From 6301d3bef3bbf413b127130632b39fc7e1e78fbb Mon Sep 17 00:00:00 2001 From: rkurduka Date: Wed, 16 Oct 2024 09:27:31 +0530 Subject: [PATCH 1/4] changes for aws-sdk-go-v2 --- apiv2/loadModelV2.go | 258 ++++++++++++++++++ apiv2/readApiV2.go | 202 ++++++++++++++ cmd/ack-generate/command/common.go | 6 +- pkg/generate/code/set_resource.go | 205 ++++++++++++-- pkg/generate/code/set_sdk.go | 137 ++++++++-- pkg/model/error.go | 6 +- pkg/model/sdk_api.go | 26 +- pkg/sdk/helper.go | 33 +++ pkg/sdk/repo.go | 11 +- pkg/util/git.go | 8 +- templates/pkg/resource/manager.go.tpl | 16 +- templates/pkg/resource/manager_factory.go.tpl | 19 +- templates/pkg/resource/sdk_update.go.tpl | 153 ++++++----- 13 files changed, 943 insertions(+), 137 deletions(-) create mode 100644 apiv2/loadModelV2.go create mode 100644 apiv2/readApiV2.go diff --git a/apiv2/loadModelV2.go b/apiv2/loadModelV2.go new file mode 100644 index 00000000..7f8f1cc6 --- /dev/null +++ b/apiv2/loadModelV2.go @@ -0,0 +1,258 @@ +package apiv2 + +import ( + "strings" + + sdkmodel "github.com/aws/aws-sdk-go/private/model/api" +) + +type ModelV2Shape struct { + Name string + Raw_shape map[string]interface{} + ServiceAlias string + ServiceObjV2 +} + +func NewModelV2Shape(raw_shape interface{}, key string, serviceAlias string) *ModelV2Shape { + + return &ModelV2Shape{ + Name: key, + Raw_shape: raw_shape.(map[string]interface{}), + ServiceAlias: serviceAlias, + } +} + +func (m *ModelV2Shape) GetShapeType() string { + + for key, value := range m.Raw_shape { + if key == "type" { + switch value.(string) { + case "structure": + return "structure" + case "map": + return "map" + case "list": + return "list" + case "string": + return "string" + case "integer": + return "integer" + case "long": + return "long" + case "double": + return "double" + case "boolean": + return "boolean" + case "timestamp": + return "timestamp" + case "enum": + return "enum" + case "operation": + return "operation" + case "blob": + return "blob" + default: + return "unknown" + } + } + } + return "unknown" +} + +func (m *ModelV2Shape) CreateShape(name string) *sdkmodel.Shape { + + api := sdkmodel.API{} + + api.AddImport("time") + + new_shape := &sdkmodel.Shape{ + ShapeName: *m.RemovePrefix(name, m.ServiceAlias), + Exception: false, + MemberRefs: make(map[string]*sdkmodel.ShapeRef), + MemberRef: sdkmodel.ShapeRef{}, + API: &api, + } + + if Type, ok := m.Raw_shape["type"]; ok { + if Type.(string) == "enum" { + new_shape.Type = "string" + } else { + new_shape.Type = Type.(string) + } + } + + return new_shape + +} + +func (m *ModelV2Shape) AddDefaultMembers(new_shape *sdkmodel.Shape) *sdkmodel.Shape { + + if m.GetShapeType() != "structure" || m.GetShapeType() != "list" || m.GetShapeType() != "enum" { + for key, _ := range m.Raw_shape { + new_shape.MemberRefs[key] = &sdkmodel.ShapeRef{ + Shape: m.CreateShape(*m.RemovePrefix(key, m.ServiceAlias)), + ShapeName: *m.RemovePrefix(key, m.ServiceAlias), + } + } + } + + return new_shape +} + +func (m *ModelV2Shape) AddStructMembers(new_shape *sdkmodel.Shape) *sdkmodel.Shape { + + if m.GetShapeType() == "structure" { + + for key, members := range m.Raw_shape["members"].(map[string]interface{}) { + + if value, ok := members.(map[string]interface{})["target"]; ok { + + valueRawShape := GetRawShape(value.(string)) + memberModel := NewModelV2Shape(valueRawShape, value.(string), m.ServiceAlias) + key = memberModel.CapitaliseName(&key) + + new_shape.MemberRefs[key] = &sdkmodel.ShapeRef{ + Shape: memberModel.CreateShape(*memberModel.RemovePrefix(value.(string), memberModel.ServiceAlias)), + ShapeName: *memberModel.RemovePrefix(value.(string), memberModel.ServiceAlias), + } + + switch new_shape.MemberRefs[key].Shape.Type { + case "list": + new_shape.MemberRefs[key].Shape = memberModel.AddListRef(new_shape.MemberRefs[key].Shape) + case "structure": + new_shape.MemberRefs[key].Shape = memberModel.AddStructMembers(new_shape.MemberRefs[key].Shape) + } + if memberModel.GetShapeType() == "enum" { + new_shape.MemberRefs[key].Shape = memberModel.AddEnumValues(new_shape.MemberRefs[key].Shape) + } + + } + + } + } + return new_shape +} + +func (m *ModelV2Shape) AddListRef(new_shape *sdkmodel.Shape) *sdkmodel.Shape { + + if m.GetShapeType() == "list" { + for _, members := range m.Raw_shape["member"].(map[string]interface{}) { + + if value, ok := members.(string); ok { + + valueRawShape := GetRawShape(value) + memberModel := NewModelV2Shape(valueRawShape, new_shape.ShapeName, m.ServiceAlias) + + new_shape.MemberRef = sdkmodel.ShapeRef{ + Shape: memberModel.CreateShape(*memberModel.RemovePrefix(value, memberModel.ServiceAlias)), + ShapeName: *memberModel.RemovePrefix(value, memberModel.ServiceAlias), + } + + switch new_shape.MemberRef.Shape.Type { + case "structure": + new_shape.MemberRef.Shape = memberModel.AddStructMembers(new_shape.MemberRef.Shape) + default: + new_shape.MemberRef.Shape = memberModel.AddDefaultMembers(new_shape.MemberRef.Shape) + + } + + } + + } + } + return new_shape +} + +func (m *ModelV2Shape) AddEnumValues(new_shape *sdkmodel.Shape) *sdkmodel.Shape { + + if m.GetShapeType() == "enum" { + for key := range m.Raw_shape["members"].(map[string]interface{}) { + new_shape.Enum = append(new_shape.Enum, key) + } + } + + return new_shape +} + +func (m *ModelV2Shape) CreateOperation(name string) *sdkmodel.Operation { + + if m.GetShapeType() == "operation" { + new_operation := &sdkmodel.Operation{ + Name: name, + ExportedName: *m.RemovePrefix(name, serviceAlias), + } + return new_operation + + } + return nil + +} + +func (m *ModelV2Shape) AddInputShapeRef(newOperation *sdkmodel.Operation, input interface{}) *sdkmodel.Operation { + + inputShapeName := input.(map[string]interface{})["target"] + inputRawShape := GetRawShape(inputShapeName.(string)) + + name := m.RemovePrefix(inputShapeName.(string), m.ServiceAlias) + name = m.ReplaceShapeSuffixRequest(*name, m.ServiceAlias) + + inputShapeModel := NewModelV2Shape(inputRawShape, *name, m.ServiceAlias) + + if _, ok := shapes[inputShapeModel.Name]; ok { + newOperation.InputRef = sdkmodel.ShapeRef{ + Shape: shapes[inputShapeModel.Name], + ShapeName: inputShapeModel.Name, + } + } else { + newOperation.InputRef = sdkmodel.ShapeRef{ + Shape: inputShapeModel.CreateShape(inputShapeModel.Name), + ShapeName: inputShapeModel.Name, + } + shapes[newOperation.InputRef.ShapeName] = newOperation.InputRef.Shape + } + + return newOperation + +} + +func (m *ModelV2Shape) AddOutputShapeRef(newOperation *sdkmodel.Operation, output interface{}) *sdkmodel.Operation { + + outputShapeName := output.(map[string]interface{})["target"] + outputRawShape := GetRawShape(outputShapeName.(string)) + + name := m.RemovePrefix(outputShapeName.(string), m.ServiceAlias) + name = m.ReplaceShapeSuffixRequest(*name, m.ServiceAlias) + outputShapeModel := NewModelV2Shape(outputRawShape, *name, m.ServiceAlias) + + if outputShapeModel.Name == "smithy.api#Unit" { + + newOperation.OutputRef = sdkmodel.ShapeRef{ + Shape: outputShapeModel.CreateShape(newOperation.Name + "Output"), + ShapeName: newOperation.Name + "Output", + } + newOperation.OutputRef.Shape.Type = "structure" + shapes[newOperation.OutputRef.ShapeName] = newOperation.OutputRef.Shape + + return newOperation + + } + + if OpOutputRef, ok := shapes[outputShapeModel.Name]; ok { + + var OutputShapeName string + if strings.HasSuffix(OpOutputRef.ShapeName, "Description") { + + OutputShapeName = newOperation.Name + "Output" + outputShapeModel.Name = OutputShapeName + outPutShape := BuildModelV2(outputShapeModel) + newOperation.OutputRef.Shape = outPutShape + return newOperation + + } + newOperation.OutputRef.Shape = OpOutputRef + + } + + return newOperation + +} diff --git a/apiv2/readApiV2.go b/apiv2/readApiV2.go new file mode 100644 index 00000000..0570386d --- /dev/null +++ b/apiv2/readApiV2.go @@ -0,0 +1,202 @@ +package apiv2 + +import ( + "encoding/json" + "errors" + "io/ioutil" + "os" + "path/filepath" + "strings" + "unicode" + + sdkmodel "github.com/aws/aws-sdk-go/private/model/api" +) + +var ( + serviceAlias string + shapes = make(map[string]*sdkmodel.Shape) + operations = make(map[string]*sdkmodel.Operation) + raw_shapes map[string]interface{} +) + +type ServiceObjV2 map[string]interface{} +type APIs map[string]*sdkmodel.API + +func (Obj *ServiceObjV2) RemovePrefix(key string, serviceAlias string) *string { + + to_Trim := "com.amazonaws." + serviceAlias + "#" + new_key := strings.TrimPrefix(key, to_Trim) + + return &new_key +} + +func (Obj *ServiceObjV2) ReplaceShapeSuffixRequest(key string, serviceAlias string) *string { + if strings.HasSuffix(key, "Request") { + new_key := strings.Replace(key, "Request", "Input", 1) + return &new_key + } else if strings.HasSuffix(key, "Response") { + new_key := strings.Replace(key, "Response", "Output", 1) + return &new_key + } + + return &key +} + +func (Obj *ServiceObjV2) CapitaliseName(name *string) string { + + runes := []rune(*name) + if unicode.IsUpper(runes[0]) { + return *name + } + runes[0] = unicode.ToUpper(runes[0]) + return string(runes) + +} + +func ReadV2file(serviceAlias string) (*ServiceObjV2, error) { + + var Obj ServiceObjV2 + + dir, _ := os.Getwd() + filepath := filepath.Join(dir + "/apiv2/" + serviceAlias + ".json") + + file, err := ioutil.ReadFile(filepath) + + if err != nil { + return nil, err + } + err = json.Unmarshal(file, &Obj) + if err != nil { + return nil, err + } + return &Obj, nil +} + +func CheckShapes(Obj *ServiceObjV2) (interface{}, error) { + if value, ok := (*Obj)["shapes"]; ok { + raw_shapes = value.(map[string]interface{}) + return raw_shapes, nil + } + return nil, errors.New("shapes not found") +} + +func GetRawShape(key string) map[string]interface{} { + + if raw_shape, ok := raw_shapes[key]; ok { + + return raw_shape.(map[string]interface{}) + } + + return nil +} + +func BuildModelV2(m *ModelV2Shape) *sdkmodel.Shape { + + if m.GetShapeType() == "structure" { + newShape := m.CreateShape(m.Name) + newShape = m.AddStructMembers(newShape) + + return newShape + + } else if m.GetShapeType() == "list" { + newShape := m.CreateShape(m.Name) + + newShape = m.AddListRef(newShape) + + return newShape + + } else if m.GetShapeType() == "enum" { + newShape := m.CreateShape(m.Name) + newShape = m.AddEnumValues(newShape) + + return newShape + + } else if m.GetShapeType() == "integer" || m.GetShapeType() == "long" || m.GetShapeType() == "string" || m.GetShapeType() == "boolean" { + newShape := m.CreateShape(m.Name) + + return newShape + + } + return nil +} + +func LoadModelV2(shapes map[string]*sdkmodel.Shape, operations map[string]*sdkmodel.Operation, serviceAlias string) map[string]*sdkmodel.API { + + api := sdkmodel.API{ + Shapes: shapes, + Operations: operations, + } + + api.StrictServiceId = true + api.Metadata.ServiceID = serviceAlias + + apis := APIs{} + /// Need to add pull path here as key in APIsmap + apis[serviceAlias] = &api + + return apis + +} + +// Write a main function to call ReadV2file and PrintV2Obj +func CollectApis(modelPath string) map[string]*sdkmodel.API { + + Obj, err := ReadV2file(modelPath) + + if err != nil { + panic(err.Error()) + + } + + if raw_shapes, err := CheckShapes(Obj); err != nil { + + panic(err.Error()) + + } else { + + for key, raw_shape := range raw_shapes.(map[string]interface{}) { + + name := Obj.RemovePrefix(key, serviceAlias) + name = Obj.ReplaceShapeSuffixRequest(*name, serviceAlias) + + m := NewModelV2Shape(raw_shape, *name, serviceAlias) + newShape := BuildModelV2(m) + + if newShape != nil { + + shapes[newShape.ShapeName] = newShape + + } + + } + + for key, raw_shape := range raw_shapes.(map[string]interface{}) { + + name := Obj.RemovePrefix(key, serviceAlias) + name = Obj.ReplaceShapeSuffixRequest(*name, serviceAlias) + + m := NewModelV2Shape(raw_shape, *name, serviceAlias) + + if m.GetShapeType() == "operation" { + + op := m.CreateOperation(m.Name) + + if input, ok := m.Raw_shape["input"]; ok { + op = m.AddInputShapeRef(op, input) + + } + if output, ok := m.Raw_shape["output"]; ok { + op = m.AddOutputShapeRef(op, output) + + } + + operations[op.Name] = op + + } + + } + + } + ApisV2 := LoadModelV2(shapes, operations, serviceAlias) + return ApisV2 +} diff --git a/cmd/ack-generate/command/common.go b/cmd/ack-generate/command/common.go index 8bba4b84..c7e789f4 100644 --- a/cmd/ack-generate/command/common.go +++ b/cmd/ack-generate/command/common.go @@ -51,7 +51,11 @@ func loadModel(svcAlias string, apiVersion string, apiGroup string, defaultCfg a } sdkHelper := acksdk.NewHelper(sdkDir, cfg) - sdkAPI, err := sdkHelper.API(modelName) + //sdkAPI, err := sdkHelper.API(modelName) + + // AWS-SDK-GO-V2 + sdkAPI, err := sdkHelper.APIV2(svcAlias) + if err != nil { retryModelName, err := FallBackFindServiceID(sdkDir, svcAlias) if err != nil { diff --git a/pkg/generate/code/set_resource.go b/pkg/generate/code/set_resource.go index 3aede536..f91d50a9 100644 --- a/pkg/generate/code/set_resource.go +++ b/pkg/generate/code/set_resource.go @@ -110,6 +110,7 @@ func SetResource( if op == nil { return "" } + outputShape, _ := r.GetOutputShape(op) if outputShape == nil { return "" @@ -160,10 +161,12 @@ func SetResource( // fields with further-nested fields as needed for memberIndex, memberName := range outputShape.MemberNames() { //TODO: (vijat@) should these field be renamed before looking them up in spec? + sourceAdaptedVarName := sourceVarName + "." + memberName // Handle the special case of ARN for primary resource identifier if r.IsPrimaryARNField(memberName) { + // if ko.Status.ACKResourceMetadata == nil { // ko.Status.ACKResourceMetadata = &ackv1alpha1.ResourceMetadata{} // } @@ -182,11 +185,13 @@ func SetResource( // if resp.BookArn != nil { // ko.Status.ACKResourceMetadata.ARN = resp.BookArn // } + out += fmt.Sprintf( "%sif %s != nil {\n", indent, sourceAdaptedVarName, ) + out += fmt.Sprintf( "%s\tarn := ackv1alpha1.AWSResourceName(*%s)\n", indent, @@ -302,9 +307,49 @@ func SetResource( // } // ko.Status.VpnMemberships = field0 - out += fmt.Sprintf( - "%sif %s != nil {\n", indent, sourceAdaptedVarName, - ) + // This is for AWS-SDK-GO-V2 + if targetMemberShapeRef.Shape.IsEnum() { + + out += fmt.Sprintf( + "%sif %s != \"\" {\n", indent, sourceAdaptedVarName, + ) + + // } else if targetMemberShapeRef.Shape.Type == "long" && strings.HasSuffix(targetMemberShapeRef.ShapeName, "Value") { + + // out += fmt.Sprintf( + // "%sif %s > 0 {\n", indent, sourceAdaptedVarName, + // ) + + // else if targetMemberShapeRef.Shape.Type == "integer" { + + // out += fmt.Sprintf( + // "%sif %s > 0 {\n", indent, sourceAdaptedVarName, + // ) + // } + + // } else if targetMemberShapeRef.Shape.Type == "boolean" && targetMemberShapeRef.Shape.GoType() == "bool" { + + // out += fmt.Sprintf( + // "%sif %s {\n", indent, sourceAdaptedVarName, + // ) + } else if targetMemberShapeRef.Shape.Type == "integer" || targetMemberShapeRef.Shape.Type == "long" { + + out += fmt.Sprintf( + "%sif %s > 0 {\n", indent, sourceAdaptedVarName, + ) + // } else if targetMemberShapeRef.Shape.Type == "boolean" { + + // out += fmt.Sprintf( + // "%sif %s {\n", indent, sourceAdaptedVarName, + // ) + + } else { + + out += fmt.Sprintf( + "%sif %s != nil {\n", indent, sourceAdaptedVarName, + ) + } + qualifiedTargetVar := fmt.Sprintf( "%s.%s", targetAdaptedVarName, f.Names.Camel, ) @@ -312,7 +357,9 @@ func SetResource( switch targetMemberShape.Type { case "list", "structure", "map": { + memberVarName := fmt.Sprintf("f%d", memberIndex) + out += varEmptyConstructorK8sType( cfg, r, memberVarName, @@ -331,6 +378,7 @@ func SetResource( opType, indentLevel+1, ) + out += setResourceForScalar( qualifiedTargetVar, memberVarName, @@ -338,7 +386,9 @@ func SetResource( indentLevel+1, ) } + default: + if setCfg != nil && setCfg.From != nil { // We have some special instructions to pull the value from a // different field or member... @@ -354,6 +404,7 @@ func SetResource( out += fmt.Sprintf( "%s} else {\n", indent, ) + out += fmt.Sprintf( "%s%s%s.%s = nil\n", indent, indent, targetAdaptedVarName, f.Names.Camel, @@ -522,6 +573,7 @@ func setResourceReadMany( out += opening for memberIndex, memberName := range sourceElemShape.MemberNames() { + sourceMemberShapeRef := sourceElemShape.MemberRefs[memberName] sourceMemberShape := sourceMemberShapeRef.Shape sourceAdaptedVarName := elemVarName + "." + memberName @@ -572,6 +624,7 @@ func setResourceReadMany( op.ExportedName, memberName, ) + inSpec, inStatus := r.HasMember(fieldName, op.ExportedName) if inSpec { targetAdaptedVarName += cfg.PrefixConfig.SpecField @@ -593,9 +646,32 @@ func setResourceReadMany( } targetMemberShapeRef = f.ShapeRef - out += fmt.Sprintf( - "%sif %s != nil {\n", innerForIndent, sourceAdaptedVarName, - ) + + // This is for AWS-SDK-GO-V2 + if targetMemberShapeRef.Shape.IsEnum() { + + out += fmt.Sprintf( + "%sif %s != \"\" {\n", innerForIndent, sourceAdaptedVarName, + ) + + // } + + // } else if targetMemberShapeRef.Shape.Type == "boolean" && targetMemberShapeRef.Shape.GoType() == "bool" { + // out += fmt.Sprintf( + // "%sif %s {\n", indent, sourceAdaptedVarName, + // ) + } else if targetMemberShapeRef.Shape.Type == "integer" || targetMemberShapeRef.Shape.Type == "long" { + + out += fmt.Sprintf( + "%sif %s > 0 {\n", innerForIndent, sourceAdaptedVarName, + ) + + } else { + out += fmt.Sprintf( + "%sif %s != nil {\n", innerForIndent, sourceAdaptedVarName, + ) + + } //ex: r.ko.Spec.CacheClusterID qualifiedTargetVar := fmt.Sprintf( @@ -623,6 +699,7 @@ func setResourceReadMany( model.OpTypeList, flIndentLvl+1, ) + out += setResourceForScalar( qualifiedTargetVar, memberVarName, @@ -661,6 +738,7 @@ func setResourceReadMany( ) } // r.ko.Spec.CacheClusterID = elem.CacheClusterId + out += setResourceForScalar( qualifiedTargetVar, sourceAdaptedVarName, @@ -1553,6 +1631,7 @@ func setResourceForContainer( ) string { switch sourceShapeRef.Shape.Type { case "structure": + return SetResourceForStruct( cfg, r, targetVarName, @@ -1565,6 +1644,7 @@ func setResourceForContainer( indentLevel, ) case "list": + return setResourceForSlice( cfg, r, targetFieldName, @@ -1629,19 +1709,6 @@ func SetResourceForStruct( var sourceAdaptedVarName, qualifiedTargetVar string for _, targetMemberName := range targetShape.MemberNames() { - // To check if the field member has `ignore` set to `true`. - // This condition currently applies only for members of a field whose shape is `structure`. - var setCfg *ackgenconfig.SetFieldConfig - f, ok := r.Fields[targetFieldPath] - if ok { - mf, ok := f.MemberFields[targetMemberName] - if ok { - setCfg = mf.GetSetterConfig(op) - if setCfg != nil && setCfg.IgnoreResourceSetter() { - continue - } - } - } sourceMemberShapeRef = sourceShape.MemberRefs[targetMemberName] if sourceMemberShapeRef == nil { @@ -1661,12 +1728,53 @@ func SetResourceForStruct( sourceMemberShape := sourceMemberShapeRef.Shape targetMemberCleanNames := names.New(targetMemberName) sourceAdaptedVarName = sourceVarName + "." + targetMemberName - out += fmt.Sprintf( - "%sif %s != nil {\n", indent, sourceAdaptedVarName, - ) + + // This is for AWS-SDK-GO-V2 + // out += fmt.Sprintf( + // "%sif %s != nil {\n", indent, sourceAdaptedVarName, + // ) + + if targetMemberShapeRef.Shape.IsEnum() { + + out += fmt.Sprintf( + "%sif %s != \"\" {\n", indent, sourceAdaptedVarName, + ) + // This is for edge case - in efs controller + // FileSystemSize.Value is int64 and rest of fields are *int64 + } else if targetMemberShapeRef.Shape.Type == "long" && targetMemberShapeRef.ShapeName == "FileSystemSizeValue" { + + out += fmt.Sprintf( + "%sif %s > 0 {\n", indent, sourceAdaptedVarName, + ) + + // } else if targetMemberShapeRef.Shape.Type == "integer" { + + // out += fmt.Sprintf( + // "%sif %s > 0 {\n", indent, sourceAdaptedVarName, + // ) + } else if targetMemberShapeRef.Shape.Type == "boolean" { + out += fmt.Sprintf( + "%sif %s {\n", indent, sourceAdaptedVarName, + ) + } else { + + out += fmt.Sprintf( + "%sif %s != nil {\n", indent, sourceAdaptedVarName, + ) + + } + qualifiedTargetVar = fmt.Sprintf( "%s.%s", targetVarName, targetMemberCleanNames.Camel, ) + + // This is for AWS-SDk-GO-V2 + // qualifiedTargetVar = fmt.Sprintf( + // "%s.%s", targetVarName, targetMemberCleanNames.Original, + // ) + + //fmt.Println("targetMemberCleanNames.Camel", targetMemberCleanNames.Camel) + updatedTargetFieldPath := targetFieldPath + "." + targetMemberCleanNames.Camel switch sourceMemberShape.Type { @@ -1690,6 +1798,7 @@ func SetResourceForStruct( op, indentLevel+1, ) + out += setResourceForScalar( qualifiedTargetVar, indexedVarName, @@ -1784,12 +1893,15 @@ func setResourceForSlice( indent := strings.Repeat("\t", indentLevel) sourceShape := sourceShapeRef.Shape + targetShape := targetShapeRef.Shape + iterVarName := fmt.Sprintf("%siter", targetVarName) elemVarName := fmt.Sprintf("%selem", targetVarName) // for _, f0iter0 := range resp.TagSpecifications { out += fmt.Sprintf("%sfor _, %s := range %s {\n", indent, iterVarName, sourceVarName) // var f0elem0 string + out += varEmptyConstructorK8sType( cfg, r, elemVarName, @@ -1861,16 +1973,22 @@ func setResourceForSlice( indentLevel+1, ) } - addressOfVar := "" + // This is for AWS-SDK-GO-V2 + //addressOfVar := "" switch targetShape.MemberRef.Shape.Type { case "structure", "list", "map": break default: - addressOfVar = "&" + // This is for AWS-SDK-GO-V2 + //addressOfVar = "&" } // f0 = append(f0, elem0) - out += fmt.Sprintf("%s\t%s = append(%s, %s%s)\n", indent, targetVarName, targetVarName, addressOfVar, elemVarName) + + // This is for AWS-SDK-GO-V2 + //out += fmt.Sprintf("%s\t%s = append(%s, %s%s)\n", indent, targetVarName, targetVarName, addressOfVar, elemVarName) + out += fmt.Sprintf("%s\t%s = append(%s, %s)\n", indent, targetVarName, targetVarName, elemVarName) out += fmt.Sprintf("%s}\n", indent) + return out } @@ -1952,6 +2070,7 @@ func setResourceForScalar( // The struct or struct field that we access our source value from sourceVar string, shapeRef *awssdkmodel.ShapeRef, + indentLevel int, ) string { out := "" @@ -1961,11 +2080,43 @@ func setResourceForScalar( if shape.Type == "timestamp" { setTo = "&metav1.Time{*" + sourceVar + "}" } + if strings.HasPrefix(targetVar, ".") { targetVar = targetVar[1:] - setTo = "*" + setTo + //setTo = "*" + setTo // This is for AWS-SDK-Go-V2 + + } + + // This is for AWS-SDK-GO-V2 + if shape.IsEnum() { + out += fmt.Sprintf("%s%s = (*string)(&%s)\n", indent, targetVar, setTo) + // } else if shape.Type == "integer" { + + // out += fmt.Sprintf("%s%s := int64(%s)\n", indent, "number", setTo) + // out += fmt.Sprintf("%s%s = &%s\n", indent, targetVar, "number") + + // This is for edge case - in efs controller + // targetvar is int64 and rest of targetvar are *int64 - EFS controller + } else if shape.Type == "long" && shapeRef.ShapeName == "FileSystemSizeValue" { + + out += fmt.Sprintf("%s%s = &%s\n", indent, targetVar, setTo) + + // This is for edge case - in ecr controller + // ScanOnPuSH - targetvar is bool and rest of taregetvar are *bool - ECR controller + } else if shape.Type == "boolean" && shape.GoType() == "*bool" && shape.ShapeName == "ScanOnPushFlag" { + + out += fmt.Sprintf("%s%s = &%s\n", indent, targetVar, setTo) + + } else if !strings.Contains(targetVar, ".") { + + out += fmt.Sprintf("%s%s = &%s\n", indent, targetVar, setTo) + } else if shape.Type == "integer" { + + out += fmt.Sprintf("%s%s = &%s\n", indent, targetVar, setTo) + } else { + + out += fmt.Sprintf("%s%s = %s\n", indent, targetVar, setTo) } - out += fmt.Sprintf("%s%s = %s\n", indent, targetVar, setTo) return out } diff --git a/pkg/generate/code/set_sdk.go b/pkg/generate/code/set_sdk.go index c2d521b0..5cf98536 100644 --- a/pkg/generate/code/set_sdk.go +++ b/pkg/generate/code/set_sdk.go @@ -124,6 +124,7 @@ func SetSDK( // an Attributes member (example: all the Delete shapes...) _, foundAttrs := inputShape.MemberRefs["Attributes"] if r.UnpacksAttributesMap() && foundAttrs { + // For APIs that use a pattern of a parameter called "Attributes" that // is of type `map[string]*string` to represent real, schema'd fields, // we need to set the input shape's "Attributes" member field to the @@ -178,11 +179,13 @@ func SetSDK( opConfig, override := cfg.GetOverrideValues(op.ExportedName) for memberIndex, memberName := range inputShape.MemberNames() { + if r.UnpacksAttributesMap() && memberName == "Attributes" { continue } if override { + value, ok := opConfig[memberName] memberShapeRef, _ := inputShape.MemberRefs[memberName] memberShape := memberShapeRef.Shape @@ -197,11 +200,13 @@ func SetSDK( } out += fmt.Sprintf("%s%s.Set%s(%s)\n", indent, targetVarName, memberName, value) + fmt.Println("Override Out", out) continue } } if r.IsPrimaryARNField(memberName) { + // if ko.Status.ACKResourceMetadata != nil && ko.Status.ACKResourceMetadata.ARN != nil { // res.SetTopicArn(string(*ko.Status.ACKResourceMetadata.ARN)) // } @@ -216,6 +221,7 @@ func SetSDK( out += fmt.Sprintf( "%s}\n", indent, ) + fmt.Println("Resoure ARN Out", out) continue } @@ -331,6 +337,7 @@ func SetSDK( switch memberShape.Type { case "list", "structure", "map": { + memberVarName := fmt.Sprintf("f%d", memberIndex) out += varEmptyConstructorSDKType( cfg, r, @@ -360,6 +367,7 @@ func SetSDK( ) } default: + if r.IsSecretField(memberName) { out += setSDKForSecret( cfg, r, @@ -373,7 +381,7 @@ func SetSDK( cfg, r, memberName, targetVarName, - inputShape.Type, + memberShape.Type, // changed this to memberShape.Type from inputShape.Type sourceFieldPath, sourceAdaptedVarName, memberShapeRef, @@ -395,6 +403,7 @@ func SetSDK( ) } } + return out } @@ -873,6 +882,7 @@ func setSDKReadMany( case "list": // Expecting slice of identifiers memberVarName := fmt.Sprintf("f%d", memberIndex) + // f0 := []*string{} out += varEmptyConstructorSDKType( cfg, r, @@ -882,10 +892,16 @@ func setSDKReadMany( ) // f0 = append(f0, sourceVarName) - out += fmt.Sprintf("%s\t%s = append(%s, %s)\n", indent, + // out += fmt.Sprintf("%s\t%s = append(%s, %s)\n", indent, + // memberVarName, memberVarName, resVarPath) + + // This is for AWS-SDK-GO-V2 + // added pointer to resVarPath - this needs to check with other services will it work or not + out += fmt.Sprintf("%s\t%s = append(%s, *%s)\n", indent, memberVarName, memberVarName, resVarPath) // res.SetIds(f0) + out += setSDKForScalar( cfg, r, memberName, @@ -899,6 +915,7 @@ func setSDKReadMany( default: // For ReadMany that have a singular identifier field. // ex: DescribeReplicationGroups + out += setSDKForScalar( cfg, r, memberName, @@ -938,7 +955,9 @@ func setSDKForContainer( op model.OpType, indentLevel int, ) string { + switch targetShapeRef.Shape.Type { + case "structure": return SetSDKForStruct( cfg, r, @@ -1101,6 +1120,7 @@ func SetSDKForStruct( targetShape := targetShapeRef.Shape for memberIndex, memberName := range targetShape.MemberNames() { + memberShapeRef := targetShape.MemberRefs[memberName] memberShape := memberShapeRef.Shape cleanMemberNames := names.New(memberName) @@ -1114,7 +1134,7 @@ func SetSDKForStruct( // To check if the field member has `ignore` set to `true`. // This condition currently applies only for members of a field whose shape is `structure` var setCfg *ackgenconfig.SetFieldConfig - f, ok := r.Fields[sourceFieldPath] + f, ok := r.Fields[targetFieldName] if ok { mf, ok := f.MemberFields[memberName] if ok { @@ -1123,6 +1143,7 @@ func SetSDKForStruct( continue } } + } fallBackName := r.GetMatchingInputShapeFieldName(op, targetFieldName) @@ -1133,9 +1154,11 @@ func SetSDKForStruct( out += fmt.Sprintf( "%sif %s != nil {\n", indent, sourceAdaptedVarName, ) + switch memberShape.Type { case "list", "structure", "map": { + memberVarName := fmt.Sprintf( "%sf%d", targetVarName, memberIndex, @@ -1177,6 +1200,7 @@ func SetSDKForStruct( indentLevel, ) } else { + out += setSDKForScalar( cfg, r, memberName, @@ -1223,6 +1247,7 @@ func setSDKForSlice( // for _, f0iter := range r.ko.Spec.Tags { out += fmt.Sprintf("%sfor _, %s := range %s {\n", indent, iterVarName, sourceVarName) // f0elem := string{} + out += varEmptyConstructorSDKType( cfg, r, elemVarName, @@ -1248,15 +1273,21 @@ func setSDKForSlice( op, indentLevel+1, ) - addressOfVar := "" + // This is for AWS-SDK-GO-V2 + //addressOfVar := "" switch targetShape.MemberRef.Shape.Type { case "structure", "list", "map": break - default: - addressOfVar = "&" + // This is for AWS-SDK-GO-V2 + // default: + // addressOfVar = "&" } // f0 = append(f0, elem0) - out += fmt.Sprintf("%s\t%s = append(%s, %s%s)\n", indent, targetVarName, targetVarName, addressOfVar, elemVarName) + + // This is for AWS-SDK-GO-V2 + //out += fmt.Sprintf("%s\t%s = append(%s, %s%s)\n", indent, targetVarName, targetVarName, addressOfVar, elemVarName) + + out += fmt.Sprintf("%s\t%s = append(%s, %s)\n", indent, targetVarName, targetVarName, elemVarName) out += fmt.Sprintf("%s}\n", indent) return out } @@ -1340,18 +1371,39 @@ func varEmptyConstructorSDKType( indent := strings.Repeat("\t", indentLevel) goType := shape.GoTypeWithPkgName() keepPointer := (shape.Type == "list" || shape.Type == "map") - goType = model.ReplacePkgName(goType, r.SDKAPIPackageName(), "svcsdk", keepPointer) + //goType = model.ReplacePkgName(goType, r.SDKAPIPackageName(), "svcsdk", keepPointer) + // This is for AWS-SDK-GO-V2 + goType = model.ReplacePkgName(goType, r.SDKAPIPackageName(), "svcsdktypes", keepPointer) switch shape.Type { case "structure": // f0 := &svcsdk.BookData{} - out += fmt.Sprintf("%s%s := &%s{}\n", indent, varName, goType) + + // This is for AWS-SDK-GO-V2 + if goType == ".Tag" { + + out += fmt.Sprintf("%s%s := svcsdktypes%s{}\n", indent, varName, goType) + } else { + + out += fmt.Sprintf("%s%s := &svcsdktypes%s{}\n", indent, varName, goType) + } + case "list", "map": // f0 := []*string{} - out += fmt.Sprintf("%s%s := %s{}\n", indent, varName, goType) + + if goType == "[]*string" || goType == "[]*int32" || goType == "[]*int64" { + + out += fmt.Sprintf("%s%s := %s{}\n", indent, varName, strings.ReplaceAll(goType, "*", "")) + } else if goType == "[]*.Tag" { + out += fmt.Sprintf("%s%s := %s{}\n", indent, varName, strings.ReplaceAll(goType, "*", "svcsdktypes")) + } else { + out += fmt.Sprintf("%s%s := %s{}\n", indent, varName, strings.ReplaceAll(goType, "*", "*svcsdktypes")) + } + default: // var f0 string out += fmt.Sprintf("%svar %s %s\n", indent, varName, goType) } + return out } @@ -1367,8 +1419,12 @@ func varEmptyConstructorK8sType( out := "" indent := strings.Repeat("\t", indentLevel) goType := shape.GoTypeWithPkgName() + keepPointer := (shape.Type == "list" || shape.Type == "map") goType = model.ReplacePkgName(goType, r.SDKAPIPackageName(), "svcapitypes", keepPointer) + + // This is for AWS-SDK-GO-V2 + //goType = model.ReplacePkgName(goType, r.SDKAPIPackageName(), "svcsdktypes", keepPointer) goTypeNoPkg := goType goPkg := "" hadPkg := false @@ -1393,19 +1449,25 @@ func varEmptyConstructorK8sType( switch shape.Type { case "structure": - if r.Config().HasEmptyShape(shape.ShapeName) { - // f0 := map[string]*string{} - out += fmt.Sprintf("%s%s := map[string]*string{}\n", indent, varName) - } else { - // f0 := &svcapitypes.BookData{} - out += fmt.Sprintf("%s%s := &%s{}\n", indent, varName, goType) - } + // f0 := &svcapitypes.BookData{} + + out += fmt.Sprintf("%s%s := &svcapitypes%s{}\n", indent, varName, goType) case "list", "map": // f0 := []*string{} - out += fmt.Sprintf("%s%s := %s{}\n", indent, varName, goType) + + if goType == "[]*string" || goType == "[]*int32" || goType == "[]*int64" { + + out += fmt.Sprintf("%s%s := %s{}\n", indent, varName, goType) + } else { + + out += fmt.Sprintf("%s%s := %s{}\n", indent, varName, strings.ReplaceAll(goType, "*", "*svcapitypes")) + + } + default: // var f0 string - out += fmt.Sprintf("%svar %s %s\n", indent, varName, goType) + + out += fmt.Sprintf("%svar %s *%s\n", indent, varName, goType) } return out } @@ -1438,15 +1500,46 @@ func setSDKForScalar( setTo += ".Time" } else if shapeRef.UseIndirection() { setTo = "*" + setTo + } - if targetVarType == "structure" { - out += fmt.Sprintf("%s%s.Set%s(%s)\n", indent, targetVarName, targetFieldName, setTo) - } else { + + // This is for AWS-SDK-GO-V2 + if targetFieldName == "" { + + //fmt.Println("TargetVarName ", targetVarName, "TargetFieldName ", targetFieldName, "ShapeType", shape.Type, "ShapeName: ", shape.ShapeName) + out += fmt.Sprintf("%s%s = %s\n", indent, targetVarName, setTo) + + } else if targetVarType == "string" && shape.IsEnum() { + // //out += fmt.Sprintf("%s%s.Set%s(%s)\n", indent, targetVarName, targetFieldName, setTo) + out += fmt.Sprintf("%s.%s = svcsdktypes.%s(%s)", targetVarName, targetFieldName, shape.ShapeName, setTo) + + // This is edge case in ECR controller where ImageScanningConfiguration.ScanOnPush is bool not *bool + } else if targetVarType == "structure" && shape.Type == "boolean" && targetFieldName == "ScanOnPush" { + targetVarPath := targetVarName if targetFieldName != "" { targetVarPath += "." + targetFieldName } + out += fmt.Sprintf("%s%s = %s\n", indent, targetVarPath, setTo) + + } else if targetVarType == "structure" && shape.Type == "boolean" { + + targetVarPath := targetVarName + if targetFieldName != "" { + targetVarPath += "." + targetFieldName + } + + out += fmt.Sprintf("%s%s = %s\n", indent, targetVarPath, strings.TrimPrefix(setTo, "*")) + + } else { + + targetVarPath := targetVarName + if targetFieldName != "" { + targetVarPath += "." + targetFieldName + } + + out += fmt.Sprintf("%s%s = %s\n", indent, targetVarPath, strings.TrimPrefix(setTo, "*")) } return out } diff --git a/pkg/model/error.go b/pkg/model/error.go index 560fa0e0..bd02aed5 100644 --- a/pkg/model/error.go +++ b/pkg/model/error.go @@ -69,5 +69,9 @@ func (r *CRD) ExceptionCode(httpStatusCode int) string { } } } - return "UNKNOWN" + + // This is for AWS-SDK-GO-V2 + //return "UNKNOWN" + + return r.Names.Original + "NotFound" } diff --git a/pkg/model/sdk_api.go b/pkg/model/sdk_api.go index 8509dbc3..2eb9a6f1 100644 --- a/pkg/model/sdk_api.go +++ b/pkg/model/sdk_api.go @@ -35,11 +35,15 @@ var ( // GoTypeToSDKShapeType is a map of Go types to aws-sdk-go // private/model/api.Shape types GoTypeToSDKShapeType = map[string]string{ - "int": "integer", - "int64": "integer", - "float64": "float", - "string": "string", + "int": "integer", + // This is for AWS-SDK-GO-V2 + //"int64": "integer", + "int64": "long", + "float64": "float", + "string": "string", + // This is for AWS-SDK-GO-V2 still under test "bool": "boolean", + "boolean": "bool", "time.Time": "timestamp", "bytes": "blob", } @@ -193,6 +197,7 @@ func (a *SDKAPI) GetShapeRefFromType( // GetCustomShapeRef finds a ShapeRef for a custom shape using either its member // or its value shape name. func (a *SDKAPI) GetCustomShapeRef(shapeName string) *awssdkmodel.ShapeRef { + customList := a.getCustomListRef(shapeName) if customList != nil { return customList @@ -202,7 +207,9 @@ func (a *SDKAPI) GetCustomShapeRef(shapeName string) *awssdkmodel.ShapeRef { // getCustomListRef finds a ShapeRef for a supplied custom list field func (a *SDKAPI) getCustomListRef(memberShapeName string) *awssdkmodel.ShapeRef { + for _, shape := range a.CustomShapes { + if shape.MemberShapeName != nil && *shape.MemberShapeName == memberShapeName { return shape.ShapeRef } @@ -226,13 +233,17 @@ func (a *SDKAPI) GetInputShapeRef( opID string, path string, ) (*awssdkmodel.ShapeRef, bool) { + op, ok := a.API.Operations[opID] + if !ok { return nil, false } if path == "." { + return &op.InputRef, true } + return getMemberByPath(op.InputRef.Shape, path) } @@ -397,17 +408,24 @@ func getMemberByPath( shape *awssdkmodel.Shape, path string, ) (*awssdkmodel.ShapeRef, bool) { + elements := strings.Split(path, ".") + last := len(elements) - 1 + for x, elem := range elements { + if elem == "" { continue } if shape == nil { return nil, false } + shapeRef, ok := shape.MemberRefs[elem] + if !ok { + return nil, false } if x == last { diff --git a/pkg/sdk/helper.go b/pkg/sdk/helper.go index 15f0bf49..739c4d9d 100644 --- a/pkg/sdk/helper.go +++ b/pkg/sdk/helper.go @@ -27,6 +27,7 @@ import ( "github.com/aws-controllers-k8s/code-generator/pkg/model" "github.com/aws-controllers-k8s/code-generator/pkg/util" + "github.com/aws-controllers-k8s/code-generator/apiv2" awssdkmodel "github.com/aws-controllers-k8s/code-generator/pkg/api" ) @@ -122,6 +123,28 @@ func (h *Helper) API(serviceModelName string) (*model.SDKAPI, error) { return nil, ErrServiceNotFound } +// AWS-SDK-GO-V2 +func (h *Helper) APIV2(serviceModelName string) (*model.SDKAPI, error) { + + modelPath := h.ModelAndDocsPathV2(serviceModelName) + + apis := apiv2.CollectApis(modelPath) + + for _, api := range apis { + + _ = api.ServicePackageDoc() + sdkapi := model.NewSDKAPI(api, h.APIGroupSuffix) + + h.InjectCustomShapes(sdkapi) + + return sdkapi, nil + + } + + return nil, ErrServiceNotFound + +} + // ModelAndDocsPath returns two string paths to the supplied service's API and // doc JSON files func (h *Helper) ModelAndDocsPath( @@ -142,6 +165,16 @@ func (h *Helper) ModelAndDocsPath( return modelPath, docsPath, nil } +// AWS-SDK-GO-V2 +func (h *Helper) ModelAndDocsPathV2(serviceModelName string) string { + + modelPath := filepath.Join( + h.basePath, "codegen", "sdk-codegen", "aws-models", serviceModelName, ".json", + ) + + return modelPath +} + // FirstAPIVersion returns the first found API version for a service API. // (e.h. "2012-10-03") func (h *Helper) FirstAPIVersion(serviceModelName string) (string, error) { diff --git a/pkg/sdk/repo.go b/pkg/sdk/repo.go index da506ca6..e796f0f9 100644 --- a/pkg/sdk/repo.go +++ b/pkg/sdk/repo.go @@ -31,6 +31,7 @@ import ( const ( sdkRepoURL = "https://github.com/aws/aws-sdk-go" + sdkRepoURLV2 = "https://github.com/aws/aws-sdk-go-v2" defaultGitCloneTimeout = 180 * time.Second defaultGitFetchTimeout = 30 * time.Second ) @@ -112,17 +113,18 @@ func EnsureRepo( } // Clone repository if it doesn't exist - sdkDir := filepath.Join(srcPath, "aws-sdk-go") + + sdkDir := filepath.Join(srcPath, "aws-sdk-go-v2") if _, err = os.Stat(sdkDir); os.IsNotExist(err) { ctx, cancel := context.WithTimeout(ctx, defaultGitCloneTimeout) defer cancel() - err = util.CloneRepository(ctx, sdkDir, sdkRepoURL) + err = util.CloneRepository(ctx, sdkDir, sdkRepoURLV2) if err != nil { // See https://github.com/aws-controllers-k8s/community/issues/1642 if errors.Is(err, context.DeadlineExceeded) { err = fmt.Errorf("%w: take too long to clone aws sdk repo, "+ - "please consider manually 'git clone %s' to cache dir %s", err, sdkRepoURL, sdkDir) + "please consider manually 'git clone %s' to cache dir %s", err, sdkRepoURLV2, sdkDir) } return "", fmt.Errorf("cannot clone repository: %v", err) } @@ -136,6 +138,7 @@ func EnsureRepo( if err != nil { return "", fmt.Errorf("cannot fetch tags: %v", err) } + } // get sdkVersion and ensure it prefix @@ -208,7 +211,7 @@ func getSDKVersionFromGoMod(goModPath string) (string, error) { if err != nil { return "", err } - sdkModule := strings.TrimPrefix(sdkRepoURL, "https://") + sdkModule := strings.TrimPrefix(sdkRepoURLV2, "https://") for _, require := range goMod.Require { if require.Mod.Path == sdkModule { return require.Mod.Version, nil diff --git a/pkg/util/git.go b/pkg/util/git.go index e73d9536..629dca86 100644 --- a/pkg/util/git.go +++ b/pkg/util/git.go @@ -97,7 +97,9 @@ func getRepositoryTagRef(repo *git.Repository, tagName string) (*plumbing.Refere // // Calling This function is equivalent to executing `git checkout tags/$tag` func CheckoutRepositoryTag(repo *git.Repository, tag string) error { + tagRef, err := getRepositoryTagRef(repo, tag) + if err != nil { return err } @@ -105,9 +107,13 @@ func CheckoutRepositoryTag(repo *git.Repository, tag string) error { if err != nil { return err } + + // AWS-SDK-GO-V2 - Hash value for tag not found, hence use tagName to checkout err = wt.Checkout(&git.CheckoutOptions{ // Checkout only take hashes or branch names. - Hash: tagRef.Hash(), + //Hash: tagRef.Hash(), + Branch: tagRef.Name(), + Force: true, }) return err } diff --git a/templates/pkg/resource/manager.go.tpl b/templates/pkg/resource/manager.go.tpl index 40a62ebf..6f3821fd 100644 --- a/templates/pkg/resource/manager.go.tpl +++ b/templates/pkg/resource/manager.go.tpl @@ -23,6 +23,8 @@ import ( "github.com/go-logr/logr" corev1 "k8s.io/api/core/v1" svcsdk "github.com/aws/aws-sdk-go/service/{{ .ServicePackageName }}" + svcsdkV2{{ .ServicePackageName }} "github.com/aws/aws-sdk-go-v2/service/{{ .ServicePackageName }}" + "github.com/aws/aws-sdk-go-v2/aws" svcsdkapi "github.com/aws/aws-sdk-go/service/{{ .ServicePackageName }}/{{ .ServicePackageName }}iface" svcapitypes "github.com/aws-controllers-k8s/{{ .ControllerName }}-controller/apis/{{ .APIVersion }}" @@ -66,6 +68,13 @@ type resourceManager struct { // sdk is a pointer to the AWS service API interface exposed by the // aws-sdk-go/services/{alias}/{alias}iface package. sdkapi svcsdkapi.{{ .ClientInterfaceTypeName }} + + // This is for AWS-SDK-GO-V2 + config aws.Config + + // clientV2 is the AWS SDK V2 Client object used to communicate with the backend AWS Service API + // This is for AWS-SDK-GO-V2 + clientV2 *svcsdkV2{{ .ServicePackageName }}.Client } // concreteResource returns a pointer to a resource from the supplied @@ -314,6 +323,7 @@ func (rm *resourceManager) EnsureTags( // newResourceManager returns a new struct implementing // acktypes.AWSResourceManager +// This is for AWS-SDK-GO-V2 - Created newResourceManager With AWS sdk-Go-ClientV2 func newResourceManager( cfg ackcfg.Config, log logr.Logger, @@ -322,6 +332,8 @@ func newResourceManager( sess *session.Session, id ackv1alpha1.AWSAccountID, region ackv1alpha1.AWSRegion, + config aws.Config, + clientV2 *svcsdkV2{{ .ServicePackageName }}.Client, ) (*resourceManager, error) { return &resourceManager{ cfg: cfg, @@ -332,6 +344,8 @@ func newResourceManager( awsRegion: region, sess: sess, sdkapi: svcsdk.New(sess), + config: config, + clientV2: clientV2, }, nil } @@ -372,4 +386,4 @@ func (rm *resourceManager) onSuccess( return r, nil } return r1, nil -} +} \ No newline at end of file diff --git a/templates/pkg/resource/manager_factory.go.tpl b/templates/pkg/resource/manager_factory.go.tpl index d613b596..d46bae78 100644 --- a/templates/pkg/resource/manager_factory.go.tpl +++ b/templates/pkg/resource/manager_factory.go.tpl @@ -12,7 +12,9 @@ import ( acktypes "github.com/aws-controllers-k8s/runtime/pkg/types" "github.com/aws/aws-sdk-go/aws/session" "github.com/go-logr/logr" + "github.com/aws/aws-sdk-go-v2/aws" + svcsdkV2{{ .ServicePackageName }} "github.com/aws/aws-sdk-go-v2/service/{{ .ServicePackageName }}" svcresource "github.com/aws-controllers-k8s/{{ .ControllerName }}-controller/pkg/resource" ) @@ -29,7 +31,7 @@ type resourceManagerFactory struct { func (f *resourceManagerFactory) ResourceDescriptor() acktypes.AWSResourceDescriptor { return &resourceDescriptor{} } - +// This is for AWS-SDK-GO-V2 -- added sdk go V2 config as a parameter // ManagerFor returns a resource manager object that can manage resources for a // supplied AWS account func (f *resourceManagerFactory) ManagerFor( @@ -40,12 +42,9 @@ func (f *resourceManagerFactory) ManagerFor( sess *session.Session, id ackv1alpha1.AWSAccountID, region ackv1alpha1.AWSRegion, - roleARN ackv1alpha1.AWSResourceName, + config aws.Config, ) (acktypes.AWSResourceManager, error) { - // We use the account ID, region, and role ARN to uniquely identify a - // resource manager. This helps us to avoid creating multiple resource - // managers for the same account/region/roleARN combination. - rmId := fmt.Sprintf("%s/%s/%s", id, region, roleARN) + rmId := fmt.Sprintf("%s/%s", id, region) f.RLock() rm, found := f.rmCache[rmId] f.RUnlock() @@ -57,7 +56,11 @@ func (f *resourceManagerFactory) ManagerFor( f.Lock() defer f.Unlock() - rm, err := newResourceManager(cfg, log, metrics, rr, sess, id, region) + // This is for AWS-SDK-GO-V2 + // Create a client for {{ .ServicePackageName }} + clientV2 := svcsdkV2{{ .ServicePackageName }}.NewFromConfig(config) + + rm, err := newResourceManager(cfg, log, metrics, rr, sess, id, region,config, clientV2) if err != nil { return nil, err } @@ -88,4 +91,4 @@ func newResourceManagerFactory() *resourceManagerFactory { func init() { svcresource.RegisterManagerFactory(newResourceManagerFactory()) -} +} \ No newline at end of file diff --git a/templates/pkg/resource/sdk_update.go.tpl b/templates/pkg/resource/sdk_update.go.tpl index f613572d..d46bae78 100644 --- a/templates/pkg/resource/sdk_update.go.tpl +++ b/templates/pkg/resource/sdk_update.go.tpl @@ -1,77 +1,94 @@ -{{- define "sdk_update" -}} -func (rm *resourceManager) sdkUpdate( - ctx context.Context, - desired *resource, - latest *resource, - delta *ackcompare.Delta, -) (updated *resource, err error) { - rlog := ackrtlog.FromContext(ctx) - exit := rlog.Trace("rm.sdkUpdate") - defer func() { - exit(err) - }() -{{- if .CRD.HasImmutableFieldChanges }} - if immutableFieldChanges := rm.getImmutableFieldChanges(delta); len(immutableFieldChanges) > 0 { - msg := fmt.Sprintf("Immutable Spec fields have been modified: %s", strings.Join(immutableFieldChanges, ",")) - return nil, ackerr.NewTerminalError(fmt.Errorf(msg)) - } -{{- end }} -{{- if $hookCode := Hook .CRD "sdk_update_pre_build_request" }} -{{ $hookCode }} -{{- end }} -{{- if $customMethod := .CRD.GetCustomImplementation .CRD.Ops.Update }} - updated, err = rm.{{ $customMethod }}(ctx, desired, latest, delta) - if updated != nil || err != nil { - return updated, err - } -{{- end }} - input, err := rm.newUpdateRequestPayload(ctx, desired, delta) - if err != nil { - return nil, err - } -{{- if $hookCode := Hook .CRD "sdk_update_post_build_request" }} -{{ $hookCode }} -{{- end }} +{{ template "boilerplate" }} - var resp {{ .CRD.GetOutputShapeGoType .CRD.Ops.Update }}; _ = resp; - resp, err = rm.sdkapi.{{ .CRD.Ops.Update.ExportedName }}WithContext(ctx, input) -{{- if $hookCode := Hook .CRD "sdk_update_post_request" }} -{{ $hookCode }} -{{- end }} - rm.metrics.RecordAPICall("UPDATE", "{{ .CRD.Ops.Update.ExportedName }}", err) - if err != nil { - return nil, err +package {{ .CRD.Names.Snake }} + +import ( + "fmt" + "sync" + + ackv1alpha1 "github.com/aws-controllers-k8s/runtime/apis/core/v1alpha1" + ackcfg "github.com/aws-controllers-k8s/runtime/pkg/config" + ackmetrics "github.com/aws-controllers-k8s/runtime/pkg/metrics" + acktypes "github.com/aws-controllers-k8s/runtime/pkg/types" + "github.com/aws/aws-sdk-go/aws/session" + "github.com/go-logr/logr" + "github.com/aws/aws-sdk-go-v2/aws" + + svcsdkV2{{ .ServicePackageName }} "github.com/aws/aws-sdk-go-v2/service/{{ .ServicePackageName }}" + svcresource "github.com/aws-controllers-k8s/{{ .ControllerName }}-controller/pkg/resource" +) + +// resourceManagerFactory produces resourceManager objects. It implements the +// `types.AWSResourceManagerFactory` interface. +type resourceManagerFactory struct { + sync.RWMutex + // rmCache contains resource managers for a particular AWS account ID + rmCache map[string]*resourceManager +} + +// ResourcePrototype returns an AWSResource that resource managers produced by +// this factory will handle +func (f *resourceManagerFactory) ResourceDescriptor() acktypes.AWSResourceDescriptor { + return &resourceDescriptor{} +} +// This is for AWS-SDK-GO-V2 -- added sdk go V2 config as a parameter +// ManagerFor returns a resource manager object that can manage resources for a +// supplied AWS account +func (f *resourceManagerFactory) ManagerFor( + cfg ackcfg.Config, + log logr.Logger, + metrics *ackmetrics.Metrics, + rr acktypes.Reconciler, + sess *session.Session, + id ackv1alpha1.AWSAccountID, + region ackv1alpha1.AWSRegion, + config aws.Config, +) (acktypes.AWSResourceManager, error) { + rmId := fmt.Sprintf("%s/%s", id, region) + f.RLock() + rm, found := f.rmCache[rmId] + f.RUnlock() + + if found { + return rm, nil } - // Merge in the information we read from the API call above to the copy of - // the original Kubernetes object we passed to the function - ko := desired.ko.DeepCopy() -{{- if $hookCode := Hook .CRD "sdk_update_pre_set_output" }} -{{ $hookCode }} -{{- end }} -{{ GoCodeSetUpdateOutput .CRD "resp" "ko" 1 }} - rm.setStatusDefaults(ko) -{{- if $setOutputCustomMethodName := .CRD.SetOutputCustomMethodName .CRD.Ops.Update }} - // custom set output from response - ko, err = rm.{{ $setOutputCustomMethodName }}(ctx, desired, resp, ko) + + f.Lock() + defer f.Unlock() + + // This is for AWS-SDK-GO-V2 + // Create a client for {{ .ServicePackageName }} + clientV2 := svcsdkV2{{ .ServicePackageName }}.NewFromConfig(config) + + rm, err := newResourceManager(cfg, log, metrics, rr, sess, id, region,config, clientV2) if err != nil { return nil, err } + f.rmCache[rmId] = rm + return rm, nil +} + +// IsAdoptable returns true if the resource is able to be adopted +func (f *resourceManagerFactory) IsAdoptable() bool { + return {{ .CRD.IsAdoptable }} +} + +// RequeueOnSuccessSeconds returns true if the resource should be requeued after specified seconds +// Default is false which means resource will not be requeued after success. +func (f *resourceManagerFactory) RequeueOnSuccessSeconds() int { +{{- if $reconcileRequeuOnSuccessSeconds := .CRD.ReconcileRequeuOnSuccessSeconds }} + return {{ $reconcileRequeuOnSuccessSeconds }} +{{- else }} + return 0 {{- end }} -{{- if $hookCode := Hook .CRD "sdk_update_post_set_output" }} -{{ $hookCode }} -{{- end }} - return &resource{ko}, nil } -// newUpdateRequestPayload returns an SDK-specific struct for the HTTP request -// payload of the Update API call for the resource -func (rm *resourceManager) newUpdateRequestPayload( - ctx context.Context, - r *resource, - delta *ackcompare.Delta, -) (*svcsdk.{{ .CRD.Ops.Update.InputRef.Shape.ShapeName }}, error) { - res := &svcsdk.{{ .CRD.Ops.Update.InputRef.Shape.ShapeName }}{} -{{ GoCodeSetUpdateInput .CRD "r.ko" "res" 1 }} - return res, nil +func newResourceManagerFactory() *resourceManagerFactory { + return &resourceManagerFactory{ + rmCache: map[string]*resourceManager{}, + } } -{{- end -}} + +func init() { + svcresource.RegisterManagerFactory(newResourceManagerFactory()) +} \ No newline at end of file From a80dcbef495cf62b3f8a93d1739af08e636bb443 Mon Sep 17 00:00:00 2001 From: rkurduka Date: Wed, 16 Oct 2024 10:15:38 +0530 Subject: [PATCH 2/4] readfile changes - to read from modelPath --- apiv2/readApiV2.go | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/apiv2/readApiV2.go b/apiv2/readApiV2.go index 0570386d..4da4d826 100644 --- a/apiv2/readApiV2.go +++ b/apiv2/readApiV2.go @@ -4,8 +4,6 @@ import ( "encoding/json" "errors" "io/ioutil" - "os" - "path/filepath" "strings" "unicode" @@ -53,12 +51,12 @@ func (Obj *ServiceObjV2) CapitaliseName(name *string) string { } -func ReadV2file(serviceAlias string) (*ServiceObjV2, error) { +func ReadV2file(filepath string) (*ServiceObjV2, error) { var Obj ServiceObjV2 - dir, _ := os.Getwd() - filepath := filepath.Join(dir + "/apiv2/" + serviceAlias + ".json") + // dir, _ := os.Getwd() + // filepath := filepath.Join(dir + "/apiv2/" + serviceAlias + ".json") file, err := ioutil.ReadFile(filepath) From c1f6ad6baa21e5927468c6b8bacaf1e392bb7725 Mon Sep 17 00:00:00 2001 From: michaelhtm <98621731+michaelhtm@users.noreply.github.com> Date: Mon, 23 Dec 2024 11:46:40 -0800 Subject: [PATCH 3/4] Generating SQS controller with V2 works!! --- apiv2/converter.go | 284 ++++++++++++++++++ apiv2/loadModelV2.go | 258 ---------------- apiv2/readApiV2.go | 200 ------------ cmd/ack-generate/command/common.go | 3 +- cmd/ack-generate/command/root.go | 2 +- go.mod | 4 + go.sum | 8 +- pkg/generate/ack/controller.go | 1 + pkg/generate/code/compare.go | 2 +- pkg/generate/code/set_resource.go | 234 +++++++-------- pkg/generate/code/set_sdk.go | 183 ++++++----- pkg/model/field.go | 13 +- pkg/model/model.go | 6 +- pkg/model/multiversion/manager.go | 3 +- pkg/model/sdk_api.go | 4 +- pkg/sdk/custom_shapes_test.go | 2 +- pkg/sdk/helper.go | 187 ++++++------ pkg/sdk/helper_test.go | 2 +- pkg/sdk/repo.go | 4 +- pkg/testutil/schema_helper.go | 4 +- scripts/build-controller.sh | 1 + templates/pkg/resource/manager.go.tpl | 44 +-- templates/pkg/resource/manager_factory.go.tpl | 17 +- templates/pkg/resource/sdk.go.tpl | 13 +- .../resource/sdk_find_get_attributes.go.tpl | 4 +- .../pkg/resource/sdk_find_read_many.go.tpl | 4 +- .../pkg/resource/sdk_find_read_one.go.tpl | 4 +- templates/pkg/resource/sdk_update.go.tpl | 153 +++++----- .../resource/sdk_update_set_attributes.go.tpl | 2 +- 29 files changed, 734 insertions(+), 912 deletions(-) create mode 100644 apiv2/converter.go delete mode 100644 apiv2/loadModelV2.go delete mode 100644 apiv2/readApiV2.go diff --git a/apiv2/converter.go b/apiv2/converter.go new file mode 100644 index 00000000..b2e22a94 --- /dev/null +++ b/apiv2/converter.go @@ -0,0 +1,284 @@ +package apiv2 + +import ( + "encoding/json" + "errors" + "fmt" + "os" + "strings" + + "github.com/aws-controllers-k8s/code-generator/pkg/api" +) + +type API struct { + Shapes map[string]Shape +} + +type Shape struct { + Type string + Traits map[string]interface{} + MemberRefs map[string]*ShapeRef `json:"members"` + MemberRef *ShapeRef `json:"member"` + KeyRef ShapeRef `json:"key"` + ValueRef ShapeRef `json:"value"` + InputRef ShapeRef `json:"input"` + OutputRef ShapeRef `json:"output"` + ErrorRefs []ShapeRef `json:"errors"` +} + +type ShapeRef struct { + API *API `json:"-"` + Shape *Shape `json:"-"` + ShapeName string `json:"target"` + Traits map[string]interface{} +} + +func ConvertApiV2Shapes(modelPath string) (map[string]*api.API, error) { + + // Read the json file + file, err := os.ReadFile(modelPath) + if err != nil { + return nil, fmt.Errorf("error reading file: %v", err) + } + + // unmarshal the file + var customAPI API + err = json.Unmarshal(file, &customAPI) + if err != nil { + return nil, fmt.Errorf("error unmarshalling file: %v", err) + } + + serviceAlias := extractServiceAlias(modelPath) + + newApi, err := BuildAPI(customAPI.Shapes, serviceAlias) + if err != nil { + return nil, fmt.Errorf("error building api: %v", err) + } + + newApi.StrictServiceId = true + + err = newApi.Setup() + if err != nil { + return nil, fmt.Errorf("error setting up api: %v", err) + } + + return map[string]*api.API{ + serviceAlias: newApi, + }, nil +} + +// This function tries to translate the API from sdk go v2 +// into the struct for sdk go v1 +func BuildAPI(shapes map[string]Shape, serviceAlias string) (*api.API, error) { + + newApi := api.API{ + Metadata: api.Metadata{}, + Operations: map[string]*api.Operation{}, + Shapes: map[string]*api.Shape{}, + } + + for shapeName, shape := range shapes { + + name := removeNamePrefix(shapeName, serviceAlias) + if shape.Type != "service" && shape.Type != "operation" { + newShape, err := createApiShape(shape) + if err != nil { + return nil, err + } + newApi.Shapes[name] = newShape + } + + switch shape.Type { + case "service": + serviceId, ok := shape.Traits["aws.api#service"].(map[string]interface{})["sdkId"] + if !ok { + return nil, errors.New("service id not found") + } + newApi.Metadata.ServiceID = serviceId.(string) + doc, ok := shape.Traits["smithy.api#documentation"] + if !ok { + return nil, errors.New("service documentation not found") + } + newApi.Documentation = api.AppendDocstring("", doc.(string)) + case "operation": + newApi.Operations[name] = createApiOperation(shape, name, serviceAlias) + case "structure": + AddMemberRefs(newApi.Shapes[name], shape, serviceAlias) + case "list": + AddMemberRef(newApi.Shapes[name], name, shape, serviceAlias) + case "map": + AddKeyAndValueRef(newApi.Shapes[name], name, shape, serviceAlias) + case "enum": + AddEnumRef(newApi.Shapes[name], shape) + } + + } + + return &newApi, nil +} + +func createApiOperation(shape Shape, name, serviceAlias string) *api.Operation { + + newOperation := &api.Operation{ + Name: name, + Documentation: api.AppendDocstring("", shape.Traits["smithy.api#documentation"].(string)), + } + + if hasPrefix(shape.InputRef.ShapeName, serviceAlias) { + inputName := removeNamePrefix(shape.InputRef.ShapeName, serviceAlias) + newOperation.InputRef = api.ShapeRef{ + ShapeName: inputName, + } + } + if hasPrefix(shape.OutputRef.ShapeName, serviceAlias) { + outputName := removeNamePrefix(shape.OutputRef.ShapeName, serviceAlias) + newOperation.OutputRef = api.ShapeRef{ + ShapeName: outputName, + } + } + + for _, err := range shape.ErrorRefs { + newOperation.ErrorRefs = append(newOperation.ErrorRefs, api.ShapeRef{ + ShapeName: removeNamePrefix(err.ShapeName, serviceAlias), + }) + } + + return newOperation +} + +func createApiShape(shape Shape) (*api.Shape, error) { + + isException := shape.IsException() + + shapeType := shape.Type + if shapeType == "enum" { + shapeType = "string" + } + + apiShape := &api.Shape{ + Type: shapeType, + Exception: isException, + MemberRefs: make(map[string]*api.ShapeRef), + MemberRef: api.ShapeRef{}, + KeyRef: api.ShapeRef{}, + ValueRef: api.ShapeRef{}, + Required: []string{}, + } + val, ok := shape.Traits["smithy.api#default"] + if ok { + apiShape.DefaultValue = &val + } + + if isException { + code, ok := shape.Traits["smithy.api#httpError"] + if ok { + switch code := code.(type) { + case float64: + apiShape.ErrorInfo = api.ErrorInfo{ + HTTPStatusCode: int(code), + } + case int: + apiShape.ErrorInfo = api.ErrorInfo{ + HTTPStatusCode: code, + } + case int64: + apiShape.ErrorInfo = api.ErrorInfo{ + HTTPStatusCode: int(code), + } + default: + return nil, fmt.Errorf("status code type not found for exception") + } + } + } + + return apiShape, nil +} + +func AddMemberRefs(apiShape *api.Shape, shape Shape, serviceAlias string) { + + var documentation string + for memberName, member := range shape.MemberRefs { + if !hasPrefix(member.ShapeName, serviceAlias) { + continue + } + shapeNameClean := removeNamePrefix(member.ShapeName, serviceAlias) + if member.Traits["smithy.api#documentation"] != nil { + documentation = api.AppendDocstring("", member.Traits["smithy.api#documentation"].(string)) + } + if member.IsRequired() { + apiShape.Required = append(apiShape.Required, memberName) + } + apiShape.MemberRefs[memberName] = &api.ShapeRef{ + ShapeName: shapeNameClean, + Documentation: documentation, + } + } + + if shape.Traits["smithy.api#documentation"] != nil { + documentation = api.AppendDocstring("", shape.Traits["smithy.api#documentation"].(string)) + } + // Add the documentation to the shape + apiShape.Documentation = documentation +} + +func AddMemberRef(apiShape *api.Shape, shapeName string, shape Shape, serviceAlias string) { + + apiShape.MemberRef = api.ShapeRef{ + ShapeName: removeNamePrefix(shape.MemberRef.ShapeName, serviceAlias), + } +} + +func AddKeyAndValueRef(apiShape *api.Shape, shapeName string, shape Shape, serviceAlias string) { + + apiShape.KeyRef = api.ShapeRef{ + ShapeName: removeNamePrefix(shape.KeyRef.ShapeName, serviceAlias), + } + apiShape.ValueRef = api.ShapeRef{ + ShapeName: removeNamePrefix(shape.ValueRef.ShapeName, serviceAlias), + } +} + +func AddEnumRef(apiShape *api.Shape, shape Shape) { + for memberName := range shape.MemberRefs { + apiShape.Enum = append(apiShape.Enum, memberName) + } +} + +func (s ShapeRef) IsRequired() bool { + _, ok := s.Traits["smithy.api#required"] + return ok +} + +func (s Shape) IsException() bool { + _, ok := s.Traits["smithy.api#error"] + return ok +} + +func hasPrefix(name, alias string) bool { + + prefix := fmt.Sprintf("com.amazonaws.%s#", alias) + + return strings.HasPrefix(name, prefix) +} + +func removeNamePrefix(name, alias string) string { + + toTrim := fmt.Sprintf("com.amazonaws.%s#", alias) + + newName := strings.TrimPrefix(name, toTrim) + + return newName +} + +func extractServiceAlias(modelPath string) string { + // Split the path into parts + parts := strings.Split(modelPath, "/") + + // Get the last part + lastPart := parts[len(parts)-1] + + // Split the last part by "." to get the service alias + serviceAlias := strings.Split(lastPart, ".")[0] + + return serviceAlias +} diff --git a/apiv2/loadModelV2.go b/apiv2/loadModelV2.go deleted file mode 100644 index 7f8f1cc6..00000000 --- a/apiv2/loadModelV2.go +++ /dev/null @@ -1,258 +0,0 @@ -package apiv2 - -import ( - "strings" - - sdkmodel "github.com/aws/aws-sdk-go/private/model/api" -) - -type ModelV2Shape struct { - Name string - Raw_shape map[string]interface{} - ServiceAlias string - ServiceObjV2 -} - -func NewModelV2Shape(raw_shape interface{}, key string, serviceAlias string) *ModelV2Shape { - - return &ModelV2Shape{ - Name: key, - Raw_shape: raw_shape.(map[string]interface{}), - ServiceAlias: serviceAlias, - } -} - -func (m *ModelV2Shape) GetShapeType() string { - - for key, value := range m.Raw_shape { - if key == "type" { - switch value.(string) { - case "structure": - return "structure" - case "map": - return "map" - case "list": - return "list" - case "string": - return "string" - case "integer": - return "integer" - case "long": - return "long" - case "double": - return "double" - case "boolean": - return "boolean" - case "timestamp": - return "timestamp" - case "enum": - return "enum" - case "operation": - return "operation" - case "blob": - return "blob" - default: - return "unknown" - } - } - } - return "unknown" -} - -func (m *ModelV2Shape) CreateShape(name string) *sdkmodel.Shape { - - api := sdkmodel.API{} - - api.AddImport("time") - - new_shape := &sdkmodel.Shape{ - ShapeName: *m.RemovePrefix(name, m.ServiceAlias), - Exception: false, - MemberRefs: make(map[string]*sdkmodel.ShapeRef), - MemberRef: sdkmodel.ShapeRef{}, - API: &api, - } - - if Type, ok := m.Raw_shape["type"]; ok { - if Type.(string) == "enum" { - new_shape.Type = "string" - } else { - new_shape.Type = Type.(string) - } - } - - return new_shape - -} - -func (m *ModelV2Shape) AddDefaultMembers(new_shape *sdkmodel.Shape) *sdkmodel.Shape { - - if m.GetShapeType() != "structure" || m.GetShapeType() != "list" || m.GetShapeType() != "enum" { - for key, _ := range m.Raw_shape { - new_shape.MemberRefs[key] = &sdkmodel.ShapeRef{ - Shape: m.CreateShape(*m.RemovePrefix(key, m.ServiceAlias)), - ShapeName: *m.RemovePrefix(key, m.ServiceAlias), - } - } - } - - return new_shape -} - -func (m *ModelV2Shape) AddStructMembers(new_shape *sdkmodel.Shape) *sdkmodel.Shape { - - if m.GetShapeType() == "structure" { - - for key, members := range m.Raw_shape["members"].(map[string]interface{}) { - - if value, ok := members.(map[string]interface{})["target"]; ok { - - valueRawShape := GetRawShape(value.(string)) - memberModel := NewModelV2Shape(valueRawShape, value.(string), m.ServiceAlias) - key = memberModel.CapitaliseName(&key) - - new_shape.MemberRefs[key] = &sdkmodel.ShapeRef{ - Shape: memberModel.CreateShape(*memberModel.RemovePrefix(value.(string), memberModel.ServiceAlias)), - ShapeName: *memberModel.RemovePrefix(value.(string), memberModel.ServiceAlias), - } - - switch new_shape.MemberRefs[key].Shape.Type { - case "list": - new_shape.MemberRefs[key].Shape = memberModel.AddListRef(new_shape.MemberRefs[key].Shape) - case "structure": - new_shape.MemberRefs[key].Shape = memberModel.AddStructMembers(new_shape.MemberRefs[key].Shape) - } - if memberModel.GetShapeType() == "enum" { - new_shape.MemberRefs[key].Shape = memberModel.AddEnumValues(new_shape.MemberRefs[key].Shape) - } - - } - - } - } - return new_shape -} - -func (m *ModelV2Shape) AddListRef(new_shape *sdkmodel.Shape) *sdkmodel.Shape { - - if m.GetShapeType() == "list" { - for _, members := range m.Raw_shape["member"].(map[string]interface{}) { - - if value, ok := members.(string); ok { - - valueRawShape := GetRawShape(value) - memberModel := NewModelV2Shape(valueRawShape, new_shape.ShapeName, m.ServiceAlias) - - new_shape.MemberRef = sdkmodel.ShapeRef{ - Shape: memberModel.CreateShape(*memberModel.RemovePrefix(value, memberModel.ServiceAlias)), - ShapeName: *memberModel.RemovePrefix(value, memberModel.ServiceAlias), - } - - switch new_shape.MemberRef.Shape.Type { - case "structure": - new_shape.MemberRef.Shape = memberModel.AddStructMembers(new_shape.MemberRef.Shape) - default: - new_shape.MemberRef.Shape = memberModel.AddDefaultMembers(new_shape.MemberRef.Shape) - - } - - } - - } - } - return new_shape -} - -func (m *ModelV2Shape) AddEnumValues(new_shape *sdkmodel.Shape) *sdkmodel.Shape { - - if m.GetShapeType() == "enum" { - for key := range m.Raw_shape["members"].(map[string]interface{}) { - new_shape.Enum = append(new_shape.Enum, key) - } - } - - return new_shape -} - -func (m *ModelV2Shape) CreateOperation(name string) *sdkmodel.Operation { - - if m.GetShapeType() == "operation" { - new_operation := &sdkmodel.Operation{ - Name: name, - ExportedName: *m.RemovePrefix(name, serviceAlias), - } - return new_operation - - } - return nil - -} - -func (m *ModelV2Shape) AddInputShapeRef(newOperation *sdkmodel.Operation, input interface{}) *sdkmodel.Operation { - - inputShapeName := input.(map[string]interface{})["target"] - inputRawShape := GetRawShape(inputShapeName.(string)) - - name := m.RemovePrefix(inputShapeName.(string), m.ServiceAlias) - name = m.ReplaceShapeSuffixRequest(*name, m.ServiceAlias) - - inputShapeModel := NewModelV2Shape(inputRawShape, *name, m.ServiceAlias) - - if _, ok := shapes[inputShapeModel.Name]; ok { - newOperation.InputRef = sdkmodel.ShapeRef{ - Shape: shapes[inputShapeModel.Name], - ShapeName: inputShapeModel.Name, - } - } else { - newOperation.InputRef = sdkmodel.ShapeRef{ - Shape: inputShapeModel.CreateShape(inputShapeModel.Name), - ShapeName: inputShapeModel.Name, - } - shapes[newOperation.InputRef.ShapeName] = newOperation.InputRef.Shape - } - - return newOperation - -} - -func (m *ModelV2Shape) AddOutputShapeRef(newOperation *sdkmodel.Operation, output interface{}) *sdkmodel.Operation { - - outputShapeName := output.(map[string]interface{})["target"] - outputRawShape := GetRawShape(outputShapeName.(string)) - - name := m.RemovePrefix(outputShapeName.(string), m.ServiceAlias) - name = m.ReplaceShapeSuffixRequest(*name, m.ServiceAlias) - outputShapeModel := NewModelV2Shape(outputRawShape, *name, m.ServiceAlias) - - if outputShapeModel.Name == "smithy.api#Unit" { - - newOperation.OutputRef = sdkmodel.ShapeRef{ - Shape: outputShapeModel.CreateShape(newOperation.Name + "Output"), - ShapeName: newOperation.Name + "Output", - } - newOperation.OutputRef.Shape.Type = "structure" - shapes[newOperation.OutputRef.ShapeName] = newOperation.OutputRef.Shape - - return newOperation - - } - - if OpOutputRef, ok := shapes[outputShapeModel.Name]; ok { - - var OutputShapeName string - if strings.HasSuffix(OpOutputRef.ShapeName, "Description") { - - OutputShapeName = newOperation.Name + "Output" - outputShapeModel.Name = OutputShapeName - outPutShape := BuildModelV2(outputShapeModel) - newOperation.OutputRef.Shape = outPutShape - return newOperation - - } - newOperation.OutputRef.Shape = OpOutputRef - - } - - return newOperation - -} diff --git a/apiv2/readApiV2.go b/apiv2/readApiV2.go deleted file mode 100644 index 4da4d826..00000000 --- a/apiv2/readApiV2.go +++ /dev/null @@ -1,200 +0,0 @@ -package apiv2 - -import ( - "encoding/json" - "errors" - "io/ioutil" - "strings" - "unicode" - - sdkmodel "github.com/aws/aws-sdk-go/private/model/api" -) - -var ( - serviceAlias string - shapes = make(map[string]*sdkmodel.Shape) - operations = make(map[string]*sdkmodel.Operation) - raw_shapes map[string]interface{} -) - -type ServiceObjV2 map[string]interface{} -type APIs map[string]*sdkmodel.API - -func (Obj *ServiceObjV2) RemovePrefix(key string, serviceAlias string) *string { - - to_Trim := "com.amazonaws." + serviceAlias + "#" - new_key := strings.TrimPrefix(key, to_Trim) - - return &new_key -} - -func (Obj *ServiceObjV2) ReplaceShapeSuffixRequest(key string, serviceAlias string) *string { - if strings.HasSuffix(key, "Request") { - new_key := strings.Replace(key, "Request", "Input", 1) - return &new_key - } else if strings.HasSuffix(key, "Response") { - new_key := strings.Replace(key, "Response", "Output", 1) - return &new_key - } - - return &key -} - -func (Obj *ServiceObjV2) CapitaliseName(name *string) string { - - runes := []rune(*name) - if unicode.IsUpper(runes[0]) { - return *name - } - runes[0] = unicode.ToUpper(runes[0]) - return string(runes) - -} - -func ReadV2file(filepath string) (*ServiceObjV2, error) { - - var Obj ServiceObjV2 - - // dir, _ := os.Getwd() - // filepath := filepath.Join(dir + "/apiv2/" + serviceAlias + ".json") - - file, err := ioutil.ReadFile(filepath) - - if err != nil { - return nil, err - } - err = json.Unmarshal(file, &Obj) - if err != nil { - return nil, err - } - return &Obj, nil -} - -func CheckShapes(Obj *ServiceObjV2) (interface{}, error) { - if value, ok := (*Obj)["shapes"]; ok { - raw_shapes = value.(map[string]interface{}) - return raw_shapes, nil - } - return nil, errors.New("shapes not found") -} - -func GetRawShape(key string) map[string]interface{} { - - if raw_shape, ok := raw_shapes[key]; ok { - - return raw_shape.(map[string]interface{}) - } - - return nil -} - -func BuildModelV2(m *ModelV2Shape) *sdkmodel.Shape { - - if m.GetShapeType() == "structure" { - newShape := m.CreateShape(m.Name) - newShape = m.AddStructMembers(newShape) - - return newShape - - } else if m.GetShapeType() == "list" { - newShape := m.CreateShape(m.Name) - - newShape = m.AddListRef(newShape) - - return newShape - - } else if m.GetShapeType() == "enum" { - newShape := m.CreateShape(m.Name) - newShape = m.AddEnumValues(newShape) - - return newShape - - } else if m.GetShapeType() == "integer" || m.GetShapeType() == "long" || m.GetShapeType() == "string" || m.GetShapeType() == "boolean" { - newShape := m.CreateShape(m.Name) - - return newShape - - } - return nil -} - -func LoadModelV2(shapes map[string]*sdkmodel.Shape, operations map[string]*sdkmodel.Operation, serviceAlias string) map[string]*sdkmodel.API { - - api := sdkmodel.API{ - Shapes: shapes, - Operations: operations, - } - - api.StrictServiceId = true - api.Metadata.ServiceID = serviceAlias - - apis := APIs{} - /// Need to add pull path here as key in APIsmap - apis[serviceAlias] = &api - - return apis - -} - -// Write a main function to call ReadV2file and PrintV2Obj -func CollectApis(modelPath string) map[string]*sdkmodel.API { - - Obj, err := ReadV2file(modelPath) - - if err != nil { - panic(err.Error()) - - } - - if raw_shapes, err := CheckShapes(Obj); err != nil { - - panic(err.Error()) - - } else { - - for key, raw_shape := range raw_shapes.(map[string]interface{}) { - - name := Obj.RemovePrefix(key, serviceAlias) - name = Obj.ReplaceShapeSuffixRequest(*name, serviceAlias) - - m := NewModelV2Shape(raw_shape, *name, serviceAlias) - newShape := BuildModelV2(m) - - if newShape != nil { - - shapes[newShape.ShapeName] = newShape - - } - - } - - for key, raw_shape := range raw_shapes.(map[string]interface{}) { - - name := Obj.RemovePrefix(key, serviceAlias) - name = Obj.ReplaceShapeSuffixRequest(*name, serviceAlias) - - m := NewModelV2Shape(raw_shape, *name, serviceAlias) - - if m.GetShapeType() == "operation" { - - op := m.CreateOperation(m.Name) - - if input, ok := m.Raw_shape["input"]; ok { - op = m.AddInputShapeRef(op, input) - - } - if output, ok := m.Raw_shape["output"]; ok { - op = m.AddOutputShapeRef(op, output) - - } - - operations[op.Name] = op - - } - - } - - } - ApisV2 := LoadModelV2(shapes, operations, serviceAlias) - return ApisV2 -} diff --git a/cmd/ack-generate/command/common.go b/cmd/ack-generate/command/common.go index c7e789f4..c7ce27f2 100644 --- a/cmd/ack-generate/command/common.go +++ b/cmd/ack-generate/command/common.go @@ -62,7 +62,8 @@ func loadModel(svcAlias string, apiVersion string, apiGroup string, defaultCfg a return nil, err } // Retry using path found by querying service ID - sdkAPI, err = sdkHelper.API(retryModelName) + // sdkAPI, err = sdkHelper.API(retryModelName) + sdkAPI, err = sdkHelper.APIV2(retryModelName) if err != nil { return nil, fmt.Errorf("service %s not found", svcAlias) } diff --git a/cmd/ack-generate/command/root.go b/cmd/ack-generate/command/root.go index 38fc5266..2116d257 100644 --- a/cmd/ack-generate/command/root.go +++ b/cmd/ack-generate/command/root.go @@ -110,7 +110,7 @@ func init() { &optCacheDir, "cache-dir", defaultCacheDir, "Path to directory to store cached files (including clone'd aws-sdk-go repo)", ) rootCmd.PersistentFlags().BoolVar( - &optRefreshCache, "refresh-cache", true, "If true, and aws-sdk-go repo is already cloned, will git pull the latest aws-sdk-go commit", + &optRefreshCache, "refresh-cache", false, "If true, and aws-sdk-go repo is already cloned, will git pull the latest aws-sdk-go commit", ) rootCmd.PersistentFlags().StringVar( &optGeneratorConfigPath, "generator-config-path", "", "Path to file containing instructions for code generation to use", diff --git a/go.mod b/go.mod index 223f320b..600f5096 100644 --- a/go.mod +++ b/go.mod @@ -25,10 +25,14 @@ require ( sigs.k8s.io/controller-runtime v0.19.0 ) +replace github.com/aws-controllers-k8s/runtime => github.com/michaelhtm/ack-runtime v0.40.1-0.20250103184439-808a0d98774f + require ( dario.cat/mergo v1.0.0 // indirect github.com/Microsoft/go-winio v0.6.1 // indirect github.com/ProtonMail/go-crypto v0.0.0-20230828082145-3c4c8a2d2371 // indirect + github.com/aws/aws-sdk-go-v2 v1.32.6 // indirect + github.com/aws/smithy-go v1.22.1 // indirect github.com/beorn7/perks v1.0.1 // indirect github.com/blang/semver/v4 v4.0.0 // indirect github.com/cespare/xxhash/v2 v2.3.0 // indirect diff --git a/go.sum b/go.sum index 68bdd93e..47f2a211 100644 --- a/go.sum +++ b/go.sum @@ -73,10 +73,12 @@ github.com/asaskevich/govalidator v0.0.0-20180720115003-f9ffefc3facf/go.mod h1:l github.com/asaskevich/govalidator v0.0.0-20190424111038-f61b66f89f4a/go.mod h1:lB+ZfQJz7igIIfQNfa7Ml4HSf2uFQQRzpGGRXenZAgY= github.com/aws-controllers-k8s/pkg v0.0.15 h1:C1pnD/aDqJsU9oYf5upHkpSc+Hv4JQVtkdCpfZQIPig= github.com/aws-controllers-k8s/pkg v0.0.15/go.mod h1:VvdjLWmR6IJ3KU8KByKiq/lJE8M+ur2piXysXKTGUS0= -github.com/aws-controllers-k8s/runtime v0.40.0 h1:FplFYgzCIbQsPafarP3dy/4bG1uGR8G1OLYOWO4a7Lc= -github.com/aws-controllers-k8s/runtime v0.40.0/go.mod h1:G07g26y1cxyZO6Ngp+LwXf03CqFyLNL7os4Py4IdyGY= github.com/aws/aws-sdk-go v1.49.0 h1:g9BkW1fo9GqKfwg2+zCD+TW/D36Ux+vtfJ8guF4AYmY= github.com/aws/aws-sdk-go v1.49.0/go.mod h1:LF8svs817+Nz+DmiMQKTO3ubZ/6IaTpq3TjupRn3Eqk= +github.com/aws/aws-sdk-go-v2 v1.32.6 h1:7BokKRgRPuGmKkFMhEg/jSul+tB9VvXhcViILtfG8b4= +github.com/aws/aws-sdk-go-v2 v1.32.6/go.mod h1:P5WJBrYqqbWVaOxgH0X/FYYD47/nooaPOZPlQdmiN2U= +github.com/aws/smithy-go v1.22.1 h1:/HPHZQ0g7f4eUeK6HKglFz8uwVfZKgoI25rb/J+dnro= +github.com/aws/smithy-go v1.22.1/go.mod h1:irrKGvNn1InZwb2d7fkIRNucdfwR8R+Ts3wxYa/cJHg= github.com/beorn7/perks v0.0.0-20180321164747-3a771d992973/go.mod h1:Dwedo/Wpr24TaqPxmxbtue+5NUziq4I4S80YR8gNf3Q= github.com/beorn7/perks v1.0.0/go.mod h1:KWe93zE9D1o94FZ5RNwFwVgaQK1VOXiVxmqh+CedLV8= github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM= @@ -431,6 +433,8 @@ github.com/mattn/go-isatty v0.0.12/go.mod h1:cbi8OIDigv2wuxKPP5vlRcQ1OAZbq2CE4Ky github.com/mattn/go-runewidth v0.0.2/go.mod h1:LwmH8dsx7+W8Uxz3IHJYH5QSwggIsqBzpuz5H//U1FU= github.com/matttproud/golang_protobuf_extensions v1.0.1/go.mod h1:D8He9yQNgCq6Z5Ld7szi9bcBfOoFv/3dc6xSMkL2PC0= github.com/matttproud/golang_protobuf_extensions v1.0.2-0.20181231171920-c182affec369/go.mod h1:BSXmuO+STAnVfrANrmjBb36TMTDstsz7MSK+HVaYKv4= +github.com/michaelhtm/ack-runtime v0.40.1-0.20250103184439-808a0d98774f h1:+iOvn5LckQbtvIcf0JazTEyIpvWBns76snBPv6xEptI= +github.com/michaelhtm/ack-runtime v0.40.1-0.20250103184439-808a0d98774f/go.mod h1:8pIhYHIFOZuI9RembiZOmrGrUq0GwAoB/ia89gxlkOQ= github.com/miekg/dns v1.0.14/go.mod h1:W1PPwlIAgtquWBMBEV9nkV9Cazfe8ScdGz/Lj7v3Nrg= github.com/mikefarah/yq/v3 v3.0.0-20201202084205-8846255d1c37/go.mod h1:dYWq+UWoFCDY1TndvFUQuhBbIYmZpjreC8adEAx93zE= github.com/mitchellh/cli v1.0.0/go.mod h1:hNIlj7HEI86fIcpObd7a0FcrxTWetlwJDGcceTlRvqc= diff --git a/pkg/generate/ack/controller.go b/pkg/generate/ack/controller.go index 783ea935..e134b58d 100644 --- a/pkg/generate/ack/controller.go +++ b/pkg/generate/ack/controller.go @@ -262,6 +262,7 @@ func Controller( if target == "tags.go.tpl" && crd.Config().TagsAreIgnored(crd.Names.Original) { continue } + outPath := filepath.Join("pkg/resource", crd.Names.Snake, strings.TrimSuffix(target, ".tpl")) tplPath := filepath.Join("pkg/resource", target) crdVars := &templateCRDVars{ diff --git a/pkg/generate/code/compare.go b/pkg/generate/code/compare.go index 35215a4e..37dd23b8 100644 --- a/pkg/generate/code/compare.go +++ b/pkg/generate/code/compare.go @@ -833,7 +833,7 @@ func fastCompareTypes( ) out += fmt.Sprintf( "%s}\n", indent, - ) + ) default: // For any other type, we can use the HasNilDifference function to // eliminate early on the case where one of the objects is nil and diff --git a/pkg/generate/code/set_resource.go b/pkg/generate/code/set_resource.go index f91d50a9..f34013f0 100644 --- a/pkg/generate/code/set_resource.go +++ b/pkg/generate/code/set_resource.go @@ -308,42 +308,9 @@ func SetResource( // ko.Status.VpnMemberships = field0 // This is for AWS-SDK-GO-V2 - if targetMemberShapeRef.Shape.IsEnum() { - - out += fmt.Sprintf( - "%sif %s != \"\" {\n", indent, sourceAdaptedVarName, - ) - - // } else if targetMemberShapeRef.Shape.Type == "long" && strings.HasSuffix(targetMemberShapeRef.ShapeName, "Value") { - - // out += fmt.Sprintf( - // "%sif %s > 0 {\n", indent, sourceAdaptedVarName, - // ) - - // else if targetMemberShapeRef.Shape.Type == "integer" { + if !targetMemberShapeRef.Shape.IsEnum() && !targetMemberShape.HasDefaultValue() { - // out += fmt.Sprintf( - // "%sif %s > 0 {\n", indent, sourceAdaptedVarName, - // ) - // } - - // } else if targetMemberShapeRef.Shape.Type == "boolean" && targetMemberShapeRef.Shape.GoType() == "bool" { - - // out += fmt.Sprintf( - // "%sif %s {\n", indent, sourceAdaptedVarName, - // ) - } else if targetMemberShapeRef.Shape.Type == "integer" || targetMemberShapeRef.Shape.Type == "long" { - - out += fmt.Sprintf( - "%sif %s > 0 {\n", indent, sourceAdaptedVarName, - ) - // } else if targetMemberShapeRef.Shape.Type == "boolean" { - - // out += fmt.Sprintf( - // "%sif %s {\n", indent, sourceAdaptedVarName, - // ) - - } else { + // if !sourceMemberShapeRef.Shape.IsEnum() && sourceMemberShapeRef.ShapeName != "Boolean" && sourceMemberShapeRef.Shape.ShapeName != "BooleanType" { out += fmt.Sprintf( "%sif %s != nil {\n", indent, sourceAdaptedVarName, @@ -355,8 +322,14 @@ func SetResource( ) switch targetMemberShape.Type { - case "list", "structure", "map": - { + case "list", "map", "structure": + if targetMemberShape.Type == "list" && targetMemberShape.MemberRef.Shape.Type == "string" { + out += fmt.Sprintf("%s%s = aws.StringSlice(%s)\n", indent, qualifiedTargetVar, sourceAdaptedVarName) + } else if targetMemberShape.Type == "map" && + targetMemberShape.KeyRef.Shape.Type == "string" && + targetMemberShape.ValueRef.Shape.Type == "string" { + out += fmt.Sprintf("%s%s = aws.StringMap(%s)\n", indent, qualifiedTargetVar, sourceAdaptedVarName) + } else { memberVarName := fmt.Sprintf("f%d", memberIndex) @@ -386,7 +359,6 @@ func SetResource( indentLevel+1, ) } - default: if setCfg != nil && setCfg.From != nil { @@ -401,17 +373,19 @@ func SetResource( indentLevel+1, ) } - out += fmt.Sprintf( - "%s} else {\n", indent, - ) + if !targetMemberShape.IsEnum() && !targetMemberShape.HasDefaultValue() { + out += fmt.Sprintf( + "%s} else {\n", indent, + ) - out += fmt.Sprintf( - "%s%s%s.%s = nil\n", indent, indent, - targetAdaptedVarName, f.Names.Camel, - ) - out += fmt.Sprintf( - "%s}\n", indent, - ) + out += fmt.Sprintf( + "%s%s%s.%s = nil\n", indent, indent, + targetAdaptedVarName, f.Names.Camel, + ) + out += fmt.Sprintf( + "%s}\n", indent, + ) + } } return out } @@ -660,12 +634,6 @@ func setResourceReadMany( // out += fmt.Sprintf( // "%sif %s {\n", indent, sourceAdaptedVarName, // ) - } else if targetMemberShapeRef.Shape.Type == "integer" || targetMemberShapeRef.Shape.Type == "long" { - - out += fmt.Sprintf( - "%sif %s > 0 {\n", innerForIndent, sourceAdaptedVarName, - ) - } else { out += fmt.Sprintf( "%sif %s != nil {\n", innerForIndent, sourceAdaptedVarName, @@ -679,7 +647,13 @@ func setResourceReadMany( ) switch sourceMemberShape.Type { case "list", "structure", "map": - { + if sourceMemberShape.Type == "list" && sourceMemberShape.MemberRef.Shape.Type == "string" { + out += fmt.Sprintf("%s%s = aws.StringSlice(%s)\n", indent, qualifiedTargetVar, sourceAdaptedVarName) + } else if sourceMemberShape.Type == "map" && + sourceMemberShape.KeyRef.Shape.Type == "string" && + sourceMemberShape.ValueRef.Shape.Type == "string" { + out += fmt.Sprintf("%s%s = aws.StringMap(%s)\n", indent, qualifiedTargetVar, sourceAdaptedVarName) + } else { memberVarName := fmt.Sprintf("f%d", memberIndex) out += varEmptyConstructorK8sType( cfg, r, @@ -912,7 +886,7 @@ func SetResourceGetAttributes( } } sort.Strings(sortedAttrFieldNames) - for _, fieldName := range sortedAttrFieldNames { + for index, fieldName := range sortedAttrFieldNames { adaptiveTargetVarName := targetVarName + cfg.PrefixConfig.StatusField if r.IsPrimaryARNField(fieldName) { if !mdGuardOut { @@ -922,7 +896,7 @@ func SetResourceGetAttributes( mdGuardOut = true } out += fmt.Sprintf( - "%stmpARN := ackv1alpha1.AWSResourceName(*%s.Attributes[\"%s\"])\n", + "%stmpARN := ackv1alpha1.AWSResourceName(%s.Attributes[\"%s\"])\n", indent, sourceVarName, fieldName, @@ -944,7 +918,7 @@ func SetResourceGetAttributes( mdGuardOut = true } out += fmt.Sprintf( - "%stmpOwnerID := ackv1alpha1.AWSAccountID(*%s.Attributes[\"%s\"])\n", + "%stmpOwnerID := ackv1alpha1.AWSAccountID(%s.Attributes[\"%s\"])\n", indent, sourceVarName, fieldName, @@ -962,13 +936,19 @@ func SetResourceGetAttributes( adaptiveTargetVarName = targetVarName + cfg.PrefixConfig.SpecField } out += fmt.Sprintf( - "%s%s.%s = %s.Attributes[\"%s\"]\n", + "%sf%d, _ := %s.Attributes[\"%s\"]\n", indent, - adaptiveTargetVarName, - fieldNames.Camel, + index, sourceVarName, fieldName, ) + out += fmt.Sprintf( + "%s%s.%s = &f%d\n", + indent, + adaptiveTargetVarName, + fieldNames.Camel, + index, + ) } return out } @@ -1709,6 +1689,19 @@ func SetResourceForStruct( var sourceAdaptedVarName, qualifiedTargetVar string for _, targetMemberName := range targetShape.MemberNames() { + // To check if the field member has `ignore` set to `true`. + // This condition currently applies only for members of a field whose shape is `structure`. + var setCfg *ackgenconfig.SetFieldConfig + f, ok := r.Fields[targetFieldPath] + if ok { + mf, ok := f.MemberFields[targetMemberName] + if ok { + setCfg = mf.GetSetterConfig(op) + if setCfg != nil && setCfg.IgnoreResourceSetter() { + continue + } + } + } sourceMemberShapeRef = sourceShape.MemberRefs[targetMemberName] if sourceMemberShapeRef == nil { @@ -1734,34 +1727,13 @@ func SetResourceForStruct( // "%sif %s != nil {\n", indent, sourceAdaptedVarName, // ) - if targetMemberShapeRef.Shape.IsEnum() { - - out += fmt.Sprintf( - "%sif %s != \"\" {\n", indent, sourceAdaptedVarName, - ) - // This is for edge case - in efs controller - // FileSystemSize.Value is int64 and rest of fields are *int64 - } else if targetMemberShapeRef.Shape.Type == "long" && targetMemberShapeRef.ShapeName == "FileSystemSizeValue" { - - out += fmt.Sprintf( - "%sif %s > 0 {\n", indent, sourceAdaptedVarName, - ) - - // } else if targetMemberShapeRef.Shape.Type == "integer" { - - // out += fmt.Sprintf( - // "%sif %s > 0 {\n", indent, sourceAdaptedVarName, - // ) - } else if targetMemberShapeRef.Shape.Type == "boolean" { - out += fmt.Sprintf( - "%sif %s {\n", indent, sourceAdaptedVarName, - ) - } else { - + if !sourceMemberShape.IsEnum() && !sourceMemberShape.HasDefaultValue() { out += fmt.Sprintf( "%sif %s != nil {\n", indent, sourceAdaptedVarName, ) + // This is for edge case - in efs controller + // FileSystemSize.Value is int64 and rest of fields are *int64 } qualifiedTargetVar = fmt.Sprintf( @@ -1773,13 +1745,19 @@ func SetResourceForStruct( // "%s.%s", targetVarName, targetMemberCleanNames.Original, // ) - //fmt.Println("targetMemberCleanNames.Camel", targetMemberCleanNames.Camel) - updatedTargetFieldPath := targetFieldPath + "." + targetMemberCleanNames.Camel switch sourceMemberShape.Type { case "list", "structure", "map": - { + if sourceMemberShape.Type == "list" && + !sourceMemberShape.MemberRef.Shape.IsEnum() && + sourceMemberShape.MemberRef.Shape.Type == "string" { + out += fmt.Sprintf("%s%s = aws.StringSlice(%s)\n", indent, qualifiedTargetVar, sourceAdaptedVarName) + } else if sourceMemberShape.Type == "map" && + sourceMemberShape.KeyRef.Shape.Type == "string" && + sourceMemberShape.ValueRef.Shape.Type == "string" { + out += fmt.Sprintf("%s%s = aws.StringMap(%s)\n", indent, qualifiedTargetVar, sourceAdaptedVarName) + } else { out += varEmptyConstructorK8sType( cfg, r, indexedVarName, @@ -1814,9 +1792,11 @@ func SetResourceForStruct( indentLevel+1, ) } - out += fmt.Sprintf( - "%s}\n", indent, - ) + if !sourceMemberShape.IsEnum() && !sourceMemberShape.HasDefaultValue() { + out += fmt.Sprintf( + "%s}\n", indent, + ) + } } if len(targetShape.MemberNames()) == 0 { // This scenario can occur when the targetShape is a primitive, but @@ -1974,18 +1954,26 @@ func setResourceForSlice( ) } // This is for AWS-SDK-GO-V2 - //addressOfVar := "" + // addressOfVar := "" switch targetShape.MemberRef.Shape.Type { case "structure", "list", "map": break default: // This is for AWS-SDK-GO-V2 - //addressOfVar = "&" + } // f0 = append(f0, elem0) + // if !sourceShape.MemberRef.Shape.IsEnum() { + // addressOfVar = "&" + // } + // if sourceShape.Type == "list" { + // addressOfVar = "&" + // } + // This is for AWS-SDK-GO-V2 //out += fmt.Sprintf("%s\t%s = append(%s, %s%s)\n", indent, targetVarName, targetVarName, addressOfVar, elemVarName) + out += fmt.Sprintf("%s\t%s = append(%s, %s)\n", indent, targetVarName, targetVarName, elemVarName) out += fmt.Sprintf("%s}\n", indent) @@ -2087,36 +2075,40 @@ func setResourceForScalar( } - // This is for AWS-SDK-GO-V2 - if shape.IsEnum() { - out += fmt.Sprintf("%s%s = (*string)(&%s)\n", indent, targetVar, setTo) - // } else if shape.Type == "integer" { - - // out += fmt.Sprintf("%s%s := int64(%s)\n", indent, "number", setTo) - // out += fmt.Sprintf("%s%s = &%s\n", indent, targetVar, "number") - - // This is for edge case - in efs controller - // targetvar is int64 and rest of targetvar are *int64 - EFS controller - } else if shape.Type == "long" && shapeRef.ShapeName == "FileSystemSizeValue" { - - out += fmt.Sprintf("%s%s = &%s\n", indent, targetVar, setTo) - - // This is for edge case - in ecr controller - // ScanOnPuSH - targetvar is bool and rest of taregetvar are *bool - ECR controller - } else if shape.Type == "boolean" && shape.GoType() == "*bool" && shape.ShapeName == "ScanOnPushFlag" { - - out += fmt.Sprintf("%s%s = &%s\n", indent, targetVar, setTo) - - } else if !strings.Contains(targetVar, ".") { - - out += fmt.Sprintf("%s%s = &%s\n", indent, targetVar, setTo) - } else if shape.Type == "integer" { - - out += fmt.Sprintf("%s%s = &%s\n", indent, targetVar, setTo) - } else { - + switch shape.Type { + case "list": out += fmt.Sprintf("%s%s = %s\n", indent, targetVar, setTo) + case "integer": + out += fmt.Sprintf("%s%stemp := int64(*%s)\n", indent, shape.ShapeName, setTo) + out += fmt.Sprintf("%s%s = &%stemp\n", indent, targetVar, shape.ShapeName) + default: + if shape.HasDefaultValue() { + out += fmt.Sprintf("%s%s = &%s\n", indent, targetVar, setTo) + } else if shape.IsEnum() { + out += fmt.Sprintf("%s%s = aws.String(string(%s))\n", indent, targetVar, strings.TrimPrefix(setTo, "*")) + } else { + out += fmt.Sprintf("%s%s = %s\n", indent, targetVar, setTo) + } } + + // This is for AWS-SDK-GO-V2 + // if shape.IsEnum() { + // out += fmt.Sprintf("%s%s = aws.String(string(%s))\n", indent, targetVar, strings.TrimPrefix(setTo, "*")) + // // } else if shape.Type == "integer" { + + // // out += fmt.Sprintf("%s%s := int64(%s)\n", indent, "number", setTo) + // // out += fmt.Sprintf("%s%s = &%s\n", indent, targetVar, "number") + + // // This is for edge case - in efs controller + // // targetvar is int64 and rest of targetvar are *int64 - EFS controller + // } else if shape.HasDefaultValue() { + // out += fmt.Sprintf("%s%s = &%s\n", indent, targetVar, setTo) + // } else if shape.Type == "integer" { + // out += fmt.Sprintf("%stemp := int64(*%s)\n", indent, setTo) + // out += fmt.Sprintf("%s%s = &temp\n", indent, targetVar) + // }else { + // out += fmt.Sprintf("%s%s = %s\n", indent, targetVar, setTo) + // } return out } diff --git a/pkg/generate/code/set_sdk.go b/pkg/generate/code/set_sdk.go index 5cf98536..e2cf759c 100644 --- a/pkg/generate/code/set_sdk.go +++ b/pkg/generate/code/set_sdk.go @@ -142,7 +142,7 @@ func SetSDK( // res.SetAttributes(attrMap) // } fieldConfigs := cfg.GetFieldConfigs(r.Names.Original) - out += fmt.Sprintf("%sattrMap := map[string]*string{}\n", indent) + out += fmt.Sprintf("%sattrMap := map[string]string{}\n", indent) sortedAttrFieldNames := []string{} for fName, fConfig := range fieldConfigs { if fConfig.IsAttribute { @@ -160,7 +160,7 @@ func SetSDK( indent, sourceAdaptedVarName, ) out += fmt.Sprintf( - "%s\tattrMap[\"%s\"] = %s\n", + "%s\tattrMap[\"%s\"] = *%s\n", indent, fieldName, sourceAdaptedVarName, ) out += fmt.Sprintf( @@ -171,7 +171,7 @@ func SetSDK( out += fmt.Sprintf( "%sif len(attrMap) > 0 {\n", indent, ) - out += fmt.Sprintf("\t%s%s.SetAttributes(attrMap)\n", indent, targetVarName) + out += fmt.Sprintf("\t%s%s.Attributes = attrMap\n", indent, targetVarName) out += fmt.Sprintf( "%s}\n", indent, ) @@ -199,8 +199,7 @@ func SetSDK( panic("Member type not handled") } - out += fmt.Sprintf("%s%s.Set%s(%s)\n", indent, targetVarName, memberName, value) - fmt.Println("Override Out", out) + out += fmt.Sprintf("%s%s.%s = %s\n", indent, targetVarName, memberName, value) continue } } @@ -215,13 +214,12 @@ func SetSDK( indent, sourceVarName, sourceVarName, ) out += fmt.Sprintf( - "%s\t%s.Set%s(string(*%s.Status.ACKResourceMetadata.ARN))\n", + "%s\t%s.%s = (*string)(%s.Status.ACKResourceMetadata.ARN)\n", indent, targetVarName, memberName, sourceVarName, ) out += fmt.Sprintf( "%s}\n", indent, ) - fmt.Println("Resoure ARN Out", out) continue } @@ -336,7 +334,15 @@ func SetSDK( switch memberShape.Type { case "list", "structure", "map": - { + if memberShape.Type == "list" && + memberShape.MemberRef.Shape.Type == "string" && + !memberShape.MemberRef.Shape.IsEnum() { + out += fmt.Sprintf("%s\t%s.%s = aws.ToStringSlice(%s)\n", indent, targetVarName, memberName, sourceAdaptedVarName) + } else if memberShape.Type == "map" && + memberShape.KeyRef.Shape.Type == "string" && + memberShape.ValueRef.Shape.Type == "string" { + out += fmt.Sprintf("%s\t%s.%s = aws.ToStringMap(%s)\n", indent, targetVarName, memberName, sourceAdaptedVarName) + } else { memberVarName := fmt.Sprintf("f%d", memberIndex) out += varEmptyConstructorSDKType( @@ -381,7 +387,7 @@ func SetSDK( cfg, r, memberName, targetVarName, - memberShape.Type, // changed this to memberShape.Type from inputShape.Type + inputShape.Type, // changed this to memberShape.Type from inputShape.Type AWS-SDK-GO-V2 sourceFieldPath, sourceAdaptedVarName, memberShapeRef, @@ -485,7 +491,7 @@ func SetSDKGetAttributes( indent, sourceVarName, sourceVarName, ) out += fmt.Sprintf( - "%s\t%s.Set%s(string(*%s.Status.ACKResourceMetadata.ARN))\n", + "%s\t%s.%s = (string(*%s.Status.ACKResourceMetadata.ARN))\n", indent, targetVarName, memberName, sourceVarName, ) nameField := r.SpecIdentifierField() @@ -527,15 +533,15 @@ func SetSDKGetAttributes( // reference to when constructing the values of the []*string or // *string members. if memberShapeRef.Shape.Type == "list" { - out += fmt.Sprintf("%s\ttmpVals := []*string{}\n", indent) + out += fmt.Sprintf("%s\ttmpVals := []svcsdktypes.%s{}\n", indent, memberShapeRef.Shape.MemberRef.ShapeName) for x, overrideValue := range overrideValues { - out += fmt.Sprintf("%s\ttmpVal%d := \"%s\"\n", indent, x, overrideValue) - out += fmt.Sprintf("%s\ttmpVals = append(tmpVals, &tmpVal%d)\n", indent, x) + out += fmt.Sprintf("%s\ttmpVal%d := svcsdktypes.%s%s\n", indent, x, memberShapeRef.Shape.MemberRef.ShapeName, overrideValue) + out += fmt.Sprintf("%s\ttmpVals = append(tmpVals, tmpVal%d)\n", indent, x) } - out += fmt.Sprintf("%s\t%s.Set%s(tmpVals)\n", indent, targetVarName, memberName) + out += fmt.Sprintf("%s\t%s.%s = tmpVals\n", indent, targetVarName, memberName) } else { - out += fmt.Sprintf("%s\ttmpVal := \"%s\"\n", indent, overrideValues[0]) - out += fmt.Sprintf("%s\t%s.Set%s(&tmpVal)\n", indent, targetVarName, memberName) + out += fmt.Sprintf("%s\ttmpVal := svcsdktypes.%s%s\n", indent, memberShapeRef.Shape.MemberRef.ShapeName, overrideValues[0]) + out += fmt.Sprintf("%s\t%s.%s = tmpVal\n", indent, targetVarName, memberName) } out += fmt.Sprintf("%s}\n", indent) continue @@ -668,7 +674,7 @@ func SetSDKSetAttributes( indent, sourceVarName, sourceVarName, ) out += fmt.Sprintf( - "%s\t%s.Set%s(string(*%s.Status.ACKResourceMetadata.ARN))\n", + "%s\t%s.%s = (string(*%s.Status.ACKResourceMetadata.ARN))\n", indent, targetVarName, memberName, sourceVarName, ) nameField := r.SpecIdentifierField() @@ -712,7 +718,7 @@ func SetSDKSetAttributes( // } // res.SetAttributes(attrMap) fieldConfigs := cfg.GetFieldConfigs(r.Names.Original) - out += fmt.Sprintf("%sattrMap := map[string]*string{}\n", indent) + out += fmt.Sprintf("%sattrMap := map[string]string{}\n", indent) sortedAttrFieldNames := []string{} for fName, fConfig := range fieldConfigs { if fConfig.IsAttribute { @@ -730,7 +736,7 @@ func SetSDKSetAttributes( indent, sourceAdaptedVarName, ) out += fmt.Sprintf( - "%s\tattrMap[\"%s\"] = %s\n", + "%s\tattrMap[\"%s\"] = *%s\n", indent, fieldName, sourceAdaptedVarName, ) out += fmt.Sprintf( @@ -741,7 +747,7 @@ func SetSDKSetAttributes( out += fmt.Sprintf( "%sif len(attrMap) > 0 {\n", indent, ) - out += fmt.Sprintf("\t%s%s.SetAttributes(attrMap)\n", indent, targetVarName) + out += fmt.Sprintf("\t%s%s.Attributes = attrMap\n", indent, targetVarName) out += fmt.Sprintf( "%s}\n", indent, ) @@ -1134,7 +1140,7 @@ func SetSDKForStruct( // To check if the field member has `ignore` set to `true`. // This condition currently applies only for members of a field whose shape is `structure` var setCfg *ackgenconfig.SetFieldConfig - f, ok := r.Fields[targetFieldName] + f, ok := r.Fields[sourceFieldPath] // AWS-SDK-GO-V2 if ok { mf, ok := f.MemberFields[memberName] if ok { @@ -1157,7 +1163,15 @@ func SetSDKForStruct( switch memberShape.Type { case "list", "structure", "map": - { + if memberShape.Type == "list" && + memberShape.MemberRef.Shape.Type == "string" && + !memberShape.MemberRef.Shape.IsEnum() { + out += fmt.Sprintf("%s\t%s.%s = aws.ToStringSlice(%s)\n", indent, targetVarName, memberName, sourceAdaptedVarName) + } else if memberShape.Type == "map" && + memberShape.KeyRef.Shape.Type == "string" && + memberShape.ValueRef.Shape.Type == "string" { + out += fmt.Sprintf("%s\t%s.%s = aws.ToStringMap(%s)\n", indent, targetVarName, memberName, sourceAdaptedVarName) + } else { memberVarName := fmt.Sprintf( "%sf%d", @@ -1286,8 +1300,15 @@ func setSDKForSlice( // This is for AWS-SDK-GO-V2 //out += fmt.Sprintf("%s\t%s = append(%s, %s%s)\n", indent, targetVarName, targetVarName, addressOfVar, elemVarName) - - out += fmt.Sprintf("%s\t%s = append(%s, %s)\n", indent, targetVarName, targetVarName, elemVarName) + setPointer := "" + if (targetShape.MemberRef.Shape.Type == "string" && !targetShape.MemberRef.Shape.IsEnum()) || targetShape.MemberRef.Shape.Type == "structure" { + setPointer = "*" + } + if targetShape.MemberRef.Shape.IsEnum() { + // setPointer = "" + elemVarName = fmt.Sprintf("svcsdktypes.%s(%s)", targetShape.MemberRef.ShapeName, elemVarName) + } + out += fmt.Sprintf("%s\t%s = append(%s, %s%s)\n", indent, targetVarName, targetVarName, setPointer, elemVarName) out += fmt.Sprintf("%s}\n", indent) return out } @@ -1316,44 +1337,42 @@ func setSDKForMap( valIterVarName := fmt.Sprintf("%svaliter", targetVarName) keyVarName := fmt.Sprintf("%skey", targetVarName) - valVarName := fmt.Sprintf("%sval", targetVarName) // for f0key, f0valiter := range r.ko.Spec.Tags { out += fmt.Sprintf("%sfor %s, %s := range %s {\n", indent, keyVarName, valIterVarName, sourceVarName) // f0elem := string{} - out += varEmptyConstructorSDKType( - cfg, r, - valVarName, - targetShape.ValueRef.Shape, - indentLevel+1, - ) + // out += varEmptyConstructorSDKType( + // cfg, r, + // valVarName, + // targetShape.ValueRef.Shape, + // indentLevel+1, + // ) // f0val = *f0valiter // // or // // f0val.SetMyField(*f0valiter) - containerFieldName := "" - if targetShape.ValueRef.Shape.Type == "structure" { - containerFieldName = targetFieldName - } - out += setSDKForContainer( - cfg, r, - containerFieldName, - valVarName, - sourceFieldPath, - valIterVarName, - &targetShape.ValueRef, - op, - indentLevel+1, - ) - addressOfVar := "" + // containerFieldName := "" + // if targetShape.ValueRef.Shape.Type == "structure" { + // containerFieldName = targetFieldName + // } + // out += setSDKForContainer( + // cfg, r, + // containerFieldName, + // valVarName, + // sourceFieldPath, + // valIterVarName, + // &targetShape.ValueRef, + // op, + // indentLevel+1, + // ) switch targetShape.ValueRef.Shape.Type { case "structure", "list", "map": break - default: - addressOfVar = "&" + // default: + // addressOfVar = "&" } // f0[f0key] = f0val - out += fmt.Sprintf("%s\t%s[%s] = %s%s\n", indent, targetVarName, keyVarName, addressOfVar, valVarName) + out += fmt.Sprintf("%s\t%s[%s] = *%s\n", indent, targetVarName, keyVarName, valIterVarName) out += fmt.Sprintf("%s}\n", indent) return out } @@ -1370,38 +1389,44 @@ func varEmptyConstructorSDKType( out := "" indent := strings.Repeat("\t", indentLevel) goType := shape.GoTypeWithPkgName() - keepPointer := (shape.Type == "list" || shape.Type == "map") //goType = model.ReplacePkgName(goType, r.SDKAPIPackageName(), "svcsdk", keepPointer) // This is for AWS-SDK-GO-V2 - goType = model.ReplacePkgName(goType, r.SDKAPIPackageName(), "svcsdktypes", keepPointer) + goType = model.ReplacePkgName(goType, r.SDKAPIPackageName(), "svcsdktypes", false) switch shape.Type { case "structure": // f0 := &svcsdk.BookData{} // This is for AWS-SDK-GO-V2 if goType == ".Tag" { - - out += fmt.Sprintf("%s%s := svcsdktypes%s{}\n", indent, varName, goType) + out += fmt.Sprintf("%s%s := %s{}\n", indent, varName, goType) } else { - - out += fmt.Sprintf("%s%s := &svcsdktypes%s{}\n", indent, varName, goType) + out += fmt.Sprintf("%s%s := &%s{}\n", indent, varName, goType) } - - case "list", "map": + case "list": + if shape.MemberRef.Shape != nil && shape.MemberRef.Shape.IsEnum() { + goType = "[]svcsdktypes." + shape.MemberRef.ShapeName + } + out += fmt.Sprintf("%s%s := %s{}\n", indent, varName, goType) + case "map": // f0 := []*string{} if goType == "[]*string" || goType == "[]*int32" || goType == "[]*int64" { out += fmt.Sprintf("%s%s := %s{}\n", indent, varName, strings.ReplaceAll(goType, "*", "")) } else if goType == "[]*.Tag" { - out += fmt.Sprintf("%s%s := %s{}\n", indent, varName, strings.ReplaceAll(goType, "*", "svcsdktypes")) + out += fmt.Sprintf("%s%s := %s{}\n", indent, varName, goType) } else { - out += fmt.Sprintf("%s%s := %s{}\n", indent, varName, strings.ReplaceAll(goType, "*", "*svcsdktypes")) + out += fmt.Sprintf("%s%s := %s{}\n", indent, varName, goType) } default: // var f0 string - out += fmt.Sprintf("%svar %s %s\n", indent, varName, goType) + if shape.IsEnum() { + out += fmt.Sprintf("%svar %s %s\n", indent, varName, goType) + } else { + out += fmt.Sprintf("%svar %s %s\n", indent, varName, goType) + } + } return out @@ -1449,25 +1474,31 @@ func varEmptyConstructorK8sType( switch shape.Type { case "structure": - // f0 := &svcapitypes.BookData{} + if r.Config().HasEmptyShape(shape.ShapeName) { + // f0 := map[string]*string{} + out += fmt.Sprintf("%s%s := map[string]*string{}\n", indent, varName) + } else { + // f0 := &svcapitypes.BookData{} + out += fmt.Sprintf("%s%s := &%s{}\n", indent, varName, goType) + } - out += fmt.Sprintf("%s%s := &svcapitypes%s{}\n", indent, varName, goType) + // out += fmt.Sprintf("%s%s := &svcapitypes%s{}\n", indent, varName, goType) case "list", "map": // f0 := []*string{} + out += fmt.Sprintf("%s%s := %s{}\n", indent, varName, goType) + // if goType == "[]*string" || goType == "[]*int32" || goType == "[]*int64" { - if goType == "[]*string" || goType == "[]*int32" || goType == "[]*int64" { - - out += fmt.Sprintf("%s%s := %s{}\n", indent, varName, goType) - } else { - - out += fmt.Sprintf("%s%s := %s{}\n", indent, varName, strings.ReplaceAll(goType, "*", "*svcapitypes")) - - } + // out += fmt.Sprintf("%s%s := %s{}\n", indent, varName, goType) + // } else { default: // var f0 string + setPointer := "" - out += fmt.Sprintf("%svar %s *%s\n", indent, varName, goType) + setPointer = "*" + // if shape.IsEnum() { + // } + out += fmt.Sprintf("%svar %s %s%s\n", indent, varName, setPointer, goType) } return out } @@ -1506,10 +1537,9 @@ func setSDKForScalar( // This is for AWS-SDK-GO-V2 if targetFieldName == "" { - //fmt.Println("TargetVarName ", targetVarName, "TargetFieldName ", targetFieldName, "ShapeType", shape.Type, "ShapeName: ", shape.ShapeName) out += fmt.Sprintf("%s%s = %s\n", indent, targetVarName, setTo) - } else if targetVarType == "string" && shape.IsEnum() { + } else if shape.IsEnum() { // //out += fmt.Sprintf("%s%s.Set%s(%s)\n", indent, targetVarName, targetFieldName, setTo) out += fmt.Sprintf("%s.%s = svcsdktypes.%s(%s)", targetVarName, targetFieldName, shape.ShapeName, setTo) @@ -1532,6 +1562,13 @@ func setSDKForScalar( out += fmt.Sprintf("%s%s = %s\n", indent, targetVarPath, strings.TrimPrefix(setTo, "*")) + } else if shape.Type == "integer" { + targetVarPath := targetVarName + if targetFieldName != "" { + targetVarPath += "." + targetFieldName + } + out += fmt.Sprintf("%stemp := int32(%s)\n", indent, setTo) + out += fmt.Sprintf("%s%s = &temp\n", indent, targetVarPath) } else { targetVarPath := targetVarName diff --git a/pkg/model/field.go b/pkg/model/field.go index acb92fba..55f6a49f 100644 --- a/pkg/model/field.go +++ b/pkg/model/field.go @@ -96,16 +96,16 @@ func (f *Field) GetDocumentation() string { hasShapeDoc := false var prepend strings.Builder - var out strings.Builder + out := "" if f.ShapeRef != nil { if f.ShapeRef.Documentation != "" { hasShapeDoc = true - out.WriteString(f.ShapeRef.Documentation) + out += f.ShapeRef.Documentation } } if cfg == nil { - return out.String() + return out } // Ensure configuration has exclusive options @@ -119,9 +119,9 @@ func (f *Field) GetDocumentation() string { if cfg.Append != nil { if hasShapeDoc { - out.WriteString("\n//\n") + out += "\n//\n" } - out.WriteString(f.formatUserProvidedDocstring(*cfg.Append)) + out += f.formatUserProvidedDocstring(*cfg.Append) } if cfg.Prepend != nil { @@ -131,7 +131,7 @@ func (f *Field) GetDocumentation() string { } } - return prepend.String() + out.String() + return prepend.String() + out } // formatUserProvidedDocstring sanitises a doc string provided by the user so @@ -456,7 +456,6 @@ func newFieldRecurse( cleanMemberNames := names.New(memberName) memberPath := path + "." + cleanMemberNames.Camel memberShape := containerShape.MemberRefs[memberName] - // Check to see if we have seen this shape before in the stack // and panic. Cyclic references are not supported if _, ok := nestedParentFields[memberShape.ShapeName]; ok { diff --git a/pkg/model/model.go b/pkg/model/model.go index d8f7a32e..53872f0b 100644 --- a/pkg/model/model.go +++ b/pkg/model/model.go @@ -19,9 +19,9 @@ import ( "sort" "strings" - awssdkmodel "github.com/aws-controllers-k8s/code-generator/pkg/api" "github.com/aws-controllers-k8s/pkg/names" - + + awssdkmodel "github.com/aws-controllers-k8s/code-generator/pkg/api" ackgenconfig "github.com/aws-controllers-k8s/code-generator/pkg/config" ackfp "github.com/aws-controllers-k8s/code-generator/pkg/fieldpath" "github.com/aws-controllers-k8s/code-generator/pkg/generate/templateset" @@ -473,7 +473,7 @@ func (m *Model) getShapeCleanGoType(shape *awssdkmodel.Shape) string { case "structure": if len(shape.MemberRefs) == 0 { if m.cfg.HasEmptyShape(shape.ShapeName) { - return "map[string]*string" + return "map[string]string" } panic(fmt.Sprintf("structure %s has no fields, either configure it as a `empty_shape` or manually set the field type", shape.ShapeName)) } diff --git a/pkg/model/multiversion/manager.go b/pkg/model/multiversion/manager.go index a8816023..de7971a2 100644 --- a/pkg/model/multiversion/manager.go +++ b/pkg/model/multiversion/manager.go @@ -99,7 +99,8 @@ func NewAPIVersionManager( return nil, err } - sdkAPI, err := sdkAPIHelper.API(servicePackageName) + // sdkAPI, err := sdkAPIHelper.API(servicePackageName) + sdkAPI, err := sdkAPIHelper.APIV2(servicePackageName) if err != nil { return nil, err } diff --git a/pkg/model/sdk_api.go b/pkg/model/sdk_api.go index 2eb9a6f1..e772402d 100644 --- a/pkg/model/sdk_api.go +++ b/pkg/model/sdk_api.go @@ -37,13 +37,11 @@ var ( GoTypeToSDKShapeType = map[string]string{ "int": "integer", // This is for AWS-SDK-GO-V2 - //"int64": "integer", - "int64": "long", + "int64": "integer", "float64": "float", "string": "string", // This is for AWS-SDK-GO-V2 still under test "bool": "boolean", - "boolean": "bool", "time.Time": "timestamp", "bytes": "blob", } diff --git a/pkg/sdk/custom_shapes_test.go b/pkg/sdk/custom_shapes_test.go index bc033b12..eac75cb6 100644 --- a/pkg/sdk/custom_shapes_test.go +++ b/pkg/sdk/custom_shapes_test.go @@ -67,7 +67,7 @@ func s3SDKAPI(t *testing.T, cfg config.Config) *model.SDKAPI { } path := filepath.Clean("../testdata") sdkHelper := sdk.NewHelper(path, cfg) - s3, err := sdkHelper.API("s3") + s3, err := sdkHelper.APIV2("s3") if err != nil { t.Fatal(err) } diff --git a/pkg/sdk/helper.go b/pkg/sdk/helper.go index 739c4d9d..93b0d082 100644 --- a/pkg/sdk/helper.go +++ b/pkg/sdk/helper.go @@ -16,18 +16,15 @@ package sdk import ( "errors" "fmt" - "io/ioutil" - "os" "path/filepath" - "sort" "github.com/go-git/go-git/v5" + "github.com/aws-controllers-k8s/code-generator/apiv2" ackgenconfig "github.com/aws-controllers-k8s/code-generator/pkg/config" "github.com/aws-controllers-k8s/code-generator/pkg/model" "github.com/aws-controllers-k8s/code-generator/pkg/util" - "github.com/aws-controllers-k8s/code-generator/apiv2" awssdkmodel "github.com/aws-controllers-k8s/code-generator/pkg/api" ) @@ -95,119 +92,115 @@ func (h *Helper) WithAPIVersion(apiVersion string) { } // API returns the aws-sdk-go API model for a supplied service model name. -func (h *Helper) API(serviceModelName string) (*model.SDKAPI, error) { - modelPath, _, err := h.ModelAndDocsPath(serviceModelName) - if err != nil { - return nil, err - } - apis, err := h.loader.Load([]string{modelPath}) - if err != nil { - return nil, err - } - // apis is a map, keyed by the service alias, of pointers to aws-sdk-go - // model API objects - for _, api := range apis { - // If we don't do this, we can end up with panic()'s like this: - // panic: assignment to entry in nil map - // when trying to execute Shape.GoType(). - // - // Calling API.ServicePackageDoc() ends up resetting the API.imports - // unexported map variable... - _ = api.ServicePackageDoc() - sdkapi := model.NewSDKAPI(api, h.APIGroupSuffix) - - h.InjectCustomShapes(sdkapi) - - return sdkapi, nil - } - return nil, ErrServiceNotFound -} +// func (h *Helper) API(serviceModelName string) (*model.SDKAPI, error) { +// modelPath, _, err := h.ModelAndDocsPath(serviceModelName) +// if err != nil { +// return nil, err +// } +// apis, err := h.loader.Load([]string{modelPath}) +// if err != nil { +// return nil, err +// } +// // apis is a map, keyed by the service alias, of pointers to aws-sdk-go +// // model API objects +// for _, api := range apis { +// // If we don't do this, we can end up with panic()'s like this: +// // panic: assignment to entry in nil map +// // when trying to execute Shape.GoType(). +// // +// // Calling API.ServicePackageDoc() ends up resetting the API.imports +// // unexported map variable... +// _ = api.ServicePackageDoc() +// sdkapi := model.NewSDKAPI(api, h.APIGroupSuffix) + +// h.InjectCustomShapes(sdkapi) + +// return sdkapi, nil +// } +// return nil, ErrServiceNotFound +// } // AWS-SDK-GO-V2 func (h *Helper) APIV2(serviceModelName string) (*model.SDKAPI, error) { - modelPath := h.ModelAndDocsPathV2(serviceModelName) - - apis := apiv2.CollectApis(modelPath) - + apis, err := apiv2.ConvertApiV2Shapes(modelPath) + if err != nil { + return nil, err + } for _, api := range apis { - _ = api.ServicePackageDoc() sdkapi := model.NewSDKAPI(api, h.APIGroupSuffix) - h.InjectCustomShapes(sdkapi) - return sdkapi, nil - } - return nil, ErrServiceNotFound - } -// ModelAndDocsPath returns two string paths to the supplied service's API and -// doc JSON files -func (h *Helper) ModelAndDocsPath( - serviceModelName string, -) (string, string, error) { - if h.apiVersion == "" { - apiVersion, err := h.FirstAPIVersion(serviceModelName) - if err != nil { - return "", "", err - } - h.apiVersion = apiVersion - } - versionPath := filepath.Join( - h.basePath, "models", "apis", serviceModelName, h.apiVersion, - ) - modelPath := filepath.Join(versionPath, "api-2.json") - docsPath := filepath.Join(versionPath, "docs-2.json") - return modelPath, docsPath, nil -} +// // ModelAndDocsPath returns two string paths to the supplied service's API and +// // doc JSON files +// func (h *Helper) ModelAndDocsPath( +// serviceModelName string, +// ) (string, string, error) { +// if h.apiVersion == "" { +// apiVersion, err := h.FirstAPIVersion(serviceModelName) +// if err != nil { +// return "", "", err +// } +// h.apiVersion = apiVersion +// } +// versionPath := filepath.Join( +// h.basePath, "models", "apis", serviceModelName, h.apiVersion, +// ) +// modelPath := filepath.Join(versionPath, "api-2.json") +// docsPath := filepath.Join(versionPath, "docs-2.json") +// return modelPath, docsPath, nil +// } // AWS-SDK-GO-V2 func (h *Helper) ModelAndDocsPathV2(serviceModelName string) string { - modelPath := filepath.Join( - h.basePath, "codegen", "sdk-codegen", "aws-models", serviceModelName, ".json", + h.basePath, + "codegen", + "sdk-codegen", + "aws-models", + serviceModelName+`.json`, ) - return modelPath } -// FirstAPIVersion returns the first found API version for a service API. -// (e.h. "2012-10-03") -func (h *Helper) FirstAPIVersion(serviceModelName string) (string, error) { - versions, err := h.GetAPIVersions(serviceModelName) - if err != nil { - return "", err - } - sort.Strings(versions) - return versions[0], nil -} +// // FirstAPIVersion returns the first found API version for a service API. +// // (e.h. "2012-10-03") +// func (h *Helper) FirstAPIVersion(serviceModelName string) (string, error) { +// versions, err := h.GetAPIVersions(serviceModelName) +// if err != nil { +// return "", err +// } +// sort.Strings(versions) +// return versions[0], nil +// } // GetAPIVersions returns the list of API Versions found in a service directory. -func (h *Helper) GetAPIVersions(serviceModelName string) ([]string, error) { - apiPath := filepath.Join(h.basePath, "models", "apis", serviceModelName) - versionDirs, err := ioutil.ReadDir(apiPath) - if err != nil { - return nil, err - } - versions := []string{} - for _, f := range versionDirs { - version := f.Name() - fp := filepath.Join(apiPath, version) - fi, err := os.Lstat(fp) - if err != nil { - return nil, err - } - if !fi.IsDir() { - return nil, fmt.Errorf("found %s: %v", version, ErrInvalidVersionDirectory) - } - versions = append(versions, version) - } - if len(versions) == 0 { - return nil, ErrNoValidVersionDirectory - } - return versions, nil -} +// func (h *Helper) GetAPIVersions(serviceModelName string) ([]string, error) { +// apiPath := filepath.Join(h.basePath, "models", "apis", serviceModelName) +// versionDirs, err := ioutil.ReadDir(apiPath) +// if err != nil { +// return nil, err +// } +// versions := []string{} +// for _, f := range versionDirs { +// version := f.Name() +// fp := filepath.Join(apiPath, version) +// fi, err := os.Lstat(fp) +// if err != nil { +// return nil, err +// } +// if !fi.IsDir() { +// return nil, fmt.Errorf("found %s: %v", version, ErrInvalidVersionDirectory) +// } +// versions = append(versions, version) +// } +// if len(versions) == 0 { +// return nil, ErrNoValidVersionDirectory +// } +// return versions, nil +// } diff --git a/pkg/sdk/helper_test.go b/pkg/sdk/helper_test.go index 2097eba9..7602d3d3 100644 --- a/pkg/sdk/helper_test.go +++ b/pkg/sdk/helper_test.go @@ -39,7 +39,7 @@ func lambdaSDKAPI(t *testing.T, cfg config.Config) *model.SDKAPI { } path := filepath.Clean("../testdata") sdkHelper := sdk.NewHelper(path, cfg) - lambda, err := sdkHelper.API("lambda") + lambda, err := sdkHelper.APIV2("lambda") if err != nil { t.Fatal(err) } diff --git a/pkg/sdk/repo.go b/pkg/sdk/repo.go index e796f0f9..aa5f26d6 100644 --- a/pkg/sdk/repo.go +++ b/pkg/sdk/repo.go @@ -30,7 +30,7 @@ import ( ) const ( - sdkRepoURL = "https://github.com/aws/aws-sdk-go" + // sdkRepoURL = "https://github.com/aws/aws-sdk-go" sdkRepoURLV2 = "https://github.com/aws/aws-sdk-go-v2" defaultGitCloneTimeout = 180 * time.Second defaultGitFetchTimeout = 30 * time.Second @@ -113,10 +113,8 @@ func EnsureRepo( } // Clone repository if it doesn't exist - sdkDir := filepath.Join(srcPath, "aws-sdk-go-v2") if _, err = os.Stat(sdkDir); os.IsNotExist(err) { - ctx, cancel := context.WithTimeout(ctx, defaultGitCloneTimeout) defer cancel() err = util.CloneRepository(ctx, sdkDir, sdkRepoURLV2) diff --git a/pkg/testutil/schema_helper.go b/pkg/testutil/schema_helper.go index 7fe9fec0..414ea2d4 100644 --- a/pkg/testutil/schema_helper.go +++ b/pkg/testutil/schema_helper.go @@ -76,7 +76,7 @@ func NewModelForServiceWithOptions(t *testing.T, servicePackageName string, opti } options.SetDefaults() - generatorConfigPath := filepath.Join(path, "models", "apis", servicePackageName, options.ServiceAPIVersion, options.GeneratorConfigFile) + generatorConfigPath := filepath.Join(path, "codegen", "sdk-codegen", "aws-models", servicePackageName+".json") if _, err := os.Stat(generatorConfigPath); os.IsNotExist(err) { t.Fatalf("Could not find generator file %q", generatorConfigPath) } @@ -86,7 +86,7 @@ func NewModelForServiceWithOptions(t *testing.T, servicePackageName string, opti } sdkHelper := acksdk.NewHelper(path, cfg) sdkHelper.WithAPIVersion(options.ServiceAPIVersion) - sdkAPI, err := sdkHelper.API(servicePackageName) + sdkAPI, err := sdkHelper.APIV2(servicePackageName) if err != nil { t.Fatal(err) } diff --git a/scripts/build-controller.sh b/scripts/build-controller.sh index 9ad59596..ce2391b3 100755 --- a/scripts/build-controller.sh +++ b/scripts/build-controller.sh @@ -242,6 +242,7 @@ popd 1>/dev/null echo "Running gofmt against generated code for $SERVICE" gofmt -w "$SERVICE_CONTROLLER_SOURCE_PATH" +goimports -w "$SERVICE_CONTROLLER_SOURCE_PATH" echo "Updating additional GitHub repository maintenance files" cp "$ROOT_DIR"/CODE_OF_CONDUCT.md "$SERVICE_CONTROLLER_SOURCE_PATH"/CODE_OF_CONDUCT.md diff --git a/templates/pkg/resource/manager.go.tpl b/templates/pkg/resource/manager.go.tpl index 6f3821fd..f00ff777 100644 --- a/templates/pkg/resource/manager.go.tpl +++ b/templates/pkg/resource/manager.go.tpl @@ -19,13 +19,10 @@ import ( acktags "github.com/aws-controllers-k8s/runtime/pkg/tags" acktypes "github.com/aws-controllers-k8s/runtime/pkg/types" ackutil "github.com/aws-controllers-k8s/runtime/pkg/util" - "github.com/aws/aws-sdk-go/aws/session" "github.com/go-logr/logr" corev1 "k8s.io/api/core/v1" - svcsdk "github.com/aws/aws-sdk-go/service/{{ .ServicePackageName }}" - svcsdkV2{{ .ServicePackageName }} "github.com/aws/aws-sdk-go-v2/service/{{ .ServicePackageName }}" + svcsdk "github.com/aws/aws-sdk-go-v2/service/{{ .ServicePackageName }}" "github.com/aws/aws-sdk-go-v2/aws" - svcsdkapi "github.com/aws/aws-sdk-go/service/{{ .ServicePackageName }}/{{ .ServicePackageName }}iface" svcapitypes "github.com/aws-controllers-k8s/{{ .ControllerName }}-controller/apis/{{ .APIVersion }}" ) @@ -48,6 +45,9 @@ type resourceManager struct { // cfg is a copy of the ackcfg.Config object passed on start of the service // controller cfg ackcfg.Config + // clientcfg is a copy of the client configuration passed on start of the + // service controller + clientcfg aws.Config // log refers to the logr.Logger object handling logging for the service // controller log logr.Logger @@ -62,19 +62,9 @@ type resourceManager struct { awsAccountID ackv1alpha1.AWSAccountID // The AWS Region that this resource manager targets awsRegion ackv1alpha1.AWSRegion - // sess is the AWS SDK Session object used to communicate with the backend - // AWS service API - sess *session.Session - // sdk is a pointer to the AWS service API interface exposed by the - // aws-sdk-go/services/{alias}/{alias}iface package. - sdkapi svcsdkapi.{{ .ClientInterfaceTypeName }} - - // This is for AWS-SDK-GO-V2 - config aws.Config - - // clientV2 is the AWS SDK V2 Client object used to communicate with the backend AWS Service API - // This is for AWS-SDK-GO-V2 - clientV2 *svcsdkV2{{ .ServicePackageName }}.Client + // sdk is a pointer to the AWS service API client exposed by the + // aws-sdk-go-v2/services/{alias} package. + sdkapi *svcsdk.Client } // concreteResource returns a pointer to a resource from the supplied @@ -326,26 +316,22 @@ func (rm *resourceManager) EnsureTags( // This is for AWS-SDK-GO-V2 - Created newResourceManager With AWS sdk-Go-ClientV2 func newResourceManager( cfg ackcfg.Config, + clientcfg aws.Config, log logr.Logger, metrics *ackmetrics.Metrics, rr acktypes.Reconciler, - sess *session.Session, id ackv1alpha1.AWSAccountID, region ackv1alpha1.AWSRegion, - config aws.Config, - clientV2 *svcsdkV2{{ .ServicePackageName }}.Client, ) (*resourceManager, error) { return &resourceManager{ - cfg: cfg, - log: log, - metrics: metrics, - rr: rr, + cfg: cfg, + clientcfg: clientcfg, + log: log, + metrics: metrics, + rr: rr, awsAccountID: id, - awsRegion: region, - sess: sess, - sdkapi: svcsdk.New(sess), - config: config, - clientV2: clientV2, + awsRegion: region, + sdkapi: svcsdk.NewFromConfig(clientcfg, ), }, nil } diff --git a/templates/pkg/resource/manager_factory.go.tpl b/templates/pkg/resource/manager_factory.go.tpl index d46bae78..e228bd95 100644 --- a/templates/pkg/resource/manager_factory.go.tpl +++ b/templates/pkg/resource/manager_factory.go.tpl @@ -10,11 +10,10 @@ import ( ackcfg "github.com/aws-controllers-k8s/runtime/pkg/config" ackmetrics "github.com/aws-controllers-k8s/runtime/pkg/metrics" acktypes "github.com/aws-controllers-k8s/runtime/pkg/types" - "github.com/aws/aws-sdk-go/aws/session" + awscfg "github.com/aws/aws-sdk-go-v2/aws" "github.com/go-logr/logr" - "github.com/aws/aws-sdk-go-v2/aws" + "k8s.io/apimachinery/pkg/runtime/schema" - svcsdkV2{{ .ServicePackageName }} "github.com/aws/aws-sdk-go-v2/service/{{ .ServicePackageName }}" svcresource "github.com/aws-controllers-k8s/{{ .ControllerName }}-controller/pkg/resource" ) @@ -36,13 +35,15 @@ func (f *resourceManagerFactory) ResourceDescriptor() acktypes.AWSResourceDescri // supplied AWS account func (f *resourceManagerFactory) ManagerFor( cfg ackcfg.Config, + clientcfg awscfg.Config, log logr.Logger, metrics *ackmetrics.Metrics, rr acktypes.Reconciler, - sess *session.Session, id ackv1alpha1.AWSAccountID, region ackv1alpha1.AWSRegion, - config aws.Config, + roleARN ackv1alpha1.AWSResourceName, + endpointURL string, + gvk schema.GroupVersionKind, ) (acktypes.AWSResourceManager, error) { rmId := fmt.Sprintf("%s/%s", id, region) f.RLock() @@ -56,11 +57,7 @@ func (f *resourceManagerFactory) ManagerFor( f.Lock() defer f.Unlock() - // This is for AWS-SDK-GO-V2 - // Create a client for {{ .ServicePackageName }} - clientV2 := svcsdkV2{{ .ServicePackageName }}.NewFromConfig(config) - - rm, err := newResourceManager(cfg, log, metrics, rr, sess, id, region,config, clientV2) + rm, err := newResourceManager(cfg, clientcfg, log, metrics, rr, id, region) if err != nil { return nil, err } diff --git a/templates/pkg/resource/sdk.go.tpl b/templates/pkg/resource/sdk.go.tpl index 9dd49db7..d159a447 100644 --- a/templates/pkg/resource/sdk.go.tpl +++ b/templates/pkg/resource/sdk.go.tpl @@ -15,8 +15,9 @@ import ( ackerr "github.com/aws-controllers-k8s/runtime/pkg/errors" ackrequeue "github.com/aws-controllers-k8s/runtime/pkg/requeue" ackrtlog "github.com/aws-controllers-k8s/runtime/pkg/runtime/log" - "github.com/aws/aws-sdk-go/aws" - svcsdk "github.com/aws/aws-sdk-go/service/{{ .ServicePackageName }}" + "github.com/aws/aws-sdk-go-v2/aws" + svcsdk "github.com/aws/aws-sdk-go-v2/service/{{ .ServicePackageName }}" + svcsdktypes "github.com/aws/aws-sdk-go-v2/service/{{ .ServicePackageName }}/types" corev1 "k8s.io/api/core/v1" metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" @@ -27,8 +28,7 @@ import ( var ( _ = &metav1.Time{} _ = strings.ToLower("") - _ = &aws.JSONValue{} - _ = &svcsdk.{{ .ClientStructTypeName }}{} + _ = &svcsdk.Client{} _ = &svcapitypes.{{ .CRD.Names.Camel }}{} _ = ackv1alpha1.AWSAccountID("") _ = &ackerr.NotFound @@ -36,6 +36,7 @@ var ( _ = &reflect.Value{} _ = fmt.Sprintf("") _ = &ackrequeue.NoRequeue{} + _ = &aws.Config{} ) // sdkFind returns SDK-specific information about a supplied resource @@ -82,7 +83,7 @@ func (rm *resourceManager) sdkCreate( {{- end }} var resp {{ .CRD.GetOutputShapeGoType .CRD.Ops.Create }}; _ = resp; - resp, err = rm.sdkapi.{{ .CRD.Ops.Create.ExportedName }}WithContext(ctx, input) + resp, err = rm.sdkapi.{{ .CRD.Ops.Create.ExportedName }}(ctx, input) {{- if $hookCode := Hook .CRD "sdk_create_post_request" }} {{ $hookCode }} {{- end }} @@ -164,7 +165,7 @@ func (rm *resourceManager) sdkDelete( {{ $hookCode }} {{- end }} var resp {{ .CRD.GetOutputShapeGoType .CRD.Ops.Delete }}; _ = resp; - resp, err = rm.sdkapi.{{ .CRD.Ops.Delete.ExportedName }}WithContext(ctx, input) + resp, err = rm.sdkapi.{{ .CRD.Ops.Delete.ExportedName }}(ctx, input) rm.metrics.RecordAPICall("DELETE", "{{ .CRD.Ops.Delete.ExportedName }}", err) {{- if $hookCode := Hook .CRD "sdk_delete_post_request" }} {{ $hookCode }} diff --git a/templates/pkg/resource/sdk_find_get_attributes.go.tpl b/templates/pkg/resource/sdk_find_get_attributes.go.tpl index 09d676e5..6774b105 100644 --- a/templates/pkg/resource/sdk_find_get_attributes.go.tpl +++ b/templates/pkg/resource/sdk_find_get_attributes.go.tpl @@ -27,13 +27,13 @@ func (rm *resourceManager) sdkFind( {{ $hookCode }} {{- end }} var resp {{ .CRD.GetOutputShapeGoType .CRD.Ops.GetAttributes }} - resp, err = rm.sdkapi.{{ .CRD.Ops.GetAttributes.ExportedName }}WithContext(ctx, input) + resp, err = rm.sdkapi.{{ .CRD.Ops.GetAttributes.ExportedName }}(ctx, input) {{- if $hookCode := Hook .CRD "sdk_get_attributes_post_request" }} {{ $hookCode }} {{- end }} rm.metrics.RecordAPICall("GET_ATTRIBUTES", "{{ .CRD.Ops.GetAttributes.ExportedName }}", err) if err != nil { - if awsErr, ok := ackerr.AWSError(err); ok && awsErr.Code() == "{{ ResourceExceptionCode .CRD 404 }}" {{ GoCodeSetExceptionMessageCheck .CRD 404 }}{ + if strings.Contains(err.Error(), "{{ ResourceExceptionCode .CRD 404 }}" {{ GoCodeSetExceptionMessageCheck .CRD 404 }}) { return nil, ackerr.NotFound } return nil, err diff --git a/templates/pkg/resource/sdk_find_read_many.go.tpl b/templates/pkg/resource/sdk_find_read_many.go.tpl index 04ec7a5f..b7cfec19 100644 --- a/templates/pkg/resource/sdk_find_read_many.go.tpl +++ b/templates/pkg/resource/sdk_find_read_many.go.tpl @@ -27,13 +27,13 @@ func (rm *resourceManager) sdkFind( {{ $hookCode }} {{- end }} var resp {{ .CRD.GetOutputShapeGoType .CRD.Ops.ReadMany }} - resp, err = rm.sdkapi.{{ .CRD.Ops.ReadMany.ExportedName }}WithContext(ctx, input) + resp, err = rm.sdkapi.{{ .CRD.Ops.ReadMany.ExportedName }}(ctx, input) {{- if $hookCode := Hook .CRD "sdk_read_many_post_request" }} {{ $hookCode }} {{- end }} rm.metrics.RecordAPICall("READ_MANY", "{{ .CRD.Ops.ReadMany.ExportedName }}", err) if err != nil { - if awsErr, ok := ackerr.AWSError(err); ok && awsErr.Code() == "{{ ResourceExceptionCode .CRD 404 }}" {{ GoCodeSetExceptionMessageCheck .CRD 404 }}{ + if if strings.Contains(err.Error(), "{{ ResourceExceptionCode .CRD 404 }}" {{ GoCodeSetExceptionMessageCheck .CRD 404 }}) { return nil, ackerr.NotFound } return nil, err diff --git a/templates/pkg/resource/sdk_find_read_one.go.tpl b/templates/pkg/resource/sdk_find_read_one.go.tpl index 7ae90405..36febb75 100644 --- a/templates/pkg/resource/sdk_find_read_one.go.tpl +++ b/templates/pkg/resource/sdk_find_read_one.go.tpl @@ -28,7 +28,7 @@ func (rm *resourceManager) sdkFind( {{- end }} var resp {{ .CRD.GetOutputShapeGoType .CRD.Ops.ReadOne }} - resp, err = rm.sdkapi.{{ .CRD.Ops.ReadOne.ExportedName }}WithContext(ctx, input) + resp, err = rm.sdkapi.{{ .CRD.Ops.ReadOne.ExportedName }}(ctx, input) {{- if $hookCode := Hook .CRD "sdk_read_one_post_request" }} {{ $hookCode }} {{- end }} @@ -37,7 +37,7 @@ func (rm *resourceManager) sdkFind( if reqErr, ok := ackerr.AWSRequestFailure(err); ok && reqErr.StatusCode() == 404 { return nil, ackerr.NotFound } - if awsErr, ok := ackerr.AWSError(err); ok && awsErr.Code() == "{{ ResourceExceptionCode .CRD 404 }}" {{ GoCodeSetExceptionMessageCheck .CRD 404 }}{ + if strings.Contains(err.Error(), "{{ ResourceExceptionCode .CRD 404 }}" {{ GoCodeSetExceptionMessageCheck .CRD 404 }}) { return nil, ackerr.NotFound } return nil, err diff --git a/templates/pkg/resource/sdk_update.go.tpl b/templates/pkg/resource/sdk_update.go.tpl index d46bae78..5f0fb376 100644 --- a/templates/pkg/resource/sdk_update.go.tpl +++ b/templates/pkg/resource/sdk_update.go.tpl @@ -1,94 +1,77 @@ -{{ template "boilerplate" }} - -package {{ .CRD.Names.Snake }} - -import ( - "fmt" - "sync" - - ackv1alpha1 "github.com/aws-controllers-k8s/runtime/apis/core/v1alpha1" - ackcfg "github.com/aws-controllers-k8s/runtime/pkg/config" - ackmetrics "github.com/aws-controllers-k8s/runtime/pkg/metrics" - acktypes "github.com/aws-controllers-k8s/runtime/pkg/types" - "github.com/aws/aws-sdk-go/aws/session" - "github.com/go-logr/logr" - "github.com/aws/aws-sdk-go-v2/aws" - - svcsdkV2{{ .ServicePackageName }} "github.com/aws/aws-sdk-go-v2/service/{{ .ServicePackageName }}" - svcresource "github.com/aws-controllers-k8s/{{ .ControllerName }}-controller/pkg/resource" -) - -// resourceManagerFactory produces resourceManager objects. It implements the -// `types.AWSResourceManagerFactory` interface. -type resourceManagerFactory struct { - sync.RWMutex - // rmCache contains resource managers for a particular AWS account ID - rmCache map[string]*resourceManager -} - -// ResourcePrototype returns an AWSResource that resource managers produced by -// this factory will handle -func (f *resourceManagerFactory) ResourceDescriptor() acktypes.AWSResourceDescriptor { - return &resourceDescriptor{} -} -// This is for AWS-SDK-GO-V2 -- added sdk go V2 config as a parameter -// ManagerFor returns a resource manager object that can manage resources for a -// supplied AWS account -func (f *resourceManagerFactory) ManagerFor( - cfg ackcfg.Config, - log logr.Logger, - metrics *ackmetrics.Metrics, - rr acktypes.Reconciler, - sess *session.Session, - id ackv1alpha1.AWSAccountID, - region ackv1alpha1.AWSRegion, - config aws.Config, -) (acktypes.AWSResourceManager, error) { - rmId := fmt.Sprintf("%s/%s", id, region) - f.RLock() - rm, found := f.rmCache[rmId] - f.RUnlock() - - if found { - return rm, nil +{{- define "sdk_update" -}} +func (rm *resourceManager) sdkUpdate( + ctx context.Context, + desired *resource, + latest *resource, + delta *ackcompare.Delta, +) (updated *resource, err error) { + rlog := ackrtlog.FromContext(ctx) + exit := rlog.Trace("rm.sdkUpdate") + defer func() { + exit(err) + }() +{{- if .CRD.HasImmutableFieldChanges }} + if immutableFieldChanges := rm.getImmutableFieldChanges(delta); len(immutableFieldChanges) > 0 { + msg := fmt.Sprintf("Immutable Spec fields have been modified: %s", strings.Join(immutableFieldChanges, ",")) + return nil, ackerr.NewTerminalError(fmt.Errorf(msg)) + } +{{- end }} +{{- if $hookCode := Hook .CRD "sdk_update_pre_build_request" }} +{{ $hookCode }} +{{- end }} +{{- if $customMethod := .CRD.GetCustomImplementation .CRD.Ops.Update }} + updated, err = rm.{{ $customMethod }}(ctx, desired, latest, delta) + if updated != nil || err != nil { + return updated, err } - - f.Lock() - defer f.Unlock() - - // This is for AWS-SDK-GO-V2 - // Create a client for {{ .ServicePackageName }} - clientV2 := svcsdkV2{{ .ServicePackageName }}.NewFromConfig(config) - - rm, err := newResourceManager(cfg, log, metrics, rr, sess, id, region,config, clientV2) +{{- end }} + input, err := rm.newUpdateRequestPayload(ctx, desired, delta) if err != nil { return nil, err } - f.rmCache[rmId] = rm - return rm, nil -} - -// IsAdoptable returns true if the resource is able to be adopted -func (f *resourceManagerFactory) IsAdoptable() bool { - return {{ .CRD.IsAdoptable }} -} - -// RequeueOnSuccessSeconds returns true if the resource should be requeued after specified seconds -// Default is false which means resource will not be requeued after success. -func (f *resourceManagerFactory) RequeueOnSuccessSeconds() int { -{{- if $reconcileRequeuOnSuccessSeconds := .CRD.ReconcileRequeuOnSuccessSeconds }} - return {{ $reconcileRequeuOnSuccessSeconds }} -{{- else }} - return 0 +{{- if $hookCode := Hook .CRD "sdk_update_post_build_request" }} +{{ $hookCode }} {{- end }} -} -func newResourceManagerFactory() *resourceManagerFactory { - return &resourceManagerFactory{ - rmCache: map[string]*resourceManager{}, + var resp {{ .CRD.GetOutputShapeGoType .CRD.Ops.Update }}; _ = resp; + resp, err = rm.sdkapi.{{ .CRD.Ops.Update.ExportedName }}(ctx, input) +{{- if $hookCode := Hook .CRD "sdk_update_post_request" }} +{{ $hookCode }} +{{- end }} + rm.metrics.RecordAPICall("UPDATE", "{{ .CRD.Ops.Update.ExportedName }}", err) + if err != nil { + return nil, err } + // Merge in the information we read from the API call above to the copy of + // the original Kubernetes object we passed to the function + ko := desired.ko.DeepCopy() +{{- if $hookCode := Hook .CRD "sdk_update_pre_set_output" }} +{{ $hookCode }} +{{- end }} +{{ GoCodeSetUpdateOutput .CRD "resp" "ko" 1 }} + rm.setStatusDefaults(ko) +{{- if $setOutputCustomMethodName := .CRD.SetOutputCustomMethodName .CRD.Ops.Update }} + // custom set output from response + ko, err = rm.{{ $setOutputCustomMethodName }}(ctx, desired, resp, ko) + if err != nil { + return nil, err + } +{{- end }} +{{- if $hookCode := Hook .CRD "sdk_update_post_set_output" }} +{{ $hookCode }} +{{- end }} + return &resource{ko}, nil } -func init() { - svcresource.RegisterManagerFactory(newResourceManagerFactory()) -} \ No newline at end of file +// newUpdateRequestPayload returns an SDK-specific struct for the HTTP request +// payload of the Update API call for the resource +func (rm *resourceManager) newUpdateRequestPayload( + ctx context.Context, + r *resource, + delta *ackcompare.Delta, +) (*svcsdk.{{ .CRD.Ops.Update.InputRef.Shape.ShapeName }}, error) { + res := &svcsdk.{{ .CRD.Ops.Update.InputRef.Shape.ShapeName }}{} +{{ GoCodeSetUpdateInput .CRD "r.ko" "res" 1 }} + return res, nil +} +{{- end -}} \ No newline at end of file diff --git a/templates/pkg/resource/sdk_update_set_attributes.go.tpl b/templates/pkg/resource/sdk_update_set_attributes.go.tpl index 14e2398b..6c7490d8 100644 --- a/templates/pkg/resource/sdk_update_set_attributes.go.tpl +++ b/templates/pkg/resource/sdk_update_set_attributes.go.tpl @@ -34,7 +34,7 @@ func (rm *resourceManager) sdkUpdate( // contain any useful information. Instead, below, we'll be returning a // DeepCopy of the supplied desired state, which should be fine because // that desired state has been constructed from a call to GetAttributes... - _, respErr := rm.sdkapi.{{ .CRD.Ops.SetAttributes.ExportedName }}WithContext(ctx, input) + _, respErr := rm.sdkapi.{{ .CRD.Ops.SetAttributes.ExportedName }}(ctx, input) {{- if $hookCode := Hook .CRD "sdk_update_post_request" }} {{ $hookCode }} {{- end }} From 47e8343309d6c3ac5e665b8a4921ff1a5ac6c3cd Mon Sep 17 00:00:00 2001 From: michaelhtm <98621731+michaelhtm@users.noreply.github.com> Date: Wed, 8 Jan 2025 17:30:01 -0800 Subject: [PATCH 4/4] Unit test changes --- .vscode/launch.json | 28 + .vscode/settings.json | 3 + apiv2/converter.go | 7 +- go.mod | 7 +- go.sum | 14 +- pkg/generate/ack/runtime_test.go | 4 +- pkg/generate/code/compare_test.go | 7 + pkg/model/multiversion/delta_test.go | 9 + .../sdk-codegen/aws-models/apigatewayv2.json | 11433 ++ .../sdk-codegen/aws-models/codedeploy.json | 10038 ++ .../sdk-codegen/aws-models/dynamodb.json | 14043 ++ .../codegen/sdk-codegen/aws-models/ec2.json | 115215 +++++++++++++++ .../codegen/sdk-codegen/aws-models/ecr.json | 8685 ++ .../codegen/sdk-codegen/aws-models/eks.json | 11734 ++ .../sdk-codegen/aws-models/elasticache.json | 16575 +++ .../sdk-codegen/aws-models/emrcontainers.json | 4853 + .../sdk-codegen/aws-models/eventbridge.json | 10021 ++ .../codegen/sdk-codegen/aws-models/iam.json | 17486 +++ .../sdk-codegen/aws-models/lambda.json | 13473 ++ .../sdk-codegen/aws-models/memorydb.json | 7608 + .../codegen/sdk-codegen/aws-models/mq.json | 5034 + .../codegen/sdk-codegen/aws-models/rds.json | 31844 ++++ .../codegen/sdk-codegen/aws-models/s3.json | 36530 +++++ .../sdk-codegen/aws-models/sagemaker.json | 76024 ++++++++++ .../codegen/sdk-codegen/aws-models/sns.json | 5289 + .../codegen/sdk-codegen/aws-models/sqs.json | 4193 + .../codegen/sdk-codegen/aws-models/wafv2.json | 13073 ++ .../generator-renamed-identifier-field.yaml | 4 + .../ecr/0000-00-00/generator-v1alpha1.yaml | 6 +- .../ecr/0000-00-00/generator-v1alpha2.yaml | 6 +- .../ecr/0000-00-00/generator-v1alpha3.yaml | 6 +- .../generator-with-field-config.yaml | 4 + .../generator-with-late-initialize.yaml | 4 + ...ator-with-nested-path-late-initialize.yaml | 4 + .../models/apis/ecr/0000-00-00/generator.yaml | 4 + .../ecr/0000-00-01/generator-v1beta1.yaml | 6 +- .../ecr/0000-00-01/generator-v1beta2.yaml | 6 +- .../models/apis/s3/0000-00-00/generator.yaml | 4 + pkg/testutil/schema_helper.go | 2 +- .../pkg/resource/sdk_find_read_many.go.tpl | 2 +- 40 files changed, 413275 insertions(+), 13 deletions(-) create mode 100644 .vscode/launch.json create mode 100644 .vscode/settings.json create mode 100644 pkg/testdata/codegen/sdk-codegen/aws-models/apigatewayv2.json create mode 100644 pkg/testdata/codegen/sdk-codegen/aws-models/codedeploy.json create mode 100644 pkg/testdata/codegen/sdk-codegen/aws-models/dynamodb.json create mode 100644 pkg/testdata/codegen/sdk-codegen/aws-models/ec2.json create mode 100644 pkg/testdata/codegen/sdk-codegen/aws-models/ecr.json create mode 100644 pkg/testdata/codegen/sdk-codegen/aws-models/eks.json create mode 100644 pkg/testdata/codegen/sdk-codegen/aws-models/elasticache.json create mode 100644 pkg/testdata/codegen/sdk-codegen/aws-models/emrcontainers.json create mode 100644 pkg/testdata/codegen/sdk-codegen/aws-models/eventbridge.json create mode 100644 pkg/testdata/codegen/sdk-codegen/aws-models/iam.json create mode 100644 pkg/testdata/codegen/sdk-codegen/aws-models/lambda.json create mode 100644 pkg/testdata/codegen/sdk-codegen/aws-models/memorydb.json create mode 100644 pkg/testdata/codegen/sdk-codegen/aws-models/mq.json create mode 100644 pkg/testdata/codegen/sdk-codegen/aws-models/rds.json create mode 100644 pkg/testdata/codegen/sdk-codegen/aws-models/s3.json create mode 100644 pkg/testdata/codegen/sdk-codegen/aws-models/sagemaker.json create mode 100644 pkg/testdata/codegen/sdk-codegen/aws-models/sns.json create mode 100644 pkg/testdata/codegen/sdk-codegen/aws-models/sqs.json create mode 100644 pkg/testdata/codegen/sdk-codegen/aws-models/wafv2.json diff --git a/.vscode/launch.json b/.vscode/launch.json new file mode 100644 index 00000000..1eb28abc --- /dev/null +++ b/.vscode/launch.json @@ -0,0 +1,28 @@ +{ + // Use IntelliSense to learn about possible attributes. + // Hover to view descriptions of existing attributes. + // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 + "version": "0.2.0", + "go.delveConfig": { + "debugAdapter": "legacy", + }, + "configurations": [ + + { + "name": "Attach to Process", + "type": "go", + "request": "attach", + "mode": "local", + "processId": 0 + }, + + { + "name": "Launch Package", + "type": "go", + "request": "launch", + "mode": "auto", + "program": "/Users/mtewold/go/src/github.com/aws-controllers-k8s/code-generator/cmd/ack-generate/main.go" + } + + ] +} \ No newline at end of file diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 00000000..c4ec0397 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,3 @@ +{ + "go.buildTags": "codegen", +} \ No newline at end of file diff --git a/apiv2/converter.go b/apiv2/converter.go index b2e22a94..6d01c368 100644 --- a/apiv2/converter.go +++ b/apiv2/converter.go @@ -110,6 +110,9 @@ func BuildAPI(shapes map[string]Shape, serviceAlias string) (*api.API, error) { AddKeyAndValueRef(newApi.Shapes[name], name, shape, serviceAlias) case "enum": AddEnumRef(newApi.Shapes[name], shape) + case "union": + newApi.Shapes[name].Type = "structure" + AddMemberRefs(newApi.Shapes[name], shape, serviceAlias) } } @@ -119,9 +122,11 @@ func BuildAPI(shapes map[string]Shape, serviceAlias string) (*api.API, error) { func createApiOperation(shape Shape, name, serviceAlias string) *api.Operation { + doc, _ := shape.Traits["smithy.api#documentation"].(string) + newOperation := &api.Operation{ Name: name, - Documentation: api.AppendDocstring("", shape.Traits["smithy.api#documentation"].(string)), + Documentation: doc, } if hasPrefix(shape.InputRef.ShapeName, serviceAlias) { diff --git a/go.mod b/go.mod index 600f5096..62f19a1f 100644 --- a/go.mod +++ b/go.mod @@ -25,13 +25,18 @@ require ( sigs.k8s.io/controller-runtime v0.19.0 ) -replace github.com/aws-controllers-k8s/runtime => github.com/michaelhtm/ack-runtime v0.40.1-0.20250103184439-808a0d98774f +replace github.com/aws-controllers-k8s/runtime => github.com/michaelhtm/ack-runtime v0.40.1-0.20250108224829-d260bd8add76 require ( dario.cat/mergo v1.0.0 // indirect github.com/Microsoft/go-winio v0.6.1 // indirect github.com/ProtonMail/go-crypto v0.0.0-20230828082145-3c4c8a2d2371 // indirect github.com/aws/aws-sdk-go-v2 v1.32.6 // indirect + github.com/aws/aws-sdk-go-v2/internal/configsources v1.3.25 // indirect + github.com/aws/aws-sdk-go-v2/internal/endpoints/v2 v2.6.25 // indirect + github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v1.12.1 // indirect + github.com/aws/aws-sdk-go-v2/service/internal/presigned-url v1.12.6 // indirect + github.com/aws/aws-sdk-go-v2/service/sts v1.33.2 // indirect github.com/aws/smithy-go v1.22.1 // indirect github.com/beorn7/perks v1.0.1 // indirect github.com/blang/semver/v4 v4.0.0 // indirect diff --git a/go.sum b/go.sum index 47f2a211..38b65197 100644 --- a/go.sum +++ b/go.sum @@ -77,6 +77,16 @@ github.com/aws/aws-sdk-go v1.49.0 h1:g9BkW1fo9GqKfwg2+zCD+TW/D36Ux+vtfJ8guF4AYmY github.com/aws/aws-sdk-go v1.49.0/go.mod h1:LF8svs817+Nz+DmiMQKTO3ubZ/6IaTpq3TjupRn3Eqk= github.com/aws/aws-sdk-go-v2 v1.32.6 h1:7BokKRgRPuGmKkFMhEg/jSul+tB9VvXhcViILtfG8b4= github.com/aws/aws-sdk-go-v2 v1.32.6/go.mod h1:P5WJBrYqqbWVaOxgH0X/FYYD47/nooaPOZPlQdmiN2U= +github.com/aws/aws-sdk-go-v2/internal/configsources v1.3.25 h1:s/fF4+yDQDoElYhfIVvSNyeCydfbuTKzhxSXDXCPasU= +github.com/aws/aws-sdk-go-v2/internal/configsources v1.3.25/go.mod h1:IgPfDv5jqFIzQSNbUEMoitNooSMXjRSDkhXv8jiROvU= +github.com/aws/aws-sdk-go-v2/internal/endpoints/v2 v2.6.25 h1:ZntTCl5EsYnhN/IygQEUugpdwbhdkom9uHcbCftiGgA= +github.com/aws/aws-sdk-go-v2/internal/endpoints/v2 v2.6.25/go.mod h1:DBdPrgeocww+CSl1C8cEV8PN1mHMBhuCDLpXezyvWkE= +github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v1.12.1 h1:iXtILhvDxB6kPvEXgsDhGaZCSC6LQET5ZHSdJozeI0Y= +github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v1.12.1/go.mod h1:9nu0fVANtYiAePIBh2/pFUSwtJ402hLnp854CNoDOeE= +github.com/aws/aws-sdk-go-v2/service/internal/presigned-url v1.12.6 h1:50+XsN70RS7dwJ2CkVNXzj7U2L1HKP8nqTd3XWEXBN4= +github.com/aws/aws-sdk-go-v2/service/internal/presigned-url v1.12.6/go.mod h1:WqgLmwY7so32kG01zD8CPTJWVWM+TzJoOVHwTg4aPug= +github.com/aws/aws-sdk-go-v2/service/sts v1.33.2 h1:s4074ZO1Hk8qv65GqNXqDjmkf4HSQqJukaLuuW0TpDA= +github.com/aws/aws-sdk-go-v2/service/sts v1.33.2/go.mod h1:mVggCnIWoM09jP71Wh+ea7+5gAp53q+49wDFs1SW5z8= github.com/aws/smithy-go v1.22.1 h1:/HPHZQ0g7f4eUeK6HKglFz8uwVfZKgoI25rb/J+dnro= github.com/aws/smithy-go v1.22.1/go.mod h1:irrKGvNn1InZwb2d7fkIRNucdfwR8R+Ts3wxYa/cJHg= github.com/beorn7/perks v0.0.0-20180321164747-3a771d992973/go.mod h1:Dwedo/Wpr24TaqPxmxbtue+5NUziq4I4S80YR8gNf3Q= @@ -433,8 +443,8 @@ github.com/mattn/go-isatty v0.0.12/go.mod h1:cbi8OIDigv2wuxKPP5vlRcQ1OAZbq2CE4Ky github.com/mattn/go-runewidth v0.0.2/go.mod h1:LwmH8dsx7+W8Uxz3IHJYH5QSwggIsqBzpuz5H//U1FU= github.com/matttproud/golang_protobuf_extensions v1.0.1/go.mod h1:D8He9yQNgCq6Z5Ld7szi9bcBfOoFv/3dc6xSMkL2PC0= github.com/matttproud/golang_protobuf_extensions v1.0.2-0.20181231171920-c182affec369/go.mod h1:BSXmuO+STAnVfrANrmjBb36TMTDstsz7MSK+HVaYKv4= -github.com/michaelhtm/ack-runtime v0.40.1-0.20250103184439-808a0d98774f h1:+iOvn5LckQbtvIcf0JazTEyIpvWBns76snBPv6xEptI= -github.com/michaelhtm/ack-runtime v0.40.1-0.20250103184439-808a0d98774f/go.mod h1:8pIhYHIFOZuI9RembiZOmrGrUq0GwAoB/ia89gxlkOQ= +github.com/michaelhtm/ack-runtime v0.40.1-0.20250108224829-d260bd8add76 h1:Fxn5/ERfgWPHOnQ5MJofyU6va0bC9TL5PZafrW2SmBY= +github.com/michaelhtm/ack-runtime v0.40.1-0.20250108224829-d260bd8add76/go.mod h1:1xPHqvdB5KnLR4UCKPj2sRszbV/0BhmtJaV/cuaJu00= github.com/miekg/dns v1.0.14/go.mod h1:W1PPwlIAgtquWBMBEV9nkV9Cazfe8ScdGz/Lj7v3Nrg= github.com/mikefarah/yq/v3 v3.0.0-20201202084205-8846255d1c37/go.mod h1:dYWq+UWoFCDY1TndvFUQuhBbIYmZpjreC8adEAx93zE= github.com/mitchellh/cli v1.0.0/go.mod h1:hNIlj7HEI86fIcpObd7a0FcrxTWetlwJDGcceTlRvqc= diff --git a/pkg/generate/ack/runtime_test.go b/pkg/generate/ack/runtime_test.go index fbbd0a32..fbd211fd 100644 --- a/pkg/generate/ack/runtime_test.go +++ b/pkg/generate/ack/runtime_test.go @@ -21,7 +21,7 @@ import ( "k8s.io/apimachinery/pkg/runtime/schema" rtclient "sigs.k8s.io/controller-runtime/pkg/client" - "github.com/aws/aws-sdk-go/aws/session" + "github.com/aws/aws-sdk-go-v2/aws" "github.com/go-logr/logr" "github.com/stretchr/testify/require" @@ -90,10 +90,10 @@ func (rmf *fakeRMF) ResourceDescriptor() acktypes.AWSResourceDescriptor { func (rmf *fakeRMF) ManagerFor( ackcfg.Config, // passed by-value to avoid mutation by consumers + aws.Config, logr.Logger, *ackmetrics.Metrics, acktypes.Reconciler, - *session.Session, ackv1alpha1.AWSAccountID, ackv1alpha1.AWSRegion, ackv1alpha1.AWSResourceName, diff --git a/pkg/generate/code/compare_test.go b/pkg/generate/code/compare_test.go index 2111ccd0..c113377c 100644 --- a/pkg/generate/code/compare_test.go +++ b/pkg/generate/code/compare_test.go @@ -124,6 +124,13 @@ func TestCompareResource_S3_Bucket(t *testing.T) { delta.Add("Spec.ObjectLockEnabledForBucket", a.ko.Spec.ObjectLockEnabledForBucket, b.ko.Spec.ObjectLockEnabledForBucket) } } + if ackcompare.HasNilDifference(a.ko.Spec.ObjectOwnership, b.ko.Spec.ObjectOwnership) { + delta.Add("Spec.ObjectOwnership", a.ko.Spec.ObjectOwnership, b.ko.Spec.ObjectOwnership) + } else if a.ko.Spec.ObjectOwnership != nil && b.ko.Spec.ObjectOwnership != nil { + if *a.ko.Spec.ObjectOwnership != *b.ko.Spec.ObjectOwnership { + delta.Add("Spec.ObjectOwnership", a.ko.Spec.ObjectOwnership, b.ko.Spec.ObjectOwnership) + } + } if ackcompare.HasNilDifference(a.ko.Spec.Tagging, b.ko.Spec.Tagging) { delta.Add("Spec.Tagging", a.ko.Spec.Tagging, b.ko.Spec.Tagging) } else if a.ko.Spec.Tagging != nil && b.ko.Spec.Tagging != nil { diff --git a/pkg/model/multiversion/delta_test.go b/pkg/model/multiversion/delta_test.go index 511b8bc5..10ab4b0a 100644 --- a/pkg/model/multiversion/delta_test.go +++ b/pkg/model/multiversion/delta_test.go @@ -435,6 +435,15 @@ func TestAreEqualShapes_ECR_Repository(t *testing.T) { model := testutil.NewModelForServiceWithOptions(t, "ecr", &testutil.TestingModelOptions{}) crds, err := model.GetCRDs() require.Nil(err) + str := "" + fmt.Println() + fmt.Println() + fmt.Println() + fmt.Println() + for _, crd := range crds { + str += crd.Names.Original + " " + } + require.Equal(str, "") require.Len(crds, 1) repositoryCRD := crds[0] diff --git a/pkg/testdata/codegen/sdk-codegen/aws-models/apigatewayv2.json b/pkg/testdata/codegen/sdk-codegen/aws-models/apigatewayv2.json new file mode 100644 index 00000000..5c1d8843 --- /dev/null +++ b/pkg/testdata/codegen/sdk-codegen/aws-models/apigatewayv2.json @@ -0,0 +1,11433 @@ +{ + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.apigatewayv2#AccessDeniedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#jsonName": "message" + } + } + }, + "traits": { + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.apigatewayv2#AccessLogSettings": { + "type": "structure", + "members": { + "DestinationArn": { + "target": "com.amazonaws.apigatewayv2#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the CloudWatch Logs log group to receive access logs.

", + "smithy.api#jsonName": "destinationArn" + } + }, + "Format": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And1024", + "traits": { + "smithy.api#documentation": "

A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.

", + "smithy.api#jsonName": "format" + } + } + }, + "traits": { + "smithy.api#documentation": "

Settings for logging access in a stage.

" + } + }, + "com.amazonaws.apigatewayv2#Api": { + "type": "structure", + "members": { + "ApiEndpoint": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.

", + "smithy.api#jsonName": "apiEndpoint" + } + }, + "ApiGatewayManaged": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.

", + "smithy.api#jsonName": "apiGatewayManaged" + } + }, + "ApiId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The API ID.

", + "smithy.api#jsonName": "apiId" + } + }, + "ApiKeySelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

", + "smithy.api#jsonName": "apiKeySelectionExpression" + } + }, + "CorsConfiguration": { + "target": "com.amazonaws.apigatewayv2#Cors", + "traits": { + "smithy.api#documentation": "

A CORS configuration. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "corsConfiguration" + } + }, + "CreatedDate": { + "target": "com.amazonaws.apigatewayv2#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

The timestamp when the API was created.

", + "smithy.api#jsonName": "createdDate" + } + }, + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

The description of the API.

", + "smithy.api#jsonName": "description" + } + }, + "DisableSchemaValidation": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "disableSchemaValidation" + } + }, + "DisableExecuteApiEndpoint": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

", + "smithy.api#jsonName": "disableExecuteApiEndpoint" + } + }, + "ImportInfo": { + "target": "com.amazonaws.apigatewayv2#__listOf__string", + "traits": { + "smithy.api#documentation": "

The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "importInfo" + } + }, + "Name": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the API.

", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + }, + "ProtocolType": { + "target": "com.amazonaws.apigatewayv2#ProtocolType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The API protocol.

", + "smithy.api#jsonName": "protocolType", + "smithy.api#required": {} + } + }, + "RouteSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

", + "smithy.api#jsonName": "routeSelectionExpression", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.apigatewayv2#Tags", + "traits": { + "smithy.api#documentation": "

A collection of tags associated with the API.

", + "smithy.api#jsonName": "tags" + } + }, + "Version": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "traits": { + "smithy.api#documentation": "

A version identifier for the API.

", + "smithy.api#jsonName": "version" + } + }, + "Warnings": { + "target": "com.amazonaws.apigatewayv2#__listOf__string", + "traits": { + "smithy.api#documentation": "

The warning messages reported when failonwarnings is turned on during API import.

", + "smithy.api#jsonName": "warnings" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents an API.

" + } + }, + "com.amazonaws.apigatewayv2#ApiGatewayV2": { + "type": "service", + "version": "2018-11-29", + "operations": [ + { + "target": "com.amazonaws.apigatewayv2#CreateApi" + }, + { + "target": "com.amazonaws.apigatewayv2#CreateApiMapping" + }, + { + "target": "com.amazonaws.apigatewayv2#CreateAuthorizer" + }, + { + "target": "com.amazonaws.apigatewayv2#CreateDeployment" + }, + { + "target": "com.amazonaws.apigatewayv2#CreateDomainName" + }, + { + "target": "com.amazonaws.apigatewayv2#CreateIntegration" + }, + { + "target": "com.amazonaws.apigatewayv2#CreateIntegrationResponse" + }, + { + "target": "com.amazonaws.apigatewayv2#CreateModel" + }, + { + "target": "com.amazonaws.apigatewayv2#CreateRoute" + }, + { + "target": "com.amazonaws.apigatewayv2#CreateRouteResponse" + }, + { + "target": "com.amazonaws.apigatewayv2#CreateStage" + }, + { + "target": "com.amazonaws.apigatewayv2#CreateVpcLink" + }, + { + "target": "com.amazonaws.apigatewayv2#DeleteAccessLogSettings" + }, + { + "target": "com.amazonaws.apigatewayv2#DeleteApi" + }, + { + "target": "com.amazonaws.apigatewayv2#DeleteApiMapping" + }, + { + "target": "com.amazonaws.apigatewayv2#DeleteAuthorizer" + }, + { + "target": "com.amazonaws.apigatewayv2#DeleteCorsConfiguration" + }, + { + "target": "com.amazonaws.apigatewayv2#DeleteDeployment" + }, + { + "target": "com.amazonaws.apigatewayv2#DeleteDomainName" + }, + { + "target": "com.amazonaws.apigatewayv2#DeleteIntegration" + }, + { + "target": "com.amazonaws.apigatewayv2#DeleteIntegrationResponse" + }, + { + "target": "com.amazonaws.apigatewayv2#DeleteModel" + }, + { + "target": "com.amazonaws.apigatewayv2#DeleteRoute" + }, + { + "target": "com.amazonaws.apigatewayv2#DeleteRouteRequestParameter" + }, + { + "target": "com.amazonaws.apigatewayv2#DeleteRouteResponse" + }, + { + "target": "com.amazonaws.apigatewayv2#DeleteRouteSettings" + }, + { + "target": "com.amazonaws.apigatewayv2#DeleteStage" + }, + { + "target": "com.amazonaws.apigatewayv2#DeleteVpcLink" + }, + { + "target": "com.amazonaws.apigatewayv2#ExportApi" + }, + { + "target": "com.amazonaws.apigatewayv2#GetApi" + }, + { + "target": "com.amazonaws.apigatewayv2#GetApiMapping" + }, + { + "target": "com.amazonaws.apigatewayv2#GetApiMappings" + }, + { + "target": "com.amazonaws.apigatewayv2#GetApis" + }, + { + "target": "com.amazonaws.apigatewayv2#GetAuthorizer" + }, + { + "target": "com.amazonaws.apigatewayv2#GetAuthorizers" + }, + { + "target": "com.amazonaws.apigatewayv2#GetDeployment" + }, + { + "target": "com.amazonaws.apigatewayv2#GetDeployments" + }, + { + "target": "com.amazonaws.apigatewayv2#GetDomainName" + }, + { + "target": "com.amazonaws.apigatewayv2#GetDomainNames" + }, + { + "target": "com.amazonaws.apigatewayv2#GetIntegration" + }, + { + "target": "com.amazonaws.apigatewayv2#GetIntegrationResponse" + }, + { + "target": "com.amazonaws.apigatewayv2#GetIntegrationResponses" + }, + { + "target": "com.amazonaws.apigatewayv2#GetIntegrations" + }, + { + "target": "com.amazonaws.apigatewayv2#GetModel" + }, + { + "target": "com.amazonaws.apigatewayv2#GetModels" + }, + { + "target": "com.amazonaws.apigatewayv2#GetModelTemplate" + }, + { + "target": "com.amazonaws.apigatewayv2#GetRoute" + }, + { + "target": "com.amazonaws.apigatewayv2#GetRouteResponse" + }, + { + "target": "com.amazonaws.apigatewayv2#GetRouteResponses" + }, + { + "target": "com.amazonaws.apigatewayv2#GetRoutes" + }, + { + "target": "com.amazonaws.apigatewayv2#GetStage" + }, + { + "target": "com.amazonaws.apigatewayv2#GetStages" + }, + { + "target": "com.amazonaws.apigatewayv2#GetTags" + }, + { + "target": "com.amazonaws.apigatewayv2#GetVpcLink" + }, + { + "target": "com.amazonaws.apigatewayv2#GetVpcLinks" + }, + { + "target": "com.amazonaws.apigatewayv2#ImportApi" + }, + { + "target": "com.amazonaws.apigatewayv2#ReimportApi" + }, + { + "target": "com.amazonaws.apigatewayv2#ResetAuthorizersCache" + }, + { + "target": "com.amazonaws.apigatewayv2#TagResource" + }, + { + "target": "com.amazonaws.apigatewayv2#UntagResource" + }, + { + "target": "com.amazonaws.apigatewayv2#UpdateApi" + }, + { + "target": "com.amazonaws.apigatewayv2#UpdateApiMapping" + }, + { + "target": "com.amazonaws.apigatewayv2#UpdateAuthorizer" + }, + { + "target": "com.amazonaws.apigatewayv2#UpdateDeployment" + }, + { + "target": "com.amazonaws.apigatewayv2#UpdateDomainName" + }, + { + "target": "com.amazonaws.apigatewayv2#UpdateIntegration" + }, + { + "target": "com.amazonaws.apigatewayv2#UpdateIntegrationResponse" + }, + { + "target": "com.amazonaws.apigatewayv2#UpdateModel" + }, + { + "target": "com.amazonaws.apigatewayv2#UpdateRoute" + }, + { + "target": "com.amazonaws.apigatewayv2#UpdateRouteResponse" + }, + { + "target": "com.amazonaws.apigatewayv2#UpdateStage" + }, + { + "target": "com.amazonaws.apigatewayv2#UpdateVpcLink" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "ApiGatewayV2", + "arnNamespace": "apigateway", + "cloudFormationName": "ApiGatewayV2", + "cloudTrailEventSource": "apigatewayv2.amazonaws.com", + "endpointPrefix": "apigateway" + }, + "aws.auth#sigv4": { + "name": "apigateway" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

Amazon API Gateway V2

", + "smithy.api#title": "AmazonApiGatewayV2", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://apigateway-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://apigateway-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://apigateway.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://apigateway.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://apigateway.af-south-1.amazonaws.com" + } + }, + "params": { + "Region": "af-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://apigateway.ap-east-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://apigateway.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://apigateway.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://apigateway.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://apigateway.ap-south-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://apigateway.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://apigateway.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://apigateway.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://apigateway.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://apigateway.eu-north-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://apigateway.eu-south-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://apigateway.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://apigateway.eu-west-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://apigateway.eu-west-3.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://apigateway.me-south-1.amazonaws.com" + } + }, + "params": { + "Region": "me-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://apigateway.sa-east-1.amazonaws.com" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://apigateway.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://apigateway.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://apigateway.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://apigateway.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://apigateway-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://apigateway-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://apigateway.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://apigateway.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://apigateway.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://apigateway-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://apigateway-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://apigateway.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://apigateway.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://apigateway.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://apigateway-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://apigateway-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://apigateway.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://apigateway.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://apigateway-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://apigateway-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://apigateway.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.apigatewayv2#ApiMapping": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#jsonName": "apiId", + "smithy.api#required": {} + } + }, + "ApiMappingId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The API mapping identifier.

", + "smithy.api#jsonName": "apiMappingId" + } + }, + "ApiMappingKey": { + "target": "com.amazonaws.apigatewayv2#SelectionKey", + "traits": { + "smithy.api#documentation": "

The API mapping key.

", + "smithy.api#jsonName": "apiMappingKey" + } + }, + "Stage": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The API stage.

", + "smithy.api#jsonName": "stage", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents an API mapping.

" + } + }, + "com.amazonaws.apigatewayv2#Arn": { + "type": "string", + "traits": { + "smithy.api#documentation": "

Represents an Amazon Resource Name (ARN).

" + } + }, + "com.amazonaws.apigatewayv2#AuthorizationScopes": { + "type": "list", + "member": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64" + }, + "traits": { + "smithy.api#documentation": "

A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

" + } + }, + "com.amazonaws.apigatewayv2#AuthorizationType": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "AWS_IAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_IAM" + } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } + }, + "JWT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JWT" + } + } + }, + "traits": { + "smithy.api#documentation": "

The authorization type. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer. For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.

" + } + }, + "com.amazonaws.apigatewayv2#Authorizer": { + "type": "structure", + "members": { + "AuthorizerCredentialsArn": { + "target": "com.amazonaws.apigatewayv2#Arn", + "traits": { + "smithy.api#documentation": "

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.

", + "smithy.api#jsonName": "authorizerCredentialsArn" + } + }, + "AuthorizerId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The authorizer identifier.

", + "smithy.api#jsonName": "authorizerId" + } + }, + "AuthorizerPayloadFormatVersion": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "traits": { + "smithy.api#documentation": "

Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

", + "smithy.api#jsonName": "authorizerPayloadFormatVersion" + } + }, + "AuthorizerResultTtlInSeconds": { + "target": "com.amazonaws.apigatewayv2#IntegerWithLengthBetween0And3600", + "traits": { + "smithy.api#documentation": "

The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.

", + "smithy.api#jsonName": "authorizerResultTtlInSeconds" + } + }, + "AuthorizerType": { + "target": "com.amazonaws.apigatewayv2#AuthorizerType", + "traits": { + "smithy.api#documentation": "

The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).

", + "smithy.api#jsonName": "authorizerType" + } + }, + "AuthorizerUri": { + "target": "com.amazonaws.apigatewayv2#UriWithLengthBetween1And2048", + "traits": { + "smithy.api#documentation": "

The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api}\n , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.

", + "smithy.api#jsonName": "authorizerUri" + } + }, + "EnableSimpleResponses": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs

", + "smithy.api#jsonName": "enableSimpleResponses" + } + }, + "IdentitySource": { + "target": "com.amazonaws.apigatewayv2#IdentitySourceList", + "traits": { + "smithy.api#documentation": "

The identity source for which authorization is requested.

For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.

", + "smithy.api#jsonName": "identitySource" + } + }, + "IdentityValidationExpression": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

The validation expression does not apply to the REQUEST authorizer.

", + "smithy.api#jsonName": "identityValidationExpression" + } + }, + "JwtConfiguration": { + "target": "com.amazonaws.apigatewayv2#JWTConfiguration", + "traits": { + "smithy.api#documentation": "

Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "jwtConfiguration" + } + }, + "Name": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the authorizer.

", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents an authorizer.

" + } + }, + "com.amazonaws.apigatewayv2#AuthorizerType": { + "type": "enum", + "members": { + "REQUEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REQUEST" + } + }, + "JWT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JWT" + } + } + }, + "traits": { + "smithy.api#documentation": "

The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).

" + } + }, + "com.amazonaws.apigatewayv2#BadRequestException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

Describes the error encountered.

", + "smithy.api#jsonName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.apigatewayv2#ConflictException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

Describes the error encountered.

", + "smithy.api#jsonName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.apigatewayv2#ConnectionType": { + "type": "enum", + "members": { + "INTERNET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNET" + } + }, + "VPC_LINK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VPC_LINK" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a connection type.

" + } + }, + "com.amazonaws.apigatewayv2#ContentHandlingStrategy": { + "type": "enum", + "members": { + "CONVERT_TO_BINARY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONVERT_TO_BINARY" + } + }, + "CONVERT_TO_TEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONVERT_TO_TEXT" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies how to handle response payload content type conversions. Supported only for WebSocket APIs.

" + } + }, + "com.amazonaws.apigatewayv2#Cors": { + "type": "structure", + "members": { + "AllowCredentials": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "allowCredentials" + } + }, + "AllowHeaders": { + "target": "com.amazonaws.apigatewayv2#CorsHeaderList", + "traits": { + "smithy.api#documentation": "

Represents a collection of allowed headers. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "allowHeaders" + } + }, + "AllowMethods": { + "target": "com.amazonaws.apigatewayv2#CorsMethodList", + "traits": { + "smithy.api#documentation": "

Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "allowMethods" + } + }, + "AllowOrigins": { + "target": "com.amazonaws.apigatewayv2#CorsOriginList", + "traits": { + "smithy.api#documentation": "

Represents a collection of allowed origins. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "allowOrigins" + } + }, + "ExposeHeaders": { + "target": "com.amazonaws.apigatewayv2#CorsHeaderList", + "traits": { + "smithy.api#documentation": "

Represents a collection of exposed headers. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "exposeHeaders" + } + }, + "MaxAge": { + "target": "com.amazonaws.apigatewayv2#IntegerWithLengthBetweenMinus1And86400", + "traits": { + "smithy.api#documentation": "

The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "maxAge" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.

" + } + }, + "com.amazonaws.apigatewayv2#CorsHeaderList": { + "type": "list", + "member": { + "target": "com.amazonaws.apigatewayv2#__string" + }, + "traits": { + "smithy.api#documentation": "

Represents a collection of allowed headers. Supported only for HTTP APIs.

" + } + }, + "com.amazonaws.apigatewayv2#CorsMethodList": { + "type": "list", + "member": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64" + }, + "traits": { + "smithy.api#documentation": "

Represents a collection of methods. Supported only for HTTP APIs.

" + } + }, + "com.amazonaws.apigatewayv2#CorsOriginList": { + "type": "list", + "member": { + "target": "com.amazonaws.apigatewayv2#__string" + }, + "traits": { + "smithy.api#documentation": "

Represents a collection of origins. Supported only for HTTP APIs.

" + } + }, + "com.amazonaws.apigatewayv2#CreateApi": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#CreateApiRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#CreateApiResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#BadRequestException" + }, + { + "target": "com.amazonaws.apigatewayv2#ConflictException" + }, + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an Api resource.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v2/apis", + "code": 201 + } + } + }, + "com.amazonaws.apigatewayv2#CreateApiMapping": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#CreateApiMappingRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#CreateApiMappingResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#BadRequestException" + }, + { + "target": "com.amazonaws.apigatewayv2#ConflictException" + }, + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an API mapping.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v2/domainnames/{DomainName}/apimappings", + "code": 201 + } + } + }, + "com.amazonaws.apigatewayv2#CreateApiMappingRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#jsonName": "apiId", + "smithy.api#required": {} + } + }, + "ApiMappingKey": { + "target": "com.amazonaws.apigatewayv2#SelectionKey", + "traits": { + "smithy.api#documentation": "The API mapping key.", + "smithy.api#jsonName": "apiMappingKey" + } + }, + "DomainName": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The domain name.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Stage": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The API stage.

", + "smithy.api#jsonName": "stage", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Creates a new ApiMapping resource to represent an API mapping.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#CreateApiMappingResponse": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#jsonName": "apiId" + } + }, + "ApiMappingId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The API mapping identifier.

", + "smithy.api#jsonName": "apiMappingId" + } + }, + "ApiMappingKey": { + "target": "com.amazonaws.apigatewayv2#SelectionKey", + "traits": { + "smithy.api#documentation": "

The API mapping key.

", + "smithy.api#jsonName": "apiMappingKey" + } + }, + "Stage": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

The API stage.

", + "smithy.api#jsonName": "stage" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#CreateApiRequest": { + "type": "structure", + "members": { + "ApiKeySelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

", + "smithy.api#jsonName": "apiKeySelectionExpression" + } + }, + "CorsConfiguration": { + "target": "com.amazonaws.apigatewayv2#Cors", + "traits": { + "smithy.api#documentation": "

A CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.

", + "smithy.api#jsonName": "corsConfiguration" + } + }, + "CredentialsArn": { + "target": "com.amazonaws.apigatewayv2#Arn", + "traits": { + "smithy.api#documentation": "

This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "credentialsArn" + } + }, + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

The description of the API.

", + "smithy.api#jsonName": "description" + } + }, + "DisableSchemaValidation": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "disableSchemaValidation" + } + }, + "DisableExecuteApiEndpoint": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

", + "smithy.api#jsonName": "disableExecuteApiEndpoint" + } + }, + "Name": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the API.

", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + }, + "ProtocolType": { + "target": "com.amazonaws.apigatewayv2#ProtocolType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The API protocol.

", + "smithy.api#jsonName": "protocolType", + "smithy.api#required": {} + } + }, + "RouteKey": { + "target": "com.amazonaws.apigatewayv2#SelectionKey", + "traits": { + "smithy.api#documentation": "

This property is part of quick create. If you don't specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "routeKey" + } + }, + "RouteSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

", + "smithy.api#jsonName": "routeSelectionExpression" + } + }, + "Tags": { + "target": "com.amazonaws.apigatewayv2#Tags", + "traits": { + "smithy.api#documentation": "

The collection of tags. Each tag element is associated with a given resource.

", + "smithy.api#jsonName": "tags" + } + }, + "Target": { + "target": "com.amazonaws.apigatewayv2#UriWithLengthBetween1And2048", + "traits": { + "smithy.api#documentation": "

This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "target" + } + }, + "Version": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "traits": { + "smithy.api#documentation": "

A version identifier for the API.

", + "smithy.api#jsonName": "version" + } + } + }, + "traits": { + "smithy.api#documentation": "

Creates a new Api resource to represent an API.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#CreateApiResponse": { + "type": "structure", + "members": { + "ApiEndpoint": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.

", + "smithy.api#jsonName": "apiEndpoint" + } + }, + "ApiGatewayManaged": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.

", + "smithy.api#jsonName": "apiGatewayManaged" + } + }, + "ApiId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The API ID.

", + "smithy.api#jsonName": "apiId" + } + }, + "ApiKeySelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

", + "smithy.api#jsonName": "apiKeySelectionExpression" + } + }, + "CorsConfiguration": { + "target": "com.amazonaws.apigatewayv2#Cors", + "traits": { + "smithy.api#documentation": "

A CORS configuration. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "corsConfiguration" + } + }, + "CreatedDate": { + "target": "com.amazonaws.apigatewayv2#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

The timestamp when the API was created.

", + "smithy.api#jsonName": "createdDate" + } + }, + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

The description of the API.

", + "smithy.api#jsonName": "description" + } + }, + "DisableSchemaValidation": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "disableSchemaValidation" + } + }, + "DisableExecuteApiEndpoint": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

", + "smithy.api#jsonName": "disableExecuteApiEndpoint" + } + }, + "ImportInfo": { + "target": "com.amazonaws.apigatewayv2#__listOf__string", + "traits": { + "smithy.api#documentation": "

The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "importInfo" + } + }, + "Name": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

The name of the API.

", + "smithy.api#jsonName": "name" + } + }, + "ProtocolType": { + "target": "com.amazonaws.apigatewayv2#ProtocolType", + "traits": { + "smithy.api#documentation": "

The API protocol.

", + "smithy.api#jsonName": "protocolType" + } + }, + "RouteSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

", + "smithy.api#jsonName": "routeSelectionExpression" + } + }, + "Tags": { + "target": "com.amazonaws.apigatewayv2#Tags", + "traits": { + "smithy.api#documentation": "

A collection of tags associated with the API.

", + "smithy.api#jsonName": "tags" + } + }, + "Version": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "traits": { + "smithy.api#documentation": "

A version identifier for the API.

", + "smithy.api#jsonName": "version" + } + }, + "Warnings": { + "target": "com.amazonaws.apigatewayv2#__listOf__string", + "traits": { + "smithy.api#documentation": "

The warning messages reported when failonwarnings is turned on during API import.

", + "smithy.api#jsonName": "warnings" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#CreateAuthorizer": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#CreateAuthorizerRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#CreateAuthorizerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#BadRequestException" + }, + { + "target": "com.amazonaws.apigatewayv2#ConflictException" + }, + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an Authorizer for an API.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v2/apis/{ApiId}/authorizers", + "code": 201 + } + } + }, + "com.amazonaws.apigatewayv2#CreateAuthorizerRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AuthorizerCredentialsArn": { + "target": "com.amazonaws.apigatewayv2#Arn", + "traits": { + "smithy.api#documentation": "

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.

", + "smithy.api#jsonName": "authorizerCredentialsArn" + } + }, + "AuthorizerPayloadFormatVersion": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "traits": { + "smithy.api#documentation": "

Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

", + "smithy.api#jsonName": "authorizerPayloadFormatVersion" + } + }, + "AuthorizerResultTtlInSeconds": { + "target": "com.amazonaws.apigatewayv2#IntegerWithLengthBetween0And3600", + "traits": { + "smithy.api#documentation": "

The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.

", + "smithy.api#jsonName": "authorizerResultTtlInSeconds" + } + }, + "AuthorizerType": { + "target": "com.amazonaws.apigatewayv2#AuthorizerType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).

", + "smithy.api#jsonName": "authorizerType", + "smithy.api#required": {} + } + }, + "AuthorizerUri": { + "target": "com.amazonaws.apigatewayv2#UriWithLengthBetween1And2048", + "traits": { + "smithy.api#documentation": "

The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api}\n , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.

", + "smithy.api#jsonName": "authorizerUri" + } + }, + "EnableSimpleResponses": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs

", + "smithy.api#jsonName": "enableSimpleResponses" + } + }, + "IdentitySource": { + "target": "com.amazonaws.apigatewayv2#IdentitySourceList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identity source for which authorization is requested.

For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.

", + "smithy.api#jsonName": "identitySource", + "smithy.api#required": {} + } + }, + "IdentityValidationExpression": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

This parameter is not used.

", + "smithy.api#jsonName": "identityValidationExpression" + } + }, + "JwtConfiguration": { + "target": "com.amazonaws.apigatewayv2#JWTConfiguration", + "traits": { + "smithy.api#documentation": "

Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "jwtConfiguration" + } + }, + "Name": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the authorizer.

", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Creates a new Authorizer resource to represent an authorizer.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#CreateAuthorizerResponse": { + "type": "structure", + "members": { + "AuthorizerCredentialsArn": { + "target": "com.amazonaws.apigatewayv2#Arn", + "traits": { + "smithy.api#documentation": "

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.

", + "smithy.api#jsonName": "authorizerCredentialsArn" + } + }, + "AuthorizerId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The authorizer identifier.

", + "smithy.api#jsonName": "authorizerId" + } + }, + "AuthorizerPayloadFormatVersion": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "traits": { + "smithy.api#documentation": "

Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

", + "smithy.api#jsonName": "authorizerPayloadFormatVersion" + } + }, + "AuthorizerResultTtlInSeconds": { + "target": "com.amazonaws.apigatewayv2#IntegerWithLengthBetween0And3600", + "traits": { + "smithy.api#documentation": "

The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.

", + "smithy.api#jsonName": "authorizerResultTtlInSeconds" + } + }, + "AuthorizerType": { + "target": "com.amazonaws.apigatewayv2#AuthorizerType", + "traits": { + "smithy.api#documentation": "

The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).

", + "smithy.api#jsonName": "authorizerType" + } + }, + "AuthorizerUri": { + "target": "com.amazonaws.apigatewayv2#UriWithLengthBetween1And2048", + "traits": { + "smithy.api#documentation": "

The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api}\n , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.

", + "smithy.api#jsonName": "authorizerUri" + } + }, + "EnableSimpleResponses": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs

", + "smithy.api#jsonName": "enableSimpleResponses" + } + }, + "IdentitySource": { + "target": "com.amazonaws.apigatewayv2#IdentitySourceList", + "traits": { + "smithy.api#documentation": "

The identity source for which authorization is requested.

For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.

", + "smithy.api#jsonName": "identitySource" + } + }, + "IdentityValidationExpression": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

The validation expression does not apply to the REQUEST authorizer.

", + "smithy.api#jsonName": "identityValidationExpression" + } + }, + "JwtConfiguration": { + "target": "com.amazonaws.apigatewayv2#JWTConfiguration", + "traits": { + "smithy.api#documentation": "

Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "jwtConfiguration" + } + }, + "Name": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

The name of the authorizer.

", + "smithy.api#jsonName": "name" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#CreateDeployment": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#CreateDeploymentRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#CreateDeploymentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#BadRequestException" + }, + { + "target": "com.amazonaws.apigatewayv2#ConflictException" + }, + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a Deployment for an API.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v2/apis/{ApiId}/deployments", + "code": 201 + } + } + }, + "com.amazonaws.apigatewayv2#CreateDeploymentRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

The description for the deployment resource.

", + "smithy.api#jsonName": "description" + } + }, + "StageName": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

The name of the Stage resource for the Deployment resource to create.

", + "smithy.api#jsonName": "stageName" + } + } + }, + "traits": { + "smithy.api#documentation": "

Creates a new Deployment resource to represent a deployment.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#CreateDeploymentResponse": { + "type": "structure", + "members": { + "AutoDeployed": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether a deployment was automatically released.

", + "smithy.api#jsonName": "autoDeployed" + } + }, + "CreatedDate": { + "target": "com.amazonaws.apigatewayv2#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

The date and time when the Deployment resource was created.

", + "smithy.api#jsonName": "createdDate" + } + }, + "DeploymentId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The identifier for the deployment.

", + "smithy.api#jsonName": "deploymentId" + } + }, + "DeploymentStatus": { + "target": "com.amazonaws.apigatewayv2#DeploymentStatus", + "traits": { + "smithy.api#documentation": "

The status of the deployment: PENDING, FAILED, or SUCCEEDED.

", + "smithy.api#jsonName": "deploymentStatus" + } + }, + "DeploymentStatusMessage": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

May contain additional feedback on the status of an API deployment.

", + "smithy.api#jsonName": "deploymentStatusMessage" + } + }, + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

The description for the deployment.

", + "smithy.api#jsonName": "description" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#CreateDomainName": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#CreateDomainNameRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#CreateDomainNameResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#AccessDeniedException" + }, + { + "target": "com.amazonaws.apigatewayv2#BadRequestException" + }, + { + "target": "com.amazonaws.apigatewayv2#ConflictException" + }, + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a domain name.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v2/domainnames", + "code": 201 + } + } + }, + "com.amazonaws.apigatewayv2#CreateDomainNameRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And512", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The domain name.

", + "smithy.api#jsonName": "domainName", + "smithy.api#required": {} + } + }, + "DomainNameConfigurations": { + "target": "com.amazonaws.apigatewayv2#DomainNameConfigurations", + "traits": { + "smithy.api#documentation": "

The domain name configurations.

", + "smithy.api#jsonName": "domainNameConfigurations" + } + }, + "MutualTlsAuthentication": { + "target": "com.amazonaws.apigatewayv2#MutualTlsAuthenticationInput", + "traits": { + "smithy.api#documentation": "

The mutual TLS authentication configuration for a custom domain name.

", + "smithy.api#jsonName": "mutualTlsAuthentication" + } + }, + "Tags": { + "target": "com.amazonaws.apigatewayv2#Tags", + "traits": { + "smithy.api#documentation": "

The collection of tags associated with a domain name.

", + "smithy.api#jsonName": "tags" + } + } + }, + "traits": { + "smithy.api#documentation": "

Creates a new DomainName resource to represent a domain name.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#CreateDomainNameResponse": { + "type": "structure", + "members": { + "ApiMappingSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

The API mapping selection expression.

", + "smithy.api#jsonName": "apiMappingSelectionExpression" + } + }, + "DomainName": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And512", + "traits": { + "smithy.api#documentation": "

The name of the DomainName resource.

", + "smithy.api#jsonName": "domainName" + } + }, + "DomainNameConfigurations": { + "target": "com.amazonaws.apigatewayv2#DomainNameConfigurations", + "traits": { + "smithy.api#documentation": "

The domain name configurations.

", + "smithy.api#jsonName": "domainNameConfigurations" + } + }, + "MutualTlsAuthentication": { + "target": "com.amazonaws.apigatewayv2#MutualTlsAuthentication", + "traits": { + "smithy.api#documentation": "

The mutual TLS authentication configuration for a custom domain name.

", + "smithy.api#jsonName": "mutualTlsAuthentication" + } + }, + "Tags": { + "target": "com.amazonaws.apigatewayv2#Tags", + "traits": { + "smithy.api#documentation": "

The collection of tags associated with a domain name.

", + "smithy.api#jsonName": "tags" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#CreateIntegration": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#CreateIntegrationRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#CreateIntegrationResult" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#BadRequestException" + }, + { + "target": "com.amazonaws.apigatewayv2#ConflictException" + }, + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an Integration.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v2/apis/{ApiId}/integrations", + "code": 201 + } + } + }, + "com.amazonaws.apigatewayv2#CreateIntegrationRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ConnectionId": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And1024", + "traits": { + "smithy.api#documentation": "

The ID of the VPC link for a private integration. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "connectionId" + } + }, + "ConnectionType": { + "target": "com.amazonaws.apigatewayv2#ConnectionType", + "traits": { + "smithy.api#documentation": "

The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.

", + "smithy.api#jsonName": "connectionType" + } + }, + "ContentHandlingStrategy": { + "target": "com.amazonaws.apigatewayv2#ContentHandlingStrategy", + "traits": { + "smithy.api#documentation": "

Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

", + "smithy.api#jsonName": "contentHandlingStrategy" + } + }, + "CredentialsArn": { + "target": "com.amazonaws.apigatewayv2#Arn", + "traits": { + "smithy.api#documentation": "

Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.

", + "smithy.api#jsonName": "credentialsArn" + } + }, + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

The description of the integration.

", + "smithy.api#jsonName": "description" + } + }, + "IntegrationMethod": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "traits": { + "smithy.api#documentation": "

Specifies the integration's HTTP method type.

", + "smithy.api#jsonName": "integrationMethod" + } + }, + "IntegrationSubtype": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.

", + "smithy.api#jsonName": "integrationSubtype" + } + }, + "IntegrationType": { + "target": "com.amazonaws.apigatewayv2#IntegrationType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The integration type of an integration. One of the following:

AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.

AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.

HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.

HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY integration.

MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "integrationType", + "smithy.api#required": {} + } + }, + "IntegrationUri": { + "target": "com.amazonaws.apigatewayv2#UriWithLengthBetween1And2048", + "traits": { + "smithy.api#documentation": "

For a Lambda integration, specify the URI of a Lambda function.

For an HTTP integration, specify a fully-qualified URL.

For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.

", + "smithy.api#jsonName": "integrationUri" + } + }, + "PassthroughBehavior": { + "target": "com.amazonaws.apigatewayv2#PassthroughBehavior", + "traits": { + "smithy.api#documentation": "

Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.

WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.

NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.

WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.

", + "smithy.api#jsonName": "passthroughBehavior" + } + }, + "PayloadFormatVersion": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "traits": { + "smithy.api#documentation": "

Specifies the format of the payload sent to an integration. Required for HTTP APIs.

", + "smithy.api#jsonName": "payloadFormatVersion" + } + }, + "RequestParameters": { + "target": "com.amazonaws.apigatewayv2#IntegrationParameters", + "traits": { + "smithy.api#documentation": "

For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name}\n , where \n {location}\n is querystring, path, or header; and \n {name}\n must be a valid and unique method request parameter name.

For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.

For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.

", + "smithy.api#jsonName": "requestParameters" + } + }, + "RequestTemplates": { + "target": "com.amazonaws.apigatewayv2#TemplateMap", + "traits": { + "smithy.api#documentation": "

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "requestTemplates" + } + }, + "ResponseParameters": { + "target": "com.amazonaws.apigatewayv2#ResponseParameters", + "traits": { + "smithy.api#documentation": "

Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.

", + "smithy.api#jsonName": "responseParameters" + } + }, + "TemplateSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

The template selection expression for the integration.

", + "smithy.api#jsonName": "templateSelectionExpression" + } + }, + "TimeoutInMillis": { + "target": "com.amazonaws.apigatewayv2#IntegerWithLengthBetween50And30000", + "traits": { + "smithy.api#documentation": "

Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.

", + "smithy.api#jsonName": "timeoutInMillis" + } + }, + "TlsConfig": { + "target": "com.amazonaws.apigatewayv2#TlsConfigInput", + "traits": { + "smithy.api#documentation": "

The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "tlsConfig" + } + } + }, + "traits": { + "smithy.api#documentation": "

Creates a new Integration resource to represent an integration.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#CreateIntegrationResponse": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#CreateIntegrationResponseRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#CreateIntegrationResponseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#BadRequestException" + }, + { + "target": "com.amazonaws.apigatewayv2#ConflictException" + }, + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an IntegrationResponses.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v2/apis/{ApiId}/integrations/{IntegrationId}/integrationresponses", + "code": 201 + } + } + }, + "com.amazonaws.apigatewayv2#CreateIntegrationResponseRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContentHandlingStrategy": { + "target": "com.amazonaws.apigatewayv2#ContentHandlingStrategy", + "traits": { + "smithy.api#documentation": "

Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

", + "smithy.api#jsonName": "contentHandlingStrategy" + } + }, + "IntegrationId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The integration ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IntegrationResponseKey": { + "target": "com.amazonaws.apigatewayv2#SelectionKey", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The integration response key.

", + "smithy.api#jsonName": "integrationResponseKey", + "smithy.api#required": {} + } + }, + "ResponseParameters": { + "target": "com.amazonaws.apigatewayv2#IntegrationParameters", + "traits": { + "smithy.api#documentation": "

A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where {name} is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where {name} is a valid and unique response header name and {JSON-expression} is a valid JSON expression without the $ prefix.

", + "smithy.api#jsonName": "responseParameters" + } + }, + "ResponseTemplates": { + "target": "com.amazonaws.apigatewayv2#TemplateMap", + "traits": { + "smithy.api#documentation": "

The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

", + "smithy.api#jsonName": "responseTemplates" + } + }, + "TemplateSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

The template selection expression for the integration response. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "templateSelectionExpression" + } + } + }, + "traits": { + "smithy.api#documentation": "

Creates a new IntegrationResponse resource to represent an integration response.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#CreateIntegrationResponseResponse": { + "type": "structure", + "members": { + "ContentHandlingStrategy": { + "target": "com.amazonaws.apigatewayv2#ContentHandlingStrategy", + "traits": { + "smithy.api#documentation": "

Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

", + "smithy.api#jsonName": "contentHandlingStrategy" + } + }, + "IntegrationResponseId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The integration response ID.

", + "smithy.api#jsonName": "integrationResponseId" + } + }, + "IntegrationResponseKey": { + "target": "com.amazonaws.apigatewayv2#SelectionKey", + "traits": { + "smithy.api#documentation": "

The integration response key.

", + "smithy.api#jsonName": "integrationResponseKey" + } + }, + "ResponseParameters": { + "target": "com.amazonaws.apigatewayv2#IntegrationParameters", + "traits": { + "smithy.api#documentation": "

A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

", + "smithy.api#jsonName": "responseParameters" + } + }, + "ResponseTemplates": { + "target": "com.amazonaws.apigatewayv2#TemplateMap", + "traits": { + "smithy.api#documentation": "

The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

", + "smithy.api#jsonName": "responseTemplates" + } + }, + "TemplateSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

The template selection expressions for the integration response.

", + "smithy.api#jsonName": "templateSelectionExpression" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#CreateIntegrationResult": { + "type": "structure", + "members": { + "ApiGatewayManaged": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.

", + "smithy.api#jsonName": "apiGatewayManaged" + } + }, + "ConnectionId": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And1024", + "traits": { + "smithy.api#documentation": "

The ID of the VPC link for a private integration. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "connectionId" + } + }, + "ConnectionType": { + "target": "com.amazonaws.apigatewayv2#ConnectionType", + "traits": { + "smithy.api#documentation": "

The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.

", + "smithy.api#jsonName": "connectionType" + } + }, + "ContentHandlingStrategy": { + "target": "com.amazonaws.apigatewayv2#ContentHandlingStrategy", + "traits": { + "smithy.api#documentation": "

Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

", + "smithy.api#jsonName": "contentHandlingStrategy" + } + }, + "CredentialsArn": { + "target": "com.amazonaws.apigatewayv2#Arn", + "traits": { + "smithy.api#documentation": "

Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.

", + "smithy.api#jsonName": "credentialsArn" + } + }, + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

Represents the description of an integration.

", + "smithy.api#jsonName": "description" + } + }, + "IntegrationId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

Represents the identifier of an integration.

", + "smithy.api#jsonName": "integrationId" + } + }, + "IntegrationMethod": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "traits": { + "smithy.api#documentation": "

Specifies the integration's HTTP method type.

", + "smithy.api#jsonName": "integrationMethod" + } + }, + "IntegrationResponseSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.

", + "smithy.api#jsonName": "integrationResponseSelectionExpression" + } + }, + "IntegrationSubtype": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.

", + "smithy.api#jsonName": "integrationSubtype" + } + }, + "IntegrationType": { + "target": "com.amazonaws.apigatewayv2#IntegrationType", + "traits": { + "smithy.api#documentation": "

The integration type of an integration. One of the following:

AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.

AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.

HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.

HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.

MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "integrationType" + } + }, + "IntegrationUri": { + "target": "com.amazonaws.apigatewayv2#UriWithLengthBetween1And2048", + "traits": { + "smithy.api#documentation": "

For a Lambda integration, specify the URI of a Lambda function.

For an HTTP integration, specify a fully-qualified URL.

For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.

", + "smithy.api#jsonName": "integrationUri" + } + }, + "PassthroughBehavior": { + "target": "com.amazonaws.apigatewayv2#PassthroughBehavior", + "traits": { + "smithy.api#documentation": "

Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.

WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.

NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.

WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.

", + "smithy.api#jsonName": "passthroughBehavior" + } + }, + "PayloadFormatVersion": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "traits": { + "smithy.api#documentation": "

Specifies the format of the payload sent to an integration. Required for HTTP APIs.

", + "smithy.api#jsonName": "payloadFormatVersion" + } + }, + "RequestParameters": { + "target": "com.amazonaws.apigatewayv2#IntegrationParameters", + "traits": { + "smithy.api#documentation": "

For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name}\n , where \n {location}\n is querystring, path, or header; and \n {name}\n must be a valid and unique method request parameter name.

For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.

For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.

", + "smithy.api#jsonName": "requestParameters" + } + }, + "RequestTemplates": { + "target": "com.amazonaws.apigatewayv2#TemplateMap", + "traits": { + "smithy.api#documentation": "

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "requestTemplates" + } + }, + "ResponseParameters": { + "target": "com.amazonaws.apigatewayv2#ResponseParameters", + "traits": { + "smithy.api#documentation": "

Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.

", + "smithy.api#jsonName": "responseParameters" + } + }, + "TemplateSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

The template selection expression for the integration. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "templateSelectionExpression" + } + }, + "TimeoutInMillis": { + "target": "com.amazonaws.apigatewayv2#IntegerWithLengthBetween50And30000", + "traits": { + "smithy.api#documentation": "

Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.

", + "smithy.api#jsonName": "timeoutInMillis" + } + }, + "TlsConfig": { + "target": "com.amazonaws.apigatewayv2#TlsConfig", + "traits": { + "smithy.api#documentation": "

The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "tlsConfig" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#CreateModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#CreateModelRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#CreateModelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#BadRequestException" + }, + { + "target": "com.amazonaws.apigatewayv2#ConflictException" + }, + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a Model for an API.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v2/apis/{ApiId}/models", + "code": 201 + } + } + }, + "com.amazonaws.apigatewayv2#CreateModelRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContentType": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And256", + "traits": { + "smithy.api#documentation": "

The content-type for the model, for example, \"application/json\".

", + "smithy.api#jsonName": "contentType" + } + }, + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

The description of the model.

", + "smithy.api#jsonName": "description" + } + }, + "Name": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the model. Must be alphanumeric.

", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + }, + "Schema": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And32K", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The schema for the model. For application/json models, this should be JSON schema draft 4 model.

", + "smithy.api#jsonName": "schema", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Creates a new Model.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#CreateModelResponse": { + "type": "structure", + "members": { + "ContentType": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And256", + "traits": { + "smithy.api#documentation": "

The content-type for the model, for example, \"application/json\".

", + "smithy.api#jsonName": "contentType" + } + }, + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

The description of the model.

", + "smithy.api#jsonName": "description" + } + }, + "ModelId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The model identifier.

", + "smithy.api#jsonName": "modelId" + } + }, + "Name": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

The name of the model. Must be alphanumeric.

", + "smithy.api#jsonName": "name" + } + }, + "Schema": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And32K", + "traits": { + "smithy.api#documentation": "

The schema for the model. For application/json models, this should be JSON schema draft 4 model.

", + "smithy.api#jsonName": "schema" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#CreateRoute": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#CreateRouteRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#CreateRouteResult" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#BadRequestException" + }, + { + "target": "com.amazonaws.apigatewayv2#ConflictException" + }, + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a Route for an API.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v2/apis/{ApiId}/routes", + "code": 201 + } + } + }, + "com.amazonaws.apigatewayv2#CreateRouteRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ApiKeyRequired": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether an API key is required for the route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "apiKeyRequired" + } + }, + "AuthorizationScopes": { + "target": "com.amazonaws.apigatewayv2#AuthorizationScopes", + "traits": { + "smithy.api#documentation": "

The authorization scopes supported by this route.

", + "smithy.api#jsonName": "authorizationScopes" + } + }, + "AuthorizationType": { + "target": "com.amazonaws.apigatewayv2#AuthorizationType", + "traits": { + "smithy.api#documentation": "

The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.

", + "smithy.api#jsonName": "authorizationType" + } + }, + "AuthorizerId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.

", + "smithy.api#jsonName": "authorizerId" + } + }, + "ModelSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

The model selection expression for the route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "modelSelectionExpression" + } + }, + "OperationName": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "traits": { + "smithy.api#documentation": "

The operation name for the route.

", + "smithy.api#jsonName": "operationName" + } + }, + "RequestModels": { + "target": "com.amazonaws.apigatewayv2#RouteModels", + "traits": { + "smithy.api#documentation": "

The request models for the route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "requestModels" + } + }, + "RequestParameters": { + "target": "com.amazonaws.apigatewayv2#RouteParameters", + "traits": { + "smithy.api#documentation": "

The request parameters for the route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "requestParameters" + } + }, + "RouteKey": { + "target": "com.amazonaws.apigatewayv2#SelectionKey", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The route key for the route.

", + "smithy.api#jsonName": "routeKey", + "smithy.api#required": {} + } + }, + "RouteResponseSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

The route response selection expression for the route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "routeResponseSelectionExpression" + } + }, + "Target": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

The target for the route.

", + "smithy.api#jsonName": "target" + } + } + }, + "traits": { + "smithy.api#documentation": "

Creates a new Route resource to represent a route.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#CreateRouteResponse": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#CreateRouteResponseRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#CreateRouteResponseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#BadRequestException" + }, + { + "target": "com.amazonaws.apigatewayv2#ConflictException" + }, + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a RouteResponse for a Route.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v2/apis/{ApiId}/routes/{RouteId}/routeresponses", + "code": 201 + } + } + }, + "com.amazonaws.apigatewayv2#CreateRouteResponseRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ModelSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

The model selection expression for the route response. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "modelSelectionExpression" + } + }, + "ResponseModels": { + "target": "com.amazonaws.apigatewayv2#RouteModels", + "traits": { + "smithy.api#documentation": "

The response models for the route response.

", + "smithy.api#jsonName": "responseModels" + } + }, + "ResponseParameters": { + "target": "com.amazonaws.apigatewayv2#RouteParameters", + "traits": { + "smithy.api#documentation": "

The route response parameters.

", + "smithy.api#jsonName": "responseParameters" + } + }, + "RouteId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The route ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RouteResponseKey": { + "target": "com.amazonaws.apigatewayv2#SelectionKey", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The route response key.

", + "smithy.api#jsonName": "routeResponseKey", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Creates a new RouteResponse resource to represent a route response.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#CreateRouteResponseResponse": { + "type": "structure", + "members": { + "ModelSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

Represents the model selection expression of a route response. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "modelSelectionExpression" + } + }, + "ResponseModels": { + "target": "com.amazonaws.apigatewayv2#RouteModels", + "traits": { + "smithy.api#documentation": "

Represents the response models of a route response.

", + "smithy.api#jsonName": "responseModels" + } + }, + "ResponseParameters": { + "target": "com.amazonaws.apigatewayv2#RouteParameters", + "traits": { + "smithy.api#documentation": "

Represents the response parameters of a route response.

", + "smithy.api#jsonName": "responseParameters" + } + }, + "RouteResponseId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

Represents the identifier of a route response.

", + "smithy.api#jsonName": "routeResponseId" + } + }, + "RouteResponseKey": { + "target": "com.amazonaws.apigatewayv2#SelectionKey", + "traits": { + "smithy.api#documentation": "

Represents the route response key of a route response.

", + "smithy.api#jsonName": "routeResponseKey" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#CreateRouteResult": { + "type": "structure", + "members": { + "ApiGatewayManaged": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.

", + "smithy.api#jsonName": "apiGatewayManaged" + } + }, + "ApiKeyRequired": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether an API key is required for this route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "apiKeyRequired" + } + }, + "AuthorizationScopes": { + "target": "com.amazonaws.apigatewayv2#AuthorizationScopes", + "traits": { + "smithy.api#documentation": "

A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

", + "smithy.api#jsonName": "authorizationScopes" + } + }, + "AuthorizationType": { + "target": "com.amazonaws.apigatewayv2#AuthorizationType", + "traits": { + "smithy.api#documentation": "

The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.

", + "smithy.api#jsonName": "authorizationType" + } + }, + "AuthorizerId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.

", + "smithy.api#jsonName": "authorizerId" + } + }, + "ModelSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

The model selection expression for the route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "modelSelectionExpression" + } + }, + "OperationName": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "traits": { + "smithy.api#documentation": "

The operation name for the route.

", + "smithy.api#jsonName": "operationName" + } + }, + "RequestModels": { + "target": "com.amazonaws.apigatewayv2#RouteModels", + "traits": { + "smithy.api#documentation": "

The request models for the route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "requestModels" + } + }, + "RequestParameters": { + "target": "com.amazonaws.apigatewayv2#RouteParameters", + "traits": { + "smithy.api#documentation": "

The request parameters for the route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "requestParameters" + } + }, + "RouteId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The route ID.

", + "smithy.api#jsonName": "routeId" + } + }, + "RouteKey": { + "target": "com.amazonaws.apigatewayv2#SelectionKey", + "traits": { + "smithy.api#documentation": "

The route key for the route.

", + "smithy.api#jsonName": "routeKey" + } + }, + "RouteResponseSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

The route response selection expression for the route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "routeResponseSelectionExpression" + } + }, + "Target": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

The target for the route.

", + "smithy.api#jsonName": "target" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#CreateStage": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#CreateStageRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#CreateStageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#BadRequestException" + }, + { + "target": "com.amazonaws.apigatewayv2#ConflictException" + }, + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a Stage for an API.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v2/apis/{ApiId}/stages", + "code": 201 + } + } + }, + "com.amazonaws.apigatewayv2#CreateStageRequest": { + "type": "structure", + "members": { + "AccessLogSettings": { + "target": "com.amazonaws.apigatewayv2#AccessLogSettings", + "traits": { + "smithy.api#documentation": "

Settings for logging access in this stage.

", + "smithy.api#jsonName": "accessLogSettings" + } + }, + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AutoDeploy": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

", + "smithy.api#jsonName": "autoDeploy" + } + }, + "ClientCertificateId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "clientCertificateId" + } + }, + "DefaultRouteSettings": { + "target": "com.amazonaws.apigatewayv2#RouteSettings", + "traits": { + "smithy.api#documentation": "

The default route settings for the stage.

", + "smithy.api#jsonName": "defaultRouteSettings" + } + }, + "DeploymentId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The deployment identifier of the API stage.

", + "smithy.api#jsonName": "deploymentId" + } + }, + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

The description for the API stage.

", + "smithy.api#jsonName": "description" + } + }, + "RouteSettings": { + "target": "com.amazonaws.apigatewayv2#RouteSettingsMap", + "traits": { + "smithy.api#documentation": "

Route settings for the stage, by routeKey.

", + "smithy.api#jsonName": "routeSettings" + } + }, + "StageName": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the stage.

", + "smithy.api#jsonName": "stageName", + "smithy.api#required": {} + } + }, + "StageVariables": { + "target": "com.amazonaws.apigatewayv2#StageVariablesMap", + "traits": { + "smithy.api#documentation": "

A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

", + "smithy.api#jsonName": "stageVariables" + } + }, + "Tags": { + "target": "com.amazonaws.apigatewayv2#Tags", + "traits": { + "smithy.api#documentation": "

The collection of tags. Each tag element is associated with a given resource.

", + "smithy.api#jsonName": "tags" + } + } + }, + "traits": { + "smithy.api#documentation": "

Creates a new Stage resource to represent a stage.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#CreateStageResponse": { + "type": "structure", + "members": { + "AccessLogSettings": { + "target": "com.amazonaws.apigatewayv2#AccessLogSettings", + "traits": { + "smithy.api#documentation": "

Settings for logging access in this stage.

", + "smithy.api#jsonName": "accessLogSettings" + } + }, + "ApiGatewayManaged": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.

", + "smithy.api#jsonName": "apiGatewayManaged" + } + }, + "AutoDeploy": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

", + "smithy.api#jsonName": "autoDeploy" + } + }, + "ClientCertificateId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "clientCertificateId" + } + }, + "CreatedDate": { + "target": "com.amazonaws.apigatewayv2#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

The timestamp when the stage was created.

", + "smithy.api#jsonName": "createdDate" + } + }, + "DefaultRouteSettings": { + "target": "com.amazonaws.apigatewayv2#RouteSettings", + "traits": { + "smithy.api#documentation": "

Default route settings for the stage.

", + "smithy.api#jsonName": "defaultRouteSettings" + } + }, + "DeploymentId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.

", + "smithy.api#jsonName": "deploymentId" + } + }, + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

The description of the stage.

", + "smithy.api#jsonName": "description" + } + }, + "LastDeploymentStatusMessage": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.

", + "smithy.api#jsonName": "lastDeploymentStatusMessage" + } + }, + "LastUpdatedDate": { + "target": "com.amazonaws.apigatewayv2#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

The timestamp when the stage was last updated.

", + "smithy.api#jsonName": "lastUpdatedDate" + } + }, + "RouteSettings": { + "target": "com.amazonaws.apigatewayv2#RouteSettingsMap", + "traits": { + "smithy.api#documentation": "

Route settings for the stage, by routeKey.

", + "smithy.api#jsonName": "routeSettings" + } + }, + "StageName": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

The name of the stage.

", + "smithy.api#jsonName": "stageName" + } + }, + "StageVariables": { + "target": "com.amazonaws.apigatewayv2#StageVariablesMap", + "traits": { + "smithy.api#documentation": "

A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

", + "smithy.api#jsonName": "stageVariables" + } + }, + "Tags": { + "target": "com.amazonaws.apigatewayv2#Tags", + "traits": { + "smithy.api#documentation": "

The collection of tags. Each tag element is associated with a given resource.

", + "smithy.api#jsonName": "tags" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#CreateVpcLink": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#CreateVpcLinkRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#CreateVpcLinkResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#BadRequestException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a VPC link.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v2/vpclinks", + "code": 201 + } + } + }, + "com.amazonaws.apigatewayv2#CreateVpcLinkRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the VPC link.

", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.apigatewayv2#SecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of security group IDs for the VPC link.

", + "smithy.api#jsonName": "securityGroupIds" + } + }, + "SubnetIds": { + "target": "com.amazonaws.apigatewayv2#SubnetIdList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A list of subnet IDs to include in the VPC link.

", + "smithy.api#jsonName": "subnetIds", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.apigatewayv2#Tags", + "traits": { + "smithy.api#documentation": "

A list of tags.

", + "smithy.api#jsonName": "tags" + } + } + }, + "traits": { + "smithy.api#documentation": "

Creates a VPC link

", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#CreateVpcLinkResponse": { + "type": "structure", + "members": { + "CreatedDate": { + "target": "com.amazonaws.apigatewayv2#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

The timestamp when the VPC link was created.

", + "smithy.api#jsonName": "createdDate" + } + }, + "Name": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

The name of the VPC link.

", + "smithy.api#jsonName": "name" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.apigatewayv2#SecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of security group IDs for the VPC link.

", + "smithy.api#jsonName": "securityGroupIds" + } + }, + "SubnetIds": { + "target": "com.amazonaws.apigatewayv2#SubnetIdList", + "traits": { + "smithy.api#documentation": "

A list of subnet IDs to include in the VPC link.

", + "smithy.api#jsonName": "subnetIds" + } + }, + "Tags": { + "target": "com.amazonaws.apigatewayv2#Tags", + "traits": { + "smithy.api#documentation": "

Tags for the VPC link.

", + "smithy.api#jsonName": "tags" + } + }, + "VpcLinkId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The ID of the VPC link.

", + "smithy.api#jsonName": "vpcLinkId" + } + }, + "VpcLinkStatus": { + "target": "com.amazonaws.apigatewayv2#VpcLinkStatus", + "traits": { + "smithy.api#documentation": "

The status of the VPC link.

", + "smithy.api#jsonName": "vpcLinkStatus" + } + }, + "VpcLinkStatusMessage": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

A message summarizing the cause of the status of the VPC link.

", + "smithy.api#jsonName": "vpcLinkStatusMessage" + } + }, + "VpcLinkVersion": { + "target": "com.amazonaws.apigatewayv2#VpcLinkVersion", + "traits": { + "smithy.api#documentation": "

The version of the VPC link.

", + "smithy.api#jsonName": "vpcLinkVersion" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#DeleteAccessLogSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#DeleteAccessLogSettingsRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the AccessLogSettings for a Stage. To disable access logging for a Stage, delete its AccessLogSettings.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/v2/apis/{ApiId}/stages/{StageName}/accesslogsettings", + "code": 204 + } + } + }, + "com.amazonaws.apigatewayv2#DeleteAccessLogSettingsRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "StageName": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#DeleteApi": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#DeleteApiRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an Api resource.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/v2/apis/{ApiId}", + "code": 204 + } + } + }, + "com.amazonaws.apigatewayv2#DeleteApiMapping": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#DeleteApiMappingRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#BadRequestException" + }, + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an API mapping.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/v2/domainnames/{DomainName}/apimappings/{ApiMappingId}", + "code": 204 + } + } + }, + "com.amazonaws.apigatewayv2#DeleteApiMappingRequest": { + "type": "structure", + "members": { + "ApiMappingId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API mapping identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DomainName": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The domain name.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#DeleteApiRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#DeleteAuthorizer": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#DeleteAuthorizerRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an Authorizer.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/v2/apis/{ApiId}/authorizers/{AuthorizerId}", + "code": 204 + } + } + }, + "com.amazonaws.apigatewayv2#DeleteAuthorizerRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AuthorizerId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The authorizer identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#DeleteCorsConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#DeleteCorsConfigurationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a CORS configuration.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/v2/apis/{ApiId}/cors", + "code": 204 + } + } + }, + "com.amazonaws.apigatewayv2#DeleteCorsConfigurationRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#DeleteDeployment": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#DeleteDeploymentRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a Deployment.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/v2/apis/{ApiId}/deployments/{DeploymentId}", + "code": 204 + } + } + }, + "com.amazonaws.apigatewayv2#DeleteDeploymentRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DeploymentId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The deployment ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#DeleteDomainName": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#DeleteDomainNameRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a domain name.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/v2/domainnames/{DomainName}", + "code": 204 + } + } + }, + "com.amazonaws.apigatewayv2#DeleteDomainNameRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The domain name.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#DeleteIntegration": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#DeleteIntegrationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an Integration.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/v2/apis/{ApiId}/integrations/{IntegrationId}", + "code": 204 + } + } + }, + "com.amazonaws.apigatewayv2#DeleteIntegrationRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IntegrationId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The integration ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#DeleteIntegrationResponse": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#DeleteIntegrationResponseRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an IntegrationResponses.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/v2/apis/{ApiId}/integrations/{IntegrationId}/integrationresponses/{IntegrationResponseId}", + "code": 204 + } + } + }, + "com.amazonaws.apigatewayv2#DeleteIntegrationResponseRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IntegrationId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The integration ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IntegrationResponseId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The integration response ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#DeleteModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#DeleteModelRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a Model.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/v2/apis/{ApiId}/models/{ModelId}", + "code": 204 + } + } + }, + "com.amazonaws.apigatewayv2#DeleteModelRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ModelId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The model ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#DeleteRoute": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#DeleteRouteRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a Route.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/v2/apis/{ApiId}/routes/{RouteId}", + "code": 204 + } + } + }, + "com.amazonaws.apigatewayv2#DeleteRouteRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RouteId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The route ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#DeleteRouteRequestParameter": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#DeleteRouteRequestParameterRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a route request parameter. Supported only for WebSocket APIs.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/v2/apis/{ApiId}/routes/{RouteId}/requestparameters/{RequestParameterKey}", + "code": 204 + } + } + }, + "com.amazonaws.apigatewayv2#DeleteRouteRequestParameterRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RequestParameterKey": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The route request parameter key.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RouteId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The route ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#DeleteRouteResponse": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#DeleteRouteResponseRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a RouteResponse.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/v2/apis/{ApiId}/routes/{RouteId}/routeresponses/{RouteResponseId}", + "code": 204 + } + } + }, + "com.amazonaws.apigatewayv2#DeleteRouteResponseRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RouteId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The route ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RouteResponseId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The route response ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#DeleteRouteSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#DeleteRouteSettingsRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the RouteSettings for a stage.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/v2/apis/{ApiId}/stages/{StageName}/routesettings/{RouteKey}", + "code": 204 + } + } + }, + "com.amazonaws.apigatewayv2#DeleteRouteSettingsRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RouteKey": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The route key.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "StageName": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#DeleteStage": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#DeleteStageRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a Stage.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/v2/apis/{ApiId}/stages/{StageName}", + "code": 204 + } + } + }, + "com.amazonaws.apigatewayv2#DeleteStageRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "StageName": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#DeleteVpcLink": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#DeleteVpcLinkRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#DeleteVpcLinkResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a VPC link.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/v2/vpclinks/{VpcLinkId}", + "code": 202 + } + } + }, + "com.amazonaws.apigatewayv2#DeleteVpcLinkRequest": { + "type": "structure", + "members": { + "VpcLinkId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The ID of the VPC link.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#DeleteVpcLinkResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#Deployment": { + "type": "structure", + "members": { + "AutoDeployed": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether a deployment was automatically released.

", + "smithy.api#jsonName": "autoDeployed" + } + }, + "CreatedDate": { + "target": "com.amazonaws.apigatewayv2#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

The date and time when the Deployment resource was created.

", + "smithy.api#jsonName": "createdDate" + } + }, + "DeploymentId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The identifier for the deployment.

", + "smithy.api#jsonName": "deploymentId" + } + }, + "DeploymentStatus": { + "target": "com.amazonaws.apigatewayv2#DeploymentStatus", + "traits": { + "smithy.api#documentation": "

The status of the deployment: PENDING, FAILED, or SUCCEEDED.

", + "smithy.api#jsonName": "deploymentStatus" + } + }, + "DeploymentStatusMessage": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

May contain additional feedback on the status of an API deployment.

", + "smithy.api#jsonName": "deploymentStatusMessage" + } + }, + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

The description for the deployment.

", + "smithy.api#jsonName": "description" + } + } + }, + "traits": { + "smithy.api#documentation": "

An immutable representation of an API that can be called by users. A Deployment must be associated with a Stage for it to be callable over the internet.

" + } + }, + "com.amazonaws.apigatewayv2#DeploymentStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "DEPLOYED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEPLOYED" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a deployment status.

" + } + }, + "com.amazonaws.apigatewayv2#DomainName": { + "type": "structure", + "members": { + "ApiMappingSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

The API mapping selection expression.

", + "smithy.api#jsonName": "apiMappingSelectionExpression" + } + }, + "DomainName": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And512", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the DomainName resource.

", + "smithy.api#jsonName": "domainName", + "smithy.api#required": {} + } + }, + "DomainNameConfigurations": { + "target": "com.amazonaws.apigatewayv2#DomainNameConfigurations", + "traits": { + "smithy.api#documentation": "

The domain name configurations.

", + "smithy.api#jsonName": "domainNameConfigurations" + } + }, + "MutualTlsAuthentication": { + "target": "com.amazonaws.apigatewayv2#MutualTlsAuthentication", + "traits": { + "smithy.api#documentation": "

The mutual TLS authentication configuration for a custom domain name.

", + "smithy.api#jsonName": "mutualTlsAuthentication" + } + }, + "Tags": { + "target": "com.amazonaws.apigatewayv2#Tags", + "traits": { + "smithy.api#documentation": "

The collection of tags associated with a domain name.

", + "smithy.api#jsonName": "tags" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a domain name.

" + } + }, + "com.amazonaws.apigatewayv2#DomainNameConfiguration": { + "type": "structure", + "members": { + "ApiGatewayDomainName": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

A domain name for the API.

", + "smithy.api#jsonName": "apiGatewayDomainName" + } + }, + "CertificateArn": { + "target": "com.amazonaws.apigatewayv2#Arn", + "traits": { + "smithy.api#documentation": "

An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

", + "smithy.api#jsonName": "certificateArn" + } + }, + "CertificateName": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.

", + "smithy.api#jsonName": "certificateName" + } + }, + "CertificateUploadDate": { + "target": "com.amazonaws.apigatewayv2#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

", + "smithy.api#jsonName": "certificateUploadDate" + } + }, + "DomainNameStatus": { + "target": "com.amazonaws.apigatewayv2#DomainNameStatus", + "traits": { + "smithy.api#documentation": "

The status of the domain name migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

", + "smithy.api#jsonName": "domainNameStatus" + } + }, + "DomainNameStatusMessage": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

An optional text message containing detailed information about status of the domain name migration.

", + "smithy.api#jsonName": "domainNameStatusMessage" + } + }, + "EndpointType": { + "target": "com.amazonaws.apigatewayv2#EndpointType", + "traits": { + "smithy.api#documentation": "

The endpoint type.

", + "smithy.api#jsonName": "endpointType" + } + }, + "HostedZoneId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The Amazon Route 53 Hosted Zone ID of the endpoint.

", + "smithy.api#jsonName": "hostedZoneId" + } + }, + "SecurityPolicy": { + "target": "com.amazonaws.apigatewayv2#SecurityPolicy", + "traits": { + "smithy.api#documentation": "

The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.

", + "smithy.api#jsonName": "securityPolicy" + } + }, + "OwnershipVerificationCertificateArn": { + "target": "com.amazonaws.apigatewayv2#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn

", + "smithy.api#jsonName": "ownershipVerificationCertificateArn" + } + } + }, + "traits": { + "smithy.api#documentation": "

The domain name configuration.

" + } + }, + "com.amazonaws.apigatewayv2#DomainNameConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.apigatewayv2#DomainNameConfiguration" + }, + "traits": { + "smithy.api#documentation": "

The domain name configurations.

" + } + }, + "com.amazonaws.apigatewayv2#DomainNameStatus": { + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "PENDING_CERTIFICATE_REIMPORT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_CERTIFICATE_REIMPORT" + } + }, + "PENDING_OWNERSHIP_VERIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_OWNERSHIP_VERIFICATION" + } + } + }, + "traits": { + "smithy.api#documentation": "

The status of the domain name migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

" + } + }, + "com.amazonaws.apigatewayv2#EndpointType": { + "type": "enum", + "members": { + "REGIONAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REGIONAL" + } + }, + "EDGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EDGE" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents an endpoint type.

" + } + }, + "com.amazonaws.apigatewayv2#ExportApi": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#ExportApiRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#ExportApiResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#BadRequestException" + }, + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#http": { + "method": "GET", + "uri": "/v2/apis/{ApiId}/exports/{Specification}", + "code": 200 + } + } + }, + "com.amazonaws.apigatewayv2#ExportApiRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ExportVersion": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is 1.0.

", + "smithy.api#httpQuery": "exportVersion" + } + }, + "IncludeExtensions": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether to include API Gateway extensions in the exported API definition. API Gateway extensions are included by default.

", + "smithy.api#httpQuery": "includeExtensions" + } + }, + "OutputType": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The output type of the exported definition file. Valid values are JSON and YAML.

", + "smithy.api#httpQuery": "outputType", + "smithy.api#required": {} + } + }, + "Specification": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only supported value.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "StageName": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The name of the API stage to export. If you don't specify this property, a representation of the latest API configuration is exported.

", + "smithy.api#httpQuery": "stageName" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#ExportApiResponse": { + "type": "structure", + "members": { + "body": { + "target": "com.amazonaws.apigatewayv2#ExportedApi", + "traits": { + "smithy.api#httpPayload": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#ExportedApi": { + "type": "blob", + "traits": { + "smithy.api#documentation": "

Represents an exported definition of an API in a particular output format, for example, YAML. The API is serialized to the requested specification, for example, OpenAPI 3.0.

" + } + }, + "com.amazonaws.apigatewayv2#GetApi": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#GetApiRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#GetApiResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets an Api resource.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v2/apis/{ApiId}", + "code": 200 + } + } + }, + "com.amazonaws.apigatewayv2#GetApiMapping": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#GetApiMappingRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#GetApiMappingResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#BadRequestException" + }, + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets an API mapping.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v2/domainnames/{DomainName}/apimappings/{ApiMappingId}", + "code": 200 + } + } + }, + "com.amazonaws.apigatewayv2#GetApiMappingRequest": { + "type": "structure", + "members": { + "ApiMappingId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API mapping identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DomainName": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The domain name.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#GetApiMappingResponse": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#jsonName": "apiId" + } + }, + "ApiMappingId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The API mapping identifier.

", + "smithy.api#jsonName": "apiMappingId" + } + }, + "ApiMappingKey": { + "target": "com.amazonaws.apigatewayv2#SelectionKey", + "traits": { + "smithy.api#documentation": "

The API mapping key.

", + "smithy.api#jsonName": "apiMappingKey" + } + }, + "Stage": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

The API stage.

", + "smithy.api#jsonName": "stage" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#GetApiMappings": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#GetApiMappingsRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#GetApiMappingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#BadRequestException" + }, + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets API mappings.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v2/domainnames/{DomainName}/apimappings", + "code": 200 + } + } + }, + "com.amazonaws.apigatewayv2#GetApiMappingsRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The domain name.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The maximum number of elements to be returned for this resource.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The next page of elements from this collection. Not valid for the last element of the collection.

", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#GetApiMappingsResponse": { + "type": "structure", + "members": { + "Items": { + "target": "com.amazonaws.apigatewayv2#__listOfApiMapping", + "traits": { + "smithy.api#documentation": "

The elements from this collection.

", + "smithy.api#jsonName": "items" + } + }, + "NextToken": { + "target": "com.amazonaws.apigatewayv2#NextToken", + "traits": { + "smithy.api#documentation": "

The next page of elements from this collection. Not valid for the last element of the collection.

", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#GetApiRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#GetApiResponse": { + "type": "structure", + "members": { + "ApiEndpoint": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.

", + "smithy.api#jsonName": "apiEndpoint" + } + }, + "ApiGatewayManaged": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.

", + "smithy.api#jsonName": "apiGatewayManaged" + } + }, + "ApiId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The API ID.

", + "smithy.api#jsonName": "apiId" + } + }, + "ApiKeySelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

", + "smithy.api#jsonName": "apiKeySelectionExpression" + } + }, + "CorsConfiguration": { + "target": "com.amazonaws.apigatewayv2#Cors", + "traits": { + "smithy.api#documentation": "

A CORS configuration. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "corsConfiguration" + } + }, + "CreatedDate": { + "target": "com.amazonaws.apigatewayv2#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

The timestamp when the API was created.

", + "smithy.api#jsonName": "createdDate" + } + }, + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

The description of the API.

", + "smithy.api#jsonName": "description" + } + }, + "DisableSchemaValidation": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "disableSchemaValidation" + } + }, + "DisableExecuteApiEndpoint": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

", + "smithy.api#jsonName": "disableExecuteApiEndpoint" + } + }, + "ImportInfo": { + "target": "com.amazonaws.apigatewayv2#__listOf__string", + "traits": { + "smithy.api#documentation": "

The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "importInfo" + } + }, + "Name": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

The name of the API.

", + "smithy.api#jsonName": "name" + } + }, + "ProtocolType": { + "target": "com.amazonaws.apigatewayv2#ProtocolType", + "traits": { + "smithy.api#documentation": "

The API protocol.

", + "smithy.api#jsonName": "protocolType" + } + }, + "RouteSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

", + "smithy.api#jsonName": "routeSelectionExpression" + } + }, + "Tags": { + "target": "com.amazonaws.apigatewayv2#Tags", + "traits": { + "smithy.api#documentation": "

A collection of tags associated with the API.

", + "smithy.api#jsonName": "tags" + } + }, + "Version": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "traits": { + "smithy.api#documentation": "

A version identifier for the API.

", + "smithy.api#jsonName": "version" + } + }, + "Warnings": { + "target": "com.amazonaws.apigatewayv2#__listOf__string", + "traits": { + "smithy.api#documentation": "

The warning messages reported when failonwarnings is turned on during API import.

", + "smithy.api#jsonName": "warnings" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#GetApis": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#GetApisRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#GetApisResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#BadRequestException" + }, + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a collection of Api resources.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v2/apis", + "code": 200 + } + } + }, + "com.amazonaws.apigatewayv2#GetApisRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The maximum number of elements to be returned for this resource.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The next page of elements from this collection. Not valid for the last element of the collection.

", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#GetApisResponse": { + "type": "structure", + "members": { + "Items": { + "target": "com.amazonaws.apigatewayv2#__listOfApi", + "traits": { + "smithy.api#documentation": "

The elements from this collection.

", + "smithy.api#jsonName": "items" + } + }, + "NextToken": { + "target": "com.amazonaws.apigatewayv2#NextToken", + "traits": { + "smithy.api#documentation": "

The next page of elements from this collection. Not valid for the last element of the collection.

", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#GetAuthorizer": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#GetAuthorizerRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#GetAuthorizerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets an Authorizer.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v2/apis/{ApiId}/authorizers/{AuthorizerId}", + "code": 200 + } + } + }, + "com.amazonaws.apigatewayv2#GetAuthorizerRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AuthorizerId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The authorizer identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#GetAuthorizerResponse": { + "type": "structure", + "members": { + "AuthorizerCredentialsArn": { + "target": "com.amazonaws.apigatewayv2#Arn", + "traits": { + "smithy.api#documentation": "

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.

", + "smithy.api#jsonName": "authorizerCredentialsArn" + } + }, + "AuthorizerId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The authorizer identifier.

", + "smithy.api#jsonName": "authorizerId" + } + }, + "AuthorizerPayloadFormatVersion": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "traits": { + "smithy.api#documentation": "

Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

", + "smithy.api#jsonName": "authorizerPayloadFormatVersion" + } + }, + "AuthorizerResultTtlInSeconds": { + "target": "com.amazonaws.apigatewayv2#IntegerWithLengthBetween0And3600", + "traits": { + "smithy.api#documentation": "

The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.

", + "smithy.api#jsonName": "authorizerResultTtlInSeconds" + } + }, + "AuthorizerType": { + "target": "com.amazonaws.apigatewayv2#AuthorizerType", + "traits": { + "smithy.api#documentation": "

The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).

", + "smithy.api#jsonName": "authorizerType" + } + }, + "AuthorizerUri": { + "target": "com.amazonaws.apigatewayv2#UriWithLengthBetween1And2048", + "traits": { + "smithy.api#documentation": "

The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api}\n , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.

", + "smithy.api#jsonName": "authorizerUri" + } + }, + "EnableSimpleResponses": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs

", + "smithy.api#jsonName": "enableSimpleResponses" + } + }, + "IdentitySource": { + "target": "com.amazonaws.apigatewayv2#IdentitySourceList", + "traits": { + "smithy.api#documentation": "

The identity source for which authorization is requested.

For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.

", + "smithy.api#jsonName": "identitySource" + } + }, + "IdentityValidationExpression": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

The validation expression does not apply to the REQUEST authorizer.

", + "smithy.api#jsonName": "identityValidationExpression" + } + }, + "JwtConfiguration": { + "target": "com.amazonaws.apigatewayv2#JWTConfiguration", + "traits": { + "smithy.api#documentation": "

Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "jwtConfiguration" + } + }, + "Name": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

The name of the authorizer.

", + "smithy.api#jsonName": "name" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#GetAuthorizers": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#GetAuthorizersRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#GetAuthorizersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#BadRequestException" + }, + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the Authorizers for an API.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v2/apis/{ApiId}/authorizers", + "code": 200 + } + } + }, + "com.amazonaws.apigatewayv2#GetAuthorizersRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The maximum number of elements to be returned for this resource.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The next page of elements from this collection. Not valid for the last element of the collection.

", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#GetAuthorizersResponse": { + "type": "structure", + "members": { + "Items": { + "target": "com.amazonaws.apigatewayv2#__listOfAuthorizer", + "traits": { + "smithy.api#documentation": "

The elements from this collection.

", + "smithy.api#jsonName": "items" + } + }, + "NextToken": { + "target": "com.amazonaws.apigatewayv2#NextToken", + "traits": { + "smithy.api#documentation": "

The next page of elements from this collection. Not valid for the last element of the collection.

", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#GetDeployment": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#GetDeploymentRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#GetDeploymentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a Deployment.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v2/apis/{ApiId}/deployments/{DeploymentId}", + "code": 200 + } + } + }, + "com.amazonaws.apigatewayv2#GetDeploymentRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DeploymentId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The deployment ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#GetDeploymentResponse": { + "type": "structure", + "members": { + "AutoDeployed": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether a deployment was automatically released.

", + "smithy.api#jsonName": "autoDeployed" + } + }, + "CreatedDate": { + "target": "com.amazonaws.apigatewayv2#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

The date and time when the Deployment resource was created.

", + "smithy.api#jsonName": "createdDate" + } + }, + "DeploymentId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The identifier for the deployment.

", + "smithy.api#jsonName": "deploymentId" + } + }, + "DeploymentStatus": { + "target": "com.amazonaws.apigatewayv2#DeploymentStatus", + "traits": { + "smithy.api#documentation": "

The status of the deployment: PENDING, FAILED, or SUCCEEDED.

", + "smithy.api#jsonName": "deploymentStatus" + } + }, + "DeploymentStatusMessage": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

May contain additional feedback on the status of an API deployment.

", + "smithy.api#jsonName": "deploymentStatusMessage" + } + }, + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

The description for the deployment.

", + "smithy.api#jsonName": "description" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#GetDeployments": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#GetDeploymentsRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#GetDeploymentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#BadRequestException" + }, + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the Deployments for an API.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v2/apis/{ApiId}/deployments", + "code": 200 + } + } + }, + "com.amazonaws.apigatewayv2#GetDeploymentsRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The maximum number of elements to be returned for this resource.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The next page of elements from this collection. Not valid for the last element of the collection.

", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#GetDeploymentsResponse": { + "type": "structure", + "members": { + "Items": { + "target": "com.amazonaws.apigatewayv2#__listOfDeployment", + "traits": { + "smithy.api#documentation": "

The elements from this collection.

", + "smithy.api#jsonName": "items" + } + }, + "NextToken": { + "target": "com.amazonaws.apigatewayv2#NextToken", + "traits": { + "smithy.api#documentation": "

The next page of elements from this collection. Not valid for the last element of the collection.

", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#GetDomainName": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#GetDomainNameRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#GetDomainNameResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a domain name.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v2/domainnames/{DomainName}", + "code": 200 + } + } + }, + "com.amazonaws.apigatewayv2#GetDomainNameRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The domain name.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#GetDomainNameResponse": { + "type": "structure", + "members": { + "ApiMappingSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

The API mapping selection expression.

", + "smithy.api#jsonName": "apiMappingSelectionExpression" + } + }, + "DomainName": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And512", + "traits": { + "smithy.api#documentation": "

The name of the DomainName resource.

", + "smithy.api#jsonName": "domainName" + } + }, + "DomainNameConfigurations": { + "target": "com.amazonaws.apigatewayv2#DomainNameConfigurations", + "traits": { + "smithy.api#documentation": "

The domain name configurations.

", + "smithy.api#jsonName": "domainNameConfigurations" + } + }, + "MutualTlsAuthentication": { + "target": "com.amazonaws.apigatewayv2#MutualTlsAuthentication", + "traits": { + "smithy.api#documentation": "

The mutual TLS authentication configuration for a custom domain name.

", + "smithy.api#jsonName": "mutualTlsAuthentication" + } + }, + "Tags": { + "target": "com.amazonaws.apigatewayv2#Tags", + "traits": { + "smithy.api#documentation": "

The collection of tags associated with a domain name.

", + "smithy.api#jsonName": "tags" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#GetDomainNames": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#GetDomainNamesRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#GetDomainNamesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#BadRequestException" + }, + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the domain names for an AWS account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v2/domainnames", + "code": 200 + } + } + }, + "com.amazonaws.apigatewayv2#GetDomainNamesRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The maximum number of elements to be returned for this resource.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The next page of elements from this collection. Not valid for the last element of the collection.

", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#GetDomainNamesResponse": { + "type": "structure", + "members": { + "Items": { + "target": "com.amazonaws.apigatewayv2#__listOfDomainName", + "traits": { + "smithy.api#documentation": "

The elements from this collection.

", + "smithy.api#jsonName": "items" + } + }, + "NextToken": { + "target": "com.amazonaws.apigatewayv2#NextToken", + "traits": { + "smithy.api#documentation": "

The next page of elements from this collection. Not valid for the last element of the collection.

", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#GetIntegration": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#GetIntegrationRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#GetIntegrationResult" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets an Integration.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v2/apis/{ApiId}/integrations/{IntegrationId}", + "code": 200 + } + } + }, + "com.amazonaws.apigatewayv2#GetIntegrationRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IntegrationId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The integration ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#GetIntegrationResponse": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#GetIntegrationResponseRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#GetIntegrationResponseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets an IntegrationResponses.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v2/apis/{ApiId}/integrations/{IntegrationId}/integrationresponses/{IntegrationResponseId}", + "code": 200 + } + } + }, + "com.amazonaws.apigatewayv2#GetIntegrationResponseRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IntegrationId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The integration ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IntegrationResponseId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The integration response ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#GetIntegrationResponseResponse": { + "type": "structure", + "members": { + "ContentHandlingStrategy": { + "target": "com.amazonaws.apigatewayv2#ContentHandlingStrategy", + "traits": { + "smithy.api#documentation": "

Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

", + "smithy.api#jsonName": "contentHandlingStrategy" + } + }, + "IntegrationResponseId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The integration response ID.

", + "smithy.api#jsonName": "integrationResponseId" + } + }, + "IntegrationResponseKey": { + "target": "com.amazonaws.apigatewayv2#SelectionKey", + "traits": { + "smithy.api#documentation": "

The integration response key.

", + "smithy.api#jsonName": "integrationResponseKey" + } + }, + "ResponseParameters": { + "target": "com.amazonaws.apigatewayv2#IntegrationParameters", + "traits": { + "smithy.api#documentation": "

A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

", + "smithy.api#jsonName": "responseParameters" + } + }, + "ResponseTemplates": { + "target": "com.amazonaws.apigatewayv2#TemplateMap", + "traits": { + "smithy.api#documentation": "

The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

", + "smithy.api#jsonName": "responseTemplates" + } + }, + "TemplateSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

The template selection expressions for the integration response.

", + "smithy.api#jsonName": "templateSelectionExpression" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#GetIntegrationResponses": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#GetIntegrationResponsesRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#GetIntegrationResponsesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#BadRequestException" + }, + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the IntegrationResponses for an Integration.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v2/apis/{ApiId}/integrations/{IntegrationId}/integrationresponses", + "code": 200 + } + } + }, + "com.amazonaws.apigatewayv2#GetIntegrationResponsesRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IntegrationId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The integration ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The maximum number of elements to be returned for this resource.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The next page of elements from this collection. Not valid for the last element of the collection.

", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#GetIntegrationResponsesResponse": { + "type": "structure", + "members": { + "Items": { + "target": "com.amazonaws.apigatewayv2#__listOfIntegrationResponse", + "traits": { + "smithy.api#documentation": "

The elements from this collection.

", + "smithy.api#jsonName": "items" + } + }, + "NextToken": { + "target": "com.amazonaws.apigatewayv2#NextToken", + "traits": { + "smithy.api#documentation": "

The next page of elements from this collection. Not valid for the last element of the collection.

", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#GetIntegrationResult": { + "type": "structure", + "members": { + "ApiGatewayManaged": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.

", + "smithy.api#jsonName": "apiGatewayManaged" + } + }, + "ConnectionId": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And1024", + "traits": { + "smithy.api#documentation": "

The ID of the VPC link for a private integration. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "connectionId" + } + }, + "ConnectionType": { + "target": "com.amazonaws.apigatewayv2#ConnectionType", + "traits": { + "smithy.api#documentation": "

The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.

", + "smithy.api#jsonName": "connectionType" + } + }, + "ContentHandlingStrategy": { + "target": "com.amazonaws.apigatewayv2#ContentHandlingStrategy", + "traits": { + "smithy.api#documentation": "

Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

", + "smithy.api#jsonName": "contentHandlingStrategy" + } + }, + "CredentialsArn": { + "target": "com.amazonaws.apigatewayv2#Arn", + "traits": { + "smithy.api#documentation": "

Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.

", + "smithy.api#jsonName": "credentialsArn" + } + }, + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

Represents the description of an integration.

", + "smithy.api#jsonName": "description" + } + }, + "IntegrationId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

Represents the identifier of an integration.

", + "smithy.api#jsonName": "integrationId" + } + }, + "IntegrationMethod": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "traits": { + "smithy.api#documentation": "

Specifies the integration's HTTP method type.

", + "smithy.api#jsonName": "integrationMethod" + } + }, + "IntegrationResponseSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.

", + "smithy.api#jsonName": "integrationResponseSelectionExpression" + } + }, + "IntegrationSubtype": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.

", + "smithy.api#jsonName": "integrationSubtype" + } + }, + "IntegrationType": { + "target": "com.amazonaws.apigatewayv2#IntegrationType", + "traits": { + "smithy.api#documentation": "

The integration type of an integration. One of the following:

AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.

AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.

HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.

HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.

MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "integrationType" + } + }, + "IntegrationUri": { + "target": "com.amazonaws.apigatewayv2#UriWithLengthBetween1And2048", + "traits": { + "smithy.api#documentation": "

For a Lambda integration, specify the URI of a Lambda function.

For an HTTP integration, specify a fully-qualified URL.

For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.

", + "smithy.api#jsonName": "integrationUri" + } + }, + "PassthroughBehavior": { + "target": "com.amazonaws.apigatewayv2#PassthroughBehavior", + "traits": { + "smithy.api#documentation": "

Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.

WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.

NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.

WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.

", + "smithy.api#jsonName": "passthroughBehavior" + } + }, + "PayloadFormatVersion": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "traits": { + "smithy.api#documentation": "

Specifies the format of the payload sent to an integration. Required for HTTP APIs.

", + "smithy.api#jsonName": "payloadFormatVersion" + } + }, + "RequestParameters": { + "target": "com.amazonaws.apigatewayv2#IntegrationParameters", + "traits": { + "smithy.api#documentation": "

For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name}\n , where \n {location}\n is querystring, path, or header; and \n {name}\n must be a valid and unique method request parameter name.

For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.

For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.

", + "smithy.api#jsonName": "requestParameters" + } + }, + "RequestTemplates": { + "target": "com.amazonaws.apigatewayv2#TemplateMap", + "traits": { + "smithy.api#documentation": "

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "requestTemplates" + } + }, + "ResponseParameters": { + "target": "com.amazonaws.apigatewayv2#ResponseParameters", + "traits": { + "smithy.api#documentation": "

Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.

", + "smithy.api#jsonName": "responseParameters" + } + }, + "TemplateSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

The template selection expression for the integration. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "templateSelectionExpression" + } + }, + "TimeoutInMillis": { + "target": "com.amazonaws.apigatewayv2#IntegerWithLengthBetween50And30000", + "traits": { + "smithy.api#documentation": "

Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.

", + "smithy.api#jsonName": "timeoutInMillis" + } + }, + "TlsConfig": { + "target": "com.amazonaws.apigatewayv2#TlsConfig", + "traits": { + "smithy.api#documentation": "

The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "tlsConfig" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#GetIntegrations": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#GetIntegrationsRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#GetIntegrationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#BadRequestException" + }, + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the Integrations for an API.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v2/apis/{ApiId}/integrations", + "code": 200 + } + } + }, + "com.amazonaws.apigatewayv2#GetIntegrationsRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The maximum number of elements to be returned for this resource.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The next page of elements from this collection. Not valid for the last element of the collection.

", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#GetIntegrationsResponse": { + "type": "structure", + "members": { + "Items": { + "target": "com.amazonaws.apigatewayv2#__listOfIntegration", + "traits": { + "smithy.api#documentation": "

The elements from this collection.

", + "smithy.api#jsonName": "items" + } + }, + "NextToken": { + "target": "com.amazonaws.apigatewayv2#NextToken", + "traits": { + "smithy.api#documentation": "

The next page of elements from this collection. Not valid for the last element of the collection.

", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#GetModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#GetModelRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#GetModelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a Model.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v2/apis/{ApiId}/models/{ModelId}", + "code": 200 + } + } + }, + "com.amazonaws.apigatewayv2#GetModelRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ModelId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The model ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#GetModelResponse": { + "type": "structure", + "members": { + "ContentType": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And256", + "traits": { + "smithy.api#documentation": "

The content-type for the model, for example, \"application/json\".

", + "smithy.api#jsonName": "contentType" + } + }, + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

The description of the model.

", + "smithy.api#jsonName": "description" + } + }, + "ModelId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The model identifier.

", + "smithy.api#jsonName": "modelId" + } + }, + "Name": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

The name of the model. Must be alphanumeric.

", + "smithy.api#jsonName": "name" + } + }, + "Schema": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And32K", + "traits": { + "smithy.api#documentation": "

The schema for the model. For application/json models, this should be JSON schema draft 4 model.

", + "smithy.api#jsonName": "schema" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#GetModelTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#GetModelTemplateRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#GetModelTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a model template.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v2/apis/{ApiId}/models/{ModelId}/template", + "code": 200 + } + } + }, + "com.amazonaws.apigatewayv2#GetModelTemplateRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ModelId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The model ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#GetModelTemplateResponse": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The template value.

", + "smithy.api#jsonName": "value" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#GetModels": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#GetModelsRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#GetModelsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#BadRequestException" + }, + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the Models for an API.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v2/apis/{ApiId}/models", + "code": 200 + } + } + }, + "com.amazonaws.apigatewayv2#GetModelsRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The maximum number of elements to be returned for this resource.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The next page of elements from this collection. Not valid for the last element of the collection.

", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#GetModelsResponse": { + "type": "structure", + "members": { + "Items": { + "target": "com.amazonaws.apigatewayv2#__listOfModel", + "traits": { + "smithy.api#documentation": "

The elements from this collection.

", + "smithy.api#jsonName": "items" + } + }, + "NextToken": { + "target": "com.amazonaws.apigatewayv2#NextToken", + "traits": { + "smithy.api#documentation": "

The next page of elements from this collection. Not valid for the last element of the collection.

", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#GetRoute": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#GetRouteRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#GetRouteResult" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a Route.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v2/apis/{ApiId}/routes/{RouteId}", + "code": 200 + } + } + }, + "com.amazonaws.apigatewayv2#GetRouteRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RouteId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The route ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#GetRouteResponse": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#GetRouteResponseRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#GetRouteResponseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a RouteResponse.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v2/apis/{ApiId}/routes/{RouteId}/routeresponses/{RouteResponseId}", + "code": 200 + } + } + }, + "com.amazonaws.apigatewayv2#GetRouteResponseRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RouteId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The route ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RouteResponseId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The route response ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#GetRouteResponseResponse": { + "type": "structure", + "members": { + "ModelSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

Represents the model selection expression of a route response. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "modelSelectionExpression" + } + }, + "ResponseModels": { + "target": "com.amazonaws.apigatewayv2#RouteModels", + "traits": { + "smithy.api#documentation": "

Represents the response models of a route response.

", + "smithy.api#jsonName": "responseModels" + } + }, + "ResponseParameters": { + "target": "com.amazonaws.apigatewayv2#RouteParameters", + "traits": { + "smithy.api#documentation": "

Represents the response parameters of a route response.

", + "smithy.api#jsonName": "responseParameters" + } + }, + "RouteResponseId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

Represents the identifier of a route response.

", + "smithy.api#jsonName": "routeResponseId" + } + }, + "RouteResponseKey": { + "target": "com.amazonaws.apigatewayv2#SelectionKey", + "traits": { + "smithy.api#documentation": "

Represents the route response key of a route response.

", + "smithy.api#jsonName": "routeResponseKey" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#GetRouteResponses": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#GetRouteResponsesRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#GetRouteResponsesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#BadRequestException" + }, + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the RouteResponses for a Route.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v2/apis/{ApiId}/routes/{RouteId}/routeresponses", + "code": 200 + } + } + }, + "com.amazonaws.apigatewayv2#GetRouteResponsesRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The maximum number of elements to be returned for this resource.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The next page of elements from this collection. Not valid for the last element of the collection.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "RouteId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The route ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#GetRouteResponsesResponse": { + "type": "structure", + "members": { + "Items": { + "target": "com.amazonaws.apigatewayv2#__listOfRouteResponse", + "traits": { + "smithy.api#documentation": "

The elements from this collection.

", + "smithy.api#jsonName": "items" + } + }, + "NextToken": { + "target": "com.amazonaws.apigatewayv2#NextToken", + "traits": { + "smithy.api#documentation": "

The next page of elements from this collection. Not valid for the last element of the collection.

", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#GetRouteResult": { + "type": "structure", + "members": { + "ApiGatewayManaged": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.

", + "smithy.api#jsonName": "apiGatewayManaged" + } + }, + "ApiKeyRequired": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether an API key is required for this route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "apiKeyRequired" + } + }, + "AuthorizationScopes": { + "target": "com.amazonaws.apigatewayv2#AuthorizationScopes", + "traits": { + "smithy.api#documentation": "

A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

", + "smithy.api#jsonName": "authorizationScopes" + } + }, + "AuthorizationType": { + "target": "com.amazonaws.apigatewayv2#AuthorizationType", + "traits": { + "smithy.api#documentation": "

The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.

", + "smithy.api#jsonName": "authorizationType" + } + }, + "AuthorizerId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.

", + "smithy.api#jsonName": "authorizerId" + } + }, + "ModelSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

The model selection expression for the route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "modelSelectionExpression" + } + }, + "OperationName": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "traits": { + "smithy.api#documentation": "

The operation name for the route.

", + "smithy.api#jsonName": "operationName" + } + }, + "RequestModels": { + "target": "com.amazonaws.apigatewayv2#RouteModels", + "traits": { + "smithy.api#documentation": "

The request models for the route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "requestModels" + } + }, + "RequestParameters": { + "target": "com.amazonaws.apigatewayv2#RouteParameters", + "traits": { + "smithy.api#documentation": "

The request parameters for the route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "requestParameters" + } + }, + "RouteId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The route ID.

", + "smithy.api#jsonName": "routeId" + } + }, + "RouteKey": { + "target": "com.amazonaws.apigatewayv2#SelectionKey", + "traits": { + "smithy.api#documentation": "

The route key for the route.

", + "smithy.api#jsonName": "routeKey" + } + }, + "RouteResponseSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

The route response selection expression for the route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "routeResponseSelectionExpression" + } + }, + "Target": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

The target for the route.

", + "smithy.api#jsonName": "target" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#GetRoutes": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#GetRoutesRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#GetRoutesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#BadRequestException" + }, + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the Routes for an API.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v2/apis/{ApiId}/routes", + "code": 200 + } + } + }, + "com.amazonaws.apigatewayv2#GetRoutesRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The maximum number of elements to be returned for this resource.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The next page of elements from this collection. Not valid for the last element of the collection.

", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#GetRoutesResponse": { + "type": "structure", + "members": { + "Items": { + "target": "com.amazonaws.apigatewayv2#__listOfRoute", + "traits": { + "smithy.api#documentation": "

The elements from this collection.

", + "smithy.api#jsonName": "items" + } + }, + "NextToken": { + "target": "com.amazonaws.apigatewayv2#NextToken", + "traits": { + "smithy.api#documentation": "

The next page of elements from this collection. Not valid for the last element of the collection.

", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#GetStage": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#GetStageRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#GetStageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a Stage.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v2/apis/{ApiId}/stages/{StageName}", + "code": 200 + } + } + }, + "com.amazonaws.apigatewayv2#GetStageRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "StageName": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#GetStageResponse": { + "type": "structure", + "members": { + "AccessLogSettings": { + "target": "com.amazonaws.apigatewayv2#AccessLogSettings", + "traits": { + "smithy.api#documentation": "

Settings for logging access in this stage.

", + "smithy.api#jsonName": "accessLogSettings" + } + }, + "ApiGatewayManaged": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.

", + "smithy.api#jsonName": "apiGatewayManaged" + } + }, + "AutoDeploy": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

", + "smithy.api#jsonName": "autoDeploy" + } + }, + "ClientCertificateId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "clientCertificateId" + } + }, + "CreatedDate": { + "target": "com.amazonaws.apigatewayv2#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

The timestamp when the stage was created.

", + "smithy.api#jsonName": "createdDate" + } + }, + "DefaultRouteSettings": { + "target": "com.amazonaws.apigatewayv2#RouteSettings", + "traits": { + "smithy.api#documentation": "

Default route settings for the stage.

", + "smithy.api#jsonName": "defaultRouteSettings" + } + }, + "DeploymentId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.

", + "smithy.api#jsonName": "deploymentId" + } + }, + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

The description of the stage.

", + "smithy.api#jsonName": "description" + } + }, + "LastDeploymentStatusMessage": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.

", + "smithy.api#jsonName": "lastDeploymentStatusMessage" + } + }, + "LastUpdatedDate": { + "target": "com.amazonaws.apigatewayv2#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

The timestamp when the stage was last updated.

", + "smithy.api#jsonName": "lastUpdatedDate" + } + }, + "RouteSettings": { + "target": "com.amazonaws.apigatewayv2#RouteSettingsMap", + "traits": { + "smithy.api#documentation": "

Route settings for the stage, by routeKey.

", + "smithy.api#jsonName": "routeSettings" + } + }, + "StageName": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

The name of the stage.

", + "smithy.api#jsonName": "stageName" + } + }, + "StageVariables": { + "target": "com.amazonaws.apigatewayv2#StageVariablesMap", + "traits": { + "smithy.api#documentation": "

A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

", + "smithy.api#jsonName": "stageVariables" + } + }, + "Tags": { + "target": "com.amazonaws.apigatewayv2#Tags", + "traits": { + "smithy.api#documentation": "

The collection of tags. Each tag element is associated with a given resource.

", + "smithy.api#jsonName": "tags" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#GetStages": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#GetStagesRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#GetStagesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#BadRequestException" + }, + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the Stages for an API.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v2/apis/{ApiId}/stages", + "code": 200 + } + } + }, + "com.amazonaws.apigatewayv2#GetStagesRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The maximum number of elements to be returned for this resource.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The next page of elements from this collection. Not valid for the last element of the collection.

", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#GetStagesResponse": { + "type": "structure", + "members": { + "Items": { + "target": "com.amazonaws.apigatewayv2#__listOfStage", + "traits": { + "smithy.api#documentation": "

The elements from this collection.

", + "smithy.api#jsonName": "items" + } + }, + "NextToken": { + "target": "com.amazonaws.apigatewayv2#NextToken", + "traits": { + "smithy.api#documentation": "

The next page of elements from this collection. Not valid for the last element of the collection.

", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#GetTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#GetTagsRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#GetTagsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#BadRequestException" + }, + { + "target": "com.amazonaws.apigatewayv2#ConflictException" + }, + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a collection of Tag resources.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v2/tags/{ResourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.apigatewayv2#GetTagsRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The resource ARN for the tag.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#GetTagsResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.apigatewayv2#Tags", + "traits": { + "smithy.api#jsonName": "tags" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#GetVpcLink": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#GetVpcLinkRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#GetVpcLinkResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a VPC link.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v2/vpclinks/{VpcLinkId}", + "code": 200 + } + } + }, + "com.amazonaws.apigatewayv2#GetVpcLinkRequest": { + "type": "structure", + "members": { + "VpcLinkId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The ID of the VPC link.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#GetVpcLinkResponse": { + "type": "structure", + "members": { + "CreatedDate": { + "target": "com.amazonaws.apigatewayv2#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

The timestamp when the VPC link was created.

", + "smithy.api#jsonName": "createdDate" + } + }, + "Name": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

The name of the VPC link.

", + "smithy.api#jsonName": "name" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.apigatewayv2#SecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of security group IDs for the VPC link.

", + "smithy.api#jsonName": "securityGroupIds" + } + }, + "SubnetIds": { + "target": "com.amazonaws.apigatewayv2#SubnetIdList", + "traits": { + "smithy.api#documentation": "

A list of subnet IDs to include in the VPC link.

", + "smithy.api#jsonName": "subnetIds" + } + }, + "Tags": { + "target": "com.amazonaws.apigatewayv2#Tags", + "traits": { + "smithy.api#documentation": "

Tags for the VPC link.

", + "smithy.api#jsonName": "tags" + } + }, + "VpcLinkId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The ID of the VPC link.

", + "smithy.api#jsonName": "vpcLinkId" + } + }, + "VpcLinkStatus": { + "target": "com.amazonaws.apigatewayv2#VpcLinkStatus", + "traits": { + "smithy.api#documentation": "

The status of the VPC link.

", + "smithy.api#jsonName": "vpcLinkStatus" + } + }, + "VpcLinkStatusMessage": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

A message summarizing the cause of the status of the VPC link.

", + "smithy.api#jsonName": "vpcLinkStatusMessage" + } + }, + "VpcLinkVersion": { + "target": "com.amazonaws.apigatewayv2#VpcLinkVersion", + "traits": { + "smithy.api#documentation": "

The version of the VPC link.

", + "smithy.api#jsonName": "vpcLinkVersion" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#GetVpcLinks": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#GetVpcLinksRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#GetVpcLinksResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#BadRequestException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a collection of VPC links.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v2/vpclinks", + "code": 200 + } + } + }, + "com.amazonaws.apigatewayv2#GetVpcLinksRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The maximum number of elements to be returned for this resource.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The next page of elements from this collection. Not valid for the last element of the collection.

", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#GetVpcLinksResponse": { + "type": "structure", + "members": { + "Items": { + "target": "com.amazonaws.apigatewayv2#__listOfVpcLink", + "traits": { + "smithy.api#documentation": "

A collection of VPC links.

", + "smithy.api#jsonName": "items" + } + }, + "NextToken": { + "target": "com.amazonaws.apigatewayv2#NextToken", + "traits": { + "smithy.api#documentation": "

The next page of elements from this collection. Not valid for the last element of the collection.

", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#Id": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The identifier.

" + } + }, + "com.amazonaws.apigatewayv2#IdentitySourceList": { + "type": "list", + "member": { + "target": "com.amazonaws.apigatewayv2#__string" + }, + "traits": { + "smithy.api#documentation": "

The identity source for which authorization is requested. For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is $method.request.header.Auth, $method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.

" + } + }, + "com.amazonaws.apigatewayv2#ImportApi": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#ImportApiRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#ImportApiResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#BadRequestException" + }, + { + "target": "com.amazonaws.apigatewayv2#ConflictException" + }, + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Imports an API.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/v2/apis", + "code": 201 + } + } + }, + "com.amazonaws.apigatewayv2#ImportApiRequest": { + "type": "structure", + "members": { + "Basepath": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see Set the OpenAPI basePath Property. Supported only for HTTP APIs.

", + "smithy.api#httpQuery": "basepath" + } + }, + "Body": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The OpenAPI definition. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "body", + "smithy.api#required": {} + } + }, + "FailOnWarnings": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.

", + "smithy.api#httpQuery": "failOnWarnings" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#ImportApiResponse": { + "type": "structure", + "members": { + "ApiEndpoint": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.

", + "smithy.api#jsonName": "apiEndpoint" + } + }, + "ApiGatewayManaged": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.

", + "smithy.api#jsonName": "apiGatewayManaged" + } + }, + "ApiId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The API ID.

", + "smithy.api#jsonName": "apiId" + } + }, + "ApiKeySelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

", + "smithy.api#jsonName": "apiKeySelectionExpression" + } + }, + "CorsConfiguration": { + "target": "com.amazonaws.apigatewayv2#Cors", + "traits": { + "smithy.api#documentation": "

A CORS configuration. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "corsConfiguration" + } + }, + "CreatedDate": { + "target": "com.amazonaws.apigatewayv2#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

The timestamp when the API was created.

", + "smithy.api#jsonName": "createdDate" + } + }, + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

The description of the API.

", + "smithy.api#jsonName": "description" + } + }, + "DisableSchemaValidation": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "disableSchemaValidation" + } + }, + "DisableExecuteApiEndpoint": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

", + "smithy.api#jsonName": "disableExecuteApiEndpoint" + } + }, + "ImportInfo": { + "target": "com.amazonaws.apigatewayv2#__listOf__string", + "traits": { + "smithy.api#documentation": "

The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "importInfo" + } + }, + "Name": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

The name of the API.

", + "smithy.api#jsonName": "name" + } + }, + "ProtocolType": { + "target": "com.amazonaws.apigatewayv2#ProtocolType", + "traits": { + "smithy.api#documentation": "

The API protocol.

", + "smithy.api#jsonName": "protocolType" + } + }, + "RouteSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

", + "smithy.api#jsonName": "routeSelectionExpression" + } + }, + "Tags": { + "target": "com.amazonaws.apigatewayv2#Tags", + "traits": { + "smithy.api#documentation": "

A collection of tags associated with the API.

", + "smithy.api#jsonName": "tags" + } + }, + "Version": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "traits": { + "smithy.api#documentation": "

A version identifier for the API.

", + "smithy.api#jsonName": "version" + } + }, + "Warnings": { + "target": "com.amazonaws.apigatewayv2#__listOf__string", + "traits": { + "smithy.api#documentation": "

The warning messages reported when failonwarnings is turned on during API import.

", + "smithy.api#jsonName": "warnings" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#IntegerWithLengthBetween0And3600": { + "type": "integer", + "traits": { + "smithy.api#documentation": "

An integer with a value between [0-3600].

", + "smithy.api#range": { + "min": 0, + "max": 3600 + } + } + }, + "com.amazonaws.apigatewayv2#IntegerWithLengthBetween50And30000": { + "type": "integer", + "traits": { + "smithy.api#documentation": "

An integer with a value between [50-30000].

", + "smithy.api#range": { + "min": 50, + "max": 30000 + } + } + }, + "com.amazonaws.apigatewayv2#IntegerWithLengthBetweenMinus1And86400": { + "type": "integer", + "traits": { + "smithy.api#documentation": "

An integer with a value between -1 and 86400. Supported only for HTTP APIs.

", + "smithy.api#range": { + "min": -1, + "max": 86400 + } + } + }, + "com.amazonaws.apigatewayv2#Integration": { + "type": "structure", + "members": { + "ApiGatewayManaged": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.

", + "smithy.api#jsonName": "apiGatewayManaged" + } + }, + "ConnectionId": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And1024", + "traits": { + "smithy.api#documentation": "

The ID of the VPC link for a private integration. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "connectionId" + } + }, + "ConnectionType": { + "target": "com.amazonaws.apigatewayv2#ConnectionType", + "traits": { + "smithy.api#documentation": "

The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.

", + "smithy.api#jsonName": "connectionType" + } + }, + "ContentHandlingStrategy": { + "target": "com.amazonaws.apigatewayv2#ContentHandlingStrategy", + "traits": { + "smithy.api#documentation": "

Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

", + "smithy.api#jsonName": "contentHandlingStrategy" + } + }, + "CredentialsArn": { + "target": "com.amazonaws.apigatewayv2#Arn", + "traits": { + "smithy.api#documentation": "

Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.

", + "smithy.api#jsonName": "credentialsArn" + } + }, + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

Represents the description of an integration.

", + "smithy.api#jsonName": "description" + } + }, + "IntegrationId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

Represents the identifier of an integration.

", + "smithy.api#jsonName": "integrationId" + } + }, + "IntegrationMethod": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "traits": { + "smithy.api#documentation": "

Specifies the integration's HTTP method type.

", + "smithy.api#jsonName": "integrationMethod" + } + }, + "IntegrationResponseSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.

", + "smithy.api#jsonName": "integrationResponseSelectionExpression" + } + }, + "IntegrationSubtype": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.

", + "smithy.api#jsonName": "integrationSubtype" + } + }, + "IntegrationType": { + "target": "com.amazonaws.apigatewayv2#IntegrationType", + "traits": { + "smithy.api#documentation": "

The integration type of an integration. One of the following:

AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.

AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.

HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.

HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.

MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "integrationType" + } + }, + "IntegrationUri": { + "target": "com.amazonaws.apigatewayv2#UriWithLengthBetween1And2048", + "traits": { + "smithy.api#documentation": "

For a Lambda integration, specify the URI of a Lambda function.

For an HTTP integration, specify a fully-qualified URL.

For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.

", + "smithy.api#jsonName": "integrationUri" + } + }, + "PassthroughBehavior": { + "target": "com.amazonaws.apigatewayv2#PassthroughBehavior", + "traits": { + "smithy.api#documentation": "

Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.

WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.

NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.

WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.

", + "smithy.api#jsonName": "passthroughBehavior" + } + }, + "PayloadFormatVersion": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "traits": { + "smithy.api#documentation": "

Specifies the format of the payload sent to an integration. Required for HTTP APIs.

", + "smithy.api#jsonName": "payloadFormatVersion" + } + }, + "RequestParameters": { + "target": "com.amazonaws.apigatewayv2#IntegrationParameters", + "traits": { + "smithy.api#documentation": "

For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name}\n , where \n {location}\n is querystring, path, or header; and \n {name}\n must be a valid and unique method request parameter name.

For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.

For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.

", + "smithy.api#jsonName": "requestParameters" + } + }, + "RequestTemplates": { + "target": "com.amazonaws.apigatewayv2#TemplateMap", + "traits": { + "smithy.api#documentation": "

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "requestTemplates" + } + }, + "ResponseParameters": { + "target": "com.amazonaws.apigatewayv2#ResponseParameters", + "traits": { + "smithy.api#documentation": "

Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.

", + "smithy.api#jsonName": "responseParameters" + } + }, + "TemplateSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

The template selection expression for the integration. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "templateSelectionExpression" + } + }, + "TimeoutInMillis": { + "target": "com.amazonaws.apigatewayv2#IntegerWithLengthBetween50And30000", + "traits": { + "smithy.api#documentation": "

Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.

", + "smithy.api#jsonName": "timeoutInMillis" + } + }, + "TlsConfig": { + "target": "com.amazonaws.apigatewayv2#TlsConfig", + "traits": { + "smithy.api#documentation": "

The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "tlsConfig" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents an integration.

" + } + }, + "com.amazonaws.apigatewayv2#IntegrationParameters": { + "type": "map", + "key": { + "target": "com.amazonaws.apigatewayv2#__string" + }, + "value": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And512" + }, + "traits": { + "smithy.api#documentation": "

For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name}\n , where \n {location}\n is querystring, path, or header; and \n {name}\n must be a valid and unique method request parameter name.

For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.

For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.

" + } + }, + "com.amazonaws.apigatewayv2#IntegrationResponse": { + "type": "structure", + "members": { + "ContentHandlingStrategy": { + "target": "com.amazonaws.apigatewayv2#ContentHandlingStrategy", + "traits": { + "smithy.api#documentation": "

Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

", + "smithy.api#jsonName": "contentHandlingStrategy" + } + }, + "IntegrationResponseId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The integration response ID.

", + "smithy.api#jsonName": "integrationResponseId" + } + }, + "IntegrationResponseKey": { + "target": "com.amazonaws.apigatewayv2#SelectionKey", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The integration response key.

", + "smithy.api#jsonName": "integrationResponseKey", + "smithy.api#required": {} + } + }, + "ResponseParameters": { + "target": "com.amazonaws.apigatewayv2#IntegrationParameters", + "traits": { + "smithy.api#documentation": "

A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

", + "smithy.api#jsonName": "responseParameters" + } + }, + "ResponseTemplates": { + "target": "com.amazonaws.apigatewayv2#TemplateMap", + "traits": { + "smithy.api#documentation": "

The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

", + "smithy.api#jsonName": "responseTemplates" + } + }, + "TemplateSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

The template selection expressions for the integration response.

", + "smithy.api#jsonName": "templateSelectionExpression" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents an integration response.

" + } + }, + "com.amazonaws.apigatewayv2#IntegrationType": { + "type": "enum", + "members": { + "AWS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS" + } + }, + "HTTP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTP" + } + }, + "MOCK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MOCK" + } + }, + "HTTP_PROXY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTP_PROXY" + } + }, + "AWS_PROXY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_PROXY" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents an API method integration type.

" + } + }, + "com.amazonaws.apigatewayv2#JWTConfiguration": { + "type": "structure", + "members": { + "Audience": { + "target": "com.amazonaws.apigatewayv2#__listOf__string", + "traits": { + "smithy.api#documentation": "

A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list. See RFC 7519. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "audience" + } + }, + "Issuer": { + "target": "com.amazonaws.apigatewayv2#UriWithLengthBetween1And2048", + "traits": { + "smithy.api#documentation": "

The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: https://cognito-idp.{region}.amazonaws.com/{userPoolId}\n . Required for the JWT authorizer type. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "issuer" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

" + } + }, + "com.amazonaws.apigatewayv2#LoggingLevel": { + "type": "enum", + "members": { + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + }, + "INFO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INFO" + } + }, + "OFF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OFF" + } + } + }, + "traits": { + "smithy.api#documentation": "

The logging level.

" + } + }, + "com.amazonaws.apigatewayv2#Model": { + "type": "structure", + "members": { + "ContentType": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And256", + "traits": { + "smithy.api#documentation": "

The content-type for the model, for example, \"application/json\".

", + "smithy.api#jsonName": "contentType" + } + }, + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

The description of the model.

", + "smithy.api#jsonName": "description" + } + }, + "ModelId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The model identifier.

", + "smithy.api#jsonName": "modelId" + } + }, + "Name": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the model. Must be alphanumeric.

", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + }, + "Schema": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And32K", + "traits": { + "smithy.api#documentation": "

The schema for the model. For application/json models, this should be JSON schema draft 4 model.

", + "smithy.api#jsonName": "schema" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a data model for an API. Supported only for WebSocket APIs. See Create Models and Mapping Templates for Request and Response Mappings.

" + } + }, + "com.amazonaws.apigatewayv2#MutualTlsAuthentication": { + "type": "structure", + "members": { + "TruststoreUri": { + "target": "com.amazonaws.apigatewayv2#UriWithLengthBetween1And2048", + "traits": { + "smithy.api#documentation": "

An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://bucket-name/key-name. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.

", + "smithy.api#jsonName": "truststoreUri" + } + }, + "TruststoreVersion": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "traits": { + "smithy.api#documentation": "

The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.

", + "smithy.api#jsonName": "truststoreVersion" + } + }, + "TruststoreWarnings": { + "target": "com.amazonaws.apigatewayv2#__listOf__string", + "traits": { + "smithy.api#documentation": "

A list of warnings that API Gateway returns while processing your truststore. Invalid certificates produce warnings. Mutual TLS is still enabled, but some clients might not be able to access your API. To resolve warnings, upload a new truststore to S3, and then update you domain name to use the new version.

", + "smithy.api#jsonName": "truststoreWarnings" + } + } + } + }, + "com.amazonaws.apigatewayv2#MutualTlsAuthenticationInput": { + "type": "structure", + "members": { + "TruststoreUri": { + "target": "com.amazonaws.apigatewayv2#UriWithLengthBetween1And2048", + "traits": { + "smithy.api#documentation": "

An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://bucket-name/key-name. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.

", + "smithy.api#jsonName": "truststoreUri" + } + }, + "TruststoreVersion": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "traits": { + "smithy.api#documentation": "

The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.

", + "smithy.api#jsonName": "truststoreVersion" + } + } + } + }, + "com.amazonaws.apigatewayv2#NextToken": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The next page of elements from this collection. Not valid for the last element of the collection.

" + } + }, + "com.amazonaws.apigatewayv2#NotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

Describes the error encountered.

", + "smithy.api#jsonName": "message" + } + }, + "ResourceType": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The resource type.

", + "smithy.api#jsonName": "resourceType" + } + } + }, + "traits": { + "smithy.api#documentation": "

The resource specified in the request was not found. See the message field for more information.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.apigatewayv2#ParameterConstraints": { + "type": "structure", + "members": { + "Required": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Whether or not the parameter is required.

", + "smithy.api#jsonName": "required" + } + } + }, + "traits": { + "smithy.api#documentation": "

Validation constraints imposed on parameters of a request (path, query string, headers).

" + } + }, + "com.amazonaws.apigatewayv2#PassthroughBehavior": { + "type": "enum", + "members": { + "WHEN_NO_MATCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WHEN_NO_MATCH" + } + }, + "NEVER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEVER" + } + }, + "WHEN_NO_TEMPLATES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WHEN_NO_TEMPLATES" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents passthrough behavior for an integration response. Supported only for WebSocket APIs.

" + } + }, + "com.amazonaws.apigatewayv2#ProtocolType": { + "type": "enum", + "members": { + "WEBSOCKET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WEBSOCKET" + } + }, + "HTTP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTP" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a protocol type." + } + }, + "com.amazonaws.apigatewayv2#ReimportApi": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#ReimportApiRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#ReimportApiResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#BadRequestException" + }, + { + "target": "com.amazonaws.apigatewayv2#ConflictException" + }, + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Puts an Api resource.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/v2/apis/{ApiId}", + "code": 201 + } + } + }, + "com.amazonaws.apigatewayv2#ReimportApiRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Basepath": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see Set the OpenAPI basePath Property. Supported only for HTTP APIs.

", + "smithy.api#httpQuery": "basepath" + } + }, + "Body": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The OpenAPI definition. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "body", + "smithy.api#required": {} + } + }, + "FailOnWarnings": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.

", + "smithy.api#httpQuery": "failOnWarnings" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#ReimportApiResponse": { + "type": "structure", + "members": { + "ApiEndpoint": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.

", + "smithy.api#jsonName": "apiEndpoint" + } + }, + "ApiGatewayManaged": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.

", + "smithy.api#jsonName": "apiGatewayManaged" + } + }, + "ApiId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The API ID.

", + "smithy.api#jsonName": "apiId" + } + }, + "ApiKeySelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

", + "smithy.api#jsonName": "apiKeySelectionExpression" + } + }, + "CorsConfiguration": { + "target": "com.amazonaws.apigatewayv2#Cors", + "traits": { + "smithy.api#documentation": "

A CORS configuration. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "corsConfiguration" + } + }, + "CreatedDate": { + "target": "com.amazonaws.apigatewayv2#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

The timestamp when the API was created.

", + "smithy.api#jsonName": "createdDate" + } + }, + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

The description of the API.

", + "smithy.api#jsonName": "description" + } + }, + "DisableSchemaValidation": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "disableSchemaValidation" + } + }, + "DisableExecuteApiEndpoint": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

", + "smithy.api#jsonName": "disableExecuteApiEndpoint" + } + }, + "ImportInfo": { + "target": "com.amazonaws.apigatewayv2#__listOf__string", + "traits": { + "smithy.api#documentation": "

The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "importInfo" + } + }, + "Name": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

The name of the API.

", + "smithy.api#jsonName": "name" + } + }, + "ProtocolType": { + "target": "com.amazonaws.apigatewayv2#ProtocolType", + "traits": { + "smithy.api#documentation": "

The API protocol.

", + "smithy.api#jsonName": "protocolType" + } + }, + "RouteSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

", + "smithy.api#jsonName": "routeSelectionExpression" + } + }, + "Tags": { + "target": "com.amazonaws.apigatewayv2#Tags", + "traits": { + "smithy.api#documentation": "

A collection of tags associated with the API.

", + "smithy.api#jsonName": "tags" + } + }, + "Version": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "traits": { + "smithy.api#documentation": "

A version identifier for the API.

", + "smithy.api#jsonName": "version" + } + }, + "Warnings": { + "target": "com.amazonaws.apigatewayv2#__listOf__string", + "traits": { + "smithy.api#documentation": "

The warning messages reported when failonwarnings is turned on during API import.

", + "smithy.api#jsonName": "warnings" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#ResetAuthorizersCache": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#ResetAuthorizersCacheRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Resets all authorizer cache entries on a stage. Supported only for HTTP APIs.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/v2/apis/{ApiId}/stages/{StageName}/cache/authorizers", + "code": 204 + } + } + }, + "com.amazonaws.apigatewayv2#ResetAuthorizersCacheRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "StageName": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default. Maximum length is 128 characters.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#ResponseParameters": { + "type": "map", + "key": { + "target": "com.amazonaws.apigatewayv2#__string" + }, + "value": { + "target": "com.amazonaws.apigatewayv2#IntegrationParameters" + }, + "traits": { + "smithy.api#documentation": "

Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients.

" + } + }, + "com.amazonaws.apigatewayv2#Route": { + "type": "structure", + "members": { + "ApiGatewayManaged": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.

", + "smithy.api#jsonName": "apiGatewayManaged" + } + }, + "ApiKeyRequired": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether an API key is required for this route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "apiKeyRequired" + } + }, + "AuthorizationScopes": { + "target": "com.amazonaws.apigatewayv2#AuthorizationScopes", + "traits": { + "smithy.api#documentation": "

A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

", + "smithy.api#jsonName": "authorizationScopes" + } + }, + "AuthorizationType": { + "target": "com.amazonaws.apigatewayv2#AuthorizationType", + "traits": { + "smithy.api#documentation": "

The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.

", + "smithy.api#jsonName": "authorizationType" + } + }, + "AuthorizerId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.

", + "smithy.api#jsonName": "authorizerId" + } + }, + "ModelSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

The model selection expression for the route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "modelSelectionExpression" + } + }, + "OperationName": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "traits": { + "smithy.api#documentation": "

The operation name for the route.

", + "smithy.api#jsonName": "operationName" + } + }, + "RequestModels": { + "target": "com.amazonaws.apigatewayv2#RouteModels", + "traits": { + "smithy.api#documentation": "

The request models for the route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "requestModels" + } + }, + "RequestParameters": { + "target": "com.amazonaws.apigatewayv2#RouteParameters", + "traits": { + "smithy.api#documentation": "

The request parameters for the route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "requestParameters" + } + }, + "RouteId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The route ID.

", + "smithy.api#jsonName": "routeId" + } + }, + "RouteKey": { + "target": "com.amazonaws.apigatewayv2#SelectionKey", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The route key for the route.

", + "smithy.api#jsonName": "routeKey", + "smithy.api#required": {} + } + }, + "RouteResponseSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

The route response selection expression for the route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "routeResponseSelectionExpression" + } + }, + "Target": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

The target for the route.

", + "smithy.api#jsonName": "target" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a route.

" + } + }, + "com.amazonaws.apigatewayv2#RouteModels": { + "type": "map", + "key": { + "target": "com.amazonaws.apigatewayv2#__string" + }, + "value": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128" + }, + "traits": { + "smithy.api#documentation": "

The route models.

" + } + }, + "com.amazonaws.apigatewayv2#RouteParameters": { + "type": "map", + "key": { + "target": "com.amazonaws.apigatewayv2#__string" + }, + "value": { + "target": "com.amazonaws.apigatewayv2#ParameterConstraints" + }, + "traits": { + "smithy.api#documentation": "

The route parameters.

" + } + }, + "com.amazonaws.apigatewayv2#RouteResponse": { + "type": "structure", + "members": { + "ModelSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

Represents the model selection expression of a route response. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "modelSelectionExpression" + } + }, + "ResponseModels": { + "target": "com.amazonaws.apigatewayv2#RouteModels", + "traits": { + "smithy.api#documentation": "

Represents the response models of a route response.

", + "smithy.api#jsonName": "responseModels" + } + }, + "ResponseParameters": { + "target": "com.amazonaws.apigatewayv2#RouteParameters", + "traits": { + "smithy.api#documentation": "

Represents the response parameters of a route response.

", + "smithy.api#jsonName": "responseParameters" + } + }, + "RouteResponseId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

Represents the identifier of a route response.

", + "smithy.api#jsonName": "routeResponseId" + } + }, + "RouteResponseKey": { + "target": "com.amazonaws.apigatewayv2#SelectionKey", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Represents the route response key of a route response.

", + "smithy.api#jsonName": "routeResponseKey", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a route response.

" + } + }, + "com.amazonaws.apigatewayv2#RouteSettings": { + "type": "structure", + "members": { + "DataTraceEnabled": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether (true) or not (false) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "dataTraceEnabled" + } + }, + "DetailedMetricsEnabled": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether detailed metrics are enabled.

", + "smithy.api#jsonName": "detailedMetricsEnabled" + } + }, + "LoggingLevel": { + "target": "com.amazonaws.apigatewayv2#LoggingLevel", + "traits": { + "smithy.api#documentation": "

Specifies the logging level for this route: INFO, ERROR, or OFF. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "loggingLevel" + } + }, + "ThrottlingBurstLimit": { + "target": "com.amazonaws.apigatewayv2#__integer", + "traits": { + "smithy.api#documentation": "

Specifies the throttling burst limit.

", + "smithy.api#jsonName": "throttlingBurstLimit" + } + }, + "ThrottlingRateLimit": { + "target": "com.amazonaws.apigatewayv2#__double", + "traits": { + "smithy.api#documentation": "

Specifies the throttling rate limit.

", + "smithy.api#jsonName": "throttlingRateLimit" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a collection of route settings.

" + } + }, + "com.amazonaws.apigatewayv2#RouteSettingsMap": { + "type": "map", + "key": { + "target": "com.amazonaws.apigatewayv2#__string" + }, + "value": { + "target": "com.amazonaws.apigatewayv2#RouteSettings" + }, + "traits": { + "smithy.api#documentation": "

The route settings map.

" + } + }, + "com.amazonaws.apigatewayv2#SecurityGroupIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.apigatewayv2#__string" + }, + "traits": { + "smithy.api#documentation": "

A list of security group IDs for the VPC link.

" + } + }, + "com.amazonaws.apigatewayv2#SecurityPolicy": { + "type": "enum", + "members": { + "TLS_1_0": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TLS_1_0" + } + }, + "TLS_1_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TLS_1_2" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.

" + } + }, + "com.amazonaws.apigatewayv2#SelectionExpression": { + "type": "string", + "traits": { + "smithy.api#documentation": "

An expression used to extract information at runtime. See Selection Expressions for more information.

" + } + }, + "com.amazonaws.apigatewayv2#SelectionKey": { + "type": "string", + "traits": { + "smithy.api#documentation": "

After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See Selection Expressions for a list of expressions and each expression's associated selection key type.

" + } + }, + "com.amazonaws.apigatewayv2#Stage": { + "type": "structure", + "members": { + "AccessLogSettings": { + "target": "com.amazonaws.apigatewayv2#AccessLogSettings", + "traits": { + "smithy.api#documentation": "

Settings for logging access in this stage.

", + "smithy.api#jsonName": "accessLogSettings" + } + }, + "ApiGatewayManaged": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.

", + "smithy.api#jsonName": "apiGatewayManaged" + } + }, + "AutoDeploy": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

", + "smithy.api#jsonName": "autoDeploy" + } + }, + "ClientCertificateId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "clientCertificateId" + } + }, + "CreatedDate": { + "target": "com.amazonaws.apigatewayv2#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

The timestamp when the stage was created.

", + "smithy.api#jsonName": "createdDate" + } + }, + "DefaultRouteSettings": { + "target": "com.amazonaws.apigatewayv2#RouteSettings", + "traits": { + "smithy.api#documentation": "

Default route settings for the stage.

", + "smithy.api#jsonName": "defaultRouteSettings" + } + }, + "DeploymentId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.

", + "smithy.api#jsonName": "deploymentId" + } + }, + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

The description of the stage.

", + "smithy.api#jsonName": "description" + } + }, + "LastDeploymentStatusMessage": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.

", + "smithy.api#jsonName": "lastDeploymentStatusMessage" + } + }, + "LastUpdatedDate": { + "target": "com.amazonaws.apigatewayv2#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

The timestamp when the stage was last updated.

", + "smithy.api#jsonName": "lastUpdatedDate" + } + }, + "RouteSettings": { + "target": "com.amazonaws.apigatewayv2#RouteSettingsMap", + "traits": { + "smithy.api#documentation": "

Route settings for the stage, by routeKey.

", + "smithy.api#jsonName": "routeSettings" + } + }, + "StageName": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the stage.

", + "smithy.api#jsonName": "stageName", + "smithy.api#required": {} + } + }, + "StageVariables": { + "target": "com.amazonaws.apigatewayv2#StageVariablesMap", + "traits": { + "smithy.api#documentation": "

A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

", + "smithy.api#jsonName": "stageVariables" + } + }, + "Tags": { + "target": "com.amazonaws.apigatewayv2#Tags", + "traits": { + "smithy.api#documentation": "

The collection of tags. Each tag element is associated with a given resource.

", + "smithy.api#jsonName": "tags" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents an API stage.

" + } + }, + "com.amazonaws.apigatewayv2#StageVariablesMap": { + "type": "map", + "key": { + "target": "com.amazonaws.apigatewayv2#__string" + }, + "value": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And2048" + }, + "traits": { + "smithy.api#documentation": "

The stage variable map.

" + } + }, + "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024": { + "type": "string", + "traits": { + "smithy.api#documentation": "

A string with a length between [0-1024].

" + } + }, + "com.amazonaws.apigatewayv2#StringWithLengthBetween0And2048": { + "type": "string", + "traits": { + "smithy.api#documentation": "

A string with a length between [0-2048].

" + } + }, + "com.amazonaws.apigatewayv2#StringWithLengthBetween0And32K": { + "type": "string", + "traits": { + "smithy.api#documentation": "

A string with a length between [0-32768].

" + } + }, + "com.amazonaws.apigatewayv2#StringWithLengthBetween1And1024": { + "type": "string", + "traits": { + "smithy.api#documentation": "

A string with a length between [1-1024].

" + } + }, + "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128": { + "type": "string", + "traits": { + "smithy.api#documentation": "

A string with a length between [1-128].

" + } + }, + "com.amazonaws.apigatewayv2#StringWithLengthBetween1And1600": { + "type": "string", + "traits": { + "smithy.api#documentation": "

A string with a length between [0-1600].

" + } + }, + "com.amazonaws.apigatewayv2#StringWithLengthBetween1And256": { + "type": "string", + "traits": { + "smithy.api#documentation": "

A string with a length between [1-256].

" + } + }, + "com.amazonaws.apigatewayv2#StringWithLengthBetween1And512": { + "type": "string", + "traits": { + "smithy.api#documentation": "

A string with a length between [1-512].

" + } + }, + "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64": { + "type": "string", + "traits": { + "smithy.api#documentation": "

A string with a length between [1-64].

" + } + }, + "com.amazonaws.apigatewayv2#SubnetIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.apigatewayv2#__string" + }, + "traits": { + "smithy.api#documentation": "

A list of subnet IDs to include in the VPC link.

" + } + }, + "com.amazonaws.apigatewayv2#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#BadRequestException" + }, + { + "target": "com.amazonaws.apigatewayv2#ConflictException" + }, + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new Tag resource to represent a tag.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v2/tags/{ResourceArn}", + "code": 201 + } + } + }, + "com.amazonaws.apigatewayv2#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The resource ARN for the tag.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.apigatewayv2#Tags", + "traits": { + "smithy.api#documentation": "

The collection of tags. Each tag element is associated with a given resource.

", + "smithy.api#jsonName": "tags" + } + } + }, + "traits": { + "smithy.api#documentation": "

Creates a new Tag resource to represent a tag.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#Tags": { + "type": "map", + "key": { + "target": "com.amazonaws.apigatewayv2#__string" + }, + "value": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And1600" + }, + "traits": { + "smithy.api#documentation": "

Represents a collection of tags associated with the resource.

" + } + }, + "com.amazonaws.apigatewayv2#TemplateMap": { + "type": "map", + "key": { + "target": "com.amazonaws.apigatewayv2#__string" + }, + "value": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And32K" + }, + "traits": { + "smithy.api#documentation": "

A mapping of identifier keys to templates. The value is an actual template script. The key is typically a SelectionKey which is chosen based on evaluating a selection expression.

" + } + }, + "com.amazonaws.apigatewayv2#TlsConfig": { + "type": "structure", + "members": { + "ServerNameToVerify": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And512", + "traits": { + "smithy.api#documentation": "

If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.

", + "smithy.api#jsonName": "serverNameToVerify" + } + } + }, + "traits": { + "smithy.api#documentation": "

The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.

" + } + }, + "com.amazonaws.apigatewayv2#TlsConfigInput": { + "type": "structure", + "members": { + "ServerNameToVerify": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And512", + "traits": { + "smithy.api#documentation": "

If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.

", + "smithy.api#jsonName": "serverNameToVerify" + } + } + }, + "traits": { + "smithy.api#documentation": "

The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.

" + } + }, + "com.amazonaws.apigatewayv2#TooManyRequestsException": { + "type": "structure", + "members": { + "LimitType": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The limit type.

", + "smithy.api#jsonName": "limitType" + } + }, + "Message": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

Describes the error encountered.

", + "smithy.api#jsonName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

A limit has been exceeded. See the accompanying error message for details.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.apigatewayv2#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#UntagResourceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#BadRequestException" + }, + { + "target": "com.amazonaws.apigatewayv2#ConflictException" + }, + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a Tag.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/v2/tags/{ResourceArn}", + "code": 204 + } + } + }, + "com.amazonaws.apigatewayv2#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The resource ARN for the tag.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.apigatewayv2#__listOf__string", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Tag keys to delete

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#UpdateApi": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#UpdateApiRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#UpdateApiResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#BadRequestException" + }, + { + "target": "com.amazonaws.apigatewayv2#ConflictException" + }, + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an Api resource.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/v2/apis/{ApiId}", + "code": 200 + } + } + }, + "com.amazonaws.apigatewayv2#UpdateApiMapping": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#UpdateApiMappingRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#UpdateApiMappingResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#BadRequestException" + }, + { + "target": "com.amazonaws.apigatewayv2#ConflictException" + }, + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

The API mapping.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/v2/domainnames/{DomainName}/apimappings/{ApiMappingId}", + "code": 200 + } + } + }, + "com.amazonaws.apigatewayv2#UpdateApiMappingRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#jsonName": "apiId", + "smithy.api#required": {} + } + }, + "ApiMappingId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API mapping identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ApiMappingKey": { + "target": "com.amazonaws.apigatewayv2#SelectionKey", + "traits": { + "smithy.api#documentation": "

The API mapping key.

", + "smithy.api#jsonName": "apiMappingKey" + } + }, + "DomainName": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The domain name.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Stage": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

The API stage.

", + "smithy.api#jsonName": "stage" + } + } + }, + "traits": { + "smithy.api#documentation": "

Updates an ApiMapping.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#UpdateApiMappingResponse": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#jsonName": "apiId" + } + }, + "ApiMappingId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The API mapping identifier.

", + "smithy.api#jsonName": "apiMappingId" + } + }, + "ApiMappingKey": { + "target": "com.amazonaws.apigatewayv2#SelectionKey", + "traits": { + "smithy.api#documentation": "

The API mapping key.

", + "smithy.api#jsonName": "apiMappingKey" + } + }, + "Stage": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

The API stage.

", + "smithy.api#jsonName": "stage" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#UpdateApiRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ApiKeySelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

", + "smithy.api#jsonName": "apiKeySelectionExpression" + } + }, + "CorsConfiguration": { + "target": "com.amazonaws.apigatewayv2#Cors", + "traits": { + "smithy.api#documentation": "

A CORS configuration. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "corsConfiguration" + } + }, + "CredentialsArn": { + "target": "com.amazonaws.apigatewayv2#Arn", + "traits": { + "smithy.api#documentation": "

This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, don't specify this parameter. Currently, this property is not used for HTTP integrations. If provided, this value replaces the credentials associated with the quick create integration. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "credentialsArn" + } + }, + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

The description of the API.

", + "smithy.api#jsonName": "description" + } + }, + "DisableSchemaValidation": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "disableSchemaValidation" + } + }, + "DisableExecuteApiEndpoint": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

", + "smithy.api#jsonName": "disableExecuteApiEndpoint" + } + }, + "Name": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

The name of the API.

", + "smithy.api#jsonName": "name" + } + }, + "RouteKey": { + "target": "com.amazonaws.apigatewayv2#SelectionKey", + "traits": { + "smithy.api#documentation": "

This property is part of quick create. If not specified, the route created using quick create is kept. Otherwise, this value replaces the route key of the quick create route. Additional routes may still be added after the API is updated. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "routeKey" + } + }, + "RouteSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

", + "smithy.api#jsonName": "routeSelectionExpression" + } + }, + "Target": { + "target": "com.amazonaws.apigatewayv2#UriWithLengthBetween1And2048", + "traits": { + "smithy.api#documentation": "

This property is part of quick create. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. The value provided updates the integration URI and integration type. You can update a quick-created target, but you can't remove it from an API. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "target" + } + }, + "Version": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "traits": { + "smithy.api#documentation": "

A version identifier for the API.

", + "smithy.api#jsonName": "version" + } + } + }, + "traits": { + "smithy.api#documentation": "

Updates an Api.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#UpdateApiResponse": { + "type": "structure", + "members": { + "ApiEndpoint": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.

", + "smithy.api#jsonName": "apiEndpoint" + } + }, + "ApiGatewayManaged": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.

", + "smithy.api#jsonName": "apiGatewayManaged" + } + }, + "ApiId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The API ID.

", + "smithy.api#jsonName": "apiId" + } + }, + "ApiKeySelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

", + "smithy.api#jsonName": "apiKeySelectionExpression" + } + }, + "CorsConfiguration": { + "target": "com.amazonaws.apigatewayv2#Cors", + "traits": { + "smithy.api#documentation": "

A CORS configuration. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "corsConfiguration" + } + }, + "CreatedDate": { + "target": "com.amazonaws.apigatewayv2#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

The timestamp when the API was created.

", + "smithy.api#jsonName": "createdDate" + } + }, + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

The description of the API.

", + "smithy.api#jsonName": "description" + } + }, + "DisableSchemaValidation": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "disableSchemaValidation" + } + }, + "DisableExecuteApiEndpoint": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

", + "smithy.api#jsonName": "disableExecuteApiEndpoint" + } + }, + "ImportInfo": { + "target": "com.amazonaws.apigatewayv2#__listOf__string", + "traits": { + "smithy.api#documentation": "

The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "importInfo" + } + }, + "Name": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

The name of the API.

", + "smithy.api#jsonName": "name" + } + }, + "ProtocolType": { + "target": "com.amazonaws.apigatewayv2#ProtocolType", + "traits": { + "smithy.api#documentation": "

The API protocol.

", + "smithy.api#jsonName": "protocolType" + } + }, + "RouteSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

", + "smithy.api#jsonName": "routeSelectionExpression" + } + }, + "Tags": { + "target": "com.amazonaws.apigatewayv2#Tags", + "traits": { + "smithy.api#documentation": "

A collection of tags associated with the API.

", + "smithy.api#jsonName": "tags" + } + }, + "Version": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "traits": { + "smithy.api#documentation": "

A version identifier for the API.

", + "smithy.api#jsonName": "version" + } + }, + "Warnings": { + "target": "com.amazonaws.apigatewayv2#__listOf__string", + "traits": { + "smithy.api#documentation": "

The warning messages reported when failonwarnings is turned on during API import.

", + "smithy.api#jsonName": "warnings" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#UpdateAuthorizer": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#UpdateAuthorizerRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#UpdateAuthorizerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#BadRequestException" + }, + { + "target": "com.amazonaws.apigatewayv2#ConflictException" + }, + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an Authorizer.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/v2/apis/{ApiId}/authorizers/{AuthorizerId}", + "code": 200 + } + } + }, + "com.amazonaws.apigatewayv2#UpdateAuthorizerRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AuthorizerCredentialsArn": { + "target": "com.amazonaws.apigatewayv2#Arn", + "traits": { + "smithy.api#documentation": "

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter.

", + "smithy.api#jsonName": "authorizerCredentialsArn" + } + }, + "AuthorizerId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The authorizer identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AuthorizerPayloadFormatVersion": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "traits": { + "smithy.api#documentation": "

Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

", + "smithy.api#jsonName": "authorizerPayloadFormatVersion" + } + }, + "AuthorizerResultTtlInSeconds": { + "target": "com.amazonaws.apigatewayv2#IntegerWithLengthBetween0And3600", + "traits": { + "smithy.api#documentation": "

The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.

", + "smithy.api#jsonName": "authorizerResultTtlInSeconds" + } + }, + "AuthorizerType": { + "target": "com.amazonaws.apigatewayv2#AuthorizerType", + "traits": { + "smithy.api#documentation": "

The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).

", + "smithy.api#jsonName": "authorizerType" + } + }, + "AuthorizerUri": { + "target": "com.amazonaws.apigatewayv2#UriWithLengthBetween1And2048", + "traits": { + "smithy.api#documentation": "

The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api}\n , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.

", + "smithy.api#jsonName": "authorizerUri" + } + }, + "EnableSimpleResponses": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs

", + "smithy.api#jsonName": "enableSimpleResponses" + } + }, + "IdentitySource": { + "target": "com.amazonaws.apigatewayv2#IdentitySourceList", + "traits": { + "smithy.api#documentation": "

The identity source for which authorization is requested.

For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.

", + "smithy.api#jsonName": "identitySource" + } + }, + "IdentityValidationExpression": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

This parameter is not used.

", + "smithy.api#jsonName": "identityValidationExpression" + } + }, + "JwtConfiguration": { + "target": "com.amazonaws.apigatewayv2#JWTConfiguration", + "traits": { + "smithy.api#documentation": "

Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "jwtConfiguration" + } + }, + "Name": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

The name of the authorizer.

", + "smithy.api#jsonName": "name" + } + } + }, + "traits": { + "smithy.api#documentation": "

Updates an Authorizer.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#UpdateAuthorizerResponse": { + "type": "structure", + "members": { + "AuthorizerCredentialsArn": { + "target": "com.amazonaws.apigatewayv2#Arn", + "traits": { + "smithy.api#documentation": "

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.

", + "smithy.api#jsonName": "authorizerCredentialsArn" + } + }, + "AuthorizerId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The authorizer identifier.

", + "smithy.api#jsonName": "authorizerId" + } + }, + "AuthorizerPayloadFormatVersion": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "traits": { + "smithy.api#documentation": "

Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

", + "smithy.api#jsonName": "authorizerPayloadFormatVersion" + } + }, + "AuthorizerResultTtlInSeconds": { + "target": "com.amazonaws.apigatewayv2#IntegerWithLengthBetween0And3600", + "traits": { + "smithy.api#documentation": "

The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.

", + "smithy.api#jsonName": "authorizerResultTtlInSeconds" + } + }, + "AuthorizerType": { + "target": "com.amazonaws.apigatewayv2#AuthorizerType", + "traits": { + "smithy.api#documentation": "

The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).

", + "smithy.api#jsonName": "authorizerType" + } + }, + "AuthorizerUri": { + "target": "com.amazonaws.apigatewayv2#UriWithLengthBetween1And2048", + "traits": { + "smithy.api#documentation": "

The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api}\n , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.

", + "smithy.api#jsonName": "authorizerUri" + } + }, + "EnableSimpleResponses": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs

", + "smithy.api#jsonName": "enableSimpleResponses" + } + }, + "IdentitySource": { + "target": "com.amazonaws.apigatewayv2#IdentitySourceList", + "traits": { + "smithy.api#documentation": "

The identity source for which authorization is requested.

For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.

", + "smithy.api#jsonName": "identitySource" + } + }, + "IdentityValidationExpression": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

The validation expression does not apply to the REQUEST authorizer.

", + "smithy.api#jsonName": "identityValidationExpression" + } + }, + "JwtConfiguration": { + "target": "com.amazonaws.apigatewayv2#JWTConfiguration", + "traits": { + "smithy.api#documentation": "

Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "jwtConfiguration" + } + }, + "Name": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

The name of the authorizer.

", + "smithy.api#jsonName": "name" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#UpdateDeployment": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#UpdateDeploymentRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#UpdateDeploymentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#BadRequestException" + }, + { + "target": "com.amazonaws.apigatewayv2#ConflictException" + }, + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a Deployment.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/v2/apis/{ApiId}/deployments/{DeploymentId}", + "code": 200 + } + } + }, + "com.amazonaws.apigatewayv2#UpdateDeploymentRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DeploymentId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The deployment ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

The description for the deployment resource.

", + "smithy.api#jsonName": "description" + } + } + }, + "traits": { + "smithy.api#documentation": "

Updates a Deployment.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#UpdateDeploymentResponse": { + "type": "structure", + "members": { + "AutoDeployed": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether a deployment was automatically released.

", + "smithy.api#jsonName": "autoDeployed" + } + }, + "CreatedDate": { + "target": "com.amazonaws.apigatewayv2#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

The date and time when the Deployment resource was created.

", + "smithy.api#jsonName": "createdDate" + } + }, + "DeploymentId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The identifier for the deployment.

", + "smithy.api#jsonName": "deploymentId" + } + }, + "DeploymentStatus": { + "target": "com.amazonaws.apigatewayv2#DeploymentStatus", + "traits": { + "smithy.api#documentation": "

The status of the deployment: PENDING, FAILED, or SUCCEEDED.

", + "smithy.api#jsonName": "deploymentStatus" + } + }, + "DeploymentStatusMessage": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

May contain additional feedback on the status of an API deployment.

", + "smithy.api#jsonName": "deploymentStatusMessage" + } + }, + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

The description for the deployment.

", + "smithy.api#jsonName": "description" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#UpdateDomainName": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#UpdateDomainNameRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#UpdateDomainNameResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#BadRequestException" + }, + { + "target": "com.amazonaws.apigatewayv2#ConflictException" + }, + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a domain name.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/v2/domainnames/{DomainName}", + "code": 200 + } + } + }, + "com.amazonaws.apigatewayv2#UpdateDomainNameRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The domain name.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DomainNameConfigurations": { + "target": "com.amazonaws.apigatewayv2#DomainNameConfigurations", + "traits": { + "smithy.api#documentation": "

The domain name configurations.

", + "smithy.api#jsonName": "domainNameConfigurations" + } + }, + "MutualTlsAuthentication": { + "target": "com.amazonaws.apigatewayv2#MutualTlsAuthenticationInput", + "traits": { + "smithy.api#documentation": "

The mutual TLS authentication configuration for a custom domain name.

", + "smithy.api#jsonName": "mutualTlsAuthentication" + } + } + }, + "traits": { + "smithy.api#documentation": "

Updates a DomainName.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#UpdateDomainNameResponse": { + "type": "structure", + "members": { + "ApiMappingSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

The API mapping selection expression.

", + "smithy.api#jsonName": "apiMappingSelectionExpression" + } + }, + "DomainName": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And512", + "traits": { + "smithy.api#documentation": "

The name of the DomainName resource.

", + "smithy.api#jsonName": "domainName" + } + }, + "DomainNameConfigurations": { + "target": "com.amazonaws.apigatewayv2#DomainNameConfigurations", + "traits": { + "smithy.api#documentation": "

The domain name configurations.

", + "smithy.api#jsonName": "domainNameConfigurations" + } + }, + "MutualTlsAuthentication": { + "target": "com.amazonaws.apigatewayv2#MutualTlsAuthentication", + "traits": { + "smithy.api#documentation": "

The mutual TLS authentication configuration for a custom domain name.

", + "smithy.api#jsonName": "mutualTlsAuthentication" + } + }, + "Tags": { + "target": "com.amazonaws.apigatewayv2#Tags", + "traits": { + "smithy.api#documentation": "

The collection of tags associated with a domain name.

", + "smithy.api#jsonName": "tags" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#UpdateIntegration": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#UpdateIntegrationRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#UpdateIntegrationResult" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#BadRequestException" + }, + { + "target": "com.amazonaws.apigatewayv2#ConflictException" + }, + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an Integration.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/v2/apis/{ApiId}/integrations/{IntegrationId}", + "code": 200 + } + } + }, + "com.amazonaws.apigatewayv2#UpdateIntegrationRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ConnectionId": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And1024", + "traits": { + "smithy.api#documentation": "

The ID of the VPC link for a private integration. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "connectionId" + } + }, + "ConnectionType": { + "target": "com.amazonaws.apigatewayv2#ConnectionType", + "traits": { + "smithy.api#documentation": "

The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.

", + "smithy.api#jsonName": "connectionType" + } + }, + "ContentHandlingStrategy": { + "target": "com.amazonaws.apigatewayv2#ContentHandlingStrategy", + "traits": { + "smithy.api#documentation": "

Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

", + "smithy.api#jsonName": "contentHandlingStrategy" + } + }, + "CredentialsArn": { + "target": "com.amazonaws.apigatewayv2#Arn", + "traits": { + "smithy.api#documentation": "

Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.

", + "smithy.api#jsonName": "credentialsArn" + } + }, + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

The description of the integration

", + "smithy.api#jsonName": "description" + } + }, + "IntegrationId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The integration ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IntegrationMethod": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "traits": { + "smithy.api#documentation": "

Specifies the integration's HTTP method type.

", + "smithy.api#jsonName": "integrationMethod" + } + }, + "IntegrationSubtype": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.

", + "smithy.api#jsonName": "integrationSubtype" + } + }, + "IntegrationType": { + "target": "com.amazonaws.apigatewayv2#IntegrationType", + "traits": { + "smithy.api#documentation": "

The integration type of an integration. One of the following:

AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.

AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.

HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.

HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY integration.

MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "integrationType" + } + }, + "IntegrationUri": { + "target": "com.amazonaws.apigatewayv2#UriWithLengthBetween1And2048", + "traits": { + "smithy.api#documentation": "

For a Lambda integration, specify the URI of a Lambda function.

For an HTTP integration, specify a fully-qualified URL.

For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.

", + "smithy.api#jsonName": "integrationUri" + } + }, + "PassthroughBehavior": { + "target": "com.amazonaws.apigatewayv2#PassthroughBehavior", + "traits": { + "smithy.api#documentation": "

Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.

WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.

NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.

WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.

", + "smithy.api#jsonName": "passthroughBehavior" + } + }, + "PayloadFormatVersion": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "traits": { + "smithy.api#documentation": "

Specifies the format of the payload sent to an integration. Required for HTTP APIs.

", + "smithy.api#jsonName": "payloadFormatVersion" + } + }, + "RequestParameters": { + "target": "com.amazonaws.apigatewayv2#IntegrationParameters", + "traits": { + "smithy.api#documentation": "

For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name}\n , where \n {location}\n is querystring, path, or header; and \n {name}\n must be a valid and unique method request parameter name.

For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.

For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.

", + "smithy.api#jsonName": "requestParameters" + } + }, + "RequestTemplates": { + "target": "com.amazonaws.apigatewayv2#TemplateMap", + "traits": { + "smithy.api#documentation": "

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "requestTemplates" + } + }, + "ResponseParameters": { + "target": "com.amazonaws.apigatewayv2#ResponseParameters", + "traits": { + "smithy.api#documentation": "

Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.

", + "smithy.api#jsonName": "responseParameters" + } + }, + "TemplateSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

The template selection expression for the integration.

", + "smithy.api#jsonName": "templateSelectionExpression" + } + }, + "TimeoutInMillis": { + "target": "com.amazonaws.apigatewayv2#IntegerWithLengthBetween50And30000", + "traits": { + "smithy.api#documentation": "

Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.

", + "smithy.api#jsonName": "timeoutInMillis" + } + }, + "TlsConfig": { + "target": "com.amazonaws.apigatewayv2#TlsConfigInput", + "traits": { + "smithy.api#documentation": "

The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "tlsConfig" + } + } + }, + "traits": { + "smithy.api#documentation": "

Updates an Integration.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#UpdateIntegrationResponse": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#UpdateIntegrationResponseRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#UpdateIntegrationResponseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#BadRequestException" + }, + { + "target": "com.amazonaws.apigatewayv2#ConflictException" + }, + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an IntegrationResponses.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/v2/apis/{ApiId}/integrations/{IntegrationId}/integrationresponses/{IntegrationResponseId}", + "code": 200 + } + } + }, + "com.amazonaws.apigatewayv2#UpdateIntegrationResponseRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContentHandlingStrategy": { + "target": "com.amazonaws.apigatewayv2#ContentHandlingStrategy", + "traits": { + "smithy.api#documentation": "

Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

", + "smithy.api#jsonName": "contentHandlingStrategy" + } + }, + "IntegrationId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The integration ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IntegrationResponseId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The integration response ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IntegrationResponseKey": { + "target": "com.amazonaws.apigatewayv2#SelectionKey", + "traits": { + "smithy.api#documentation": "

The integration response key.

", + "smithy.api#jsonName": "integrationResponseKey" + } + }, + "ResponseParameters": { + "target": "com.amazonaws.apigatewayv2#IntegrationParameters", + "traits": { + "smithy.api#documentation": "

A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}\n , where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name}\n or integration.response.body.{JSON-expression}\n , where \n {name}\n is a valid and unique response header name and \n {JSON-expression}\n is a valid JSON expression without the $ prefix.

", + "smithy.api#jsonName": "responseParameters" + } + }, + "ResponseTemplates": { + "target": "com.amazonaws.apigatewayv2#TemplateMap", + "traits": { + "smithy.api#documentation": "

The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

", + "smithy.api#jsonName": "responseTemplates" + } + }, + "TemplateSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

The template selection expression for the integration response. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "templateSelectionExpression" + } + } + }, + "traits": { + "smithy.api#documentation": "

Updates an IntegrationResponses.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#UpdateIntegrationResponseResponse": { + "type": "structure", + "members": { + "ContentHandlingStrategy": { + "target": "com.amazonaws.apigatewayv2#ContentHandlingStrategy", + "traits": { + "smithy.api#documentation": "

Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

", + "smithy.api#jsonName": "contentHandlingStrategy" + } + }, + "IntegrationResponseId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The integration response ID.

", + "smithy.api#jsonName": "integrationResponseId" + } + }, + "IntegrationResponseKey": { + "target": "com.amazonaws.apigatewayv2#SelectionKey", + "traits": { + "smithy.api#documentation": "

The integration response key.

", + "smithy.api#jsonName": "integrationResponseKey" + } + }, + "ResponseParameters": { + "target": "com.amazonaws.apigatewayv2#IntegrationParameters", + "traits": { + "smithy.api#documentation": "

A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

", + "smithy.api#jsonName": "responseParameters" + } + }, + "ResponseTemplates": { + "target": "com.amazonaws.apigatewayv2#TemplateMap", + "traits": { + "smithy.api#documentation": "

The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

", + "smithy.api#jsonName": "responseTemplates" + } + }, + "TemplateSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

The template selection expressions for the integration response.

", + "smithy.api#jsonName": "templateSelectionExpression" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#UpdateIntegrationResult": { + "type": "structure", + "members": { + "ApiGatewayManaged": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.

", + "smithy.api#jsonName": "apiGatewayManaged" + } + }, + "ConnectionId": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And1024", + "traits": { + "smithy.api#documentation": "

The ID of the VPC link for a private integration. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "connectionId" + } + }, + "ConnectionType": { + "target": "com.amazonaws.apigatewayv2#ConnectionType", + "traits": { + "smithy.api#documentation": "

The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.

", + "smithy.api#jsonName": "connectionType" + } + }, + "ContentHandlingStrategy": { + "target": "com.amazonaws.apigatewayv2#ContentHandlingStrategy", + "traits": { + "smithy.api#documentation": "

Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

", + "smithy.api#jsonName": "contentHandlingStrategy" + } + }, + "CredentialsArn": { + "target": "com.amazonaws.apigatewayv2#Arn", + "traits": { + "smithy.api#documentation": "

Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.

", + "smithy.api#jsonName": "credentialsArn" + } + }, + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

Represents the description of an integration.

", + "smithy.api#jsonName": "description" + } + }, + "IntegrationId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

Represents the identifier of an integration.

", + "smithy.api#jsonName": "integrationId" + } + }, + "IntegrationMethod": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "traits": { + "smithy.api#documentation": "

Specifies the integration's HTTP method type.

", + "smithy.api#jsonName": "integrationMethod" + } + }, + "IntegrationResponseSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.

", + "smithy.api#jsonName": "integrationResponseSelectionExpression" + } + }, + "IntegrationSubtype": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.

", + "smithy.api#jsonName": "integrationSubtype" + } + }, + "IntegrationType": { + "target": "com.amazonaws.apigatewayv2#IntegrationType", + "traits": { + "smithy.api#documentation": "

The integration type of an integration. One of the following:

AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.

AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.

HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.

HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.

MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "integrationType" + } + }, + "IntegrationUri": { + "target": "com.amazonaws.apigatewayv2#UriWithLengthBetween1And2048", + "traits": { + "smithy.api#documentation": "

For a Lambda integration, specify the URI of a Lambda function.

For an HTTP integration, specify a fully-qualified URL.

For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.

", + "smithy.api#jsonName": "integrationUri" + } + }, + "PassthroughBehavior": { + "target": "com.amazonaws.apigatewayv2#PassthroughBehavior", + "traits": { + "smithy.api#documentation": "

Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.

WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.

NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.

WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.

", + "smithy.api#jsonName": "passthroughBehavior" + } + }, + "PayloadFormatVersion": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "traits": { + "smithy.api#documentation": "

Specifies the format of the payload sent to an integration. Required for HTTP APIs.

", + "smithy.api#jsonName": "payloadFormatVersion" + } + }, + "RequestParameters": { + "target": "com.amazonaws.apigatewayv2#IntegrationParameters", + "traits": { + "smithy.api#documentation": "

For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name}\n , where \n {location}\n is querystring, path, or header; and \n {name}\n must be a valid and unique method request parameter name.

For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.

For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.

", + "smithy.api#jsonName": "requestParameters" + } + }, + "RequestTemplates": { + "target": "com.amazonaws.apigatewayv2#TemplateMap", + "traits": { + "smithy.api#documentation": "

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "requestTemplates" + } + }, + "ResponseParameters": { + "target": "com.amazonaws.apigatewayv2#ResponseParameters", + "traits": { + "smithy.api#documentation": "

Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.

", + "smithy.api#jsonName": "responseParameters" + } + }, + "TemplateSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

The template selection expression for the integration. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "templateSelectionExpression" + } + }, + "TimeoutInMillis": { + "target": "com.amazonaws.apigatewayv2#IntegerWithLengthBetween50And30000", + "traits": { + "smithy.api#documentation": "

Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.

", + "smithy.api#jsonName": "timeoutInMillis" + } + }, + "TlsConfig": { + "target": "com.amazonaws.apigatewayv2#TlsConfig", + "traits": { + "smithy.api#documentation": "

The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "tlsConfig" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#UpdateModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#UpdateModelRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#UpdateModelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#BadRequestException" + }, + { + "target": "com.amazonaws.apigatewayv2#ConflictException" + }, + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a Model.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/v2/apis/{ApiId}/models/{ModelId}", + "code": 200 + } + } + }, + "com.amazonaws.apigatewayv2#UpdateModelRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContentType": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And256", + "traits": { + "smithy.api#documentation": "

The content-type for the model, for example, \"application/json\".

", + "smithy.api#jsonName": "contentType" + } + }, + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

The description of the model.

", + "smithy.api#jsonName": "description" + } + }, + "ModelId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The model ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

The name of the model.

", + "smithy.api#jsonName": "name" + } + }, + "Schema": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And32K", + "traits": { + "smithy.api#documentation": "

The schema for the model. For application/json models, this should be JSON schema draft 4 model.

", + "smithy.api#jsonName": "schema" + } + } + }, + "traits": { + "smithy.api#documentation": "

Updates a Model.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#UpdateModelResponse": { + "type": "structure", + "members": { + "ContentType": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And256", + "traits": { + "smithy.api#documentation": "

The content-type for the model, for example, \"application/json\".

", + "smithy.api#jsonName": "contentType" + } + }, + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

The description of the model.

", + "smithy.api#jsonName": "description" + } + }, + "ModelId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The model identifier.

", + "smithy.api#jsonName": "modelId" + } + }, + "Name": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

The name of the model. Must be alphanumeric.

", + "smithy.api#jsonName": "name" + } + }, + "Schema": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And32K", + "traits": { + "smithy.api#documentation": "

The schema for the model. For application/json models, this should be JSON schema draft 4 model.

", + "smithy.api#jsonName": "schema" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#UpdateRoute": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#UpdateRouteRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#UpdateRouteResult" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#BadRequestException" + }, + { + "target": "com.amazonaws.apigatewayv2#ConflictException" + }, + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a Route.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/v2/apis/{ApiId}/routes/{RouteId}", + "code": 200 + } + } + }, + "com.amazonaws.apigatewayv2#UpdateRouteRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ApiKeyRequired": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether an API key is required for the route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "apiKeyRequired" + } + }, + "AuthorizationScopes": { + "target": "com.amazonaws.apigatewayv2#AuthorizationScopes", + "traits": { + "smithy.api#documentation": "

The authorization scopes supported by this route.

", + "smithy.api#jsonName": "authorizationScopes" + } + }, + "AuthorizationType": { + "target": "com.amazonaws.apigatewayv2#AuthorizationType", + "traits": { + "smithy.api#documentation": "

The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.

", + "smithy.api#jsonName": "authorizationType" + } + }, + "AuthorizerId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.

", + "smithy.api#jsonName": "authorizerId" + } + }, + "ModelSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

The model selection expression for the route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "modelSelectionExpression" + } + }, + "OperationName": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "traits": { + "smithy.api#documentation": "

The operation name for the route.

", + "smithy.api#jsonName": "operationName" + } + }, + "RequestModels": { + "target": "com.amazonaws.apigatewayv2#RouteModels", + "traits": { + "smithy.api#documentation": "

The request models for the route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "requestModels" + } + }, + "RequestParameters": { + "target": "com.amazonaws.apigatewayv2#RouteParameters", + "traits": { + "smithy.api#documentation": "

The request parameters for the route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "requestParameters" + } + }, + "RouteId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The route ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RouteKey": { + "target": "com.amazonaws.apigatewayv2#SelectionKey", + "traits": { + "smithy.api#documentation": "

The route key for the route.

", + "smithy.api#jsonName": "routeKey" + } + }, + "RouteResponseSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

The route response selection expression for the route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "routeResponseSelectionExpression" + } + }, + "Target": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

The target for the route.

", + "smithy.api#jsonName": "target" + } + } + }, + "traits": { + "smithy.api#documentation": "

Updates a Route.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#UpdateRouteResponse": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#UpdateRouteResponseRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#UpdateRouteResponseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#BadRequestException" + }, + { + "target": "com.amazonaws.apigatewayv2#ConflictException" + }, + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a RouteResponse.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/v2/apis/{ApiId}/routes/{RouteId}/routeresponses/{RouteResponseId}", + "code": 200 + } + } + }, + "com.amazonaws.apigatewayv2#UpdateRouteResponseRequest": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ModelSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

The model selection expression for the route response. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "modelSelectionExpression" + } + }, + "ResponseModels": { + "target": "com.amazonaws.apigatewayv2#RouteModels", + "traits": { + "smithy.api#documentation": "

The response models for the route response.

", + "smithy.api#jsonName": "responseModels" + } + }, + "ResponseParameters": { + "target": "com.amazonaws.apigatewayv2#RouteParameters", + "traits": { + "smithy.api#documentation": "

The route response parameters.

", + "smithy.api#jsonName": "responseParameters" + } + }, + "RouteId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The route ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RouteResponseId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The route response ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RouteResponseKey": { + "target": "com.amazonaws.apigatewayv2#SelectionKey", + "traits": { + "smithy.api#documentation": "

The route response key.

", + "smithy.api#jsonName": "routeResponseKey" + } + } + }, + "traits": { + "smithy.api#documentation": "

Updates a RouteResponse.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#UpdateRouteResponseResponse": { + "type": "structure", + "members": { + "ModelSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

Represents the model selection expression of a route response. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "modelSelectionExpression" + } + }, + "ResponseModels": { + "target": "com.amazonaws.apigatewayv2#RouteModels", + "traits": { + "smithy.api#documentation": "

Represents the response models of a route response.

", + "smithy.api#jsonName": "responseModels" + } + }, + "ResponseParameters": { + "target": "com.amazonaws.apigatewayv2#RouteParameters", + "traits": { + "smithy.api#documentation": "

Represents the response parameters of a route response.

", + "smithy.api#jsonName": "responseParameters" + } + }, + "RouteResponseId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

Represents the identifier of a route response.

", + "smithy.api#jsonName": "routeResponseId" + } + }, + "RouteResponseKey": { + "target": "com.amazonaws.apigatewayv2#SelectionKey", + "traits": { + "smithy.api#documentation": "

Represents the route response key of a route response.

", + "smithy.api#jsonName": "routeResponseKey" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#UpdateRouteResult": { + "type": "structure", + "members": { + "ApiGatewayManaged": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.

", + "smithy.api#jsonName": "apiGatewayManaged" + } + }, + "ApiKeyRequired": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether an API key is required for this route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "apiKeyRequired" + } + }, + "AuthorizationScopes": { + "target": "com.amazonaws.apigatewayv2#AuthorizationScopes", + "traits": { + "smithy.api#documentation": "

A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

", + "smithy.api#jsonName": "authorizationScopes" + } + }, + "AuthorizationType": { + "target": "com.amazonaws.apigatewayv2#AuthorizationType", + "traits": { + "smithy.api#documentation": "

The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.

", + "smithy.api#jsonName": "authorizationType" + } + }, + "AuthorizerId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.

", + "smithy.api#jsonName": "authorizerId" + } + }, + "ModelSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

The model selection expression for the route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "modelSelectionExpression" + } + }, + "OperationName": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "traits": { + "smithy.api#documentation": "

The operation name for the route.

", + "smithy.api#jsonName": "operationName" + } + }, + "RequestModels": { + "target": "com.amazonaws.apigatewayv2#RouteModels", + "traits": { + "smithy.api#documentation": "

The request models for the route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "requestModels" + } + }, + "RequestParameters": { + "target": "com.amazonaws.apigatewayv2#RouteParameters", + "traits": { + "smithy.api#documentation": "

The request parameters for the route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "requestParameters" + } + }, + "RouteId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The route ID.

", + "smithy.api#jsonName": "routeId" + } + }, + "RouteKey": { + "target": "com.amazonaws.apigatewayv2#SelectionKey", + "traits": { + "smithy.api#documentation": "

The route key for the route.

", + "smithy.api#jsonName": "routeKey" + } + }, + "RouteResponseSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

The route response selection expression for the route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "routeResponseSelectionExpression" + } + }, + "Target": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

The target for the route.

", + "smithy.api#jsonName": "target" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#UpdateStage": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#UpdateStageRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#UpdateStageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#BadRequestException" + }, + { + "target": "com.amazonaws.apigatewayv2#ConflictException" + }, + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a Stage.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/v2/apis/{ApiId}/stages/{StageName}", + "code": 200 + } + } + }, + "com.amazonaws.apigatewayv2#UpdateStageRequest": { + "type": "structure", + "members": { + "AccessLogSettings": { + "target": "com.amazonaws.apigatewayv2#AccessLogSettings", + "traits": { + "smithy.api#documentation": "

Settings for logging access in this stage.

", + "smithy.api#jsonName": "accessLogSettings" + } + }, + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AutoDeploy": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

", + "smithy.api#jsonName": "autoDeploy" + } + }, + "ClientCertificateId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The identifier of a client certificate for a Stage.

", + "smithy.api#jsonName": "clientCertificateId" + } + }, + "DefaultRouteSettings": { + "target": "com.amazonaws.apigatewayv2#RouteSettings", + "traits": { + "smithy.api#documentation": "

The default route settings for the stage.

", + "smithy.api#jsonName": "defaultRouteSettings" + } + }, + "DeploymentId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled.

", + "smithy.api#jsonName": "deploymentId" + } + }, + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

The description for the API stage.

", + "smithy.api#jsonName": "description" + } + }, + "RouteSettings": { + "target": "com.amazonaws.apigatewayv2#RouteSettingsMap", + "traits": { + "smithy.api#documentation": "

Route settings for the stage.

", + "smithy.api#jsonName": "routeSettings" + } + }, + "StageName": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default. Maximum length is 128 characters.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "StageVariables": { + "target": "com.amazonaws.apigatewayv2#StageVariablesMap", + "traits": { + "smithy.api#documentation": "

A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

", + "smithy.api#jsonName": "stageVariables" + } + } + }, + "traits": { + "smithy.api#documentation": "

Updates a Stage.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#UpdateStageResponse": { + "type": "structure", + "members": { + "AccessLogSettings": { + "target": "com.amazonaws.apigatewayv2#AccessLogSettings", + "traits": { + "smithy.api#documentation": "

Settings for logging access in this stage.

", + "smithy.api#jsonName": "accessLogSettings" + } + }, + "ApiGatewayManaged": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.

", + "smithy.api#jsonName": "apiGatewayManaged" + } + }, + "AutoDeploy": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

", + "smithy.api#jsonName": "autoDeploy" + } + }, + "ClientCertificateId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "clientCertificateId" + } + }, + "CreatedDate": { + "target": "com.amazonaws.apigatewayv2#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

The timestamp when the stage was created.

", + "smithy.api#jsonName": "createdDate" + } + }, + "DefaultRouteSettings": { + "target": "com.amazonaws.apigatewayv2#RouteSettings", + "traits": { + "smithy.api#documentation": "

Default route settings for the stage.

", + "smithy.api#jsonName": "defaultRouteSettings" + } + }, + "DeploymentId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.

", + "smithy.api#jsonName": "deploymentId" + } + }, + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

The description of the stage.

", + "smithy.api#jsonName": "description" + } + }, + "LastDeploymentStatusMessage": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.

", + "smithy.api#jsonName": "lastDeploymentStatusMessage" + } + }, + "LastUpdatedDate": { + "target": "com.amazonaws.apigatewayv2#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

The timestamp when the stage was last updated.

", + "smithy.api#jsonName": "lastUpdatedDate" + } + }, + "RouteSettings": { + "target": "com.amazonaws.apigatewayv2#RouteSettingsMap", + "traits": { + "smithy.api#documentation": "

Route settings for the stage, by routeKey.

", + "smithy.api#jsonName": "routeSettings" + } + }, + "StageName": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

The name of the stage.

", + "smithy.api#jsonName": "stageName" + } + }, + "StageVariables": { + "target": "com.amazonaws.apigatewayv2#StageVariablesMap", + "traits": { + "smithy.api#documentation": "

A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

", + "smithy.api#jsonName": "stageVariables" + } + }, + "Tags": { + "target": "com.amazonaws.apigatewayv2#Tags", + "traits": { + "smithy.api#documentation": "

The collection of tags. Each tag element is associated with a given resource.

", + "smithy.api#jsonName": "tags" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#UpdateVpcLink": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#UpdateVpcLinkRequest" + }, + "output": { + "target": "com.amazonaws.apigatewayv2#UpdateVpcLinkResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#BadRequestException" + }, + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a VPC link.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/v2/vpclinks/{VpcLinkId}", + "code": 200 + } + } + }, + "com.amazonaws.apigatewayv2#UpdateVpcLinkRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

The name of the VPC link.

", + "smithy.api#jsonName": "name" + } + }, + "VpcLinkId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The ID of the VPC link.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Updates a VPC link.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigatewayv2#UpdateVpcLinkResponse": { + "type": "structure", + "members": { + "CreatedDate": { + "target": "com.amazonaws.apigatewayv2#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

The timestamp when the VPC link was created.

", + "smithy.api#jsonName": "createdDate" + } + }, + "Name": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

The name of the VPC link.

", + "smithy.api#jsonName": "name" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.apigatewayv2#SecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of security group IDs for the VPC link.

", + "smithy.api#jsonName": "securityGroupIds" + } + }, + "SubnetIds": { + "target": "com.amazonaws.apigatewayv2#SubnetIdList", + "traits": { + "smithy.api#documentation": "

A list of subnet IDs to include in the VPC link.

", + "smithy.api#jsonName": "subnetIds" + } + }, + "Tags": { + "target": "com.amazonaws.apigatewayv2#Tags", + "traits": { + "smithy.api#documentation": "

Tags for the VPC link.

", + "smithy.api#jsonName": "tags" + } + }, + "VpcLinkId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The ID of the VPC link.

", + "smithy.api#jsonName": "vpcLinkId" + } + }, + "VpcLinkStatus": { + "target": "com.amazonaws.apigatewayv2#VpcLinkStatus", + "traits": { + "smithy.api#documentation": "

The status of the VPC link.

", + "smithy.api#jsonName": "vpcLinkStatus" + } + }, + "VpcLinkStatusMessage": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

A message summarizing the cause of the status of the VPC link.

", + "smithy.api#jsonName": "vpcLinkStatusMessage" + } + }, + "VpcLinkVersion": { + "target": "com.amazonaws.apigatewayv2#VpcLinkVersion", + "traits": { + "smithy.api#documentation": "

The version of the VPC link.

", + "smithy.api#jsonName": "vpcLinkVersion" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.apigatewayv2#UriWithLengthBetween1And2048": { + "type": "string", + "traits": { + "smithy.api#documentation": "

A string representation of a URI with a length between [1-2048].

" + } + }, + "com.amazonaws.apigatewayv2#VpcLink": { + "type": "structure", + "members": { + "CreatedDate": { + "target": "com.amazonaws.apigatewayv2#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

The timestamp when the VPC link was created.

", + "smithy.api#jsonName": "createdDate" + } + }, + "Name": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the VPC link.

", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.apigatewayv2#SecurityGroupIdList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A list of security group IDs for the VPC link.

", + "smithy.api#jsonName": "securityGroupIds", + "smithy.api#required": {} + } + }, + "SubnetIds": { + "target": "com.amazonaws.apigatewayv2#SubnetIdList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A list of subnet IDs to include in the VPC link.

", + "smithy.api#jsonName": "subnetIds", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.apigatewayv2#Tags", + "traits": { + "smithy.api#documentation": "

Tags for the VPC link.

", + "smithy.api#jsonName": "tags" + } + }, + "VpcLinkId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC link.

", + "smithy.api#jsonName": "vpcLinkId", + "smithy.api#required": {} + } + }, + "VpcLinkStatus": { + "target": "com.amazonaws.apigatewayv2#VpcLinkStatus", + "traits": { + "smithy.api#documentation": "

The status of the VPC link.

", + "smithy.api#jsonName": "vpcLinkStatus" + } + }, + "VpcLinkStatusMessage": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

A message summarizing the cause of the status of the VPC link.

", + "smithy.api#jsonName": "vpcLinkStatusMessage" + } + }, + "VpcLinkVersion": { + "target": "com.amazonaws.apigatewayv2#VpcLinkVersion", + "traits": { + "smithy.api#documentation": "

The version of the VPC link.

", + "smithy.api#jsonName": "vpcLinkVersion" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a VPC link.

" + } + }, + "com.amazonaws.apigatewayv2#VpcLinkStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "INACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACTIVE" + } + } + }, + "traits": { + "smithy.api#documentation": "

The status of the VPC link.

" + } + }, + "com.amazonaws.apigatewayv2#VpcLinkVersion": { + "type": "enum", + "members": { + "V2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "V2" + } + } + }, + "traits": { + "smithy.api#documentation": "

The version of the VPC link.

" + } + }, + "com.amazonaws.apigatewayv2#__boolean": { + "type": "boolean" + }, + "com.amazonaws.apigatewayv2#__double": { + "type": "double" + }, + "com.amazonaws.apigatewayv2#__integer": { + "type": "integer" + }, + "com.amazonaws.apigatewayv2#__listOfApi": { + "type": "list", + "member": { + "target": "com.amazonaws.apigatewayv2#Api" + } + }, + "com.amazonaws.apigatewayv2#__listOfApiMapping": { + "type": "list", + "member": { + "target": "com.amazonaws.apigatewayv2#ApiMapping" + } + }, + "com.amazonaws.apigatewayv2#__listOfAuthorizer": { + "type": "list", + "member": { + "target": "com.amazonaws.apigatewayv2#Authorizer" + } + }, + "com.amazonaws.apigatewayv2#__listOfDeployment": { + "type": "list", + "member": { + "target": "com.amazonaws.apigatewayv2#Deployment" + } + }, + "com.amazonaws.apigatewayv2#__listOfDomainName": { + "type": "list", + "member": { + "target": "com.amazonaws.apigatewayv2#DomainName" + } + }, + "com.amazonaws.apigatewayv2#__listOfIntegration": { + "type": "list", + "member": { + "target": "com.amazonaws.apigatewayv2#Integration" + } + }, + "com.amazonaws.apigatewayv2#__listOfIntegrationResponse": { + "type": "list", + "member": { + "target": "com.amazonaws.apigatewayv2#IntegrationResponse" + } + }, + "com.amazonaws.apigatewayv2#__listOfModel": { + "type": "list", + "member": { + "target": "com.amazonaws.apigatewayv2#Model" + } + }, + "com.amazonaws.apigatewayv2#__listOfRoute": { + "type": "list", + "member": { + "target": "com.amazonaws.apigatewayv2#Route" + } + }, + "com.amazonaws.apigatewayv2#__listOfRouteResponse": { + "type": "list", + "member": { + "target": "com.amazonaws.apigatewayv2#RouteResponse" + } + }, + "com.amazonaws.apigatewayv2#__listOfStage": { + "type": "list", + "member": { + "target": "com.amazonaws.apigatewayv2#Stage" + } + }, + "com.amazonaws.apigatewayv2#__listOfVpcLink": { + "type": "list", + "member": { + "target": "com.amazonaws.apigatewayv2#VpcLink" + } + }, + "com.amazonaws.apigatewayv2#__listOf__string": { + "type": "list", + "member": { + "target": "com.amazonaws.apigatewayv2#__string" + } + }, + "com.amazonaws.apigatewayv2#__string": { + "type": "string" + }, + "com.amazonaws.apigatewayv2#__timestampIso8601": { + "type": "timestamp", + "traits": { + "smithy.api#timestampFormat": "date-time" + } + } + } +} \ No newline at end of file diff --git a/pkg/testdata/codegen/sdk-codegen/aws-models/codedeploy.json b/pkg/testdata/codegen/sdk-codegen/aws-models/codedeploy.json new file mode 100644 index 00000000..ac4c7b96 --- /dev/null +++ b/pkg/testdata/codegen/sdk-codegen/aws-models/codedeploy.json @@ -0,0 +1,10038 @@ +{ + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.codedeploy#AddTagsToOnPremisesInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.codedeploy#AddTagsToOnPremisesInstancesInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.codedeploy#InstanceLimitExceededException" + }, + { + "target": "com.amazonaws.codedeploy#InstanceNameRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#InstanceNotRegisteredException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidInstanceNameException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidTagException" + }, + { + "target": "com.amazonaws.codedeploy#TagLimitExceededException" + }, + { + "target": "com.amazonaws.codedeploy#TagRequiredException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds tags to on-premises instances.

" + } + }, + "com.amazonaws.codedeploy#AddTagsToOnPremisesInstancesInput": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.codedeploy#TagList", + "traits": { + "smithy.api#documentation": "

The tag key-value pairs to add to the on-premises instances.

\n

Keys and values are both required. Keys cannot be null or empty strings. Value-only\n tags are not allowed.

", + "smithy.api#required": {} + } + }, + "instanceNames": { + "target": "com.amazonaws.codedeploy#InstanceNameList", + "traits": { + "smithy.api#documentation": "

The names of the on-premises instances to which to add tags.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of, and adds tags to, an on-premises instance operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.codedeploy#AdditionalDeploymentStatusInfo": { + "type": "string", + "traits": { + "smithy.api#deprecated": { + "message": "AdditionalDeploymentStatusInfo is deprecated, use DeploymentStatusMessageList instead." + } + } + }, + "com.amazonaws.codedeploy#Alarm": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.codedeploy#AlarmName", + "traits": { + "smithy.api#documentation": "

The name of the alarm. Maximum length is 255 characters. Each alarm name can be used\n only once in a list of alarms.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an alarm.

" + } + }, + "com.amazonaws.codedeploy#AlarmConfiguration": { + "type": "structure", + "members": { + "enabled": { + "target": "com.amazonaws.codedeploy#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the alarm configuration is enabled.

" + } + }, + "ignorePollAlarmFailure": { + "target": "com.amazonaws.codedeploy#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether a deployment should continue if information about the current state\n of alarms cannot be retrieved from Amazon CloudWatch. The default value is false.

\n " + } + }, + "alarms": { + "target": "com.amazonaws.codedeploy#AlarmList", + "traits": { + "smithy.api#documentation": "

A list of alarms configured for the deployment or deployment group. A maximum of 10\n alarms can be added.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about alarms associated with a deployment or deployment group.

" + } + }, + "com.amazonaws.codedeploy#AlarmList": { + "type": "list", + "member": { + "target": "com.amazonaws.codedeploy#Alarm" + } + }, + "com.amazonaws.codedeploy#AlarmName": { + "type": "string" + }, + "com.amazonaws.codedeploy#AlarmsLimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The maximum number of alarms for a deployment group (10) was exceeded.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#AppSpecContent": { + "type": "structure", + "members": { + "content": { + "target": "com.amazonaws.codedeploy#RawStringContent", + "traits": { + "smithy.api#documentation": "

The YAML-formatted or JSON-formatted revision string.

\n

For an Lambda deployment, the content includes a Lambda\n function name, the alias for its original version, and the alias for its replacement\n version. The deployment shifts traffic from the original version of the Lambda function to the replacement version.

\n

For an Amazon ECS deployment, the content includes the task name, information\n about the load balancer that serves traffic to the container, and more.

\n

For both types of deployments, the content can specify Lambda functions\n that run at specified hooks, such as BeforeInstall, during a deployment.\n

" + } + }, + "sha256": { + "target": "com.amazonaws.codedeploy#RawStringSha256", + "traits": { + "smithy.api#documentation": "

The SHA256 hash value of the revision content.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A revision for an Lambda or Amazon ECS deployment that is a\n YAML-formatted or JSON-formatted string. For Lambda and Amazon ECS deployments, the revision is the same as the AppSpec file. This method replaces the\n deprecated RawString data type.

" + } + }, + "com.amazonaws.codedeploy#ApplicationAlreadyExistsException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An application with the specified name with the user or Amazon Web Services account\n already exists.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#ApplicationDoesNotExistException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The application does not exist with the user or Amazon Web Services account.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#ApplicationId": { + "type": "string" + }, + "com.amazonaws.codedeploy#ApplicationInfo": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.codedeploy#ApplicationId", + "traits": { + "smithy.api#documentation": "

The application ID.

" + } + }, + "applicationName": { + "target": "com.amazonaws.codedeploy#ApplicationName", + "traits": { + "smithy.api#documentation": "

The application name.

" + } + }, + "createTime": { + "target": "com.amazonaws.codedeploy#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the application was created.

" + } + }, + "linkedToGitHub": { + "target": "com.amazonaws.codedeploy#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

True if the user has authenticated with GitHub for the specified application.\n Otherwise, false.

" + } + }, + "gitHubAccountName": { + "target": "com.amazonaws.codedeploy#GitHubAccountTokenName", + "traits": { + "smithy.api#documentation": "

The name for a connection to a GitHub account.

" + } + }, + "computePlatform": { + "target": "com.amazonaws.codedeploy#ComputePlatform", + "traits": { + "smithy.api#documentation": "

The destination platform type for deployment of the application (Lambda or Server).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an application.

" + } + }, + "com.amazonaws.codedeploy#ApplicationLimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

More applications were attempted to be created than are allowed.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#ApplicationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.codedeploy#ApplicationNameRequiredException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum number of required application names was not specified.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#ApplicationRevisionSortBy": { + "type": "enum", + "members": { + "RegisterTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "registerTime" + } + }, + "FirstUsedTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "firstUsedTime" + } + }, + "LastUsedTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "lastUsedTime" + } + } + } + }, + "com.amazonaws.codedeploy#ApplicationsInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.codedeploy#ApplicationInfo" + } + }, + "com.amazonaws.codedeploy#ApplicationsList": { + "type": "list", + "member": { + "target": "com.amazonaws.codedeploy#ApplicationName" + } + }, + "com.amazonaws.codedeploy#Arn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1011 + } + } + }, + "com.amazonaws.codedeploy#ArnNotSupportedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The specified ARN is not supported. For example, it might be an ARN for a resource\n that is not expected.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#AutoRollbackConfiguration": { + "type": "structure", + "members": { + "enabled": { + "target": "com.amazonaws.codedeploy#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether a defined automatic rollback configuration is currently\n enabled.

" + } + }, + "events": { + "target": "com.amazonaws.codedeploy#AutoRollbackEventsList", + "traits": { + "smithy.api#documentation": "

The event type or types that trigger a rollback.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a configuration for automatically rolling back to a previous version\n of an application revision when a deployment is not completed successfully.

" + } + }, + "com.amazonaws.codedeploy#AutoRollbackEvent": { + "type": "enum", + "members": { + "DEPLOYMENT_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEPLOYMENT_FAILURE" + } + }, + "DEPLOYMENT_STOP_ON_ALARM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEPLOYMENT_STOP_ON_ALARM" + } + }, + "DEPLOYMENT_STOP_ON_REQUEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEPLOYMENT_STOP_ON_REQUEST" + } + } + } + }, + "com.amazonaws.codedeploy#AutoRollbackEventsList": { + "type": "list", + "member": { + "target": "com.amazonaws.codedeploy#AutoRollbackEvent" + } + }, + "com.amazonaws.codedeploy#AutoScalingGroup": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.codedeploy#AutoScalingGroupName", + "traits": { + "smithy.api#documentation": "

The Auto Scaling group name.

" + } + }, + "hook": { + "target": "com.amazonaws.codedeploy#AutoScalingGroupHook", + "traits": { + "smithy.api#documentation": "

The name of the launch hook that CodeDeploy installed into the Auto Scaling group.

\n

For more information about the launch hook, see How Amazon EC2 Auto Scaling works with CodeDeploy in the\n CodeDeploy User Guide.

" + } + }, + "terminationHook": { + "target": "com.amazonaws.codedeploy#AutoScalingGroupHook", + "traits": { + "smithy.api#documentation": "

The name of the termination hook that CodeDeploy installed into the Auto Scaling group.

\n

For more information about the termination hook, see Enabling termination deployments during Auto Scaling scale-in events in the\n CodeDeploy User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an Auto Scaling group.

" + } + }, + "com.amazonaws.codedeploy#AutoScalingGroupHook": { + "type": "string" + }, + "com.amazonaws.codedeploy#AutoScalingGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.codedeploy#AutoScalingGroup" + } + }, + "com.amazonaws.codedeploy#AutoScalingGroupName": { + "type": "string" + }, + "com.amazonaws.codedeploy#AutoScalingGroupNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.codedeploy#AutoScalingGroupName" + } + }, + "com.amazonaws.codedeploy#BatchGetApplicationRevisions": { + "type": "operation", + "input": { + "target": "com.amazonaws.codedeploy#BatchGetApplicationRevisionsInput" + }, + "output": { + "target": "com.amazonaws.codedeploy#BatchGetApplicationRevisionsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codedeploy#ApplicationDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#ApplicationNameRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#BatchLimitExceededException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidApplicationNameException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidRevisionException" + }, + { + "target": "com.amazonaws.codedeploy#RevisionRequiredException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about one or more application revisions. The maximum number of\n application revisions that can be returned is 25.

" + } + }, + "com.amazonaws.codedeploy#BatchGetApplicationRevisionsInput": { + "type": "structure", + "members": { + "applicationName": { + "target": "com.amazonaws.codedeploy#ApplicationName", + "traits": { + "smithy.api#documentation": "

The name of an CodeDeploy application about which to get revision\n information.

", + "smithy.api#required": {} + } + }, + "revisions": { + "target": "com.amazonaws.codedeploy#RevisionLocationList", + "traits": { + "smithy.api#documentation": "

An array of RevisionLocation objects that specify information to get\n about the application revisions, including type and location. The maximum number of\n RevisionLocation objects you can specify is 25.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a BatchGetApplicationRevisions operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.codedeploy#BatchGetApplicationRevisionsOutput": { + "type": "structure", + "members": { + "applicationName": { + "target": "com.amazonaws.codedeploy#ApplicationName", + "traits": { + "smithy.api#documentation": "

The name of the application that corresponds to the revisions.

" + } + }, + "errorMessage": { + "target": "com.amazonaws.codedeploy#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Information about errors that might have occurred during the API call.

" + } + }, + "revisions": { + "target": "com.amazonaws.codedeploy#RevisionInfoList", + "traits": { + "smithy.api#documentation": "

Additional information about the revisions, including the type and location.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a BatchGetApplicationRevisions operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.codedeploy#BatchGetApplications": { + "type": "operation", + "input": { + "target": "com.amazonaws.codedeploy#BatchGetApplicationsInput" + }, + "output": { + "target": "com.amazonaws.codedeploy#BatchGetApplicationsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codedeploy#ApplicationDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#ApplicationNameRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#BatchLimitExceededException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidApplicationNameException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about one or more applications. The maximum number of applications\n that can be returned is 100.

" + } + }, + "com.amazonaws.codedeploy#BatchGetApplicationsInput": { + "type": "structure", + "members": { + "applicationNames": { + "target": "com.amazonaws.codedeploy#ApplicationsList", + "traits": { + "smithy.api#documentation": "

A list of application names separated by spaces. The maximum number of application\n names you can specify is 100.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a BatchGetApplications operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.codedeploy#BatchGetApplicationsOutput": { + "type": "structure", + "members": { + "applicationsInfo": { + "target": "com.amazonaws.codedeploy#ApplicationsInfoList", + "traits": { + "smithy.api#documentation": "

Information about the applications.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a BatchGetApplications operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.codedeploy#BatchGetDeploymentGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.codedeploy#BatchGetDeploymentGroupsInput" + }, + "output": { + "target": "com.amazonaws.codedeploy#BatchGetDeploymentGroupsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codedeploy#ApplicationDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#ApplicationNameRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#BatchLimitExceededException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentConfigDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentGroupNameRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidApplicationNameException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidDeploymentGroupNameException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about one or more deployment groups.

" + } + }, + "com.amazonaws.codedeploy#BatchGetDeploymentGroupsInput": { + "type": "structure", + "members": { + "applicationName": { + "target": "com.amazonaws.codedeploy#ApplicationName", + "traits": { + "smithy.api#documentation": "

The name of an CodeDeploy application associated with the applicable user\n or Amazon Web Services account.

", + "smithy.api#required": {} + } + }, + "deploymentGroupNames": { + "target": "com.amazonaws.codedeploy#DeploymentGroupsList", + "traits": { + "smithy.api#documentation": "

The names of the deployment groups.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a BatchGetDeploymentGroups operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.codedeploy#BatchGetDeploymentGroupsOutput": { + "type": "structure", + "members": { + "deploymentGroupsInfo": { + "target": "com.amazonaws.codedeploy#DeploymentGroupInfoList", + "traits": { + "smithy.api#documentation": "

Information about the deployment groups.

" + } + }, + "errorMessage": { + "target": "com.amazonaws.codedeploy#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Information about errors that might have occurred during the API call.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a BatchGetDeploymentGroups operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.codedeploy#BatchGetDeploymentInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.codedeploy#BatchGetDeploymentInstancesInput" + }, + "output": { + "target": "com.amazonaws.codedeploy#BatchGetDeploymentInstancesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codedeploy#BatchLimitExceededException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentIdRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#InstanceIdRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidComputePlatformException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidDeploymentIdException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidInstanceNameException" + } + ], + "traits": { + "smithy.api#deprecated": { + "message": "This operation is deprecated, use BatchGetDeploymentTargets instead." + }, + "smithy.api#documentation": "\n

This method works, but is deprecated. Use BatchGetDeploymentTargets\n instead.

\n \n

Returns an array of one or more instances associated with a deployment. This method\n works with EC2/On-premises and Lambda compute platforms. The newer\n BatchGetDeploymentTargets works with all compute platforms. The maximum\n number of instances that can be returned is 25.

" + } + }, + "com.amazonaws.codedeploy#BatchGetDeploymentInstancesInput": { + "type": "structure", + "members": { + "deploymentId": { + "target": "com.amazonaws.codedeploy#DeploymentId", + "traits": { + "smithy.api#documentation": "

The unique ID of a deployment.

", + "smithy.api#required": {} + } + }, + "instanceIds": { + "target": "com.amazonaws.codedeploy#InstancesList", + "traits": { + "smithy.api#documentation": "

The unique IDs of instances used in the deployment. The maximum number of instance IDs\n you can specify is 25.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a BatchGetDeploymentInstances operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.codedeploy#BatchGetDeploymentInstancesOutput": { + "type": "structure", + "members": { + "instancesSummary": { + "target": "com.amazonaws.codedeploy#InstanceSummaryList", + "traits": { + "smithy.api#documentation": "

Information about the instance.

" + } + }, + "errorMessage": { + "target": "com.amazonaws.codedeploy#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Information about errors that might have occurred during the API call.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a BatchGetDeploymentInstances operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.codedeploy#BatchGetDeploymentTargets": { + "type": "operation", + "input": { + "target": "com.amazonaws.codedeploy#BatchGetDeploymentTargetsInput" + }, + "output": { + "target": "com.amazonaws.codedeploy#BatchGetDeploymentTargetsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codedeploy#DeploymentDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentIdRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentNotStartedException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentTargetDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentTargetIdRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentTargetListSizeExceededException" + }, + { + "target": "com.amazonaws.codedeploy#InstanceDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidDeploymentIdException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidDeploymentTargetIdException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns an array of one or more targets associated with a deployment. This method\n works with all compute types and should be used instead of the deprecated\n BatchGetDeploymentInstances. The maximum number of targets that can be\n returned is 25.

\n

The type of targets returned depends on the deployment's compute platform or\n deployment method:

\n " + } + }, + "com.amazonaws.codedeploy#BatchGetDeploymentTargetsInput": { + "type": "structure", + "members": { + "deploymentId": { + "target": "com.amazonaws.codedeploy#DeploymentId", + "traits": { + "smithy.api#documentation": "

The unique ID of a deployment.

", + "smithy.api#required": {} + } + }, + "targetIds": { + "target": "com.amazonaws.codedeploy#TargetIdList", + "traits": { + "smithy.api#documentation": "

The unique IDs of the deployment targets. The compute platform of the deployment\n determines the type of the targets and their formats. The maximum number of deployment\n target IDs you can specify is 25.

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codedeploy#BatchGetDeploymentTargetsOutput": { + "type": "structure", + "members": { + "deploymentTargets": { + "target": "com.amazonaws.codedeploy#DeploymentTargetList", + "traits": { + "smithy.api#documentation": "

A list of target objects for a deployment. Each target object contains details about\n the target, such as its status and lifecycle events. The type of the target objects\n depends on the deployment' compute platform.

\n " + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.codedeploy#BatchGetDeployments": { + "type": "operation", + "input": { + "target": "com.amazonaws.codedeploy#BatchGetDeploymentsInput" + }, + "output": { + "target": "com.amazonaws.codedeploy#BatchGetDeploymentsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codedeploy#BatchLimitExceededException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentIdRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidDeploymentIdException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about one or more deployments. The maximum number of deployments that\n can be returned is 25.

" + } + }, + "com.amazonaws.codedeploy#BatchGetDeploymentsInput": { + "type": "structure", + "members": { + "deploymentIds": { + "target": "com.amazonaws.codedeploy#DeploymentsList", + "traits": { + "smithy.api#documentation": "

A list of deployment IDs, separated by spaces. The maximum number of deployment IDs\n you can specify is 25.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a BatchGetDeployments operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.codedeploy#BatchGetDeploymentsOutput": { + "type": "structure", + "members": { + "deploymentsInfo": { + "target": "com.amazonaws.codedeploy#DeploymentsInfoList", + "traits": { + "smithy.api#documentation": "

Information about the deployments.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a BatchGetDeployments operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.codedeploy#BatchGetOnPremisesInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.codedeploy#BatchGetOnPremisesInstancesInput" + }, + "output": { + "target": "com.amazonaws.codedeploy#BatchGetOnPremisesInstancesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codedeploy#BatchLimitExceededException" + }, + { + "target": "com.amazonaws.codedeploy#InstanceNameRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidInstanceNameException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about one or more on-premises instances. The maximum number of\n on-premises instances that can be returned is 25.

" + } + }, + "com.amazonaws.codedeploy#BatchGetOnPremisesInstancesInput": { + "type": "structure", + "members": { + "instanceNames": { + "target": "com.amazonaws.codedeploy#InstanceNameList", + "traits": { + "smithy.api#documentation": "

The names of the on-premises instances about which to get information. The maximum\n number of instance names you can specify is 25.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a BatchGetOnPremisesInstances operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.codedeploy#BatchGetOnPremisesInstancesOutput": { + "type": "structure", + "members": { + "instanceInfos": { + "target": "com.amazonaws.codedeploy#InstanceInfoList", + "traits": { + "smithy.api#documentation": "

Information about the on-premises instances.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a BatchGetOnPremisesInstances operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.codedeploy#BatchLimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The maximum number of names or IDs allowed for this request (100) was exceeded.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#BlueGreenDeploymentConfiguration": { + "type": "structure", + "members": { + "terminateBlueInstancesOnDeploymentSuccess": { + "target": "com.amazonaws.codedeploy#BlueInstanceTerminationOption", + "traits": { + "smithy.api#documentation": "

Information about whether to terminate instances in the original fleet during a\n blue/green deployment.

" + } + }, + "deploymentReadyOption": { + "target": "com.amazonaws.codedeploy#DeploymentReadyOption", + "traits": { + "smithy.api#documentation": "

Information about the action to take when newly provisioned instances are ready to\n receive traffic in a blue/green deployment.

" + } + }, + "greenFleetProvisioningOption": { + "target": "com.amazonaws.codedeploy#GreenFleetProvisioningOption", + "traits": { + "smithy.api#documentation": "

Information about how instances are provisioned for a replacement environment in a\n blue/green deployment.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about blue/green deployment options for a deployment group.

" + } + }, + "com.amazonaws.codedeploy#BlueInstanceTerminationOption": { + "type": "structure", + "members": { + "action": { + "target": "com.amazonaws.codedeploy#InstanceAction", + "traits": { + "smithy.api#documentation": "

The action to take on instances in the original environment after a successful\n blue/green deployment.

\n " + } + }, + "terminationWaitTimeInMinutes": { + "target": "com.amazonaws.codedeploy#Duration", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

For an Amazon EC2 deployment, the number of minutes to wait after a successful\n blue/green deployment before terminating instances from the original environment.

\n

For an Amazon ECS deployment, the number of minutes before deleting the\n original (blue) task set. During an Amazon ECS deployment, CodeDeploy shifts\n traffic from the original (blue) task set to a replacement (green) task set.

\n

The maximum setting is 2880 minutes (2 days).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about whether instances in the original environment are terminated when a\n blue/green deployment is successful. BlueInstanceTerminationOption does not\n apply to Lambda deployments.

" + } + }, + "com.amazonaws.codedeploy#Boolean": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.codedeploy#BucketNameFilterRequiredException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A bucket name is required, but was not provided.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#BundleType": { + "type": "enum", + "members": { + "Tar": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "tar" + } + }, + "TarGZip": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "tgz" + } + }, + "Zip": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "zip" + } + }, + "YAML": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "YAML" + } + }, + "JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSON" + } + } + } + }, + "com.amazonaws.codedeploy#CloudFormationResourceType": { + "type": "string" + }, + "com.amazonaws.codedeploy#CloudFormationTarget": { + "type": "structure", + "members": { + "deploymentId": { + "target": "com.amazonaws.codedeploy#DeploymentId", + "traits": { + "smithy.api#documentation": "

The unique ID of an CloudFormation blue/green deployment.

" + } + }, + "targetId": { + "target": "com.amazonaws.codedeploy#TargetId", + "traits": { + "smithy.api#documentation": "

The unique ID of a deployment target that has a type\n of CloudFormationTarget.

" + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.codedeploy#Time", + "traits": { + "smithy.api#documentation": "

The date and time when the target application was updated by an CloudFormation\n blue/green deployment.

" + } + }, + "lifecycleEvents": { + "target": "com.amazonaws.codedeploy#LifecycleEventList", + "traits": { + "smithy.api#documentation": "

The lifecycle events of the CloudFormation blue/green deployment to this target\n application.

" + } + }, + "status": { + "target": "com.amazonaws.codedeploy#TargetStatus", + "traits": { + "smithy.api#documentation": "

The status of an CloudFormation blue/green deployment's target application.\n

" + } + }, + "resourceType": { + "target": "com.amazonaws.codedeploy#CloudFormationResourceType", + "traits": { + "smithy.api#documentation": "

The resource type for the CloudFormation blue/green deployment.

" + } + }, + "targetVersionWeight": { + "target": "com.amazonaws.codedeploy#TrafficWeight", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The percentage of production traffic that the target version of an CloudFormation\n blue/green deployment receives.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the target to be updated by an CloudFormation blue/green\n deployment. This target type is used for all deployments initiated by a CloudFormation stack update.

" + } + }, + "com.amazonaws.codedeploy#CodeDeploy_20141006": { + "type": "service", + "version": "2014-10-06", + "operations": [ + { + "target": "com.amazonaws.codedeploy#AddTagsToOnPremisesInstances" + }, + { + "target": "com.amazonaws.codedeploy#BatchGetApplicationRevisions" + }, + { + "target": "com.amazonaws.codedeploy#BatchGetApplications" + }, + { + "target": "com.amazonaws.codedeploy#BatchGetDeploymentGroups" + }, + { + "target": "com.amazonaws.codedeploy#BatchGetDeploymentInstances" + }, + { + "target": "com.amazonaws.codedeploy#BatchGetDeployments" + }, + { + "target": "com.amazonaws.codedeploy#BatchGetDeploymentTargets" + }, + { + "target": "com.amazonaws.codedeploy#BatchGetOnPremisesInstances" + }, + { + "target": "com.amazonaws.codedeploy#ContinueDeployment" + }, + { + "target": "com.amazonaws.codedeploy#CreateApplication" + }, + { + "target": "com.amazonaws.codedeploy#CreateDeployment" + }, + { + "target": "com.amazonaws.codedeploy#CreateDeploymentConfig" + }, + { + "target": "com.amazonaws.codedeploy#CreateDeploymentGroup" + }, + { + "target": "com.amazonaws.codedeploy#DeleteApplication" + }, + { + "target": "com.amazonaws.codedeploy#DeleteDeploymentConfig" + }, + { + "target": "com.amazonaws.codedeploy#DeleteDeploymentGroup" + }, + { + "target": "com.amazonaws.codedeploy#DeleteGitHubAccountToken" + }, + { + "target": "com.amazonaws.codedeploy#DeleteResourcesByExternalId" + }, + { + "target": "com.amazonaws.codedeploy#DeregisterOnPremisesInstance" + }, + { + "target": "com.amazonaws.codedeploy#GetApplication" + }, + { + "target": "com.amazonaws.codedeploy#GetApplicationRevision" + }, + { + "target": "com.amazonaws.codedeploy#GetDeployment" + }, + { + "target": "com.amazonaws.codedeploy#GetDeploymentConfig" + }, + { + "target": "com.amazonaws.codedeploy#GetDeploymentGroup" + }, + { + "target": "com.amazonaws.codedeploy#GetDeploymentInstance" + }, + { + "target": "com.amazonaws.codedeploy#GetDeploymentTarget" + }, + { + "target": "com.amazonaws.codedeploy#GetOnPremisesInstance" + }, + { + "target": "com.amazonaws.codedeploy#ListApplicationRevisions" + }, + { + "target": "com.amazonaws.codedeploy#ListApplications" + }, + { + "target": "com.amazonaws.codedeploy#ListDeploymentConfigs" + }, + { + "target": "com.amazonaws.codedeploy#ListDeploymentGroups" + }, + { + "target": "com.amazonaws.codedeploy#ListDeploymentInstances" + }, + { + "target": "com.amazonaws.codedeploy#ListDeployments" + }, + { + "target": "com.amazonaws.codedeploy#ListDeploymentTargets" + }, + { + "target": "com.amazonaws.codedeploy#ListGitHubAccountTokenNames" + }, + { + "target": "com.amazonaws.codedeploy#ListOnPremisesInstances" + }, + { + "target": "com.amazonaws.codedeploy#ListTagsForResource" + }, + { + "target": "com.amazonaws.codedeploy#PutLifecycleEventHookExecutionStatus" + }, + { + "target": "com.amazonaws.codedeploy#RegisterApplicationRevision" + }, + { + "target": "com.amazonaws.codedeploy#RegisterOnPremisesInstance" + }, + { + "target": "com.amazonaws.codedeploy#RemoveTagsFromOnPremisesInstances" + }, + { + "target": "com.amazonaws.codedeploy#SkipWaitTimeForInstanceTermination" + }, + { + "target": "com.amazonaws.codedeploy#StopDeployment" + }, + { + "target": "com.amazonaws.codedeploy#TagResource" + }, + { + "target": "com.amazonaws.codedeploy#UntagResource" + }, + { + "target": "com.amazonaws.codedeploy#UpdateApplication" + }, + { + "target": "com.amazonaws.codedeploy#UpdateDeploymentGroup" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "CodeDeploy", + "arnNamespace": "codedeploy", + "cloudFormationName": "CodeDeploy", + "cloudTrailEventSource": "codedeploy.amazonaws.com", + "endpointPrefix": "codedeploy" + }, + "aws.auth#sigv4": { + "name": "codedeploy" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "

CodeDeploy is a deployment service that automates application deployments\n to Amazon EC2 instances, on-premises instances running in your own facility,\n serverless Lambda functions, or applications in an Amazon ECS\n service.

\n

You can deploy a nearly unlimited variety of application content, such as an updated\n Lambda function, updated applications in an Amazon ECS service,\n code, web and configuration files, executables, packages, scripts, multimedia files, and\n so on. CodeDeploy can deploy application content stored in Amazon S3\n buckets, GitHub repositories, or Bitbucket repositories. You do not need to make changes\n to your existing code before you can use CodeDeploy.

\n

CodeDeploy makes it easier for you to rapidly release new features, helps\n you avoid downtime during application deployment, and handles the complexity of updating\n your applications, without many of the risks associated with error-prone manual\n deployments.

\n

\n CodeDeploy Components\n

\n

Use the information in this guide to help you work with the following CodeDeploy components:

\n \n

This guide also contains information to help you get details about the instances in\n your deployments, to make on-premises instances available for CodeDeploy\n deployments, to get details about a Lambda function deployment, and to get\n details about Amazon ECS service deployments.

\n

\n CodeDeploy Information Resources\n

\n ", + "smithy.api#title": "AWS CodeDeploy", + "smithy.api#xmlNamespace": { + "uri": "http://codedeploy.amazonaws.com/doc/2014-10-06/" + }, + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://codedeploy-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://codedeploy-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://codedeploy.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://codedeploy.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codedeploy.af-south-1.amazonaws.com" + } + }, + "params": { + "Region": "af-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codedeploy.ap-east-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codedeploy.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codedeploy.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codedeploy.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codedeploy.ap-south-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codedeploy.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codedeploy.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codedeploy.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codedeploy.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codedeploy.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codedeploy.eu-north-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codedeploy.eu-south-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codedeploy.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codedeploy.eu-west-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codedeploy.eu-west-3.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codedeploy.me-south-1.amazonaws.com" + } + }, + "params": { + "Region": "me-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codedeploy.sa-east-1.amazonaws.com" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codedeploy.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codedeploy-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codedeploy.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codedeploy-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codedeploy.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codedeploy-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codedeploy.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codedeploy-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://codedeploy-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://codedeploy.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codedeploy.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codedeploy.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://codedeploy-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codedeploy-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://codedeploy.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codedeploy.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codedeploy-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codedeploy.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codedeploy-fips.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://codedeploy-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://codedeploy.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codedeploy.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codedeploy.us-iso-west-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codedeploy-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codedeploy.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codedeploy-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.codedeploy#CommitId": { + "type": "string" + }, + "com.amazonaws.codedeploy#ComputePlatform": { + "type": "enum", + "members": { + "SERVER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Server" + } + }, + "LAMBDA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Lambda" + } + }, + "ECS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ECS" + } + } + } + }, + "com.amazonaws.codedeploy#ContinueDeployment": { + "type": "operation", + "input": { + "target": "com.amazonaws.codedeploy#ContinueDeploymentInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.codedeploy#DeploymentAlreadyCompletedException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentIdRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentIsNotInReadyStateException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidDeploymentIdException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidDeploymentStatusException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidDeploymentWaitTypeException" + }, + { + "target": "com.amazonaws.codedeploy#UnsupportedActionForDeploymentTypeException" + } + ], + "traits": { + "smithy.api#documentation": "

For a blue/green deployment, starts the process of rerouting traffic from instances in\n the original environment to instances in the replacement environment without waiting for\n a specified wait time to elapse. (Traffic rerouting, which is achieved by registering\n instances in the replacement environment with the load balancer, can start as soon as\n all instances have a status of Ready.)

" + } + }, + "com.amazonaws.codedeploy#ContinueDeploymentInput": { + "type": "structure", + "members": { + "deploymentId": { + "target": "com.amazonaws.codedeploy#DeploymentId", + "traits": { + "smithy.api#documentation": "

The unique ID of a blue/green deployment for which you want to start rerouting\n traffic to the replacement environment.

" + } + }, + "deploymentWaitType": { + "target": "com.amazonaws.codedeploy#DeploymentWaitType", + "traits": { + "smithy.api#documentation": "

The status of the deployment's waiting period. READY_WAIT indicates that\n the deployment is ready to start shifting traffic. TERMINATION_WAIT\n indicates that the traffic is shifted, but the original target is not terminated.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codedeploy#CreateApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.codedeploy#CreateApplicationInput" + }, + "output": { + "target": "com.amazonaws.codedeploy#CreateApplicationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codedeploy#ApplicationAlreadyExistsException" + }, + { + "target": "com.amazonaws.codedeploy#ApplicationLimitExceededException" + }, + { + "target": "com.amazonaws.codedeploy#ApplicationNameRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidApplicationNameException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidComputePlatformException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidTagsToAddException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an application.

" + } + }, + "com.amazonaws.codedeploy#CreateApplicationInput": { + "type": "structure", + "members": { + "applicationName": { + "target": "com.amazonaws.codedeploy#ApplicationName", + "traits": { + "smithy.api#documentation": "

The name of the application. This name must be unique with the applicable user or\n Amazon Web Services account.

", + "smithy.api#required": {} + } + }, + "computePlatform": { + "target": "com.amazonaws.codedeploy#ComputePlatform", + "traits": { + "smithy.api#documentation": "

The destination platform type for the deployment (Lambda,\n Server, or ECS).

" + } + }, + "tags": { + "target": "com.amazonaws.codedeploy#TagList", + "traits": { + "smithy.api#documentation": "

The metadata that you apply to CodeDeploy applications to help you organize and\n categorize them. Each tag consists of a key and an optional value, both of which you\n define.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a CreateApplication operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.codedeploy#CreateApplicationOutput": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.codedeploy#ApplicationId", + "traits": { + "smithy.api#documentation": "

A unique application ID.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a CreateApplication operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.codedeploy#CreateDeployment": { + "type": "operation", + "input": { + "target": "com.amazonaws.codedeploy#CreateDeploymentInput" + }, + "output": { + "target": "com.amazonaws.codedeploy#CreateDeploymentOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codedeploy#AlarmsLimitExceededException" + }, + { + "target": "com.amazonaws.codedeploy#ApplicationDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#ApplicationNameRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentConfigDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentGroupDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentGroupNameRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentLimitExceededException" + }, + { + "target": "com.amazonaws.codedeploy#DescriptionTooLongException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidAlarmConfigException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidApplicationNameException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidAutoRollbackConfigException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidAutoScalingGroupException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidDeploymentConfigNameException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidDeploymentGroupNameException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidFileExistsBehaviorException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidGitHubAccountTokenException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidIgnoreApplicationStopFailuresValueException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidLoadBalancerInfoException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidRevisionException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidRoleException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidTargetInstancesException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidTrafficRoutingConfigurationException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidUpdateOutdatedInstancesOnlyValueException" + }, + { + "target": "com.amazonaws.codedeploy#RevisionDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#RevisionRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deploys an application revision through the specified deployment group.

" + } + }, + "com.amazonaws.codedeploy#CreateDeploymentConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.codedeploy#CreateDeploymentConfigInput" + }, + "output": { + "target": "com.amazonaws.codedeploy#CreateDeploymentConfigOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codedeploy#DeploymentConfigAlreadyExistsException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentConfigLimitExceededException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentConfigNameRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidComputePlatformException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidDeploymentConfigNameException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidMinimumHealthyHostValueException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidTrafficRoutingConfigurationException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidZonalDeploymentConfigurationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a deployment configuration.

" + } + }, + "com.amazonaws.codedeploy#CreateDeploymentConfigInput": { + "type": "structure", + "members": { + "deploymentConfigName": { + "target": "com.amazonaws.codedeploy#DeploymentConfigName", + "traits": { + "smithy.api#documentation": "

The name of the deployment configuration to create.

", + "smithy.api#required": {} + } + }, + "minimumHealthyHosts": { + "target": "com.amazonaws.codedeploy#MinimumHealthyHosts", + "traits": { + "smithy.api#documentation": "

The minimum number of healthy instances that should be available at any time during\n the deployment. There are two parameters expected in the input: type and value.

\n

The type parameter takes either of the following values:

\n \n

The value parameter takes an integer.

\n

For example, to set a minimum of 95% healthy instance, specify a type of FLEET_PERCENT\n and a value of 95.

" + } + }, + "trafficRoutingConfig": { + "target": "com.amazonaws.codedeploy#TrafficRoutingConfig", + "traits": { + "smithy.api#documentation": "

The configuration that specifies how the deployment traffic is routed.

" + } + }, + "computePlatform": { + "target": "com.amazonaws.codedeploy#ComputePlatform", + "traits": { + "smithy.api#documentation": "

The destination platform type for the deployment (Lambda,\n Server, or ECS).

" + } + }, + "zonalConfig": { + "target": "com.amazonaws.codedeploy#ZonalConfig", + "traits": { + "smithy.api#documentation": "

Configure the ZonalConfig object if you want CodeDeploy to\n deploy your application to one Availability Zone at a time, within an Amazon Web Services Region.

\n

For more information about the zonal configuration feature, see zonal configuration in the CodeDeploy User\n Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a CreateDeploymentConfig operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.codedeploy#CreateDeploymentConfigOutput": { + "type": "structure", + "members": { + "deploymentConfigId": { + "target": "com.amazonaws.codedeploy#DeploymentConfigId", + "traits": { + "smithy.api#documentation": "

A unique deployment configuration ID.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a CreateDeploymentConfig operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.codedeploy#CreateDeploymentGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.codedeploy#CreateDeploymentGroupInput" + }, + "output": { + "target": "com.amazonaws.codedeploy#CreateDeploymentGroupOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codedeploy#AlarmsLimitExceededException" + }, + { + "target": "com.amazonaws.codedeploy#ApplicationDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#ApplicationNameRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentConfigDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentGroupAlreadyExistsException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentGroupLimitExceededException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentGroupNameRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#ECSServiceMappingLimitExceededException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidAlarmConfigException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidApplicationNameException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidAutoRollbackConfigException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidAutoScalingGroupException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidBlueGreenDeploymentConfigurationException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidDeploymentConfigNameException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidDeploymentGroupNameException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidDeploymentStyleException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidEC2TagCombinationException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidEC2TagException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidECSServiceException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidInputException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidLoadBalancerInfoException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidOnPremisesTagCombinationException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidRoleException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidTagException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidTagsToAddException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidTargetGroupPairException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidTrafficRoutingConfigurationException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidTriggerConfigException" + }, + { + "target": "com.amazonaws.codedeploy#LifecycleHookLimitExceededException" + }, + { + "target": "com.amazonaws.codedeploy#RoleRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#TagSetListLimitExceededException" + }, + { + "target": "com.amazonaws.codedeploy#ThrottlingException" + }, + { + "target": "com.amazonaws.codedeploy#TriggerTargetsLimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a deployment group to which application revisions are deployed.

" + } + }, + "com.amazonaws.codedeploy#CreateDeploymentGroupInput": { + "type": "structure", + "members": { + "applicationName": { + "target": "com.amazonaws.codedeploy#ApplicationName", + "traits": { + "smithy.api#documentation": "

The name of an CodeDeploy application associated with the user or Amazon Web Services account.

", + "smithy.api#required": {} + } + }, + "deploymentGroupName": { + "target": "com.amazonaws.codedeploy#DeploymentGroupName", + "traits": { + "smithy.api#documentation": "

The name of a new deployment group for the specified application.

", + "smithy.api#required": {} + } + }, + "deploymentConfigName": { + "target": "com.amazonaws.codedeploy#DeploymentConfigName", + "traits": { + "smithy.api#documentation": "

If specified, the deployment configuration name can be either one of the predefined\n configurations provided with CodeDeploy or a custom deployment configuration\n that you create by calling the create deployment configuration operation.

\n

\n CodeDeployDefault.OneAtATime is the default deployment configuration. It\n is used if a configuration isn't specified for the deployment or deployment\n group.

\n

For more information about the predefined deployment configurations in CodeDeploy, see Working with\n Deployment Configurations in CodeDeploy in the CodeDeploy User Guide.

" + } + }, + "ec2TagFilters": { + "target": "com.amazonaws.codedeploy#EC2TagFilterList", + "traits": { + "smithy.api#documentation": "

The Amazon EC2 tags on which to filter. The deployment group includes Amazon EC2 instances with any of the specified tags. Cannot be used in the same call\n as ec2TagSet.

" + } + }, + "onPremisesInstanceTagFilters": { + "target": "com.amazonaws.codedeploy#TagFilterList", + "traits": { + "smithy.api#documentation": "

The on-premises instance tags on which to filter. The deployment group includes\n on-premises instances with any of the specified tags. Cannot be used in the same call as\n OnPremisesTagSet.

" + } + }, + "autoScalingGroups": { + "target": "com.amazonaws.codedeploy#AutoScalingGroupNameList", + "traits": { + "smithy.api#documentation": "

A list of associated Amazon EC2 Auto Scaling groups.

" + } + }, + "serviceRoleArn": { + "target": "com.amazonaws.codedeploy#Role", + "traits": { + "smithy.api#documentation": "

A service role Amazon Resource Name (ARN) that allows CodeDeploy to act on\n the user's behalf when interacting with Amazon Web Services services.

", + "smithy.api#required": {} + } + }, + "triggerConfigurations": { + "target": "com.amazonaws.codedeploy#TriggerConfigList", + "traits": { + "smithy.api#documentation": "

Information about triggers to create when the deployment group is created. For\n examples, see Create a Trigger for an\n CodeDeploy Event in the CodeDeploy\n User Guide.

" + } + }, + "alarmConfiguration": { + "target": "com.amazonaws.codedeploy#AlarmConfiguration", + "traits": { + "smithy.api#documentation": "

Information to add about Amazon CloudWatch alarms when the deployment group is\n created.

" + } + }, + "autoRollbackConfiguration": { + "target": "com.amazonaws.codedeploy#AutoRollbackConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration information for an automatic rollback that is added when a deployment\n group is created.

" + } + }, + "outdatedInstancesStrategy": { + "target": "com.amazonaws.codedeploy#OutdatedInstancesStrategy", + "traits": { + "smithy.api#documentation": "

Indicates what happens when new Amazon EC2 instances are launched\n mid-deployment and do not receive the deployed application revision.

\n

If this option is set to UPDATE or is unspecified, CodeDeploy initiates\n one or more 'auto-update outdated instances' deployments to apply the deployed\n application revision to the new Amazon EC2 instances.

\n

If this option is set to IGNORE, CodeDeploy does not initiate a\n deployment to update the new Amazon EC2 instances. This may result in instances\n having different revisions.

" + } + }, + "deploymentStyle": { + "target": "com.amazonaws.codedeploy#DeploymentStyle", + "traits": { + "smithy.api#documentation": "

Information about the type of deployment, in-place or blue/green, that you want to run\n and whether to route deployment traffic behind a load balancer.

" + } + }, + "blueGreenDeploymentConfiguration": { + "target": "com.amazonaws.codedeploy#BlueGreenDeploymentConfiguration", + "traits": { + "smithy.api#documentation": "

Information about blue/green deployment options for a deployment group.

" + } + }, + "loadBalancerInfo": { + "target": "com.amazonaws.codedeploy#LoadBalancerInfo", + "traits": { + "smithy.api#documentation": "

Information about the load balancer used in a deployment.

" + } + }, + "ec2TagSet": { + "target": "com.amazonaws.codedeploy#EC2TagSet", + "traits": { + "smithy.api#documentation": "

Information about groups of tags applied to Amazon EC2 instances. The\n deployment group includes only Amazon EC2 instances identified by all the tag\n groups. Cannot be used in the same call as ec2TagFilters.

" + } + }, + "ecsServices": { + "target": "com.amazonaws.codedeploy#ECSServiceList", + "traits": { + "smithy.api#documentation": "

The target Amazon ECS services in the deployment group. This applies only to\n deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name\n pair using the format :.

" + } + }, + "onPremisesTagSet": { + "target": "com.amazonaws.codedeploy#OnPremisesTagSet", + "traits": { + "smithy.api#documentation": "

Information about groups of tags applied to on-premises instances. The deployment\n group includes only on-premises instances identified by all of the tag groups. Cannot be\n used in the same call as onPremisesInstanceTagFilters.

" + } + }, + "tags": { + "target": "com.amazonaws.codedeploy#TagList", + "traits": { + "smithy.api#documentation": "

The metadata that you apply to CodeDeploy deployment groups to help you organize and\n categorize them. Each tag consists of a key and an optional value, both of which you\n define.

" + } + }, + "terminationHookEnabled": { + "target": "com.amazonaws.codedeploy#NullableBoolean", + "traits": { + "smithy.api#documentation": "

This parameter only applies if you are using CodeDeploy with Amazon EC2 Auto Scaling. For more information, see Integrating\n CodeDeploy with Amazon EC2 Auto Scaling in the CodeDeploy User Guide.

\n

Set terminationHookEnabled to true to have CodeDeploy install a termination hook into your Auto Scaling group when you create a\n deployment group. When this hook is installed, CodeDeploy will perform\n termination deployments.

\n

For information about termination deployments, see Enabling termination deployments during Auto Scaling scale-in events in the\n CodeDeploy User Guide.

\n

For more information about Auto Scaling scale-in events, see the Scale in topic in the Amazon EC2 Auto Scaling User\n Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a CreateDeploymentGroup operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.codedeploy#CreateDeploymentGroupOutput": { + "type": "structure", + "members": { + "deploymentGroupId": { + "target": "com.amazonaws.codedeploy#DeploymentGroupId", + "traits": { + "smithy.api#documentation": "

A unique deployment group ID.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a CreateDeploymentGroup operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.codedeploy#CreateDeploymentInput": { + "type": "structure", + "members": { + "applicationName": { + "target": "com.amazonaws.codedeploy#ApplicationName", + "traits": { + "smithy.api#documentation": "

The name of an CodeDeploy application associated with the user or Amazon Web Services account.

", + "smithy.api#required": {} + } + }, + "deploymentGroupName": { + "target": "com.amazonaws.codedeploy#DeploymentGroupName", + "traits": { + "smithy.api#documentation": "

The name of the deployment group.

" + } + }, + "revision": { + "target": "com.amazonaws.codedeploy#RevisionLocation", + "traits": { + "smithy.api#documentation": "

The type and location of the revision to deploy.

" + } + }, + "deploymentConfigName": { + "target": "com.amazonaws.codedeploy#DeploymentConfigName", + "traits": { + "smithy.api#documentation": "

The name of a deployment configuration associated with the user or Amazon Web Services account.

\n

If not specified, the value configured in the deployment group is used as the default.\n If the deployment group does not have a deployment configuration associated with it,\n CodeDeployDefault.OneAtATime is used by default.

" + } + }, + "description": { + "target": "com.amazonaws.codedeploy#Description", + "traits": { + "smithy.api#documentation": "

A comment about the deployment.

" + } + }, + "ignoreApplicationStopFailures": { + "target": "com.amazonaws.codedeploy#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

If true, then if an ApplicationStop, BeforeBlockTraffic, or\n AfterBlockTraffic deployment lifecycle event to an instance fails, then\n the deployment continues to the next deployment lifecycle event. For example, if\n ApplicationStop fails, the deployment continues with\n DownloadBundle. If BeforeBlockTraffic fails, the\n deployment continues with BlockTraffic. If AfterBlockTraffic\n fails, the deployment continues with ApplicationStop.

\n

If false or not specified, then if a lifecycle event fails during a deployment to an\n instance, that deployment fails. If deployment to that instance is part of an overall\n deployment and the number of healthy hosts is not less than the minimum number of\n healthy hosts, then a deployment to the next instance is attempted.

\n

During a deployment, the CodeDeploy agent runs the scripts specified for\n ApplicationStop, BeforeBlockTraffic, and\n AfterBlockTraffic in the AppSpec file from the previous successful\n deployment. (All other scripts are run from the AppSpec file in the current deployment.)\n If one of these scripts contains an error and does not run successfully, the deployment\n can fail.

\n

If the cause of the failure is a script from the last successful deployment that will\n never run successfully, create a new deployment and use\n ignoreApplicationStopFailures to specify that the\n ApplicationStop, BeforeBlockTraffic, and\n AfterBlockTraffic failures should be ignored.

" + } + }, + "targetInstances": { + "target": "com.amazonaws.codedeploy#TargetInstances", + "traits": { + "smithy.api#documentation": "

Information about the instances that belong to the replacement environment in a\n blue/green deployment.

" + } + }, + "autoRollbackConfiguration": { + "target": "com.amazonaws.codedeploy#AutoRollbackConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration information for an automatic rollback that is added when a deployment is\n created.

" + } + }, + "updateOutdatedInstancesOnly": { + "target": "com.amazonaws.codedeploy#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to deploy to all instances or only to instances that are not\n running the latest application revision.

" + } + }, + "fileExistsBehavior": { + "target": "com.amazonaws.codedeploy#FileExistsBehavior", + "traits": { + "smithy.api#documentation": "

Information about how CodeDeploy handles files that already exist in a\n deployment target location but weren't part of the previous successful\n deployment.

\n

The fileExistsBehavior parameter takes any of the following\n values:

\n " + } + }, + "overrideAlarmConfiguration": { + "target": "com.amazonaws.codedeploy#AlarmConfiguration", + "traits": { + "smithy.api#documentation": "

Allows you to specify information about alarms associated with a deployment. The alarm\n configuration that you specify here will override the alarm configuration at the\n deployment group level. Consider overriding the alarm configuration if you have set up\n alarms at the deployment group level that are causing deployment failures. In this case,\n you would call CreateDeployment to create a new deployment that uses a\n previous application revision that is known to work, and set its alarm configuration to\n turn off alarm polling. Turning off alarm polling ensures that the new deployment\n proceeds without being blocked by the alarm that was generated by the previous, failed,\n deployment.

\n \n

If you specify an overrideAlarmConfiguration, you need the\n UpdateDeploymentGroup\n IAM permission when calling CreateDeployment.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a CreateDeployment operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.codedeploy#CreateDeploymentOutput": { + "type": "structure", + "members": { + "deploymentId": { + "target": "com.amazonaws.codedeploy#DeploymentId", + "traits": { + "smithy.api#documentation": "

The unique ID of a deployment.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a CreateDeployment operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.codedeploy#DeleteApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.codedeploy#DeleteApplicationInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.codedeploy#ApplicationNameRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidApplicationNameException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidRoleException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an application.

" + } + }, + "com.amazonaws.codedeploy#DeleteApplicationInput": { + "type": "structure", + "members": { + "applicationName": { + "target": "com.amazonaws.codedeploy#ApplicationName", + "traits": { + "smithy.api#documentation": "

The name of an CodeDeploy application associated with the user or Amazon Web Services account.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a DeleteApplication operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.codedeploy#DeleteDeploymentConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.codedeploy#DeleteDeploymentConfigInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.codedeploy#DeploymentConfigInUseException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentConfigNameRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidDeploymentConfigNameException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a deployment configuration.

\n \n

A deployment configuration cannot be deleted if it is currently in use. Predefined\n configurations cannot be deleted.

\n " + } + }, + "com.amazonaws.codedeploy#DeleteDeploymentConfigInput": { + "type": "structure", + "members": { + "deploymentConfigName": { + "target": "com.amazonaws.codedeploy#DeploymentConfigName", + "traits": { + "smithy.api#documentation": "

The name of a deployment configuration associated with the user or Amazon Web Services account.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a DeleteDeploymentConfig operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.codedeploy#DeleteDeploymentGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.codedeploy#DeleteDeploymentGroupInput" + }, + "output": { + "target": "com.amazonaws.codedeploy#DeleteDeploymentGroupOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codedeploy#ApplicationNameRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentGroupNameRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidApplicationNameException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidDeploymentGroupNameException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidRoleException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a deployment group.

" + } + }, + "com.amazonaws.codedeploy#DeleteDeploymentGroupInput": { + "type": "structure", + "members": { + "applicationName": { + "target": "com.amazonaws.codedeploy#ApplicationName", + "traits": { + "smithy.api#documentation": "

The name of an CodeDeploy application associated with the user or Amazon Web Services account.

", + "smithy.api#required": {} + } + }, + "deploymentGroupName": { + "target": "com.amazonaws.codedeploy#DeploymentGroupName", + "traits": { + "smithy.api#documentation": "

The name of a deployment group for the specified application.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a DeleteDeploymentGroup operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.codedeploy#DeleteDeploymentGroupOutput": { + "type": "structure", + "members": { + "hooksNotCleanedUp": { + "target": "com.amazonaws.codedeploy#AutoScalingGroupList", + "traits": { + "smithy.api#documentation": "

If the output contains no data, and the corresponding deployment group contained at\n least one Auto Scaling group, CodeDeploy successfully removed all\n corresponding Auto Scaling lifecycle event hooks from the Amazon EC2\n instances in the Auto Scaling group. If the output contains data, CodeDeploy could not remove some Auto Scaling lifecycle event hooks from\n the Amazon EC2 instances in the Auto Scaling group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a DeleteDeploymentGroup operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.codedeploy#DeleteGitHubAccountToken": { + "type": "operation", + "input": { + "target": "com.amazonaws.codedeploy#DeleteGitHubAccountTokenInput" + }, + "output": { + "target": "com.amazonaws.codedeploy#DeleteGitHubAccountTokenOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codedeploy#GitHubAccountTokenDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#GitHubAccountTokenNameRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidGitHubAccountTokenNameException" + }, + { + "target": "com.amazonaws.codedeploy#OperationNotSupportedException" + }, + { + "target": "com.amazonaws.codedeploy#ResourceValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a GitHub account connection.

" + } + }, + "com.amazonaws.codedeploy#DeleteGitHubAccountTokenInput": { + "type": "structure", + "members": { + "tokenName": { + "target": "com.amazonaws.codedeploy#GitHubAccountTokenName", + "traits": { + "smithy.api#documentation": "

The name of the GitHub account connection to delete.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a DeleteGitHubAccount operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.codedeploy#DeleteGitHubAccountTokenOutput": { + "type": "structure", + "members": { + "tokenName": { + "target": "com.amazonaws.codedeploy#GitHubAccountTokenName", + "traits": { + "smithy.api#documentation": "

The name of the GitHub account connection that was deleted.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a DeleteGitHubAccountToken operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.codedeploy#DeleteResourcesByExternalId": { + "type": "operation", + "input": { + "target": "com.amazonaws.codedeploy#DeleteResourcesByExternalIdInput" + }, + "output": { + "target": "com.amazonaws.codedeploy#DeleteResourcesByExternalIdOutput" + }, + "traits": { + "smithy.api#documentation": "

Deletes resources linked to an external ID. This action only applies if you have\n configured blue/green deployments through CloudFormation.

\n \n

It is not necessary to call this action directly. CloudFormation calls it\n on your behalf when it needs to delete stack resources. This action is offered\n publicly in case you need to delete resources to comply with General Data Protection\n Regulation (GDPR) requirements.

\n " + } + }, + "com.amazonaws.codedeploy#DeleteResourcesByExternalIdInput": { + "type": "structure", + "members": { + "externalId": { + "target": "com.amazonaws.codedeploy#ExternalId", + "traits": { + "smithy.api#documentation": "

The unique ID of an external resource (for example, a CloudFormation stack\n ID) that is linked to one or more CodeDeploy resources.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codedeploy#DeleteResourcesByExternalIdOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.codedeploy#DeploymentAlreadyCompletedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The deployment is already complete.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#DeploymentConfigAlreadyExistsException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A deployment configuration with the specified name with the user or Amazon Web Services account already exists.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#DeploymentConfigDoesNotExistException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The deployment configuration does not exist with the user or Amazon Web Services account.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#DeploymentConfigId": { + "type": "string" + }, + "com.amazonaws.codedeploy#DeploymentConfigInUseException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The deployment configuration is still in use.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#DeploymentConfigInfo": { + "type": "structure", + "members": { + "deploymentConfigId": { + "target": "com.amazonaws.codedeploy#DeploymentConfigId", + "traits": { + "smithy.api#documentation": "

The deployment configuration ID.

" + } + }, + "deploymentConfigName": { + "target": "com.amazonaws.codedeploy#DeploymentConfigName", + "traits": { + "smithy.api#documentation": "

The deployment configuration name.

" + } + }, + "minimumHealthyHosts": { + "target": "com.amazonaws.codedeploy#MinimumHealthyHosts", + "traits": { + "smithy.api#documentation": "

Information about the number or percentage of minimum healthy instances.

" + } + }, + "createTime": { + "target": "com.amazonaws.codedeploy#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the deployment configuration was created.

" + } + }, + "computePlatform": { + "target": "com.amazonaws.codedeploy#ComputePlatform", + "traits": { + "smithy.api#documentation": "

The destination platform type for the deployment (Lambda,\n Server, or ECS).

" + } + }, + "trafficRoutingConfig": { + "target": "com.amazonaws.codedeploy#TrafficRoutingConfig", + "traits": { + "smithy.api#documentation": "

The configuration that specifies how the deployment traffic is routed. Used for\n deployments with a Lambda or Amazon ECS compute platform\n only.

" + } + }, + "zonalConfig": { + "target": "com.amazonaws.codedeploy#ZonalConfig", + "traits": { + "smithy.api#documentation": "

Information about a zonal configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a deployment configuration.

" + } + }, + "com.amazonaws.codedeploy#DeploymentConfigLimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The deployment configurations limit was exceeded.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#DeploymentConfigName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.codedeploy#DeploymentConfigNameRequiredException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The deployment configuration name was not specified.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#DeploymentConfigsList": { + "type": "list", + "member": { + "target": "com.amazonaws.codedeploy#DeploymentConfigName" + } + }, + "com.amazonaws.codedeploy#DeploymentCreator": { + "type": "enum", + "members": { + "User": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "user" + } + }, + "Autoscaling": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "autoscaling" + } + }, + "CodeDeployRollback": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "codeDeployRollback" + } + }, + "CodeDeploy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CodeDeploy" + } + }, + "CodeDeployAutoUpdate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CodeDeployAutoUpdate" + } + }, + "CloudFormation": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CloudFormation" + } + }, + "CloudFormationRollback": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CloudFormationRollback" + } + }, + "AutoscalingTermination": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "autoscalingTermination" + } + } + } + }, + "com.amazonaws.codedeploy#DeploymentDoesNotExistException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The deployment with the user or Amazon Web Services account does not exist.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#DeploymentGroupAlreadyExistsException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A deployment group with the specified name with the user or Amazon Web Services account\n already exists.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#DeploymentGroupDoesNotExistException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The named deployment group with the user or Amazon Web Services account does not\n exist.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#DeploymentGroupId": { + "type": "string" + }, + "com.amazonaws.codedeploy#DeploymentGroupInfo": { + "type": "structure", + "members": { + "applicationName": { + "target": "com.amazonaws.codedeploy#ApplicationName", + "traits": { + "smithy.api#documentation": "

The application name.

" + } + }, + "deploymentGroupId": { + "target": "com.amazonaws.codedeploy#DeploymentGroupId", + "traits": { + "smithy.api#documentation": "

The deployment group ID.

" + } + }, + "deploymentGroupName": { + "target": "com.amazonaws.codedeploy#DeploymentGroupName", + "traits": { + "smithy.api#documentation": "

The deployment group name.

" + } + }, + "deploymentConfigName": { + "target": "com.amazonaws.codedeploy#DeploymentConfigName", + "traits": { + "smithy.api#documentation": "

The deployment configuration name.

" + } + }, + "ec2TagFilters": { + "target": "com.amazonaws.codedeploy#EC2TagFilterList", + "traits": { + "smithy.api#documentation": "

The Amazon EC2 tags on which to filter. The deployment group includes EC2\n instances with any of the specified tags.

" + } + }, + "onPremisesInstanceTagFilters": { + "target": "com.amazonaws.codedeploy#TagFilterList", + "traits": { + "smithy.api#documentation": "

The on-premises instance tags on which to filter. The deployment group includes\n on-premises instances with any of the specified tags.

" + } + }, + "autoScalingGroups": { + "target": "com.amazonaws.codedeploy#AutoScalingGroupList", + "traits": { + "smithy.api#documentation": "

A list of associated Auto Scaling groups.

" + } + }, + "serviceRoleArn": { + "target": "com.amazonaws.codedeploy#Role", + "traits": { + "smithy.api#documentation": "

A service role Amazon Resource Name (ARN) that grants CodeDeploy permission to make\n calls to Amazon Web Services services on your behalf. For more information, see Create a\n Service Role for CodeDeploy in the CodeDeploy User Guide.

" + } + }, + "targetRevision": { + "target": "com.amazonaws.codedeploy#RevisionLocation", + "traits": { + "smithy.api#documentation": "

Information about the deployment group's target revision, including type and\n location.

" + } + }, + "triggerConfigurations": { + "target": "com.amazonaws.codedeploy#TriggerConfigList", + "traits": { + "smithy.api#documentation": "

Information about triggers associated with the deployment group.

" + } + }, + "alarmConfiguration": { + "target": "com.amazonaws.codedeploy#AlarmConfiguration", + "traits": { + "smithy.api#documentation": "

A list of alarms associated with the deployment group.

" + } + }, + "autoRollbackConfiguration": { + "target": "com.amazonaws.codedeploy#AutoRollbackConfiguration", + "traits": { + "smithy.api#documentation": "

Information about the automatic rollback configuration associated with the deployment\n group.

" + } + }, + "deploymentStyle": { + "target": "com.amazonaws.codedeploy#DeploymentStyle", + "traits": { + "smithy.api#documentation": "

Information about the type of deployment, either in-place or blue/green, you want to\n run and whether to route deployment traffic behind a load balancer.

" + } + }, + "outdatedInstancesStrategy": { + "target": "com.amazonaws.codedeploy#OutdatedInstancesStrategy", + "traits": { + "smithy.api#documentation": "

Indicates what happens when new Amazon EC2 instances are launched\n mid-deployment and do not receive the deployed application revision.

\n

If this option is set to UPDATE or is unspecified, CodeDeploy initiates\n one or more 'auto-update outdated instances' deployments to apply the deployed\n application revision to the new Amazon EC2 instances.

\n

If this option is set to IGNORE, CodeDeploy does not initiate a\n deployment to update the new Amazon EC2 instances. This may result in instances\n having different revisions.

" + } + }, + "blueGreenDeploymentConfiguration": { + "target": "com.amazonaws.codedeploy#BlueGreenDeploymentConfiguration", + "traits": { + "smithy.api#documentation": "

Information about blue/green deployment options for a deployment group.

" + } + }, + "loadBalancerInfo": { + "target": "com.amazonaws.codedeploy#LoadBalancerInfo", + "traits": { + "smithy.api#documentation": "

Information about the load balancer to use in a deployment.

" + } + }, + "lastSuccessfulDeployment": { + "target": "com.amazonaws.codedeploy#LastDeploymentInfo", + "traits": { + "smithy.api#documentation": "

Information about the most recent successful deployment to the deployment\n group.

" + } + }, + "lastAttemptedDeployment": { + "target": "com.amazonaws.codedeploy#LastDeploymentInfo", + "traits": { + "smithy.api#documentation": "

Information about the most recent attempted deployment to the deployment group.

" + } + }, + "ec2TagSet": { + "target": "com.amazonaws.codedeploy#EC2TagSet", + "traits": { + "smithy.api#documentation": "

Information about groups of tags applied to an Amazon EC2 instance. The\n deployment group includes only Amazon EC2 instances identified by all of the tag\n groups. Cannot be used in the same call as ec2TagFilters.

" + } + }, + "onPremisesTagSet": { + "target": "com.amazonaws.codedeploy#OnPremisesTagSet", + "traits": { + "smithy.api#documentation": "

Information about groups of tags applied to an on-premises instance. The deployment\n group includes only on-premises instances identified by all the tag groups. Cannot be\n used in the same call as onPremisesInstanceTagFilters.

" + } + }, + "computePlatform": { + "target": "com.amazonaws.codedeploy#ComputePlatform", + "traits": { + "smithy.api#documentation": "

The destination platform type for the deployment (Lambda,\n Server, or ECS).

" + } + }, + "ecsServices": { + "target": "com.amazonaws.codedeploy#ECSServiceList", + "traits": { + "smithy.api#documentation": "

The target Amazon ECS services in the deployment group. This applies only to\n deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name\n pair using the format :.

" + } + }, + "terminationHookEnabled": { + "target": "com.amazonaws.codedeploy#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the deployment group was configured to have CodeDeploy\n install a termination hook into an Auto Scaling group.

\n

For more information about the termination hook, see How Amazon EC2 Auto Scaling works with CodeDeploy in the\n CodeDeploy User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a deployment group.

" + } + }, + "com.amazonaws.codedeploy#DeploymentGroupInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.codedeploy#DeploymentGroupInfo" + } + }, + "com.amazonaws.codedeploy#DeploymentGroupLimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The deployment groups limit was exceeded.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#DeploymentGroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.codedeploy#DeploymentGroupNameRequiredException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The deployment group name was not specified.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#DeploymentGroupsList": { + "type": "list", + "member": { + "target": "com.amazonaws.codedeploy#DeploymentGroupName" + } + }, + "com.amazonaws.codedeploy#DeploymentId": { + "type": "string" + }, + "com.amazonaws.codedeploy#DeploymentIdRequiredException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

At least one deployment ID must be specified.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#DeploymentInfo": { + "type": "structure", + "members": { + "applicationName": { + "target": "com.amazonaws.codedeploy#ApplicationName", + "traits": { + "smithy.api#documentation": "

The application name.

" + } + }, + "deploymentGroupName": { + "target": "com.amazonaws.codedeploy#DeploymentGroupName", + "traits": { + "smithy.api#documentation": "

The deployment group name.

" + } + }, + "deploymentConfigName": { + "target": "com.amazonaws.codedeploy#DeploymentConfigName", + "traits": { + "smithy.api#documentation": "

The deployment configuration name.

" + } + }, + "deploymentId": { + "target": "com.amazonaws.codedeploy#DeploymentId", + "traits": { + "smithy.api#documentation": "

The unique ID of a deployment.

" + } + }, + "previousRevision": { + "target": "com.amazonaws.codedeploy#RevisionLocation", + "traits": { + "smithy.api#documentation": "

Information about the application revision that was deployed to the deployment group\n before the most recent successful deployment.

" + } + }, + "revision": { + "target": "com.amazonaws.codedeploy#RevisionLocation", + "traits": { + "smithy.api#documentation": "

Information about the location of stored application artifacts and the service from\n which to retrieve them.

" + } + }, + "status": { + "target": "com.amazonaws.codedeploy#DeploymentStatus", + "traits": { + "smithy.api#documentation": "

The current state of the deployment as a whole.

" + } + }, + "errorInformation": { + "target": "com.amazonaws.codedeploy#ErrorInformation", + "traits": { + "smithy.api#documentation": "

Information about any error associated with this deployment.

" + } + }, + "createTime": { + "target": "com.amazonaws.codedeploy#Timestamp", + "traits": { + "smithy.api#documentation": "

A timestamp that indicates when the deployment was created.

" + } + }, + "startTime": { + "target": "com.amazonaws.codedeploy#Timestamp", + "traits": { + "smithy.api#documentation": "

A timestamp that indicates when the deployment was deployed to the deployment\n group.

\n

In some cases, the reported value of the start time might be later than the complete\n time. This is due to differences in the clock settings of backend servers that\n participate in the deployment process.

" + } + }, + "completeTime": { + "target": "com.amazonaws.codedeploy#Timestamp", + "traits": { + "smithy.api#documentation": "

A timestamp that indicates when the deployment was complete.

" + } + }, + "deploymentOverview": { + "target": "com.amazonaws.codedeploy#DeploymentOverview", + "traits": { + "smithy.api#documentation": "

A summary of the deployment status of the instances in the deployment.

" + } + }, + "description": { + "target": "com.amazonaws.codedeploy#Description", + "traits": { + "smithy.api#documentation": "

A comment about the deployment.

" + } + }, + "creator": { + "target": "com.amazonaws.codedeploy#DeploymentCreator", + "traits": { + "smithy.api#documentation": "

The means by which the deployment was created:

\n " + } + }, + "ignoreApplicationStopFailures": { + "target": "com.amazonaws.codedeploy#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

If true, then if an ApplicationStop, BeforeBlockTraffic, or\n AfterBlockTraffic deployment lifecycle event to an instance fails, then\n the deployment continues to the next deployment lifecycle event. For example, if\n ApplicationStop fails, the deployment continues with DownloadBundle. If\n BeforeBlockTraffic fails, the deployment continues with\n BlockTraffic. If AfterBlockTraffic fails, the deployment\n continues with ApplicationStop.

\n

If false or not specified, then if a lifecycle event fails during a deployment to an\n instance, that deployment fails. If deployment to that instance is part of an overall\n deployment and the number of healthy hosts is not less than the minimum number of\n healthy hosts, then a deployment to the next instance is attempted.

\n

During a deployment, the CodeDeploy agent runs the scripts specified for\n ApplicationStop, BeforeBlockTraffic, and\n AfterBlockTraffic in the AppSpec file from the previous successful\n deployment. (All other scripts are run from the AppSpec file in the current deployment.)\n If one of these scripts contains an error and does not run successfully, the deployment\n can fail.

\n

If the cause of the failure is a script from the last successful deployment that will\n never run successfully, create a new deployment and use\n ignoreApplicationStopFailures to specify that the\n ApplicationStop, BeforeBlockTraffic, and\n AfterBlockTraffic failures should be ignored.

" + } + }, + "autoRollbackConfiguration": { + "target": "com.amazonaws.codedeploy#AutoRollbackConfiguration", + "traits": { + "smithy.api#documentation": "

Information about the automatic rollback configuration associated with the\n deployment.

" + } + }, + "updateOutdatedInstancesOnly": { + "target": "com.amazonaws.codedeploy#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether only instances that are not running the latest application revision\n are to be deployed to.

" + } + }, + "rollbackInfo": { + "target": "com.amazonaws.codedeploy#RollbackInfo", + "traits": { + "smithy.api#documentation": "

Information about a deployment rollback.

" + } + }, + "deploymentStyle": { + "target": "com.amazonaws.codedeploy#DeploymentStyle", + "traits": { + "smithy.api#documentation": "

Information about the type of deployment, either in-place or blue/green, you want to\n run and whether to route deployment traffic behind a load balancer.

" + } + }, + "targetInstances": { + "target": "com.amazonaws.codedeploy#TargetInstances", + "traits": { + "smithy.api#documentation": "

Information about the instances that belong to the replacement environment in a\n blue/green deployment.

" + } + }, + "instanceTerminationWaitTimeStarted": { + "target": "com.amazonaws.codedeploy#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the wait period set for the termination of instances in the original\n environment has started. Status is 'false' if the KEEP_ALIVE option is specified.\n Otherwise, 'true' as soon as the termination wait period starts.

" + } + }, + "blueGreenDeploymentConfiguration": { + "target": "com.amazonaws.codedeploy#BlueGreenDeploymentConfiguration", + "traits": { + "smithy.api#documentation": "

Information about blue/green deployment options for this deployment.

" + } + }, + "loadBalancerInfo": { + "target": "com.amazonaws.codedeploy#LoadBalancerInfo", + "traits": { + "smithy.api#documentation": "

Information about the load balancer used in the deployment.

" + } + }, + "additionalDeploymentStatusInfo": { + "target": "com.amazonaws.codedeploy#AdditionalDeploymentStatusInfo", + "traits": { + "smithy.api#documentation": "

Provides information about the results of a deployment, such as whether instances in\n the original environment in a blue/green deployment were not terminated.

" + } + }, + "fileExistsBehavior": { + "target": "com.amazonaws.codedeploy#FileExistsBehavior", + "traits": { + "smithy.api#documentation": "

Information about how CodeDeploy handles files that already exist in a\n deployment target location but weren't part of the previous successful\n deployment.

\n " + } + }, + "deploymentStatusMessages": { + "target": "com.amazonaws.codedeploy#DeploymentStatusMessageList", + "traits": { + "smithy.api#documentation": "

Messages that contain information about the status of a deployment.

" + } + }, + "computePlatform": { + "target": "com.amazonaws.codedeploy#ComputePlatform", + "traits": { + "smithy.api#documentation": "

The destination platform type for the deployment (Lambda,\n Server, or ECS).

" + } + }, + "externalId": { + "target": "com.amazonaws.codedeploy#ExternalId", + "traits": { + "smithy.api#documentation": "

The unique ID for an external resource (for example, a CloudFormation stack\n ID) that is linked to this deployment.

" + } + }, + "relatedDeployments": { + "target": "com.amazonaws.codedeploy#RelatedDeployments" + }, + "overrideAlarmConfiguration": { + "target": "com.amazonaws.codedeploy#AlarmConfiguration" + } + }, + "traits": { + "smithy.api#documentation": "

Information about a deployment.

" + } + }, + "com.amazonaws.codedeploy#DeploymentIsNotInReadyStateException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The deployment does not have a status of Ready and can't continue yet.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#DeploymentLimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The number of allowed deployments was exceeded.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#DeploymentNotStartedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The specified deployment has not started.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#DeploymentOption": { + "type": "enum", + "members": { + "WITH_TRAFFIC_CONTROL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WITH_TRAFFIC_CONTROL" + } + }, + "WITHOUT_TRAFFIC_CONTROL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WITHOUT_TRAFFIC_CONTROL" + } + } + } + }, + "com.amazonaws.codedeploy#DeploymentOverview": { + "type": "structure", + "members": { + "Pending": { + "target": "com.amazonaws.codedeploy#InstanceCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of instances in the deployment in a pending state.

" + } + }, + "InProgress": { + "target": "com.amazonaws.codedeploy#InstanceCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of instances in which the deployment is in progress.

" + } + }, + "Succeeded": { + "target": "com.amazonaws.codedeploy#InstanceCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of instances in the deployment to which revisions have been successfully\n deployed.

" + } + }, + "Failed": { + "target": "com.amazonaws.codedeploy#InstanceCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of instances in the deployment in a failed state.

" + } + }, + "Skipped": { + "target": "com.amazonaws.codedeploy#InstanceCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of instances in the deployment in a skipped state.

" + } + }, + "Ready": { + "target": "com.amazonaws.codedeploy#InstanceCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of instances in a replacement environment ready to receive traffic in a\n blue/green deployment.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the deployment status of the instances in the deployment.

" + } + }, + "com.amazonaws.codedeploy#DeploymentReadyAction": { + "type": "enum", + "members": { + "CONTINUE_DEPLOYMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTINUE_DEPLOYMENT" + } + }, + "STOP_DEPLOYMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOP_DEPLOYMENT" + } + } + } + }, + "com.amazonaws.codedeploy#DeploymentReadyOption": { + "type": "structure", + "members": { + "actionOnTimeout": { + "target": "com.amazonaws.codedeploy#DeploymentReadyAction", + "traits": { + "smithy.api#documentation": "

Information about when to reroute traffic from an original environment to a\n replacement environment in a blue/green deployment.

\n " + } + }, + "waitTimeInMinutes": { + "target": "com.amazonaws.codedeploy#Duration", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of minutes to wait before the status of a blue/green deployment is changed\n to Stopped if rerouting is not started manually. Applies only to the\n STOP_DEPLOYMENT option for actionOnTimeout.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about how traffic is rerouted to instances in a replacement environment in\n a blue/green deployment.

" + } + }, + "com.amazonaws.codedeploy#DeploymentStatus": { + "type": "enum", + "members": { + "CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Created" + } + }, + "QUEUED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Queued" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "BAKING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Baking" + } + }, + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Succeeded" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + }, + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ready" + } + } + } + }, + "com.amazonaws.codedeploy#DeploymentStatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.codedeploy#DeploymentStatus" + } + }, + "com.amazonaws.codedeploy#DeploymentStatusMessageList": { + "type": "list", + "member": { + "target": "com.amazonaws.codedeploy#ErrorMessage" + } + }, + "com.amazonaws.codedeploy#DeploymentStyle": { + "type": "structure", + "members": { + "deploymentType": { + "target": "com.amazonaws.codedeploy#DeploymentType", + "traits": { + "smithy.api#documentation": "

Indicates whether to run an in-place deployment or a blue/green deployment.

" + } + }, + "deploymentOption": { + "target": "com.amazonaws.codedeploy#DeploymentOption", + "traits": { + "smithy.api#documentation": "

Indicates whether to route deployment traffic behind a load balancer.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the type of deployment, either in-place or blue/green, you want to\n run and whether to route deployment traffic behind a load balancer.

" + } + }, + "com.amazonaws.codedeploy#DeploymentTarget": { + "type": "structure", + "members": { + "deploymentTargetType": { + "target": "com.amazonaws.codedeploy#DeploymentTargetType", + "traits": { + "smithy.api#documentation": "

The deployment type that is specific to the deployment's compute platform or\n deployments initiated by a CloudFormation stack update.

" + } + }, + "instanceTarget": { + "target": "com.amazonaws.codedeploy#InstanceTarget", + "traits": { + "smithy.api#documentation": "

Information about the target for a deployment that uses the EC2/On-premises compute\n platform.

" + } + }, + "lambdaTarget": { + "target": "com.amazonaws.codedeploy#LambdaTarget", + "traits": { + "smithy.api#documentation": "

Information about the target for a deployment that uses the Lambda\n compute platform.

" + } + }, + "ecsTarget": { + "target": "com.amazonaws.codedeploy#ECSTarget", + "traits": { + "smithy.api#documentation": "

Information about the target for a deployment that uses the Amazon ECS\n compute platform.

" + } + }, + "cloudFormationTarget": { + "target": "com.amazonaws.codedeploy#CloudFormationTarget" + } + }, + "traits": { + "smithy.api#documentation": "

Information about the deployment target.

" + } + }, + "com.amazonaws.codedeploy#DeploymentTargetDoesNotExistException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The provided target ID does not belong to the attempted deployment.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#DeploymentTargetIdRequiredException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A deployment target ID was not provided.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#DeploymentTargetList": { + "type": "list", + "member": { + "target": "com.amazonaws.codedeploy#DeploymentTarget" + } + }, + "com.amazonaws.codedeploy#DeploymentTargetListSizeExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The maximum number of targets that can be associated with an Amazon ECS or\n Lambda deployment was exceeded. The target list of both types of\n deployments must have exactly one item. This exception does not apply to EC2/On-premises\n deployments.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#DeploymentTargetType": { + "type": "enum", + "members": { + "INSTANCE_TARGET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InstanceTarget" + } + }, + "LAMBDA_TARGET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LambdaTarget" + } + }, + "ECS_TARGET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ECSTarget" + } + }, + "CLOUDFORMATION_TARGET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CloudFormationTarget" + } + } + } + }, + "com.amazonaws.codedeploy#DeploymentType": { + "type": "enum", + "members": { + "IN_PLACE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PLACE" + } + }, + "BLUE_GREEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BLUE_GREEN" + } + } + } + }, + "com.amazonaws.codedeploy#DeploymentWaitType": { + "type": "enum", + "members": { + "READY_WAIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY_WAIT" + } + }, + "TERMINATION_WAIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TERMINATION_WAIT" + } + } + } + }, + "com.amazonaws.codedeploy#DeploymentsInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.codedeploy#DeploymentInfo" + } + }, + "com.amazonaws.codedeploy#DeploymentsList": { + "type": "list", + "member": { + "target": "com.amazonaws.codedeploy#DeploymentId" + } + }, + "com.amazonaws.codedeploy#DeregisterOnPremisesInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.codedeploy#DeregisterOnPremisesInstanceInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.codedeploy#InstanceNameRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidInstanceNameException" + } + ], + "traits": { + "smithy.api#documentation": "

Deregisters an on-premises instance.

" + } + }, + "com.amazonaws.codedeploy#DeregisterOnPremisesInstanceInput": { + "type": "structure", + "members": { + "instanceName": { + "target": "com.amazonaws.codedeploy#InstanceName", + "traits": { + "smithy.api#documentation": "

The name of the on-premises instance to deregister.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a DeregisterOnPremisesInstance operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.codedeploy#Description": { + "type": "string" + }, + "com.amazonaws.codedeploy#DescriptionTooLongException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The description is too long.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#Diagnostics": { + "type": "structure", + "members": { + "errorCode": { + "target": "com.amazonaws.codedeploy#LifecycleErrorCode", + "traits": { + "smithy.api#documentation": "

The associated error code:

\n " + } + }, + "scriptName": { + "target": "com.amazonaws.codedeploy#ScriptName", + "traits": { + "smithy.api#documentation": "

The name of the script.

" + } + }, + "message": { + "target": "com.amazonaws.codedeploy#LifecycleMessage", + "traits": { + "smithy.api#documentation": "

The message associated with the error.

" + } + }, + "logTail": { + "target": "com.amazonaws.codedeploy#LogTail", + "traits": { + "smithy.api#documentation": "

The last portion of the diagnostic log.

\n

If available, CodeDeploy returns up to the last 4 KB of the diagnostic\n log.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Diagnostic information about executable scripts that are part of a deployment.

" + } + }, + "com.amazonaws.codedeploy#Duration": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.codedeploy#EC2TagFilter": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.codedeploy#Key", + "traits": { + "smithy.api#documentation": "

The tag filter key.

" + } + }, + "Value": { + "target": "com.amazonaws.codedeploy#Value", + "traits": { + "smithy.api#documentation": "

The tag filter value.

" + } + }, + "Type": { + "target": "com.amazonaws.codedeploy#EC2TagFilterType", + "traits": { + "smithy.api#documentation": "

The tag filter type:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an EC2 tag filter.

" + } + }, + "com.amazonaws.codedeploy#EC2TagFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.codedeploy#EC2TagFilter" + } + }, + "com.amazonaws.codedeploy#EC2TagFilterType": { + "type": "enum", + "members": { + "KEY_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KEY_ONLY" + } + }, + "VALUE_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALUE_ONLY" + } + }, + "KEY_AND_VALUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KEY_AND_VALUE" + } + } + } + }, + "com.amazonaws.codedeploy#EC2TagSet": { + "type": "structure", + "members": { + "ec2TagSetList": { + "target": "com.amazonaws.codedeploy#EC2TagSetList", + "traits": { + "smithy.api#documentation": "

A list that contains other lists of Amazon EC2 instance tag groups. For an\n instance to be included in the deployment group, it must be identified by all of the tag\n groups in the list.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about groups of Amazon EC2 instance tags.

" + } + }, + "com.amazonaws.codedeploy#EC2TagSetList": { + "type": "list", + "member": { + "target": "com.amazonaws.codedeploy#EC2TagFilterList" + } + }, + "com.amazonaws.codedeploy#ECSClusterName": { + "type": "string" + }, + "com.amazonaws.codedeploy#ECSService": { + "type": "structure", + "members": { + "serviceName": { + "target": "com.amazonaws.codedeploy#ECSServiceName", + "traits": { + "smithy.api#documentation": "

The name of the target Amazon ECS service.

" + } + }, + "clusterName": { + "target": "com.amazonaws.codedeploy#ECSClusterName", + "traits": { + "smithy.api#documentation": "

The name of the cluster that the Amazon ECS service is associated with.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the service and cluster names used to identify an Amazon ECS\n deployment's target.

" + } + }, + "com.amazonaws.codedeploy#ECSServiceList": { + "type": "list", + "member": { + "target": "com.amazonaws.codedeploy#ECSService" + } + }, + "com.amazonaws.codedeploy#ECSServiceMappingLimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon ECS service is associated with more than one deployment groups. An\n Amazon ECS service can be associated with only one deployment group.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#ECSServiceName": { + "type": "string" + }, + "com.amazonaws.codedeploy#ECSTarget": { + "type": "structure", + "members": { + "deploymentId": { + "target": "com.amazonaws.codedeploy#DeploymentId", + "traits": { + "smithy.api#documentation": "

The unique ID of a deployment.

" + } + }, + "targetId": { + "target": "com.amazonaws.codedeploy#TargetId", + "traits": { + "smithy.api#documentation": "

The unique ID of a deployment target that has a type of ecsTarget.\n

" + } + }, + "targetArn": { + "target": "com.amazonaws.codedeploy#TargetArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the target.

" + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.codedeploy#Time", + "traits": { + "smithy.api#documentation": "

The date and time when the target Amazon ECS application was updated by a\n deployment.

" + } + }, + "lifecycleEvents": { + "target": "com.amazonaws.codedeploy#LifecycleEventList", + "traits": { + "smithy.api#documentation": "

The lifecycle events of the deployment to this target Amazon ECS application.\n

" + } + }, + "status": { + "target": "com.amazonaws.codedeploy#TargetStatus", + "traits": { + "smithy.api#documentation": "

The status an Amazon ECS deployment's target ECS application.

" + } + }, + "taskSetsInfo": { + "target": "com.amazonaws.codedeploy#ECSTaskSetList", + "traits": { + "smithy.api#documentation": "

The ECSTaskSet objects associated with the ECS target.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the target of an Amazon ECS deployment.

" + } + }, + "com.amazonaws.codedeploy#ECSTaskSet": { + "type": "structure", + "members": { + "identifer": { + "target": "com.amazonaws.codedeploy#ECSTaskSetIdentifier", + "traits": { + "smithy.api#documentation": "

A unique ID of an ECSTaskSet.

" + } + }, + "desiredCount": { + "target": "com.amazonaws.codedeploy#ECSTaskSetCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of tasks in a task set. During a deployment that uses the Amazon ECS compute type, CodeDeploy instructs Amazon ECS to create a new task set and\n uses this value to determine how many tasks to create. After the updated task set is\n created, CodeDeploy shifts traffic to the new task set.

" + } + }, + "pendingCount": { + "target": "com.amazonaws.codedeploy#ECSTaskSetCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of tasks in the task set that are in the PENDING status\n during an Amazon ECS deployment. A task in the PENDING state is\n preparing to enter the RUNNING state. A task set enters the\n PENDING status when it launches for the first time, or when it is\n restarted after being in the STOPPED state.

" + } + }, + "runningCount": { + "target": "com.amazonaws.codedeploy#ECSTaskSetCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of tasks in the task set that are in the RUNNING status\n during an Amazon ECS deployment. A task in the RUNNING state is\n running and ready for use.

" + } + }, + "status": { + "target": "com.amazonaws.codedeploy#ECSTaskSetStatus", + "traits": { + "smithy.api#documentation": "

The status of the task set. There are three valid task set statuses:

\n " + } + }, + "trafficWeight": { + "target": "com.amazonaws.codedeploy#TrafficWeight", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The percentage of traffic served by this task set.

" + } + }, + "targetGroup": { + "target": "com.amazonaws.codedeploy#TargetGroupInfo", + "traits": { + "smithy.api#documentation": "

The target group associated with the task set. The target group is used by CodeDeploy to manage traffic to a task set.

" + } + }, + "taskSetLabel": { + "target": "com.amazonaws.codedeploy#TargetLabel", + "traits": { + "smithy.api#documentation": "

A label that identifies whether the ECS task set is an original target\n (BLUE) or a replacement target (GREEN).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a set of Amazon ECS tasks in an CodeDeploy\n deployment. An Amazon ECS task set includes details such as the desired number\n of tasks, how many tasks are running, and whether the task set serves production\n traffic. An CodeDeploy application that uses the Amazon ECS compute\n platform deploys a containerized application in an Amazon ECS service as a task\n set.

" + } + }, + "com.amazonaws.codedeploy#ECSTaskSetCount": { + "type": "long", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.codedeploy#ECSTaskSetIdentifier": { + "type": "string" + }, + "com.amazonaws.codedeploy#ECSTaskSetList": { + "type": "list", + "member": { + "target": "com.amazonaws.codedeploy#ECSTaskSet" + } + }, + "com.amazonaws.codedeploy#ECSTaskSetStatus": { + "type": "string" + }, + "com.amazonaws.codedeploy#ELBInfo": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.codedeploy#ELBName", + "traits": { + "smithy.api#documentation": "

For blue/green deployments, the name of the Classic Load Balancer that is used to\n route traffic from original instances to replacement instances in a blue/green\n deployment. For in-place deployments, the name of the Classic Load Balancer that\n instances are deregistered from so they are not serving traffic during a deployment, and\n then re-registered with after the deployment is complete.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a Classic Load Balancer in Elastic Load Balancing to use in a\n deployment. Instances are registered directly with a load balancer, and traffic is\n routed to the load balancer.

" + } + }, + "com.amazonaws.codedeploy#ELBInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.codedeploy#ELBInfo" + } + }, + "com.amazonaws.codedeploy#ELBName": { + "type": "string" + }, + "com.amazonaws.codedeploy#ETag": { + "type": "string" + }, + "com.amazonaws.codedeploy#ErrorCode": { + "type": "enum", + "members": { + "AGENT_ISSUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AGENT_ISSUE" + } + }, + "ALARM_ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALARM_ACTIVE" + } + }, + "APPLICATION_MISSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPLICATION_MISSING" + } + }, + "AUTOSCALING_VALIDATION_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTOSCALING_VALIDATION_ERROR" + } + }, + "AUTO_SCALING_CONFIGURATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO_SCALING_CONFIGURATION" + } + }, + "AUTO_SCALING_IAM_ROLE_PERMISSIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO_SCALING_IAM_ROLE_PERMISSIONS" + } + }, + "CODEDEPLOY_RESOURCE_CANNOT_BE_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CODEDEPLOY_RESOURCE_CANNOT_BE_FOUND" + } + }, + "CUSTOMER_APPLICATION_UNHEALTHY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOMER_APPLICATION_UNHEALTHY" + } + }, + "DEPLOYMENT_GROUP_MISSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEPLOYMENT_GROUP_MISSING" + } + }, + "ECS_UPDATE_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ECS_UPDATE_ERROR" + } + }, + "ELASTIC_LOAD_BALANCING_INVALID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ELASTIC_LOAD_BALANCING_INVALID" + } + }, + "ELB_INVALID_INSTANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ELB_INVALID_INSTANCE" + } + }, + "HEALTH_CONSTRAINTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HEALTH_CONSTRAINTS" + } + }, + "HEALTH_CONSTRAINTS_INVALID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HEALTH_CONSTRAINTS_INVALID" + } + }, + "HOOK_EXECUTION_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOOK_EXECUTION_FAILURE" + } + }, + "IAM_ROLE_MISSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM_ROLE_MISSING" + } + }, + "IAM_ROLE_PERMISSIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM_ROLE_PERMISSIONS" + } + }, + "INTERNAL_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_ERROR" + } + }, + "INVALID_ECS_SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_ECS_SERVICE" + } + }, + "INVALID_LAMBDA_CONFIGURATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_LAMBDA_CONFIGURATION" + } + }, + "INVALID_LAMBDA_FUNCTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_LAMBDA_FUNCTION" + } + }, + "INVALID_REVISION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_REVISION" + } + }, + "MANUAL_STOP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANUAL_STOP" + } + }, + "MISSING_BLUE_GREEN_DEPLOYMENT_CONFIGURATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MISSING_BLUE_GREEN_DEPLOYMENT_CONFIGURATION" + } + }, + "MISSING_ELB_INFORMATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MISSING_ELB_INFORMATION" + } + }, + "MISSING_GITHUB_TOKEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MISSING_GITHUB_TOKEN" + } + }, + "NO_EC2_SUBSCRIPTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_EC2_SUBSCRIPTION" + } + }, + "NO_INSTANCES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_INSTANCES" + } + }, + "OVER_MAX_INSTANCES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OVER_MAX_INSTANCES" + } + }, + "RESOURCE_LIMIT_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOURCE_LIMIT_EXCEEDED" + } + }, + "REVISION_MISSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REVISION_MISSING" + } + }, + "THROTTLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THROTTLED" + } + }, + "TIMEOUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIMEOUT" + } + }, + "CLOUDFORMATION_STACK_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLOUDFORMATION_STACK_FAILURE" + } + } + } + }, + "com.amazonaws.codedeploy#ErrorInformation": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.codedeploy#ErrorCode", + "traits": { + "smithy.api#documentation": "

For more information, see Error Codes for CodeDeploy in the CodeDeploy User Guide.

\n

The error code:

\n " + } + }, + "message": { + "target": "com.amazonaws.codedeploy#ErrorMessage", + "traits": { + "smithy.api#documentation": "

An accompanying error message.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a deployment error.

" + } + }, + "com.amazonaws.codedeploy#ErrorMessage": { + "type": "string" + }, + "com.amazonaws.codedeploy#ExternalId": { + "type": "string" + }, + "com.amazonaws.codedeploy#FileExistsBehavior": { + "type": "enum", + "members": { + "DISALLOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISALLOW" + } + }, + "OVERWRITE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OVERWRITE" + } + }, + "RETAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETAIN" + } + } + } + }, + "com.amazonaws.codedeploy#FilterValue": { + "type": "string" + }, + "com.amazonaws.codedeploy#FilterValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.codedeploy#FilterValue" + } + }, + "com.amazonaws.codedeploy#GenericRevisionInfo": { + "type": "structure", + "members": { + "description": { + "target": "com.amazonaws.codedeploy#Description", + "traits": { + "smithy.api#documentation": "

A comment about the revision.

" + } + }, + "deploymentGroups": { + "target": "com.amazonaws.codedeploy#DeploymentGroupsList", + "traits": { + "smithy.api#documentation": "

The deployment groups for which this is the current target revision.

" + } + }, + "firstUsedTime": { + "target": "com.amazonaws.codedeploy#Timestamp", + "traits": { + "smithy.api#documentation": "

When the revision was first used by CodeDeploy.

" + } + }, + "lastUsedTime": { + "target": "com.amazonaws.codedeploy#Timestamp", + "traits": { + "smithy.api#documentation": "

When the revision was last used by CodeDeploy.

" + } + }, + "registerTime": { + "target": "com.amazonaws.codedeploy#Timestamp", + "traits": { + "smithy.api#documentation": "

When the revision was registered with CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an application revision.

" + } + }, + "com.amazonaws.codedeploy#GetApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.codedeploy#GetApplicationInput" + }, + "output": { + "target": "com.amazonaws.codedeploy#GetApplicationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codedeploy#ApplicationDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#ApplicationNameRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidApplicationNameException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about an application.

" + } + }, + "com.amazonaws.codedeploy#GetApplicationInput": { + "type": "structure", + "members": { + "applicationName": { + "target": "com.amazonaws.codedeploy#ApplicationName", + "traits": { + "smithy.api#documentation": "

The name of an CodeDeploy application associated with the user or Amazon Web Services account.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a GetApplication operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.codedeploy#GetApplicationOutput": { + "type": "structure", + "members": { + "application": { + "target": "com.amazonaws.codedeploy#ApplicationInfo", + "traits": { + "smithy.api#documentation": "

Information about the application.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a GetApplication operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.codedeploy#GetApplicationRevision": { + "type": "operation", + "input": { + "target": "com.amazonaws.codedeploy#GetApplicationRevisionInput" + }, + "output": { + "target": "com.amazonaws.codedeploy#GetApplicationRevisionOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codedeploy#ApplicationDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#ApplicationNameRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidApplicationNameException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidRevisionException" + }, + { + "target": "com.amazonaws.codedeploy#RevisionDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#RevisionRequiredException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about an application revision.

" + } + }, + "com.amazonaws.codedeploy#GetApplicationRevisionInput": { + "type": "structure", + "members": { + "applicationName": { + "target": "com.amazonaws.codedeploy#ApplicationName", + "traits": { + "smithy.api#documentation": "

The name of the application that corresponds to the revision.

", + "smithy.api#required": {} + } + }, + "revision": { + "target": "com.amazonaws.codedeploy#RevisionLocation", + "traits": { + "smithy.api#documentation": "

Information about the application revision to get, including type and location.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a GetApplicationRevision operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.codedeploy#GetApplicationRevisionOutput": { + "type": "structure", + "members": { + "applicationName": { + "target": "com.amazonaws.codedeploy#ApplicationName", + "traits": { + "smithy.api#documentation": "

The name of the application that corresponds to the revision.

" + } + }, + "revision": { + "target": "com.amazonaws.codedeploy#RevisionLocation", + "traits": { + "smithy.api#documentation": "

Additional information about the revision, including type and location.

" + } + }, + "revisionInfo": { + "target": "com.amazonaws.codedeploy#GenericRevisionInfo", + "traits": { + "smithy.api#documentation": "

General information about the revision.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a GetApplicationRevision operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.codedeploy#GetDeployment": { + "type": "operation", + "input": { + "target": "com.amazonaws.codedeploy#GetDeploymentInput" + }, + "output": { + "target": "com.amazonaws.codedeploy#GetDeploymentOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codedeploy#DeploymentDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentIdRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidDeploymentIdException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about a deployment.

\n \n

The content property of the appSpecContent object in\n the returned revision is always null. Use GetApplicationRevision and\n the sha256 property of the returned appSpecContent object\n to get the content of the deployment’s AppSpec file.

\n ", + "smithy.waiters#waitable": { + "DeploymentSuccessful": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "deploymentInfo.status", + "expected": "Succeeded", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "deploymentInfo.status", + "expected": "Failed", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "deploymentInfo.status", + "expected": "Stopped", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 15 + } + } + } + }, + "com.amazonaws.codedeploy#GetDeploymentConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.codedeploy#GetDeploymentConfigInput" + }, + "output": { + "target": "com.amazonaws.codedeploy#GetDeploymentConfigOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codedeploy#DeploymentConfigDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentConfigNameRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidComputePlatformException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidDeploymentConfigNameException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about a deployment configuration.

" + } + }, + "com.amazonaws.codedeploy#GetDeploymentConfigInput": { + "type": "structure", + "members": { + "deploymentConfigName": { + "target": "com.amazonaws.codedeploy#DeploymentConfigName", + "traits": { + "smithy.api#documentation": "

The name of a deployment configuration associated with the user or Amazon Web Services account.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a GetDeploymentConfig operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.codedeploy#GetDeploymentConfigOutput": { + "type": "structure", + "members": { + "deploymentConfigInfo": { + "target": "com.amazonaws.codedeploy#DeploymentConfigInfo", + "traits": { + "smithy.api#documentation": "

Information about the deployment configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a GetDeploymentConfig operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.codedeploy#GetDeploymentGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.codedeploy#GetDeploymentGroupInput" + }, + "output": { + "target": "com.amazonaws.codedeploy#GetDeploymentGroupOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codedeploy#ApplicationDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#ApplicationNameRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentConfigDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentGroupDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentGroupNameRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidApplicationNameException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidDeploymentGroupNameException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about a deployment group.

" + } + }, + "com.amazonaws.codedeploy#GetDeploymentGroupInput": { + "type": "structure", + "members": { + "applicationName": { + "target": "com.amazonaws.codedeploy#ApplicationName", + "traits": { + "smithy.api#documentation": "

The name of an CodeDeploy application associated with the user or Amazon Web Services account.

", + "smithy.api#required": {} + } + }, + "deploymentGroupName": { + "target": "com.amazonaws.codedeploy#DeploymentGroupName", + "traits": { + "smithy.api#documentation": "

The name of a deployment group for the specified application.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a GetDeploymentGroup operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.codedeploy#GetDeploymentGroupOutput": { + "type": "structure", + "members": { + "deploymentGroupInfo": { + "target": "com.amazonaws.codedeploy#DeploymentGroupInfo", + "traits": { + "smithy.api#documentation": "

Information about the deployment group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a GetDeploymentGroup operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.codedeploy#GetDeploymentInput": { + "type": "structure", + "members": { + "deploymentId": { + "target": "com.amazonaws.codedeploy#DeploymentId", + "traits": { + "smithy.api#documentation": "

The unique ID of a deployment associated with the user or Amazon Web Services account.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a GetDeployment operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.codedeploy#GetDeploymentInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.codedeploy#GetDeploymentInstanceInput" + }, + "output": { + "target": "com.amazonaws.codedeploy#GetDeploymentInstanceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codedeploy#DeploymentDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentIdRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#InstanceDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#InstanceIdRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidComputePlatformException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidDeploymentIdException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidInstanceNameException" + } + ], + "traits": { + "smithy.api#deprecated": { + "message": "This operation is deprecated, use GetDeploymentTarget instead." + }, + "smithy.api#documentation": "

Gets information about an instance as part of a deployment.

" + } + }, + "com.amazonaws.codedeploy#GetDeploymentInstanceInput": { + "type": "structure", + "members": { + "deploymentId": { + "target": "com.amazonaws.codedeploy#DeploymentId", + "traits": { + "smithy.api#documentation": "

The unique ID of a deployment.

", + "smithy.api#required": {} + } + }, + "instanceId": { + "target": "com.amazonaws.codedeploy#InstanceId", + "traits": { + "smithy.api#documentation": "

The unique ID of an instance in the deployment group.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a GetDeploymentInstance operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.codedeploy#GetDeploymentInstanceOutput": { + "type": "structure", + "members": { + "instanceSummary": { + "target": "com.amazonaws.codedeploy#InstanceSummary", + "traits": { + "smithy.api#documentation": "

Information about the instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a GetDeploymentInstance operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.codedeploy#GetDeploymentOutput": { + "type": "structure", + "members": { + "deploymentInfo": { + "target": "com.amazonaws.codedeploy#DeploymentInfo", + "traits": { + "smithy.api#documentation": "

Information about the deployment.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a GetDeployment operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.codedeploy#GetDeploymentTarget": { + "type": "operation", + "input": { + "target": "com.amazonaws.codedeploy#GetDeploymentTargetInput" + }, + "output": { + "target": "com.amazonaws.codedeploy#GetDeploymentTargetOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codedeploy#DeploymentDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentIdRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentNotStartedException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentTargetDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentTargetIdRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidDeploymentIdException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidDeploymentTargetIdException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidInstanceNameException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a deployment target.

" + } + }, + "com.amazonaws.codedeploy#GetDeploymentTargetInput": { + "type": "structure", + "members": { + "deploymentId": { + "target": "com.amazonaws.codedeploy#DeploymentId", + "traits": { + "smithy.api#documentation": "

The unique ID of a deployment.

", + "smithy.api#required": {} + } + }, + "targetId": { + "target": "com.amazonaws.codedeploy#TargetId", + "traits": { + "smithy.api#documentation": "

The unique ID of a deployment target.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codedeploy#GetDeploymentTargetOutput": { + "type": "structure", + "members": { + "deploymentTarget": { + "target": "com.amazonaws.codedeploy#DeploymentTarget", + "traits": { + "smithy.api#documentation": "

A deployment target that contains information about a deployment such as its status,\n lifecycle events, and when it was last updated. It also contains metadata about the\n deployment target. The deployment target metadata depends on the deployment target's\n type (instanceTarget, lambdaTarget, or\n ecsTarget).

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.codedeploy#GetOnPremisesInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.codedeploy#GetOnPremisesInstanceInput" + }, + "output": { + "target": "com.amazonaws.codedeploy#GetOnPremisesInstanceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codedeploy#InstanceNameRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#InstanceNotRegisteredException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidInstanceNameException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about an on-premises instance.

" + } + }, + "com.amazonaws.codedeploy#GetOnPremisesInstanceInput": { + "type": "structure", + "members": { + "instanceName": { + "target": "com.amazonaws.codedeploy#InstanceName", + "traits": { + "smithy.api#documentation": "

The name of the on-premises instance about which to get information.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a GetOnPremisesInstance operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.codedeploy#GetOnPremisesInstanceOutput": { + "type": "structure", + "members": { + "instanceInfo": { + "target": "com.amazonaws.codedeploy#InstanceInfo", + "traits": { + "smithy.api#documentation": "

Information about the on-premises instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a GetOnPremisesInstance operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.codedeploy#GitHubAccountTokenDoesNotExistException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

No GitHub account connection exists with the named specified in the call.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#GitHubAccountTokenName": { + "type": "string" + }, + "com.amazonaws.codedeploy#GitHubAccountTokenNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.codedeploy#GitHubAccountTokenName" + } + }, + "com.amazonaws.codedeploy#GitHubAccountTokenNameRequiredException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The call is missing a required GitHub account connection name.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#GitHubLocation": { + "type": "structure", + "members": { + "repository": { + "target": "com.amazonaws.codedeploy#Repository", + "traits": { + "smithy.api#documentation": "

The GitHub account and repository pair that stores a reference to the commit that\n represents the bundled artifacts for the application revision.

\n

Specified as account/repository.

" + } + }, + "commitId": { + "target": "com.amazonaws.codedeploy#CommitId", + "traits": { + "smithy.api#documentation": "

The SHA1 commit ID of the GitHub commit that represents the bundled artifacts for the\n application revision.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the location of application artifacts stored in GitHub.

" + } + }, + "com.amazonaws.codedeploy#GreenFleetProvisioningAction": { + "type": "enum", + "members": { + "DISCOVER_EXISTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISCOVER_EXISTING" + } + }, + "COPY_AUTO_SCALING_GROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COPY_AUTO_SCALING_GROUP" + } + } + } + }, + "com.amazonaws.codedeploy#GreenFleetProvisioningOption": { + "type": "structure", + "members": { + "action": { + "target": "com.amazonaws.codedeploy#GreenFleetProvisioningAction", + "traits": { + "smithy.api#documentation": "

The method used to add instances to a replacement environment.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the instances that belong to the replacement environment in a\n blue/green deployment.

" + } + }, + "com.amazonaws.codedeploy#IamArnRequiredException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

No IAM ARN was included in the request. You must use an IAM session ARN or user ARN in the request.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#IamSessionArn": { + "type": "string" + }, + "com.amazonaws.codedeploy#IamSessionArnAlreadyRegisteredException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The request included an IAM session ARN that has already been used to\n register a different instance.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#IamUserArn": { + "type": "string" + }, + "com.amazonaws.codedeploy#IamUserArnAlreadyRegisteredException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The specified user ARN is already registered with an on-premises instance.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#IamUserArnRequiredException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An user ARN was not specified.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InstanceAction": { + "type": "enum", + "members": { + "TERMINATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TERMINATE" + } + }, + "KEEP_ALIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KEEP_ALIVE" + } + } + } + }, + "com.amazonaws.codedeploy#InstanceArn": { + "type": "string" + }, + "com.amazonaws.codedeploy#InstanceCount": { + "type": "long", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.codedeploy#InstanceDoesNotExistException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#deprecated": { + "message": "This exception is deprecated, use DeploymentTargetDoesNotExistException instead." + }, + "smithy.api#documentation": "

The specified instance does not exist in the deployment group.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InstanceId": { + "type": "string" + }, + "com.amazonaws.codedeploy#InstanceIdRequiredException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#deprecated": { + "message": "This exception is deprecated, use DeploymentTargetIdRequiredException instead." + }, + "smithy.api#documentation": "

The instance ID was not specified.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InstanceInfo": { + "type": "structure", + "members": { + "instanceName": { + "target": "com.amazonaws.codedeploy#InstanceName", + "traits": { + "smithy.api#documentation": "

The name of the on-premises instance.

" + } + }, + "iamSessionArn": { + "target": "com.amazonaws.codedeploy#IamSessionArn", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM session associated with the on-premises\n instance.

" + } + }, + "iamUserArn": { + "target": "com.amazonaws.codedeploy#IamUserArn", + "traits": { + "smithy.api#documentation": "

The user ARN associated with the on-premises instance.

" + } + }, + "instanceArn": { + "target": "com.amazonaws.codedeploy#InstanceArn", + "traits": { + "smithy.api#documentation": "

The ARN of the on-premises instance.

" + } + }, + "registerTime": { + "target": "com.amazonaws.codedeploy#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the on-premises instance was registered.

" + } + }, + "deregisterTime": { + "target": "com.amazonaws.codedeploy#Timestamp", + "traits": { + "smithy.api#documentation": "

If the on-premises instance was deregistered, the time at which the on-premises\n instance was deregistered.

" + } + }, + "tags": { + "target": "com.amazonaws.codedeploy#TagList", + "traits": { + "smithy.api#documentation": "

The tags currently associated with the on-premises instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an on-premises instance.

" + } + }, + "com.amazonaws.codedeploy#InstanceInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.codedeploy#InstanceInfo" + } + }, + "com.amazonaws.codedeploy#InstanceLimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The maximum number of allowed on-premises instances in a single call was\n exceeded.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InstanceName": { + "type": "string" + }, + "com.amazonaws.codedeploy#InstanceNameAlreadyRegisteredException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The specified on-premises instance name is already registered.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InstanceNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.codedeploy#InstanceName" + } + }, + "com.amazonaws.codedeploy#InstanceNameRequiredException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An on-premises instance name was not specified.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InstanceNotRegisteredException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The specified on-premises instance is not registered.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InstanceStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Succeeded" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "SKIPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Skipped" + } + }, + "UNKNOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Unknown" + } + }, + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ready" + } + } + }, + "traits": { + "smithy.api#deprecated": { + "message": "InstanceStatus is deprecated, use TargetStatus instead." + } + } + }, + "com.amazonaws.codedeploy#InstanceStatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.codedeploy#InstanceStatus" + } + }, + "com.amazonaws.codedeploy#InstanceSummary": { + "type": "structure", + "members": { + "deploymentId": { + "target": "com.amazonaws.codedeploy#DeploymentId", + "traits": { + "smithy.api#documentation": "

The unique ID of a deployment.

" + } + }, + "instanceId": { + "target": "com.amazonaws.codedeploy#InstanceId", + "traits": { + "smithy.api#documentation": "

The instance ID.

" + } + }, + "status": { + "target": "com.amazonaws.codedeploy#InstanceStatus", + "traits": { + "smithy.api#documentation": "

The deployment status for this instance:

\n " + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.codedeploy#Timestamp", + "traits": { + "smithy.api#documentation": "

A timestamp that indicates when the instance information was last updated.

" + } + }, + "lifecycleEvents": { + "target": "com.amazonaws.codedeploy#LifecycleEventList", + "traits": { + "smithy.api#documentation": "

A list of lifecycle events for this instance.

" + } + }, + "instanceType": { + "target": "com.amazonaws.codedeploy#InstanceType", + "traits": { + "smithy.api#documentation": "

Information about which environment an instance belongs to in a blue/green\n deployment.

\n " + } + } + }, + "traits": { + "smithy.api#deprecated": { + "message": "InstanceSummary is deprecated, use DeploymentTarget instead." + }, + "smithy.api#documentation": "

Information about an instance in a deployment.

" + } + }, + "com.amazonaws.codedeploy#InstanceSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.codedeploy#InstanceSummary" + } + }, + "com.amazonaws.codedeploy#InstanceTarget": { + "type": "structure", + "members": { + "deploymentId": { + "target": "com.amazonaws.codedeploy#DeploymentId", + "traits": { + "smithy.api#documentation": "

The unique ID of a deployment.

" + } + }, + "targetId": { + "target": "com.amazonaws.codedeploy#TargetId", + "traits": { + "smithy.api#documentation": "

The unique ID of a deployment target that has a type of instanceTarget.\n

" + } + }, + "targetArn": { + "target": "com.amazonaws.codedeploy#TargetArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the target.

" + } + }, + "status": { + "target": "com.amazonaws.codedeploy#TargetStatus", + "traits": { + "smithy.api#documentation": "

The status an EC2/On-premises deployment's target instance.

" + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.codedeploy#Time", + "traits": { + "smithy.api#documentation": "

The date and time when the target instance was updated by a deployment.

" + } + }, + "lifecycleEvents": { + "target": "com.amazonaws.codedeploy#LifecycleEventList", + "traits": { + "smithy.api#documentation": "

The lifecycle events of the deployment to this target instance.

" + } + }, + "instanceLabel": { + "target": "com.amazonaws.codedeploy#TargetLabel", + "traits": { + "smithy.api#documentation": "

A label that identifies whether the instance is an original target\n (BLUE) or a replacement target (GREEN).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A target Amazon EC2 or on-premises instance during a deployment that uses the\n EC2/On-premises compute platform.

" + } + }, + "com.amazonaws.codedeploy#InstanceType": { + "type": "enum", + "members": { + "BLUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Blue" + } + }, + "GREEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Green" + } + } + } + }, + "com.amazonaws.codedeploy#InstanceTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.codedeploy#InstanceType" + } + }, + "com.amazonaws.codedeploy#InstancesList": { + "type": "list", + "member": { + "target": "com.amazonaws.codedeploy#InstanceId" + } + }, + "com.amazonaws.codedeploy#InvalidAlarmConfigException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The format of the alarm configuration is invalid. Possible causes include:

\n ", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidApplicationNameException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The application name was specified in an invalid format.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidArnException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The specified ARN is not in a valid format.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidAutoRollbackConfigException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The automatic rollback configuration was specified in an invalid format. For example,\n automatic rollback is enabled, but an invalid triggering event type or no event types\n were listed.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidAutoScalingGroupException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Auto Scaling group was specified in an invalid format or does not\n exist.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidBlueGreenDeploymentConfigurationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for the blue/green deployment group was provided in an invalid\n format. For information about deployment configuration format, see CreateDeploymentConfig.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidBucketNameFilterException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The bucket name either doesn't exist or was specified in an invalid format.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidComputePlatformException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The computePlatform is invalid. The computePlatform should be Lambda, Server, or ECS.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidDeployedStateFilterException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The deployed state filter was specified in an invalid format.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidDeploymentConfigNameException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The deployment configuration name was specified in an invalid format.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidDeploymentGroupNameException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The deployment group name was specified in an invalid format.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidDeploymentIdException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

At least one of the deployment IDs was specified in an invalid format.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidDeploymentInstanceTypeException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An instance type was specified for an in-place deployment. Instance types are\n supported for blue/green deployments only.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidDeploymentStatusException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The specified deployment status doesn't exist or cannot be determined.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidDeploymentStyleException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An invalid deployment style was specified. Valid deployment types include \"IN_PLACE\"\n and \"BLUE_GREEN.\" Valid deployment options include \"WITH_TRAFFIC_CONTROL\" and\n \"WITHOUT_TRAFFIC_CONTROL.\"

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidDeploymentTargetIdException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The target ID provided was not valid.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidDeploymentWaitTypeException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The wait type is invalid.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidEC2TagCombinationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A call was submitted that specified both Ec2TagFilters and Ec2TagSet, but only one of\n these data types can be used in a single call.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidEC2TagException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The tag was specified in an invalid format.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidECSServiceException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon ECS service identifier is not valid.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidExternalIdException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The external ID was specified in an invalid format.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidFileExistsBehaviorException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An invalid fileExistsBehavior option was specified to determine how CodeDeploy handles files or directories that already exist in a deployment\n target location, but weren't part of the previous successful deployment. Valid values\n include \"DISALLOW,\" \"OVERWRITE,\" and \"RETAIN.\"

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidGitHubAccountTokenException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The GitHub token is not valid.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidGitHubAccountTokenNameException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The format of the specified GitHub account connection name is invalid.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidIamSessionArnException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The IAM session ARN was specified in an invalid format.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidIamUserArnException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The user ARN was specified in an invalid format.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidIgnoreApplicationStopFailuresValueException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The IgnoreApplicationStopFailures value is invalid. For Lambda\n deployments, false is expected. For EC2/On-premises deployments,\n true or false is expected.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidInputException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The input was specified in an invalid format.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidInstanceNameException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The on-premises instance name was specified in an invalid format.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidInstanceStatusException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The specified instance status does not exist.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidInstanceTypeException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An invalid instance type was specified for instances in a blue/green deployment. Valid\n values include \"Blue\" for an original environment and \"Green\" for a replacement\n environment.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidKeyPrefixFilterException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The specified key prefix filter was specified in an invalid format.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidLifecycleEventHookExecutionIdException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A lifecycle event hook is invalid. Review the hooks section in your\n AppSpec file to ensure the lifecycle events and hooks functions are\n valid.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidLifecycleEventHookExecutionStatusException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The result of a Lambda validation function that verifies a lifecycle event\n is invalid. It should return Succeeded or Failed.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidLoadBalancerInfoException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An invalid load balancer name, or no load balancer name, was specified.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidMinimumHealthyHostValueException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum healthy instance value was specified in an invalid format.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidNextTokenException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The next token was specified in an invalid format.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidOnPremisesTagCombinationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A call was submitted that specified both OnPremisesTagFilters and OnPremisesTagSet,\n but only one of these data types can be used in a single call.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidOperationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An invalid operation was detected.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidRegistrationStatusException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The registration status was specified in an invalid format.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidRevisionException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The revision was specified in an invalid format.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidRoleException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The service role ARN was specified in an invalid format. Or, if an Auto Scaling\n group was specified, the specified service role does not grant the appropriate\n permissions to Amazon EC2 Auto Scaling.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidSortByException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The column name to sort by is either not present or was specified in an invalid\n format.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidSortOrderException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The sort order was specified in an invalid format.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidTagException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The tag was specified in an invalid format.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidTagFilterException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The tag filter was specified in an invalid format.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidTagsToAddException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The specified tags are not valid.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidTargetFilterNameException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The target filter name is invalid.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidTargetGroupPairException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A target group pair associated with this deployment is not valid.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidTargetInstancesException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The target instance configuration is invalid. Possible causes include:

\n ", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidTimeRangeException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The specified time range was specified in an invalid format.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidTrafficRoutingConfigurationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration that specifies how traffic is routed during a deployment is\n invalid.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidTriggerConfigException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The trigger was specified in an invalid format.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidUpdateOutdatedInstancesOnlyValueException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The UpdateOutdatedInstancesOnly value is invalid. For Lambda\n deployments, false is expected. For EC2/On-premises deployments,\n true or false is expected.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#InvalidZonalDeploymentConfigurationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The ZonalConfig object is not valid.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#Key": { + "type": "string" + }, + "com.amazonaws.codedeploy#LambdaFunctionAlias": { + "type": "string" + }, + "com.amazonaws.codedeploy#LambdaFunctionInfo": { + "type": "structure", + "members": { + "functionName": { + "target": "com.amazonaws.codedeploy#LambdaFunctionName", + "traits": { + "smithy.api#documentation": "

The name of a Lambda function.

" + } + }, + "functionAlias": { + "target": "com.amazonaws.codedeploy#LambdaFunctionAlias", + "traits": { + "smithy.api#documentation": "

The alias of a Lambda function. For more information, see Lambda Function Aliases in the Lambda Developer\n Guide.

" + } + }, + "currentVersion": { + "target": "com.amazonaws.codedeploy#Version", + "traits": { + "smithy.api#documentation": "

The version of a Lambda function that production traffic points to.\n

" + } + }, + "targetVersion": { + "target": "com.amazonaws.codedeploy#Version", + "traits": { + "smithy.api#documentation": "

The version of a Lambda function that production traffic points to after\n the Lambda function is deployed.

" + } + }, + "targetVersionWeight": { + "target": "com.amazonaws.codedeploy#TrafficWeight", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The percentage of production traffic that the target version of a Lambda\n function receives.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a Lambda function specified in a deployment.

" + } + }, + "com.amazonaws.codedeploy#LambdaFunctionName": { + "type": "string" + }, + "com.amazonaws.codedeploy#LambdaTarget": { + "type": "structure", + "members": { + "deploymentId": { + "target": "com.amazonaws.codedeploy#DeploymentId", + "traits": { + "smithy.api#documentation": "

The unique ID of a deployment.

" + } + }, + "targetId": { + "target": "com.amazonaws.codedeploy#TargetId", + "traits": { + "smithy.api#documentation": "

The unique ID of a deployment target that has a type of lambdaTarget.\n

" + } + }, + "targetArn": { + "target": "com.amazonaws.codedeploy#TargetArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the target.

" + } + }, + "status": { + "target": "com.amazonaws.codedeploy#TargetStatus", + "traits": { + "smithy.api#documentation": "

The status an Lambda deployment's target Lambda function.\n

" + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.codedeploy#Time", + "traits": { + "smithy.api#documentation": "

The date and time when the target Lambda function was updated by a\n deployment.

" + } + }, + "lifecycleEvents": { + "target": "com.amazonaws.codedeploy#LifecycleEventList", + "traits": { + "smithy.api#documentation": "

The lifecycle events of the deployment to this target Lambda function.\n

" + } + }, + "lambdaFunctionInfo": { + "target": "com.amazonaws.codedeploy#LambdaFunctionInfo", + "traits": { + "smithy.api#documentation": "

A LambdaFunctionInfo object that describes a target Lambda\n function.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the target Lambda function during an Lambda deployment.

" + } + }, + "com.amazonaws.codedeploy#LastDeploymentInfo": { + "type": "structure", + "members": { + "deploymentId": { + "target": "com.amazonaws.codedeploy#DeploymentId", + "traits": { + "smithy.api#documentation": "

The unique ID of a deployment.

" + } + }, + "status": { + "target": "com.amazonaws.codedeploy#DeploymentStatus", + "traits": { + "smithy.api#documentation": "

The status of the most recent deployment.

" + } + }, + "endTime": { + "target": "com.amazonaws.codedeploy#Timestamp", + "traits": { + "smithy.api#documentation": "

A timestamp that indicates when the most recent deployment to the deployment group was\n complete.

" + } + }, + "createTime": { + "target": "com.amazonaws.codedeploy#Timestamp", + "traits": { + "smithy.api#documentation": "

A timestamp that indicates when the most recent deployment to the deployment group\n started.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the most recent attempted or successful deployment to a deployment\n group.

" + } + }, + "com.amazonaws.codedeploy#LifecycleErrorCode": { + "type": "enum", + "members": { + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Success" + } + }, + "SCRIPT_MISSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ScriptMissing" + } + }, + "SCRIPT_NOT_EXECUTABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ScriptNotExecutable" + } + }, + "SCRIPT_TIMED_OUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ScriptTimedOut" + } + }, + "SCRIPT_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ScriptFailed" + } + }, + "UNKNOWN_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UnknownError" + } + } + } + }, + "com.amazonaws.codedeploy#LifecycleEvent": { + "type": "structure", + "members": { + "lifecycleEventName": { + "target": "com.amazonaws.codedeploy#LifecycleEventName", + "traits": { + "smithy.api#documentation": "

The deployment lifecycle event name, such as ApplicationStop,\n BeforeInstall, AfterInstall,\n ApplicationStart, or ValidateService.

" + } + }, + "diagnostics": { + "target": "com.amazonaws.codedeploy#Diagnostics", + "traits": { + "smithy.api#documentation": "

Diagnostic information about the deployment lifecycle event.

" + } + }, + "startTime": { + "target": "com.amazonaws.codedeploy#Timestamp", + "traits": { + "smithy.api#documentation": "

A timestamp that indicates when the deployment lifecycle event started.

" + } + }, + "endTime": { + "target": "com.amazonaws.codedeploy#Timestamp", + "traits": { + "smithy.api#documentation": "

A timestamp that indicates when the deployment lifecycle event ended.

" + } + }, + "status": { + "target": "com.amazonaws.codedeploy#LifecycleEventStatus", + "traits": { + "smithy.api#documentation": "

The deployment lifecycle event status:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a deployment lifecycle event.

" + } + }, + "com.amazonaws.codedeploy#LifecycleEventAlreadyCompletedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An attempt to return the status of an already completed lifecycle event\n occurred.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#LifecycleEventHookExecutionId": { + "type": "string" + }, + "com.amazonaws.codedeploy#LifecycleEventList": { + "type": "list", + "member": { + "target": "com.amazonaws.codedeploy#LifecycleEvent" + } + }, + "com.amazonaws.codedeploy#LifecycleEventName": { + "type": "string" + }, + "com.amazonaws.codedeploy#LifecycleEventStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Succeeded" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "SKIPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Skipped" + } + }, + "UNKNOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Unknown" + } + } + } + }, + "com.amazonaws.codedeploy#LifecycleHookLimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The limit for lifecycle hooks was exceeded.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#LifecycleMessage": { + "type": "string" + }, + "com.amazonaws.codedeploy#ListApplicationRevisions": { + "type": "operation", + "input": { + "target": "com.amazonaws.codedeploy#ListApplicationRevisionsInput" + }, + "output": { + "target": "com.amazonaws.codedeploy#ListApplicationRevisionsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codedeploy#ApplicationDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#ApplicationNameRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#BucketNameFilterRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidApplicationNameException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidBucketNameFilterException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidDeployedStateFilterException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidKeyPrefixFilterException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidSortByException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidSortOrderException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists information about revisions for an application.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "revisions" + } + } + }, + "com.amazonaws.codedeploy#ListApplicationRevisionsInput": { + "type": "structure", + "members": { + "applicationName": { + "target": "com.amazonaws.codedeploy#ApplicationName", + "traits": { + "smithy.api#documentation": "

The name of an CodeDeploy application associated with the user or Amazon Web Services account.

", + "smithy.api#required": {} + } + }, + "sortBy": { + "target": "com.amazonaws.codedeploy#ApplicationRevisionSortBy", + "traits": { + "smithy.api#documentation": "

The column name to use to sort the list results:

\n \n

If not specified or set to null, the results are returned in an arbitrary order.\n

" + } + }, + "sortOrder": { + "target": "com.amazonaws.codedeploy#SortOrder", + "traits": { + "smithy.api#documentation": "

The order in which to sort the list results:

\n \n

If not specified, the results are sorted in ascending order.

\n

If set to null, the results are sorted in an arbitrary order.

" + } + }, + "s3Bucket": { + "target": "com.amazonaws.codedeploy#S3Bucket", + "traits": { + "smithy.api#documentation": "

An Amazon S3 bucket name to limit the search for revisions.

\n

If set to null, all of the user's buckets are searched.

" + } + }, + "s3KeyPrefix": { + "target": "com.amazonaws.codedeploy#S3Key", + "traits": { + "smithy.api#documentation": "

A key prefix for the set of Amazon S3 objects to limit the search for\n revisions.

" + } + }, + "deployed": { + "target": "com.amazonaws.codedeploy#ListStateFilterAction", + "traits": { + "smithy.api#documentation": "

Whether to list revisions based on whether the revision is the target revision of a\n deployment group:

\n " + } + }, + "nextToken": { + "target": "com.amazonaws.codedeploy#NextToken", + "traits": { + "smithy.api#documentation": "

An identifier returned from the previous ListApplicationRevisions call.\n It can be used to return the next set of applications in the list.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a ListApplicationRevisions operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.codedeploy#ListApplicationRevisionsOutput": { + "type": "structure", + "members": { + "revisions": { + "target": "com.amazonaws.codedeploy#RevisionLocationList", + "traits": { + "smithy.api#documentation": "

A list of locations that contain the matching revisions.

" + } + }, + "nextToken": { + "target": "com.amazonaws.codedeploy#NextToken", + "traits": { + "smithy.api#documentation": "

If a large amount of information is returned, an identifier is also returned. It can\n be used in a subsequent list application revisions call to return the next set of\n application revisions in the list.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a ListApplicationRevisions operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.codedeploy#ListApplications": { + "type": "operation", + "input": { + "target": "com.amazonaws.codedeploy#ListApplicationsInput" + }, + "output": { + "target": "com.amazonaws.codedeploy#ListApplicationsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codedeploy#InvalidNextTokenException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the applications registered with the user or Amazon Web Services account.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "applications" + }, + "smithy.test#smokeTests": [ + { + "id": "ListApplicationsSuccess", + "params": {}, + "vendorParams": { + "region": "us-west-2" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "success": {} + } + } + ] + } + }, + "com.amazonaws.codedeploy#ListApplicationsInput": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.codedeploy#NextToken", + "traits": { + "smithy.api#documentation": "

An identifier returned from the previous list applications call. It can be used to\n return the next set of applications in the list.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a ListApplications operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.codedeploy#ListApplicationsOutput": { + "type": "structure", + "members": { + "applications": { + "target": "com.amazonaws.codedeploy#ApplicationsList", + "traits": { + "smithy.api#documentation": "

A list of application names.

" + } + }, + "nextToken": { + "target": "com.amazonaws.codedeploy#NextToken", + "traits": { + "smithy.api#documentation": "

If a large amount of information is returned, an identifier is also returned. It can\n be used in a subsequent list applications call to return the next set of applications in\n the list.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a ListApplications operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.codedeploy#ListDeploymentConfigs": { + "type": "operation", + "input": { + "target": "com.amazonaws.codedeploy#ListDeploymentConfigsInput" + }, + "output": { + "target": "com.amazonaws.codedeploy#ListDeploymentConfigsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codedeploy#InvalidNextTokenException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the deployment configurations with the user or Amazon Web Services account.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "deploymentConfigsList" + } + } + }, + "com.amazonaws.codedeploy#ListDeploymentConfigsInput": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.codedeploy#NextToken", + "traits": { + "smithy.api#documentation": "

An identifier returned from the previous ListDeploymentConfigs call. It\n can be used to return the next set of deployment configurations in the list.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a ListDeploymentConfigs operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.codedeploy#ListDeploymentConfigsOutput": { + "type": "structure", + "members": { + "deploymentConfigsList": { + "target": "com.amazonaws.codedeploy#DeploymentConfigsList", + "traits": { + "smithy.api#documentation": "

A list of deployment configurations, including built-in configurations such as\n CodeDeployDefault.OneAtATime.

" + } + }, + "nextToken": { + "target": "com.amazonaws.codedeploy#NextToken", + "traits": { + "smithy.api#documentation": "

If a large amount of information is returned, an identifier is also returned. It can\n be used in a subsequent list deployment configurations call to return the next set of\n deployment configurations in the list.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a ListDeploymentConfigs operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.codedeploy#ListDeploymentGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.codedeploy#ListDeploymentGroupsInput" + }, + "output": { + "target": "com.amazonaws.codedeploy#ListDeploymentGroupsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codedeploy#ApplicationDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#ApplicationNameRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidApplicationNameException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidNextTokenException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the deployment groups for an application registered with the Amazon Web Services\n user or Amazon Web Services account.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "deploymentGroups" + } + } + }, + "com.amazonaws.codedeploy#ListDeploymentGroupsInput": { + "type": "structure", + "members": { + "applicationName": { + "target": "com.amazonaws.codedeploy#ApplicationName", + "traits": { + "smithy.api#documentation": "

The name of an CodeDeploy application associated with the user or Amazon Web Services account.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.codedeploy#NextToken", + "traits": { + "smithy.api#documentation": "

An identifier returned from the previous list deployment groups call. It can be used\n to return the next set of deployment groups in the list.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a ListDeploymentGroups operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.codedeploy#ListDeploymentGroupsOutput": { + "type": "structure", + "members": { + "applicationName": { + "target": "com.amazonaws.codedeploy#ApplicationName", + "traits": { + "smithy.api#documentation": "

The application name.

" + } + }, + "deploymentGroups": { + "target": "com.amazonaws.codedeploy#DeploymentGroupsList", + "traits": { + "smithy.api#documentation": "

A list of deployment group names.

" + } + }, + "nextToken": { + "target": "com.amazonaws.codedeploy#NextToken", + "traits": { + "smithy.api#documentation": "

If a large amount of information is returned, an identifier is also returned. It can\n be used in a subsequent list deployment groups call to return the next set of deployment\n groups in the list.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a ListDeploymentGroups operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.codedeploy#ListDeploymentInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.codedeploy#ListDeploymentInstancesInput" + }, + "output": { + "target": "com.amazonaws.codedeploy#ListDeploymentInstancesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codedeploy#DeploymentDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentIdRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentNotStartedException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidComputePlatformException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidDeploymentIdException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidDeploymentInstanceTypeException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidInstanceStatusException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidInstanceTypeException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidTargetFilterNameException" + } + ], + "traits": { + "smithy.api#deprecated": { + "message": "This operation is deprecated, use ListDeploymentTargets instead." + }, + "smithy.api#documentation": "\n

The newer BatchGetDeploymentTargets should be used instead because\n it works with all compute types. ListDeploymentInstances throws an\n exception if it is used with a compute platform other than EC2/On-premises or\n Lambda.

\n \n

Lists the instance for a deployment associated with the user or Amazon Web Services account.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "instancesList" + } + } + }, + "com.amazonaws.codedeploy#ListDeploymentInstancesInput": { + "type": "structure", + "members": { + "deploymentId": { + "target": "com.amazonaws.codedeploy#DeploymentId", + "traits": { + "smithy.api#documentation": "

The unique ID of a deployment.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.codedeploy#NextToken", + "traits": { + "smithy.api#documentation": "

An identifier returned from the previous list deployment instances call. It can be\n used to return the next set of deployment instances in the list.

" + } + }, + "instanceStatusFilter": { + "target": "com.amazonaws.codedeploy#InstanceStatusList", + "traits": { + "smithy.api#documentation": "

A subset of instances to list by status:

\n " + } + }, + "instanceTypeFilter": { + "target": "com.amazonaws.codedeploy#InstanceTypeList", + "traits": { + "smithy.api#documentation": "

The set of instances in a blue/green deployment, either those in the original\n environment (\"BLUE\") or those in the replacement environment (\"GREEN\"), for which you\n want to view instance information.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a ListDeploymentInstances operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.codedeploy#ListDeploymentInstancesOutput": { + "type": "structure", + "members": { + "instancesList": { + "target": "com.amazonaws.codedeploy#InstancesList", + "traits": { + "smithy.api#documentation": "

A list of instance IDs.

" + } + }, + "nextToken": { + "target": "com.amazonaws.codedeploy#NextToken", + "traits": { + "smithy.api#documentation": "

If a large amount of information is returned, an identifier is also returned. It can\n be used in a subsequent list deployment instances call to return the next set of\n deployment instances in the list.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a ListDeploymentInstances operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.codedeploy#ListDeploymentTargets": { + "type": "operation", + "input": { + "target": "com.amazonaws.codedeploy#ListDeploymentTargetsInput" + }, + "output": { + "target": "com.amazonaws.codedeploy#ListDeploymentTargetsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codedeploy#DeploymentDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentIdRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentNotStartedException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidDeploymentIdException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidDeploymentInstanceTypeException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidInstanceStatusException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidInstanceTypeException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidTargetFilterNameException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns an array of target IDs that are associated a deployment.

" + } + }, + "com.amazonaws.codedeploy#ListDeploymentTargetsInput": { + "type": "structure", + "members": { + "deploymentId": { + "target": "com.amazonaws.codedeploy#DeploymentId", + "traits": { + "smithy.api#documentation": "

The unique ID of a deployment.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.codedeploy#NextToken", + "traits": { + "smithy.api#documentation": "

A token identifier returned from the previous ListDeploymentTargets\n call. It can be used to return the next set of deployment targets in the list.

" + } + }, + "targetFilters": { + "target": "com.amazonaws.codedeploy#TargetFilters", + "traits": { + "smithy.api#documentation": "

A key used to filter the returned targets. The two valid values are:

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codedeploy#ListDeploymentTargetsOutput": { + "type": "structure", + "members": { + "targetIds": { + "target": "com.amazonaws.codedeploy#TargetIdList", + "traits": { + "smithy.api#documentation": "

The unique IDs of deployment targets.

" + } + }, + "nextToken": { + "target": "com.amazonaws.codedeploy#NextToken", + "traits": { + "smithy.api#documentation": "

If a large amount of information is returned, a token identifier is also returned. It\n can be used in a subsequent ListDeploymentTargets call to return the next\n set of deployment targets in the list.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.codedeploy#ListDeployments": { + "type": "operation", + "input": { + "target": "com.amazonaws.codedeploy#ListDeploymentsInput" + }, + "output": { + "target": "com.amazonaws.codedeploy#ListDeploymentsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codedeploy#ApplicationDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#ApplicationNameRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentGroupDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentGroupNameRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidApplicationNameException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidDeploymentGroupNameException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidDeploymentStatusException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidExternalIdException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidInputException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidTimeRangeException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the deployments in a deployment group for an application registered with the\n user or Amazon Web Services account.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "deployments" + } + } + }, + "com.amazonaws.codedeploy#ListDeploymentsInput": { + "type": "structure", + "members": { + "applicationName": { + "target": "com.amazonaws.codedeploy#ApplicationName", + "traits": { + "smithy.api#documentation": "

The name of an CodeDeploy application associated with the user or Amazon Web Services account.

\n \n

If applicationName is specified, then\n deploymentGroupName must be specified. If it is not specified, then\n deploymentGroupName must not be specified.

\n " + } + }, + "deploymentGroupName": { + "target": "com.amazonaws.codedeploy#DeploymentGroupName", + "traits": { + "smithy.api#documentation": "

The name of a deployment group for the specified application.

\n \n

If deploymentGroupName is specified, then\n applicationName must be specified. If it is not specified, then\n applicationName must not be specified.

\n " + } + }, + "externalId": { + "target": "com.amazonaws.codedeploy#ExternalId", + "traits": { + "smithy.api#documentation": "

The unique ID of an external resource for returning deployments linked to the external\n resource.

" + } + }, + "includeOnlyStatuses": { + "target": "com.amazonaws.codedeploy#DeploymentStatusList", + "traits": { + "smithy.api#documentation": "

A subset of deployments to list by status:

\n " + } + }, + "createTimeRange": { + "target": "com.amazonaws.codedeploy#TimeRange", + "traits": { + "smithy.api#documentation": "

A time range (start and end) for returning a subset of the list of deployments.

" + } + }, + "nextToken": { + "target": "com.amazonaws.codedeploy#NextToken", + "traits": { + "smithy.api#documentation": "

An identifier returned from the previous list deployments call. It can be used to\n return the next set of deployments in the list.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a ListDeployments operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.codedeploy#ListDeploymentsOutput": { + "type": "structure", + "members": { + "deployments": { + "target": "com.amazonaws.codedeploy#DeploymentsList", + "traits": { + "smithy.api#documentation": "

A list of deployment IDs.

" + } + }, + "nextToken": { + "target": "com.amazonaws.codedeploy#NextToken", + "traits": { + "smithy.api#documentation": "

If a large amount of information is returned, an identifier is also returned. It can\n be used in a subsequent list deployments call to return the next set of deployments in\n the list.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a ListDeployments operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.codedeploy#ListGitHubAccountTokenNames": { + "type": "operation", + "input": { + "target": "com.amazonaws.codedeploy#ListGitHubAccountTokenNamesInput" + }, + "output": { + "target": "com.amazonaws.codedeploy#ListGitHubAccountTokenNamesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codedeploy#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.codedeploy#OperationNotSupportedException" + }, + { + "target": "com.amazonaws.codedeploy#ResourceValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the names of stored connections to GitHub accounts.

" + } + }, + "com.amazonaws.codedeploy#ListGitHubAccountTokenNamesInput": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.codedeploy#NextToken", + "traits": { + "smithy.api#documentation": "

An identifier returned from the previous ListGitHubAccountTokenNames\n call. It can be used to return the next set of names in the list.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a ListGitHubAccountTokenNames operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.codedeploy#ListGitHubAccountTokenNamesOutput": { + "type": "structure", + "members": { + "tokenNameList": { + "target": "com.amazonaws.codedeploy#GitHubAccountTokenNameList", + "traits": { + "smithy.api#documentation": "

A list of names of connections to GitHub accounts.

" + } + }, + "nextToken": { + "target": "com.amazonaws.codedeploy#NextToken", + "traits": { + "smithy.api#documentation": "

If a large amount of information is returned, an identifier is also returned. It can\n be used in a subsequent ListGitHubAccountTokenNames call to return the next\n set of names in the list.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a ListGitHubAccountTokenNames operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.codedeploy#ListOnPremisesInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.codedeploy#ListOnPremisesInstancesInput" + }, + "output": { + "target": "com.amazonaws.codedeploy#ListOnPremisesInstancesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codedeploy#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidRegistrationStatusException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidTagFilterException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a list of names for one or more on-premises instances.

\n

Unless otherwise specified, both registered and deregistered on-premises instance\n names are listed. To list only registered or deregistered on-premises instance names,\n use the registration status parameter.

" + } + }, + "com.amazonaws.codedeploy#ListOnPremisesInstancesInput": { + "type": "structure", + "members": { + "registrationStatus": { + "target": "com.amazonaws.codedeploy#RegistrationStatus", + "traits": { + "smithy.api#documentation": "

The registration status of the on-premises instances:

\n " + } + }, + "tagFilters": { + "target": "com.amazonaws.codedeploy#TagFilterList", + "traits": { + "smithy.api#documentation": "

The on-premises instance tags that are used to restrict the on-premises instance names\n returned.

" + } + }, + "nextToken": { + "target": "com.amazonaws.codedeploy#NextToken", + "traits": { + "smithy.api#documentation": "

An identifier returned from the previous list on-premises instances call. It can be\n used to return the next set of on-premises instances in the list.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a ListOnPremisesInstances operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.codedeploy#ListOnPremisesInstancesOutput": { + "type": "structure", + "members": { + "instanceNames": { + "target": "com.amazonaws.codedeploy#InstanceNameList", + "traits": { + "smithy.api#documentation": "

The list of matching on-premises instance names.

" + } + }, + "nextToken": { + "target": "com.amazonaws.codedeploy#NextToken", + "traits": { + "smithy.api#documentation": "

If a large amount of information is returned, an identifier is also returned. It can\n be used in a subsequent list on-premises instances call to return the next set of\n on-premises instances in the list.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of the list on-premises instances operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.codedeploy#ListStateFilterAction": { + "type": "enum", + "members": { + "Include": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "include" + } + }, + "Exclude": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "exclude" + } + }, + "Ignore": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ignore" + } + } + } + }, + "com.amazonaws.codedeploy#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.codedeploy#ListTagsForResourceInput" + }, + "output": { + "target": "com.amazonaws.codedeploy#ListTagsForResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codedeploy#ArnNotSupportedException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidArnException" + }, + { + "target": "com.amazonaws.codedeploy#ResourceArnRequiredException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of tags for the resource identified by a specified Amazon Resource\n Name (ARN). Tags are used to organize and categorize your CodeDeploy resources.

" + } + }, + "com.amazonaws.codedeploy#ListTagsForResourceInput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.codedeploy#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of a CodeDeploy resource. ListTagsForResource returns all the\n tags associated with the resource that is identified by the ResourceArn.\n

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.codedeploy#NextToken", + "traits": { + "smithy.api#documentation": "

An identifier returned from the previous ListTagsForResource call. It can\n be used to return the next set of applications in the list.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codedeploy#ListTagsForResourceOutput": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.codedeploy#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags returned by ListTagsForResource. The tags are associated\n with the resource identified by the input ResourceArn parameter.

" + } + }, + "NextToken": { + "target": "com.amazonaws.codedeploy#NextToken", + "traits": { + "smithy.api#documentation": "

If a large amount of information is returned, an identifier is also returned. It can\n be used in a subsequent list application revisions call to return the next set of\n application revisions in the list.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.codedeploy#ListenerArn": { + "type": "string" + }, + "com.amazonaws.codedeploy#ListenerArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.codedeploy#ListenerArn" + } + }, + "com.amazonaws.codedeploy#LoadBalancerInfo": { + "type": "structure", + "members": { + "elbInfoList": { + "target": "com.amazonaws.codedeploy#ELBInfoList", + "traits": { + "smithy.api#documentation": "

An array that contains information about the load balancers to use for load balancing\n in a deployment. If you're using Classic Load Balancers, specify those load balancers in\n this array.

\n \n

You can add up to 10 load balancers to the array.

\n \n \n

If you're using Application Load Balancers or Network Load Balancers, use the\n targetGroupInfoList array instead of this one.

\n " + } + }, + "targetGroupInfoList": { + "target": "com.amazonaws.codedeploy#TargetGroupInfoList", + "traits": { + "smithy.api#documentation": "

An array that contains information about the target groups to use for load balancing\n in a deployment. If you're using Application Load Balancers and Network Load Balancers,\n specify their associated target groups in this array.

\n \n

You can add up to 10 target groups to the array.

\n \n \n

If you're using Classic Load Balancers, use the elbInfoList array\n instead of this one.

\n " + } + }, + "targetGroupPairInfoList": { + "target": "com.amazonaws.codedeploy#TargetGroupPairInfoList", + "traits": { + "smithy.api#documentation": "

The target group pair information. This is an array of\n TargeGroupPairInfo objects with a maximum size of one.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the Elastic Load Balancing load balancer or target group used in a\n deployment.

\n

You can use load balancers and target groups in combination. For example, if you have\n two Classic Load Balancers, and five target groups tied to an Application Load Balancer,\n you can specify the two Classic Load Balancers in elbInfoList, and the five\n target groups in targetGroupInfoList.

" + } + }, + "com.amazonaws.codedeploy#LogTail": { + "type": "string" + }, + "com.amazonaws.codedeploy#Message": { + "type": "string" + }, + "com.amazonaws.codedeploy#MinimumHealthyHosts": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.codedeploy#MinimumHealthyHostsType", + "traits": { + "smithy.api#documentation": "

The minimum healthy instance type:

\n \n

In an example of nine instances, if a HOST_COUNT of six is specified, deploy to up to\n three instances at a time. The deployment is successful if six or more instances are\n deployed to successfully. Otherwise, the deployment fails. If a FLEET_PERCENT of 40 is\n specified, deploy to up to five instances at a time. The deployment is successful if\n four or more instances are deployed to successfully. Otherwise, the deployment\n fails.

\n \n

In a call to the GetDeploymentConfig, CodeDeployDefault.OneAtATime\n returns a minimum healthy instance type of MOST_CONCURRENCY and a value of 1. This\n means a deployment to only one instance at a time. (You cannot set the type to\n MOST_CONCURRENCY, only to HOST_COUNT or FLEET_PERCENT.) In addition, with\n CodeDeployDefault.OneAtATime, CodeDeploy attempts to ensure that all\n instances but one are kept in a healthy state during the deployment. Although this\n allows one instance at a time to be taken offline for a new deployment, it also\n means that if the deployment to the last instance fails, the overall deployment is\n still successful.

\n \n

For more information, see CodeDeploy\n Instance Health in the CodeDeploy User\n Guide.

" + } + }, + "value": { + "target": "com.amazonaws.codedeploy#MinimumHealthyHostsValue", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The minimum healthy instance value.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the minimum number of healthy instances.

" + } + }, + "com.amazonaws.codedeploy#MinimumHealthyHostsPerZone": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.codedeploy#MinimumHealthyHostsPerZoneType", + "traits": { + "smithy.api#documentation": "

The type associated with the MinimumHealthyHostsPerZone\n option.

" + } + }, + "value": { + "target": "com.amazonaws.codedeploy#MinimumHealthyHostsPerZoneValue", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The value associated with the MinimumHealthyHostsPerZone\n option.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the minimum number of healthy instances per Availability\n Zone.

" + } + }, + "com.amazonaws.codedeploy#MinimumHealthyHostsPerZoneType": { + "type": "enum", + "members": { + "HOST_COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOST_COUNT" + } + }, + "FLEET_PERCENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLEET_PERCENT" + } + } + } + }, + "com.amazonaws.codedeploy#MinimumHealthyHostsPerZoneValue": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.codedeploy#MinimumHealthyHostsType": { + "type": "enum", + "members": { + "HOST_COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOST_COUNT" + } + }, + "FLEET_PERCENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLEET_PERCENT" + } + } + } + }, + "com.amazonaws.codedeploy#MinimumHealthyHostsValue": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.codedeploy#MultipleIamArnsProvidedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Both an user ARN and an IAM session ARN were included in the request.\n Use only one ARN type.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#NextToken": { + "type": "string" + }, + "com.amazonaws.codedeploy#NullableBoolean": { + "type": "boolean" + }, + "com.amazonaws.codedeploy#OnPremisesTagSet": { + "type": "structure", + "members": { + "onPremisesTagSetList": { + "target": "com.amazonaws.codedeploy#OnPremisesTagSetList", + "traits": { + "smithy.api#documentation": "

A list that contains other lists of on-premises instance tag groups. For an instance\n to be included in the deployment group, it must be identified by all of the tag groups\n in the list.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about groups of on-premises instance tags.

" + } + }, + "com.amazonaws.codedeploy#OnPremisesTagSetList": { + "type": "list", + "member": { + "target": "com.amazonaws.codedeploy#TagFilterList" + } + }, + "com.amazonaws.codedeploy#OperationNotSupportedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The API used does not support the deployment.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#OutdatedInstancesStrategy": { + "type": "enum", + "members": { + "Update": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE" + } + }, + "Ignore": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IGNORE" + } + } + } + }, + "com.amazonaws.codedeploy#Percentage": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.codedeploy#PutLifecycleEventHookExecutionStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.codedeploy#PutLifecycleEventHookExecutionStatusInput" + }, + "output": { + "target": "com.amazonaws.codedeploy#PutLifecycleEventHookExecutionStatusOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codedeploy#DeploymentDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentIdRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidDeploymentIdException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidLifecycleEventHookExecutionIdException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidLifecycleEventHookExecutionStatusException" + }, + { + "target": "com.amazonaws.codedeploy#LifecycleEventAlreadyCompletedException" + }, + { + "target": "com.amazonaws.codedeploy#UnsupportedActionForDeploymentTypeException" + } + ], + "traits": { + "smithy.api#documentation": "

Sets the result of a Lambda validation function. The function validates\n lifecycle hooks during a deployment that uses the Lambda or Amazon ECS compute platform. For Lambda deployments, the available\n lifecycle hooks are BeforeAllowTraffic and AfterAllowTraffic.\n For Amazon ECS deployments, the available lifecycle hooks are\n BeforeInstall, AfterInstall,\n AfterAllowTestTraffic, BeforeAllowTraffic, and\n AfterAllowTraffic. Lambda validation functions return\n Succeeded or Failed. For more information, see AppSpec 'hooks' Section for an Lambda Deployment and\n AppSpec 'hooks' Section for an Amazon ECS Deployment.

" + } + }, + "com.amazonaws.codedeploy#PutLifecycleEventHookExecutionStatusInput": { + "type": "structure", + "members": { + "deploymentId": { + "target": "com.amazonaws.codedeploy#DeploymentId", + "traits": { + "smithy.api#documentation": "

The unique ID of a deployment. Pass this ID to a Lambda function that\n validates a deployment lifecycle event.

" + } + }, + "lifecycleEventHookExecutionId": { + "target": "com.amazonaws.codedeploy#LifecycleEventHookExecutionId", + "traits": { + "smithy.api#documentation": "

The execution ID of a deployment's lifecycle hook. A deployment lifecycle hook is\n specified in the hooks section of the AppSpec file.

" + } + }, + "status": { + "target": "com.amazonaws.codedeploy#LifecycleEventStatus", + "traits": { + "smithy.api#documentation": "

The result of a Lambda function that validates a deployment lifecycle\n event. The values listed in Valid Values are valid for\n lifecycle statuses in general; however, only Succeeded and\n Failed can be passed successfully in your API call.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codedeploy#PutLifecycleEventHookExecutionStatusOutput": { + "type": "structure", + "members": { + "lifecycleEventHookExecutionId": { + "target": "com.amazonaws.codedeploy#LifecycleEventHookExecutionId", + "traits": { + "smithy.api#documentation": "

The execution ID of the lifecycle event hook. A hook is specified in the\n hooks section of the deployment's AppSpec file.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.codedeploy#RawString": { + "type": "structure", + "members": { + "content": { + "target": "com.amazonaws.codedeploy#RawStringContent", + "traits": { + "smithy.api#documentation": "

The YAML-formatted or JSON-formatted revision string. It includes information about\n which Lambda function to update and optional Lambda functions\n that validate deployment lifecycle events.

" + } + }, + "sha256": { + "target": "com.amazonaws.codedeploy#RawStringSha256", + "traits": { + "smithy.api#documentation": "

The SHA256 hash value of the revision content.

" + } + } + }, + "traits": { + "smithy.api#deprecated": { + "message": "RawString and String revision type are deprecated, use AppSpecContent type instead." + }, + "smithy.api#documentation": "

A revision for an Lambda deployment that is a YAML-formatted or\n JSON-formatted string. For Lambda deployments, the revision is the same\n as the AppSpec file.

" + } + }, + "com.amazonaws.codedeploy#RawStringContent": { + "type": "string" + }, + "com.amazonaws.codedeploy#RawStringSha256": { + "type": "string" + }, + "com.amazonaws.codedeploy#RegisterApplicationRevision": { + "type": "operation", + "input": { + "target": "com.amazonaws.codedeploy#RegisterApplicationRevisionInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.codedeploy#ApplicationDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#ApplicationNameRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#DescriptionTooLongException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidApplicationNameException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidRevisionException" + }, + { + "target": "com.amazonaws.codedeploy#RevisionRequiredException" + } + ], + "traits": { + "smithy.api#documentation": "

Registers with CodeDeploy a revision for the specified application.

" + } + }, + "com.amazonaws.codedeploy#RegisterApplicationRevisionInput": { + "type": "structure", + "members": { + "applicationName": { + "target": "com.amazonaws.codedeploy#ApplicationName", + "traits": { + "smithy.api#documentation": "

The name of an CodeDeploy application associated with the user or Amazon Web Services account.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.codedeploy#Description", + "traits": { + "smithy.api#documentation": "

A comment about the revision.

" + } + }, + "revision": { + "target": "com.amazonaws.codedeploy#RevisionLocation", + "traits": { + "smithy.api#documentation": "

Information about the application revision to register, including type and\n location.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a RegisterApplicationRevision operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.codedeploy#RegisterOnPremisesInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.codedeploy#RegisterOnPremisesInstanceInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.codedeploy#IamArnRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#IamSessionArnAlreadyRegisteredException" + }, + { + "target": "com.amazonaws.codedeploy#IamUserArnAlreadyRegisteredException" + }, + { + "target": "com.amazonaws.codedeploy#IamUserArnRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#InstanceNameAlreadyRegisteredException" + }, + { + "target": "com.amazonaws.codedeploy#InstanceNameRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidIamSessionArnException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidIamUserArnException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidInstanceNameException" + }, + { + "target": "com.amazonaws.codedeploy#MultipleIamArnsProvidedException" + } + ], + "traits": { + "smithy.api#documentation": "

Registers an on-premises instance.

\n \n

Only one IAM ARN (an IAM session ARN or IAM user ARN) is supported in the request. You cannot use both.

\n " + } + }, + "com.amazonaws.codedeploy#RegisterOnPremisesInstanceInput": { + "type": "structure", + "members": { + "instanceName": { + "target": "com.amazonaws.codedeploy#InstanceName", + "traits": { + "smithy.api#documentation": "

The name of the on-premises instance to register.

", + "smithy.api#required": {} + } + }, + "iamSessionArn": { + "target": "com.amazonaws.codedeploy#IamSessionArn", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM session to associate with the on-premises\n instance.

" + } + }, + "iamUserArn": { + "target": "com.amazonaws.codedeploy#IamUserArn", + "traits": { + "smithy.api#documentation": "

The ARN of the user to associate with the on-premises instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of the register on-premises instance operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.codedeploy#RegistrationStatus": { + "type": "enum", + "members": { + "Registered": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Registered" + } + }, + "Deregistered": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deregistered" + } + } + } + }, + "com.amazonaws.codedeploy#RelatedDeployments": { + "type": "structure", + "members": { + "autoUpdateOutdatedInstancesRootDeploymentId": { + "target": "com.amazonaws.codedeploy#DeploymentId", + "traits": { + "smithy.api#documentation": "

The deployment ID of the root deployment that triggered this deployment.

" + } + }, + "autoUpdateOutdatedInstancesDeploymentIds": { + "target": "com.amazonaws.codedeploy#DeploymentsList", + "traits": { + "smithy.api#documentation": "

The deployment IDs of 'auto-update outdated instances' deployments triggered by this\n deployment.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about deployments related to the specified deployment.

" + } + }, + "com.amazonaws.codedeploy#RemoveTagsFromOnPremisesInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.codedeploy#RemoveTagsFromOnPremisesInstancesInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.codedeploy#InstanceLimitExceededException" + }, + { + "target": "com.amazonaws.codedeploy#InstanceNameRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#InstanceNotRegisteredException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidInstanceNameException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidTagException" + }, + { + "target": "com.amazonaws.codedeploy#TagLimitExceededException" + }, + { + "target": "com.amazonaws.codedeploy#TagRequiredException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes one or more tags from one or more on-premises instances.

" + } + }, + "com.amazonaws.codedeploy#RemoveTagsFromOnPremisesInstancesInput": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.codedeploy#TagList", + "traits": { + "smithy.api#documentation": "

The tag key-value pairs to remove from the on-premises instances.

", + "smithy.api#required": {} + } + }, + "instanceNames": { + "target": "com.amazonaws.codedeploy#InstanceNameList", + "traits": { + "smithy.api#documentation": "

The names of the on-premises instances from which to remove tags.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a RemoveTagsFromOnPremisesInstances\n operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.codedeploy#Repository": { + "type": "string" + }, + "com.amazonaws.codedeploy#ResourceArnRequiredException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The ARN of a resource is required, but was not found.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#ResourceValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The specified resource could not be validated.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#RevisionDoesNotExistException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The named revision does not exist with the user or Amazon Web Services account.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#RevisionInfo": { + "type": "structure", + "members": { + "revisionLocation": { + "target": "com.amazonaws.codedeploy#RevisionLocation", + "traits": { + "smithy.api#documentation": "

Information about the location and type of an application revision.

" + } + }, + "genericRevisionInfo": { + "target": "com.amazonaws.codedeploy#GenericRevisionInfo", + "traits": { + "smithy.api#documentation": "

Information about an application revision, including usage details and associated\n deployment groups.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an application revision.

" + } + }, + "com.amazonaws.codedeploy#RevisionInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.codedeploy#RevisionInfo" + } + }, + "com.amazonaws.codedeploy#RevisionLocation": { + "type": "structure", + "members": { + "revisionType": { + "target": "com.amazonaws.codedeploy#RevisionLocationType", + "traits": { + "smithy.api#documentation": "

The type of application revision:

\n " + } + }, + "s3Location": { + "target": "com.amazonaws.codedeploy#S3Location", + "traits": { + "smithy.api#documentation": "

Information about the location of a revision stored in Amazon S3.

" + } + }, + "gitHubLocation": { + "target": "com.amazonaws.codedeploy#GitHubLocation", + "traits": { + "smithy.api#documentation": "

Information about the location of application artifacts stored in GitHub.

" + } + }, + "string": { + "target": "com.amazonaws.codedeploy#RawString", + "traits": { + "smithy.api#documentation": "

Information about the location of an Lambda deployment revision stored\n as a RawString.

" + } + }, + "appSpecContent": { + "target": "com.amazonaws.codedeploy#AppSpecContent", + "traits": { + "smithy.api#documentation": "

The content of an AppSpec file for an Lambda or Amazon ECS\n deployment. The content is formatted as JSON or YAML and stored as a RawString.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the location of an application revision.

" + } + }, + "com.amazonaws.codedeploy#RevisionLocationList": { + "type": "list", + "member": { + "target": "com.amazonaws.codedeploy#RevisionLocation" + } + }, + "com.amazonaws.codedeploy#RevisionLocationType": { + "type": "enum", + "members": { + "S3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3" + } + }, + "GitHub": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GitHub" + } + }, + "String": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "String" + } + }, + "AppSpecContent": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AppSpecContent" + } + } + } + }, + "com.amazonaws.codedeploy#RevisionRequiredException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The revision ID was not specified.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#Role": { + "type": "string" + }, + "com.amazonaws.codedeploy#RoleRequiredException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The role ID was not specified.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#RollbackInfo": { + "type": "structure", + "members": { + "rollbackDeploymentId": { + "target": "com.amazonaws.codedeploy#DeploymentId", + "traits": { + "smithy.api#documentation": "

The ID of the deployment rollback.

" + } + }, + "rollbackTriggeringDeploymentId": { + "target": "com.amazonaws.codedeploy#DeploymentId", + "traits": { + "smithy.api#documentation": "

The deployment ID of the deployment that was underway and triggered a rollback\n deployment because it failed or was stopped.

" + } + }, + "rollbackMessage": { + "target": "com.amazonaws.codedeploy#Description", + "traits": { + "smithy.api#documentation": "

Information that describes the status of a deployment rollback (for example, whether\n the deployment can't be rolled back, is in progress, failed, or succeeded).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a deployment rollback.

" + } + }, + "com.amazonaws.codedeploy#S3Bucket": { + "type": "string" + }, + "com.amazonaws.codedeploy#S3Key": { + "type": "string" + }, + "com.amazonaws.codedeploy#S3Location": { + "type": "structure", + "members": { + "bucket": { + "target": "com.amazonaws.codedeploy#S3Bucket", + "traits": { + "smithy.api#documentation": "

The name of the Amazon S3 bucket where the application revision is\n stored.

" + } + }, + "key": { + "target": "com.amazonaws.codedeploy#S3Key", + "traits": { + "smithy.api#documentation": "

The name of the Amazon S3 object that represents the bundled artifacts for the\n application revision.

" + } + }, + "bundleType": { + "target": "com.amazonaws.codedeploy#BundleType", + "traits": { + "smithy.api#documentation": "

The file type of the application revision. Must be one of the following:

\n " + } + }, + "version": { + "target": "com.amazonaws.codedeploy#VersionId", + "traits": { + "smithy.api#documentation": "

A specific version of the Amazon S3 object that represents the bundled\n artifacts for the application revision.

\n

If the version is not specified, the system uses the most recent version by\n default.

" + } + }, + "eTag": { + "target": "com.amazonaws.codedeploy#ETag", + "traits": { + "smithy.api#documentation": "

The ETag of the Amazon S3 object that represents the bundled artifacts for the\n application revision.

\n

If the ETag is not specified as an input parameter, ETag validation of the object is\n skipped.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the location of application artifacts stored in Amazon S3.

" + } + }, + "com.amazonaws.codedeploy#ScriptName": { + "type": "string" + }, + "com.amazonaws.codedeploy#SkipWaitTimeForInstanceTermination": { + "type": "operation", + "input": { + "target": "com.amazonaws.codedeploy#SkipWaitTimeForInstanceTerminationInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.codedeploy#DeploymentAlreadyCompletedException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentIdRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentNotStartedException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidDeploymentIdException" + }, + { + "target": "com.amazonaws.codedeploy#UnsupportedActionForDeploymentTypeException" + } + ], + "traits": { + "smithy.api#deprecated": { + "message": "This operation is deprecated, use ContinueDeployment with DeploymentWaitType instead." + }, + "smithy.api#documentation": "

In a blue/green deployment, overrides any specified wait time and starts terminating\n instances immediately after the traffic routing is complete.

" + } + }, + "com.amazonaws.codedeploy#SkipWaitTimeForInstanceTerminationInput": { + "type": "structure", + "members": { + "deploymentId": { + "target": "com.amazonaws.codedeploy#DeploymentId", + "traits": { + "smithy.api#documentation": "

The unique ID of a blue/green deployment for which you want to skip the instance\n termination wait time.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codedeploy#SortOrder": { + "type": "enum", + "members": { + "Ascending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ascending" + } + }, + "Descending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "descending" + } + } + } + }, + "com.amazonaws.codedeploy#StopDeployment": { + "type": "operation", + "input": { + "target": "com.amazonaws.codedeploy#StopDeploymentInput" + }, + "output": { + "target": "com.amazonaws.codedeploy#StopDeploymentOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codedeploy#DeploymentAlreadyCompletedException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentGroupDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentIdRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidDeploymentIdException" + }, + { + "target": "com.amazonaws.codedeploy#UnsupportedActionForDeploymentTypeException" + } + ], + "traits": { + "smithy.api#documentation": "

Attempts to stop an ongoing deployment.

" + } + }, + "com.amazonaws.codedeploy#StopDeploymentInput": { + "type": "structure", + "members": { + "deploymentId": { + "target": "com.amazonaws.codedeploy#DeploymentId", + "traits": { + "smithy.api#documentation": "

The unique ID of a deployment.

", + "smithy.api#required": {} + } + }, + "autoRollbackEnabled": { + "target": "com.amazonaws.codedeploy#NullableBoolean", + "traits": { + "smithy.api#documentation": "

Indicates, when a deployment is stopped, whether instances that have been updated\n should be rolled back to the previous version of the application revision.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a StopDeployment operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.codedeploy#StopDeploymentOutput": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.codedeploy#StopStatus", + "traits": { + "smithy.api#documentation": "

The status of the stop deployment operation:

\n " + } + }, + "statusMessage": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

An accompanying status message.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a StopDeployment operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.codedeploy#StopStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Succeeded" + } + } + } + }, + "com.amazonaws.codedeploy#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.codedeploy#Key", + "traits": { + "smithy.api#documentation": "

The tag's key.

" + } + }, + "Value": { + "target": "com.amazonaws.codedeploy#Value", + "traits": { + "smithy.api#documentation": "

The tag's value.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a tag.

" + } + }, + "com.amazonaws.codedeploy#TagFilter": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.codedeploy#Key", + "traits": { + "smithy.api#documentation": "

The on-premises instance tag filter key.

" + } + }, + "Value": { + "target": "com.amazonaws.codedeploy#Value", + "traits": { + "smithy.api#documentation": "

The on-premises instance tag filter value.

" + } + }, + "Type": { + "target": "com.amazonaws.codedeploy#TagFilterType", + "traits": { + "smithy.api#documentation": "

The on-premises instance tag filter type:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an on-premises instance tag filter.

" + } + }, + "com.amazonaws.codedeploy#TagFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.codedeploy#TagFilter" + } + }, + "com.amazonaws.codedeploy#TagFilterType": { + "type": "enum", + "members": { + "KEY_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KEY_ONLY" + } + }, + "VALUE_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALUE_ONLY" + } + }, + "KEY_AND_VALUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KEY_AND_VALUE" + } + } + } + }, + "com.amazonaws.codedeploy#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.codedeploy#Key" + } + }, + "com.amazonaws.codedeploy#TagLimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The maximum allowed number of tags was exceeded.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.codedeploy#Tag" + } + }, + "com.amazonaws.codedeploy#TagRequiredException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A tag was not specified.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.codedeploy#TagResourceInput" + }, + "output": { + "target": "com.amazonaws.codedeploy#TagResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codedeploy#ApplicationDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#ArnNotSupportedException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentConfigDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentGroupDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidArnException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidTagsToAddException" + }, + { + "target": "com.amazonaws.codedeploy#ResourceArnRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#TagRequiredException" + } + ], + "traits": { + "smithy.api#documentation": "

Associates the list of tags in the input Tags parameter with the\n resource identified by the ResourceArn input parameter.

" + } + }, + "com.amazonaws.codedeploy#TagResourceInput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.codedeploy#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of a resource, such as a CodeDeploy application or deployment group.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.codedeploy#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags that TagResource associates with a resource. The resource\n is identified by the ResourceArn input parameter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codedeploy#TagResourceOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.codedeploy#TagSetListLimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The number of tag groups included in the tag set list exceeded the maximum allowed\n limit of 3.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#TargetArn": { + "type": "string" + }, + "com.amazonaws.codedeploy#TargetFilterName": { + "type": "enum", + "members": { + "TARGET_STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TargetStatus" + } + }, + "SERVER_INSTANCE_LABEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ServerInstanceLabel" + } + } + } + }, + "com.amazonaws.codedeploy#TargetFilters": { + "type": "map", + "key": { + "target": "com.amazonaws.codedeploy#TargetFilterName" + }, + "value": { + "target": "com.amazonaws.codedeploy#FilterValueList" + } + }, + "com.amazonaws.codedeploy#TargetGroupInfo": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.codedeploy#TargetGroupName", + "traits": { + "smithy.api#documentation": "

For blue/green deployments, the name of the target group that instances in the\n original environment are deregistered from, and instances in the replacement environment\n are registered with. For in-place deployments, the name of the target group that\n instances are deregistered from, so they are not serving traffic during a deployment,\n and then re-registered with after the deployment is complete.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a target group in Elastic Load Balancing to use in a deployment.\n Instances are registered as targets in a target group, and traffic is routed to the\n target group.

" + } + }, + "com.amazonaws.codedeploy#TargetGroupInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.codedeploy#TargetGroupInfo" + } + }, + "com.amazonaws.codedeploy#TargetGroupName": { + "type": "string" + }, + "com.amazonaws.codedeploy#TargetGroupPairInfo": { + "type": "structure", + "members": { + "targetGroups": { + "target": "com.amazonaws.codedeploy#TargetGroupInfoList", + "traits": { + "smithy.api#documentation": "

One pair of target groups. One is associated with the original task set. The second\n is associated with the task set that serves traffic after the deployment is complete.\n

" + } + }, + "prodTrafficRoute": { + "target": "com.amazonaws.codedeploy#TrafficRoute", + "traits": { + "smithy.api#documentation": "

The path used by a load balancer to route production traffic when an Amazon ECS deployment is complete.

" + } + }, + "testTrafficRoute": { + "target": "com.amazonaws.codedeploy#TrafficRoute", + "traits": { + "smithy.api#documentation": "

An optional path used by a load balancer to route test traffic after an Amazon ECS deployment. Validation can occur while test traffic is served during a\n deployment.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about two target groups and how traffic is routed during an Amazon ECS deployment. An optional test traffic route can be specified.

" + } + }, + "com.amazonaws.codedeploy#TargetGroupPairInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.codedeploy#TargetGroupPairInfo" + } + }, + "com.amazonaws.codedeploy#TargetId": { + "type": "string" + }, + "com.amazonaws.codedeploy#TargetIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.codedeploy#TargetId" + } + }, + "com.amazonaws.codedeploy#TargetInstances": { + "type": "structure", + "members": { + "tagFilters": { + "target": "com.amazonaws.codedeploy#EC2TagFilterList", + "traits": { + "smithy.api#documentation": "

The tag filter key, type, and value used to identify Amazon EC2 instances in a\n replacement environment for a blue/green deployment. Cannot be used in the same call as\n ec2TagSet.

" + } + }, + "autoScalingGroups": { + "target": "com.amazonaws.codedeploy#AutoScalingGroupNameList", + "traits": { + "smithy.api#documentation": "

The names of one or more Auto Scaling groups to identify a replacement\n environment for a blue/green deployment.

" + } + }, + "ec2TagSet": { + "target": "com.amazonaws.codedeploy#EC2TagSet", + "traits": { + "smithy.api#documentation": "

Information about the groups of Amazon EC2 instance tags that an instance must\n be identified by in order for it to be included in the replacement environment for a\n blue/green deployment. Cannot be used in the same call as\n tagFilters.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the instances to be used in the replacement environment in a\n blue/green deployment.

" + } + }, + "com.amazonaws.codedeploy#TargetLabel": { + "type": "enum", + "members": { + "BLUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Blue" + } + }, + "GREEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Green" + } + } + } + }, + "com.amazonaws.codedeploy#TargetStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Succeeded" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "SKIPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Skipped" + } + }, + "UNKNOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Unknown" + } + }, + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ready" + } + } + } + }, + "com.amazonaws.codedeploy#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An API function was called too frequently.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#Time": { + "type": "timestamp" + }, + "com.amazonaws.codedeploy#TimeBasedCanary": { + "type": "structure", + "members": { + "canaryPercentage": { + "target": "com.amazonaws.codedeploy#Percentage", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The percentage of traffic to shift in the first increment of a\n TimeBasedCanary deployment.

" + } + }, + "canaryInterval": { + "target": "com.amazonaws.codedeploy#WaitTimeInMins", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of minutes between the first and second traffic shifts of a\n TimeBasedCanary deployment.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A configuration that shifts traffic from one version of a Lambda function\n or Amazon ECS task set to another in two increments. The original and target\n Lambda function versions or ECS task sets are specified in the\n deployment's AppSpec file.

" + } + }, + "com.amazonaws.codedeploy#TimeBasedLinear": { + "type": "structure", + "members": { + "linearPercentage": { + "target": "com.amazonaws.codedeploy#Percentage", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The percentage of traffic that is shifted at the start of each increment of a\n TimeBasedLinear deployment.

" + } + }, + "linearInterval": { + "target": "com.amazonaws.codedeploy#WaitTimeInMins", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of minutes between each incremental traffic shift of a\n TimeBasedLinear deployment.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A configuration that shifts traffic from one version of a Lambda function\n or ECS task set to another in equal increments, with an equal number of minutes between\n each increment. The original and target Lambda function versions or ECS task\n sets are specified in the deployment's AppSpec file.

" + } + }, + "com.amazonaws.codedeploy#TimeRange": { + "type": "structure", + "members": { + "start": { + "target": "com.amazonaws.codedeploy#Timestamp", + "traits": { + "smithy.api#documentation": "

The start time of the time range.

\n \n

Specify null to leave the start time open-ended.

\n " + } + }, + "end": { + "target": "com.amazonaws.codedeploy#Timestamp", + "traits": { + "smithy.api#documentation": "

The end time of the time range.

\n \n

Specify null to leave the end time open-ended.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a time range.

" + } + }, + "com.amazonaws.codedeploy#Timestamp": { + "type": "timestamp" + }, + "com.amazonaws.codedeploy#TrafficRoute": { + "type": "structure", + "members": { + "listenerArns": { + "target": "com.amazonaws.codedeploy#ListenerArnList", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of one listener. The listener identifies the route\n between a target group and a load balancer. This is an array of strings with a maximum\n size of one.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a listener. The listener contains the path used to route traffic\n that is received from the load balancer to a target group.

" + } + }, + "com.amazonaws.codedeploy#TrafficRoutingConfig": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.codedeploy#TrafficRoutingType", + "traits": { + "smithy.api#documentation": "

The type of traffic shifting (TimeBasedCanary or\n TimeBasedLinear) used by a deployment configuration.

" + } + }, + "timeBasedCanary": { + "target": "com.amazonaws.codedeploy#TimeBasedCanary", + "traits": { + "smithy.api#documentation": "

A configuration that shifts traffic from one version of a Lambda function\n or ECS task set to another in two increments. The original and target Lambda\n function versions or ECS task sets are specified in the deployment's AppSpec\n file.

" + } + }, + "timeBasedLinear": { + "target": "com.amazonaws.codedeploy#TimeBasedLinear", + "traits": { + "smithy.api#documentation": "

A configuration that shifts traffic from one version of a Lambda function\n or Amazon ECS task set to another in equal increments, with an equal number of\n minutes between each increment. The original and target Lambda function\n versions or Amazon ECS task sets are specified in the deployment's AppSpec\n file.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration that specifies how traffic is shifted from one version of a Lambda function to another version during an Lambda deployment,\n or from one Amazon ECS task set to another during an Amazon ECS\n deployment.

" + } + }, + "com.amazonaws.codedeploy#TrafficRoutingType": { + "type": "enum", + "members": { + "TimeBasedCanary": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TimeBasedCanary" + } + }, + "TimeBasedLinear": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TimeBasedLinear" + } + }, + "AllAtOnce": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AllAtOnce" + } + } + } + }, + "com.amazonaws.codedeploy#TrafficWeight": { + "type": "double", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.codedeploy#TriggerConfig": { + "type": "structure", + "members": { + "triggerName": { + "target": "com.amazonaws.codedeploy#TriggerName", + "traits": { + "smithy.api#documentation": "

The name of the notification trigger.

" + } + }, + "triggerTargetArn": { + "target": "com.amazonaws.codedeploy#TriggerTargetArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic through\n which notifications about deployment or instance events are sent.

" + } + }, + "triggerEvents": { + "target": "com.amazonaws.codedeploy#TriggerEventTypeList", + "traits": { + "smithy.api#documentation": "

The event type or types for which notifications are triggered.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about notification triggers for the deployment group.

" + } + }, + "com.amazonaws.codedeploy#TriggerConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.codedeploy#TriggerConfig" + } + }, + "com.amazonaws.codedeploy#TriggerEventType": { + "type": "enum", + "members": { + "DEPLOYMENT_START": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeploymentStart" + } + }, + "DEPLOYMENT_SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeploymentSuccess" + } + }, + "DEPLOYMENT_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeploymentFailure" + } + }, + "DEPLOYMENT_STOP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeploymentStop" + } + }, + "DEPLOYMENT_ROLLBACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeploymentRollback" + } + }, + "DEPLOYMENT_READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeploymentReady" + } + }, + "INSTANCE_START": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InstanceStart" + } + }, + "INSTANCE_SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InstanceSuccess" + } + }, + "INSTANCE_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InstanceFailure" + } + }, + "INSTANCE_READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InstanceReady" + } + } + } + }, + "com.amazonaws.codedeploy#TriggerEventTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.codedeploy#TriggerEventType" + } + }, + "com.amazonaws.codedeploy#TriggerName": { + "type": "string" + }, + "com.amazonaws.codedeploy#TriggerTargetArn": { + "type": "string" + }, + "com.amazonaws.codedeploy#TriggerTargetsLimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The maximum allowed number of triggers was exceeded.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#UnsupportedActionForDeploymentTypeException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codedeploy#Message", + "traits": { + "smithy.api#documentation": "

The message that corresponds to the exception thrown by CodeDeploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A call was submitted that is not supported for the specified deployment type.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.codedeploy#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.codedeploy#UntagResourceInput" + }, + "output": { + "target": "com.amazonaws.codedeploy#UntagResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codedeploy#ApplicationDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#ArnNotSupportedException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentConfigDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentGroupDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidArnException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidTagsToAddException" + }, + { + "target": "com.amazonaws.codedeploy#ResourceArnRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#TagRequiredException" + } + ], + "traits": { + "smithy.api#documentation": "

Disassociates a resource from a list of tags. The resource is identified by the\n ResourceArn input parameter. The tags are identified by the list of\n keys in the TagKeys input parameter.

" + } + }, + "com.amazonaws.codedeploy#UntagResourceInput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.codedeploy#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that specifies from which resource to disassociate the\n tags with the keys in the TagKeys input parameter.

", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.codedeploy#TagKeyList", + "traits": { + "smithy.api#documentation": "

A list of keys of Tag objects. The Tag objects identified\n by the keys are disassociated from the resource specified by the\n ResourceArn input parameter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codedeploy#UntagResourceOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.codedeploy#UpdateApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.codedeploy#UpdateApplicationInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.codedeploy#ApplicationAlreadyExistsException" + }, + { + "target": "com.amazonaws.codedeploy#ApplicationDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#ApplicationNameRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidApplicationNameException" + } + ], + "traits": { + "smithy.api#documentation": "

Changes the name of an application.

" + } + }, + "com.amazonaws.codedeploy#UpdateApplicationInput": { + "type": "structure", + "members": { + "applicationName": { + "target": "com.amazonaws.codedeploy#ApplicationName", + "traits": { + "smithy.api#documentation": "

The current name of the application you want to change.

" + } + }, + "newApplicationName": { + "target": "com.amazonaws.codedeploy#ApplicationName", + "traits": { + "smithy.api#documentation": "

The new name to give the application.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of an UpdateApplication operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.codedeploy#UpdateDeploymentGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.codedeploy#UpdateDeploymentGroupInput" + }, + "output": { + "target": "com.amazonaws.codedeploy#UpdateDeploymentGroupOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codedeploy#AlarmsLimitExceededException" + }, + { + "target": "com.amazonaws.codedeploy#ApplicationDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#ApplicationNameRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentConfigDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentGroupAlreadyExistsException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentGroupDoesNotExistException" + }, + { + "target": "com.amazonaws.codedeploy#DeploymentGroupNameRequiredException" + }, + { + "target": "com.amazonaws.codedeploy#ECSServiceMappingLimitExceededException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidAlarmConfigException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidApplicationNameException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidAutoRollbackConfigException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidAutoScalingGroupException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidBlueGreenDeploymentConfigurationException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidDeploymentConfigNameException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidDeploymentGroupNameException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidDeploymentStyleException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidEC2TagCombinationException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidEC2TagException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidECSServiceException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidInputException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidLoadBalancerInfoException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidOnPremisesTagCombinationException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidRoleException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidTagException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidTargetGroupPairException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidTrafficRoutingConfigurationException" + }, + { + "target": "com.amazonaws.codedeploy#InvalidTriggerConfigException" + }, + { + "target": "com.amazonaws.codedeploy#LifecycleHookLimitExceededException" + }, + { + "target": "com.amazonaws.codedeploy#TagSetListLimitExceededException" + }, + { + "target": "com.amazonaws.codedeploy#ThrottlingException" + }, + { + "target": "com.amazonaws.codedeploy#TriggerTargetsLimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Changes information about a deployment group.

" + } + }, + "com.amazonaws.codedeploy#UpdateDeploymentGroupInput": { + "type": "structure", + "members": { + "applicationName": { + "target": "com.amazonaws.codedeploy#ApplicationName", + "traits": { + "smithy.api#documentation": "

The application name that corresponds to the deployment group to update.

", + "smithy.api#required": {} + } + }, + "currentDeploymentGroupName": { + "target": "com.amazonaws.codedeploy#DeploymentGroupName", + "traits": { + "smithy.api#documentation": "

The current name of the deployment group.

", + "smithy.api#required": {} + } + }, + "newDeploymentGroupName": { + "target": "com.amazonaws.codedeploy#DeploymentGroupName", + "traits": { + "smithy.api#documentation": "

The new name of the deployment group, if you want to change it.

" + } + }, + "deploymentConfigName": { + "target": "com.amazonaws.codedeploy#DeploymentConfigName", + "traits": { + "smithy.api#documentation": "

The replacement deployment configuration name to use, if you want to change it.

" + } + }, + "ec2TagFilters": { + "target": "com.amazonaws.codedeploy#EC2TagFilterList", + "traits": { + "smithy.api#documentation": "

The replacement set of Amazon EC2 tags on which to filter, if you want to\n change them. To keep the existing tags, enter their names. To remove tags, do not enter\n any tag names.

" + } + }, + "onPremisesInstanceTagFilters": { + "target": "com.amazonaws.codedeploy#TagFilterList", + "traits": { + "smithy.api#documentation": "

The replacement set of on-premises instance tags on which to filter, if you want to\n change them. To keep the existing tags, enter their names. To remove tags, do not enter\n any tag names.

" + } + }, + "autoScalingGroups": { + "target": "com.amazonaws.codedeploy#AutoScalingGroupNameList", + "traits": { + "smithy.api#documentation": "

The replacement list of Auto Scaling groups to be included in the deployment\n group, if you want to change them.

\n " + } + }, + "serviceRoleArn": { + "target": "com.amazonaws.codedeploy#Role", + "traits": { + "smithy.api#documentation": "

A replacement ARN for the service role, if you want to change it.

" + } + }, + "triggerConfigurations": { + "target": "com.amazonaws.codedeploy#TriggerConfigList", + "traits": { + "smithy.api#documentation": "

Information about triggers to change when the deployment group is updated. For\n examples, see Edit a Trigger in a\n CodeDeploy Deployment Group in the CodeDeploy User\n Guide.

" + } + }, + "alarmConfiguration": { + "target": "com.amazonaws.codedeploy#AlarmConfiguration", + "traits": { + "smithy.api#documentation": "

Information to add or change about Amazon CloudWatch alarms when the deployment group\n is updated.

" + } + }, + "autoRollbackConfiguration": { + "target": "com.amazonaws.codedeploy#AutoRollbackConfiguration", + "traits": { + "smithy.api#documentation": "

Information for an automatic rollback configuration that is added or changed when a\n deployment group is updated.

" + } + }, + "outdatedInstancesStrategy": { + "target": "com.amazonaws.codedeploy#OutdatedInstancesStrategy", + "traits": { + "smithy.api#documentation": "

Indicates what happens when new Amazon EC2 instances are launched\n mid-deployment and do not receive the deployed application revision.

\n

If this option is set to UPDATE or is unspecified, CodeDeploy initiates\n one or more 'auto-update outdated instances' deployments to apply the deployed\n application revision to the new Amazon EC2 instances.

\n

If this option is set to IGNORE, CodeDeploy does not initiate a\n deployment to update the new Amazon EC2 instances. This may result in instances\n having different revisions.

" + } + }, + "deploymentStyle": { + "target": "com.amazonaws.codedeploy#DeploymentStyle", + "traits": { + "smithy.api#documentation": "

Information about the type of deployment, either in-place or blue/green, you want to\n run and whether to route deployment traffic behind a load balancer.

" + } + }, + "blueGreenDeploymentConfiguration": { + "target": "com.amazonaws.codedeploy#BlueGreenDeploymentConfiguration", + "traits": { + "smithy.api#documentation": "

Information about blue/green deployment options for a deployment group.

" + } + }, + "loadBalancerInfo": { + "target": "com.amazonaws.codedeploy#LoadBalancerInfo", + "traits": { + "smithy.api#documentation": "

Information about the load balancer used in a deployment.

" + } + }, + "ec2TagSet": { + "target": "com.amazonaws.codedeploy#EC2TagSet", + "traits": { + "smithy.api#documentation": "

Information about groups of tags applied to on-premises instances. The deployment\n group includes only Amazon EC2 instances identified by all the tag\n groups.

" + } + }, + "ecsServices": { + "target": "com.amazonaws.codedeploy#ECSServiceList", + "traits": { + "smithy.api#documentation": "

The target Amazon ECS services in the deployment group. This applies only to\n deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name\n pair using the format :.

" + } + }, + "onPremisesTagSet": { + "target": "com.amazonaws.codedeploy#OnPremisesTagSet", + "traits": { + "smithy.api#documentation": "

Information about an on-premises instance tag set. The deployment group includes only\n on-premises instances identified by all the tag groups.

" + } + }, + "terminationHookEnabled": { + "target": "com.amazonaws.codedeploy#NullableBoolean", + "traits": { + "smithy.api#documentation": "

This parameter only applies if you are using CodeDeploy with Amazon EC2 Auto Scaling. For more information, see Integrating\n CodeDeploy with Amazon EC2 Auto Scaling in the CodeDeploy User Guide.

\n

Set terminationHookEnabled to true to have CodeDeploy install a termination hook into your Auto Scaling group when you update a\n deployment group. When this hook is installed, CodeDeploy will perform\n termination deployments.

\n

For information about termination deployments, see Enabling termination deployments during Auto Scaling scale-in events in the\n CodeDeploy User Guide.

\n

For more information about Auto Scaling scale-in events, see the Scale in topic in the Amazon EC2 Auto Scaling User\n Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of an UpdateDeploymentGroup operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.codedeploy#UpdateDeploymentGroupOutput": { + "type": "structure", + "members": { + "hooksNotCleanedUp": { + "target": "com.amazonaws.codedeploy#AutoScalingGroupList", + "traits": { + "smithy.api#documentation": "

If the output contains no data, and the corresponding deployment group contained at\n least one Auto Scaling group, CodeDeploy successfully removed all\n corresponding Auto Scaling lifecycle event hooks from the Amazon Web Services account. If the output contains data, CodeDeploy could not remove some Auto Scaling lifecycle event hooks from the Amazon Web Services account.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of an UpdateDeploymentGroup operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.codedeploy#Value": { + "type": "string" + }, + "com.amazonaws.codedeploy#Version": { + "type": "string" + }, + "com.amazonaws.codedeploy#VersionId": { + "type": "string" + }, + "com.amazonaws.codedeploy#WaitTimeInMins": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.codedeploy#WaitTimeInSeconds": { + "type": "long" + }, + "com.amazonaws.codedeploy#ZonalConfig": { + "type": "structure", + "members": { + "firstZoneMonitorDurationInSeconds": { + "target": "com.amazonaws.codedeploy#WaitTimeInSeconds", + "traits": { + "smithy.api#documentation": "

The period of time, in seconds, that CodeDeploy must wait after completing a\n deployment to the first Availability Zone. CodeDeploy will\n wait this amount of time before starting a deployment to the second Availability Zone.\n You might set this option if you want to allow extra bake time for the first\n Availability Zone. If you don't specify a value for\n firstZoneMonitorDurationInSeconds, then CodeDeploy uses the\n monitorDurationInSeconds value for the first Availability Zone.

\n

For more information about the zonal configuration feature, see zonal configuration in the CodeDeploy User\n Guide.

" + } + }, + "monitorDurationInSeconds": { + "target": "com.amazonaws.codedeploy#WaitTimeInSeconds", + "traits": { + "smithy.api#documentation": "

The period of time, in seconds, that CodeDeploy must wait after completing a\n deployment to an Availability Zone. CodeDeploy will wait this amount of time\n before starting a deployment to the next Availability Zone. Consider adding a monitor\n duration to give the deployment some time to prove itself (or 'bake') in one\n Availability Zone before it is released in the next zone. If you don't specify a\n monitorDurationInSeconds, CodeDeploy starts deploying to the\n next Availability Zone immediately.

\n

For more information about the zonal configuration feature, see zonal configuration in the CodeDeploy User\n Guide.

" + } + }, + "minimumHealthyHostsPerZone": { + "target": "com.amazonaws.codedeploy#MinimumHealthyHostsPerZone", + "traits": { + "smithy.api#documentation": "

The number or percentage of instances that must remain available per Availability Zone\n during a deployment. This option works in conjunction with the\n MinimumHealthyHosts option. For more information, see About the minimum number of healthy hosts per Availability Zone in the\n CodeDeploy User Guide.

\n

If you don't specify the minimumHealthyHostsPerZone option, then CodeDeploy uses a default value of 0 percent.

\n

For more information about the zonal configuration feature, see zonal configuration in the CodeDeploy User\n Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configure the ZonalConfig object if you want CodeDeploy to\n deploy your application to one Availability Zone at a time, within an Amazon Web Services Region. By\n deploying to one Availability Zone at a time, you can expose your deployment to a\n progressively larger audience as confidence in the deployment's performance and\n viability grows. If you don't configure the ZonalConfig object, CodeDeploy deploys your application to a random selection of hosts across a\n Region.

\n

For more information about the zonal configuration feature, see zonal configuration in the CodeDeploy User\n Guide.

" + } + } + } +} \ No newline at end of file diff --git a/pkg/testdata/codegen/sdk-codegen/aws-models/dynamodb.json b/pkg/testdata/codegen/sdk-codegen/aws-models/dynamodb.json new file mode 100644 index 00000000..7783afca --- /dev/null +++ b/pkg/testdata/codegen/sdk-codegen/aws-models/dynamodb.json @@ -0,0 +1,14043 @@ +{ + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + }, + { + "id": "RuleSetAwsBuiltIn.AWS::Auth::AccountIdEndpointMode", + "namespace": "*" + }, + { + "id": "RuleSetAwsBuiltIn.AWS::Auth::AccountId", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.dynamodb#ApproximateCreationDateTimePrecision": { + "type": "enum", + "members": { + "MILLISECOND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MILLISECOND" + } + }, + "MICROSECOND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MICROSECOND" + } + } + } + }, + "com.amazonaws.dynamodb#ArchivalReason": { + "type": "string" + }, + "com.amazonaws.dynamodb#ArchivalSummary": { + "type": "structure", + "members": { + "ArchivalDateTime": { + "target": "com.amazonaws.dynamodb#Date", + "traits": { + "smithy.api#documentation": "

The date and time when table archival was initiated by DynamoDB, in UNIX epoch time\n format.

" + } + }, + "ArchivalReason": { + "target": "com.amazonaws.dynamodb#ArchivalReason", + "traits": { + "smithy.api#documentation": "

The reason DynamoDB archived the table. Currently, the only possible value is:

\n " + } + }, + "ArchivalBackupArn": { + "target": "com.amazonaws.dynamodb#BackupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the backup the table was archived to, when\n applicable in the archival reason. If you wish to restore this backup to the same table\n name, you will need to delete the original table.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details of a table archival operation.

" + } + }, + "com.amazonaws.dynamodb#AttributeAction": { + "type": "enum", + "members": { + "ADD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADD" + } + }, + "PUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PUT" + } + }, + "DELETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE" + } + } + } + }, + "com.amazonaws.dynamodb#AttributeDefinition": { + "type": "structure", + "members": { + "AttributeName": { + "target": "com.amazonaws.dynamodb#KeySchemaAttributeName", + "traits": { + "smithy.api#documentation": "

A name for the attribute.

", + "smithy.api#required": {} + } + }, + "AttributeType": { + "target": "com.amazonaws.dynamodb#ScalarAttributeType", + "traits": { + "smithy.api#documentation": "

The data type for the attribute, where:

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents an attribute for describing the schema for the table and indexes.

" + } + }, + "com.amazonaws.dynamodb#AttributeDefinitions": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#AttributeDefinition" + } + }, + "com.amazonaws.dynamodb#AttributeMap": { + "type": "map", + "key": { + "target": "com.amazonaws.dynamodb#AttributeName" + }, + "value": { + "target": "com.amazonaws.dynamodb#AttributeValue" + } + }, + "com.amazonaws.dynamodb#AttributeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 65535 + } + } + }, + "com.amazonaws.dynamodb#AttributeNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#AttributeName" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.dynamodb#AttributeUpdates": { + "type": "map", + "key": { + "target": "com.amazonaws.dynamodb#AttributeName" + }, + "value": { + "target": "com.amazonaws.dynamodb#AttributeValueUpdate" + } + }, + "com.amazonaws.dynamodb#AttributeValue": { + "type": "union", + "members": { + "S": { + "target": "com.amazonaws.dynamodb#StringAttributeValue", + "traits": { + "smithy.api#documentation": "

An attribute of type String. For example:

\n

\n \"S\": \"Hello\"\n

" + } + }, + "N": { + "target": "com.amazonaws.dynamodb#NumberAttributeValue", + "traits": { + "smithy.api#documentation": "

An attribute of type Number. For example:

\n

\n \"N\": \"123.45\"\n

\n

Numbers are sent across the network to DynamoDB as strings, to maximize compatibility\n across languages and libraries. However, DynamoDB treats them as number type attributes\n for mathematical operations.

" + } + }, + "B": { + "target": "com.amazonaws.dynamodb#BinaryAttributeValue", + "traits": { + "smithy.api#documentation": "

An attribute of type Binary. For example:

\n

\n \"B\": \"dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk\"\n

" + } + }, + "SS": { + "target": "com.amazonaws.dynamodb#StringSetAttributeValue", + "traits": { + "smithy.api#documentation": "

An attribute of type String Set. For example:

\n

\n \"SS\": [\"Giraffe\", \"Hippo\" ,\"Zebra\"]\n

" + } + }, + "NS": { + "target": "com.amazonaws.dynamodb#NumberSetAttributeValue", + "traits": { + "smithy.api#documentation": "

An attribute of type Number Set. For example:

\n

\n \"NS\": [\"42.2\", \"-19\", \"7.5\", \"3.14\"]\n

\n

Numbers are sent across the network to DynamoDB as strings, to maximize compatibility\n across languages and libraries. However, DynamoDB treats them as number type attributes\n for mathematical operations.

" + } + }, + "BS": { + "target": "com.amazonaws.dynamodb#BinarySetAttributeValue", + "traits": { + "smithy.api#documentation": "

An attribute of type Binary Set. For example:

\n

\n \"BS\": [\"U3Vubnk=\", \"UmFpbnk=\", \"U25vd3k=\"]\n

" + } + }, + "M": { + "target": "com.amazonaws.dynamodb#MapAttributeValue", + "traits": { + "smithy.api#documentation": "

An attribute of type Map. For example:

\n

\n \"M\": {\"Name\": {\"S\": \"Joe\"}, \"Age\": {\"N\": \"35\"}}\n

" + } + }, + "L": { + "target": "com.amazonaws.dynamodb#ListAttributeValue", + "traits": { + "smithy.api#documentation": "

An attribute of type List. For example:

\n

\n \"L\": [ {\"S\": \"Cookies\"} , {\"S\": \"Coffee\"}, {\"N\": \"3.14159\"}]\n

" + } + }, + "NULL": { + "target": "com.amazonaws.dynamodb#NullAttributeValue", + "traits": { + "smithy.api#documentation": "

An attribute of type Null. For example:

\n

\n \"NULL\": true\n

" + } + }, + "BOOL": { + "target": "com.amazonaws.dynamodb#BooleanAttributeValue", + "traits": { + "smithy.api#documentation": "

An attribute of type Boolean. For example:

\n

\n \"BOOL\": true\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the data for an attribute.

\n

Each attribute value is described as a name-value pair. The name is the data type, and\n the value is the data itself.

\n

For more information, see Data Types in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "com.amazonaws.dynamodb#AttributeValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#AttributeValue" + } + }, + "com.amazonaws.dynamodb#AttributeValueUpdate": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.dynamodb#AttributeValue", + "traits": { + "smithy.api#documentation": "

Represents the data for an attribute.

\n

Each attribute value is described as a name-value pair. The name is the data type, and\n the value is the data itself.

\n

For more information, see Data Types in the Amazon DynamoDB Developer Guide.\n

" + } + }, + "Action": { + "target": "com.amazonaws.dynamodb#AttributeAction", + "traits": { + "smithy.api#documentation": "

Specifies how to perform the update. Valid values are PUT (default),\n DELETE, and ADD. The behavior depends on whether the\n specified primary key already exists in the table.

\n

\n If an item with the specified Key is found in\n the table:\n

\n \n

\n If no item with the specified Key is\n found:\n

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

For the UpdateItem operation, represents the attributes to be modified,\n the action to perform on each, and the new value for each.

\n \n

You cannot use UpdateItem to update any primary key attributes.\n Instead, you will need to delete the item, and then use PutItem to\n create a new item with new attributes.

\n \n

Attribute values cannot be null; string and binary type attributes must have lengths\n greater than zero; and set type attributes must not be empty. Requests with empty values\n will be rejected with a ValidationException exception.

" + } + }, + "com.amazonaws.dynamodb#AutoScalingPolicyDescription": { + "type": "structure", + "members": { + "PolicyName": { + "target": "com.amazonaws.dynamodb#AutoScalingPolicyName", + "traits": { + "smithy.api#documentation": "

The name of the scaling policy.

" + } + }, + "TargetTrackingScalingPolicyConfiguration": { + "target": "com.amazonaws.dynamodb#AutoScalingTargetTrackingScalingPolicyConfigurationDescription", + "traits": { + "smithy.api#documentation": "

Represents a target tracking scaling policy configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the properties of the scaling policy.

" + } + }, + "com.amazonaws.dynamodb#AutoScalingPolicyDescriptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#AutoScalingPolicyDescription" + } + }, + "com.amazonaws.dynamodb#AutoScalingPolicyName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^\\p{Print}+$" + } + }, + "com.amazonaws.dynamodb#AutoScalingPolicyUpdate": { + "type": "structure", + "members": { + "PolicyName": { + "target": "com.amazonaws.dynamodb#AutoScalingPolicyName", + "traits": { + "smithy.api#documentation": "

The name of the scaling policy.

" + } + }, + "TargetTrackingScalingPolicyConfiguration": { + "target": "com.amazonaws.dynamodb#AutoScalingTargetTrackingScalingPolicyConfigurationUpdate", + "traits": { + "smithy.api#documentation": "

Represents a target tracking scaling policy configuration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the auto scaling policy to be modified.

" + } + }, + "com.amazonaws.dynamodb#AutoScalingRoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1600 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" + } + }, + "com.amazonaws.dynamodb#AutoScalingSettingsDescription": { + "type": "structure", + "members": { + "MinimumUnits": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

The minimum capacity units that a global table or global secondary index should be\n scaled down to.

" + } + }, + "MaximumUnits": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

The maximum capacity units that a global table or global secondary index should be\n scaled up to.

" + } + }, + "AutoScalingDisabled": { + "target": "com.amazonaws.dynamodb#BooleanObject", + "traits": { + "smithy.api#documentation": "

Disabled auto scaling for this global table or global secondary index.

" + } + }, + "AutoScalingRoleArn": { + "target": "com.amazonaws.dynamodb#String", + "traits": { + "smithy.api#documentation": "

Role ARN used for configuring the auto scaling policy.

" + } + }, + "ScalingPolicies": { + "target": "com.amazonaws.dynamodb#AutoScalingPolicyDescriptionList", + "traits": { + "smithy.api#documentation": "

Information about the scaling policies.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the auto scaling settings for a global table or global secondary\n index.

" + } + }, + "com.amazonaws.dynamodb#AutoScalingSettingsUpdate": { + "type": "structure", + "members": { + "MinimumUnits": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

The minimum capacity units that a global table or global secondary index should be\n scaled down to.

" + } + }, + "MaximumUnits": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

The maximum capacity units that a global table or global secondary index should be\n scaled up to.

" + } + }, + "AutoScalingDisabled": { + "target": "com.amazonaws.dynamodb#BooleanObject", + "traits": { + "smithy.api#documentation": "

Disabled auto scaling for this global table or global secondary index.

" + } + }, + "AutoScalingRoleArn": { + "target": "com.amazonaws.dynamodb#AutoScalingRoleArn", + "traits": { + "smithy.api#documentation": "

Role ARN used for configuring auto scaling policy.

" + } + }, + "ScalingPolicyUpdate": { + "target": "com.amazonaws.dynamodb#AutoScalingPolicyUpdate", + "traits": { + "smithy.api#documentation": "

The scaling policy to apply for scaling target global table or global secondary index\n capacity units.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the auto scaling settings to be modified for a global table or global\n secondary index.

" + } + }, + "com.amazonaws.dynamodb#AutoScalingTargetTrackingScalingPolicyConfigurationDescription": { + "type": "structure", + "members": { + "DisableScaleIn": { + "target": "com.amazonaws.dynamodb#BooleanObject", + "traits": { + "smithy.api#documentation": "

Indicates whether scale in by the target tracking policy is disabled. If the value is\n true, scale in is disabled and the target tracking policy won't remove capacity from the\n scalable resource. Otherwise, scale in is enabled and the target tracking policy can\n remove capacity from the scalable resource. The default value is false.

" + } + }, + "ScaleInCooldown": { + "target": "com.amazonaws.dynamodb#IntegerObject", + "traits": { + "smithy.api#documentation": "

The amount of time, in seconds, after a scale in activity completes before another\n scale in activity can start. The cooldown period is used to block subsequent scale in\n requests until it has expired. You should scale in conservatively to protect your\n application's availability. However, if another alarm triggers a scale out policy during\n the cooldown period after a scale-in, application auto scaling scales out your scalable\n target immediately.

" + } + }, + "ScaleOutCooldown": { + "target": "com.amazonaws.dynamodb#IntegerObject", + "traits": { + "smithy.api#documentation": "

The amount of time, in seconds, after a scale out activity completes before another\n scale out activity can start. While the cooldown period is in effect, the capacity that\n has been added by the previous scale out event that initiated the cooldown is calculated\n as part of the desired capacity for the next scale out. You should continuously (but not\n excessively) scale out.

" + } + }, + "TargetValue": { + "target": "com.amazonaws.dynamodb#DoubleObject", + "traits": { + "smithy.api#documentation": "

The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10)\n or 2e-360 to 2e360 (Base 2).

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the properties of a target tracking scaling policy.

" + } + }, + "com.amazonaws.dynamodb#AutoScalingTargetTrackingScalingPolicyConfigurationUpdate": { + "type": "structure", + "members": { + "DisableScaleIn": { + "target": "com.amazonaws.dynamodb#BooleanObject", + "traits": { + "smithy.api#documentation": "

Indicates whether scale in by the target tracking policy is disabled. If the value is\n true, scale in is disabled and the target tracking policy won't remove capacity from the\n scalable resource. Otherwise, scale in is enabled and the target tracking policy can\n remove capacity from the scalable resource. The default value is false.

" + } + }, + "ScaleInCooldown": { + "target": "com.amazonaws.dynamodb#IntegerObject", + "traits": { + "smithy.api#documentation": "

The amount of time, in seconds, after a scale in activity completes before another\n scale in activity can start. The cooldown period is used to block subsequent scale in\n requests until it has expired. You should scale in conservatively to protect your\n application's availability. However, if another alarm triggers a scale out policy during\n the cooldown period after a scale-in, application auto scaling scales out your scalable\n target immediately.

" + } + }, + "ScaleOutCooldown": { + "target": "com.amazonaws.dynamodb#IntegerObject", + "traits": { + "smithy.api#documentation": "

The amount of time, in seconds, after a scale out activity completes before another\n scale out activity can start. While the cooldown period is in effect, the capacity that\n has been added by the previous scale out event that initiated the cooldown is calculated\n as part of the desired capacity for the next scale out. You should continuously (but not\n excessively) scale out.

" + } + }, + "TargetValue": { + "target": "com.amazonaws.dynamodb#DoubleObject", + "traits": { + "smithy.api#documentation": "

The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10)\n or 2e-360 to 2e360 (Base 2).

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the settings of a target tracking scaling policy that will be\n modified.

" + } + }, + "com.amazonaws.dynamodb#Backfilling": { + "type": "boolean" + }, + "com.amazonaws.dynamodb#BackupArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 37, + "max": 1024 + } + } + }, + "com.amazonaws.dynamodb#BackupCreationDateTime": { + "type": "timestamp" + }, + "com.amazonaws.dynamodb#BackupDescription": { + "type": "structure", + "members": { + "BackupDetails": { + "target": "com.amazonaws.dynamodb#BackupDetails", + "traits": { + "smithy.api#documentation": "

Contains the details of the backup created for the table.

" + } + }, + "SourceTableDetails": { + "target": "com.amazonaws.dynamodb#SourceTableDetails", + "traits": { + "smithy.api#documentation": "

Contains the details of the table when the backup was created.

" + } + }, + "SourceTableFeatureDetails": { + "target": "com.amazonaws.dynamodb#SourceTableFeatureDetails", + "traits": { + "smithy.api#documentation": "

Contains the details of the features enabled on the table when the backup was created.\n For example, LSIs, GSIs, streams, TTL.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the description of the backup created for the table.

" + } + }, + "com.amazonaws.dynamodb#BackupDetails": { + "type": "structure", + "members": { + "BackupArn": { + "target": "com.amazonaws.dynamodb#BackupArn", + "traits": { + "smithy.api#documentation": "

ARN associated with the backup.

", + "smithy.api#required": {} + } + }, + "BackupName": { + "target": "com.amazonaws.dynamodb#BackupName", + "traits": { + "smithy.api#documentation": "

Name of the requested backup.

", + "smithy.api#required": {} + } + }, + "BackupSizeBytes": { + "target": "com.amazonaws.dynamodb#BackupSizeBytes", + "traits": { + "smithy.api#documentation": "

Size of the backup in bytes. DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.

" + } + }, + "BackupStatus": { + "target": "com.amazonaws.dynamodb#BackupStatus", + "traits": { + "smithy.api#documentation": "

Backup can be in one of the following states: CREATING, ACTIVE, DELETED.

", + "smithy.api#required": {} + } + }, + "BackupType": { + "target": "com.amazonaws.dynamodb#BackupType", + "traits": { + "smithy.api#documentation": "

BackupType:

\n ", + "smithy.api#required": {} + } + }, + "BackupCreationDateTime": { + "target": "com.amazonaws.dynamodb#BackupCreationDateTime", + "traits": { + "smithy.api#documentation": "

Time at which the backup was created. This is the request time of the backup.

", + "smithy.api#required": {} + } + }, + "BackupExpiryDateTime": { + "target": "com.amazonaws.dynamodb#Date", + "traits": { + "smithy.api#documentation": "

Time at which the automatic on-demand backup created by DynamoDB will\n expire. This SYSTEM on-demand backup expires automatically 35 days after\n its creation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details of the backup created for the table.

" + } + }, + "com.amazonaws.dynamodb#BackupInUseException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

There is another ongoing conflicting backup control plane operation on the table.\n The backup is either being created, deleted or restored to a table.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#BackupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_.-]+$" + } + }, + "com.amazonaws.dynamodb#BackupNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

Backup not found for the given BackupARN.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#BackupSizeBytes": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.dynamodb#BackupStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + }, + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + } + } + }, + "com.amazonaws.dynamodb#BackupSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#BackupSummary" + } + }, + "com.amazonaws.dynamodb#BackupSummary": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

Name of the table.

" + } + }, + "TableId": { + "target": "com.amazonaws.dynamodb#TableId", + "traits": { + "smithy.api#documentation": "

Unique identifier for the table.

" + } + }, + "TableArn": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

ARN associated with the table.

" + } + }, + "BackupArn": { + "target": "com.amazonaws.dynamodb#BackupArn", + "traits": { + "smithy.api#documentation": "

ARN associated with the backup.

" + } + }, + "BackupName": { + "target": "com.amazonaws.dynamodb#BackupName", + "traits": { + "smithy.api#documentation": "

Name of the specified backup.

" + } + }, + "BackupCreationDateTime": { + "target": "com.amazonaws.dynamodb#BackupCreationDateTime", + "traits": { + "smithy.api#documentation": "

Time at which the backup was created.

" + } + }, + "BackupExpiryDateTime": { + "target": "com.amazonaws.dynamodb#Date", + "traits": { + "smithy.api#documentation": "

Time at which the automatic on-demand backup created by DynamoDB will\n expire. This SYSTEM on-demand backup expires automatically 35 days after\n its creation.

" + } + }, + "BackupStatus": { + "target": "com.amazonaws.dynamodb#BackupStatus", + "traits": { + "smithy.api#documentation": "

Backup can be in one of the following states: CREATING, ACTIVE, DELETED.

" + } + }, + "BackupType": { + "target": "com.amazonaws.dynamodb#BackupType", + "traits": { + "smithy.api#documentation": "

BackupType:

\n " + } + }, + "BackupSizeBytes": { + "target": "com.amazonaws.dynamodb#BackupSizeBytes", + "traits": { + "smithy.api#documentation": "

Size of the backup in bytes.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details for the backup.

" + } + }, + "com.amazonaws.dynamodb#BackupType": { + "type": "enum", + "members": { + "USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USER" + } + }, + "SYSTEM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYSTEM" + } + }, + "AWS_BACKUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_BACKUP" + } + } + } + }, + "com.amazonaws.dynamodb#BackupTypeFilter": { + "type": "enum", + "members": { + "USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USER" + } + }, + "SYSTEM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYSTEM" + } + }, + "AWS_BACKUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_BACKUP" + } + }, + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + } + } + }, + "com.amazonaws.dynamodb#BackupsInputLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.dynamodb#BatchExecuteStatement": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#BatchExecuteStatementInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#BatchExecuteStatementOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#RequestLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

This operation allows you to perform batch reads or writes on data stored in DynamoDB,\n using PartiQL. Each read statement in a BatchExecuteStatement must specify\n an equality condition on all key attributes. This enforces that each SELECT\n statement in a batch returns at most a single item. For more information, see Running batch operations with PartiQL for DynamoDB\n .

\n \n

The entire batch must consist of either read statements or write statements, you\n cannot mix both in one batch.

\n \n \n

A HTTP 200 response does not mean that all statements in the BatchExecuteStatement\n succeeded. Error details for individual statements can be found under the Error field of the BatchStatementResponse for each\n statement.

\n " + } + }, + "com.amazonaws.dynamodb#BatchExecuteStatementInput": { + "type": "structure", + "members": { + "Statements": { + "target": "com.amazonaws.dynamodb#PartiQLBatchRequest", + "traits": { + "smithy.api#documentation": "

The list of PartiQL statements representing the batch to run.

", + "smithy.api#required": {} + } + }, + "ReturnConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ReturnConsumedCapacity" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#BatchExecuteStatementOutput": { + "type": "structure", + "members": { + "Responses": { + "target": "com.amazonaws.dynamodb#PartiQLBatchResponse", + "traits": { + "smithy.api#documentation": "

The response to each PartiQL statement in the batch. The values of the list are\n ordered according to the ordering of the request statements.

" + } + }, + "ConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ConsumedCapacityMultiple", + "traits": { + "smithy.api#documentation": "

The capacity units consumed by the entire operation. The values of the list are\n ordered according to the ordering of the statements.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#BatchGetItem": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#BatchGetItemInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#BatchGetItemOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.dynamodb#RequestLimitExceeded" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

The BatchGetItem operation returns the attributes of one or more items\n from one or more tables. You identify requested items by primary key.

\n

A single operation can retrieve up to 16 MB of data, which can contain as many as 100\n items. BatchGetItem returns a partial result if the response size limit is\n exceeded, the table's provisioned throughput is exceeded, more than 1MB per partition is\n requested, or an internal processing failure occurs. If a partial result is returned,\n the operation returns a value for UnprocessedKeys. You can use this value\n to retry the operation starting with the next item to get.

\n \n

If you request more than 100 items, BatchGetItem returns a\n ValidationException with the message \"Too many items requested for\n the BatchGetItem call.\"

\n \n

For example, if you ask to retrieve 100 items, but each individual item is 300 KB in\n size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns\n an appropriate UnprocessedKeys value so you can get the next page of\n results. If desired, your application can include its own logic to assemble the pages of\n results into one dataset.

\n

If none of the items can be processed due to insufficient\n provisioned throughput on all of the tables in the request, then\n BatchGetItem returns a\n ProvisionedThroughputExceededException. If at least\n one of the items is successfully processed, then\n BatchGetItem completes successfully, while returning the keys of the\n unread items in UnprocessedKeys.

\n \n

If DynamoDB returns any unprocessed items, you should retry the batch operation on\n those items. However, we strongly recommend that you use an exponential\n backoff algorithm. If you retry the batch operation immediately, the\n underlying read or write requests can still fail due to throttling on the individual\n tables. If you delay the batch operation using exponential backoff, the individual\n requests in the batch are much more likely to succeed.

\n

For more information, see Batch Operations and Error Handling in the Amazon DynamoDB\n Developer Guide.

\n \n

By default, BatchGetItem performs eventually consistent reads on every\n table in the request. If you want strongly consistent reads instead, you can set\n ConsistentRead to true for any or all tables.

\n

In order to minimize response latency, BatchGetItem may retrieve items in\n parallel.

\n

When designing your application, keep in mind that DynamoDB does not return items in\n any particular order. To help parse the response by item, include the primary key values\n for the items in your request in the ProjectionExpression parameter.

\n

If a requested item does not exist, it is not returned in the result. Requests for\n nonexistent items consume the minimum read capacity units according to the type of read.\n For more information, see Working with Tables in the Amazon DynamoDB Developer\n Guide.

", + "smithy.api#examples": [ + { + "title": "To retrieve multiple items from a table", + "documentation": "This example reads multiple items from the Music table using a batch of three GetItem requests. Only the AlbumTitle attribute is returned.", + "input": { + "RequestItems": { + "Music": { + "Keys": [ + { + "Artist": { + "S": "No One You Know" + }, + "SongTitle": { + "S": "Call Me Today" + } + }, + { + "Artist": { + "S": "Acme Band" + }, + "SongTitle": { + "S": "Happy Day" + } + }, + { + "Artist": { + "S": "No One You Know" + }, + "SongTitle": { + "S": "Scared of My Shadow" + } + } + ], + "ProjectionExpression": "AlbumTitle" + } + } + }, + "output": { + "Responses": { + "Music": [ + { + "AlbumTitle": { + "S": "Somewhat Famous" + } + }, + { + "AlbumTitle": { + "S": "Blue Sky Blues" + } + }, + { + "AlbumTitle": { + "S": "Louder Than Ever" + } + } + ] + } + } + } + ] + } + }, + "com.amazonaws.dynamodb#BatchGetItemInput": { + "type": "structure", + "members": { + "RequestItems": { + "target": "com.amazonaws.dynamodb#BatchGetRequestMap", + "traits": { + "smithy.api#documentation": "

A map of one or more table names or table ARNs and, for each table, a map that\n describes one or more items to retrieve from that table. Each table name or ARN can be\n used only once per BatchGetItem request.

\n

Each element in the map of items to retrieve consists of the following:

\n ", + "smithy.api#required": {} + } + }, + "ReturnConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ReturnConsumedCapacity" + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a BatchGetItem operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#BatchGetItemOutput": { + "type": "structure", + "members": { + "Responses": { + "target": "com.amazonaws.dynamodb#BatchGetResponseMap", + "traits": { + "smithy.api#documentation": "

A map of table name or table ARN to a list of items. Each object in\n Responses consists of a table name or ARN, along with a map of\n attribute data consisting of the data type and attribute value.

" + } + }, + "UnprocessedKeys": { + "target": "com.amazonaws.dynamodb#BatchGetRequestMap", + "traits": { + "smithy.api#documentation": "

A map of tables and their respective keys that were not processed with the current\n response. The UnprocessedKeys value is in the same form as\n RequestItems, so the value can be provided directly to a subsequent\n BatchGetItem operation. For more information, see\n RequestItems in the Request Parameters section.

\n

Each element consists of:

\n \n

If there are no unprocessed keys remaining, the response contains an empty\n UnprocessedKeys map.

" + } + }, + "ConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ConsumedCapacityMultiple", + "traits": { + "smithy.api#documentation": "

The read capacity units consumed by the entire BatchGetItem\n operation.

\n

Each element consists of:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a BatchGetItem operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#BatchGetRequestMap": { + "type": "map", + "key": { + "target": "com.amazonaws.dynamodb#TableArn" + }, + "value": { + "target": "com.amazonaws.dynamodb#KeysAndAttributes" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.dynamodb#BatchGetResponseMap": { + "type": "map", + "key": { + "target": "com.amazonaws.dynamodb#TableArn" + }, + "value": { + "target": "com.amazonaws.dynamodb#ItemList" + } + }, + "com.amazonaws.dynamodb#BatchStatementError": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.dynamodb#BatchStatementErrorCodeEnum", + "traits": { + "smithy.api#documentation": "

The error code associated with the failed PartiQL batch statement.

" + } + }, + "Message": { + "target": "com.amazonaws.dynamodb#String", + "traits": { + "smithy.api#documentation": "

The error message associated with the PartiQL batch response.

" + } + }, + "Item": { + "target": "com.amazonaws.dynamodb#AttributeMap", + "traits": { + "smithy.api#documentation": "

The item which caused the condition check to fail. This will be set if\n ReturnValuesOnConditionCheckFailure is specified as ALL_OLD.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An error associated with a statement in a PartiQL batch that was run.

" + } + }, + "com.amazonaws.dynamodb#BatchStatementErrorCodeEnum": { + "type": "enum", + "members": { + "ConditionalCheckFailed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ConditionalCheckFailed" + } + }, + "ItemCollectionSizeLimitExceeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ItemCollectionSizeLimitExceeded" + } + }, + "RequestLimitExceeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RequestLimitExceeded" + } + }, + "ValidationError": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ValidationError" + } + }, + "ProvisionedThroughputExceeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ProvisionedThroughputExceeded" + } + }, + "TransactionConflict": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TransactionConflict" + } + }, + "ThrottlingError": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ThrottlingError" + } + }, + "InternalServerError": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InternalServerError" + } + }, + "ResourceNotFound": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ResourceNotFound" + } + }, + "AccessDenied": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AccessDenied" + } + }, + "DuplicateItem": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DuplicateItem" + } + } + } + }, + "com.amazonaws.dynamodb#BatchStatementRequest": { + "type": "structure", + "members": { + "Statement": { + "target": "com.amazonaws.dynamodb#PartiQLStatement", + "traits": { + "smithy.api#documentation": "

A valid PartiQL statement.

", + "smithy.api#required": {} + } + }, + "Parameters": { + "target": "com.amazonaws.dynamodb#PreparedStatementParameters", + "traits": { + "smithy.api#documentation": "

The parameters associated with a PartiQL statement in the batch request.

" + } + }, + "ConsistentRead": { + "target": "com.amazonaws.dynamodb#ConsistentRead", + "traits": { + "smithy.api#documentation": "

The read consistency of the PartiQL batch request.

" + } + }, + "ReturnValuesOnConditionCheckFailure": { + "target": "com.amazonaws.dynamodb#ReturnValuesOnConditionCheckFailure", + "traits": { + "smithy.api#documentation": "

An optional parameter that returns the item attributes for a PartiQL batch request\n operation that failed a condition check.

\n

There is no additional cost associated with requesting a return value aside from the\n small network and processing overhead of receiving a larger response. No read capacity\n units are consumed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A PartiQL batch statement request.

" + } + }, + "com.amazonaws.dynamodb#BatchStatementResponse": { + "type": "structure", + "members": { + "Error": { + "target": "com.amazonaws.dynamodb#BatchStatementError", + "traits": { + "smithy.api#documentation": "

The error associated with a failed PartiQL batch statement.

" + } + }, + "TableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The table name associated with a failed PartiQL batch statement.

" + } + }, + "Item": { + "target": "com.amazonaws.dynamodb#AttributeMap", + "traits": { + "smithy.api#documentation": "

A DynamoDB item associated with a BatchStatementResponse

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A PartiQL batch statement response..

" + } + }, + "com.amazonaws.dynamodb#BatchWriteItem": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#BatchWriteItemInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#BatchWriteItemOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#ItemCollectionSizeLimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.dynamodb#RequestLimitExceeded" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

The BatchWriteItem operation puts or deletes multiple items in one or\n more tables. A single call to BatchWriteItem can transmit up to 16MB of\n data over the network, consisting of up to 25 item put or delete operations. While\n individual items can be up to 400 KB once stored, it's important to note that an item's\n representation might be greater than 400KB while being sent in DynamoDB's JSON format\n for the API call. For more details on this distinction, see Naming Rules and Data Types.

\n \n

\n BatchWriteItem cannot update items. If you perform a\n BatchWriteItem operation on an existing item, that item's values\n will be overwritten by the operation and it will appear like it was updated. To\n update items, we recommend you use the UpdateItem action.

\n \n

The individual PutItem and DeleteItem operations specified\n in BatchWriteItem are atomic; however BatchWriteItem as a\n whole is not. If any requested operations fail because the table's provisioned\n throughput is exceeded or an internal processing failure occurs, the failed operations\n are returned in the UnprocessedItems response parameter. You can\n investigate and optionally resend the requests. Typically, you would call\n BatchWriteItem in a loop. Each iteration would check for unprocessed\n items and submit a new BatchWriteItem request with those unprocessed items\n until all items have been processed.

\n

For tables and indexes with provisioned capacity, if none of the items can be\n processed due to insufficient provisioned throughput on all of the tables in the\n request, then BatchWriteItem returns a\n ProvisionedThroughputExceededException. For all tables and indexes, if\n none of the items can be processed due to other throttling scenarios (such as exceeding\n partition level limits), then BatchWriteItem returns a\n ThrottlingException.

\n \n

If DynamoDB returns any unprocessed items, you should retry the batch operation on\n those items. However, we strongly recommend that you use an exponential\n backoff algorithm. If you retry the batch operation immediately, the\n underlying read or write requests can still fail due to throttling on the individual\n tables. If you delay the batch operation using exponential backoff, the individual\n requests in the batch are much more likely to succeed.

\n

For more information, see Batch Operations and Error Handling in the Amazon DynamoDB\n Developer Guide.

\n \n

With BatchWriteItem, you can efficiently write or delete large amounts of\n data, such as from Amazon EMR, or copy data from another database into DynamoDB. In\n order to improve performance with these large-scale operations,\n BatchWriteItem does not behave in the same way as individual\n PutItem and DeleteItem calls would. For example, you\n cannot specify conditions on individual put and delete requests, and\n BatchWriteItem does not return deleted items in the response.

\n

If you use a programming language that supports concurrency, you can use threads to\n write items in parallel. Your application must include the necessary logic to manage the\n threads. With languages that don't support threading, you must update or delete the\n specified items one at a time. In both situations, BatchWriteItem performs\n the specified put and delete operations in parallel, giving you the power of the thread\n pool approach without having to introduce complexity into your application.

\n

Parallel processing reduces latency, but each specified put and delete request\n consumes the same number of write capacity units whether it is processed in parallel or\n not. Delete operations on nonexistent items consume one write capacity unit.

\n

If one or more of the following is true, DynamoDB rejects the entire batch write\n operation:

\n ", + "smithy.api#examples": [ + { + "title": "To add multiple items to a table", + "documentation": "This example adds three new items to the Music table using a batch of three PutItem requests.", + "input": { + "RequestItems": { + "Music": [ + { + "PutRequest": { + "Item": { + "AlbumTitle": { + "S": "Somewhat Famous" + }, + "SongTitle": { + "S": "Call Me Today" + }, + "Artist": { + "S": "No One You Know" + } + } + } + }, + { + "PutRequest": { + "Item": { + "AlbumTitle": { + "S": "Songs About Life" + }, + "SongTitle": { + "S": "Happy Day" + }, + "Artist": { + "S": "Acme Band" + } + } + } + }, + { + "PutRequest": { + "Item": { + "AlbumTitle": { + "S": "Blue Sky Blues" + }, + "SongTitle": { + "S": "Scared of My Shadow" + }, + "Artist": { + "S": "No One You Know" + } + } + } + } + ] + } + }, + "output": {} + } + ] + } + }, + "com.amazonaws.dynamodb#BatchWriteItemInput": { + "type": "structure", + "members": { + "RequestItems": { + "target": "com.amazonaws.dynamodb#BatchWriteItemRequestMap", + "traits": { + "smithy.api#documentation": "

A map of one or more table names or table ARNs and, for each table, a list of\n operations to be performed (DeleteRequest or PutRequest). Each\n element in the map consists of the following:

\n ", + "smithy.api#required": {} + } + }, + "ReturnConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ReturnConsumedCapacity" + }, + "ReturnItemCollectionMetrics": { + "target": "com.amazonaws.dynamodb#ReturnItemCollectionMetrics", + "traits": { + "smithy.api#documentation": "

Determines whether item collection metrics are returned. If set to SIZE,\n the response includes statistics about item collections, if any, that were modified\n during the operation are returned in the response. If set to NONE (the\n default), no statistics are returned.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a BatchWriteItem operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#BatchWriteItemOutput": { + "type": "structure", + "members": { + "UnprocessedItems": { + "target": "com.amazonaws.dynamodb#BatchWriteItemRequestMap", + "traits": { + "smithy.api#documentation": "

A map of tables and requests against those tables that were not processed. The\n UnprocessedItems value is in the same form as\n RequestItems, so you can provide this value directly to a subsequent\n BatchWriteItem operation. For more information, see\n RequestItems in the Request Parameters section.

\n

Each UnprocessedItems entry consists of a table name or table ARN\n and, for that table, a list of operations to perform (DeleteRequest or\n PutRequest).

\n \n

If there are no unprocessed items remaining, the response contains an empty\n UnprocessedItems map.

" + } + }, + "ItemCollectionMetrics": { + "target": "com.amazonaws.dynamodb#ItemCollectionMetricsPerTable", + "traits": { + "smithy.api#documentation": "

A list of tables that were processed by BatchWriteItem and, for each\n table, information about any item collections that were affected by individual\n DeleteItem or PutItem operations.

\n

Each entry consists of the following subelements:

\n " + } + }, + "ConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ConsumedCapacityMultiple", + "traits": { + "smithy.api#documentation": "

The capacity units consumed by the entire BatchWriteItem\n operation.

\n

Each element consists of:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a BatchWriteItem operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#BatchWriteItemRequestMap": { + "type": "map", + "key": { + "target": "com.amazonaws.dynamodb#TableArn" + }, + "value": { + "target": "com.amazonaws.dynamodb#WriteRequests" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.dynamodb#BilledSizeBytes": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.dynamodb#BillingMode": { + "type": "enum", + "members": { + "PROVISIONED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROVISIONED" + } + }, + "PAY_PER_REQUEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PAY_PER_REQUEST" + } + } + } + }, + "com.amazonaws.dynamodb#BillingModeSummary": { + "type": "structure", + "members": { + "BillingMode": { + "target": "com.amazonaws.dynamodb#BillingMode", + "traits": { + "smithy.api#documentation": "

Controls how you are charged for read and write throughput and how you manage\n capacity. This setting can be changed later.

\n " + } + }, + "LastUpdateToPayPerRequestDateTime": { + "target": "com.amazonaws.dynamodb#Date", + "traits": { + "smithy.api#documentation": "

Represents the time when PAY_PER_REQUEST was last set as the read/write\n capacity mode.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details for the read/write capacity mode. This page talks about\n PROVISIONED and PAY_PER_REQUEST billing modes. For more\n information about these modes, see Read/write capacity mode.

\n \n

You may need to switch to on-demand mode at least once in order to return a\n BillingModeSummary response.

\n " + } + }, + "com.amazonaws.dynamodb#BinaryAttributeValue": { + "type": "blob" + }, + "com.amazonaws.dynamodb#BinarySetAttributeValue": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#BinaryAttributeValue" + } + }, + "com.amazonaws.dynamodb#BooleanAttributeValue": { + "type": "boolean" + }, + "com.amazonaws.dynamodb#BooleanObject": { + "type": "boolean" + }, + "com.amazonaws.dynamodb#CancellationReason": { + "type": "structure", + "members": { + "Item": { + "target": "com.amazonaws.dynamodb#AttributeMap", + "traits": { + "smithy.api#documentation": "

Item in the request which caused the transaction to get cancelled.

" + } + }, + "Code": { + "target": "com.amazonaws.dynamodb#Code", + "traits": { + "smithy.api#documentation": "

Status code for the result of the cancelled transaction.

" + } + }, + "Message": { + "target": "com.amazonaws.dynamodb#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Cancellation reason message description.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An ordered list of errors for each item in the request which caused the transaction to\n get cancelled. The values of the list are ordered according to the ordering of the\n TransactWriteItems request parameter. If no error occurred for the\n associated item an error with a Null code and Null message will be present.

" + } + }, + "com.amazonaws.dynamodb#CancellationReasonList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#CancellationReason" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.dynamodb#Capacity": { + "type": "structure", + "members": { + "ReadCapacityUnits": { + "target": "com.amazonaws.dynamodb#ConsumedCapacityUnits", + "traits": { + "smithy.api#documentation": "

The total number of read capacity units consumed on a table or an index.

" + } + }, + "WriteCapacityUnits": { + "target": "com.amazonaws.dynamodb#ConsumedCapacityUnits", + "traits": { + "smithy.api#documentation": "

The total number of write capacity units consumed on a table or an index.

" + } + }, + "CapacityUnits": { + "target": "com.amazonaws.dynamodb#ConsumedCapacityUnits", + "traits": { + "smithy.api#documentation": "

The total number of capacity units consumed on a table or an index.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the amount of provisioned throughput capacity consumed on a table or an\n index.

" + } + }, + "com.amazonaws.dynamodb#ClientRequestToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 36 + } + } + }, + "com.amazonaws.dynamodb#ClientToken": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[^\\$]+$" + } + }, + "com.amazonaws.dynamodb#CloudWatchLogGroupArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.dynamodb#Code": { + "type": "string" + }, + "com.amazonaws.dynamodb#ComparisonOperator": { + "type": "enum", + "members": { + "EQ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQ" + } + }, + "NE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NE" + } + }, + "IN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN" + } + }, + "LE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LE" + } + }, + "LT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LT" + } + }, + "GE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GE" + } + }, + "GT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GT" + } + }, + "BETWEEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BETWEEN" + } + }, + "NOT_NULL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_NULL" + } + }, + "NULL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NULL" + } + }, + "CONTAINS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTAINS" + } + }, + "NOT_CONTAINS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_CONTAINS" + } + }, + "BEGINS_WITH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BEGINS_WITH" + } + } + } + }, + "com.amazonaws.dynamodb#Condition": { + "type": "structure", + "members": { + "AttributeValueList": { + "target": "com.amazonaws.dynamodb#AttributeValueList", + "traits": { + "smithy.api#documentation": "

One or more values to evaluate against the supplied attribute. The number of values in\n the list depends on the ComparisonOperator being used.

\n

For type Number, value comparisons are numeric.

\n

String value comparisons for greater than, equals, or less than are based on ASCII\n character code values. For example, a is greater than A, and\n a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.

\n

For Binary, DynamoDB treats each byte of the binary data as unsigned when it\n compares binary values.

" + } + }, + "ComparisonOperator": { + "target": "com.amazonaws.dynamodb#ComparisonOperator", + "traits": { + "smithy.api#documentation": "

A comparator for evaluating attributes. For example, equals, greater than, less than,\n etc.

\n

The following comparison operators are available:

\n

\n EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS |\n BEGINS_WITH | IN | BETWEEN\n

\n

The following are descriptions of each comparison operator.

\n \n

For usage examples of AttributeValueList and\n ComparisonOperator, see Legacy\n Conditional Parameters in the Amazon DynamoDB Developer\n Guide.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the selection criteria for a Query or Scan\n operation:

\n " + } + }, + "com.amazonaws.dynamodb#ConditionCheck": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.dynamodb#Key", + "traits": { + "smithy.api#documentation": "

The primary key of the item to be checked. Each element consists of an attribute name\n and a value for that attribute.

", + "smithy.api#required": {} + } + }, + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

Name of the table for the check item request. You can also provide the Amazon Resource Name (ARN) of\n the table in this parameter.

", + "smithy.api#required": {} + } + }, + "ConditionExpression": { + "target": "com.amazonaws.dynamodb#ConditionExpression", + "traits": { + "smithy.api#documentation": "

A condition that must be satisfied in order for a conditional update to succeed. For\n more information, see Condition expressions in the Amazon DynamoDB Developer\n Guide.

", + "smithy.api#required": {} + } + }, + "ExpressionAttributeNames": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", + "traits": { + "smithy.api#documentation": "

One or more substitution tokens for attribute names in an expression. For more\n information, see Expression attribute names in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ExpressionAttributeValues": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeValueMap", + "traits": { + "smithy.api#documentation": "

One or more values that can be substituted in an expression. For more information, see\n Condition expressions in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ReturnValuesOnConditionCheckFailure": { + "target": "com.amazonaws.dynamodb#ReturnValuesOnConditionCheckFailure", + "traits": { + "smithy.api#documentation": "

Use ReturnValuesOnConditionCheckFailure to get the item attributes if the\n ConditionCheck condition fails. For\n ReturnValuesOnConditionCheckFailure, the valid values are: NONE and\n ALL_OLD.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a request to perform a check that an item exists or to check the condition\n of specific attributes of the item.

" + } + }, + "com.amazonaws.dynamodb#ConditionExpression": { + "type": "string" + }, + "com.amazonaws.dynamodb#ConditionalCheckFailedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The conditional request failed.

" + } + }, + "Item": { + "target": "com.amazonaws.dynamodb#AttributeMap", + "traits": { + "smithy.api#documentation": "

Item which caused the ConditionalCheckFailedException.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A condition specified in the operation could not be evaluated.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#ConditionalOperator": { + "type": "enum", + "members": { + "AND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AND" + } + }, + "OR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OR" + } + } + } + }, + "com.amazonaws.dynamodb#ConfirmRemoveSelfResourceAccess": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.dynamodb#ConsistentRead": { + "type": "boolean" + }, + "com.amazonaws.dynamodb#ConsumedCapacity": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The name of the table that was affected by the operation. If you had specified the\n Amazon Resource Name (ARN) of a table in the input, you'll see the table ARN in the response.

" + } + }, + "CapacityUnits": { + "target": "com.amazonaws.dynamodb#ConsumedCapacityUnits", + "traits": { + "smithy.api#documentation": "

The total number of capacity units consumed by the operation.

" + } + }, + "ReadCapacityUnits": { + "target": "com.amazonaws.dynamodb#ConsumedCapacityUnits", + "traits": { + "smithy.api#documentation": "

The total number of read capacity units consumed by the operation.

" + } + }, + "WriteCapacityUnits": { + "target": "com.amazonaws.dynamodb#ConsumedCapacityUnits", + "traits": { + "smithy.api#documentation": "

The total number of write capacity units consumed by the operation.

" + } + }, + "Table": { + "target": "com.amazonaws.dynamodb#Capacity", + "traits": { + "smithy.api#documentation": "

The amount of throughput consumed on the table affected by the operation.

" + } + }, + "LocalSecondaryIndexes": { + "target": "com.amazonaws.dynamodb#SecondaryIndexesCapacityMap", + "traits": { + "smithy.api#documentation": "

The amount of throughput consumed on each local index affected by the\n operation.

" + } + }, + "GlobalSecondaryIndexes": { + "target": "com.amazonaws.dynamodb#SecondaryIndexesCapacityMap", + "traits": { + "smithy.api#documentation": "

The amount of throughput consumed on each global index affected by the\n operation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The capacity units consumed by an operation. The data returned includes the total\n provisioned throughput consumed, along with statistics for the table and any indexes\n involved in the operation. ConsumedCapacity is only returned if the request\n asked for it. For more information, see Provisioned capacity mode in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "com.amazonaws.dynamodb#ConsumedCapacityMultiple": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ConsumedCapacity" + } + }, + "com.amazonaws.dynamodb#ConsumedCapacityUnits": { + "type": "double" + }, + "com.amazonaws.dynamodb#ContinuousBackupsDescription": { + "type": "structure", + "members": { + "ContinuousBackupsStatus": { + "target": "com.amazonaws.dynamodb#ContinuousBackupsStatus", + "traits": { + "smithy.api#documentation": "

\n ContinuousBackupsStatus can be one of the following states: ENABLED,\n DISABLED

", + "smithy.api#required": {} + } + }, + "PointInTimeRecoveryDescription": { + "target": "com.amazonaws.dynamodb#PointInTimeRecoveryDescription", + "traits": { + "smithy.api#documentation": "

The description of the point in time recovery settings applied to the table.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the continuous backups and point in time recovery settings on the\n table.

" + } + }, + "com.amazonaws.dynamodb#ContinuousBackupsStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.dynamodb#ContinuousBackupsUnavailableException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

Backups have not yet been enabled for this table.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#ContributorInsightsAction": { + "type": "enum", + "members": { + "ENABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLE" + } + }, + "DISABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLE" + } + } + } + }, + "com.amazonaws.dynamodb#ContributorInsightsRule": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[A-Za-z0-9][A-Za-z0-9\\-\\_\\.]{0,126}[A-Za-z0-9]$" + } + }, + "com.amazonaws.dynamodb#ContributorInsightsRuleList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ContributorInsightsRule" + } + }, + "com.amazonaws.dynamodb#ContributorInsightsStatus": { + "type": "enum", + "members": { + "ENABLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLING" + } + }, + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLING" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.dynamodb#ContributorInsightsSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ContributorInsightsSummary" + } + }, + "com.amazonaws.dynamodb#ContributorInsightsSummary": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

Name of the table associated with the summary.

" + } + }, + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

Name of the index associated with the summary, if any.

" + } + }, + "ContributorInsightsStatus": { + "target": "com.amazonaws.dynamodb#ContributorInsightsStatus", + "traits": { + "smithy.api#documentation": "

Describes the current status for contributor insights for the given table and index,\n if applicable.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a Contributor Insights summary entry.

" + } + }, + "com.amazonaws.dynamodb#CreateBackup": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#CreateBackupInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#CreateBackupOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#BackupInUseException" + }, + { + "target": "com.amazonaws.dynamodb#ContinuousBackupsUnavailableException" + }, + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#TableInUseException" + }, + { + "target": "com.amazonaws.dynamodb#TableNotFoundException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Creates a backup for an existing table.

\n

Each time you create an on-demand backup, the entire table data is backed up. There\n is no limit to the number of on-demand backups that can be taken.

\n

When you create an on-demand backup, a time marker of the request is cataloged, and\n the backup is created asynchronously, by applying all changes until the time of the\n request to the last full table snapshot. Backup requests are processed instantaneously\n and become available for restore within minutes.

\n

You can call CreateBackup at a maximum rate of 50 times per\n second.

\n

All backups in DynamoDB work without consuming any provisioned throughput on the\n table.

\n

If you submit a backup request on 2018-12-14 at 14:25:00, the backup is guaranteed to\n contain all data committed to the table up to 14:24:00, and data committed after\n 14:26:00 will not be. The backup might contain data modifications made between 14:24:00\n and 14:26:00. On-demand backup does not support causal consistency.

\n

Along with data, the following are also included on the backups:

\n " + } + }, + "com.amazonaws.dynamodb#CreateBackupInput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this\n parameter.

", + "smithy.api#required": {} + } + }, + "BackupName": { + "target": "com.amazonaws.dynamodb#BackupName", + "traits": { + "smithy.api#documentation": "

Specified name for the backup.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#CreateBackupOutput": { + "type": "structure", + "members": { + "BackupDetails": { + "target": "com.amazonaws.dynamodb#BackupDetails", + "traits": { + "smithy.api#documentation": "

Contains the details of the backup created for the table.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#CreateGlobalSecondaryIndexAction": { + "type": "structure", + "members": { + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the global secondary index to be created.

", + "smithy.api#required": {} + } + }, + "KeySchema": { + "target": "com.amazonaws.dynamodb#KeySchema", + "traits": { + "smithy.api#documentation": "

The key schema for the global secondary index.

", + "smithy.api#required": {} + } + }, + "Projection": { + "target": "com.amazonaws.dynamodb#Projection", + "traits": { + "smithy.api#documentation": "

Represents attributes that are copied (projected) from the table into an index. These\n are in addition to the primary key attributes and index key attributes, which are\n automatically projected.

", + "smithy.api#required": {} + } + }, + "ProvisionedThroughput": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughput", + "traits": { + "smithy.api#documentation": "

Represents the provisioned throughput settings for the specified global secondary\n index.

\n

For current minimum and maximum provisioned throughput values, see Service,\n Account, and Table Quotas in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "OnDemandThroughput": { + "target": "com.amazonaws.dynamodb#OnDemandThroughput", + "traits": { + "smithy.api#documentation": "

The maximum number of read and write units for the global secondary index being\n created. If you use this parameter, you must specify MaxReadRequestUnits,\n MaxWriteRequestUnits, or both.

" + } + }, + "WarmThroughput": { + "target": "com.amazonaws.dynamodb#WarmThroughput", + "traits": { + "smithy.api#documentation": "

Represents the warm throughput value (in read units per second and write units per\n second) when creating a secondary index.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a new global secondary index to be added to an existing table.

" + } + }, + "com.amazonaws.dynamodb#CreateGlobalTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#CreateGlobalTableInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#CreateGlobalTableOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#GlobalTableAlreadyExistsException" + }, + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#TableNotFoundException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Creates a global table from an existing table. A global table creates a replication\n relationship between two or more DynamoDB tables with the same table name in the\n provided Regions.

\n \n

This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 (Current) when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).

\n

To determine which version you're using, see Determining the global table version you are using. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.

\n \n

If you want to add a new replica table to a global table, each of the following\n conditions must be true:

\n \n

If global secondary indexes are specified, then the following conditions must also be\n met:

\n \n

If local secondary indexes are specified, then the following conditions must also be\n met:

\n \n \n

Write capacity settings should be set consistently across your replica tables and\n secondary indexes. DynamoDB strongly recommends enabling auto scaling to manage the\n write capacity settings for all of your global tables replicas and indexes.

\n

If you prefer to manage write capacity settings manually, you should provision\n equal replicated write capacity units to your replica tables. You should also\n provision equal replicated write capacity units to matching secondary indexes across\n your global table.

\n " + } + }, + "com.amazonaws.dynamodb#CreateGlobalTableInput": { + "type": "structure", + "members": { + "GlobalTableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The global table name.

", + "smithy.api#required": {} + } + }, + "ReplicationGroup": { + "target": "com.amazonaws.dynamodb#ReplicaList", + "traits": { + "smithy.api#documentation": "

The Regions where the global table needs to be created.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#CreateGlobalTableOutput": { + "type": "structure", + "members": { + "GlobalTableDescription": { + "target": "com.amazonaws.dynamodb#GlobalTableDescription", + "traits": { + "smithy.api#documentation": "

Contains the details of the global table.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#CreateReplicaAction": { + "type": "structure", + "members": { + "RegionName": { + "target": "com.amazonaws.dynamodb#RegionName", + "traits": { + "smithy.api#documentation": "

The Region of the replica to be added.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a replica to be added.

" + } + }, + "com.amazonaws.dynamodb#CreateReplicationGroupMemberAction": { + "type": "structure", + "members": { + "RegionName": { + "target": "com.amazonaws.dynamodb#RegionName", + "traits": { + "smithy.api#documentation": "

The Region where the new replica will be created.

", + "smithy.api#required": {} + } + }, + "KMSMasterKeyId": { + "target": "com.amazonaws.dynamodb#KMSMasterKeyId", + "traits": { + "smithy.api#documentation": "

The KMS key that should be used for KMS encryption in\n the new replica. To specify a key, use its key ID, Amazon Resource Name (ARN), alias\n name, or alias ARN. Note that you should only provide this parameter if the key is\n different from the default DynamoDB KMS key\n alias/aws/dynamodb.

" + } + }, + "ProvisionedThroughputOverride": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughputOverride", + "traits": { + "smithy.api#documentation": "

Replica-specific provisioned throughput. If not specified, uses the source table's\n provisioned throughput settings.

" + } + }, + "OnDemandThroughputOverride": { + "target": "com.amazonaws.dynamodb#OnDemandThroughputOverride", + "traits": { + "smithy.api#documentation": "

The maximum on-demand throughput settings for the specified replica table being\n created. You can only modify MaxReadRequestUnits, because you can't modify\n MaxWriteRequestUnits for individual replica tables.

" + } + }, + "GlobalSecondaryIndexes": { + "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexList", + "traits": { + "smithy.api#documentation": "

Replica-specific global secondary index settings.

" + } + }, + "TableClassOverride": { + "target": "com.amazonaws.dynamodb#TableClass", + "traits": { + "smithy.api#documentation": "

Replica-specific table class. If not specified, uses the source table's table\n class.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a replica to be created.

" + } + }, + "com.amazonaws.dynamodb#CreateTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#CreateTableInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#CreateTableOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceInUseException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

The CreateTable operation adds a new table to your account. In an Amazon Web Services account, table names must be unique within each Region. That is, you can\n have two tables with same name if you create the tables in different Regions.

\n

\n CreateTable is an asynchronous operation. Upon receiving a\n CreateTable request, DynamoDB immediately returns a response with a\n TableStatus of CREATING. After the table is created,\n DynamoDB sets the TableStatus to ACTIVE. You can perform read\n and write operations only on an ACTIVE table.

\n

You can optionally define secondary indexes on the new table, as part of the\n CreateTable operation. If you want to create multiple tables with\n secondary indexes on them, you must create the tables sequentially. Only one table with\n secondary indexes can be in the CREATING state at any given time.

\n

You can use the DescribeTable action to check the table status.

" + } + }, + "com.amazonaws.dynamodb#CreateTableInput": { + "type": "structure", + "members": { + "AttributeDefinitions": { + "target": "com.amazonaws.dynamodb#AttributeDefinitions", + "traits": { + "smithy.api#documentation": "

An array of attributes that describe the key schema for the table and indexes.

", + "smithy.api#required": {} + } + }, + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The name of the table to create. You can also provide the Amazon Resource Name (ARN) of the table in\n this parameter.

", + "smithy.api#required": {} + } + }, + "KeySchema": { + "target": "com.amazonaws.dynamodb#KeySchema", + "traits": { + "smithy.api#documentation": "

Specifies the attributes that make up the primary key for a table or an index. The\n attributes in KeySchema must also be defined in the\n AttributeDefinitions array. For more information, see Data\n Model in the Amazon DynamoDB Developer Guide.

\n

Each KeySchemaElement in the array is composed of:

\n \n \n

The partition key of an item is also known as its hash\n attribute. The term \"hash attribute\" derives from the DynamoDB usage\n of an internal hash function to evenly distribute data items across partitions,\n based on their partition key values.

\n

The sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with the same\n partition key physically close together, in sorted order by the sort key\n value.

\n \n

For a simple primary key (partition key), you must provide exactly one element with a\n KeyType of HASH.

\n

For a composite primary key (partition key and sort key), you must provide exactly two\n elements, in this order: The first element must have a KeyType of\n HASH, and the second element must have a KeyType of\n RANGE.

\n

For more information, see Working with Tables in the Amazon DynamoDB Developer\n Guide.

", + "smithy.api#required": {} + } + }, + "LocalSecondaryIndexes": { + "target": "com.amazonaws.dynamodb#LocalSecondaryIndexList", + "traits": { + "smithy.api#documentation": "

One or more local secondary indexes (the maximum is 5) to be created on the table.\n Each index is scoped to a given partition key value. There is a 10 GB size limit per\n partition key value; otherwise, the size of a local secondary index is\n unconstrained.

\n

Each local secondary index in the array includes the following:

\n " + } + }, + "GlobalSecondaryIndexes": { + "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexList", + "traits": { + "smithy.api#documentation": "

One or more global secondary indexes (the maximum is 20) to be created on the table.\n Each global secondary index in the array includes the following:

\n " + } + }, + "BillingMode": { + "target": "com.amazonaws.dynamodb#BillingMode", + "traits": { + "smithy.api#documentation": "

Controls how you are charged for read and write throughput and how you manage\n capacity. This setting can be changed later.

\n " + } + }, + "ProvisionedThroughput": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughput", + "traits": { + "smithy.api#documentation": "

Represents the provisioned throughput settings for a specified table or index. The\n settings can be modified using the UpdateTable operation.

\n

If you set BillingMode as PROVISIONED, you must specify this property.\n If you set BillingMode as PAY_PER_REQUEST, you cannot specify this\n property.

\n

For current minimum and maximum provisioned throughput values, see Service,\n Account, and Table Quotas in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "StreamSpecification": { + "target": "com.amazonaws.dynamodb#StreamSpecification", + "traits": { + "smithy.api#documentation": "

The settings for DynamoDB Streams on the table. These settings consist of:

\n " + } + }, + "SSESpecification": { + "target": "com.amazonaws.dynamodb#SSESpecification", + "traits": { + "smithy.api#documentation": "

Represents the settings used to enable server-side encryption.

" + } + }, + "Tags": { + "target": "com.amazonaws.dynamodb#TagList", + "traits": { + "smithy.api#documentation": "

A list of key-value pairs to label the table. For more information, see Tagging\n for DynamoDB.

" + } + }, + "TableClass": { + "target": "com.amazonaws.dynamodb#TableClass", + "traits": { + "smithy.api#documentation": "

The table class of the new table. Valid values are STANDARD and\n STANDARD_INFREQUENT_ACCESS.

" + } + }, + "DeletionProtectionEnabled": { + "target": "com.amazonaws.dynamodb#DeletionProtectionEnabled", + "traits": { + "smithy.api#documentation": "

Indicates whether deletion protection is to be enabled (true) or disabled (false) on\n the table.

" + } + }, + "WarmThroughput": { + "target": "com.amazonaws.dynamodb#WarmThroughput", + "traits": { + "smithy.api#documentation": "

Represents the warm throughput (in read units per second and write units per second) for creating a table.

" + } + }, + "ResourcePolicy": { + "target": "com.amazonaws.dynamodb#ResourcePolicy", + "traits": { + "smithy.api#documentation": "

An Amazon Web Services resource-based policy document in JSON format that will be\n attached to the table.

\n

When you attach a resource-based policy while creating a table, the policy application\n is strongly consistent.

\n

The maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this\n limit. For a full list of all considerations that apply for resource-based policies, see\n Resource-based\n policy considerations.

\n \n

You need to specify the CreateTable and\n PutResourcePolicy\n IAM actions for authorizing a user to create a table with a\n resource-based policy.

\n " + } + }, + "OnDemandThroughput": { + "target": "com.amazonaws.dynamodb#OnDemandThroughput", + "traits": { + "smithy.api#documentation": "

Sets the maximum number of read and write units for the specified table in on-demand\n capacity mode. If you use this parameter, you must specify\n MaxReadRequestUnits, MaxWriteRequestUnits, or both.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a CreateTable operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#CreateTableOutput": { + "type": "structure", + "members": { + "TableDescription": { + "target": "com.amazonaws.dynamodb#TableDescription", + "traits": { + "smithy.api#documentation": "

Represents the properties of the table.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a CreateTable operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#CsvDelimiter": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#pattern": "^[,;:|\\t ]$" + } + }, + "com.amazonaws.dynamodb#CsvHeader": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 65536 + }, + "smithy.api#pattern": "^[\\x20-\\x21\\x23-\\x2B\\x2D-\\x7E]*$" + } + }, + "com.amazonaws.dynamodb#CsvHeaderList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#CsvHeader" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.dynamodb#CsvOptions": { + "type": "structure", + "members": { + "Delimiter": { + "target": "com.amazonaws.dynamodb#CsvDelimiter", + "traits": { + "smithy.api#documentation": "

The delimiter used for separating items in the CSV file being imported.

" + } + }, + "HeaderList": { + "target": "com.amazonaws.dynamodb#CsvHeaderList", + "traits": { + "smithy.api#documentation": "

List of the headers used to specify a common header for all source CSV files being\n imported. If this field is specified then the first line of each CSV file is treated as\n data instead of the header. If this field is not specified the the first line of each\n CSV file is treated as the header.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Processing options for the CSV file being imported.

" + } + }, + "com.amazonaws.dynamodb#Date": { + "type": "timestamp" + }, + "com.amazonaws.dynamodb#Delete": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.dynamodb#Key", + "traits": { + "smithy.api#documentation": "

The primary key of the item to be deleted. Each element consists of an attribute name\n and a value for that attribute.

", + "smithy.api#required": {} + } + }, + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

Name of the table in which the item to be deleted resides. You can also provide the\n Amazon Resource Name (ARN) of the table in this parameter.

", + "smithy.api#required": {} + } + }, + "ConditionExpression": { + "target": "com.amazonaws.dynamodb#ConditionExpression", + "traits": { + "smithy.api#documentation": "

A condition that must be satisfied in order for a conditional delete to\n succeed.

" + } + }, + "ExpressionAttributeNames": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", + "traits": { + "smithy.api#documentation": "

One or more substitution tokens for attribute names in an expression.

" + } + }, + "ExpressionAttributeValues": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeValueMap", + "traits": { + "smithy.api#documentation": "

One or more values that can be substituted in an expression.

" + } + }, + "ReturnValuesOnConditionCheckFailure": { + "target": "com.amazonaws.dynamodb#ReturnValuesOnConditionCheckFailure", + "traits": { + "smithy.api#documentation": "

Use ReturnValuesOnConditionCheckFailure to get the item attributes if the\n Delete condition fails. For\n ReturnValuesOnConditionCheckFailure, the valid values are: NONE and\n ALL_OLD.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a request to perform a DeleteItem operation.

" + } + }, + "com.amazonaws.dynamodb#DeleteBackup": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#DeleteBackupInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#DeleteBackupOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#BackupInUseException" + }, + { + "target": "com.amazonaws.dynamodb#BackupNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Deletes an existing backup of a table.

\n

You can call DeleteBackup at a maximum rate of 10 times per\n second.

" + } + }, + "com.amazonaws.dynamodb#DeleteBackupInput": { + "type": "structure", + "members": { + "BackupArn": { + "target": "com.amazonaws.dynamodb#BackupArn", + "traits": { + "smithy.api#documentation": "

The ARN associated with the backup.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#DeleteBackupOutput": { + "type": "structure", + "members": { + "BackupDescription": { + "target": "com.amazonaws.dynamodb#BackupDescription", + "traits": { + "smithy.api#documentation": "

Contains the description of the backup created for the table.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#DeleteGlobalSecondaryIndexAction": { + "type": "structure", + "members": { + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the global secondary index to be deleted.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a global secondary index to be deleted from an existing table.

" + } + }, + "com.amazonaws.dynamodb#DeleteItem": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#DeleteItemInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#DeleteItemOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#ConditionalCheckFailedException" + }, + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#ItemCollectionSizeLimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.dynamodb#ReplicatedWriteConflictException" + }, + { + "target": "com.amazonaws.dynamodb#RequestLimitExceeded" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#TransactionConflictException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Deletes a single item in a table by primary key. You can perform a conditional delete\n operation that deletes the item if it exists, or if it has an expected attribute\n value.

\n

In addition to deleting an item, you can also return the item's attribute values in\n the same operation, using the ReturnValues parameter.

\n

Unless you specify conditions, the DeleteItem is an idempotent operation;\n running it multiple times on the same item or attribute does not\n result in an error response.

\n

Conditional deletes are useful for deleting items only if specific conditions are met.\n If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not\n deleted.

", + "smithy.api#examples": [ + { + "title": "To delete an item", + "documentation": "This example deletes an item from the Music table.", + "input": { + "TableName": "Music", + "Key": { + "Artist": { + "S": "No One You Know" + }, + "SongTitle": { + "S": "Scared of My Shadow" + } + } + }, + "output": { + "ConsumedCapacity": { + "CapacityUnits": 1, + "TableName": "Music" + } + } + } + ] + } + }, + "com.amazonaws.dynamodb#DeleteItemInput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The name of the table from which to delete the item. You can also provide the\n Amazon Resource Name (ARN) of the table in this parameter.

", + "smithy.api#required": {} + } + }, + "Key": { + "target": "com.amazonaws.dynamodb#Key", + "traits": { + "smithy.api#documentation": "

A map of attribute names to AttributeValue objects, representing the\n primary key of the item to delete.

\n

For the primary key, you must provide all of the key attributes. For example, with a\n simple primary key, you only need to provide a value for the partition key. For a\n composite primary key, you must provide values for both the partition key and the sort\n key.

", + "smithy.api#required": {} + } + }, + "Expected": { + "target": "com.amazonaws.dynamodb#ExpectedAttributeMap", + "traits": { + "smithy.api#documentation": "

This is a legacy parameter. Use ConditionExpression instead. For more\n information, see Expected in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ConditionalOperator": { + "target": "com.amazonaws.dynamodb#ConditionalOperator", + "traits": { + "smithy.api#documentation": "

This is a legacy parameter. Use ConditionExpression instead. For more\n information, see ConditionalOperator in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ReturnValues": { + "target": "com.amazonaws.dynamodb#ReturnValue", + "traits": { + "smithy.api#documentation": "

Use ReturnValues if you want to get the item attributes as they appeared\n before they were deleted. For DeleteItem, the valid values are:

\n \n

There is no additional cost associated with requesting a return value aside from the\n small network and processing overhead of receiving a larger response. No read capacity\n units are consumed.

\n \n

The ReturnValues parameter is used by several DynamoDB operations;\n however, DeleteItem does not recognize any values other than\n NONE or ALL_OLD.

\n " + } + }, + "ReturnConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ReturnConsumedCapacity" + }, + "ReturnItemCollectionMetrics": { + "target": "com.amazonaws.dynamodb#ReturnItemCollectionMetrics", + "traits": { + "smithy.api#documentation": "

Determines whether item collection metrics are returned. If set to SIZE,\n the response includes statistics about item collections, if any, that were modified\n during the operation are returned in the response. If set to NONE (the\n default), no statistics are returned.

" + } + }, + "ConditionExpression": { + "target": "com.amazonaws.dynamodb#ConditionExpression", + "traits": { + "smithy.api#documentation": "

A condition that must be satisfied in order for a conditional DeleteItem\n to succeed.

\n

An expression can contain any of the following:

\n \n

For more information about condition expressions, see Condition Expressions in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ExpressionAttributeNames": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", + "traits": { + "smithy.api#documentation": "

One or more substitution tokens for attribute names in an expression. The following\n are some use cases for using ExpressionAttributeNames:

\n \n

Use the # character in an expression to dereference\n an attribute name. For example, consider the following attribute name:

\n \n

The name of this attribute conflicts with a reserved word, so it cannot be used\n directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer\n Guide). To work around this, you could specify the following for\n ExpressionAttributeNames:

\n \n

You could then use this substitution in an expression, as in this example:

\n \n \n

Tokens that begin with the : character are\n expression attribute values, which are placeholders for the\n actual value at runtime.

\n \n

For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ExpressionAttributeValues": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeValueMap", + "traits": { + "smithy.api#documentation": "

One or more values that can be substituted in an expression.

\n

Use the : (colon) character in an expression to\n dereference an attribute value. For example, suppose that you wanted to check whether\n the value of the ProductStatus attribute was one of the following:

\n

\n Available | Backordered | Discontinued\n

\n

You would first need to specify ExpressionAttributeValues as\n follows:

\n

\n { \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"},\n \":disc\":{\"S\":\"Discontinued\"} }\n

\n

You could then use these values in an expression, such as this:

\n

\n ProductStatus IN (:avail, :back, :disc)\n

\n

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ReturnValuesOnConditionCheckFailure": { + "target": "com.amazonaws.dynamodb#ReturnValuesOnConditionCheckFailure", + "traits": { + "smithy.api#documentation": "

An optional parameter that returns the item attributes for a DeleteItem\n operation that failed a condition check.

\n

There is no additional cost associated with requesting a return value aside from the\n small network and processing overhead of receiving a larger response. No read capacity\n units are consumed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a DeleteItem operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#DeleteItemOutput": { + "type": "structure", + "members": { + "Attributes": { + "target": "com.amazonaws.dynamodb#AttributeMap", + "traits": { + "smithy.api#documentation": "

A map of attribute names to AttributeValue objects, representing the item\n as it appeared before the DeleteItem operation. This map appears in the\n response only if ReturnValues was specified as ALL_OLD in the\n request.

" + } + }, + "ConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ConsumedCapacity", + "traits": { + "smithy.api#documentation": "

The capacity units consumed by the DeleteItem operation. The data\n returned includes the total provisioned throughput consumed, along with statistics for\n the table and any indexes involved in the operation. ConsumedCapacity is\n only returned if the ReturnConsumedCapacity parameter was specified. For\n more information, see Provisioned capacity mode in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ItemCollectionMetrics": { + "target": "com.amazonaws.dynamodb#ItemCollectionMetrics", + "traits": { + "smithy.api#documentation": "

Information about item collections, if any, that were affected by the\n DeleteItem operation. ItemCollectionMetrics is only\n returned if the ReturnItemCollectionMetrics parameter was specified. If the\n table does not have any local secondary indexes, this information is not returned in the\n response.

\n

Each ItemCollectionMetrics element consists of:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a DeleteItem operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#DeleteReplicaAction": { + "type": "structure", + "members": { + "RegionName": { + "target": "com.amazonaws.dynamodb#RegionName", + "traits": { + "smithy.api#documentation": "

The Region of the replica to be removed.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a replica to be removed.

" + } + }, + "com.amazonaws.dynamodb#DeleteReplicationGroupMemberAction": { + "type": "structure", + "members": { + "RegionName": { + "target": "com.amazonaws.dynamodb#RegionName", + "traits": { + "smithy.api#documentation": "

The Region where the replica exists.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a replica to be deleted.

" + } + }, + "com.amazonaws.dynamodb#DeleteRequest": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.dynamodb#Key", + "traits": { + "smithy.api#documentation": "

A map of attribute name to attribute values, representing the primary key of the item\n to delete. All of the table's primary key attributes must be specified, and their data\n types must match those of the table's key schema.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a request to perform a DeleteItem operation on an item.

" + } + }, + "com.amazonaws.dynamodb#DeleteResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#DeleteResourcePolicyInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#DeleteResourcePolicyOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#PolicyNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceInUseException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Deletes the resource-based policy attached to the resource, which can be a table or\n stream.

\n

\n DeleteResourcePolicy is an idempotent operation; running it multiple\n times on the same resource doesn't result in an error response,\n unless you specify an ExpectedRevisionId, which will then return a\n PolicyNotFoundException.

\n \n

To make sure that you don't inadvertently lock yourself out of your own resources,\n the root principal in your Amazon Web Services account can perform\n DeleteResourcePolicy requests, even if your resource-based policy\n explicitly denies the root principal's access.

\n \n \n

\n DeleteResourcePolicy is an asynchronous operation. If you issue a\n GetResourcePolicy request immediately after running the\n DeleteResourcePolicy request, DynamoDB might still return\n the deleted policy. This is because the policy for your resource might not have been\n deleted yet. Wait for a few seconds, and then try the GetResourcePolicy\n request again.

\n " + } + }, + "com.amazonaws.dynamodb#DeleteResourcePolicyInput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.dynamodb#ResourceArnString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the DynamoDB resource from which the policy will be\n removed. The resources you can specify include tables and streams. If you remove the\n policy of a table, it will also remove the permissions for the table's indexes defined\n in that policy document. This is because index permissions are defined in the table's\n policy.

", + "smithy.api#required": {} + } + }, + "ExpectedRevisionId": { + "target": "com.amazonaws.dynamodb#PolicyRevisionId", + "traits": { + "smithy.api#documentation": "

A string value that you can use to conditionally delete your policy. When you provide\n an expected revision ID, if the revision ID of the existing policy on the resource\n doesn't match or if there's no policy attached to the resource, the request will fail\n and return a PolicyNotFoundException.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#DeleteResourcePolicyOutput": { + "type": "structure", + "members": { + "RevisionId": { + "target": "com.amazonaws.dynamodb#PolicyRevisionId", + "traits": { + "smithy.api#documentation": "

A unique string that represents the revision ID of the policy. If you're comparing revision IDs, make sure to always use string comparison logic.

\n

This value will be empty if you make a request against a resource without a\n policy.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#DeleteTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#DeleteTableInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#DeleteTableOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceInUseException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

The DeleteTable operation deletes a table and all of its items. After a\n DeleteTable request, the specified table is in the\n DELETING state until DynamoDB completes the deletion. If the table is\n in the ACTIVE state, you can delete it. If a table is in\n CREATING or UPDATING states, then DynamoDB returns a\n ResourceInUseException. If the specified table does not exist, DynamoDB\n returns a ResourceNotFoundException. If table is already in the\n DELETING state, no error is returned.

\n \n

For global tables, this operation only applies to\n global tables using Version 2019.11.21 (Current version).

\n \n \n

DynamoDB might continue to accept data read and write operations, such as\n GetItem and PutItem, on a table in the\n DELETING state until the table deletion is complete. For the full\n list of table states, see TableStatus.

\n \n

When you delete a table, any indexes on that table are also deleted.

\n

If you have DynamoDB Streams enabled on the table, then the corresponding stream on\n that table goes into the DISABLED state, and the stream is automatically\n deleted after 24 hours.

\n

Use the DescribeTable action to check the status of the table.

", + "smithy.api#examples": [ + { + "title": "To delete a table", + "documentation": "This example deletes the Music table.", + "input": { + "TableName": "Music" + }, + "output": { + "TableDescription": { + "TableStatus": "DELETING", + "TableSizeBytes": 0, + "ItemCount": 0, + "TableName": "Music", + "ProvisionedThroughput": { + "NumberOfDecreasesToday": 1, + "WriteCapacityUnits": 5, + "ReadCapacityUnits": 5 + } + } + } + } + ] + } + }, + "com.amazonaws.dynamodb#DeleteTableInput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The name of the table to delete. You can also provide the Amazon Resource Name (ARN) of the table in\n this parameter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a DeleteTable operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#DeleteTableOutput": { + "type": "structure", + "members": { + "TableDescription": { + "target": "com.amazonaws.dynamodb#TableDescription", + "traits": { + "smithy.api#documentation": "

Represents the properties of a table.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a DeleteTable operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#DeletionProtectionEnabled": { + "type": "boolean" + }, + "com.amazonaws.dynamodb#DescribeBackup": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#DescribeBackupInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#DescribeBackupOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#BackupNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Describes an existing backup of a table.

\n

You can call DescribeBackup at a maximum rate of 10 times per\n second.

" + } + }, + "com.amazonaws.dynamodb#DescribeBackupInput": { + "type": "structure", + "members": { + "BackupArn": { + "target": "com.amazonaws.dynamodb#BackupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the backup.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#DescribeBackupOutput": { + "type": "structure", + "members": { + "BackupDescription": { + "target": "com.amazonaws.dynamodb#BackupDescription", + "traits": { + "smithy.api#documentation": "

Contains the description of the backup created for the table.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#DescribeContinuousBackups": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#DescribeContinuousBackupsInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#DescribeContinuousBackupsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#TableNotFoundException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Checks the status of continuous backups and point in time recovery on the specified\n table. Continuous backups are ENABLED on all tables at table creation. If\n point in time recovery is enabled, PointInTimeRecoveryStatus will be set to\n ENABLED.

\n

After continuous backups and point in time recovery are enabled, you can restore to\n any point in time within EarliestRestorableDateTime and\n LatestRestorableDateTime.

\n

\n LatestRestorableDateTime is typically 5 minutes before the current time.\n You can restore your table to any point in time in the last 35 days. You can set the recovery period to any value between 1 and 35 days.

\n

You can call DescribeContinuousBackups at a maximum rate of 10 times per\n second.

" + } + }, + "com.amazonaws.dynamodb#DescribeContinuousBackupsInput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

Name of the table for which the customer wants to check the continuous backups and\n point in time recovery settings.

\n

You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#DescribeContinuousBackupsOutput": { + "type": "structure", + "members": { + "ContinuousBackupsDescription": { + "target": "com.amazonaws.dynamodb#ContinuousBackupsDescription", + "traits": { + "smithy.api#documentation": "

Represents the continuous backups and point in time recovery settings on the\n table.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#DescribeContributorInsights": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#DescribeContributorInsightsInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#DescribeContributorInsightsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about contributor insights for a given table or global secondary\n index.

" + } + }, + "com.amazonaws.dynamodb#DescribeContributorInsightsInput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The name of the table to describe. You can also provide the Amazon Resource Name (ARN) of the table in\n this parameter.

", + "smithy.api#required": {} + } + }, + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the global secondary index to describe, if applicable.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#DescribeContributorInsightsOutput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The name of the table being described.

" + } + }, + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the global secondary index being described.

" + } + }, + "ContributorInsightsRuleList": { + "target": "com.amazonaws.dynamodb#ContributorInsightsRuleList", + "traits": { + "smithy.api#documentation": "

List of names of the associated contributor insights rules.

" + } + }, + "ContributorInsightsStatus": { + "target": "com.amazonaws.dynamodb#ContributorInsightsStatus", + "traits": { + "smithy.api#documentation": "

Current status of contributor insights.

" + } + }, + "LastUpdateDateTime": { + "target": "com.amazonaws.dynamodb#LastUpdateDateTime", + "traits": { + "smithy.api#documentation": "

Timestamp of the last time the status was changed.

" + } + }, + "FailureException": { + "target": "com.amazonaws.dynamodb#FailureException", + "traits": { + "smithy.api#documentation": "

Returns information about the last failure that was encountered.

\n

The most common exceptions for a FAILED status are:

\n " + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#DescribeEndpoints": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#DescribeEndpointsRequest" + }, + "output": { + "target": "com.amazonaws.dynamodb#DescribeEndpointsResponse" + }, + "traits": { + "smithy.api#documentation": "

Returns the regional endpoint information. For more information on policy permissions,\n please see Internetwork traffic privacy.

" + } + }, + "com.amazonaws.dynamodb#DescribeEndpointsRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#DescribeEndpointsResponse": { + "type": "structure", + "members": { + "Endpoints": { + "target": "com.amazonaws.dynamodb#Endpoints", + "traits": { + "smithy.api#documentation": "

List of endpoints.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#DescribeExport": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#DescribeExportInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#DescribeExportOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#ExportNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes an existing table export.

" + } + }, + "com.amazonaws.dynamodb#DescribeExportInput": { + "type": "structure", + "members": { + "ExportArn": { + "target": "com.amazonaws.dynamodb#ExportArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the export.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#DescribeExportOutput": { + "type": "structure", + "members": { + "ExportDescription": { + "target": "com.amazonaws.dynamodb#ExportDescription", + "traits": { + "smithy.api#documentation": "

Represents the properties of the export.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#DescribeGlobalTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#DescribeGlobalTableInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#DescribeGlobalTableOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#GlobalTableNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Returns information about the specified global table.

\n \n

This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 (Current) when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).

\n

To determine which version you're using, see Determining the global table version you are using. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.

\n " + } + }, + "com.amazonaws.dynamodb#DescribeGlobalTableInput": { + "type": "structure", + "members": { + "GlobalTableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The name of the global table.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#DescribeGlobalTableOutput": { + "type": "structure", + "members": { + "GlobalTableDescription": { + "target": "com.amazonaws.dynamodb#GlobalTableDescription", + "traits": { + "smithy.api#documentation": "

Contains the details of the global table.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#DescribeGlobalTableSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#DescribeGlobalTableSettingsInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#DescribeGlobalTableSettingsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#GlobalTableNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Describes Region-specific settings for a global table.

\n \n

This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 (Current) when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).

\n

To determine which version you're using, see Determining the global table version you are using. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.

\n " + } + }, + "com.amazonaws.dynamodb#DescribeGlobalTableSettingsInput": { + "type": "structure", + "members": { + "GlobalTableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The name of the global table to describe.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#DescribeGlobalTableSettingsOutput": { + "type": "structure", + "members": { + "GlobalTableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The name of the global table.

" + } + }, + "ReplicaSettings": { + "target": "com.amazonaws.dynamodb#ReplicaSettingsDescriptionList", + "traits": { + "smithy.api#documentation": "

The Region-specific settings for the global table.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#DescribeImport": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#DescribeImportInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#DescribeImportOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#ImportNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Represents the properties of the import.

" + } + }, + "com.amazonaws.dynamodb#DescribeImportInput": { + "type": "structure", + "members": { + "ImportArn": { + "target": "com.amazonaws.dynamodb#ImportArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the table you're importing to.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#DescribeImportOutput": { + "type": "structure", + "members": { + "ImportTableDescription": { + "target": "com.amazonaws.dynamodb#ImportTableDescription", + "traits": { + "smithy.api#documentation": "

Represents the properties of the table created for the import, and parameters of the\n import. The import parameters include import status, how many items were processed, and\n how many errors were encountered.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#DescribeKinesisStreamingDestination": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#DescribeKinesisStreamingDestinationInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#DescribeKinesisStreamingDestinationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Returns information about the status of Kinesis streaming.

" + } + }, + "com.amazonaws.dynamodb#DescribeKinesisStreamingDestinationInput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The name of the table being described. You can also provide the Amazon Resource Name (ARN) of the table\n in this parameter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#DescribeKinesisStreamingDestinationOutput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The name of the table being described.

" + } + }, + "KinesisDataStreamDestinations": { + "target": "com.amazonaws.dynamodb#KinesisDataStreamDestinations", + "traits": { + "smithy.api#documentation": "

The list of replica structures for the table being described.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#DescribeLimits": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#DescribeLimitsInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#DescribeLimitsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Returns the current provisioned-capacity quotas for your Amazon Web Services account in\n a Region, both for the Region as a whole and for any one DynamoDB table that you create\n there.

\n

When you establish an Amazon Web Services account, the account has initial quotas on\n the maximum read capacity units and write capacity units that you can provision across\n all of your DynamoDB tables in a given Region. Also, there are per-table\n quotas that apply when you create a table there. For more information, see Service,\n Account, and Table Quotas page in the Amazon DynamoDB\n Developer Guide.

\n

Although you can increase these quotas by filing a case at Amazon Web Services Support Center, obtaining the\n increase is not instantaneous. The DescribeLimits action lets you write\n code to compare the capacity you are currently using to those quotas imposed by your\n account so that you have enough time to apply for an increase before you hit a\n quota.

\n

For example, you could use one of the Amazon Web Services SDKs to do the\n following:

\n
    \n
  1. \n

    Call DescribeLimits for a particular Region to obtain your\n current account quotas on provisioned capacity there.

    \n
    2. \n
  2. \n

    Create a variable to hold the aggregate read capacity units provisioned for\n all your tables in that Region, and one to hold the aggregate write capacity\n units. Zero them both.

    \n
    3. \n
  3. \n

    Call ListTables to obtain a list of all your DynamoDB\n tables.

    \n
    4. \n
  4. \n

    For each table name listed by ListTables, do the\n following:

    \n
      \n
    • \n

      Call DescribeTable with the table name.

      \n
      • \n
    • \n

      Use the data returned by DescribeTable to add the read\n capacity units and write capacity units provisioned for the table itself\n to your variables.

      \n
      • \n
    • \n

      If the table has one or more global secondary indexes (GSIs), loop\n over these GSIs and add their provisioned capacity values to your\n variables as well.

      \n
      • \n
    \n
    5. \n
  5. \n

    Report the account quotas for that Region returned by\n DescribeLimits, along with the total current provisioned\n capacity levels you have calculated.

    \n
    6. \n
\n

This will let you see whether you are getting close to your account-level\n quotas.

\n

The per-table quotas apply only when you are creating a new table. They restrict the\n sum of the provisioned capacity of the new table itself and all its global secondary\n indexes.

\n

For existing tables and their GSIs, DynamoDB doesn't let you increase provisioned\n capacity extremely rapidly, but the only quota that applies is that the aggregate\n provisioned capacity over all your tables and GSIs cannot exceed either of the\n per-account quotas.

\n \n

\n DescribeLimits should only be called periodically. You can expect\n throttling errors if you call it more than once in a minute.

\n \n

The DescribeLimits Request element has no content.

", + "smithy.api#examples": [ + { + "title": "To determine capacity limits per table and account, in the current AWS region", + "documentation": "The following example returns the maximum read and write capacity units per table, and for the AWS account, in the current AWS region.", + "output": { + "TableMaxWriteCapacityUnits": 10000, + "TableMaxReadCapacityUnits": 10000, + "AccountMaxReadCapacityUnits": 20000, + "AccountMaxWriteCapacityUnits": 20000 + } + } + ] + } + }, + "com.amazonaws.dynamodb#DescribeLimitsInput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Represents the input of a DescribeLimits operation. Has no\n content.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#DescribeLimitsOutput": { + "type": "structure", + "members": { + "AccountMaxReadCapacityUnits": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

The maximum total read capacity units that your account allows you to provision across\n all of your tables in this Region.

" + } + }, + "AccountMaxWriteCapacityUnits": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

The maximum total write capacity units that your account allows you to provision\n across all of your tables in this Region.

" + } + }, + "TableMaxReadCapacityUnits": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

The maximum read capacity units that your account allows you to provision for a new\n table that you are creating in this Region, including the read capacity units\n provisioned for its global secondary indexes (GSIs).

" + } + }, + "TableMaxWriteCapacityUnits": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

The maximum write capacity units that your account allows you to provision for a new\n table that you are creating in this Region, including the write capacity units\n provisioned for its global secondary indexes (GSIs).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a DescribeLimits operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#DescribeTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#DescribeTableInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#DescribeTableOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Returns information about the table, including the current status of the table, when\n it was created, the primary key schema, and any indexes on the table.

\n \n

For global tables, this operation only applies to global tables using Version\n 2019.11.21 (Current version).

\n \n \n

If you issue a DescribeTable request immediately after a\n CreateTable request, DynamoDB might return a\n ResourceNotFoundException. This is because\n DescribeTable uses an eventually consistent query, and the metadata\n for your table might not be available at that moment. Wait for a few seconds, and\n then try the DescribeTable request again.

\n ", + "smithy.waiters#waitable": { + "TableExists": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "Table.TableStatus", + "expected": "ACTIVE", + "comparator": "stringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "errorType": "ResourceNotFoundException" + } + } + ], + "minDelay": 20 + }, + "TableNotExists": { + "acceptors": [ + { + "state": "success", + "matcher": { + "errorType": "ResourceNotFoundException" + } + } + ], + "minDelay": 20 + } + } + } + }, + "com.amazonaws.dynamodb#DescribeTableInput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The name of the table to describe. You can also provide the Amazon Resource Name (ARN) of the table in\n this parameter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a DescribeTable operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#DescribeTableOutput": { + "type": "structure", + "members": { + "Table": { + "target": "com.amazonaws.dynamodb#TableDescription", + "traits": { + "smithy.api#documentation": "

The properties of the table.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a DescribeTable operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#DescribeTableReplicaAutoScaling": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#DescribeTableReplicaAutoScalingInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#DescribeTableReplicaAutoScalingOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes auto scaling settings across replicas of the global table at once.

\n \n

For global tables, this operation only applies to global tables using Version\n 2019.11.21 (Current version).

\n " + } + }, + "com.amazonaws.dynamodb#DescribeTableReplicaAutoScalingInput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this\n parameter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#DescribeTableReplicaAutoScalingOutput": { + "type": "structure", + "members": { + "TableAutoScalingDescription": { + "target": "com.amazonaws.dynamodb#TableAutoScalingDescription", + "traits": { + "smithy.api#documentation": "

Represents the auto scaling properties of the table.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#DescribeTimeToLive": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#DescribeTimeToLiveInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#DescribeTimeToLiveOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Gives a description of the Time to Live (TTL) status on the specified table.

" + } + }, + "com.amazonaws.dynamodb#DescribeTimeToLiveInput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The name of the table to be described. You can also provide the Amazon Resource Name (ARN) of the table\n in this parameter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#DescribeTimeToLiveOutput": { + "type": "structure", + "members": { + "TimeToLiveDescription": { + "target": "com.amazonaws.dynamodb#TimeToLiveDescription", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#DestinationStatus": { + "type": "enum", + "members": { + "ENABLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DISABLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLING" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + }, + "ENABLE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLE_FAILED" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + } + } + }, + "com.amazonaws.dynamodb#DisableKinesisStreamingDestination": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#KinesisStreamingDestinationInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#KinesisStreamingDestinationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceInUseException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Stops replication from the DynamoDB table to the Kinesis data stream. This\n is done without deleting either of the resources.

" + } + }, + "com.amazonaws.dynamodb#DoubleObject": { + "type": "double" + }, + "com.amazonaws.dynamodb#DuplicateItemException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

There was an attempt to insert an item with the same primary key as an item that\n already exists in the DynamoDB table.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#DynamoDB_20120810": { + "type": "service", + "version": "2012-08-10", + "operations": [ + { + "target": "com.amazonaws.dynamodb#BatchExecuteStatement" + }, + { + "target": "com.amazonaws.dynamodb#BatchGetItem" + }, + { + "target": "com.amazonaws.dynamodb#BatchWriteItem" + }, + { + "target": "com.amazonaws.dynamodb#CreateBackup" + }, + { + "target": "com.amazonaws.dynamodb#CreateGlobalTable" + }, + { + "target": "com.amazonaws.dynamodb#CreateTable" + }, + { + "target": "com.amazonaws.dynamodb#DeleteBackup" + }, + { + "target": "com.amazonaws.dynamodb#DeleteItem" + }, + { + "target": "com.amazonaws.dynamodb#DeleteResourcePolicy" + }, + { + "target": "com.amazonaws.dynamodb#DeleteTable" + }, + { + "target": "com.amazonaws.dynamodb#DescribeBackup" + }, + { + "target": "com.amazonaws.dynamodb#DescribeContinuousBackups" + }, + { + "target": "com.amazonaws.dynamodb#DescribeContributorInsights" + }, + { + "target": "com.amazonaws.dynamodb#DescribeEndpoints" + }, + { + "target": "com.amazonaws.dynamodb#DescribeExport" + }, + { + "target": "com.amazonaws.dynamodb#DescribeGlobalTable" + }, + { + "target": "com.amazonaws.dynamodb#DescribeGlobalTableSettings" + }, + { + "target": "com.amazonaws.dynamodb#DescribeImport" + }, + { + "target": "com.amazonaws.dynamodb#DescribeKinesisStreamingDestination" + }, + { + "target": "com.amazonaws.dynamodb#DescribeLimits" + }, + { + "target": "com.amazonaws.dynamodb#DescribeTable" + }, + { + "target": "com.amazonaws.dynamodb#DescribeTableReplicaAutoScaling" + }, + { + "target": "com.amazonaws.dynamodb#DescribeTimeToLive" + }, + { + "target": "com.amazonaws.dynamodb#DisableKinesisStreamingDestination" + }, + { + "target": "com.amazonaws.dynamodb#EnableKinesisStreamingDestination" + }, + { + "target": "com.amazonaws.dynamodb#ExecuteStatement" + }, + { + "target": "com.amazonaws.dynamodb#ExecuteTransaction" + }, + { + "target": "com.amazonaws.dynamodb#ExportTableToPointInTime" + }, + { + "target": "com.amazonaws.dynamodb#GetItem" + }, + { + "target": "com.amazonaws.dynamodb#GetResourcePolicy" + }, + { + "target": "com.amazonaws.dynamodb#ImportTable" + }, + { + "target": "com.amazonaws.dynamodb#ListBackups" + }, + { + "target": "com.amazonaws.dynamodb#ListContributorInsights" + }, + { + "target": "com.amazonaws.dynamodb#ListExports" + }, + { + "target": "com.amazonaws.dynamodb#ListGlobalTables" + }, + { + "target": "com.amazonaws.dynamodb#ListImports" + }, + { + "target": "com.amazonaws.dynamodb#ListTables" + }, + { + "target": "com.amazonaws.dynamodb#ListTagsOfResource" + }, + { + "target": "com.amazonaws.dynamodb#PutItem" + }, + { + "target": "com.amazonaws.dynamodb#PutResourcePolicy" + }, + { + "target": "com.amazonaws.dynamodb#Query" + }, + { + "target": "com.amazonaws.dynamodb#RestoreTableFromBackup" + }, + { + "target": "com.amazonaws.dynamodb#RestoreTableToPointInTime" + }, + { + "target": "com.amazonaws.dynamodb#Scan" + }, + { + "target": "com.amazonaws.dynamodb#TagResource" + }, + { + "target": "com.amazonaws.dynamodb#TransactGetItems" + }, + { + "target": "com.amazonaws.dynamodb#TransactWriteItems" + }, + { + "target": "com.amazonaws.dynamodb#UntagResource" + }, + { + "target": "com.amazonaws.dynamodb#UpdateContinuousBackups" + }, + { + "target": "com.amazonaws.dynamodb#UpdateContributorInsights" + }, + { + "target": "com.amazonaws.dynamodb#UpdateGlobalTable" + }, + { + "target": "com.amazonaws.dynamodb#UpdateGlobalTableSettings" + }, + { + "target": "com.amazonaws.dynamodb#UpdateItem" + }, + { + "target": "com.amazonaws.dynamodb#UpdateKinesisStreamingDestination" + }, + { + "target": "com.amazonaws.dynamodb#UpdateTable" + }, + { + "target": "com.amazonaws.dynamodb#UpdateTableReplicaAutoScaling" + }, + { + "target": "com.amazonaws.dynamodb#UpdateTimeToLive" + } + ], + "traits": { + "aws.api#clientEndpointDiscovery": { + "operation": "com.amazonaws.dynamodb#DescribeEndpoints", + "error": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + "aws.api#service": { + "sdkId": "DynamoDB", + "arnNamespace": "dynamodb", + "cloudFormationName": "DynamoDB", + "cloudTrailEventSource": "dynamodb.amazonaws.com", + "endpointPrefix": "dynamodb" + }, + "aws.auth#sigv4": { + "name": "dynamodb" + }, + "aws.protocols#awsJson1_0": {}, + "smithy.api#documentation": "Amazon DynamoDB\n

Amazon DynamoDB is a fully managed NoSQL database service that provides fast\n and predictable performance with seamless scalability. DynamoDB lets you\n offload the administrative burdens of operating and scaling a distributed database, so\n that you don't have to worry about hardware provisioning, setup and configuration,\n replication, software patching, or cluster scaling.

\n

With DynamoDB, you can create database tables that can store and retrieve\n any amount of data, and serve any level of request traffic. You can scale up or scale\n down your tables' throughput capacity without downtime or performance degradation, and\n use the Amazon Web Services Management Console to monitor resource utilization and performance\n metrics.

\n

DynamoDB automatically spreads the data and traffic for your tables over\n a sufficient number of servers to handle your throughput and storage requirements, while\n maintaining consistent and fast performance. All of your data is stored on solid state\n disks (SSDs) and automatically replicated across multiple Availability Zones in an\n Amazon Web Services Region, providing built-in high availability and data\n durability.

", + "smithy.api#suppress": [ + "RuleSetAwsBuiltIn.AWS::Auth::AccountId" + ], + "smithy.api#title": "Amazon DynamoDB", + "smithy.api#xmlNamespace": { + "uri": "http://dynamodb.amazonaws.com/doc/2012-08-10/" + }, + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + }, + "AccountId": { + "builtIn": "AWS::Auth::AccountId", + "required": false, + "documentation": "The AWS AccountId used for the request.", + "type": "String" + }, + "AccountIdEndpointMode": { + "builtIn": "AWS::Auth::AccountIdEndpointMode", + "required": false, + "documentation": "The AccountId Endpoint Mode.", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": "{Endpoint}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "local" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and local endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and local endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": "http://localhost:8000", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "AccountIdEndpointMode" + } + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "AccountIdEndpointMode" + }, + "required" + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "AccountId" + } + ] + } + ] + } + ], + "error": "AccountIdEndpointMode is required but no AccountID was provided or able to be loaded.", + "type": "error" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "AccountId" + } + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws" + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isValidHostLabel", + "argv": [ + { + "ref": "AccountId" + }, + false + ] + } + ] + } + ], + "error": "Credentials-sourced account ID parameter is invalid", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "AccountIdEndpointMode" + } + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "AccountIdEndpointMode" + }, + "disabled" + ] + } + ], + "endpoint": { + "url": "https://dynamodb-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://dynamodb-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-us-gov" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "AccountIdEndpointMode" + } + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "AccountIdEndpointMode" + }, + "disabled" + ] + } + ], + "endpoint": { + "url": "https://dynamodb.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://dynamodb.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "AccountIdEndpointMode" + } + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "AccountIdEndpointMode" + }, + "disabled" + ] + } + ], + "endpoint": { + "url": "https://dynamodb-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://dynamodb-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "AccountIdEndpointMode" + } + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "AccountIdEndpointMode" + }, + "disabled" + ] + } + ], + "endpoint": { + "url": "https://dynamodb.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://dynamodb.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "AccountIdEndpointMode" + } + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "AccountIdEndpointMode" + }, + "disabled" + ] + } + ], + "endpoint": { + "url": "https://dynamodb.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "AccountId" + } + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws" + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ] + } + ], + "endpoint": { + "url": "https://{AccountId}.ddb.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://dynamodb.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.af-south-1.amazonaws.com" + } + }, + "params": { + "Region": "af-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.ap-east-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.ap-south-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.eu-north-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.eu-south-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.eu-west-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.eu-west-3.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region local with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "params": { + "Region": "local", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.me-south-1.amazonaws.com" + } + }, + "params": { + "Region": "me-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.sa-east-1.amazonaws.com" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-iso-west-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + }, + { + "documentation": "For custom endpoint with account ID available, FIPS enabled, and DualStack enabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "AccountId": "012345678901", + "UseFIPS": true, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with account ID available, FIPS enabled, and DualStack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "AccountId": "012345678901", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with account ID available, FIPS disabled, and DualStack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "AccountId": "012345678901", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with account ID available, FIPS disabled, and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Auth::AccountId": "012345678901" + }, + "operationName": "ListTables" + } + ], + "params": { + "AccountId": "012345678901", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with empty account ID available, FIPS disabled, and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Auth::AccountId": "" + }, + "operationName": "ListTables" + } + ], + "params": { + "AccountId": "", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For region local with account ID available, FIPS enabled, and DualStack enabled", + "expect": { + "error": "Invalid Configuration: FIPS and local endpoint are not supported" + }, + "params": { + "Region": "local", + "AccountId": "012345678901", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region local with account ID available, FIPS enabled, and DualStack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and local endpoint are not supported" + }, + "params": { + "Region": "local", + "AccountId": "012345678901", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region local with account ID available, FIPS disabled, and DualStack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and local endpoint are not supported" + }, + "params": { + "Region": "local", + "AccountId": "012345678901", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region local with account ID available, FIPS disabled, and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "local", + "AWS::Auth::AccountId": "012345678901" + }, + "operationName": "ListTables" + } + ], + "params": { + "Region": "local", + "AccountId": "012345678901", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region local with empty account ID available, FIPS disabled, and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "local", + "AWS::Auth::AccountId": "" + }, + "operationName": "ListTables" + } + ], + "params": { + "Region": "local", + "AccountId": "", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For AccountIdEndpointMode required and no AccountId set", + "expect": { + "error": "AccountIdEndpointMode is required but no AccountID was provided or able to be loaded." + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "ListTables" + } + ], + "params": { + "Region": "us-east-1", + "AccountIdEndpointMode": "required" + } + }, + { + "documentation": "For region us-east-1 with account ID available, FIPS enabled, and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-east-1.api.aws" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::Auth::AccountId": "012345678901", + "AWS::UseFIPS": true, + "AWS::UseDualStack": true + }, + "operationName": "ListTables" + } + ], + "params": { + "Region": "us-east-1", + "AccountId": "012345678901", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with account ID available, FIPS enabled, and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::Auth::AccountId": "012345678901", + "AWS::UseFIPS": true + }, + "operationName": "ListTables" + } + ], + "params": { + "Region": "us-east-1", + "AccountId": "012345678901", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with account ID available, AccountIdEndpointMode preferred, FIPS enabled, and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::Auth::AccountId": "012345678901", + "AWS::Auth::AccountIdEndpointMode": "preferred", + "AWS::UseFIPS": true + }, + "operationName": "ListTables" + } + ], + "params": { + "Region": "us-east-1", + "AccountId": "012345678901", + "AccountIdEndpointMode": "preferred", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with account ID available, AccountIdEndpointMode required, FIPS enabled, and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::Auth::AccountId": "012345678901", + "AWS::Auth::AccountIdEndpointMode": "required", + "AWS::UseFIPS": true + }, + "operationName": "ListTables" + } + ], + "params": { + "Region": "us-east-1", + "AccountId": "012345678901", + "AccountIdEndpointMode": "required", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with account ID available, FIPS disabled, and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-east-1.api.aws" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::Auth::AccountId": "012345678901", + "AWS::UseDualStack": true + }, + "operationName": "ListTables" + } + ], + "params": { + "Region": "us-east-1", + "AccountId": "012345678901", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with account ID available, FIPS disabled, and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-east-1.api.aws" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::Auth::AccountId": "012345678901", + "AWS::UseDualStack": true + }, + "operationName": "ListTables" + } + ], + "params": { + "Region": "us-east-1", + "AccountId": "012345678901", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with account ID available, AccountIdEndpointMode preferred, FIPS disabled, and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "AccountId": "012345678901", + "AccountIdEndpointMode": "preferred", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with account ID available, AccountIdEndpointMode disabled, FIPS disabled, and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "AccountId": "012345678901", + "AccountIdEndpointMode": "disabled", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with account ID available, AccountIdEndpointMode required, FIPS disabled, and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "AccountId": "012345678901", + "AccountIdEndpointMode": "required", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with account ID available, AccountIdEndpointMode preferred, FIPS disabled, and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://012345678901.ddb.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::Auth::AccountId": "012345678901", + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "ListTables" + } + ], + "params": { + "Region": "us-east-1", + "AccountId": "012345678901", + "UseFIPS": false, + "UseDualStack": false, + "AccountIdEndpointMode": "preferred" + } + }, + { + "documentation": "For region us-east-1 with account ID available, AccountIdEndpointMode required, FIPS disabled, and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://012345678901.ddb.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::Auth::AccountId": "012345678901", + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "ListTables" + } + ], + "params": { + "Region": "us-east-1", + "AccountId": "012345678901", + "UseFIPS": false, + "UseDualStack": false, + "AccountIdEndpointMode": "required" + } + }, + { + "documentation": "For region us-east-1 with account ID available, AccountIdEndpointMode disabled, FIPS disabled, and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::Auth::AccountId": "012345678901", + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "ListTables" + } + ], + "params": { + "Region": "us-east-1", + "AccountId": "012345678901", + "UseFIPS": false, + "UseDualStack": false, + "AccountIdEndpointMode": "disabled" + } + }, + { + "documentation": "For region us-east-1 with empty account ID, FIPS disabled, and DualStack disabled", + "expect": { + "error": "Credentials-sourced account ID parameter is invalid" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::Auth::AccountId": " " + }, + "operationName": "ListTables" + } + ], + "params": { + "Region": "us-east-1", + "AccountId": "", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with account ID available, FIPS enabled, and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::Auth::AccountId": "012345678901", + "AWS::UseFIPS": true, + "AWS::UseDualStack": true + }, + "operationName": "ListTables" + } + ], + "params": { + "Region": "cn-north-1", + "AccountId": "012345678901", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with account ID available, FIPS enabled, and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.cn-north-1.amazonaws.com.cn" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::Auth::AccountId": "012345678901", + "AWS::UseFIPS": true + }, + "operationName": "ListTables" + } + ], + "params": { + "Region": "cn-north-1", + "AccountId": "012345678901", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with account ID available, FIPS disabled, and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::Auth::AccountId": "012345678901", + "AWS::UseDualStack": true + }, + "operationName": "ListTables" + } + ], + "params": { + "Region": "cn-north-1", + "AccountId": "012345678901", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with account ID available, FIPS disabled, and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.cn-north-1.amazonaws.com.cn" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::Auth::AccountId": "012345678901" + }, + "operationName": "ListTables" + } + ], + "params": { + "Region": "cn-north-1", + "AccountId": "012345678901", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with account ID available, AccountIdEndpointMode preferred, FIPS disabled, and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "AccountId": "012345678901", + "AccountIdEndpointMode": "preferred", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with account ID available, AccountIdEndpointMode disabled, FIPS disabled, and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "AccountId": "012345678901", + "AccountIdEndpointMode": "disabled", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with account ID available, AccountIdEndpointMode required, FIPS disabled, and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "AccountId": "012345678901", + "AccountIdEndpointMode": "required", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with empty account ID available, FIPS disabled, and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.cn-north-1.amazonaws.com.cn" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::Auth::AccountId": "" + }, + "operationName": "ListTables" + } + ], + "params": { + "Region": "cn-north-1", + "AccountId": "", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with account ID available, FIPS enabled, and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "AccountId": "012345678901", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with account ID available, FIPS enabled, and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-iso-east-1", + "AWS::Auth::AccountId": "012345678901", + "AWS::UseFIPS": true + }, + "operationName": "ListTables" + } + ], + "params": { + "Region": "us-iso-east-1", + "AccountId": "012345678901", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with account ID available, FIPS disabled, and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "AccountId": "012345678901", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with account ID available, FIPS disabled, and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-iso-east-1.c2s.ic.gov" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-iso-east-1", + "AWS::Auth::AccountId": "012345678901" + }, + "operationName": "ListTables" + } + ], + "params": { + "Region": "us-iso-east-1", + "AccountId": "012345678901", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with empty account ID available, FIPS disabled, and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-iso-east-1.c2s.ic.gov" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-iso-east-1", + "AWS::Auth::AccountId": "012345678901" + }, + "operationName": "ListTables" + } + ], + "params": { + "Region": "us-iso-east-1", + "AccountId": "", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with account ID available, FIPS enabled, and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "AccountId": "012345678901", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with account ID available, FIPS enabled, and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "AccountId": "012345678901", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with account ID available, FIPS disabled, and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "AccountId": "012345678901", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with account ID available, FIPS disabled, and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-gov-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-gov-east-1", + "AWS::Auth::AccountId": "012345678901" + }, + "operationName": "ListTables" + } + ], + "params": { + "Region": "us-gov-east-1", + "AccountId": "012345678901", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with empty account ID available, FIPS disabled, and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-gov-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-gov-east-1", + "AWS::Auth::AccountId": "" + }, + "operationName": "ListTables" + } + ], + "params": { + "Region": "us-gov-east-1", + "AccountId": "", + "UseFIPS": false, + "UseDualStack": false + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.dynamodb#EnableKinesisStreamingConfiguration": { + "type": "structure", + "members": { + "ApproximateCreationDateTimePrecision": { + "target": "com.amazonaws.dynamodb#ApproximateCreationDateTimePrecision", + "traits": { + "smithy.api#documentation": "

Toggle for the precision of Kinesis data stream timestamp. The values are either\n MILLISECOND or MICROSECOND.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Enables setting the configuration for Kinesis Streaming.

" + } + }, + "com.amazonaws.dynamodb#EnableKinesisStreamingDestination": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#KinesisStreamingDestinationInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#KinesisStreamingDestinationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceInUseException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Starts table data replication to the specified Kinesis data stream at a timestamp\n chosen during the enable workflow. If this operation doesn't return results immediately,\n use DescribeKinesisStreamingDestination to check if streaming to the Kinesis data stream\n is ACTIVE.

" + } + }, + "com.amazonaws.dynamodb#Endpoint": { + "type": "structure", + "members": { + "Address": { + "target": "com.amazonaws.dynamodb#String", + "traits": { + "smithy.api#documentation": "

IP address of the endpoint.

", + "smithy.api#required": {} + } + }, + "CachePeriodInMinutes": { + "target": "com.amazonaws.dynamodb#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Endpoint cache time to live (TTL) value.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An endpoint information details.

" + } + }, + "com.amazonaws.dynamodb#Endpoints": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#Endpoint" + } + }, + "com.amazonaws.dynamodb#ErrorCount": { + "type": "long", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.dynamodb#ErrorMessage": { + "type": "string" + }, + "com.amazonaws.dynamodb#ExceptionDescription": { + "type": "string" + }, + "com.amazonaws.dynamodb#ExceptionName": { + "type": "string" + }, + "com.amazonaws.dynamodb#ExecuteStatement": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#ExecuteStatementInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#ExecuteStatementOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#ConditionalCheckFailedException" + }, + { + "target": "com.amazonaws.dynamodb#DuplicateItemException" + }, + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#ItemCollectionSizeLimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.dynamodb#RequestLimitExceeded" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#TransactionConflictException" + } + ], + "traits": { + "smithy.api#documentation": "

This operation allows you to perform reads and singleton writes on data stored in\n DynamoDB, using PartiQL.

\n

For PartiQL reads (SELECT statement), if the total number of processed\n items exceeds the maximum dataset size limit of 1 MB, the read stops and results are\n returned to the user as a LastEvaluatedKey value to continue the read in a\n subsequent operation. If the filter criteria in WHERE clause does not match\n any data, the read will return an empty result set.

\n

A single SELECT statement response can return up to the maximum number of\n items (if using the Limit parameter) or a maximum of 1 MB of data (and then apply any\n filtering to the results using WHERE clause). If\n LastEvaluatedKey is present in the response, you need to paginate the\n result set. If NextToken is present, you need to paginate the result set\n and include NextToken.

" + } + }, + "com.amazonaws.dynamodb#ExecuteStatementInput": { + "type": "structure", + "members": { + "Statement": { + "target": "com.amazonaws.dynamodb#PartiQLStatement", + "traits": { + "smithy.api#documentation": "

The PartiQL statement representing the operation to run.

", + "smithy.api#required": {} + } + }, + "Parameters": { + "target": "com.amazonaws.dynamodb#PreparedStatementParameters", + "traits": { + "smithy.api#documentation": "

The parameters for the PartiQL statement, if any.

" + } + }, + "ConsistentRead": { + "target": "com.amazonaws.dynamodb#ConsistentRead", + "traits": { + "smithy.api#documentation": "

The consistency of a read operation. If set to true, then a strongly\n consistent read is used; otherwise, an eventually consistent read is used.

" + } + }, + "NextToken": { + "target": "com.amazonaws.dynamodb#PartiQLNextToken", + "traits": { + "smithy.api#documentation": "

Set this value to get remaining results, if NextToken was returned in the\n statement response.

" + } + }, + "ReturnConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ReturnConsumedCapacity" + }, + "Limit": { + "target": "com.amazonaws.dynamodb#PositiveIntegerObject", + "traits": { + "smithy.api#documentation": "

The maximum number of items to evaluate (not necessarily the number of matching\n items). If DynamoDB processes the number of items up to the limit while processing the\n results, it stops the operation and returns the matching values up to that point, along\n with a key in LastEvaluatedKey to apply in a subsequent operation so you\n can pick up where you left off. Also, if the processed dataset size exceeds 1 MB before\n DynamoDB reaches this limit, it stops the operation and returns the matching values up\n to the limit, and a key in LastEvaluatedKey to apply in a subsequent\n operation to continue the operation.

" + } + }, + "ReturnValuesOnConditionCheckFailure": { + "target": "com.amazonaws.dynamodb#ReturnValuesOnConditionCheckFailure", + "traits": { + "smithy.api#documentation": "

An optional parameter that returns the item attributes for an\n ExecuteStatement operation that failed a condition check.

\n

There is no additional cost associated with requesting a return value aside from the\n small network and processing overhead of receiving a larger response. No read capacity\n units are consumed.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#ExecuteStatementOutput": { + "type": "structure", + "members": { + "Items": { + "target": "com.amazonaws.dynamodb#ItemList", + "traits": { + "smithy.api#documentation": "

If a read operation was used, this property will contain the result of the read\n operation; a map of attribute names and their values. For the write operations this\n value will be empty.

" + } + }, + "NextToken": { + "target": "com.amazonaws.dynamodb#PartiQLNextToken", + "traits": { + "smithy.api#documentation": "

If the response of a read request exceeds the response payload limit DynamoDB will set\n this value in the response. If set, you can use that this value in the subsequent\n request to get the remaining results.

" + } + }, + "ConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ConsumedCapacity" + }, + "LastEvaluatedKey": { + "target": "com.amazonaws.dynamodb#Key", + "traits": { + "smithy.api#documentation": "

The primary key of the item where the operation stopped, inclusive of the previous\n result set. Use this value to start a new operation, excluding this value in the new\n request. If LastEvaluatedKey is empty, then the \"last page\" of results has\n been processed and there is no more data to be retrieved. If\n LastEvaluatedKey is not empty, it does not necessarily mean that there\n is more data in the result set. The only way to know when you have reached the end of\n the result set is when LastEvaluatedKey is empty.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#ExecuteTransaction": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#ExecuteTransactionInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#ExecuteTransactionOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#IdempotentParameterMismatchException" + }, + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.dynamodb#RequestLimitExceeded" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#TransactionCanceledException" + }, + { + "target": "com.amazonaws.dynamodb#TransactionInProgressException" + } + ], + "traits": { + "smithy.api#documentation": "

This operation allows you to perform transactional reads or writes on data stored in\n DynamoDB, using PartiQL.

\n \n

The entire transaction must consist of either read statements or write statements,\n you cannot mix both in one transaction. The EXISTS function is an exception and can\n be used to check the condition of specific attributes of the item in a similar\n manner to ConditionCheck in the TransactWriteItems API.

\n " + } + }, + "com.amazonaws.dynamodb#ExecuteTransactionInput": { + "type": "structure", + "members": { + "TransactStatements": { + "target": "com.amazonaws.dynamodb#ParameterizedStatements", + "traits": { + "smithy.api#documentation": "

The list of PartiQL statements representing the transaction to run.

", + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.dynamodb#ClientRequestToken", + "traits": { + "smithy.api#documentation": "

Set this value to get remaining results, if NextToken was returned in the\n statement response.

", + "smithy.api#idempotencyToken": {} + } + }, + "ReturnConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ReturnConsumedCapacity", + "traits": { + "smithy.api#documentation": "

Determines the level of detail about either provisioned or on-demand throughput\n consumption that is returned in the response. For more information, see TransactGetItems and TransactWriteItems.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#ExecuteTransactionOutput": { + "type": "structure", + "members": { + "Responses": { + "target": "com.amazonaws.dynamodb#ItemResponseList", + "traits": { + "smithy.api#documentation": "

The response to a PartiQL transaction.

" + } + }, + "ConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ConsumedCapacityMultiple", + "traits": { + "smithy.api#documentation": "

The capacity units consumed by the entire operation. The values of the list are\n ordered according to the ordering of the statements.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#ExpectedAttributeMap": { + "type": "map", + "key": { + "target": "com.amazonaws.dynamodb#AttributeName" + }, + "value": { + "target": "com.amazonaws.dynamodb#ExpectedAttributeValue" + } + }, + "com.amazonaws.dynamodb#ExpectedAttributeValue": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.dynamodb#AttributeValue", + "traits": { + "smithy.api#documentation": "

Represents the data for the expected attribute.

\n

Each attribute value is described as a name-value pair. The name is the data type, and\n the value is the data itself.

\n

For more information, see Data Types in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "Exists": { + "target": "com.amazonaws.dynamodb#BooleanObject", + "traits": { + "smithy.api#documentation": "

Causes DynamoDB to evaluate the value before attempting a conditional\n operation:

\n \n

The default setting for Exists is true. If you supply a\n Value all by itself, DynamoDB assumes the attribute exists:\n You don't have to set Exists to true, because it is\n implied.

\n

DynamoDB returns a ValidationException if:

\n " + } + }, + "ComparisonOperator": { + "target": "com.amazonaws.dynamodb#ComparisonOperator", + "traits": { + "smithy.api#documentation": "

A comparator for evaluating attributes in the AttributeValueList. For\n example, equals, greater than, less than, etc.

\n

The following comparison operators are available:

\n

\n EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS |\n BEGINS_WITH | IN | BETWEEN\n

\n

The following are descriptions of each comparison operator.

\n " + } + }, + "AttributeValueList": { + "target": "com.amazonaws.dynamodb#AttributeValueList", + "traits": { + "smithy.api#documentation": "

One or more values to evaluate against the supplied attribute. The number of values in\n the list depends on the ComparisonOperator being used.

\n

For type Number, value comparisons are numeric.

\n

String value comparisons for greater than, equals, or less than are based on ASCII\n character code values. For example, a is greater than A, and\n a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.

\n

For Binary, DynamoDB treats each byte of the binary data as unsigned when it\n compares binary values.

\n

For information on specifying data types in JSON, see JSON Data Format\n in the Amazon DynamoDB Developer Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a condition to be compared with an attribute value. This condition can be\n used with DeleteItem, PutItem, or UpdateItem\n operations; if the comparison evaluates to true, the operation succeeds; if not, the\n operation fails. You can use ExpectedAttributeValue in one of two different\n ways:

\n \n

\n Value and Exists are incompatible with\n AttributeValueList and ComparisonOperator. Note that if\n you use both sets of parameters at once, DynamoDB will return a\n ValidationException exception.

" + } + }, + "com.amazonaws.dynamodb#ExportArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 37, + "max": 1024 + } + } + }, + "com.amazonaws.dynamodb#ExportConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

There was a conflict when writing to the specified S3 bucket.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#ExportDescription": { + "type": "structure", + "members": { + "ExportArn": { + "target": "com.amazonaws.dynamodb#ExportArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the table export.

" + } + }, + "ExportStatus": { + "target": "com.amazonaws.dynamodb#ExportStatus", + "traits": { + "smithy.api#documentation": "

Export can be in one of the following states: IN_PROGRESS, COMPLETED, or\n FAILED.

" + } + }, + "StartTime": { + "target": "com.amazonaws.dynamodb#ExportStartTime", + "traits": { + "smithy.api#documentation": "

The time at which the export task began.

" + } + }, + "EndTime": { + "target": "com.amazonaws.dynamodb#ExportEndTime", + "traits": { + "smithy.api#documentation": "

The time at which the export task completed.

" + } + }, + "ExportManifest": { + "target": "com.amazonaws.dynamodb#ExportManifest", + "traits": { + "smithy.api#documentation": "

The name of the manifest file for the export task.

" + } + }, + "TableArn": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the table that was exported.

" + } + }, + "TableId": { + "target": "com.amazonaws.dynamodb#TableId", + "traits": { + "smithy.api#documentation": "

Unique ID of the table that was exported.

" + } + }, + "ExportTime": { + "target": "com.amazonaws.dynamodb#ExportTime", + "traits": { + "smithy.api#documentation": "

Point in time from which table data was exported.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.dynamodb#ClientToken", + "traits": { + "smithy.api#documentation": "

The client token that was provided for the export task. A client token makes calls to\n ExportTableToPointInTimeInput idempotent, meaning that multiple\n identical calls have the same effect as one single call.

" + } + }, + "S3Bucket": { + "target": "com.amazonaws.dynamodb#S3Bucket", + "traits": { + "smithy.api#documentation": "

The name of the Amazon S3 bucket containing the export.

" + } + }, + "S3BucketOwner": { + "target": "com.amazonaws.dynamodb#S3BucketOwner", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the bucket containing the\n export.

" + } + }, + "S3Prefix": { + "target": "com.amazonaws.dynamodb#S3Prefix", + "traits": { + "smithy.api#documentation": "

The Amazon S3 bucket prefix used as the file name and path of the exported\n snapshot.

" + } + }, + "S3SseAlgorithm": { + "target": "com.amazonaws.dynamodb#S3SseAlgorithm", + "traits": { + "smithy.api#documentation": "

Type of encryption used on the bucket where export data is stored. Valid values for\n S3SseAlgorithm are:

\n " + } + }, + "S3SseKmsKeyId": { + "target": "com.amazonaws.dynamodb#S3SseKmsKeyId", + "traits": { + "smithy.api#documentation": "

The ID of the KMS managed key used to encrypt the S3 bucket where\n export data is stored (if applicable).

" + } + }, + "FailureCode": { + "target": "com.amazonaws.dynamodb#FailureCode", + "traits": { + "smithy.api#documentation": "

Status code for the result of the failed export.

" + } + }, + "FailureMessage": { + "target": "com.amazonaws.dynamodb#FailureMessage", + "traits": { + "smithy.api#documentation": "

Export failure reason description.

" + } + }, + "ExportFormat": { + "target": "com.amazonaws.dynamodb#ExportFormat", + "traits": { + "smithy.api#documentation": "

The format of the exported data. Valid values for ExportFormat are\n DYNAMODB_JSON or ION.

" + } + }, + "BilledSizeBytes": { + "target": "com.amazonaws.dynamodb#BilledSizeBytes", + "traits": { + "smithy.api#documentation": "

The billable size of the table export.

" + } + }, + "ItemCount": { + "target": "com.amazonaws.dynamodb#ItemCount", + "traits": { + "smithy.api#documentation": "

The number of items exported.

" + } + }, + "ExportType": { + "target": "com.amazonaws.dynamodb#ExportType", + "traits": { + "smithy.api#documentation": "

The type of export that was performed. Valid values are FULL_EXPORT or\n INCREMENTAL_EXPORT.

" + } + }, + "IncrementalExportSpecification": { + "target": "com.amazonaws.dynamodb#IncrementalExportSpecification", + "traits": { + "smithy.api#documentation": "

Optional object containing the parameters specific to an incremental export.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the properties of the exported table.

" + } + }, + "com.amazonaws.dynamodb#ExportEndTime": { + "type": "timestamp" + }, + "com.amazonaws.dynamodb#ExportFormat": { + "type": "enum", + "members": { + "DYNAMODB_JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DYNAMODB_JSON" + } + }, + "ION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ION" + } + } + } + }, + "com.amazonaws.dynamodb#ExportFromTime": { + "type": "timestamp" + }, + "com.amazonaws.dynamodb#ExportManifest": { + "type": "string" + }, + "com.amazonaws.dynamodb#ExportNextToken": { + "type": "string" + }, + "com.amazonaws.dynamodb#ExportNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The specified export was not found.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#ExportStartTime": { + "type": "timestamp" + }, + "com.amazonaws.dynamodb#ExportStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.dynamodb#ExportSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ExportSummary" + } + }, + "com.amazonaws.dynamodb#ExportSummary": { + "type": "structure", + "members": { + "ExportArn": { + "target": "com.amazonaws.dynamodb#ExportArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the export.

" + } + }, + "ExportStatus": { + "target": "com.amazonaws.dynamodb#ExportStatus", + "traits": { + "smithy.api#documentation": "

Export can be in one of the following states: IN_PROGRESS, COMPLETED, or\n FAILED.

" + } + }, + "ExportType": { + "target": "com.amazonaws.dynamodb#ExportType", + "traits": { + "smithy.api#documentation": "

The type of export that was performed. Valid values are FULL_EXPORT or\n INCREMENTAL_EXPORT.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Summary information about an export task.

" + } + }, + "com.amazonaws.dynamodb#ExportTableToPointInTime": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#ExportTableToPointInTimeInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#ExportTableToPointInTimeOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#ExportConflictException" + }, + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidExportTimeException" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#PointInTimeRecoveryUnavailableException" + }, + { + "target": "com.amazonaws.dynamodb#TableNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Exports table data to an S3 bucket. The table must have point in time recovery\n enabled, and you can export data from any time within the point in time recovery\n window.

" + } + }, + "com.amazonaws.dynamodb#ExportTableToPointInTimeInput": { + "type": "structure", + "members": { + "TableArn": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the table to export.

", + "smithy.api#required": {} + } + }, + "ExportTime": { + "target": "com.amazonaws.dynamodb#ExportTime", + "traits": { + "smithy.api#documentation": "

Time in the past from which to export table data, counted in seconds from the start of\n the Unix epoch. The table export will be a snapshot of the table's state at this point\n in time.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.dynamodb#ClientToken", + "traits": { + "smithy.api#documentation": "

Providing a ClientToken makes the call to\n ExportTableToPointInTimeInput idempotent, meaning that multiple\n identical calls have the same effect as one single call.

\n

A client token is valid for 8 hours after the first request that uses it is completed.\n After 8 hours, any request with the same client token is treated as a new request. Do\n not resubmit the same request with the same client token for more than 8 hours, or the\n result might not be idempotent.

\n

If you submit a request with the same client token but a change in other parameters\n within the 8-hour idempotency window, DynamoDB returns an\n ImportConflictException.

", + "smithy.api#idempotencyToken": {} + } + }, + "S3Bucket": { + "target": "com.amazonaws.dynamodb#S3Bucket", + "traits": { + "smithy.api#documentation": "

The name of the Amazon S3 bucket to export the snapshot to.

", + "smithy.api#required": {} + } + }, + "S3BucketOwner": { + "target": "com.amazonaws.dynamodb#S3BucketOwner", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the bucket the export will be\n stored in.

\n \n

S3BucketOwner is a required parameter when exporting to a S3 bucket in another\n account.

\n " + } + }, + "S3Prefix": { + "target": "com.amazonaws.dynamodb#S3Prefix", + "traits": { + "smithy.api#documentation": "

The Amazon S3 bucket prefix to use as the file name and path of the exported\n snapshot.

" + } + }, + "S3SseAlgorithm": { + "target": "com.amazonaws.dynamodb#S3SseAlgorithm", + "traits": { + "smithy.api#documentation": "

Type of encryption used on the bucket where export data will be stored. Valid values\n for S3SseAlgorithm are:

\n " + } + }, + "S3SseKmsKeyId": { + "target": "com.amazonaws.dynamodb#S3SseKmsKeyId", + "traits": { + "smithy.api#documentation": "

The ID of the KMS managed key used to encrypt the S3 bucket where\n export data will be stored (if applicable).

" + } + }, + "ExportFormat": { + "target": "com.amazonaws.dynamodb#ExportFormat", + "traits": { + "smithy.api#documentation": "

The format for the exported data. Valid values for ExportFormat are\n DYNAMODB_JSON or ION.

" + } + }, + "ExportType": { + "target": "com.amazonaws.dynamodb#ExportType", + "traits": { + "smithy.api#documentation": "

Choice of whether to execute as a full export or incremental export. Valid values are\n FULL_EXPORT or INCREMENTAL_EXPORT. The default value is FULL_EXPORT. If\n INCREMENTAL_EXPORT is provided, the IncrementalExportSpecification must also be\n used.

" + } + }, + "IncrementalExportSpecification": { + "target": "com.amazonaws.dynamodb#IncrementalExportSpecification", + "traits": { + "smithy.api#documentation": "

Optional object containing the parameters specific to an incremental export.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#ExportTableToPointInTimeOutput": { + "type": "structure", + "members": { + "ExportDescription": { + "target": "com.amazonaws.dynamodb#ExportDescription", + "traits": { + "smithy.api#documentation": "

Contains a description of the table export.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#ExportTime": { + "type": "timestamp" + }, + "com.amazonaws.dynamodb#ExportToTime": { + "type": "timestamp" + }, + "com.amazonaws.dynamodb#ExportType": { + "type": "enum", + "members": { + "FULL_EXPORT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FULL_EXPORT" + } + }, + "INCREMENTAL_EXPORT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INCREMENTAL_EXPORT" + } + } + } + }, + "com.amazonaws.dynamodb#ExportViewType": { + "type": "enum", + "members": { + "NEW_IMAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEW_IMAGE" + } + }, + "NEW_AND_OLD_IMAGES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEW_AND_OLD_IMAGES" + } + } + } + }, + "com.amazonaws.dynamodb#ExpressionAttributeNameMap": { + "type": "map", + "key": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeNameVariable" + }, + "value": { + "target": "com.amazonaws.dynamodb#AttributeName" + } + }, + "com.amazonaws.dynamodb#ExpressionAttributeNameVariable": { + "type": "string" + }, + "com.amazonaws.dynamodb#ExpressionAttributeValueMap": { + "type": "map", + "key": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeValueVariable" + }, + "value": { + "target": "com.amazonaws.dynamodb#AttributeValue" + } + }, + "com.amazonaws.dynamodb#ExpressionAttributeValueVariable": { + "type": "string" + }, + "com.amazonaws.dynamodb#FailureCode": { + "type": "string" + }, + "com.amazonaws.dynamodb#FailureException": { + "type": "structure", + "members": { + "ExceptionName": { + "target": "com.amazonaws.dynamodb#ExceptionName", + "traits": { + "smithy.api#documentation": "

Exception name.

" + } + }, + "ExceptionDescription": { + "target": "com.amazonaws.dynamodb#ExceptionDescription", + "traits": { + "smithy.api#documentation": "

Description of the failure.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a failure a contributor insights operation.

" + } + }, + "com.amazonaws.dynamodb#FailureMessage": { + "type": "string" + }, + "com.amazonaws.dynamodb#FilterConditionMap": { + "type": "map", + "key": { + "target": "com.amazonaws.dynamodb#AttributeName" + }, + "value": { + "target": "com.amazonaws.dynamodb#Condition" + } + }, + "com.amazonaws.dynamodb#Get": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.dynamodb#Key", + "traits": { + "smithy.api#documentation": "

A map of attribute names to AttributeValue objects that specifies the\n primary key of the item to retrieve.

", + "smithy.api#required": {} + } + }, + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The name of the table from which to retrieve the specified item. You can also provide\n the Amazon Resource Name (ARN) of the table in this parameter.

", + "smithy.api#required": {} + } + }, + "ProjectionExpression": { + "target": "com.amazonaws.dynamodb#ProjectionExpression", + "traits": { + "smithy.api#documentation": "

A string that identifies one or more attributes of the specified item to retrieve from\n the table. The attributes in the expression must be separated by commas. If no attribute\n names are specified, then all attributes of the specified item are returned. If any of\n the requested attributes are not found, they do not appear in the result.

" + } + }, + "ExpressionAttributeNames": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", + "traits": { + "smithy.api#documentation": "

One or more substitution tokens for attribute names in the ProjectionExpression\n parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies an item and related attribute values to retrieve in a\n TransactGetItem object.

" + } + }, + "com.amazonaws.dynamodb#GetItem": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#GetItemInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#GetItemOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.dynamodb#RequestLimitExceeded" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

The GetItem operation returns a set of attributes for the item with the\n given primary key. If there is no matching item, GetItem does not return\n any data and there will be no Item element in the response.

\n

\n GetItem provides an eventually consistent read by default. If your\n application requires a strongly consistent read, set ConsistentRead to\n true. Although a strongly consistent read might take more time than an\n eventually consistent read, it always returns the last updated value.

", + "smithy.api#examples": [ + { + "title": "To read an item from a table", + "documentation": "This example retrieves an item from the Music table. The table has a partition key and a sort key (Artist and SongTitle), so you must specify both of these attributes.", + "input": { + "TableName": "Music", + "Key": { + "Artist": { + "S": "Acme Band" + }, + "SongTitle": { + "S": "Happy Day" + } + } + }, + "output": { + "Item": { + "AlbumTitle": { + "S": "Songs About Life" + }, + "SongTitle": { + "S": "Happy Day" + }, + "Artist": { + "S": "Acme Band" + } + } + } + } + ] + } + }, + "com.amazonaws.dynamodb#GetItemInput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The name of the table containing the requested item. You can also provide the\n Amazon Resource Name (ARN) of the table in this parameter.

", + "smithy.api#required": {} + } + }, + "Key": { + "target": "com.amazonaws.dynamodb#Key", + "traits": { + "smithy.api#documentation": "

A map of attribute names to AttributeValue objects, representing the\n primary key of the item to retrieve.

\n

For the primary key, you must provide all of the attributes. For example, with a\n simple primary key, you only need to provide a value for the partition key. For a\n composite primary key, you must provide values for both the partition key and the sort\n key.

", + "smithy.api#required": {} + } + }, + "AttributesToGet": { + "target": "com.amazonaws.dynamodb#AttributeNameList", + "traits": { + "smithy.api#documentation": "

This is a legacy parameter. Use ProjectionExpression instead. For more\n information, see AttributesToGet in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ConsistentRead": { + "target": "com.amazonaws.dynamodb#ConsistentRead", + "traits": { + "smithy.api#documentation": "

Determines the read consistency model: If set to true, then the operation\n uses strongly consistent reads; otherwise, the operation uses eventually consistent\n reads.

" + } + }, + "ReturnConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ReturnConsumedCapacity" + }, + "ProjectionExpression": { + "target": "com.amazonaws.dynamodb#ProjectionExpression", + "traits": { + "smithy.api#documentation": "

A string that identifies one or more attributes to retrieve from the table. These\n attributes can include scalars, sets, or elements of a JSON document. The attributes in\n the expression must be separated by commas.

\n

If no attribute names are specified, then all attributes are returned. If any of the\n requested attributes are not found, they do not appear in the result.

\n

For more information, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ExpressionAttributeNames": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", + "traits": { + "smithy.api#documentation": "

One or more substitution tokens for attribute names in an expression. The following\n are some use cases for using ExpressionAttributeNames:

\n \n

Use the # character in an expression to dereference\n an attribute name. For example, consider the following attribute name:

\n \n

The name of this attribute conflicts with a reserved word, so it cannot be used\n directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer\n Guide). To work around this, you could specify the following for\n ExpressionAttributeNames:

\n \n

You could then use this substitution in an expression, as in this example:

\n \n \n

Tokens that begin with the : character are\n expression attribute values, which are placeholders for the\n actual value at runtime.

\n \n

For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a GetItem operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#GetItemOutput": { + "type": "structure", + "members": { + "Item": { + "target": "com.amazonaws.dynamodb#AttributeMap", + "traits": { + "smithy.api#documentation": "

A map of attribute names to AttributeValue objects, as specified by\n ProjectionExpression.

" + } + }, + "ConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ConsumedCapacity", + "traits": { + "smithy.api#documentation": "

The capacity units consumed by the GetItem operation. The data returned\n includes the total provisioned throughput consumed, along with statistics for the table\n and any indexes involved in the operation. ConsumedCapacity is only\n returned if the ReturnConsumedCapacity parameter was specified. For more\n information, see Capacity unit consumption for read operations in the Amazon\n DynamoDB Developer Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a GetItem operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#GetResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#GetResourcePolicyInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#GetResourcePolicyOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#PolicyNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Returns the resource-based policy document attached to the resource, which can be a\n table or stream, in JSON format.

\n

\n GetResourcePolicy follows an \n eventually consistent\n model. The following list\n describes the outcomes when you issue the GetResourcePolicy request\n immediately after issuing another request:

\n \n

Because GetResourcePolicy uses an eventually\n consistent query, the metadata for your policy or table might not be\n available at that moment. Wait for a few seconds, and then retry the\n GetResourcePolicy request.

\n

After a GetResourcePolicy request returns a policy created using the\n PutResourcePolicy request, the policy will be applied in the\n authorization of requests to the resource. Because this process is eventually\n consistent, it will take some time to apply the policy to all requests to a resource.\n Policies that you attach while creating a table using the CreateTable\n request will always be applied to all requests for that table.

" + } + }, + "com.amazonaws.dynamodb#GetResourcePolicyInput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.dynamodb#ResourceArnString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the DynamoDB resource to which the policy is attached. The\n resources you can specify include tables and streams.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#GetResourcePolicyOutput": { + "type": "structure", + "members": { + "Policy": { + "target": "com.amazonaws.dynamodb#ResourcePolicy", + "traits": { + "smithy.api#documentation": "

The resource-based policy document attached to the resource, which can be a table or\n stream, in JSON format.

" + } + }, + "RevisionId": { + "target": "com.amazonaws.dynamodb#PolicyRevisionId", + "traits": { + "smithy.api#documentation": "

A unique string that represents the revision ID of the policy. If you're comparing revision IDs, make sure to always use string comparison logic.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#GlobalSecondaryIndex": { + "type": "structure", + "members": { + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the global secondary index. The name must be unique among all other\n indexes on this table.

", + "smithy.api#required": {} + } + }, + "KeySchema": { + "target": "com.amazonaws.dynamodb#KeySchema", + "traits": { + "smithy.api#documentation": "

The complete key schema for a global secondary index, which consists of one or more\n pairs of attribute names and key types:

\n \n \n

The partition key of an item is also known as its hash\n attribute. The term \"hash attribute\" derives from DynamoDB's usage of\n an internal hash function to evenly distribute data items across partitions, based\n on their partition key values.

\n

The sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with the same\n partition key physically close together, in sorted order by the sort key\n value.

\n ", + "smithy.api#required": {} + } + }, + "Projection": { + "target": "com.amazonaws.dynamodb#Projection", + "traits": { + "smithy.api#documentation": "

Represents attributes that are copied (projected) from the table into the global\n secondary index. These are in addition to the primary key attributes and index key\n attributes, which are automatically projected.

", + "smithy.api#required": {} + } + }, + "ProvisionedThroughput": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughput", + "traits": { + "smithy.api#documentation": "

Represents the provisioned throughput settings for the specified global secondary\n index.

\n

For current minimum and maximum provisioned throughput values, see Service,\n Account, and Table Quotas in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "OnDemandThroughput": { + "target": "com.amazonaws.dynamodb#OnDemandThroughput", + "traits": { + "smithy.api#documentation": "

The maximum number of read and write units for the specified global secondary index.\n If you use this parameter, you must specify MaxReadRequestUnits,\n MaxWriteRequestUnits, or both.

" + } + }, + "WarmThroughput": { + "target": "com.amazonaws.dynamodb#WarmThroughput", + "traits": { + "smithy.api#documentation": "

Represents the warm throughput value (in read units per second and write units per\n second) for the specified secondary index. If you use this parameter, you must specify\n ReadUnitsPerSecond, WriteUnitsPerSecond, or both.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the properties of a global secondary index.

" + } + }, + "com.amazonaws.dynamodb#GlobalSecondaryIndexAutoScalingUpdate": { + "type": "structure", + "members": { + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the global secondary index.

" + } + }, + "ProvisionedWriteCapacityAutoScalingUpdate": { + "target": "com.amazonaws.dynamodb#AutoScalingSettingsUpdate" + } + }, + "traits": { + "smithy.api#documentation": "

Represents the auto scaling settings of a global secondary index for a global table\n that will be modified.

" + } + }, + "com.amazonaws.dynamodb#GlobalSecondaryIndexAutoScalingUpdateList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexAutoScalingUpdate" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.dynamodb#GlobalSecondaryIndexDescription": { + "type": "structure", + "members": { + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the global secondary index.

" + } + }, + "KeySchema": { + "target": "com.amazonaws.dynamodb#KeySchema", + "traits": { + "smithy.api#documentation": "

The complete key schema for a global secondary index, which consists of one or more\n pairs of attribute names and key types:

\n \n \n

The partition key of an item is also known as its hash\n attribute. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across\n partitions, based on their partition key values.

\n

The sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with\n the same partition key physically close together, in sorted order by the sort key\n value.

\n " + } + }, + "Projection": { + "target": "com.amazonaws.dynamodb#Projection", + "traits": { + "smithy.api#documentation": "

Represents attributes that are copied (projected) from the table into the global\n secondary index. These are in addition to the primary key attributes and index key\n attributes, which are automatically projected.

" + } + }, + "IndexStatus": { + "target": "com.amazonaws.dynamodb#IndexStatus", + "traits": { + "smithy.api#documentation": "

The current state of the global secondary index:

\n " + } + }, + "Backfilling": { + "target": "com.amazonaws.dynamodb#Backfilling", + "traits": { + "smithy.api#documentation": "

Indicates whether the index is currently backfilling. Backfilling\n is the process of reading items from the table and determining whether they can be added\n to the index. (Not all items will qualify: For example, a partition key cannot have any\n duplicate values.) If an item can be added to the index, DynamoDB will do so. After all\n items have been processed, the backfilling operation is complete and\n Backfilling is false.

\n

You can delete an index that is being created during the Backfilling\n phase when IndexStatus is set to CREATING and Backfilling is\n true. You can't delete the index that is being created when IndexStatus is\n set to CREATING and Backfilling is false.

\n \n

For indexes that were created during a CreateTable operation, the\n Backfilling attribute does not appear in the\n DescribeTable output.

\n " + } + }, + "ProvisionedThroughput": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughputDescription", + "traits": { + "smithy.api#documentation": "

Represents the provisioned throughput settings for the specified global secondary\n index.

\n

For current minimum and maximum provisioned throughput values, see Service,\n Account, and Table Quotas in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "IndexSizeBytes": { + "target": "com.amazonaws.dynamodb#LongObject", + "traits": { + "smithy.api#documentation": "

The total size of the specified index, in bytes. DynamoDB updates this value\n approximately every six hours. Recent changes might not be reflected in this\n value.

" + } + }, + "ItemCount": { + "target": "com.amazonaws.dynamodb#LongObject", + "traits": { + "smithy.api#documentation": "

The number of items in the specified index. DynamoDB updates this value approximately\n every six hours. Recent changes might not be reflected in this value.

" + } + }, + "IndexArn": { + "target": "com.amazonaws.dynamodb#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the index.

" + } + }, + "OnDemandThroughput": { + "target": "com.amazonaws.dynamodb#OnDemandThroughput", + "traits": { + "smithy.api#documentation": "

The maximum number of read and write units for the specified global secondary index.\n If you use this parameter, you must specify MaxReadRequestUnits,\n MaxWriteRequestUnits, or both.

" + } + }, + "WarmThroughput": { + "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexWarmThroughputDescription", + "traits": { + "smithy.api#documentation": "

Represents the warm throughput value (in read units per second and write units per\n second) for the specified secondary index.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the properties of a global secondary index.

" + } + }, + "com.amazonaws.dynamodb#GlobalSecondaryIndexDescriptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexDescription" + } + }, + "com.amazonaws.dynamodb#GlobalSecondaryIndexInfo": { + "type": "structure", + "members": { + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the global secondary index.

" + } + }, + "KeySchema": { + "target": "com.amazonaws.dynamodb#KeySchema", + "traits": { + "smithy.api#documentation": "

The complete key schema for a global secondary index, which consists of one or more\n pairs of attribute names and key types:

\n \n \n

The partition key of an item is also known as its hash\n attribute. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across\n partitions, based on their partition key values.

\n

The sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with\n the same partition key physically close together, in sorted order by the sort key\n value.

\n " + } + }, + "Projection": { + "target": "com.amazonaws.dynamodb#Projection", + "traits": { + "smithy.api#documentation": "

Represents attributes that are copied (projected) from the table into the global\n secondary index. These are in addition to the primary key attributes and index key\n attributes, which are automatically projected.

" + } + }, + "ProvisionedThroughput": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughput", + "traits": { + "smithy.api#documentation": "

Represents the provisioned throughput settings for the specified global secondary\n index.

" + } + }, + "OnDemandThroughput": { + "target": "com.amazonaws.dynamodb#OnDemandThroughput" + } + }, + "traits": { + "smithy.api#documentation": "

Represents the properties of a global secondary index for the table when the backup\n was created.

" + } + }, + "com.amazonaws.dynamodb#GlobalSecondaryIndexList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#GlobalSecondaryIndex" + } + }, + "com.amazonaws.dynamodb#GlobalSecondaryIndexUpdate": { + "type": "structure", + "members": { + "Update": { + "target": "com.amazonaws.dynamodb#UpdateGlobalSecondaryIndexAction", + "traits": { + "smithy.api#documentation": "

The name of an existing global secondary index, along with new provisioned throughput\n settings to be applied to that index.

" + } + }, + "Create": { + "target": "com.amazonaws.dynamodb#CreateGlobalSecondaryIndexAction", + "traits": { + "smithy.api#documentation": "

The parameters required for creating a global secondary index on an existing\n table:

\n " + } + }, + "Delete": { + "target": "com.amazonaws.dynamodb#DeleteGlobalSecondaryIndexAction", + "traits": { + "smithy.api#documentation": "

The name of an existing global secondary index to be removed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents one of the following:

\n " + } + }, + "com.amazonaws.dynamodb#GlobalSecondaryIndexUpdateList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexUpdate" + } + }, + "com.amazonaws.dynamodb#GlobalSecondaryIndexWarmThroughputDescription": { + "type": "structure", + "members": { + "ReadUnitsPerSecond": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

Represents warm throughput read units per second value for a global secondary\n index.

" + } + }, + "WriteUnitsPerSecond": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

Represents warm throughput write units per second value for a global secondary\n index.

" + } + }, + "Status": { + "target": "com.amazonaws.dynamodb#IndexStatus", + "traits": { + "smithy.api#documentation": "

Represents the warm throughput status being created or updated on a global secondary\n index. The status can only be UPDATING or ACTIVE.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The description of the warm throughput value on a global secondary index.

" + } + }, + "com.amazonaws.dynamodb#GlobalSecondaryIndexes": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexInfo" + } + }, + "com.amazonaws.dynamodb#GlobalTable": { + "type": "structure", + "members": { + "GlobalTableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The global table name.

" + } + }, + "ReplicationGroup": { + "target": "com.amazonaws.dynamodb#ReplicaList", + "traits": { + "smithy.api#documentation": "

The Regions where the global table has replicas.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the properties of a global table.

" + } + }, + "com.amazonaws.dynamodb#GlobalTableAlreadyExistsException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The specified global table already exists.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#GlobalTableArnString": { + "type": "string" + }, + "com.amazonaws.dynamodb#GlobalTableDescription": { + "type": "structure", + "members": { + "ReplicationGroup": { + "target": "com.amazonaws.dynamodb#ReplicaDescriptionList", + "traits": { + "smithy.api#documentation": "

The Regions where the global table has replicas.

" + } + }, + "GlobalTableArn": { + "target": "com.amazonaws.dynamodb#GlobalTableArnString", + "traits": { + "smithy.api#documentation": "

The unique identifier of the global table.

" + } + }, + "CreationDateTime": { + "target": "com.amazonaws.dynamodb#Date", + "traits": { + "smithy.api#documentation": "

The creation time of the global table.

" + } + }, + "GlobalTableStatus": { + "target": "com.amazonaws.dynamodb#GlobalTableStatus", + "traits": { + "smithy.api#documentation": "

The current state of the global table:

\n " + } + }, + "GlobalTableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The global table name.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about the global table.

" + } + }, + "com.amazonaws.dynamodb#GlobalTableGlobalSecondaryIndexSettingsUpdate": { + "type": "structure", + "members": { + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the global secondary index. The name must be unique among all other\n indexes on this table.

", + "smithy.api#required": {} + } + }, + "ProvisionedWriteCapacityUnits": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

The maximum number of writes consumed per second before DynamoDB returns a\n ThrottlingException.\n

" + } + }, + "ProvisionedWriteCapacityAutoScalingSettingsUpdate": { + "target": "com.amazonaws.dynamodb#AutoScalingSettingsUpdate", + "traits": { + "smithy.api#documentation": "

Auto scaling settings for managing a global secondary index's write capacity\n units.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the settings of a global secondary index for a global table that will be\n modified.

" + } + }, + "com.amazonaws.dynamodb#GlobalTableGlobalSecondaryIndexSettingsUpdateList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#GlobalTableGlobalSecondaryIndexSettingsUpdate" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.dynamodb#GlobalTableList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#GlobalTable" + } + }, + "com.amazonaws.dynamodb#GlobalTableNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The specified global table does not exist.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#GlobalTableStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + } + } + }, + "com.amazonaws.dynamodb#IdempotentParameterMismatchException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

DynamoDB rejected the request because you retried a request with a\n different payload but with an idempotent token that was already used.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#ImportArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 37, + "max": 1024 + } + } + }, + "com.amazonaws.dynamodb#ImportConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

\n There was a conflict when importing from the specified S3 source. \n This can occur when the current import conflicts with a previous import request \n that had the same client token.\n

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#ImportEndTime": { + "type": "timestamp" + }, + "com.amazonaws.dynamodb#ImportNextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 112, + "max": 1024 + }, + "smithy.api#pattern": "^([0-9a-f]{16})+$" + } + }, + "com.amazonaws.dynamodb#ImportNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

\n The specified import was not found.\n

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#ImportStartTime": { + "type": "timestamp" + }, + "com.amazonaws.dynamodb#ImportStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "CANCELLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLING" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.dynamodb#ImportSummary": { + "type": "structure", + "members": { + "ImportArn": { + "target": "com.amazonaws.dynamodb#ImportArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) corresponding to the import request.

" + } + }, + "ImportStatus": { + "target": "com.amazonaws.dynamodb#ImportStatus", + "traits": { + "smithy.api#documentation": "

The status of the import operation.

" + } + }, + "TableArn": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the table being imported into.

" + } + }, + "S3BucketSource": { + "target": "com.amazonaws.dynamodb#S3BucketSource", + "traits": { + "smithy.api#documentation": "

The path and S3 bucket of the source file that is being imported. This includes the\n S3Bucket (required), S3KeyPrefix (optional) and S3BucketOwner (optional if the bucket is\n owned by the requester).

" + } + }, + "CloudWatchLogGroupArn": { + "target": "com.amazonaws.dynamodb#CloudWatchLogGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the Cloudwatch Log Group associated with this\n import task.

" + } + }, + "InputFormat": { + "target": "com.amazonaws.dynamodb#InputFormat", + "traits": { + "smithy.api#documentation": "

The format of the source data. Valid values are CSV,\n DYNAMODB_JSON or ION.

" + } + }, + "StartTime": { + "target": "com.amazonaws.dynamodb#ImportStartTime", + "traits": { + "smithy.api#documentation": "

The time at which this import task began.

" + } + }, + "EndTime": { + "target": "com.amazonaws.dynamodb#ImportEndTime", + "traits": { + "smithy.api#documentation": "

The time at which this import task ended. (Does this include the successful complete\n creation of the table it was imported to?)

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Summary information about the source file for the import.\n

" + } + }, + "com.amazonaws.dynamodb#ImportSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ImportSummary" + } + }, + "com.amazonaws.dynamodb#ImportTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#ImportTableInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#ImportTableOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#ImportConflictException" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceInUseException" + } + ], + "traits": { + "smithy.api#documentation": "

Imports table data from an S3 bucket.

" + } + }, + "com.amazonaws.dynamodb#ImportTableDescription": { + "type": "structure", + "members": { + "ImportArn": { + "target": "com.amazonaws.dynamodb#ImportArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) corresponding to the import request.\n

" + } + }, + "ImportStatus": { + "target": "com.amazonaws.dynamodb#ImportStatus", + "traits": { + "smithy.api#documentation": "

The status of the import.

" + } + }, + "TableArn": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the table being imported into.\n

" + } + }, + "TableId": { + "target": "com.amazonaws.dynamodb#TableId", + "traits": { + "smithy.api#documentation": "

The table id corresponding to the table created by import table process.\n

" + } + }, + "ClientToken": { + "target": "com.amazonaws.dynamodb#ClientToken", + "traits": { + "smithy.api#documentation": "

The client token that was provided for the import task. Reusing the client token on\n retry makes a call to ImportTable idempotent.

" + } + }, + "S3BucketSource": { + "target": "com.amazonaws.dynamodb#S3BucketSource", + "traits": { + "smithy.api#documentation": "

Values for the S3 bucket the source file is imported from. Includes bucket name\n (required), key prefix (optional) and bucket account owner ID (optional).

" + } + }, + "ErrorCount": { + "target": "com.amazonaws.dynamodb#ErrorCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of errors occurred on importing the source file into the target table.\n

" + } + }, + "CloudWatchLogGroupArn": { + "target": "com.amazonaws.dynamodb#CloudWatchLogGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the Cloudwatch Log Group associated with the\n target table.

" + } + }, + "InputFormat": { + "target": "com.amazonaws.dynamodb#InputFormat", + "traits": { + "smithy.api#documentation": "

The format of the source data going into the target table.\n

" + } + }, + "InputFormatOptions": { + "target": "com.amazonaws.dynamodb#InputFormatOptions", + "traits": { + "smithy.api#documentation": "

The format options for the data that was imported into the target table. There is one\n value, CsvOption.

" + } + }, + "InputCompressionType": { + "target": "com.amazonaws.dynamodb#InputCompressionType", + "traits": { + "smithy.api#documentation": "

The compression options for the data that has been imported into the target table.\n The values are NONE, GZIP, or ZSTD.

" + } + }, + "TableCreationParameters": { + "target": "com.amazonaws.dynamodb#TableCreationParameters", + "traits": { + "smithy.api#documentation": "

The parameters for the new table that is being imported into.

" + } + }, + "StartTime": { + "target": "com.amazonaws.dynamodb#ImportStartTime", + "traits": { + "smithy.api#documentation": "

The time when this import task started.

" + } + }, + "EndTime": { + "target": "com.amazonaws.dynamodb#ImportEndTime", + "traits": { + "smithy.api#documentation": "

The time at which the creation of the table associated with this import task\n completed.

" + } + }, + "ProcessedSizeBytes": { + "target": "com.amazonaws.dynamodb#LongObject", + "traits": { + "smithy.api#documentation": "

The total size of data processed from the source file, in Bytes.

" + } + }, + "ProcessedItemCount": { + "target": "com.amazonaws.dynamodb#ProcessedItemCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The total number of items processed from the source file.

" + } + }, + "ImportedItemCount": { + "target": "com.amazonaws.dynamodb#ImportedItemCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of items successfully imported into the new table.

" + } + }, + "FailureCode": { + "target": "com.amazonaws.dynamodb#FailureCode", + "traits": { + "smithy.api#documentation": "

The error code corresponding to the failure that the import job ran into during\n execution.

" + } + }, + "FailureMessage": { + "target": "com.amazonaws.dynamodb#FailureMessage", + "traits": { + "smithy.api#documentation": "

The error message corresponding to the failure that the import job ran into during\n execution.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the properties of the table being imported into.\n

" + } + }, + "com.amazonaws.dynamodb#ImportTableInput": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.dynamodb#ClientToken", + "traits": { + "smithy.api#documentation": "

Providing a ClientToken makes the call to ImportTableInput\n idempotent, meaning that multiple identical calls have the same effect as one single\n call.

\n

A client token is valid for 8 hours after the first request that uses it is completed.\n After 8 hours, any request with the same client token is treated as a new request. Do\n not resubmit the same request with the same client token for more than 8 hours, or the\n result might not be idempotent.

\n

If you submit a request with the same client token but a change in other parameters\n within the 8-hour idempotency window, DynamoDB returns an\n IdempotentParameterMismatch exception.

", + "smithy.api#idempotencyToken": {} + } + }, + "S3BucketSource": { + "target": "com.amazonaws.dynamodb#S3BucketSource", + "traits": { + "smithy.api#documentation": "

The S3 bucket that provides the source for the import.

", + "smithy.api#required": {} + } + }, + "InputFormat": { + "target": "com.amazonaws.dynamodb#InputFormat", + "traits": { + "smithy.api#documentation": "

The format of the source data. Valid values for ImportFormat are\n CSV, DYNAMODB_JSON or ION.

", + "smithy.api#required": {} + } + }, + "InputFormatOptions": { + "target": "com.amazonaws.dynamodb#InputFormatOptions", + "traits": { + "smithy.api#documentation": "

Additional properties that specify how the input is formatted,

" + } + }, + "InputCompressionType": { + "target": "com.amazonaws.dynamodb#InputCompressionType", + "traits": { + "smithy.api#documentation": "

Type of compression to be used on the input coming from the imported table.

" + } + }, + "TableCreationParameters": { + "target": "com.amazonaws.dynamodb#TableCreationParameters", + "traits": { + "smithy.api#documentation": "

Parameters for the table to import the data into.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#ImportTableOutput": { + "type": "structure", + "members": { + "ImportTableDescription": { + "target": "com.amazonaws.dynamodb#ImportTableDescription", + "traits": { + "smithy.api#documentation": "

Represents the properties of the table created for the import, and parameters of the\n import. The import parameters include import status, how many items were processed, and\n how many errors were encountered.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#ImportedItemCount": { + "type": "long", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.dynamodb#IncrementalExportSpecification": { + "type": "structure", + "members": { + "ExportFromTime": { + "target": "com.amazonaws.dynamodb#ExportFromTime", + "traits": { + "smithy.api#documentation": "

Time in the past which provides the inclusive start range for the export table's data,\n counted in seconds from the start of the Unix epoch. The incremental export will reflect\n the table's state including and after this point in time.

" + } + }, + "ExportToTime": { + "target": "com.amazonaws.dynamodb#ExportToTime", + "traits": { + "smithy.api#documentation": "

Time in the past which provides the exclusive end range for the export table's data,\n counted in seconds from the start of the Unix epoch. The incremental export will reflect\n the table's state just prior to this point in time. If this is not provided, the latest\n time with data available will be used.

" + } + }, + "ExportViewType": { + "target": "com.amazonaws.dynamodb#ExportViewType", + "traits": { + "smithy.api#documentation": "

The view type that was chosen for the export. Valid values are\n NEW_AND_OLD_IMAGES and NEW_IMAGES. The default value is\n NEW_AND_OLD_IMAGES.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Optional object containing the parameters specific to an incremental export.

" + } + }, + "com.amazonaws.dynamodb#IndexName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_.-]+$" + } + }, + "com.amazonaws.dynamodb#IndexNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The operation tried to access a nonexistent index.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#IndexStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + } + } + }, + "com.amazonaws.dynamodb#InputCompressionType": { + "type": "enum", + "members": { + "GZIP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GZIP" + } + }, + "ZSTD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZSTD" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, + "com.amazonaws.dynamodb#InputFormat": { + "type": "enum", + "members": { + "DYNAMODB_JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DYNAMODB_JSON" + } + }, + "ION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ION" + } + }, + "CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CSV" + } + } + } + }, + "com.amazonaws.dynamodb#InputFormatOptions": { + "type": "structure", + "members": { + "Csv": { + "target": "com.amazonaws.dynamodb#CsvOptions", + "traits": { + "smithy.api#documentation": "

The options for imported source files in CSV format. The values are Delimiter and\n HeaderList.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The format options for the data that was imported into the target table. There is one\n value, CsvOption.

" + } + }, + "com.amazonaws.dynamodb#Integer": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.dynamodb#IntegerObject": { + "type": "integer" + }, + "com.amazonaws.dynamodb#InternalServerError": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The server encountered an internal error trying to fulfill the request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An error occurred on the server side.

", + "smithy.api#error": "server" + } + }, + "com.amazonaws.dynamodb#InvalidEndpointException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.dynamodb#String" + } + }, + "traits": { + "smithy.api#error": "client", + "smithy.api#httpError": 421 + } + }, + "com.amazonaws.dynamodb#InvalidExportTimeException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The specified ExportTime is outside of the point in time recovery\n window.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#InvalidRestoreTimeException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

An invalid restore time was specified. RestoreDateTime must be between\n EarliestRestorableDateTime and LatestRestorableDateTime.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#ItemCollectionKeyAttributeMap": { + "type": "map", + "key": { + "target": "com.amazonaws.dynamodb#AttributeName" + }, + "value": { + "target": "com.amazonaws.dynamodb#AttributeValue" + } + }, + "com.amazonaws.dynamodb#ItemCollectionMetrics": { + "type": "structure", + "members": { + "ItemCollectionKey": { + "target": "com.amazonaws.dynamodb#ItemCollectionKeyAttributeMap", + "traits": { + "smithy.api#documentation": "

The partition key value of the item collection. This value is the same as the\n partition key value of the item.

" + } + }, + "SizeEstimateRangeGB": { + "target": "com.amazonaws.dynamodb#ItemCollectionSizeEstimateRange", + "traits": { + "smithy.api#documentation": "

An estimate of item collection size, in gigabytes. This value is a two-element array\n containing a lower bound and an upper bound for the estimate. The estimate includes the\n size of all the items in the table, plus the size of all attributes projected into all\n of the local secondary indexes on that table. Use this estimate to measure whether a\n local secondary index is approaching its size limit.

\n

The estimate is subject to change over time; therefore, do not rely on the precision\n or accuracy of the estimate.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about item collections, if any, that were affected by the operation.\n ItemCollectionMetrics is only returned if the request asked for it. If\n the table does not have any local secondary indexes, this information is not returned in\n the response.

" + } + }, + "com.amazonaws.dynamodb#ItemCollectionMetricsMultiple": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ItemCollectionMetrics" + } + }, + "com.amazonaws.dynamodb#ItemCollectionMetricsPerTable": { + "type": "map", + "key": { + "target": "com.amazonaws.dynamodb#TableArn" + }, + "value": { + "target": "com.amazonaws.dynamodb#ItemCollectionMetricsMultiple" + } + }, + "com.amazonaws.dynamodb#ItemCollectionSizeEstimateBound": { + "type": "double" + }, + "com.amazonaws.dynamodb#ItemCollectionSizeEstimateRange": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ItemCollectionSizeEstimateBound" + } + }, + "com.amazonaws.dynamodb#ItemCollectionSizeLimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The total size of an item collection has exceeded the maximum limit of 10\n gigabytes.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An item collection is too large. This exception is only returned for tables that\n have one or more local secondary indexes.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#ItemCount": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.dynamodb#ItemList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#AttributeMap" + } + }, + "com.amazonaws.dynamodb#ItemResponse": { + "type": "structure", + "members": { + "Item": { + "target": "com.amazonaws.dynamodb#AttributeMap", + "traits": { + "smithy.api#documentation": "

Map of attribute data consisting of the data type and attribute value.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details for the requested item.

" + } + }, + "com.amazonaws.dynamodb#ItemResponseList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ItemResponse" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.dynamodb#KMSMasterKeyArn": { + "type": "string" + }, + "com.amazonaws.dynamodb#KMSMasterKeyId": { + "type": "string" + }, + "com.amazonaws.dynamodb#Key": { + "type": "map", + "key": { + "target": "com.amazonaws.dynamodb#AttributeName" + }, + "value": { + "target": "com.amazonaws.dynamodb#AttributeValue" + } + }, + "com.amazonaws.dynamodb#KeyConditions": { + "type": "map", + "key": { + "target": "com.amazonaws.dynamodb#AttributeName" + }, + "value": { + "target": "com.amazonaws.dynamodb#Condition" + } + }, + "com.amazonaws.dynamodb#KeyExpression": { + "type": "string" + }, + "com.amazonaws.dynamodb#KeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#Key" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.dynamodb#KeySchema": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#KeySchemaElement" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.dynamodb#KeySchemaAttributeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.dynamodb#KeySchemaElement": { + "type": "structure", + "members": { + "AttributeName": { + "target": "com.amazonaws.dynamodb#KeySchemaAttributeName", + "traits": { + "smithy.api#documentation": "

The name of a key attribute.

", + "smithy.api#required": {} + } + }, + "KeyType": { + "target": "com.amazonaws.dynamodb#KeyType", + "traits": { + "smithy.api#documentation": "

The role that this key attribute will assume:

\n \n \n

The partition key of an item is also known as its hash\n attribute. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across\n partitions, based on their partition key values.

\n

The sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with\n the same partition key physically close together, in sorted order by the sort key\n value.

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a single element of a key schema. A key schema\n specifies the attributes that make up the primary key of a table, or the key attributes\n of an index.

\n

A KeySchemaElement represents exactly one attribute of the primary key.\n For example, a simple primary key would be represented by one\n KeySchemaElement (for the partition key). A composite primary key would\n require one KeySchemaElement for the partition key, and another\n KeySchemaElement for the sort key.

\n

A KeySchemaElement must be a scalar, top-level attribute (not a nested\n attribute). The data type must be one of String, Number, or Binary. The attribute cannot\n be nested within a List or a Map.

" + } + }, + "com.amazonaws.dynamodb#KeyType": { + "type": "enum", + "members": { + "HASH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HASH" + } + }, + "RANGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RANGE" + } + } + } + }, + "com.amazonaws.dynamodb#KeysAndAttributes": { + "type": "structure", + "members": { + "Keys": { + "target": "com.amazonaws.dynamodb#KeyList", + "traits": { + "smithy.api#documentation": "

The primary key attribute values that define the items and the attributes associated\n with the items.

", + "smithy.api#required": {} + } + }, + "AttributesToGet": { + "target": "com.amazonaws.dynamodb#AttributeNameList", + "traits": { + "smithy.api#documentation": "

This is a legacy parameter. Use ProjectionExpression instead. For more\n information, see Legacy\n Conditional Parameters in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ConsistentRead": { + "target": "com.amazonaws.dynamodb#ConsistentRead", + "traits": { + "smithy.api#documentation": "

The consistency of a read operation. If set to true, then a strongly\n consistent read is used; otherwise, an eventually consistent read is used.

" + } + }, + "ProjectionExpression": { + "target": "com.amazonaws.dynamodb#ProjectionExpression", + "traits": { + "smithy.api#documentation": "

A string that identifies one or more attributes to retrieve from the table. These\n attributes can include scalars, sets, or elements of a JSON document. The attributes in\n the ProjectionExpression must be separated by commas.

\n

If no attribute names are specified, then all attributes will be returned. If any of\n the requested attributes are not found, they will not appear in the result.

\n

For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ExpressionAttributeNames": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", + "traits": { + "smithy.api#documentation": "

One or more substitution tokens for attribute names in an expression. The following\n are some use cases for using ExpressionAttributeNames:

\n \n

Use the # character in an expression to dereference\n an attribute name. For example, consider the following attribute name:

\n \n

The name of this attribute conflicts with a reserved word, so it cannot be used\n directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer\n Guide). To work around this, you could specify the following for\n ExpressionAttributeNames:

\n \n

You could then use this substitution in an expression, as in this example:

\n \n \n

Tokens that begin with the : character are\n expression attribute values, which are placeholders for the\n actual value at runtime.

\n \n

For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer\n Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a set of primary keys and, for each key, the attributes to retrieve from\n the table.

\n

For each primary key, you must provide all of the key attributes.\n For example, with a simple primary key, you only need to provide the partition key. For\n a composite primary key, you must provide both the partition key\n and the sort key.

" + } + }, + "com.amazonaws.dynamodb#KinesisDataStreamDestination": { + "type": "structure", + "members": { + "StreamArn": { + "target": "com.amazonaws.dynamodb#StreamArn", + "traits": { + "smithy.api#documentation": "

The ARN for a specific Kinesis data stream.

" + } + }, + "DestinationStatus": { + "target": "com.amazonaws.dynamodb#DestinationStatus", + "traits": { + "smithy.api#documentation": "

The current status of replication.

" + } + }, + "DestinationStatusDescription": { + "target": "com.amazonaws.dynamodb#String", + "traits": { + "smithy.api#documentation": "

The human-readable string that corresponds to the replica status.

" + } + }, + "ApproximateCreationDateTimePrecision": { + "target": "com.amazonaws.dynamodb#ApproximateCreationDateTimePrecision", + "traits": { + "smithy.api#documentation": "

The precision of the Kinesis data stream timestamp. The values are either\n MILLISECOND or MICROSECOND.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Kinesis data stream destination.

" + } + }, + "com.amazonaws.dynamodb#KinesisDataStreamDestinations": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#KinesisDataStreamDestination" + } + }, + "com.amazonaws.dynamodb#KinesisStreamingDestinationInput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The name of the DynamoDB table. You can also provide the Amazon Resource Name (ARN) of the\n table in this parameter.

", + "smithy.api#required": {} + } + }, + "StreamArn": { + "target": "com.amazonaws.dynamodb#StreamArn", + "traits": { + "smithy.api#documentation": "

The ARN for a Kinesis data stream.

", + "smithy.api#required": {} + } + }, + "EnableKinesisStreamingConfiguration": { + "target": "com.amazonaws.dynamodb#EnableKinesisStreamingConfiguration", + "traits": { + "smithy.api#documentation": "

The source for the Kinesis streaming information that is being enabled.

" + } + } + } + }, + "com.amazonaws.dynamodb#KinesisStreamingDestinationOutput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The name of the table being modified.

" + } + }, + "StreamArn": { + "target": "com.amazonaws.dynamodb#StreamArn", + "traits": { + "smithy.api#documentation": "

The ARN for the specific Kinesis data stream.

" + } + }, + "DestinationStatus": { + "target": "com.amazonaws.dynamodb#DestinationStatus", + "traits": { + "smithy.api#documentation": "

The current status of the replication.

" + } + }, + "EnableKinesisStreamingConfiguration": { + "target": "com.amazonaws.dynamodb#EnableKinesisStreamingConfiguration", + "traits": { + "smithy.api#documentation": "

The destination for the Kinesis streaming information that is being enabled.

" + } + } + } + }, + "com.amazonaws.dynamodb#LastUpdateDateTime": { + "type": "timestamp" + }, + "com.amazonaws.dynamodb#LimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Too many operations for a given subscriber.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

There is no limit to the number of daily on-demand backups that can be taken.

\n

For most purposes, up to 500 simultaneous table operations are allowed per account. These operations\n include CreateTable, UpdateTable,\n DeleteTable,UpdateTimeToLive,\n RestoreTableFromBackup, and RestoreTableToPointInTime.

\n

When you are creating a table with one or more secondary\n indexes, you can have up to 250 such requests running at a time. However, if the table or\n index specifications are complex, then DynamoDB might temporarily reduce the number\n of concurrent operations.

\n

When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.

\n

There is a soft account quota of 2,500 tables.

\n

GetRecords was called with a value of more than 1000 for the limit request parameter.

\n

More than 2 processes are reading from the same streams shard at the same time. Exceeding\n this limit may result in request throttling.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#ListAttributeValue": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#AttributeValue" + } + }, + "com.amazonaws.dynamodb#ListBackups": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#ListBackupsInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#ListBackupsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

List DynamoDB backups that are associated with an Amazon Web Services account and\n weren't made with Amazon Web Services Backup. To list these backups for a given table,\n specify TableName. ListBackups returns a paginated list of\n results with at most 1 MB worth of items in a page. You can also specify a maximum\n number of entries to be returned in a page.

\n

In the request, start time is inclusive, but end time is exclusive. Note that these\n boundaries are for the time at which the original backup was requested.

\n

You can call ListBackups a maximum of five times per second.

\n

If you want to retrieve the complete list of backups made with Amazon Web Services\n Backup, use the Amazon Web Services Backup\n list API.\n

" + } + }, + "com.amazonaws.dynamodb#ListBackupsInput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

Lists the backups from the table specified in TableName. You can also\n provide the Amazon Resource Name (ARN) of the table in this parameter.

" + } + }, + "Limit": { + "target": "com.amazonaws.dynamodb#BackupsInputLimit", + "traits": { + "smithy.api#documentation": "

Maximum number of backups to return at once.

" + } + }, + "TimeRangeLowerBound": { + "target": "com.amazonaws.dynamodb#TimeRangeLowerBound", + "traits": { + "smithy.api#documentation": "

Only backups created after this time are listed. TimeRangeLowerBound is\n inclusive.

" + } + }, + "TimeRangeUpperBound": { + "target": "com.amazonaws.dynamodb#TimeRangeUpperBound", + "traits": { + "smithy.api#documentation": "

Only backups created before this time are listed. TimeRangeUpperBound is\n exclusive.

" + } + }, + "ExclusiveStartBackupArn": { + "target": "com.amazonaws.dynamodb#BackupArn", + "traits": { + "smithy.api#documentation": "

\n LastEvaluatedBackupArn is the Amazon Resource Name (ARN) of the backup last\n evaluated when the current page of results was returned, inclusive of the current page\n of results. This value may be specified as the ExclusiveStartBackupArn of a\n new ListBackups operation in order to fetch the next page of results.\n

" + } + }, + "BackupType": { + "target": "com.amazonaws.dynamodb#BackupTypeFilter", + "traits": { + "smithy.api#documentation": "

The backups from the table specified by BackupType are listed.

\n

Where BackupType can be:

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#ListBackupsOutput": { + "type": "structure", + "members": { + "BackupSummaries": { + "target": "com.amazonaws.dynamodb#BackupSummaries", + "traits": { + "smithy.api#documentation": "

List of BackupSummary objects.

" + } + }, + "LastEvaluatedBackupArn": { + "target": "com.amazonaws.dynamodb#BackupArn", + "traits": { + "smithy.api#documentation": "

The ARN of the backup last evaluated when the current page of results was returned,\n inclusive of the current page of results. This value may be specified as the\n ExclusiveStartBackupArn of a new ListBackups operation in\n order to fetch the next page of results.

\n

If LastEvaluatedBackupArn is empty, then the last page of results has\n been processed and there are no more results to be retrieved.

\n

If LastEvaluatedBackupArn is not empty, this may or may not indicate\n that there is more data to be returned. All results are guaranteed to have been returned\n if and only if no value for LastEvaluatedBackupArn is returned.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#ListContributorInsights": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#ListContributorInsightsInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#ListContributorInsightsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of ContributorInsightsSummary for a table and all its global secondary\n indexes.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.dynamodb#ListContributorInsightsInput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this\n parameter.

" + } + }, + "NextToken": { + "target": "com.amazonaws.dynamodb#NextTokenString", + "traits": { + "smithy.api#documentation": "

A token to for the desired page, if there is one.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.dynamodb#ListContributorInsightsLimit", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Maximum number of results to return per page.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#ListContributorInsightsLimit": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "max": 100 + } + } + }, + "com.amazonaws.dynamodb#ListContributorInsightsOutput": { + "type": "structure", + "members": { + "ContributorInsightsSummaries": { + "target": "com.amazonaws.dynamodb#ContributorInsightsSummaries", + "traits": { + "smithy.api#documentation": "

A list of ContributorInsightsSummary.

" + } + }, + "NextToken": { + "target": "com.amazonaws.dynamodb#NextTokenString", + "traits": { + "smithy.api#documentation": "

A token to go to the next page if there is one.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#ListExports": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#ListExportsInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#ListExportsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists completed exports within the past 90 days.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.dynamodb#ListExportsInput": { + "type": "structure", + "members": { + "TableArn": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the exported table.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.dynamodb#ListExportsMaxLimit", + "traits": { + "smithy.api#documentation": "

Maximum number of results to return per page.

" + } + }, + "NextToken": { + "target": "com.amazonaws.dynamodb#ExportNextToken", + "traits": { + "smithy.api#documentation": "

An optional string that, if supplied, must be copied from the output of a previous\n call to ListExports. When provided in this manner, the API fetches the next\n page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#ListExportsMaxLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.dynamodb#ListExportsOutput": { + "type": "structure", + "members": { + "ExportSummaries": { + "target": "com.amazonaws.dynamodb#ExportSummaries", + "traits": { + "smithy.api#documentation": "

A list of ExportSummary objects.

" + } + }, + "NextToken": { + "target": "com.amazonaws.dynamodb#ExportNextToken", + "traits": { + "smithy.api#documentation": "

If this value is returned, there are additional results to be displayed. To retrieve\n them, call ListExports again, with NextToken set to this\n value.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#ListGlobalTables": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#ListGlobalTablesInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#ListGlobalTablesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Lists all global tables that have a replica in the specified Region.

\n \n

This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 (Current) when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).

\n

To determine which version you're using, see Determining the global table version you are using. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.

\n " + } + }, + "com.amazonaws.dynamodb#ListGlobalTablesInput": { + "type": "structure", + "members": { + "ExclusiveStartGlobalTableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The first global table name that this operation will evaluate.

" + } + }, + "Limit": { + "target": "com.amazonaws.dynamodb#PositiveIntegerObject", + "traits": { + "smithy.api#documentation": "

The maximum number of table names to return, if the parameter is not specified\n DynamoDB defaults to 100.

\n

If the number of global tables DynamoDB finds reaches this limit, it stops the\n operation and returns the table names collected up to that point, with a table name in\n the LastEvaluatedGlobalTableName to apply in a subsequent operation to the\n ExclusiveStartGlobalTableName parameter.

" + } + }, + "RegionName": { + "target": "com.amazonaws.dynamodb#RegionName", + "traits": { + "smithy.api#documentation": "

Lists the global tables in a specific Region.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#ListGlobalTablesOutput": { + "type": "structure", + "members": { + "GlobalTables": { + "target": "com.amazonaws.dynamodb#GlobalTableList", + "traits": { + "smithy.api#documentation": "

List of global table names.

" + } + }, + "LastEvaluatedGlobalTableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

Last evaluated global table name.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#ListImports": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#ListImportsInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#ListImportsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists completed imports within the past 90 days.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "PageSize" + } + } + }, + "com.amazonaws.dynamodb#ListImportsInput": { + "type": "structure", + "members": { + "TableArn": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the table that was imported to.\n

" + } + }, + "PageSize": { + "target": "com.amazonaws.dynamodb#ListImportsMaxLimit", + "traits": { + "smithy.api#documentation": "

The number of ImportSummary objects returned in a single page.

" + } + }, + "NextToken": { + "target": "com.amazonaws.dynamodb#ImportNextToken", + "traits": { + "smithy.api#documentation": "

An optional string that, if supplied, must be copied from the output of a previous\n call to ListImports. When provided in this manner, the API fetches the next\n page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#ListImportsMaxLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.dynamodb#ListImportsOutput": { + "type": "structure", + "members": { + "ImportSummaryList": { + "target": "com.amazonaws.dynamodb#ImportSummaryList", + "traits": { + "smithy.api#documentation": "

A list of ImportSummary objects.

" + } + }, + "NextToken": { + "target": "com.amazonaws.dynamodb#ImportNextToken", + "traits": { + "smithy.api#documentation": "

If this value is returned, there are additional results to be displayed. To retrieve\n them, call ListImports again, with NextToken set to this\n value.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#ListTables": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#ListTablesInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#ListTablesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Returns an array of table names associated with the current account and endpoint. The\n output from ListTables is paginated, with each page returning a maximum of\n 100 table names.

", + "smithy.api#examples": [ + { + "title": "To list tables", + "documentation": "This example lists all of the tables associated with the current AWS account and endpoint.", + "output": { + "TableNames": [ + "Forum", + "ProductCatalog", + "Reply", + "Thread" + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "ExclusiveStartTableName", + "outputToken": "LastEvaluatedTableName", + "items": "TableNames", + "pageSize": "Limit" + }, + "smithy.test#smokeTests": [ + { + "id": "ListTablesSuccess", + "params": { + "Limit": 1 + }, + "vendorParams": { + "region": "us-west-2" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "success": {} + } + } + ] + } + }, + "com.amazonaws.dynamodb#ListTablesInput": { + "type": "structure", + "members": { + "ExclusiveStartTableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The first table name that this operation will evaluate. Use the value that was\n returned for LastEvaluatedTableName in a previous operation, so that you\n can obtain the next page of results.

" + } + }, + "Limit": { + "target": "com.amazonaws.dynamodb#ListTablesInputLimit", + "traits": { + "smithy.api#documentation": "

A maximum number of table names to return. If this parameter is not specified, the\n limit is 100.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a ListTables operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#ListTablesInputLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.dynamodb#ListTablesOutput": { + "type": "structure", + "members": { + "TableNames": { + "target": "com.amazonaws.dynamodb#TableNameList", + "traits": { + "smithy.api#documentation": "

The names of the tables associated with the current account at the current endpoint.\n The maximum size of this array is 100.

\n

If LastEvaluatedTableName also appears in the output, you can use this\n value as the ExclusiveStartTableName parameter in a subsequent\n ListTables request and obtain the next page of results.

" + } + }, + "LastEvaluatedTableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The name of the last table in the current page of results. Use this value as the\n ExclusiveStartTableName in a new request to obtain the next page of\n results, until all the table names are returned.

\n

If you do not receive a LastEvaluatedTableName value in the response,\n this means that there are no more table names to be retrieved.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a ListTables operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#ListTagsOfResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#ListTagsOfResourceInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#ListTagsOfResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

List all tags on an Amazon DynamoDB resource. You can call ListTagsOfResource up to 10\n times per second, per account.

\n

For an overview on tagging DynamoDB resources, see Tagging for DynamoDB\n in the Amazon DynamoDB Developer Guide.

" + } + }, + "com.amazonaws.dynamodb#ListTagsOfResourceInput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.dynamodb#ResourceArnString", + "traits": { + "smithy.api#documentation": "

The Amazon DynamoDB resource with tags to be listed. This value is an Amazon Resource\n Name (ARN).

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.dynamodb#NextTokenString", + "traits": { + "smithy.api#documentation": "

An optional string that, if supplied, must be copied from the output of a previous\n call to ListTagOfResource. When provided in this manner, this API fetches the next page\n of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#ListTagsOfResourceOutput": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.dynamodb#TagList", + "traits": { + "smithy.api#documentation": "

The tags currently associated with the Amazon DynamoDB resource.

" + } + }, + "NextToken": { + "target": "com.amazonaws.dynamodb#NextTokenString", + "traits": { + "smithy.api#documentation": "

If this value is returned, there are additional results to be displayed. To retrieve\n them, call ListTagsOfResource again, with NextToken set to this value.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#LocalSecondaryIndex": { + "type": "structure", + "members": { + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the local secondary index. The name must be unique among all other indexes\n on this table.

", + "smithy.api#required": {} + } + }, + "KeySchema": { + "target": "com.amazonaws.dynamodb#KeySchema", + "traits": { + "smithy.api#documentation": "

The complete key schema for the local secondary index, consisting of one or more pairs\n of attribute names and key types:

\n \n \n

The partition key of an item is also known as its hash\n attribute. The term \"hash attribute\" derives from DynamoDB's usage of\n an internal hash function to evenly distribute data items across partitions, based\n on their partition key values.

\n

The sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with the same\n partition key physically close together, in sorted order by the sort key\n value.

\n ", + "smithy.api#required": {} + } + }, + "Projection": { + "target": "com.amazonaws.dynamodb#Projection", + "traits": { + "smithy.api#documentation": "

Represents attributes that are copied (projected) from the table into the local\n secondary index. These are in addition to the primary key attributes and index key\n attributes, which are automatically projected.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the properties of a local secondary index.

" + } + }, + "com.amazonaws.dynamodb#LocalSecondaryIndexDescription": { + "type": "structure", + "members": { + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

Represents the name of the local secondary index.

" + } + }, + "KeySchema": { + "target": "com.amazonaws.dynamodb#KeySchema", + "traits": { + "smithy.api#documentation": "

The complete key schema for the local secondary index, consisting of one or more pairs\n of attribute names and key types:

\n \n \n

The partition key of an item is also known as its hash\n attribute. The term \"hash attribute\" derives from DynamoDB's usage of\n an internal hash function to evenly distribute data items across partitions, based\n on their partition key values.

\n

The sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with the same\n partition key physically close together, in sorted order by the sort key\n value.

\n " + } + }, + "Projection": { + "target": "com.amazonaws.dynamodb#Projection", + "traits": { + "smithy.api#documentation": "

Represents attributes that are copied (projected) from the table into the global\n secondary index. These are in addition to the primary key attributes and index key\n attributes, which are automatically projected.

" + } + }, + "IndexSizeBytes": { + "target": "com.amazonaws.dynamodb#LongObject", + "traits": { + "smithy.api#documentation": "

The total size of the specified index, in bytes. DynamoDB updates this value\n approximately every six hours. Recent changes might not be reflected in this\n value.

" + } + }, + "ItemCount": { + "target": "com.amazonaws.dynamodb#LongObject", + "traits": { + "smithy.api#documentation": "

The number of items in the specified index. DynamoDB updates this value\n approximately every six hours. Recent changes might not be reflected in this\n value.

" + } + }, + "IndexArn": { + "target": "com.amazonaws.dynamodb#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the index.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the properties of a local secondary index.

" + } + }, + "com.amazonaws.dynamodb#LocalSecondaryIndexDescriptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#LocalSecondaryIndexDescription" + } + }, + "com.amazonaws.dynamodb#LocalSecondaryIndexInfo": { + "type": "structure", + "members": { + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

Represents the name of the local secondary index.

" + } + }, + "KeySchema": { + "target": "com.amazonaws.dynamodb#KeySchema", + "traits": { + "smithy.api#documentation": "

The complete key schema for a local secondary index, which consists of one or more\n pairs of attribute names and key types:

\n \n \n

The partition key of an item is also known as its hash\n attribute. The term \"hash attribute\" derives from DynamoDB's usage of\n an internal hash function to evenly distribute data items across partitions, based\n on their partition key values.

\n

The sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with the same\n partition key physically close together, in sorted order by the sort key\n value.

\n " + } + }, + "Projection": { + "target": "com.amazonaws.dynamodb#Projection", + "traits": { + "smithy.api#documentation": "

Represents attributes that are copied (projected) from the table into the global\n secondary index. These are in addition to the primary key attributes and index key\n attributes, which are automatically projected.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the properties of a local secondary index for the table when the backup was\n created.

" + } + }, + "com.amazonaws.dynamodb#LocalSecondaryIndexList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#LocalSecondaryIndex" + } + }, + "com.amazonaws.dynamodb#LocalSecondaryIndexes": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#LocalSecondaryIndexInfo" + } + }, + "com.amazonaws.dynamodb#Long": { + "type": "long", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.dynamodb#LongObject": { + "type": "long" + }, + "com.amazonaws.dynamodb#MapAttributeValue": { + "type": "map", + "key": { + "target": "com.amazonaws.dynamodb#AttributeName" + }, + "value": { + "target": "com.amazonaws.dynamodb#AttributeValue" + } + }, + "com.amazonaws.dynamodb#MultiRegionConsistency": { + "type": "enum", + "members": { + "EVENTUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EVENTUAL" + } + }, + "STRONG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRONG" + } + } + } + }, + "com.amazonaws.dynamodb#NextTokenString": { + "type": "string" + }, + "com.amazonaws.dynamodb#NonKeyAttributeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.dynamodb#NonKeyAttributeNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#NonKeyAttributeName" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.dynamodb#NonNegativeLongObject": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.dynamodb#NullAttributeValue": { + "type": "boolean" + }, + "com.amazonaws.dynamodb#NumberAttributeValue": { + "type": "string" + }, + "com.amazonaws.dynamodb#NumberSetAttributeValue": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#NumberAttributeValue" + } + }, + "com.amazonaws.dynamodb#OnDemandThroughput": { + "type": "structure", + "members": { + "MaxReadRequestUnits": { + "target": "com.amazonaws.dynamodb#LongObject", + "traits": { + "smithy.api#documentation": "

Maximum number of read request units for the specified table.

\n

To specify a maximum OnDemandThroughput on your table, set the value of\n MaxReadRequestUnits as greater than or equal to 1. To remove the\n maximum OnDemandThroughput that is currently set on your table, set the\n value of MaxReadRequestUnits to -1.

" + } + }, + "MaxWriteRequestUnits": { + "target": "com.amazonaws.dynamodb#LongObject", + "traits": { + "smithy.api#documentation": "

Maximum number of write request units for the specified table.

\n

To specify a maximum OnDemandThroughput on your table, set the value of\n MaxWriteRequestUnits as greater than or equal to 1. To remove the\n maximum OnDemandThroughput that is currently set on your table, set the\n value of MaxWriteRequestUnits to -1.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Sets the maximum number of read and write units for the specified on-demand table. If\n you use this parameter, you must specify MaxReadRequestUnits,\n MaxWriteRequestUnits, or both.

" + } + }, + "com.amazonaws.dynamodb#OnDemandThroughputOverride": { + "type": "structure", + "members": { + "MaxReadRequestUnits": { + "target": "com.amazonaws.dynamodb#LongObject", + "traits": { + "smithy.api#documentation": "

Maximum number of read request units for the specified replica table.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Overrides the on-demand throughput settings for this replica table. If you don't\n specify a value for this parameter, it uses the source table's on-demand throughput\n settings.

" + } + }, + "com.amazonaws.dynamodb#ParameterizedStatement": { + "type": "structure", + "members": { + "Statement": { + "target": "com.amazonaws.dynamodb#PartiQLStatement", + "traits": { + "smithy.api#documentation": "

A PartiQL statement that uses parameters.

", + "smithy.api#required": {} + } + }, + "Parameters": { + "target": "com.amazonaws.dynamodb#PreparedStatementParameters", + "traits": { + "smithy.api#documentation": "

The parameter values.

" + } + }, + "ReturnValuesOnConditionCheckFailure": { + "target": "com.amazonaws.dynamodb#ReturnValuesOnConditionCheckFailure", + "traits": { + "smithy.api#documentation": "

An optional parameter that returns the item attributes for a PartiQL\n ParameterizedStatement operation that failed a condition check.

\n

There is no additional cost associated with requesting a return value aside from the\n small network and processing overhead of receiving a larger response. No read capacity\n units are consumed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a PartiQL statement that uses parameters.

" + } + }, + "com.amazonaws.dynamodb#ParameterizedStatements": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ParameterizedStatement" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.dynamodb#PartiQLBatchRequest": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#BatchStatementRequest" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.dynamodb#PartiQLBatchResponse": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#BatchStatementResponse" + } + }, + "com.amazonaws.dynamodb#PartiQLNextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32768 + } + } + }, + "com.amazonaws.dynamodb#PartiQLStatement": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 8192 + } + } + }, + "com.amazonaws.dynamodb#PointInTimeRecoveryDescription": { + "type": "structure", + "members": { + "PointInTimeRecoveryStatus": { + "target": "com.amazonaws.dynamodb#PointInTimeRecoveryStatus", + "traits": { + "smithy.api#documentation": "

The current state of point in time recovery:

\n " + } + }, + "RecoveryPeriodInDays": { + "target": "com.amazonaws.dynamodb#RecoveryPeriodInDays", + "traits": { + "smithy.api#documentation": "

The number of preceding days for which continuous backups are taken and maintained.\n Your table data is only recoverable to any point-in-time from within the configured\n recovery period. This parameter is optional. If no value is provided, the value will\n default to 35.

" + } + }, + "EarliestRestorableDateTime": { + "target": "com.amazonaws.dynamodb#Date", + "traits": { + "smithy.api#documentation": "

Specifies the earliest point in time you can restore your table to. You can restore\n your table to any point in time during the last 35 days.

" + } + }, + "LatestRestorableDateTime": { + "target": "com.amazonaws.dynamodb#Date", + "traits": { + "smithy.api#documentation": "

\n LatestRestorableDateTime is typically 5 minutes before the current time.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The description of the point in time settings applied to the table.

" + } + }, + "com.amazonaws.dynamodb#PointInTimeRecoverySpecification": { + "type": "structure", + "members": { + "PointInTimeRecoveryEnabled": { + "target": "com.amazonaws.dynamodb#BooleanObject", + "traits": { + "smithy.api#documentation": "

Indicates whether point in time recovery is enabled (true) or disabled (false) on the\n table.

", + "smithy.api#required": {} + } + }, + "RecoveryPeriodInDays": { + "target": "com.amazonaws.dynamodb#RecoveryPeriodInDays", + "traits": { + "smithy.api#documentation": "

The number of preceding days for which continuous backups are taken and maintained.\n Your table data is only recoverable to any point-in-time from within the configured\n recovery period. This parameter is optional. If no value is provided, the value will\n default to 35.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the settings used to enable point in time recovery.

" + } + }, + "com.amazonaws.dynamodb#PointInTimeRecoveryStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.dynamodb#PointInTimeRecoveryUnavailableException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

Point in time recovery has not yet been enabled for this source table.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#PolicyNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The operation tried to access a nonexistent resource-based policy.

\n

If you specified an ExpectedRevisionId, it's possible that a policy is present for the resource but its revision ID didn't match the expected value.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#PolicyRevisionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.dynamodb#PositiveIntegerObject": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.dynamodb#PositiveLongObject": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.dynamodb#PreparedStatementParameters": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#AttributeValue" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.dynamodb#ProcessedItemCount": { + "type": "long", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.dynamodb#Projection": { + "type": "structure", + "members": { + "ProjectionType": { + "target": "com.amazonaws.dynamodb#ProjectionType", + "traits": { + "smithy.api#documentation": "

The set of attributes that are projected into the index:

\n \n

When using the DynamoDB console, ALL is selected by default.

" + } + }, + "NonKeyAttributes": { + "target": "com.amazonaws.dynamodb#NonKeyAttributeNameList", + "traits": { + "smithy.api#documentation": "

Represents the non-key attribute names which will be projected into the index.

\n

For local secondary indexes, the total count of NonKeyAttributes summed\n across all of the local secondary indexes, must not exceed 100. If you project the same\n attribute into two different indexes, this counts as two distinct attributes when\n determining the total.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents attributes that are copied (projected) from the table into an index. These\n are in addition to the primary key attributes and index key attributes, which are\n automatically projected.

" + } + }, + "com.amazonaws.dynamodb#ProjectionExpression": { + "type": "string" + }, + "com.amazonaws.dynamodb#ProjectionType": { + "type": "enum", + "members": { + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + }, + "KEYS_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KEYS_ONLY" + } + }, + "INCLUDE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INCLUDE" + } + } + } + }, + "com.amazonaws.dynamodb#ProvisionedThroughput": { + "type": "structure", + "members": { + "ReadCapacityUnits": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

The maximum number of strongly consistent reads consumed per second before DynamoDB\n returns a ThrottlingException. For more information, see Specifying\n Read and Write Requirements in the Amazon DynamoDB Developer\n Guide.

\n

If read/write capacity mode is PAY_PER_REQUEST the value is set to\n 0.

", + "smithy.api#required": {} + } + }, + "WriteCapacityUnits": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

The maximum number of writes consumed per second before DynamoDB returns a\n ThrottlingException. For more information, see Specifying\n Read and Write Requirements in the Amazon DynamoDB Developer\n Guide.

\n

If read/write capacity mode is PAY_PER_REQUEST the value is set to\n 0.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the provisioned throughput settings for a specified table or index. The\n settings can be modified using the UpdateTable operation.

\n

For current minimum and maximum provisioned throughput values, see Service,\n Account, and Table Quotas in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "com.amazonaws.dynamodb#ProvisionedThroughputDescription": { + "type": "structure", + "members": { + "LastIncreaseDateTime": { + "target": "com.amazonaws.dynamodb#Date", + "traits": { + "smithy.api#documentation": "

The date and time of the last provisioned throughput increase for this table.

" + } + }, + "LastDecreaseDateTime": { + "target": "com.amazonaws.dynamodb#Date", + "traits": { + "smithy.api#documentation": "

The date and time of the last provisioned throughput decrease for this table.

" + } + }, + "NumberOfDecreasesToday": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

The number of provisioned throughput decreases for this table during this UTC calendar\n day. For current maximums on provisioned throughput decreases, see Service,\n Account, and Table Quotas in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ReadCapacityUnits": { + "target": "com.amazonaws.dynamodb#NonNegativeLongObject", + "traits": { + "smithy.api#documentation": "

The maximum number of strongly consistent reads consumed per second before DynamoDB\n returns a ThrottlingException. Eventually consistent reads require less\n effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits\n per second provides 100 eventually consistent ReadCapacityUnits per\n second.

" + } + }, + "WriteCapacityUnits": { + "target": "com.amazonaws.dynamodb#NonNegativeLongObject", + "traits": { + "smithy.api#documentation": "

The maximum number of writes consumed per second before DynamoDB returns a\n ThrottlingException.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the provisioned throughput settings for the table, consisting of read and\n write capacity units, along with data about increases and decreases.

" + } + }, + "com.amazonaws.dynamodb#ProvisionedThroughputExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage", + "traits": { + "smithy.api#documentation": "

You exceeded your maximum allowed provisioned throughput.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Your request rate is too high. The Amazon Web Services SDKs for DynamoDB\n automatically retry requests that receive this exception. Your request is eventually\n successful, unless your retry queue is too large to finish. Reduce the frequency of\n requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#ProvisionedThroughputOverride": { + "type": "structure", + "members": { + "ReadCapacityUnits": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

Replica-specific read capacity units. If not specified, uses the source table's read\n capacity settings.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Replica-specific provisioned throughput settings. If not specified, uses the source\n table's provisioned throughput settings.

" + } + }, + "com.amazonaws.dynamodb#Put": { + "type": "structure", + "members": { + "Item": { + "target": "com.amazonaws.dynamodb#PutItemInputAttributeMap", + "traits": { + "smithy.api#documentation": "

A map of attribute name to attribute values, representing the primary key of the item\n to be written by PutItem. All of the table's primary key attributes must be\n specified, and their data types must match those of the table's key schema. If any\n attributes are present in the item that are part of an index key schema for the table,\n their types must match the index key schema.

", + "smithy.api#required": {} + } + }, + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

Name of the table in which to write the item. You can also provide the Amazon Resource Name (ARN) of\n the table in this parameter.

", + "smithy.api#required": {} + } + }, + "ConditionExpression": { + "target": "com.amazonaws.dynamodb#ConditionExpression", + "traits": { + "smithy.api#documentation": "

A condition that must be satisfied in order for a conditional update to\n succeed.

" + } + }, + "ExpressionAttributeNames": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", + "traits": { + "smithy.api#documentation": "

One or more substitution tokens for attribute names in an expression.

" + } + }, + "ExpressionAttributeValues": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeValueMap", + "traits": { + "smithy.api#documentation": "

One or more values that can be substituted in an expression.

" + } + }, + "ReturnValuesOnConditionCheckFailure": { + "target": "com.amazonaws.dynamodb#ReturnValuesOnConditionCheckFailure", + "traits": { + "smithy.api#documentation": "

Use ReturnValuesOnConditionCheckFailure to get the item attributes if the\n Put condition fails. For\n ReturnValuesOnConditionCheckFailure, the valid values are: NONE and\n ALL_OLD.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a request to perform a PutItem operation.

" + } + }, + "com.amazonaws.dynamodb#PutItem": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#PutItemInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#PutItemOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#ConditionalCheckFailedException" + }, + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#ItemCollectionSizeLimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.dynamodb#ReplicatedWriteConflictException" + }, + { + "target": "com.amazonaws.dynamodb#RequestLimitExceeded" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#TransactionConflictException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Creates a new item, or replaces an old item with a new item. If an item that has the\n same primary key as the new item already exists in the specified table, the new item\n completely replaces the existing item. You can perform a conditional put operation (add\n a new item if one with the specified primary key doesn't exist), or replace an existing\n item if it has certain attribute values. You can return the item's attribute values in\n the same operation, using the ReturnValues parameter.

\n

When you add an item, the primary key attributes are the only required attributes.

\n

Empty String and Binary attribute values are allowed. Attribute values of type String\n and Binary must have a length greater than zero if the attribute is used as a key\n attribute for a table or index. Set type attributes cannot be empty.

\n

Invalid Requests with empty values will be rejected with a\n ValidationException exception.

\n \n

To prevent a new item from replacing an existing item, use a conditional\n expression that contains the attribute_not_exists function with the\n name of the attribute being used as the partition key for the table. Since every\n record must contain that attribute, the attribute_not_exists function\n will only succeed if no matching item exists.

\n \n

For more information about PutItem, see Working with\n Items in the Amazon DynamoDB Developer Guide.

", + "smithy.api#examples": [ + { + "title": "To add an item to a table", + "documentation": "This example adds a new item to the Music table.", + "input": { + "TableName": "Music", + "Item": { + "AlbumTitle": { + "S": "Somewhat Famous" + }, + "SongTitle": { + "S": "Call Me Today" + }, + "Artist": { + "S": "No One You Know" + } + }, + "ReturnConsumedCapacity": "TOTAL" + }, + "output": { + "ConsumedCapacity": { + "CapacityUnits": 1, + "TableName": "Music" + } + } + } + ] + } + }, + "com.amazonaws.dynamodb#PutItemInput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The name of the table to contain the item. You can also provide the Amazon Resource Name (ARN) of the\n table in this parameter.

", + "smithy.api#required": {} + } + }, + "Item": { + "target": "com.amazonaws.dynamodb#PutItemInputAttributeMap", + "traits": { + "smithy.api#documentation": "

A map of attribute name/value pairs, one for each attribute. Only the primary key\n attributes are required; you can optionally provide other attribute name-value pairs for\n the item.

\n

You must provide all of the attributes for the primary key. For example, with a simple\n primary key, you only need to provide a value for the partition key. For a composite\n primary key, you must provide both values for both the partition key and the sort\n key.

\n

If you specify any attributes that are part of an index key, then the data types for\n those attributes must match those of the schema in the table's attribute\n definition.

\n

Empty String and Binary attribute values are allowed. Attribute values of type String\n and Binary must have a length greater than zero if the attribute is used as a key\n attribute for a table or index.

\n

For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer\n Guide.

\n

Each element in the Item map is an AttributeValue\n object.

", + "smithy.api#required": {} + } + }, + "Expected": { + "target": "com.amazonaws.dynamodb#ExpectedAttributeMap", + "traits": { + "smithy.api#documentation": "

This is a legacy parameter. Use ConditionExpression instead. For more\n information, see Expected in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ReturnValues": { + "target": "com.amazonaws.dynamodb#ReturnValue", + "traits": { + "smithy.api#documentation": "

Use ReturnValues if you want to get the item attributes as they appeared\n before they were updated with the PutItem request. For\n PutItem, the valid values are:

\n \n

The values returned are strongly consistent.

\n

There is no additional cost associated with requesting a return value aside from the\n small network and processing overhead of receiving a larger response. No read capacity\n units are consumed.

\n \n

The ReturnValues parameter is used by several DynamoDB operations;\n however, PutItem does not recognize any values other than\n NONE or ALL_OLD.

\n " + } + }, + "ReturnConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ReturnConsumedCapacity" + }, + "ReturnItemCollectionMetrics": { + "target": "com.amazonaws.dynamodb#ReturnItemCollectionMetrics", + "traits": { + "smithy.api#documentation": "

Determines whether item collection metrics are returned. If set to SIZE,\n the response includes statistics about item collections, if any, that were modified\n during the operation are returned in the response. If set to NONE (the\n default), no statistics are returned.

" + } + }, + "ConditionalOperator": { + "target": "com.amazonaws.dynamodb#ConditionalOperator", + "traits": { + "smithy.api#documentation": "

This is a legacy parameter. Use ConditionExpression instead. For more\n information, see ConditionalOperator in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ConditionExpression": { + "target": "com.amazonaws.dynamodb#ConditionExpression", + "traits": { + "smithy.api#documentation": "

A condition that must be satisfied in order for a conditional PutItem\n operation to succeed.

\n

An expression can contain any of the following:

\n \n

For more information on condition expressions, see Condition Expressions in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ExpressionAttributeNames": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", + "traits": { + "smithy.api#documentation": "

One or more substitution tokens for attribute names in an expression. The following\n are some use cases for using ExpressionAttributeNames:

\n \n

Use the # character in an expression to dereference\n an attribute name. For example, consider the following attribute name:

\n \n

The name of this attribute conflicts with a reserved word, so it cannot be used\n directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer\n Guide). To work around this, you could specify the following for\n ExpressionAttributeNames:

\n \n

You could then use this substitution in an expression, as in this example:

\n \n \n

Tokens that begin with the : character are\n expression attribute values, which are placeholders for the\n actual value at runtime.

\n \n

For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ExpressionAttributeValues": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeValueMap", + "traits": { + "smithy.api#documentation": "

One or more values that can be substituted in an expression.

\n

Use the : (colon) character in an expression to\n dereference an attribute value. For example, suppose that you wanted to check whether\n the value of the ProductStatus attribute was one of the following:

\n

\n Available | Backordered | Discontinued\n

\n

You would first need to specify ExpressionAttributeValues as\n follows:

\n

\n { \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"},\n \":disc\":{\"S\":\"Discontinued\"} }\n

\n

You could then use these values in an expression, such as this:

\n

\n ProductStatus IN (:avail, :back, :disc)\n

\n

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ReturnValuesOnConditionCheckFailure": { + "target": "com.amazonaws.dynamodb#ReturnValuesOnConditionCheckFailure", + "traits": { + "smithy.api#documentation": "

An optional parameter that returns the item attributes for a PutItem\n operation that failed a condition check.

\n

There is no additional cost associated with requesting a return value aside from the\n small network and processing overhead of receiving a larger response. No read capacity\n units are consumed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a PutItem operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#PutItemInputAttributeMap": { + "type": "map", + "key": { + "target": "com.amazonaws.dynamodb#AttributeName" + }, + "value": { + "target": "com.amazonaws.dynamodb#AttributeValue" + } + }, + "com.amazonaws.dynamodb#PutItemOutput": { + "type": "structure", + "members": { + "Attributes": { + "target": "com.amazonaws.dynamodb#AttributeMap", + "traits": { + "smithy.api#documentation": "

The attribute values as they appeared before the PutItem operation, but\n only if ReturnValues is specified as ALL_OLD in the request.\n Each element consists of an attribute name and an attribute value.

" + } + }, + "ConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ConsumedCapacity", + "traits": { + "smithy.api#documentation": "

The capacity units consumed by the PutItem operation. The data returned\n includes the total provisioned throughput consumed, along with statistics for the table\n and any indexes involved in the operation. ConsumedCapacity is only\n returned if the ReturnConsumedCapacity parameter was specified. For more\n information, see Capacity unity consumption for write operations in the Amazon\n DynamoDB Developer Guide.

" + } + }, + "ItemCollectionMetrics": { + "target": "com.amazonaws.dynamodb#ItemCollectionMetrics", + "traits": { + "smithy.api#documentation": "

Information about item collections, if any, that were affected by the\n PutItem operation. ItemCollectionMetrics is only returned\n if the ReturnItemCollectionMetrics parameter was specified. If the table\n does not have any local secondary indexes, this information is not returned in the\n response.

\n

Each ItemCollectionMetrics element consists of:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a PutItem operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#PutRequest": { + "type": "structure", + "members": { + "Item": { + "target": "com.amazonaws.dynamodb#PutItemInputAttributeMap", + "traits": { + "smithy.api#documentation": "

A map of attribute name to attribute values, representing the primary key of an item\n to be processed by PutItem. All of the table's primary key attributes must\n be specified, and their data types must match those of the table's key schema. If any\n attributes are present in the item that are part of an index key schema for the table,\n their types must match the index key schema.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a request to perform a PutItem operation on an item.

" + } + }, + "com.amazonaws.dynamodb#PutResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#PutResourcePolicyInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#PutResourcePolicyOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#PolicyNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceInUseException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Attaches a resource-based policy document to the resource, which can be a table or\n stream. When you attach a resource-based policy using this API, the policy application\n is \n eventually consistent\n .

\n

\n PutResourcePolicy is an idempotent operation; running it multiple times\n on the same resource using the same policy document will return the same revision ID. If\n you specify an ExpectedRevisionId that doesn't match the current policy's\n RevisionId, the PolicyNotFoundException will be\n returned.

\n \n

\n PutResourcePolicy is an asynchronous operation. If you issue a\n GetResourcePolicy request immediately after a\n PutResourcePolicy request, DynamoDB might return your\n previous policy, if there was one, or return the\n PolicyNotFoundException. This is because\n GetResourcePolicy uses an eventually consistent query, and the\n metadata for your policy or table might not be available at that moment. Wait for a\n few seconds, and then try the GetResourcePolicy request again.

\n " + } + }, + "com.amazonaws.dynamodb#PutResourcePolicyInput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.dynamodb#ResourceArnString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the DynamoDB resource to which the policy will be attached.\n The resources you can specify include tables and streams.

\n

You can control index permissions using the base table's policy. To specify the same permission level for your table and its indexes, you can provide both the table and index Amazon Resource Name (ARN)s in the Resource field of a given Statement in your policy document. Alternatively, to specify different permissions for your table, indexes, or both, you can define multiple Statement fields in your policy document.

", + "smithy.api#required": {} + } + }, + "Policy": { + "target": "com.amazonaws.dynamodb#ResourcePolicy", + "traits": { + "smithy.api#documentation": "

An Amazon Web Services resource-based policy document in JSON format.

\n \n

For a full list of all considerations that apply while attaching a resource-based\n policy, see Resource-based\n policy considerations.

", + "smithy.api#required": {} + } + }, + "ExpectedRevisionId": { + "target": "com.amazonaws.dynamodb#PolicyRevisionId", + "traits": { + "smithy.api#documentation": "

A string value that you can use to conditionally update your policy. You can provide\n the revision ID of your existing policy to make mutating requests against that\n policy.

\n \n

When you provide an expected revision ID, if the revision ID of the existing\n policy on the resource doesn't match or if there's no policy attached to the\n resource, your request will be rejected with a\n PolicyNotFoundException.

\n \n

To conditionally attach a policy when no policy exists for the resource, specify\n NO_POLICY for the revision ID.

" + } + }, + "ConfirmRemoveSelfResourceAccess": { + "target": "com.amazonaws.dynamodb#ConfirmRemoveSelfResourceAccess", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Set this parameter to true to confirm that you want to remove your\n permissions to change the policy of this resource in the future.

", + "smithy.api#httpHeader": "x-amz-confirm-remove-self-resource-access" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#PutResourcePolicyOutput": { + "type": "structure", + "members": { + "RevisionId": { + "target": "com.amazonaws.dynamodb#PolicyRevisionId", + "traits": { + "smithy.api#documentation": "

A unique string that represents the revision ID of the policy. If you're comparing revision IDs, make sure to always use string comparison logic.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#Query": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#QueryInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#QueryOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.dynamodb#RequestLimitExceeded" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

You must provide the name of the partition key attribute and a single value for that\n attribute. Query returns all items with that partition key value.\n Optionally, you can provide a sort key attribute and use a comparison operator to refine\n the search results.

\n

Use the KeyConditionExpression parameter to provide a specific value for\n the partition key. The Query operation will return all of the items from\n the table or index with that partition key value. You can optionally narrow the scope of\n the Query operation by specifying a sort key value and a comparison\n operator in KeyConditionExpression. To further refine the\n Query results, you can optionally provide a\n FilterExpression. A FilterExpression determines which\n items within the results should be returned to you. All of the other results are\n discarded.

\n

A Query operation always returns a result set. If no matching items are\n found, the result set will be empty. Queries that do not return results consume the\n minimum number of read capacity units for that type of read operation.

\n \n

DynamoDB calculates the number of read capacity units consumed based on item\n size, not on the amount of data that is returned to an application. The number of\n capacity units consumed will be the same whether you request all of the attributes\n (the default behavior) or just some of them (using a projection expression). The\n number will also be the same whether or not you use a FilterExpression.\n

\n \n

\n Query results are always sorted by the sort key value. If the data type of\n the sort key is Number, the results are returned in numeric order; otherwise, the\n results are returned in order of UTF-8 bytes. By default, the sort order is ascending.\n To reverse the order, set the ScanIndexForward parameter to false.

\n

A single Query operation will read up to the maximum number of items set\n (if using the Limit parameter) or a maximum of 1 MB of data and then apply\n any filtering to the results using FilterExpression. If\n LastEvaluatedKey is present in the response, you will need to paginate\n the result set. For more information, see Paginating\n the Results in the Amazon DynamoDB Developer Guide.

\n

\n FilterExpression is applied after a Query finishes, but before\n the results are returned. A FilterExpression cannot contain partition key\n or sort key attributes. You need to specify those attributes in the\n KeyConditionExpression.

\n \n

A Query operation can return an empty result set and a\n LastEvaluatedKey if all the items read for the page of results are\n filtered out.

\n \n

You can query a table, a local secondary index, or a global secondary index. For a\n query on a table or on a local secondary index, you can set the\n ConsistentRead parameter to true and obtain a strongly\n consistent result. Global secondary indexes support eventually consistent reads only, so\n do not specify ConsistentRead when querying a global secondary\n index.

", + "smithy.api#examples": [ + { + "title": "To query an item", + "documentation": "This example queries items in the Music table. The table has a partition key and sort key (Artist and SongTitle), but this query only specifies the partition key value. It returns song titles by the artist named \"No One You Know\".", + "input": { + "TableName": "Music", + "ProjectionExpression": "SongTitle", + "KeyConditionExpression": "Artist = :v1", + "ExpressionAttributeValues": { + ":v1": { + "S": "No One You Know" + } + } + }, + "output": { + "Count": 2, + "Items": [ + { + "SongTitle": { + "S": "Call Me Today" + } + } + ], + "ScannedCount": 2, + "ConsumedCapacity": {} + } + } + ], + "smithy.api#paginated": { + "inputToken": "ExclusiveStartKey", + "outputToken": "LastEvaluatedKey", + "items": "Items", + "pageSize": "Limit" + }, + "smithy.api#suppress": [ + "PaginatedTrait" + ] + } + }, + "com.amazonaws.dynamodb#QueryInput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The name of the table containing the requested items. You can also provide the\n Amazon Resource Name (ARN) of the table in this parameter.

", + "smithy.api#required": {} + } + }, + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The name of an index to query. This index can be any local secondary index or global\n secondary index on the table. Note that if you use the IndexName parameter,\n you must also provide TableName.\n

" + } + }, + "Select": { + "target": "com.amazonaws.dynamodb#Select", + "traits": { + "smithy.api#documentation": "

The attributes to be returned in the result. You can retrieve all item attributes,\n specific item attributes, the count of matching items, or in the case of an index, some\n or all of the attributes projected into the index.

\n \n

If neither Select nor ProjectionExpression are specified,\n DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and\n ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both\n Select and ProjectionExpression together in a single\n request, unless the value for Select is SPECIFIC_ATTRIBUTES.\n (This usage is equivalent to specifying ProjectionExpression without any\n value for Select.)

\n \n

If you use the ProjectionExpression parameter, then the value for\n Select can only be SPECIFIC_ATTRIBUTES. Any other\n value for Select will return an error.

\n " + } + }, + "AttributesToGet": { + "target": "com.amazonaws.dynamodb#AttributeNameList", + "traits": { + "smithy.api#documentation": "

This is a legacy parameter. Use ProjectionExpression instead. For more\n information, see AttributesToGet in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "Limit": { + "target": "com.amazonaws.dynamodb#PositiveIntegerObject", + "traits": { + "smithy.api#documentation": "

The maximum number of items to evaluate (not necessarily the number of matching\n items). If DynamoDB processes the number of items up to the limit while processing the\n results, it stops the operation and returns the matching values up to that point, and a\n key in LastEvaluatedKey to apply in a subsequent operation, so that you can\n pick up where you left off. Also, if the processed dataset size exceeds 1 MB before\n DynamoDB reaches this limit, it stops the operation and returns the matching values up\n to the limit, and a key in LastEvaluatedKey to apply in a subsequent\n operation to continue the operation. For more information, see Query and Scan in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ConsistentRead": { + "target": "com.amazonaws.dynamodb#ConsistentRead", + "traits": { + "smithy.api#documentation": "

Determines the read consistency model: If set to true, then the operation\n uses strongly consistent reads; otherwise, the operation uses eventually consistent\n reads.

\n

Strongly consistent reads are not supported on global secondary indexes. If you query\n a global secondary index with ConsistentRead set to true, you\n will receive a ValidationException.

" + } + }, + "KeyConditions": { + "target": "com.amazonaws.dynamodb#KeyConditions", + "traits": { + "smithy.api#documentation": "

This is a legacy parameter. Use KeyConditionExpression instead. For more\n information, see KeyConditions in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "QueryFilter": { + "target": "com.amazonaws.dynamodb#FilterConditionMap", + "traits": { + "smithy.api#documentation": "

This is a legacy parameter. Use FilterExpression instead. For more\n information, see QueryFilter in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ConditionalOperator": { + "target": "com.amazonaws.dynamodb#ConditionalOperator", + "traits": { + "smithy.api#documentation": "

This is a legacy parameter. Use FilterExpression instead. For more\n information, see ConditionalOperator in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ScanIndexForward": { + "target": "com.amazonaws.dynamodb#BooleanObject", + "traits": { + "smithy.api#documentation": "

Specifies the order for index traversal: If true (default), the traversal\n is performed in ascending order; if false, the traversal is performed in\n descending order.

\n

Items with the same partition key value are stored in sorted order by sort key. If the\n sort key data type is Number, the results are stored in numeric order. For type String,\n the results are stored in order of UTF-8 bytes. For type Binary, DynamoDB treats each\n byte of the binary data as unsigned.

\n

If ScanIndexForward is true, DynamoDB returns the results in\n the order in which they are stored (by sort key value). This is the default behavior. If\n ScanIndexForward is false, DynamoDB reads the results in\n reverse order by sort key value, and then returns the results to the client.

" + } + }, + "ExclusiveStartKey": { + "target": "com.amazonaws.dynamodb#Key", + "traits": { + "smithy.api#documentation": "

The primary key of the first item that this operation will evaluate. Use the value\n that was returned for LastEvaluatedKey in the previous operation.

\n

The data type for ExclusiveStartKey must be String, Number, or Binary. No\n set data types are allowed.

" + } + }, + "ReturnConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ReturnConsumedCapacity" + }, + "ProjectionExpression": { + "target": "com.amazonaws.dynamodb#ProjectionExpression", + "traits": { + "smithy.api#documentation": "

A string that identifies one or more attributes to retrieve from the table. These\n attributes can include scalars, sets, or elements of a JSON document. The attributes in\n the expression must be separated by commas.

\n

If no attribute names are specified, then all attributes will be returned. If any of\n the requested attributes are not found, they will not appear in the result.

\n

For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "FilterExpression": { + "target": "com.amazonaws.dynamodb#ConditionExpression", + "traits": { + "smithy.api#documentation": "

A string that contains conditions that DynamoDB applies after the Query\n operation, but before the data is returned to you. Items that do not satisfy the\n FilterExpression criteria are not returned.

\n

A FilterExpression does not allow key attributes. You cannot define a\n filter expression based on a partition key or a sort key.

\n \n

A FilterExpression is applied after the items have already been read;\n the process of filtering does not consume any additional read capacity units.

\n \n

For more information, see Filter\n Expressions in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "KeyConditionExpression": { + "target": "com.amazonaws.dynamodb#KeyExpression", + "traits": { + "smithy.api#documentation": "

The condition that specifies the key values for items to be retrieved by the\n Query action.

\n

The condition must perform an equality test on a single partition key value.

\n

The condition can optionally perform one of several comparison tests on a single sort\n key value. This allows Query to retrieve one item with a given partition\n key value and sort key value, or several items that have the same partition key value\n but different sort key values.

\n

The partition key equality test is required, and must be specified in the following\n format:

\n

\n partitionKeyName\n =\n :partitionkeyval\n

\n

If you also want to provide a condition for the sort key, it must be combined using\n AND with the condition for the sort key. Following is an example, using\n the = comparison operator for the sort key:

\n

\n partitionKeyName\n =\n :partitionkeyval\n AND\n sortKeyName\n =\n :sortkeyval\n

\n

Valid comparisons for the sort key condition are as follows:

\n \n

Use the ExpressionAttributeValues parameter to replace tokens such as\n :partitionval and :sortval with actual values at\n runtime.

\n

You can optionally use the ExpressionAttributeNames parameter to replace\n the names of the partition key and sort key with placeholder tokens. This option might\n be necessary if an attribute name conflicts with a DynamoDB reserved word. For example,\n the following KeyConditionExpression parameter causes an error because\n Size is a reserved word:

\n \n

To work around this, define a placeholder (such a #S) to represent the\n attribute name Size. KeyConditionExpression then is as\n follows:

\n \n

For a list of reserved words, see Reserved Words\n in the Amazon DynamoDB Developer Guide.

\n

For more information on ExpressionAttributeNames and\n ExpressionAttributeValues, see Using\n Placeholders for Attribute Names and Values in the Amazon DynamoDB\n Developer Guide.

" + } + }, + "ExpressionAttributeNames": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", + "traits": { + "smithy.api#documentation": "

One or more substitution tokens for attribute names in an expression. The following\n are some use cases for using ExpressionAttributeNames:

\n \n

Use the # character in an expression to dereference\n an attribute name. For example, consider the following attribute name:

\n \n

The name of this attribute conflicts with a reserved word, so it cannot be used\n directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer\n Guide). To work around this, you could specify the following for\n ExpressionAttributeNames:

\n \n

You could then use this substitution in an expression, as in this example:

\n \n \n

Tokens that begin with the : character are\n expression attribute values, which are placeholders for the\n actual value at runtime.

\n \n

For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ExpressionAttributeValues": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeValueMap", + "traits": { + "smithy.api#documentation": "

One or more values that can be substituted in an expression.

\n

Use the : (colon) character in an expression to\n dereference an attribute value. For example, suppose that you wanted to check whether\n the value of the ProductStatus attribute was one of the following:

\n

\n Available | Backordered | Discontinued\n

\n

You would first need to specify ExpressionAttributeValues as\n follows:

\n

\n { \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"},\n \":disc\":{\"S\":\"Discontinued\"} }\n

\n

You could then use these values in an expression, such as this:

\n

\n ProductStatus IN (:avail, :back, :disc)\n

\n

For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer\n Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a Query operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#QueryOutput": { + "type": "structure", + "members": { + "Items": { + "target": "com.amazonaws.dynamodb#ItemList", + "traits": { + "smithy.api#documentation": "

An array of item attributes that match the query criteria. Each element in this array\n consists of an attribute name and the value for that attribute.

" + } + }, + "Count": { + "target": "com.amazonaws.dynamodb#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of items in the response.

\n

If you used a QueryFilter in the request, then Count is the\n number of items returned after the filter was applied, and ScannedCount is\n the number of matching items before the filter was applied.

\n

If you did not use a filter in the request, then Count and\n ScannedCount are the same.

" + } + }, + "ScannedCount": { + "target": "com.amazonaws.dynamodb#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of items evaluated, before any QueryFilter is applied. A high\n ScannedCount value with few, or no, Count results\n indicates an inefficient Query operation. For more information, see Count and\n ScannedCount in the Amazon DynamoDB Developer\n Guide.

\n

If you did not use a filter in the request, then ScannedCount is the same\n as Count.

" + } + }, + "LastEvaluatedKey": { + "target": "com.amazonaws.dynamodb#Key", + "traits": { + "smithy.api#documentation": "

The primary key of the item where the operation stopped, inclusive of the previous\n result set. Use this value to start a new operation, excluding this value in the new\n request.

\n

If LastEvaluatedKey is empty, then the \"last page\" of results has been\n processed and there is no more data to be retrieved.

\n

If LastEvaluatedKey is not empty, it does not necessarily mean that there\n is more data in the result set. The only way to know when you have reached the end of\n the result set is when LastEvaluatedKey is empty.

" + } + }, + "ConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ConsumedCapacity", + "traits": { + "smithy.api#documentation": "

The capacity units consumed by the Query operation. The data returned\n includes the total provisioned throughput consumed, along with statistics for the table\n and any indexes involved in the operation. ConsumedCapacity is only\n returned if the ReturnConsumedCapacity parameter was specified. For more\n information, see Capacity unit consumption for read operations in the Amazon\n DynamoDB Developer Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a Query operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#RecoveryPeriodInDays": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 35 + } + } + }, + "com.amazonaws.dynamodb#RegionName": { + "type": "string" + }, + "com.amazonaws.dynamodb#Replica": { + "type": "structure", + "members": { + "RegionName": { + "target": "com.amazonaws.dynamodb#RegionName", + "traits": { + "smithy.api#documentation": "

The Region where the replica needs to be created.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the properties of a replica.

" + } + }, + "com.amazonaws.dynamodb#ReplicaAlreadyExistsException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The specified replica is already part of the global table.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#ReplicaAutoScalingDescription": { + "type": "structure", + "members": { + "RegionName": { + "target": "com.amazonaws.dynamodb#RegionName", + "traits": { + "smithy.api#documentation": "

The Region where the replica exists.

" + } + }, + "GlobalSecondaryIndexes": { + "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexAutoScalingDescriptionList", + "traits": { + "smithy.api#documentation": "

Replica-specific global secondary index auto scaling settings.

" + } + }, + "ReplicaProvisionedReadCapacityAutoScalingSettings": { + "target": "com.amazonaws.dynamodb#AutoScalingSettingsDescription" + }, + "ReplicaProvisionedWriteCapacityAutoScalingSettings": { + "target": "com.amazonaws.dynamodb#AutoScalingSettingsDescription" + }, + "ReplicaStatus": { + "target": "com.amazonaws.dynamodb#ReplicaStatus", + "traits": { + "smithy.api#documentation": "

The current state of the replica:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the auto scaling settings of the replica.

" + } + }, + "com.amazonaws.dynamodb#ReplicaAutoScalingDescriptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ReplicaAutoScalingDescription" + } + }, + "com.amazonaws.dynamodb#ReplicaAutoScalingUpdate": { + "type": "structure", + "members": { + "RegionName": { + "target": "com.amazonaws.dynamodb#RegionName", + "traits": { + "smithy.api#documentation": "

The Region where the replica exists.

", + "smithy.api#required": {} + } + }, + "ReplicaGlobalSecondaryIndexUpdates": { + "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexAutoScalingUpdateList", + "traits": { + "smithy.api#documentation": "

Represents the auto scaling settings of global secondary indexes that will be\n modified.

" + } + }, + "ReplicaProvisionedReadCapacityAutoScalingUpdate": { + "target": "com.amazonaws.dynamodb#AutoScalingSettingsUpdate" + } + }, + "traits": { + "smithy.api#documentation": "

Represents the auto scaling settings of a replica that will be modified.

" + } + }, + "com.amazonaws.dynamodb#ReplicaAutoScalingUpdateList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ReplicaAutoScalingUpdate" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.dynamodb#ReplicaDescription": { + "type": "structure", + "members": { + "RegionName": { + "target": "com.amazonaws.dynamodb#RegionName", + "traits": { + "smithy.api#documentation": "

The name of the Region.

" + } + }, + "ReplicaStatus": { + "target": "com.amazonaws.dynamodb#ReplicaStatus", + "traits": { + "smithy.api#documentation": "

The current state of the replica:

\n " + } + }, + "ReplicaStatusDescription": { + "target": "com.amazonaws.dynamodb#ReplicaStatusDescription", + "traits": { + "smithy.api#documentation": "

Detailed information about the replica status.

" + } + }, + "ReplicaStatusPercentProgress": { + "target": "com.amazonaws.dynamodb#ReplicaStatusPercentProgress", + "traits": { + "smithy.api#documentation": "

Specifies the progress of a Create, Update, or Delete action on the replica as a\n percentage.

" + } + }, + "KMSMasterKeyId": { + "target": "com.amazonaws.dynamodb#KMSMasterKeyId", + "traits": { + "smithy.api#documentation": "

The KMS key of the replica that will be used for KMS\n encryption.

" + } + }, + "ProvisionedThroughputOverride": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughputOverride", + "traits": { + "smithy.api#documentation": "

Replica-specific provisioned throughput. If not described, uses the source table's\n provisioned throughput settings.

" + } + }, + "OnDemandThroughputOverride": { + "target": "com.amazonaws.dynamodb#OnDemandThroughputOverride", + "traits": { + "smithy.api#documentation": "

Overrides the maximum on-demand throughput settings for the specified replica\n table.

" + } + }, + "WarmThroughput": { + "target": "com.amazonaws.dynamodb#TableWarmThroughputDescription", + "traits": { + "smithy.api#documentation": "

Represents the warm throughput value for this replica.

" + } + }, + "GlobalSecondaryIndexes": { + "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexDescriptionList", + "traits": { + "smithy.api#documentation": "

Replica-specific global secondary index settings.

" + } + }, + "ReplicaInaccessibleDateTime": { + "target": "com.amazonaws.dynamodb#Date", + "traits": { + "smithy.api#documentation": "

The time at which the replica was first detected as inaccessible. To determine cause\n of inaccessibility check the ReplicaStatus property.

" + } + }, + "ReplicaTableClassSummary": { + "target": "com.amazonaws.dynamodb#TableClassSummary" + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details of the replica.

" + } + }, + "com.amazonaws.dynamodb#ReplicaDescriptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ReplicaDescription" + } + }, + "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndex": { + "type": "structure", + "members": { + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the global secondary index.

", + "smithy.api#required": {} + } + }, + "ProvisionedThroughputOverride": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughputOverride", + "traits": { + "smithy.api#documentation": "

Replica table GSI-specific provisioned throughput. If not specified, uses the source\n table GSI's read capacity settings.

" + } + }, + "OnDemandThroughputOverride": { + "target": "com.amazonaws.dynamodb#OnDemandThroughputOverride", + "traits": { + "smithy.api#documentation": "

Overrides the maximum on-demand throughput settings for the specified global secondary\n index in the specified replica table.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the properties of a replica global secondary index.

" + } + }, + "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexAutoScalingDescription": { + "type": "structure", + "members": { + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the global secondary index.

" + } + }, + "IndexStatus": { + "target": "com.amazonaws.dynamodb#IndexStatus", + "traits": { + "smithy.api#documentation": "

The current state of the replica global secondary index:

\n " + } + }, + "ProvisionedReadCapacityAutoScalingSettings": { + "target": "com.amazonaws.dynamodb#AutoScalingSettingsDescription" + }, + "ProvisionedWriteCapacityAutoScalingSettings": { + "target": "com.amazonaws.dynamodb#AutoScalingSettingsDescription" + } + }, + "traits": { + "smithy.api#documentation": "

Represents the auto scaling configuration for a replica global secondary index.

" + } + }, + "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexAutoScalingDescriptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexAutoScalingDescription" + } + }, + "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexAutoScalingUpdate": { + "type": "structure", + "members": { + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the global secondary index.

" + } + }, + "ProvisionedReadCapacityAutoScalingUpdate": { + "target": "com.amazonaws.dynamodb#AutoScalingSettingsUpdate" + } + }, + "traits": { + "smithy.api#documentation": "

Represents the auto scaling settings of a global secondary index for a replica that\n will be modified.

" + } + }, + "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexAutoScalingUpdateList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexAutoScalingUpdate" + } + }, + "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexDescription": { + "type": "structure", + "members": { + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the global secondary index.

" + } + }, + "ProvisionedThroughputOverride": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughputOverride", + "traits": { + "smithy.api#documentation": "

If not described, uses the source table GSI's read capacity settings.

" + } + }, + "OnDemandThroughputOverride": { + "target": "com.amazonaws.dynamodb#OnDemandThroughputOverride", + "traits": { + "smithy.api#documentation": "

Overrides the maximum on-demand throughput for the specified global secondary index in\n the specified replica table.

" + } + }, + "WarmThroughput": { + "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexWarmThroughputDescription", + "traits": { + "smithy.api#documentation": "

Represents the warm throughput of the global secondary index for this replica.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the properties of a replica global secondary index.

" + } + }, + "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexDescriptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexDescription" + } + }, + "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndex" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexSettingsDescription": { + "type": "structure", + "members": { + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the global secondary index. The name must be unique among all other\n indexes on this table.

", + "smithy.api#required": {} + } + }, + "IndexStatus": { + "target": "com.amazonaws.dynamodb#IndexStatus", + "traits": { + "smithy.api#documentation": "

The current status of the global secondary index:

\n " + } + }, + "ProvisionedReadCapacityUnits": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

The maximum number of strongly consistent reads consumed per second before DynamoDB\n returns a ThrottlingException.

" + } + }, + "ProvisionedReadCapacityAutoScalingSettings": { + "target": "com.amazonaws.dynamodb#AutoScalingSettingsDescription", + "traits": { + "smithy.api#documentation": "

Auto scaling settings for a global secondary index replica's read capacity\n units.

" + } + }, + "ProvisionedWriteCapacityUnits": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

The maximum number of writes consumed per second before DynamoDB returns a\n ThrottlingException.

" + } + }, + "ProvisionedWriteCapacityAutoScalingSettings": { + "target": "com.amazonaws.dynamodb#AutoScalingSettingsDescription", + "traits": { + "smithy.api#documentation": "

Auto scaling settings for a global secondary index replica's write capacity\n units.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the properties of a global secondary index.

" + } + }, + "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexSettingsDescriptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexSettingsDescription" + } + }, + "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexSettingsUpdate": { + "type": "structure", + "members": { + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the global secondary index. The name must be unique among all other\n indexes on this table.

", + "smithy.api#required": {} + } + }, + "ProvisionedReadCapacityUnits": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

The maximum number of strongly consistent reads consumed per second before DynamoDB\n returns a ThrottlingException.

" + } + }, + "ProvisionedReadCapacityAutoScalingSettingsUpdate": { + "target": "com.amazonaws.dynamodb#AutoScalingSettingsUpdate", + "traits": { + "smithy.api#documentation": "

Auto scaling settings for managing a global secondary index replica's read capacity\n units.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the settings of a global secondary index for a global table that will be\n modified.

" + } + }, + "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexSettingsUpdateList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexSettingsUpdate" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.dynamodb#ReplicaList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#Replica" + } + }, + "com.amazonaws.dynamodb#ReplicaNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The specified replica is no longer part of the global table.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#ReplicaSettingsDescription": { + "type": "structure", + "members": { + "RegionName": { + "target": "com.amazonaws.dynamodb#RegionName", + "traits": { + "smithy.api#documentation": "

The Region name of the replica.

", + "smithy.api#required": {} + } + }, + "ReplicaStatus": { + "target": "com.amazonaws.dynamodb#ReplicaStatus", + "traits": { + "smithy.api#documentation": "

The current state of the Region:

\n " + } + }, + "ReplicaBillingModeSummary": { + "target": "com.amazonaws.dynamodb#BillingModeSummary", + "traits": { + "smithy.api#documentation": "

The read/write capacity mode of the replica.

" + } + }, + "ReplicaProvisionedReadCapacityUnits": { + "target": "com.amazonaws.dynamodb#NonNegativeLongObject", + "traits": { + "smithy.api#documentation": "

The maximum number of strongly consistent reads consumed per second before DynamoDB\n returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB\n Developer Guide.

" + } + }, + "ReplicaProvisionedReadCapacityAutoScalingSettings": { + "target": "com.amazonaws.dynamodb#AutoScalingSettingsDescription", + "traits": { + "smithy.api#documentation": "

Auto scaling settings for a global table replica's read capacity units.

" + } + }, + "ReplicaProvisionedWriteCapacityUnits": { + "target": "com.amazonaws.dynamodb#NonNegativeLongObject", + "traits": { + "smithy.api#documentation": "

The maximum number of writes consumed per second before DynamoDB returns a\n ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB\n Developer Guide.

" + } + }, + "ReplicaProvisionedWriteCapacityAutoScalingSettings": { + "target": "com.amazonaws.dynamodb#AutoScalingSettingsDescription", + "traits": { + "smithy.api#documentation": "

Auto scaling settings for a global table replica's write capacity units.

" + } + }, + "ReplicaGlobalSecondaryIndexSettings": { + "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexSettingsDescriptionList", + "traits": { + "smithy.api#documentation": "

Replica global secondary index settings for the global table.

" + } + }, + "ReplicaTableClassSummary": { + "target": "com.amazonaws.dynamodb#TableClassSummary" + } + }, + "traits": { + "smithy.api#documentation": "

Represents the properties of a replica.

" + } + }, + "com.amazonaws.dynamodb#ReplicaSettingsDescriptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ReplicaSettingsDescription" + } + }, + "com.amazonaws.dynamodb#ReplicaSettingsUpdate": { + "type": "structure", + "members": { + "RegionName": { + "target": "com.amazonaws.dynamodb#RegionName", + "traits": { + "smithy.api#documentation": "

The Region of the replica to be added.

", + "smithy.api#required": {} + } + }, + "ReplicaProvisionedReadCapacityUnits": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

The maximum number of strongly consistent reads consumed per second before DynamoDB\n returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB\n Developer Guide.

" + } + }, + "ReplicaProvisionedReadCapacityAutoScalingSettingsUpdate": { + "target": "com.amazonaws.dynamodb#AutoScalingSettingsUpdate", + "traits": { + "smithy.api#documentation": "

Auto scaling settings for managing a global table replica's read capacity\n units.

" + } + }, + "ReplicaGlobalSecondaryIndexSettingsUpdate": { + "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexSettingsUpdateList", + "traits": { + "smithy.api#documentation": "

Represents the settings of a global secondary index for a global table that will be\n modified.

" + } + }, + "ReplicaTableClass": { + "target": "com.amazonaws.dynamodb#TableClass", + "traits": { + "smithy.api#documentation": "

Replica-specific table class. If not specified, uses the source table's table\n class.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the settings for a global table in a Region that will be modified.

" + } + }, + "com.amazonaws.dynamodb#ReplicaSettingsUpdateList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ReplicaSettingsUpdate" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.dynamodb#ReplicaStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "CREATION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_FAILED" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "REGION_DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REGION_DISABLED" + } + }, + "INACCESSIBLE_ENCRYPTION_CREDENTIALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACCESSIBLE_ENCRYPTION_CREDENTIALS" + } + } + } + }, + "com.amazonaws.dynamodb#ReplicaStatusDescription": { + "type": "string" + }, + "com.amazonaws.dynamodb#ReplicaStatusPercentProgress": { + "type": "string" + }, + "com.amazonaws.dynamodb#ReplicaUpdate": { + "type": "structure", + "members": { + "Create": { + "target": "com.amazonaws.dynamodb#CreateReplicaAction", + "traits": { + "smithy.api#documentation": "

The parameters required for creating a replica on an existing global table.

" + } + }, + "Delete": { + "target": "com.amazonaws.dynamodb#DeleteReplicaAction", + "traits": { + "smithy.api#documentation": "

The name of the existing replica to be removed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents one of the following:

\n " + } + }, + "com.amazonaws.dynamodb#ReplicaUpdateList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ReplicaUpdate" + } + }, + "com.amazonaws.dynamodb#ReplicatedWriteConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The request was rejected because one or more items in the request are being modified by a request in another Region.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#ReplicationGroupUpdate": { + "type": "structure", + "members": { + "Create": { + "target": "com.amazonaws.dynamodb#CreateReplicationGroupMemberAction", + "traits": { + "smithy.api#documentation": "

The parameters required for creating a replica for the table.

" + } + }, + "Update": { + "target": "com.amazonaws.dynamodb#UpdateReplicationGroupMemberAction", + "traits": { + "smithy.api#documentation": "

The parameters required for updating a replica for the table.

" + } + }, + "Delete": { + "target": "com.amazonaws.dynamodb#DeleteReplicationGroupMemberAction", + "traits": { + "smithy.api#documentation": "

The parameters required for deleting a replica for the table.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents one of the following:

\n \n \n

When you manually remove a table or global table replica, you do not automatically\n remove any associated scalable targets, scaling policies, or CloudWatch\n alarms.

\n " + } + }, + "com.amazonaws.dynamodb#ReplicationGroupUpdateList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ReplicationGroupUpdate" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.dynamodb#RequestLimitExceeded": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

Throughput exceeds the current throughput quota for your account. Please contact\n Amazon Web Services Support to request a\n quota increase.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#ResourceArnString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1283 + } + } + }, + "com.amazonaws.dynamodb#ResourceInUseException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The resource which is being attempted to be changed is in use.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The operation conflicts with the resource's availability. For example:

\n \n

When appropriate, wait for the ongoing update to complete and attempt the request again.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The resource which is being requested does not exist.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The operation tried to access a nonexistent table or index. The resource might not\n be specified correctly, or its status might not be ACTIVE.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#ResourcePolicy": { + "type": "string" + }, + "com.amazonaws.dynamodb#RestoreInProgress": { + "type": "boolean" + }, + "com.amazonaws.dynamodb#RestoreSummary": { + "type": "structure", + "members": { + "SourceBackupArn": { + "target": "com.amazonaws.dynamodb#BackupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the backup from which the table was restored.

" + } + }, + "SourceTableArn": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The ARN of the source table of the backup that is being restored.

" + } + }, + "RestoreDateTime": { + "target": "com.amazonaws.dynamodb#Date", + "traits": { + "smithy.api#documentation": "

Point in time or source backup time.

", + "smithy.api#required": {} + } + }, + "RestoreInProgress": { + "target": "com.amazonaws.dynamodb#RestoreInProgress", + "traits": { + "smithy.api#documentation": "

Indicates if a restore is in progress or not.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details for the restore.

" + } + }, + "com.amazonaws.dynamodb#RestoreTableFromBackup": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#RestoreTableFromBackupInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#RestoreTableFromBackupOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#BackupInUseException" + }, + { + "target": "com.amazonaws.dynamodb#BackupNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#TableAlreadyExistsException" + }, + { + "target": "com.amazonaws.dynamodb#TableInUseException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Creates a new table from an existing backup. Any number of users can execute up to 50\n concurrent restores (any type of restore) in a given account.

\n

You can call RestoreTableFromBackup at a maximum rate of 10 times per\n second.

\n

You must manually set up the following on the restored table:

\n " + } + }, + "com.amazonaws.dynamodb#RestoreTableFromBackupInput": { + "type": "structure", + "members": { + "TargetTableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The name of the new table to which the backup must be restored.

", + "smithy.api#required": {} + } + }, + "BackupArn": { + "target": "com.amazonaws.dynamodb#BackupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the backup.

", + "smithy.api#required": {} + } + }, + "BillingModeOverride": { + "target": "com.amazonaws.dynamodb#BillingMode", + "traits": { + "smithy.api#documentation": "

The billing mode of the restored table.

" + } + }, + "GlobalSecondaryIndexOverride": { + "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexList", + "traits": { + "smithy.api#documentation": "

List of global secondary indexes for the restored table. The indexes provided should\n match existing secondary indexes. You can choose to exclude some or all of the indexes\n at the time of restore.

" + } + }, + "LocalSecondaryIndexOverride": { + "target": "com.amazonaws.dynamodb#LocalSecondaryIndexList", + "traits": { + "smithy.api#documentation": "

List of local secondary indexes for the restored table. The indexes provided should\n match existing secondary indexes. You can choose to exclude some or all of the indexes\n at the time of restore.

" + } + }, + "ProvisionedThroughputOverride": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughput", + "traits": { + "smithy.api#documentation": "

Provisioned throughput settings for the restored table.

" + } + }, + "OnDemandThroughputOverride": { + "target": "com.amazonaws.dynamodb#OnDemandThroughput" + }, + "SSESpecificationOverride": { + "target": "com.amazonaws.dynamodb#SSESpecification", + "traits": { + "smithy.api#documentation": "

The new server-side encryption settings for the restored table.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#RestoreTableFromBackupOutput": { + "type": "structure", + "members": { + "TableDescription": { + "target": "com.amazonaws.dynamodb#TableDescription", + "traits": { + "smithy.api#documentation": "

The description of the table created from an existing backup.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#RestoreTableToPointInTime": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#RestoreTableToPointInTimeInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#RestoreTableToPointInTimeOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#InvalidRestoreTimeException" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#PointInTimeRecoveryUnavailableException" + }, + { + "target": "com.amazonaws.dynamodb#TableAlreadyExistsException" + }, + { + "target": "com.amazonaws.dynamodb#TableInUseException" + }, + { + "target": "com.amazonaws.dynamodb#TableNotFoundException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Restores the specified table to the specified point in time within\n EarliestRestorableDateTime and LatestRestorableDateTime.\n You can restore your table to any point in time in the last 35 days. You can set the recovery period to any value between 1 and 35 days. Any number of\n users can execute up to 50 concurrent restores (any type of restore) in a given account.

\n

When you restore using point in time recovery, DynamoDB restores your table data to\n the state based on the selected date and time (day:hour:minute:second) to a new table.

\n

Along with data, the following are also included on the new restored table using point\n in time recovery:

\n \n

You must manually set up the following on the restored table:

\n " + } + }, + "com.amazonaws.dynamodb#RestoreTableToPointInTimeInput": { + "type": "structure", + "members": { + "SourceTableArn": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The DynamoDB table that will be restored. This value is an Amazon Resource Name\n (ARN).

" + } + }, + "SourceTableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

Name of the source table that is being restored.

" + } + }, + "TargetTableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The name of the new table to which it must be restored to.

", + "smithy.api#required": {} + } + }, + "UseLatestRestorableTime": { + "target": "com.amazonaws.dynamodb#BooleanObject", + "traits": { + "smithy.api#documentation": "

Restore the table to the latest possible time. LatestRestorableDateTime\n is typically 5 minutes before the current time.

" + } + }, + "RestoreDateTime": { + "target": "com.amazonaws.dynamodb#Date", + "traits": { + "smithy.api#documentation": "

Time in the past to restore the table to.

" + } + }, + "BillingModeOverride": { + "target": "com.amazonaws.dynamodb#BillingMode", + "traits": { + "smithy.api#documentation": "

The billing mode of the restored table.

" + } + }, + "GlobalSecondaryIndexOverride": { + "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexList", + "traits": { + "smithy.api#documentation": "

List of global secondary indexes for the restored table. The indexes provided should\n match existing secondary indexes. You can choose to exclude some or all of the indexes\n at the time of restore.

" + } + }, + "LocalSecondaryIndexOverride": { + "target": "com.amazonaws.dynamodb#LocalSecondaryIndexList", + "traits": { + "smithy.api#documentation": "

List of local secondary indexes for the restored table. The indexes provided should\n match existing secondary indexes. You can choose to exclude some or all of the indexes\n at the time of restore.

" + } + }, + "ProvisionedThroughputOverride": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughput", + "traits": { + "smithy.api#documentation": "

Provisioned throughput settings for the restored table.

" + } + }, + "OnDemandThroughputOverride": { + "target": "com.amazonaws.dynamodb#OnDemandThroughput" + }, + "SSESpecificationOverride": { + "target": "com.amazonaws.dynamodb#SSESpecification", + "traits": { + "smithy.api#documentation": "

The new server-side encryption settings for the restored table.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#RestoreTableToPointInTimeOutput": { + "type": "structure", + "members": { + "TableDescription": { + "target": "com.amazonaws.dynamodb#TableDescription", + "traits": { + "smithy.api#documentation": "

Represents the properties of a table.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#ReturnConsumedCapacity": { + "type": "enum", + "members": { + "INDEXES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INDEXES" + } + }, + "TOTAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOTAL" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + }, + "traits": { + "smithy.api#documentation": "

Determines the level of detail about either provisioned or on-demand throughput\n consumption that is returned in the response:

\n " + } + }, + "com.amazonaws.dynamodb#ReturnItemCollectionMetrics": { + "type": "enum", + "members": { + "SIZE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SIZE" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, + "com.amazonaws.dynamodb#ReturnValue": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "ALL_OLD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL_OLD" + } + }, + "UPDATED_OLD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATED_OLD" + } + }, + "ALL_NEW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL_NEW" + } + }, + "UPDATED_NEW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATED_NEW" + } + } + } + }, + "com.amazonaws.dynamodb#ReturnValuesOnConditionCheckFailure": { + "type": "enum", + "members": { + "ALL_OLD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL_OLD" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, + "com.amazonaws.dynamodb#S3Bucket": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": "^[a-z0-9A-Z]+[\\.\\-\\w]*[a-z0-9A-Z]+$" + } + }, + "com.amazonaws.dynamodb#S3BucketOwner": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9]{12}$" + } + }, + "com.amazonaws.dynamodb#S3BucketSource": { + "type": "structure", + "members": { + "S3BucketOwner": { + "target": "com.amazonaws.dynamodb#S3BucketOwner", + "traits": { + "smithy.api#documentation": "

The account number of the S3 bucket that is being imported from. If the bucket is\n owned by the requester this is optional.

" + } + }, + "S3Bucket": { + "target": "com.amazonaws.dynamodb#S3Bucket", + "traits": { + "smithy.api#documentation": "

The S3 bucket that is being imported from.

", + "smithy.api#required": {} + } + }, + "S3KeyPrefix": { + "target": "com.amazonaws.dynamodb#S3Prefix", + "traits": { + "smithy.api#documentation": "

The key prefix shared by all S3 Objects that are being imported.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The S3 bucket that is being imported from.

" + } + }, + "com.amazonaws.dynamodb#S3Prefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.dynamodb#S3SseAlgorithm": { + "type": "enum", + "members": { + "AES256": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AES256" + } + }, + "KMS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KMS" + } + } + } + }, + "com.amazonaws.dynamodb#S3SseKmsKeyId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.dynamodb#SSEDescription": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.dynamodb#SSEStatus", + "traits": { + "smithy.api#documentation": "

Represents the current state of server-side encryption. The only supported values\n are:

\n " + } + }, + "SSEType": { + "target": "com.amazonaws.dynamodb#SSEType", + "traits": { + "smithy.api#documentation": "

Server-side encryption type. The only supported value is:

\n " + } + }, + "KMSMasterKeyArn": { + "target": "com.amazonaws.dynamodb#KMSMasterKeyArn", + "traits": { + "smithy.api#documentation": "

The KMS key ARN used for the KMS encryption.

" + } + }, + "InaccessibleEncryptionDateTime": { + "target": "com.amazonaws.dynamodb#Date", + "traits": { + "smithy.api#documentation": "

Indicates the time, in UNIX epoch date format, when DynamoDB detected that\n the table's KMS key was inaccessible. This attribute will automatically\n be cleared when DynamoDB detects that the table's KMS key is accessible\n again. DynamoDB will initiate the table archival process when table's KMS key remains inaccessible for more than seven days from this date.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The description of the server-side encryption status on the specified table.

" + } + }, + "com.amazonaws.dynamodb#SSEEnabled": { + "type": "boolean" + }, + "com.amazonaws.dynamodb#SSESpecification": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.dynamodb#SSEEnabled", + "traits": { + "smithy.api#documentation": "

Indicates whether server-side encryption is done using an Amazon Web Services managed\n key or an Amazon Web Services owned key. If enabled (true), server-side encryption type\n is set to KMS and an Amazon Web Services managed key is used (KMS charges apply). If disabled (false) or not specified, server-side\n encryption is set to Amazon Web Services owned key.

" + } + }, + "SSEType": { + "target": "com.amazonaws.dynamodb#SSEType", + "traits": { + "smithy.api#documentation": "

Server-side encryption type. The only supported value is:

\n " + } + }, + "KMSMasterKeyId": { + "target": "com.amazonaws.dynamodb#KMSMasterKeyId", + "traits": { + "smithy.api#documentation": "

The KMS key that should be used for the KMS encryption.\n To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN.\n Note that you should only provide this parameter if the key is different from the\n default DynamoDB key alias/aws/dynamodb.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the settings used to enable server-side encryption.

" + } + }, + "com.amazonaws.dynamodb#SSEStatus": { + "type": "enum", + "members": { + "ENABLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLING" + } + }, + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLING" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + } + } + }, + "com.amazonaws.dynamodb#SSEType": { + "type": "enum", + "members": { + "AES256": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AES256" + } + }, + "KMS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KMS" + } + } + } + }, + "com.amazonaws.dynamodb#ScalarAttributeType": { + "type": "enum", + "members": { + "S": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S" + } + }, + "N": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "N" + } + }, + "B": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "B" + } + } + } + }, + "com.amazonaws.dynamodb#Scan": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#ScanInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#ScanOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.dynamodb#RequestLimitExceeded" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

The Scan operation returns one or more items and item attributes by\n accessing every item in a table or a secondary index. To have DynamoDB return fewer\n items, you can provide a FilterExpression operation.

\n

If the total size of scanned items exceeds the maximum dataset size limit of 1 MB, the\n scan completes and results are returned to the user. The LastEvaluatedKey\n value is also returned and the requestor can use the LastEvaluatedKey to\n continue the scan in a subsequent operation. Each scan response also includes number of\n items that were scanned (ScannedCount) as part of the request. If using a\n FilterExpression, a scan result can result in no items meeting the\n criteria and the Count will result in zero. If you did not use a\n FilterExpression in the scan request, then Count is the\n same as ScannedCount.

\n \n

\n Count and ScannedCount only return the count of items\n specific to a single scan request and, unless the table is less than 1MB, do not\n represent the total number of items in the table.

\n \n

A single Scan operation first reads up to the maximum number of items set\n (if using the Limit parameter) or a maximum of 1 MB of data and then\n applies any filtering to the results if a FilterExpression is provided. If\n LastEvaluatedKey is present in the response, pagination is required to\n complete the full table scan. For more information, see Paginating the\n Results in the Amazon DynamoDB Developer Guide.

\n

\n Scan operations proceed sequentially; however, for faster performance on\n a large table or secondary index, applications can request a parallel Scan\n operation by providing the Segment and TotalSegments\n parameters. For more information, see Parallel\n Scan in the Amazon DynamoDB Developer Guide.

\n

By default, a Scan uses eventually consistent reads when accessing the\n items in a table. Therefore, the results from an eventually consistent Scan\n may not include the latest item changes at the time the scan iterates through each item\n in the table. If you require a strongly consistent read of each item as the scan\n iterates through the items in the table, you can set the ConsistentRead\n parameter to true. Strong consistency only relates to the consistency of the read at the\n item level.

\n \n

DynamoDB does not provide snapshot isolation for a scan operation when the\n ConsistentRead parameter is set to true. Thus, a DynamoDB scan\n operation does not guarantee that all reads in a scan see a consistent snapshot of\n the table when the scan operation was requested.

\n ", + "smithy.api#examples": [ + { + "title": "To scan a table", + "documentation": "This example scans the entire Music table, and then narrows the results to songs by the artist \"No One You Know\". For each item, only the album title and song title are returned.", + "input": { + "TableName": "Music", + "FilterExpression": "Artist = :a", + "ProjectionExpression": "#ST, #AT", + "ExpressionAttributeNames": { + "#ST": "SongTitle", + "#AT": "AlbumTitle" + }, + "ExpressionAttributeValues": { + ":a": { + "S": "No One You Know" + } + } + }, + "output": { + "Count": 2, + "Items": [ + { + "SongTitle": { + "S": "Call Me Today" + }, + "AlbumTitle": { + "S": "Somewhat Famous" + } + }, + { + "SongTitle": { + "S": "Scared of My Shadow" + }, + "AlbumTitle": { + "S": "Blue Sky Blues" + } + } + ], + "ScannedCount": 3, + "ConsumedCapacity": {} + } + } + ], + "smithy.api#paginated": { + "inputToken": "ExclusiveStartKey", + "outputToken": "LastEvaluatedKey", + "items": "Items", + "pageSize": "Limit" + }, + "smithy.api#suppress": [ + "PaginatedTrait" + ] + } + }, + "com.amazonaws.dynamodb#ScanInput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The name of the table containing the requested items or if you provide\n IndexName, the name of the table to which that index belongs.

\n

You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

", + "smithy.api#required": {} + } + }, + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The name of a secondary index to scan. This index can be any local secondary index or\n global secondary index. Note that if you use the IndexName parameter, you\n must also provide TableName.

" + } + }, + "AttributesToGet": { + "target": "com.amazonaws.dynamodb#AttributeNameList", + "traits": { + "smithy.api#documentation": "

This is a legacy parameter. Use ProjectionExpression instead. For more\n information, see AttributesToGet in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "Limit": { + "target": "com.amazonaws.dynamodb#PositiveIntegerObject", + "traits": { + "smithy.api#documentation": "

The maximum number of items to evaluate (not necessarily the number of matching\n items). If DynamoDB processes the number of items up to the limit while processing the\n results, it stops the operation and returns the matching values up to that point, and a\n key in LastEvaluatedKey to apply in a subsequent operation, so that you can\n pick up where you left off. Also, if the processed dataset size exceeds 1 MB before\n DynamoDB reaches this limit, it stops the operation and returns the matching values up\n to the limit, and a key in LastEvaluatedKey to apply in a subsequent\n operation to continue the operation. For more information, see Working with Queries in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "Select": { + "target": "com.amazonaws.dynamodb#Select", + "traits": { + "smithy.api#documentation": "

The attributes to be returned in the result. You can retrieve all item attributes,\n specific item attributes, the count of matching items, or in the case of an index, some\n or all of the attributes projected into the index.

\n \n

If neither Select nor ProjectionExpression are specified,\n DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and\n ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both\n Select and ProjectionExpression together in a single\n request, unless the value for Select is SPECIFIC_ATTRIBUTES.\n (This usage is equivalent to specifying ProjectionExpression without any\n value for Select.)

\n \n

If you use the ProjectionExpression parameter, then the value for\n Select can only be SPECIFIC_ATTRIBUTES. Any other\n value for Select will return an error.

\n " + } + }, + "ScanFilter": { + "target": "com.amazonaws.dynamodb#FilterConditionMap", + "traits": { + "smithy.api#documentation": "

This is a legacy parameter. Use FilterExpression instead. For more\n information, see ScanFilter in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ConditionalOperator": { + "target": "com.amazonaws.dynamodb#ConditionalOperator", + "traits": { + "smithy.api#documentation": "

This is a legacy parameter. Use FilterExpression instead. For more\n information, see ConditionalOperator in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ExclusiveStartKey": { + "target": "com.amazonaws.dynamodb#Key", + "traits": { + "smithy.api#documentation": "

The primary key of the first item that this operation will evaluate. Use the value\n that was returned for LastEvaluatedKey in the previous operation.

\n

The data type for ExclusiveStartKey must be String, Number or Binary. No\n set data types are allowed.

\n

In a parallel scan, a Scan request that includes\n ExclusiveStartKey must specify the same segment whose previous\n Scan returned the corresponding value of\n LastEvaluatedKey.

" + } + }, + "ReturnConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ReturnConsumedCapacity" + }, + "TotalSegments": { + "target": "com.amazonaws.dynamodb#ScanTotalSegments", + "traits": { + "smithy.api#documentation": "

For a parallel Scan request, TotalSegments represents the\n total number of segments into which the Scan operation will be divided. The\n value of TotalSegments corresponds to the number of application workers\n that will perform the parallel scan. For example, if you want to use four application\n threads to scan a table or an index, specify a TotalSegments value of\n 4.

\n

The value for TotalSegments must be greater than or equal to 1, and less\n than or equal to 1000000. If you specify a TotalSegments value of 1, the\n Scan operation will be sequential rather than parallel.

\n

If you specify TotalSegments, you must also specify\n Segment.

" + } + }, + "Segment": { + "target": "com.amazonaws.dynamodb#ScanSegment", + "traits": { + "smithy.api#documentation": "

For a parallel Scan request, Segment identifies an\n individual segment to be scanned by an application worker.

\n

Segment IDs are zero-based, so the first segment is always 0. For example, if you want\n to use four application threads to scan a table or an index, then the first thread\n specifies a Segment value of 0, the second thread specifies 1, and so\n on.

\n

The value of LastEvaluatedKey returned from a parallel Scan\n request must be used as ExclusiveStartKey with the same segment ID in a\n subsequent Scan operation.

\n

The value for Segment must be greater than or equal to 0, and less than\n the value provided for TotalSegments.

\n

If you provide Segment, you must also provide\n TotalSegments.

" + } + }, + "ProjectionExpression": { + "target": "com.amazonaws.dynamodb#ProjectionExpression", + "traits": { + "smithy.api#documentation": "

A string that identifies one or more attributes to retrieve from the specified table\n or index. These attributes can include scalars, sets, or elements of a JSON document.\n The attributes in the expression must be separated by commas.

\n

If no attribute names are specified, then all attributes will be returned. If any of\n the requested attributes are not found, they will not appear in the result.

\n

For more information, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "FilterExpression": { + "target": "com.amazonaws.dynamodb#ConditionExpression", + "traits": { + "smithy.api#documentation": "

A string that contains conditions that DynamoDB applies after the Scan\n operation, but before the data is returned to you. Items that do not satisfy the\n FilterExpression criteria are not returned.

\n \n

A FilterExpression is applied after the items have already been read;\n the process of filtering does not consume any additional read capacity units.

\n \n

For more information, see Filter\n Expressions in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ExpressionAttributeNames": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", + "traits": { + "smithy.api#documentation": "

One or more substitution tokens for attribute names in an expression. The following\n are some use cases for using ExpressionAttributeNames:

\n \n

Use the # character in an expression to dereference\n an attribute name. For example, consider the following attribute name:

\n \n

The name of this attribute conflicts with a reserved word, so it cannot be used\n directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer\n Guide). To work around this, you could specify the following for\n ExpressionAttributeNames:

\n \n

You could then use this substitution in an expression, as in this example:

\n \n \n

Tokens that begin with the : character are\n expression attribute values, which are placeholders for the\n actual value at runtime.

\n \n

For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ExpressionAttributeValues": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeValueMap", + "traits": { + "smithy.api#documentation": "

One or more values that can be substituted in an expression.

\n

Use the : (colon) character in an expression to\n dereference an attribute value. For example, suppose that you wanted to check whether\n the value of the ProductStatus attribute was one of the following:

\n

\n Available | Backordered | Discontinued\n

\n

You would first need to specify ExpressionAttributeValues as\n follows:

\n

\n { \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"},\n \":disc\":{\"S\":\"Discontinued\"} }\n

\n

You could then use these values in an expression, such as this:

\n

\n ProductStatus IN (:avail, :back, :disc)\n

\n

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ConsistentRead": { + "target": "com.amazonaws.dynamodb#ConsistentRead", + "traits": { + "smithy.api#documentation": "

A Boolean value that determines the read consistency model during the scan:

\n \n

The default setting for ConsistentRead is false.

\n

The ConsistentRead parameter is not supported on global secondary\n indexes. If you scan a global secondary index with ConsistentRead set to\n true, you will receive a ValidationException.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a Scan operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#ScanOutput": { + "type": "structure", + "members": { + "Items": { + "target": "com.amazonaws.dynamodb#ItemList", + "traits": { + "smithy.api#documentation": "

An array of item attributes that match the scan criteria. Each element in this array\n consists of an attribute name and the value for that attribute.

" + } + }, + "Count": { + "target": "com.amazonaws.dynamodb#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of items in the response.

\n

If you set ScanFilter in the request, then Count is the\n number of items returned after the filter was applied, and ScannedCount is\n the number of matching items before the filter was applied.

\n

If you did not use a filter in the request, then Count is the same as\n ScannedCount.

" + } + }, + "ScannedCount": { + "target": "com.amazonaws.dynamodb#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of items evaluated, before any ScanFilter is applied. A high\n ScannedCount value with few, or no, Count results\n indicates an inefficient Scan operation. For more information, see Count and\n ScannedCount in the Amazon DynamoDB Developer\n Guide.

\n

If you did not use a filter in the request, then ScannedCount is the same\n as Count.

" + } + }, + "LastEvaluatedKey": { + "target": "com.amazonaws.dynamodb#Key", + "traits": { + "smithy.api#documentation": "

The primary key of the item where the operation stopped, inclusive of the previous\n result set. Use this value to start a new operation, excluding this value in the new\n request.

\n

If LastEvaluatedKey is empty, then the \"last page\" of results has been\n processed and there is no more data to be retrieved.

\n

If LastEvaluatedKey is not empty, it does not necessarily mean that there\n is more data in the result set. The only way to know when you have reached the end of\n the result set is when LastEvaluatedKey is empty.

" + } + }, + "ConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ConsumedCapacity", + "traits": { + "smithy.api#documentation": "

The capacity units consumed by the Scan operation. The data returned\n includes the total provisioned throughput consumed, along with statistics for the table\n and any indexes involved in the operation. ConsumedCapacity is only\n returned if the ReturnConsumedCapacity parameter was specified. For more\n information, see Capacity unit consumption for read operations in the Amazon\n DynamoDB Developer Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a Scan operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#ScanSegment": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 999999 + } + } + }, + "com.amazonaws.dynamodb#ScanTotalSegments": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000000 + } + } + }, + "com.amazonaws.dynamodb#SecondaryIndexesCapacityMap": { + "type": "map", + "key": { + "target": "com.amazonaws.dynamodb#IndexName" + }, + "value": { + "target": "com.amazonaws.dynamodb#Capacity" + } + }, + "com.amazonaws.dynamodb#Select": { + "type": "enum", + "members": { + "ALL_ATTRIBUTES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL_ATTRIBUTES" + } + }, + "ALL_PROJECTED_ATTRIBUTES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL_PROJECTED_ATTRIBUTES" + } + }, + "SPECIFIC_ATTRIBUTES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SPECIFIC_ATTRIBUTES" + } + }, + "COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COUNT" + } + } + } + }, + "com.amazonaws.dynamodb#SourceTableDetails": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The name of the table for which the backup was created.

", + "smithy.api#required": {} + } + }, + "TableId": { + "target": "com.amazonaws.dynamodb#TableId", + "traits": { + "smithy.api#documentation": "

Unique identifier for the table for which the backup was created.

", + "smithy.api#required": {} + } + }, + "TableArn": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

ARN of the table for which backup was created.

" + } + }, + "TableSizeBytes": { + "target": "com.amazonaws.dynamodb#LongObject", + "traits": { + "smithy.api#documentation": "

Size of the table in bytes. Note that this is an approximate value.

" + } + }, + "KeySchema": { + "target": "com.amazonaws.dynamodb#KeySchema", + "traits": { + "smithy.api#documentation": "

Schema of the table.

", + "smithy.api#required": {} + } + }, + "TableCreationDateTime": { + "target": "com.amazonaws.dynamodb#TableCreationDateTime", + "traits": { + "smithy.api#documentation": "

Time when the source table was created.

", + "smithy.api#required": {} + } + }, + "ProvisionedThroughput": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughput", + "traits": { + "smithy.api#documentation": "

Read IOPs and Write IOPS on the table when the backup was created.

", + "smithy.api#required": {} + } + }, + "OnDemandThroughput": { + "target": "com.amazonaws.dynamodb#OnDemandThroughput" + }, + "ItemCount": { + "target": "com.amazonaws.dynamodb#ItemCount", + "traits": { + "smithy.api#documentation": "

Number of items in the table. Note that this is an approximate value.

" + } + }, + "BillingMode": { + "target": "com.amazonaws.dynamodb#BillingMode", + "traits": { + "smithy.api#documentation": "

Controls how you are charged for read and write throughput and how you manage\n capacity. This setting can be changed later.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details of the table when the backup was created.

" + } + }, + "com.amazonaws.dynamodb#SourceTableFeatureDetails": { + "type": "structure", + "members": { + "LocalSecondaryIndexes": { + "target": "com.amazonaws.dynamodb#LocalSecondaryIndexes", + "traits": { + "smithy.api#documentation": "

Represents the LSI properties for the table when the backup was created. It includes\n the IndexName, KeySchema and Projection for the LSIs on the table at the time of backup.\n

" + } + }, + "GlobalSecondaryIndexes": { + "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexes", + "traits": { + "smithy.api#documentation": "

Represents the GSI properties for the table when the backup was created. It includes\n the IndexName, KeySchema, Projection, and ProvisionedThroughput for the GSIs on the\n table at the time of backup.

" + } + }, + "StreamDescription": { + "target": "com.amazonaws.dynamodb#StreamSpecification", + "traits": { + "smithy.api#documentation": "

Stream settings on the table when the backup was created.

" + } + }, + "TimeToLiveDescription": { + "target": "com.amazonaws.dynamodb#TimeToLiveDescription", + "traits": { + "smithy.api#documentation": "

Time to Live settings on the table when the backup was created.

" + } + }, + "SSEDescription": { + "target": "com.amazonaws.dynamodb#SSEDescription", + "traits": { + "smithy.api#documentation": "

The description of the server-side encryption status on the table when the backup was\n created.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details of the features enabled on the table when the backup was created.\n For example, LSIs, GSIs, streams, TTL.

" + } + }, + "com.amazonaws.dynamodb#StreamArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 37, + "max": 1024 + } + } + }, + "com.amazonaws.dynamodb#StreamEnabled": { + "type": "boolean" + }, + "com.amazonaws.dynamodb#StreamSpecification": { + "type": "structure", + "members": { + "StreamEnabled": { + "target": "com.amazonaws.dynamodb#StreamEnabled", + "traits": { + "smithy.api#documentation": "

Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the\n table.

", + "smithy.api#required": {} + } + }, + "StreamViewType": { + "target": "com.amazonaws.dynamodb#StreamViewType", + "traits": { + "smithy.api#documentation": "

When an item in the table is modified, StreamViewType determines what\n information is written to the stream for this table. Valid values for\n StreamViewType are:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the DynamoDB Streams configuration for a table in DynamoDB.

" + } + }, + "com.amazonaws.dynamodb#StreamViewType": { + "type": "enum", + "members": { + "NEW_IMAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEW_IMAGE" + } + }, + "OLD_IMAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OLD_IMAGE" + } + }, + "NEW_AND_OLD_IMAGES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEW_AND_OLD_IMAGES" + } + }, + "KEYS_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KEYS_ONLY" + } + } + } + }, + "com.amazonaws.dynamodb#String": { + "type": "string" + }, + "com.amazonaws.dynamodb#StringAttributeValue": { + "type": "string" + }, + "com.amazonaws.dynamodb#StringSetAttributeValue": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#StringAttributeValue" + } + }, + "com.amazonaws.dynamodb#TableAlreadyExistsException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

A target table with the specified name already exists.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#TableArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.dynamodb#TableAutoScalingDescription": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The name of the table.

" + } + }, + "TableStatus": { + "target": "com.amazonaws.dynamodb#TableStatus", + "traits": { + "smithy.api#documentation": "

The current state of the table:

\n " + } + }, + "Replicas": { + "target": "com.amazonaws.dynamodb#ReplicaAutoScalingDescriptionList", + "traits": { + "smithy.api#documentation": "

Represents replicas of the global table.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the auto scaling configuration for a global table.

" + } + }, + "com.amazonaws.dynamodb#TableClass": { + "type": "enum", + "members": { + "STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STANDARD" + } + }, + "STANDARD_INFREQUENT_ACCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STANDARD_INFREQUENT_ACCESS" + } + } + } + }, + "com.amazonaws.dynamodb#TableClassSummary": { + "type": "structure", + "members": { + "TableClass": { + "target": "com.amazonaws.dynamodb#TableClass", + "traits": { + "smithy.api#documentation": "

The table class of the specified table. Valid values are STANDARD and\n STANDARD_INFREQUENT_ACCESS.

" + } + }, + "LastUpdateDateTime": { + "target": "com.amazonaws.dynamodb#Date", + "traits": { + "smithy.api#documentation": "

The date and time at which the table class was last updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details of the table class.

" + } + }, + "com.amazonaws.dynamodb#TableCreationDateTime": { + "type": "timestamp" + }, + "com.amazonaws.dynamodb#TableCreationParameters": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The name of the table created as part of the import operation.

", + "smithy.api#required": {} + } + }, + "AttributeDefinitions": { + "target": "com.amazonaws.dynamodb#AttributeDefinitions", + "traits": { + "smithy.api#documentation": "

The attributes of the table created as part of the import operation.

", + "smithy.api#required": {} + } + }, + "KeySchema": { + "target": "com.amazonaws.dynamodb#KeySchema", + "traits": { + "smithy.api#documentation": "

The primary key and option sort key of the table created as part of the import\n operation.

", + "smithy.api#required": {} + } + }, + "BillingMode": { + "target": "com.amazonaws.dynamodb#BillingMode", + "traits": { + "smithy.api#documentation": "

The billing mode for provisioning the table created as part of the import operation.\n

" + } + }, + "ProvisionedThroughput": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughput" + }, + "OnDemandThroughput": { + "target": "com.amazonaws.dynamodb#OnDemandThroughput" + }, + "SSESpecification": { + "target": "com.amazonaws.dynamodb#SSESpecification" + }, + "GlobalSecondaryIndexes": { + "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexList", + "traits": { + "smithy.api#documentation": "

The Global Secondary Indexes (GSI) of the table to be created as part of the import\n operation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters for the table created as part of the import operation.

" + } + }, + "com.amazonaws.dynamodb#TableDescription": { + "type": "structure", + "members": { + "AttributeDefinitions": { + "target": "com.amazonaws.dynamodb#AttributeDefinitions", + "traits": { + "smithy.api#documentation": "

An array of AttributeDefinition objects. Each of these objects describes\n one attribute in the table and index key schema.

\n

Each AttributeDefinition object in this array is composed of:

\n " + } + }, + "TableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The name of the table.

" + } + }, + "KeySchema": { + "target": "com.amazonaws.dynamodb#KeySchema", + "traits": { + "smithy.api#documentation": "

The primary key structure for the table. Each KeySchemaElement consists\n of:

\n \n

For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "TableStatus": { + "target": "com.amazonaws.dynamodb#TableStatus", + "traits": { + "smithy.api#documentation": "

The current state of the table:

\n " + } + }, + "CreationDateTime": { + "target": "com.amazonaws.dynamodb#Date", + "traits": { + "smithy.api#documentation": "

The date and time when the table was created, in UNIX epoch time format.

" + } + }, + "ProvisionedThroughput": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughputDescription", + "traits": { + "smithy.api#documentation": "

The provisioned throughput settings for the table, consisting of read and write\n capacity units, along with data about increases and decreases.

" + } + }, + "TableSizeBytes": { + "target": "com.amazonaws.dynamodb#LongObject", + "traits": { + "smithy.api#documentation": "

The total size of the specified table, in bytes. DynamoDB updates this value\n approximately every six hours. Recent changes might not be reflected in this\n value.

" + } + }, + "ItemCount": { + "target": "com.amazonaws.dynamodb#LongObject", + "traits": { + "smithy.api#documentation": "

The number of items in the specified table. DynamoDB updates this value approximately\n every six hours. Recent changes might not be reflected in this value.

" + } + }, + "TableArn": { + "target": "com.amazonaws.dynamodb#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the table.

" + } + }, + "TableId": { + "target": "com.amazonaws.dynamodb#TableId", + "traits": { + "smithy.api#documentation": "

Unique identifier for the table for which the backup was created.

" + } + }, + "BillingModeSummary": { + "target": "com.amazonaws.dynamodb#BillingModeSummary", + "traits": { + "smithy.api#documentation": "

Contains the details for the read/write capacity mode.

" + } + }, + "LocalSecondaryIndexes": { + "target": "com.amazonaws.dynamodb#LocalSecondaryIndexDescriptionList", + "traits": { + "smithy.api#documentation": "

Represents one or more local secondary indexes on the table. Each index is scoped to a\n given partition key value. Tables with one or more local secondary indexes are subject\n to an item collection size limit, where the amount of data within a given item\n collection cannot exceed 10 GB. Each element is composed of:

\n \n

If the table is in the DELETING state, no information about indexes will\n be returned.

" + } + }, + "GlobalSecondaryIndexes": { + "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexDescriptionList", + "traits": { + "smithy.api#documentation": "

The global secondary indexes, if any, on the table. Each index is scoped to a given\n partition key value. Each element is composed of:

\n \n

If the table is in the DELETING state, no information about indexes will\n be returned.

" + } + }, + "StreamSpecification": { + "target": "com.amazonaws.dynamodb#StreamSpecification", + "traits": { + "smithy.api#documentation": "

The current DynamoDB Streams configuration for the table.

" + } + }, + "LatestStreamLabel": { + "target": "com.amazonaws.dynamodb#String", + "traits": { + "smithy.api#documentation": "

A timestamp, in ISO 8601 format, for this stream.

\n

Note that LatestStreamLabel is not a unique identifier for the stream,\n because it is possible that a stream from another table might have the same timestamp.\n However, the combination of the following three elements is guaranteed to be\n unique:

\n " + } + }, + "LatestStreamArn": { + "target": "com.amazonaws.dynamodb#StreamArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this\n table.

" + } + }, + "GlobalTableVersion": { + "target": "com.amazonaws.dynamodb#String", + "traits": { + "smithy.api#documentation": "

Represents the version of global tables\n in use, if the table is replicated across Amazon Web Services Regions.

" + } + }, + "Replicas": { + "target": "com.amazonaws.dynamodb#ReplicaDescriptionList", + "traits": { + "smithy.api#documentation": "

Represents replicas of the table.

" + } + }, + "RestoreSummary": { + "target": "com.amazonaws.dynamodb#RestoreSummary", + "traits": { + "smithy.api#documentation": "

Contains details for the restore.

" + } + }, + "SSEDescription": { + "target": "com.amazonaws.dynamodb#SSEDescription", + "traits": { + "smithy.api#documentation": "

The description of the server-side encryption status on the specified table.

" + } + }, + "ArchivalSummary": { + "target": "com.amazonaws.dynamodb#ArchivalSummary", + "traits": { + "smithy.api#documentation": "

Contains information about the table archive.

" + } + }, + "TableClassSummary": { + "target": "com.amazonaws.dynamodb#TableClassSummary", + "traits": { + "smithy.api#documentation": "

Contains details of the table class.

" + } + }, + "DeletionProtectionEnabled": { + "target": "com.amazonaws.dynamodb#DeletionProtectionEnabled", + "traits": { + "smithy.api#documentation": "

Indicates whether deletion protection is enabled (true) or disabled (false) on the\n table.

" + } + }, + "OnDemandThroughput": { + "target": "com.amazonaws.dynamodb#OnDemandThroughput", + "traits": { + "smithy.api#documentation": "

The maximum number of read and write units for the specified on-demand table. If you\n use this parameter, you must specify MaxReadRequestUnits,\n MaxWriteRequestUnits, or both.

" + } + }, + "WarmThroughput": { + "target": "com.amazonaws.dynamodb#TableWarmThroughputDescription", + "traits": { + "smithy.api#documentation": "

Describes the warm throughput value of the base table.

" + } + }, + "MultiRegionConsistency": { + "target": "com.amazonaws.dynamodb#MultiRegionConsistency", + "traits": { + "smithy.api#documentation": "

Indicates one of the following consistency modes for a global table:

\n \n

If you don't specify this field, the global table consistency mode defaults to EVENTUAL.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the properties of a table.

" + } + }, + "com.amazonaws.dynamodb#TableId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" + } + }, + "com.amazonaws.dynamodb#TableInUseException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

A target table with the specified name is either being created or deleted.\n

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#TableName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_.-]+$" + } + }, + "com.amazonaws.dynamodb#TableNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#TableName" + } + }, + "com.amazonaws.dynamodb#TableNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

A source table with the name TableName does not currently exist within\n the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#TableStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "INACCESSIBLE_ENCRYPTION_CREDENTIALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACCESSIBLE_ENCRYPTION_CREDENTIALS" + } + }, + "ARCHIVING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARCHIVING" + } + }, + "ARCHIVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARCHIVED" + } + } + } + }, + "com.amazonaws.dynamodb#TableWarmThroughputDescription": { + "type": "structure", + "members": { + "ReadUnitsPerSecond": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

Represents the base table's warm throughput value in read units per second.

" + } + }, + "WriteUnitsPerSecond": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

Represents the base table's warm throughput value in write units per second.

" + } + }, + "Status": { + "target": "com.amazonaws.dynamodb#TableStatus", + "traits": { + "smithy.api#documentation": "

Represents warm throughput value of the base table..

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the warm throughput value (in read units per second and write units per\n second) of the base table.

" + } + }, + "com.amazonaws.dynamodb#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.dynamodb#TagKeyString", + "traits": { + "smithy.api#documentation": "

The key of the tag. Tag keys are case sensitive. Each DynamoDB table can\n only have up to one tag with the same key. If you try to add an existing tag (same key),\n the existing tag value will be updated to the new value.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.dynamodb#TagValueString", + "traits": { + "smithy.api#documentation": "

The value of the tag. Tag values are case-sensitive and can be null.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single\n DynamoDB table.

\n

Amazon Web Services-assigned tag names and values are automatically assigned the\n aws: prefix, which the user cannot assign. Amazon Web Services-assigned\n tag names do not count towards the tag limit of 50. User-assigned tag names have the\n prefix user: in the Cost Allocation Report. You cannot backdate the\n application of a tag.

\n

For an overview on tagging DynamoDB resources, see Tagging\n for DynamoDB in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "com.amazonaws.dynamodb#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#TagKeyString" + } + }, + "com.amazonaws.dynamodb#TagKeyString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.dynamodb#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#Tag" + } + }, + "com.amazonaws.dynamodb#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#TagResourceInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceInUseException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Associate a set of tags with an Amazon DynamoDB resource. You can then activate these\n user-defined tags so that they appear on the Billing and Cost Management console for\n cost allocation tracking. You can call TagResource up to five times per second, per\n account.

\n \n

For an overview on tagging DynamoDB resources, see Tagging for DynamoDB\n in the Amazon DynamoDB Developer Guide.

" + } + }, + "com.amazonaws.dynamodb#TagResourceInput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.dynamodb#ResourceArnString", + "traits": { + "smithy.api#documentation": "

Identifies the Amazon DynamoDB resource to which tags should be added. This value is\n an Amazon Resource Name (ARN).

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.dynamodb#TagList", + "traits": { + "smithy.api#documentation": "

The tags to be assigned to the Amazon DynamoDB resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#TagValueString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.dynamodb#TimeRangeLowerBound": { + "type": "timestamp" + }, + "com.amazonaws.dynamodb#TimeRangeUpperBound": { + "type": "timestamp" + }, + "com.amazonaws.dynamodb#TimeToLiveAttributeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.dynamodb#TimeToLiveDescription": { + "type": "structure", + "members": { + "TimeToLiveStatus": { + "target": "com.amazonaws.dynamodb#TimeToLiveStatus", + "traits": { + "smithy.api#documentation": "

The TTL status for the table.

" + } + }, + "AttributeName": { + "target": "com.amazonaws.dynamodb#TimeToLiveAttributeName", + "traits": { + "smithy.api#documentation": "

The name of the TTL attribute for items in the table.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The description of the Time to Live (TTL) status on the specified table.

" + } + }, + "com.amazonaws.dynamodb#TimeToLiveEnabled": { + "type": "boolean" + }, + "com.amazonaws.dynamodb#TimeToLiveSpecification": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.dynamodb#TimeToLiveEnabled", + "traits": { + "smithy.api#documentation": "

Indicates whether TTL is to be enabled (true) or disabled (false) on the table.

", + "smithy.api#required": {} + } + }, + "AttributeName": { + "target": "com.amazonaws.dynamodb#TimeToLiveAttributeName", + "traits": { + "smithy.api#documentation": "

The name of the TTL attribute used to store the expiration time for items in the\n table.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the settings used to enable or disable Time to Live (TTL) for the specified\n table.

" + } + }, + "com.amazonaws.dynamodb#TimeToLiveStatus": { + "type": "enum", + "members": { + "ENABLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLING" + } + }, + "DISABLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLING" + } + }, + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.dynamodb#TransactGetItem": { + "type": "structure", + "members": { + "Get": { + "target": "com.amazonaws.dynamodb#Get", + "traits": { + "smithy.api#documentation": "

Contains the primary key that identifies the item to get, together with the name of\n the table that contains the item, and optionally the specific attributes of the item to\n retrieve.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies an item to be retrieved as part of the transaction.

" + } + }, + "com.amazonaws.dynamodb#TransactGetItemList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#TransactGetItem" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.dynamodb#TransactGetItems": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#TransactGetItemsInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#TransactGetItemsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.dynamodb#RequestLimitExceeded" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#TransactionCanceledException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

\n TransactGetItems is a synchronous operation that atomically retrieves\n multiple items from one or more tables (but not from indexes) in a single account and\n Region. A TransactGetItems call can contain up to 100\n TransactGetItem objects, each of which contains a Get\n structure that specifies an item to retrieve from a table in the account and Region. A\n call to TransactGetItems cannot retrieve items from tables in more than one\n Amazon Web Services account or Region. The aggregate size of the items in the\n transaction cannot exceed 4 MB.

\n

DynamoDB rejects the entire TransactGetItems request if any of\n the following is true:

\n " + } + }, + "com.amazonaws.dynamodb#TransactGetItemsInput": { + "type": "structure", + "members": { + "TransactItems": { + "target": "com.amazonaws.dynamodb#TransactGetItemList", + "traits": { + "smithy.api#documentation": "

An ordered array of up to 100 TransactGetItem objects, each of which\n contains a Get structure.

", + "smithy.api#required": {} + } + }, + "ReturnConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ReturnConsumedCapacity", + "traits": { + "smithy.api#documentation": "

A value of TOTAL causes consumed capacity information to be returned, and\n a value of NONE prevents that information from being returned. No other\n value is valid.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#TransactGetItemsOutput": { + "type": "structure", + "members": { + "ConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ConsumedCapacityMultiple", + "traits": { + "smithy.api#documentation": "

If the ReturnConsumedCapacity value was TOTAL, this\n is an array of ConsumedCapacity objects, one for each table addressed by\n TransactGetItem objects in the TransactItems\n parameter. These ConsumedCapacity objects report the read-capacity units\n consumed by the TransactGetItems call in that table.

" + } + }, + "Responses": { + "target": "com.amazonaws.dynamodb#ItemResponseList", + "traits": { + "smithy.api#documentation": "

An ordered array of up to 100 ItemResponse objects, each of which\n corresponds to the TransactGetItem object in the same position in the\n TransactItems array. Each ItemResponse object\n contains a Map of the name-value pairs that are the projected attributes of the\n requested item.

\n

If a requested item could not be retrieved, the corresponding\n ItemResponse object is Null, or if the requested item has no projected\n attributes, the corresponding ItemResponse object is an empty Map.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#TransactWriteItem": { + "type": "structure", + "members": { + "ConditionCheck": { + "target": "com.amazonaws.dynamodb#ConditionCheck", + "traits": { + "smithy.api#documentation": "

A request to perform a check item operation.

" + } + }, + "Put": { + "target": "com.amazonaws.dynamodb#Put", + "traits": { + "smithy.api#documentation": "

A request to perform a PutItem operation.

" + } + }, + "Delete": { + "target": "com.amazonaws.dynamodb#Delete", + "traits": { + "smithy.api#documentation": "

A request to perform a DeleteItem operation.

" + } + }, + "Update": { + "target": "com.amazonaws.dynamodb#Update", + "traits": { + "smithy.api#documentation": "

A request to perform an UpdateItem operation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of requests that can perform update, put, delete, or check operations on\n multiple items in one or more tables atomically.

" + } + }, + "com.amazonaws.dynamodb#TransactWriteItemList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#TransactWriteItem" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.dynamodb#TransactWriteItems": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#TransactWriteItemsInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#TransactWriteItemsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#IdempotentParameterMismatchException" + }, + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.dynamodb#RequestLimitExceeded" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#TransactionCanceledException" + }, + { + "target": "com.amazonaws.dynamodb#TransactionInProgressException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

\n TransactWriteItems is a synchronous write operation that groups up to 100\n action requests. These actions can target items in different tables, but not in\n different Amazon Web Services accounts or Regions, and no two actions can target the same\n item. For example, you cannot both ConditionCheck and Update\n the same item. The aggregate size of the items in the transaction cannot exceed 4\n MB.

\n

The actions are completed atomically so that either all of them succeed, or all of\n them fail. They are defined by the following objects:

\n \n

DynamoDB rejects the entire TransactWriteItems request if any of the\n following is true:

\n " + } + }, + "com.amazonaws.dynamodb#TransactWriteItemsInput": { + "type": "structure", + "members": { + "TransactItems": { + "target": "com.amazonaws.dynamodb#TransactWriteItemList", + "traits": { + "smithy.api#documentation": "

An ordered array of up to 100 TransactWriteItem objects, each of which\n contains a ConditionCheck, Put, Update, or\n Delete object. These can operate on items in different tables, but the\n tables must reside in the same Amazon Web Services account and Region, and no two of them\n can operate on the same item.

", + "smithy.api#required": {} + } + }, + "ReturnConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ReturnConsumedCapacity" + }, + "ReturnItemCollectionMetrics": { + "target": "com.amazonaws.dynamodb#ReturnItemCollectionMetrics", + "traits": { + "smithy.api#documentation": "

Determines whether item collection metrics are returned. If set to SIZE,\n the response includes statistics about item collections (if any), that were modified\n during the operation and are returned in the response. If set to NONE (the\n default), no statistics are returned.

" + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.dynamodb#ClientRequestToken", + "traits": { + "smithy.api#documentation": "

Providing a ClientRequestToken makes the call to\n TransactWriteItems idempotent, meaning that multiple identical calls\n have the same effect as one single call.

\n

Although multiple identical calls using the same client request token produce the same\n result on the server (no side effects), the responses to the calls might not be the\n same. If the ReturnConsumedCapacity parameter is set, then the initial\n TransactWriteItems call returns the amount of write capacity units\n consumed in making the changes. Subsequent TransactWriteItems calls with\n the same client token return the number of read capacity units consumed in reading the\n item.

\n

A client request token is valid for 10 minutes after the first request that uses it is\n completed. After 10 minutes, any request with the same client token is treated as a new\n request. Do not resubmit the same request with the same client token for more than 10\n minutes, or the result might not be idempotent.

\n

If you submit a request with the same client token but a change in other parameters\n within the 10-minute idempotency window, DynamoDB returns an\n IdempotentParameterMismatch exception.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#TransactWriteItemsOutput": { + "type": "structure", + "members": { + "ConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ConsumedCapacityMultiple", + "traits": { + "smithy.api#documentation": "

The capacity units consumed by the entire TransactWriteItems operation.\n The values of the list are ordered according to the ordering of the\n TransactItems request parameter.

" + } + }, + "ItemCollectionMetrics": { + "target": "com.amazonaws.dynamodb#ItemCollectionMetricsPerTable", + "traits": { + "smithy.api#documentation": "

A list of tables that were processed by TransactWriteItems and, for each\n table, information about any item collections that were affected by individual\n UpdateItem, PutItem, or DeleteItem\n operations.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#TransactionCanceledException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + }, + "CancellationReasons": { + "target": "com.amazonaws.dynamodb#CancellationReasonList", + "traits": { + "smithy.api#documentation": "

A list of cancellation reasons.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The entire transaction request was canceled.

\n

DynamoDB cancels a TransactWriteItems request under the following\n circumstances:

\n \n

DynamoDB cancels a TransactGetItems request under the\n following circumstances:

\n \n \n

If using Java, DynamoDB lists the cancellation reasons on the\n CancellationReasons property. This property is not set for other\n languages. Transaction cancellation reasons are ordered in the order of requested\n items, if an item has no error it will have None code and\n Null message.

\n \n

Cancellation reason codes and possible error messages:

\n ", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#TransactionConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

Operation was rejected because there is an ongoing transaction for the\n item.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#TransactionInProgressException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The transaction with the given request token is already in progress.

\n

\n Recommended Settings \n

\n \n

\n This is a general recommendation for handling the TransactionInProgressException. These settings help \n ensure that the client retries will trigger completion of the ongoing TransactWriteItems request.\n

\n \n \n

\n Assuming default retry policy, \n example timeout settings based on the guidelines above are as follows: \n

\n

Example timeline:

\n ", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#UntagResourceInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceInUseException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Removes the association of tags from an Amazon DynamoDB resource. You can call\n UntagResource up to five times per second, per account.

\n \n

For an overview on tagging DynamoDB resources, see Tagging for DynamoDB\n in the Amazon DynamoDB Developer Guide.

" + } + }, + "com.amazonaws.dynamodb#UntagResourceInput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.dynamodb#ResourceArnString", + "traits": { + "smithy.api#documentation": "

The DynamoDB resource that the tags will be removed from. This value is an Amazon\n Resource Name (ARN).

", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.dynamodb#TagKeyList", + "traits": { + "smithy.api#documentation": "

A list of tag keys. Existing tags of the resource whose keys are members of this list\n will be removed from the DynamoDB resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#Update": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.dynamodb#Key", + "traits": { + "smithy.api#documentation": "

The primary key of the item to be updated. Each element consists of an attribute name\n and a value for that attribute.

", + "smithy.api#required": {} + } + }, + "UpdateExpression": { + "target": "com.amazonaws.dynamodb#UpdateExpression", + "traits": { + "smithy.api#documentation": "

An expression that defines one or more attributes to be updated, the action to be\n performed on them, and new value(s) for them.

", + "smithy.api#required": {} + } + }, + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

Name of the table for the UpdateItem request. You can also provide the\n Amazon Resource Name (ARN) of the table in this parameter.

", + "smithy.api#required": {} + } + }, + "ConditionExpression": { + "target": "com.amazonaws.dynamodb#ConditionExpression", + "traits": { + "smithy.api#documentation": "

A condition that must be satisfied in order for a conditional update to\n succeed.

" + } + }, + "ExpressionAttributeNames": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", + "traits": { + "smithy.api#documentation": "

One or more substitution tokens for attribute names in an expression.

" + } + }, + "ExpressionAttributeValues": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeValueMap", + "traits": { + "smithy.api#documentation": "

One or more values that can be substituted in an expression.

" + } + }, + "ReturnValuesOnConditionCheckFailure": { + "target": "com.amazonaws.dynamodb#ReturnValuesOnConditionCheckFailure", + "traits": { + "smithy.api#documentation": "

Use ReturnValuesOnConditionCheckFailure to get the item attributes if the\n Update condition fails. For\n ReturnValuesOnConditionCheckFailure, the valid values are: NONE and\n ALL_OLD.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a request to perform an UpdateItem operation.

" + } + }, + "com.amazonaws.dynamodb#UpdateContinuousBackups": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#UpdateContinuousBackupsInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#UpdateContinuousBackupsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#ContinuousBackupsUnavailableException" + }, + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#TableNotFoundException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

\n UpdateContinuousBackups enables or disables point in time recovery for\n the specified table. A successful UpdateContinuousBackups call returns the\n current ContinuousBackupsDescription. Continuous backups are\n ENABLED on all tables at table creation. If point in time recovery is\n enabled, PointInTimeRecoveryStatus will be set to ENABLED.

\n

Once continuous backups and point in time recovery are enabled, you can restore to\n any point in time within EarliestRestorableDateTime and\n LatestRestorableDateTime.

\n

\n LatestRestorableDateTime is typically 5 minutes before the current time.\n You can restore your table to any point in time in the last 35 days. You can set the recovery period to any value between 1 and 35 days.

" + } + }, + "com.amazonaws.dynamodb#UpdateContinuousBackupsInput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this\n parameter.

", + "smithy.api#required": {} + } + }, + "PointInTimeRecoverySpecification": { + "target": "com.amazonaws.dynamodb#PointInTimeRecoverySpecification", + "traits": { + "smithy.api#documentation": "

Represents the settings used to enable point in time recovery.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#UpdateContinuousBackupsOutput": { + "type": "structure", + "members": { + "ContinuousBackupsDescription": { + "target": "com.amazonaws.dynamodb#ContinuousBackupsDescription", + "traits": { + "smithy.api#documentation": "

Represents the continuous backups and point in time recovery settings on the\n table.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#UpdateContributorInsights": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#UpdateContributorInsightsInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#UpdateContributorInsightsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the status for contributor insights for a specific table or index. CloudWatch\n Contributor Insights for DynamoDB graphs display the partition key and (if applicable)\n sort key of frequently accessed items and frequently throttled items in plaintext. If\n you require the use of Amazon Web Services Key Management Service (KMS) to encrypt this\n table’s partition key and sort key data with an Amazon Web Services managed key or\n customer managed key, you should not enable CloudWatch Contributor Insights for DynamoDB\n for this table.

" + } + }, + "com.amazonaws.dynamodb#UpdateContributorInsightsInput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this\n parameter.

", + "smithy.api#required": {} + } + }, + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The global secondary index name, if applicable.

" + } + }, + "ContributorInsightsAction": { + "target": "com.amazonaws.dynamodb#ContributorInsightsAction", + "traits": { + "smithy.api#documentation": "

Represents the contributor insights action.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#UpdateContributorInsightsOutput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The name of the table.

" + } + }, + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the global secondary index, if applicable.

" + } + }, + "ContributorInsightsStatus": { + "target": "com.amazonaws.dynamodb#ContributorInsightsStatus", + "traits": { + "smithy.api#documentation": "

The status of contributor insights

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#UpdateExpression": { + "type": "string" + }, + "com.amazonaws.dynamodb#UpdateGlobalSecondaryIndexAction": { + "type": "structure", + "members": { + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the global secondary index to be updated.

", + "smithy.api#required": {} + } + }, + "ProvisionedThroughput": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughput", + "traits": { + "smithy.api#documentation": "

Represents the provisioned throughput settings for the specified global secondary\n index.

\n

For current minimum and maximum provisioned throughput values, see Service,\n Account, and Table Quotas in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "OnDemandThroughput": { + "target": "com.amazonaws.dynamodb#OnDemandThroughput", + "traits": { + "smithy.api#documentation": "

Updates the maximum number of read and write units for the specified global secondary\n index. If you use this parameter, you must specify MaxReadRequestUnits,\n MaxWriteRequestUnits, or both.

" + } + }, + "WarmThroughput": { + "target": "com.amazonaws.dynamodb#WarmThroughput", + "traits": { + "smithy.api#documentation": "

Represents the warm throughput value of the new provisioned throughput settings to be\n applied to a global secondary index.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the new provisioned throughput settings to be applied to a global secondary\n index.

" + } + }, + "com.amazonaws.dynamodb#UpdateGlobalTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#UpdateGlobalTableInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#UpdateGlobalTableOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#GlobalTableNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#ReplicaAlreadyExistsException" + }, + { + "target": "com.amazonaws.dynamodb#ReplicaNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#TableNotFoundException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Adds or removes replicas in the specified global table. The global table must already\n exist to be able to use this operation. Any replica to be added must be empty, have the\n same name as the global table, have the same key schema, have DynamoDB Streams enabled,\n and have the same provisioned and maximum write capacity units.

\n \n

This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 (Current) when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).

\n

To determine which version you're using, see Determining the global table version you are using. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.

\n \n \n

For global tables, this operation only applies to global tables using Version\n 2019.11.21 (Current version). If you are using global tables Version\n 2019.11.21 you can use UpdateTable instead.

\n

Although you can use UpdateGlobalTable to add replicas and remove\n replicas in a single request, for simplicity we recommend that you issue separate\n requests for adding or removing replicas.

\n \n

If global secondary indexes are specified, then the following conditions must also be\n met:

\n " + } + }, + "com.amazonaws.dynamodb#UpdateGlobalTableInput": { + "type": "structure", + "members": { + "GlobalTableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The global table name.

", + "smithy.api#required": {} + } + }, + "ReplicaUpdates": { + "target": "com.amazonaws.dynamodb#ReplicaUpdateList", + "traits": { + "smithy.api#documentation": "

A list of Regions that should be added or removed from the global table.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#UpdateGlobalTableOutput": { + "type": "structure", + "members": { + "GlobalTableDescription": { + "target": "com.amazonaws.dynamodb#GlobalTableDescription", + "traits": { + "smithy.api#documentation": "

Contains the details of the global table.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#UpdateGlobalTableSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#UpdateGlobalTableSettingsInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#UpdateGlobalTableSettingsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#GlobalTableNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#IndexNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#ReplicaNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceInUseException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Updates settings for a global table.

\n \n

This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 (Current) when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).

\n

To determine which version you're using, see Determining the global table version you are using. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.

\n " + } + }, + "com.amazonaws.dynamodb#UpdateGlobalTableSettingsInput": { + "type": "structure", + "members": { + "GlobalTableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The name of the global table

", + "smithy.api#required": {} + } + }, + "GlobalTableBillingMode": { + "target": "com.amazonaws.dynamodb#BillingMode", + "traits": { + "smithy.api#documentation": "

The billing mode of the global table. If GlobalTableBillingMode is not\n specified, the global table defaults to PROVISIONED capacity billing\n mode.

\n " + } + }, + "GlobalTableProvisionedWriteCapacityUnits": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

The maximum number of writes consumed per second before DynamoDB returns a\n ThrottlingException.\n

" + } + }, + "GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate": { + "target": "com.amazonaws.dynamodb#AutoScalingSettingsUpdate", + "traits": { + "smithy.api#documentation": "

Auto scaling settings for managing provisioned write capacity for the global\n table.

" + } + }, + "GlobalTableGlobalSecondaryIndexSettingsUpdate": { + "target": "com.amazonaws.dynamodb#GlobalTableGlobalSecondaryIndexSettingsUpdateList", + "traits": { + "smithy.api#documentation": "

Represents the settings of a global secondary index for a global table that will be\n modified.

" + } + }, + "ReplicaSettingsUpdate": { + "target": "com.amazonaws.dynamodb#ReplicaSettingsUpdateList", + "traits": { + "smithy.api#documentation": "

Represents the settings for a global table in a Region that will be modified.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#UpdateGlobalTableSettingsOutput": { + "type": "structure", + "members": { + "GlobalTableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The name of the global table.

" + } + }, + "ReplicaSettings": { + "target": "com.amazonaws.dynamodb#ReplicaSettingsDescriptionList", + "traits": { + "smithy.api#documentation": "

The Region-specific settings for the global table.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#UpdateItem": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#UpdateItemInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#UpdateItemOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#ConditionalCheckFailedException" + }, + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#ItemCollectionSizeLimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.dynamodb#ReplicatedWriteConflictException" + }, + { + "target": "com.amazonaws.dynamodb#RequestLimitExceeded" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#TransactionConflictException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Edits an existing item's attributes, or adds a new item to the table if it does not\n already exist. You can put, delete, or add attribute values. You can also perform a\n conditional update on an existing item (insert a new attribute name-value pair if it\n doesn't exist, or replace an existing name-value pair if it has certain expected\n attribute values).

\n

You can also return the item's attribute values in the same UpdateItem\n operation using the ReturnValues parameter.

", + "smithy.api#examples": [ + { + "title": "To update an item in a table", + "documentation": "This example updates an item in the Music table. It adds a new attribute (Year) and modifies the AlbumTitle attribute. All of the attributes in the item, as they appear after the update, are returned in the response.", + "input": { + "TableName": "Music", + "Key": { + "Artist": { + "S": "Acme Band" + }, + "SongTitle": { + "S": "Happy Day" + } + }, + "UpdateExpression": "SET #Y = :y, #AT = :t", + "ExpressionAttributeNames": { + "#Y": "Year", + "#AT": "AlbumTitle" + }, + "ExpressionAttributeValues": { + ":y": { + "N": "2015" + }, + ":t": { + "S": "Louder Than Ever" + } + }, + "ReturnValues": "ALL_NEW" + }, + "output": { + "Attributes": { + "AlbumTitle": { + "S": "Louder Than Ever" + }, + "Artist": { + "S": "Acme Band" + }, + "Year": { + "N": "2015" + }, + "SongTitle": { + "S": "Happy Day" + } + } + } + } + ] + } + }, + "com.amazonaws.dynamodb#UpdateItemInput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The name of the table containing the item to update. You can also provide the\n Amazon Resource Name (ARN) of the table in this parameter.

", + "smithy.api#required": {} + } + }, + "Key": { + "target": "com.amazonaws.dynamodb#Key", + "traits": { + "smithy.api#documentation": "

The primary key of the item to be updated. Each element consists of an attribute name\n and a value for that attribute.

\n

For the primary key, you must provide all of the attributes. For example, with a\n simple primary key, you only need to provide a value for the partition key. For a\n composite primary key, you must provide values for both the partition key and the sort\n key.

", + "smithy.api#required": {} + } + }, + "AttributeUpdates": { + "target": "com.amazonaws.dynamodb#AttributeUpdates", + "traits": { + "smithy.api#documentation": "

This is a legacy parameter. Use UpdateExpression instead. For more\n information, see AttributeUpdates in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "Expected": { + "target": "com.amazonaws.dynamodb#ExpectedAttributeMap", + "traits": { + "smithy.api#documentation": "

This is a legacy parameter. Use ConditionExpression instead. For more\n information, see Expected in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ConditionalOperator": { + "target": "com.amazonaws.dynamodb#ConditionalOperator", + "traits": { + "smithy.api#documentation": "

This is a legacy parameter. Use ConditionExpression instead. For more\n information, see ConditionalOperator in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ReturnValues": { + "target": "com.amazonaws.dynamodb#ReturnValue", + "traits": { + "smithy.api#documentation": "

Use ReturnValues if you want to get the item attributes as they appear\n before or after they are successfully updated. For UpdateItem, the valid\n values are:

\n \n

There is no additional cost associated with requesting a return value aside from the\n small network and processing overhead of receiving a larger response. No read capacity\n units are consumed.

\n

The values returned are strongly consistent.

" + } + }, + "ReturnConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ReturnConsumedCapacity" + }, + "ReturnItemCollectionMetrics": { + "target": "com.amazonaws.dynamodb#ReturnItemCollectionMetrics", + "traits": { + "smithy.api#documentation": "

Determines whether item collection metrics are returned. If set to SIZE,\n the response includes statistics about item collections, if any, that were modified\n during the operation are returned in the response. If set to NONE (the\n default), no statistics are returned.

" + } + }, + "UpdateExpression": { + "target": "com.amazonaws.dynamodb#UpdateExpression", + "traits": { + "smithy.api#documentation": "

An expression that defines one or more attributes to be updated, the action to be\n performed on them, and new values for them.

\n

The following action values are available for UpdateExpression.

\n \n

You can have many actions in a single expression, such as the following: SET\n a=:value1, b=:value2 DELETE :value3, :value4, :value5\n

\n

For more information on update expressions, see Modifying\n Items and Attributes in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ConditionExpression": { + "target": "com.amazonaws.dynamodb#ConditionExpression", + "traits": { + "smithy.api#documentation": "

A condition that must be satisfied in order for a conditional update to\n succeed.

\n

An expression can contain any of the following:

\n \n

For more information about condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ExpressionAttributeNames": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", + "traits": { + "smithy.api#documentation": "

One or more substitution tokens for attribute names in an expression. The following\n are some use cases for using ExpressionAttributeNames:

\n \n

Use the # character in an expression to dereference\n an attribute name. For example, consider the following attribute name:

\n \n

The name of this attribute conflicts with a reserved word, so it cannot be used\n directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer\n Guide.) To work around this, you could specify the following for\n ExpressionAttributeNames:

\n \n

You could then use this substitution in an expression, as in this example:

\n \n \n

Tokens that begin with the : character are\n expression attribute values, which are placeholders for the\n actual value at runtime.

\n \n

For more information about expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ExpressionAttributeValues": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeValueMap", + "traits": { + "smithy.api#documentation": "

One or more values that can be substituted in an expression.

\n

Use the : (colon) character in an expression to\n dereference an attribute value. For example, suppose that you wanted to check whether\n the value of the ProductStatus attribute was one of the following:

\n

\n Available | Backordered | Discontinued\n

\n

You would first need to specify ExpressionAttributeValues as\n follows:

\n

\n { \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"},\n \":disc\":{\"S\":\"Discontinued\"} }\n

\n

You could then use these values in an expression, such as this:

\n

\n ProductStatus IN (:avail, :back, :disc)\n

\n

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ReturnValuesOnConditionCheckFailure": { + "target": "com.amazonaws.dynamodb#ReturnValuesOnConditionCheckFailure", + "traits": { + "smithy.api#documentation": "

An optional parameter that returns the item attributes for an UpdateItem\n operation that failed a condition check.

\n

There is no additional cost associated with requesting a return value aside from the\n small network and processing overhead of receiving a larger response. No read capacity\n units are consumed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of an UpdateItem operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#UpdateItemOutput": { + "type": "structure", + "members": { + "Attributes": { + "target": "com.amazonaws.dynamodb#AttributeMap", + "traits": { + "smithy.api#documentation": "

A map of attribute values as they appear before or after the UpdateItem\n operation, as determined by the ReturnValues parameter.

\n

The Attributes map is only present if the update was successful and\n ReturnValues was specified as something other than NONE in\n the request. Each element represents one attribute.

" + } + }, + "ConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ConsumedCapacity", + "traits": { + "smithy.api#documentation": "

The capacity units consumed by the UpdateItem operation. The data\n returned includes the total provisioned throughput consumed, along with statistics for\n the table and any indexes involved in the operation. ConsumedCapacity is\n only returned if the ReturnConsumedCapacity parameter was specified. For\n more information, see Capacity unity consumption for write operations in the Amazon\n DynamoDB Developer Guide.

" + } + }, + "ItemCollectionMetrics": { + "target": "com.amazonaws.dynamodb#ItemCollectionMetrics", + "traits": { + "smithy.api#documentation": "

Information about item collections, if any, that were affected by the\n UpdateItem operation. ItemCollectionMetrics is only\n returned if the ReturnItemCollectionMetrics parameter was specified. If the\n table does not have any local secondary indexes, this information is not returned in the\n response.

\n

Each ItemCollectionMetrics element consists of:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of an UpdateItem operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#UpdateKinesisStreamingConfiguration": { + "type": "structure", + "members": { + "ApproximateCreationDateTimePrecision": { + "target": "com.amazonaws.dynamodb#ApproximateCreationDateTimePrecision", + "traits": { + "smithy.api#documentation": "

Enables updating the precision of Kinesis data stream timestamp.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Enables updating the configuration for Kinesis Streaming.

" + } + }, + "com.amazonaws.dynamodb#UpdateKinesisStreamingDestination": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#UpdateKinesisStreamingDestinationInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#UpdateKinesisStreamingDestinationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceInUseException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

The command to update the Kinesis stream destination.

" + } + }, + "com.amazonaws.dynamodb#UpdateKinesisStreamingDestinationInput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The table name for the Kinesis streaming destination input. You can also provide the\n ARN of the table in this parameter.

", + "smithy.api#required": {} + } + }, + "StreamArn": { + "target": "com.amazonaws.dynamodb#StreamArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the Kinesis stream input.

", + "smithy.api#required": {} + } + }, + "UpdateKinesisStreamingConfiguration": { + "target": "com.amazonaws.dynamodb#UpdateKinesisStreamingConfiguration", + "traits": { + "smithy.api#documentation": "

The command to update the Kinesis stream configuration.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#UpdateKinesisStreamingDestinationOutput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The table name for the Kinesis streaming destination output.

" + } + }, + "StreamArn": { + "target": "com.amazonaws.dynamodb#StreamArn", + "traits": { + "smithy.api#documentation": "

The ARN for the Kinesis stream input.

" + } + }, + "DestinationStatus": { + "target": "com.amazonaws.dynamodb#DestinationStatus", + "traits": { + "smithy.api#documentation": "

The status of the attempt to update the Kinesis streaming destination output.

" + } + }, + "UpdateKinesisStreamingConfiguration": { + "target": "com.amazonaws.dynamodb#UpdateKinesisStreamingConfiguration", + "traits": { + "smithy.api#documentation": "

The command to update the Kinesis streaming destination configuration.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#UpdateReplicationGroupMemberAction": { + "type": "structure", + "members": { + "RegionName": { + "target": "com.amazonaws.dynamodb#RegionName", + "traits": { + "smithy.api#documentation": "

The Region where the replica exists.

", + "smithy.api#required": {} + } + }, + "KMSMasterKeyId": { + "target": "com.amazonaws.dynamodb#KMSMasterKeyId", + "traits": { + "smithy.api#documentation": "

The KMS key of the replica that should be used for KMS\n encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or\n alias ARN. Note that you should only provide this parameter if the key is different from\n the default DynamoDB KMS key alias/aws/dynamodb.

" + } + }, + "ProvisionedThroughputOverride": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughputOverride", + "traits": { + "smithy.api#documentation": "

Replica-specific provisioned throughput. If not specified, uses the source table's\n provisioned throughput settings.

" + } + }, + "OnDemandThroughputOverride": { + "target": "com.amazonaws.dynamodb#OnDemandThroughputOverride", + "traits": { + "smithy.api#documentation": "

Overrides the maximum on-demand throughput for the replica table.

" + } + }, + "GlobalSecondaryIndexes": { + "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexList", + "traits": { + "smithy.api#documentation": "

Replica-specific global secondary index settings.

" + } + }, + "TableClassOverride": { + "target": "com.amazonaws.dynamodb#TableClass", + "traits": { + "smithy.api#documentation": "

Replica-specific table class. If not specified, uses the source table's table\n class.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a replica to be modified.

" + } + }, + "com.amazonaws.dynamodb#UpdateTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#UpdateTableInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#UpdateTableOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceInUseException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB\n Streams settings for a given table.

\n \n

For global tables, this operation only applies to global tables using Version\n 2019.11.21 (Current version).

\n \n

You can only perform one of the following operations at once:

\n \n

\n UpdateTable is an asynchronous operation; while it's executing, the table\n status changes from ACTIVE to UPDATING. While it's\n UPDATING, you can't issue another UpdateTable request.\n When the table returns to the ACTIVE state, the UpdateTable\n operation is complete.

" + } + }, + "com.amazonaws.dynamodb#UpdateTableInput": { + "type": "structure", + "members": { + "AttributeDefinitions": { + "target": "com.amazonaws.dynamodb#AttributeDefinitions", + "traits": { + "smithy.api#documentation": "

An array of attributes that describe the key schema for the table and indexes. If you\n are adding a new global secondary index to the table, AttributeDefinitions\n must include the key element(s) of the new index.

" + } + }, + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The name of the table to be updated. You can also provide the Amazon Resource Name (ARN) of the table\n in this parameter.

", + "smithy.api#required": {} + } + }, + "BillingMode": { + "target": "com.amazonaws.dynamodb#BillingMode", + "traits": { + "smithy.api#documentation": "

Controls how you are charged for read and write throughput and how you manage\n capacity. When switching from pay-per-request to provisioned capacity, initial\n provisioned capacity values must be set. The initial provisioned capacity values are\n estimated based on the consumed read and write capacity of your table and global\n secondary indexes over the past 30 minutes.

\n " + } + }, + "ProvisionedThroughput": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughput", + "traits": { + "smithy.api#documentation": "

The new provisioned throughput settings for the specified table or index.

" + } + }, + "GlobalSecondaryIndexUpdates": { + "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexUpdateList", + "traits": { + "smithy.api#documentation": "

An array of one or more global secondary indexes for the table. For each index in the\n array, you can request one action:

\n \n

You can create or delete only one global secondary index per UpdateTable\n operation.

\n

For more information, see Managing Global\n Secondary Indexes in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "StreamSpecification": { + "target": "com.amazonaws.dynamodb#StreamSpecification", + "traits": { + "smithy.api#documentation": "

Represents the DynamoDB Streams configuration for the table.

\n \n

You receive a ValidationException if you try to enable a stream on a\n table that already has a stream, or if you try to disable a stream on a table that\n doesn't have a stream.

\n " + } + }, + "SSESpecification": { + "target": "com.amazonaws.dynamodb#SSESpecification", + "traits": { + "smithy.api#documentation": "

The new server-side encryption settings for the specified table.

" + } + }, + "ReplicaUpdates": { + "target": "com.amazonaws.dynamodb#ReplicationGroupUpdateList", + "traits": { + "smithy.api#documentation": "

A list of replica update actions (create, delete, or update) for the table.

\n \n

For global tables, this property only applies to global tables using Version\n 2019.11.21 (Current version).

\n " + } + }, + "TableClass": { + "target": "com.amazonaws.dynamodb#TableClass", + "traits": { + "smithy.api#documentation": "

The table class of the table to be updated. Valid values are STANDARD and\n STANDARD_INFREQUENT_ACCESS.

" + } + }, + "DeletionProtectionEnabled": { + "target": "com.amazonaws.dynamodb#DeletionProtectionEnabled", + "traits": { + "smithy.api#documentation": "

Indicates whether deletion protection is to be enabled (true) or disabled (false) on\n the table.

" + } + }, + "MultiRegionConsistency": { + "target": "com.amazonaws.dynamodb#MultiRegionConsistency", + "traits": { + "smithy.api#documentation": "

Specifies the consistency mode for a new global table. This parameter is only valid when you create a global table by specifying one or more Create actions in the ReplicaUpdates action list.

\n

You can specify one of the following consistency modes:

\n \n

If you don't specify this parameter, the global table consistency mode defaults to EVENTUAL.

" + } + }, + "OnDemandThroughput": { + "target": "com.amazonaws.dynamodb#OnDemandThroughput", + "traits": { + "smithy.api#documentation": "

Updates the maximum number of read and write units for the specified table in\n on-demand capacity mode. If you use this parameter, you must specify\n MaxReadRequestUnits, MaxWriteRequestUnits, or both.

" + } + }, + "WarmThroughput": { + "target": "com.amazonaws.dynamodb#WarmThroughput", + "traits": { + "smithy.api#documentation": "

Represents the warm throughput (in read units per second and write units per second) for updating a table.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of an UpdateTable operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#UpdateTableOutput": { + "type": "structure", + "members": { + "TableDescription": { + "target": "com.amazonaws.dynamodb#TableDescription", + "traits": { + "smithy.api#documentation": "

Represents the properties of the table.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of an UpdateTable operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#UpdateTableReplicaAutoScaling": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#UpdateTableReplicaAutoScalingInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#UpdateTableReplicaAutoScalingOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceInUseException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates auto scaling settings on your global tables at once.

\n \n

For global tables, this operation only applies to global tables using Version\n 2019.11.21 (Current version).

\n " + } + }, + "com.amazonaws.dynamodb#UpdateTableReplicaAutoScalingInput": { + "type": "structure", + "members": { + "GlobalSecondaryIndexUpdates": { + "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexAutoScalingUpdateList", + "traits": { + "smithy.api#documentation": "

Represents the auto scaling settings of the global secondary indexes of the replica to\n be updated.

" + } + }, + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The name of the global table to be updated. You can also provide the Amazon Resource Name (ARN) of the\n table in this parameter.

", + "smithy.api#required": {} + } + }, + "ProvisionedWriteCapacityAutoScalingUpdate": { + "target": "com.amazonaws.dynamodb#AutoScalingSettingsUpdate" + }, + "ReplicaUpdates": { + "target": "com.amazonaws.dynamodb#ReplicaAutoScalingUpdateList", + "traits": { + "smithy.api#documentation": "

Represents the auto scaling settings of replicas of the table that will be\n modified.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#UpdateTableReplicaAutoScalingOutput": { + "type": "structure", + "members": { + "TableAutoScalingDescription": { + "target": "com.amazonaws.dynamodb#TableAutoScalingDescription", + "traits": { + "smithy.api#documentation": "

Returns information about the auto scaling settings of a table with replicas.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#UpdateTimeToLive": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#UpdateTimeToLiveInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#UpdateTimeToLiveOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceInUseException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

The UpdateTimeToLive method enables or disables Time to Live (TTL) for\n the specified table. A successful UpdateTimeToLive call returns the current\n TimeToLiveSpecification. It can take up to one hour for the change to\n fully process. Any additional UpdateTimeToLive calls for the same table\n during this one hour duration result in a ValidationException.

\n

TTL compares the current time in epoch time format to the time stored in the TTL\n attribute of an item. If the epoch time value stored in the attribute is less than the\n current time, the item is marked as expired and subsequently deleted.

\n \n

The epoch time format is the number of seconds elapsed since 12:00:00 AM January\n 1, 1970 UTC.

\n \n

DynamoDB deletes expired items on a best-effort basis to ensure availability of\n throughput for other data operations.

\n \n

DynamoDB typically deletes expired items within two days of expiration. The exact\n duration within which an item gets deleted after expiration is specific to the\n nature of the workload. Items that have expired and not been deleted will still show\n up in reads, queries, and scans.

\n \n

As items are deleted, they are removed from any local secondary index and global\n secondary index immediately in the same eventually consistent way as a standard delete\n operation.

\n

For more information, see Time To Live in the\n Amazon DynamoDB Developer Guide.

" + } + }, + "com.amazonaws.dynamodb#UpdateTimeToLiveInput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The name of the table to be configured. You can also provide the Amazon Resource Name (ARN) of the\n table in this parameter.

", + "smithy.api#required": {} + } + }, + "TimeToLiveSpecification": { + "target": "com.amazonaws.dynamodb#TimeToLiveSpecification", + "traits": { + "smithy.api#documentation": "

Represents the settings used to enable or disable Time to Live for the specified\n table.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of an UpdateTimeToLive operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#UpdateTimeToLiveOutput": { + "type": "structure", + "members": { + "TimeToLiveSpecification": { + "target": "com.amazonaws.dynamodb#TimeToLiveSpecification", + "traits": { + "smithy.api#documentation": "

Represents the output of an UpdateTimeToLive operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#WarmThroughput": { + "type": "structure", + "members": { + "ReadUnitsPerSecond": { + "target": "com.amazonaws.dynamodb#LongObject", + "traits": { + "smithy.api#documentation": "

Represents the number of read operations your base table can instantaneously\n support.

" + } + }, + "WriteUnitsPerSecond": { + "target": "com.amazonaws.dynamodb#LongObject", + "traits": { + "smithy.api#documentation": "

Represents the number of write operations your base table can instantaneously\n support.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides visibility into the number of read and write operations your table or\n secondary index can instantaneously support. The settings can be modified using the\n UpdateTable operation to meet the throughput requirements of an\n upcoming peak event.

" + } + }, + "com.amazonaws.dynamodb#WriteRequest": { + "type": "structure", + "members": { + "PutRequest": { + "target": "com.amazonaws.dynamodb#PutRequest", + "traits": { + "smithy.api#documentation": "

A request to perform a PutItem operation.

" + } + }, + "DeleteRequest": { + "target": "com.amazonaws.dynamodb#DeleteRequest", + "traits": { + "smithy.api#documentation": "

A request to perform a DeleteItem operation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents an operation to perform - either DeleteItem or\n PutItem. You can only request one of these operations, not both, in a\n single WriteRequest. If you do need to perform both of these operations,\n you need to provide two separate WriteRequest objects.

" + } + }, + "com.amazonaws.dynamodb#WriteRequests": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#WriteRequest" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + } + } +} \ No newline at end of file diff --git a/pkg/testdata/codegen/sdk-codegen/aws-models/ec2.json b/pkg/testdata/codegen/sdk-codegen/aws-models/ec2.json new file mode 100644 index 00000000..8000ff91 --- /dev/null +++ b/pkg/testdata/codegen/sdk-codegen/aws-models/ec2.json @@ -0,0 +1,115215 @@ +{ + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.ec2#AcceleratorCount": { + "type": "structure", + "members": { + "Min": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Min", + "smithy.api#documentation": "

The minimum number of accelerators. If this parameter is not specified, there is no minimum\n limit.

", + "smithy.api#xmlName": "min" + } + }, + "Max": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Max", + "smithy.api#documentation": "

The maximum number of accelerators. If this parameter is not specified, there is no\n maximum limit.

", + "smithy.api#xmlName": "max" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips)\n on an instance.

" + } + }, + "com.amazonaws.ec2#AcceleratorCountRequest": { + "type": "structure", + "members": { + "Min": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The minimum number of accelerators. To specify no minimum limit, omit this\n parameter.

" + } + }, + "Max": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of accelerators. To specify no maximum limit, omit this\n parameter. To exclude accelerator-enabled instance types, set Max to\n 0.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips)\n on an instance. To exclude accelerator-enabled instance types, set Max to\n 0.

" + } + }, + "com.amazonaws.ec2#AcceleratorManufacturer": { + "type": "enum", + "members": { + "AMAZON_WEB_SERVICES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "amazon-web-services" + } + }, + "AMD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "amd" + } + }, + "NVIDIA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nvidia" + } + }, + "XILINX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "xilinx" + } + }, + "HABANA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "habana" + } + } + } + }, + "com.amazonaws.ec2#AcceleratorManufacturerSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AcceleratorManufacturer", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#AcceleratorName": { + "type": "enum", + "members": { + "A100": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "a100" + } + }, + "INFERENTIA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "inferentia" + } + }, + "K520": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "k520" + } + }, + "K80": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "k80" + } + }, + "M60": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m60" + } + }, + "RADEON_PRO_V520": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "radeon-pro-v520" + } + }, + "T4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t4" + } + }, + "VU9P": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vu9p" + } + }, + "V100": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "v100" + } + }, + "A10G": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "a10g" + } + }, + "H100": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "h100" + } + }, + "T4G": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t4g" + } + } + } + }, + "com.amazonaws.ec2#AcceleratorNameSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AcceleratorName", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#AcceleratorTotalMemoryMiB": { + "type": "structure", + "members": { + "Min": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Min", + "smithy.api#documentation": "

The minimum amount of accelerator memory, in MiB. If this parameter is not specified,\n there is no minimum limit.

", + "smithy.api#xmlName": "min" + } + }, + "Max": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Max", + "smithy.api#documentation": "

The maximum amount of accelerator memory, in MiB. If this parameter is not specified,\n there is no maximum limit.

", + "smithy.api#xmlName": "max" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum and maximum amount of total accelerator memory, in MiB.

" + } + }, + "com.amazonaws.ec2#AcceleratorTotalMemoryMiBRequest": { + "type": "structure", + "members": { + "Min": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The minimum amount of accelerator memory, in MiB. To specify no minimum limit, omit this\n parameter.

" + } + }, + "Max": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum amount of accelerator memory, in MiB. To specify no maximum limit, omit this\n parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum and maximum amount of total accelerator memory, in MiB.

" + } + }, + "com.amazonaws.ec2#AcceleratorType": { + "type": "enum", + "members": { + "GPU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "gpu" + } + }, + "FPGA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fpga" + } + }, + "INFERENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "inference" + } + } + } + }, + "com.amazonaws.ec2#AcceleratorTypeSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AcceleratorType", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#AcceptAddressTransfer": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AcceptAddressTransferRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AcceptAddressTransferResult" + }, + "traits": { + "smithy.api#documentation": "

Accepts an Elastic IP address transfer. For more information, see Accept a transferred Elastic IP address in the Amazon VPC User Guide.

" + } + }, + "com.amazonaws.ec2#AcceptAddressTransferRequest": { + "type": "structure", + "members": { + "Address": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Elastic IP address you are accepting for transfer.

", + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

\n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AcceptAddressTransferResult": { + "type": "structure", + "members": { + "AddressTransfer": { + "target": "com.amazonaws.ec2#AddressTransfer", + "traits": { + "aws.protocols#ec2QueryName": "AddressTransfer", + "smithy.api#documentation": "

An Elastic IP address transfer.

", + "smithy.api#xmlName": "addressTransfer" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AcceptCapacityReservationBillingOwnership": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AcceptCapacityReservationBillingOwnershipRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AcceptCapacityReservationBillingOwnershipResult" + }, + "traits": { + "smithy.api#documentation": "

Accepts a request to assign billing of the available capacity of a shared Capacity\n\t\t\tReservation to your account. For more information, see Billing assignment for shared\n\t\t\t\t\tAmazon EC2 Capacity Reservations.

" + } + }, + "com.amazonaws.ec2#AcceptCapacityReservationBillingOwnershipRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "CapacityReservationId": { + "target": "com.amazonaws.ec2#CapacityReservationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Capacity Reservation for which to accept the request.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AcceptCapacityReservationBillingOwnershipResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AcceptReservedInstancesExchangeQuote": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AcceptReservedInstancesExchangeQuoteRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AcceptReservedInstancesExchangeQuoteResult" + }, + "traits": { + "smithy.api#documentation": "

Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call.

" + } + }, + "com.amazonaws.ec2#AcceptReservedInstancesExchangeQuoteRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ReservedInstanceIds": { + "target": "com.amazonaws.ec2#ReservedInstanceIdSet", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the Convertible Reserved Instances to exchange for another Convertible\n Reserved Instance of the same or higher value.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "ReservedInstanceId" + } + }, + "TargetConfigurations": { + "target": "com.amazonaws.ec2#TargetConfigurationRequestSet", + "traits": { + "smithy.api#documentation": "

The configuration of the target Convertible Reserved Instance to exchange for your\n current Convertible Reserved Instances.

", + "smithy.api#xmlName": "TargetConfiguration" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for accepting the quote.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AcceptReservedInstancesExchangeQuoteResult": { + "type": "structure", + "members": { + "ExchangeId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ExchangeId", + "smithy.api#documentation": "

The ID of the successful exchange.

", + "smithy.api#xmlName": "exchangeId" + } + } + }, + "traits": { + "smithy.api#documentation": "

The result of the exchange and whether it was successful.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AcceptTransitGatewayMulticastDomainAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AcceptTransitGatewayMulticastDomainAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AcceptTransitGatewayMulticastDomainAssociationsResult" + }, + "traits": { + "smithy.api#documentation": "

Accepts a request to associate subnets with a transit gateway multicast domain.

" + } + }, + "com.amazonaws.ec2#AcceptTransitGatewayMulticastDomainAssociationsRequest": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainId", + "traits": { + "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

" + } + }, + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#documentation": "

The ID of the transit gateway attachment.

" + } + }, + "SubnetIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the subnets to associate with the transit gateway multicast domain.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AcceptTransitGatewayMulticastDomainAssociationsResult": { + "type": "structure", + "members": { + "Associations": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainAssociations", + "traits": { + "aws.protocols#ec2QueryName": "Associations", + "smithy.api#documentation": "

Information about the multicast domain associations.

", + "smithy.api#xmlName": "associations" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AcceptTransitGatewayPeeringAttachment": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AcceptTransitGatewayPeeringAttachmentRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AcceptTransitGatewayPeeringAttachmentResult" + }, + "traits": { + "smithy.api#documentation": "

Accepts a transit gateway peering attachment request. The peering attachment must be\n in the pendingAcceptance state.

" + } + }, + "com.amazonaws.ec2#AcceptTransitGatewayPeeringAttachmentRequest": { + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway attachment.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AcceptTransitGatewayPeeringAttachmentResult": { + "type": "structure", + "members": { + "TransitGatewayPeeringAttachment": { + "target": "com.amazonaws.ec2#TransitGatewayPeeringAttachment", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayPeeringAttachment", + "smithy.api#documentation": "

The transit gateway peering attachment.

", + "smithy.api#xmlName": "transitGatewayPeeringAttachment" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AcceptTransitGatewayVpcAttachment": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AcceptTransitGatewayVpcAttachmentRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AcceptTransitGatewayVpcAttachmentResult" + }, + "traits": { + "smithy.api#documentation": "

Accepts a request to attach a VPC to a transit gateway.

\n

The VPC attachment must be in the pendingAcceptance state.\n Use DescribeTransitGatewayVpcAttachments to view your pending VPC attachment requests.\n Use RejectTransitGatewayVpcAttachment to reject a VPC attachment request.

" + } + }, + "com.amazonaws.ec2#AcceptTransitGatewayVpcAttachmentRequest": { + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the attachment.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AcceptTransitGatewayVpcAttachmentResult": { + "type": "structure", + "members": { + "TransitGatewayVpcAttachment": { + "target": "com.amazonaws.ec2#TransitGatewayVpcAttachment", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayVpcAttachment", + "smithy.api#documentation": "

The VPC attachment.

", + "smithy.api#xmlName": "transitGatewayVpcAttachment" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AcceptVpcEndpointConnections": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AcceptVpcEndpointConnectionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AcceptVpcEndpointConnectionsResult" + }, + "traits": { + "smithy.api#documentation": "

Accepts connection requests to your VPC endpoint service.

" + } + }, + "com.amazonaws.ec2#AcceptVpcEndpointConnectionsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ServiceId": { + "target": "com.amazonaws.ec2#VpcEndpointServiceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC endpoint service.

", + "smithy.api#required": {} + } + }, + "VpcEndpointIds": { + "target": "com.amazonaws.ec2#VpcEndpointIdList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the interface VPC endpoints.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "VpcEndpointId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AcceptVpcEndpointConnectionsResult": { + "type": "structure", + "members": { + "Unsuccessful": { + "target": "com.amazonaws.ec2#UnsuccessfulItemSet", + "traits": { + "aws.protocols#ec2QueryName": "Unsuccessful", + "smithy.api#documentation": "

Information about the interface endpoints that were not accepted, if\n applicable.

", + "smithy.api#xmlName": "unsuccessful" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AcceptVpcPeeringConnection": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AcceptVpcPeeringConnectionRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AcceptVpcPeeringConnectionResult" + }, + "traits": { + "smithy.api#documentation": "

Accept a VPC peering connection request. To accept a request, the VPC peering connection must\n be in the pending-acceptance state, and you must be the owner of the peer VPC.\n Use DescribeVpcPeeringConnections to view your outstanding VPC\n peering connection requests.

\n

For an inter-Region VPC peering connection request, you must accept the VPC peering\n connection in the Region of the accepter VPC.

" + } + }, + "com.amazonaws.ec2#AcceptVpcPeeringConnectionRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "VpcPeeringConnectionId": { + "target": "com.amazonaws.ec2#VpcPeeringConnectionIdWithResolver", + "traits": { + "aws.protocols#ec2QueryName": "VpcPeeringConnectionId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC peering connection. You must specify this parameter in the\n\t\t\trequest.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "vpcPeeringConnectionId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AcceptVpcPeeringConnectionResult": { + "type": "structure", + "members": { + "VpcPeeringConnection": { + "target": "com.amazonaws.ec2#VpcPeeringConnection", + "traits": { + "aws.protocols#ec2QueryName": "VpcPeeringConnection", + "smithy.api#documentation": "

Information about the VPC peering connection.

", + "smithy.api#xmlName": "vpcPeeringConnection" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AccessScopeAnalysisFinding": { + "type": "structure", + "members": { + "NetworkInsightsAccessScopeAnalysisId": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysisId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeAnalysisId", + "smithy.api#documentation": "

The ID of the Network Access Scope analysis.

", + "smithy.api#xmlName": "networkInsightsAccessScopeAnalysisId" + } + }, + "NetworkInsightsAccessScopeId": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeId", + "smithy.api#documentation": "

The ID of the Network Access Scope.

", + "smithy.api#xmlName": "networkInsightsAccessScopeId" + } + }, + "FindingId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "FindingId", + "smithy.api#documentation": "

The ID of the finding.

", + "smithy.api#xmlName": "findingId" + } + }, + "FindingComponents": { + "target": "com.amazonaws.ec2#PathComponentList", + "traits": { + "aws.protocols#ec2QueryName": "FindingComponentSet", + "smithy.api#documentation": "

The finding components.

", + "smithy.api#xmlName": "findingComponentSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a finding for a Network Access Scope.

" + } + }, + "com.amazonaws.ec2#AccessScopeAnalysisFindingList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AccessScopeAnalysisFinding", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#AccessScopePath": { + "type": "structure", + "members": { + "Source": { + "target": "com.amazonaws.ec2#PathStatement", + "traits": { + "aws.protocols#ec2QueryName": "Source", + "smithy.api#documentation": "

The source.

", + "smithy.api#xmlName": "source" + } + }, + "Destination": { + "target": "com.amazonaws.ec2#PathStatement", + "traits": { + "aws.protocols#ec2QueryName": "Destination", + "smithy.api#documentation": "

The destination.

", + "smithy.api#xmlName": "destination" + } + }, + "ThroughResources": { + "target": "com.amazonaws.ec2#ThroughResourcesStatementList", + "traits": { + "aws.protocols#ec2QueryName": "ThroughResourceSet", + "smithy.api#documentation": "

The through resources.

", + "smithy.api#xmlName": "throughResourceSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a path.

" + } + }, + "com.amazonaws.ec2#AccessScopePathList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AccessScopePath", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#AccessScopePathListRequest": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AccessScopePathRequest", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#AccessScopePathRequest": { + "type": "structure", + "members": { + "Source": { + "target": "com.amazonaws.ec2#PathStatementRequest", + "traits": { + "smithy.api#documentation": "

The source.

" + } + }, + "Destination": { + "target": "com.amazonaws.ec2#PathStatementRequest", + "traits": { + "smithy.api#documentation": "

The destination.

" + } + }, + "ThroughResources": { + "target": "com.amazonaws.ec2#ThroughResourcesStatementRequestList", + "traits": { + "smithy.api#documentation": "

The through resources.

", + "smithy.api#xmlName": "ThroughResource" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a path.

" + } + }, + "com.amazonaws.ec2#AccountAttribute": { + "type": "structure", + "members": { + "AttributeName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AttributeName", + "smithy.api#documentation": "

The name of the account attribute.

", + "smithy.api#xmlName": "attributeName" + } + }, + "AttributeValues": { + "target": "com.amazonaws.ec2#AccountAttributeValueList", + "traits": { + "aws.protocols#ec2QueryName": "AttributeValueSet", + "smithy.api#documentation": "

The values for the account attribute.

", + "smithy.api#xmlName": "attributeValueSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an account attribute.

" + } + }, + "com.amazonaws.ec2#AccountAttributeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AccountAttribute", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#AccountAttributeName": { + "type": "enum", + "members": { + "supported_platforms": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "supported-platforms" + } + }, + "default_vpc": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "default-vpc" + } + } + } + }, + "com.amazonaws.ec2#AccountAttributeNameStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AccountAttributeName", + "traits": { + "smithy.api#xmlName": "attributeName" + } + } + }, + "com.amazonaws.ec2#AccountAttributeValue": { + "type": "structure", + "members": { + "AttributeValue": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AttributeValue", + "smithy.api#documentation": "

The value of the attribute.

", + "smithy.api#xmlName": "attributeValue" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a value of an account attribute.

" + } + }, + "com.amazonaws.ec2#AccountAttributeValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AccountAttributeValue", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#AccountID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "^[0-9]{12}$" + } + }, + "com.amazonaws.ec2#ActiveInstance": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#xmlName": "instanceId" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type.

", + "smithy.api#xmlName": "instanceType" + } + }, + "SpotInstanceRequestId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SpotInstanceRequestId", + "smithy.api#documentation": "

The ID of the Spot Instance request.

", + "smithy.api#xmlName": "spotInstanceRequestId" + } + }, + "InstanceHealth": { + "target": "com.amazonaws.ec2#InstanceHealthStatus", + "traits": { + "aws.protocols#ec2QueryName": "InstanceHealth", + "smithy.api#documentation": "

The health status of the instance. If the status of either the instance status check\n or the system status check is impaired, the health status of the instance\n is unhealthy. Otherwise, the health status is healthy.

", + "smithy.api#xmlName": "instanceHealth" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a running instance in a Spot Fleet.

" + } + }, + "com.amazonaws.ec2#ActiveInstanceSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ActiveInstance", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ActivityStatus": { + "type": "enum", + "members": { + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "error" + } + }, + "PENDING_FULFILLMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending_fulfillment" + } + }, + "PENDING_TERMINATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending_termination" + } + }, + "FULFILLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fulfilled" + } + } + } + }, + "com.amazonaws.ec2#AddIpamOperatingRegion": { + "type": "structure", + "members": { + "RegionName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the operating Region.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Add an operating Region to an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

\n

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.\n

" + } + }, + "com.amazonaws.ec2#AddIpamOperatingRegionSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AddIpamOperatingRegion" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.ec2#AddIpamOrganizationalUnitExclusion": { + "type": "structure", + "members": { + "OrganizationsEntityPath": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

An Amazon Web Services Organizations entity path. Build the path for the OU(s) using Amazon Web Services Organizations IDs separated by a /. Include all child OUs by ending the path with /*.

\n \n

For more information on how to construct an entity path, see Understand the Amazon Web Services Organizations entity path in the Amazon Web Services Identity and Access Management User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Add an Organizational Unit (OU) exclusion to your IPAM. If your IPAM is integrated with Amazon Web Services Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion. There is a limit on the number of exclusions you can create. For more information, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.

" + } + }, + "com.amazonaws.ec2#AddIpamOrganizationalUnitExclusionSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AddIpamOrganizationalUnitExclusion" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.ec2#AddPrefixListEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AddPrefixListEntry" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.ec2#AddPrefixListEntry": { + "type": "structure", + "members": { + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The CIDR block.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description for the entry.

\n

Constraints: Up to 255 characters in length.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An entry for a prefix list.

" + } + }, + "com.amazonaws.ec2#AddedPrincipal": { + "type": "structure", + "members": { + "PrincipalType": { + "target": "com.amazonaws.ec2#PrincipalType", + "traits": { + "aws.protocols#ec2QueryName": "PrincipalType", + "smithy.api#documentation": "

The type of principal.

", + "smithy.api#xmlName": "principalType" + } + }, + "Principal": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Principal", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the principal.

", + "smithy.api#xmlName": "principal" + } + }, + "ServicePermissionId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ServicePermissionId", + "smithy.api#documentation": "

The ID of the service permission.

", + "smithy.api#xmlName": "servicePermissionId" + } + }, + "ServiceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ServiceId", + "smithy.api#documentation": "

The ID of the service.

", + "smithy.api#xmlName": "serviceId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a principal.

" + } + }, + "com.amazonaws.ec2#AddedPrincipalSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AddedPrincipal", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#AdditionalDetail": { + "type": "structure", + "members": { + "AdditionalDetailType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AdditionalDetailType", + "smithy.api#documentation": "

The additional detail code.

", + "smithy.api#xmlName": "additionalDetailType" + } + }, + "Component": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "Component", + "smithy.api#documentation": "

The path component.

", + "smithy.api#xmlName": "component" + } + }, + "VpcEndpointService": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "VpcEndpointService", + "smithy.api#documentation": "

The VPC endpoint service.

", + "smithy.api#xmlName": "vpcEndpointService" + } + }, + "RuleOptions": { + "target": "com.amazonaws.ec2#RuleOptionList", + "traits": { + "aws.protocols#ec2QueryName": "RuleOptionSet", + "smithy.api#documentation": "

The rule options.

", + "smithy.api#xmlName": "ruleOptionSet" + } + }, + "RuleGroupTypePairs": { + "target": "com.amazonaws.ec2#RuleGroupTypePairList", + "traits": { + "aws.protocols#ec2QueryName": "RuleGroupTypePairSet", + "smithy.api#documentation": "

The rule group type.

", + "smithy.api#xmlName": "ruleGroupTypePairSet" + } + }, + "RuleGroupRuleOptionsPairs": { + "target": "com.amazonaws.ec2#RuleGroupRuleOptionsPairList", + "traits": { + "aws.protocols#ec2QueryName": "RuleGroupRuleOptionsPairSet", + "smithy.api#documentation": "

The rule options.

", + "smithy.api#xmlName": "ruleGroupRuleOptionsPairSet" + } + }, + "ServiceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ServiceName", + "smithy.api#documentation": "

The name of the VPC endpoint service.

", + "smithy.api#xmlName": "serviceName" + } + }, + "LoadBalancers": { + "target": "com.amazonaws.ec2#AnalysisComponentList", + "traits": { + "aws.protocols#ec2QueryName": "LoadBalancerSet", + "smithy.api#documentation": "

The load balancers.

", + "smithy.api#xmlName": "loadBalancerSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an additional detail for a path analysis. For more information, see Reachability Analyzer additional detail codes.

" + } + }, + "com.amazonaws.ec2#AdditionalDetailList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AdditionalDetail", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Address": { + "type": "structure", + "members": { + "AllocationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AllocationId", + "smithy.api#documentation": "

The ID representing the allocation of the address.

", + "smithy.api#xmlName": "allocationId" + } + }, + "AssociationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AssociationId", + "smithy.api#documentation": "

The ID representing the association of the address with an instance.

", + "smithy.api#xmlName": "associationId" + } + }, + "Domain": { + "target": "com.amazonaws.ec2#DomainType", + "traits": { + "aws.protocols#ec2QueryName": "Domain", + "smithy.api#documentation": "

The network (vpc).

", + "smithy.api#xmlName": "domain" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "NetworkInterfaceOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceOwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the network interface.

", + "smithy.api#xmlName": "networkInterfaceOwnerId" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddress", + "smithy.api#documentation": "

The private IP address associated with the Elastic IP address.

", + "smithy.api#xmlName": "privateIpAddress" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the Elastic IP address.

", + "smithy.api#xmlName": "tagSet" + } + }, + "PublicIpv4Pool": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicIpv4Pool", + "smithy.api#documentation": "

The ID of an address pool.

", + "smithy.api#xmlName": "publicIpv4Pool" + } + }, + "NetworkBorderGroup": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkBorderGroup", + "smithy.api#documentation": "

The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from\n which Amazon Web Services advertises IP addresses.

", + "smithy.api#xmlName": "networkBorderGroup" + } + }, + "CustomerOwnedIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CustomerOwnedIp", + "smithy.api#documentation": "

The customer-owned IP address.

", + "smithy.api#xmlName": "customerOwnedIp" + } + }, + "CustomerOwnedIpv4Pool": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CustomerOwnedIpv4Pool", + "smithy.api#documentation": "

The ID of the customer-owned address pool.

", + "smithy.api#xmlName": "customerOwnedIpv4Pool" + } + }, + "CarrierIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CarrierIp", + "smithy.api#documentation": "

The carrier IP address associated. This option is only available for network interfaces\n which reside in a subnet in a Wavelength Zone (for example an EC2 instance).

", + "smithy.api#xmlName": "carrierIp" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance that the address is associated with (if any).

", + "smithy.api#xmlName": "instanceId" + } + }, + "PublicIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicIp", + "smithy.api#documentation": "

The Elastic IP address.

", + "smithy.api#xmlName": "publicIp" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an Elastic IP address, or a carrier IP address.

" + } + }, + "com.amazonaws.ec2#AddressAttribute": { + "type": "structure", + "members": { + "PublicIp": { + "target": "com.amazonaws.ec2#PublicIpAddress", + "traits": { + "aws.protocols#ec2QueryName": "PublicIp", + "smithy.api#documentation": "

The public IP address.

", + "smithy.api#xmlName": "publicIp" + } + }, + "AllocationId": { + "target": "com.amazonaws.ec2#AllocationId", + "traits": { + "aws.protocols#ec2QueryName": "AllocationId", + "smithy.api#documentation": "

[EC2-VPC] The allocation ID.

", + "smithy.api#xmlName": "allocationId" + } + }, + "PtrRecord": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PtrRecord", + "smithy.api#documentation": "

The pointer (PTR) record for the IP address.

", + "smithy.api#xmlName": "ptrRecord" + } + }, + "PtrRecordUpdate": { + "target": "com.amazonaws.ec2#PtrUpdateStatus", + "traits": { + "aws.protocols#ec2QueryName": "PtrRecordUpdate", + "smithy.api#documentation": "

The updated PTR record for the IP address.

", + "smithy.api#xmlName": "ptrRecordUpdate" + } + } + }, + "traits": { + "smithy.api#documentation": "

The attributes associated with an Elastic IP address.

" + } + }, + "com.amazonaws.ec2#AddressAttributeName": { + "type": "enum", + "members": { + "domain_name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "domain-name" + } + } + } + }, + "com.amazonaws.ec2#AddressFamily": { + "type": "enum", + "members": { + "ipv4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv4" + } + }, + "ipv6": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv6" + } + } + } + }, + "com.amazonaws.ec2#AddressList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Address", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#AddressMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#AddressSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AddressAttribute", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#AddressTransfer": { + "type": "structure", + "members": { + "PublicIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicIp", + "smithy.api#documentation": "

The Elastic IP address being transferred.

", + "smithy.api#xmlName": "publicIp" + } + }, + "AllocationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AllocationId", + "smithy.api#documentation": "

The allocation ID of an Elastic IP address.

", + "smithy.api#xmlName": "allocationId" + } + }, + "TransferAccountId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransferAccountId", + "smithy.api#documentation": "

The ID of the account that you want to transfer the Elastic IP address to.

", + "smithy.api#xmlName": "transferAccountId" + } + }, + "TransferOfferExpirationTimestamp": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "TransferOfferExpirationTimestamp", + "smithy.api#documentation": "

The timestamp when the Elastic IP address transfer expired. When the source account starts\n the transfer, the transfer account has seven hours to allocate the Elastic IP address to\n complete the transfer, or the Elastic IP address will return to its original owner.

", + "smithy.api#xmlName": "transferOfferExpirationTimestamp" + } + }, + "TransferOfferAcceptedTimestamp": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "TransferOfferAcceptedTimestamp", + "smithy.api#documentation": "

The timestamp when the Elastic IP address transfer was accepted.

", + "smithy.api#xmlName": "transferOfferAcceptedTimestamp" + } + }, + "AddressTransferStatus": { + "target": "com.amazonaws.ec2#AddressTransferStatus", + "traits": { + "aws.protocols#ec2QueryName": "AddressTransferStatus", + "smithy.api#documentation": "

The Elastic IP address transfer status.

", + "smithy.api#xmlName": "addressTransferStatus" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details on the Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon VPC User Guide.

" + } + }, + "com.amazonaws.ec2#AddressTransferList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AddressTransfer", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#AddressTransferStatus": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + }, + "accepted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "accepted" + } + } + } + }, + "com.amazonaws.ec2#AdvertiseByoipCidr": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AdvertiseByoipCidrRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AdvertiseByoipCidrResult" + }, + "traits": { + "smithy.api#documentation": "

Advertises an IPv4 or IPv6 address range that is provisioned for use with your Amazon Web Services resources through \n bring your own IP addresses (BYOIP).

\n

You can perform this operation at most once every 10 seconds, even if you specify different \n address ranges each time.

\n

We recommend that you stop advertising the BYOIP CIDR from other locations when you advertise\n it from Amazon Web Services. To minimize down time, you can configure your Amazon Web Services resources to use an address from a\n BYOIP CIDR before it is advertised, and then simultaneously stop advertising it from the current \n location and start advertising it through Amazon Web Services.

\n

It can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services\n because of BGP propagation delays.

\n

To stop advertising the BYOIP CIDR, use WithdrawByoipCidr.

" + } + }, + "com.amazonaws.ec2#AdvertiseByoipCidrRequest": { + "type": "structure", + "members": { + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The address range, in CIDR notation. This must be the exact range that you provisioned. \n You can't advertise only a portion of the provisioned range.

", + "smithy.api#required": {} + } + }, + "Asn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The public 2-byte or 4-byte ASN that you want to advertise.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "NetworkBorderGroup": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

If you have Local Zones enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR. Choose the network border group carefully as the EIP and the Amazon Web Services resource it is associated with must reside in the same network border group.

\n

You can provision BYOIP address ranges to and advertise them in the following Local Zone network border groups:

\n \n \n

You cannot provision or advertise BYOIPv6 address ranges in Local Zones at this time.

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AdvertiseByoipCidrResult": { + "type": "structure", + "members": { + "ByoipCidr": { + "target": "com.amazonaws.ec2#ByoipCidr", + "traits": { + "aws.protocols#ec2QueryName": "ByoipCidr", + "smithy.api#documentation": "

Information about the address range.

", + "smithy.api#xmlName": "byoipCidr" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#Affinity": { + "type": "enum", + "members": { + "default": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "default" + } + }, + "host": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "host" + } + } + } + }, + "com.amazonaws.ec2#AllocateAddress": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AllocateAddressRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AllocateAddressResult" + }, + "traits": { + "smithy.api#documentation": "

Allocates an Elastic IP address to your Amazon Web Services account. After you allocate the Elastic IP address you can associate \n it with an instance or network interface. After you release an Elastic IP address, it is released to the IP address \n pool and can be allocated to a different Amazon Web Services account.

\n

You can allocate an Elastic IP address from an address pool owned by Amazon Web Services or from an address pool created \n from a public IPv4 address range that you have brought to Amazon Web Services for use with your Amazon Web Services resources using bring your own \n IP addresses (BYOIP). For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon EC2 User Guide.

\n

If you release an Elastic IP address, you might be able to recover it. You cannot recover\n an Elastic IP address that you released after it is allocated to another Amazon Web Services account. To attempt to recover an Elastic IP address that you released, specify\n it in this operation.

\n

For more information, see Elastic IP Addresses in the Amazon EC2 User Guide.

\n

You can allocate a carrier IP address which is a public IP address from a telecommunication carrier, \n to a network interface which resides in a subnet in a Wavelength Zone (for example an EC2 instance).

", + "smithy.api#examples": [ + { + "title": "To allocate an Elastic IP address", + "documentation": "This example allocates an Elastic IP address.", + "output": { + "PublicIp": "203.0.113.0", + "AllocationId": "eipalloc-64d5890a", + "PublicIpv4Pool": "amazon", + "NetworkBorderGroup": "us-east-1", + "Domain": "vpc" + } + } + ] + } + }, + "com.amazonaws.ec2#AllocateAddressRequest": { + "type": "structure", + "members": { + "Domain": { + "target": "com.amazonaws.ec2#DomainType", + "traits": { + "smithy.api#documentation": "

The network (vpc).

" + } + }, + "Address": { + "target": "com.amazonaws.ec2#PublicIpAddress", + "traits": { + "smithy.api#documentation": "

The Elastic IP address to recover or an IPv4 address from an address pool.

" + } + }, + "PublicIpv4Pool": { + "target": "com.amazonaws.ec2#Ipv4PoolEc2Id", + "traits": { + "smithy.api#documentation": "

The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool.\n To specify a specific address from the address pool, use the Address parameter instead.

" + } + }, + "NetworkBorderGroup": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services\n advertises IP addresses. Use this parameter to limit the IP address to this location. IP\n addresses cannot move between network border groups.

" + } + }, + "CustomerOwnedIpv4Pool": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 \n select an address from the address pool. Alternatively, specify a specific \n address from the address pool.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to the Elastic IP address.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "smithy.api#documentation": "

The ID of an IPAM pool which has an Amazon-provided or BYOIP public IPv4 CIDR provisioned to it. For more information, see Allocate sequential Elastic IP addresses from an IPAM pool in the Amazon VPC IPAM User Guide.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AllocateAddressResult": { + "type": "structure", + "members": { + "AllocationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AllocationId", + "smithy.api#documentation": "

The ID that represents the allocation of the Elastic IP address.

", + "smithy.api#xmlName": "allocationId" + } + }, + "PublicIpv4Pool": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicIpv4Pool", + "smithy.api#documentation": "

The ID of an address pool.

", + "smithy.api#xmlName": "publicIpv4Pool" + } + }, + "NetworkBorderGroup": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkBorderGroup", + "smithy.api#documentation": "

The set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises\n IP addresses.

", + "smithy.api#xmlName": "networkBorderGroup" + } + }, + "Domain": { + "target": "com.amazonaws.ec2#DomainType", + "traits": { + "aws.protocols#ec2QueryName": "Domain", + "smithy.api#documentation": "

The network (vpc).

", + "smithy.api#xmlName": "domain" + } + }, + "CustomerOwnedIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CustomerOwnedIp", + "smithy.api#documentation": "

The customer-owned IP address.

", + "smithy.api#xmlName": "customerOwnedIp" + } + }, + "CustomerOwnedIpv4Pool": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CustomerOwnedIpv4Pool", + "smithy.api#documentation": "

The ID of the customer-owned address pool.

", + "smithy.api#xmlName": "customerOwnedIpv4Pool" + } + }, + "CarrierIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CarrierIp", + "smithy.api#documentation": "

The carrier IP address. This option is only available for network interfaces that reside\n in a subnet in a Wavelength Zone.

", + "smithy.api#xmlName": "carrierIp" + } + }, + "PublicIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicIp", + "smithy.api#documentation": "

The Elastic IP address.

", + "smithy.api#xmlName": "publicIp" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AllocateHosts": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AllocateHostsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AllocateHostsResult" + }, + "traits": { + "smithy.api#documentation": "

Allocates a Dedicated Host to your account. At a minimum, specify the supported\n instance type or instance family, the Availability Zone in which to allocate the host,\n and the number of hosts to allocate.

" + } + }, + "com.amazonaws.ec2#AllocateHostsRequest": { + "type": "structure", + "members": { + "InstanceFamily": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Specifies the instance family to be supported by the Dedicated Hosts. If you specify\n an instance family, the Dedicated Hosts support multiple instance types within that\n instance family.

\n

If you want the Dedicated Hosts to support a specific instance type only, omit this\n parameter and specify InstanceType instead. You cannot\n specify InstanceFamily and InstanceType in the same request.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the Dedicated Host during creation.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "HostRecovery": { + "target": "com.amazonaws.ec2#HostRecovery", + "traits": { + "smithy.api#documentation": "

Indicates whether to enable or disable host recovery for the Dedicated Host. Host\n recovery is disabled by default. For more information, see Host recovery\n in the Amazon EC2 User Guide.

\n

Default: off\n

" + } + }, + "OutpostArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate\n the Dedicated Host. If you specify OutpostArn, you can \n optionally specify AssetIds.

\n

If you are allocating the Dedicated Host in a Region, omit this parameter.

" + } + }, + "HostMaintenance": { + "target": "com.amazonaws.ec2#HostMaintenance", + "traits": { + "smithy.api#documentation": "

Indicates whether to enable or disable host maintenance for the Dedicated Host. For\n more information, see Host\n maintenance in the Amazon EC2 User Guide.

" + } + }, + "AssetIds": { + "target": "com.amazonaws.ec2#AssetIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the Outpost hardware assets on which to allocate the Dedicated Hosts. Targeting \n specific hardware assets on an Outpost can help to minimize latency between your workloads. \n This parameter is supported only if you specify OutpostArn. \n If you are allocating the Dedicated Hosts in a Region, omit this parameter.

\n ", + "smithy.api#xmlName": "AssetId" + } + }, + "AutoPlacement": { + "target": "com.amazonaws.ec2#AutoPlacement", + "traits": { + "aws.protocols#ec2QueryName": "AutoPlacement", + "smithy.api#documentation": "

Indicates whether the host accepts any untargeted instance launches that match its\n instance type configuration, or if it only accepts Host tenancy instance launches that\n specify its unique host ID. For more information, see Understanding auto-placement and affinity in the\n Amazon EC2 User Guide.

\n

Default: off\n

", + "smithy.api#xmlName": "autoPlacement" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

", + "smithy.api#xmlName": "clientToken" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

Specifies the instance type to be supported by the Dedicated Hosts. If you specify an\n instance type, the Dedicated Hosts support instances of the specified instance type\n only.

\n

If you want the Dedicated Hosts to support multiple instance types in a specific\n instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the\n same request.

", + "smithy.api#xmlName": "instanceType" + } + }, + "Quantity": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Quantity", + "smithy.api#documentation": "

The number of Dedicated Hosts to allocate to your account with these parameters. If you are \n allocating the Dedicated Hosts on an Outpost, and you specify AssetIds, \n you can omit this parameter. In this case, Amazon EC2 allocates a Dedicated Host on each \n specified hardware asset. If you specify both AssetIds and \n Quantity, then the value that you specify for \n Quantity must be equal to the number of asset IDs specified.

", + "smithy.api#xmlName": "quantity" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Availability Zone in which to allocate the Dedicated Host.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "availabilityZone" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AllocateHostsResult": { + "type": "structure", + "members": { + "HostIds": { + "target": "com.amazonaws.ec2#ResponseHostIdList", + "traits": { + "aws.protocols#ec2QueryName": "HostIdSet", + "smithy.api#documentation": "

The ID of the allocated Dedicated Host. This is used to launch an instance onto a\n specific host.

", + "smithy.api#xmlName": "hostIdSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of AllocateHosts.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AllocateIpamPoolCidr": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AllocateIpamPoolCidrRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AllocateIpamPoolCidrResult" + }, + "traits": { + "smithy.api#documentation": "

Allocate a CIDR from an IPAM pool. The Region you use should be the IPAM pool locale. The locale is the Amazon Web Services Region where this IPAM pool is available for allocations.

\n

In IPAM, an allocation is a CIDR assignment from an IPAM pool to another IPAM pool or to a resource. For more information, see Allocate CIDRs in the Amazon VPC IPAM User Guide.

\n \n

This action creates an allocation with strong consistency. The returned CIDR will not overlap with any other allocations from the same pool.

\n " + } + }, + "com.amazonaws.ec2#AllocateIpamPoolCidrRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the IPAM pool from which you would like to allocate a CIDR.

", + "smithy.api#required": {} + } + }, + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The CIDR you would like to allocate from the IPAM pool. Note the following:

\n \n

Possible values: Any available IPv4 or IPv6 CIDR.

" + } + }, + "NetmaskLength": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The netmask length of the CIDR you would like to allocate from the IPAM pool. Note the following:

\n \n

Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description for the allocation.

" + } + }, + "PreviewNextCidr": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A preview of the next available CIDR in a pool.

" + } + }, + "AllowedCidrs": { + "target": "com.amazonaws.ec2#IpamPoolAllocationAllowedCidrs", + "traits": { + "smithy.api#documentation": "

Include a particular CIDR range that can be returned by the pool. Allowed CIDRs are only allowed if using netmask length for allocation.

", + "smithy.api#xmlName": "AllowedCidr" + } + }, + "DisallowedCidrs": { + "target": "com.amazonaws.ec2#IpamPoolAllocationDisallowedCidrs", + "traits": { + "smithy.api#documentation": "

Exclude a particular CIDR range from being returned by the pool. Disallowed CIDRs are only allowed if using netmask length for allocation.

", + "smithy.api#xmlName": "DisallowedCidr" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AllocateIpamPoolCidrResult": { + "type": "structure", + "members": { + "IpamPoolAllocation": { + "target": "com.amazonaws.ec2#IpamPoolAllocation", + "traits": { + "aws.protocols#ec2QueryName": "IpamPoolAllocation", + "smithy.api#documentation": "

Information about the allocation created.

", + "smithy.api#xmlName": "ipamPoolAllocation" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AllocationId": { + "type": "string" + }, + "com.amazonaws.ec2#AllocationIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AllocationId", + "traits": { + "smithy.api#xmlName": "AllocationId" + } + } + }, + "com.amazonaws.ec2#AllocationIds": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AllocationId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#AllocationState": { + "type": "enum", + "members": { + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "under_assessment": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "under-assessment" + } + }, + "permanent_failure": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "permanent-failure" + } + }, + "released": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "released" + } + }, + "released_permanent_failure": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "released-permanent-failure" + } + }, + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + } + } + }, + "com.amazonaws.ec2#AllocationStrategy": { + "type": "enum", + "members": { + "LOWEST_PRICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "lowestPrice" + } + }, + "DIVERSIFIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "diversified" + } + }, + "CAPACITY_OPTIMIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "capacityOptimized" + } + }, + "CAPACITY_OPTIMIZED_PRIORITIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "capacityOptimizedPrioritized" + } + }, + "PRICE_CAPACITY_OPTIMIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "priceCapacityOptimized" + } + } + } + }, + "com.amazonaws.ec2#AllocationType": { + "type": "enum", + "members": { + "used": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "used" + } + } + } + }, + "com.amazonaws.ec2#AllowedImagesSettingsDisabledState": { + "type": "enum", + "members": { + "disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + } + } + }, + "com.amazonaws.ec2#AllowedImagesSettingsEnabledState": { + "type": "enum", + "members": { + "enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + }, + "audit_mode": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "audit-mode" + } + } + } + }, + "com.amazonaws.ec2#AllowedInstanceType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 30 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\.\\*\\-]+$" + } + }, + "com.amazonaws.ec2#AllowedInstanceTypeSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AllowedInstanceType", + "traits": { + "smithy.api#xmlName": "item" + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 400 + } + } + }, + "com.amazonaws.ec2#AllowedPrincipal": { + "type": "structure", + "members": { + "PrincipalType": { + "target": "com.amazonaws.ec2#PrincipalType", + "traits": { + "aws.protocols#ec2QueryName": "PrincipalType", + "smithy.api#documentation": "

The type of principal.

", + "smithy.api#xmlName": "principalType" + } + }, + "Principal": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Principal", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the principal.

", + "smithy.api#xmlName": "principal" + } + }, + "ServicePermissionId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ServicePermissionId", + "smithy.api#documentation": "

The ID of the service permission.

", + "smithy.api#xmlName": "servicePermissionId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags.

", + "smithy.api#xmlName": "tagSet" + } + }, + "ServiceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ServiceId", + "smithy.api#documentation": "

The ID of the service.

", + "smithy.api#xmlName": "serviceId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a principal.

" + } + }, + "com.amazonaws.ec2#AllowedPrincipalSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AllowedPrincipal", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#AllowsMultipleInstanceTypes": { + "type": "enum", + "members": { + "on": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "on" + } + }, + "off": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "off" + } + } + } + }, + "com.amazonaws.ec2#AlternatePathHint": { + "type": "structure", + "members": { + "ComponentId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ComponentId", + "smithy.api#documentation": "

The ID of the component.

", + "smithy.api#xmlName": "componentId" + } + }, + "ComponentArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ComponentArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component.

", + "smithy.api#xmlName": "componentArn" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an potential intermediate component of a feasible path.

" + } + }, + "com.amazonaws.ec2#AlternatePathHintList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AlternatePathHint", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#AmazonEC2": { + "type": "service", + "version": "2016-11-15", + "operations": [ + { + "target": "com.amazonaws.ec2#AcceptAddressTransfer" + }, + { + "target": "com.amazonaws.ec2#AcceptCapacityReservationBillingOwnership" + }, + { + "target": "com.amazonaws.ec2#AcceptReservedInstancesExchangeQuote" + }, + { + "target": "com.amazonaws.ec2#AcceptTransitGatewayMulticastDomainAssociations" + }, + { + "target": "com.amazonaws.ec2#AcceptTransitGatewayPeeringAttachment" + }, + { + "target": "com.amazonaws.ec2#AcceptTransitGatewayVpcAttachment" + }, + { + "target": "com.amazonaws.ec2#AcceptVpcEndpointConnections" + }, + { + "target": "com.amazonaws.ec2#AcceptVpcPeeringConnection" + }, + { + "target": "com.amazonaws.ec2#AdvertiseByoipCidr" + }, + { + "target": "com.amazonaws.ec2#AllocateAddress" + }, + { + "target": "com.amazonaws.ec2#AllocateHosts" + }, + { + "target": "com.amazonaws.ec2#AllocateIpamPoolCidr" + }, + { + "target": "com.amazonaws.ec2#ApplySecurityGroupsToClientVpnTargetNetwork" + }, + { + "target": "com.amazonaws.ec2#AssignIpv6Addresses" + }, + { + "target": "com.amazonaws.ec2#AssignPrivateIpAddresses" + }, + { + "target": "com.amazonaws.ec2#AssignPrivateNatGatewayAddress" + }, + { + "target": "com.amazonaws.ec2#AssociateAddress" + }, + { + "target": "com.amazonaws.ec2#AssociateCapacityReservationBillingOwner" + }, + { + "target": "com.amazonaws.ec2#AssociateClientVpnTargetNetwork" + }, + { + "target": "com.amazonaws.ec2#AssociateDhcpOptions" + }, + { + "target": "com.amazonaws.ec2#AssociateEnclaveCertificateIamRole" + }, + { + "target": "com.amazonaws.ec2#AssociateIamInstanceProfile" + }, + { + "target": "com.amazonaws.ec2#AssociateInstanceEventWindow" + }, + { + "target": "com.amazonaws.ec2#AssociateIpamByoasn" + }, + { + "target": "com.amazonaws.ec2#AssociateIpamResourceDiscovery" + }, + { + "target": "com.amazonaws.ec2#AssociateNatGatewayAddress" + }, + { + "target": "com.amazonaws.ec2#AssociateRouteTable" + }, + { + "target": "com.amazonaws.ec2#AssociateSecurityGroupVpc" + }, + { + "target": "com.amazonaws.ec2#AssociateSubnetCidrBlock" + }, + { + "target": "com.amazonaws.ec2#AssociateTransitGatewayMulticastDomain" + }, + { + "target": "com.amazonaws.ec2#AssociateTransitGatewayPolicyTable" + }, + { + "target": "com.amazonaws.ec2#AssociateTransitGatewayRouteTable" + }, + { + "target": "com.amazonaws.ec2#AssociateTrunkInterface" + }, + { + "target": "com.amazonaws.ec2#AssociateVpcCidrBlock" + }, + { + "target": "com.amazonaws.ec2#AttachClassicLinkVpc" + }, + { + "target": "com.amazonaws.ec2#AttachInternetGateway" + }, + { + "target": "com.amazonaws.ec2#AttachNetworkInterface" + }, + { + "target": "com.amazonaws.ec2#AttachVerifiedAccessTrustProvider" + }, + { + "target": "com.amazonaws.ec2#AttachVolume" + }, + { + "target": "com.amazonaws.ec2#AttachVpnGateway" + }, + { + "target": "com.amazonaws.ec2#AuthorizeClientVpnIngress" + }, + { + "target": "com.amazonaws.ec2#AuthorizeSecurityGroupEgress" + }, + { + "target": "com.amazonaws.ec2#AuthorizeSecurityGroupIngress" + }, + { + "target": "com.amazonaws.ec2#BundleInstance" + }, + { + "target": "com.amazonaws.ec2#CancelBundleTask" + }, + { + "target": "com.amazonaws.ec2#CancelCapacityReservation" + }, + { + "target": "com.amazonaws.ec2#CancelCapacityReservationFleets" + }, + { + "target": "com.amazonaws.ec2#CancelConversionTask" + }, + { + "target": "com.amazonaws.ec2#CancelDeclarativePoliciesReport" + }, + { + "target": "com.amazonaws.ec2#CancelExportTask" + }, + { + "target": "com.amazonaws.ec2#CancelImageLaunchPermission" + }, + { + "target": "com.amazonaws.ec2#CancelImportTask" + }, + { + "target": "com.amazonaws.ec2#CancelReservedInstancesListing" + }, + { + "target": "com.amazonaws.ec2#CancelSpotFleetRequests" + }, + { + "target": "com.amazonaws.ec2#CancelSpotInstanceRequests" + }, + { + "target": "com.amazonaws.ec2#ConfirmProductInstance" + }, + { + "target": "com.amazonaws.ec2#CopyFpgaImage" + }, + { + "target": "com.amazonaws.ec2#CopyImage" + }, + { + "target": "com.amazonaws.ec2#CopySnapshot" + }, + { + "target": "com.amazonaws.ec2#CreateCapacityReservation" + }, + { + "target": "com.amazonaws.ec2#CreateCapacityReservationBySplitting" + }, + { + "target": "com.amazonaws.ec2#CreateCapacityReservationFleet" + }, + { + "target": "com.amazonaws.ec2#CreateCarrierGateway" + }, + { + "target": "com.amazonaws.ec2#CreateClientVpnEndpoint" + }, + { + "target": "com.amazonaws.ec2#CreateClientVpnRoute" + }, + { + "target": "com.amazonaws.ec2#CreateCoipCidr" + }, + { + "target": "com.amazonaws.ec2#CreateCoipPool" + }, + { + "target": "com.amazonaws.ec2#CreateCustomerGateway" + }, + { + "target": "com.amazonaws.ec2#CreateDefaultSubnet" + }, + { + "target": "com.amazonaws.ec2#CreateDefaultVpc" + }, + { + "target": "com.amazonaws.ec2#CreateDhcpOptions" + }, + { + "target": "com.amazonaws.ec2#CreateEgressOnlyInternetGateway" + }, + { + "target": "com.amazonaws.ec2#CreateFleet" + }, + { + "target": "com.amazonaws.ec2#CreateFlowLogs" + }, + { + "target": "com.amazonaws.ec2#CreateFpgaImage" + }, + { + "target": "com.amazonaws.ec2#CreateImage" + }, + { + "target": "com.amazonaws.ec2#CreateInstanceConnectEndpoint" + }, + { + "target": "com.amazonaws.ec2#CreateInstanceEventWindow" + }, + { + "target": "com.amazonaws.ec2#CreateInstanceExportTask" + }, + { + "target": "com.amazonaws.ec2#CreateInternetGateway" + }, + { + "target": "com.amazonaws.ec2#CreateIpam" + }, + { + "target": "com.amazonaws.ec2#CreateIpamExternalResourceVerificationToken" + }, + { + "target": "com.amazonaws.ec2#CreateIpamPool" + }, + { + "target": "com.amazonaws.ec2#CreateIpamResourceDiscovery" + }, + { + "target": "com.amazonaws.ec2#CreateIpamScope" + }, + { + "target": "com.amazonaws.ec2#CreateKeyPair" + }, + { + "target": "com.amazonaws.ec2#CreateLaunchTemplate" + }, + { + "target": "com.amazonaws.ec2#CreateLaunchTemplateVersion" + }, + { + "target": "com.amazonaws.ec2#CreateLocalGatewayRoute" + }, + { + "target": "com.amazonaws.ec2#CreateLocalGatewayRouteTable" + }, + { + "target": "com.amazonaws.ec2#CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation" + }, + { + "target": "com.amazonaws.ec2#CreateLocalGatewayRouteTableVpcAssociation" + }, + { + "target": "com.amazonaws.ec2#CreateManagedPrefixList" + }, + { + "target": "com.amazonaws.ec2#CreateNatGateway" + }, + { + "target": "com.amazonaws.ec2#CreateNetworkAcl" + }, + { + "target": "com.amazonaws.ec2#CreateNetworkAclEntry" + }, + { + "target": "com.amazonaws.ec2#CreateNetworkInsightsAccessScope" + }, + { + "target": "com.amazonaws.ec2#CreateNetworkInsightsPath" + }, + { + "target": "com.amazonaws.ec2#CreateNetworkInterface" + }, + { + "target": "com.amazonaws.ec2#CreateNetworkInterfacePermission" + }, + { + "target": "com.amazonaws.ec2#CreatePlacementGroup" + }, + { + "target": "com.amazonaws.ec2#CreatePublicIpv4Pool" + }, + { + "target": "com.amazonaws.ec2#CreateReplaceRootVolumeTask" + }, + { + "target": "com.amazonaws.ec2#CreateReservedInstancesListing" + }, + { + "target": "com.amazonaws.ec2#CreateRestoreImageTask" + }, + { + "target": "com.amazonaws.ec2#CreateRoute" + }, + { + "target": "com.amazonaws.ec2#CreateRouteTable" + }, + { + "target": "com.amazonaws.ec2#CreateSecurityGroup" + }, + { + "target": "com.amazonaws.ec2#CreateSnapshot" + }, + { + "target": "com.amazonaws.ec2#CreateSnapshots" + }, + { + "target": "com.amazonaws.ec2#CreateSpotDatafeedSubscription" + }, + { + "target": "com.amazonaws.ec2#CreateStoreImageTask" + }, + { + "target": "com.amazonaws.ec2#CreateSubnet" + }, + { + "target": "com.amazonaws.ec2#CreateSubnetCidrReservation" + }, + { + "target": "com.amazonaws.ec2#CreateTags" + }, + { + "target": "com.amazonaws.ec2#CreateTrafficMirrorFilter" + }, + { + "target": "com.amazonaws.ec2#CreateTrafficMirrorFilterRule" + }, + { + "target": "com.amazonaws.ec2#CreateTrafficMirrorSession" + }, + { + "target": "com.amazonaws.ec2#CreateTrafficMirrorTarget" + }, + { + "target": "com.amazonaws.ec2#CreateTransitGateway" + }, + { + "target": "com.amazonaws.ec2#CreateTransitGatewayConnect" + }, + { + "target": "com.amazonaws.ec2#CreateTransitGatewayConnectPeer" + }, + { + "target": "com.amazonaws.ec2#CreateTransitGatewayMulticastDomain" + }, + { + "target": "com.amazonaws.ec2#CreateTransitGatewayPeeringAttachment" + }, + { + "target": "com.amazonaws.ec2#CreateTransitGatewayPolicyTable" + }, + { + "target": "com.amazonaws.ec2#CreateTransitGatewayPrefixListReference" + }, + { + "target": "com.amazonaws.ec2#CreateTransitGatewayRoute" + }, + { + "target": "com.amazonaws.ec2#CreateTransitGatewayRouteTable" + }, + { + "target": "com.amazonaws.ec2#CreateTransitGatewayRouteTableAnnouncement" + }, + { + "target": "com.amazonaws.ec2#CreateTransitGatewayVpcAttachment" + }, + { + "target": "com.amazonaws.ec2#CreateVerifiedAccessEndpoint" + }, + { + "target": "com.amazonaws.ec2#CreateVerifiedAccessGroup" + }, + { + "target": "com.amazonaws.ec2#CreateVerifiedAccessInstance" + }, + { + "target": "com.amazonaws.ec2#CreateVerifiedAccessTrustProvider" + }, + { + "target": "com.amazonaws.ec2#CreateVolume" + }, + { + "target": "com.amazonaws.ec2#CreateVpc" + }, + { + "target": "com.amazonaws.ec2#CreateVpcBlockPublicAccessExclusion" + }, + { + "target": "com.amazonaws.ec2#CreateVpcEndpoint" + }, + { + "target": "com.amazonaws.ec2#CreateVpcEndpointConnectionNotification" + }, + { + "target": "com.amazonaws.ec2#CreateVpcEndpointServiceConfiguration" + }, + { + "target": "com.amazonaws.ec2#CreateVpcPeeringConnection" + }, + { + "target": "com.amazonaws.ec2#CreateVpnConnection" + }, + { + "target": "com.amazonaws.ec2#CreateVpnConnectionRoute" + }, + { + "target": "com.amazonaws.ec2#CreateVpnGateway" + }, + { + "target": "com.amazonaws.ec2#DeleteCarrierGateway" + }, + { + "target": "com.amazonaws.ec2#DeleteClientVpnEndpoint" + }, + { + "target": "com.amazonaws.ec2#DeleteClientVpnRoute" + }, + { + "target": "com.amazonaws.ec2#DeleteCoipCidr" + }, + { + "target": "com.amazonaws.ec2#DeleteCoipPool" + }, + { + "target": "com.amazonaws.ec2#DeleteCustomerGateway" + }, + { + "target": "com.amazonaws.ec2#DeleteDhcpOptions" + }, + { + "target": "com.amazonaws.ec2#DeleteEgressOnlyInternetGateway" + }, + { + "target": "com.amazonaws.ec2#DeleteFleets" + }, + { + "target": "com.amazonaws.ec2#DeleteFlowLogs" + }, + { + "target": "com.amazonaws.ec2#DeleteFpgaImage" + }, + { + "target": "com.amazonaws.ec2#DeleteInstanceConnectEndpoint" + }, + { + "target": "com.amazonaws.ec2#DeleteInstanceEventWindow" + }, + { + "target": "com.amazonaws.ec2#DeleteInternetGateway" + }, + { + "target": "com.amazonaws.ec2#DeleteIpam" + }, + { + "target": "com.amazonaws.ec2#DeleteIpamExternalResourceVerificationToken" + }, + { + "target": "com.amazonaws.ec2#DeleteIpamPool" + }, + { + "target": "com.amazonaws.ec2#DeleteIpamResourceDiscovery" + }, + { + "target": "com.amazonaws.ec2#DeleteIpamScope" + }, + { + "target": "com.amazonaws.ec2#DeleteKeyPair" + }, + { + "target": "com.amazonaws.ec2#DeleteLaunchTemplate" + }, + { + "target": "com.amazonaws.ec2#DeleteLaunchTemplateVersions" + }, + { + "target": "com.amazonaws.ec2#DeleteLocalGatewayRoute" + }, + { + "target": "com.amazonaws.ec2#DeleteLocalGatewayRouteTable" + }, + { + "target": "com.amazonaws.ec2#DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation" + }, + { + "target": "com.amazonaws.ec2#DeleteLocalGatewayRouteTableVpcAssociation" + }, + { + "target": "com.amazonaws.ec2#DeleteManagedPrefixList" + }, + { + "target": "com.amazonaws.ec2#DeleteNatGateway" + }, + { + "target": "com.amazonaws.ec2#DeleteNetworkAcl" + }, + { + "target": "com.amazonaws.ec2#DeleteNetworkAclEntry" + }, + { + "target": "com.amazonaws.ec2#DeleteNetworkInsightsAccessScope" + }, + { + "target": "com.amazonaws.ec2#DeleteNetworkInsightsAccessScopeAnalysis" + }, + { + "target": "com.amazonaws.ec2#DeleteNetworkInsightsAnalysis" + }, + { + "target": "com.amazonaws.ec2#DeleteNetworkInsightsPath" + }, + { + "target": "com.amazonaws.ec2#DeleteNetworkInterface" + }, + { + "target": "com.amazonaws.ec2#DeleteNetworkInterfacePermission" + }, + { + "target": "com.amazonaws.ec2#DeletePlacementGroup" + }, + { + "target": "com.amazonaws.ec2#DeletePublicIpv4Pool" + }, + { + "target": "com.amazonaws.ec2#DeleteQueuedReservedInstances" + }, + { + "target": "com.amazonaws.ec2#DeleteRoute" + }, + { + "target": "com.amazonaws.ec2#DeleteRouteTable" + }, + { + "target": "com.amazonaws.ec2#DeleteSecurityGroup" + }, + { + "target": "com.amazonaws.ec2#DeleteSnapshot" + }, + { + "target": "com.amazonaws.ec2#DeleteSpotDatafeedSubscription" + }, + { + "target": "com.amazonaws.ec2#DeleteSubnet" + }, + { + "target": "com.amazonaws.ec2#DeleteSubnetCidrReservation" + }, + { + "target": "com.amazonaws.ec2#DeleteTags" + }, + { + "target": "com.amazonaws.ec2#DeleteTrafficMirrorFilter" + }, + { + "target": "com.amazonaws.ec2#DeleteTrafficMirrorFilterRule" + }, + { + "target": "com.amazonaws.ec2#DeleteTrafficMirrorSession" + }, + { + "target": "com.amazonaws.ec2#DeleteTrafficMirrorTarget" + }, + { + "target": "com.amazonaws.ec2#DeleteTransitGateway" + }, + { + "target": "com.amazonaws.ec2#DeleteTransitGatewayConnect" + }, + { + "target": "com.amazonaws.ec2#DeleteTransitGatewayConnectPeer" + }, + { + "target": "com.amazonaws.ec2#DeleteTransitGatewayMulticastDomain" + }, + { + "target": "com.amazonaws.ec2#DeleteTransitGatewayPeeringAttachment" + }, + { + "target": "com.amazonaws.ec2#DeleteTransitGatewayPolicyTable" + }, + { + "target": "com.amazonaws.ec2#DeleteTransitGatewayPrefixListReference" + }, + { + "target": "com.amazonaws.ec2#DeleteTransitGatewayRoute" + }, + { + "target": "com.amazonaws.ec2#DeleteTransitGatewayRouteTable" + }, + { + "target": "com.amazonaws.ec2#DeleteTransitGatewayRouteTableAnnouncement" + }, + { + "target": "com.amazonaws.ec2#DeleteTransitGatewayVpcAttachment" + }, + { + "target": "com.amazonaws.ec2#DeleteVerifiedAccessEndpoint" + }, + { + "target": "com.amazonaws.ec2#DeleteVerifiedAccessGroup" + }, + { + "target": "com.amazonaws.ec2#DeleteVerifiedAccessInstance" + }, + { + "target": "com.amazonaws.ec2#DeleteVerifiedAccessTrustProvider" + }, + { + "target": "com.amazonaws.ec2#DeleteVolume" + }, + { + "target": "com.amazonaws.ec2#DeleteVpc" + }, + { + "target": "com.amazonaws.ec2#DeleteVpcBlockPublicAccessExclusion" + }, + { + "target": "com.amazonaws.ec2#DeleteVpcEndpointConnectionNotifications" + }, + { + "target": "com.amazonaws.ec2#DeleteVpcEndpoints" + }, + { + "target": "com.amazonaws.ec2#DeleteVpcEndpointServiceConfigurations" + }, + { + "target": "com.amazonaws.ec2#DeleteVpcPeeringConnection" + }, + { + "target": "com.amazonaws.ec2#DeleteVpnConnection" + }, + { + "target": "com.amazonaws.ec2#DeleteVpnConnectionRoute" + }, + { + "target": "com.amazonaws.ec2#DeleteVpnGateway" + }, + { + "target": "com.amazonaws.ec2#DeprovisionByoipCidr" + }, + { + "target": "com.amazonaws.ec2#DeprovisionIpamByoasn" + }, + { + "target": "com.amazonaws.ec2#DeprovisionIpamPoolCidr" + }, + { + "target": "com.amazonaws.ec2#DeprovisionPublicIpv4PoolCidr" + }, + { + "target": "com.amazonaws.ec2#DeregisterImage" + }, + { + "target": "com.amazonaws.ec2#DeregisterInstanceEventNotificationAttributes" + }, + { + "target": "com.amazonaws.ec2#DeregisterTransitGatewayMulticastGroupMembers" + }, + { + "target": "com.amazonaws.ec2#DeregisterTransitGatewayMulticastGroupSources" + }, + { + "target": "com.amazonaws.ec2#DescribeAccountAttributes" + }, + { + "target": "com.amazonaws.ec2#DescribeAddresses" + }, + { + "target": "com.amazonaws.ec2#DescribeAddressesAttribute" + }, + { + "target": "com.amazonaws.ec2#DescribeAddressTransfers" + }, + { + "target": "com.amazonaws.ec2#DescribeAggregateIdFormat" + }, + { + "target": "com.amazonaws.ec2#DescribeAvailabilityZones" + }, + { + "target": "com.amazonaws.ec2#DescribeAwsNetworkPerformanceMetricSubscriptions" + }, + { + "target": "com.amazonaws.ec2#DescribeBundleTasks" + }, + { + "target": "com.amazonaws.ec2#DescribeByoipCidrs" + }, + { + "target": "com.amazonaws.ec2#DescribeCapacityBlockExtensionHistory" + }, + { + "target": "com.amazonaws.ec2#DescribeCapacityBlockExtensionOfferings" + }, + { + "target": "com.amazonaws.ec2#DescribeCapacityBlockOfferings" + }, + { + "target": "com.amazonaws.ec2#DescribeCapacityReservationBillingRequests" + }, + { + "target": "com.amazonaws.ec2#DescribeCapacityReservationFleets" + }, + { + "target": "com.amazonaws.ec2#DescribeCapacityReservations" + }, + { + "target": "com.amazonaws.ec2#DescribeCarrierGateways" + }, + { + "target": "com.amazonaws.ec2#DescribeClassicLinkInstances" + }, + { + "target": "com.amazonaws.ec2#DescribeClientVpnAuthorizationRules" + }, + { + "target": "com.amazonaws.ec2#DescribeClientVpnConnections" + }, + { + "target": "com.amazonaws.ec2#DescribeClientVpnEndpoints" + }, + { + "target": "com.amazonaws.ec2#DescribeClientVpnRoutes" + }, + { + "target": "com.amazonaws.ec2#DescribeClientVpnTargetNetworks" + }, + { + "target": "com.amazonaws.ec2#DescribeCoipPools" + }, + { + "target": "com.amazonaws.ec2#DescribeConversionTasks" + }, + { + "target": "com.amazonaws.ec2#DescribeCustomerGateways" + }, + { + "target": "com.amazonaws.ec2#DescribeDeclarativePoliciesReports" + }, + { + "target": "com.amazonaws.ec2#DescribeDhcpOptions" + }, + { + "target": "com.amazonaws.ec2#DescribeEgressOnlyInternetGateways" + }, + { + "target": "com.amazonaws.ec2#DescribeElasticGpus" + }, + { + "target": "com.amazonaws.ec2#DescribeExportImageTasks" + }, + { + "target": "com.amazonaws.ec2#DescribeExportTasks" + }, + { + "target": "com.amazonaws.ec2#DescribeFastLaunchImages" + }, + { + "target": "com.amazonaws.ec2#DescribeFastSnapshotRestores" + }, + { + "target": "com.amazonaws.ec2#DescribeFleetHistory" + }, + { + "target": "com.amazonaws.ec2#DescribeFleetInstances" + }, + { + "target": "com.amazonaws.ec2#DescribeFleets" + }, + { + "target": "com.amazonaws.ec2#DescribeFlowLogs" + }, + { + "target": "com.amazonaws.ec2#DescribeFpgaImageAttribute" + }, + { + "target": "com.amazonaws.ec2#DescribeFpgaImages" + }, + { + "target": "com.amazonaws.ec2#DescribeHostReservationOfferings" + }, + { + "target": "com.amazonaws.ec2#DescribeHostReservations" + }, + { + "target": "com.amazonaws.ec2#DescribeHosts" + }, + { + "target": "com.amazonaws.ec2#DescribeIamInstanceProfileAssociations" + }, + { + "target": "com.amazonaws.ec2#DescribeIdentityIdFormat" + }, + { + "target": "com.amazonaws.ec2#DescribeIdFormat" + }, + { + "target": "com.amazonaws.ec2#DescribeImageAttribute" + }, + { + "target": "com.amazonaws.ec2#DescribeImages" + }, + { + "target": "com.amazonaws.ec2#DescribeImportImageTasks" + }, + { + "target": "com.amazonaws.ec2#DescribeImportSnapshotTasks" + }, + { + "target": "com.amazonaws.ec2#DescribeInstanceAttribute" + }, + { + "target": "com.amazonaws.ec2#DescribeInstanceConnectEndpoints" + }, + { + "target": "com.amazonaws.ec2#DescribeInstanceCreditSpecifications" + }, + { + "target": "com.amazonaws.ec2#DescribeInstanceEventNotificationAttributes" + }, + { + "target": "com.amazonaws.ec2#DescribeInstanceEventWindows" + }, + { + "target": "com.amazonaws.ec2#DescribeInstanceImageMetadata" + }, + { + "target": "com.amazonaws.ec2#DescribeInstances" + }, + { + "target": "com.amazonaws.ec2#DescribeInstanceStatus" + }, + { + "target": "com.amazonaws.ec2#DescribeInstanceTopology" + }, + { + "target": "com.amazonaws.ec2#DescribeInstanceTypeOfferings" + }, + { + "target": "com.amazonaws.ec2#DescribeInstanceTypes" + }, + { + "target": "com.amazonaws.ec2#DescribeInternetGateways" + }, + { + "target": "com.amazonaws.ec2#DescribeIpamByoasn" + }, + { + "target": "com.amazonaws.ec2#DescribeIpamExternalResourceVerificationTokens" + }, + { + "target": "com.amazonaws.ec2#DescribeIpamPools" + }, + { + "target": "com.amazonaws.ec2#DescribeIpamResourceDiscoveries" + }, + { + "target": "com.amazonaws.ec2#DescribeIpamResourceDiscoveryAssociations" + }, + { + "target": "com.amazonaws.ec2#DescribeIpams" + }, + { + "target": "com.amazonaws.ec2#DescribeIpamScopes" + }, + { + "target": "com.amazonaws.ec2#DescribeIpv6Pools" + }, + { + "target": "com.amazonaws.ec2#DescribeKeyPairs" + }, + { + "target": "com.amazonaws.ec2#DescribeLaunchTemplates" + }, + { + "target": "com.amazonaws.ec2#DescribeLaunchTemplateVersions" + }, + { + "target": "com.amazonaws.ec2#DescribeLocalGatewayRouteTables" + }, + { + "target": "com.amazonaws.ec2#DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations" + }, + { + "target": "com.amazonaws.ec2#DescribeLocalGatewayRouteTableVpcAssociations" + }, + { + "target": "com.amazonaws.ec2#DescribeLocalGateways" + }, + { + "target": "com.amazonaws.ec2#DescribeLocalGatewayVirtualInterfaceGroups" + }, + { + "target": "com.amazonaws.ec2#DescribeLocalGatewayVirtualInterfaces" + }, + { + "target": "com.amazonaws.ec2#DescribeLockedSnapshots" + }, + { + "target": "com.amazonaws.ec2#DescribeMacHosts" + }, + { + "target": "com.amazonaws.ec2#DescribeManagedPrefixLists" + }, + { + "target": "com.amazonaws.ec2#DescribeMovingAddresses" + }, + { + "target": "com.amazonaws.ec2#DescribeNatGateways" + }, + { + "target": "com.amazonaws.ec2#DescribeNetworkAcls" + }, + { + "target": "com.amazonaws.ec2#DescribeNetworkInsightsAccessScopeAnalyses" + }, + { + "target": "com.amazonaws.ec2#DescribeNetworkInsightsAccessScopes" + }, + { + "target": "com.amazonaws.ec2#DescribeNetworkInsightsAnalyses" + }, + { + "target": "com.amazonaws.ec2#DescribeNetworkInsightsPaths" + }, + { + "target": "com.amazonaws.ec2#DescribeNetworkInterfaceAttribute" + }, + { + "target": "com.amazonaws.ec2#DescribeNetworkInterfacePermissions" + }, + { + "target": "com.amazonaws.ec2#DescribeNetworkInterfaces" + }, + { + "target": "com.amazonaws.ec2#DescribePlacementGroups" + }, + { + "target": "com.amazonaws.ec2#DescribePrefixLists" + }, + { + "target": "com.amazonaws.ec2#DescribePrincipalIdFormat" + }, + { + "target": "com.amazonaws.ec2#DescribePublicIpv4Pools" + }, + { + "target": "com.amazonaws.ec2#DescribeRegions" + }, + { + "target": "com.amazonaws.ec2#DescribeReplaceRootVolumeTasks" + }, + { + "target": "com.amazonaws.ec2#DescribeReservedInstances" + }, + { + "target": "com.amazonaws.ec2#DescribeReservedInstancesListings" + }, + { + "target": "com.amazonaws.ec2#DescribeReservedInstancesModifications" + }, + { + "target": "com.amazonaws.ec2#DescribeReservedInstancesOfferings" + }, + { + "target": "com.amazonaws.ec2#DescribeRouteTables" + }, + { + "target": "com.amazonaws.ec2#DescribeScheduledInstanceAvailability" + }, + { + "target": "com.amazonaws.ec2#DescribeScheduledInstances" + }, + { + "target": "com.amazonaws.ec2#DescribeSecurityGroupReferences" + }, + { + "target": "com.amazonaws.ec2#DescribeSecurityGroupRules" + }, + { + "target": "com.amazonaws.ec2#DescribeSecurityGroups" + }, + { + "target": "com.amazonaws.ec2#DescribeSecurityGroupVpcAssociations" + }, + { + "target": "com.amazonaws.ec2#DescribeSnapshotAttribute" + }, + { + "target": "com.amazonaws.ec2#DescribeSnapshots" + }, + { + "target": "com.amazonaws.ec2#DescribeSnapshotTierStatus" + }, + { + "target": "com.amazonaws.ec2#DescribeSpotDatafeedSubscription" + }, + { + "target": "com.amazonaws.ec2#DescribeSpotFleetInstances" + }, + { + "target": "com.amazonaws.ec2#DescribeSpotFleetRequestHistory" + }, + { + "target": "com.amazonaws.ec2#DescribeSpotFleetRequests" + }, + { + "target": "com.amazonaws.ec2#DescribeSpotInstanceRequests" + }, + { + "target": "com.amazonaws.ec2#DescribeSpotPriceHistory" + }, + { + "target": "com.amazonaws.ec2#DescribeStaleSecurityGroups" + }, + { + "target": "com.amazonaws.ec2#DescribeStoreImageTasks" + }, + { + "target": "com.amazonaws.ec2#DescribeSubnets" + }, + { + "target": "com.amazonaws.ec2#DescribeTags" + }, + { + "target": "com.amazonaws.ec2#DescribeTrafficMirrorFilterRules" + }, + { + "target": "com.amazonaws.ec2#DescribeTrafficMirrorFilters" + }, + { + "target": "com.amazonaws.ec2#DescribeTrafficMirrorSessions" + }, + { + "target": "com.amazonaws.ec2#DescribeTrafficMirrorTargets" + }, + { + "target": "com.amazonaws.ec2#DescribeTransitGatewayAttachments" + }, + { + "target": "com.amazonaws.ec2#DescribeTransitGatewayConnectPeers" + }, + { + "target": "com.amazonaws.ec2#DescribeTransitGatewayConnects" + }, + { + "target": "com.amazonaws.ec2#DescribeTransitGatewayMulticastDomains" + }, + { + "target": "com.amazonaws.ec2#DescribeTransitGatewayPeeringAttachments" + }, + { + "target": "com.amazonaws.ec2#DescribeTransitGatewayPolicyTables" + }, + { + "target": "com.amazonaws.ec2#DescribeTransitGatewayRouteTableAnnouncements" + }, + { + "target": "com.amazonaws.ec2#DescribeTransitGatewayRouteTables" + }, + { + "target": "com.amazonaws.ec2#DescribeTransitGateways" + }, + { + "target": "com.amazonaws.ec2#DescribeTransitGatewayVpcAttachments" + }, + { + "target": "com.amazonaws.ec2#DescribeTrunkInterfaceAssociations" + }, + { + "target": "com.amazonaws.ec2#DescribeVerifiedAccessEndpoints" + }, + { + "target": "com.amazonaws.ec2#DescribeVerifiedAccessGroups" + }, + { + "target": "com.amazonaws.ec2#DescribeVerifiedAccessInstanceLoggingConfigurations" + }, + { + "target": "com.amazonaws.ec2#DescribeVerifiedAccessInstances" + }, + { + "target": "com.amazonaws.ec2#DescribeVerifiedAccessTrustProviders" + }, + { + "target": "com.amazonaws.ec2#DescribeVolumeAttribute" + }, + { + "target": "com.amazonaws.ec2#DescribeVolumes" + }, + { + "target": "com.amazonaws.ec2#DescribeVolumesModifications" + }, + { + "target": "com.amazonaws.ec2#DescribeVolumeStatus" + }, + { + "target": "com.amazonaws.ec2#DescribeVpcAttribute" + }, + { + "target": "com.amazonaws.ec2#DescribeVpcBlockPublicAccessExclusions" + }, + { + "target": "com.amazonaws.ec2#DescribeVpcBlockPublicAccessOptions" + }, + { + "target": "com.amazonaws.ec2#DescribeVpcClassicLink" + }, + { + "target": "com.amazonaws.ec2#DescribeVpcClassicLinkDnsSupport" + }, + { + "target": "com.amazonaws.ec2#DescribeVpcEndpointAssociations" + }, + { + "target": "com.amazonaws.ec2#DescribeVpcEndpointConnectionNotifications" + }, + { + "target": "com.amazonaws.ec2#DescribeVpcEndpointConnections" + }, + { + "target": "com.amazonaws.ec2#DescribeVpcEndpoints" + }, + { + "target": "com.amazonaws.ec2#DescribeVpcEndpointServiceConfigurations" + }, + { + "target": "com.amazonaws.ec2#DescribeVpcEndpointServicePermissions" + }, + { + "target": "com.amazonaws.ec2#DescribeVpcEndpointServices" + }, + { + "target": "com.amazonaws.ec2#DescribeVpcPeeringConnections" + }, + { + "target": "com.amazonaws.ec2#DescribeVpcs" + }, + { + "target": "com.amazonaws.ec2#DescribeVpnConnections" + }, + { + "target": "com.amazonaws.ec2#DescribeVpnGateways" + }, + { + "target": "com.amazonaws.ec2#DetachClassicLinkVpc" + }, + { + "target": "com.amazonaws.ec2#DetachInternetGateway" + }, + { + "target": "com.amazonaws.ec2#DetachNetworkInterface" + }, + { + "target": "com.amazonaws.ec2#DetachVerifiedAccessTrustProvider" + }, + { + "target": "com.amazonaws.ec2#DetachVolume" + }, + { + "target": "com.amazonaws.ec2#DetachVpnGateway" + }, + { + "target": "com.amazonaws.ec2#DisableAddressTransfer" + }, + { + "target": "com.amazonaws.ec2#DisableAllowedImagesSettings" + }, + { + "target": "com.amazonaws.ec2#DisableAwsNetworkPerformanceMetricSubscription" + }, + { + "target": "com.amazonaws.ec2#DisableEbsEncryptionByDefault" + }, + { + "target": "com.amazonaws.ec2#DisableFastLaunch" + }, + { + "target": "com.amazonaws.ec2#DisableFastSnapshotRestores" + }, + { + "target": "com.amazonaws.ec2#DisableImage" + }, + { + "target": "com.amazonaws.ec2#DisableImageBlockPublicAccess" + }, + { + "target": "com.amazonaws.ec2#DisableImageDeprecation" + }, + { + "target": "com.amazonaws.ec2#DisableImageDeregistrationProtection" + }, + { + "target": "com.amazonaws.ec2#DisableIpamOrganizationAdminAccount" + }, + { + "target": "com.amazonaws.ec2#DisableSerialConsoleAccess" + }, + { + "target": "com.amazonaws.ec2#DisableSnapshotBlockPublicAccess" + }, + { + "target": "com.amazonaws.ec2#DisableTransitGatewayRouteTablePropagation" + }, + { + "target": "com.amazonaws.ec2#DisableVgwRoutePropagation" + }, + { + "target": "com.amazonaws.ec2#DisableVpcClassicLink" + }, + { + "target": "com.amazonaws.ec2#DisableVpcClassicLinkDnsSupport" + }, + { + "target": "com.amazonaws.ec2#DisassociateAddress" + }, + { + "target": "com.amazonaws.ec2#DisassociateCapacityReservationBillingOwner" + }, + { + "target": "com.amazonaws.ec2#DisassociateClientVpnTargetNetwork" + }, + { + "target": "com.amazonaws.ec2#DisassociateEnclaveCertificateIamRole" + }, + { + "target": "com.amazonaws.ec2#DisassociateIamInstanceProfile" + }, + { + "target": "com.amazonaws.ec2#DisassociateInstanceEventWindow" + }, + { + "target": "com.amazonaws.ec2#DisassociateIpamByoasn" + }, + { + "target": "com.amazonaws.ec2#DisassociateIpamResourceDiscovery" + }, + { + "target": "com.amazonaws.ec2#DisassociateNatGatewayAddress" + }, + { + "target": "com.amazonaws.ec2#DisassociateRouteTable" + }, + { + "target": "com.amazonaws.ec2#DisassociateSecurityGroupVpc" + }, + { + "target": "com.amazonaws.ec2#DisassociateSubnetCidrBlock" + }, + { + "target": "com.amazonaws.ec2#DisassociateTransitGatewayMulticastDomain" + }, + { + "target": "com.amazonaws.ec2#DisassociateTransitGatewayPolicyTable" + }, + { + "target": "com.amazonaws.ec2#DisassociateTransitGatewayRouteTable" + }, + { + "target": "com.amazonaws.ec2#DisassociateTrunkInterface" + }, + { + "target": "com.amazonaws.ec2#DisassociateVpcCidrBlock" + }, + { + "target": "com.amazonaws.ec2#EnableAddressTransfer" + }, + { + "target": "com.amazonaws.ec2#EnableAllowedImagesSettings" + }, + { + "target": "com.amazonaws.ec2#EnableAwsNetworkPerformanceMetricSubscription" + }, + { + "target": "com.amazonaws.ec2#EnableEbsEncryptionByDefault" + }, + { + "target": "com.amazonaws.ec2#EnableFastLaunch" + }, + { + "target": "com.amazonaws.ec2#EnableFastSnapshotRestores" + }, + { + "target": "com.amazonaws.ec2#EnableImage" + }, + { + "target": "com.amazonaws.ec2#EnableImageBlockPublicAccess" + }, + { + "target": "com.amazonaws.ec2#EnableImageDeprecation" + }, + { + "target": "com.amazonaws.ec2#EnableImageDeregistrationProtection" + }, + { + "target": "com.amazonaws.ec2#EnableIpamOrganizationAdminAccount" + }, + { + "target": "com.amazonaws.ec2#EnableReachabilityAnalyzerOrganizationSharing" + }, + { + "target": "com.amazonaws.ec2#EnableSerialConsoleAccess" + }, + { + "target": "com.amazonaws.ec2#EnableSnapshotBlockPublicAccess" + }, + { + "target": "com.amazonaws.ec2#EnableTransitGatewayRouteTablePropagation" + }, + { + "target": "com.amazonaws.ec2#EnableVgwRoutePropagation" + }, + { + "target": "com.amazonaws.ec2#EnableVolumeIO" + }, + { + "target": "com.amazonaws.ec2#EnableVpcClassicLink" + }, + { + "target": "com.amazonaws.ec2#EnableVpcClassicLinkDnsSupport" + }, + { + "target": "com.amazonaws.ec2#ExportClientVpnClientCertificateRevocationList" + }, + { + "target": "com.amazonaws.ec2#ExportClientVpnClientConfiguration" + }, + { + "target": "com.amazonaws.ec2#ExportImage" + }, + { + "target": "com.amazonaws.ec2#ExportTransitGatewayRoutes" + }, + { + "target": "com.amazonaws.ec2#ExportVerifiedAccessInstanceClientConfiguration" + }, + { + "target": "com.amazonaws.ec2#GetAllowedImagesSettings" + }, + { + "target": "com.amazonaws.ec2#GetAssociatedEnclaveCertificateIamRoles" + }, + { + "target": "com.amazonaws.ec2#GetAssociatedIpv6PoolCidrs" + }, + { + "target": "com.amazonaws.ec2#GetAwsNetworkPerformanceData" + }, + { + "target": "com.amazonaws.ec2#GetCapacityReservationUsage" + }, + { + "target": "com.amazonaws.ec2#GetCoipPoolUsage" + }, + { + "target": "com.amazonaws.ec2#GetConsoleOutput" + }, + { + "target": "com.amazonaws.ec2#GetConsoleScreenshot" + }, + { + "target": "com.amazonaws.ec2#GetDeclarativePoliciesReportSummary" + }, + { + "target": "com.amazonaws.ec2#GetDefaultCreditSpecification" + }, + { + "target": "com.amazonaws.ec2#GetEbsDefaultKmsKeyId" + }, + { + "target": "com.amazonaws.ec2#GetEbsEncryptionByDefault" + }, + { + "target": "com.amazonaws.ec2#GetFlowLogsIntegrationTemplate" + }, + { + "target": "com.amazonaws.ec2#GetGroupsForCapacityReservation" + }, + { + "target": "com.amazonaws.ec2#GetHostReservationPurchasePreview" + }, + { + "target": "com.amazonaws.ec2#GetImageBlockPublicAccessState" + }, + { + "target": "com.amazonaws.ec2#GetInstanceMetadataDefaults" + }, + { + "target": "com.amazonaws.ec2#GetInstanceTpmEkPub" + }, + { + "target": "com.amazonaws.ec2#GetInstanceTypesFromInstanceRequirements" + }, + { + "target": "com.amazonaws.ec2#GetInstanceUefiData" + }, + { + "target": "com.amazonaws.ec2#GetIpamAddressHistory" + }, + { + "target": "com.amazonaws.ec2#GetIpamDiscoveredAccounts" + }, + { + "target": "com.amazonaws.ec2#GetIpamDiscoveredPublicAddresses" + }, + { + "target": "com.amazonaws.ec2#GetIpamDiscoveredResourceCidrs" + }, + { + "target": "com.amazonaws.ec2#GetIpamPoolAllocations" + }, + { + "target": "com.amazonaws.ec2#GetIpamPoolCidrs" + }, + { + "target": "com.amazonaws.ec2#GetIpamResourceCidrs" + }, + { + "target": "com.amazonaws.ec2#GetLaunchTemplateData" + }, + { + "target": "com.amazonaws.ec2#GetManagedPrefixListAssociations" + }, + { + "target": "com.amazonaws.ec2#GetManagedPrefixListEntries" + }, + { + "target": "com.amazonaws.ec2#GetNetworkInsightsAccessScopeAnalysisFindings" + }, + { + "target": "com.amazonaws.ec2#GetNetworkInsightsAccessScopeContent" + }, + { + "target": "com.amazonaws.ec2#GetPasswordData" + }, + { + "target": "com.amazonaws.ec2#GetReservedInstancesExchangeQuote" + }, + { + "target": "com.amazonaws.ec2#GetSecurityGroupsForVpc" + }, + { + "target": "com.amazonaws.ec2#GetSerialConsoleAccessStatus" + }, + { + "target": "com.amazonaws.ec2#GetSnapshotBlockPublicAccessState" + }, + { + "target": "com.amazonaws.ec2#GetSpotPlacementScores" + }, + { + "target": "com.amazonaws.ec2#GetSubnetCidrReservations" + }, + { + "target": "com.amazonaws.ec2#GetTransitGatewayAttachmentPropagations" + }, + { + "target": "com.amazonaws.ec2#GetTransitGatewayMulticastDomainAssociations" + }, + { + "target": "com.amazonaws.ec2#GetTransitGatewayPolicyTableAssociations" + }, + { + "target": "com.amazonaws.ec2#GetTransitGatewayPolicyTableEntries" + }, + { + "target": "com.amazonaws.ec2#GetTransitGatewayPrefixListReferences" + }, + { + "target": "com.amazonaws.ec2#GetTransitGatewayRouteTableAssociations" + }, + { + "target": "com.amazonaws.ec2#GetTransitGatewayRouteTablePropagations" + }, + { + "target": "com.amazonaws.ec2#GetVerifiedAccessEndpointPolicy" + }, + { + "target": "com.amazonaws.ec2#GetVerifiedAccessEndpointTargets" + }, + { + "target": "com.amazonaws.ec2#GetVerifiedAccessGroupPolicy" + }, + { + "target": "com.amazonaws.ec2#GetVpnConnectionDeviceSampleConfiguration" + }, + { + "target": "com.amazonaws.ec2#GetVpnConnectionDeviceTypes" + }, + { + "target": "com.amazonaws.ec2#GetVpnTunnelReplacementStatus" + }, + { + "target": "com.amazonaws.ec2#ImportClientVpnClientCertificateRevocationList" + }, + { + "target": "com.amazonaws.ec2#ImportImage" + }, + { + "target": "com.amazonaws.ec2#ImportInstance" + }, + { + "target": "com.amazonaws.ec2#ImportKeyPair" + }, + { + "target": "com.amazonaws.ec2#ImportSnapshot" + }, + { + "target": "com.amazonaws.ec2#ImportVolume" + }, + { + "target": "com.amazonaws.ec2#ListImagesInRecycleBin" + }, + { + "target": "com.amazonaws.ec2#ListSnapshotsInRecycleBin" + }, + { + "target": "com.amazonaws.ec2#LockSnapshot" + }, + { + "target": "com.amazonaws.ec2#ModifyAddressAttribute" + }, + { + "target": "com.amazonaws.ec2#ModifyAvailabilityZoneGroup" + }, + { + "target": "com.amazonaws.ec2#ModifyCapacityReservation" + }, + { + "target": "com.amazonaws.ec2#ModifyCapacityReservationFleet" + }, + { + "target": "com.amazonaws.ec2#ModifyClientVpnEndpoint" + }, + { + "target": "com.amazonaws.ec2#ModifyDefaultCreditSpecification" + }, + { + "target": "com.amazonaws.ec2#ModifyEbsDefaultKmsKeyId" + }, + { + "target": "com.amazonaws.ec2#ModifyFleet" + }, + { + "target": "com.amazonaws.ec2#ModifyFpgaImageAttribute" + }, + { + "target": "com.amazonaws.ec2#ModifyHosts" + }, + { + "target": "com.amazonaws.ec2#ModifyIdentityIdFormat" + }, + { + "target": "com.amazonaws.ec2#ModifyIdFormat" + }, + { + "target": "com.amazonaws.ec2#ModifyImageAttribute" + }, + { + "target": "com.amazonaws.ec2#ModifyInstanceAttribute" + }, + { + "target": "com.amazonaws.ec2#ModifyInstanceCapacityReservationAttributes" + }, + { + "target": "com.amazonaws.ec2#ModifyInstanceCpuOptions" + }, + { + "target": "com.amazonaws.ec2#ModifyInstanceCreditSpecification" + }, + { + "target": "com.amazonaws.ec2#ModifyInstanceEventStartTime" + }, + { + "target": "com.amazonaws.ec2#ModifyInstanceEventWindow" + }, + { + "target": "com.amazonaws.ec2#ModifyInstanceMaintenanceOptions" + }, + { + "target": "com.amazonaws.ec2#ModifyInstanceMetadataDefaults" + }, + { + "target": "com.amazonaws.ec2#ModifyInstanceMetadataOptions" + }, + { + "target": "com.amazonaws.ec2#ModifyInstanceNetworkPerformanceOptions" + }, + { + "target": "com.amazonaws.ec2#ModifyInstancePlacement" + }, + { + "target": "com.amazonaws.ec2#ModifyIpam" + }, + { + "target": "com.amazonaws.ec2#ModifyIpamPool" + }, + { + "target": "com.amazonaws.ec2#ModifyIpamResourceCidr" + }, + { + "target": "com.amazonaws.ec2#ModifyIpamResourceDiscovery" + }, + { + "target": "com.amazonaws.ec2#ModifyIpamScope" + }, + { + "target": "com.amazonaws.ec2#ModifyLaunchTemplate" + }, + { + "target": "com.amazonaws.ec2#ModifyLocalGatewayRoute" + }, + { + "target": "com.amazonaws.ec2#ModifyManagedPrefixList" + }, + { + "target": "com.amazonaws.ec2#ModifyNetworkInterfaceAttribute" + }, + { + "target": "com.amazonaws.ec2#ModifyPrivateDnsNameOptions" + }, + { + "target": "com.amazonaws.ec2#ModifyReservedInstances" + }, + { + "target": "com.amazonaws.ec2#ModifySecurityGroupRules" + }, + { + "target": "com.amazonaws.ec2#ModifySnapshotAttribute" + }, + { + "target": "com.amazonaws.ec2#ModifySnapshotTier" + }, + { + "target": "com.amazonaws.ec2#ModifySpotFleetRequest" + }, + { + "target": "com.amazonaws.ec2#ModifySubnetAttribute" + }, + { + "target": "com.amazonaws.ec2#ModifyTrafficMirrorFilterNetworkServices" + }, + { + "target": "com.amazonaws.ec2#ModifyTrafficMirrorFilterRule" + }, + { + "target": "com.amazonaws.ec2#ModifyTrafficMirrorSession" + }, + { + "target": "com.amazonaws.ec2#ModifyTransitGateway" + }, + { + "target": "com.amazonaws.ec2#ModifyTransitGatewayPrefixListReference" + }, + { + "target": "com.amazonaws.ec2#ModifyTransitGatewayVpcAttachment" + }, + { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessEndpoint" + }, + { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessEndpointPolicy" + }, + { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessGroup" + }, + { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessGroupPolicy" + }, + { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessInstance" + }, + { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessInstanceLoggingConfiguration" + }, + { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessTrustProvider" + }, + { + "target": "com.amazonaws.ec2#ModifyVolume" + }, + { + "target": "com.amazonaws.ec2#ModifyVolumeAttribute" + }, + { + "target": "com.amazonaws.ec2#ModifyVpcAttribute" + }, + { + "target": "com.amazonaws.ec2#ModifyVpcBlockPublicAccessExclusion" + }, + { + "target": "com.amazonaws.ec2#ModifyVpcBlockPublicAccessOptions" + }, + { + "target": "com.amazonaws.ec2#ModifyVpcEndpoint" + }, + { + "target": "com.amazonaws.ec2#ModifyVpcEndpointConnectionNotification" + }, + { + "target": "com.amazonaws.ec2#ModifyVpcEndpointServiceConfiguration" + }, + { + "target": "com.amazonaws.ec2#ModifyVpcEndpointServicePayerResponsibility" + }, + { + "target": "com.amazonaws.ec2#ModifyVpcEndpointServicePermissions" + }, + { + "target": "com.amazonaws.ec2#ModifyVpcPeeringConnectionOptions" + }, + { + "target": "com.amazonaws.ec2#ModifyVpcTenancy" + }, + { + "target": "com.amazonaws.ec2#ModifyVpnConnection" + }, + { + "target": "com.amazonaws.ec2#ModifyVpnConnectionOptions" + }, + { + "target": "com.amazonaws.ec2#ModifyVpnTunnelCertificate" + }, + { + "target": "com.amazonaws.ec2#ModifyVpnTunnelOptions" + }, + { + "target": "com.amazonaws.ec2#MonitorInstances" + }, + { + "target": "com.amazonaws.ec2#MoveAddressToVpc" + }, + { + "target": "com.amazonaws.ec2#MoveByoipCidrToIpam" + }, + { + "target": "com.amazonaws.ec2#MoveCapacityReservationInstances" + }, + { + "target": "com.amazonaws.ec2#ProvisionByoipCidr" + }, + { + "target": "com.amazonaws.ec2#ProvisionIpamByoasn" + }, + { + "target": "com.amazonaws.ec2#ProvisionIpamPoolCidr" + }, + { + "target": "com.amazonaws.ec2#ProvisionPublicIpv4PoolCidr" + }, + { + "target": "com.amazonaws.ec2#PurchaseCapacityBlock" + }, + { + "target": "com.amazonaws.ec2#PurchaseCapacityBlockExtension" + }, + { + "target": "com.amazonaws.ec2#PurchaseHostReservation" + }, + { + "target": "com.amazonaws.ec2#PurchaseReservedInstancesOffering" + }, + { + "target": "com.amazonaws.ec2#PurchaseScheduledInstances" + }, + { + "target": "com.amazonaws.ec2#RebootInstances" + }, + { + "target": "com.amazonaws.ec2#RegisterImage" + }, + { + "target": "com.amazonaws.ec2#RegisterInstanceEventNotificationAttributes" + }, + { + "target": "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupMembers" + }, + { + "target": "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupSources" + }, + { + "target": "com.amazonaws.ec2#RejectCapacityReservationBillingOwnership" + }, + { + "target": "com.amazonaws.ec2#RejectTransitGatewayMulticastDomainAssociations" + }, + { + "target": "com.amazonaws.ec2#RejectTransitGatewayPeeringAttachment" + }, + { + "target": "com.amazonaws.ec2#RejectTransitGatewayVpcAttachment" + }, + { + "target": "com.amazonaws.ec2#RejectVpcEndpointConnections" + }, + { + "target": "com.amazonaws.ec2#RejectVpcPeeringConnection" + }, + { + "target": "com.amazonaws.ec2#ReleaseAddress" + }, + { + "target": "com.amazonaws.ec2#ReleaseHosts" + }, + { + "target": "com.amazonaws.ec2#ReleaseIpamPoolAllocation" + }, + { + "target": "com.amazonaws.ec2#ReplaceIamInstanceProfileAssociation" + }, + { + "target": "com.amazonaws.ec2#ReplaceImageCriteriaInAllowedImagesSettings" + }, + { + "target": "com.amazonaws.ec2#ReplaceNetworkAclAssociation" + }, + { + "target": "com.amazonaws.ec2#ReplaceNetworkAclEntry" + }, + { + "target": "com.amazonaws.ec2#ReplaceRoute" + }, + { + "target": "com.amazonaws.ec2#ReplaceRouteTableAssociation" + }, + { + "target": "com.amazonaws.ec2#ReplaceTransitGatewayRoute" + }, + { + "target": "com.amazonaws.ec2#ReplaceVpnTunnel" + }, + { + "target": "com.amazonaws.ec2#ReportInstanceStatus" + }, + { + "target": "com.amazonaws.ec2#RequestSpotFleet" + }, + { + "target": "com.amazonaws.ec2#RequestSpotInstances" + }, + { + "target": "com.amazonaws.ec2#ResetAddressAttribute" + }, + { + "target": "com.amazonaws.ec2#ResetEbsDefaultKmsKeyId" + }, + { + "target": "com.amazonaws.ec2#ResetFpgaImageAttribute" + }, + { + "target": "com.amazonaws.ec2#ResetImageAttribute" + }, + { + "target": "com.amazonaws.ec2#ResetInstanceAttribute" + }, + { + "target": "com.amazonaws.ec2#ResetNetworkInterfaceAttribute" + }, + { + "target": "com.amazonaws.ec2#ResetSnapshotAttribute" + }, + { + "target": "com.amazonaws.ec2#RestoreAddressToClassic" + }, + { + "target": "com.amazonaws.ec2#RestoreImageFromRecycleBin" + }, + { + "target": "com.amazonaws.ec2#RestoreManagedPrefixListVersion" + }, + { + "target": "com.amazonaws.ec2#RestoreSnapshotFromRecycleBin" + }, + { + "target": "com.amazonaws.ec2#RestoreSnapshotTier" + }, + { + "target": "com.amazonaws.ec2#RevokeClientVpnIngress" + }, + { + "target": "com.amazonaws.ec2#RevokeSecurityGroupEgress" + }, + { + "target": "com.amazonaws.ec2#RevokeSecurityGroupIngress" + }, + { + "target": "com.amazonaws.ec2#RunInstances" + }, + { + "target": "com.amazonaws.ec2#RunScheduledInstances" + }, + { + "target": "com.amazonaws.ec2#SearchLocalGatewayRoutes" + }, + { + "target": "com.amazonaws.ec2#SearchTransitGatewayMulticastGroups" + }, + { + "target": "com.amazonaws.ec2#SearchTransitGatewayRoutes" + }, + { + "target": "com.amazonaws.ec2#SendDiagnosticInterrupt" + }, + { + "target": "com.amazonaws.ec2#StartDeclarativePoliciesReport" + }, + { + "target": "com.amazonaws.ec2#StartInstances" + }, + { + "target": "com.amazonaws.ec2#StartNetworkInsightsAccessScopeAnalysis" + }, + { + "target": "com.amazonaws.ec2#StartNetworkInsightsAnalysis" + }, + { + "target": "com.amazonaws.ec2#StartVpcEndpointServicePrivateDnsVerification" + }, + { + "target": "com.amazonaws.ec2#StopInstances" + }, + { + "target": "com.amazonaws.ec2#TerminateClientVpnConnections" + }, + { + "target": "com.amazonaws.ec2#TerminateInstances" + }, + { + "target": "com.amazonaws.ec2#UnassignIpv6Addresses" + }, + { + "target": "com.amazonaws.ec2#UnassignPrivateIpAddresses" + }, + { + "target": "com.amazonaws.ec2#UnassignPrivateNatGatewayAddress" + }, + { + "target": "com.amazonaws.ec2#UnlockSnapshot" + }, + { + "target": "com.amazonaws.ec2#UnmonitorInstances" + }, + { + "target": "com.amazonaws.ec2#UpdateSecurityGroupRuleDescriptionsEgress" + }, + { + "target": "com.amazonaws.ec2#UpdateSecurityGroupRuleDescriptionsIngress" + }, + { + "target": "com.amazonaws.ec2#WithdrawByoipCidr" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "EC2", + "arnNamespace": "ec2", + "cloudFormationName": "EC2", + "cloudTrailEventSource": "ec2.amazonaws.com", + "endpointPrefix": "ec2" + }, + "aws.auth#sigv4": { + "name": "ec2" + }, + "aws.protocols#ec2Query": {}, + "smithy.api#documentation": "Amazon Elastic Compute Cloud\n

You can access the features of Amazon Elastic Compute Cloud (Amazon EC2) programmatically. For more information,\n see the Amazon EC2 Developer Guide.

", + "smithy.api#title": "Amazon Elastic Compute Cloud", + "smithy.api#xmlNamespace": { + "uri": "http://ec2.amazonaws.com/doc/2016-11-15" + }, + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://ec2-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-us-gov" + ] + } + ], + "endpoint": { + "url": "https://ec2.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://ec2-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://ec2.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://ec2.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.af-south-1.amazonaws.com" + } + }, + "params": { + "Region": "af-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.ap-east-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.ap-south-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ec2.ap-south-1.api.aws" + } + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2-fips.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.eu-north-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.eu-south-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ec2.eu-west-1.api.aws" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.eu-west-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.eu-west-3.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.me-south-1.amazonaws.com" + } + }, + "params": { + "Region": "me-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.sa-east-1.amazonaws.com" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ec2.sa-east-1.api.aws" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ec2.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ec2.us-east-2.api.aws" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ec2.us-west-2.api.aws" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ec2-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ec2-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ec2.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ec2-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ec2.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.us-iso-west-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.ec2#AmdSevSnpSpecification": { + "type": "enum", + "members": { + "enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + }, + "disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + } + } + }, + "com.amazonaws.ec2#AnalysisAclRule": { + "type": "structure", + "members": { + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Cidr", + "smithy.api#documentation": "

The IPv4 address range, in CIDR notation.

", + "smithy.api#xmlName": "cidr" + } + }, + "Egress": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Egress", + "smithy.api#documentation": "

Indicates whether the rule is an outbound rule.

", + "smithy.api#xmlName": "egress" + } + }, + "PortRange": { + "target": "com.amazonaws.ec2#PortRange", + "traits": { + "aws.protocols#ec2QueryName": "PortRange", + "smithy.api#documentation": "

The range of ports.

", + "smithy.api#xmlName": "portRange" + } + }, + "Protocol": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Protocol", + "smithy.api#documentation": "

The protocol.

", + "smithy.api#xmlName": "protocol" + } + }, + "RuleAction": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RuleAction", + "smithy.api#documentation": "

Indicates whether to allow or deny traffic that matches the rule.

", + "smithy.api#xmlName": "ruleAction" + } + }, + "RuleNumber": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "RuleNumber", + "smithy.api#documentation": "

The rule number.

", + "smithy.api#xmlName": "ruleNumber" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a network access control (ACL) rule.

" + } + }, + "com.amazonaws.ec2#AnalysisComponent": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Id", + "smithy.api#documentation": "

The ID of the component.

", + "smithy.api#xmlName": "id" + } + }, + "Arn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Arn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component.

", + "smithy.api#xmlName": "arn" + } + }, + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Name", + "smithy.api#documentation": "

The name of the analysis component.

", + "smithy.api#xmlName": "name" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a path component.

" + } + }, + "com.amazonaws.ec2#AnalysisComponentList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#AnalysisLoadBalancerListener": { + "type": "structure", + "members": { + "LoadBalancerPort": { + "target": "com.amazonaws.ec2#Port", + "traits": { + "aws.protocols#ec2QueryName": "LoadBalancerPort", + "smithy.api#documentation": "

The port on which the load balancer is listening.

", + "smithy.api#xmlName": "loadBalancerPort" + } + }, + "InstancePort": { + "target": "com.amazonaws.ec2#Port", + "traits": { + "aws.protocols#ec2QueryName": "InstancePort", + "smithy.api#documentation": "

[Classic Load Balancers] The back-end port for the listener.

", + "smithy.api#xmlName": "instancePort" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a load balancer listener.

" + } + }, + "com.amazonaws.ec2#AnalysisLoadBalancerTarget": { + "type": "structure", + "members": { + "Address": { + "target": "com.amazonaws.ec2#IpAddress", + "traits": { + "aws.protocols#ec2QueryName": "Address", + "smithy.api#documentation": "

The IP address.

", + "smithy.api#xmlName": "address" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "Instance": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "Instance", + "smithy.api#documentation": "

Information about the instance.

", + "smithy.api#xmlName": "instance" + } + }, + "Port": { + "target": "com.amazonaws.ec2#Port", + "traits": { + "aws.protocols#ec2QueryName": "Port", + "smithy.api#documentation": "

The port on which the target is listening.

", + "smithy.api#xmlName": "port" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a load balancer target.

" + } + }, + "com.amazonaws.ec2#AnalysisPacketHeader": { + "type": "structure", + "members": { + "DestinationAddresses": { + "target": "com.amazonaws.ec2#IpAddressList", + "traits": { + "aws.protocols#ec2QueryName": "DestinationAddressSet", + "smithy.api#documentation": "

The destination addresses.

", + "smithy.api#xmlName": "destinationAddressSet" + } + }, + "DestinationPortRanges": { + "target": "com.amazonaws.ec2#PortRangeList", + "traits": { + "aws.protocols#ec2QueryName": "DestinationPortRangeSet", + "smithy.api#documentation": "

The destination port ranges.

", + "smithy.api#xmlName": "destinationPortRangeSet" + } + }, + "Protocol": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Protocol", + "smithy.api#documentation": "

The protocol.

", + "smithy.api#xmlName": "protocol" + } + }, + "SourceAddresses": { + "target": "com.amazonaws.ec2#IpAddressList", + "traits": { + "aws.protocols#ec2QueryName": "SourceAddressSet", + "smithy.api#documentation": "

The source addresses.

", + "smithy.api#xmlName": "sourceAddressSet" + } + }, + "SourcePortRanges": { + "target": "com.amazonaws.ec2#PortRangeList", + "traits": { + "aws.protocols#ec2QueryName": "SourcePortRangeSet", + "smithy.api#documentation": "

The source port ranges.

", + "smithy.api#xmlName": "sourcePortRangeSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a header. Reflects any changes made by a component as traffic passes through.\n The fields of an inbound header are null except for the first component of a path.

" + } + }, + "com.amazonaws.ec2#AnalysisRouteTableRoute": { + "type": "structure", + "members": { + "DestinationCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationCidr", + "smithy.api#documentation": "

The destination IPv4 address, in CIDR notation.

", + "smithy.api#xmlName": "destinationCidr" + } + }, + "DestinationPrefixListId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationPrefixListId", + "smithy.api#documentation": "

The prefix of the Amazon Web Services service.

", + "smithy.api#xmlName": "destinationPrefixListId" + } + }, + "EgressOnlyInternetGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "EgressOnlyInternetGatewayId", + "smithy.api#documentation": "

The ID of an egress-only internet gateway.

", + "smithy.api#xmlName": "egressOnlyInternetGatewayId" + } + }, + "GatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GatewayId", + "smithy.api#documentation": "

The ID of the gateway, such as an internet gateway or virtual private gateway.

", + "smithy.api#xmlName": "gatewayId" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance, such as a NAT instance.

", + "smithy.api#xmlName": "instanceId" + } + }, + "NatGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NatGatewayId", + "smithy.api#documentation": "

The ID of a NAT gateway.

", + "smithy.api#xmlName": "natGatewayId" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of a network interface.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "Origin": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Origin", + "smithy.api#documentation": "

Describes how the route was created. The following are the possible values:

\n ", + "smithy.api#xmlName": "origin" + } + }, + "TransitGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayId", + "smithy.api#documentation": "

The ID of a transit gateway.

", + "smithy.api#xmlName": "transitGatewayId" + } + }, + "VpcPeeringConnectionId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcPeeringConnectionId", + "smithy.api#documentation": "

The ID of a VPC peering connection.

", + "smithy.api#xmlName": "vpcPeeringConnectionId" + } + }, + "State": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state. The following are the possible values:

\n ", + "smithy.api#xmlName": "state" + } + }, + "CarrierGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CarrierGatewayId", + "smithy.api#documentation": "

The ID of a carrier gateway.

", + "smithy.api#xmlName": "carrierGatewayId" + } + }, + "CoreNetworkArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "CoreNetworkArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a core network.

", + "smithy.api#xmlName": "coreNetworkArn" + } + }, + "LocalGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayId", + "smithy.api#documentation": "

The ID of a local gateway.

", + "smithy.api#xmlName": "localGatewayId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a route table route.

" + } + }, + "com.amazonaws.ec2#AnalysisSecurityGroupRule": { + "type": "structure", + "members": { + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Cidr", + "smithy.api#documentation": "

The IPv4 address range, in CIDR notation.

", + "smithy.api#xmlName": "cidr" + } + }, + "Direction": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Direction", + "smithy.api#documentation": "

The direction. The following are the possible values:

\n ", + "smithy.api#xmlName": "direction" + } + }, + "SecurityGroupId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroupId", + "smithy.api#documentation": "

The security group ID.

", + "smithy.api#xmlName": "securityGroupId" + } + }, + "PortRange": { + "target": "com.amazonaws.ec2#PortRange", + "traits": { + "aws.protocols#ec2QueryName": "PortRange", + "smithy.api#documentation": "

The port range.

", + "smithy.api#xmlName": "portRange" + } + }, + "PrefixListId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrefixListId", + "smithy.api#documentation": "

The prefix list ID.

", + "smithy.api#xmlName": "prefixListId" + } + }, + "Protocol": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Protocol", + "smithy.api#documentation": "

The protocol name.

", + "smithy.api#xmlName": "protocol" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a security group rule.

" + } + }, + "com.amazonaws.ec2#AnalysisStatus": { + "type": "enum", + "members": { + "running": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "running" + } + }, + "succeeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "succeeded" + } + }, + "failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + } + } + }, + "com.amazonaws.ec2#ApplianceModeSupportValue": { + "type": "enum", + "members": { + "enable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enable" + } + }, + "disable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disable" + } + } + } + }, + "com.amazonaws.ec2#ApplySecurityGroupsToClientVpnTargetNetwork": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ApplySecurityGroupsToClientVpnTargetNetworkRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ApplySecurityGroupsToClientVpnTargetNetworkResult" + }, + "traits": { + "smithy.api#documentation": "

Applies a security group to the association between the target network and the Client VPN endpoint. This action replaces the existing \n\t\t\tsecurity groups with the specified security groups.

" + } + }, + "com.amazonaws.ec2#ApplySecurityGroupsToClientVpnTargetNetworkRequest": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#ClientVpnEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", + "smithy.api#required": {} + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC in which the associated target network is located.

", + "smithy.api#required": {} + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.ec2#ClientVpnSecurityGroupIdSet", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the security groups to apply to the associated target network. Up to 5 security groups can \n\t\t\tbe applied to an associated target network.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "SecurityGroupId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ApplySecurityGroupsToClientVpnTargetNetworkResult": { + "type": "structure", + "members": { + "SecurityGroupIds": { + "target": "com.amazonaws.ec2#ClientVpnSecurityGroupIdSet", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroupIds", + "smithy.api#documentation": "

The IDs of the applied security groups.

", + "smithy.api#xmlName": "securityGroupIds" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ArchitectureType": { + "type": "enum", + "members": { + "i386": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i386" + } + }, + "x86_64": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x86_64" + } + }, + "arm64": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "arm64" + } + }, + "x86_64_mac": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x86_64_mac" + } + }, + "arm64_mac": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "arm64_mac" + } + } + } + }, + "com.amazonaws.ec2#ArchitectureTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ArchitectureType", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ArchitectureTypeSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ArchitectureType", + "traits": { + "smithy.api#xmlName": "item" + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3 + } + } + }, + "com.amazonaws.ec2#ArchitectureValues": { + "type": "enum", + "members": { + "i386": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i386" + } + }, + "x86_64": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x86_64" + } + }, + "arm64": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "arm64" + } + }, + "x86_64_mac": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x86_64_mac" + } + }, + "arm64_mac": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "arm64_mac" + } + } + } + }, + "com.amazonaws.ec2#ArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#AsnAssociation": { + "type": "structure", + "members": { + "Asn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Asn", + "smithy.api#documentation": "

The association's ASN.

", + "smithy.api#xmlName": "asn" + } + }, + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Cidr", + "smithy.api#documentation": "

The association's CIDR.

", + "smithy.api#xmlName": "cidr" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

The association's status message.

", + "smithy.api#xmlName": "statusMessage" + } + }, + "State": { + "target": "com.amazonaws.ec2#AsnAssociationState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The association's state.

", + "smithy.api#xmlName": "state" + } + } + }, + "traits": { + "smithy.api#documentation": "

An Autonomous System Number (ASN) and BYOIP CIDR association.

" + } + }, + "com.amazonaws.ec2#AsnAssociationSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AsnAssociation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#AsnAssociationState": { + "type": "enum", + "members": { + "disassociated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociated" + } + }, + "failed_disassociation": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed-disassociation" + } + }, + "failed_association": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed-association" + } + }, + "pending_disassociation": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending-disassociation" + } + }, + "pending_association": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending-association" + } + }, + "associated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associated" + } + } + } + }, + "com.amazonaws.ec2#AsnAuthorizationContext": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The authorization context's message.

", + "smithy.api#required": {} + } + }, + "Signature": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The authorization context's signature.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides authorization for Amazon to bring an Autonomous System Number (ASN) to a specific Amazon Web Services account using bring your own ASN (BYOASN). \n For details on the format of the message and signature, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide.

" + } + }, + "com.amazonaws.ec2#AsnState": { + "type": "enum", + "members": { + "deprovisioned": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deprovisioned" + } + }, + "failed_deprovision": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed-deprovision" + } + }, + "failed_provision": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed-provision" + } + }, + "pending_deprovision": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending-deprovision" + } + }, + "pending_provision": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending-provision" + } + }, + "provisioned": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "provisioned" + } + } + } + }, + "com.amazonaws.ec2#AssetId": { + "type": "string" + }, + "com.amazonaws.ec2#AssetIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AssetId" + } + }, + "com.amazonaws.ec2#AssignIpv6Addresses": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AssignIpv6AddressesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AssignIpv6AddressesResult" + }, + "traits": { + "smithy.api#documentation": "

Assigns one or more IPv6 addresses to the specified network interface. You can\n specify one or more specific IPv6 addresses, or you can specify the number of IPv6\n addresses to be automatically assigned from within the subnet's IPv6 CIDR block range.\n You can assign as many IPv6 addresses to a network interface as you can assign private\n IPv4 addresses, and the limit varies per instance type.

\n

You must specify either the IPv6 addresses or the IPv6 address count in the request.

\n

You can optionally use Prefix Delegation on the network interface. You must specify\n either the IPV6 Prefix Delegation prefixes, or the IPv6 Prefix Delegation count. For\n information, see \n Assigning prefixes to network interfaces in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#AssignIpv6AddressesRequest": { + "type": "structure", + "members": { + "Ipv6PrefixCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The number of IPv6 prefixes that Amazon Web Services automatically assigns to the\n network interface. You cannot use this option if you use the Ipv6Prefixes\n option.

" + } + }, + "Ipv6Prefixes": { + "target": "com.amazonaws.ec2#IpPrefixList", + "traits": { + "smithy.api#documentation": "

One or more IPv6 prefixes assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option.

", + "smithy.api#xmlName": "Ipv6Prefix" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "Ipv6Addresses": { + "target": "com.amazonaws.ec2#Ipv6AddressList", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6Addresses", + "smithy.api#documentation": "

The IPv6 addresses to be assigned to the network interface. You can't use this option if you're specifying a number of IPv6 addresses.

", + "smithy.api#xmlName": "ipv6Addresses" + } + }, + "Ipv6AddressCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6AddressCount", + "smithy.api#documentation": "

The number of additional IPv6 addresses to assign to the network interface. \n \t\tThe specified number of IPv6 addresses are assigned in addition to the \n \t\texisting IPv6 addresses that are already assigned to the network interface. \n \t\tAmazon EC2 automatically selects the IPv6 addresses from the subnet range. You \n \t\tcan't use this option if specifying specific IPv6 addresses.

", + "smithy.api#xmlName": "ipv6AddressCount" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AssignIpv6AddressesResult": { + "type": "structure", + "members": { + "AssignedIpv6Addresses": { + "target": "com.amazonaws.ec2#Ipv6AddressList", + "traits": { + "aws.protocols#ec2QueryName": "AssignedIpv6Addresses", + "smithy.api#documentation": "

The new IPv6 addresses assigned to the network interface. Existing IPv6 addresses \n \tthat were assigned to the network interface before the request are not included.

", + "smithy.api#xmlName": "assignedIpv6Addresses" + } + }, + "AssignedIpv6Prefixes": { + "target": "com.amazonaws.ec2#IpPrefixList", + "traits": { + "aws.protocols#ec2QueryName": "AssignedIpv6PrefixSet", + "smithy.api#documentation": "

The IPv6 prefixes that are assigned to the network interface.

", + "smithy.api#xmlName": "assignedIpv6PrefixSet" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#xmlName": "networkInterfaceId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AssignPrivateIpAddresses": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AssignPrivateIpAddressesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AssignPrivateIpAddressesResult" + }, + "traits": { + "smithy.api#documentation": "

Assigns one or more secondary private IP addresses to the specified network interface.

\n

You can specify one or more specific secondary IP addresses, or you can specify the number \n of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. \n The number of secondary IP addresses that you can assign to an instance varies by instance type.\n For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon EC2 User Guide.

\n

When you move a secondary private IP address to another network interface, any Elastic IP address \n that is associated with the IP address is also moved.

\n

Remapping an IP address is an asynchronous operation. When you move an IP address from one network\n interface to another, check network/interfaces/macs/mac/local-ipv4s in the instance\n metadata to confirm that the remapping is complete.

\n

You must specify either the IP addresses or the IP address count in the request.

\n

You can optionally use Prefix Delegation on the network interface. You must specify\n either the IPv4 Prefix Delegation prefixes, or the IPv4 Prefix Delegation count. For\n information, see \n Assigning prefixes to network interfaces in the Amazon EC2 User Guide.

", + "smithy.api#examples": [ + { + "title": "To assign a specific secondary private IP address to an interface", + "documentation": "This example assigns the specified secondary private IP address to the specified network interface.", + "input": { + "NetworkInterfaceId": "eni-e5aa89a3", + "PrivateIpAddresses": [ + "10.0.0.82" + ] + } + }, + { + "title": "To assign secondary private IP addresses that Amazon EC2 selects to an interface", + "documentation": "This example assigns two secondary private IP addresses to the specified network interface. Amazon EC2 automatically assigns these IP addresses from the available IP addresses in the CIDR block range of the subnet the network interface is associated with.", + "input": { + "NetworkInterfaceId": "eni-e5aa89a3", + "SecondaryPrivateIpAddressCount": 2 + } + } + ] + } + }, + "com.amazonaws.ec2#AssignPrivateIpAddressesRequest": { + "type": "structure", + "members": { + "Ipv4Prefixes": { + "target": "com.amazonaws.ec2#IpPrefixList", + "traits": { + "smithy.api#documentation": "

One or more IPv4 prefixes assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option.

", + "smithy.api#xmlName": "Ipv4Prefix" + } + }, + "Ipv4PrefixCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv4 Prefixes option.

" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "PrivateIpAddresses": { + "target": "com.amazonaws.ec2#PrivateIpAddressStringList", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddress", + "smithy.api#documentation": "

The IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.

\n

If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.

", + "smithy.api#xmlName": "privateIpAddress" + } + }, + "SecondaryPrivateIpAddressCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "SecondaryPrivateIpAddressCount", + "smithy.api#documentation": "

The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.

", + "smithy.api#xmlName": "secondaryPrivateIpAddressCount" + } + }, + "AllowReassignment": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "AllowReassignment", + "smithy.api#documentation": "

Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.

", + "smithy.api#xmlName": "allowReassignment" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for AssignPrivateIpAddresses.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AssignPrivateIpAddressesResult": { + "type": "structure", + "members": { + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "AssignedPrivateIpAddresses": { + "target": "com.amazonaws.ec2#AssignedPrivateIpAddressList", + "traits": { + "aws.protocols#ec2QueryName": "AssignedPrivateIpAddressesSet", + "smithy.api#documentation": "

The private IP addresses assigned to the network interface.

", + "smithy.api#xmlName": "assignedPrivateIpAddressesSet" + } + }, + "AssignedIpv4Prefixes": { + "target": "com.amazonaws.ec2#Ipv4PrefixesList", + "traits": { + "aws.protocols#ec2QueryName": "AssignedIpv4PrefixSet", + "smithy.api#documentation": "

The IPv4 prefixes that are assigned to the network interface.

", + "smithy.api#xmlName": "assignedIpv4PrefixSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AssignPrivateNatGatewayAddress": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AssignPrivateNatGatewayAddressRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AssignPrivateNatGatewayAddressResult" + }, + "traits": { + "smithy.api#documentation": "

Assigns private IPv4 addresses to a private NAT gateway. For more information, see \n Work with NAT gateways in the Amazon VPC User Guide.

" + } + }, + "com.amazonaws.ec2#AssignPrivateNatGatewayAddressRequest": { + "type": "structure", + "members": { + "NatGatewayId": { + "target": "com.amazonaws.ec2#NatGatewayId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the NAT gateway.

", + "smithy.api#required": {} + } + }, + "PrivateIpAddresses": { + "target": "com.amazonaws.ec2#IpList", + "traits": { + "smithy.api#documentation": "

The private IPv4 addresses you want to assign to the private NAT gateway.

", + "smithy.api#xmlName": "PrivateIpAddress" + } + }, + "PrivateIpAddressCount": { + "target": "com.amazonaws.ec2#PrivateIpAddressCount", + "traits": { + "smithy.api#documentation": "

The number of private IP addresses to assign to the NAT gateway. You can't specify this parameter when also specifying private IP addresses.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AssignPrivateNatGatewayAddressResult": { + "type": "structure", + "members": { + "NatGatewayId": { + "target": "com.amazonaws.ec2#NatGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "NatGatewayId", + "smithy.api#documentation": "

The ID of the NAT gateway.

", + "smithy.api#xmlName": "natGatewayId" + } + }, + "NatGatewayAddresses": { + "target": "com.amazonaws.ec2#NatGatewayAddressList", + "traits": { + "aws.protocols#ec2QueryName": "NatGatewayAddressSet", + "smithy.api#documentation": "

NAT gateway IP addresses.

", + "smithy.api#xmlName": "natGatewayAddressSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AssignedPrivateIpAddress": { + "type": "structure", + "members": { + "PrivateIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddress", + "smithy.api#documentation": "

The private IP address assigned to the network interface.

", + "smithy.api#xmlName": "privateIpAddress" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the private IP addresses assigned to a network interface.

" + } + }, + "com.amazonaws.ec2#AssignedPrivateIpAddressList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AssignedPrivateIpAddress", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#AssociateAddress": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AssociateAddressRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AssociateAddressResult" + }, + "traits": { + "smithy.api#documentation": "

Associates an Elastic IP address, or carrier IP address (for instances that are in\n subnets in Wavelength Zones) with an instance or a network interface. Before you can use an\n Elastic IP address, you must allocate it to your account.

\n

If the Elastic IP address is already\n associated with a different instance, it is disassociated from that instance and associated\n with the specified instance. If you associate an Elastic IP address with an instance that has\n an existing Elastic IP address, the existing address is disassociated from the instance, but\n remains allocated to your account.

\n

[Subnets in Wavelength Zones] You can associate an IP address from the telecommunication\n carrier to the instance or network interface.

\n

You cannot associate an Elastic IP address with an interface in a different network border group.

\n \n

This is an idempotent operation. If you perform the operation more than once, Amazon EC2\n doesn't return an error, and you may be charged for each time the Elastic IP address is\n remapped to the same instance. For more information, see the Elastic IP\n Addresses section of Amazon EC2\n Pricing.

\n ", + "smithy.api#examples": [ + { + "title": "To associate an Elastic IP address", + "documentation": "This example associates the specified Elastic IP address with the specified instance.", + "input": { + "AllocationId": "eipalloc-64d5890a", + "InstanceId": "i-0b263919b6498b123" + }, + "output": { + "AssociationId": "eipassoc-2bebb745" + } + }, + { + "title": "To associate an Elastic IP address with a network interface", + "documentation": "This example associates the specified Elastic IP address with the specified network interface.", + "input": { + "AllocationId": "eipalloc-64d5890a", + "NetworkInterfaceId": "eni-1a2b3c4d" + }, + "output": { + "AssociationId": "eipassoc-2bebb745" + } + } + ] + } + }, + "com.amazonaws.ec2#AssociateAddressRequest": { + "type": "structure", + "members": { + "AllocationId": { + "target": "com.amazonaws.ec2#AllocationId", + "traits": { + "smithy.api#documentation": "

The allocation ID. This is required.

" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#documentation": "

The ID of the instance. The instance must have exactly one attached network interface.\n You can specify either the instance ID or the network interface ID, but not both.

" + } + }, + "PublicIp": { + "target": "com.amazonaws.ec2#EipAllocationPublicIp", + "traits": { + "smithy.api#documentation": "

Deprecated.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.

\n

You can specify either the instance ID or the network interface ID, but not both.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddress", + "smithy.api#documentation": "

The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.

", + "smithy.api#xmlName": "privateIpAddress" + } + }, + "AllowReassociation": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "AllowReassociation", + "smithy.api#documentation": "

Reassociation is automatic, but you can specify false to ensure the operation fails if the Elastic IP address is already associated with another resource.

", + "smithy.api#xmlName": "allowReassociation" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AssociateAddressResult": { + "type": "structure", + "members": { + "AssociationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AssociationId", + "smithy.api#documentation": "

The ID that represents the association of the Elastic IP address with an instance.

", + "smithy.api#xmlName": "associationId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AssociateCapacityReservationBillingOwner": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AssociateCapacityReservationBillingOwnerRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AssociateCapacityReservationBillingOwnerResult" + }, + "traits": { + "smithy.api#documentation": "

Initiates a request to assign billing of the unused capacity of a shared Capacity\n\t\t\tReservation to a consumer account that is consolidated under the same Amazon Web Services\n\t\t\torganizations payer account. For more information, see Billing assignment for shared\n\t\t\t\t\tAmazon EC2 Capacity Reservations.

" + } + }, + "com.amazonaws.ec2#AssociateCapacityReservationBillingOwnerRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "CapacityReservationId": { + "target": "com.amazonaws.ec2#CapacityReservationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Capacity Reservation.

", + "smithy.api#required": {} + } + }, + "UnusedReservationBillingOwnerId": { + "target": "com.amazonaws.ec2#AccountID", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the consumer account to which to assign billing.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AssociateCapacityReservationBillingOwnerResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AssociateClientVpnTargetNetwork": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AssociateClientVpnTargetNetworkRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AssociateClientVpnTargetNetworkResult" + }, + "traits": { + "smithy.api#documentation": "

Associates a target network with a Client VPN endpoint. A target network is a subnet in a VPC. You can associate multiple subnets from the same VPC with a Client VPN endpoint. You can associate only one subnet in each Availability Zone. We recommend that you associate at least two subnets to provide Availability Zone redundancy.

\n

If you specified a VPC when you created the Client VPN endpoint or if you have previous subnet associations, the specified subnet must be in the same VPC. To specify a subnet that's in a different VPC, you must first modify the Client VPN endpoint (ModifyClientVpnEndpoint) and change the VPC that's associated with it.

" + } + }, + "com.amazonaws.ec2#AssociateClientVpnTargetNetworkRequest": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#ClientVpnEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", + "smithy.api#required": {} + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the subnet to associate with the Client VPN endpoint.

", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. \nFor more information, see Ensuring idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AssociateClientVpnTargetNetworkResult": { + "type": "structure", + "members": { + "AssociationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AssociationId", + "smithy.api#documentation": "

The unique ID of the target network association.

", + "smithy.api#xmlName": "associationId" + } + }, + "Status": { + "target": "com.amazonaws.ec2#AssociationStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The current state of the target network association.

", + "smithy.api#xmlName": "status" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AssociateDhcpOptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AssociateDhcpOptionsRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.

\n

After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.

\n

For more information, see DHCP option sets\n in the Amazon VPC User Guide.

", + "smithy.api#examples": [ + { + "title": "To associate a DHCP options set with a VPC", + "documentation": "This example associates the specified DHCP options set with the specified VPC.", + "input": { + "DhcpOptionsId": "dopt-d9070ebb", + "VpcId": "vpc-a01106c2" + } + }, + { + "title": "To associate the default DHCP options set with a VPC", + "documentation": "This example associates the default DHCP options set with the specified VPC.", + "input": { + "DhcpOptionsId": "default", + "VpcId": "vpc-a01106c2" + } + } + ] + } + }, + "com.amazonaws.ec2#AssociateDhcpOptionsRequest": { + "type": "structure", + "members": { + "DhcpOptionsId": { + "target": "com.amazonaws.ec2#DefaultingDhcpOptionsId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the DHCP options set, or default to associate \n no DHCP options with the VPC.

", + "smithy.api#required": {} + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AssociateEnclaveCertificateIamRole": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AssociateEnclaveCertificateIamRoleRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AssociateEnclaveCertificateIamRoleResult" + }, + "traits": { + "smithy.api#documentation": "

Associates an Identity and Access Management (IAM) role with an Certificate Manager (ACM) certificate. \n\t\t\tThis enables the certificate to be used by the ACM for Nitro Enclaves application inside an enclave. For more \n\t\t\tinformation, see Certificate Manager for Nitro Enclaves in the Amazon Web Services Nitro Enclaves \n\t\t\t\t\tUser Guide.

\n

When the IAM role is associated with the ACM certificate, the certificate, certificate chain, and encrypted \n\t\t\tprivate key are placed in an Amazon S3 location that only the associated IAM role can access. The private key of the certificate \n\t\t\tis encrypted with an Amazon Web Services managed key that has an attached attestation-based key policy.

\n

To enable the IAM role to access the Amazon S3 object, you must grant it permission to call s3:GetObject \n\t\t\ton the Amazon S3 bucket returned by the command. To enable the IAM role to access the KMS key,\n\t\t\tyou must grant it permission to call kms:Decrypt on the KMS key returned by the command. \n\t\t\tFor more information, see \n\t\t\t\tGrant the role permission to access the certificate and encryption key in the \n\t\t\tAmazon Web Services Nitro Enclaves User Guide.

" + } + }, + "com.amazonaws.ec2#AssociateEnclaveCertificateIamRoleRequest": { + "type": "structure", + "members": { + "CertificateArn": { + "target": "com.amazonaws.ec2#CertificateId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the ACM certificate with which to associate the IAM role.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.ec2#RoleId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the IAM role to associate with the ACM certificate. You can associate up to 16 IAM roles with an ACM \n\t\t\tcertificate.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AssociateEnclaveCertificateIamRoleResult": { + "type": "structure", + "members": { + "CertificateS3BucketName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CertificateS3BucketName", + "smithy.api#documentation": "

The name of the Amazon S3 bucket to which the certificate was uploaded.

", + "smithy.api#xmlName": "certificateS3BucketName" + } + }, + "CertificateS3ObjectKey": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CertificateS3ObjectKey", + "smithy.api#documentation": "

The Amazon S3 object key where the certificate, certificate chain, and encrypted private key bundle are stored. The \n\t\t\tobject key is formatted as follows: role_arn/certificate_arn.

", + "smithy.api#xmlName": "certificateS3ObjectKey" + } + }, + "EncryptionKmsKeyId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "EncryptionKmsKeyId", + "smithy.api#documentation": "

The ID of the KMS key used to encrypt the private key of the certificate.

", + "smithy.api#xmlName": "encryptionKmsKeyId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AssociateIamInstanceProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AssociateIamInstanceProfileRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AssociateIamInstanceProfileResult" + }, + "traits": { + "smithy.api#documentation": "

Associates an IAM instance profile with a running or stopped instance. You cannot\n associate more than one IAM instance profile with an instance.

", + "smithy.api#examples": [ + { + "title": "To associate an IAM instance profile with an instance", + "documentation": "This example associates an IAM instance profile named admin-role with the specified instance.", + "input": { + "IamInstanceProfile": { + "Name": "admin-role" + }, + "InstanceId": "i-123456789abcde123" + }, + "output": { + "IamInstanceProfileAssociation": { + "InstanceId": "i-123456789abcde123", + "State": "associating", + "AssociationId": "iip-assoc-0e7736511a163c209", + "IamInstanceProfile": { + "Id": "AIPAJBLK7RKJKWDXVHIEC", + "Arn": "arn:aws:iam::123456789012:instance-profile/admin-role" + } + } + } + } + ] + } + }, + "com.amazonaws.ec2#AssociateIamInstanceProfileRequest": { + "type": "structure", + "members": { + "IamInstanceProfile": { + "target": "com.amazonaws.ec2#IamInstanceProfileSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IAM instance profile.

", + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AssociateIamInstanceProfileResult": { + "type": "structure", + "members": { + "IamInstanceProfileAssociation": { + "target": "com.amazonaws.ec2#IamInstanceProfileAssociation", + "traits": { + "aws.protocols#ec2QueryName": "IamInstanceProfileAssociation", + "smithy.api#documentation": "

Information about the IAM instance profile association.

", + "smithy.api#xmlName": "iamInstanceProfileAssociation" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AssociateInstanceEventWindow": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AssociateInstanceEventWindowRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AssociateInstanceEventWindowResult" + }, + "traits": { + "smithy.api#documentation": "

Associates one or more targets with an event window. Only one type of target (instance IDs,\n Dedicated Host IDs, or tags) can be specified with an event window.

\n

For more information, see Define event windows for scheduled\n events in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#AssociateInstanceEventWindowRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "InstanceEventWindowId": { + "target": "com.amazonaws.ec2#InstanceEventWindowId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the event window.

", + "smithy.api#required": {} + } + }, + "AssociationTarget": { + "target": "com.amazonaws.ec2#InstanceEventWindowAssociationRequest", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

One or more targets associated with the specified event window.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AssociateInstanceEventWindowResult": { + "type": "structure", + "members": { + "InstanceEventWindow": { + "target": "com.amazonaws.ec2#InstanceEventWindow", + "traits": { + "aws.protocols#ec2QueryName": "InstanceEventWindow", + "smithy.api#documentation": "

Information about the event window.

", + "smithy.api#xmlName": "instanceEventWindow" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AssociateIpamByoasn": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AssociateIpamByoasnRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AssociateIpamByoasnResult" + }, + "traits": { + "smithy.api#documentation": "

Associates your Autonomous System Number (ASN) with a BYOIP CIDR that you own in the same Amazon Web Services Region. \n For more information, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide.

\n

After the association succeeds, the ASN is eligible for \n advertisement. You can view the association with DescribeByoipCidrs. You can advertise the CIDR with AdvertiseByoipCidr.

" + } + }, + "com.amazonaws.ec2#AssociateIpamByoasnRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Asn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A public 2-byte or 4-byte ASN.

", + "smithy.api#required": {} + } + }, + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The BYOIP CIDR you want to associate with an ASN.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AssociateIpamByoasnResult": { + "type": "structure", + "members": { + "AsnAssociation": { + "target": "com.amazonaws.ec2#AsnAssociation", + "traits": { + "aws.protocols#ec2QueryName": "AsnAssociation", + "smithy.api#documentation": "

The ASN and BYOIP CIDR association.

", + "smithy.api#xmlName": "asnAssociation" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AssociateIpamResourceDiscovery": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AssociateIpamResourceDiscoveryRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AssociateIpamResourceDiscoveryResult" + }, + "traits": { + "smithy.api#documentation": "

Associates an IPAM resource discovery with an Amazon VPC IPAM. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

" + } + }, + "com.amazonaws.ec2#AssociateIpamResourceDiscoveryRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamId": { + "target": "com.amazonaws.ec2#IpamId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An IPAM ID.

", + "smithy.api#required": {} + } + }, + "IpamResourceDiscoveryId": { + "target": "com.amazonaws.ec2#IpamResourceDiscoveryId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A resource discovery ID.

", + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

Tag specifications.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A client token.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AssociateIpamResourceDiscoveryResult": { + "type": "structure", + "members": { + "IpamResourceDiscoveryAssociation": { + "target": "com.amazonaws.ec2#IpamResourceDiscoveryAssociation", + "traits": { + "aws.protocols#ec2QueryName": "IpamResourceDiscoveryAssociation", + "smithy.api#documentation": "

A resource discovery association. An associated resource discovery is a resource discovery that has been associated with an IPAM.

", + "smithy.api#xmlName": "ipamResourceDiscoveryAssociation" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AssociateNatGatewayAddress": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AssociateNatGatewayAddressRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AssociateNatGatewayAddressResult" + }, + "traits": { + "smithy.api#documentation": "

Associates Elastic IP addresses (EIPs) and private IPv4 addresses with a public NAT gateway. For more information, \n see Work with NAT gateways in the Amazon VPC User Guide.

\n

By default, you can associate up to 2 Elastic IP addresses per public NAT gateway. You can increase the limit by requesting a quota adjustment. \n For more information, see Elastic IP address quotas in the Amazon VPC User Guide.

\n \n

When you associate an EIP or secondary EIPs with a public NAT gateway, the network border group of the EIPs \n must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. If it's not the same, \n the EIP will fail to associate. You can see the network border group for the subnet's AZ by viewing the details of the subnet.\n Similarly, you can view the network border group of an EIP by viewing the details of the EIP address. For more information \n about network border groups and EIPs, see Allocate an Elastic IP address in the Amazon VPC User Guide. \n

\n " + } + }, + "com.amazonaws.ec2#AssociateNatGatewayAddressRequest": { + "type": "structure", + "members": { + "NatGatewayId": { + "target": "com.amazonaws.ec2#NatGatewayId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the NAT gateway.

", + "smithy.api#required": {} + } + }, + "AllocationIds": { + "target": "com.amazonaws.ec2#AllocationIdList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The allocation IDs of EIPs that you want to associate with your NAT gateway.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "AllocationId" + } + }, + "PrivateIpAddresses": { + "target": "com.amazonaws.ec2#IpList", + "traits": { + "smithy.api#documentation": "

The private IPv4 addresses that you want to assign to the NAT gateway.

", + "smithy.api#xmlName": "PrivateIpAddress" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AssociateNatGatewayAddressResult": { + "type": "structure", + "members": { + "NatGatewayId": { + "target": "com.amazonaws.ec2#NatGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "NatGatewayId", + "smithy.api#documentation": "

The ID of the NAT gateway.

", + "smithy.api#xmlName": "natGatewayId" + } + }, + "NatGatewayAddresses": { + "target": "com.amazonaws.ec2#NatGatewayAddressList", + "traits": { + "aws.protocols#ec2QueryName": "NatGatewayAddressSet", + "smithy.api#documentation": "

The IP addresses.

", + "smithy.api#xmlName": "natGatewayAddressSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AssociateRouteTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AssociateRouteTableRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AssociateRouteTableResult" + }, + "traits": { + "smithy.api#documentation": "

Associates a subnet in your VPC or an internet gateway or virtual private gateway\n attached to your VPC with a route table in your VPC. This association causes traffic\n from the subnet or gateway to be routed according to the routes in the route table. The\n action returns an association ID, which you need in order to disassociate the route\n table later. A route table can be associated with multiple subnets.

\n

For more information, see Route tables in the\n Amazon VPC User Guide.

", + "smithy.api#examples": [ + { + "title": "To associate a route table with a subnet", + "documentation": "This example associates the specified route table with the specified subnet.", + "input": { + "SubnetId": "subnet-9d4a7b6", + "RouteTableId": "rtb-22574640" + }, + "output": { + "AssociationId": "rtbassoc-781d0d1a" + } + } + ] + } + }, + "com.amazonaws.ec2#AssociateRouteTableRequest": { + "type": "structure", + "members": { + "GatewayId": { + "target": "com.amazonaws.ec2#RouteGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the internet gateway or virtual private gateway.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet.

", + "smithy.api#xmlName": "subnetId" + } + }, + "RouteTableId": { + "target": "com.amazonaws.ec2#RouteTableId", + "traits": { + "aws.protocols#ec2QueryName": "RouteTableId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the route table.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "routeTableId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AssociateRouteTableResult": { + "type": "structure", + "members": { + "AssociationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AssociationId", + "smithy.api#documentation": "

The route table association ID. This ID is required for disassociating the route\n\t\t\ttable.

", + "smithy.api#xmlName": "associationId" + } + }, + "AssociationState": { + "target": "com.amazonaws.ec2#RouteTableAssociationState", + "traits": { + "aws.protocols#ec2QueryName": "AssociationState", + "smithy.api#documentation": "

The state of the association.

", + "smithy.api#xmlName": "associationState" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AssociateSecurityGroupVpc": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AssociateSecurityGroupVpcRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AssociateSecurityGroupVpcResult" + }, + "traits": { + "smithy.api#documentation": "

Associates a security group with another VPC in the same Region. This enables you to use the same security group with network interfaces and instances in the specified VPC.

\n \n
    \n
  • \n

    The VPC you want to associate the security group with must be in the same Region.

    \n
    • \n
  • \n

    You can associate the security group with another VPC if your account owns the VPC or if the VPC was shared with you.

    \n
    • \n
  • \n

    You must own the security group and the VPC that it was created in.

    \n
    • \n
  • \n

    You cannot use this feature with default security groups.

    \n
    • \n
  • \n

    You cannot use this feature with the default VPC.

    \n
    • \n
\n " + } + }, + "com.amazonaws.ec2#AssociateSecurityGroupVpcRequest": { + "type": "structure", + "members": { + "GroupId": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A security group ID.

", + "smithy.api#required": {} + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A VPC ID.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AssociateSecurityGroupVpcResult": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.ec2#SecurityGroupVpcAssociationState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the association.

", + "smithy.api#xmlName": "state" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AssociateSubnetCidrBlock": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AssociateSubnetCidrBlockRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AssociateSubnetCidrBlockResult" + }, + "traits": { + "smithy.api#documentation": "

Associates a CIDR block with your subnet. You can only associate a single IPv6 CIDR\n block with your subnet.

" + } + }, + "com.amazonaws.ec2#AssociateSubnetCidrBlockRequest": { + "type": "structure", + "members": { + "Ipv6IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "smithy.api#documentation": "

An IPv6 IPAM pool ID.

" + } + }, + "Ipv6NetmaskLength": { + "target": "com.amazonaws.ec2#NetmaskLength", + "traits": { + "smithy.api#documentation": "

An IPv6 netmask length.

" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of your subnet.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "subnetId" + } + }, + "Ipv6CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6CidrBlock", + "smithy.api#documentation": "

The IPv6 CIDR block for your subnet.

", + "smithy.api#xmlName": "ipv6CidrBlock" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AssociateSubnetCidrBlockResult": { + "type": "structure", + "members": { + "Ipv6CidrBlockAssociation": { + "target": "com.amazonaws.ec2#SubnetIpv6CidrBlockAssociation", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6CidrBlockAssociation", + "smithy.api#documentation": "

Information about the IPv6 association.

", + "smithy.api#xmlName": "ipv6CidrBlockAssociation" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet.

", + "smithy.api#xmlName": "subnetId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AssociateTransitGatewayMulticastDomain": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AssociateTransitGatewayMulticastDomainRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AssociateTransitGatewayMulticastDomainResult" + }, + "traits": { + "smithy.api#documentation": "

Associates the specified subnets and transit gateway attachments with the specified transit gateway multicast domain.

\n

The transit gateway attachment must be in the available state before you can add a resource. Use DescribeTransitGatewayAttachments \n to see the state of the attachment.

" + } + }, + "com.amazonaws.ec2#AssociateTransitGatewayMulticastDomainRequest": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

", + "smithy.api#required": {} + } + }, + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway attachment to associate with the transit gateway multicast domain.

", + "smithy.api#required": {} + } + }, + "SubnetIds": { + "target": "com.amazonaws.ec2#TransitGatewaySubnetIdList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the subnets to associate with the transit gateway multicast domain.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AssociateTransitGatewayMulticastDomainResult": { + "type": "structure", + "members": { + "Associations": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainAssociations", + "traits": { + "aws.protocols#ec2QueryName": "Associations", + "smithy.api#documentation": "

Information about the transit gateway multicast domain associations.

", + "smithy.api#xmlName": "associations" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AssociateTransitGatewayPolicyTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AssociateTransitGatewayPolicyTableRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AssociateTransitGatewayPolicyTableResult" + }, + "traits": { + "smithy.api#documentation": "

Associates the specified transit gateway attachment with a transit gateway policy table.

" + } + }, + "com.amazonaws.ec2#AssociateTransitGatewayPolicyTableRequest": { + "type": "structure", + "members": { + "TransitGatewayPolicyTableId": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway policy table to associate with the transit gateway attachment.

", + "smithy.api#required": {} + } + }, + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway attachment to associate with the policy table.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AssociateTransitGatewayPolicyTableResult": { + "type": "structure", + "members": { + "Association": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableAssociation", + "traits": { + "aws.protocols#ec2QueryName": "Association", + "smithy.api#documentation": "

Describes the association of a transit gateway and a transit gateway policy table.

", + "smithy.api#xmlName": "association" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AssociateTransitGatewayRouteTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AssociateTransitGatewayRouteTableRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AssociateTransitGatewayRouteTableResult" + }, + "traits": { + "smithy.api#documentation": "

Associates the specified attachment with the specified transit gateway route table. You can \n associate only one route table with an attachment.

" + } + }, + "com.amazonaws.ec2#AssociateTransitGatewayRouteTableRequest": { + "type": "structure", + "members": { + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway route table.

", + "smithy.api#required": {} + } + }, + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the attachment.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AssociateTransitGatewayRouteTableResult": { + "type": "structure", + "members": { + "Association": { + "target": "com.amazonaws.ec2#TransitGatewayAssociation", + "traits": { + "aws.protocols#ec2QueryName": "Association", + "smithy.api#documentation": "

The ID of the association.

", + "smithy.api#xmlName": "association" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AssociateTrunkInterface": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AssociateTrunkInterfaceRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AssociateTrunkInterfaceResult" + }, + "traits": { + "smithy.api#documentation": "

Associates a branch network interface with a trunk network interface.

\n

Before you create the association, use CreateNetworkInterface command and set the interface type\n to trunk. You must also create a network interface for \n each branch network interface that you want to associate with the trunk \n network interface.

" + } + }, + "com.amazonaws.ec2#AssociateTrunkInterfaceRequest": { + "type": "structure", + "members": { + "BranchInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the branch network interface.

", + "smithy.api#required": {} + } + }, + "TrunkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the trunk network interface.

", + "smithy.api#required": {} + } + }, + "VlanId": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The ID of the VLAN. This applies to the VLAN protocol.

" + } + }, + "GreKey": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The application key. This applies to the GRE protocol.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AssociateTrunkInterfaceResult": { + "type": "structure", + "members": { + "InterfaceAssociation": { + "target": "com.amazonaws.ec2#TrunkInterfaceAssociation", + "traits": { + "aws.protocols#ec2QueryName": "InterfaceAssociation", + "smithy.api#documentation": "

Information about the association between the trunk network interface and branch network interface.

", + "smithy.api#xmlName": "interfaceAssociation" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n idempotency.

", + "smithy.api#xmlName": "clientToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AssociateVpcCidrBlock": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AssociateVpcCidrBlockRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AssociateVpcCidrBlockResult" + }, + "traits": { + "smithy.api#documentation": "

Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR block,\n an Amazon-provided IPv6 CIDR block, or an IPv6 CIDR block from an IPv6 address pool that\n you provisioned through bring your own IP addresses (BYOIP).

\n

You must specify one of the following in the request: an IPv4 CIDR block, an IPv6\n pool, or an Amazon-provided IPv6 CIDR block.

\n

For more information about associating CIDR blocks with your VPC and applicable\n restrictions, see IP addressing for your VPCs and subnets \n in the Amazon VPC User Guide.

" + } + }, + "com.amazonaws.ec2#AssociateVpcCidrBlockRequest": { + "type": "structure", + "members": { + "CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

An IPv4 CIDR block to associate with the VPC.

" + } + }, + "Ipv6CidrBlockNetworkBorderGroup": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the location from which we advertise the IPV6 CIDR block. Use this parameter\n to limit the CIDR block to this location.

\n

You must set AmazonProvidedIpv6CidrBlock to true to use this parameter.

\n

You can have one IPv6 CIDR block association per network border group.

" + } + }, + "Ipv6Pool": { + "target": "com.amazonaws.ec2#Ipv6PoolEc2Id", + "traits": { + "smithy.api#documentation": "

The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.

" + } + }, + "Ipv6CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

An IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request.

\n

To let Amazon choose the IPv6 CIDR block for you, omit this parameter.

" + } + }, + "Ipv4IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "smithy.api#documentation": "

Associate a CIDR allocated from an IPv4 IPAM pool to a VPC. For more information about Amazon VPC IP Address Manager (IPAM), see What is IPAM? in the Amazon VPC IPAM User Guide.

" + } + }, + "Ipv4NetmaskLength": { + "target": "com.amazonaws.ec2#NetmaskLength", + "traits": { + "smithy.api#documentation": "

The netmask length of the IPv4 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.\n

" + } + }, + "Ipv6IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "smithy.api#documentation": "

Associates a CIDR allocated from an IPv6 IPAM pool to a VPC. For more information about Amazon VPC IP Address Manager (IPAM), see What is IPAM? in the Amazon VPC IPAM User Guide.

" + } + }, + "Ipv6NetmaskLength": { + "target": "com.amazonaws.ec2#NetmaskLength", + "traits": { + "smithy.api#documentation": "

The netmask length of the IPv6 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.

" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "vpcId" + } + }, + "AmazonProvidedIpv6CidrBlock": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "AmazonProvidedIpv6CidrBlock", + "smithy.api#documentation": "

Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You\n cannot specify the range of IPv6 addresses or the size of the CIDR block.

", + "smithy.api#xmlName": "amazonProvidedIpv6CidrBlock" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AssociateVpcCidrBlockResult": { + "type": "structure", + "members": { + "Ipv6CidrBlockAssociation": { + "target": "com.amazonaws.ec2#VpcIpv6CidrBlockAssociation", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6CidrBlockAssociation", + "smithy.api#documentation": "

Information about the IPv6 CIDR block association.

", + "smithy.api#xmlName": "ipv6CidrBlockAssociation" + } + }, + "CidrBlockAssociation": { + "target": "com.amazonaws.ec2#VpcCidrBlockAssociation", + "traits": { + "aws.protocols#ec2QueryName": "CidrBlockAssociation", + "smithy.api#documentation": "

Information about the IPv4 CIDR block association.

", + "smithy.api#xmlName": "cidrBlockAssociation" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "vpcId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AssociatedNetworkType": { + "type": "enum", + "members": { + "vpc": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vpc" + } + } + } + }, + "com.amazonaws.ec2#AssociatedRole": { + "type": "structure", + "members": { + "AssociatedRoleArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "AssociatedRoleArn", + "smithy.api#documentation": "

The ARN of the associated IAM role.

", + "smithy.api#xmlName": "associatedRoleArn" + } + }, + "CertificateS3BucketName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CertificateS3BucketName", + "smithy.api#documentation": "

The name of the Amazon S3 bucket in which the Amazon S3 object is stored.

", + "smithy.api#xmlName": "certificateS3BucketName" + } + }, + "CertificateS3ObjectKey": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CertificateS3ObjectKey", + "smithy.api#documentation": "

The key of the Amazon S3 object where the certificate, certificate chain, and encrypted private key bundle \n\t\t\tare stored. The object key is formatted as follows: role_arn/certificate_arn.\n\t\t

", + "smithy.api#xmlName": "certificateS3ObjectKey" + } + }, + "EncryptionKmsKeyId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "EncryptionKmsKeyId", + "smithy.api#documentation": "

The ID of the KMS key used to encrypt the private key.

", + "smithy.api#xmlName": "encryptionKmsKeyId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the associated IAM roles.

" + } + }, + "com.amazonaws.ec2#AssociatedRolesList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AssociatedRole", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#AssociatedTargetNetwork": { + "type": "structure", + "members": { + "NetworkId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkId", + "smithy.api#documentation": "

The ID of the subnet.

", + "smithy.api#xmlName": "networkId" + } + }, + "NetworkType": { + "target": "com.amazonaws.ec2#AssociatedNetworkType", + "traits": { + "aws.protocols#ec2QueryName": "NetworkType", + "smithy.api#documentation": "

The target network type.

", + "smithy.api#xmlName": "networkType" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a target network that is associated with a Client VPN endpoint. A target network is a subnet in a VPC.

" + } + }, + "com.amazonaws.ec2#AssociatedTargetNetworkSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AssociatedTargetNetwork", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#AssociationIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IamInstanceProfileAssociationId", + "traits": { + "smithy.api#xmlName": "AssociationId" + } + } + }, + "com.amazonaws.ec2#AssociationStatus": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#AssociationStatusCode", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The state of the target network association.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

A message about the status of the target network association, if applicable.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the state of a target network association.

" + } + }, + "com.amazonaws.ec2#AssociationStatusCode": { + "type": "enum", + "members": { + "associating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associating" + } + }, + "associated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associated" + } + }, + "association_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "association-failed" + } + }, + "disassociating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociating" + } + }, + "disassociated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociated" + } + } + } + }, + "com.amazonaws.ec2#AthenaIntegration": { + "type": "structure", + "members": { + "IntegrationResultS3DestinationArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The location in Amazon S3 to store the generated CloudFormation template.

", + "smithy.api#required": {} + } + }, + "PartitionLoadFrequency": { + "target": "com.amazonaws.ec2#PartitionLoadFrequency", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The schedule for adding new partitions to the table.

", + "smithy.api#required": {} + } + }, + "PartitionStartDate": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "smithy.api#documentation": "

The start date for the partition.

" + } + }, + "PartitionEndDate": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "smithy.api#documentation": "

The end date for the partition.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes integration options for Amazon Athena.

" + } + }, + "com.amazonaws.ec2#AthenaIntegrationsSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AthenaIntegration", + "traits": { + "smithy.api#xmlName": "item" + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.ec2#AttachClassicLinkVpc": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AttachClassicLinkVpcRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AttachClassicLinkVpcResult" + }, + "traits": { + "smithy.api#documentation": "\n

This action is deprecated.

\n \n

Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC\n\t\t\tsecurity groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You\n\t\t\tcan only link an instance that's in the running state. An instance is\n\t\t\tautomatically unlinked from a VPC when it's stopped - you can link it to the VPC again when\n\t\t\tyou restart it.

\n

After you've linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again.

\n

Linking your instance to a VPC is sometimes referred to as attaching your instance.

" + } + }, + "com.amazonaws.ec2#AttachClassicLinkVpcRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the EC2-Classic instance.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "instanceId" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the ClassicLink-enabled VPC.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "vpcId" + } + }, + "Groups": { + "target": "com.amazonaws.ec2#GroupIdStringList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the security groups. You cannot specify security groups from a different VPC.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "SecurityGroupId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AttachClassicLinkVpcResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AttachInternetGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AttachInternetGatewayRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Attaches an internet gateway or a virtual private gateway to a VPC, enabling connectivity \n\t\t between the internet and the VPC. For more information, see Internet gateways in the \n\t\t Amazon VPC User Guide.

", + "smithy.api#examples": [ + { + "title": "To attach an Internet gateway to a VPC", + "documentation": "This example attaches the specified Internet gateway to the specified VPC.", + "input": { + "InternetGatewayId": "igw-c0a643a9", + "VpcId": "vpc-a01106c2" + } + } + ] + } + }, + "com.amazonaws.ec2#AttachInternetGatewayRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "InternetGatewayId": { + "target": "com.amazonaws.ec2#InternetGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "InternetGatewayId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the internet gateway.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "internetGatewayId" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "vpcId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AttachNetworkInterface": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AttachNetworkInterfaceRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AttachNetworkInterfaceResult" + }, + "traits": { + "smithy.api#documentation": "

Attaches a network interface to an instance.

", + "smithy.api#examples": [ + { + "title": "To attach a network interface to an instance", + "documentation": "This example attaches the specified network interface to the specified instance.", + "input": { + "NetworkInterfaceId": "eni-e5aa89a3", + "InstanceId": "i-1234567890abcdef0", + "DeviceIndex": 1 + }, + "output": { + "AttachmentId": "eni-attach-66c4350a" + } + } + ] + } + }, + "com.amazonaws.ec2#AttachNetworkInterfaceRequest": { + "type": "structure", + "members": { + "NetworkCardIndex": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The index of the network card. Some instance types support multiple network cards. \n The primary network interface must be assigned to network card index 0. \n The default is network card index 0.

" + } + }, + "EnaSrdSpecification": { + "target": "com.amazonaws.ec2#EnaSrdSpecification", + "traits": { + "smithy.api#documentation": "

Configures ENA Express for the network interface that this action attaches to the instance.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "instanceId" + } + }, + "DeviceIndex": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "DeviceIndex", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The index of the device for the network interface attachment.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "deviceIndex" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for AttachNetworkInterface.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AttachNetworkInterfaceResult": { + "type": "structure", + "members": { + "AttachmentId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AttachmentId", + "smithy.api#documentation": "

The ID of the network interface attachment.

", + "smithy.api#xmlName": "attachmentId" + } + }, + "NetworkCardIndex": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "NetworkCardIndex", + "smithy.api#documentation": "

The index of the network card.

", + "smithy.api#xmlName": "networkCardIndex" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of AttachNetworkInterface.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AttachVerifiedAccessTrustProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AttachVerifiedAccessTrustProviderRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AttachVerifiedAccessTrustProviderResult" + }, + "traits": { + "smithy.api#documentation": "

Attaches the specified Amazon Web Services Verified Access trust provider to the specified Amazon Web Services Verified Access instance.

" + } + }, + "com.amazonaws.ec2#AttachVerifiedAccessTrustProviderRequest": { + "type": "structure", + "members": { + "VerifiedAccessInstanceId": { + "target": "com.amazonaws.ec2#VerifiedAccessInstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Verified Access instance.

", + "smithy.api#required": {} + } + }, + "VerifiedAccessTrustProviderId": { + "target": "com.amazonaws.ec2#VerifiedAccessTrustProviderId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Verified Access trust provider.

", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AttachVerifiedAccessTrustProviderResult": { + "type": "structure", + "members": { + "VerifiedAccessTrustProvider": { + "target": "com.amazonaws.ec2#VerifiedAccessTrustProvider", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessTrustProvider", + "smithy.api#documentation": "

Details about the Verified Access trust provider.

", + "smithy.api#xmlName": "verifiedAccessTrustProvider" + } + }, + "VerifiedAccessInstance": { + "target": "com.amazonaws.ec2#VerifiedAccessInstance", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessInstance", + "smithy.api#documentation": "

Details about the Verified Access instance.

", + "smithy.api#xmlName": "verifiedAccessInstance" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AttachVolume": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AttachVolumeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#VolumeAttachment" + }, + "traits": { + "smithy.api#documentation": "

Attaches an EBS volume to a running or stopped instance and exposes it to the instance\n with the specified device name.

\n

Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. For\n more information, see Amazon EBS encryption in the Amazon EBS User Guide.

\n

After you attach an EBS volume, you must make it available. For more information, see \n Make an EBS volume available for use.

\n

If a volume has an Amazon Web Services Marketplace product code:

\n \n

For more information, see Attach an Amazon EBS volume to an instance in the\n Amazon EBS User Guide.

", + "smithy.api#examples": [ + { + "title": "To attach a volume to an instance", + "documentation": "This example attaches a volume (``vol-1234567890abcdef0``) to an instance (``i-01474ef662b89480``) as ``/dev/sdf``.", + "input": { + "VolumeId": "vol-1234567890abcdef0", + "InstanceId": "i-01474ef662b89480", + "Device": "/dev/sdf" + }, + "output": { + "AttachTime": "2016-08-29T18:52:32.724Z", + "InstanceId": "i-01474ef662b89480", + "VolumeId": "vol-1234567890abcdef0", + "State": "attaching", + "Device": "/dev/sdf" + } + } + ] + } + }, + "com.amazonaws.ec2#AttachVolumeRequest": { + "type": "structure", + "members": { + "Device": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The device name (for example, /dev/sdh or xvdh).

", + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#required": {} + } + }, + "VolumeId": { + "target": "com.amazonaws.ec2#VolumeId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the EBS volume. The volume and instance must be within the same Availability\n Zone.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AttachVpnGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AttachVpnGatewayRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AttachVpnGatewayResult" + }, + "traits": { + "smithy.api#documentation": "

Attaches an available virtual private gateway to a VPC. You can attach one virtual private\n gateway to one VPC at a time.

\n

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.

" + } + }, + "com.amazonaws.ec2#AttachVpnGatewayRequest": { + "type": "structure", + "members": { + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#required": {} + } + }, + "VpnGatewayId": { + "target": "com.amazonaws.ec2#VpnGatewayId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the virtual private gateway.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for AttachVpnGateway.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AttachVpnGatewayResult": { + "type": "structure", + "members": { + "VpcAttachment": { + "target": "com.amazonaws.ec2#VpcAttachment", + "traits": { + "aws.protocols#ec2QueryName": "Attachment", + "smithy.api#documentation": "

Information about the attachment.

", + "smithy.api#xmlName": "attachment" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of AttachVpnGateway.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AttachmentEnaSrdSpecification": { + "type": "structure", + "members": { + "EnaSrdEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EnaSrdEnabled", + "smithy.api#documentation": "

Indicates whether ENA Express is enabled for the network interface.

", + "smithy.api#xmlName": "enaSrdEnabled" + } + }, + "EnaSrdUdpSpecification": { + "target": "com.amazonaws.ec2#AttachmentEnaSrdUdpSpecification", + "traits": { + "aws.protocols#ec2QueryName": "EnaSrdUdpSpecification", + "smithy.api#documentation": "

Configures ENA Express for UDP network traffic.

", + "smithy.api#xmlName": "enaSrdUdpSpecification" + } + } + }, + "traits": { + "smithy.api#documentation": "

ENA Express uses Amazon Web Services Scalable Reliable Datagram (SRD) technology to increase the \n\t\t\tmaximum bandwidth used per stream and minimize tail latency of network traffic between EC2 instances. \n\t\t\tWith ENA Express, you can communicate between two EC2 instances in the same subnet within the same \n\t\t\taccount, or in different accounts. Both sending and receiving instances must have ENA Express enabled.

\n

To improve the reliability of network packet delivery, ENA Express reorders network packets on the \n\t\t\treceiving end by default. However, some UDP-based applications are designed to handle network packets \n\t\t\tthat are out of order to reduce the overhead for packet delivery at the network layer. When ENA Express \n\t\t\tis enabled, you can specify whether UDP network traffic uses it.

" + } + }, + "com.amazonaws.ec2#AttachmentEnaSrdUdpSpecification": { + "type": "structure", + "members": { + "EnaSrdUdpEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EnaSrdUdpEnabled", + "smithy.api#documentation": "

Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, \n\t\t\tyou must first enable ENA Express.

", + "smithy.api#xmlName": "enaSrdUdpEnabled" + } + } + }, + "traits": { + "smithy.api#documentation": "

ENA Express is compatible with both TCP and UDP transport protocols. When it's enabled, TCP traffic \n\t\t\tautomatically uses it. However, some UDP-based applications are designed to handle network packets that are \n\t\t\tout of order, without a need for retransmission, such as live video broadcasting or other near-real-time \n\t\t\tapplications. For UDP traffic, you can specify whether to use ENA Express, based on your application \n\t\t\tenvironment needs.

" + } + }, + "com.amazonaws.ec2#AttachmentStatus": { + "type": "enum", + "members": { + "attaching": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "attaching" + } + }, + "attached": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "attached" + } + }, + "detaching": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "detaching" + } + }, + "detached": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "detached" + } + } + } + }, + "com.amazonaws.ec2#AttributeBooleanValue": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Value", + "smithy.api#documentation": "

The attribute value. The valid values are true or false.

", + "smithy.api#xmlName": "value" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a value for a resource attribute that is a Boolean value.

" + } + }, + "com.amazonaws.ec2#AttributeSummary": { + "type": "structure", + "members": { + "AttributeName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AttributeName", + "smithy.api#documentation": "

The name of the attribute.

", + "smithy.api#xmlName": "attributeName" + } + }, + "MostFrequentValue": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "MostFrequentValue", + "smithy.api#documentation": "

The configuration value that is most frequently observed for the attribute.

", + "smithy.api#xmlName": "mostFrequentValue" + } + }, + "NumberOfMatchedAccounts": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "NumberOfMatchedAccounts", + "smithy.api#documentation": "

The number of accounts with the same configuration value for the attribute that is\n most frequently observed.

", + "smithy.api#xmlName": "numberOfMatchedAccounts" + } + }, + "NumberOfUnmatchedAccounts": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "NumberOfUnmatchedAccounts", + "smithy.api#documentation": "

The number of accounts with a configuration value different from the most frequently\n observed value for the attribute.

", + "smithy.api#xmlName": "numberOfUnmatchedAccounts" + } + }, + "RegionalSummaries": { + "target": "com.amazonaws.ec2#RegionalSummaryList", + "traits": { + "aws.protocols#ec2QueryName": "RegionalSummarySet", + "smithy.api#documentation": "

The summary report for each Region for the attribute.

", + "smithy.api#xmlName": "regionalSummarySet" + } + } + }, + "traits": { + "smithy.api#documentation": "

A summary report for the attribute across all Regions.

" + } + }, + "com.amazonaws.ec2#AttributeSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AttributeSummary", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#AttributeValue": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Value", + "smithy.api#documentation": "

The attribute value. The value is case-sensitive.

", + "smithy.api#xmlName": "value" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a value for a resource attribute that is a String.

" + } + }, + "com.amazonaws.ec2#AuthorizationRule": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientVpnEndpointId", + "smithy.api#documentation": "

The ID of the Client VPN endpoint with which the authorization rule is associated.

", + "smithy.api#xmlName": "clientVpnEndpointId" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A brief description of the authorization rule.

", + "smithy.api#xmlName": "description" + } + }, + "GroupId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupId", + "smithy.api#documentation": "

The ID of the Active Directory group to which the authorization rule grants access.

", + "smithy.api#xmlName": "groupId" + } + }, + "AccessAll": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "AccessAll", + "smithy.api#documentation": "

Indicates whether the authorization rule grants access to all clients.

", + "smithy.api#xmlName": "accessAll" + } + }, + "DestinationCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationCidr", + "smithy.api#documentation": "

The IPv4 address range, in CIDR notation, of the network to which the authorization rule applies.

", + "smithy.api#xmlName": "destinationCidr" + } + }, + "Status": { + "target": "com.amazonaws.ec2#ClientVpnAuthorizationRuleStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The current state of the authorization rule.

", + "smithy.api#xmlName": "status" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an authorization rule.

" + } + }, + "com.amazonaws.ec2#AuthorizationRuleSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AuthorizationRule", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#AuthorizeClientVpnIngress": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AuthorizeClientVpnIngressRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AuthorizeClientVpnIngressResult" + }, + "traits": { + "smithy.api#documentation": "

Adds an ingress authorization rule to a Client VPN endpoint. Ingress authorization rules act as \n\t\t\tfirewall rules that grant access to networks. You must configure ingress authorization rules to \n\t\t\tenable clients to access resources in Amazon Web Services or on-premises networks.

" + } + }, + "com.amazonaws.ec2#AuthorizeClientVpnIngressRequest": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#ClientVpnEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", + "smithy.api#required": {} + } + }, + "TargetNetworkCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IPv4 address range, in CIDR notation, of the network for which access is being authorized.

", + "smithy.api#required": {} + } + }, + "AccessGroupId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group. Required if AuthorizeAllGroups is false or not specified.

" + } + }, + "AuthorizeAllGroups": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether to grant access to all clients. Specify true to grant all\n clients who successfully establish a VPN connection access to the network. Must be set\n to true if AccessGroupId is not specified.

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A brief description of the authorization rule.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. \nFor more information, see Ensuring idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AuthorizeClientVpnIngressResult": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.ec2#ClientVpnAuthorizationRuleStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The current state of the authorization rule.

", + "smithy.api#xmlName": "status" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AuthorizeSecurityGroupEgress": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AuthorizeSecurityGroupEgressRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AuthorizeSecurityGroupEgressResult" + }, + "traits": { + "smithy.api#documentation": "

Adds the specified outbound (egress) rules to a security group.

\n

An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 \n address ranges, the IP address ranges specified by a prefix list, or the instances \n that are associated with a source security group. For more information, see Security group rules.

\n

You must specify exactly one of the following destinations: an IPv4 or IPv6 address range, \n a prefix list, or a security group. You must specify a protocol for each rule (for example, TCP). \n If the protocol is TCP or UDP, you must also specify a port or port range. If the protocol is \n ICMP or ICMPv6, you must also specify the ICMP type and code.

\n

Rule changes are propagated to instances associated with the security group as quickly \n as possible. However, a small delay might occur.

\n

For examples of rules that you can add to security groups for specific access scenarios, \n see Security group rules for different use cases in the Amazon EC2 User Guide.

\n

For information about security group quotas, see Amazon VPC quotas in the Amazon VPC User Guide.

", + "smithy.api#examples": [ + { + "title": "To add a rule that allows outbound traffic to a specific address range", + "documentation": "This example adds a rule that grants access to the specified address ranges on TCP port 80.", + "input": { + "GroupId": "sg-1a2b3c4d", + "IpPermissions": [ + { + "IpProtocol": "tcp", + "FromPort": 80, + "ToPort": 80, + "IpRanges": [ + { + "CidrIp": "10.0.0.0/16" + } + ] + } + ] + }, + "output": {} + }, + { + "title": "To add a rule that allows outbound traffic to a specific security group", + "documentation": "This example adds a rule that grants access to the specified security group on TCP port 80.", + "input": { + "GroupId": "sg-1a2b3c4d", + "IpPermissions": [ + { + "IpProtocol": "tcp", + "FromPort": 80, + "ToPort": 80, + "UserIdGroupPairs": [ + { + "GroupId": "sg-4b51a32f" + } + ] + } + ] + }, + "output": {} + } + ] + } + }, + "com.amazonaws.ec2#AuthorizeSecurityGroupEgressRequest": { + "type": "structure", + "members": { + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags applied to the security group rule.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "GroupId": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "aws.protocols#ec2QueryName": "GroupId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the security group.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "groupId" + } + }, + "SourceSecurityGroupName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SourceSecurityGroupName", + "smithy.api#documentation": "

Not supported. Use IP permissions instead.

", + "smithy.api#xmlName": "sourceSecurityGroupName" + } + }, + "SourceSecurityGroupOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SourceSecurityGroupOwnerId", + "smithy.api#documentation": "

Not supported. Use IP permissions instead.

", + "smithy.api#xmlName": "sourceSecurityGroupOwnerId" + } + }, + "IpProtocol": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IpProtocol", + "smithy.api#documentation": "

Not supported. Use IP permissions instead.

", + "smithy.api#xmlName": "ipProtocol" + } + }, + "FromPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "FromPort", + "smithy.api#documentation": "

Not supported. Use IP permissions instead.

", + "smithy.api#xmlName": "fromPort" + } + }, + "ToPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "ToPort", + "smithy.api#documentation": "

Not supported. Use IP permissions instead.

", + "smithy.api#xmlName": "toPort" + } + }, + "CidrIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CidrIp", + "smithy.api#documentation": "

Not supported. Use IP permissions instead.

", + "smithy.api#xmlName": "cidrIp" + } + }, + "IpPermissions": { + "target": "com.amazonaws.ec2#IpPermissionList", + "traits": { + "aws.protocols#ec2QueryName": "IpPermissions", + "smithy.api#documentation": "

The permissions for the security group rules.

", + "smithy.api#xmlName": "ipPermissions" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AuthorizeSecurityGroupEgressResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, returns an error.

", + "smithy.api#xmlName": "return" + } + }, + "SecurityGroupRules": { + "target": "com.amazonaws.ec2#SecurityGroupRuleList", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroupRuleSet", + "smithy.api#documentation": "

Information about the outbound (egress) security group rules that were added.

", + "smithy.api#xmlName": "securityGroupRuleSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AuthorizeSecurityGroupIngress": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AuthorizeSecurityGroupIngressRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AuthorizeSecurityGroupIngressResult" + }, + "traits": { + "smithy.api#documentation": "

Adds the specified inbound (ingress) rules to a security group.

\n

An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 \n address range, the IP address ranges that are specified by a prefix list, or the instances \n that are associated with a destination security group. For more information, see Security group rules.

\n

You must specify exactly one of the following sources: an IPv4 or IPv6 address range,\n a prefix list, or a security group. You must specify a protocol for each rule (for example, TCP). \n If the protocol is TCP or UDP, you must also specify a port or port range. If the protocol is \n ICMP or ICMPv6, you must also specify the ICMP/ICMPv6 type and code.

\n

Rule changes are propagated to instances associated with the security group as quickly \n as possible. However, a small delay might occur.

\n

For examples of rules that you can add to security groups for specific access scenarios, \n see Security group rules for different use cases in the Amazon EC2 User Guide.

\n

For more information about security group quotas, see Amazon VPC quotas in the Amazon VPC User Guide.

", + "smithy.api#examples": [ + { + "title": "To add a rule that allows inbound HTTP traffic from another security group", + "documentation": "This example enables inbound traffic on TCP port 80 from the specified security group. The group must be in the same VPC or a peer VPC. Incoming traffic is allowed based on the private IP addresses of instances that are associated with the specified security group.", + "input": { + "GroupId": "sg-111aaa22", + "IpPermissions": [ + { + "IpProtocol": "tcp", + "FromPort": 80, + "ToPort": 80, + "UserIdGroupPairs": [ + { + "GroupId": "sg-1a2b3c4d", + "Description": "HTTP access from other instances" + } + ] + } + ] + }, + "output": {} + }, + { + "title": "To add a rule that allows inbound SSH traffic from an IPv4 address range", + "documentation": "This example enables inbound traffic on TCP port 22 (SSH). The rule includes a description to help you identify it later.", + "input": { + "GroupId": "sg-903004f8", + "IpPermissions": [ + { + "IpProtocol": "tcp", + "FromPort": 22, + "ToPort": 22, + "IpRanges": [ + { + "CidrIp": "203.0.113.0/24", + "Description": "SSH access from the LA office" + } + ] + } + ] + }, + "output": {} + }, + { + "title": "To add a rule that allows inbound RDP traffic from an IPv6 address range", + "documentation": "This example adds an inbound rule that allows RDP traffic from the specified IPv6 address range. The rule includes a description to help you identify it later.", + "input": { + "GroupId": "sg-123abc12 ", + "IpPermissions": [ + { + "IpProtocol": "tcp", + "FromPort": 3389, + "ToPort": 3389, + "Ipv6Ranges": [ + { + "CidrIpv6": "2001:db8:1234:1a00::/64", + "Description": "RDP access from the NY office" + } + ] + } + ] + }, + "output": {} + } + ] + } + }, + "com.amazonaws.ec2#AuthorizeSecurityGroupIngressRequest": { + "type": "structure", + "members": { + "CidrIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IPv4 address range, in CIDR format.

\n

To specify an IPv6 address range, use IP permissions instead.

\n

To specify multiple rules and descriptions for the rules, use IP permissions instead.

" + } + }, + "FromPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

If the protocol is TCP or UDP, this is the start of the port range.\n If the protocol is ICMP, this is the ICMP type or -1 (all ICMP types).

\n

To specify multiple rules and descriptions for the rules, use IP permissions instead.

" + } + }, + "GroupId": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "smithy.api#documentation": "

The ID of the security group.

" + } + }, + "GroupName": { + "target": "com.amazonaws.ec2#SecurityGroupName", + "traits": { + "smithy.api#documentation": "

[Default VPC] The name of the security group. For security groups for a default VPC\n you can specify either the ID or the name of the security group. For security groups for\n a nondefault VPC, you must specify the ID of the security group.

" + } + }, + "IpPermissions": { + "target": "com.amazonaws.ec2#IpPermissionList", + "traits": { + "smithy.api#documentation": "

The permissions for the security group rules.

" + } + }, + "IpProtocol": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IP protocol name (tcp, udp, icmp) or number\n (see Protocol Numbers). To specify all protocols, use -1.

\n

To specify icmpv6, use IP permissions instead.

\n

If you specify a protocol other than one of the supported values, traffic is allowed \n on all ports, regardless of any ports that you specify.

\n

To specify multiple rules and descriptions for the rules, use IP permissions instead.

" + } + }, + "SourceSecurityGroupName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

[Default VPC] The name of the source security group.

\n

The rule grants full ICMP, UDP, and TCP access. To create a rule with a specific protocol\n and port range, specify a set of IP permissions instead.

" + } + }, + "SourceSecurityGroupOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID for the source security group, if the source security group is \n in a different account.

\n

The rule grants full ICMP, UDP, and TCP access. To create a rule with a specific protocol \n and port range, use IP permissions instead.

" + } + }, + "ToPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

If the protocol is TCP or UDP, this is the end of the port range.\n If the protocol is ICMP, this is the ICMP code or -1 (all ICMP codes). \n If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes).

\n

To specify multiple rules and descriptions for the rules, use IP permissions instead.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags applied to the security group rule.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AuthorizeSecurityGroupIngressResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, returns an error.

", + "smithy.api#xmlName": "return" + } + }, + "SecurityGroupRules": { + "target": "com.amazonaws.ec2#SecurityGroupRuleList", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroupRuleSet", + "smithy.api#documentation": "

Information about the inbound (ingress) security group rules that were added.

", + "smithy.api#xmlName": "securityGroupRuleSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AutoAcceptSharedAssociationsValue": { + "type": "enum", + "members": { + "enable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enable" + } + }, + "disable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disable" + } + } + } + }, + "com.amazonaws.ec2#AutoAcceptSharedAttachmentsValue": { + "type": "enum", + "members": { + "enable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enable" + } + }, + "disable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disable" + } + } + } + }, + "com.amazonaws.ec2#AutoPlacement": { + "type": "enum", + "members": { + "on": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "on" + } + }, + "off": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "off" + } + } + } + }, + "com.amazonaws.ec2#AutoRecoveryFlag": { + "type": "boolean" + }, + "com.amazonaws.ec2#AvailabilityZone": { + "type": "structure", + "members": { + "OptInStatus": { + "target": "com.amazonaws.ec2#AvailabilityZoneOptInStatus", + "traits": { + "aws.protocols#ec2QueryName": "OptInStatus", + "smithy.api#documentation": "

For Availability Zones, this parameter always has the value of\n opt-in-not-required.

\n

For Local Zones and Wavelength Zones, this parameter is the opt-in status. The possible\n values are opted-in, and not-opted-in.

", + "smithy.api#xmlName": "optInStatus" + } + }, + "Messages": { + "target": "com.amazonaws.ec2#AvailabilityZoneMessageList", + "traits": { + "aws.protocols#ec2QueryName": "MessageSet", + "smithy.api#documentation": "

Any messages about the Availability Zone, Local Zone, or Wavelength Zone.

", + "smithy.api#xmlName": "messageSet" + } + }, + "RegionName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RegionName", + "smithy.api#documentation": "

The name of the Region.

", + "smithy.api#xmlName": "regionName" + } + }, + "ZoneName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ZoneName", + "smithy.api#documentation": "

The name of the Availability Zone, Local Zone, or Wavelength Zone.

", + "smithy.api#xmlName": "zoneName" + } + }, + "ZoneId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ZoneId", + "smithy.api#documentation": "

The ID of the Availability Zone, Local Zone, or Wavelength Zone.

", + "smithy.api#xmlName": "zoneId" + } + }, + "GroupName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupName", + "smithy.api#documentation": "

For Availability Zones, this parameter has the same value as the Region name.

\n

For Local Zones, the name of the associated group, for example\n us-west-2-lax-1.

\n

For Wavelength Zones, the name of the associated group, for example\n us-east-1-wl1-bos-wlz-1.

", + "smithy.api#xmlName": "groupName" + } + }, + "NetworkBorderGroup": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkBorderGroup", + "smithy.api#documentation": "

The name of the network border group.

", + "smithy.api#xmlName": "networkBorderGroup" + } + }, + "ZoneType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ZoneType", + "smithy.api#documentation": "

The type of zone. The valid values are availability-zone,\n local-zone, and wavelength-zone.

", + "smithy.api#xmlName": "zoneType" + } + }, + "ParentZoneName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ParentZoneName", + "smithy.api#documentation": "

The name of the zone that handles some of the Local Zone or Wavelength Zone control plane\n operations, such as API calls.

", + "smithy.api#xmlName": "parentZoneName" + } + }, + "ParentZoneId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ParentZoneId", + "smithy.api#documentation": "

The ID of the zone that handles some of the Local Zone or Wavelength Zone control plane\n operations, such as API calls.

", + "smithy.api#xmlName": "parentZoneId" + } + }, + "State": { + "target": "com.amazonaws.ec2#AvailabilityZoneState", + "traits": { + "aws.protocols#ec2QueryName": "ZoneState", + "smithy.api#documentation": "

The state of the Availability Zone, Local Zone, or Wavelength Zone. This value is always\n available.

", + "smithy.api#xmlName": "zoneState" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes Availability Zones, Local Zones, and Wavelength Zones.

" + } + }, + "com.amazonaws.ec2#AvailabilityZoneId": { + "type": "string" + }, + "com.amazonaws.ec2#AvailabilityZoneList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AvailabilityZone", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#AvailabilityZoneMessage": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

The message about the Availability Zone, Local Zone, or Wavelength Zone.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a message about an Availability Zone, Local Zone, or Wavelength Zone.

" + } + }, + "com.amazonaws.ec2#AvailabilityZoneMessageList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AvailabilityZoneMessage", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#AvailabilityZoneName": { + "type": "string" + }, + "com.amazonaws.ec2#AvailabilityZoneOptInStatus": { + "type": "enum", + "members": { + "opt_in_not_required": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "opt-in-not-required" + } + }, + "opted_in": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "opted-in" + } + }, + "not_opted_in": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "not-opted-in" + } + } + } + }, + "com.amazonaws.ec2#AvailabilityZoneState": { + "type": "enum", + "members": { + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "information": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "information" + } + }, + "impaired": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "impaired" + } + }, + "unavailable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unavailable" + } + }, + "constrained": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "constrained" + } + } + } + }, + "com.amazonaws.ec2#AvailabilityZoneStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "AvailabilityZone" + } + } + }, + "com.amazonaws.ec2#AvailableCapacity": { + "type": "structure", + "members": { + "AvailableInstanceCapacity": { + "target": "com.amazonaws.ec2#AvailableInstanceCapacityList", + "traits": { + "aws.protocols#ec2QueryName": "AvailableInstanceCapacity", + "smithy.api#documentation": "

The number of instances that can be launched onto the Dedicated Host depending on the\n host's available capacity. For Dedicated Hosts that support multiple instance types,\n this parameter represents the number of instances for each instance size that is\n supported on the host.

", + "smithy.api#xmlName": "availableInstanceCapacity" + } + }, + "AvailableVCpus": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "AvailableVCpus", + "smithy.api#documentation": "

The number of vCPUs available for launching instances onto the Dedicated Host.

", + "smithy.api#xmlName": "availableVCpus" + } + } + }, + "traits": { + "smithy.api#documentation": "

The capacity information for instances that can be launched onto the Dedicated Host.\n

" + } + }, + "com.amazonaws.ec2#AvailableInstanceCapacityList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceCapacity", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#BandwidthWeightingType": { + "type": "enum", + "members": { + "DEFAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "default" + } + }, + "VPC_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vpc-1" + } + }, + "EBS_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ebs-1" + } + } + } + }, + "com.amazonaws.ec2#BandwidthWeightingTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#BandwidthWeightingType", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#BareMetal": { + "type": "enum", + "members": { + "INCLUDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "included" + } + }, + "REQUIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "required" + } + }, + "EXCLUDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "excluded" + } + } + } + }, + "com.amazonaws.ec2#BareMetalFlag": { + "type": "boolean" + }, + "com.amazonaws.ec2#BaselineBandwidthInGbps": { + "type": "double" + }, + "com.amazonaws.ec2#BaselineBandwidthInMbps": { + "type": "integer" + }, + "com.amazonaws.ec2#BaselineEbsBandwidthMbps": { + "type": "structure", + "members": { + "Min": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Min", + "smithy.api#documentation": "

The minimum baseline bandwidth, in Mbps. If this parameter is not specified, there is no\n minimum limit.

", + "smithy.api#xmlName": "min" + } + }, + "Max": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Max", + "smithy.api#documentation": "

The maximum baseline bandwidth, in Mbps. If this parameter is not specified, there is no\n maximum limit.

", + "smithy.api#xmlName": "max" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see\n Amazon\n EBS–optimized instances in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#BaselineEbsBandwidthMbpsRequest": { + "type": "structure", + "members": { + "Min": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The minimum baseline bandwidth, in Mbps. To specify no minimum limit, omit\n this parameter.

" + } + }, + "Max": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum baseline bandwidth, in Mbps. To specify no maximum limit, omit\n this parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see\n Amazon\n EBS–optimized instances in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#BaselineIops": { + "type": "integer" + }, + "com.amazonaws.ec2#BaselinePerformanceFactors": { + "type": "structure", + "members": { + "Cpu": { + "target": "com.amazonaws.ec2#CpuPerformanceFactor", + "traits": { + "aws.protocols#ec2QueryName": "Cpu", + "smithy.api#documentation": "

The CPU performance to consider, using an instance family as the baseline reference.

", + "smithy.api#xmlName": "cpu" + } + } + }, + "traits": { + "smithy.api#documentation": "

The baseline performance to consider, using an instance family as a baseline reference.\n The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this\n baseline to guide instance type selection, but there is no guarantee that the selected\n instance types will always exceed the baseline for every application.

\n

Currently, this parameter only supports CPU performance as a baseline performance\n factor. For example, specifying c6i would use the CPU performance of the\n c6i family as the baseline reference.

" + } + }, + "com.amazonaws.ec2#BaselinePerformanceFactorsRequest": { + "type": "structure", + "members": { + "Cpu": { + "target": "com.amazonaws.ec2#CpuPerformanceFactorRequest", + "traits": { + "smithy.api#documentation": "

The CPU performance to consider, using an instance family as the baseline reference.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The baseline performance to consider, using an instance family as a baseline reference.\n The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this\n baseline to guide instance type selection, but there is no guarantee that the selected\n instance types will always exceed the baseline for every application.

\n

Currently, this parameter only supports CPU performance as a baseline performance\n factor. For example, specifying c6i would use the CPU performance of the\n c6i family as the baseline reference.

" + } + }, + "com.amazonaws.ec2#BaselineThroughputInMBps": { + "type": "double" + }, + "com.amazonaws.ec2#BatchState": { + "type": "enum", + "members": { + "SUBMITTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "submitted" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cancelled" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + }, + "CANCELLED_RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cancelled_running" + } + }, + "CANCELLED_TERMINATING_INSTANCES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cancelled_terminating" + } + }, + "MODIFYING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modifying" + } + } + } + }, + "com.amazonaws.ec2#BgpStatus": { + "type": "enum", + "members": { + "up": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "up" + } + }, + "down": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "down" + } + } + } + }, + "com.amazonaws.ec2#BillingProductList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Blob": { + "type": "blob" + }, + "com.amazonaws.ec2#BlobAttributeValue": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.ec2#Blob", + "traits": { + "aws.protocols#ec2QueryName": "Value", + "smithy.api#xmlName": "value" + } + } + } + }, + "com.amazonaws.ec2#BlockDeviceMapping": { + "type": "structure", + "members": { + "Ebs": { + "target": "com.amazonaws.ec2#EbsBlockDevice", + "traits": { + "aws.protocols#ec2QueryName": "Ebs", + "smithy.api#documentation": "

Parameters used to automatically set up EBS volumes when the instance is\n launched.

", + "smithy.api#xmlName": "ebs" + } + }, + "NoDevice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NoDevice", + "smithy.api#documentation": "

To omit the device from the block device mapping, specify an empty string. When this\n property is specified, the device is removed from the block device mapping regardless of\n the assigned value.

", + "smithy.api#xmlName": "noDevice" + } + }, + "DeviceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DeviceName", + "smithy.api#documentation": "

The device name (for example, /dev/sdh or xvdh).

", + "smithy.api#xmlName": "deviceName" + } + }, + "VirtualName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VirtualName", + "smithy.api#documentation": "

The virtual device name (ephemeralN). Instance store volumes are numbered\n starting from 0. An instance type with 2 available instance store volumes can specify\n mappings for ephemeral0 and ephemeral1. The number of\n available instance store volumes depends on the instance type. After you connect to the\n instance, you must mount the volume.

\n

NVMe instance store volumes are automatically enumerated and assigned a device name.\n Including them in your block device mapping has no effect.

\n

Constraints: For M3 instances, you must specify instance store volumes in the block\n device mapping for the instance. When you launch an M3 instance, we ignore any instance\n store volumes specified in the block device mapping for the AMI.

", + "smithy.api#xmlName": "virtualName" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a block device mapping, which defines the EBS volumes and instance store\n volumes to attach to an instance at launch.

" + } + }, + "com.amazonaws.ec2#BlockDeviceMappingList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#BlockDeviceMapping", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#BlockDeviceMappingRequestList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#BlockDeviceMapping", + "traits": { + "smithy.api#xmlName": "BlockDeviceMapping" + } + } + }, + "com.amazonaws.ec2#BlockPublicAccessMode": { + "type": "enum", + "members": { + "off": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "off" + } + }, + "block_bidirectional": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "block-bidirectional" + } + }, + "block_ingress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "block-ingress" + } + } + } + }, + "com.amazonaws.ec2#BlockPublicAccessStates": { + "type": "structure", + "members": { + "InternetGatewayBlockMode": { + "target": "com.amazonaws.ec2#BlockPublicAccessMode", + "traits": { + "aws.protocols#ec2QueryName": "InternetGatewayBlockMode", + "smithy.api#documentation": "

The mode of VPC BPA.

\n ", + "smithy.api#xmlName": "internetGatewayBlockMode" + } + } + }, + "traits": { + "smithy.api#documentation": "

The state of VPC Block Public Access (BPA).

" + } + }, + "com.amazonaws.ec2#Boolean": { + "type": "boolean" + }, + "com.amazonaws.ec2#BootModeType": { + "type": "enum", + "members": { + "legacy_bios": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "legacy-bios" + } + }, + "uefi": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "uefi" + } + } + } + }, + "com.amazonaws.ec2#BootModeTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#BootModeType", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#BootModeValues": { + "type": "enum", + "members": { + "legacy_bios": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "legacy-bios" + } + }, + "uefi": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "uefi" + } + }, + "uefi_preferred": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "uefi-preferred" + } + } + } + }, + "com.amazonaws.ec2#BoxedDouble": { + "type": "double" + }, + "com.amazonaws.ec2#BoxedInteger": { + "type": "integer" + }, + "com.amazonaws.ec2#BundleId": { + "type": "string" + }, + "com.amazonaws.ec2#BundleIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#BundleId", + "traits": { + "smithy.api#xmlName": "BundleId" + } + } + }, + "com.amazonaws.ec2#BundleInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#BundleInstanceRequest" + }, + "output": { + "target": "com.amazonaws.ec2#BundleInstanceResult" + }, + "traits": { + "smithy.api#documentation": "

Bundles an Amazon instance store-backed Windows instance.

\n

During bundling, only the root device volume (C:\\) is bundled. Data on other instance\n store volumes is not preserved.

\n \n

This action is not applicable for Linux/Unix instances or Windows instances that are\n backed by Amazon EBS.

\n " + } + }, + "com.amazonaws.ec2#BundleInstanceRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance to bundle.

\n

Default: None

", + "smithy.api#required": {} + } + }, + "Storage": { + "target": "com.amazonaws.ec2#Storage", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The bucket in which to store the AMI. You can specify a bucket that you already own or a\n new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone\n else, Amazon EC2 returns an error.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for BundleInstance.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#BundleInstanceResult": { + "type": "structure", + "members": { + "BundleTask": { + "target": "com.amazonaws.ec2#BundleTask", + "traits": { + "aws.protocols#ec2QueryName": "BundleInstanceTask", + "smithy.api#documentation": "

Information about the bundle task.

", + "smithy.api#xmlName": "bundleInstanceTask" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of BundleInstance.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#BundleTask": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance associated with this bundle task.

", + "smithy.api#xmlName": "instanceId" + } + }, + "BundleId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "BundleId", + "smithy.api#documentation": "

The ID of the bundle task.

", + "smithy.api#xmlName": "bundleId" + } + }, + "State": { + "target": "com.amazonaws.ec2#BundleTaskState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the task.

", + "smithy.api#xmlName": "state" + } + }, + "StartTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "StartTime", + "smithy.api#documentation": "

The time this task started.

", + "smithy.api#xmlName": "startTime" + } + }, + "UpdateTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "UpdateTime", + "smithy.api#documentation": "

The time of the most recent update for the task.

", + "smithy.api#xmlName": "updateTime" + } + }, + "Storage": { + "target": "com.amazonaws.ec2#Storage", + "traits": { + "aws.protocols#ec2QueryName": "Storage", + "smithy.api#documentation": "

The Amazon S3 storage locations.

", + "smithy.api#xmlName": "storage" + } + }, + "Progress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Progress", + "smithy.api#documentation": "

The level of task completion, as a percent (for example, 20%).

", + "smithy.api#xmlName": "progress" + } + }, + "BundleTaskError": { + "target": "com.amazonaws.ec2#BundleTaskError", + "traits": { + "aws.protocols#ec2QueryName": "Error", + "smithy.api#documentation": "

If the task fails, a description of the error.

", + "smithy.api#xmlName": "error" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a bundle task.

" + } + }, + "com.amazonaws.ec2#BundleTaskError": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The error code.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

The error message.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an error for BundleInstance.

" + } + }, + "com.amazonaws.ec2#BundleTaskList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#BundleTask", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#BundleTaskState": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "waiting_for_shutdown": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "waiting-for-shutdown" + } + }, + "bundling": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "bundling" + } + }, + "storing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "storing" + } + }, + "cancelling": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cancelling" + } + }, + "complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "complete" + } + }, + "failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + } + } + }, + "com.amazonaws.ec2#BurstablePerformance": { + "type": "enum", + "members": { + "INCLUDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "included" + } + }, + "REQUIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "required" + } + }, + "EXCLUDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "excluded" + } + } + } + }, + "com.amazonaws.ec2#BurstablePerformanceFlag": { + "type": "boolean" + }, + "com.amazonaws.ec2#Byoasn": { + "type": "structure", + "members": { + "Asn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Asn", + "smithy.api#documentation": "

A public 2-byte or 4-byte ASN.

", + "smithy.api#xmlName": "asn" + } + }, + "IpamId": { + "target": "com.amazonaws.ec2#IpamId", + "traits": { + "aws.protocols#ec2QueryName": "IpamId", + "smithy.api#documentation": "

An IPAM ID.

", + "smithy.api#xmlName": "ipamId" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

The status message.

", + "smithy.api#xmlName": "statusMessage" + } + }, + "State": { + "target": "com.amazonaws.ec2#AsnState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The provisioning state of the BYOASN.

", + "smithy.api#xmlName": "state" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Autonomous System Number (ASN) and BYOIP CIDR association.

" + } + }, + "com.amazonaws.ec2#ByoasnSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Byoasn", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ByoipCidr": { + "type": "structure", + "members": { + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Cidr", + "smithy.api#documentation": "

The address range, in CIDR notation.

", + "smithy.api#xmlName": "cidr" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description of the address range.

", + "smithy.api#xmlName": "description" + } + }, + "AsnAssociations": { + "target": "com.amazonaws.ec2#AsnAssociationSet", + "traits": { + "aws.protocols#ec2QueryName": "AsnAssociationSet", + "smithy.api#documentation": "

The BYOIP CIDR associations with ASNs.

", + "smithy.api#xmlName": "asnAssociationSet" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

Upon success, contains the ID of the address pool. Otherwise, contains an error message.

", + "smithy.api#xmlName": "statusMessage" + } + }, + "State": { + "target": "com.amazonaws.ec2#ByoipCidrState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the address range.

\n ", + "smithy.api#xmlName": "state" + } + }, + "NetworkBorderGroup": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkBorderGroup", + "smithy.api#documentation": "

If you have Local Zones enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR. Choose the network border group carefully as the EIP and the Amazon Web Services resource it is associated with must reside in the same network border group.

\n

You can provision BYOIP address ranges to and advertise them in the following Local Zone network border groups:

\n \n \n

You cannot provision or advertise BYOIPv6 address ranges in Local Zones at this time.

\n ", + "smithy.api#xmlName": "networkBorderGroup" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an address range that is provisioned for use with your Amazon Web Services resources \n through bring your own IP addresses (BYOIP).

" + } + }, + "com.amazonaws.ec2#ByoipCidrSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ByoipCidr", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ByoipCidrState": { + "type": "enum", + "members": { + "advertised": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "advertised" + } + }, + "deprovisioned": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deprovisioned" + } + }, + "failed_deprovision": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed-deprovision" + } + }, + "failed_provision": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed-provision" + } + }, + "pending_deprovision": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending-deprovision" + } + }, + "pending_provision": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending-provision" + } + }, + "provisioned": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "provisioned" + } + }, + "provisioned_not_publicly_advertisable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "provisioned-not-publicly-advertisable" + } + } + } + }, + "com.amazonaws.ec2#CallerRole": { + "type": "enum", + "members": { + "odcr_owner": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "odcr-owner" + } + }, + "unused_reservation_billing_owner": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unused-reservation-billing-owner" + } + } + } + }, + "com.amazonaws.ec2#CancelBatchErrorCode": { + "type": "enum", + "members": { + "FLEET_REQUEST_ID_DOES_NOT_EXIST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fleetRequestIdDoesNotExist" + } + }, + "FLEET_REQUEST_ID_MALFORMED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fleetRequestIdMalformed" + } + }, + "FLEET_REQUEST_NOT_IN_CANCELLABLE_STATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fleetRequestNotInCancellableState" + } + }, + "UNEXPECTED_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unexpectedError" + } + } + } + }, + "com.amazonaws.ec2#CancelBundleTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CancelBundleTaskRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CancelBundleTaskResult" + }, + "traits": { + "smithy.api#documentation": "

Cancels a bundling operation for an instance store-backed Windows instance.

" + } + }, + "com.amazonaws.ec2#CancelBundleTaskRequest": { + "type": "structure", + "members": { + "BundleId": { + "target": "com.amazonaws.ec2#BundleId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the bundle task.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for CancelBundleTask.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CancelBundleTaskResult": { + "type": "structure", + "members": { + "BundleTask": { + "target": "com.amazonaws.ec2#BundleTask", + "traits": { + "aws.protocols#ec2QueryName": "BundleInstanceTask", + "smithy.api#documentation": "

Information about the bundle task.

", + "smithy.api#xmlName": "bundleInstanceTask" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of CancelBundleTask.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CancelCapacityReservation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CancelCapacityReservationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CancelCapacityReservationResult" + }, + "traits": { + "smithy.api#documentation": "

Cancels the specified Capacity Reservation, releases the reserved capacity, and changes \n\t\t\tthe Capacity Reservation's state to cancelled.

\n

You can cancel a Capacity Reservation that is in the following states:

\n \n

If a future-dated Capacity Reservation enters the delayed state, the commitment \n\t\t\tduration is waived, and you can cancel it as soon as it enters the active state.

\n

Instances running in the reserved capacity continue running until you stop them. Stopped\n\t\t\tinstances that target the Capacity Reservation can no longer launch. Modify these instances to either\n\t\t\ttarget a different Capacity Reservation, launch On-Demand Instance capacity, or run in any open Capacity Reservation\n\t\t\tthat has matching attributes and sufficient capacity.

" + } + }, + "com.amazonaws.ec2#CancelCapacityReservationFleetError": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#CancelCapacityReservationFleetErrorCode", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The error code.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#CancelCapacityReservationFleetErrorMessage", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

The error message.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Capacity Reservation Fleet cancellation error.

" + } + }, + "com.amazonaws.ec2#CancelCapacityReservationFleetErrorCode": { + "type": "string" + }, + "com.amazonaws.ec2#CancelCapacityReservationFleetErrorMessage": { + "type": "string" + }, + "com.amazonaws.ec2#CancelCapacityReservationFleets": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CancelCapacityReservationFleetsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CancelCapacityReservationFleetsResult" + }, + "traits": { + "smithy.api#documentation": "

Cancels one or more Capacity Reservation Fleets. When you cancel a Capacity\n\t\t\tReservation Fleet, the following happens:

\n " + } + }, + "com.amazonaws.ec2#CancelCapacityReservationFleetsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "CapacityReservationFleetIds": { + "target": "com.amazonaws.ec2#CapacityReservationFleetIdSet", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the Capacity Reservation Fleets to cancel.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "CapacityReservationFleetId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CancelCapacityReservationFleetsResult": { + "type": "structure", + "members": { + "SuccessfulFleetCancellations": { + "target": "com.amazonaws.ec2#CapacityReservationFleetCancellationStateSet", + "traits": { + "aws.protocols#ec2QueryName": "SuccessfulFleetCancellationSet", + "smithy.api#documentation": "

Information about the Capacity Reservation Fleets that were successfully\n\t\t\tcancelled.

", + "smithy.api#xmlName": "successfulFleetCancellationSet" + } + }, + "FailedFleetCancellations": { + "target": "com.amazonaws.ec2#FailedCapacityReservationFleetCancellationResultSet", + "traits": { + "aws.protocols#ec2QueryName": "FailedFleetCancellationSet", + "smithy.api#documentation": "

Information about the Capacity Reservation Fleets that could not be cancelled.

", + "smithy.api#xmlName": "failedFleetCancellationSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CancelCapacityReservationRequest": { + "type": "structure", + "members": { + "CapacityReservationId": { + "target": "com.amazonaws.ec2#CapacityReservationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Capacity Reservation to be cancelled.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CancelCapacityReservationResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CancelConversionRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "ConversionTaskId": { + "target": "com.amazonaws.ec2#ConversionTaskId", + "traits": { + "aws.protocols#ec2QueryName": "ConversionTaskId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the conversion task.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "conversionTaskId" + } + }, + "ReasonMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ReasonMessage", + "smithy.api#documentation": "

The reason for canceling the conversion task.

", + "smithy.api#xmlName": "reasonMessage" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CancelConversionTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CancelConversionRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all\n artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is\n in the process of transferring the final disk image, the command fails and returns an exception.

" + } + }, + "com.amazonaws.ec2#CancelDeclarativePoliciesReport": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CancelDeclarativePoliciesReportRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CancelDeclarativePoliciesReportResult" + }, + "traits": { + "smithy.api#documentation": "

Cancels the generation of an account status report.

\n

You can only cancel a report while it has the running status. Reports\n with other statuses (complete, cancelled, or\n error) can't be canceled.

\n

For more information, see Generating the account status report for declarative policies in the\n Amazon Web Services Organizations User Guide.

" + } + }, + "com.amazonaws.ec2#CancelDeclarativePoliciesReportRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ReportId": { + "target": "com.amazonaws.ec2#DeclarativePoliciesReportId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the report.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CancelDeclarativePoliciesReportResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Is true if the request succeeds, and an error otherwise.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CancelExportTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CancelExportTaskRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Cancels an active export task. The request removes all artifacts of the export, including any partially-created\n Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the\n command fails and returns an error.

" + } + }, + "com.amazonaws.ec2#CancelExportTaskRequest": { + "type": "structure", + "members": { + "ExportTaskId": { + "target": "com.amazonaws.ec2#ExportVmTaskId", + "traits": { + "aws.protocols#ec2QueryName": "ExportTaskId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the export task. This is the ID returned by the\n CreateInstanceExportTask and ExportImage operations.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "exportTaskId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CancelImageLaunchPermission": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CancelImageLaunchPermissionRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CancelImageLaunchPermissionResult" + }, + "traits": { + "smithy.api#documentation": "

Removes your Amazon Web Services account from the launch permissions for the specified AMI.\n For more information, see Cancel having an AMI shared with\n your Amazon Web Services account in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#CancelImageLaunchPermissionRequest": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the AMI that was shared with your Amazon Web Services account.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CancelImageLaunchPermissionResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CancelImportTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CancelImportTaskRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CancelImportTaskResult" + }, + "traits": { + "smithy.api#documentation": "

Cancels an in-process import virtual machine or import snapshot task.

" + } + }, + "com.amazonaws.ec2#CancelImportTaskRequest": { + "type": "structure", + "members": { + "CancelReason": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The reason for canceling the task.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ImportTaskId": { + "target": "com.amazonaws.ec2#ImportTaskId", + "traits": { + "smithy.api#documentation": "

The ID of the import image or import snapshot task to be canceled.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CancelImportTaskResult": { + "type": "structure", + "members": { + "ImportTaskId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImportTaskId", + "smithy.api#documentation": "

The ID of the task being canceled.

", + "smithy.api#xmlName": "importTaskId" + } + }, + "PreviousState": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PreviousState", + "smithy.api#documentation": "

The current state of the task being canceled.

", + "smithy.api#xmlName": "previousState" + } + }, + "State": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of the task being canceled.

", + "smithy.api#xmlName": "state" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CancelReservedInstancesListing": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CancelReservedInstancesListingRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CancelReservedInstancesListingResult" + }, + "traits": { + "smithy.api#documentation": "

Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.

\n

For more information, see Sell in the Reserved Instance\n Marketplace in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#CancelReservedInstancesListingRequest": { + "type": "structure", + "members": { + "ReservedInstancesListingId": { + "target": "com.amazonaws.ec2#ReservedInstancesListingId", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstancesListingId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Reserved Instance listing.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "reservedInstancesListingId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for CancelReservedInstancesListing.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CancelReservedInstancesListingResult": { + "type": "structure", + "members": { + "ReservedInstancesListings": { + "target": "com.amazonaws.ec2#ReservedInstancesListingList", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstancesListingsSet", + "smithy.api#documentation": "

The Reserved Instance listing.

", + "smithy.api#xmlName": "reservedInstancesListingsSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of CancelReservedInstancesListing.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CancelSpotFleetRequests": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CancelSpotFleetRequestsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CancelSpotFleetRequestsResponse" + }, + "traits": { + "smithy.api#documentation": "

Cancels the specified Spot Fleet requests.

\n

After you cancel a Spot Fleet request, the Spot Fleet launches no new instances.

\n

You must also specify whether a canceled Spot Fleet request should terminate its instances. If you\n choose to terminate the instances, the Spot Fleet request enters the\n cancelled_terminating state. Otherwise, the Spot Fleet request enters\n the cancelled_running state and the instances continue to run until they\n are interrupted or you terminate them manually.

\n

\n Restrictions\n

\n ", + "smithy.api#examples": [ + { + "title": "To cancel a Spot fleet request", + "documentation": "This example cancels the specified Spot fleet request and terminates its associated Spot Instances.", + "input": { + "SpotFleetRequestIds": [ + "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" + ], + "TerminateInstances": true + }, + "output": { + "SuccessfulFleetRequests": [ + { + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", + "CurrentSpotFleetRequestState": "cancelled_running", + "PreviousSpotFleetRequestState": "active" + } + ] + } + }, + { + "title": "To cancel a Spot fleet request without terminating its Spot Instances", + "documentation": "This example cancels the specified Spot fleet request without terminating its associated Spot Instances.", + "input": { + "SpotFleetRequestIds": [ + "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" + ], + "TerminateInstances": false + }, + "output": { + "SuccessfulFleetRequests": [ + { + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", + "CurrentSpotFleetRequestState": "cancelled_terminating", + "PreviousSpotFleetRequestState": "active" + } + ] + } + } + ] + } + }, + "com.amazonaws.ec2#CancelSpotFleetRequestsError": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#CancelBatchErrorCode", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The error code.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

The description for the error code.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Spot Fleet error.

" + } + }, + "com.amazonaws.ec2#CancelSpotFleetRequestsErrorItem": { + "type": "structure", + "members": { + "Error": { + "target": "com.amazonaws.ec2#CancelSpotFleetRequestsError", + "traits": { + "aws.protocols#ec2QueryName": "Error", + "smithy.api#documentation": "

The error.

", + "smithy.api#xmlName": "error" + } + }, + "SpotFleetRequestId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SpotFleetRequestId", + "smithy.api#documentation": "

The ID of the Spot Fleet request.

", + "smithy.api#xmlName": "spotFleetRequestId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Spot Fleet request that was not successfully canceled.

" + } + }, + "com.amazonaws.ec2#CancelSpotFleetRequestsErrorSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CancelSpotFleetRequestsErrorItem", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#CancelSpotFleetRequestsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "SpotFleetRequestIds": { + "target": "com.amazonaws.ec2#SpotFleetRequestIdList", + "traits": { + "aws.protocols#ec2QueryName": "SpotFleetRequestId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the Spot Fleet requests.

\n

Constraint: You can specify up to 100 IDs in a single request.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "spotFleetRequestId" + } + }, + "TerminateInstances": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "TerminateInstances", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Indicates whether to terminate the associated instances when the Spot Fleet request is canceled. \n The default is to terminate the instances.

\n

To let the instances continue to run after the Spot Fleet request is canceled, specify\n no-terminate-instances.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "terminateInstances" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for CancelSpotFleetRequests.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CancelSpotFleetRequestsResponse": { + "type": "structure", + "members": { + "SuccessfulFleetRequests": { + "target": "com.amazonaws.ec2#CancelSpotFleetRequestsSuccessSet", + "traits": { + "aws.protocols#ec2QueryName": "SuccessfulFleetRequestSet", + "smithy.api#documentation": "

Information about the Spot Fleet requests that are successfully canceled.

", + "smithy.api#xmlName": "successfulFleetRequestSet" + } + }, + "UnsuccessfulFleetRequests": { + "target": "com.amazonaws.ec2#CancelSpotFleetRequestsErrorSet", + "traits": { + "aws.protocols#ec2QueryName": "UnsuccessfulFleetRequestSet", + "smithy.api#documentation": "

Information about the Spot Fleet requests that are not successfully canceled.

", + "smithy.api#xmlName": "unsuccessfulFleetRequestSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of CancelSpotFleetRequests.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CancelSpotFleetRequestsSuccessItem": { + "type": "structure", + "members": { + "CurrentSpotFleetRequestState": { + "target": "com.amazonaws.ec2#BatchState", + "traits": { + "aws.protocols#ec2QueryName": "CurrentSpotFleetRequestState", + "smithy.api#documentation": "

The current state of the Spot Fleet request.

", + "smithy.api#xmlName": "currentSpotFleetRequestState" + } + }, + "PreviousSpotFleetRequestState": { + "target": "com.amazonaws.ec2#BatchState", + "traits": { + "aws.protocols#ec2QueryName": "PreviousSpotFleetRequestState", + "smithy.api#documentation": "

The previous state of the Spot Fleet request.

", + "smithy.api#xmlName": "previousSpotFleetRequestState" + } + }, + "SpotFleetRequestId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SpotFleetRequestId", + "smithy.api#documentation": "

The ID of the Spot Fleet request.

", + "smithy.api#xmlName": "spotFleetRequestId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Spot Fleet request that was successfully canceled.

" + } + }, + "com.amazonaws.ec2#CancelSpotFleetRequestsSuccessSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CancelSpotFleetRequestsSuccessItem", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#CancelSpotInstanceRequestState": { + "type": "enum", + "members": { + "active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "open": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "open" + } + }, + "closed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "closed" + } + }, + "cancelled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cancelled" + } + }, + "completed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "completed" + } + } + } + }, + "com.amazonaws.ec2#CancelSpotInstanceRequests": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CancelSpotInstanceRequestsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CancelSpotInstanceRequestsResult" + }, + "traits": { + "smithy.api#documentation": "

Cancels one or more Spot Instance requests.

\n \n

Canceling a Spot Instance request does not terminate running Spot Instances\n associated with the request.

\n ", + "smithy.api#examples": [ + { + "title": "To cancel Spot Instance requests", + "documentation": "This example cancels a Spot Instance request.", + "input": { + "SpotInstanceRequestIds": [ + "sir-08b93456" + ] + }, + "output": { + "CancelledSpotInstanceRequests": [ + { + "State": "cancelled", + "SpotInstanceRequestId": "sir-08b93456" + } + ] + } + } + ] + } + }, + "com.amazonaws.ec2#CancelSpotInstanceRequestsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "SpotInstanceRequestIds": { + "target": "com.amazonaws.ec2#SpotInstanceRequestIdList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the Spot Instance requests.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "SpotInstanceRequestId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for CancelSpotInstanceRequests.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CancelSpotInstanceRequestsResult": { + "type": "structure", + "members": { + "CancelledSpotInstanceRequests": { + "target": "com.amazonaws.ec2#CancelledSpotInstanceRequestList", + "traits": { + "aws.protocols#ec2QueryName": "SpotInstanceRequestSet", + "smithy.api#documentation": "

The Spot Instance requests.

", + "smithy.api#xmlName": "spotInstanceRequestSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of CancelSpotInstanceRequests.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CancelledSpotInstanceRequest": { + "type": "structure", + "members": { + "SpotInstanceRequestId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SpotInstanceRequestId", + "smithy.api#documentation": "

The ID of the Spot Instance request.

", + "smithy.api#xmlName": "spotInstanceRequestId" + } + }, + "State": { + "target": "com.amazonaws.ec2#CancelSpotInstanceRequestState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the Spot Instance request.

", + "smithy.api#xmlName": "state" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a request to cancel a Spot Instance.

" + } + }, + "com.amazonaws.ec2#CancelledSpotInstanceRequestList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CancelledSpotInstanceRequest", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#CapacityAllocation": { + "type": "structure", + "members": { + "AllocationType": { + "target": "com.amazonaws.ec2#AllocationType", + "traits": { + "aws.protocols#ec2QueryName": "AllocationType", + "smithy.api#documentation": "

The usage type. used indicates that the instance capacity is in use by\n\t\t\tinstances that are running in the Capacity Reservation.

", + "smithy.api#xmlName": "allocationType" + } + }, + "Count": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Count", + "smithy.api#documentation": "

The amount of instance capacity associated with the usage. For example a value of\n\t\t\t\t4 indicates that instance capacity for 4 instances is currently in\n\t\t\tuse.

", + "smithy.api#xmlName": "count" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about instance capacity usage for a Capacity Reservation.

" + } + }, + "com.amazonaws.ec2#CapacityAllocations": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CapacityAllocation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#CapacityBlockExtension": { + "type": "structure", + "members": { + "CapacityReservationId": { + "target": "com.amazonaws.ec2#CapacityReservationId", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationId", + "smithy.api#documentation": "

The reservation ID of the Capacity Block extension.

", + "smithy.api#xmlName": "capacityReservationId" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type of the Capacity Block extension.

", + "smithy.api#xmlName": "instanceType" + } + }, + "InstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "InstanceCount", + "smithy.api#documentation": "

The number of instances in the Capacity Block extension.

", + "smithy.api#xmlName": "instanceCount" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#AvailabilityZoneName", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone of the Capacity Block extension.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "AvailabilityZoneId": { + "target": "com.amazonaws.ec2#AvailabilityZoneId", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZoneId", + "smithy.api#documentation": "

The Availability Zone ID of the Capacity Block extension.

", + "smithy.api#xmlName": "availabilityZoneId" + } + }, + "CapacityBlockExtensionOfferingId": { + "target": "com.amazonaws.ec2#OfferingId", + "traits": { + "aws.protocols#ec2QueryName": "CapacityBlockExtensionOfferingId", + "smithy.api#documentation": "

The ID of the Capacity Block extension offering.

", + "smithy.api#xmlName": "capacityBlockExtensionOfferingId" + } + }, + "CapacityBlockExtensionDurationHours": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "CapacityBlockExtensionDurationHours", + "smithy.api#documentation": "

The duration of the Capacity Block extension in hours.

", + "smithy.api#xmlName": "capacityBlockExtensionDurationHours" + } + }, + "CapacityBlockExtensionStatus": { + "target": "com.amazonaws.ec2#CapacityBlockExtensionStatus", + "traits": { + "aws.protocols#ec2QueryName": "CapacityBlockExtensionStatus", + "smithy.api#documentation": "

The status of the Capacity Block extension. A Capacity Block extension can have one of\n\t\t\tthe following statuses:

\n ", + "smithy.api#xmlName": "capacityBlockExtensionStatus" + } + }, + "CapacityBlockExtensionPurchaseDate": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "CapacityBlockExtensionPurchaseDate", + "smithy.api#documentation": "

The date when the Capacity Block extension was purchased.

", + "smithy.api#xmlName": "capacityBlockExtensionPurchaseDate" + } + }, + "CapacityBlockExtensionStartDate": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "CapacityBlockExtensionStartDate", + "smithy.api#documentation": "

The start date of the Capacity Block extension.

", + "smithy.api#xmlName": "capacityBlockExtensionStartDate" + } + }, + "CapacityBlockExtensionEndDate": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "CapacityBlockExtensionEndDate", + "smithy.api#documentation": "

The end date of the Capacity Block extension.

", + "smithy.api#xmlName": "capacityBlockExtensionEndDate" + } + }, + "UpfrontFee": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "UpfrontFee", + "smithy.api#documentation": "

The total price to be paid up front.

", + "smithy.api#xmlName": "upfrontFee" + } + }, + "CurrencyCode": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CurrencyCode", + "smithy.api#documentation": "

The currency of the payment for the Capacity Block extension.

", + "smithy.api#xmlName": "currencyCode" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Capacity Block extension. With an extension, you can\n\t\t\textend the duration of time for an existing Capacity Block.

" + } + }, + "com.amazonaws.ec2#CapacityBlockExtensionOffering": { + "type": "structure", + "members": { + "CapacityBlockExtensionOfferingId": { + "target": "com.amazonaws.ec2#OfferingId", + "traits": { + "aws.protocols#ec2QueryName": "CapacityBlockExtensionOfferingId", + "smithy.api#documentation": "

The ID of the Capacity Block extension offering.

", + "smithy.api#xmlName": "capacityBlockExtensionOfferingId" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type of the Capacity Block that will be extended.

", + "smithy.api#xmlName": "instanceType" + } + }, + "InstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "InstanceCount", + "smithy.api#documentation": "

The number of instances in the Capacity Block extension offering.

", + "smithy.api#xmlName": "instanceCount" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#AvailabilityZoneName", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone of the Capacity Block that will be extended.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "AvailabilityZoneId": { + "target": "com.amazonaws.ec2#AvailabilityZoneId", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZoneId", + "smithy.api#documentation": "

The Availability Zone ID of the Capacity Block that will be\n\t\t\textended.

", + "smithy.api#xmlName": "availabilityZoneId" + } + }, + "StartDate": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "StartDate", + "smithy.api#documentation": "

The start date of the Capacity Block that will be extended.

", + "smithy.api#xmlName": "startDate" + } + }, + "CapacityBlockExtensionStartDate": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "CapacityBlockExtensionStartDate", + "smithy.api#documentation": "

The date and time at which the Capacity Block extension will start. This date is\n\t\t\talso the same as the end date of the Capacity Block that will be\n\t\t\textended.

", + "smithy.api#xmlName": "capacityBlockExtensionStartDate" + } + }, + "CapacityBlockExtensionEndDate": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "CapacityBlockExtensionEndDate", + "smithy.api#documentation": "

The date and time at which the Capacity Block extension expires. When a Capacity\n\t\t\tBlock expires, the reserved capacity is released and you can no longer launch\n\t\t\tinstances into it. The Capacity Block's state changes to expired when\n\t\t\tit reaches its end date

", + "smithy.api#xmlName": "capacityBlockExtensionEndDate" + } + }, + "CapacityBlockExtensionDurationHours": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "CapacityBlockExtensionDurationHours", + "smithy.api#documentation": "

The amount of time of the Capacity Block extension offering in hours.

", + "smithy.api#xmlName": "capacityBlockExtensionDurationHours" + } + }, + "UpfrontFee": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "UpfrontFee", + "smithy.api#documentation": "

The total price of the Capacity Block extension offering, to be paid up front.

", + "smithy.api#xmlName": "upfrontFee" + } + }, + "CurrencyCode": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CurrencyCode", + "smithy.api#documentation": "

The currency of the payment for the Capacity Block extension offering.

", + "smithy.api#xmlName": "currencyCode" + } + }, + "Tenancy": { + "target": "com.amazonaws.ec2#CapacityReservationTenancy", + "traits": { + "aws.protocols#ec2QueryName": "Tenancy", + "smithy.api#documentation": "

Indicates the tenancy of the Capacity Block extension offering. A Capacity Block\n\t\t\tcan have one of the following tenancy settings:

\n ", + "smithy.api#xmlName": "tenancy" + } + } + }, + "traits": { + "smithy.api#documentation": "

The recommended Capacity Block extension that fits your search requirements.

" + } + }, + "com.amazonaws.ec2#CapacityBlockExtensionOfferingSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CapacityBlockExtensionOffering", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#CapacityBlockExtensionSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CapacityBlockExtension", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#CapacityBlockExtensionStatus": { + "type": "enum", + "members": { + "PAYMENT_PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "payment-pending" + } + }, + "PAYMENT_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "payment-failed" + } + }, + "PAYMENT_SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "payment-succeeded" + } + } + } + }, + "com.amazonaws.ec2#CapacityBlockOffering": { + "type": "structure", + "members": { + "CapacityBlockOfferingId": { + "target": "com.amazonaws.ec2#OfferingId", + "traits": { + "aws.protocols#ec2QueryName": "CapacityBlockOfferingId", + "smithy.api#documentation": "

The ID of the Capacity Block offering.

", + "smithy.api#xmlName": "capacityBlockOfferingId" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type of the Capacity Block offering.

", + "smithy.api#xmlName": "instanceType" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone of the Capacity Block offering.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "InstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "InstanceCount", + "smithy.api#documentation": "

The number of instances in the Capacity Block offering.

", + "smithy.api#xmlName": "instanceCount" + } + }, + "StartDate": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "StartDate", + "smithy.api#documentation": "

The start date of the Capacity Block offering.

", + "smithy.api#xmlName": "startDate" + } + }, + "EndDate": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "EndDate", + "smithy.api#documentation": "

The end date of the Capacity Block offering.

", + "smithy.api#xmlName": "endDate" + } + }, + "CapacityBlockDurationHours": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "CapacityBlockDurationHours", + "smithy.api#documentation": "

The number of hours (in addition to capacityBlockDurationMinutes) for the \n\t\t\tduration of the Capacity Block reservation. For example, if a Capacity Block starts at \n\t\t\t04:55 and ends at 11:30, \n\t\t\tthe hours field would be 6.

", + "smithy.api#xmlName": "capacityBlockDurationHours" + } + }, + "UpfrontFee": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "UpfrontFee", + "smithy.api#documentation": "

The total price to be paid up front.

", + "smithy.api#xmlName": "upfrontFee" + } + }, + "CurrencyCode": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CurrencyCode", + "smithy.api#documentation": "

The currency of the payment for the Capacity Block.

", + "smithy.api#xmlName": "currencyCode" + } + }, + "Tenancy": { + "target": "com.amazonaws.ec2#CapacityReservationTenancy", + "traits": { + "aws.protocols#ec2QueryName": "Tenancy", + "smithy.api#documentation": "

The tenancy of the Capacity Block.

", + "smithy.api#xmlName": "tenancy" + } + }, + "CapacityBlockDurationMinutes": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "CapacityBlockDurationMinutes", + "smithy.api#documentation": "

The number of minutes (in addition to capacityBlockDurationHours) for the \n\t\t\tduration of the Capacity Block reservation. For example, if a Capacity Block starts at \n\t\t\t08:55 and ends at 11:30, \n\t\t\tthe minutes field would be 35.

", + "smithy.api#xmlName": "capacityBlockDurationMinutes" + } + } + }, + "traits": { + "smithy.api#documentation": "

The recommended Capacity Block that fits your search requirements.

" + } + }, + "com.amazonaws.ec2#CapacityBlockOfferingSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CapacityBlockOffering", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#CapacityReservation": { + "type": "structure", + "members": { + "CapacityReservationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationId", + "smithy.api#documentation": "

The ID of the Capacity Reservation.

", + "smithy.api#xmlName": "capacityReservationId" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the Capacity Reservation.

", + "smithy.api#xmlName": "ownerId" + } + }, + "CapacityReservationArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Capacity Reservation.

", + "smithy.api#xmlName": "capacityReservationArn" + } + }, + "AvailabilityZoneId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZoneId", + "smithy.api#documentation": "

The Availability Zone ID of the Capacity Reservation.

", + "smithy.api#xmlName": "availabilityZoneId" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The type of instance for which the Capacity Reservation reserves capacity.

", + "smithy.api#xmlName": "instanceType" + } + }, + "InstancePlatform": { + "target": "com.amazonaws.ec2#CapacityReservationInstancePlatform", + "traits": { + "aws.protocols#ec2QueryName": "InstancePlatform", + "smithy.api#documentation": "

The type of operating system for which the Capacity Reservation reserves\n\t\t\tcapacity.

", + "smithy.api#xmlName": "instancePlatform" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone in which the capacity is reserved.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "Tenancy": { + "target": "com.amazonaws.ec2#CapacityReservationTenancy", + "traits": { + "aws.protocols#ec2QueryName": "Tenancy", + "smithy.api#documentation": "

Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one\n\t\t\tof the following tenancy settings:

\n ", + "smithy.api#xmlName": "tenancy" + } + }, + "TotalInstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TotalInstanceCount", + "smithy.api#documentation": "

The total number of instances for which the Capacity Reservation reserves\n\t\t\tcapacity.

", + "smithy.api#xmlName": "totalInstanceCount" + } + }, + "AvailableInstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "AvailableInstanceCount", + "smithy.api#documentation": "

The remaining capacity. Indicates the number of instances that can be launched in the\n\t\t\tCapacity Reservation.

", + "smithy.api#xmlName": "availableInstanceCount" + } + }, + "EbsOptimized": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EbsOptimized", + "smithy.api#documentation": "

Indicates whether the Capacity Reservation supports EBS-optimized instances. This\n\t\t\toptimization provides dedicated throughput to Amazon EBS and an optimized configuration\n\t\t\tstack to provide optimal I/O performance. This optimization isn't available with all\n\t\t\tinstance types. Additional usage charges apply when using an EBS- optimized\n\t\t\tinstance.

", + "smithy.api#xmlName": "ebsOptimized" + } + }, + "EphemeralStorage": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EphemeralStorage", + "smithy.api#documentation": "

\n Deprecated.\n

", + "smithy.api#xmlName": "ephemeralStorage" + } + }, + "State": { + "target": "com.amazonaws.ec2#CapacityReservationState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of the Capacity Reservation. A Capacity Reservation can be in one of\n\t\t\tthe following states:

\n ", + "smithy.api#xmlName": "state" + } + }, + "StartDate": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "StartDate", + "smithy.api#documentation": "

The date and time at which the Capacity Reservation was started.

", + "smithy.api#xmlName": "startDate" + } + }, + "EndDate": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "EndDate", + "smithy.api#documentation": "

The date and time at which the Capacity Reservation expires. When a Capacity\n\t\t\tReservation expires, the reserved capacity is released and you can no longer launch\n\t\t\tinstances into it. The Capacity Reservation's state changes to expired when\n\t\t\tit reaches its end date and time.

", + "smithy.api#xmlName": "endDate" + } + }, + "EndDateType": { + "target": "com.amazonaws.ec2#EndDateType", + "traits": { + "aws.protocols#ec2QueryName": "EndDateType", + "smithy.api#documentation": "

Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can\n\t\t\thave one of the following end types:

\n ", + "smithy.api#xmlName": "endDateType" + } + }, + "InstanceMatchCriteria": { + "target": "com.amazonaws.ec2#InstanceMatchCriteria", + "traits": { + "aws.protocols#ec2QueryName": "InstanceMatchCriteria", + "smithy.api#documentation": "

Indicates the type of instance launches that the Capacity Reservation accepts. The\n\t\t\toptions include:

\n ", + "smithy.api#xmlName": "instanceMatchCriteria" + } + }, + "CreateDate": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreateDate", + "smithy.api#documentation": "

The date and time at which the Capacity Reservation was created.

", + "smithy.api#xmlName": "createDate" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the Capacity Reservation.

", + "smithy.api#xmlName": "tagSet" + } + }, + "OutpostArn": { + "target": "com.amazonaws.ec2#OutpostArn", + "traits": { + "aws.protocols#ec2QueryName": "OutpostArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was\n\t\t\tcreated.

", + "smithy.api#xmlName": "outpostArn" + } + }, + "CapacityReservationFleetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationFleetId", + "smithy.api#documentation": "

The ID of the Capacity Reservation Fleet to which the Capacity Reservation belongs.\n\t\t\tOnly valid for Capacity Reservations that were created by a Capacity Reservation\n\t\t\tFleet.

", + "smithy.api#xmlName": "capacityReservationFleetId" + } + }, + "PlacementGroupArn": { + "target": "com.amazonaws.ec2#PlacementGroupArn", + "traits": { + "aws.protocols#ec2QueryName": "PlacementGroupArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster placement group in which the Capacity\n\t\t\tReservation was created. For more information, see Capacity Reservations for cluster\n\t\t\t\tplacement groups in the Amazon EC2 User Guide.

", + "smithy.api#xmlName": "placementGroupArn" + } + }, + "CapacityAllocations": { + "target": "com.amazonaws.ec2#CapacityAllocations", + "traits": { + "aws.protocols#ec2QueryName": "CapacityAllocationSet", + "smithy.api#documentation": "

Information about instance capacity usage.

", + "smithy.api#xmlName": "capacityAllocationSet" + } + }, + "ReservationType": { + "target": "com.amazonaws.ec2#CapacityReservationType", + "traits": { + "aws.protocols#ec2QueryName": "ReservationType", + "smithy.api#documentation": "

The type of Capacity Reservation.

", + "smithy.api#xmlName": "reservationType" + } + }, + "UnusedReservationBillingOwnerId": { + "target": "com.amazonaws.ec2#AccountID", + "traits": { + "aws.protocols#ec2QueryName": "UnusedReservationBillingOwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account to which billing of the unused capacity of\n\t\t\tthe Capacity Reservation is assigned.

", + "smithy.api#xmlName": "unusedReservationBillingOwnerId" + } + }, + "CommitmentInfo": { + "target": "com.amazonaws.ec2#CapacityReservationCommitmentInfo", + "traits": { + "aws.protocols#ec2QueryName": "CommitmentInfo", + "smithy.api#documentation": "

Information about your commitment for a future-dated Capacity Reservation.

", + "smithy.api#xmlName": "commitmentInfo" + } + }, + "DeliveryPreference": { + "target": "com.amazonaws.ec2#CapacityReservationDeliveryPreference", + "traits": { + "aws.protocols#ec2QueryName": "DeliveryPreference", + "smithy.api#documentation": "

The delivery method for a future-dated Capacity Reservation. incremental \n\t\t\tindicates that the requested capacity is delivered in addition to any running instances \n\t\t\tand reserved capacity that you have in your account at the requested date and time.

", + "smithy.api#xmlName": "deliveryPreference" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Capacity Reservation.

" + } + }, + "com.amazonaws.ec2#CapacityReservationBillingRequest": { + "type": "structure", + "members": { + "CapacityReservationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationId", + "smithy.api#documentation": "

The ID of the Capacity Reservation.

", + "smithy.api#xmlName": "capacityReservationId" + } + }, + "RequestedBy": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RequestedBy", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that initiated the request.

", + "smithy.api#xmlName": "requestedBy" + } + }, + "UnusedReservationBillingOwnerId": { + "target": "com.amazonaws.ec2#AccountID", + "traits": { + "aws.protocols#ec2QueryName": "UnusedReservationBillingOwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account to which the request was sent.

", + "smithy.api#xmlName": "unusedReservationBillingOwnerId" + } + }, + "LastUpdateTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "LastUpdateTime", + "smithy.api#documentation": "

The date and time, in UTC time format, at which the request was initiated.

", + "smithy.api#xmlName": "lastUpdateTime" + } + }, + "Status": { + "target": "com.amazonaws.ec2#CapacityReservationBillingRequestStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The status of the request. For more information, see View billing assignment\n\t\t\t\trequests for a shared Amazon EC2 Capacity Reservation.

", + "smithy.api#xmlName": "status" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

Information about the status.

", + "smithy.api#xmlName": "statusMessage" + } + }, + "CapacityReservationInfo": { + "target": "com.amazonaws.ec2#CapacityReservationInfo", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationInfo", + "smithy.api#documentation": "

Information about the Capacity Reservation.

", + "smithy.api#xmlName": "capacityReservationInfo" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a request to assign billing of the unused capacity of a Capacity\n\t\t\tReservation.

" + } + }, + "com.amazonaws.ec2#CapacityReservationBillingRequestSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CapacityReservationBillingRequest", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#CapacityReservationBillingRequestStatus": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "accepted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "accepted" + } + }, + "rejected": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rejected" + } + }, + "cancelled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cancelled" + } + }, + "revoked": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "revoked" + } + }, + "expired": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "expired" + } + } + } + }, + "com.amazonaws.ec2#CapacityReservationCommitmentDuration": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 200000000 + } + } + }, + "com.amazonaws.ec2#CapacityReservationCommitmentInfo": { + "type": "structure", + "members": { + "CommittedInstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "CommittedInstanceCount", + "smithy.api#documentation": "

The instance capacity that you committed to when you requested the future-dated \n\t\t\tCapacity Reservation.

", + "smithy.api#xmlName": "committedInstanceCount" + } + }, + "CommitmentEndDate": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "CommitmentEndDate", + "smithy.api#documentation": "

The date and time at which the commitment duration expires, in the ISO8601 format \n\t\t\tin the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). You can't decrease the \n\t\t\tinstance count or cancel the Capacity Reservation before this date and time.

", + "smithy.api#xmlName": "commitmentEndDate" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about your commitment for a future-dated Capacity Reservation.

" + } + }, + "com.amazonaws.ec2#CapacityReservationDeliveryPreference": { + "type": "enum", + "members": { + "FIXED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fixed" + } + }, + "INCREMENTAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "incremental" + } + } + } + }, + "com.amazonaws.ec2#CapacityReservationFleet": { + "type": "structure", + "members": { + "CapacityReservationFleetId": { + "target": "com.amazonaws.ec2#CapacityReservationFleetId", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationFleetId", + "smithy.api#documentation": "

The ID of the Capacity Reservation Fleet.

", + "smithy.api#xmlName": "capacityReservationFleetId" + } + }, + "CapacityReservationFleetArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationFleetArn", + "smithy.api#documentation": "

The ARN of the Capacity Reservation Fleet.

", + "smithy.api#xmlName": "capacityReservationFleetArn" + } + }, + "State": { + "target": "com.amazonaws.ec2#CapacityReservationFleetState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the Capacity Reservation Fleet. Possible states include:

\n ", + "smithy.api#xmlName": "state" + } + }, + "TotalTargetCapacity": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TotalTargetCapacity", + "smithy.api#documentation": "

The total number of capacity units for which the Capacity Reservation Fleet reserves\n\t\t\tcapacity. For more information, see Total target\n\t\t\t\tcapacity in the Amazon EC2 User Guide.

", + "smithy.api#xmlName": "totalTargetCapacity" + } + }, + "TotalFulfilledCapacity": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "TotalFulfilledCapacity", + "smithy.api#documentation": "

The capacity units that have been fulfilled.

", + "smithy.api#xmlName": "totalFulfilledCapacity" + } + }, + "Tenancy": { + "target": "com.amazonaws.ec2#FleetCapacityReservationTenancy", + "traits": { + "aws.protocols#ec2QueryName": "Tenancy", + "smithy.api#documentation": "

The tenancy of the Capacity Reservation Fleet. Tenancies include:

\n ", + "smithy.api#xmlName": "tenancy" + } + }, + "EndDate": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "EndDate", + "smithy.api#documentation": "

The date and time at which the Capacity Reservation Fleet expires.

", + "smithy.api#xmlName": "endDate" + } + }, + "CreateTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreateTime", + "smithy.api#documentation": "

The date and time at which the Capacity Reservation Fleet was created.

", + "smithy.api#xmlName": "createTime" + } + }, + "InstanceMatchCriteria": { + "target": "com.amazonaws.ec2#FleetInstanceMatchCriteria", + "traits": { + "aws.protocols#ec2QueryName": "InstanceMatchCriteria", + "smithy.api#documentation": "

Indicates the type of instance launches that the Capacity Reservation Fleet accepts.\n\t\t\tAll Capacity Reservations in the Fleet inherit this instance matching criteria.

\n

Currently, Capacity Reservation Fleets support open instance matching\n\t\t\tcriteria only. This means that instances that have matching attributes (instance type,\n\t\t\tplatform, and Availability Zone) run in the Capacity Reservations automatically.\n\t\t\tInstances do not need to explicitly target a Capacity Reservation Fleet to use its\n\t\t\treserved capacity.

", + "smithy.api#xmlName": "instanceMatchCriteria" + } + }, + "AllocationStrategy": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AllocationStrategy", + "smithy.api#documentation": "

The strategy used by the Capacity Reservation Fleet to determine which of the\n\t\t\tspecified instance types to use. For more information, see For more information, see\n\t\t\t\tAllocation\n\t\t\t\tstrategy in the Amazon EC2 User Guide.

", + "smithy.api#xmlName": "allocationStrategy" + } + }, + "InstanceTypeSpecifications": { + "target": "com.amazonaws.ec2#FleetCapacityReservationSet", + "traits": { + "aws.protocols#ec2QueryName": "InstanceTypeSpecificationSet", + "smithy.api#documentation": "

Information about the instance types for which to reserve the capacity.

", + "smithy.api#xmlName": "instanceTypeSpecificationSet" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the Capacity Reservation Fleet.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a Capacity Reservation Fleet.

" + } + }, + "com.amazonaws.ec2#CapacityReservationFleetCancellationState": { + "type": "structure", + "members": { + "CurrentFleetState": { + "target": "com.amazonaws.ec2#CapacityReservationFleetState", + "traits": { + "aws.protocols#ec2QueryName": "CurrentFleetState", + "smithy.api#documentation": "

The current state of the Capacity Reservation Fleet.

", + "smithy.api#xmlName": "currentFleetState" + } + }, + "PreviousFleetState": { + "target": "com.amazonaws.ec2#CapacityReservationFleetState", + "traits": { + "aws.protocols#ec2QueryName": "PreviousFleetState", + "smithy.api#documentation": "

The previous state of the Capacity Reservation Fleet.

", + "smithy.api#xmlName": "previousFleetState" + } + }, + "CapacityReservationFleetId": { + "target": "com.amazonaws.ec2#CapacityReservationFleetId", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationFleetId", + "smithy.api#documentation": "

The ID of the Capacity Reservation Fleet that was successfully cancelled.

", + "smithy.api#xmlName": "capacityReservationFleetId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Capacity Reservation Fleet that was successfully cancelled.

" + } + }, + "com.amazonaws.ec2#CapacityReservationFleetCancellationStateSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CapacityReservationFleetCancellationState", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#CapacityReservationFleetId": { + "type": "string" + }, + "com.amazonaws.ec2#CapacityReservationFleetIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CapacityReservationFleetId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#CapacityReservationFleetSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CapacityReservationFleet", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#CapacityReservationFleetState": { + "type": "enum", + "members": { + "SUBMITTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "submitted" + } + }, + "MODIFYING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modifying" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "PARTIALLY_FULFILLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "partially_fulfilled" + } + }, + "EXPIRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "expiring" + } + }, + "EXPIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "expired" + } + }, + "CANCELLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cancelling" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cancelled" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + } + } + }, + "com.amazonaws.ec2#CapacityReservationGroup": { + "type": "structure", + "members": { + "GroupArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupArn", + "smithy.api#documentation": "

The ARN of the resource group.

", + "smithy.api#xmlName": "groupArn" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the resource group.

", + "smithy.api#xmlName": "ownerId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a resource group to which a Capacity Reservation has been added.

" + } + }, + "com.amazonaws.ec2#CapacityReservationGroupSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CapacityReservationGroup", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#CapacityReservationId": { + "type": "string" + }, + "com.amazonaws.ec2#CapacityReservationIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CapacityReservationId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#CapacityReservationInfo": { + "type": "structure", + "members": { + "InstanceType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type for the Capacity Reservation.

", + "smithy.api#xmlName": "instanceType" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#AvailabilityZoneName", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone for the Capacity Reservation.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "Tenancy": { + "target": "com.amazonaws.ec2#CapacityReservationTenancy", + "traits": { + "aws.protocols#ec2QueryName": "Tenancy", + "smithy.api#documentation": "

The tenancy of the Capacity Reservation.

", + "smithy.api#xmlName": "tenancy" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a Capacity Reservation.

" + } + }, + "com.amazonaws.ec2#CapacityReservationInstancePlatform": { + "type": "enum", + "members": { + "LINUX_UNIX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Linux/UNIX" + } + }, + "RED_HAT_ENTERPRISE_LINUX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Red Hat Enterprise Linux" + } + }, + "SUSE_LINUX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUSE Linux" + } + }, + "WINDOWS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Windows" + } + }, + "WINDOWS_WITH_SQL_SERVER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Windows with SQL Server" + } + }, + "WINDOWS_WITH_SQL_SERVER_ENTERPRISE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Windows with SQL Server Enterprise" + } + }, + "WINDOWS_WITH_SQL_SERVER_STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Windows with SQL Server Standard" + } + }, + "WINDOWS_WITH_SQL_SERVER_WEB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Windows with SQL Server Web" + } + }, + "LINUX_WITH_SQL_SERVER_STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Linux with SQL Server Standard" + } + }, + "LINUX_WITH_SQL_SERVER_WEB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Linux with SQL Server Web" + } + }, + "LINUX_WITH_SQL_SERVER_ENTERPRISE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Linux with SQL Server Enterprise" + } + }, + "RHEL_WITH_SQL_SERVER_STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RHEL with SQL Server Standard" + } + }, + "RHEL_WITH_SQL_SERVER_ENTERPRISE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RHEL with SQL Server Enterprise" + } + }, + "RHEL_WITH_SQL_SERVER_WEB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RHEL with SQL Server Web" + } + }, + "RHEL_WITH_HA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RHEL with HA" + } + }, + "RHEL_WITH_HA_AND_SQL_SERVER_STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RHEL with HA and SQL Server Standard" + } + }, + "RHEL_WITH_HA_AND_SQL_SERVER_ENTERPRISE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RHEL with HA and SQL Server Enterprise" + } + }, + "UBUNTU_PRO_LINUX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ubuntu Pro" + } + } + } + }, + "com.amazonaws.ec2#CapacityReservationOptions": { + "type": "structure", + "members": { + "UsageStrategy": { + "target": "com.amazonaws.ec2#FleetCapacityReservationUsageStrategy", + "traits": { + "aws.protocols#ec2QueryName": "UsageStrategy", + "smithy.api#documentation": "

Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.

\n

If you specify use-capacity-reservations-first, the fleet uses unused\n Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If\n multiple instance pools have unused Capacity Reservations, the On-Demand allocation\n strategy (lowest-price or prioritized) is applied. If the number\n of unused Capacity Reservations is less than the On-Demand target capacity, the remaining\n On-Demand target capacity is launched according to the On-Demand allocation strategy\n (lowest-price or prioritized).

\n

If you do not specify a value, the fleet fulfils the On-Demand capacity according to the\n chosen On-Demand allocation strategy.

", + "smithy.api#xmlName": "usageStrategy" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the strategy for using unused Capacity Reservations for fulfilling On-Demand\n capacity.

\n \n

This strategy can only be used if the EC2 Fleet is of type\n instant.

\n \n

For more information about Capacity Reservations, see On-Demand Capacity\n Reservations in the Amazon EC2 User Guide. For examples of using\n Capacity Reservations in an EC2 Fleet, see EC2 Fleet example\n configurations in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#CapacityReservationOptionsRequest": { + "type": "structure", + "members": { + "UsageStrategy": { + "target": "com.amazonaws.ec2#FleetCapacityReservationUsageStrategy", + "traits": { + "smithy.api#documentation": "

Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.

\n

If you specify use-capacity-reservations-first, the fleet uses unused\n Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If\n multiple instance pools have unused Capacity Reservations, the On-Demand allocation\n strategy (lowest-price or prioritized) is applied. If the number\n of unused Capacity Reservations is less than the On-Demand target capacity, the remaining\n On-Demand target capacity is launched according to the On-Demand allocation strategy\n (lowest-price or prioritized).

\n

If you do not specify a value, the fleet fulfils the On-Demand capacity according to the\n chosen On-Demand allocation strategy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the strategy for using unused Capacity Reservations for fulfilling On-Demand\n capacity.

\n \n

This strategy can only be used if the EC2 Fleet is of type instant.

\n \n

For more information about Capacity Reservations, see On-Demand Capacity\n Reservations in the Amazon EC2 User Guide. For examples of using\n Capacity Reservations in an EC2 Fleet, see EC2 Fleet example\n configurations in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#CapacityReservationPreference": { + "type": "enum", + "members": { + "capacity_reservations_only": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "capacity-reservations-only" + } + }, + "open": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "open" + } + }, + "none": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "none" + } + } + } + }, + "com.amazonaws.ec2#CapacityReservationSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CapacityReservation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#CapacityReservationSpecification": { + "type": "structure", + "members": { + "CapacityReservationPreference": { + "target": "com.amazonaws.ec2#CapacityReservationPreference", + "traits": { + "smithy.api#documentation": "

Indicates the instance's Capacity Reservation preferences. Possible preferences \n\t\t\tinclude:

\n " + } + }, + "CapacityReservationTarget": { + "target": "com.amazonaws.ec2#CapacityReservationTarget", + "traits": { + "smithy.api#documentation": "

Information about the target Capacity Reservation or Capacity Reservation group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an instance's Capacity Reservation targeting option.

\n

Use the CapacityReservationPreference parameter to configure the instance to\n\t\t\trun as an On-Demand Instance, to run in any open Capacity Reservation that\n\t\t\thas matching attributes, or to run only in a Capacity Reservation or Capacity\n\t\t\tReservation group. Use the CapacityReservationTarget parameter to\n\t\t\texplicitly target a specific Capacity Reservation or a Capacity Reservation\n\t\t\tgroup.

\n

You can only specify CapacityReservationPreference and CapacityReservationTarget if the CapacityReservationPreference is capacity-reservations-only.

" + } + }, + "com.amazonaws.ec2#CapacityReservationSpecificationResponse": { + "type": "structure", + "members": { + "CapacityReservationPreference": { + "target": "com.amazonaws.ec2#CapacityReservationPreference", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationPreference", + "smithy.api#documentation": "

Describes the instance's Capacity Reservation preferences. Possible preferences include:

\n ", + "smithy.api#xmlName": "capacityReservationPreference" + } + }, + "CapacityReservationTarget": { + "target": "com.amazonaws.ec2#CapacityReservationTargetResponse", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationTarget", + "smithy.api#documentation": "

Information about the targeted Capacity Reservation or Capacity Reservation group.

", + "smithy.api#xmlName": "capacityReservationTarget" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the instance's Capacity Reservation targeting preferences. The action returns the\n capacityReservationPreference response element if the instance is\n configured to run in On-Demand capacity, or if it is configured in run in any\n open Capacity Reservation that has matching attributes (instance type, platform,\n Availability Zone). The action returns the capacityReservationTarget\n response element if the instance explicily targets a specific Capacity Reservation or Capacity Reservation group.

" + } + }, + "com.amazonaws.ec2#CapacityReservationState": { + "type": "enum", + "members": { + "active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "expired": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "expired" + } + }, + "cancelled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cancelled" + } + }, + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + }, + "scheduled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scheduled" + } + }, + "payment_pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "payment-pending" + } + }, + "payment_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "payment-failed" + } + }, + "assessing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "assessing" + } + }, + "delayed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "delayed" + } + }, + "unsupported": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unsupported" + } + } + } + }, + "com.amazonaws.ec2#CapacityReservationTarget": { + "type": "structure", + "members": { + "CapacityReservationId": { + "target": "com.amazonaws.ec2#CapacityReservationId", + "traits": { + "smithy.api#documentation": "

The ID of the Capacity Reservation in which to run the instance.

" + } + }, + "CapacityReservationResourceGroupArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ARN of the Capacity Reservation resource group in which to run the\n\t\t\tinstance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a target Capacity Reservation or Capacity Reservation group.

" + } + }, + "com.amazonaws.ec2#CapacityReservationTargetResponse": { + "type": "structure", + "members": { + "CapacityReservationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationId", + "smithy.api#documentation": "

The ID of the targeted Capacity Reservation.

", + "smithy.api#xmlName": "capacityReservationId" + } + }, + "CapacityReservationResourceGroupArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationResourceGroupArn", + "smithy.api#documentation": "

The ARN of the targeted Capacity Reservation group.

", + "smithy.api#xmlName": "capacityReservationResourceGroupArn" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a target Capacity Reservation or Capacity Reservation group.

" + } + }, + "com.amazonaws.ec2#CapacityReservationTenancy": { + "type": "enum", + "members": { + "default": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "default" + } + }, + "dedicated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dedicated" + } + } + } + }, + "com.amazonaws.ec2#CapacityReservationType": { + "type": "enum", + "members": { + "DEFAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "default" + } + }, + "CAPACITY_BLOCK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "capacity-block" + } + } + } + }, + "com.amazonaws.ec2#CarrierGateway": { + "type": "structure", + "members": { + "CarrierGatewayId": { + "target": "com.amazonaws.ec2#CarrierGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "CarrierGatewayId", + "smithy.api#documentation": "

The ID of the carrier gateway.

", + "smithy.api#xmlName": "carrierGatewayId" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC associated with the carrier gateway.

", + "smithy.api#xmlName": "vpcId" + } + }, + "State": { + "target": "com.amazonaws.ec2#CarrierGatewayState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the carrier gateway.

", + "smithy.api#xmlName": "state" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The Amazon Web Services account ID of the owner of the carrier gateway.

", + "smithy.api#xmlName": "ownerId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the carrier gateway.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a carrier gateway.

" + } + }, + "com.amazonaws.ec2#CarrierGatewayId": { + "type": "string" + }, + "com.amazonaws.ec2#CarrierGatewayIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CarrierGatewayId" + } + }, + "com.amazonaws.ec2#CarrierGatewayMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#CarrierGatewaySet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CarrierGateway", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#CarrierGatewayState": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + }, + "deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted" + } + } + } + }, + "com.amazonaws.ec2#CertificateArn": { + "type": "string" + }, + "com.amazonaws.ec2#CertificateAuthentication": { + "type": "structure", + "members": { + "ClientRootCertificateChain": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientRootCertificateChain", + "smithy.api#documentation": "

The ARN of the client certificate.

", + "smithy.api#xmlName": "clientRootCertificateChain" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the client certificate used for authentication.

" + } + }, + "com.amazonaws.ec2#CertificateAuthenticationRequest": { + "type": "structure", + "members": { + "ClientRootCertificateChainArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ARN of the client certificate. The certificate must be signed by a certificate \n\t\t\tauthority (CA) and it must be provisioned in Certificate Manager (ACM).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the client certificate to be used for authentication.

" + } + }, + "com.amazonaws.ec2#CertificateId": { + "type": "string" + }, + "com.amazonaws.ec2#CidrAuthorizationContext": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The plain-text authorization message for the prefix and account.

", + "smithy.api#required": {} + } + }, + "Signature": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The signed authorization message for the prefix and account.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides authorization for Amazon to bring a specific IP address range to a specific\n Amazon Web Services account using bring your own IP addresses (BYOIP). For more information, see Configuring your BYOIP address range in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#CidrBlock": { + "type": "structure", + "members": { + "CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CidrBlock", + "smithy.api#documentation": "

The IPv4 CIDR block.

", + "smithy.api#xmlName": "cidrBlock" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an IPv4 CIDR block.

" + } + }, + "com.amazonaws.ec2#CidrBlockSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CidrBlock", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ClassicLinkDnsSupport": { + "type": "structure", + "members": { + "ClassicLinkDnsSupported": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "ClassicLinkDnsSupported", + "smithy.api#documentation": "

Indicates whether ClassicLink DNS support is enabled for the VPC.

", + "smithy.api#xmlName": "classicLinkDnsSupported" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "vpcId" + } + } + }, + "traits": { + "smithy.api#documentation": "\n

Deprecated.

\n \n

Describes the ClassicLink DNS support status of a VPC.

" + } + }, + "com.amazonaws.ec2#ClassicLinkDnsSupportList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ClassicLinkDnsSupport", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ClassicLinkInstance": { + "type": "structure", + "members": { + "Groups": { + "target": "com.amazonaws.ec2#GroupIdentifierList", + "traits": { + "aws.protocols#ec2QueryName": "GroupSet", + "smithy.api#documentation": "

The security groups.

", + "smithy.api#xmlName": "groupSet" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#xmlName": "instanceId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the instance.

", + "smithy.api#xmlName": "tagSet" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "vpcId" + } + } + }, + "traits": { + "smithy.api#documentation": "\n

Deprecated.

\n \n

Describes a linked EC2-Classic instance.

" + } + }, + "com.amazonaws.ec2#ClassicLinkInstanceList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ClassicLinkInstance", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ClassicLoadBalancer": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Name", + "smithy.api#documentation": "

The name of the load balancer.

", + "smithy.api#xmlName": "name" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Classic Load Balancer.

" + } + }, + "com.amazonaws.ec2#ClassicLoadBalancers": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ClassicLoadBalancer", + "traits": { + "smithy.api#xmlName": "item" + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.ec2#ClassicLoadBalancersConfig": { + "type": "structure", + "members": { + "ClassicLoadBalancers": { + "target": "com.amazonaws.ec2#ClassicLoadBalancers", + "traits": { + "aws.protocols#ec2QueryName": "ClassicLoadBalancers", + "smithy.api#documentation": "

One or more Classic Load Balancers.

", + "smithy.api#xmlName": "classicLoadBalancers" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the Classic Load Balancers to attach to a Spot Fleet. Spot Fleet registers\n the running Spot Instances with these Classic Load Balancers.

" + } + }, + "com.amazonaws.ec2#ClientCertificateRevocationListStatus": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#ClientCertificateRevocationListStatusCode", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The state of the client certificate revocation list.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

A message about the status of the client certificate revocation list, if applicable.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the state of a client certificate revocation list.

" + } + }, + "com.amazonaws.ec2#ClientCertificateRevocationListStatusCode": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + } + } + }, + "com.amazonaws.ec2#ClientConnectOptions": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether client connect options are enabled. The default is false (not enabled).

" + } + }, + "LambdaFunctionArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Lambda function used for connection authorization.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options for managing connection authorization for new client connections.

" + } + }, + "com.amazonaws.ec2#ClientConnectResponseOptions": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Enabled", + "smithy.api#documentation": "

Indicates whether client connect options are enabled.

", + "smithy.api#xmlName": "enabled" + } + }, + "LambdaFunctionArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LambdaFunctionArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Lambda function used for connection authorization.

", + "smithy.api#xmlName": "lambdaFunctionArn" + } + }, + "Status": { + "target": "com.amazonaws.ec2#ClientVpnEndpointAttributeStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The status of any updates to the client connect options.

", + "smithy.api#xmlName": "status" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options for managing connection authorization for new client connections.

" + } + }, + "com.amazonaws.ec2#ClientData": { + "type": "structure", + "members": { + "Comment": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A user-defined comment about the disk upload.

" + } + }, + "UploadEnd": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "smithy.api#documentation": "

The time that the disk upload ends.

" + } + }, + "UploadSize": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "smithy.api#documentation": "

The size of the uploaded disk image, in GiB.

" + } + }, + "UploadStart": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "smithy.api#documentation": "

The time that the disk upload starts.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the client-specific data.

" + } + }, + "com.amazonaws.ec2#ClientLoginBannerOptions": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Enable or disable a customizable text banner that will be displayed on\n\t\t\tAmazon Web Services provided clients when a VPN session is established.

\n

Valid values: true | false\n

\n

Default value: false\n

" + } + }, + "BannerText": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Customizable text that will be displayed in a banner on Amazon Web Services provided\n\t\t\tclients when a VPN session is established. UTF-8 encoded characters only. Maximum of\n\t\t\t1400 characters.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Options for enabling a customizable text banner that will be displayed on\n\t\t\tAmazon Web Services provided clients when a VPN session is established.

" + } + }, + "com.amazonaws.ec2#ClientLoginBannerResponseOptions": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Enabled", + "smithy.api#documentation": "

Current state of text banner feature.

\n

Valid values: true | false\n

", + "smithy.api#xmlName": "enabled" + } + }, + "BannerText": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "BannerText", + "smithy.api#documentation": "

Customizable text that will be displayed in a banner on Amazon Web Services provided\n\t\t\tclients when a VPN session is established. UTF-8 encoded\n\t\t\tcharacters only. Maximum of 1400 characters.

", + "smithy.api#xmlName": "bannerText" + } + } + }, + "traits": { + "smithy.api#documentation": "

Current state of options for customizable text banner that will be displayed on\n\t\t\tAmazon Web Services provided clients when a VPN session is established.

" + } + }, + "com.amazonaws.ec2#ClientSecretType": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.ec2#ClientVpnAuthentication": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.ec2#ClientVpnAuthenticationType", + "traits": { + "aws.protocols#ec2QueryName": "Type", + "smithy.api#documentation": "

The authentication type used.

", + "smithy.api#xmlName": "type" + } + }, + "ActiveDirectory": { + "target": "com.amazonaws.ec2#DirectoryServiceAuthentication", + "traits": { + "aws.protocols#ec2QueryName": "ActiveDirectory", + "smithy.api#documentation": "

Information about the Active Directory, if applicable.

", + "smithy.api#xmlName": "activeDirectory" + } + }, + "MutualAuthentication": { + "target": "com.amazonaws.ec2#CertificateAuthentication", + "traits": { + "aws.protocols#ec2QueryName": "MutualAuthentication", + "smithy.api#documentation": "

Information about the authentication certificates, if applicable.

", + "smithy.api#xmlName": "mutualAuthentication" + } + }, + "FederatedAuthentication": { + "target": "com.amazonaws.ec2#FederatedAuthentication", + "traits": { + "aws.protocols#ec2QueryName": "FederatedAuthentication", + "smithy.api#documentation": "

Information about the IAM SAML identity provider, if applicable.

", + "smithy.api#xmlName": "federatedAuthentication" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the authentication methods used by a Client VPN endpoint. For more information, see Authentication \n\t\t\tin the Client VPN Administrator Guide.

" + } + }, + "com.amazonaws.ec2#ClientVpnAuthenticationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ClientVpnAuthentication", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ClientVpnAuthenticationRequest": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.ec2#ClientVpnAuthenticationType", + "traits": { + "smithy.api#documentation": "

The type of client authentication to be used.

" + } + }, + "ActiveDirectory": { + "target": "com.amazonaws.ec2#DirectoryServiceAuthenticationRequest", + "traits": { + "smithy.api#documentation": "

Information about the Active Directory to be used, if applicable. You must provide this information if Type is directory-service-authentication.

" + } + }, + "MutualAuthentication": { + "target": "com.amazonaws.ec2#CertificateAuthenticationRequest", + "traits": { + "smithy.api#documentation": "

Information about the authentication certificates to be used, if applicable. You must provide this information if Type is certificate-authentication.

" + } + }, + "FederatedAuthentication": { + "target": "com.amazonaws.ec2#FederatedAuthenticationRequest", + "traits": { + "smithy.api#documentation": "

Information about the IAM SAML identity provider to be used, if applicable. You must provide this information if Type is federated-authentication.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the authentication method to be used by a Client VPN endpoint. For more information, see Authentication \n\t\t\tin the Client VPN Administrator Guide.

" + } + }, + "com.amazonaws.ec2#ClientVpnAuthenticationRequestList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ClientVpnAuthenticationRequest" + } + }, + "com.amazonaws.ec2#ClientVpnAuthenticationType": { + "type": "enum", + "members": { + "certificate_authentication": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "certificate-authentication" + } + }, + "directory_service_authentication": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "directory-service-authentication" + } + }, + "federated_authentication": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "federated-authentication" + } + } + } + }, + "com.amazonaws.ec2#ClientVpnAuthorizationRuleStatus": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#ClientVpnAuthorizationRuleStatusCode", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The state of the authorization rule.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

A message about the status of the authorization rule, if applicable.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the state of an authorization rule.

" + } + }, + "com.amazonaws.ec2#ClientVpnAuthorizationRuleStatusCode": { + "type": "enum", + "members": { + "authorizing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "authorizing" + } + }, + "active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + }, + "revoking": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "revoking" + } + } + } + }, + "com.amazonaws.ec2#ClientVpnConnection": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientVpnEndpointId", + "smithy.api#documentation": "

The ID of the Client VPN endpoint to which the client is connected.

", + "smithy.api#xmlName": "clientVpnEndpointId" + } + }, + "Timestamp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Timestamp", + "smithy.api#documentation": "

The current date and time.

", + "smithy.api#xmlName": "timestamp" + } + }, + "ConnectionId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ConnectionId", + "smithy.api#documentation": "

The ID of the client connection.

", + "smithy.api#xmlName": "connectionId" + } + }, + "Username": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Username", + "smithy.api#documentation": "

The username of the client who established the client connection. This information is only provided \n\t\t\tif Active Directory client authentication is used.

", + "smithy.api#xmlName": "username" + } + }, + "ConnectionEstablishedTime": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ConnectionEstablishedTime", + "smithy.api#documentation": "

The date and time the client connection was established.

", + "smithy.api#xmlName": "connectionEstablishedTime" + } + }, + "IngressBytes": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IngressBytes", + "smithy.api#documentation": "

The number of bytes sent by the client.

", + "smithy.api#xmlName": "ingressBytes" + } + }, + "EgressBytes": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "EgressBytes", + "smithy.api#documentation": "

The number of bytes received by the client.

", + "smithy.api#xmlName": "egressBytes" + } + }, + "IngressPackets": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IngressPackets", + "smithy.api#documentation": "

The number of packets sent by the client.

", + "smithy.api#xmlName": "ingressPackets" + } + }, + "EgressPackets": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "EgressPackets", + "smithy.api#documentation": "

The number of packets received by the client.

", + "smithy.api#xmlName": "egressPackets" + } + }, + "ClientIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientIp", + "smithy.api#documentation": "

The IP address of the client.

", + "smithy.api#xmlName": "clientIp" + } + }, + "CommonName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CommonName", + "smithy.api#documentation": "

The common name associated with the client. This is either the name of the client certificate,\n\t\t\tor the Active Directory user name.

", + "smithy.api#xmlName": "commonName" + } + }, + "Status": { + "target": "com.amazonaws.ec2#ClientVpnConnectionStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The current state of the client connection.

", + "smithy.api#xmlName": "status" + } + }, + "ConnectionEndTime": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ConnectionEndTime", + "smithy.api#documentation": "

The date and time the client connection was terminated.

", + "smithy.api#xmlName": "connectionEndTime" + } + }, + "PostureComplianceStatuses": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "PostureComplianceStatusSet", + "smithy.api#documentation": "

The statuses returned by the client connect handler for posture compliance, if applicable.

", + "smithy.api#xmlName": "postureComplianceStatusSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a client connection.

" + } + }, + "com.amazonaws.ec2#ClientVpnConnectionSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ClientVpnConnection", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ClientVpnConnectionStatus": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#ClientVpnConnectionStatusCode", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The state of the client connection.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

A message about the status of the client connection, if applicable.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the status of a client connection.

" + } + }, + "com.amazonaws.ec2#ClientVpnConnectionStatusCode": { + "type": "enum", + "members": { + "active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "failed_to_terminate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed-to-terminate" + } + }, + "terminating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "terminating" + } + }, + "terminated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "terminated" + } + } + } + }, + "com.amazonaws.ec2#ClientVpnEndpoint": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientVpnEndpointId", + "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", + "smithy.api#xmlName": "clientVpnEndpointId" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A brief description of the endpoint.

", + "smithy.api#xmlName": "description" + } + }, + "Status": { + "target": "com.amazonaws.ec2#ClientVpnEndpointStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The current state of the Client VPN endpoint.

", + "smithy.api#xmlName": "status" + } + }, + "CreationTime": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CreationTime", + "smithy.api#documentation": "

The date and time the Client VPN endpoint was created.

", + "smithy.api#xmlName": "creationTime" + } + }, + "DeletionTime": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DeletionTime", + "smithy.api#documentation": "

The date and time the Client VPN endpoint was deleted, if applicable.

", + "smithy.api#xmlName": "deletionTime" + } + }, + "DnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DnsName", + "smithy.api#documentation": "

The DNS name to be used by clients when connecting to the Client VPN endpoint.

", + "smithy.api#xmlName": "dnsName" + } + }, + "ClientCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientCidrBlock", + "smithy.api#documentation": "

The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.

", + "smithy.api#xmlName": "clientCidrBlock" + } + }, + "DnsServers": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "DnsServer", + "smithy.api#documentation": "

Information about the DNS servers to be used for DNS resolution.

", + "smithy.api#xmlName": "dnsServer" + } + }, + "SplitTunnel": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "SplitTunnel", + "smithy.api#documentation": "

Indicates whether split-tunnel is enabled in the Client VPN endpoint.

\n

For information about split-tunnel VPN endpoints, see Split-Tunnel Client VPN endpoint \n\t\t\tin the Client VPN Administrator Guide.

", + "smithy.api#xmlName": "splitTunnel" + } + }, + "VpnProtocol": { + "target": "com.amazonaws.ec2#VpnProtocol", + "traits": { + "aws.protocols#ec2QueryName": "VpnProtocol", + "smithy.api#documentation": "

The protocol used by the VPN session.

", + "smithy.api#xmlName": "vpnProtocol" + } + }, + "TransportProtocol": { + "target": "com.amazonaws.ec2#TransportProtocol", + "traits": { + "aws.protocols#ec2QueryName": "TransportProtocol", + "smithy.api#documentation": "

The transport protocol used by the Client VPN endpoint.

", + "smithy.api#xmlName": "transportProtocol" + } + }, + "VpnPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "VpnPort", + "smithy.api#documentation": "

The port number for the Client VPN endpoint.

", + "smithy.api#xmlName": "vpnPort" + } + }, + "AssociatedTargetNetworks": { + "target": "com.amazonaws.ec2#AssociatedTargetNetworkSet", + "traits": { + "aws.protocols#ec2QueryName": "AssociatedTargetNetwork", + "smithy.api#deprecated": { + "message": "This property is deprecated. To view the target networks associated with a Client VPN endpoint, call DescribeClientVpnTargetNetworks and inspect the clientVpnTargetNetworks response element." + }, + "smithy.api#documentation": "

Information about the associated target networks. A target network is a subnet in a VPC.

", + "smithy.api#xmlName": "associatedTargetNetwork" + } + }, + "ServerCertificateArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ServerCertificateArn", + "smithy.api#documentation": "

The ARN of the server certificate.

", + "smithy.api#xmlName": "serverCertificateArn" + } + }, + "AuthenticationOptions": { + "target": "com.amazonaws.ec2#ClientVpnAuthenticationList", + "traits": { + "aws.protocols#ec2QueryName": "AuthenticationOptions", + "smithy.api#documentation": "

Information about the authentication method used by the Client VPN endpoint.

", + "smithy.api#xmlName": "authenticationOptions" + } + }, + "ConnectionLogOptions": { + "target": "com.amazonaws.ec2#ConnectionLogResponseOptions", + "traits": { + "aws.protocols#ec2QueryName": "ConnectionLogOptions", + "smithy.api#documentation": "

Information about the client connection logging options for the Client VPN endpoint.

", + "smithy.api#xmlName": "connectionLogOptions" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the Client VPN endpoint.

", + "smithy.api#xmlName": "tagSet" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.ec2#ClientVpnSecurityGroupIdSet", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroupIdSet", + "smithy.api#documentation": "

The IDs of the security groups for the target network.

", + "smithy.api#xmlName": "securityGroupIdSet" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "vpcId" + } + }, + "SelfServicePortalUrl": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SelfServicePortalUrl", + "smithy.api#documentation": "

The URL of the self-service portal.

", + "smithy.api#xmlName": "selfServicePortalUrl" + } + }, + "ClientConnectOptions": { + "target": "com.amazonaws.ec2#ClientConnectResponseOptions", + "traits": { + "aws.protocols#ec2QueryName": "ClientConnectOptions", + "smithy.api#documentation": "

The options for managing connection authorization for new client connections.

", + "smithy.api#xmlName": "clientConnectOptions" + } + }, + "SessionTimeoutHours": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "SessionTimeoutHours", + "smithy.api#documentation": "

The maximum VPN session duration time in hours.

\n

Valid values: 8 | 10 | 12 | 24\n

\n

Default value: 24\n

", + "smithy.api#xmlName": "sessionTimeoutHours" + } + }, + "ClientLoginBannerOptions": { + "target": "com.amazonaws.ec2#ClientLoginBannerResponseOptions", + "traits": { + "aws.protocols#ec2QueryName": "ClientLoginBannerOptions", + "smithy.api#documentation": "

Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is\n\t\t\testablished.

", + "smithy.api#xmlName": "clientLoginBannerOptions" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Client VPN endpoint.

" + } + }, + "com.amazonaws.ec2#ClientVpnEndpointAttributeStatus": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#ClientVpnEndpointAttributeStatusCode", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The status code.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

The status message.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the status of the Client VPN endpoint attribute.

" + } + }, + "com.amazonaws.ec2#ClientVpnEndpointAttributeStatusCode": { + "type": "enum", + "members": { + "applying": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "applying" + } + }, + "applied": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "applied" + } + } + } + }, + "com.amazonaws.ec2#ClientVpnEndpointId": { + "type": "string" + }, + "com.amazonaws.ec2#ClientVpnEndpointIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ClientVpnEndpointId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ClientVpnEndpointStatus": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#ClientVpnEndpointStatusCode", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The state of the Client VPN endpoint. Possible states include:

\n ", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

A message about the status of the Client VPN endpoint.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the state of a Client VPN endpoint.

" + } + }, + "com.amazonaws.ec2#ClientVpnEndpointStatusCode": { + "type": "enum", + "members": { + "pending_associate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending-associate" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + }, + "deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted" + } + } + } + }, + "com.amazonaws.ec2#ClientVpnRoute": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientVpnEndpointId", + "smithy.api#documentation": "

The ID of the Client VPN endpoint with which the route is associated.

", + "smithy.api#xmlName": "clientVpnEndpointId" + } + }, + "DestinationCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationCidr", + "smithy.api#documentation": "

The IPv4 address range, in CIDR notation, of the route destination.

", + "smithy.api#xmlName": "destinationCidr" + } + }, + "TargetSubnet": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TargetSubnet", + "smithy.api#documentation": "

The ID of the subnet through which traffic is routed.

", + "smithy.api#xmlName": "targetSubnet" + } + }, + "Type": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Type", + "smithy.api#documentation": "

The route type.

", + "smithy.api#xmlName": "type" + } + }, + "Origin": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Origin", + "smithy.api#documentation": "

Indicates how the route was associated with the Client VPN endpoint. \n\t\t\tassociate indicates that the route was automatically added when the target network \n\t\t\twas associated with the Client VPN endpoint. add-route indicates that the route \n\t\t\twas manually added using the CreateClientVpnRoute action.

", + "smithy.api#xmlName": "origin" + } + }, + "Status": { + "target": "com.amazonaws.ec2#ClientVpnRouteStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The current state of the route.

", + "smithy.api#xmlName": "status" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A brief description of the route.

", + "smithy.api#xmlName": "description" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a Client VPN endpoint route.

" + } + }, + "com.amazonaws.ec2#ClientVpnRouteSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ClientVpnRoute", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ClientVpnRouteStatus": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#ClientVpnRouteStatusCode", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The state of the Client VPN endpoint route.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

A message about the status of the Client VPN endpoint route, if applicable.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the state of a Client VPN endpoint route.

" + } + }, + "com.amazonaws.ec2#ClientVpnRouteStatusCode": { + "type": "enum", + "members": { + "creating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "creating" + } + }, + "active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + } + } + }, + "com.amazonaws.ec2#ClientVpnSecurityGroupIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#CloudWatchLogGroupArn": { + "type": "string" + }, + "com.amazonaws.ec2#CloudWatchLogOptions": { + "type": "structure", + "members": { + "LogEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "LogEnabled", + "smithy.api#documentation": "

Status of VPN tunnel logging feature. Default value is False.

\n

Valid values: True | False\n

", + "smithy.api#xmlName": "logEnabled" + } + }, + "LogGroupArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LogGroupArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CloudWatch log group to send logs to.

", + "smithy.api#xmlName": "logGroupArn" + } + }, + "LogOutputFormat": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LogOutputFormat", + "smithy.api#documentation": "

Configured log format. Default format is json.

\n

Valid values: json | text\n

", + "smithy.api#xmlName": "logOutputFormat" + } + } + }, + "traits": { + "smithy.api#documentation": "

Options for sending VPN tunnel logs to CloudWatch.

" + } + }, + "com.amazonaws.ec2#CloudWatchLogOptionsSpecification": { + "type": "structure", + "members": { + "LogEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Enable or disable VPN tunnel logging feature. Default value is False.

\n

Valid values: True | False\n

" + } + }, + "LogGroupArn": { + "target": "com.amazonaws.ec2#CloudWatchLogGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CloudWatch log group to send logs to.

" + } + }, + "LogOutputFormat": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Set log format. Default format is json.

\n

Valid values: json | text\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Options for sending VPN tunnel logs to CloudWatch.

" + } + }, + "com.amazonaws.ec2#CoipAddressUsage": { + "type": "structure", + "members": { + "AllocationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AllocationId", + "smithy.api#documentation": "

The allocation ID of the address.

", + "smithy.api#xmlName": "allocationId" + } + }, + "AwsAccountId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AwsAccountId", + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#xmlName": "awsAccountId" + } + }, + "AwsService": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AwsService", + "smithy.api#documentation": "

The Amazon Web Services service.

", + "smithy.api#xmlName": "awsService" + } + }, + "CoIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CoIp", + "smithy.api#documentation": "

The customer-owned IP address.

", + "smithy.api#xmlName": "coIp" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes address usage for a customer-owned address pool.

" + } + }, + "com.amazonaws.ec2#CoipAddressUsageSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CoipAddressUsage", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#CoipCidr": { + "type": "structure", + "members": { + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Cidr", + "smithy.api#documentation": "

\n An address range in a customer-owned IP address space.\n

", + "smithy.api#xmlName": "cidr" + } + }, + "CoipPoolId": { + "target": "com.amazonaws.ec2#Ipv4PoolCoipId", + "traits": { + "aws.protocols#ec2QueryName": "CoipPoolId", + "smithy.api#documentation": "

\n The ID of the address pool.\n

", + "smithy.api#xmlName": "coipPoolId" + } + }, + "LocalGatewayRouteTableId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayRouteTableId", + "smithy.api#documentation": "

\n The ID of the local gateway route table.\n

", + "smithy.api#xmlName": "localGatewayRouteTableId" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Information about a customer-owned IP address range.\n

" + } + }, + "com.amazonaws.ec2#CoipPool": { + "type": "structure", + "members": { + "PoolId": { + "target": "com.amazonaws.ec2#Ipv4PoolCoipId", + "traits": { + "aws.protocols#ec2QueryName": "PoolId", + "smithy.api#documentation": "

The ID of the address pool.

", + "smithy.api#xmlName": "poolId" + } + }, + "PoolCidrs": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "PoolCidrSet", + "smithy.api#documentation": "

The address ranges of the address pool.

", + "smithy.api#xmlName": "poolCidrSet" + } + }, + "LocalGatewayRouteTableId": { + "target": "com.amazonaws.ec2#LocalGatewayRoutetableId", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayRouteTableId", + "smithy.api#documentation": "

The ID of the local gateway route table.

", + "smithy.api#xmlName": "localGatewayRouteTableId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags.

", + "smithy.api#xmlName": "tagSet" + } + }, + "PoolArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "PoolArn", + "smithy.api#documentation": "

The ARN of the address pool.

", + "smithy.api#xmlName": "poolArn" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a customer-owned address pool.

" + } + }, + "com.amazonaws.ec2#CoipPoolId": { + "type": "string" + }, + "com.amazonaws.ec2#CoipPoolIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Ipv4PoolCoipId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#CoipPoolMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#CoipPoolSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CoipPool", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ComponentAccount": { + "type": "string", + "traits": { + "smithy.api#pattern": "^\\d{12}$" + } + }, + "com.amazonaws.ec2#ComponentRegion": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-z]{2}-[a-z]+-[1-9]+$" + } + }, + "com.amazonaws.ec2#ConfirmProductInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ConfirmProductInstanceRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ConfirmProductInstanceResult" + }, + "traits": { + "smithy.api#documentation": "

Determines whether a product code is associated with an instance. This action can only\n be used by the owner of the product code. It is useful when a product code owner must\n verify whether another user's instance is eligible for support.

", + "smithy.api#examples": [ + { + "title": "To confirm the product instance", + "documentation": "This example determines whether the specified product code is associated with the specified instance.", + "input": { + "ProductCode": "774F4FF8", + "InstanceId": "i-1234567890abcdef0" + }, + "output": { + "OwnerId": "123456789012" + } + } + ] + } + }, + "com.amazonaws.ec2#ConfirmProductInstanceRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#required": {} + } + }, + "ProductCode": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The product code. This must be a product code that you own.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ConfirmProductInstanceResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

The return value of the request. Returns true if the specified product\n code is owned by the requester and associated with the specified instance.

", + "smithy.api#xmlName": "return" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The Amazon Web Services account ID of the instance owner. This is only present if the\n product code is attached to the instance.

", + "smithy.api#xmlName": "ownerId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ConnectionLogOptions": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether connection logging is enabled.

" + } + }, + "CloudwatchLogGroup": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the CloudWatch Logs log group. Required if connection logging is enabled.

" + } + }, + "CloudwatchLogStream": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the CloudWatch Logs log stream to which the connection data is published.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the client connection logging options for the Client VPN endpoint.

" + } + }, + "com.amazonaws.ec2#ConnectionLogResponseOptions": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether client connection logging is enabled for the Client VPN endpoint.

" + } + }, + "CloudwatchLogGroup": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon CloudWatch Logs log group to which connection logging data is published.

" + } + }, + "CloudwatchLogStream": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon CloudWatch Logs log stream to which connection logging data is published.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the client connection logging options for a Client VPN endpoint.

" + } + }, + "com.amazonaws.ec2#ConnectionNotification": { + "type": "structure", + "members": { + "ConnectionNotificationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ConnectionNotificationId", + "smithy.api#documentation": "

The ID of the notification.

", + "smithy.api#xmlName": "connectionNotificationId" + } + }, + "ServiceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ServiceId", + "smithy.api#documentation": "

The ID of the endpoint service.

", + "smithy.api#xmlName": "serviceId" + } + }, + "VpcEndpointId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcEndpointId", + "smithy.api#documentation": "

The ID of the VPC endpoint.

", + "smithy.api#xmlName": "vpcEndpointId" + } + }, + "ConnectionNotificationType": { + "target": "com.amazonaws.ec2#ConnectionNotificationType", + "traits": { + "aws.protocols#ec2QueryName": "ConnectionNotificationType", + "smithy.api#documentation": "

The type of notification.

", + "smithy.api#xmlName": "connectionNotificationType" + } + }, + "ConnectionNotificationArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ConnectionNotificationArn", + "smithy.api#documentation": "

The ARN of the SNS topic for the notification.

", + "smithy.api#xmlName": "connectionNotificationArn" + } + }, + "ConnectionEvents": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "ConnectionEvents", + "smithy.api#documentation": "

The events for the notification. Valid values are Accept,\n Connect, Delete, and Reject.

", + "smithy.api#xmlName": "connectionEvents" + } + }, + "ConnectionNotificationState": { + "target": "com.amazonaws.ec2#ConnectionNotificationState", + "traits": { + "aws.protocols#ec2QueryName": "ConnectionNotificationState", + "smithy.api#documentation": "

The state of the notification.

", + "smithy.api#xmlName": "connectionNotificationState" + } + }, + "ServiceRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ServiceRegion", + "smithy.api#documentation": "

The Region for the endpoint service.

", + "smithy.api#xmlName": "serviceRegion" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a connection notification for a VPC endpoint or VPC endpoint\n service.

" + } + }, + "com.amazonaws.ec2#ConnectionNotificationId": { + "type": "string" + }, + "com.amazonaws.ec2#ConnectionNotificationIdsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ConnectionNotificationId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ConnectionNotificationSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ConnectionNotification", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ConnectionNotificationState": { + "type": "enum", + "members": { + "Enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enabled" + } + }, + "Disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disabled" + } + } + } + }, + "com.amazonaws.ec2#ConnectionNotificationType": { + "type": "enum", + "members": { + "Topic": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Topic" + } + } + } + }, + "com.amazonaws.ec2#ConnectionTrackingConfiguration": { + "type": "structure", + "members": { + "TcpEstablishedTimeout": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TcpEstablishedTimeout", + "smithy.api#documentation": "

Timeout (in seconds) for idle TCP\n\t\t\t\t\t\tconnections in an established state. Min: 60 seconds. Max: 432000 seconds (5\n\t\t\t\t\t\tdays). Default: 432000 seconds. Recommended: Less than 432000 seconds.

", + "smithy.api#xmlName": "tcpEstablishedTimeout" + } + }, + "UdpStreamTimeout": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "UdpStreamTimeout", + "smithy.api#documentation": "

Timeout (in seconds) for idle UDP\n\t\t\t\t\t\tflows classified as streams which have seen more than one request-response\n\t\t\t\t\t\ttransaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180\n\t\t\t\t\t\tseconds.

", + "smithy.api#xmlName": "udpStreamTimeout" + } + }, + "UdpTimeout": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "UdpTimeout", + "smithy.api#documentation": "

Timeout (in seconds) for idle UDP flows that\n\t\t\t\t\t\thave seen traffic only in a single direction or a single request-response\n\t\t\t\t\t\ttransaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds.

", + "smithy.api#xmlName": "udpTimeout" + } + } + }, + "traits": { + "smithy.api#documentation": "

A security group connection tracking configuration that enables you to set the idle timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#ConnectionTrackingSpecification": { + "type": "structure", + "members": { + "TcpEstablishedTimeout": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TcpEstablishedTimeout", + "smithy.api#documentation": "

Timeout (in seconds) for idle TCP\n\t\t\t\t\t\tconnections in an established state. Min: 60 seconds. Max: 432000 seconds (5\n\t\t\t\t\t\tdays). Default: 432000 seconds. Recommended: Less than 432000 seconds.

", + "smithy.api#xmlName": "tcpEstablishedTimeout" + } + }, + "UdpTimeout": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "UdpTimeout", + "smithy.api#documentation": "

Timeout (in seconds) for idle UDP flows that\n\t\t\t\t\t\thave seen traffic only in a single direction or a single request-response\n\t\t\t\t\t\ttransaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds.

", + "smithy.api#xmlName": "udpTimeout" + } + }, + "UdpStreamTimeout": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "UdpStreamTimeout", + "smithy.api#documentation": "

Timeout (in seconds) for idle UDP\n\t\t\t\t\t\tflows classified as streams which have seen more than one request-response\n\t\t\t\t\t\ttransaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180\n\t\t\t\t\t\tseconds.

", + "smithy.api#xmlName": "udpStreamTimeout" + } + } + }, + "traits": { + "smithy.api#documentation": "

A security group connection tracking specification that enables you to set the idle timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#ConnectionTrackingSpecificationRequest": { + "type": "structure", + "members": { + "TcpEstablishedTimeout": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

Timeout (in seconds) for idle TCP\n\t\t\t\t\t\tconnections in an established state. Min: 60 seconds. Max: 432000 seconds (5\n\t\t\t\t\t\tdays). Default: 432000 seconds. Recommended: Less than 432000 seconds.

" + } + }, + "UdpStreamTimeout": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

Timeout (in seconds) for idle UDP\n\t\t\t\t\t\tflows classified as streams which have seen more than one request-response\n\t\t\t\t\t\ttransaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180\n\t\t\t\t\t\tseconds.

" + } + }, + "UdpTimeout": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

Timeout (in seconds) for idle UDP flows that\n\t\t\t\t\t\thave seen traffic only in a single direction or a single request-response\n\t\t\t\t\t\ttransaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A security group connection tracking specification request that enables you to set the idle timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#ConnectionTrackingSpecificationResponse": { + "type": "structure", + "members": { + "TcpEstablishedTimeout": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TcpEstablishedTimeout", + "smithy.api#documentation": "

Timeout (in seconds) for idle TCP\n\t\t\t\t\t\tconnections in an established state. Min: 60 seconds. Max: 432000 seconds (5\n\t\t\t\t\t\tdays). Default: 432000 seconds. Recommended: Less than 432000 seconds.

", + "smithy.api#xmlName": "tcpEstablishedTimeout" + } + }, + "UdpStreamTimeout": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "UdpStreamTimeout", + "smithy.api#documentation": "

Timeout (in seconds) for idle UDP\n\t\t\t\t\t\tflows classified as streams which have seen more than one request-response\n\t\t\t\t\t\ttransaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180\n\t\t\t\t\t\tseconds.

", + "smithy.api#xmlName": "udpStreamTimeout" + } + }, + "UdpTimeout": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "UdpTimeout", + "smithy.api#documentation": "

Timeout (in seconds) for idle UDP flows that\n\t\t\t\t\t\thave seen traffic only in a single direction or a single request-response\n\t\t\t\t\t\ttransaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds.

", + "smithy.api#xmlName": "udpTimeout" + } + } + }, + "traits": { + "smithy.api#documentation": "

A security group connection tracking specification response that enables you to set the idle timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#ConnectivityType": { + "type": "enum", + "members": { + "PRIVATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "private" + } + }, + "PUBLIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "public" + } + } + } + }, + "com.amazonaws.ec2#ContainerFormat": { + "type": "enum", + "members": { + "ova": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ova" + } + } + } + }, + "com.amazonaws.ec2#ConversionIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ConversionTaskId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ConversionTask": { + "type": "structure", + "members": { + "ConversionTaskId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ConversionTaskId", + "smithy.api#documentation": "

The ID of the conversion task.

", + "smithy.api#xmlName": "conversionTaskId" + } + }, + "ExpirationTime": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ExpirationTime", + "smithy.api#documentation": "

The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel\n the task.

", + "smithy.api#xmlName": "expirationTime" + } + }, + "ImportInstance": { + "target": "com.amazonaws.ec2#ImportInstanceTaskDetails", + "traits": { + "aws.protocols#ec2QueryName": "ImportInstance", + "smithy.api#documentation": "

If the task is for importing an instance, this contains information about the import instance task.

", + "smithy.api#xmlName": "importInstance" + } + }, + "ImportVolume": { + "target": "com.amazonaws.ec2#ImportVolumeTaskDetails", + "traits": { + "aws.protocols#ec2QueryName": "ImportVolume", + "smithy.api#documentation": "

If the task is for importing a volume, this contains information about the import volume task.

", + "smithy.api#xmlName": "importVolume" + } + }, + "State": { + "target": "com.amazonaws.ec2#ConversionTaskState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the conversion task.

", + "smithy.api#xmlName": "state" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

The status message related to the conversion task.

", + "smithy.api#xmlName": "statusMessage" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the task.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a conversion task.

" + } + }, + "com.amazonaws.ec2#ConversionTaskId": { + "type": "string" + }, + "com.amazonaws.ec2#ConversionTaskState": { + "type": "enum", + "members": { + "active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "cancelling": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cancelling" + } + }, + "cancelled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cancelled" + } + }, + "completed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "completed" + } + } + } + }, + "com.amazonaws.ec2#CoolOffPeriodRequestHours": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 72 + } + } + }, + "com.amazonaws.ec2#CoolOffPeriodResponseHours": { + "type": "integer" + }, + "com.amazonaws.ec2#CopyFpgaImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CopyFpgaImageRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CopyFpgaImageResult" + }, + "traits": { + "smithy.api#documentation": "

Copies the specified Amazon FPGA Image (AFI) to the current Region.

" + } + }, + "com.amazonaws.ec2#CopyFpgaImageRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "SourceFpgaImageId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the source AFI.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The description for the new AFI.

" + } + }, + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name for the new AFI. The default is the name of the source AFI.

" + } + }, + "SourceRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Region that contains the source AFI.

", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. \n \tFor more information, see Ensuring idempotency.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CopyFpgaImageResult": { + "type": "structure", + "members": { + "FpgaImageId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "FpgaImageId", + "smithy.api#documentation": "

The ID of the new AFI.

", + "smithy.api#xmlName": "fpgaImageId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CopyImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CopyImageRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CopyImageResult" + }, + "traits": { + "smithy.api#documentation": "

Initiates an AMI copy operation. You can copy an AMI from one Region to another, or from a\n Region to an Outpost. You can't copy an AMI from an Outpost to a Region, from one Outpost to\n another, or within the same Outpost. To copy an AMI to another partition, see CreateStoreImageTask.

\n

When you copy an AMI from one Region to another, the destination Region is the current\n Region.

\n

When you copy an AMI from a Region to an Outpost, specify the ARN of the Outpost as the\n destination. Backing snapshots copied to an Outpost are encrypted by default using the default\n encryption key for the Region or the key that you specify. Outposts do not support unencrypted\n snapshots.

\n

For information about the prerequisites when copying an AMI, see Copy an AMI in the\n Amazon EC2 User Guide.

", + "smithy.api#examples": [ + { + "title": "To copy an AMI to another region", + "documentation": "This example copies the specified AMI from the us-east-1 region to the current region.", + "input": { + "Description": "", + "Name": "My server", + "SourceImageId": "ami-5731123e", + "SourceRegion": "us-east-1" + }, + "output": { + "ImageId": "ami-438bea42" + } + } + ] + } + }, + "com.amazonaws.ec2#CopyImageRequest": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For\n more information, see Ensuring idempotency\n in the Amazon EC2 API Reference.

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description for the new AMI in the destination Region.

" + } + }, + "Encrypted": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Encrypted", + "smithy.api#documentation": "

Specifies whether the destination snapshots of the copied image should be encrypted. You\n can encrypt a copy of an unencrypted snapshot, but you cannot create an unencrypted copy of an\n encrypted snapshot. The default KMS key for Amazon EBS is used unless you specify a non-default\n Key Management Service (KMS) KMS key using KmsKeyId. For more information, see Use encryption with\n EBS-backed AMIs in the Amazon EC2 User Guide.

", + "smithy.api#xmlName": "encrypted" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.ec2#KmsKeyId", + "traits": { + "aws.protocols#ec2QueryName": "KmsKeyId", + "smithy.api#documentation": "

The identifier of the symmetric Key Management Service (KMS) KMS key to use when creating encrypted volumes.\n If this parameter is not specified, your Amazon Web Services managed KMS key for Amazon EBS is used. If you\n specify a KMS key, you must also set the encrypted state to true.

\n

You can specify a KMS key using any of the following:

\n \n

Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an identifier\n that is not valid, the action can appear to complete, but eventually fails.

\n

The specified KMS key must exist in the destination Region.

\n

Amazon EBS does not support asymmetric KMS keys.

", + "smithy.api#xmlName": "kmsKeyId" + } + }, + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the new AMI in the destination Region.

", + "smithy.api#required": {} + } + }, + "SourceImageId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the AMI to copy.

", + "smithy.api#required": {} + } + }, + "SourceRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Region that contains the AMI to copy.

", + "smithy.api#required": {} + } + }, + "DestinationOutpostArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost to which to copy the AMI. Only specify this\n parameter when copying an AMI from an Amazon Web Services Region to an Outpost. The AMI must be in the\n Region of the destination Outpost. You cannot copy an AMI from an Outpost to a Region, from\n one Outpost to another, or within the same Outpost.

\n

For more information, see Copy AMIs from an Amazon Web Services Region\n to an Outpost in the Amazon EBS User Guide.

" + } + }, + "CopyImageTags": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether to include your user-defined AMI tags when copying the AMI.

\n

The following tags will not be copied:

\n \n

Default: Your user-defined AMI tags are not copied.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the new AMI and new snapshots. You can tag the AMI, the snapshots, or\n both.

\n \n

If you specify other values for ResourceType, the request fails.

\n

To tag an AMI or snapshot after it has been created, see CreateTags.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for CopyImage.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CopyImageResult": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the new AMI.

", + "smithy.api#xmlName": "imageId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of CopyImage.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CopySnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CopySnapshotRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CopySnapshotResult" + }, + "traits": { + "smithy.api#documentation": "

Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy a\n snapshot within the same Region, from one Region to another, or from a Region to an Outpost. \n You can't copy a snapshot from an Outpost to a Region, from one Outpost to another, or within \n the same Outpost.

\n

You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs).

\n

When copying snapshots to a Region, copies of encrypted EBS snapshots remain encrypted. \n \tCopies of unencrypted snapshots remain unencrypted, unless you enable encryption for the \n \tsnapshot copy operation. By default, encrypted snapshot copies use the default KMS key; \n \thowever, you can specify a different KMS key. To copy an encrypted \n \tsnapshot that has been shared from another account, you must have permissions for the KMS key \n \tused to encrypt the snapshot.

\n

Snapshots copied to an Outpost are encrypted by default using the default\n \t\tencryption key for the Region, or a different key that you specify in the request using \n \t\tKmsKeyId. Outposts do not support unencrypted \n \t snapshots. For more information, \n \t\t\tAmazon EBS local snapshots on Outposts in the Amazon EBS User Guide.

\n

Snapshots created by copying another snapshot have an arbitrary volume ID that should not\n be used for any purpose.

\n

For more information, see Copy an Amazon EBS snapshot in the\n Amazon EBS User Guide.

", + "smithy.api#examples": [ + { + "title": "To copy a snapshot", + "documentation": "This example copies a snapshot with the snapshot ID of ``snap-066877671789bd71b`` from the ``us-west-2`` region to the ``us-east-1`` region and adds a short description to identify the snapshot.", + "input": { + "SourceRegion": "us-west-2", + "SourceSnapshotId": "snap-066877671789bd71b", + "Description": "This is my copied snapshot.", + "DestinationRegion": "us-east-1" + }, + "output": { + "SnapshotId": "snap-066877671789bd71b" + } + } + ] + } + }, + "com.amazonaws.ec2#CopySnapshotRequest": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description for the EBS snapshot.

" + } + }, + "DestinationOutpostArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost to which to copy the snapshot. Only \n\t\tspecify this parameter when copying a snapshot from an Amazon Web Services Region to an Outpost. \n\t\tThe snapshot must be in the Region for the destination Outpost. You cannot copy a \n\t\tsnapshot from an Outpost to a Region, from one Outpost to another, or within the same \n\t\tOutpost.

\n

For more information, see \n \t\tCopy snapshots from an Amazon Web Services Region to an Outpost in the \n \t\tAmazon EBS User Guide.

" + } + }, + "DestinationRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationRegion", + "smithy.api#documentation": "

The destination Region to use in the PresignedUrl parameter of a snapshot\n copy operation. This parameter is only valid for specifying the destination Region in a\n PresignedUrl parameter, where it is required.

\n

The snapshot copy is sent to the regional endpoint that you sent the HTTP\n \trequest to (for example, ec2.us-east-1.amazonaws.com). With the CLI, this is\n specified using the --region parameter or the default Region in your Amazon Web Services\n configuration file.

", + "smithy.api#xmlName": "destinationRegion" + } + }, + "Encrypted": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Encrypted", + "smithy.api#documentation": "

To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, \n enable encryption using this parameter. Otherwise, omit this parameter. Encrypted snapshots \n are encrypted, even if you omit this parameter and encryption by default is not enabled. You \n cannot set this parameter to false. For more information, see Amazon EBS encryption in the \n Amazon EBS User Guide.

", + "smithy.api#xmlName": "encrypted" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.ec2#KmsKeyId", + "traits": { + "aws.protocols#ec2QueryName": "KmsKeyId", + "smithy.api#documentation": "

The identifier of the KMS key to use for Amazon EBS encryption.\n If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is\n specified, the encrypted state must be true.

\n

You can specify the KMS key using any of the following:

\n \n

Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, \n the action can appear to complete, but eventually fails.

", + "smithy.api#xmlName": "kmsKeyId" + } + }, + "PresignedUrl": { + "target": "com.amazonaws.ec2#CopySnapshotRequestPSU", + "traits": { + "aws.protocols#ec2QueryName": "PresignedUrl", + "smithy.api#documentation": "

When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a\n pre-signed URL. This parameter is optional for unencrypted snapshots. For more information,\n see Query\n requests.

\n

The PresignedUrl should use the snapshot source endpoint, the\n CopySnapshot action, and include the SourceRegion,\n SourceSnapshotId, and DestinationRegion parameters. The\n PresignedUrl must be signed using Amazon Web Services Signature Version 4. Because EBS\n snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic\n that is described in \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) in the Amazon S3 API Reference. An\n invalid or improperly signed PresignedUrl will cause the copy operation to fail\n asynchronously, and the snapshot will move to an error state.

", + "smithy.api#xmlName": "presignedUrl" + } + }, + "SourceRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Region that contains the snapshot to be copied.

", + "smithy.api#required": {} + } + }, + "SourceSnapshotId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the EBS snapshot to copy.

", + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the new snapshot.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "CompletionDurationMinutes": { + "target": "com.amazonaws.ec2#SnapshotCompletionDurationMinutesRequest", + "traits": { + "smithy.api#documentation": "

Specify a completion duration, in 15 minute increments, to initiate a time-based snapshot \n copy. Time-based snapshot copy operations complete within the specified duration. For more \n information, see \n Time-based copies.

\n

If you do not specify a value, the snapshot copy operation is completed on a \n best-effort basis.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CopySnapshotRequestPSU": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.ec2#CopySnapshotResult": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags applied to the new snapshot.

", + "smithy.api#xmlName": "tagSet" + } + }, + "SnapshotId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The ID of the new snapshot.

", + "smithy.api#xmlName": "snapshotId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CopyTagsFromSource": { + "type": "enum", + "members": { + "volume": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "volume" + } + } + } + }, + "com.amazonaws.ec2#CoreCount": { + "type": "integer" + }, + "com.amazonaws.ec2#CoreCountList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CoreCount", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#CoreNetworkArn": { + "type": "string" + }, + "com.amazonaws.ec2#CpuManufacturer": { + "type": "enum", + "members": { + "INTEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "intel" + } + }, + "AMD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "amd" + } + }, + "AMAZON_WEB_SERVICES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "amazon-web-services" + } + }, + "APPLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "apple" + } + } + } + }, + "com.amazonaws.ec2#CpuManufacturerName": { + "type": "string" + }, + "com.amazonaws.ec2#CpuManufacturerSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CpuManufacturer", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#CpuOptions": { + "type": "structure", + "members": { + "CoreCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "CoreCount", + "smithy.api#documentation": "

The number of CPU cores for the instance.

", + "smithy.api#xmlName": "coreCount" + } + }, + "ThreadsPerCore": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "ThreadsPerCore", + "smithy.api#documentation": "

The number of threads per CPU core.

", + "smithy.api#xmlName": "threadsPerCore" + } + }, + "AmdSevSnp": { + "target": "com.amazonaws.ec2#AmdSevSnpSpecification", + "traits": { + "aws.protocols#ec2QueryName": "AmdSevSnp", + "smithy.api#documentation": "

Indicates whether the instance is enabled for AMD SEV-SNP. For more information, see \n AMD SEV-SNP.

", + "smithy.api#xmlName": "amdSevSnp" + } + } + }, + "traits": { + "smithy.api#documentation": "

The CPU options for the instance.

" + } + }, + "com.amazonaws.ec2#CpuOptionsRequest": { + "type": "structure", + "members": { + "CoreCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The number of CPU cores for the instance.

" + } + }, + "ThreadsPerCore": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The number of threads per CPU core. To disable multithreading for the instance,\n specify a value of 1. Otherwise, specify the default value of\n 2.

" + } + }, + "AmdSevSnp": { + "target": "com.amazonaws.ec2#AmdSevSnpSpecification", + "traits": { + "smithy.api#documentation": "

Indicates whether to enable the instance for AMD SEV-SNP. AMD SEV-SNP is supported \n with M6a, R6a, and C6a instance types only. For more information, see \n AMD SEV-SNP.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The CPU options for the instance. Both the core count and threads per core must be\n specified in the request.

" + } + }, + "com.amazonaws.ec2#CpuPerformanceFactor": { + "type": "structure", + "members": { + "References": { + "target": "com.amazonaws.ec2#PerformanceFactorReferenceSet", + "traits": { + "aws.protocols#ec2QueryName": "ReferenceSet", + "smithy.api#documentation": "

Specify an instance family to use as the baseline reference for CPU performance. All\n instance types that match your specified attributes will be compared against the CPU\n performance of the referenced instance family, regardless of CPU manufacturer or\n architecture differences.

\n \n

Currently, only one instance family can be specified in the list.

\n ", + "smithy.api#xmlName": "referenceSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

The CPU performance to consider, using an instance family as the baseline reference.

" + } + }, + "com.amazonaws.ec2#CpuPerformanceFactorRequest": { + "type": "structure", + "members": { + "References": { + "target": "com.amazonaws.ec2#PerformanceFactorReferenceSetRequest", + "traits": { + "smithy.api#documentation": "

Specify an instance family to use as the baseline reference for CPU performance. All\n instance types that match your specified attributes will be compared against the CPU\n performance of the referenced instance family, regardless of CPU manufacturer or\n architecture differences.

\n \n

Currently, only one instance family can be specified in the list.

\n ", + "smithy.api#xmlName": "Reference" + } + } + }, + "traits": { + "smithy.api#documentation": "

The CPU performance to consider, using an instance family as the baseline reference.

" + } + }, + "com.amazonaws.ec2#CreateCapacityReservation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateCapacityReservationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateCapacityReservationResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a new Capacity Reservation with the specified attributes. Capacity Reservations enable \n\t\t\tyou to reserve capacity for your Amazon EC2 instances in a specific Availability Zone for any \n\t\t\tduration.

\n

You can create a Capacity Reservation at any time, and you can choose when it starts. You can create a \n\t\t\tCapacity Reservation for immediate use or you can request a Capacity Reservation for a future date.

\n

For more information, see \n\t\t\tReserve compute capacity with On-Demand Capacity Reservations in the Amazon EC2 User Guide.

\n

Your request to create a Capacity Reservation could fail if:

\n " + } + }, + "com.amazonaws.ec2#CreateCapacityReservationBySplitting": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateCapacityReservationBySplittingRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateCapacityReservationBySplittingResult" + }, + "traits": { + "smithy.api#documentation": "

Create a new Capacity Reservation by splitting the capacity of the source Capacity\n\t\t\tReservation. The new Capacity Reservation will have the same attributes as the source\n\t\t\tCapacity Reservation except for tags. The source Capacity Reservation must be\n\t\t\t\tactive and owned by your Amazon Web Services account.

" + } + }, + "com.amazonaws.ec2#CreateCapacityReservationBySplittingRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "SourceCapacityReservationId": { + "target": "com.amazonaws.ec2#CapacityReservationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Capacity Reservation from which you want to split the capacity.

", + "smithy.api#required": {} + } + }, + "InstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of instances to split from the source Capacity Reservation.

", + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the new Capacity Reservation.

", + "smithy.api#xmlName": "TagSpecification" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateCapacityReservationBySplittingResult": { + "type": "structure", + "members": { + "SourceCapacityReservation": { + "target": "com.amazonaws.ec2#CapacityReservation", + "traits": { + "aws.protocols#ec2QueryName": "SourceCapacityReservation", + "smithy.api#documentation": "

Information about the source Capacity Reservation.

", + "smithy.api#xmlName": "sourceCapacityReservation" + } + }, + "DestinationCapacityReservation": { + "target": "com.amazonaws.ec2#CapacityReservation", + "traits": { + "aws.protocols#ec2QueryName": "DestinationCapacityReservation", + "smithy.api#documentation": "

Information about the destination Capacity Reservation.

", + "smithy.api#xmlName": "destinationCapacityReservation" + } + }, + "InstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "InstanceCount", + "smithy.api#documentation": "

The number of instances in the new Capacity Reservation. The number of instances in\n\t\t\tthe source Capacity Reservation was reduced by this amount.

", + "smithy.api#xmlName": "instanceCount" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateCapacityReservationFleet": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateCapacityReservationFleetRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateCapacityReservationFleetResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a Capacity Reservation Fleet. For more information, see Create a\n\t\t\t\tCapacity Reservation Fleet in the\n\t\t\tAmazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#CreateCapacityReservationFleetRequest": { + "type": "structure", + "members": { + "AllocationStrategy": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The strategy used by the Capacity Reservation Fleet to determine which of the\n\t\t\tspecified instance types to use. Currently, only the prioritized allocation\n\t\t\tstrategy is supported. For more information, see Allocation\n\t\t\t\tstrategy in the Amazon EC2 User Guide.

\n

Valid values: prioritized\n

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "InstanceTypeSpecifications": { + "target": "com.amazonaws.ec2#ReservationFleetInstanceSpecificationList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Information about the instance types for which to reserve the capacity.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "InstanceTypeSpecification" + } + }, + "Tenancy": { + "target": "com.amazonaws.ec2#FleetCapacityReservationTenancy", + "traits": { + "smithy.api#documentation": "

Indicates the tenancy of the Capacity Reservation Fleet. All Capacity Reservations in\n\t\t\tthe Fleet inherit this tenancy. The Capacity Reservation Fleet can have one of the\n\t\t\tfollowing tenancy settings:

\n " + } + }, + "TotalTargetCapacity": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The total number of capacity units to be reserved by the Capacity Reservation Fleet.\n\t\t\tThis value, together with the instance type weights that you assign to each instance\n\t\t\ttype used by the Fleet determine the number of instances for which the Fleet reserves\n\t\t\tcapacity. Both values are based on units that make sense for your workload. For more\n\t\t\tinformation, see Total target\n\t\t\t\tcapacity in the Amazon EC2 User Guide.

", + "smithy.api#required": {} + } + }, + "EndDate": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "smithy.api#documentation": "

The date and time at which the Capacity Reservation Fleet expires. When the Capacity\n\t\t\tReservation Fleet expires, its state changes to expired and all of the\n\t\t\tCapacity Reservations in the Fleet expire.

\n

The Capacity Reservation Fleet expires within an hour after the specified time. For\n\t\t\texample, if you specify 5/31/2019, 13:30:55, the Capacity\n\t\t\tReservation Fleet is guaranteed to expire between 13:30:55 and\n\t\t\t\t14:30:55 on 5/31/2019.

" + } + }, + "InstanceMatchCriteria": { + "target": "com.amazonaws.ec2#FleetInstanceMatchCriteria", + "traits": { + "smithy.api#documentation": "

Indicates the type of instance launches that the Capacity Reservation Fleet accepts.\n\t\t\tAll Capacity Reservations in the Fleet inherit this instance matching criteria.

\n

Currently, Capacity Reservation Fleets support open instance matching\n\t\t\tcriteria only. This means that instances that have matching attributes (instance type,\n\t\t\tplatform, and Availability Zone) run in the Capacity Reservations automatically.\n\t\t\tInstances do not need to explicitly target a Capacity Reservation Fleet to use its\n\t\t\treserved capacity.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to the Capacity Reservation Fleet. The tags are automatically\n\t\t\tassigned to the Capacity Reservations in the Fleet.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateCapacityReservationFleetResult": { + "type": "structure", + "members": { + "CapacityReservationFleetId": { + "target": "com.amazonaws.ec2#CapacityReservationFleetId", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationFleetId", + "smithy.api#documentation": "

The ID of the Capacity Reservation Fleet.

", + "smithy.api#xmlName": "capacityReservationFleetId" + } + }, + "State": { + "target": "com.amazonaws.ec2#CapacityReservationFleetState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The status of the Capacity Reservation Fleet.

", + "smithy.api#xmlName": "state" + } + }, + "TotalTargetCapacity": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TotalTargetCapacity", + "smithy.api#documentation": "

The total number of capacity units for which the Capacity Reservation Fleet reserves\n\t\t\tcapacity.

", + "smithy.api#xmlName": "totalTargetCapacity" + } + }, + "TotalFulfilledCapacity": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "TotalFulfilledCapacity", + "smithy.api#documentation": "

The requested capacity units that have been successfully reserved.

", + "smithy.api#xmlName": "totalFulfilledCapacity" + } + }, + "InstanceMatchCriteria": { + "target": "com.amazonaws.ec2#FleetInstanceMatchCriteria", + "traits": { + "aws.protocols#ec2QueryName": "InstanceMatchCriteria", + "smithy.api#documentation": "

The instance matching criteria for the Capacity Reservation Fleet.

", + "smithy.api#xmlName": "instanceMatchCriteria" + } + }, + "AllocationStrategy": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AllocationStrategy", + "smithy.api#documentation": "

The allocation strategy used by the Capacity Reservation Fleet.

", + "smithy.api#xmlName": "allocationStrategy" + } + }, + "CreateTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreateTime", + "smithy.api#documentation": "

The date and time at which the Capacity Reservation Fleet was created.

", + "smithy.api#xmlName": "createTime" + } + }, + "EndDate": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "EndDate", + "smithy.api#documentation": "

The date and time at which the Capacity Reservation Fleet expires.

", + "smithy.api#xmlName": "endDate" + } + }, + "Tenancy": { + "target": "com.amazonaws.ec2#FleetCapacityReservationTenancy", + "traits": { + "aws.protocols#ec2QueryName": "Tenancy", + "smithy.api#documentation": "

Indicates the tenancy of Capacity Reservation Fleet.

", + "smithy.api#xmlName": "tenancy" + } + }, + "FleetCapacityReservations": { + "target": "com.amazonaws.ec2#FleetCapacityReservationSet", + "traits": { + "aws.protocols#ec2QueryName": "FleetCapacityReservationSet", + "smithy.api#documentation": "

Information about the individual Capacity Reservations in the Capacity Reservation\n\t\t\tFleet.

", + "smithy.api#xmlName": "fleetCapacityReservationSet" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the Capacity Reservation Fleet.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateCapacityReservationRequest": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.

" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The instance type for which to reserve capacity.

\n \n

You can request future-dated Capacity Reservations for instance types in the C, M, R, I, \n\t\t\t\tand T instance families only.

\n \n

For more information, see Instance types in the Amazon EC2 User Guide.

", + "smithy.api#required": {} + } + }, + "InstancePlatform": { + "target": "com.amazonaws.ec2#CapacityReservationInstancePlatform", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of operating system for which to reserve capacity.

", + "smithy.api#required": {} + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#AvailabilityZoneName", + "traits": { + "smithy.api#documentation": "

The Availability Zone in which to create the Capacity Reservation.

" + } + }, + "AvailabilityZoneId": { + "target": "com.amazonaws.ec2#AvailabilityZoneId", + "traits": { + "smithy.api#documentation": "

The ID of the Availability Zone in which to create the Capacity Reservation.

" + } + }, + "Tenancy": { + "target": "com.amazonaws.ec2#CapacityReservationTenancy", + "traits": { + "smithy.api#documentation": "

Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one\n\t\t\tof the following tenancy settings:

\n " + } + }, + "InstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of instances for which to reserve capacity.

\n \n

You can request future-dated Capacity Reservations for an instance count \n\t\t\t\twith a minimum of 100 VPUs. For example, if you request a future-dated Capacity \n\t\t\t\tReservation for m5.xlarge instances, you must request at least \n\t\t\t\t25 instances (25 * m5.xlarge = 100 vCPUs).

\n \n

Valid range: 1 - 1000

", + "smithy.api#required": {} + } + }, + "EbsOptimized": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the Capacity Reservation supports EBS-optimized instances. This\n\t\t\toptimization provides dedicated throughput to Amazon EBS and an optimized configuration\n\t\t\tstack to provide optimal I/O performance. This optimization isn't available with all\n\t\t\tinstance types. Additional usage charges apply when using an EBS- optimized\n\t\t\tinstance.

" + } + }, + "EphemeralStorage": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

\n Deprecated.\n

" + } + }, + "EndDate": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "smithy.api#documentation": "

The date and time at which the Capacity Reservation expires. When a Capacity \n\t\t\tReservation expires, the reserved capacity is released and you can no longer launch \n\t\t\tinstances into it. The Capacity Reservation's state changes to expired \n\t\t\twhen it reaches its end date and time.

\n

You must provide an EndDate value if EndDateType is\n\t\t\tlimited. Omit EndDate if EndDateType is\n\t\t\tunlimited.

\n

If the EndDateType is limited, the Capacity Reservation \n\t\t\tis cancelled within an hour from the specified time. For example, if you specify \n\t\t\t5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 \n\t\t\tand 14:30:55 on 5/31/2019.

\n

If you are requesting a future-dated Capacity Reservation, you can't specify an end \n\t\t\tdate and time that is within the commitment duration.

" + } + }, + "EndDateType": { + "target": "com.amazonaws.ec2#EndDateType", + "traits": { + "smithy.api#documentation": "

Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can\n\t\t\thave one of the following end types:

\n " + } + }, + "InstanceMatchCriteria": { + "target": "com.amazonaws.ec2#InstanceMatchCriteria", + "traits": { + "smithy.api#documentation": "

Indicates the type of instance launches that the Capacity Reservation accepts. The\n\t\t\toptions include:

\n \n \n

If you are requesting a future-dated Capacity Reservation, you must specify targeted.

\n \n

Default: open\n

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the Capacity Reservation during launch.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "OutpostArn": { + "target": "com.amazonaws.ec2#OutpostArn", + "traits": { + "smithy.api#documentation": "\n

Not supported for future-dated Capacity Reservations.

\n \n

The Amazon Resource Name (ARN) of the Outpost on which to create the Capacity \n\t\t\tReservation.

" + } + }, + "PlacementGroupArn": { + "target": "com.amazonaws.ec2#PlacementGroupArn", + "traits": { + "smithy.api#documentation": "\n

Not supported for future-dated Capacity Reservations.

\n \n

The Amazon Resource Name (ARN) of the cluster placement group in which \n\t\t\tto create the Capacity Reservation. For more information, see \n\t\t\t\n\t\t\t\tCapacity Reservations for cluster placement groups in the \n\t\t\tAmazon EC2 User Guide.

" + } + }, + "StartDate": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "smithy.api#documentation": "\n

Required for future-dated Capacity Reservations only. To create a Capacity \n\t\t\tReservation for immediate use, omit this parameter.

\n \n

The date and time at which the future-dated Capacity Reservation should become \n\t\t\tavailable for use, in the ISO8601 format in the UTC time zone \n\t\t\t(YYYY-MM-DDThh:mm:ss.sssZ).

\n

You can request a future-dated Capacity Reservation between 5 and 120 days in \n\t\t\tadvance.

" + } + }, + "CommitmentDuration": { + "target": "com.amazonaws.ec2#CapacityReservationCommitmentDuration", + "traits": { + "smithy.api#documentation": "\n

Required for future-dated Capacity Reservations only. To create a Capacity \n\t\t\tReservation for immediate use, omit this parameter.

\n \n

Specify a commitment duration, in seconds, for the future-dated Capacity Reservation.

\n

The commitment duration is a minimum duration for which you commit to having the \n\t\t\tfuture-dated Capacity Reservation in the active state in your account \n\t\t\tafter it has been delivered.

\n

For more information, see \n\t\t\tCommitment duration.

" + } + }, + "DeliveryPreference": { + "target": "com.amazonaws.ec2#CapacityReservationDeliveryPreference", + "traits": { + "smithy.api#documentation": "\n

Required for future-dated Capacity Reservations only. To create a Capacity \n\t\t\tReservation for immediate use, omit this parameter.

\n \n

Indicates that the requested capacity will be delivered in addition to any \n\t\t\trunning instances or reserved capacity that you have in your account at the \n\t\t\trequested date and time.

\n

The only supported value is incremental.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateCapacityReservationResult": { + "type": "structure", + "members": { + "CapacityReservation": { + "target": "com.amazonaws.ec2#CapacityReservation", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservation", + "smithy.api#documentation": "

Information about the Capacity Reservation.

", + "smithy.api#xmlName": "capacityReservation" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateCarrierGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateCarrierGatewayRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateCarrierGatewayResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a carrier gateway. For more information about carrier gateways, see Carrier gateways in the Amazon Web Services Wavelength Developer Guide.

" + } + }, + "com.amazonaws.ec2#CreateCarrierGatewayRequest": { + "type": "structure", + "members": { + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC to associate with the carrier gateway.

", + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to associate with the carrier gateway.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateCarrierGatewayResult": { + "type": "structure", + "members": { + "CarrierGateway": { + "target": "com.amazonaws.ec2#CarrierGateway", + "traits": { + "aws.protocols#ec2QueryName": "CarrierGateway", + "smithy.api#documentation": "

Information about the carrier gateway.

", + "smithy.api#xmlName": "carrierGateway" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateClientVpnEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateClientVpnEndpointRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateClientVpnEndpointResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a Client VPN endpoint. A Client VPN endpoint is the resource you create and configure to \n\t\t\tenable and manage client VPN sessions. It is the destination endpoint at which all client VPN sessions \n\t\t\tare terminated.

" + } + }, + "com.amazonaws.ec2#CreateClientVpnEndpointRequest": { + "type": "structure", + "members": { + "ClientCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. Client CIDR range must have a size of at least /22 and must not be greater than /12.

", + "smithy.api#required": {} + } + }, + "ServerCertificateArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the server certificate. For more information, see \n\t\t\tthe Certificate Manager User Guide.

", + "smithy.api#required": {} + } + }, + "AuthenticationOptions": { + "target": "com.amazonaws.ec2#ClientVpnAuthenticationRequestList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Information about the authentication method to be used to authenticate clients.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "Authentication" + } + }, + "ConnectionLogOptions": { + "target": "com.amazonaws.ec2#ConnectionLogOptions", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Information about the client connection logging options.

\n

If you enable client connection logging, data about client connections is sent to a\n\t\t\tCloudwatch Logs log stream. The following information is logged:

\n ", + "smithy.api#required": {} + } + }, + "DnsServers": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can\n\t\t\thave up to two DNS servers. If no DNS server is specified, the DNS address configured on the device is used for the DNS server.

" + } + }, + "TransportProtocol": { + "target": "com.amazonaws.ec2#TransportProtocol", + "traits": { + "smithy.api#documentation": "

The transport protocol to be used by the VPN session.

\n

Default value: udp\n

" + } + }, + "VpnPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The port number to assign to the Client VPN endpoint for TCP and UDP traffic.

\n

Valid Values: 443 | 1194\n

\n

Default Value: 443\n

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A brief description of the Client VPN endpoint.

" + } + }, + "SplitTunnel": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether split-tunnel is enabled on the Client VPN endpoint.

\n

By default, split-tunnel on a VPN endpoint is disabled.

\n

For information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the \n\t\t\tClient VPN Administrator Guide.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. \nFor more information, see Ensuring idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the Client VPN endpoint during creation.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.ec2#ClientVpnSecurityGroupIdSet", + "traits": { + "smithy.api#documentation": "

The IDs of one or more security groups to apply to the target network. You must also specify the ID of the VPC that contains the security groups.

", + "smithy.api#xmlName": "SecurityGroupId" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#documentation": "

The ID of the VPC to associate with the Client VPN endpoint. If no security group IDs are specified in the request, the default security group for the VPC is applied.

" + } + }, + "SelfServicePortal": { + "target": "com.amazonaws.ec2#SelfServicePortal", + "traits": { + "smithy.api#documentation": "

Specify whether to enable the self-service portal for the Client VPN endpoint.

\n

Default Value: enabled\n

" + } + }, + "ClientConnectOptions": { + "target": "com.amazonaws.ec2#ClientConnectOptions", + "traits": { + "smithy.api#documentation": "

The options for managing connection authorization for new client connections.

" + } + }, + "SessionTimeoutHours": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum VPN session duration time in hours.

\n

Valid values: 8 | 10 | 12 | 24\n

\n

Default value: 24\n

" + } + }, + "ClientLoginBannerOptions": { + "target": "com.amazonaws.ec2#ClientLoginBannerOptions", + "traits": { + "smithy.api#documentation": "

Options for enabling a customizable text banner that will be displayed on\n\t\t\tAmazon Web Services provided clients when a VPN session is established.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateClientVpnEndpointResult": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientVpnEndpointId", + "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", + "smithy.api#xmlName": "clientVpnEndpointId" + } + }, + "Status": { + "target": "com.amazonaws.ec2#ClientVpnEndpointStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The current state of the Client VPN endpoint.

", + "smithy.api#xmlName": "status" + } + }, + "DnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DnsName", + "smithy.api#documentation": "

The DNS name to be used by clients when establishing their VPN session.

", + "smithy.api#xmlName": "dnsName" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateClientVpnRoute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateClientVpnRouteRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateClientVpnRouteResult" + }, + "traits": { + "smithy.api#documentation": "

Adds a route to a network to a Client VPN endpoint. Each Client VPN endpoint has a route table that describes the \n\t\t\tavailable destination network routes. Each route in the route table specifies the path for traffic to specific resources or networks.

" + } + }, + "com.amazonaws.ec2#CreateClientVpnRouteRequest": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#ClientVpnEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Client VPN endpoint to which to add the route.

", + "smithy.api#required": {} + } + }, + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IPv4 address range, in CIDR notation, of the route destination. For example:

\n ", + "smithy.api#required": {} + } + }, + "TargetVpcSubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the subnet through which you want to route traffic. The specified subnet must be\n\t\t\tan existing target network of the Client VPN endpoint.

\n

Alternatively, if you're adding a route for the local network, specify local.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A brief description of the route.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. \nFor more information, see Ensuring idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateClientVpnRouteResult": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.ec2#ClientVpnRouteStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The current state of the route.

", + "smithy.api#xmlName": "status" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateCoipCidr": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateCoipCidrRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateCoipCidrResult" + }, + "traits": { + "smithy.api#documentation": "

\n Creates a range of customer-owned IP addresses.\n

" + } + }, + "com.amazonaws.ec2#CreateCoipCidrRequest": { + "type": "structure", + "members": { + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

\n A customer-owned IP address range to create.\n

", + "smithy.api#required": {} + } + }, + "CoipPoolId": { + "target": "com.amazonaws.ec2#Ipv4PoolCoipId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

\n The ID of the address pool.\n

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateCoipCidrResult": { + "type": "structure", + "members": { + "CoipCidr": { + "target": "com.amazonaws.ec2#CoipCidr", + "traits": { + "aws.protocols#ec2QueryName": "CoipCidr", + "smithy.api#documentation": "

\n Information about a range of customer-owned IP addresses.\n

", + "smithy.api#xmlName": "coipCidr" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateCoipPool": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateCoipPoolRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateCoipPoolResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a pool of customer-owned IP (CoIP) addresses.

" + } + }, + "com.amazonaws.ec2#CreateCoipPoolRequest": { + "type": "structure", + "members": { + "LocalGatewayRouteTableId": { + "target": "com.amazonaws.ec2#LocalGatewayRoutetableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

\n The ID of the local gateway route table.\n

", + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

\n The tags to assign to the CoIP address pool.\n

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateCoipPoolResult": { + "type": "structure", + "members": { + "CoipPool": { + "target": "com.amazonaws.ec2#CoipPool", + "traits": { + "aws.protocols#ec2QueryName": "CoipPool", + "smithy.api#documentation": "

Information about the CoIP address pool.

", + "smithy.api#xmlName": "coipPool" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateCustomerGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateCustomerGatewayRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateCustomerGatewayResult" + }, + "traits": { + "smithy.api#documentation": "

Provides information to Amazon Web Services about your customer gateway device. The\n customer gateway device is the appliance at your end of the VPN connection. You\n must provide the IP address of the customer gateway device’s external\n interface. The IP address must be static and can be behind a device performing network\n address translation (NAT).

\n

For devices that use Border Gateway Protocol (BGP), you can also provide the device's\n BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network.\n If you don't have an ASN already, you can use a private ASN. For more information, see \n Customer gateway \n options for your Site-to-Site VPN connection in the Amazon Web Services Site-to-Site VPN User Guide.

\n

To create more than one customer gateway with the same VPN type, IP address, and\n BGP ASN, specify a unique device name for each customer gateway. An identical request\n returns information about the existing customer gateway; it doesn't create a new customer\n gateway.

", + "smithy.api#examples": [ + { + "title": "To create a customer gateway", + "documentation": "This example creates a customer gateway with the specified IP address for its outside interface.", + "input": { + "Type": "ipsec.1", + "PublicIp": "12.1.2.3", + "BgpAsn": 65534 + }, + "output": { + "CustomerGateway": { + "CustomerGatewayId": "cgw-0e11f167", + "IpAddress": "12.1.2.3", + "State": "available", + "Type": "ipsec.1", + "BgpAsn": "65534" + } + } + } + ] + } + }, + "com.amazonaws.ec2#CreateCustomerGatewayRequest": { + "type": "structure", + "members": { + "BgpAsn": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

For customer gateway devices that support BGP, specify the device's ASN. You must specify either BgpAsn or BgpAsnExtended when creating the customer gateway. If the ASN is larger than 2,147,483,647, you must use BgpAsnExtended.

\n

Default: 65000

\n

Valid values: 1 to 2,147,483,647\n

" + } + }, + "PublicIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

\n This member has been deprecated. The Internet-routable IP address for the customer gateway's outside interface. The\n address must be static.

" + } + }, + "CertificateArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the customer gateway certificate.

" + } + }, + "Type": { + "target": "com.amazonaws.ec2#GatewayType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of VPN connection that this customer gateway supports\n (ipsec.1).

", + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the customer gateway.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DeviceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A name for the customer gateway device.

\n

Length Constraints: Up to 255 characters.

" + } + }, + "IpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

IPv4 address for the customer gateway device's outside interface. The address must be\n static. If OutsideIpAddressType in your VPN connection options is set to\n PrivateIpv4, you can use an RFC6598 or RFC1918 private IPv4 address. If\n OutsideIpAddressType is set to PublicIpv4, you can use a\n public IPv4 address.

" + } + }, + "BgpAsnExtended": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "smithy.api#documentation": "

For customer gateway devices that support BGP, specify the device's ASN. You must specify either BgpAsn or BgpAsnExtended when creating the customer gateway. If the ASN is larger than 2,147,483,647, you must use BgpAsnExtended.

\n

Valid values: 2,147,483,648 to 4,294,967,295\n

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for CreateCustomerGateway.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateCustomerGatewayResult": { + "type": "structure", + "members": { + "CustomerGateway": { + "target": "com.amazonaws.ec2#CustomerGateway", + "traits": { + "aws.protocols#ec2QueryName": "CustomerGateway", + "smithy.api#documentation": "

Information about the customer gateway.

", + "smithy.api#xmlName": "customerGateway" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of CreateCustomerGateway.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateDefaultSubnet": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateDefaultSubnetRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateDefaultSubnetResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a default subnet with a size /20 IPv4 CIDR block in the\n specified Availability Zone in your default VPC. You can have only one default subnet\n per Availability Zone. For more information, see Create a default\n subnet in the Amazon VPC User Guide.

" + } + }, + "com.amazonaws.ec2#CreateDefaultSubnetRequest": { + "type": "structure", + "members": { + "AvailabilityZone": { + "target": "com.amazonaws.ec2#AvailabilityZoneName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Availability Zone in which to create the default subnet.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Ipv6Native": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether to create an IPv6 only subnet. If you already have a default subnet\n for this Availability Zone, you must delete it before you can create an IPv6 only subnet.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateDefaultSubnetResult": { + "type": "structure", + "members": { + "Subnet": { + "target": "com.amazonaws.ec2#Subnet", + "traits": { + "aws.protocols#ec2QueryName": "Subnet", + "smithy.api#documentation": "

Information about the subnet.

", + "smithy.api#xmlName": "subnet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateDefaultVpc": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateDefaultVpcRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateDefaultVpcResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a default VPC with a size /16 IPv4 CIDR block and a default subnet\n\t\t\tin each Availability Zone. For more information about the components of a default VPC,\n\t\t\tsee Default VPCs \n\t\t in the Amazon VPC User Guide. You cannot specify the components of the \n\t\t default VPC yourself.

\n

If you deleted your previous default VPC, you can create a default VPC. You cannot have\n\t\t\tmore than one default VPC per Region.

" + } + }, + "com.amazonaws.ec2#CreateDefaultVpcRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateDefaultVpcResult": { + "type": "structure", + "members": { + "Vpc": { + "target": "com.amazonaws.ec2#Vpc", + "traits": { + "aws.protocols#ec2QueryName": "Vpc", + "smithy.api#documentation": "

Information about the VPC.

", + "smithy.api#xmlName": "vpc" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateDhcpOptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateDhcpOptionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateDhcpOptionsResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a custom set of DHCP options. After you create a DHCP option set, you associate\n\t it with a VPC. After you associate a DHCP option set with a VPC, all existing and newly \n\t launched instances in the VPC use this set of DHCP options.

\n

The following are the individual DHCP options you can specify. For more information, see \n DHCP option sets \n in the Amazon VPC User Guide.

\n ", + "smithy.api#examples": [ + { + "title": "To create a DHCP options set", + "documentation": "This example creates a DHCP options set.", + "input": { + "DhcpConfigurations": [ + { + "Key": "domain-name-servers", + "Values": [ + "10.2.5.1", + "10.2.5.2" + ] + } + ] + }, + "output": { + "DhcpOptions": { + "DhcpConfigurations": [ + { + "Values": [ + { + "Value": "10.2.5.2" + }, + { + "Value": "10.2.5.1" + } + ], + "Key": "domain-name-servers" + } + ], + "DhcpOptionsId": "dopt-d9070ebb" + } + } + } + ] + } + }, + "com.amazonaws.ec2#CreateDhcpOptionsRequest": { + "type": "structure", + "members": { + "DhcpConfigurations": { + "target": "com.amazonaws.ec2#NewDhcpConfigurationList", + "traits": { + "aws.protocols#ec2QueryName": "DhcpConfiguration", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A DHCP configuration option.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "dhcpConfiguration" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to the DHCP option.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateDhcpOptionsResult": { + "type": "structure", + "members": { + "DhcpOptions": { + "target": "com.amazonaws.ec2#DhcpOptions", + "traits": { + "aws.protocols#ec2QueryName": "DhcpOptions", + "smithy.api#documentation": "

A set of DHCP options.

", + "smithy.api#xmlName": "dhcpOptions" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateEgressOnlyInternetGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateEgressOnlyInternetGatewayRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateEgressOnlyInternetGatewayResult" + }, + "traits": { + "smithy.api#documentation": "

[IPv6 only] Creates an egress-only internet gateway for your VPC. An egress-only\n\t\t\tinternet gateway is used to enable outbound communication over IPv6 from instances in\n\t\t\tyour VPC to the internet, and prevents hosts outside of your VPC from initiating an IPv6\n\t\t\tconnection with your instance.

" + } + }, + "com.amazonaws.ec2#CreateEgressOnlyInternetGatewayRequest": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n\t\t\trequest. For more information, see Ensuring idempotency.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC for which to create the egress-only internet gateway.

", + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to the egress-only internet gateway.

", + "smithy.api#xmlName": "TagSpecification" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateEgressOnlyInternetGatewayResult": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n\t\t\trequest.

", + "smithy.api#xmlName": "clientToken" + } + }, + "EgressOnlyInternetGateway": { + "target": "com.amazonaws.ec2#EgressOnlyInternetGateway", + "traits": { + "aws.protocols#ec2QueryName": "EgressOnlyInternetGateway", + "smithy.api#documentation": "

Information about the egress-only internet gateway.

", + "smithy.api#xmlName": "egressOnlyInternetGateway" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateFleet": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateFleetRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateFleetResult" + }, + "traits": { + "smithy.api#documentation": "

Creates an EC2 Fleet that contains the configuration information for On-Demand Instances and Spot Instances.\n Instances are launched immediately if there is available capacity.

\n

A single EC2 Fleet can include multiple launch specifications that vary by instance type,\n AMI, Availability Zone, or subnet.

\n

For more information, see EC2 Fleet in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#CreateFleetError": { + "type": "structure", + "members": { + "LaunchTemplateAndOverrides": { + "target": "com.amazonaws.ec2#LaunchTemplateAndOverridesResponse", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateAndOverrides", + "smithy.api#documentation": "

The launch templates and overrides that were used for launching the instances. The\n values that you specify in the Overrides replace the values in the launch template.

", + "smithy.api#xmlName": "launchTemplateAndOverrides" + } + }, + "Lifecycle": { + "target": "com.amazonaws.ec2#InstanceLifecycle", + "traits": { + "aws.protocols#ec2QueryName": "Lifecycle", + "smithy.api#documentation": "

Indicates if the instance that could not be launched was a Spot Instance or On-Demand Instance.

", + "smithy.api#xmlName": "lifecycle" + } + }, + "ErrorCode": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ErrorCode", + "smithy.api#documentation": "

The error code that indicates why the instance could not be launched. For more\n information about error codes, see Error codes.

", + "smithy.api#xmlName": "errorCode" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ErrorMessage", + "smithy.api#documentation": "

The error message that describes why the instance could not be launched. For more\n information about error messages, see Error codes.

", + "smithy.api#xmlName": "errorMessage" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the instances that could not be launched by the fleet.

" + } + }, + "com.amazonaws.ec2#CreateFleetErrorsSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CreateFleetError", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#CreateFleetInstance": { + "type": "structure", + "members": { + "LaunchTemplateAndOverrides": { + "target": "com.amazonaws.ec2#LaunchTemplateAndOverridesResponse", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateAndOverrides", + "smithy.api#documentation": "

The launch templates and overrides that were used for launching the instances. The\n values that you specify in the Overrides replace the values in the launch template.

", + "smithy.api#xmlName": "launchTemplateAndOverrides" + } + }, + "Lifecycle": { + "target": "com.amazonaws.ec2#InstanceLifecycle", + "traits": { + "aws.protocols#ec2QueryName": "Lifecycle", + "smithy.api#documentation": "

Indicates if the instance that was launched is a Spot Instance or On-Demand Instance.

", + "smithy.api#xmlName": "lifecycle" + } + }, + "InstanceIds": { + "target": "com.amazonaws.ec2#InstanceIdsSet", + "traits": { + "aws.protocols#ec2QueryName": "InstanceIds", + "smithy.api#documentation": "

The IDs of the instances.

", + "smithy.api#xmlName": "instanceIds" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type.

", + "smithy.api#xmlName": "instanceType" + } + }, + "Platform": { + "target": "com.amazonaws.ec2#PlatformValues", + "traits": { + "aws.protocols#ec2QueryName": "Platform", + "smithy.api#documentation": "

The value is windows for Windows instances in an EC2 Fleet. Otherwise, the value is\n blank.

", + "smithy.api#xmlName": "platform" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the instances that were launched by the fleet.

" + } + }, + "com.amazonaws.ec2#CreateFleetInstancesSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CreateFleetInstance", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#CreateFleetRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n idempotency.

" + } + }, + "SpotOptions": { + "target": "com.amazonaws.ec2#SpotOptionsRequest", + "traits": { + "smithy.api#documentation": "

Describes the configuration of Spot Instances in an EC2 Fleet.

" + } + }, + "OnDemandOptions": { + "target": "com.amazonaws.ec2#OnDemandOptionsRequest", + "traits": { + "smithy.api#documentation": "

Describes the configuration of On-Demand Instances in an EC2 Fleet.

" + } + }, + "ExcessCapacityTerminationPolicy": { + "target": "com.amazonaws.ec2#FleetExcessCapacityTerminationPolicy", + "traits": { + "smithy.api#documentation": "

Indicates whether running instances should be terminated if the total target capacity of\n the EC2 Fleet is decreased below the current size of the EC2 Fleet.

\n

Supported only for fleets of type maintain.

" + } + }, + "LaunchTemplateConfigs": { + "target": "com.amazonaws.ec2#FleetLaunchTemplateConfigListRequest", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The configuration for the EC2 Fleet.

", + "smithy.api#required": {} + } + }, + "TargetCapacitySpecification": { + "target": "com.amazonaws.ec2#TargetCapacitySpecificationRequest", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of units to request.

", + "smithy.api#required": {} + } + }, + "TerminateInstancesWithExpiration": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether running instances should be terminated when the EC2 Fleet expires.

" + } + }, + "Type": { + "target": "com.amazonaws.ec2#FleetType", + "traits": { + "smithy.api#documentation": "

The fleet type. The default value is maintain.

\n \n

For more information, see EC2 Fleet\n request types in the Amazon EC2 User Guide.

" + } + }, + "ValidFrom": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "smithy.api#documentation": "

The start date and time of the request, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).\n The default is to start fulfilling the request immediately.

" + } + }, + "ValidUntil": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "smithy.api#documentation": "

The end date and time of the request, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).\n At this point, no new EC2 Fleet requests are placed or able to fulfill the request. If no value is specified, the request remains until you cancel it.

" + } + }, + "ReplaceUnhealthyInstances": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported only for\n fleets of type maintain. For more information, see EC2 Fleet\n health checks in the Amazon EC2 User Guide.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The key-value pair for tagging the EC2 Fleet request on creation. For more information, see \n Tag your resources.

\n

If the fleet type is instant, specify a resource type of fleet \n to tag the fleet or instance to tag the instances at launch.

\n

If the fleet type is maintain or request, specify a resource\n type of fleet to tag the fleet. You cannot specify a resource type of\n instance. To tag instances at launch, specify the tags in a launch template.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "Context": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Reserved.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateFleetResult": { + "type": "structure", + "members": { + "FleetId": { + "target": "com.amazonaws.ec2#FleetId", + "traits": { + "aws.protocols#ec2QueryName": "FleetId", + "smithy.api#documentation": "

The ID of the EC2 Fleet.

", + "smithy.api#xmlName": "fleetId" + } + }, + "Errors": { + "target": "com.amazonaws.ec2#CreateFleetErrorsSet", + "traits": { + "aws.protocols#ec2QueryName": "ErrorSet", + "smithy.api#documentation": "

Information about the instances that could not be launched by the fleet. Supported only for\n fleets of type instant.

", + "smithy.api#xmlName": "errorSet" + } + }, + "Instances": { + "target": "com.amazonaws.ec2#CreateFleetInstancesSet", + "traits": { + "aws.protocols#ec2QueryName": "FleetInstanceSet", + "smithy.api#documentation": "

Information about the instances that were launched by the fleet. Supported only for\n fleets of type instant.

", + "smithy.api#xmlName": "fleetInstanceSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateFlowLogs": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateFlowLogsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateFlowLogsResult" + }, + "traits": { + "smithy.api#documentation": "

Creates one or more flow logs to capture information about IP traffic for a specific network interface,\n subnet, or VPC.

\n

Flow log data for a monitored network interface is recorded as flow log records, which are log events \n consisting of fields that describe the traffic flow. For more information, see \n Flow log records \n in the Amazon VPC User Guide.

\n

When publishing to CloudWatch Logs, flow log records are published to a log group, and each network \n interface has a unique log stream in the log group. When publishing to Amazon S3, flow log records for all \n of the monitored network interfaces are published to a single log file object that is stored in the specified \n bucket.

\n

For more information, see VPC Flow Logs \n in the Amazon VPC User Guide.

" + } + }, + "com.amazonaws.ec2#CreateFlowLogsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.

" + } + }, + "DeliverLogsPermissionArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM role that allows Amazon EC2 to publish flow logs to the log destination.

\n

This parameter is required if the destination type is cloud-watch-logs,\n or if the destination type is kinesis-data-firehose and the delivery stream\n and the resources to monitor are in different accounts.

" + } + }, + "DeliverCrossAccountRole": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM role that allows Amazon EC2 to publish flow logs across accounts.

" + } + }, + "LogGroupName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.

\n

This parameter is valid only if the destination type is cloud-watch-logs.

" + } + }, + "ResourceIds": { + "target": "com.amazonaws.ec2#FlowLogResourceIds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the resources to monitor. For example, if the resource type is\n VPC, specify the IDs of the VPCs.

\n

Constraints: Maximum of 25 for transit gateway resource types. Maximum of 1000 for the\n other resource types.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "ResourceId" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#FlowLogsResourceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of resource to monitor.

", + "smithy.api#required": {} + } + }, + "TrafficType": { + "target": "com.amazonaws.ec2#TrafficType", + "traits": { + "smithy.api#documentation": "

The type of traffic to monitor (accepted traffic, rejected traffic, or all traffic).\n This parameter is not supported for transit gateway resource types. It is required for\n the other resource types.

" + } + }, + "LogDestinationType": { + "target": "com.amazonaws.ec2#LogDestinationType", + "traits": { + "smithy.api#documentation": "

The type of destination for the flow log data.

\n

Default: cloud-watch-logs\n

" + } + }, + "LogDestination": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The destination for the flow log data. The meaning of this parameter depends on the destination type.

\n " + } + }, + "LogFormat": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The fields to include in the flow log record. List the fields in the order in which\n they should appear. If you omit this parameter, the flow log is created using the\n default format. If you specify this parameter, you must include at least one\n field. For more information about the available fields, see Flow log records \n in the Amazon VPC User Guide or Transit Gateway Flow Log\n records in the Amazon Web Services Transit Gateway Guide.

\n

Specify the fields using the ${field-id} format, separated by spaces.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the flow logs.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "MaxAggregationInterval": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. \n The possible values are 60 seconds (1 minute) or 600 seconds (10 minutes).\n This parameter must be 60 seconds for transit gateway resource types.

\n

When a network interface is attached to a Nitro-based\n instance, the aggregation interval is always 60 seconds or less, regardless\n of the value that you specify.

\n

Default: 600

" + } + }, + "DestinationOptions": { + "target": "com.amazonaws.ec2#DestinationOptionsRequest", + "traits": { + "smithy.api#documentation": "

The destination options.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateFlowLogsResult": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", + "smithy.api#xmlName": "clientToken" + } + }, + "FlowLogIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "FlowLogIdSet", + "smithy.api#documentation": "

The IDs of the flow logs.

", + "smithy.api#xmlName": "flowLogIdSet" + } + }, + "Unsuccessful": { + "target": "com.amazonaws.ec2#UnsuccessfulItemSet", + "traits": { + "aws.protocols#ec2QueryName": "Unsuccessful", + "smithy.api#documentation": "

Information about the flow logs that could not be created successfully.

", + "smithy.api#xmlName": "unsuccessful" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateFpgaImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateFpgaImageRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateFpgaImageResult" + }, + "traits": { + "smithy.api#documentation": "

Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP).

\n

The create operation is asynchronous. To verify that the AFI is ready for use, \n check the output logs.

\n

An AFI contains the FPGA bitstream that is ready to download to an FPGA. \n You can securely deploy an AFI on multiple FPGA-accelerated instances.\n For more information, see the Amazon Web Services FPGA Hardware Development Kit.

" + } + }, + "com.amazonaws.ec2#CreateFpgaImageRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "InputStorageLocation": { + "target": "com.amazonaws.ec2#StorageLocation", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The location of the encrypted design checkpoint in Amazon S3. The input must be a tarball.

", + "smithy.api#required": {} + } + }, + "LogsStorageLocation": { + "target": "com.amazonaws.ec2#StorageLocation", + "traits": { + "smithy.api#documentation": "

The location in Amazon S3 for the output logs.

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description for the AFI.

" + } + }, + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A name for the AFI.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. \n \tFor more information, see Ensuring Idempotency.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the FPGA image during creation.

", + "smithy.api#xmlName": "TagSpecification" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateFpgaImageResult": { + "type": "structure", + "members": { + "FpgaImageId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "FpgaImageId", + "smithy.api#documentation": "

The FPGA image identifier (AFI ID).

", + "smithy.api#xmlName": "fpgaImageId" + } + }, + "FpgaImageGlobalId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "FpgaImageGlobalId", + "smithy.api#documentation": "

The global FPGA image identifier (AGFI ID).

", + "smithy.api#xmlName": "fpgaImageGlobalId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateImageRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateImageResult" + }, + "traits": { + "smithy.api#documentation": "

Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or\n stopped.

\n

If you customized your instance with instance store volumes or Amazon EBS volumes in addition\n to the root device volume, the new AMI contains block device mapping information for those\n volumes. When you launch an instance from this new AMI, the instance automatically launches\n with those additional volumes.

\n

For more information, see Create an Amazon EBS-backed Linux\n AMI in the Amazon Elastic Compute Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#CreateImageRequest": { + "type": "structure", + "members": { + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the AMI and snapshots on creation. You can tag the AMI, the\n snapshots, or both.

\n \n

If you specify other values for ResourceType, the request fails.

\n

To tag an AMI or snapshot after it has been created, see CreateTags.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "instanceId" + } + }, + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Name", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A name for the new image.

\n

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces\n ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or\n underscores(_)

", + "smithy.api#required": {}, + "smithy.api#xmlName": "name" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description for the new image.

", + "smithy.api#xmlName": "description" + } + }, + "NoReboot": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "NoReboot", + "smithy.api#documentation": "

Indicates whether or not the instance should be automatically rebooted before creating the\n image. Specify one of the following values:

\n \n

Default: false\n

", + "smithy.api#xmlName": "noReboot" + } + }, + "BlockDeviceMappings": { + "target": "com.amazonaws.ec2#BlockDeviceMappingRequestList", + "traits": { + "aws.protocols#ec2QueryName": "BlockDeviceMapping", + "smithy.api#documentation": "

The block device mappings.

\n

When using the CreateImage action:

\n ", + "smithy.api#xmlName": "blockDeviceMapping" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateImageResult": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the new AMI.

", + "smithy.api#xmlName": "imageId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateInstanceConnectEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateInstanceConnectEndpointRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateInstanceConnectEndpointResult" + }, + "traits": { + "smithy.api#documentation": "

Creates an EC2 Instance Connect Endpoint.

\n

An EC2 Instance Connect Endpoint allows you to connect to an instance, without\n requiring the instance to have a public IPv4 address. For more information, see Connect to your instances without requiring a public IPv4 address using EC2\n Instance Connect Endpoint in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#CreateInstanceConnectEndpointRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the subnet in which to create the EC2 Instance Connect Endpoint.

", + "smithy.api#required": {} + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.ec2#SecurityGroupIdStringListRequest", + "traits": { + "smithy.api#documentation": "

One or more security groups to associate with the endpoint. If you don't specify a security group, \n the default security group for your VPC will be associated with the endpoint.

", + "smithy.api#xmlName": "SecurityGroupId" + } + }, + "PreserveClientIp": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the client IP address is preserved as the source. The following are the possible values.

\n \n

Default: false\n

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", + "smithy.api#idempotencyToken": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the EC2 Instance Connect Endpoint during creation.

", + "smithy.api#xmlName": "TagSpecification" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateInstanceConnectEndpointResult": { + "type": "structure", + "members": { + "InstanceConnectEndpoint": { + "target": "com.amazonaws.ec2#Ec2InstanceConnectEndpoint", + "traits": { + "aws.protocols#ec2QueryName": "InstanceConnectEndpoint", + "smithy.api#documentation": "

Information about the EC2 Instance Connect Endpoint.

", + "smithy.api#xmlName": "instanceConnectEndpoint" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive idempotency token provided by the client in the the request.

", + "smithy.api#xmlName": "clientToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateInstanceEventWindow": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateInstanceEventWindowRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateInstanceEventWindowResult" + }, + "traits": { + "smithy.api#documentation": "

Creates an event window in which scheduled events for the associated Amazon EC2 instances can\n run.

\n

You can define either a set of time ranges or a cron expression when creating the event\n window, but not both. All event window times are in UTC.

\n

You can create up to 200 event windows per Amazon Web Services Region.

\n

When you create the event window, targets (instance IDs, Dedicated Host IDs, or tags)\n are not yet associated with it. To ensure that the event window can be used, you must\n associate one or more targets with it by using the AssociateInstanceEventWindow API.

\n \n

Event windows are applicable only for scheduled events that stop, reboot, or\n terminate instances.

\n

Event windows are not applicable for:

\n
    \n
  • \n

    Expedited scheduled events and network maintenance events.

    \n
    • \n
  • \n

    Unscheduled maintenance such as AutoRecovery and unplanned reboots.

    \n
    • \n
\n \n

For more information, see Define event windows for scheduled\n events in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#CreateInstanceEventWindowRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the event window.

" + } + }, + "TimeRanges": { + "target": "com.amazonaws.ec2#InstanceEventWindowTimeRangeRequestSet", + "traits": { + "smithy.api#documentation": "

The time range for the event window. If you specify a time range, you can't specify a cron\n expression.

", + "smithy.api#xmlName": "TimeRange" + } + }, + "CronExpression": { + "target": "com.amazonaws.ec2#InstanceEventWindowCronExpression", + "traits": { + "smithy.api#documentation": "

The cron expression for the event window, for example, * 0-4,20-23 * * 1,5. If\n you specify a cron expression, you can't specify a time range.

\n

Constraints:

\n \n

For more information about cron expressions, see cron on the Wikipedia\n website.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the event window.

", + "smithy.api#xmlName": "TagSpecification" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateInstanceEventWindowResult": { + "type": "structure", + "members": { + "InstanceEventWindow": { + "target": "com.amazonaws.ec2#InstanceEventWindow", + "traits": { + "aws.protocols#ec2QueryName": "InstanceEventWindow", + "smithy.api#documentation": "

Information about the event window.

", + "smithy.api#xmlName": "instanceEventWindow" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateInstanceExportTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateInstanceExportTaskRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateInstanceExportTaskResult" + }, + "traits": { + "smithy.api#documentation": "

Exports a running or stopped instance to an Amazon S3 bucket.

\n

For information about the prerequisites for your Amazon S3 bucket, supported operating systems,\n image formats, and known limitations for the types of instances you can export, see Exporting an instance as a VM Using VM\n Import/Export in the VM Import/Export User Guide.

" + } + }, + "com.amazonaws.ec2#CreateInstanceExportTaskRequest": { + "type": "structure", + "members": { + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the export instance task during creation.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description for the conversion task or the resource being exported. The maximum length is 255 characters.

", + "smithy.api#xmlName": "description" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "instanceId" + } + }, + "TargetEnvironment": { + "target": "com.amazonaws.ec2#ExportEnvironment", + "traits": { + "aws.protocols#ec2QueryName": "TargetEnvironment", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The target virtualization environment.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "targetEnvironment" + } + }, + "ExportToS3Task": { + "target": "com.amazonaws.ec2#ExportToS3TaskSpecification", + "traits": { + "aws.protocols#ec2QueryName": "ExportToS3", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The format and location for an export instance task.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "exportToS3" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateInstanceExportTaskResult": { + "type": "structure", + "members": { + "ExportTask": { + "target": "com.amazonaws.ec2#ExportTask", + "traits": { + "aws.protocols#ec2QueryName": "ExportTask", + "smithy.api#documentation": "

Information about the export instance task.

", + "smithy.api#xmlName": "exportTask" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateInternetGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateInternetGatewayRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateInternetGatewayResult" + }, + "traits": { + "smithy.api#documentation": "

Creates an internet gateway for use with a VPC. After creating the internet gateway,\n\t\t\tyou attach it to a VPC using AttachInternetGateway.

\n

For more information, see Internet gateways in the \n Amazon VPC User Guide.

", + "smithy.api#examples": [ + { + "title": "To create an Internet gateway", + "documentation": "This example creates an Internet gateway.", + "output": { + "InternetGateway": { + "Tags": [], + "InternetGatewayId": "igw-c0a643a9", + "Attachments": [] + } + } + } + ] + } + }, + "com.amazonaws.ec2#CreateInternetGatewayRequest": { + "type": "structure", + "members": { + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to the internet gateway.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateInternetGatewayResult": { + "type": "structure", + "members": { + "InternetGateway": { + "target": "com.amazonaws.ec2#InternetGateway", + "traits": { + "aws.protocols#ec2QueryName": "InternetGateway", + "smithy.api#documentation": "

Information about the internet gateway.

", + "smithy.api#xmlName": "internetGateway" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateIpam": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateIpamRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateIpamResult" + }, + "traits": { + "smithy.api#documentation": "

Create an IPAM. Amazon VPC IP Address Manager (IPAM) is a VPC feature that you can use\n to automate your IP address management workflows including assigning, tracking,\n troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts\n throughout your Amazon Web Services Organization.

\n

For more information, see Create an IPAM in the Amazon VPC IPAM User Guide.\n

" + } + }, + "com.amazonaws.ec2#CreateIpamExternalResourceVerificationToken": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateIpamExternalResourceVerificationTokenRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateIpamExternalResourceVerificationTokenResult" + }, + "traits": { + "smithy.api#documentation": "

Create a verification token. A verification token is an Amazon Web Services-generated random value that you can use to prove ownership of an external resource. For example, you can use a verification token to validate that you control a public IP address range when you bring an IP address range to Amazon Web Services (BYOIP).\n

" + } + }, + "com.amazonaws.ec2#CreateIpamExternalResourceVerificationTokenRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamId": { + "target": "com.amazonaws.ec2#IpamId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the IPAM that will create the token.

", + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

Token tags.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateIpamExternalResourceVerificationTokenResult": { + "type": "structure", + "members": { + "IpamExternalResourceVerificationToken": { + "target": "com.amazonaws.ec2#IpamExternalResourceVerificationToken", + "traits": { + "aws.protocols#ec2QueryName": "IpamExternalResourceVerificationToken", + "smithy.api#documentation": "

The verification token.

", + "smithy.api#xmlName": "ipamExternalResourceVerificationToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateIpamPool": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateIpamPoolRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateIpamPoolResult" + }, + "traits": { + "smithy.api#documentation": "

Create an IP address pool for Amazon VPC IP Address Manager (IPAM). In IPAM, a pool is a collection of contiguous IP addresses CIDRs. Pools enable you to organize your IP addresses according to your routing and security needs. For example, if you have separate routing and security needs for development and production applications, you can create a pool for each.

\n

For more information, see Create a top-level pool in the Amazon VPC IPAM User Guide.\n

" + } + }, + "com.amazonaws.ec2#CreateIpamPoolRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamScopeId": { + "target": "com.amazonaws.ec2#IpamScopeId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the scope in which you would like to create the IPAM pool.

", + "smithy.api#required": {} + } + }, + "Locale": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The locale for the pool should be one of the following:

\n \n

Possible values: Any Amazon Web Services Region or supported Amazon Web Services Local Zone. Default is none and means any locale.

" + } + }, + "SourceIpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "smithy.api#documentation": "

The ID of the source IPAM pool. Use this option to create a pool within an existing pool. Note that the CIDR you provision for the pool within the source pool must be available in the source pool's CIDR range.

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description for the IPAM pool.

" + } + }, + "AddressFamily": { + "target": "com.amazonaws.ec2#AddressFamily", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IP protocol assigned to this IPAM pool. You must choose either IPv4 or IPv6 protocol for a pool.

", + "smithy.api#required": {} + } + }, + "AutoImport": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

If selected, IPAM will continuously look for resources within the CIDR range of this pool \n and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for\n these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import \n a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently \n marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM \n discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.\n

\n

A locale must be set on the pool for this feature to work.

" + } + }, + "PubliclyAdvertisable": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Determines if the pool is publicly advertisable. The request can only contain PubliclyAdvertisable if AddressFamily is ipv6 and PublicIpSource is byoip.

" + } + }, + "AllocationMinNetmaskLength": { + "target": "com.amazonaws.ec2#IpamNetmaskLength", + "traits": { + "smithy.api#documentation": "

The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be \n less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

" + } + }, + "AllocationMaxNetmaskLength": { + "target": "com.amazonaws.ec2#IpamNetmaskLength", + "traits": { + "smithy.api#documentation": "

The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be \n greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

" + } + }, + "AllocationDefaultNetmaskLength": { + "target": "com.amazonaws.ec2#IpamNetmaskLength", + "traits": { + "smithy.api#documentation": "

The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, \n new allocations will default to 10.0.0.0/16.

" + } + }, + "AllocationResourceTags": { + "target": "com.amazonaws.ec2#RequestIpamResourceTagList", + "traits": { + "smithy.api#documentation": "

Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.

", + "smithy.api#xmlName": "AllocationResourceTag" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "AwsService": { + "target": "com.amazonaws.ec2#IpamPoolAwsService", + "traits": { + "smithy.api#documentation": "

Limits which service in Amazon Web Services that the pool can be used in. \"ec2\", for example, allows users to use space for Elastic IP addresses and VPCs.

" + } + }, + "PublicIpSource": { + "target": "com.amazonaws.ec2#IpamPoolPublicIpSource", + "traits": { + "smithy.api#documentation": "

The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is byoip. For more information, see Create IPv6 pools in the Amazon VPC IPAM User Guide. \n By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool if PublicIpSource is amazon. For information on increasing the default limit, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.

" + } + }, + "SourceResource": { + "target": "com.amazonaws.ec2#IpamPoolSourceResourceRequest", + "traits": { + "smithy.api#documentation": "

The resource used to provision CIDRs to a resource planning pool.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateIpamPoolResult": { + "type": "structure", + "members": { + "IpamPool": { + "target": "com.amazonaws.ec2#IpamPool", + "traits": { + "aws.protocols#ec2QueryName": "IpamPool", + "smithy.api#documentation": "

Information about the IPAM pool created.

", + "smithy.api#xmlName": "ipamPool" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateIpamRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description for the IPAM.

" + } + }, + "OperatingRegions": { + "target": "com.amazonaws.ec2#AddIpamOperatingRegionSet", + "traits": { + "smithy.api#documentation": "

The operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

\n

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.\n

", + "smithy.api#xmlName": "OperatingRegion" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "Tier": { + "target": "com.amazonaws.ec2#IpamTier", + "traits": { + "smithy.api#documentation": "

IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.

" + } + }, + "EnablePrivateGua": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateIpamResourceDiscovery": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateIpamResourceDiscoveryRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateIpamResourceDiscoveryResult" + }, + "traits": { + "smithy.api#documentation": "

Creates an IPAM resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

" + } + }, + "com.amazonaws.ec2#CreateIpamResourceDiscoveryRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description for the IPAM resource discovery.

" + } + }, + "OperatingRegions": { + "target": "com.amazonaws.ec2#AddIpamOperatingRegionSet", + "traits": { + "smithy.api#documentation": "

Operating Regions for the IPAM resource discovery. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

", + "smithy.api#xmlName": "OperatingRegion" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

Tag specifications for the IPAM resource discovery.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A client token for the IPAM resource discovery.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateIpamResourceDiscoveryResult": { + "type": "structure", + "members": { + "IpamResourceDiscovery": { + "target": "com.amazonaws.ec2#IpamResourceDiscovery", + "traits": { + "aws.protocols#ec2QueryName": "IpamResourceDiscovery", + "smithy.api#documentation": "

An IPAM resource discovery.

", + "smithy.api#xmlName": "ipamResourceDiscovery" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateIpamResult": { + "type": "structure", + "members": { + "Ipam": { + "target": "com.amazonaws.ec2#Ipam", + "traits": { + "aws.protocols#ec2QueryName": "Ipam", + "smithy.api#documentation": "

Information about the IPAM created.

", + "smithy.api#xmlName": "ipam" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateIpamScope": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateIpamScopeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateIpamScopeResult" + }, + "traits": { + "smithy.api#documentation": "

Create an IPAM scope. In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.

\n

For more information, see Add a scope in the Amazon VPC IPAM User Guide.

" + } + }, + "com.amazonaws.ec2#CreateIpamScopeRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamId": { + "target": "com.amazonaws.ec2#IpamId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the IPAM for which you're creating this scope.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description for the scope you're creating.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateIpamScopeResult": { + "type": "structure", + "members": { + "IpamScope": { + "target": "com.amazonaws.ec2#IpamScope", + "traits": { + "aws.protocols#ec2QueryName": "IpamScope", + "smithy.api#documentation": "

Information about the created scope.

", + "smithy.api#xmlName": "ipamScope" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateKeyPair": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateKeyPairRequest" + }, + "output": { + "target": "com.amazonaws.ec2#KeyPair" + }, + "traits": { + "smithy.api#documentation": "

Creates an ED25519 or 2048-bit RSA key pair with the specified name and in the\n specified format. Amazon EC2 stores the public key and displays the private\n key for you to save to a file. The private key is returned as an unencrypted PEM encoded\n PKCS#1 private key or an unencrypted PPK formatted private key for use with PuTTY. If a\n key with the specified name already exists, Amazon EC2 returns an error.

\n

The key pair returned to you is available only in the Amazon Web Services Region in which you create it.\n If you prefer, you can create your own key pair using a third-party tool and upload it\n to any Region using ImportKeyPair.

\n

You can have up to 5,000 key pairs per Amazon Web Services Region.

\n

For more information, see Amazon EC2 key pairs in the\n Amazon EC2 User Guide.

", + "smithy.api#examples": [ + { + "title": "To create a key pair", + "documentation": "This example creates a key pair named my-key-pair.", + "input": { + "KeyName": "my-key-pair" + } + } + ] + } + }, + "com.amazonaws.ec2#CreateKeyPairRequest": { + "type": "structure", + "members": { + "KeyName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A unique name for the key pair.

\n

Constraints: Up to 255 ASCII characters

", + "smithy.api#required": {} + } + }, + "KeyType": { + "target": "com.amazonaws.ec2#KeyType", + "traits": { + "smithy.api#documentation": "

The type of key pair. Note that ED25519 keys are not supported for Windows instances.

\n

Default: rsa\n

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the new key pair.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "KeyFormat": { + "target": "com.amazonaws.ec2#KeyFormat", + "traits": { + "smithy.api#documentation": "

The format of the key pair.

\n

Default: pem\n

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateLaunchTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateLaunchTemplateRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateLaunchTemplateResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a launch template.

\n

A launch template contains the parameters to launch an instance. When you launch an\n instance using RunInstances, you can specify a launch template instead\n of providing the launch parameters in the request. For more information, see Launch\n an instance from a launch template in the\n Amazon EC2 User Guide.

\n

To clone an existing launch template as the basis for a new launch template, use the \n Amazon EC2 console. The API, SDKs, and CLI do not support cloning a template. For more \n information, see Create a launch template from an existing launch template in the\n Amazon EC2 User Guide.

", + "smithy.api#examples": [ + { + "title": "To create a launch template", + "documentation": "This example creates a launch template that specifies the subnet in which to launch the instance, assigns a public IP address and an IPv6 address to the instance, and creates a tag for the instance.", + "input": { + "LaunchTemplateName": "my-template", + "VersionDescription": "WebVersion1", + "LaunchTemplateData": { + "NetworkInterfaces": [ + { + "AssociatePublicIpAddress": true, + "DeviceIndex": 0, + "Ipv6AddressCount": 1, + "SubnetId": "subnet-7b16de0c" + } + ], + "ImageId": "ami-8c1be5f6", + "InstanceType": "t2.small", + "TagSpecifications": [ + { + "ResourceType": "instance", + "Tags": [ + { + "Key": "Name", + "Value": "webserver" + } + ] + } + ] + } + }, + "output": { + "LaunchTemplate": { + "LatestVersionNumber": 1, + "LaunchTemplateId": "lt-01238c059e3466abc", + "LaunchTemplateName": "my-template", + "DefaultVersionNumber": 1, + "CreatedBy": "arn:aws:iam::123456789012:root", + "CreateTime": "2017-11-27T09:13:24.000Z" + } + } + } + ] + } + }, + "com.amazonaws.ec2#CreateLaunchTemplateRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n idempotency.

\n

Constraint: Maximum 128 ASCII characters.

" + } + }, + "LaunchTemplateName": { + "target": "com.amazonaws.ec2#LaunchTemplateName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A name for the launch template.

", + "smithy.api#required": {} + } + }, + "VersionDescription": { + "target": "com.amazonaws.ec2#VersionDescription", + "traits": { + "smithy.api#documentation": "

A description for the first version of the launch template.

" + } + }, + "LaunchTemplateData": { + "target": "com.amazonaws.ec2#RequestLaunchTemplateData", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The information for the launch template.

", + "smithy.api#required": {} + } + }, + "Operator": { + "target": "com.amazonaws.ec2#OperatorRequest", + "traits": { + "smithy.api#documentation": "

Reserved for internal use.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the launch template on creation. To tag the launch template, the\n resource type must be launch-template.

\n

To specify the tags for the resources that are created when an instance is\n launched, you must use the TagSpecifications parameter in the launch template data structure.

", + "smithy.api#xmlName": "TagSpecification" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateLaunchTemplateResult": { + "type": "structure", + "members": { + "LaunchTemplate": { + "target": "com.amazonaws.ec2#LaunchTemplate", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplate", + "smithy.api#documentation": "

Information about the launch template.

", + "smithy.api#xmlName": "launchTemplate" + } + }, + "Warning": { + "target": "com.amazonaws.ec2#ValidationWarning", + "traits": { + "aws.protocols#ec2QueryName": "Warning", + "smithy.api#documentation": "

If the launch template contains parameters or parameter combinations that are not\n valid, an error code and an error message are returned for each issue that's\n found.

", + "smithy.api#xmlName": "warning" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateLaunchTemplateVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateLaunchTemplateVersionRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateLaunchTemplateVersionResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a new version of a launch template. You must specify an existing launch\n template, either by name or ID. You can determine whether the new version inherits \n parameters from a source version, and add or overwrite parameters as needed.

\n

Launch template versions are numbered in the order in which they are created. You\n can't specify, change, or replace the numbering of launch template versions.

\n

Launch templates are immutable; after you create a launch template, you can't modify\n it. Instead, you can create a new version of the launch template that includes the\n changes that you require.

\n

For more information, see Modify a launch template (manage launch template versions) in the\n Amazon EC2 User Guide.

", + "smithy.api#examples": [ + { + "title": "To create a launch template version", + "documentation": "This example creates a new launch template version based on version 1 of the specified launch template and specifies a different AMI ID.", + "input": { + "LaunchTemplateId": "lt-0abcd290751193123", + "SourceVersion": "1", + "VersionDescription": "WebVersion2", + "LaunchTemplateData": { + "ImageId": "ami-c998b6b2" + } + }, + "output": { + "LaunchTemplateVersion": { + "VersionDescription": "WebVersion2", + "LaunchTemplateId": "lt-0abcd290751193123", + "LaunchTemplateName": "my-template", + "VersionNumber": 2, + "CreatedBy": "arn:aws:iam::123456789012:root", + "LaunchTemplateData": { + "ImageId": "ami-c998b6b2", + "InstanceType": "t2.micro", + "NetworkInterfaces": [ + { + "Ipv6Addresses": [ + { + "Ipv6Address": "2001:db8:1234:1a00::123" + } + ], + "DeviceIndex": 0, + "SubnetId": "subnet-7b16de0c", + "AssociatePublicIpAddress": true + } + ] + }, + "DefaultVersion": false, + "CreateTime": "2017-12-01T13:35:46.000Z" + } + } + } + ] + } + }, + "com.amazonaws.ec2#CreateLaunchTemplateVersionRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n idempotency.

\n

Constraint: Maximum 128 ASCII characters.

" + } + }, + "LaunchTemplateId": { + "target": "com.amazonaws.ec2#LaunchTemplateId", + "traits": { + "smithy.api#documentation": "

The ID of the launch template.

\n

You must specify either the launch template ID or the\n launch template name, but not both.

" + } + }, + "LaunchTemplateName": { + "target": "com.amazonaws.ec2#LaunchTemplateName", + "traits": { + "smithy.api#documentation": "

The name of the launch template.

\n

You must specify either the launch template ID or the\n launch template name, but not both.

" + } + }, + "SourceVersion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The version of the launch template on which to base the new version. \n Snapshots applied to the block device mapping are ignored when creating a new version \n unless they are explicitly included.

\n

If you specify this parameter, the new version inherits the launch parameters from the\n source version. If you specify additional launch parameters for the new version, they \n overwrite any corresponding launch parameters inherited from the source version.

\n

If you omit this parameter, the new version contains only the launch parameters\n that you specify for the new version.

" + } + }, + "VersionDescription": { + "target": "com.amazonaws.ec2#VersionDescription", + "traits": { + "smithy.api#documentation": "

A description for the version of the launch template.

" + } + }, + "LaunchTemplateData": { + "target": "com.amazonaws.ec2#RequestLaunchTemplateData", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The information for the launch template.

", + "smithy.api#required": {} + } + }, + "ResolveAlias": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

If true, and if a Systems Manager parameter is specified for ImageId,\n the AMI ID is displayed in the response for imageID. For more information, see Use a Systems \n Manager parameter instead of an AMI ID in the Amazon EC2 User Guide.

\n

Default: false\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateLaunchTemplateVersionResult": { + "type": "structure", + "members": { + "LaunchTemplateVersion": { + "target": "com.amazonaws.ec2#LaunchTemplateVersion", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateVersion", + "smithy.api#documentation": "

Information about the launch template version.

", + "smithy.api#xmlName": "launchTemplateVersion" + } + }, + "Warning": { + "target": "com.amazonaws.ec2#ValidationWarning", + "traits": { + "aws.protocols#ec2QueryName": "Warning", + "smithy.api#documentation": "

If the new version of the launch template contains parameters or parameter\n combinations that are not valid, an error code and an error message are returned for\n each issue that's found.

", + "smithy.api#xmlName": "warning" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateLocalGatewayRoute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateLocalGatewayRouteRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateLocalGatewayRouteResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a static route for the specified local gateway route table. You must specify one of the \n following targets:

\n " + } + }, + "com.amazonaws.ec2#CreateLocalGatewayRouteRequest": { + "type": "structure", + "members": { + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The CIDR range used for destination matches. Routing decisions are based on \n the most specific match.

" + } + }, + "LocalGatewayRouteTableId": { + "target": "com.amazonaws.ec2#LocalGatewayRoutetableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the local gateway route table.

", + "smithy.api#required": {} + } + }, + "LocalGatewayVirtualInterfaceGroupId": { + "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupId", + "traits": { + "smithy.api#documentation": "

The ID of the virtual interface group.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "smithy.api#documentation": "

The ID of the network interface.

" + } + }, + "DestinationPrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "smithy.api#documentation": "

\n The ID of the prefix list. Use a prefix list in place of DestinationCidrBlock. You \n cannot use DestinationPrefixListId and DestinationCidrBlock in the same request.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateLocalGatewayRouteResult": { + "type": "structure", + "members": { + "Route": { + "target": "com.amazonaws.ec2#LocalGatewayRoute", + "traits": { + "aws.protocols#ec2QueryName": "Route", + "smithy.api#documentation": "

Information about the route.

", + "smithy.api#xmlName": "route" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateLocalGatewayRouteTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateLocalGatewayRouteTableRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateLocalGatewayRouteTableResult" + }, + "traits": { + "smithy.api#documentation": "

\n Creates a local gateway route table. \n

" + } + }, + "com.amazonaws.ec2#CreateLocalGatewayRouteTableRequest": { + "type": "structure", + "members": { + "LocalGatewayId": { + "target": "com.amazonaws.ec2#LocalGatewayId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

\n The ID of the local gateway. \n

", + "smithy.api#required": {} + } + }, + "Mode": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTableMode", + "traits": { + "smithy.api#documentation": "

\n The mode of the local gateway route table.\n

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

\n The tags assigned to the local gateway route table.\n

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateLocalGatewayRouteTableResult": { + "type": "structure", + "members": { + "LocalGatewayRouteTable": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTable", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayRouteTable", + "smithy.api#documentation": "

Information about the local gateway route table.

", + "smithy.api#xmlName": "localGatewayRouteTable" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociationResult" + }, + "traits": { + "smithy.api#documentation": "

\n Creates a local gateway route table virtual interface group association. \n

" + } + }, + "com.amazonaws.ec2#CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociationRequest": { + "type": "structure", + "members": { + "LocalGatewayRouteTableId": { + "target": "com.amazonaws.ec2#LocalGatewayRoutetableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

\n The ID of the local gateway route table.\n

", + "smithy.api#required": {} + } + }, + "LocalGatewayVirtualInterfaceGroupId": { + "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

\n The ID of the local gateway route table virtual interface group association.\n

", + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

\n The tags assigned to the local gateway route table virtual interface group association.\n

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociationResult": { + "type": "structure", + "members": { + "LocalGatewayRouteTableVirtualInterfaceGroupAssociation": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTableVirtualInterfaceGroupAssociation", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayRouteTableVirtualInterfaceGroupAssociation", + "smithy.api#documentation": "

Information about the local gateway route table virtual interface group association.

", + "smithy.api#xmlName": "localGatewayRouteTableVirtualInterfaceGroupAssociation" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateLocalGatewayRouteTableVpcAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateLocalGatewayRouteTableVpcAssociationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateLocalGatewayRouteTableVpcAssociationResult" + }, + "traits": { + "smithy.api#documentation": "

Associates the specified VPC with the specified local gateway route table.

" + } + }, + "com.amazonaws.ec2#CreateLocalGatewayRouteTableVpcAssociationRequest": { + "type": "structure", + "members": { + "LocalGatewayRouteTableId": { + "target": "com.amazonaws.ec2#LocalGatewayRoutetableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the local gateway route table.

", + "smithy.api#required": {} + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to the local gateway route table VPC association.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateLocalGatewayRouteTableVpcAssociationResult": { + "type": "structure", + "members": { + "LocalGatewayRouteTableVpcAssociation": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTableVpcAssociation", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayRouteTableVpcAssociation", + "smithy.api#documentation": "

Information about the association.

", + "smithy.api#xmlName": "localGatewayRouteTableVpcAssociation" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateManagedPrefixList": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateManagedPrefixListRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateManagedPrefixListResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a managed prefix list. You can specify one or more entries for the prefix list. \n Each entry consists of a CIDR block and an optional description.

" + } + }, + "com.amazonaws.ec2#CreateManagedPrefixListRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "PrefixListName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A name for the prefix list.

\n

Constraints: Up to 255 characters in length. The name cannot start with com.amazonaws.

", + "smithy.api#required": {} + } + }, + "Entries": { + "target": "com.amazonaws.ec2#AddPrefixListEntries", + "traits": { + "smithy.api#documentation": "

One or more entries for the prefix list.

", + "smithy.api#xmlName": "Entry" + } + }, + "MaxEntries": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The maximum number of entries for the prefix list.

", + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the prefix list during creation.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "AddressFamily": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IP address type.

\n

Valid Values: IPv4 | IPv6\n

", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n idempotency.

\n

Constraints: Up to 255 UTF-8 characters in length.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateManagedPrefixListResult": { + "type": "structure", + "members": { + "PrefixList": { + "target": "com.amazonaws.ec2#ManagedPrefixList", + "traits": { + "aws.protocols#ec2QueryName": "PrefixList", + "smithy.api#documentation": "

Information about the prefix list.

", + "smithy.api#xmlName": "prefixList" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateNatGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateNatGatewayRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateNatGatewayResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a NAT gateway in the specified subnet. This action creates a network interface\n in the specified subnet with a private IP address from the IP address range of the\n subnet. You can create either a public NAT gateway or a private NAT gateway.

\n

With a public NAT gateway, internet-bound traffic from a private subnet can be routed\n to the NAT gateway, so that instances in a private subnet can connect to the internet.

\n

With a private NAT gateway, private communication is routed across VPCs and on-premises\n networks through a transit gateway or virtual private gateway. Common use cases include\n running large workloads behind a small pool of allowlisted IPv4 addresses, preserving\n private IPv4 addresses, and communicating between overlapping networks.

\n

For more information, see NAT gateways in the Amazon VPC User Guide.

\n \n

When you create a public NAT gateway and assign it an EIP or secondary EIPs, \n the network border group of the EIPs must match the network border group of the Availability Zone (AZ) \n that the public NAT gateway is in. If it's not the same, the NAT gateway will fail to launch. \n You can see the network border group for the subnet's AZ by viewing the details of the subnet. \n Similarly, you can view the network border group of an EIP by viewing the details of the EIP address. \n For more information about network border groups and EIPs, see Allocate an Elastic IP address \n in the Amazon VPC User Guide. \n

\n ", + "smithy.api#examples": [ + { + "title": "To create a NAT gateway", + "documentation": "This example creates a NAT gateway in subnet subnet-1a2b3c4d and associates an Elastic IP address with the allocation ID eipalloc-37fc1a52 with the NAT gateway.", + "input": { + "SubnetId": "subnet-1a2b3c4d", + "AllocationId": "eipalloc-37fc1a52" + }, + "output": { + "NatGateway": { + "NatGatewayAddresses": [ + { + "AllocationId": "eipalloc-37fc1a52" + } + ], + "VpcId": "vpc-1122aabb", + "State": "pending", + "NatGatewayId": "nat-08d48af2a8e83edfd", + "SubnetId": "subnet-1a2b3c4d", + "CreateTime": "2015-12-17T12:45:26.732Z" + } + } + } + ] + } + }, + "com.amazonaws.ec2#CreateNatGatewayRequest": { + "type": "structure", + "members": { + "AllocationId": { + "target": "com.amazonaws.ec2#AllocationId", + "traits": { + "smithy.api#documentation": "

[Public NAT gateways only] The allocation ID of an Elastic IP address to associate \n with the NAT gateway. You cannot specify an Elastic IP address with a private NAT gateway.\n If the Elastic IP address is associated with another resource, you must first disassociate it.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n\t\t\trequest. For more information, see Ensuring idempotency.

\n

Constraint: Maximum 64 ASCII characters.

", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the subnet in which to create the NAT gateway.

", + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to the NAT gateway.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "ConnectivityType": { + "target": "com.amazonaws.ec2#ConnectivityType", + "traits": { + "smithy.api#documentation": "

Indicates whether the NAT gateway supports public or private connectivity. \n The default is public connectivity.

" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The private IPv4 address to assign to the NAT gateway. If you don't provide an address, a private IPv4 address will be automatically assigned.

" + } + }, + "SecondaryAllocationIds": { + "target": "com.amazonaws.ec2#AllocationIdList", + "traits": { + "smithy.api#documentation": "

Secondary EIP allocation IDs. For more information, see Create a NAT gateway \n in the Amazon VPC User Guide.

", + "smithy.api#xmlName": "SecondaryAllocationId" + } + }, + "SecondaryPrivateIpAddresses": { + "target": "com.amazonaws.ec2#IpList", + "traits": { + "smithy.api#documentation": "

Secondary private IPv4 addresses. For more information about secondary addresses, see \n Create a NAT gateway in the Amazon VPC User Guide.

", + "smithy.api#xmlName": "SecondaryPrivateIpAddress" + } + }, + "SecondaryPrivateIpAddressCount": { + "target": "com.amazonaws.ec2#PrivateIpAddressCount", + "traits": { + "smithy.api#documentation": "

[Private NAT gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT gateway. \n For more information about secondary addresses, see Create a NAT gateway \n in the Amazon VPC User Guide.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateNatGatewayResult": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.

", + "smithy.api#xmlName": "clientToken" + } + }, + "NatGateway": { + "target": "com.amazonaws.ec2#NatGateway", + "traits": { + "aws.protocols#ec2QueryName": "NatGateway", + "smithy.api#documentation": "

Information about the NAT gateway.

", + "smithy.api#xmlName": "natGateway" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateNetworkAcl": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateNetworkAclRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateNetworkAclResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC.

\n

For more information, see Network ACLs in the\n\t\t\t\tAmazon VPC User Guide.

", + "smithy.api#examples": [ + { + "title": "To create a network ACL", + "documentation": "This example creates a network ACL for the specified VPC.", + "input": { + "VpcId": "vpc-a01106c2" + }, + "output": { + "NetworkAcl": { + "Associations": [], + "NetworkAclId": "acl-5fb85d36", + "VpcId": "vpc-a01106c2", + "Tags": [], + "Entries": [ + { + "CidrBlock": "0.0.0.0/0", + "RuleNumber": 32767, + "Protocol": "-1", + "Egress": true, + "RuleAction": "deny" + }, + { + "CidrBlock": "0.0.0.0/0", + "RuleNumber": 32767, + "Protocol": "-1", + "Egress": false, + "RuleAction": "deny" + } + ], + "IsDefault": false + } + } + } + ] + } + }, + "com.amazonaws.ec2#CreateNetworkAclEntry": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateNetworkAclEntryRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules \n\t\t and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated \n\t\t with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of \n\t\t ingress rules and a separate set of egress rules.

\n

We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the \n\t\t other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.

\n

After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one.

\n

For more information about network ACLs, see Network ACLs \n in the Amazon VPC User Guide.

", + "smithy.api#examples": [ + { + "title": "To create a network ACL entry", + "documentation": "This example creates an entry for the specified network ACL. The rule allows ingress traffic from anywhere (0.0.0.0/0) on UDP port 53 (DNS) into any associated subnet.", + "input": { + "NetworkAclId": "acl-5fb85d36", + "RuleNumber": 100, + "Protocol": "17", + "RuleAction": "allow", + "Egress": false, + "CidrBlock": "0.0.0.0/0", + "PortRange": { + "From": 53, + "To": 53 + } + } + } + ] + } + }, + "com.amazonaws.ec2#CreateNetworkAclEntryRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "NetworkAclId": { + "target": "com.amazonaws.ec2#NetworkAclId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkAclId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the network ACL.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "networkAclId" + } + }, + "RuleNumber": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "RuleNumber", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.

\n

Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is reserved for internal use.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "ruleNumber" + } + }, + "Protocol": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Protocol", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The protocol number. A value of \"-1\" means all protocols. If you specify \"-1\" or a\n \t\t\tprotocol number other than \"6\" (TCP), \"17\" (UDP), or \"1\" (ICMP), traffic on all ports is \n\t\t\tallowed, regardless of any ports or ICMP types or codes that you specify. If you specify \n\t\t\tprotocol \"58\" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and \n\t\t\tcodes allowed, regardless of any that you specify. If you specify protocol \"58\" (ICMPv6) \n\t\t\tand specify an IPv6 CIDR block, you must specify an ICMP type and code.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "protocol" + } + }, + "RuleAction": { + "target": "com.amazonaws.ec2#RuleAction", + "traits": { + "aws.protocols#ec2QueryName": "RuleAction", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Indicates whether to allow or deny the traffic that matches the rule.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "ruleAction" + } + }, + "Egress": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Egress", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).

", + "smithy.api#required": {}, + "smithy.api#xmlName": "egress" + } + }, + "CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CidrBlock", + "smithy.api#documentation": "

The IPv4 network range to allow or deny, in CIDR notation (for example\n\t\t 172.16.0.0/24). We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.

", + "smithy.api#xmlName": "cidrBlock" + } + }, + "Ipv6CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6CidrBlock", + "smithy.api#documentation": "

The IPv6 network range to allow or deny, in CIDR notation (for example\n 2001:db8:1234:1a00::/64).

", + "smithy.api#xmlName": "ipv6CidrBlock" + } + }, + "IcmpTypeCode": { + "target": "com.amazonaws.ec2#IcmpTypeCode", + "traits": { + "smithy.api#documentation": "

ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol \n\t\t 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.

", + "smithy.api#xmlName": "Icmp" + } + }, + "PortRange": { + "target": "com.amazonaws.ec2#PortRange", + "traits": { + "aws.protocols#ec2QueryName": "PortRange", + "smithy.api#documentation": "

TCP or UDP protocols: The range of ports the rule applies to.\n\t\t Required if specifying protocol 6 (TCP) or 17 (UDP).

", + "smithy.api#xmlName": "portRange" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateNetworkAclRequest": { + "type": "structure", + "members": { + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to the network ACL.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see Ensuring idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "vpcId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateNetworkAclResult": { + "type": "structure", + "members": { + "NetworkAcl": { + "target": "com.amazonaws.ec2#NetworkAcl", + "traits": { + "aws.protocols#ec2QueryName": "NetworkAcl", + "smithy.api#documentation": "

Information about the network ACL.

", + "smithy.api#xmlName": "networkAcl" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.

", + "smithy.api#xmlName": "clientToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateNetworkInsightsAccessScope": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateNetworkInsightsAccessScopeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateNetworkInsightsAccessScopeResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a Network Access Scope.

\n

Amazon Web Services Network Access Analyzer enables cloud networking and cloud operations teams \n to verify that their networks on Amazon Web Services conform to their network security and governance \n objectives. For more information, see the Amazon Web Services Network Access Analyzer Guide.

" + } + }, + "com.amazonaws.ec2#CreateNetworkInsightsAccessScopeRequest": { + "type": "structure", + "members": { + "MatchPaths": { + "target": "com.amazonaws.ec2#AccessScopePathListRequest", + "traits": { + "smithy.api#documentation": "

The paths to match.

", + "smithy.api#xmlName": "MatchPath" + } + }, + "ExcludePaths": { + "target": "com.amazonaws.ec2#AccessScopePathListRequest", + "traits": { + "smithy.api#documentation": "

The paths to exclude.

", + "smithy.api#xmlName": "ExcludePath" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, \n see How to ensure idempotency.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateNetworkInsightsAccessScopeResult": { + "type": "structure", + "members": { + "NetworkInsightsAccessScope": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScope", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAccessScope", + "smithy.api#documentation": "

The Network Access Scope.

", + "smithy.api#xmlName": "networkInsightsAccessScope" + } + }, + "NetworkInsightsAccessScopeContent": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeContent", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeContent", + "smithy.api#documentation": "

The Network Access Scope content.

", + "smithy.api#xmlName": "networkInsightsAccessScopeContent" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateNetworkInsightsPath": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateNetworkInsightsPathRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateNetworkInsightsPathResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a path to analyze for reachability.

\n

Reachability Analyzer enables you to analyze and debug network reachability between\n two resources in your virtual private cloud (VPC). For more information, see the \n Reachability Analyzer Guide.

" + } + }, + "com.amazonaws.ec2#CreateNetworkInsightsPathRequest": { + "type": "structure", + "members": { + "SourceIp": { + "target": "com.amazonaws.ec2#IpAddress", + "traits": { + "smithy.api#documentation": "

The IP address of the source.

" + } + }, + "DestinationIp": { + "target": "com.amazonaws.ec2#IpAddress", + "traits": { + "smithy.api#documentation": "

The IP address of the destination.

" + } + }, + "Source": { + "target": "com.amazonaws.ec2#NetworkInsightsResourceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID or ARN of the source. If the resource is in another account, you must specify an ARN.

", + "smithy.api#required": {} + } + }, + "Destination": { + "target": "com.amazonaws.ec2#NetworkInsightsResourceId", + "traits": { + "smithy.api#documentation": "

The ID or ARN of the destination. If the resource is in another account, you must specify an ARN.

" + } + }, + "Protocol": { + "target": "com.amazonaws.ec2#Protocol", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The protocol.

", + "smithy.api#required": {} + } + }, + "DestinationPort": { + "target": "com.amazonaws.ec2#Port", + "traits": { + "smithy.api#documentation": "

The destination port.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to add to the path.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, \n see How to ensure idempotency.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "FilterAtSource": { + "target": "com.amazonaws.ec2#PathRequestFilter", + "traits": { + "smithy.api#documentation": "

Scopes the analysis to network paths that match specific filters at the source. If you specify\n this parameter, you can't specify the parameters for the source IP address or the destination port.

" + } + }, + "FilterAtDestination": { + "target": "com.amazonaws.ec2#PathRequestFilter", + "traits": { + "smithy.api#documentation": "

Scopes the analysis to network paths that match specific filters at the destination. If you specify\n this parameter, you can't specify the parameter for the destination IP address.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateNetworkInsightsPathResult": { + "type": "structure", + "members": { + "NetworkInsightsPath": { + "target": "com.amazonaws.ec2#NetworkInsightsPath", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsPath", + "smithy.api#documentation": "

Information about the path.

", + "smithy.api#xmlName": "networkInsightsPath" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateNetworkInterface": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateNetworkInterfaceRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateNetworkInterfaceResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a network interface in the specified subnet.

\n

The number of IP addresses you can assign to a network interface varies by instance\n type.

\n

For more information about network interfaces, see Elastic network interfaces \n in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#CreateNetworkInterfacePermission": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateNetworkInterfacePermissionRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateNetworkInterfacePermissionResult" + }, + "traits": { + "smithy.api#documentation": "

Grants an Amazon Web Services-authorized account permission to attach the specified network interface to\n an instance in their account.

\n

You can grant permission to a single Amazon Web Services account only, and only one account at a time.

" + } + }, + "com.amazonaws.ec2#CreateNetworkInterfacePermissionRequest": { + "type": "structure", + "members": { + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

" + } + }, + "AwsService": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services service. Currently not supported.

" + } + }, + "Permission": { + "target": "com.amazonaws.ec2#InterfacePermissionType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of permission to grant.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is DryRunOperation. \n\t\t\tOtherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for CreateNetworkInterfacePermission.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateNetworkInterfacePermissionResult": { + "type": "structure", + "members": { + "InterfacePermission": { + "target": "com.amazonaws.ec2#NetworkInterfacePermission", + "traits": { + "aws.protocols#ec2QueryName": "InterfacePermission", + "smithy.api#documentation": "

Information about the permission for the network interface.

", + "smithy.api#xmlName": "interfacePermission" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of CreateNetworkInterfacePermission.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateNetworkInterfaceRequest": { + "type": "structure", + "members": { + "Ipv4Prefixes": { + "target": "com.amazonaws.ec2#Ipv4PrefixList", + "traits": { + "smithy.api#documentation": "

The IPv4 prefixes assigned to the network interface.

\n

You can't specify IPv4 prefixes if you've specified one of the following:\n a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.

", + "smithy.api#xmlName": "Ipv4Prefix" + } + }, + "Ipv4PrefixCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface.

\n

You can't specify a count of IPv4 prefixes if you've specified one of the following:\n specific IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4\n addresses.

" + } + }, + "Ipv6Prefixes": { + "target": "com.amazonaws.ec2#Ipv6PrefixList", + "traits": { + "smithy.api#documentation": "

The IPv6 prefixes assigned to the network interface.

\n

You can't specify IPv6 prefixes if you've specified one of the following:\n a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.

", + "smithy.api#xmlName": "Ipv6Prefix" + } + }, + "Ipv6PrefixCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The number of IPv6 prefixes that Amazon Web Services automatically assigns to the network interface.

\n

You can't specify a count of IPv6 prefixes if you've specified one of the following:\n specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.

" + } + }, + "InterfaceType": { + "target": "com.amazonaws.ec2#NetworkInterfaceCreationType", + "traits": { + "smithy.api#documentation": "

The type of network interface. The default is interface.

\n

If you specify efa-only, do not assign any IP addresses to the network \n interface. EFA-only network interfaces do not support IP addresses.

\n

The only supported values are interface, efa, efa-only, and trunk.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the new network interface.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "EnablePrimaryIpv6": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

If you’re creating a network interface in a dual-stack or IPv6-only subnet, you have\n the option to assign a primary IPv6 IP address. A primary IPv6 address is an IPv6 GUA\n address associated with an ENI that you have enabled to use a primary IPv6 address. Use this option if the instance that\n this ENI will be attached to relies on its IPv6 address not changing. Amazon Web Services\n will automatically assign an IPv6 address associated with the ENI attached to your\n instance to be the primary IPv6 address. Once you enable an IPv6 GUA address to be a\n primary IPv6, you cannot disable it. When you enable an IPv6 GUA address to be a primary\n IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is\n terminated or the network interface is detached. If you have multiple IPv6 addresses\n associated with an ENI attached to your instance and you enable a primary IPv6 address,\n the first IPv6 GUA address associated with the ENI becomes the primary IPv6\n address.

" + } + }, + "ConnectionTrackingSpecification": { + "target": "com.amazonaws.ec2#ConnectionTrackingSpecificationRequest", + "traits": { + "smithy.api#documentation": "

A connection tracking specification for the network interface.

" + } + }, + "Operator": { + "target": "com.amazonaws.ec2#OperatorRequest", + "traits": { + "smithy.api#documentation": "

Reserved for internal use.

" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the subnet to associate with the network interface.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "subnetId" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description for the network interface.

", + "smithy.api#xmlName": "description" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddress", + "smithy.api#documentation": "

The primary private IPv4 address of the network interface. If you don't specify an\n IPv4 address, Amazon EC2 selects one for you from the subnet's IPv4 CIDR range. If you\n specify an IP address, you cannot indicate any IP addresses specified in\n privateIpAddresses as primary (only one IP address can be designated as\n primary).

", + "smithy.api#xmlName": "privateIpAddress" + } + }, + "Groups": { + "target": "com.amazonaws.ec2#SecurityGroupIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of one or more security groups.

", + "smithy.api#xmlName": "SecurityGroupId" + } + }, + "PrivateIpAddresses": { + "target": "com.amazonaws.ec2#PrivateIpAddressSpecificationList", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddresses", + "smithy.api#documentation": "

The private IPv4 addresses.

\n

You can't specify private IPv4 addresses if you've specified one of the following:\n a count of private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.

", + "smithy.api#xmlName": "privateIpAddresses" + } + }, + "SecondaryPrivateIpAddressCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "SecondaryPrivateIpAddressCount", + "smithy.api#documentation": "

The number of secondary private IPv4 addresses to assign to a network interface. When\n you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses\n within the subnet's IPv4 CIDR range. You can't specify this option and specify more than\n one private IP address using privateIpAddresses.

\n

You can't specify a count of private IPv4 addresses if you've specified one of the following:\n specific private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.

", + "smithy.api#xmlName": "secondaryPrivateIpAddressCount" + } + }, + "Ipv6Addresses": { + "target": "com.amazonaws.ec2#InstanceIpv6AddressList", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6Addresses", + "smithy.api#documentation": "

The IPv6 addresses from the IPv6 CIDR block range of your subnet.

\n

You can't specify IPv6 addresses using this parameter if you've specified one of the \n following: a count of IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.

", + "smithy.api#xmlName": "ipv6Addresses" + } + }, + "Ipv6AddressCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6AddressCount", + "smithy.api#documentation": "

The number of IPv6 addresses to assign to a network interface. Amazon EC2\n automatically selects the IPv6 addresses from the subnet range.

\n

You can't specify a count of IPv6 addresses using this parameter if you've specified \n one of the following: specific IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.

\n

If your subnet has the AssignIpv6AddressOnCreation attribute set, you can\n override that setting by specifying 0 as the IPv6 address count.

", + "smithy.api#xmlName": "ipv6AddressCount" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateNetworkInterfaceResult": { + "type": "structure", + "members": { + "NetworkInterface": { + "target": "com.amazonaws.ec2#NetworkInterface", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterface", + "smithy.api#documentation": "

Information about the network interface.

", + "smithy.api#xmlName": "networkInterface" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "clientToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreatePlacementGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreatePlacementGroupRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreatePlacementGroupResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a placement group in which to launch instances. The strategy of the placement\n group determines how the instances are organized within the group.

\n

A cluster placement group is a logical grouping of instances within a\n single Availability Zone that benefit from low network latency, high network throughput.\n A spread placement group places instances on distinct hardware. A\n partition placement group places groups of instances in different\n partitions, where instances in one partition do not share the same hardware with\n instances in another partition.

\n

For more information, see Placement groups in the\n Amazon EC2 User Guide.

", + "smithy.api#examples": [ + { + "title": "To create a placement group", + "documentation": "This example creates a placement group with the specified name.", + "input": { + "GroupName": "my-cluster", + "Strategy": "cluster" + }, + "output": {} + } + ] + } + }, + "com.amazonaws.ec2#CreatePlacementGroupRequest": { + "type": "structure", + "members": { + "PartitionCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The number of partitions. Valid only when Strategy is\n set to partition.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the new placement group.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "SpreadLevel": { + "target": "com.amazonaws.ec2#SpreadLevel", + "traits": { + "smithy.api#documentation": "

Determines how placement groups spread instances.

\n " + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "GroupName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupName", + "smithy.api#documentation": "

A name for the placement group. Must be unique within the scope of your account for\n the Region.

\n

Constraints: Up to 255 ASCII characters

", + "smithy.api#xmlName": "groupName" + } + }, + "Strategy": { + "target": "com.amazonaws.ec2#PlacementStrategy", + "traits": { + "aws.protocols#ec2QueryName": "Strategy", + "smithy.api#documentation": "

The placement strategy.

", + "smithy.api#xmlName": "strategy" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreatePlacementGroupResult": { + "type": "structure", + "members": { + "PlacementGroup": { + "target": "com.amazonaws.ec2#PlacementGroup", + "traits": { + "aws.protocols#ec2QueryName": "PlacementGroup", + "smithy.api#documentation": "

Information about the placement group.

", + "smithy.api#xmlName": "placementGroup" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreatePublicIpv4Pool": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreatePublicIpv4PoolRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreatePublicIpv4PoolResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a public IPv4 address pool. A public IPv4 pool is an EC2 IP address pool required for the public IPv4 CIDRs that you own and bring to Amazon Web Services to manage with IPAM. IPv6 addresses you bring to Amazon Web Services, however, use IPAM pools only. To monitor the status of pool creation, use DescribePublicIpv4Pools.

" + } + }, + "com.amazonaws.ec2#CreatePublicIpv4PoolRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "NetworkBorderGroup": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone (AZ) or Local Zone (LZ) network border group that the resource that the IP address is assigned to is in. Defaults to an AZ network border group. For more information on available Local Zones, see Local Zone availability in the Amazon EC2 User Guide.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreatePublicIpv4PoolResult": { + "type": "structure", + "members": { + "PoolId": { + "target": "com.amazonaws.ec2#Ipv4PoolEc2Id", + "traits": { + "aws.protocols#ec2QueryName": "PoolId", + "smithy.api#documentation": "

The ID of the public IPv4 pool.

", + "smithy.api#xmlName": "poolId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateReplaceRootVolumeTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateReplaceRootVolumeTaskRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateReplaceRootVolumeTaskResult" + }, + "traits": { + "smithy.api#documentation": "

Replaces the EBS-backed root volume for a running instance with a new \n volume that is restored to the original root volume's launch state, that is restored to a \n specific snapshot taken from the original root volume, or that is restored from an AMI \n that has the same key characteristics as that of the instance.

\n

For more information, see Replace a root volume in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#CreateReplaceRootVolumeTaskRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance for which to replace the root volume.

", + "smithy.api#required": {} + } + }, + "SnapshotId": { + "target": "com.amazonaws.ec2#SnapshotId", + "traits": { + "smithy.api#documentation": "

The ID of the snapshot from which to restore the replacement root volume. The \n specified snapshot must be a snapshot that you previously created from the original \n root volume.

\n

If you want to restore the replacement root volume to the initial launch state, \n or if you want to restore the replacement root volume from an AMI, omit this \n parameter.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. \n If you do not specify a client token, a randomly generated token is used for the request \n to ensure idempotency. For more information, see Ensuring idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the root volume replacement task.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#documentation": "

The ID of the AMI to use to restore the root volume. The specified AMI must have the \n same product code, billing information, architecture type, and virtualization type as \n that of the instance.

\n

If you want to restore the replacement volume from a specific snapshot, or if you want \n to restore it to its launch state, omit this parameter.

" + } + }, + "DeleteReplacedRootVolume": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether to automatically delete the original root volume after the root volume \n replacement task completes. To delete the original root volume, specify true. \n If you choose to keep the original root volume after the replacement task completes, you must \n manually delete it when you no longer need it.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateReplaceRootVolumeTaskResult": { + "type": "structure", + "members": { + "ReplaceRootVolumeTask": { + "target": "com.amazonaws.ec2#ReplaceRootVolumeTask", + "traits": { + "aws.protocols#ec2QueryName": "ReplaceRootVolumeTask", + "smithy.api#documentation": "

Information about the root volume replacement task.

", + "smithy.api#xmlName": "replaceRootVolumeTask" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateReservedInstancesListing": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateReservedInstancesListingRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateReservedInstancesListingResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance\n\t\t\tMarketplace. You can submit one Standard Reserved Instance listing at a time. To get a list of your\n\t\t\tStandard Reserved Instances, you can use the DescribeReservedInstances operation.

\n \n

Only Standard Reserved Instances can be sold in the Reserved Instance Marketplace. \n Convertible Reserved Instances cannot be sold.

\n \n

The Reserved Instance Marketplace matches sellers who want to resell Standard Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

\n

To sell your Standard Reserved Instances, you must first register as a seller in the Reserved Instance\n Marketplace. After completing the registration process, you can create a Reserved Instance\n Marketplace listing of some or all of your Standard Reserved Instances, and specify the upfront price\n to receive for them. Your Standard Reserved Instance listings then become available for purchase. To\n view the details of your Standard Reserved Instance listing, you can use the\n DescribeReservedInstancesListings operation.

\n

For more information, see Sell in the Reserved Instance\n Marketplace in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#CreateReservedInstancesListingRequest": { + "type": "structure", + "members": { + "ReservedInstancesId": { + "target": "com.amazonaws.ec2#ReservationId", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstancesId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the active Standard Reserved Instance.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "reservedInstancesId" + } + }, + "InstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "InstanceCount", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of instances that are a part of a Reserved Instance account to be listed in the Reserved Instance Marketplace. This number should be less than or equal to the instance count associated with the Reserved Instance ID specified in this call.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "instanceCount" + } + }, + "PriceSchedules": { + "target": "com.amazonaws.ec2#PriceScheduleSpecificationList", + "traits": { + "aws.protocols#ec2QueryName": "PriceSchedules", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A list specifying the price of the Standard Reserved Instance for each month remaining in the Reserved Instance term.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "priceSchedules" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure idempotency of your\n\t\t\t\tlistings. This helps avoid duplicate listings. For more information, see \n\t\t\t\tEnsuring Idempotency.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "clientToken" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for CreateReservedInstancesListing.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateReservedInstancesListingResult": { + "type": "structure", + "members": { + "ReservedInstancesListings": { + "target": "com.amazonaws.ec2#ReservedInstancesListingList", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstancesListingsSet", + "smithy.api#documentation": "

Information about the Standard Reserved Instance listing.

", + "smithy.api#xmlName": "reservedInstancesListingsSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of CreateReservedInstancesListing.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateRestoreImageTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateRestoreImageTaskRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateRestoreImageTaskResult" + }, + "traits": { + "smithy.api#documentation": "

Starts a task that restores an AMI from an Amazon S3 object that was previously created by\n using CreateStoreImageTask.

\n

To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the\n Amazon EC2 User Guide.

\n

For more information, see Store and restore an AMI using\n Amazon S3 in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#CreateRestoreImageTaskRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Amazon S3 bucket that contains the stored AMI object.

", + "smithy.api#required": {} + } + }, + "ObjectKey": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the stored AMI object in the bucket.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name for the restored AMI. The name must be unique for AMIs in the Region for this\n account. If you do not provide a name, the new AMI gets the same name as the original\n AMI.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the AMI and snapshots on restoration. You can tag the AMI, the\n snapshots, or both.

\n ", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateRestoreImageTaskResult": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The AMI ID.

", + "smithy.api#xmlName": "imageId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateRoute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateRouteRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateRouteResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a route in a route table within a VPC.

\n

You must specify either a destination CIDR block or a prefix list ID. You must also specify \n exactly one of the resources from the parameter list.

\n

When determining how to route traffic, we use the route with the most specific match.\n For example, traffic is destined for the IPv4 address 192.0.2.3, and the\n route table includes the following two IPv4 routes:

\n \n

Both routes apply to the traffic destined for 192.0.2.3. However, the second route\n\t\t\t\tin the list covers a smaller number of IP addresses and is therefore more specific,\n\t\t\t\tso we use that route to determine where to target the traffic.

\n

For more information about route tables, see Route tables in the\n Amazon VPC User Guide.

", + "smithy.api#examples": [ + { + "title": "To create a route", + "documentation": "This example creates a route for the specified route table. The route matches all traffic (0.0.0.0/0) and routes it to the specified Internet gateway.", + "input": { + "RouteTableId": "rtb-22574640", + "DestinationCidrBlock": "0.0.0.0/0", + "GatewayId": "igw-c0a643a9" + } + } + ] + } + }, + "com.amazonaws.ec2#CreateRouteRequest": { + "type": "structure", + "members": { + "DestinationPrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "smithy.api#documentation": "

The ID of a prefix list used for the destination match.

" + } + }, + "VpcEndpointId": { + "target": "com.amazonaws.ec2#VpcEndpointId", + "traits": { + "smithy.api#documentation": "

The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.

" + } + }, + "TransitGatewayId": { + "target": "com.amazonaws.ec2#TransitGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of a transit gateway.

" + } + }, + "LocalGatewayId": { + "target": "com.amazonaws.ec2#LocalGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the local gateway.

" + } + }, + "CarrierGatewayId": { + "target": "com.amazonaws.ec2#CarrierGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the carrier gateway.

\n

You can only use this option when the VPC contains a subnet which is associated with a Wavelength Zone.

" + } + }, + "CoreNetworkArn": { + "target": "com.amazonaws.ec2#CoreNetworkArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the core network.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "RouteTableId": { + "target": "com.amazonaws.ec2#RouteTableId", + "traits": { + "aws.protocols#ec2QueryName": "RouteTableId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the route table for the route.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "routeTableId" + } + }, + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationCidrBlock", + "smithy.api#documentation": "

The IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.

", + "smithy.api#xmlName": "destinationCidrBlock" + } + }, + "GatewayId": { + "target": "com.amazonaws.ec2#RouteGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "GatewayId", + "smithy.api#documentation": "

The ID of an internet gateway or virtual private gateway attached to your\n\t\t\tVPC.

", + "smithy.api#xmlName": "gatewayId" + } + }, + "DestinationIpv6CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationIpv6CidrBlock", + "smithy.api#documentation": "

The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match.

", + "smithy.api#xmlName": "destinationIpv6CidrBlock" + } + }, + "EgressOnlyInternetGatewayId": { + "target": "com.amazonaws.ec2#EgressOnlyInternetGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "EgressOnlyInternetGatewayId", + "smithy.api#documentation": "

[IPv6 traffic only] The ID of an egress-only internet gateway.

", + "smithy.api#xmlName": "egressOnlyInternetGatewayId" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.

", + "smithy.api#xmlName": "instanceId" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of a network interface.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "VpcPeeringConnectionId": { + "target": "com.amazonaws.ec2#VpcPeeringConnectionId", + "traits": { + "aws.protocols#ec2QueryName": "VpcPeeringConnectionId", + "smithy.api#documentation": "

The ID of a VPC peering connection.

", + "smithy.api#xmlName": "vpcPeeringConnectionId" + } + }, + "NatGatewayId": { + "target": "com.amazonaws.ec2#NatGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "NatGatewayId", + "smithy.api#documentation": "

[IPv4 traffic only] The ID of a NAT gateway.

", + "smithy.api#xmlName": "natGatewayId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateRouteResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateRouteTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateRouteTableRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateRouteTableResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.

\n

For more information, see Route tables in the\n\t\t\t\tAmazon VPC User Guide.

", + "smithy.api#examples": [ + { + "title": "To create a route table", + "documentation": "This example creates a route table for the specified VPC.", + "input": { + "VpcId": "vpc-a01106c2" + }, + "output": { + "RouteTable": { + "Associations": [], + "RouteTableId": "rtb-22574640", + "VpcId": "vpc-a01106c2", + "PropagatingVgws": [], + "Tags": [], + "Routes": [ + { + "GatewayId": "local", + "DestinationCidrBlock": "10.0.0.0/16", + "State": "active" + } + ] + } + } + } + ] + } + }, + "com.amazonaws.ec2#CreateRouteTableRequest": { + "type": "structure", + "members": { + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to the route table.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see Ensuring idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "vpcId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateRouteTableResult": { + "type": "structure", + "members": { + "RouteTable": { + "target": "com.amazonaws.ec2#RouteTable", + "traits": { + "aws.protocols#ec2QueryName": "RouteTable", + "smithy.api#documentation": "

Information about the route table.

", + "smithy.api#xmlName": "routeTable" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.

", + "smithy.api#xmlName": "clientToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateSecurityGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateSecurityGroupRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateSecurityGroupResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a security group.

\n

A security group acts as a virtual firewall for your instance to control inbound and outbound traffic.\n For more information, see\n\t\t\t\tAmazon EC2 security groups in \n\t\t\t\tthe Amazon EC2 User Guide and \n\t\t\t\tSecurity groups for your VPC in the\n\t\t\t\tAmazon VPC User Guide.

\n

When you create a security group, you specify a friendly name of your choice. \n You can't have two security groups for the same VPC with the same name.

\n

You have a default security group for use in your VPC. If you don't specify a security group \n when you launch an instance, the instance is launched into the appropriate default security group. \n A default security group includes a default rule that grants instances unrestricted network access \n to each other.

\n

You can add or remove rules from your security groups using \n\t\t\t\t\tAuthorizeSecurityGroupIngress,\n\t\t\t\t\tAuthorizeSecurityGroupEgress,\n\t\t\t\t\tRevokeSecurityGroupIngress, and\n\t\t\t\t\tRevokeSecurityGroupEgress.

\n

For more information about VPC security group limits, see Amazon VPC Limits.

", + "smithy.api#examples": [ + { + "title": "To create a security group for a VPC", + "documentation": "This example creates a security group for the specified VPC.", + "input": { + "Description": "My security group", + "GroupName": "my-security-group", + "VpcId": "vpc-1a2b3c4d" + }, + "output": { + "GroupId": "sg-903004f8" + } + } + ] + } + }, + "com.amazonaws.ec2#CreateSecurityGroupRequest": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A description for the security group.

\n

Constraints: Up to 255 characters in length

\n

Valid characters: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

", + "smithy.api#required": {}, + "smithy.api#xmlName": "GroupDescription" + } + }, + "GroupName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the security group.

\n

Constraints: Up to 255 characters in length. Cannot start with sg-.

\n

Valid characters: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

", + "smithy.api#required": {} + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#documentation": "

The ID of the VPC. Required for a nondefault VPC.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to the security group.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateSecurityGroupResult": { + "type": "structure", + "members": { + "GroupId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupId", + "smithy.api#documentation": "

The ID of the security group.

", + "smithy.api#xmlName": "groupId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the security group.

", + "smithy.api#xmlName": "tagSet" + } + }, + "SecurityGroupArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroupArn", + "smithy.api#documentation": "

The security group ARN.

", + "smithy.api#xmlName": "securityGroupArn" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.ec2#Snapshot" + }, + "traits": { + "smithy.api#documentation": "

Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for\n \tbackups, to make copies of EBS volumes, and to save data before shutting down an\n \tinstance.

\n

The location of the source EBS volume determines where you can create the snapshot.

\n \n

When a snapshot is created, any Amazon Web Services Marketplace product codes that are associated with the\n source volume are propagated to the snapshot.

\n

You can take a snapshot of an attached volume that is in use. However, snapshots only\n capture data that has been written to your Amazon EBS volume at the time the snapshot command is\n issued; this might exclude any data that has been cached by any applications or the operating\n system. If you can pause any file systems on the volume long enough to take a snapshot, your\n snapshot should be complete. However, if you cannot pause all file writes to the volume, you\n should unmount the volume from within the instance, issue the snapshot command, and then\n remount the volume to ensure a consistent and complete snapshot. You may remount and use your\n volume while the snapshot status is pending.

\n

When you create a snapshot for an EBS volume that serves as a root device, we recommend \n that you stop the instance before taking the snapshot.

\n

Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that\n are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes\n and any associated snapshots always remain protected. For more information, \n Amazon EBS encryption \n in the Amazon EBS User Guide.

", + "smithy.api#examples": [ + { + "title": "To create a snapshot", + "documentation": "This example creates a snapshot of the volume with a volume ID of ``vol-1234567890abcdef0`` and a short description to identify the snapshot.", + "input": { + "VolumeId": "vol-1234567890abcdef0", + "Description": "This is my root volume snapshot." + }, + "output": { + "Description": "This is my root volume snapshot.", + "Tags": [], + "VolumeId": "vol-1234567890abcdef0", + "State": "pending", + "VolumeSize": 8, + "StartTime": "2014-02-28T21:06:01.000Z", + "OwnerId": "012345678910", + "SnapshotId": "snap-066877671789bd71b" + } + } + ] + } + }, + "com.amazonaws.ec2#CreateSnapshotRequest": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description for the snapshot.

" + } + }, + "OutpostArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "\n

Only supported for volumes on Outposts. If the source volume is not on an Outpost, \n omit this parameter.

\n \n \n

For more information, see Create local snapshots from volumes on an Outpost in the Amazon EBS User Guide.

" + } + }, + "VolumeId": { + "target": "com.amazonaws.ec2#VolumeId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Amazon EBS volume.

", + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the snapshot during creation.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "Location": { + "target": "com.amazonaws.ec2#SnapshotLocationEnum", + "traits": { + "smithy.api#documentation": "\n

Only supported for volumes in Local Zones. If the source volume is not in a Local Zone, \n omit this parameter.

\n \n \n

Default value: regional\n

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateSnapshots": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateSnapshotsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateSnapshotsResult" + }, + "traits": { + "smithy.api#documentation": "

Creates crash-consistent snapshots of multiple EBS volumes attached to an Amazon EC2 instance.\n Volumes are chosen by specifying an instance. Each volume attached to the specified instance \n will produce one snapshot that is crash-consistent across the instance. You can include all of \n the volumes currently attached to the instance, or you can exclude the root volume or specific \n data (non-root) volumes from the multi-volume snapshot set.

\n

The location of the source instance determines where you can create the snapshots.

\n " + } + }, + "com.amazonaws.ec2#CreateSnapshotsRequest": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description propagated to every snapshot specified by the instance.

" + } + }, + "InstanceSpecification": { + "target": "com.amazonaws.ec2#InstanceSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The instance to specify which volumes should be included in the snapshots.

", + "smithy.api#required": {} + } + }, + "OutpostArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "\n

Only supported for instances on Outposts. If the source instance is not on an Outpost, \n omit this parameter.

\n \n \n

For more information, see \n Create local snapshots from volumes on an Outpost in the Amazon EBS User Guide.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

Tags to apply to every snapshot specified by the instance.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "CopyTagsFromSource": { + "target": "com.amazonaws.ec2#CopyTagsFromSource", + "traits": { + "smithy.api#documentation": "

Copies the tags from the specified volume to corresponding snapshot.

" + } + }, + "Location": { + "target": "com.amazonaws.ec2#SnapshotLocationEnum", + "traits": { + "smithy.api#documentation": "\n

Only supported for instances in Local Zones. If the source instance is not in a Local Zone, \n omit this parameter.

\n \n \n

Default value: regional\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateSnapshotsResult": { + "type": "structure", + "members": { + "Snapshots": { + "target": "com.amazonaws.ec2#SnapshotSet", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotSet", + "smithy.api#documentation": "

List of snapshots.

", + "smithy.api#xmlName": "snapshotSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateSpotDatafeedSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateSpotDatafeedSubscriptionRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateSpotDatafeedSubscriptionResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a data feed for Spot Instances, enabling you to view Spot Instance usage logs.\n You can create one data feed per Amazon Web Services account. For more information, see\n Spot Instance data feed \n in the Amazon EC2 User Guide.

", + "smithy.api#examples": [ + { + "title": "To create a Spot Instance datafeed", + "documentation": "This example creates a Spot Instance data feed for your AWS account.", + "input": { + "Bucket": "my-s3-bucket", + "Prefix": "spotdata" + }, + "output": { + "SpotDatafeedSubscription": { + "OwnerId": "123456789012", + "Prefix": "spotdata", + "Bucket": "my-s3-bucket", + "State": "Active" + } + } + } + ] + } + }, + "com.amazonaws.ec2#CreateSpotDatafeedSubscriptionRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "Bucket": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Bucket", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Amazon S3 bucket in which to store the Spot Instance data feed. For\n more information about bucket names, see Bucket naming rules \n in the Amazon S3 User Guide.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "bucket" + } + }, + "Prefix": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Prefix", + "smithy.api#documentation": "

The prefix for the data feed file names.

", + "smithy.api#xmlName": "prefix" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for CreateSpotDatafeedSubscription.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateSpotDatafeedSubscriptionResult": { + "type": "structure", + "members": { + "SpotDatafeedSubscription": { + "target": "com.amazonaws.ec2#SpotDatafeedSubscription", + "traits": { + "aws.protocols#ec2QueryName": "SpotDatafeedSubscription", + "smithy.api#documentation": "

The Spot Instance data feed subscription.

", + "smithy.api#xmlName": "spotDatafeedSubscription" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of CreateSpotDatafeedSubscription.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateStoreImageTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateStoreImageTaskRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateStoreImageTaskResult" + }, + "traits": { + "smithy.api#documentation": "

Stores an AMI as a single object in an Amazon S3 bucket.

\n

To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the\n Amazon EC2 User Guide.

\n

For more information, see Store and restore an AMI using\n Amazon S3 in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#CreateStoreImageTaskRequest": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the AMI.

", + "smithy.api#required": {} + } + }, + "Bucket": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Amazon S3 bucket in which the AMI object will be stored. The bucket must be in\n the Region in which the request is being made. The AMI object appears in the bucket only after\n the upload task has completed.

", + "smithy.api#required": {} + } + }, + "S3ObjectTags": { + "target": "com.amazonaws.ec2#S3ObjectTagList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the AMI object that will be stored in the Amazon S3 bucket.

", + "smithy.api#xmlName": "S3ObjectTag" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateStoreImageTaskResult": { + "type": "structure", + "members": { + "ObjectKey": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ObjectKey", + "smithy.api#documentation": "

The name of the stored AMI object in the S3 bucket.

", + "smithy.api#xmlName": "objectKey" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateSubnet": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateSubnetRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateSubnetResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a subnet in the specified VPC. For an IPv4 only subnet, specify an IPv4 CIDR block.\n If the VPC has an IPv6 CIDR block, you can create an IPv6 only subnet or a dual stack subnet instead.\n For an IPv6 only subnet, specify an IPv6 CIDR block. For a dual stack subnet, specify both\n an IPv4 CIDR block and an IPv6 CIDR block.

\n

A subnet CIDR block must not overlap the CIDR block of an existing subnet in the VPC.\n After you create a subnet, you can't change its CIDR block.

\n

The allowed size for an IPv4 subnet is between a /28 netmask (16 IP addresses) and \n a /16 netmask (65,536 IP addresses). Amazon Web Services reserves both the first four and \n the last IPv4 address in each subnet's CIDR block. They're not available for your use.

\n

If you've associated an IPv6 CIDR block with your VPC, you can associate an IPv6 CIDR\n block with a subnet when you create it.

\n

If you add more than one subnet to a VPC, they're set up in a star topology with a\n logical router in the middle.

\n

When you stop an instance in a subnet, it retains its private IPv4 address. It's\n therefore possible to have a subnet with no running instances (they're all stopped), but\n no remaining IP addresses available.

\n

For more information, see Subnets in the Amazon VPC User Guide.

", + "smithy.api#examples": [ + { + "title": "To create a subnet", + "documentation": "This example creates a subnet in the specified VPC with the specified CIDR block. We recommend that you let us select an Availability Zone for you.", + "input": { + "VpcId": "vpc-a01106c2", + "CidrBlock": "10.0.1.0/24" + }, + "output": { + "Subnet": { + "VpcId": "vpc-a01106c2", + "CidrBlock": "10.0.1.0/24", + "State": "pending", + "AvailabilityZone": "us-west-2c", + "SubnetId": "subnet-9d4a7b6c", + "AvailableIpAddressCount": 251 + } + } + } + ] + } + }, + "com.amazonaws.ec2#CreateSubnetCidrReservation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateSubnetCidrReservationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateSubnetCidrReservationResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a subnet CIDR reservation. For more information, see Subnet CIDR reservations \n in the Amazon VPC User Guide and Manage prefixes \n for your network interfaces in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#CreateSubnetCidrReservationRequest": { + "type": "structure", + "members": { + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the subnet.

", + "smithy.api#required": {} + } + }, + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IPv4 or IPV6 CIDR range to reserve.

", + "smithy.api#required": {} + } + }, + "ReservationType": { + "target": "com.amazonaws.ec2#SubnetCidrReservationType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of reservation. The reservation type determines how the reserved IP addresses are \n assigned to resources.

\n ", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The description to assign to the subnet CIDR reservation.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to the subnet CIDR reservation.

", + "smithy.api#xmlName": "TagSpecification" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateSubnetCidrReservationResult": { + "type": "structure", + "members": { + "SubnetCidrReservation": { + "target": "com.amazonaws.ec2#SubnetCidrReservation", + "traits": { + "aws.protocols#ec2QueryName": "SubnetCidrReservation", + "smithy.api#documentation": "

Information about the created subnet CIDR reservation.

", + "smithy.api#xmlName": "subnetCidrReservation" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateSubnetRequest": { + "type": "structure", + "members": { + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to the subnet.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone or Local Zone for the subnet.

\n

Default: Amazon Web Services selects one for you. If you create more than one subnet in your VPC, we \n do not necessarily select a different zone for each subnet.

\n

To create a subnet in a Local Zone, set this value to the Local Zone ID, for example\n us-west-2-lax-1a. For information about the Regions that support Local Zones, \n see Available Local Zones.

\n

To create a subnet in an Outpost, set this value to the Availability Zone for the\n Outpost and specify the Outpost ARN.

" + } + }, + "AvailabilityZoneId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The AZ ID or the Local Zone ID of the subnet.

" + } + }, + "CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IPv4 network range for the subnet, in CIDR notation. For example, 10.0.0.0/24. \n We modify the specified CIDR block to its canonical form; for example, if you specify \n 100.68.0.18/18, we modify it to 100.68.0.0/18.

\n

This parameter is not supported for an IPv6 only subnet.

" + } + }, + "Ipv6CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IPv6 network range for the subnet, in CIDR notation. This parameter is required\n for an IPv6 only subnet.

" + } + }, + "OutpostArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost. If you specify an Outpost ARN, you must also\n specify the Availability Zone of the Outpost subnet.

" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#required": {} + } + }, + "Ipv6Native": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether to create an IPv6 only subnet.

" + } + }, + "Ipv4IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "smithy.api#documentation": "

An IPv4 IPAM pool ID for the subnet.

" + } + }, + "Ipv4NetmaskLength": { + "target": "com.amazonaws.ec2#NetmaskLength", + "traits": { + "smithy.api#documentation": "

An IPv4 netmask length for the subnet.

" + } + }, + "Ipv6IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "smithy.api#documentation": "

An IPv6 IPAM pool ID for the subnet.

" + } + }, + "Ipv6NetmaskLength": { + "target": "com.amazonaws.ec2#NetmaskLength", + "traits": { + "smithy.api#documentation": "

An IPv6 netmask length for the subnet.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateSubnetResult": { + "type": "structure", + "members": { + "Subnet": { + "target": "com.amazonaws.ec2#Subnet", + "traits": { + "aws.protocols#ec2QueryName": "Subnet", + "smithy.api#documentation": "

Information about the subnet.

", + "smithy.api#xmlName": "subnet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateTagsRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Adds or overwrites only the specified tags for the specified Amazon EC2 resource or\n resources. When you specify an existing tag key, the value is overwritten with\n the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and\n optional value. Tag keys must be unique per resource.

\n

For more information about tags, see Tag your Amazon EC2 resources in the\n Amazon Elastic Compute Cloud User Guide. For more information about\n creating IAM policies that control users' access to resources based on tags, see Supported\n resource-level permissions for Amazon EC2 API actions in the Amazon\n Elastic Compute Cloud User Guide.

", + "smithy.api#examples": [ + { + "title": "To add a tag to a resource", + "documentation": "This example adds the tag Stack=production to the specified image, or overwrites an existing tag for the AMI where the tag key is Stack.", + "input": { + "Resources": [ + "ami-78a54011" + ], + "Tags": [ + { + "Key": "Stack", + "Value": "production" + } + ] + } + } + ] + } + }, + "com.amazonaws.ec2#CreateTagsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "Resources": { + "target": "com.amazonaws.ec2#ResourceIdList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the resources, separated by spaces.

\n

Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "ResourceId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The tags. The value parameter is required, but if you don't want the tag to have a value,\n specify the parameter with no value, and we set the value to an empty string.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "Tag" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateTrafficMirrorFilter": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateTrafficMirrorFilterRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateTrafficMirrorFilterResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a Traffic Mirror filter.

\n

A Traffic Mirror filter is a set of rules that defines the traffic to mirror.

\n

By default, no traffic is mirrored. To mirror traffic, use CreateTrafficMirrorFilterRule \n to add Traffic Mirror rules to the filter. The rules you add define what traffic gets mirrored. \n You can also use ModifyTrafficMirrorFilterNetworkServices to mirror supported network services.

" + } + }, + "com.amazonaws.ec2#CreateTrafficMirrorFilterRequest": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The description of the Traffic Mirror filter.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to a Traffic Mirror filter.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateTrafficMirrorFilterResult": { + "type": "structure", + "members": { + "TrafficMirrorFilter": { + "target": "com.amazonaws.ec2#TrafficMirrorFilter", + "traits": { + "aws.protocols#ec2QueryName": "TrafficMirrorFilter", + "smithy.api#documentation": "

Information about the Traffic Mirror filter.

", + "smithy.api#xmlName": "trafficMirrorFilter" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

", + "smithy.api#xmlName": "clientToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateTrafficMirrorFilterRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateTrafficMirrorFilterRuleRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateTrafficMirrorFilterRuleResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a Traffic Mirror filter rule.

\n

A Traffic Mirror rule defines the Traffic Mirror source traffic to mirror.

\n

You need the Traffic Mirror filter ID when you create the rule.

" + } + }, + "com.amazonaws.ec2#CreateTrafficMirrorFilterRuleRequest": { + "type": "structure", + "members": { + "TrafficMirrorFilterId": { + "target": "com.amazonaws.ec2#TrafficMirrorFilterId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the filter that this rule is associated with.

", + "smithy.api#required": {} + } + }, + "TrafficDirection": { + "target": "com.amazonaws.ec2#TrafficDirection", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of traffic.

", + "smithy.api#required": {} + } + }, + "RuleNumber": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given\n direction. The rules are processed in ascending order by rule number.

", + "smithy.api#required": {} + } + }, + "RuleAction": { + "target": "com.amazonaws.ec2#TrafficMirrorRuleAction", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The action to take on the filtered traffic.

", + "smithy.api#required": {} + } + }, + "DestinationPortRange": { + "target": "com.amazonaws.ec2#TrafficMirrorPortRangeRequest", + "traits": { + "smithy.api#documentation": "

The destination port range.

" + } + }, + "SourcePortRange": { + "target": "com.amazonaws.ec2#TrafficMirrorPortRangeRequest", + "traits": { + "smithy.api#documentation": "

The source port range.

" + } + }, + "Protocol": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The protocol, for example UDP, to assign to the Traffic Mirror rule.

\n

For information about the protocol value, see Protocol Numbers on the Internet Assigned Numbers Authority (IANA) website.

" + } + }, + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The destination CIDR block to assign to the Traffic Mirror rule.

", + "smithy.api#required": {} + } + }, + "SourceCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The source CIDR block to assign to the Traffic Mirror rule.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The description of the Traffic Mirror rule.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

Traffic Mirroring tags specifications.

", + "smithy.api#xmlName": "TagSpecification" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateTrafficMirrorFilterRuleResult": { + "type": "structure", + "members": { + "TrafficMirrorFilterRule": { + "target": "com.amazonaws.ec2#TrafficMirrorFilterRule", + "traits": { + "aws.protocols#ec2QueryName": "TrafficMirrorFilterRule", + "smithy.api#documentation": "

The Traffic Mirror rule.

", + "smithy.api#xmlName": "trafficMirrorFilterRule" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

", + "smithy.api#xmlName": "clientToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateTrafficMirrorSession": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateTrafficMirrorSessionRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateTrafficMirrorSessionResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a Traffic Mirror session.

\n

A Traffic Mirror session actively copies packets from a Traffic Mirror source to a Traffic Mirror target. Create a filter, and then assign it\n to the session to define a subset of the traffic to mirror, for example all TCP\n traffic.

\n

The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in a different VPC connected via VPC peering or a transit gateway.

\n

By default, no traffic is mirrored. Use CreateTrafficMirrorFilter to\n create filter rules that specify the traffic to mirror.

" + } + }, + "com.amazonaws.ec2#CreateTrafficMirrorSessionRequest": { + "type": "structure", + "members": { + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the source network interface.

", + "smithy.api#required": {} + } + }, + "TrafficMirrorTargetId": { + "target": "com.amazonaws.ec2#TrafficMirrorTargetId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Traffic Mirror target.

", + "smithy.api#required": {} + } + }, + "TrafficMirrorFilterId": { + "target": "com.amazonaws.ec2#TrafficMirrorFilterId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Traffic Mirror filter.

", + "smithy.api#required": {} + } + }, + "PacketLength": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The number of bytes in each packet to mirror. These are bytes after the VXLAN header. Do\n not specify this parameter when you want to mirror the entire packet. To mirror a subset of\n the packet, set this to the length (in bytes) that you want to mirror. For example, if you\n set this value to 100, then the first 100 bytes that meet the filter criteria are copied to\n the target.

\n

If you do not want to mirror the entire packet, use the PacketLength parameter to specify the number of bytes in each packet to mirror.

\n

For sessions with Network Load Balancer (NLB) Traffic Mirror targets the default PacketLength will be set to 8500. Valid values are 1-8500. Setting a PacketLength greater than 8500 will result in an error response.

" + } + }, + "SessionNumber": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.

\n

Valid values are 1-32766.

", + "smithy.api#required": {} + } + }, + "VirtualNetworkId": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The VXLAN ID for the Traffic Mirror session. For more information about the VXLAN\n protocol, see RFC 7348. If you do\n not specify a VirtualNetworkId, an account-wide unique ID is chosen at\n random.

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The description of the Traffic Mirror session.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to a Traffic Mirror session.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateTrafficMirrorSessionResult": { + "type": "structure", + "members": { + "TrafficMirrorSession": { + "target": "com.amazonaws.ec2#TrafficMirrorSession", + "traits": { + "aws.protocols#ec2QueryName": "TrafficMirrorSession", + "smithy.api#documentation": "

Information about the Traffic Mirror session.

", + "smithy.api#xmlName": "trafficMirrorSession" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

", + "smithy.api#xmlName": "clientToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateTrafficMirrorTarget": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateTrafficMirrorTargetRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateTrafficMirrorTargetResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a target for your Traffic Mirror session.

\n

A Traffic Mirror target is the destination for mirrored traffic. The Traffic Mirror source and\n the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in\n different VPCs connected via VPC peering or a transit gateway.

\n

A Traffic Mirror target can be a network interface, a Network Load Balancer, or a Gateway Load Balancer endpoint.

\n

To use the target in a Traffic Mirror session, use CreateTrafficMirrorSession.

" + } + }, + "com.amazonaws.ec2#CreateTrafficMirrorTargetRequest": { + "type": "structure", + "members": { + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "smithy.api#documentation": "

The network interface ID that is associated with the target.

" + } + }, + "NetworkLoadBalancerArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the target.

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The description of the Traffic Mirror target.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to the Traffic Mirror target.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "GatewayLoadBalancerEndpointId": { + "target": "com.amazonaws.ec2#VpcEndpointId", + "traits": { + "smithy.api#documentation": "

The ID of the Gateway Load Balancer endpoint.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateTrafficMirrorTargetResult": { + "type": "structure", + "members": { + "TrafficMirrorTarget": { + "target": "com.amazonaws.ec2#TrafficMirrorTarget", + "traits": { + "aws.protocols#ec2QueryName": "TrafficMirrorTarget", + "smithy.api#documentation": "

Information about the Traffic Mirror target.

", + "smithy.api#xmlName": "trafficMirrorTarget" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

", + "smithy.api#xmlName": "clientToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateTransitGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateTransitGatewayRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateTransitGatewayResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a transit gateway.

\n

You can use a transit gateway to interconnect your virtual private clouds (VPC) and on-premises networks.\n After the transit gateway enters the available state, you can attach your VPCs and VPN\n connections to the transit gateway.

\n

To attach your VPCs, use CreateTransitGatewayVpcAttachment.

\n

To attach a VPN connection, use CreateCustomerGateway to create a customer \n gateway and specify the ID of the customer gateway and the ID of the transit gateway in a call to\n CreateVpnConnection.

\n

When you create a transit gateway, we create a default transit gateway route table and use it as the default association route table\n and the default propagation route table. You can use CreateTransitGatewayRouteTable to create\n additional transit gateway route tables. If you disable automatic route propagation, we do not create a default transit gateway route table. \n You can use EnableTransitGatewayRouteTablePropagation to propagate routes from a resource \n attachment to a transit gateway route table. If you disable automatic associations, you can use AssociateTransitGatewayRouteTable to associate a resource attachment with a transit gateway route table.

" + } + }, + "com.amazonaws.ec2#CreateTransitGatewayConnect": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateTransitGatewayConnectRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateTransitGatewayConnectResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a Connect attachment from a specified transit gateway attachment. A Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a transit gateway and an appliance.

\n

A Connect attachment uses an existing VPC or Amazon Web Services Direct Connect attachment as the underlying transport mechanism.

" + } + }, + "com.amazonaws.ec2#CreateTransitGatewayConnectPeer": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateTransitGatewayConnectPeerRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateTransitGatewayConnectPeerResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a Connect peer for a specified transit gateway Connect attachment between a\n transit gateway and an appliance.

\n

The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).

\n

For more information, see Connect peers\n in the Amazon Web Services Transit Gateways Guide.

" + } + }, + "com.amazonaws.ec2#CreateTransitGatewayConnectPeerRequest": { + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Connect attachment.

", + "smithy.api#required": {} + } + }, + "TransitGatewayAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The peer IP address (GRE outer IP address) on the transit gateway side of the Connect peer, which must be\n specified from a transit gateway CIDR block. If not specified, Amazon automatically assigns\n the first available IP address from the transit gateway CIDR block.

" + } + }, + "PeerAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The peer IP address (GRE outer IP address) on the appliance side of the Connect peer.

", + "smithy.api#required": {} + } + }, + "BgpOptions": { + "target": "com.amazonaws.ec2#TransitGatewayConnectRequestBgpOptions", + "traits": { + "smithy.api#documentation": "

The BGP options for the Connect peer.

" + } + }, + "InsideCidrBlocks": { + "target": "com.amazonaws.ec2#InsideCidrBlocksStringList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The range of inside IP addresses that are used for BGP peering. You must specify a\n size /29 IPv4 CIDR block from the 169.254.0.0/16 range. The first address\n from the range must be configured on the appliance as the BGP IP address. You can also\n optionally specify a size /125 IPv6 CIDR block from the fd00::/8\n range.

", + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the Connect peer.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateTransitGatewayConnectPeerResult": { + "type": "structure", + "members": { + "TransitGatewayConnectPeer": { + "target": "com.amazonaws.ec2#TransitGatewayConnectPeer", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayConnectPeer", + "smithy.api#documentation": "

Information about the Connect peer.

", + "smithy.api#xmlName": "transitGatewayConnectPeer" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateTransitGatewayConnectRequest": { + "type": "structure", + "members": { + "TransportTransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway attachment. You can specify a VPC attachment or Amazon Web Services Direct Connect attachment.

", + "smithy.api#required": {} + } + }, + "Options": { + "target": "com.amazonaws.ec2#CreateTransitGatewayConnectRequestOptions", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Connect attachment options.

", + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the Connect attachment.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateTransitGatewayConnectRequestOptions": { + "type": "structure", + "members": { + "Protocol": { + "target": "com.amazonaws.ec2#ProtocolValue", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The tunnel protocol.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The options for a Connect attachment.

" + } + }, + "com.amazonaws.ec2#CreateTransitGatewayConnectResult": { + "type": "structure", + "members": { + "TransitGatewayConnect": { + "target": "com.amazonaws.ec2#TransitGatewayConnect", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayConnect", + "smithy.api#documentation": "

Information about the Connect attachment.

", + "smithy.api#xmlName": "transitGatewayConnect" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateTransitGatewayMulticastDomain": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateTransitGatewayMulticastDomainRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateTransitGatewayMulticastDomainResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a multicast domain using the specified transit gateway.

\n

The transit gateway must be in the available state before you create a domain. Use DescribeTransitGateways to see the state of transit gateway.

" + } + }, + "com.amazonaws.ec2#CreateTransitGatewayMulticastDomainRequest": { + "type": "structure", + "members": { + "TransitGatewayId": { + "target": "com.amazonaws.ec2#TransitGatewayId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway.

", + "smithy.api#required": {} + } + }, + "Options": { + "target": "com.amazonaws.ec2#CreateTransitGatewayMulticastDomainRequestOptions", + "traits": { + "smithy.api#documentation": "

The options for the transit gateway multicast domain.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags for the transit gateway multicast domain.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateTransitGatewayMulticastDomainRequestOptions": { + "type": "structure", + "members": { + "Igmpv2Support": { + "target": "com.amazonaws.ec2#Igmpv2SupportValue", + "traits": { + "smithy.api#documentation": "

Specify whether to enable Internet Group Management Protocol (IGMP) version 2 for the transit gateway multicast domain.

" + } + }, + "StaticSourcesSupport": { + "target": "com.amazonaws.ec2#StaticSourcesSupportValue", + "traits": { + "smithy.api#documentation": "

Specify whether to enable support for statically configuring multicast group sources for a domain.

" + } + }, + "AutoAcceptSharedAssociations": { + "target": "com.amazonaws.ec2#AutoAcceptSharedAssociationsValue", + "traits": { + "smithy.api#documentation": "

Indicates whether to automatically accept cross-account subnet associations that are associated with the transit gateway multicast domain.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options for the transit gateway multicast domain.

" + } + }, + "com.amazonaws.ec2#CreateTransitGatewayMulticastDomainResult": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomain": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomain", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayMulticastDomain", + "smithy.api#documentation": "

Information about the transit gateway multicast domain.

", + "smithy.api#xmlName": "transitGatewayMulticastDomain" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateTransitGatewayPeeringAttachment": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateTransitGatewayPeeringAttachmentRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateTransitGatewayPeeringAttachmentResult" + }, + "traits": { + "smithy.api#documentation": "

Requests a transit gateway peering attachment between the specified transit gateway\n (requester) and a peer transit gateway (accepter). The peer transit gateway can be in \n your account or a different Amazon Web Services account.

\n

After you create the peering attachment, the owner of the accepter transit gateway \n must accept the attachment request.

" + } + }, + "com.amazonaws.ec2#CreateTransitGatewayPeeringAttachmentRequest": { + "type": "structure", + "members": { + "TransitGatewayId": { + "target": "com.amazonaws.ec2#TransitGatewayId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway.

", + "smithy.api#required": {} + } + }, + "PeerTransitGatewayId": { + "target": "com.amazonaws.ec2#TransitAssociationGatewayId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the peer transit gateway with which to create the peering attachment.

", + "smithy.api#required": {} + } + }, + "PeerAccountId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the peer transit gateway.

", + "smithy.api#required": {} + } + }, + "PeerRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Region where the peer transit gateway is located.

", + "smithy.api#required": {} + } + }, + "Options": { + "target": "com.amazonaws.ec2#CreateTransitGatewayPeeringAttachmentRequestOptions", + "traits": { + "smithy.api#documentation": "

Requests a transit gateway peering attachment.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the transit gateway peering attachment.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateTransitGatewayPeeringAttachmentRequestOptions": { + "type": "structure", + "members": { + "DynamicRouting": { + "target": "com.amazonaws.ec2#DynamicRoutingValue", + "traits": { + "smithy.api#documentation": "

Indicates whether dynamic routing is enabled or disabled.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes whether dynamic routing is enabled or disabled for the transit gateway peering request.

" + } + }, + "com.amazonaws.ec2#CreateTransitGatewayPeeringAttachmentResult": { + "type": "structure", + "members": { + "TransitGatewayPeeringAttachment": { + "target": "com.amazonaws.ec2#TransitGatewayPeeringAttachment", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayPeeringAttachment", + "smithy.api#documentation": "

The transit gateway peering attachment.

", + "smithy.api#xmlName": "transitGatewayPeeringAttachment" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateTransitGatewayPolicyTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateTransitGatewayPolicyTableRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateTransitGatewayPolicyTableResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a transit gateway policy table.

" + } + }, + "com.amazonaws.ec2#CreateTransitGatewayPolicyTableRequest": { + "type": "structure", + "members": { + "TransitGatewayId": { + "target": "com.amazonaws.ec2#TransitGatewayId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway used for the policy table.

", + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags specification for the transit gateway policy table created during the request.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateTransitGatewayPolicyTableResult": { + "type": "structure", + "members": { + "TransitGatewayPolicyTable": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTable", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayPolicyTable", + "smithy.api#documentation": "

Describes the created transit gateway policy table.

", + "smithy.api#xmlName": "transitGatewayPolicyTable" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateTransitGatewayPrefixListReference": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateTransitGatewayPrefixListReferenceRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateTransitGatewayPrefixListReferenceResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a reference (route) to a prefix list in a specified transit gateway route table.

" + } + }, + "com.amazonaws.ec2#CreateTransitGatewayPrefixListReferenceRequest": { + "type": "structure", + "members": { + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway route table.

", + "smithy.api#required": {} + } + }, + "PrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the prefix list that is used for destination matches.

", + "smithy.api#required": {} + } + }, + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#documentation": "

The ID of the attachment to which traffic is routed.

" + } + }, + "Blackhole": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether to drop traffic that matches this route.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateTransitGatewayPrefixListReferenceResult": { + "type": "structure", + "members": { + "TransitGatewayPrefixListReference": { + "target": "com.amazonaws.ec2#TransitGatewayPrefixListReference", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayPrefixListReference", + "smithy.api#documentation": "

Information about the prefix list reference.

", + "smithy.api#xmlName": "transitGatewayPrefixListReference" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateTransitGatewayRequest": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description of the transit gateway.

" + } + }, + "Options": { + "target": "com.amazonaws.ec2#TransitGatewayRequestOptions", + "traits": { + "smithy.api#documentation": "

The transit gateway options.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the transit gateway.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateTransitGatewayResult": { + "type": "structure", + "members": { + "TransitGateway": { + "target": "com.amazonaws.ec2#TransitGateway", + "traits": { + "aws.protocols#ec2QueryName": "TransitGateway", + "smithy.api#documentation": "

Information about the transit gateway.

", + "smithy.api#xmlName": "transitGateway" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateTransitGatewayRoute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateTransitGatewayRouteRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateTransitGatewayRouteResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a static route for the specified transit gateway route table.

" + } + }, + "com.amazonaws.ec2#CreateTransitGatewayRouteRequest": { + "type": "structure", + "members": { + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The CIDR range used for destination matches. Routing decisions are based on the\n most specific match.

", + "smithy.api#required": {} + } + }, + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway route table.

", + "smithy.api#required": {} + } + }, + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#documentation": "

The ID of the attachment.

" + } + }, + "Blackhole": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether to drop traffic that matches this route.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateTransitGatewayRouteResult": { + "type": "structure", + "members": { + "Route": { + "target": "com.amazonaws.ec2#TransitGatewayRoute", + "traits": { + "aws.protocols#ec2QueryName": "Route", + "smithy.api#documentation": "

Information about the route.

", + "smithy.api#xmlName": "route" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateTransitGatewayRouteTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateTransitGatewayRouteTableRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateTransitGatewayRouteTableResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a route table for the specified transit gateway.

" + } + }, + "com.amazonaws.ec2#CreateTransitGatewayRouteTableAnnouncement": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateTransitGatewayRouteTableAnnouncementRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateTransitGatewayRouteTableAnnouncementResult" + }, + "traits": { + "smithy.api#documentation": "

Advertises a new transit gateway route table.

" + } + }, + "com.amazonaws.ec2#CreateTransitGatewayRouteTableAnnouncementRequest": { + "type": "structure", + "members": { + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway route table.

", + "smithy.api#required": {} + } + }, + "PeeringAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the peering attachment.

", + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags specifications applied to the transit gateway route table announcement.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateTransitGatewayRouteTableAnnouncementResult": { + "type": "structure", + "members": { + "TransitGatewayRouteTableAnnouncement": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncement", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTableAnnouncement", + "smithy.api#documentation": "

Provides details about the transit gateway route table announcement.

", + "smithy.api#xmlName": "transitGatewayRouteTableAnnouncement" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateTransitGatewayRouteTableRequest": { + "type": "structure", + "members": { + "TransitGatewayId": { + "target": "com.amazonaws.ec2#TransitGatewayId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway.

", + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the transit gateway route table.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateTransitGatewayRouteTableResult": { + "type": "structure", + "members": { + "TransitGatewayRouteTable": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTable", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTable", + "smithy.api#documentation": "

Information about the transit gateway route table.

", + "smithy.api#xmlName": "transitGatewayRouteTable" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateTransitGatewayVpcAttachment": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateTransitGatewayVpcAttachmentRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateTransitGatewayVpcAttachmentResult" + }, + "traits": { + "smithy.api#documentation": "

Attaches the specified VPC to the specified transit gateway.

\n

If you attach a VPC with a CIDR range that overlaps the CIDR range of a VPC that is already attached,\n the new VPC CIDR range is not propagated to the default propagation route table.

\n

To send VPC traffic to an attached transit gateway, add a route to the VPC route table using CreateRoute.

" + } + }, + "com.amazonaws.ec2#CreateTransitGatewayVpcAttachmentRequest": { + "type": "structure", + "members": { + "TransitGatewayId": { + "target": "com.amazonaws.ec2#TransitGatewayId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway.

", + "smithy.api#required": {} + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#required": {} + } + }, + "SubnetIds": { + "target": "com.amazonaws.ec2#TransitGatewaySubnetIdList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of one or more subnets. You can specify only one subnet per Availability Zone. \n You must specify at least one subnet, but we recommend that you specify two subnets for better availability.\n The transit gateway uses one IP address from each specified subnet.

", + "smithy.api#required": {} + } + }, + "Options": { + "target": "com.amazonaws.ec2#CreateTransitGatewayVpcAttachmentRequestOptions", + "traits": { + "smithy.api#documentation": "

The VPC attachment options.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the VPC attachment.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateTransitGatewayVpcAttachmentRequestOptions": { + "type": "structure", + "members": { + "DnsSupport": { + "target": "com.amazonaws.ec2#DnsSupportValue", + "traits": { + "smithy.api#documentation": "

Enable or disable DNS support. The default is enable.

" + } + }, + "SecurityGroupReferencingSupport": { + "target": "com.amazonaws.ec2#SecurityGroupReferencingSupportValue", + "traits": { + "smithy.api#documentation": "

Enables you to reference a security group across VPCs attached to a transit gateway to simplify security group management.

\n

This option is set to enable by default. However, at the transit gateway level the default is set to disable.

\n

For more information about security group referencing, see Security group referencing in the Amazon Web Services Transit Gateways Guide.

" + } + }, + "Ipv6Support": { + "target": "com.amazonaws.ec2#Ipv6SupportValue", + "traits": { + "smithy.api#documentation": "

Enable or disable IPv6 support. The default is disable.

" + } + }, + "ApplianceModeSupport": { + "target": "com.amazonaws.ec2#ApplianceModeSupportValue", + "traits": { + "smithy.api#documentation": "

Enable or disable support for appliance mode. If enabled, a traffic flow between a source and destination uses the same Availability Zone for the VPC attachment for the lifetime of that flow. The default is disable.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the options for a VPC attachment.

" + } + }, + "com.amazonaws.ec2#CreateTransitGatewayVpcAttachmentResult": { + "type": "structure", + "members": { + "TransitGatewayVpcAttachment": { + "target": "com.amazonaws.ec2#TransitGatewayVpcAttachment", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayVpcAttachment", + "smithy.api#documentation": "

Information about the VPC attachment.

", + "smithy.api#xmlName": "transitGatewayVpcAttachment" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateVerifiedAccessEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateVerifiedAccessEndpointRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateVerifiedAccessEndpointResult" + }, + "traits": { + "smithy.api#documentation": "

An Amazon Web Services Verified Access endpoint is where you define your application along with an optional endpoint-level access policy.

" + } + }, + "com.amazonaws.ec2#CreateVerifiedAccessEndpointCidrOptions": { + "type": "structure", + "members": { + "Protocol": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointProtocol", + "traits": { + "smithy.api#documentation": "

The protocol.

" + } + }, + "SubnetIds": { + "target": "com.amazonaws.ec2#CreateVerifiedAccessEndpointSubnetIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the subnets.

", + "smithy.api#xmlName": "SubnetId" + } + }, + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The CIDR.

" + } + }, + "PortRanges": { + "target": "com.amazonaws.ec2#CreateVerifiedAccessEndpointPortRangeList", + "traits": { + "smithy.api#documentation": "

The port ranges.

", + "smithy.api#xmlName": "PortRange" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the CIDR options for a Verified Access endpoint.

" + } + }, + "com.amazonaws.ec2#CreateVerifiedAccessEndpointEniOptions": { + "type": "structure", + "members": { + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "smithy.api#documentation": "

The ID of the network interface.

" + } + }, + "Protocol": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointProtocol", + "traits": { + "smithy.api#documentation": "

The IP protocol.

" + } + }, + "Port": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointPortNumber", + "traits": { + "smithy.api#documentation": "

The IP port number.

" + } + }, + "PortRanges": { + "target": "com.amazonaws.ec2#CreateVerifiedAccessEndpointPortRangeList", + "traits": { + "smithy.api#documentation": "

The port ranges.

", + "smithy.api#xmlName": "PortRange" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the network interface options when creating an Amazon Web Services Verified Access endpoint using the\n network-interface type.

" + } + }, + "com.amazonaws.ec2#CreateVerifiedAccessEndpointLoadBalancerOptions": { + "type": "structure", + "members": { + "Protocol": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointProtocol", + "traits": { + "smithy.api#documentation": "

The IP protocol.

" + } + }, + "Port": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointPortNumber", + "traits": { + "smithy.api#documentation": "

The IP port number.

" + } + }, + "LoadBalancerArn": { + "target": "com.amazonaws.ec2#LoadBalancerArn", + "traits": { + "smithy.api#documentation": "

The ARN of the load balancer.

" + } + }, + "SubnetIds": { + "target": "com.amazonaws.ec2#CreateVerifiedAccessEndpointSubnetIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the subnets.

", + "smithy.api#xmlName": "SubnetId" + } + }, + "PortRanges": { + "target": "com.amazonaws.ec2#CreateVerifiedAccessEndpointPortRangeList", + "traits": { + "smithy.api#documentation": "

The port ranges.

", + "smithy.api#xmlName": "PortRange" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the load balancer options when creating an Amazon Web Services Verified Access endpoint using the\n load-balancer type.

" + } + }, + "com.amazonaws.ec2#CreateVerifiedAccessEndpointPortRange": { + "type": "structure", + "members": { + "FromPort": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointPortNumber", + "traits": { + "smithy.api#documentation": "

The start of the port range.

" + } + }, + "ToPort": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointPortNumber", + "traits": { + "smithy.api#documentation": "

The end of the port range.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the port range for a Verified Access endpoint.

" + } + }, + "com.amazonaws.ec2#CreateVerifiedAccessEndpointPortRangeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CreateVerifiedAccessEndpointPortRange", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#CreateVerifiedAccessEndpointRdsOptions": { + "type": "structure", + "members": { + "Protocol": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointProtocol", + "traits": { + "smithy.api#documentation": "

The protocol.

" + } + }, + "Port": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointPortNumber", + "traits": { + "smithy.api#documentation": "

The port.

" + } + }, + "RdsDbInstanceArn": { + "target": "com.amazonaws.ec2#RdsDbInstanceArn", + "traits": { + "smithy.api#documentation": "

The ARN of the RDS instance.

" + } + }, + "RdsDbClusterArn": { + "target": "com.amazonaws.ec2#RdsDbClusterArn", + "traits": { + "smithy.api#documentation": "

The ARN of the DB cluster.

" + } + }, + "RdsDbProxyArn": { + "target": "com.amazonaws.ec2#RdsDbProxyArn", + "traits": { + "smithy.api#documentation": "

The ARN of the RDS proxy.

" + } + }, + "RdsEndpoint": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The RDS endpoint.

" + } + }, + "SubnetIds": { + "target": "com.amazonaws.ec2#CreateVerifiedAccessEndpointSubnetIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the subnets.

", + "smithy.api#xmlName": "SubnetId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the RDS options for a Verified Access endpoint.

" + } + }, + "com.amazonaws.ec2#CreateVerifiedAccessEndpointRequest": { + "type": "structure", + "members": { + "VerifiedAccessGroupId": { + "target": "com.amazonaws.ec2#VerifiedAccessGroupId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Verified Access group to associate the endpoint with.

", + "smithy.api#required": {} + } + }, + "EndpointType": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of Verified Access endpoint to create.

", + "smithy.api#required": {} + } + }, + "AttachmentType": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointAttachmentType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of attachment.

", + "smithy.api#required": {} + } + }, + "DomainCertificateArn": { + "target": "com.amazonaws.ec2#CertificateArn", + "traits": { + "smithy.api#documentation": "

The ARN of the public TLS/SSL certificate in Amazon Web Services Certificate Manager to associate with the endpoint.\n The CN in the certificate must match the DNS name your end users will use to reach your\n application.

" + } + }, + "ApplicationDomain": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The DNS name for users to reach your application.

" + } + }, + "EndpointDomainPrefix": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A custom identifier that is prepended to the DNS name that is generated for the\n endpoint.

" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.ec2#SecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the security groups to associate with the Verified Access endpoint. Required if AttachmentType is set to vpc.

", + "smithy.api#xmlName": "SecurityGroupId" + } + }, + "LoadBalancerOptions": { + "target": "com.amazonaws.ec2#CreateVerifiedAccessEndpointLoadBalancerOptions", + "traits": { + "smithy.api#documentation": "

The load balancer details. This parameter is required if the endpoint type is\n load-balancer.

" + } + }, + "NetworkInterfaceOptions": { + "target": "com.amazonaws.ec2#CreateVerifiedAccessEndpointEniOptions", + "traits": { + "smithy.api#documentation": "

The network interface details. This parameter is required if the endpoint type is\n network-interface.

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description for the Verified Access endpoint.

" + } + }, + "PolicyDocument": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Verified Access policy document.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to the Verified Access endpoint.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "SseSpecification": { + "target": "com.amazonaws.ec2#VerifiedAccessSseSpecificationRequest", + "traits": { + "smithy.api#documentation": "

The options for server side encryption.

" + } + }, + "RdsOptions": { + "target": "com.amazonaws.ec2#CreateVerifiedAccessEndpointRdsOptions", + "traits": { + "smithy.api#documentation": "

The RDS details. This parameter is required if the endpoint type is rds.

" + } + }, + "CidrOptions": { + "target": "com.amazonaws.ec2#CreateVerifiedAccessEndpointCidrOptions", + "traits": { + "smithy.api#documentation": "

The CIDR options. This parameter is required if the endpoint type is cidr.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateVerifiedAccessEndpointResult": { + "type": "structure", + "members": { + "VerifiedAccessEndpoint": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpoint", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessEndpoint", + "smithy.api#documentation": "

Details about the Verified Access endpoint.

", + "smithy.api#xmlName": "verifiedAccessEndpoint" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateVerifiedAccessEndpointSubnetIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#CreateVerifiedAccessGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateVerifiedAccessGroupRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateVerifiedAccessGroupResult" + }, + "traits": { + "smithy.api#documentation": "

An Amazon Web Services Verified Access group is a collection of Amazon Web Services Verified Access endpoints who's associated applications have\n similar security requirements. Each instance within a Verified Access group shares an Verified Access policy. For\n example, you can group all Verified Access instances associated with \"sales\" applications together and\n use one common Verified Access policy.

" + } + }, + "com.amazonaws.ec2#CreateVerifiedAccessGroupRequest": { + "type": "structure", + "members": { + "VerifiedAccessInstanceId": { + "target": "com.amazonaws.ec2#VerifiedAccessInstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Verified Access instance.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description for the Verified Access group.

" + } + }, + "PolicyDocument": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Verified Access policy document.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to the Verified Access group.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "SseSpecification": { + "target": "com.amazonaws.ec2#VerifiedAccessSseSpecificationRequest", + "traits": { + "smithy.api#documentation": "

The options for server side encryption.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateVerifiedAccessGroupResult": { + "type": "structure", + "members": { + "VerifiedAccessGroup": { + "target": "com.amazonaws.ec2#VerifiedAccessGroup", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessGroup", + "smithy.api#documentation": "

Details about the Verified Access group.

", + "smithy.api#xmlName": "verifiedAccessGroup" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateVerifiedAccessInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateVerifiedAccessInstanceRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateVerifiedAccessInstanceResult" + }, + "traits": { + "smithy.api#documentation": "

An Amazon Web Services Verified Access instance is a regional entity that evaluates application requests and grants\n access only when your security requirements are met.

" + } + }, + "com.amazonaws.ec2#CreateVerifiedAccessInstanceRequest": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description for the Verified Access instance.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to the Verified Access instance.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "FIPSEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Enable or disable support for Federal Information Processing Standards (FIPS) on the instance.

" + } + }, + "CidrEndpointsCustomSubDomain": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The custom subdomain.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateVerifiedAccessInstanceResult": { + "type": "structure", + "members": { + "VerifiedAccessInstance": { + "target": "com.amazonaws.ec2#VerifiedAccessInstance", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessInstance", + "smithy.api#documentation": "

Details about the Verified Access instance.

", + "smithy.api#xmlName": "verifiedAccessInstance" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateVerifiedAccessNativeApplicationOidcOptions": { + "type": "structure", + "members": { + "PublicSigningKeyEndpoint": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The public signing key endpoint.

" + } + }, + "Issuer": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The OIDC issuer identifier of the IdP.

" + } + }, + "AuthorizationEndpoint": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The authorization endpoint of the IdP.

" + } + }, + "TokenEndpoint": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token endpoint of the IdP.

" + } + }, + "UserInfoEndpoint": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The user info endpoint of the IdP.

" + } + }, + "ClientId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The OAuth 2.0 client identifier.

" + } + }, + "ClientSecret": { + "target": "com.amazonaws.ec2#ClientSecretType", + "traits": { + "smithy.api#documentation": "

The OAuth 2.0 client secret.

" + } + }, + "Scope": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The set of user claims to be requested from the IdP.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the OpenID Connect (OIDC) options.

" + } + }, + "com.amazonaws.ec2#CreateVerifiedAccessTrustProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateVerifiedAccessTrustProviderRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateVerifiedAccessTrustProviderResult" + }, + "traits": { + "smithy.api#documentation": "

A trust provider is a third-party entity that creates, maintains, and manages identity\n information for users and devices. When an application request is made, the identity\n information sent by the trust provider is evaluated by Verified Access before allowing or\n denying the application request.

" + } + }, + "com.amazonaws.ec2#CreateVerifiedAccessTrustProviderDeviceOptions": { + "type": "structure", + "members": { + "TenantId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ID of the tenant application with the device-identity provider.

" + } + }, + "PublicSigningKeyUrl": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

\n The URL Amazon Web Services Verified Access will use to verify the authenticity of the device tokens.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the options when creating an Amazon Web Services Verified Access trust provider using the\n device type.

" + } + }, + "com.amazonaws.ec2#CreateVerifiedAccessTrustProviderOidcOptions": { + "type": "structure", + "members": { + "Issuer": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The OIDC issuer.

" + } + }, + "AuthorizationEndpoint": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The OIDC authorization endpoint.

" + } + }, + "TokenEndpoint": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The OIDC token endpoint.

" + } + }, + "UserInfoEndpoint": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The OIDC user info endpoint.

" + } + }, + "ClientId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The client identifier.

" + } + }, + "ClientSecret": { + "target": "com.amazonaws.ec2#ClientSecretType", + "traits": { + "smithy.api#documentation": "

The client secret.

" + } + }, + "Scope": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

OpenID Connect (OIDC) scopes are used by an application during authentication to authorize access to a user's details. Each scope returns a specific set of user attributes.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the options when creating an Amazon Web Services Verified Access trust provider using the user\n type.

" + } + }, + "com.amazonaws.ec2#CreateVerifiedAccessTrustProviderRequest": { + "type": "structure", + "members": { + "TrustProviderType": { + "target": "com.amazonaws.ec2#TrustProviderType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of trust provider.

", + "smithy.api#required": {} + } + }, + "UserTrustProviderType": { + "target": "com.amazonaws.ec2#UserTrustProviderType", + "traits": { + "smithy.api#documentation": "

The type of user-based trust provider. This parameter is required when the provider type\n is user.

" + } + }, + "DeviceTrustProviderType": { + "target": "com.amazonaws.ec2#DeviceTrustProviderType", + "traits": { + "smithy.api#documentation": "

The type of device-based trust provider. This parameter is required when the provider\n type is device.

" + } + }, + "OidcOptions": { + "target": "com.amazonaws.ec2#CreateVerifiedAccessTrustProviderOidcOptions", + "traits": { + "smithy.api#documentation": "

The options for a OpenID Connect-compatible user-identity trust provider. This parameter\n is required when the provider type is user.

" + } + }, + "DeviceOptions": { + "target": "com.amazonaws.ec2#CreateVerifiedAccessTrustProviderDeviceOptions", + "traits": { + "smithy.api#documentation": "

The options for a device-based trust provider. This parameter is required when the\n provider type is device.

" + } + }, + "PolicyReferenceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier to be used when working with policy rules.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description for the Verified Access trust provider.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to the Verified Access trust provider.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "SseSpecification": { + "target": "com.amazonaws.ec2#VerifiedAccessSseSpecificationRequest", + "traits": { + "smithy.api#documentation": "

The options for server side encryption.

" + } + }, + "NativeApplicationOidcOptions": { + "target": "com.amazonaws.ec2#CreateVerifiedAccessNativeApplicationOidcOptions", + "traits": { + "smithy.api#documentation": "

The OpenID Connect (OIDC) options.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateVerifiedAccessTrustProviderResult": { + "type": "structure", + "members": { + "VerifiedAccessTrustProvider": { + "target": "com.amazonaws.ec2#VerifiedAccessTrustProvider", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessTrustProvider", + "smithy.api#documentation": "

Details about the Verified Access trust provider.

", + "smithy.api#xmlName": "verifiedAccessTrustProvider" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateVolume": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateVolumeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#Volume" + }, + "traits": { + "smithy.api#documentation": "

Creates an EBS volume that can be attached to an instance in the same Availability Zone.

\n

You can create a new empty volume or restore a volume from an EBS snapshot.\n Any Amazon Web Services Marketplace product codes from the snapshot are propagated to the volume.

\n

You can create encrypted volumes. Encrypted volumes must be attached to instances that \n support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically \n encrypted. For more information, see Amazon EBS encryption\n in the Amazon EBS User Guide.

\n

You can tag your volumes during creation. For more information, see Tag your Amazon EC2\n resources in the Amazon EC2 User Guide.

\n

For more information, see Create an Amazon EBS volume in the\n Amazon EBS User Guide.

", + "smithy.api#examples": [ + { + "title": "To create a new Provisioned IOPS (SSD) volume from a snapshot", + "documentation": "This example creates a new Provisioned IOPS (SSD) volume with 1000 provisioned IOPS from a snapshot in the Availability Zone ``us-east-1a``.", + "input": { + "AvailabilityZone": "us-east-1a", + "Iops": 1000, + "VolumeType": "io1", + "SnapshotId": "snap-066877671789bd71b" + }, + "output": { + "AvailabilityZone": "us-east-1a", + "Attachments": [], + "Tags": [], + "VolumeType": "io1", + "VolumeId": "vol-1234567890abcdef0", + "State": "creating", + "Iops": 1000, + "SnapshotId": "snap-066877671789bd71b", + "CreateTime": "2016-08-29T18:52:32.724Z", + "Size": 500 + } + }, + { + "title": "To create a new volume", + "documentation": "This example creates an 80 GiB General Purpose (SSD) volume in the Availability Zone ``us-east-1a``.", + "input": { + "AvailabilityZone": "us-east-1a", + "Size": 80, + "VolumeType": "gp2" + }, + "output": { + "AvailabilityZone": "us-east-1a", + "Encrypted": false, + "VolumeType": "gp2", + "VolumeId": "vol-6b60b7c7", + "State": "creating", + "Iops": 240, + "SnapshotId": "", + "CreateTime": "2016-08-29T18:52:32.724Z", + "Size": 80 + } + } + ] + } + }, + "com.amazonaws.ec2#CreateVolumePermission": { + "type": "structure", + "members": { + "UserId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "UserId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account to be added or removed.

", + "smithy.api#xmlName": "userId" + } + }, + "Group": { + "target": "com.amazonaws.ec2#PermissionGroup", + "traits": { + "aws.protocols#ec2QueryName": "Group", + "smithy.api#documentation": "

The group to be added or removed. The possible value is all.

", + "smithy.api#xmlName": "group" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the user or group to be added or removed from the list of create volume\n permissions for a volume.

" + } + }, + "com.amazonaws.ec2#CreateVolumePermissionList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CreateVolumePermission", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#CreateVolumePermissionModifications": { + "type": "structure", + "members": { + "Add": { + "target": "com.amazonaws.ec2#CreateVolumePermissionList", + "traits": { + "smithy.api#documentation": "

Adds the specified Amazon Web Services account ID or group to the list.

" + } + }, + "Remove": { + "target": "com.amazonaws.ec2#CreateVolumePermissionList", + "traits": { + "smithy.api#documentation": "

Removes the specified Amazon Web Services account ID or group from the list.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes modifications to the list of create volume permissions for a volume.

" + } + }, + "com.amazonaws.ec2#CreateVolumeRequest": { + "type": "structure", + "members": { + "AvailabilityZone": { + "target": "com.amazonaws.ec2#AvailabilityZoneName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Availability Zone in which to create the volume. For example, us-east-1a.

", + "smithy.api#required": {} + } + }, + "Encrypted": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Encrypted", + "smithy.api#documentation": "

Indicates whether the volume should be encrypted. \n The effect of setting the encryption state to true depends on \nthe volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. \n For more information, see Encryption by default\n in the Amazon EBS User Guide.

\n

Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. \n For more information, see Supported\n instance types.

", + "smithy.api#xmlName": "encrypted" + } + }, + "Iops": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents \n the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline \n performance of the volume and the rate at which the volume accumulates I/O credits for bursting.

\n

The following are the supported values for each volume type:

\n \n

For io2 volumes, you can achieve up to 256,000 IOPS on \ninstances \nbuilt on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.

\n

This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS.\n This parameter is not supported for gp2, st1, sc1, or standard volumes.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.ec2#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The identifier of the KMS key to use for Amazon EBS encryption.\n If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is\n specified, the encrypted state must be true.

\n

You can specify the KMS key using any of the following:

\n \n

Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, \n the action can appear to complete, but eventually fails.

" + } + }, + "OutpostArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost on which to create the volume.

\n

If you intend to use a volume with an instance running on an outpost, then you must \n create the volume on the same outpost as the instance. You can't use a volume created \n in an Amazon Web Services Region with an instance on an Amazon Web Services outpost, or the other way around.

" + } + }, + "Size": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size.\n If you specify a snapshot, the default is the snapshot size. You can specify a volume \n size that is equal to or larger than the snapshot size.

\n

The following are the supported volumes sizes for each volume type:

\n " + } + }, + "SnapshotId": { + "target": "com.amazonaws.ec2#SnapshotId", + "traits": { + "smithy.api#documentation": "

The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.

" + } + }, + "VolumeType": { + "target": "com.amazonaws.ec2#VolumeType", + "traits": { + "smithy.api#documentation": "

The volume type. This parameter can be one of the following values:

\n \n \n

Throughput Optimized HDD (st1) and Cold HDD (sc1) volumes can't be used as boot volumes.

\n \n

For more information, see Amazon EBS volume types in the\n Amazon EBS User Guide.

\n

Default: gp2\n

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the volume during creation.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "MultiAttachEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the \n volume to up to 16 Instances built on the Nitro System in the same Availability Zone. This parameter is \n \tsupported with io1 and io2 volumes only. For more information, \n \tsee \n \t\tAmazon EBS Multi-Attach in the Amazon EBS User Guide.

" + } + }, + "Throughput": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The throughput to provision for a volume, with a maximum of 1,000 MiB/s.

\n

This parameter is valid only for gp3 volumes.

\n

Valid Range: Minimum value of 125. Maximum value of 1000.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency \n of the request. For more information, see Ensure \n Idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "Operator": { + "target": "com.amazonaws.ec2#OperatorRequest", + "traits": { + "smithy.api#documentation": "

Reserved for internal use.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateVpc": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateVpcRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateVpcResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a VPC with the specified CIDR blocks. For more information, see IP addressing for your VPCs and subnets in the \n Amazon VPC User Guide.

\n

You can optionally request an IPv6 CIDR block for the VPC. You can request an\n Amazon-provided IPv6 CIDR block from Amazon's pool of IPv6 addresses or an IPv6 CIDR\n block from an IPv6 address pool that you provisioned through bring your own IP addresses\n (BYOIP).

\n

By default, each instance that you launch in the VPC has the default DHCP options, which\n\t\t\tinclude only a default DNS server that we provide (AmazonProvidedDNS). For more\n\t\t\tinformation, see DHCP option sets in the Amazon VPC User Guide.

\n

You can specify the instance tenancy value for the VPC when you create it. You can't change\n this value for the VPC after you create it. For more information, see Dedicated Instances in the\n Amazon EC2 User Guide.

", + "smithy.api#examples": [ + { + "title": "To create a VPC", + "documentation": "This example creates a VPC with the specified CIDR block.", + "input": { + "CidrBlock": "10.0.0.0/16" + }, + "output": { + "Vpc": { + "InstanceTenancy": "default", + "State": "pending", + "VpcId": "vpc-a01106c2", + "CidrBlock": "10.0.0.0/16", + "DhcpOptionsId": "dopt-7a8b9c2d" + } + } + } + ] + } + }, + "com.amazonaws.ec2#CreateVpcBlockPublicAccessExclusion": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateVpcBlockPublicAccessExclusionRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateVpcBlockPublicAccessExclusionResult" + }, + "traits": { + "smithy.api#documentation": "

Create a VPC Block Public Access (BPA) exclusion. A VPC BPA exclusion is a mode that can be applied to a single VPC or subnet that exempts it from the account’s BPA mode and will allow bidirectional or egress-only access. You can create BPA exclusions for VPCs and subnets even when BPA is not enabled on the account to ensure that there is no traffic disruption to the exclusions when VPC BPA is turned on. To learn more about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User Guide.

" + } + }, + "com.amazonaws.ec2#CreateVpcBlockPublicAccessExclusionRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "smithy.api#documentation": "

A subnet ID.

" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#documentation": "

A VPC ID.

" + } + }, + "InternetGatewayExclusionMode": { + "target": "com.amazonaws.ec2#InternetGatewayExclusionMode", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The exclusion mode for internet gateway traffic.

\n ", + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

\n tag - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

", + "smithy.api#xmlName": "TagSpecification" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateVpcBlockPublicAccessExclusionResult": { + "type": "structure", + "members": { + "VpcBlockPublicAccessExclusion": { + "target": "com.amazonaws.ec2#VpcBlockPublicAccessExclusion", + "traits": { + "aws.protocols#ec2QueryName": "VpcBlockPublicAccessExclusion", + "smithy.api#documentation": "

Details about an exclusion.

", + "smithy.api#xmlName": "vpcBlockPublicAccessExclusion" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateVpcEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateVpcEndpointRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateVpcEndpointResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a VPC endpoint. A VPC endpoint provides a private connection between the\n specified VPC and the specified endpoint service. You can use an endpoint service\n provided by Amazon Web Services, an Amazon Web Services Marketplace Partner, or another\n Amazon Web Services account. For more information, see the Amazon Web Services PrivateLink User Guide.

" + } + }, + "com.amazonaws.ec2#CreateVpcEndpointConnectionNotification": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateVpcEndpointConnectionNotificationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateVpcEndpointConnectionNotificationResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a connection notification for a specified VPC endpoint or VPC endpoint\n service. A connection notification notifies you of specific endpoint events. You must\n create an SNS topic to receive notifications. For more information, see Creating an Amazon SNS topic in\n the Amazon SNS Developer Guide.

\n

You can create a connection notification for interface endpoints only.

" + } + }, + "com.amazonaws.ec2#CreateVpcEndpointConnectionNotificationRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ServiceId": { + "target": "com.amazonaws.ec2#VpcEndpointServiceId", + "traits": { + "smithy.api#documentation": "

The ID of the endpoint service.

" + } + }, + "VpcEndpointId": { + "target": "com.amazonaws.ec2#VpcEndpointId", + "traits": { + "smithy.api#documentation": "

The ID of the endpoint.

" + } + }, + "ConnectionNotificationArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the SNS topic for the notifications.

", + "smithy.api#required": {} + } + }, + "ConnectionEvents": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The endpoint events for which to receive notifications. Valid values are\n Accept, Connect, Delete, and\n Reject.

", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateVpcEndpointConnectionNotificationResult": { + "type": "structure", + "members": { + "ConnectionNotification": { + "target": "com.amazonaws.ec2#ConnectionNotification", + "traits": { + "aws.protocols#ec2QueryName": "ConnectionNotification", + "smithy.api#documentation": "

Information about the notification.

", + "smithy.api#xmlName": "connectionNotification" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", + "smithy.api#xmlName": "clientToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateVpcEndpointRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "VpcEndpointType": { + "target": "com.amazonaws.ec2#VpcEndpointType", + "traits": { + "smithy.api#documentation": "

The type of endpoint.

\n

Default: Gateway

" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#required": {} + } + }, + "ServiceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the endpoint service.

" + } + }, + "PolicyDocument": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

(Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the\n service. The policy must be in valid JSON format. If this parameter is not specified, we\n attach a default policy that allows full access to the service.

" + } + }, + "RouteTableIds": { + "target": "com.amazonaws.ec2#VpcEndpointRouteTableIdList", + "traits": { + "smithy.api#documentation": "

(Gateway endpoint) The route table IDs.

", + "smithy.api#xmlName": "RouteTableId" + } + }, + "SubnetIds": { + "target": "com.amazonaws.ec2#VpcEndpointSubnetIdList", + "traits": { + "smithy.api#documentation": "

(Interface and Gateway Load Balancer endpoints) The IDs of the subnets in which to create endpoint\n network interfaces. For a Gateway Load Balancer endpoint, you can specify only one subnet.

", + "smithy.api#xmlName": "SubnetId" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.ec2#VpcEndpointSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

(Interface endpoint) The IDs of the security groups to associate with the\n endpoint network interfaces. If this parameter is not specified, we use the default \n security group for the VPC.

", + "smithy.api#xmlName": "SecurityGroupId" + } + }, + "IpAddressType": { + "target": "com.amazonaws.ec2#IpAddressType", + "traits": { + "smithy.api#documentation": "

The IP address type for the endpoint.

" + } + }, + "DnsOptions": { + "target": "com.amazonaws.ec2#DnsOptionsSpecification", + "traits": { + "smithy.api#documentation": "

The DNS options for the endpoint.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.

" + } + }, + "PrivateDnsEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

(Interface endpoint) Indicates whether to associate a private hosted zone with the\n specified VPC. The private hosted zone contains a record set for the default public DNS\n name for the service for the Region (for example,\n kinesis.us-east-1.amazonaws.com), which resolves to the private IP\n addresses of the endpoint network interfaces in the VPC. This enables you to make\n requests to the default public DNS name for the service instead of the public DNS names\n that are automatically generated by the VPC endpoint service.

\n

To use a private hosted zone, you must set the following VPC attributes to\n true: enableDnsHostnames and\n enableDnsSupport. Use ModifyVpcAttribute to set the VPC\n attributes.

\n

Default: true\n

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to associate with the endpoint.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "SubnetConfigurations": { + "target": "com.amazonaws.ec2#SubnetConfigurationsList", + "traits": { + "smithy.api#documentation": "

The subnet configurations for the endpoint.

", + "smithy.api#xmlName": "SubnetConfiguration" + } + }, + "ServiceNetworkArn": { + "target": "com.amazonaws.ec2#ServiceNetworkArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a service network that will be associated with the VPC\n endpoint of type service-network.

" + } + }, + "ResourceConfigurationArn": { + "target": "com.amazonaws.ec2#ResourceConfigurationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a resource configuration that will be associated with\n the VPC endpoint of type resource.

" + } + }, + "ServiceRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Region where the service is hosted. The default is the current Region.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateVpcEndpointResult": { + "type": "structure", + "members": { + "VpcEndpoint": { + "target": "com.amazonaws.ec2#VpcEndpoint", + "traits": { + "aws.protocols#ec2QueryName": "VpcEndpoint", + "smithy.api#documentation": "

Information about the endpoint.

", + "smithy.api#xmlName": "vpcEndpoint" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", + "smithy.api#xmlName": "clientToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateVpcEndpointServiceConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateVpcEndpointServiceConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateVpcEndpointServiceConfigurationResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a VPC endpoint service to which service consumers (Amazon Web Services accounts,\n users, and IAM roles) can connect.

\n

Before you create an endpoint service, you must create one of the following for your service:

\n \n

If you set the private DNS name, you must prove that you own the private DNS domain\n name.

\n

For more information, see the Amazon Web Services PrivateLink \n\t Guide.

" + } + }, + "com.amazonaws.ec2#CreateVpcEndpointServiceConfigurationRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "AcceptanceRequired": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether requests from service consumers to create an endpoint to your service must\n be accepted manually.

" + } + }, + "PrivateDnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

(Interface endpoint configuration) The private DNS name to assign to the VPC endpoint service.

" + } + }, + "NetworkLoadBalancerArns": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the Network Load Balancers.

", + "smithy.api#xmlName": "NetworkLoadBalancerArn" + } + }, + "GatewayLoadBalancerArns": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the Gateway Load Balancers.

", + "smithy.api#xmlName": "GatewayLoadBalancerArn" + } + }, + "SupportedIpAddressTypes": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The supported IP address types. The possible values are ipv4 and ipv6.

", + "smithy.api#xmlName": "SupportedIpAddressType" + } + }, + "SupportedRegions": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The Regions from which service consumers can access the service.

", + "smithy.api#xmlName": "SupportedRegion" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.\n For more information, see How to ensure\n idempotency.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to associate with the service.

", + "smithy.api#xmlName": "TagSpecification" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateVpcEndpointServiceConfigurationResult": { + "type": "structure", + "members": { + "ServiceConfiguration": { + "target": "com.amazonaws.ec2#ServiceConfiguration", + "traits": { + "aws.protocols#ec2QueryName": "ServiceConfiguration", + "smithy.api#documentation": "

Information about the service configuration.

", + "smithy.api#xmlName": "serviceConfiguration" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", + "smithy.api#xmlName": "clientToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateVpcPeeringConnection": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateVpcPeeringConnectionRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateVpcPeeringConnectionResult" + }, + "traits": { + "smithy.api#documentation": "

Requests a VPC peering connection between two VPCs: a requester VPC that you own and\n\t\t an accepter VPC with which to create the connection. The accepter VPC can belong to\n\t\t another Amazon Web Services account and can be in a different Region to the requester VPC. \n The requester VPC and accepter VPC cannot have overlapping CIDR blocks.

\n \n

Limitations and rules apply to a VPC peering connection. For more information, see \n the VPC peering limitations in the VPC Peering Guide.

\n \n

The owner of the accepter VPC must accept the peering request to activate the peering\n connection. The VPC peering connection request expires after 7 days, after which it\n cannot be accepted or rejected.

\n

If you create a VPC peering connection request between VPCs with overlapping CIDR\n blocks, the VPC peering connection has a status of failed.

" + } + }, + "com.amazonaws.ec2#CreateVpcPeeringConnectionRequest": { + "type": "structure", + "members": { + "PeerRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Region code for the accepter VPC, if the accepter VPC is located in a Region\n other than the Region in which you make the request.

\n

Default: The Region in which you make the request.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to the peering connection.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the requester VPC. You must specify this parameter in the\n\t\t\trequest.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "vpcId" + } + }, + "PeerVpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PeerVpcId", + "smithy.api#documentation": "

The ID of the VPC with which you are creating the VPC peering connection. You must\n\t\t\tspecify this parameter in the request.

", + "smithy.api#xmlName": "peerVpcId" + } + }, + "PeerOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PeerOwnerId", + "smithy.api#documentation": "

The Amazon Web Services account ID of the owner of the accepter VPC.

\n

Default: Your Amazon Web Services account ID

", + "smithy.api#xmlName": "peerOwnerId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateVpcPeeringConnectionResult": { + "type": "structure", + "members": { + "VpcPeeringConnection": { + "target": "com.amazonaws.ec2#VpcPeeringConnection", + "traits": { + "aws.protocols#ec2QueryName": "VpcPeeringConnection", + "smithy.api#documentation": "

Information about the VPC peering connection.

", + "smithy.api#xmlName": "vpcPeeringConnection" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateVpcRequest": { + "type": "structure", + "members": { + "CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IPv4 network range for the VPC, in CIDR notation. For example,\n\t\t 10.0.0.0/16. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.

" + } + }, + "Ipv6Pool": { + "target": "com.amazonaws.ec2#Ipv6PoolEc2Id", + "traits": { + "smithy.api#documentation": "

The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.

" + } + }, + "Ipv6CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request.

\n

To let Amazon choose the IPv6 CIDR block for you, omit this parameter.

" + } + }, + "Ipv4IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "smithy.api#documentation": "

The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.\n \n

" + } + }, + "Ipv4NetmaskLength": { + "target": "com.amazonaws.ec2#NetmaskLength", + "traits": { + "smithy.api#documentation": "

The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.

" + } + }, + "Ipv6IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "smithy.api#documentation": "

The ID of an IPv6 IPAM pool which will be used to allocate this VPC an IPv6 CIDR. IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.

" + } + }, + "Ipv6NetmaskLength": { + "target": "com.amazonaws.ec2#NetmaskLength", + "traits": { + "smithy.api#documentation": "

The netmask length of the IPv6 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.

" + } + }, + "Ipv6CidrBlockNetworkBorderGroup": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the address to this location.

\n

You must set AmazonProvidedIpv6CidrBlock to true to use this parameter.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to the VPC.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "InstanceTenancy": { + "target": "com.amazonaws.ec2#Tenancy", + "traits": { + "aws.protocols#ec2QueryName": "InstanceTenancy", + "smithy.api#documentation": "

The tenancy options for instances launched into the VPC. For default, instances\n are launched with shared tenancy by default. You can launch instances with any tenancy into a\n shared tenancy VPC. For dedicated, instances are launched as dedicated tenancy\n instances by default. You can only launch instances with a tenancy of dedicated\n or host into a dedicated tenancy VPC.

\n

\n Important: The host value cannot be used with this parameter. Use the default or dedicated values only.

\n

Default: default\n

", + "smithy.api#xmlName": "instanceTenancy" + } + }, + "AmazonProvidedIpv6CidrBlock": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "AmazonProvidedIpv6CidrBlock", + "smithy.api#documentation": "

Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC.\n You cannot specify the range of IP addresses, or the size of the CIDR block.

", + "smithy.api#xmlName": "amazonProvidedIpv6CidrBlock" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateVpcResult": { + "type": "structure", + "members": { + "Vpc": { + "target": "com.amazonaws.ec2#Vpc", + "traits": { + "aws.protocols#ec2QueryName": "Vpc", + "smithy.api#documentation": "

Information about the VPC.

", + "smithy.api#xmlName": "vpc" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateVpnConnection": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateVpnConnectionRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateVpnConnectionResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a VPN connection between an existing virtual private gateway or transit\n gateway and a customer gateway. The supported connection type is\n ipsec.1.

\n

The response includes information that you need to give to your network administrator\n to configure your customer gateway.

\n \n

We strongly recommend that you use HTTPS when calling this operation because the\n response contains sensitive cryptographic information for configuring your customer\n gateway device.

\n \n

If you decide to shut down your VPN connection for any reason and later create a new\n VPN connection, you must reconfigure your customer gateway with the new information\n returned from this call.

\n

This is an idempotent operation. If you perform the operation more than once, Amazon\n EC2 doesn't return an error.

\n

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.

" + } + }, + "com.amazonaws.ec2#CreateVpnConnectionRequest": { + "type": "structure", + "members": { + "CustomerGatewayId": { + "target": "com.amazonaws.ec2#CustomerGatewayId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the customer gateway.

", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of VPN connection (ipsec.1).

", + "smithy.api#required": {} + } + }, + "VpnGatewayId": { + "target": "com.amazonaws.ec2#VpnGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the virtual private gateway. If you specify a virtual private gateway, you\n cannot specify a transit gateway.

" + } + }, + "TransitGatewayId": { + "target": "com.amazonaws.ec2#TransitGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the transit gateway. If you specify a transit gateway, you cannot specify a virtual private\n gateway.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the VPN connection.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "Options": { + "target": "com.amazonaws.ec2#VpnConnectionOptionsSpecification", + "traits": { + "aws.protocols#ec2QueryName": "Options", + "smithy.api#documentation": "

The options for the VPN connection.

", + "smithy.api#xmlName": "options" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for CreateVpnConnection.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateVpnConnectionResult": { + "type": "structure", + "members": { + "VpnConnection": { + "target": "com.amazonaws.ec2#VpnConnection", + "traits": { + "aws.protocols#ec2QueryName": "VpnConnection", + "smithy.api#documentation": "

Information about the VPN connection.

", + "smithy.api#xmlName": "vpnConnection" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of CreateVpnConnection.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateVpnConnectionRoute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateVpnConnectionRouteRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Creates a static route associated with a VPN connection between an existing virtual\n private gateway and a VPN customer gateway. The static route allows traffic to be routed\n from the virtual private gateway to the VPN customer gateway.

\n

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.

" + } + }, + "com.amazonaws.ec2#CreateVpnConnectionRouteRequest": { + "type": "structure", + "members": { + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The CIDR block associated with the local subnet of the customer network.

", + "smithy.api#required": {} + } + }, + "VpnConnectionId": { + "target": "com.amazonaws.ec2#VpnConnectionId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPN connection.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for CreateVpnConnectionRoute.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateVpnGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateVpnGatewayRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateVpnGatewayResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a virtual private gateway. A virtual private gateway is the endpoint on the\n VPC side of your VPN connection. You can create a virtual private gateway before\n creating the VPC itself.

\n

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.

" + } + }, + "com.amazonaws.ec2#CreateVpnGatewayRequest": { + "type": "structure", + "members": { + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone for the virtual private gateway.

" + } + }, + "Type": { + "target": "com.amazonaws.ec2#GatewayType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of VPN connection this virtual private gateway supports.

", + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the virtual private gateway.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "AmazonSideAsn": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "smithy.api#documentation": "

A private Autonomous System Number (ASN) for the Amazon side of a BGP session. If\n you're using a 16-bit ASN, it must be in the 64512 to 65534 range. If you're using a\n 32-bit ASN, it must be in the 4200000000 to 4294967294 range.

\n

Default: 64512

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for CreateVpnGateway.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateVpnGatewayResult": { + "type": "structure", + "members": { + "VpnGateway": { + "target": "com.amazonaws.ec2#VpnGateway", + "traits": { + "aws.protocols#ec2QueryName": "VpnGateway", + "smithy.api#documentation": "

Information about the virtual private gateway.

", + "smithy.api#xmlName": "vpnGateway" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of CreateVpnGateway.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreditSpecification": { + "type": "structure", + "members": { + "CpuCredits": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CpuCredits", + "smithy.api#documentation": "

The credit option for CPU usage of a T instance.

\n

Valid values: standard | unlimited\n

", + "smithy.api#xmlName": "cpuCredits" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the credit option for CPU usage of a T instance.

" + } + }, + "com.amazonaws.ec2#CreditSpecificationRequest": { + "type": "structure", + "members": { + "CpuCredits": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The credit option for CPU usage of a T instance.

\n

Valid values: standard | unlimited\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The credit option for CPU usage of a T instance.

" + } + }, + "com.amazonaws.ec2#CurrencyCodeValues": { + "type": "enum", + "members": { + "USD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USD" + } + } + } + }, + "com.amazonaws.ec2#CurrentGenerationFlag": { + "type": "boolean" + }, + "com.amazonaws.ec2#CustomerGateway": { + "type": "structure", + "members": { + "CertificateArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CertificateArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the customer gateway certificate.

", + "smithy.api#xmlName": "certificateArn" + } + }, + "DeviceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DeviceName", + "smithy.api#documentation": "

The name of customer gateway device.

", + "smithy.api#xmlName": "deviceName" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the customer gateway.

", + "smithy.api#xmlName": "tagSet" + } + }, + "BgpAsnExtended": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "BgpAsnExtended", + "smithy.api#documentation": "

The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number\n (ASN).

\n

Valid values: 2,147,483,648 to 4,294,967,295\n

", + "smithy.api#xmlName": "bgpAsnExtended" + } + }, + "CustomerGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CustomerGatewayId", + "smithy.api#documentation": "

The ID of the customer gateway.

", + "smithy.api#xmlName": "customerGatewayId" + } + }, + "State": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of the customer gateway (pending | available | deleting |\n deleted).

", + "smithy.api#xmlName": "state" + } + }, + "Type": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Type", + "smithy.api#documentation": "

The type of VPN connection the customer gateway supports\n (ipsec.1).

", + "smithy.api#xmlName": "type" + } + }, + "IpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IpAddress", + "smithy.api#documentation": "

\n IPv4 address for the customer gateway device's outside interface. The address must be static. If OutsideIpAddressType in your VPN connection options is set to PrivateIpv4, you can use an RFC6598 or RFC1918 private IPv4 address. If OutsideIpAddressType is set to PublicIpv4, you can use a public IPv4 address.\n

", + "smithy.api#xmlName": "ipAddress" + } + }, + "BgpAsn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "BgpAsn", + "smithy.api#documentation": "

The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number\n (ASN).

\n

Valid values: 1 to 2,147,483,647\n

", + "smithy.api#xmlName": "bgpAsn" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a customer gateway.

" + } + }, + "com.amazonaws.ec2#CustomerGatewayId": { + "type": "string" + }, + "com.amazonaws.ec2#CustomerGatewayIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CustomerGatewayId", + "traits": { + "smithy.api#xmlName": "CustomerGatewayId" + } + } + }, + "com.amazonaws.ec2#CustomerGatewayList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CustomerGateway", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#DITMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 100 + } + } + }, + "com.amazonaws.ec2#DITOMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DataQueries": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#DataQuery" + } + }, + "com.amazonaws.ec2#DataQuery": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A user-defined ID associated with a data query that's returned in the dataResponse identifying the query. For example, if you set the Id to MyQuery01in the query, the dataResponse identifies the query as MyQuery01.

" + } + }, + "Source": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Region or Availability Zone that's the source for the data query. For example, us-east-1.

" + } + }, + "Destination": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Region or Availability Zone that's the target for the data query. For example, eu-north-1.

" + } + }, + "Metric": { + "target": "com.amazonaws.ec2#MetricType", + "traits": { + "smithy.api#documentation": "

The metric used for the network performance request.

" + } + }, + "Statistic": { + "target": "com.amazonaws.ec2#StatisticType", + "traits": { + "smithy.api#documentation": "

The metric data aggregation period, p50, between the specified startDate \n and endDate. For example, a metric of five_minutes is the median of all \n the data points gathered within those five minutes. p50 is the only supported metric.

" + } + }, + "Period": { + "target": "com.amazonaws.ec2#PeriodType", + "traits": { + "smithy.api#documentation": "

The aggregation period used for the data query.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A query used for retrieving network health data.

" + } + }, + "com.amazonaws.ec2#DataResponse": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Id", + "smithy.api#documentation": "

The ID passed in the DataQuery.

", + "smithy.api#xmlName": "id" + } + }, + "Source": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Source", + "smithy.api#documentation": "

The Region or Availability Zone that's the source for the data query. For example, us-east-1.

", + "smithy.api#xmlName": "source" + } + }, + "Destination": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Destination", + "smithy.api#documentation": "

The Region or Availability Zone that's the destination for the data query. For example, eu-west-1.

", + "smithy.api#xmlName": "destination" + } + }, + "Metric": { + "target": "com.amazonaws.ec2#MetricType", + "traits": { + "aws.protocols#ec2QueryName": "Metric", + "smithy.api#documentation": "

The metric used for the network performance request.

", + "smithy.api#xmlName": "metric" + } + }, + "Statistic": { + "target": "com.amazonaws.ec2#StatisticType", + "traits": { + "aws.protocols#ec2QueryName": "Statistic", + "smithy.api#documentation": "

The statistic used for the network performance request.

", + "smithy.api#xmlName": "statistic" + } + }, + "Period": { + "target": "com.amazonaws.ec2#PeriodType", + "traits": { + "aws.protocols#ec2QueryName": "Period", + "smithy.api#documentation": "

The period used for the network performance request.

", + "smithy.api#xmlName": "period" + } + }, + "MetricPoints": { + "target": "com.amazonaws.ec2#MetricPoints", + "traits": { + "aws.protocols#ec2QueryName": "MetricPointSet", + "smithy.api#documentation": "

A list of MetricPoint objects.

", + "smithy.api#xmlName": "metricPointSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

The response to a DataQuery.

" + } + }, + "com.amazonaws.ec2#DataResponses": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#DataResponse", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#DatafeedSubscriptionState": { + "type": "enum", + "members": { + "Active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active" + } + }, + "Inactive": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Inactive" + } + } + } + }, + "com.amazonaws.ec2#DateTime": { + "type": "timestamp" + }, + "com.amazonaws.ec2#DeclarativePoliciesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DeclarativePoliciesReport": { + "type": "structure", + "members": { + "ReportId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ReportId", + "smithy.api#documentation": "

The ID of the report.

", + "smithy.api#xmlName": "reportId" + } + }, + "S3Bucket": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "S3Bucket", + "smithy.api#documentation": "

The name of the Amazon S3 bucket where the report is located.

", + "smithy.api#xmlName": "s3Bucket" + } + }, + "S3Prefix": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "S3Prefix", + "smithy.api#documentation": "

The prefix for your S3 object.

", + "smithy.api#xmlName": "s3Prefix" + } + }, + "TargetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TargetId", + "smithy.api#documentation": "

The root ID, organizational unit ID, or account ID.

\n

Format:

\n ", + "smithy.api#xmlName": "targetId" + } + }, + "StartTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "StartTime", + "smithy.api#documentation": "

The time when the report generation started.

", + "smithy.api#xmlName": "startTime" + } + }, + "EndTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "EndTime", + "smithy.api#documentation": "

The time when the report generation ended.

", + "smithy.api#xmlName": "endTime" + } + }, + "Status": { + "target": "com.amazonaws.ec2#ReportState", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The current status of the report.

", + "smithy.api#xmlName": "status" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the report.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the metadata of the account status report.

" + } + }, + "com.amazonaws.ec2#DeclarativePoliciesReportId": { + "type": "string" + }, + "com.amazonaws.ec2#DeclarativePoliciesReportList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#DeclarativePoliciesReport", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#DedicatedHostFlag": { + "type": "boolean" + }, + "com.amazonaws.ec2#DedicatedHostId": { + "type": "string" + }, + "com.amazonaws.ec2#DedicatedHostIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#DedicatedHostId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#DefaultInstanceMetadataEndpointState": { + "type": "enum", + "members": { + "disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + }, + "enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + }, + "no_preference": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "no-preference" + } + } + } + }, + "com.amazonaws.ec2#DefaultInstanceMetadataTagsState": { + "type": "enum", + "members": { + "disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + }, + "enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + }, + "no_preference": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "no-preference" + } + } + } + }, + "com.amazonaws.ec2#DefaultNetworkCardIndex": { + "type": "integer" + }, + "com.amazonaws.ec2#DefaultRouteTableAssociationValue": { + "type": "enum", + "members": { + "enable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enable" + } + }, + "disable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disable" + } + } + } + }, + "com.amazonaws.ec2#DefaultRouteTablePropagationValue": { + "type": "enum", + "members": { + "enable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enable" + } + }, + "disable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disable" + } + } + } + }, + "com.amazonaws.ec2#DefaultTargetCapacityType": { + "type": "enum", + "members": { + "SPOT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "spot" + } + }, + "ON_DEMAND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "on-demand" + } + }, + "CAPACITY_BLOCK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "capacity-block" + } + } + } + }, + "com.amazonaws.ec2#DefaultingDhcpOptionsId": { + "type": "string" + }, + "com.amazonaws.ec2#DeleteCarrierGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteCarrierGatewayRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteCarrierGatewayResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes a carrier gateway.

\n \n

If you do not delete the route that contains the carrier gateway as the\n Target, the route is a blackhole route. For information about how to delete a route, see \n DeleteRoute.

\n " + } + }, + "com.amazonaws.ec2#DeleteCarrierGatewayRequest": { + "type": "structure", + "members": { + "CarrierGatewayId": { + "target": "com.amazonaws.ec2#CarrierGatewayId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the carrier gateway.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteCarrierGatewayResult": { + "type": "structure", + "members": { + "CarrierGateway": { + "target": "com.amazonaws.ec2#CarrierGateway", + "traits": { + "aws.protocols#ec2QueryName": "CarrierGateway", + "smithy.api#documentation": "

Information about the carrier gateway.

", + "smithy.api#xmlName": "carrierGateway" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteClientVpnEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteClientVpnEndpointRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteClientVpnEndpointResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified Client VPN endpoint. You must disassociate all target networks before you \n\t\t\tcan delete a Client VPN endpoint.

" + } + }, + "com.amazonaws.ec2#DeleteClientVpnEndpointRequest": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#ClientVpnEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Client VPN to be deleted.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteClientVpnEndpointResult": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.ec2#ClientVpnEndpointStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The current state of the Client VPN endpoint.

", + "smithy.api#xmlName": "status" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteClientVpnRoute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteClientVpnRouteRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteClientVpnRouteResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes a route from a Client VPN endpoint. You can only delete routes that you manually added using \n\t\t\tthe CreateClientVpnRoute action. You cannot delete routes that were \n\t\t\tautomatically added when associating a subnet. To remove routes that have been automatically added, \n\t\t\tdisassociate the target subnet from the Client VPN endpoint.

" + } + }, + "com.amazonaws.ec2#DeleteClientVpnRouteRequest": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#ClientVpnEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Client VPN endpoint from which the route is to be deleted.

", + "smithy.api#required": {} + } + }, + "TargetVpcSubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "smithy.api#documentation": "

The ID of the target subnet used by the route.

" + } + }, + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IPv4 address range, in CIDR notation, of the route to be deleted.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteClientVpnRouteResult": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.ec2#ClientVpnRouteStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The current state of the route.

", + "smithy.api#xmlName": "status" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteCoipCidr": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteCoipCidrRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteCoipCidrResult" + }, + "traits": { + "smithy.api#documentation": "

\n Deletes a range of customer-owned IP addresses.\n

" + } + }, + "com.amazonaws.ec2#DeleteCoipCidrRequest": { + "type": "structure", + "members": { + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A customer-owned IP address range that you want to delete.

", + "smithy.api#required": {} + } + }, + "CoipPoolId": { + "target": "com.amazonaws.ec2#Ipv4PoolCoipId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

\n The ID of the customer-owned address pool. \n

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteCoipCidrResult": { + "type": "structure", + "members": { + "CoipCidr": { + "target": "com.amazonaws.ec2#CoipCidr", + "traits": { + "aws.protocols#ec2QueryName": "CoipCidr", + "smithy.api#documentation": "

\n Information about a range of customer-owned IP addresses.\n

", + "smithy.api#xmlName": "coipCidr" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteCoipPool": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteCoipPoolRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteCoipPoolResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes a pool of customer-owned IP (CoIP) addresses.

" + } + }, + "com.amazonaws.ec2#DeleteCoipPoolRequest": { + "type": "structure", + "members": { + "CoipPoolId": { + "target": "com.amazonaws.ec2#Ipv4PoolCoipId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the CoIP pool that you want to delete.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteCoipPoolResult": { + "type": "structure", + "members": { + "CoipPool": { + "target": "com.amazonaws.ec2#CoipPool", + "traits": { + "aws.protocols#ec2QueryName": "CoipPool", + "smithy.api#documentation": "

Information about the CoIP address pool.

", + "smithy.api#xmlName": "coipPool" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteCustomerGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteCustomerGatewayRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified customer gateway. You must delete the VPN connection before you\n can delete the customer gateway.

", + "smithy.api#examples": [ + { + "title": "To delete a customer gateway", + "documentation": "This example deletes the specified customer gateway.", + "input": { + "CustomerGatewayId": "cgw-0e11f167" + } + } + ] + } + }, + "com.amazonaws.ec2#DeleteCustomerGatewayRequest": { + "type": "structure", + "members": { + "CustomerGatewayId": { + "target": "com.amazonaws.ec2#CustomerGatewayId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the customer gateway.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DeleteCustomerGateway.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteDhcpOptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteDhcpOptionsRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC.

", + "smithy.api#examples": [ + { + "title": "To delete a DHCP options set", + "documentation": "This example deletes the specified DHCP options set.", + "input": { + "DhcpOptionsId": "dopt-d9070ebb" + } + } + ] + } + }, + "com.amazonaws.ec2#DeleteDhcpOptionsRequest": { + "type": "structure", + "members": { + "DhcpOptionsId": { + "target": "com.amazonaws.ec2#DhcpOptionsId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the DHCP options set.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteEgressOnlyInternetGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteEgressOnlyInternetGatewayRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteEgressOnlyInternetGatewayResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes an egress-only internet gateway.

" + } + }, + "com.amazonaws.ec2#DeleteEgressOnlyInternetGatewayRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "EgressOnlyInternetGatewayId": { + "target": "com.amazonaws.ec2#EgressOnlyInternetGatewayId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the egress-only internet gateway.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteEgressOnlyInternetGatewayResult": { + "type": "structure", + "members": { + "ReturnCode": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "ReturnCode", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "returnCode" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteFleetError": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#DeleteFleetErrorCode", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The error code.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

The description for the error code.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an EC2 Fleet error.

" + } + }, + "com.amazonaws.ec2#DeleteFleetErrorCode": { + "type": "enum", + "members": { + "FLEET_ID_DOES_NOT_EXIST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fleetIdDoesNotExist" + } + }, + "FLEET_ID_MALFORMED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fleetIdMalformed" + } + }, + "FLEET_NOT_IN_DELETABLE_STATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fleetNotInDeletableState" + } + }, + "UNEXPECTED_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unexpectedError" + } + } + } + }, + "com.amazonaws.ec2#DeleteFleetErrorItem": { + "type": "structure", + "members": { + "Error": { + "target": "com.amazonaws.ec2#DeleteFleetError", + "traits": { + "aws.protocols#ec2QueryName": "Error", + "smithy.api#documentation": "

The error.

", + "smithy.api#xmlName": "error" + } + }, + "FleetId": { + "target": "com.amazonaws.ec2#FleetId", + "traits": { + "aws.protocols#ec2QueryName": "FleetId", + "smithy.api#documentation": "

The ID of the EC2 Fleet.

", + "smithy.api#xmlName": "fleetId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an EC2 Fleet that was not successfully deleted.

" + } + }, + "com.amazonaws.ec2#DeleteFleetErrorSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#DeleteFleetErrorItem", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#DeleteFleetSuccessItem": { + "type": "structure", + "members": { + "CurrentFleetState": { + "target": "com.amazonaws.ec2#FleetStateCode", + "traits": { + "aws.protocols#ec2QueryName": "CurrentFleetState", + "smithy.api#documentation": "

The current state of the EC2 Fleet.

", + "smithy.api#xmlName": "currentFleetState" + } + }, + "PreviousFleetState": { + "target": "com.amazonaws.ec2#FleetStateCode", + "traits": { + "aws.protocols#ec2QueryName": "PreviousFleetState", + "smithy.api#documentation": "

The previous state of the EC2 Fleet.

", + "smithy.api#xmlName": "previousFleetState" + } + }, + "FleetId": { + "target": "com.amazonaws.ec2#FleetId", + "traits": { + "aws.protocols#ec2QueryName": "FleetId", + "smithy.api#documentation": "

The ID of the EC2 Fleet.

", + "smithy.api#xmlName": "fleetId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an EC2 Fleet that was successfully deleted.

" + } + }, + "com.amazonaws.ec2#DeleteFleetSuccessSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#DeleteFleetSuccessItem", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#DeleteFleets": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteFleetsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteFleetsResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified EC2 Fleets.

\n

After you delete an EC2 Fleet, it launches no new instances.

\n

You must also specify whether a deleted EC2 Fleet should terminate its instances. If you\n choose to terminate the instances, the EC2 Fleet enters the deleted_terminating\n state. Otherwise, the EC2 Fleet enters the deleted_running state, and the instances\n continue to run until they are interrupted or you terminate them manually.

\n

For instant fleets, EC2 Fleet must terminate the instances when the fleet is\n deleted. Up to 1000 instances can be terminated in a single request to delete\n instant fleets. A deleted instant fleet with running instances\n is not supported.

\n

\n Restrictions\n

\n \n

For more information, see Delete an EC2\n Fleet in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#DeleteFleetsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "FleetIds": { + "target": "com.amazonaws.ec2#FleetIdSet", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the EC2 Fleets.

\n

Constraints: In a single request, you can specify up to 25 instant fleet\n IDs and up to 100 maintain or request fleet IDs.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "FleetId" + } + }, + "TerminateInstances": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Indicates whether to terminate the associated instances when the EC2 Fleet is deleted. The default is to\n terminate the instances.

\n

To let the instances continue to run after the EC2 Fleet is deleted, specify\n no-terminate-instances. Supported only for fleets of type\n maintain and request.

\n

For instant fleets, you cannot specify NoTerminateInstances. A\n deleted instant fleet with running instances is not supported.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteFleetsResult": { + "type": "structure", + "members": { + "SuccessfulFleetDeletions": { + "target": "com.amazonaws.ec2#DeleteFleetSuccessSet", + "traits": { + "aws.protocols#ec2QueryName": "SuccessfulFleetDeletionSet", + "smithy.api#documentation": "

Information about the EC2 Fleets that are successfully deleted.

", + "smithy.api#xmlName": "successfulFleetDeletionSet" + } + }, + "UnsuccessfulFleetDeletions": { + "target": "com.amazonaws.ec2#DeleteFleetErrorSet", + "traits": { + "aws.protocols#ec2QueryName": "UnsuccessfulFleetDeletionSet", + "smithy.api#documentation": "

Information about the EC2 Fleets that are not successfully deleted.

", + "smithy.api#xmlName": "unsuccessfulFleetDeletionSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteFlowLogs": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteFlowLogsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteFlowLogsResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes one or more flow logs.

" + } + }, + "com.amazonaws.ec2#DeleteFlowLogsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "FlowLogIds": { + "target": "com.amazonaws.ec2#FlowLogIdList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

One or more flow log IDs.

\n

Constraint: Maximum of 1000 flow log IDs.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "FlowLogId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteFlowLogsResult": { + "type": "structure", + "members": { + "Unsuccessful": { + "target": "com.amazonaws.ec2#UnsuccessfulItemSet", + "traits": { + "aws.protocols#ec2QueryName": "Unsuccessful", + "smithy.api#documentation": "

Information about the flow logs that could not be deleted successfully.

", + "smithy.api#xmlName": "unsuccessful" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteFpgaImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteFpgaImageRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteFpgaImageResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified Amazon FPGA Image (AFI).

" + } + }, + "com.amazonaws.ec2#DeleteFpgaImageRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "FpgaImageId": { + "target": "com.amazonaws.ec2#FpgaImageId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the AFI.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteFpgaImageResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Is true if the request succeeds, and an error otherwise.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteInstanceConnectEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteInstanceConnectEndpointRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteInstanceConnectEndpointResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified EC2 Instance Connect Endpoint.

" + } + }, + "com.amazonaws.ec2#DeleteInstanceConnectEndpointRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "InstanceConnectEndpointId": { + "target": "com.amazonaws.ec2#InstanceConnectEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the EC2 Instance Connect Endpoint to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteInstanceConnectEndpointResult": { + "type": "structure", + "members": { + "InstanceConnectEndpoint": { + "target": "com.amazonaws.ec2#Ec2InstanceConnectEndpoint", + "traits": { + "aws.protocols#ec2QueryName": "InstanceConnectEndpoint", + "smithy.api#documentation": "

Information about the EC2 Instance Connect Endpoint.

", + "smithy.api#xmlName": "instanceConnectEndpoint" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteInstanceEventWindow": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteInstanceEventWindowRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteInstanceEventWindowResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified event window.

\n

For more information, see Define event windows for scheduled\n events in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#DeleteInstanceEventWindowRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ForceDelete": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Specify true to force delete the event window. Use the force delete parameter\n if the event window is currently associated with targets.

" + } + }, + "InstanceEventWindowId": { + "target": "com.amazonaws.ec2#InstanceEventWindowId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the event window.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "InstanceEventWindowId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteInstanceEventWindowResult": { + "type": "structure", + "members": { + "InstanceEventWindowState": { + "target": "com.amazonaws.ec2#InstanceEventWindowStateChange", + "traits": { + "aws.protocols#ec2QueryName": "InstanceEventWindowState", + "smithy.api#documentation": "

The state of the event window.

", + "smithy.api#xmlName": "instanceEventWindowState" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteInternetGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteInternetGatewayRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified internet gateway. You must detach the internet gateway from the\n\t\t\tVPC before you can delete it.

", + "smithy.api#examples": [ + { + "title": "To delete an Internet gateway", + "documentation": "This example deletes the specified Internet gateway.", + "input": { + "InternetGatewayId": "igw-c0a643a9" + } + } + ] + } + }, + "com.amazonaws.ec2#DeleteInternetGatewayRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "InternetGatewayId": { + "target": "com.amazonaws.ec2#InternetGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "InternetGatewayId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the internet gateway.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "internetGatewayId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteIpam": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteIpamRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteIpamResult" + }, + "traits": { + "smithy.api#documentation": "

Delete an IPAM. Deleting an IPAM removes all monitored data associated with the IPAM including the historical data for CIDRs.

\n

For more information, see Delete an IPAM in the Amazon VPC IPAM User Guide.\n

" + } + }, + "com.amazonaws.ec2#DeleteIpamExternalResourceVerificationToken": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteIpamExternalResourceVerificationTokenRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteIpamExternalResourceVerificationTokenResult" + }, + "traits": { + "smithy.api#documentation": "

Delete a verification token. A verification token is an Amazon Web Services-generated random value that you can use to prove ownership of an external resource. For example, you can use a verification token to validate that you control a public IP address range when you bring an IP address range to Amazon Web Services (BYOIP).\n

" + } + }, + "com.amazonaws.ec2#DeleteIpamExternalResourceVerificationTokenRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamExternalResourceVerificationTokenId": { + "target": "com.amazonaws.ec2#IpamExternalResourceVerificationTokenId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The token ID.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteIpamExternalResourceVerificationTokenResult": { + "type": "structure", + "members": { + "IpamExternalResourceVerificationToken": { + "target": "com.amazonaws.ec2#IpamExternalResourceVerificationToken", + "traits": { + "aws.protocols#ec2QueryName": "IpamExternalResourceVerificationToken", + "smithy.api#documentation": "

The verification token.

", + "smithy.api#xmlName": "ipamExternalResourceVerificationToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteIpamPool": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteIpamPoolRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteIpamPoolResult" + }, + "traits": { + "smithy.api#documentation": "

Delete an IPAM pool.

\n \n

You cannot delete an IPAM pool if there are allocations in it or CIDRs provisioned to it. To release \n allocations, see ReleaseIpamPoolAllocation. To deprovision pool \n CIDRs, see DeprovisionIpamPoolCidr.

\n \n

For more information, see Delete a pool in the Amazon VPC IPAM User Guide.\n

" + } + }, + "com.amazonaws.ec2#DeleteIpamPoolRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the pool to delete.

", + "smithy.api#required": {} + } + }, + "Cascade": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Enables you to quickly delete an IPAM pool and all resources within that pool, including\n provisioned CIDRs, allocations, and other pools.

\n \n

You can only use this option to delete pools in the private scope or pools in the public scope with a source resource. A source resource is a resource used to provision CIDRs to a resource planning pool.

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteIpamPoolResult": { + "type": "structure", + "members": { + "IpamPool": { + "target": "com.amazonaws.ec2#IpamPool", + "traits": { + "aws.protocols#ec2QueryName": "IpamPool", + "smithy.api#documentation": "

Information about the results of the deletion.

", + "smithy.api#xmlName": "ipamPool" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteIpamRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamId": { + "target": "com.amazonaws.ec2#IpamId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the IPAM to delete.

", + "smithy.api#required": {} + } + }, + "Cascade": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and\n any allocations in the pools in private scopes. You cannot delete the IPAM with this option if there is a pool in your public scope. If you use this option, IPAM does the following:

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteIpamResourceDiscovery": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteIpamResourceDiscoveryRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteIpamResourceDiscoveryResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes an IPAM resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

" + } + }, + "com.amazonaws.ec2#DeleteIpamResourceDiscoveryRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamResourceDiscoveryId": { + "target": "com.amazonaws.ec2#IpamResourceDiscoveryId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IPAM resource discovery ID.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteIpamResourceDiscoveryResult": { + "type": "structure", + "members": { + "IpamResourceDiscovery": { + "target": "com.amazonaws.ec2#IpamResourceDiscovery", + "traits": { + "aws.protocols#ec2QueryName": "IpamResourceDiscovery", + "smithy.api#documentation": "

The IPAM resource discovery.

", + "smithy.api#xmlName": "ipamResourceDiscovery" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteIpamResult": { + "type": "structure", + "members": { + "Ipam": { + "target": "com.amazonaws.ec2#Ipam", + "traits": { + "aws.protocols#ec2QueryName": "Ipam", + "smithy.api#documentation": "

Information about the results of the deletion.

", + "smithy.api#xmlName": "ipam" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteIpamScope": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteIpamScopeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteIpamScopeResult" + }, + "traits": { + "smithy.api#documentation": "

Delete the scope for an IPAM. You cannot delete the default scopes.

\n

For more information, see Delete a scope in the Amazon VPC IPAM User Guide.\n

" + } + }, + "com.amazonaws.ec2#DeleteIpamScopeRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamScopeId": { + "target": "com.amazonaws.ec2#IpamScopeId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the scope to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteIpamScopeResult": { + "type": "structure", + "members": { + "IpamScope": { + "target": "com.amazonaws.ec2#IpamScope", + "traits": { + "aws.protocols#ec2QueryName": "IpamScope", + "smithy.api#documentation": "

Information about the results of the deletion.

", + "smithy.api#xmlName": "ipamScope" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteKeyPair": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteKeyPairRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteKeyPairResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified key pair, by removing the public key from Amazon EC2.

", + "smithy.api#examples": [ + { + "title": "To delete a key pair", + "documentation": "This example deletes the specified key pair.", + "input": { + "KeyName": "my-key-pair" + } + } + ] + } + }, + "com.amazonaws.ec2#DeleteKeyPairRequest": { + "type": "structure", + "members": { + "KeyName": { + "target": "com.amazonaws.ec2#KeyPairNameWithResolver", + "traits": { + "smithy.api#documentation": "

The name of the key pair.

" + } + }, + "KeyPairId": { + "target": "com.amazonaws.ec2#KeyPairId", + "traits": { + "smithy.api#documentation": "

The ID of the key pair.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteKeyPairResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Is true if the request succeeds, and an error otherwise.

", + "smithy.api#xmlName": "return" + } + }, + "KeyPairId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KeyPairId", + "smithy.api#documentation": "

The ID of the key pair.

", + "smithy.api#xmlName": "keyPairId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteLaunchTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteLaunchTemplateRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteLaunchTemplateResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes a launch template. Deleting a launch template deletes all of its\n versions.

", + "smithy.api#examples": [ + { + "title": "To delete a launch template", + "documentation": "This example deletes the specified launch template.", + "input": { + "LaunchTemplateId": "lt-0abcd290751193123" + }, + "output": { + "LaunchTemplate": { + "LatestVersionNumber": 2, + "LaunchTemplateId": "lt-0abcd290751193123", + "LaunchTemplateName": "my-template", + "DefaultVersionNumber": 2, + "CreatedBy": "arn:aws:iam::123456789012:root", + "CreateTime": "2017-11-23T16:46:25.000Z" + } + } + } + ] + } + }, + "com.amazonaws.ec2#DeleteLaunchTemplateRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" + } + }, + "LaunchTemplateId": { + "target": "com.amazonaws.ec2#LaunchTemplateId", + "traits": { + "smithy.api#documentation": "

The ID of the launch template.

\n

You must specify either the launch template ID or the\n launch template name, but not both.

" + } + }, + "LaunchTemplateName": { + "target": "com.amazonaws.ec2#LaunchTemplateName", + "traits": { + "smithy.api#documentation": "

The name of the launch template.

\n

You must specify either the launch template ID or the\n launch template name, but not both.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteLaunchTemplateResult": { + "type": "structure", + "members": { + "LaunchTemplate": { + "target": "com.amazonaws.ec2#LaunchTemplate", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplate", + "smithy.api#documentation": "

Information about the launch template.

", + "smithy.api#xmlName": "launchTemplate" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteLaunchTemplateVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteLaunchTemplateVersionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteLaunchTemplateVersionsResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes one or more versions of a launch template.

\n

You can't delete the default version of a launch template; you must first assign a\n different version as the default. If the default version is the only version for the\n launch template, you must delete the entire launch template using DeleteLaunchTemplate.

\n

You can delete up to 200 launch template versions in a single request. To delete more\n than 200 versions in a single request, use DeleteLaunchTemplate, which\n deletes the launch template and all of its versions.

\n

For more information, see Delete a launch template version in the\n Amazon EC2 User Guide.

", + "smithy.api#examples": [ + { + "title": "To delete a launch template version", + "documentation": "This example deletes the specified launch template version.", + "input": { + "LaunchTemplateId": "lt-0abcd290751193123", + "Versions": [ + "1" + ] + }, + "output": { + "SuccessfullyDeletedLaunchTemplateVersions": [ + { + "LaunchTemplateName": "my-template", + "VersionNumber": 1, + "LaunchTemplateId": "lt-0abcd290751193123" + } + ], + "UnsuccessfullyDeletedLaunchTemplateVersions": [] + } + } + ] + } + }, + "com.amazonaws.ec2#DeleteLaunchTemplateVersionsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" + } + }, + "LaunchTemplateId": { + "target": "com.amazonaws.ec2#LaunchTemplateId", + "traits": { + "smithy.api#documentation": "

The ID of the launch template.

\n

You must specify either the launch template ID or the\n launch template name, but not both.

" + } + }, + "LaunchTemplateName": { + "target": "com.amazonaws.ec2#LaunchTemplateName", + "traits": { + "smithy.api#documentation": "

The name of the launch template.

\n

You must specify either the launch template ID or the\n launch template name, but not both.

" + } + }, + "Versions": { + "target": "com.amazonaws.ec2#VersionStringList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The version numbers of one or more launch template versions to delete. You can specify\n up to 200 launch template version numbers.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "LaunchTemplateVersion" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteLaunchTemplateVersionsResponseErrorItem": { + "type": "structure", + "members": { + "LaunchTemplateId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateId", + "smithy.api#documentation": "

The ID of the launch template.

", + "smithy.api#xmlName": "launchTemplateId" + } + }, + "LaunchTemplateName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateName", + "smithy.api#documentation": "

The name of the launch template.

", + "smithy.api#xmlName": "launchTemplateName" + } + }, + "VersionNumber": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "VersionNumber", + "smithy.api#documentation": "

The version number of the launch template.

", + "smithy.api#xmlName": "versionNumber" + } + }, + "ResponseError": { + "target": "com.amazonaws.ec2#ResponseError", + "traits": { + "aws.protocols#ec2QueryName": "ResponseError", + "smithy.api#documentation": "

Information about the error.

", + "smithy.api#xmlName": "responseError" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a launch template version that could not be deleted.

" + } + }, + "com.amazonaws.ec2#DeleteLaunchTemplateVersionsResponseErrorSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#DeleteLaunchTemplateVersionsResponseErrorItem", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#DeleteLaunchTemplateVersionsResponseSuccessItem": { + "type": "structure", + "members": { + "LaunchTemplateId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateId", + "smithy.api#documentation": "

The ID of the launch template.

", + "smithy.api#xmlName": "launchTemplateId" + } + }, + "LaunchTemplateName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateName", + "smithy.api#documentation": "

The name of the launch template.

", + "smithy.api#xmlName": "launchTemplateName" + } + }, + "VersionNumber": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "VersionNumber", + "smithy.api#documentation": "

The version number of the launch template.

", + "smithy.api#xmlName": "versionNumber" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a launch template version that was successfully deleted.

" + } + }, + "com.amazonaws.ec2#DeleteLaunchTemplateVersionsResponseSuccessSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#DeleteLaunchTemplateVersionsResponseSuccessItem", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#DeleteLaunchTemplateVersionsResult": { + "type": "structure", + "members": { + "SuccessfullyDeletedLaunchTemplateVersions": { + "target": "com.amazonaws.ec2#DeleteLaunchTemplateVersionsResponseSuccessSet", + "traits": { + "aws.protocols#ec2QueryName": "SuccessfullyDeletedLaunchTemplateVersionSet", + "smithy.api#documentation": "

Information about the launch template versions that were successfully deleted.

", + "smithy.api#xmlName": "successfullyDeletedLaunchTemplateVersionSet" + } + }, + "UnsuccessfullyDeletedLaunchTemplateVersions": { + "target": "com.amazonaws.ec2#DeleteLaunchTemplateVersionsResponseErrorSet", + "traits": { + "aws.protocols#ec2QueryName": "UnsuccessfullyDeletedLaunchTemplateVersionSet", + "smithy.api#documentation": "

Information about the launch template versions that could not be deleted.

", + "smithy.api#xmlName": "unsuccessfullyDeletedLaunchTemplateVersionSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteLocalGatewayRoute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteLocalGatewayRouteRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteLocalGatewayRouteResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified route from the specified local gateway route table.

" + } + }, + "com.amazonaws.ec2#DeleteLocalGatewayRouteRequest": { + "type": "structure", + "members": { + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The CIDR range for the route. This must match the CIDR for the route exactly.

" + } + }, + "LocalGatewayRouteTableId": { + "target": "com.amazonaws.ec2#LocalGatewayRoutetableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the local gateway route table.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "DestinationPrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "smithy.api#documentation": "

\n Use a prefix list in place of DestinationCidrBlock. You cannot use \n DestinationPrefixListId and DestinationCidrBlock in the same request.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteLocalGatewayRouteResult": { + "type": "structure", + "members": { + "Route": { + "target": "com.amazonaws.ec2#LocalGatewayRoute", + "traits": { + "aws.protocols#ec2QueryName": "Route", + "smithy.api#documentation": "

Information about the route.

", + "smithy.api#xmlName": "route" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteLocalGatewayRouteTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteLocalGatewayRouteTableRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteLocalGatewayRouteTableResult" + }, + "traits": { + "smithy.api#documentation": "

\n Deletes a local gateway route table.\n

" + } + }, + "com.amazonaws.ec2#DeleteLocalGatewayRouteTableRequest": { + "type": "structure", + "members": { + "LocalGatewayRouteTableId": { + "target": "com.amazonaws.ec2#LocalGatewayRoutetableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

\n The ID of the local gateway route table.\n

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteLocalGatewayRouteTableResult": { + "type": "structure", + "members": { + "LocalGatewayRouteTable": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTable", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayRouteTable", + "smithy.api#documentation": "

Information about the local gateway route table.

", + "smithy.api#xmlName": "localGatewayRouteTable" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociationResult" + }, + "traits": { + "smithy.api#documentation": "

\n Deletes a local gateway route table virtual interface group association.\n

" + } + }, + "com.amazonaws.ec2#DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociationRequest": { + "type": "structure", + "members": { + "LocalGatewayRouteTableVirtualInterfaceGroupAssociationId": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTableVirtualInterfaceGroupAssociationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

\n The ID of the local gateway route table virtual interface group association.\n

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociationResult": { + "type": "structure", + "members": { + "LocalGatewayRouteTableVirtualInterfaceGroupAssociation": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTableVirtualInterfaceGroupAssociation", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayRouteTableVirtualInterfaceGroupAssociation", + "smithy.api#documentation": "

Information about the association.

", + "smithy.api#xmlName": "localGatewayRouteTableVirtualInterfaceGroupAssociation" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteLocalGatewayRouteTableVpcAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteLocalGatewayRouteTableVpcAssociationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteLocalGatewayRouteTableVpcAssociationResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified association between a VPC and local gateway route table.

" + } + }, + "com.amazonaws.ec2#DeleteLocalGatewayRouteTableVpcAssociationRequest": { + "type": "structure", + "members": { + "LocalGatewayRouteTableVpcAssociationId": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTableVpcAssociationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the association.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteLocalGatewayRouteTableVpcAssociationResult": { + "type": "structure", + "members": { + "LocalGatewayRouteTableVpcAssociation": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTableVpcAssociation", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayRouteTableVpcAssociation", + "smithy.api#documentation": "

Information about the association.

", + "smithy.api#xmlName": "localGatewayRouteTableVpcAssociation" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteManagedPrefixList": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteManagedPrefixListRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteManagedPrefixListResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified managed prefix list. You must first remove all references to the prefix list in your resources.

" + } + }, + "com.amazonaws.ec2#DeleteManagedPrefixListRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "PrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the prefix list.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteManagedPrefixListResult": { + "type": "structure", + "members": { + "PrefixList": { + "target": "com.amazonaws.ec2#ManagedPrefixList", + "traits": { + "aws.protocols#ec2QueryName": "PrefixList", + "smithy.api#documentation": "

Information about the prefix list.

", + "smithy.api#xmlName": "prefixList" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteNatGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteNatGatewayRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteNatGatewayResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified NAT gateway. Deleting a public NAT gateway disassociates its Elastic IP address, \n but does not release the address from your account. Deleting a NAT gateway does not delete any NAT gateway \n routes in your route tables.

", + "smithy.api#examples": [ + { + "title": "To delete a NAT gateway", + "documentation": "This example deletes the specified NAT gateway.", + "input": { + "NatGatewayId": "nat-04ae55e711cec5680" + }, + "output": { + "NatGatewayId": "nat-04ae55e711cec5680" + } + } + ] + } + }, + "com.amazonaws.ec2#DeleteNatGatewayRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "NatGatewayId": { + "target": "com.amazonaws.ec2#NatGatewayId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the NAT gateway.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "NatGatewayId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteNatGatewayResult": { + "type": "structure", + "members": { + "NatGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NatGatewayId", + "smithy.api#documentation": "

The ID of the NAT gateway.

", + "smithy.api#xmlName": "natGatewayId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteNetworkAcl": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteNetworkAclRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL.

", + "smithy.api#examples": [ + { + "title": "To delete a network ACL", + "documentation": "This example deletes the specified network ACL.", + "input": { + "NetworkAclId": "acl-5fb85d36" + } + } + ] + } + }, + "com.amazonaws.ec2#DeleteNetworkAclEntry": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteNetworkAclEntryRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified ingress or egress entry (rule) from the specified network ACL.

", + "smithy.api#examples": [ + { + "title": "To delete a network ACL entry", + "documentation": "This example deletes ingress rule number 100 from the specified network ACL.", + "input": { + "NetworkAclId": "acl-5fb85d36", + "RuleNumber": 100, + "Egress": true + } + } + ] + } + }, + "com.amazonaws.ec2#DeleteNetworkAclEntryRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "NetworkAclId": { + "target": "com.amazonaws.ec2#NetworkAclId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkAclId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the network ACL.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "networkAclId" + } + }, + "RuleNumber": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "RuleNumber", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The rule number of the entry to delete.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "ruleNumber" + } + }, + "Egress": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Egress", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Indicates whether the rule is an egress rule.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "egress" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteNetworkAclRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "NetworkAclId": { + "target": "com.amazonaws.ec2#NetworkAclId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkAclId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the network ACL.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "networkAclId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteNetworkInsightsAccessScope": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteNetworkInsightsAccessScopeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteNetworkInsightsAccessScopeResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified Network Access Scope.

" + } + }, + "com.amazonaws.ec2#DeleteNetworkInsightsAccessScopeAnalysis": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteNetworkInsightsAccessScopeAnalysisRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteNetworkInsightsAccessScopeAnalysisResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified Network Access Scope analysis.

" + } + }, + "com.amazonaws.ec2#DeleteNetworkInsightsAccessScopeAnalysisRequest": { + "type": "structure", + "members": { + "NetworkInsightsAccessScopeAnalysisId": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysisId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Network Access Scope analysis.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteNetworkInsightsAccessScopeAnalysisResult": { + "type": "structure", + "members": { + "NetworkInsightsAccessScopeAnalysisId": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysisId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeAnalysisId", + "smithy.api#documentation": "

The ID of the Network Access Scope analysis.

", + "smithy.api#xmlName": "networkInsightsAccessScopeAnalysisId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteNetworkInsightsAccessScopeRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "NetworkInsightsAccessScopeId": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Network Access Scope.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteNetworkInsightsAccessScopeResult": { + "type": "structure", + "members": { + "NetworkInsightsAccessScopeId": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeId", + "smithy.api#documentation": "

The ID of the Network Access Scope.

", + "smithy.api#xmlName": "networkInsightsAccessScopeId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteNetworkInsightsAnalysis": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteNetworkInsightsAnalysisRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteNetworkInsightsAnalysisResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified network insights analysis.

" + } + }, + "com.amazonaws.ec2#DeleteNetworkInsightsAnalysisRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "NetworkInsightsAnalysisId": { + "target": "com.amazonaws.ec2#NetworkInsightsAnalysisId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the network insights analysis.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteNetworkInsightsAnalysisResult": { + "type": "structure", + "members": { + "NetworkInsightsAnalysisId": { + "target": "com.amazonaws.ec2#NetworkInsightsAnalysisId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAnalysisId", + "smithy.api#documentation": "

The ID of the network insights analysis.

", + "smithy.api#xmlName": "networkInsightsAnalysisId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteNetworkInsightsPath": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteNetworkInsightsPathRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteNetworkInsightsPathResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified path.

" + } + }, + "com.amazonaws.ec2#DeleteNetworkInsightsPathRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "NetworkInsightsPathId": { + "target": "com.amazonaws.ec2#NetworkInsightsPathId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the path.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteNetworkInsightsPathResult": { + "type": "structure", + "members": { + "NetworkInsightsPathId": { + "target": "com.amazonaws.ec2#NetworkInsightsPathId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsPathId", + "smithy.api#documentation": "

The ID of the path.

", + "smithy.api#xmlName": "networkInsightsPathId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteNetworkInterface": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteNetworkInterfaceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified network interface. You must detach the network interface before you can delete it.

", + "smithy.api#examples": [ + { + "title": "To delete a network interface", + "documentation": "This example deletes the specified network interface.", + "input": { + "NetworkInterfaceId": "eni-e5aa89a3" + } + } + ] + } + }, + "com.amazonaws.ec2#DeleteNetworkInterfacePermission": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteNetworkInterfacePermissionRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteNetworkInterfacePermissionResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes a permission for a network interface. By default, you cannot delete the\n\t\t\tpermission if the account for which you're removing the permission has attached the\n\t\t\tnetwork interface to an instance. However, you can force delete the permission,\n\t\t\tregardless of any attachment.

" + } + }, + "com.amazonaws.ec2#DeleteNetworkInterfacePermissionRequest": { + "type": "structure", + "members": { + "NetworkInterfacePermissionId": { + "target": "com.amazonaws.ec2#NetworkInterfacePermissionId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the network interface permission.

", + "smithy.api#required": {} + } + }, + "Force": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Specify true to remove the permission even if the network interface is\n\t\t\tattached to an instance.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is DryRunOperation. \n\t\t\tOtherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DeleteNetworkInterfacePermission.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteNetworkInterfacePermissionResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds, otherwise returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output for DeleteNetworkInterfacePermission.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteNetworkInterfaceRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "networkInterfaceId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DeleteNetworkInterface.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeletePlacementGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeletePlacementGroupRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified placement group. You must terminate all instances in the\n placement group before you can delete the placement group. For more information, see\n Placement groups in the Amazon EC2 User Guide.

", + "smithy.api#examples": [ + { + "title": "To delete a placement group", + "documentation": "This example deletes the specified placement group.\n", + "input": { + "GroupName": "my-cluster" + }, + "output": {} + } + ] + } + }, + "com.amazonaws.ec2#DeletePlacementGroupRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "GroupName": { + "target": "com.amazonaws.ec2#PlacementGroupName", + "traits": { + "aws.protocols#ec2QueryName": "GroupName", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the placement group.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "groupName" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeletePublicIpv4Pool": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeletePublicIpv4PoolRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeletePublicIpv4PoolResult" + }, + "traits": { + "smithy.api#documentation": "

Delete a public IPv4 pool. A public IPv4 pool is an EC2 IP address pool required for the public IPv4 CIDRs that you own and bring to Amazon Web Services to manage with IPAM. IPv6 addresses you bring to Amazon Web Services, however, use IPAM pools only.

" + } + }, + "com.amazonaws.ec2#DeletePublicIpv4PoolRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "PoolId": { + "target": "com.amazonaws.ec2#Ipv4PoolEc2Id", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the public IPv4 pool you want to delete.

", + "smithy.api#required": {} + } + }, + "NetworkBorderGroup": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone (AZ) or Local Zone (LZ) network border group that the resource that the IP address is assigned to is in. Defaults to an AZ network border group. For more information on available Local Zones, see Local Zone availability in the Amazon EC2 User Guide.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeletePublicIpv4PoolResult": { + "type": "structure", + "members": { + "ReturnValue": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "ReturnValue", + "smithy.api#documentation": "

Information about the result of deleting the public IPv4 pool.

", + "smithy.api#xmlName": "returnValue" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteQueuedReservedInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteQueuedReservedInstancesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteQueuedReservedInstancesResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the queued purchases for the specified Reserved Instances.

" + } + }, + "com.amazonaws.ec2#DeleteQueuedReservedInstancesError": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#DeleteQueuedReservedInstancesErrorCode", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The error code.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

The error message.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the error for a Reserved Instance whose queued purchase could not be deleted.

" + } + }, + "com.amazonaws.ec2#DeleteQueuedReservedInstancesErrorCode": { + "type": "enum", + "members": { + "RESERVED_INSTANCES_ID_INVALID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "reserved-instances-id-invalid" + } + }, + "RESERVED_INSTANCES_NOT_IN_QUEUED_STATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "reserved-instances-not-in-queued-state" + } + }, + "UNEXPECTED_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unexpected-error" + } + } + } + }, + "com.amazonaws.ec2#DeleteQueuedReservedInstancesIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ReservationId", + "traits": { + "smithy.api#xmlName": "item" + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.ec2#DeleteQueuedReservedInstancesRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ReservedInstancesIds": { + "target": "com.amazonaws.ec2#DeleteQueuedReservedInstancesIdList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the Reserved Instances.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "ReservedInstancesId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteQueuedReservedInstancesResult": { + "type": "structure", + "members": { + "SuccessfulQueuedPurchaseDeletions": { + "target": "com.amazonaws.ec2#SuccessfulQueuedPurchaseDeletionSet", + "traits": { + "aws.protocols#ec2QueryName": "SuccessfulQueuedPurchaseDeletionSet", + "smithy.api#documentation": "

Information about the queued purchases that were successfully deleted.

", + "smithy.api#xmlName": "successfulQueuedPurchaseDeletionSet" + } + }, + "FailedQueuedPurchaseDeletions": { + "target": "com.amazonaws.ec2#FailedQueuedPurchaseDeletionSet", + "traits": { + "aws.protocols#ec2QueryName": "FailedQueuedPurchaseDeletionSet", + "smithy.api#documentation": "

Information about the queued purchases that could not be deleted.

", + "smithy.api#xmlName": "failedQueuedPurchaseDeletionSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteRoute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteRouteRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified route from the specified route table.

", + "smithy.api#examples": [ + { + "title": "To delete a route", + "documentation": "This example deletes the specified route from the specified route table.", + "input": { + "RouteTableId": "rtb-22574640", + "DestinationCidrBlock": "0.0.0.0/0" + } + } + ] + } + }, + "com.amazonaws.ec2#DeleteRouteRequest": { + "type": "structure", + "members": { + "DestinationPrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the prefix list for the route.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "RouteTableId": { + "target": "com.amazonaws.ec2#RouteTableId", + "traits": { + "aws.protocols#ec2QueryName": "RouteTableId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the route table.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "routeTableId" + } + }, + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationCidrBlock", + "smithy.api#documentation": "

The IPv4 CIDR range for the route. The value you specify must match the CIDR for the route exactly.

", + "smithy.api#xmlName": "destinationCidrBlock" + } + }, + "DestinationIpv6CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationIpv6CidrBlock", + "smithy.api#documentation": "

The IPv6 CIDR range for the route. The value you specify must match the CIDR for the route exactly.

", + "smithy.api#xmlName": "destinationIpv6CidrBlock" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteRouteTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteRouteTableRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table.

", + "smithy.api#examples": [ + { + "title": "To delete a route table", + "documentation": "This example deletes the specified route table.", + "input": { + "RouteTableId": "rtb-22574640" + } + } + ] + } + }, + "com.amazonaws.ec2#DeleteRouteTableRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "RouteTableId": { + "target": "com.amazonaws.ec2#RouteTableId", + "traits": { + "aws.protocols#ec2QueryName": "RouteTableId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the route table.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "routeTableId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteSecurityGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteSecurityGroupRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteSecurityGroupResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes a security group.

\n

If you attempt to delete a security group that is associated with an instance or network interface, is\n\t\t\t referenced by another security group in the same VPC, or has a VPC association, the operation fails with\n\t\t\t\tDependencyViolation.

", + "smithy.api#examples": [ + { + "title": "To delete a security group", + "documentation": "This example deletes the specified security group.", + "input": { + "GroupId": "sg-903004f8" + }, + "output": {} + } + ] + } + }, + "com.amazonaws.ec2#DeleteSecurityGroupRequest": { + "type": "structure", + "members": { + "GroupId": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "smithy.api#documentation": "

The ID of the security group.

" + } + }, + "GroupName": { + "target": "com.amazonaws.ec2#SecurityGroupName", + "traits": { + "smithy.api#documentation": "

[Default VPC] The name of the security group. You can specify either the\n security group name or the security group ID. For security groups in a nondefault VPC,\n you must specify the security group ID.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteSecurityGroupResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, returns an error.

", + "smithy.api#xmlName": "return" + } + }, + "GroupId": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "aws.protocols#ec2QueryName": "GroupId", + "smithy.api#documentation": "

The ID of the deleted security group.

", + "smithy.api#xmlName": "groupId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteSnapshotRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified snapshot.

\n

When you make periodic snapshots of a volume, the snapshots are incremental, and only the\n blocks on the device that have changed since your last snapshot are saved in the new snapshot.\n When you delete a snapshot, only the data not needed for any other snapshot is removed. So\n regardless of which prior snapshots have been deleted, all active snapshots will have access\n to all the information needed to restore the volume.

\n

You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI.\n You must first de-register the AMI before you can delete the snapshot.

\n

For more information, see Delete an Amazon EBS snapshot in the\n Amazon EBS User Guide.

", + "smithy.api#examples": [ + { + "title": "To delete a snapshot", + "documentation": "This example deletes a snapshot with the snapshot ID of ``snap-1234567890abcdef0``. If the command succeeds, no output is returned.", + "input": { + "SnapshotId": "snap-1234567890abcdef0" + }, + "output": {} + } + ] + } + }, + "com.amazonaws.ec2#DeleteSnapshotRequest": { + "type": "structure", + "members": { + "SnapshotId": { + "target": "com.amazonaws.ec2#SnapshotId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the EBS snapshot.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteSpotDatafeedSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteSpotDatafeedSubscriptionRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deletes the data feed for Spot Instances.

", + "smithy.api#examples": [ + { + "title": "To cancel a Spot Instance data feed subscription", + "documentation": "This example deletes a Spot data feed subscription for the account." + } + ] + } + }, + "com.amazonaws.ec2#DeleteSpotDatafeedSubscriptionRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DeleteSpotDatafeedSubscription.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteSubnet": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteSubnetRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.

", + "smithy.api#examples": [ + { + "title": "To delete a subnet", + "documentation": "This example deletes the specified subnet.", + "input": { + "SubnetId": "subnet-9d4a7b6c" + } + } + ] + } + }, + "com.amazonaws.ec2#DeleteSubnetCidrReservation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteSubnetCidrReservationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteSubnetCidrReservationResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes a subnet CIDR reservation.

" + } + }, + "com.amazonaws.ec2#DeleteSubnetCidrReservationRequest": { + "type": "structure", + "members": { + "SubnetCidrReservationId": { + "target": "com.amazonaws.ec2#SubnetCidrReservationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the subnet CIDR reservation.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteSubnetCidrReservationResult": { + "type": "structure", + "members": { + "DeletedSubnetCidrReservation": { + "target": "com.amazonaws.ec2#SubnetCidrReservation", + "traits": { + "aws.protocols#ec2QueryName": "DeletedSubnetCidrReservation", + "smithy.api#documentation": "

Information about the deleted subnet CIDR reservation.

", + "smithy.api#xmlName": "deletedSubnetCidrReservation" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteSubnetRequest": { + "type": "structure", + "members": { + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the subnet.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteTagsRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified set of tags from the specified set of resources.

\n

To list the current tags, use DescribeTags. For more information about\n tags, see Tag\n your Amazon EC2 resources in the Amazon Elastic Compute Cloud User\n Guide.

", + "smithy.api#examples": [ + { + "title": "To delete a tag from a resource", + "documentation": "This example deletes the tag Stack=test from the specified image.", + "input": { + "Resources": [ + "ami-78a54011" + ], + "Tags": [ + { + "Key": "Stack", + "Value": "test" + } + ] + } + } + ] + } + }, + "com.amazonaws.ec2#DeleteTagsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "Resources": { + "target": "com.amazonaws.ec2#ResourceIdList", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the resources, separated by spaces.

\n

Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "resourceId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "Tag", + "smithy.api#documentation": "

The tags to delete. Specify a tag key and an optional tag value to delete\n specific tags. If you specify a tag key without a tag value, we delete any tag with this\n key regardless of its value. If you specify a tag key with an empty string as the tag\n value, we delete the tag only if its value is an empty string.

\n

If you omit this parameter, we delete all user-defined tags for the specified\n resources. We do not delete Amazon Web Services-generated tags (tags that have the aws:\n prefix).

\n

Constraints: Up to 1000 tags.

", + "smithy.api#xmlName": "tag" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteTrafficMirrorFilter": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteTrafficMirrorFilterRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteTrafficMirrorFilterResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified Traffic Mirror filter.

\n

You cannot delete a Traffic Mirror filter that is in use by a Traffic Mirror session.

" + } + }, + "com.amazonaws.ec2#DeleteTrafficMirrorFilterRequest": { + "type": "structure", + "members": { + "TrafficMirrorFilterId": { + "target": "com.amazonaws.ec2#TrafficMirrorFilterId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Traffic Mirror filter.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteTrafficMirrorFilterResult": { + "type": "structure", + "members": { + "TrafficMirrorFilterId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TrafficMirrorFilterId", + "smithy.api#documentation": "

The ID of the Traffic Mirror filter.

", + "smithy.api#xmlName": "trafficMirrorFilterId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteTrafficMirrorFilterRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteTrafficMirrorFilterRuleRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteTrafficMirrorFilterRuleResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified Traffic Mirror rule.

" + } + }, + "com.amazonaws.ec2#DeleteTrafficMirrorFilterRuleRequest": { + "type": "structure", + "members": { + "TrafficMirrorFilterRuleId": { + "target": "com.amazonaws.ec2#TrafficMirrorFilterRuleIdWithResolver", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Traffic Mirror rule.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteTrafficMirrorFilterRuleResult": { + "type": "structure", + "members": { + "TrafficMirrorFilterRuleId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TrafficMirrorFilterRuleId", + "smithy.api#documentation": "

The ID of the deleted Traffic Mirror rule.

", + "smithy.api#xmlName": "trafficMirrorFilterRuleId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteTrafficMirrorSession": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteTrafficMirrorSessionRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteTrafficMirrorSessionResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified Traffic Mirror session.

" + } + }, + "com.amazonaws.ec2#DeleteTrafficMirrorSessionRequest": { + "type": "structure", + "members": { + "TrafficMirrorSessionId": { + "target": "com.amazonaws.ec2#TrafficMirrorSessionId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Traffic Mirror session.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteTrafficMirrorSessionResult": { + "type": "structure", + "members": { + "TrafficMirrorSessionId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TrafficMirrorSessionId", + "smithy.api#documentation": "

The ID of the deleted Traffic Mirror session.

", + "smithy.api#xmlName": "trafficMirrorSessionId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteTrafficMirrorTarget": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteTrafficMirrorTargetRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteTrafficMirrorTargetResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified Traffic Mirror target.

\n

You cannot delete a Traffic Mirror target that is in use by a Traffic Mirror session.

" + } + }, + "com.amazonaws.ec2#DeleteTrafficMirrorTargetRequest": { + "type": "structure", + "members": { + "TrafficMirrorTargetId": { + "target": "com.amazonaws.ec2#TrafficMirrorTargetId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Traffic Mirror target.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteTrafficMirrorTargetResult": { + "type": "structure", + "members": { + "TrafficMirrorTargetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TrafficMirrorTargetId", + "smithy.api#documentation": "

The ID of the deleted Traffic Mirror target.

", + "smithy.api#xmlName": "trafficMirrorTargetId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteTransitGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified transit gateway.

" + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayConnect": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayConnectRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayConnectResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified Connect attachment. You must first delete any Connect peers for\n the attachment.

" + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayConnectPeer": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayConnectPeerRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayConnectPeerResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified Connect peer.

" + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayConnectPeerRequest": { + "type": "structure", + "members": { + "TransitGatewayConnectPeerId": { + "target": "com.amazonaws.ec2#TransitGatewayConnectPeerId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Connect peer.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayConnectPeerResult": { + "type": "structure", + "members": { + "TransitGatewayConnectPeer": { + "target": "com.amazonaws.ec2#TransitGatewayConnectPeer", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayConnectPeer", + "smithy.api#documentation": "

Information about the deleted Connect peer.

", + "smithy.api#xmlName": "transitGatewayConnectPeer" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayConnectRequest": { + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Connect attachment.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayConnectResult": { + "type": "structure", + "members": { + "TransitGatewayConnect": { + "target": "com.amazonaws.ec2#TransitGatewayConnect", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayConnect", + "smithy.api#documentation": "

Information about the deleted Connect attachment.

", + "smithy.api#xmlName": "transitGatewayConnect" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayMulticastDomain": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayMulticastDomainRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayMulticastDomainResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified transit gateway multicast domain.

" + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayMulticastDomainRequest": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayMulticastDomainResult": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomain": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomain", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayMulticastDomain", + "smithy.api#documentation": "

Information about the deleted transit gateway multicast domain.

", + "smithy.api#xmlName": "transitGatewayMulticastDomain" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayPeeringAttachment": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayPeeringAttachmentRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayPeeringAttachmentResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes a transit gateway peering attachment.

" + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayPeeringAttachmentRequest": { + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway peering attachment.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayPeeringAttachmentResult": { + "type": "structure", + "members": { + "TransitGatewayPeeringAttachment": { + "target": "com.amazonaws.ec2#TransitGatewayPeeringAttachment", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayPeeringAttachment", + "smithy.api#documentation": "

The transit gateway peering attachment.

", + "smithy.api#xmlName": "transitGatewayPeeringAttachment" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayPolicyTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayPolicyTableRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayPolicyTableResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified transit gateway policy table.

" + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayPolicyTableRequest": { + "type": "structure", + "members": { + "TransitGatewayPolicyTableId": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The transit gateway policy table to delete.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayPolicyTableResult": { + "type": "structure", + "members": { + "TransitGatewayPolicyTable": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTable", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayPolicyTable", + "smithy.api#documentation": "

Provides details about the deleted transit gateway policy table.

", + "smithy.api#xmlName": "transitGatewayPolicyTable" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayPrefixListReference": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayPrefixListReferenceRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayPrefixListReferenceResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes a reference (route) to a prefix list in a specified transit gateway route table.

" + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayPrefixListReferenceRequest": { + "type": "structure", + "members": { + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the route table.

", + "smithy.api#required": {} + } + }, + "PrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the prefix list.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayPrefixListReferenceResult": { + "type": "structure", + "members": { + "TransitGatewayPrefixListReference": { + "target": "com.amazonaws.ec2#TransitGatewayPrefixListReference", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayPrefixListReference", + "smithy.api#documentation": "

Information about the deleted prefix list reference.

", + "smithy.api#xmlName": "transitGatewayPrefixListReference" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayRequest": { + "type": "structure", + "members": { + "TransitGatewayId": { + "target": "com.amazonaws.ec2#TransitGatewayId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayResult": { + "type": "structure", + "members": { + "TransitGateway": { + "target": "com.amazonaws.ec2#TransitGateway", + "traits": { + "aws.protocols#ec2QueryName": "TransitGateway", + "smithy.api#documentation": "

Information about the deleted transit gateway.

", + "smithy.api#xmlName": "transitGateway" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayRoute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayRouteRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayRouteResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified route from the specified transit gateway route table.

" + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayRouteRequest": { + "type": "structure", + "members": { + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway route table.

", + "smithy.api#required": {} + } + }, + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The CIDR range for the route. This must match the CIDR for the route exactly.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayRouteResult": { + "type": "structure", + "members": { + "Route": { + "target": "com.amazonaws.ec2#TransitGatewayRoute", + "traits": { + "aws.protocols#ec2QueryName": "Route", + "smithy.api#documentation": "

Information about the route.

", + "smithy.api#xmlName": "route" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayRouteTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayRouteTableRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayRouteTableResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified transit gateway route table. If there are any route tables associated with\n the transit gateway route table, you must first run DisassociateRouteTable before you can delete the transit gateway route table. This removes any route tables associated with the transit gateway route table.

" + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayRouteTableAnnouncement": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayRouteTableAnnouncementRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayRouteTableAnnouncementResult" + }, + "traits": { + "smithy.api#documentation": "

Advertises to the transit gateway that a transit gateway route table is deleted.

" + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayRouteTableAnnouncementRequest": { + "type": "structure", + "members": { + "TransitGatewayRouteTableAnnouncementId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The transit gateway route table ID that's being deleted.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayRouteTableAnnouncementResult": { + "type": "structure", + "members": { + "TransitGatewayRouteTableAnnouncement": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncement", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTableAnnouncement", + "smithy.api#documentation": "

Provides details about a deleted transit gateway route table.

", + "smithy.api#xmlName": "transitGatewayRouteTableAnnouncement" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayRouteTableRequest": { + "type": "structure", + "members": { + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway route table.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayRouteTableResult": { + "type": "structure", + "members": { + "TransitGatewayRouteTable": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTable", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTable", + "smithy.api#documentation": "

Information about the deleted transit gateway route table.

", + "smithy.api#xmlName": "transitGatewayRouteTable" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayVpcAttachment": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayVpcAttachmentRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayVpcAttachmentResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified VPC attachment.

" + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayVpcAttachmentRequest": { + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the attachment.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayVpcAttachmentResult": { + "type": "structure", + "members": { + "TransitGatewayVpcAttachment": { + "target": "com.amazonaws.ec2#TransitGatewayVpcAttachment", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayVpcAttachment", + "smithy.api#documentation": "

Information about the deleted VPC attachment.

", + "smithy.api#xmlName": "transitGatewayVpcAttachment" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteVerifiedAccessEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteVerifiedAccessEndpointRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteVerifiedAccessEndpointResult" + }, + "traits": { + "smithy.api#documentation": "

Delete an Amazon Web Services Verified Access endpoint.

" + } + }, + "com.amazonaws.ec2#DeleteVerifiedAccessEndpointRequest": { + "type": "structure", + "members": { + "VerifiedAccessEndpointId": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Verified Access endpoint.

", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteVerifiedAccessEndpointResult": { + "type": "structure", + "members": { + "VerifiedAccessEndpoint": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpoint", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessEndpoint", + "smithy.api#documentation": "

Details about the Verified Access endpoint.

", + "smithy.api#xmlName": "verifiedAccessEndpoint" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteVerifiedAccessGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteVerifiedAccessGroupRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteVerifiedAccessGroupResult" + }, + "traits": { + "smithy.api#documentation": "

Delete an Amazon Web Services Verified Access group.

" + } + }, + "com.amazonaws.ec2#DeleteVerifiedAccessGroupRequest": { + "type": "structure", + "members": { + "VerifiedAccessGroupId": { + "target": "com.amazonaws.ec2#VerifiedAccessGroupId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Verified Access group.

", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteVerifiedAccessGroupResult": { + "type": "structure", + "members": { + "VerifiedAccessGroup": { + "target": "com.amazonaws.ec2#VerifiedAccessGroup", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessGroup", + "smithy.api#documentation": "

Details about the Verified Access group.

", + "smithy.api#xmlName": "verifiedAccessGroup" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteVerifiedAccessInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteVerifiedAccessInstanceRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteVerifiedAccessInstanceResult" + }, + "traits": { + "smithy.api#documentation": "

Delete an Amazon Web Services Verified Access instance.

" + } + }, + "com.amazonaws.ec2#DeleteVerifiedAccessInstanceRequest": { + "type": "structure", + "members": { + "VerifiedAccessInstanceId": { + "target": "com.amazonaws.ec2#VerifiedAccessInstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Verified Access instance.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring idempotency.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteVerifiedAccessInstanceResult": { + "type": "structure", + "members": { + "VerifiedAccessInstance": { + "target": "com.amazonaws.ec2#VerifiedAccessInstance", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessInstance", + "smithy.api#documentation": "

Details about the Verified Access instance.

", + "smithy.api#xmlName": "verifiedAccessInstance" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteVerifiedAccessTrustProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteVerifiedAccessTrustProviderRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteVerifiedAccessTrustProviderResult" + }, + "traits": { + "smithy.api#documentation": "

Delete an Amazon Web Services Verified Access trust provider.

" + } + }, + "com.amazonaws.ec2#DeleteVerifiedAccessTrustProviderRequest": { + "type": "structure", + "members": { + "VerifiedAccessTrustProviderId": { + "target": "com.amazonaws.ec2#VerifiedAccessTrustProviderId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Verified Access trust provider.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring idempotency.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteVerifiedAccessTrustProviderResult": { + "type": "structure", + "members": { + "VerifiedAccessTrustProvider": { + "target": "com.amazonaws.ec2#VerifiedAccessTrustProvider", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessTrustProvider", + "smithy.api#documentation": "

Details about the Verified Access trust provider.

", + "smithy.api#xmlName": "verifiedAccessTrustProvider" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteVolume": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteVolumeRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified EBS volume. The volume must be in the available state\n (not attached to an instance).

\n

The volume can remain in the deleting state for several minutes.

\n

For more information, see Delete an Amazon EBS volume in the\n Amazon EBS User Guide.

", + "smithy.api#examples": [ + { + "title": "To delete a volume", + "documentation": "This example deletes an available volume with the volume ID of ``vol-049df61146c4d7901``. If the command succeeds, no output is returned.", + "input": { + "VolumeId": "vol-049df61146c4d7901" + }, + "output": {} + } + ] + } + }, + "com.amazonaws.ec2#DeleteVolumeRequest": { + "type": "structure", + "members": { + "VolumeId": { + "target": "com.amazonaws.ec2#VolumeId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the volume.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteVpc": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteVpcRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified VPC. You must detach or delete all gateways and resources that are associated \n\t\t with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, \n\t\t delete all security groups associated with the VPC (except the default one), delete all route tables \n\t\t associated with the VPC (except the default one), and so on. When you delete the VPC, it deletes the \n\t\t default security group, network ACL, and route table for the VPC.

\n

If you created a flow log for the VPC that you are deleting, note that flow logs for deleted \n VPCs are eventually automatically removed.

", + "smithy.api#examples": [ + { + "title": "To delete a VPC", + "documentation": "This example deletes the specified VPC.", + "input": { + "VpcId": "vpc-a01106c2" + } + } + ] + } + }, + "com.amazonaws.ec2#DeleteVpcBlockPublicAccessExclusion": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteVpcBlockPublicAccessExclusionRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteVpcBlockPublicAccessExclusionResult" + }, + "traits": { + "smithy.api#documentation": "

Delete a VPC Block Public Access (BPA) exclusion. A VPC BPA exclusion is a mode that can be applied to a single VPC or subnet that exempts it from the account’s BPA mode and will allow bidirectional or egress-only access. You can create BPA exclusions for VPCs and subnets even when BPA is not enabled on the account to ensure that there is no traffic disruption to the exclusions when VPC BPA is turned on. To learn more about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User Guide.

" + } + }, + "com.amazonaws.ec2#DeleteVpcBlockPublicAccessExclusionRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ExclusionId": { + "target": "com.amazonaws.ec2#VpcBlockPublicAccessExclusionId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the exclusion.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteVpcBlockPublicAccessExclusionResult": { + "type": "structure", + "members": { + "VpcBlockPublicAccessExclusion": { + "target": "com.amazonaws.ec2#VpcBlockPublicAccessExclusion", + "traits": { + "aws.protocols#ec2QueryName": "VpcBlockPublicAccessExclusion", + "smithy.api#documentation": "

Details about an exclusion.

", + "smithy.api#xmlName": "vpcBlockPublicAccessExclusion" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteVpcEndpointConnectionNotifications": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteVpcEndpointConnectionNotificationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteVpcEndpointConnectionNotificationsResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified VPC endpoint connection notifications.

" + } + }, + "com.amazonaws.ec2#DeleteVpcEndpointConnectionNotificationsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ConnectionNotificationIds": { + "target": "com.amazonaws.ec2#ConnectionNotificationIdsList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the notifications.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "ConnectionNotificationId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteVpcEndpointConnectionNotificationsResult": { + "type": "structure", + "members": { + "Unsuccessful": { + "target": "com.amazonaws.ec2#UnsuccessfulItemSet", + "traits": { + "aws.protocols#ec2QueryName": "Unsuccessful", + "smithy.api#documentation": "

Information about the notifications that could not be deleted\n successfully.

", + "smithy.api#xmlName": "unsuccessful" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteVpcEndpointServiceConfigurations": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteVpcEndpointServiceConfigurationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteVpcEndpointServiceConfigurationsResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified VPC endpoint service configurations. Before you can delete\n an endpoint service configuration, you must reject any Available or\n PendingAcceptance interface endpoint connections that are attached to\n the service.

" + } + }, + "com.amazonaws.ec2#DeleteVpcEndpointServiceConfigurationsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ServiceIds": { + "target": "com.amazonaws.ec2#VpcEndpointServiceIdList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the services.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "ServiceId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteVpcEndpointServiceConfigurationsResult": { + "type": "structure", + "members": { + "Unsuccessful": { + "target": "com.amazonaws.ec2#UnsuccessfulItemSet", + "traits": { + "aws.protocols#ec2QueryName": "Unsuccessful", + "smithy.api#documentation": "

Information about the service configurations that were not deleted, if\n applicable.

", + "smithy.api#xmlName": "unsuccessful" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteVpcEndpoints": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteVpcEndpointsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteVpcEndpointsResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified VPC endpoints.

\n

When you delete a gateway endpoint, we delete the endpoint routes in the route tables for the endpoint.

\n

When you delete a Gateway Load Balancer endpoint, we delete its endpoint network interfaces. \n You can only delete Gateway Load Balancer endpoints when the routes that are associated with the endpoint are deleted.

\n

When you delete an interface endpoint, we delete its endpoint network interfaces.

" + } + }, + "com.amazonaws.ec2#DeleteVpcEndpointsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "VpcEndpointIds": { + "target": "com.amazonaws.ec2#VpcEndpointIdList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the VPC endpoints.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "VpcEndpointId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteVpcEndpointsResult": { + "type": "structure", + "members": { + "Unsuccessful": { + "target": "com.amazonaws.ec2#UnsuccessfulItemSet", + "traits": { + "aws.protocols#ec2QueryName": "Unsuccessful", + "smithy.api#documentation": "

Information about the VPC endpoints that were not successfully deleted.

", + "smithy.api#xmlName": "unsuccessful" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteVpcPeeringConnection": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteVpcPeeringConnectionRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteVpcPeeringConnectionResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes a VPC peering connection. Either the owner of the requester VPC or the owner\n of the accepter VPC can delete the VPC peering connection if it's in the\n active state. The owner of the requester VPC can delete a VPC peering\n connection in the pending-acceptance state. You cannot delete a VPC peering\n connection that's in the failed or rejected state.

" + } + }, + "com.amazonaws.ec2#DeleteVpcPeeringConnectionRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "VpcPeeringConnectionId": { + "target": "com.amazonaws.ec2#VpcPeeringConnectionId", + "traits": { + "aws.protocols#ec2QueryName": "VpcPeeringConnectionId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC peering connection.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "vpcPeeringConnectionId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteVpcPeeringConnectionResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteVpcRequest": { + "type": "structure", + "members": { + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteVpnConnection": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteVpnConnectionRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified VPN connection.

\n

If you're deleting the VPC and its associated components, we recommend that you detach\n the virtual private gateway from the VPC and delete the VPC before deleting the VPN\n connection. If you believe that the tunnel credentials for your VPN connection have been\n compromised, you can delete the VPN connection and create a new one that has new keys,\n without needing to delete the VPC or virtual private gateway. If you create a new VPN\n connection, you must reconfigure the customer gateway device using the new configuration\n information returned with the new VPN connection ID.

\n

For certificate-based authentication, delete all Certificate Manager (ACM) private\n certificates used for the Amazon Web Services-side tunnel endpoints for the VPN\n connection before deleting the VPN connection.

" + } + }, + "com.amazonaws.ec2#DeleteVpnConnectionRequest": { + "type": "structure", + "members": { + "VpnConnectionId": { + "target": "com.amazonaws.ec2#VpnConnectionId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPN connection.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DeleteVpnConnection.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteVpnConnectionRoute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteVpnConnectionRouteRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified static route associated with a VPN connection between an\n existing virtual private gateway and a VPN customer gateway. The static route allows\n traffic to be routed from the virtual private gateway to the VPN customer\n gateway.

" + } + }, + "com.amazonaws.ec2#DeleteVpnConnectionRouteRequest": { + "type": "structure", + "members": { + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The CIDR block associated with the local subnet of the customer network.

", + "smithy.api#required": {} + } + }, + "VpnConnectionId": { + "target": "com.amazonaws.ec2#VpnConnectionId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPN connection.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DeleteVpnConnectionRoute.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteVpnGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteVpnGatewayRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified virtual private gateway. You must first detach the virtual\n private gateway from the VPC. Note that you don't need to delete the virtual private\n gateway if you plan to delete and recreate the VPN connection between your VPC and your\n network.

" + } + }, + "com.amazonaws.ec2#DeleteVpnGatewayRequest": { + "type": "structure", + "members": { + "VpnGatewayId": { + "target": "com.amazonaws.ec2#VpnGatewayId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the virtual private gateway.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DeleteVpnGateway.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeprovisionByoipCidr": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeprovisionByoipCidrRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeprovisionByoipCidrResult" + }, + "traits": { + "smithy.api#documentation": "

Releases the specified address range that you provisioned for use with your Amazon Web Services resources\n through bring your own IP addresses (BYOIP) and deletes the corresponding address pool.

\n

Before you can release an address range, you must stop advertising it using WithdrawByoipCidr and you must not have any IP addresses allocated from its\n address range.

" + } + }, + "com.amazonaws.ec2#DeprovisionByoipCidrRequest": { + "type": "structure", + "members": { + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The address range, in CIDR notation. The prefix must be the same prefix \n that you specified when you provisioned the address range.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeprovisionByoipCidrResult": { + "type": "structure", + "members": { + "ByoipCidr": { + "target": "com.amazonaws.ec2#ByoipCidr", + "traits": { + "aws.protocols#ec2QueryName": "ByoipCidr", + "smithy.api#documentation": "

Information about the address range.

", + "smithy.api#xmlName": "byoipCidr" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeprovisionIpamByoasn": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeprovisionIpamByoasnRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeprovisionIpamByoasnResult" + }, + "traits": { + "smithy.api#documentation": "

Deprovisions your Autonomous System Number (ASN) from your Amazon Web Services account. This action can only be called after any BYOIP CIDR associations are removed from your Amazon Web Services account with DisassociateIpamByoasn.\n For more information, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide.

" + } + }, + "com.amazonaws.ec2#DeprovisionIpamByoasnRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamId": { + "target": "com.amazonaws.ec2#IpamId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IPAM ID.

", + "smithy.api#required": {} + } + }, + "Asn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An ASN.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeprovisionIpamByoasnResult": { + "type": "structure", + "members": { + "Byoasn": { + "target": "com.amazonaws.ec2#Byoasn", + "traits": { + "aws.protocols#ec2QueryName": "Byoasn", + "smithy.api#documentation": "

An ASN and BYOIP CIDR association.

", + "smithy.api#xmlName": "byoasn" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeprovisionIpamPoolCidr": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeprovisionIpamPoolCidrRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeprovisionIpamPoolCidrResult" + }, + "traits": { + "smithy.api#documentation": "

Deprovision a CIDR provisioned from an IPAM pool. If you deprovision a CIDR from a pool that has a source pool, the CIDR is recycled back into the source pool. For more information, see Deprovision pool CIDRs in the Amazon VPC IPAM User Guide.

" + } + }, + "com.amazonaws.ec2#DeprovisionIpamPoolCidrRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the pool that has the CIDR you want to deprovision.

", + "smithy.api#required": {} + } + }, + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The CIDR which you want to deprovision from the pool.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeprovisionIpamPoolCidrResult": { + "type": "structure", + "members": { + "IpamPoolCidr": { + "target": "com.amazonaws.ec2#IpamPoolCidr", + "traits": { + "aws.protocols#ec2QueryName": "IpamPoolCidr", + "smithy.api#documentation": "

The deprovisioned pool CIDR.

", + "smithy.api#xmlName": "ipamPoolCidr" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeprovisionPublicIpv4PoolCidr": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeprovisionPublicIpv4PoolCidrRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeprovisionPublicIpv4PoolCidrResult" + }, + "traits": { + "smithy.api#documentation": "

Deprovision a CIDR from a public IPv4 pool.

" + } + }, + "com.amazonaws.ec2#DeprovisionPublicIpv4PoolCidrRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "PoolId": { + "target": "com.amazonaws.ec2#Ipv4PoolEc2Id", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the pool that you want to deprovision the CIDR from.

", + "smithy.api#required": {} + } + }, + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The CIDR you want to deprovision from the pool. Enter the CIDR you want to deprovision with a netmask of /32. You must rerun this command for each IP address in the CIDR range. If your CIDR is a /24, you will have to run this command to deprovision each of the 256 IP addresses in the /24 CIDR.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeprovisionPublicIpv4PoolCidrResult": { + "type": "structure", + "members": { + "PoolId": { + "target": "com.amazonaws.ec2#Ipv4PoolEc2Id", + "traits": { + "aws.protocols#ec2QueryName": "PoolId", + "smithy.api#documentation": "

The ID of the pool that you deprovisioned the CIDR from.

", + "smithy.api#xmlName": "poolId" + } + }, + "DeprovisionedAddresses": { + "target": "com.amazonaws.ec2#DeprovisionedAddressSet", + "traits": { + "aws.protocols#ec2QueryName": "DeprovisionedAddressSet", + "smithy.api#documentation": "

The deprovisioned CIDRs.

", + "smithy.api#xmlName": "deprovisionedAddressSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeprovisionedAddressSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#DeregisterImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeregisterImageRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new\n instances.

\n

If you deregister an AMI that matches a Recycle Bin retention rule, the AMI is retained in\n the Recycle Bin for the specified retention period. For more information, see Recycle Bin in\n the Amazon EC2 User Guide.

\n

When you deregister an AMI, it doesn't affect any instances that you've already launched\n from the AMI. You'll continue to incur usage costs for those instances until you terminate\n them.

\n

When you deregister an Amazon EBS-backed AMI, it doesn't affect the snapshot that was created\n for the root volume of the instance during the AMI creation process. When you deregister an\n instance store-backed AMI, it doesn't affect the files that you uploaded to Amazon S3 when you\n created the AMI.

" + } + }, + "com.amazonaws.ec2#DeregisterImageRequest": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the AMI.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DeregisterImage.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeregisterInstanceEventNotificationAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeregisterInstanceEventNotificationAttributesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeregisterInstanceEventNotificationAttributesResult" + }, + "traits": { + "smithy.api#documentation": "

Deregisters tag keys to prevent tags that have the specified tag keys from being included\n\t\t\tin scheduled event notifications for resources in the Region.

" + } + }, + "com.amazonaws.ec2#DeregisterInstanceEventNotificationAttributesRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "InstanceTagAttribute": { + "target": "com.amazonaws.ec2#DeregisterInstanceTagAttributeRequest", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Information about the tag keys to deregister.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeregisterInstanceEventNotificationAttributesResult": { + "type": "structure", + "members": { + "InstanceTagAttribute": { + "target": "com.amazonaws.ec2#InstanceTagNotificationAttribute", + "traits": { + "aws.protocols#ec2QueryName": "InstanceTagAttribute", + "smithy.api#documentation": "

The resulting set of tag keys.

", + "smithy.api#xmlName": "instanceTagAttribute" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeregisterInstanceTagAttributeRequest": { + "type": "structure", + "members": { + "IncludeAllTagsOfInstance": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether to deregister all tag keys in the current Region. Specify false \n \t\tto deregister all tag keys.

" + } + }, + "InstanceTagKeys": { + "target": "com.amazonaws.ec2#InstanceTagKeySet", + "traits": { + "smithy.api#documentation": "

Information about the tag keys to deregister.

", + "smithy.api#xmlName": "InstanceTagKey" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the tag keys to deregister for the current Region. You can either specify \n \t\tindividual tag keys or deregister all tag keys in the current Region. You must specify either\n \t\tIncludeAllTagsOfInstance or InstanceTagKeys in the request

" + } + }, + "com.amazonaws.ec2#DeregisterTransitGatewayMulticastGroupMembers": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeregisterTransitGatewayMulticastGroupMembersRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeregisterTransitGatewayMulticastGroupMembersResult" + }, + "traits": { + "smithy.api#documentation": "

Deregisters the specified members (network interfaces) from the transit gateway multicast group.

" + } + }, + "com.amazonaws.ec2#DeregisterTransitGatewayMulticastGroupMembersRequest": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainId", + "traits": { + "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

" + } + }, + "GroupIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IP address assigned to the transit gateway multicast group.

" + } + }, + "NetworkInterfaceIds": { + "target": "com.amazonaws.ec2#TransitGatewayNetworkInterfaceIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the group members' network interfaces.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeregisterTransitGatewayMulticastGroupMembersResult": { + "type": "structure", + "members": { + "DeregisteredMulticastGroupMembers": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDeregisteredGroupMembers", + "traits": { + "aws.protocols#ec2QueryName": "DeregisteredMulticastGroupMembers", + "smithy.api#documentation": "

Information about the deregistered members.

", + "smithy.api#xmlName": "deregisteredMulticastGroupMembers" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeregisterTransitGatewayMulticastGroupSources": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeregisterTransitGatewayMulticastGroupSourcesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeregisterTransitGatewayMulticastGroupSourcesResult" + }, + "traits": { + "smithy.api#documentation": "

Deregisters the specified sources (network interfaces) from the transit gateway multicast group.

" + } + }, + "com.amazonaws.ec2#DeregisterTransitGatewayMulticastGroupSourcesRequest": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainId", + "traits": { + "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

" + } + }, + "GroupIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IP address assigned to the transit gateway multicast group.

" + } + }, + "NetworkInterfaceIds": { + "target": "com.amazonaws.ec2#TransitGatewayNetworkInterfaceIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the group sources' network interfaces.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeregisterTransitGatewayMulticastGroupSourcesResult": { + "type": "structure", + "members": { + "DeregisteredMulticastGroupSources": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDeregisteredGroupSources", + "traits": { + "aws.protocols#ec2QueryName": "DeregisteredMulticastGroupSources", + "smithy.api#documentation": "

Information about the deregistered group sources.

", + "smithy.api#xmlName": "deregisteredMulticastGroupSources" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeAccountAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeAccountAttributesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeAccountAttributesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes attributes of your Amazon Web Services account. The following are the supported account attributes:

\n \n \n

The order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.

\n ", + "smithy.api#examples": [ + { + "title": "To describe a single attribute for your AWS account", + "documentation": "This example describes the supported-platforms attribute for your AWS account.", + "input": { + "AttributeNames": [ + "supported-platforms" + ] + }, + "output": { + "AccountAttributes": [ + { + "AttributeName": "supported-platforms", + "AttributeValues": [ + { + "AttributeValue": "EC2" + }, + { + "AttributeValue": "VPC" + } + ] + } + ] + } + }, + { + "title": "To describe all attributes for your AWS account", + "documentation": "This example describes the attributes for your AWS account.", + "output": { + "AccountAttributes": [ + { + "AttributeName": "supported-platforms", + "AttributeValues": [ + { + "AttributeValue": "EC2" + }, + { + "AttributeValue": "VPC" + } + ] + }, + { + "AttributeName": "vpc-max-security-groups-per-interface", + "AttributeValues": [ + { + "AttributeValue": "5" + } + ] + }, + { + "AttributeName": "max-elastic-ips", + "AttributeValues": [ + { + "AttributeValue": "5" + } + ] + }, + { + "AttributeName": "max-instances", + "AttributeValues": [ + { + "AttributeValue": "20" + } + ] + }, + { + "AttributeName": "vpc-max-elastic-ips", + "AttributeValues": [ + { + "AttributeValue": "5" + } + ] + }, + { + "AttributeName": "default-vpc", + "AttributeValues": [ + { + "AttributeValue": "none" + } + ] + } + ] + } + } + ] + } + }, + "com.amazonaws.ec2#DescribeAccountAttributesRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "AttributeNames": { + "target": "com.amazonaws.ec2#AccountAttributeNameStringList", + "traits": { + "aws.protocols#ec2QueryName": "AttributeName", + "smithy.api#documentation": "

The account attribute names.

", + "smithy.api#xmlName": "attributeName" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeAccountAttributesResult": { + "type": "structure", + "members": { + "AccountAttributes": { + "target": "com.amazonaws.ec2#AccountAttributeList", + "traits": { + "aws.protocols#ec2QueryName": "AccountAttributeSet", + "smithy.api#documentation": "

Information about the account attributes.

", + "smithy.api#xmlName": "accountAttributeSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeAddressTransfers": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeAddressTransfersRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeAddressTransfersResult" + }, + "traits": { + "smithy.api#documentation": "

Describes an Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon VPC User Guide.

\n

When you transfer an Elastic IP address, there is a two-step handshake\n between the source and transfer Amazon Web Services accounts. When the source account starts the transfer,\n the transfer account has seven days to accept the Elastic IP address\n transfer. During those seven days, the source account can view the\n pending transfer by using this action. After seven days, the\n transfer expires and ownership of the Elastic IP\n address returns to the source\n account. Accepted transfers are visible to the source account for 14 days\n after the transfers have been accepted.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AddressTransfers", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeAddressTransfersMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeAddressTransfersRequest": { + "type": "structure", + "members": { + "AllocationIds": { + "target": "com.amazonaws.ec2#AllocationIdList", + "traits": { + "smithy.api#documentation": "

The allocation IDs of Elastic IP addresses.

", + "smithy.api#xmlName": "AllocationId" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Specify the pagination token from a previous request to retrieve the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeAddressTransfersMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of address transfers to return in one page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeAddressTransfersResult": { + "type": "structure", + "members": { + "AddressTransfers": { + "target": "com.amazonaws.ec2#AddressTransferList", + "traits": { + "aws.protocols#ec2QueryName": "AddressTransferSet", + "smithy.api#documentation": "

The Elastic IP address transfer.

", + "smithy.api#xmlName": "addressTransferSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

Specify the pagination token from a previous request to retrieve the next page of results.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeAddresses": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeAddressesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeAddressesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified Elastic IP addresses or all of your Elastic IP addresses.

", + "smithy.api#examples": [ + { + "title": "To describe your Elastic IP addresses", + "documentation": "This example describes your Elastic IP addresses.", + "output": { + "Addresses": [ + { + "InstanceId": "i-1234567890abcdef0", + "PublicIp": "198.51.100.0", + "Domain": "standard" + }, + { + "Domain": "vpc", + "InstanceId": "i-1234567890abcdef0", + "NetworkInterfaceId": "eni-12345678", + "AssociationId": "eipassoc-12345678", + "NetworkInterfaceOwnerId": "123456789012", + "PublicIp": "203.0.113.0", + "AllocationId": "eipalloc-12345678", + "PrivateIpAddress": "10.0.1.241" + } + ] + } + } + ] + } + }, + "com.amazonaws.ec2#DescribeAddressesAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeAddressesAttributeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeAddressesAttributeResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the attributes of the specified Elastic IP addresses. For requirements, see Using reverse DNS for email applications.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Addresses", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeAddressesAttributeRequest": { + "type": "structure", + "members": { + "AllocationIds": { + "target": "com.amazonaws.ec2#AllocationIds", + "traits": { + "smithy.api#documentation": "

[EC2-VPC] The allocation IDs.

", + "smithy.api#xmlName": "AllocationId" + } + }, + "Attribute": { + "target": "com.amazonaws.ec2#AddressAttributeName", + "traits": { + "smithy.api#documentation": "

The attribute of the IP address.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#AddressMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeAddressesAttributeResult": { + "type": "structure", + "members": { + "Addresses": { + "target": "com.amazonaws.ec2#AddressSet", + "traits": { + "aws.protocols#ec2QueryName": "AddressSet", + "smithy.api#documentation": "

Information about the IP addresses.

", + "smithy.api#xmlName": "addressSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeAddressesRequest": { + "type": "structure", + "members": { + "PublicIps": { + "target": "com.amazonaws.ec2#PublicIpStringList", + "traits": { + "smithy.api#documentation": "

One or more Elastic IP addresses.

\n

Default: Describes all your Elastic IP addresses.

", + "smithy.api#xmlName": "PublicIp" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "AllocationIds": { + "target": "com.amazonaws.ec2#AllocationIdList", + "traits": { + "smithy.api#documentation": "

Information about the allocation IDs.

", + "smithy.api#xmlName": "AllocationId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeAddressesResult": { + "type": "structure", + "members": { + "Addresses": { + "target": "com.amazonaws.ec2#AddressList", + "traits": { + "aws.protocols#ec2QueryName": "AddressesSet", + "smithy.api#documentation": "

Information about the Elastic IP addresses.

", + "smithy.api#xmlName": "addressesSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeAggregateIdFormat": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeAggregateIdFormatRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeAggregateIdFormatResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the longer ID format settings for all resource types in a specific\n Region. This request is useful for performing a quick audit to determine whether a\n specific Region is fully opted in for longer IDs (17-character IDs).

\n

This request only returns information about resource types that support longer IDs.

\n

The following resource types support longer IDs: bundle |\n conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | instance | internet-gateway |\n network-acl | network-acl-association |\n network-interface | network-interface-attachment |\n prefix-list | reservation | route-table |\n route-table-association | security-group |\n snapshot | subnet |\n subnet-cidr-block-association | volume | vpc |\n vpc-cidr-block-association | vpc-endpoint |\n vpc-peering-connection | vpn-connection | vpn-gateway.

" + } + }, + "com.amazonaws.ec2#DescribeAggregateIdFormatRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeAggregateIdFormatResult": { + "type": "structure", + "members": { + "UseLongIdsAggregated": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "UseLongIdsAggregated", + "smithy.api#documentation": "

Indicates whether all resource types in the Region are configured to use longer IDs.\n This value is only true if all users are configured to use longer IDs for\n all resources types in the Region.

", + "smithy.api#xmlName": "useLongIdsAggregated" + } + }, + "Statuses": { + "target": "com.amazonaws.ec2#IdFormatList", + "traits": { + "aws.protocols#ec2QueryName": "StatusSet", + "smithy.api#documentation": "

Information about each resource's ID format.

", + "smithy.api#xmlName": "statusSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeAvailabilityZones": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeAvailabilityZonesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeAvailabilityZonesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the Availability Zones, Local Zones, and Wavelength Zones that are available to\n you. If there is an event impacting a zone, you can use this request to view the state and any\n provided messages for that zone.

\n

For more information about Availability Zones, Local Zones, and Wavelength Zones, see\n Regions and zones \n in the Amazon EC2 User Guide.

\n \n

The order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.

\n ", + "smithy.api#examples": [ + { + "title": "To describe your Availability Zones", + "documentation": "This example describes the Availability Zones that are available to you. The response includes Availability Zones only for the current region.", + "output": { + "AvailabilityZones": [ + { + "State": "available", + "RegionName": "us-east-1", + "Messages": [], + "ZoneName": "us-east-1b" + }, + { + "State": "available", + "RegionName": "us-east-1", + "Messages": [], + "ZoneName": "us-east-1c" + }, + { + "State": "available", + "RegionName": "us-east-1", + "Messages": [], + "ZoneName": "us-east-1d" + }, + { + "State": "available", + "RegionName": "us-east-1", + "Messages": [], + "ZoneName": "us-east-1e" + } + ] + } + } + ] + } + }, + "com.amazonaws.ec2#DescribeAvailabilityZonesRequest": { + "type": "structure", + "members": { + "ZoneNames": { + "target": "com.amazonaws.ec2#ZoneNameStringList", + "traits": { + "smithy.api#documentation": "

The names of the Availability Zones, Local Zones, and Wavelength Zones.

", + "smithy.api#xmlName": "ZoneName" + } + }, + "ZoneIds": { + "target": "com.amazonaws.ec2#ZoneIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the Availability Zones, Local Zones, and Wavelength Zones.

", + "smithy.api#xmlName": "ZoneId" + } + }, + "AllAvailabilityZones": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Include all Availability Zones, Local Zones, and Wavelength Zones regardless of your\n opt-in status.

\n

If you do not use this parameter, the results include only the zones for the Regions where you have chosen the option to opt in.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeAvailabilityZonesResult": { + "type": "structure", + "members": { + "AvailabilityZones": { + "target": "com.amazonaws.ec2#AvailabilityZoneList", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZoneInfo", + "smithy.api#documentation": "

Information about the Availability Zones, Local Zones, and Wavelength Zones.

", + "smithy.api#xmlName": "availabilityZoneInfo" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeAwsNetworkPerformanceMetricSubscriptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeAwsNetworkPerformanceMetricSubscriptionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeAwsNetworkPerformanceMetricSubscriptionsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the current Infrastructure Performance metric subscriptions.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Subscriptions", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeAwsNetworkPerformanceMetricSubscriptionsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.ec2#MaxResultsParam", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

", + "smithy.api#xmlName": "Filter" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeAwsNetworkPerformanceMetricSubscriptionsResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "Subscriptions": { + "target": "com.amazonaws.ec2#SubscriptionList", + "traits": { + "aws.protocols#ec2QueryName": "SubscriptionSet", + "smithy.api#documentation": "

Describes the current Infrastructure Performance subscriptions.

", + "smithy.api#xmlName": "subscriptionSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeBundleTasks": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeBundleTasksRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeBundleTasksResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified bundle tasks or all of your bundle tasks.

\n \n

Completed bundle tasks are listed for only a limited time. If your bundle task is no\n longer in the list, you can still register an AMI from it. Just use\n RegisterImage with the Amazon S3 bucket name and image manifest name you provided\n to the bundle task.

\n \n \n

The order of the elements in the response, including those within nested structures,\n might vary. Applications should not assume the elements appear in a particular order.

\n ", + "smithy.waiters#waitable": { + "BundleTaskComplete": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "BundleTasks[].State", + "expected": "complete", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "BundleTasks[].State", + "expected": "failed", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 15 + } + } + } + }, + "com.amazonaws.ec2#DescribeBundleTasksRequest": { + "type": "structure", + "members": { + "BundleIds": { + "target": "com.amazonaws.ec2#BundleIdStringList", + "traits": { + "smithy.api#documentation": "

The bundle task IDs.

\n

Default: Describes all your bundle tasks.

", + "smithy.api#xmlName": "BundleId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeBundleTasksResult": { + "type": "structure", + "members": { + "BundleTasks": { + "target": "com.amazonaws.ec2#BundleTaskList", + "traits": { + "aws.protocols#ec2QueryName": "BundleInstanceTasksSet", + "smithy.api#documentation": "

Information about the bundle tasks.

", + "smithy.api#xmlName": "bundleInstanceTasksSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeByoipCidrs": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeByoipCidrsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeByoipCidrsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the IP address ranges that were specified in calls to ProvisionByoipCidr.

\n

To describe the address pools that were created when you provisioned the address\n ranges, use DescribePublicIpv4Pools or DescribeIpv6Pools.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ByoipCidrs", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeByoipCidrsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.ec2#DescribeByoipCidrsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeByoipCidrsMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeByoipCidrsResult": { + "type": "structure", + "members": { + "ByoipCidrs": { + "target": "com.amazonaws.ec2#ByoipCidrSet", + "traits": { + "aws.protocols#ec2QueryName": "ByoipCidrSet", + "smithy.api#documentation": "

Information about your address ranges.

", + "smithy.api#xmlName": "byoipCidrSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeCapacityBlockExtensionHistory": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeCapacityBlockExtensionHistoryRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeCapacityBlockExtensionHistoryResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the events for the specified Capacity Block extension during the specified\n\t\t\ttime.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "CapacityBlockExtensions", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeCapacityBlockExtensionHistoryRequest": { + "type": "structure", + "members": { + "CapacityReservationIds": { + "target": "com.amazonaws.ec2#CapacityReservationIdSet", + "traits": { + "smithy.api#documentation": "

The IDs of Capacity Block reservations that you want to display the history\n\t\t\tfor.

", + "smithy.api#xmlName": "CapacityReservationId" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeFutureCapacityMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, \n see Pagination.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeCapacityBlockExtensionHistoryResult": { + "type": "structure", + "members": { + "CapacityBlockExtensions": { + "target": "com.amazonaws.ec2#CapacityBlockExtensionSet", + "traits": { + "aws.protocols#ec2QueryName": "CapacityBlockExtensionSet", + "smithy.api#documentation": "

Describes one or more of your Capacity Block extensions. The results describe only the\n\t\t\tCapacity Block extensions in the Amazon Web Services Region that you're currently using.

", + "smithy.api#xmlName": "capacityBlockExtensionSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeCapacityBlockExtensionOfferings": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeCapacityBlockExtensionOfferingsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeCapacityBlockExtensionOfferingsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes Capacity Block extension offerings available for purchase in the Amazon Web Services Region\n\t\t\tthat you're currently using.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "CapacityBlockExtensionOfferings", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeCapacityBlockExtensionOfferingsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeCapacityBlockExtensionOfferingsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "CapacityBlockExtensionDurationHours": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The duration of the Capacity Block extension offering in hours.

", + "smithy.api#required": {} + } + }, + "CapacityReservationId": { + "target": "com.amazonaws.ec2#CapacityReservationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Capacity reservation to be extended.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeCapacityBlockExtensionOfferingsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, \n see Pagination.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeCapacityBlockExtensionOfferingsResult": { + "type": "structure", + "members": { + "CapacityBlockExtensionOfferings": { + "target": "com.amazonaws.ec2#CapacityBlockExtensionOfferingSet", + "traits": { + "aws.protocols#ec2QueryName": "CapacityBlockExtensionOfferingSet", + "smithy.api#documentation": "

The recommended Capacity Block extension offerings for the dates specified.

", + "smithy.api#xmlName": "capacityBlockExtensionOfferingSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeCapacityBlockOfferings": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeCapacityBlockOfferingsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeCapacityBlockOfferingsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes Capacity Block offerings available for purchase in the Amazon Web Services Region that you're currently using. With Capacity Blocks, you purchase a\n\t\t\tspecific instance type for a period of time.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "CapacityBlockOfferings", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeCapacityBlockOfferingsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeCapacityBlockOfferingsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The type of instance for which the Capacity Block offering reserves capacity.

" + } + }, + "InstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The number of instances for which to reserve capacity.

" + } + }, + "StartDateRange": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "smithy.api#documentation": "

The earliest start date for the Capacity Block offering.

" + } + }, + "EndDateRange": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "smithy.api#documentation": "

The latest end date for the Capacity Block offering.

" + } + }, + "CapacityDurationHours": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of hours for which to reserve Capacity Block.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeCapacityBlockOfferingsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, \n see Pagination.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeCapacityBlockOfferingsResult": { + "type": "structure", + "members": { + "CapacityBlockOfferings": { + "target": "com.amazonaws.ec2#CapacityBlockOfferingSet", + "traits": { + "aws.protocols#ec2QueryName": "CapacityBlockOfferingSet", + "smithy.api#documentation": "

The recommended Capacity Block offering for the dates specified.

", + "smithy.api#xmlName": "capacityBlockOfferingSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeCapacityReservationBillingRequests": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeCapacityReservationBillingRequestsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeCapacityReservationBillingRequestsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes a request to assign the billing of the unused capacity of a Capacity\n\t\t\tReservation. For more information, see Billing assignment for shared\n\t\t\t\t\tAmazon EC2 Capacity Reservations.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "CapacityReservationBillingRequests", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeCapacityReservationBillingRequestsRequest": { + "type": "structure", + "members": { + "CapacityReservationIds": { + "target": "com.amazonaws.ec2#CapacityReservationIdSet", + "traits": { + "smithy.api#documentation": "

The ID of the Capacity Reservation.

", + "smithy.api#xmlName": "CapacityReservationId" + } + }, + "Role": { + "target": "com.amazonaws.ec2#CallerRole", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specify one of the following:

\n ", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeCapacityReservationBillingRequestsRequestMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, \n see Pagination.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeCapacityReservationBillingRequestsRequestMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeCapacityReservationBillingRequestsResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "CapacityReservationBillingRequests": { + "target": "com.amazonaws.ec2#CapacityReservationBillingRequestSet", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationBillingRequestSet", + "smithy.api#documentation": "

Information about the request.

", + "smithy.api#xmlName": "capacityReservationBillingRequestSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeCapacityReservationFleets": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeCapacityReservationFleetsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeCapacityReservationFleetsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more Capacity Reservation Fleets.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "CapacityReservationFleets", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeCapacityReservationFleetsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.ec2#DescribeCapacityReservationFleetsRequest": { + "type": "structure", + "members": { + "CapacityReservationFleetIds": { + "target": "com.amazonaws.ec2#CapacityReservationFleetIdSet", + "traits": { + "smithy.api#documentation": "

The IDs of the Capacity Reservation Fleets to describe.

", + "smithy.api#xmlName": "CapacityReservationFleetId" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeCapacityReservationFleetsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, \n see Pagination.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeCapacityReservationFleetsResult": { + "type": "structure", + "members": { + "CapacityReservationFleets": { + "target": "com.amazonaws.ec2#CapacityReservationFleetSet", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationFleetSet", + "smithy.api#documentation": "

Information about the Capacity Reservation Fleets.

", + "smithy.api#xmlName": "capacityReservationFleetSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeCapacityReservations": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeCapacityReservationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeCapacityReservationsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more of your Capacity Reservations. The results describe only the\n\t\t\tCapacity Reservations in the Amazon Web Services Region that you're currently\n\t\t\tusing.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "CapacityReservations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeCapacityReservationsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeCapacityReservationsRequest": { + "type": "structure", + "members": { + "CapacityReservationIds": { + "target": "com.amazonaws.ec2#CapacityReservationIdSet", + "traits": { + "smithy.api#documentation": "

The ID of the Capacity Reservation.

", + "smithy.api#xmlName": "CapacityReservationId" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeCapacityReservationsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, \n see Pagination.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeCapacityReservationsResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "CapacityReservations": { + "target": "com.amazonaws.ec2#CapacityReservationSet", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationSet", + "smithy.api#documentation": "

Information about the Capacity Reservations.

", + "smithy.api#xmlName": "capacityReservationSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeCarrierGateways": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeCarrierGatewaysRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeCarrierGatewaysResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more of your carrier gateways.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "CarrierGateways", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeCarrierGatewaysRequest": { + "type": "structure", + "members": { + "CarrierGatewayIds": { + "target": "com.amazonaws.ec2#CarrierGatewayIdSet", + "traits": { + "smithy.api#documentation": "

One or more carrier gateway IDs.

", + "smithy.api#xmlName": "CarrierGatewayId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#CarrierGatewayMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeCarrierGatewaysResult": { + "type": "structure", + "members": { + "CarrierGateways": { + "target": "com.amazonaws.ec2#CarrierGatewaySet", + "traits": { + "aws.protocols#ec2QueryName": "CarrierGatewaySet", + "smithy.api#documentation": "

Information about the carrier gateway.

", + "smithy.api#xmlName": "carrierGatewaySet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeClassicLinkInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeClassicLinkInstancesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeClassicLinkInstancesResult" + }, + "traits": { + "smithy.api#documentation": "\n

This action is deprecated.

\n \n

Describes your linked EC2-Classic instances. This request only returns\n\t\t\tinformation about EC2-Classic instances linked to a VPC through ClassicLink. You cannot\n\t\t\tuse this request to return information about other instances.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Instances", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeClassicLinkInstancesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeClassicLinkInstancesRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "InstanceIds": { + "target": "com.amazonaws.ec2#InstanceIdStringList", + "traits": { + "smithy.api#documentation": "

The instance IDs. Must be instances linked to a VPC through ClassicLink.

", + "smithy.api#xmlName": "InstanceId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

", + "smithy.api#xmlName": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeClassicLinkInstancesMaxResults", + "traits": { + "aws.protocols#ec2QueryName": "MaxResults", + "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

\n

Constraint: If the value is greater than 1000, we return only 1000 items.

", + "smithy.api#xmlName": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeClassicLinkInstancesResult": { + "type": "structure", + "members": { + "Instances": { + "target": "com.amazonaws.ec2#ClassicLinkInstanceList", + "traits": { + "aws.protocols#ec2QueryName": "InstancesSet", + "smithy.api#documentation": "

Information about one or more linked EC2-Classic instances.

", + "smithy.api#xmlName": "instancesSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeClientVpnAuthorizationRules": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeClientVpnAuthorizationRulesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeClientVpnAuthorizationRulesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the authorization rules for a specified Client VPN endpoint.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AuthorizationRules", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeClientVpnAuthorizationRulesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeClientVpnAuthorizationRulesRequest": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#ClientVpnEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token to retrieve the next page of results.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeClientVpnAuthorizationRulesMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeClientVpnAuthorizationRulesResult": { + "type": "structure", + "members": { + "AuthorizationRules": { + "target": "com.amazonaws.ec2#AuthorizationRuleSet", + "traits": { + "aws.protocols#ec2QueryName": "AuthorizationRule", + "smithy.api#documentation": "

Information about the authorization rules.

", + "smithy.api#xmlName": "authorizationRule" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeClientVpnConnections": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeClientVpnConnectionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeClientVpnConnectionsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes active client connections and connections that have been terminated within the last 60 \n\t\t\tminutes for the specified Client VPN endpoint.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Connections", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeClientVpnConnectionsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeClientVpnConnectionsRequest": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#ClientVpnEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token to retrieve the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeClientVpnConnectionsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeClientVpnConnectionsResult": { + "type": "structure", + "members": { + "Connections": { + "target": "com.amazonaws.ec2#ClientVpnConnectionSet", + "traits": { + "aws.protocols#ec2QueryName": "Connections", + "smithy.api#documentation": "

Information about the active and terminated client connections.

", + "smithy.api#xmlName": "connections" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeClientVpnEndpointMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeClientVpnEndpoints": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeClientVpnEndpointsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeClientVpnEndpointsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more Client VPN endpoints in the account.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ClientVpnEndpoints", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeClientVpnEndpointsRequest": { + "type": "structure", + "members": { + "ClientVpnEndpointIds": { + "target": "com.amazonaws.ec2#ClientVpnEndpointIdList", + "traits": { + "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", + "smithy.api#xmlName": "ClientVpnEndpointId" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeClientVpnEndpointMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token to retrieve the next page of results.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeClientVpnEndpointsResult": { + "type": "structure", + "members": { + "ClientVpnEndpoints": { + "target": "com.amazonaws.ec2#EndpointSet", + "traits": { + "aws.protocols#ec2QueryName": "ClientVpnEndpoint", + "smithy.api#documentation": "

Information about the Client VPN endpoints.

", + "smithy.api#xmlName": "clientVpnEndpoint" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeClientVpnRoutes": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeClientVpnRoutesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeClientVpnRoutesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the routes for the specified Client VPN endpoint.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Routes", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeClientVpnRoutesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeClientVpnRoutesRequest": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#ClientVpnEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeClientVpnRoutesMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token to retrieve the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeClientVpnRoutesResult": { + "type": "structure", + "members": { + "Routes": { + "target": "com.amazonaws.ec2#ClientVpnRouteSet", + "traits": { + "aws.protocols#ec2QueryName": "Routes", + "smithy.api#documentation": "

Information about the Client VPN endpoint routes.

", + "smithy.api#xmlName": "routes" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeClientVpnTargetNetworks": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeClientVpnTargetNetworksRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeClientVpnTargetNetworksResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the target networks associated with the specified Client VPN endpoint.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ClientVpnTargetNetworks", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeClientVpnTargetNetworksMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeClientVpnTargetNetworksRequest": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#ClientVpnEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", + "smithy.api#required": {} + } + }, + "AssociationIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the target network associations.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeClientVpnTargetNetworksMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token to retrieve the next page of results.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeClientVpnTargetNetworksResult": { + "type": "structure", + "members": { + "ClientVpnTargetNetworks": { + "target": "com.amazonaws.ec2#TargetNetworkSet", + "traits": { + "aws.protocols#ec2QueryName": "ClientVpnTargetNetworks", + "smithy.api#documentation": "

Information about the associated target networks.

", + "smithy.api#xmlName": "clientVpnTargetNetworks" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeCoipPools": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeCoipPoolsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeCoipPoolsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified customer-owned address pools or all of your customer-owned address pools.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "CoipPools", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeCoipPoolsRequest": { + "type": "structure", + "members": { + "PoolIds": { + "target": "com.amazonaws.ec2#CoipPoolIdSet", + "traits": { + "smithy.api#documentation": "

The IDs of the address pools.

", + "smithy.api#xmlName": "PoolId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#CoipPoolMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeCoipPoolsResult": { + "type": "structure", + "members": { + "CoipPools": { + "target": "com.amazonaws.ec2#CoipPoolSet", + "traits": { + "aws.protocols#ec2QueryName": "CoipPoolSet", + "smithy.api#documentation": "

Information about the address pools.

", + "smithy.api#xmlName": "coipPoolSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeConversionTaskList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ConversionTask", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#DescribeConversionTasks": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeConversionTasksRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeConversionTasksResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified conversion tasks or all your conversion tasks. For more information, see the\n VM Import/Export User Guide.

\n

For information about the import manifest referenced by this API action, see VM Import Manifest.

", + "smithy.waiters#waitable": { + "ConversionTaskCancelled": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "ConversionTasks[].State", + "expected": "cancelled", + "comparator": "allStringEquals" + } + } + } + ], + "minDelay": 15 + }, + "ConversionTaskCompleted": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "ConversionTasks[].State", + "expected": "completed", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ConversionTasks[].State", + "expected": "cancelled", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ConversionTasks[].State", + "expected": "cancelling", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 15 + }, + "ConversionTaskDeleted": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "ConversionTasks[].State", + "expected": "deleted", + "comparator": "allStringEquals" + } + } + } + ], + "minDelay": 15 + } + } + } + }, + "com.amazonaws.ec2#DescribeConversionTasksRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "ConversionTaskIds": { + "target": "com.amazonaws.ec2#ConversionIdStringList", + "traits": { + "aws.protocols#ec2QueryName": "ConversionTaskId", + "smithy.api#documentation": "

The conversion task IDs.

", + "smithy.api#xmlName": "conversionTaskId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeConversionTasksResult": { + "type": "structure", + "members": { + "ConversionTasks": { + "target": "com.amazonaws.ec2#DescribeConversionTaskList", + "traits": { + "aws.protocols#ec2QueryName": "ConversionTasks", + "smithy.api#documentation": "

Information about the conversion tasks.

", + "smithy.api#xmlName": "conversionTasks" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeCustomerGateways": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeCustomerGatewaysRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeCustomerGatewaysResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more of your VPN customer gateways.

\n

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.

", + "smithy.api#examples": [ + { + "title": "To describe a customer gateway", + "documentation": "This example describes the specified customer gateway.", + "input": { + "CustomerGatewayIds": [ + "cgw-0e11f167" + ] + }, + "output": { + "CustomerGateways": [ + { + "CustomerGatewayId": "cgw-0e11f167", + "IpAddress": "12.1.2.3", + "State": "available", + "Type": "ipsec.1", + "BgpAsn": "65534" + } + ] + } + } + ], + "smithy.waiters#waitable": { + "CustomerGatewayAvailable": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "CustomerGateways[].State", + "expected": "available", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "CustomerGateways[].State", + "expected": "deleted", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "CustomerGateways[].State", + "expected": "deleting", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 15 + } + } + } + }, + "com.amazonaws.ec2#DescribeCustomerGatewaysRequest": { + "type": "structure", + "members": { + "CustomerGatewayIds": { + "target": "com.amazonaws.ec2#CustomerGatewayIdStringList", + "traits": { + "smithy.api#documentation": "

One or more customer gateway IDs.

\n

Default: Describes all your customer gateways.

", + "smithy.api#xmlName": "CustomerGatewayId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DescribeCustomerGateways.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeCustomerGatewaysResult": { + "type": "structure", + "members": { + "CustomerGateways": { + "target": "com.amazonaws.ec2#CustomerGatewayList", + "traits": { + "aws.protocols#ec2QueryName": "CustomerGatewaySet", + "smithy.api#documentation": "

Information about one or more customer gateways.

", + "smithy.api#xmlName": "customerGatewaySet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of DescribeCustomerGateways.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeDeclarativePoliciesReports": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeDeclarativePoliciesReportsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeDeclarativePoliciesReportsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the metadata of an account status report, including the status of the\n report.

\n

To view the full report, download it from the Amazon S3 bucket where it was saved.\n Reports are accessible only when they have the complete status. Reports\n with other statuses (running, cancelled, or\n error) are not available in the S3 bucket. For more information about\n downloading objects from an S3 bucket, see Downloading objects in\n the Amazon Simple Storage Service User Guide.

\n

For more information, see Generating the account status report for declarative policies in the\n Amazon Web Services Organizations User Guide.

" + } + }, + "com.amazonaws.ec2#DescribeDeclarativePoliciesReportsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DeclarativePoliciesMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

" + } + }, + "ReportIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

One or more report IDs.

", + "smithy.api#xmlName": "ReportId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeDeclarativePoliciesReportsResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "Reports": { + "target": "com.amazonaws.ec2#DeclarativePoliciesReportList", + "traits": { + "aws.protocols#ec2QueryName": "ReportSet", + "smithy.api#documentation": "

The report metadata.

", + "smithy.api#xmlName": "reportSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeDhcpOptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeDhcpOptionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeDhcpOptionsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes your DHCP option sets. The default is to describe all your DHCP option sets. \n\t\t Alternatively, you can specify specific DHCP option set IDs or filter the results to\n\t\t include only the DHCP option sets that match specific criteria.

\n

For more information, see DHCP option sets in the\n\t\t\t\tAmazon VPC User Guide.

", + "smithy.api#examples": [ + { + "title": "To describe a DHCP options set", + "documentation": "This example describes the specified DHCP options set.", + "input": { + "DhcpOptionsIds": [ + "dopt-d9070ebb" + ] + }, + "output": { + "DhcpOptions": [ + { + "DhcpConfigurations": [ + { + "Values": [ + { + "Value": "10.2.5.2" + }, + { + "Value": "10.2.5.1" + } + ], + "Key": "domain-name-servers" + } + ], + "DhcpOptionsId": "dopt-d9070ebb" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "DhcpOptions", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeDhcpOptionsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeDhcpOptionsRequest": { + "type": "structure", + "members": { + "DhcpOptionsIds": { + "target": "com.amazonaws.ec2#DhcpOptionsIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of DHCP option sets.

", + "smithy.api#xmlName": "DhcpOptionsId" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeDhcpOptionsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeDhcpOptionsResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "DhcpOptions": { + "target": "com.amazonaws.ec2#DhcpOptionsList", + "traits": { + "aws.protocols#ec2QueryName": "DhcpOptionsSet", + "smithy.api#documentation": "

Information about the DHCP options sets.

", + "smithy.api#xmlName": "dhcpOptionsSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeEgressOnlyInternetGateways": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeEgressOnlyInternetGatewaysRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeEgressOnlyInternetGatewaysResult" + }, + "traits": { + "smithy.api#documentation": "

Describes your egress-only internet gateways. The default is to describe all your egress-only internet gateways. \n Alternatively, you can specify specific egress-only internet gateway IDs or filter the results to\n include only the egress-only internet gateways that match specific criteria.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "EgressOnlyInternetGateways", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeEgressOnlyInternetGatewaysMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 255 + } + } + }, + "com.amazonaws.ec2#DescribeEgressOnlyInternetGatewaysRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "EgressOnlyInternetGatewayIds": { + "target": "com.amazonaws.ec2#EgressOnlyInternetGatewayIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the egress-only internet gateways.

", + "smithy.api#xmlName": "EgressOnlyInternetGatewayId" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeEgressOnlyInternetGatewaysMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeEgressOnlyInternetGatewaysResult": { + "type": "structure", + "members": { + "EgressOnlyInternetGateways": { + "target": "com.amazonaws.ec2#EgressOnlyInternetGatewayList", + "traits": { + "aws.protocols#ec2QueryName": "EgressOnlyInternetGatewaySet", + "smithy.api#documentation": "

Information about the egress-only internet gateways.

", + "smithy.api#xmlName": "egressOnlyInternetGatewaySet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeElasticGpus": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeElasticGpusRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeElasticGpusResult" + }, + "traits": { + "smithy.api#documentation": "\n

Amazon Elastic Graphics reached end of life on January 8, 2024.

\n \n

Describes the Elastic Graphics accelerator associated with your instances.

" + } + }, + "com.amazonaws.ec2#DescribeElasticGpusMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 10, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeElasticGpusRequest": { + "type": "structure", + "members": { + "ElasticGpuIds": { + "target": "com.amazonaws.ec2#ElasticGpuIdSet", + "traits": { + "smithy.api#documentation": "

The Elastic Graphics accelerator IDs.

", + "smithy.api#xmlName": "ElasticGpuId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeElasticGpusMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining\n results, make another call with the returned NextToken value. This value\n can be between 5 and 1000.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to request the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeElasticGpusResult": { + "type": "structure", + "members": { + "ElasticGpuSet": { + "target": "com.amazonaws.ec2#ElasticGpuSet", + "traits": { + "aws.protocols#ec2QueryName": "ElasticGpuSet", + "smithy.api#documentation": "

Information about the Elastic Graphics accelerators.

", + "smithy.api#xmlName": "elasticGpuSet" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "MaxResults", + "smithy.api#documentation": "

The total number of items to return. If the total number of items available is more\n than the value specified in max-items then a Next-Token will be provided in the output\n that you can use to resume pagination.

", + "smithy.api#xmlName": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is\n null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeExportImageTasks": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeExportImageTasksRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeExportImageTasksResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified export image tasks or all of your export image tasks.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ExportImageTasks", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeExportImageTasksMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.ec2#DescribeExportImageTasksRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

Filter tasks using the task-state filter and one of the following values: active,\n completed, deleting, or deleted.

", + "smithy.api#xmlName": "Filter" + } + }, + "ExportImageTaskIds": { + "target": "com.amazonaws.ec2#ExportImageTaskIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the export image tasks.

", + "smithy.api#xmlName": "ExportImageTaskId" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeExportImageTasksMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in a single call.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

A token that indicates the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeExportImageTasksResult": { + "type": "structure", + "members": { + "ExportImageTasks": { + "target": "com.amazonaws.ec2#ExportImageTaskList", + "traits": { + "aws.protocols#ec2QueryName": "ExportImageTaskSet", + "smithy.api#documentation": "

Information about the export image tasks.

", + "smithy.api#xmlName": "exportImageTaskSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to get the next page of results. This value is null when there are no more results\n to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeExportTasks": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeExportTasksRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeExportTasksResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified export instance tasks or all of your export instance tasks.

", + "smithy.waiters#waitable": { + "ExportTaskCancelled": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "ExportTasks[].State", + "expected": "cancelled", + "comparator": "allStringEquals" + } + } + } + ], + "minDelay": 15 + }, + "ExportTaskCompleted": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "ExportTasks[].State", + "expected": "completed", + "comparator": "allStringEquals" + } + } + } + ], + "minDelay": 15 + } + } + } + }, + "com.amazonaws.ec2#DescribeExportTasksRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

the filters for the export tasks.

", + "smithy.api#xmlName": "Filter" + } + }, + "ExportTaskIds": { + "target": "com.amazonaws.ec2#ExportTaskIdStringList", + "traits": { + "aws.protocols#ec2QueryName": "ExportTaskId", + "smithy.api#documentation": "

The export task IDs.

", + "smithy.api#xmlName": "exportTaskId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeExportTasksResult": { + "type": "structure", + "members": { + "ExportTasks": { + "target": "com.amazonaws.ec2#ExportTaskList", + "traits": { + "aws.protocols#ec2QueryName": "ExportTaskSet", + "smithy.api#documentation": "

Information about the export tasks.

", + "smithy.api#xmlName": "exportTaskSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeFastLaunchImages": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeFastLaunchImagesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeFastLaunchImagesResult" + }, + "traits": { + "smithy.api#documentation": "

Describe details for Windows AMIs that are configured for Windows fast launch.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "FastLaunchImages", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeFastLaunchImagesRequest": { + "type": "structure", + "members": { + "ImageIds": { + "target": "com.amazonaws.ec2#FastLaunchImageIdList", + "traits": { + "smithy.api#documentation": "

Specify one or more Windows AMI image IDs for the request.

", + "smithy.api#xmlName": "ImageId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

Use the following filters to streamline results.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeFastLaunchImagesRequestMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeFastLaunchImagesRequestMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.ec2#DescribeFastLaunchImagesResult": { + "type": "structure", + "members": { + "FastLaunchImages": { + "target": "com.amazonaws.ec2#DescribeFastLaunchImagesSuccessSet", + "traits": { + "aws.protocols#ec2QueryName": "FastLaunchImageSet", + "smithy.api#documentation": "

A collection of details about the fast-launch enabled Windows images that meet the\n requested criteria.

", + "smithy.api#xmlName": "fastLaunchImageSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeFastLaunchImagesSuccessItem": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The image ID that identifies the Windows fast launch enabled image.

", + "smithy.api#xmlName": "imageId" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#FastLaunchResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The resource type that Amazon EC2 uses for pre-provisioning the Windows AMI. Supported values\n include: snapshot.

", + "smithy.api#xmlName": "resourceType" + } + }, + "SnapshotConfiguration": { + "target": "com.amazonaws.ec2#FastLaunchSnapshotConfigurationResponse", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotConfiguration", + "smithy.api#documentation": "

A group of parameters that are used for pre-provisioning the associated Windows AMI using\n snapshots.

", + "smithy.api#xmlName": "snapshotConfiguration" + } + }, + "LaunchTemplate": { + "target": "com.amazonaws.ec2#FastLaunchLaunchTemplateSpecificationResponse", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplate", + "smithy.api#documentation": "

The launch template that the Windows fast launch enabled AMI uses when it launches Windows\n instances from pre-provisioned snapshots.

", + "smithy.api#xmlName": "launchTemplate" + } + }, + "MaxParallelLaunches": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "MaxParallelLaunches", + "smithy.api#documentation": "

The maximum number of instances that Amazon EC2 can launch at the same time to create\n pre-provisioned snapshots for Windows fast launch.

", + "smithy.api#xmlName": "maxParallelLaunches" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The owner ID for the Windows fast launch enabled AMI.

", + "smithy.api#xmlName": "ownerId" + } + }, + "State": { + "target": "com.amazonaws.ec2#FastLaunchStateCode", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of Windows fast launch for the specified Windows AMI.

", + "smithy.api#xmlName": "state" + } + }, + "StateTransitionReason": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StateTransitionReason", + "smithy.api#documentation": "

The reason that Windows fast launch for the AMI changed to the current state.

", + "smithy.api#xmlName": "stateTransitionReason" + } + }, + "StateTransitionTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "StateTransitionTime", + "smithy.api#documentation": "

The time that Windows fast launch for the AMI changed to the current state.

", + "smithy.api#xmlName": "stateTransitionTime" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describe details about a Windows image with Windows fast launch enabled that meets the\n requested criteria. Criteria are defined by the DescribeFastLaunchImages action\n filters.

" + } + }, + "com.amazonaws.ec2#DescribeFastLaunchImagesSuccessSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#DescribeFastLaunchImagesSuccessItem", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#DescribeFastSnapshotRestoreSuccessItem": { + "type": "structure", + "members": { + "SnapshotId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The ID of the snapshot.

", + "smithy.api#xmlName": "snapshotId" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "State": { + "target": "com.amazonaws.ec2#FastSnapshotRestoreStateCode", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of fast snapshot restores.

", + "smithy.api#xmlName": "state" + } + }, + "StateTransitionReason": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StateTransitionReason", + "smithy.api#documentation": "

The reason for the state transition. The possible values are as follows:

\n ", + "smithy.api#xmlName": "stateTransitionReason" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that enabled fast snapshot restores on the snapshot.

", + "smithy.api#xmlName": "ownerId" + } + }, + "OwnerAlias": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerAlias", + "smithy.api#documentation": "

The Amazon Web Services owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use.

", + "smithy.api#xmlName": "ownerAlias" + } + }, + "EnablingTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "EnablingTime", + "smithy.api#documentation": "

The time at which fast snapshot restores entered the enabling state.

", + "smithy.api#xmlName": "enablingTime" + } + }, + "OptimizingTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "OptimizingTime", + "smithy.api#documentation": "

The time at which fast snapshot restores entered the optimizing state.

", + "smithy.api#xmlName": "optimizingTime" + } + }, + "EnabledTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "EnabledTime", + "smithy.api#documentation": "

The time at which fast snapshot restores entered the enabled state.

", + "smithy.api#xmlName": "enabledTime" + } + }, + "DisablingTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "DisablingTime", + "smithy.api#documentation": "

The time at which fast snapshot restores entered the disabling state.

", + "smithy.api#xmlName": "disablingTime" + } + }, + "DisabledTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "DisabledTime", + "smithy.api#documentation": "

The time at which fast snapshot restores entered the disabled state.

", + "smithy.api#xmlName": "disabledTime" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes fast snapshot restores for a snapshot.

" + } + }, + "com.amazonaws.ec2#DescribeFastSnapshotRestoreSuccessSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#DescribeFastSnapshotRestoreSuccessItem", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#DescribeFastSnapshotRestores": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeFastSnapshotRestoresRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeFastSnapshotRestoresResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the state of fast snapshot restores for your snapshots.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "FastSnapshotRestores", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeFastSnapshotRestoresMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.ec2#DescribeFastSnapshotRestoresRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters. The possible values are:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeFastSnapshotRestoresMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output. \n\tFor more information, see Pagination.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request.\n Pagination continues from the end of the items returned by the previous request.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeFastSnapshotRestoresResult": { + "type": "structure", + "members": { + "FastSnapshotRestores": { + "target": "com.amazonaws.ec2#DescribeFastSnapshotRestoreSuccessSet", + "traits": { + "aws.protocols#ec2QueryName": "FastSnapshotRestoreSet", + "smithy.api#documentation": "

Information about the state of fast snapshot restores.

", + "smithy.api#xmlName": "fastSnapshotRestoreSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. \n This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeFleetError": { + "type": "structure", + "members": { + "LaunchTemplateAndOverrides": { + "target": "com.amazonaws.ec2#LaunchTemplateAndOverridesResponse", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateAndOverrides", + "smithy.api#documentation": "

The launch templates and overrides that were used for launching the instances. The\n values that you specify in the Overrides replace the values in the launch template.

", + "smithy.api#xmlName": "launchTemplateAndOverrides" + } + }, + "Lifecycle": { + "target": "com.amazonaws.ec2#InstanceLifecycle", + "traits": { + "aws.protocols#ec2QueryName": "Lifecycle", + "smithy.api#documentation": "

Indicates if the instance that could not be launched was a Spot Instance or On-Demand Instance.

", + "smithy.api#xmlName": "lifecycle" + } + }, + "ErrorCode": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ErrorCode", + "smithy.api#documentation": "

The error code that indicates why the instance could not be launched. For more\n information about error codes, see Error codes.

", + "smithy.api#xmlName": "errorCode" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ErrorMessage", + "smithy.api#documentation": "

The error message that describes why the instance could not be launched. For more\n information about error messages, see Error codes.

", + "smithy.api#xmlName": "errorMessage" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the instances that could not be launched by the fleet.

" + } + }, + "com.amazonaws.ec2#DescribeFleetHistory": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeFleetHistoryRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeFleetHistoryResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the events for the specified EC2 Fleet during the specified time.

\n

EC2 Fleet events are delayed by up to 30 seconds before they can be described. This ensures\n that you can query by the last evaluated time and not miss a recorded event. EC2 Fleet events\n are available for 48 hours.

\n

For more information, see Monitor fleet events using Amazon EventBridge in the\n Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#DescribeFleetHistoryRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "EventType": { + "target": "com.amazonaws.ec2#FleetEventType", + "traits": { + "smithy.api#documentation": "

The type of events to describe. By default, all events are described.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "FleetId": { + "target": "com.amazonaws.ec2#FleetId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the EC2 Fleet.

", + "smithy.api#required": {} + } + }, + "StartTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The start date and time for the events, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeFleetHistoryResult": { + "type": "structure", + "members": { + "HistoryRecords": { + "target": "com.amazonaws.ec2#HistoryRecordSet", + "traits": { + "aws.protocols#ec2QueryName": "HistoryRecordSet", + "smithy.api#documentation": "

Information about the events in the history of the EC2 Fleet.

", + "smithy.api#xmlName": "historyRecordSet" + } + }, + "LastEvaluatedTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "LastEvaluatedTime", + "smithy.api#documentation": "

The last date and time for the events, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).\n All records up to this time were retrieved.

\n

If nextToken indicates that there are more items, this value is not\n present.

", + "smithy.api#xmlName": "lastEvaluatedTime" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "FleetId": { + "target": "com.amazonaws.ec2#FleetId", + "traits": { + "aws.protocols#ec2QueryName": "FleetId", + "smithy.api#documentation": "

The ID of the EC Fleet.

", + "smithy.api#xmlName": "fleetId" + } + }, + "StartTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "StartTime", + "smithy.api#documentation": "

The start date and time for the events, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).

", + "smithy.api#xmlName": "startTime" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeFleetInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeFleetInstancesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeFleetInstancesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the running instances for the specified EC2 Fleet.

\n \n

Currently, DescribeFleetInstances does not support fleets of type\n instant. Instead, use DescribeFleets, specifying the\n instant fleet ID in the request.

\n \n

For more information, see Describe your\n EC2 Fleet in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#DescribeFleetInstancesRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "FleetId": { + "target": "com.amazonaws.ec2#FleetId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the EC2 Fleet.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeFleetInstancesResult": { + "type": "structure", + "members": { + "ActiveInstances": { + "target": "com.amazonaws.ec2#ActiveInstanceSet", + "traits": { + "aws.protocols#ec2QueryName": "ActiveInstanceSet", + "smithy.api#documentation": "

The running instances. This list is refreshed periodically and might be out of\n date.

", + "smithy.api#xmlName": "activeInstanceSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "FleetId": { + "target": "com.amazonaws.ec2#FleetId", + "traits": { + "aws.protocols#ec2QueryName": "FleetId", + "smithy.api#documentation": "

The ID of the EC2 Fleet.

", + "smithy.api#xmlName": "fleetId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeFleets": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeFleetsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeFleetsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified EC2 Fleet or all of your EC2 Fleets.

\n \n

If a fleet is of type instant, you must specify the fleet ID in the\n request, otherwise the fleet does not appear in the response.

\n \n

For more information, see Describe your\n EC2 Fleet in the Amazon EC2 User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Fleets", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeFleetsErrorSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#DescribeFleetError", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#DescribeFleetsInstances": { + "type": "structure", + "members": { + "LaunchTemplateAndOverrides": { + "target": "com.amazonaws.ec2#LaunchTemplateAndOverridesResponse", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateAndOverrides", + "smithy.api#documentation": "

The launch templates and overrides that were used for launching the instances. The\n values that you specify in the Overrides replace the values in the launch template.

", + "smithy.api#xmlName": "launchTemplateAndOverrides" + } + }, + "Lifecycle": { + "target": "com.amazonaws.ec2#InstanceLifecycle", + "traits": { + "aws.protocols#ec2QueryName": "Lifecycle", + "smithy.api#documentation": "

Indicates if the instance that was launched is a Spot Instance or On-Demand Instance.

", + "smithy.api#xmlName": "lifecycle" + } + }, + "InstanceIds": { + "target": "com.amazonaws.ec2#InstanceIdsSet", + "traits": { + "aws.protocols#ec2QueryName": "InstanceIds", + "smithy.api#documentation": "

The IDs of the instances.

", + "smithy.api#xmlName": "instanceIds" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type.

", + "smithy.api#xmlName": "instanceType" + } + }, + "Platform": { + "target": "com.amazonaws.ec2#PlatformValues", + "traits": { + "aws.protocols#ec2QueryName": "Platform", + "smithy.api#documentation": "

The value is windows for Windows instances in an EC2 Fleet. Otherwise, the value is\n blank.

", + "smithy.api#xmlName": "platform" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the instances that were launched by the fleet.

" + } + }, + "com.amazonaws.ec2#DescribeFleetsInstancesSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#DescribeFleetsInstances", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#DescribeFleetsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "FleetIds": { + "target": "com.amazonaws.ec2#FleetIdSet", + "traits": { + "smithy.api#documentation": "

The IDs of the EC2 Fleets.

\n \n

If a fleet is of type instant, you must specify the fleet ID, otherwise\n it does not appear in the response.

\n ", + "smithy.api#xmlName": "FleetId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeFleetsResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "Fleets": { + "target": "com.amazonaws.ec2#FleetSet", + "traits": { + "aws.protocols#ec2QueryName": "FleetSet", + "smithy.api#documentation": "

Information about the EC2 Fleets.

", + "smithy.api#xmlName": "fleetSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeFlowLogs": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeFlowLogsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeFlowLogsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more flow logs.

\n

To view the published flow log records, you must view the log destination. For example, \n the CloudWatch Logs log group, the Amazon S3 bucket, or the Kinesis Data Firehose delivery stream.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "FlowLogs", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeFlowLogsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Filter": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n " + } + }, + "FlowLogIds": { + "target": "com.amazonaws.ec2#FlowLogIdList", + "traits": { + "smithy.api#documentation": "

One or more flow log IDs.

\n

Constraint: Maximum of 1000 flow log IDs.

", + "smithy.api#xmlName": "FlowLogId" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to request the next page of items. Pagination continues from the end of the items returned by the previous request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeFlowLogsResult": { + "type": "structure", + "members": { + "FlowLogs": { + "target": "com.amazonaws.ec2#FlowLogSet", + "traits": { + "aws.protocols#ec2QueryName": "FlowLogSet", + "smithy.api#documentation": "

Information about the flow logs.

", + "smithy.api#xmlName": "flowLogSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to request the next page of items. This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeFpgaImageAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeFpgaImageAttributeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeFpgaImageAttributeResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified attribute of the specified Amazon FPGA Image (AFI).

" + } + }, + "com.amazonaws.ec2#DescribeFpgaImageAttributeRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "FpgaImageId": { + "target": "com.amazonaws.ec2#FpgaImageId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the AFI.

", + "smithy.api#required": {} + } + }, + "Attribute": { + "target": "com.amazonaws.ec2#FpgaImageAttributeName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The AFI attribute.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeFpgaImageAttributeResult": { + "type": "structure", + "members": { + "FpgaImageAttribute": { + "target": "com.amazonaws.ec2#FpgaImageAttribute", + "traits": { + "aws.protocols#ec2QueryName": "FpgaImageAttribute", + "smithy.api#documentation": "

Information about the attribute.

", + "smithy.api#xmlName": "fpgaImageAttribute" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeFpgaImages": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeFpgaImagesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeFpgaImagesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the Amazon FPGA Images (AFIs) available to you. These include public AFIs,\n\t\t\tprivate AFIs that you own, and AFIs owned by other Amazon Web Services accounts for which you have load\n\t\t\tpermissions.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "FpgaImages", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeFpgaImagesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeFpgaImagesRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "FpgaImageIds": { + "target": "com.amazonaws.ec2#FpgaImageIdList", + "traits": { + "smithy.api#documentation": "

The AFI IDs.

", + "smithy.api#xmlName": "FpgaImageId" + } + }, + "Owners": { + "target": "com.amazonaws.ec2#OwnerStringList", + "traits": { + "smithy.api#documentation": "

Filters the AFI by owner. Specify an Amazon Web Services account ID, self \n\t\t\t(owner is the sender of the request), or an Amazon Web Services owner alias (valid values are \n\t\t\tamazon | aws-marketplace).

", + "smithy.api#xmlName": "Owner" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token to retrieve the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeFpgaImagesMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in a single call.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeFpgaImagesResult": { + "type": "structure", + "members": { + "FpgaImages": { + "target": "com.amazonaws.ec2#FpgaImageList", + "traits": { + "aws.protocols#ec2QueryName": "FpgaImageSet", + "smithy.api#documentation": "

Information about the FPGA images.

", + "smithy.api#xmlName": "fpgaImageSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeFutureCapacityMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeHostReservationOfferings": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeHostReservationOfferingsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeHostReservationOfferingsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the Dedicated Host reservations that are available to purchase.

\n

The results describe all of the Dedicated Host reservation offerings, including\n offerings that might not match the instance family and Region of your Dedicated Hosts.\n When purchasing an offering, ensure that the instance family and Region of the offering\n matches that of the Dedicated Hosts with which it is to be associated. For more\n information about supported instance types, see Dedicated Hosts\n in the Amazon EC2 User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "OfferingSet", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeHostReservationOfferingsRequest": { + "type": "structure", + "members": { + "Filter": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n " + } + }, + "MaxDuration": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

This is the maximum duration of the reservation to purchase, specified in seconds.\n Reservations are available in one-year and three-year terms. The number of seconds\n specified must be the number of seconds in a year (365x24x60x60) times one of the\n supported durations (1 or 3). For example, specify 94608000 for three years.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeHostReservationsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.

" + } + }, + "MinDuration": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

This is the minimum duration of the reservation you'd like to purchase, specified in\n seconds. Reservations are available in one-year and three-year terms. The number of\n seconds specified must be the number of seconds in a year (365x24x60x60) times one of\n the supported durations (1 or 3). For example, specify 31536000 for one year.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next page of results.

" + } + }, + "OfferingId": { + "target": "com.amazonaws.ec2#OfferingId", + "traits": { + "smithy.api#documentation": "

The ID of the reservation offering.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeHostReservationOfferingsResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "OfferingSet": { + "target": "com.amazonaws.ec2#HostOfferingSet", + "traits": { + "aws.protocols#ec2QueryName": "OfferingSet", + "smithy.api#documentation": "

Information about the offerings.

", + "smithy.api#xmlName": "offeringSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeHostReservations": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeHostReservationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeHostReservationsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes reservations that are associated with Dedicated Hosts in your\n account.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "HostReservationSet", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeHostReservationsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 500 + } + } + }, + "com.amazonaws.ec2#DescribeHostReservationsRequest": { + "type": "structure", + "members": { + "Filter": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n " + } + }, + "HostReservationIdSet": { + "target": "com.amazonaws.ec2#HostReservationIdSet", + "traits": { + "smithy.api#documentation": "

The host reservation IDs.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeHostReservationsResult": { + "type": "structure", + "members": { + "HostReservationSet": { + "target": "com.amazonaws.ec2#HostReservationSet", + "traits": { + "aws.protocols#ec2QueryName": "HostReservationSet", + "smithy.api#documentation": "

Details about the reservation's configuration.

", + "smithy.api#xmlName": "hostReservationSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeHosts": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeHostsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeHostsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified Dedicated Hosts or all your Dedicated Hosts.

\n

The results describe only the Dedicated Hosts in the Region you're currently using.\n All listed instances consume capacity on your Dedicated Host. Dedicated Hosts that have\n recently been released are listed with the state released.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Hosts", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeHostsRequest": { + "type": "structure", + "members": { + "HostIds": { + "target": "com.amazonaws.ec2#RequestHostIdList", + "traits": { + "aws.protocols#ec2QueryName": "HostId", + "smithy.api#documentation": "

The IDs of the Dedicated Hosts. The IDs are used for targeted instance\n launches.

", + "smithy.api#xmlName": "hostId" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results.

", + "smithy.api#xmlName": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "MaxResults", + "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.

\n

You cannot specify this parameter and the host IDs parameter in the same\n request.

", + "smithy.api#xmlName": "maxResults" + } + }, + "Filter": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "aws.protocols#ec2QueryName": "Filter", + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "filter" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeHostsResult": { + "type": "structure", + "members": { + "Hosts": { + "target": "com.amazonaws.ec2#HostList", + "traits": { + "aws.protocols#ec2QueryName": "HostSet", + "smithy.api#documentation": "

Information about the Dedicated Hosts.

", + "smithy.api#xmlName": "hostSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeIamInstanceProfileAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeIamInstanceProfileAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeIamInstanceProfileAssociationsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes your IAM instance profile associations.

", + "smithy.api#examples": [ + { + "title": "To describe an IAM instance profile association", + "documentation": "This example describes the specified IAM instance profile association.", + "input": { + "AssociationIds": [ + "iip-assoc-0db249b1f25fa24b8" + ] + }, + "output": { + "IamInstanceProfileAssociations": [ + { + "InstanceId": "i-09eb09efa73ec1dee", + "State": "associated", + "AssociationId": "iip-assoc-0db249b1f25fa24b8", + "IamInstanceProfile": { + "Id": "AIPAJVQN4F5WVLGCJDRGM", + "Arn": "arn:aws:iam::123456789012:instance-profile/admin-role" + } + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "IamInstanceProfileAssociations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeIamInstanceProfileAssociationsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeIamInstanceProfileAssociationsRequest": { + "type": "structure", + "members": { + "AssociationIds": { + "target": "com.amazonaws.ec2#AssociationIdList", + "traits": { + "smithy.api#documentation": "

The IAM instance profile associations.

", + "smithy.api#xmlName": "AssociationId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeIamInstanceProfileAssociationsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request. To get the next page of\n items, make another request with the token returned in the output. For more information, \n see Pagination.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request.\n Pagination continues from the end of the items returned by the previous request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeIamInstanceProfileAssociationsResult": { + "type": "structure", + "members": { + "IamInstanceProfileAssociations": { + "target": "com.amazonaws.ec2#IamInstanceProfileAssociationSet", + "traits": { + "aws.protocols#ec2QueryName": "IamInstanceProfileAssociationSet", + "smithy.api#documentation": "

Information about the IAM instance profile associations.

", + "smithy.api#xmlName": "iamInstanceProfileAssociationSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. \n This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeIdFormat": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeIdFormatRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeIdFormatResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the ID format settings for your resources on a per-Region basis, for example, to view which resource types are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types.

\n

The following resource types support longer IDs: bundle |\n conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | instance | internet-gateway |\n network-acl | network-acl-association |\n network-interface | network-interface-attachment |\n prefix-list | reservation | route-table |\n route-table-association | security-group |\n snapshot | subnet |\n subnet-cidr-block-association | volume | vpc\n | vpc-cidr-block-association | vpc-endpoint |\n vpc-peering-connection | vpn-connection | vpn-gateway.

\n

These settings apply to the IAM user who makes the request; they do not apply to the entire\n Amazon Web Services account. By default, an IAM user defaults to the same settings as the root user, unless\n they explicitly override the settings by running the ModifyIdFormat command. Resources\n created with longer IDs are visible to all IAM users, regardless of these settings and\n provided that they have permission to use the relevant Describe command for the\n resource type.

" + } + }, + "com.amazonaws.ec2#DescribeIdFormatRequest": { + "type": "structure", + "members": { + "Resource": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The type of resource: bundle |\n conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | instance | internet-gateway |\n network-acl | network-acl-association |\n network-interface | network-interface-attachment |\n prefix-list | reservation | route-table |\n route-table-association | security-group |\n snapshot | subnet |\n subnet-cidr-block-association | volume | vpc\n | vpc-cidr-block-association | vpc-endpoint |\n vpc-peering-connection | vpn-connection | vpn-gateway\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeIdFormatResult": { + "type": "structure", + "members": { + "Statuses": { + "target": "com.amazonaws.ec2#IdFormatList", + "traits": { + "aws.protocols#ec2QueryName": "StatusSet", + "smithy.api#documentation": "

Information about the ID format for the resource.

", + "smithy.api#xmlName": "statusSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeIdentityIdFormat": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeIdentityIdFormatRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeIdentityIdFormatResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the ID format settings for resources for the specified IAM user, IAM role, or root\n user. For example, you can view the resource types that are enabled for longer IDs. This request only\n returns information about resource types whose ID formats can be modified; it does not return\n information about other resource types. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.

\n

The following resource types support longer IDs: bundle |\n conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | instance | internet-gateway |\n network-acl | network-acl-association |\n network-interface | network-interface-attachment |\n prefix-list | reservation | route-table |\n route-table-association | security-group |\n snapshot | subnet |\n subnet-cidr-block-association | volume | vpc\n | vpc-cidr-block-association | vpc-endpoint |\n vpc-peering-connection | vpn-connection | vpn-gateway.

\n

These settings apply to the principal specified in the request. They do not apply to the\n principal that makes the request.

" + } + }, + "com.amazonaws.ec2#DescribeIdentityIdFormatRequest": { + "type": "structure", + "members": { + "Resource": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Resource", + "smithy.api#documentation": "

The type of resource: bundle |\n conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | instance | internet-gateway |\n network-acl | network-acl-association |\n network-interface | network-interface-attachment |\n prefix-list | reservation | route-table |\n route-table-association | security-group |\n snapshot | subnet |\n subnet-cidr-block-association | volume | vpc\n | vpc-cidr-block-association | vpc-endpoint |\n vpc-peering-connection | vpn-connection | vpn-gateway\n

", + "smithy.api#xmlName": "resource" + } + }, + "PrincipalArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrincipalArn", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the principal, which can be an IAM role, IAM user, or the root user.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "principalArn" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeIdentityIdFormatResult": { + "type": "structure", + "members": { + "Statuses": { + "target": "com.amazonaws.ec2#IdFormatList", + "traits": { + "aws.protocols#ec2QueryName": "StatusSet", + "smithy.api#documentation": "

Information about the ID format for the resources.

", + "smithy.api#xmlName": "statusSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeImageAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeImageAttributeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ImageAttribute" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified attribute of the specified AMI. You can specify only one attribute\n at a time.

\n \n

The order of the elements in the response, including those within nested structures,\n might vary. Applications should not assume the elements appear in a particular order.

\n ", + "smithy.api#examples": [ + { + "title": "To describe the launch permissions for an AMI", + "documentation": "This example describes the launch permissions for the specified AMI.", + "input": { + "Attribute": "launchPermission", + "ImageId": "ami-5731123e" + }, + "output": { + "ImageId": "ami-5731123e", + "LaunchPermissions": [ + { + "UserId": "123456789012" + } + ] + } + } + ] + } + }, + "com.amazonaws.ec2#DescribeImageAttributeRequest": { + "type": "structure", + "members": { + "Attribute": { + "target": "com.amazonaws.ec2#ImageAttributeName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The AMI attribute.

\n

\n Note: The blockDeviceMapping attribute is\n deprecated. Using this attribute returns the Client.AuthFailure error. To get\n information about the block device mappings for an AMI, use the DescribeImages action.

", + "smithy.api#required": {} + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the AMI.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DescribeImageAttribute.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeImages": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeImagesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeImagesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the\n images available to you.

\n

The images available to you include public images, private images that you own, and\n private images owned by other Amazon Web Services accounts for which you have explicit launch\n permissions.

\n

Recently deregistered images appear in the returned results for a short interval and then\n return empty results. After all instances that reference a deregistered AMI are terminated,\n specifying the ID of the image will eventually return an error indicating that the AMI ID\n cannot be found.

\n

When Allowed AMIs is set to enabled, only allowed images are returned in the\n results, with the imageAllowed field set to true for each image. In\n audit-mode, the imageAllowed field is set to true for\n images that meet the account's Allowed AMIs criteria, and false for images that\n don't meet the criteria. For more information, see EnableAllowedImagesSettings.

\n \n

We strongly recommend using only paginated requests. Unpaginated requests are\n susceptible to throttling and timeouts.

\n \n \n

The order of the elements in the response, including those within nested structures,\n might vary. Applications should not assume the elements appear in a particular order.

\n ", + "smithy.api#examples": [ + { + "title": "To describe an AMI", + "documentation": "This example describes the specified AMI.", + "input": { + "ImageIds": [ + "ami-5731123e" + ] + }, + "output": { + "Images": [ + { + "VirtualizationType": "paravirtual", + "Name": "My server", + "Hypervisor": "xen", + "ImageId": "ami-5731123e", + "RootDeviceType": "ebs", + "State": "available", + "BlockDeviceMappings": [ + { + "DeviceName": "/dev/sda1", + "Ebs": { + "DeleteOnTermination": true, + "SnapshotId": "snap-1234567890abcdef0", + "VolumeSize": 8, + "VolumeType": "standard" + } + } + ], + "Architecture": "x86_64", + "ImageLocation": "123456789012/My server", + "KernelId": "aki-88aa75e1", + "OwnerId": "123456789012", + "RootDeviceName": "/dev/sda1", + "Public": false, + "ImageType": "machine", + "Description": "An AMI for my server" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Images", + "pageSize": "MaxResults" + }, + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "ImageAvailable": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "Images[].State", + "expected": "available", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Images[].State", + "expected": "failed", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 15 + }, + "ImageExists": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "length(Images[]) > `0`", + "expected": "true", + "comparator": "booleanEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "errorType": "InvalidAMIID.NotFound" + } + } + ], + "minDelay": 15 + } + } + } + }, + "com.amazonaws.ec2#DescribeImagesRequest": { + "type": "structure", + "members": { + "ExecutableUsers": { + "target": "com.amazonaws.ec2#ExecutableByStringList", + "traits": { + "smithy.api#documentation": "

Scopes the images by users with explicit launch permissions. Specify an Amazon Web Services account ID, self (the sender of the request), or all\n (public AMIs).

\n ", + "smithy.api#xmlName": "ExecutableBy" + } + }, + "ImageIds": { + "target": "com.amazonaws.ec2#ImageIdStringList", + "traits": { + "smithy.api#documentation": "

The image IDs.

\n

Default: Describes all images available to you.

", + "smithy.api#xmlName": "ImageId" + } + }, + "Owners": { + "target": "com.amazonaws.ec2#OwnerStringList", + "traits": { + "smithy.api#documentation": "

Scopes the results to images with the specified owners. You can specify a combination of\n Amazon Web Services account IDs, self, amazon,\n aws-backup-vault, and aws-marketplace. If you omit this parameter,\n the results include all images for which you have launch permissions, regardless of\n ownership.

", + "smithy.api#xmlName": "Owner" + } + }, + "IncludeDeprecated": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether to include deprecated AMIs.

\n

Default: No deprecated AMIs are included in the response.

\n \n

If you are the AMI owner, all deprecated AMIs appear in the response regardless of what\n you specify for this parameter.

\n " + } + }, + "IncludeDisabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether to include disabled AMIs.

\n

Default: No disabled AMIs are included in the response.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeImagesResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "Images": { + "target": "com.amazonaws.ec2#ImageList", + "traits": { + "aws.protocols#ec2QueryName": "ImagesSet", + "smithy.api#documentation": "

Information about the images.

", + "smithy.api#xmlName": "imagesSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeImportImageTasks": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeImportImageTasksRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeImportImageTasksResult" + }, + "traits": { + "smithy.api#documentation": "

Displays details about an import virtual machine or import snapshot tasks that are already created.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ImportImageTasks", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeImportImageTasksRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

Filter tasks using the task-state filter and one of the following values: active,\n completed, deleting, or deleted.

", + "smithy.api#xmlName": "Filters" + } + }, + "ImportTaskIds": { + "target": "com.amazonaws.ec2#ImportTaskIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the import image tasks.

", + "smithy.api#xmlName": "ImportTaskId" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in a single call.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A token that indicates the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeImportImageTasksResult": { + "type": "structure", + "members": { + "ImportImageTasks": { + "target": "com.amazonaws.ec2#ImportImageTaskList", + "traits": { + "aws.protocols#ec2QueryName": "ImportImageTaskSet", + "smithy.api#documentation": "

A list of zero or more import image tasks that are currently active or were completed or canceled in the\n previous 7 days.

", + "smithy.api#xmlName": "importImageTaskSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to get the next page of results. This value is null when there are no more results\n to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeImportSnapshotTasks": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeImportSnapshotTasksRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeImportSnapshotTasksResult" + }, + "traits": { + "smithy.api#documentation": "

Describes your import snapshot tasks.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ImportSnapshotTasks", + "pageSize": "MaxResults" + }, + "smithy.waiters#waitable": { + "SnapshotImported": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "ImportSnapshotTasks[].SnapshotTaskDetail.Status", + "expected": "completed", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ImportSnapshotTasks[].SnapshotTaskDetail.Status", + "expected": "error", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 15 + } + } + } + }, + "com.amazonaws.ec2#DescribeImportSnapshotTasksRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

", + "smithy.api#xmlName": "Filters" + } + }, + "ImportTaskIds": { + "target": "com.amazonaws.ec2#ImportSnapshotTaskIdList", + "traits": { + "smithy.api#documentation": "

A list of import snapshot task IDs.

", + "smithy.api#xmlName": "ImportTaskId" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining results, make another call\n with the returned NextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A token that indicates the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeImportSnapshotTasksResult": { + "type": "structure", + "members": { + "ImportSnapshotTasks": { + "target": "com.amazonaws.ec2#ImportSnapshotTaskList", + "traits": { + "aws.protocols#ec2QueryName": "ImportSnapshotTaskSet", + "smithy.api#documentation": "

A list of zero or more import snapshot tasks that are currently active or were completed or canceled in the\n previous 7 days.

", + "smithy.api#xmlName": "importSnapshotTaskSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to get the next page of results. This value is null when there are no more results\n to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeInstanceAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeInstanceAttributeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#InstanceAttribute" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified attribute of the specified instance. You can specify only one\n attribute at a time. Valid attribute values are: instanceType |\n kernel | ramdisk | userData |\n disableApiTermination | instanceInitiatedShutdownBehavior\n | rootDeviceName | blockDeviceMapping |\n productCodes | sourceDestCheck | groupSet |\n ebsOptimized | sriovNetSupport\n

", + "smithy.api#examples": [ + { + "title": "To describe the block device mapping for an instance", + "documentation": "This example describes the ``blockDeviceMapping`` attribute of the specified instance.\n", + "input": { + "InstanceId": "i-1234567890abcdef0", + "Attribute": "blockDeviceMapping" + }, + "output": { + "InstanceId": "i-1234567890abcdef0", + "BlockDeviceMappings": [ + { + "DeviceName": "/dev/sda1", + "Ebs": { + "Status": "attached", + "DeleteOnTermination": true, + "VolumeId": "vol-049df61146c4d7901", + "AttachTime": "2013-05-17T22:42:34.000Z" + } + }, + { + "DeviceName": "/dev/sdf", + "Ebs": { + "Status": "attached", + "DeleteOnTermination": false, + "VolumeId": "vol-049df61146c4d7901", + "AttachTime": "2013-09-10T23:07:00.000Z" + } + } + ] + } + }, + { + "title": "To describe the instance type", + "documentation": "This example describes the instance type of the specified instance.\n", + "input": { + "InstanceId": "i-1234567890abcdef0", + "Attribute": "instanceType" + }, + "output": { + "InstanceId": "i-1234567890abcdef0", + "InstanceType": { + "Value": "t1.micro" + } + } + } + ] + } + }, + "com.amazonaws.ec2#DescribeInstanceAttributeRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "instanceId" + } + }, + "Attribute": { + "target": "com.amazonaws.ec2#InstanceAttributeName", + "traits": { + "aws.protocols#ec2QueryName": "Attribute", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The instance attribute.

\n

Note: The enaSupport attribute is not supported at this time.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "attribute" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeInstanceConnectEndpoints": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeInstanceConnectEndpointsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeInstanceConnectEndpointsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified EC2 Instance Connect Endpoints or all EC2 Instance Connect Endpoints.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "InstanceConnectEndpoints", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeInstanceConnectEndpointsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#InstanceConnectEndpointMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "InstanceConnectEndpointIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

One or more EC2 Instance Connect Endpoint IDs.

", + "smithy.api#xmlName": "InstanceConnectEndpointId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeInstanceConnectEndpointsResult": { + "type": "structure", + "members": { + "InstanceConnectEndpoints": { + "target": "com.amazonaws.ec2#InstanceConnectEndpointSet", + "traits": { + "aws.protocols#ec2QueryName": "InstanceConnectEndpointSet", + "smithy.api#documentation": "

Information about the EC2 Instance Connect Endpoints.

", + "smithy.api#xmlName": "instanceConnectEndpointSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeInstanceCreditSpecifications": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeInstanceCreditSpecificationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeInstanceCreditSpecificationsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the credit option for CPU usage of the specified burstable performance\n instances. The credit options are standard and\n unlimited.

\n

If you do not specify an instance ID, Amazon EC2 returns burstable performance\n instances with the unlimited credit option, as well as instances that were\n previously configured as T2, T3, and T3a with the unlimited credit option.\n For example, if you resize a T2 instance, while it is configured as\n unlimited, to an M4 instance, Amazon EC2 returns the M4\n instance.

\n

If you specify one or more instance IDs, Amazon EC2 returns the credit option\n (standard or unlimited) of those instances. If you specify\n an instance ID that is not valid, such as an instance that is not a burstable\n performance instance, an error is returned.

\n

Recently terminated instances might appear in the returned results. This interval is\n usually less than one hour.

\n

If an Availability Zone is experiencing a service disruption and you specify instance\n IDs in the affected zone, or do not specify any instance IDs at all, the call fails. If\n you specify only instance IDs in an unaffected zone, the call works normally.

\n

For more information, see Burstable\n performance instances in the Amazon EC2 User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "InstanceCreditSpecifications", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeInstanceCreditSpecificationsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeInstanceCreditSpecificationsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "InstanceIds": { + "target": "com.amazonaws.ec2#InstanceIdStringList", + "traits": { + "smithy.api#documentation": "

The instance IDs.

\n

Default: Describes all your instances.

\n

Constraints: Maximum 1000 explicitly specified instance IDs.

", + "smithy.api#xmlName": "InstanceId" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeInstanceCreditSpecificationsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

\n

You cannot specify this parameter and the instance IDs\n parameter in the same call.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeInstanceCreditSpecificationsResult": { + "type": "structure", + "members": { + "InstanceCreditSpecifications": { + "target": "com.amazonaws.ec2#InstanceCreditSpecificationList", + "traits": { + "aws.protocols#ec2QueryName": "InstanceCreditSpecificationSet", + "smithy.api#documentation": "

Information about the credit option for CPU usage of an instance.

", + "smithy.api#xmlName": "instanceCreditSpecificationSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeInstanceEventNotificationAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeInstanceEventNotificationAttributesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeInstanceEventNotificationAttributesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the tag keys that are registered to appear in scheduled event notifications for \n \tresources in the current Region.

" + } + }, + "com.amazonaws.ec2#DescribeInstanceEventNotificationAttributesRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeInstanceEventNotificationAttributesResult": { + "type": "structure", + "members": { + "InstanceTagAttribute": { + "target": "com.amazonaws.ec2#InstanceTagNotificationAttribute", + "traits": { + "aws.protocols#ec2QueryName": "InstanceTagAttribute", + "smithy.api#documentation": "

Information about the registered tag keys.

", + "smithy.api#xmlName": "instanceTagAttribute" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeInstanceEventWindows": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeInstanceEventWindowsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeInstanceEventWindowsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified event windows or all event windows.

\n

If you specify event window IDs, the output includes information for only the specified\n event windows. If you specify filters, the output includes information for only those event\n windows that meet the filter criteria. If you do not specify event windows IDs or filters,\n the output includes information for all event windows, which can affect performance. We\n recommend that you use pagination to ensure that the operation returns quickly and\n successfully.

\n

For more information, see Define event windows for scheduled\n events in the Amazon EC2 User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "InstanceEventWindows", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeInstanceEventWindowsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "InstanceEventWindowIds": { + "target": "com.amazonaws.ec2#InstanceEventWindowIdSet", + "traits": { + "smithy.api#documentation": "

The IDs of the event windows.

", + "smithy.api#xmlName": "InstanceEventWindowId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#ResultRange", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining\n results, make another call with the returned NextToken value. This value can\n be between 20 and 500. You cannot specify this parameter and the event window IDs parameter\n in the same call.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to request the next page of results.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describe instance event windows by InstanceEventWindow.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeInstanceEventWindowsResult": { + "type": "structure", + "members": { + "InstanceEventWindows": { + "target": "com.amazonaws.ec2#InstanceEventWindowSet", + "traits": { + "aws.protocols#ec2QueryName": "InstanceEventWindowSet", + "smithy.api#documentation": "

Information about the event windows.

", + "smithy.api#xmlName": "instanceEventWindowSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeInstanceImageMetadata": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeInstanceImageMetadataRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeInstanceImageMetadataResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the AMI that was used to launch an instance, even if the AMI is deprecated,\n deregistered, made private (no longer public or shared with your account), or not\n allowed.

\n

If you specify instance IDs, the output includes information for only the specified\n instances. If you specify filters, the output includes information for only those instances\n that meet the filter criteria. If you do not specify instance IDs or filters, the output\n includes information for all instances, which can affect performance.

\n

If you specify an instance ID that is not valid, an instance that doesn't exist, or an\n instance that you do not own, an error (InvalidInstanceID.NotFound) is\n returned.

\n

Recently terminated instances might appear in the returned results. This interval is\n usually less than one hour.

\n

In the rare case where an Availability Zone is experiencing a service disruption and you\n specify instance IDs that are in the affected Availability Zone, or do not specify any\n instance IDs at all, the call fails. If you specify only instance IDs that are in an\n unaffected Availability Zone, the call works normally.

\n \n

The order of the elements in the response, including those within nested structures,\n might vary. Applications should not assume the elements appear in a particular order.

\n ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "InstanceImageMetadata", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeInstanceImageMetadataMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeInstanceImageMetadataRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "InstanceIds": { + "target": "com.amazonaws.ec2#InstanceIdStringList", + "traits": { + "smithy.api#documentation": "

The instance IDs.

\n

If you don't specify an instance ID or filters, the output includes information for all\n instances.

", + "smithy.api#xmlName": "InstanceId" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeInstanceImageMetadataMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

\n

Default: 1000

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeInstanceImageMetadataResult": { + "type": "structure", + "members": { + "InstanceImageMetadata": { + "target": "com.amazonaws.ec2#InstanceImageMetadataList", + "traits": { + "aws.protocols#ec2QueryName": "InstanceImageMetadataSet", + "smithy.api#documentation": "

Information about the instance and the AMI used to launch the instance.

", + "smithy.api#xmlName": "instanceImageMetadataSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeInstanceStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeInstanceStatusRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeInstanceStatusResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the status of the specified instances or all of your instances. By default,\n only running instances are described, unless you specifically indicate to return the\n status of all instances.

\n

Instance status includes the following components:

\n \n \n

The order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.

\n ", + "smithy.api#examples": [ + { + "title": "To describe the status of an instance", + "documentation": "This example describes the current status of the specified instance.", + "input": { + "InstanceIds": [ + "i-1234567890abcdef0" + ] + }, + "output": { + "InstanceStatuses": [ + { + "InstanceId": "i-1234567890abcdef0", + "InstanceState": { + "Code": 16, + "Name": "running" + }, + "AvailabilityZone": "us-east-1d", + "SystemStatus": { + "Status": "ok", + "Details": [ + { + "Status": "passed", + "Name": "reachability" + } + ] + }, + "InstanceStatus": { + "Status": "ok", + "Details": [ + { + "Status": "passed", + "Name": "reachability" + } + ] + } + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "InstanceStatuses", + "pageSize": "MaxResults" + }, + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "InstanceStatusOk": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "InstanceStatuses[].InstanceStatus.Status", + "expected": "ok", + "comparator": "allStringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "errorType": "InvalidInstanceID.NotFound" + } + } + ], + "minDelay": 15 + }, + "SystemStatusOk": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "InstanceStatuses[].SystemStatus.Status", + "expected": "ok", + "comparator": "allStringEquals" + } + } + } + ], + "minDelay": 15 + } + } + } + }, + "com.amazonaws.ec2#DescribeInstanceStatusRequest": { + "type": "structure", + "members": { + "InstanceIds": { + "target": "com.amazonaws.ec2#InstanceIdStringList", + "traits": { + "smithy.api#documentation": "

The instance IDs.

\n

Default: Describes all your instances.

\n

Constraints: Maximum 100 explicitly specified instance IDs.

", + "smithy.api#xmlName": "InstanceId" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

\n

You cannot specify this parameter and the instance IDs parameter in the same request.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "IncludeAllInstances": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "IncludeAllInstances", + "smithy.api#documentation": "

When true, includes the health status for all instances. When\n false, includes the health status for running instances only.

\n

Default: false\n

", + "smithy.api#xmlName": "includeAllInstances" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeInstanceStatusResult": { + "type": "structure", + "members": { + "InstanceStatuses": { + "target": "com.amazonaws.ec2#InstanceStatusList", + "traits": { + "aws.protocols#ec2QueryName": "InstanceStatusSet", + "smithy.api#documentation": "

Information about the status of the instances.

", + "smithy.api#xmlName": "instanceStatusSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeInstanceTopology": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeInstanceTopologyRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeInstanceTopologyResult" + }, + "traits": { + "smithy.api#documentation": "

Describes a tree-based hierarchy that represents the physical host placement of your\n EC2 instances within an Availability Zone or Local Zone. You can use this information to\n determine the relative proximity of your EC2 instances within the Amazon Web Services network to\n support your tightly coupled workloads.

\n

\n Limitations\n

\n \n

For more information, see Amazon EC2 instance\n topology in the Amazon EC2 User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Instances", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeInstanceTopologyGroupNameSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#PlacementGroupName" + } + }, + "com.amazonaws.ec2#DescribeInstanceTopologyInstanceIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceId" + } + }, + "com.amazonaws.ec2#DescribeInstanceTopologyMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.ec2#DescribeInstanceTopologyRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeInstanceTopologyMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

\n

You can't specify this parameter and the instance IDs parameter in the same request.

\n

Default: 20\n

" + } + }, + "InstanceIds": { + "target": "com.amazonaws.ec2#DescribeInstanceTopologyInstanceIdSet", + "traits": { + "smithy.api#documentation": "

The instance IDs.

\n

Default: Describes all your instances.

\n

Constraints: Maximum 100 explicitly specified instance IDs.

", + "smithy.api#xmlName": "InstanceId" + } + }, + "GroupNames": { + "target": "com.amazonaws.ec2#DescribeInstanceTopologyGroupNameSet", + "traits": { + "smithy.api#documentation": "

The name of the placement group that each instance is in.

\n

Constraints: Maximum 100 explicitly specified placement group names.

", + "smithy.api#xmlName": "GroupName" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeInstanceTopologyResult": { + "type": "structure", + "members": { + "Instances": { + "target": "com.amazonaws.ec2#InstanceSet", + "traits": { + "aws.protocols#ec2QueryName": "InstanceSet", + "smithy.api#documentation": "

Information about the topology of each instance.

", + "smithy.api#xmlName": "instanceSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeInstanceTypeOfferings": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeInstanceTypeOfferingsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeInstanceTypeOfferingsResult" + }, + "traits": { + "smithy.api#documentation": "

Lists the instance types that are offered for the specified location. If no location is\n specified, the default is to list the instance types that are offered in the current\n Region.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "InstanceTypeOfferings", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeInstanceTypeOfferingsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request,\n and provides an error response. If you have the required permissions, the error response is\n DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "LocationType": { + "target": "com.amazonaws.ec2#LocationType", + "traits": { + "smithy.api#documentation": "

The location type.

\n " + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DITOMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeInstanceTypeOfferingsResult": { + "type": "structure", + "members": { + "InstanceTypeOfferings": { + "target": "com.amazonaws.ec2#InstanceTypeOfferingsList", + "traits": { + "aws.protocols#ec2QueryName": "InstanceTypeOfferingSet", + "smithy.api#documentation": "

The instance types offered in the location.

", + "smithy.api#xmlName": "instanceTypeOfferingSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeInstanceTypes": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeInstanceTypesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeInstanceTypesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified instance types. By default, all instance types for the current\n Region are described. Alternatively, you can filter the results.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "InstanceTypes", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeInstanceTypesRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request,\n and provides an error response. If you have the required permissions, the error response is\n DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "InstanceTypes": { + "target": "com.amazonaws.ec2#RequestInstanceTypeList", + "traits": { + "smithy.api#documentation": "

The instance types.

", + "smithy.api#xmlName": "InstanceType" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DITMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeInstanceTypesResult": { + "type": "structure", + "members": { + "InstanceTypes": { + "target": "com.amazonaws.ec2#InstanceTypeInfoList", + "traits": { + "aws.protocols#ec2QueryName": "InstanceTypeSet", + "smithy.api#documentation": "

The instance type.

", + "smithy.api#xmlName": "instanceTypeSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeInstancesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeInstancesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified instances or all instances.

\n

If you specify instance IDs, the output includes information for only the specified\n instances. If you specify filters, the output includes information for only those\n instances that meet the filter criteria. If you do not specify instance IDs or filters,\n the output includes information for all instances, which can affect performance. We\n recommend that you use pagination to ensure that the operation returns quickly and\n successfully.

\n

If you specify an instance ID that is not valid, an error is returned. If you specify\n an instance that you do not own, it is not included in the output.

\n

Recently terminated instances might appear in the returned results. This interval is\n usually less than one hour.

\n

If you describe instances in the rare case where an Availability Zone is experiencing\n a service disruption and you specify instance IDs that are in the affected zone, or do\n not specify any instance IDs at all, the call fails. If you describe instances and\n specify only instance IDs that are in an unaffected zone, the call works\n normally.

\n \n

We strongly recommend using only paginated requests. Unpaginated requests are\n susceptible to throttling and timeouts.

\n \n \n

The order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.

\n ", + "smithy.api#examples": [ + { + "title": "To describe an Amazon EC2 instance", + "documentation": "This example describes the specified instance.", + "input": { + "InstanceIds": [ + "i-1234567890abcdef0" + ] + }, + "output": {} + }, + { + "title": "To describe the instances with a specific tag", + "documentation": "This example describes the instances with the Purpose=test tag.", + "input": { + "Filters": [ + { + "Name": "tag:Purpose", + "Values": [ + "test" + ] + } + ] + }, + "output": {} + }, + { + "title": "To describe the instances with a specific instance type", + "documentation": "This example describes the instances with the t2.micro instance type.", + "input": { + "Filters": [ + { + "Name": "instance-type", + "Values": [ + "t2.micro" + ] + } + ] + }, + "output": {} + } + ], + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Reservations", + "pageSize": "MaxResults" + }, + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.test#smokeTests": [ + { + "id": "DescribeInstancesFailure", + "params": { + "InstanceIds": [ + "i-12345678" + ] + }, + "vendorParams": { + "region": "us-west-2" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "failure": {} + } + } + ], + "smithy.waiters#waitable": { + "InstanceExists": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "length(Reservations[]) > `0`", + "expected": "true", + "comparator": "booleanEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "errorType": "InvalidInstanceID.NotFound" + } + } + ], + "minDelay": 5 + }, + "InstanceRunning": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "Reservations[].Instances[].State.Name", + "expected": "running", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Reservations[].Instances[].State.Name", + "expected": "shutting-down", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Reservations[].Instances[].State.Name", + "expected": "terminated", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Reservations[].Instances[].State.Name", + "expected": "stopping", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "errorType": "InvalidInstanceID.NotFound" + } + } + ], + "minDelay": 15 + }, + "InstanceStopped": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "Reservations[].Instances[].State.Name", + "expected": "stopped", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Reservations[].Instances[].State.Name", + "expected": "pending", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Reservations[].Instances[].State.Name", + "expected": "terminated", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 15 + }, + "InstanceTerminated": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "Reservations[].Instances[].State.Name", + "expected": "terminated", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Reservations[].Instances[].State.Name", + "expected": "pending", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Reservations[].Instances[].State.Name", + "expected": "stopping", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 15 + } + } + } + }, + "com.amazonaws.ec2#DescribeInstancesRequest": { + "type": "structure", + "members": { + "InstanceIds": { + "target": "com.amazonaws.ec2#InstanceIdStringList", + "traits": { + "smithy.api#documentation": "

The instance IDs.

\n

Default: Describes all your instances.

", + "smithy.api#xmlName": "InstanceId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

", + "smithy.api#xmlName": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "MaxResults", + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

\n

You cannot specify this parameter and the instance IDs parameter in the same request.

", + "smithy.api#xmlName": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeInstancesResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "Reservations": { + "target": "com.amazonaws.ec2#ReservationList", + "traits": { + "aws.protocols#ec2QueryName": "ReservationSet", + "smithy.api#documentation": "

Information about the reservations.

", + "smithy.api#xmlName": "reservationSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeInternetGateways": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeInternetGatewaysRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeInternetGatewaysResult" + }, + "traits": { + "smithy.api#documentation": "

Describes your internet gateways. The default is to describe all your internet gateways. \n Alternatively, you can specify specific internet gateway IDs or filter the results to\n include only the internet gateways that match specific criteria.

", + "smithy.api#examples": [ + { + "title": "To describe the Internet gateway for a VPC", + "documentation": "This example describes the Internet gateway for the specified VPC.", + "input": { + "Filters": [ + { + "Name": "attachment.vpc-id", + "Values": [ + "vpc-a01106c2" + ] + } + ] + }, + "output": { + "InternetGateways": [ + { + "Tags": [], + "InternetGatewayId": "igw-c0a643a9", + "Attachments": [ + { + "State": "attached", + "VpcId": "vpc-a01106c2" + } + ] + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "InternetGateways", + "pageSize": "MaxResults" + }, + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "InternetGatewayExists": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "length(InternetGateways[].InternetGatewayId) > `0`", + "expected": "true", + "comparator": "booleanEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "errorType": "InvalidInternetGateway.NotFound" + } + } + ], + "minDelay": 5 + } + } + } + }, + "com.amazonaws.ec2#DescribeInternetGatewaysMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeInternetGatewaysRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeInternetGatewaysMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "InternetGatewayIds": { + "target": "com.amazonaws.ec2#InternetGatewayIdList", + "traits": { + "aws.protocols#ec2QueryName": "InternetGatewayId", + "smithy.api#documentation": "

The IDs of the internet gateways.

\n

Default: Describes all your internet gateways.

", + "smithy.api#xmlName": "internetGatewayId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeInternetGatewaysResult": { + "type": "structure", + "members": { + "InternetGateways": { + "target": "com.amazonaws.ec2#InternetGatewayList", + "traits": { + "aws.protocols#ec2QueryName": "InternetGatewaySet", + "smithy.api#documentation": "

Information about the internet gateways.

", + "smithy.api#xmlName": "internetGatewaySet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeIpamByoasn": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeIpamByoasnRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeIpamByoasnResult" + }, + "traits": { + "smithy.api#documentation": "

Describes your Autonomous System Numbers (ASNs), their provisioning statuses, and the BYOIP CIDRs with which they are associated. For more information, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide.

" + } + }, + "com.amazonaws.ec2#DescribeIpamByoasnMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.ec2#DescribeIpamByoasnRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeIpamByoasnMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeIpamByoasnResult": { + "type": "structure", + "members": { + "Byoasns": { + "target": "com.amazonaws.ec2#ByoasnSet", + "traits": { + "aws.protocols#ec2QueryName": "ByoasnSet", + "smithy.api#documentation": "

ASN and BYOIP CIDR associations.

", + "smithy.api#xmlName": "byoasnSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeIpamExternalResourceVerificationTokens": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeIpamExternalResourceVerificationTokensRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeIpamExternalResourceVerificationTokensResult" + }, + "traits": { + "smithy.api#documentation": "

Describe verification tokens. A verification token is an Amazon Web Services-generated random value that you can use to prove ownership of an external resource. For example, you can use a verification token to validate that you control a public IP address range when you bring an IP address range to Amazon Web Services (BYOIP).\n

" + } + }, + "com.amazonaws.ec2#DescribeIpamExternalResourceVerificationTokensRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters for the request. For more information about filtering, see Filtering CLI output.

\n

Available filters:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#IpamMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of tokens to return in one page of results.

" + } + }, + "IpamExternalResourceVerificationTokenIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

Verification token IDs.

", + "smithy.api#xmlName": "IpamExternalResourceVerificationTokenId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeIpamExternalResourceVerificationTokensResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "IpamExternalResourceVerificationTokens": { + "target": "com.amazonaws.ec2#IpamExternalResourceVerificationTokenSet", + "traits": { + "aws.protocols#ec2QueryName": "IpamExternalResourceVerificationTokenSet", + "smithy.api#documentation": "

Verification tokens.

", + "smithy.api#xmlName": "ipamExternalResourceVerificationTokenSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeIpamPools": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeIpamPoolsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeIpamPoolsResult" + }, + "traits": { + "smithy.api#documentation": "

Get information about your IPAM pools.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "IpamPools", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeIpamPoolsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters for the request. For more information about filtering, see Filtering CLI output.

", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#IpamMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in the request.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "IpamPoolIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the IPAM pools you would like information on.

", + "smithy.api#xmlName": "IpamPoolId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeIpamPoolsResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "IpamPools": { + "target": "com.amazonaws.ec2#IpamPoolSet", + "traits": { + "aws.protocols#ec2QueryName": "IpamPoolSet", + "smithy.api#documentation": "

Information about the IPAM pools.

", + "smithy.api#xmlName": "ipamPoolSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeIpamResourceDiscoveries": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeIpamResourceDiscoveriesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeIpamResourceDiscoveriesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes IPAM resource discoveries. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "IpamResourceDiscoveries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeIpamResourceDiscoveriesRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamResourceDiscoveryIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The IPAM resource discovery IDs.

", + "smithy.api#xmlName": "IpamResourceDiscoveryId" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

Specify the pagination token from a previous request to retrieve the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#IpamMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of resource discoveries to return in one page of results.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The resource discovery filters.

", + "smithy.api#xmlName": "Filter" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeIpamResourceDiscoveriesResult": { + "type": "structure", + "members": { + "IpamResourceDiscoveries": { + "target": "com.amazonaws.ec2#IpamResourceDiscoverySet", + "traits": { + "aws.protocols#ec2QueryName": "IpamResourceDiscoverySet", + "smithy.api#documentation": "

The resource discoveries.

", + "smithy.api#xmlName": "ipamResourceDiscoverySet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

Specify the pagination token from a previous request to retrieve the next page of results.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeIpamResourceDiscoveryAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeIpamResourceDiscoveryAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeIpamResourceDiscoveryAssociationsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes resource discovery association with an Amazon VPC IPAM. An associated resource discovery is a resource discovery that has been associated with an IPAM..

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "IpamResourceDiscoveryAssociations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeIpamResourceDiscoveryAssociationsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamResourceDiscoveryAssociationIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The resource discovery association IDs.

", + "smithy.api#xmlName": "IpamResourceDiscoveryAssociationId" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

Specify the pagination token from a previous request to retrieve the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#IpamMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of resource discovery associations to return in one page of results.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The resource discovery association filters.

", + "smithy.api#xmlName": "Filter" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeIpamResourceDiscoveryAssociationsResult": { + "type": "structure", + "members": { + "IpamResourceDiscoveryAssociations": { + "target": "com.amazonaws.ec2#IpamResourceDiscoveryAssociationSet", + "traits": { + "aws.protocols#ec2QueryName": "IpamResourceDiscoveryAssociationSet", + "smithy.api#documentation": "

The resource discovery associations.

", + "smithy.api#xmlName": "ipamResourceDiscoveryAssociationSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

Specify the pagination token from a previous request to retrieve the next page of results.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeIpamScopes": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeIpamScopesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeIpamScopesResult" + }, + "traits": { + "smithy.api#documentation": "

Get information about your IPAM scopes.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "IpamScopes", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeIpamScopesRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters for the request. For more information about filtering, see Filtering CLI output.

", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#IpamMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in the request.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "IpamScopeIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the scopes you want information on.

", + "smithy.api#xmlName": "IpamScopeId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeIpamScopesResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "IpamScopes": { + "target": "com.amazonaws.ec2#IpamScopeSet", + "traits": { + "aws.protocols#ec2QueryName": "IpamScopeSet", + "smithy.api#documentation": "

The scopes you want information on.

", + "smithy.api#xmlName": "ipamScopeSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeIpams": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeIpamsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeIpamsResult" + }, + "traits": { + "smithy.api#documentation": "

Get information about your IPAM pools.

\n

For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.\n

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Ipams", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeIpamsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters for the request. For more information about filtering, see Filtering CLI output.

", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#IpamMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in the request.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "IpamIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the IPAMs you want information on.

", + "smithy.api#xmlName": "IpamId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeIpamsResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "Ipams": { + "target": "com.amazonaws.ec2#IpamSet", + "traits": { + "aws.protocols#ec2QueryName": "IpamSet", + "smithy.api#documentation": "

Information about the IPAMs.

", + "smithy.api#xmlName": "ipamSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeIpv6Pools": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeIpv6PoolsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeIpv6PoolsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes your IPv6 address pools.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Ipv6Pools", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeIpv6PoolsRequest": { + "type": "structure", + "members": { + "PoolIds": { + "target": "com.amazonaws.ec2#Ipv6PoolIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the IPv6 address pools.

", + "smithy.api#xmlName": "PoolId" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Ipv6PoolMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeIpv6PoolsResult": { + "type": "structure", + "members": { + "Ipv6Pools": { + "target": "com.amazonaws.ec2#Ipv6PoolSet", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6PoolSet", + "smithy.api#documentation": "

Information about the IPv6 address pools.

", + "smithy.api#xmlName": "ipv6PoolSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeKeyPairs": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeKeyPairsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeKeyPairsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified key pairs or all of your key pairs.

\n

For more information about key pairs, see Amazon EC2 key pairs \n\t\t\t\tin the Amazon EC2 User Guide.

", + "smithy.api#examples": [ + { + "title": "To display a key pair", + "documentation": "This example displays the fingerprint for the specified key.", + "input": { + "KeyNames": [ + "my-key-pair" + ] + }, + "output": { + "KeyPairs": [ + { + "KeyName": "my-key-pair", + "KeyFingerprint": "1f:51:ae:28:bf:89:e9:d8:1f:25:5d:37:2d:7d:b8:ca:9f:f5:f1:6f" + } + ] + } + } + ], + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "KeyPairExists": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "length(KeyPairs[].KeyName) > `0`", + "expected": "true", + "comparator": "booleanEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "errorType": "InvalidKeyPair.NotFound" + } + } + ], + "minDelay": 5 + } + } + } + }, + "com.amazonaws.ec2#DescribeKeyPairsRequest": { + "type": "structure", + "members": { + "KeyNames": { + "target": "com.amazonaws.ec2#KeyNameStringList", + "traits": { + "smithy.api#documentation": "

The key pair names.

\n

Default: Describes all of your key pairs.

", + "smithy.api#xmlName": "KeyName" + } + }, + "KeyPairIds": { + "target": "com.amazonaws.ec2#KeyPairIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the key pairs.

", + "smithy.api#xmlName": "KeyPairId" + } + }, + "IncludePublicKey": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

If true, the public key material is included in the response.

\n

Default: false\n

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeKeyPairsResult": { + "type": "structure", + "members": { + "KeyPairs": { + "target": "com.amazonaws.ec2#KeyPairList", + "traits": { + "aws.protocols#ec2QueryName": "KeySet", + "smithy.api#documentation": "

Information about the key pairs.

", + "smithy.api#xmlName": "keySet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeLaunchTemplateVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeLaunchTemplateVersionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeLaunchTemplateVersionsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more versions of a specified launch template. You can describe all\n versions, individual versions, or a range of versions. You can also describe all the\n latest versions or all the default versions of all the launch templates in your\n account.

", + "smithy.api#examples": [ + { + "title": "To describe the versions for a launch template", + "documentation": "This example describes the versions for the specified launch template.", + "input": { + "LaunchTemplateId": "068f72b72934aff71" + }, + "output": { + "LaunchTemplateVersions": [ + { + "LaunchTemplateId": "lt-068f72b72934aff71", + "LaunchTemplateName": "Webservers", + "VersionNumber": 2, + "CreatedBy": "arn:aws:iam::123456789102:root", + "LaunchTemplateData": { + "KeyName": "kp-us-east", + "ImageId": "ami-6057e21a", + "InstanceType": "t2.medium", + "NetworkInterfaces": [ + { + "SubnetId": "subnet-1a2b3c4d", + "DeviceIndex": 0, + "Groups": [ + "sg-7c227019" + ] + } + ] + }, + "DefaultVersion": false, + "CreateTime": "2017-11-20T13:12:32.000Z" + }, + { + "LaunchTemplateId": "lt-068f72b72934aff71", + "LaunchTemplateName": "Webservers", + "VersionNumber": 1, + "CreatedBy": "arn:aws:iam::123456789102:root", + "LaunchTemplateData": { + "UserData": "", + "KeyName": "kp-us-east", + "ImageId": "ami-aabbcc11", + "InstanceType": "t2.medium", + "NetworkInterfaces": [ + { + "SubnetId": "subnet-7b16de0c", + "DeviceIndex": 0, + "DeleteOnTermination": false, + "Groups": [ + "sg-7c227019" + ], + "AssociatePublicIpAddress": true + } + ] + }, + "DefaultVersion": true, + "CreateTime": "2017-11-20T12:52:33.000Z" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "LaunchTemplateVersions", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeLaunchTemplateVersionsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" + } + }, + "LaunchTemplateId": { + "target": "com.amazonaws.ec2#LaunchTemplateId", + "traits": { + "smithy.api#documentation": "

The ID of the launch template.

\n

To describe one or more versions of a specified launch template, you must specify\n either the launch template ID or the launch template name, but not both.

\n

To describe all the latest or default launch template versions in your account, you\n must omit this parameter.

" + } + }, + "LaunchTemplateName": { + "target": "com.amazonaws.ec2#LaunchTemplateName", + "traits": { + "smithy.api#documentation": "

The name of the launch template.

\n

To describe one or more versions of a specified launch template, you must specify\n either the launch template name or the launch template ID, but not both.

\n

To describe all the latest or default launch template versions in your account, you\n must omit this parameter.

" + } + }, + "Versions": { + "target": "com.amazonaws.ec2#VersionStringList", + "traits": { + "smithy.api#documentation": "

One or more versions of the launch template. Valid values depend on whether you are\n describing a specified launch template (by ID or name) or all launch templates in your\n account.

\n

To describe one or more versions of a specified launch template, valid values are\n $Latest, $Default, and numbers.

\n

To describe all launch templates in your account that are defined as the latest\n version, the valid value is $Latest. To describe all launch templates in\n your account that are defined as the default version, the valid value is\n $Default. You can specify $Latest and\n $Default in the same request. You cannot specify numbers.

", + "smithy.api#xmlName": "LaunchTemplateVersion" + } + }, + "MinVersion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The version number after which to describe launch template versions.

" + } + }, + "MaxVersion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The version number up to which to describe launch template versions.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to request the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining\n results, make another call with the returned NextToken value. This value\n can be between 1 and 200.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "ResolveAlias": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

If true, and if a Systems Manager parameter is specified for ImageId,\n the AMI ID is displayed in the response for imageId.

\n

If false, and if a Systems Manager parameter is specified for ImageId,\n the parameter is displayed in the response for imageId.

\n

For more information, see Use a Systems \n Manager parameter instead of an AMI ID in the Amazon EC2 User Guide.

\n

Default: false\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeLaunchTemplateVersionsResult": { + "type": "structure", + "members": { + "LaunchTemplateVersions": { + "target": "com.amazonaws.ec2#LaunchTemplateVersionSet", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateVersionSet", + "smithy.api#documentation": "

Information about the launch template versions.

", + "smithy.api#xmlName": "launchTemplateVersionSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null\n when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeLaunchTemplates": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeLaunchTemplatesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeLaunchTemplatesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more launch templates.

", + "smithy.api#examples": [ + { + "title": "To describe a launch template", + "documentation": "This example describes the specified launch template.", + "input": { + "LaunchTemplateIds": [ + "lt-01238c059e3466abc" + ] + }, + "output": { + "LaunchTemplates": [ + { + "LatestVersionNumber": 1, + "LaunchTemplateName": "my-template", + "LaunchTemplateId": "lt-01238c059e3466abc", + "CreatedBy": "arn:aws:iam::123456789012:root", + "CreateTime": "2018-01-16T04:32:57.000Z", + "DefaultVersionNumber": 1 + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "LaunchTemplates", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeLaunchTemplatesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.ec2#DescribeLaunchTemplatesRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" + } + }, + "LaunchTemplateIds": { + "target": "com.amazonaws.ec2#LaunchTemplateIdStringList", + "traits": { + "smithy.api#documentation": "

One or more launch template IDs.

", + "smithy.api#xmlName": "LaunchTemplateId" + } + }, + "LaunchTemplateNames": { + "target": "com.amazonaws.ec2#LaunchTemplateNameStringList", + "traits": { + "smithy.api#documentation": "

One or more launch template names.

", + "smithy.api#xmlName": "LaunchTemplateName" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to request the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeLaunchTemplatesMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining\n results, make another call with the returned NextToken value. This value\n can be between 1 and 200.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeLaunchTemplatesResult": { + "type": "structure", + "members": { + "LaunchTemplates": { + "target": "com.amazonaws.ec2#LaunchTemplateSet", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplates", + "smithy.api#documentation": "

Information about the launch templates.

", + "smithy.api#xmlName": "launchTemplates" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null\n when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the associations between virtual interface groups and local gateway route tables.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "LocalGatewayRouteTableVirtualInterfaceGroupAssociations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsRequest": { + "type": "structure", + "members": { + "LocalGatewayRouteTableVirtualInterfaceGroupAssociationIds": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTableVirtualInterfaceGroupAssociationIdSet", + "traits": { + "smithy.api#documentation": "

The IDs of the associations.

", + "smithy.api#xmlName": "LocalGatewayRouteTableVirtualInterfaceGroupAssociationId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#LocalGatewayMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsResult": { + "type": "structure", + "members": { + "LocalGatewayRouteTableVirtualInterfaceGroupAssociations": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTableVirtualInterfaceGroupAssociationSet", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayRouteTableVirtualInterfaceGroupAssociationSet", + "smithy.api#documentation": "

Information about the associations.

", + "smithy.api#xmlName": "localGatewayRouteTableVirtualInterfaceGroupAssociationSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeLocalGatewayRouteTableVpcAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeLocalGatewayRouteTableVpcAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeLocalGatewayRouteTableVpcAssociationsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified associations between VPCs and local gateway route tables.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "LocalGatewayRouteTableVpcAssociations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeLocalGatewayRouteTableVpcAssociationsRequest": { + "type": "structure", + "members": { + "LocalGatewayRouteTableVpcAssociationIds": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTableVpcAssociationIdSet", + "traits": { + "smithy.api#documentation": "

The IDs of the associations.

", + "smithy.api#xmlName": "LocalGatewayRouteTableVpcAssociationId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#LocalGatewayMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeLocalGatewayRouteTableVpcAssociationsResult": { + "type": "structure", + "members": { + "LocalGatewayRouteTableVpcAssociations": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTableVpcAssociationSet", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayRouteTableVpcAssociationSet", + "smithy.api#documentation": "

Information about the associations.

", + "smithy.api#xmlName": "localGatewayRouteTableVpcAssociationSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeLocalGatewayRouteTables": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeLocalGatewayRouteTablesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeLocalGatewayRouteTablesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more local gateway route tables. By default, all local gateway route tables are described.\n Alternatively, you can filter the results.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "LocalGatewayRouteTables", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeLocalGatewayRouteTablesRequest": { + "type": "structure", + "members": { + "LocalGatewayRouteTableIds": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTableIdSet", + "traits": { + "smithy.api#documentation": "

The IDs of the local gateway route tables.

", + "smithy.api#xmlName": "LocalGatewayRouteTableId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#LocalGatewayMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeLocalGatewayRouteTablesResult": { + "type": "structure", + "members": { + "LocalGatewayRouteTables": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTableSet", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayRouteTableSet", + "smithy.api#documentation": "

Information about the local gateway route tables.

", + "smithy.api#xmlName": "localGatewayRouteTableSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeLocalGatewayVirtualInterfaceGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeLocalGatewayVirtualInterfaceGroupsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeLocalGatewayVirtualInterfaceGroupsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified local gateway virtual interface groups.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "LocalGatewayVirtualInterfaceGroups", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeLocalGatewayVirtualInterfaceGroupsRequest": { + "type": "structure", + "members": { + "LocalGatewayVirtualInterfaceGroupIds": { + "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupIdSet", + "traits": { + "smithy.api#documentation": "

The IDs of the virtual interface groups.

", + "smithy.api#xmlName": "LocalGatewayVirtualInterfaceGroupId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#LocalGatewayMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeLocalGatewayVirtualInterfaceGroupsResult": { + "type": "structure", + "members": { + "LocalGatewayVirtualInterfaceGroups": { + "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupSet", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayVirtualInterfaceGroupSet", + "smithy.api#documentation": "

The virtual interface groups.

", + "smithy.api#xmlName": "localGatewayVirtualInterfaceGroupSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeLocalGatewayVirtualInterfaces": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeLocalGatewayVirtualInterfacesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeLocalGatewayVirtualInterfacesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified local gateway virtual interfaces.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "LocalGatewayVirtualInterfaces", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeLocalGatewayVirtualInterfacesRequest": { + "type": "structure", + "members": { + "LocalGatewayVirtualInterfaceIds": { + "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceIdSet", + "traits": { + "smithy.api#documentation": "

The IDs of the virtual interfaces.

", + "smithy.api#xmlName": "LocalGatewayVirtualInterfaceId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#LocalGatewayMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeLocalGatewayVirtualInterfacesResult": { + "type": "structure", + "members": { + "LocalGatewayVirtualInterfaces": { + "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceSet", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayVirtualInterfaceSet", + "smithy.api#documentation": "

Information about the virtual interfaces.

", + "smithy.api#xmlName": "localGatewayVirtualInterfaceSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeLocalGateways": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeLocalGatewaysRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeLocalGatewaysResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more local gateways. By default, all local gateways are described. \n Alternatively, you can filter the results.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "LocalGateways", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeLocalGatewaysRequest": { + "type": "structure", + "members": { + "LocalGatewayIds": { + "target": "com.amazonaws.ec2#LocalGatewayIdSet", + "traits": { + "smithy.api#documentation": "

The IDs of the local gateways.

", + "smithy.api#xmlName": "LocalGatewayId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#LocalGatewayMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeLocalGatewaysResult": { + "type": "structure", + "members": { + "LocalGateways": { + "target": "com.amazonaws.ec2#LocalGatewaySet", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewaySet", + "smithy.api#documentation": "

Information about the local gateways.

", + "smithy.api#xmlName": "localGatewaySet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeLockedSnapshots": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeLockedSnapshotsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeLockedSnapshotsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the lock status for a snapshot.

" + } + }, + "com.amazonaws.ec2#DescribeLockedSnapshotsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeLockedSnapshotsRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeLockedSnapshotsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output. \n\tFor more information, see Pagination.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request.\n Pagination continues from the end of the items returned by the previous request.

" + } + }, + "SnapshotIds": { + "target": "com.amazonaws.ec2#SnapshotIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the snapshots for which to view the lock status.

", + "smithy.api#xmlName": "SnapshotId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeLockedSnapshotsResult": { + "type": "structure", + "members": { + "Snapshots": { + "target": "com.amazonaws.ec2#LockedSnapshotsInfoList", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotSet", + "smithy.api#documentation": "

Information about the snapshots.

", + "smithy.api#xmlName": "snapshotSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. \n This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeMacHosts": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeMacHostsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeMacHostsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified EC2 Mac Dedicated Host or all of your EC2 Mac Dedicated Hosts.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "MacHosts", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeMacHostsRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "HostIds": { + "target": "com.amazonaws.ec2#RequestHostIdList", + "traits": { + "smithy.api#documentation": "

\n The IDs of the EC2 Mac Dedicated Hosts.\n

", + "smithy.api#xmlName": "HostId" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeMacHostsRequestMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeMacHostsRequestMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 500 + } + } + }, + "com.amazonaws.ec2#DescribeMacHostsResult": { + "type": "structure", + "members": { + "MacHosts": { + "target": "com.amazonaws.ec2#MacHostList", + "traits": { + "aws.protocols#ec2QueryName": "MacHostSet", + "smithy.api#documentation": "

\n Information about the EC2 Mac Dedicated Hosts.\n

", + "smithy.api#xmlName": "macHostSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeManagedPrefixLists": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeManagedPrefixListsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeManagedPrefixListsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes your managed prefix lists and any Amazon Web Services-managed prefix lists.

\n

To view the entries for your prefix list, use GetManagedPrefixListEntries.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "PrefixLists", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeManagedPrefixListsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#PrefixListMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "PrefixListIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

One or more prefix list IDs.

", + "smithy.api#xmlName": "PrefixListId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeManagedPrefixListsResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "PrefixLists": { + "target": "com.amazonaws.ec2#ManagedPrefixListSet", + "traits": { + "aws.protocols#ec2QueryName": "PrefixListSet", + "smithy.api#documentation": "

Information about the prefix lists.

", + "smithy.api#xmlName": "prefixListSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeMovingAddresses": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeMovingAddressesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeMovingAddressesResult" + }, + "traits": { + "smithy.api#documentation": "\n

This action is deprecated.

\n \n

Describes your Elastic IP addresses that are being moved from or being restored to the EC2-Classic platform. \n This request does not return information about any other Elastic IP addresses in your account.

", + "smithy.api#examples": [ + { + "title": "To describe your moving addresses", + "documentation": "This example describes all of your moving Elastic IP addresses.", + "output": { + "MovingAddressStatuses": [ + { + "PublicIp": "198.51.100.0", + "MoveStatus": "movingToVpc" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "MovingAddressStatuses", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeMovingAddressesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeMovingAddressesRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "PublicIps": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "PublicIp", + "smithy.api#documentation": "

One or more Elastic IP addresses.

", + "smithy.api#xmlName": "publicIp" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token for the next page of results.

", + "smithy.api#xmlName": "nextToken" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "aws.protocols#ec2QueryName": "Filter", + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeMovingAddressesMaxResults", + "traits": { + "aws.protocols#ec2QueryName": "MaxResults", + "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining\n results of the initial request can be seen by sending another request with the returned\n NextToken value. This value can be between 5 and 1000; if\n MaxResults is given a value outside of this range, an error is returned.

\n

Default: If no value is provided, the default is 1000.

", + "smithy.api#xmlName": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeMovingAddressesResult": { + "type": "structure", + "members": { + "MovingAddressStatuses": { + "target": "com.amazonaws.ec2#MovingAddressStatusSet", + "traits": { + "aws.protocols#ec2QueryName": "MovingAddressStatusSet", + "smithy.api#documentation": "

The status for each Elastic IP address.

", + "smithy.api#xmlName": "movingAddressStatusSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeNatGateways": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeNatGatewaysRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeNatGatewaysResult" + }, + "traits": { + "smithy.api#documentation": "

Describes your NAT gateways. The default is to describe all your NAT gateways. \n Alternatively, you can specify specific NAT gateway IDs or filter the results to\n include only the NAT gateways that match specific criteria.

", + "smithy.api#examples": [ + { + "title": "To describe a NAT gateway", + "documentation": "This example describes the NAT gateway for the specified VPC.", + "input": { + "Filter": [ + { + "Name": "vpc-id", + "Values": [ + "vpc-1a2b3c4d" + ] + } + ] + }, + "output": { + "NatGateways": [ + { + "NatGatewayAddresses": [ + { + "PublicIp": "198.11.222.333", + "NetworkInterfaceId": "eni-9dec76cd", + "AllocationId": "eipalloc-89c620ec", + "PrivateIp": "10.0.0.149" + } + ], + "VpcId": "vpc-1a2b3c4d", + "State": "available", + "NatGatewayId": "nat-05dba92075d71c408", + "SubnetId": "subnet-847e4dc2", + "CreateTime": "2015-12-01T12:26:55.983Z" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "NatGateways", + "pageSize": "MaxResults" + }, + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "NatGatewayAvailable": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "NatGateways[].State", + "expected": "available", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "NatGateways[].State", + "expected": "failed", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "NatGateways[].State", + "expected": "deleting", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "NatGateways[].State", + "expected": "deleted", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "errorType": "NatGatewayNotFound" + } + } + ], + "minDelay": 15 + }, + "NatGatewayDeleted": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "NatGateways[].State", + "expected": "deleted", + "comparator": "allStringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "errorType": "NatGatewayNotFound" + } + } + ], + "minDelay": 15 + } + } + } + }, + "com.amazonaws.ec2#DescribeNatGatewaysMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeNatGatewaysRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Filter": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n " + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeNatGatewaysMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

" + } + }, + "NatGatewayIds": { + "target": "com.amazonaws.ec2#NatGatewayIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the NAT gateways.

", + "smithy.api#xmlName": "NatGatewayId" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeNatGatewaysResult": { + "type": "structure", + "members": { + "NatGateways": { + "target": "com.amazonaws.ec2#NatGatewayList", + "traits": { + "aws.protocols#ec2QueryName": "NatGatewaySet", + "smithy.api#documentation": "

Information about the NAT gateways.

", + "smithy.api#xmlName": "natGatewaySet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeNetworkAcls": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeNetworkAclsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeNetworkAclsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes your network ACLs. The default is to describe all your network ACLs. \n Alternatively, you can specify specific network ACL IDs or filter the results to\n include only the network ACLs that match specific criteria.

\n

For more information, see Network ACLs in the\n\t\t\t\tAmazon VPC User Guide.

", + "smithy.api#examples": [ + { + "title": "To describe a network ACL", + "documentation": "This example describes the specified network ACL.", + "input": { + "NetworkAclIds": [ + "acl-5fb85d36" + ] + }, + "output": { + "NetworkAcls": [ + { + "Associations": [ + { + "SubnetId": "subnet-65ea5f08", + "NetworkAclId": "acl-9aeb5ef7", + "NetworkAclAssociationId": "aclassoc-66ea5f0b" + } + ], + "NetworkAclId": "acl-5fb85d36", + "VpcId": "vpc-a01106c2", + "Tags": [], + "Entries": [ + { + "CidrBlock": "0.0.0.0/0", + "RuleNumber": 32767, + "Protocol": "-1", + "Egress": true, + "RuleAction": "deny" + }, + { + "CidrBlock": "0.0.0.0/0", + "RuleNumber": 32767, + "Protocol": "-1", + "Egress": false, + "RuleAction": "deny" + } + ], + "IsDefault": false + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "NetworkAcls", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeNetworkAclsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeNetworkAclsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeNetworkAclsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "NetworkAclIds": { + "target": "com.amazonaws.ec2#NetworkAclIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the network ACLs.

", + "smithy.api#xmlName": "NetworkAclId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeNetworkAclsResult": { + "type": "structure", + "members": { + "NetworkAcls": { + "target": "com.amazonaws.ec2#NetworkAclList", + "traits": { + "aws.protocols#ec2QueryName": "NetworkAclSet", + "smithy.api#documentation": "

Information about the network ACLs.

", + "smithy.api#xmlName": "networkAclSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeNetworkInsightsAccessScopeAnalyses": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeNetworkInsightsAccessScopeAnalysesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeNetworkInsightsAccessScopeAnalysesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified Network Access Scope analyses.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "NetworkInsightsAccessScopeAnalyses", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeNetworkInsightsAccessScopeAnalysesRequest": { + "type": "structure", + "members": { + "NetworkInsightsAccessScopeAnalysisIds": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysisIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the Network Access Scope analyses.

", + "smithy.api#xmlName": "NetworkInsightsAccessScopeAnalysisId" + } + }, + "NetworkInsightsAccessScopeId": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeId", + "traits": { + "smithy.api#documentation": "

The ID of the Network Access Scope.

" + } + }, + "AnalysisStartTimeBegin": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "smithy.api#documentation": "

Filters the results based on the start time. The analysis must have started on or after this time.

" + } + }, + "AnalysisStartTimeEnd": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "smithy.api#documentation": "

Filters the results based on the start time. The analysis must have started on or before this time.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

There are no supported filters.

", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#NetworkInsightsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeNetworkInsightsAccessScopeAnalysesResult": { + "type": "structure", + "members": { + "NetworkInsightsAccessScopeAnalyses": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysisList", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeAnalysisSet", + "smithy.api#documentation": "

The Network Access Scope analyses.

", + "smithy.api#xmlName": "networkInsightsAccessScopeAnalysisSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeNetworkInsightsAccessScopes": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeNetworkInsightsAccessScopesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeNetworkInsightsAccessScopesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified Network Access Scopes.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "NetworkInsightsAccessScopes", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeNetworkInsightsAccessScopesRequest": { + "type": "structure", + "members": { + "NetworkInsightsAccessScopeIds": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the Network Access Scopes.

", + "smithy.api#xmlName": "NetworkInsightsAccessScopeId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

There are no supported filters.

", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#NetworkInsightsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeNetworkInsightsAccessScopesResult": { + "type": "structure", + "members": { + "NetworkInsightsAccessScopes": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeList", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeSet", + "smithy.api#documentation": "

The Network Access Scopes.

", + "smithy.api#xmlName": "networkInsightsAccessScopeSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeNetworkInsightsAnalyses": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeNetworkInsightsAnalysesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeNetworkInsightsAnalysesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more of your network insights analyses.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "NetworkInsightsAnalyses", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeNetworkInsightsAnalysesRequest": { + "type": "structure", + "members": { + "NetworkInsightsAnalysisIds": { + "target": "com.amazonaws.ec2#NetworkInsightsAnalysisIdList", + "traits": { + "smithy.api#documentation": "

The ID of the network insights analyses. You must specify either analysis IDs or a path ID.

", + "smithy.api#xmlName": "NetworkInsightsAnalysisId" + } + }, + "NetworkInsightsPathId": { + "target": "com.amazonaws.ec2#NetworkInsightsPathId", + "traits": { + "smithy.api#documentation": "

The ID of the path. You must specify either a path ID or analysis IDs.

" + } + }, + "AnalysisStartTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "smithy.api#documentation": "

The time when the network insights analyses started.

" + } + }, + "AnalysisEndTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "smithy.api#documentation": "

The time when the network insights analyses ended.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters. The following are the possible values:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#NetworkInsightsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeNetworkInsightsAnalysesResult": { + "type": "structure", + "members": { + "NetworkInsightsAnalyses": { + "target": "com.amazonaws.ec2#NetworkInsightsAnalysisList", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAnalysisSet", + "smithy.api#documentation": "

Information about the network insights analyses.

", + "smithy.api#xmlName": "networkInsightsAnalysisSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeNetworkInsightsPaths": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeNetworkInsightsPathsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeNetworkInsightsPathsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more of your paths.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "NetworkInsightsPaths", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeNetworkInsightsPathsRequest": { + "type": "structure", + "members": { + "NetworkInsightsPathIds": { + "target": "com.amazonaws.ec2#NetworkInsightsPathIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the paths.

", + "smithy.api#xmlName": "NetworkInsightsPathId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters. The following are the possible values:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#NetworkInsightsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeNetworkInsightsPathsResult": { + "type": "structure", + "members": { + "NetworkInsightsPaths": { + "target": "com.amazonaws.ec2#NetworkInsightsPathList", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsPathSet", + "smithy.api#documentation": "

Information about the paths.

", + "smithy.api#xmlName": "networkInsightsPathSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeNetworkInterfaceAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeNetworkInterfaceAttributeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeNetworkInterfaceAttributeResult" + }, + "traits": { + "smithy.api#documentation": "

Describes a network interface attribute. You can specify only one attribute at a time.

", + "smithy.api#examples": [ + { + "title": "To describe the attachment attribute of a network interface", + "documentation": "This example describes the attachment attribute of the specified network interface.", + "input": { + "NetworkInterfaceId": "eni-686ea200", + "Attribute": "attachment" + }, + "output": { + "NetworkInterfaceId": "eni-686ea200", + "Attachment": { + "Status": "attached", + "DeviceIndex": 0, + "AttachTime": "2015-05-21T20:02:20.000Z", + "InstanceId": "i-1234567890abcdef0", + "DeleteOnTermination": true, + "AttachmentId": "eni-attach-43348162", + "InstanceOwnerId": "123456789012" + } + } + }, + { + "title": "To describe the description attribute of a network interface", + "documentation": "This example describes the description attribute of the specified network interface.", + "input": { + "NetworkInterfaceId": "eni-686ea200", + "Attribute": "description" + }, + "output": { + "NetworkInterfaceId": "eni-686ea200", + "Description": { + "Value": "My description" + } + } + }, + { + "title": "To describe the groupSet attribute of a network interface", + "documentation": "This example describes the groupSet attribute of the specified network interface.", + "input": { + "NetworkInterfaceId": "eni-686ea200", + "Attribute": "groupSet" + }, + "output": { + "NetworkInterfaceId": "eni-686ea200", + "Groups": [ + { + "GroupName": "my-security-group", + "GroupId": "sg-903004f8" + } + ] + } + }, + { + "title": "To describe the sourceDestCheck attribute of a network interface", + "documentation": "This example describes the sourceDestCheck attribute of the specified network interface.", + "input": { + "NetworkInterfaceId": "eni-686ea200", + "Attribute": "sourceDestCheck" + }, + "output": { + "NetworkInterfaceId": "eni-686ea200", + "SourceDestCheck": { + "Value": true + } + } + } + ] + } + }, + "com.amazonaws.ec2#DescribeNetworkInterfaceAttributeRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "Attribute": { + "target": "com.amazonaws.ec2#NetworkInterfaceAttribute", + "traits": { + "aws.protocols#ec2QueryName": "Attribute", + "smithy.api#documentation": "

The attribute of the network interface. This parameter is required.

", + "smithy.api#xmlName": "attribute" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DescribeNetworkInterfaceAttribute.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeNetworkInterfaceAttributeResult": { + "type": "structure", + "members": { + "Attachment": { + "target": "com.amazonaws.ec2#NetworkInterfaceAttachment", + "traits": { + "aws.protocols#ec2QueryName": "Attachment", + "smithy.api#documentation": "

The attachment (if any) of the network interface.

", + "smithy.api#xmlName": "attachment" + } + }, + "Description": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description of the network interface.

", + "smithy.api#xmlName": "description" + } + }, + "Groups": { + "target": "com.amazonaws.ec2#GroupIdentifierList", + "traits": { + "aws.protocols#ec2QueryName": "GroupSet", + "smithy.api#documentation": "

The security groups associated with the network interface.

", + "smithy.api#xmlName": "groupSet" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "SourceDestCheck": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "aws.protocols#ec2QueryName": "SourceDestCheck", + "smithy.api#documentation": "

Indicates whether source/destination checking is enabled.

", + "smithy.api#xmlName": "sourceDestCheck" + } + }, + "AssociatePublicIpAddress": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "AssociatePublicIpAddress", + "smithy.api#documentation": "

Indicates whether to assign a public IPv4 address to a network interface. \n This option can be enabled for any network interface but will only apply to the primary network interface (eth0).

", + "smithy.api#xmlName": "associatePublicIpAddress" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of DescribeNetworkInterfaceAttribute.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeNetworkInterfacePermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeNetworkInterfacePermissionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeNetworkInterfacePermissionsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the permissions for your network interfaces.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "NetworkInterfacePermissions", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeNetworkInterfacePermissionsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 255 + } + } + }, + "com.amazonaws.ec2#DescribeNetworkInterfacePermissionsRequest": { + "type": "structure", + "members": { + "NetworkInterfacePermissionIds": { + "target": "com.amazonaws.ec2#NetworkInterfacePermissionIdList", + "traits": { + "smithy.api#documentation": "

The network interface permission IDs.

", + "smithy.api#xmlName": "NetworkInterfacePermissionId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request.\n\t\t Pagination continues from the end of the items returned by the previous request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeNetworkInterfacePermissionsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request. To get the next page of items,\n\t\t\tmake another request with the token returned in the output. If this parameter is not specified, \n\t\t\tup to 50 results are returned by default. For more information, see\n\t\t\tPagination.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DescribeNetworkInterfacePermissions.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeNetworkInterfacePermissionsResult": { + "type": "structure", + "members": { + "NetworkInterfacePermissions": { + "target": "com.amazonaws.ec2#NetworkInterfacePermissionList", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfacePermissions", + "smithy.api#documentation": "

The network interface permissions.

", + "smithy.api#xmlName": "networkInterfacePermissions" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items.\n\t\t This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output for DescribeNetworkInterfacePermissions.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeNetworkInterfaces": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeNetworkInterfacesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeNetworkInterfacesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more of your network interfaces.

\n

If you have a large number of network interfaces, the operation fails unless \n you use pagination or one of the following filters: group-id, \n mac-address, private-dns-name, private-ip-address, \n private-dns-name, subnet-id, or vpc-id.

\n \n

We strongly recommend using only paginated requests. Unpaginated requests are\n susceptible to throttling and timeouts.

\n ", + "smithy.api#examples": [ + { + "title": "To describe a network interface", + "documentation": "", + "input": { + "NetworkInterfaceIds": [ + "eni-e5aa89a3" + ] + }, + "output": { + "NetworkInterfaces": [ + { + "Status": "in-use", + "MacAddress": "02:2f:8f:b0:cf:75", + "SourceDestCheck": true, + "VpcId": "vpc-a01106c2", + "Description": "my network interface", + "Association": { + "PublicIp": "203.0.113.12", + "AssociationId": "eipassoc-0fbb766a", + "PublicDnsName": "ec2-203-0-113-12.compute-1.amazonaws.com", + "IpOwnerId": "123456789012" + }, + "NetworkInterfaceId": "eni-e5aa89a3", + "PrivateIpAddresses": [ + { + "PrivateDnsName": "ip-10-0-1-17.ec2.internal", + "Association": { + "PublicIp": "203.0.113.12", + "AssociationId": "eipassoc-0fbb766a", + "PublicDnsName": "ec2-203-0-113-12.compute-1.amazonaws.com", + "IpOwnerId": "123456789012" + }, + "Primary": true, + "PrivateIpAddress": "10.0.1.17" + } + ], + "RequesterManaged": false, + "PrivateDnsName": "ip-10-0-1-17.ec2.internal", + "AvailabilityZone": "us-east-1d", + "Attachment": { + "Status": "attached", + "DeviceIndex": 1, + "AttachTime": "2013-11-30T23:36:42.000Z", + "InstanceId": "i-1234567890abcdef0", + "DeleteOnTermination": false, + "AttachmentId": "eni-attach-66c4350a", + "InstanceOwnerId": "123456789012" + }, + "Groups": [ + { + "GroupName": "default", + "GroupId": "sg-8637d3e3" + } + ], + "SubnetId": "subnet-b61f49f0", + "OwnerId": "123456789012", + "TagSet": [], + "PrivateIpAddress": "10.0.1.17" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "NetworkInterfaces", + "pageSize": "MaxResults" + }, + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "NetworkInterfaceAvailable": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "NetworkInterfaces[].Status", + "expected": "available", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "errorType": "InvalidNetworkInterfaceID.NotFound" + } + } + ], + "minDelay": 20 + } + } + } + }, + "com.amazonaws.ec2#DescribeNetworkInterfacesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeNetworkInterfacesRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request.\n\t\t Pagination continues from the end of the items returned by the previous request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeNetworkInterfacesMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request. To get the next page of items,\n\t\t make another request with the token returned in the output. You cannot specify this\n\t\t parameter and the network interface IDs parameter in the same request. For more information, \n\t\t see Pagination.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "NetworkInterfaceIds": { + "target": "com.amazonaws.ec2#NetworkInterfaceIdList", + "traits": { + "smithy.api#documentation": "

The network interface IDs.

\n

Default: Describes all your network interfaces.

", + "smithy.api#xmlName": "NetworkInterfaceId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "aws.protocols#ec2QueryName": "Filter", + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "filter" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DescribeNetworkInterfaces.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeNetworkInterfacesResult": { + "type": "structure", + "members": { + "NetworkInterfaces": { + "target": "com.amazonaws.ec2#NetworkInterfaceList", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceSet", + "smithy.api#documentation": "

Information about the network interfaces.

", + "smithy.api#xmlName": "networkInterfaceSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. \n\t\t This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribePlacementGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribePlacementGroupsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribePlacementGroupsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified placement groups or all of your placement groups.

\n \n

To describe a specific placement group that is shared with\n your account, you must specify the ID of the placement group using the\n GroupId parameter. Specifying the name of a\n shared placement group using the GroupNames\n parameter will result in an error.

\n \n

For more information, see Placement groups in the\n Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#DescribePlacementGroupsRequest": { + "type": "structure", + "members": { + "GroupIds": { + "target": "com.amazonaws.ec2#PlacementGroupIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the placement groups.

", + "smithy.api#xmlName": "GroupId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "GroupNames": { + "target": "com.amazonaws.ec2#PlacementGroupStringList", + "traits": { + "aws.protocols#ec2QueryName": "GroupName", + "smithy.api#documentation": "

The names of the placement groups.

\n

Constraints:

\n ", + "smithy.api#xmlName": "groupName" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribePlacementGroupsResult": { + "type": "structure", + "members": { + "PlacementGroups": { + "target": "com.amazonaws.ec2#PlacementGroupList", + "traits": { + "aws.protocols#ec2QueryName": "PlacementGroupSet", + "smithy.api#documentation": "

Information about the placement groups.

", + "smithy.api#xmlName": "placementGroupSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribePrefixLists": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribePrefixListsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribePrefixListsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes available Amazon Web Services services in a prefix list format, which includes the prefix list\n name and prefix list ID of the service and the IP address range for the service.

\n

We recommend that you use DescribeManagedPrefixLists instead.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "PrefixLists", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribePrefixListsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "PrefixListIds": { + "target": "com.amazonaws.ec2#PrefixListResourceIdStringList", + "traits": { + "smithy.api#documentation": "

One or more prefix list IDs.

", + "smithy.api#xmlName": "PrefixListId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribePrefixListsResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "PrefixLists": { + "target": "com.amazonaws.ec2#PrefixListSet", + "traits": { + "aws.protocols#ec2QueryName": "PrefixListSet", + "smithy.api#documentation": "

All available prefix lists.

", + "smithy.api#xmlName": "prefixListSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribePrincipalIdFormat": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribePrincipalIdFormatRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribePrincipalIdFormatResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the ID format settings for the root user and all IAM roles and IAM users\n that have explicitly specified a longer ID (17-character ID) preference.

\n

By default, all IAM roles and IAM users default to the same ID settings as the root user, unless they\n explicitly override the settings. This request is useful for identifying those IAM users and IAM roles\n that have overridden the default ID settings.

\n

The following resource types support longer IDs: bundle |\n conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | instance | internet-gateway |\n network-acl | network-acl-association |\n network-interface | network-interface-attachment |\n prefix-list | reservation | route-table |\n route-table-association | security-group |\n snapshot | subnet |\n subnet-cidr-block-association | volume | vpc\n | vpc-cidr-block-association | vpc-endpoint |\n vpc-peering-connection | vpn-connection | vpn-gateway.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Principals", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribePrincipalIdFormatMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribePrincipalIdFormatRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Resources": { + "target": "com.amazonaws.ec2#ResourceList", + "traits": { + "smithy.api#documentation": "

The type of resource: bundle |\n conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | instance | internet-gateway |\n network-acl | network-acl-association |\n network-interface | network-interface-attachment |\n prefix-list | reservation | route-table |\n route-table-association | security-group |\n snapshot | subnet |\n subnet-cidr-block-association | volume | vpc\n | vpc-cidr-block-association | vpc-endpoint |\n vpc-peering-connection | vpn-connection | vpn-gateway\n

", + "smithy.api#xmlName": "Resource" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribePrincipalIdFormatMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining\n results, make another call with the returned NextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to request the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribePrincipalIdFormatResult": { + "type": "structure", + "members": { + "Principals": { + "target": "com.amazonaws.ec2#PrincipalIdFormatList", + "traits": { + "aws.protocols#ec2QueryName": "PrincipalSet", + "smithy.api#documentation": "

Information about the ID format settings for the ARN.

", + "smithy.api#xmlName": "principalSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribePublicIpv4Pools": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribePublicIpv4PoolsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribePublicIpv4PoolsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified IPv4 address pools.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "PublicIpv4Pools", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribePublicIpv4PoolsRequest": { + "type": "structure", + "members": { + "PoolIds": { + "target": "com.amazonaws.ec2#PublicIpv4PoolIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the address pools.

", + "smithy.api#xmlName": "PoolId" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#PoolMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribePublicIpv4PoolsResult": { + "type": "structure", + "members": { + "PublicIpv4Pools": { + "target": "com.amazonaws.ec2#PublicIpv4PoolSet", + "traits": { + "aws.protocols#ec2QueryName": "PublicIpv4PoolSet", + "smithy.api#documentation": "

Information about the address pools.

", + "smithy.api#xmlName": "publicIpv4PoolSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeRegions": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeRegionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeRegionsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the Regions that are enabled for your account, or all Regions.

\n

For a list of the Regions supported by Amazon EC2, see Amazon EC2 service endpoints.

\n

For information about enabling and disabling Regions for your account, see Specify which Amazon Web Services Regions \n your account can use in the Amazon Web Services Account Management Reference Guide.

\n \n

The order of the elements in the response, including those within nested structures,\n might vary. Applications should not assume the elements appear in a particular order.

\n ", + "smithy.api#examples": [ + { + "title": "To describe your regions", + "documentation": "This example describes all the regions that are available to you.", + "output": { + "Regions": [ + { + "Endpoint": "ec2.ap-south-1.amazonaws.com", + "RegionName": "ap-south-1" + }, + { + "Endpoint": "ec2.eu-west-1.amazonaws.com", + "RegionName": "eu-west-1" + }, + { + "Endpoint": "ec2.ap-southeast-1.amazonaws.com", + "RegionName": "ap-southeast-1" + }, + { + "Endpoint": "ec2.ap-southeast-2.amazonaws.com", + "RegionName": "ap-southeast-2" + }, + { + "Endpoint": "ec2.eu-central-1.amazonaws.com", + "RegionName": "eu-central-1" + }, + { + "Endpoint": "ec2.ap-northeast-2.amazonaws.com", + "RegionName": "ap-northeast-2" + }, + { + "Endpoint": "ec2.ap-northeast-1.amazonaws.com", + "RegionName": "ap-northeast-1" + }, + { + "Endpoint": "ec2.us-east-1.amazonaws.com", + "RegionName": "us-east-1" + }, + { + "Endpoint": "ec2.sa-east-1.amazonaws.com", + "RegionName": "sa-east-1" + }, + { + "Endpoint": "ec2.us-west-1.amazonaws.com", + "RegionName": "us-west-1" + }, + { + "Endpoint": "ec2.us-west-2.amazonaws.com", + "RegionName": "us-west-2" + } + ] + } + } + ], + "smithy.test#smokeTests": [ + { + "id": "DescribeRegionsSuccess", + "params": {}, + "vendorParams": { + "region": "us-west-2" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "success": {} + } + } + ] + } + }, + "com.amazonaws.ec2#DescribeRegionsRequest": { + "type": "structure", + "members": { + "RegionNames": { + "target": "com.amazonaws.ec2#RegionNameStringList", + "traits": { + "smithy.api#documentation": "

The names of the Regions. You can specify any Regions, whether they are enabled and disabled for your account.

", + "smithy.api#xmlName": "RegionName" + } + }, + "AllRegions": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether to display all Regions, including Regions that are disabled for your account.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeRegionsResult": { + "type": "structure", + "members": { + "Regions": { + "target": "com.amazonaws.ec2#RegionList", + "traits": { + "aws.protocols#ec2QueryName": "RegionInfo", + "smithy.api#documentation": "

Information about the Regions.

", + "smithy.api#xmlName": "regionInfo" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeReplaceRootVolumeTasks": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeReplaceRootVolumeTasksRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeReplaceRootVolumeTasksResult" + }, + "traits": { + "smithy.api#documentation": "

Describes a root volume replacement task. For more information, see \n Replace a root volume in the Amazon EC2 User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ReplaceRootVolumeTasks", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeReplaceRootVolumeTasksMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.ec2#DescribeReplaceRootVolumeTasksRequest": { + "type": "structure", + "members": { + "ReplaceRootVolumeTaskIds": { + "target": "com.amazonaws.ec2#ReplaceRootVolumeTaskIds", + "traits": { + "smithy.api#documentation": "

The ID of the root volume replacement task to view.

", + "smithy.api#xmlName": "ReplaceRootVolumeTaskId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

Filter to use:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeReplaceRootVolumeTasksMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output. \n\tFor more information, see Pagination.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request.\n Pagination continues from the end of the items returned by the previous request.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeReplaceRootVolumeTasksResult": { + "type": "structure", + "members": { + "ReplaceRootVolumeTasks": { + "target": "com.amazonaws.ec2#ReplaceRootVolumeTasks", + "traits": { + "aws.protocols#ec2QueryName": "ReplaceRootVolumeTaskSet", + "smithy.api#documentation": "

Information about the root volume replacement task.

", + "smithy.api#xmlName": "replaceRootVolumeTaskSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. \n This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeReservedInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeReservedInstancesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeReservedInstancesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more of the Reserved Instances that you purchased.

\n

For more information about Reserved Instances, see Reserved\n\t\t\t\tInstances in the Amazon EC2 User Guide.

\n \n

The order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.

\n " + } + }, + "com.amazonaws.ec2#DescribeReservedInstancesListings": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeReservedInstancesListingsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeReservedInstancesListingsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes your account's Reserved Instance listings in the Reserved Instance Marketplace.

\n

The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

\n

As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.

\n

As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.

\n

For more information, see Sell in the Reserved Instance\n Marketplace in the Amazon EC2 User Guide.

\n \n

The order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.

\n " + } + }, + "com.amazonaws.ec2#DescribeReservedInstancesListingsRequest": { + "type": "structure", + "members": { + "ReservedInstancesId": { + "target": "com.amazonaws.ec2#ReservationId", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstancesId", + "smithy.api#documentation": "

One or more Reserved Instance IDs.

", + "smithy.api#xmlName": "reservedInstancesId" + } + }, + "ReservedInstancesListingId": { + "target": "com.amazonaws.ec2#ReservedInstancesListingId", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstancesListingId", + "smithy.api#documentation": "

One or more Reserved Instance listing IDs.

", + "smithy.api#xmlName": "reservedInstancesListingId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DescribeReservedInstancesListings.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeReservedInstancesListingsResult": { + "type": "structure", + "members": { + "ReservedInstancesListings": { + "target": "com.amazonaws.ec2#ReservedInstancesListingList", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstancesListingsSet", + "smithy.api#documentation": "

Information about the Reserved Instance listing.

", + "smithy.api#xmlName": "reservedInstancesListingsSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of DescribeReservedInstancesListings.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeReservedInstancesModifications": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeReservedInstancesModificationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeReservedInstancesModificationsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.

\n

For more information, see Modify Reserved Instances in the\n Amazon EC2 User Guide.

\n \n

The order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.

\n ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ReservedInstancesModifications" + } + } + }, + "com.amazonaws.ec2#DescribeReservedInstancesModificationsRequest": { + "type": "structure", + "members": { + "ReservedInstancesModificationIds": { + "target": "com.amazonaws.ec2#ReservedInstancesModificationIdStringList", + "traits": { + "smithy.api#documentation": "

IDs for the submitted modification request.

", + "smithy.api#xmlName": "ReservedInstancesModificationId" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to retrieve the next page of results.

", + "smithy.api#xmlName": "nextToken" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DescribeReservedInstancesModifications.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeReservedInstancesModificationsResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when\n\t\t\tthere are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "ReservedInstancesModifications": { + "target": "com.amazonaws.ec2#ReservedInstancesModificationList", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstancesModificationsSet", + "smithy.api#documentation": "

The Reserved Instance modification information.

", + "smithy.api#xmlName": "reservedInstancesModificationsSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of DescribeReservedInstancesModifications.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeReservedInstancesOfferings": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeReservedInstancesOfferingsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeReservedInstancesOfferingsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.

\n

If you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances.

\n

For more information, see Sell in the Reserved Instance\n Marketplace in the Amazon EC2 User Guide.

\n \n

The order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.

\n ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ReservedInstancesOfferings", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeReservedInstancesOfferingsRequest": { + "type": "structure", + "members": { + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone in which the Reserved Instance can be used.

" + } + }, + "IncludeMarketplace": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Include Reserved Instance Marketplace offerings in the response.

" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "smithy.api#documentation": "

The instance type that the reservation will cover (for example, m1.small).\n For more information, see Amazon EC2 instance types in the\n Amazon EC2 User Guide.

" + } + }, + "MaxDuration": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "smithy.api#documentation": "

The maximum duration (in seconds) to filter when searching for offerings.

\n

Default: 94608000 (3 years)

" + } + }, + "MaxInstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of instances to filter when searching for offerings.

\n

Default: 20

" + } + }, + "MinDuration": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "smithy.api#documentation": "

The minimum duration (in seconds) to filter when searching for offerings.

\n

Default: 2592000 (1 month)

" + } + }, + "OfferingClass": { + "target": "com.amazonaws.ec2#OfferingClassType", + "traits": { + "smithy.api#documentation": "

The offering class of the Reserved Instance. Can be standard or convertible.

" + } + }, + "ProductDescription": { + "target": "com.amazonaws.ec2#RIProductDescription", + "traits": { + "smithy.api#documentation": "

The Reserved Instance product platform description. Instances that include (Amazon\n VPC) in the description are for use with Amazon VPC.

" + } + }, + "ReservedInstancesOfferingIds": { + "target": "com.amazonaws.ec2#ReservedInstancesOfferingIdStringList", + "traits": { + "smithy.api#documentation": "

One or more Reserved Instances offering IDs.

", + "smithy.api#xmlName": "ReservedInstancesOfferingId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "InstanceTenancy": { + "target": "com.amazonaws.ec2#Tenancy", + "traits": { + "aws.protocols#ec2QueryName": "InstanceTenancy", + "smithy.api#documentation": "

The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy\n of dedicated is applied to instances that run in a VPC on single-tenant hardware\n (i.e., Dedicated Instances).

\n

\n Important: The host value cannot be used with this parameter. Use the default or dedicated values only.

\n

Default: default\n

", + "smithy.api#xmlName": "instanceTenancy" + } + }, + "OfferingType": { + "target": "com.amazonaws.ec2#OfferingTypeValues", + "traits": { + "aws.protocols#ec2QueryName": "OfferingType", + "smithy.api#documentation": "

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API\n\t\t\tversion, you only have access to the Medium Utilization Reserved Instance\n\t\t\toffering type.

", + "smithy.api#xmlName": "offeringType" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to retrieve the next page of results.

", + "smithy.api#xmlName": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "MaxResults", + "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining\n\t\t\tresults of the initial request can be seen by sending another request with the returned\n\t\t\t\tNextToken value. The maximum is 100.

\n

Default: 100

", + "smithy.api#xmlName": "maxResults" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DescribeReservedInstancesOfferings.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeReservedInstancesOfferingsResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when\n\t\t\tthere are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "ReservedInstancesOfferings": { + "target": "com.amazonaws.ec2#ReservedInstancesOfferingList", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstancesOfferingsSet", + "smithy.api#documentation": "

A list of Reserved Instances offerings.

", + "smithy.api#xmlName": "reservedInstancesOfferingsSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of DescribeReservedInstancesOfferings.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeReservedInstancesRequest": { + "type": "structure", + "members": { + "OfferingClass": { + "target": "com.amazonaws.ec2#OfferingClassType", + "traits": { + "smithy.api#documentation": "

Describes whether the Reserved Instance is Standard or Convertible.

" + } + }, + "ReservedInstancesIds": { + "target": "com.amazonaws.ec2#ReservedInstancesIdStringList", + "traits": { + "smithy.api#documentation": "

One or more Reserved Instance IDs.

\n

Default: Describes all your Reserved Instances, or only those otherwise specified.

", + "smithy.api#xmlName": "ReservedInstancesId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "OfferingType": { + "target": "com.amazonaws.ec2#OfferingTypeValues", + "traits": { + "aws.protocols#ec2QueryName": "OfferingType", + "smithy.api#documentation": "

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API\n\t\t\tversion, you only have access to the Medium Utilization Reserved Instance\n\t\t\toffering type.

", + "smithy.api#xmlName": "offeringType" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DescribeReservedInstances.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeReservedInstancesResult": { + "type": "structure", + "members": { + "ReservedInstances": { + "target": "com.amazonaws.ec2#ReservedInstancesList", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstancesSet", + "smithy.api#documentation": "

A list of Reserved Instances.

", + "smithy.api#xmlName": "reservedInstancesSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output for DescribeReservedInstances.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeRouteTables": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeRouteTablesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeRouteTablesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes your route tables. The default is to describe all your route tables. \n Alternatively, you can specify specific route table IDs or filter the results to\n include only the route tables that match specific criteria.

\n

Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations.

\n

For more information, see Route tables in the\n\t\t\t\tAmazon VPC User Guide.

", + "smithy.api#examples": [ + { + "title": "To describe a route table", + "documentation": "This example describes the specified route table.", + "input": { + "RouteTableIds": [ + "rtb-1f382e7d" + ] + }, + "output": { + "RouteTables": [ + { + "Associations": [ + { + "RouteTableAssociationId": "rtbassoc-d8ccddba", + "Main": true, + "RouteTableId": "rtb-1f382e7d" + } + ], + "RouteTableId": "rtb-1f382e7d", + "VpcId": "vpc-a01106c2", + "PropagatingVgws": [], + "Tags": [], + "Routes": [ + { + "GatewayId": "local", + "DestinationCidrBlock": "10.0.0.0/16", + "State": "active" + } + ] + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "RouteTables", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeRouteTablesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 100 + } + } + }, + "com.amazonaws.ec2#DescribeRouteTablesRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeRouteTablesMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "RouteTableIds": { + "target": "com.amazonaws.ec2#RouteTableIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the route tables.

", + "smithy.api#xmlName": "RouteTableId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeRouteTablesResult": { + "type": "structure", + "members": { + "RouteTables": { + "target": "com.amazonaws.ec2#RouteTableList", + "traits": { + "aws.protocols#ec2QueryName": "RouteTableSet", + "smithy.api#documentation": "

Information about the route tables.

", + "smithy.api#xmlName": "routeTableSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of DescribeRouteTables.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeScheduledInstanceAvailability": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeScheduledInstanceAvailabilityRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeScheduledInstanceAvailabilityResult" + }, + "traits": { + "smithy.api#documentation": "

Finds available schedules that meet the specified criteria.

\n

You can search for an available schedule no more than 3 months in advance. You must meet the minimum required duration of 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.

\n

After you find a schedule that meets your needs, call PurchaseScheduledInstances\n to purchase Scheduled Instances with that schedule.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ScheduledInstanceAvailabilitySet", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeScheduledInstanceAvailabilityMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 300 + } + } + }, + "com.amazonaws.ec2#DescribeScheduledInstanceAvailabilityRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "FirstSlotStartTimeRange": { + "target": "com.amazonaws.ec2#SlotDateTimeRangeRequest", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The time period for the first schedule to start.

", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeScheduledInstanceAvailabilityMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in a single call. \n This value can be between 5 and 300. The default value is 300.\n To retrieve the remaining results, make another call with the returned\n NextToken value.

" + } + }, + "MaxSlotDurationInHours": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum available duration, in hours. This value must be greater than MinSlotDurationInHours\n and less than 1,720.

" + } + }, + "MinSlotDurationInHours": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The minimum available duration, in hours. The minimum required duration is 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results.

" + } + }, + "Recurrence": { + "target": "com.amazonaws.ec2#ScheduledInstanceRecurrenceRequest", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The schedule recurrence.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DescribeScheduledInstanceAvailability.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeScheduledInstanceAvailabilityResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "ScheduledInstanceAvailabilitySet": { + "target": "com.amazonaws.ec2#ScheduledInstanceAvailabilitySet", + "traits": { + "aws.protocols#ec2QueryName": "ScheduledInstanceAvailabilitySet", + "smithy.api#documentation": "

Information about the available Scheduled Instances.

", + "smithy.api#xmlName": "scheduledInstanceAvailabilitySet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of DescribeScheduledInstanceAvailability.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeScheduledInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeScheduledInstancesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeScheduledInstancesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified Scheduled Instances or all your Scheduled Instances.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ScheduledInstanceSet", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeScheduledInstancesRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in a single call. \n This value can be between 5 and 300. The default value is 100.\n To retrieve the remaining results, make another call with the returned\n NextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results.

" + } + }, + "ScheduledInstanceIds": { + "target": "com.amazonaws.ec2#ScheduledInstanceIdRequestSet", + "traits": { + "smithy.api#documentation": "

The Scheduled Instance IDs.

", + "smithy.api#xmlName": "ScheduledInstanceId" + } + }, + "SlotStartTimeRange": { + "target": "com.amazonaws.ec2#SlotStartTimeRangeRequest", + "traits": { + "smithy.api#documentation": "

The time period for the first schedule to start.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DescribeScheduledInstances.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeScheduledInstancesResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "ScheduledInstanceSet": { + "target": "com.amazonaws.ec2#ScheduledInstanceSet", + "traits": { + "aws.protocols#ec2QueryName": "ScheduledInstanceSet", + "smithy.api#documentation": "

Information about the Scheduled Instances.

", + "smithy.api#xmlName": "scheduledInstanceSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of DescribeScheduledInstances.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeSecurityGroupReferences": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeSecurityGroupReferencesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeSecurityGroupReferencesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the VPCs on the other side of a VPC peering or Transit Gateway connection that are referencing the security groups you've specified in this request.

", + "smithy.api#examples": [ + { + "title": "To describe security group references", + "documentation": "This example describes the security group references for the specified security group.", + "input": { + "GroupId": [ + "sg-903004f8" + ] + }, + "output": { + "SecurityGroupReferenceSet": [ + { + "ReferencingVpcId": "vpc-1a2b3c4d", + "GroupId": "sg-903004f8", + "VpcPeeringConnectionId": "pcx-b04deed9" + } + ] + } + } + ] + } + }, + "com.amazonaws.ec2#DescribeSecurityGroupReferencesRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "GroupId": { + "target": "com.amazonaws.ec2#GroupIds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the security groups in your account.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeSecurityGroupReferencesResult": { + "type": "structure", + "members": { + "SecurityGroupReferenceSet": { + "target": "com.amazonaws.ec2#SecurityGroupReferences", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroupReferenceSet", + "smithy.api#documentation": "

Information about the VPCs with the referencing security groups.

", + "smithy.api#xmlName": "securityGroupReferenceSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeSecurityGroupRules": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeSecurityGroupRulesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeSecurityGroupRulesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more of your security group rules.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "SecurityGroupRules", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeSecurityGroupRulesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeSecurityGroupRulesRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "SecurityGroupRuleIds": { + "target": "com.amazonaws.ec2#SecurityGroupRuleIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the security group rules.

", + "smithy.api#xmlName": "SecurityGroupRuleId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request.\n Pagination continues from the end of the items returned by the previous request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeSecurityGroupRulesMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request. To get the next page of \n items, make another request with the token returned in the output. This value\n can be between 5 and 1000. If this parameter is not specified, then all items are\n returned. For more information, see Pagination.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeSecurityGroupRulesResult": { + "type": "structure", + "members": { + "SecurityGroupRules": { + "target": "com.amazonaws.ec2#SecurityGroupRuleList", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroupRuleSet", + "smithy.api#documentation": "

Information about security group rules.

", + "smithy.api#xmlName": "securityGroupRuleSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. \n This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeSecurityGroupVpcAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeSecurityGroupVpcAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeSecurityGroupVpcAssociationsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes security group VPC associations made with AssociateSecurityGroupVpc.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "SecurityGroupVpcAssociations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeSecurityGroupVpcAssociationsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeSecurityGroupVpcAssociationsRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

Security group VPC association filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeSecurityGroupVpcAssociationsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeSecurityGroupVpcAssociationsResult": { + "type": "structure", + "members": { + "SecurityGroupVpcAssociations": { + "target": "com.amazonaws.ec2#SecurityGroupVpcAssociationList", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroupVpcAssociationSet", + "smithy.api#documentation": "

The security group VPC associations.

", + "smithy.api#xmlName": "securityGroupVpcAssociationSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeSecurityGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeSecurityGroupsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeSecurityGroupsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified security groups or all of your security groups.

", + "smithy.api#examples": [ + { + "title": "To describe a security group", + "documentation": "This example describes the specified security group.", + "input": { + "GroupIds": [ + "sg-903004f8" + ] + }, + "output": {} + }, + { + "title": "To describe a tagged security group", + "documentation": "This example describes the security groups that include the specified tag (Purpose=test).", + "input": { + "Filters": [ + { + "Name": "tag:Purpose", + "Values": [ + "test" + ] + } + ] + }, + "output": {} + } + ], + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "SecurityGroups", + "pageSize": "MaxResults" + }, + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "SecurityGroupExists": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "length(SecurityGroups[].GroupId) > `0`", + "expected": "true", + "comparator": "booleanEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "errorType": "InvalidGroup.NotFound" + } + } + ], + "minDelay": 5 + } + } + } + }, + "com.amazonaws.ec2#DescribeSecurityGroupsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeSecurityGroupsRequest": { + "type": "structure", + "members": { + "GroupIds": { + "target": "com.amazonaws.ec2#GroupIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the security groups. Required for security groups in a nondefault VPC.

\n

Default: Describes all of your security groups.

", + "smithy.api#xmlName": "GroupId" + } + }, + "GroupNames": { + "target": "com.amazonaws.ec2#GroupNameStringList", + "traits": { + "smithy.api#documentation": "

[Default VPC] The names of the security groups. You can specify either\n\t\t\tthe security group name or the security group ID.

\n

Default: Describes all of your security groups.

", + "smithy.api#xmlName": "GroupName" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request.\n Pagination continues from the end of the items returned by the previous request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeSecurityGroupsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request. To get the next page of items,\n make another request with the token returned in the output. This value can be between 5 and 1000. \n If this parameter is not specified, then all items are returned. For more information, see \n Pagination.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.

\n ", + "smithy.api#xmlName": "Filter" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeSecurityGroupsResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.ec2#SecurityGroupList", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroupInfo", + "smithy.api#documentation": "

Information about the security groups.

", + "smithy.api#xmlName": "securityGroupInfo" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeSnapshotAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeSnapshotAttributeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeSnapshotAttributeResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified attribute of the specified snapshot. You can specify only one\n attribute at a time.

\n

For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon EBS User Guide.

", + "smithy.api#examples": [ + { + "title": "To describe snapshot attributes", + "documentation": "This example describes the ``createVolumePermission`` attribute on a snapshot with the snapshot ID of ``snap-066877671789bd71b``.", + "input": { + "SnapshotId": "snap-066877671789bd71b", + "Attribute": "createVolumePermission" + }, + "output": { + "SnapshotId": "snap-066877671789bd71b", + "CreateVolumePermissions": [] + } + } + ] + } + }, + "com.amazonaws.ec2#DescribeSnapshotAttributeRequest": { + "type": "structure", + "members": { + "Attribute": { + "target": "com.amazonaws.ec2#SnapshotAttributeName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The snapshot attribute you would like to view.

", + "smithy.api#required": {} + } + }, + "SnapshotId": { + "target": "com.amazonaws.ec2#SnapshotId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the EBS snapshot.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeSnapshotAttributeResult": { + "type": "structure", + "members": { + "ProductCodes": { + "target": "com.amazonaws.ec2#ProductCodeList", + "traits": { + "aws.protocols#ec2QueryName": "ProductCodes", + "smithy.api#documentation": "

The product codes.

", + "smithy.api#xmlName": "productCodes" + } + }, + "SnapshotId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The ID of the EBS snapshot.

", + "smithy.api#xmlName": "snapshotId" + } + }, + "CreateVolumePermissions": { + "target": "com.amazonaws.ec2#CreateVolumePermissionList", + "traits": { + "aws.protocols#ec2QueryName": "CreateVolumePermission", + "smithy.api#documentation": "

The users and groups that have the permissions for creating volumes from the\n snapshot.

", + "smithy.api#xmlName": "createVolumePermission" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeSnapshotTierStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeSnapshotTierStatusRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeSnapshotTierStatusResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the storage tier status of one or more Amazon EBS snapshots.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "SnapshotTierStatuses", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeSnapshotTierStatusMaxResults": { + "type": "integer" + }, + "com.amazonaws.ec2#DescribeSnapshotTierStatusRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request.\n Pagination continues from the end of the items returned by the previous request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeSnapshotTierStatusMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output. \n\tFor more information, see Pagination.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeSnapshotTierStatusResult": { + "type": "structure", + "members": { + "SnapshotTierStatuses": { + "target": "com.amazonaws.ec2#snapshotTierStatusSet", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotTierStatusSet", + "smithy.api#documentation": "

Information about the snapshot's storage tier.

", + "smithy.api#xmlName": "snapshotTierStatusSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. \n This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeSnapshots": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeSnapshotsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeSnapshotsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified EBS snapshots available to you or all of the EBS snapshots\n available to you.

\n

The snapshots available to you include public snapshots, private snapshots that you own,\n and private snapshots owned by other Amazon Web Services accounts for which you have explicit create volume\n permissions.

\n

The create volume permissions fall into the following categories:

\n \n

The list of snapshots returned can be filtered by specifying snapshot IDs, snapshot\n owners, or Amazon Web Services accounts with create volume permissions. If no options are specified, \n Amazon EC2 returns all snapshots for which you have create volume permissions.

\n

If you specify one or more snapshot IDs, only snapshots that have the specified IDs are\n returned. If you specify an invalid snapshot ID, an error is returned. If you specify a\n snapshot ID for which you do not have access, it is not included in the returned\n results.

\n

If you specify one or more snapshot owners using the OwnerIds option, only\n snapshots from the specified owners and for which you have access are returned. The results\n can include the Amazon Web Services account IDs of the specified owners, amazon for snapshots\n owned by Amazon, or self for snapshots that you own.

\n

If you specify a list of restorable users, only snapshots with create snapshot permissions\n for those users are returned. You can specify Amazon Web Services account IDs (if you own the snapshots),\n self for snapshots for which you own or have explicit permissions, or\n all for public snapshots.

\n

If you are describing a long list of snapshots, we recommend that you paginate the output to make the\n list more manageable. For more information, see Pagination.

\n

To get the state of fast snapshot restores for a snapshot, use DescribeFastSnapshotRestores.

\n

For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon EBS User Guide.

\n \n

We strongly recommend using only paginated requests. Unpaginated requests are\n susceptible to throttling and timeouts.

\n ", + "smithy.api#examples": [ + { + "title": "To describe a snapshot", + "documentation": "This example describes a snapshot with the snapshot ID of ``snap-1234567890abcdef0``.", + "input": { + "SnapshotIds": [ + "snap-1234567890abcdef0" + ] + }, + "output": { + "Snapshots": [ + { + "Description": "This is my snapshot.", + "VolumeId": "vol-049df61146c4d7901", + "State": "completed", + "VolumeSize": 8, + "Progress": "100%", + "StartTime": "2014-02-28T21:28:32.000Z", + "SnapshotId": "snap-1234567890abcdef0", + "OwnerId": "012345678910" + } + ], + "NextToken": "" + } + }, + { + "title": "To describe snapshots using filters", + "documentation": "This example describes all snapshots owned by the ID 012345678910 that are in the ``pending`` status.", + "input": { + "OwnerIds": [ + "012345678910" + ], + "Filters": [ + { + "Values": [ + "pending" + ], + "Name": "status" + } + ] + }, + "output": { + "Snapshots": [ + { + "Description": "This is my copied snapshot.", + "VolumeId": "vol-1234567890abcdef0", + "State": "pending", + "VolumeSize": 8, + "Progress": "87%", + "StartTime": "2014-02-28T21:37:27.000Z", + "SnapshotId": "snap-066877671789bd71b", + "OwnerId": "012345678910" + } + ], + "NextToken": "" + } + } + ], + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Snapshots", + "pageSize": "MaxResults" + }, + "smithy.waiters#waitable": { + "SnapshotCompleted": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "Snapshots[].State", + "expected": "completed", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Snapshots[].State", + "expected": "error", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 15 + } + } + } + }, + "com.amazonaws.ec2#DescribeSnapshotsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output. \n\tFor more information, see Pagination.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request.\n Pagination continues from the end of the items returned by the previous request.

" + } + }, + "OwnerIds": { + "target": "com.amazonaws.ec2#OwnerStringList", + "traits": { + "smithy.api#documentation": "

Scopes the results to snapshots with the specified owners. You can specify a combination of\n Amazon Web Services account IDs, self, and amazon.

", + "smithy.api#xmlName": "Owner" + } + }, + "RestorableByUserIds": { + "target": "com.amazonaws.ec2#RestorableByStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the Amazon Web Services accounts that can create volumes from the snapshot.

", + "smithy.api#xmlName": "RestorableBy" + } + }, + "SnapshotIds": { + "target": "com.amazonaws.ec2#SnapshotIdStringList", + "traits": { + "smithy.api#documentation": "

The snapshot IDs.

\n

Default: Describes the snapshots for which you have create volume permissions.

", + "smithy.api#xmlName": "SnapshotId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeSnapshotsResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. \n This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "Snapshots": { + "target": "com.amazonaws.ec2#SnapshotList", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotSet", + "smithy.api#documentation": "

Information about the snapshots.

", + "smithy.api#xmlName": "snapshotSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeSpotDatafeedSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeSpotDatafeedSubscriptionRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeSpotDatafeedSubscriptionResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the data feed for Spot Instances. For more information, see Spot\n Instance data feed in the Amazon EC2 User Guide.

", + "smithy.api#examples": [ + { + "title": "To describe the datafeed for your AWS account", + "documentation": "This example describes the Spot Instance datafeed subscription for your AWS account.", + "output": { + "SpotDatafeedSubscription": { + "OwnerId": "123456789012", + "Prefix": "spotdata", + "Bucket": "my-s3-bucket", + "State": "Active" + } + } + } + ] + } + }, + "com.amazonaws.ec2#DescribeSpotDatafeedSubscriptionRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DescribeSpotDatafeedSubscription.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeSpotDatafeedSubscriptionResult": { + "type": "structure", + "members": { + "SpotDatafeedSubscription": { + "target": "com.amazonaws.ec2#SpotDatafeedSubscription", + "traits": { + "aws.protocols#ec2QueryName": "SpotDatafeedSubscription", + "smithy.api#documentation": "

The Spot Instance data feed subscription.

", + "smithy.api#xmlName": "spotDatafeedSubscription" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of DescribeSpotDatafeedSubscription.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeSpotFleetInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeSpotFleetInstancesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeSpotFleetInstancesResponse" + }, + "traits": { + "smithy.api#documentation": "

Describes the running instances for the specified Spot Fleet.

", + "smithy.api#examples": [ + { + "title": "To describe the Spot Instances associated with a Spot fleet", + "documentation": "This example lists the Spot Instances associated with the specified Spot fleet.", + "input": { + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" + }, + "output": { + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", + "ActiveInstances": [ + { + "InstanceId": "i-1234567890abcdef0", + "InstanceType": "m3.medium", + "SpotInstanceRequestId": "sir-08b93456" + } + ] + } + } + ] + } + }, + "com.amazonaws.ec2#DescribeSpotFleetInstancesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeSpotFleetInstancesRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "SpotFleetRequestId": { + "target": "com.amazonaws.ec2#SpotFleetRequestId", + "traits": { + "aws.protocols#ec2QueryName": "SpotFleetRequestId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Spot Fleet request.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "spotFleetRequestId" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeSpotFleetInstancesMaxResults", + "traits": { + "aws.protocols#ec2QueryName": "MaxResults", + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

", + "smithy.api#xmlName": "maxResults" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DescribeSpotFleetInstances.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeSpotFleetInstancesResponse": { + "type": "structure", + "members": { + "ActiveInstances": { + "target": "com.amazonaws.ec2#ActiveInstanceSet", + "traits": { + "aws.protocols#ec2QueryName": "ActiveInstanceSet", + "smithy.api#documentation": "

The running instances. This list is refreshed periodically and might be out of\n date.

", + "smithy.api#xmlName": "activeInstanceSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "SpotFleetRequestId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SpotFleetRequestId", + "smithy.api#documentation": "

The ID of the Spot Fleet request.

", + "smithy.api#xmlName": "spotFleetRequestId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of DescribeSpotFleetInstances.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeSpotFleetRequestHistory": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeSpotFleetRequestHistoryRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeSpotFleetRequestHistoryResponse" + }, + "traits": { + "smithy.api#documentation": "

Describes the events for the specified Spot Fleet request during the specified\n time.

\n

Spot Fleet events are delayed by up to 30 seconds before they can be described. This\n ensures that you can query by the last evaluated time and not miss a recorded event.\n Spot Fleet events are available for 48 hours.

\n

For more information, see Monitor fleet events using Amazon\n EventBridge in the Amazon EC2 User Guide.

", + "smithy.api#examples": [ + { + "title": "To describe Spot fleet history", + "documentation": "This example returns the history for the specified Spot fleet starting at the specified time.", + "input": { + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", + "StartTime": "2015-05-26T00:00:00Z" + }, + "output": { + "HistoryRecords": [ + { + "Timestamp": "2015-05-26T23:17:20.697Z", + "EventInformation": { + "EventSubType": "submitted" + }, + "EventType": "fleetRequestChange" + }, + { + "Timestamp": "2015-05-26T23:17:20.873Z", + "EventInformation": { + "EventSubType": "active" + }, + "EventType": "fleetRequestChange" + }, + { + "Timestamp": "2015-05-26T23:21:21.712Z", + "EventInformation": { + "InstanceId": "i-1234567890abcdef0", + "EventSubType": "launched" + }, + "EventType": "instanceChange" + }, + { + "Timestamp": "2015-05-26T23:21:21.816Z", + "EventInformation": { + "InstanceId": "i-1234567890abcdef1", + "EventSubType": "launched" + }, + "EventType": "instanceChange" + } + ], + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", + "StartTime": "2015-05-26T00:00:00Z", + "NextToken": "CpHNsscimcV5oH7bSbub03CI2Qms5+ypNpNm+53MNlR0YcXAkp0xFlfKf91yVxSExmbtma3awYxMFzNA663ZskT0AHtJ6TCb2Z8bQC2EnZgyELbymtWPfpZ1ZbauVg+P+TfGlWxWWB/Vr5dk5d4LfdgA/DRAHUrYgxzrEXAMPLE=" + } + } + ] + } + }, + "com.amazonaws.ec2#DescribeSpotFleetRequestHistoryMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeSpotFleetRequestHistoryRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "SpotFleetRequestId": { + "target": "com.amazonaws.ec2#SpotFleetRequestId", + "traits": { + "aws.protocols#ec2QueryName": "SpotFleetRequestId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Spot Fleet request.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "spotFleetRequestId" + } + }, + "EventType": { + "target": "com.amazonaws.ec2#EventType", + "traits": { + "aws.protocols#ec2QueryName": "EventType", + "smithy.api#documentation": "

The type of events to describe. By default, all events are described.

", + "smithy.api#xmlName": "eventType" + } + }, + "StartTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "StartTime", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The starting date and time for the events, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).

", + "smithy.api#required": {}, + "smithy.api#xmlName": "startTime" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeSpotFleetRequestHistoryMaxResults", + "traits": { + "aws.protocols#ec2QueryName": "MaxResults", + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

", + "smithy.api#xmlName": "maxResults" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DescribeSpotFleetRequestHistory.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeSpotFleetRequestHistoryResponse": { + "type": "structure", + "members": { + "HistoryRecords": { + "target": "com.amazonaws.ec2#HistoryRecords", + "traits": { + "aws.protocols#ec2QueryName": "HistoryRecordSet", + "smithy.api#documentation": "

Information about the events in the history of the Spot Fleet request.

", + "smithy.api#xmlName": "historyRecordSet" + } + }, + "LastEvaluatedTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "LastEvaluatedTime", + "smithy.api#documentation": "

The last date and time for the events, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).\n All records up to this time were retrieved.

\n

If nextToken indicates that there are more items, this value is not\n present.

", + "smithy.api#xmlName": "lastEvaluatedTime" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "SpotFleetRequestId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SpotFleetRequestId", + "smithy.api#documentation": "

The ID of the Spot Fleet request.

", + "smithy.api#xmlName": "spotFleetRequestId" + } + }, + "StartTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "StartTime", + "smithy.api#documentation": "

The starting date and time for the events, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).

", + "smithy.api#xmlName": "startTime" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of DescribeSpotFleetRequestHistory.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeSpotFleetRequests": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeSpotFleetRequestsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeSpotFleetRequestsResponse" + }, + "traits": { + "smithy.api#documentation": "

Describes your Spot Fleet requests.

\n

Spot Fleet requests are deleted 48 hours after they are canceled and their instances\n are terminated.

", + "smithy.api#examples": [ + { + "title": "To describe a Spot fleet request", + "documentation": "This example describes the specified Spot fleet request.", + "input": { + "SpotFleetRequestIds": [ + "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" + ] + }, + "output": { + "SpotFleetRequestConfigs": [ + { + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", + "SpotFleetRequestConfig": { + "TargetCapacity": 20, + "LaunchSpecifications": [ + { + "EbsOptimized": false, + "NetworkInterfaces": [ + { + "SubnetId": "subnet-a61dafcf", + "DeviceIndex": 0, + "DeleteOnTermination": false, + "AssociatePublicIpAddress": true, + "SecondaryPrivateIpAddressCount": 0 + } + ], + "InstanceType": "cc2.8xlarge", + "ImageId": "ami-1a2b3c4d" + }, + { + "EbsOptimized": false, + "NetworkInterfaces": [ + { + "SubnetId": "subnet-a61dafcf", + "DeviceIndex": 0, + "DeleteOnTermination": false, + "AssociatePublicIpAddress": true, + "SecondaryPrivateIpAddressCount": 0 + } + ], + "InstanceType": "r3.8xlarge", + "ImageId": "ami-1a2b3c4d" + } + ], + "SpotPrice": "0.05", + "IamFleetRole": "arn:aws:iam::123456789012:role/my-spot-fleet-role" + }, + "SpotFleetRequestState": "active" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "SpotFleetRequestConfigs", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeSpotFleetRequestsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "SpotFleetRequestIds": { + "target": "com.amazonaws.ec2#SpotFleetRequestIdList", + "traits": { + "aws.protocols#ec2QueryName": "SpotFleetRequestId", + "smithy.api#documentation": "

The IDs of the Spot Fleet requests.

", + "smithy.api#xmlName": "spotFleetRequestId" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "MaxResults", + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

", + "smithy.api#xmlName": "maxResults" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DescribeSpotFleetRequests.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeSpotFleetRequestsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "SpotFleetRequestConfigs": { + "target": "com.amazonaws.ec2#SpotFleetRequestConfigSet", + "traits": { + "aws.protocols#ec2QueryName": "SpotFleetRequestConfigSet", + "smithy.api#documentation": "

Information about the configuration of your Spot Fleet.

", + "smithy.api#xmlName": "spotFleetRequestConfigSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of DescribeSpotFleetRequests.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeSpotInstanceRequests": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeSpotInstanceRequestsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeSpotInstanceRequestsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified Spot Instance requests.

\n

You can use DescribeSpotInstanceRequests to find a running Spot Instance by\n examining the response. If the status of the Spot Instance is fulfilled, the\n instance ID appears in the response and contains the identifier of the instance.\n Alternatively, you can use DescribeInstances\n with a filter to look for instances where the instance lifecycle is\n spot.

\n

We recommend that you set MaxResults to a value between 5 and 1000 to\n limit the number of items returned. This paginates the output, which makes the list\n more manageable and returns the items faster. If the list of items exceeds your\n MaxResults value, then that number of items is returned along with a\n NextToken value that can be passed to a subsequent\n DescribeSpotInstanceRequests request to retrieve the remaining\n items.

\n

Spot Instance requests are deleted four hours after they are canceled and their instances are\n terminated.

", + "smithy.api#examples": [ + { + "title": "To describe a Spot Instance request", + "documentation": "This example describes the specified Spot Instance request.", + "input": { + "SpotInstanceRequestIds": [ + "sir-08b93456" + ] + }, + "output": { + "SpotInstanceRequests": [ + { + "Status": { + "UpdateTime": "2014-04-30T18:16:21.000Z", + "Code": "fulfilled", + "Message": "Your Spot request is fulfilled." + }, + "ProductDescription": "Linux/UNIX", + "InstanceId": "i-1234567890abcdef0", + "SpotInstanceRequestId": "sir-08b93456", + "State": "active", + "LaunchedAvailabilityZone": "us-west-1b", + "LaunchSpecification": { + "ImageId": "ami-7aba833f", + "KeyName": "my-key-pair", + "BlockDeviceMappings": [ + { + "DeviceName": "/dev/sda1", + "Ebs": { + "DeleteOnTermination": true, + "VolumeType": "standard", + "VolumeSize": 8 + } + } + ], + "EbsOptimized": false, + "SecurityGroups": [ + { + "GroupName": "my-security-group", + "GroupId": "sg-e38f24a7" + } + ], + "InstanceType": "m1.small" + }, + "Type": "one-time", + "CreateTime": "2014-04-30T18:14:55.000Z", + "SpotPrice": "0.010000" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "SpotInstanceRequests", + "pageSize": "MaxResults" + }, + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "SpotInstanceRequestFulfilled": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "SpotInstanceRequests[].Status.Code", + "expected": "fulfilled", + "comparator": "allStringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "output": { + "path": "SpotInstanceRequests[].Status.Code", + "expected": "request-canceled-and-instance-running", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "SpotInstanceRequests[].Status.Code", + "expected": "schedule-expired", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "SpotInstanceRequests[].Status.Code", + "expected": "canceled-before-fulfillment", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "SpotInstanceRequests[].Status.Code", + "expected": "bad-parameters", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "SpotInstanceRequests[].Status.Code", + "expected": "system-error", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "errorType": "InvalidSpotInstanceRequestID.NotFound" + } + } + ], + "minDelay": 15 + } + } + } + }, + "com.amazonaws.ec2#DescribeSpotInstanceRequestsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "SpotInstanceRequestIds": { + "target": "com.amazonaws.ec2#SpotInstanceRequestIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the Spot Instance requests.

", + "smithy.api#xmlName": "SpotInstanceRequestId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DescribeSpotInstanceRequests.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeSpotInstanceRequestsResult": { + "type": "structure", + "members": { + "SpotInstanceRequests": { + "target": "com.amazonaws.ec2#SpotInstanceRequestList", + "traits": { + "aws.protocols#ec2QueryName": "SpotInstanceRequestSet", + "smithy.api#documentation": "

The Spot Instance requests.

", + "smithy.api#xmlName": "spotInstanceRequestSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of DescribeSpotInstanceRequests.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeSpotPriceHistory": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeSpotPriceHistoryRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeSpotPriceHistoryResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the Spot price history. For more information, see Spot Instance pricing history in the\n Amazon EC2 User Guide.

\n

When you specify a start and end time, the operation returns the prices of the\n instance types within that time range. It also returns the last price change before the\n start time, which is the effective price as of the start time.

", + "smithy.api#examples": [ + { + "title": "To describe Spot price history for Linux/UNIX (Amazon VPC)", + "documentation": "This example returns the Spot Price history for m1.xlarge, Linux/UNIX (Amazon VPC) instances for a particular day in January.", + "input": { + "StartTime": "2014-01-06T07:08:09.05Z", + "EndTime": "2014-01-06T08:09:10.05Z", + "InstanceTypes": [ + "m1.xlarge" + ], + "ProductDescriptions": [ + "Linux/UNIX (Amazon VPC)" + ] + }, + "output": { + "SpotPriceHistory": [ + { + "Timestamp": "2014-01-06T04:32:53.000Z", + "ProductDescription": "Linux/UNIX (Amazon VPC)", + "InstanceType": "m1.xlarge", + "SpotPrice": "0.080000", + "AvailabilityZone": "us-west-1a" + }, + { + "Timestamp": "2014-01-05T11:28:26.000Z", + "ProductDescription": "Linux/UNIX (Amazon VPC)", + "InstanceType": "m1.xlarge", + "SpotPrice": "0.080000", + "AvailabilityZone": "us-west-1c" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "SpotPriceHistory", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeSpotPriceHistoryRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "StartTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "StartTime", + "smithy.api#documentation": "

The date and time, up to the past 90 days, from which to start retrieving the price\n history data, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).

", + "smithy.api#xmlName": "startTime" + } + }, + "EndTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "EndTime", + "smithy.api#documentation": "

The date and time, up to the current date, from which to stop retrieving the price\n history data, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).

", + "smithy.api#xmlName": "endTime" + } + }, + "InstanceTypes": { + "target": "com.amazonaws.ec2#InstanceTypeList", + "traits": { + "smithy.api#documentation": "

Filters the results by the specified instance types.

", + "smithy.api#xmlName": "InstanceType" + } + }, + "ProductDescriptions": { + "target": "com.amazonaws.ec2#ProductDescriptionList", + "traits": { + "smithy.api#documentation": "

Filters the results by the specified basic product descriptions.

", + "smithy.api#xmlName": "ProductDescription" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

Filters the results by the specified Availability Zone.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "MaxResults", + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

", + "smithy.api#xmlName": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DescribeSpotPriceHistory.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeSpotPriceHistoryResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is\n an empty string (\"\") or null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "SpotPriceHistory": { + "target": "com.amazonaws.ec2#SpotPriceHistoryList", + "traits": { + "aws.protocols#ec2QueryName": "SpotPriceHistorySet", + "smithy.api#documentation": "

The historical Spot prices.

", + "smithy.api#xmlName": "spotPriceHistorySet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of DescribeSpotPriceHistory.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeStaleSecurityGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeStaleSecurityGroupsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeStaleSecurityGroupsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the stale security group rules for security groups referenced across a VPC\n peering connection, transit gateway connection, or with a security group VPC\n association. Rules are stale when they reference a deleted security group. Rules can\n also be stale if they reference a security group in a peer VPC for which the VPC peering\n connection has been deleted, across a transit gateway where the transit gateway has been\n deleted (or the transit\n gateway security group referencing feature has been disabled), or if a\n security group VPC association has been disassociated.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "StaleSecurityGroupSet", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeStaleSecurityGroupsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 255 + } + } + }, + "com.amazonaws.ec2#DescribeStaleSecurityGroupsNextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.ec2#DescribeStaleSecurityGroupsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeStaleSecurityGroupsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request. To get the next page of items,\n make another request with the token returned in the output. For more information, \n see Pagination.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#DescribeStaleSecurityGroupsNextToken", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeStaleSecurityGroupsResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "StaleSecurityGroupSet": { + "target": "com.amazonaws.ec2#StaleSecurityGroupSet", + "traits": { + "aws.protocols#ec2QueryName": "StaleSecurityGroupSet", + "smithy.api#documentation": "

Information about the stale security groups.

", + "smithy.api#xmlName": "staleSecurityGroupSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeStoreImageTasks": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeStoreImageTasksRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeStoreImageTasksResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the progress of the AMI store tasks. You can describe the store tasks for\n specified AMIs. If you don't specify the AMIs, you get a paginated list of store tasks from\n the last 31 days.

\n

For each AMI task, the response indicates if the task is InProgress,\n Completed, or Failed. For tasks InProgress, the\n response shows the estimated progress as a percentage.

\n

Tasks are listed in reverse chronological order. Currently, only tasks from the past 31\n days can be viewed.

\n

To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the\n Amazon EC2 User Guide.

\n

For more information, see Store and restore an AMI using\n Amazon S3 in the Amazon EC2 User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "StoreImageTaskResults", + "pageSize": "MaxResults" + }, + "smithy.waiters#waitable": { + "StoreImageTaskComplete": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "StoreImageTaskResults[].StoreTaskState", + "expected": "Completed", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "StoreImageTaskResults[].StoreTaskState", + "expected": "Failed", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "output": { + "path": "StoreImageTaskResults[].StoreTaskState", + "expected": "InProgress", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 5 + } + } + } + }, + "com.amazonaws.ec2#DescribeStoreImageTasksRequest": { + "type": "structure", + "members": { + "ImageIds": { + "target": "com.amazonaws.ec2#ImageIdList", + "traits": { + "smithy.api#documentation": "

The AMI IDs for which to show progress. Up to 20 AMI IDs can be included in a\n request.

", + "smithy.api#xmlName": "ImageId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n \n \n

When you specify the ImageIds parameter, any filters that you specify are\n ignored. To use the filters, you must remove the ImageIds parameter.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeStoreImageTasksRequestMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

\n

You cannot specify this parameter and the ImageIds parameter in the same\n call.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeStoreImageTasksRequestMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.ec2#DescribeStoreImageTasksResult": { + "type": "structure", + "members": { + "StoreImageTaskResults": { + "target": "com.amazonaws.ec2#StoreImageTaskResultSet", + "traits": { + "aws.protocols#ec2QueryName": "StoreImageTaskResultSet", + "smithy.api#documentation": "

The information about the AMI store tasks.

", + "smithy.api#xmlName": "storeImageTaskResultSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeSubnets": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeSubnetsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeSubnetsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes your subnets. The default is to describe all your subnets. \n Alternatively, you can specify specific subnet IDs or filter the results to\n include only the subnets that match specific criteria.

\n

For more information, see Subnets in the\n\t\t\t\tAmazon VPC User Guide.

", + "smithy.api#examples": [ + { + "title": "To describe the subnets for a VPC", + "documentation": "This example describes the subnets for the specified VPC.", + "input": { + "Filters": [ + { + "Name": "vpc-id", + "Values": [ + "vpc-a01106c2" + ] + } + ] + }, + "output": { + "Subnets": [ + { + "VpcId": "vpc-a01106c2", + "CidrBlock": "10.0.1.0/24", + "MapPublicIpOnLaunch": false, + "DefaultForAz": false, + "State": "available", + "AvailabilityZone": "us-east-1c", + "SubnetId": "subnet-9d4a7b6c", + "AvailableIpAddressCount": 251 + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Subnets", + "pageSize": "MaxResults" + }, + "smithy.waiters#waitable": { + "SubnetAvailable": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "Subnets[].State", + "expected": "available", + "comparator": "allStringEquals" + } + } + } + ], + "minDelay": 15 + } + } + } + }, + "com.amazonaws.ec2#DescribeSubnetsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeSubnetsRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "SubnetIds": { + "target": "com.amazonaws.ec2#SubnetIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the subnets.

\n

Default: Describes all your subnets.

", + "smithy.api#xmlName": "SubnetId" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeSubnetsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeSubnetsResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "Subnets": { + "target": "com.amazonaws.ec2#SubnetList", + "traits": { + "aws.protocols#ec2QueryName": "SubnetSet", + "smithy.api#documentation": "

Information about the subnets.

", + "smithy.api#xmlName": "subnetSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeTagsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeTagsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified tags for your EC2 resources.

\n

For more information about tags, see Tag your Amazon EC2 resources in the\n Amazon Elastic Compute Cloud User Guide.

\n \n

We strongly recommend using only paginated requests. Unpaginated requests are\n susceptible to throttling and timeouts.

\n \n \n

The order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.

\n ", + "smithy.api#examples": [ + { + "title": "To describe the tags for a single resource", + "documentation": "This example describes the tags for the specified instance.", + "input": { + "Filters": [ + { + "Name": "resource-id", + "Values": [ + "i-1234567890abcdef8" + ] + } + ] + }, + "output": { + "Tags": [ + { + "ResourceType": "instance", + "ResourceId": "i-1234567890abcdef8", + "Value": "test", + "Key": "Stack" + }, + { + "ResourceType": "instance", + "ResourceId": "i-1234567890abcdef8", + "Value": "Beta Server", + "Key": "Name" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Tags", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeTagsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "MaxResults", + "smithy.api#documentation": "

The maximum number of items to return for this request. This value can be between 5 and 1000. \n To get the next page of items, make another request with the token returned in the output.\n For more information, see Pagination.

", + "smithy.api#xmlName": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token returned from a previous paginated request.\n Pagination continues from the end of the items returned by the previous request.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeTagsResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. \n This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagDescriptionList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeTrafficMirrorFilterRules": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeTrafficMirrorFilterRulesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeTrafficMirrorFilterRulesResult" + }, + "traits": { + "smithy.api#documentation": "

Describe traffic mirror filters that determine the traffic that is mirrored.

" + } + }, + "com.amazonaws.ec2#DescribeTrafficMirrorFilterRulesRequest": { + "type": "structure", + "members": { + "TrafficMirrorFilterRuleIds": { + "target": "com.amazonaws.ec2#TrafficMirrorFilterRuleIdList", + "traits": { + "smithy.api#documentation": "

Traffic filter rule IDs.

", + "smithy.api#xmlName": "TrafficMirrorFilterRuleId" + } + }, + "TrafficMirrorFilterId": { + "target": "com.amazonaws.ec2#TrafficMirrorFilterId", + "traits": { + "smithy.api#documentation": "

Traffic filter ID.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

Traffic mirror filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#TrafficMirroringMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeTrafficMirrorFilterRulesResult": { + "type": "structure", + "members": { + "TrafficMirrorFilterRules": { + "target": "com.amazonaws.ec2#TrafficMirrorFilterRuleSet", + "traits": { + "aws.protocols#ec2QueryName": "TrafficMirrorFilterRuleSet", + "smithy.api#documentation": "

Traffic mirror rules.

", + "smithy.api#xmlName": "trafficMirrorFilterRuleSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. The value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeTrafficMirrorFilters": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeTrafficMirrorFiltersRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeTrafficMirrorFiltersResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more Traffic Mirror filters.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TrafficMirrorFilters", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeTrafficMirrorFiltersRequest": { + "type": "structure", + "members": { + "TrafficMirrorFilterIds": { + "target": "com.amazonaws.ec2#TrafficMirrorFilterIdList", + "traits": { + "smithy.api#documentation": "

The ID of the Traffic Mirror filter.

", + "smithy.api#xmlName": "TrafficMirrorFilterId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#TrafficMirroringMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeTrafficMirrorFiltersResult": { + "type": "structure", + "members": { + "TrafficMirrorFilters": { + "target": "com.amazonaws.ec2#TrafficMirrorFilterSet", + "traits": { + "aws.protocols#ec2QueryName": "TrafficMirrorFilterSet", + "smithy.api#documentation": "

Information about one or more Traffic Mirror filters.

", + "smithy.api#xmlName": "trafficMirrorFilterSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. The value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeTrafficMirrorSessions": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeTrafficMirrorSessionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeTrafficMirrorSessionsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TrafficMirrorSessions", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeTrafficMirrorSessionsRequest": { + "type": "structure", + "members": { + "TrafficMirrorSessionIds": { + "target": "com.amazonaws.ec2#TrafficMirrorSessionIdList", + "traits": { + "smithy.api#documentation": "

The ID of the Traffic Mirror session.

", + "smithy.api#xmlName": "TrafficMirrorSessionId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#TrafficMirroringMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeTrafficMirrorSessionsResult": { + "type": "structure", + "members": { + "TrafficMirrorSessions": { + "target": "com.amazonaws.ec2#TrafficMirrorSessionSet", + "traits": { + "aws.protocols#ec2QueryName": "TrafficMirrorSessionSet", + "smithy.api#documentation": "

Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.

", + "smithy.api#xmlName": "trafficMirrorSessionSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. The value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeTrafficMirrorTargets": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeTrafficMirrorTargetsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeTrafficMirrorTargetsResult" + }, + "traits": { + "smithy.api#documentation": "

Information about one or more Traffic Mirror targets.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TrafficMirrorTargets", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeTrafficMirrorTargetsRequest": { + "type": "structure", + "members": { + "TrafficMirrorTargetIds": { + "target": "com.amazonaws.ec2#TrafficMirrorTargetIdList", + "traits": { + "smithy.api#documentation": "

The ID of the Traffic Mirror targets.

", + "smithy.api#xmlName": "TrafficMirrorTargetId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#TrafficMirroringMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeTrafficMirrorTargetsResult": { + "type": "structure", + "members": { + "TrafficMirrorTargets": { + "target": "com.amazonaws.ec2#TrafficMirrorTargetSet", + "traits": { + "aws.protocols#ec2QueryName": "TrafficMirrorTargetSet", + "smithy.api#documentation": "

Information about one or more Traffic Mirror targets.

", + "smithy.api#xmlName": "trafficMirrorTargetSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. The value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayAttachments": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeTransitGatewayAttachmentsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeTransitGatewayAttachmentsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more attachments between resources and transit gateways. By default, all attachments are described.\n Alternatively, you can filter the results by attachment ID, attachment state, resource ID, or resource owner.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TransitGatewayAttachments", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayAttachmentsRequest": { + "type": "structure", + "members": { + "TransitGatewayAttachmentIds": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the attachments.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#TransitGatewayMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayAttachmentsResult": { + "type": "structure", + "members": { + "TransitGatewayAttachments": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentList", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAttachments", + "smithy.api#documentation": "

Information about the attachments.

", + "smithy.api#xmlName": "transitGatewayAttachments" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayConnectPeers": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeTransitGatewayConnectPeersRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeTransitGatewayConnectPeersResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more Connect peers.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TransitGatewayConnectPeers", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayConnectPeersRequest": { + "type": "structure", + "members": { + "TransitGatewayConnectPeerIds": { + "target": "com.amazonaws.ec2#TransitGatewayConnectPeerIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the Connect peers.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#TransitGatewayMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayConnectPeersResult": { + "type": "structure", + "members": { + "TransitGatewayConnectPeers": { + "target": "com.amazonaws.ec2#TransitGatewayConnectPeerList", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayConnectPeerSet", + "smithy.api#documentation": "

Information about the Connect peers.

", + "smithy.api#xmlName": "transitGatewayConnectPeerSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayConnects": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeTransitGatewayConnectsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeTransitGatewayConnectsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more Connect attachments.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TransitGatewayConnects", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayConnectsRequest": { + "type": "structure", + "members": { + "TransitGatewayAttachmentIds": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the attachments.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#TransitGatewayMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayConnectsResult": { + "type": "structure", + "members": { + "TransitGatewayConnects": { + "target": "com.amazonaws.ec2#TransitGatewayConnectList", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayConnectSet", + "smithy.api#documentation": "

Information about the Connect attachments.

", + "smithy.api#xmlName": "transitGatewayConnectSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayMulticastDomains": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeTransitGatewayMulticastDomainsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeTransitGatewayMulticastDomainsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more transit gateway multicast domains.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TransitGatewayMulticastDomains", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayMulticastDomainsRequest": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainIds": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainIdStringList", + "traits": { + "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#TransitGatewayMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayMulticastDomainsResult": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomains": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainList", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayMulticastDomains", + "smithy.api#documentation": "

Information about the transit gateway multicast domains.

", + "smithy.api#xmlName": "transitGatewayMulticastDomains" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayPeeringAttachments": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeTransitGatewayPeeringAttachmentsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeTransitGatewayPeeringAttachmentsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes your transit gateway peering attachments.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TransitGatewayPeeringAttachments", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayPeeringAttachmentsRequest": { + "type": "structure", + "members": { + "TransitGatewayAttachmentIds": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentIdStringList", + "traits": { + "smithy.api#documentation": "

One or more IDs of the transit gateway peering attachments.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#TransitGatewayMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayPeeringAttachmentsResult": { + "type": "structure", + "members": { + "TransitGatewayPeeringAttachments": { + "target": "com.amazonaws.ec2#TransitGatewayPeeringAttachmentList", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayPeeringAttachments", + "smithy.api#documentation": "

The transit gateway peering attachments.

", + "smithy.api#xmlName": "transitGatewayPeeringAttachments" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayPolicyTables": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeTransitGatewayPolicyTablesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeTransitGatewayPolicyTablesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more transit gateway route policy tables.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TransitGatewayPolicyTables", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayPolicyTablesRequest": { + "type": "structure", + "members": { + "TransitGatewayPolicyTableIds": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the transit gateway policy tables.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters associated with the transit gateway policy table.

", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#TransitGatewayMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayPolicyTablesResult": { + "type": "structure", + "members": { + "TransitGatewayPolicyTables": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableList", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayPolicyTables", + "smithy.api#documentation": "

Describes the transit gateway policy tables.

", + "smithy.api#xmlName": "transitGatewayPolicyTables" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token for the next page of results.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayRouteTableAnnouncements": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeTransitGatewayRouteTableAnnouncementsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeTransitGatewayRouteTableAnnouncementsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more transit gateway route table advertisements.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TransitGatewayRouteTableAnnouncements", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayRouteTableAnnouncementsRequest": { + "type": "structure", + "members": { + "TransitGatewayRouteTableAnnouncementIds": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the transit gateway route tables that are being advertised.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters associated with the transit gateway policy table.

", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#TransitGatewayMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayRouteTableAnnouncementsResult": { + "type": "structure", + "members": { + "TransitGatewayRouteTableAnnouncements": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementList", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTableAnnouncements", + "smithy.api#documentation": "

Describes the transit gateway route table announcement.

", + "smithy.api#xmlName": "transitGatewayRouteTableAnnouncements" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token for the next page of results.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayRouteTables": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeTransitGatewayRouteTablesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeTransitGatewayRouteTablesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more transit gateway route tables. By default, all transit gateway route tables are described.\n Alternatively, you can filter the results.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TransitGatewayRouteTables", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayRouteTablesRequest": { + "type": "structure", + "members": { + "TransitGatewayRouteTableIds": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the transit gateway route tables.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#TransitGatewayMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayRouteTablesResult": { + "type": "structure", + "members": { + "TransitGatewayRouteTables": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableList", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTables", + "smithy.api#documentation": "

Information about the transit gateway route tables.

", + "smithy.api#xmlName": "transitGatewayRouteTables" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayVpcAttachments": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeTransitGatewayVpcAttachmentsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeTransitGatewayVpcAttachmentsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more VPC attachments. By default, all VPC attachments are described.\n Alternatively, you can filter the results.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TransitGatewayVpcAttachments", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayVpcAttachmentsRequest": { + "type": "structure", + "members": { + "TransitGatewayAttachmentIds": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the attachments.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#TransitGatewayMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayVpcAttachmentsResult": { + "type": "structure", + "members": { + "TransitGatewayVpcAttachments": { + "target": "com.amazonaws.ec2#TransitGatewayVpcAttachmentList", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayVpcAttachments", + "smithy.api#documentation": "

Information about the VPC attachments.

", + "smithy.api#xmlName": "transitGatewayVpcAttachments" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeTransitGateways": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeTransitGatewaysRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeTransitGatewaysResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can\n filter the results.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TransitGateways", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeTransitGatewaysRequest": { + "type": "structure", + "members": { + "TransitGatewayIds": { + "target": "com.amazonaws.ec2#TransitGatewayIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the transit gateways.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#TransitGatewayMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeTransitGatewaysResult": { + "type": "structure", + "members": { + "TransitGateways": { + "target": "com.amazonaws.ec2#TransitGatewayList", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewaySet", + "smithy.api#documentation": "

Information about the transit gateways.

", + "smithy.api#xmlName": "transitGatewaySet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeTrunkInterfaceAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeTrunkInterfaceAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeTrunkInterfaceAssociationsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more network interface trunk associations.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "InterfaceAssociations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeTrunkInterfaceAssociationsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 255 + } + } + }, + "com.amazonaws.ec2#DescribeTrunkInterfaceAssociationsRequest": { + "type": "structure", + "members": { + "AssociationIds": { + "target": "com.amazonaws.ec2#TrunkInterfaceAssociationIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the associations.

", + "smithy.api#xmlName": "AssociationId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeTrunkInterfaceAssociationsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeTrunkInterfaceAssociationsResult": { + "type": "structure", + "members": { + "InterfaceAssociations": { + "target": "com.amazonaws.ec2#TrunkInterfaceAssociationList", + "traits": { + "aws.protocols#ec2QueryName": "InterfaceAssociationSet", + "smithy.api#documentation": "

Information about the trunk associations.

", + "smithy.api#xmlName": "interfaceAssociationSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeVerifiedAccessEndpoints": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeVerifiedAccessEndpointsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeVerifiedAccessEndpointsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified Amazon Web Services Verified Access endpoints.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "VerifiedAccessEndpoints", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeVerifiedAccessEndpointsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeVerifiedAccessEndpointsRequest": { + "type": "structure", + "members": { + "VerifiedAccessEndpointIds": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointIdList", + "traits": { + "smithy.api#documentation": "

The ID of the Verified Access endpoint.

", + "smithy.api#xmlName": "VerifiedAccessEndpointId" + } + }, + "VerifiedAccessInstanceId": { + "target": "com.amazonaws.ec2#VerifiedAccessInstanceId", + "traits": { + "smithy.api#documentation": "

The ID of the Verified Access instance.

" + } + }, + "VerifiedAccessGroupId": { + "target": "com.amazonaws.ec2#VerifiedAccessGroupId", + "traits": { + "smithy.api#documentation": "

The ID of the Verified Access group.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeVerifiedAccessEndpointsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

", + "smithy.api#xmlName": "Filter" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeVerifiedAccessEndpointsResult": { + "type": "structure", + "members": { + "VerifiedAccessEndpoints": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointList", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessEndpointSet", + "smithy.api#documentation": "

Details about the Verified Access endpoints.

", + "smithy.api#xmlName": "verifiedAccessEndpointSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeVerifiedAccessGroupMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeVerifiedAccessGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeVerifiedAccessGroupsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeVerifiedAccessGroupsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified Verified Access groups.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "VerifiedAccessGroups", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeVerifiedAccessGroupsRequest": { + "type": "structure", + "members": { + "VerifiedAccessGroupIds": { + "target": "com.amazonaws.ec2#VerifiedAccessGroupIdList", + "traits": { + "smithy.api#documentation": "

The ID of the Verified Access groups.

", + "smithy.api#xmlName": "VerifiedAccessGroupId" + } + }, + "VerifiedAccessInstanceId": { + "target": "com.amazonaws.ec2#VerifiedAccessInstanceId", + "traits": { + "smithy.api#documentation": "

The ID of the Verified Access instance.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeVerifiedAccessGroupMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

", + "smithy.api#xmlName": "Filter" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeVerifiedAccessGroupsResult": { + "type": "structure", + "members": { + "VerifiedAccessGroups": { + "target": "com.amazonaws.ec2#VerifiedAccessGroupList", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessGroupSet", + "smithy.api#documentation": "

Details about the Verified Access groups.

", + "smithy.api#xmlName": "verifiedAccessGroupSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeVerifiedAccessInstanceLoggingConfigurations": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeVerifiedAccessInstanceLoggingConfigurationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeVerifiedAccessInstanceLoggingConfigurationsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified Amazon Web Services Verified Access instances.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "LoggingConfigurations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeVerifiedAccessInstanceLoggingConfigurationsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.ec2#DescribeVerifiedAccessInstanceLoggingConfigurationsRequest": { + "type": "structure", + "members": { + "VerifiedAccessInstanceIds": { + "target": "com.amazonaws.ec2#VerifiedAccessInstanceIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the Verified Access instances.

", + "smithy.api#xmlName": "VerifiedAccessInstanceId" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeVerifiedAccessInstanceLoggingConfigurationsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

", + "smithy.api#xmlName": "Filter" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeVerifiedAccessInstanceLoggingConfigurationsResult": { + "type": "structure", + "members": { + "LoggingConfigurations": { + "target": "com.amazonaws.ec2#VerifiedAccessInstanceLoggingConfigurationList", + "traits": { + "aws.protocols#ec2QueryName": "LoggingConfigurationSet", + "smithy.api#documentation": "

The logging configuration for the Verified Access instances.

", + "smithy.api#xmlName": "loggingConfigurationSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeVerifiedAccessInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeVerifiedAccessInstancesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeVerifiedAccessInstancesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified Amazon Web Services Verified Access instances.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "VerifiedAccessInstances", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeVerifiedAccessInstancesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 200 + } + } + }, + "com.amazonaws.ec2#DescribeVerifiedAccessInstancesRequest": { + "type": "structure", + "members": { + "VerifiedAccessInstanceIds": { + "target": "com.amazonaws.ec2#VerifiedAccessInstanceIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the Verified Access instances.

", + "smithy.api#xmlName": "VerifiedAccessInstanceId" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeVerifiedAccessInstancesMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

", + "smithy.api#xmlName": "Filter" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeVerifiedAccessInstancesResult": { + "type": "structure", + "members": { + "VerifiedAccessInstances": { + "target": "com.amazonaws.ec2#VerifiedAccessInstanceList", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessInstanceSet", + "smithy.api#documentation": "

Details about the Verified Access instances.

", + "smithy.api#xmlName": "verifiedAccessInstanceSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeVerifiedAccessTrustProviders": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeVerifiedAccessTrustProvidersRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeVerifiedAccessTrustProvidersResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified Amazon Web Services Verified Access trust providers.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "VerifiedAccessTrustProviders", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeVerifiedAccessTrustProvidersMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 200 + } + } + }, + "com.amazonaws.ec2#DescribeVerifiedAccessTrustProvidersRequest": { + "type": "structure", + "members": { + "VerifiedAccessTrustProviderIds": { + "target": "com.amazonaws.ec2#VerifiedAccessTrustProviderIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the Verified Access trust providers.

", + "smithy.api#xmlName": "VerifiedAccessTrustProviderId" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeVerifiedAccessTrustProvidersMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

", + "smithy.api#xmlName": "Filter" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeVerifiedAccessTrustProvidersResult": { + "type": "structure", + "members": { + "VerifiedAccessTrustProviders": { + "target": "com.amazonaws.ec2#VerifiedAccessTrustProviderList", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessTrustProviderSet", + "smithy.api#documentation": "

Details about the Verified Access trust providers.

", + "smithy.api#xmlName": "verifiedAccessTrustProviderSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeVolumeAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeVolumeAttributeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeVolumeAttributeResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified attribute of the specified volume. You can specify only one\n attribute at a time.

\n

For more information about EBS volumes, see Amazon EBS volumes in the Amazon EBS User Guide.

", + "smithy.api#examples": [ + { + "title": "To describe a volume attribute", + "documentation": "This example describes the ``autoEnableIo`` attribute of the volume with the ID ``vol-049df61146c4d7901``.", + "input": { + "VolumeId": "vol-049df61146c4d7901", + "Attribute": "autoEnableIO" + }, + "output": { + "AutoEnableIO": { + "Value": false + }, + "VolumeId": "vol-049df61146c4d7901" + } + } + ] + } + }, + "com.amazonaws.ec2#DescribeVolumeAttributeRequest": { + "type": "structure", + "members": { + "Attribute": { + "target": "com.amazonaws.ec2#VolumeAttributeName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The attribute of the volume. This parameter is required.

", + "smithy.api#required": {} + } + }, + "VolumeId": { + "target": "com.amazonaws.ec2#VolumeId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the volume.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeVolumeAttributeResult": { + "type": "structure", + "members": { + "AutoEnableIO": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "aws.protocols#ec2QueryName": "AutoEnableIO", + "smithy.api#documentation": "

The state of autoEnableIO attribute.

", + "smithy.api#xmlName": "autoEnableIO" + } + }, + "ProductCodes": { + "target": "com.amazonaws.ec2#ProductCodeList", + "traits": { + "aws.protocols#ec2QueryName": "ProductCodes", + "smithy.api#documentation": "

A list of product codes.

", + "smithy.api#xmlName": "productCodes" + } + }, + "VolumeId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VolumeId", + "smithy.api#documentation": "

The ID of the volume.

", + "smithy.api#xmlName": "volumeId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeVolumeStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeVolumeStatusRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeVolumeStatusResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the status of the specified volumes. Volume status provides the result of the\n checks performed on your volumes to determine events that can impair the performance of your\n volumes. The performance of a volume can be affected if an issue occurs on the volume's\n underlying host. If the volume's underlying host experiences a power outage or system issue,\n after the system is restored, there could be data inconsistencies on the volume. Volume events\n notify you if this occurs. Volume actions notify you if any action needs to be taken in\n response to the event.

\n

The DescribeVolumeStatus operation provides the following information about\n the specified volumes:

\n

\n Status: Reflects the current status of the volume. The possible\n values are ok, impaired , warning, or\n insufficient-data. If all checks pass, the overall status of the volume is\n ok. If the check fails, the overall status is impaired. If the\n status is insufficient-data, then the checks might still be taking place on your\n volume at the time. We recommend that you retry the request. For more information about volume\n status, see Monitor the status of your volumes in the Amazon EBS User Guide.

\n

\n Events: Reflect the cause of a volume status and might require you to\n take action. For example, if your volume returns an impaired status, then the\n volume event might be potential-data-inconsistency. This means that your volume\n has been affected by an issue with the underlying host, has all I/O operations disabled, and\n might have inconsistent data.

\n

\n Actions: Reflect the actions you might have to take in response to an\n event. For example, if the status of the volume is impaired and the volume event\n shows potential-data-inconsistency, then the action shows\n enable-volume-io. This means that you may want to enable the I/O operations for\n the volume by calling the EnableVolumeIO action and then check the volume\n for data consistency.

\n

Volume status is based on the volume status checks, and does not reflect the volume state.\n Therefore, volume status does not indicate volumes in the error state (for\n example, when a volume is incapable of accepting I/O.)

\n \n

The order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.

\n ", + "smithy.api#examples": [ + { + "title": "To describe the status of a single volume", + "documentation": "This example describes the status for the volume ``vol-1234567890abcdef0``.", + "input": { + "VolumeIds": [ + "vol-1234567890abcdef0" + ] + }, + "output": { + "VolumeStatuses": [ + { + "VolumeStatus": { + "Status": "ok", + "Details": [ + { + "Status": "passed", + "Name": "io-enabled" + }, + { + "Status": "not-applicable", + "Name": "io-performance" + } + ] + }, + "AvailabilityZone": "us-east-1a", + "VolumeId": "vol-1234567890abcdef0", + "Actions": [], + "Events": [] + } + ] + } + }, + { + "title": "To describe the status of impaired volumes", + "documentation": "This example describes the status for all volumes that are impaired. In this example output, there are no impaired volumes.", + "input": { + "Filters": [ + { + "Values": [ + "impaired" + ], + "Name": "volume-status.status" + } + ] + }, + "output": { + "VolumeStatuses": [] + } + } + ], + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "VolumeStatuses", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeVolumeStatusRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output. \n\tFor more information, see Pagination.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request.\n Pagination continues from the end of the items returned by the previous request.

" + } + }, + "VolumeIds": { + "target": "com.amazonaws.ec2#VolumeIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the volumes.

\n

Default: Describes all your volumes.

", + "smithy.api#xmlName": "VolumeId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeVolumeStatusResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. \n This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "VolumeStatuses": { + "target": "com.amazonaws.ec2#VolumeStatusList", + "traits": { + "aws.protocols#ec2QueryName": "VolumeStatusSet", + "smithy.api#documentation": "

Information about the status of the volumes.

", + "smithy.api#xmlName": "volumeStatusSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeVolumes": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeVolumesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeVolumesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified EBS volumes or all of your EBS volumes.

\n

If you are describing a long list of volumes, we recommend that you paginate the output to make the list\n more manageable. For more information, see Pagination.

\n

For more information about EBS volumes, see Amazon EBS volumes in the Amazon EBS User Guide.

\n \n

We strongly recommend using only paginated requests. Unpaginated requests are\n susceptible to throttling and timeouts.

\n \n \n

The order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.

\n ", + "smithy.api#examples": [ + { + "title": "To describe all volumes", + "documentation": "This example describes all of your volumes in the default region.", + "output": { + "Volumes": [ + { + "AvailabilityZone": "us-east-1a", + "Attachments": [ + { + "AttachTime": "2013-12-18T22:35:00.000Z", + "InstanceId": "i-1234567890abcdef0", + "VolumeId": "vol-049df61146c4d7901", + "State": "attached", + "DeleteOnTermination": true, + "Device": "/dev/sda1" + } + ], + "VolumeType": "standard", + "VolumeId": "vol-049df61146c4d7901", + "State": "in-use", + "SnapshotId": "snap-1234567890abcdef0", + "CreateTime": "2013-12-18T22:35:00.084Z", + "Size": 8 + } + ], + "NextToken": "" + } + }, + { + "title": "To describe volumes that are attached to a specific instance", + "documentation": "This example describes all volumes that are both attached to the instance with the ID i-1234567890abcdef0 and set to delete when the instance terminates.", + "input": { + "Filters": [ + { + "Values": [ + "i-1234567890abcdef0" + ], + "Name": "attachment.instance-id" + }, + { + "Values": [ + "true" + ], + "Name": "attachment.delete-on-termination" + } + ] + }, + "output": { + "Volumes": [ + { + "AvailabilityZone": "us-east-1a", + "Attachments": [ + { + "AttachTime": "2013-12-18T22:35:00.000Z", + "InstanceId": "i-1234567890abcdef0", + "VolumeId": "vol-049df61146c4d7901", + "State": "attached", + "DeleteOnTermination": true, + "Device": "/dev/sda1" + } + ], + "VolumeType": "standard", + "VolumeId": "vol-049df61146c4d7901", + "State": "in-use", + "SnapshotId": "snap-1234567890abcdef0", + "CreateTime": "2013-12-18T22:35:00.084Z", + "Size": 8 + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Volumes", + "pageSize": "MaxResults" + }, + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "VolumeAvailable": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "Volumes[].State", + "expected": "available", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Volumes[].State", + "expected": "deleted", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 15 + }, + "VolumeDeleted": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "Volumes[].State", + "expected": "deleted", + "comparator": "allStringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "errorType": "InvalidVolume.NotFound" + } + } + ], + "minDelay": 15 + }, + "VolumeInUse": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "Volumes[].State", + "expected": "in-use", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Volumes[].State", + "expected": "deleted", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 15 + } + } + } + }, + "com.amazonaws.ec2#DescribeVolumesModifications": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeVolumesModificationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeVolumesModificationsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the most recent volume modification request for the specified EBS volumes.

\n

For more information, see \n Monitor the progress of volume modifications in the Amazon EBS User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "VolumesModifications", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeVolumesModificationsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "VolumeIds": { + "target": "com.amazonaws.ec2#VolumeIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the volumes.

", + "smithy.api#xmlName": "VolumeId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request.\n Pagination continues from the end of the items returned by the previous request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of results (up to a limit of 500) to be returned in a paginated\n request. For more information, see Pagination.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeVolumesModificationsResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. \n This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "VolumesModifications": { + "target": "com.amazonaws.ec2#VolumeModificationList", + "traits": { + "aws.protocols#ec2QueryName": "VolumeModificationSet", + "smithy.api#documentation": "

Information about the volume modifications.

", + "smithy.api#xmlName": "volumeModificationSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeVolumesRequest": { + "type": "structure", + "members": { + "VolumeIds": { + "target": "com.amazonaws.ec2#VolumeIdStringList", + "traits": { + "smithy.api#documentation": "

The volume IDs. If not specified, then all volumes are included in the response.

", + "smithy.api#xmlName": "VolumeId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token returned from a previous paginated request.\n Pagination continues from the end of the items returned by the previous request.

", + "smithy.api#xmlName": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "MaxResults", + "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output. \n\tFor more information, see Pagination.

", + "smithy.api#xmlName": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeVolumesResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. \n This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "Volumes": { + "target": "com.amazonaws.ec2#VolumeList", + "traits": { + "aws.protocols#ec2QueryName": "VolumeSet", + "smithy.api#documentation": "

Information about the volumes.

", + "smithy.api#xmlName": "volumeSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeVpcAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeVpcAttributeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeVpcAttributeResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.

", + "smithy.api#examples": [ + { + "title": "To describe the enableDnsSupport attribute", + "documentation": "This example describes the enableDnsSupport attribute. This attribute indicates whether DNS resolution is enabled for the VPC. If this attribute is true, the Amazon DNS server resolves DNS hostnames for your instances to their corresponding IP addresses; otherwise, it does not.", + "input": { + "VpcId": "vpc-a01106c2", + "Attribute": "enableDnsSupport" + }, + "output": { + "VpcId": "vpc-a01106c2", + "EnableDnsSupport": { + "Value": true + } + } + }, + { + "title": "To describe the enableDnsHostnames attribute", + "documentation": "This example describes the enableDnsHostnames attribute. This attribute indicates whether the instances launched in the VPC get DNS hostnames. If this attribute is true, instances in the VPC get DNS hostnames; otherwise, they do not.", + "input": { + "VpcId": "vpc-a01106c2", + "Attribute": "enableDnsHostnames" + }, + "output": { + "VpcId": "vpc-a01106c2", + "EnableDnsHostnames": { + "Value": true + } + } + } + ] + } + }, + "com.amazonaws.ec2#DescribeVpcAttributeRequest": { + "type": "structure", + "members": { + "Attribute": { + "target": "com.amazonaws.ec2#VpcAttributeName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The VPC attribute.

", + "smithy.api#required": {} + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeVpcAttributeResult": { + "type": "structure", + "members": { + "EnableDnsHostnames": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "aws.protocols#ec2QueryName": "EnableDnsHostnames", + "smithy.api#documentation": "

Indicates whether the instances launched in the VPC get DNS hostnames.\n\t\t\t\tIf this attribute is true, instances in the VPC get DNS hostnames;\n\t\t\t\totherwise, they do not.

", + "smithy.api#xmlName": "enableDnsHostnames" + } + }, + "EnableDnsSupport": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "aws.protocols#ec2QueryName": "EnableDnsSupport", + "smithy.api#documentation": "

Indicates whether DNS resolution is enabled for\n\t\t\t\tthe VPC. If this attribute is true, the Amazon DNS server\n\t\t\t\tresolves DNS hostnames for your instances to their corresponding\n\t\t\t\tIP addresses; otherwise, it does not.

", + "smithy.api#xmlName": "enableDnsSupport" + } + }, + "EnableNetworkAddressUsageMetrics": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "aws.protocols#ec2QueryName": "EnableNetworkAddressUsageMetrics", + "smithy.api#documentation": "

Indicates whether Network Address Usage metrics are enabled for your VPC.

", + "smithy.api#xmlName": "enableNetworkAddressUsageMetrics" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "vpcId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeVpcBlockPublicAccessExclusions": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeVpcBlockPublicAccessExclusionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeVpcBlockPublicAccessExclusionsResult" + }, + "traits": { + "smithy.api#documentation": "

Describe VPC Block Public Access (BPA) exclusions. A VPC BPA exclusion is a mode that can be applied to a single VPC or subnet that exempts it from the account’s BPA mode and will allow bidirectional or egress-only access. You can create BPA exclusions for VPCs and subnets even when BPA is not enabled on the account to ensure that there is no traffic disruption to the exclusions when VPC BPA is turned on. To learn more about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User Guide.

" + } + }, + "com.amazonaws.ec2#DescribeVpcBlockPublicAccessExclusionsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeVpcBlockPublicAccessExclusionsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

Filters for the request:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "ExclusionIds": { + "target": "com.amazonaws.ec2#VpcBlockPublicAccessExclusionIdList", + "traits": { + "smithy.api#documentation": "

IDs of exclusions.

", + "smithy.api#xmlName": "ExclusionId" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeVpcBlockPublicAccessExclusionsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeVpcBlockPublicAccessExclusionsResult": { + "type": "structure", + "members": { + "VpcBlockPublicAccessExclusions": { + "target": "com.amazonaws.ec2#VpcBlockPublicAccessExclusionList", + "traits": { + "aws.protocols#ec2QueryName": "VpcBlockPublicAccessExclusionSet", + "smithy.api#documentation": "

Details related to the exclusions.

", + "smithy.api#xmlName": "vpcBlockPublicAccessExclusionSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeVpcBlockPublicAccessOptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeVpcBlockPublicAccessOptionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeVpcBlockPublicAccessOptionsResult" + }, + "traits": { + "smithy.api#documentation": "

Describe VPC Block Public Access (BPA) options. VPC Block Public Access (BPA) enables you to block resources in VPCs and subnets that you own in a Region from reaching or being reached from the internet through internet gateways and egress-only internet gateways. To learn more about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User Guide.

" + } + }, + "com.amazonaws.ec2#DescribeVpcBlockPublicAccessOptionsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeVpcBlockPublicAccessOptionsResult": { + "type": "structure", + "members": { + "VpcBlockPublicAccessOptions": { + "target": "com.amazonaws.ec2#VpcBlockPublicAccessOptions", + "traits": { + "aws.protocols#ec2QueryName": "VpcBlockPublicAccessOptions", + "smithy.api#documentation": "

Details related to the options.

", + "smithy.api#xmlName": "vpcBlockPublicAccessOptions" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeVpcClassicLink": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeVpcClassicLinkRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeVpcClassicLinkResult" + }, + "traits": { + "smithy.api#documentation": "\n

This action is deprecated.

\n \n

Describes the ClassicLink status of the specified VPCs.

" + } + }, + "com.amazonaws.ec2#DescribeVpcClassicLinkDnsSupport": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeVpcClassicLinkDnsSupportRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeVpcClassicLinkDnsSupportResult" + }, + "traits": { + "smithy.api#documentation": "\n

This action is deprecated.

\n \n

Describes the ClassicLink DNS support status of one or more VPCs. If enabled, the DNS\n hostname of a linked EC2-Classic instance resolves to its private IP address when\n addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname\n of an instance in a VPC resolves to its private IP address when addressed from a linked\n EC2-Classic instance.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Vpcs", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeVpcClassicLinkDnsSupportMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 255 + } + } + }, + "com.amazonaws.ec2#DescribeVpcClassicLinkDnsSupportNextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.ec2#DescribeVpcClassicLinkDnsSupportRequest": { + "type": "structure", + "members": { + "VpcIds": { + "target": "com.amazonaws.ec2#VpcClassicLinkIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the VPCs.

", + "smithy.api#xmlName": "VpcIds" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeVpcClassicLinkDnsSupportMaxResults", + "traits": { + "aws.protocols#ec2QueryName": "MaxResults", + "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

", + "smithy.api#xmlName": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#DescribeVpcClassicLinkDnsSupportNextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeVpcClassicLinkDnsSupportResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#DescribeVpcClassicLinkDnsSupportNextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "Vpcs": { + "target": "com.amazonaws.ec2#ClassicLinkDnsSupportList", + "traits": { + "aws.protocols#ec2QueryName": "Vpcs", + "smithy.api#documentation": "

Information about the ClassicLink DNS support status of the VPCs.

", + "smithy.api#xmlName": "vpcs" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeVpcClassicLinkRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "VpcIds": { + "target": "com.amazonaws.ec2#VpcClassicLinkIdList", + "traits": { + "smithy.api#documentation": "

The VPCs for which you want to describe the ClassicLink status.

", + "smithy.api#xmlName": "VpcId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeVpcClassicLinkResult": { + "type": "structure", + "members": { + "Vpcs": { + "target": "com.amazonaws.ec2#VpcClassicLinkList", + "traits": { + "aws.protocols#ec2QueryName": "VpcSet", + "smithy.api#documentation": "

The ClassicLink status of the VPCs.

", + "smithy.api#xmlName": "vpcSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeVpcEndpointAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeVpcEndpointAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeVpcEndpointAssociationsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the VPC resources, VPC endpoint services, Amazon Lattice services, or service networks\n associated with the VPC endpoint.

" + } + }, + "com.amazonaws.ec2#DescribeVpcEndpointAssociationsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "VpcEndpointIds": { + "target": "com.amazonaws.ec2#VpcEndpointIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the VPC endpoints.

", + "smithy.api#xmlName": "VpcEndpointId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#MaxResults2", + "traits": { + "smithy.api#documentation": "

The maximum page size.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The pagination token.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeVpcEndpointAssociationsResult": { + "type": "structure", + "members": { + "VpcEndpointAssociations": { + "target": "com.amazonaws.ec2#VpcEndpointAssociationSet", + "traits": { + "aws.protocols#ec2QueryName": "VpcEndpointAssociationSet", + "smithy.api#documentation": "

Details of the endpoint associations.

", + "smithy.api#xmlName": "vpcEndpointAssociationSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The pagination token.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeVpcEndpointConnectionNotifications": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeVpcEndpointConnectionNotificationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeVpcEndpointConnectionNotificationsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the connection notifications for VPC endpoints and VPC endpoint\n services.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ConnectionNotificationSet", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeVpcEndpointConnectionNotificationsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ConnectionNotificationId": { + "target": "com.amazonaws.ec2#ConnectionNotificationId", + "traits": { + "smithy.api#documentation": "

The ID of the notification.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining\n results, make another request with the returned NextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to request the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeVpcEndpointConnectionNotificationsResult": { + "type": "structure", + "members": { + "ConnectionNotificationSet": { + "target": "com.amazonaws.ec2#ConnectionNotificationSet", + "traits": { + "aws.protocols#ec2QueryName": "ConnectionNotificationSet", + "smithy.api#documentation": "

The notifications.

", + "smithy.api#xmlName": "connectionNotificationSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is\n null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeVpcEndpointConnections": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeVpcEndpointConnectionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeVpcEndpointConnectionsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the VPC endpoint connections to your VPC endpoint services, including any\n endpoints that are pending your acceptance.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "VpcEndpointConnections", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeVpcEndpointConnectionsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining\n results of the initial request can be seen by sending another request with the returned\n NextToken value. This value can be between 5 and 1,000; if\n MaxResults is given a value larger than 1,000, only 1,000 results are\n returned.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to retrieve the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeVpcEndpointConnectionsResult": { + "type": "structure", + "members": { + "VpcEndpointConnections": { + "target": "com.amazonaws.ec2#VpcEndpointConnectionSet", + "traits": { + "aws.protocols#ec2QueryName": "VpcEndpointConnectionSet", + "smithy.api#documentation": "

Information about the VPC endpoint connections.

", + "smithy.api#xmlName": "vpcEndpointConnectionSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeVpcEndpointServiceConfigurations": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeVpcEndpointServiceConfigurationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeVpcEndpointServiceConfigurationsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the VPC endpoint service configurations in your account (your services).

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ServiceConfigurations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeVpcEndpointServiceConfigurationsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ServiceIds": { + "target": "com.amazonaws.ec2#VpcEndpointServiceIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the endpoint services.

", + "smithy.api#xmlName": "ServiceId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining\n results of the initial request can be seen by sending another request with the returned\n NextToken value. This value can be between 5 and 1,000; if\n MaxResults is given a value larger than 1,000, only 1,000 results are\n returned.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to retrieve the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeVpcEndpointServiceConfigurationsResult": { + "type": "structure", + "members": { + "ServiceConfigurations": { + "target": "com.amazonaws.ec2#ServiceConfigurationSet", + "traits": { + "aws.protocols#ec2QueryName": "ServiceConfigurationSet", + "smithy.api#documentation": "

Information about the services.

", + "smithy.api#xmlName": "serviceConfigurationSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeVpcEndpointServicePermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeVpcEndpointServicePermissionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeVpcEndpointServicePermissionsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the principals (service consumers) that are permitted to discover your VPC\n endpoint service.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AllowedPrincipals", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeVpcEndpointServicePermissionsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ServiceId": { + "target": "com.amazonaws.ec2#VpcEndpointServiceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the service.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining\n results of the initial request can be seen by sending another request with the returned\n NextToken value. This value can be between 5 and 1,000; if\n MaxResults is given a value larger than 1,000, only 1,000 results are\n returned.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to retrieve the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeVpcEndpointServicePermissionsResult": { + "type": "structure", + "members": { + "AllowedPrincipals": { + "target": "com.amazonaws.ec2#AllowedPrincipalSet", + "traits": { + "aws.protocols#ec2QueryName": "AllowedPrincipals", + "smithy.api#documentation": "

Information about the allowed principals.

", + "smithy.api#xmlName": "allowedPrincipals" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeVpcEndpointServices": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeVpcEndpointServicesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeVpcEndpointServicesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes available services to which you can create a VPC endpoint.

\n

When the service provider and the consumer have different accounts in multiple\n Availability Zones, and the consumer views the VPC endpoint service information, the\n response only includes the common Availability Zones. For example, when the service\n provider account uses us-east-1a and us-east-1c and the\n consumer uses us-east-1a and us-east-1b, the response includes\n the VPC endpoint services in the common Availability Zone,\n us-east-1a.

" + } + }, + "com.amazonaws.ec2#DescribeVpcEndpointServicesRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ServiceNames": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The service names.

", + "smithy.api#xmlName": "ServiceName" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

\n

Constraint: If the value is greater than 1,000, we return only 1,000 items.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a prior call.)

" + } + }, + "ServiceRegions": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The service Regions.

", + "smithy.api#xmlName": "ServiceRegion" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeVpcEndpointServicesResult": { + "type": "structure", + "members": { + "ServiceNames": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "ServiceNameSet", + "smithy.api#documentation": "

The supported services.

", + "smithy.api#xmlName": "serviceNameSet" + } + }, + "ServiceDetails": { + "target": "com.amazonaws.ec2#ServiceDetailSet", + "traits": { + "aws.protocols#ec2QueryName": "ServiceDetailSet", + "smithy.api#documentation": "

Information about the service.

", + "smithy.api#xmlName": "serviceDetailSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeVpcEndpoints": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeVpcEndpointsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeVpcEndpointsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes your VPC endpoints. The default is to describe all your VPC endpoints. \n Alternatively, you can specify specific VPC endpoint IDs or filter the results to\n include only the VPC endpoints that match specific criteria.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "VpcEndpoints", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeVpcEndpointsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "VpcEndpointIds": { + "target": "com.amazonaws.ec2#VpcEndpointIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the VPC endpoints.

", + "smithy.api#xmlName": "VpcEndpointId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

\n

Constraint: If the value is greater than 1,000, we return only 1,000 items.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a prior call.)

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeVpcEndpointsResult": { + "type": "structure", + "members": { + "VpcEndpoints": { + "target": "com.amazonaws.ec2#VpcEndpointSet", + "traits": { + "aws.protocols#ec2QueryName": "VpcEndpointSet", + "smithy.api#documentation": "

Information about the VPC endpoints.

", + "smithy.api#xmlName": "vpcEndpointSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeVpcPeeringConnections": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeVpcPeeringConnectionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeVpcPeeringConnectionsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes your VPC peering connections. The default is to describe all your VPC peering connections. \n Alternatively, you can specify specific VPC peering connection IDs or filter the results to\n include only the VPC peering connections that match specific criteria.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "VpcPeeringConnections", + "pageSize": "MaxResults" + }, + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "VpcPeeringConnectionDeleted": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "VpcPeeringConnections[].Status.Code", + "expected": "deleted", + "comparator": "allStringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "errorType": "InvalidVpcPeeringConnectionID.NotFound" + } + } + ], + "minDelay": 15 + }, + "VpcPeeringConnectionExists": { + "acceptors": [ + { + "state": "success", + "matcher": { + "success": true + } + }, + { + "state": "retry", + "matcher": { + "errorType": "InvalidVpcPeeringConnectionID.NotFound" + } + } + ], + "minDelay": 15 + } + } + } + }, + "com.amazonaws.ec2#DescribeVpcPeeringConnectionsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeVpcPeeringConnectionsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeVpcPeeringConnectionsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "VpcPeeringConnectionIds": { + "target": "com.amazonaws.ec2#VpcPeeringConnectionIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the VPC peering connections.

\n

Default: Describes all your VPC peering connections.

", + "smithy.api#xmlName": "VpcPeeringConnectionId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeVpcPeeringConnectionsResult": { + "type": "structure", + "members": { + "VpcPeeringConnections": { + "target": "com.amazonaws.ec2#VpcPeeringConnectionList", + "traits": { + "aws.protocols#ec2QueryName": "VpcPeeringConnectionSet", + "smithy.api#documentation": "

Information about the VPC peering connections.

", + "smithy.api#xmlName": "vpcPeeringConnectionSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeVpcs": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeVpcsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeVpcsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes your VPCs. The default is to describe all your VPCs. \n Alternatively, you can specify specific VPC IDs or filter the results to\n include only the VPCs that match specific criteria.

", + "smithy.api#examples": [ + { + "title": "To describe a VPC", + "documentation": "This example describes the specified VPC.", + "input": { + "VpcIds": [ + "vpc-a01106c2" + ] + }, + "output": { + "Vpcs": [ + { + "VpcId": "vpc-a01106c2", + "InstanceTenancy": "default", + "Tags": [ + { + "Value": "MyVPC", + "Key": "Name" + } + ], + "State": "available", + "DhcpOptionsId": "dopt-7a8b9c2d", + "CidrBlock": "10.0.0.0/16", + "IsDefault": false + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Vpcs", + "pageSize": "MaxResults" + }, + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "VpcAvailable": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "Vpcs[].State", + "expected": "available", + "comparator": "allStringEquals" + } + } + } + ], + "minDelay": 15 + }, + "VpcExists": { + "acceptors": [ + { + "state": "success", + "matcher": { + "success": true + } + }, + { + "state": "retry", + "matcher": { + "errorType": "InvalidVpcID.NotFound" + } + } + ], + "minDelay": 1 + } + } + } + }, + "com.amazonaws.ec2#DescribeVpcsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeVpcsRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "VpcIds": { + "target": "com.amazonaws.ec2#VpcIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the VPCs.

", + "smithy.api#xmlName": "VpcId" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeVpcsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeVpcsResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "Vpcs": { + "target": "com.amazonaws.ec2#VpcList", + "traits": { + "aws.protocols#ec2QueryName": "VpcSet", + "smithy.api#documentation": "

Information about the VPCs.

", + "smithy.api#xmlName": "vpcSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeVpnConnections": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeVpnConnectionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeVpnConnectionsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more of your VPN connections.

\n

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.

", + "smithy.waiters#waitable": { + "VpnConnectionAvailable": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "VpnConnections[].State", + "expected": "available", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "VpnConnections[].State", + "expected": "deleting", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "VpnConnections[].State", + "expected": "deleted", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 15 + }, + "VpnConnectionDeleted": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "VpnConnections[].State", + "expected": "deleted", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "VpnConnections[].State", + "expected": "pending", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 15 + } + } + } + }, + "com.amazonaws.ec2#DescribeVpnConnectionsRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "VpnConnectionIds": { + "target": "com.amazonaws.ec2#VpnConnectionIdStringList", + "traits": { + "smithy.api#documentation": "

One or more VPN connection IDs.

\n

Default: Describes your VPN connections.

", + "smithy.api#xmlName": "VpnConnectionId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DescribeVpnConnections.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeVpnConnectionsResult": { + "type": "structure", + "members": { + "VpnConnections": { + "target": "com.amazonaws.ec2#VpnConnectionList", + "traits": { + "aws.protocols#ec2QueryName": "VpnConnectionSet", + "smithy.api#documentation": "

Information about one or more VPN connections.

", + "smithy.api#xmlName": "vpnConnectionSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of DescribeVpnConnections.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeVpnGateways": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeVpnGatewaysRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeVpnGatewaysResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more of your virtual private gateways.

\n

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.

" + } + }, + "com.amazonaws.ec2#DescribeVpnGatewaysRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "VpnGatewayIds": { + "target": "com.amazonaws.ec2#VpnGatewayIdStringList", + "traits": { + "smithy.api#documentation": "

One or more virtual private gateway IDs.

\n

Default: Describes all your virtual private gateways.

", + "smithy.api#xmlName": "VpnGatewayId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DescribeVpnGateways.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeVpnGatewaysResult": { + "type": "structure", + "members": { + "VpnGateways": { + "target": "com.amazonaws.ec2#VpnGatewayList", + "traits": { + "aws.protocols#ec2QueryName": "VpnGatewaySet", + "smithy.api#documentation": "

Information about one or more virtual private gateways.

", + "smithy.api#xmlName": "vpnGatewaySet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of DescribeVpnGateways.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DestinationFileFormat": { + "type": "enum", + "members": { + "plain_text": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "plain-text" + } + }, + "parquet": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "parquet" + } + } + } + }, + "com.amazonaws.ec2#DestinationOptionsRequest": { + "type": "structure", + "members": { + "FileFormat": { + "target": "com.amazonaws.ec2#DestinationFileFormat", + "traits": { + "smithy.api#documentation": "

The format for the flow log. The default is plain-text.

" + } + }, + "HiveCompatiblePartitions": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether to use Hive-compatible prefixes for flow logs stored in Amazon S3.\n The default is false.

" + } + }, + "PerHourPartition": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether to partition the flow log per hour. This reduces the cost and response \n time for queries. The default is false.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the destination options for a flow log.

" + } + }, + "com.amazonaws.ec2#DestinationOptionsResponse": { + "type": "structure", + "members": { + "FileFormat": { + "target": "com.amazonaws.ec2#DestinationFileFormat", + "traits": { + "aws.protocols#ec2QueryName": "FileFormat", + "smithy.api#documentation": "

The format for the flow log.

", + "smithy.api#xmlName": "fileFormat" + } + }, + "HiveCompatiblePartitions": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "HiveCompatiblePartitions", + "smithy.api#documentation": "

Indicates whether to use Hive-compatible prefixes for flow logs stored in Amazon S3.

", + "smithy.api#xmlName": "hiveCompatiblePartitions" + } + }, + "PerHourPartition": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "PerHourPartition", + "smithy.api#documentation": "

Indicates whether to partition the flow log per hour.

", + "smithy.api#xmlName": "perHourPartition" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the destination options for a flow log.

" + } + }, + "com.amazonaws.ec2#DetachClassicLinkVpc": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DetachClassicLinkVpcRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DetachClassicLinkVpcResult" + }, + "traits": { + "smithy.api#documentation": "\n

This action is deprecated.

\n \n

Unlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, \n\t\t the VPC security groups are no longer associated with it. An instance is automatically unlinked from \n\t\t a VPC when it's stopped.

" + } + }, + "com.amazonaws.ec2#DetachClassicLinkVpcRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance to unlink from the VPC.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "instanceId" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC to which the instance is linked.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "vpcId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DetachClassicLinkVpcResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DetachInternetGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DetachInternetGatewayRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Detaches an internet gateway from a VPC, disabling connectivity between the internet\n\t\t\tand the VPC. The VPC must not contain any running instances with Elastic IP addresses or\n\t\t\tpublic IPv4 addresses.

", + "smithy.api#examples": [ + { + "title": "To detach an Internet gateway from a VPC", + "documentation": "This example detaches the specified Internet gateway from the specified VPC.", + "input": { + "InternetGatewayId": "igw-c0a643a9", + "VpcId": "vpc-a01106c2" + } + } + ] + } + }, + "com.amazonaws.ec2#DetachInternetGatewayRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "InternetGatewayId": { + "target": "com.amazonaws.ec2#InternetGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "InternetGatewayId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the internet gateway.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "internetGatewayId" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "vpcId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DetachNetworkInterface": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DetachNetworkInterfaceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Detaches a network interface from an instance.

", + "smithy.api#examples": [ + { + "title": "To detach a network interface from an instance", + "documentation": "This example detaches the specified network interface from its attached instance.", + "input": { + "AttachmentId": "eni-attach-66c4350a" + } + } + ] + } + }, + "com.amazonaws.ec2#DetachNetworkInterfaceRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "AttachmentId": { + "target": "com.amazonaws.ec2#NetworkInterfaceAttachmentId", + "traits": { + "aws.protocols#ec2QueryName": "AttachmentId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the attachment.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "attachmentId" + } + }, + "Force": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Force", + "smithy.api#documentation": "

Specifies whether to force a detachment.

\n \n
    \n
  • \n

    Use the Force parameter only as a last resort to detach a network interface from a failed instance.

    \n
    • \n
  • \n

    If you use the Force parameter to detach a network interface, you might not be able to attach a different network interface to the same index on the instance without first stopping and starting the instance.

    \n
    • \n
  • \n

    If you force the detachment of a network interface, the instance metadata\n might not get updated. This means that the attributes associated\n with the detached network interface might still be visible. The\n instance metadata will get updated when you stop and start the\n instance.

    \n
    • \n
\n ", + "smithy.api#xmlName": "force" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DetachNetworkInterface.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DetachVerifiedAccessTrustProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DetachVerifiedAccessTrustProviderRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DetachVerifiedAccessTrustProviderResult" + }, + "traits": { + "smithy.api#documentation": "

Detaches the specified Amazon Web Services Verified Access trust provider from the specified Amazon Web Services Verified Access instance.

" + } + }, + "com.amazonaws.ec2#DetachVerifiedAccessTrustProviderRequest": { + "type": "structure", + "members": { + "VerifiedAccessInstanceId": { + "target": "com.amazonaws.ec2#VerifiedAccessInstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Verified Access instance.

", + "smithy.api#required": {} + } + }, + "VerifiedAccessTrustProviderId": { + "target": "com.amazonaws.ec2#VerifiedAccessTrustProviderId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Verified Access trust provider.

", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DetachVerifiedAccessTrustProviderResult": { + "type": "structure", + "members": { + "VerifiedAccessTrustProvider": { + "target": "com.amazonaws.ec2#VerifiedAccessTrustProvider", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessTrustProvider", + "smithy.api#documentation": "

Details about the Verified Access trust provider.

", + "smithy.api#xmlName": "verifiedAccessTrustProvider" + } + }, + "VerifiedAccessInstance": { + "target": "com.amazonaws.ec2#VerifiedAccessInstance", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessInstance", + "smithy.api#documentation": "

Details about the Verified Access instance.

", + "smithy.api#xmlName": "verifiedAccessInstance" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DetachVolume": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DetachVolumeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#VolumeAttachment" + }, + "traits": { + "smithy.api#documentation": "

Detaches an EBS volume from an instance. Make sure to unmount any file systems on the\n device within your operating system before detaching the volume. Failure to do so can result\n in the volume becoming stuck in the busy state while detaching. If this happens,\n detachment can be delayed indefinitely until you unmount the volume, force detachment, reboot\n the instance, or all three. If an EBS volume is the root device of an instance, it can't be\n detached while the instance is running. To detach the root volume, stop the instance\n first.

\n

When a volume with an Amazon Web Services Marketplace product code is detached from an instance, the\n product code is no longer associated with the instance.

\n

You can't detach or force detach volumes that are attached to Amazon ECS or \n Fargate tasks. Attempting to do this results in the UnsupportedOperationException \n exception with the Unable to detach volume attached to ECS tasks error message.

\n

For more information, see Detach an Amazon EBS volume in the\n Amazon EBS User Guide.

", + "smithy.api#examples": [ + { + "title": "To detach a volume from an instance", + "documentation": "This example detaches the volume (``vol-049df61146c4d7901``) from the instance it is attached to.", + "input": { + "VolumeId": "vol-1234567890abcdef0" + }, + "output": { + "AttachTime": "2014-02-27T19:23:06.000Z", + "InstanceId": "i-1234567890abcdef0", + "VolumeId": "vol-049df61146c4d7901", + "State": "detaching", + "Device": "/dev/sdb" + } + } + ] + } + }, + "com.amazonaws.ec2#DetachVolumeRequest": { + "type": "structure", + "members": { + "Device": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The device name.

" + } + }, + "Force": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Forces detachment if the previous detachment attempt did not occur cleanly (for example,\n logging into an instance, unmounting the volume, and detaching normally). This option can lead\n to data loss or a corrupted file system. Use this option only as a last resort to detach a\n volume from a failed instance. The instance won't have an opportunity to flush file system\n caches or file system metadata. If you use this option, you must perform file system check and\n repair procedures.

" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceIdForResolver", + "traits": { + "smithy.api#documentation": "

The ID of the instance. If you are detaching a Multi-Attach enabled volume, you must specify an instance ID.

" + } + }, + "VolumeId": { + "target": "com.amazonaws.ec2#VolumeIdWithResolver", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the volume.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DetachVpnGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DetachVpnGatewayRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Detaches a virtual private gateway from a VPC. You do this if you're planning to turn\n off the VPC and not use it anymore. You can confirm a virtual private gateway has been\n completely detached from a VPC by describing the virtual private gateway (any\n attachments to the virtual private gateway are also described).

\n

You must wait for the attachment's state to switch to detached before you\n can delete the VPC or attach a different VPC to the virtual private gateway.

" + } + }, + "com.amazonaws.ec2#DetachVpnGatewayRequest": { + "type": "structure", + "members": { + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#required": {} + } + }, + "VpnGatewayId": { + "target": "com.amazonaws.ec2#VpnGatewayId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the virtual private gateway.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DetachVpnGateway.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeviceOptions": { + "type": "structure", + "members": { + "TenantId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TenantId", + "smithy.api#documentation": "

The ID of the tenant application with the device-identity provider.

", + "smithy.api#xmlName": "tenantId" + } + }, + "PublicSigningKeyUrl": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicSigningKeyUrl", + "smithy.api#documentation": "

\n The URL Amazon Web Services Verified Access will use to verify the authenticity of the device tokens.\n

", + "smithy.api#xmlName": "publicSigningKeyUrl" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the options for an Amazon Web Services Verified Access device-identity based trust provider.

" + } + }, + "com.amazonaws.ec2#DeviceTrustProviderType": { + "type": "enum", + "members": { + "jamf": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "jamf" + } + }, + "crowdstrike": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "crowdstrike" + } + }, + "jumpcloud": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "jumpcloud" + } + } + } + }, + "com.amazonaws.ec2#DeviceTrustProviderTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#DeviceTrustProviderType", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#DeviceType": { + "type": "enum", + "members": { + "ebs": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ebs" + } + }, + "instance_store": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "instance-store" + } + } + } + }, + "com.amazonaws.ec2#DhcpConfiguration": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Key", + "smithy.api#documentation": "

The name of a DHCP option.

", + "smithy.api#xmlName": "key" + } + }, + "Values": { + "target": "com.amazonaws.ec2#DhcpConfigurationValueList", + "traits": { + "aws.protocols#ec2QueryName": "ValueSet", + "smithy.api#documentation": "

The values for the DHCP option.

", + "smithy.api#xmlName": "valueSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a DHCP configuration option.

" + } + }, + "com.amazonaws.ec2#DhcpConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#DhcpConfiguration", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#DhcpConfigurationValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#DhcpOptions": { + "type": "structure", + "members": { + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the DHCP options set.

", + "smithy.api#xmlName": "ownerId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the DHCP options set.

", + "smithy.api#xmlName": "tagSet" + } + }, + "DhcpOptionsId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DhcpOptionsId", + "smithy.api#documentation": "

The ID of the set of DHCP options.

", + "smithy.api#xmlName": "dhcpOptionsId" + } + }, + "DhcpConfigurations": { + "target": "com.amazonaws.ec2#DhcpConfigurationList", + "traits": { + "aws.protocols#ec2QueryName": "DhcpConfigurationSet", + "smithy.api#documentation": "

The DHCP options in the set.

", + "smithy.api#xmlName": "dhcpConfigurationSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

The set of DHCP options.

" + } + }, + "com.amazonaws.ec2#DhcpOptionsId": { + "type": "string" + }, + "com.amazonaws.ec2#DhcpOptionsIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#DhcpOptionsId", + "traits": { + "smithy.api#xmlName": "DhcpOptionsId" + } + } + }, + "com.amazonaws.ec2#DhcpOptionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#DhcpOptions", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#DirectoryServiceAuthentication": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DirectoryId", + "smithy.api#documentation": "

The ID of the Active Directory used for authentication.

", + "smithy.api#xmlName": "directoryId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an Active Directory.

" + } + }, + "com.amazonaws.ec2#DirectoryServiceAuthenticationRequest": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ID of the Active Directory to be used for authentication.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the Active Directory to be used for client authentication.

" + } + }, + "com.amazonaws.ec2#DisableAddressTransfer": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisableAddressTransferRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisableAddressTransferResult" + }, + "traits": { + "smithy.api#documentation": "

Disables Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon VPC User Guide.

" + } + }, + "com.amazonaws.ec2#DisableAddressTransferRequest": { + "type": "structure", + "members": { + "AllocationId": { + "target": "com.amazonaws.ec2#AllocationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The allocation ID of an Elastic IP address.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisableAddressTransferResult": { + "type": "structure", + "members": { + "AddressTransfer": { + "target": "com.amazonaws.ec2#AddressTransfer", + "traits": { + "aws.protocols#ec2QueryName": "AddressTransfer", + "smithy.api#documentation": "

An Elastic IP address transfer.

", + "smithy.api#xmlName": "addressTransfer" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisableAllowedImagesSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisableAllowedImagesSettingsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisableAllowedImagesSettingsResult" + }, + "traits": { + "smithy.api#documentation": "

Disables Allowed AMIs for your account in the specified Amazon Web Services Region. When set to\n disabled, the image criteria in your Allowed AMIs settings do not apply, and no\n restrictions are placed on AMI discoverability or usage. Users in your account can launch\n instances using any public AMI or AMI shared with your account.

\n \n

The Allowed AMIs feature does not restrict the AMIs owned by your account. Regardless of\n the criteria you set, the AMIs created by your account will always be discoverable and\n usable by users in your account.

\n \n

For more information, see Control the discovery and use of AMIs in\n Amazon EC2 with Allowed AMIs in\n Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#DisableAllowedImagesSettingsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisableAllowedImagesSettingsResult": { + "type": "structure", + "members": { + "AllowedImagesSettingsState": { + "target": "com.amazonaws.ec2#AllowedImagesSettingsDisabledState", + "traits": { + "aws.protocols#ec2QueryName": "AllowedImagesSettingsState", + "smithy.api#documentation": "

Returns disabled if the request succeeds; otherwise, it returns an\n error.

", + "smithy.api#xmlName": "allowedImagesSettingsState" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisableAwsNetworkPerformanceMetricSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisableAwsNetworkPerformanceMetricSubscriptionRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisableAwsNetworkPerformanceMetricSubscriptionResult" + }, + "traits": { + "smithy.api#documentation": "

Disables Infrastructure Performance metric subscriptions.

" + } + }, + "com.amazonaws.ec2#DisableAwsNetworkPerformanceMetricSubscriptionRequest": { + "type": "structure", + "members": { + "Source": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The source Region or Availability Zone that the metric subscription is disabled for. For example, us-east-1.

" + } + }, + "Destination": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The target Region or Availability Zone that the metric subscription is disabled for. For example, eu-north-1.

" + } + }, + "Metric": { + "target": "com.amazonaws.ec2#MetricType", + "traits": { + "smithy.api#documentation": "

The metric used for the disabled subscription.

" + } + }, + "Statistic": { + "target": "com.amazonaws.ec2#StatisticType", + "traits": { + "smithy.api#documentation": "

The statistic used for the disabled subscription.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisableAwsNetworkPerformanceMetricSubscriptionResult": { + "type": "structure", + "members": { + "Output": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Output", + "smithy.api#documentation": "

Indicates whether the unsubscribe action was successful.

", + "smithy.api#xmlName": "output" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisableEbsEncryptionByDefault": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisableEbsEncryptionByDefaultRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisableEbsEncryptionByDefaultResult" + }, + "traits": { + "smithy.api#documentation": "

Disables EBS encryption by default for your account in the current Region.

\n

After you disable encryption by default, you can still create encrypted volumes by \n enabling encryption when you create each volume.

\n

Disabling encryption by default does not change the encryption status of your\n existing volumes.

\n

For more information, see Amazon EBS encryption in the\n Amazon EBS User Guide.

" + } + }, + "com.amazonaws.ec2#DisableEbsEncryptionByDefaultRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisableEbsEncryptionByDefaultResult": { + "type": "structure", + "members": { + "EbsEncryptionByDefault": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EbsEncryptionByDefault", + "smithy.api#documentation": "

The updated status of encryption by default.

", + "smithy.api#xmlName": "ebsEncryptionByDefault" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisableFastLaunch": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisableFastLaunchRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisableFastLaunchResult" + }, + "traits": { + "smithy.api#documentation": "

Discontinue Windows fast launch for a Windows AMI, and clean up existing pre-provisioned\n snapshots. After you disable Windows fast launch, the AMI uses the standard launch process for\n each new instance. Amazon EC2 must remove all pre-provisioned snapshots before you can enable\n Windows fast launch again.

\n \n

You can only change these settings for Windows AMIs that you own or that have been\n shared with you.

\n " + } + }, + "com.amazonaws.ec2#DisableFastLaunchRequest": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specify the ID of the image for which to disable Windows fast launch.

", + "smithy.api#required": {} + } + }, + "Force": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Forces the image settings to turn off Windows fast launch for your Windows AMI. This\n parameter overrides any errors that are encountered while cleaning up resources in your\n account.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisableFastLaunchResult": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the image for which Windows fast launch was disabled.

", + "smithy.api#xmlName": "imageId" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#FastLaunchResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The pre-provisioning resource type that must be cleaned after turning off Windows fast\n launch for the Windows AMI. Supported values include: snapshot.

", + "smithy.api#xmlName": "resourceType" + } + }, + "SnapshotConfiguration": { + "target": "com.amazonaws.ec2#FastLaunchSnapshotConfigurationResponse", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotConfiguration", + "smithy.api#documentation": "

Parameters that were used for Windows fast launch for the Windows AMI before Windows fast\n launch was disabled. This informs the clean-up process.

", + "smithy.api#xmlName": "snapshotConfiguration" + } + }, + "LaunchTemplate": { + "target": "com.amazonaws.ec2#FastLaunchLaunchTemplateSpecificationResponse", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplate", + "smithy.api#documentation": "

The launch template that was used to launch Windows instances from pre-provisioned\n snapshots.

", + "smithy.api#xmlName": "launchTemplate" + } + }, + "MaxParallelLaunches": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "MaxParallelLaunches", + "smithy.api#documentation": "

The maximum number of instances that Amazon EC2 can launch at the same time to create\n pre-provisioned snapshots for Windows fast launch.

", + "smithy.api#xmlName": "maxParallelLaunches" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The owner of the Windows AMI for which Windows fast launch was disabled.

", + "smithy.api#xmlName": "ownerId" + } + }, + "State": { + "target": "com.amazonaws.ec2#FastLaunchStateCode", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of Windows fast launch for the specified Windows AMI.

", + "smithy.api#xmlName": "state" + } + }, + "StateTransitionReason": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StateTransitionReason", + "smithy.api#documentation": "

The reason that the state changed for Windows fast launch for the Windows AMI.

", + "smithy.api#xmlName": "stateTransitionReason" + } + }, + "StateTransitionTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "StateTransitionTime", + "smithy.api#documentation": "

The time that the state changed for Windows fast launch for the Windows AMI.

", + "smithy.api#xmlName": "stateTransitionTime" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisableFastSnapshotRestoreErrorItem": { + "type": "structure", + "members": { + "SnapshotId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The ID of the snapshot.

", + "smithy.api#xmlName": "snapshotId" + } + }, + "FastSnapshotRestoreStateErrors": { + "target": "com.amazonaws.ec2#DisableFastSnapshotRestoreStateErrorSet", + "traits": { + "aws.protocols#ec2QueryName": "FastSnapshotRestoreStateErrorSet", + "smithy.api#documentation": "

The errors.

", + "smithy.api#xmlName": "fastSnapshotRestoreStateErrorSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the errors that occurred when disabling fast snapshot restores.

" + } + }, + "com.amazonaws.ec2#DisableFastSnapshotRestoreErrorSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#DisableFastSnapshotRestoreErrorItem", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#DisableFastSnapshotRestoreStateError": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The error code.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

The error message.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an error that occurred when disabling fast snapshot restores.

" + } + }, + "com.amazonaws.ec2#DisableFastSnapshotRestoreStateErrorItem": { + "type": "structure", + "members": { + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "Error": { + "target": "com.amazonaws.ec2#DisableFastSnapshotRestoreStateError", + "traits": { + "aws.protocols#ec2QueryName": "Error", + "smithy.api#documentation": "

The error.

", + "smithy.api#xmlName": "error" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about an error that occurred when disabling fast snapshot restores.

" + } + }, + "com.amazonaws.ec2#DisableFastSnapshotRestoreStateErrorSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#DisableFastSnapshotRestoreStateErrorItem", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#DisableFastSnapshotRestoreSuccessItem": { + "type": "structure", + "members": { + "SnapshotId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The ID of the snapshot.

", + "smithy.api#xmlName": "snapshotId" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "State": { + "target": "com.amazonaws.ec2#FastSnapshotRestoreStateCode", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of fast snapshot restores for the snapshot.

", + "smithy.api#xmlName": "state" + } + }, + "StateTransitionReason": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StateTransitionReason", + "smithy.api#documentation": "

The reason for the state transition. The possible values are as follows:

\n ", + "smithy.api#xmlName": "stateTransitionReason" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that enabled fast snapshot restores on the snapshot.

", + "smithy.api#xmlName": "ownerId" + } + }, + "OwnerAlias": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerAlias", + "smithy.api#documentation": "

The Amazon Web Services owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use.

", + "smithy.api#xmlName": "ownerAlias" + } + }, + "EnablingTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "EnablingTime", + "smithy.api#documentation": "

The time at which fast snapshot restores entered the enabling state.

", + "smithy.api#xmlName": "enablingTime" + } + }, + "OptimizingTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "OptimizingTime", + "smithy.api#documentation": "

The time at which fast snapshot restores entered the optimizing state.

", + "smithy.api#xmlName": "optimizingTime" + } + }, + "EnabledTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "EnabledTime", + "smithy.api#documentation": "

The time at which fast snapshot restores entered the enabled state.

", + "smithy.api#xmlName": "enabledTime" + } + }, + "DisablingTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "DisablingTime", + "smithy.api#documentation": "

The time at which fast snapshot restores entered the disabling state.

", + "smithy.api#xmlName": "disablingTime" + } + }, + "DisabledTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "DisabledTime", + "smithy.api#documentation": "

The time at which fast snapshot restores entered the disabled state.

", + "smithy.api#xmlName": "disabledTime" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes fast snapshot restores that were successfully disabled.

" + } + }, + "com.amazonaws.ec2#DisableFastSnapshotRestoreSuccessSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#DisableFastSnapshotRestoreSuccessItem", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#DisableFastSnapshotRestores": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisableFastSnapshotRestoresRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisableFastSnapshotRestoresResult" + }, + "traits": { + "smithy.api#documentation": "

Disables fast snapshot restores for the specified snapshots in the specified Availability Zones.

" + } + }, + "com.amazonaws.ec2#DisableFastSnapshotRestoresRequest": { + "type": "structure", + "members": { + "AvailabilityZones": { + "target": "com.amazonaws.ec2#AvailabilityZoneStringList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

One or more Availability Zones. For example, us-east-2a.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "AvailabilityZone" + } + }, + "SourceSnapshotIds": { + "target": "com.amazonaws.ec2#SnapshotIdStringList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of one or more snapshots. For example, snap-1234567890abcdef0.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "SourceSnapshotId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisableFastSnapshotRestoresResult": { + "type": "structure", + "members": { + "Successful": { + "target": "com.amazonaws.ec2#DisableFastSnapshotRestoreSuccessSet", + "traits": { + "aws.protocols#ec2QueryName": "Successful", + "smithy.api#documentation": "

Information about the snapshots for which fast snapshot restores were successfully disabled.

", + "smithy.api#xmlName": "successful" + } + }, + "Unsuccessful": { + "target": "com.amazonaws.ec2#DisableFastSnapshotRestoreErrorSet", + "traits": { + "aws.protocols#ec2QueryName": "Unsuccessful", + "smithy.api#documentation": "

Information about the snapshots for which fast snapshot restores could not be disabled.

", + "smithy.api#xmlName": "unsuccessful" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisableImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisableImageRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisableImageResult" + }, + "traits": { + "smithy.api#documentation": "

Sets the AMI state to disabled and removes all launch permissions from the\n AMI. A disabled AMI can't be used for instance launches.

\n

A disabled AMI can't be shared. If an AMI was public or previously shared, it is made\n private. If an AMI was shared with an Amazon Web Services account, organization, or Organizational Unit,\n they lose access to the disabled AMI.

\n

A disabled AMI does not appear in DescribeImages API calls by\n default.

\n

Only the AMI owner can disable an AMI.

\n

You can re-enable a disabled AMI using EnableImage.

\n

For more information, see Disable an AMI in the\n Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#DisableImageBlockPublicAccess": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisableImageBlockPublicAccessRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisableImageBlockPublicAccessResult" + }, + "traits": { + "smithy.api#documentation": "

Disables block public access for AMIs at the account level in the\n specified Amazon Web Services Region. This removes the block public access restriction\n from your account. With the restriction removed, you can publicly share your AMIs in the\n specified Amazon Web Services Region.

\n

The API can take up to 10 minutes to configure this setting. During this time, if you run\n GetImageBlockPublicAccessState, the response will be\n block-new-sharing. When the API has completed the configuration, the response\n will be unblocked.

\n

For more information, see Block\n public access to your AMIs in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#DisableImageBlockPublicAccessRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisableImageBlockPublicAccessResult": { + "type": "structure", + "members": { + "ImageBlockPublicAccessState": { + "target": "com.amazonaws.ec2#ImageBlockPublicAccessDisabledState", + "traits": { + "aws.protocols#ec2QueryName": "ImageBlockPublicAccessState", + "smithy.api#documentation": "

Returns unblocked if the request succeeds; otherwise, it returns an\n error.

", + "smithy.api#xmlName": "imageBlockPublicAccessState" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisableImageDeprecation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisableImageDeprecationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisableImageDeprecationResult" + }, + "traits": { + "smithy.api#documentation": "

Cancels the deprecation of the specified AMI.

\n

For more information, see Deprecate an AMI in the\n Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#DisableImageDeprecationRequest": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the AMI.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisableImageDeprecationResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisableImageDeregistrationProtection": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisableImageDeregistrationProtectionRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisableImageDeregistrationProtectionResult" + }, + "traits": { + "smithy.api#documentation": "

Disables deregistration protection for an AMI. When deregistration protection is disabled,\n the AMI can be deregistered.

\n

If you chose to include a 24-hour cooldown period when you enabled deregistration\n protection for the AMI, then, when you disable deregistration protection, you won’t\n immediately be able to deregister the AMI.

\n

For more information, see Protect an\n AMI from deregistration in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#DisableImageDeregistrationProtectionRequest": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the AMI.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisableImageDeregistrationProtectionResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisableImageRequest": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the AMI.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisableImageResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisableIpamOrganizationAdminAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisableIpamOrganizationAdminAccountRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisableIpamOrganizationAdminAccountResult" + }, + "traits": { + "smithy.api#documentation": "

Disable the IPAM account. For more information, see Enable integration with Organizations in the Amazon VPC IPAM User Guide.\n

" + } + }, + "com.amazonaws.ec2#DisableIpamOrganizationAdminAccountRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "DelegatedAdminAccountId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Organizations member account ID that you want to disable as IPAM account.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisableIpamOrganizationAdminAccountResult": { + "type": "structure", + "members": { + "Success": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Success", + "smithy.api#documentation": "

The result of disabling the IPAM account.

", + "smithy.api#xmlName": "success" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisableSerialConsoleAccess": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisableSerialConsoleAccessRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisableSerialConsoleAccessResult" + }, + "traits": { + "smithy.api#documentation": "

Disables access to the EC2 serial console of all instances for your account. By default,\n\t\t\taccess to the EC2 serial console is disabled for your account. For more information, see\n\t\t\t\tManage account access to the EC2 serial console in the Amazon EC2\n\t\t\t\tUser Guide.

" + } + }, + "com.amazonaws.ec2#DisableSerialConsoleAccessRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisableSerialConsoleAccessResult": { + "type": "structure", + "members": { + "SerialConsoleAccessEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "SerialConsoleAccessEnabled", + "smithy.api#documentation": "

If true, access to the EC2 serial console of all instances is enabled for\n\t\t\tyour account. If false, access to the EC2 serial console of all instances\n\t\t\tis disabled for your account.

", + "smithy.api#xmlName": "serialConsoleAccessEnabled" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisableSnapshotBlockPublicAccess": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisableSnapshotBlockPublicAccessRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisableSnapshotBlockPublicAccessResult" + }, + "traits": { + "smithy.api#documentation": "

Disables the block public access for snapshots setting at \n the account level for the specified Amazon Web Services Region. After you disable block public \n access for snapshots in a Region, users can publicly share snapshots in that Region.

\n \n

Enabling block public access for snapshots in block-all-sharing \n mode does not change the permissions for snapshots that are already publicly shared. \n Instead, it prevents these snapshots from be publicly visible and publicly accessible. \n Therefore, the attributes for these snapshots still indicate that they are publicly \n shared, even though they are not publicly available.

\n

If you disable block public access , these snapshots will become publicly available \n again.

\n \n

For more information, see \n Block public access for snapshots in the Amazon EBS User Guide .

\n

" + } + }, + "com.amazonaws.ec2#DisableSnapshotBlockPublicAccessRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisableSnapshotBlockPublicAccessResult": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.ec2#SnapshotBlockPublicAccessState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

Returns unblocked if the request succeeds.

", + "smithy.api#xmlName": "state" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisableTransitGatewayRouteTablePropagation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisableTransitGatewayRouteTablePropagationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisableTransitGatewayRouteTablePropagationResult" + }, + "traits": { + "smithy.api#documentation": "

Disables the specified resource attachment from propagating routes to the specified\n propagation route table.

" + } + }, + "com.amazonaws.ec2#DisableTransitGatewayRouteTablePropagationRequest": { + "type": "structure", + "members": { + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the propagation route table.

", + "smithy.api#required": {} + } + }, + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#documentation": "

The ID of the attachment.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "TransitGatewayRouteTableAnnouncementId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementId", + "traits": { + "smithy.api#documentation": "

The ID of the route table announcement.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisableTransitGatewayRouteTablePropagationResult": { + "type": "structure", + "members": { + "Propagation": { + "target": "com.amazonaws.ec2#TransitGatewayPropagation", + "traits": { + "aws.protocols#ec2QueryName": "Propagation", + "smithy.api#documentation": "

Information about route propagation.

", + "smithy.api#xmlName": "propagation" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisableVgwRoutePropagation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisableVgwRoutePropagationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Disables a virtual private gateway (VGW) from propagating routes to a specified route\n table of a VPC.

", + "smithy.api#examples": [ + { + "title": "To disable route propagation", + "documentation": "This example disables the specified virtual private gateway from propagating static routes to the specified route table.", + "input": { + "RouteTableId": "rtb-22574640", + "GatewayId": "vgw-9a4cacf3" + } + } + ] + } + }, + "com.amazonaws.ec2#DisableVgwRoutePropagationRequest": { + "type": "structure", + "members": { + "GatewayId": { + "target": "com.amazonaws.ec2#VpnGatewayId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the virtual private gateway.

", + "smithy.api#required": {} + } + }, + "RouteTableId": { + "target": "com.amazonaws.ec2#RouteTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the route table.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DisableVgwRoutePropagation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisableVpcClassicLink": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisableVpcClassicLinkRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisableVpcClassicLinkResult" + }, + "traits": { + "smithy.api#documentation": "\n

This action is deprecated.

\n \n

Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances\n linked to it.

" + } + }, + "com.amazonaws.ec2#DisableVpcClassicLinkDnsSupport": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisableVpcClassicLinkDnsSupportRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisableVpcClassicLinkDnsSupportResult" + }, + "traits": { + "smithy.api#documentation": "\n

This action is deprecated.

\n \n

Disables ClassicLink DNS support for a VPC. If disabled, DNS hostnames resolve to\n\t\t\tpublic IP addresses when addressed between a linked EC2-Classic instance and instances\n\t\t\tin the VPC to which it's linked.

\n

You must specify a VPC ID in the request.

" + } + }, + "com.amazonaws.ec2#DisableVpcClassicLinkDnsSupportRequest": { + "type": "structure", + "members": { + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "VpcId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisableVpcClassicLinkDnsSupportResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisableVpcClassicLinkRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "vpcId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisableVpcClassicLinkResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisassociateAddress": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisassociateAddressRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Disassociates an Elastic IP address from the instance or network interface it's associated with.

\n

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

", + "smithy.api#examples": [ + { + "title": "To disassociate an Elastic IP address", + "documentation": "This example disassociates an Elastic IP address from an instance.", + "input": { + "AssociationId": "eipassoc-2bebb745" + } + } + ] + } + }, + "com.amazonaws.ec2#DisassociateAddressRequest": { + "type": "structure", + "members": { + "AssociationId": { + "target": "com.amazonaws.ec2#ElasticIpAssociationId", + "traits": { + "smithy.api#documentation": "

The association ID. This parameter is required.

" + } + }, + "PublicIp": { + "target": "com.amazonaws.ec2#EipAllocationPublicIp", + "traits": { + "smithy.api#documentation": "

Deprecated.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisassociateCapacityReservationBillingOwner": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisassociateCapacityReservationBillingOwnerRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisassociateCapacityReservationBillingOwnerResult" + }, + "traits": { + "smithy.api#documentation": "

Cancels a pending request to assign billing of the unused capacity of a Capacity\n\t\t\tReservation to a consumer account, or revokes a request that has already been accepted.\n\t\t\tFor more information, see Billing assignment for shared\n\t\t\t\t\tAmazon EC2 Capacity Reservations.

" + } + }, + "com.amazonaws.ec2#DisassociateCapacityReservationBillingOwnerRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "CapacityReservationId": { + "target": "com.amazonaws.ec2#CapacityReservationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Capacity Reservation.

", + "smithy.api#required": {} + } + }, + "UnusedReservationBillingOwnerId": { + "target": "com.amazonaws.ec2#AccountID", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the consumer account to which the request was sent.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisassociateCapacityReservationBillingOwnerResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisassociateClientVpnTargetNetwork": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisassociateClientVpnTargetNetworkRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisassociateClientVpnTargetNetworkResult" + }, + "traits": { + "smithy.api#documentation": "

Disassociates a target network from the specified Client VPN endpoint. When you disassociate the \n\t\t\tlast target network from a Client VPN, the following happens:

\n " + } + }, + "com.amazonaws.ec2#DisassociateClientVpnTargetNetworkRequest": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#ClientVpnEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Client VPN endpoint from which to disassociate the target network.

", + "smithy.api#required": {} + } + }, + "AssociationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the target network association.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisassociateClientVpnTargetNetworkResult": { + "type": "structure", + "members": { + "AssociationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AssociationId", + "smithy.api#documentation": "

The ID of the target network association.

", + "smithy.api#xmlName": "associationId" + } + }, + "Status": { + "target": "com.amazonaws.ec2#AssociationStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The current state of the target network association.

", + "smithy.api#xmlName": "status" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisassociateEnclaveCertificateIamRole": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisassociateEnclaveCertificateIamRoleRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisassociateEnclaveCertificateIamRoleResult" + }, + "traits": { + "smithy.api#documentation": "

Disassociates an IAM role from an Certificate Manager (ACM) certificate. Disassociating an IAM role \n\t\t\tfrom an ACM certificate removes the Amazon S3 object that contains the certificate, certificate chain, and \n\t\t\tencrypted private key from the Amazon S3 bucket. It also revokes the IAM role's permission to use the\n\t\t\tKMS key used to encrypt the private key. This effectively revokes the role's permission \n\t\t\tto use the certificate.

" + } + }, + "com.amazonaws.ec2#DisassociateEnclaveCertificateIamRoleRequest": { + "type": "structure", + "members": { + "CertificateArn": { + "target": "com.amazonaws.ec2#CertificateId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the ACM certificate from which to disassociate the IAM role.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.ec2#RoleId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the IAM role to disassociate.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisassociateEnclaveCertificateIamRoleResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisassociateIamInstanceProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisassociateIamInstanceProfileRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisassociateIamInstanceProfileResult" + }, + "traits": { + "smithy.api#documentation": "

Disassociates an IAM instance profile from a running or stopped instance.

\n

Use DescribeIamInstanceProfileAssociations to get the association\n ID.

", + "smithy.api#examples": [ + { + "title": "To disassociate an IAM instance profile", + "documentation": "This example disassociates the specified IAM instance profile from an instance.", + "input": { + "AssociationId": "iip-assoc-05020b59952902f5f" + }, + "output": { + "IamInstanceProfileAssociation": { + "InstanceId": "i-123456789abcde123", + "State": "disassociating", + "AssociationId": "iip-assoc-05020b59952902f5f", + "IamInstanceProfile": { + "Id": "AIPAI5IVIHMFFYY2DKV5Y", + "Arn": "arn:aws:iam::123456789012:instance-profile/admin-role" + } + } + } + } + ] + } + }, + "com.amazonaws.ec2#DisassociateIamInstanceProfileRequest": { + "type": "structure", + "members": { + "AssociationId": { + "target": "com.amazonaws.ec2#IamInstanceProfileAssociationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the IAM instance profile association.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisassociateIamInstanceProfileResult": { + "type": "structure", + "members": { + "IamInstanceProfileAssociation": { + "target": "com.amazonaws.ec2#IamInstanceProfileAssociation", + "traits": { + "aws.protocols#ec2QueryName": "IamInstanceProfileAssociation", + "smithy.api#documentation": "

Information about the IAM instance profile association.

", + "smithy.api#xmlName": "iamInstanceProfileAssociation" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisassociateInstanceEventWindow": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisassociateInstanceEventWindowRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisassociateInstanceEventWindowResult" + }, + "traits": { + "smithy.api#documentation": "

Disassociates one or more targets from an event window.

\n

For more information, see Define event windows for scheduled\n events in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#DisassociateInstanceEventWindowRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "InstanceEventWindowId": { + "target": "com.amazonaws.ec2#InstanceEventWindowId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the event window.

", + "smithy.api#required": {} + } + }, + "AssociationTarget": { + "target": "com.amazonaws.ec2#InstanceEventWindowDisassociationRequest", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

One or more targets to disassociate from the specified event window.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisassociateInstanceEventWindowResult": { + "type": "structure", + "members": { + "InstanceEventWindow": { + "target": "com.amazonaws.ec2#InstanceEventWindow", + "traits": { + "aws.protocols#ec2QueryName": "InstanceEventWindow", + "smithy.api#documentation": "

Information about the event window.

", + "smithy.api#xmlName": "instanceEventWindow" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisassociateIpamByoasn": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisassociateIpamByoasnRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisassociateIpamByoasnResult" + }, + "traits": { + "smithy.api#documentation": "

Remove the association between your Autonomous System Number (ASN) and your BYOIP CIDR. You may want to use this action to disassociate an ASN from a CIDR or if you want to swap ASNs. \n For more information, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide.

" + } + }, + "com.amazonaws.ec2#DisassociateIpamByoasnRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Asn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A public 2-byte or 4-byte ASN.

", + "smithy.api#required": {} + } + }, + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A BYOIP CIDR.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisassociateIpamByoasnResult": { + "type": "structure", + "members": { + "AsnAssociation": { + "target": "com.amazonaws.ec2#AsnAssociation", + "traits": { + "aws.protocols#ec2QueryName": "AsnAssociation", + "smithy.api#documentation": "

An ASN and BYOIP CIDR association.

", + "smithy.api#xmlName": "asnAssociation" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisassociateIpamResourceDiscovery": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisassociateIpamResourceDiscoveryRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisassociateIpamResourceDiscoveryResult" + }, + "traits": { + "smithy.api#documentation": "

Disassociates a resource discovery from an Amazon VPC IPAM. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

" + } + }, + "com.amazonaws.ec2#DisassociateIpamResourceDiscoveryRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamResourceDiscoveryAssociationId": { + "target": "com.amazonaws.ec2#IpamResourceDiscoveryAssociationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A resource discovery association ID.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisassociateIpamResourceDiscoveryResult": { + "type": "structure", + "members": { + "IpamResourceDiscoveryAssociation": { + "target": "com.amazonaws.ec2#IpamResourceDiscoveryAssociation", + "traits": { + "aws.protocols#ec2QueryName": "IpamResourceDiscoveryAssociation", + "smithy.api#documentation": "

A resource discovery association.

", + "smithy.api#xmlName": "ipamResourceDiscoveryAssociation" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisassociateNatGatewayAddress": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisassociateNatGatewayAddressRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisassociateNatGatewayAddressResult" + }, + "traits": { + "smithy.api#documentation": "

Disassociates secondary Elastic IP addresses (EIPs) from a public NAT gateway. \n You cannot disassociate your primary EIP. For more information, see Edit secondary IP address associations in the Amazon VPC User Guide.

\n

While disassociating is in progress, you cannot associate/disassociate additional EIPs while the connections are being drained. You are, however, allowed to delete the NAT gateway.

\n

An EIP is released only at the end of MaxDrainDurationSeconds. It stays\n associated and supports the existing connections but does not support any new connections\n (new connections are distributed across the remaining associated EIPs). As the existing\n connections drain out, the EIPs (and the corresponding private IP addresses mapped to them) \n are released.

" + } + }, + "com.amazonaws.ec2#DisassociateNatGatewayAddressRequest": { + "type": "structure", + "members": { + "NatGatewayId": { + "target": "com.amazonaws.ec2#NatGatewayId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the NAT gateway.

", + "smithy.api#required": {} + } + }, + "AssociationIds": { + "target": "com.amazonaws.ec2#EipAssociationIdList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The association IDs of EIPs that have been associated with the NAT gateway.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "AssociationId" + } + }, + "MaxDrainDurationSeconds": { + "target": "com.amazonaws.ec2#DrainSeconds", + "traits": { + "smithy.api#documentation": "

The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress. Default value is 350 seconds.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisassociateNatGatewayAddressResult": { + "type": "structure", + "members": { + "NatGatewayId": { + "target": "com.amazonaws.ec2#NatGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "NatGatewayId", + "smithy.api#documentation": "

The ID of the NAT gateway.

", + "smithy.api#xmlName": "natGatewayId" + } + }, + "NatGatewayAddresses": { + "target": "com.amazonaws.ec2#NatGatewayAddressList", + "traits": { + "aws.protocols#ec2QueryName": "NatGatewayAddressSet", + "smithy.api#documentation": "

Information about the NAT gateway IP addresses.

", + "smithy.api#xmlName": "natGatewayAddressSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisassociateRouteTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisassociateRouteTableRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Disassociates a subnet or gateway from a route table.

\n

After you perform this action, the subnet no longer uses the routes in the route table.\n\t\t\t\tInstead, it uses the routes in the VPC's main route table. For more information\n\t\t\t\tabout route tables, see Route\n\t\t\t\ttables in the Amazon VPC User Guide.

", + "smithy.api#examples": [ + { + "title": "To disassociate a route table", + "documentation": "This example disassociates the specified route table from its associated subnet.", + "input": { + "AssociationId": "rtbassoc-781d0d1a" + } + } + ] + } + }, + "com.amazonaws.ec2#DisassociateRouteTableRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "AssociationId": { + "target": "com.amazonaws.ec2#RouteTableAssociationId", + "traits": { + "aws.protocols#ec2QueryName": "AssociationId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The association ID representing the current association between the route table and subnet or gateway.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "associationId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisassociateSecurityGroupVpc": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisassociateSecurityGroupVpcRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisassociateSecurityGroupVpcResult" + }, + "traits": { + "smithy.api#documentation": "

Disassociates a security group from a VPC. You cannot disassociate the security group if any Elastic network interfaces in the associated VPC are still associated with the security group.\n \n Note that the disassociation is asynchronous and you can check the status of the request with DescribeSecurityGroupVpcAssociations.

" + } + }, + "com.amazonaws.ec2#DisassociateSecurityGroupVpcRequest": { + "type": "structure", + "members": { + "GroupId": { + "target": "com.amazonaws.ec2#DisassociateSecurityGroupVpcSecurityGroupId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A security group ID.

", + "smithy.api#required": {} + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A VPC ID.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisassociateSecurityGroupVpcResult": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.ec2#SecurityGroupVpcAssociationState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the disassociation.

", + "smithy.api#xmlName": "state" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisassociateSecurityGroupVpcSecurityGroupId": { + "type": "string" + }, + "com.amazonaws.ec2#DisassociateSubnetCidrBlock": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisassociateSubnetCidrBlockRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisassociateSubnetCidrBlockResult" + }, + "traits": { + "smithy.api#documentation": "

Disassociates a CIDR block from a subnet. Currently, you can disassociate an IPv6 CIDR block only. You must detach or delete all gateways and resources that are associated with the CIDR block before you can disassociate it.

" + } + }, + "com.amazonaws.ec2#DisassociateSubnetCidrBlockRequest": { + "type": "structure", + "members": { + "AssociationId": { + "target": "com.amazonaws.ec2#SubnetCidrAssociationId", + "traits": { + "aws.protocols#ec2QueryName": "AssociationId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The association ID for the CIDR block.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "associationId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisassociateSubnetCidrBlockResult": { + "type": "structure", + "members": { + "Ipv6CidrBlockAssociation": { + "target": "com.amazonaws.ec2#SubnetIpv6CidrBlockAssociation", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6CidrBlockAssociation", + "smithy.api#documentation": "

Information about the IPv6 CIDR block association.

", + "smithy.api#xmlName": "ipv6CidrBlockAssociation" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet.

", + "smithy.api#xmlName": "subnetId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisassociateTransitGatewayMulticastDomain": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisassociateTransitGatewayMulticastDomainRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisassociateTransitGatewayMulticastDomainResult" + }, + "traits": { + "smithy.api#documentation": "

Disassociates the specified subnets from the transit gateway multicast domain.

" + } + }, + "com.amazonaws.ec2#DisassociateTransitGatewayMulticastDomainRequest": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

", + "smithy.api#required": {} + } + }, + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the attachment.

", + "smithy.api#required": {} + } + }, + "SubnetIds": { + "target": "com.amazonaws.ec2#TransitGatewaySubnetIdList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the subnets;

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisassociateTransitGatewayMulticastDomainResult": { + "type": "structure", + "members": { + "Associations": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainAssociations", + "traits": { + "aws.protocols#ec2QueryName": "Associations", + "smithy.api#documentation": "

Information about the association.

", + "smithy.api#xmlName": "associations" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisassociateTransitGatewayPolicyTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisassociateTransitGatewayPolicyTableRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisassociateTransitGatewayPolicyTableResult" + }, + "traits": { + "smithy.api#documentation": "

Removes the association between an an attachment and a policy table.

" + } + }, + "com.amazonaws.ec2#DisassociateTransitGatewayPolicyTableRequest": { + "type": "structure", + "members": { + "TransitGatewayPolicyTableId": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the disassociated policy table.

", + "smithy.api#required": {} + } + }, + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway attachment to disassociate from the policy table.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisassociateTransitGatewayPolicyTableResult": { + "type": "structure", + "members": { + "Association": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableAssociation", + "traits": { + "aws.protocols#ec2QueryName": "Association", + "smithy.api#documentation": "

Returns details about the transit gateway policy table disassociation.

", + "smithy.api#xmlName": "association" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisassociateTransitGatewayRouteTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisassociateTransitGatewayRouteTableRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisassociateTransitGatewayRouteTableResult" + }, + "traits": { + "smithy.api#documentation": "

Disassociates a resource attachment from a transit gateway route table.

" + } + }, + "com.amazonaws.ec2#DisassociateTransitGatewayRouteTableRequest": { + "type": "structure", + "members": { + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway route table.

", + "smithy.api#required": {} + } + }, + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the attachment.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisassociateTransitGatewayRouteTableResult": { + "type": "structure", + "members": { + "Association": { + "target": "com.amazonaws.ec2#TransitGatewayAssociation", + "traits": { + "aws.protocols#ec2QueryName": "Association", + "smithy.api#documentation": "

Information about the association.

", + "smithy.api#xmlName": "association" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisassociateTrunkInterface": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisassociateTrunkInterfaceRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisassociateTrunkInterfaceResult" + }, + "traits": { + "smithy.api#documentation": "

Removes an association between a branch network interface with a trunk network interface.

" + } + }, + "com.amazonaws.ec2#DisassociateTrunkInterfaceRequest": { + "type": "structure", + "members": { + "AssociationId": { + "target": "com.amazonaws.ec2#TrunkInterfaceAssociationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the association

", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisassociateTrunkInterfaceResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n idempotency.

", + "smithy.api#xmlName": "clientToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisassociateVpcCidrBlock": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisassociateVpcCidrBlockRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisassociateVpcCidrBlockResult" + }, + "traits": { + "smithy.api#documentation": "

Disassociates a CIDR block from a VPC. To disassociate the CIDR block, you must\n specify its association ID. You can get the association ID by using\n DescribeVpcs. You must detach or delete all gateways and resources that\n are associated with the CIDR block before you can disassociate it.

\n

You cannot disassociate the CIDR block with which you originally created the VPC (the\n\t\t\tprimary CIDR block).

" + } + }, + "com.amazonaws.ec2#DisassociateVpcCidrBlockRequest": { + "type": "structure", + "members": { + "AssociationId": { + "target": "com.amazonaws.ec2#VpcCidrAssociationId", + "traits": { + "aws.protocols#ec2QueryName": "AssociationId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The association ID for the CIDR block.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "associationId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisassociateVpcCidrBlockResult": { + "type": "structure", + "members": { + "Ipv6CidrBlockAssociation": { + "target": "com.amazonaws.ec2#VpcIpv6CidrBlockAssociation", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6CidrBlockAssociation", + "smithy.api#documentation": "

Information about the IPv6 CIDR block association.

", + "smithy.api#xmlName": "ipv6CidrBlockAssociation" + } + }, + "CidrBlockAssociation": { + "target": "com.amazonaws.ec2#VpcCidrBlockAssociation", + "traits": { + "aws.protocols#ec2QueryName": "CidrBlockAssociation", + "smithy.api#documentation": "

Information about the IPv4 CIDR block association.

", + "smithy.api#xmlName": "cidrBlockAssociation" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "vpcId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DiskCount": { + "type": "integer" + }, + "com.amazonaws.ec2#DiskImage": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description of the disk image.

" + } + }, + "Image": { + "target": "com.amazonaws.ec2#DiskImageDetail", + "traits": { + "smithy.api#documentation": "

Information about the disk image.

" + } + }, + "Volume": { + "target": "com.amazonaws.ec2#VolumeDetail", + "traits": { + "smithy.api#documentation": "

Information about the volume.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a disk image.

" + } + }, + "com.amazonaws.ec2#DiskImageDescription": { + "type": "structure", + "members": { + "Checksum": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Checksum", + "smithy.api#documentation": "

The checksum computed for the disk image.

", + "smithy.api#xmlName": "checksum" + } + }, + "Format": { + "target": "com.amazonaws.ec2#DiskImageFormat", + "traits": { + "aws.protocols#ec2QueryName": "Format", + "smithy.api#documentation": "

The disk image format.

", + "smithy.api#xmlName": "format" + } + }, + "ImportManifestUrl": { + "target": "com.amazonaws.ec2#ImportManifestUrl", + "traits": { + "aws.protocols#ec2QueryName": "ImportManifestUrl", + "smithy.api#documentation": "

A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for\n an Amazon S3 object, read the \"Query String Request Authentication Alternative\" section of the Authenticating REST Requests topic in\n the Amazon Simple Storage Service Developer Guide.

\n

For information about the import manifest referenced by this API action, see VM Import Manifest.

", + "smithy.api#xmlName": "importManifestUrl" + } + }, + "Size": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "Size", + "smithy.api#documentation": "

The size of the disk image, in GiB.

", + "smithy.api#xmlName": "size" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a disk image.

" + } + }, + "com.amazonaws.ec2#DiskImageDetail": { + "type": "structure", + "members": { + "Format": { + "target": "com.amazonaws.ec2#DiskImageFormat", + "traits": { + "aws.protocols#ec2QueryName": "Format", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The disk image format.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "format" + } + }, + "Bytes": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "Bytes", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The size of the disk image, in GiB.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "bytes" + } + }, + "ImportManifestUrl": { + "target": "com.amazonaws.ec2#ImportManifestUrl", + "traits": { + "aws.protocols#ec2QueryName": "ImportManifestUrl", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL.\n For information about creating a presigned URL for an Amazon S3 object, read the \"Query String Request Authentication\n Alternative\" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer\n Guide.

\n

For information about the import manifest referenced by this API action, see VM Import Manifest.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "importManifestUrl" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a disk image.

" + } + }, + "com.amazonaws.ec2#DiskImageFormat": { + "type": "enum", + "members": { + "VMDK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VMDK" + } + }, + "RAW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RAW" + } + }, + "VHD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VHD" + } + } + } + }, + "com.amazonaws.ec2#DiskImageList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#DiskImage" + } + }, + "com.amazonaws.ec2#DiskImageVolumeDescription": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Id", + "smithy.api#documentation": "

The volume identifier.

", + "smithy.api#xmlName": "id" + } + }, + "Size": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "Size", + "smithy.api#documentation": "

The size of the volume, in GiB.

", + "smithy.api#xmlName": "size" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a disk image volume.

" + } + }, + "com.amazonaws.ec2#DiskInfo": { + "type": "structure", + "members": { + "SizeInGB": { + "target": "com.amazonaws.ec2#DiskSize", + "traits": { + "aws.protocols#ec2QueryName": "SizeInGB", + "smithy.api#documentation": "

The size of the disk in GB.

", + "smithy.api#xmlName": "sizeInGB" + } + }, + "Count": { + "target": "com.amazonaws.ec2#DiskCount", + "traits": { + "aws.protocols#ec2QueryName": "Count", + "smithy.api#documentation": "

The number of disks with this configuration.

", + "smithy.api#xmlName": "count" + } + }, + "Type": { + "target": "com.amazonaws.ec2#DiskType", + "traits": { + "aws.protocols#ec2QueryName": "Type", + "smithy.api#documentation": "

The type of disk.

", + "smithy.api#xmlName": "type" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a disk.

" + } + }, + "com.amazonaws.ec2#DiskInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#DiskInfo", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#DiskSize": { + "type": "long" + }, + "com.amazonaws.ec2#DiskType": { + "type": "enum", + "members": { + "hdd": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hdd" + } + }, + "ssd": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ssd" + } + } + } + }, + "com.amazonaws.ec2#DnsEntry": { + "type": "structure", + "members": { + "DnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DnsName", + "smithy.api#documentation": "

The DNS name.

", + "smithy.api#xmlName": "dnsName" + } + }, + "HostedZoneId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "HostedZoneId", + "smithy.api#documentation": "

The ID of the private hosted zone.

", + "smithy.api#xmlName": "hostedZoneId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a DNS entry.

" + } + }, + "com.amazonaws.ec2#DnsEntrySet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#DnsEntry", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#DnsNameState": { + "type": "enum", + "members": { + "PendingVerification": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pendingVerification" + } + }, + "Verified": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "verified" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + } + } + }, + "com.amazonaws.ec2#DnsOptions": { + "type": "structure", + "members": { + "DnsRecordIpType": { + "target": "com.amazonaws.ec2#DnsRecordIpType", + "traits": { + "aws.protocols#ec2QueryName": "DnsRecordIpType", + "smithy.api#documentation": "

The DNS records created for the endpoint.

", + "smithy.api#xmlName": "dnsRecordIpType" + } + }, + "PrivateDnsOnlyForInboundResolverEndpoint": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "PrivateDnsOnlyForInboundResolverEndpoint", + "smithy.api#documentation": "

Indicates whether to enable private DNS only for inbound endpoints.

", + "smithy.api#xmlName": "privateDnsOnlyForInboundResolverEndpoint" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the DNS options for an endpoint.

" + } + }, + "com.amazonaws.ec2#DnsOptionsSpecification": { + "type": "structure", + "members": { + "DnsRecordIpType": { + "target": "com.amazonaws.ec2#DnsRecordIpType", + "traits": { + "smithy.api#documentation": "

The DNS records created for the endpoint.

" + } + }, + "PrivateDnsOnlyForInboundResolverEndpoint": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether to enable private DNS only for inbound endpoints. This option is\n available only for services that support both gateway and interface endpoints. It routes\n traffic that originates from the VPC to the gateway endpoint and traffic that originates\n from on-premises to the interface endpoint.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the DNS options for an endpoint.

" + } + }, + "com.amazonaws.ec2#DnsRecordIpType": { + "type": "enum", + "members": { + "ipv4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv4" + } + }, + "dualstack": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dualstack" + } + }, + "ipv6": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv6" + } + }, + "service_defined": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "service-defined" + } + } + } + }, + "com.amazonaws.ec2#DnsServersOptionsModifyStructure": { + "type": "structure", + "members": { + "CustomDnsServers": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The IPv4 address range, in CIDR notation, of the DNS servers to be used. You can specify up to \n\t\t\ttwo DNS servers. Ensure that the DNS servers can be reached by the clients. The specified values \n\t\t\toverwrite the existing values.

" + } + }, + "Enabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether DNS servers should be used. Specify False to delete the existing DNS \n\t\t\tservers.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the DNS server to be used.

" + } + }, + "com.amazonaws.ec2#DnsSupportValue": { + "type": "enum", + "members": { + "enable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enable" + } + }, + "disable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disable" + } + } + } + }, + "com.amazonaws.ec2#DomainType": { + "type": "enum", + "members": { + "vpc": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vpc" + } + }, + "standard": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "standard" + } + } + } + }, + "com.amazonaws.ec2#Double": { + "type": "double" + }, + "com.amazonaws.ec2#DoubleWithConstraints": { + "type": "double", + "traits": { + "smithy.api#range": { + "min": 0.001, + "max": 99.999 + } + } + }, + "com.amazonaws.ec2#DrainSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 4000 + } + } + }, + "com.amazonaws.ec2#DynamicRoutingValue": { + "type": "enum", + "members": { + "enable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enable" + } + }, + "disable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disable" + } + } + } + }, + "com.amazonaws.ec2#EbsBlockDevice": { + "type": "structure", + "members": { + "DeleteOnTermination": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DeleteOnTermination", + "smithy.api#documentation": "

Indicates whether the EBS volume is deleted on instance termination. For more\n information, see Preserving Amazon EBS volumes on instance termination in the\n Amazon EC2 User Guide.

", + "smithy.api#xmlName": "deleteOnTermination" + } + }, + "Iops": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Iops", + "smithy.api#documentation": "

The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes,\n this represents the number of IOPS that are provisioned for the volume. For gp2\n volumes, this represents the baseline performance of the volume and the rate at which\n the volume accumulates I/O credits for bursting.

\n

The following are the supported values for each volume type:

\n \n

For io2 volumes, you can achieve up to 256,000 IOPS on \ninstances \nbuilt on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.

\n

This parameter is required for io1 and io2 volumes. The default for gp3 volumes\n is 3,000 IOPS.

", + "smithy.api#xmlName": "iops" + } + }, + "SnapshotId": { + "target": "com.amazonaws.ec2#SnapshotId", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The ID of the snapshot.

", + "smithy.api#xmlName": "snapshotId" + } + }, + "VolumeSize": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "VolumeSize", + "smithy.api#documentation": "

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume\n size. If you specify a snapshot, the default is the snapshot size. You can specify a\n volume size that is equal to or larger than the snapshot size.

\n

The following are the supported sizes for each volume type:

\n ", + "smithy.api#xmlName": "volumeSize" + } + }, + "VolumeType": { + "target": "com.amazonaws.ec2#VolumeType", + "traits": { + "aws.protocols#ec2QueryName": "VolumeType", + "smithy.api#documentation": "

The volume type. For more information, see Amazon EBS volume types in the\n Amazon EBS User Guide.

", + "smithy.api#xmlName": "volumeType" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KmsKeyId", + "smithy.api#documentation": "

Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key \n to use for EBS encryption.

\n

This parameter is only supported on BlockDeviceMapping objects called by\n RunInstances, RequestSpotFleet,\n and RequestSpotInstances.

", + "smithy.api#xmlName": "kmsKeyId" + } + }, + "Throughput": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Throughput", + "smithy.api#documentation": "

The throughput that the volume supports, in MiB/s.

\n

This parameter is valid only for gp3 volumes.

\n

Valid Range: Minimum value of 125. Maximum value of 1000.

", + "smithy.api#xmlName": "throughput" + } + }, + "OutpostArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OutpostArn", + "smithy.api#documentation": "

The ARN of the Outpost on which the snapshot is stored.

\n

This parameter is not supported when using CreateImage.

", + "smithy.api#xmlName": "outpostArn" + } + }, + "Encrypted": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Encrypted", + "smithy.api#documentation": "

Indicates whether the encryption state of an EBS volume is changed while being\n restored from a backing snapshot. The effect of setting the encryption state to true depends on \nthe volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.

\n

In no case can you remove encryption from an encrypted volume.

\n

Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For\n more information, see Supported instance types.

\n

This parameter is not returned by DescribeImageAttribute.

\n

For CreateImage and RegisterImage, whether you can \n include this parameter, and the allowed values differ depending on the type of block \n device mapping you are creating.

\n ", + "smithy.api#xmlName": "encrypted" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a block device for an EBS volume.

" + } + }, + "com.amazonaws.ec2#EbsEncryptionSupport": { + "type": "enum", + "members": { + "unsupported": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unsupported" + } + }, + "supported": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "supported" + } + } + } + }, + "com.amazonaws.ec2#EbsInfo": { + "type": "structure", + "members": { + "EbsOptimizedSupport": { + "target": "com.amazonaws.ec2#EbsOptimizedSupport", + "traits": { + "aws.protocols#ec2QueryName": "EbsOptimizedSupport", + "smithy.api#documentation": "

Indicates whether the instance type is Amazon EBS-optimized. For more information, see Amazon EBS-optimized\n instances in Amazon EC2 User Guide.

", + "smithy.api#xmlName": "ebsOptimizedSupport" + } + }, + "EncryptionSupport": { + "target": "com.amazonaws.ec2#EbsEncryptionSupport", + "traits": { + "aws.protocols#ec2QueryName": "EncryptionSupport", + "smithy.api#documentation": "

Indicates whether Amazon EBS encryption is supported.

", + "smithy.api#xmlName": "encryptionSupport" + } + }, + "EbsOptimizedInfo": { + "target": "com.amazonaws.ec2#EbsOptimizedInfo", + "traits": { + "aws.protocols#ec2QueryName": "EbsOptimizedInfo", + "smithy.api#documentation": "

Describes the optimized EBS performance for the instance type.

", + "smithy.api#xmlName": "ebsOptimizedInfo" + } + }, + "NvmeSupport": { + "target": "com.amazonaws.ec2#EbsNvmeSupport", + "traits": { + "aws.protocols#ec2QueryName": "NvmeSupport", + "smithy.api#documentation": "

Indicates whether non-volatile memory express (NVMe) is supported.

", + "smithy.api#xmlName": "nvmeSupport" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the Amazon EBS features supported by the instance type.

" + } + }, + "com.amazonaws.ec2#EbsInstanceBlockDevice": { + "type": "structure", + "members": { + "AttachTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "AttachTime", + "smithy.api#documentation": "

The time stamp when the attachment initiated.

", + "smithy.api#xmlName": "attachTime" + } + }, + "DeleteOnTermination": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DeleteOnTermination", + "smithy.api#documentation": "

Indicates whether the volume is deleted on instance termination.

", + "smithy.api#xmlName": "deleteOnTermination" + } + }, + "Status": { + "target": "com.amazonaws.ec2#AttachmentStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The attachment state.

", + "smithy.api#xmlName": "status" + } + }, + "VolumeId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VolumeId", + "smithy.api#documentation": "

The ID of the EBS volume.

", + "smithy.api#xmlName": "volumeId" + } + }, + "AssociatedResource": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AssociatedResource", + "smithy.api#documentation": "

The ARN of the Amazon ECS or Fargate task \n to which the volume is attached.

", + "smithy.api#xmlName": "associatedResource" + } + }, + "VolumeOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VolumeOwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the volume.

\n

This parameter is returned only for volumes that are attached to \n Fargate tasks.

", + "smithy.api#xmlName": "volumeOwnerId" + } + }, + "Operator": { + "target": "com.amazonaws.ec2#OperatorResponse", + "traits": { + "aws.protocols#ec2QueryName": "Operator", + "smithy.api#documentation": "

The service provider that manages the EBS volume.

", + "smithy.api#xmlName": "operator" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a parameter used to set up an EBS volume in a block device mapping.

" + } + }, + "com.amazonaws.ec2#EbsInstanceBlockDeviceSpecification": { + "type": "structure", + "members": { + "VolumeId": { + "target": "com.amazonaws.ec2#VolumeId", + "traits": { + "aws.protocols#ec2QueryName": "VolumeId", + "smithy.api#documentation": "

The ID of the EBS volume.

", + "smithy.api#xmlName": "volumeId" + } + }, + "DeleteOnTermination": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DeleteOnTermination", + "smithy.api#documentation": "

Indicates whether the volume is deleted on instance termination.

", + "smithy.api#xmlName": "deleteOnTermination" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes information used to set up an EBS volume specified in a block device\n mapping.

" + } + }, + "com.amazonaws.ec2#EbsNvmeSupport": { + "type": "enum", + "members": { + "UNSUPPORTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unsupported" + } + }, + "SUPPORTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "supported" + } + }, + "REQUIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "required" + } + } + } + }, + "com.amazonaws.ec2#EbsOptimizedInfo": { + "type": "structure", + "members": { + "BaselineBandwidthInMbps": { + "target": "com.amazonaws.ec2#BaselineBandwidthInMbps", + "traits": { + "aws.protocols#ec2QueryName": "BaselineBandwidthInMbps", + "smithy.api#documentation": "

The baseline bandwidth performance for an EBS-optimized instance type, in Mbps.

", + "smithy.api#xmlName": "baselineBandwidthInMbps" + } + }, + "BaselineThroughputInMBps": { + "target": "com.amazonaws.ec2#BaselineThroughputInMBps", + "traits": { + "aws.protocols#ec2QueryName": "BaselineThroughputInMBps", + "smithy.api#documentation": "

The baseline throughput performance for an EBS-optimized instance type, in MB/s.

", + "smithy.api#xmlName": "baselineThroughputInMBps" + } + }, + "BaselineIops": { + "target": "com.amazonaws.ec2#BaselineIops", + "traits": { + "aws.protocols#ec2QueryName": "BaselineIops", + "smithy.api#documentation": "

The baseline input/output storage operations per seconds for an EBS-optimized instance\n type.

", + "smithy.api#xmlName": "baselineIops" + } + }, + "MaximumBandwidthInMbps": { + "target": "com.amazonaws.ec2#MaximumBandwidthInMbps", + "traits": { + "aws.protocols#ec2QueryName": "MaximumBandwidthInMbps", + "smithy.api#documentation": "

The maximum bandwidth performance for an EBS-optimized instance type, in Mbps.

", + "smithy.api#xmlName": "maximumBandwidthInMbps" + } + }, + "MaximumThroughputInMBps": { + "target": "com.amazonaws.ec2#MaximumThroughputInMBps", + "traits": { + "aws.protocols#ec2QueryName": "MaximumThroughputInMBps", + "smithy.api#documentation": "

The maximum throughput performance for an EBS-optimized instance type, in MB/s.

", + "smithy.api#xmlName": "maximumThroughputInMBps" + } + }, + "MaximumIops": { + "target": "com.amazonaws.ec2#MaximumIops", + "traits": { + "aws.protocols#ec2QueryName": "MaximumIops", + "smithy.api#documentation": "

The maximum input/output storage operations per second for an EBS-optimized instance\n type.

", + "smithy.api#xmlName": "maximumIops" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the optimized EBS performance for supported instance types.

" + } + }, + "com.amazonaws.ec2#EbsOptimizedSupport": { + "type": "enum", + "members": { + "unsupported": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unsupported" + } + }, + "supported": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "supported" + } + }, + "default": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "default" + } + } + } + }, + "com.amazonaws.ec2#EbsStatusDetails": { + "type": "structure", + "members": { + "ImpairedSince": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "ImpairedSince", + "smithy.api#documentation": "

The date and time when the attached EBS status check failed.

", + "smithy.api#xmlName": "impairedSince" + } + }, + "Name": { + "target": "com.amazonaws.ec2#StatusName", + "traits": { + "aws.protocols#ec2QueryName": "Name", + "smithy.api#documentation": "

The name of the attached EBS status check.

", + "smithy.api#xmlName": "name" + } + }, + "Status": { + "target": "com.amazonaws.ec2#StatusType", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The result of the attached EBS status check.

", + "smithy.api#xmlName": "status" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the attached EBS status check for an instance.

" + } + }, + "com.amazonaws.ec2#EbsStatusDetailsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#EbsStatusDetails", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#EbsStatusSummary": { + "type": "structure", + "members": { + "Details": { + "target": "com.amazonaws.ec2#EbsStatusDetailsList", + "traits": { + "aws.protocols#ec2QueryName": "Details", + "smithy.api#documentation": "

Details about the attached EBS status check for an instance.

", + "smithy.api#xmlName": "details" + } + }, + "Status": { + "target": "com.amazonaws.ec2#SummaryStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The current status.

", + "smithy.api#xmlName": "status" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides a summary of the attached EBS volume status for an instance.

" + } + }, + "com.amazonaws.ec2#Ec2InstanceConnectEndpoint": { + "type": "structure", + "members": { + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that created the EC2 Instance Connect Endpoint.

", + "smithy.api#xmlName": "ownerId" + } + }, + "InstanceConnectEndpointId": { + "target": "com.amazonaws.ec2#InstanceConnectEndpointId", + "traits": { + "aws.protocols#ec2QueryName": "InstanceConnectEndpointId", + "smithy.api#documentation": "

The ID of the EC2 Instance Connect Endpoint.

", + "smithy.api#xmlName": "instanceConnectEndpointId" + } + }, + "InstanceConnectEndpointArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "InstanceConnectEndpointArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the EC2 Instance Connect Endpoint.

", + "smithy.api#xmlName": "instanceConnectEndpointArn" + } + }, + "State": { + "target": "com.amazonaws.ec2#Ec2InstanceConnectEndpointState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of the EC2 Instance Connect Endpoint.

", + "smithy.api#xmlName": "state" + } + }, + "StateMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StateMessage", + "smithy.api#documentation": "

The message for the current state of the EC2 Instance Connect Endpoint. \n Can include a failure message.

", + "smithy.api#xmlName": "stateMessage" + } + }, + "DnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DnsName", + "smithy.api#documentation": "

The DNS name of the EC2 Instance Connect Endpoint.

", + "smithy.api#xmlName": "dnsName" + } + }, + "FipsDnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "FipsDnsName", + "smithy.api#documentation": "

", + "smithy.api#xmlName": "fipsDnsName" + } + }, + "NetworkInterfaceIds": { + "target": "com.amazonaws.ec2#NetworkInterfaceIdSet", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceIdSet", + "smithy.api#documentation": "

The ID of the elastic network interface that Amazon EC2 automatically created when creating the EC2\n Instance Connect Endpoint.

", + "smithy.api#xmlName": "networkInterfaceIdSet" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC in which the EC2 Instance Connect Endpoint was created.

", + "smithy.api#xmlName": "vpcId" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone of the EC2 Instance Connect Endpoint.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "CreatedAt": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreatedAt", + "smithy.api#documentation": "

The date and time that the EC2 Instance Connect Endpoint was created.

", + "smithy.api#xmlName": "createdAt" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet in which the EC2 Instance Connect Endpoint was created.

", + "smithy.api#xmlName": "subnetId" + } + }, + "PreserveClientIp": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "PreserveClientIp", + "smithy.api#documentation": "

Indicates whether your client's IP address is preserved as the source. The value is true or false.

\n \n

Default: true\n

", + "smithy.api#xmlName": "preserveClientIp" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.ec2#SecurityGroupIdSet", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroupIdSet", + "smithy.api#documentation": "

The security groups associated with the endpoint. If you didn't specify a security group, \n the default security group for your VPC is associated with the endpoint.

", + "smithy.api#xmlName": "securityGroupIdSet" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the EC2 Instance Connect Endpoint.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

The EC2 Instance Connect Endpoint.

" + } + }, + "com.amazonaws.ec2#Ec2InstanceConnectEndpointState": { + "type": "enum", + "members": { + "create_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "create-in-progress" + } + }, + "create_complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "create-complete" + } + }, + "create_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "create-failed" + } + }, + "delete_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "delete-in-progress" + } + }, + "delete_complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "delete-complete" + } + }, + "delete_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "delete-failed" + } + } + } + }, + "com.amazonaws.ec2#EfaInfo": { + "type": "structure", + "members": { + "MaximumEfaInterfaces": { + "target": "com.amazonaws.ec2#MaximumEfaInterfaces", + "traits": { + "aws.protocols#ec2QueryName": "MaximumEfaInterfaces", + "smithy.api#documentation": "

The maximum number of Elastic Fabric Adapters for the instance type.

", + "smithy.api#xmlName": "maximumEfaInterfaces" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the Elastic Fabric Adapters for the instance type.

" + } + }, + "com.amazonaws.ec2#EfaSupportedFlag": { + "type": "boolean" + }, + "com.amazonaws.ec2#EgressOnlyInternetGateway": { + "type": "structure", + "members": { + "Attachments": { + "target": "com.amazonaws.ec2#InternetGatewayAttachmentList", + "traits": { + "aws.protocols#ec2QueryName": "AttachmentSet", + "smithy.api#documentation": "

Information about the attachment of the egress-only internet gateway.

", + "smithy.api#xmlName": "attachmentSet" + } + }, + "EgressOnlyInternetGatewayId": { + "target": "com.amazonaws.ec2#EgressOnlyInternetGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "EgressOnlyInternetGatewayId", + "smithy.api#documentation": "

The ID of the egress-only internet gateway.

", + "smithy.api#xmlName": "egressOnlyInternetGatewayId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the egress-only internet gateway.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an egress-only internet gateway.

" + } + }, + "com.amazonaws.ec2#EgressOnlyInternetGatewayId": { + "type": "string" + }, + "com.amazonaws.ec2#EgressOnlyInternetGatewayIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#EgressOnlyInternetGatewayId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#EgressOnlyInternetGatewayList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#EgressOnlyInternetGateway", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#EipAllocationPublicIp": { + "type": "string" + }, + "com.amazonaws.ec2#EipAssociationIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ElasticIpAssociationId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#EkPubKeyFormat": { + "type": "enum", + "members": { + "der": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "der" + } + }, + "tpmt": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "tpmt" + } + } + } + }, + "com.amazonaws.ec2#EkPubKeyType": { + "type": "enum", + "members": { + "RSA_2048": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rsa-2048" + } + }, + "ECC_SEC_P384": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ecc-sec-p384" + } + } + } + }, + "com.amazonaws.ec2#EkPubKeyValue": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.ec2#ElasticGpuAssociation": { + "type": "structure", + "members": { + "ElasticGpuId": { + "target": "com.amazonaws.ec2#ElasticGpuId", + "traits": { + "aws.protocols#ec2QueryName": "ElasticGpuId", + "smithy.api#documentation": "

The ID of the Elastic Graphics accelerator.

", + "smithy.api#xmlName": "elasticGpuId" + } + }, + "ElasticGpuAssociationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ElasticGpuAssociationId", + "smithy.api#documentation": "

The ID of the association.

", + "smithy.api#xmlName": "elasticGpuAssociationId" + } + }, + "ElasticGpuAssociationState": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ElasticGpuAssociationState", + "smithy.api#documentation": "

The state of the association between the instance and the\n Elastic Graphics accelerator.

", + "smithy.api#xmlName": "elasticGpuAssociationState" + } + }, + "ElasticGpuAssociationTime": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ElasticGpuAssociationTime", + "smithy.api#documentation": "

The time the Elastic Graphics accelerator was associated with the instance.

", + "smithy.api#xmlName": "elasticGpuAssociationTime" + } + } + }, + "traits": { + "smithy.api#documentation": "\n

Amazon Elastic Graphics reached end of life on January 8, 2024.

\n \n

Describes the association between an instance and an Elastic Graphics accelerator.

" + } + }, + "com.amazonaws.ec2#ElasticGpuAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ElasticGpuAssociation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ElasticGpuHealth": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.ec2#ElasticGpuStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The health status.

", + "smithy.api#xmlName": "status" + } + } + }, + "traits": { + "smithy.api#documentation": "\n

Amazon Elastic Graphics reached end of life on January 8, 2024.

\n \n

Describes the status of an Elastic Graphics accelerator.

" + } + }, + "com.amazonaws.ec2#ElasticGpuId": { + "type": "string" + }, + "com.amazonaws.ec2#ElasticGpuIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ElasticGpuId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ElasticGpuSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ElasticGpus", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ElasticGpuSpecification": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of Elastic Graphics accelerator.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "\n

Amazon Elastic Graphics reached end of life on January 8, 2024.

\n \n

A specification for an Elastic Graphics accelerator.

" + } + }, + "com.amazonaws.ec2#ElasticGpuSpecificationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ElasticGpuSpecification", + "traits": { + "smithy.api#xmlName": "ElasticGpuSpecification" + } + } + }, + "com.amazonaws.ec2#ElasticGpuSpecificationResponse": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Type", + "smithy.api#documentation": "

Deprecated.

\n \n

Amazon Elastic Graphics reached end of life on January 8, 2024. For \n workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, \n G4dn, or G5 instances.

\n ", + "smithy.api#xmlName": "type" + } + } + }, + "traits": { + "smithy.api#documentation": "

Deprecated.

\n \n

Amazon Elastic Graphics reached end of life on January 8, 2024. For \n workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, \n G4dn, or G5 instances.

\n " + } + }, + "com.amazonaws.ec2#ElasticGpuSpecificationResponseList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ElasticGpuSpecificationResponse", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ElasticGpuSpecifications": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ElasticGpuSpecification", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ElasticGpuState": { + "type": "enum", + "members": { + "Attached": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ATTACHED" + } + } + } + }, + "com.amazonaws.ec2#ElasticGpuStatus": { + "type": "enum", + "members": { + "Ok": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OK" + } + }, + "Impaired": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMPAIRED" + } + } + } + }, + "com.amazonaws.ec2#ElasticGpus": { + "type": "structure", + "members": { + "ElasticGpuId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ElasticGpuId", + "smithy.api#documentation": "

The ID of the Elastic Graphics accelerator.

", + "smithy.api#xmlName": "elasticGpuId" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone in the which the Elastic Graphics accelerator resides.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "ElasticGpuType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ElasticGpuType", + "smithy.api#documentation": "

The type of Elastic Graphics accelerator.

", + "smithy.api#xmlName": "elasticGpuType" + } + }, + "ElasticGpuHealth": { + "target": "com.amazonaws.ec2#ElasticGpuHealth", + "traits": { + "aws.protocols#ec2QueryName": "ElasticGpuHealth", + "smithy.api#documentation": "

The status of the Elastic Graphics accelerator.

", + "smithy.api#xmlName": "elasticGpuHealth" + } + }, + "ElasticGpuState": { + "target": "com.amazonaws.ec2#ElasticGpuState", + "traits": { + "aws.protocols#ec2QueryName": "ElasticGpuState", + "smithy.api#documentation": "

The state of the Elastic Graphics accelerator.

", + "smithy.api#xmlName": "elasticGpuState" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance to which the Elastic Graphics accelerator is attached.

", + "smithy.api#xmlName": "instanceId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the Elastic Graphics accelerator.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "\n

Amazon Elastic Graphics reached end of life on January 8, 2024.

\n \n

Describes an Elastic Graphics accelerator.

" + } + }, + "com.amazonaws.ec2#ElasticInferenceAccelerator": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

\n \tThe type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, eia1.xlarge, eia2.medium, eia2.large, and eia2.xlarge.\n

", + "smithy.api#required": {} + } + }, + "Count": { + "target": "com.amazonaws.ec2#ElasticInferenceAcceleratorCount", + "traits": { + "smithy.api#documentation": "

\n The number of elastic inference accelerators to attach to the instance. \n

\n

Default: 1

" + } + } + }, + "traits": { + "smithy.api#documentation": "\n

Amazon Elastic Inference is no longer available.

\n \n

\n Describes an elastic inference accelerator. \n

" + } + }, + "com.amazonaws.ec2#ElasticInferenceAcceleratorAssociation": { + "type": "structure", + "members": { + "ElasticInferenceAcceleratorArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ElasticInferenceAcceleratorArn", + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the elastic inference accelerator. \n

", + "smithy.api#xmlName": "elasticInferenceAcceleratorArn" + } + }, + "ElasticInferenceAcceleratorAssociationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ElasticInferenceAcceleratorAssociationId", + "smithy.api#documentation": "

\n The ID of the association. \n

", + "smithy.api#xmlName": "elasticInferenceAcceleratorAssociationId" + } + }, + "ElasticInferenceAcceleratorAssociationState": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ElasticInferenceAcceleratorAssociationState", + "smithy.api#documentation": "

\n The state of the elastic inference accelerator.\n

", + "smithy.api#xmlName": "elasticInferenceAcceleratorAssociationState" + } + }, + "ElasticInferenceAcceleratorAssociationTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "ElasticInferenceAcceleratorAssociationTime", + "smithy.api#documentation": "

\n The time at which the elastic inference accelerator is associated with an instance.\n

", + "smithy.api#xmlName": "elasticInferenceAcceleratorAssociationTime" + } + } + }, + "traits": { + "smithy.api#documentation": "\n

Amazon Elastic Inference is no longer available.

\n \n

\n Describes the association between an instance and an elastic inference accelerator. \n

" + } + }, + "com.amazonaws.ec2#ElasticInferenceAcceleratorAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ElasticInferenceAcceleratorAssociation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ElasticInferenceAcceleratorCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.ec2#ElasticInferenceAccelerators": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ElasticInferenceAccelerator", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ElasticIpAssociationId": { + "type": "string" + }, + "com.amazonaws.ec2#EnaSrdSpecification": { + "type": "structure", + "members": { + "EnaSrdEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether ENA Express is enabled for the network interface.

" + } + }, + "EnaSrdUdpSpecification": { + "target": "com.amazonaws.ec2#EnaSrdUdpSpecification", + "traits": { + "smithy.api#documentation": "

Configures ENA Express for UDP network traffic.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

ENA Express uses Amazon Web Services Scalable Reliable Datagram (SRD) technology to increase the \n\t\t\tmaximum bandwidth used per stream and minimize tail latency of network traffic between EC2 instances. \n\t\t\tWith ENA Express, you can communicate between two EC2 instances in the same subnet within the same \n\t\t\taccount, or in different accounts. Both sending and receiving instances must have ENA Express enabled.

\n

To improve the reliability of network packet delivery, ENA Express reorders network packets on the \n\t\t\treceiving end by default. However, some UDP-based applications are designed to handle network packets \n\t\t\tthat are out of order to reduce the overhead for packet delivery at the network layer. When ENA Express \n\t\t\tis enabled, you can specify whether UDP network traffic uses it.

" + } + }, + "com.amazonaws.ec2#EnaSrdSpecificationRequest": { + "type": "structure", + "members": { + "EnaSrdEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether ENA Express is enabled for the network interface when you \n\t\t\tlaunch an instance from your launch template.

" + } + }, + "EnaSrdUdpSpecification": { + "target": "com.amazonaws.ec2#EnaSrdUdpSpecificationRequest", + "traits": { + "smithy.api#documentation": "

Contains ENA Express settings for UDP network traffic in your launch template.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Launch instances with ENA Express settings configured \n\t\t\tfrom your launch template.

" + } + }, + "com.amazonaws.ec2#EnaSrdSupported": { + "type": "boolean" + }, + "com.amazonaws.ec2#EnaSrdUdpSpecification": { + "type": "structure", + "members": { + "EnaSrdUdpEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, \n\t\t\tyou must first enable ENA Express.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

ENA Express is compatible with both TCP and UDP transport protocols. When it's enabled, TCP traffic \n\t\t\tautomatically uses it. However, some UDP-based applications are designed to handle network packets that are \n\t\t\tout of order, without a need for retransmission, such as live video broadcasting or other near-real-time \n\t\t\tapplications. For UDP traffic, you can specify whether to use ENA Express, based on your application \n\t\t\tenvironment needs.

" + } + }, + "com.amazonaws.ec2#EnaSrdUdpSpecificationRequest": { + "type": "structure", + "members": { + "EnaSrdUdpEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether UDP traffic uses ENA Express for your instance. To ensure that \n\t\t\tUDP traffic can use ENA Express when you launch an instance, you must also set \n\t\t\tEnaSrdEnabled in the EnaSrdSpecificationRequest to true in your \n\t\t\tlaunch template.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configures ENA Express for UDP network traffic from your launch template.

" + } + }, + "com.amazonaws.ec2#EnaSupport": { + "type": "enum", + "members": { + "unsupported": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unsupported" + } + }, + "supported": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "supported" + } + }, + "required": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "required" + } + } + } + }, + "com.amazonaws.ec2#EnableAddressTransfer": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#EnableAddressTransferRequest" + }, + "output": { + "target": "com.amazonaws.ec2#EnableAddressTransferResult" + }, + "traits": { + "smithy.api#documentation": "

Enables Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon VPC User Guide.

" + } + }, + "com.amazonaws.ec2#EnableAddressTransferRequest": { + "type": "structure", + "members": { + "AllocationId": { + "target": "com.amazonaws.ec2#AllocationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The allocation ID of an Elastic IP address.

", + "smithy.api#required": {} + } + }, + "TransferAccountId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the account that you want to transfer the Elastic IP address to.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#EnableAddressTransferResult": { + "type": "structure", + "members": { + "AddressTransfer": { + "target": "com.amazonaws.ec2#AddressTransfer", + "traits": { + "aws.protocols#ec2QueryName": "AddressTransfer", + "smithy.api#documentation": "

An Elastic IP address transfer.

", + "smithy.api#xmlName": "addressTransfer" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#EnableAllowedImagesSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#EnableAllowedImagesSettingsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#EnableAllowedImagesSettingsResult" + }, + "traits": { + "smithy.api#documentation": "

Enables Allowed AMIs for your account in the specified Amazon Web Services Region. Two values are\n accepted:

\n \n \n

The Allowed AMIs feature does not restrict the AMIs owned by your account. Regardless of\n the criteria you set, the AMIs created by your account will always be discoverable and\n usable by users in your account.

\n \n

For more information, see Control the discovery and use of AMIs in\n Amazon EC2 with Allowed AMIs in\n Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#EnableAllowedImagesSettingsRequest": { + "type": "structure", + "members": { + "AllowedImagesSettingsState": { + "target": "com.amazonaws.ec2#AllowedImagesSettingsEnabledState", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specify enabled to apply the image criteria specified by the Allowed AMIs\n settings. Specify audit-mode so that you can check which AMIs will be allowed or\n not allowed by the image criteria.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#EnableAllowedImagesSettingsResult": { + "type": "structure", + "members": { + "AllowedImagesSettingsState": { + "target": "com.amazonaws.ec2#AllowedImagesSettingsEnabledState", + "traits": { + "aws.protocols#ec2QueryName": "AllowedImagesSettingsState", + "smithy.api#documentation": "

Returns enabled or audit-mode if the request succeeds;\n otherwise, it returns an error.

", + "smithy.api#xmlName": "allowedImagesSettingsState" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#EnableAwsNetworkPerformanceMetricSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#EnableAwsNetworkPerformanceMetricSubscriptionRequest" + }, + "output": { + "target": "com.amazonaws.ec2#EnableAwsNetworkPerformanceMetricSubscriptionResult" + }, + "traits": { + "smithy.api#documentation": "

Enables Infrastructure Performance subscriptions.

" + } + }, + "com.amazonaws.ec2#EnableAwsNetworkPerformanceMetricSubscriptionRequest": { + "type": "structure", + "members": { + "Source": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The source Region (like us-east-1) or Availability Zone ID (like use1-az1) that the metric subscription is enabled for. If you use Availability Zone IDs, the Source and Destination Availability Zones must be in the same Region.

" + } + }, + "Destination": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The target Region (like us-east-2) or Availability Zone ID (like use2-az2) that the metric subscription is enabled for. If you use Availability Zone IDs, the Source and Destination Availability Zones must be in the same Region.

" + } + }, + "Metric": { + "target": "com.amazonaws.ec2#MetricType", + "traits": { + "smithy.api#documentation": "

The metric used for the enabled subscription.

" + } + }, + "Statistic": { + "target": "com.amazonaws.ec2#StatisticType", + "traits": { + "smithy.api#documentation": "

The statistic used for the enabled subscription.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#EnableAwsNetworkPerformanceMetricSubscriptionResult": { + "type": "structure", + "members": { + "Output": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Output", + "smithy.api#documentation": "

Indicates whether the subscribe action was successful.

", + "smithy.api#xmlName": "output" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#EnableEbsEncryptionByDefault": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#EnableEbsEncryptionByDefaultRequest" + }, + "output": { + "target": "com.amazonaws.ec2#EnableEbsEncryptionByDefaultResult" + }, + "traits": { + "smithy.api#documentation": "

Enables EBS encryption by default for your account in the current Region.

\n

After you enable encryption by default, the EBS volumes that you create are\n \talways encrypted, either using the default KMS key or the KMS key that you specified\n when you created each volume. For more information, see Amazon EBS encryption in the\n Amazon EBS User Guide.

\n

You can specify the default KMS key for encryption by default using ModifyEbsDefaultKmsKeyId\n or ResetEbsDefaultKmsKeyId.

\n

Enabling encryption by default has no effect on the encryption status of your \n existing volumes.

\n

After you enable encryption by default, you can no longer launch instances\n using instance types that do not support encryption. For more information, see Supported\n instance types.

" + } + }, + "com.amazonaws.ec2#EnableEbsEncryptionByDefaultRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#EnableEbsEncryptionByDefaultResult": { + "type": "structure", + "members": { + "EbsEncryptionByDefault": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EbsEncryptionByDefault", + "smithy.api#documentation": "

The updated status of encryption by default.

", + "smithy.api#xmlName": "ebsEncryptionByDefault" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#EnableFastLaunch": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#EnableFastLaunchRequest" + }, + "output": { + "target": "com.amazonaws.ec2#EnableFastLaunchResult" + }, + "traits": { + "smithy.api#documentation": "

When you enable Windows fast launch for a Windows AMI, images are pre-provisioned, using\n snapshots to launch instances up to 65% faster. To create the optimized Windows image, Amazon EC2\n launches an instance and runs through Sysprep steps, rebooting as required. Then it creates a\n set of reserved snapshots that are used for subsequent launches. The reserved snapshots are\n automatically replenished as they are used, depending on your settings for launch\n frequency.

\n \n

You can only change these settings for Windows AMIs that you own or that have been\n shared with you.

\n " + } + }, + "com.amazonaws.ec2#EnableFastLaunchRequest": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specify the ID of the image for which to enable Windows fast launch.

", + "smithy.api#required": {} + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The type of resource to use for pre-provisioning the AMI for Windows fast launch.\n Supported values include: snapshot, which is the default value.

" + } + }, + "SnapshotConfiguration": { + "target": "com.amazonaws.ec2#FastLaunchSnapshotConfigurationRequest", + "traits": { + "smithy.api#documentation": "

Configuration settings for creating and managing the snapshots that are used for\n pre-provisioning the AMI for Windows fast launch. The associated ResourceType\n must be snapshot.

" + } + }, + "LaunchTemplate": { + "target": "com.amazonaws.ec2#FastLaunchLaunchTemplateSpecificationRequest", + "traits": { + "smithy.api#documentation": "

The launch template to use when launching Windows instances from pre-provisioned\n snapshots. Launch template parameters can include either the name or ID of the launch\n template, but not both.

" + } + }, + "MaxParallelLaunches": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of instances that Amazon EC2 can launch at the same time to create\n pre-provisioned snapshots for Windows fast launch. Value must be 6 or\n greater.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#EnableFastLaunchResult": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The image ID that identifies the AMI for which Windows fast launch was enabled.

", + "smithy.api#xmlName": "imageId" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#FastLaunchResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The type of resource that was defined for pre-provisioning the AMI for Windows fast\n launch.

", + "smithy.api#xmlName": "resourceType" + } + }, + "SnapshotConfiguration": { + "target": "com.amazonaws.ec2#FastLaunchSnapshotConfigurationResponse", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotConfiguration", + "smithy.api#documentation": "

Settings to create and manage the pre-provisioned snapshots that Amazon EC2 uses for faster\n launches from the Windows AMI. This property is returned when the associated\n resourceType is snapshot.

", + "smithy.api#xmlName": "snapshotConfiguration" + } + }, + "LaunchTemplate": { + "target": "com.amazonaws.ec2#FastLaunchLaunchTemplateSpecificationResponse", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplate", + "smithy.api#documentation": "

The launch template that is used when launching Windows instances from pre-provisioned\n snapshots.

", + "smithy.api#xmlName": "launchTemplate" + } + }, + "MaxParallelLaunches": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "MaxParallelLaunches", + "smithy.api#documentation": "

The maximum number of instances that Amazon EC2 can launch at the same time to create\n pre-provisioned snapshots for Windows fast launch.

", + "smithy.api#xmlName": "maxParallelLaunches" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The owner ID for the AMI for which Windows fast launch was enabled.

", + "smithy.api#xmlName": "ownerId" + } + }, + "State": { + "target": "com.amazonaws.ec2#FastLaunchStateCode", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of Windows fast launch for the specified AMI.

", + "smithy.api#xmlName": "state" + } + }, + "StateTransitionReason": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StateTransitionReason", + "smithy.api#documentation": "

The reason that the state changed for Windows fast launch for the AMI.

", + "smithy.api#xmlName": "stateTransitionReason" + } + }, + "StateTransitionTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "StateTransitionTime", + "smithy.api#documentation": "

The time that the state changed for Windows fast launch for the AMI.

", + "smithy.api#xmlName": "stateTransitionTime" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#EnableFastSnapshotRestoreErrorItem": { + "type": "structure", + "members": { + "SnapshotId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The ID of the snapshot.

", + "smithy.api#xmlName": "snapshotId" + } + }, + "FastSnapshotRestoreStateErrors": { + "target": "com.amazonaws.ec2#EnableFastSnapshotRestoreStateErrorSet", + "traits": { + "aws.protocols#ec2QueryName": "FastSnapshotRestoreStateErrorSet", + "smithy.api#documentation": "

The errors.

", + "smithy.api#xmlName": "fastSnapshotRestoreStateErrorSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the errors that occurred when enabling fast snapshot restores.

" + } + }, + "com.amazonaws.ec2#EnableFastSnapshotRestoreErrorSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#EnableFastSnapshotRestoreErrorItem", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#EnableFastSnapshotRestoreStateError": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The error code.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

The error message.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an error that occurred when enabling fast snapshot restores.

" + } + }, + "com.amazonaws.ec2#EnableFastSnapshotRestoreStateErrorItem": { + "type": "structure", + "members": { + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "Error": { + "target": "com.amazonaws.ec2#EnableFastSnapshotRestoreStateError", + "traits": { + "aws.protocols#ec2QueryName": "Error", + "smithy.api#documentation": "

The error.

", + "smithy.api#xmlName": "error" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about an error that occurred when enabling fast snapshot restores.

" + } + }, + "com.amazonaws.ec2#EnableFastSnapshotRestoreStateErrorSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#EnableFastSnapshotRestoreStateErrorItem", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#EnableFastSnapshotRestoreSuccessItem": { + "type": "structure", + "members": { + "SnapshotId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The ID of the snapshot.

", + "smithy.api#xmlName": "snapshotId" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "State": { + "target": "com.amazonaws.ec2#FastSnapshotRestoreStateCode", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of fast snapshot restores.

", + "smithy.api#xmlName": "state" + } + }, + "StateTransitionReason": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StateTransitionReason", + "smithy.api#documentation": "

The reason for the state transition. The possible values are as follows:

\n ", + "smithy.api#xmlName": "stateTransitionReason" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that enabled fast snapshot restores on the snapshot.

", + "smithy.api#xmlName": "ownerId" + } + }, + "OwnerAlias": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerAlias", + "smithy.api#documentation": "

The Amazon Web Services owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use.

", + "smithy.api#xmlName": "ownerAlias" + } + }, + "EnablingTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "EnablingTime", + "smithy.api#documentation": "

The time at which fast snapshot restores entered the enabling state.

", + "smithy.api#xmlName": "enablingTime" + } + }, + "OptimizingTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "OptimizingTime", + "smithy.api#documentation": "

The time at which fast snapshot restores entered the optimizing state.

", + "smithy.api#xmlName": "optimizingTime" + } + }, + "EnabledTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "EnabledTime", + "smithy.api#documentation": "

The time at which fast snapshot restores entered the enabled state.

", + "smithy.api#xmlName": "enabledTime" + } + }, + "DisablingTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "DisablingTime", + "smithy.api#documentation": "

The time at which fast snapshot restores entered the disabling state.

", + "smithy.api#xmlName": "disablingTime" + } + }, + "DisabledTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "DisabledTime", + "smithy.api#documentation": "

The time at which fast snapshot restores entered the disabled state.

", + "smithy.api#xmlName": "disabledTime" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes fast snapshot restores that were successfully enabled.

" + } + }, + "com.amazonaws.ec2#EnableFastSnapshotRestoreSuccessSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#EnableFastSnapshotRestoreSuccessItem", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#EnableFastSnapshotRestores": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#EnableFastSnapshotRestoresRequest" + }, + "output": { + "target": "com.amazonaws.ec2#EnableFastSnapshotRestoresResult" + }, + "traits": { + "smithy.api#documentation": "

Enables fast snapshot restores for the specified snapshots in the specified Availability Zones.

\n

You get the full benefit of fast snapshot restores after they enter the enabled state.\n To get the current state of fast snapshot restores, use DescribeFastSnapshotRestores.\n To disable fast snapshot restores, use DisableFastSnapshotRestores.

\n

For more information, see Amazon EBS fast snapshot\n restore in the Amazon EBS User Guide.

" + } + }, + "com.amazonaws.ec2#EnableFastSnapshotRestoresRequest": { + "type": "structure", + "members": { + "AvailabilityZones": { + "target": "com.amazonaws.ec2#AvailabilityZoneStringList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

One or more Availability Zones. For example, us-east-2a.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "AvailabilityZone" + } + }, + "SourceSnapshotIds": { + "target": "com.amazonaws.ec2#SnapshotIdStringList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of one or more snapshots. For example, snap-1234567890abcdef0. You can specify\n a snapshot that was shared with you from another Amazon Web Services account.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "SourceSnapshotId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#EnableFastSnapshotRestoresResult": { + "type": "structure", + "members": { + "Successful": { + "target": "com.amazonaws.ec2#EnableFastSnapshotRestoreSuccessSet", + "traits": { + "aws.protocols#ec2QueryName": "Successful", + "smithy.api#documentation": "

Information about the snapshots for which fast snapshot restores were successfully enabled.

", + "smithy.api#xmlName": "successful" + } + }, + "Unsuccessful": { + "target": "com.amazonaws.ec2#EnableFastSnapshotRestoreErrorSet", + "traits": { + "aws.protocols#ec2QueryName": "Unsuccessful", + "smithy.api#documentation": "

Information about the snapshots for which fast snapshot restores could not be enabled.

", + "smithy.api#xmlName": "unsuccessful" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#EnableImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#EnableImageRequest" + }, + "output": { + "target": "com.amazonaws.ec2#EnableImageResult" + }, + "traits": { + "smithy.api#documentation": "

Re-enables a disabled AMI. The re-enabled AMI is marked as available and can\n be used for instance launches, appears in describe operations, and can be shared. Amazon Web Services\n accounts, organizations, and Organizational Units that lost access to the AMI when it was\n disabled do not regain access automatically. Once the AMI is available, it can be shared with\n them again.

\n

Only the AMI owner can re-enable a disabled AMI.

\n

For more information, see Disable an AMI in the\n Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#EnableImageBlockPublicAccess": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#EnableImageBlockPublicAccessRequest" + }, + "output": { + "target": "com.amazonaws.ec2#EnableImageBlockPublicAccessResult" + }, + "traits": { + "smithy.api#documentation": "

Enables block public access for AMIs at the account level in the\n specified Amazon Web Services Region. This prevents the public sharing of your AMIs. However, if you already\n have public AMIs, they will remain publicly available.

\n

The API can take up to 10 minutes to configure this setting. During this time, if you run\n GetImageBlockPublicAccessState, the response will be unblocked. When\n the API has completed the configuration, the response will be\n block-new-sharing.

\n

For more information, see Block\n public access to your AMIs in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#EnableImageBlockPublicAccessRequest": { + "type": "structure", + "members": { + "ImageBlockPublicAccessState": { + "target": "com.amazonaws.ec2#ImageBlockPublicAccessEnabledState", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specify block-new-sharing to enable block public access for AMIs at the\n account level in the specified Region. This will block any attempt to publicly share your AMIs\n in the specified Region.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#EnableImageBlockPublicAccessResult": { + "type": "structure", + "members": { + "ImageBlockPublicAccessState": { + "target": "com.amazonaws.ec2#ImageBlockPublicAccessEnabledState", + "traits": { + "aws.protocols#ec2QueryName": "ImageBlockPublicAccessState", + "smithy.api#documentation": "

Returns block-new-sharing if the request succeeds; otherwise, it returns an\n error.

", + "smithy.api#xmlName": "imageBlockPublicAccessState" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#EnableImageDeprecation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#EnableImageDeprecationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#EnableImageDeprecationResult" + }, + "traits": { + "smithy.api#documentation": "

Enables deprecation of the specified AMI at the specified date and time.

\n

For more information, see Deprecate an AMI in the\n Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#EnableImageDeprecationRequest": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the AMI.

", + "smithy.api#required": {} + } + }, + "DeprecateAt": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The date and time to deprecate the AMI, in UTC, in the following format:\n YYYY-MM-DDTHH:MM:SSZ.\n If you specify a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.

\n

You can’t specify a date in the past. The upper limit for DeprecateAt is 10\n years from now, except for public AMIs, where the upper limit is 2 years from the creation\n date.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#EnableImageDeprecationResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#EnableImageDeregistrationProtection": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#EnableImageDeregistrationProtectionRequest" + }, + "output": { + "target": "com.amazonaws.ec2#EnableImageDeregistrationProtectionResult" + }, + "traits": { + "smithy.api#documentation": "

Enables deregistration protection for an AMI. When deregistration protection is enabled,\n the AMI can't be deregistered.

\n

To allow the AMI to be deregistered, you must first disable deregistration protection\n using DisableImageDeregistrationProtection.

\n

For more information, see Protect an\n AMI from deregistration in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#EnableImageDeregistrationProtectionRequest": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the AMI.

", + "smithy.api#required": {} + } + }, + "WithCooldown": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

If true, enforces deregistration protection for 24 hours after deregistration\n protection is disabled.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#EnableImageDeregistrationProtectionResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#EnableImageRequest": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the AMI.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#EnableImageResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#EnableIpamOrganizationAdminAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#EnableIpamOrganizationAdminAccountRequest" + }, + "output": { + "target": "com.amazonaws.ec2#EnableIpamOrganizationAdminAccountResult" + }, + "traits": { + "smithy.api#documentation": "

Enable an Organizations member account as the IPAM admin account. You cannot select the Organizations management account as the IPAM admin account. For more information, see Enable integration with Organizations in the Amazon VPC IPAM User Guide.\n

" + } + }, + "com.amazonaws.ec2#EnableIpamOrganizationAdminAccountRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "DelegatedAdminAccountId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Organizations member account ID that you want to enable as the IPAM account.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#EnableIpamOrganizationAdminAccountResult": { + "type": "structure", + "members": { + "Success": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Success", + "smithy.api#documentation": "

The result of enabling the IPAM account.

", + "smithy.api#xmlName": "success" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#EnableReachabilityAnalyzerOrganizationSharing": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#EnableReachabilityAnalyzerOrganizationSharingRequest" + }, + "output": { + "target": "com.amazonaws.ec2#EnableReachabilityAnalyzerOrganizationSharingResult" + }, + "traits": { + "smithy.api#documentation": "

Establishes a trust relationship between Reachability Analyzer and Organizations.\n This operation must be performed by the management account for the organization.

\n

After you establish a trust relationship, a user in the management account or \n a delegated administrator account can run a cross-account analysis using resources \n from the member accounts.

" + } + }, + "com.amazonaws.ec2#EnableReachabilityAnalyzerOrganizationSharingRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#EnableReachabilityAnalyzerOrganizationSharingResult": { + "type": "structure", + "members": { + "ReturnValue": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "ReturnValue", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, returns an error.

", + "smithy.api#xmlName": "returnValue" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#EnableSerialConsoleAccess": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#EnableSerialConsoleAccessRequest" + }, + "output": { + "target": "com.amazonaws.ec2#EnableSerialConsoleAccessResult" + }, + "traits": { + "smithy.api#documentation": "

Enables access to the EC2 serial console of all instances for your account. By default,\n\t\t\taccess to the EC2 serial console is disabled for your account. For more information, see Manage account access to the EC2 serial console\n\t\t\tin the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#EnableSerialConsoleAccessRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#EnableSerialConsoleAccessResult": { + "type": "structure", + "members": { + "SerialConsoleAccessEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "SerialConsoleAccessEnabled", + "smithy.api#documentation": "

If true, access to the EC2 serial console of all instances is enabled for\n\t\t\tyour account. If false, access to the EC2 serial console of all instances\n\t\t\tis disabled for your account.

", + "smithy.api#xmlName": "serialConsoleAccessEnabled" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#EnableSnapshotBlockPublicAccess": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#EnableSnapshotBlockPublicAccessRequest" + }, + "output": { + "target": "com.amazonaws.ec2#EnableSnapshotBlockPublicAccessResult" + }, + "traits": { + "smithy.api#documentation": "

Enables or modifies the block public access for snapshots \n setting at the account level for the specified Amazon Web Services Region. After you enable block \n public access for snapshots in a Region, users can no longer request public sharing \n for snapshots in that Region. Snapshots that are already publicly shared are either \n treated as private or they remain publicly shared, depending on the \n State that you specify.

\n \n

Enabling block public access for snapshots in block all sharing \n mode does not change the permissions for snapshots that are already publicly shared. \n Instead, it prevents these snapshots from be publicly visible and publicly accessible. \n Therefore, the attributes for these snapshots still indicate that they are publicly \n shared, even though they are not publicly available.

\n

If you later disable block public access or change the mode to block new \n sharing, these snapshots will become publicly available again.

\n \n

For more information, see \n Block public access for snapshots in the Amazon EBS User Guide.

" + } + }, + "com.amazonaws.ec2#EnableSnapshotBlockPublicAccessRequest": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.ec2#SnapshotBlockPublicAccessState", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The mode in which to enable block public access for snapshots for the Region. \n Specify one of the following values:

\n \n

\n unblocked is not a valid value for EnableSnapshotBlockPublicAccess.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#EnableSnapshotBlockPublicAccessResult": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.ec2#SnapshotBlockPublicAccessState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of block public access for snapshots for the account and Region. Returns \n either block-all-sharing or block-new-sharing if the request \n succeeds.

", + "smithy.api#xmlName": "state" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#EnableTransitGatewayRouteTablePropagation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#EnableTransitGatewayRouteTablePropagationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#EnableTransitGatewayRouteTablePropagationResult" + }, + "traits": { + "smithy.api#documentation": "

Enables the specified attachment to propagate routes to the specified\n propagation route table.

" + } + }, + "com.amazonaws.ec2#EnableTransitGatewayRouteTablePropagationRequest": { + "type": "structure", + "members": { + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the propagation route table.

", + "smithy.api#required": {} + } + }, + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#documentation": "

The ID of the attachment.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "TransitGatewayRouteTableAnnouncementId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementId", + "traits": { + "smithy.api#documentation": "

The ID of the transit gateway route table announcement.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#EnableTransitGatewayRouteTablePropagationResult": { + "type": "structure", + "members": { + "Propagation": { + "target": "com.amazonaws.ec2#TransitGatewayPropagation", + "traits": { + "aws.protocols#ec2QueryName": "Propagation", + "smithy.api#documentation": "

Information about route propagation.

", + "smithy.api#xmlName": "propagation" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#EnableVgwRoutePropagation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#EnableVgwRoutePropagationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Enables a virtual private gateway (VGW) to propagate routes to the specified route\n table of a VPC.

", + "smithy.api#examples": [ + { + "title": "To enable route propagation", + "documentation": "This example enables the specified virtual private gateway to propagate static routes to the specified route table.", + "input": { + "RouteTableId": "rtb-22574640", + "GatewayId": "vgw-9a4cacf3" + } + } + ] + } + }, + "com.amazonaws.ec2#EnableVgwRoutePropagationRequest": { + "type": "structure", + "members": { + "GatewayId": { + "target": "com.amazonaws.ec2#VpnGatewayId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the virtual private gateway that is attached to a VPC. The virtual private\n gateway must be attached to the same VPC that the routing tables are associated with.\n

", + "smithy.api#required": {} + } + }, + "RouteTableId": { + "target": "com.amazonaws.ec2#RouteTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the route table. The routing table must be associated with the same VPC that\n the virtual private gateway is attached to.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for EnableVgwRoutePropagation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#EnableVolumeIO": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#EnableVolumeIORequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Enables I/O operations for a volume that had I/O operations disabled because the data on\n the volume was potentially inconsistent.

", + "smithy.api#examples": [ + { + "title": "To enable I/O for a volume", + "documentation": "This example enables I/O on volume ``vol-1234567890abcdef0``.", + "input": { + "VolumeId": "vol-1234567890abcdef0" + } + } + ] + } + }, + "com.amazonaws.ec2#EnableVolumeIORequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "VolumeId": { + "target": "com.amazonaws.ec2#VolumeId", + "traits": { + "aws.protocols#ec2QueryName": "VolumeId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the volume.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "volumeId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#EnableVpcClassicLink": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#EnableVpcClassicLinkRequest" + }, + "output": { + "target": "com.amazonaws.ec2#EnableVpcClassicLinkResult" + }, + "traits": { + "smithy.api#documentation": "\n

This action is deprecated.

\n \n

Enables a VPC for ClassicLink. You can then link EC2-Classic instances to your\n\t\t\tClassicLink-enabled VPC to allow communication over private IP addresses. You cannot\n\t\t\tenable your VPC for ClassicLink if any of your VPC route tables have existing routes for\n\t\t\taddress ranges within the 10.0.0.0/8 IP address range, excluding local\n\t\t\troutes for VPCs in the 10.0.0.0/16 and 10.1.0.0/16 IP address\n\t\t\tranges.

" + } + }, + "com.amazonaws.ec2#EnableVpcClassicLinkDnsSupport": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#EnableVpcClassicLinkDnsSupportRequest" + }, + "output": { + "target": "com.amazonaws.ec2#EnableVpcClassicLinkDnsSupportResult" + }, + "traits": { + "smithy.api#documentation": "\n

This action is deprecated.

\n \n

Enables a VPC to support DNS hostname resolution for ClassicLink. If enabled, the DNS\n\t\t\thostname of a linked EC2-Classic instance resolves to its private IP address when\n\t\t\taddressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname\n\t\t\tof an instance in a VPC resolves to its private IP address when addressed from a linked\n\t\t\tEC2-Classic instance.

\n

You must specify a VPC ID in the request.

" + } + }, + "com.amazonaws.ec2#EnableVpcClassicLinkDnsSupportRequest": { + "type": "structure", + "members": { + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "VpcId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#EnableVpcClassicLinkDnsSupportResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#EnableVpcClassicLinkRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "vpcId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#EnableVpcClassicLinkResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#EnclaveOptions": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Enabled", + "smithy.api#documentation": "

If this parameter is set to true, the instance is enabled for Amazon Web Services Nitro Enclaves; otherwise, it is not enabled for Amazon Web Services Nitro\n Enclaves.

", + "smithy.api#xmlName": "enabled" + } + } + }, + "traits": { + "smithy.api#documentation": "

Indicates whether the instance is enabled for Amazon Web Services Nitro\n Enclaves.

" + } + }, + "com.amazonaws.ec2#EnclaveOptionsRequest": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to\n true.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For\n more information, see What is Amazon Web Services Nitro\n Enclaves? in the Amazon Web Services Nitro Enclaves User\n Guide.

" + } + }, + "com.amazonaws.ec2#EncryptionInTransitSupported": { + "type": "boolean" + }, + "com.amazonaws.ec2#EndDateType": { + "type": "enum", + "members": { + "unlimited": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unlimited" + } + }, + "limited": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "limited" + } + } + } + }, + "com.amazonaws.ec2#EndpointSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ClientVpnEndpoint", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#EphemeralNvmeSupport": { + "type": "enum", + "members": { + "UNSUPPORTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unsupported" + } + }, + "SUPPORTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "supported" + } + }, + "REQUIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "required" + } + } + } + }, + "com.amazonaws.ec2#ErrorSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ValidationError", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#EventCode": { + "type": "enum", + "members": { + "instance_reboot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "instance-reboot" + } + }, + "system_reboot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "system-reboot" + } + }, + "system_maintenance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "system-maintenance" + } + }, + "instance_retirement": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "instance-retirement" + } + }, + "instance_stop": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "instance-stop" + } + } + } + }, + "com.amazonaws.ec2#EventInformation": { + "type": "structure", + "members": { + "EventDescription": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "EventDescription", + "smithy.api#documentation": "

The description of the event.

", + "smithy.api#xmlName": "eventDescription" + } + }, + "EventSubType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "EventSubType", + "smithy.api#documentation": "

The event.

\n

\n error events:

\n \n

\n fleetRequestChange events:

\n \n

\n instanceChange events:

\n \n

\n Information events:

\n ", + "smithy.api#xmlName": "eventSubType" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance. This information is available only for\n instanceChange events.

", + "smithy.api#xmlName": "instanceId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an EC2 Fleet or Spot Fleet event.

" + } + }, + "com.amazonaws.ec2#EventType": { + "type": "enum", + "members": { + "INSTANCE_CHANGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "instanceChange" + } + }, + "BATCH_CHANGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fleetRequestChange" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "error" + } + }, + "INFORMATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "information" + } + } + } + }, + "com.amazonaws.ec2#ExcessCapacityTerminationPolicy": { + "type": "enum", + "members": { + "NO_TERMINATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "noTermination" + } + }, + "DEFAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "default" + } + } + } + }, + "com.amazonaws.ec2#ExcludedInstanceType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 30 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\.\\*\\-]+$" + } + }, + "com.amazonaws.ec2#ExcludedInstanceTypeSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ExcludedInstanceType", + "traits": { + "smithy.api#xmlName": "item" + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 400 + } + } + }, + "com.amazonaws.ec2#ExecutableByStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "ExecutableBy" + } + } + }, + "com.amazonaws.ec2#Explanation": { + "type": "structure", + "members": { + "Acl": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "Acl", + "smithy.api#documentation": "

The network ACL.

", + "smithy.api#xmlName": "acl" + } + }, + "AclRule": { + "target": "com.amazonaws.ec2#AnalysisAclRule", + "traits": { + "aws.protocols#ec2QueryName": "AclRule", + "smithy.api#documentation": "

The network ACL rule.

", + "smithy.api#xmlName": "aclRule" + } + }, + "Address": { + "target": "com.amazonaws.ec2#IpAddress", + "traits": { + "aws.protocols#ec2QueryName": "Address", + "smithy.api#documentation": "

The IPv4 address, in CIDR notation.

", + "smithy.api#xmlName": "address" + } + }, + "Addresses": { + "target": "com.amazonaws.ec2#IpAddressList", + "traits": { + "aws.protocols#ec2QueryName": "AddressSet", + "smithy.api#documentation": "

The IPv4 addresses, in CIDR notation.

", + "smithy.api#xmlName": "addressSet" + } + }, + "AttachedTo": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "AttachedTo", + "smithy.api#documentation": "

The resource to which the component is attached.

", + "smithy.api#xmlName": "attachedTo" + } + }, + "AvailabilityZones": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZoneSet", + "smithy.api#documentation": "

The Availability Zones.

", + "smithy.api#xmlName": "availabilityZoneSet" + } + }, + "Cidrs": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "CidrSet", + "smithy.api#documentation": "

The CIDR ranges.

", + "smithy.api#xmlName": "cidrSet" + } + }, + "Component": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "Component", + "smithy.api#documentation": "

The component.

", + "smithy.api#xmlName": "component" + } + }, + "CustomerGateway": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "CustomerGateway", + "smithy.api#documentation": "

The customer gateway.

", + "smithy.api#xmlName": "customerGateway" + } + }, + "Destination": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "Destination", + "smithy.api#documentation": "

The destination.

", + "smithy.api#xmlName": "destination" + } + }, + "DestinationVpc": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "DestinationVpc", + "smithy.api#documentation": "

The destination VPC.

", + "smithy.api#xmlName": "destinationVpc" + } + }, + "Direction": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Direction", + "smithy.api#documentation": "

The direction. The following are the possible values:

\n ", + "smithy.api#xmlName": "direction" + } + }, + "ExplanationCode": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ExplanationCode", + "smithy.api#documentation": "

The explanation code.

", + "smithy.api#xmlName": "explanationCode" + } + }, + "IngressRouteTable": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "IngressRouteTable", + "smithy.api#documentation": "

The route table.

", + "smithy.api#xmlName": "ingressRouteTable" + } + }, + "InternetGateway": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "InternetGateway", + "smithy.api#documentation": "

The internet gateway.

", + "smithy.api#xmlName": "internetGateway" + } + }, + "LoadBalancerArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "LoadBalancerArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the load balancer.

", + "smithy.api#xmlName": "loadBalancerArn" + } + }, + "ClassicLoadBalancerListener": { + "target": "com.amazonaws.ec2#AnalysisLoadBalancerListener", + "traits": { + "aws.protocols#ec2QueryName": "ClassicLoadBalancerListener", + "smithy.api#documentation": "

The listener for a Classic Load Balancer.

", + "smithy.api#xmlName": "classicLoadBalancerListener" + } + }, + "LoadBalancerListenerPort": { + "target": "com.amazonaws.ec2#Port", + "traits": { + "aws.protocols#ec2QueryName": "LoadBalancerListenerPort", + "smithy.api#documentation": "

The listener port of the load balancer.

", + "smithy.api#xmlName": "loadBalancerListenerPort" + } + }, + "LoadBalancerTarget": { + "target": "com.amazonaws.ec2#AnalysisLoadBalancerTarget", + "traits": { + "aws.protocols#ec2QueryName": "LoadBalancerTarget", + "smithy.api#documentation": "

The target.

", + "smithy.api#xmlName": "loadBalancerTarget" + } + }, + "LoadBalancerTargetGroup": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "LoadBalancerTargetGroup", + "smithy.api#documentation": "

The target group.

", + "smithy.api#xmlName": "loadBalancerTargetGroup" + } + }, + "LoadBalancerTargetGroups": { + "target": "com.amazonaws.ec2#AnalysisComponentList", + "traits": { + "aws.protocols#ec2QueryName": "LoadBalancerTargetGroupSet", + "smithy.api#documentation": "

The target groups.

", + "smithy.api#xmlName": "loadBalancerTargetGroupSet" + } + }, + "LoadBalancerTargetPort": { + "target": "com.amazonaws.ec2#Port", + "traits": { + "aws.protocols#ec2QueryName": "LoadBalancerTargetPort", + "smithy.api#documentation": "

The target port.

", + "smithy.api#xmlName": "loadBalancerTargetPort" + } + }, + "ElasticLoadBalancerListener": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "ElasticLoadBalancerListener", + "smithy.api#documentation": "

The load balancer listener.

", + "smithy.api#xmlName": "elasticLoadBalancerListener" + } + }, + "MissingComponent": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "MissingComponent", + "smithy.api#documentation": "

The missing component.

", + "smithy.api#xmlName": "missingComponent" + } + }, + "NatGateway": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "NatGateway", + "smithy.api#documentation": "

The NAT gateway.

", + "smithy.api#xmlName": "natGateway" + } + }, + "NetworkInterface": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterface", + "smithy.api#documentation": "

The network interface.

", + "smithy.api#xmlName": "networkInterface" + } + }, + "PacketField": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PacketField", + "smithy.api#documentation": "

The packet field.

", + "smithy.api#xmlName": "packetField" + } + }, + "VpcPeeringConnection": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "VpcPeeringConnection", + "smithy.api#documentation": "

The VPC peering connection.

", + "smithy.api#xmlName": "vpcPeeringConnection" + } + }, + "Port": { + "target": "com.amazonaws.ec2#Port", + "traits": { + "aws.protocols#ec2QueryName": "Port", + "smithy.api#documentation": "

The port.

", + "smithy.api#xmlName": "port" + } + }, + "PortRanges": { + "target": "com.amazonaws.ec2#PortRangeList", + "traits": { + "aws.protocols#ec2QueryName": "PortRangeSet", + "smithy.api#documentation": "

The port ranges.

", + "smithy.api#xmlName": "portRangeSet" + } + }, + "PrefixList": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "PrefixList", + "smithy.api#documentation": "

The prefix list.

", + "smithy.api#xmlName": "prefixList" + } + }, + "Protocols": { + "target": "com.amazonaws.ec2#StringList", + "traits": { + "aws.protocols#ec2QueryName": "ProtocolSet", + "smithy.api#documentation": "

The protocols.

", + "smithy.api#xmlName": "protocolSet" + } + }, + "RouteTableRoute": { + "target": "com.amazonaws.ec2#AnalysisRouteTableRoute", + "traits": { + "aws.protocols#ec2QueryName": "RouteTableRoute", + "smithy.api#documentation": "

The route table route.

", + "smithy.api#xmlName": "routeTableRoute" + } + }, + "RouteTable": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "RouteTable", + "smithy.api#documentation": "

The route table.

", + "smithy.api#xmlName": "routeTable" + } + }, + "SecurityGroup": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroup", + "smithy.api#documentation": "

The security group.

", + "smithy.api#xmlName": "securityGroup" + } + }, + "SecurityGroupRule": { + "target": "com.amazonaws.ec2#AnalysisSecurityGroupRule", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroupRule", + "smithy.api#documentation": "

The security group rule.

", + "smithy.api#xmlName": "securityGroupRule" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.ec2#AnalysisComponentList", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroupSet", + "smithy.api#documentation": "

The security groups.

", + "smithy.api#xmlName": "securityGroupSet" + } + }, + "SourceVpc": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "SourceVpc", + "smithy.api#documentation": "

The source VPC.

", + "smithy.api#xmlName": "sourceVpc" + } + }, + "State": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state.

", + "smithy.api#xmlName": "state" + } + }, + "Subnet": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "Subnet", + "smithy.api#documentation": "

The subnet.

", + "smithy.api#xmlName": "subnet" + } + }, + "SubnetRouteTable": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "SubnetRouteTable", + "smithy.api#documentation": "

The route table for the subnet.

", + "smithy.api#xmlName": "subnetRouteTable" + } + }, + "Vpc": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "Vpc", + "smithy.api#documentation": "

The component VPC.

", + "smithy.api#xmlName": "vpc" + } + }, + "VpcEndpoint": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "VpcEndpoint", + "smithy.api#documentation": "

The VPC endpoint.

", + "smithy.api#xmlName": "vpcEndpoint" + } + }, + "VpnConnection": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "VpnConnection", + "smithy.api#documentation": "

The VPN connection.

", + "smithy.api#xmlName": "vpnConnection" + } + }, + "VpnGateway": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "VpnGateway", + "smithy.api#documentation": "

The VPN gateway.

", + "smithy.api#xmlName": "vpnGateway" + } + }, + "TransitGateway": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "TransitGateway", + "smithy.api#documentation": "

The transit gateway.

", + "smithy.api#xmlName": "transitGateway" + } + }, + "TransitGatewayRouteTable": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTable", + "smithy.api#documentation": "

The transit gateway route table.

", + "smithy.api#xmlName": "transitGatewayRouteTable" + } + }, + "TransitGatewayRouteTableRoute": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableRoute", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTableRoute", + "smithy.api#documentation": "

The transit gateway route table route.

", + "smithy.api#xmlName": "transitGatewayRouteTableRoute" + } + }, + "TransitGatewayAttachment": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAttachment", + "smithy.api#documentation": "

The transit gateway attachment.

", + "smithy.api#xmlName": "transitGatewayAttachment" + } + }, + "ComponentAccount": { + "target": "com.amazonaws.ec2#ComponentAccount", + "traits": { + "aws.protocols#ec2QueryName": "ComponentAccount", + "smithy.api#documentation": "

The Amazon Web Services account for the component.

", + "smithy.api#xmlName": "componentAccount" + } + }, + "ComponentRegion": { + "target": "com.amazonaws.ec2#ComponentRegion", + "traits": { + "aws.protocols#ec2QueryName": "ComponentRegion", + "smithy.api#documentation": "

The Region for the component.

", + "smithy.api#xmlName": "componentRegion" + } + }, + "FirewallStatelessRule": { + "target": "com.amazonaws.ec2#FirewallStatelessRule", + "traits": { + "aws.protocols#ec2QueryName": "FirewallStatelessRule", + "smithy.api#documentation": "

The Network Firewall stateless rule.

", + "smithy.api#xmlName": "firewallStatelessRule" + } + }, + "FirewallStatefulRule": { + "target": "com.amazonaws.ec2#FirewallStatefulRule", + "traits": { + "aws.protocols#ec2QueryName": "FirewallStatefulRule", + "smithy.api#documentation": "

The Network Firewall stateful rule.

", + "smithy.api#xmlName": "firewallStatefulRule" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an explanation code for an unreachable path. For more information, see Reachability Analyzer explanation codes.

" + } + }, + "com.amazonaws.ec2#ExplanationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Explanation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ExportClientVpnClientCertificateRevocationList": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ExportClientVpnClientCertificateRevocationListRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ExportClientVpnClientCertificateRevocationListResult" + }, + "traits": { + "smithy.api#documentation": "

Downloads the client certificate revocation list for the specified Client VPN endpoint.

" + } + }, + "com.amazonaws.ec2#ExportClientVpnClientCertificateRevocationListRequest": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#ClientVpnEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ExportClientVpnClientCertificateRevocationListResult": { + "type": "structure", + "members": { + "CertificateRevocationList": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CertificateRevocationList", + "smithy.api#documentation": "

Information about the client certificate revocation list.

", + "smithy.api#xmlName": "certificateRevocationList" + } + }, + "Status": { + "target": "com.amazonaws.ec2#ClientCertificateRevocationListStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The current state of the client certificate revocation list.

", + "smithy.api#xmlName": "status" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ExportClientVpnClientConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ExportClientVpnClientConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ExportClientVpnClientConfigurationResult" + }, + "traits": { + "smithy.api#documentation": "

Downloads the contents of the Client VPN endpoint configuration file for the specified Client VPN endpoint. The Client VPN endpoint configuration \n\t\t\tfile includes the Client VPN endpoint and certificate information clients need to establish a connection \n\t\t\twith the Client VPN endpoint.

" + } + }, + "com.amazonaws.ec2#ExportClientVpnClientConfigurationRequest": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#ClientVpnEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ExportClientVpnClientConfigurationResult": { + "type": "structure", + "members": { + "ClientConfiguration": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientConfiguration", + "smithy.api#documentation": "

The contents of the Client VPN endpoint configuration file.

", + "smithy.api#xmlName": "clientConfiguration" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ExportEnvironment": { + "type": "enum", + "members": { + "citrix": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "citrix" + } + }, + "vmware": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vmware" + } + }, + "microsoft": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "microsoft" + } + } + } + }, + "com.amazonaws.ec2#ExportImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ExportImageRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ExportImageResult" + }, + "traits": { + "smithy.api#documentation": "

Exports an Amazon Machine Image (AMI) to a VM file. For more information, see Exporting a VM\n directly from an Amazon Machine Image (AMI) in the\n VM Import/Export User Guide.

" + } + }, + "com.amazonaws.ec2#ExportImageRequest": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Token to enable idempotency for export image requests.

", + "smithy.api#idempotencyToken": {} + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description of the image being exported. The maximum length is 255 characters.

" + } + }, + "DiskImageFormat": { + "target": "com.amazonaws.ec2#DiskImageFormat", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The disk image format.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the image.

", + "smithy.api#required": {} + } + }, + "S3ExportLocation": { + "target": "com.amazonaws.ec2#ExportTaskS3LocationRequest", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon S3 bucket for the destination image. The destination bucket must exist.

", + "smithy.api#required": {} + } + }, + "RoleName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the role that grants VM Import/Export permission to export images to your Amazon\n S3 bucket. If this parameter is not specified, the default role is named 'vmimport'.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the export image task during creation.

", + "smithy.api#xmlName": "TagSpecification" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ExportImageResult": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description of the image being exported.

", + "smithy.api#xmlName": "description" + } + }, + "DiskImageFormat": { + "target": "com.amazonaws.ec2#DiskImageFormat", + "traits": { + "aws.protocols#ec2QueryName": "DiskImageFormat", + "smithy.api#documentation": "

The disk image format for the exported image.

", + "smithy.api#xmlName": "diskImageFormat" + } + }, + "ExportImageTaskId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ExportImageTaskId", + "smithy.api#documentation": "

The ID of the export image task.

", + "smithy.api#xmlName": "exportImageTaskId" + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the image.

", + "smithy.api#xmlName": "imageId" + } + }, + "RoleName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RoleName", + "smithy.api#documentation": "

The name of the role that grants VM Import/Export permission to export images to your Amazon\n S3 bucket.

", + "smithy.api#xmlName": "roleName" + } + }, + "Progress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Progress", + "smithy.api#documentation": "

The percent complete of the export image task.

", + "smithy.api#xmlName": "progress" + } + }, + "S3ExportLocation": { + "target": "com.amazonaws.ec2#ExportTaskS3Location", + "traits": { + "aws.protocols#ec2QueryName": "S3ExportLocation", + "smithy.api#documentation": "

Information about the destination Amazon S3 bucket.

", + "smithy.api#xmlName": "s3ExportLocation" + } + }, + "Status": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The status of the export image task. The possible values are active, completed,\n deleting, and deleted.

", + "smithy.api#xmlName": "status" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

The status message for the export image task.

", + "smithy.api#xmlName": "statusMessage" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the export image task.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ExportImageTask": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description of the image being exported.

", + "smithy.api#xmlName": "description" + } + }, + "ExportImageTaskId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ExportImageTaskId", + "smithy.api#documentation": "

The ID of the export image task.

", + "smithy.api#xmlName": "exportImageTaskId" + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the image.

", + "smithy.api#xmlName": "imageId" + } + }, + "Progress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Progress", + "smithy.api#documentation": "

The percent complete of the export image task.

", + "smithy.api#xmlName": "progress" + } + }, + "S3ExportLocation": { + "target": "com.amazonaws.ec2#ExportTaskS3Location", + "traits": { + "aws.protocols#ec2QueryName": "S3ExportLocation", + "smithy.api#documentation": "

Information about the destination Amazon S3 bucket.

", + "smithy.api#xmlName": "s3ExportLocation" + } + }, + "Status": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The status of the export image task. The possible values are active, completed,\n deleting, and deleted.

", + "smithy.api#xmlName": "status" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

The status message for the export image task.

", + "smithy.api#xmlName": "statusMessage" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the export image task.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an export image task.

" + } + }, + "com.amazonaws.ec2#ExportImageTaskId": { + "type": "string" + }, + "com.amazonaws.ec2#ExportImageTaskIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ExportImageTaskId", + "traits": { + "smithy.api#xmlName": "ExportImageTaskId" + } + } + }, + "com.amazonaws.ec2#ExportImageTaskList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ExportImageTask", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ExportTask": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description of the resource being exported.

", + "smithy.api#xmlName": "description" + } + }, + "ExportTaskId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ExportTaskId", + "smithy.api#documentation": "

The ID of the export task.

", + "smithy.api#xmlName": "exportTaskId" + } + }, + "ExportToS3Task": { + "target": "com.amazonaws.ec2#ExportToS3Task", + "traits": { + "aws.protocols#ec2QueryName": "ExportToS3", + "smithy.api#documentation": "

Information about the export task.

", + "smithy.api#xmlName": "exportToS3" + } + }, + "InstanceExportDetails": { + "target": "com.amazonaws.ec2#InstanceExportDetails", + "traits": { + "aws.protocols#ec2QueryName": "InstanceExport", + "smithy.api#documentation": "

Information about the instance to export.

", + "smithy.api#xmlName": "instanceExport" + } + }, + "State": { + "target": "com.amazonaws.ec2#ExportTaskState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the export task.

", + "smithy.api#xmlName": "state" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

The status message related to the export task.

", + "smithy.api#xmlName": "statusMessage" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags for the export task.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an export instance task.

" + } + }, + "com.amazonaws.ec2#ExportTaskId": { + "type": "string" + }, + "com.amazonaws.ec2#ExportTaskIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ExportTaskId", + "traits": { + "smithy.api#xmlName": "ExportTaskId" + } + } + }, + "com.amazonaws.ec2#ExportTaskList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ExportTask", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ExportTaskS3Location": { + "type": "structure", + "members": { + "S3Bucket": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "S3Bucket", + "smithy.api#documentation": "

The destination Amazon S3 bucket.

", + "smithy.api#xmlName": "s3Bucket" + } + }, + "S3Prefix": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "S3Prefix", + "smithy.api#documentation": "

The prefix (logical hierarchy) in the bucket.

", + "smithy.api#xmlName": "s3Prefix" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the destination for an export image task.

" + } + }, + "com.amazonaws.ec2#ExportTaskS3LocationRequest": { + "type": "structure", + "members": { + "S3Bucket": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The destination Amazon S3 bucket.

", + "smithy.api#required": {} + } + }, + "S3Prefix": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The prefix (logical hierarchy) in the bucket.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the destination for an export image task.

" + } + }, + "com.amazonaws.ec2#ExportTaskState": { + "type": "enum", + "members": { + "active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "cancelling": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cancelling" + } + }, + "cancelled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cancelled" + } + }, + "completed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "completed" + } + } + } + }, + "com.amazonaws.ec2#ExportToS3Task": { + "type": "structure", + "members": { + "ContainerFormat": { + "target": "com.amazonaws.ec2#ContainerFormat", + "traits": { + "aws.protocols#ec2QueryName": "ContainerFormat", + "smithy.api#documentation": "

The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is\n exported.

", + "smithy.api#xmlName": "containerFormat" + } + }, + "DiskImageFormat": { + "target": "com.amazonaws.ec2#DiskImageFormat", + "traits": { + "aws.protocols#ec2QueryName": "DiskImageFormat", + "smithy.api#documentation": "

The format for the exported image.

", + "smithy.api#xmlName": "diskImageFormat" + } + }, + "S3Bucket": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "S3Bucket", + "smithy.api#documentation": "

The Amazon S3 bucket for the destination image. The destination bucket must exist and have\n an access control list (ACL) attached that specifies the Region-specific canonical account ID for\n the Grantee. For more information about the ACL to your S3 bucket, see Prerequisites in the VM Import/Export User Guide.

", + "smithy.api#xmlName": "s3Bucket" + } + }, + "S3Key": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "S3Key", + "smithy.api#documentation": "

The encryption key for your S3 bucket.

", + "smithy.api#xmlName": "s3Key" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the format and location for the export task.

" + } + }, + "com.amazonaws.ec2#ExportToS3TaskSpecification": { + "type": "structure", + "members": { + "DiskImageFormat": { + "target": "com.amazonaws.ec2#DiskImageFormat", + "traits": { + "aws.protocols#ec2QueryName": "DiskImageFormat", + "smithy.api#documentation": "

The format for the exported image.

", + "smithy.api#xmlName": "diskImageFormat" + } + }, + "ContainerFormat": { + "target": "com.amazonaws.ec2#ContainerFormat", + "traits": { + "aws.protocols#ec2QueryName": "ContainerFormat", + "smithy.api#documentation": "

The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is\n exported.

", + "smithy.api#xmlName": "containerFormat" + } + }, + "S3Bucket": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "S3Bucket", + "smithy.api#documentation": "

The Amazon S3 bucket for the destination image. The destination bucket must exist and have\n an access control list (ACL) attached that specifies the Region-specific canonical account ID for\n the Grantee. For more information about the ACL to your S3 bucket, see Prerequisites in the VM Import/Export User Guide.

", + "smithy.api#xmlName": "s3Bucket" + } + }, + "S3Prefix": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "S3Prefix", + "smithy.api#documentation": "

The image is written to a single object in the Amazon S3 bucket at the S3 key s3prefix +\n exportTaskId + '.' + diskImageFormat.

", + "smithy.api#xmlName": "s3Prefix" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an export instance task.

" + } + }, + "com.amazonaws.ec2#ExportTransitGatewayRoutes": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ExportTransitGatewayRoutesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ExportTransitGatewayRoutesResult" + }, + "traits": { + "smithy.api#documentation": "

Exports routes from the specified transit gateway route table to the specified S3 bucket.\n By default, all routes are exported. Alternatively, you can filter by CIDR range.

\n

The routes are saved to the specified bucket in a JSON file. For more information, see\n Export route tables\n to Amazon S3 in the Amazon Web Services Transit Gateways Guide.

" + } + }, + "com.amazonaws.ec2#ExportTransitGatewayRoutesRequest": { + "type": "structure", + "members": { + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the route table.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "S3Bucket": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the S3 bucket.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ExportTransitGatewayRoutesResult": { + "type": "structure", + "members": { + "S3Location": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "S3Location", + "smithy.api#documentation": "

The URL of the exported file in Amazon S3. For example, \n s3://bucket_name/VPCTransitGateway/TransitGatewayRouteTables/file_name.

", + "smithy.api#xmlName": "s3Location" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ExportVerifiedAccessInstanceClientConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ExportVerifiedAccessInstanceClientConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ExportVerifiedAccessInstanceClientConfigurationResult" + }, + "traits": { + "smithy.api#documentation": "

Exports the client configuration for a Verified Access instance.

" + } + }, + "com.amazonaws.ec2#ExportVerifiedAccessInstanceClientConfigurationRequest": { + "type": "structure", + "members": { + "VerifiedAccessInstanceId": { + "target": "com.amazonaws.ec2#VerifiedAccessInstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Verified Access instance.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ExportVerifiedAccessInstanceClientConfigurationResult": { + "type": "structure", + "members": { + "Version": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Version", + "smithy.api#documentation": "

The version.

", + "smithy.api#xmlName": "version" + } + }, + "VerifiedAccessInstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessInstanceId", + "smithy.api#documentation": "

The ID of the Verified Access instance.

", + "smithy.api#xmlName": "verifiedAccessInstanceId" + } + }, + "Region": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Region", + "smithy.api#documentation": "

The Region.

", + "smithy.api#xmlName": "region" + } + }, + "DeviceTrustProviders": { + "target": "com.amazonaws.ec2#DeviceTrustProviderTypeList", + "traits": { + "aws.protocols#ec2QueryName": "DeviceTrustProviderSet", + "smithy.api#documentation": "

The device trust providers.

", + "smithy.api#xmlName": "deviceTrustProviderSet" + } + }, + "UserTrustProvider": { + "target": "com.amazonaws.ec2#VerifiedAccessInstanceUserTrustProviderClientConfiguration", + "traits": { + "aws.protocols#ec2QueryName": "UserTrustProvider", + "smithy.api#documentation": "

The user identity trust provider.

", + "smithy.api#xmlName": "userTrustProvider" + } + }, + "OpenVpnConfigurations": { + "target": "com.amazonaws.ec2#VerifiedAccessInstanceOpenVpnClientConfigurationList", + "traits": { + "aws.protocols#ec2QueryName": "OpenVpnConfigurationSet", + "smithy.api#documentation": "

The Open VPN configuration.

", + "smithy.api#xmlName": "openVpnConfigurationSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ExportVmTaskId": { + "type": "string" + }, + "com.amazonaws.ec2#FailedCapacityReservationFleetCancellationResult": { + "type": "structure", + "members": { + "CapacityReservationFleetId": { + "target": "com.amazonaws.ec2#CapacityReservationFleetId", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationFleetId", + "smithy.api#documentation": "

The ID of the Capacity Reservation Fleet that could not be cancelled.

", + "smithy.api#xmlName": "capacityReservationFleetId" + } + }, + "CancelCapacityReservationFleetError": { + "target": "com.amazonaws.ec2#CancelCapacityReservationFleetError", + "traits": { + "aws.protocols#ec2QueryName": "CancelCapacityReservationFleetError", + "smithy.api#documentation": "

Information about the Capacity Reservation Fleet cancellation error.

", + "smithy.api#xmlName": "cancelCapacityReservationFleetError" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Capacity Reservation Fleet that could not be cancelled.

" + } + }, + "com.amazonaws.ec2#FailedCapacityReservationFleetCancellationResultSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#FailedCapacityReservationFleetCancellationResult", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#FailedQueuedPurchaseDeletion": { + "type": "structure", + "members": { + "Error": { + "target": "com.amazonaws.ec2#DeleteQueuedReservedInstancesError", + "traits": { + "aws.protocols#ec2QueryName": "Error", + "smithy.api#documentation": "

The error.

", + "smithy.api#xmlName": "error" + } + }, + "ReservedInstancesId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstancesId", + "smithy.api#documentation": "

The ID of the Reserved Instance.

", + "smithy.api#xmlName": "reservedInstancesId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Reserved Instance whose queued purchase was not deleted.

" + } + }, + "com.amazonaws.ec2#FailedQueuedPurchaseDeletionSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#FailedQueuedPurchaseDeletion", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#FastLaunchImageIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#xmlName": "ImageId" + } + } + }, + "com.amazonaws.ec2#FastLaunchLaunchTemplateSpecificationRequest": { + "type": "structure", + "members": { + "LaunchTemplateId": { + "target": "com.amazonaws.ec2#LaunchTemplateId", + "traits": { + "smithy.api#documentation": "

Specify the ID of the launch template that the AMI should use for Windows fast\n launch.

" + } + }, + "LaunchTemplateName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Specify the name of the launch template that the AMI should use for Windows fast\n launch.

" + } + }, + "Version": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specify the version of the launch template that the AMI should use for Windows fast\n launch.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Request to create a launch template for a Windows fast launch enabled AMI.

\n \n

Note - You can specify either the LaunchTemplateName or the\n LaunchTemplateId, but not both.

\n " + } + }, + "com.amazonaws.ec2#FastLaunchLaunchTemplateSpecificationResponse": { + "type": "structure", + "members": { + "LaunchTemplateId": { + "target": "com.amazonaws.ec2#LaunchTemplateId", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateId", + "smithy.api#documentation": "

The ID of the launch template that the AMI uses for Windows fast launch.

", + "smithy.api#xmlName": "launchTemplateId" + } + }, + "LaunchTemplateName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateName", + "smithy.api#documentation": "

The name of the launch template that the AMI uses for Windows fast launch.

", + "smithy.api#xmlName": "launchTemplateName" + } + }, + "Version": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Version", + "smithy.api#documentation": "

The version of the launch template that the AMI uses for Windows fast launch.

", + "smithy.api#xmlName": "version" + } + } + }, + "traits": { + "smithy.api#documentation": "

Identifies the launch template that the AMI uses for Windows fast launch.

" + } + }, + "com.amazonaws.ec2#FastLaunchResourceType": { + "type": "enum", + "members": { + "SNAPSHOT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "snapshot" + } + } + } + }, + "com.amazonaws.ec2#FastLaunchSnapshotConfigurationRequest": { + "type": "structure", + "members": { + "TargetResourceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The number of pre-provisioned snapshots to keep on hand for a Windows fast launch enabled\n AMI.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration settings for creating and managing pre-provisioned snapshots for a Windows\n fast launch enabled AMI.

" + } + }, + "com.amazonaws.ec2#FastLaunchSnapshotConfigurationResponse": { + "type": "structure", + "members": { + "TargetResourceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TargetResourceCount", + "smithy.api#documentation": "

The number of pre-provisioned snapshots requested to keep on hand for a Windows fast\n launch enabled AMI.

", + "smithy.api#xmlName": "targetResourceCount" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration settings for creating and managing pre-provisioned snapshots for a Windows\n fast launch enabled Windows AMI.

" + } + }, + "com.amazonaws.ec2#FastLaunchStateCode": { + "type": "enum", + "members": { + "enabling": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabling" + } + }, + "enabling_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabling-failed" + } + }, + "enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + }, + "enabled_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled-failed" + } + }, + "disabling": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabling" + } + }, + "disabling_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabling-failed" + } + } + } + }, + "com.amazonaws.ec2#FastSnapshotRestoreStateCode": { + "type": "enum", + "members": { + "enabling": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabling" + } + }, + "optimizing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "optimizing" + } + }, + "enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + }, + "disabling": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabling" + } + }, + "disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + } + } + }, + "com.amazonaws.ec2#FederatedAuthentication": { + "type": "structure", + "members": { + "SamlProviderArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SamlProviderArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM SAML identity provider.

", + "smithy.api#xmlName": "samlProviderArn" + } + }, + "SelfServiceSamlProviderArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SelfServiceSamlProviderArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM SAML identity provider for the self-service portal.

", + "smithy.api#xmlName": "selfServiceSamlProviderArn" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the IAM SAML identity providers used for federated authentication.

" + } + }, + "com.amazonaws.ec2#FederatedAuthenticationRequest": { + "type": "structure", + "members": { + "SAMLProviderArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM SAML identity provider.

" + } + }, + "SelfServiceSAMLProviderArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM SAML identity provider for the self-service portal.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The IAM SAML identity provider used for federated authentication.

" + } + }, + "com.amazonaws.ec2#Filter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the filter. Filter names are case-sensitive.

" + } + }, + "Values": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The filter values. Filter values are case-sensitive. If you specify multiple values for a \n filter, the values are joined with an OR, and the request returns all results \n that match any of the specified values.

", + "smithy.api#xmlName": "Value" + } + } + }, + "traits": { + "smithy.api#documentation": "

A filter name and value pair that is used to return a more specific list of results from a describe operation. \n Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

\n

If you specify multiple filters, the filters are joined with an AND, and the request returns only \n results that match all of the specified filters.

\n

For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#FilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Filter", + "traits": { + "smithy.api#xmlName": "Filter" + } + } + }, + "com.amazonaws.ec2#FilterPortRange": { + "type": "structure", + "members": { + "FromPort": { + "target": "com.amazonaws.ec2#Port", + "traits": { + "aws.protocols#ec2QueryName": "FromPort", + "smithy.api#documentation": "

The first port in the range.

", + "smithy.api#xmlName": "fromPort" + } + }, + "ToPort": { + "target": "com.amazonaws.ec2#Port", + "traits": { + "aws.protocols#ec2QueryName": "ToPort", + "smithy.api#documentation": "

The last port in the range.

", + "smithy.api#xmlName": "toPort" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a port range.

" + } + }, + "com.amazonaws.ec2#FindingsFound": { + "type": "enum", + "members": { + "true": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "true" + } + }, + "false": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "false" + } + }, + "unknown": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unknown" + } + } + } + }, + "com.amazonaws.ec2#FirewallStatefulRule": { + "type": "structure", + "members": { + "RuleGroupArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "RuleGroupArn", + "smithy.api#documentation": "

The ARN of the stateful rule group.

", + "smithy.api#xmlName": "ruleGroupArn" + } + }, + "Sources": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "SourceSet", + "smithy.api#documentation": "

The source IP addresses, in CIDR notation.

", + "smithy.api#xmlName": "sourceSet" + } + }, + "Destinations": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "DestinationSet", + "smithy.api#documentation": "

The destination IP addresses, in CIDR notation.

", + "smithy.api#xmlName": "destinationSet" + } + }, + "SourcePorts": { + "target": "com.amazonaws.ec2#PortRangeList", + "traits": { + "aws.protocols#ec2QueryName": "SourcePortSet", + "smithy.api#documentation": "

The source ports.

", + "smithy.api#xmlName": "sourcePortSet" + } + }, + "DestinationPorts": { + "target": "com.amazonaws.ec2#PortRangeList", + "traits": { + "aws.protocols#ec2QueryName": "DestinationPortSet", + "smithy.api#documentation": "

The destination ports.

", + "smithy.api#xmlName": "destinationPortSet" + } + }, + "Protocol": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Protocol", + "smithy.api#documentation": "

The protocol.

", + "smithy.api#xmlName": "protocol" + } + }, + "RuleAction": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RuleAction", + "smithy.api#documentation": "

The rule action. The possible values are pass, drop, and \n alert.

", + "smithy.api#xmlName": "ruleAction" + } + }, + "Direction": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Direction", + "smithy.api#documentation": "

The direction. The possible values are FORWARD and ANY.

", + "smithy.api#xmlName": "direction" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a stateful rule.

" + } + }, + "com.amazonaws.ec2#FirewallStatelessRule": { + "type": "structure", + "members": { + "RuleGroupArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "RuleGroupArn", + "smithy.api#documentation": "

The ARN of the stateless rule group.

", + "smithy.api#xmlName": "ruleGroupArn" + } + }, + "Sources": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "SourceSet", + "smithy.api#documentation": "

The source IP addresses, in CIDR notation.

", + "smithy.api#xmlName": "sourceSet" + } + }, + "Destinations": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "DestinationSet", + "smithy.api#documentation": "

The destination IP addresses, in CIDR notation.

", + "smithy.api#xmlName": "destinationSet" + } + }, + "SourcePorts": { + "target": "com.amazonaws.ec2#PortRangeList", + "traits": { + "aws.protocols#ec2QueryName": "SourcePortSet", + "smithy.api#documentation": "

The source ports.

", + "smithy.api#xmlName": "sourcePortSet" + } + }, + "DestinationPorts": { + "target": "com.amazonaws.ec2#PortRangeList", + "traits": { + "aws.protocols#ec2QueryName": "DestinationPortSet", + "smithy.api#documentation": "

The destination ports.

", + "smithy.api#xmlName": "destinationPortSet" + } + }, + "Protocols": { + "target": "com.amazonaws.ec2#ProtocolIntList", + "traits": { + "aws.protocols#ec2QueryName": "ProtocolSet", + "smithy.api#documentation": "

The protocols.

", + "smithy.api#xmlName": "protocolSet" + } + }, + "RuleAction": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RuleAction", + "smithy.api#documentation": "

The rule action. The possible values are pass, drop, and \n forward_to_site.

", + "smithy.api#xmlName": "ruleAction" + } + }, + "Priority": { + "target": "com.amazonaws.ec2#Priority", + "traits": { + "aws.protocols#ec2QueryName": "Priority", + "smithy.api#documentation": "

The rule priority.

", + "smithy.api#xmlName": "priority" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a stateless rule.

" + } + }, + "com.amazonaws.ec2#FleetActivityStatus": { + "type": "enum", + "members": { + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "error" + } + }, + "PENDING_FULFILLMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending_fulfillment" + } + }, + "PENDING_TERMINATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending_termination" + } + }, + "FULFILLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fulfilled" + } + } + } + }, + "com.amazonaws.ec2#FleetCapacityReservation": { + "type": "structure", + "members": { + "CapacityReservationId": { + "target": "com.amazonaws.ec2#CapacityReservationId", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationId", + "smithy.api#documentation": "

The ID of the Capacity Reservation.

", + "smithy.api#xmlName": "capacityReservationId" + } + }, + "AvailabilityZoneId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZoneId", + "smithy.api#documentation": "

The ID of the Availability Zone in which the Capacity Reservation reserves\n\t\t\tcapacity.

", + "smithy.api#xmlName": "availabilityZoneId" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type for which the Capacity Reservation reserves capacity.

", + "smithy.api#xmlName": "instanceType" + } + }, + "InstancePlatform": { + "target": "com.amazonaws.ec2#CapacityReservationInstancePlatform", + "traits": { + "aws.protocols#ec2QueryName": "InstancePlatform", + "smithy.api#documentation": "

The type of operating system for which the Capacity Reservation reserves\n\t\t\tcapacity.

", + "smithy.api#xmlName": "instancePlatform" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone in which the Capacity Reservation reserves capacity.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "TotalInstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TotalInstanceCount", + "smithy.api#documentation": "

The total number of instances for which the Capacity Reservation reserves\n\t\t\tcapacity.

", + "smithy.api#xmlName": "totalInstanceCount" + } + }, + "FulfilledCapacity": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "FulfilledCapacity", + "smithy.api#documentation": "

The number of capacity units fulfilled by the Capacity Reservation. For more\n\t\t\tinformation, see Total target\n\t\t\t\tcapacity in the Amazon EC2 User Guide.

", + "smithy.api#xmlName": "fulfilledCapacity" + } + }, + "EbsOptimized": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EbsOptimized", + "smithy.api#documentation": "

Indicates whether the Capacity Reservation reserves capacity for EBS-optimized\n\t\t\tinstance types.

", + "smithy.api#xmlName": "ebsOptimized" + } + }, + "CreateDate": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreateDate", + "smithy.api#documentation": "

The date and time at which the Capacity Reservation was created.

", + "smithy.api#xmlName": "createDate" + } + }, + "Weight": { + "target": "com.amazonaws.ec2#DoubleWithConstraints", + "traits": { + "aws.protocols#ec2QueryName": "Weight", + "smithy.api#documentation": "

The weight of the instance type in the Capacity Reservation Fleet. For more\n\t\t\tinformation, see Instance type\n\t\t\t\tweight in the Amazon EC2 User Guide.

", + "smithy.api#xmlName": "weight" + } + }, + "Priority": { + "target": "com.amazonaws.ec2#IntegerWithConstraints", + "traits": { + "aws.protocols#ec2QueryName": "Priority", + "smithy.api#documentation": "

The priority of the instance type in the Capacity Reservation Fleet. For more\n\t\t\tinformation, see Instance type\n\t\t\t\tpriority in the Amazon EC2 User Guide.

", + "smithy.api#xmlName": "priority" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a Capacity Reservation in a Capacity Reservation Fleet.

" + } + }, + "com.amazonaws.ec2#FleetCapacityReservationSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#FleetCapacityReservation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#FleetCapacityReservationTenancy": { + "type": "enum", + "members": { + "default": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "default" + } + } + } + }, + "com.amazonaws.ec2#FleetCapacityReservationUsageStrategy": { + "type": "enum", + "members": { + "USE_CAPACITY_RESERVATIONS_FIRST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "use-capacity-reservations-first" + } + } + } + }, + "com.amazonaws.ec2#FleetData": { + "type": "structure", + "members": { + "ActivityStatus": { + "target": "com.amazonaws.ec2#FleetActivityStatus", + "traits": { + "aws.protocols#ec2QueryName": "ActivityStatus", + "smithy.api#documentation": "

The progress of the EC2 Fleet. If there is an error, the status is error. After\n all requests are placed, the status is pending_fulfillment. If the size of the\n EC2 Fleet is equal to or greater than its target capacity, the status is fulfilled.\n If the size of the EC2 Fleet is decreased, the status is pending_termination while\n instances are terminating.

", + "smithy.api#xmlName": "activityStatus" + } + }, + "CreateTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreateTime", + "smithy.api#documentation": "

The creation date and time of the EC2 Fleet.

", + "smithy.api#xmlName": "createTime" + } + }, + "FleetId": { + "target": "com.amazonaws.ec2#FleetId", + "traits": { + "aws.protocols#ec2QueryName": "FleetId", + "smithy.api#documentation": "

The ID of the EC2 Fleet.

", + "smithy.api#xmlName": "fleetId" + } + }, + "FleetState": { + "target": "com.amazonaws.ec2#FleetStateCode", + "traits": { + "aws.protocols#ec2QueryName": "FleetState", + "smithy.api#documentation": "

The state of the EC2 Fleet.

", + "smithy.api#xmlName": "fleetState" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n idempotency.

\n

Constraints: Maximum 64 ASCII characters

", + "smithy.api#xmlName": "clientToken" + } + }, + "ExcessCapacityTerminationPolicy": { + "target": "com.amazonaws.ec2#FleetExcessCapacityTerminationPolicy", + "traits": { + "aws.protocols#ec2QueryName": "ExcessCapacityTerminationPolicy", + "smithy.api#documentation": "

Indicates whether running instances should be terminated if the target capacity of the\n EC2 Fleet is decreased below the current size of the EC2 Fleet.

\n

Supported only for fleets of type maintain.

", + "smithy.api#xmlName": "excessCapacityTerminationPolicy" + } + }, + "FulfilledCapacity": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "FulfilledCapacity", + "smithy.api#documentation": "

The number of units fulfilled by this request compared to the set target\n capacity.

", + "smithy.api#xmlName": "fulfilledCapacity" + } + }, + "FulfilledOnDemandCapacity": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "FulfilledOnDemandCapacity", + "smithy.api#documentation": "

The number of units fulfilled by this request compared to the set target On-Demand\n capacity.

", + "smithy.api#xmlName": "fulfilledOnDemandCapacity" + } + }, + "LaunchTemplateConfigs": { + "target": "com.amazonaws.ec2#FleetLaunchTemplateConfigList", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateConfigs", + "smithy.api#documentation": "

The launch template and overrides.

", + "smithy.api#xmlName": "launchTemplateConfigs" + } + }, + "TargetCapacitySpecification": { + "target": "com.amazonaws.ec2#TargetCapacitySpecification", + "traits": { + "aws.protocols#ec2QueryName": "TargetCapacitySpecification", + "smithy.api#documentation": "

The number of units to request. You can choose to set the target capacity in terms of\n instances or a performance characteristic that is important to your application workload,\n such as vCPUs, memory, or I/O. If the request type is maintain, you can\n specify a target capacity of 0 and add capacity later.

", + "smithy.api#xmlName": "targetCapacitySpecification" + } + }, + "TerminateInstancesWithExpiration": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "TerminateInstancesWithExpiration", + "smithy.api#documentation": "

Indicates whether running instances should be terminated when the EC2 Fleet expires.

", + "smithy.api#xmlName": "terminateInstancesWithExpiration" + } + }, + "Type": { + "target": "com.amazonaws.ec2#FleetType", + "traits": { + "aws.protocols#ec2QueryName": "Type", + "smithy.api#documentation": "

The type of request. Indicates whether the EC2 Fleet only requests the target\n capacity, or also attempts to maintain it. If you request a certain target\n capacity, EC2 Fleet only places the required requests; it does not attempt to replenish\n instances if capacity is diminished, and it does not submit requests in alternative\n capacity pools if capacity is unavailable. To maintain a certain target capacity, EC2 Fleet\n places the required requests to meet this target capacity. It also automatically\n replenishes any interrupted Spot Instances. Default: maintain.

", + "smithy.api#xmlName": "type" + } + }, + "ValidFrom": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "ValidFrom", + "smithy.api#documentation": "

The start date and time of the request, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).\n The default is to start fulfilling the request immediately.

", + "smithy.api#xmlName": "validFrom" + } + }, + "ValidUntil": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "ValidUntil", + "smithy.api#documentation": "

The end date and time of the request, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).\n At this point, no new instance requests are placed or able to fulfill the request. The\n default end date is 7 days from the current date.

", + "smithy.api#xmlName": "validUntil" + } + }, + "ReplaceUnhealthyInstances": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "ReplaceUnhealthyInstances", + "smithy.api#documentation": "

Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported only for\n fleets of type maintain. For more information, see EC2 Fleet\n health checks in the Amazon EC2 User Guide.

", + "smithy.api#xmlName": "replaceUnhealthyInstances" + } + }, + "SpotOptions": { + "target": "com.amazonaws.ec2#SpotOptions", + "traits": { + "aws.protocols#ec2QueryName": "SpotOptions", + "smithy.api#documentation": "

The configuration of Spot Instances in an EC2 Fleet.

", + "smithy.api#xmlName": "spotOptions" + } + }, + "OnDemandOptions": { + "target": "com.amazonaws.ec2#OnDemandOptions", + "traits": { + "aws.protocols#ec2QueryName": "OnDemandOptions", + "smithy.api#documentation": "

The allocation strategy of On-Demand Instances in an EC2 Fleet.

", + "smithy.api#xmlName": "onDemandOptions" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags for an EC2 Fleet resource.

", + "smithy.api#xmlName": "tagSet" + } + }, + "Errors": { + "target": "com.amazonaws.ec2#DescribeFleetsErrorSet", + "traits": { + "aws.protocols#ec2QueryName": "ErrorSet", + "smithy.api#documentation": "

Information about the instances that could not be launched by the fleet. Valid only when\n Type is set to instant.

", + "smithy.api#xmlName": "errorSet" + } + }, + "Instances": { + "target": "com.amazonaws.ec2#DescribeFleetsInstancesSet", + "traits": { + "aws.protocols#ec2QueryName": "FleetInstanceSet", + "smithy.api#documentation": "

Information about the instances that were launched by the fleet. Valid only when\n Type is set to instant.

", + "smithy.api#xmlName": "fleetInstanceSet" + } + }, + "Context": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Context", + "smithy.api#documentation": "

Reserved.

", + "smithy.api#xmlName": "context" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an EC2 Fleet.

" + } + }, + "com.amazonaws.ec2#FleetEventType": { + "type": "enum", + "members": { + "INSTANCE_CHANGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "instance-change" + } + }, + "FLEET_CHANGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fleet-change" + } + }, + "SERVICE_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "service-error" + } + } + } + }, + "com.amazonaws.ec2#FleetExcessCapacityTerminationPolicy": { + "type": "enum", + "members": { + "NO_TERMINATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "no-termination" + } + }, + "TERMINATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "termination" + } + } + } + }, + "com.amazonaws.ec2#FleetId": { + "type": "string" + }, + "com.amazonaws.ec2#FleetIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#FleetId" + } + }, + "com.amazonaws.ec2#FleetInstanceMatchCriteria": { + "type": "enum", + "members": { + "open": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "open" + } + } + } + }, + "com.amazonaws.ec2#FleetLaunchTemplateConfig": { + "type": "structure", + "members": { + "LaunchTemplateSpecification": { + "target": "com.amazonaws.ec2#FleetLaunchTemplateSpecification", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateSpecification", + "smithy.api#documentation": "

The launch template.

", + "smithy.api#xmlName": "launchTemplateSpecification" + } + }, + "Overrides": { + "target": "com.amazonaws.ec2#FleetLaunchTemplateOverridesList", + "traits": { + "aws.protocols#ec2QueryName": "Overrides", + "smithy.api#documentation": "

Any parameters that you specify override the same parameters in the launch\n template.

", + "smithy.api#xmlName": "overrides" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a launch template and overrides.

" + } + }, + "com.amazonaws.ec2#FleetLaunchTemplateConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#FleetLaunchTemplateConfig", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#FleetLaunchTemplateConfigListRequest": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#FleetLaunchTemplateConfigRequest", + "traits": { + "smithy.api#xmlName": "item" + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.ec2#FleetLaunchTemplateConfigRequest": { + "type": "structure", + "members": { + "LaunchTemplateSpecification": { + "target": "com.amazonaws.ec2#FleetLaunchTemplateSpecificationRequest", + "traits": { + "smithy.api#documentation": "

The launch template to use. You must specify either the launch template ID or launch\n template name in the request.

" + } + }, + "Overrides": { + "target": "com.amazonaws.ec2#FleetLaunchTemplateOverridesListRequest", + "traits": { + "smithy.api#documentation": "

Any parameters that you specify override the same parameters in the launch\n template.

\n

For fleets of type request and maintain, a maximum of 300\n items is allowed across all launch templates.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a launch template and overrides.

" + } + }, + "com.amazonaws.ec2#FleetLaunchTemplateOverrides": { + "type": "structure", + "members": { + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type.

\n

\n mac1.metal is not supported as a launch template override.

\n \n

If you specify InstanceType, you can't specify\n InstanceRequirements.

\n ", + "smithy.api#xmlName": "instanceType" + } + }, + "MaxPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "MaxPrice", + "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.\n

\n \n

If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.

\n ", + "smithy.api#xmlName": "maxPrice" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet in which to launch the instances.

", + "smithy.api#xmlName": "subnetId" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone in which to launch the instances.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "WeightedCapacity": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "WeightedCapacity", + "smithy.api#documentation": "

The number of units provided by the specified instance type. These are the same units\n that you chose to set the target capacity in terms of instances, or a performance\n characteristic such as vCPUs, memory, or I/O.

\n

If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the\n number of instances to the next whole number. If this value is not specified, the default\n is 1.

\n \n

When specifying weights, the price used in the lowest-price and\n price-capacity-optimized allocation strategies is per\n unit hour (where the instance price is divided by the specified\n weight). However, if all the specified weights are above the requested\n TargetCapacity, resulting in only 1 instance being launched, the price\n used is per instance hour.

\n ", + "smithy.api#xmlName": "weightedCapacity" + } + }, + "Priority": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "Priority", + "smithy.api#documentation": "

The priority for the launch template override. The highest priority is launched\n first.

\n

If the On-Demand AllocationStrategy is set to prioritized,\n EC2 Fleet uses priority to determine which launch template override to use first in fulfilling\n On-Demand capacity.

\n

If the Spot AllocationStrategy is set to\n capacity-optimized-prioritized, EC2 Fleet uses priority on a best-effort basis\n to determine which launch template override to use in fulfilling Spot capacity, but\n optimizes for capacity first.

\n

Valid values are whole numbers starting at 0. The lower the number, the\n higher the priority. If no number is set, the override has the lowest priority. You can set\n the same priority for different launch template overrides.

", + "smithy.api#xmlName": "priority" + } + }, + "Placement": { + "target": "com.amazonaws.ec2#PlacementResponse", + "traits": { + "aws.protocols#ec2QueryName": "Placement", + "smithy.api#documentation": "

The location where the instance launched, if applicable.

", + "smithy.api#xmlName": "placement" + } + }, + "InstanceRequirements": { + "target": "com.amazonaws.ec2#InstanceRequirements", + "traits": { + "aws.protocols#ec2QueryName": "InstanceRequirements", + "smithy.api#documentation": "

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will\n identify instance types with those attributes.

\n \n

If you specify InstanceRequirements, you can't specify\n InstanceType.

\n ", + "smithy.api#xmlName": "instanceRequirements" + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the AMI in the format ami-17characters00000.

\n

Alternatively, you can specify a Systems Manager parameter, using one of the following\n formats. The Systems Manager parameter will resolve to an AMI ID on launch.

\n

To reference a public parameter:

\n \n

To reference a parameter stored in the same account:

\n \n

To reference a parameter shared from another Amazon Web Services account:

\n \n

For more information, see Use a Systems Manager parameter instead of an AMI ID in the\n Amazon EC2 User Guide.

\n \n

This parameter is only available for fleets of type instant. For fleets\n of type maintain and request, you must specify the AMI ID in\n the launch template.

\n ", + "smithy.api#xmlName": "imageId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes overrides for a launch template.

" + } + }, + "com.amazonaws.ec2#FleetLaunchTemplateOverridesList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#FleetLaunchTemplateOverrides", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#FleetLaunchTemplateOverridesListRequest": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#FleetLaunchTemplateOverridesRequest", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#FleetLaunchTemplateOverridesRequest": { + "type": "structure", + "members": { + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "smithy.api#documentation": "

The instance type.

\n

\n mac1.metal is not supported as a launch template override.

\n \n

If you specify InstanceType, you can't specify\n InstanceRequirements.

\n " + } + }, + "MaxPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.\n

\n \n

If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.

\n " + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "smithy.api#documentation": "

The IDs of the subnets in which to launch the instances. Separate multiple subnet IDs using commas (for example, subnet-1234abcdeexample1, subnet-0987cdef6example2). A request of type instant can have only one subnet ID.

" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone in which to launch the instances.

" + } + }, + "WeightedCapacity": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "smithy.api#documentation": "

The number of units provided by the specified instance type. These are the same units\n that you chose to set the target capacity in terms of instances, or a performance\n characteristic such as vCPUs, memory, or I/O.

\n

If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the\n number of instances to the next whole number. If this value is not specified, the default\n is 1.

\n \n

When specifying weights, the price used in the lowest-price and\n price-capacity-optimized allocation strategies is per\n unit hour (where the instance price is divided by the specified\n weight). However, if all the specified weights are above the requested\n TargetCapacity, resulting in only 1 instance being launched, the price\n used is per instance hour.

\n " + } + }, + "Priority": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "smithy.api#documentation": "

The priority for the launch template override. The highest priority is launched\n first.

\n

If the On-Demand AllocationStrategy is set to prioritized,\n EC2 Fleet uses priority to determine which launch template override to use first in fulfilling\n On-Demand capacity.

\n

If the Spot AllocationStrategy is set to\n capacity-optimized-prioritized, EC2 Fleet uses priority on a best-effort basis\n to determine which launch template override to use in fulfilling Spot capacity, but\n optimizes for capacity first.

\n

Valid values are whole numbers starting at 0. The lower the number, the\n higher the priority. If no number is set, the launch template override has the lowest\n priority. You can set the same priority for different launch template overrides.

" + } + }, + "Placement": { + "target": "com.amazonaws.ec2#Placement", + "traits": { + "smithy.api#documentation": "

The location where the instance launched, if applicable.

" + } + }, + "InstanceRequirements": { + "target": "com.amazonaws.ec2#InstanceRequirementsRequest", + "traits": { + "smithy.api#documentation": "

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will\n identify instance types with those attributes.

\n \n

If you specify InstanceRequirements, you can't specify\n InstanceType.

\n " + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#documentation": "

The ID of the AMI in the format ami-17characters00000.

\n

Alternatively, you can specify a Systems Manager parameter, using one of the following\n formats. The Systems Manager parameter will resolve to an AMI ID on launch.

\n

To reference a public parameter:

\n \n

To reference a parameter stored in the same account:

\n \n

To reference a parameter shared from another Amazon Web Services account:

\n \n

For more information, see Use a Systems Manager parameter instead of an AMI ID in the\n Amazon EC2 User Guide.

\n \n

This parameter is only available for fleets of type instant. For fleets\n of type maintain and request, you must specify the AMI ID in\n the launch template.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes overrides for a launch template.

" + } + }, + "com.amazonaws.ec2#FleetLaunchTemplateSpecification": { + "type": "structure", + "members": { + "LaunchTemplateId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateId", + "smithy.api#documentation": "

The ID of the launch template.

\n

You must specify the LaunchTemplateId or the LaunchTemplateName, but not both.

", + "smithy.api#xmlName": "launchTemplateId" + } + }, + "LaunchTemplateName": { + "target": "com.amazonaws.ec2#LaunchTemplateName", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateName", + "smithy.api#documentation": "

The name of the launch template.

\n

You must specify the LaunchTemplateName or the LaunchTemplateId, but not both.

", + "smithy.api#xmlName": "launchTemplateName" + } + }, + "Version": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Version", + "smithy.api#documentation": "

The launch template version number, $Latest, or $Default.\n You must specify a value, otherwise the request fails.

\n

If the value is $Latest, Amazon EC2 uses the latest version of the launch\n template.

\n

If the value is $Default, Amazon EC2 uses the default version of the launch\n template.

", + "smithy.api#xmlName": "version" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon EC2 launch template that can be used by\n a Spot Fleet to configure Amazon EC2 instances. You must specify either the ID or name of the launch template in the request, but not both.

\n

For information about launch templates,\n see Launch an instance from a launch template in the\n Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#FleetLaunchTemplateSpecificationRequest": { + "type": "structure", + "members": { + "LaunchTemplateId": { + "target": "com.amazonaws.ec2#LaunchTemplateId", + "traits": { + "smithy.api#documentation": "

The ID of the launch template.

\n

You must specify the LaunchTemplateId or the LaunchTemplateName, but not both.

" + } + }, + "LaunchTemplateName": { + "target": "com.amazonaws.ec2#LaunchTemplateName", + "traits": { + "smithy.api#documentation": "

The name of the launch template.

\n

You must specify the LaunchTemplateName or the LaunchTemplateId, but not both.

" + } + }, + "Version": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The launch template version number, $Latest, or $Default. You must specify a value, otherwise the request fails.

\n

If the value is $Latest, Amazon EC2 uses the latest version of the launch template.

\n

If the value is $Default, Amazon EC2 uses the default version of the launch template.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon EC2 launch template that can be used by\n an EC2 Fleet to configure Amazon EC2 instances. You must specify either the ID or name of the launch template in the request, but not both.

\n

For information about launch templates, see Launch\n an instance from a launch template in the\n Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#FleetOnDemandAllocationStrategy": { + "type": "enum", + "members": { + "LOWEST_PRICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "lowest-price" + } + }, + "PRIORITIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "prioritized" + } + } + } + }, + "com.amazonaws.ec2#FleetReplacementStrategy": { + "type": "enum", + "members": { + "LAUNCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "launch" + } + }, + "LAUNCH_BEFORE_TERMINATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "launch-before-terminate" + } + } + } + }, + "com.amazonaws.ec2#FleetSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#FleetData", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#FleetSpotCapacityRebalance": { + "type": "structure", + "members": { + "ReplacementStrategy": { + "target": "com.amazonaws.ec2#FleetReplacementStrategy", + "traits": { + "aws.protocols#ec2QueryName": "ReplacementStrategy", + "smithy.api#documentation": "

The replacement strategy to use. Only available for fleets of type\n maintain.

\n

\n launch - EC2 Fleet launches a new replacement Spot Instance when a\n rebalance notification is emitted for an existing Spot Instance in the fleet. EC2 Fleet\n does not terminate the instances that receive a rebalance notification. You can terminate\n the old instances, or you can leave them running. You are charged for all instances while\n they are running.

\n

\n launch-before-terminate - EC2 Fleet launches a new replacement Spot\n Instance when a rebalance notification is emitted for an existing Spot Instance in the\n fleet, and then, after a delay that you specify (in TerminationDelay),\n terminates the instances that received a rebalance notification.

", + "smithy.api#xmlName": "replacementStrategy" + } + }, + "TerminationDelay": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TerminationDelay", + "smithy.api#documentation": "

The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot\n Instance after launching a new replacement Spot Instance.

\n

Required when ReplacementStrategy is set to launch-before-terminate.

\n

Not valid when ReplacementStrategy is set to launch.

\n

Valid values: Minimum value of 120 seconds. Maximum value of 7200 seconds.

", + "smithy.api#xmlName": "terminationDelay" + } + } + }, + "traits": { + "smithy.api#documentation": "

The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an\n elevated risk of being interrupted.

" + } + }, + "com.amazonaws.ec2#FleetSpotCapacityRebalanceRequest": { + "type": "structure", + "members": { + "ReplacementStrategy": { + "target": "com.amazonaws.ec2#FleetReplacementStrategy", + "traits": { + "smithy.api#documentation": "

The replacement strategy to use. Only available for fleets of type\n maintain.

\n

\n launch - EC2 Fleet launches a replacement Spot Instance when a rebalance\n notification is emitted for an existing Spot Instance in the fleet. EC2 Fleet does not\n terminate the instances that receive a rebalance notification. You can terminate the old\n instances, or you can leave them running. You are charged for all instances while they are\n running.

\n

\n launch-before-terminate - EC2 Fleet launches a replacement Spot Instance\n when a rebalance notification is emitted for an existing Spot Instance in the fleet, and\n then, after a delay that you specify (in TerminationDelay), terminates the\n instances that received a rebalance notification.

" + } + }, + "TerminationDelay": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot\n Instance after launching a new replacement Spot Instance.

\n

Required when ReplacementStrategy is set to launch-before-terminate.

\n

Not valid when ReplacementStrategy is set to launch.

\n

Valid values: Minimum value of 120 seconds. Maximum value of 7200 seconds.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Spot Instance replacement strategy to use when Amazon EC2 emits a rebalance\n notification signal that your Spot Instance is at an elevated risk of being interrupted.\n For more information, see Capacity rebalancing in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#FleetSpotMaintenanceStrategies": { + "type": "structure", + "members": { + "CapacityRebalance": { + "target": "com.amazonaws.ec2#FleetSpotCapacityRebalance", + "traits": { + "aws.protocols#ec2QueryName": "CapacityRebalance", + "smithy.api#documentation": "

The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an\n elevated risk of being interrupted.

", + "smithy.api#xmlName": "capacityRebalance" + } + } + }, + "traits": { + "smithy.api#documentation": "

The strategies for managing your Spot Instances that are at an elevated risk of being\n interrupted.

" + } + }, + "com.amazonaws.ec2#FleetSpotMaintenanceStrategiesRequest": { + "type": "structure", + "members": { + "CapacityRebalance": { + "target": "com.amazonaws.ec2#FleetSpotCapacityRebalanceRequest", + "traits": { + "smithy.api#documentation": "

The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an\n elevated risk of being interrupted.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.

" + } + }, + "com.amazonaws.ec2#FleetStateCode": { + "type": "enum", + "members": { + "SUBMITTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "submitted" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + }, + "DELETED_RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted_running" + } + }, + "DELETED_TERMINATING_INSTANCES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted_terminating" + } + }, + "MODIFYING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modifying" + } + } + } + }, + "com.amazonaws.ec2#FleetType": { + "type": "enum", + "members": { + "REQUEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "request" + } + }, + "MAINTAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "maintain" + } + }, + "INSTANT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "instant" + } + } + } + }, + "com.amazonaws.ec2#Float": { + "type": "float" + }, + "com.amazonaws.ec2#FlowLog": { + "type": "structure", + "members": { + "CreationTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreationTime", + "smithy.api#documentation": "

The date and time the flow log was created.

", + "smithy.api#xmlName": "creationTime" + } + }, + "DeliverLogsErrorMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DeliverLogsErrorMessage", + "smithy.api#documentation": "

Information about the error that occurred. Rate limited indicates that\n CloudWatch Logs throttling has been applied for one or more network interfaces, or that you've\n reached the limit on the number of log groups that you can create. Access\n error indicates that the IAM role associated with the flow log does not have\n sufficient permissions to publish to CloudWatch Logs. Unknown error indicates an\n internal error.

", + "smithy.api#xmlName": "deliverLogsErrorMessage" + } + }, + "DeliverLogsPermissionArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DeliverLogsPermissionArn", + "smithy.api#documentation": "

The ARN of the IAM role allows the service to publish logs to CloudWatch Logs.

", + "smithy.api#xmlName": "deliverLogsPermissionArn" + } + }, + "DeliverCrossAccountRole": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DeliverCrossAccountRole", + "smithy.api#documentation": "

The ARN of the IAM role that allows the service to publish flow logs across accounts.

", + "smithy.api#xmlName": "deliverCrossAccountRole" + } + }, + "DeliverLogsStatus": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DeliverLogsStatus", + "smithy.api#documentation": "

The status of the logs delivery (SUCCESS | FAILED).

", + "smithy.api#xmlName": "deliverLogsStatus" + } + }, + "FlowLogId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "FlowLogId", + "smithy.api#documentation": "

The ID of the flow log.

", + "smithy.api#xmlName": "flowLogId" + } + }, + "FlowLogStatus": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "FlowLogStatus", + "smithy.api#documentation": "

The status of the flow log (ACTIVE).

", + "smithy.api#xmlName": "flowLogStatus" + } + }, + "LogGroupName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LogGroupName", + "smithy.api#documentation": "

The name of the flow log group.

", + "smithy.api#xmlName": "logGroupName" + } + }, + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The ID of the resource being monitored.

", + "smithy.api#xmlName": "resourceId" + } + }, + "TrafficType": { + "target": "com.amazonaws.ec2#TrafficType", + "traits": { + "aws.protocols#ec2QueryName": "TrafficType", + "smithy.api#documentation": "

The type of traffic captured for the flow log.

", + "smithy.api#xmlName": "trafficType" + } + }, + "LogDestinationType": { + "target": "com.amazonaws.ec2#LogDestinationType", + "traits": { + "aws.protocols#ec2QueryName": "LogDestinationType", + "smithy.api#documentation": "

The type of destination for the flow log data.

", + "smithy.api#xmlName": "logDestinationType" + } + }, + "LogDestination": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LogDestination", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the destination for the flow log data.

", + "smithy.api#xmlName": "logDestination" + } + }, + "LogFormat": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LogFormat", + "smithy.api#documentation": "

The format of the flow log record.

", + "smithy.api#xmlName": "logFormat" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags for the flow log.

", + "smithy.api#xmlName": "tagSet" + } + }, + "MaxAggregationInterval": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "MaxAggregationInterval", + "smithy.api#documentation": "

The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record.

\n

When a network interface is attached to a Nitro-based\n instance, the aggregation interval is always 60 seconds (1 minute) or less,\n regardless of the specified value.

\n

Valid Values: 60 | 600\n

", + "smithy.api#xmlName": "maxAggregationInterval" + } + }, + "DestinationOptions": { + "target": "com.amazonaws.ec2#DestinationOptionsResponse", + "traits": { + "aws.protocols#ec2QueryName": "DestinationOptions", + "smithy.api#documentation": "

The destination options.

", + "smithy.api#xmlName": "destinationOptions" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a flow log.

" + } + }, + "com.amazonaws.ec2#FlowLogIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VpcFlowLogId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#FlowLogResourceId": { + "type": "string" + }, + "com.amazonaws.ec2#FlowLogResourceIds": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#FlowLogResourceId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#FlowLogSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#FlowLog", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#FlowLogsResourceType": { + "type": "enum", + "members": { + "VPC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VPC" + } + }, + "Subnet": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Subnet" + } + }, + "NetworkInterface": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NetworkInterface" + } + }, + "TransitGateway": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TransitGateway" + } + }, + "TransitGatewayAttachment": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TransitGatewayAttachment" + } + } + } + }, + "com.amazonaws.ec2#FpgaDeviceCount": { + "type": "integer" + }, + "com.amazonaws.ec2#FpgaDeviceInfo": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.ec2#FpgaDeviceName", + "traits": { + "aws.protocols#ec2QueryName": "Name", + "smithy.api#documentation": "

The name of the FPGA accelerator.

", + "smithy.api#xmlName": "name" + } + }, + "Manufacturer": { + "target": "com.amazonaws.ec2#FpgaDeviceManufacturerName", + "traits": { + "aws.protocols#ec2QueryName": "Manufacturer", + "smithy.api#documentation": "

The manufacturer of the FPGA accelerator.

", + "smithy.api#xmlName": "manufacturer" + } + }, + "Count": { + "target": "com.amazonaws.ec2#FpgaDeviceCount", + "traits": { + "aws.protocols#ec2QueryName": "Count", + "smithy.api#documentation": "

The count of FPGA accelerators for the instance type.

", + "smithy.api#xmlName": "count" + } + }, + "MemoryInfo": { + "target": "com.amazonaws.ec2#FpgaDeviceMemoryInfo", + "traits": { + "aws.protocols#ec2QueryName": "MemoryInfo", + "smithy.api#documentation": "

Describes the memory for the FPGA accelerator for the instance type.

", + "smithy.api#xmlName": "memoryInfo" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the FPGA accelerator for the instance type.

" + } + }, + "com.amazonaws.ec2#FpgaDeviceInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#FpgaDeviceInfo", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#FpgaDeviceManufacturerName": { + "type": "string" + }, + "com.amazonaws.ec2#FpgaDeviceMemoryInfo": { + "type": "structure", + "members": { + "SizeInMiB": { + "target": "com.amazonaws.ec2#FpgaDeviceMemorySize", + "traits": { + "aws.protocols#ec2QueryName": "SizeInMiB", + "smithy.api#documentation": "

The size of the memory available to the FPGA accelerator, in MiB.

", + "smithy.api#xmlName": "sizeInMiB" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the memory for the FPGA accelerator for the instance type.

" + } + }, + "com.amazonaws.ec2#FpgaDeviceMemorySize": { + "type": "integer" + }, + "com.amazonaws.ec2#FpgaDeviceName": { + "type": "string" + }, + "com.amazonaws.ec2#FpgaImage": { + "type": "structure", + "members": { + "FpgaImageId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "FpgaImageId", + "smithy.api#documentation": "

The FPGA image identifier (AFI ID).

", + "smithy.api#xmlName": "fpgaImageId" + } + }, + "FpgaImageGlobalId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "FpgaImageGlobalId", + "smithy.api#documentation": "

The global FPGA image identifier (AGFI ID).

", + "smithy.api#xmlName": "fpgaImageGlobalId" + } + }, + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Name", + "smithy.api#documentation": "

The name of the AFI.

", + "smithy.api#xmlName": "name" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description of the AFI.

", + "smithy.api#xmlName": "description" + } + }, + "ShellVersion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ShellVersion", + "smithy.api#documentation": "

The version of the Amazon Web Services Shell that was used to create the bitstream.

", + "smithy.api#xmlName": "shellVersion" + } + }, + "PciId": { + "target": "com.amazonaws.ec2#PciId", + "traits": { + "aws.protocols#ec2QueryName": "PciId", + "smithy.api#documentation": "

Information about the PCI bus.

", + "smithy.api#xmlName": "pciId" + } + }, + "State": { + "target": "com.amazonaws.ec2#FpgaImageState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

Information about the state of the AFI.

", + "smithy.api#xmlName": "state" + } + }, + "CreateTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreateTime", + "smithy.api#documentation": "

The date and time the AFI was created.

", + "smithy.api#xmlName": "createTime" + } + }, + "UpdateTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "UpdateTime", + "smithy.api#documentation": "

The time of the most recent update to the AFI.

", + "smithy.api#xmlName": "updateTime" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the AFI.

", + "smithy.api#xmlName": "ownerId" + } + }, + "OwnerAlias": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerAlias", + "smithy.api#documentation": "

The alias of the AFI owner. Possible values include self, amazon, and aws-marketplace.

", + "smithy.api#xmlName": "ownerAlias" + } + }, + "ProductCodes": { + "target": "com.amazonaws.ec2#ProductCodeList", + "traits": { + "aws.protocols#ec2QueryName": "ProductCodes", + "smithy.api#documentation": "

The product codes for the AFI.

", + "smithy.api#xmlName": "productCodes" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "Tags", + "smithy.api#documentation": "

Any tags assigned to the AFI.

", + "smithy.api#xmlName": "tags" + } + }, + "Public": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Public", + "smithy.api#documentation": "

Indicates whether the AFI is public.

", + "smithy.api#xmlName": "public" + } + }, + "DataRetentionSupport": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DataRetentionSupport", + "smithy.api#documentation": "

Indicates whether data retention support is enabled for the AFI.

", + "smithy.api#xmlName": "dataRetentionSupport" + } + }, + "InstanceTypes": { + "target": "com.amazonaws.ec2#InstanceTypesList", + "traits": { + "aws.protocols#ec2QueryName": "InstanceTypes", + "smithy.api#documentation": "

The instance types supported by the AFI.

", + "smithy.api#xmlName": "instanceTypes" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an Amazon FPGA image (AFI).

" + } + }, + "com.amazonaws.ec2#FpgaImageAttribute": { + "type": "structure", + "members": { + "FpgaImageId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "FpgaImageId", + "smithy.api#documentation": "

The ID of the AFI.

", + "smithy.api#xmlName": "fpgaImageId" + } + }, + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Name", + "smithy.api#documentation": "

The name of the AFI.

", + "smithy.api#xmlName": "name" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description of the AFI.

", + "smithy.api#xmlName": "description" + } + }, + "LoadPermissions": { + "target": "com.amazonaws.ec2#LoadPermissionList", + "traits": { + "aws.protocols#ec2QueryName": "LoadPermissions", + "smithy.api#documentation": "

The load permissions.

", + "smithy.api#xmlName": "loadPermissions" + } + }, + "ProductCodes": { + "target": "com.amazonaws.ec2#ProductCodeList", + "traits": { + "aws.protocols#ec2QueryName": "ProductCodes", + "smithy.api#documentation": "

The product codes.

", + "smithy.api#xmlName": "productCodes" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an Amazon FPGA image (AFI) attribute.

" + } + }, + "com.amazonaws.ec2#FpgaImageAttributeName": { + "type": "enum", + "members": { + "description": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "description" + } + }, + "name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "name" + } + }, + "loadPermission": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "loadPermission" + } + }, + "productCodes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "productCodes" + } + } + } + }, + "com.amazonaws.ec2#FpgaImageId": { + "type": "string" + }, + "com.amazonaws.ec2#FpgaImageIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#FpgaImageId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#FpgaImageList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#FpgaImage", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#FpgaImageState": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#FpgaImageStateCode", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The state. The following are the possible values:

\n ", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

If the state is failed, this is the error message.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the state of the bitstream generation process for an Amazon FPGA image (AFI).

" + } + }, + "com.amazonaws.ec2#FpgaImageStateCode": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "unavailable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unavailable" + } + } + } + }, + "com.amazonaws.ec2#FpgaInfo": { + "type": "structure", + "members": { + "Fpgas": { + "target": "com.amazonaws.ec2#FpgaDeviceInfoList", + "traits": { + "aws.protocols#ec2QueryName": "Fpgas", + "smithy.api#documentation": "

Describes the FPGAs for the instance type.

", + "smithy.api#xmlName": "fpgas" + } + }, + "TotalFpgaMemoryInMiB": { + "target": "com.amazonaws.ec2#totalFpgaMemory", + "traits": { + "aws.protocols#ec2QueryName": "TotalFpgaMemoryInMiB", + "smithy.api#documentation": "

The total memory of all FPGA accelerators for the instance type.

", + "smithy.api#xmlName": "totalFpgaMemoryInMiB" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the FPGAs for the instance type.

" + } + }, + "com.amazonaws.ec2#FreeTierEligibleFlag": { + "type": "boolean" + }, + "com.amazonaws.ec2#GVCDMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 200, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#GatewayAssociationState": { + "type": "enum", + "members": { + "associated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associated" + } + }, + "not_associated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "not-associated" + } + }, + "associating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associating" + } + }, + "disassociating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociating" + } + } + } + }, + "com.amazonaws.ec2#GatewayType": { + "type": "enum", + "members": { + "ipsec_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipsec.1" + } + } + } + }, + "com.amazonaws.ec2#GetAllowedImagesSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetAllowedImagesSettingsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetAllowedImagesSettingsResult" + }, + "traits": { + "smithy.api#documentation": "

Gets the current state of the Allowed AMIs setting and the list of Allowed AMIs criteria\n at the account level in the specified Region.

\n \n

The Allowed AMIs feature does not restrict the AMIs owned by your account. Regardless of\n the criteria you set, the AMIs created by your account will always be discoverable and\n usable by users in your account.

\n \n

For more information, see Control the discovery and use of AMIs in\n Amazon EC2 with Allowed AMIs in\n Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#GetAllowedImagesSettingsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetAllowedImagesSettingsResult": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of the Allowed AMIs setting at the account level in the specified Amazon Web Services\n Region.

\n

Possible values:

\n ", + "smithy.api#xmlName": "state" + } + }, + "ImageCriteria": { + "target": "com.amazonaws.ec2#ImageCriterionList", + "traits": { + "aws.protocols#ec2QueryName": "ImageCriterionSet", + "smithy.api#documentation": "

The list of criteria for images that are discoverable and usable in the account in the\n specified Amazon Web Services Region.

", + "smithy.api#xmlName": "imageCriterionSet" + } + }, + "ManagedBy": { + "target": "com.amazonaws.ec2#ManagedBy", + "traits": { + "aws.protocols#ec2QueryName": "ManagedBy", + "smithy.api#documentation": "

The entity that manages the Allowed AMIs settings. Possible values include:

\n ", + "smithy.api#xmlName": "managedBy" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetAssociatedEnclaveCertificateIamRoles": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetAssociatedEnclaveCertificateIamRolesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetAssociatedEnclaveCertificateIamRolesResult" + }, + "traits": { + "smithy.api#documentation": "

Returns the IAM roles that are associated with the specified ACM (ACM) certificate. \n\t\t\tIt also returns the name of the Amazon S3 bucket and the Amazon S3 object key where the certificate, \n\t\t\tcertificate chain, and encrypted private key bundle are stored, and the ARN of the KMS key \n\t\t\tthat's used to encrypt the private key.

" + } + }, + "com.amazonaws.ec2#GetAssociatedEnclaveCertificateIamRolesRequest": { + "type": "structure", + "members": { + "CertificateArn": { + "target": "com.amazonaws.ec2#CertificateId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the ACM certificate for which to view the associated IAM roles, encryption keys, and Amazon \n\t\t\tS3 object information.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetAssociatedEnclaveCertificateIamRolesResult": { + "type": "structure", + "members": { + "AssociatedRoles": { + "target": "com.amazonaws.ec2#AssociatedRolesList", + "traits": { + "aws.protocols#ec2QueryName": "AssociatedRoleSet", + "smithy.api#documentation": "

Information about the associated IAM roles.

", + "smithy.api#xmlName": "associatedRoleSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetAssociatedIpv6PoolCidrs": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetAssociatedIpv6PoolCidrsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetAssociatedIpv6PoolCidrsResult" + }, + "traits": { + "smithy.api#documentation": "

Gets information about the IPv6 CIDR block associations for a specified IPv6 address pool.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Ipv6CidrAssociations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetAssociatedIpv6PoolCidrsRequest": { + "type": "structure", + "members": { + "PoolId": { + "target": "com.amazonaws.ec2#Ipv6PoolEc2Id", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the IPv6 address pool.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Ipv6PoolMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetAssociatedIpv6PoolCidrsResult": { + "type": "structure", + "members": { + "Ipv6CidrAssociations": { + "target": "com.amazonaws.ec2#Ipv6CidrAssociationSet", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6CidrAssociationSet", + "smithy.api#documentation": "

Information about the IPv6 CIDR block associations.

", + "smithy.api#xmlName": "ipv6CidrAssociationSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetAwsNetworkPerformanceData": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetAwsNetworkPerformanceDataRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetAwsNetworkPerformanceDataResult" + }, + "traits": { + "smithy.api#documentation": "

Gets network performance data.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "DataResponses", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetAwsNetworkPerformanceDataRequest": { + "type": "structure", + "members": { + "DataQueries": { + "target": "com.amazonaws.ec2#DataQueries", + "traits": { + "smithy.api#documentation": "

A list of network performance data queries.

", + "smithy.api#xmlName": "DataQuery" + } + }, + "StartTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "smithy.api#documentation": "

The starting time for the performance data request. The starting time must be formatted\n as yyyy-mm-ddThh:mm:ss. For example, 2022-06-10T12:00:00.000Z.

" + } + }, + "EndTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "smithy.api#documentation": "

The ending time for the performance data request. The end time must be formatted as yyyy-mm-ddThh:mm:ss. For example, 2022-06-12T12:00:00.000Z.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetAwsNetworkPerformanceDataResult": { + "type": "structure", + "members": { + "DataResponses": { + "target": "com.amazonaws.ec2#DataResponses", + "traits": { + "aws.protocols#ec2QueryName": "DataResponseSet", + "smithy.api#documentation": "

The list of data responses.

", + "smithy.api#xmlName": "dataResponseSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetCapacityReservationUsage": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetCapacityReservationUsageRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetCapacityReservationUsageResult" + }, + "traits": { + "smithy.api#documentation": "

Gets usage information about a Capacity Reservation. If the Capacity Reservation is\n\t\t\tshared, it shows usage information for the Capacity Reservation owner and each Amazon Web Services account that is currently using the shared capacity. If the Capacity\n\t\t\tReservation is not shared, it shows only the Capacity Reservation owner's usage.

" + } + }, + "com.amazonaws.ec2#GetCapacityReservationUsageRequest": { + "type": "structure", + "members": { + "CapacityReservationId": { + "target": "com.amazonaws.ec2#CapacityReservationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Capacity Reservation.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#GetCapacityReservationUsageRequestMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, \n see Pagination.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetCapacityReservationUsageRequestMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#GetCapacityReservationUsageResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "CapacityReservationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationId", + "smithy.api#documentation": "

The ID of the Capacity Reservation.

", + "smithy.api#xmlName": "capacityReservationId" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The type of instance for which the Capacity Reservation reserves capacity.

", + "smithy.api#xmlName": "instanceType" + } + }, + "TotalInstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TotalInstanceCount", + "smithy.api#documentation": "

The number of instances for which the Capacity Reservation reserves capacity.

", + "smithy.api#xmlName": "totalInstanceCount" + } + }, + "AvailableInstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "AvailableInstanceCount", + "smithy.api#documentation": "

The remaining capacity. Indicates the number of instances that can be launched in the\n\t\t\tCapacity Reservation.

", + "smithy.api#xmlName": "availableInstanceCount" + } + }, + "State": { + "target": "com.amazonaws.ec2#CapacityReservationState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of the Capacity Reservation. A Capacity Reservation can be in one of\n\t\t\tthe following states:

\n ", + "smithy.api#xmlName": "state" + } + }, + "InstanceUsages": { + "target": "com.amazonaws.ec2#InstanceUsageSet", + "traits": { + "aws.protocols#ec2QueryName": "InstanceUsageSet", + "smithy.api#documentation": "

Information about the Capacity Reservation usage.

", + "smithy.api#xmlName": "instanceUsageSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetCoipPoolUsage": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetCoipPoolUsageRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetCoipPoolUsageResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the allocations from the specified customer-owned address pool.

" + } + }, + "com.amazonaws.ec2#GetCoipPoolUsageRequest": { + "type": "structure", + "members": { + "PoolId": { + "target": "com.amazonaws.ec2#Ipv4PoolCoipId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the address pool.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#CoipPoolMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetCoipPoolUsageResult": { + "type": "structure", + "members": { + "CoipPoolId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CoipPoolId", + "smithy.api#documentation": "

The ID of the customer-owned address pool.

", + "smithy.api#xmlName": "coipPoolId" + } + }, + "CoipAddressUsages": { + "target": "com.amazonaws.ec2#CoipAddressUsageSet", + "traits": { + "aws.protocols#ec2QueryName": "CoipAddressUsageSet", + "smithy.api#documentation": "

Information about the address usage.

", + "smithy.api#xmlName": "coipAddressUsageSet" + } + }, + "LocalGatewayRouteTableId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayRouteTableId", + "smithy.api#documentation": "

The ID of the local gateway route table.

", + "smithy.api#xmlName": "localGatewayRouteTableId" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetConsoleOutput": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetConsoleOutputRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetConsoleOutputResult" + }, + "traits": { + "smithy.api#documentation": "

Gets the console output for the specified instance. For Linux instances, the instance\n console output displays the exact console output that would normally be displayed on a\n physical monitor attached to a computer. For Windows instances, the instance console\n output includes the last three system event log errors.

\n

For more information, see Instance\n console output in the Amazon EC2 User Guide.

", + "smithy.api#examples": [ + { + "title": "To get the console output", + "documentation": "This example gets the console output for the specified instance.", + "input": { + "InstanceId": "i-1234567890abcdef0" + }, + "output": { + "InstanceId": "i-1234567890abcdef0", + "Output": "...", + "Timestamp": "2018-05-25T21:23:53.000Z" + } + } + ] + } + }, + "com.amazonaws.ec2#GetConsoleOutputRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#required": {} + } + }, + "Latest": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

When enabled, retrieves the latest console output for the instance.

\n

Default: disabled (false)

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetConsoleOutputResult": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#xmlName": "instanceId" + } + }, + "Timestamp": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "Timestamp", + "smithy.api#documentation": "

The time at which the output was last updated.

", + "smithy.api#xmlName": "timestamp" + } + }, + "Output": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Output", + "smithy.api#documentation": "

The console output, base64-encoded. If you are using a command line tool, the tool\n decodes the output for you.

", + "smithy.api#xmlName": "output" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetConsoleScreenshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetConsoleScreenshotRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetConsoleScreenshotResult" + }, + "traits": { + "smithy.api#documentation": "

Retrieve a JPG-format screenshot of a running instance to help with\n troubleshooting.

\n

The returned content is Base64-encoded.

\n

For more information, see Instance console output in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#GetConsoleScreenshotRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#required": {} + } + }, + "WakeUp": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

When set to true, acts as keystroke input and wakes up an instance that's\n in standby or \"sleep\" mode.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetConsoleScreenshotResult": { + "type": "structure", + "members": { + "ImageData": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImageData", + "smithy.api#documentation": "

The data that comprises the image.

", + "smithy.api#xmlName": "imageData" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#xmlName": "instanceId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetDeclarativePoliciesReportSummary": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetDeclarativePoliciesReportSummaryRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetDeclarativePoliciesReportSummaryResult" + }, + "traits": { + "smithy.api#documentation": "

Retrieves a summary of the account status report.

\n

To view the full report, download it from the Amazon S3 bucket where it was saved.\n Reports are accessible only when they have the complete status. Reports\n with other statuses (running, cancelled, or\n error) are not available in the S3 bucket. For more information about\n downloading objects from an S3 bucket, see Downloading objects in\n the Amazon Simple Storage Service User Guide.

\n

For more information, see Generating the account status report for declarative policies in the\n Amazon Web Services Organizations User Guide.

" + } + }, + "com.amazonaws.ec2#GetDeclarativePoliciesReportSummaryRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ReportId": { + "target": "com.amazonaws.ec2#DeclarativePoliciesReportId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the report.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetDeclarativePoliciesReportSummaryResult": { + "type": "structure", + "members": { + "ReportId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ReportId", + "smithy.api#documentation": "

The ID of the report.

", + "smithy.api#xmlName": "reportId" + } + }, + "S3Bucket": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "S3Bucket", + "smithy.api#documentation": "

The name of the Amazon S3 bucket where the report is located.

", + "smithy.api#xmlName": "s3Bucket" + } + }, + "S3Prefix": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "S3Prefix", + "smithy.api#documentation": "

The prefix for your S3 object.

", + "smithy.api#xmlName": "s3Prefix" + } + }, + "TargetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TargetId", + "smithy.api#documentation": "

The root ID, organizational unit ID, or account ID.

\n

Format:

\n ", + "smithy.api#xmlName": "targetId" + } + }, + "StartTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "StartTime", + "smithy.api#documentation": "

The time when the report generation started.

", + "smithy.api#xmlName": "startTime" + } + }, + "EndTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "EndTime", + "smithy.api#documentation": "

The time when the report generation ended.

", + "smithy.api#xmlName": "endTime" + } + }, + "NumberOfAccounts": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "NumberOfAccounts", + "smithy.api#documentation": "

The total number of accounts associated with the specified\n targetId.

", + "smithy.api#xmlName": "numberOfAccounts" + } + }, + "NumberOfFailedAccounts": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "NumberOfFailedAccounts", + "smithy.api#documentation": "

The number of accounts where attributes could not be retrieved in any Region.

", + "smithy.api#xmlName": "numberOfFailedAccounts" + } + }, + "AttributeSummaries": { + "target": "com.amazonaws.ec2#AttributeSummaryList", + "traits": { + "aws.protocols#ec2QueryName": "AttributeSummarySet", + "smithy.api#documentation": "

The attributes described in the report.

", + "smithy.api#xmlName": "attributeSummarySet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetDefaultCreditSpecification": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetDefaultCreditSpecificationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetDefaultCreditSpecificationResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the default credit option for CPU usage of a burstable performance instance\n family.

\n

For more information, see Burstable\n performance instances in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#GetDefaultCreditSpecificationRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "InstanceFamily": { + "target": "com.amazonaws.ec2#UnlimitedSupportedInstanceFamily", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The instance family.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetDefaultCreditSpecificationResult": { + "type": "structure", + "members": { + "InstanceFamilyCreditSpecification": { + "target": "com.amazonaws.ec2#InstanceFamilyCreditSpecification", + "traits": { + "aws.protocols#ec2QueryName": "InstanceFamilyCreditSpecification", + "smithy.api#documentation": "

The default credit option for CPU usage of the instance family.

", + "smithy.api#xmlName": "instanceFamilyCreditSpecification" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetEbsDefaultKmsKeyId": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetEbsDefaultKmsKeyIdRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetEbsDefaultKmsKeyIdResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the default KMS key for EBS encryption by default for your account in this Region. \n \t\tYou can change the default KMS key for encryption by default using ModifyEbsDefaultKmsKeyId or\n ResetEbsDefaultKmsKeyId.

\n

For more information, see Amazon EBS encryption\n in the Amazon EBS User Guide.

" + } + }, + "com.amazonaws.ec2#GetEbsDefaultKmsKeyIdRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetEbsDefaultKmsKeyIdResult": { + "type": "structure", + "members": { + "KmsKeyId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KmsKeyId", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the default KMS key for encryption by default.

", + "smithy.api#xmlName": "kmsKeyId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetEbsEncryptionByDefault": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetEbsEncryptionByDefaultRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetEbsEncryptionByDefaultResult" + }, + "traits": { + "smithy.api#documentation": "

Describes whether EBS encryption by default is enabled for your account in the current\n Region.

\n

For more information, see Amazon EBS encryption\n in the Amazon EBS User Guide.

" + } + }, + "com.amazonaws.ec2#GetEbsEncryptionByDefaultRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetEbsEncryptionByDefaultResult": { + "type": "structure", + "members": { + "EbsEncryptionByDefault": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EbsEncryptionByDefault", + "smithy.api#documentation": "

Indicates whether encryption by default is enabled.

", + "smithy.api#xmlName": "ebsEncryptionByDefault" + } + }, + "SseType": { + "target": "com.amazonaws.ec2#SSEType", + "traits": { + "aws.protocols#ec2QueryName": "SseType", + "smithy.api#documentation": "

Reserved for future use.

", + "smithy.api#xmlName": "sseType" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetFlowLogsIntegrationTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetFlowLogsIntegrationTemplateRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetFlowLogsIntegrationTemplateResult" + }, + "traits": { + "smithy.api#documentation": "

Generates a CloudFormation template that streamlines and automates the integration of VPC flow logs \n with Amazon Athena. This make it easier for you to query and gain insights from VPC flow logs data. \n Based on the information that you provide, we configure resources in the template to do the following:

\n \n \n

\n GetFlowLogsIntegrationTemplate does not support integration between\n Amazon Web Services Transit Gateway Flow Logs and Amazon Athena.

\n " + } + }, + "com.amazonaws.ec2#GetFlowLogsIntegrationTemplateRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "FlowLogId": { + "target": "com.amazonaws.ec2#VpcFlowLogId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the flow log.

", + "smithy.api#required": {} + } + }, + "ConfigDeliveryS3DestinationArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

To store the CloudFormation template in Amazon S3, specify the location in Amazon S3.

", + "smithy.api#required": {} + } + }, + "IntegrateServices": { + "target": "com.amazonaws.ec2#IntegrateServices", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Information about the service integration.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "IntegrateService" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetFlowLogsIntegrationTemplateResult": { + "type": "structure", + "members": { + "Result": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Result", + "smithy.api#documentation": "

The generated CloudFormation template.

", + "smithy.api#xmlName": "result" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetGroupsForCapacityReservation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetGroupsForCapacityReservationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetGroupsForCapacityReservationResult" + }, + "traits": { + "smithy.api#documentation": "

Lists the resource groups to which a Capacity Reservation has been added.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "CapacityReservationGroups", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetGroupsForCapacityReservationRequest": { + "type": "structure", + "members": { + "CapacityReservationId": { + "target": "com.amazonaws.ec2#CapacityReservationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Capacity Reservation. If you specify a Capacity Reservation that is\n\t\t\tshared with you, the operation returns only Capacity Reservation groups that you\n\t\t\town.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#GetGroupsForCapacityReservationRequestMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, \n see Pagination.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetGroupsForCapacityReservationRequestMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#GetGroupsForCapacityReservationResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "CapacityReservationGroups": { + "target": "com.amazonaws.ec2#CapacityReservationGroupSet", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationGroupSet", + "smithy.api#documentation": "

Information about the resource groups to which the Capacity Reservation has been\n\t\t\tadded.

", + "smithy.api#xmlName": "capacityReservationGroupSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetHostReservationPurchasePreview": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetHostReservationPurchasePreviewRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetHostReservationPurchasePreviewResult" + }, + "traits": { + "smithy.api#documentation": "

Preview a reservation purchase with configurations that match those of your Dedicated\n Host. You must have active Dedicated Hosts in your account before you purchase a\n reservation.

\n

This is a preview of the PurchaseHostReservation action and does not\n result in the offering being purchased.

" + } + }, + "com.amazonaws.ec2#GetHostReservationPurchasePreviewRequest": { + "type": "structure", + "members": { + "HostIdSet": { + "target": "com.amazonaws.ec2#RequestHostIdSet", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the Dedicated Hosts with which the reservation is associated.

", + "smithy.api#required": {} + } + }, + "OfferingId": { + "target": "com.amazonaws.ec2#OfferingId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The offering ID of the reservation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetHostReservationPurchasePreviewResult": { + "type": "structure", + "members": { + "CurrencyCode": { + "target": "com.amazonaws.ec2#CurrencyCodeValues", + "traits": { + "aws.protocols#ec2QueryName": "CurrencyCode", + "smithy.api#documentation": "

The currency in which the totalUpfrontPrice and\n totalHourlyPrice amounts are specified. At this time, the only\n supported currency is USD.

", + "smithy.api#xmlName": "currencyCode" + } + }, + "Purchase": { + "target": "com.amazonaws.ec2#PurchaseSet", + "traits": { + "aws.protocols#ec2QueryName": "Purchase", + "smithy.api#documentation": "

The purchase information of the Dedicated Host reservation and the Dedicated Hosts\n associated with it.

", + "smithy.api#xmlName": "purchase" + } + }, + "TotalHourlyPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TotalHourlyPrice", + "smithy.api#documentation": "

The potential total hourly price of the reservation per hour.

", + "smithy.api#xmlName": "totalHourlyPrice" + } + }, + "TotalUpfrontPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TotalUpfrontPrice", + "smithy.api#documentation": "

The potential total upfront price. This is billed immediately.

", + "smithy.api#xmlName": "totalUpfrontPrice" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetImageBlockPublicAccessState": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetImageBlockPublicAccessStateRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetImageBlockPublicAccessStateResult" + }, + "traits": { + "smithy.api#documentation": "

Gets the current state of block public access for AMIs at the account\n level in the specified Amazon Web Services Region.

\n

For more information, see Block\n public access to your AMIs in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#GetImageBlockPublicAccessStateRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetImageBlockPublicAccessStateResult": { + "type": "structure", + "members": { + "ImageBlockPublicAccessState": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImageBlockPublicAccessState", + "smithy.api#documentation": "

The current state of block public access for AMIs at the account level in the specified\n Amazon Web Services Region.

\n

Possible values:

\n ", + "smithy.api#xmlName": "imageBlockPublicAccessState" + } + }, + "ManagedBy": { + "target": "com.amazonaws.ec2#ManagedBy", + "traits": { + "aws.protocols#ec2QueryName": "ManagedBy", + "smithy.api#documentation": "

The entity that manages the state for block public access for AMIs. Possible values\n include:

\n ", + "smithy.api#xmlName": "managedBy" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetInstanceMetadataDefaults": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetInstanceMetadataDefaultsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetInstanceMetadataDefaultsResult" + }, + "traits": { + "smithy.api#documentation": "

Gets the default instance metadata service (IMDS) settings that are set at the account\n level in the specified Amazon Web Services\u2028 Region.

\n

For more information, see Order of precedence for instance metadata options in the\n Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#GetInstanceMetadataDefaultsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetInstanceMetadataDefaultsResult": { + "type": "structure", + "members": { + "AccountLevel": { + "target": "com.amazonaws.ec2#InstanceMetadataDefaultsResponse", + "traits": { + "aws.protocols#ec2QueryName": "AccountLevel", + "smithy.api#documentation": "

The account-level default IMDS settings.

", + "smithy.api#xmlName": "accountLevel" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetInstanceTpmEkPub": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetInstanceTpmEkPubRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetInstanceTpmEkPubResult" + }, + "traits": { + "smithy.api#documentation": "

Gets the public endorsement key associated with the Nitro Trusted \n Platform Module (NitroTPM) for the specified instance.

" + } + }, + "com.amazonaws.ec2#GetInstanceTpmEkPubRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance for which to get the public endorsement key.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "InstanceId" + } + }, + "KeyType": { + "target": "com.amazonaws.ec2#EkPubKeyType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The required public endorsement key type.

", + "smithy.api#required": {} + } + }, + "KeyFormat": { + "target": "com.amazonaws.ec2#EkPubKeyFormat", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The required public endorsement key format. Specify der for a DER-encoded public \n key that is compatible with OpenSSL. Specify tpmt for a TPM 2.0 format that is \n compatible with tpm2-tools. The returned key is base64 encoded.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Specify this parameter to verify whether the request will succeed, without actually making the \n request. If the request will succeed, the response is DryRunOperation. Otherwise, \n the response is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetInstanceTpmEkPubResult": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#xmlName": "instanceId" + } + }, + "KeyType": { + "target": "com.amazonaws.ec2#EkPubKeyType", + "traits": { + "aws.protocols#ec2QueryName": "KeyType", + "smithy.api#documentation": "

The public endorsement key type.

", + "smithy.api#xmlName": "keyType" + } + }, + "KeyFormat": { + "target": "com.amazonaws.ec2#EkPubKeyFormat", + "traits": { + "aws.protocols#ec2QueryName": "KeyFormat", + "smithy.api#documentation": "

The public endorsement key format.

", + "smithy.api#xmlName": "keyFormat" + } + }, + "KeyValue": { + "target": "com.amazonaws.ec2#EkPubKeyValue", + "traits": { + "aws.protocols#ec2QueryName": "KeyValue", + "smithy.api#documentation": "

The public endorsement key material.

", + "smithy.api#xmlName": "keyValue" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetInstanceTypesFromInstanceRequirements": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetInstanceTypesFromInstanceRequirementsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetInstanceTypesFromInstanceRequirementsResult" + }, + "traits": { + "smithy.api#documentation": "

Returns a list of instance types with the specified instance attributes. You can\n use the response to preview the instance types without launching instances. Note\n that the response does not consider capacity.

\n

When you specify multiple parameters, you get instance types that satisfy all of the\n specified parameters. If you specify multiple values for a parameter, you get instance\n types that satisfy any of the specified values.

\n

For more information, see Preview instance types with specified attributes, Specify attributes for instance type selection for EC2 Fleet or Spot Fleet, and Spot\n placement score in the Amazon EC2 User Guide, and Creating\n mixed instance groups using attribute-based instance type selection in the\n Amazon EC2 Auto Scaling User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "InstanceTypes", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetInstanceTypesFromInstanceRequirementsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ArchitectureTypes": { + "target": "com.amazonaws.ec2#ArchitectureTypeSet", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The processor architecture type.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "ArchitectureType" + } + }, + "VirtualizationTypes": { + "target": "com.amazonaws.ec2#VirtualizationTypeSet", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The virtualization type.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "VirtualizationType" + } + }, + "InstanceRequirements": { + "target": "com.amazonaws.ec2#InstanceRequirementsRequest", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The attributes required for the instance types.

", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetInstanceTypesFromInstanceRequirementsResult": { + "type": "structure", + "members": { + "InstanceTypes": { + "target": "com.amazonaws.ec2#InstanceTypeInfoFromInstanceRequirementsSet", + "traits": { + "aws.protocols#ec2QueryName": "InstanceTypeSet", + "smithy.api#documentation": "

The instance types with the specified instance attributes.

", + "smithy.api#xmlName": "instanceTypeSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetInstanceUefiData": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetInstanceUefiDataRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetInstanceUefiDataResult" + }, + "traits": { + "smithy.api#documentation": "

A binary representation of the UEFI variable store. Only non-volatile variables are\n stored. This is a base64 encoded and zlib compressed binary value that must be properly\n encoded.

\n

When you use register-image to create\n an AMI, you can create an exact copy of your variable store by passing the UEFI data in\n the UefiData parameter. You can modify the UEFI data by using the python-uefivars tool on\n GitHub. You can use the tool to convert the UEFI data into a human-readable format\n (JSON), which you can inspect and modify, and then convert back into the binary format\n to use with register-image.

\n

For more information, see UEFI Secure Boot in the\n Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#GetInstanceUefiDataRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance from which to retrieve the UEFI data.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "InstanceId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetInstanceUefiDataResult": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance from which to retrieve the UEFI data.

", + "smithy.api#xmlName": "instanceId" + } + }, + "UefiData": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "UefiData", + "smithy.api#documentation": "

Base64 representation of the non-volatile UEFI variable store.

", + "smithy.api#xmlName": "uefiData" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetIpamAddressHistory": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetIpamAddressHistoryRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetIpamAddressHistoryResult" + }, + "traits": { + "smithy.api#documentation": "

Retrieve historical information about a CIDR within an IPAM scope. For more information, see View the history of IP addresses in the Amazon VPC IPAM User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "HistoryRecords", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetIpamAddressHistoryRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The CIDR you want the history of. The CIDR can be an IPv4 or IPv6 IP address range. \n If you enter a /16 IPv4 CIDR, you will get records that match it exactly. You will not get records for any subnets within the /16 CIDR.

", + "smithy.api#required": {} + } + }, + "IpamScopeId": { + "target": "com.amazonaws.ec2#IpamScopeId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the IPAM scope that the CIDR is in.

", + "smithy.api#required": {} + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ID of the VPC you want your history records filtered by.

" + } + }, + "StartTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "smithy.api#documentation": "

The start of the time period for which you are looking for history. If you omit this option, it will default to the value of EndTime.

" + } + }, + "EndTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "smithy.api#documentation": "

The end of the time period for which you are looking for history. If you omit this option, it will default to the current time.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#IpamAddressHistoryMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of historical results you would like returned per page. Defaults to 100.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetIpamAddressHistoryResult": { + "type": "structure", + "members": { + "HistoryRecords": { + "target": "com.amazonaws.ec2#IpamAddressHistoryRecordSet", + "traits": { + "aws.protocols#ec2QueryName": "HistoryRecordSet", + "smithy.api#documentation": "

A historical record for a CIDR within an IPAM scope. If the CIDR is associated with an EC2 instance, you will see an object in the response for the instance and one for the network interface.

", + "smithy.api#xmlName": "historyRecordSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetIpamDiscoveredAccounts": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetIpamDiscoveredAccountsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetIpamDiscoveredAccountsResult" + }, + "traits": { + "smithy.api#documentation": "

Gets IPAM discovered accounts. A discovered account is an Amazon Web Services account that is monitored under a resource discovery. If you have integrated IPAM with Amazon Web Services Organizations, all accounts in the organization are discovered accounts. Only the IPAM account can get all discovered accounts in the organization.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "IpamDiscoveredAccounts", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetIpamDiscoveredAccountsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamResourceDiscoveryId": { + "target": "com.amazonaws.ec2#IpamResourceDiscoveryId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A resource discovery ID.

", + "smithy.api#required": {} + } + }, + "DiscoveryRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Web Services Region that the account information is returned from.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

Discovered account filters.

", + "smithy.api#xmlName": "Filter" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

Specify the pagination token from a previous request to retrieve the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#IpamMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of discovered accounts to return in one page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetIpamDiscoveredAccountsResult": { + "type": "structure", + "members": { + "IpamDiscoveredAccounts": { + "target": "com.amazonaws.ec2#IpamDiscoveredAccountSet", + "traits": { + "aws.protocols#ec2QueryName": "IpamDiscoveredAccountSet", + "smithy.api#documentation": "

Discovered accounts.

", + "smithy.api#xmlName": "ipamDiscoveredAccountSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

Specify the pagination token from a previous request to retrieve the next page of results.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetIpamDiscoveredPublicAddresses": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetIpamDiscoveredPublicAddressesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetIpamDiscoveredPublicAddressesResult" + }, + "traits": { + "smithy.api#documentation": "

Gets the public IP addresses that have been discovered by IPAM.

" + } + }, + "com.amazonaws.ec2#GetIpamDiscoveredPublicAddressesRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamResourceDiscoveryId": { + "target": "com.amazonaws.ec2#IpamResourceDiscoveryId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An IPAM resource discovery ID.

", + "smithy.api#required": {} + } + }, + "AddressRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Web Services Region for the IP address.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

Filters.

", + "smithy.api#xmlName": "Filter" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#IpamMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of IPAM discovered public addresses to return in one page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetIpamDiscoveredPublicAddressesResult": { + "type": "structure", + "members": { + "IpamDiscoveredPublicAddresses": { + "target": "com.amazonaws.ec2#IpamDiscoveredPublicAddressSet", + "traits": { + "aws.protocols#ec2QueryName": "IpamDiscoveredPublicAddressSet", + "smithy.api#documentation": "

IPAM discovered public addresses.

", + "smithy.api#xmlName": "ipamDiscoveredPublicAddressSet" + } + }, + "OldestSampleTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "OldestSampleTime", + "smithy.api#documentation": "

The oldest successful resource discovery time.

", + "smithy.api#xmlName": "oldestSampleTime" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetIpamDiscoveredResourceCidrs": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetIpamDiscoveredResourceCidrsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetIpamDiscoveredResourceCidrsResult" + }, + "traits": { + "smithy.api#documentation": "

Returns the resource CIDRs that are monitored as part of a resource discovery. A discovered resource is a resource CIDR monitored under a resource discovery. The following resources can be discovered: VPCs, Public IPv4 pools, VPC subnets, and Elastic IP addresses.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "IpamDiscoveredResourceCidrs", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetIpamDiscoveredResourceCidrsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamResourceDiscoveryId": { + "target": "com.amazonaws.ec2#IpamResourceDiscoveryId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A resource discovery ID.

", + "smithy.api#required": {} + } + }, + "ResourceRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A resource Region.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

Filters.

", + "smithy.api#xmlName": "Filter" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

Specify the pagination token from a previous request to retrieve the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#IpamMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of discovered resource CIDRs to return in one page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetIpamDiscoveredResourceCidrsResult": { + "type": "structure", + "members": { + "IpamDiscoveredResourceCidrs": { + "target": "com.amazonaws.ec2#IpamDiscoveredResourceCidrSet", + "traits": { + "aws.protocols#ec2QueryName": "IpamDiscoveredResourceCidrSet", + "smithy.api#documentation": "

Discovered resource CIDRs.

", + "smithy.api#xmlName": "ipamDiscoveredResourceCidrSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

Specify the pagination token from a previous request to retrieve the next page of results.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetIpamPoolAllocations": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetIpamPoolAllocationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetIpamPoolAllocationsResult" + }, + "traits": { + "smithy.api#documentation": "

Get a list of all the CIDR allocations in an IPAM pool. The Region you use should be the IPAM pool locale. The locale is the Amazon Web Services Region where this IPAM pool is available for allocations.

\n \n

If you use this action after AllocateIpamPoolCidr or ReleaseIpamPoolAllocation, note that all EC2 API actions follow an eventual consistency model.

\n ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "IpamPoolAllocations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetIpamPoolAllocationsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1000, + "max": 100000 + } + } + }, + "com.amazonaws.ec2#GetIpamPoolAllocationsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the IPAM pool you want to see the allocations for.

", + "smithy.api#required": {} + } + }, + "IpamPoolAllocationId": { + "target": "com.amazonaws.ec2#IpamPoolAllocationId", + "traits": { + "smithy.api#documentation": "

The ID of the allocation.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters for the request. For more information about filtering, see Filtering CLI output.

", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#GetIpamPoolAllocationsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results you would like returned per page.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetIpamPoolAllocationsResult": { + "type": "structure", + "members": { + "IpamPoolAllocations": { + "target": "com.amazonaws.ec2#IpamPoolAllocationSet", + "traits": { + "aws.protocols#ec2QueryName": "IpamPoolAllocationSet", + "smithy.api#documentation": "

The IPAM pool allocations you want information on.

", + "smithy.api#xmlName": "ipamPoolAllocationSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetIpamPoolCidrs": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetIpamPoolCidrsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetIpamPoolCidrsResult" + }, + "traits": { + "smithy.api#documentation": "

Get the CIDRs provisioned to an IPAM pool.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "IpamPoolCidrs", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetIpamPoolCidrsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the IPAM pool you want the CIDR for.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters for the request. For more information about filtering, see Filtering CLI output.

", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#IpamMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in the request.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetIpamPoolCidrsResult": { + "type": "structure", + "members": { + "IpamPoolCidrs": { + "target": "com.amazonaws.ec2#IpamPoolCidrSet", + "traits": { + "aws.protocols#ec2QueryName": "IpamPoolCidrSet", + "smithy.api#documentation": "

Information about the CIDRs provisioned to an IPAM pool.

", + "smithy.api#xmlName": "ipamPoolCidrSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetIpamResourceCidrs": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetIpamResourceCidrsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetIpamResourceCidrsResult" + }, + "traits": { + "smithy.api#documentation": "

Returns resource CIDRs managed by IPAM in a given scope. If an IPAM is associated with more than one resource discovery, the resource CIDRs across all of the resource discoveries is returned. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "IpamResourceCidrs", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetIpamResourceCidrsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters for the request. For more information about filtering, see Filtering CLI output.

", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#IpamMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in the request.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "IpamScopeId": { + "target": "com.amazonaws.ec2#IpamScopeId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the scope that the resource is in.

", + "smithy.api#required": {} + } + }, + "IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "smithy.api#documentation": "

The ID of the IPAM pool that the resource is in.

" + } + }, + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ID of the resource.

" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#IpamResourceType", + "traits": { + "smithy.api#documentation": "

The resource type.

" + } + }, + "ResourceTag": { + "target": "com.amazonaws.ec2#RequestIpamResourceTag", + "traits": { + "smithy.api#documentation": "

The resource tag.

" + } + }, + "ResourceOwner": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the resource.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetIpamResourceCidrsResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "IpamResourceCidrs": { + "target": "com.amazonaws.ec2#IpamResourceCidrSet", + "traits": { + "aws.protocols#ec2QueryName": "IpamResourceCidrSet", + "smithy.api#documentation": "

The resource CIDRs.

", + "smithy.api#xmlName": "ipamResourceCidrSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetLaunchTemplateData": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetLaunchTemplateDataRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetLaunchTemplateDataResult" + }, + "traits": { + "smithy.api#documentation": "

Retrieves the configuration data of the specified instance. You can use this data to\n create a launch template.

\n

This action calls on other describe actions to get instance information. Depending on\n your instance configuration, you may need to allow the following actions in your IAM\n policy: DescribeSpotInstanceRequests, DescribeInstanceCreditSpecifications, \n DescribeVolumes, and DescribeInstanceAttribute. Or,\n you can allow describe* depending on your instance requirements.

", + "smithy.api#examples": [ + { + "title": "To get the launch template data for an instance ", + "documentation": "This example gets the launch template data for the specified instance.", + "input": { + "InstanceId": "0123d646e8048babc" + }, + "output": { + "LaunchTemplateData": { + "NetworkInterfaces": [ + { + "DeviceIndex": 0, + "Groups": [ + "sg-d14e1bb4" + ], + "Ipv6Addresses": [], + "AssociatePublicIpAddress": false, + "NetworkInterfaceId": "eni-4338b5a9", + "DeleteOnTermination": true, + "Description": "", + "PrivateIpAddress": "10.0.3.233", + "SubnetId": "subnet-5264e837", + "PrivateIpAddresses": [ + { + "PrivateIpAddress": "10.0.3.233", + "Primary": true + } + ] + } + ], + "Placement": { + "GroupName": "", + "Tenancy": "default", + "AvailabilityZone": "us-east-2b" + }, + "InstanceType": "t2.medium", + "EbsOptimized": false, + "BlockDeviceMappings": [ + { + "Ebs": { + "VolumeType": "gp2", + "Encrypted": false, + "Iops": 100, + "VolumeSize": 8, + "SnapshotId": "snap-02594938353ef77d3", + "DeleteOnTermination": true + }, + "DeviceName": "/dev/xvda" + } + ], + "KeyName": "my-key-pair", + "ImageId": "ami-32cf7b4a", + "Monitoring": { + "Enabled": false + } + } + } + } + ] + } + }, + "com.amazonaws.ec2#GetLaunchTemplateDataRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetLaunchTemplateDataResult": { + "type": "structure", + "members": { + "LaunchTemplateData": { + "target": "com.amazonaws.ec2#ResponseLaunchTemplateData", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateData", + "smithy.api#documentation": "

The instance data.

", + "smithy.api#xmlName": "launchTemplateData" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetManagedPrefixListAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetManagedPrefixListAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetManagedPrefixListAssociationsResult" + }, + "traits": { + "smithy.api#documentation": "

Gets information about the resources that are associated with the specified managed prefix list.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "PrefixListAssociations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetManagedPrefixListAssociationsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 255 + } + } + }, + "com.amazonaws.ec2#GetManagedPrefixListAssociationsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "PrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the prefix list.

", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#GetManagedPrefixListAssociationsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetManagedPrefixListAssociationsResult": { + "type": "structure", + "members": { + "PrefixListAssociations": { + "target": "com.amazonaws.ec2#PrefixListAssociationSet", + "traits": { + "aws.protocols#ec2QueryName": "PrefixListAssociationSet", + "smithy.api#documentation": "

Information about the associations.

", + "smithy.api#xmlName": "prefixListAssociationSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetManagedPrefixListEntries": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetManagedPrefixListEntriesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetManagedPrefixListEntriesResult" + }, + "traits": { + "smithy.api#documentation": "

Gets information about the entries for a specified managed prefix list.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Entries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetManagedPrefixListEntriesRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "PrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the prefix list.

", + "smithy.api#required": {} + } + }, + "TargetVersion": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "smithy.api#documentation": "

The version of the prefix list for which to return the entries. The default is the current version.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#PrefixListMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetManagedPrefixListEntriesResult": { + "type": "structure", + "members": { + "Entries": { + "target": "com.amazonaws.ec2#PrefixListEntrySet", + "traits": { + "aws.protocols#ec2QueryName": "EntrySet", + "smithy.api#documentation": "

Information about the prefix list entries.

", + "smithy.api#xmlName": "entrySet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetNetworkInsightsAccessScopeAnalysisFindings": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetNetworkInsightsAccessScopeAnalysisFindingsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetNetworkInsightsAccessScopeAnalysisFindingsResult" + }, + "traits": { + "smithy.api#documentation": "

Gets the findings for the specified Network Access Scope analysis.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AnalysisFindings", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetNetworkInsightsAccessScopeAnalysisFindingsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#GetNetworkInsightsAccessScopeAnalysisFindingsRequest": { + "type": "structure", + "members": { + "NetworkInsightsAccessScopeAnalysisId": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysisId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Network Access Scope analysis.

", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#GetNetworkInsightsAccessScopeAnalysisFindingsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetNetworkInsightsAccessScopeAnalysisFindingsResult": { + "type": "structure", + "members": { + "NetworkInsightsAccessScopeAnalysisId": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysisId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeAnalysisId", + "smithy.api#documentation": "

The ID of the Network Access Scope analysis.

", + "smithy.api#xmlName": "networkInsightsAccessScopeAnalysisId" + } + }, + "AnalysisStatus": { + "target": "com.amazonaws.ec2#AnalysisStatus", + "traits": { + "aws.protocols#ec2QueryName": "AnalysisStatus", + "smithy.api#documentation": "

The status of Network Access Scope Analysis.

", + "smithy.api#xmlName": "analysisStatus" + } + }, + "AnalysisFindings": { + "target": "com.amazonaws.ec2#AccessScopeAnalysisFindingList", + "traits": { + "aws.protocols#ec2QueryName": "AnalysisFindingSet", + "smithy.api#documentation": "

The findings associated with Network Access Scope Analysis.

", + "smithy.api#xmlName": "analysisFindingSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetNetworkInsightsAccessScopeContent": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetNetworkInsightsAccessScopeContentRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetNetworkInsightsAccessScopeContentResult" + }, + "traits": { + "smithy.api#documentation": "

Gets the content for the specified Network Access Scope.

" + } + }, + "com.amazonaws.ec2#GetNetworkInsightsAccessScopeContentRequest": { + "type": "structure", + "members": { + "NetworkInsightsAccessScopeId": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Network Access Scope.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetNetworkInsightsAccessScopeContentResult": { + "type": "structure", + "members": { + "NetworkInsightsAccessScopeContent": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeContent", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeContent", + "smithy.api#documentation": "

The Network Access Scope content.

", + "smithy.api#xmlName": "networkInsightsAccessScopeContent" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetPasswordData": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetPasswordDataRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetPasswordDataResult" + }, + "traits": { + "smithy.api#documentation": "

Retrieves the encrypted administrator password for a running Windows instance.

\n

The Windows password is generated at boot by the EC2Config service or\n EC2Launch scripts (Windows Server 2016 and later). This usually only\n happens the first time an instance is launched. For more information, see EC2Config and EC2Launch in the\n Amazon EC2 User Guide.

\n

For the EC2Config service, the password is not generated for rebundled\n AMIs unless Ec2SetPassword is enabled before bundling.

\n

The password is encrypted using the key pair that you specified when you launched the\n instance. You must provide the corresponding key pair file.

\n

When you launch an instance, password generation and encryption may take a few\n minutes. If you try to retrieve the password before it's available, the output returns\n an empty string. We recommend that you wait up to 15 minutes after launching an instance\n before trying to retrieve the generated password.

", + "smithy.waiters#waitable": { + "PasswordDataAvailable": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "length(PasswordData) > `0`", + "expected": "true", + "comparator": "booleanEquals" + } + } + } + ], + "minDelay": 15 + } + } + } + }, + "com.amazonaws.ec2#GetPasswordDataRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Windows instance.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetPasswordDataResult": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the Windows instance.

", + "smithy.api#xmlName": "instanceId" + } + }, + "Timestamp": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "Timestamp", + "smithy.api#documentation": "

The time the data was last updated.

", + "smithy.api#xmlName": "timestamp" + } + }, + "PasswordData": { + "target": "com.amazonaws.ec2#PasswordData", + "traits": { + "aws.protocols#ec2QueryName": "PasswordData", + "smithy.api#documentation": "

The password of the instance. Returns an empty string if the password is not\n available.

", + "smithy.api#xmlName": "passwordData" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetReservedInstancesExchangeQuote": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetReservedInstancesExchangeQuoteRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetReservedInstancesExchangeQuoteResult" + }, + "traits": { + "smithy.api#documentation": "

Returns a quote and exchange information for exchanging one or more specified\n Convertible Reserved Instances for a new Convertible Reserved Instance. If the exchange\n cannot be performed, the reason is returned in the response. Use AcceptReservedInstancesExchangeQuote to perform the exchange.

" + } + }, + "com.amazonaws.ec2#GetReservedInstancesExchangeQuoteRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ReservedInstanceIds": { + "target": "com.amazonaws.ec2#ReservedInstanceIdSet", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the Convertible Reserved Instances to exchange.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "ReservedInstanceId" + } + }, + "TargetConfigurations": { + "target": "com.amazonaws.ec2#TargetConfigurationRequestSet", + "traits": { + "smithy.api#documentation": "

The configuration of the target Convertible Reserved Instance to exchange for your\n current Convertible Reserved Instances.

", + "smithy.api#xmlName": "TargetConfiguration" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for GetReservedInstanceExchangeQuote.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetReservedInstancesExchangeQuoteResult": { + "type": "structure", + "members": { + "CurrencyCode": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CurrencyCode", + "smithy.api#documentation": "

The currency of the transaction.

", + "smithy.api#xmlName": "currencyCode" + } + }, + "IsValidExchange": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "IsValidExchange", + "smithy.api#documentation": "

If true, the exchange is valid. If false, the exchange cannot be completed.

", + "smithy.api#xmlName": "isValidExchange" + } + }, + "OutputReservedInstancesWillExpireAt": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "OutputReservedInstancesWillExpireAt", + "smithy.api#documentation": "

The new end date of the reservation term.

", + "smithy.api#xmlName": "outputReservedInstancesWillExpireAt" + } + }, + "PaymentDue": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PaymentDue", + "smithy.api#documentation": "

The total true upfront charge for the exchange.

", + "smithy.api#xmlName": "paymentDue" + } + }, + "ReservedInstanceValueRollup": { + "target": "com.amazonaws.ec2#ReservationValue", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstanceValueRollup", + "smithy.api#documentation": "

The cost associated with the Reserved Instance.

", + "smithy.api#xmlName": "reservedInstanceValueRollup" + } + }, + "ReservedInstanceValueSet": { + "target": "com.amazonaws.ec2#ReservedInstanceReservationValueSet", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstanceValueSet", + "smithy.api#documentation": "

The configuration of your Convertible Reserved Instances.

", + "smithy.api#xmlName": "reservedInstanceValueSet" + } + }, + "TargetConfigurationValueRollup": { + "target": "com.amazonaws.ec2#ReservationValue", + "traits": { + "aws.protocols#ec2QueryName": "TargetConfigurationValueRollup", + "smithy.api#documentation": "

The cost associated with the Reserved Instance.

", + "smithy.api#xmlName": "targetConfigurationValueRollup" + } + }, + "TargetConfigurationValueSet": { + "target": "com.amazonaws.ec2#TargetReservationValueSet", + "traits": { + "aws.protocols#ec2QueryName": "TargetConfigurationValueSet", + "smithy.api#documentation": "

The values of the target Convertible Reserved Instances.

", + "smithy.api#xmlName": "targetConfigurationValueSet" + } + }, + "ValidationFailureReason": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ValidationFailureReason", + "smithy.api#documentation": "

Describes the reason why the exchange cannot be completed.

", + "smithy.api#xmlName": "validationFailureReason" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of GetReservedInstancesExchangeQuote.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetSecurityGroupsForVpc": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetSecurityGroupsForVpcRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetSecurityGroupsForVpcResult" + }, + "traits": { + "smithy.api#documentation": "

Gets security groups that can be associated by the Amazon Web Services account making the request with network interfaces in the specified VPC.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "SecurityGroupForVpcs", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetSecurityGroupsForVpcRequest": { + "type": "structure", + "members": { + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The VPC ID where the security group can be used.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#GetSecurityGroupsForVpcRequestMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters. If using multiple filters, the results include security groups which match all filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetSecurityGroupsForVpcRequestMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#GetSecurityGroupsForVpcResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "SecurityGroupForVpcs": { + "target": "com.amazonaws.ec2#SecurityGroupForVpcList", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroupForVpcSet", + "smithy.api#documentation": "

The security group that can be used by interfaces in the VPC.

", + "smithy.api#xmlName": "securityGroupForVpcSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetSerialConsoleAccessStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetSerialConsoleAccessStatusRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetSerialConsoleAccessStatusResult" + }, + "traits": { + "smithy.api#documentation": "

Retrieves the access status of your account to the EC2 serial console of all instances. By\n\t\t\tdefault, access to the EC2 serial console is disabled for your account. For more\n\t\t\tinformation, see Manage account access to the EC2 serial console in the Amazon EC2\n\t\t\t\tUser Guide.

" + } + }, + "com.amazonaws.ec2#GetSerialConsoleAccessStatusRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetSerialConsoleAccessStatusResult": { + "type": "structure", + "members": { + "SerialConsoleAccessEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "SerialConsoleAccessEnabled", + "smithy.api#documentation": "

If true, access to the EC2 serial console of all instances is enabled for\n\t\t\tyour account. If false, access to the EC2 serial console of all instances\n\t\t\tis disabled for your account.

", + "smithy.api#xmlName": "serialConsoleAccessEnabled" + } + }, + "ManagedBy": { + "target": "com.amazonaws.ec2#ManagedBy", + "traits": { + "aws.protocols#ec2QueryName": "ManagedBy", + "smithy.api#documentation": "

The entity that manages access to the serial console. Possible values include:

\n ", + "smithy.api#xmlName": "managedBy" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetSnapshotBlockPublicAccessState": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetSnapshotBlockPublicAccessStateRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetSnapshotBlockPublicAccessStateResult" + }, + "traits": { + "smithy.api#documentation": "

Gets the current state of block public access for snapshots setting \n for the account and Region.

\n

For more information, see \n Block public access for snapshots in the Amazon EBS User Guide.

" + } + }, + "com.amazonaws.ec2#GetSnapshotBlockPublicAccessStateRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetSnapshotBlockPublicAccessStateResult": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.ec2#SnapshotBlockPublicAccessState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of block public access for snapshots. Possible values include:

\n ", + "smithy.api#xmlName": "state" + } + }, + "ManagedBy": { + "target": "com.amazonaws.ec2#ManagedBy", + "traits": { + "aws.protocols#ec2QueryName": "ManagedBy", + "smithy.api#documentation": "

The entity that manages the state for block public access for snapshots. Possible\n values include:

\n ", + "smithy.api#xmlName": "managedBy" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetSpotPlacementScores": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetSpotPlacementScoresRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetSpotPlacementScoresResult" + }, + "traits": { + "smithy.api#documentation": "

Calculates the Spot placement score for a Region or Availability Zone based on the\n specified target capacity and compute requirements.

\n

You can specify your compute requirements either by using\n InstanceRequirementsWithMetadata and letting Amazon EC2 choose the optimal\n instance types to fulfill your Spot request, or you can specify the instance types by using\n InstanceTypes.

\n

For more information, see Spot placement score in\n the Amazon EC2 User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "SpotPlacementScores", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetSpotPlacementScoresRequest": { + "type": "structure", + "members": { + "InstanceTypes": { + "target": "com.amazonaws.ec2#InstanceTypes", + "traits": { + "smithy.api#documentation": "

The instance types. We recommend that you specify at least three instance types. If you\n specify one or two instance types, or specify variations of a single instance type (for\n example, an m3.xlarge with and without instance storage), the returned\n placement score will always be low.

\n

If you specify InstanceTypes, you can't specify\n InstanceRequirementsWithMetadata.

", + "smithy.api#xmlName": "InstanceType" + } + }, + "TargetCapacity": { + "target": "com.amazonaws.ec2#SpotPlacementScoresTargetCapacity", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The target capacity.

", + "smithy.api#required": {} + } + }, + "TargetCapacityUnitType": { + "target": "com.amazonaws.ec2#TargetCapacityUnitType", + "traits": { + "smithy.api#documentation": "

The unit for the target capacity.

" + } + }, + "SingleAvailabilityZone": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Specify true so that the response returns a list of scored Availability Zones.\n Otherwise, the response returns a list of scored Regions.

\n

A list of scored Availability Zones is useful if you want to launch all of your Spot\n capacity into a single Availability Zone.

" + } + }, + "RegionNames": { + "target": "com.amazonaws.ec2#RegionNames", + "traits": { + "smithy.api#documentation": "

The Regions used to narrow down the list of Regions to be scored. Enter the Region code,\n for example, us-east-1.

", + "smithy.api#xmlName": "RegionName" + } + }, + "InstanceRequirementsWithMetadata": { + "target": "com.amazonaws.ec2#InstanceRequirementsWithMetadataRequest", + "traits": { + "smithy.api#documentation": "

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will\n identify instance types with those attributes.

\n

If you specify InstanceRequirementsWithMetadata, you can't specify\n InstanceTypes.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#SpotPlacementScoresMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetSpotPlacementScoresResult": { + "type": "structure", + "members": { + "SpotPlacementScores": { + "target": "com.amazonaws.ec2#SpotPlacementScores", + "traits": { + "aws.protocols#ec2QueryName": "SpotPlacementScoreSet", + "smithy.api#documentation": "

The Spot placement score for the top 10 Regions or Availability Zones, scored on a scale\n from 1 to 10. Each score\u2028 reflects how likely it is that each Region or Availability Zone\n will succeed at fulfilling the specified target capacity\u2028 at the time of the Spot\n placement score request. A score of 10 means that your Spot\n capacity request is highly likely to succeed in that Region or Availability Zone.

\n

If you request a Spot placement score for Regions, a high score assumes that your fleet\n request will be configured to use all Availability Zones and the\n capacity-optimized allocation strategy. If you request a Spot placement\n score for Availability Zones, a high score assumes that your fleet request will be\n configured to use a single Availability Zone and the capacity-optimized\n allocation strategy.

\n

Different\u2028 Regions or Availability Zones might return the same score.

\n \n

The Spot placement score serves as a recommendation only. No score guarantees that your\n Spot request will be fully or partially fulfilled.

\n ", + "smithy.api#xmlName": "spotPlacementScoreSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetSubnetCidrReservations": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetSubnetCidrReservationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetSubnetCidrReservationsResult" + }, + "traits": { + "smithy.api#documentation": "

Gets information about the subnet CIDR reservations.

" + } + }, + "com.amazonaws.ec2#GetSubnetCidrReservationsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#GetSubnetCidrReservationsRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the subnet.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#GetSubnetCidrReservationsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetSubnetCidrReservationsResult": { + "type": "structure", + "members": { + "SubnetIpv4CidrReservations": { + "target": "com.amazonaws.ec2#SubnetCidrReservationList", + "traits": { + "aws.protocols#ec2QueryName": "SubnetIpv4CidrReservationSet", + "smithy.api#documentation": "

Information about the IPv4 subnet CIDR reservations.

", + "smithy.api#xmlName": "subnetIpv4CidrReservationSet" + } + }, + "SubnetIpv6CidrReservations": { + "target": "com.amazonaws.ec2#SubnetCidrReservationList", + "traits": { + "aws.protocols#ec2QueryName": "SubnetIpv6CidrReservationSet", + "smithy.api#documentation": "

Information about the IPv6 subnet CIDR reservations.

", + "smithy.api#xmlName": "subnetIpv6CidrReservationSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetTransitGatewayAttachmentPropagations": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetTransitGatewayAttachmentPropagationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetTransitGatewayAttachmentPropagationsResult" + }, + "traits": { + "smithy.api#documentation": "

Lists the route tables to which the specified resource attachment propagates routes.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TransitGatewayAttachmentPropagations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetTransitGatewayAttachmentPropagationsRequest": { + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the attachment.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#TransitGatewayMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetTransitGatewayAttachmentPropagationsResult": { + "type": "structure", + "members": { + "TransitGatewayAttachmentPropagations": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentPropagationList", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAttachmentPropagations", + "smithy.api#documentation": "

Information about the propagation route tables.

", + "smithy.api#xmlName": "transitGatewayAttachmentPropagations" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetTransitGatewayMulticastDomainAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetTransitGatewayMulticastDomainAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetTransitGatewayMulticastDomainAssociationsResult" + }, + "traits": { + "smithy.api#documentation": "

Gets information about the associations for the transit gateway multicast domain.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "MulticastDomainAssociations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetTransitGatewayMulticastDomainAssociationsRequest": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#TransitGatewayMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetTransitGatewayMulticastDomainAssociationsResult": { + "type": "structure", + "members": { + "MulticastDomainAssociations": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainAssociationList", + "traits": { + "aws.protocols#ec2QueryName": "MulticastDomainAssociations", + "smithy.api#documentation": "

Information about the multicast domain associations.

", + "smithy.api#xmlName": "multicastDomainAssociations" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetTransitGatewayPolicyTableAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetTransitGatewayPolicyTableAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetTransitGatewayPolicyTableAssociationsResult" + }, + "traits": { + "smithy.api#documentation": "

Gets a list of the transit gateway policy table associations.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Associations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetTransitGatewayPolicyTableAssociationsRequest": { + "type": "structure", + "members": { + "TransitGatewayPolicyTableId": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway policy table.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters associated with the transit gateway policy table.

", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#TransitGatewayMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetTransitGatewayPolicyTableAssociationsResult": { + "type": "structure", + "members": { + "Associations": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableAssociationList", + "traits": { + "aws.protocols#ec2QueryName": "Associations", + "smithy.api#documentation": "

Returns details about the transit gateway policy table association.

", + "smithy.api#xmlName": "associations" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token for the next page of results.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetTransitGatewayPolicyTableEntries": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetTransitGatewayPolicyTableEntriesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetTransitGatewayPolicyTableEntriesResult" + }, + "traits": { + "smithy.api#documentation": "

Returns a list of transit gateway policy table entries.

" + } + }, + "com.amazonaws.ec2#GetTransitGatewayPolicyTableEntriesRequest": { + "type": "structure", + "members": { + "TransitGatewayPolicyTableId": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway policy table.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters associated with the transit gateway policy table.

", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#TransitGatewayMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetTransitGatewayPolicyTableEntriesResult": { + "type": "structure", + "members": { + "TransitGatewayPolicyTableEntries": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableEntryList", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayPolicyTableEntries", + "smithy.api#documentation": "

The entries for the transit gateway policy table.

", + "smithy.api#xmlName": "transitGatewayPolicyTableEntries" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetTransitGatewayPrefixListReferences": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetTransitGatewayPrefixListReferencesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetTransitGatewayPrefixListReferencesResult" + }, + "traits": { + "smithy.api#documentation": "

Gets information about the prefix list references in a specified transit gateway route table.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TransitGatewayPrefixListReferences", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetTransitGatewayPrefixListReferencesRequest": { + "type": "structure", + "members": { + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway route table.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#TransitGatewayMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetTransitGatewayPrefixListReferencesResult": { + "type": "structure", + "members": { + "TransitGatewayPrefixListReferences": { + "target": "com.amazonaws.ec2#TransitGatewayPrefixListReferenceSet", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayPrefixListReferenceSet", + "smithy.api#documentation": "

Information about the prefix list references.

", + "smithy.api#xmlName": "transitGatewayPrefixListReferenceSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetTransitGatewayRouteTableAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetTransitGatewayRouteTableAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetTransitGatewayRouteTableAssociationsResult" + }, + "traits": { + "smithy.api#documentation": "

Gets information about the associations for the specified transit gateway route table.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Associations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetTransitGatewayRouteTableAssociationsRequest": { + "type": "structure", + "members": { + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway route table.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#TransitGatewayMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetTransitGatewayRouteTableAssociationsResult": { + "type": "structure", + "members": { + "Associations": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableAssociationList", + "traits": { + "aws.protocols#ec2QueryName": "Associations", + "smithy.api#documentation": "

Information about the associations.

", + "smithy.api#xmlName": "associations" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetTransitGatewayRouteTablePropagations": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetTransitGatewayRouteTablePropagationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetTransitGatewayRouteTablePropagationsResult" + }, + "traits": { + "smithy.api#documentation": "

Gets information about the route table propagations for the specified transit gateway route table.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TransitGatewayRouteTablePropagations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetTransitGatewayRouteTablePropagationsRequest": { + "type": "structure", + "members": { + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway route table.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#TransitGatewayMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetTransitGatewayRouteTablePropagationsResult": { + "type": "structure", + "members": { + "TransitGatewayRouteTablePropagations": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTablePropagationList", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTablePropagations", + "smithy.api#documentation": "

Information about the route table propagations.

", + "smithy.api#xmlName": "transitGatewayRouteTablePropagations" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetVerifiedAccessEndpointPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetVerifiedAccessEndpointPolicyRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetVerifiedAccessEndpointPolicyResult" + }, + "traits": { + "smithy.api#documentation": "

Get the Verified Access policy associated with the endpoint.

" + } + }, + "com.amazonaws.ec2#GetVerifiedAccessEndpointPolicyRequest": { + "type": "structure", + "members": { + "VerifiedAccessEndpointId": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Verified Access endpoint.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetVerifiedAccessEndpointPolicyResult": { + "type": "structure", + "members": { + "PolicyEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "PolicyEnabled", + "smithy.api#documentation": "

The status of the Verified Access policy.

", + "smithy.api#xmlName": "policyEnabled" + } + }, + "PolicyDocument": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PolicyDocument", + "smithy.api#documentation": "

The Verified Access policy document.

", + "smithy.api#xmlName": "policyDocument" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetVerifiedAccessEndpointTargets": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetVerifiedAccessEndpointTargetsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetVerifiedAccessEndpointTargetsResult" + }, + "traits": { + "smithy.api#documentation": "

Gets the targets for the specified network CIDR endpoint for Verified Access.

" + } + }, + "com.amazonaws.ec2#GetVerifiedAccessEndpointTargetsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#GetVerifiedAccessEndpointTargetsRequest": { + "type": "structure", + "members": { + "VerifiedAccessEndpointId": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the network CIDR endpoint.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "VerifiedAccessEndpointId" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#GetVerifiedAccessEndpointTargetsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetVerifiedAccessEndpointTargetsResult": { + "type": "structure", + "members": { + "VerifiedAccessEndpointTargets": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointTargetList", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessEndpointTargetSet", + "smithy.api#documentation": "

The Verified Access targets.

", + "smithy.api#xmlName": "verifiedAccessEndpointTargetSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetVerifiedAccessGroupPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetVerifiedAccessGroupPolicyRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetVerifiedAccessGroupPolicyResult" + }, + "traits": { + "smithy.api#documentation": "

Shows the contents of the Verified Access policy associated with the group.

" + } + }, + "com.amazonaws.ec2#GetVerifiedAccessGroupPolicyRequest": { + "type": "structure", + "members": { + "VerifiedAccessGroupId": { + "target": "com.amazonaws.ec2#VerifiedAccessGroupId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Verified Access group.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetVerifiedAccessGroupPolicyResult": { + "type": "structure", + "members": { + "PolicyEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "PolicyEnabled", + "smithy.api#documentation": "

The status of the Verified Access policy.

", + "smithy.api#xmlName": "policyEnabled" + } + }, + "PolicyDocument": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PolicyDocument", + "smithy.api#documentation": "

The Verified Access policy document.

", + "smithy.api#xmlName": "policyDocument" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetVpnConnectionDeviceSampleConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetVpnConnectionDeviceSampleConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetVpnConnectionDeviceSampleConfigurationResult" + }, + "traits": { + "smithy.api#documentation": "

Download an Amazon Web Services-provided sample configuration file to be used with the customer\n gateway device specified for your Site-to-Site VPN connection.

" + } + }, + "com.amazonaws.ec2#GetVpnConnectionDeviceSampleConfigurationRequest": { + "type": "structure", + "members": { + "VpnConnectionId": { + "target": "com.amazonaws.ec2#VpnConnectionId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The VpnConnectionId specifies the Site-to-Site VPN connection used for the sample\n configuration.

", + "smithy.api#required": {} + } + }, + "VpnConnectionDeviceTypeId": { + "target": "com.amazonaws.ec2#VpnConnectionDeviceTypeId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Device identifier provided by the GetVpnConnectionDeviceTypes API.

", + "smithy.api#required": {} + } + }, + "InternetKeyExchangeVersion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IKE version to be used in the sample configuration file for your customer gateway\n device. You can specify one of the following versions: ikev1 or\n ikev2.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetVpnConnectionDeviceSampleConfigurationResult": { + "type": "structure", + "members": { + "VpnConnectionDeviceSampleConfiguration": { + "target": "com.amazonaws.ec2#VpnConnectionDeviceSampleConfiguration", + "traits": { + "aws.protocols#ec2QueryName": "VpnConnectionDeviceSampleConfiguration", + "smithy.api#documentation": "

Sample configuration file for the specified customer gateway device.

", + "smithy.api#xmlName": "vpnConnectionDeviceSampleConfiguration" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetVpnConnectionDeviceTypes": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetVpnConnectionDeviceTypesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetVpnConnectionDeviceTypesResult" + }, + "traits": { + "smithy.api#documentation": "

Obtain a list of customer gateway devices for which sample configuration\n files can be provided. The request has no additional parameters. You can also see the\n list of device types with sample configuration files available under Your customer gateway\n device in the Amazon Web Services Site-to-Site VPN User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "VpnConnectionDeviceTypes", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetVpnConnectionDeviceTypesRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.ec2#GVCDMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results returned by GetVpnConnectionDeviceTypes in\n paginated output. When this parameter is used, GetVpnConnectionDeviceTypes\n only returns MaxResults results in a single page along with a\n NextToken response element. The remaining results of the initial\n request can be seen by sending another GetVpnConnectionDeviceTypes request\n with the returned NextToken value. This value can be between 200 and 1000.\n If this parameter is not used, then GetVpnConnectionDeviceTypes returns all\n results.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The NextToken value returned from a previous paginated\n GetVpnConnectionDeviceTypes request where MaxResults was\n used and the results exceeded the value of that parameter. Pagination continues from the\n end of the previous results that returned the NextToken value. This value\n is null when there are no more results to return.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetVpnConnectionDeviceTypesResult": { + "type": "structure", + "members": { + "VpnConnectionDeviceTypes": { + "target": "com.amazonaws.ec2#VpnConnectionDeviceTypeList", + "traits": { + "aws.protocols#ec2QueryName": "VpnConnectionDeviceTypeSet", + "smithy.api#documentation": "

List of customer gateway devices that have a sample configuration file available for\n use.

", + "smithy.api#xmlName": "vpnConnectionDeviceTypeSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The NextToken value to include in a future\n GetVpnConnectionDeviceTypes request. When the results of a\n GetVpnConnectionDeviceTypes request exceed MaxResults,\n this value can be used to retrieve the next page of results. This value is null when\n there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetVpnTunnelReplacementStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetVpnTunnelReplacementStatusRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetVpnTunnelReplacementStatusResult" + }, + "traits": { + "smithy.api#documentation": "

Get details of available tunnel endpoint maintenance.

" + } + }, + "com.amazonaws.ec2#GetVpnTunnelReplacementStatusRequest": { + "type": "structure", + "members": { + "VpnConnectionId": { + "target": "com.amazonaws.ec2#VpnConnectionId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Site-to-Site VPN connection.

", + "smithy.api#required": {} + } + }, + "VpnTunnelOutsideIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The external IP address of the VPN tunnel.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetVpnTunnelReplacementStatusResult": { + "type": "structure", + "members": { + "VpnConnectionId": { + "target": "com.amazonaws.ec2#VpnConnectionId", + "traits": { + "aws.protocols#ec2QueryName": "VpnConnectionId", + "smithy.api#documentation": "

The ID of the Site-to-Site VPN connection.

", + "smithy.api#xmlName": "vpnConnectionId" + } + }, + "TransitGatewayId": { + "target": "com.amazonaws.ec2#TransitGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayId", + "smithy.api#documentation": "

The ID of the transit gateway associated with the VPN connection.

", + "smithy.api#xmlName": "transitGatewayId" + } + }, + "CustomerGatewayId": { + "target": "com.amazonaws.ec2#CustomerGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "CustomerGatewayId", + "smithy.api#documentation": "

The ID of the customer gateway.

", + "smithy.api#xmlName": "customerGatewayId" + } + }, + "VpnGatewayId": { + "target": "com.amazonaws.ec2#VpnGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "VpnGatewayId", + "smithy.api#documentation": "

The ID of the virtual private gateway.

", + "smithy.api#xmlName": "vpnGatewayId" + } + }, + "VpnTunnelOutsideIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpnTunnelOutsideIpAddress", + "smithy.api#documentation": "

The external IP address of the VPN tunnel.

", + "smithy.api#xmlName": "vpnTunnelOutsideIpAddress" + } + }, + "MaintenanceDetails": { + "target": "com.amazonaws.ec2#MaintenanceDetails", + "traits": { + "aws.protocols#ec2QueryName": "MaintenanceDetails", + "smithy.api#documentation": "

Get details of pending tunnel endpoint maintenance.

", + "smithy.api#xmlName": "maintenanceDetails" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GpuDeviceCount": { + "type": "integer" + }, + "com.amazonaws.ec2#GpuDeviceInfo": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.ec2#GpuDeviceName", + "traits": { + "aws.protocols#ec2QueryName": "Name", + "smithy.api#documentation": "

The name of the GPU accelerator.

", + "smithy.api#xmlName": "name" + } + }, + "Manufacturer": { + "target": "com.amazonaws.ec2#GpuDeviceManufacturerName", + "traits": { + "aws.protocols#ec2QueryName": "Manufacturer", + "smithy.api#documentation": "

The manufacturer of the GPU accelerator.

", + "smithy.api#xmlName": "manufacturer" + } + }, + "Count": { + "target": "com.amazonaws.ec2#GpuDeviceCount", + "traits": { + "aws.protocols#ec2QueryName": "Count", + "smithy.api#documentation": "

The number of GPUs for the instance type.

", + "smithy.api#xmlName": "count" + } + }, + "MemoryInfo": { + "target": "com.amazonaws.ec2#GpuDeviceMemoryInfo", + "traits": { + "aws.protocols#ec2QueryName": "MemoryInfo", + "smithy.api#documentation": "

Describes the memory available to the GPU accelerator.

", + "smithy.api#xmlName": "memoryInfo" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the GPU accelerators for the instance type.

" + } + }, + "com.amazonaws.ec2#GpuDeviceInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#GpuDeviceInfo", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#GpuDeviceManufacturerName": { + "type": "string" + }, + "com.amazonaws.ec2#GpuDeviceMemoryInfo": { + "type": "structure", + "members": { + "SizeInMiB": { + "target": "com.amazonaws.ec2#GpuDeviceMemorySize", + "traits": { + "aws.protocols#ec2QueryName": "SizeInMiB", + "smithy.api#documentation": "

The size of the memory available to the GPU accelerator, in MiB.

", + "smithy.api#xmlName": "sizeInMiB" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the memory available to the GPU accelerator.

" + } + }, + "com.amazonaws.ec2#GpuDeviceMemorySize": { + "type": "integer" + }, + "com.amazonaws.ec2#GpuDeviceName": { + "type": "string" + }, + "com.amazonaws.ec2#GpuInfo": { + "type": "structure", + "members": { + "Gpus": { + "target": "com.amazonaws.ec2#GpuDeviceInfoList", + "traits": { + "aws.protocols#ec2QueryName": "Gpus", + "smithy.api#documentation": "

Describes the GPU accelerators for the instance type.

", + "smithy.api#xmlName": "gpus" + } + }, + "TotalGpuMemoryInMiB": { + "target": "com.amazonaws.ec2#totalGpuMemory", + "traits": { + "aws.protocols#ec2QueryName": "TotalGpuMemoryInMiB", + "smithy.api#documentation": "

The total size of the memory for the GPU accelerators for the instance type, in MiB.

", + "smithy.api#xmlName": "totalGpuMemoryInMiB" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the GPU accelerators for the instance type.

" + } + }, + "com.amazonaws.ec2#GroupIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "smithy.api#xmlName": "groupId" + } + } + }, + "com.amazonaws.ec2#GroupIdentifier": { + "type": "structure", + "members": { + "GroupId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupId", + "smithy.api#documentation": "

The ID of the security group.

", + "smithy.api#xmlName": "groupId" + } + }, + "GroupName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupName", + "smithy.api#documentation": "

The name of the security group.

", + "smithy.api#xmlName": "groupName" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a security group.

" + } + }, + "com.amazonaws.ec2#GroupIdentifierList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#GroupIdentifier", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#GroupIdentifierSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SecurityGroupIdentifier", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#GroupIds": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#GroupNameStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SecurityGroupName", + "traits": { + "smithy.api#xmlName": "GroupName" + } + } + }, + "com.amazonaws.ec2#HibernationFlag": { + "type": "boolean" + }, + "com.amazonaws.ec2#HibernationOptions": { + "type": "structure", + "members": { + "Configured": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Configured", + "smithy.api#documentation": "

If true, your instance is enabled for hibernation; otherwise, it is not\n enabled for hibernation.

", + "smithy.api#xmlName": "configured" + } + } + }, + "traits": { + "smithy.api#documentation": "

Indicates whether your instance is configured for hibernation. This parameter is valid\n only if the instance meets the hibernation\n prerequisites. For more information, see Hibernate your Amazon EC2\n instance in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#HibernationOptionsRequest": { + "type": "structure", + "members": { + "Configured": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Set to true to enable your instance for hibernation.

\n

For Spot Instances, if you set Configured to true, either\n omit the InstanceInterruptionBehavior parameter (for \n SpotMarketOptions\n ), or set it to\n hibernate. When Configured is true:

\n \n

Default: false\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Indicates whether your instance is configured for hibernation. This parameter is valid\n only if the instance meets the hibernation\n prerequisites. For more information, see Hibernate your Amazon EC2\n instance in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#HistoryRecord": { + "type": "structure", + "members": { + "EventInformation": { + "target": "com.amazonaws.ec2#EventInformation", + "traits": { + "aws.protocols#ec2QueryName": "EventInformation", + "smithy.api#documentation": "

Information about the event.

", + "smithy.api#xmlName": "eventInformation" + } + }, + "EventType": { + "target": "com.amazonaws.ec2#EventType", + "traits": { + "aws.protocols#ec2QueryName": "EventType", + "smithy.api#documentation": "

The event type.

\n ", + "smithy.api#xmlName": "eventType" + } + }, + "Timestamp": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "Timestamp", + "smithy.api#documentation": "

The date and time of the event, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).

", + "smithy.api#xmlName": "timestamp" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an event in the history of the Spot Fleet request.

" + } + }, + "com.amazonaws.ec2#HistoryRecordEntry": { + "type": "structure", + "members": { + "EventInformation": { + "target": "com.amazonaws.ec2#EventInformation", + "traits": { + "aws.protocols#ec2QueryName": "EventInformation", + "smithy.api#documentation": "

Information about the event.

", + "smithy.api#xmlName": "eventInformation" + } + }, + "EventType": { + "target": "com.amazonaws.ec2#FleetEventType", + "traits": { + "aws.protocols#ec2QueryName": "EventType", + "smithy.api#documentation": "

The event type.

", + "smithy.api#xmlName": "eventType" + } + }, + "Timestamp": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "Timestamp", + "smithy.api#documentation": "

The date and time of the event, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).

", + "smithy.api#xmlName": "timestamp" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an event in the history of an EC2 Fleet.

" + } + }, + "com.amazonaws.ec2#HistoryRecordSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#HistoryRecordEntry", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#HistoryRecords": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#HistoryRecord", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Host": { + "type": "structure", + "members": { + "AutoPlacement": { + "target": "com.amazonaws.ec2#AutoPlacement", + "traits": { + "aws.protocols#ec2QueryName": "AutoPlacement", + "smithy.api#documentation": "

Whether auto-placement is on or off.

", + "smithy.api#xmlName": "autoPlacement" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone of the Dedicated Host.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "AvailableCapacity": { + "target": "com.amazonaws.ec2#AvailableCapacity", + "traits": { + "aws.protocols#ec2QueryName": "AvailableCapacity", + "smithy.api#documentation": "

Information about the instances running on the Dedicated Host.

", + "smithy.api#xmlName": "availableCapacity" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

", + "smithy.api#xmlName": "clientToken" + } + }, + "HostId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "HostId", + "smithy.api#documentation": "

The ID of the Dedicated Host.

", + "smithy.api#xmlName": "hostId" + } + }, + "HostProperties": { + "target": "com.amazonaws.ec2#HostProperties", + "traits": { + "aws.protocols#ec2QueryName": "HostProperties", + "smithy.api#documentation": "

The hardware specifications of the Dedicated Host.

", + "smithy.api#xmlName": "hostProperties" + } + }, + "HostReservationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "HostReservationId", + "smithy.api#documentation": "

The reservation ID of the Dedicated Host. This returns a null response if\n the Dedicated Host doesn't have an associated reservation.

", + "smithy.api#xmlName": "hostReservationId" + } + }, + "Instances": { + "target": "com.amazonaws.ec2#HostInstanceList", + "traits": { + "aws.protocols#ec2QueryName": "Instances", + "smithy.api#documentation": "

The IDs and instance type that are currently running on the Dedicated Host.

", + "smithy.api#xmlName": "instances" + } + }, + "State": { + "target": "com.amazonaws.ec2#AllocationState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The Dedicated Host's state.

", + "smithy.api#xmlName": "state" + } + }, + "AllocationTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "AllocationTime", + "smithy.api#documentation": "

The time that the Dedicated Host was allocated.

", + "smithy.api#xmlName": "allocationTime" + } + }, + "ReleaseTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "ReleaseTime", + "smithy.api#documentation": "

The time that the Dedicated Host was released.

", + "smithy.api#xmlName": "releaseTime" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the Dedicated Host.

", + "smithy.api#xmlName": "tagSet" + } + }, + "HostRecovery": { + "target": "com.amazonaws.ec2#HostRecovery", + "traits": { + "aws.protocols#ec2QueryName": "HostRecovery", + "smithy.api#documentation": "

Indicates whether host recovery is enabled or disabled for the Dedicated Host.

", + "smithy.api#xmlName": "hostRecovery" + } + }, + "AllowsMultipleInstanceTypes": { + "target": "com.amazonaws.ec2#AllowsMultipleInstanceTypes", + "traits": { + "aws.protocols#ec2QueryName": "AllowsMultipleInstanceTypes", + "smithy.api#documentation": "

Indicates whether the Dedicated Host supports multiple instance types of the same\n instance family. If the value is on, the Dedicated Host supports multiple\n instance types in the instance family. If the value is off, the Dedicated\n Host supports a single instance type only.

", + "smithy.api#xmlName": "allowsMultipleInstanceTypes" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the Dedicated Host.

", + "smithy.api#xmlName": "ownerId" + } + }, + "AvailabilityZoneId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZoneId", + "smithy.api#documentation": "

The ID of the Availability Zone in which the Dedicated Host is allocated.

", + "smithy.api#xmlName": "availabilityZoneId" + } + }, + "MemberOfServiceLinkedResourceGroup": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "MemberOfServiceLinkedResourceGroup", + "smithy.api#documentation": "

Indicates whether the Dedicated Host is in a host resource group. If memberOfServiceLinkedResourceGroup is true, the\n host is in a host resource group; otherwise, it is not.

", + "smithy.api#xmlName": "memberOfServiceLinkedResourceGroup" + } + }, + "OutpostArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OutpostArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which the\n Dedicated Host is allocated.

", + "smithy.api#xmlName": "outpostArn" + } + }, + "HostMaintenance": { + "target": "com.amazonaws.ec2#HostMaintenance", + "traits": { + "aws.protocols#ec2QueryName": "HostMaintenance", + "smithy.api#documentation": "

Indicates whether host maintenance is enabled or disabled for the Dedicated\n Host.

", + "smithy.api#xmlName": "hostMaintenance" + } + }, + "AssetId": { + "target": "com.amazonaws.ec2#AssetId", + "traits": { + "aws.protocols#ec2QueryName": "AssetId", + "smithy.api#documentation": "

The ID of the Outpost hardware asset on which the Dedicated Host is allocated.

", + "smithy.api#xmlName": "assetId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the properties of the Dedicated Host.

" + } + }, + "com.amazonaws.ec2#HostInstance": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of instance that is running on the Dedicated Host.

", + "smithy.api#xmlName": "instanceId" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type (for example, m3.medium) of the running\n instance.

", + "smithy.api#xmlName": "instanceType" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the instance.

", + "smithy.api#xmlName": "ownerId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an instance running on a Dedicated Host.

" + } + }, + "com.amazonaws.ec2#HostInstanceList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#HostInstance", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#HostList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Host", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#HostMaintenance": { + "type": "enum", + "members": { + "on": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "on" + } + }, + "off": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "off" + } + } + } + }, + "com.amazonaws.ec2#HostOffering": { + "type": "structure", + "members": { + "CurrencyCode": { + "target": "com.amazonaws.ec2#CurrencyCodeValues", + "traits": { + "aws.protocols#ec2QueryName": "CurrencyCode", + "smithy.api#documentation": "

The currency of the offering.

", + "smithy.api#xmlName": "currencyCode" + } + }, + "Duration": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Duration", + "smithy.api#documentation": "

The duration of the offering (in seconds).

", + "smithy.api#xmlName": "duration" + } + }, + "HourlyPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "HourlyPrice", + "smithy.api#documentation": "

The hourly price of the offering.

", + "smithy.api#xmlName": "hourlyPrice" + } + }, + "InstanceFamily": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceFamily", + "smithy.api#documentation": "

The instance family of the offering.

", + "smithy.api#xmlName": "instanceFamily" + } + }, + "OfferingId": { + "target": "com.amazonaws.ec2#OfferingId", + "traits": { + "aws.protocols#ec2QueryName": "OfferingId", + "smithy.api#documentation": "

The ID of the offering.

", + "smithy.api#xmlName": "offeringId" + } + }, + "PaymentOption": { + "target": "com.amazonaws.ec2#PaymentOption", + "traits": { + "aws.protocols#ec2QueryName": "PaymentOption", + "smithy.api#documentation": "

The available payment option.

", + "smithy.api#xmlName": "paymentOption" + } + }, + "UpfrontPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "UpfrontPrice", + "smithy.api#documentation": "

The upfront price of the offering. Does not apply to No Upfront offerings.

", + "smithy.api#xmlName": "upfrontPrice" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the Dedicated Host Reservation offering.

" + } + }, + "com.amazonaws.ec2#HostOfferingSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#HostOffering", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#HostProperties": { + "type": "structure", + "members": { + "Cores": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Cores", + "smithy.api#documentation": "

The number of cores on the Dedicated Host.

", + "smithy.api#xmlName": "cores" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type supported by the Dedicated Host. For example, m5.large.\n If the host supports multiple instance types, no instanceType is returned.

", + "smithy.api#xmlName": "instanceType" + } + }, + "InstanceFamily": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceFamily", + "smithy.api#documentation": "

The instance family supported by the Dedicated Host. For example,\n m5.

", + "smithy.api#xmlName": "instanceFamily" + } + }, + "Sockets": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Sockets", + "smithy.api#documentation": "

The number of sockets on the Dedicated Host.

", + "smithy.api#xmlName": "sockets" + } + }, + "TotalVCpus": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TotalVCpus", + "smithy.api#documentation": "

The total number of vCPUs on the Dedicated Host.

", + "smithy.api#xmlName": "totalVCpus" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the properties of a Dedicated Host.

" + } + }, + "com.amazonaws.ec2#HostRecovery": { + "type": "enum", + "members": { + "on": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "on" + } + }, + "off": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "off" + } + } + } + }, + "com.amazonaws.ec2#HostReservation": { + "type": "structure", + "members": { + "Count": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Count", + "smithy.api#documentation": "

The number of Dedicated Hosts the reservation is associated with.

", + "smithy.api#xmlName": "count" + } + }, + "CurrencyCode": { + "target": "com.amazonaws.ec2#CurrencyCodeValues", + "traits": { + "aws.protocols#ec2QueryName": "CurrencyCode", + "smithy.api#documentation": "

The currency in which the upfrontPrice and hourlyPrice\n amounts are specified. At this time, the only supported currency is\n USD.

", + "smithy.api#xmlName": "currencyCode" + } + }, + "Duration": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Duration", + "smithy.api#documentation": "

The length of the reservation's term, specified in seconds. Can be 31536000 (1\n year) | 94608000 (3 years).

", + "smithy.api#xmlName": "duration" + } + }, + "End": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "End", + "smithy.api#documentation": "

The date and time that the reservation ends.

", + "smithy.api#xmlName": "end" + } + }, + "HostIdSet": { + "target": "com.amazonaws.ec2#ResponseHostIdSet", + "traits": { + "aws.protocols#ec2QueryName": "HostIdSet", + "smithy.api#documentation": "

The IDs of the Dedicated Hosts associated with the reservation.

", + "smithy.api#xmlName": "hostIdSet" + } + }, + "HostReservationId": { + "target": "com.amazonaws.ec2#HostReservationId", + "traits": { + "aws.protocols#ec2QueryName": "HostReservationId", + "smithy.api#documentation": "

The ID of the reservation that specifies the associated Dedicated Hosts.

", + "smithy.api#xmlName": "hostReservationId" + } + }, + "HourlyPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "HourlyPrice", + "smithy.api#documentation": "

The hourly price of the reservation.

", + "smithy.api#xmlName": "hourlyPrice" + } + }, + "InstanceFamily": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceFamily", + "smithy.api#documentation": "

The instance family of the Dedicated Host Reservation. The instance family on the\n Dedicated Host must be the same in order for it to benefit from the reservation.

", + "smithy.api#xmlName": "instanceFamily" + } + }, + "OfferingId": { + "target": "com.amazonaws.ec2#OfferingId", + "traits": { + "aws.protocols#ec2QueryName": "OfferingId", + "smithy.api#documentation": "

The ID of the reservation. This remains the same regardless of which Dedicated Hosts\n are associated with it.

", + "smithy.api#xmlName": "offeringId" + } + }, + "PaymentOption": { + "target": "com.amazonaws.ec2#PaymentOption", + "traits": { + "aws.protocols#ec2QueryName": "PaymentOption", + "smithy.api#documentation": "

The payment option selected for this reservation.

", + "smithy.api#xmlName": "paymentOption" + } + }, + "Start": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "Start", + "smithy.api#documentation": "

The date and time that the reservation started.

", + "smithy.api#xmlName": "start" + } + }, + "State": { + "target": "com.amazonaws.ec2#ReservationState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the reservation.

", + "smithy.api#xmlName": "state" + } + }, + "UpfrontPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "UpfrontPrice", + "smithy.api#documentation": "

The upfront price of the reservation.

", + "smithy.api#xmlName": "upfrontPrice" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the Dedicated Host Reservation.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the Dedicated Host Reservation and associated Dedicated Hosts.

" + } + }, + "com.amazonaws.ec2#HostReservationId": { + "type": "string" + }, + "com.amazonaws.ec2#HostReservationIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#HostReservationId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#HostReservationSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#HostReservation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#HostTenancy": { + "type": "enum", + "members": { + "default": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "default" + } + }, + "dedicated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dedicated" + } + }, + "host": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "host" + } + } + } + }, + "com.amazonaws.ec2#HostnameType": { + "type": "enum", + "members": { + "ip_name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ip-name" + } + }, + "resource_name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "resource-name" + } + } + } + }, + "com.amazonaws.ec2#Hour": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 23 + } + } + }, + "com.amazonaws.ec2#HttpTokensState": { + "type": "enum", + "members": { + "optional": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "optional" + } + }, + "required": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "required" + } + } + } + }, + "com.amazonaws.ec2#HypervisorType": { + "type": "enum", + "members": { + "ovm": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ovm" + } + }, + "xen": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "xen" + } + } + } + }, + "com.amazonaws.ec2#IKEVersionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IKEVersionsListValue", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IKEVersionsListValue": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Value", + "smithy.api#documentation": "

The IKE version.

", + "smithy.api#xmlName": "value" + } + } + }, + "traits": { + "smithy.api#documentation": "

The internet key exchange (IKE) version permitted for the VPN tunnel.

" + } + }, + "com.amazonaws.ec2#IKEVersionsRequestList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IKEVersionsRequestListValue", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IKEVersionsRequestListValue": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IKE version.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The IKE version that is permitted for the VPN tunnel.

" + } + }, + "com.amazonaws.ec2#IamInstanceProfile": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Arn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the instance profile.

", + "smithy.api#xmlName": "arn" + } + }, + "Id": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Id", + "smithy.api#documentation": "

The ID of the instance profile.

", + "smithy.api#xmlName": "id" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an IAM instance profile.

" + } + }, + "com.amazonaws.ec2#IamInstanceProfileAssociation": { + "type": "structure", + "members": { + "AssociationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AssociationId", + "smithy.api#documentation": "

The ID of the association.

", + "smithy.api#xmlName": "associationId" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#xmlName": "instanceId" + } + }, + "IamInstanceProfile": { + "target": "com.amazonaws.ec2#IamInstanceProfile", + "traits": { + "aws.protocols#ec2QueryName": "IamInstanceProfile", + "smithy.api#documentation": "

The IAM instance profile.

", + "smithy.api#xmlName": "iamInstanceProfile" + } + }, + "State": { + "target": "com.amazonaws.ec2#IamInstanceProfileAssociationState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the association.

", + "smithy.api#xmlName": "state" + } + }, + "Timestamp": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "Timestamp", + "smithy.api#documentation": "

The time the IAM instance profile was associated with the instance.

", + "smithy.api#xmlName": "timestamp" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an association between an IAM instance profile and an instance.

" + } + }, + "com.amazonaws.ec2#IamInstanceProfileAssociationId": { + "type": "string" + }, + "com.amazonaws.ec2#IamInstanceProfileAssociationSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IamInstanceProfileAssociation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IamInstanceProfileAssociationState": { + "type": "enum", + "members": { + "ASSOCIATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associating" + } + }, + "ASSOCIATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associated" + } + }, + "DISASSOCIATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociating" + } + }, + "DISASSOCIATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociated" + } + } + } + }, + "com.amazonaws.ec2#IamInstanceProfileSpecification": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Arn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the instance profile.

", + "smithy.api#xmlName": "arn" + } + }, + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Name", + "smithy.api#documentation": "

The name of the instance profile.

", + "smithy.api#xmlName": "name" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an IAM instance profile.

" + } + }, + "com.amazonaws.ec2#IcmpTypeCode": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The ICMP code. A value of -1 means all codes for the specified ICMP type.

", + "smithy.api#xmlName": "code" + } + }, + "Type": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Type", + "smithy.api#documentation": "

The ICMP type. A value of -1 means all types.

", + "smithy.api#xmlName": "type" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the ICMP type and code.

" + } + }, + "com.amazonaws.ec2#IdFormat": { + "type": "structure", + "members": { + "Deadline": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "Deadline", + "smithy.api#documentation": "

The date in UTC at which you are permanently switched over to using longer IDs. If a deadline is not yet available for this resource type, this field is not returned.

", + "smithy.api#xmlName": "deadline" + } + }, + "Resource": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Resource", + "smithy.api#documentation": "

The type of resource.

", + "smithy.api#xmlName": "resource" + } + }, + "UseLongIds": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "UseLongIds", + "smithy.api#documentation": "

Indicates whether longer IDs (17-character IDs) are enabled for the resource.

", + "smithy.api#xmlName": "useLongIds" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the ID format for a resource.

" + } + }, + "com.amazonaws.ec2#IdFormatList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IdFormat", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Igmpv2SupportValue": { + "type": "enum", + "members": { + "enable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enable" + } + }, + "disable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disable" + } + } + } + }, + "com.amazonaws.ec2#Image": { + "type": "structure", + "members": { + "PlatformDetails": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PlatformDetails", + "smithy.api#documentation": "

The platform details associated with the billing code of the AMI. For more information,\n see Understand\n AMI billing information in the Amazon EC2 User Guide.

", + "smithy.api#xmlName": "platformDetails" + } + }, + "UsageOperation": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "UsageOperation", + "smithy.api#documentation": "

The operation of the Amazon EC2 instance and the billing code that is associated with the AMI.\n usageOperation corresponds to the lineitem/Operation column on your Amazon Web Services Cost and Usage Report and in the Amazon Web Services Price\n List API. You can view these fields on the Instances or AMIs pages in the Amazon EC2 console,\n or in the responses that are returned by the DescribeImages command in\n the Amazon EC2 API, or the describe-images command in the\n CLI.

", + "smithy.api#xmlName": "usageOperation" + } + }, + "BlockDeviceMappings": { + "target": "com.amazonaws.ec2#BlockDeviceMappingList", + "traits": { + "aws.protocols#ec2QueryName": "BlockDeviceMapping", + "smithy.api#documentation": "

Any block device mapping entries.

", + "smithy.api#xmlName": "blockDeviceMapping" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description of the AMI that was provided during image creation.

", + "smithy.api#xmlName": "description" + } + }, + "EnaSupport": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EnaSupport", + "smithy.api#documentation": "

Specifies whether enhanced networking with ENA is enabled.

", + "smithy.api#xmlName": "enaSupport" + } + }, + "Hypervisor": { + "target": "com.amazonaws.ec2#HypervisorType", + "traits": { + "aws.protocols#ec2QueryName": "Hypervisor", + "smithy.api#documentation": "

The hypervisor type of the image. Only xen is supported. ovm is\n not supported.

", + "smithy.api#xmlName": "hypervisor" + } + }, + "ImageOwnerAlias": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImageOwnerAlias", + "smithy.api#documentation": "

The owner alias (amazon | aws-backup-vault |\n aws-marketplace).

", + "smithy.api#xmlName": "imageOwnerAlias" + } + }, + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Name", + "smithy.api#documentation": "

The name of the AMI that was provided during image creation.

", + "smithy.api#xmlName": "name" + } + }, + "RootDeviceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RootDeviceName", + "smithy.api#documentation": "

The device name of the root device volume (for example, /dev/sda1).

", + "smithy.api#xmlName": "rootDeviceName" + } + }, + "RootDeviceType": { + "target": "com.amazonaws.ec2#DeviceType", + "traits": { + "aws.protocols#ec2QueryName": "RootDeviceType", + "smithy.api#documentation": "

The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance\n store volume.

", + "smithy.api#xmlName": "rootDeviceType" + } + }, + "SriovNetSupport": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SriovNetSupport", + "smithy.api#documentation": "

Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is\n enabled.

", + "smithy.api#xmlName": "sriovNetSupport" + } + }, + "StateReason": { + "target": "com.amazonaws.ec2#StateReason", + "traits": { + "aws.protocols#ec2QueryName": "StateReason", + "smithy.api#documentation": "

The reason for the state change.

", + "smithy.api#xmlName": "stateReason" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the image.

", + "smithy.api#xmlName": "tagSet" + } + }, + "VirtualizationType": { + "target": "com.amazonaws.ec2#VirtualizationType", + "traits": { + "aws.protocols#ec2QueryName": "VirtualizationType", + "smithy.api#documentation": "

The type of virtualization of the AMI.

", + "smithy.api#xmlName": "virtualizationType" + } + }, + "BootMode": { + "target": "com.amazonaws.ec2#BootModeValues", + "traits": { + "aws.protocols#ec2QueryName": "BootMode", + "smithy.api#documentation": "

The boot mode of the image. For more information, see Boot modes in the\n Amazon EC2 User Guide.

", + "smithy.api#xmlName": "bootMode" + } + }, + "TpmSupport": { + "target": "com.amazonaws.ec2#TpmSupportValues", + "traits": { + "aws.protocols#ec2QueryName": "TpmSupport", + "smithy.api#documentation": "

If the image is configured for NitroTPM support, the value is v2.0. For more\n information, see NitroTPM in the Amazon EC2 User Guide.

", + "smithy.api#xmlName": "tpmSupport" + } + }, + "DeprecationTime": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DeprecationTime", + "smithy.api#documentation": "

The date and time to deprecate the AMI, in UTC, in the following format:\n YYYY-MM-DDTHH:MM:SSZ.\n If you specified a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.

", + "smithy.api#xmlName": "deprecationTime" + } + }, + "ImdsSupport": { + "target": "com.amazonaws.ec2#ImdsSupportValues", + "traits": { + "aws.protocols#ec2QueryName": "ImdsSupport", + "smithy.api#documentation": "

If v2.0, it indicates that IMDSv2 is specified in the AMI. Instances launched\n from this AMI will have HttpTokens automatically set to required so\n that, by default, the instance requires that IMDSv2 is used when requesting instance metadata.\n In addition, HttpPutResponseHopLimit is set to 2. For more\n information, see Configure the AMI in the Amazon EC2 User Guide.

", + "smithy.api#xmlName": "imdsSupport" + } + }, + "SourceInstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SourceInstanceId", + "smithy.api#documentation": "

The ID of the instance that the AMI was created from if the AMI was created using CreateImage. This field only appears if the AMI was created using\n CreateImage.

", + "smithy.api#xmlName": "sourceInstanceId" + } + }, + "DeregistrationProtection": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DeregistrationProtection", + "smithy.api#documentation": "

Indicates whether deregistration protection is enabled for the AMI.

", + "smithy.api#xmlName": "deregistrationProtection" + } + }, + "LastLaunchedTime": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LastLaunchedTime", + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the AMI was last used to launch an EC2 instance. When the AMI is used\n to launch an instance, there is a 24-hour delay before that usage is reported.

\n \n

\n lastLaunchedTime data is available starting April 2017.

\n ", + "smithy.api#xmlName": "lastLaunchedTime" + } + }, + "ImageAllowed": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "ImageAllowed", + "smithy.api#documentation": "

If true, the AMI satisfies the criteria for Allowed AMIs and can be\n discovered and used in the account. If false and Allowed AMIs is set to\n enabled, the AMI can't be discovered or used in the account. If\n false and Allowed AMIs is set to audit-mode, the AMI can be\n discovered and used in the account.

\n

For more information, see Control the discovery and use of AMIs in\n Amazon EC2 with Allowed AMIs in\n Amazon EC2 User Guide.

", + "smithy.api#xmlName": "imageAllowed" + } + }, + "SourceImageId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SourceImageId", + "smithy.api#documentation": "

The ID of the source AMI from which the AMI was created.

\n

The ID only appears if the AMI was created using CreateImage, CopyImage, or CreateRestoreImageTask. The ID does not appear\n if the AMI was created using any other API. For some older AMIs, the ID might not be\n available. For more information, see Identify the\n source AMI used to create a new AMI in the\n Amazon EC2 User Guide.

", + "smithy.api#xmlName": "sourceImageId" + } + }, + "SourceImageRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SourceImageRegion", + "smithy.api#documentation": "

The Region of the source AMI.

\n

The Region only appears if the AMI was created using CreateImage, CopyImage, or CreateRestoreImageTask. The Region does not\n appear if the AMI was created using any other API. For some older AMIs, the Region might not\n be available. For more information, see Identify the\n source AMI used to create a new AMI in the\n Amazon EC2 User Guide.

", + "smithy.api#xmlName": "sourceImageRegion" + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the AMI.

", + "smithy.api#xmlName": "imageId" + } + }, + "ImageLocation": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImageLocation", + "smithy.api#documentation": "

The location of the AMI.

", + "smithy.api#xmlName": "imageLocation" + } + }, + "State": { + "target": "com.amazonaws.ec2#ImageState", + "traits": { + "aws.protocols#ec2QueryName": "ImageState", + "smithy.api#documentation": "

The current state of the AMI. If the state is available, the image is\n successfully registered and can be used to launch an instance.

", + "smithy.api#xmlName": "imageState" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImageOwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the image.

", + "smithy.api#xmlName": "imageOwnerId" + } + }, + "CreationDate": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CreationDate", + "smithy.api#documentation": "

The date and time the image was created.

", + "smithy.api#xmlName": "creationDate" + } + }, + "Public": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "IsPublic", + "smithy.api#documentation": "

Indicates whether the image has public launch permissions. The value is true\n if this image has public launch permissions or false if it has only implicit and\n explicit launch permissions.

", + "smithy.api#xmlName": "isPublic" + } + }, + "ProductCodes": { + "target": "com.amazonaws.ec2#ProductCodeList", + "traits": { + "aws.protocols#ec2QueryName": "ProductCodes", + "smithy.api#documentation": "

Any product codes associated with the AMI.

", + "smithy.api#xmlName": "productCodes" + } + }, + "Architecture": { + "target": "com.amazonaws.ec2#ArchitectureValues", + "traits": { + "aws.protocols#ec2QueryName": "Architecture", + "smithy.api#documentation": "

The architecture of the image.

", + "smithy.api#xmlName": "architecture" + } + }, + "ImageType": { + "target": "com.amazonaws.ec2#ImageTypeValues", + "traits": { + "aws.protocols#ec2QueryName": "ImageType", + "smithy.api#documentation": "

The type of image.

", + "smithy.api#xmlName": "imageType" + } + }, + "KernelId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KernelId", + "smithy.api#documentation": "

The kernel associated with the image, if any. Only applicable for machine images.

", + "smithy.api#xmlName": "kernelId" + } + }, + "RamdiskId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RamdiskId", + "smithy.api#documentation": "

The RAM disk associated with the image, if any. Only applicable for machine images.

", + "smithy.api#xmlName": "ramdiskId" + } + }, + "Platform": { + "target": "com.amazonaws.ec2#PlatformValues", + "traits": { + "aws.protocols#ec2QueryName": "Platform", + "smithy.api#documentation": "

This value is set to windows for Windows AMIs; otherwise, it is blank.

", + "smithy.api#xmlName": "platform" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an image.

" + } + }, + "com.amazonaws.ec2#ImageAttribute": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description for the AMI.

", + "smithy.api#xmlName": "description" + } + }, + "KernelId": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "Kernel", + "smithy.api#documentation": "

The kernel ID.

", + "smithy.api#xmlName": "kernel" + } + }, + "RamdiskId": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "Ramdisk", + "smithy.api#documentation": "

The RAM disk ID.

", + "smithy.api#xmlName": "ramdisk" + } + }, + "SriovNetSupport": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "SriovNetSupport", + "smithy.api#documentation": "

Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is\n enabled.

", + "smithy.api#xmlName": "sriovNetSupport" + } + }, + "BootMode": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "BootMode", + "smithy.api#documentation": "

The boot mode.

", + "smithy.api#xmlName": "bootMode" + } + }, + "TpmSupport": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "TpmSupport", + "smithy.api#documentation": "

If the image is configured for NitroTPM support, the value is v2.0.

", + "smithy.api#xmlName": "tpmSupport" + } + }, + "UefiData": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "UefiData", + "smithy.api#documentation": "

Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data,\n use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the\n python-uefivars tool on\n GitHub. For more information, see UEFI Secure Boot in the\n Amazon EC2 User Guide.

", + "smithy.api#xmlName": "uefiData" + } + }, + "LastLaunchedTime": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "LastLaunchedTime", + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the AMI was last used to launch an EC2 instance. When the AMI is used\n to launch an instance, there is a 24-hour delay before that usage is reported.

\n \n

\n lastLaunchedTime data is available starting April 2017.

\n ", + "smithy.api#xmlName": "lastLaunchedTime" + } + }, + "ImdsSupport": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "ImdsSupport", + "smithy.api#documentation": "

If v2.0, it indicates that IMDSv2 is specified in the AMI. Instances launched\n from this AMI will have HttpTokens automatically set to required so\n that, by default, the instance requires that IMDSv2 is used when requesting instance metadata.\n In addition, HttpPutResponseHopLimit is set to 2. For more\n information, see Configure the AMI in the Amazon EC2 User Guide.

", + "smithy.api#xmlName": "imdsSupport" + } + }, + "DeregistrationProtection": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "DeregistrationProtection", + "smithy.api#documentation": "

Indicates whether deregistration protection is enabled for the AMI.

", + "smithy.api#xmlName": "deregistrationProtection" + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the AMI.

", + "smithy.api#xmlName": "imageId" + } + }, + "LaunchPermissions": { + "target": "com.amazonaws.ec2#LaunchPermissionList", + "traits": { + "aws.protocols#ec2QueryName": "LaunchPermission", + "smithy.api#documentation": "

The launch permissions.

", + "smithy.api#xmlName": "launchPermission" + } + }, + "ProductCodes": { + "target": "com.amazonaws.ec2#ProductCodeList", + "traits": { + "aws.protocols#ec2QueryName": "ProductCodes", + "smithy.api#documentation": "

The product codes.

", + "smithy.api#xmlName": "productCodes" + } + }, + "BlockDeviceMappings": { + "target": "com.amazonaws.ec2#BlockDeviceMappingList", + "traits": { + "aws.protocols#ec2QueryName": "BlockDeviceMapping", + "smithy.api#documentation": "

The block device mapping entries.

", + "smithy.api#xmlName": "blockDeviceMapping" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an image attribute.

" + } + }, + "com.amazonaws.ec2#ImageAttributeName": { + "type": "enum", + "members": { + "description": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "description" + } + }, + "kernel": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "kernel" + } + }, + "ramdisk": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ramdisk" + } + }, + "launchPermission": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "launchPermission" + } + }, + "productCodes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "productCodes" + } + }, + "blockDeviceMapping": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "blockDeviceMapping" + } + }, + "sriovNetSupport": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sriovNetSupport" + } + }, + "bootMode": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "bootMode" + } + }, + "tpmSupport": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "tpmSupport" + } + }, + "uefiData": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "uefiData" + } + }, + "lastLaunchedTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "lastLaunchedTime" + } + }, + "imdsSupport": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "imdsSupport" + } + }, + "deregistrationProtection": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deregistrationProtection" + } + } + } + }, + "com.amazonaws.ec2#ImageBlockPublicAccessDisabledState": { + "type": "enum", + "members": { + "unblocked": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unblocked" + } + } + } + }, + "com.amazonaws.ec2#ImageBlockPublicAccessEnabledState": { + "type": "enum", + "members": { + "block_new_sharing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "block-new-sharing" + } + } + } + }, + "com.amazonaws.ec2#ImageCriterion": { + "type": "structure", + "members": { + "ImageProviders": { + "target": "com.amazonaws.ec2#ImageProviderList", + "traits": { + "aws.protocols#ec2QueryName": "ImageProviderSet", + "smithy.api#documentation": "

A list of AMI providers whose AMIs are discoverable and useable in the account. Up to a\n total of 200 values can be specified.

\n

Possible values:

\n

\n amazon: Allow AMIs created by Amazon Web Services.

\n

\n aws-marketplace: Allow AMIs created by verified providers in the Amazon Web Services\n Marketplace.

\n

\n aws-backup-vault: Allow AMIs created by Amazon Web Services Backup.

\n

12-digit account ID: Allow AMIs created by this account. One or more account IDs can be\n specified.

\n

\n none: Allow AMIs created by your own account only.

", + "smithy.api#xmlName": "imageProviderSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

The list of criteria that are evaluated to determine whch AMIs are discoverable and usable\n in the account in the specified Amazon Web Services Region. Currently, the only criteria that can be\n specified are AMI providers.

\n

Up to 10 imageCriteria objects can be specified, and up to a total of 200\n values for all imageProviders. For more information, see JSON\n configuration for the Allowed AMIs criteria in the\n Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#ImageCriterionList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ImageCriterion", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ImageCriterionRequest": { + "type": "structure", + "members": { + "ImageProviders": { + "target": "com.amazonaws.ec2#ImageProviderRequestList", + "traits": { + "smithy.api#documentation": "

A list of image providers whose AMIs are discoverable and useable in the account. Up to a\n total of 200 values can be specified.

\n

Possible values:

\n

\n amazon: Allow AMIs created by Amazon Web Services.

\n

\n aws-marketplace: Allow AMIs created by verified providers in the Amazon Web Services\n Marketplace.

\n

\n aws-backup-vault: Allow AMIs created by Amazon Web Services Backup.

\n

12-digit account ID: Allow AMIs created by this account. One or more account IDs can be\n specified.

\n

\n none: Allow AMIs created by your own account only. When none is\n specified, no other values can be specified.

", + "smithy.api#xmlName": "ImageProvider" + } + } + }, + "traits": { + "smithy.api#documentation": "

The list of criteria that are evaluated to determine whch AMIs are discoverable and usable\n in the account in the specified Amazon Web Services Region. Currently, the only criteria that can be\n specified are AMI providers.

\n

Up to 10 imageCriteria objects can be specified, and up to a total of 200\n values for all imageProviders. For more information, see JSON\n configuration for the Allowed AMIs criteria in the\n Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#ImageCriterionRequestList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ImageCriterionRequest", + "traits": { + "smithy.api#xmlName": "ImageCriterion" + } + } + }, + "com.amazonaws.ec2#ImageDiskContainer": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The description of the disk image.

" + } + }, + "DeviceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The block device mapping for the disk.

" + } + }, + "Format": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The format of the disk image being imported.

\n

Valid values: OVA | VHD | VHDX | VMDK | RAW\n

" + } + }, + "SnapshotId": { + "target": "com.amazonaws.ec2#SnapshotId", + "traits": { + "smithy.api#documentation": "

The ID of the EBS snapshot to be used for importing the snapshot.

" + } + }, + "Url": { + "target": "com.amazonaws.ec2#SensitiveUrl", + "traits": { + "smithy.api#documentation": "

The URL to the Amazon S3-based disk image being imported. The URL can either be a https URL (https://..) or an\n Amazon S3 URL (s3://..)

" + } + }, + "UserBucket": { + "target": "com.amazonaws.ec2#UserBucket", + "traits": { + "smithy.api#documentation": "

The S3 bucket for the disk image.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the disk container object for an import image task.

" + } + }, + "com.amazonaws.ec2#ImageDiskContainerList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ImageDiskContainer", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ImageId": { + "type": "string" + }, + "com.amazonaws.ec2#ImageIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ImageIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#xmlName": "ImageId" + } + } + }, + "com.amazonaws.ec2#ImageList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Image", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ImageMetadata": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the AMI.

", + "smithy.api#xmlName": "imageId" + } + }, + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Name", + "smithy.api#documentation": "

The name of the AMI.

", + "smithy.api#xmlName": "name" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImageOwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the AMI.

", + "smithy.api#xmlName": "imageOwnerId" + } + }, + "State": { + "target": "com.amazonaws.ec2#ImageState", + "traits": { + "aws.protocols#ec2QueryName": "ImageState", + "smithy.api#documentation": "

The current state of the AMI. If the state is available, the AMI is\n successfully registered and can be used to launch an instance.

", + "smithy.api#xmlName": "imageState" + } + }, + "ImageOwnerAlias": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImageOwnerAlias", + "smithy.api#documentation": "

The alias of the AMI owner.

\n

Valid values: amazon | aws-backup-vault |\n aws-marketplace\n

", + "smithy.api#xmlName": "imageOwnerAlias" + } + }, + "CreationDate": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CreationDate", + "smithy.api#documentation": "

The date and time the AMI was created.

", + "smithy.api#xmlName": "creationDate" + } + }, + "DeprecationTime": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DeprecationTime", + "smithy.api#documentation": "

The deprecation date and time of the AMI, in UTC, in the following format:\n YYYY-MM-DDTHH:MM:SSZ.

", + "smithy.api#xmlName": "deprecationTime" + } + }, + "ImageAllowed": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "ImageAllowed", + "smithy.api#documentation": "

If true, the AMI satisfies the criteria for Allowed AMIs and can be\n discovered and used in the account. If false, the AMI can't be discovered or used\n in the account.

\n

For more information, see Control the discovery and use of AMIs in\n Amazon EC2 with Allowed AMIs in\n Amazon EC2 User Guide.

", + "smithy.api#xmlName": "imageAllowed" + } + }, + "IsPublic": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "IsPublic", + "smithy.api#documentation": "

Indicates whether the AMI has public launch permissions. A value of true\n means this AMI has public launch permissions, while false means it has only\n implicit (AMI owner) or explicit (shared with your account) launch permissions.

", + "smithy.api#xmlName": "isPublic" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the AMI.

" + } + }, + "com.amazonaws.ec2#ImageProvider": { + "type": "string" + }, + "com.amazonaws.ec2#ImageProviderList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ImageProvider", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ImageProviderRequest": { + "type": "string" + }, + "com.amazonaws.ec2#ImageProviderRequestList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ImageProviderRequest", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ImageRecycleBinInfo": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the AMI.

", + "smithy.api#xmlName": "imageId" + } + }, + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Name", + "smithy.api#documentation": "

The name of the AMI.

", + "smithy.api#xmlName": "name" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description of the AMI.

", + "smithy.api#xmlName": "description" + } + }, + "RecycleBinEnterTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "RecycleBinEnterTime", + "smithy.api#documentation": "

The date and time when the AMI entered the Recycle Bin.

", + "smithy.api#xmlName": "recycleBinEnterTime" + } + }, + "RecycleBinExitTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "RecycleBinExitTime", + "smithy.api#documentation": "

The date and time when the AMI is to be permanently deleted from the Recycle Bin.

", + "smithy.api#xmlName": "recycleBinExitTime" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an AMI that is currently in the Recycle Bin.

" + } + }, + "com.amazonaws.ec2#ImageRecycleBinInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ImageRecycleBinInfo", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ImageState": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "invalid": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "invalid" + } + }, + "deregistered": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deregistered" + } + }, + "transient": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "transient" + } + }, + "failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + }, + "error": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "error" + } + }, + "disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + } + } + }, + "com.amazonaws.ec2#ImageTypeValues": { + "type": "enum", + "members": { + "machine": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "machine" + } + }, + "kernel": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "kernel" + } + }, + "ramdisk": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ramdisk" + } + } + } + }, + "com.amazonaws.ec2#ImdsSupportValues": { + "type": "enum", + "members": { + "v2_0": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "v2.0" + } + } + } + }, + "com.amazonaws.ec2#ImportClientVpnClientCertificateRevocationList": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ImportClientVpnClientCertificateRevocationListRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ImportClientVpnClientCertificateRevocationListResult" + }, + "traits": { + "smithy.api#documentation": "

Uploads a client certificate revocation list to the specified Client VPN endpoint. Uploading a client certificate revocation list overwrites the existing client certificate revocation list.

\n

Uploading a client certificate revocation list resets existing client connections.

" + } + }, + "com.amazonaws.ec2#ImportClientVpnClientCertificateRevocationListRequest": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#ClientVpnEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Client VPN endpoint to which the client certificate revocation list applies.

", + "smithy.api#required": {} + } + }, + "CertificateRevocationList": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The client certificate revocation list file. For more information, see Generate a Client Certificate Revocation List in the\n\t\t\t\tClient VPN Administrator Guide.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ImportClientVpnClientCertificateRevocationListResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ImportImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ImportImageRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ImportImageResult" + }, + "traits": { + "smithy.api#documentation": "\n

To import your virtual machines (VMs) with a console-based experience, you can use the\n Import virtual machine images to Amazon Web Services template in the Migration Hub Orchestrator console. For more\n information, see the \n Migration Hub Orchestrator User Guide\n .

\n \n

Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI).

\n \n

Amazon Web Services VM Import/Export strongly recommends specifying a value for either the\n --license-type or --usage-operation parameter when you create a new\n VM Import task. This ensures your operating system is licensed appropriately and your billing is\n optimized.

\n \n

For more information, see Importing a \n VM as an image using VM Import/Export in the VM Import/Export User Guide.

" + } + }, + "com.amazonaws.ec2#ImportImageLicenseConfigurationRequest": { + "type": "structure", + "members": { + "LicenseConfigurationArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ARN of a license configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The request information of license configurations.

" + } + }, + "com.amazonaws.ec2#ImportImageLicenseConfigurationResponse": { + "type": "structure", + "members": { + "LicenseConfigurationArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LicenseConfigurationArn", + "smithy.api#documentation": "

The ARN of a license configuration.

", + "smithy.api#xmlName": "licenseConfigurationArn" + } + } + }, + "traits": { + "smithy.api#documentation": "

The response information for license configurations.

" + } + }, + "com.amazonaws.ec2#ImportImageLicenseSpecificationListRequest": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ImportImageLicenseConfigurationRequest", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ImportImageLicenseSpecificationListResponse": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ImportImageLicenseConfigurationResponse", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ImportImageRequest": { + "type": "structure", + "members": { + "Architecture": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The architecture of the virtual machine.

\n

Valid values: i386 | x86_64\n

" + } + }, + "ClientData": { + "target": "com.amazonaws.ec2#ClientData", + "traits": { + "smithy.api#documentation": "

The client-specific data.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to enable idempotency for VM import requests.

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description string for the import image task.

" + } + }, + "DiskContainers": { + "target": "com.amazonaws.ec2#ImageDiskContainerList", + "traits": { + "smithy.api#documentation": "

Information about the disk containers.

", + "smithy.api#xmlName": "DiskContainer" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Encrypted": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the destination AMI of the imported image should be encrypted. The default KMS key for EBS is used\n unless you specify a non-default KMS key using KmsKeyId. For more information, see Amazon EBS Encryption in the\n Amazon Elastic Compute Cloud User Guide.

" + } + }, + "Hypervisor": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The target hypervisor platform.

\n

Valid values: xen\n

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.ec2#KmsKeyId", + "traits": { + "smithy.api#documentation": "

An identifier for the symmetric KMS key to use when creating the\n encrypted AMI. This parameter is only required if you want to use a non-default KMS key; if this\n parameter is not specified, the default KMS key for EBS is used. If a KmsKeyId is\n specified, the Encrypted flag must also be set.

\n

The KMS key identifier may be provided in any of the following formats:

\n \n

Amazon Web Services parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even\n though you provided an invalid identifier. This action will eventually report failure.

\n

The specified KMS key must exist in the Region that the AMI is being copied to.

\n

Amazon EBS does not support asymmetric KMS keys.

" + } + }, + "LicenseType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The license type to be used for the Amazon Machine Image (AMI) after importing.

\n

Specify AWS to replace the source-system license with an Amazon Web Services\n license or BYOL to retain the source-system license. Leaving this parameter\n undefined is the same as choosing AWS when importing a Windows Server operating\n system, and the same as choosing BYOL when importing a Windows client operating\n system (such as Windows 10) or a Linux operating system.

\n

To use BYOL, you must have existing licenses with rights to use these licenses in a third party\n cloud, such as Amazon Web Services. For more information, see Prerequisites in the\n VM Import/Export User Guide.

" + } + }, + "Platform": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The operating system of the virtual machine. If you import a VM that is compatible with\n Unified Extensible Firmware Interface (UEFI) using an EBS snapshot, you must specify a value for\n the platform.

\n

Valid values: Windows | Linux\n

" + } + }, + "RoleName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the role to use when not using the default role, 'vmimport'.

" + } + }, + "LicenseSpecifications": { + "target": "com.amazonaws.ec2#ImportImageLicenseSpecificationListRequest", + "traits": { + "smithy.api#documentation": "

The ARNs of the license configurations.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the import image task during creation.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "UsageOperation": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The usage operation value. For more information, see Licensing options in the VM Import/Export User Guide.

" + } + }, + "BootMode": { + "target": "com.amazonaws.ec2#BootModeValues", + "traits": { + "smithy.api#documentation": "

The boot mode of the virtual machine.

\n \n

The uefi-preferred boot mode isn't supported for importing images. For more\n information, see Boot modes in\n the VM Import/Export User Guide.

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ImportImageResult": { + "type": "structure", + "members": { + "Architecture": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Architecture", + "smithy.api#documentation": "

The architecture of the virtual machine.

", + "smithy.api#xmlName": "architecture" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description of the import task.

", + "smithy.api#xmlName": "description" + } + }, + "Encrypted": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Encrypted", + "smithy.api#documentation": "

Indicates whether the AMI is encrypted.

", + "smithy.api#xmlName": "encrypted" + } + }, + "Hypervisor": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Hypervisor", + "smithy.api#documentation": "

The target hypervisor of the import task.

", + "smithy.api#xmlName": "hypervisor" + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the Amazon Machine Image (AMI) created by the import task.

", + "smithy.api#xmlName": "imageId" + } + }, + "ImportTaskId": { + "target": "com.amazonaws.ec2#ImportImageTaskId", + "traits": { + "aws.protocols#ec2QueryName": "ImportTaskId", + "smithy.api#documentation": "

The task ID of the import image task.

", + "smithy.api#xmlName": "importTaskId" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.ec2#KmsKeyId", + "traits": { + "aws.protocols#ec2QueryName": "KmsKeyId", + "smithy.api#documentation": "

The identifier for the symmetric KMS key that was used to create the encrypted AMI.

", + "smithy.api#xmlName": "kmsKeyId" + } + }, + "LicenseType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LicenseType", + "smithy.api#documentation": "

The license type of the virtual machine.

", + "smithy.api#xmlName": "licenseType" + } + }, + "Platform": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Platform", + "smithy.api#documentation": "

The operating system of the virtual machine.

", + "smithy.api#xmlName": "platform" + } + }, + "Progress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Progress", + "smithy.api#documentation": "

The progress of the task.

", + "smithy.api#xmlName": "progress" + } + }, + "SnapshotDetails": { + "target": "com.amazonaws.ec2#SnapshotDetailList", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotDetailSet", + "smithy.api#documentation": "

Information about the snapshots.

", + "smithy.api#xmlName": "snapshotDetailSet" + } + }, + "Status": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

A brief status of the task.

", + "smithy.api#xmlName": "status" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

A detailed status message of the import task.

", + "smithy.api#xmlName": "statusMessage" + } + }, + "LicenseSpecifications": { + "target": "com.amazonaws.ec2#ImportImageLicenseSpecificationListResponse", + "traits": { + "aws.protocols#ec2QueryName": "LicenseSpecifications", + "smithy.api#documentation": "

The ARNs of the license configurations.

", + "smithy.api#xmlName": "licenseSpecifications" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the import image task.

", + "smithy.api#xmlName": "tagSet" + } + }, + "UsageOperation": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "UsageOperation", + "smithy.api#documentation": "

The usage operation value.

", + "smithy.api#xmlName": "usageOperation" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ImportImageTask": { + "type": "structure", + "members": { + "Architecture": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Architecture", + "smithy.api#documentation": "

The architecture of the virtual machine.

\n

Valid values: i386 | x86_64 | arm64\n

", + "smithy.api#xmlName": "architecture" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description of the import task.

", + "smithy.api#xmlName": "description" + } + }, + "Encrypted": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Encrypted", + "smithy.api#documentation": "

Indicates whether the image is encrypted.

", + "smithy.api#xmlName": "encrypted" + } + }, + "Hypervisor": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Hypervisor", + "smithy.api#documentation": "

The target hypervisor for the import task.

\n

Valid values: xen\n

", + "smithy.api#xmlName": "hypervisor" + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the Amazon Machine Image (AMI) of the imported virtual machine.

", + "smithy.api#xmlName": "imageId" + } + }, + "ImportTaskId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImportTaskId", + "smithy.api#documentation": "

The ID of the import image task.

", + "smithy.api#xmlName": "importTaskId" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KmsKeyId", + "smithy.api#documentation": "

The identifier for the KMS key that was used to create the encrypted image.

", + "smithy.api#xmlName": "kmsKeyId" + } + }, + "LicenseType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LicenseType", + "smithy.api#documentation": "

The license type of the virtual machine.

", + "smithy.api#xmlName": "licenseType" + } + }, + "Platform": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Platform", + "smithy.api#documentation": "

The description string for the import image task.

", + "smithy.api#xmlName": "platform" + } + }, + "Progress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Progress", + "smithy.api#documentation": "

The percentage of progress of the import image task.

", + "smithy.api#xmlName": "progress" + } + }, + "SnapshotDetails": { + "target": "com.amazonaws.ec2#SnapshotDetailList", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotDetailSet", + "smithy.api#documentation": "

Information about the snapshots.

", + "smithy.api#xmlName": "snapshotDetailSet" + } + }, + "Status": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

A brief status for the import image task.

", + "smithy.api#xmlName": "status" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

A descriptive status message for the import image task.

", + "smithy.api#xmlName": "statusMessage" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags for the import image task.

", + "smithy.api#xmlName": "tagSet" + } + }, + "LicenseSpecifications": { + "target": "com.amazonaws.ec2#ImportImageLicenseSpecificationListResponse", + "traits": { + "aws.protocols#ec2QueryName": "LicenseSpecifications", + "smithy.api#documentation": "

The ARNs of the license configurations that are associated with the import image task.

", + "smithy.api#xmlName": "licenseSpecifications" + } + }, + "UsageOperation": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "UsageOperation", + "smithy.api#documentation": "

The usage operation value.

", + "smithy.api#xmlName": "usageOperation" + } + }, + "BootMode": { + "target": "com.amazonaws.ec2#BootModeValues", + "traits": { + "aws.protocols#ec2QueryName": "BootMode", + "smithy.api#documentation": "

The boot mode of the virtual machine.

", + "smithy.api#xmlName": "bootMode" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an import image task.

" + } + }, + "com.amazonaws.ec2#ImportImageTaskId": { + "type": "string" + }, + "com.amazonaws.ec2#ImportImageTaskList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ImportImageTask", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ImportInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ImportInstanceRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ImportInstanceResult" + }, + "traits": { + "smithy.api#documentation": "\n

We recommend that you use the \n ImportImage\n \n API instead. For more information, see Importing a VM as an image using VM\n Import/Export in the VM Import/Export User Guide.

\n \n

Creates an import instance task using metadata from the specified disk image.

\n

This API action supports only single-volume VMs. To import multi-volume VMs, use ImportImage\n instead.

\n

For information about the import manifest referenced by this API action, see VM Import Manifest.

\n

This API action is not supported by the Command Line Interface (CLI).

" + } + }, + "com.amazonaws.ec2#ImportInstanceLaunchSpecification": { + "type": "structure", + "members": { + "Architecture": { + "target": "com.amazonaws.ec2#ArchitectureValues", + "traits": { + "aws.protocols#ec2QueryName": "Architecture", + "smithy.api#documentation": "

The architecture of the instance.

", + "smithy.api#xmlName": "architecture" + } + }, + "GroupNames": { + "target": "com.amazonaws.ec2#SecurityGroupStringList", + "traits": { + "smithy.api#documentation": "

The security group names.

", + "smithy.api#xmlName": "GroupName" + } + }, + "GroupIds": { + "target": "com.amazonaws.ec2#SecurityGroupIdStringList", + "traits": { + "smithy.api#documentation": "

The security group IDs.

", + "smithy.api#xmlName": "GroupId" + } + }, + "AdditionalInfo": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AdditionalInfo", + "smithy.api#documentation": "

Reserved.

", + "smithy.api#xmlName": "additionalInfo" + } + }, + "UserData": { + "target": "com.amazonaws.ec2#UserData", + "traits": { + "aws.protocols#ec2QueryName": "UserData", + "smithy.api#documentation": "

The Base64-encoded user data to make available to the instance.

", + "smithy.api#xmlName": "userData" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type. For more information about the instance types that you can import, see Instance Types in the\n VM Import/Export User Guide.

", + "smithy.api#xmlName": "instanceType" + } + }, + "Placement": { + "target": "com.amazonaws.ec2#Placement", + "traits": { + "aws.protocols#ec2QueryName": "Placement", + "smithy.api#documentation": "

The placement information for the instance.

", + "smithy.api#xmlName": "placement" + } + }, + "Monitoring": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Monitoring", + "smithy.api#documentation": "

Indicates whether monitoring is enabled.

", + "smithy.api#xmlName": "monitoring" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

[EC2-VPC] The ID of the subnet in which to launch the instance.

", + "smithy.api#xmlName": "subnetId" + } + }, + "InstanceInitiatedShutdownBehavior": { + "target": "com.amazonaws.ec2#ShutdownBehavior", + "traits": { + "aws.protocols#ec2QueryName": "InstanceInitiatedShutdownBehavior", + "smithy.api#documentation": "

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the\n operating system command for system shutdown).

", + "smithy.api#xmlName": "instanceInitiatedShutdownBehavior" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddress", + "smithy.api#documentation": "

[EC2-VPC] An available IP address from the IP address range of the subnet.

", + "smithy.api#xmlName": "privateIpAddress" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the launch specification for VM import.

" + } + }, + "com.amazonaws.ec2#ImportInstanceRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description for the instance being imported.

", + "smithy.api#xmlName": "description" + } + }, + "LaunchSpecification": { + "target": "com.amazonaws.ec2#ImportInstanceLaunchSpecification", + "traits": { + "aws.protocols#ec2QueryName": "LaunchSpecification", + "smithy.api#documentation": "

The launch specification.

", + "smithy.api#xmlName": "launchSpecification" + } + }, + "DiskImages": { + "target": "com.amazonaws.ec2#DiskImageList", + "traits": { + "aws.protocols#ec2QueryName": "DiskImage", + "smithy.api#documentation": "

The disk image.

", + "smithy.api#xmlName": "diskImage" + } + }, + "Platform": { + "target": "com.amazonaws.ec2#PlatformValues", + "traits": { + "aws.protocols#ec2QueryName": "Platform", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The instance operating system.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "platform" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ImportInstanceResult": { + "type": "structure", + "members": { + "ConversionTask": { + "target": "com.amazonaws.ec2#ConversionTask", + "traits": { + "aws.protocols#ec2QueryName": "ConversionTask", + "smithy.api#documentation": "

Information about the conversion task.

", + "smithy.api#xmlName": "conversionTask" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ImportInstanceTaskDetails": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description of the task.

", + "smithy.api#xmlName": "description" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#xmlName": "instanceId" + } + }, + "Platform": { + "target": "com.amazonaws.ec2#PlatformValues", + "traits": { + "aws.protocols#ec2QueryName": "Platform", + "smithy.api#documentation": "

The instance operating system.

", + "smithy.api#xmlName": "platform" + } + }, + "Volumes": { + "target": "com.amazonaws.ec2#ImportInstanceVolumeDetailSet", + "traits": { + "aws.protocols#ec2QueryName": "Volumes", + "smithy.api#documentation": "

The volumes.

", + "smithy.api#xmlName": "volumes" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an import instance task.

" + } + }, + "com.amazonaws.ec2#ImportInstanceVolumeDetailItem": { + "type": "structure", + "members": { + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone where the resulting instance will reside.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "BytesConverted": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "BytesConverted", + "smithy.api#documentation": "

The number of bytes converted so far.

", + "smithy.api#xmlName": "bytesConverted" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description of the task.

", + "smithy.api#xmlName": "description" + } + }, + "Image": { + "target": "com.amazonaws.ec2#DiskImageDescription", + "traits": { + "aws.protocols#ec2QueryName": "Image", + "smithy.api#documentation": "

The image.

", + "smithy.api#xmlName": "image" + } + }, + "Status": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The status of the import of this particular disk image.

", + "smithy.api#xmlName": "status" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

The status information or errors related to the disk image.

", + "smithy.api#xmlName": "statusMessage" + } + }, + "Volume": { + "target": "com.amazonaws.ec2#DiskImageVolumeDescription", + "traits": { + "aws.protocols#ec2QueryName": "Volume", + "smithy.api#documentation": "

The volume.

", + "smithy.api#xmlName": "volume" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an import volume task.

" + } + }, + "com.amazonaws.ec2#ImportInstanceVolumeDetailSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ImportInstanceVolumeDetailItem", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ImportKeyPair": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ImportKeyPairRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ImportKeyPairResult" + }, + "traits": { + "smithy.api#documentation": "

Imports the public key from an RSA or ED25519 key pair that you created using a third-party tool. \n You give Amazon Web Services only the public key. The private key is never transferred between you and Amazon Web Services.

\n

For more information about the requirements for importing a key pair, see Create a key pair and import the public key to Amazon EC2 in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#ImportKeyPairRequest": { + "type": "structure", + "members": { + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the imported key pair.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "KeyName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KeyName", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A unique name for the key pair.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "keyName" + } + }, + "PublicKeyMaterial": { + "target": "com.amazonaws.ec2#Blob", + "traits": { + "aws.protocols#ec2QueryName": "PublicKeyMaterial", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The public key.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "publicKeyMaterial" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ImportKeyPairResult": { + "type": "structure", + "members": { + "KeyFingerprint": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KeyFingerprint", + "smithy.api#documentation": "", + "smithy.api#xmlName": "keyFingerprint" + } + }, + "KeyName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KeyName", + "smithy.api#documentation": "

The key pair name that you provided.

", + "smithy.api#xmlName": "keyName" + } + }, + "KeyPairId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KeyPairId", + "smithy.api#documentation": "

The ID of the resulting key pair.

", + "smithy.api#xmlName": "keyPairId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags applied to the imported key pair.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ImportManifestUrl": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.ec2#ImportSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ImportSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ImportSnapshotResult" + }, + "traits": { + "smithy.api#documentation": "

Imports a disk into an EBS snapshot.

\n

For more information, see Importing a disk as a snapshot using VM Import/Export in the \n VM Import/Export User Guide.

" + } + }, + "com.amazonaws.ec2#ImportSnapshotRequest": { + "type": "structure", + "members": { + "ClientData": { + "target": "com.amazonaws.ec2#ClientData", + "traits": { + "smithy.api#documentation": "

The client-specific data.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Token to enable idempotency for VM import requests.

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The description string for the import snapshot task.

" + } + }, + "DiskContainer": { + "target": "com.amazonaws.ec2#SnapshotDiskContainer", + "traits": { + "smithy.api#documentation": "

Information about the disk container.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Encrypted": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the destination snapshot of the imported image should be encrypted. The default KMS key for EBS is\n used unless you specify a non-default KMS key using KmsKeyId. For more information, see Amazon EBS Encryption in the\n Amazon Elastic Compute Cloud User Guide.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.ec2#KmsKeyId", + "traits": { + "smithy.api#documentation": "

An identifier for the symmetric KMS key to use when creating the\n encrypted snapshot. This parameter is only required if you want to use a non-default KMS key; if this\n parameter is not specified, the default KMS key for EBS is used. If a KmsKeyId is\n specified, the Encrypted flag must also be set.

\n

The KMS key identifier may be provided in any of the following formats:

\n \n

Amazon Web Services parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even\n though you provided an invalid identifier. This action will eventually report failure.

\n

The specified KMS key must exist in the Region that the snapshot is being copied to.

\n

Amazon EBS does not support asymmetric KMS keys.

" + } + }, + "RoleName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the role to use when not using the default role, 'vmimport'.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the import snapshot task during creation.

", + "smithy.api#xmlName": "TagSpecification" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ImportSnapshotResult": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description of the import snapshot task.

", + "smithy.api#xmlName": "description" + } + }, + "ImportTaskId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImportTaskId", + "smithy.api#documentation": "

The ID of the import snapshot task.

", + "smithy.api#xmlName": "importTaskId" + } + }, + "SnapshotTaskDetail": { + "target": "com.amazonaws.ec2#SnapshotTaskDetail", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotTaskDetail", + "smithy.api#documentation": "

Information about the import snapshot task.

", + "smithy.api#xmlName": "snapshotTaskDetail" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the import snapshot task.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ImportSnapshotTask": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description of the import snapshot task.

", + "smithy.api#xmlName": "description" + } + }, + "ImportTaskId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImportTaskId", + "smithy.api#documentation": "

The ID of the import snapshot task.

", + "smithy.api#xmlName": "importTaskId" + } + }, + "SnapshotTaskDetail": { + "target": "com.amazonaws.ec2#SnapshotTaskDetail", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotTaskDetail", + "smithy.api#documentation": "

Describes an import snapshot task.

", + "smithy.api#xmlName": "snapshotTaskDetail" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags for the import snapshot task.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an import snapshot task.

" + } + }, + "com.amazonaws.ec2#ImportSnapshotTaskId": { + "type": "string" + }, + "com.amazonaws.ec2#ImportSnapshotTaskIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ImportSnapshotTaskId", + "traits": { + "smithy.api#xmlName": "ImportTaskId" + } + } + }, + "com.amazonaws.ec2#ImportSnapshotTaskList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ImportSnapshotTask", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ImportTaskId": { + "type": "string" + }, + "com.amazonaws.ec2#ImportTaskIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ImportImageTaskId", + "traits": { + "smithy.api#xmlName": "ImportTaskId" + } + } + }, + "com.amazonaws.ec2#ImportVolume": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ImportVolumeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ImportVolumeResult" + }, + "traits": { + "smithy.api#documentation": "\n

This API action supports only single-volume VMs. To import multi-volume VMs, use \n ImportImage instead. To import a disk to a snapshot, use\n ImportSnapshot instead.

\n \n

Creates an import volume task using metadata from the specified disk image.

\n

For information about the import manifest referenced by this API action, see VM Import Manifest.

\n

This API action is not supported by the Command Line Interface (CLI).

" + } + }, + "com.amazonaws.ec2#ImportVolumeRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Availability Zone for the resulting EBS volume.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "availabilityZone" + } + }, + "Image": { + "target": "com.amazonaws.ec2#DiskImageDetail", + "traits": { + "aws.protocols#ec2QueryName": "Image", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The disk image.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "image" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description of the volume.

", + "smithy.api#xmlName": "description" + } + }, + "Volume": { + "target": "com.amazonaws.ec2#VolumeDetail", + "traits": { + "aws.protocols#ec2QueryName": "Volume", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The volume size.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "volume" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ImportVolumeResult": { + "type": "structure", + "members": { + "ConversionTask": { + "target": "com.amazonaws.ec2#ConversionTask", + "traits": { + "aws.protocols#ec2QueryName": "ConversionTask", + "smithy.api#documentation": "

Information about the conversion task.

", + "smithy.api#xmlName": "conversionTask" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ImportVolumeTaskDetails": { + "type": "structure", + "members": { + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone where the resulting volume will reside.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "BytesConverted": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "BytesConverted", + "smithy.api#documentation": "

The number of bytes converted so far.

", + "smithy.api#xmlName": "bytesConverted" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description you provided when starting the import volume task.

", + "smithy.api#xmlName": "description" + } + }, + "Image": { + "target": "com.amazonaws.ec2#DiskImageDescription", + "traits": { + "aws.protocols#ec2QueryName": "Image", + "smithy.api#documentation": "

The image.

", + "smithy.api#xmlName": "image" + } + }, + "Volume": { + "target": "com.amazonaws.ec2#DiskImageVolumeDescription", + "traits": { + "aws.protocols#ec2QueryName": "Volume", + "smithy.api#documentation": "

The volume.

", + "smithy.api#xmlName": "volume" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an import volume task.

" + } + }, + "com.amazonaws.ec2#InferenceAcceleratorInfo": { + "type": "structure", + "members": { + "Accelerators": { + "target": "com.amazonaws.ec2#InferenceDeviceInfoList", + "traits": { + "aws.protocols#ec2QueryName": "Accelerators", + "smithy.api#documentation": "

Describes the Inference accelerators for the instance type.

", + "smithy.api#xmlName": "accelerators" + } + }, + "TotalInferenceMemoryInMiB": { + "target": "com.amazonaws.ec2#totalInferenceMemory", + "traits": { + "aws.protocols#ec2QueryName": "TotalInferenceMemoryInMiB", + "smithy.api#documentation": "

The total size of the memory for the inference accelerators for the instance type, in\n MiB.

", + "smithy.api#xmlName": "totalInferenceMemoryInMiB" + } + } + }, + "traits": { + "smithy.api#documentation": "\n

Amazon Elastic Inference is no longer available.

\n \n

Describes the Inference accelerators for the instance type.

" + } + }, + "com.amazonaws.ec2#InferenceDeviceCount": { + "type": "integer" + }, + "com.amazonaws.ec2#InferenceDeviceInfo": { + "type": "structure", + "members": { + "Count": { + "target": "com.amazonaws.ec2#InferenceDeviceCount", + "traits": { + "aws.protocols#ec2QueryName": "Count", + "smithy.api#documentation": "

The number of Inference accelerators for the instance type.

", + "smithy.api#xmlName": "count" + } + }, + "Name": { + "target": "com.amazonaws.ec2#InferenceDeviceName", + "traits": { + "aws.protocols#ec2QueryName": "Name", + "smithy.api#documentation": "

The name of the Inference accelerator.

", + "smithy.api#xmlName": "name" + } + }, + "Manufacturer": { + "target": "com.amazonaws.ec2#InferenceDeviceManufacturerName", + "traits": { + "aws.protocols#ec2QueryName": "Manufacturer", + "smithy.api#documentation": "

The manufacturer of the Inference accelerator.

", + "smithy.api#xmlName": "manufacturer" + } + }, + "MemoryInfo": { + "target": "com.amazonaws.ec2#InferenceDeviceMemoryInfo", + "traits": { + "aws.protocols#ec2QueryName": "MemoryInfo", + "smithy.api#documentation": "

Describes the memory available to the inference accelerator.

", + "smithy.api#xmlName": "memoryInfo" + } + } + }, + "traits": { + "smithy.api#documentation": "\n

Amazon Elastic Inference is no longer available.

\n \n

Describes the Inference accelerators for the instance type.

" + } + }, + "com.amazonaws.ec2#InferenceDeviceInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InferenceDeviceInfo" + } + }, + "com.amazonaws.ec2#InferenceDeviceManufacturerName": { + "type": "string" + }, + "com.amazonaws.ec2#InferenceDeviceMemoryInfo": { + "type": "structure", + "members": { + "SizeInMiB": { + "target": "com.amazonaws.ec2#InferenceDeviceMemorySize", + "traits": { + "aws.protocols#ec2QueryName": "SizeInMiB", + "smithy.api#documentation": "

The size of the memory available to the inference accelerator, in MiB.

", + "smithy.api#xmlName": "sizeInMiB" + } + } + }, + "traits": { + "smithy.api#documentation": "\n

Amazon Elastic Inference is no longer available.

\n \n

Describes the memory available to the inference accelerator.

" + } + }, + "com.amazonaws.ec2#InferenceDeviceMemorySize": { + "type": "integer" + }, + "com.amazonaws.ec2#InferenceDeviceName": { + "type": "string" + }, + "com.amazonaws.ec2#InsideCidrBlocksStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Instance": { + "type": "structure", + "members": { + "Architecture": { + "target": "com.amazonaws.ec2#ArchitectureValues", + "traits": { + "aws.protocols#ec2QueryName": "Architecture", + "smithy.api#documentation": "

The architecture of the image.

", + "smithy.api#xmlName": "architecture" + } + }, + "BlockDeviceMappings": { + "target": "com.amazonaws.ec2#InstanceBlockDeviceMappingList", + "traits": { + "aws.protocols#ec2QueryName": "BlockDeviceMapping", + "smithy.api#documentation": "

Any block device mapping entries for the instance.

", + "smithy.api#xmlName": "blockDeviceMapping" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

The idempotency token you provided when you launched the instance, if\n applicable.

", + "smithy.api#xmlName": "clientToken" + } + }, + "EbsOptimized": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EbsOptimized", + "smithy.api#documentation": "

Indicates whether the instance is optimized for Amazon EBS I/O. This optimization\n provides dedicated throughput to Amazon EBS and an optimized configuration stack to\n provide optimal I/O performance. This optimization isn't available with all instance\n types. Additional usage charges apply when using an EBS Optimized instance.

", + "smithy.api#xmlName": "ebsOptimized" + } + }, + "EnaSupport": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EnaSupport", + "smithy.api#documentation": "

Specifies whether enhanced networking with ENA is enabled.

", + "smithy.api#xmlName": "enaSupport" + } + }, + "Hypervisor": { + "target": "com.amazonaws.ec2#HypervisorType", + "traits": { + "aws.protocols#ec2QueryName": "Hypervisor", + "smithy.api#documentation": "

The hypervisor type of the instance. The value xen is used for both Xen\n and Nitro hypervisors.

", + "smithy.api#xmlName": "hypervisor" + } + }, + "IamInstanceProfile": { + "target": "com.amazonaws.ec2#IamInstanceProfile", + "traits": { + "aws.protocols#ec2QueryName": "IamInstanceProfile", + "smithy.api#documentation": "

The IAM instance profile associated with the instance, if\n applicable.

", + "smithy.api#xmlName": "iamInstanceProfile" + } + }, + "InstanceLifecycle": { + "target": "com.amazonaws.ec2#InstanceLifecycleType", + "traits": { + "aws.protocols#ec2QueryName": "InstanceLifecycle", + "smithy.api#documentation": "

Indicates whether this is a Spot Instance or a Scheduled Instance.

", + "smithy.api#xmlName": "instanceLifecycle" + } + }, + "ElasticGpuAssociations": { + "target": "com.amazonaws.ec2#ElasticGpuAssociationList", + "traits": { + "aws.protocols#ec2QueryName": "ElasticGpuAssociationSet", + "smithy.api#documentation": "

Deprecated.

\n \n

Amazon Elastic Graphics reached end of life on January 8, 2024.

\n ", + "smithy.api#xmlName": "elasticGpuAssociationSet" + } + }, + "ElasticInferenceAcceleratorAssociations": { + "target": "com.amazonaws.ec2#ElasticInferenceAcceleratorAssociationList", + "traits": { + "aws.protocols#ec2QueryName": "ElasticInferenceAcceleratorAssociationSet", + "smithy.api#documentation": "

Deprecated

\n \n

Amazon Elastic Inference is no longer available.

\n ", + "smithy.api#xmlName": "elasticInferenceAcceleratorAssociationSet" + } + }, + "NetworkInterfaces": { + "target": "com.amazonaws.ec2#InstanceNetworkInterfaceList", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceSet", + "smithy.api#documentation": "

The network interfaces for the instance.

", + "smithy.api#xmlName": "networkInterfaceSet" + } + }, + "OutpostArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OutpostArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost.

", + "smithy.api#xmlName": "outpostArn" + } + }, + "RootDeviceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RootDeviceName", + "smithy.api#documentation": "

The device name of the root device volume (for example,\n /dev/sda1).

", + "smithy.api#xmlName": "rootDeviceName" + } + }, + "RootDeviceType": { + "target": "com.amazonaws.ec2#DeviceType", + "traits": { + "aws.protocols#ec2QueryName": "RootDeviceType", + "smithy.api#documentation": "

The root device type used by the AMI. The AMI can use an EBS volume or an instance\n store volume.

", + "smithy.api#xmlName": "rootDeviceType" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.ec2#GroupIdentifierList", + "traits": { + "aws.protocols#ec2QueryName": "GroupSet", + "smithy.api#documentation": "

The security groups for the instance.

", + "smithy.api#xmlName": "groupSet" + } + }, + "SourceDestCheck": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "SourceDestCheck", + "smithy.api#documentation": "

Indicates whether source/destination checking is enabled.

", + "smithy.api#xmlName": "sourceDestCheck" + } + }, + "SpotInstanceRequestId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SpotInstanceRequestId", + "smithy.api#documentation": "

If the request is a Spot Instance request, the ID of the request.

", + "smithy.api#xmlName": "spotInstanceRequestId" + } + }, + "SriovNetSupport": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SriovNetSupport", + "smithy.api#documentation": "

Specifies whether enhanced networking with the Intel 82599 Virtual Function interface\n is enabled.

", + "smithy.api#xmlName": "sriovNetSupport" + } + }, + "StateReason": { + "target": "com.amazonaws.ec2#StateReason", + "traits": { + "aws.protocols#ec2QueryName": "StateReason", + "smithy.api#documentation": "

The reason for the most recent state transition.

", + "smithy.api#xmlName": "stateReason" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the instance.

", + "smithy.api#xmlName": "tagSet" + } + }, + "VirtualizationType": { + "target": "com.amazonaws.ec2#VirtualizationType", + "traits": { + "aws.protocols#ec2QueryName": "VirtualizationType", + "smithy.api#documentation": "

The virtualization type of the instance.

", + "smithy.api#xmlName": "virtualizationType" + } + }, + "CpuOptions": { + "target": "com.amazonaws.ec2#CpuOptions", + "traits": { + "aws.protocols#ec2QueryName": "CpuOptions", + "smithy.api#documentation": "

The CPU options for the instance.

", + "smithy.api#xmlName": "cpuOptions" + } + }, + "CapacityReservationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationId", + "smithy.api#documentation": "

The ID of the Capacity Reservation.

", + "smithy.api#xmlName": "capacityReservationId" + } + }, + "CapacityReservationSpecification": { + "target": "com.amazonaws.ec2#CapacityReservationSpecificationResponse", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationSpecification", + "smithy.api#documentation": "

Information about the Capacity Reservation targeting option.

", + "smithy.api#xmlName": "capacityReservationSpecification" + } + }, + "HibernationOptions": { + "target": "com.amazonaws.ec2#HibernationOptions", + "traits": { + "aws.protocols#ec2QueryName": "HibernationOptions", + "smithy.api#documentation": "

Indicates whether the instance is enabled for hibernation.

", + "smithy.api#xmlName": "hibernationOptions" + } + }, + "Licenses": { + "target": "com.amazonaws.ec2#LicenseList", + "traits": { + "aws.protocols#ec2QueryName": "LicenseSet", + "smithy.api#documentation": "

The license configurations for the instance.

", + "smithy.api#xmlName": "licenseSet" + } + }, + "MetadataOptions": { + "target": "com.amazonaws.ec2#InstanceMetadataOptionsResponse", + "traits": { + "aws.protocols#ec2QueryName": "MetadataOptions", + "smithy.api#documentation": "

The metadata options for the instance.

", + "smithy.api#xmlName": "metadataOptions" + } + }, + "EnclaveOptions": { + "target": "com.amazonaws.ec2#EnclaveOptions", + "traits": { + "aws.protocols#ec2QueryName": "EnclaveOptions", + "smithy.api#documentation": "

Indicates whether the instance is enabled for Amazon Web Services Nitro\n Enclaves.

", + "smithy.api#xmlName": "enclaveOptions" + } + }, + "BootMode": { + "target": "com.amazonaws.ec2#BootModeValues", + "traits": { + "aws.protocols#ec2QueryName": "BootMode", + "smithy.api#documentation": "

The boot mode that was specified by the AMI. If the value is uefi-preferred, \n the AMI supports both UEFI and Legacy BIOS. The currentInstanceBootMode parameter \n is the boot mode that is used to boot the instance at launch or start.

\n \n

The operating system contained in the AMI must be configured to support the specified boot mode.

\n \n

For more information, see Boot modes in the\n Amazon EC2 User Guide.

", + "smithy.api#xmlName": "bootMode" + } + }, + "PlatformDetails": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PlatformDetails", + "smithy.api#documentation": "

The platform details value for the instance. For more information, see AMI\n billing information fields in the\n Amazon EC2 User Guide.

", + "smithy.api#xmlName": "platformDetails" + } + }, + "UsageOperation": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "UsageOperation", + "smithy.api#documentation": "

The usage operation value for the instance. For more information, see AMI\n billing information fields in the\n Amazon EC2 User Guide.

", + "smithy.api#xmlName": "usageOperation" + } + }, + "UsageOperationUpdateTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "UsageOperationUpdateTime", + "smithy.api#documentation": "

The time that the usage operation was last updated.

", + "smithy.api#xmlName": "usageOperationUpdateTime" + } + }, + "PrivateDnsNameOptions": { + "target": "com.amazonaws.ec2#PrivateDnsNameOptionsResponse", + "traits": { + "aws.protocols#ec2QueryName": "PrivateDnsNameOptions", + "smithy.api#documentation": "

The options for the instance hostname.

", + "smithy.api#xmlName": "privateDnsNameOptions" + } + }, + "Ipv6Address": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6Address", + "smithy.api#documentation": "

The IPv6 address assigned to the instance.

", + "smithy.api#xmlName": "ipv6Address" + } + }, + "TpmSupport": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TpmSupport", + "smithy.api#documentation": "

If the instance is configured for NitroTPM support, the value is v2.0.\n For more information, see NitroTPM in the\n Amazon EC2 User Guide.

", + "smithy.api#xmlName": "tpmSupport" + } + }, + "MaintenanceOptions": { + "target": "com.amazonaws.ec2#InstanceMaintenanceOptions", + "traits": { + "aws.protocols#ec2QueryName": "MaintenanceOptions", + "smithy.api#documentation": "

Provides information on the recovery and maintenance options of your instance.

", + "smithy.api#xmlName": "maintenanceOptions" + } + }, + "CurrentInstanceBootMode": { + "target": "com.amazonaws.ec2#InstanceBootModeValues", + "traits": { + "aws.protocols#ec2QueryName": "CurrentInstanceBootMode", + "smithy.api#documentation": "

The boot mode that is used to boot the instance at launch or start. For more information, see Boot modes in the\n Amazon EC2 User Guide.

", + "smithy.api#xmlName": "currentInstanceBootMode" + } + }, + "NetworkPerformanceOptions": { + "target": "com.amazonaws.ec2#InstanceNetworkPerformanceOptions", + "traits": { + "aws.protocols#ec2QueryName": "NetworkPerformanceOptions", + "smithy.api#documentation": "

Contains settings for the network performance options for your instance.

", + "smithy.api#xmlName": "networkPerformanceOptions" + } + }, + "Operator": { + "target": "com.amazonaws.ec2#OperatorResponse", + "traits": { + "aws.protocols#ec2QueryName": "Operator", + "smithy.api#documentation": "

The service provider that manages the instance.

", + "smithy.api#xmlName": "operator" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#xmlName": "instanceId" + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the AMI used to launch the instance.

", + "smithy.api#xmlName": "imageId" + } + }, + "State": { + "target": "com.amazonaws.ec2#InstanceState", + "traits": { + "aws.protocols#ec2QueryName": "InstanceState", + "smithy.api#documentation": "

The current state of the instance.

", + "smithy.api#xmlName": "instanceState" + } + }, + "PrivateDnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateDnsName", + "smithy.api#documentation": "

[IPv4 only] The private DNS hostname name assigned to the instance. This DNS hostname\n can only be used inside the Amazon EC2 network. This name is not available until the\n instance enters the running state.

\n

The Amazon-provided DNS server resolves Amazon-provided private DNS\n hostnames if you've enabled DNS resolution and DNS hostnames in your VPC. If you are not\n using the Amazon-provided DNS server in your VPC, your custom domain name servers must\n resolve the hostname as appropriate.

", + "smithy.api#xmlName": "privateDnsName" + } + }, + "PublicDnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DnsName", + "smithy.api#documentation": "

[IPv4 only] The public DNS name assigned to the instance. This name is not available\n until the instance enters the running state. This name is only\n available if you've enabled DNS hostnames for your VPC.

", + "smithy.api#xmlName": "dnsName" + } + }, + "StateTransitionReason": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Reason", + "smithy.api#documentation": "

The reason for the most recent state transition. This might be an empty string.

", + "smithy.api#xmlName": "reason" + } + }, + "KeyName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KeyName", + "smithy.api#documentation": "

The name of the key pair, if this instance was launched with an associated key\n pair.

", + "smithy.api#xmlName": "keyName" + } + }, + "AmiLaunchIndex": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "AmiLaunchIndex", + "smithy.api#documentation": "

The AMI launch index, which can be used to find this instance in the launch\n group.

", + "smithy.api#xmlName": "amiLaunchIndex" + } + }, + "ProductCodes": { + "target": "com.amazonaws.ec2#ProductCodeList", + "traits": { + "aws.protocols#ec2QueryName": "ProductCodes", + "smithy.api#documentation": "

The product codes attached to this instance, if applicable.

", + "smithy.api#xmlName": "productCodes" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type.

", + "smithy.api#xmlName": "instanceType" + } + }, + "LaunchTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTime", + "smithy.api#documentation": "

The time that the instance was last launched. To determine the time that instance was first launched,\n see the attachment time for the primary network interface.

", + "smithy.api#xmlName": "launchTime" + } + }, + "Placement": { + "target": "com.amazonaws.ec2#Placement", + "traits": { + "aws.protocols#ec2QueryName": "Placement", + "smithy.api#documentation": "

The location where the instance launched, if applicable.

", + "smithy.api#xmlName": "placement" + } + }, + "KernelId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KernelId", + "smithy.api#documentation": "

The kernel associated with this instance, if applicable.

", + "smithy.api#xmlName": "kernelId" + } + }, + "RamdiskId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RamdiskId", + "smithy.api#documentation": "

The RAM disk associated with this instance, if applicable.

", + "smithy.api#xmlName": "ramdiskId" + } + }, + "Platform": { + "target": "com.amazonaws.ec2#PlatformValues", + "traits": { + "aws.protocols#ec2QueryName": "Platform", + "smithy.api#documentation": "

The platform. This value is windows for Windows instances; otherwise, it is empty.

", + "smithy.api#xmlName": "platform" + } + }, + "Monitoring": { + "target": "com.amazonaws.ec2#Monitoring", + "traits": { + "aws.protocols#ec2QueryName": "Monitoring", + "smithy.api#documentation": "

The monitoring for the instance.

", + "smithy.api#xmlName": "monitoring" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet in which the instance is running.

", + "smithy.api#xmlName": "subnetId" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC in which the instance is running.

", + "smithy.api#xmlName": "vpcId" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddress", + "smithy.api#documentation": "

The private IPv4 address assigned to the instance.

", + "smithy.api#xmlName": "privateIpAddress" + } + }, + "PublicIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IpAddress", + "smithy.api#documentation": "

The public IPv4 address, or the Carrier IP address assigned to the instance, if\n applicable.

\n

A Carrier IP address only applies to an instance launched in a subnet associated with\n a Wavelength Zone.

", + "smithy.api#xmlName": "ipAddress" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an instance.

" + } + }, + "com.amazonaws.ec2#InstanceAttachmentEnaSrdSpecification": { + "type": "structure", + "members": { + "EnaSrdEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EnaSrdEnabled", + "smithy.api#documentation": "

Indicates whether ENA Express is enabled for the network interface.

", + "smithy.api#xmlName": "enaSrdEnabled" + } + }, + "EnaSrdUdpSpecification": { + "target": "com.amazonaws.ec2#InstanceAttachmentEnaSrdUdpSpecification", + "traits": { + "aws.protocols#ec2QueryName": "EnaSrdUdpSpecification", + "smithy.api#documentation": "

Configures ENA Express for UDP network traffic.

", + "smithy.api#xmlName": "enaSrdUdpSpecification" + } + } + }, + "traits": { + "smithy.api#documentation": "

ENA Express uses Amazon Web Services Scalable Reliable Datagram (SRD) technology to increase the \n\t\t\tmaximum bandwidth used per stream and minimize tail latency of network traffic between EC2 instances. \n\t\t\tWith ENA Express, you can communicate between two EC2 instances in the same subnet within the same \n\t\t\taccount, or in different accounts. Both sending and receiving instances must have ENA Express enabled.

\n

To improve the reliability of network packet delivery, ENA Express reorders network packets on the \n\t\t\treceiving end by default. However, some UDP-based applications are designed to handle network packets \n\t\t\tthat are out of order to reduce the overhead for packet delivery at the network layer. When ENA Express \n\t\t\tis enabled, you can specify whether UDP network traffic uses it.

" + } + }, + "com.amazonaws.ec2#InstanceAttachmentEnaSrdUdpSpecification": { + "type": "structure", + "members": { + "EnaSrdUdpEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EnaSrdUdpEnabled", + "smithy.api#documentation": "

Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, \n\t\t\tyou must first enable ENA Express.

", + "smithy.api#xmlName": "enaSrdUdpEnabled" + } + } + }, + "traits": { + "smithy.api#documentation": "

ENA Express is compatible with both TCP and UDP transport protocols. When it's enabled, TCP traffic \n\t\t\tautomatically uses it. However, some UDP-based applications are designed to handle network packets that are \n\t\t\tout of order, without a need for retransmission, such as live video broadcasting or other near-real-time \n\t\t\tapplications. For UDP traffic, you can specify whether to use ENA Express, based on your application \n\t\t\tenvironment needs.

" + } + }, + "com.amazonaws.ec2#InstanceAttribute": { + "type": "structure", + "members": { + "BlockDeviceMappings": { + "target": "com.amazonaws.ec2#InstanceBlockDeviceMappingList", + "traits": { + "aws.protocols#ec2QueryName": "BlockDeviceMapping", + "smithy.api#documentation": "

The block device mapping of the instance.

", + "smithy.api#xmlName": "blockDeviceMapping" + } + }, + "DisableApiTermination": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "aws.protocols#ec2QueryName": "DisableApiTermination", + "smithy.api#documentation": "

If the value is true, you can't terminate the instance through the Amazon\n EC2 console, CLI, or API; otherwise, you can.

", + "smithy.api#xmlName": "disableApiTermination" + } + }, + "EnaSupport": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "aws.protocols#ec2QueryName": "EnaSupport", + "smithy.api#documentation": "

Indicates whether enhanced networking with ENA is enabled.

", + "smithy.api#xmlName": "enaSupport" + } + }, + "EnclaveOptions": { + "target": "com.amazonaws.ec2#EnclaveOptions", + "traits": { + "aws.protocols#ec2QueryName": "EnclaveOptions", + "smithy.api#documentation": "

To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to\n true; otherwise, set it to false.

", + "smithy.api#xmlName": "enclaveOptions" + } + }, + "EbsOptimized": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "aws.protocols#ec2QueryName": "EbsOptimized", + "smithy.api#documentation": "

Indicates whether the instance is optimized for Amazon EBS I/O.

", + "smithy.api#xmlName": "ebsOptimized" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#xmlName": "instanceId" + } + }, + "InstanceInitiatedShutdownBehavior": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "InstanceInitiatedShutdownBehavior", + "smithy.api#documentation": "

Indicates whether an instance stops or terminates when you initiate shutdown from the\n instance (using the operating system command for system shutdown).

", + "smithy.api#xmlName": "instanceInitiatedShutdownBehavior" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type.

", + "smithy.api#xmlName": "instanceType" + } + }, + "KernelId": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "Kernel", + "smithy.api#documentation": "

The kernel ID.

", + "smithy.api#xmlName": "kernel" + } + }, + "ProductCodes": { + "target": "com.amazonaws.ec2#ProductCodeList", + "traits": { + "aws.protocols#ec2QueryName": "ProductCodes", + "smithy.api#documentation": "

A list of product codes.

", + "smithy.api#xmlName": "productCodes" + } + }, + "RamdiskId": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "Ramdisk", + "smithy.api#documentation": "

The RAM disk ID.

", + "smithy.api#xmlName": "ramdisk" + } + }, + "RootDeviceName": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "RootDeviceName", + "smithy.api#documentation": "

The device name of the root device volume (for example,\n /dev/sda1).

", + "smithy.api#xmlName": "rootDeviceName" + } + }, + "SourceDestCheck": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "aws.protocols#ec2QueryName": "SourceDestCheck", + "smithy.api#documentation": "

Enable or disable source/destination checks, which ensure that the instance is either\n the source or the destination of any traffic that it receives. If the value is\n true, source/destination checks are enabled; otherwise, they are\n disabled. The default value is true. You must disable source/destination\n checks if the instance runs services such as network address translation, routing, or\n firewalls.

", + "smithy.api#xmlName": "sourceDestCheck" + } + }, + "SriovNetSupport": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "SriovNetSupport", + "smithy.api#documentation": "

Indicates whether enhanced networking with the Intel 82599 Virtual Function interface\n is enabled.

", + "smithy.api#xmlName": "sriovNetSupport" + } + }, + "UserData": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "UserData", + "smithy.api#documentation": "

The user data.

", + "smithy.api#xmlName": "userData" + } + }, + "DisableApiStop": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "aws.protocols#ec2QueryName": "DisableApiStop", + "smithy.api#documentation": "

To enable the instance for Amazon Web Services Stop Protection, set this parameter to\n true; otherwise, set it to false.

", + "smithy.api#xmlName": "disableApiStop" + } + }, + "Groups": { + "target": "com.amazonaws.ec2#GroupIdentifierList", + "traits": { + "aws.protocols#ec2QueryName": "GroupSet", + "smithy.api#documentation": "

The security groups associated with the instance.

", + "smithy.api#xmlName": "groupSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an instance attribute.

" + } + }, + "com.amazonaws.ec2#InstanceAttributeName": { + "type": "enum", + "members": { + "instanceType": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "instanceType" + } + }, + "kernel": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "kernel" + } + }, + "ramdisk": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ramdisk" + } + }, + "userData": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "userData" + } + }, + "disableApiTermination": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disableApiTermination" + } + }, + "instanceInitiatedShutdownBehavior": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "instanceInitiatedShutdownBehavior" + } + }, + "rootDeviceName": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rootDeviceName" + } + }, + "blockDeviceMapping": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "blockDeviceMapping" + } + }, + "productCodes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "productCodes" + } + }, + "sourceDestCheck": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sourceDestCheck" + } + }, + "groupSet": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "groupSet" + } + }, + "ebsOptimized": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ebsOptimized" + } + }, + "sriovNetSupport": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sriovNetSupport" + } + }, + "enaSupport": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enaSupport" + } + }, + "enclaveOptions": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enclaveOptions" + } + }, + "disableApiStop": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disableApiStop" + } + } + } + }, + "com.amazonaws.ec2#InstanceAutoRecoveryState": { + "type": "enum", + "members": { + "disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + }, + "default": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "default" + } + } + } + }, + "com.amazonaws.ec2#InstanceBandwidthWeighting": { + "type": "enum", + "members": { + "DEFAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "default" + } + }, + "VPC_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vpc-1" + } + }, + "EBS_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ebs-1" + } + } + } + }, + "com.amazonaws.ec2#InstanceBlockDeviceMapping": { + "type": "structure", + "members": { + "DeviceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DeviceName", + "smithy.api#documentation": "

The device name (for example, /dev/sdh or xvdh).

", + "smithy.api#xmlName": "deviceName" + } + }, + "Ebs": { + "target": "com.amazonaws.ec2#EbsInstanceBlockDevice", + "traits": { + "aws.protocols#ec2QueryName": "Ebs", + "smithy.api#documentation": "

Parameters used to automatically set up EBS volumes when the instance is\n launched.

", + "smithy.api#xmlName": "ebs" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a block device mapping.

" + } + }, + "com.amazonaws.ec2#InstanceBlockDeviceMappingList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceBlockDeviceMapping", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceBlockDeviceMappingSpecification": { + "type": "structure", + "members": { + "DeviceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DeviceName", + "smithy.api#documentation": "

The device name (for example, /dev/sdh or xvdh).

", + "smithy.api#xmlName": "deviceName" + } + }, + "Ebs": { + "target": "com.amazonaws.ec2#EbsInstanceBlockDeviceSpecification", + "traits": { + "aws.protocols#ec2QueryName": "Ebs", + "smithy.api#documentation": "

Parameters used to automatically set up EBS volumes when the instance is\n launched.

", + "smithy.api#xmlName": "ebs" + } + }, + "VirtualName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VirtualName", + "smithy.api#documentation": "

The virtual device name.

", + "smithy.api#xmlName": "virtualName" + } + }, + "NoDevice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NoDevice", + "smithy.api#documentation": "

suppress the specified device included in the block device mapping.

", + "smithy.api#xmlName": "noDevice" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a block device mapping entry.

" + } + }, + "com.amazonaws.ec2#InstanceBlockDeviceMappingSpecificationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceBlockDeviceMappingSpecification", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceBootModeValues": { + "type": "enum", + "members": { + "legacy_bios": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "legacy-bios" + } + }, + "uefi": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "uefi" + } + } + } + }, + "com.amazonaws.ec2#InstanceCapacity": { + "type": "structure", + "members": { + "AvailableCapacity": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "AvailableCapacity", + "smithy.api#documentation": "

The number of instances that can be launched onto the Dedicated Host based on the\n host's available capacity.

", + "smithy.api#xmlName": "availableCapacity" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type supported by the Dedicated Host.

", + "smithy.api#xmlName": "instanceType" + } + }, + "TotalCapacity": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TotalCapacity", + "smithy.api#documentation": "

The total number of instances that can be launched onto the Dedicated Host if there\n are no instances running on it.

", + "smithy.api#xmlName": "totalCapacity" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the number of instances that can be launched onto the Dedicated\n Host.

" + } + }, + "com.amazonaws.ec2#InstanceConnectEndpointId": { + "type": "string" + }, + "com.amazonaws.ec2#InstanceConnectEndpointMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.ec2#InstanceConnectEndpointSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Ec2InstanceConnectEndpoint", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceCount": { + "type": "structure", + "members": { + "InstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "InstanceCount", + "smithy.api#documentation": "

The number of listed Reserved Instances in the state specified by the state.

", + "smithy.api#xmlName": "instanceCount" + } + }, + "State": { + "target": "com.amazonaws.ec2#ListingState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The states of the listed Reserved Instances.

", + "smithy.api#xmlName": "state" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Reserved Instance listing state.

" + } + }, + "com.amazonaws.ec2#InstanceCountList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceCount", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceCreditSpecification": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#xmlName": "instanceId" + } + }, + "CpuCredits": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CpuCredits", + "smithy.api#documentation": "

The credit option for CPU usage of the instance.

\n

Valid values: standard | unlimited\n

", + "smithy.api#xmlName": "cpuCredits" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the credit option for CPU usage of a burstable performance instance.

" + } + }, + "com.amazonaws.ec2#InstanceCreditSpecificationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceCreditSpecification", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceCreditSpecificationListRequest": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceCreditSpecificationRequest", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceCreditSpecificationRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#required": {} + } + }, + "CpuCredits": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The credit option for CPU usage of the instance.

\n

Valid values: standard | unlimited\n

\n

T3 instances with host tenancy do not support the unlimited\n CPU credit option.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the credit option for CPU usage of a burstable performance instance.

" + } + }, + "com.amazonaws.ec2#InstanceEventId": { + "type": "string" + }, + "com.amazonaws.ec2#InstanceEventWindow": { + "type": "structure", + "members": { + "InstanceEventWindowId": { + "target": "com.amazonaws.ec2#InstanceEventWindowId", + "traits": { + "aws.protocols#ec2QueryName": "InstanceEventWindowId", + "smithy.api#documentation": "

The ID of the event window.

", + "smithy.api#xmlName": "instanceEventWindowId" + } + }, + "TimeRanges": { + "target": "com.amazonaws.ec2#InstanceEventWindowTimeRangeList", + "traits": { + "aws.protocols#ec2QueryName": "TimeRangeSet", + "smithy.api#documentation": "

One or more time ranges defined for the event window.

", + "smithy.api#xmlName": "timeRangeSet" + } + }, + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Name", + "smithy.api#documentation": "

The name of the event window.

", + "smithy.api#xmlName": "name" + } + }, + "CronExpression": { + "target": "com.amazonaws.ec2#InstanceEventWindowCronExpression", + "traits": { + "aws.protocols#ec2QueryName": "CronExpression", + "smithy.api#documentation": "

The cron expression defined for the event window.

", + "smithy.api#xmlName": "cronExpression" + } + }, + "AssociationTarget": { + "target": "com.amazonaws.ec2#InstanceEventWindowAssociationTarget", + "traits": { + "aws.protocols#ec2QueryName": "AssociationTarget", + "smithy.api#documentation": "

One or more targets associated with the event window.

", + "smithy.api#xmlName": "associationTarget" + } + }, + "State": { + "target": "com.amazonaws.ec2#InstanceEventWindowState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of the event window.

", + "smithy.api#xmlName": "state" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The instance tags associated with the event window.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

The event window.

" + } + }, + "com.amazonaws.ec2#InstanceEventWindowAssociationRequest": { + "type": "structure", + "members": { + "InstanceIds": { + "target": "com.amazonaws.ec2#InstanceIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the instances to associate with the event window. If the instance is on a\n Dedicated Host, you can't specify the Instance ID parameter; you must use the Dedicated\n Host ID parameter.

", + "smithy.api#xmlName": "InstanceId" + } + }, + "InstanceTags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "smithy.api#documentation": "

The instance tags to associate with the event window. Any instances associated with the\n tags will be associated with the event window.

", + "smithy.api#xmlName": "InstanceTag" + } + }, + "DedicatedHostIds": { + "target": "com.amazonaws.ec2#DedicatedHostIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the Dedicated Hosts to associate with the event window.

", + "smithy.api#xmlName": "DedicatedHostId" + } + } + }, + "traits": { + "smithy.api#documentation": "

One or more targets associated with the specified event window. Only one\n type of target (instance ID, instance tag, or Dedicated Host ID)\n can be associated with an event window.

" + } + }, + "com.amazonaws.ec2#InstanceEventWindowAssociationTarget": { + "type": "structure", + "members": { + "InstanceIds": { + "target": "com.amazonaws.ec2#InstanceIdList", + "traits": { + "aws.protocols#ec2QueryName": "InstanceIdSet", + "smithy.api#documentation": "

The IDs of the instances associated with the event window.

", + "smithy.api#xmlName": "instanceIdSet" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The instance tags associated with the event window. Any instances associated with the tags\n will be associated with the event window.

", + "smithy.api#xmlName": "tagSet" + } + }, + "DedicatedHostIds": { + "target": "com.amazonaws.ec2#DedicatedHostIdList", + "traits": { + "aws.protocols#ec2QueryName": "DedicatedHostIdSet", + "smithy.api#documentation": "

The IDs of the Dedicated Hosts associated with the event window.

", + "smithy.api#xmlName": "dedicatedHostIdSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

One or more targets associated with the event window.

" + } + }, + "com.amazonaws.ec2#InstanceEventWindowCronExpression": { + "type": "string" + }, + "com.amazonaws.ec2#InstanceEventWindowDisassociationRequest": { + "type": "structure", + "members": { + "InstanceIds": { + "target": "com.amazonaws.ec2#InstanceIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the instances to disassociate from the event window.

", + "smithy.api#xmlName": "InstanceId" + } + }, + "InstanceTags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "smithy.api#documentation": "

The instance tags to disassociate from the event window. Any instances associated with\n the tags will be disassociated from the event window.

", + "smithy.api#xmlName": "InstanceTag" + } + }, + "DedicatedHostIds": { + "target": "com.amazonaws.ec2#DedicatedHostIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the Dedicated Hosts to disassociate from the event window.

", + "smithy.api#xmlName": "DedicatedHostId" + } + } + }, + "traits": { + "smithy.api#documentation": "

The targets to disassociate from the specified event window.

" + } + }, + "com.amazonaws.ec2#InstanceEventWindowId": { + "type": "string" + }, + "com.amazonaws.ec2#InstanceEventWindowIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceEventWindowId", + "traits": { + "smithy.api#xmlName": "InstanceEventWindowId" + } + } + }, + "com.amazonaws.ec2#InstanceEventWindowSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceEventWindow", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceEventWindowState": { + "type": "enum", + "members": { + "creating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "creating" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + }, + "active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted" + } + } + } + }, + "com.amazonaws.ec2#InstanceEventWindowStateChange": { + "type": "structure", + "members": { + "InstanceEventWindowId": { + "target": "com.amazonaws.ec2#InstanceEventWindowId", + "traits": { + "aws.protocols#ec2QueryName": "InstanceEventWindowId", + "smithy.api#documentation": "

The ID of the event window.

", + "smithy.api#xmlName": "instanceEventWindowId" + } + }, + "State": { + "target": "com.amazonaws.ec2#InstanceEventWindowState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of the event window.

", + "smithy.api#xmlName": "state" + } + } + }, + "traits": { + "smithy.api#documentation": "

The state of the event window.

" + } + }, + "com.amazonaws.ec2#InstanceEventWindowTimeRange": { + "type": "structure", + "members": { + "StartWeekDay": { + "target": "com.amazonaws.ec2#WeekDay", + "traits": { + "aws.protocols#ec2QueryName": "StartWeekDay", + "smithy.api#documentation": "

The day on which the time range begins.

", + "smithy.api#xmlName": "startWeekDay" + } + }, + "StartHour": { + "target": "com.amazonaws.ec2#Hour", + "traits": { + "aws.protocols#ec2QueryName": "StartHour", + "smithy.api#documentation": "

The hour when the time range begins.

", + "smithy.api#xmlName": "startHour" + } + }, + "EndWeekDay": { + "target": "com.amazonaws.ec2#WeekDay", + "traits": { + "aws.protocols#ec2QueryName": "EndWeekDay", + "smithy.api#documentation": "

The day on which the time range ends.

", + "smithy.api#xmlName": "endWeekDay" + } + }, + "EndHour": { + "target": "com.amazonaws.ec2#Hour", + "traits": { + "aws.protocols#ec2QueryName": "EndHour", + "smithy.api#documentation": "

The hour when the time range ends.

", + "smithy.api#xmlName": "endHour" + } + } + }, + "traits": { + "smithy.api#documentation": "

The start day and time and the end day and time of the time range, in UTC.

" + } + }, + "com.amazonaws.ec2#InstanceEventWindowTimeRangeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceEventWindowTimeRange", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceEventWindowTimeRangeRequest": { + "type": "structure", + "members": { + "StartWeekDay": { + "target": "com.amazonaws.ec2#WeekDay", + "traits": { + "smithy.api#documentation": "

The day on which the time range begins.

" + } + }, + "StartHour": { + "target": "com.amazonaws.ec2#Hour", + "traits": { + "smithy.api#documentation": "

The hour when the time range begins.

" + } + }, + "EndWeekDay": { + "target": "com.amazonaws.ec2#WeekDay", + "traits": { + "smithy.api#documentation": "

The day on which the time range ends.

" + } + }, + "EndHour": { + "target": "com.amazonaws.ec2#Hour", + "traits": { + "smithy.api#documentation": "

The hour when the time range ends.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The start day and time and the end day and time of the time range, in UTC.

" + } + }, + "com.amazonaws.ec2#InstanceEventWindowTimeRangeRequestSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceEventWindowTimeRangeRequest" + } + }, + "com.amazonaws.ec2#InstanceExportDetails": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the resource being exported.

", + "smithy.api#xmlName": "instanceId" + } + }, + "TargetEnvironment": { + "target": "com.amazonaws.ec2#ExportEnvironment", + "traits": { + "aws.protocols#ec2QueryName": "TargetEnvironment", + "smithy.api#documentation": "

The target virtualization environment.

", + "smithy.api#xmlName": "targetEnvironment" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an instance to export.

" + } + }, + "com.amazonaws.ec2#InstanceFamilyCreditSpecification": { + "type": "structure", + "members": { + "InstanceFamily": { + "target": "com.amazonaws.ec2#UnlimitedSupportedInstanceFamily", + "traits": { + "aws.protocols#ec2QueryName": "InstanceFamily", + "smithy.api#documentation": "

The instance family.

", + "smithy.api#xmlName": "instanceFamily" + } + }, + "CpuCredits": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CpuCredits", + "smithy.api#documentation": "

The default credit option for CPU usage of the instance family. Valid values are\n standard and unlimited.

", + "smithy.api#xmlName": "cpuCredits" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the default credit option for CPU usage of a burstable performance instance\n family.

" + } + }, + "com.amazonaws.ec2#InstanceGeneration": { + "type": "enum", + "members": { + "CURRENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "current" + } + }, + "PREVIOUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "previous" + } + } + } + }, + "com.amazonaws.ec2#InstanceGenerationSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceGeneration", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceHealthStatus": { + "type": "enum", + "members": { + "HEALTHY_STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "healthy" + } + }, + "UNHEALTHY_STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unhealthy" + } + } + } + }, + "com.amazonaws.ec2#InstanceId": { + "type": "string" + }, + "com.amazonaws.ec2#InstanceIdForResolver": { + "type": "string" + }, + "com.amazonaws.ec2#InstanceIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#xmlName": "InstanceId" + } + } + }, + "com.amazonaws.ec2#InstanceIdWithVolumeResolver": { + "type": "string" + }, + "com.amazonaws.ec2#InstanceIdsSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceImageMetadata": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#xmlName": "instanceId" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type.

", + "smithy.api#xmlName": "instanceType" + } + }, + "LaunchTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTime", + "smithy.api#documentation": "

The time the instance was launched.

", + "smithy.api#xmlName": "launchTime" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone or Local Zone of the instance.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "ZoneId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ZoneId", + "smithy.api#documentation": "

The ID of the Availability Zone or Local Zone of the instance.

", + "smithy.api#xmlName": "zoneId" + } + }, + "State": { + "target": "com.amazonaws.ec2#InstanceState", + "traits": { + "aws.protocols#ec2QueryName": "InstanceState", + "smithy.api#documentation": "

The current state of the instance.

", + "smithy.api#xmlName": "instanceState" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceOwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the instance.

", + "smithy.api#xmlName": "instanceOwnerId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the instance.

", + "smithy.api#xmlName": "tagSet" + } + }, + "ImageMetadata": { + "target": "com.amazonaws.ec2#ImageMetadata", + "traits": { + "aws.protocols#ec2QueryName": "ImageMetadata", + "smithy.api#documentation": "

Information about the AMI used to launch the instance.

", + "smithy.api#xmlName": "imageMetadata" + } + }, + "Operator": { + "target": "com.amazonaws.ec2#OperatorResponse", + "traits": { + "aws.protocols#ec2QueryName": "Operator", + "smithy.api#documentation": "

The entity that manages the instance.

", + "smithy.api#xmlName": "operator" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the instance and the AMI used to launch the instance.

" + } + }, + "com.amazonaws.ec2#InstanceImageMetadataList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceImageMetadata", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceInterruptionBehavior": { + "type": "enum", + "members": { + "hibernate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hibernate" + } + }, + "stop": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "stop" + } + }, + "terminate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "terminate" + } + } + } + }, + "com.amazonaws.ec2#InstanceIpv4Prefix": { + "type": "structure", + "members": { + "Ipv4Prefix": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Ipv4Prefix", + "smithy.api#documentation": "

One or more IPv4 prefixes assigned to the network interface.

", + "smithy.api#xmlName": "ipv4Prefix" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an IPv4 prefix.

" + } + }, + "com.amazonaws.ec2#InstanceIpv4PrefixList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceIpv4Prefix", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceIpv6Address": { + "type": "structure", + "members": { + "Ipv6Address": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6Address", + "smithy.api#documentation": "

The IPv6 address.

", + "smithy.api#xmlName": "ipv6Address" + } + }, + "IsPrimaryIpv6": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "IsPrimaryIpv6", + "smithy.api#documentation": "

Determines if an IPv6 address associated with a network interface is the primary IPv6 address. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. \n For more information, see RunInstances.

", + "smithy.api#xmlName": "isPrimaryIpv6" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an IPv6 address.

" + } + }, + "com.amazonaws.ec2#InstanceIpv6AddressList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceIpv6Address", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceIpv6AddressListRequest": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceIpv6AddressRequest", + "traits": { + "smithy.api#xmlName": "InstanceIpv6Address" + } + } + }, + "com.amazonaws.ec2#InstanceIpv6AddressRequest": { + "type": "structure", + "members": { + "Ipv6Address": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IPv6 address.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an IPv6 address.

" + } + }, + "com.amazonaws.ec2#InstanceIpv6Prefix": { + "type": "structure", + "members": { + "Ipv6Prefix": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6Prefix", + "smithy.api#documentation": "

One or more IPv6 prefixes assigned to the network interface.

", + "smithy.api#xmlName": "ipv6Prefix" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an IPv6 prefix.

" + } + }, + "com.amazonaws.ec2#InstanceIpv6PrefixList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceIpv6Prefix", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceLifecycle": { + "type": "enum", + "members": { + "SPOT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "spot" + } + }, + "ON_DEMAND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "on-demand" + } + } + } + }, + "com.amazonaws.ec2#InstanceLifecycleType": { + "type": "enum", + "members": { + "spot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "spot" + } + }, + "scheduled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scheduled" + } + }, + "capacity_block": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "capacity-block" + } + } + } + }, + "com.amazonaws.ec2#InstanceList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Instance", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceMaintenanceOptions": { + "type": "structure", + "members": { + "AutoRecovery": { + "target": "com.amazonaws.ec2#InstanceAutoRecoveryState", + "traits": { + "aws.protocols#ec2QueryName": "AutoRecovery", + "smithy.api#documentation": "

Provides information on the current automatic recovery behavior of your\n instance.

", + "smithy.api#xmlName": "autoRecovery" + } + } + }, + "traits": { + "smithy.api#documentation": "

The maintenance options for the instance.

" + } + }, + "com.amazonaws.ec2#InstanceMaintenanceOptionsRequest": { + "type": "structure", + "members": { + "AutoRecovery": { + "target": "com.amazonaws.ec2#InstanceAutoRecoveryState", + "traits": { + "smithy.api#documentation": "

Disables the automatic recovery behavior of your instance or sets it to default. For\n more information, see Simplified automatic recovery.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The maintenance options for the instance.

" + } + }, + "com.amazonaws.ec2#InstanceMarketOptionsRequest": { + "type": "structure", + "members": { + "MarketType": { + "target": "com.amazonaws.ec2#MarketType", + "traits": { + "smithy.api#documentation": "

The market type.

" + } + }, + "SpotOptions": { + "target": "com.amazonaws.ec2#SpotMarketOptions", + "traits": { + "smithy.api#documentation": "

The options for Spot Instances.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the market (purchasing) option for the instances.

" + } + }, + "com.amazonaws.ec2#InstanceMatchCriteria": { + "type": "enum", + "members": { + "open": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "open" + } + }, + "targeted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "targeted" + } + } + } + }, + "com.amazonaws.ec2#InstanceMetadataDefaultsResponse": { + "type": "structure", + "members": { + "HttpTokens": { + "target": "com.amazonaws.ec2#HttpTokensState", + "traits": { + "aws.protocols#ec2QueryName": "HttpTokens", + "smithy.api#documentation": "

Indicates whether IMDSv2 is required.

\n ", + "smithy.api#xmlName": "httpTokens" + } + }, + "HttpPutResponseHopLimit": { + "target": "com.amazonaws.ec2#BoxedInteger", + "traits": { + "aws.protocols#ec2QueryName": "HttpPutResponseHopLimit", + "smithy.api#documentation": "

The maximum number of hops that the metadata token can travel.

", + "smithy.api#xmlName": "httpPutResponseHopLimit" + } + }, + "HttpEndpoint": { + "target": "com.amazonaws.ec2#InstanceMetadataEndpointState", + "traits": { + "aws.protocols#ec2QueryName": "HttpEndpoint", + "smithy.api#documentation": "

Indicates whether the IMDS endpoint for an instance is enabled or disabled. When disabled, the instance\n metadata can't be accessed.

", + "smithy.api#xmlName": "httpEndpoint" + } + }, + "InstanceMetadataTags": { + "target": "com.amazonaws.ec2#InstanceMetadataTagsState", + "traits": { + "aws.protocols#ec2QueryName": "InstanceMetadataTags", + "smithy.api#documentation": "

Indicates whether access to instance tags from the instance metadata is enabled or\n disabled. For more information, see Work with\n instance tags using the instance metadata in the\n Amazon EC2 User Guide.

", + "smithy.api#xmlName": "instanceMetadataTags" + } + }, + "ManagedBy": { + "target": "com.amazonaws.ec2#ManagedBy", + "traits": { + "aws.protocols#ec2QueryName": "ManagedBy", + "smithy.api#documentation": "

The entity that manages the IMDS default settings. Possible values include:

\n ", + "smithy.api#xmlName": "managedBy" + } + }, + "ManagedExceptionMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ManagedExceptionMessage", + "smithy.api#documentation": "

The customized exception message that is specified in the declarative policy.

", + "smithy.api#xmlName": "managedExceptionMessage" + } + } + }, + "traits": { + "smithy.api#documentation": "

The default instance metadata service (IMDS) settings that were set at the account\n level in the specified Amazon Web Services\u2028 Region.

" + } + }, + "com.amazonaws.ec2#InstanceMetadataEndpointState": { + "type": "enum", + "members": { + "disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + }, + "enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + } + } + }, + "com.amazonaws.ec2#InstanceMetadataOptionsRequest": { + "type": "structure", + "members": { + "HttpTokens": { + "target": "com.amazonaws.ec2#HttpTokensState", + "traits": { + "smithy.api#documentation": "

Indicates whether IMDSv2 is required.

\n \n

Default:

\n \n

The default value can also be affected by other combinations of parameters. For more\n information, see Order of precedence for instance metadata options in the\n Amazon EC2 User Guide.

" + } + }, + "HttpPutResponseHopLimit": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of hops that the metadata token can travel.

\n

Possible values: Integers from 1 to 64

" + } + }, + "HttpEndpoint": { + "target": "com.amazonaws.ec2#InstanceMetadataEndpointState", + "traits": { + "smithy.api#documentation": "

Enables or disables the HTTP metadata endpoint on your instances.

\n

If you specify a value of disabled, you cannot access your instance\n metadata.

\n

Default: enabled\n

" + } + }, + "HttpProtocolIpv6": { + "target": "com.amazonaws.ec2#InstanceMetadataProtocolState", + "traits": { + "smithy.api#documentation": "

Enables or disables the IPv6 endpoint for the instance metadata service.

\n

Default: disabled\n

" + } + }, + "InstanceMetadataTags": { + "target": "com.amazonaws.ec2#InstanceMetadataTagsState", + "traits": { + "smithy.api#documentation": "

Set to enabled to allow access to instance tags from the instance\n metadata. Set to disabled to turn off access to instance tags from the\n instance metadata. For more information, see Work with\n instance tags using the instance metadata.

\n

Default: disabled\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The metadata options for the instance.

" + } + }, + "com.amazonaws.ec2#InstanceMetadataOptionsResponse": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.ec2#InstanceMetadataOptionsState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the metadata option changes.

\n

\n pending - The metadata options are being updated and the instance is not\n ready to process metadata traffic with the new selection.

\n

\n applied - The metadata options have been successfully applied on the\n instance.

", + "smithy.api#xmlName": "state" + } + }, + "HttpTokens": { + "target": "com.amazonaws.ec2#HttpTokensState", + "traits": { + "aws.protocols#ec2QueryName": "HttpTokens", + "smithy.api#documentation": "

Indicates whether IMDSv2 is required.

\n ", + "smithy.api#xmlName": "httpTokens" + } + }, + "HttpPutResponseHopLimit": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "HttpPutResponseHopLimit", + "smithy.api#documentation": "

The maximum number of hops that the metadata token can travel.

\n

Possible values: Integers from 1 to 64\n

", + "smithy.api#xmlName": "httpPutResponseHopLimit" + } + }, + "HttpEndpoint": { + "target": "com.amazonaws.ec2#InstanceMetadataEndpointState", + "traits": { + "aws.protocols#ec2QueryName": "HttpEndpoint", + "smithy.api#documentation": "

Indicates whether the HTTP metadata endpoint on your instances is enabled or\n disabled.

\n

If the value is disabled, you cannot access your instance\n metadata.

", + "smithy.api#xmlName": "httpEndpoint" + } + }, + "HttpProtocolIpv6": { + "target": "com.amazonaws.ec2#InstanceMetadataProtocolState", + "traits": { + "aws.protocols#ec2QueryName": "HttpProtocolIpv6", + "smithy.api#documentation": "

Indicates whether the IPv6 endpoint for the instance metadata service is enabled or\n disabled.

\n

Default: disabled\n

", + "smithy.api#xmlName": "httpProtocolIpv6" + } + }, + "InstanceMetadataTags": { + "target": "com.amazonaws.ec2#InstanceMetadataTagsState", + "traits": { + "aws.protocols#ec2QueryName": "InstanceMetadataTags", + "smithy.api#documentation": "

Indicates whether access to instance tags from the instance metadata is enabled or\n disabled. For more information, see Work with\n instance tags using the instance metadata.

", + "smithy.api#xmlName": "instanceMetadataTags" + } + } + }, + "traits": { + "smithy.api#documentation": "

The metadata options for the instance.

" + } + }, + "com.amazonaws.ec2#InstanceMetadataOptionsState": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "applied": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "applied" + } + } + } + }, + "com.amazonaws.ec2#InstanceMetadataProtocolState": { + "type": "enum", + "members": { + "disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + }, + "enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + } + } + }, + "com.amazonaws.ec2#InstanceMetadataTagsState": { + "type": "enum", + "members": { + "disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + }, + "enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + } + } + }, + "com.amazonaws.ec2#InstanceMonitoring": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#xmlName": "instanceId" + } + }, + "Monitoring": { + "target": "com.amazonaws.ec2#Monitoring", + "traits": { + "aws.protocols#ec2QueryName": "Monitoring", + "smithy.api#documentation": "

The monitoring for the instance.

", + "smithy.api#xmlName": "monitoring" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the monitoring of an instance.

" + } + }, + "com.amazonaws.ec2#InstanceMonitoringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceMonitoring", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceNetworkInterface": { + "type": "structure", + "members": { + "Association": { + "target": "com.amazonaws.ec2#InstanceNetworkInterfaceAssociation", + "traits": { + "aws.protocols#ec2QueryName": "Association", + "smithy.api#documentation": "

The association information for an Elastic IPv4 associated with the network\n interface.

", + "smithy.api#xmlName": "association" + } + }, + "Attachment": { + "target": "com.amazonaws.ec2#InstanceNetworkInterfaceAttachment", + "traits": { + "aws.protocols#ec2QueryName": "Attachment", + "smithy.api#documentation": "

The network interface attachment.

", + "smithy.api#xmlName": "attachment" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description.

", + "smithy.api#xmlName": "description" + } + }, + "Groups": { + "target": "com.amazonaws.ec2#GroupIdentifierList", + "traits": { + "aws.protocols#ec2QueryName": "GroupSet", + "smithy.api#documentation": "

The security groups.

", + "smithy.api#xmlName": "groupSet" + } + }, + "Ipv6Addresses": { + "target": "com.amazonaws.ec2#InstanceIpv6AddressList", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6AddressesSet", + "smithy.api#documentation": "

The IPv6 addresses associated with the network interface.

", + "smithy.api#xmlName": "ipv6AddressesSet" + } + }, + "MacAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "MacAddress", + "smithy.api#documentation": "

The MAC address.

", + "smithy.api#xmlName": "macAddress" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that created the network interface.

", + "smithy.api#xmlName": "ownerId" + } + }, + "PrivateDnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateDnsName", + "smithy.api#documentation": "

The private DNS name.

", + "smithy.api#xmlName": "privateDnsName" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddress", + "smithy.api#documentation": "

The IPv4 address of the network interface within the subnet.

", + "smithy.api#xmlName": "privateIpAddress" + } + }, + "PrivateIpAddresses": { + "target": "com.amazonaws.ec2#InstancePrivateIpAddressList", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddressesSet", + "smithy.api#documentation": "

The private IPv4 addresses associated with the network interface.

", + "smithy.api#xmlName": "privateIpAddressesSet" + } + }, + "SourceDestCheck": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "SourceDestCheck", + "smithy.api#documentation": "

Indicates whether source/destination checking is enabled.

", + "smithy.api#xmlName": "sourceDestCheck" + } + }, + "Status": { + "target": "com.amazonaws.ec2#NetworkInterfaceStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The status of the network interface.

", + "smithy.api#xmlName": "status" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet.

", + "smithy.api#xmlName": "subnetId" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "vpcId" + } + }, + "InterfaceType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InterfaceType", + "smithy.api#documentation": "

The type of network interface.

\n

Valid values: interface | efa | efa-only | trunk\n

", + "smithy.api#xmlName": "interfaceType" + } + }, + "Ipv4Prefixes": { + "target": "com.amazonaws.ec2#InstanceIpv4PrefixList", + "traits": { + "aws.protocols#ec2QueryName": "Ipv4PrefixSet", + "smithy.api#documentation": "

The IPv4 delegated prefixes that are assigned to the network interface.

", + "smithy.api#xmlName": "ipv4PrefixSet" + } + }, + "Ipv6Prefixes": { + "target": "com.amazonaws.ec2#InstanceIpv6PrefixList", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6PrefixSet", + "smithy.api#documentation": "

The IPv6 delegated prefixes that are assigned to the network interface.

", + "smithy.api#xmlName": "ipv6PrefixSet" + } + }, + "ConnectionTrackingConfiguration": { + "target": "com.amazonaws.ec2#ConnectionTrackingSpecificationResponse", + "traits": { + "aws.protocols#ec2QueryName": "ConnectionTrackingConfiguration", + "smithy.api#documentation": "

A security group connection tracking configuration that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon EC2 User Guide.

", + "smithy.api#xmlName": "connectionTrackingConfiguration" + } + }, + "Operator": { + "target": "com.amazonaws.ec2#OperatorResponse", + "traits": { + "aws.protocols#ec2QueryName": "Operator", + "smithy.api#documentation": "

The service provider that manages the network interface.

", + "smithy.api#xmlName": "operator" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a network interface.

" + } + }, + "com.amazonaws.ec2#InstanceNetworkInterfaceAssociation": { + "type": "structure", + "members": { + "CarrierIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CarrierIp", + "smithy.api#documentation": "

The carrier IP address associated with the network interface.

", + "smithy.api#xmlName": "carrierIp" + } + }, + "CustomerOwnedIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CustomerOwnedIp", + "smithy.api#documentation": "

The customer-owned IP address associated with the network interface.

", + "smithy.api#xmlName": "customerOwnedIp" + } + }, + "IpOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IpOwnerId", + "smithy.api#documentation": "

The ID of the owner of the Elastic IP address.

", + "smithy.api#xmlName": "ipOwnerId" + } + }, + "PublicDnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicDnsName", + "smithy.api#documentation": "

The public DNS name.

", + "smithy.api#xmlName": "publicDnsName" + } + }, + "PublicIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicIp", + "smithy.api#documentation": "

The public IP address or Elastic IP address bound to the network interface.

", + "smithy.api#xmlName": "publicIp" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes association information for an Elastic IP address (IPv4).

" + } + }, + "com.amazonaws.ec2#InstanceNetworkInterfaceAttachment": { + "type": "structure", + "members": { + "AttachTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "AttachTime", + "smithy.api#documentation": "

The time stamp when the attachment initiated.

", + "smithy.api#xmlName": "attachTime" + } + }, + "AttachmentId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AttachmentId", + "smithy.api#documentation": "

The ID of the network interface attachment.

", + "smithy.api#xmlName": "attachmentId" + } + }, + "DeleteOnTermination": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DeleteOnTermination", + "smithy.api#documentation": "

Indicates whether the network interface is deleted when the instance is terminated.

", + "smithy.api#xmlName": "deleteOnTermination" + } + }, + "DeviceIndex": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "DeviceIndex", + "smithy.api#documentation": "

The index of the device on the instance for the network interface attachment.

", + "smithy.api#xmlName": "deviceIndex" + } + }, + "Status": { + "target": "com.amazonaws.ec2#AttachmentStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The attachment state.

", + "smithy.api#xmlName": "status" + } + }, + "NetworkCardIndex": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "NetworkCardIndex", + "smithy.api#documentation": "

The index of the network card.

", + "smithy.api#xmlName": "networkCardIndex" + } + }, + "EnaSrdSpecification": { + "target": "com.amazonaws.ec2#InstanceAttachmentEnaSrdSpecification", + "traits": { + "aws.protocols#ec2QueryName": "EnaSrdSpecification", + "smithy.api#documentation": "

Contains the ENA Express settings for the network interface that's attached \n\t\t\tto the instance.

", + "smithy.api#xmlName": "enaSrdSpecification" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a network interface attachment.

" + } + }, + "com.amazonaws.ec2#InstanceNetworkInterfaceList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceNetworkInterface", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceNetworkInterfaceSpecification": { + "type": "structure", + "members": { + "AssociatePublicIpAddress": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "AssociatePublicIpAddress", + "smithy.api#documentation": "

Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The\n public IP address can only be assigned to a network interface for eth0, and can only be\n assigned to a new network interface, not an existing one. You cannot specify more than one\n network interface in the request. If launching into a default subnet, the default value is\n true.

\n

Amazon Web Services charges for all public IPv4 addresses, including public IPv4 addresses \nassociated with running instances and Elastic IP addresses. For more information, see the Public IPv4 Address tab on the Amazon VPC pricing page.

", + "smithy.api#xmlName": "associatePublicIpAddress" + } + }, + "DeleteOnTermination": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DeleteOnTermination", + "smithy.api#documentation": "

If set to true, the interface is deleted when the instance is terminated. You can\n specify true only if creating a new network interface when launching an\n instance.

", + "smithy.api#xmlName": "deleteOnTermination" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description of the network interface. Applies only if creating a network interface when launching an instance.

", + "smithy.api#xmlName": "description" + } + }, + "DeviceIndex": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "DeviceIndex", + "smithy.api#documentation": "

The position of the network interface in the attachment order. \n A primary network interface has a device index of 0.

\n

If you specify a network interface when launching an instance, \n you must specify the device index.

", + "smithy.api#xmlName": "deviceIndex" + } + }, + "Groups": { + "target": "com.amazonaws.ec2#SecurityGroupIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.

", + "smithy.api#xmlName": "SecurityGroupId" + } + }, + "Ipv6AddressCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6AddressCount", + "smithy.api#documentation": "

A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses\n the IPv6 addresses from the range of the subnet. You cannot specify this option and the\n option to assign specific IPv6 addresses in the same request. You can specify this\n option if you've specified a minimum number of instances to launch.

", + "smithy.api#xmlName": "ipv6AddressCount" + } + }, + "Ipv6Addresses": { + "target": "com.amazonaws.ec2#InstanceIpv6AddressList", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6Addresses", + "smithy.api#documentation": "

The IPv6 addresses to assign to the network interface. You cannot specify\n this option and the option to assign a number of IPv6 addresses in the same request. You\n cannot specify this option if you've specified a minimum number of instances to\n launch.

", + "smithy.api#xmlName": "ipv6AddressesSet" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of the network interface.

\n

If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddress", + "smithy.api#documentation": "

The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching\n \tmore than one instance in a RunInstances request.

", + "smithy.api#xmlName": "privateIpAddress" + } + }, + "PrivateIpAddresses": { + "target": "com.amazonaws.ec2#PrivateIpAddressSpecificationList", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddresses", + "smithy.api#documentation": "

The private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're\n \tlaunching more than one instance in a RunInstances request.

", + "smithy.api#xmlName": "privateIpAddressesSet" + } + }, + "SecondaryPrivateIpAddressCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "SecondaryPrivateIpAddressCount", + "smithy.api#documentation": "

The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're\n \tlaunching more than one instance in a RunInstances request.

", + "smithy.api#xmlName": "secondaryPrivateIpAddressCount" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance.

", + "smithy.api#xmlName": "subnetId" + } + }, + "AssociateCarrierIpAddress": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether to assign a carrier IP address to the network interface.

\n

You can only assign a carrier IP address to a network interface that is in a subnet in\n a Wavelength Zone. For more information about carrier IP addresses, see Carrier IP address in the Amazon Web Services Wavelength Developer\n Guide.

" + } + }, + "InterfaceType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The type of network interface.

\n

If you specify efa-only, do not assign any IP addresses to the network \n\t interface. EFA-only network interfaces do not support IP addresses.

\n

Valid values: interface | efa | efa-only\n

" + } + }, + "NetworkCardIndex": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The index of the network card. Some instance types support multiple network cards. \n The primary network interface must be assigned to network card index 0. \n The default is network card index 0.

\n

If you are using RequestSpotInstances to create Spot Instances, omit this parameter because\n you can’t specify the network card index when using this API. To specify the network\n card index, use RunInstances.

" + } + }, + "Ipv4Prefixes": { + "target": "com.amazonaws.ec2#Ipv4PrefixList", + "traits": { + "smithy.api#documentation": "

The IPv4 delegated prefixes to be assigned to the network interface. You cannot \n use this option if you use the Ipv4PrefixCount option.

", + "smithy.api#xmlName": "Ipv4Prefix" + } + }, + "Ipv4PrefixCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The number of IPv4 delegated prefixes to be automatically assigned to the network interface. \n You cannot use this option if you use the Ipv4Prefix option.

" + } + }, + "Ipv6Prefixes": { + "target": "com.amazonaws.ec2#Ipv6PrefixList", + "traits": { + "smithy.api#documentation": "

The IPv6 delegated prefixes to be assigned to the network interface. You cannot \n use this option if you use the Ipv6PrefixCount option.

", + "smithy.api#xmlName": "Ipv6Prefix" + } + }, + "Ipv6PrefixCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The number of IPv6 delegated prefixes to be automatically assigned to the network interface. \n You cannot use this option if you use the Ipv6Prefix option.

" + } + }, + "PrimaryIpv6": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

The primary IPv6 address of the network interface. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information about primary IPv6 addresses, see RunInstances.

" + } + }, + "EnaSrdSpecification": { + "target": "com.amazonaws.ec2#EnaSrdSpecificationRequest", + "traits": { + "smithy.api#documentation": "

Specifies the ENA Express settings for the network interface that's attached to \n\t\t\tthe instance.

" + } + }, + "ConnectionTrackingSpecification": { + "target": "com.amazonaws.ec2#ConnectionTrackingSpecificationRequest", + "traits": { + "smithy.api#documentation": "

A security group connection tracking specification that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon EC2 User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a network interface.

" + } + }, + "com.amazonaws.ec2#InstanceNetworkInterfaceSpecificationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceNetworkInterfaceSpecification", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceNetworkPerformanceOptions": { + "type": "structure", + "members": { + "BandwidthWeighting": { + "target": "com.amazonaws.ec2#InstanceBandwidthWeighting", + "traits": { + "aws.protocols#ec2QueryName": "BandwidthWeighting", + "smithy.api#documentation": "

When you configure network bandwidth weighting, you can boost your baseline bandwidth for either \n \t\tnetworking or EBS by up to 25%. The total available baseline bandwidth for your instance remains \n \t\tthe same. The default option uses the standard bandwidth configuration for your instance type.

", + "smithy.api#xmlName": "bandwidthWeighting" + } + } + }, + "traits": { + "smithy.api#documentation": "

With network performance options, you can adjust your bandwidth preferences to meet \n \t\tthe needs of the workload that runs on your instance.

" + } + }, + "com.amazonaws.ec2#InstanceNetworkPerformanceOptionsRequest": { + "type": "structure", + "members": { + "BandwidthWeighting": { + "target": "com.amazonaws.ec2#InstanceBandwidthWeighting", + "traits": { + "smithy.api#documentation": "

Specify the bandwidth weighting option to boost the associated type of baseline bandwidth, \n \t\tas follows:

\n
\n
default
\n
\n

This option uses the standard bandwidth configuration for your instance type.

\n
\n
vpc-1
\n
\n

This option boosts your networking baseline bandwidth and reduces your EBS baseline \n \t\t\t\t\tbandwidth.

\n
\n
ebs-1
\n
\n

This option boosts your EBS baseline bandwidth and reduces your networking baseline \n \t\t\t\t\tbandwidth.

\n
\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configure network performance options for your instance that are geared towards performance \n \t\timprovements based on the workload that it runs.

" + } + }, + "com.amazonaws.ec2#InstancePrivateIpAddress": { + "type": "structure", + "members": { + "Association": { + "target": "com.amazonaws.ec2#InstanceNetworkInterfaceAssociation", + "traits": { + "aws.protocols#ec2QueryName": "Association", + "smithy.api#documentation": "

The association information for an Elastic IP address for the network interface.

", + "smithy.api#xmlName": "association" + } + }, + "Primary": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Primary", + "smithy.api#documentation": "

Indicates whether this IPv4 address is the primary private IP address of the network interface.

", + "smithy.api#xmlName": "primary" + } + }, + "PrivateDnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateDnsName", + "smithy.api#documentation": "

The private IPv4 DNS name.

", + "smithy.api#xmlName": "privateDnsName" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddress", + "smithy.api#documentation": "

The private IPv4 address of the network interface.

", + "smithy.api#xmlName": "privateIpAddress" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a private IPv4 address.

" + } + }, + "com.amazonaws.ec2#InstancePrivateIpAddressList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstancePrivateIpAddress", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceRequirements": { + "type": "structure", + "members": { + "VCpuCount": { + "target": "com.amazonaws.ec2#VCpuCountRange", + "traits": { + "aws.protocols#ec2QueryName": "VCpuCount", + "smithy.api#documentation": "

The minimum and maximum number of vCPUs.

", + "smithy.api#xmlName": "vCpuCount" + } + }, + "MemoryMiB": { + "target": "com.amazonaws.ec2#MemoryMiB", + "traits": { + "aws.protocols#ec2QueryName": "MemoryMiB", + "smithy.api#documentation": "

The minimum and maximum amount of memory, in MiB.

", + "smithy.api#xmlName": "memoryMiB" + } + }, + "CpuManufacturers": { + "target": "com.amazonaws.ec2#CpuManufacturerSet", + "traits": { + "aws.protocols#ec2QueryName": "CpuManufacturerSet", + "smithy.api#documentation": "

The CPU manufacturers to include.

\n \n \n

Don't confuse the CPU manufacturer with the CPU architecture. Instances will \n be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you \n specify in your launch template.

\n \n

Default: Any manufacturer

", + "smithy.api#xmlName": "cpuManufacturerSet" + } + }, + "MemoryGiBPerVCpu": { + "target": "com.amazonaws.ec2#MemoryGiBPerVCpu", + "traits": { + "aws.protocols#ec2QueryName": "MemoryGiBPerVCpu", + "smithy.api#documentation": "

The minimum and maximum amount of memory per vCPU, in GiB.

\n

Default: No minimum or maximum limits

", + "smithy.api#xmlName": "memoryGiBPerVCpu" + } + }, + "ExcludedInstanceTypes": { + "target": "com.amazonaws.ec2#ExcludedInstanceTypeSet", + "traits": { + "aws.protocols#ec2QueryName": "ExcludedInstanceTypeSet", + "smithy.api#documentation": "

The instance types to exclude.

\n

You can use strings with one or more wild cards, represented by\n an asterisk (*), to exclude an instance type, size, or generation. The\n following are examples: m5.8xlarge, c5*.*, m5a.*,\n r*, *3*.

\n

For example, if you specify c5*,Amazon EC2 will exclude the entire C5 instance\n family, which includes all C5a and C5n instance types. If you specify\n m5a.*, Amazon EC2 will exclude all the M5a instance types, but not the M5n\n instance types.

\n \n

If you specify ExcludedInstanceTypes, you can't specify AllowedInstanceTypes.

\n \n

Default: No excluded instance types

", + "smithy.api#xmlName": "excludedInstanceTypeSet" + } + }, + "InstanceGenerations": { + "target": "com.amazonaws.ec2#InstanceGenerationSet", + "traits": { + "aws.protocols#ec2QueryName": "InstanceGenerationSet", + "smithy.api#documentation": "

Indicates whether current or previous generation instance types are included. The\n current generation instance types are recommended for use. Current generation instance types are\n typically the latest two to three generations in each instance family. For more\n information, see Instance types in the\n Amazon EC2 User Guide.

\n

For current generation instance types, specify current.

\n

For previous generation instance types, specify previous.

\n

Default: Current and previous generation instance types

", + "smithy.api#xmlName": "instanceGenerationSet" + } + }, + "SpotMaxPricePercentageOverLowestPrice": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "SpotMaxPricePercentageOverLowestPrice", + "smithy.api#documentation": "

[Price protection] The price protection threshold for Spot Instances, as a percentage higher than\n an identified Spot price. The identified Spot price is the Spot price of the lowest priced\n current generation C, M, or R instance type with your specified attributes. If no current\n generation C, M, or R instance type matches your attributes, then the identified Spot price\n is from the lowest priced current generation instance types, and failing that, from the\n lowest priced previous generation instance types that match your attributes. When Amazon EC2\n selects instance types with your attributes, it will exclude instance types whose Spot\n price exceeds your specified threshold.

\n

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

\n

If you set TargetCapacityUnitType to vcpu or\n memory-mib, the price protection threshold is applied based on the per-vCPU\n or per-memory price instead of the per-instance price.

\n

This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.

\n \n

Only one of SpotMaxPricePercentageOverLowestPrice or\n MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you\n don't specify either, Amazon EC2 will automatically apply optimal price protection to\n consistently select from a wide range of instance types. To indicate no price protection\n threshold for Spot Instances, meaning you want to consider all instance types that match your\n attributes, include one of these parameters and specify a high value, such as\n 999999.

\n \n

Default: 100\n

", + "smithy.api#xmlName": "spotMaxPricePercentageOverLowestPrice" + } + }, + "OnDemandMaxPricePercentageOverLowestPrice": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "OnDemandMaxPricePercentageOverLowestPrice", + "smithy.api#documentation": "

[Price protection] The price protection threshold for On-Demand Instances, as a percentage higher\n than an identified On-Demand price. The identified On-Demand price is the price of the\n lowest priced current generation C, M, or R instance type with your specified attributes.\n When Amazon EC2 selects instance types with your attributes, it will exclude instance types\n whose price exceeds your specified threshold.

\n

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

\n

To turn off price protection, specify a high value, such as 999999.

\n

This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.

\n \n

If you set TargetCapacityUnitType to vcpu or\n memory-mib, the price protection threshold is applied based on the\n per-vCPU or per-memory price instead of the per-instance price.

\n \n

Default: 20\n

", + "smithy.api#xmlName": "onDemandMaxPricePercentageOverLowestPrice" + } + }, + "BareMetal": { + "target": "com.amazonaws.ec2#BareMetal", + "traits": { + "aws.protocols#ec2QueryName": "BareMetal", + "smithy.api#documentation": "

Indicates whether bare metal instance types must be included, excluded, or required.

\n \n

Default: excluded\n

", + "smithy.api#xmlName": "bareMetal" + } + }, + "BurstablePerformance": { + "target": "com.amazonaws.ec2#BurstablePerformance", + "traits": { + "aws.protocols#ec2QueryName": "BurstablePerformance", + "smithy.api#documentation": "

Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see \n Burstable performance instances.

\n \n

Default: excluded\n

", + "smithy.api#xmlName": "burstablePerformance" + } + }, + "RequireHibernateSupport": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "RequireHibernateSupport", + "smithy.api#documentation": "

Indicates whether instance types must support hibernation for On-Demand\n Instances.

\n

This parameter is not supported for GetSpotPlacementScores.

\n

Default: false\n

", + "smithy.api#xmlName": "requireHibernateSupport" + } + }, + "NetworkInterfaceCount": { + "target": "com.amazonaws.ec2#NetworkInterfaceCount", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceCount", + "smithy.api#documentation": "

The minimum and maximum number of network interfaces.

\n

Default: No minimum or maximum limits

", + "smithy.api#xmlName": "networkInterfaceCount" + } + }, + "LocalStorage": { + "target": "com.amazonaws.ec2#LocalStorage", + "traits": { + "aws.protocols#ec2QueryName": "LocalStorage", + "smithy.api#documentation": "

Indicates whether instance types with instance store volumes are included, excluded, or required. For more information,\n Amazon\n EC2 instance store in the Amazon EC2 User Guide.

\n \n

Default: included\n

", + "smithy.api#xmlName": "localStorage" + } + }, + "LocalStorageTypes": { + "target": "com.amazonaws.ec2#LocalStorageTypeSet", + "traits": { + "aws.protocols#ec2QueryName": "LocalStorageTypeSet", + "smithy.api#documentation": "

The type of local storage that is required.

\n \n

Default: hdd and ssd\n

", + "smithy.api#xmlName": "localStorageTypeSet" + } + }, + "TotalLocalStorageGB": { + "target": "com.amazonaws.ec2#TotalLocalStorageGB", + "traits": { + "aws.protocols#ec2QueryName": "TotalLocalStorageGB", + "smithy.api#documentation": "

The minimum and maximum amount of total local storage, in GB.

\n

Default: No minimum or maximum limits

", + "smithy.api#xmlName": "totalLocalStorageGB" + } + }, + "BaselineEbsBandwidthMbps": { + "target": "com.amazonaws.ec2#BaselineEbsBandwidthMbps", + "traits": { + "aws.protocols#ec2QueryName": "BaselineEbsBandwidthMbps", + "smithy.api#documentation": "

The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see\n Amazon\n EBS–optimized instances in the Amazon EC2 User Guide.

\n

Default: No minimum or maximum limits

", + "smithy.api#xmlName": "baselineEbsBandwidthMbps" + } + }, + "AcceleratorTypes": { + "target": "com.amazonaws.ec2#AcceleratorTypeSet", + "traits": { + "aws.protocols#ec2QueryName": "AcceleratorTypeSet", + "smithy.api#documentation": "

The accelerator types that must be on the instance type.

\n \n

Default: Any accelerator type

", + "smithy.api#xmlName": "acceleratorTypeSet" + } + }, + "AcceleratorCount": { + "target": "com.amazonaws.ec2#AcceleratorCount", + "traits": { + "aws.protocols#ec2QueryName": "AcceleratorCount", + "smithy.api#documentation": "

The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on\n an instance.

\n

To exclude accelerator-enabled instance types, set Max to 0.

\n

Default: No minimum or maximum limits

", + "smithy.api#xmlName": "acceleratorCount" + } + }, + "AcceleratorManufacturers": { + "target": "com.amazonaws.ec2#AcceleratorManufacturerSet", + "traits": { + "aws.protocols#ec2QueryName": "AcceleratorManufacturerSet", + "smithy.api#documentation": "

Indicates whether instance types must have accelerators by specific manufacturers.

\n \n

Default: Any manufacturer

", + "smithy.api#xmlName": "acceleratorManufacturerSet" + } + }, + "AcceleratorNames": { + "target": "com.amazonaws.ec2#AcceleratorNameSet", + "traits": { + "aws.protocols#ec2QueryName": "AcceleratorNameSet", + "smithy.api#documentation": "

The accelerators that must be on the instance type.

\n \n

Default: Any accelerator

", + "smithy.api#xmlName": "acceleratorNameSet" + } + }, + "AcceleratorTotalMemoryMiB": { + "target": "com.amazonaws.ec2#AcceleratorTotalMemoryMiB", + "traits": { + "aws.protocols#ec2QueryName": "AcceleratorTotalMemoryMiB", + "smithy.api#documentation": "

The minimum and maximum amount of total accelerator memory, in MiB.

\n

Default: No minimum or maximum limits

", + "smithy.api#xmlName": "acceleratorTotalMemoryMiB" + } + }, + "NetworkBandwidthGbps": { + "target": "com.amazonaws.ec2#NetworkBandwidthGbps", + "traits": { + "aws.protocols#ec2QueryName": "NetworkBandwidthGbps", + "smithy.api#documentation": "

The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).

\n

Default: No minimum or maximum limits

", + "smithy.api#xmlName": "networkBandwidthGbps" + } + }, + "AllowedInstanceTypes": { + "target": "com.amazonaws.ec2#AllowedInstanceTypeSet", + "traits": { + "aws.protocols#ec2QueryName": "AllowedInstanceTypeSet", + "smithy.api#documentation": "

The instance types to apply your specified attributes against. All other instance types \n are ignored, even if they match your specified attributes.

\n

You can use strings with one or more wild cards, represented by\n an asterisk (*), to allow an instance type, size, or generation. The\n following are examples: m5.8xlarge, c5*.*, m5a.*,\n r*, *3*.

\n

For example, if you specify c5*,Amazon EC2 will allow the entire C5 instance\n family, which includes all C5a and C5n instance types. If you specify\n m5a.*, Amazon EC2 will allow all the M5a instance types, but not the M5n\n instance types.

\n \n

If you specify AllowedInstanceTypes, you can't specify ExcludedInstanceTypes.

\n \n

Default: All instance types

", + "smithy.api#xmlName": "allowedInstanceTypeSet" + } + }, + "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice", + "smithy.api#documentation": "

[Price protection] The price protection threshold for Spot Instances, as a percentage of an\n identified On-Demand price. The identified On-Demand price is the price of the lowest\n priced current generation C, M, or R instance type with your specified attributes. If no\n current generation C, M, or R instance type matches your attributes, then the identified\n price is from the lowest priced current generation instance types, and failing that, from\n the lowest priced previous generation instance types that match your attributes. When Amazon EC2\n selects instance types with your attributes, it will exclude instance types whose price\n exceeds your specified threshold.

\n

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

\n

If you set TargetCapacityUnitType to vcpu or\n memory-mib, the price protection threshold is based on the per vCPU or per\n memory price instead of the per instance price.

\n \n

Only one of SpotMaxPricePercentageOverLowestPrice or\n MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you\n don't specify either, Amazon EC2 will automatically apply optimal price protection to\n consistently select from a wide range of instance types. To indicate no price protection\n threshold for Spot Instances, meaning you want to consider all instance types that match your\n attributes, include one of these parameters and specify a high value, such as\n 999999.

\n ", + "smithy.api#xmlName": "maxSpotPriceAsPercentageOfOptimalOnDemandPrice" + } + }, + "BaselinePerformanceFactors": { + "target": "com.amazonaws.ec2#BaselinePerformanceFactors", + "traits": { + "aws.protocols#ec2QueryName": "BaselinePerformanceFactors", + "smithy.api#documentation": "

The baseline performance to consider, using an instance family as a baseline reference.\n The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this\n baseline to guide instance type selection, but there is no guarantee that the selected\n instance types will always exceed the baseline for every application. Currently, this\n parameter only supports CPU performance as a baseline performance factor. For more\n information, see Performance protection in the Amazon EC2 User Guide.

", + "smithy.api#xmlName": "baselinePerformanceFactors" + } + } + }, + "traits": { + "smithy.api#documentation": "

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will\n identify instance types with these attributes.

\n

You must specify VCpuCount and MemoryMiB. All other attributes\n are optional. Any unspecified optional attribute is set to its default.

\n

When you specify multiple attributes, you get instance types that satisfy all of the\n specified attributes. If you specify multiple values for an attribute, you get instance\n types that satisfy any of the specified values.

\n

To limit the list of instance types from which Amazon EC2 can identify matching instance types, \n you can use one of the following parameters, but not both in the same request:

\n \n \n

If you specify InstanceRequirements, you can't specify\n InstanceType.

\n

Attribute-based instance type selection is only supported when using Auto Scaling\n groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in\n the launch instance\n wizard or with the RunInstances API, you\n can't specify InstanceRequirements.

\n \n

For more information, see Create mixed instances group using attribute-based instance type selection in\n the Amazon EC2 Auto Scaling User Guide, and also Specify attributes for instance type selection for EC2 Fleet or Spot Fleet and Spot\n placement score in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#InstanceRequirementsRequest": { + "type": "structure", + "members": { + "VCpuCount": { + "target": "com.amazonaws.ec2#VCpuCountRangeRequest", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The minimum and maximum number of vCPUs.

", + "smithy.api#required": {} + } + }, + "MemoryMiB": { + "target": "com.amazonaws.ec2#MemoryMiBRequest", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The minimum and maximum amount of memory, in MiB.

", + "smithy.api#required": {} + } + }, + "CpuManufacturers": { + "target": "com.amazonaws.ec2#CpuManufacturerSet", + "traits": { + "smithy.api#documentation": "

The CPU manufacturers to include.

\n \n \n

Don't confuse the CPU manufacturer with the CPU architecture. Instances will \n be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you \n specify in your launch template.

\n \n

Default: Any manufacturer

", + "smithy.api#xmlName": "CpuManufacturer" + } + }, + "MemoryGiBPerVCpu": { + "target": "com.amazonaws.ec2#MemoryGiBPerVCpuRequest", + "traits": { + "smithy.api#documentation": "

The minimum and maximum amount of memory per vCPU, in GiB.

\n

Default: No minimum or maximum limits

" + } + }, + "ExcludedInstanceTypes": { + "target": "com.amazonaws.ec2#ExcludedInstanceTypeSet", + "traits": { + "smithy.api#documentation": "

The instance types to exclude.

\n

You can use strings with one or more wild cards, represented by\n an asterisk (*), to exclude an instance family, type, size, or generation. The\n following are examples: m5.8xlarge, c5*.*, m5a.*,\n r*, *3*.

\n

For example, if you specify c5*,Amazon EC2 will exclude the entire C5 instance\n family, which includes all C5a and C5n instance types. If you specify\n m5a.*, Amazon EC2 will exclude all the M5a instance types, but not the M5n\n instance types.

\n \n

If you specify ExcludedInstanceTypes, you can't specify AllowedInstanceTypes.

\n \n

Default: No excluded instance types

", + "smithy.api#xmlName": "ExcludedInstanceType" + } + }, + "InstanceGenerations": { + "target": "com.amazonaws.ec2#InstanceGenerationSet", + "traits": { + "smithy.api#documentation": "

Indicates whether current or previous generation instance types are included. The\n current generation instance types are recommended for use. Current generation instance types are\n typically the latest two to three generations in each instance family. For more\n information, see Instance types in the\n Amazon EC2 User Guide.

\n

For current generation instance types, specify current.

\n

For previous generation instance types, specify previous.

\n

Default: Current and previous generation instance types

", + "smithy.api#xmlName": "InstanceGeneration" + } + }, + "SpotMaxPricePercentageOverLowestPrice": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

[Price protection] The price protection threshold for Spot Instances, as a percentage higher than\n an identified Spot price. The identified Spot price is the Spot price of the lowest priced\n current generation C, M, or R instance type with your specified attributes. If no current\n generation C, M, or R instance type matches your attributes, then the identified Spot price\n is from the lowest priced current generation instance types, and failing that, from the\n lowest priced previous generation instance types that match your attributes. When Amazon EC2\n selects instance types with your attributes, it will exclude instance types whose Spot\n price exceeds your specified threshold.

\n

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

\n

If you set TargetCapacityUnitType to vcpu or\n memory-mib, the price protection threshold is applied based on the\n per-vCPU or per-memory price instead of the per-instance price.

\n

This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.

\n \n

Only one of SpotMaxPricePercentageOverLowestPrice or\n MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you\n don't specify either, Amazon EC2 will automatically apply optimal price protection to\n consistently select from a wide range of instance types. To indicate no price protection\n threshold for Spot Instances, meaning you want to consider all instance types that match your\n attributes, include one of these parameters and specify a high value, such as\n 999999.

\n \n

Default: 100\n

" + } + }, + "OnDemandMaxPricePercentageOverLowestPrice": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

[Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than\n an identified On-Demand price. The identified On-Demand price is the price of the lowest\n priced current generation C, M, or R instance type with your specified attributes. When\n Amazon EC2 selects instance types with your attributes, it will exclude instance types whose\n price exceeds your specified threshold.

\n

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

\n

To indicate no price protection threshold, specify a high value, such as\n 999999.

\n

This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.

\n \n

If you set TargetCapacityUnitType to vcpu or\n memory-mib, the price protection threshold is applied based on the\n per-vCPU or per-memory price instead of the per-instance price.

\n \n

Default: 20\n

" + } + }, + "BareMetal": { + "target": "com.amazonaws.ec2#BareMetal", + "traits": { + "smithy.api#documentation": "

Indicates whether bare metal instance types must be included, excluded, or required.

\n \n

Default: excluded\n

" + } + }, + "BurstablePerformance": { + "target": "com.amazonaws.ec2#BurstablePerformance", + "traits": { + "smithy.api#documentation": "

Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see \n Burstable performance instances.

\n \n

Default: excluded\n

" + } + }, + "RequireHibernateSupport": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether instance types must support hibernation for On-Demand Instances.

\n

This parameter is not supported for GetSpotPlacementScores.

\n

Default: false\n

" + } + }, + "NetworkInterfaceCount": { + "target": "com.amazonaws.ec2#NetworkInterfaceCountRequest", + "traits": { + "smithy.api#documentation": "

The minimum and maximum number of network interfaces.

\n

Default: No minimum or maximum limits

" + } + }, + "LocalStorage": { + "target": "com.amazonaws.ec2#LocalStorage", + "traits": { + "smithy.api#documentation": "

Indicates whether instance types with instance store volumes are included, excluded, or required. For more information,\n Amazon\n EC2 instance store in the Amazon EC2 User Guide.

\n \n

Default: included\n

" + } + }, + "LocalStorageTypes": { + "target": "com.amazonaws.ec2#LocalStorageTypeSet", + "traits": { + "smithy.api#documentation": "

The type of local storage that is required.

\n \n

Default: hdd and ssd\n

", + "smithy.api#xmlName": "LocalStorageType" + } + }, + "TotalLocalStorageGB": { + "target": "com.amazonaws.ec2#TotalLocalStorageGBRequest", + "traits": { + "smithy.api#documentation": "

The minimum and maximum amount of total local storage, in GB.

\n

Default: No minimum or maximum limits

" + } + }, + "BaselineEbsBandwidthMbps": { + "target": "com.amazonaws.ec2#BaselineEbsBandwidthMbpsRequest", + "traits": { + "smithy.api#documentation": "

The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see\n Amazon\n EBS–optimized instances in the Amazon EC2 User Guide.

\n

Default: No minimum or maximum limits

" + } + }, + "AcceleratorTypes": { + "target": "com.amazonaws.ec2#AcceleratorTypeSet", + "traits": { + "smithy.api#documentation": "

The accelerator types that must be on the instance type.

\n \n

Default: Any accelerator type

", + "smithy.api#xmlName": "AcceleratorType" + } + }, + "AcceleratorCount": { + "target": "com.amazonaws.ec2#AcceleratorCountRequest", + "traits": { + "smithy.api#documentation": "

The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on\n an instance.

\n

To exclude accelerator-enabled instance types, set Max to 0.

\n

Default: No minimum or maximum limits

" + } + }, + "AcceleratorManufacturers": { + "target": "com.amazonaws.ec2#AcceleratorManufacturerSet", + "traits": { + "smithy.api#documentation": "

Indicates whether instance types must have accelerators by specific manufacturers.

\n \n

Default: Any manufacturer

", + "smithy.api#xmlName": "AcceleratorManufacturer" + } + }, + "AcceleratorNames": { + "target": "com.amazonaws.ec2#AcceleratorNameSet", + "traits": { + "smithy.api#documentation": "

The accelerators that must be on the instance type.

\n \n

Default: Any accelerator

", + "smithy.api#xmlName": "AcceleratorName" + } + }, + "AcceleratorTotalMemoryMiB": { + "target": "com.amazonaws.ec2#AcceleratorTotalMemoryMiBRequest", + "traits": { + "smithy.api#documentation": "

The minimum and maximum amount of total accelerator memory, in MiB.

\n

Default: No minimum or maximum limits

" + } + }, + "NetworkBandwidthGbps": { + "target": "com.amazonaws.ec2#NetworkBandwidthGbpsRequest", + "traits": { + "smithy.api#documentation": "

The minimum and maximum amount of baseline network bandwidth, in gigabits per second \n (Gbps). For more information, see Amazon EC2 instance network bandwidth in the Amazon EC2 User Guide.

\n

Default: No minimum or maximum limits

" + } + }, + "AllowedInstanceTypes": { + "target": "com.amazonaws.ec2#AllowedInstanceTypeSet", + "traits": { + "smithy.api#documentation": "

The instance types to apply your specified attributes against. All other instance types \n are ignored, even if they match your specified attributes.

\n

You can use strings with one or more wild cards, represented by\n an asterisk (*), to allow an instance type, size, or generation. The\n following are examples: m5.8xlarge, c5*.*, m5a.*,\n r*, *3*.

\n

For example, if you specify c5*,Amazon EC2 will allow the entire C5 instance\n family, which includes all C5a and C5n instance types. If you specify\n m5a.*, Amazon EC2 will allow all the M5a instance types, but not the M5n\n instance types.

\n \n

If you specify AllowedInstanceTypes, you can't specify ExcludedInstanceTypes.

\n \n

Default: All instance types

", + "smithy.api#xmlName": "AllowedInstanceType" + } + }, + "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

[Price protection] The price protection threshold for Spot Instances, as a percentage of an\n identified On-Demand price. The identified On-Demand price is the price of the lowest\n priced current generation C, M, or R instance type with your specified attributes. If no\n current generation C, M, or R instance type matches your attributes, then the identified\n price is from the lowest priced current generation instance types, and failing that, from\n the lowest priced previous generation instance types that match your attributes. When Amazon EC2\n selects instance types with your attributes, it will exclude instance types whose price\n exceeds your specified threshold.

\n

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

\n

If you set TargetCapacityUnitType to vcpu or\n memory-mib, the price protection threshold is based on the per vCPU or per\n memory price instead of the per instance price.

\n \n

Only one of SpotMaxPricePercentageOverLowestPrice or\n MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you\n don't specify either, Amazon EC2 will automatically apply optimal price protection to\n consistently select from a wide range of instance types. To indicate no price protection\n threshold for Spot Instances, meaning you want to consider all instance types that match your\n attributes, include one of these parameters and specify a high value, such as\n 999999.

\n " + } + }, + "BaselinePerformanceFactors": { + "target": "com.amazonaws.ec2#BaselinePerformanceFactorsRequest", + "traits": { + "smithy.api#documentation": "

The baseline performance to consider, using an instance family as a baseline reference.\n The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this\n baseline to guide instance type selection, but there is no guarantee that the selected\n instance types will always exceed the baseline for every application. Currently, this\n parameter only supports CPU performance as a baseline performance factor. For more\n information, see Performance protection in the Amazon EC2 User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will\n identify instance types with these attributes.

\n

You must specify VCpuCount and MemoryMiB. All other attributes\n are optional. Any unspecified optional attribute is set to its default.

\n

When you specify multiple attributes, you get instance types that satisfy all of the\n specified attributes. If you specify multiple values for an attribute, you get instance\n types that satisfy any of the specified values.

\n

To limit the list of instance types from which Amazon EC2 can identify matching instance types, \n you can use one of the following parameters, but not both in the same request:

\n \n \n

If you specify InstanceRequirements, you can't specify\n InstanceType.

\n

Attribute-based instance type selection is only supported when using Auto Scaling\n groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in\n the launch instance\n wizard, or with the RunInstances API or\n AWS::EC2::Instance Amazon Web Services CloudFormation resource, you can't specify\n InstanceRequirements.

\n \n

For more information, see Specify attributes for instance type selection for EC2 Fleet or Spot Fleet and Spot\n placement score in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#InstanceRequirementsWithMetadataRequest": { + "type": "structure", + "members": { + "ArchitectureTypes": { + "target": "com.amazonaws.ec2#ArchitectureTypeSet", + "traits": { + "smithy.api#documentation": "

The architecture type.

", + "smithy.api#xmlName": "ArchitectureType" + } + }, + "VirtualizationTypes": { + "target": "com.amazonaws.ec2#VirtualizationTypeSet", + "traits": { + "smithy.api#documentation": "

The virtualization type.

", + "smithy.api#xmlName": "VirtualizationType" + } + }, + "InstanceRequirements": { + "target": "com.amazonaws.ec2#InstanceRequirementsRequest", + "traits": { + "smithy.api#documentation": "

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will\n identify instance types with those attributes.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The architecture type, virtualization type, and other attributes for the instance types.\n When you specify instance attributes, Amazon EC2 will identify instance types with those\n attributes.

\n

If you specify InstanceRequirementsWithMetadataRequest, you can't specify\n InstanceTypes.

" + } + }, + "com.amazonaws.ec2#InstanceSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceTopology", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceSpecification": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceIdWithVolumeResolver", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The instance to specify which volumes should be snapshotted.

", + "smithy.api#required": {} + } + }, + "ExcludeBootVolume": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Excludes the root volume from being snapshotted.

" + } + }, + "ExcludeDataVolumeIds": { + "target": "com.amazonaws.ec2#VolumeIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the data (non-root) volumes to exclude from the multi-volume snapshot set. \n If you specify the ID of the root volume, the request fails. To exclude the root volume, \n use ExcludeBootVolume.

\n

You can specify up to 40 volume IDs per request.

", + "smithy.api#xmlName": "ExcludeDataVolumeId" + } + } + }, + "traits": { + "smithy.api#documentation": "

The instance details to specify which volumes should be snapshotted.

" + } + }, + "com.amazonaws.ec2#InstanceState": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The state of the instance as a 16-bit unsigned integer.

\n

The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values\n between 256 and 65,535. These numerical values are used for internal purposes and should\n be ignored.

\n

The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values\n between 0 and 255.

\n

The valid values for instance-state-code will all be in the range of the low byte and\n they are:

\n \n

You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in\n decimal.

", + "smithy.api#xmlName": "code" + } + }, + "Name": { + "target": "com.amazonaws.ec2#InstanceStateName", + "traits": { + "aws.protocols#ec2QueryName": "Name", + "smithy.api#documentation": "

The current state of the instance.

", + "smithy.api#xmlName": "name" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the current state of an instance.

" + } + }, + "com.amazonaws.ec2#InstanceStateChange": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#xmlName": "instanceId" + } + }, + "CurrentState": { + "target": "com.amazonaws.ec2#InstanceState", + "traits": { + "aws.protocols#ec2QueryName": "CurrentState", + "smithy.api#documentation": "

The current state of the instance.

", + "smithy.api#xmlName": "currentState" + } + }, + "PreviousState": { + "target": "com.amazonaws.ec2#InstanceState", + "traits": { + "aws.protocols#ec2QueryName": "PreviousState", + "smithy.api#documentation": "

The previous state of the instance.

", + "smithy.api#xmlName": "previousState" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an instance state change.

" + } + }, + "com.amazonaws.ec2#InstanceStateChangeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceStateChange", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceStateName": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "running": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "running" + } + }, + "shutting_down": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "shutting-down" + } + }, + "terminated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "terminated" + } + }, + "stopping": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "stopping" + } + }, + "stopped": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "stopped" + } + } + } + }, + "com.amazonaws.ec2#InstanceStatus": { + "type": "structure", + "members": { + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone of the instance.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "OutpostArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OutpostArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost.

", + "smithy.api#xmlName": "outpostArn" + } + }, + "Operator": { + "target": "com.amazonaws.ec2#OperatorResponse", + "traits": { + "aws.protocols#ec2QueryName": "Operator", + "smithy.api#documentation": "

The service provider that manages the instance.

", + "smithy.api#xmlName": "operator" + } + }, + "Events": { + "target": "com.amazonaws.ec2#InstanceStatusEventList", + "traits": { + "aws.protocols#ec2QueryName": "EventsSet", + "smithy.api#documentation": "

Any scheduled events associated with the instance.

", + "smithy.api#xmlName": "eventsSet" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#xmlName": "instanceId" + } + }, + "InstanceState": { + "target": "com.amazonaws.ec2#InstanceState", + "traits": { + "aws.protocols#ec2QueryName": "InstanceState", + "smithy.api#documentation": "

The intended state of the instance. DescribeInstanceStatus requires\n that an instance be in the running state.

", + "smithy.api#xmlName": "instanceState" + } + }, + "InstanceStatus": { + "target": "com.amazonaws.ec2#InstanceStatusSummary", + "traits": { + "aws.protocols#ec2QueryName": "InstanceStatus", + "smithy.api#documentation": "

Reports impaired functionality that stems from issues internal to the instance, such\n as impaired reachability.

", + "smithy.api#xmlName": "instanceStatus" + } + }, + "SystemStatus": { + "target": "com.amazonaws.ec2#InstanceStatusSummary", + "traits": { + "aws.protocols#ec2QueryName": "SystemStatus", + "smithy.api#documentation": "

Reports impaired functionality that stems from issues related to the systems that\n support an instance, such as hardware failures and network connectivity problems.

", + "smithy.api#xmlName": "systemStatus" + } + }, + "AttachedEbsStatus": { + "target": "com.amazonaws.ec2#EbsStatusSummary", + "traits": { + "aws.protocols#ec2QueryName": "AttachedEbsStatus", + "smithy.api#documentation": "

Reports impaired functionality that stems from an attached Amazon EBS volume that is \n unreachable and unable to complete I/O operations.

", + "smithy.api#xmlName": "attachedEbsStatus" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the status of an instance.

" + } + }, + "com.amazonaws.ec2#InstanceStatusDetails": { + "type": "structure", + "members": { + "ImpairedSince": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "ImpairedSince", + "smithy.api#documentation": "

The time when a status check failed. For an instance that was launched and impaired,\n this is the time when the instance was launched.

", + "smithy.api#xmlName": "impairedSince" + } + }, + "Name": { + "target": "com.amazonaws.ec2#StatusName", + "traits": { + "aws.protocols#ec2QueryName": "Name", + "smithy.api#documentation": "

The type of instance status.

", + "smithy.api#xmlName": "name" + } + }, + "Status": { + "target": "com.amazonaws.ec2#StatusType", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The status.

", + "smithy.api#xmlName": "status" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the instance status.

" + } + }, + "com.amazonaws.ec2#InstanceStatusDetailsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceStatusDetails", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceStatusEvent": { + "type": "structure", + "members": { + "InstanceEventId": { + "target": "com.amazonaws.ec2#InstanceEventId", + "traits": { + "aws.protocols#ec2QueryName": "InstanceEventId", + "smithy.api#documentation": "

The ID of the event.

", + "smithy.api#xmlName": "instanceEventId" + } + }, + "Code": { + "target": "com.amazonaws.ec2#EventCode", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The event code.

", + "smithy.api#xmlName": "code" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description of the event.

\n

After a scheduled event is completed, it can still be described for up to a week. If\n the event has been completed, this description starts with the following text:\n [Completed].

", + "smithy.api#xmlName": "description" + } + }, + "NotAfter": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "NotAfter", + "smithy.api#documentation": "

The latest scheduled end time for the event.

", + "smithy.api#xmlName": "notAfter" + } + }, + "NotBefore": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "NotBefore", + "smithy.api#documentation": "

The earliest scheduled start time for the event.

", + "smithy.api#xmlName": "notBefore" + } + }, + "NotBeforeDeadline": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "NotBeforeDeadline", + "smithy.api#documentation": "

The deadline for starting the event.

", + "smithy.api#xmlName": "notBeforeDeadline" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a scheduled event for an instance.

" + } + }, + "com.amazonaws.ec2#InstanceStatusEventList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceStatusEvent", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceStatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceStatus", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceStatusSummary": { + "type": "structure", + "members": { + "Details": { + "target": "com.amazonaws.ec2#InstanceStatusDetailsList", + "traits": { + "aws.protocols#ec2QueryName": "Details", + "smithy.api#documentation": "

The system instance health or application instance health.

", + "smithy.api#xmlName": "details" + } + }, + "Status": { + "target": "com.amazonaws.ec2#SummaryStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The status.

", + "smithy.api#xmlName": "status" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the status of an instance.

" + } + }, + "com.amazonaws.ec2#InstanceStorageEncryptionSupport": { + "type": "enum", + "members": { + "unsupported": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unsupported" + } + }, + "required": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "required" + } + } + } + }, + "com.amazonaws.ec2#InstanceStorageFlag": { + "type": "boolean" + }, + "com.amazonaws.ec2#InstanceStorageInfo": { + "type": "structure", + "members": { + "TotalSizeInGB": { + "target": "com.amazonaws.ec2#DiskSize", + "traits": { + "aws.protocols#ec2QueryName": "TotalSizeInGB", + "smithy.api#documentation": "

The total size of the disks, in GB.

", + "smithy.api#xmlName": "totalSizeInGB" + } + }, + "Disks": { + "target": "com.amazonaws.ec2#DiskInfoList", + "traits": { + "aws.protocols#ec2QueryName": "Disks", + "smithy.api#documentation": "

Describes the disks that are available for the instance type.

", + "smithy.api#xmlName": "disks" + } + }, + "NvmeSupport": { + "target": "com.amazonaws.ec2#EphemeralNvmeSupport", + "traits": { + "aws.protocols#ec2QueryName": "NvmeSupport", + "smithy.api#documentation": "

Indicates whether non-volatile memory express (NVMe) is supported.

", + "smithy.api#xmlName": "nvmeSupport" + } + }, + "EncryptionSupport": { + "target": "com.amazonaws.ec2#InstanceStorageEncryptionSupport", + "traits": { + "aws.protocols#ec2QueryName": "EncryptionSupport", + "smithy.api#documentation": "

Indicates whether data is encrypted at rest.

", + "smithy.api#xmlName": "encryptionSupport" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the instance store features that are supported by the instance type.

" + } + }, + "com.amazonaws.ec2#InstanceTagKeySet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceTagNotificationAttribute": { + "type": "structure", + "members": { + "InstanceTagKeys": { + "target": "com.amazonaws.ec2#InstanceTagKeySet", + "traits": { + "aws.protocols#ec2QueryName": "InstanceTagKeySet", + "smithy.api#documentation": "

The registered tag keys.

", + "smithy.api#xmlName": "instanceTagKeySet" + } + }, + "IncludeAllTagsOfInstance": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "IncludeAllTagsOfInstance", + "smithy.api#documentation": "

Indicates wheter all tag keys in the current Region are registered to appear in scheduled event notifications. \n \ttrue indicates that all tag keys in the current Region are registered.

", + "smithy.api#xmlName": "includeAllTagsOfInstance" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the registered tag keys for the current Region.

" + } + }, + "com.amazonaws.ec2#InstanceTopology": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The instance ID.

", + "smithy.api#xmlName": "instanceId" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type.

", + "smithy.api#xmlName": "instanceType" + } + }, + "GroupName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupName", + "smithy.api#documentation": "

The name of the placement group that the instance is in.

", + "smithy.api#xmlName": "groupName" + } + }, + "NetworkNodes": { + "target": "com.amazonaws.ec2#NetworkNodesList", + "traits": { + "aws.protocols#ec2QueryName": "NetworkNodeSet", + "smithy.api#documentation": "

The network nodes. The nodes are hashed based on your account. Instances from\n different accounts running under the same server will return a different hashed list of\n strings.

", + "smithy.api#xmlName": "networkNodeSet" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The name of the Availability Zone or Local Zone that the instance is in.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "ZoneId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ZoneId", + "smithy.api#documentation": "

The ID of the Availability Zone or Local Zone that the instance is in.

", + "smithy.api#xmlName": "zoneId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the instance topology.

" + } + }, + "com.amazonaws.ec2#InstanceType": { + "type": "enum", + "members": { + "a1_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "a1.medium" + } + }, + "a1_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "a1.large" + } + }, + "a1_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "a1.xlarge" + } + }, + "a1_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "a1.2xlarge" + } + }, + "a1_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "a1.4xlarge" + } + }, + "a1_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "a1.metal" + } + }, + "c1_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c1.medium" + } + }, + "c1_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c1.xlarge" + } + }, + "c3_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c3.large" + } + }, + "c3_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c3.xlarge" + } + }, + "c3_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c3.2xlarge" + } + }, + "c3_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c3.4xlarge" + } + }, + "c3_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c3.8xlarge" + } + }, + "c4_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c4.large" + } + }, + "c4_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c4.xlarge" + } + }, + "c4_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c4.2xlarge" + } + }, + "c4_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c4.4xlarge" + } + }, + "c4_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c4.8xlarge" + } + }, + "c5_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5.large" + } + }, + "c5_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5.xlarge" + } + }, + "c5_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5.2xlarge" + } + }, + "c5_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5.4xlarge" + } + }, + "c5_9xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5.9xlarge" + } + }, + "c5_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5.12xlarge" + } + }, + "c5_18xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5.18xlarge" + } + }, + "c5_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5.24xlarge" + } + }, + "c5_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5.metal" + } + }, + "c5a_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5a.large" + } + }, + "c5a_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5a.xlarge" + } + }, + "c5a_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5a.2xlarge" + } + }, + "c5a_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5a.4xlarge" + } + }, + "c5a_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5a.8xlarge" + } + }, + "c5a_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5a.12xlarge" + } + }, + "c5a_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5a.16xlarge" + } + }, + "c5a_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5a.24xlarge" + } + }, + "c5ad_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5ad.large" + } + }, + "c5ad_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5ad.xlarge" + } + }, + "c5ad_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5ad.2xlarge" + } + }, + "c5ad_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5ad.4xlarge" + } + }, + "c5ad_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5ad.8xlarge" + } + }, + "c5ad_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5ad.12xlarge" + } + }, + "c5ad_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5ad.16xlarge" + } + }, + "c5ad_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5ad.24xlarge" + } + }, + "c5d_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5d.large" + } + }, + "c5d_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5d.xlarge" + } + }, + "c5d_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5d.2xlarge" + } + }, + "c5d_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5d.4xlarge" + } + }, + "c5d_9xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5d.9xlarge" + } + }, + "c5d_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5d.12xlarge" + } + }, + "c5d_18xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5d.18xlarge" + } + }, + "c5d_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5d.24xlarge" + } + }, + "c5d_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5d.metal" + } + }, + "c5n_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5n.large" + } + }, + "c5n_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5n.xlarge" + } + }, + "c5n_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5n.2xlarge" + } + }, + "c5n_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5n.4xlarge" + } + }, + "c5n_9xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5n.9xlarge" + } + }, + "c5n_18xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5n.18xlarge" + } + }, + "c5n_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5n.metal" + } + }, + "c6g_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6g.medium" + } + }, + "c6g_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6g.large" + } + }, + "c6g_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6g.xlarge" + } + }, + "c6g_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6g.2xlarge" + } + }, + "c6g_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6g.4xlarge" + } + }, + "c6g_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6g.8xlarge" + } + }, + "c6g_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6g.12xlarge" + } + }, + "c6g_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6g.16xlarge" + } + }, + "c6g_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6g.metal" + } + }, + "c6gd_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6gd.medium" + } + }, + "c6gd_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6gd.large" + } + }, + "c6gd_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6gd.xlarge" + } + }, + "c6gd_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6gd.2xlarge" + } + }, + "c6gd_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6gd.4xlarge" + } + }, + "c6gd_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6gd.8xlarge" + } + }, + "c6gd_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6gd.12xlarge" + } + }, + "c6gd_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6gd.16xlarge" + } + }, + "c6gd_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6gd.metal" + } + }, + "c6gn_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6gn.medium" + } + }, + "c6gn_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6gn.large" + } + }, + "c6gn_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6gn.xlarge" + } + }, + "c6gn_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6gn.2xlarge" + } + }, + "c6gn_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6gn.4xlarge" + } + }, + "c6gn_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6gn.8xlarge" + } + }, + "c6gn_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6gn.12xlarge" + } + }, + "c6gn_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6gn.16xlarge" + } + }, + "c6i_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6i.large" + } + }, + "c6i_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6i.xlarge" + } + }, + "c6i_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6i.2xlarge" + } + }, + "c6i_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6i.4xlarge" + } + }, + "c6i_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6i.8xlarge" + } + }, + "c6i_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6i.12xlarge" + } + }, + "c6i_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6i.16xlarge" + } + }, + "c6i_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6i.24xlarge" + } + }, + "c6i_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6i.32xlarge" + } + }, + "c6i_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6i.metal" + } + }, + "cc1_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cc1.4xlarge" + } + }, + "cc2_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cc2.8xlarge" + } + }, + "cg1_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cg1.4xlarge" + } + }, + "cr1_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cr1.8xlarge" + } + }, + "d2_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "d2.xlarge" + } + }, + "d2_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "d2.2xlarge" + } + }, + "d2_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "d2.4xlarge" + } + }, + "d2_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "d2.8xlarge" + } + }, + "d3_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "d3.xlarge" + } + }, + "d3_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "d3.2xlarge" + } + }, + "d3_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "d3.4xlarge" + } + }, + "d3_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "d3.8xlarge" + } + }, + "d3en_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "d3en.xlarge" + } + }, + "d3en_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "d3en.2xlarge" + } + }, + "d3en_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "d3en.4xlarge" + } + }, + "d3en_6xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "d3en.6xlarge" + } + }, + "d3en_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "d3en.8xlarge" + } + }, + "d3en_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "d3en.12xlarge" + } + }, + "dl1_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dl1.24xlarge" + } + }, + "f1_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "f1.2xlarge" + } + }, + "f1_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "f1.4xlarge" + } + }, + "f1_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "f1.16xlarge" + } + }, + "g2_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g2.2xlarge" + } + }, + "g2_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g2.8xlarge" + } + }, + "g3_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g3.4xlarge" + } + }, + "g3_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g3.8xlarge" + } + }, + "g3_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g3.16xlarge" + } + }, + "g3s_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g3s.xlarge" + } + }, + "g4ad_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g4ad.xlarge" + } + }, + "g4ad_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g4ad.2xlarge" + } + }, + "g4ad_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g4ad.4xlarge" + } + }, + "g4ad_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g4ad.8xlarge" + } + }, + "g4ad_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g4ad.16xlarge" + } + }, + "g4dn_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g4dn.xlarge" + } + }, + "g4dn_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g4dn.2xlarge" + } + }, + "g4dn_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g4dn.4xlarge" + } + }, + "g4dn_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g4dn.8xlarge" + } + }, + "g4dn_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g4dn.12xlarge" + } + }, + "g4dn_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g4dn.16xlarge" + } + }, + "g4dn_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g4dn.metal" + } + }, + "g5_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g5.xlarge" + } + }, + "g5_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g5.2xlarge" + } + }, + "g5_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g5.4xlarge" + } + }, + "g5_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g5.8xlarge" + } + }, + "g5_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g5.12xlarge" + } + }, + "g5_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g5.16xlarge" + } + }, + "g5_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g5.24xlarge" + } + }, + "g5_48xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g5.48xlarge" + } + }, + "g5g_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g5g.xlarge" + } + }, + "g5g_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g5g.2xlarge" + } + }, + "g5g_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g5g.4xlarge" + } + }, + "g5g_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g5g.8xlarge" + } + }, + "g5g_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g5g.16xlarge" + } + }, + "g5g_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g5g.metal" + } + }, + "hi1_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hi1.4xlarge" + } + }, + "hpc6a_48xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hpc6a.48xlarge" + } + }, + "hs1_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hs1.8xlarge" + } + }, + "h1_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "h1.2xlarge" + } + }, + "h1_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "h1.4xlarge" + } + }, + "h1_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "h1.8xlarge" + } + }, + "h1_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "h1.16xlarge" + } + }, + "i2_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i2.xlarge" + } + }, + "i2_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i2.2xlarge" + } + }, + "i2_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i2.4xlarge" + } + }, + "i2_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i2.8xlarge" + } + }, + "i3_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i3.large" + } + }, + "i3_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i3.xlarge" + } + }, + "i3_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i3.2xlarge" + } + }, + "i3_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i3.4xlarge" + } + }, + "i3_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i3.8xlarge" + } + }, + "i3_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i3.16xlarge" + } + }, + "i3_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i3.metal" + } + }, + "i3en_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i3en.large" + } + }, + "i3en_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i3en.xlarge" + } + }, + "i3en_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i3en.2xlarge" + } + }, + "i3en_3xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i3en.3xlarge" + } + }, + "i3en_6xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i3en.6xlarge" + } + }, + "i3en_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i3en.12xlarge" + } + }, + "i3en_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i3en.24xlarge" + } + }, + "i3en_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i3en.metal" + } + }, + "im4gn_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "im4gn.large" + } + }, + "im4gn_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "im4gn.xlarge" + } + }, + "im4gn_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "im4gn.2xlarge" + } + }, + "im4gn_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "im4gn.4xlarge" + } + }, + "im4gn_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "im4gn.8xlarge" + } + }, + "im4gn_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "im4gn.16xlarge" + } + }, + "inf1_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "inf1.xlarge" + } + }, + "inf1_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "inf1.2xlarge" + } + }, + "inf1_6xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "inf1.6xlarge" + } + }, + "inf1_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "inf1.24xlarge" + } + }, + "is4gen_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "is4gen.medium" + } + }, + "is4gen_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "is4gen.large" + } + }, + "is4gen_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "is4gen.xlarge" + } + }, + "is4gen_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "is4gen.2xlarge" + } + }, + "is4gen_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "is4gen.4xlarge" + } + }, + "is4gen_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "is4gen.8xlarge" + } + }, + "m1_small": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m1.small" + } + }, + "m1_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m1.medium" + } + }, + "m1_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m1.large" + } + }, + "m1_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m1.xlarge" + } + }, + "m2_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m2.xlarge" + } + }, + "m2_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m2.2xlarge" + } + }, + "m2_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m2.4xlarge" + } + }, + "m3_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m3.medium" + } + }, + "m3_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m3.large" + } + }, + "m3_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m3.xlarge" + } + }, + "m3_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m3.2xlarge" + } + }, + "m4_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m4.large" + } + }, + "m4_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m4.xlarge" + } + }, + "m4_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m4.2xlarge" + } + }, + "m4_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m4.4xlarge" + } + }, + "m4_10xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m4.10xlarge" + } + }, + "m4_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m4.16xlarge" + } + }, + "m5_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5.large" + } + }, + "m5_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5.xlarge" + } + }, + "m5_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5.2xlarge" + } + }, + "m5_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5.4xlarge" + } + }, + "m5_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5.8xlarge" + } + }, + "m5_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5.12xlarge" + } + }, + "m5_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5.16xlarge" + } + }, + "m5_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5.24xlarge" + } + }, + "m5_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5.metal" + } + }, + "m5a_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5a.large" + } + }, + "m5a_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5a.xlarge" + } + }, + "m5a_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5a.2xlarge" + } + }, + "m5a_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5a.4xlarge" + } + }, + "m5a_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5a.8xlarge" + } + }, + "m5a_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5a.12xlarge" + } + }, + "m5a_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5a.16xlarge" + } + }, + "m5a_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5a.24xlarge" + } + }, + "m5ad_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5ad.large" + } + }, + "m5ad_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5ad.xlarge" + } + }, + "m5ad_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5ad.2xlarge" + } + }, + "m5ad_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5ad.4xlarge" + } + }, + "m5ad_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5ad.8xlarge" + } + }, + "m5ad_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5ad.12xlarge" + } + }, + "m5ad_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5ad.16xlarge" + } + }, + "m5ad_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5ad.24xlarge" + } + }, + "m5d_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5d.large" + } + }, + "m5d_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5d.xlarge" + } + }, + "m5d_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5d.2xlarge" + } + }, + "m5d_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5d.4xlarge" + } + }, + "m5d_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5d.8xlarge" + } + }, + "m5d_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5d.12xlarge" + } + }, + "m5d_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5d.16xlarge" + } + }, + "m5d_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5d.24xlarge" + } + }, + "m5d_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5d.metal" + } + }, + "m5dn_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5dn.large" + } + }, + "m5dn_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5dn.xlarge" + } + }, + "m5dn_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5dn.2xlarge" + } + }, + "m5dn_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5dn.4xlarge" + } + }, + "m5dn_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5dn.8xlarge" + } + }, + "m5dn_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5dn.12xlarge" + } + }, + "m5dn_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5dn.16xlarge" + } + }, + "m5dn_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5dn.24xlarge" + } + }, + "m5dn_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5dn.metal" + } + }, + "m5n_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5n.large" + } + }, + "m5n_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5n.xlarge" + } + }, + "m5n_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5n.2xlarge" + } + }, + "m5n_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5n.4xlarge" + } + }, + "m5n_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5n.8xlarge" + } + }, + "m5n_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5n.12xlarge" + } + }, + "m5n_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5n.16xlarge" + } + }, + "m5n_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5n.24xlarge" + } + }, + "m5n_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5n.metal" + } + }, + "m5zn_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5zn.large" + } + }, + "m5zn_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5zn.xlarge" + } + }, + "m5zn_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5zn.2xlarge" + } + }, + "m5zn_3xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5zn.3xlarge" + } + }, + "m5zn_6xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5zn.6xlarge" + } + }, + "m5zn_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5zn.12xlarge" + } + }, + "m5zn_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5zn.metal" + } + }, + "m6a_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6a.large" + } + }, + "m6a_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6a.xlarge" + } + }, + "m6a_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6a.2xlarge" + } + }, + "m6a_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6a.4xlarge" + } + }, + "m6a_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6a.8xlarge" + } + }, + "m6a_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6a.12xlarge" + } + }, + "m6a_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6a.16xlarge" + } + }, + "m6a_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6a.24xlarge" + } + }, + "m6a_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6a.32xlarge" + } + }, + "m6a_48xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6a.48xlarge" + } + }, + "m6g_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6g.metal" + } + }, + "m6g_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6g.medium" + } + }, + "m6g_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6g.large" + } + }, + "m6g_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6g.xlarge" + } + }, + "m6g_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6g.2xlarge" + } + }, + "m6g_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6g.4xlarge" + } + }, + "m6g_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6g.8xlarge" + } + }, + "m6g_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6g.12xlarge" + } + }, + "m6g_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6g.16xlarge" + } + }, + "m6gd_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6gd.metal" + } + }, + "m6gd_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6gd.medium" + } + }, + "m6gd_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6gd.large" + } + }, + "m6gd_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6gd.xlarge" + } + }, + "m6gd_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6gd.2xlarge" + } + }, + "m6gd_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6gd.4xlarge" + } + }, + "m6gd_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6gd.8xlarge" + } + }, + "m6gd_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6gd.12xlarge" + } + }, + "m6gd_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6gd.16xlarge" + } + }, + "m6i_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6i.large" + } + }, + "m6i_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6i.xlarge" + } + }, + "m6i_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6i.2xlarge" + } + }, + "m6i_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6i.4xlarge" + } + }, + "m6i_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6i.8xlarge" + } + }, + "m6i_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6i.12xlarge" + } + }, + "m6i_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6i.16xlarge" + } + }, + "m6i_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6i.24xlarge" + } + }, + "m6i_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6i.32xlarge" + } + }, + "m6i_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6i.metal" + } + }, + "mac1_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "mac1.metal" + } + }, + "p2_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "p2.xlarge" + } + }, + "p2_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "p2.8xlarge" + } + }, + "p2_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "p2.16xlarge" + } + }, + "p3_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "p3.2xlarge" + } + }, + "p3_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "p3.8xlarge" + } + }, + "p3_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "p3.16xlarge" + } + }, + "p3dn_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "p3dn.24xlarge" + } + }, + "p4d_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "p4d.24xlarge" + } + }, + "r3_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r3.large" + } + }, + "r3_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r3.xlarge" + } + }, + "r3_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r3.2xlarge" + } + }, + "r3_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r3.4xlarge" + } + }, + "r3_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r3.8xlarge" + } + }, + "r4_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r4.large" + } + }, + "r4_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r4.xlarge" + } + }, + "r4_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r4.2xlarge" + } + }, + "r4_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r4.4xlarge" + } + }, + "r4_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r4.8xlarge" + } + }, + "r4_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r4.16xlarge" + } + }, + "r5_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5.large" + } + }, + "r5_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5.xlarge" + } + }, + "r5_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5.2xlarge" + } + }, + "r5_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5.4xlarge" + } + }, + "r5_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5.8xlarge" + } + }, + "r5_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5.12xlarge" + } + }, + "r5_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5.16xlarge" + } + }, + "r5_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5.24xlarge" + } + }, + "r5_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5.metal" + } + }, + "r5a_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5a.large" + } + }, + "r5a_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5a.xlarge" + } + }, + "r5a_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5a.2xlarge" + } + }, + "r5a_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5a.4xlarge" + } + }, + "r5a_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5a.8xlarge" + } + }, + "r5a_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5a.12xlarge" + } + }, + "r5a_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5a.16xlarge" + } + }, + "r5a_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5a.24xlarge" + } + }, + "r5ad_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5ad.large" + } + }, + "r5ad_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5ad.xlarge" + } + }, + "r5ad_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5ad.2xlarge" + } + }, + "r5ad_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5ad.4xlarge" + } + }, + "r5ad_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5ad.8xlarge" + } + }, + "r5ad_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5ad.12xlarge" + } + }, + "r5ad_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5ad.16xlarge" + } + }, + "r5ad_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5ad.24xlarge" + } + }, + "r5b_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5b.large" + } + }, + "r5b_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5b.xlarge" + } + }, + "r5b_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5b.2xlarge" + } + }, + "r5b_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5b.4xlarge" + } + }, + "r5b_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5b.8xlarge" + } + }, + "r5b_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5b.12xlarge" + } + }, + "r5b_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5b.16xlarge" + } + }, + "r5b_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5b.24xlarge" + } + }, + "r5b_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5b.metal" + } + }, + "r5d_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5d.large" + } + }, + "r5d_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5d.xlarge" + } + }, + "r5d_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5d.2xlarge" + } + }, + "r5d_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5d.4xlarge" + } + }, + "r5d_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5d.8xlarge" + } + }, + "r5d_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5d.12xlarge" + } + }, + "r5d_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5d.16xlarge" + } + }, + "r5d_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5d.24xlarge" + } + }, + "r5d_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5d.metal" + } + }, + "r5dn_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5dn.large" + } + }, + "r5dn_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5dn.xlarge" + } + }, + "r5dn_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5dn.2xlarge" + } + }, + "r5dn_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5dn.4xlarge" + } + }, + "r5dn_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5dn.8xlarge" + } + }, + "r5dn_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5dn.12xlarge" + } + }, + "r5dn_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5dn.16xlarge" + } + }, + "r5dn_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5dn.24xlarge" + } + }, + "r5dn_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5dn.metal" + } + }, + "r5n_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5n.large" + } + }, + "r5n_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5n.xlarge" + } + }, + "r5n_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5n.2xlarge" + } + }, + "r5n_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5n.4xlarge" + } + }, + "r5n_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5n.8xlarge" + } + }, + "r5n_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5n.12xlarge" + } + }, + "r5n_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5n.16xlarge" + } + }, + "r5n_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5n.24xlarge" + } + }, + "r5n_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5n.metal" + } + }, + "r6g_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6g.medium" + } + }, + "r6g_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6g.large" + } + }, + "r6g_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6g.xlarge" + } + }, + "r6g_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6g.2xlarge" + } + }, + "r6g_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6g.4xlarge" + } + }, + "r6g_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6g.8xlarge" + } + }, + "r6g_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6g.12xlarge" + } + }, + "r6g_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6g.16xlarge" + } + }, + "r6g_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6g.metal" + } + }, + "r6gd_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6gd.medium" + } + }, + "r6gd_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6gd.large" + } + }, + "r6gd_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6gd.xlarge" + } + }, + "r6gd_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6gd.2xlarge" + } + }, + "r6gd_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6gd.4xlarge" + } + }, + "r6gd_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6gd.8xlarge" + } + }, + "r6gd_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6gd.12xlarge" + } + }, + "r6gd_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6gd.16xlarge" + } + }, + "r6gd_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6gd.metal" + } + }, + "r6i_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6i.large" + } + }, + "r6i_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6i.xlarge" + } + }, + "r6i_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6i.2xlarge" + } + }, + "r6i_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6i.4xlarge" + } + }, + "r6i_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6i.8xlarge" + } + }, + "r6i_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6i.12xlarge" + } + }, + "r6i_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6i.16xlarge" + } + }, + "r6i_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6i.24xlarge" + } + }, + "r6i_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6i.32xlarge" + } + }, + "r6i_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6i.metal" + } + }, + "t1_micro": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t1.micro" + } + }, + "t2_nano": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t2.nano" + } + }, + "t2_micro": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t2.micro" + } + }, + "t2_small": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t2.small" + } + }, + "t2_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t2.medium" + } + }, + "t2_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t2.large" + } + }, + "t2_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t2.xlarge" + } + }, + "t2_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t2.2xlarge" + } + }, + "t3_nano": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t3.nano" + } + }, + "t3_micro": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t3.micro" + } + }, + "t3_small": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t3.small" + } + }, + "t3_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t3.medium" + } + }, + "t3_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t3.large" + } + }, + "t3_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t3.xlarge" + } + }, + "t3_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t3.2xlarge" + } + }, + "t3a_nano": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t3a.nano" + } + }, + "t3a_micro": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t3a.micro" + } + }, + "t3a_small": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t3a.small" + } + }, + "t3a_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t3a.medium" + } + }, + "t3a_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t3a.large" + } + }, + "t3a_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t3a.xlarge" + } + }, + "t3a_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t3a.2xlarge" + } + }, + "t4g_nano": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t4g.nano" + } + }, + "t4g_micro": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t4g.micro" + } + }, + "t4g_small": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t4g.small" + } + }, + "t4g_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t4g.medium" + } + }, + "t4g_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t4g.large" + } + }, + "t4g_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t4g.xlarge" + } + }, + "t4g_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t4g.2xlarge" + } + }, + "u_6tb1_56xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "u-6tb1.56xlarge" + } + }, + "u_6tb1_112xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "u-6tb1.112xlarge" + } + }, + "u_9tb1_112xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "u-9tb1.112xlarge" + } + }, + "u_12tb1_112xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "u-12tb1.112xlarge" + } + }, + "u_6tb1_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "u-6tb1.metal" + } + }, + "u_9tb1_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "u-9tb1.metal" + } + }, + "u_12tb1_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "u-12tb1.metal" + } + }, + "u_18tb1_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "u-18tb1.metal" + } + }, + "u_24tb1_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "u-24tb1.metal" + } + }, + "vt1_3xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vt1.3xlarge" + } + }, + "vt1_6xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vt1.6xlarge" + } + }, + "vt1_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vt1.24xlarge" + } + }, + "x1_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x1.16xlarge" + } + }, + "x1_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x1.32xlarge" + } + }, + "x1e_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x1e.xlarge" + } + }, + "x1e_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x1e.2xlarge" + } + }, + "x1e_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x1e.4xlarge" + } + }, + "x1e_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x1e.8xlarge" + } + }, + "x1e_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x1e.16xlarge" + } + }, + "x1e_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x1e.32xlarge" + } + }, + "x2iezn_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2iezn.2xlarge" + } + }, + "x2iezn_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2iezn.4xlarge" + } + }, + "x2iezn_6xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2iezn.6xlarge" + } + }, + "x2iezn_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2iezn.8xlarge" + } + }, + "x2iezn_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2iezn.12xlarge" + } + }, + "x2iezn_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2iezn.metal" + } + }, + "x2gd_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2gd.medium" + } + }, + "x2gd_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2gd.large" + } + }, + "x2gd_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2gd.xlarge" + } + }, + "x2gd_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2gd.2xlarge" + } + }, + "x2gd_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2gd.4xlarge" + } + }, + "x2gd_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2gd.8xlarge" + } + }, + "x2gd_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2gd.12xlarge" + } + }, + "x2gd_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2gd.16xlarge" + } + }, + "x2gd_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2gd.metal" + } + }, + "z1d_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "z1d.large" + } + }, + "z1d_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "z1d.xlarge" + } + }, + "z1d_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "z1d.2xlarge" + } + }, + "z1d_3xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "z1d.3xlarge" + } + }, + "z1d_6xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "z1d.6xlarge" + } + }, + "z1d_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "z1d.12xlarge" + } + }, + "z1d_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "z1d.metal" + } + }, + "x2idn_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2idn.16xlarge" + } + }, + "x2idn_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2idn.24xlarge" + } + }, + "x2idn_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2idn.32xlarge" + } + }, + "x2iedn_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2iedn.xlarge" + } + }, + "x2iedn_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2iedn.2xlarge" + } + }, + "x2iedn_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2iedn.4xlarge" + } + }, + "x2iedn_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2iedn.8xlarge" + } + }, + "x2iedn_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2iedn.16xlarge" + } + }, + "x2iedn_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2iedn.24xlarge" + } + }, + "x2iedn_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2iedn.32xlarge" + } + }, + "c6a_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6a.large" + } + }, + "c6a_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6a.xlarge" + } + }, + "c6a_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6a.2xlarge" + } + }, + "c6a_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6a.4xlarge" + } + }, + "c6a_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6a.8xlarge" + } + }, + "c6a_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6a.12xlarge" + } + }, + "c6a_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6a.16xlarge" + } + }, + "c6a_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6a.24xlarge" + } + }, + "c6a_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6a.32xlarge" + } + }, + "c6a_48xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6a.48xlarge" + } + }, + "c6a_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6a.metal" + } + }, + "m6a_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6a.metal" + } + }, + "i4i_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i4i.large" + } + }, + "i4i_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i4i.xlarge" + } + }, + "i4i_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i4i.2xlarge" + } + }, + "i4i_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i4i.4xlarge" + } + }, + "i4i_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i4i.8xlarge" + } + }, + "i4i_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i4i.16xlarge" + } + }, + "i4i_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i4i.32xlarge" + } + }, + "i4i_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i4i.metal" + } + }, + "x2idn_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2idn.metal" + } + }, + "x2iedn_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2iedn.metal" + } + }, + "c7g_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7g.medium" + } + }, + "c7g_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7g.large" + } + }, + "c7g_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7g.xlarge" + } + }, + "c7g_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7g.2xlarge" + } + }, + "c7g_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7g.4xlarge" + } + }, + "c7g_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7g.8xlarge" + } + }, + "c7g_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7g.12xlarge" + } + }, + "c7g_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7g.16xlarge" + } + }, + "mac2_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "mac2.metal" + } + }, + "c6id_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6id.large" + } + }, + "c6id_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6id.xlarge" + } + }, + "c6id_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6id.2xlarge" + } + }, + "c6id_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6id.4xlarge" + } + }, + "c6id_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6id.8xlarge" + } + }, + "c6id_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6id.12xlarge" + } + }, + "c6id_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6id.16xlarge" + } + }, + "c6id_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6id.24xlarge" + } + }, + "c6id_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6id.32xlarge" + } + }, + "c6id_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6id.metal" + } + }, + "m6id_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6id.large" + } + }, + "m6id_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6id.xlarge" + } + }, + "m6id_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6id.2xlarge" + } + }, + "m6id_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6id.4xlarge" + } + }, + "m6id_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6id.8xlarge" + } + }, + "m6id_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6id.12xlarge" + } + }, + "m6id_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6id.16xlarge" + } + }, + "m6id_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6id.24xlarge" + } + }, + "m6id_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6id.32xlarge" + } + }, + "m6id_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6id.metal" + } + }, + "r6id_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6id.large" + } + }, + "r6id_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6id.xlarge" + } + }, + "r6id_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6id.2xlarge" + } + }, + "r6id_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6id.4xlarge" + } + }, + "r6id_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6id.8xlarge" + } + }, + "r6id_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6id.12xlarge" + } + }, + "r6id_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6id.16xlarge" + } + }, + "r6id_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6id.24xlarge" + } + }, + "r6id_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6id.32xlarge" + } + }, + "r6id_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6id.metal" + } + }, + "r6a_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6a.large" + } + }, + "r6a_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6a.xlarge" + } + }, + "r6a_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6a.2xlarge" + } + }, + "r6a_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6a.4xlarge" + } + }, + "r6a_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6a.8xlarge" + } + }, + "r6a_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6a.12xlarge" + } + }, + "r6a_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6a.16xlarge" + } + }, + "r6a_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6a.24xlarge" + } + }, + "r6a_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6a.32xlarge" + } + }, + "r6a_48xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6a.48xlarge" + } + }, + "r6a_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6a.metal" + } + }, + "p4de_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "p4de.24xlarge" + } + }, + "u_3tb1_56xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "u-3tb1.56xlarge" + } + }, + "u_18tb1_112xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "u-18tb1.112xlarge" + } + }, + "u_24tb1_112xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "u-24tb1.112xlarge" + } + }, + "trn1_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "trn1.2xlarge" + } + }, + "trn1_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "trn1.32xlarge" + } + }, + "hpc6id_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hpc6id.32xlarge" + } + }, + "c6in_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6in.large" + } + }, + "c6in_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6in.xlarge" + } + }, + "c6in_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6in.2xlarge" + } + }, + "c6in_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6in.4xlarge" + } + }, + "c6in_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6in.8xlarge" + } + }, + "c6in_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6in.12xlarge" + } + }, + "c6in_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6in.16xlarge" + } + }, + "c6in_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6in.24xlarge" + } + }, + "c6in_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6in.32xlarge" + } + }, + "m6in_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6in.large" + } + }, + "m6in_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6in.xlarge" + } + }, + "m6in_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6in.2xlarge" + } + }, + "m6in_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6in.4xlarge" + } + }, + "m6in_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6in.8xlarge" + } + }, + "m6in_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6in.12xlarge" + } + }, + "m6in_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6in.16xlarge" + } + }, + "m6in_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6in.24xlarge" + } + }, + "m6in_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6in.32xlarge" + } + }, + "m6idn_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6idn.large" + } + }, + "m6idn_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6idn.xlarge" + } + }, + "m6idn_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6idn.2xlarge" + } + }, + "m6idn_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6idn.4xlarge" + } + }, + "m6idn_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6idn.8xlarge" + } + }, + "m6idn_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6idn.12xlarge" + } + }, + "m6idn_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6idn.16xlarge" + } + }, + "m6idn_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6idn.24xlarge" + } + }, + "m6idn_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6idn.32xlarge" + } + }, + "r6in_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6in.large" + } + }, + "r6in_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6in.xlarge" + } + }, + "r6in_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6in.2xlarge" + } + }, + "r6in_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6in.4xlarge" + } + }, + "r6in_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6in.8xlarge" + } + }, + "r6in_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6in.12xlarge" + } + }, + "r6in_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6in.16xlarge" + } + }, + "r6in_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6in.24xlarge" + } + }, + "r6in_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6in.32xlarge" + } + }, + "r6idn_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6idn.large" + } + }, + "r6idn_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6idn.xlarge" + } + }, + "r6idn_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6idn.2xlarge" + } + }, + "r6idn_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6idn.4xlarge" + } + }, + "r6idn_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6idn.8xlarge" + } + }, + "r6idn_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6idn.12xlarge" + } + }, + "r6idn_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6idn.16xlarge" + } + }, + "r6idn_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6idn.24xlarge" + } + }, + "r6idn_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6idn.32xlarge" + } + }, + "c7g_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7g.metal" + } + }, + "m7g_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7g.medium" + } + }, + "m7g_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7g.large" + } + }, + "m7g_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7g.xlarge" + } + }, + "m7g_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7g.2xlarge" + } + }, + "m7g_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7g.4xlarge" + } + }, + "m7g_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7g.8xlarge" + } + }, + "m7g_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7g.12xlarge" + } + }, + "m7g_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7g.16xlarge" + } + }, + "m7g_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7g.metal" + } + }, + "r7g_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7g.medium" + } + }, + "r7g_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7g.large" + } + }, + "r7g_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7g.xlarge" + } + }, + "r7g_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7g.2xlarge" + } + }, + "r7g_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7g.4xlarge" + } + }, + "r7g_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7g.8xlarge" + } + }, + "r7g_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7g.12xlarge" + } + }, + "r7g_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7g.16xlarge" + } + }, + "r7g_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7g.metal" + } + }, + "c6in_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6in.metal" + } + }, + "m6in_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6in.metal" + } + }, + "m6idn_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6idn.metal" + } + }, + "r6in_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6in.metal" + } + }, + "r6idn_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6idn.metal" + } + }, + "inf2_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "inf2.xlarge" + } + }, + "inf2_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "inf2.8xlarge" + } + }, + "inf2_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "inf2.24xlarge" + } + }, + "inf2_48xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "inf2.48xlarge" + } + }, + "trn1n_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "trn1n.32xlarge" + } + }, + "i4g_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i4g.large" + } + }, + "i4g_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i4g.xlarge" + } + }, + "i4g_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i4g.2xlarge" + } + }, + "i4g_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i4g.4xlarge" + } + }, + "i4g_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i4g.8xlarge" + } + }, + "i4g_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i4g.16xlarge" + } + }, + "hpc7g_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hpc7g.4xlarge" + } + }, + "hpc7g_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hpc7g.8xlarge" + } + }, + "hpc7g_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hpc7g.16xlarge" + } + }, + "c7gn_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7gn.medium" + } + }, + "c7gn_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7gn.large" + } + }, + "c7gn_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7gn.xlarge" + } + }, + "c7gn_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7gn.2xlarge" + } + }, + "c7gn_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7gn.4xlarge" + } + }, + "c7gn_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7gn.8xlarge" + } + }, + "c7gn_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7gn.12xlarge" + } + }, + "c7gn_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7gn.16xlarge" + } + }, + "p5_48xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "p5.48xlarge" + } + }, + "m7i_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7i.large" + } + }, + "m7i_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7i.xlarge" + } + }, + "m7i_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7i.2xlarge" + } + }, + "m7i_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7i.4xlarge" + } + }, + "m7i_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7i.8xlarge" + } + }, + "m7i_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7i.12xlarge" + } + }, + "m7i_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7i.16xlarge" + } + }, + "m7i_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7i.24xlarge" + } + }, + "m7i_48xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7i.48xlarge" + } + }, + "m7i_flex_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7i-flex.large" + } + }, + "m7i_flex_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7i-flex.xlarge" + } + }, + "m7i_flex_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7i-flex.2xlarge" + } + }, + "m7i_flex_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7i-flex.4xlarge" + } + }, + "m7i_flex_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7i-flex.8xlarge" + } + }, + "m7a_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7a.medium" + } + }, + "m7a_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7a.large" + } + }, + "m7a_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7a.xlarge" + } + }, + "m7a_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7a.2xlarge" + } + }, + "m7a_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7a.4xlarge" + } + }, + "m7a_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7a.8xlarge" + } + }, + "m7a_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7a.12xlarge" + } + }, + "m7a_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7a.16xlarge" + } + }, + "m7a_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7a.24xlarge" + } + }, + "m7a_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7a.32xlarge" + } + }, + "m7a_48xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7a.48xlarge" + } + }, + "m7a_metal_48xl": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7a.metal-48xl" + } + }, + "hpc7a_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hpc7a.12xlarge" + } + }, + "hpc7a_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hpc7a.24xlarge" + } + }, + "hpc7a_48xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hpc7a.48xlarge" + } + }, + "hpc7a_96xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hpc7a.96xlarge" + } + }, + "c7gd_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7gd.medium" + } + }, + "c7gd_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7gd.large" + } + }, + "c7gd_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7gd.xlarge" + } + }, + "c7gd_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7gd.2xlarge" + } + }, + "c7gd_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7gd.4xlarge" + } + }, + "c7gd_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7gd.8xlarge" + } + }, + "c7gd_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7gd.12xlarge" + } + }, + "c7gd_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7gd.16xlarge" + } + }, + "m7gd_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7gd.medium" + } + }, + "m7gd_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7gd.large" + } + }, + "m7gd_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7gd.xlarge" + } + }, + "m7gd_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7gd.2xlarge" + } + }, + "m7gd_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7gd.4xlarge" + } + }, + "m7gd_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7gd.8xlarge" + } + }, + "m7gd_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7gd.12xlarge" + } + }, + "m7gd_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7gd.16xlarge" + } + }, + "r7gd_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7gd.medium" + } + }, + "r7gd_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7gd.large" + } + }, + "r7gd_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7gd.xlarge" + } + }, + "r7gd_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7gd.2xlarge" + } + }, + "r7gd_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7gd.4xlarge" + } + }, + "r7gd_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7gd.8xlarge" + } + }, + "r7gd_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7gd.12xlarge" + } + }, + "r7gd_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7gd.16xlarge" + } + }, + "r7a_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7a.medium" + } + }, + "r7a_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7a.large" + } + }, + "r7a_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7a.xlarge" + } + }, + "r7a_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7a.2xlarge" + } + }, + "r7a_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7a.4xlarge" + } + }, + "r7a_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7a.8xlarge" + } + }, + "r7a_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7a.12xlarge" + } + }, + "r7a_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7a.16xlarge" + } + }, + "r7a_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7a.24xlarge" + } + }, + "r7a_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7a.32xlarge" + } + }, + "r7a_48xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7a.48xlarge" + } + }, + "c7i_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7i.large" + } + }, + "c7i_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7i.xlarge" + } + }, + "c7i_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7i.2xlarge" + } + }, + "c7i_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7i.4xlarge" + } + }, + "c7i_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7i.8xlarge" + } + }, + "c7i_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7i.12xlarge" + } + }, + "c7i_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7i.16xlarge" + } + }, + "c7i_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7i.24xlarge" + } + }, + "c7i_48xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7i.48xlarge" + } + }, + "mac2_m2pro_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "mac2-m2pro.metal" + } + }, + "r7iz_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7iz.large" + } + }, + "r7iz_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7iz.xlarge" + } + }, + "r7iz_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7iz.2xlarge" + } + }, + "r7iz_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7iz.4xlarge" + } + }, + "r7iz_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7iz.8xlarge" + } + }, + "r7iz_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7iz.12xlarge" + } + }, + "r7iz_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7iz.16xlarge" + } + }, + "r7iz_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7iz.32xlarge" + } + }, + "c7a_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7a.medium" + } + }, + "c7a_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7a.large" + } + }, + "c7a_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7a.xlarge" + } + }, + "c7a_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7a.2xlarge" + } + }, + "c7a_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7a.4xlarge" + } + }, + "c7a_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7a.8xlarge" + } + }, + "c7a_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7a.12xlarge" + } + }, + "c7a_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7a.16xlarge" + } + }, + "c7a_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7a.24xlarge" + } + }, + "c7a_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7a.32xlarge" + } + }, + "c7a_48xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7a.48xlarge" + } + }, + "c7a_metal_48xl": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7a.metal-48xl" + } + }, + "r7a_metal_48xl": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7a.metal-48xl" + } + }, + "r7i_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7i.large" + } + }, + "r7i_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7i.xlarge" + } + }, + "r7i_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7i.2xlarge" + } + }, + "r7i_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7i.4xlarge" + } + }, + "r7i_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7i.8xlarge" + } + }, + "r7i_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7i.12xlarge" + } + }, + "r7i_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7i.16xlarge" + } + }, + "r7i_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7i.24xlarge" + } + }, + "r7i_48xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7i.48xlarge" + } + }, + "dl2q_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dl2q.24xlarge" + } + }, + "mac2_m2_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "mac2-m2.metal" + } + }, + "i4i_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i4i.12xlarge" + } + }, + "i4i_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i4i.24xlarge" + } + }, + "c7i_metal_24xl": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7i.metal-24xl" + } + }, + "c7i_metal_48xl": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7i.metal-48xl" + } + }, + "m7i_metal_24xl": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7i.metal-24xl" + } + }, + "m7i_metal_48xl": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7i.metal-48xl" + } + }, + "r7i_metal_24xl": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7i.metal-24xl" + } + }, + "r7i_metal_48xl": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7i.metal-48xl" + } + }, + "r7iz_metal_16xl": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7iz.metal-16xl" + } + }, + "r7iz_metal_32xl": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7iz.metal-32xl" + } + }, + "c7gd_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7gd.metal" + } + }, + "m7gd_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7gd.metal" + } + }, + "r7gd_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7gd.metal" + } + }, + "g6_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g6.xlarge" + } + }, + "g6_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g6.2xlarge" + } + }, + "g6_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g6.4xlarge" + } + }, + "g6_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g6.8xlarge" + } + }, + "g6_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g6.12xlarge" + } + }, + "g6_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g6.16xlarge" + } + }, + "g6_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g6.24xlarge" + } + }, + "g6_48xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g6.48xlarge" + } + }, + "gr6_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "gr6.4xlarge" + } + }, + "gr6_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "gr6.8xlarge" + } + }, + "c7i_flex_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7i-flex.large" + } + }, + "c7i_flex_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7i-flex.xlarge" + } + }, + "c7i_flex_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7i-flex.2xlarge" + } + }, + "c7i_flex_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7i-flex.4xlarge" + } + }, + "c7i_flex_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7i-flex.8xlarge" + } + }, + "u7i_12tb_224xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "u7i-12tb.224xlarge" + } + }, + "u7in_16tb_224xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "u7in-16tb.224xlarge" + } + }, + "u7in_24tb_224xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "u7in-24tb.224xlarge" + } + }, + "u7in_32tb_224xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "u7in-32tb.224xlarge" + } + }, + "u7ib_12tb_224xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "u7ib-12tb.224xlarge" + } + }, + "c7gn_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7gn.metal" + } + }, + "r8g_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r8g.medium" + } + }, + "r8g_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r8g.large" + } + }, + "r8g_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r8g.xlarge" + } + }, + "r8g_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r8g.2xlarge" + } + }, + "r8g_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r8g.4xlarge" + } + }, + "r8g_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r8g.8xlarge" + } + }, + "r8g_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r8g.12xlarge" + } + }, + "r8g_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r8g.16xlarge" + } + }, + "r8g_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r8g.24xlarge" + } + }, + "r8g_48xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r8g.48xlarge" + } + }, + "r8g_metal_24xl": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r8g.metal-24xl" + } + }, + "r8g_metal_48xl": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r8g.metal-48xl" + } + }, + "mac2_m1ultra_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "mac2-m1ultra.metal" + } + }, + "g6e_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g6e.xlarge" + } + }, + "g6e_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g6e.2xlarge" + } + }, + "g6e_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g6e.4xlarge" + } + }, + "g6e_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g6e.8xlarge" + } + }, + "g6e_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g6e.12xlarge" + } + }, + "g6e_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g6e.16xlarge" + } + }, + "g6e_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g6e.24xlarge" + } + }, + "g6e_48xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g6e.48xlarge" + } + }, + "c8g_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c8g.medium" + } + }, + "c8g_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c8g.large" + } + }, + "c8g_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c8g.xlarge" + } + }, + "c8g_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c8g.2xlarge" + } + }, + "c8g_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c8g.4xlarge" + } + }, + "c8g_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c8g.8xlarge" + } + }, + "c8g_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c8g.12xlarge" + } + }, + "c8g_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c8g.16xlarge" + } + }, + "c8g_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c8g.24xlarge" + } + }, + "c8g_48xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c8g.48xlarge" + } + }, + "c8g_metal_24xl": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c8g.metal-24xl" + } + }, + "c8g_metal_48xl": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c8g.metal-48xl" + } + }, + "m8g_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m8g.medium" + } + }, + "m8g_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m8g.large" + } + }, + "m8g_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m8g.xlarge" + } + }, + "m8g_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m8g.2xlarge" + } + }, + "m8g_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m8g.4xlarge" + } + }, + "m8g_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m8g.8xlarge" + } + }, + "m8g_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m8g.12xlarge" + } + }, + "m8g_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m8g.16xlarge" + } + }, + "m8g_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m8g.24xlarge" + } + }, + "m8g_48xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m8g.48xlarge" + } + }, + "m8g_metal_24xl": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m8g.metal-24xl" + } + }, + "m8g_metal_48xl": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m8g.metal-48xl" + } + }, + "x8g_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x8g.medium" + } + }, + "x8g_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x8g.large" + } + }, + "x8g_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x8g.xlarge" + } + }, + "x8g_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x8g.2xlarge" + } + }, + "x8g_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x8g.4xlarge" + } + }, + "x8g_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x8g.8xlarge" + } + }, + "x8g_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x8g.12xlarge" + } + }, + "x8g_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x8g.16xlarge" + } + }, + "x8g_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x8g.24xlarge" + } + }, + "x8g_48xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x8g.48xlarge" + } + }, + "x8g_metal_24xl": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x8g.metal-24xl" + } + }, + "x8g_metal_48xl": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x8g.metal-48xl" + } + }, + "i7ie_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i7ie.large" + } + }, + "i7ie_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i7ie.xlarge" + } + }, + "i7ie_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i7ie.2xlarge" + } + }, + "i7ie_3xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i7ie.3xlarge" + } + }, + "i7ie_6xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i7ie.6xlarge" + } + }, + "i7ie_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i7ie.12xlarge" + } + }, + "i7ie_18xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i7ie.18xlarge" + } + }, + "i7ie_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i7ie.24xlarge" + } + }, + "i7ie_48xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i7ie.48xlarge" + } + }, + "i8g_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i8g.large" + } + }, + "i8g_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i8g.xlarge" + } + }, + "i8g_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i8g.2xlarge" + } + }, + "i8g_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i8g.4xlarge" + } + }, + "i8g_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i8g.8xlarge" + } + }, + "i8g_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i8g.12xlarge" + } + }, + "i8g_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i8g.16xlarge" + } + }, + "i8g_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i8g.24xlarge" + } + }, + "i8g_metal_24xl": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i8g.metal-24xl" + } + } + } + }, + "com.amazonaws.ec2#InstanceTypeHypervisor": { + "type": "enum", + "members": { + "NITRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nitro" + } + }, + "XEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "xen" + } + } + } + }, + "com.amazonaws.ec2#InstanceTypeInfo": { + "type": "structure", + "members": { + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type. For more information, see Instance types in the Amazon EC2\n User Guide.

", + "smithy.api#xmlName": "instanceType" + } + }, + "CurrentGeneration": { + "target": "com.amazonaws.ec2#CurrentGenerationFlag", + "traits": { + "aws.protocols#ec2QueryName": "CurrentGeneration", + "smithy.api#documentation": "

Indicates whether the instance type is current generation.

", + "smithy.api#xmlName": "currentGeneration" + } + }, + "FreeTierEligible": { + "target": "com.amazonaws.ec2#FreeTierEligibleFlag", + "traits": { + "aws.protocols#ec2QueryName": "FreeTierEligible", + "smithy.api#documentation": "

Indicates whether the instance type is eligible for the free tier.

", + "smithy.api#xmlName": "freeTierEligible" + } + }, + "SupportedUsageClasses": { + "target": "com.amazonaws.ec2#UsageClassTypeList", + "traits": { + "aws.protocols#ec2QueryName": "SupportedUsageClasses", + "smithy.api#documentation": "

Indicates whether the instance type is offered for spot, On-Demand, or Capacity Blocks.

", + "smithy.api#xmlName": "supportedUsageClasses" + } + }, + "SupportedRootDeviceTypes": { + "target": "com.amazonaws.ec2#RootDeviceTypeList", + "traits": { + "aws.protocols#ec2QueryName": "SupportedRootDeviceTypes", + "smithy.api#documentation": "

The supported root device types.

", + "smithy.api#xmlName": "supportedRootDeviceTypes" + } + }, + "SupportedVirtualizationTypes": { + "target": "com.amazonaws.ec2#VirtualizationTypeList", + "traits": { + "aws.protocols#ec2QueryName": "SupportedVirtualizationTypes", + "smithy.api#documentation": "

The supported virtualization types.

", + "smithy.api#xmlName": "supportedVirtualizationTypes" + } + }, + "BareMetal": { + "target": "com.amazonaws.ec2#BareMetalFlag", + "traits": { + "aws.protocols#ec2QueryName": "BareMetal", + "smithy.api#documentation": "

Indicates whether the instance is a bare metal instance type.

", + "smithy.api#xmlName": "bareMetal" + } + }, + "Hypervisor": { + "target": "com.amazonaws.ec2#InstanceTypeHypervisor", + "traits": { + "aws.protocols#ec2QueryName": "Hypervisor", + "smithy.api#documentation": "

The hypervisor for the instance type.

", + "smithy.api#xmlName": "hypervisor" + } + }, + "ProcessorInfo": { + "target": "com.amazonaws.ec2#ProcessorInfo", + "traits": { + "aws.protocols#ec2QueryName": "ProcessorInfo", + "smithy.api#documentation": "

Describes the processor.

", + "smithy.api#xmlName": "processorInfo" + } + }, + "VCpuInfo": { + "target": "com.amazonaws.ec2#VCpuInfo", + "traits": { + "aws.protocols#ec2QueryName": "VCpuInfo", + "smithy.api#documentation": "

Describes the vCPU configurations for the instance type.

", + "smithy.api#xmlName": "vCpuInfo" + } + }, + "MemoryInfo": { + "target": "com.amazonaws.ec2#MemoryInfo", + "traits": { + "aws.protocols#ec2QueryName": "MemoryInfo", + "smithy.api#documentation": "

Describes the memory for the instance type.

", + "smithy.api#xmlName": "memoryInfo" + } + }, + "InstanceStorageSupported": { + "target": "com.amazonaws.ec2#InstanceStorageFlag", + "traits": { + "aws.protocols#ec2QueryName": "InstanceStorageSupported", + "smithy.api#documentation": "

Indicates whether instance storage is supported.

", + "smithy.api#xmlName": "instanceStorageSupported" + } + }, + "InstanceStorageInfo": { + "target": "com.amazonaws.ec2#InstanceStorageInfo", + "traits": { + "aws.protocols#ec2QueryName": "InstanceStorageInfo", + "smithy.api#documentation": "

Describes the instance storage for the instance type.

", + "smithy.api#xmlName": "instanceStorageInfo" + } + }, + "EbsInfo": { + "target": "com.amazonaws.ec2#EbsInfo", + "traits": { + "aws.protocols#ec2QueryName": "EbsInfo", + "smithy.api#documentation": "

Describes the Amazon EBS settings for the instance type.

", + "smithy.api#xmlName": "ebsInfo" + } + }, + "NetworkInfo": { + "target": "com.amazonaws.ec2#NetworkInfo", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInfo", + "smithy.api#documentation": "

Describes the network settings for the instance type.

", + "smithy.api#xmlName": "networkInfo" + } + }, + "GpuInfo": { + "target": "com.amazonaws.ec2#GpuInfo", + "traits": { + "aws.protocols#ec2QueryName": "GpuInfo", + "smithy.api#documentation": "

Describes the GPU accelerator settings for the instance type.

", + "smithy.api#xmlName": "gpuInfo" + } + }, + "FpgaInfo": { + "target": "com.amazonaws.ec2#FpgaInfo", + "traits": { + "aws.protocols#ec2QueryName": "FpgaInfo", + "smithy.api#documentation": "

Describes the FPGA accelerator settings for the instance type.

", + "smithy.api#xmlName": "fpgaInfo" + } + }, + "PlacementGroupInfo": { + "target": "com.amazonaws.ec2#PlacementGroupInfo", + "traits": { + "aws.protocols#ec2QueryName": "PlacementGroupInfo", + "smithy.api#documentation": "

Describes the placement group settings for the instance type.

", + "smithy.api#xmlName": "placementGroupInfo" + } + }, + "InferenceAcceleratorInfo": { + "target": "com.amazonaws.ec2#InferenceAcceleratorInfo", + "traits": { + "aws.protocols#ec2QueryName": "InferenceAcceleratorInfo", + "smithy.api#documentation": "

Describes the Inference accelerator settings for the instance type.

", + "smithy.api#xmlName": "inferenceAcceleratorInfo" + } + }, + "HibernationSupported": { + "target": "com.amazonaws.ec2#HibernationFlag", + "traits": { + "aws.protocols#ec2QueryName": "HibernationSupported", + "smithy.api#documentation": "

Indicates whether On-Demand hibernation is supported.

", + "smithy.api#xmlName": "hibernationSupported" + } + }, + "BurstablePerformanceSupported": { + "target": "com.amazonaws.ec2#BurstablePerformanceFlag", + "traits": { + "aws.protocols#ec2QueryName": "BurstablePerformanceSupported", + "smithy.api#documentation": "

Indicates whether the instance type is a burstable performance T instance type. For more\n information, see Burstable performance\n instances.

", + "smithy.api#xmlName": "burstablePerformanceSupported" + } + }, + "DedicatedHostsSupported": { + "target": "com.amazonaws.ec2#DedicatedHostFlag", + "traits": { + "aws.protocols#ec2QueryName": "DedicatedHostsSupported", + "smithy.api#documentation": "

Indicates whether Dedicated Hosts are supported on the instance type.

", + "smithy.api#xmlName": "dedicatedHostsSupported" + } + }, + "AutoRecoverySupported": { + "target": "com.amazonaws.ec2#AutoRecoveryFlag", + "traits": { + "aws.protocols#ec2QueryName": "AutoRecoverySupported", + "smithy.api#documentation": "

Indicates whether Amazon CloudWatch action based recovery is supported.

", + "smithy.api#xmlName": "autoRecoverySupported" + } + }, + "SupportedBootModes": { + "target": "com.amazonaws.ec2#BootModeTypeList", + "traits": { + "aws.protocols#ec2QueryName": "SupportedBootModes", + "smithy.api#documentation": "

The supported boot modes. For more information, see Boot modes in the Amazon EC2 User\n Guide.

", + "smithy.api#xmlName": "supportedBootModes" + } + }, + "NitroEnclavesSupport": { + "target": "com.amazonaws.ec2#NitroEnclavesSupport", + "traits": { + "aws.protocols#ec2QueryName": "NitroEnclavesSupport", + "smithy.api#documentation": "

Indicates whether Nitro Enclaves is supported.

", + "smithy.api#xmlName": "nitroEnclavesSupport" + } + }, + "NitroTpmSupport": { + "target": "com.amazonaws.ec2#NitroTpmSupport", + "traits": { + "aws.protocols#ec2QueryName": "NitroTpmSupport", + "smithy.api#documentation": "

Indicates whether NitroTPM is supported.

", + "smithy.api#xmlName": "nitroTpmSupport" + } + }, + "NitroTpmInfo": { + "target": "com.amazonaws.ec2#NitroTpmInfo", + "traits": { + "aws.protocols#ec2QueryName": "NitroTpmInfo", + "smithy.api#documentation": "

Describes the supported NitroTPM versions for the instance type.

", + "smithy.api#xmlName": "nitroTpmInfo" + } + }, + "MediaAcceleratorInfo": { + "target": "com.amazonaws.ec2#MediaAcceleratorInfo", + "traits": { + "aws.protocols#ec2QueryName": "MediaAcceleratorInfo", + "smithy.api#documentation": "

Describes the media accelerator settings for the instance type.

", + "smithy.api#xmlName": "mediaAcceleratorInfo" + } + }, + "NeuronInfo": { + "target": "com.amazonaws.ec2#NeuronInfo", + "traits": { + "aws.protocols#ec2QueryName": "NeuronInfo", + "smithy.api#documentation": "

Describes the Neuron accelerator settings for the instance type.

", + "smithy.api#xmlName": "neuronInfo" + } + }, + "PhcSupport": { + "target": "com.amazonaws.ec2#PhcSupport", + "traits": { + "aws.protocols#ec2QueryName": "PhcSupport", + "smithy.api#documentation": "

Indicates whether a local Precision Time Protocol (PTP) hardware clock (PHC) is\n supported.

", + "smithy.api#xmlName": "phcSupport" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the instance type.

" + } + }, + "com.amazonaws.ec2#InstanceTypeInfoFromInstanceRequirements": { + "type": "structure", + "members": { + "InstanceType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The matching instance type.

", + "smithy.api#xmlName": "instanceType" + } + } + }, + "traits": { + "smithy.api#documentation": "

The list of instance types with the specified instance attributes.

" + } + }, + "com.amazonaws.ec2#InstanceTypeInfoFromInstanceRequirementsSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceTypeInfoFromInstanceRequirements", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceTypeInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceTypeInfo", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceType" + } + }, + "com.amazonaws.ec2#InstanceTypeOffering": { + "type": "structure", + "members": { + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type. For more information, see Instance types in the Amazon EC2\n User Guide.

", + "smithy.api#xmlName": "instanceType" + } + }, + "LocationType": { + "target": "com.amazonaws.ec2#LocationType", + "traits": { + "aws.protocols#ec2QueryName": "LocationType", + "smithy.api#documentation": "

The location type.

", + "smithy.api#xmlName": "locationType" + } + }, + "Location": { + "target": "com.amazonaws.ec2#Location", + "traits": { + "aws.protocols#ec2QueryName": "Location", + "smithy.api#documentation": "

The identifier for the location. This depends on the location type. For example, if the\n location type is region, the location is the Region code (for example,\n us-east-2.)

", + "smithy.api#xmlName": "location" + } + } + }, + "traits": { + "smithy.api#documentation": "

The instance types offered.

" + } + }, + "com.amazonaws.ec2#InstanceTypeOfferingsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceTypeOffering", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#InstanceTypesList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceUsage": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AccountId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that is making use of the Capacity\n\t\t\tReservation.

", + "smithy.api#xmlName": "accountId" + } + }, + "UsedInstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "UsedInstanceCount", + "smithy.api#documentation": "

The number of instances the Amazon Web Services account currently has in the Capacity\n\t\t\tReservation.

", + "smithy.api#xmlName": "usedInstanceCount" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the Capacity Reservation usage.

" + } + }, + "com.amazonaws.ec2#InstanceUsageSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceUsage", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Integer": { + "type": "integer" + }, + "com.amazonaws.ec2#IntegerWithConstraints": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.ec2#IntegrateServices": { + "type": "structure", + "members": { + "AthenaIntegrations": { + "target": "com.amazonaws.ec2#AthenaIntegrationsSet", + "traits": { + "smithy.api#documentation": "

Information about the integration with Amazon Athena.

", + "smithy.api#xmlName": "AthenaIntegration" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes service integrations with VPC Flow logs.

" + } + }, + "com.amazonaws.ec2#InterfacePermissionType": { + "type": "enum", + "members": { + "INSTANCE_ATTACH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSTANCE-ATTACH" + } + }, + "EIP_ASSOCIATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EIP-ASSOCIATE" + } + } + } + }, + "com.amazonaws.ec2#InterfaceProtocolType": { + "type": "enum", + "members": { + "VLAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VLAN" + } + }, + "GRE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GRE" + } + } + } + }, + "com.amazonaws.ec2#InternetGateway": { + "type": "structure", + "members": { + "Attachments": { + "target": "com.amazonaws.ec2#InternetGatewayAttachmentList", + "traits": { + "aws.protocols#ec2QueryName": "AttachmentSet", + "smithy.api#documentation": "

Any VPCs attached to the internet gateway.

", + "smithy.api#xmlName": "attachmentSet" + } + }, + "InternetGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InternetGatewayId", + "smithy.api#documentation": "

The ID of the internet gateway.

", + "smithy.api#xmlName": "internetGatewayId" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the internet gateway.

", + "smithy.api#xmlName": "ownerId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the internet gateway.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an internet gateway.

" + } + }, + "com.amazonaws.ec2#InternetGatewayAttachment": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.ec2#AttachmentStatus", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of the attachment. For an internet gateway, the state is\n\t\t\t\tavailable when attached to a VPC; otherwise, this value is not\n\t\t\treturned.

", + "smithy.api#xmlName": "state" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "vpcId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the attachment of a VPC to an internet gateway or an egress-only internet gateway.

" + } + }, + "com.amazonaws.ec2#InternetGatewayAttachmentList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InternetGatewayAttachment", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InternetGatewayBlockMode": { + "type": "enum", + "members": { + "off": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "off" + } + }, + "block_bidirectional": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "block-bidirectional" + } + }, + "block_ingress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "block-ingress" + } + } + } + }, + "com.amazonaws.ec2#InternetGatewayExclusionMode": { + "type": "enum", + "members": { + "allow_bidirectional": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "allow-bidirectional" + } + }, + "allow_egress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "allow-egress" + } + } + } + }, + "com.amazonaws.ec2#InternetGatewayId": { + "type": "string" + }, + "com.amazonaws.ec2#InternetGatewayIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InternetGatewayId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InternetGatewayList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InternetGateway", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpAddress": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 15 + }, + "smithy.api#pattern": "^([0-9]{1,3}.){3}[0-9]{1,3}$" + } + }, + "com.amazonaws.ec2#IpAddressList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IpAddress", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpAddressType": { + "type": "enum", + "members": { + "ipv4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv4" + } + }, + "dualstack": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dualstack" + } + }, + "ipv6": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv6" + } + } + } + }, + "com.amazonaws.ec2#IpList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpPermission": { + "type": "structure", + "members": { + "IpProtocol": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IpProtocol", + "smithy.api#documentation": "

The IP protocol name (tcp, udp, icmp, icmpv6) \n or number (see Protocol Numbers).

\n

Use -1 to specify all protocols. When authorizing\n security group rules, specifying -1 or a protocol number other than\n tcp, udp, icmp, or icmpv6 allows\n traffic on all ports, regardless of any port range you specify. For tcp,\n udp, and icmp, you must specify a port range. For icmpv6,\n the port range is optional; if you omit the port range, traffic for all types and codes is allowed.

", + "smithy.api#xmlName": "ipProtocol" + } + }, + "FromPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "FromPort", + "smithy.api#documentation": "

If the protocol is TCP or UDP, this is the start of the port range.\n If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types).

", + "smithy.api#xmlName": "fromPort" + } + }, + "ToPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "ToPort", + "smithy.api#documentation": "

If the protocol is TCP or UDP, this is the end of the port range.\n If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). \n If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes).

", + "smithy.api#xmlName": "toPort" + } + }, + "UserIdGroupPairs": { + "target": "com.amazonaws.ec2#UserIdGroupPairList", + "traits": { + "aws.protocols#ec2QueryName": "Groups", + "smithy.api#documentation": "

The security group and Amazon Web Services account ID pairs.

", + "smithy.api#xmlName": "groups" + } + }, + "IpRanges": { + "target": "com.amazonaws.ec2#IpRangeList", + "traits": { + "aws.protocols#ec2QueryName": "IpRanges", + "smithy.api#documentation": "

The IPv4 address ranges.

", + "smithy.api#xmlName": "ipRanges" + } + }, + "Ipv6Ranges": { + "target": "com.amazonaws.ec2#Ipv6RangeList", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6Ranges", + "smithy.api#documentation": "

The IPv6 address ranges.

", + "smithy.api#xmlName": "ipv6Ranges" + } + }, + "PrefixListIds": { + "target": "com.amazonaws.ec2#PrefixListIdList", + "traits": { + "aws.protocols#ec2QueryName": "PrefixListIds", + "smithy.api#documentation": "

The prefix list IDs.

", + "smithy.api#xmlName": "prefixListIds" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the permissions for a security group rule.

" + } + }, + "com.amazonaws.ec2#IpPermissionList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IpPermission", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpPrefixList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpRange": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description for the security group rule that references this IPv4 address range.

\n

Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9,\n spaces, and ._-:/()#,@[]+=&;{}!$*

", + "smithy.api#xmlName": "description" + } + }, + "CidrIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CidrIp", + "smithy.api#documentation": "

The IPv4 address range. You can either specify a CIDR block or a source security group,\n not both. To specify a single IPv4 address, use the /32 prefix length.

", + "smithy.api#xmlName": "cidrIp" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an IPv4 address range.

" + } + }, + "com.amazonaws.ec2#IpRangeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IpRange", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpRanges": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpSource": { + "type": "enum", + "members": { + "amazon": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "amazon" + } + }, + "byoip": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "byoip" + } + }, + "none": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "none" + } + } + } + }, + "com.amazonaws.ec2#Ipam": { + "type": "structure", + "members": { + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The Amazon Web Services account ID of the owner of the IPAM.

", + "smithy.api#xmlName": "ownerId" + } + }, + "IpamId": { + "target": "com.amazonaws.ec2#IpamId", + "traits": { + "aws.protocols#ec2QueryName": "IpamId", + "smithy.api#documentation": "

The ID of the IPAM.

", + "smithy.api#xmlName": "ipamId" + } + }, + "IpamArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "IpamArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IPAM.

", + "smithy.api#xmlName": "ipamArn" + } + }, + "IpamRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IpamRegion", + "smithy.api#documentation": "

The Amazon Web Services Region of the IPAM.

", + "smithy.api#xmlName": "ipamRegion" + } + }, + "PublicDefaultScopeId": { + "target": "com.amazonaws.ec2#IpamScopeId", + "traits": { + "aws.protocols#ec2QueryName": "PublicDefaultScopeId", + "smithy.api#documentation": "

The ID of the IPAM's default public scope.

", + "smithy.api#xmlName": "publicDefaultScopeId" + } + }, + "PrivateDefaultScopeId": { + "target": "com.amazonaws.ec2#IpamScopeId", + "traits": { + "aws.protocols#ec2QueryName": "PrivateDefaultScopeId", + "smithy.api#documentation": "

The ID of the IPAM's default private scope.

", + "smithy.api#xmlName": "privateDefaultScopeId" + } + }, + "ScopeCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "ScopeCount", + "smithy.api#documentation": "

The number of scopes in the IPAM. The scope quota is 5. For more information on quotas, see Quotas in IPAM in the Amazon VPC IPAM User Guide.\n

", + "smithy.api#xmlName": "scopeCount" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description for the IPAM.

", + "smithy.api#xmlName": "description" + } + }, + "OperatingRegions": { + "target": "com.amazonaws.ec2#IpamOperatingRegionSet", + "traits": { + "aws.protocols#ec2QueryName": "OperatingRegionSet", + "smithy.api#documentation": "

The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

\n

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.

", + "smithy.api#xmlName": "operatingRegionSet" + } + }, + "State": { + "target": "com.amazonaws.ec2#IpamState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the IPAM.

", + "smithy.api#xmlName": "state" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

", + "smithy.api#xmlName": "tagSet" + } + }, + "DefaultResourceDiscoveryId": { + "target": "com.amazonaws.ec2#IpamResourceDiscoveryId", + "traits": { + "aws.protocols#ec2QueryName": "DefaultResourceDiscoveryId", + "smithy.api#documentation": "

The IPAM's default resource discovery ID.

", + "smithy.api#xmlName": "defaultResourceDiscoveryId" + } + }, + "DefaultResourceDiscoveryAssociationId": { + "target": "com.amazonaws.ec2#IpamResourceDiscoveryAssociationId", + "traits": { + "aws.protocols#ec2QueryName": "DefaultResourceDiscoveryAssociationId", + "smithy.api#documentation": "

The IPAM's default resource discovery association ID.

", + "smithy.api#xmlName": "defaultResourceDiscoveryAssociationId" + } + }, + "ResourceDiscoveryAssociationCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "ResourceDiscoveryAssociationCount", + "smithy.api#documentation": "

The IPAM's resource discovery association count.

", + "smithy.api#xmlName": "resourceDiscoveryAssociationCount" + } + }, + "StateMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StateMessage", + "smithy.api#documentation": "

The state message.

", + "smithy.api#xmlName": "stateMessage" + } + }, + "Tier": { + "target": "com.amazonaws.ec2#IpamTier", + "traits": { + "aws.protocols#ec2QueryName": "Tier", + "smithy.api#documentation": "

IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.

", + "smithy.api#xmlName": "tier" + } + }, + "EnablePrivateGua": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EnablePrivateGua", + "smithy.api#documentation": "

Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default.

", + "smithy.api#xmlName": "enablePrivateGua" + } + } + }, + "traits": { + "smithy.api#documentation": "

IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.

" + } + }, + "com.amazonaws.ec2#IpamAddressHistoryMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#IpamAddressHistoryRecord": { + "type": "structure", + "members": { + "ResourceOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceOwnerId", + "smithy.api#documentation": "

The ID of the resource owner.

", + "smithy.api#xmlName": "resourceOwnerId" + } + }, + "ResourceRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceRegion", + "smithy.api#documentation": "

The Amazon Web Services Region of the resource.

", + "smithy.api#xmlName": "resourceRegion" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#IpamAddressHistoryResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The type of the resource.

", + "smithy.api#xmlName": "resourceType" + } + }, + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The ID of the resource.

", + "smithy.api#xmlName": "resourceId" + } + }, + "ResourceCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceCidr", + "smithy.api#documentation": "

The CIDR of the resource.

", + "smithy.api#xmlName": "resourceCidr" + } + }, + "ResourceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceName", + "smithy.api#documentation": "

The name of the resource.

", + "smithy.api#xmlName": "resourceName" + } + }, + "ResourceComplianceStatus": { + "target": "com.amazonaws.ec2#IpamComplianceStatus", + "traits": { + "aws.protocols#ec2QueryName": "ResourceComplianceStatus", + "smithy.api#documentation": "

The compliance status of a resource. For more information on compliance statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.

", + "smithy.api#xmlName": "resourceComplianceStatus" + } + }, + "ResourceOverlapStatus": { + "target": "com.amazonaws.ec2#IpamOverlapStatus", + "traits": { + "aws.protocols#ec2QueryName": "ResourceOverlapStatus", + "smithy.api#documentation": "

The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.

", + "smithy.api#xmlName": "resourceOverlapStatus" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The VPC ID of the resource.

", + "smithy.api#xmlName": "vpcId" + } + }, + "SampledStartTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "SampledStartTime", + "smithy.api#documentation": "

Sampled start time of the resource-to-CIDR association within the IPAM scope. Changes are picked up in periodic snapshots, so the start time may have occurred before this specific time.

", + "smithy.api#xmlName": "sampledStartTime" + } + }, + "SampledEndTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "SampledEndTime", + "smithy.api#documentation": "

Sampled end time of the resource-to-CIDR association within the IPAM scope. Changes are picked up in periodic snapshots, so the end time may have occurred before this specific time.

", + "smithy.api#xmlName": "sampledEndTime" + } + } + }, + "traits": { + "smithy.api#documentation": "

The historical record of a CIDR within an IPAM scope. For more information, see View the history of IP addresses in the Amazon VPC IPAM User Guide.\n

" + } + }, + "com.amazonaws.ec2#IpamAddressHistoryRecordSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IpamAddressHistoryRecord", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpamAddressHistoryResourceType": { + "type": "enum", + "members": { + "eip": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eip" + } + }, + "vpc": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vpc" + } + }, + "subnet": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "subnet" + } + }, + "network_interface": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "network-interface" + } + }, + "instance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "instance" + } + } + } + }, + "com.amazonaws.ec2#IpamAssociatedResourceDiscoveryStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "not-found" + } + } + } + }, + "com.amazonaws.ec2#IpamCidrAuthorizationContext": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The plain-text authorization message for the prefix and account.

" + } + }, + "Signature": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The signed authorization message for the prefix and account.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.

" + } + }, + "com.amazonaws.ec2#IpamComplianceStatus": { + "type": "enum", + "members": { + "compliant": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "compliant" + } + }, + "noncompliant": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "noncompliant" + } + }, + "unmanaged": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unmanaged" + } + }, + "ignored": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ignored" + } + } + } + }, + "com.amazonaws.ec2#IpamDiscoveredAccount": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AccountId", + "smithy.api#documentation": "

The account ID.

", + "smithy.api#xmlName": "accountId" + } + }, + "DiscoveryRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DiscoveryRegion", + "smithy.api#documentation": "

The Amazon Web Services Region that the account information is returned from. \n An account can be discovered in multiple regions and will have a separate discovered account for each Region.

", + "smithy.api#xmlName": "discoveryRegion" + } + }, + "FailureReason": { + "target": "com.amazonaws.ec2#IpamDiscoveryFailureReason", + "traits": { + "aws.protocols#ec2QueryName": "FailureReason", + "smithy.api#documentation": "

The resource discovery failure reason.

", + "smithy.api#xmlName": "failureReason" + } + }, + "LastAttemptedDiscoveryTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "LastAttemptedDiscoveryTime", + "smithy.api#documentation": "

The last attempted resource discovery time.

", + "smithy.api#xmlName": "lastAttemptedDiscoveryTime" + } + }, + "LastSuccessfulDiscoveryTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "LastSuccessfulDiscoveryTime", + "smithy.api#documentation": "

The last successful resource discovery time.

", + "smithy.api#xmlName": "lastSuccessfulDiscoveryTime" + } + }, + "OrganizationalUnitId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OrganizationalUnitId", + "smithy.api#documentation": "

The ID of an Organizational Unit in Amazon Web Services Organizations.

", + "smithy.api#xmlName": "organizationalUnitId" + } + } + }, + "traits": { + "smithy.api#documentation": "

An IPAM discovered account. A discovered account is an Amazon Web Services account that is monitored under a resource discovery. If you have integrated IPAM with Amazon Web Services Organizations, all accounts in the organization are discovered accounts.

" + } + }, + "com.amazonaws.ec2#IpamDiscoveredAccountSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IpamDiscoveredAccount", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpamDiscoveredPublicAddress": { + "type": "structure", + "members": { + "IpamResourceDiscoveryId": { + "target": "com.amazonaws.ec2#IpamResourceDiscoveryId", + "traits": { + "aws.protocols#ec2QueryName": "IpamResourceDiscoveryId", + "smithy.api#documentation": "

The resource discovery ID.

", + "smithy.api#xmlName": "ipamResourceDiscoveryId" + } + }, + "AddressRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AddressRegion", + "smithy.api#documentation": "

The Region of the resource the IP address is assigned to.

", + "smithy.api#xmlName": "addressRegion" + } + }, + "Address": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Address", + "smithy.api#documentation": "

The IP address.

", + "smithy.api#xmlName": "address" + } + }, + "AddressOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AddressOwnerId", + "smithy.api#documentation": "

The ID of the owner of the resource the IP address is assigned to.

", + "smithy.api#xmlName": "addressOwnerId" + } + }, + "AddressAllocationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AddressAllocationId", + "smithy.api#documentation": "

The allocation ID of the resource the IP address is assigned to.

", + "smithy.api#xmlName": "addressAllocationId" + } + }, + "AssociationStatus": { + "target": "com.amazonaws.ec2#IpamPublicAddressAssociationStatus", + "traits": { + "aws.protocols#ec2QueryName": "AssociationStatus", + "smithy.api#documentation": "

The association status.

", + "smithy.api#xmlName": "associationStatus" + } + }, + "AddressType": { + "target": "com.amazonaws.ec2#IpamPublicAddressType", + "traits": { + "aws.protocols#ec2QueryName": "AddressType", + "smithy.api#documentation": "

The IP address type.

", + "smithy.api#xmlName": "addressType" + } + }, + "Service": { + "target": "com.amazonaws.ec2#IpamPublicAddressAwsService", + "traits": { + "aws.protocols#ec2QueryName": "Service", + "smithy.api#documentation": "

The Amazon Web Services service associated with the IP address.

", + "smithy.api#xmlName": "service" + } + }, + "ServiceResource": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ServiceResource", + "smithy.api#documentation": "

The resource ARN or ID.

", + "smithy.api#xmlName": "serviceResource" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC that the resource with the assigned IP address is in.

", + "smithy.api#xmlName": "vpcId" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet that the resource with the assigned IP address is in.

", + "smithy.api#xmlName": "subnetId" + } + }, + "PublicIpv4PoolId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicIpv4PoolId", + "smithy.api#documentation": "

The ID of the public IPv4 pool that the resource with the assigned IP address is from.

", + "smithy.api#xmlName": "publicIpv4PoolId" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The network interface ID of the resource with the assigned IP address.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "NetworkInterfaceDescription": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceDescription", + "smithy.api#documentation": "

The description of the network interface that IP address is assigned to.

", + "smithy.api#xmlName": "networkInterfaceDescription" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The instance ID of the instance the assigned IP address is assigned to.

", + "smithy.api#xmlName": "instanceId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#IpamPublicAddressTags", + "traits": { + "aws.protocols#ec2QueryName": "Tags", + "smithy.api#documentation": "

Tags associated with the IP address.

", + "smithy.api#xmlName": "tags" + } + }, + "NetworkBorderGroup": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkBorderGroup", + "smithy.api#documentation": "

The Availability Zone (AZ) or Local Zone (LZ) network border group that the resource that the IP address is assigned to is in. Defaults to an AZ network border group. For more information on available Local Zones, see Local Zone availability in the Amazon EC2 User Guide.

", + "smithy.api#xmlName": "networkBorderGroup" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.ec2#IpamPublicAddressSecurityGroupList", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroupSet", + "smithy.api#documentation": "

Security groups associated with the resource that the IP address is assigned to.

", + "smithy.api#xmlName": "securityGroupSet" + } + }, + "SampleTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "SampleTime", + "smithy.api#documentation": "

The last successful resource discovery time.

", + "smithy.api#xmlName": "sampleTime" + } + } + }, + "traits": { + "smithy.api#documentation": "

A public IP Address discovered by IPAM.

" + } + }, + "com.amazonaws.ec2#IpamDiscoveredPublicAddressSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IpamDiscoveredPublicAddress", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpamDiscoveredResourceCidr": { + "type": "structure", + "members": { + "IpamResourceDiscoveryId": { + "target": "com.amazonaws.ec2#IpamResourceDiscoveryId", + "traits": { + "aws.protocols#ec2QueryName": "IpamResourceDiscoveryId", + "smithy.api#documentation": "

The resource discovery ID.

", + "smithy.api#xmlName": "ipamResourceDiscoveryId" + } + }, + "ResourceRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceRegion", + "smithy.api#documentation": "

The resource Region.

", + "smithy.api#xmlName": "resourceRegion" + } + }, + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The resource ID.

", + "smithy.api#xmlName": "resourceId" + } + }, + "ResourceOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceOwnerId", + "smithy.api#documentation": "

The resource owner ID.

", + "smithy.api#xmlName": "resourceOwnerId" + } + }, + "ResourceCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceCidr", + "smithy.api#documentation": "

The resource CIDR.

", + "smithy.api#xmlName": "resourceCidr" + } + }, + "IpSource": { + "target": "com.amazonaws.ec2#IpamResourceCidrIpSource", + "traits": { + "aws.protocols#ec2QueryName": "IpSource", + "smithy.api#documentation": "

The source that allocated the IP address space. byoip or amazon indicates public IP address space allocated by Amazon or space that you have allocated with Bring your own IP (BYOIP). none indicates private space.

", + "smithy.api#xmlName": "ipSource" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#IpamResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The resource type.

", + "smithy.api#xmlName": "resourceType" + } + }, + "ResourceTags": { + "target": "com.amazonaws.ec2#IpamResourceTagList", + "traits": { + "aws.protocols#ec2QueryName": "ResourceTagSet", + "smithy.api#documentation": "

The resource tags.

", + "smithy.api#xmlName": "resourceTagSet" + } + }, + "IpUsage": { + "target": "com.amazonaws.ec2#BoxedDouble", + "traits": { + "aws.protocols#ec2QueryName": "IpUsage", + "smithy.api#documentation": "

The percentage of IP address space in use. To convert the decimal to a percentage, multiply the decimal by 100. Note the following:

\n ", + "smithy.api#xmlName": "ipUsage" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The VPC ID.

", + "smithy.api#xmlName": "vpcId" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The subnet ID.

", + "smithy.api#xmlName": "subnetId" + } + }, + "NetworkInterfaceAttachmentStatus": { + "target": "com.amazonaws.ec2#IpamNetworkInterfaceAttachmentStatus", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceAttachmentStatus", + "smithy.api#documentation": "

For elastic network interfaces, this is the status of whether or not the elastic network interface is attached.

", + "smithy.api#xmlName": "networkInterfaceAttachmentStatus" + } + }, + "SampleTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "SampleTime", + "smithy.api#documentation": "

The last successful resource discovery time.

", + "smithy.api#xmlName": "sampleTime" + } + }, + "AvailabilityZoneId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZoneId", + "smithy.api#documentation": "

The Availability Zone ID.

", + "smithy.api#xmlName": "availabilityZoneId" + } + } + }, + "traits": { + "smithy.api#documentation": "

An IPAM discovered resource CIDR. A discovered resource is a resource CIDR monitored under a resource discovery. The following resources can be discovered: VPCs, Public IPv4 pools, VPC subnets, and Elastic IP addresses. The discovered resource CIDR is the IP address range in CIDR notation that is associated with the resource.

" + } + }, + "com.amazonaws.ec2#IpamDiscoveredResourceCidrSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IpamDiscoveredResourceCidr", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpamDiscoveryFailureCode": { + "type": "enum", + "members": { + "assume_role_failure": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "assume-role-failure" + } + }, + "throttling_failure": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "throttling-failure" + } + }, + "unauthorized_failure": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unauthorized-failure" + } + } + } + }, + "com.amazonaws.ec2#IpamDiscoveryFailureReason": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#IpamDiscoveryFailureCode", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The discovery failure code.

\n ", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

The discovery failure message.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

The discovery failure reason.

" + } + }, + "com.amazonaws.ec2#IpamExternalResourceVerificationToken": { + "type": "structure", + "members": { + "IpamExternalResourceVerificationTokenId": { + "target": "com.amazonaws.ec2#IpamExternalResourceVerificationTokenId", + "traits": { + "aws.protocols#ec2QueryName": "IpamExternalResourceVerificationTokenId", + "smithy.api#documentation": "

The ID of the token.

", + "smithy.api#xmlName": "ipamExternalResourceVerificationTokenId" + } + }, + "IpamExternalResourceVerificationTokenArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "IpamExternalResourceVerificationTokenArn", + "smithy.api#documentation": "

Token ARN.

", + "smithy.api#xmlName": "ipamExternalResourceVerificationTokenArn" + } + }, + "IpamId": { + "target": "com.amazonaws.ec2#IpamId", + "traits": { + "aws.protocols#ec2QueryName": "IpamId", + "smithy.api#documentation": "

The ID of the IPAM that created the token.

", + "smithy.api#xmlName": "ipamId" + } + }, + "IpamArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "IpamArn", + "smithy.api#documentation": "

ARN of the IPAM that created the token.

", + "smithy.api#xmlName": "ipamArn" + } + }, + "IpamRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IpamRegion", + "smithy.api#documentation": "

Region of the IPAM that created the token.

", + "smithy.api#xmlName": "ipamRegion" + } + }, + "TokenValue": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TokenValue", + "smithy.api#documentation": "

Token value.

", + "smithy.api#xmlName": "tokenValue" + } + }, + "TokenName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TokenName", + "smithy.api#documentation": "

Token name.

", + "smithy.api#xmlName": "tokenName" + } + }, + "NotAfter": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "NotAfter", + "smithy.api#documentation": "

Token expiration.

", + "smithy.api#xmlName": "notAfter" + } + }, + "Status": { + "target": "com.amazonaws.ec2#TokenState", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

Token status.

", + "smithy.api#xmlName": "status" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Token tags.

", + "smithy.api#xmlName": "tagSet" + } + }, + "State": { + "target": "com.amazonaws.ec2#IpamExternalResourceVerificationTokenState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

Token state.

", + "smithy.api#xmlName": "state" + } + } + }, + "traits": { + "smithy.api#documentation": "

A verification token is an Amazon Web Services-generated random value that you can use to prove ownership of an external resource. For example, you can use a verification token to validate that you control a public IP address range when you bring an IP address range to Amazon Web Services (BYOIP).\n

" + } + }, + "com.amazonaws.ec2#IpamExternalResourceVerificationTokenId": { + "type": "string" + }, + "com.amazonaws.ec2#IpamExternalResourceVerificationTokenSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IpamExternalResourceVerificationToken", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpamExternalResourceVerificationTokenState": { + "type": "enum", + "members": { + "CREATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "create-in-progress" + } + }, + "CREATE_COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "create-complete" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "create-failed" + } + }, + "DELETE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "delete-in-progress" + } + }, + "DELETE_COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "delete-complete" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "delete-failed" + } + } + } + }, + "com.amazonaws.ec2#IpamId": { + "type": "string" + }, + "com.amazonaws.ec2#IpamManagementState": { + "type": "enum", + "members": { + "managed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "managed" + } + }, + "unmanaged": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unmanaged" + } + }, + "ignored": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ignored" + } + } + } + }, + "com.amazonaws.ec2#IpamMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#IpamNetmaskLength": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 128 + } + } + }, + "com.amazonaws.ec2#IpamNetworkInterfaceAttachmentStatus": { + "type": "enum", + "members": { + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "in_use": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "in-use" + } + } + } + }, + "com.amazonaws.ec2#IpamOperatingRegion": { + "type": "structure", + "members": { + "RegionName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RegionName", + "smithy.api#documentation": "

The name of the operating Region.

", + "smithy.api#xmlName": "regionName" + } + } + }, + "traits": { + "smithy.api#documentation": "

The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

\n

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.

" + } + }, + "com.amazonaws.ec2#IpamOperatingRegionSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IpamOperatingRegion", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpamOrganizationalUnitExclusion": { + "type": "structure", + "members": { + "OrganizationsEntityPath": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OrganizationsEntityPath", + "smithy.api#documentation": "

An Amazon Web Services Organizations entity path. For more information on the entity path, see Understand the Amazon Web Services Organizations entity path in the Amazon Web Services Identity and Access Management User Guide.

", + "smithy.api#xmlName": "organizationsEntityPath" + } + } + }, + "traits": { + "smithy.api#documentation": "

If your IPAM is integrated with Amazon Web Services Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion.

" + } + }, + "com.amazonaws.ec2#IpamOrganizationalUnitExclusionSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IpamOrganizationalUnitExclusion", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpamOverlapStatus": { + "type": "enum", + "members": { + "overlapping": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "overlapping" + } + }, + "nonoverlapping": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nonoverlapping" + } + }, + "ignored": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ignored" + } + } + } + }, + "com.amazonaws.ec2#IpamPool": { + "type": "structure", + "members": { + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The Amazon Web Services account ID of the owner of the IPAM pool.

", + "smithy.api#xmlName": "ownerId" + } + }, + "IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "aws.protocols#ec2QueryName": "IpamPoolId", + "smithy.api#documentation": "

The ID of the IPAM pool.

", + "smithy.api#xmlName": "ipamPoolId" + } + }, + "SourceIpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "aws.protocols#ec2QueryName": "SourceIpamPoolId", + "smithy.api#documentation": "

The ID of the source IPAM pool. You can use this option to create an IPAM pool within an existing source pool.

", + "smithy.api#xmlName": "sourceIpamPoolId" + } + }, + "IpamPoolArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "IpamPoolArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IPAM pool.

", + "smithy.api#xmlName": "ipamPoolArn" + } + }, + "IpamScopeArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "IpamScopeArn", + "smithy.api#documentation": "

The ARN of the scope of the IPAM pool.

", + "smithy.api#xmlName": "ipamScopeArn" + } + }, + "IpamScopeType": { + "target": "com.amazonaws.ec2#IpamScopeType", + "traits": { + "aws.protocols#ec2QueryName": "IpamScopeType", + "smithy.api#documentation": "

In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.

", + "smithy.api#xmlName": "ipamScopeType" + } + }, + "IpamArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "IpamArn", + "smithy.api#documentation": "

The ARN of the IPAM.

", + "smithy.api#xmlName": "ipamArn" + } + }, + "IpamRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IpamRegion", + "smithy.api#documentation": "

The Amazon Web Services Region of the IPAM pool.

", + "smithy.api#xmlName": "ipamRegion" + } + }, + "Locale": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Locale", + "smithy.api#documentation": "

The locale of the IPAM pool.

\n

The locale for the pool should be one of the following:

\n \n

If you choose an Amazon Web Services Region for locale that has not been configured as an operating Region for the IPAM, you'll get an error.

", + "smithy.api#xmlName": "locale" + } + }, + "PoolDepth": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "PoolDepth", + "smithy.api#documentation": "

The depth of pools in your IPAM pool. The pool depth quota is 10. For more information, see Quotas in IPAM in the Amazon VPC IPAM User Guide.\n

", + "smithy.api#xmlName": "poolDepth" + } + }, + "State": { + "target": "com.amazonaws.ec2#IpamPoolState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the IPAM pool.

", + "smithy.api#xmlName": "state" + } + }, + "StateMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StateMessage", + "smithy.api#documentation": "

The state message.

", + "smithy.api#xmlName": "stateMessage" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description of the IPAM pool.

", + "smithy.api#xmlName": "description" + } + }, + "AutoImport": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "AutoImport", + "smithy.api#documentation": "

If selected, IPAM will continuously look for resources within the CIDR range of this pool \n and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for\n these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import \n a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently \n marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM \n discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.\n

\n

A locale must be set on the pool for this feature to work.

", + "smithy.api#xmlName": "autoImport" + } + }, + "PubliclyAdvertisable": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "PubliclyAdvertisable", + "smithy.api#documentation": "

Determines if a pool is publicly advertisable. This option is not available for pools with AddressFamily set to ipv4.

", + "smithy.api#xmlName": "publiclyAdvertisable" + } + }, + "AddressFamily": { + "target": "com.amazonaws.ec2#AddressFamily", + "traits": { + "aws.protocols#ec2QueryName": "AddressFamily", + "smithy.api#documentation": "

The address family of the pool.

", + "smithy.api#xmlName": "addressFamily" + } + }, + "AllocationMinNetmaskLength": { + "target": "com.amazonaws.ec2#IpamNetmaskLength", + "traits": { + "aws.protocols#ec2QueryName": "AllocationMinNetmaskLength", + "smithy.api#documentation": "

The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

", + "smithy.api#xmlName": "allocationMinNetmaskLength" + } + }, + "AllocationMaxNetmaskLength": { + "target": "com.amazonaws.ec2#IpamNetmaskLength", + "traits": { + "aws.protocols#ec2QueryName": "AllocationMaxNetmaskLength", + "smithy.api#documentation": "

The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

", + "smithy.api#xmlName": "allocationMaxNetmaskLength" + } + }, + "AllocationDefaultNetmaskLength": { + "target": "com.amazonaws.ec2#IpamNetmaskLength", + "traits": { + "aws.protocols#ec2QueryName": "AllocationDefaultNetmaskLength", + "smithy.api#documentation": "

The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and \n you enter 16 here, new allocations will default to 10.0.0.0/16.

", + "smithy.api#xmlName": "allocationDefaultNetmaskLength" + } + }, + "AllocationResourceTags": { + "target": "com.amazonaws.ec2#IpamResourceTagList", + "traits": { + "aws.protocols#ec2QueryName": "AllocationResourceTagSet", + "smithy.api#documentation": "

Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.

", + "smithy.api#xmlName": "allocationResourceTagSet" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

", + "smithy.api#xmlName": "tagSet" + } + }, + "AwsService": { + "target": "com.amazonaws.ec2#IpamPoolAwsService", + "traits": { + "aws.protocols#ec2QueryName": "AwsService", + "smithy.api#documentation": "

Limits which service in Amazon Web Services that the pool can be used in. \"ec2\", for example, allows users to use space for Elastic IP addresses and VPCs.

", + "smithy.api#xmlName": "awsService" + } + }, + "PublicIpSource": { + "target": "com.amazonaws.ec2#IpamPoolPublicIpSource", + "traits": { + "aws.protocols#ec2QueryName": "PublicIpSource", + "smithy.api#documentation": "

The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is BYOIP. For more information, see Create IPv6 pools in the Amazon VPC IPAM User Guide. \n By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool. For information on increasing the default limit, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.

", + "smithy.api#xmlName": "publicIpSource" + } + }, + "SourceResource": { + "target": "com.amazonaws.ec2#IpamPoolSourceResource", + "traits": { + "aws.protocols#ec2QueryName": "SourceResource", + "smithy.api#documentation": "

The resource used to provision CIDRs to a resource planning pool.

", + "smithy.api#xmlName": "sourceResource" + } + } + }, + "traits": { + "smithy.api#documentation": "

In IPAM, a pool is a collection of contiguous IP addresses CIDRs. Pools enable you to organize your IP addresses according to your routing and security needs. For example, if you have separate routing and security needs for development and production applications, you can create a pool for each.

" + } + }, + "com.amazonaws.ec2#IpamPoolAllocation": { + "type": "structure", + "members": { + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Cidr", + "smithy.api#documentation": "

The CIDR for the allocation. A CIDR is a representation of an IP address and its associated network mask (or netmask) and \n refers to a range of IP addresses. An IPv4 CIDR example is 10.24.34.0/23. An IPv6 CIDR example is 2001:DB8::/32.

", + "smithy.api#xmlName": "cidr" + } + }, + "IpamPoolAllocationId": { + "target": "com.amazonaws.ec2#IpamPoolAllocationId", + "traits": { + "aws.protocols#ec2QueryName": "IpamPoolAllocationId", + "smithy.api#documentation": "

The ID of an allocation.

", + "smithy.api#xmlName": "ipamPoolAllocationId" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description of the pool allocation.

", + "smithy.api#xmlName": "description" + } + }, + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The ID of the resource.

", + "smithy.api#xmlName": "resourceId" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#IpamPoolAllocationResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The type of the resource.

", + "smithy.api#xmlName": "resourceType" + } + }, + "ResourceRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceRegion", + "smithy.api#documentation": "

The Amazon Web Services Region of the resource.

", + "smithy.api#xmlName": "resourceRegion" + } + }, + "ResourceOwner": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceOwner", + "smithy.api#documentation": "

The owner of the resource.

", + "smithy.api#xmlName": "resourceOwner" + } + } + }, + "traits": { + "smithy.api#documentation": "

In IPAM, an allocation is a CIDR assignment from an IPAM pool to another IPAM pool or to a resource.

" + } + }, + "com.amazonaws.ec2#IpamPoolAllocationAllowedCidrs": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpamPoolAllocationDisallowedCidrs": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpamPoolAllocationId": { + "type": "string" + }, + "com.amazonaws.ec2#IpamPoolAllocationResourceType": { + "type": "enum", + "members": { + "ipam_pool": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipam-pool" + } + }, + "vpc": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vpc" + } + }, + "ec2_public_ipv4_pool": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ec2-public-ipv4-pool" + } + }, + "custom": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "custom" + } + }, + "subnet": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "subnet" + } + }, + "eip": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eip" + } + } + } + }, + "com.amazonaws.ec2#IpamPoolAllocationSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IpamPoolAllocation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpamPoolAwsService": { + "type": "enum", + "members": { + "ec2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ec2" + } + } + } + }, + "com.amazonaws.ec2#IpamPoolCidr": { + "type": "structure", + "members": { + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Cidr", + "smithy.api#documentation": "

The CIDR provisioned to the IPAM pool. A CIDR is a representation of an IP address and its associated network mask (or netmask) \n and refers to a range of IP addresses. An IPv4 CIDR example is 10.24.34.0/23. An IPv6 CIDR example is 2001:DB8::/32.

", + "smithy.api#xmlName": "cidr" + } + }, + "State": { + "target": "com.amazonaws.ec2#IpamPoolCidrState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the CIDR.

", + "smithy.api#xmlName": "state" + } + }, + "FailureReason": { + "target": "com.amazonaws.ec2#IpamPoolCidrFailureReason", + "traits": { + "aws.protocols#ec2QueryName": "FailureReason", + "smithy.api#documentation": "

Details related to why an IPAM pool CIDR failed to be provisioned.

", + "smithy.api#xmlName": "failureReason" + } + }, + "IpamPoolCidrId": { + "target": "com.amazonaws.ec2#IpamPoolCidrId", + "traits": { + "aws.protocols#ec2QueryName": "IpamPoolCidrId", + "smithy.api#documentation": "

The IPAM pool CIDR ID.

", + "smithy.api#xmlName": "ipamPoolCidrId" + } + }, + "NetmaskLength": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "NetmaskLength", + "smithy.api#documentation": "

The netmask length of the CIDR you'd like to provision to a pool. Can be used for provisioning Amazon-provided IPv6 CIDRs to top-level pools and for provisioning CIDRs to pools with source pools. Cannot be used to provision BYOIP CIDRs to top-level pools. \"NetmaskLength\" or \"Cidr\" is required.

", + "smithy.api#xmlName": "netmaskLength" + } + } + }, + "traits": { + "smithy.api#documentation": "

A CIDR provisioned to an IPAM pool.

" + } + }, + "com.amazonaws.ec2#IpamPoolCidrFailureCode": { + "type": "enum", + "members": { + "cidr_not_available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cidr-not-available" + } + }, + "limit_exceeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "limit-exceeded" + } + } + } + }, + "com.amazonaws.ec2#IpamPoolCidrFailureReason": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#IpamPoolCidrFailureCode", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

An error code related to why an IPAM pool CIDR failed to be provisioned.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

A message related to why an IPAM pool CIDR failed to be provisioned.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details related to why an IPAM pool CIDR failed to be provisioned.

" + } + }, + "com.amazonaws.ec2#IpamPoolCidrId": { + "type": "string" + }, + "com.amazonaws.ec2#IpamPoolCidrSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IpamPoolCidr", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpamPoolCidrState": { + "type": "enum", + "members": { + "pending_provision": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending-provision" + } + }, + "provisioned": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "provisioned" + } + }, + "failed_provision": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed-provision" + } + }, + "pending_deprovision": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending-deprovision" + } + }, + "deprovisioned": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deprovisioned" + } + }, + "failed_deprovision": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed-deprovision" + } + }, + "pending_import": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending-import" + } + }, + "failed_import": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed-import" + } + } + } + }, + "com.amazonaws.ec2#IpamPoolId": { + "type": "string" + }, + "com.amazonaws.ec2#IpamPoolPublicIpSource": { + "type": "enum", + "members": { + "amazon": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "amazon" + } + }, + "byoip": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "byoip" + } + } + } + }, + "com.amazonaws.ec2#IpamPoolSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IpamPool", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpamPoolSourceResource": { + "type": "structure", + "members": { + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The source resource ID.

", + "smithy.api#xmlName": "resourceId" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#IpamPoolSourceResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The source resource type.

", + "smithy.api#xmlName": "resourceType" + } + }, + "ResourceRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceRegion", + "smithy.api#documentation": "

The source resource Region.

", + "smithy.api#xmlName": "resourceRegion" + } + }, + "ResourceOwner": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceOwner", + "smithy.api#documentation": "

The source resource owner.

", + "smithy.api#xmlName": "resourceOwner" + } + } + }, + "traits": { + "smithy.api#documentation": "

The resource used to provision CIDRs to a resource planning pool.

" + } + }, + "com.amazonaws.ec2#IpamPoolSourceResourceRequest": { + "type": "structure", + "members": { + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The source resource ID.

" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#IpamPoolSourceResourceType", + "traits": { + "smithy.api#documentation": "

The source resource type.

" + } + }, + "ResourceRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The source resource Region.

" + } + }, + "ResourceOwner": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The source resource owner.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The resource used to provision CIDRs to a resource planning pool.

" + } + }, + "com.amazonaws.ec2#IpamPoolSourceResourceType": { + "type": "enum", + "members": { + "vpc": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vpc" + } + } + } + }, + "com.amazonaws.ec2#IpamPoolState": { + "type": "enum", + "members": { + "create_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "create-in-progress" + } + }, + "create_complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "create-complete" + } + }, + "create_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "create-failed" + } + }, + "modify_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modify-in-progress" + } + }, + "modify_complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modify-complete" + } + }, + "modify_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modify-failed" + } + }, + "delete_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "delete-in-progress" + } + }, + "delete_complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "delete-complete" + } + }, + "delete_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "delete-failed" + } + }, + "isolate_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "isolate-in-progress" + } + }, + "isolate_complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "isolate-complete" + } + }, + "restore_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "restore-in-progress" + } + } + } + }, + "com.amazonaws.ec2#IpamPublicAddressAssociationStatus": { + "type": "enum", + "members": { + "ASSOCIATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associated" + } + }, + "DISASSOCIATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociated" + } + } + } + }, + "com.amazonaws.ec2#IpamPublicAddressAwsService": { + "type": "enum", + "members": { + "NAT_GATEWAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nat-gateway" + } + }, + "DMS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "database-migration-service" + } + }, + "REDSHIFT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "redshift" + } + }, + "ECS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "elastic-container-service" + } + }, + "RDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "relational-database-service" + } + }, + "S2S_VPN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "site-to-site-vpn" + } + }, + "EC2_LB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "load-balancer" + } + }, + "AGA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "global-accelerator" + } + }, + "OTHER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "other" + } + } + } + }, + "com.amazonaws.ec2#IpamPublicAddressSecurityGroup": { + "type": "structure", + "members": { + "GroupName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupName", + "smithy.api#documentation": "

The security group's name.

", + "smithy.api#xmlName": "groupName" + } + }, + "GroupId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupId", + "smithy.api#documentation": "

The security group's ID.

", + "smithy.api#xmlName": "groupId" + } + } + }, + "traits": { + "smithy.api#documentation": "

The security group that the resource with the public IP address is in.

" + } + }, + "com.amazonaws.ec2#IpamPublicAddressSecurityGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IpamPublicAddressSecurityGroup", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpamPublicAddressTag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Key", + "smithy.api#documentation": "

The tag's key.

", + "smithy.api#xmlName": "key" + } + }, + "Value": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Value", + "smithy.api#documentation": "

The tag's value.

", + "smithy.api#xmlName": "value" + } + } + }, + "traits": { + "smithy.api#documentation": "

A tag for a public IP address discovered by IPAM.

" + } + }, + "com.amazonaws.ec2#IpamPublicAddressTagList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IpamPublicAddressTag", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpamPublicAddressTags": { + "type": "structure", + "members": { + "EipTags": { + "target": "com.amazonaws.ec2#IpamPublicAddressTagList", + "traits": { + "aws.protocols#ec2QueryName": "EipTagSet", + "smithy.api#documentation": "

Tags for an Elastic IP address.

", + "smithy.api#xmlName": "eipTagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Tags for a public IP address discovered by IPAM.

" + } + }, + "com.amazonaws.ec2#IpamPublicAddressType": { + "type": "enum", + "members": { + "SERVICE_MANAGED_IP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "service-managed-ip" + } + }, + "SERVICE_MANAGED_BYOIP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "service-managed-byoip" + } + }, + "AMAZON_OWNED_EIP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "amazon-owned-eip" + } + }, + "AMAZON_OWNED_CONTIG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "amazon-owned-contig" + } + }, + "BYOIP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "byoip" + } + }, + "EC2_PUBLIC_IP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ec2-public-ip" + } + } + } + }, + "com.amazonaws.ec2#IpamResourceCidr": { + "type": "structure", + "members": { + "IpamId": { + "target": "com.amazonaws.ec2#IpamId", + "traits": { + "aws.protocols#ec2QueryName": "IpamId", + "smithy.api#documentation": "

The IPAM ID for an IPAM resource.

", + "smithy.api#xmlName": "ipamId" + } + }, + "IpamScopeId": { + "target": "com.amazonaws.ec2#IpamScopeId", + "traits": { + "aws.protocols#ec2QueryName": "IpamScopeId", + "smithy.api#documentation": "

The scope ID for an IPAM resource.

", + "smithy.api#xmlName": "ipamScopeId" + } + }, + "IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "aws.protocols#ec2QueryName": "IpamPoolId", + "smithy.api#documentation": "

The pool ID for an IPAM resource.

", + "smithy.api#xmlName": "ipamPoolId" + } + }, + "ResourceRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceRegion", + "smithy.api#documentation": "

The Amazon Web Services Region for an IPAM resource.

", + "smithy.api#xmlName": "resourceRegion" + } + }, + "ResourceOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceOwnerId", + "smithy.api#documentation": "

The Amazon Web Services account number of the owner of an IPAM resource.

", + "smithy.api#xmlName": "resourceOwnerId" + } + }, + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The ID of an IPAM resource.

", + "smithy.api#xmlName": "resourceId" + } + }, + "ResourceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceName", + "smithy.api#documentation": "

The name of an IPAM resource.

", + "smithy.api#xmlName": "resourceName" + } + }, + "ResourceCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceCidr", + "smithy.api#documentation": "

The CIDR for an IPAM resource.

", + "smithy.api#xmlName": "resourceCidr" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#IpamResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The type of IPAM resource.

", + "smithy.api#xmlName": "resourceType" + } + }, + "ResourceTags": { + "target": "com.amazonaws.ec2#IpamResourceTagList", + "traits": { + "aws.protocols#ec2QueryName": "ResourceTagSet", + "smithy.api#documentation": "

The tags for an IPAM resource.

", + "smithy.api#xmlName": "resourceTagSet" + } + }, + "IpUsage": { + "target": "com.amazonaws.ec2#BoxedDouble", + "traits": { + "aws.protocols#ec2QueryName": "IpUsage", + "smithy.api#documentation": "

The percentage of IP address space in use. To convert the decimal to a percentage, multiply the decimal by 100. Note the following:

\n ", + "smithy.api#xmlName": "ipUsage" + } + }, + "ComplianceStatus": { + "target": "com.amazonaws.ec2#IpamComplianceStatus", + "traits": { + "aws.protocols#ec2QueryName": "ComplianceStatus", + "smithy.api#documentation": "

The compliance status of the IPAM resource. For more information on compliance statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.

", + "smithy.api#xmlName": "complianceStatus" + } + }, + "ManagementState": { + "target": "com.amazonaws.ec2#IpamManagementState", + "traits": { + "aws.protocols#ec2QueryName": "ManagementState", + "smithy.api#documentation": "

The management state of the resource. For more information about management states, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.

", + "smithy.api#xmlName": "managementState" + } + }, + "OverlapStatus": { + "target": "com.amazonaws.ec2#IpamOverlapStatus", + "traits": { + "aws.protocols#ec2QueryName": "OverlapStatus", + "smithy.api#documentation": "

The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.

", + "smithy.api#xmlName": "overlapStatus" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of a VPC.

", + "smithy.api#xmlName": "vpcId" + } + }, + "AvailabilityZoneId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZoneId", + "smithy.api#documentation": "

The Availability Zone ID.

", + "smithy.api#xmlName": "availabilityZoneId" + } + } + }, + "traits": { + "smithy.api#documentation": "

The CIDR for an IPAM resource.

" + } + }, + "com.amazonaws.ec2#IpamResourceCidrIpSource": { + "type": "enum", + "members": { + "amazon": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "amazon" + } + }, + "byoip": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "byoip" + } + }, + "none": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "none" + } + } + } + }, + "com.amazonaws.ec2#IpamResourceCidrSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IpamResourceCidr", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpamResourceDiscovery": { + "type": "structure", + "members": { + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the owner.

", + "smithy.api#xmlName": "ownerId" + } + }, + "IpamResourceDiscoveryId": { + "target": "com.amazonaws.ec2#IpamResourceDiscoveryId", + "traits": { + "aws.protocols#ec2QueryName": "IpamResourceDiscoveryId", + "smithy.api#documentation": "

The resource discovery ID.

", + "smithy.api#xmlName": "ipamResourceDiscoveryId" + } + }, + "IpamResourceDiscoveryArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IpamResourceDiscoveryArn", + "smithy.api#documentation": "

The resource discovery Amazon Resource Name (ARN).

", + "smithy.api#xmlName": "ipamResourceDiscoveryArn" + } + }, + "IpamResourceDiscoveryRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IpamResourceDiscoveryRegion", + "smithy.api#documentation": "

The resource discovery Region.

", + "smithy.api#xmlName": "ipamResourceDiscoveryRegion" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The resource discovery description.

", + "smithy.api#xmlName": "description" + } + }, + "OperatingRegions": { + "target": "com.amazonaws.ec2#IpamOperatingRegionSet", + "traits": { + "aws.protocols#ec2QueryName": "OperatingRegionSet", + "smithy.api#documentation": "

The operating Regions for the resource discovery. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

", + "smithy.api#xmlName": "operatingRegionSet" + } + }, + "IsDefault": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "IsDefault", + "smithy.api#documentation": "

Defines if the resource discovery is the default. The default resource discovery is the resource discovery automatically created when you create an IPAM.

", + "smithy.api#xmlName": "isDefault" + } + }, + "State": { + "target": "com.amazonaws.ec2#IpamResourceDiscoveryState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The lifecycle state of the resource discovery.

\n ", + "smithy.api#xmlName": "state" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.

", + "smithy.api#xmlName": "tagSet" + } + }, + "OrganizationalUnitExclusions": { + "target": "com.amazonaws.ec2#IpamOrganizationalUnitExclusionSet", + "traits": { + "aws.protocols#ec2QueryName": "OrganizationalUnitExclusionSet", + "smithy.api#documentation": "

If your IPAM is integrated with Amazon Web Services Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion.

", + "smithy.api#xmlName": "organizationalUnitExclusionSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

" + } + }, + "com.amazonaws.ec2#IpamResourceDiscoveryAssociation": { + "type": "structure", + "members": { + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The Amazon Web Services account ID of the resource discovery owner.

", + "smithy.api#xmlName": "ownerId" + } + }, + "IpamResourceDiscoveryAssociationId": { + "target": "com.amazonaws.ec2#IpamResourceDiscoveryAssociationId", + "traits": { + "aws.protocols#ec2QueryName": "IpamResourceDiscoveryAssociationId", + "smithy.api#documentation": "

The resource discovery association ID.

", + "smithy.api#xmlName": "ipamResourceDiscoveryAssociationId" + } + }, + "IpamResourceDiscoveryAssociationArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IpamResourceDiscoveryAssociationArn", + "smithy.api#documentation": "

The resource discovery association Amazon Resource Name (ARN).

", + "smithy.api#xmlName": "ipamResourceDiscoveryAssociationArn" + } + }, + "IpamResourceDiscoveryId": { + "target": "com.amazonaws.ec2#IpamResourceDiscoveryId", + "traits": { + "aws.protocols#ec2QueryName": "IpamResourceDiscoveryId", + "smithy.api#documentation": "

The resource discovery ID.

", + "smithy.api#xmlName": "ipamResourceDiscoveryId" + } + }, + "IpamId": { + "target": "com.amazonaws.ec2#IpamId", + "traits": { + "aws.protocols#ec2QueryName": "IpamId", + "smithy.api#documentation": "

The IPAM ID.

", + "smithy.api#xmlName": "ipamId" + } + }, + "IpamArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "IpamArn", + "smithy.api#documentation": "

The IPAM ARN.

", + "smithy.api#xmlName": "ipamArn" + } + }, + "IpamRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IpamRegion", + "smithy.api#documentation": "

The IPAM home Region.

", + "smithy.api#xmlName": "ipamRegion" + } + }, + "IsDefault": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "IsDefault", + "smithy.api#documentation": "

Defines if the resource discovery is the default. When you create an IPAM, a default resource discovery is created for your IPAM and it's associated with your IPAM.

", + "smithy.api#xmlName": "isDefault" + } + }, + "ResourceDiscoveryStatus": { + "target": "com.amazonaws.ec2#IpamAssociatedResourceDiscoveryStatus", + "traits": { + "aws.protocols#ec2QueryName": "ResourceDiscoveryStatus", + "smithy.api#documentation": "

The resource discovery status.

\n ", + "smithy.api#xmlName": "resourceDiscoveryStatus" + } + }, + "State": { + "target": "com.amazonaws.ec2#IpamResourceDiscoveryAssociationState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The lifecycle state of the association when you associate or disassociate a resource discovery.

\n ", + "smithy.api#xmlName": "state" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

An IPAM resource discovery association. An associated resource discovery is a resource discovery that has been associated with an IPAM. IPAM aggregates the resource CIDRs discovered by the associated resource discovery.

" + } + }, + "com.amazonaws.ec2#IpamResourceDiscoveryAssociationId": { + "type": "string" + }, + "com.amazonaws.ec2#IpamResourceDiscoveryAssociationSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IpamResourceDiscoveryAssociation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpamResourceDiscoveryAssociationState": { + "type": "enum", + "members": { + "ASSOCIATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associate-in-progress" + } + }, + "ASSOCIATE_COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associate-complete" + } + }, + "ASSOCIATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associate-failed" + } + }, + "DISASSOCIATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociate-in-progress" + } + }, + "DISASSOCIATE_COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociate-complete" + } + }, + "DISASSOCIATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociate-failed" + } + }, + "ISOLATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "isolate-in-progress" + } + }, + "ISOLATE_COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "isolate-complete" + } + }, + "RESTORE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "restore-in-progress" + } + } + } + }, + "com.amazonaws.ec2#IpamResourceDiscoveryId": { + "type": "string" + }, + "com.amazonaws.ec2#IpamResourceDiscoverySet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IpamResourceDiscovery", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpamResourceDiscoveryState": { + "type": "enum", + "members": { + "CREATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "create-in-progress" + } + }, + "CREATE_COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "create-complete" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "create-failed" + } + }, + "MODIFY_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modify-in-progress" + } + }, + "MODIFY_COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modify-complete" + } + }, + "MODIFY_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modify-failed" + } + }, + "DELETE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "delete-in-progress" + } + }, + "DELETE_COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "delete-complete" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "delete-failed" + } + }, + "ISOLATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "isolate-in-progress" + } + }, + "ISOLATE_COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "isolate-complete" + } + }, + "RESTORE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "restore-in-progress" + } + } + } + }, + "com.amazonaws.ec2#IpamResourceTag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Key", + "smithy.api#documentation": "

The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

", + "smithy.api#xmlName": "key" + } + }, + "Value": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Value", + "smithy.api#documentation": "

The value of the tag.

", + "smithy.api#xmlName": "value" + } + } + }, + "traits": { + "smithy.api#documentation": "

The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

" + } + }, + "com.amazonaws.ec2#IpamResourceTagList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IpamResourceTag", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpamResourceType": { + "type": "enum", + "members": { + "vpc": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vpc" + } + }, + "subnet": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "subnet" + } + }, + "eip": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eip" + } + }, + "public_ipv4_pool": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "public-ipv4-pool" + } + }, + "ipv6_pool": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv6-pool" + } + }, + "eni": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eni" + } + } + } + }, + "com.amazonaws.ec2#IpamScope": { + "type": "structure", + "members": { + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The Amazon Web Services account ID of the owner of the scope.

", + "smithy.api#xmlName": "ownerId" + } + }, + "IpamScopeId": { + "target": "com.amazonaws.ec2#IpamScopeId", + "traits": { + "aws.protocols#ec2QueryName": "IpamScopeId", + "smithy.api#documentation": "

The ID of the scope.

", + "smithy.api#xmlName": "ipamScopeId" + } + }, + "IpamScopeArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "IpamScopeArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the scope.

", + "smithy.api#xmlName": "ipamScopeArn" + } + }, + "IpamArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "IpamArn", + "smithy.api#documentation": "

The ARN of the IPAM.

", + "smithy.api#xmlName": "ipamArn" + } + }, + "IpamRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IpamRegion", + "smithy.api#documentation": "

The Amazon Web Services Region of the IPAM scope.

", + "smithy.api#xmlName": "ipamRegion" + } + }, + "IpamScopeType": { + "target": "com.amazonaws.ec2#IpamScopeType", + "traits": { + "aws.protocols#ec2QueryName": "IpamScopeType", + "smithy.api#documentation": "

The type of the scope.

", + "smithy.api#xmlName": "ipamScopeType" + } + }, + "IsDefault": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "IsDefault", + "smithy.api#documentation": "

Defines if the scope is the default scope or not.

", + "smithy.api#xmlName": "isDefault" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description of the scope.

", + "smithy.api#xmlName": "description" + } + }, + "PoolCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "PoolCount", + "smithy.api#documentation": "

The number of pools in the scope.

", + "smithy.api#xmlName": "poolCount" + } + }, + "State": { + "target": "com.amazonaws.ec2#IpamScopeState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the IPAM scope.

", + "smithy.api#xmlName": "state" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.

\n

For more information, see How IPAM works in the Amazon VPC IPAM User Guide.

" + } + }, + "com.amazonaws.ec2#IpamScopeId": { + "type": "string" + }, + "com.amazonaws.ec2#IpamScopeSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IpamScope", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpamScopeState": { + "type": "enum", + "members": { + "create_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "create-in-progress" + } + }, + "create_complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "create-complete" + } + }, + "create_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "create-failed" + } + }, + "modify_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modify-in-progress" + } + }, + "modify_complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modify-complete" + } + }, + "modify_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modify-failed" + } + }, + "delete_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "delete-in-progress" + } + }, + "delete_complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "delete-complete" + } + }, + "delete_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "delete-failed" + } + }, + "isolate_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "isolate-in-progress" + } + }, + "isolate_complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "isolate-complete" + } + }, + "restore_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "restore-in-progress" + } + } + } + }, + "com.amazonaws.ec2#IpamScopeType": { + "type": "enum", + "members": { + "public": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "public" + } + }, + "private": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "private" + } + } + } + }, + "com.amazonaws.ec2#IpamSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Ipam", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpamState": { + "type": "enum", + "members": { + "create_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "create-in-progress" + } + }, + "create_complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "create-complete" + } + }, + "create_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "create-failed" + } + }, + "modify_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modify-in-progress" + } + }, + "modify_complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modify-complete" + } + }, + "modify_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modify-failed" + } + }, + "delete_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "delete-in-progress" + } + }, + "delete_complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "delete-complete" + } + }, + "delete_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "delete-failed" + } + }, + "isolate_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "isolate-in-progress" + } + }, + "isolate_complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "isolate-complete" + } + }, + "restore_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "restore-in-progress" + } + } + } + }, + "com.amazonaws.ec2#IpamTier": { + "type": "enum", + "members": { + "free": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "free" + } + }, + "advanced": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "advanced" + } + } + } + }, + "com.amazonaws.ec2#Ipv4PoolCoipId": { + "type": "string" + }, + "com.amazonaws.ec2#Ipv4PoolEc2Id": { + "type": "string" + }, + "com.amazonaws.ec2#Ipv4PrefixList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Ipv4PrefixSpecificationRequest", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Ipv4PrefixListResponse": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Ipv4PrefixSpecificationResponse", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Ipv4PrefixSpecification": { + "type": "structure", + "members": { + "Ipv4Prefix": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Ipv4Prefix", + "smithy.api#documentation": "

The IPv4 prefix. For information, see \n Assigning prefixes to network interfaces in the\n Amazon EC2 User Guide.

", + "smithy.api#xmlName": "ipv4Prefix" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an IPv4 prefix.

" + } + }, + "com.amazonaws.ec2#Ipv4PrefixSpecificationRequest": { + "type": "structure", + "members": { + "Ipv4Prefix": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IPv4 prefix. For information, see \n Assigning prefixes to network interfaces in the\n Amazon EC2 User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the IPv4 prefix option for a network interface.

" + } + }, + "com.amazonaws.ec2#Ipv4PrefixSpecificationResponse": { + "type": "structure", + "members": { + "Ipv4Prefix": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Ipv4Prefix", + "smithy.api#documentation": "

The IPv4 delegated prefixes assigned to the network interface.

", + "smithy.api#xmlName": "ipv4Prefix" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the IPv4 delegated prefixes assigned \n to a network interface.

" + } + }, + "com.amazonaws.ec2#Ipv4PrefixesList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Ipv4PrefixSpecification", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Ipv6Address": { + "type": "string" + }, + "com.amazonaws.ec2#Ipv6AddressAttribute": { + "type": "enum", + "members": { + "public": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "public" + } + }, + "private": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "private" + } + } + } + }, + "com.amazonaws.ec2#Ipv6AddressList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Ipv6CidrAssociation": { + "type": "structure", + "members": { + "Ipv6Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6Cidr", + "smithy.api#documentation": "

The IPv6 CIDR block.

", + "smithy.api#xmlName": "ipv6Cidr" + } + }, + "AssociatedResource": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AssociatedResource", + "smithy.api#documentation": "

The resource that's associated with the IPv6 CIDR block.

", + "smithy.api#xmlName": "associatedResource" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an IPv6 CIDR block association.

" + } + }, + "com.amazonaws.ec2#Ipv6CidrAssociationSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Ipv6CidrAssociation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Ipv6CidrBlock": { + "type": "structure", + "members": { + "Ipv6CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6CidrBlock", + "smithy.api#documentation": "

The IPv6 CIDR block.

", + "smithy.api#xmlName": "ipv6CidrBlock" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an IPv6 CIDR block.

" + } + }, + "com.amazonaws.ec2#Ipv6CidrBlockSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Ipv6CidrBlock", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Ipv6Flag": { + "type": "boolean" + }, + "com.amazonaws.ec2#Ipv6Pool": { + "type": "structure", + "members": { + "PoolId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PoolId", + "smithy.api#documentation": "

The ID of the address pool.

", + "smithy.api#xmlName": "poolId" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description for the address pool.

", + "smithy.api#xmlName": "description" + } + }, + "PoolCidrBlocks": { + "target": "com.amazonaws.ec2#PoolCidrBlocksSet", + "traits": { + "aws.protocols#ec2QueryName": "PoolCidrBlockSet", + "smithy.api#documentation": "

The CIDR blocks for the address pool.

", + "smithy.api#xmlName": "poolCidrBlockSet" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags for the address pool.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an IPv6 address pool.

" + } + }, + "com.amazonaws.ec2#Ipv6PoolEc2Id": { + "type": "string" + }, + "com.amazonaws.ec2#Ipv6PoolIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Ipv6PoolEc2Id", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Ipv6PoolMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#Ipv6PoolSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Ipv6Pool", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Ipv6PrefixList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Ipv6PrefixSpecificationRequest", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Ipv6PrefixListResponse": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Ipv6PrefixSpecificationResponse", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Ipv6PrefixSpecification": { + "type": "structure", + "members": { + "Ipv6Prefix": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6Prefix", + "smithy.api#documentation": "

The IPv6 prefix.

", + "smithy.api#xmlName": "ipv6Prefix" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the IPv6 prefix.

" + } + }, + "com.amazonaws.ec2#Ipv6PrefixSpecificationRequest": { + "type": "structure", + "members": { + "Ipv6Prefix": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IPv6 prefix.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the IPv4 prefix option for a network interface.

" + } + }, + "com.amazonaws.ec2#Ipv6PrefixSpecificationResponse": { + "type": "structure", + "members": { + "Ipv6Prefix": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6Prefix", + "smithy.api#documentation": "

The IPv6 delegated prefixes assigned to the network interface.

", + "smithy.api#xmlName": "ipv6Prefix" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the IPv6 delegated prefixes assigned \n to a network interface.

" + } + }, + "com.amazonaws.ec2#Ipv6PrefixesList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Ipv6PrefixSpecification", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Ipv6Range": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description for the security group rule that references this IPv6 address range.

\n

Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9,\n spaces, and ._-:/()#,@[]+=&;{}!$*

", + "smithy.api#xmlName": "description" + } + }, + "CidrIpv6": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CidrIpv6", + "smithy.api#documentation": "

The IPv6 address range. You can either specify a CIDR block or a source security group,\n not both. To specify a single IPv6 address, use the /128 prefix length.

", + "smithy.api#xmlName": "cidrIpv6" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an IPv6 address range.

" + } + }, + "com.amazonaws.ec2#Ipv6RangeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Ipv6Range", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Ipv6SupportValue": { + "type": "enum", + "members": { + "enable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enable" + } + }, + "disable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disable" + } + } + } + }, + "com.amazonaws.ec2#KernelId": { + "type": "string" + }, + "com.amazonaws.ec2#KeyFormat": { + "type": "enum", + "members": { + "pem": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pem" + } + }, + "ppk": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ppk" + } + } + } + }, + "com.amazonaws.ec2#KeyNameStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#KeyPairName", + "traits": { + "smithy.api#xmlName": "KeyName" + } + } + }, + "com.amazonaws.ec2#KeyPair": { + "type": "structure", + "members": { + "KeyPairId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KeyPairId", + "smithy.api#documentation": "

The ID of the key pair.

", + "smithy.api#xmlName": "keyPairId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags applied to the key pair.

", + "smithy.api#xmlName": "tagSet" + } + }, + "KeyName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KeyName", + "smithy.api#documentation": "

The name of the key pair.

", + "smithy.api#xmlName": "keyName" + } + }, + "KeyFingerprint": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KeyFingerprint", + "smithy.api#documentation": "", + "smithy.api#xmlName": "keyFingerprint" + } + }, + "KeyMaterial": { + "target": "com.amazonaws.ec2#SensitiveUserData", + "traits": { + "aws.protocols#ec2QueryName": "KeyMaterial", + "smithy.api#documentation": "

An unencrypted PEM encoded RSA or ED25519 private key.

", + "smithy.api#xmlName": "keyMaterial" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a key pair.

" + } + }, + "com.amazonaws.ec2#KeyPairId": { + "type": "string" + }, + "com.amazonaws.ec2#KeyPairIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#KeyPairId", + "traits": { + "smithy.api#xmlName": "KeyPairId" + } + } + }, + "com.amazonaws.ec2#KeyPairInfo": { + "type": "structure", + "members": { + "KeyPairId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KeyPairId", + "smithy.api#documentation": "

The ID of the key pair.

", + "smithy.api#xmlName": "keyPairId" + } + }, + "KeyType": { + "target": "com.amazonaws.ec2#KeyType", + "traits": { + "aws.protocols#ec2QueryName": "KeyType", + "smithy.api#documentation": "

The type of key pair.

", + "smithy.api#xmlName": "keyType" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags applied to the key pair.

", + "smithy.api#xmlName": "tagSet" + } + }, + "PublicKey": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicKey", + "smithy.api#documentation": "

The public key material.

", + "smithy.api#xmlName": "publicKey" + } + }, + "CreateTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreateTime", + "smithy.api#documentation": "

If you used Amazon EC2 to create the key pair, this is the date and time when the key\n was created, in ISO\n 8601 date-time format, in the UTC time zone.

\n

If you imported an existing key pair to Amazon EC2, this is the date and time the key\n was imported, in ISO\n 8601 date-time format, in the UTC time zone.

", + "smithy.api#xmlName": "createTime" + } + }, + "KeyName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KeyName", + "smithy.api#documentation": "

The name of the key pair.

", + "smithy.api#xmlName": "keyName" + } + }, + "KeyFingerprint": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KeyFingerprint", + "smithy.api#documentation": "

If you used CreateKeyPair to create the key pair:

\n \n

If you used ImportKeyPair to provide Amazon Web Services the public key:

\n ", + "smithy.api#xmlName": "keyFingerprint" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a key pair.

" + } + }, + "com.amazonaws.ec2#KeyPairList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#KeyPairInfo", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#KeyPairName": { + "type": "string" + }, + "com.amazonaws.ec2#KeyPairNameWithResolver": { + "type": "string" + }, + "com.amazonaws.ec2#KeyType": { + "type": "enum", + "members": { + "rsa": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rsa" + } + }, + "ed25519": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ed25519" + } + } + } + }, + "com.amazonaws.ec2#KmsKeyArn": { + "type": "string" + }, + "com.amazonaws.ec2#KmsKeyId": { + "type": "string" + }, + "com.amazonaws.ec2#LastError": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

The error message for the VPC endpoint error.

", + "smithy.api#xmlName": "message" + } + }, + "Code": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The error code for the VPC endpoint error.

", + "smithy.api#xmlName": "code" + } + } + }, + "traits": { + "smithy.api#documentation": "

The last error that occurred for a VPC endpoint.

" + } + }, + "com.amazonaws.ec2#LaunchPermission": { + "type": "structure", + "members": { + "OrganizationArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OrganizationArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an organization.

", + "smithy.api#xmlName": "organizationArn" + } + }, + "OrganizationalUnitArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OrganizationalUnitArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an organizational unit (OU).

", + "smithy.api#xmlName": "organizationalUnitArn" + } + }, + "UserId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "UserId", + "smithy.api#documentation": "

The Amazon Web Services account ID.

\n

Constraints: Up to 10 000 account IDs can be specified in a single request.

", + "smithy.api#xmlName": "userId" + } + }, + "Group": { + "target": "com.amazonaws.ec2#PermissionGroup", + "traits": { + "aws.protocols#ec2QueryName": "Group", + "smithy.api#documentation": "

The name of the group.

", + "smithy.api#xmlName": "group" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a launch permission.

" + } + }, + "com.amazonaws.ec2#LaunchPermissionList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LaunchPermission", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LaunchPermissionModifications": { + "type": "structure", + "members": { + "Add": { + "target": "com.amazonaws.ec2#LaunchPermissionList", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID, organization ARN, or OU ARN to add to the list of\n launch permissions for the AMI.

" + } + }, + "Remove": { + "target": "com.amazonaws.ec2#LaunchPermissionList", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID, organization ARN, or OU ARN to remove from the list of\n launch permissions for the AMI.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a launch permission modification.

" + } + }, + "com.amazonaws.ec2#LaunchSpecification": { + "type": "structure", + "members": { + "UserData": { + "target": "com.amazonaws.ec2#SensitiveUserData", + "traits": { + "aws.protocols#ec2QueryName": "UserData", + "smithy.api#documentation": "

The base64-encoded user data that instances use when starting up. User data is limited to 16 KB.

", + "smithy.api#xmlName": "userData" + } + }, + "AddressingType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AddressingType", + "smithy.api#documentation": "

Deprecated.

", + "smithy.api#xmlName": "addressingType" + } + }, + "BlockDeviceMappings": { + "target": "com.amazonaws.ec2#BlockDeviceMappingList", + "traits": { + "aws.protocols#ec2QueryName": "BlockDeviceMapping", + "smithy.api#documentation": "

The block device mapping entries.

", + "smithy.api#xmlName": "blockDeviceMapping" + } + }, + "EbsOptimized": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EbsOptimized", + "smithy.api#documentation": "

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

\n

Default: false\n

", + "smithy.api#xmlName": "ebsOptimized" + } + }, + "IamInstanceProfile": { + "target": "com.amazonaws.ec2#IamInstanceProfileSpecification", + "traits": { + "aws.protocols#ec2QueryName": "IamInstanceProfile", + "smithy.api#documentation": "

The IAM instance profile.

", + "smithy.api#xmlName": "iamInstanceProfile" + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the AMI.

", + "smithy.api#xmlName": "imageId" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type. Only one instance type can be specified.

", + "smithy.api#xmlName": "instanceType" + } + }, + "KernelId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KernelId", + "smithy.api#documentation": "

The ID of the kernel.

", + "smithy.api#xmlName": "kernelId" + } + }, + "KeyName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KeyName", + "smithy.api#documentation": "

The name of the key pair.

", + "smithy.api#xmlName": "keyName" + } + }, + "NetworkInterfaces": { + "target": "com.amazonaws.ec2#InstanceNetworkInterfaceSpecificationList", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceSet", + "smithy.api#documentation": "

The network interfaces. If you specify a network interface, you must specify \n subnet IDs and security group IDs using the network interface.

", + "smithy.api#xmlName": "networkInterfaceSet" + } + }, + "Placement": { + "target": "com.amazonaws.ec2#SpotPlacement", + "traits": { + "aws.protocols#ec2QueryName": "Placement", + "smithy.api#documentation": "

The placement information for the instance.

", + "smithy.api#xmlName": "placement" + } + }, + "RamdiskId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RamdiskId", + "smithy.api#documentation": "

The ID of the RAM disk.

", + "smithy.api#xmlName": "ramdiskId" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet in which to launch the instance.

", + "smithy.api#xmlName": "subnetId" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.ec2#GroupIdentifierList", + "traits": { + "aws.protocols#ec2QueryName": "GroupSet", + "smithy.api#documentation": "

The IDs of the security groups.

", + "smithy.api#xmlName": "groupSet" + } + }, + "Monitoring": { + "target": "com.amazonaws.ec2#RunInstancesMonitoringEnabled", + "traits": { + "aws.protocols#ec2QueryName": "Monitoring", + "smithy.api#xmlName": "monitoring" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the launch specification for an instance.

" + } + }, + "com.amazonaws.ec2#LaunchSpecsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SpotFleetLaunchSpecification", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LaunchTemplate": { + "type": "structure", + "members": { + "LaunchTemplateId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateId", + "smithy.api#documentation": "

The ID of the launch template.

", + "smithy.api#xmlName": "launchTemplateId" + } + }, + "LaunchTemplateName": { + "target": "com.amazonaws.ec2#LaunchTemplateName", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateName", + "smithy.api#documentation": "

The name of the launch template.

", + "smithy.api#xmlName": "launchTemplateName" + } + }, + "CreateTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreateTime", + "smithy.api#documentation": "

The time launch template was created.

", + "smithy.api#xmlName": "createTime" + } + }, + "CreatedBy": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CreatedBy", + "smithy.api#documentation": "

The principal that created the launch template.

", + "smithy.api#xmlName": "createdBy" + } + }, + "DefaultVersionNumber": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "DefaultVersionNumber", + "smithy.api#documentation": "

The version number of the default version of the launch template.

", + "smithy.api#xmlName": "defaultVersionNumber" + } + }, + "LatestVersionNumber": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "LatestVersionNumber", + "smithy.api#documentation": "

The version number of the latest version of the launch template.

", + "smithy.api#xmlName": "latestVersionNumber" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags for the launch template.

", + "smithy.api#xmlName": "tagSet" + } + }, + "Operator": { + "target": "com.amazonaws.ec2#OperatorResponse", + "traits": { + "aws.protocols#ec2QueryName": "Operator", + "smithy.api#documentation": "

The entity that manages the launch template.

", + "smithy.api#xmlName": "operator" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a launch template.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateAndOverridesResponse": { + "type": "structure", + "members": { + "LaunchTemplateSpecification": { + "target": "com.amazonaws.ec2#FleetLaunchTemplateSpecification", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateSpecification", + "smithy.api#documentation": "

The launch template.

", + "smithy.api#xmlName": "launchTemplateSpecification" + } + }, + "Overrides": { + "target": "com.amazonaws.ec2#FleetLaunchTemplateOverrides", + "traits": { + "aws.protocols#ec2QueryName": "Overrides", + "smithy.api#documentation": "

Any parameters that you specify override the same parameters in the launch\n template.

", + "smithy.api#xmlName": "overrides" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a launch template and overrides.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateAutoRecoveryState": { + "type": "enum", + "members": { + "default": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "default" + } + }, + "disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + } + } + }, + "com.amazonaws.ec2#LaunchTemplateBlockDeviceMapping": { + "type": "structure", + "members": { + "DeviceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DeviceName", + "smithy.api#documentation": "

The device name.

", + "smithy.api#xmlName": "deviceName" + } + }, + "VirtualName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VirtualName", + "smithy.api#documentation": "

The virtual device name (ephemeralN).

", + "smithy.api#xmlName": "virtualName" + } + }, + "Ebs": { + "target": "com.amazonaws.ec2#LaunchTemplateEbsBlockDevice", + "traits": { + "aws.protocols#ec2QueryName": "Ebs", + "smithy.api#documentation": "

Information about the block device for an EBS volume.

", + "smithy.api#xmlName": "ebs" + } + }, + "NoDevice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NoDevice", + "smithy.api#documentation": "

To omit the device from the block device mapping, specify an empty string.

", + "smithy.api#xmlName": "noDevice" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a block device mapping.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateBlockDeviceMappingList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LaunchTemplateBlockDeviceMapping", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LaunchTemplateBlockDeviceMappingRequest": { + "type": "structure", + "members": { + "DeviceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The device name (for example, /dev/sdh or xvdh).

" + } + }, + "VirtualName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The virtual device name (ephemeralN). Instance store volumes are numbered starting\n from 0. An instance type with 2 available instance store volumes can specify mappings\n for ephemeral0 and ephemeral1. The number of available instance store volumes depends on\n the instance type. After you connect to the instance, you must mount the volume.

" + } + }, + "Ebs": { + "target": "com.amazonaws.ec2#LaunchTemplateEbsBlockDeviceRequest", + "traits": { + "smithy.api#documentation": "

Parameters used to automatically set up EBS volumes when the instance is\n launched.

" + } + }, + "NoDevice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

To omit the device from the block device mapping, specify an empty string.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a block device mapping.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateBlockDeviceMappingRequestList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LaunchTemplateBlockDeviceMappingRequest", + "traits": { + "smithy.api#xmlName": "BlockDeviceMapping" + } + } + }, + "com.amazonaws.ec2#LaunchTemplateCapacityReservationSpecificationRequest": { + "type": "structure", + "members": { + "CapacityReservationPreference": { + "target": "com.amazonaws.ec2#CapacityReservationPreference", + "traits": { + "smithy.api#documentation": "

Indicates the instance's Capacity Reservation preferences. Possible preferences\n include:

\n " + } + }, + "CapacityReservationTarget": { + "target": "com.amazonaws.ec2#CapacityReservationTarget", + "traits": { + "smithy.api#documentation": "

Information about the target Capacity Reservation or Capacity Reservation\n group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an instance's Capacity Reservation targeting option. You can specify only\n one option at a time. Use the CapacityReservationPreference parameter to\n configure the instance to run in On-Demand capacity or to run in any open\n Capacity Reservation that has matching attributes (instance type, platform, Availability\n Zone). Use the CapacityReservationTarget parameter to explicitly target a\n specific Capacity Reservation or a Capacity Reservation group.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateCapacityReservationSpecificationResponse": { + "type": "structure", + "members": { + "CapacityReservationPreference": { + "target": "com.amazonaws.ec2#CapacityReservationPreference", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationPreference", + "smithy.api#documentation": "

Indicates the instance's Capacity Reservation preferences. Possible preferences\n include:

\n ", + "smithy.api#xmlName": "capacityReservationPreference" + } + }, + "CapacityReservationTarget": { + "target": "com.amazonaws.ec2#CapacityReservationTargetResponse", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationTarget", + "smithy.api#documentation": "

Information about the target Capacity Reservation or Capacity Reservation\n group.

", + "smithy.api#xmlName": "capacityReservationTarget" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the Capacity Reservation targeting option.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateConfig": { + "type": "structure", + "members": { + "LaunchTemplateSpecification": { + "target": "com.amazonaws.ec2#FleetLaunchTemplateSpecification", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateSpecification", + "smithy.api#documentation": "

The launch template to use. Make sure that the launch template does not contain the\n NetworkInterfaceId parameter because you can't specify a network interface\n ID in a Spot Fleet.

", + "smithy.api#xmlName": "launchTemplateSpecification" + } + }, + "Overrides": { + "target": "com.amazonaws.ec2#LaunchTemplateOverridesList", + "traits": { + "aws.protocols#ec2QueryName": "Overrides", + "smithy.api#documentation": "

Any parameters that you specify override the same parameters in the launch\n template.

", + "smithy.api#xmlName": "overrides" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a launch template and overrides.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LaunchTemplateConfig", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LaunchTemplateCpuOptions": { + "type": "structure", + "members": { + "CoreCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "CoreCount", + "smithy.api#documentation": "

The number of CPU cores for the instance.

", + "smithy.api#xmlName": "coreCount" + } + }, + "ThreadsPerCore": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "ThreadsPerCore", + "smithy.api#documentation": "

The number of threads per CPU core.

", + "smithy.api#xmlName": "threadsPerCore" + } + }, + "AmdSevSnp": { + "target": "com.amazonaws.ec2#AmdSevSnpSpecification", + "traits": { + "aws.protocols#ec2QueryName": "AmdSevSnp", + "smithy.api#documentation": "

Indicates whether the instance is enabled for AMD SEV-SNP. For more information, see \n AMD SEV-SNP.

", + "smithy.api#xmlName": "amdSevSnp" + } + } + }, + "traits": { + "smithy.api#documentation": "

The CPU options for the instance.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateCpuOptionsRequest": { + "type": "structure", + "members": { + "CoreCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The number of CPU cores for the instance.

" + } + }, + "ThreadsPerCore": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The number of threads per CPU core. To disable multithreading for the instance,\n specify a value of 1. Otherwise, specify the default value of\n 2.

" + } + }, + "AmdSevSnp": { + "target": "com.amazonaws.ec2#AmdSevSnpSpecification", + "traits": { + "smithy.api#documentation": "

Indicates whether to enable the instance for AMD SEV-SNP. AMD SEV-SNP is supported \n with M6a, R6a, and C6a instance types only. For more information, see \n AMD SEV-SNP.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The CPU options for the instance. Both the core count and threads per core must be\n specified in the request.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateEbsBlockDevice": { + "type": "structure", + "members": { + "Encrypted": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Encrypted", + "smithy.api#documentation": "

Indicates whether the EBS volume is encrypted.

", + "smithy.api#xmlName": "encrypted" + } + }, + "DeleteOnTermination": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DeleteOnTermination", + "smithy.api#documentation": "

Indicates whether the EBS volume is deleted on instance termination.

", + "smithy.api#xmlName": "deleteOnTermination" + } + }, + "Iops": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Iops", + "smithy.api#documentation": "

The number of I/O operations per second (IOPS) that the volume supports.

", + "smithy.api#xmlName": "iops" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.ec2#KmsKeyId", + "traits": { + "aws.protocols#ec2QueryName": "KmsKeyId", + "smithy.api#documentation": "

Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key \n to use for EBS encryption.

", + "smithy.api#xmlName": "kmsKeyId" + } + }, + "SnapshotId": { + "target": "com.amazonaws.ec2#SnapshotId", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The ID of the snapshot.

", + "smithy.api#xmlName": "snapshotId" + } + }, + "VolumeSize": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "VolumeSize", + "smithy.api#documentation": "

The size of the volume, in GiB.

", + "smithy.api#xmlName": "volumeSize" + } + }, + "VolumeType": { + "target": "com.amazonaws.ec2#VolumeType", + "traits": { + "aws.protocols#ec2QueryName": "VolumeType", + "smithy.api#documentation": "

The volume type.

", + "smithy.api#xmlName": "volumeType" + } + }, + "Throughput": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Throughput", + "smithy.api#documentation": "

The throughput that the volume supports, in MiB/s.

", + "smithy.api#xmlName": "throughput" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a block device for an EBS volume.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateEbsBlockDeviceRequest": { + "type": "structure", + "members": { + "Encrypted": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached\n to instances that support Amazon EBS encryption. If you are creating a volume from a\n snapshot, you can't specify an encryption value.

" + } + }, + "DeleteOnTermination": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the EBS volume is deleted on instance termination.

" + } + }, + "Iops": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The number of I/O operations per second (IOPS). For gp3,\n io1, and io2 volumes, this represents the number of IOPS that\n are provisioned for the volume. For gp2 volumes, this represents the\n baseline performance of the volume and the rate at which the volume accumulates I/O\n credits for bursting.

\n

The following are the supported values for each volume type:

\n \n

For io2 volumes, you can achieve up to 256,000 IOPS on \ninstances \nbuilt on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.

\n

This parameter is supported for io1, io2, and gp3 volumes only.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.ec2#KmsKeyId", + "traits": { + "smithy.api#documentation": "

Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key \n to use for EBS encryption.

" + } + }, + "SnapshotId": { + "target": "com.amazonaws.ec2#SnapshotId", + "traits": { + "smithy.api#documentation": "

The ID of the snapshot.

" + } + }, + "VolumeSize": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume\n size. The following are the supported volumes sizes for each volume type:

\n " + } + }, + "VolumeType": { + "target": "com.amazonaws.ec2#VolumeType", + "traits": { + "smithy.api#documentation": "

The volume type. For more information, see Amazon EBS volume types in the\n Amazon EBS User Guide.

" + } + }, + "Throughput": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The throughput to provision for a gp3 volume, with a maximum of 1,000\n MiB/s.

\n

Valid Range: Minimum value of 125. Maximum value of 1000.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters for a block device for an EBS volume.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateElasticInferenceAccelerator": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of elastic inference accelerator. The possible values are eia1.medium,\n eia1.large, and eia1.xlarge.

", + "smithy.api#required": {} + } + }, + "Count": { + "target": "com.amazonaws.ec2#LaunchTemplateElasticInferenceAcceleratorCount", + "traits": { + "smithy.api#documentation": "

The number of elastic inference accelerators to attach to the instance.

\n

Default: 1

" + } + } + }, + "traits": { + "smithy.api#documentation": "\n

Amazon Elastic Inference is no longer available.

\n \n

Describes an elastic inference accelerator.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateElasticInferenceAcceleratorCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.ec2#LaunchTemplateElasticInferenceAcceleratorList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LaunchTemplateElasticInferenceAccelerator", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LaunchTemplateElasticInferenceAcceleratorResponse": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Type", + "smithy.api#documentation": "

The type of elastic inference accelerator. The possible values are eia1.medium,\n eia1.large, and eia1.xlarge.

", + "smithy.api#xmlName": "type" + } + }, + "Count": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Count", + "smithy.api#documentation": "

The number of elastic inference accelerators to attach to the instance.

\n

Default: 1

", + "smithy.api#xmlName": "count" + } + } + }, + "traits": { + "smithy.api#documentation": "\n

Amazon Elastic Inference is no longer available.

\n \n

Describes an elastic inference accelerator.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateElasticInferenceAcceleratorResponseList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LaunchTemplateElasticInferenceAcceleratorResponse", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LaunchTemplateEnaSrdSpecification": { + "type": "structure", + "members": { + "EnaSrdEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EnaSrdEnabled", + "smithy.api#documentation": "

Indicates whether ENA Express is enabled for the network interface.

", + "smithy.api#xmlName": "enaSrdEnabled" + } + }, + "EnaSrdUdpSpecification": { + "target": "com.amazonaws.ec2#LaunchTemplateEnaSrdUdpSpecification", + "traits": { + "aws.protocols#ec2QueryName": "EnaSrdUdpSpecification", + "smithy.api#documentation": "

Configures ENA Express for UDP network traffic.

", + "smithy.api#xmlName": "enaSrdUdpSpecification" + } + } + }, + "traits": { + "smithy.api#documentation": "

ENA Express uses Amazon Web Services Scalable Reliable Datagram (SRD) technology to increase the \n\t\t\tmaximum bandwidth used per stream and minimize tail latency of network traffic between EC2 instances. \n\t\t\tWith ENA Express, you can communicate between two EC2 instances in the same subnet within the same \n\t\t\taccount, or in different accounts. Both sending and receiving instances must have ENA Express enabled.

\n

To improve the reliability of network packet delivery, ENA Express reorders network packets on the \n\t\t\treceiving end by default. However, some UDP-based applications are designed to handle network packets \n\t\t\tthat are out of order to reduce the overhead for packet delivery at the network layer. When ENA Express \n\t\t\tis enabled, you can specify whether UDP network traffic uses it.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateEnaSrdUdpSpecification": { + "type": "structure", + "members": { + "EnaSrdUdpEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EnaSrdUdpEnabled", + "smithy.api#documentation": "

Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, \n\t\t\tyou must first enable ENA Express.

", + "smithy.api#xmlName": "enaSrdUdpEnabled" + } + } + }, + "traits": { + "smithy.api#documentation": "

ENA Express is compatible with both TCP and UDP transport protocols. When it's enabled, TCP traffic \n\t\t\tautomatically uses it. However, some UDP-based applications are designed to handle network packets that are \n\t\t\tout of order, without a need for retransmission, such as live video broadcasting or other near-real-time \n\t\t\tapplications. For UDP traffic, you can specify whether to use ENA Express, based on your application \n\t\t\tenvironment needs.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateEnclaveOptions": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Enabled", + "smithy.api#documentation": "

If this parameter is set to true, the instance is enabled for Amazon Web Services Nitro\n Enclaves; otherwise, it is not enabled for Amazon Web Services Nitro Enclaves.

", + "smithy.api#xmlName": "enabled" + } + } + }, + "traits": { + "smithy.api#documentation": "

Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateEnclaveOptionsRequest": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to\n true.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more\n information, see What is Amazon Web Services Nitro Enclaves?\n in the Amazon Web Services Nitro Enclaves User Guide.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateErrorCode": { + "type": "enum", + "members": { + "LAUNCH_TEMPLATE_ID_DOES_NOT_EXIST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "launchTemplateIdDoesNotExist" + } + }, + "LAUNCH_TEMPLATE_ID_MALFORMED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "launchTemplateIdMalformed" + } + }, + "LAUNCH_TEMPLATE_NAME_DOES_NOT_EXIST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "launchTemplateNameDoesNotExist" + } + }, + "LAUNCH_TEMPLATE_NAME_MALFORMED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "launchTemplateNameMalformed" + } + }, + "LAUNCH_TEMPLATE_VERSION_DOES_NOT_EXIST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "launchTemplateVersionDoesNotExist" + } + }, + "UNEXPECTED_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unexpectedError" + } + } + } + }, + "com.amazonaws.ec2#LaunchTemplateHibernationOptions": { + "type": "structure", + "members": { + "Configured": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Configured", + "smithy.api#documentation": "

If this parameter is set to true, the instance is enabled for\n hibernation; otherwise, it is not enabled for hibernation.

", + "smithy.api#xmlName": "configured" + } + } + }, + "traits": { + "smithy.api#documentation": "

Indicates whether an instance is configured for hibernation.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateHibernationOptionsRequest": { + "type": "structure", + "members": { + "Configured": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

If you set this parameter to true, the instance is enabled for\n hibernation.

\n

Default: false\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Indicates whether the instance is configured for hibernation. This parameter is valid\n only if the instance meets the hibernation\n prerequisites.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateHttpTokensState": { + "type": "enum", + "members": { + "optional": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "optional" + } + }, + "required": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "required" + } + } + } + }, + "com.amazonaws.ec2#LaunchTemplateIamInstanceProfileSpecification": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Arn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the instance profile.

", + "smithy.api#xmlName": "arn" + } + }, + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Name", + "smithy.api#documentation": "

The name of the instance profile.

", + "smithy.api#xmlName": "name" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an IAM instance profile.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateIamInstanceProfileSpecificationRequest": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the instance profile.

" + } + }, + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the instance profile.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An IAM instance profile.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateId": { + "type": "string" + }, + "com.amazonaws.ec2#LaunchTemplateIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LaunchTemplateId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LaunchTemplateInstanceMaintenanceOptions": { + "type": "structure", + "members": { + "AutoRecovery": { + "target": "com.amazonaws.ec2#LaunchTemplateAutoRecoveryState", + "traits": { + "aws.protocols#ec2QueryName": "AutoRecovery", + "smithy.api#documentation": "

Disables the automatic recovery behavior of your instance or sets it to\n default.

", + "smithy.api#xmlName": "autoRecovery" + } + } + }, + "traits": { + "smithy.api#documentation": "

The maintenance options of your instance.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateInstanceMaintenanceOptionsRequest": { + "type": "structure", + "members": { + "AutoRecovery": { + "target": "com.amazonaws.ec2#LaunchTemplateAutoRecoveryState", + "traits": { + "smithy.api#documentation": "

Disables the automatic recovery behavior of your instance or sets it to default. For\n more information, see Simplified automatic recovery.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The maintenance options of your instance.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateInstanceMarketOptions": { + "type": "structure", + "members": { + "MarketType": { + "target": "com.amazonaws.ec2#MarketType", + "traits": { + "aws.protocols#ec2QueryName": "MarketType", + "smithy.api#documentation": "

The market type.

", + "smithy.api#xmlName": "marketType" + } + }, + "SpotOptions": { + "target": "com.amazonaws.ec2#LaunchTemplateSpotMarketOptions", + "traits": { + "aws.protocols#ec2QueryName": "SpotOptions", + "smithy.api#documentation": "

The options for Spot Instances.

", + "smithy.api#xmlName": "spotOptions" + } + } + }, + "traits": { + "smithy.api#documentation": "

The market (purchasing) option for the instances.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateInstanceMarketOptionsRequest": { + "type": "structure", + "members": { + "MarketType": { + "target": "com.amazonaws.ec2#MarketType", + "traits": { + "smithy.api#documentation": "

The market type.

" + } + }, + "SpotOptions": { + "target": "com.amazonaws.ec2#LaunchTemplateSpotMarketOptionsRequest", + "traits": { + "smithy.api#documentation": "

The options for Spot Instances.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The market (purchasing) option for the instances.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateInstanceMetadataEndpointState": { + "type": "enum", + "members": { + "disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + }, + "enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + } + } + }, + "com.amazonaws.ec2#LaunchTemplateInstanceMetadataOptions": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataOptionsState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the metadata option changes.

\n

\n pending - The metadata options are being updated and the instance is not\n ready to process metadata traffic with the new selection.

\n

\n applied - The metadata options have been successfully applied on the\n instance.

", + "smithy.api#xmlName": "state" + } + }, + "HttpTokens": { + "target": "com.amazonaws.ec2#LaunchTemplateHttpTokensState", + "traits": { + "aws.protocols#ec2QueryName": "HttpTokens", + "smithy.api#documentation": "

Indicates whether IMDSv2 is required.

\n ", + "smithy.api#xmlName": "httpTokens" + } + }, + "HttpPutResponseHopLimit": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "HttpPutResponseHopLimit", + "smithy.api#documentation": "

The desired HTTP PUT response hop limit for instance metadata requests. The larger the\n number, the further instance metadata requests can travel.

\n

Default: 1

\n

Possible values: Integers from 1 to 64

", + "smithy.api#xmlName": "httpPutResponseHopLimit" + } + }, + "HttpEndpoint": { + "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataEndpointState", + "traits": { + "aws.protocols#ec2QueryName": "HttpEndpoint", + "smithy.api#documentation": "

Enables or disables the HTTP metadata endpoint on your instances. If the parameter is\n not specified, the default state is enabled.

\n \n

If you specify a value of disabled, you will not be able to access\n your instance metadata.

\n ", + "smithy.api#xmlName": "httpEndpoint" + } + }, + "HttpProtocolIpv6": { + "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataProtocolIpv6", + "traits": { + "aws.protocols#ec2QueryName": "HttpProtocolIpv6", + "smithy.api#documentation": "

Enables or disables the IPv6 endpoint for the instance metadata service.

\n

Default: disabled\n

", + "smithy.api#xmlName": "httpProtocolIpv6" + } + }, + "InstanceMetadataTags": { + "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataTagsState", + "traits": { + "aws.protocols#ec2QueryName": "InstanceMetadataTags", + "smithy.api#documentation": "

Set to enabled to allow access to instance tags from the instance\n metadata. Set to disabled to turn off access to instance tags from the\n instance metadata. For more information, see Work with\n instance tags using the instance metadata.

\n

Default: disabled\n

", + "smithy.api#xmlName": "instanceMetadataTags" + } + } + }, + "traits": { + "smithy.api#documentation": "

The metadata options for the instance. For more information, see Instance metadata and user data in the\n Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateInstanceMetadataOptionsRequest": { + "type": "structure", + "members": { + "HttpTokens": { + "target": "com.amazonaws.ec2#LaunchTemplateHttpTokensState", + "traits": { + "smithy.api#documentation": "

Indicates whether IMDSv2 is required.

\n \n

Default: If the value of ImdsSupport for the Amazon Machine Image (AMI) \n for your instance is v2.0, the default is required.

" + } + }, + "HttpPutResponseHopLimit": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The desired HTTP PUT response hop limit for instance metadata requests. The larger the\n number, the further instance metadata requests can travel.

\n

Default: 1\n

\n

Possible values: Integers from 1 to 64

" + } + }, + "HttpEndpoint": { + "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataEndpointState", + "traits": { + "smithy.api#documentation": "

Enables or disables the HTTP metadata endpoint on your instances. If the parameter is\n not specified, the default state is enabled.

\n \n

If you specify a value of disabled, you will not be able to access\n your instance metadata.

\n " + } + }, + "HttpProtocolIpv6": { + "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataProtocolIpv6", + "traits": { + "smithy.api#documentation": "

Enables or disables the IPv6 endpoint for the instance metadata service.

\n

Default: disabled\n

" + } + }, + "InstanceMetadataTags": { + "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataTagsState", + "traits": { + "smithy.api#documentation": "

Set to enabled to allow access to instance tags from the instance\n metadata. Set to disabled to turn off access to instance tags from the\n instance metadata. For more information, see Work with\n instance tags using the instance metadata.

\n

Default: disabled\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The metadata options for the instance. For more information, see Instance metadata and user data in the\n Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateInstanceMetadataOptionsState": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "applied": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "applied" + } + } + } + }, + "com.amazonaws.ec2#LaunchTemplateInstanceMetadataProtocolIpv6": { + "type": "enum", + "members": { + "disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + }, + "enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + } + } + }, + "com.amazonaws.ec2#LaunchTemplateInstanceMetadataTagsState": { + "type": "enum", + "members": { + "disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + }, + "enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + } + } + }, + "com.amazonaws.ec2#LaunchTemplateInstanceNetworkInterfaceSpecification": { + "type": "structure", + "members": { + "AssociateCarrierIpAddress": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "AssociateCarrierIpAddress", + "smithy.api#documentation": "

Indicates whether to associate a Carrier IP address with eth0 for a new network\n interface.

\n

Use this option when you launch an instance in a Wavelength Zone and want to associate\n a Carrier IP address with the network interface. For more information about Carrier IP\n addresses, see Carrier IP addresses in the Wavelength Developer\n Guide.

", + "smithy.api#xmlName": "associateCarrierIpAddress" + } + }, + "AssociatePublicIpAddress": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "AssociatePublicIpAddress", + "smithy.api#documentation": "

Indicates whether to associate a public IPv4 address with eth0 for a new network\n interface.

\n

Amazon Web Services charges for all public IPv4 addresses, including public IPv4 addresses \nassociated with running instances and Elastic IP addresses. For more information, see the Public IPv4 Address tab on the Amazon VPC pricing page.

", + "smithy.api#xmlName": "associatePublicIpAddress" + } + }, + "DeleteOnTermination": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DeleteOnTermination", + "smithy.api#documentation": "

Indicates whether the network interface is deleted when the instance is\n terminated.

", + "smithy.api#xmlName": "deleteOnTermination" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description for the network interface.

", + "smithy.api#xmlName": "description" + } + }, + "DeviceIndex": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "DeviceIndex", + "smithy.api#documentation": "

The device index for the network interface attachment.

", + "smithy.api#xmlName": "deviceIndex" + } + }, + "Groups": { + "target": "com.amazonaws.ec2#GroupIdStringList", + "traits": { + "aws.protocols#ec2QueryName": "GroupSet", + "smithy.api#documentation": "

The IDs of one or more security groups.

", + "smithy.api#xmlName": "groupSet" + } + }, + "InterfaceType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InterfaceType", + "smithy.api#documentation": "

The type of network interface.

", + "smithy.api#xmlName": "interfaceType" + } + }, + "Ipv6AddressCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6AddressCount", + "smithy.api#documentation": "

The number of IPv6 addresses for the network interface.

", + "smithy.api#xmlName": "ipv6AddressCount" + } + }, + "Ipv6Addresses": { + "target": "com.amazonaws.ec2#InstanceIpv6AddressList", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6AddressesSet", + "smithy.api#documentation": "

The IPv6 addresses for the network interface.

", + "smithy.api#xmlName": "ipv6AddressesSet" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddress", + "smithy.api#documentation": "

The primary private IPv4 address of the network interface.

", + "smithy.api#xmlName": "privateIpAddress" + } + }, + "PrivateIpAddresses": { + "target": "com.amazonaws.ec2#PrivateIpAddressSpecificationList", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddressesSet", + "smithy.api#documentation": "

One or more private IPv4 addresses.

", + "smithy.api#xmlName": "privateIpAddressesSet" + } + }, + "SecondaryPrivateIpAddressCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "SecondaryPrivateIpAddressCount", + "smithy.api#documentation": "

The number of secondary private IPv4 addresses for the network interface.

", + "smithy.api#xmlName": "secondaryPrivateIpAddressCount" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet for the network interface.

", + "smithy.api#xmlName": "subnetId" + } + }, + "NetworkCardIndex": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "NetworkCardIndex", + "smithy.api#documentation": "

The index of the network card.

", + "smithy.api#xmlName": "networkCardIndex" + } + }, + "Ipv4Prefixes": { + "target": "com.amazonaws.ec2#Ipv4PrefixListResponse", + "traits": { + "aws.protocols#ec2QueryName": "Ipv4PrefixSet", + "smithy.api#documentation": "

One or more IPv4 prefixes assigned to the network interface.

", + "smithy.api#xmlName": "ipv4PrefixSet" + } + }, + "Ipv4PrefixCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Ipv4PrefixCount", + "smithy.api#documentation": "

The number of IPv4 prefixes that Amazon Web Services automatically assigned to the network\n interface.

", + "smithy.api#xmlName": "ipv4PrefixCount" + } + }, + "Ipv6Prefixes": { + "target": "com.amazonaws.ec2#Ipv6PrefixListResponse", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6PrefixSet", + "smithy.api#documentation": "

One or more IPv6 prefixes assigned to the network interface.

", + "smithy.api#xmlName": "ipv6PrefixSet" + } + }, + "Ipv6PrefixCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6PrefixCount", + "smithy.api#documentation": "

The number of IPv6 prefixes that Amazon Web Services automatically assigned to the network\n interface.

", + "smithy.api#xmlName": "ipv6PrefixCount" + } + }, + "PrimaryIpv6": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "PrimaryIpv6", + "smithy.api#documentation": "

The primary IPv6 address of the network interface. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information about primary IPv6 addresses, see RunInstances.

", + "smithy.api#xmlName": "primaryIpv6" + } + }, + "EnaSrdSpecification": { + "target": "com.amazonaws.ec2#LaunchTemplateEnaSrdSpecification", + "traits": { + "aws.protocols#ec2QueryName": "EnaSrdSpecification", + "smithy.api#documentation": "

Contains the ENA Express settings for instances launched from your launch template.

", + "smithy.api#xmlName": "enaSrdSpecification" + } + }, + "ConnectionTrackingSpecification": { + "target": "com.amazonaws.ec2#ConnectionTrackingSpecification", + "traits": { + "aws.protocols#ec2QueryName": "ConnectionTrackingSpecification", + "smithy.api#documentation": "

A security group connection tracking specification that enables you to set the timeout\n for connection tracking on an Elastic network interface. For more information, see\n Idle connection tracking timeout in the\n Amazon EC2 User Guide.

", + "smithy.api#xmlName": "connectionTrackingSpecification" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a network interface.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateInstanceNetworkInterfaceSpecificationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LaunchTemplateInstanceNetworkInterfaceSpecification", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LaunchTemplateInstanceNetworkInterfaceSpecificationRequest": { + "type": "structure", + "members": { + "AssociateCarrierIpAddress": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Associates a Carrier IP address with eth0 for a new network interface.

\n

Use this option when you launch an instance in a Wavelength Zone and want to associate\n a Carrier IP address with the network interface. For more information about Carrier IP\n addresses, see Carrier IP addresses in the Wavelength Developer\n Guide.

" + } + }, + "AssociatePublicIpAddress": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Associates a public IPv4 address with eth0 for a new network interface.

\n

Amazon Web Services charges for all public IPv4 addresses, including public IPv4 addresses \nassociated with running instances and Elastic IP addresses. For more information, see the Public IPv4 Address tab on the Amazon VPC pricing page.

" + } + }, + "DeleteOnTermination": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the network interface is deleted when the instance is\n terminated.

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description for the network interface.

" + } + }, + "DeviceIndex": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The device index for the network interface attachment. Each network interface requires\n a device index. If you create a launch template that includes secondary network interfaces \n but not a primary network interface, then you must add a primary network interface as a \n launch parameter when you launch an instance from the template.

" + } + }, + "Groups": { + "target": "com.amazonaws.ec2#SecurityGroupIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of one or more security groups.

", + "smithy.api#xmlName": "SecurityGroupId" + } + }, + "InterfaceType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The type of network interface. To create an Elastic Fabric Adapter (EFA), specify\n efa or efa. For more information, see Elastic Fabric Adapter in the\n Amazon EC2 User Guide.

\n

If you are not creating an EFA, specify interface or omit this\n parameter.

\n

If you specify efa-only, do not assign any IP addresses to the network \n interface. EFA-only network interfaces do not support IP addresses.

\n

Valid values: interface | efa | efa-only\n

" + } + }, + "Ipv6AddressCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The number of IPv6 addresses to assign to a network interface. Amazon EC2\n automatically selects the IPv6 addresses from the subnet range. You can't use this\n option if specifying specific IPv6 addresses.

" + } + }, + "Ipv6Addresses": { + "target": "com.amazonaws.ec2#InstanceIpv6AddressListRequest", + "traits": { + "smithy.api#documentation": "

One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You\n can't use this option if you're specifying a number of IPv6 addresses.

" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "smithy.api#documentation": "

The ID of the network interface.

" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The primary private IPv4 address of the network interface.

" + } + }, + "PrivateIpAddresses": { + "target": "com.amazonaws.ec2#PrivateIpAddressSpecificationList", + "traits": { + "smithy.api#documentation": "

One or more private IPv4 addresses.

" + } + }, + "SecondaryPrivateIpAddressCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The number of secondary private IPv4 addresses to assign to a network\n interface.

" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "smithy.api#documentation": "

The ID of the subnet for the network interface.

" + } + }, + "NetworkCardIndex": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The index of the network card. Some instance types support multiple network cards. The\n primary network interface must be assigned to network card index 0. The default is\n network card index 0.

" + } + }, + "Ipv4Prefixes": { + "target": "com.amazonaws.ec2#Ipv4PrefixList", + "traits": { + "smithy.api#documentation": "

One or more IPv4 prefixes to be assigned to the network interface. You cannot use this\n option if you use the Ipv4PrefixCount option.

", + "smithy.api#xmlName": "Ipv4Prefix" + } + }, + "Ipv4PrefixCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The number of IPv4 prefixes to be automatically assigned to the network interface. You\n cannot use this option if you use the Ipv4Prefix option.

" + } + }, + "Ipv6Prefixes": { + "target": "com.amazonaws.ec2#Ipv6PrefixList", + "traits": { + "smithy.api#documentation": "

One or more IPv6 prefixes to be assigned to the network interface. You cannot use this\n option if you use the Ipv6PrefixCount option.

", + "smithy.api#xmlName": "Ipv6Prefix" + } + }, + "Ipv6PrefixCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The number of IPv6 prefixes to be automatically assigned to the network interface. You\n cannot use this option if you use the Ipv6Prefix option.

" + } + }, + "PrimaryIpv6": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

The primary IPv6 address of the network interface. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information about primary IPv6 addresses, see RunInstances.

" + } + }, + "EnaSrdSpecification": { + "target": "com.amazonaws.ec2#EnaSrdSpecificationRequest", + "traits": { + "smithy.api#documentation": "

Configure ENA Express settings for your launch template.

" + } + }, + "ConnectionTrackingSpecification": { + "target": "com.amazonaws.ec2#ConnectionTrackingSpecificationRequest", + "traits": { + "smithy.api#documentation": "

A security group connection tracking specification that enables you to set the timeout\n for connection tracking on an Elastic network interface. For more information, see\n Idle connection tracking timeout in the\n Amazon EC2 User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters for a network interface.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateInstanceNetworkInterfaceSpecificationRequestList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LaunchTemplateInstanceNetworkInterfaceSpecificationRequest", + "traits": { + "smithy.api#xmlName": "InstanceNetworkInterfaceSpecification" + } + } + }, + "com.amazonaws.ec2#LaunchTemplateLicenseConfiguration": { + "type": "structure", + "members": { + "LicenseConfigurationArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LicenseConfigurationArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the license configuration.

", + "smithy.api#xmlName": "licenseConfigurationArn" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a license configuration.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateLicenseConfigurationRequest": { + "type": "structure", + "members": { + "LicenseConfigurationArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the license configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a license configuration.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateLicenseList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LaunchTemplateLicenseConfiguration", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LaunchTemplateLicenseSpecificationListRequest": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LaunchTemplateLicenseConfigurationRequest", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LaunchTemplateName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\(\\)\\.\\-/_]+$" + } + }, + "com.amazonaws.ec2#LaunchTemplateNameStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LaunchTemplateName", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LaunchTemplateNetworkPerformanceOptions": { + "type": "structure", + "members": { + "BandwidthWeighting": { + "target": "com.amazonaws.ec2#InstanceBandwidthWeighting", + "traits": { + "aws.protocols#ec2QueryName": "BandwidthWeighting", + "smithy.api#documentation": "

When you configure network bandwidth weighting, you can boost baseline bandwidth for either networking \n \t\tor EBS by up to 25%. The total available baseline bandwidth for your instance remains \n the same. The default option uses the standard bandwidth configuration for your instance type.

", + "smithy.api#xmlName": "bandwidthWeighting" + } + } + }, + "traits": { + "smithy.api#documentation": "

With network performance options, you can adjust your bandwidth preferences to meet \n \t\tthe needs of the workload that runs on your instance at launch.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateNetworkPerformanceOptionsRequest": { + "type": "structure", + "members": { + "BandwidthWeighting": { + "target": "com.amazonaws.ec2#InstanceBandwidthWeighting", + "traits": { + "smithy.api#documentation": "

Specify the bandwidth weighting option to boost the associated type of baseline bandwidth, as follows:

\n
\n
default
\n
\n

This option uses the standard bandwidth configuration for your instance type.

\n
\n
vpc-1
\n
\n

This option boosts your networking baseline bandwidth and reduces your EBS \n \t\t\t\t\tbaseline bandwidth.

\n
\n
ebs-1
\n
\n

This option boosts your EBS baseline bandwidth and reduces your networking \n \t\t\t\t\tbaseline bandwidth.

\n
\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

When you configure network performance options in your launch template, your instance \n \t\tis geared for performance improvements based on the workload that it runs as soon as it's \n \t\tavailable.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateOverrides": { + "type": "structure", + "members": { + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type.

", + "smithy.api#xmlName": "instanceType" + } + }, + "SpotPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SpotPrice", + "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to \n increased interruptions. If you do not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.

\n ", + "smithy.api#xmlName": "spotPrice" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet in which to launch the instances.

", + "smithy.api#xmlName": "subnetId" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone in which to launch the instances.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "WeightedCapacity": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "WeightedCapacity", + "smithy.api#documentation": "

The number of units provided by the specified instance type. These are the same units\n that you chose to set the target capacity in terms of instances, or a performance\n characteristic such as vCPUs, memory, or I/O.

\n

If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the\n number of instances to the next whole number. If this value is not specified, the default\n is 1.

\n \n

When specifying weights, the price used in the lowestPrice and\n priceCapacityOptimized allocation strategies is per\n unit hour (where the instance price is divided by the specified\n weight). However, if all the specified weights are above the requested\n TargetCapacity, resulting in only 1 instance being launched, the price\n used is per instance hour.

\n ", + "smithy.api#xmlName": "weightedCapacity" + } + }, + "Priority": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "Priority", + "smithy.api#documentation": "

The priority for the launch template override. The highest priority is launched\n first.

\n

If OnDemandAllocationStrategy is set to prioritized, Spot Fleet\n uses priority to determine which launch template override to use first in fulfilling\n On-Demand capacity.

\n

If the Spot AllocationStrategy is set to\n capacityOptimizedPrioritized, Spot Fleet uses priority on a best-effort basis\n to determine which launch template override to use in fulfilling Spot capacity, but\n optimizes for capacity first.

\n

Valid values are whole numbers starting at 0. The lower the number, the\n higher the priority. If no number is set, the launch template override has the lowest\n priority. You can set the same priority for different launch template overrides.

", + "smithy.api#xmlName": "priority" + } + }, + "InstanceRequirements": { + "target": "com.amazonaws.ec2#InstanceRequirements", + "traits": { + "aws.protocols#ec2QueryName": "InstanceRequirements", + "smithy.api#documentation": "

The instance requirements. When you specify instance requirements, Amazon EC2 will identify\n instance types with the provided requirements, and then use your On-Demand and Spot\n allocation strategies to launch instances from these instance types, in the same way as\n when you specify a list of instance types.

\n \n

If you specify InstanceRequirements, you can't specify\n InstanceType.

\n ", + "smithy.api#xmlName": "instanceRequirements" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes overrides for a launch template.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateOverridesList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LaunchTemplateOverrides", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LaunchTemplatePlacement": { + "type": "structure", + "members": { + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone of the instance.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "Affinity": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Affinity", + "smithy.api#documentation": "

The affinity setting for the instance on the Dedicated Host.

", + "smithy.api#xmlName": "affinity" + } + }, + "GroupName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupName", + "smithy.api#documentation": "

The name of the placement group for the instance.

", + "smithy.api#xmlName": "groupName" + } + }, + "HostId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "HostId", + "smithy.api#documentation": "

The ID of the Dedicated Host for the instance.

", + "smithy.api#xmlName": "hostId" + } + }, + "Tenancy": { + "target": "com.amazonaws.ec2#Tenancy", + "traits": { + "aws.protocols#ec2QueryName": "Tenancy", + "smithy.api#documentation": "

The tenancy of the instance. An instance with a\n tenancy of dedicated runs on single-tenant hardware.

", + "smithy.api#xmlName": "tenancy" + } + }, + "SpreadDomain": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SpreadDomain", + "smithy.api#documentation": "

Reserved for future use.

", + "smithy.api#xmlName": "spreadDomain" + } + }, + "HostResourceGroupArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "HostResourceGroupArn", + "smithy.api#documentation": "

The ARN of the host resource group in which to launch the instances.

", + "smithy.api#xmlName": "hostResourceGroupArn" + } + }, + "PartitionNumber": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "PartitionNumber", + "smithy.api#documentation": "

The number of the partition the instance should launch in. Valid only if the placement\n group strategy is set to partition.

", + "smithy.api#xmlName": "partitionNumber" + } + }, + "GroupId": { + "target": "com.amazonaws.ec2#PlacementGroupId", + "traits": { + "aws.protocols#ec2QueryName": "GroupId", + "smithy.api#documentation": "

The Group ID of the placement group. You must specify the Placement Group Group ID to launch an instance in a shared placement\n group.

", + "smithy.api#xmlName": "groupId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the placement of an instance.

" + } + }, + "com.amazonaws.ec2#LaunchTemplatePlacementRequest": { + "type": "structure", + "members": { + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone for the instance.

" + } + }, + "Affinity": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The affinity setting for an instance on a Dedicated Host.

" + } + }, + "GroupName": { + "target": "com.amazonaws.ec2#PlacementGroupName", + "traits": { + "smithy.api#documentation": "

The name of the placement group for the instance.

" + } + }, + "HostId": { + "target": "com.amazonaws.ec2#DedicatedHostId", + "traits": { + "smithy.api#documentation": "

The ID of the Dedicated Host for the instance.

" + } + }, + "Tenancy": { + "target": "com.amazonaws.ec2#Tenancy", + "traits": { + "smithy.api#documentation": "

The tenancy of the instance. An instance with a\n tenancy of dedicated runs on single-tenant hardware.

" + } + }, + "SpreadDomain": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

" + } + }, + "HostResourceGroupArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ARN of the host resource group in which to launch the instances. If you specify a\n host resource group ARN, omit the Tenancy parameter or\n set it to host.

" + } + }, + "PartitionNumber": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The number of the partition the instance should launch in. Valid only if the placement\n group strategy is set to partition.

" + } + }, + "GroupId": { + "target": "com.amazonaws.ec2#PlacementGroupId", + "traits": { + "smithy.api#documentation": "

The Group Id of a placement group. You must specify the Placement Group Group Id to launch an instance in a shared placement\n group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the placement of an instance.

" + } + }, + "com.amazonaws.ec2#LaunchTemplatePrivateDnsNameOptions": { + "type": "structure", + "members": { + "HostnameType": { + "target": "com.amazonaws.ec2#HostnameType", + "traits": { + "aws.protocols#ec2QueryName": "HostnameType", + "smithy.api#documentation": "

The type of hostname to assign to an instance.

", + "smithy.api#xmlName": "hostnameType" + } + }, + "EnableResourceNameDnsARecord": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EnableResourceNameDnsARecord", + "smithy.api#documentation": "

Indicates whether to respond to DNS queries for instance hostnames with DNS A\n records.

", + "smithy.api#xmlName": "enableResourceNameDnsARecord" + } + }, + "EnableResourceNameDnsAAAARecord": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EnableResourceNameDnsAAAARecord", + "smithy.api#documentation": "

Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA\n records.

", + "smithy.api#xmlName": "enableResourceNameDnsAAAARecord" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the options for instance hostnames.

" + } + }, + "com.amazonaws.ec2#LaunchTemplatePrivateDnsNameOptionsRequest": { + "type": "structure", + "members": { + "HostnameType": { + "target": "com.amazonaws.ec2#HostnameType", + "traits": { + "smithy.api#documentation": "

The type of hostname for Amazon EC2 instances. For IPv4 only subnets, an instance DNS name\n must be based on the instance IPv4 address. For IPv6 native subnets, an instance DNS\n name must be based on the instance ID. For dual-stack subnets, you can specify whether\n DNS names use the instance IPv4 address or the instance ID.

" + } + }, + "EnableResourceNameDnsARecord": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether to respond to DNS queries for instance hostnames with DNS A\n records.

" + } + }, + "EnableResourceNameDnsAAAARecord": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA\n records.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the options for instance hostnames.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LaunchTemplate", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LaunchTemplateSpecification": { + "type": "structure", + "members": { + "LaunchTemplateId": { + "target": "com.amazonaws.ec2#LaunchTemplateId", + "traits": { + "smithy.api#documentation": "

The ID of the launch template.

\n

You must specify either the launch template ID or the\n launch template name, but not both.

" + } + }, + "LaunchTemplateName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the launch template.

\n

You must specify either the launch template ID or the\n launch template name, but not both.

" + } + }, + "Version": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The launch template version number, $Latest, or\n $Default.

\n

A value of $Latest uses the latest version of the launch template.

\n

A value of $Default uses the default version of the launch template.

\n

Default: The default version of the launch template.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the launch template to use.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateSpotMarketOptions": { + "type": "structure", + "members": { + "MaxPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "MaxPrice", + "smithy.api#documentation": "

The maximum hourly price you're willing to pay for the Spot Instances. We do not\n recommend using this parameter because it can lead to increased interruptions. If you do\n not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your Spot Instances will be interrupted more\n frequently than if you do not specify this parameter.

\n ", + "smithy.api#xmlName": "maxPrice" + } + }, + "SpotInstanceType": { + "target": "com.amazonaws.ec2#SpotInstanceType", + "traits": { + "aws.protocols#ec2QueryName": "SpotInstanceType", + "smithy.api#documentation": "

The Spot Instance request type.

", + "smithy.api#xmlName": "spotInstanceType" + } + }, + "BlockDurationMinutes": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "BlockDurationMinutes", + "smithy.api#documentation": "

The required duration for the Spot Instances (also known as Spot blocks), in minutes.\n This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).

", + "smithy.api#xmlName": "blockDurationMinutes" + } + }, + "ValidUntil": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "ValidUntil", + "smithy.api#documentation": "

The end date of the request. For a one-time request, the request remains active until\n all instances launch, the request is canceled, or this date is reached. If the request\n is persistent, it remains active until it is canceled or this date and time is\n reached.

", + "smithy.api#xmlName": "validUntil" + } + }, + "InstanceInterruptionBehavior": { + "target": "com.amazonaws.ec2#InstanceInterruptionBehavior", + "traits": { + "aws.protocols#ec2QueryName": "InstanceInterruptionBehavior", + "smithy.api#documentation": "

The behavior when a Spot Instance is interrupted.

", + "smithy.api#xmlName": "instanceInterruptionBehavior" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options for Spot Instances.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateSpotMarketOptionsRequest": { + "type": "structure", + "members": { + "MaxPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The maximum hourly price you're willing to pay for the Spot Instances. We do not\n recommend using this parameter because it can lead to increased interruptions. If you do\n not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your Spot Instances will be interrupted more\n frequently than if you do not specify this parameter.

\n " + } + }, + "SpotInstanceType": { + "target": "com.amazonaws.ec2#SpotInstanceType", + "traits": { + "smithy.api#documentation": "

The Spot Instance request type.

" + } + }, + "BlockDurationMinutes": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

Deprecated.

" + } + }, + "ValidUntil": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "smithy.api#documentation": "

The end date of the request, in UTC format\n (YYYY-MM-DDTHH:MM:SSZ). Supported only for\n persistent requests.

\n \n

Default: 7 days from the current date

" + } + }, + "InstanceInterruptionBehavior": { + "target": "com.amazonaws.ec2#InstanceInterruptionBehavior", + "traits": { + "smithy.api#documentation": "

The behavior when a Spot Instance is interrupted. The default is\n terminate.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options for Spot Instances.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateTagSpecification": { + "type": "structure", + "members": { + "ResourceType": { + "target": "com.amazonaws.ec2#ResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The type of resource to tag.

", + "smithy.api#xmlName": "resourceType" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags for the resource.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

The tags specification for the launch template.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateTagSpecificationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LaunchTemplateTagSpecification", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LaunchTemplateTagSpecificationRequest": { + "type": "structure", + "members": { + "ResourceType": { + "target": "com.amazonaws.ec2#ResourceType", + "traits": { + "smithy.api#documentation": "

The type of resource to tag.

\n

Valid Values lists all resource types for Amazon EC2 that can be tagged. When\n you create a launch template, you can specify tags for the following resource types\n only: instance | volume |\n network-interface | spot-instances-request.\n If the instance does not include the resource type that you specify, the instance \n launch fails. For example, not all instance types include a volume.

\n

To tag a resource after it has been created, see CreateTags.

" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the resource.

", + "smithy.api#xmlName": "Tag" + } + } + }, + "traits": { + "smithy.api#documentation": "

The tags specification for the resources that are created during instance\n launch.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateTagSpecificationRequestList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LaunchTemplateTagSpecificationRequest", + "traits": { + "smithy.api#xmlName": "LaunchTemplateTagSpecificationRequest" + } + } + }, + "com.amazonaws.ec2#LaunchTemplateVersion": { + "type": "structure", + "members": { + "LaunchTemplateId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateId", + "smithy.api#documentation": "

The ID of the launch template.

", + "smithy.api#xmlName": "launchTemplateId" + } + }, + "LaunchTemplateName": { + "target": "com.amazonaws.ec2#LaunchTemplateName", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateName", + "smithy.api#documentation": "

The name of the launch template.

", + "smithy.api#xmlName": "launchTemplateName" + } + }, + "VersionNumber": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "VersionNumber", + "smithy.api#documentation": "

The version number.

", + "smithy.api#xmlName": "versionNumber" + } + }, + "VersionDescription": { + "target": "com.amazonaws.ec2#VersionDescription", + "traits": { + "aws.protocols#ec2QueryName": "VersionDescription", + "smithy.api#documentation": "

The description for the version.

", + "smithy.api#xmlName": "versionDescription" + } + }, + "CreateTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreateTime", + "smithy.api#documentation": "

The time the version was created.

", + "smithy.api#xmlName": "createTime" + } + }, + "CreatedBy": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CreatedBy", + "smithy.api#documentation": "

The principal that created the version.

", + "smithy.api#xmlName": "createdBy" + } + }, + "DefaultVersion": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DefaultVersion", + "smithy.api#documentation": "

Indicates whether the version is the default version.

", + "smithy.api#xmlName": "defaultVersion" + } + }, + "LaunchTemplateData": { + "target": "com.amazonaws.ec2#ResponseLaunchTemplateData", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateData", + "smithy.api#documentation": "

Information about the launch template.

", + "smithy.api#xmlName": "launchTemplateData" + } + }, + "Operator": { + "target": "com.amazonaws.ec2#OperatorResponse", + "traits": { + "aws.protocols#ec2QueryName": "Operator", + "smithy.api#documentation": "

The entity that manages the launch template.

", + "smithy.api#xmlName": "operator" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a launch template version.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateVersionSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LaunchTemplateVersion", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LaunchTemplatesMonitoring": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Enabled", + "smithy.api#documentation": "

Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is\n enabled.

", + "smithy.api#xmlName": "enabled" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the monitoring for the instance.

" + } + }, + "com.amazonaws.ec2#LaunchTemplatesMonitoringRequest": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Specify true to enable detailed monitoring. Otherwise, basic monitoring\n is enabled.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the monitoring for the instance.

" + } + }, + "com.amazonaws.ec2#LicenseConfiguration": { + "type": "structure", + "members": { + "LicenseConfigurationArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LicenseConfigurationArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the license configuration.

", + "smithy.api#xmlName": "licenseConfigurationArn" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a license configuration.

" + } + }, + "com.amazonaws.ec2#LicenseConfigurationRequest": { + "type": "structure", + "members": { + "LicenseConfigurationArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the license configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a license configuration.

" + } + }, + "com.amazonaws.ec2#LicenseList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LicenseConfiguration", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LicenseSpecificationListRequest": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LicenseConfigurationRequest", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ListImagesInRecycleBin": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ListImagesInRecycleBinRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ListImagesInRecycleBinResult" + }, + "traits": { + "smithy.api#documentation": "

Lists one or more AMIs that are currently in the Recycle Bin. For more information, see\n Recycle\n Bin in the Amazon EC2 User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Images", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#ListImagesInRecycleBinMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#ListImagesInRecycleBinRequest": { + "type": "structure", + "members": { + "ImageIds": { + "target": "com.amazonaws.ec2#ImageIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the AMIs to list. Omit this parameter to list all of the AMIs that are in the\n Recycle Bin. You can specify up to 20 IDs in a single request.

", + "smithy.api#xmlName": "ImageId" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#ListImagesInRecycleBinMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ListImagesInRecycleBinResult": { + "type": "structure", + "members": { + "Images": { + "target": "com.amazonaws.ec2#ImageRecycleBinInfoList", + "traits": { + "aws.protocols#ec2QueryName": "ImageSet", + "smithy.api#documentation": "

Information about the AMIs.

", + "smithy.api#xmlName": "imageSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ListSnapshotsInRecycleBin": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ListSnapshotsInRecycleBinRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ListSnapshotsInRecycleBinResult" + }, + "traits": { + "smithy.api#documentation": "

Lists one or more snapshots that are currently in the Recycle Bin.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Snapshots", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#ListSnapshotsInRecycleBinMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#ListSnapshotsInRecycleBinRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.ec2#ListSnapshotsInRecycleBinMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output. \n\tFor more information, see Pagination.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request.\n Pagination continues from the end of the items returned by the previous request.

" + } + }, + "SnapshotIds": { + "target": "com.amazonaws.ec2#SnapshotIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the snapshots to list. Omit this parameter to list all of the \n snapshots that are in the Recycle Bin.

", + "smithy.api#xmlName": "SnapshotId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ListSnapshotsInRecycleBinResult": { + "type": "structure", + "members": { + "Snapshots": { + "target": "com.amazonaws.ec2#SnapshotRecycleBinInfoList", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotSet", + "smithy.api#documentation": "

Information about the snapshots.

", + "smithy.api#xmlName": "snapshotSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. \n This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ListingState": { + "type": "enum", + "members": { + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "sold": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sold" + } + }, + "cancelled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cancelled" + } + }, + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + } + } + }, + "com.amazonaws.ec2#ListingStatus": { + "type": "enum", + "members": { + "active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "cancelled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cancelled" + } + }, + "closed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "closed" + } + } + } + }, + "com.amazonaws.ec2#LoadBalancerArn": { + "type": "string" + }, + "com.amazonaws.ec2#LoadBalancersConfig": { + "type": "structure", + "members": { + "ClassicLoadBalancersConfig": { + "target": "com.amazonaws.ec2#ClassicLoadBalancersConfig", + "traits": { + "aws.protocols#ec2QueryName": "ClassicLoadBalancersConfig", + "smithy.api#documentation": "

The Classic Load Balancers.

", + "smithy.api#xmlName": "classicLoadBalancersConfig" + } + }, + "TargetGroupsConfig": { + "target": "com.amazonaws.ec2#TargetGroupsConfig", + "traits": { + "aws.protocols#ec2QueryName": "TargetGroupsConfig", + "smithy.api#documentation": "

The target groups.

", + "smithy.api#xmlName": "targetGroupsConfig" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the Classic Load Balancers and target groups to attach to a Spot Fleet\n request.

" + } + }, + "com.amazonaws.ec2#LoadPermission": { + "type": "structure", + "members": { + "UserId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "UserId", + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#xmlName": "userId" + } + }, + "Group": { + "target": "com.amazonaws.ec2#PermissionGroup", + "traits": { + "aws.protocols#ec2QueryName": "Group", + "smithy.api#documentation": "

The name of the group.

", + "smithy.api#xmlName": "group" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a load permission.

" + } + }, + "com.amazonaws.ec2#LoadPermissionList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LoadPermission", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LoadPermissionListRequest": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LoadPermissionRequest", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LoadPermissionModifications": { + "type": "structure", + "members": { + "Add": { + "target": "com.amazonaws.ec2#LoadPermissionListRequest", + "traits": { + "smithy.api#documentation": "

The load permissions to add.

" + } + }, + "Remove": { + "target": "com.amazonaws.ec2#LoadPermissionListRequest", + "traits": { + "smithy.api#documentation": "

The load permissions to remove.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes modifications to the load permissions of an Amazon FPGA image (AFI).

" + } + }, + "com.amazonaws.ec2#LoadPermissionRequest": { + "type": "structure", + "members": { + "Group": { + "target": "com.amazonaws.ec2#PermissionGroup", + "traits": { + "smithy.api#documentation": "

The name of the group.

" + } + }, + "UserId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a load permission.

" + } + }, + "com.amazonaws.ec2#LocalGateway": { + "type": "structure", + "members": { + "LocalGatewayId": { + "target": "com.amazonaws.ec2#LocalGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayId", + "smithy.api#documentation": "

The ID of the local gateway.

", + "smithy.api#xmlName": "localGatewayId" + } + }, + "OutpostArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OutpostArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost.

", + "smithy.api#xmlName": "outpostArn" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the local gateway.

", + "smithy.api#xmlName": "ownerId" + } + }, + "State": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the local gateway.

", + "smithy.api#xmlName": "state" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the local gateway.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a local gateway.

" + } + }, + "com.amazonaws.ec2#LocalGatewayId": { + "type": "string" + }, + "com.amazonaws.ec2#LocalGatewayIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LocalGatewayId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LocalGatewayMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#LocalGatewayRoute": { + "type": "structure", + "members": { + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationCidrBlock", + "smithy.api#documentation": "

The CIDR block used for destination matches.

", + "smithy.api#xmlName": "destinationCidrBlock" + } + }, + "LocalGatewayVirtualInterfaceGroupId": { + "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupId", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayVirtualInterfaceGroupId", + "smithy.api#documentation": "

The ID of the virtual interface group.

", + "smithy.api#xmlName": "localGatewayVirtualInterfaceGroupId" + } + }, + "Type": { + "target": "com.amazonaws.ec2#LocalGatewayRouteType", + "traits": { + "aws.protocols#ec2QueryName": "Type", + "smithy.api#documentation": "

The route type.

", + "smithy.api#xmlName": "type" + } + }, + "State": { + "target": "com.amazonaws.ec2#LocalGatewayRouteState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the route.

", + "smithy.api#xmlName": "state" + } + }, + "LocalGatewayRouteTableId": { + "target": "com.amazonaws.ec2#LocalGatewayRoutetableId", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayRouteTableId", + "smithy.api#documentation": "

The ID of the local gateway route table.

", + "smithy.api#xmlName": "localGatewayRouteTableId" + } + }, + "LocalGatewayRouteTableArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayRouteTableArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the local gateway route table.

", + "smithy.api#xmlName": "localGatewayRouteTableArn" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the local gateway route.

", + "smithy.api#xmlName": "ownerId" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet.

", + "smithy.api#xmlName": "subnetId" + } + }, + "CoipPoolId": { + "target": "com.amazonaws.ec2#CoipPoolId", + "traits": { + "aws.protocols#ec2QueryName": "CoipPoolId", + "smithy.api#documentation": "

The ID of the customer-owned address pool.

", + "smithy.api#xmlName": "coipPoolId" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "DestinationPrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "aws.protocols#ec2QueryName": "DestinationPrefixListId", + "smithy.api#documentation": "

\n The ID of the prefix list.\n

", + "smithy.api#xmlName": "destinationPrefixListId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a route for a local gateway route table.

" + } + }, + "com.amazonaws.ec2#LocalGatewayRouteList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LocalGatewayRoute", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LocalGatewayRouteState": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "blackhole": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "blackhole" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + }, + "deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted" + } + } + } + }, + "com.amazonaws.ec2#LocalGatewayRouteTable": { + "type": "structure", + "members": { + "LocalGatewayRouteTableId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayRouteTableId", + "smithy.api#documentation": "

The ID of the local gateway route table.

", + "smithy.api#xmlName": "localGatewayRouteTableId" + } + }, + "LocalGatewayRouteTableArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayRouteTableArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the local gateway route table.

", + "smithy.api#xmlName": "localGatewayRouteTableArn" + } + }, + "LocalGatewayId": { + "target": "com.amazonaws.ec2#LocalGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayId", + "smithy.api#documentation": "

The ID of the local gateway.

", + "smithy.api#xmlName": "localGatewayId" + } + }, + "OutpostArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OutpostArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost.

", + "smithy.api#xmlName": "outpostArn" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the local gateway route table.

", + "smithy.api#xmlName": "ownerId" + } + }, + "State": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the local gateway route table.

", + "smithy.api#xmlName": "state" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the local gateway route table.

", + "smithy.api#xmlName": "tagSet" + } + }, + "Mode": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTableMode", + "traits": { + "aws.protocols#ec2QueryName": "Mode", + "smithy.api#documentation": "

The mode of the local gateway route table.

", + "smithy.api#xmlName": "mode" + } + }, + "StateReason": { + "target": "com.amazonaws.ec2#StateReason", + "traits": { + "aws.protocols#ec2QueryName": "StateReason", + "smithy.api#documentation": "

Information about the state change.

", + "smithy.api#xmlName": "stateReason" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a local gateway route table.

" + } + }, + "com.amazonaws.ec2#LocalGatewayRouteTableIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LocalGatewayRoutetableId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LocalGatewayRouteTableMode": { + "type": "enum", + "members": { + "direct_vpc_routing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "direct-vpc-routing" + } + }, + "coip": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "coip" + } + } + } + }, + "com.amazonaws.ec2#LocalGatewayRouteTableSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTable", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LocalGatewayRouteTableVirtualInterfaceGroupAssociation": { + "type": "structure", + "members": { + "LocalGatewayRouteTableVirtualInterfaceGroupAssociationId": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTableVirtualInterfaceGroupAssociationId", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayRouteTableVirtualInterfaceGroupAssociationId", + "smithy.api#documentation": "

The ID of the association.

", + "smithy.api#xmlName": "localGatewayRouteTableVirtualInterfaceGroupAssociationId" + } + }, + "LocalGatewayVirtualInterfaceGroupId": { + "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupId", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayVirtualInterfaceGroupId", + "smithy.api#documentation": "

The ID of the virtual interface group.

", + "smithy.api#xmlName": "localGatewayVirtualInterfaceGroupId" + } + }, + "LocalGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayId", + "smithy.api#documentation": "

The ID of the local gateway.

", + "smithy.api#xmlName": "localGatewayId" + } + }, + "LocalGatewayRouteTableId": { + "target": "com.amazonaws.ec2#LocalGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayRouteTableId", + "smithy.api#documentation": "

The ID of the local gateway route table.

", + "smithy.api#xmlName": "localGatewayRouteTableId" + } + }, + "LocalGatewayRouteTableArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayRouteTableArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the local gateway route table for the virtual interface group.

", + "smithy.api#xmlName": "localGatewayRouteTableArn" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the local gateway virtual interface group association.

", + "smithy.api#xmlName": "ownerId" + } + }, + "State": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the association.

", + "smithy.api#xmlName": "state" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the association.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an association between a local gateway route table and a virtual interface group.

" + } + }, + "com.amazonaws.ec2#LocalGatewayRouteTableVirtualInterfaceGroupAssociationId": { + "type": "string" + }, + "com.amazonaws.ec2#LocalGatewayRouteTableVirtualInterfaceGroupAssociationIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTableVirtualInterfaceGroupAssociationId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LocalGatewayRouteTableVirtualInterfaceGroupAssociationSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTableVirtualInterfaceGroupAssociation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LocalGatewayRouteTableVpcAssociation": { + "type": "structure", + "members": { + "LocalGatewayRouteTableVpcAssociationId": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTableVpcAssociationId", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayRouteTableVpcAssociationId", + "smithy.api#documentation": "

The ID of the association.

", + "smithy.api#xmlName": "localGatewayRouteTableVpcAssociationId" + } + }, + "LocalGatewayRouteTableId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayRouteTableId", + "smithy.api#documentation": "

The ID of the local gateway route table.

", + "smithy.api#xmlName": "localGatewayRouteTableId" + } + }, + "LocalGatewayRouteTableArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayRouteTableArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the local gateway route table for the association.

", + "smithy.api#xmlName": "localGatewayRouteTableArn" + } + }, + "LocalGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayId", + "smithy.api#documentation": "

The ID of the local gateway.

", + "smithy.api#xmlName": "localGatewayId" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "vpcId" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the local gateway route table for the association.

", + "smithy.api#xmlName": "ownerId" + } + }, + "State": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the association.

", + "smithy.api#xmlName": "state" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the association.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an association between a local gateway route table and a VPC.

" + } + }, + "com.amazonaws.ec2#LocalGatewayRouteTableVpcAssociationId": { + "type": "string" + }, + "com.amazonaws.ec2#LocalGatewayRouteTableVpcAssociationIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTableVpcAssociationId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LocalGatewayRouteTableVpcAssociationSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTableVpcAssociation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LocalGatewayRouteType": { + "type": "enum", + "members": { + "static": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "static" + } + }, + "propagated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "propagated" + } + } + } + }, + "com.amazonaws.ec2#LocalGatewayRoutetableId": { + "type": "string" + }, + "com.amazonaws.ec2#LocalGatewaySet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LocalGateway", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LocalGatewayVirtualInterface": { + "type": "structure", + "members": { + "LocalGatewayVirtualInterfaceId": { + "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceId", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayVirtualInterfaceId", + "smithy.api#documentation": "

The ID of the virtual interface.

", + "smithy.api#xmlName": "localGatewayVirtualInterfaceId" + } + }, + "LocalGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayId", + "smithy.api#documentation": "

The ID of the local gateway.

", + "smithy.api#xmlName": "localGatewayId" + } + }, + "Vlan": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Vlan", + "smithy.api#documentation": "

The ID of the VLAN.

", + "smithy.api#xmlName": "vlan" + } + }, + "LocalAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LocalAddress", + "smithy.api#documentation": "

The local address.

", + "smithy.api#xmlName": "localAddress" + } + }, + "PeerAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PeerAddress", + "smithy.api#documentation": "

The peer address.

", + "smithy.api#xmlName": "peerAddress" + } + }, + "LocalBgpAsn": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "LocalBgpAsn", + "smithy.api#documentation": "

The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway.

", + "smithy.api#xmlName": "localBgpAsn" + } + }, + "PeerBgpAsn": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "PeerBgpAsn", + "smithy.api#documentation": "

The peer BGP ASN.

", + "smithy.api#xmlName": "peerBgpAsn" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the local gateway virtual interface.

", + "smithy.api#xmlName": "ownerId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the virtual interface.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a local gateway virtual interface.

" + } + }, + "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroup": { + "type": "structure", + "members": { + "LocalGatewayVirtualInterfaceGroupId": { + "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupId", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayVirtualInterfaceGroupId", + "smithy.api#documentation": "

The ID of the virtual interface group.

", + "smithy.api#xmlName": "localGatewayVirtualInterfaceGroupId" + } + }, + "LocalGatewayVirtualInterfaceIds": { + "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceIdSet", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayVirtualInterfaceIdSet", + "smithy.api#documentation": "

The IDs of the virtual interfaces.

", + "smithy.api#xmlName": "localGatewayVirtualInterfaceIdSet" + } + }, + "LocalGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayId", + "smithy.api#documentation": "

The ID of the local gateway.

", + "smithy.api#xmlName": "localGatewayId" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the local gateway virtual interface group.

", + "smithy.api#xmlName": "ownerId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the virtual interface group.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a local gateway virtual interface group.

" + } + }, + "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupId": { + "type": "string" + }, + "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroup", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LocalGatewayVirtualInterfaceId": { + "type": "string" + }, + "com.amazonaws.ec2#LocalGatewayVirtualInterfaceIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LocalGatewayVirtualInterfaceSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LocalGatewayVirtualInterface", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LocalStorage": { + "type": "enum", + "members": { + "INCLUDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "included" + } + }, + "REQUIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "required" + } + }, + "EXCLUDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "excluded" + } + } + } + }, + "com.amazonaws.ec2#LocalStorageType": { + "type": "enum", + "members": { + "HDD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hdd" + } + }, + "SSD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ssd" + } + } + } + }, + "com.amazonaws.ec2#LocalStorageTypeSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LocalStorageType", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Location": { + "type": "string" + }, + "com.amazonaws.ec2#LocationType": { + "type": "enum", + "members": { + "region": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "region" + } + }, + "availability_zone": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "availability-zone" + } + }, + "availability_zone_id": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "availability-zone-id" + } + }, + "outpost": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "outpost" + } + } + } + }, + "com.amazonaws.ec2#LockMode": { + "type": "enum", + "members": { + "compliance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "compliance" + } + }, + "governance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "governance" + } + } + } + }, + "com.amazonaws.ec2#LockSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#LockSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.ec2#LockSnapshotResult" + }, + "traits": { + "smithy.api#documentation": "

Locks an Amazon EBS snapshot in either governance or compliance \n mode to protect it against accidental or malicious deletions for a specific duration. A locked snapshot \n can't be deleted.

\n

You can also use this action to modify the lock settings for a snapshot that is already locked. The \n allowed modifications depend on the lock mode and lock state:

\n " + } + }, + "com.amazonaws.ec2#LockSnapshotRequest": { + "type": "structure", + "members": { + "SnapshotId": { + "target": "com.amazonaws.ec2#SnapshotId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the snapshot to lock.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "LockMode": { + "target": "com.amazonaws.ec2#LockMode", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The mode in which to lock the snapshot. Specify one of the following:

\n ", + "smithy.api#required": {} + } + }, + "CoolOffPeriod": { + "target": "com.amazonaws.ec2#CoolOffPeriodRequestHours", + "traits": { + "smithy.api#documentation": "

The cooling-off period during which you can unlock the snapshot or modify the lock settings after \n locking the snapshot in compliance mode, in hours. After the cooling-off period expires, you can't \n unlock or delete the snapshot, decrease the lock duration, or change the lock mode. You can increase \n the lock duration after the cooling-off period expires.

\n

The cooling-off period is optional when locking a snapshot in compliance mode. If you are locking \n the snapshot in governance mode, omit this parameter.

\n

To lock the snapshot in compliance mode immediately without a cooling-off period, omit this \n parameter.

\n

If you are extending the lock duration for a snapshot that is locked in compliance mode after \n the cooling-off period has expired, omit this parameter. If you specify a cooling-period in a such \n a request, the request fails.

\n

Allowed values: Min 1, max 72.

" + } + }, + "LockDuration": { + "target": "com.amazonaws.ec2#RetentionPeriodRequestDays", + "traits": { + "smithy.api#documentation": "

The period of time for which to lock the snapshot, in days. The snapshot lock will automatically \n expire after this period lapses.

\n

You must specify either this parameter or ExpirationDate, but \n not both.

\n

Allowed values: Min: 1, max 36500

" + } + }, + "ExpirationDate": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "smithy.api#documentation": "

The date and time at which the snapshot lock is to automatically expire, in the UTC time zone \n (YYYY-MM-DDThh:mm:ss.sssZ).

\n

You must specify either this parameter or LockDuration, but \n not both.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#LockSnapshotResult": { + "type": "structure", + "members": { + "SnapshotId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The ID of the snapshot

", + "smithy.api#xmlName": "snapshotId" + } + }, + "LockState": { + "target": "com.amazonaws.ec2#LockState", + "traits": { + "aws.protocols#ec2QueryName": "LockState", + "smithy.api#documentation": "

The state of the snapshot lock. Valid states include:

\n ", + "smithy.api#xmlName": "lockState" + } + }, + "LockDuration": { + "target": "com.amazonaws.ec2#RetentionPeriodResponseDays", + "traits": { + "aws.protocols#ec2QueryName": "LockDuration", + "smithy.api#documentation": "

The period of time for which the snapshot is locked, in days.

", + "smithy.api#xmlName": "lockDuration" + } + }, + "CoolOffPeriod": { + "target": "com.amazonaws.ec2#CoolOffPeriodResponseHours", + "traits": { + "aws.protocols#ec2QueryName": "CoolOffPeriod", + "smithy.api#documentation": "

The compliance mode cooling-off period, in hours.

", + "smithy.api#xmlName": "coolOffPeriod" + } + }, + "CoolOffPeriodExpiresOn": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "CoolOffPeriodExpiresOn", + "smithy.api#documentation": "

The date and time at which the compliance mode cooling-off period expires, in the UTC time zone \n (YYYY-MM-DDThh:mm:ss.sssZ).

", + "smithy.api#xmlName": "coolOffPeriodExpiresOn" + } + }, + "LockCreatedOn": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "LockCreatedOn", + "smithy.api#documentation": "

The date and time at which the snapshot was locked, in the UTC time zone \n (YYYY-MM-DDThh:mm:ss.sssZ).

", + "smithy.api#xmlName": "lockCreatedOn" + } + }, + "LockExpiresOn": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "LockExpiresOn", + "smithy.api#documentation": "

The date and time at which the lock will expire, in the UTC time zone \n (YYYY-MM-DDThh:mm:ss.sssZ).

", + "smithy.api#xmlName": "lockExpiresOn" + } + }, + "LockDurationStartTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "LockDurationStartTime", + "smithy.api#documentation": "

The date and time at which the lock duration started, in the UTC time zone \n (YYYY-MM-DDThh:mm:ss.sssZ).

", + "smithy.api#xmlName": "lockDurationStartTime" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#LockState": { + "type": "enum", + "members": { + "compliance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "compliance" + } + }, + "governance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "governance" + } + }, + "compliance_cooloff": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "compliance-cooloff" + } + }, + "expired": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "expired" + } + } + } + }, + "com.amazonaws.ec2#LockedSnapshotsInfo": { + "type": "structure", + "members": { + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The account ID of the Amazon Web Services account that owns the snapshot.

", + "smithy.api#xmlName": "ownerId" + } + }, + "SnapshotId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The ID of the snapshot.

", + "smithy.api#xmlName": "snapshotId" + } + }, + "LockState": { + "target": "com.amazonaws.ec2#LockState", + "traits": { + "aws.protocols#ec2QueryName": "LockState", + "smithy.api#documentation": "

The state of the snapshot lock. Valid states include:

\n ", + "smithy.api#xmlName": "lockState" + } + }, + "LockDuration": { + "target": "com.amazonaws.ec2#RetentionPeriodResponseDays", + "traits": { + "aws.protocols#ec2QueryName": "LockDuration", + "smithy.api#documentation": "

The period of time for which the snapshot is locked, in days.

", + "smithy.api#xmlName": "lockDuration" + } + }, + "CoolOffPeriod": { + "target": "com.amazonaws.ec2#CoolOffPeriodResponseHours", + "traits": { + "aws.protocols#ec2QueryName": "CoolOffPeriod", + "smithy.api#documentation": "

The compliance mode cooling-off period, in hours.

", + "smithy.api#xmlName": "coolOffPeriod" + } + }, + "CoolOffPeriodExpiresOn": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "CoolOffPeriodExpiresOn", + "smithy.api#documentation": "

The date and time at which the compliance mode cooling-off period expires, in the UTC time zone \n (YYYY-MM-DDThh:mm:ss.sssZ).

", + "smithy.api#xmlName": "coolOffPeriodExpiresOn" + } + }, + "LockCreatedOn": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "LockCreatedOn", + "smithy.api#documentation": "

The date and time at which the snapshot was locked, in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ).

", + "smithy.api#xmlName": "lockCreatedOn" + } + }, + "LockDurationStartTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "LockDurationStartTime", + "smithy.api#documentation": "

The date and time at which the lock duration started, in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ).

\n

If you lock a snapshot that is in the pending state, the lock duration \n starts only once the snapshot enters the completed state.

", + "smithy.api#xmlName": "lockDurationStartTime" + } + }, + "LockExpiresOn": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "LockExpiresOn", + "smithy.api#documentation": "

The date and time at which the lock will expire, in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ).

", + "smithy.api#xmlName": "lockExpiresOn" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a locked snapshot.

" + } + }, + "com.amazonaws.ec2#LockedSnapshotsInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LockedSnapshotsInfo", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LogDestinationType": { + "type": "enum", + "members": { + "cloud_watch_logs": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cloud-watch-logs" + } + }, + "s3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "s3" + } + }, + "kinesis_data_firehose": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "kinesis-data-firehose" + } + } + } + }, + "com.amazonaws.ec2#Long": { + "type": "long" + }, + "com.amazonaws.ec2#MacHost": { + "type": "structure", + "members": { + "HostId": { + "target": "com.amazonaws.ec2#DedicatedHostId", + "traits": { + "aws.protocols#ec2QueryName": "HostId", + "smithy.api#documentation": "

\n The EC2 Mac Dedicated Host ID.\n

", + "smithy.api#xmlName": "hostId" + } + }, + "MacOSLatestSupportedVersions": { + "target": "com.amazonaws.ec2#MacOSVersionStringList", + "traits": { + "aws.protocols#ec2QueryName": "MacOSLatestSupportedVersionSet", + "smithy.api#documentation": "

\n The latest macOS versions that the EC2 Mac Dedicated Host can launch without being upgraded.\n

", + "smithy.api#xmlName": "macOSLatestSupportedVersionSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Information about the EC2 Mac Dedicated Host.\n

" + } + }, + "com.amazonaws.ec2#MacHostList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#MacHost", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#MacOSVersionStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#MaintenanceDetails": { + "type": "structure", + "members": { + "PendingMaintenance": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PendingMaintenance", + "smithy.api#documentation": "

Verify existence of a pending maintenance.

", + "smithy.api#xmlName": "pendingMaintenance" + } + }, + "MaintenanceAutoAppliedAfter": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "MaintenanceAutoAppliedAfter", + "smithy.api#documentation": "

The timestamp after which Amazon Web Services will automatically apply maintenance.

", + "smithy.api#xmlName": "maintenanceAutoAppliedAfter" + } + }, + "LastMaintenanceApplied": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "LastMaintenanceApplied", + "smithy.api#documentation": "

Timestamp of last applied maintenance.

", + "smithy.api#xmlName": "lastMaintenanceApplied" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details for Site-to-Site VPN tunnel endpoint maintenance events.

" + } + }, + "com.amazonaws.ec2#ManagedBy": { + "type": "enum", + "members": { + "account": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "account" + } + }, + "declarative_policy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "declarative-policy" + } + } + } + }, + "com.amazonaws.ec2#ManagedPrefixList": { + "type": "structure", + "members": { + "PrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "aws.protocols#ec2QueryName": "PrefixListId", + "smithy.api#documentation": "

The ID of the prefix list.

", + "smithy.api#xmlName": "prefixListId" + } + }, + "AddressFamily": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AddressFamily", + "smithy.api#documentation": "

The IP address version.

", + "smithy.api#xmlName": "addressFamily" + } + }, + "State": { + "target": "com.amazonaws.ec2#PrefixListState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of the prefix list.

", + "smithy.api#xmlName": "state" + } + }, + "StateMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StateMessage", + "smithy.api#documentation": "

The state message.

", + "smithy.api#xmlName": "stateMessage" + } + }, + "PrefixListArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "PrefixListArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the prefix list.

", + "smithy.api#xmlName": "prefixListArn" + } + }, + "PrefixListName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrefixListName", + "smithy.api#documentation": "

The name of the prefix list.

", + "smithy.api#xmlName": "prefixListName" + } + }, + "MaxEntries": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "MaxEntries", + "smithy.api#documentation": "

The maximum number of entries for the prefix list.

", + "smithy.api#xmlName": "maxEntries" + } + }, + "Version": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "Version", + "smithy.api#documentation": "

The version of the prefix list.

", + "smithy.api#xmlName": "version" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags for the prefix list.

", + "smithy.api#xmlName": "tagSet" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the owner of the prefix list.

", + "smithy.api#xmlName": "ownerId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a managed prefix list.

" + } + }, + "com.amazonaws.ec2#ManagedPrefixListSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ManagedPrefixList", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#MarketType": { + "type": "enum", + "members": { + "spot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "spot" + } + }, + "capacity_block": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "capacity-block" + } + } + } + }, + "com.amazonaws.ec2#MaxIpv4AddrPerInterface": { + "type": "integer" + }, + "com.amazonaws.ec2#MaxIpv6AddrPerInterface": { + "type": "integer" + }, + "com.amazonaws.ec2#MaxNetworkInterfaces": { + "type": "integer" + }, + "com.amazonaws.ec2#MaxResults": { + "type": "integer" + }, + "com.amazonaws.ec2#MaxResults2": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.ec2#MaxResultsParam": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.ec2#MaximumBandwidthInMbps": { + "type": "integer" + }, + "com.amazonaws.ec2#MaximumEfaInterfaces": { + "type": "integer" + }, + "com.amazonaws.ec2#MaximumIops": { + "type": "integer" + }, + "com.amazonaws.ec2#MaximumNetworkCards": { + "type": "integer" + }, + "com.amazonaws.ec2#MaximumThroughputInMBps": { + "type": "double" + }, + "com.amazonaws.ec2#MediaAcceleratorInfo": { + "type": "structure", + "members": { + "Accelerators": { + "target": "com.amazonaws.ec2#MediaDeviceInfoList", + "traits": { + "aws.protocols#ec2QueryName": "Accelerators", + "smithy.api#documentation": "

Describes the media accelerators for the instance type.

", + "smithy.api#xmlName": "accelerators" + } + }, + "TotalMediaMemoryInMiB": { + "target": "com.amazonaws.ec2#TotalMediaMemory", + "traits": { + "aws.protocols#ec2QueryName": "TotalMediaMemoryInMiB", + "smithy.api#documentation": "

The total size of the memory for the media accelerators for the instance type, in\n MiB.

", + "smithy.api#xmlName": "totalMediaMemoryInMiB" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the media accelerators for the instance type.

" + } + }, + "com.amazonaws.ec2#MediaDeviceCount": { + "type": "integer" + }, + "com.amazonaws.ec2#MediaDeviceInfo": { + "type": "structure", + "members": { + "Count": { + "target": "com.amazonaws.ec2#MediaDeviceCount", + "traits": { + "aws.protocols#ec2QueryName": "Count", + "smithy.api#documentation": "

The number of media accelerators for the instance type.

", + "smithy.api#xmlName": "count" + } + }, + "Name": { + "target": "com.amazonaws.ec2#MediaDeviceName", + "traits": { + "aws.protocols#ec2QueryName": "Name", + "smithy.api#documentation": "

The name of the media accelerator.

", + "smithy.api#xmlName": "name" + } + }, + "Manufacturer": { + "target": "com.amazonaws.ec2#MediaDeviceManufacturerName", + "traits": { + "aws.protocols#ec2QueryName": "Manufacturer", + "smithy.api#documentation": "

The manufacturer of the media accelerator.

", + "smithy.api#xmlName": "manufacturer" + } + }, + "MemoryInfo": { + "target": "com.amazonaws.ec2#MediaDeviceMemoryInfo", + "traits": { + "aws.protocols#ec2QueryName": "MemoryInfo", + "smithy.api#documentation": "

Describes the memory available to the media accelerator.

", + "smithy.api#xmlName": "memoryInfo" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the media accelerators for the instance type.

" + } + }, + "com.amazonaws.ec2#MediaDeviceInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#MediaDeviceInfo", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#MediaDeviceManufacturerName": { + "type": "string" + }, + "com.amazonaws.ec2#MediaDeviceMemoryInfo": { + "type": "structure", + "members": { + "SizeInMiB": { + "target": "com.amazonaws.ec2#MediaDeviceMemorySize", + "traits": { + "aws.protocols#ec2QueryName": "SizeInMiB", + "smithy.api#documentation": "

The size of the memory available to each media accelerator, in MiB.

", + "smithy.api#xmlName": "sizeInMiB" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the memory available to the media accelerator.

" + } + }, + "com.amazonaws.ec2#MediaDeviceMemorySize": { + "type": "integer" + }, + "com.amazonaws.ec2#MediaDeviceName": { + "type": "string" + }, + "com.amazonaws.ec2#MembershipType": { + "type": "enum", + "members": { + "static": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "static" + } + }, + "igmp": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "igmp" + } + } + } + }, + "com.amazonaws.ec2#MemoryGiBPerVCpu": { + "type": "structure", + "members": { + "Min": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "Min", + "smithy.api#documentation": "

The minimum amount of memory per vCPU, in GiB. If this parameter is not specified, there is\n no minimum limit.

", + "smithy.api#xmlName": "min" + } + }, + "Max": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "Max", + "smithy.api#documentation": "

The maximum amount of memory per vCPU, in GiB. If this parameter is not specified, there is\n no maximum limit.

", + "smithy.api#xmlName": "max" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum and maximum amount of memory per vCPU, in GiB.

\n

" + } + }, + "com.amazonaws.ec2#MemoryGiBPerVCpuRequest": { + "type": "structure", + "members": { + "Min": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "smithy.api#documentation": "

The minimum amount of memory per vCPU, in GiB. To specify no minimum limit, omit this\n parameter.

" + } + }, + "Max": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "smithy.api#documentation": "

The maximum amount of memory per vCPU, in GiB. To specify no maximum limit, omit this\n parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum and maximum amount of memory per vCPU, in GiB.

" + } + }, + "com.amazonaws.ec2#MemoryInfo": { + "type": "structure", + "members": { + "SizeInMiB": { + "target": "com.amazonaws.ec2#MemorySize", + "traits": { + "aws.protocols#ec2QueryName": "SizeInMiB", + "smithy.api#documentation": "

The size of the memory, in MiB.

", + "smithy.api#xmlName": "sizeInMiB" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the memory for the instance type.

" + } + }, + "com.amazonaws.ec2#MemoryMiB": { + "type": "structure", + "members": { + "Min": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Min", + "smithy.api#documentation": "

The minimum amount of memory, in MiB. If this parameter is not specified, there is no minimum\n limit.

", + "smithy.api#xmlName": "min" + } + }, + "Max": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Max", + "smithy.api#documentation": "

The maximum amount of memory, in MiB. If this parameter is not specified, there is no\n maximum limit.

", + "smithy.api#xmlName": "max" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum and maximum amount of memory, in MiB.

" + } + }, + "com.amazonaws.ec2#MemoryMiBRequest": { + "type": "structure", + "members": { + "Min": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The minimum amount of memory, in MiB. To specify no minimum limit, specify\n 0.

", + "smithy.api#required": {} + } + }, + "Max": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum amount of memory, in MiB. To specify no maximum limit, omit this\n parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum and maximum amount of memory, in MiB.

" + } + }, + "com.amazonaws.ec2#MemorySize": { + "type": "long" + }, + "com.amazonaws.ec2#MetadataDefaultHttpTokensState": { + "type": "enum", + "members": { + "optional": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "optional" + } + }, + "required": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "required" + } + }, + "no_preference": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "no-preference" + } + } + } + }, + "com.amazonaws.ec2#MetricPoint": { + "type": "structure", + "members": { + "StartDate": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "StartDate", + "smithy.api#documentation": "

The start date for the metric point. The starting date for the metric point. The starting time must be formatted\n as yyyy-mm-ddThh:mm:ss. For example, 2022-06-10T12:00:00.000Z.

", + "smithy.api#xmlName": "startDate" + } + }, + "EndDate": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "EndDate", + "smithy.api#documentation": "

The end date for the metric point. The ending time must be formatted as yyyy-mm-ddThh:mm:ss. For example, 2022-06-12T12:00:00.000Z.

", + "smithy.api#xmlName": "endDate" + } + }, + "Value": { + "target": "com.amazonaws.ec2#Float", + "traits": { + "aws.protocols#ec2QueryName": "Value", + "smithy.api#xmlName": "value" + } + }, + "Status": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The status of the metric point.

", + "smithy.api#xmlName": "status" + } + } + }, + "traits": { + "smithy.api#documentation": "

Indicates whether the network was healthy or degraded at a particular point. The value is aggregated from the startDate to the endDate. Currently only five_minutes is supported.

" + } + }, + "com.amazonaws.ec2#MetricPoints": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#MetricPoint", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#MetricType": { + "type": "enum", + "members": { + "aggregate_latency": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "aggregate-latency" + } + } + } + }, + "com.amazonaws.ec2#MillisecondDateTime": { + "type": "timestamp" + }, + "com.amazonaws.ec2#ModifyAddressAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyAddressAttributeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyAddressAttributeResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies an attribute of the specified Elastic IP address. For requirements, see Using reverse DNS for email applications.

" + } + }, + "com.amazonaws.ec2#ModifyAddressAttributeRequest": { + "type": "structure", + "members": { + "AllocationId": { + "target": "com.amazonaws.ec2#AllocationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

[EC2-VPC] The allocation ID.

", + "smithy.api#required": {} + } + }, + "DomainName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The domain name to modify for the IP address.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyAddressAttributeResult": { + "type": "structure", + "members": { + "Address": { + "target": "com.amazonaws.ec2#AddressAttribute", + "traits": { + "aws.protocols#ec2QueryName": "Address", + "smithy.api#documentation": "

Information about the Elastic IP address.

", + "smithy.api#xmlName": "address" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyAvailabilityZoneGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyAvailabilityZoneGroupRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyAvailabilityZoneGroupResult" + }, + "traits": { + "smithy.api#documentation": "

Changes the opt-in status of the specified zone group for your account.

" + } + }, + "com.amazonaws.ec2#ModifyAvailabilityZoneGroupRequest": { + "type": "structure", + "members": { + "GroupName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Availability Zone group, Local Zone group, or Wavelength Zone\n group.

", + "smithy.api#required": {} + } + }, + "OptInStatus": { + "target": "com.amazonaws.ec2#ModifyAvailabilityZoneOptInStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Indicates whether to opt in to the zone group. The only valid value is opted-in. \n You must contact Amazon Web Services Support to opt out of a Local Zone or Wavelength Zone group.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyAvailabilityZoneGroupResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Is true if the request succeeds, and an error otherwise.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyAvailabilityZoneOptInStatus": { + "type": "enum", + "members": { + "opted_in": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "opted-in" + } + }, + "not_opted_in": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "not-opted-in" + } + } + } + }, + "com.amazonaws.ec2#ModifyCapacityReservation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyCapacityReservationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyCapacityReservationResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies a Capacity Reservation's capacity, instance eligibility, and the conditions under \n\t\t\twhich it is to be released. You can't modify a Capacity Reservation's instance type, EBS \n\t\t\toptimization, platform, instance store settings, Availability Zone, or tenancy. If you need \n\t\t\tto modify any of these attributes, we recommend that you cancel the Capacity Reservation, \n\t\t\tand then create a new one with the required attributes. For more information, see \n\t\t\t\n\t\t\t\tModify an active Capacity Reservation.

\n

The allowed modifications depend on the state of the Capacity Reservation:

\n " + } + }, + "com.amazonaws.ec2#ModifyCapacityReservationFleet": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyCapacityReservationFleetRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyCapacityReservationFleetResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies a Capacity Reservation Fleet.

\n

When you modify the total target capacity of a Capacity Reservation Fleet, the Fleet\n\t\t\tautomatically creates new Capacity Reservations, or modifies or cancels existing\n\t\t\tCapacity Reservations in the Fleet to meet the new total target capacity. When you\n\t\t\tmodify the end date for the Fleet, the end dates for all of the individual Capacity\n\t\t\tReservations in the Fleet are updated accordingly.

" + } + }, + "com.amazonaws.ec2#ModifyCapacityReservationFleetRequest": { + "type": "structure", + "members": { + "CapacityReservationFleetId": { + "target": "com.amazonaws.ec2#CapacityReservationFleetId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Capacity Reservation Fleet to modify.

", + "smithy.api#required": {} + } + }, + "TotalTargetCapacity": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The total number of capacity units to be reserved by the Capacity Reservation Fleet.\n\t\t\tThis value, together with the instance type weights that you assign to each instance\n\t\t\ttype used by the Fleet determine the number of instances for which the Fleet reserves\n\t\t\tcapacity. Both values are based on units that make sense for your workload. For more\n\t\t\tinformation, see Total target\n\t\t\t\tcapacity in the Amazon EC2 User Guide.

" + } + }, + "EndDate": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "smithy.api#documentation": "

The date and time at which the Capacity Reservation Fleet expires. When the Capacity\n\t\t\tReservation Fleet expires, its state changes to expired and all of the\n\t\t\tCapacity Reservations in the Fleet expire.

\n

The Capacity Reservation Fleet expires within an hour after the specified time. For\n\t\t\texample, if you specify 5/31/2019, 13:30:55, the Capacity\n\t\t\tReservation Fleet is guaranteed to expire between 13:30:55 and\n\t\t\t\t14:30:55 on 5/31/2019.

\n

You can't specify EndDate and \n\t\t\t\tRemoveEndDate in the same request.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "RemoveEndDate": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether to remove the end date from the Capacity Reservation Fleet. If you\n\t\t\tremove the end date, the Capacity Reservation Fleet does not expire and it remains\n\t\t\tactive until you explicitly cancel it using the CancelCapacityReservationFleet action.

\n

You can't specify RemoveEndDate and EndDate in the same request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyCapacityReservationFleetResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyCapacityReservationRequest": { + "type": "structure", + "members": { + "CapacityReservationId": { + "target": "com.amazonaws.ec2#CapacityReservationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Capacity Reservation.

", + "smithy.api#required": {} + } + }, + "InstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The number of instances for which to reserve capacity. The number of instances can't\n\t\t\tbe increased or decreased by more than 1000 in a single request.

" + } + }, + "EndDate": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "smithy.api#documentation": "

The date and time at which the Capacity Reservation expires. When a Capacity\n\t\t\tReservation expires, the reserved capacity is released and you can no longer launch\n\t\t\tinstances into it. The Capacity Reservation's state changes to expired when\n\t\t\tit reaches its end date and time.

\n

The Capacity Reservation is cancelled within an hour from the specified time. For\n\t\t\texample, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to\n\t\t\tend between 13:30:55 and 14:30:55 on 5/31/2019.

\n

You must provide an EndDate value if EndDateType is\n\t\t\t\tlimited. Omit EndDate if EndDateType is\n\t\t\t\tunlimited.

" + } + }, + "EndDateType": { + "target": "com.amazonaws.ec2#EndDateType", + "traits": { + "smithy.api#documentation": "

Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can\n\t\t\thave one of the following end types:

\n " + } + }, + "Accept": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Reserved. Capacity Reservations you have created are accepted by default.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "AdditionalInfo": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

" + } + }, + "InstanceMatchCriteria": { + "target": "com.amazonaws.ec2#InstanceMatchCriteria", + "traits": { + "smithy.api#documentation": "

The matching criteria (instance eligibility) that you want to use in the modified\n\t\t\tCapacity Reservation. If you change the instance eligibility of an existing Capacity\n\t\t\tReservation from targeted to open, any running instances that\n\t\t\tmatch the attributes of the Capacity Reservation, have the\n\t\t\t\tCapacityReservationPreference set to open, and are not yet\n\t\t\trunning in the Capacity Reservation, will automatically use the modified Capacity\n\t\t\tReservation.

\n

To modify the instance eligibility, the Capacity Reservation must be completely idle\n\t\t\t(zero usage).

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyCapacityReservationResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyClientVpnEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyClientVpnEndpointRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyClientVpnEndpointResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the specified Client VPN endpoint. Modifying the DNS server resets existing client connections.

" + } + }, + "com.amazonaws.ec2#ModifyClientVpnEndpointRequest": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#ClientVpnEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Client VPN endpoint to modify.

", + "smithy.api#required": {} + } + }, + "ServerCertificateArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ARN of the server certificate to be used. The server certificate must be provisioned in \n\t\t\tCertificate Manager (ACM).

" + } + }, + "ConnectionLogOptions": { + "target": "com.amazonaws.ec2#ConnectionLogOptions", + "traits": { + "smithy.api#documentation": "

Information about the client connection logging options.

\n

If you enable client connection logging, data about client connections is sent to a\n\t\t\tCloudwatch Logs log stream. The following information is logged:

\n " + } + }, + "DnsServers": { + "target": "com.amazonaws.ec2#DnsServersOptionsModifyStructure", + "traits": { + "smithy.api#documentation": "

Information about the DNS servers to be used by Client VPN connections. A Client VPN endpoint can have \n\t\t\tup to two DNS servers.

" + } + }, + "VpnPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The port number to assign to the Client VPN endpoint for TCP and UDP traffic.

\n

Valid Values: 443 | 1194\n

\n

Default Value: 443\n

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A brief description of the Client VPN endpoint.

" + } + }, + "SplitTunnel": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the VPN is split-tunnel.

\n

For information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the \n \tClient VPN Administrator Guide.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.ec2#ClientVpnSecurityGroupIdSet", + "traits": { + "smithy.api#documentation": "

The IDs of one or more security groups to apply to the target network.

", + "smithy.api#xmlName": "SecurityGroupId" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#documentation": "

The ID of the VPC to associate with the Client VPN endpoint.

" + } + }, + "SelfServicePortal": { + "target": "com.amazonaws.ec2#SelfServicePortal", + "traits": { + "smithy.api#documentation": "

Specify whether to enable the self-service portal for the Client VPN endpoint.

" + } + }, + "ClientConnectOptions": { + "target": "com.amazonaws.ec2#ClientConnectOptions", + "traits": { + "smithy.api#documentation": "

The options for managing connection authorization for new client connections.

" + } + }, + "SessionTimeoutHours": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum VPN session duration time in hours.

\n

Valid values: 8 | 10 | 12 | 24\n

\n

Default value: 24\n

" + } + }, + "ClientLoginBannerOptions": { + "target": "com.amazonaws.ec2#ClientLoginBannerOptions", + "traits": { + "smithy.api#documentation": "

Options for enabling a customizable text banner that will be displayed on\n\t\t\tAmazon Web Services provided clients when a VPN session is established.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyClientVpnEndpointResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyDefaultCreditSpecification": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyDefaultCreditSpecificationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyDefaultCreditSpecificationResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the default credit option for CPU usage of burstable performance instances.\n The default credit option is set at the account level per Amazon Web Services Region, and\n is specified per instance family. All new burstable performance instances in the account\n launch using the default credit option.

\n

\n ModifyDefaultCreditSpecification is an asynchronous operation, which\n works at an Amazon Web Services Region level and modifies the credit option for each\n Availability Zone. All zones in a Region are updated within five minutes. But if\n instances are launched during this operation, they might not get the new credit option\n until the zone is updated. To verify whether the update has occurred, you can call\n GetDefaultCreditSpecification and check\n DefaultCreditSpecification for updates.

\n

For more information, see Burstable\n performance instances in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#ModifyDefaultCreditSpecificationRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "InstanceFamily": { + "target": "com.amazonaws.ec2#UnlimitedSupportedInstanceFamily", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The instance family.

", + "smithy.api#required": {} + } + }, + "CpuCredits": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The credit option for CPU usage of the instance family.

\n

Valid Values: standard | unlimited\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyDefaultCreditSpecificationResult": { + "type": "structure", + "members": { + "InstanceFamilyCreditSpecification": { + "target": "com.amazonaws.ec2#InstanceFamilyCreditSpecification", + "traits": { + "aws.protocols#ec2QueryName": "InstanceFamilyCreditSpecification", + "smithy.api#documentation": "

The default credit option for CPU usage of the instance family.

", + "smithy.api#xmlName": "instanceFamilyCreditSpecification" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyEbsDefaultKmsKeyId": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyEbsDefaultKmsKeyIdRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyEbsDefaultKmsKeyIdResult" + }, + "traits": { + "smithy.api#documentation": "

Changes the default KMS key for EBS encryption by default for your account in this Region.

\n

Amazon Web Services creates a unique Amazon Web Services managed KMS key in each Region for use with encryption by default. If\n you change the default KMS key to a symmetric customer managed KMS key, it is used instead of the Amazon Web Services\n managed KMS key. To reset the default KMS key to the Amazon Web Services managed KMS key for EBS, use ResetEbsDefaultKmsKeyId. Amazon EBS does not support asymmetric KMS keys.

\n

If you delete or disable the customer managed KMS key that you specified for use with\n encryption by default, your instances will fail to launch.

\n

For more information, see Amazon EBS encryption\n in the Amazon EBS User Guide.

" + } + }, + "com.amazonaws.ec2#ModifyEbsDefaultKmsKeyIdRequest": { + "type": "structure", + "members": { + "KmsKeyId": { + "target": "com.amazonaws.ec2#KmsKeyId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier of the KMS key to use for Amazon EBS encryption.\n If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is\n specified, the encrypted state must be true.

\n

You can specify the KMS key using any of the following:

\n \n

Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, \n the action can appear to complete, but eventually fails.

\n

Amazon EBS does not support asymmetric KMS keys.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyEbsDefaultKmsKeyIdResult": { + "type": "structure", + "members": { + "KmsKeyId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KmsKeyId", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the default KMS key for encryption by default.

", + "smithy.api#xmlName": "kmsKeyId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyFleet": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyFleetRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyFleetResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the specified EC2 Fleet.

\n

You can only modify an EC2 Fleet request of type maintain.

\n

While the EC2 Fleet is being modified, it is in the modifying state.

\n

To scale up your EC2 Fleet, increase its target capacity. The EC2 Fleet launches the additional\n Spot Instances according to the allocation strategy for the EC2 Fleet request. If the allocation\n strategy is lowest-price, the EC2 Fleet launches instances using the Spot Instance\n pool with the lowest price. If the allocation strategy is diversified, the\n EC2 Fleet distributes the instances across the Spot Instance pools. If the allocation strategy\n is capacity-optimized, EC2 Fleet launches instances from Spot Instance pools with optimal\n capacity for the number of instances that are launching.

\n

To scale down your EC2 Fleet, decrease its target capacity. First, the EC2 Fleet cancels any open\n requests that exceed the new target capacity. You can request that the EC2 Fleet terminate Spot\n Instances until the size of the fleet no longer exceeds the new target capacity. If the\n allocation strategy is lowest-price, the EC2 Fleet terminates the instances with\n the highest price per unit. If the allocation strategy is capacity-optimized,\n the EC2 Fleet terminates the instances in the Spot Instance pools that have the least available\n Spot Instance capacity. If the allocation strategy is diversified, the EC2 Fleet terminates\n instances across the Spot Instance pools. Alternatively, you can request that the EC2 Fleet keep\n the fleet at its current size, but not replace any Spot Instances that are interrupted or\n that you terminate manually.

\n

If you are finished with your EC2 Fleet for now, but will use it again later, you can set the\n target capacity to 0.

" + } + }, + "com.amazonaws.ec2#ModifyFleetRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ExcessCapacityTerminationPolicy": { + "target": "com.amazonaws.ec2#FleetExcessCapacityTerminationPolicy", + "traits": { + "smithy.api#documentation": "

Indicates whether running instances should be terminated if the total target capacity of\n the EC2 Fleet is decreased below the current size of the EC2 Fleet.

\n

Supported only for fleets of type maintain.

" + } + }, + "LaunchTemplateConfigs": { + "target": "com.amazonaws.ec2#FleetLaunchTemplateConfigListRequest", + "traits": { + "smithy.api#documentation": "

The launch template and overrides.

", + "smithy.api#xmlName": "LaunchTemplateConfig" + } + }, + "FleetId": { + "target": "com.amazonaws.ec2#FleetId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the EC2 Fleet.

", + "smithy.api#required": {} + } + }, + "TargetCapacitySpecification": { + "target": "com.amazonaws.ec2#TargetCapacitySpecificationRequest", + "traits": { + "smithy.api#documentation": "

The size of the EC2 Fleet.

" + } + }, + "Context": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Reserved.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyFleetResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

If the request succeeds, the response returns true. If the request fails,\n no response is returned, and instead an error message is returned.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyFpgaImageAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyFpgaImageAttributeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyFpgaImageAttributeResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the specified attribute of the specified Amazon FPGA Image (AFI).

" + } + }, + "com.amazonaws.ec2#ModifyFpgaImageAttributeRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "FpgaImageId": { + "target": "com.amazonaws.ec2#FpgaImageId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the AFI.

", + "smithy.api#required": {} + } + }, + "Attribute": { + "target": "com.amazonaws.ec2#FpgaImageAttributeName", + "traits": { + "smithy.api#documentation": "

The name of the attribute.

" + } + }, + "OperationType": { + "target": "com.amazonaws.ec2#OperationType", + "traits": { + "smithy.api#documentation": "

The operation type.

" + } + }, + "UserIds": { + "target": "com.amazonaws.ec2#UserIdStringList", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account IDs. This parameter is valid only when modifying the loadPermission attribute.

", + "smithy.api#xmlName": "UserId" + } + }, + "UserGroups": { + "target": "com.amazonaws.ec2#UserGroupStringList", + "traits": { + "smithy.api#documentation": "

The user groups. This parameter is valid only when modifying the loadPermission attribute.

", + "smithy.api#xmlName": "UserGroup" + } + }, + "ProductCodes": { + "target": "com.amazonaws.ec2#ProductCodeStringList", + "traits": { + "smithy.api#documentation": "

The product codes. After you add a product code to an AFI, it can't be removed.\n\t\t This parameter is valid only when modifying the productCodes attribute.

", + "smithy.api#xmlName": "ProductCode" + } + }, + "LoadPermission": { + "target": "com.amazonaws.ec2#LoadPermissionModifications", + "traits": { + "smithy.api#documentation": "

The load permission for the AFI.

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description for the AFI.

" + } + }, + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A name for the AFI.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyFpgaImageAttributeResult": { + "type": "structure", + "members": { + "FpgaImageAttribute": { + "target": "com.amazonaws.ec2#FpgaImageAttribute", + "traits": { + "aws.protocols#ec2QueryName": "FpgaImageAttribute", + "smithy.api#documentation": "

Information about the attribute.

", + "smithy.api#xmlName": "fpgaImageAttribute" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyHosts": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyHostsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyHostsResult" + }, + "traits": { + "smithy.api#documentation": "

Modify the auto-placement setting of a Dedicated Host. When auto-placement is enabled,\n any instances that you launch with a tenancy of host but without a specific\n host ID are placed onto any available Dedicated Host in your account that has\n auto-placement enabled. When auto-placement is disabled, you need to provide a host ID\n to have the instance launch onto a specific host. If no host ID is provided, the\n instance is launched onto a suitable host with auto-placement enabled.

\n

You can also use this API action to modify a Dedicated Host to support either multiple\n instance types in an instance family, or to support a specific instance type\n only.

" + } + }, + "com.amazonaws.ec2#ModifyHostsRequest": { + "type": "structure", + "members": { + "HostRecovery": { + "target": "com.amazonaws.ec2#HostRecovery", + "traits": { + "smithy.api#documentation": "

Indicates whether to enable or disable host recovery for the Dedicated Host. For more\n information, see Host recovery in\n the Amazon EC2 User Guide.

" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Specifies the instance type to be supported by the Dedicated Host. Specify this\n parameter to modify a Dedicated Host to support only a specific instance type.

\n

If you want to modify a Dedicated Host to support multiple instance types in its\n current instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the\n same request.

" + } + }, + "InstanceFamily": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Specifies the instance family to be supported by the Dedicated Host. Specify this\n parameter to modify a Dedicated Host to support multiple instance types within its\n current instance family.

\n

If you want to modify a Dedicated Host to support a specific instance type only, omit\n this parameter and specify InstanceType instead. You\n cannot specify InstanceFamily and InstanceType in the same request.

" + } + }, + "HostMaintenance": { + "target": "com.amazonaws.ec2#HostMaintenance", + "traits": { + "smithy.api#documentation": "

Indicates whether to enable or disable host maintenance for the Dedicated Host. For\n more information, see Host\n maintenance in the Amazon EC2 User Guide.

" + } + }, + "HostIds": { + "target": "com.amazonaws.ec2#RequestHostIdList", + "traits": { + "aws.protocols#ec2QueryName": "HostId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the Dedicated Hosts to modify.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "hostId" + } + }, + "AutoPlacement": { + "target": "com.amazonaws.ec2#AutoPlacement", + "traits": { + "aws.protocols#ec2QueryName": "AutoPlacement", + "smithy.api#documentation": "

Specify whether to enable or disable auto-placement.

", + "smithy.api#xmlName": "autoPlacement" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyHostsResult": { + "type": "structure", + "members": { + "Successful": { + "target": "com.amazonaws.ec2#ResponseHostIdList", + "traits": { + "aws.protocols#ec2QueryName": "Successful", + "smithy.api#documentation": "

The IDs of the Dedicated Hosts that were successfully modified.

", + "smithy.api#xmlName": "successful" + } + }, + "Unsuccessful": { + "target": "com.amazonaws.ec2#UnsuccessfulItemList", + "traits": { + "aws.protocols#ec2QueryName": "Unsuccessful", + "smithy.api#documentation": "

The IDs of the Dedicated Hosts that could not be modified. Check whether the setting\n you requested can be used.

", + "smithy.api#xmlName": "unsuccessful" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyIdFormat": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyIdFormatRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Modifies the ID format for the specified resource on a per-Region basis. You can\n specify that resources should receive longer IDs (17-character IDs) when they are\n created.

\n

This request can only be used to modify longer ID settings for resource types that\n are within the opt-in period. Resources currently in their opt-in period include:\n bundle | conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | internet-gateway | network-acl\n | network-acl-association | network-interface |\n network-interface-attachment | prefix-list |\n route-table | route-table-association |\n security-group | subnet |\n subnet-cidr-block-association | vpc |\n vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

\n

This setting applies to the IAM user who makes the request; it does not apply to the\n entire Amazon Web Services account. By default, an IAM user defaults to the same settings as the root user. If\n you're using this action as the root user, then these settings apply to the entire account,\n unless an IAM user explicitly overrides these settings for themselves. For more information,\n see Resource IDs \n in the Amazon Elastic Compute Cloud User Guide.

\n

Resources created with longer IDs are visible to all IAM roles and users, regardless\n of these settings and provided that they have permission to use the relevant\n Describe command for the resource type.

" + } + }, + "com.amazonaws.ec2#ModifyIdFormatRequest": { + "type": "structure", + "members": { + "Resource": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of resource: bundle | conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | internet-gateway | network-acl\n | network-acl-association | network-interface |\n network-interface-attachment | prefix-list |\n route-table | route-table-association |\n security-group | subnet |\n subnet-cidr-block-association | vpc |\n vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

\n

Alternatively, use the all-current option to include all resource types that are\n currently within their opt-in period for longer IDs.

", + "smithy.api#required": {} + } + }, + "UseLongIds": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Indicate whether the resource should use longer IDs (17-character IDs).

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyIdentityIdFormat": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyIdentityIdFormatRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Modifies the ID format of a resource for a specified IAM user, IAM role, or the root\n user for an account; or all IAM users, IAM roles, and the root user for an account. You can\n specify that resources should receive longer IDs (17-character IDs) when they are created.

\n

This request can only be used to modify longer ID settings for resource types that are\n within the opt-in period. Resources currently in their opt-in period include:\n bundle | conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | internet-gateway | network-acl\n | network-acl-association | network-interface |\n network-interface-attachment | prefix-list |\n route-table | route-table-association |\n security-group | subnet |\n subnet-cidr-block-association | vpc |\n vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

\n

For more information, see Resource IDs in the\n Amazon Elastic Compute Cloud User Guide.

\n

This setting applies to the principal specified in the request; it does not apply to the\n principal that makes the request.

\n

Resources created with longer IDs are visible to all IAM roles and users, regardless of these\n settings and provided that they have permission to use the relevant Describe\n command for the resource type.

" + } + }, + "com.amazonaws.ec2#ModifyIdentityIdFormatRequest": { + "type": "structure", + "members": { + "Resource": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Resource", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of resource: bundle | conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | internet-gateway | network-acl\n | network-acl-association | network-interface |\n network-interface-attachment | prefix-list |\n route-table | route-table-association |\n security-group | subnet |\n subnet-cidr-block-association | vpc |\n vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

\n

Alternatively, use the all-current option to include all resource types that are\n currently within their opt-in period for longer IDs.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "resource" + } + }, + "UseLongIds": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "UseLongIds", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Indicates whether the resource should use longer IDs (17-character IDs)

", + "smithy.api#required": {}, + "smithy.api#xmlName": "useLongIds" + } + }, + "PrincipalArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrincipalArn", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the principal, which can be an IAM user, IAM role, or the root user. Specify\n all to modify the ID format for all IAM users, IAM roles, and the root user of\n the account.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "principalArn" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyImageAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyImageAttributeRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Modifies the specified attribute of the specified AMI. You can specify only one attribute\n at a time.

\n

To specify the attribute, you can use the Attribute parameter, or one of the\n following parameters: Description, ImdsSupport, or\n LaunchPermission.

\n

Images with an Amazon Web Services Marketplace product code cannot be made public.

\n

To enable the SriovNetSupport enhanced networking attribute of an image, enable\n SriovNetSupport on an instance and create an AMI from the instance.

", + "smithy.api#examples": [ + { + "title": "To grant launch permissions", + "documentation": "This example grants launch permissions for the specified AMI to the specified AWS account.", + "input": { + "ImageId": "ami-5731123e", + "LaunchPermission": { + "Add": [ + { + "UserId": "123456789012" + } + ] + } + }, + "output": {} + }, + { + "title": "To make an AMI public", + "documentation": "This example makes the specified AMI public.", + "input": { + "ImageId": "ami-5731123e", + "LaunchPermission": { + "Add": [ + { + "Group": "all" + } + ] + } + }, + "output": {} + } + ] + } + }, + "com.amazonaws.ec2#ModifyImageAttributeRequest": { + "type": "structure", + "members": { + "Attribute": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the attribute to modify.

\n

Valid values: description | imdsSupport |\n launchPermission\n

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "smithy.api#documentation": "

A new description for the AMI.

" + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the AMI.

", + "smithy.api#required": {} + } + }, + "LaunchPermission": { + "target": "com.amazonaws.ec2#LaunchPermissionModifications", + "traits": { + "smithy.api#documentation": "

A new launch permission for the AMI.

" + } + }, + "OperationType": { + "target": "com.amazonaws.ec2#OperationType", + "traits": { + "smithy.api#documentation": "

The operation type. This parameter can be used only when the Attribute\n parameter is launchPermission.

" + } + }, + "ProductCodes": { + "target": "com.amazonaws.ec2#ProductCodeStringList", + "traits": { + "smithy.api#documentation": "

Not supported.

", + "smithy.api#xmlName": "ProductCode" + } + }, + "UserGroups": { + "target": "com.amazonaws.ec2#UserGroupStringList", + "traits": { + "smithy.api#documentation": "

The user groups. This parameter can be used only when the Attribute parameter\n is launchPermission.

", + "smithy.api#xmlName": "UserGroup" + } + }, + "UserIds": { + "target": "com.amazonaws.ec2#UserIdStringList", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account IDs. This parameter can be used only when the\n Attribute parameter is launchPermission.

", + "smithy.api#xmlName": "UserId" + } + }, + "Value": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The value of the attribute being modified. This parameter can be used only when the\n Attribute parameter is description or\n imdsSupport.

" + } + }, + "OrganizationArns": { + "target": "com.amazonaws.ec2#OrganizationArnStringList", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an organization. This parameter can be used only when\n the Attribute parameter is launchPermission.

", + "smithy.api#xmlName": "OrganizationArn" + } + }, + "OrganizationalUnitArns": { + "target": "com.amazonaws.ec2#OrganizationalUnitArnStringList", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an organizational unit (OU). This parameter can be used\n only when the Attribute parameter is launchPermission.

", + "smithy.api#xmlName": "OrganizationalUnitArn" + } + }, + "ImdsSupport": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "smithy.api#documentation": "

Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances\n launched from this AMI will have HttpTokens automatically set to\n required so that, by default, the instance requires that IMDSv2 is used when\n requesting instance metadata. In addition, HttpPutResponseHopLimit is set to\n 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.

\n \n

Do not use this parameter unless your AMI software supports IMDSv2. After you set the\n value to v2.0, you can't undo it. The only way to “reset” your AMI is to create\n a new AMI from the underlying snapshot.

\n " + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for ModifyImageAttribute.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyInstanceAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyInstanceAttributeRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Modifies the specified attribute of the specified instance. You can specify only one\n attribute at a time.

\n

\n Note: Using this action to change the security groups\n associated with an elastic network interface (ENI) attached to an instance can\n result in an error if the instance has more than one ENI. To change the security groups\n associated with an ENI attached to an instance that has multiple ENIs, we recommend that\n you use the ModifyNetworkInterfaceAttribute action.

\n

To modify some attributes, the instance must be stopped. For more information, see\n Modify a stopped instance in the\n Amazon EC2 User Guide.

", + "smithy.api#examples": [ + { + "title": "To enable enhanced networking", + "documentation": "This example enables enhanced networking for the specified stopped instance.", + "input": { + "InstanceId": "i-1234567890abcdef0", + "EnaSupport": { + "Value": true + } + }, + "output": {} + }, + { + "title": "To modify the instance type", + "documentation": "This example modifies the instance type of the specified stopped instance.", + "input": { + "InstanceId": "i-1234567890abcdef0", + "InstanceType": { + "Value": "m5.large" + } + }, + "output": {} + } + ] + } + }, + "com.amazonaws.ec2#ModifyInstanceAttributeRequest": { + "type": "structure", + "members": { + "SourceDestCheck": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "smithy.api#documentation": "

Enable or disable source/destination checks, which ensure that the instance is either\n the source or the destination of any traffic that it receives. If the value is\n true, source/destination checks are enabled; otherwise, they are\n disabled. The default value is true. You must disable source/destination\n checks if the instance runs services such as network address translation, routing, or\n firewalls.

" + } + }, + "DisableApiStop": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "smithy.api#documentation": "

Indicates whether an instance is enabled for stop protection. For more information,\n see Enable stop\n protection for your instance.

\n

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "instanceId" + } + }, + "Attribute": { + "target": "com.amazonaws.ec2#InstanceAttributeName", + "traits": { + "aws.protocols#ec2QueryName": "Attribute", + "smithy.api#documentation": "

The name of the attribute to modify.

\n \n

You can modify the following attributes only: disableApiTermination |\n instanceType | kernel | ramdisk |\n instanceInitiatedShutdownBehavior | blockDeviceMapping\n | userData | sourceDestCheck | groupSet |\n ebsOptimized | sriovNetSupport |\n enaSupport | nvmeSupport | disableApiStop\n | enclaveOptions\n

\n ", + "smithy.api#xmlName": "attribute" + } + }, + "Value": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Value", + "smithy.api#documentation": "

A new value for the attribute. Use only with the kernel,\n ramdisk, userData, disableApiTermination, or\n instanceInitiatedShutdownBehavior attribute.

", + "smithy.api#xmlName": "value" + } + }, + "BlockDeviceMappings": { + "target": "com.amazonaws.ec2#InstanceBlockDeviceMappingSpecificationList", + "traits": { + "aws.protocols#ec2QueryName": "BlockDeviceMapping", + "smithy.api#documentation": "

Modifies the DeleteOnTermination attribute for volumes that are currently\n attached. The volume must be owned by the caller. If no value is specified for\n DeleteOnTermination, the default is true and the volume is\n deleted when the instance is terminated. You can't modify the DeleteOnTermination \n attribute for volumes that are attached to Fargate tasks.

\n

To add instance store volumes to an Amazon EBS-backed instance, you must add them when\n you launch the instance. For more information, see Update the block device mapping when launching an instance in the\n Amazon EC2 User Guide.

", + "smithy.api#xmlName": "blockDeviceMapping" + } + }, + "DisableApiTermination": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "aws.protocols#ec2QueryName": "DisableApiTermination", + "smithy.api#documentation": "

If the value is true, you can't terminate the instance using the Amazon\n EC2 console, CLI, or API; otherwise, you can. You cannot use this parameter for Spot\n Instances.

", + "smithy.api#xmlName": "disableApiTermination" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

Changes the instance type to the specified value. For more information, see Instance\n types in the Amazon EC2 User Guide. If the instance type is\n not valid, the error returned is InvalidInstanceAttributeValue.

", + "smithy.api#xmlName": "instanceType" + } + }, + "Kernel": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "Kernel", + "smithy.api#documentation": "

Changes the instance's kernel to the specified value. We recommend that you use\n PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.

", + "smithy.api#xmlName": "kernel" + } + }, + "Ramdisk": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "Ramdisk", + "smithy.api#documentation": "

Changes the instance's RAM disk to the specified value. We recommend that you use\n PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.

", + "smithy.api#xmlName": "ramdisk" + } + }, + "UserData": { + "target": "com.amazonaws.ec2#BlobAttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "UserData", + "smithy.api#documentation": "

Changes the instance's user data to the specified value. User data must be base64-encoded.\n Depending on the tool or SDK that you're using, the base64-encoding might be performed for you.\n For more information, see Work with instance user data.

", + "smithy.api#xmlName": "userData" + } + }, + "InstanceInitiatedShutdownBehavior": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "InstanceInitiatedShutdownBehavior", + "smithy.api#documentation": "

Specifies whether an instance stops or terminates when you initiate shutdown from the\n instance (using the operating system command for system shutdown).

", + "smithy.api#xmlName": "instanceInitiatedShutdownBehavior" + } + }, + "Groups": { + "target": "com.amazonaws.ec2#GroupIdStringList", + "traits": { + "smithy.api#documentation": "

Replaces the security groups of the instance with the specified security groups.\n You must specify the ID of at least one security group, even if it's just the default\n security group for the VPC.

", + "smithy.api#xmlName": "GroupId" + } + }, + "EbsOptimized": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "aws.protocols#ec2QueryName": "EbsOptimized", + "smithy.api#documentation": "

Specifies whether the instance is optimized for Amazon EBS I/O. This optimization\n provides dedicated throughput to Amazon EBS and an optimized configuration stack to\n provide optimal EBS I/O performance. This optimization isn't available with all instance\n types. Additional usage charges apply when using an EBS Optimized instance.

", + "smithy.api#xmlName": "ebsOptimized" + } + }, + "SriovNetSupport": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "SriovNetSupport", + "smithy.api#documentation": "

Set to simple to enable enhanced networking with the Intel 82599 Virtual\n Function interface for the instance.

\n

There is no way to disable enhanced networking with the Intel 82599 Virtual Function\n interface at this time.

\n

This option is supported only for HVM instances. Specifying this option with a PV\n instance can make it unreachable.

", + "smithy.api#xmlName": "sriovNetSupport" + } + }, + "EnaSupport": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "aws.protocols#ec2QueryName": "EnaSupport", + "smithy.api#documentation": "

Set to true to enable enhanced networking with ENA for the\n instance.

\n

This option is supported only for HVM instances. Specifying this option with a PV\n instance can make it unreachable.

", + "smithy.api#xmlName": "enaSupport" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyInstanceCapacityReservationAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyInstanceCapacityReservationAttributesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyInstanceCapacityReservationAttributesResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the Capacity Reservation settings for a stopped instance. Use this action to \n\t\t\tconfigure an instance to target a specific Capacity Reservation, run in any \n\t\t\topen Capacity Reservation with matching attributes, run in On-Demand \n\t\t\tInstance capacity, or only run in a Capacity Reservation.

" + } + }, + "com.amazonaws.ec2#ModifyInstanceCapacityReservationAttributesRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance to be modified.

", + "smithy.api#required": {} + } + }, + "CapacityReservationSpecification": { + "target": "com.amazonaws.ec2#CapacityReservationSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Information about the Capacity Reservation targeting option.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyInstanceCapacityReservationAttributesResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyInstanceCpuOptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyInstanceCpuOptionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyInstanceCpuOptionsResult" + }, + "traits": { + "smithy.api#documentation": "

By default, all vCPUs for the instance type are active when you launch an instance. When you \n\t\t\tconfigure the number of active vCPUs for the instance, it can help you save on licensing costs and \n\t\t\toptimize performance. The base cost of the instance remains unchanged.

\n

The number of active vCPUs equals the number of threads per CPU core multiplied by the number \n\t\t\tof cores. The instance must be in a Stopped state before you make changes.

\n \n

Some instance type options do not support this capability. For more information, see \n\t\t\t\tSupported CPU \n\t\t\t\t\toptions in the Amazon EC2 User Guide.

\n " + } + }, + "com.amazonaws.ec2#ModifyInstanceCpuOptionsRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance to update.

", + "smithy.api#required": {} + } + }, + "CoreCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of CPU cores to activate for the specified instance.

", + "smithy.api#required": {} + } + }, + "ThreadsPerCore": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of threads to run for each CPU core.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyInstanceCpuOptionsResult": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance that was updated.

", + "smithy.api#xmlName": "instanceId" + } + }, + "CoreCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "CoreCount", + "smithy.api#documentation": "

The number of CPU cores that are running for the specified instance after the \n\t\t\tupdate.

", + "smithy.api#xmlName": "coreCount" + } + }, + "ThreadsPerCore": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "ThreadsPerCore", + "smithy.api#documentation": "

The number of threads that are running per CPU core for the specified \n\t\t\tinstance after the update.

", + "smithy.api#xmlName": "threadsPerCore" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyInstanceCreditSpecification": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyInstanceCreditSpecificationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyInstanceCreditSpecificationResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the credit option for CPU usage on a running or stopped burstable performance\n instance. The credit options are standard and\n unlimited.

\n

For more information, see Burstable\n performance instances in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#ModifyInstanceCreditSpecificationRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring\n Idempotency.

" + } + }, + "InstanceCreditSpecifications": { + "target": "com.amazonaws.ec2#InstanceCreditSpecificationListRequest", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Information about the credit option for CPU usage.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "InstanceCreditSpecification" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyInstanceCreditSpecificationResult": { + "type": "structure", + "members": { + "SuccessfulInstanceCreditSpecifications": { + "target": "com.amazonaws.ec2#SuccessfulInstanceCreditSpecificationSet", + "traits": { + "aws.protocols#ec2QueryName": "SuccessfulInstanceCreditSpecificationSet", + "smithy.api#documentation": "

Information about the instances whose credit option for CPU usage was successfully\n modified.

", + "smithy.api#xmlName": "successfulInstanceCreditSpecificationSet" + } + }, + "UnsuccessfulInstanceCreditSpecifications": { + "target": "com.amazonaws.ec2#UnsuccessfulInstanceCreditSpecificationSet", + "traits": { + "aws.protocols#ec2QueryName": "UnsuccessfulInstanceCreditSpecificationSet", + "smithy.api#documentation": "

Information about the instances whose credit option for CPU usage was not\n modified.

", + "smithy.api#xmlName": "unsuccessfulInstanceCreditSpecificationSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyInstanceEventStartTime": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyInstanceEventStartTimeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyInstanceEventStartTimeResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the start time for a scheduled Amazon EC2 instance event.

" + } + }, + "com.amazonaws.ec2#ModifyInstanceEventStartTimeRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance with the scheduled event.

", + "smithy.api#required": {} + } + }, + "InstanceEventId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the event whose date and time you are modifying.

", + "smithy.api#required": {} + } + }, + "NotBefore": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The new date and time when the event will take place.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyInstanceEventStartTimeResult": { + "type": "structure", + "members": { + "Event": { + "target": "com.amazonaws.ec2#InstanceStatusEvent", + "traits": { + "aws.protocols#ec2QueryName": "Event", + "smithy.api#documentation": "

Information about the event.

", + "smithy.api#xmlName": "event" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyInstanceEventWindow": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyInstanceEventWindowRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyInstanceEventWindowResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the specified event window.

\n

You can define either a set of time ranges or a cron expression when modifying the event\n window, but not both.

\n

To modify the targets associated with the event window, use the AssociateInstanceEventWindow and DisassociateInstanceEventWindow API.

\n

If Amazon Web Services has already scheduled an event, modifying an event window won't change the time\n of the scheduled event.

\n

For more information, see Define event windows for scheduled\n events in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#ModifyInstanceEventWindowRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the event window.

" + } + }, + "InstanceEventWindowId": { + "target": "com.amazonaws.ec2#InstanceEventWindowId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the event window.

", + "smithy.api#required": {} + } + }, + "TimeRanges": { + "target": "com.amazonaws.ec2#InstanceEventWindowTimeRangeRequestSet", + "traits": { + "smithy.api#documentation": "

The time ranges of the event window.

", + "smithy.api#xmlName": "TimeRange" + } + }, + "CronExpression": { + "target": "com.amazonaws.ec2#InstanceEventWindowCronExpression", + "traits": { + "smithy.api#documentation": "

The cron expression of the event window, for example, * 0-4,20-23 * * 1,5.

\n

Constraints:

\n \n

For more information about cron expressions, see cron on the Wikipedia\n website.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyInstanceEventWindowResult": { + "type": "structure", + "members": { + "InstanceEventWindow": { + "target": "com.amazonaws.ec2#InstanceEventWindow", + "traits": { + "aws.protocols#ec2QueryName": "InstanceEventWindow", + "smithy.api#documentation": "

Information about the event window.

", + "smithy.api#xmlName": "instanceEventWindow" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyInstanceMaintenanceOptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyInstanceMaintenanceOptionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyInstanceMaintenanceOptionsResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the recovery behavior of your instance to disable simplified automatic\n recovery or set the recovery behavior to default. The default configuration will not\n enable simplified automatic recovery for an unsupported instance type. For more\n information, see Simplified automatic recovery.

" + } + }, + "com.amazonaws.ec2#ModifyInstanceMaintenanceOptionsRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#required": {} + } + }, + "AutoRecovery": { + "target": "com.amazonaws.ec2#InstanceAutoRecoveryState", + "traits": { + "smithy.api#documentation": "

Disables the automatic recovery behavior of your instance or sets it to\n default.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyInstanceMaintenanceOptionsResult": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#xmlName": "instanceId" + } + }, + "AutoRecovery": { + "target": "com.amazonaws.ec2#InstanceAutoRecoveryState", + "traits": { + "aws.protocols#ec2QueryName": "AutoRecovery", + "smithy.api#documentation": "

Provides information on the current automatic recovery behavior of your\n instance.

", + "smithy.api#xmlName": "autoRecovery" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyInstanceMetadataDefaults": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyInstanceMetadataDefaultsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyInstanceMetadataDefaultsResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the default instance metadata service (IMDS) settings at the account level in\n the specified Amazon Web Services\u2028 Region.

\n \n

To remove a parameter's account-level default setting, specify\n no-preference. If an account-level setting is cleared with\n no-preference, then the instance launch considers the other\n instance metadata settings. For more information, see Order of precedence for instance metadata options in the\n Amazon EC2 User Guide.

\n " + } + }, + "com.amazonaws.ec2#ModifyInstanceMetadataDefaultsRequest": { + "type": "structure", + "members": { + "HttpTokens": { + "target": "com.amazonaws.ec2#MetadataDefaultHttpTokensState", + "traits": { + "smithy.api#documentation": "

Indicates whether IMDSv2 is required.

\n " + } + }, + "HttpPutResponseHopLimit": { + "target": "com.amazonaws.ec2#BoxedInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of hops that the metadata token can travel. To indicate no\n preference, specify -1.

\n

Possible values: Integers from 1 to 64, and -1\n to indicate no preference

" + } + }, + "HttpEndpoint": { + "target": "com.amazonaws.ec2#DefaultInstanceMetadataEndpointState", + "traits": { + "smithy.api#documentation": "

Enables or disables the IMDS endpoint on an instance. When disabled, the instance\n metadata can't be accessed.

" + } + }, + "InstanceMetadataTags": { + "target": "com.amazonaws.ec2#DefaultInstanceMetadataTagsState", + "traits": { + "smithy.api#documentation": "

Enables or disables access to an instance's tags from the instance metadata. For more\n information, see Work with\n instance tags using the instance metadata in the\n Amazon EC2 User Guide.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyInstanceMetadataDefaultsResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

If the request succeeds, the response returns true. If the request fails,\n no response is returned, and instead an error message is returned.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyInstanceMetadataOptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyInstanceMetadataOptionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyInstanceMetadataOptionsResult" + }, + "traits": { + "smithy.api#documentation": "

Modify the instance metadata parameters on a running or stopped instance. When you\n modify the parameters on a stopped instance, they are applied when the instance is\n started. When you modify the parameters on a running instance, the API responds with a\n state of “pending”. After the parameter modifications are successfully applied to the\n instance, the state of the modifications changes from “pending” to “applied” in\n subsequent describe-instances API calls. For more information, see Instance metadata and user data in the\n Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#ModifyInstanceMetadataOptionsRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#required": {} + } + }, + "HttpTokens": { + "target": "com.amazonaws.ec2#HttpTokensState", + "traits": { + "smithy.api#documentation": "

Indicates whether IMDSv2 is required.

\n \n

Default:

\n \n

The default value can also be affected by other combinations of parameters. For more\n information, see Order of precedence for instance metadata options in the\n Amazon EC2 User Guide.

" + } + }, + "HttpPutResponseHopLimit": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The desired HTTP PUT response hop limit for instance metadata requests. The larger the\n number, the further instance metadata requests can travel. If no parameter is specified,\n the existing state is maintained.

\n

Possible values: Integers from 1 to 64

" + } + }, + "HttpEndpoint": { + "target": "com.amazonaws.ec2#InstanceMetadataEndpointState", + "traits": { + "smithy.api#documentation": "

Enables or disables the HTTP metadata endpoint on your instances. If this parameter is\n not specified, the existing state is maintained.

\n

If you specify a value of disabled, you cannot access your instance\n metadata.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" + } + }, + "HttpProtocolIpv6": { + "target": "com.amazonaws.ec2#InstanceMetadataProtocolState", + "traits": { + "smithy.api#documentation": "

Enables or disables the IPv6 endpoint for the instance metadata service. \n Applies only if you enabled the HTTP metadata endpoint.

" + } + }, + "InstanceMetadataTags": { + "target": "com.amazonaws.ec2#InstanceMetadataTagsState", + "traits": { + "smithy.api#documentation": "

Set to enabled to allow access to instance tags from the instance\n metadata. Set to disabled to turn off access to instance tags from the\n instance metadata. For more information, see Work with\n instance tags using the instance metadata.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyInstanceMetadataOptionsResult": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#xmlName": "instanceId" + } + }, + "InstanceMetadataOptions": { + "target": "com.amazonaws.ec2#InstanceMetadataOptionsResponse", + "traits": { + "aws.protocols#ec2QueryName": "InstanceMetadataOptions", + "smithy.api#documentation": "

The metadata options for the instance.

", + "smithy.api#xmlName": "instanceMetadataOptions" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyInstanceNetworkPerformanceOptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyInstanceNetworkPerformanceRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyInstanceNetworkPerformanceResult" + }, + "traits": { + "smithy.api#documentation": "

Change the configuration of the network performance options for an existing \n \tinstance.

" + } + }, + "com.amazonaws.ec2#ModifyInstanceNetworkPerformanceRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance to update.

", + "smithy.api#required": {} + } + }, + "BandwidthWeighting": { + "target": "com.amazonaws.ec2#InstanceBandwidthWeighting", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specify the bandwidth weighting option to boost the associated type of baseline bandwidth, as follows:

\n
\n
default
\n
\n

This option uses the standard bandwidth configuration for your instance type.

\n
\n
vpc-1
\n
\n

This option boosts your networking baseline bandwidth and reduces your EBS \n \t\t\t\t\tbaseline bandwidth.

\n
\n
ebs-1
\n
\n

This option boosts your EBS baseline bandwidth and reduces your networking \n \t\t\t\t\tbaseline bandwidth.

\n
\n
", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyInstanceNetworkPerformanceResult": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The instance ID that was updated.

", + "smithy.api#xmlName": "instanceId" + } + }, + "BandwidthWeighting": { + "target": "com.amazonaws.ec2#InstanceBandwidthWeighting", + "traits": { + "aws.protocols#ec2QueryName": "BandwidthWeighting", + "smithy.api#documentation": "

Contains the updated configuration for bandwidth weighting on the specified instance.

", + "smithy.api#xmlName": "bandwidthWeighting" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyInstancePlacement": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyInstancePlacementRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyInstancePlacementResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the placement attributes for a specified instance. You can do the\n following:

\n \n

At least one attribute for affinity, host ID, tenancy, or placement group name must be\n specified in the request. Affinity and tenancy can be modified in the same\n request.

\n

To modify the host ID, tenancy, placement group, or partition for an instance, the\n instance must be in the stopped state.

" + } + }, + "com.amazonaws.ec2#ModifyInstancePlacementRequest": { + "type": "structure", + "members": { + "GroupName": { + "target": "com.amazonaws.ec2#PlacementGroupName", + "traits": { + "smithy.api#documentation": "

The name of the placement group in which to place the instance. For spread placement\n groups, the instance must have a tenancy of default. For cluster and\n partition placement groups, the instance must have a tenancy of default or\n dedicated.

\n

To remove an instance from a placement group, specify an empty string (\"\").

" + } + }, + "PartitionNumber": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The number of the partition in which to place the instance. Valid only if the\n placement group strategy is set to partition.

" + } + }, + "HostResourceGroupArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ARN of the host resource group in which to place the instance. The instance must\n have a tenancy of host to specify this parameter.

" + } + }, + "GroupId": { + "target": "com.amazonaws.ec2#PlacementGroupId", + "traits": { + "smithy.api#documentation": "

The Group Id of a placement group. You must specify the Placement Group Group Id to launch an instance in a shared placement\n group.

" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance that you are modifying.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "instanceId" + } + }, + "Tenancy": { + "target": "com.amazonaws.ec2#HostTenancy", + "traits": { + "aws.protocols#ec2QueryName": "Tenancy", + "smithy.api#documentation": "

The tenancy for the instance.

\n \n

For T3 instances, you must launch the instance on a Dedicated Host to use a\n tenancy of host. You can't change the tenancy from\n host to dedicated or default.\n Attempting to make one of these unsupported tenancy changes results in an\n InvalidRequest error code.

\n ", + "smithy.api#xmlName": "tenancy" + } + }, + "Affinity": { + "target": "com.amazonaws.ec2#Affinity", + "traits": { + "aws.protocols#ec2QueryName": "Affinity", + "smithy.api#documentation": "

The affinity setting for the instance. For more information, see Host affinity in the Amazon EC2 User Guide.

", + "smithy.api#xmlName": "affinity" + } + }, + "HostId": { + "target": "com.amazonaws.ec2#DedicatedHostId", + "traits": { + "aws.protocols#ec2QueryName": "HostId", + "smithy.api#documentation": "

The ID of the Dedicated Host with which to associate the instance.

", + "smithy.api#xmlName": "hostId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyInstancePlacementResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Is true if the request succeeds, and an error otherwise.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyIpam": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyIpamRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyIpamResult" + }, + "traits": { + "smithy.api#documentation": "

Modify the configurations of an IPAM.\n

" + } + }, + "com.amazonaws.ec2#ModifyIpamPool": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyIpamPoolRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyIpamPoolResult" + }, + "traits": { + "smithy.api#documentation": "

Modify the configurations of an IPAM pool.

\n

For more information, see Modify a pool in the Amazon VPC IPAM User Guide.\n

" + } + }, + "com.amazonaws.ec2#ModifyIpamPoolRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the IPAM pool you want to modify.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The description of the IPAM pool you want to modify.

" + } + }, + "AutoImport": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

If true, IPAM will continuously look for resources within the CIDR range of this pool \n and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for\n these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import \n a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently \n marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM \n discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.\n

\n

A locale must be set on the pool for this feature to work.

" + } + }, + "AllocationMinNetmaskLength": { + "target": "com.amazonaws.ec2#IpamNetmaskLength", + "traits": { + "smithy.api#documentation": "

The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. Possible \n netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. The minimum netmask \n length must be less than the maximum netmask length.

" + } + }, + "AllocationMaxNetmaskLength": { + "target": "com.amazonaws.ec2#IpamNetmaskLength", + "traits": { + "smithy.api#documentation": "

The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. Possible \n netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.The maximum netmask \n length must be greater than the minimum netmask length.

" + } + }, + "AllocationDefaultNetmaskLength": { + "target": "com.amazonaws.ec2#IpamNetmaskLength", + "traits": { + "smithy.api#documentation": "

The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.

" + } + }, + "ClearAllocationDefaultNetmaskLength": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Clear the default netmask length allocation rule for this pool.

" + } + }, + "AddAllocationResourceTags": { + "target": "com.amazonaws.ec2#RequestIpamResourceTagList", + "traits": { + "smithy.api#documentation": "

Add tag allocation rules to a pool. For more information about allocation rules, see Create a top-level pool in the Amazon VPC IPAM User Guide.

", + "smithy.api#xmlName": "AddAllocationResourceTag" + } + }, + "RemoveAllocationResourceTags": { + "target": "com.amazonaws.ec2#RequestIpamResourceTagList", + "traits": { + "smithy.api#documentation": "

Remove tag allocation rules from a pool.

", + "smithy.api#xmlName": "RemoveAllocationResourceTag" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyIpamPoolResult": { + "type": "structure", + "members": { + "IpamPool": { + "target": "com.amazonaws.ec2#IpamPool", + "traits": { + "aws.protocols#ec2QueryName": "IpamPool", + "smithy.api#documentation": "

The results of the modification.

", + "smithy.api#xmlName": "ipamPool" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyIpamRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamId": { + "target": "com.amazonaws.ec2#IpamId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the IPAM you want to modify.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The description of the IPAM you want to modify.

" + } + }, + "AddOperatingRegions": { + "target": "com.amazonaws.ec2#AddIpamOperatingRegionSet", + "traits": { + "smithy.api#documentation": "

Choose the operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

\n

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.

", + "smithy.api#xmlName": "AddOperatingRegion" + } + }, + "RemoveOperatingRegions": { + "target": "com.amazonaws.ec2#RemoveIpamOperatingRegionSet", + "traits": { + "smithy.api#documentation": "

The operating Regions to remove.

", + "smithy.api#xmlName": "RemoveOperatingRegion" + } + }, + "Tier": { + "target": "com.amazonaws.ec2#IpamTier", + "traits": { + "smithy.api#documentation": "

IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.

" + } + }, + "EnablePrivateGua": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyIpamResourceCidr": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyIpamResourceCidrRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyIpamResourceCidrResult" + }, + "traits": { + "smithy.api#documentation": "

Modify a resource CIDR. You can use this action to transfer resource CIDRs between scopes and ignore resource CIDRs that you do not want to manage. If set to false, the resource will not be tracked for overlap, it cannot be auto-imported into a pool, and it will be removed from any pool it has an allocation in.

\n

For more information, see Move resource CIDRs between scopes and Change the monitoring state of resource CIDRs in the Amazon VPC IPAM User Guide.

" + } + }, + "com.amazonaws.ec2#ModifyIpamResourceCidrRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the resource you want to modify.

", + "smithy.api#required": {} + } + }, + "ResourceCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The CIDR of the resource you want to modify.

", + "smithy.api#required": {} + } + }, + "ResourceRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Web Services Region of the resource you want to modify.

", + "smithy.api#required": {} + } + }, + "CurrentIpamScopeId": { + "target": "com.amazonaws.ec2#IpamScopeId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the current scope that the resource CIDR is in.

", + "smithy.api#required": {} + } + }, + "DestinationIpamScopeId": { + "target": "com.amazonaws.ec2#IpamScopeId", + "traits": { + "smithy.api#documentation": "

The ID of the scope you want to transfer the resource CIDR to.

" + } + }, + "Monitored": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Determines if the resource is monitored by IPAM. If a resource is monitored, the resource is discovered by IPAM and you can view details about the resource’s CIDR.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyIpamResourceCidrResult": { + "type": "structure", + "members": { + "IpamResourceCidr": { + "target": "com.amazonaws.ec2#IpamResourceCidr", + "traits": { + "aws.protocols#ec2QueryName": "IpamResourceCidr", + "smithy.api#documentation": "

The CIDR of the resource.

", + "smithy.api#xmlName": "ipamResourceCidr" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyIpamResourceDiscovery": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyIpamResourceDiscoveryRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyIpamResourceDiscoveryResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies a resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

" + } + }, + "com.amazonaws.ec2#ModifyIpamResourceDiscoveryRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamResourceDiscoveryId": { + "target": "com.amazonaws.ec2#IpamResourceDiscoveryId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A resource discovery ID.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A resource discovery description.

" + } + }, + "AddOperatingRegions": { + "target": "com.amazonaws.ec2#AddIpamOperatingRegionSet", + "traits": { + "smithy.api#documentation": "

Add operating Regions to the resource discovery. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

", + "smithy.api#xmlName": "AddOperatingRegion" + } + }, + "RemoveOperatingRegions": { + "target": "com.amazonaws.ec2#RemoveIpamOperatingRegionSet", + "traits": { + "smithy.api#documentation": "

Remove operating Regions.

", + "smithy.api#xmlName": "RemoveOperatingRegion" + } + }, + "AddOrganizationalUnitExclusions": { + "target": "com.amazonaws.ec2#AddIpamOrganizationalUnitExclusionSet", + "traits": { + "smithy.api#documentation": "

Add an Organizational Unit (OU) exclusion to your IPAM. If your IPAM is integrated with Amazon Web Services Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion. There is a limit on the number of exclusions you can create. For more information, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.

", + "smithy.api#xmlName": "AddOrganizationalUnitExclusion" + } + }, + "RemoveOrganizationalUnitExclusions": { + "target": "com.amazonaws.ec2#RemoveIpamOrganizationalUnitExclusionSet", + "traits": { + "smithy.api#documentation": "

Remove an Organizational Unit (OU) exclusion to your IPAM. If your IPAM is integrated with Amazon Web Services Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion. There is a limit on the number of exclusions you can create. For more information, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.

", + "smithy.api#xmlName": "RemoveOrganizationalUnitExclusion" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyIpamResourceDiscoveryResult": { + "type": "structure", + "members": { + "IpamResourceDiscovery": { + "target": "com.amazonaws.ec2#IpamResourceDiscovery", + "traits": { + "aws.protocols#ec2QueryName": "IpamResourceDiscovery", + "smithy.api#documentation": "

A resource discovery.

", + "smithy.api#xmlName": "ipamResourceDiscovery" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyIpamResult": { + "type": "structure", + "members": { + "Ipam": { + "target": "com.amazonaws.ec2#Ipam", + "traits": { + "aws.protocols#ec2QueryName": "Ipam", + "smithy.api#documentation": "

The results of the modification.

", + "smithy.api#xmlName": "ipam" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyIpamScope": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyIpamScopeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyIpamScopeResult" + }, + "traits": { + "smithy.api#documentation": "

Modify an IPAM scope.

" + } + }, + "com.amazonaws.ec2#ModifyIpamScopeRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamScopeId": { + "target": "com.amazonaws.ec2#IpamScopeId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the scope you want to modify.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The description of the scope you want to modify.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyIpamScopeResult": { + "type": "structure", + "members": { + "IpamScope": { + "target": "com.amazonaws.ec2#IpamScope", + "traits": { + "aws.protocols#ec2QueryName": "IpamScope", + "smithy.api#documentation": "

The results of the modification.

", + "smithy.api#xmlName": "ipamScope" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyLaunchTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyLaunchTemplateRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyLaunchTemplateResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies a launch template. You can specify which version of the launch template to\n set as the default version. When launching an instance, the default version applies when\n a launch template version is not specified.

", + "smithy.api#examples": [ + { + "title": "To change the default version of a launch template", + "documentation": "This example specifies version 2 as the default version of the specified launch template.", + "input": { + "LaunchTemplateId": "lt-0abcd290751193123", + "DefaultVersion": "2" + }, + "output": { + "LaunchTemplate": { + "LatestVersionNumber": 2, + "LaunchTemplateId": "lt-0abcd290751193123", + "LaunchTemplateName": "WebServers", + "DefaultVersionNumber": 2, + "CreatedBy": "arn:aws:iam::123456789012:root", + "CreateTime": "2017-12-01T13:35:46.000Z" + } + } + } + ] + } + }, + "com.amazonaws.ec2#ModifyLaunchTemplateRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n idempotency.

\n

Constraint: Maximum 128 ASCII characters.

" + } + }, + "LaunchTemplateId": { + "target": "com.amazonaws.ec2#LaunchTemplateId", + "traits": { + "smithy.api#documentation": "

The ID of the launch template.

\n

You must specify either the launch template ID or the\n launch template name, but not both.

" + } + }, + "LaunchTemplateName": { + "target": "com.amazonaws.ec2#LaunchTemplateName", + "traits": { + "smithy.api#documentation": "

The name of the launch template.

\n

You must specify either the launch template ID or the\n launch template name, but not both.

" + } + }, + "DefaultVersion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The version number of the launch template to set as the default version.

", + "smithy.api#xmlName": "SetDefaultVersion" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyLaunchTemplateResult": { + "type": "structure", + "members": { + "LaunchTemplate": { + "target": "com.amazonaws.ec2#LaunchTemplate", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplate", + "smithy.api#documentation": "

Information about the launch template.

", + "smithy.api#xmlName": "launchTemplate" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyLocalGatewayRoute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyLocalGatewayRouteRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyLocalGatewayRouteResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the specified local gateway route.

" + } + }, + "com.amazonaws.ec2#ModifyLocalGatewayRouteRequest": { + "type": "structure", + "members": { + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The CIDR block used for destination matches. The value that you provide must match the CIDR of an existing route in the table.

" + } + }, + "LocalGatewayRouteTableId": { + "target": "com.amazonaws.ec2#LocalGatewayRoutetableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the local gateway route table.

", + "smithy.api#required": {} + } + }, + "LocalGatewayVirtualInterfaceGroupId": { + "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupId", + "traits": { + "smithy.api#documentation": "

\n The ID of the virtual interface group.\n

" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "smithy.api#documentation": "

The ID of the network interface.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "DestinationPrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "smithy.api#documentation": "

\n The ID of the prefix list. Use a prefix list in place of DestinationCidrBlock. You \n cannot use DestinationPrefixListId and DestinationCidrBlock in the same request.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyLocalGatewayRouteResult": { + "type": "structure", + "members": { + "Route": { + "target": "com.amazonaws.ec2#LocalGatewayRoute", + "traits": { + "aws.protocols#ec2QueryName": "Route", + "smithy.api#documentation": "

Information about the local gateway route table.

", + "smithy.api#xmlName": "route" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyManagedPrefixList": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyManagedPrefixListRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyManagedPrefixListResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the specified managed prefix list.

\n

Adding or removing entries in a prefix list creates a new version of the prefix list.\n Changing the name of the prefix list does not affect the version.

\n

If you specify a current version number that does not match the true current version\n number, the request fails.

" + } + }, + "com.amazonaws.ec2#ModifyManagedPrefixListRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "PrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the prefix list.

", + "smithy.api#required": {} + } + }, + "CurrentVersion": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "smithy.api#documentation": "

The current version of the prefix list.

" + } + }, + "PrefixListName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A name for the prefix list.

" + } + }, + "AddEntries": { + "target": "com.amazonaws.ec2#AddPrefixListEntries", + "traits": { + "smithy.api#documentation": "

One or more entries to add to the prefix list.

", + "smithy.api#xmlName": "AddEntry" + } + }, + "RemoveEntries": { + "target": "com.amazonaws.ec2#RemovePrefixListEntries", + "traits": { + "smithy.api#documentation": "

One or more entries to remove from the prefix list.

", + "smithy.api#xmlName": "RemoveEntry" + } + }, + "MaxEntries": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of entries for the prefix list. You cannot modify the entries \n of a prefix list and modify the size of a prefix list at the same time.

\n

If any of the resources that reference the prefix list cannot support the new\n maximum size, the modify operation fails. Check the state message for the IDs of \n the first ten resources that do not support the new maximum size.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyManagedPrefixListResult": { + "type": "structure", + "members": { + "PrefixList": { + "target": "com.amazonaws.ec2#ManagedPrefixList", + "traits": { + "aws.protocols#ec2QueryName": "PrefixList", + "smithy.api#documentation": "

Information about the prefix list.

", + "smithy.api#xmlName": "prefixList" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyNetworkInterfaceAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyNetworkInterfaceAttributeRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Modifies the specified network interface attribute. You can specify only one\n attribute at a time. You can use this action to attach and detach security groups from\n an existing EC2 instance.

", + "smithy.api#examples": [ + { + "title": "To modify the attachment attribute of a network interface", + "documentation": "This example modifies the attachment attribute of the specified network interface.", + "input": { + "NetworkInterfaceId": "eni-686ea200", + "Attachment": { + "AttachmentId": "eni-attach-43348162", + "DeleteOnTermination": false + } + } + }, + { + "title": "To modify the description attribute of a network interface", + "documentation": "This example modifies the description attribute of the specified network interface.", + "input": { + "NetworkInterfaceId": "eni-686ea200", + "Description": { + "Value": "My description" + } + } + }, + { + "title": "To modify the groupSet attribute of a network interface", + "documentation": "This example command modifies the groupSet attribute of the specified network interface.", + "input": { + "NetworkInterfaceId": "eni-686ea200", + "Groups": [ + "sg-903004f8", + "sg-1a2b3c4d" + ] + } + }, + { + "title": "To modify the sourceDestCheck attribute of a network interface", + "documentation": "This example command modifies the sourceDestCheck attribute of the specified network interface.", + "input": { + "NetworkInterfaceId": "eni-686ea200", + "SourceDestCheck": { + "Value": false + } + } + } + ] + } + }, + "com.amazonaws.ec2#ModifyNetworkInterfaceAttributeRequest": { + "type": "structure", + "members": { + "EnaSrdSpecification": { + "target": "com.amazonaws.ec2#EnaSrdSpecification", + "traits": { + "smithy.api#documentation": "

Updates the ENA Express configuration for the network interface that’s attached to the\n\t\t\tinstance.

" + } + }, + "EnablePrimaryIpv6": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

If you’re modifying a network interface in a dual-stack or IPv6-only subnet, you have\n the option to assign a primary IPv6 IP address. A primary IPv6 address is an IPv6 GUA\n address associated with an ENI that you have enabled to use a primary IPv6 address. Use\n this option if the instance that this ENI will be attached to relies on its IPv6 address\n not changing. Amazon Web Services will automatically assign an IPv6 address associated\n with the ENI attached to your instance to be the primary IPv6 address. Once you enable\n an IPv6 GUA address to be a primary IPv6, you cannot disable it. When you enable an IPv6\n GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6\n address until the instance is terminated or the network interface is detached. If you\n have multiple IPv6 addresses associated with an ENI attached to your instance and you\n enable a primary IPv6 address, the first IPv6 GUA address associated with the ENI\n becomes the primary IPv6 address.

" + } + }, + "ConnectionTrackingSpecification": { + "target": "com.amazonaws.ec2#ConnectionTrackingSpecificationRequest", + "traits": { + "smithy.api#documentation": "

A connection tracking specification.

" + } + }, + "AssociatePublicIpAddress": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether to assign a public IPv4 address to a network interface. \n This option can be enabled for any network interface but will only apply to the primary network interface (eth0).

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "Description": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description for the network interface.

", + "smithy.api#xmlName": "description" + } + }, + "SourceDestCheck": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "aws.protocols#ec2QueryName": "SourceDestCheck", + "smithy.api#documentation": "

Enable or disable source/destination checks, which ensure that the instance\n is either the source or the destination of any traffic that it receives.\n If the value is true, source/destination checks are enabled;\n otherwise, they are disabled. The default value is true. \n You must disable source/destination checks if the instance runs services \n such as network address translation, routing, or firewalls.

", + "smithy.api#xmlName": "sourceDestCheck" + } + }, + "Groups": { + "target": "com.amazonaws.ec2#SecurityGroupIdStringList", + "traits": { + "smithy.api#documentation": "

Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name.

", + "smithy.api#xmlName": "SecurityGroupId" + } + }, + "Attachment": { + "target": "com.amazonaws.ec2#NetworkInterfaceAttachmentChanges", + "traits": { + "aws.protocols#ec2QueryName": "Attachment", + "smithy.api#documentation": "

Information about the interface attachment. If modifying the delete on\n\t\t\t\ttermination attribute, you must specify the ID of the interface\n\t\t\tattachment.

", + "smithy.api#xmlName": "attachment" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for ModifyNetworkInterfaceAttribute.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyPrivateDnsNameOptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyPrivateDnsNameOptionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyPrivateDnsNameOptionsResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the options for instance hostnames for the specified instance.

" + } + }, + "com.amazonaws.ec2#ModifyPrivateDnsNameOptionsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#required": {} + } + }, + "PrivateDnsHostnameType": { + "target": "com.amazonaws.ec2#HostnameType", + "traits": { + "smithy.api#documentation": "

The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name\n must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name\n must be based on the instance ID. For dual-stack subnets, you can specify whether DNS\n names use the instance IPv4 address or the instance ID.

" + } + }, + "EnableResourceNameDnsARecord": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether to respond to DNS queries for instance hostnames with DNS A\n records.

" + } + }, + "EnableResourceNameDnsAAAARecord": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA\n records.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyPrivateDnsNameOptionsResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an\n error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyReservedInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyReservedInstancesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyReservedInstancesResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the configuration of your Reserved Instances, such as the Availability Zone, \n instance count, or instance type. The Reserved Instances to be modified must be identical, \n except for Availability Zone, network platform, and instance type.

\n

For more information, see Modify Reserved Instances in the\n Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#ModifyReservedInstancesRequest": { + "type": "structure", + "members": { + "ReservedInstancesIds": { + "target": "com.amazonaws.ec2#ReservedInstancesIdStringList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the Reserved Instances to modify.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "ReservedInstancesId" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see \n \t\tEnsuring Idempotency.

", + "smithy.api#xmlName": "clientToken" + } + }, + "TargetConfigurations": { + "target": "com.amazonaws.ec2#ReservedInstancesConfigurationList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The configuration settings for the Reserved Instances to modify.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "ReservedInstancesConfigurationSetItemType" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for ModifyReservedInstances.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyReservedInstancesResult": { + "type": "structure", + "members": { + "ReservedInstancesModificationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstancesModificationId", + "smithy.api#documentation": "

The ID for the modification.

", + "smithy.api#xmlName": "reservedInstancesModificationId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of ModifyReservedInstances.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifySecurityGroupRules": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifySecurityGroupRulesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifySecurityGroupRulesResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the rules of a security group.

" + } + }, + "com.amazonaws.ec2#ModifySecurityGroupRulesRequest": { + "type": "structure", + "members": { + "GroupId": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the security group.

", + "smithy.api#required": {} + } + }, + "SecurityGroupRules": { + "target": "com.amazonaws.ec2#SecurityGroupRuleUpdateList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Information about the security group properties to update.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "SecurityGroupRule" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifySecurityGroupRulesResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifySnapshotAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifySnapshotAttributeRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Adds or removes permission settings for the specified snapshot. You may add or remove\n specified Amazon Web Services account IDs from a snapshot's list of create volume permissions, but you cannot\n do both in a single operation. If you need to both add and remove account IDs for a snapshot,\n you must use multiple operations. You can make up to 500 modifications to a snapshot in a single operation.

\n

Encrypted snapshots and snapshots with Amazon Web Services Marketplace product codes cannot be made\n public. Snapshots encrypted with your default KMS key cannot be shared with other accounts.

\n

For more information about modifying snapshot permissions, see Share a snapshot in the\n Amazon EBS User Guide.

", + "smithy.api#examples": [ + { + "title": "To make a snapshot public", + "documentation": "This example makes the snapshot ``snap-1234567890abcdef0`` public.", + "input": { + "SnapshotId": "snap-1234567890abcdef0", + "Attribute": "createVolumePermission", + "OperationType": "add", + "GroupNames": [ + "all" + ] + }, + "output": {} + }, + { + "title": "To modify a snapshot attribute", + "documentation": "This example modifies snapshot ``snap-1234567890abcdef0`` to remove the create volume permission for a user with the account ID ``123456789012``. If the command succeeds, no output is returned.", + "input": { + "SnapshotId": "snap-1234567890abcdef0", + "Attribute": "createVolumePermission", + "OperationType": "remove", + "UserIds": [ + "123456789012" + ] + }, + "output": {} + } + ] + } + }, + "com.amazonaws.ec2#ModifySnapshotAttributeRequest": { + "type": "structure", + "members": { + "Attribute": { + "target": "com.amazonaws.ec2#SnapshotAttributeName", + "traits": { + "smithy.api#documentation": "

The snapshot attribute to modify. Only volume creation permissions can be modified.

" + } + }, + "CreateVolumePermission": { + "target": "com.amazonaws.ec2#CreateVolumePermissionModifications", + "traits": { + "smithy.api#documentation": "

A JSON representation of the snapshot attribute modification.

" + } + }, + "GroupNames": { + "target": "com.amazonaws.ec2#GroupNameStringList", + "traits": { + "smithy.api#documentation": "

The group to modify for the snapshot.

", + "smithy.api#xmlName": "UserGroup" + } + }, + "OperationType": { + "target": "com.amazonaws.ec2#OperationType", + "traits": { + "smithy.api#documentation": "

The type of operation to perform to the attribute.

" + } + }, + "SnapshotId": { + "target": "com.amazonaws.ec2#SnapshotId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the snapshot.

", + "smithy.api#required": {} + } + }, + "UserIds": { + "target": "com.amazonaws.ec2#UserIdStringList", + "traits": { + "smithy.api#documentation": "

The account ID to modify for the snapshot.

", + "smithy.api#xmlName": "UserId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifySnapshotTier": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifySnapshotTierRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifySnapshotTierResult" + }, + "traits": { + "smithy.api#documentation": "

Archives an Amazon EBS snapshot. When you archive a snapshot, it is converted to a full \n snapshot that includes all of the blocks of data that were written to the volume at the \n time the snapshot was created, and moved from the standard tier to the archive \n tier. For more information, see Archive Amazon EBS snapshots \n in the Amazon EBS User Guide.

" + } + }, + "com.amazonaws.ec2#ModifySnapshotTierRequest": { + "type": "structure", + "members": { + "SnapshotId": { + "target": "com.amazonaws.ec2#SnapshotId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the snapshot.

", + "smithy.api#required": {} + } + }, + "StorageTier": { + "target": "com.amazonaws.ec2#TargetStorageTier", + "traits": { + "smithy.api#documentation": "

The name of the storage tier. You must specify archive.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifySnapshotTierResult": { + "type": "structure", + "members": { + "SnapshotId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The ID of the snapshot.

", + "smithy.api#xmlName": "snapshotId" + } + }, + "TieringStartTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "TieringStartTime", + "smithy.api#documentation": "

The date and time when the archive process was started.

", + "smithy.api#xmlName": "tieringStartTime" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifySpotFleetRequest": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifySpotFleetRequestRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifySpotFleetRequestResponse" + }, + "traits": { + "smithy.api#documentation": "

Modifies the specified Spot Fleet request.

\n

You can only modify a Spot Fleet request of type maintain.

\n

While the Spot Fleet request is being modified, it is in the modifying\n state.

\n

To scale up your Spot Fleet, increase its target capacity. The Spot Fleet launches the\n additional Spot Instances according to the allocation strategy for the Spot Fleet\n request. If the allocation strategy is lowestPrice, the Spot Fleet launches\n instances using the Spot Instance pool with the lowest price. If the allocation strategy\n is diversified, the Spot Fleet distributes the instances across the Spot\n Instance pools. If the allocation strategy is capacityOptimized, Spot Fleet\n launches instances from Spot Instance pools with optimal capacity for the number of instances\n that are launching.

\n

To scale down your Spot Fleet, decrease its target capacity. First, the Spot Fleet\n cancels any open requests that exceed the new target capacity. You can request that the\n Spot Fleet terminate Spot Instances until the size of the fleet no longer exceeds the\n new target capacity. If the allocation strategy is lowestPrice, the Spot\n Fleet terminates the instances with the highest price per unit. If the allocation\n strategy is capacityOptimized, the Spot Fleet terminates the instances in\n the Spot Instance pools that have the least available Spot Instance capacity. If the allocation\n strategy is diversified, the Spot Fleet terminates instances across the\n Spot Instance pools. Alternatively, you can request that the Spot Fleet keep the fleet\n at its current size, but not replace any Spot Instances that are interrupted or that you\n terminate manually.

\n

If you are finished with your Spot Fleet for now, but will use it again later, you can\n set the target capacity to 0.

", + "smithy.api#examples": [ + { + "title": "To increase the target capacity of a Spot fleet request", + "documentation": "This example increases the target capacity of the specified Spot fleet request.", + "input": { + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", + "TargetCapacity": 20 + }, + "output": { + "Return": true + } + } + ] + } + }, + "com.amazonaws.ec2#ModifySpotFleetRequestRequest": { + "type": "structure", + "members": { + "LaunchTemplateConfigs": { + "target": "com.amazonaws.ec2#LaunchTemplateConfigList", + "traits": { + "smithy.api#documentation": "

The launch template and overrides. You can only use this parameter if you specified a\n launch template (LaunchTemplateConfigs) in your Spot Fleet request. If you\n specified LaunchSpecifications in your Spot Fleet request, then omit this\n parameter.

", + "smithy.api#xmlName": "LaunchTemplateConfig" + } + }, + "OnDemandTargetCapacity": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The number of On-Demand Instances in the fleet.

" + } + }, + "Context": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Reserved.

" + } + }, + "SpotFleetRequestId": { + "target": "com.amazonaws.ec2#SpotFleetRequestId", + "traits": { + "aws.protocols#ec2QueryName": "SpotFleetRequestId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Spot Fleet request.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "spotFleetRequestId" + } + }, + "TargetCapacity": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TargetCapacity", + "smithy.api#documentation": "

The size of the fleet.

", + "smithy.api#xmlName": "targetCapacity" + } + }, + "ExcessCapacityTerminationPolicy": { + "target": "com.amazonaws.ec2#ExcessCapacityTerminationPolicy", + "traits": { + "aws.protocols#ec2QueryName": "ExcessCapacityTerminationPolicy", + "smithy.api#documentation": "

Indicates whether running instances should be terminated if the target capacity\n of the Spot Fleet request is decreased below the current size of the Spot Fleet.

\n

Supported only for fleets of type maintain.

", + "smithy.api#xmlName": "excessCapacityTerminationPolicy" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for ModifySpotFleetRequest.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifySpotFleetRequestResponse": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

If the request succeeds, the response returns true. If the request fails,\n no response is returned, and instead an error message is returned.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of ModifySpotFleetRequest.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifySubnetAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifySubnetAttributeRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Modifies a subnet attribute. You can only modify one attribute at a time.

\n

Use this action to modify subnets on Amazon Web Services Outposts.

\n \n

For more information about Amazon Web Services Outposts, see the following:

\n ", + "smithy.api#examples": [ + { + "title": "To change a subnet's public IP addressing behavior", + "documentation": "This example modifies the specified subnet so that all instances launched into this subnet are assigned a public IP address.", + "input": { + "SubnetId": "subnet-1a2b3c4d", + "MapPublicIpOnLaunch": { + "Value": true + } + } + } + ] + } + }, + "com.amazonaws.ec2#ModifySubnetAttributeRequest": { + "type": "structure", + "members": { + "AssignIpv6AddressOnCreation": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "smithy.api#documentation": "

Specify true to indicate that network interfaces created in the\n specified subnet should be assigned an IPv6 address. This includes a network interface\n that's created when launching an instance into the subnet (the instance therefore\n receives an IPv6 address).

\n

If you enable the IPv6 addressing feature for your subnet, your network interface\n or instance only receives an IPv6 address if it's created using version\n 2016-11-15 or later of the Amazon EC2 API.

" + } + }, + "MapPublicIpOnLaunch": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "smithy.api#documentation": "

Specify true to indicate that network interfaces attached to instances created in the\n specified subnet should be assigned a public IPv4 address.

\n

Amazon Web Services charges for all public IPv4 addresses, including public IPv4 addresses \nassociated with running instances and Elastic IP addresses. For more information, see the Public IPv4 Address tab on the Amazon VPC pricing page.

" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the subnet.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "subnetId" + } + }, + "MapCustomerOwnedIpOnLaunch": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "smithy.api#documentation": "

Specify true to indicate that network interfaces attached to instances created in the\n specified subnet should be assigned a customer-owned IPv4 address.

\n

When this value is true, you must specify the customer-owned IP pool using CustomerOwnedIpv4Pool.

" + } + }, + "CustomerOwnedIpv4Pool": { + "target": "com.amazonaws.ec2#CoipPoolId", + "traits": { + "smithy.api#documentation": "

The customer-owned IPv4 address pool associated with the subnet.

\n

You must set this value when you specify true for MapCustomerOwnedIpOnLaunch.

" + } + }, + "EnableDns64": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "smithy.api#documentation": "

Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet \n should return synthetic IPv6 addresses for IPv4-only destinations.

\n

You must first configure a NAT gateway in a public subnet (separate from the subnet \n containing the IPv6-only workloads). For example, the subnet containing the NAT gateway \n should have a 0.0.0.0/0 route pointing to the internet gateway. For more \n information, see Configure DNS64 and NAT64 in the Amazon VPC User Guide.

" + } + }, + "PrivateDnsHostnameTypeOnLaunch": { + "target": "com.amazonaws.ec2#HostnameType", + "traits": { + "smithy.api#documentation": "

The type of hostname to assign to instances in the subnet at launch. For IPv4-only and dual-stack (IPv4 and IPv6) subnets, an\n instance DNS name can be based on the instance IPv4 address (ip-name) or the instance ID (resource-name). For IPv6 only subnets, an instance\n DNS name must be based on the instance ID (resource-name).

" + } + }, + "EnableResourceNameDnsARecordOnLaunch": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "smithy.api#documentation": "

Indicates whether to respond to DNS queries for instance hostnames with DNS A records.

" + } + }, + "EnableResourceNameDnsAAAARecordOnLaunch": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "smithy.api#documentation": "

Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.

" + } + }, + "EnableLniAtDeviceIndex": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

\n Indicates the device position for local network interfaces in this subnet. For example, \n 1 indicates local network interfaces in this subnet are the secondary \n network interface (eth1). A local network interface cannot be the primary network\n interface (eth0).\n

" + } + }, + "DisableLniAtDeviceIndex": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "smithy.api#documentation": "

\n Specify true to indicate that local network interfaces at the current \n position should be disabled. \n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyTrafficMirrorFilterNetworkServices": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyTrafficMirrorFilterNetworkServicesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyTrafficMirrorFilterNetworkServicesResult" + }, + "traits": { + "smithy.api#documentation": "

Allows or restricts mirroring network services.

\n

By default, Amazon DNS network services are not eligible for Traffic Mirror. Use AddNetworkServices to add network services to a Traffic Mirror filter. When a network service is added to the Traffic Mirror filter, all traffic related to that network service will be mirrored.\n When you no longer want to mirror network services, use RemoveNetworkServices to remove the network services from the Traffic Mirror filter.\n

" + } + }, + "com.amazonaws.ec2#ModifyTrafficMirrorFilterNetworkServicesRequest": { + "type": "structure", + "members": { + "TrafficMirrorFilterId": { + "target": "com.amazonaws.ec2#TrafficMirrorFilterId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Traffic Mirror filter.

", + "smithy.api#required": {} + } + }, + "AddNetworkServices": { + "target": "com.amazonaws.ec2#TrafficMirrorNetworkServiceList", + "traits": { + "smithy.api#documentation": "

The network service, for example Amazon DNS, that you want to mirror.

", + "smithy.api#xmlName": "AddNetworkService" + } + }, + "RemoveNetworkServices": { + "target": "com.amazonaws.ec2#TrafficMirrorNetworkServiceList", + "traits": { + "smithy.api#documentation": "

The network service, for example Amazon DNS, that you no longer want to mirror.

", + "smithy.api#xmlName": "RemoveNetworkService" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyTrafficMirrorFilterNetworkServicesResult": { + "type": "structure", + "members": { + "TrafficMirrorFilter": { + "target": "com.amazonaws.ec2#TrafficMirrorFilter", + "traits": { + "aws.protocols#ec2QueryName": "TrafficMirrorFilter", + "smithy.api#documentation": "

The Traffic Mirror filter that the network service is associated with.

", + "smithy.api#xmlName": "trafficMirrorFilter" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyTrafficMirrorFilterRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyTrafficMirrorFilterRuleRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyTrafficMirrorFilterRuleResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the specified Traffic Mirror rule.

\n

\n DestinationCidrBlock and SourceCidrBlock must both be an IPv4\n range or an IPv6 range.

" + } + }, + "com.amazonaws.ec2#ModifyTrafficMirrorFilterRuleRequest": { + "type": "structure", + "members": { + "TrafficMirrorFilterRuleId": { + "target": "com.amazonaws.ec2#TrafficMirrorFilterRuleIdWithResolver", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Traffic Mirror rule.

", + "smithy.api#required": {} + } + }, + "TrafficDirection": { + "target": "com.amazonaws.ec2#TrafficDirection", + "traits": { + "smithy.api#documentation": "

The type of traffic to assign to the rule.

" + } + }, + "RuleNumber": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given\n direction. The rules are processed in ascending order by rule number.

" + } + }, + "RuleAction": { + "target": "com.amazonaws.ec2#TrafficMirrorRuleAction", + "traits": { + "smithy.api#documentation": "

The action to assign to the rule.

" + } + }, + "DestinationPortRange": { + "target": "com.amazonaws.ec2#TrafficMirrorPortRangeRequest", + "traits": { + "smithy.api#documentation": "

The destination ports that are associated with the Traffic Mirror rule.

" + } + }, + "SourcePortRange": { + "target": "com.amazonaws.ec2#TrafficMirrorPortRangeRequest", + "traits": { + "smithy.api#documentation": "

The port range to assign to the Traffic Mirror rule.

" + } + }, + "Protocol": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The protocol, for example TCP, to assign to the Traffic Mirror rule.

" + } + }, + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The destination CIDR block to assign to the Traffic Mirror rule.

" + } + }, + "SourceCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The source CIDR block to assign to the Traffic Mirror rule.

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The description to assign to the Traffic Mirror rule.

" + } + }, + "RemoveFields": { + "target": "com.amazonaws.ec2#TrafficMirrorFilterRuleFieldList", + "traits": { + "smithy.api#documentation": "

The properties that you want to remove from the Traffic Mirror filter rule.

\n

When you remove a property from a Traffic Mirror filter rule, the property is set to the default.

", + "smithy.api#xmlName": "RemoveField" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyTrafficMirrorFilterRuleResult": { + "type": "structure", + "members": { + "TrafficMirrorFilterRule": { + "target": "com.amazonaws.ec2#TrafficMirrorFilterRule", + "traits": { + "aws.protocols#ec2QueryName": "TrafficMirrorFilterRule", + "smithy.api#documentation": "\n

Tags are not returned for ModifyTrafficMirrorFilterRule.

\n \n

A Traffic Mirror rule.

", + "smithy.api#xmlName": "trafficMirrorFilterRule" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyTrafficMirrorSession": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyTrafficMirrorSessionRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyTrafficMirrorSessionResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies a Traffic Mirror session.

" + } + }, + "com.amazonaws.ec2#ModifyTrafficMirrorSessionRequest": { + "type": "structure", + "members": { + "TrafficMirrorSessionId": { + "target": "com.amazonaws.ec2#TrafficMirrorSessionId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Traffic Mirror session.

", + "smithy.api#required": {} + } + }, + "TrafficMirrorTargetId": { + "target": "com.amazonaws.ec2#TrafficMirrorTargetId", + "traits": { + "smithy.api#documentation": "

The Traffic Mirror target. The target must be in the same VPC as the source, or have a VPC peering connection with the source.

" + } + }, + "TrafficMirrorFilterId": { + "target": "com.amazonaws.ec2#TrafficMirrorFilterId", + "traits": { + "smithy.api#documentation": "

The ID of the Traffic Mirror filter.

" + } + }, + "PacketLength": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The number of bytes in each packet to mirror. These are bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. Do not specify this parameter when you want to mirror the entire packet.

\n

For sessions with Network Load Balancer (NLB) traffic mirror targets, the default PacketLength will be set to 8500. Valid values are 1-8500. Setting a PacketLength greater than 8500 will result in an error response.

" + } + }, + "SessionNumber": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.

\n

Valid values are 1-32766.

" + } + }, + "VirtualNetworkId": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The virtual network ID of the Traffic Mirror session.

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The description to assign to the Traffic Mirror session.

" + } + }, + "RemoveFields": { + "target": "com.amazonaws.ec2#TrafficMirrorSessionFieldList", + "traits": { + "smithy.api#documentation": "

The properties that you want to remove from the Traffic Mirror session.

\n

When you remove a property from a Traffic Mirror session, the property is set to the default.

", + "smithy.api#xmlName": "RemoveField" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyTrafficMirrorSessionResult": { + "type": "structure", + "members": { + "TrafficMirrorSession": { + "target": "com.amazonaws.ec2#TrafficMirrorSession", + "traits": { + "aws.protocols#ec2QueryName": "TrafficMirrorSession", + "smithy.api#documentation": "

Information about the Traffic Mirror session.

", + "smithy.api#xmlName": "trafficMirrorSession" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyTransitGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyTransitGatewayRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyTransitGatewayResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the specified transit gateway. When you modify a transit gateway, the modified options are applied to new transit gateway attachments only. Your existing transit gateway attachments are not modified.

" + } + }, + "com.amazonaws.ec2#ModifyTransitGatewayOptions": { + "type": "structure", + "members": { + "AddTransitGatewayCidrBlocks": { + "target": "com.amazonaws.ec2#TransitGatewayCidrBlockStringList", + "traits": { + "smithy.api#documentation": "

Adds IPv4 or IPv6 CIDR blocks for the transit gateway. Must be a size /24 CIDR block or larger for IPv4, or a size /64 CIDR block or larger for IPv6.

" + } + }, + "RemoveTransitGatewayCidrBlocks": { + "target": "com.amazonaws.ec2#TransitGatewayCidrBlockStringList", + "traits": { + "smithy.api#documentation": "

Removes CIDR blocks for the transit gateway.

" + } + }, + "VpnEcmpSupport": { + "target": "com.amazonaws.ec2#VpnEcmpSupportValue", + "traits": { + "smithy.api#documentation": "

Enable or disable Equal Cost Multipath Protocol support.

" + } + }, + "DnsSupport": { + "target": "com.amazonaws.ec2#DnsSupportValue", + "traits": { + "smithy.api#documentation": "

Enable or disable DNS support.

" + } + }, + "SecurityGroupReferencingSupport": { + "target": "com.amazonaws.ec2#SecurityGroupReferencingSupportValue", + "traits": { + "smithy.api#documentation": "

Enables you to reference a security group across VPCs attached to a transit gateway to simplify security group management.\n\n

\n

This option is disabled by default.

\n

For more information about security group referencing, see Security group referencing in the Amazon Web Services Transit Gateways Guide.

" + } + }, + "AutoAcceptSharedAttachments": { + "target": "com.amazonaws.ec2#AutoAcceptSharedAttachmentsValue", + "traits": { + "smithy.api#documentation": "

Enable or disable automatic acceptance of attachment requests.

" + } + }, + "DefaultRouteTableAssociation": { + "target": "com.amazonaws.ec2#DefaultRouteTableAssociationValue", + "traits": { + "smithy.api#documentation": "

Enable or disable automatic association with the default association route table.

" + } + }, + "AssociationDefaultRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#documentation": "

The ID of the default association route table.

" + } + }, + "DefaultRouteTablePropagation": { + "target": "com.amazonaws.ec2#DefaultRouteTablePropagationValue", + "traits": { + "smithy.api#documentation": "

Enable or disable automatic propagation of routes to the default propagation route table.

" + } + }, + "PropagationDefaultRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#documentation": "

The ID of the default propagation route table.

" + } + }, + "AmazonSideAsn": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "smithy.api#documentation": "

A private Autonomous System Number (ASN) for the Amazon side of a BGP session. \n The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs.

\n

The modify ASN operation is not allowed on a transit gateway if it has the following attachments:

\n \n

You must first delete all transit gateway attachments configured prior to modifying the ASN on\n the transit gateway.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The transit gateway options.

" + } + }, + "com.amazonaws.ec2#ModifyTransitGatewayPrefixListReference": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyTransitGatewayPrefixListReferenceRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyTransitGatewayPrefixListReferenceResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies a reference (route) to a prefix list in a specified transit gateway route table.

" + } + }, + "com.amazonaws.ec2#ModifyTransitGatewayPrefixListReferenceRequest": { + "type": "structure", + "members": { + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway route table.

", + "smithy.api#required": {} + } + }, + "PrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the prefix list.

", + "smithy.api#required": {} + } + }, + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#documentation": "

The ID of the attachment to which traffic is routed.

" + } + }, + "Blackhole": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether to drop traffic that matches this route.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyTransitGatewayPrefixListReferenceResult": { + "type": "structure", + "members": { + "TransitGatewayPrefixListReference": { + "target": "com.amazonaws.ec2#TransitGatewayPrefixListReference", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayPrefixListReference", + "smithy.api#documentation": "

Information about the prefix list reference.

", + "smithy.api#xmlName": "transitGatewayPrefixListReference" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyTransitGatewayRequest": { + "type": "structure", + "members": { + "TransitGatewayId": { + "target": "com.amazonaws.ec2#TransitGatewayId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The description for the transit gateway.

" + } + }, + "Options": { + "target": "com.amazonaws.ec2#ModifyTransitGatewayOptions", + "traits": { + "smithy.api#documentation": "

The options to modify.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyTransitGatewayResult": { + "type": "structure", + "members": { + "TransitGateway": { + "target": "com.amazonaws.ec2#TransitGateway", + "traits": { + "aws.protocols#ec2QueryName": "TransitGateway", + "smithy.api#documentation": "

Information about the transit gateway.

", + "smithy.api#xmlName": "transitGateway" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyTransitGatewayVpcAttachment": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyTransitGatewayVpcAttachmentRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyTransitGatewayVpcAttachmentResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the specified VPC attachment.

" + } + }, + "com.amazonaws.ec2#ModifyTransitGatewayVpcAttachmentRequest": { + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the attachment.

", + "smithy.api#required": {} + } + }, + "AddSubnetIds": { + "target": "com.amazonaws.ec2#TransitGatewaySubnetIdList", + "traits": { + "smithy.api#documentation": "

The IDs of one or more subnets to add. You can specify at most one subnet per Availability Zone.

" + } + }, + "RemoveSubnetIds": { + "target": "com.amazonaws.ec2#TransitGatewaySubnetIdList", + "traits": { + "smithy.api#documentation": "

The IDs of one or more subnets to remove.

" + } + }, + "Options": { + "target": "com.amazonaws.ec2#ModifyTransitGatewayVpcAttachmentRequestOptions", + "traits": { + "smithy.api#documentation": "

The new VPC attachment options.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyTransitGatewayVpcAttachmentRequestOptions": { + "type": "structure", + "members": { + "DnsSupport": { + "target": "com.amazonaws.ec2#DnsSupportValue", + "traits": { + "smithy.api#documentation": "

Enable or disable DNS support. The default is enable.

" + } + }, + "SecurityGroupReferencingSupport": { + "target": "com.amazonaws.ec2#SecurityGroupReferencingSupportValue", + "traits": { + "smithy.api#documentation": "

Enables you to reference a security group across VPCs attached to a transit gateway to simplify security group management.\n\n

\n

This option is disabled by default.

\n

For more information about security group referencing, see Security group referencing in the Amazon Web Services Transit Gateways Guide.

" + } + }, + "Ipv6Support": { + "target": "com.amazonaws.ec2#Ipv6SupportValue", + "traits": { + "smithy.api#documentation": "

Enable or disable IPv6 support. The default is enable.

" + } + }, + "ApplianceModeSupport": { + "target": "com.amazonaws.ec2#ApplianceModeSupportValue", + "traits": { + "smithy.api#documentation": "

Enable or disable support for appliance mode. If enabled, a traffic flow between a source and destination uses the same Availability Zone for the VPC attachment for the lifetime of that flow. The default is disable.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the options for a VPC attachment.

" + } + }, + "com.amazonaws.ec2#ModifyTransitGatewayVpcAttachmentResult": { + "type": "structure", + "members": { + "TransitGatewayVpcAttachment": { + "target": "com.amazonaws.ec2#TransitGatewayVpcAttachment", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayVpcAttachment", + "smithy.api#documentation": "

Information about the modified attachment.

", + "smithy.api#xmlName": "transitGatewayVpcAttachment" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessEndpointRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessEndpointResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the configuration of the specified Amazon Web Services Verified Access endpoint.

" + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessEndpointCidrOptions": { + "type": "structure", + "members": { + "PortRanges": { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessEndpointPortRangeList", + "traits": { + "smithy.api#documentation": "

The port ranges.

", + "smithy.api#xmlName": "PortRange" + } + } + }, + "traits": { + "smithy.api#documentation": "

The CIDR options for a Verified Access endpoint.

" + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessEndpointEniOptions": { + "type": "structure", + "members": { + "Protocol": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointProtocol", + "traits": { + "smithy.api#documentation": "

The IP protocol.

" + } + }, + "Port": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointPortNumber", + "traits": { + "smithy.api#documentation": "

The IP port number.

" + } + }, + "PortRanges": { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessEndpointPortRangeList", + "traits": { + "smithy.api#documentation": "

The port ranges.

", + "smithy.api#xmlName": "PortRange" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the options when modifying a Verified Access endpoint with the\n network-interface type.

" + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessEndpointLoadBalancerOptions": { + "type": "structure", + "members": { + "SubnetIds": { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessEndpointSubnetIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the subnets.

", + "smithy.api#xmlName": "SubnetId" + } + }, + "Protocol": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointProtocol", + "traits": { + "smithy.api#documentation": "

The IP protocol.

" + } + }, + "Port": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointPortNumber", + "traits": { + "smithy.api#documentation": "

The IP port number.

" + } + }, + "PortRanges": { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessEndpointPortRangeList", + "traits": { + "smithy.api#documentation": "

The port ranges.

", + "smithy.api#xmlName": "PortRange" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a load balancer when creating an Amazon Web Services Verified Access endpoint using the\n load-balancer type.

" + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessEndpointPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessEndpointPolicyRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessEndpointPolicyResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the specified Amazon Web Services Verified Access endpoint policy.

" + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessEndpointPolicyRequest": { + "type": "structure", + "members": { + "VerifiedAccessEndpointId": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Verified Access endpoint.

", + "smithy.api#required": {} + } + }, + "PolicyEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

The status of the Verified Access policy.

" + } + }, + "PolicyDocument": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Verified Access policy document.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "SseSpecification": { + "target": "com.amazonaws.ec2#VerifiedAccessSseSpecificationRequest", + "traits": { + "smithy.api#documentation": "

The options for server side encryption.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessEndpointPolicyResult": { + "type": "structure", + "members": { + "PolicyEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "PolicyEnabled", + "smithy.api#documentation": "

The status of the Verified Access policy.

", + "smithy.api#xmlName": "policyEnabled" + } + }, + "PolicyDocument": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PolicyDocument", + "smithy.api#documentation": "

The Verified Access policy document.

", + "smithy.api#xmlName": "policyDocument" + } + }, + "SseSpecification": { + "target": "com.amazonaws.ec2#VerifiedAccessSseSpecificationResponse", + "traits": { + "aws.protocols#ec2QueryName": "SseSpecification", + "smithy.api#documentation": "

The options in use for server side encryption.

", + "smithy.api#xmlName": "sseSpecification" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessEndpointPortRange": { + "type": "structure", + "members": { + "FromPort": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointPortNumber", + "traits": { + "smithy.api#documentation": "

The start of the port range.

" + } + }, + "ToPort": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointPortNumber", + "traits": { + "smithy.api#documentation": "

The end of the port range.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the port range for a Verified Access endpoint.

" + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessEndpointPortRangeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessEndpointPortRange", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessEndpointRdsOptions": { + "type": "structure", + "members": { + "SubnetIds": { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessEndpointSubnetIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the subnets.

", + "smithy.api#xmlName": "SubnetId" + } + }, + "Port": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointPortNumber", + "traits": { + "smithy.api#documentation": "

The port.

" + } + }, + "RdsEndpoint": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The RDS endpoint.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The RDS options for a Verified Access endpoint.

" + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessEndpointRequest": { + "type": "structure", + "members": { + "VerifiedAccessEndpointId": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Verified Access endpoint.

", + "smithy.api#required": {} + } + }, + "VerifiedAccessGroupId": { + "target": "com.amazonaws.ec2#VerifiedAccessGroupId", + "traits": { + "smithy.api#documentation": "

The ID of the Verified Access group.

" + } + }, + "LoadBalancerOptions": { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessEndpointLoadBalancerOptions", + "traits": { + "smithy.api#documentation": "

The load balancer details if creating the Verified Access endpoint as\n load-balancertype.

" + } + }, + "NetworkInterfaceOptions": { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessEndpointEniOptions", + "traits": { + "smithy.api#documentation": "

The network interface options.

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description for the Verified Access endpoint.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "RdsOptions": { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessEndpointRdsOptions", + "traits": { + "smithy.api#documentation": "

The RDS options.

" + } + }, + "CidrOptions": { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessEndpointCidrOptions", + "traits": { + "smithy.api#documentation": "

The CIDR options.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessEndpointResult": { + "type": "structure", + "members": { + "VerifiedAccessEndpoint": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpoint", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessEndpoint", + "smithy.api#documentation": "

Details about the Verified Access endpoint.

", + "smithy.api#xmlName": "verifiedAccessEndpoint" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessEndpointSubnetIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessGroupRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessGroupResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the specified Amazon Web Services Verified Access group configuration.

" + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessGroupPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessGroupPolicyRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessGroupPolicyResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the specified Amazon Web Services Verified Access group policy.

" + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessGroupPolicyRequest": { + "type": "structure", + "members": { + "VerifiedAccessGroupId": { + "target": "com.amazonaws.ec2#VerifiedAccessGroupId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Verified Access group.

", + "smithy.api#required": {} + } + }, + "PolicyEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

The status of the Verified Access policy.

" + } + }, + "PolicyDocument": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Verified Access policy document.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "SseSpecification": { + "target": "com.amazonaws.ec2#VerifiedAccessSseSpecificationRequest", + "traits": { + "smithy.api#documentation": "

The options for server side encryption.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessGroupPolicyResult": { + "type": "structure", + "members": { + "PolicyEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "PolicyEnabled", + "smithy.api#documentation": "

The status of the Verified Access policy.

", + "smithy.api#xmlName": "policyEnabled" + } + }, + "PolicyDocument": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PolicyDocument", + "smithy.api#documentation": "

The Verified Access policy document.

", + "smithy.api#xmlName": "policyDocument" + } + }, + "SseSpecification": { + "target": "com.amazonaws.ec2#VerifiedAccessSseSpecificationResponse", + "traits": { + "aws.protocols#ec2QueryName": "SseSpecification", + "smithy.api#documentation": "

The options in use for server side encryption.

", + "smithy.api#xmlName": "sseSpecification" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessGroupRequest": { + "type": "structure", + "members": { + "VerifiedAccessGroupId": { + "target": "com.amazonaws.ec2#VerifiedAccessGroupId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Verified Access group.

", + "smithy.api#required": {} + } + }, + "VerifiedAccessInstanceId": { + "target": "com.amazonaws.ec2#VerifiedAccessInstanceId", + "traits": { + "smithy.api#documentation": "

The ID of the Verified Access instance.

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description for the Verified Access group.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessGroupResult": { + "type": "structure", + "members": { + "VerifiedAccessGroup": { + "target": "com.amazonaws.ec2#VerifiedAccessGroup", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessGroup", + "smithy.api#documentation": "

Details about the Verified Access group.

", + "smithy.api#xmlName": "verifiedAccessGroup" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessInstanceRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessInstanceResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the configuration of the specified Amazon Web Services Verified Access instance.

" + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessInstanceLoggingConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessInstanceLoggingConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessInstanceLoggingConfigurationResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the logging configuration for the specified Amazon Web Services Verified Access instance.

" + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessInstanceLoggingConfigurationRequest": { + "type": "structure", + "members": { + "VerifiedAccessInstanceId": { + "target": "com.amazonaws.ec2#VerifiedAccessInstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Verified Access instance.

", + "smithy.api#required": {} + } + }, + "AccessLogs": { + "target": "com.amazonaws.ec2#VerifiedAccessLogOptions", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The configuration options for Verified Access instances.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring idempotency.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessInstanceLoggingConfigurationResult": { + "type": "structure", + "members": { + "LoggingConfiguration": { + "target": "com.amazonaws.ec2#VerifiedAccessInstanceLoggingConfiguration", + "traits": { + "aws.protocols#ec2QueryName": "LoggingConfiguration", + "smithy.api#documentation": "

The logging configuration for the Verified Access instance.

", + "smithy.api#xmlName": "loggingConfiguration" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessInstanceRequest": { + "type": "structure", + "members": { + "VerifiedAccessInstanceId": { + "target": "com.amazonaws.ec2#VerifiedAccessInstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Verified Access instance.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description for the Verified Access instance.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "CidrEndpointsCustomSubDomain": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The custom subdomain.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessInstanceResult": { + "type": "structure", + "members": { + "VerifiedAccessInstance": { + "target": "com.amazonaws.ec2#VerifiedAccessInstance", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessInstance", + "smithy.api#documentation": "

Details about the Verified Access instance.

", + "smithy.api#xmlName": "verifiedAccessInstance" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessNativeApplicationOidcOptions": { + "type": "structure", + "members": { + "PublicSigningKeyEndpoint": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The public signing key endpoint.

" + } + }, + "Issuer": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The OIDC issuer identifier of the IdP.

" + } + }, + "AuthorizationEndpoint": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The authorization endpoint of the IdP.

" + } + }, + "TokenEndpoint": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token endpoint of the IdP.

" + } + }, + "UserInfoEndpoint": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The user info endpoint of the IdP.

" + } + }, + "ClientId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The OAuth 2.0 client identifier.

" + } + }, + "ClientSecret": { + "target": "com.amazonaws.ec2#ClientSecretType", + "traits": { + "smithy.api#documentation": "

The OAuth 2.0 client secret.

" + } + }, + "Scope": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The set of user claims to be requested from the IdP.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the OpenID Connect (OIDC) options.

" + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessTrustProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessTrustProviderRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessTrustProviderResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the configuration of the specified Amazon Web Services Verified Access trust provider.

" + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessTrustProviderDeviceOptions": { + "type": "structure", + "members": { + "PublicSigningKeyUrl": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The URL Amazon Web Services Verified Access will use to verify the authenticity of the device tokens.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Modifies the configuration of the specified device-based Amazon Web Services Verified Access trust provider.

" + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessTrustProviderOidcOptions": { + "type": "structure", + "members": { + "Issuer": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The OIDC issuer.

" + } + }, + "AuthorizationEndpoint": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The OIDC authorization endpoint.

" + } + }, + "TokenEndpoint": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The OIDC token endpoint.

" + } + }, + "UserInfoEndpoint": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The OIDC user info endpoint.

" + } + }, + "ClientId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The client identifier.

" + } + }, + "ClientSecret": { + "target": "com.amazonaws.ec2#ClientSecretType", + "traits": { + "smithy.api#documentation": "

The client secret.

" + } + }, + "Scope": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

OpenID Connect (OIDC) scopes are used by an application during authentication to authorize access to a user's details. Each scope returns a specific set of user attributes.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Options for an OpenID Connect-compatible user-identity trust provider.

" + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessTrustProviderRequest": { + "type": "structure", + "members": { + "VerifiedAccessTrustProviderId": { + "target": "com.amazonaws.ec2#VerifiedAccessTrustProviderId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Verified Access trust provider.

", + "smithy.api#required": {} + } + }, + "OidcOptions": { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessTrustProviderOidcOptions", + "traits": { + "smithy.api#documentation": "

The options for an OpenID Connect-compatible user-identity trust provider.

" + } + }, + "DeviceOptions": { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessTrustProviderDeviceOptions", + "traits": { + "smithy.api#documentation": "

The options for a device-based trust provider. This parameter is required when the\n provider type is device.

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description for the Verified Access trust provider.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "SseSpecification": { + "target": "com.amazonaws.ec2#VerifiedAccessSseSpecificationRequest", + "traits": { + "smithy.api#documentation": "

The options for server side encryption.

" + } + }, + "NativeApplicationOidcOptions": { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessNativeApplicationOidcOptions", + "traits": { + "smithy.api#documentation": "

The OpenID Connect (OIDC) options.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessTrustProviderResult": { + "type": "structure", + "members": { + "VerifiedAccessTrustProvider": { + "target": "com.amazonaws.ec2#VerifiedAccessTrustProvider", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessTrustProvider", + "smithy.api#documentation": "

Details about the Verified Access trust provider.

", + "smithy.api#xmlName": "verifiedAccessTrustProvider" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyVolume": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyVolumeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyVolumeResult" + }, + "traits": { + "smithy.api#documentation": "

You can modify several parameters of an existing EBS volume, including volume size, volume\n type, and IOPS capacity. If your EBS volume is attached to a current-generation EC2 instance\n type, you might be able to apply these changes without stopping the instance or detaching the\n volume from it. For more information about modifying EBS volumes, see Amazon EBS Elastic Volumes \n in the Amazon EBS User Guide.

\n

When you complete a resize operation on your volume, you need to extend the volume's\n file-system size to take advantage of the new storage capacity. For more information, see Extend the file system.

\n

For more information, see Monitor the progress of volume modifications in the Amazon EBS User Guide.

\n

With previous-generation instance types, resizing an EBS volume might require detaching and\n reattaching the volume or stopping and restarting the instance.

\n

After modifying a volume, you must wait at least six hours and ensure that the volume \n is in the in-use or available state before you can modify the same \n volume. This is sometimes referred to as a cooldown period.

" + } + }, + "com.amazonaws.ec2#ModifyVolumeAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyVolumeAttributeRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Modifies a volume attribute.

\n

By default, all I/O operations for the volume are suspended when the data on the volume is\n determined to be potentially inconsistent, to prevent undetectable, latent data corruption.\n The I/O access to the volume can be resumed by first enabling I/O access and then checking the\n data consistency on your volume.

\n

You can change the default behavior to resume I/O operations. We recommend that you change\n this only for boot volumes or for volumes that are stateless or disposable.

", + "smithy.api#examples": [ + { + "title": "To modify a volume attribute", + "documentation": "This example sets the ``autoEnableIo`` attribute of the volume with the ID ``vol-1234567890abcdef0`` to ``true``. If the command succeeds, no output is returned.", + "input": { + "DryRun": true, + "VolumeId": "vol-1234567890abcdef0", + "AutoEnableIO": { + "Value": true + } + }, + "output": {} + } + ] + } + }, + "com.amazonaws.ec2#ModifyVolumeAttributeRequest": { + "type": "structure", + "members": { + "AutoEnableIO": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "smithy.api#documentation": "

Indicates whether the volume should be auto-enabled for I/O operations.

" + } + }, + "VolumeId": { + "target": "com.amazonaws.ec2#VolumeId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the volume.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyVolumeRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "VolumeId": { + "target": "com.amazonaws.ec2#VolumeId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the volume.

", + "smithy.api#required": {} + } + }, + "Size": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The target size of the volume, in GiB. The target volume size must be greater than or\n equal to the existing size of the volume.

\n

The following are the supported volumes sizes for each volume type:

\n \n

Default: The existing size is retained.

" + } + }, + "VolumeType": { + "target": "com.amazonaws.ec2#VolumeType", + "traits": { + "smithy.api#documentation": "

The target EBS volume type of the volume. For more information, see Amazon EBS volume types in the Amazon EBS User Guide.

\n

Default: The existing type is retained.

" + } + }, + "Iops": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The target IOPS rate of the volume. This parameter is valid only for gp3, io1, and io2 volumes.

\n

The following are the supported values for each volume type:

\n \n

For io2 volumes, you can achieve up to 256,000 IOPS on \ninstances \nbuilt on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.

\n

Default: The existing value is retained if you keep the same volume type. If you change\n the volume type to io1, io2, or gp3, the default is 3,000.

" + } + }, + "Throughput": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The target throughput of the volume, in MiB/s. This parameter is valid only for gp3 volumes. \n The maximum value is 1,000.

\n

Default: The existing value is retained if the source and target volume type is gp3.\n Otherwise, the default value is 125.

\n

Valid Range: Minimum value of 125. Maximum value of 1000.

" + } + }, + "MultiAttachEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the \n\t volume to up to 16 \n\t\t\tNitro-based instances in the same Availability Zone. This parameter is \n\t\tsupported with io1 and io2 volumes only. For more information, see \n\t \n\t\t\tAmazon EBS Multi-Attach in the Amazon EBS User Guide.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyVolumeResult": { + "type": "structure", + "members": { + "VolumeModification": { + "target": "com.amazonaws.ec2#VolumeModification", + "traits": { + "aws.protocols#ec2QueryName": "VolumeModification", + "smithy.api#documentation": "

Information about the volume modification.

", + "smithy.api#xmlName": "volumeModification" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyVpcAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyVpcAttributeRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Modifies the specified attribute of the specified VPC.

", + "smithy.api#examples": [ + { + "title": "To modify the enableDnsSupport attribute", + "documentation": "This example modifies the enableDnsSupport attribute. This attribute indicates whether DNS resolution is enabled for the VPC. If this attribute is true, the Amazon DNS server resolves DNS hostnames for instances in the VPC to their corresponding IP addresses; otherwise, it does not.", + "input": { + "VpcId": "vpc-a01106c2", + "EnableDnsSupport": { + "Value": false + } + } + }, + { + "title": "To modify the enableDnsHostnames attribute", + "documentation": "This example modifies the enableDnsHostnames attribute. This attribute indicates whether instances launched in the VPC get DNS hostnames. If this attribute is true, instances in the VPC get DNS hostnames; otherwise, they do not.", + "input": { + "VpcId": "vpc-a01106c2", + "EnableDnsHostnames": { + "Value": false + } + } + } + ] + } + }, + "com.amazonaws.ec2#ModifyVpcAttributeRequest": { + "type": "structure", + "members": { + "EnableDnsHostnames": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "smithy.api#documentation": "

Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not.

\n

You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute. You can only enable DNS hostnames if you've enabled DNS support.

" + } + }, + "EnableDnsSupport": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "smithy.api#documentation": "

Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to\n\t\t\tthe Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP\n\t\t\taddress at the base of the VPC network range \"plus two\" succeed. If disabled, the Amazon\n\t\t\tprovided DNS service in the VPC that resolves public DNS hostnames to IP addresses is\n\t\t\tnot enabled.

\n

You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute.

" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "vpcId" + } + }, + "EnableNetworkAddressUsageMetrics": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "smithy.api#documentation": "

Indicates whether Network Address Usage metrics are enabled for your VPC.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyVpcBlockPublicAccessExclusion": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyVpcBlockPublicAccessExclusionRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyVpcBlockPublicAccessExclusionResult" + }, + "traits": { + "smithy.api#documentation": "

Modify VPC Block Public Access (BPA) exclusions. A VPC BPA exclusion is a mode that can be applied to a single VPC or subnet that exempts it from the account’s BPA mode and will allow bidirectional or egress-only access. You can create BPA exclusions for VPCs and subnets even when BPA is not enabled on the account to ensure that there is no traffic disruption to the exclusions when VPC BPA is turned on.

" + } + }, + "com.amazonaws.ec2#ModifyVpcBlockPublicAccessExclusionRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ExclusionId": { + "target": "com.amazonaws.ec2#VpcBlockPublicAccessExclusionId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of an exclusion.

", + "smithy.api#required": {} + } + }, + "InternetGatewayExclusionMode": { + "target": "com.amazonaws.ec2#InternetGatewayExclusionMode", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The exclusion mode for internet gateway traffic.

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyVpcBlockPublicAccessExclusionResult": { + "type": "structure", + "members": { + "VpcBlockPublicAccessExclusion": { + "target": "com.amazonaws.ec2#VpcBlockPublicAccessExclusion", + "traits": { + "aws.protocols#ec2QueryName": "VpcBlockPublicAccessExclusion", + "smithy.api#documentation": "

Details related to the exclusion.

", + "smithy.api#xmlName": "vpcBlockPublicAccessExclusion" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyVpcBlockPublicAccessOptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyVpcBlockPublicAccessOptionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyVpcBlockPublicAccessOptionsResult" + }, + "traits": { + "smithy.api#documentation": "

Modify VPC Block Public Access (BPA) options. VPC Block Public Access (BPA) enables you to block resources in VPCs and subnets that you own in a Region from reaching or being reached from the internet through internet gateways and egress-only internet gateways. To learn more about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User Guide.

" + } + }, + "com.amazonaws.ec2#ModifyVpcBlockPublicAccessOptionsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "InternetGatewayBlockMode": { + "target": "com.amazonaws.ec2#InternetGatewayBlockMode", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The mode of VPC BPA.

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyVpcBlockPublicAccessOptionsResult": { + "type": "structure", + "members": { + "VpcBlockPublicAccessOptions": { + "target": "com.amazonaws.ec2#VpcBlockPublicAccessOptions", + "traits": { + "aws.protocols#ec2QueryName": "VpcBlockPublicAccessOptions", + "smithy.api#documentation": "

Details related to the VPC Block Public Access (BPA) options.

", + "smithy.api#xmlName": "vpcBlockPublicAccessOptions" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyVpcEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyVpcEndpointRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyVpcEndpointResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies attributes of a specified VPC endpoint. The attributes that you can modify\n depend on the type of VPC endpoint (interface, gateway, or Gateway Load Balancer). For more information, \n see the Amazon Web Services PrivateLink \n Guide.

" + } + }, + "com.amazonaws.ec2#ModifyVpcEndpointConnectionNotification": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyVpcEndpointConnectionNotificationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyVpcEndpointConnectionNotificationResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies a connection notification for VPC endpoint or VPC endpoint service. You\n can change the SNS topic for the notification, or the events for which to be notified.

" + } + }, + "com.amazonaws.ec2#ModifyVpcEndpointConnectionNotificationRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ConnectionNotificationId": { + "target": "com.amazonaws.ec2#ConnectionNotificationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the notification.

", + "smithy.api#required": {} + } + }, + "ConnectionNotificationArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ARN for the SNS topic for the notification.

" + } + }, + "ConnectionEvents": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The events for the endpoint. Valid values are Accept,\n Connect, Delete, and Reject.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyVpcEndpointConnectionNotificationResult": { + "type": "structure", + "members": { + "ReturnValue": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyVpcEndpointRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "VpcEndpointId": { + "target": "com.amazonaws.ec2#VpcEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the endpoint.

", + "smithy.api#required": {} + } + }, + "ResetPolicy": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

(Gateway endpoint) Specify true to reset the policy document to the\n default policy. The default policy allows full access to the service.

" + } + }, + "PolicyDocument": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

(Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service. The policy must\n be in valid JSON format.

" + } + }, + "AddRouteTableIds": { + "target": "com.amazonaws.ec2#VpcEndpointRouteTableIdList", + "traits": { + "smithy.api#documentation": "

(Gateway endpoint) The IDs of the route tables to associate with the endpoint.

", + "smithy.api#xmlName": "AddRouteTableId" + } + }, + "RemoveRouteTableIds": { + "target": "com.amazonaws.ec2#VpcEndpointRouteTableIdList", + "traits": { + "smithy.api#documentation": "

(Gateway endpoint) The IDs of the route tables to disassociate from the endpoint.

", + "smithy.api#xmlName": "RemoveRouteTableId" + } + }, + "AddSubnetIds": { + "target": "com.amazonaws.ec2#VpcEndpointSubnetIdList", + "traits": { + "smithy.api#documentation": "

(Interface and Gateway Load Balancer endpoints) The IDs of the subnets in which to serve the endpoint. \n For a Gateway Load Balancer endpoint, you can specify only one subnet.

", + "smithy.api#xmlName": "AddSubnetId" + } + }, + "RemoveSubnetIds": { + "target": "com.amazonaws.ec2#VpcEndpointSubnetIdList", + "traits": { + "smithy.api#documentation": "

(Interface endpoint) The IDs of the subnets from which to remove the endpoint.

", + "smithy.api#xmlName": "RemoveSubnetId" + } + }, + "AddSecurityGroupIds": { + "target": "com.amazonaws.ec2#VpcEndpointSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

(Interface endpoint) The IDs of the security groups to associate with the endpoint network interfaces.

", + "smithy.api#xmlName": "AddSecurityGroupId" + } + }, + "RemoveSecurityGroupIds": { + "target": "com.amazonaws.ec2#VpcEndpointSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

(Interface endpoint) The IDs of the security groups to disassociate from the endpoint network interfaces.

", + "smithy.api#xmlName": "RemoveSecurityGroupId" + } + }, + "IpAddressType": { + "target": "com.amazonaws.ec2#IpAddressType", + "traits": { + "smithy.api#documentation": "

The IP address type for the endpoint.

" + } + }, + "DnsOptions": { + "target": "com.amazonaws.ec2#DnsOptionsSpecification", + "traits": { + "smithy.api#documentation": "

The DNS options for the endpoint.

" + } + }, + "PrivateDnsEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

(Interface endpoint) Indicates whether a private hosted zone is associated with the VPC.

" + } + }, + "SubnetConfigurations": { + "target": "com.amazonaws.ec2#SubnetConfigurationsList", + "traits": { + "smithy.api#documentation": "

The subnet configurations for the endpoint.

", + "smithy.api#xmlName": "SubnetConfiguration" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyVpcEndpointResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyVpcEndpointServiceConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyVpcEndpointServiceConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyVpcEndpointServiceConfigurationResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the attributes of the specified VPC endpoint service configuration.

\n

If you set or modify the private DNS name, you must prove that you own the private DNS\n domain name.

" + } + }, + "com.amazonaws.ec2#ModifyVpcEndpointServiceConfigurationRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ServiceId": { + "target": "com.amazonaws.ec2#VpcEndpointServiceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the service.

", + "smithy.api#required": {} + } + }, + "PrivateDnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

(Interface endpoint configuration) The private DNS name to assign to the endpoint service.

" + } + }, + "RemovePrivateDnsName": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

(Interface endpoint configuration) Removes the private DNS name of the endpoint service.

" + } + }, + "AcceptanceRequired": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether requests to create an endpoint to the service must be accepted.

" + } + }, + "AddNetworkLoadBalancerArns": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of Network Load Balancers to add to the service\n configuration.

", + "smithy.api#xmlName": "AddNetworkLoadBalancerArn" + } + }, + "RemoveNetworkLoadBalancerArns": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of Network Load Balancers to remove from the service\n configuration.

", + "smithy.api#xmlName": "RemoveNetworkLoadBalancerArn" + } + }, + "AddGatewayLoadBalancerArns": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of Gateway Load Balancers to add to the service configuration.

", + "smithy.api#xmlName": "AddGatewayLoadBalancerArn" + } + }, + "RemoveGatewayLoadBalancerArns": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of Gateway Load Balancers to remove from the service configuration.

", + "smithy.api#xmlName": "RemoveGatewayLoadBalancerArn" + } + }, + "AddSupportedIpAddressTypes": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The IP address types to add to the service configuration.

", + "smithy.api#xmlName": "AddSupportedIpAddressType" + } + }, + "RemoveSupportedIpAddressTypes": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The IP address types to remove from the service configuration.

", + "smithy.api#xmlName": "RemoveSupportedIpAddressType" + } + }, + "AddSupportedRegions": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The supported Regions to add to the service configuration.

", + "smithy.api#xmlName": "AddSupportedRegion" + } + }, + "RemoveSupportedRegions": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The supported Regions to remove from the service configuration.

", + "smithy.api#xmlName": "RemoveSupportedRegion" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyVpcEndpointServiceConfigurationResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyVpcEndpointServicePayerResponsibility": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyVpcEndpointServicePayerResponsibilityRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyVpcEndpointServicePayerResponsibilityResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the payer responsibility for your VPC endpoint service.

" + } + }, + "com.amazonaws.ec2#ModifyVpcEndpointServicePayerResponsibilityRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ServiceId": { + "target": "com.amazonaws.ec2#VpcEndpointServiceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the service.

", + "smithy.api#required": {} + } + }, + "PayerResponsibility": { + "target": "com.amazonaws.ec2#PayerResponsibility", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The entity that is responsible for the endpoint costs. The default is the endpoint owner.\n If you set the payer responsibility to the service owner, you cannot set it back to the\n endpoint owner.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyVpcEndpointServicePayerResponsibilityResult": { + "type": "structure", + "members": { + "ReturnValue": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyVpcEndpointServicePermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyVpcEndpointServicePermissionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyVpcEndpointServicePermissionsResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the permissions for your VPC endpoint service. You can add or remove permissions\n for service consumers (Amazon Web Services accounts, users, and IAM roles) to connect to\n your endpoint service.

\n

If you grant permissions to all principals, the service is public. Any users who know the name of a\n\t public service can send a request to attach an endpoint. If the service does not require manual approval,\n\t attachments are automatically approved.

" + } + }, + "com.amazonaws.ec2#ModifyVpcEndpointServicePermissionsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ServiceId": { + "target": "com.amazonaws.ec2#VpcEndpointServiceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the service.

", + "smithy.api#required": {} + } + }, + "AddAllowedPrincipals": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the principals.\n\t Permissions are granted to the principals in this list.\n\t To grant permissions to all principals, specify an asterisk (*).

" + } + }, + "RemoveAllowedPrincipals": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the principals.\n\t Permissions are revoked for principals in this list.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyVpcEndpointServicePermissionsResult": { + "type": "structure", + "members": { + "AddedPrincipals": { + "target": "com.amazonaws.ec2#AddedPrincipalSet", + "traits": { + "aws.protocols#ec2QueryName": "AddedPrincipalSet", + "smithy.api#documentation": "

Information about the added principals.

", + "smithy.api#xmlName": "addedPrincipalSet" + } + }, + "ReturnValue": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyVpcPeeringConnectionOptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyVpcPeeringConnectionOptionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyVpcPeeringConnectionOptionsResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the VPC peering connection options on one side of a VPC peering connection.

\n

If the peered VPCs are in the same Amazon Web Services account, you can enable DNS\n resolution for queries from the local VPC. This ensures that queries from the local VPC\n resolve to private IP addresses in the peer VPC. This option is not available if the\n peered VPCs are in different Amazon Web Services accounts or different Regions. For\n peered VPCs in different Amazon Web Services accounts, each Amazon Web Services account\n owner must initiate a separate request to modify the peering connection options. For\n inter-region peering connections, you must use the Region for the requester VPC to\n modify the requester VPC peering options and the Region for the accepter VPC to modify\n the accepter VPC peering options. To verify which VPCs are the accepter and the\n requester for a VPC peering connection, use the DescribeVpcPeeringConnections command.

" + } + }, + "com.amazonaws.ec2#ModifyVpcPeeringConnectionOptionsRequest": { + "type": "structure", + "members": { + "AccepterPeeringConnectionOptions": { + "target": "com.amazonaws.ec2#PeeringConnectionOptionsRequest", + "traits": { + "smithy.api#documentation": "

The VPC peering connection options for the accepter VPC.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "RequesterPeeringConnectionOptions": { + "target": "com.amazonaws.ec2#PeeringConnectionOptionsRequest", + "traits": { + "smithy.api#documentation": "

The VPC peering connection options for the requester VPC.

" + } + }, + "VpcPeeringConnectionId": { + "target": "com.amazonaws.ec2#VpcPeeringConnectionId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC peering connection.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyVpcPeeringConnectionOptionsResult": { + "type": "structure", + "members": { + "AccepterPeeringConnectionOptions": { + "target": "com.amazonaws.ec2#PeeringConnectionOptions", + "traits": { + "aws.protocols#ec2QueryName": "AccepterPeeringConnectionOptions", + "smithy.api#documentation": "

Information about the VPC peering connection options for the accepter VPC.

", + "smithy.api#xmlName": "accepterPeeringConnectionOptions" + } + }, + "RequesterPeeringConnectionOptions": { + "target": "com.amazonaws.ec2#PeeringConnectionOptions", + "traits": { + "aws.protocols#ec2QueryName": "RequesterPeeringConnectionOptions", + "smithy.api#documentation": "

Information about the VPC peering connection options for the requester VPC.

", + "smithy.api#xmlName": "requesterPeeringConnectionOptions" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyVpcTenancy": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyVpcTenancyRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyVpcTenancyResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the instance tenancy attribute of the specified VPC. You can change the\n instance tenancy attribute of a VPC to default only. You cannot change the\n instance tenancy attribute to dedicated.

\n

After you modify the tenancy of the VPC, any new instances that you launch into the\n VPC have a tenancy of default, unless you specify otherwise during launch.\n The tenancy of any existing instances in the VPC is not affected.

\n

For more information, see Dedicated Instances in the\n\t\t\t\tAmazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#ModifyVpcTenancyRequest": { + "type": "structure", + "members": { + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#required": {} + } + }, + "InstanceTenancy": { + "target": "com.amazonaws.ec2#VpcTenancy", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The instance tenancy attribute for the VPC.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyVpcTenancyResult": { + "type": "structure", + "members": { + "ReturnValue": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, returns an\n error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyVpnConnection": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyVpnConnectionRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyVpnConnectionResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the customer gateway or the target gateway of an Amazon Web Services Site-to-Site VPN connection. To\n modify the target gateway, the following migration options are available:

\n \n

Before you perform the migration to the new gateway, you must configure the new\n gateway. Use CreateVpnGateway to create a virtual private gateway, or\n CreateTransitGateway to create a transit gateway.

\n

This step is required when you migrate from a virtual private gateway with static\n routes to a transit gateway.

\n

You must delete the static routes before you migrate to the new gateway.

\n

Keep a copy of the static route before you delete it. You will need to add back these\n routes to the transit gateway after the VPN connection migration is complete.

\n

After you migrate to the new gateway, you might need to modify your VPC route table.\n Use CreateRoute and DeleteRoute to make the changes\n described in Update VPC route\n tables in the Amazon Web Services Site-to-Site VPN User Guide.

\n

When the new gateway is a transit gateway, modify the transit gateway route table to\n allow traffic between the VPC and the Amazon Web Services Site-to-Site VPN connection.\n Use CreateTransitGatewayRoute to add the routes.

\n

If you deleted VPN static routes, you must add the static routes to the transit\n gateway route table.

\n

After you perform this operation, the VPN endpoint's IP addresses on the Amazon Web Services side and the tunnel options remain intact. Your Amazon Web Services Site-to-Site VPN connection will\n be temporarily unavailable for a brief period while we provision the new\n endpoints.

" + } + }, + "com.amazonaws.ec2#ModifyVpnConnectionOptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyVpnConnectionOptionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyVpnConnectionOptionsResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the connection options for your Site-to-Site VPN connection.

\n

When you modify the VPN connection options, the VPN endpoint IP addresses on the\n Amazon Web Services side do not change, and the tunnel options do not change. Your\n VPN connection will be temporarily unavailable for a brief period while the VPN\n connection is updated.

" + } + }, + "com.amazonaws.ec2#ModifyVpnConnectionOptionsRequest": { + "type": "structure", + "members": { + "VpnConnectionId": { + "target": "com.amazonaws.ec2#VpnConnectionId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Site-to-Site VPN connection.

", + "smithy.api#required": {} + } + }, + "LocalIpv4NetworkCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.

\n

Default: 0.0.0.0/0\n

" + } + }, + "RemoteIpv4NetworkCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IPv4 CIDR on the Amazon Web Services side of the VPN connection.

\n

Default: 0.0.0.0/0\n

" + } + }, + "LocalIpv6NetworkCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.

\n

Default: ::/0\n

" + } + }, + "RemoteIpv6NetworkCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IPv6 CIDR on the Amazon Web Services side of the VPN connection.

\n

Default: ::/0\n

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyVpnConnectionOptionsResult": { + "type": "structure", + "members": { + "VpnConnection": { + "target": "com.amazonaws.ec2#VpnConnection", + "traits": { + "aws.protocols#ec2QueryName": "VpnConnection", + "smithy.api#documentation": "

Information about the VPN connection.

", + "smithy.api#xmlName": "vpnConnection" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyVpnConnectionRequest": { + "type": "structure", + "members": { + "VpnConnectionId": { + "target": "com.amazonaws.ec2#VpnConnectionId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPN connection.

", + "smithy.api#required": {} + } + }, + "TransitGatewayId": { + "target": "com.amazonaws.ec2#TransitGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the transit gateway.

" + } + }, + "CustomerGatewayId": { + "target": "com.amazonaws.ec2#CustomerGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the customer gateway at your end of the VPN connection.

" + } + }, + "VpnGatewayId": { + "target": "com.amazonaws.ec2#VpnGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the virtual private gateway at the Amazon Web Services side of the VPN\n connection.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyVpnConnectionResult": { + "type": "structure", + "members": { + "VpnConnection": { + "target": "com.amazonaws.ec2#VpnConnection", + "traits": { + "aws.protocols#ec2QueryName": "VpnConnection", + "smithy.api#documentation": "

Information about the VPN connection.

", + "smithy.api#xmlName": "vpnConnection" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyVpnTunnelCertificate": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyVpnTunnelCertificateRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyVpnTunnelCertificateResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the VPN tunnel endpoint certificate.

" + } + }, + "com.amazonaws.ec2#ModifyVpnTunnelCertificateRequest": { + "type": "structure", + "members": { + "VpnConnectionId": { + "target": "com.amazonaws.ec2#VpnConnectionId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Amazon Web Services Site-to-Site VPN connection.

", + "smithy.api#required": {} + } + }, + "VpnTunnelOutsideIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The external IP address of the VPN tunnel.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyVpnTunnelCertificateResult": { + "type": "structure", + "members": { + "VpnConnection": { + "target": "com.amazonaws.ec2#VpnConnection", + "traits": { + "aws.protocols#ec2QueryName": "VpnConnection", + "smithy.api#documentation": "

Information about the VPN connection.

", + "smithy.api#xmlName": "vpnConnection" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyVpnTunnelOptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyVpnTunnelOptionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyVpnTunnelOptionsResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the options for a VPN tunnel in an Amazon Web Services Site-to-Site VPN connection. You can modify\n multiple options for a tunnel in a single request, but you can only modify one tunnel at\n a time. For more information, see Site-to-Site VPN tunnel options for your Site-to-Site VPN\n connection in the Amazon Web Services Site-to-Site VPN User Guide.

" + } + }, + "com.amazonaws.ec2#ModifyVpnTunnelOptionsRequest": { + "type": "structure", + "members": { + "VpnConnectionId": { + "target": "com.amazonaws.ec2#VpnConnectionId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Amazon Web Services Site-to-Site VPN connection.

", + "smithy.api#required": {} + } + }, + "VpnTunnelOutsideIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The external IP address of the VPN tunnel.

", + "smithy.api#required": {} + } + }, + "TunnelOptions": { + "target": "com.amazonaws.ec2#ModifyVpnTunnelOptionsSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The tunnel options to modify.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" + } + }, + "SkipTunnelReplacement": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Choose whether or not to trigger immediate tunnel replacement. This is only applicable when turning on or off EnableTunnelLifecycleControl.

\n

Valid values: True | False\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyVpnTunnelOptionsResult": { + "type": "structure", + "members": { + "VpnConnection": { + "target": "com.amazonaws.ec2#VpnConnection", + "traits": { + "aws.protocols#ec2QueryName": "VpnConnection", + "smithy.api#documentation": "

Information about the VPN connection.

", + "smithy.api#xmlName": "vpnConnection" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyVpnTunnelOptionsSpecification": { + "type": "structure", + "members": { + "TunnelInsideCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The range of inside IPv4 addresses for the tunnel. Any specified CIDR blocks must be\n unique across all VPN connections that use the same virtual private gateway.

\n

Constraints: A size /30 CIDR block from the 169.254.0.0/16 range. The\n following CIDR blocks are reserved and cannot be used:

\n " + } + }, + "TunnelInsideIpv6Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The range of inside IPv6 addresses for the tunnel. Any specified CIDR blocks must be\n unique across all VPN connections that use the same transit gateway.

\n

Constraints: A size /126 CIDR block from the local fd00::/8 range.

" + } + }, + "PreSharedKey": { + "target": "com.amazonaws.ec2#preSharedKey", + "traits": { + "smithy.api#documentation": "

The pre-shared key (PSK) to establish initial authentication between the virtual\n private gateway and the customer gateway.

\n

Constraints: Allowed characters are alphanumeric characters, periods (.), and\n underscores (_). Must be between 8 and 64 characters in length and cannot start with\n zero (0).

" + } + }, + "Phase1LifetimeSeconds": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The lifetime for phase 1 of the IKE negotiation, in seconds.

\n

Constraints: A value between 900 and 28,800.

\n

Default: 28800\n

" + } + }, + "Phase2LifetimeSeconds": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The lifetime for phase 2 of the IKE negotiation, in seconds.

\n

Constraints: A value between 900 and 3,600. The value must be less than the value for\n Phase1LifetimeSeconds.

\n

Default: 3600\n

" + } + }, + "RekeyMarginTimeSeconds": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The margin time, in seconds, before the phase 2 lifetime expires, during which the\n Amazon Web Services side of the VPN connection performs an IKE rekey. The exact time\n of the rekey is randomly selected based on the value for\n RekeyFuzzPercentage.

\n

Constraints: A value between 60 and half of Phase2LifetimeSeconds.

\n

Default: 270\n

" + } + }, + "RekeyFuzzPercentage": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The percentage of the rekey window (determined by RekeyMarginTimeSeconds)\n during which the rekey time is randomly selected.

\n

Constraints: A value between 0 and 100.

\n

Default: 100\n

" + } + }, + "ReplayWindowSize": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The number of packets in an IKE replay window.

\n

Constraints: A value between 64 and 2048.

\n

Default: 1024\n

" + } + }, + "DPDTimeoutSeconds": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The number of seconds after which a DPD timeout occurs. A DPD timeout of 40 seconds means that the VPN endpoint will consider the peer dead 30 seconds after the first failed keep-alive.

\n

Constraints: A value greater than or equal to 30.

\n

Default: 40\n

" + } + }, + "DPDTimeoutAction": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The action to take after DPD timeout occurs. Specify restart to restart\n the IKE initiation. Specify clear to end the IKE session.

\n

Valid Values: clear | none | restart\n

\n

Default: clear\n

" + } + }, + "Phase1EncryptionAlgorithms": { + "target": "com.amazonaws.ec2#Phase1EncryptionAlgorithmsRequestList", + "traits": { + "smithy.api#documentation": "

One or more encryption algorithms that are permitted for the VPN tunnel for phase 1\n IKE negotiations.

\n

Valid values: AES128 | AES256 | AES128-GCM-16 |\n AES256-GCM-16\n

", + "smithy.api#xmlName": "Phase1EncryptionAlgorithm" + } + }, + "Phase2EncryptionAlgorithms": { + "target": "com.amazonaws.ec2#Phase2EncryptionAlgorithmsRequestList", + "traits": { + "smithy.api#documentation": "

One or more encryption algorithms that are permitted for the VPN tunnel for phase 2\n IKE negotiations.

\n

Valid values: AES128 | AES256 | AES128-GCM-16 |\n AES256-GCM-16\n

", + "smithy.api#xmlName": "Phase2EncryptionAlgorithm" + } + }, + "Phase1IntegrityAlgorithms": { + "target": "com.amazonaws.ec2#Phase1IntegrityAlgorithmsRequestList", + "traits": { + "smithy.api#documentation": "

One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE\n negotiations.

\n

Valid values: SHA1 | SHA2-256 | SHA2-384 |\n SHA2-512\n

", + "smithy.api#xmlName": "Phase1IntegrityAlgorithm" + } + }, + "Phase2IntegrityAlgorithms": { + "target": "com.amazonaws.ec2#Phase2IntegrityAlgorithmsRequestList", + "traits": { + "smithy.api#documentation": "

One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE\n negotiations.

\n

Valid values: SHA1 | SHA2-256 | SHA2-384 |\n SHA2-512\n

", + "smithy.api#xmlName": "Phase2IntegrityAlgorithm" + } + }, + "Phase1DHGroupNumbers": { + "target": "com.amazonaws.ec2#Phase1DHGroupNumbersRequestList", + "traits": { + "smithy.api#documentation": "

One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for\n phase 1 IKE negotiations.

\n

Valid values: 2 | 14 | 15 | 16 |\n 17 | 18 | 19 | 20 |\n 21 | 22 | 23 | 24\n

", + "smithy.api#xmlName": "Phase1DHGroupNumber" + } + }, + "Phase2DHGroupNumbers": { + "target": "com.amazonaws.ec2#Phase2DHGroupNumbersRequestList", + "traits": { + "smithy.api#documentation": "

One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for\n phase 2 IKE negotiations.

\n

Valid values: 2 | 5 | 14 | 15 |\n 16 | 17 | 18 | 19 |\n 20 | 21 | 22 | 23 |\n 24\n

", + "smithy.api#xmlName": "Phase2DHGroupNumber" + } + }, + "IKEVersions": { + "target": "com.amazonaws.ec2#IKEVersionsRequestList", + "traits": { + "smithy.api#documentation": "

The IKE versions that are permitted for the VPN tunnel.

\n

Valid values: ikev1 | ikev2\n

", + "smithy.api#xmlName": "IKEVersion" + } + }, + "StartupAction": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The action to take when the establishing the tunnel for the VPN connection. By\n default, your customer gateway device must initiate the IKE negotiation and bring up the\n tunnel. Specify start for Amazon Web Services to initiate the IKE\n negotiation.

\n

Valid Values: add | start\n

\n

Default: add\n

" + } + }, + "LogOptions": { + "target": "com.amazonaws.ec2#VpnTunnelLogOptionsSpecification", + "traits": { + "smithy.api#documentation": "

Options for logging VPN tunnel activity.

" + } + }, + "EnableTunnelLifecycleControl": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Turn on or off tunnel endpoint lifecycle control feature.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Site-to-Site VPN tunnel options to modify.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.ec2#MonitorInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#MonitorInstancesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#MonitorInstancesResult" + }, + "traits": { + "smithy.api#documentation": "

Enables detailed monitoring for a running instance. Otherwise, basic monitoring is\n enabled. For more information, see Monitor your instances using\n CloudWatch in the Amazon EC2 User Guide.

\n

To disable detailed monitoring, see UnmonitorInstances.

" + } + }, + "com.amazonaws.ec2#MonitorInstancesRequest": { + "type": "structure", + "members": { + "InstanceIds": { + "target": "com.amazonaws.ec2#InstanceIdStringList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the instances.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "InstanceId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#MonitorInstancesResult": { + "type": "structure", + "members": { + "InstanceMonitorings": { + "target": "com.amazonaws.ec2#InstanceMonitoringList", + "traits": { + "aws.protocols#ec2QueryName": "InstancesSet", + "smithy.api#documentation": "

The monitoring information.

", + "smithy.api#xmlName": "instancesSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#Monitoring": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.ec2#MonitoringState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is\n enabled.

", + "smithy.api#xmlName": "state" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the monitoring of an instance.

" + } + }, + "com.amazonaws.ec2#MonitoringState": { + "type": "enum", + "members": { + "disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + }, + "disabling": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabling" + } + }, + "enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + }, + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + } + } + }, + "com.amazonaws.ec2#MoveAddressToVpc": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#MoveAddressToVpcRequest" + }, + "output": { + "target": "com.amazonaws.ec2#MoveAddressToVpcResult" + }, + "traits": { + "smithy.api#documentation": "\n

This action is deprecated.

\n \n

Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The\n Elastic IP address must be allocated to your account for more than 24 hours, and it must not\n be associated with an instance. After the Elastic IP address is moved, it is no longer\n available for use in the EC2-Classic platform, unless you move it back using the\n RestoreAddressToClassic request. You cannot move an Elastic IP address that was\n originally allocated for use in the EC2-VPC platform to the EC2-Classic platform.

", + "smithy.api#examples": [ + { + "title": "To move an address to EC2-VPC", + "documentation": "This example moves the specified Elastic IP address to the EC2-VPC platform.", + "input": { + "PublicIp": "54.123.4.56" + }, + "output": { + "Status": "MoveInProgress" + } + } + ] + } + }, + "com.amazonaws.ec2#MoveAddressToVpcRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "PublicIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicIp", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Elastic IP address.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "publicIp" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#MoveAddressToVpcResult": { + "type": "structure", + "members": { + "AllocationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AllocationId", + "smithy.api#documentation": "

The allocation ID for the Elastic IP address.

", + "smithy.api#xmlName": "allocationId" + } + }, + "Status": { + "target": "com.amazonaws.ec2#Status", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The status of the move of the IP address.

", + "smithy.api#xmlName": "status" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#MoveByoipCidrToIpam": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#MoveByoipCidrToIpamRequest" + }, + "output": { + "target": "com.amazonaws.ec2#MoveByoipCidrToIpamResult" + }, + "traits": { + "smithy.api#documentation": "

Move a BYOIPv4 CIDR to IPAM from a public IPv4 pool.

\n

If you already have a BYOIPv4 CIDR with Amazon Web Services, you can move the CIDR to IPAM from a public IPv4 pool. You cannot move an IPv6 CIDR to IPAM. If you are bringing a new IP address to Amazon Web Services for the first time, complete the steps in Tutorial: BYOIP address CIDRs to IPAM.

" + } + }, + "com.amazonaws.ec2#MoveByoipCidrToIpamRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The BYOIP CIDR.

", + "smithy.api#required": {} + } + }, + "IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IPAM pool ID.

", + "smithy.api#required": {} + } + }, + "IpamPoolOwner": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Web Services account ID of the owner of the IPAM pool.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#MoveByoipCidrToIpamResult": { + "type": "structure", + "members": { + "ByoipCidr": { + "target": "com.amazonaws.ec2#ByoipCidr", + "traits": { + "aws.protocols#ec2QueryName": "ByoipCidr", + "smithy.api#documentation": "

The BYOIP CIDR.

", + "smithy.api#xmlName": "byoipCidr" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#MoveCapacityReservationInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#MoveCapacityReservationInstancesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#MoveCapacityReservationInstancesResult" + }, + "traits": { + "smithy.api#documentation": "

Move available capacity from a source Capacity Reservation to a destination Capacity\n\t\t\tReservation. The source Capacity Reservation and the destination Capacity Reservation\n\t\t\tmust be active, owned by your Amazon Web Services account, and share the following:

\n " + } + }, + "com.amazonaws.ec2#MoveCapacityReservationInstancesRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "SourceCapacityReservationId": { + "target": "com.amazonaws.ec2#CapacityReservationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Capacity Reservation from which you want to move capacity.

", + "smithy.api#required": {} + } + }, + "DestinationCapacityReservationId": { + "target": "com.amazonaws.ec2#CapacityReservationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Capacity Reservation that you want to move capacity into.

", + "smithy.api#required": {} + } + }, + "InstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of instances that you want to move from the source Capacity Reservation.\n\t\t

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#MoveCapacityReservationInstancesResult": { + "type": "structure", + "members": { + "SourceCapacityReservation": { + "target": "com.amazonaws.ec2#CapacityReservation", + "traits": { + "aws.protocols#ec2QueryName": "SourceCapacityReservation", + "smithy.api#documentation": "

Information about the source Capacity Reservation.

", + "smithy.api#xmlName": "sourceCapacityReservation" + } + }, + "DestinationCapacityReservation": { + "target": "com.amazonaws.ec2#CapacityReservation", + "traits": { + "aws.protocols#ec2QueryName": "DestinationCapacityReservation", + "smithy.api#documentation": "

Information about the destination Capacity Reservation.

", + "smithy.api#xmlName": "destinationCapacityReservation" + } + }, + "InstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "InstanceCount", + "smithy.api#documentation": "

The number of instances that were moved from the source Capacity Reservation to the\n\t\t\tdestination Capacity Reservation.

", + "smithy.api#xmlName": "instanceCount" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#MoveStatus": { + "type": "enum", + "members": { + "movingToVpc": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "movingToVpc" + } + }, + "restoringToClassic": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "restoringToClassic" + } + } + } + }, + "com.amazonaws.ec2#MovingAddressStatus": { + "type": "structure", + "members": { + "MoveStatus": { + "target": "com.amazonaws.ec2#MoveStatus", + "traits": { + "aws.protocols#ec2QueryName": "MoveStatus", + "smithy.api#documentation": "

The status of the Elastic IP address that's being moved or restored.

", + "smithy.api#xmlName": "moveStatus" + } + }, + "PublicIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicIp", + "smithy.api#documentation": "

The Elastic IP address.

", + "smithy.api#xmlName": "publicIp" + } + } + }, + "traits": { + "smithy.api#documentation": "\n

This action is deprecated.

\n \n

Describes the status of a moving Elastic IP address.

" + } + }, + "com.amazonaws.ec2#MovingAddressStatusSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#MovingAddressStatus", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#MulticastSupportValue": { + "type": "enum", + "members": { + "enable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enable" + } + }, + "disable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disable" + } + } + } + }, + "com.amazonaws.ec2#NatGateway": { + "type": "structure", + "members": { + "CreateTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreateTime", + "smithy.api#documentation": "

The date and time the NAT gateway was created.

", + "smithy.api#xmlName": "createTime" + } + }, + "DeleteTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "DeleteTime", + "smithy.api#documentation": "

The date and time the NAT gateway was deleted, if applicable.

", + "smithy.api#xmlName": "deleteTime" + } + }, + "FailureCode": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "FailureCode", + "smithy.api#documentation": "

If the NAT gateway could not be created, specifies the error code for the failure.\n (InsufficientFreeAddressesInSubnet | Gateway.NotAttached |\n InvalidAllocationID.NotFound | Resource.AlreadyAssociated |\n InternalError | InvalidSubnetID.NotFound)

", + "smithy.api#xmlName": "failureCode" + } + }, + "FailureMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "FailureMessage", + "smithy.api#documentation": "

If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code.

\n ", + "smithy.api#xmlName": "failureMessage" + } + }, + "NatGatewayAddresses": { + "target": "com.amazonaws.ec2#NatGatewayAddressList", + "traits": { + "aws.protocols#ec2QueryName": "NatGatewayAddressSet", + "smithy.api#documentation": "

Information about the IP addresses and network interface associated with the NAT gateway.

", + "smithy.api#xmlName": "natGatewayAddressSet" + } + }, + "NatGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NatGatewayId", + "smithy.api#documentation": "

The ID of the NAT gateway.

", + "smithy.api#xmlName": "natGatewayId" + } + }, + "ProvisionedBandwidth": { + "target": "com.amazonaws.ec2#ProvisionedBandwidth", + "traits": { + "aws.protocols#ec2QueryName": "ProvisionedBandwidth", + "smithy.api#documentation": "

Reserved. If you need to sustain traffic greater than the documented limits, \n contact Amazon Web Services Support.

", + "smithy.api#xmlName": "provisionedBandwidth" + } + }, + "State": { + "target": "com.amazonaws.ec2#NatGatewayState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the NAT gateway.

\n ", + "smithy.api#xmlName": "state" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet in which the NAT gateway is located.

", + "smithy.api#xmlName": "subnetId" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC in which the NAT gateway is located.

", + "smithy.api#xmlName": "vpcId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags for the NAT gateway.

", + "smithy.api#xmlName": "tagSet" + } + }, + "ConnectivityType": { + "target": "com.amazonaws.ec2#ConnectivityType", + "traits": { + "aws.protocols#ec2QueryName": "ConnectivityType", + "smithy.api#documentation": "

Indicates whether the NAT gateway supports public or private connectivity.

", + "smithy.api#xmlName": "connectivityType" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a NAT gateway.

" + } + }, + "com.amazonaws.ec2#NatGatewayAddress": { + "type": "structure", + "members": { + "AllocationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AllocationId", + "smithy.api#documentation": "

[Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway.

", + "smithy.api#xmlName": "allocationId" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of the network interface associated with the NAT gateway.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "PrivateIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIp", + "smithy.api#documentation": "

The private IP address associated with the NAT gateway.

", + "smithy.api#xmlName": "privateIp" + } + }, + "PublicIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicIp", + "smithy.api#documentation": "

[Public NAT gateway only] The Elastic IP address associated with the NAT gateway.

", + "smithy.api#xmlName": "publicIp" + } + }, + "AssociationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AssociationId", + "smithy.api#documentation": "

[Public NAT gateway only] The association ID of the Elastic IP address that's associated with the NAT gateway.

", + "smithy.api#xmlName": "associationId" + } + }, + "IsPrimary": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "IsPrimary", + "smithy.api#documentation": "

Defines if the IP address is the primary address.

", + "smithy.api#xmlName": "isPrimary" + } + }, + "FailureMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "FailureMessage", + "smithy.api#documentation": "

The address failure message.

", + "smithy.api#xmlName": "failureMessage" + } + }, + "Status": { + "target": "com.amazonaws.ec2#NatGatewayAddressStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The address status.

", + "smithy.api#xmlName": "status" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the IP addresses and network interface associated with a NAT gateway.

" + } + }, + "com.amazonaws.ec2#NatGatewayAddressList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NatGatewayAddress", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NatGatewayAddressStatus": { + "type": "enum", + "members": { + "ASSIGNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "assigning" + } + }, + "UNASSIGNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unassigning" + } + }, + "ASSOCIATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associating" + } + }, + "DISASSOCIATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociating" + } + }, + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "succeeded" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + } + } + }, + "com.amazonaws.ec2#NatGatewayId": { + "type": "string" + }, + "com.amazonaws.ec2#NatGatewayIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NatGatewayId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NatGatewayList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NatGateway", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NatGatewayState": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + }, + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted" + } + } + } + }, + "com.amazonaws.ec2#NativeApplicationOidcOptions": { + "type": "structure", + "members": { + "PublicSigningKeyEndpoint": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicSigningKeyEndpoint", + "smithy.api#documentation": "

The public signing key endpoint.

", + "smithy.api#xmlName": "publicSigningKeyEndpoint" + } + }, + "Issuer": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Issuer", + "smithy.api#documentation": "

The OIDC issuer identifier of the IdP.

", + "smithy.api#xmlName": "issuer" + } + }, + "AuthorizationEndpoint": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AuthorizationEndpoint", + "smithy.api#documentation": "

The authorization endpoint of the IdP.

", + "smithy.api#xmlName": "authorizationEndpoint" + } + }, + "TokenEndpoint": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TokenEndpoint", + "smithy.api#documentation": "

The token endpoint of the IdP.

", + "smithy.api#xmlName": "tokenEndpoint" + } + }, + "UserInfoEndpoint": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "UserInfoEndpoint", + "smithy.api#documentation": "

The user info endpoint of the IdP.

", + "smithy.api#xmlName": "userInfoEndpoint" + } + }, + "ClientId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientId", + "smithy.api#documentation": "

The OAuth 2.0 client identifier.

", + "smithy.api#xmlName": "clientId" + } + }, + "Scope": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Scope", + "smithy.api#documentation": "

The set of user claims to be requested from the IdP.

", + "smithy.api#xmlName": "scope" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the OpenID Connect (OIDC) options.

" + } + }, + "com.amazonaws.ec2#NetmaskLength": { + "type": "integer" + }, + "com.amazonaws.ec2#NetworkAcl": { + "type": "structure", + "members": { + "Associations": { + "target": "com.amazonaws.ec2#NetworkAclAssociationList", + "traits": { + "aws.protocols#ec2QueryName": "AssociationSet", + "smithy.api#documentation": "

Any associations between the network ACL and your subnets

", + "smithy.api#xmlName": "associationSet" + } + }, + "Entries": { + "target": "com.amazonaws.ec2#NetworkAclEntryList", + "traits": { + "aws.protocols#ec2QueryName": "EntrySet", + "smithy.api#documentation": "

The entries (rules) in the network ACL.

", + "smithy.api#xmlName": "entrySet" + } + }, + "IsDefault": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Default", + "smithy.api#documentation": "

Indicates whether this is the default network ACL for the VPC.

", + "smithy.api#xmlName": "default" + } + }, + "NetworkAclId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkAclId", + "smithy.api#documentation": "

The ID of the network ACL.

", + "smithy.api#xmlName": "networkAclId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the network ACL.

", + "smithy.api#xmlName": "tagSet" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC for the network ACL.

", + "smithy.api#xmlName": "vpcId" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the network ACL.

", + "smithy.api#xmlName": "ownerId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a network ACL.

" + } + }, + "com.amazonaws.ec2#NetworkAclAssociation": { + "type": "structure", + "members": { + "NetworkAclAssociationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkAclAssociationId", + "smithy.api#documentation": "

The ID of the association between a network ACL and a subnet.

", + "smithy.api#xmlName": "networkAclAssociationId" + } + }, + "NetworkAclId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkAclId", + "smithy.api#documentation": "

The ID of the network ACL.

", + "smithy.api#xmlName": "networkAclId" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet.

", + "smithy.api#xmlName": "subnetId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an association between a network ACL and a subnet.

" + } + }, + "com.amazonaws.ec2#NetworkAclAssociationId": { + "type": "string" + }, + "com.amazonaws.ec2#NetworkAclAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NetworkAclAssociation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NetworkAclEntry": { + "type": "structure", + "members": { + "CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CidrBlock", + "smithy.api#documentation": "

The IPv4 network range to allow or deny, in CIDR notation.

", + "smithy.api#xmlName": "cidrBlock" + } + }, + "Egress": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Egress", + "smithy.api#documentation": "

Indicates whether the rule is an egress rule (applied to traffic leaving the subnet).

", + "smithy.api#xmlName": "egress" + } + }, + "IcmpTypeCode": { + "target": "com.amazonaws.ec2#IcmpTypeCode", + "traits": { + "aws.protocols#ec2QueryName": "IcmpTypeCode", + "smithy.api#documentation": "

ICMP protocol: The ICMP type and code.

", + "smithy.api#xmlName": "icmpTypeCode" + } + }, + "Ipv6CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6CidrBlock", + "smithy.api#documentation": "

The IPv6 network range to allow or deny, in CIDR notation.

", + "smithy.api#xmlName": "ipv6CidrBlock" + } + }, + "PortRange": { + "target": "com.amazonaws.ec2#PortRange", + "traits": { + "aws.protocols#ec2QueryName": "PortRange", + "smithy.api#documentation": "

TCP or UDP protocols: The range of ports the rule applies to.

", + "smithy.api#xmlName": "portRange" + } + }, + "Protocol": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Protocol", + "smithy.api#documentation": "

The protocol number. A value of \"-1\" means all protocols.

", + "smithy.api#xmlName": "protocol" + } + }, + "RuleAction": { + "target": "com.amazonaws.ec2#RuleAction", + "traits": { + "aws.protocols#ec2QueryName": "RuleAction", + "smithy.api#documentation": "

Indicates whether to allow or deny the traffic that matches the rule.

", + "smithy.api#xmlName": "ruleAction" + } + }, + "RuleNumber": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "RuleNumber", + "smithy.api#documentation": "

The rule number for the entry. ACL entries are processed in ascending order by rule number.

", + "smithy.api#xmlName": "ruleNumber" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an entry in a network ACL.

" + } + }, + "com.amazonaws.ec2#NetworkAclEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NetworkAclEntry", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NetworkAclId": { + "type": "string" + }, + "com.amazonaws.ec2#NetworkAclIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NetworkAclId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NetworkAclList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NetworkAcl", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NetworkBandwidthGbps": { + "type": "structure", + "members": { + "Min": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "Min", + "smithy.api#documentation": "

The minimum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no minimum\n limit.

", + "smithy.api#xmlName": "min" + } + }, + "Max": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "Max", + "smithy.api#documentation": "

The maximum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no\n maximum limit.

", + "smithy.api#xmlName": "max" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).

\n \n

Setting the minimum bandwidth does not guarantee that your instance will achieve the \n minimum bandwidth. Amazon EC2 will identify instance types that support the specified minimum \n bandwidth, but the actual bandwidth of your instance might go below the specified minimum \n at times. For more information, see Available instance bandwidth in the\n Amazon EC2 User Guide.

\n " + } + }, + "com.amazonaws.ec2#NetworkBandwidthGbpsRequest": { + "type": "structure", + "members": { + "Min": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "smithy.api#documentation": "

The minimum amount of network bandwidth, in Gbps. To specify no minimum limit, omit this\n parameter.

" + } + }, + "Max": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "smithy.api#documentation": "

The maximum amount of network bandwidth, in Gbps. To specify no maximum limit, omit this\n parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).

\n \n

Setting the minimum bandwidth does not guarantee that your instance will achieve the \n minimum bandwidth. Amazon EC2 will identify instance types that support the specified minimum \n bandwidth, but the actual bandwidth of your instance might go below the specified minimum \n at times. For more information, see Available instance bandwidth in the\n Amazon EC2 User Guide.

\n " + } + }, + "com.amazonaws.ec2#NetworkCardIndex": { + "type": "integer" + }, + "com.amazonaws.ec2#NetworkCardInfo": { + "type": "structure", + "members": { + "NetworkCardIndex": { + "target": "com.amazonaws.ec2#NetworkCardIndex", + "traits": { + "aws.protocols#ec2QueryName": "NetworkCardIndex", + "smithy.api#documentation": "

The index of the network card.

", + "smithy.api#xmlName": "networkCardIndex" + } + }, + "NetworkPerformance": { + "target": "com.amazonaws.ec2#NetworkPerformance", + "traits": { + "aws.protocols#ec2QueryName": "NetworkPerformance", + "smithy.api#documentation": "

The network performance of the network card.

", + "smithy.api#xmlName": "networkPerformance" + } + }, + "MaximumNetworkInterfaces": { + "target": "com.amazonaws.ec2#MaxNetworkInterfaces", + "traits": { + "aws.protocols#ec2QueryName": "MaximumNetworkInterfaces", + "smithy.api#documentation": "

The maximum number of network interfaces for the network card.

", + "smithy.api#xmlName": "maximumNetworkInterfaces" + } + }, + "BaselineBandwidthInGbps": { + "target": "com.amazonaws.ec2#BaselineBandwidthInGbps", + "traits": { + "aws.protocols#ec2QueryName": "BaselineBandwidthInGbps", + "smithy.api#documentation": "

The baseline network performance of the network card, in Gbps.

", + "smithy.api#xmlName": "baselineBandwidthInGbps" + } + }, + "PeakBandwidthInGbps": { + "target": "com.amazonaws.ec2#PeakBandwidthInGbps", + "traits": { + "aws.protocols#ec2QueryName": "PeakBandwidthInGbps", + "smithy.api#documentation": "

The peak (burst) network performance of the network card, in Gbps.

", + "smithy.api#xmlName": "peakBandwidthInGbps" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the network card support of the instance type.

" + } + }, + "com.amazonaws.ec2#NetworkCardInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NetworkCardInfo", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NetworkInfo": { + "type": "structure", + "members": { + "NetworkPerformance": { + "target": "com.amazonaws.ec2#NetworkPerformance", + "traits": { + "aws.protocols#ec2QueryName": "NetworkPerformance", + "smithy.api#documentation": "

The network performance.

", + "smithy.api#xmlName": "networkPerformance" + } + }, + "MaximumNetworkInterfaces": { + "target": "com.amazonaws.ec2#MaxNetworkInterfaces", + "traits": { + "aws.protocols#ec2QueryName": "MaximumNetworkInterfaces", + "smithy.api#documentation": "

The maximum number of network interfaces for the instance type.

", + "smithy.api#xmlName": "maximumNetworkInterfaces" + } + }, + "MaximumNetworkCards": { + "target": "com.amazonaws.ec2#MaximumNetworkCards", + "traits": { + "aws.protocols#ec2QueryName": "MaximumNetworkCards", + "smithy.api#documentation": "

The maximum number of physical network cards that can be allocated to the instance.

", + "smithy.api#xmlName": "maximumNetworkCards" + } + }, + "DefaultNetworkCardIndex": { + "target": "com.amazonaws.ec2#DefaultNetworkCardIndex", + "traits": { + "aws.protocols#ec2QueryName": "DefaultNetworkCardIndex", + "smithy.api#documentation": "

The index of the default network card, starting at 0.

", + "smithy.api#xmlName": "defaultNetworkCardIndex" + } + }, + "NetworkCards": { + "target": "com.amazonaws.ec2#NetworkCardInfoList", + "traits": { + "aws.protocols#ec2QueryName": "NetworkCards", + "smithy.api#documentation": "

Describes the network cards for the instance type.

", + "smithy.api#xmlName": "networkCards" + } + }, + "Ipv4AddressesPerInterface": { + "target": "com.amazonaws.ec2#MaxIpv4AddrPerInterface", + "traits": { + "aws.protocols#ec2QueryName": "Ipv4AddressesPerInterface", + "smithy.api#documentation": "

The maximum number of IPv4 addresses per network interface.

", + "smithy.api#xmlName": "ipv4AddressesPerInterface" + } + }, + "Ipv6AddressesPerInterface": { + "target": "com.amazonaws.ec2#MaxIpv6AddrPerInterface", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6AddressesPerInterface", + "smithy.api#documentation": "

The maximum number of IPv6 addresses per network interface.

", + "smithy.api#xmlName": "ipv6AddressesPerInterface" + } + }, + "Ipv6Supported": { + "target": "com.amazonaws.ec2#Ipv6Flag", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6Supported", + "smithy.api#documentation": "

Indicates whether IPv6 is supported.

", + "smithy.api#xmlName": "ipv6Supported" + } + }, + "EnaSupport": { + "target": "com.amazonaws.ec2#EnaSupport", + "traits": { + "aws.protocols#ec2QueryName": "EnaSupport", + "smithy.api#documentation": "

Indicates whether Elastic Network Adapter (ENA) is supported.

", + "smithy.api#xmlName": "enaSupport" + } + }, + "EfaSupported": { + "target": "com.amazonaws.ec2#EfaSupportedFlag", + "traits": { + "aws.protocols#ec2QueryName": "EfaSupported", + "smithy.api#documentation": "

Indicates whether Elastic Fabric Adapter (EFA) is supported.

", + "smithy.api#xmlName": "efaSupported" + } + }, + "EfaInfo": { + "target": "com.amazonaws.ec2#EfaInfo", + "traits": { + "aws.protocols#ec2QueryName": "EfaInfo", + "smithy.api#documentation": "

Describes the Elastic Fabric Adapters for the instance type.

", + "smithy.api#xmlName": "efaInfo" + } + }, + "EncryptionInTransitSupported": { + "target": "com.amazonaws.ec2#EncryptionInTransitSupported", + "traits": { + "aws.protocols#ec2QueryName": "EncryptionInTransitSupported", + "smithy.api#documentation": "

Indicates whether the instance type automatically encrypts in-transit traffic between\n instances.

", + "smithy.api#xmlName": "encryptionInTransitSupported" + } + }, + "EnaSrdSupported": { + "target": "com.amazonaws.ec2#EnaSrdSupported", + "traits": { + "aws.protocols#ec2QueryName": "EnaSrdSupported", + "smithy.api#documentation": "

Indicates whether the instance type supports ENA Express. ENA Express uses Amazon Web Services Scalable Reliable Datagram (SRD) technology to increase the maximum bandwidth used per stream\n and minimize tail latency of network traffic between EC2 instances.

", + "smithy.api#xmlName": "enaSrdSupported" + } + }, + "BandwidthWeightings": { + "target": "com.amazonaws.ec2#BandwidthWeightingTypeList", + "traits": { + "aws.protocols#ec2QueryName": "BandwidthWeightings", + "smithy.api#documentation": "

A list of valid settings for configurable bandwidth weighting for the instance\n \ttype, if supported.

", + "smithy.api#xmlName": "bandwidthWeightings" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the networking features of the instance type.

" + } + }, + "com.amazonaws.ec2#NetworkInsightsAccessScope": { + "type": "structure", + "members": { + "NetworkInsightsAccessScopeId": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeId", + "smithy.api#documentation": "

The ID of the Network Access Scope.

", + "smithy.api#xmlName": "networkInsightsAccessScopeId" + } + }, + "NetworkInsightsAccessScopeArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Network Access Scope.

", + "smithy.api#xmlName": "networkInsightsAccessScopeArn" + } + }, + "CreatedDate": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreatedDate", + "smithy.api#documentation": "

The creation date.

", + "smithy.api#xmlName": "createdDate" + } + }, + "UpdatedDate": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "UpdatedDate", + "smithy.api#documentation": "

The last updated date.

", + "smithy.api#xmlName": "updatedDate" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Network Access Scope.

" + } + }, + "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysis": { + "type": "structure", + "members": { + "NetworkInsightsAccessScopeAnalysisId": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysisId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeAnalysisId", + "smithy.api#documentation": "

The ID of the Network Access Scope analysis.

", + "smithy.api#xmlName": "networkInsightsAccessScopeAnalysisId" + } + }, + "NetworkInsightsAccessScopeAnalysisArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeAnalysisArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Network Access Scope analysis.

", + "smithy.api#xmlName": "networkInsightsAccessScopeAnalysisArn" + } + }, + "NetworkInsightsAccessScopeId": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeId", + "smithy.api#documentation": "

The ID of the Network Access Scope.

", + "smithy.api#xmlName": "networkInsightsAccessScopeId" + } + }, + "Status": { + "target": "com.amazonaws.ec2#AnalysisStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The status.

", + "smithy.api#xmlName": "status" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

The status message.

", + "smithy.api#xmlName": "statusMessage" + } + }, + "WarningMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "WarningMessage", + "smithy.api#documentation": "

The warning message.

", + "smithy.api#xmlName": "warningMessage" + } + }, + "StartDate": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "StartDate", + "smithy.api#documentation": "

The analysis start date.

", + "smithy.api#xmlName": "startDate" + } + }, + "EndDate": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "EndDate", + "smithy.api#documentation": "

The analysis end date.

", + "smithy.api#xmlName": "endDate" + } + }, + "FindingsFound": { + "target": "com.amazonaws.ec2#FindingsFound", + "traits": { + "aws.protocols#ec2QueryName": "FindingsFound", + "smithy.api#documentation": "

Indicates whether there are findings.

", + "smithy.api#xmlName": "findingsFound" + } + }, + "AnalyzedEniCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "AnalyzedEniCount", + "smithy.api#documentation": "

The number of network interfaces analyzed.

", + "smithy.api#xmlName": "analyzedEniCount" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Network Access Scope analysis.

" + } + }, + "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysisId": { + "type": "string" + }, + "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysisIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysisId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysisList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysis", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NetworkInsightsAccessScopeContent": { + "type": "structure", + "members": { + "NetworkInsightsAccessScopeId": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeId", + "smithy.api#documentation": "

The ID of the Network Access Scope.

", + "smithy.api#xmlName": "networkInsightsAccessScopeId" + } + }, + "MatchPaths": { + "target": "com.amazonaws.ec2#AccessScopePathList", + "traits": { + "aws.protocols#ec2QueryName": "MatchPathSet", + "smithy.api#documentation": "

The paths to match.

", + "smithy.api#xmlName": "matchPathSet" + } + }, + "ExcludePaths": { + "target": "com.amazonaws.ec2#AccessScopePathList", + "traits": { + "aws.protocols#ec2QueryName": "ExcludePathSet", + "smithy.api#documentation": "

The paths to exclude.

", + "smithy.api#xmlName": "excludePathSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the Network Access Scope content.

" + } + }, + "com.amazonaws.ec2#NetworkInsightsAccessScopeId": { + "type": "string" + }, + "com.amazonaws.ec2#NetworkInsightsAccessScopeIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NetworkInsightsAccessScopeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScope", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NetworkInsightsAnalysis": { + "type": "structure", + "members": { + "NetworkInsightsAnalysisId": { + "target": "com.amazonaws.ec2#NetworkInsightsAnalysisId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAnalysisId", + "smithy.api#documentation": "

The ID of the network insights analysis.

", + "smithy.api#xmlName": "networkInsightsAnalysisId" + } + }, + "NetworkInsightsAnalysisArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAnalysisArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network insights analysis.

", + "smithy.api#xmlName": "networkInsightsAnalysisArn" + } + }, + "NetworkInsightsPathId": { + "target": "com.amazonaws.ec2#NetworkInsightsPathId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsPathId", + "smithy.api#documentation": "

The ID of the path.

", + "smithy.api#xmlName": "networkInsightsPathId" + } + }, + "AdditionalAccounts": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "AdditionalAccountSet", + "smithy.api#documentation": "

The member accounts that contain resources that the path can traverse.

", + "smithy.api#xmlName": "additionalAccountSet" + } + }, + "FilterInArns": { + "target": "com.amazonaws.ec2#ArnList", + "traits": { + "aws.protocols#ec2QueryName": "FilterInArnSet", + "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the resources that the path must traverse.

", + "smithy.api#xmlName": "filterInArnSet" + } + }, + "StartDate": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "StartDate", + "smithy.api#documentation": "

The time the analysis started.

", + "smithy.api#xmlName": "startDate" + } + }, + "Status": { + "target": "com.amazonaws.ec2#AnalysisStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The status of the network insights analysis.

", + "smithy.api#xmlName": "status" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

The status message, if the status is failed.

", + "smithy.api#xmlName": "statusMessage" + } + }, + "WarningMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "WarningMessage", + "smithy.api#documentation": "

The warning message.

", + "smithy.api#xmlName": "warningMessage" + } + }, + "NetworkPathFound": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "NetworkPathFound", + "smithy.api#documentation": "

Indicates whether the destination is reachable from the source.

", + "smithy.api#xmlName": "networkPathFound" + } + }, + "ForwardPathComponents": { + "target": "com.amazonaws.ec2#PathComponentList", + "traits": { + "aws.protocols#ec2QueryName": "ForwardPathComponentSet", + "smithy.api#documentation": "

The components in the path from source to destination.

", + "smithy.api#xmlName": "forwardPathComponentSet" + } + }, + "ReturnPathComponents": { + "target": "com.amazonaws.ec2#PathComponentList", + "traits": { + "aws.protocols#ec2QueryName": "ReturnPathComponentSet", + "smithy.api#documentation": "

The components in the path from destination to source.

", + "smithy.api#xmlName": "returnPathComponentSet" + } + }, + "Explanations": { + "target": "com.amazonaws.ec2#ExplanationList", + "traits": { + "aws.protocols#ec2QueryName": "ExplanationSet", + "smithy.api#documentation": "

The explanations. For more information, see Reachability Analyzer explanation codes.

", + "smithy.api#xmlName": "explanationSet" + } + }, + "AlternatePathHints": { + "target": "com.amazonaws.ec2#AlternatePathHintList", + "traits": { + "aws.protocols#ec2QueryName": "AlternatePathHintSet", + "smithy.api#documentation": "

Potential intermediate components.

", + "smithy.api#xmlName": "alternatePathHintSet" + } + }, + "SuggestedAccounts": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "SuggestedAccountSet", + "smithy.api#documentation": "

Potential intermediate accounts.

", + "smithy.api#xmlName": "suggestedAccountSet" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a network insights analysis.

" + } + }, + "com.amazonaws.ec2#NetworkInsightsAnalysisId": { + "type": "string" + }, + "com.amazonaws.ec2#NetworkInsightsAnalysisIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NetworkInsightsAnalysisId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NetworkInsightsAnalysisList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NetworkInsightsAnalysis", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NetworkInsightsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.ec2#NetworkInsightsPath": { + "type": "structure", + "members": { + "NetworkInsightsPathId": { + "target": "com.amazonaws.ec2#NetworkInsightsPathId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsPathId", + "smithy.api#documentation": "

The ID of the path.

", + "smithy.api#xmlName": "networkInsightsPathId" + } + }, + "NetworkInsightsPathArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsPathArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the path.

", + "smithy.api#xmlName": "networkInsightsPathArn" + } + }, + "CreatedDate": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreatedDate", + "smithy.api#documentation": "

The time stamp when the path was created.

", + "smithy.api#xmlName": "createdDate" + } + }, + "Source": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Source", + "smithy.api#documentation": "

The ID of the source.

", + "smithy.api#xmlName": "source" + } + }, + "Destination": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Destination", + "smithy.api#documentation": "

The ID of the destination.

", + "smithy.api#xmlName": "destination" + } + }, + "SourceArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "SourceArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source.

", + "smithy.api#xmlName": "sourceArn" + } + }, + "DestinationArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "DestinationArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the destination.

", + "smithy.api#xmlName": "destinationArn" + } + }, + "SourceIp": { + "target": "com.amazonaws.ec2#IpAddress", + "traits": { + "aws.protocols#ec2QueryName": "SourceIp", + "smithy.api#documentation": "

The IP address of the source.

", + "smithy.api#xmlName": "sourceIp" + } + }, + "DestinationIp": { + "target": "com.amazonaws.ec2#IpAddress", + "traits": { + "aws.protocols#ec2QueryName": "DestinationIp", + "smithy.api#documentation": "

The IP address of the destination.

", + "smithy.api#xmlName": "destinationIp" + } + }, + "Protocol": { + "target": "com.amazonaws.ec2#Protocol", + "traits": { + "aws.protocols#ec2QueryName": "Protocol", + "smithy.api#documentation": "

The protocol.

", + "smithy.api#xmlName": "protocol" + } + }, + "DestinationPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "DestinationPort", + "smithy.api#documentation": "

The destination port.

", + "smithy.api#xmlName": "destinationPort" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags associated with the path.

", + "smithy.api#xmlName": "tagSet" + } + }, + "FilterAtSource": { + "target": "com.amazonaws.ec2#PathFilter", + "traits": { + "aws.protocols#ec2QueryName": "FilterAtSource", + "smithy.api#documentation": "

Scopes the analysis to network paths that match specific filters at the source.

", + "smithy.api#xmlName": "filterAtSource" + } + }, + "FilterAtDestination": { + "target": "com.amazonaws.ec2#PathFilter", + "traits": { + "aws.protocols#ec2QueryName": "FilterAtDestination", + "smithy.api#documentation": "

Scopes the analysis to network paths that match specific filters at the destination.

", + "smithy.api#xmlName": "filterAtDestination" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a path.

" + } + }, + "com.amazonaws.ec2#NetworkInsightsPathId": { + "type": "string" + }, + "com.amazonaws.ec2#NetworkInsightsPathIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NetworkInsightsPathId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NetworkInsightsPathList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NetworkInsightsPath", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NetworkInsightsResourceId": { + "type": "string" + }, + "com.amazonaws.ec2#NetworkInterface": { + "type": "structure", + "members": { + "Association": { + "target": "com.amazonaws.ec2#NetworkInterfaceAssociation", + "traits": { + "aws.protocols#ec2QueryName": "Association", + "smithy.api#documentation": "

The association information for an Elastic IP address (IPv4) associated with the network interface.

", + "smithy.api#xmlName": "association" + } + }, + "Attachment": { + "target": "com.amazonaws.ec2#NetworkInterfaceAttachment", + "traits": { + "aws.protocols#ec2QueryName": "Attachment", + "smithy.api#documentation": "

The network interface attachment.

", + "smithy.api#xmlName": "attachment" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "ConnectionTrackingConfiguration": { + "target": "com.amazonaws.ec2#ConnectionTrackingConfiguration", + "traits": { + "aws.protocols#ec2QueryName": "ConnectionTrackingConfiguration", + "smithy.api#documentation": "

A security group connection tracking configuration that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon EC2 User Guide.

", + "smithy.api#xmlName": "connectionTrackingConfiguration" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description.

", + "smithy.api#xmlName": "description" + } + }, + "Groups": { + "target": "com.amazonaws.ec2#GroupIdentifierList", + "traits": { + "aws.protocols#ec2QueryName": "GroupSet", + "smithy.api#documentation": "

Any security groups for the network interface.

", + "smithy.api#xmlName": "groupSet" + } + }, + "InterfaceType": { + "target": "com.amazonaws.ec2#NetworkInterfaceType", + "traits": { + "aws.protocols#ec2QueryName": "InterfaceType", + "smithy.api#documentation": "

The type of network interface.

", + "smithy.api#xmlName": "interfaceType" + } + }, + "Ipv6Addresses": { + "target": "com.amazonaws.ec2#NetworkInterfaceIpv6AddressesList", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6AddressesSet", + "smithy.api#documentation": "

The IPv6 addresses associated with the network interface.

", + "smithy.api#xmlName": "ipv6AddressesSet" + } + }, + "MacAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "MacAddress", + "smithy.api#documentation": "

The MAC address.

", + "smithy.api#xmlName": "macAddress" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "OutpostArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OutpostArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost.

", + "smithy.api#xmlName": "outpostArn" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The Amazon Web Services account ID of the owner of the network interface.

", + "smithy.api#xmlName": "ownerId" + } + }, + "PrivateDnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateDnsName", + "smithy.api#documentation": "

The private DNS name.

", + "smithy.api#xmlName": "privateDnsName" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddress", + "smithy.api#documentation": "

The IPv4 address of the network interface within the subnet.

", + "smithy.api#xmlName": "privateIpAddress" + } + }, + "PrivateIpAddresses": { + "target": "com.amazonaws.ec2#NetworkInterfacePrivateIpAddressList", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddressesSet", + "smithy.api#documentation": "

The private IPv4 addresses associated with the network interface.

", + "smithy.api#xmlName": "privateIpAddressesSet" + } + }, + "Ipv4Prefixes": { + "target": "com.amazonaws.ec2#Ipv4PrefixesList", + "traits": { + "aws.protocols#ec2QueryName": "Ipv4PrefixSet", + "smithy.api#documentation": "

The IPv4 prefixes that are assigned to the network interface.

", + "smithy.api#xmlName": "ipv4PrefixSet" + } + }, + "Ipv6Prefixes": { + "target": "com.amazonaws.ec2#Ipv6PrefixesList", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6PrefixSet", + "smithy.api#documentation": "

The IPv6 prefixes that are assigned to the network interface.

", + "smithy.api#xmlName": "ipv6PrefixSet" + } + }, + "RequesterId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RequesterId", + "smithy.api#documentation": "

The alias or Amazon Web Services account ID of the principal or service that created the network interface.

", + "smithy.api#xmlName": "requesterId" + } + }, + "RequesterManaged": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "RequesterManaged", + "smithy.api#documentation": "

Indicates whether the network interface is being managed by Amazon Web Services.

", + "smithy.api#xmlName": "requesterManaged" + } + }, + "SourceDestCheck": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "SourceDestCheck", + "smithy.api#documentation": "

Indicates whether source/destination checking is enabled.

", + "smithy.api#xmlName": "sourceDestCheck" + } + }, + "Status": { + "target": "com.amazonaws.ec2#NetworkInterfaceStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The status of the network interface.

", + "smithy.api#xmlName": "status" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet.

", + "smithy.api#xmlName": "subnetId" + } + }, + "TagSet": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the network interface.

", + "smithy.api#xmlName": "tagSet" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "vpcId" + } + }, + "DenyAllIgwTraffic": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DenyAllIgwTraffic", + "smithy.api#documentation": "

Indicates whether a network interface with an IPv6 address is unreachable from the \n public internet. If the value is true, inbound traffic from the internet \n is dropped and you cannot assign an elastic IP address to the network interface. The \n network interface is reachable from peered VPCs and resources connected through a \n transit gateway, including on-premises networks.

", + "smithy.api#xmlName": "denyAllIgwTraffic" + } + }, + "Ipv6Native": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6Native", + "smithy.api#documentation": "

Indicates whether this is an IPv6 only network interface.

", + "smithy.api#xmlName": "ipv6Native" + } + }, + "Ipv6Address": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6Address", + "smithy.api#documentation": "

The IPv6 globally unique address associated with the network interface.

", + "smithy.api#xmlName": "ipv6Address" + } + }, + "Operator": { + "target": "com.amazonaws.ec2#OperatorResponse", + "traits": { + "aws.protocols#ec2QueryName": "Operator", + "smithy.api#documentation": "

The service provider that manages the network interface.

", + "smithy.api#xmlName": "operator" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a network interface.

" + } + }, + "com.amazonaws.ec2#NetworkInterfaceAssociation": { + "type": "structure", + "members": { + "AllocationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AllocationId", + "smithy.api#documentation": "

The allocation ID.

", + "smithy.api#xmlName": "allocationId" + } + }, + "AssociationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AssociationId", + "smithy.api#documentation": "

The association ID.

", + "smithy.api#xmlName": "associationId" + } + }, + "IpOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IpOwnerId", + "smithy.api#documentation": "

The ID of the Elastic IP address owner.

", + "smithy.api#xmlName": "ipOwnerId" + } + }, + "PublicDnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicDnsName", + "smithy.api#documentation": "

The public DNS name.

", + "smithy.api#xmlName": "publicDnsName" + } + }, + "PublicIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicIp", + "smithy.api#documentation": "

The address of the Elastic IP address bound to the network\n interface.

", + "smithy.api#xmlName": "publicIp" + } + }, + "CustomerOwnedIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CustomerOwnedIp", + "smithy.api#documentation": "

The customer-owned IP address associated with the network interface.

", + "smithy.api#xmlName": "customerOwnedIp" + } + }, + "CarrierIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CarrierIp", + "smithy.api#documentation": "

The carrier IP address associated with the network interface.

\n

This option is only available when the network interface is in a subnet which is associated with a Wavelength Zone.

", + "smithy.api#xmlName": "carrierIp" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes association information for an Elastic IP address (IPv4 only), or a Carrier\n IP address (for a network interface which resides in a subnet in a Wavelength\n Zone).

" + } + }, + "com.amazonaws.ec2#NetworkInterfaceAttachment": { + "type": "structure", + "members": { + "AttachTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "AttachTime", + "smithy.api#documentation": "

The timestamp indicating when the attachment initiated.

", + "smithy.api#xmlName": "attachTime" + } + }, + "AttachmentId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AttachmentId", + "smithy.api#documentation": "

The ID of the network interface attachment.

", + "smithy.api#xmlName": "attachmentId" + } + }, + "DeleteOnTermination": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DeleteOnTermination", + "smithy.api#documentation": "

Indicates whether the network interface is deleted when the instance is terminated.

", + "smithy.api#xmlName": "deleteOnTermination" + } + }, + "DeviceIndex": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "DeviceIndex", + "smithy.api#documentation": "

The device index of the network interface attachment on the instance.

", + "smithy.api#xmlName": "deviceIndex" + } + }, + "NetworkCardIndex": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "NetworkCardIndex", + "smithy.api#documentation": "

The index of the network card.

", + "smithy.api#xmlName": "networkCardIndex" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#xmlName": "instanceId" + } + }, + "InstanceOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceOwnerId", + "smithy.api#documentation": "

The Amazon Web Services account ID of the owner of the instance.

", + "smithy.api#xmlName": "instanceOwnerId" + } + }, + "Status": { + "target": "com.amazonaws.ec2#AttachmentStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The attachment state.

", + "smithy.api#xmlName": "status" + } + }, + "EnaSrdSpecification": { + "target": "com.amazonaws.ec2#AttachmentEnaSrdSpecification", + "traits": { + "aws.protocols#ec2QueryName": "EnaSrdSpecification", + "smithy.api#documentation": "

Configures ENA Express for the network interface that this action attaches to the instance.

", + "smithy.api#xmlName": "enaSrdSpecification" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a network interface attachment.

" + } + }, + "com.amazonaws.ec2#NetworkInterfaceAttachmentChanges": { + "type": "structure", + "members": { + "AttachmentId": { + "target": "com.amazonaws.ec2#NetworkInterfaceAttachmentId", + "traits": { + "aws.protocols#ec2QueryName": "AttachmentId", + "smithy.api#documentation": "

The ID of the network interface attachment.

", + "smithy.api#xmlName": "attachmentId" + } + }, + "DeleteOnTermination": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DeleteOnTermination", + "smithy.api#documentation": "

Indicates whether the network interface is deleted when the instance is terminated.

", + "smithy.api#xmlName": "deleteOnTermination" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an attachment change.

" + } + }, + "com.amazonaws.ec2#NetworkInterfaceAttachmentId": { + "type": "string" + }, + "com.amazonaws.ec2#NetworkInterfaceAttribute": { + "type": "enum", + "members": { + "description": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "description" + } + }, + "groupSet": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "groupSet" + } + }, + "sourceDestCheck": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sourceDestCheck" + } + }, + "attachment": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "attachment" + } + }, + "associatePublicIpAddress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associatePublicIpAddress" + } + } + } + }, + "com.amazonaws.ec2#NetworkInterfaceCount": { + "type": "structure", + "members": { + "Min": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Min", + "smithy.api#documentation": "

The minimum number of network interfaces. If this parameter is not specified, there is no\n minimum limit.

", + "smithy.api#xmlName": "min" + } + }, + "Max": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Max", + "smithy.api#documentation": "

The maximum number of network interfaces. If this parameter is not specified, there is no\n maximum limit.

", + "smithy.api#xmlName": "max" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum and maximum number of network interfaces.

" + } + }, + "com.amazonaws.ec2#NetworkInterfaceCountRequest": { + "type": "structure", + "members": { + "Min": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The minimum number of network interfaces. To specify no minimum limit, omit this\n parameter.

" + } + }, + "Max": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of network interfaces. To specify no maximum limit, omit this\n parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum and maximum number of network interfaces.

" + } + }, + "com.amazonaws.ec2#NetworkInterfaceCreationType": { + "type": "enum", + "members": { + "efa": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "efa" + } + }, + "efa_only": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "efa-only" + } + }, + "branch": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "branch" + } + }, + "trunk": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "trunk" + } + } + } + }, + "com.amazonaws.ec2#NetworkInterfaceId": { + "type": "string" + }, + "com.amazonaws.ec2#NetworkInterfaceIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NetworkInterfaceIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NetworkInterfaceIpv6Address": { + "type": "structure", + "members": { + "Ipv6Address": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6Address", + "smithy.api#documentation": "

The IPv6 address.

", + "smithy.api#xmlName": "ipv6Address" + } + }, + "IsPrimaryIpv6": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "IsPrimaryIpv6", + "smithy.api#documentation": "

Determines if an IPv6 address associated with a network interface is the primary IPv6 address. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. \n For more information, see ModifyNetworkInterfaceAttribute.

", + "smithy.api#xmlName": "isPrimaryIpv6" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an IPv6 address associated with a network interface.

" + } + }, + "com.amazonaws.ec2#NetworkInterfaceIpv6AddressesList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NetworkInterfaceIpv6Address", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NetworkInterfaceList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NetworkInterface", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NetworkInterfacePermission": { + "type": "structure", + "members": { + "NetworkInterfacePermissionId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfacePermissionId", + "smithy.api#documentation": "

The ID of the network interface permission.

", + "smithy.api#xmlName": "networkInterfacePermissionId" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "AwsAccountId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AwsAccountId", + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#xmlName": "awsAccountId" + } + }, + "AwsService": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AwsService", + "smithy.api#documentation": "

The Amazon Web Services service.

", + "smithy.api#xmlName": "awsService" + } + }, + "Permission": { + "target": "com.amazonaws.ec2#InterfacePermissionType", + "traits": { + "aws.protocols#ec2QueryName": "Permission", + "smithy.api#documentation": "

The type of permission.

", + "smithy.api#xmlName": "permission" + } + }, + "PermissionState": { + "target": "com.amazonaws.ec2#NetworkInterfacePermissionState", + "traits": { + "aws.protocols#ec2QueryName": "PermissionState", + "smithy.api#documentation": "

Information about the state of the permission.

", + "smithy.api#xmlName": "permissionState" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a permission for a network interface.

" + } + }, + "com.amazonaws.ec2#NetworkInterfacePermissionId": { + "type": "string" + }, + "com.amazonaws.ec2#NetworkInterfacePermissionIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NetworkInterfacePermissionId" + } + }, + "com.amazonaws.ec2#NetworkInterfacePermissionList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NetworkInterfacePermission", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NetworkInterfacePermissionState": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.ec2#NetworkInterfacePermissionStateCode", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the permission.

", + "smithy.api#xmlName": "state" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

A status message, if applicable.

", + "smithy.api#xmlName": "statusMessage" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the state of a network interface permission.

" + } + }, + "com.amazonaws.ec2#NetworkInterfacePermissionStateCode": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "granted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "granted" + } + }, + "revoking": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "revoking" + } + }, + "revoked": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "revoked" + } + } + } + }, + "com.amazonaws.ec2#NetworkInterfacePrivateIpAddress": { + "type": "structure", + "members": { + "Association": { + "target": "com.amazonaws.ec2#NetworkInterfaceAssociation", + "traits": { + "aws.protocols#ec2QueryName": "Association", + "smithy.api#documentation": "

The association information for an Elastic IP address (IPv4) associated with the network interface.

", + "smithy.api#xmlName": "association" + } + }, + "Primary": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Primary", + "smithy.api#documentation": "

Indicates whether this IPv4 address is the primary private IPv4 address of the network interface.

", + "smithy.api#xmlName": "primary" + } + }, + "PrivateDnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateDnsName", + "smithy.api#documentation": "

The private DNS name.

", + "smithy.api#xmlName": "privateDnsName" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddress", + "smithy.api#documentation": "

The private IPv4 address.

", + "smithy.api#xmlName": "privateIpAddress" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the private IPv4 address of a network interface.

" + } + }, + "com.amazonaws.ec2#NetworkInterfacePrivateIpAddressList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NetworkInterfacePrivateIpAddress", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NetworkInterfaceStatus": { + "type": "enum", + "members": { + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "associated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associated" + } + }, + "attaching": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "attaching" + } + }, + "in_use": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "in-use" + } + }, + "detaching": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "detaching" + } + } + } + }, + "com.amazonaws.ec2#NetworkInterfaceType": { + "type": "enum", + "members": { + "interface": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "interface" + } + }, + "natGateway": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "natGateway" + } + }, + "efa": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "efa" + } + }, + "efa_only": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "efa-only" + } + }, + "trunk": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "trunk" + } + }, + "load_balancer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "load_balancer" + } + }, + "network_load_balancer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "network_load_balancer" + } + }, + "vpc_endpoint": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vpc_endpoint" + } + }, + "branch": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "branch" + } + }, + "transit_gateway": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "transit_gateway" + } + }, + "lambda": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "lambda" + } + }, + "quicksight": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "quicksight" + } + }, + "global_accelerator_managed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "global_accelerator_managed" + } + }, + "api_gateway_managed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "api_gateway_managed" + } + }, + "gateway_load_balancer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "gateway_load_balancer" + } + }, + "gateway_load_balancer_endpoint": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "gateway_load_balancer_endpoint" + } + }, + "iot_rules_managed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "iot_rules_managed" + } + }, + "aws_codestar_connections_managed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "aws_codestar_connections_managed" + } + } + } + }, + "com.amazonaws.ec2#NetworkNodesList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NetworkPerformance": { + "type": "string" + }, + "com.amazonaws.ec2#NeuronDeviceCoreCount": { + "type": "integer" + }, + "com.amazonaws.ec2#NeuronDeviceCoreInfo": { + "type": "structure", + "members": { + "Count": { + "target": "com.amazonaws.ec2#NeuronDeviceCoreCount", + "traits": { + "aws.protocols#ec2QueryName": "Count", + "smithy.api#documentation": "

The number of cores available to the neuron accelerator.

", + "smithy.api#xmlName": "count" + } + }, + "Version": { + "target": "com.amazonaws.ec2#NeuronDeviceCoreVersion", + "traits": { + "aws.protocols#ec2QueryName": "Version", + "smithy.api#documentation": "

The version of the neuron accelerator.

", + "smithy.api#xmlName": "version" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the cores available to the neuron accelerator.

" + } + }, + "com.amazonaws.ec2#NeuronDeviceCoreVersion": { + "type": "integer" + }, + "com.amazonaws.ec2#NeuronDeviceCount": { + "type": "integer" + }, + "com.amazonaws.ec2#NeuronDeviceInfo": { + "type": "structure", + "members": { + "Count": { + "target": "com.amazonaws.ec2#NeuronDeviceCount", + "traits": { + "aws.protocols#ec2QueryName": "Count", + "smithy.api#documentation": "

The number of neuron accelerators for the instance type.

", + "smithy.api#xmlName": "count" + } + }, + "Name": { + "target": "com.amazonaws.ec2#NeuronDeviceName", + "traits": { + "aws.protocols#ec2QueryName": "Name", + "smithy.api#documentation": "

The name of the neuron accelerator.

", + "smithy.api#xmlName": "name" + } + }, + "CoreInfo": { + "target": "com.amazonaws.ec2#NeuronDeviceCoreInfo", + "traits": { + "aws.protocols#ec2QueryName": "CoreInfo", + "smithy.api#documentation": "

Describes the cores available to each neuron accelerator.

", + "smithy.api#xmlName": "coreInfo" + } + }, + "MemoryInfo": { + "target": "com.amazonaws.ec2#NeuronDeviceMemoryInfo", + "traits": { + "aws.protocols#ec2QueryName": "MemoryInfo", + "smithy.api#documentation": "

Describes the memory available to each neuron accelerator.

", + "smithy.api#xmlName": "memoryInfo" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the neuron accelerators for the instance type.

" + } + }, + "com.amazonaws.ec2#NeuronDeviceInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NeuronDeviceInfo", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NeuronDeviceMemoryInfo": { + "type": "structure", + "members": { + "SizeInMiB": { + "target": "com.amazonaws.ec2#NeuronDeviceMemorySize", + "traits": { + "aws.protocols#ec2QueryName": "SizeInMiB", + "smithy.api#documentation": "

The size of the memory available to the neuron accelerator, in MiB.

", + "smithy.api#xmlName": "sizeInMiB" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the memory available to the neuron accelerator.

" + } + }, + "com.amazonaws.ec2#NeuronDeviceMemorySize": { + "type": "integer" + }, + "com.amazonaws.ec2#NeuronDeviceName": { + "type": "string" + }, + "com.amazonaws.ec2#NeuronInfo": { + "type": "structure", + "members": { + "NeuronDevices": { + "target": "com.amazonaws.ec2#NeuronDeviceInfoList", + "traits": { + "aws.protocols#ec2QueryName": "NeuronDevices", + "smithy.api#documentation": "

Describes the neuron accelerators for the instance type.

", + "smithy.api#xmlName": "neuronDevices" + } + }, + "TotalNeuronDeviceMemoryInMiB": { + "target": "com.amazonaws.ec2#TotalNeuronMemory", + "traits": { + "aws.protocols#ec2QueryName": "TotalNeuronDeviceMemoryInMiB", + "smithy.api#documentation": "

The total size of the memory for the neuron accelerators for the instance type, in\n MiB.

", + "smithy.api#xmlName": "totalNeuronDeviceMemoryInMiB" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the neuron accelerators for the instance type.

" + } + }, + "com.amazonaws.ec2#NewDhcpConfiguration": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Key", + "smithy.api#documentation": "

The name of a DHCP option.

", + "smithy.api#xmlName": "key" + } + }, + "Values": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The values for the DHCP option.

", + "smithy.api#xmlName": "Value" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a DHCP configuration option.

" + } + }, + "com.amazonaws.ec2#NewDhcpConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NewDhcpConfiguration", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NextToken": { + "type": "string" + }, + "com.amazonaws.ec2#NitroEnclavesSupport": { + "type": "enum", + "members": { + "UNSUPPORTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unsupported" + } + }, + "SUPPORTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "supported" + } + } + } + }, + "com.amazonaws.ec2#NitroTpmInfo": { + "type": "structure", + "members": { + "SupportedVersions": { + "target": "com.amazonaws.ec2#NitroTpmSupportedVersionsList", + "traits": { + "aws.protocols#ec2QueryName": "SupportedVersions", + "smithy.api#documentation": "

Indicates the supported NitroTPM versions.

", + "smithy.api#xmlName": "supportedVersions" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the supported NitroTPM versions for the instance type.

" + } + }, + "com.amazonaws.ec2#NitroTpmSupport": { + "type": "enum", + "members": { + "UNSUPPORTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unsupported" + } + }, + "SUPPORTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "supported" + } + } + } + }, + "com.amazonaws.ec2#NitroTpmSupportedVersionType": { + "type": "string" + }, + "com.amazonaws.ec2#NitroTpmSupportedVersionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NitroTpmSupportedVersionType", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#OccurrenceDayRequestSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#xmlName": "OccurenceDay" + } + } + }, + "com.amazonaws.ec2#OccurrenceDaySet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#OfferingClassType": { + "type": "enum", + "members": { + "STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "standard" + } + }, + "CONVERTIBLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "convertible" + } + } + } + }, + "com.amazonaws.ec2#OfferingId": { + "type": "string" + }, + "com.amazonaws.ec2#OfferingTypeValues": { + "type": "enum", + "members": { + "Heavy_Utilization": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Heavy Utilization" + } + }, + "Medium_Utilization": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Medium Utilization" + } + }, + "Light_Utilization": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Light Utilization" + } + }, + "No_Upfront": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "No Upfront" + } + }, + "Partial_Upfront": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Partial Upfront" + } + }, + "All_Upfront": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "All Upfront" + } + } + } + }, + "com.amazonaws.ec2#OidcOptions": { + "type": "structure", + "members": { + "Issuer": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Issuer", + "smithy.api#documentation": "

The OIDC issuer.

", + "smithy.api#xmlName": "issuer" + } + }, + "AuthorizationEndpoint": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AuthorizationEndpoint", + "smithy.api#documentation": "

The OIDC authorization endpoint.

", + "smithy.api#xmlName": "authorizationEndpoint" + } + }, + "TokenEndpoint": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TokenEndpoint", + "smithy.api#documentation": "

The OIDC token endpoint.

", + "smithy.api#xmlName": "tokenEndpoint" + } + }, + "UserInfoEndpoint": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "UserInfoEndpoint", + "smithy.api#documentation": "

The OIDC user info endpoint.

", + "smithy.api#xmlName": "userInfoEndpoint" + } + }, + "ClientId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientId", + "smithy.api#documentation": "

The client identifier.

", + "smithy.api#xmlName": "clientId" + } + }, + "ClientSecret": { + "target": "com.amazonaws.ec2#ClientSecretType", + "traits": { + "aws.protocols#ec2QueryName": "ClientSecret", + "smithy.api#documentation": "

The client secret.

", + "smithy.api#xmlName": "clientSecret" + } + }, + "Scope": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Scope", + "smithy.api#documentation": "

The OpenID Connect (OIDC) scope specified.

", + "smithy.api#xmlName": "scope" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the options for an OpenID Connect-compatible user-identity trust\n provider.

" + } + }, + "com.amazonaws.ec2#OnDemandAllocationStrategy": { + "type": "enum", + "members": { + "LOWEST_PRICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "lowestPrice" + } + }, + "PRIORITIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "prioritized" + } + } + } + }, + "com.amazonaws.ec2#OnDemandOptions": { + "type": "structure", + "members": { + "AllocationStrategy": { + "target": "com.amazonaws.ec2#FleetOnDemandAllocationStrategy", + "traits": { + "aws.protocols#ec2QueryName": "AllocationStrategy", + "smithy.api#documentation": "

The strategy that determines the order of the launch template overrides to use in\n fulfilling On-Demand capacity.

\n

\n lowest-price - EC2 Fleet uses price to determine the order, launching the lowest\n price first.

\n

\n prioritized - EC2 Fleet uses the priority that you assigned to each launch\n template override, launching the highest priority first.

\n

Default: lowest-price\n

", + "smithy.api#xmlName": "allocationStrategy" + } + }, + "CapacityReservationOptions": { + "target": "com.amazonaws.ec2#CapacityReservationOptions", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationOptions", + "smithy.api#documentation": "

The strategy for using unused Capacity Reservations for fulfilling On-Demand\n capacity.

\n

Supported only for fleets of type instant.

", + "smithy.api#xmlName": "capacityReservationOptions" + } + }, + "SingleInstanceType": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "SingleInstanceType", + "smithy.api#documentation": "

Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the\n fleet.

\n

Supported only for fleets of type instant.

", + "smithy.api#xmlName": "singleInstanceType" + } + }, + "SingleAvailabilityZone": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "SingleAvailabilityZone", + "smithy.api#documentation": "

Indicates that the fleet launches all On-Demand Instances into a single Availability Zone.

\n

Supported only for fleets of type instant.

", + "smithy.api#xmlName": "singleAvailabilityZone" + } + }, + "MinTargetCapacity": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "MinTargetCapacity", + "smithy.api#documentation": "

The minimum target capacity for On-Demand Instances in the fleet. If this minimum capacity isn't\n reached, no instances are launched.

\n

Constraints: Maximum value of 1000. Supported only for fleets of type\n instant.

\n

At least one of the following must be specified: SingleAvailabilityZone |\n SingleInstanceType\n

", + "smithy.api#xmlName": "minTargetCapacity" + } + }, + "MaxTotalPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "MaxTotalPrice", + "smithy.api#documentation": "

The maximum amount per hour for On-Demand Instances that you're willing to pay.

\n \n

If your fleet includes T instances that are configured as unlimited, and\n if their average CPU usage exceeds the baseline utilization, you will incur a charge for\n surplus credits. The maxTotalPrice does not account for surplus credits,\n and, if you use surplus credits, your final cost might be higher than what you specified\n for maxTotalPrice. For more information, see Surplus credits can incur charges in the\n Amazon EC2 User Guide.

\n ", + "smithy.api#xmlName": "maxTotalPrice" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the configuration of On-Demand Instances in an EC2 Fleet.

" + } + }, + "com.amazonaws.ec2#OnDemandOptionsRequest": { + "type": "structure", + "members": { + "AllocationStrategy": { + "target": "com.amazonaws.ec2#FleetOnDemandAllocationStrategy", + "traits": { + "smithy.api#documentation": "

The strategy that determines the order of the launch template overrides to use in\n fulfilling On-Demand capacity.

\n

\n lowest-price - EC2 Fleet uses price to determine the order, launching the lowest\n price first.

\n

\n prioritized - EC2 Fleet uses the priority that you assigned to each launch\n template override, launching the highest priority first.

\n

Default: lowest-price\n

" + } + }, + "CapacityReservationOptions": { + "target": "com.amazonaws.ec2#CapacityReservationOptionsRequest", + "traits": { + "smithy.api#documentation": "

The strategy for using unused Capacity Reservations for fulfilling On-Demand\n capacity.

\n

Supported only for fleets of type instant.

" + } + }, + "SingleInstanceType": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the\n fleet.

\n

Supported only for fleets of type instant.

" + } + }, + "SingleAvailabilityZone": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates that the fleet launches all On-Demand Instances into a single Availability Zone.

\n

Supported only for fleets of type instant.

" + } + }, + "MinTargetCapacity": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The minimum target capacity for On-Demand Instances in the fleet. If this minimum capacity isn't\n reached, no instances are launched.

\n

Constraints: Maximum value of 1000. Supported only for fleets of type\n instant.

\n

At least one of the following must be specified: SingleAvailabilityZone |\n SingleInstanceType\n

" + } + }, + "MaxTotalPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The maximum amount per hour for On-Demand Instances that you're willing to pay.

\n \n

If your fleet includes T instances that are configured as unlimited,\n and if their average CPU usage exceeds the baseline utilization, you will incur a charge\n for surplus credits. The MaxTotalPrice does not account for surplus\n credits, and, if you use surplus credits, your final cost might be higher than what you\n specified for MaxTotalPrice. For more information, see Surplus credits can incur charges in the Amazon EC2 User Guide.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the configuration of On-Demand Instances in an EC2 Fleet.

" + } + }, + "com.amazonaws.ec2#OperationType": { + "type": "enum", + "members": { + "add": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "add" + } + }, + "remove": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "remove" + } + } + } + }, + "com.amazonaws.ec2#OperatorRequest": { + "type": "structure", + "members": { + "Principal": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The service provider that manages the resource.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The service provider that manages the resource.

" + } + }, + "com.amazonaws.ec2#OperatorResponse": { + "type": "structure", + "members": { + "Managed": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Managed", + "smithy.api#documentation": "

If true, the resource is managed by an service provider.

", + "smithy.api#xmlName": "managed" + } + }, + "Principal": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Principal", + "smithy.api#documentation": "

If managed is true, then the principal is returned. The\n principal is the service provider that manages the resource.

", + "smithy.api#xmlName": "principal" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes whether the resource is managed by an service provider and, if so, describes\n the service provider that manages it.

" + } + }, + "com.amazonaws.ec2#OrganizationArnStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "OrganizationArn" + } + } + }, + "com.amazonaws.ec2#OrganizationalUnitArnStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "OrganizationalUnitArn" + } + } + }, + "com.amazonaws.ec2#OutpostArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws([a-z-]+)?:outposts:[a-z\\d-]+:\\d{12}:outpost/op-[a-f0-9]{17}$" + } + }, + "com.amazonaws.ec2#OwnerStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "Owner" + } + } + }, + "com.amazonaws.ec2#PacketHeaderStatement": { + "type": "structure", + "members": { + "SourceAddresses": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "SourceAddressSet", + "smithy.api#documentation": "

The source addresses.

", + "smithy.api#xmlName": "sourceAddressSet" + } + }, + "DestinationAddresses": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "DestinationAddressSet", + "smithy.api#documentation": "

The destination addresses.

", + "smithy.api#xmlName": "destinationAddressSet" + } + }, + "SourcePorts": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "SourcePortSet", + "smithy.api#documentation": "

The source ports.

", + "smithy.api#xmlName": "sourcePortSet" + } + }, + "DestinationPorts": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "DestinationPortSet", + "smithy.api#documentation": "

The destination ports.

", + "smithy.api#xmlName": "destinationPortSet" + } + }, + "SourcePrefixLists": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "SourcePrefixListSet", + "smithy.api#documentation": "

The source prefix lists.

", + "smithy.api#xmlName": "sourcePrefixListSet" + } + }, + "DestinationPrefixLists": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "DestinationPrefixListSet", + "smithy.api#documentation": "

The destination prefix lists.

", + "smithy.api#xmlName": "destinationPrefixListSet" + } + }, + "Protocols": { + "target": "com.amazonaws.ec2#ProtocolList", + "traits": { + "aws.protocols#ec2QueryName": "ProtocolSet", + "smithy.api#documentation": "

The protocols.

", + "smithy.api#xmlName": "protocolSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a packet header statement.

" + } + }, + "com.amazonaws.ec2#PacketHeaderStatementRequest": { + "type": "structure", + "members": { + "SourceAddresses": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The source addresses.

", + "smithy.api#xmlName": "SourceAddress" + } + }, + "DestinationAddresses": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The destination addresses.

", + "smithy.api#xmlName": "DestinationAddress" + } + }, + "SourcePorts": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The source ports.

", + "smithy.api#xmlName": "SourcePort" + } + }, + "DestinationPorts": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The destination ports.

", + "smithy.api#xmlName": "DestinationPort" + } + }, + "SourcePrefixLists": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The source prefix lists.

", + "smithy.api#xmlName": "SourcePrefixList" + } + }, + "DestinationPrefixLists": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The destination prefix lists.

", + "smithy.api#xmlName": "DestinationPrefixList" + } + }, + "Protocols": { + "target": "com.amazonaws.ec2#ProtocolList", + "traits": { + "smithy.api#documentation": "

The protocols.

", + "smithy.api#xmlName": "Protocol" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a packet header statement.

" + } + }, + "com.amazonaws.ec2#PartitionLoadFrequency": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "none" + } + }, + "DAILY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "daily" + } + }, + "WEEKLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "weekly" + } + }, + "MONTHLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "monthly" + } + } + } + }, + "com.amazonaws.ec2#PasswordData": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.ec2#PathComponent": { + "type": "structure", + "members": { + "SequenceNumber": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "SequenceNumber", + "smithy.api#documentation": "

The sequence number.

", + "smithy.api#xmlName": "sequenceNumber" + } + }, + "AclRule": { + "target": "com.amazonaws.ec2#AnalysisAclRule", + "traits": { + "aws.protocols#ec2QueryName": "AclRule", + "smithy.api#documentation": "

The network ACL rule.

", + "smithy.api#xmlName": "aclRule" + } + }, + "AttachedTo": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "AttachedTo", + "smithy.api#documentation": "

The resource to which the path component is attached.

", + "smithy.api#xmlName": "attachedTo" + } + }, + "Component": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "Component", + "smithy.api#documentation": "

The component.

", + "smithy.api#xmlName": "component" + } + }, + "DestinationVpc": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "DestinationVpc", + "smithy.api#documentation": "

The destination VPC.

", + "smithy.api#xmlName": "destinationVpc" + } + }, + "OutboundHeader": { + "target": "com.amazonaws.ec2#AnalysisPacketHeader", + "traits": { + "aws.protocols#ec2QueryName": "OutboundHeader", + "smithy.api#documentation": "

The outbound header.

", + "smithy.api#xmlName": "outboundHeader" + } + }, + "InboundHeader": { + "target": "com.amazonaws.ec2#AnalysisPacketHeader", + "traits": { + "aws.protocols#ec2QueryName": "InboundHeader", + "smithy.api#documentation": "

The inbound header.

", + "smithy.api#xmlName": "inboundHeader" + } + }, + "RouteTableRoute": { + "target": "com.amazonaws.ec2#AnalysisRouteTableRoute", + "traits": { + "aws.protocols#ec2QueryName": "RouteTableRoute", + "smithy.api#documentation": "

The route table route.

", + "smithy.api#xmlName": "routeTableRoute" + } + }, + "SecurityGroupRule": { + "target": "com.amazonaws.ec2#AnalysisSecurityGroupRule", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroupRule", + "smithy.api#documentation": "

The security group rule.

", + "smithy.api#xmlName": "securityGroupRule" + } + }, + "SourceVpc": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "SourceVpc", + "smithy.api#documentation": "

The source VPC.

", + "smithy.api#xmlName": "sourceVpc" + } + }, + "Subnet": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "Subnet", + "smithy.api#documentation": "

The subnet.

", + "smithy.api#xmlName": "subnet" + } + }, + "Vpc": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "Vpc", + "smithy.api#documentation": "

The component VPC.

", + "smithy.api#xmlName": "vpc" + } + }, + "AdditionalDetails": { + "target": "com.amazonaws.ec2#AdditionalDetailList", + "traits": { + "aws.protocols#ec2QueryName": "AdditionalDetailSet", + "smithy.api#documentation": "

The additional details.

", + "smithy.api#xmlName": "additionalDetailSet" + } + }, + "TransitGateway": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "TransitGateway", + "smithy.api#documentation": "

The transit gateway.

", + "smithy.api#xmlName": "transitGateway" + } + }, + "TransitGatewayRouteTableRoute": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableRoute", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTableRoute", + "smithy.api#documentation": "

The route in a transit gateway route table.

", + "smithy.api#xmlName": "transitGatewayRouteTableRoute" + } + }, + "Explanations": { + "target": "com.amazonaws.ec2#ExplanationList", + "traits": { + "aws.protocols#ec2QueryName": "ExplanationSet", + "smithy.api#documentation": "

The explanation codes.

", + "smithy.api#xmlName": "explanationSet" + } + }, + "ElasticLoadBalancerListener": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "ElasticLoadBalancerListener", + "smithy.api#documentation": "

The load balancer listener.

", + "smithy.api#xmlName": "elasticLoadBalancerListener" + } + }, + "FirewallStatelessRule": { + "target": "com.amazonaws.ec2#FirewallStatelessRule", + "traits": { + "aws.protocols#ec2QueryName": "FirewallStatelessRule", + "smithy.api#documentation": "

The Network Firewall stateless rule.

", + "smithy.api#xmlName": "firewallStatelessRule" + } + }, + "FirewallStatefulRule": { + "target": "com.amazonaws.ec2#FirewallStatefulRule", + "traits": { + "aws.protocols#ec2QueryName": "FirewallStatefulRule", + "smithy.api#documentation": "

The Network Firewall stateful rule.

", + "smithy.api#xmlName": "firewallStatefulRule" + } + }, + "ServiceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ServiceName", + "smithy.api#documentation": "

The name of the VPC endpoint service.

", + "smithy.api#xmlName": "serviceName" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a path component.

" + } + }, + "com.amazonaws.ec2#PathComponentList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#PathComponent", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#PathFilter": { + "type": "structure", + "members": { + "SourceAddress": { + "target": "com.amazonaws.ec2#IpAddress", + "traits": { + "aws.protocols#ec2QueryName": "SourceAddress", + "smithy.api#documentation": "

The source IPv4 address.

", + "smithy.api#xmlName": "sourceAddress" + } + }, + "SourcePortRange": { + "target": "com.amazonaws.ec2#FilterPortRange", + "traits": { + "aws.protocols#ec2QueryName": "SourcePortRange", + "smithy.api#documentation": "

The source port range.

", + "smithy.api#xmlName": "sourcePortRange" + } + }, + "DestinationAddress": { + "target": "com.amazonaws.ec2#IpAddress", + "traits": { + "aws.protocols#ec2QueryName": "DestinationAddress", + "smithy.api#documentation": "

The destination IPv4 address.

", + "smithy.api#xmlName": "destinationAddress" + } + }, + "DestinationPortRange": { + "target": "com.amazonaws.ec2#FilterPortRange", + "traits": { + "aws.protocols#ec2QueryName": "DestinationPortRange", + "smithy.api#documentation": "

The destination port range.

", + "smithy.api#xmlName": "destinationPortRange" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a set of filters for a path analysis. Use path filters to scope the analysis when\n there can be multiple resulting paths.

" + } + }, + "com.amazonaws.ec2#PathRequestFilter": { + "type": "structure", + "members": { + "SourceAddress": { + "target": "com.amazonaws.ec2#IpAddress", + "traits": { + "smithy.api#documentation": "

The source IPv4 address.

" + } + }, + "SourcePortRange": { + "target": "com.amazonaws.ec2#RequestFilterPortRange", + "traits": { + "smithy.api#documentation": "

The source port range.

" + } + }, + "DestinationAddress": { + "target": "com.amazonaws.ec2#IpAddress", + "traits": { + "smithy.api#documentation": "

The destination IPv4 address.

" + } + }, + "DestinationPortRange": { + "target": "com.amazonaws.ec2#RequestFilterPortRange", + "traits": { + "smithy.api#documentation": "

The destination port range.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a set of filters for a path analysis. Use path filters to scope the analysis when\n there can be multiple resulting paths.

" + } + }, + "com.amazonaws.ec2#PathStatement": { + "type": "structure", + "members": { + "PacketHeaderStatement": { + "target": "com.amazonaws.ec2#PacketHeaderStatement", + "traits": { + "aws.protocols#ec2QueryName": "PacketHeaderStatement", + "smithy.api#documentation": "

The packet header statement.

", + "smithy.api#xmlName": "packetHeaderStatement" + } + }, + "ResourceStatement": { + "target": "com.amazonaws.ec2#ResourceStatement", + "traits": { + "aws.protocols#ec2QueryName": "ResourceStatement", + "smithy.api#documentation": "

The resource statement.

", + "smithy.api#xmlName": "resourceStatement" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a path statement.

" + } + }, + "com.amazonaws.ec2#PathStatementRequest": { + "type": "structure", + "members": { + "PacketHeaderStatement": { + "target": "com.amazonaws.ec2#PacketHeaderStatementRequest", + "traits": { + "smithy.api#documentation": "

The packet header statement.

" + } + }, + "ResourceStatement": { + "target": "com.amazonaws.ec2#ResourceStatementRequest", + "traits": { + "smithy.api#documentation": "

The resource statement.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a path statement.

" + } + }, + "com.amazonaws.ec2#PayerResponsibility": { + "type": "enum", + "members": { + "ServiceOwner": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ServiceOwner" + } + } + } + }, + "com.amazonaws.ec2#PaymentOption": { + "type": "enum", + "members": { + "ALL_UPFRONT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AllUpfront" + } + }, + "PARTIAL_UPFRONT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PartialUpfront" + } + }, + "NO_UPFRONT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NoUpfront" + } + } + } + }, + "com.amazonaws.ec2#PciId": { + "type": "structure", + "members": { + "DeviceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ID of the device.

" + } + }, + "VendorId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ID of the vendor.

" + } + }, + "SubsystemId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ID of the subsystem.

" + } + }, + "SubsystemVendorId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ID of the vendor for the subsystem.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the data that identifies an Amazon FPGA image (AFI) on the PCI bus.

" + } + }, + "com.amazonaws.ec2#PeakBandwidthInGbps": { + "type": "double" + }, + "com.amazonaws.ec2#PeeringAttachmentStatus": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The status code.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

The status message, if applicable.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

The status of the transit gateway peering attachment.

" + } + }, + "com.amazonaws.ec2#PeeringConnectionOptions": { + "type": "structure", + "members": { + "AllowDnsResolutionFromRemoteVpc": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "AllowDnsResolutionFromRemoteVpc", + "smithy.api#documentation": "

If true, the public DNS hostnames of instances in the specified VPC resolve to private\n IP addresses when queried from instances in the peer VPC.

", + "smithy.api#xmlName": "allowDnsResolutionFromRemoteVpc" + } + }, + "AllowEgressFromLocalClassicLinkToRemoteVpc": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "AllowEgressFromLocalClassicLinkToRemoteVpc", + "smithy.api#documentation": "

Deprecated.

", + "smithy.api#xmlName": "allowEgressFromLocalClassicLinkToRemoteVpc" + } + }, + "AllowEgressFromLocalVpcToRemoteClassicLink": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "AllowEgressFromLocalVpcToRemoteClassicLink", + "smithy.api#documentation": "

Deprecated.

", + "smithy.api#xmlName": "allowEgressFromLocalVpcToRemoteClassicLink" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the VPC peering connection options.

" + } + }, + "com.amazonaws.ec2#PeeringConnectionOptionsRequest": { + "type": "structure", + "members": { + "AllowDnsResolutionFromRemoteVpc": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

If true, enables a local VPC to resolve public DNS hostnames to private IP addresses \n when queried from instances in the peer VPC.

" + } + }, + "AllowEgressFromLocalClassicLinkToRemoteVpc": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Deprecated.

" + } + }, + "AllowEgressFromLocalVpcToRemoteClassicLink": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Deprecated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The VPC peering connection options.

" + } + }, + "com.amazonaws.ec2#PeeringTgwInfo": { + "type": "structure", + "members": { + "TransitGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayId", + "smithy.api#documentation": "

The ID of the transit gateway.

", + "smithy.api#xmlName": "transitGatewayId" + } + }, + "CoreNetworkId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CoreNetworkId", + "smithy.api#documentation": "

The ID of the core network where the transit gateway peer is located.

", + "smithy.api#xmlName": "coreNetworkId" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the transit gateway.

", + "smithy.api#xmlName": "ownerId" + } + }, + "Region": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Region", + "smithy.api#documentation": "

The Region of the transit gateway.

", + "smithy.api#xmlName": "region" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the transit gateway in the peering attachment.

" + } + }, + "com.amazonaws.ec2#PerformanceFactorReference": { + "type": "structure", + "members": { + "InstanceFamily": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceFamily", + "smithy.api#documentation": "

The instance family to use as a baseline reference.

\n \n

Ensure that you specify the correct value for the instance family. The instance\n family is everything before the period (.) in the instance type name. For\n example, in the instance type c6i.large, the instance family is\n c6i, not c6. For more information, see Amazon EC2\n instance type naming conventions in Amazon EC2 Instance\n Types.

\n \n

The following instance families are not supported for performance\n protection:

\n \n

If you enable performance protection by specifying a supported instance family, the\n returned instance types will exclude the above unsupported instance families.

\n

If you specify an unsupported instance family as a value for baseline performance, the\n API returns an empty response for and an exception for , , , and .

", + "smithy.api#xmlName": "instanceFamily" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specify an instance family to use as the baseline reference for CPU performance. All\n instance types that match your specified attributes will be compared against the CPU\n performance of the referenced instance family, regardless of CPU manufacturer or\n architecture.

\n \n

Currently, only one instance family can be specified in the list.

\n " + } + }, + "com.amazonaws.ec2#PerformanceFactorReferenceRequest": { + "type": "structure", + "members": { + "InstanceFamily": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The instance family to use as a baseline reference.

\n \n

Ensure that you specify the correct value for the instance family. The instance\n family is everything before the period (.) in the instance type name. For\n example, in the instance type c6i.large, the instance family is\n c6i, not c6. For more information, see Amazon EC2\n instance type naming conventions in Amazon EC2 Instance\n Types.

\n \n

The following instance families are not supported for performance\n protection:

\n \n

If you enable performance protection by specifying a supported instance family, the\n returned instance types will exclude the above unsupported instance families.

\n

If you specify an unsupported instance family as a value for baseline performance, the\n API returns an empty response for and an exception for , , , and .

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specify an instance family to use as the baseline reference for CPU performance. All\n instance types that match your specified attributes will be compared against the CPU\n performance of the referenced instance family, regardless of CPU manufacturer or\n architecture.

\n \n

Currently, only one instance family can be specified in the list.

\n " + } + }, + "com.amazonaws.ec2#PerformanceFactorReferenceSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#PerformanceFactorReference", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#PerformanceFactorReferenceSetRequest": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#PerformanceFactorReferenceRequest", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#PeriodType": { + "type": "enum", + "members": { + "five_minutes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "five-minutes" + } + }, + "fifteen_minutes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fifteen-minutes" + } + }, + "one_hour": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "one-hour" + } + }, + "three_hours": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "three-hours" + } + }, + "one_day": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "one-day" + } + }, + "one_week": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "one-week" + } + } + } + }, + "com.amazonaws.ec2#PermissionGroup": { + "type": "enum", + "members": { + "all": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "all" + } + } + } + }, + "com.amazonaws.ec2#Phase1DHGroupNumbersList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Phase1DHGroupNumbersListValue", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Phase1DHGroupNumbersListValue": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Value", + "smithy.api#documentation": "

The Diffie-Hellmann group number.

", + "smithy.api#xmlName": "value" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Diffie-Hellmann group number for phase 1 IKE negotiations.

" + } + }, + "com.amazonaws.ec2#Phase1DHGroupNumbersRequestList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Phase1DHGroupNumbersRequestListValue", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Phase1DHGroupNumbersRequestListValue": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The Diffie-Hellmann group number.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies a Diffie-Hellman group number for the VPN tunnel for phase 1 IKE\n negotiations.

" + } + }, + "com.amazonaws.ec2#Phase1EncryptionAlgorithmsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Phase1EncryptionAlgorithmsListValue", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Phase1EncryptionAlgorithmsListValue": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Value", + "smithy.api#documentation": "

The value for the encryption algorithm.

", + "smithy.api#xmlName": "value" + } + } + }, + "traits": { + "smithy.api#documentation": "

The encryption algorithm for phase 1 IKE negotiations.

" + } + }, + "com.amazonaws.ec2#Phase1EncryptionAlgorithmsRequestList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Phase1EncryptionAlgorithmsRequestListValue", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Phase1EncryptionAlgorithmsRequestListValue": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The value for the encryption algorithm.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the encryption algorithm for the VPN tunnel for phase 1 IKE\n negotiations.

" + } + }, + "com.amazonaws.ec2#Phase1IntegrityAlgorithmsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Phase1IntegrityAlgorithmsListValue", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Phase1IntegrityAlgorithmsListValue": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Value", + "smithy.api#documentation": "

The value for the integrity algorithm.

", + "smithy.api#xmlName": "value" + } + } + }, + "traits": { + "smithy.api#documentation": "

The integrity algorithm for phase 1 IKE negotiations.

" + } + }, + "com.amazonaws.ec2#Phase1IntegrityAlgorithmsRequestList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Phase1IntegrityAlgorithmsRequestListValue", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Phase1IntegrityAlgorithmsRequestListValue": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The value for the integrity algorithm.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the integrity algorithm for the VPN tunnel for phase 1 IKE\n negotiations.

" + } + }, + "com.amazonaws.ec2#Phase2DHGroupNumbersList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Phase2DHGroupNumbersListValue", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Phase2DHGroupNumbersListValue": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Value", + "smithy.api#documentation": "

The Diffie-Hellmann group number.

", + "smithy.api#xmlName": "value" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Diffie-Hellmann group number for phase 2 IKE negotiations.

" + } + }, + "com.amazonaws.ec2#Phase2DHGroupNumbersRequestList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Phase2DHGroupNumbersRequestListValue", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Phase2DHGroupNumbersRequestListValue": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The Diffie-Hellmann group number.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies a Diffie-Hellman group number for the VPN tunnel for phase 2 IKE\n negotiations.

" + } + }, + "com.amazonaws.ec2#Phase2EncryptionAlgorithmsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Phase2EncryptionAlgorithmsListValue", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Phase2EncryptionAlgorithmsListValue": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Value", + "smithy.api#documentation": "

The encryption algorithm.

", + "smithy.api#xmlName": "value" + } + } + }, + "traits": { + "smithy.api#documentation": "

The encryption algorithm for phase 2 IKE negotiations.

" + } + }, + "com.amazonaws.ec2#Phase2EncryptionAlgorithmsRequestList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Phase2EncryptionAlgorithmsRequestListValue", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Phase2EncryptionAlgorithmsRequestListValue": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The encryption algorithm.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the encryption algorithm for the VPN tunnel for phase 2 IKE\n negotiations.

" + } + }, + "com.amazonaws.ec2#Phase2IntegrityAlgorithmsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Phase2IntegrityAlgorithmsListValue", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Phase2IntegrityAlgorithmsListValue": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Value", + "smithy.api#documentation": "

The integrity algorithm.

", + "smithy.api#xmlName": "value" + } + } + }, + "traits": { + "smithy.api#documentation": "

The integrity algorithm for phase 2 IKE negotiations.

" + } + }, + "com.amazonaws.ec2#Phase2IntegrityAlgorithmsRequestList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Phase2IntegrityAlgorithmsRequestListValue", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Phase2IntegrityAlgorithmsRequestListValue": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The integrity algorithm.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the integrity algorithm for the VPN tunnel for phase 2 IKE\n negotiations.

" + } + }, + "com.amazonaws.ec2#PhcSupport": { + "type": "enum", + "members": { + "UNSUPPORTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unsupported" + } + }, + "SUPPORTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "supported" + } + } + } + }, + "com.amazonaws.ec2#Placement": { + "type": "structure", + "members": { + "Affinity": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Affinity", + "smithy.api#documentation": "

The affinity setting for the instance on the Dedicated Host.

\n

This parameter is not supported for CreateFleet or ImportInstance.

", + "smithy.api#xmlName": "affinity" + } + }, + "GroupName": { + "target": "com.amazonaws.ec2#PlacementGroupName", + "traits": { + "aws.protocols#ec2QueryName": "GroupName", + "smithy.api#documentation": "

The name of the placement group that the instance is in. If you specify\n GroupName, you can't specify GroupId.

", + "smithy.api#xmlName": "groupName" + } + }, + "PartitionNumber": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "PartitionNumber", + "smithy.api#documentation": "

The number of the partition that the instance is in. Valid only if the placement group\n strategy is set to partition.

\n

This parameter is not supported for CreateFleet.

", + "smithy.api#xmlName": "partitionNumber" + } + }, + "HostId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "HostId", + "smithy.api#documentation": "

The ID of the Dedicated Host on which the instance resides.

\n

This parameter is not supported for CreateFleet or ImportInstance.

", + "smithy.api#xmlName": "hostId" + } + }, + "Tenancy": { + "target": "com.amazonaws.ec2#Tenancy", + "traits": { + "aws.protocols#ec2QueryName": "Tenancy", + "smithy.api#documentation": "

The tenancy of the instance. An instance with a\n tenancy of dedicated runs on single-tenant hardware.

\n

This parameter is not supported for CreateFleet. The\n host tenancy is not supported for ImportInstance or\n for T3 instances that are configured for the unlimited CPU credit\n option.

", + "smithy.api#xmlName": "tenancy" + } + }, + "SpreadDomain": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SpreadDomain", + "smithy.api#documentation": "

Reserved for future use.

", + "smithy.api#xmlName": "spreadDomain" + } + }, + "HostResourceGroupArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "HostResourceGroupArn", + "smithy.api#documentation": "

The ARN of the host resource group in which to launch the instances.

\n

If you specify this parameter, either omit the Tenancy parameter or set it to host.

\n

This parameter is not supported for CreateFleet.

", + "smithy.api#xmlName": "hostResourceGroupArn" + } + }, + "GroupId": { + "target": "com.amazonaws.ec2#PlacementGroupId", + "traits": { + "aws.protocols#ec2QueryName": "GroupId", + "smithy.api#documentation": "

The ID of the placement group that the instance is in. If you specify\n GroupId, you can't specify GroupName.

", + "smithy.api#xmlName": "groupId" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone of the instance.

\n

If not specified, an Availability Zone will be automatically chosen for you based on\n the load balancing criteria for the Region.

\n

This parameter is not supported for CreateFleet.

", + "smithy.api#xmlName": "availabilityZone" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the placement of an instance.

" + } + }, + "com.amazonaws.ec2#PlacementGroup": { + "type": "structure", + "members": { + "GroupName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupName", + "smithy.api#documentation": "

The name of the placement group.

", + "smithy.api#xmlName": "groupName" + } + }, + "State": { + "target": "com.amazonaws.ec2#PlacementGroupState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the placement group.

", + "smithy.api#xmlName": "state" + } + }, + "Strategy": { + "target": "com.amazonaws.ec2#PlacementStrategy", + "traits": { + "aws.protocols#ec2QueryName": "Strategy", + "smithy.api#documentation": "

The placement strategy.

", + "smithy.api#xmlName": "strategy" + } + }, + "PartitionCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "PartitionCount", + "smithy.api#documentation": "

The number of partitions. Valid only if strategy is\n set to partition.

", + "smithy.api#xmlName": "partitionCount" + } + }, + "GroupId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupId", + "smithy.api#documentation": "

The ID of the placement group.

", + "smithy.api#xmlName": "groupId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags applied to the placement group.

", + "smithy.api#xmlName": "tagSet" + } + }, + "GroupArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the placement group.

", + "smithy.api#xmlName": "groupArn" + } + }, + "SpreadLevel": { + "target": "com.amazonaws.ec2#SpreadLevel", + "traits": { + "aws.protocols#ec2QueryName": "SpreadLevel", + "smithy.api#documentation": "

The spread level for the placement group. Only Outpost placement\n groups can be spread across hosts.

", + "smithy.api#xmlName": "spreadLevel" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a placement group.

" + } + }, + "com.amazonaws.ec2#PlacementGroupArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws([a-z-]+)?:ec2:[a-z\\d-]+:\\d{12}:placement-group/^.{1,255}$" + } + }, + "com.amazonaws.ec2#PlacementGroupId": { + "type": "string" + }, + "com.amazonaws.ec2#PlacementGroupIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#PlacementGroupId", + "traits": { + "smithy.api#xmlName": "GroupId" + } + } + }, + "com.amazonaws.ec2#PlacementGroupInfo": { + "type": "structure", + "members": { + "SupportedStrategies": { + "target": "com.amazonaws.ec2#PlacementGroupStrategyList", + "traits": { + "aws.protocols#ec2QueryName": "SupportedStrategies", + "smithy.api#documentation": "

The supported placement group types.

", + "smithy.api#xmlName": "supportedStrategies" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the placement group support of the instance type.

" + } + }, + "com.amazonaws.ec2#PlacementGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#PlacementGroup", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#PlacementGroupName": { + "type": "string" + }, + "com.amazonaws.ec2#PlacementGroupState": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + }, + "deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted" + } + } + } + }, + "com.amazonaws.ec2#PlacementGroupStrategy": { + "type": "enum", + "members": { + "cluster": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cluster" + } + }, + "partition": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "partition" + } + }, + "spread": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "spread" + } + } + } + }, + "com.amazonaws.ec2#PlacementGroupStrategyList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#PlacementGroupStrategy", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#PlacementGroupStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#PlacementGroupName" + } + }, + "com.amazonaws.ec2#PlacementResponse": { + "type": "structure", + "members": { + "GroupName": { + "target": "com.amazonaws.ec2#PlacementGroupName", + "traits": { + "aws.protocols#ec2QueryName": "GroupName", + "smithy.api#documentation": "

The name of the placement group that the instance is in.

", + "smithy.api#xmlName": "groupName" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the placement of an instance.

" + } + }, + "com.amazonaws.ec2#PlacementStrategy": { + "type": "enum", + "members": { + "cluster": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cluster" + } + }, + "spread": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "spread" + } + }, + "partition": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "partition" + } + } + } + }, + "com.amazonaws.ec2#PlatformValues": { + "type": "enum", + "members": { + "Windows": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Windows" + } + } + } + }, + "com.amazonaws.ec2#PoolCidrBlock": { + "type": "structure", + "members": { + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PoolCidrBlock", + "smithy.api#documentation": "

The CIDR block.

", + "smithy.api#xmlName": "poolCidrBlock" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a CIDR block for an address pool.

" + } + }, + "com.amazonaws.ec2#PoolCidrBlocksSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#PoolCidrBlock", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#PoolMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.ec2#Port": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 65535 + } + } + }, + "com.amazonaws.ec2#PortRange": { + "type": "structure", + "members": { + "From": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "From", + "smithy.api#documentation": "

The first port in the range.

", + "smithy.api#xmlName": "from" + } + }, + "To": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "To", + "smithy.api#documentation": "

The last port in the range.

", + "smithy.api#xmlName": "to" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a range of ports.

" + } + }, + "com.amazonaws.ec2#PortRangeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#PortRange", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#PrefixList": { + "type": "structure", + "members": { + "Cidrs": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "CidrSet", + "smithy.api#documentation": "

The IP address range of the Amazon Web Services service.

", + "smithy.api#xmlName": "cidrSet" + } + }, + "PrefixListId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrefixListId", + "smithy.api#documentation": "

The ID of the prefix.

", + "smithy.api#xmlName": "prefixListId" + } + }, + "PrefixListName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrefixListName", + "smithy.api#documentation": "

The name of the prefix.

", + "smithy.api#xmlName": "prefixListName" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes prefixes for Amazon Web Services services.

" + } + }, + "com.amazonaws.ec2#PrefixListAssociation": { + "type": "structure", + "members": { + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The ID of the resource.

", + "smithy.api#xmlName": "resourceId" + } + }, + "ResourceOwner": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceOwner", + "smithy.api#documentation": "

The owner of the resource.

", + "smithy.api#xmlName": "resourceOwner" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the resource with which a prefix list is associated.

" + } + }, + "com.amazonaws.ec2#PrefixListAssociationSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#PrefixListAssociation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#PrefixListEntry": { + "type": "structure", + "members": { + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Cidr", + "smithy.api#documentation": "

The CIDR block.

", + "smithy.api#xmlName": "cidr" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description.

", + "smithy.api#xmlName": "description" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a prefix list entry.

" + } + }, + "com.amazonaws.ec2#PrefixListEntrySet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#PrefixListEntry", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#PrefixListId": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description for the security group rule that references this prefix list ID.

\n

Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9,\n spaces, and ._-:/()#,@[]+=;{}!$*

", + "smithy.api#xmlName": "description" + } + }, + "PrefixListId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrefixListId", + "smithy.api#documentation": "

The ID of the prefix.

", + "smithy.api#xmlName": "prefixListId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a prefix list ID.

" + } + }, + "com.amazonaws.ec2#PrefixListIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#PrefixListId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#PrefixListIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#PrefixListMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.ec2#PrefixListResourceId": { + "type": "string" + }, + "com.amazonaws.ec2#PrefixListResourceIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#PrefixListSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#PrefixList", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#PrefixListState": { + "type": "enum", + "members": { + "create_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "create-in-progress" + } + }, + "create_complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "create-complete" + } + }, + "create_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "create-failed" + } + }, + "modify_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modify-in-progress" + } + }, + "modify_complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modify-complete" + } + }, + "modify_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modify-failed" + } + }, + "restore_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "restore-in-progress" + } + }, + "restore_complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "restore-complete" + } + }, + "restore_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "restore-failed" + } + }, + "delete_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "delete-in-progress" + } + }, + "delete_complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "delete-complete" + } + }, + "delete_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "delete-failed" + } + } + } + }, + "com.amazonaws.ec2#PriceSchedule": { + "type": "structure", + "members": { + "Active": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Active", + "smithy.api#documentation": "

The current price schedule, as determined by the term remaining for the Reserved Instance in the listing.

\n

A specific price schedule is always in effect, but only one price schedule can be active at any time. Take, for example, a Reserved Instance listing that has five months remaining in its term. When you specify price schedules for five months and two months, this means that schedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. Then schedule 2, covering the last two months of the term, will be active for months 2 and 1.

", + "smithy.api#xmlName": "active" + } + }, + "CurrencyCode": { + "target": "com.amazonaws.ec2#CurrencyCodeValues", + "traits": { + "aws.protocols#ec2QueryName": "CurrencyCode", + "smithy.api#documentation": "

The currency for transacting the Reserved Instance resale.\n\t\t\t\tAt this time, the only supported currency is USD.

", + "smithy.api#xmlName": "currencyCode" + } + }, + "Price": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "Price", + "smithy.api#documentation": "

The fixed price for the term.

", + "smithy.api#xmlName": "price" + } + }, + "Term": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "Term", + "smithy.api#documentation": "

The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.

", + "smithy.api#xmlName": "term" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the price for a Reserved Instance.

" + } + }, + "com.amazonaws.ec2#PriceScheduleList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#PriceSchedule", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#PriceScheduleSpecification": { + "type": "structure", + "members": { + "Term": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "Term", + "smithy.api#documentation": "

The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.

", + "smithy.api#xmlName": "term" + } + }, + "Price": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "Price", + "smithy.api#documentation": "

The fixed price for the term.

", + "smithy.api#xmlName": "price" + } + }, + "CurrencyCode": { + "target": "com.amazonaws.ec2#CurrencyCodeValues", + "traits": { + "aws.protocols#ec2QueryName": "CurrencyCode", + "smithy.api#documentation": "

The currency for transacting the Reserved Instance resale.\n\t\t\t\tAt this time, the only supported currency is USD.

", + "smithy.api#xmlName": "currencyCode" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the price for a Reserved Instance.

" + } + }, + "com.amazonaws.ec2#PriceScheduleSpecificationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#PriceScheduleSpecification", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#PricingDetail": { + "type": "structure", + "members": { + "Count": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Count", + "smithy.api#documentation": "

The number of reservations available for the price.

", + "smithy.api#xmlName": "count" + } + }, + "Price": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "Price", + "smithy.api#documentation": "

The price per instance.

", + "smithy.api#xmlName": "price" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Reserved Instance offering.

" + } + }, + "com.amazonaws.ec2#PricingDetailsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#PricingDetail", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#PrincipalIdFormat": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Arn", + "smithy.api#documentation": "

PrincipalIdFormatARN description

", + "smithy.api#xmlName": "arn" + } + }, + "Statuses": { + "target": "com.amazonaws.ec2#IdFormatList", + "traits": { + "aws.protocols#ec2QueryName": "StatusSet", + "smithy.api#documentation": "

PrincipalIdFormatStatuses description

", + "smithy.api#xmlName": "statusSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

PrincipalIdFormat description

" + } + }, + "com.amazonaws.ec2#PrincipalIdFormatList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#PrincipalIdFormat", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#PrincipalType": { + "type": "enum", + "members": { + "All": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "All" + } + }, + "Service": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Service" + } + }, + "OrganizationUnit": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OrganizationUnit" + } + }, + "Account": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Account" + } + }, + "User": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "User" + } + }, + "Role": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Role" + } + } + } + }, + "com.amazonaws.ec2#Priority": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": -1, + "max": 65535 + } + } + }, + "com.amazonaws.ec2#PrivateDnsDetails": { + "type": "structure", + "members": { + "PrivateDnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateDnsName", + "smithy.api#documentation": "

The private DNS name assigned to the VPC endpoint service.

", + "smithy.api#xmlName": "privateDnsName" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the Private DNS name for interface endpoints.

" + } + }, + "com.amazonaws.ec2#PrivateDnsDetailsSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#PrivateDnsDetails", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#PrivateDnsNameConfiguration": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.ec2#DnsNameState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The verification state of the VPC endpoint service.

\n

>Consumers\n of the endpoint service can use the private name only when the state is\n verified.

", + "smithy.api#xmlName": "state" + } + }, + "Type": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Type", + "smithy.api#documentation": "

The endpoint service verification type, for example TXT.

", + "smithy.api#xmlName": "type" + } + }, + "Value": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Value", + "smithy.api#documentation": "

The value the service provider adds to the private DNS name domain record before verification.

", + "smithy.api#xmlName": "value" + } + }, + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Name", + "smithy.api#documentation": "

The name of the record subdomain the service provider needs to create. The service provider adds the value text to the name.

", + "smithy.api#xmlName": "name" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the private DNS name for the service endpoint.

" + } + }, + "com.amazonaws.ec2#PrivateDnsNameOptionsOnLaunch": { + "type": "structure", + "members": { + "HostnameType": { + "target": "com.amazonaws.ec2#HostnameType", + "traits": { + "aws.protocols#ec2QueryName": "HostnameType", + "smithy.api#documentation": "

The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name\n must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name\n must be based on the instance ID. For dual-stack subnets, you can specify whether DNS\n names use the instance IPv4 address or the instance ID.

", + "smithy.api#xmlName": "hostnameType" + } + }, + "EnableResourceNameDnsARecord": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EnableResourceNameDnsARecord", + "smithy.api#documentation": "

Indicates whether to respond to DNS queries for instance hostnames with DNS A\n records.

", + "smithy.api#xmlName": "enableResourceNameDnsARecord" + } + }, + "EnableResourceNameDnsAAAARecord": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EnableResourceNameDnsAAAARecord", + "smithy.api#documentation": "

Indicates whether to respond to DNS queries for instance hostname with DNS AAAA\n records.

", + "smithy.api#xmlName": "enableResourceNameDnsAAAARecord" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the options for instance hostnames.

" + } + }, + "com.amazonaws.ec2#PrivateDnsNameOptionsRequest": { + "type": "structure", + "members": { + "HostnameType": { + "target": "com.amazonaws.ec2#HostnameType", + "traits": { + "smithy.api#documentation": "

The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name\n must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name\n must be based on the instance ID. For dual-stack subnets, you can specify whether DNS\n names use the instance IPv4 address or the instance ID.

" + } + }, + "EnableResourceNameDnsARecord": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether to respond to DNS queries for instance hostnames with DNS A\n records.

" + } + }, + "EnableResourceNameDnsAAAARecord": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA\n records.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the options for instance hostnames.

" + } + }, + "com.amazonaws.ec2#PrivateDnsNameOptionsResponse": { + "type": "structure", + "members": { + "HostnameType": { + "target": "com.amazonaws.ec2#HostnameType", + "traits": { + "aws.protocols#ec2QueryName": "HostnameType", + "smithy.api#documentation": "

The type of hostname to assign to an instance.

", + "smithy.api#xmlName": "hostnameType" + } + }, + "EnableResourceNameDnsARecord": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EnableResourceNameDnsARecord", + "smithy.api#documentation": "

Indicates whether to respond to DNS queries for instance hostnames with DNS A\n records.

", + "smithy.api#xmlName": "enableResourceNameDnsARecord" + } + }, + "EnableResourceNameDnsAAAARecord": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EnableResourceNameDnsAAAARecord", + "smithy.api#documentation": "

Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA\n records.

", + "smithy.api#xmlName": "enableResourceNameDnsAAAARecord" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the options for instance hostnames.

" + } + }, + "com.amazonaws.ec2#PrivateIpAddressConfigSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ScheduledInstancesPrivateIpAddressConfig", + "traits": { + "smithy.api#xmlName": "PrivateIpAddressConfigSet" + } + } + }, + "com.amazonaws.ec2#PrivateIpAddressCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 31 + } + } + }, + "com.amazonaws.ec2#PrivateIpAddressSpecification": { + "type": "structure", + "members": { + "Primary": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Primary", + "smithy.api#documentation": "

Indicates whether the private IPv4 address is the primary private IPv4 address. Only\n one IPv4 address can be designated as primary.

", + "smithy.api#xmlName": "primary" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddress", + "smithy.api#documentation": "

The private IPv4 address.

", + "smithy.api#xmlName": "privateIpAddress" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a secondary private IPv4 address for a network interface.

" + } + }, + "com.amazonaws.ec2#PrivateIpAddressSpecificationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#PrivateIpAddressSpecification", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#PrivateIpAddressStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "PrivateIpAddress" + } + } + }, + "com.amazonaws.ec2#ProcessorInfo": { + "type": "structure", + "members": { + "SupportedArchitectures": { + "target": "com.amazonaws.ec2#ArchitectureTypeList", + "traits": { + "aws.protocols#ec2QueryName": "SupportedArchitectures", + "smithy.api#documentation": "

The architectures supported by the instance type.

", + "smithy.api#xmlName": "supportedArchitectures" + } + }, + "SustainedClockSpeedInGhz": { + "target": "com.amazonaws.ec2#ProcessorSustainedClockSpeed", + "traits": { + "aws.protocols#ec2QueryName": "SustainedClockSpeedInGhz", + "smithy.api#documentation": "

The speed of the processor, in GHz.

", + "smithy.api#xmlName": "sustainedClockSpeedInGhz" + } + }, + "SupportedFeatures": { + "target": "com.amazonaws.ec2#SupportedAdditionalProcessorFeatureList", + "traits": { + "aws.protocols#ec2QueryName": "SupportedFeatures", + "smithy.api#documentation": "

Indicates whether the instance type supports AMD SEV-SNP. If the request returns\n amd-sev-snp, AMD SEV-SNP is supported. Otherwise, it is not supported. For more\n information, see AMD\n SEV-SNP.

", + "smithy.api#xmlName": "supportedFeatures" + } + }, + "Manufacturer": { + "target": "com.amazonaws.ec2#CpuManufacturerName", + "traits": { + "aws.protocols#ec2QueryName": "Manufacturer", + "smithy.api#documentation": "

The manufacturer of the processor.

", + "smithy.api#xmlName": "manufacturer" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the processor used by the instance type.

" + } + }, + "com.amazonaws.ec2#ProcessorSustainedClockSpeed": { + "type": "double" + }, + "com.amazonaws.ec2#ProductCode": { + "type": "structure", + "members": { + "ProductCodeId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ProductCode", + "smithy.api#documentation": "

The product code.

", + "smithy.api#xmlName": "productCode" + } + }, + "ProductCodeType": { + "target": "com.amazonaws.ec2#ProductCodeValues", + "traits": { + "aws.protocols#ec2QueryName": "Type", + "smithy.api#documentation": "

The type of product code.

", + "smithy.api#xmlName": "type" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a product code.

" + } + }, + "com.amazonaws.ec2#ProductCodeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ProductCode", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ProductCodeStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "ProductCode" + } + } + }, + "com.amazonaws.ec2#ProductCodeValues": { + "type": "enum", + "members": { + "devpay": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "devpay" + } + }, + "marketplace": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "marketplace" + } + } + } + }, + "com.amazonaws.ec2#ProductDescriptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String" + } + }, + "com.amazonaws.ec2#PropagatingVgw": { + "type": "structure", + "members": { + "GatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GatewayId", + "smithy.api#documentation": "

The ID of the virtual private gateway.

", + "smithy.api#xmlName": "gatewayId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a virtual private gateway propagating route.

" + } + }, + "com.amazonaws.ec2#PropagatingVgwList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#PropagatingVgw", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Protocol": { + "type": "enum", + "members": { + "tcp": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "tcp" + } + }, + "udp": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "udp" + } + } + } + }, + "com.amazonaws.ec2#ProtocolInt": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 255 + } + } + }, + "com.amazonaws.ec2#ProtocolIntList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ProtocolInt", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ProtocolList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Protocol", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ProtocolValue": { + "type": "enum", + "members": { + "gre": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "gre" + } + } + } + }, + "com.amazonaws.ec2#ProvisionByoipCidr": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ProvisionByoipCidrRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ProvisionByoipCidrResult" + }, + "traits": { + "smithy.api#documentation": "

Provisions an IPv4 or IPv6 address range for use with your Amazon Web Services resources through bring your own IP \n addresses (BYOIP) and creates a corresponding address pool. After the address range is\n provisioned, it is ready to be advertised using AdvertiseByoipCidr.

\n

Amazon Web Services verifies that you own the address range and are authorized to advertise it. \n You must ensure that the address range is registered to you and that you created an \n RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. \n For more information, see Bring your own IP addresses (BYOIP) in the Amazon EC2 User Guide.

\n

Provisioning an address range is an asynchronous operation, so the call returns immediately,\n but the address range is not ready to use until its status changes from pending-provision\n to provisioned. To monitor the status of an address range, use DescribeByoipCidrs. \n To allocate an Elastic IP address from your IPv4 address pool, use AllocateAddress \n with either the specific address from the address pool or the ID of the address pool.

" + } + }, + "com.amazonaws.ec2#ProvisionByoipCidrRequest": { + "type": "structure", + "members": { + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The public IPv4 or IPv6 address range, in CIDR notation. The most specific IPv4 prefix that you can \n specify is /24. The most specific IPv6 address range that you can bring is /48 for CIDRs that are publicly advertisable and /56 for CIDRs that are not publicly advertisable. The address range cannot overlap with another address range that you've \n brought to this or another Region.

", + "smithy.api#required": {} + } + }, + "CidrAuthorizationContext": { + "target": "com.amazonaws.ec2#CidrAuthorizationContext", + "traits": { + "smithy.api#documentation": "

A signed document that proves that you are authorized to bring the specified IP address \n range to Amazon using BYOIP.

" + } + }, + "PubliclyAdvertisable": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

(IPv6 only) Indicate whether the address range will be publicly advertised to the\n internet.

\n

Default: true

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description for the address range and the address pool.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "PoolTagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the address pool.

", + "smithy.api#xmlName": "PoolTagSpecification" + } + }, + "MultiRegion": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Reserved.

" + } + }, + "NetworkBorderGroup": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

If you have Local Zones enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR. Choose the network border group carefully as the EIP and the Amazon Web Services resource it is associated with must reside in the same network border group.

\n

You can provision BYOIP address ranges to and advertise them in the following Local Zone network border groups:

\n \n \n

You cannot provision or advertise BYOIPv6 address ranges in Local Zones at this time.

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ProvisionByoipCidrResult": { + "type": "structure", + "members": { + "ByoipCidr": { + "target": "com.amazonaws.ec2#ByoipCidr", + "traits": { + "aws.protocols#ec2QueryName": "ByoipCidr", + "smithy.api#documentation": "

Information about the address range.

", + "smithy.api#xmlName": "byoipCidr" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ProvisionIpamByoasn": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ProvisionIpamByoasnRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ProvisionIpamByoasnResult" + }, + "traits": { + "smithy.api#documentation": "

Provisions your Autonomous System Number (ASN) for use in your Amazon Web Services account. This action requires authorization context for Amazon to bring the ASN to an Amazon Web Services account. For more information, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide.

" + } + }, + "com.amazonaws.ec2#ProvisionIpamByoasnRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamId": { + "target": "com.amazonaws.ec2#IpamId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An IPAM ID.

", + "smithy.api#required": {} + } + }, + "Asn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A public 2-byte or 4-byte ASN.

", + "smithy.api#required": {} + } + }, + "AsnAuthorizationContext": { + "target": "com.amazonaws.ec2#AsnAuthorizationContext", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An ASN authorization context.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ProvisionIpamByoasnResult": { + "type": "structure", + "members": { + "Byoasn": { + "target": "com.amazonaws.ec2#Byoasn", + "traits": { + "aws.protocols#ec2QueryName": "Byoasn", + "smithy.api#documentation": "

An ASN and BYOIP CIDR association.

", + "smithy.api#xmlName": "byoasn" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ProvisionIpamPoolCidr": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ProvisionIpamPoolCidrRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ProvisionIpamPoolCidrResult" + }, + "traits": { + "smithy.api#documentation": "

Provision a CIDR to an IPAM pool. You can use this action to provision new CIDRs to a top-level pool or to transfer a CIDR from a top-level pool to a pool within it.

\n

For more information, see Provision CIDRs to pools in the Amazon VPC IPAM User Guide.\n

" + } + }, + "com.amazonaws.ec2#ProvisionIpamPoolCidrRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the IPAM pool to which you want to assign a CIDR.

", + "smithy.api#required": {} + } + }, + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The CIDR you want to assign to the IPAM pool. Either \"NetmaskLength\" or \"Cidr\" is required. This value will be null if you specify \"NetmaskLength\" and will be filled in during the provisioning process.

" + } + }, + "CidrAuthorizationContext": { + "target": "com.amazonaws.ec2#IpamCidrAuthorizationContext", + "traits": { + "smithy.api#documentation": "

A signed document that proves that you are authorized to bring a specified IP address range to Amazon using BYOIP. This option only applies to IPv4 and IPv6 pools in the public scope.

" + } + }, + "NetmaskLength": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The netmask length of the CIDR you'd like to provision to a pool. Can be used for provisioning Amazon-provided IPv6 CIDRs to top-level pools and for provisioning CIDRs to pools with source pools. Cannot be used to provision BYOIP CIDRs to top-level pools. Either \"NetmaskLength\" or \"Cidr\" is required.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "VerificationMethod": { + "target": "com.amazonaws.ec2#VerificationMethod", + "traits": { + "smithy.api#documentation": "

The method for verifying control of a public IP address range. Defaults to remarks-x509 if not specified. This option only applies to IPv4 and IPv6 pools in the public scope.

" + } + }, + "IpamExternalResourceVerificationTokenId": { + "target": "com.amazonaws.ec2#IpamExternalResourceVerificationTokenId", + "traits": { + "smithy.api#documentation": "

Verification token ID. This option only applies to IPv4 and IPv6 pools in the public scope.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ProvisionIpamPoolCidrResult": { + "type": "structure", + "members": { + "IpamPoolCidr": { + "target": "com.amazonaws.ec2#IpamPoolCidr", + "traits": { + "aws.protocols#ec2QueryName": "IpamPoolCidr", + "smithy.api#documentation": "

Information about the provisioned CIDR.

", + "smithy.api#xmlName": "ipamPoolCidr" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ProvisionPublicIpv4PoolCidr": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ProvisionPublicIpv4PoolCidrRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ProvisionPublicIpv4PoolCidrResult" + }, + "traits": { + "smithy.api#documentation": "

Provision a CIDR to a public IPv4 pool.

\n

For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.

" + } + }, + "com.amazonaws.ec2#ProvisionPublicIpv4PoolCidrRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the IPAM pool you would like to use to allocate this CIDR.

", + "smithy.api#required": {} + } + }, + "PoolId": { + "target": "com.amazonaws.ec2#Ipv4PoolEc2Id", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the public IPv4 pool you would like to use for this CIDR.

", + "smithy.api#required": {} + } + }, + "NetmaskLength": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The netmask length of the CIDR you would like to allocate to the public IPv4 pool. The least specific netmask length you can define is 24.

", + "smithy.api#required": {} + } + }, + "NetworkBorderGroup": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone (AZ) or Local Zone (LZ) network border group that the resource that the IP address is assigned to is in. Defaults to an AZ network border group. For more information on available Local Zones, see Local Zone availability in the Amazon EC2 User Guide.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ProvisionPublicIpv4PoolCidrResult": { + "type": "structure", + "members": { + "PoolId": { + "target": "com.amazonaws.ec2#Ipv4PoolEc2Id", + "traits": { + "aws.protocols#ec2QueryName": "PoolId", + "smithy.api#documentation": "

The ID of the pool that you want to provision the CIDR to.

", + "smithy.api#xmlName": "poolId" + } + }, + "PoolAddressRange": { + "target": "com.amazonaws.ec2#PublicIpv4PoolRange", + "traits": { + "aws.protocols#ec2QueryName": "PoolAddressRange", + "smithy.api#documentation": "

Information about the address range of the public IPv4 pool.

", + "smithy.api#xmlName": "poolAddressRange" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ProvisionedBandwidth": { + "type": "structure", + "members": { + "ProvisionTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "ProvisionTime", + "smithy.api#documentation": "

Reserved.

", + "smithy.api#xmlName": "provisionTime" + } + }, + "Provisioned": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Provisioned", + "smithy.api#documentation": "

Reserved.

", + "smithy.api#xmlName": "provisioned" + } + }, + "RequestTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "RequestTime", + "smithy.api#documentation": "

Reserved.

", + "smithy.api#xmlName": "requestTime" + } + }, + "Requested": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Requested", + "smithy.api#documentation": "

Reserved.

", + "smithy.api#xmlName": "requested" + } + }, + "Status": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

Reserved.

", + "smithy.api#xmlName": "status" + } + } + }, + "traits": { + "smithy.api#documentation": "

Reserved. If you need to sustain traffic greater than the documented limits, \n contact Amazon Web Services Support.

" + } + }, + "com.amazonaws.ec2#PtrUpdateStatus": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Value", + "smithy.api#documentation": "

The value for the PTR record update.

", + "smithy.api#xmlName": "value" + } + }, + "Status": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The status of the PTR record update.

", + "smithy.api#xmlName": "status" + } + }, + "Reason": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Reason", + "smithy.api#documentation": "

The reason for the PTR record update.

", + "smithy.api#xmlName": "reason" + } + } + }, + "traits": { + "smithy.api#documentation": "

The status of an updated pointer (PTR) record for an Elastic IP address.

" + } + }, + "com.amazonaws.ec2#PublicIpAddress": { + "type": "string" + }, + "com.amazonaws.ec2#PublicIpStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "PublicIp" + } + } + }, + "com.amazonaws.ec2#PublicIpv4Pool": { + "type": "structure", + "members": { + "PoolId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PoolId", + "smithy.api#documentation": "

The ID of the address pool.

", + "smithy.api#xmlName": "poolId" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description of the address pool.

", + "smithy.api#xmlName": "description" + } + }, + "PoolAddressRanges": { + "target": "com.amazonaws.ec2#PublicIpv4PoolRangeSet", + "traits": { + "aws.protocols#ec2QueryName": "PoolAddressRangeSet", + "smithy.api#documentation": "

The address ranges.

", + "smithy.api#xmlName": "poolAddressRangeSet" + } + }, + "TotalAddressCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TotalAddressCount", + "smithy.api#documentation": "

The total number of addresses.

", + "smithy.api#xmlName": "totalAddressCount" + } + }, + "TotalAvailableAddressCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TotalAvailableAddressCount", + "smithy.api#documentation": "

The total number of available addresses.

", + "smithy.api#xmlName": "totalAvailableAddressCount" + } + }, + "NetworkBorderGroup": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkBorderGroup", + "smithy.api#documentation": "

The name of the location from which the address pool is advertised. \n A network border group is a unique set of Availability Zones or Local Zones \n from where Amazon Web Services advertises public IP addresses.

", + "smithy.api#xmlName": "networkBorderGroup" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags for the address pool.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an IPv4 address pool.

" + } + }, + "com.amazonaws.ec2#PublicIpv4PoolIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Ipv4PoolEc2Id", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#PublicIpv4PoolRange": { + "type": "structure", + "members": { + "FirstAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "FirstAddress", + "smithy.api#documentation": "

The first IP address in the range.

", + "smithy.api#xmlName": "firstAddress" + } + }, + "LastAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LastAddress", + "smithy.api#documentation": "

The last IP address in the range.

", + "smithy.api#xmlName": "lastAddress" + } + }, + "AddressCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "AddressCount", + "smithy.api#documentation": "

The number of addresses in the range.

", + "smithy.api#xmlName": "addressCount" + } + }, + "AvailableAddressCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "AvailableAddressCount", + "smithy.api#documentation": "

The number of available addresses in the range.

", + "smithy.api#xmlName": "availableAddressCount" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an address range of an IPv4 address pool.

" + } + }, + "com.amazonaws.ec2#PublicIpv4PoolRangeSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#PublicIpv4PoolRange", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#PublicIpv4PoolSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#PublicIpv4Pool", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Purchase": { + "type": "structure", + "members": { + "CurrencyCode": { + "target": "com.amazonaws.ec2#CurrencyCodeValues", + "traits": { + "aws.protocols#ec2QueryName": "CurrencyCode", + "smithy.api#documentation": "

The currency in which the UpfrontPrice and HourlyPrice\n amounts are specified. At this time, the only supported currency is\n USD.

", + "smithy.api#xmlName": "currencyCode" + } + }, + "Duration": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Duration", + "smithy.api#documentation": "

The duration of the reservation's term in seconds.

", + "smithy.api#xmlName": "duration" + } + }, + "HostIdSet": { + "target": "com.amazonaws.ec2#ResponseHostIdSet", + "traits": { + "aws.protocols#ec2QueryName": "HostIdSet", + "smithy.api#documentation": "

The IDs of the Dedicated Hosts associated with the reservation.

", + "smithy.api#xmlName": "hostIdSet" + } + }, + "HostReservationId": { + "target": "com.amazonaws.ec2#HostReservationId", + "traits": { + "aws.protocols#ec2QueryName": "HostReservationId", + "smithy.api#documentation": "

The ID of the reservation.

", + "smithy.api#xmlName": "hostReservationId" + } + }, + "HourlyPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "HourlyPrice", + "smithy.api#documentation": "

The hourly price of the reservation per hour.

", + "smithy.api#xmlName": "hourlyPrice" + } + }, + "InstanceFamily": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceFamily", + "smithy.api#documentation": "

The instance family on the Dedicated Host that the reservation can be associated\n with.

", + "smithy.api#xmlName": "instanceFamily" + } + }, + "PaymentOption": { + "target": "com.amazonaws.ec2#PaymentOption", + "traits": { + "aws.protocols#ec2QueryName": "PaymentOption", + "smithy.api#documentation": "

The payment option for the reservation.

", + "smithy.api#xmlName": "paymentOption" + } + }, + "UpfrontPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "UpfrontPrice", + "smithy.api#documentation": "

The upfront price of the reservation.

", + "smithy.api#xmlName": "upfrontPrice" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the result of the purchase.

" + } + }, + "com.amazonaws.ec2#PurchaseCapacityBlock": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#PurchaseCapacityBlockRequest" + }, + "output": { + "target": "com.amazonaws.ec2#PurchaseCapacityBlockResult" + }, + "traits": { + "smithy.api#documentation": "

Purchase the Capacity Block for use with your account. With Capacity Blocks you ensure\n\t\t\tGPU capacity is available for machine learning (ML) workloads. You must specify the ID\n\t\t\tof the Capacity Block offering you are purchasing.

" + } + }, + "com.amazonaws.ec2#PurchaseCapacityBlockExtension": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#PurchaseCapacityBlockExtensionRequest" + }, + "output": { + "target": "com.amazonaws.ec2#PurchaseCapacityBlockExtensionResult" + }, + "traits": { + "smithy.api#documentation": "

Purchase the Capacity Block extension for use with your account. You must specify the\n\t\t\tID of the Capacity Block extension offering you are purchasing.

" + } + }, + "com.amazonaws.ec2#PurchaseCapacityBlockExtensionRequest": { + "type": "structure", + "members": { + "CapacityBlockExtensionOfferingId": { + "target": "com.amazonaws.ec2#OfferingId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Capacity Block extension offering to purchase.

", + "smithy.api#required": {} + } + }, + "CapacityReservationId": { + "target": "com.amazonaws.ec2#CapacityReservationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Capacity reservation to be extended.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#PurchaseCapacityBlockExtensionResult": { + "type": "structure", + "members": { + "CapacityBlockExtensions": { + "target": "com.amazonaws.ec2#CapacityBlockExtensionSet", + "traits": { + "aws.protocols#ec2QueryName": "CapacityBlockExtensionSet", + "smithy.api#documentation": "

The purchased Capacity Block extensions.

", + "smithy.api#xmlName": "capacityBlockExtensionSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#PurchaseCapacityBlockRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the Capacity Block during launch.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "CapacityBlockOfferingId": { + "target": "com.amazonaws.ec2#OfferingId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Capacity Block offering.

", + "smithy.api#required": {} + } + }, + "InstancePlatform": { + "target": "com.amazonaws.ec2#CapacityReservationInstancePlatform", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of operating system for which to reserve capacity.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#PurchaseCapacityBlockResult": { + "type": "structure", + "members": { + "CapacityReservation": { + "target": "com.amazonaws.ec2#CapacityReservation", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservation", + "smithy.api#documentation": "

The Capacity Reservation.

", + "smithy.api#xmlName": "capacityReservation" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#PurchaseHostReservation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#PurchaseHostReservationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#PurchaseHostReservationResult" + }, + "traits": { + "smithy.api#documentation": "

Purchase a reservation with configurations that match those of your Dedicated Host.\n You must have active Dedicated Hosts in your account before you purchase a reservation.\n This action results in the specified reservation being purchased and charged to your\n account.

" + } + }, + "com.amazonaws.ec2#PurchaseHostReservationRequest": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

" + } + }, + "CurrencyCode": { + "target": "com.amazonaws.ec2#CurrencyCodeValues", + "traits": { + "smithy.api#documentation": "

The currency in which the totalUpfrontPrice, LimitPrice, and\n totalHourlyPrice amounts are specified. At this time, the only\n supported currency is USD.

" + } + }, + "HostIdSet": { + "target": "com.amazonaws.ec2#RequestHostIdSet", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the Dedicated Hosts with which the reservation will be associated.

", + "smithy.api#required": {} + } + }, + "LimitPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The specified limit is checked against the total upfront cost of the reservation\n (calculated as the offering's upfront cost multiplied by the host count). If the total\n upfront cost is greater than the specified price limit, the request fails. This is used\n to ensure that the purchase does not exceed the expected upfront cost of the purchase.\n At this time, the only supported currency is USD. For example, to indicate\n a limit price of USD 100, specify 100.00.

" + } + }, + "OfferingId": { + "target": "com.amazonaws.ec2#OfferingId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the offering.

", + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the Dedicated Host Reservation during purchase.

", + "smithy.api#xmlName": "TagSpecification" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#PurchaseHostReservationResult": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

", + "smithy.api#xmlName": "clientToken" + } + }, + "CurrencyCode": { + "target": "com.amazonaws.ec2#CurrencyCodeValues", + "traits": { + "aws.protocols#ec2QueryName": "CurrencyCode", + "smithy.api#documentation": "

The currency in which the totalUpfrontPrice and\n totalHourlyPrice amounts are specified. At this time, the only\n supported currency is USD.

", + "smithy.api#xmlName": "currencyCode" + } + }, + "Purchase": { + "target": "com.amazonaws.ec2#PurchaseSet", + "traits": { + "aws.protocols#ec2QueryName": "Purchase", + "smithy.api#documentation": "

Describes the details of the purchase.

", + "smithy.api#xmlName": "purchase" + } + }, + "TotalHourlyPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TotalHourlyPrice", + "smithy.api#documentation": "

The total hourly price of the reservation calculated per hour.

", + "smithy.api#xmlName": "totalHourlyPrice" + } + }, + "TotalUpfrontPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TotalUpfrontPrice", + "smithy.api#documentation": "

The total amount charged to your account when you purchase the reservation.

", + "smithy.api#xmlName": "totalUpfrontPrice" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#PurchaseRequest": { + "type": "structure", + "members": { + "InstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of instances.

", + "smithy.api#required": {} + } + }, + "PurchaseToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The purchase token.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a request to purchase Scheduled Instances.

" + } + }, + "com.amazonaws.ec2#PurchaseRequestSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#PurchaseRequest", + "traits": { + "smithy.api#xmlName": "PurchaseRequest" + } + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.ec2#PurchaseReservedInstancesOffering": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#PurchaseReservedInstancesOfferingRequest" + }, + "output": { + "target": "com.amazonaws.ec2#PurchaseReservedInstancesOfferingResult" + }, + "traits": { + "smithy.api#documentation": "

Purchases a Reserved Instance for use with your account. With Reserved Instances, you pay a lower \n hourly rate compared to On-Demand instance pricing.

\n

Use DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings \n\t\t\tthat match your specifications. After you've purchased a Reserved Instance, you can check for your\n\t\t\tnew Reserved Instance with DescribeReservedInstances.

\n

To queue a purchase for a future date and time, specify a purchase time. If you do not specify a\n purchase time, the default is the current time.

\n

For more information, see Reserved\n Instances and Sell in the Reserved Instance\n Marketplace in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#PurchaseReservedInstancesOfferingRequest": { + "type": "structure", + "members": { + "InstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of Reserved Instances to purchase.

", + "smithy.api#required": {} + } + }, + "ReservedInstancesOfferingId": { + "target": "com.amazonaws.ec2#ReservedInstancesOfferingId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Reserved Instance offering to purchase.

", + "smithy.api#required": {} + } + }, + "PurchaseTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "smithy.api#documentation": "

The time at which to purchase the Reserved Instance, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "LimitPrice": { + "target": "com.amazonaws.ec2#ReservedInstanceLimitPrice", + "traits": { + "aws.protocols#ec2QueryName": "LimitPrice", + "smithy.api#documentation": "

Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices.

", + "smithy.api#xmlName": "limitPrice" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for PurchaseReservedInstancesOffering.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#PurchaseReservedInstancesOfferingResult": { + "type": "structure", + "members": { + "ReservedInstancesId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstancesId", + "smithy.api#documentation": "

The IDs of the purchased Reserved Instances. If your purchase crosses into a discounted\n pricing tier, the final Reserved Instances IDs might change. For more information, see Crossing\n pricing tiers in the Amazon EC2 User Guide.

", + "smithy.api#xmlName": "reservedInstancesId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of PurchaseReservedInstancesOffering.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#PurchaseScheduledInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#PurchaseScheduledInstancesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#PurchaseScheduledInstancesResult" + }, + "traits": { + "smithy.api#documentation": "\n

You can no longer purchase Scheduled Instances.

\n \n

Purchases the Scheduled Instances with the specified schedule.

\n

Scheduled Instances enable you to purchase Amazon EC2 compute capacity by the hour for a one-year term.\n Before you can purchase a Scheduled Instance, you must call DescribeScheduledInstanceAvailability\n to check for available schedules and obtain a purchase token. After you purchase a Scheduled Instance,\n you must call RunScheduledInstances during each scheduled time period.

\n

After you purchase a Scheduled Instance, you can't cancel, modify, or resell your purchase.

" + } + }, + "com.amazonaws.ec2#PurchaseScheduledInstancesRequest": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that ensures the idempotency of the request. \n For more information, see Ensuring Idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "PurchaseRequests": { + "target": "com.amazonaws.ec2#PurchaseRequestSet", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The purchase requests.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "PurchaseRequest" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for PurchaseScheduledInstances.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#PurchaseScheduledInstancesResult": { + "type": "structure", + "members": { + "ScheduledInstanceSet": { + "target": "com.amazonaws.ec2#PurchasedScheduledInstanceSet", + "traits": { + "aws.protocols#ec2QueryName": "ScheduledInstanceSet", + "smithy.api#documentation": "

Information about the Scheduled Instances.

", + "smithy.api#xmlName": "scheduledInstanceSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of PurchaseScheduledInstances.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#PurchaseSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Purchase", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#PurchasedScheduledInstanceSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ScheduledInstance", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#RIProductDescription": { + "type": "enum", + "members": { + "Linux_UNIX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Linux/UNIX" + } + }, + "Linux_UNIX_Amazon_VPC_": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Linux/UNIX (Amazon VPC)" + } + }, + "Windows": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Windows" + } + }, + "Windows_Amazon_VPC_": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Windows (Amazon VPC)" + } + } + } + }, + "com.amazonaws.ec2#RamdiskId": { + "type": "string" + }, + "com.amazonaws.ec2#RdsDbClusterArn": { + "type": "string" + }, + "com.amazonaws.ec2#RdsDbInstanceArn": { + "type": "string" + }, + "com.amazonaws.ec2#RdsDbProxyArn": { + "type": "string" + }, + "com.amazonaws.ec2#ReasonCodesList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ReportInstanceReasonCodes", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#RebootInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RebootInstancesRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Requests a reboot of the specified instances. This operation is asynchronous; it only\n queues a request to reboot the specified instances. The operation succeeds if the\n instances are valid and belong to you. Requests to reboot terminated instances are\n ignored.

\n

If an instance does not cleanly shut down within a few minutes, Amazon EC2 performs a\n hard reboot.

\n

For more information about troubleshooting, see Troubleshoot an unreachable\n instance in the Amazon EC2 User Guide.

", + "smithy.api#examples": [ + { + "title": "To reboot an EC2 instance", + "documentation": "This example reboots the specified EC2 instance.", + "input": { + "InstanceIds": [ + "i-1234567890abcdef5" + ] + }, + "output": {} + } + ] + } + }, + "com.amazonaws.ec2#RebootInstancesRequest": { + "type": "structure", + "members": { + "InstanceIds": { + "target": "com.amazonaws.ec2#InstanceIdStringList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The instance IDs.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "InstanceId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#RecurringCharge": { + "type": "structure", + "members": { + "Amount": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "Amount", + "smithy.api#documentation": "

The amount of the recurring charge.

", + "smithy.api#xmlName": "amount" + } + }, + "Frequency": { + "target": "com.amazonaws.ec2#RecurringChargeFrequency", + "traits": { + "aws.protocols#ec2QueryName": "Frequency", + "smithy.api#documentation": "

The frequency of the recurring charge.

", + "smithy.api#xmlName": "frequency" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a recurring charge.

" + } + }, + "com.amazonaws.ec2#RecurringChargeFrequency": { + "type": "enum", + "members": { + "Hourly": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Hourly" + } + } + } + }, + "com.amazonaws.ec2#RecurringChargesList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#RecurringCharge", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ReferencedSecurityGroup": { + "type": "structure", + "members": { + "GroupId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupId", + "smithy.api#documentation": "

The ID of the security group.

", + "smithy.api#xmlName": "groupId" + } + }, + "PeeringStatus": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PeeringStatus", + "smithy.api#documentation": "

The status of a VPC peering connection, if applicable.

", + "smithy.api#xmlName": "peeringStatus" + } + }, + "UserId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "UserId", + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#xmlName": "userId" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "vpcId" + } + }, + "VpcPeeringConnectionId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcPeeringConnectionId", + "smithy.api#documentation": "

The ID of the VPC peering connection (if applicable).

", + "smithy.api#xmlName": "vpcPeeringConnectionId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the security group that is referenced in the security group rule.

" + } + }, + "com.amazonaws.ec2#Region": { + "type": "structure", + "members": { + "OptInStatus": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OptInStatus", + "smithy.api#documentation": "

The Region opt-in status. The possible values are opt-in-not-required, opted-in, and \n not-opted-in.

", + "smithy.api#xmlName": "optInStatus" + } + }, + "RegionName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RegionName", + "smithy.api#documentation": "

The name of the Region.

", + "smithy.api#xmlName": "regionName" + } + }, + "Endpoint": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RegionEndpoint", + "smithy.api#documentation": "

The Region service endpoint.

", + "smithy.api#xmlName": "regionEndpoint" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Region.

" + } + }, + "com.amazonaws.ec2#RegionList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Region", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#RegionNameStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "RegionName" + } + } + }, + "com.amazonaws.ec2#RegionNames": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.ec2#RegionalSummary": { + "type": "structure", + "members": { + "RegionName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RegionName", + "smithy.api#documentation": "

The Amazon Web Services Region.

", + "smithy.api#xmlName": "regionName" + } + }, + "NumberOfMatchedAccounts": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "NumberOfMatchedAccounts", + "smithy.api#documentation": "

The number of accounts in the Region with the same configuration value for the\n attribute that is most frequently observed.

", + "smithy.api#xmlName": "numberOfMatchedAccounts" + } + }, + "NumberOfUnmatchedAccounts": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "NumberOfUnmatchedAccounts", + "smithy.api#documentation": "

The number of accounts in the Region with a configuration value different from the\n most frequently observed value for the attribute.

", + "smithy.api#xmlName": "numberOfUnmatchedAccounts" + } + } + }, + "traits": { + "smithy.api#documentation": "

A summary report for the attribute for a Region.

" + } + }, + "com.amazonaws.ec2#RegionalSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#RegionalSummary", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#RegisterImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RegisterImageRequest" + }, + "output": { + "target": "com.amazonaws.ec2#RegisterImageResult" + }, + "traits": { + "smithy.api#documentation": "

Registers an AMI. When you're creating an instance-store backed AMI, registering the AMI\n is the final step in the creation process. For more information about creating AMIs, see\n Create an AMI from a snapshot and Create an instance-store\n backed AMI in the Amazon EC2 User Guide.

\n \n

For Amazon EBS-backed instances, CreateImage creates and registers the AMI\n in a single request, so you don't have to register the AMI yourself. We recommend that you\n always use CreateImage unless you have a specific reason to use\n RegisterImage.

\n \n

If needed, you can deregister an AMI at any time. Any modifications you make to an AMI\n backed by an instance store volume invalidates its registration. If you make changes to an\n image, deregister the previous image and register the new image.

\n

\n Register a snapshot of a root device volume\n

\n

You can use RegisterImage to create an Amazon EBS-backed Linux AMI from a snapshot\n of a root device volume. You specify the snapshot using a block device mapping. You can't set\n the encryption state of the volume using the block device mapping. If the snapshot is\n encrypted, or encryption by default is enabled, the root volume of an instance launched from\n the AMI is encrypted.

\n

For more information, see Create an AMI from a snapshot and Use encryption with Amazon EBS-backed\n AMIs in the Amazon EC2 User Guide.

\n

\n Amazon Web Services Marketplace product codes\n

\n

If any snapshots have Amazon Web Services Marketplace product codes, they are copied to the new AMI.

\n

In most cases, AMIs for Windows, RedHat, SUSE, and SQL Server require correct licensing\n information to be present on the AMI. For more information, see Understand AMI billing\n information in the Amazon EC2 User Guide. When creating an AMI from\n a snapshot, the RegisterImage operation derives the correct billing information\n from the snapshot's metadata, but this requires the appropriate metadata to be present. To\n verify if the correct billing information was applied, check the PlatformDetails\n field on the new AMI. If the field is empty or doesn't match the expected operating system\n code (for example, Windows, RedHat, SUSE, or SQL), the AMI creation was unsuccessful, and you\n should discard the AMI and instead create the AMI from an instance using CreateImage. For more information, see Create an AMI\n from an instance in the Amazon EC2 User Guide.

\n

If you purchase a Reserved Instance to apply to an On-Demand Instance that was launched\n from an AMI with a billing product code, make sure that the Reserved Instance has the matching\n billing product code. If you purchase a Reserved Instance without the matching billing product\n code, the Reserved Instance will not be applied to the On-Demand Instance. For information\n about how to obtain the platform details and billing information of an AMI, see Understand AMI\n billing information in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#RegisterImageRequest": { + "type": "structure", + "members": { + "ImageLocation": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The full path to your AMI manifest in Amazon S3 storage. The specified bucket must have the\n aws-exec-read canned access control list (ACL) to ensure that it can be\n accessed by Amazon EC2. For more information, see Canned ACLs in the\n Amazon S3 Service Developer Guide.

" + } + }, + "BillingProducts": { + "target": "com.amazonaws.ec2#BillingProductList", + "traits": { + "smithy.api#documentation": "

The billing product codes. Your account must be authorized to specify billing product\n codes.

\n

If your account is not authorized to specify billing product codes, you can publish AMIs\n that include billable software and list them on the Amazon Web Services Marketplace. You must first register as a seller\n on the Amazon Web Services Marketplace. For more information, see Getting started as a\n seller and AMI-based products in the\n Amazon Web Services Marketplace Seller Guide.

", + "smithy.api#xmlName": "BillingProduct" + } + }, + "BootMode": { + "target": "com.amazonaws.ec2#BootModeValues", + "traits": { + "smithy.api#documentation": "

The boot mode of the AMI. A value of uefi-preferred indicates that the AMI\n supports both UEFI and Legacy BIOS.

\n \n

The operating system contained in the AMI must be configured to support the specified\n boot mode.

\n \n

For more information, see Boot modes in the\n Amazon EC2 User Guide.

" + } + }, + "TpmSupport": { + "target": "com.amazonaws.ec2#TpmSupportValues", + "traits": { + "smithy.api#documentation": "

Set to v2.0 to enable Trusted Platform Module (TPM) support. For more\n information, see NitroTPM in the Amazon EC2 User Guide.

" + } + }, + "UefiData": { + "target": "com.amazonaws.ec2#StringType", + "traits": { + "smithy.api#documentation": "

Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data,\n use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the\n python-uefivars tool on\n GitHub. For more information, see UEFI Secure Boot in the\n Amazon EC2 User Guide.

" + } + }, + "ImdsSupport": { + "target": "com.amazonaws.ec2#ImdsSupportValues", + "traits": { + "smithy.api#documentation": "

Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances\n launched from this AMI will have HttpTokens automatically set to\n required so that, by default, the instance requires that IMDSv2 is used when\n requesting instance metadata. In addition, HttpPutResponseHopLimit is set to\n 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.

\n \n

If you set the value to v2.0, make sure that your AMI software can support\n IMDSv2.

\n " + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the AMI.

\n

To tag the AMI, the value for ResourceType must be image. If you\n specify another value for ResourceType, the request fails.

\n

To tag an AMI after it has been registered, see CreateTags.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Name", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A name for your AMI.

\n

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces\n ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or\n underscores(_)

", + "smithy.api#required": {}, + "smithy.api#xmlName": "name" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description for your AMI.

", + "smithy.api#xmlName": "description" + } + }, + "Architecture": { + "target": "com.amazonaws.ec2#ArchitectureValues", + "traits": { + "aws.protocols#ec2QueryName": "Architecture", + "smithy.api#documentation": "

The architecture of the AMI.

\n

Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the\n architecture specified in the manifest file.

", + "smithy.api#xmlName": "architecture" + } + }, + "KernelId": { + "target": "com.amazonaws.ec2#KernelId", + "traits": { + "aws.protocols#ec2QueryName": "KernelId", + "smithy.api#documentation": "

The ID of the kernel.

", + "smithy.api#xmlName": "kernelId" + } + }, + "RamdiskId": { + "target": "com.amazonaws.ec2#RamdiskId", + "traits": { + "aws.protocols#ec2QueryName": "RamdiskId", + "smithy.api#documentation": "

The ID of the RAM disk.

", + "smithy.api#xmlName": "ramdiskId" + } + }, + "RootDeviceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RootDeviceName", + "smithy.api#documentation": "

The device name of the root device volume (for example, /dev/sda1).

", + "smithy.api#xmlName": "rootDeviceName" + } + }, + "BlockDeviceMappings": { + "target": "com.amazonaws.ec2#BlockDeviceMappingRequestList", + "traits": { + "smithy.api#documentation": "

The block device mapping entries.

\n

If you specify an Amazon EBS volume using the ID of an Amazon EBS snapshot, you can't specify the\n encryption state of the volume.

\n

If you create an AMI on an Outpost, then all backing snapshots must be on the same Outpost\n or in the Region of that Outpost. AMIs on an Outpost that include local snapshots can be used\n to launch instances on the same Outpost only. For more information, Amazon EBS local\n snapshots on Outposts in the Amazon EBS User Guide.

", + "smithy.api#xmlName": "BlockDeviceMapping" + } + }, + "VirtualizationType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VirtualizationType", + "smithy.api#documentation": "

The type of virtualization (hvm | paravirtual).

\n

Default: paravirtual\n

", + "smithy.api#xmlName": "virtualizationType" + } + }, + "SriovNetSupport": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SriovNetSupport", + "smithy.api#documentation": "

Set to simple to enable enhanced networking with the Intel 82599 Virtual\n Function interface for the AMI and any instances that you launch from the AMI.

\n

There is no way to disable sriovNetSupport at this time.

\n

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make\n instances launched from the AMI unreachable.

", + "smithy.api#xmlName": "sriovNetSupport" + } + }, + "EnaSupport": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EnaSupport", + "smithy.api#documentation": "

Set to true to enable enhanced networking with ENA for the AMI and any\n instances that you launch from the AMI.

\n

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make\n instances launched from the AMI unreachable.

", + "smithy.api#xmlName": "enaSupport" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for RegisterImage.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#RegisterImageResult": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the newly registered AMI.

", + "smithy.api#xmlName": "imageId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of RegisterImage.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#RegisterInstanceEventNotificationAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RegisterInstanceEventNotificationAttributesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#RegisterInstanceEventNotificationAttributesResult" + }, + "traits": { + "smithy.api#documentation": "

Registers a set of tag keys to include in scheduled event notifications for your resources. \n \t\t

\n

To remove tags, use DeregisterInstanceEventNotificationAttributes.

" + } + }, + "com.amazonaws.ec2#RegisterInstanceEventNotificationAttributesRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "InstanceTagAttribute": { + "target": "com.amazonaws.ec2#RegisterInstanceTagAttributeRequest", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Information about the tag keys to register.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#RegisterInstanceEventNotificationAttributesResult": { + "type": "structure", + "members": { + "InstanceTagAttribute": { + "target": "com.amazonaws.ec2#InstanceTagNotificationAttribute", + "traits": { + "aws.protocols#ec2QueryName": "InstanceTagAttribute", + "smithy.api#documentation": "

The resulting set of tag keys.

", + "smithy.api#xmlName": "instanceTagAttribute" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#RegisterInstanceTagAttributeRequest": { + "type": "structure", + "members": { + "IncludeAllTagsOfInstance": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether to register all tag keys in the current Region. Specify true \n \tto register all tag keys.

" + } + }, + "InstanceTagKeys": { + "target": "com.amazonaws.ec2#InstanceTagKeySet", + "traits": { + "smithy.api#documentation": "

The tag keys to register.

", + "smithy.api#xmlName": "InstanceTagKey" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the tag keys to register for the current Region. You can either specify \n \tindividual tag keys or register all tag keys in the current Region. You must specify either\n \tIncludeAllTagsOfInstance or InstanceTagKeys in the request

" + } + }, + "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupMembers": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupMembersRequest" + }, + "output": { + "target": "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupMembersResult" + }, + "traits": { + "smithy.api#documentation": "

Registers members (network interfaces) with the transit gateway multicast group. A member is a network interface associated\n with a supported EC2 instance that receives multicast traffic. For more information, see\n Multicast\n on transit gateways in the Amazon Web Services Transit Gateways Guide.

\n

After you add the members, use SearchTransitGatewayMulticastGroups to verify that the members were added\n to the transit gateway multicast group.

" + } + }, + "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupMembersRequest": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

", + "smithy.api#required": {} + } + }, + "GroupIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IP address assigned to the transit gateway multicast group.

" + } + }, + "NetworkInterfaceIds": { + "target": "com.amazonaws.ec2#TransitGatewayNetworkInterfaceIdList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The group members' network interface IDs to register with the transit gateway multicast group.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupMembersResult": { + "type": "structure", + "members": { + "RegisteredMulticastGroupMembers": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastRegisteredGroupMembers", + "traits": { + "aws.protocols#ec2QueryName": "RegisteredMulticastGroupMembers", + "smithy.api#documentation": "

Information about the registered transit gateway multicast group members.

", + "smithy.api#xmlName": "registeredMulticastGroupMembers" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupSources": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupSourcesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupSourcesResult" + }, + "traits": { + "smithy.api#documentation": "

Registers sources (network interfaces) with the specified transit gateway multicast group.

\n

A multicast source is a network interface attached to a supported instance that sends\n multicast traffic. For more information about supported instances, see Multicast\n on transit gateways in the Amazon Web Services Transit Gateways Guide.

\n

After you add the source, use SearchTransitGatewayMulticastGroups to verify that the source was added to the multicast\n group.

" + } + }, + "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupSourcesRequest": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

", + "smithy.api#required": {} + } + }, + "GroupIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IP address assigned to the transit gateway multicast group.

" + } + }, + "NetworkInterfaceIds": { + "target": "com.amazonaws.ec2#TransitGatewayNetworkInterfaceIdList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The group sources' network interface IDs to register with the transit gateway multicast group.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupSourcesResult": { + "type": "structure", + "members": { + "RegisteredMulticastGroupSources": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastRegisteredGroupSources", + "traits": { + "aws.protocols#ec2QueryName": "RegisteredMulticastGroupSources", + "smithy.api#documentation": "

Information about the transit gateway multicast group sources.

", + "smithy.api#xmlName": "registeredMulticastGroupSources" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#RejectCapacityReservationBillingOwnership": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RejectCapacityReservationBillingOwnershipRequest" + }, + "output": { + "target": "com.amazonaws.ec2#RejectCapacityReservationBillingOwnershipResult" + }, + "traits": { + "smithy.api#documentation": "

Rejects a request to assign billing of the available capacity of a shared Capacity\n\t\t\tReservation to your account. For more information, see Billing assignment for shared\n\t\t\t\t\tAmazon EC2 Capacity Reservations.

" + } + }, + "com.amazonaws.ec2#RejectCapacityReservationBillingOwnershipRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "CapacityReservationId": { + "target": "com.amazonaws.ec2#CapacityReservationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Capacity Reservation for which to reject the request.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#RejectCapacityReservationBillingOwnershipResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#RejectTransitGatewayMulticastDomainAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RejectTransitGatewayMulticastDomainAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#RejectTransitGatewayMulticastDomainAssociationsResult" + }, + "traits": { + "smithy.api#documentation": "

Rejects a request to associate cross-account subnets with a transit gateway multicast domain.

" + } + }, + "com.amazonaws.ec2#RejectTransitGatewayMulticastDomainAssociationsRequest": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainId", + "traits": { + "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

" + } + }, + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#documentation": "

The ID of the transit gateway attachment.

" + } + }, + "SubnetIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the subnets to associate with the transit gateway multicast domain.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#RejectTransitGatewayMulticastDomainAssociationsResult": { + "type": "structure", + "members": { + "Associations": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainAssociations", + "traits": { + "aws.protocols#ec2QueryName": "Associations", + "smithy.api#documentation": "

Information about the multicast domain associations.

", + "smithy.api#xmlName": "associations" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#RejectTransitGatewayPeeringAttachment": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RejectTransitGatewayPeeringAttachmentRequest" + }, + "output": { + "target": "com.amazonaws.ec2#RejectTransitGatewayPeeringAttachmentResult" + }, + "traits": { + "smithy.api#documentation": "

Rejects a transit gateway peering attachment request.

" + } + }, + "com.amazonaws.ec2#RejectTransitGatewayPeeringAttachmentRequest": { + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway peering attachment.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#RejectTransitGatewayPeeringAttachmentResult": { + "type": "structure", + "members": { + "TransitGatewayPeeringAttachment": { + "target": "com.amazonaws.ec2#TransitGatewayPeeringAttachment", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayPeeringAttachment", + "smithy.api#documentation": "

The transit gateway peering attachment.

", + "smithy.api#xmlName": "transitGatewayPeeringAttachment" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#RejectTransitGatewayVpcAttachment": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RejectTransitGatewayVpcAttachmentRequest" + }, + "output": { + "target": "com.amazonaws.ec2#RejectTransitGatewayVpcAttachmentResult" + }, + "traits": { + "smithy.api#documentation": "

Rejects a request to attach a VPC to a transit gateway.

\n

The VPC attachment must be in the pendingAcceptance state.\n Use DescribeTransitGatewayVpcAttachments to view your pending VPC attachment requests.\n Use AcceptTransitGatewayVpcAttachment to accept a VPC attachment request.

" + } + }, + "com.amazonaws.ec2#RejectTransitGatewayVpcAttachmentRequest": { + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the attachment.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#RejectTransitGatewayVpcAttachmentResult": { + "type": "structure", + "members": { + "TransitGatewayVpcAttachment": { + "target": "com.amazonaws.ec2#TransitGatewayVpcAttachment", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayVpcAttachment", + "smithy.api#documentation": "

Information about the attachment.

", + "smithy.api#xmlName": "transitGatewayVpcAttachment" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#RejectVpcEndpointConnections": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RejectVpcEndpointConnectionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#RejectVpcEndpointConnectionsResult" + }, + "traits": { + "smithy.api#documentation": "

Rejects VPC endpoint connection requests to your VPC endpoint service.

" + } + }, + "com.amazonaws.ec2#RejectVpcEndpointConnectionsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ServiceId": { + "target": "com.amazonaws.ec2#VpcEndpointServiceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the service.

", + "smithy.api#required": {} + } + }, + "VpcEndpointIds": { + "target": "com.amazonaws.ec2#VpcEndpointIdList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the VPC endpoints.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "VpcEndpointId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#RejectVpcEndpointConnectionsResult": { + "type": "structure", + "members": { + "Unsuccessful": { + "target": "com.amazonaws.ec2#UnsuccessfulItemSet", + "traits": { + "aws.protocols#ec2QueryName": "Unsuccessful", + "smithy.api#documentation": "

Information about the endpoints that were not rejected, if applicable.

", + "smithy.api#xmlName": "unsuccessful" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#RejectVpcPeeringConnection": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RejectVpcPeeringConnectionRequest" + }, + "output": { + "target": "com.amazonaws.ec2#RejectVpcPeeringConnectionResult" + }, + "traits": { + "smithy.api#documentation": "

Rejects a VPC peering connection request. The VPC peering connection must be in the\n\t\t\t\tpending-acceptance state. Use the DescribeVpcPeeringConnections request\n\t\t\tto view your outstanding VPC peering connection requests. To delete an active VPC peering\n\t\t\tconnection, or to delete a VPC peering connection request that you initiated, use\tDeleteVpcPeeringConnection.

" + } + }, + "com.amazonaws.ec2#RejectVpcPeeringConnectionRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "VpcPeeringConnectionId": { + "target": "com.amazonaws.ec2#VpcPeeringConnectionId", + "traits": { + "aws.protocols#ec2QueryName": "VpcPeeringConnectionId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC peering connection.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "vpcPeeringConnectionId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#RejectVpcPeeringConnectionResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ReleaseAddress": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ReleaseAddressRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Releases the specified Elastic IP address.

\n

[Default VPC] Releasing an Elastic IP address automatically disassociates it\n\t\t\t\tfrom any instance that it's associated with. To disassociate an Elastic IP address without\n\t\t\t\treleasing it, use DisassociateAddress.

\n

[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address\n\t\t\t before you can release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse).

\n

After releasing an Elastic IP address, it is released to the IP address pool. \n Be sure to update your DNS records and any servers or devices that communicate with the address. \n If you attempt to release an Elastic IP address that you already released, you'll get an\n AuthFailure error if the address is already allocated to another Amazon Web Services account.

\n

After you release an Elastic IP address, you might be able to recover it.\n For more information, see AllocateAddress.

", + "smithy.api#examples": [ + { + "title": "To release an Elastic IP address", + "documentation": "This example releases the specified Elastic IP address.", + "input": { + "AllocationId": "eipalloc-64d5890a" + } + } + ] + } + }, + "com.amazonaws.ec2#ReleaseAddressRequest": { + "type": "structure", + "members": { + "AllocationId": { + "target": "com.amazonaws.ec2#AllocationId", + "traits": { + "smithy.api#documentation": "

The allocation ID. This parameter is required.

" + } + }, + "PublicIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Deprecated.

" + } + }, + "NetworkBorderGroup": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises\n IP addresses.

\n

If you provide an incorrect network border group, you receive an InvalidAddress.NotFound error.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ReleaseHosts": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ReleaseHostsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ReleaseHostsResult" + }, + "traits": { + "smithy.api#documentation": "

When you no longer want to use an On-Demand Dedicated Host it can be released.\n On-Demand billing is stopped and the host goes into released state. The\n host ID of Dedicated Hosts that have been released can no longer be specified in another\n request, for example, to modify the host. You must stop or terminate all instances on a\n host before it can be released.

\n

When Dedicated Hosts are released, it may take some time for them to stop counting\n toward your limit and you may receive capacity errors when trying to allocate new\n Dedicated Hosts. Wait a few minutes and then try again.

\n

Released hosts still appear in a DescribeHosts response.

" + } + }, + "com.amazonaws.ec2#ReleaseHostsRequest": { + "type": "structure", + "members": { + "HostIds": { + "target": "com.amazonaws.ec2#RequestHostIdList", + "traits": { + "aws.protocols#ec2QueryName": "HostId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the Dedicated Hosts to release.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "hostId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ReleaseHostsResult": { + "type": "structure", + "members": { + "Successful": { + "target": "com.amazonaws.ec2#ResponseHostIdList", + "traits": { + "aws.protocols#ec2QueryName": "Successful", + "smithy.api#documentation": "

The IDs of the Dedicated Hosts that were successfully released.

", + "smithy.api#xmlName": "successful" + } + }, + "Unsuccessful": { + "target": "com.amazonaws.ec2#UnsuccessfulItemList", + "traits": { + "aws.protocols#ec2QueryName": "Unsuccessful", + "smithy.api#documentation": "

The IDs of the Dedicated Hosts that could not be released, including an error\n message.

", + "smithy.api#xmlName": "unsuccessful" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ReleaseIpamPoolAllocation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ReleaseIpamPoolAllocationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ReleaseIpamPoolAllocationResult" + }, + "traits": { + "smithy.api#documentation": "

Release an allocation within an IPAM pool. The Region you use should be the IPAM pool locale. The locale is the Amazon Web Services Region where this IPAM pool is available for allocations. You can only use this action to release manual allocations. To remove an allocation for a resource without deleting the resource, set its monitored state to false using ModifyIpamResourceCidr. For more information, see Release an allocation in the Amazon VPC IPAM User Guide.\n

\n \n

All EC2 API actions follow an eventual consistency model.

\n " + } + }, + "com.amazonaws.ec2#ReleaseIpamPoolAllocationRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the IPAM pool which contains the allocation you want to release.

", + "smithy.api#required": {} + } + }, + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The CIDR of the allocation you want to release.

", + "smithy.api#required": {} + } + }, + "IpamPoolAllocationId": { + "target": "com.amazonaws.ec2#IpamPoolAllocationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the allocation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ReleaseIpamPoolAllocationResult": { + "type": "structure", + "members": { + "Success": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Success", + "smithy.api#documentation": "

Indicates if the release was successful.

", + "smithy.api#xmlName": "success" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#RemoveIpamOperatingRegion": { + "type": "structure", + "members": { + "RegionName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the operating Region you want to remove.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Remove an operating Region from an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

\n

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide\n

" + } + }, + "com.amazonaws.ec2#RemoveIpamOperatingRegionSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#RemoveIpamOperatingRegion" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.ec2#RemoveIpamOrganizationalUnitExclusion": { + "type": "structure", + "members": { + "OrganizationsEntityPath": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

An Amazon Web Services Organizations entity path. Build the path for the OU(s) using Amazon Web Services Organizations IDs separated by a /. Include all child OUs by ending the path with /*.

\n \n

For more information on how to construct an entity path, see Understand the Amazon Web Services Organizations entity path in the Amazon Web Services Identity and Access Management User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Remove an Organizational Unit (OU) exclusion to your IPAM. If your IPAM is integrated with Amazon Web Services Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion. There is a limit on the number of exclusions you can create. For more information, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.

" + } + }, + "com.amazonaws.ec2#RemoveIpamOrganizationalUnitExclusionSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#RemoveIpamOrganizationalUnitExclusion" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.ec2#RemovePrefixListEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#RemovePrefixListEntry" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.ec2#RemovePrefixListEntry": { + "type": "structure", + "members": { + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The CIDR block.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An entry for a prefix list.

" + } + }, + "com.amazonaws.ec2#ReplaceIamInstanceProfileAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ReplaceIamInstanceProfileAssociationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ReplaceIamInstanceProfileAssociationResult" + }, + "traits": { + "smithy.api#documentation": "

Replaces an IAM instance profile for the specified running instance. You can use\n this action to change the IAM instance profile that's associated with an instance\n without having to disassociate the existing IAM instance profile first.

\n

Use DescribeIamInstanceProfileAssociations to get the association\n ID.

" + } + }, + "com.amazonaws.ec2#ReplaceIamInstanceProfileAssociationRequest": { + "type": "structure", + "members": { + "IamInstanceProfile": { + "target": "com.amazonaws.ec2#IamInstanceProfileSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IAM instance profile.

", + "smithy.api#required": {} + } + }, + "AssociationId": { + "target": "com.amazonaws.ec2#IamInstanceProfileAssociationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the existing IAM instance profile association.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ReplaceIamInstanceProfileAssociationResult": { + "type": "structure", + "members": { + "IamInstanceProfileAssociation": { + "target": "com.amazonaws.ec2#IamInstanceProfileAssociation", + "traits": { + "aws.protocols#ec2QueryName": "IamInstanceProfileAssociation", + "smithy.api#documentation": "

Information about the IAM instance profile association.

", + "smithy.api#xmlName": "iamInstanceProfileAssociation" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ReplaceImageCriteriaInAllowedImagesSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ReplaceImageCriteriaInAllowedImagesSettingsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ReplaceImageCriteriaInAllowedImagesSettingsResult" + }, + "traits": { + "smithy.api#documentation": "

Sets or replaces the criteria for Allowed AMIs.

\n \n

The Allowed AMIs feature does not restrict the AMIs owned by your account. Regardless of\n the criteria you set, the AMIs created by your account will always be discoverable and\n usable by users in your account.

\n \n

For more information, see Control the discovery and use of AMIs in\n Amazon EC2 with Allowed AMIs in\n Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#ReplaceImageCriteriaInAllowedImagesSettingsRequest": { + "type": "structure", + "members": { + "ImageCriteria": { + "target": "com.amazonaws.ec2#ImageCriterionRequestList", + "traits": { + "smithy.api#documentation": "

The list of criteria that are evaluated to determine whether AMIs are discoverable and\n usable in the account in the specified Amazon Web Services Region.

", + "smithy.api#xmlName": "ImageCriterion" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ReplaceImageCriteriaInAllowedImagesSettingsResult": { + "type": "structure", + "members": { + "ReturnValue": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ReplaceNetworkAclAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ReplaceNetworkAclAssociationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ReplaceNetworkAclAssociationResult" + }, + "traits": { + "smithy.api#documentation": "

Changes which network ACL a subnet is associated with. By default when you create a\n\t\t\tsubnet, it's automatically associated with the default network ACL. For more\n\t\t\tinformation, see Network ACLs in the Amazon VPC User Guide.

\n

This is an idempotent operation.

", + "smithy.api#examples": [ + { + "title": "To replace the network ACL associated with a subnet", + "documentation": "This example associates the specified network ACL with the subnet for the specified network ACL association.", + "input": { + "AssociationId": "aclassoc-e5b95c8c", + "NetworkAclId": "acl-5fb85d36" + }, + "output": { + "NewAssociationId": "aclassoc-3999875b" + } + } + ] + } + }, + "com.amazonaws.ec2#ReplaceNetworkAclAssociationRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "AssociationId": { + "target": "com.amazonaws.ec2#NetworkAclAssociationId", + "traits": { + "aws.protocols#ec2QueryName": "AssociationId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the current association between the original network ACL and the subnet.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "associationId" + } + }, + "NetworkAclId": { + "target": "com.amazonaws.ec2#NetworkAclId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkAclId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the new network ACL to associate with the subnet.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "networkAclId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ReplaceNetworkAclAssociationResult": { + "type": "structure", + "members": { + "NewAssociationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NewAssociationId", + "smithy.api#documentation": "

The ID of the new association.

", + "smithy.api#xmlName": "newAssociationId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ReplaceNetworkAclEntry": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ReplaceNetworkAclEntryRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Replaces an entry (rule) in a network ACL. For more information, see Network ACLs in the\n\t\t\t\tAmazon VPC User Guide.

", + "smithy.api#examples": [ + { + "title": "To replace a network ACL entry", + "documentation": "This example replaces an entry for the specified network ACL. The new rule 100 allows ingress traffic from 203.0.113.12/24 on UDP port 53 (DNS) into any associated subnet.", + "input": { + "NetworkAclId": "acl-5fb85d36", + "RuleNumber": 100, + "Protocol": "17", + "RuleAction": "allow", + "Egress": false, + "CidrBlock": "203.0.113.12/24", + "PortRange": { + "From": 53, + "To": 53 + } + } + } + ] + } + }, + "com.amazonaws.ec2#ReplaceNetworkAclEntryRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "NetworkAclId": { + "target": "com.amazonaws.ec2#NetworkAclId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkAclId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the ACL.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "networkAclId" + } + }, + "RuleNumber": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "RuleNumber", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The rule number of the entry to replace.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "ruleNumber" + } + }, + "Protocol": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Protocol", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The protocol number. A value of \"-1\" means all protocols. If you specify \"-1\" or a\n protocol number other than \"6\" (TCP), \"17\" (UDP), or \"1\" (ICMP), traffic on all ports is \n allowed, regardless of any ports or ICMP types or codes that you specify. If you specify \n protocol \"58\" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and \n codes allowed, regardless of any that you specify. If you specify protocol \"58\" (ICMPv6) \n and specify an IPv6 CIDR block, you must specify an ICMP type and code.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "protocol" + } + }, + "RuleAction": { + "target": "com.amazonaws.ec2#RuleAction", + "traits": { + "aws.protocols#ec2QueryName": "RuleAction", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Indicates whether to allow or deny the traffic that matches the rule.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "ruleAction" + } + }, + "Egress": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Egress", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Indicates whether to replace the egress rule.

\n

Default: If no value is specified, we replace the ingress rule.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "egress" + } + }, + "CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CidrBlock", + "smithy.api#documentation": "

The IPv4 network range to allow or deny, in CIDR notation (for example\n 172.16.0.0/24).

", + "smithy.api#xmlName": "cidrBlock" + } + }, + "Ipv6CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6CidrBlock", + "smithy.api#documentation": "

The IPv6 network range to allow or deny, in CIDR notation (for example\n 2001:bd8:1234:1a00::/64).

", + "smithy.api#xmlName": "ipv6CidrBlock" + } + }, + "IcmpTypeCode": { + "target": "com.amazonaws.ec2#IcmpTypeCode", + "traits": { + "smithy.api#documentation": "

ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol\n\t\t 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.

", + "smithy.api#xmlName": "Icmp" + } + }, + "PortRange": { + "target": "com.amazonaws.ec2#PortRange", + "traits": { + "aws.protocols#ec2QueryName": "PortRange", + "smithy.api#documentation": "

TCP or UDP protocols: The range of ports the rule applies to. \n\t\t Required if specifying protocol 6 (TCP) or 17 (UDP).

", + "smithy.api#xmlName": "portRange" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ReplaceRootVolumeTask": { + "type": "structure", + "members": { + "ReplaceRootVolumeTaskId": { + "target": "com.amazonaws.ec2#ReplaceRootVolumeTaskId", + "traits": { + "aws.protocols#ec2QueryName": "ReplaceRootVolumeTaskId", + "smithy.api#documentation": "

The ID of the root volume replacement task.

", + "smithy.api#xmlName": "replaceRootVolumeTaskId" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance for which the root volume replacement task was created.

", + "smithy.api#xmlName": "instanceId" + } + }, + "TaskState": { + "target": "com.amazonaws.ec2#ReplaceRootVolumeTaskState", + "traits": { + "aws.protocols#ec2QueryName": "TaskState", + "smithy.api#documentation": "

The state of the task. The task can be in one of the following states:

\n ", + "smithy.api#xmlName": "taskState" + } + }, + "StartTime": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StartTime", + "smithy.api#documentation": "

The time the task was started.

", + "smithy.api#xmlName": "startTime" + } + }, + "CompleteTime": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CompleteTime", + "smithy.api#documentation": "

The time the task completed.

", + "smithy.api#xmlName": "completeTime" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the task.

", + "smithy.api#xmlName": "tagSet" + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the AMI used to create the replacement root volume.

", + "smithy.api#xmlName": "imageId" + } + }, + "SnapshotId": { + "target": "com.amazonaws.ec2#SnapshotId", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The ID of the snapshot used to create the replacement root volume.

", + "smithy.api#xmlName": "snapshotId" + } + }, + "DeleteReplacedRootVolume": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DeleteReplacedRootVolume", + "smithy.api#documentation": "

Indicates whether the original root volume is to be deleted after the root volume \n replacement task completes.

", + "smithy.api#xmlName": "deleteReplacedRootVolume" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a root volume replacement task.

" + } + }, + "com.amazonaws.ec2#ReplaceRootVolumeTaskId": { + "type": "string" + }, + "com.amazonaws.ec2#ReplaceRootVolumeTaskIds": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ReplaceRootVolumeTaskId", + "traits": { + "smithy.api#xmlName": "ReplaceRootVolumeTaskId" + } + } + }, + "com.amazonaws.ec2#ReplaceRootVolumeTaskState": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "in-progress" + } + }, + "failing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failing" + } + }, + "succeeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "succeeded" + } + }, + "failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + }, + "failed_detached": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed-detached" + } + } + } + }, + "com.amazonaws.ec2#ReplaceRootVolumeTasks": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ReplaceRootVolumeTask", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ReplaceRoute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ReplaceRouteRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Replaces an existing route within a route table in a VPC.

\n

You must specify either a destination CIDR block or a prefix list ID. You must also specify \n exactly one of the resources from the parameter list, or reset the local route to its default \n target.

\n

For more information, see Route tables in the\n Amazon VPC User Guide.

", + "smithy.api#examples": [ + { + "title": "To replace a route", + "documentation": "This example replaces the specified route in the specified table table. The new route matches the specified CIDR and sends the traffic to the specified virtual private gateway.", + "input": { + "RouteTableId": "rtb-22574640", + "DestinationCidrBlock": "10.0.0.0/16", + "GatewayId": "vgw-9a4cacf3" + } + } + ] + } + }, + "com.amazonaws.ec2#ReplaceRouteRequest": { + "type": "structure", + "members": { + "DestinationPrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the prefix list for the route.

" + } + }, + "VpcEndpointId": { + "target": "com.amazonaws.ec2#VpcEndpointId", + "traits": { + "smithy.api#documentation": "

The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.

" + } + }, + "LocalTarget": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether to reset the local route to its default target (local).

" + } + }, + "TransitGatewayId": { + "target": "com.amazonaws.ec2#TransitGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of a transit gateway.

" + } + }, + "LocalGatewayId": { + "target": "com.amazonaws.ec2#LocalGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the local gateway.

" + } + }, + "CarrierGatewayId": { + "target": "com.amazonaws.ec2#CarrierGatewayId", + "traits": { + "smithy.api#documentation": "

[IPv4 traffic only] The ID of a carrier gateway.

" + } + }, + "CoreNetworkArn": { + "target": "com.amazonaws.ec2#CoreNetworkArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the core network.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "RouteTableId": { + "target": "com.amazonaws.ec2#RouteTableId", + "traits": { + "aws.protocols#ec2QueryName": "RouteTableId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the route table.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "routeTableId" + } + }, + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationCidrBlock", + "smithy.api#documentation": "

The IPv4 CIDR address block used for the destination match. The value that you\n\t\t\tprovide must match the CIDR of an existing route in the table.

", + "smithy.api#xmlName": "destinationCidrBlock" + } + }, + "GatewayId": { + "target": "com.amazonaws.ec2#RouteGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "GatewayId", + "smithy.api#documentation": "

The ID of an internet gateway or virtual private gateway.

", + "smithy.api#xmlName": "gatewayId" + } + }, + "DestinationIpv6CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationIpv6CidrBlock", + "smithy.api#documentation": "

The IPv6 CIDR address block used for the destination match. The value that you\n\t\t\tprovide must match the CIDR of an existing route in the table.

", + "smithy.api#xmlName": "destinationIpv6CidrBlock" + } + }, + "EgressOnlyInternetGatewayId": { + "target": "com.amazonaws.ec2#EgressOnlyInternetGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "EgressOnlyInternetGatewayId", + "smithy.api#documentation": "

[IPv6 traffic only] The ID of an egress-only internet gateway.

", + "smithy.api#xmlName": "egressOnlyInternetGatewayId" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of a NAT instance in your VPC.

", + "smithy.api#xmlName": "instanceId" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of a network interface.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "VpcPeeringConnectionId": { + "target": "com.amazonaws.ec2#VpcPeeringConnectionId", + "traits": { + "aws.protocols#ec2QueryName": "VpcPeeringConnectionId", + "smithy.api#documentation": "

The ID of a VPC peering connection.

", + "smithy.api#xmlName": "vpcPeeringConnectionId" + } + }, + "NatGatewayId": { + "target": "com.amazonaws.ec2#NatGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "NatGatewayId", + "smithy.api#documentation": "

[IPv4 traffic only] The ID of a NAT gateway.

", + "smithy.api#xmlName": "natGatewayId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ReplaceRouteTableAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ReplaceRouteTableAssociationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ReplaceRouteTableAssociationResult" + }, + "traits": { + "smithy.api#documentation": "

Changes the route table associated with a given subnet, internet gateway, or virtual private gateway in a VPC. After the operation\n completes, the subnet or gateway uses the routes in the new route table. For more\n information about route tables, see Route\n tables in the Amazon VPC User Guide.

\n

You can also use this operation to change which table is the main route table in the VPC. Specify the main route table's association ID and the route table ID of the new main route table.

", + "smithy.api#examples": [ + { + "title": "To replace the route table associated with a subnet", + "documentation": "This example associates the specified route table with the subnet for the specified route table association.", + "input": { + "AssociationId": "rtbassoc-781d0d1a", + "RouteTableId": "rtb-22574640" + }, + "output": { + "NewAssociationId": "rtbassoc-3a1f0f58" + } + } + ] + } + }, + "com.amazonaws.ec2#ReplaceRouteTableAssociationRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "AssociationId": { + "target": "com.amazonaws.ec2#RouteTableAssociationId", + "traits": { + "aws.protocols#ec2QueryName": "AssociationId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The association ID.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "associationId" + } + }, + "RouteTableId": { + "target": "com.amazonaws.ec2#RouteTableId", + "traits": { + "aws.protocols#ec2QueryName": "RouteTableId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the new route table to associate with the subnet.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "routeTableId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ReplaceRouteTableAssociationResult": { + "type": "structure", + "members": { + "NewAssociationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NewAssociationId", + "smithy.api#documentation": "

The ID of the new association.

", + "smithy.api#xmlName": "newAssociationId" + } + }, + "AssociationState": { + "target": "com.amazonaws.ec2#RouteTableAssociationState", + "traits": { + "aws.protocols#ec2QueryName": "AssociationState", + "smithy.api#documentation": "

The state of the association.

", + "smithy.api#xmlName": "associationState" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ReplaceTransitGatewayRoute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ReplaceTransitGatewayRouteRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ReplaceTransitGatewayRouteResult" + }, + "traits": { + "smithy.api#documentation": "

Replaces the specified route in the specified transit gateway route table.

" + } + }, + "com.amazonaws.ec2#ReplaceTransitGatewayRouteRequest": { + "type": "structure", + "members": { + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The CIDR range used for the destination match. Routing decisions are based on the most specific match.

", + "smithy.api#required": {} + } + }, + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the route table.

", + "smithy.api#required": {} + } + }, + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#documentation": "

The ID of the attachment.

" + } + }, + "Blackhole": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether traffic matching this route is to be dropped.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ReplaceTransitGatewayRouteResult": { + "type": "structure", + "members": { + "Route": { + "target": "com.amazonaws.ec2#TransitGatewayRoute", + "traits": { + "aws.protocols#ec2QueryName": "Route", + "smithy.api#documentation": "

Information about the modified route.

", + "smithy.api#xmlName": "route" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ReplaceVpnTunnel": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ReplaceVpnTunnelRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ReplaceVpnTunnelResult" + }, + "traits": { + "smithy.api#documentation": "

Trigger replacement of specified VPN tunnel.

" + } + }, + "com.amazonaws.ec2#ReplaceVpnTunnelRequest": { + "type": "structure", + "members": { + "VpnConnectionId": { + "target": "com.amazonaws.ec2#VpnConnectionId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Site-to-Site VPN connection.

", + "smithy.api#required": {} + } + }, + "VpnTunnelOutsideIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The external IP address of the VPN tunnel.

", + "smithy.api#required": {} + } + }, + "ApplyPendingMaintenance": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Trigger pending tunnel endpoint maintenance.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ReplaceVpnTunnelResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Confirmation of replace tunnel operation.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ReplacementStrategy": { + "type": "enum", + "members": { + "LAUNCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "launch" + } + }, + "LAUNCH_BEFORE_TERMINATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "launch-before-terminate" + } + } + } + }, + "com.amazonaws.ec2#ReportInstanceReasonCodes": { + "type": "enum", + "members": { + "instance_stuck_in_state": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "instance-stuck-in-state" + } + }, + "unresponsive": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unresponsive" + } + }, + "not_accepting_credentials": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "not-accepting-credentials" + } + }, + "password_not_available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "password-not-available" + } + }, + "performance_network": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "performance-network" + } + }, + "performance_instance_store": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "performance-instance-store" + } + }, + "performance_ebs_volume": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "performance-ebs-volume" + } + }, + "performance_other": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "performance-other" + } + }, + "other": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "other" + } + } + } + }, + "com.amazonaws.ec2#ReportInstanceStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ReportInstanceStatusRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Submits feedback about the status of an instance. The instance must be in the\n running state. If your experience with the instance differs from the\n instance status returned by DescribeInstanceStatus, use ReportInstanceStatus to report your experience with the instance. Amazon\n EC2 collects this information to improve the accuracy of status checks.

\n

Use of this action does not change the value returned by DescribeInstanceStatus.

" + } + }, + "com.amazonaws.ec2#ReportInstanceStatusRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "Instances": { + "target": "com.amazonaws.ec2#InstanceIdStringList", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The instances.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "instanceId" + } + }, + "Status": { + "target": "com.amazonaws.ec2#ReportStatusType", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of all instances listed.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "status" + } + }, + "StartTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "StartTime", + "smithy.api#documentation": "

The time at which the reported instance health state began.

", + "smithy.api#xmlName": "startTime" + } + }, + "EndTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "EndTime", + "smithy.api#documentation": "

The time at which the reported instance health state ended.

", + "smithy.api#xmlName": "endTime" + } + }, + "ReasonCodes": { + "target": "com.amazonaws.ec2#ReasonCodesList", + "traits": { + "aws.protocols#ec2QueryName": "ReasonCode", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The reason codes that describe the health state of your instance.

\n ", + "smithy.api#required": {}, + "smithy.api#xmlName": "reasonCode" + } + }, + "Description": { + "target": "com.amazonaws.ec2#ReportInstanceStatusRequestDescription", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#deprecated": { + "message": "This member has been deprecated" + }, + "smithy.api#documentation": "

Descriptive text about the health state of your instance.

", + "smithy.api#xmlName": "description" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ReportInstanceStatusRequestDescription": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.ec2#ReportState": { + "type": "enum", + "members": { + "running": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "running" + } + }, + "cancelled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cancelled" + } + }, + "complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "complete" + } + }, + "error": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "error" + } + } + } + }, + "com.amazonaws.ec2#ReportStatusType": { + "type": "enum", + "members": { + "ok": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ok" + } + }, + "impaired": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "impaired" + } + } + } + }, + "com.amazonaws.ec2#RequestFilterPortRange": { + "type": "structure", + "members": { + "FromPort": { + "target": "com.amazonaws.ec2#Port", + "traits": { + "smithy.api#documentation": "

The first port in the range.

" + } + }, + "ToPort": { + "target": "com.amazonaws.ec2#Port", + "traits": { + "smithy.api#documentation": "

The last port in the range.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a port range.

" + } + }, + "com.amazonaws.ec2#RequestHostIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#DedicatedHostId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#RequestHostIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#DedicatedHostId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#RequestInstanceTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceType" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.ec2#RequestIpamResourceTag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

" + } + }, + "Value": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The value for the tag.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A tag on an IPAM resource.

" + } + }, + "com.amazonaws.ec2#RequestIpamResourceTagList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#RequestIpamResourceTag", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#RequestLaunchTemplateData": { + "type": "structure", + "members": { + "KernelId": { + "target": "com.amazonaws.ec2#KernelId", + "traits": { + "smithy.api#documentation": "

The ID of the kernel.

\n \n

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see User provided\n kernels in the Amazon EC2 User Guide.

\n " + } + }, + "EbsOptimized": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the instance is optimized for Amazon EBS I/O. This optimization\n provides dedicated throughput to Amazon EBS and an optimized configuration stack to\n provide optimal Amazon EBS I/O performance. This optimization isn't available with all\n instance types. Additional usage charges apply when using an EBS-optimized\n instance.

" + } + }, + "IamInstanceProfile": { + "target": "com.amazonaws.ec2#LaunchTemplateIamInstanceProfileSpecificationRequest", + "traits": { + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of an IAM instance profile.

" + } + }, + "BlockDeviceMappings": { + "target": "com.amazonaws.ec2#LaunchTemplateBlockDeviceMappingRequestList", + "traits": { + "smithy.api#documentation": "

The block device mapping.

", + "smithy.api#xmlName": "BlockDeviceMapping" + } + }, + "NetworkInterfaces": { + "target": "com.amazonaws.ec2#LaunchTemplateInstanceNetworkInterfaceSpecificationRequestList", + "traits": { + "smithy.api#documentation": "

The network interfaces for the instance.

", + "smithy.api#xmlName": "NetworkInterface" + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#documentation": "

The ID of the AMI in the format ami-0ac394d6a3example.

\n

Alternatively, you can specify a Systems Manager parameter, using one of the following\n formats. The Systems Manager parameter will resolve to an AMI ID on launch.

\n

To reference a public parameter:

\n \n

To reference a parameter stored in the same account:

\n \n

To reference a parameter shared from another Amazon Web Services account:

\n \n

For more information, see Use a Systems Manager parameter instead of an AMI ID in the Amazon EC2 User Guide.

\n \n

If the launch template will be used for an EC2 Fleet or Spot Fleet, note the\n following:

\n
    \n
  • \n

    Only EC2 Fleets of type instant support specifying a Systems\n Manager parameter.

    \n
    • \n
  • \n

    For EC2 Fleets of type maintain or request, or\n for Spot Fleets, you must specify the AMI ID.

    \n
    • \n
\n " + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "smithy.api#documentation": "

The instance type. For more information, see Amazon EC2 instance types in\n the Amazon EC2 User Guide.

\n

If you specify InstanceType, you can't specify\n InstanceRequirements.

" + } + }, + "KeyName": { + "target": "com.amazonaws.ec2#KeyPairName", + "traits": { + "smithy.api#documentation": "

The name of the key pair. You can create a key pair using CreateKeyPair or\n ImportKeyPair.

\n \n

If you do not specify a key pair, you can't connect to the instance unless you\n choose an AMI that is configured to allow users another way to log in.

\n " + } + }, + "Monitoring": { + "target": "com.amazonaws.ec2#LaunchTemplatesMonitoringRequest", + "traits": { + "smithy.api#documentation": "

The monitoring for the instance.

" + } + }, + "Placement": { + "target": "com.amazonaws.ec2#LaunchTemplatePlacementRequest", + "traits": { + "smithy.api#documentation": "

The placement for the instance.

" + } + }, + "RamDiskId": { + "target": "com.amazonaws.ec2#RamdiskId", + "traits": { + "smithy.api#documentation": "

The ID of the RAM disk.

\n \n

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see User provided\n kernels in the Amazon EC2 User Guide.

\n " + } + }, + "DisableApiTermination": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

If you set this parameter to true, you can't terminate the instance using\n the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after\n launch, use ModifyInstanceAttribute. Alternatively, if you set\n InstanceInitiatedShutdownBehavior to terminate, you can\n terminate the instance by running the shutdown command from the instance.

" + } + }, + "InstanceInitiatedShutdownBehavior": { + "target": "com.amazonaws.ec2#ShutdownBehavior", + "traits": { + "smithy.api#documentation": "

Indicates whether an instance stops or terminates when you initiate shutdown from the\n instance (using the operating system command for system shutdown).

\n

Default: stop\n

" + } + }, + "UserData": { + "target": "com.amazonaws.ec2#SensitiveUserData", + "traits": { + "smithy.api#documentation": "

The user data to make available to the instance. You must provide base64-encoded text.\n User data is limited to 16 KB. For more information, see Run commands on your Amazon EC2 instance at\n launch in the Amazon EC2 User Guide.

\n

If you are creating the launch template for use with Batch, the user\n data must be provided in the MIME multi-part archive format. For more information, see Amazon EC2 user data in launch templates in the Batch User Guide.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#LaunchTemplateTagSpecificationRequestList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the resources that are created during instance launch. These\n tags are not applied to the launch template.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "ElasticGpuSpecifications": { + "target": "com.amazonaws.ec2#ElasticGpuSpecificationList", + "traits": { + "smithy.api#documentation": "

Deprecated.

\n \n

Amazon Elastic Graphics reached end of life on January 8, 2024. For \n workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, \n G4dn, or G5 instances.

\n ", + "smithy.api#xmlName": "ElasticGpuSpecification" + } + }, + "ElasticInferenceAccelerators": { + "target": "com.amazonaws.ec2#LaunchTemplateElasticInferenceAcceleratorList", + "traits": { + "smithy.api#documentation": "\n

Amazon Elastic Inference is no longer available.

\n \n

An elastic inference accelerator to associate with the instance. Elastic inference\n accelerators are a resource you can attach to your Amazon EC2 instances to accelerate\n your Deep Learning (DL) inference workloads.

\n

You cannot specify accelerators from different generations in the same request.

\n \n

Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon\n Elastic Inference (EI), and will help current customers migrate their workloads to\n options that offer better price and performance. After April 15, 2023, new customers\n will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker,\n Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during\n the past 30-day period are considered current customers and will be able to continue\n using the service.

\n ", + "smithy.api#xmlName": "ElasticInferenceAccelerator" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.ec2#SecurityGroupIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the security groups.

\n

If you specify a network interface, you must specify any security groups as part of \n the network interface instead of using this parameter.

", + "smithy.api#xmlName": "SecurityGroupId" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.ec2#SecurityGroupStringList", + "traits": { + "smithy.api#documentation": "

The names of the security groups. For a nondefault VPC, you must use security group\n IDs instead.

\n

If you specify a network interface, you must specify any security groups as part of \n the network interface instead of using this parameter.

", + "smithy.api#xmlName": "SecurityGroup" + } + }, + "InstanceMarketOptions": { + "target": "com.amazonaws.ec2#LaunchTemplateInstanceMarketOptionsRequest", + "traits": { + "smithy.api#documentation": "

The market (purchasing) option for the instances.

" + } + }, + "CreditSpecification": { + "target": "com.amazonaws.ec2#CreditSpecificationRequest", + "traits": { + "smithy.api#documentation": "

The credit option for CPU usage of the instance. Valid only for T instances.

" + } + }, + "CpuOptions": { + "target": "com.amazonaws.ec2#LaunchTemplateCpuOptionsRequest", + "traits": { + "smithy.api#documentation": "

The CPU options for the instance. For more information, see Optimize CPU options in the Amazon EC2 User Guide.

" + } + }, + "CapacityReservationSpecification": { + "target": "com.amazonaws.ec2#LaunchTemplateCapacityReservationSpecificationRequest", + "traits": { + "smithy.api#documentation": "

The Capacity Reservation targeting option. If you do not specify this parameter, the\n instance's Capacity Reservation preference defaults to open, which enables\n it to run in any open Capacity Reservation that has matching attributes (instance type,\n platform, Availability Zone).

" + } + }, + "LicenseSpecifications": { + "target": "com.amazonaws.ec2#LaunchTemplateLicenseSpecificationListRequest", + "traits": { + "smithy.api#documentation": "

The license configurations.

", + "smithy.api#xmlName": "LicenseSpecification" + } + }, + "HibernationOptions": { + "target": "com.amazonaws.ec2#LaunchTemplateHibernationOptionsRequest", + "traits": { + "smithy.api#documentation": "

Indicates whether an instance is enabled for hibernation. This parameter is valid only\n if the instance meets the hibernation\n prerequisites. For more information, see Hibernate your Amazon EC2 instance\n in the Amazon EC2 User Guide.

" + } + }, + "MetadataOptions": { + "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataOptionsRequest", + "traits": { + "smithy.api#documentation": "

The metadata options for the instance. For more information, see Instance metadata and user data in the\n Amazon EC2 User Guide.

" + } + }, + "EnclaveOptions": { + "target": "com.amazonaws.ec2#LaunchTemplateEnclaveOptionsRequest", + "traits": { + "smithy.api#documentation": "

Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more\n information, see What is Amazon Web Services Nitro Enclaves?\n in the Amazon Web Services Nitro Enclaves User Guide.

\n

You can't enable Amazon Web Services Nitro Enclaves and hibernation on the same instance.

" + } + }, + "InstanceRequirements": { + "target": "com.amazonaws.ec2#InstanceRequirementsRequest", + "traits": { + "smithy.api#documentation": "

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will\n identify instance types with these attributes.

\n

You must specify VCpuCount and MemoryMiB. All other attributes\n are optional. Any unspecified optional attribute is set to its default.

\n

When you specify multiple attributes, you get instance types that satisfy all of the\n specified attributes. If you specify multiple values for an attribute, you get instance\n types that satisfy any of the specified values.

\n

To limit the list of instance types from which Amazon EC2 can identify matching instance types, \n you can use one of the following parameters, but not both in the same request:

\n \n \n

If you specify InstanceRequirements, you can't specify\n InstanceType.

\n

Attribute-based instance type selection is only supported when using Auto Scaling\n groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in\n the launch instance\n wizard, or with the RunInstances API or\n AWS::EC2::Instance Amazon Web Services CloudFormation resource, you can't specify InstanceRequirements.

\n \n

For more information, see Specify attributes for instance type selection for EC2 Fleet or Spot Fleet and Spot\n placement score in the Amazon EC2 User Guide.

" + } + }, + "PrivateDnsNameOptions": { + "target": "com.amazonaws.ec2#LaunchTemplatePrivateDnsNameOptionsRequest", + "traits": { + "smithy.api#documentation": "

The options for the instance hostname. The default values are inherited from the\n subnet.

" + } + }, + "MaintenanceOptions": { + "target": "com.amazonaws.ec2#LaunchTemplateInstanceMaintenanceOptionsRequest", + "traits": { + "smithy.api#documentation": "

The maintenance options for the instance.

" + } + }, + "DisableApiStop": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether to enable the instance for stop protection. For more information,\n see Enable stop protection for your instance in the\n Amazon EC2 User Guide.

" + } + }, + "Operator": { + "target": "com.amazonaws.ec2#OperatorRequest", + "traits": { + "smithy.api#documentation": "

The entity that manages the launch template.

" + } + }, + "NetworkPerformanceOptions": { + "target": "com.amazonaws.ec2#LaunchTemplateNetworkPerformanceOptionsRequest", + "traits": { + "smithy.api#documentation": "

Contains launch template settings to boost network performance for the type of \n \tworkload that runs on your instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The information to include in the launch template.

\n \n

You must specify at least one parameter for the launch template data.

\n " + } + }, + "com.amazonaws.ec2#RequestSpotFleet": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RequestSpotFleetRequest" + }, + "output": { + "target": "com.amazonaws.ec2#RequestSpotFleetResponse" + }, + "traits": { + "smithy.api#documentation": "

Creates a Spot Fleet request.

\n

The Spot Fleet request specifies the total target capacity and the On-Demand target\n capacity. Amazon EC2 calculates the difference between the total capacity and On-Demand\n capacity, and launches the difference as Spot capacity.

\n

You can submit a single request that includes multiple launch specifications that vary\n by instance type, AMI, Availability Zone, or subnet.

\n

By default, the Spot Fleet requests Spot Instances in the Spot Instance pool where the\n price per unit is the lowest. Each launch specification can include its own instance\n weighting that reflects the value of the instance type to your application\n workload.

\n

Alternatively, you can specify that the Spot Fleet distribute the target capacity\n across the Spot pools included in its launch specifications. By ensuring that the Spot\n Instances in your Spot Fleet are in different Spot pools, you can improve the\n availability of your fleet.

\n

You can specify tags for the Spot Fleet request and instances launched by the fleet.\n You cannot tag other resource types in a Spot Fleet request because only the\n spot-fleet-request and instance resource types are\n supported.

\n

For more information, see Spot Fleet requests\n in the Amazon EC2 User Guide.

\n \n

We strongly discourage using the RequestSpotFleet API because it is a legacy\n API with no planned investment. For options for requesting Spot Instances, see\n Which\n is the best Spot request method to use? in the\n Amazon EC2 User Guide.

\n ", + "smithy.api#examples": [ + { + "title": "To request a Spot fleet in the subnet with the lowest price", + "documentation": "This example creates a Spot fleet request with two launch specifications that differ only by subnet. The Spot fleet launches the instances in the specified subnet with the lowest price. If the instances are launched in a default VPC, they receive a public IP address by default. If the instances are launched in a nondefault VPC, they do not receive a public IP address by default. Note that you can't specify different subnets from the same Availability Zone in a Spot fleet request.", + "input": { + "SpotFleetRequestConfig": { + "SpotPrice": "0.04", + "TargetCapacity": 2, + "IamFleetRole": "arn:aws:iam::123456789012:role/my-spot-fleet-role", + "LaunchSpecifications": [ + { + "ImageId": "ami-1a2b3c4d", + "KeyName": "my-key-pair", + "SecurityGroups": [ + { + "GroupId": "sg-1a2b3c4d" + } + ], + "InstanceType": "m3.medium", + "SubnetId": "subnet-1a2b3c4d, subnet-3c4d5e6f", + "IamInstanceProfile": { + "Arn": "arn:aws:iam::123456789012:instance-profile/my-iam-role" + } + } + ] + } + }, + "output": { + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" + } + }, + { + "title": "To request a Spot fleet in the Availability Zone with the lowest price", + "documentation": "This example creates a Spot fleet request with two launch specifications that differ only by Availability Zone. The Spot fleet launches the instances in the specified Availability Zone with the lowest price. If your account supports EC2-VPC only, Amazon EC2 launches the Spot instances in the default subnet of the Availability Zone.", + "input": { + "SpotFleetRequestConfig": { + "SpotPrice": "0.04", + "TargetCapacity": 2, + "IamFleetRole": "arn:aws:iam::123456789012:role/my-spot-fleet-role", + "LaunchSpecifications": [ + { + "ImageId": "ami-1a2b3c4d", + "KeyName": "my-key-pair", + "SecurityGroups": [ + { + "GroupId": "sg-1a2b3c4d" + } + ], + "InstanceType": "m3.medium", + "Placement": { + "AvailabilityZone": "us-west-2a, us-west-2b" + }, + "IamInstanceProfile": { + "Arn": "arn:aws:iam::123456789012:instance-profile/my-iam-role" + } + } + ] + } + }, + "output": { + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" + } + }, + { + "title": "To launch Spot instances in a subnet and assign them public IP addresses", + "documentation": "This example assigns public addresses to instances launched in a nondefault VPC. Note that when you specify a network interface, you must include the subnet ID and security group ID using the network interface.", + "input": { + "SpotFleetRequestConfig": { + "SpotPrice": "0.04", + "TargetCapacity": 2, + "IamFleetRole": "arn:aws:iam::123456789012:role/my-spot-fleet-role", + "LaunchSpecifications": [ + { + "ImageId": "ami-1a2b3c4d", + "KeyName": "my-key-pair", + "InstanceType": "m3.medium", + "NetworkInterfaces": [ + { + "DeviceIndex": 0, + "SubnetId": "subnet-1a2b3c4d", + "Groups": [ + "sg-1a2b3c4d" + ], + "AssociatePublicIpAddress": true + } + ], + "IamInstanceProfile": { + "Arn": "arn:aws:iam::880185128111:instance-profile/my-iam-role" + } + } + ] + } + }, + "output": { + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" + } + }, + { + "title": "To request a Spot fleet using the diversified allocation strategy", + "documentation": "This example creates a Spot fleet request that launches 30 instances using the diversified allocation strategy. The launch specifications differ by instance type. The Spot fleet distributes the instances across the launch specifications such that there are 10 instances of each type.", + "input": { + "SpotFleetRequestConfig": { + "SpotPrice": "0.70", + "TargetCapacity": 30, + "AllocationStrategy": "diversified", + "IamFleetRole": "arn:aws:iam::123456789012:role/my-spot-fleet-role", + "LaunchSpecifications": [ + { + "ImageId": "ami-1a2b3c4d", + "InstanceType": "c4.2xlarge", + "SubnetId": "subnet-1a2b3c4d" + }, + { + "ImageId": "ami-1a2b3c4d", + "InstanceType": "m3.2xlarge", + "SubnetId": "subnet-1a2b3c4d" + }, + { + "ImageId": "ami-1a2b3c4d", + "InstanceType": "r3.2xlarge", + "SubnetId": "subnet-1a2b3c4d" + } + ] + } + }, + "output": { + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" + } + } + ] + } + }, + "com.amazonaws.ec2#RequestSpotFleetRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "SpotFleetRequestConfig": { + "target": "com.amazonaws.ec2#SpotFleetRequestConfigData", + "traits": { + "aws.protocols#ec2QueryName": "SpotFleetRequestConfig", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The configuration for the Spot Fleet request.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "spotFleetRequestConfig" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for RequestSpotFleet.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#RequestSpotFleetResponse": { + "type": "structure", + "members": { + "SpotFleetRequestId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SpotFleetRequestId", + "smithy.api#documentation": "

The ID of the Spot Fleet request.

", + "smithy.api#xmlName": "spotFleetRequestId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of RequestSpotFleet.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#RequestSpotInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RequestSpotInstancesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#RequestSpotInstancesResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a Spot Instance request.

\n

For more information, see Work with Spot Instance in\n the Amazon EC2 User Guide.

\n \n

We strongly discourage using the RequestSpotInstances API because it is a legacy\n API with no planned investment. For options for requesting Spot Instances, see\n Which\n is the best Spot request method to use? in the\n Amazon EC2 User Guide.

\n ", + "smithy.api#examples": [ + { + "title": "To create a one-time Spot Instance request", + "documentation": "This example creates a one-time Spot Instance request for five instances in the specified Availability Zone. If your account supports EC2-VPC only, Amazon EC2 launches the instances in the default subnet of the specified Availability Zone.", + "input": { + "SpotPrice": "0.03", + "InstanceCount": 5, + "Type": "one-time", + "LaunchSpecification": { + "ImageId": "ami-1a2b3c4d", + "KeyName": "my-key-pair", + "SecurityGroupIds": [ + "sg-1a2b3c4d" + ], + "InstanceType": "m3.medium", + "Placement": { + "AvailabilityZone": "us-west-2a" + }, + "IamInstanceProfile": { + "Arn": "arn:aws:iam::123456789012:instance-profile/my-iam-role" + } + } + } + }, + { + "title": "To create a one-time Spot Instance request", + "documentation": "This example command creates a one-time Spot Instance request for five instances in the specified subnet. Amazon EC2 launches the instances in the specified subnet. If the VPC is a nondefault VPC, the instances do not receive a public IP address by default.", + "input": { + "SpotPrice": "0.050", + "InstanceCount": 5, + "Type": "one-time", + "LaunchSpecification": { + "ImageId": "ami-1a2b3c4d", + "SecurityGroupIds": [ + "sg-1a2b3c4d" + ], + "InstanceType": "m3.medium", + "SubnetId": "subnet-1a2b3c4d", + "IamInstanceProfile": { + "Arn": "arn:aws:iam::123456789012:instance-profile/my-iam-role" + } + } + } + } + ] + } + }, + "com.amazonaws.ec2#RequestSpotInstancesRequest": { + "type": "structure", + "members": { + "LaunchSpecification": { + "target": "com.amazonaws.ec2#RequestSpotLaunchSpecification", + "traits": { + "smithy.api#documentation": "

The launch specification.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The key-value pair for tagging the Spot Instance request on creation. The value for\n ResourceType must be spot-instances-request, otherwise the\n Spot Instance request fails. To tag the Spot Instance request after it has been created,\n see CreateTags.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "InstanceInterruptionBehavior": { + "target": "com.amazonaws.ec2#InstanceInterruptionBehavior", + "traits": { + "smithy.api#documentation": "

The behavior when a Spot Instance is interrupted. The default is terminate.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "SpotPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SpotPrice", + "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend \n using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.

\n ", + "smithy.api#xmlName": "spotPrice" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see Ensuring idempotency in\n Amazon EC2 API requests in the Amazon EC2 User Guide.

", + "smithy.api#xmlName": "clientToken" + } + }, + "InstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "InstanceCount", + "smithy.api#documentation": "

The maximum number of Spot Instances to launch.

\n

Default: 1

", + "smithy.api#xmlName": "instanceCount" + } + }, + "Type": { + "target": "com.amazonaws.ec2#SpotInstanceType", + "traits": { + "aws.protocols#ec2QueryName": "Type", + "smithy.api#documentation": "

The Spot Instance request type.

\n

Default: one-time\n

", + "smithy.api#xmlName": "type" + } + }, + "ValidFrom": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "ValidFrom", + "smithy.api#documentation": "

The start date of the request. If this is a one-time request, the request becomes\n active at this date and time and remains active until all instances launch, the request\n expires, or the request is canceled. If the request is persistent, the request becomes\n active at this date and time and remains active until it expires or is canceled.

\n

The specified start date and time cannot be equal to the current date and time. You\n must specify a start date and time that occurs after the current date and time.

", + "smithy.api#xmlName": "validFrom" + } + }, + "ValidUntil": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "ValidUntil", + "smithy.api#documentation": "

The end date of the request, in UTC format\n (YYYY-MM-DDTHH:MM:SSZ).

\n ", + "smithy.api#xmlName": "validUntil" + } + }, + "LaunchGroup": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LaunchGroup", + "smithy.api#documentation": "

The instance launch group. Launch groups are Spot Instances that launch together and\n terminate together.

\n

Default: Instances are launched and terminated individually

", + "smithy.api#xmlName": "launchGroup" + } + }, + "AvailabilityZoneGroup": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZoneGroup", + "smithy.api#documentation": "

The user-specified name for a logical grouping of requests.

\n

When you specify an Availability Zone group in a Spot Instance request, all Spot\n Instances in the request are launched in the same Availability Zone. Instance proximity\n is maintained with this parameter, but the choice of Availability Zone is not. The group\n applies only to requests for Spot Instances of the same instance type. Any additional\n Spot Instance requests that are specified with the same Availability Zone group name are\n launched in that same Availability Zone, as long as at least one instance from the group\n is still active.

\n

If there is no active instance running in the Availability Zone group that you specify\n for a new Spot Instance request (all instances are terminated, the request is expired,\n or the maximum price you specified falls below current Spot price), then Amazon EC2 launches\n the instance in any Availability Zone where the constraint can be met. Consequently, the\n subsequent set of Spot Instances could be placed in a different zone from the original\n request, even if you specified the same Availability Zone group.

\n

Default: Instances are launched in any available Availability Zone.

", + "smithy.api#xmlName": "availabilityZoneGroup" + } + }, + "BlockDurationMinutes": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "BlockDurationMinutes", + "smithy.api#documentation": "

Deprecated.

", + "smithy.api#xmlName": "blockDurationMinutes" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for RequestSpotInstances.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#RequestSpotInstancesResult": { + "type": "structure", + "members": { + "SpotInstanceRequests": { + "target": "com.amazonaws.ec2#SpotInstanceRequestList", + "traits": { + "aws.protocols#ec2QueryName": "SpotInstanceRequestSet", + "smithy.api#documentation": "

The Spot Instance requests.

", + "smithy.api#xmlName": "spotInstanceRequestSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of RequestSpotInstances.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#RequestSpotLaunchSpecification": { + "type": "structure", + "members": { + "SecurityGroupIds": { + "target": "com.amazonaws.ec2#RequestSpotLaunchSpecificationSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the security groups.

", + "smithy.api#xmlName": "SecurityGroupId" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.ec2#RequestSpotLaunchSpecificationSecurityGroupList", + "traits": { + "smithy.api#documentation": "

Not supported.

", + "smithy.api#xmlName": "SecurityGroup" + } + }, + "AddressingType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AddressingType", + "smithy.api#documentation": "

Deprecated.

", + "smithy.api#xmlName": "addressingType" + } + }, + "BlockDeviceMappings": { + "target": "com.amazonaws.ec2#BlockDeviceMappingList", + "traits": { + "aws.protocols#ec2QueryName": "BlockDeviceMapping", + "smithy.api#documentation": "

The block device mapping entries. You can't specify both a snapshot ID and an encryption value. \n This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, \n it is not blank and its encryption status is used for the volume encryption status.

", + "smithy.api#xmlName": "blockDeviceMapping" + } + }, + "EbsOptimized": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EbsOptimized", + "smithy.api#documentation": "

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

\n

Default: false\n

", + "smithy.api#xmlName": "ebsOptimized" + } + }, + "IamInstanceProfile": { + "target": "com.amazonaws.ec2#IamInstanceProfileSpecification", + "traits": { + "aws.protocols#ec2QueryName": "IamInstanceProfile", + "smithy.api#documentation": "

The IAM instance profile.

", + "smithy.api#xmlName": "iamInstanceProfile" + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the AMI.

", + "smithy.api#xmlName": "imageId" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type. Only one instance type can be specified.

", + "smithy.api#xmlName": "instanceType" + } + }, + "KernelId": { + "target": "com.amazonaws.ec2#KernelId", + "traits": { + "aws.protocols#ec2QueryName": "KernelId", + "smithy.api#documentation": "

The ID of the kernel.

", + "smithy.api#xmlName": "kernelId" + } + }, + "KeyName": { + "target": "com.amazonaws.ec2#KeyPairNameWithResolver", + "traits": { + "aws.protocols#ec2QueryName": "KeyName", + "smithy.api#documentation": "

The name of the key pair.

", + "smithy.api#xmlName": "keyName" + } + }, + "Monitoring": { + "target": "com.amazonaws.ec2#RunInstancesMonitoringEnabled", + "traits": { + "aws.protocols#ec2QueryName": "Monitoring", + "smithy.api#documentation": "

Indicates whether basic or detailed monitoring is enabled for the instance.

\n

Default: Disabled

", + "smithy.api#xmlName": "monitoring" + } + }, + "NetworkInterfaces": { + "target": "com.amazonaws.ec2#InstanceNetworkInterfaceSpecificationList", + "traits": { + "smithy.api#documentation": "

The network interfaces. If you specify a network interface, you must specify \n subnet IDs and security group IDs using the network interface.

", + "smithy.api#xmlName": "NetworkInterface" + } + }, + "Placement": { + "target": "com.amazonaws.ec2#SpotPlacement", + "traits": { + "aws.protocols#ec2QueryName": "Placement", + "smithy.api#documentation": "

The placement information for the instance.

", + "smithy.api#xmlName": "placement" + } + }, + "RamdiskId": { + "target": "com.amazonaws.ec2#RamdiskId", + "traits": { + "aws.protocols#ec2QueryName": "RamdiskId", + "smithy.api#documentation": "

The ID of the RAM disk.

", + "smithy.api#xmlName": "ramdiskId" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet in which to launch the instance.

", + "smithy.api#xmlName": "subnetId" + } + }, + "UserData": { + "target": "com.amazonaws.ec2#SensitiveUserData", + "traits": { + "aws.protocols#ec2QueryName": "UserData", + "smithy.api#documentation": "

The base64-encoded user data that instances use when starting up. User data is limited to 16 KB.

", + "smithy.api#xmlName": "userData" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the launch specification for an instance.

" + } + }, + "com.amazonaws.ec2#RequestSpotLaunchSpecificationSecurityGroupIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#RequestSpotLaunchSpecificationSecurityGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Reservation": { + "type": "structure", + "members": { + "ReservationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ReservationId", + "smithy.api#documentation": "

The ID of the reservation.

", + "smithy.api#xmlName": "reservationId" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the reservation.

", + "smithy.api#xmlName": "ownerId" + } + }, + "RequesterId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RequesterId", + "smithy.api#documentation": "

The ID of the requester that launched the instances on your behalf (for example,\n Amazon Web Services Management Console or Auto Scaling).

", + "smithy.api#xmlName": "requesterId" + } + }, + "Groups": { + "target": "com.amazonaws.ec2#GroupIdentifierList", + "traits": { + "aws.protocols#ec2QueryName": "GroupSet", + "smithy.api#documentation": "

Not supported.

", + "smithy.api#xmlName": "groupSet" + } + }, + "Instances": { + "target": "com.amazonaws.ec2#InstanceList", + "traits": { + "aws.protocols#ec2QueryName": "InstancesSet", + "smithy.api#documentation": "

The instances.

", + "smithy.api#xmlName": "instancesSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a launch request for one or more instances, and includes owner, requester,\n and security group information that applies to all instances in the launch\n request.

" + } + }, + "com.amazonaws.ec2#ReservationFleetInstanceSpecification": { + "type": "structure", + "members": { + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "smithy.api#documentation": "

The instance type for which the Capacity Reservation Fleet reserves capacity.

" + } + }, + "InstancePlatform": { + "target": "com.amazonaws.ec2#CapacityReservationInstancePlatform", + "traits": { + "smithy.api#documentation": "

The type of operating system for which the Capacity Reservation Fleet reserves\n\t\t\tcapacity.

" + } + }, + "Weight": { + "target": "com.amazonaws.ec2#DoubleWithConstraints", + "traits": { + "smithy.api#documentation": "

The number of capacity units provided by the specified instance type. This value,\n\t\t\ttogether with the total target capacity that you specify for the Fleet determine the\n\t\t\tnumber of instances for which the Fleet reserves capacity. Both values are based on\n\t\t\tunits that make sense for your workload. For more information, see Total target\n\t\t\t\tcapacity in the Amazon EC2 User Guide.

" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone in which the Capacity Reservation Fleet reserves the capacity. A\n\t\t\tCapacity Reservation Fleet can't span Availability Zones. All instance type\n\t\t\tspecifications that you specify for the Fleet must use the same Availability\n\t\t\tZone.

" + } + }, + "AvailabilityZoneId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ID of the Availability Zone in which the Capacity Reservation Fleet reserves the\n\t\t\tcapacity. A Capacity Reservation Fleet can't span Availability Zones. All instance type\n\t\t\tspecifications that you specify for the Fleet must use the same Availability\n\t\t\tZone.

" + } + }, + "EbsOptimized": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the Capacity Reservation Fleet supports EBS-optimized instances\n\t\t\ttypes. This optimization provides dedicated throughput to Amazon EBS and an\n\t\t\toptimized configuration stack to provide optimal I/O performance. This optimization\n\t\t\tisn't available with all instance types. Additional usage charges apply when using\n\t\t\tEBS-optimized instance types.

" + } + }, + "Priority": { + "target": "com.amazonaws.ec2#IntegerWithConstraints", + "traits": { + "smithy.api#documentation": "

The priority to assign to the instance type. This value is used to determine which of\n\t\t\tthe instance types specified for the Fleet should be prioritized for use. A lower value\n\t\t\tindicates a high priority. For more information, see Instance type\n\t\t\t\tpriority in the Amazon EC2 User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an instance type to use in a Capacity Reservation Fleet.

" + } + }, + "com.amazonaws.ec2#ReservationFleetInstanceSpecificationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ReservationFleetInstanceSpecification" + } + }, + "com.amazonaws.ec2#ReservationId": { + "type": "string" + }, + "com.amazonaws.ec2#ReservationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Reservation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ReservationState": { + "type": "enum", + "members": { + "PAYMENT_PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "payment-pending" + } + }, + "PAYMENT_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "payment-failed" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "RETIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "retired" + } + } + } + }, + "com.amazonaws.ec2#ReservationValue": { + "type": "structure", + "members": { + "HourlyPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "HourlyPrice", + "smithy.api#documentation": "

The hourly rate of the reservation.

", + "smithy.api#xmlName": "hourlyPrice" + } + }, + "RemainingTotalValue": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RemainingTotalValue", + "smithy.api#documentation": "

The balance of the total value (the sum of remainingUpfrontValue + hourlyPrice * number of hours remaining).

", + "smithy.api#xmlName": "remainingTotalValue" + } + }, + "RemainingUpfrontValue": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RemainingUpfrontValue", + "smithy.api#documentation": "

The remaining upfront cost of the reservation.

", + "smithy.api#xmlName": "remainingUpfrontValue" + } + } + }, + "traits": { + "smithy.api#documentation": "

The cost associated with the Reserved Instance.

" + } + }, + "com.amazonaws.ec2#ReservedInstanceIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ReservationId", + "traits": { + "smithy.api#xmlName": "ReservedInstanceId" + } + } + }, + "com.amazonaws.ec2#ReservedInstanceLimitPrice": { + "type": "structure", + "members": { + "Amount": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "Amount", + "smithy.api#documentation": "

Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount * price).

", + "smithy.api#xmlName": "amount" + } + }, + "CurrencyCode": { + "target": "com.amazonaws.ec2#CurrencyCodeValues", + "traits": { + "aws.protocols#ec2QueryName": "CurrencyCode", + "smithy.api#documentation": "

The currency in which the limitPrice amount is specified.\n\t\t\t\tAt this time, the only supported currency is USD.

", + "smithy.api#xmlName": "currencyCode" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the limit price of a Reserved Instance offering.

" + } + }, + "com.amazonaws.ec2#ReservedInstanceReservationValue": { + "type": "structure", + "members": { + "ReservationValue": { + "target": "com.amazonaws.ec2#ReservationValue", + "traits": { + "aws.protocols#ec2QueryName": "ReservationValue", + "smithy.api#documentation": "

The total value of the Convertible Reserved Instance that you are exchanging.

", + "smithy.api#xmlName": "reservationValue" + } + }, + "ReservedInstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstanceId", + "smithy.api#documentation": "

The ID of the Convertible Reserved Instance that you are exchanging.

", + "smithy.api#xmlName": "reservedInstanceId" + } + } + }, + "traits": { + "smithy.api#documentation": "

The total value of the Convertible Reserved Instance.

" + } + }, + "com.amazonaws.ec2#ReservedInstanceReservationValueSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ReservedInstanceReservationValue", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ReservedInstanceState": { + "type": "enum", + "members": { + "payment_pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "payment-pending" + } + }, + "active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "payment_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "payment-failed" + } + }, + "retired": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "retired" + } + }, + "queued": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "queued" + } + }, + "queued_deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "queued-deleted" + } + } + } + }, + "com.amazonaws.ec2#ReservedInstances": { + "type": "structure", + "members": { + "CurrencyCode": { + "target": "com.amazonaws.ec2#CurrencyCodeValues", + "traits": { + "aws.protocols#ec2QueryName": "CurrencyCode", + "smithy.api#documentation": "

The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes.\n\t\t\t\tAt this time, the only supported currency is USD.

", + "smithy.api#xmlName": "currencyCode" + } + }, + "InstanceTenancy": { + "target": "com.amazonaws.ec2#Tenancy", + "traits": { + "aws.protocols#ec2QueryName": "InstanceTenancy", + "smithy.api#documentation": "

The tenancy of the instance.

", + "smithy.api#xmlName": "instanceTenancy" + } + }, + "OfferingClass": { + "target": "com.amazonaws.ec2#OfferingClassType", + "traits": { + "aws.protocols#ec2QueryName": "OfferingClass", + "smithy.api#documentation": "

The offering class of the Reserved Instance.

", + "smithy.api#xmlName": "offeringClass" + } + }, + "OfferingType": { + "target": "com.amazonaws.ec2#OfferingTypeValues", + "traits": { + "aws.protocols#ec2QueryName": "OfferingType", + "smithy.api#documentation": "

The Reserved Instance offering type.

", + "smithy.api#xmlName": "offeringType" + } + }, + "RecurringCharges": { + "target": "com.amazonaws.ec2#RecurringChargesList", + "traits": { + "aws.protocols#ec2QueryName": "RecurringCharges", + "smithy.api#documentation": "

The recurring charge tag assigned to the resource.

", + "smithy.api#xmlName": "recurringCharges" + } + }, + "Scope": { + "target": "com.amazonaws.ec2#scope", + "traits": { + "aws.protocols#ec2QueryName": "Scope", + "smithy.api#documentation": "

The scope of the Reserved Instance.

", + "smithy.api#xmlName": "scope" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the resource.

", + "smithy.api#xmlName": "tagSet" + } + }, + "ReservedInstancesId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstancesId", + "smithy.api#documentation": "

The ID of the Reserved Instance.

", + "smithy.api#xmlName": "reservedInstancesId" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type on which the Reserved Instance can be used.

", + "smithy.api#xmlName": "instanceType" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone in which the Reserved Instance can be used.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "Start": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "Start", + "smithy.api#documentation": "

The date and time the Reserved Instance started.

", + "smithy.api#xmlName": "start" + } + }, + "End": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "End", + "smithy.api#documentation": "

The time when the Reserved Instance expires.

", + "smithy.api#xmlName": "end" + } + }, + "Duration": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "Duration", + "smithy.api#documentation": "

The duration of the Reserved Instance, in seconds.

", + "smithy.api#xmlName": "duration" + } + }, + "UsagePrice": { + "target": "com.amazonaws.ec2#Float", + "traits": { + "aws.protocols#ec2QueryName": "UsagePrice", + "smithy.api#documentation": "

The usage price of the Reserved Instance, per hour.

", + "smithy.api#xmlName": "usagePrice" + } + }, + "FixedPrice": { + "target": "com.amazonaws.ec2#Float", + "traits": { + "aws.protocols#ec2QueryName": "FixedPrice", + "smithy.api#documentation": "

The purchase price of the Reserved Instance.

", + "smithy.api#xmlName": "fixedPrice" + } + }, + "InstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "InstanceCount", + "smithy.api#documentation": "

The number of reservations purchased.

", + "smithy.api#xmlName": "instanceCount" + } + }, + "ProductDescription": { + "target": "com.amazonaws.ec2#RIProductDescription", + "traits": { + "aws.protocols#ec2QueryName": "ProductDescription", + "smithy.api#documentation": "

The Reserved Instance product platform description.

", + "smithy.api#xmlName": "productDescription" + } + }, + "State": { + "target": "com.amazonaws.ec2#ReservedInstanceState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the Reserved Instance purchase.

", + "smithy.api#xmlName": "state" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Reserved Instance.

" + } + }, + "com.amazonaws.ec2#ReservedInstancesConfiguration": { + "type": "structure", + "members": { + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone for the modified Reserved Instances.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "InstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "InstanceCount", + "smithy.api#documentation": "

The number of modified Reserved Instances.

\n \n

This is a required field for a request.

\n ", + "smithy.api#xmlName": "instanceCount" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type for the modified Reserved Instances.

", + "smithy.api#xmlName": "instanceType" + } + }, + "Platform": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Platform", + "smithy.api#documentation": "

The network platform of the modified Reserved Instances.

", + "smithy.api#xmlName": "platform" + } + }, + "Scope": { + "target": "com.amazonaws.ec2#scope", + "traits": { + "aws.protocols#ec2QueryName": "Scope", + "smithy.api#documentation": "

Whether the Reserved Instance is applied to instances in a Region or instances in a specific Availability Zone.

", + "smithy.api#xmlName": "scope" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the configuration settings for the modified Reserved Instances.

" + } + }, + "com.amazonaws.ec2#ReservedInstancesConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ReservedInstancesConfiguration", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ReservedInstancesId": { + "type": "structure", + "members": { + "ReservedInstancesId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstancesId", + "smithy.api#documentation": "

The ID of the Reserved Instance.

", + "smithy.api#xmlName": "reservedInstancesId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the ID of a Reserved Instance.

" + } + }, + "com.amazonaws.ec2#ReservedInstancesIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ReservationId", + "traits": { + "smithy.api#xmlName": "ReservedInstancesId" + } + } + }, + "com.amazonaws.ec2#ReservedInstancesList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ReservedInstances", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ReservedInstancesListing": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

A unique, case-sensitive key supplied by the client to ensure that the request is\n\t\t\tidempotent. For more information, see Ensuring Idempotency.

", + "smithy.api#xmlName": "clientToken" + } + }, + "CreateDate": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreateDate", + "smithy.api#documentation": "

The time the listing was created.

", + "smithy.api#xmlName": "createDate" + } + }, + "InstanceCounts": { + "target": "com.amazonaws.ec2#InstanceCountList", + "traits": { + "aws.protocols#ec2QueryName": "InstanceCounts", + "smithy.api#documentation": "

The number of instances in this state.

", + "smithy.api#xmlName": "instanceCounts" + } + }, + "PriceSchedules": { + "target": "com.amazonaws.ec2#PriceScheduleList", + "traits": { + "aws.protocols#ec2QueryName": "PriceSchedules", + "smithy.api#documentation": "

The price of the Reserved Instance listing.

", + "smithy.api#xmlName": "priceSchedules" + } + }, + "ReservedInstancesId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstancesId", + "smithy.api#documentation": "

The ID of the Reserved Instance.

", + "smithy.api#xmlName": "reservedInstancesId" + } + }, + "ReservedInstancesListingId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstancesListingId", + "smithy.api#documentation": "

The ID of the Reserved Instance listing.

", + "smithy.api#xmlName": "reservedInstancesListingId" + } + }, + "Status": { + "target": "com.amazonaws.ec2#ListingStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The status of the Reserved Instance listing.

", + "smithy.api#xmlName": "status" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

The reason for the current status of the Reserved Instance listing. The response can be blank.

", + "smithy.api#xmlName": "statusMessage" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the resource.

", + "smithy.api#xmlName": "tagSet" + } + }, + "UpdateDate": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "UpdateDate", + "smithy.api#documentation": "

The last modified timestamp of the listing.

", + "smithy.api#xmlName": "updateDate" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Reserved Instance listing.

" + } + }, + "com.amazonaws.ec2#ReservedInstancesListingId": { + "type": "string" + }, + "com.amazonaws.ec2#ReservedInstancesListingList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ReservedInstancesListing", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ReservedInstancesModification": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

A unique, case-sensitive key supplied by the client to ensure that the request is idempotent.\n\t\t\tFor more information, see Ensuring\n\t\t\t\tIdempotency.

", + "smithy.api#xmlName": "clientToken" + } + }, + "CreateDate": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreateDate", + "smithy.api#documentation": "

The time when the modification request was created.

", + "smithy.api#xmlName": "createDate" + } + }, + "EffectiveDate": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "EffectiveDate", + "smithy.api#documentation": "

The time for the modification to become effective.

", + "smithy.api#xmlName": "effectiveDate" + } + }, + "ModificationResults": { + "target": "com.amazonaws.ec2#ReservedInstancesModificationResultList", + "traits": { + "aws.protocols#ec2QueryName": "ModificationResultSet", + "smithy.api#documentation": "

Contains target configurations along with their corresponding new Reserved Instance IDs.

", + "smithy.api#xmlName": "modificationResultSet" + } + }, + "ReservedInstancesIds": { + "target": "com.amazonaws.ec2#ReservedIntancesIds", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstancesSet", + "smithy.api#documentation": "

The IDs of one or more Reserved Instances.

", + "smithy.api#xmlName": "reservedInstancesSet" + } + }, + "ReservedInstancesModificationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstancesModificationId", + "smithy.api#documentation": "

A unique ID for the Reserved Instance modification.

", + "smithy.api#xmlName": "reservedInstancesModificationId" + } + }, + "Status": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The status of the Reserved Instances modification request.

", + "smithy.api#xmlName": "status" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

The reason for the status.

", + "smithy.api#xmlName": "statusMessage" + } + }, + "UpdateDate": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "UpdateDate", + "smithy.api#documentation": "

The time when the modification request was last updated.

", + "smithy.api#xmlName": "updateDate" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Reserved Instance modification.

" + } + }, + "com.amazonaws.ec2#ReservedInstancesModificationId": { + "type": "string" + }, + "com.amazonaws.ec2#ReservedInstancesModificationIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ReservedInstancesModificationId", + "traits": { + "smithy.api#xmlName": "ReservedInstancesModificationId" + } + } + }, + "com.amazonaws.ec2#ReservedInstancesModificationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ReservedInstancesModification", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ReservedInstancesModificationResult": { + "type": "structure", + "members": { + "ReservedInstancesId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstancesId", + "smithy.api#documentation": "

The ID for the Reserved Instances that were created as part of the modification request. This field is only available when the modification is fulfilled.

", + "smithy.api#xmlName": "reservedInstancesId" + } + }, + "TargetConfiguration": { + "target": "com.amazonaws.ec2#ReservedInstancesConfiguration", + "traits": { + "aws.protocols#ec2QueryName": "TargetConfiguration", + "smithy.api#documentation": "

The target Reserved Instances configurations supplied as part of the modification request.

", + "smithy.api#xmlName": "targetConfiguration" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the modification request/s.

" + } + }, + "com.amazonaws.ec2#ReservedInstancesModificationResultList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ReservedInstancesModificationResult", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ReservedInstancesOffering": { + "type": "structure", + "members": { + "CurrencyCode": { + "target": "com.amazonaws.ec2#CurrencyCodeValues", + "traits": { + "aws.protocols#ec2QueryName": "CurrencyCode", + "smithy.api#documentation": "

The currency of the Reserved Instance offering you are purchasing. It's \n\t\t\t\tspecified using ISO 4217 standard currency codes. At this time, \n\t\t\t\tthe only supported currency is USD.

", + "smithy.api#xmlName": "currencyCode" + } + }, + "InstanceTenancy": { + "target": "com.amazonaws.ec2#Tenancy", + "traits": { + "aws.protocols#ec2QueryName": "InstanceTenancy", + "smithy.api#documentation": "

The tenancy of the instance.

", + "smithy.api#xmlName": "instanceTenancy" + } + }, + "Marketplace": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Marketplace", + "smithy.api#documentation": "

Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or Amazon Web Services. \n If it's a Reserved Instance Marketplace offering, this is true.

", + "smithy.api#xmlName": "marketplace" + } + }, + "OfferingClass": { + "target": "com.amazonaws.ec2#OfferingClassType", + "traits": { + "aws.protocols#ec2QueryName": "OfferingClass", + "smithy.api#documentation": "

If convertible it can be exchanged for Reserved Instances of\n the same or higher monetary value, with different configurations. If standard, it is not \n possible to perform an exchange.

", + "smithy.api#xmlName": "offeringClass" + } + }, + "OfferingType": { + "target": "com.amazonaws.ec2#OfferingTypeValues", + "traits": { + "aws.protocols#ec2QueryName": "OfferingType", + "smithy.api#documentation": "

The Reserved Instance offering type.

", + "smithy.api#xmlName": "offeringType" + } + }, + "PricingDetails": { + "target": "com.amazonaws.ec2#PricingDetailsList", + "traits": { + "aws.protocols#ec2QueryName": "PricingDetailsSet", + "smithy.api#documentation": "

The pricing details of the Reserved Instance offering.

", + "smithy.api#xmlName": "pricingDetailsSet" + } + }, + "RecurringCharges": { + "target": "com.amazonaws.ec2#RecurringChargesList", + "traits": { + "aws.protocols#ec2QueryName": "RecurringCharges", + "smithy.api#documentation": "

The recurring charge tag assigned to the resource.

", + "smithy.api#xmlName": "recurringCharges" + } + }, + "Scope": { + "target": "com.amazonaws.ec2#scope", + "traits": { + "aws.protocols#ec2QueryName": "Scope", + "smithy.api#documentation": "

Whether the Reserved Instance is applied to instances in a Region or an Availability Zone.

", + "smithy.api#xmlName": "scope" + } + }, + "ReservedInstancesOfferingId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstancesOfferingId", + "smithy.api#documentation": "

The ID of the Reserved Instance offering. This is the offering ID used in GetReservedInstancesExchangeQuote \n to confirm that an exchange can be made.

", + "smithy.api#xmlName": "reservedInstancesOfferingId" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type on which the Reserved Instance can be used.

", + "smithy.api#xmlName": "instanceType" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone in which the Reserved Instance can be used.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "Duration": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "Duration", + "smithy.api#documentation": "

The duration of the Reserved Instance, in seconds.

", + "smithy.api#xmlName": "duration" + } + }, + "UsagePrice": { + "target": "com.amazonaws.ec2#Float", + "traits": { + "aws.protocols#ec2QueryName": "UsagePrice", + "smithy.api#documentation": "

The usage price of the Reserved Instance, per hour.

", + "smithy.api#xmlName": "usagePrice" + } + }, + "FixedPrice": { + "target": "com.amazonaws.ec2#Float", + "traits": { + "aws.protocols#ec2QueryName": "FixedPrice", + "smithy.api#documentation": "

The purchase price of the Reserved Instance.

", + "smithy.api#xmlName": "fixedPrice" + } + }, + "ProductDescription": { + "target": "com.amazonaws.ec2#RIProductDescription", + "traits": { + "aws.protocols#ec2QueryName": "ProductDescription", + "smithy.api#documentation": "

The Reserved Instance product platform description.

", + "smithy.api#xmlName": "productDescription" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Reserved Instance offering.

" + } + }, + "com.amazonaws.ec2#ReservedInstancesOfferingId": { + "type": "string" + }, + "com.amazonaws.ec2#ReservedInstancesOfferingIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ReservedInstancesOfferingId" + } + }, + "com.amazonaws.ec2#ReservedInstancesOfferingList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ReservedInstancesOffering", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ReservedIntancesIds": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ReservedInstancesId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ResetAddressAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ResetAddressAttributeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ResetAddressAttributeResult" + }, + "traits": { + "smithy.api#documentation": "

Resets the attribute of the specified IP address. For requirements, see Using reverse DNS for email applications.

" + } + }, + "com.amazonaws.ec2#ResetAddressAttributeRequest": { + "type": "structure", + "members": { + "AllocationId": { + "target": "com.amazonaws.ec2#AllocationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

[EC2-VPC] The allocation ID.

", + "smithy.api#required": {} + } + }, + "Attribute": { + "target": "com.amazonaws.ec2#AddressAttributeName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The attribute of the IP address.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ResetAddressAttributeResult": { + "type": "structure", + "members": { + "Address": { + "target": "com.amazonaws.ec2#AddressAttribute", + "traits": { + "aws.protocols#ec2QueryName": "Address", + "smithy.api#documentation": "

Information about the IP address.

", + "smithy.api#xmlName": "address" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ResetEbsDefaultKmsKeyId": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ResetEbsDefaultKmsKeyIdRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ResetEbsDefaultKmsKeyIdResult" + }, + "traits": { + "smithy.api#documentation": "

Resets the default KMS key for EBS encryption for your account in this Region \n to the Amazon Web Services managed KMS key for EBS.

\n

After resetting the default KMS key to the Amazon Web Services managed KMS key, you can continue to encrypt by a \n customer managed KMS key by specifying it when you create the volume. For more information, see\n Amazon EBS encryption\n in the Amazon EBS User Guide.

" + } + }, + "com.amazonaws.ec2#ResetEbsDefaultKmsKeyIdRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ResetEbsDefaultKmsKeyIdResult": { + "type": "structure", + "members": { + "KmsKeyId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KmsKeyId", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the default KMS key for EBS encryption by default.

", + "smithy.api#xmlName": "kmsKeyId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ResetFpgaImageAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ResetFpgaImageAttributeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ResetFpgaImageAttributeResult" + }, + "traits": { + "smithy.api#documentation": "

Resets the specified attribute of the specified Amazon FPGA Image (AFI) to its default value.\n\t\t You can only reset the load permission attribute.

" + } + }, + "com.amazonaws.ec2#ResetFpgaImageAttributeName": { + "type": "enum", + "members": { + "loadPermission": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "loadPermission" + } + } + } + }, + "com.amazonaws.ec2#ResetFpgaImageAttributeRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "FpgaImageId": { + "target": "com.amazonaws.ec2#FpgaImageId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the AFI.

", + "smithy.api#required": {} + } + }, + "Attribute": { + "target": "com.amazonaws.ec2#ResetFpgaImageAttributeName", + "traits": { + "smithy.api#documentation": "

The attribute.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ResetFpgaImageAttributeResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Is true if the request succeeds, and an error otherwise.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ResetImageAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ResetImageAttributeRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Resets an attribute of an AMI to its default value.

", + "smithy.api#examples": [ + { + "title": "To reset the launchPermission attribute", + "documentation": "This example resets the launchPermission attribute for the specified AMI. By default, AMIs are private.", + "input": { + "Attribute": "launchPermission", + "ImageId": "ami-5731123e" + }, + "output": {} + } + ] + } + }, + "com.amazonaws.ec2#ResetImageAttributeName": { + "type": "enum", + "members": { + "launchPermission": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "launchPermission" + } + } + } + }, + "com.amazonaws.ec2#ResetImageAttributeRequest": { + "type": "structure", + "members": { + "Attribute": { + "target": "com.amazonaws.ec2#ResetImageAttributeName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The attribute to reset (currently you can only reset the launch permission\n attribute).

", + "smithy.api#required": {} + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the AMI.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for ResetImageAttribute.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ResetInstanceAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ResetInstanceAttributeRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Resets an attribute of an instance to its default value. To reset the\n kernel or ramdisk, the instance must be in a stopped\n state. To reset the sourceDestCheck, the instance can be either running or\n stopped.

\n

The sourceDestCheck attribute controls whether source/destination\n checking is enabled. The default value is true, which means checking is\n enabled. This value must be false for a NAT instance to perform NAT. For\n more information, see NAT instances in the\n Amazon VPC User Guide.

", + "smithy.api#examples": [ + { + "title": "To reset the sourceDestCheck attribute", + "documentation": "This example resets the sourceDestCheck attribute for the specified instance.", + "input": { + "Attribute": "sourceDestCheck", + "InstanceId": "i-1234567890abcdef0" + }, + "output": {} + } + ] + } + }, + "com.amazonaws.ec2#ResetInstanceAttributeRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "instanceId" + } + }, + "Attribute": { + "target": "com.amazonaws.ec2#InstanceAttributeName", + "traits": { + "aws.protocols#ec2QueryName": "Attribute", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The attribute to reset.

\n \n

You can only reset the following attributes: kernel |\n ramdisk | sourceDestCheck.

\n ", + "smithy.api#required": {}, + "smithy.api#xmlName": "attribute" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ResetNetworkInterfaceAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ResetNetworkInterfaceAttributeRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Resets a network interface attribute. You can specify only one attribute at a time.

" + } + }, + "com.amazonaws.ec2#ResetNetworkInterfaceAttributeRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "SourceDestCheck": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SourceDestCheck", + "smithy.api#documentation": "

The source/destination checking attribute. Resets the value to true.

", + "smithy.api#xmlName": "sourceDestCheck" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for ResetNetworkInterfaceAttribute.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ResetSnapshotAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ResetSnapshotAttributeRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Resets permission settings for the specified snapshot.

\n

For more information about modifying snapshot permissions, see Share a snapshot in the\n Amazon EBS User Guide.

", + "smithy.api#examples": [ + { + "title": "To reset a snapshot attribute", + "documentation": "This example resets the create volume permissions for snapshot ``snap-1234567890abcdef0``. If the command succeeds, no output is returned.", + "input": { + "SnapshotId": "snap-1234567890abcdef0", + "Attribute": "createVolumePermission" + }, + "output": {} + } + ] + } + }, + "com.amazonaws.ec2#ResetSnapshotAttributeRequest": { + "type": "structure", + "members": { + "Attribute": { + "target": "com.amazonaws.ec2#SnapshotAttributeName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The attribute to reset. Currently, only the attribute for permission to create volumes can\n be reset.

", + "smithy.api#required": {} + } + }, + "SnapshotId": { + "target": "com.amazonaws.ec2#SnapshotId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the snapshot.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1283 + } + } + }, + "com.amazonaws.ec2#ResourceConfigurationArn": { + "type": "string" + }, + "com.amazonaws.ec2#ResourceIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TaggableResourceId" + } + }, + "com.amazonaws.ec2#ResourceList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ResourceStatement": { + "type": "structure", + "members": { + "Resources": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "ResourceSet", + "smithy.api#documentation": "

The resources.

", + "smithy.api#xmlName": "resourceSet" + } + }, + "ResourceTypes": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "ResourceTypeSet", + "smithy.api#documentation": "

The resource types.

", + "smithy.api#xmlName": "resourceTypeSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a resource statement.

" + } + }, + "com.amazonaws.ec2#ResourceStatementRequest": { + "type": "structure", + "members": { + "Resources": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The resources.

", + "smithy.api#xmlName": "Resource" + } + }, + "ResourceTypes": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The resource types.

", + "smithy.api#xmlName": "ResourceType" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a resource statement.

" + } + }, + "com.amazonaws.ec2#ResourceType": { + "type": "enum", + "members": { + "capacity_reservation": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "capacity-reservation" + } + }, + "client_vpn_endpoint": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "client-vpn-endpoint" + } + }, + "customer_gateway": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "customer-gateway" + } + }, + "carrier_gateway": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "carrier-gateway" + } + }, + "coip_pool": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "coip-pool" + } + }, + "declarative_policies_report": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "declarative-policies-report" + } + }, + "dedicated_host": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dedicated-host" + } + }, + "dhcp_options": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dhcp-options" + } + }, + "egress_only_internet_gateway": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "egress-only-internet-gateway" + } + }, + "elastic_ip": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "elastic-ip" + } + }, + "elastic_gpu": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "elastic-gpu" + } + }, + "export_image_task": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "export-image-task" + } + }, + "export_instance_task": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "export-instance-task" + } + }, + "fleet": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fleet" + } + }, + "fpga_image": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fpga-image" + } + }, + "host_reservation": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "host-reservation" + } + }, + "image": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "image" + } + }, + "import_image_task": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "import-image-task" + } + }, + "import_snapshot_task": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "import-snapshot-task" + } + }, + "instance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "instance" + } + }, + "instance_event_window": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "instance-event-window" + } + }, + "internet_gateway": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "internet-gateway" + } + }, + "ipam": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipam" + } + }, + "ipam_pool": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipam-pool" + } + }, + "ipam_scope": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipam-scope" + } + }, + "ipv4pool_ec2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv4pool-ec2" + } + }, + "ipv6pool_ec2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv6pool-ec2" + } + }, + "key_pair": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "key-pair" + } + }, + "launch_template": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "launch-template" + } + }, + "local_gateway": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "local-gateway" + } + }, + "local_gateway_route_table": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "local-gateway-route-table" + } + }, + "local_gateway_virtual_interface": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "local-gateway-virtual-interface" + } + }, + "local_gateway_virtual_interface_group": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "local-gateway-virtual-interface-group" + } + }, + "local_gateway_route_table_vpc_association": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "local-gateway-route-table-vpc-association" + } + }, + "local_gateway_route_table_virtual_interface_group_association": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "local-gateway-route-table-virtual-interface-group-association" + } + }, + "natgateway": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "natgateway" + } + }, + "network_acl": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "network-acl" + } + }, + "network_interface": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "network-interface" + } + }, + "network_insights_analysis": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "network-insights-analysis" + } + }, + "network_insights_path": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "network-insights-path" + } + }, + "network_insights_access_scope": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "network-insights-access-scope" + } + }, + "network_insights_access_scope_analysis": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "network-insights-access-scope-analysis" + } + }, + "placement_group": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "placement-group" + } + }, + "prefix_list": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "prefix-list" + } + }, + "replace_root_volume_task": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "replace-root-volume-task" + } + }, + "reserved_instances": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "reserved-instances" + } + }, + "route_table": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "route-table" + } + }, + "security_group": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "security-group" + } + }, + "security_group_rule": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "security-group-rule" + } + }, + "snapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "snapshot" + } + }, + "spot_fleet_request": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "spot-fleet-request" + } + }, + "spot_instances_request": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "spot-instances-request" + } + }, + "subnet": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "subnet" + } + }, + "subnet_cidr_reservation": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "subnet-cidr-reservation" + } + }, + "traffic_mirror_filter": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "traffic-mirror-filter" + } + }, + "traffic_mirror_session": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "traffic-mirror-session" + } + }, + "traffic_mirror_target": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "traffic-mirror-target" + } + }, + "transit_gateway": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "transit-gateway" + } + }, + "transit_gateway_attachment": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "transit-gateway-attachment" + } + }, + "transit_gateway_connect_peer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "transit-gateway-connect-peer" + } + }, + "transit_gateway_multicast_domain": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "transit-gateway-multicast-domain" + } + }, + "transit_gateway_policy_table": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "transit-gateway-policy-table" + } + }, + "transit_gateway_route_table": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "transit-gateway-route-table" + } + }, + "transit_gateway_route_table_announcement": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "transit-gateway-route-table-announcement" + } + }, + "volume": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "volume" + } + }, + "vpc": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vpc" + } + }, + "vpc_endpoint": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vpc-endpoint" + } + }, + "vpc_endpoint_connection": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vpc-endpoint-connection" + } + }, + "vpc_endpoint_service": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vpc-endpoint-service" + } + }, + "vpc_endpoint_service_permission": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vpc-endpoint-service-permission" + } + }, + "vpc_peering_connection": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vpc-peering-connection" + } + }, + "vpn_connection": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vpn-connection" + } + }, + "vpn_gateway": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vpn-gateway" + } + }, + "vpc_flow_log": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vpc-flow-log" + } + }, + "capacity_reservation_fleet": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "capacity-reservation-fleet" + } + }, + "traffic_mirror_filter_rule": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "traffic-mirror-filter-rule" + } + }, + "vpc_endpoint_connection_device_type": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vpc-endpoint-connection-device-type" + } + }, + "verified_access_instance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "verified-access-instance" + } + }, + "verified_access_group": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "verified-access-group" + } + }, + "verified_access_endpoint": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "verified-access-endpoint" + } + }, + "verified_access_policy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "verified-access-policy" + } + }, + "verified_access_trust_provider": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "verified-access-trust-provider" + } + }, + "vpn_connection_device_type": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vpn-connection-device-type" + } + }, + "vpc_block_public_access_exclusion": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vpc-block-public-access-exclusion" + } + }, + "ipam_resource_discovery": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipam-resource-discovery" + } + }, + "ipam_resource_discovery_association": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipam-resource-discovery-association" + } + }, + "instance_connect_endpoint": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "instance-connect-endpoint" + } + }, + "verified_access_endpoint_target": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "verified-access-endpoint-target" + } + }, + "ipam_external_resource_verification_token": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipam-external-resource-verification-token" + } + } + } + }, + "com.amazonaws.ec2#ResponseError": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#LaunchTemplateErrorCode", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The error code.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

The error message, if applicable.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the error that's returned when you cannot delete a launch template\n version.

" + } + }, + "com.amazonaws.ec2#ResponseHostIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ResponseHostIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ResponseLaunchTemplateData": { + "type": "structure", + "members": { + "KernelId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KernelId", + "smithy.api#documentation": "

The ID of the kernel, if applicable.

", + "smithy.api#xmlName": "kernelId" + } + }, + "EbsOptimized": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EbsOptimized", + "smithy.api#documentation": "

Indicates whether the instance is optimized for Amazon EBS I/O.

", + "smithy.api#xmlName": "ebsOptimized" + } + }, + "IamInstanceProfile": { + "target": "com.amazonaws.ec2#LaunchTemplateIamInstanceProfileSpecification", + "traits": { + "aws.protocols#ec2QueryName": "IamInstanceProfile", + "smithy.api#documentation": "

The IAM instance profile.

", + "smithy.api#xmlName": "iamInstanceProfile" + } + }, + "BlockDeviceMappings": { + "target": "com.amazonaws.ec2#LaunchTemplateBlockDeviceMappingList", + "traits": { + "aws.protocols#ec2QueryName": "BlockDeviceMappingSet", + "smithy.api#documentation": "

The block device mappings.

", + "smithy.api#xmlName": "blockDeviceMappingSet" + } + }, + "NetworkInterfaces": { + "target": "com.amazonaws.ec2#LaunchTemplateInstanceNetworkInterfaceSpecificationList", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceSet", + "smithy.api#documentation": "

The network interfaces.

", + "smithy.api#xmlName": "networkInterfaceSet" + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the AMI or a Systems Manager parameter. The Systems Manager parameter will\n resolve to the ID of the AMI at instance launch.

\n

The value depends on what you specified in the request. The possible values are:

\n \n

For more information, see Use a Systems \n Manager parameter instead of an AMI ID in the Amazon EC2 User Guide.

", + "smithy.api#xmlName": "imageId" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type.

", + "smithy.api#xmlName": "instanceType" + } + }, + "KeyName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KeyName", + "smithy.api#documentation": "

The name of the key pair.

", + "smithy.api#xmlName": "keyName" + } + }, + "Monitoring": { + "target": "com.amazonaws.ec2#LaunchTemplatesMonitoring", + "traits": { + "aws.protocols#ec2QueryName": "Monitoring", + "smithy.api#documentation": "

The monitoring for the instance.

", + "smithy.api#xmlName": "monitoring" + } + }, + "Placement": { + "target": "com.amazonaws.ec2#LaunchTemplatePlacement", + "traits": { + "aws.protocols#ec2QueryName": "Placement", + "smithy.api#documentation": "

The placement of the instance.

", + "smithy.api#xmlName": "placement" + } + }, + "RamDiskId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RamDiskId", + "smithy.api#documentation": "

The ID of the RAM disk, if applicable.

", + "smithy.api#xmlName": "ramDiskId" + } + }, + "DisableApiTermination": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DisableApiTermination", + "smithy.api#documentation": "

If set to true, indicates that the instance cannot be terminated using\n the Amazon EC2 console, command line tool, or API.

", + "smithy.api#xmlName": "disableApiTermination" + } + }, + "InstanceInitiatedShutdownBehavior": { + "target": "com.amazonaws.ec2#ShutdownBehavior", + "traits": { + "aws.protocols#ec2QueryName": "InstanceInitiatedShutdownBehavior", + "smithy.api#documentation": "

Indicates whether an instance stops or terminates when you initiate shutdown from the\n instance (using the operating system command for system shutdown).

", + "smithy.api#xmlName": "instanceInitiatedShutdownBehavior" + } + }, + "UserData": { + "target": "com.amazonaws.ec2#SensitiveUserData", + "traits": { + "aws.protocols#ec2QueryName": "UserData", + "smithy.api#documentation": "

The user data for the instance.

", + "smithy.api#xmlName": "userData" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#LaunchTemplateTagSpecificationList", + "traits": { + "aws.protocols#ec2QueryName": "TagSpecificationSet", + "smithy.api#documentation": "

The tags that are applied to the resources that are created during instance\n launch.

", + "smithy.api#xmlName": "tagSpecificationSet" + } + }, + "ElasticGpuSpecifications": { + "target": "com.amazonaws.ec2#ElasticGpuSpecificationResponseList", + "traits": { + "aws.protocols#ec2QueryName": "ElasticGpuSpecificationSet", + "smithy.api#documentation": "

Deprecated.

\n \n

Amazon Elastic Graphics reached end of life on January 8, 2024. For \n workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, \n G4dn, or G5 instances.

\n ", + "smithy.api#xmlName": "elasticGpuSpecificationSet" + } + }, + "ElasticInferenceAccelerators": { + "target": "com.amazonaws.ec2#LaunchTemplateElasticInferenceAcceleratorResponseList", + "traits": { + "aws.protocols#ec2QueryName": "ElasticInferenceAcceleratorSet", + "smithy.api#documentation": "\n

Amazon Elastic Inference is no longer available.

\n \n

An elastic inference accelerator to associate with the instance. Elastic inference\n accelerators are a resource you can attach to your Amazon EC2 instances to accelerate\n your Deep Learning (DL) inference workloads.

\n

You cannot specify accelerators from different generations in the same request.

\n \n

Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon\n Elastic Inference (EI), and will help current customers migrate their workloads to\n options that offer better price and performance. After April 15, 2023, new customers\n will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker,\n Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during\n the past 30-day period are considered current customers and will be able to continue\n using the service.

\n ", + "smithy.api#xmlName": "elasticInferenceAcceleratorSet" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroupIdSet", + "smithy.api#documentation": "

The security group IDs.

", + "smithy.api#xmlName": "securityGroupIdSet" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroupSet", + "smithy.api#documentation": "

The security group names.

", + "smithy.api#xmlName": "securityGroupSet" + } + }, + "InstanceMarketOptions": { + "target": "com.amazonaws.ec2#LaunchTemplateInstanceMarketOptions", + "traits": { + "aws.protocols#ec2QueryName": "InstanceMarketOptions", + "smithy.api#documentation": "

The market (purchasing) option for the instances.

", + "smithy.api#xmlName": "instanceMarketOptions" + } + }, + "CreditSpecification": { + "target": "com.amazonaws.ec2#CreditSpecification", + "traits": { + "aws.protocols#ec2QueryName": "CreditSpecification", + "smithy.api#documentation": "

The credit option for CPU usage of the instance.

", + "smithy.api#xmlName": "creditSpecification" + } + }, + "CpuOptions": { + "target": "com.amazonaws.ec2#LaunchTemplateCpuOptions", + "traits": { + "aws.protocols#ec2QueryName": "CpuOptions", + "smithy.api#documentation": "

The CPU options for the instance. For more information, see Optimize CPU options in the Amazon EC2 User Guide.

", + "smithy.api#xmlName": "cpuOptions" + } + }, + "CapacityReservationSpecification": { + "target": "com.amazonaws.ec2#LaunchTemplateCapacityReservationSpecificationResponse", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationSpecification", + "smithy.api#documentation": "

Information about the Capacity Reservation targeting option.

", + "smithy.api#xmlName": "capacityReservationSpecification" + } + }, + "LicenseSpecifications": { + "target": "com.amazonaws.ec2#LaunchTemplateLicenseList", + "traits": { + "aws.protocols#ec2QueryName": "LicenseSet", + "smithy.api#documentation": "

The license configurations.

", + "smithy.api#xmlName": "licenseSet" + } + }, + "HibernationOptions": { + "target": "com.amazonaws.ec2#LaunchTemplateHibernationOptions", + "traits": { + "aws.protocols#ec2QueryName": "HibernationOptions", + "smithy.api#documentation": "

Indicates whether an instance is configured for hibernation. For more information, see\n Hibernate\n your Amazon EC2 instance in the Amazon EC2 User Guide.

", + "smithy.api#xmlName": "hibernationOptions" + } + }, + "MetadataOptions": { + "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataOptions", + "traits": { + "aws.protocols#ec2QueryName": "MetadataOptions", + "smithy.api#documentation": "

The metadata options for the instance. For more information, see Instance metadata and user data in the\n Amazon EC2 User Guide.

", + "smithy.api#xmlName": "metadataOptions" + } + }, + "EnclaveOptions": { + "target": "com.amazonaws.ec2#LaunchTemplateEnclaveOptions", + "traits": { + "aws.protocols#ec2QueryName": "EnclaveOptions", + "smithy.api#documentation": "

Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.

", + "smithy.api#xmlName": "enclaveOptions" + } + }, + "InstanceRequirements": { + "target": "com.amazonaws.ec2#InstanceRequirements", + "traits": { + "aws.protocols#ec2QueryName": "InstanceRequirements", + "smithy.api#documentation": "

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will\n identify instance types with these attributes.

\n

If you specify InstanceRequirements, you can't specify\n InstanceTypes.

", + "smithy.api#xmlName": "instanceRequirements" + } + }, + "PrivateDnsNameOptions": { + "target": "com.amazonaws.ec2#LaunchTemplatePrivateDnsNameOptions", + "traits": { + "aws.protocols#ec2QueryName": "PrivateDnsNameOptions", + "smithy.api#documentation": "

The options for the instance hostname.

", + "smithy.api#xmlName": "privateDnsNameOptions" + } + }, + "MaintenanceOptions": { + "target": "com.amazonaws.ec2#LaunchTemplateInstanceMaintenanceOptions", + "traits": { + "aws.protocols#ec2QueryName": "MaintenanceOptions", + "smithy.api#documentation": "

The maintenance options for your instance.

", + "smithy.api#xmlName": "maintenanceOptions" + } + }, + "DisableApiStop": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DisableApiStop", + "smithy.api#documentation": "

Indicates whether the instance is enabled for stop protection. For more information,\n see Enable stop protection for your instance in the\n Amazon EC2 User Guide.

", + "smithy.api#xmlName": "disableApiStop" + } + }, + "Operator": { + "target": "com.amazonaws.ec2#OperatorResponse", + "traits": { + "aws.protocols#ec2QueryName": "Operator", + "smithy.api#documentation": "

The entity that manages the launch template.

", + "smithy.api#xmlName": "operator" + } + }, + "NetworkPerformanceOptions": { + "target": "com.amazonaws.ec2#LaunchTemplateNetworkPerformanceOptions", + "traits": { + "aws.protocols#ec2QueryName": "NetworkPerformanceOptions", + "smithy.api#documentation": "

Contains the launch template settings for network performance options for \n \tyour instance.

", + "smithy.api#xmlName": "networkPerformanceOptions" + } + } + }, + "traits": { + "smithy.api#documentation": "

The information for a launch template.

" + } + }, + "com.amazonaws.ec2#RestorableByStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String" + } + }, + "com.amazonaws.ec2#RestoreAddressToClassic": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RestoreAddressToClassicRequest" + }, + "output": { + "target": "com.amazonaws.ec2#RestoreAddressToClassicResult" + }, + "traits": { + "smithy.api#documentation": "\n

This action is deprecated.

\n \n

Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform. You cannot move an Elastic IP address that was originally allocated for use in EC2-VPC. The Elastic IP address must not be associated with an instance or network interface.

" + } + }, + "com.amazonaws.ec2#RestoreAddressToClassicRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "PublicIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicIp", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Elastic IP address.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "publicIp" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#RestoreAddressToClassicResult": { + "type": "structure", + "members": { + "PublicIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicIp", + "smithy.api#documentation": "

The Elastic IP address.

", + "smithy.api#xmlName": "publicIp" + } + }, + "Status": { + "target": "com.amazonaws.ec2#Status", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The move status for the IP address.

", + "smithy.api#xmlName": "status" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#RestoreImageFromRecycleBin": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RestoreImageFromRecycleBinRequest" + }, + "output": { + "target": "com.amazonaws.ec2#RestoreImageFromRecycleBinResult" + }, + "traits": { + "smithy.api#documentation": "

Restores an AMI from the Recycle Bin. For more information, see Recycle Bin in\n the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#RestoreImageFromRecycleBinRequest": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the AMI to restore.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#RestoreImageFromRecycleBinResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#RestoreManagedPrefixListVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RestoreManagedPrefixListVersionRequest" + }, + "output": { + "target": "com.amazonaws.ec2#RestoreManagedPrefixListVersionResult" + }, + "traits": { + "smithy.api#documentation": "

Restores the entries from a previous version of a managed prefix list to a new version of the prefix list.

" + } + }, + "com.amazonaws.ec2#RestoreManagedPrefixListVersionRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "PrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the prefix list.

", + "smithy.api#required": {} + } + }, + "PreviousVersion": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The version to restore.

", + "smithy.api#required": {} + } + }, + "CurrentVersion": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The current version number for the prefix list.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#RestoreManagedPrefixListVersionResult": { + "type": "structure", + "members": { + "PrefixList": { + "target": "com.amazonaws.ec2#ManagedPrefixList", + "traits": { + "aws.protocols#ec2QueryName": "PrefixList", + "smithy.api#documentation": "

Information about the prefix list.

", + "smithy.api#xmlName": "prefixList" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#RestoreSnapshotFromRecycleBin": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RestoreSnapshotFromRecycleBinRequest" + }, + "output": { + "target": "com.amazonaws.ec2#RestoreSnapshotFromRecycleBinResult" + }, + "traits": { + "smithy.api#documentation": "

Restores a snapshot from the Recycle Bin. For more information, see Restore \n snapshots from the Recycle Bin in the Amazon EBS User Guide.

" + } + }, + "com.amazonaws.ec2#RestoreSnapshotFromRecycleBinRequest": { + "type": "structure", + "members": { + "SnapshotId": { + "target": "com.amazonaws.ec2#SnapshotId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the snapshot to restore.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#RestoreSnapshotFromRecycleBinResult": { + "type": "structure", + "members": { + "SnapshotId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The ID of the snapshot.

", + "smithy.api#xmlName": "snapshotId" + } + }, + "OutpostArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OutpostArn", + "smithy.api#documentation": "

The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the \n Amazon EBS User Guide.

", + "smithy.api#xmlName": "outpostArn" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description for the snapshot.

", + "smithy.api#xmlName": "description" + } + }, + "Encrypted": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Encrypted", + "smithy.api#documentation": "

Indicates whether the snapshot is encrypted.

", + "smithy.api#xmlName": "encrypted" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the EBS snapshot.

", + "smithy.api#xmlName": "ownerId" + } + }, + "Progress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Progress", + "smithy.api#documentation": "

The progress of the snapshot, as a percentage.

", + "smithy.api#xmlName": "progress" + } + }, + "StartTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "StartTime", + "smithy.api#documentation": "

The time stamp when the snapshot was initiated.

", + "smithy.api#xmlName": "startTime" + } + }, + "State": { + "target": "com.amazonaws.ec2#SnapshotState", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The state of the snapshot.

", + "smithy.api#xmlName": "status" + } + }, + "VolumeId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VolumeId", + "smithy.api#documentation": "

The ID of the volume that was used to create the snapshot.

", + "smithy.api#xmlName": "volumeId" + } + }, + "VolumeSize": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "VolumeSize", + "smithy.api#documentation": "

The size of the volume, in GiB.

", + "smithy.api#xmlName": "volumeSize" + } + }, + "SseType": { + "target": "com.amazonaws.ec2#SSEType", + "traits": { + "aws.protocols#ec2QueryName": "SseType", + "smithy.api#documentation": "

Reserved for future use.

", + "smithy.api#xmlName": "sseType" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#RestoreSnapshotTier": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RestoreSnapshotTierRequest" + }, + "output": { + "target": "com.amazonaws.ec2#RestoreSnapshotTierResult" + }, + "traits": { + "smithy.api#documentation": "

Restores an archived Amazon EBS snapshot for use temporarily or permanently, or modifies the restore \n period or restore type for a snapshot that was previously temporarily restored.

\n

For more information see \n Restore an archived snapshot and \n modify the restore period or restore type for a temporarily restored snapshot in the Amazon EBS User Guide.

" + } + }, + "com.amazonaws.ec2#RestoreSnapshotTierRequest": { + "type": "structure", + "members": { + "SnapshotId": { + "target": "com.amazonaws.ec2#SnapshotId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the snapshot to restore.

", + "smithy.api#required": {} + } + }, + "TemporaryRestoreDays": { + "target": "com.amazonaws.ec2#RestoreSnapshotTierRequestTemporaryRestoreDays", + "traits": { + "smithy.api#documentation": "

Specifies the number of days for which to temporarily restore an archived snapshot. \n Required for temporary restores only. The snapshot will be automatically re-archived \n after this period.

\n

To temporarily restore an archived snapshot, specify the number of days and omit \n the PermanentRestore parameter or set it to \n false.

" + } + }, + "PermanentRestore": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether to permanently restore an archived snapshot. To permanently restore \n an archived snapshot, specify true and omit the \n RestoreSnapshotTierRequest$TemporaryRestoreDays parameter.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#RestoreSnapshotTierRequestTemporaryRestoreDays": { + "type": "integer" + }, + "com.amazonaws.ec2#RestoreSnapshotTierResult": { + "type": "structure", + "members": { + "SnapshotId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The ID of the snapshot.

", + "smithy.api#xmlName": "snapshotId" + } + }, + "RestoreStartTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "RestoreStartTime", + "smithy.api#documentation": "

The date and time when the snapshot restore process started.

", + "smithy.api#xmlName": "restoreStartTime" + } + }, + "RestoreDuration": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "RestoreDuration", + "smithy.api#documentation": "

For temporary restores only. The number of days for which the archived snapshot \n is temporarily restored.

", + "smithy.api#xmlName": "restoreDuration" + } + }, + "IsPermanentRestore": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "IsPermanentRestore", + "smithy.api#documentation": "

Indicates whether the snapshot is permanently restored. true indicates a permanent \n restore. false indicates a temporary restore.

", + "smithy.api#xmlName": "isPermanentRestore" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ResultRange": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 20, + "max": 500 + } + } + }, + "com.amazonaws.ec2#RetentionPeriodRequestDays": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 36500 + } + } + }, + "com.amazonaws.ec2#RetentionPeriodResponseDays": { + "type": "integer" + }, + "com.amazonaws.ec2#RevokeClientVpnIngress": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RevokeClientVpnIngressRequest" + }, + "output": { + "target": "com.amazonaws.ec2#RevokeClientVpnIngressResult" + }, + "traits": { + "smithy.api#documentation": "

Removes an ingress authorization rule from a Client VPN endpoint.

" + } + }, + "com.amazonaws.ec2#RevokeClientVpnIngressRequest": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#ClientVpnEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Client VPN endpoint with which the authorization rule is associated.

", + "smithy.api#required": {} + } + }, + "TargetNetworkCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IPv4 address range, in CIDR notation, of the network for which access is being removed.

", + "smithy.api#required": {} + } + }, + "AccessGroupId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ID of the Active Directory group for which to revoke access.

" + } + }, + "RevokeAllGroups": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether access should be revoked for all groups for a single TargetNetworkCidr that earlier authorized ingress for all groups using AuthorizeAllGroups.\n\t\t\tThis does not impact other authorization rules that allowed ingress to the same TargetNetworkCidr with a specific AccessGroupId.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#RevokeClientVpnIngressResult": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.ec2#ClientVpnAuthorizationRuleStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The current state of the authorization rule.

", + "smithy.api#xmlName": "status" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#RevokeSecurityGroupEgress": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RevokeSecurityGroupEgressRequest" + }, + "output": { + "target": "com.amazonaws.ec2#RevokeSecurityGroupEgressResult" + }, + "traits": { + "smithy.api#documentation": "

Removes the specified outbound (egress) rules from the specified security group.

\n

You can specify rules using either rule IDs or security group rule properties. If you use\n rule properties, the values that you specify (for example, ports) must match the existing rule's \n values exactly. Each rule has a protocol, from and to ports, and destination (CIDR range, \n security group, or prefix list). For the TCP and UDP protocols, you must also specify the \n destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type \n and code. If the security group rule has a description, you do not need to specify the description \n to revoke the rule.

\n

For a default VPC, if the values you specify do not match the existing rule's values, no error is\n returned, and the output describes the security group rules that were not revoked.

\n

Amazon Web Services recommends that you describe the security group to verify that the rules were removed.

\n

Rule changes are propagated to instances within the security group as quickly as possible. However, \n a small delay might occur.

" + } + }, + "com.amazonaws.ec2#RevokeSecurityGroupEgressRequest": { + "type": "structure", + "members": { + "SecurityGroupRuleIds": { + "target": "com.amazonaws.ec2#SecurityGroupRuleIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the security group rules.

", + "smithy.api#xmlName": "SecurityGroupRuleId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "GroupId": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "aws.protocols#ec2QueryName": "GroupId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the security group.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "groupId" + } + }, + "SourceSecurityGroupName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SourceSecurityGroupName", + "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify a\n destination security group.

", + "smithy.api#xmlName": "sourceSecurityGroupName" + } + }, + "SourceSecurityGroupOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SourceSecurityGroupOwnerId", + "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify a destination security\n group.

", + "smithy.api#xmlName": "sourceSecurityGroupOwnerId" + } + }, + "IpProtocol": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IpProtocol", + "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify the protocol name or\n number.

", + "smithy.api#xmlName": "ipProtocol" + } + }, + "FromPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "FromPort", + "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify the port.

", + "smithy.api#xmlName": "fromPort" + } + }, + "ToPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "ToPort", + "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify the port.

", + "smithy.api#xmlName": "toPort" + } + }, + "CidrIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CidrIp", + "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify the CIDR.

", + "smithy.api#xmlName": "cidrIp" + } + }, + "IpPermissions": { + "target": "com.amazonaws.ec2#IpPermissionList", + "traits": { + "aws.protocols#ec2QueryName": "IpPermissions", + "smithy.api#documentation": "

The sets of IP permissions. You can't specify a destination security group and a CIDR IP address range in the same set of permissions.

", + "smithy.api#xmlName": "ipPermissions" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#RevokeSecurityGroupEgressResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, returns an error.

", + "smithy.api#xmlName": "return" + } + }, + "UnknownIpPermissions": { + "target": "com.amazonaws.ec2#IpPermissionList", + "traits": { + "aws.protocols#ec2QueryName": "UnknownIpPermissionSet", + "smithy.api#documentation": "

The outbound rules that were unknown to the service. In some cases,\n unknownIpPermissionSet might be in a different format from the request\n parameter.

", + "smithy.api#xmlName": "unknownIpPermissionSet" + } + }, + "RevokedSecurityGroupRules": { + "target": "com.amazonaws.ec2#RevokedSecurityGroupRuleList", + "traits": { + "aws.protocols#ec2QueryName": "RevokedSecurityGroupRuleSet", + "smithy.api#documentation": "

Details about the revoked security group rules.

", + "smithy.api#xmlName": "revokedSecurityGroupRuleSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#RevokeSecurityGroupIngress": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RevokeSecurityGroupIngressRequest" + }, + "output": { + "target": "com.amazonaws.ec2#RevokeSecurityGroupIngressResult" + }, + "traits": { + "smithy.api#documentation": "

Removes the specified inbound (ingress) rules from a security group.

\n

You can specify rules using either rule IDs or security group rule properties. If you use\n rule properties, the values that you specify (for example, ports) must match the existing rule's \n values exactly. Each rule has a protocol, from and to ports, and source (CIDR range, \n security group, or prefix list). For the TCP and UDP protocols, you must also specify the \n destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type \n and code. If the security group rule has a description, you do not need to specify the description \n to revoke the rule.

\n

For a default VPC, if the values you specify do not match the existing rule's values,\n no error is returned, and the output describes the security group rules that were not\n revoked.

\n

For a non-default VPC, if the values you specify do not match the existing rule's\n values, an InvalidPermission.NotFound client error is returned, and no\n rules are revoked.

\n

Amazon Web Services recommends that you describe the security group to verify that the rules were removed.

\n

Rule changes are propagated to instances within the security group as quickly as possible. \n However, a small delay might occur.

" + } + }, + "com.amazonaws.ec2#RevokeSecurityGroupIngressRequest": { + "type": "structure", + "members": { + "CidrIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

" + } + }, + "FromPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

If the protocol is TCP or UDP, this is the start of the port range.\n If the protocol is ICMP, this is the ICMP type or -1 (all ICMP types).

" + } + }, + "GroupId": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "smithy.api#documentation": "

The ID of the security group.

" + } + }, + "GroupName": { + "target": "com.amazonaws.ec2#SecurityGroupName", + "traits": { + "smithy.api#documentation": "

[Default VPC] The name of the security group. You must specify either the\n security group ID or the security group name in the request. For security groups in a\n nondefault VPC, you must specify the security group ID.

" + } + }, + "IpPermissions": { + "target": "com.amazonaws.ec2#IpPermissionList", + "traits": { + "smithy.api#documentation": "

The sets of IP permissions. You can't specify a source security group and a CIDR IP address range in the same set of permissions.

" + } + }, + "IpProtocol": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IP protocol name (tcp, udp, icmp) or number \n (see Protocol Numbers). \n Use -1 to specify all.

" + } + }, + "SourceSecurityGroupName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

[Default VPC] The name of the source security group. You can't specify this parameter \n in combination with the following parameters: the CIDR IP address range, the start of the port range, \n the IP protocol, and the end of the port range. The source security group must be in the same VPC. \n To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.

" + } + }, + "SourceSecurityGroupOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Not supported.

" + } + }, + "ToPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

If the protocol is TCP or UDP, this is the end of the port range.\n If the protocol is ICMP, this is the ICMP code or -1 (all ICMP codes).

" + } + }, + "SecurityGroupRuleIds": { + "target": "com.amazonaws.ec2#SecurityGroupRuleIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the security group rules.

", + "smithy.api#xmlName": "SecurityGroupRuleId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#RevokeSecurityGroupIngressResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, returns an error.

", + "smithy.api#xmlName": "return" + } + }, + "UnknownIpPermissions": { + "target": "com.amazonaws.ec2#IpPermissionList", + "traits": { + "aws.protocols#ec2QueryName": "UnknownIpPermissionSet", + "smithy.api#documentation": "

The inbound rules that were unknown to the service. In some cases,\n unknownIpPermissionSet might be in a different format from the request\n parameter.

", + "smithy.api#xmlName": "unknownIpPermissionSet" + } + }, + "RevokedSecurityGroupRules": { + "target": "com.amazonaws.ec2#RevokedSecurityGroupRuleList", + "traits": { + "aws.protocols#ec2QueryName": "RevokedSecurityGroupRuleSet", + "smithy.api#documentation": "

Details about the revoked security group rules.

", + "smithy.api#xmlName": "revokedSecurityGroupRuleSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#RevokedSecurityGroupRule": { + "type": "structure", + "members": { + "SecurityGroupRuleId": { + "target": "com.amazonaws.ec2#SecurityGroupRuleId", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroupRuleId", + "smithy.api#documentation": "

A security group rule ID.

", + "smithy.api#xmlName": "securityGroupRuleId" + } + }, + "GroupId": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "aws.protocols#ec2QueryName": "GroupId", + "smithy.api#documentation": "

A security group ID.

", + "smithy.api#xmlName": "groupId" + } + }, + "IsEgress": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "IsEgress", + "smithy.api#documentation": "

Defines if a security group rule is an outbound rule.

", + "smithy.api#xmlName": "isEgress" + } + }, + "IpProtocol": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IpProtocol", + "smithy.api#documentation": "

The security group rule's protocol.

", + "smithy.api#xmlName": "ipProtocol" + } + }, + "FromPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "FromPort", + "smithy.api#documentation": "

The 'from' port number of the security group rule.

", + "smithy.api#xmlName": "fromPort" + } + }, + "ToPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "ToPort", + "smithy.api#documentation": "

The 'to' port number of the security group rule.

", + "smithy.api#xmlName": "toPort" + } + }, + "CidrIpv4": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CidrIpv4", + "smithy.api#documentation": "

The IPv4 CIDR of the traffic source.

", + "smithy.api#xmlName": "cidrIpv4" + } + }, + "CidrIpv6": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CidrIpv6", + "smithy.api#documentation": "

The IPv6 CIDR of the traffic source.

", + "smithy.api#xmlName": "cidrIpv6" + } + }, + "PrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "aws.protocols#ec2QueryName": "PrefixListId", + "smithy.api#documentation": "

The ID of a prefix list that's the traffic source.

", + "smithy.api#xmlName": "prefixListId" + } + }, + "ReferencedGroupId": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "aws.protocols#ec2QueryName": "ReferencedGroupId", + "smithy.api#documentation": "

The ID of a referenced security group.

", + "smithy.api#xmlName": "referencedGroupId" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description of the revoked security group rule.

", + "smithy.api#xmlName": "description" + } + } + }, + "traits": { + "smithy.api#documentation": "

A security group rule removed with RevokeSecurityGroupEgress or RevokeSecurityGroupIngress.

" + } + }, + "com.amazonaws.ec2#RevokedSecurityGroupRuleList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#RevokedSecurityGroupRule", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#RoleId": { + "type": "string" + }, + "com.amazonaws.ec2#RootDeviceType": { + "type": "enum", + "members": { + "ebs": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ebs" + } + }, + "instance_store": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "instance-store" + } + } + } + }, + "com.amazonaws.ec2#RootDeviceTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#RootDeviceType", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Route": { + "type": "structure", + "members": { + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationCidrBlock", + "smithy.api#documentation": "

The IPv4 CIDR block used for the destination match.

", + "smithy.api#xmlName": "destinationCidrBlock" + } + }, + "DestinationIpv6CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationIpv6CidrBlock", + "smithy.api#documentation": "

The IPv6 CIDR block used for the destination match.

", + "smithy.api#xmlName": "destinationIpv6CidrBlock" + } + }, + "DestinationPrefixListId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationPrefixListId", + "smithy.api#documentation": "

The prefix of the Amazon Web Services service.

", + "smithy.api#xmlName": "destinationPrefixListId" + } + }, + "EgressOnlyInternetGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "EgressOnlyInternetGatewayId", + "smithy.api#documentation": "

The ID of the egress-only internet gateway.

", + "smithy.api#xmlName": "egressOnlyInternetGatewayId" + } + }, + "GatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GatewayId", + "smithy.api#documentation": "

The ID of a gateway attached to your VPC.

", + "smithy.api#xmlName": "gatewayId" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of a NAT instance in your VPC.

", + "smithy.api#xmlName": "instanceId" + } + }, + "InstanceOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceOwnerId", + "smithy.api#documentation": "

The ID of Amazon Web Services account that owns the instance.

", + "smithy.api#xmlName": "instanceOwnerId" + } + }, + "NatGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NatGatewayId", + "smithy.api#documentation": "

The ID of a NAT gateway.

", + "smithy.api#xmlName": "natGatewayId" + } + }, + "TransitGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayId", + "smithy.api#documentation": "

The ID of a transit gateway.

", + "smithy.api#xmlName": "transitGatewayId" + } + }, + "LocalGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayId", + "smithy.api#documentation": "

The ID of the local gateway.

", + "smithy.api#xmlName": "localGatewayId" + } + }, + "CarrierGatewayId": { + "target": "com.amazonaws.ec2#CarrierGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "CarrierGatewayId", + "smithy.api#documentation": "

The ID of the carrier gateway.

", + "smithy.api#xmlName": "carrierGatewayId" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "Origin": { + "target": "com.amazonaws.ec2#RouteOrigin", + "traits": { + "aws.protocols#ec2QueryName": "Origin", + "smithy.api#documentation": "

Describes how the route was created.

\n ", + "smithy.api#xmlName": "origin" + } + }, + "State": { + "target": "com.amazonaws.ec2#RouteState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the route. The blackhole state indicates that the\n\t\t\t\troute's target isn't available (for example, the specified gateway isn't attached to the\n\t\t\t\tVPC, or the specified NAT instance has been terminated).

", + "smithy.api#xmlName": "state" + } + }, + "VpcPeeringConnectionId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcPeeringConnectionId", + "smithy.api#documentation": "

The ID of a VPC peering connection.

", + "smithy.api#xmlName": "vpcPeeringConnectionId" + } + }, + "CoreNetworkArn": { + "target": "com.amazonaws.ec2#CoreNetworkArn", + "traits": { + "aws.protocols#ec2QueryName": "CoreNetworkArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the core network.

", + "smithy.api#xmlName": "coreNetworkArn" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a route in a route table.

" + } + }, + "com.amazonaws.ec2#RouteGatewayId": { + "type": "string" + }, + "com.amazonaws.ec2#RouteList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Route", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#RouteOrigin": { + "type": "enum", + "members": { + "CreateRouteTable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateRouteTable" + } + }, + "CreateRoute": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateRoute" + } + }, + "EnableVgwRoutePropagation": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EnableVgwRoutePropagation" + } + } + } + }, + "com.amazonaws.ec2#RouteState": { + "type": "enum", + "members": { + "active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "blackhole": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "blackhole" + } + } + } + }, + "com.amazonaws.ec2#RouteTable": { + "type": "structure", + "members": { + "Associations": { + "target": "com.amazonaws.ec2#RouteTableAssociationList", + "traits": { + "aws.protocols#ec2QueryName": "AssociationSet", + "smithy.api#documentation": "

The associations between the route table and your subnets or gateways.

", + "smithy.api#xmlName": "associationSet" + } + }, + "PropagatingVgws": { + "target": "com.amazonaws.ec2#PropagatingVgwList", + "traits": { + "aws.protocols#ec2QueryName": "PropagatingVgwSet", + "smithy.api#documentation": "

Any virtual private gateway (VGW) propagating routes.

", + "smithy.api#xmlName": "propagatingVgwSet" + } + }, + "RouteTableId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RouteTableId", + "smithy.api#documentation": "

The ID of the route table.

", + "smithy.api#xmlName": "routeTableId" + } + }, + "Routes": { + "target": "com.amazonaws.ec2#RouteList", + "traits": { + "aws.protocols#ec2QueryName": "RouteSet", + "smithy.api#documentation": "

The routes in the route table.

", + "smithy.api#xmlName": "routeSet" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the route table.

", + "smithy.api#xmlName": "tagSet" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "vpcId" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the route table.

", + "smithy.api#xmlName": "ownerId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a route table.

" + } + }, + "com.amazonaws.ec2#RouteTableAssociation": { + "type": "structure", + "members": { + "Main": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Main", + "smithy.api#documentation": "

Indicates whether this is the main route table.

", + "smithy.api#xmlName": "main" + } + }, + "RouteTableAssociationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RouteTableAssociationId", + "smithy.api#documentation": "

The ID of the association.

", + "smithy.api#xmlName": "routeTableAssociationId" + } + }, + "RouteTableId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RouteTableId", + "smithy.api#documentation": "

The ID of the route table.

", + "smithy.api#xmlName": "routeTableId" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet. A subnet ID is not returned for an implicit association.

", + "smithy.api#xmlName": "subnetId" + } + }, + "GatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GatewayId", + "smithy.api#documentation": "

The ID of the internet gateway or virtual private gateway.

", + "smithy.api#xmlName": "gatewayId" + } + }, + "AssociationState": { + "target": "com.amazonaws.ec2#RouteTableAssociationState", + "traits": { + "aws.protocols#ec2QueryName": "AssociationState", + "smithy.api#documentation": "

The state of the association.

", + "smithy.api#xmlName": "associationState" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an association between a route table and a subnet or gateway.

" + } + }, + "com.amazonaws.ec2#RouteTableAssociationId": { + "type": "string" + }, + "com.amazonaws.ec2#RouteTableAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#RouteTableAssociation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#RouteTableAssociationState": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.ec2#RouteTableAssociationStateCode", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the association.

", + "smithy.api#xmlName": "state" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

The status message, if applicable.

", + "smithy.api#xmlName": "statusMessage" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the state of an association between a route table and a subnet or gateway.

" + } + }, + "com.amazonaws.ec2#RouteTableAssociationStateCode": { + "type": "enum", + "members": { + "associating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associating" + } + }, + "associated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associated" + } + }, + "disassociating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociating" + } + }, + "disassociated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociated" + } + }, + "failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + } + } + }, + "com.amazonaws.ec2#RouteTableId": { + "type": "string" + }, + "com.amazonaws.ec2#RouteTableIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#RouteTableId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#RouteTableList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#RouteTable", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#RuleAction": { + "type": "enum", + "members": { + "allow": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "allow" + } + }, + "deny": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deny" + } + } + } + }, + "com.amazonaws.ec2#RuleGroupRuleOptionsPair": { + "type": "structure", + "members": { + "RuleGroupArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "RuleGroupArn", + "smithy.api#documentation": "

The ARN of the rule group.

", + "smithy.api#xmlName": "ruleGroupArn" + } + }, + "RuleOptions": { + "target": "com.amazonaws.ec2#RuleOptionList", + "traits": { + "aws.protocols#ec2QueryName": "RuleOptionSet", + "smithy.api#documentation": "

The rule options.

", + "smithy.api#xmlName": "ruleOptionSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the rule options for a stateful rule group.

" + } + }, + "com.amazonaws.ec2#RuleGroupRuleOptionsPairList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#RuleGroupRuleOptionsPair", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#RuleGroupTypePair": { + "type": "structure", + "members": { + "RuleGroupArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "RuleGroupArn", + "smithy.api#documentation": "

The ARN of the rule group.

", + "smithy.api#xmlName": "ruleGroupArn" + } + }, + "RuleGroupType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RuleGroupType", + "smithy.api#documentation": "

The rule group type. The possible values are Domain List and Suricata.

", + "smithy.api#xmlName": "ruleGroupType" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the type of a stateful rule group.

" + } + }, + "com.amazonaws.ec2#RuleGroupTypePairList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#RuleGroupTypePair", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#RuleOption": { + "type": "structure", + "members": { + "Keyword": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Keyword", + "smithy.api#documentation": "

The Suricata keyword.

", + "smithy.api#xmlName": "keyword" + } + }, + "Settings": { + "target": "com.amazonaws.ec2#StringList", + "traits": { + "aws.protocols#ec2QueryName": "SettingSet", + "smithy.api#documentation": "

The settings for the keyword.

", + "smithy.api#xmlName": "settingSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes additional settings for a stateful rule.

" + } + }, + "com.amazonaws.ec2#RuleOptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#RuleOption", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#RunInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RunInstancesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#Reservation" + }, + "traits": { + "smithy.api#documentation": "

Launches the specified number of instances using an AMI for which you have\n permissions.

\n

You can specify a number of options, or leave the default options. The following rules\n apply:

\n \n

You can create a launch template,\n which is a resource that contains the parameters to launch an instance. When you launch\n an instance using RunInstances, you can specify the launch template\n instead of specifying the launch parameters.

\n

To ensure faster instance launches, break up large requests into smaller batches. For\n example, create five separate launch requests for 100 instances each instead of one\n launch request for 500 instances.

\n

\n RunInstances is subject to both request rate limiting and resource rate\n limiting. For more information, see Request throttling.

\n

An instance is ready for you to use when it's in the running state. You\n can check the state of your instance using DescribeInstances. You can\n tag instances and EBS volumes during launch, after launch, or both. For more\n information, see CreateTags and Tagging your Amazon EC2\n resources.

\n

Linux instances have access to the public key of the key pair at boot. You can use\n this key to provide secure access to the instance. Amazon EC2 public images use this\n feature to provide secure access without passwords. For more information, see Key\n pairs.

\n

For troubleshooting, see What to do if\n an instance immediately terminates, and Troubleshooting connecting to your instance.

", + "smithy.api#examples": [ + { + "title": "To launch an instance", + "documentation": "This example launches an instance using the specified AMI, instance type, security group, subnet, block device mapping, and tags.", + "input": { + "BlockDeviceMappings": [ + { + "DeviceName": "/dev/sdh", + "Ebs": { + "VolumeSize": 100 + } + } + ], + "ImageId": "ami-abc12345", + "InstanceType": "t2.micro", + "KeyName": "my-key-pair", + "MaxCount": 1, + "MinCount": 1, + "SecurityGroupIds": [ + "sg-1a2b3c4d" + ], + "SubnetId": "subnet-6e7f829e", + "TagSpecifications": [ + { + "ResourceType": "instance", + "Tags": [ + { + "Key": "Purpose", + "Value": "test" + } + ] + } + ] + }, + "output": {} + } + ] + } + }, + "com.amazonaws.ec2#RunInstancesMonitoringEnabled": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Enabled", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is\n enabled.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "enabled" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the monitoring of an instance.

" + } + }, + "com.amazonaws.ec2#RunInstancesRequest": { + "type": "structure", + "members": { + "BlockDeviceMappings": { + "target": "com.amazonaws.ec2#BlockDeviceMappingRequestList", + "traits": { + "smithy.api#documentation": "

The block device mapping, which defines the EBS volumes and instance store volumes to\n attach to the instance at launch. For more information, see Block device\n mappings in the Amazon EC2 User Guide.

", + "smithy.api#xmlName": "BlockDeviceMapping" + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#documentation": "

The ID of the AMI. An AMI ID is required to launch an instance and must be specified\n here or in a launch template.

" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "smithy.api#documentation": "

The instance type. For more information, see Amazon EC2 instance\n types in the Amazon EC2 User Guide.

" + } + }, + "Ipv6AddressCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The number of IPv6 addresses to associate with the primary network\n interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You\n cannot specify this option and the option to assign specific IPv6 addresses in the same\n request. You can specify this option if you've specified a minimum number of instances\n to launch.

\n

You cannot specify this option and the network interfaces option in the same\n request.

" + } + }, + "Ipv6Addresses": { + "target": "com.amazonaws.ec2#InstanceIpv6AddressList", + "traits": { + "smithy.api#documentation": "

The IPv6 addresses from the range of the subnet to associate with the\n primary network interface. You cannot specify this option and the option to assign a\n number of IPv6 addresses in the same request. You cannot specify this option if you've\n specified a minimum number of instances to launch.

\n

You cannot specify this option and the network interfaces option in the same\n request.

", + "smithy.api#xmlName": "Ipv6Address" + } + }, + "KernelId": { + "target": "com.amazonaws.ec2#KernelId", + "traits": { + "smithy.api#documentation": "

The ID of the kernel.

\n \n

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see PV-GRUB in the\n Amazon EC2 User Guide.

\n " + } + }, + "KeyName": { + "target": "com.amazonaws.ec2#KeyPairName", + "traits": { + "smithy.api#documentation": "

The name of the key pair. You can create a key pair using CreateKeyPair or\n ImportKeyPair.

\n \n

If you do not specify a key pair, you can't connect to the instance unless you\n choose an AMI that is configured to allow users another way to log in.

\n " + } + }, + "MaxCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The maximum number of instances to launch. If you specify a value that is more\n capacity than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 \n launches the largest possible number of instances above the specified minimum\n count.

\n

Constraints: Between 1 and the quota for the specified instance type for your account for this Region. \n For more information, see Amazon EC2 instance type quotas.

", + "smithy.api#required": {} + } + }, + "MinCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The minimum number of instances to launch. If you specify a value that is more\n capacity than Amazon EC2 can provide in the target Availability Zone, Amazon EC2 does\n not launch any instances.

\n

Constraints: Between 1 and the quota for the specified instance type for your account for this Region.\n For more information, see Amazon EC2 instance type quotas.

", + "smithy.api#required": {} + } + }, + "Monitoring": { + "target": "com.amazonaws.ec2#RunInstancesMonitoringEnabled", + "traits": { + "smithy.api#documentation": "

Specifies whether detailed monitoring is enabled for the instance.

" + } + }, + "Placement": { + "target": "com.amazonaws.ec2#Placement", + "traits": { + "smithy.api#documentation": "

The placement for the instance.

" + } + }, + "RamdiskId": { + "target": "com.amazonaws.ec2#RamdiskId", + "traits": { + "smithy.api#documentation": "

The ID of the RAM disk to select. Some kernels require additional drivers at launch.\n Check the kernel requirements for information about whether you need to specify a RAM\n disk. To find kernel requirements, go to the Amazon Web Services Resource Center and\n search for the kernel ID.

\n \n

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see PV-GRUB in the\n Amazon EC2 User Guide.

\n " + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.ec2#SecurityGroupIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the security groups. You can create a security group using CreateSecurityGroup.

\n

If you specify a network interface, you must specify any security groups as part of\n the network interface instead of using this parameter.

", + "smithy.api#xmlName": "SecurityGroupId" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.ec2#SecurityGroupStringList", + "traits": { + "smithy.api#documentation": "

[Default VPC] The names of the security groups.

\n

If you specify a network interface, you must specify any security groups as part of\n the network interface instead of using this parameter.

\n

Default: Amazon EC2 uses the default security group.

", + "smithy.api#xmlName": "SecurityGroup" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "smithy.api#documentation": "

The ID of the subnet to launch the instance into.

\n

If you specify a network interface, you must specify any subnets as part of the\n network interface instead of using this parameter.

" + } + }, + "UserData": { + "target": "com.amazonaws.ec2#RunInstancesUserData", + "traits": { + "smithy.api#documentation": "

The user data to make available to the instance. User data must be base64-encoded.\n Depending on the tool or SDK that you're using, the base64-encoding might be performed for you.\n For more information, see Work with instance user data.

" + } + }, + "ElasticGpuSpecification": { + "target": "com.amazonaws.ec2#ElasticGpuSpecifications", + "traits": { + "smithy.api#documentation": "

An elastic GPU to associate with the instance.

\n \n

Amazon Elastic Graphics reached end of life on January 8, 2024.

\n " + } + }, + "ElasticInferenceAccelerators": { + "target": "com.amazonaws.ec2#ElasticInferenceAccelerators", + "traits": { + "smithy.api#documentation": "

An elastic inference accelerator to associate with the instance.

\n \n

Amazon Elastic Inference is no longer available.

\n ", + "smithy.api#xmlName": "ElasticInferenceAccelerator" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the resources that are created during instance launch.

\n

You can specify tags for the following resources only:

\n \n

To tag a resource after it has been created, see CreateTags.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "LaunchTemplate": { + "target": "com.amazonaws.ec2#LaunchTemplateSpecification", + "traits": { + "smithy.api#documentation": "

The launch template. Any additional parameters that you specify for the new instance \n overwrite the corresponding parameters included in the launch template.

" + } + }, + "InstanceMarketOptions": { + "target": "com.amazonaws.ec2#InstanceMarketOptionsRequest", + "traits": { + "smithy.api#documentation": "

The market (purchasing) option for the instances.

\n

For RunInstances, persistent Spot Instance requests are\n only supported when InstanceInterruptionBehavior is set\n to either hibernate or stop.

" + } + }, + "CreditSpecification": { + "target": "com.amazonaws.ec2#CreditSpecificationRequest", + "traits": { + "smithy.api#documentation": "

The credit option for CPU usage of the burstable performance instance. Valid values\n are standard and unlimited. To change this attribute after\n launch, use \n ModifyInstanceCreditSpecification. For more information, see Burstable\n performance instances in the Amazon EC2 User Guide.

\n

Default: standard (T2 instances) or unlimited (T3/T3a/T4g\n instances)

\n

For T3 instances with host tenancy, only standard is\n supported.

" + } + }, + "CpuOptions": { + "target": "com.amazonaws.ec2#CpuOptionsRequest", + "traits": { + "smithy.api#documentation": "

The CPU options for the instance. For more information, see Optimize CPU options in the Amazon EC2 User Guide.

" + } + }, + "CapacityReservationSpecification": { + "target": "com.amazonaws.ec2#CapacityReservationSpecification", + "traits": { + "smithy.api#documentation": "

Information about the Capacity Reservation targeting option. If you do not specify this parameter, the\n instance's Capacity Reservation preference defaults to open, which enables\n it to run in any open Capacity Reservation that has matching attributes (instance type,\n platform, Availability Zone, and tenancy).

" + } + }, + "HibernationOptions": { + "target": "com.amazonaws.ec2#HibernationOptionsRequest", + "traits": { + "smithy.api#documentation": "

Indicates whether an instance is enabled for hibernation. This parameter is valid only\n if the instance meets the hibernation\n prerequisites. For more information, see Hibernate your Amazon EC2\n instance in the Amazon EC2 User Guide.

\n

You can't enable hibernation and Amazon Web Services Nitro Enclaves on the same\n instance.

" + } + }, + "LicenseSpecifications": { + "target": "com.amazonaws.ec2#LicenseSpecificationListRequest", + "traits": { + "smithy.api#documentation": "

The license configurations.

", + "smithy.api#xmlName": "LicenseSpecification" + } + }, + "MetadataOptions": { + "target": "com.amazonaws.ec2#InstanceMetadataOptionsRequest", + "traits": { + "smithy.api#documentation": "

The metadata options for the instance. For more information, see Instance metadata and user data.

" + } + }, + "EnclaveOptions": { + "target": "com.amazonaws.ec2#EnclaveOptionsRequest", + "traits": { + "smithy.api#documentation": "

Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For\n more information, see What is Amazon Web Services Nitro\n Enclaves? in the Amazon Web Services Nitro Enclaves User\n Guide.

\n

You can't enable Amazon Web Services Nitro Enclaves and hibernation on the same\n instance.

" + } + }, + "PrivateDnsNameOptions": { + "target": "com.amazonaws.ec2#PrivateDnsNameOptionsRequest", + "traits": { + "smithy.api#documentation": "

The options for the instance hostname. \n The default values are inherited from the subnet.\n Applies only if creating a network interface, not attaching an existing one.

" + } + }, + "MaintenanceOptions": { + "target": "com.amazonaws.ec2#InstanceMaintenanceOptionsRequest", + "traits": { + "smithy.api#documentation": "

The maintenance and recovery options for the instance.

" + } + }, + "DisableApiStop": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether an instance is enabled for stop protection. For more information,\n see Stop\n protection.

" + } + }, + "EnablePrimaryIpv6": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

If you’re launching an instance into a dual-stack or IPv6-only subnet, you can enable\n assigning a primary IPv6 address. A primary IPv6 address is an IPv6 GUA address\n associated with an ENI that you have enabled to use a primary IPv6 address. Use this\n option if an instance relies on its IPv6 address not changing. When you launch the\n instance, Amazon Web Services will automatically assign an IPv6 address associated with\n the ENI attached to your instance to be the primary IPv6 address. Once you enable an\n IPv6 GUA address to be a primary IPv6, you cannot disable it. When you enable an IPv6\n GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6\n address until the instance is terminated or the network interface is detached. If you\n have multiple IPv6 addresses associated with an ENI attached to your instance and you\n enable a primary IPv6 address, the first IPv6 GUA address associated with the ENI\n becomes the primary IPv6 address.

" + } + }, + "NetworkPerformanceOptions": { + "target": "com.amazonaws.ec2#InstanceNetworkPerformanceOptionsRequest", + "traits": { + "smithy.api#documentation": "

Contains settings for the network performance options for the instance.

" + } + }, + "Operator": { + "target": "com.amazonaws.ec2#OperatorRequest", + "traits": { + "smithy.api#documentation": "

Reserved for internal use.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "DisableApiTermination": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DisableApiTermination", + "smithy.api#documentation": "

If you set this parameter to true, you can't terminate the instance using\n the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after\n launch, use ModifyInstanceAttribute. Alternatively, if you set\n InstanceInitiatedShutdownBehavior to terminate, you can\n terminate the instance by running the shutdown command from the instance.

\n

Default: false\n

", + "smithy.api#xmlName": "disableApiTermination" + } + }, + "InstanceInitiatedShutdownBehavior": { + "target": "com.amazonaws.ec2#ShutdownBehavior", + "traits": { + "aws.protocols#ec2QueryName": "InstanceInitiatedShutdownBehavior", + "smithy.api#documentation": "

Indicates whether an instance stops or terminates when you initiate shutdown from the\n instance (using the operating system command for system shutdown).

\n

Default: stop\n

", + "smithy.api#xmlName": "instanceInitiatedShutdownBehavior" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddress", + "smithy.api#documentation": "

The primary IPv4 address. You must specify a value from the IPv4 address\n range of the subnet.

\n

Only one private IP address can be designated as primary. You can't specify this\n option if you've specified the option to designate a private IP address as the primary\n IP address in a network interface specification. You cannot specify this option if\n you're launching more than one instance in the request.

\n

You cannot specify this option and the network interfaces option in the same\n request.

", + "smithy.api#xmlName": "privateIpAddress" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. If you do not specify a client token, a randomly generated token is used for\n the request to ensure idempotency.

\n

For more information, see Ensuring\n Idempotency.

\n

Constraints: Maximum 64 ASCII characters

", + "smithy.api#idempotencyToken": {}, + "smithy.api#xmlName": "clientToken" + } + }, + "AdditionalInfo": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AdditionalInfo", + "smithy.api#documentation": "

Reserved.

", + "smithy.api#xmlName": "additionalInfo" + } + }, + "NetworkInterfaces": { + "target": "com.amazonaws.ec2#InstanceNetworkInterfaceSpecificationList", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterface", + "smithy.api#documentation": "

The network interfaces to associate with the instance.

", + "smithy.api#xmlName": "networkInterface" + } + }, + "IamInstanceProfile": { + "target": "com.amazonaws.ec2#IamInstanceProfileSpecification", + "traits": { + "aws.protocols#ec2QueryName": "IamInstanceProfile", + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of an IAM instance\n profile.

", + "smithy.api#xmlName": "iamInstanceProfile" + } + }, + "EbsOptimized": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EbsOptimized", + "smithy.api#documentation": "

Indicates whether the instance is optimized for Amazon EBS I/O. This optimization\n provides dedicated throughput to Amazon EBS and an optimized configuration stack to\n provide optimal Amazon EBS I/O performance. This optimization isn't available with all\n instance types. Additional usage charges apply when using an EBS-optimized\n instance.

\n

Default: false\n

", + "smithy.api#xmlName": "ebsOptimized" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#RunInstancesUserData": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.ec2#RunScheduledInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RunScheduledInstancesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#RunScheduledInstancesResult" + }, + "traits": { + "smithy.api#documentation": "

Launches the specified Scheduled Instances.

\n

Before you can launch a Scheduled Instance, you must purchase it and obtain an identifier using PurchaseScheduledInstances.

\n

You must launch a Scheduled Instance during its scheduled time period. You can't stop or\n reboot a Scheduled Instance, but you can terminate it as needed. If you terminate a\n Scheduled Instance before the current scheduled time period ends, you can launch it again\n after a few minutes.

" + } + }, + "com.amazonaws.ec2#RunScheduledInstancesRequest": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that ensures the idempotency of the request. \n For more information, see Ensuring Idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "InstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The number of instances.

\n

Default: 1

" + } + }, + "LaunchSpecification": { + "target": "com.amazonaws.ec2#ScheduledInstancesLaunchSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The launch specification. You must match the instance type, Availability Zone, \n network, and platform of the schedule that you purchased.

", + "smithy.api#required": {} + } + }, + "ScheduledInstanceId": { + "target": "com.amazonaws.ec2#ScheduledInstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Scheduled Instance ID.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for RunScheduledInstances.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#RunScheduledInstancesResult": { + "type": "structure", + "members": { + "InstanceIdSet": { + "target": "com.amazonaws.ec2#InstanceIdSet", + "traits": { + "aws.protocols#ec2QueryName": "InstanceIdSet", + "smithy.api#documentation": "

The IDs of the newly launched instances.

", + "smithy.api#xmlName": "instanceIdSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of RunScheduledInstances.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#S3ObjectTag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The key of the tag.

\n

Constraints: Tag keys are case-sensitive and can be up to 128 Unicode characters in\n length. May not begin with aws:.

" + } + }, + "Value": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The value of the tag.

\n

Constraints: Tag values are case-sensitive and can be up to 256 Unicode characters in\n length.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The tags to apply to the AMI object that will be stored in the Amazon S3 bucket. For more\n information, see Categorizing your storage using\n tags in the Amazon Simple Storage Service User Guide.

" + } + }, + "com.amazonaws.ec2#S3ObjectTagList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#S3ObjectTag", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#S3Storage": { + "type": "structure", + "members": { + "AWSAccessKeyId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The access key ID of the owner of the bucket. Before you specify a value for your access\n key ID, review and follow the guidance in Best Practices for Amazon Web Services\n accounts in the Account ManagementReference Guide.

" + } + }, + "Bucket": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Bucket", + "smithy.api#documentation": "

The bucket in which to store the AMI. You can specify a bucket that you already own or a\n new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone\n else, Amazon EC2 returns an error.

", + "smithy.api#xmlName": "bucket" + } + }, + "Prefix": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Prefix", + "smithy.api#documentation": "

The beginning of the file name of the AMI.

", + "smithy.api#xmlName": "prefix" + } + }, + "UploadPolicy": { + "target": "com.amazonaws.ec2#Blob", + "traits": { + "aws.protocols#ec2QueryName": "UploadPolicy", + "smithy.api#documentation": "

An Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your\n behalf.

", + "smithy.api#xmlName": "uploadPolicy" + } + }, + "UploadPolicySignature": { + "target": "com.amazonaws.ec2#S3StorageUploadPolicySignature", + "traits": { + "aws.protocols#ec2QueryName": "UploadPolicySignature", + "smithy.api#documentation": "

The signature of the JSON document.

", + "smithy.api#xmlName": "uploadPolicySignature" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the storage parameters for Amazon S3 and Amazon S3 buckets for an instance store-backed\n AMI.

" + } + }, + "com.amazonaws.ec2#S3StorageUploadPolicySignature": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.ec2#SSEType": { + "type": "enum", + "members": { + "sse_ebs": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sse-ebs" + } + }, + "sse_kms": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sse-kms" + } + }, + "none": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "none" + } + } + } + }, + "com.amazonaws.ec2#ScheduledInstance": { + "type": "structure", + "members": { + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "CreateDate": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreateDate", + "smithy.api#documentation": "

The date when the Scheduled Instance was purchased.

", + "smithy.api#xmlName": "createDate" + } + }, + "HourlyPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "HourlyPrice", + "smithy.api#documentation": "

The hourly price for a single instance.

", + "smithy.api#xmlName": "hourlyPrice" + } + }, + "InstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "InstanceCount", + "smithy.api#documentation": "

The number of instances.

", + "smithy.api#xmlName": "instanceCount" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type.

", + "smithy.api#xmlName": "instanceType" + } + }, + "NetworkPlatform": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkPlatform", + "smithy.api#documentation": "

The network platform.

", + "smithy.api#xmlName": "networkPlatform" + } + }, + "NextSlotStartTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "NextSlotStartTime", + "smithy.api#documentation": "

The time for the next schedule to start.

", + "smithy.api#xmlName": "nextSlotStartTime" + } + }, + "Platform": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Platform", + "smithy.api#documentation": "

The platform (Linux/UNIX or Windows).

", + "smithy.api#xmlName": "platform" + } + }, + "PreviousSlotEndTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "PreviousSlotEndTime", + "smithy.api#documentation": "

The time that the previous schedule ended or will end.

", + "smithy.api#xmlName": "previousSlotEndTime" + } + }, + "Recurrence": { + "target": "com.amazonaws.ec2#ScheduledInstanceRecurrence", + "traits": { + "aws.protocols#ec2QueryName": "Recurrence", + "smithy.api#documentation": "

The schedule recurrence.

", + "smithy.api#xmlName": "recurrence" + } + }, + "ScheduledInstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ScheduledInstanceId", + "smithy.api#documentation": "

The Scheduled Instance ID.

", + "smithy.api#xmlName": "scheduledInstanceId" + } + }, + "SlotDurationInHours": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "SlotDurationInHours", + "smithy.api#documentation": "

The number of hours in the schedule.

", + "smithy.api#xmlName": "slotDurationInHours" + } + }, + "TermEndDate": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "TermEndDate", + "smithy.api#documentation": "

The end date for the Scheduled Instance.

", + "smithy.api#xmlName": "termEndDate" + } + }, + "TermStartDate": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "TermStartDate", + "smithy.api#documentation": "

The start date for the Scheduled Instance.

", + "smithy.api#xmlName": "termStartDate" + } + }, + "TotalScheduledInstanceHours": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TotalScheduledInstanceHours", + "smithy.api#documentation": "

The total number of hours for a single instance for the entire term.

", + "smithy.api#xmlName": "totalScheduledInstanceHours" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Scheduled Instance.

" + } + }, + "com.amazonaws.ec2#ScheduledInstanceAvailability": { + "type": "structure", + "members": { + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "AvailableInstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "AvailableInstanceCount", + "smithy.api#documentation": "

The number of available instances.

", + "smithy.api#xmlName": "availableInstanceCount" + } + }, + "FirstSlotStartTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "FirstSlotStartTime", + "smithy.api#documentation": "

The time period for the first schedule to start.

", + "smithy.api#xmlName": "firstSlotStartTime" + } + }, + "HourlyPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "HourlyPrice", + "smithy.api#documentation": "

The hourly price for a single instance.

", + "smithy.api#xmlName": "hourlyPrice" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type. You can specify one of the C3, C4, M4, or R3 instance types.

", + "smithy.api#xmlName": "instanceType" + } + }, + "MaxTermDurationInDays": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "MaxTermDurationInDays", + "smithy.api#documentation": "

The maximum term. The only possible value is 365 days.

", + "smithy.api#xmlName": "maxTermDurationInDays" + } + }, + "MinTermDurationInDays": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "MinTermDurationInDays", + "smithy.api#documentation": "

The minimum term. The only possible value is 365 days.

", + "smithy.api#xmlName": "minTermDurationInDays" + } + }, + "NetworkPlatform": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkPlatform", + "smithy.api#documentation": "

The network platform.

", + "smithy.api#xmlName": "networkPlatform" + } + }, + "Platform": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Platform", + "smithy.api#documentation": "

The platform (Linux/UNIX or Windows).

", + "smithy.api#xmlName": "platform" + } + }, + "PurchaseToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PurchaseToken", + "smithy.api#documentation": "

The purchase token. This token expires in two hours.

", + "smithy.api#xmlName": "purchaseToken" + } + }, + "Recurrence": { + "target": "com.amazonaws.ec2#ScheduledInstanceRecurrence", + "traits": { + "aws.protocols#ec2QueryName": "Recurrence", + "smithy.api#documentation": "

The schedule recurrence.

", + "smithy.api#xmlName": "recurrence" + } + }, + "SlotDurationInHours": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "SlotDurationInHours", + "smithy.api#documentation": "

The number of hours in the schedule.

", + "smithy.api#xmlName": "slotDurationInHours" + } + }, + "TotalScheduledInstanceHours": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TotalScheduledInstanceHours", + "smithy.api#documentation": "

The total number of hours for a single instance for the entire term.

", + "smithy.api#xmlName": "totalScheduledInstanceHours" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a schedule that is available for your Scheduled Instances.

" + } + }, + "com.amazonaws.ec2#ScheduledInstanceAvailabilitySet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ScheduledInstanceAvailability", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ScheduledInstanceId": { + "type": "string" + }, + "com.amazonaws.ec2#ScheduledInstanceIdRequestSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ScheduledInstanceId", + "traits": { + "smithy.api#xmlName": "ScheduledInstanceId" + } + } + }, + "com.amazonaws.ec2#ScheduledInstanceRecurrence": { + "type": "structure", + "members": { + "Frequency": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Frequency", + "smithy.api#documentation": "

The frequency (Daily, Weekly, or Monthly).

", + "smithy.api#xmlName": "frequency" + } + }, + "Interval": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Interval", + "smithy.api#documentation": "

The interval quantity. The interval unit depends on the value of frequency. For example, every 2\n weeks or every 2 months.

", + "smithy.api#xmlName": "interval" + } + }, + "OccurrenceDaySet": { + "target": "com.amazonaws.ec2#OccurrenceDaySet", + "traits": { + "aws.protocols#ec2QueryName": "OccurrenceDaySet", + "smithy.api#documentation": "

The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday).

", + "smithy.api#xmlName": "occurrenceDaySet" + } + }, + "OccurrenceRelativeToEnd": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "OccurrenceRelativeToEnd", + "smithy.api#documentation": "

Indicates whether the occurrence is relative to the end of the specified week or month.

", + "smithy.api#xmlName": "occurrenceRelativeToEnd" + } + }, + "OccurrenceUnit": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OccurrenceUnit", + "smithy.api#documentation": "

The unit for occurrenceDaySet (DayOfWeek or DayOfMonth).

", + "smithy.api#xmlName": "occurrenceUnit" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the recurring schedule for a Scheduled Instance.

" + } + }, + "com.amazonaws.ec2#ScheduledInstanceRecurrenceRequest": { + "type": "structure", + "members": { + "Frequency": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The frequency (Daily, Weekly, or Monthly).

" + } + }, + "Interval": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The interval quantity. The interval unit depends on the value of Frequency. For example, every 2 \n weeks or every 2 months.

" + } + }, + "OccurrenceDays": { + "target": "com.amazonaws.ec2#OccurrenceDayRequestSet", + "traits": { + "smithy.api#documentation": "

The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.

", + "smithy.api#xmlName": "OccurrenceDay" + } + }, + "OccurrenceRelativeToEnd": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.

" + } + }, + "OccurrenceUnit": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The unit for OccurrenceDays (DayOfWeek or DayOfMonth).\n This value is required for a monthly schedule.\n You can't specify DayOfWeek with a weekly schedule.\n You can't specify this value with a daily schedule.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the recurring schedule for a Scheduled Instance.

" + } + }, + "com.amazonaws.ec2#ScheduledInstanceSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ScheduledInstance", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ScheduledInstancesBlockDeviceMapping": { + "type": "structure", + "members": { + "DeviceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The device name (for example, /dev/sdh or xvdh).

" + } + }, + "Ebs": { + "target": "com.amazonaws.ec2#ScheduledInstancesEbs", + "traits": { + "smithy.api#documentation": "

Parameters used to set up EBS volumes automatically when the instance is launched.

" + } + }, + "NoDevice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

To omit the device from the block device mapping, specify an empty string.

" + } + }, + "VirtualName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The virtual device name (ephemeralN). Instance store volumes are numbered\n starting from 0. An instance type with two available instance store volumes can specify mappings\n for ephemeral0 and ephemeral1. The number of available instance store\n volumes depends on the instance type. After you connect to the instance, you must mount the\n volume.

\n

Constraints: For M3 instances, you must specify instance store volumes in the block device \n mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes \n specified in the block device mapping for the AMI.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a block device mapping for a Scheduled Instance.

" + } + }, + "com.amazonaws.ec2#ScheduledInstancesBlockDeviceMappingSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ScheduledInstancesBlockDeviceMapping", + "traits": { + "smithy.api#xmlName": "BlockDeviceMapping" + } + } + }, + "com.amazonaws.ec2#ScheduledInstancesEbs": { + "type": "structure", + "members": { + "DeleteOnTermination": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the volume is deleted on instance termination.

" + } + }, + "Encrypted": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the volume is encrypted. You can attached encrypted volumes only to instances that \n support them.

" + } + }, + "Iops": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The number of I/O operations per second (IOPS) to provision for a gp3, io1, or io2 \n \t volume.

" + } + }, + "SnapshotId": { + "target": "com.amazonaws.ec2#SnapshotId", + "traits": { + "smithy.api#documentation": "

The ID of the snapshot.

" + } + }, + "VolumeSize": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The size of the volume, in GiB.

\n

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default \n is the snapshot size.

" + } + }, + "VolumeType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The volume type.

\n

Default: gp2\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an EBS volume for a Scheduled Instance.

" + } + }, + "com.amazonaws.ec2#ScheduledInstancesIamInstanceProfile": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN).

" + } + }, + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an IAM instance profile for a Scheduled Instance.

" + } + }, + "com.amazonaws.ec2#ScheduledInstancesIpv6Address": { + "type": "structure", + "members": { + "Ipv6Address": { + "target": "com.amazonaws.ec2#Ipv6Address", + "traits": { + "smithy.api#documentation": "

The IPv6 address.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an IPv6 address.

" + } + }, + "com.amazonaws.ec2#ScheduledInstancesIpv6AddressList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ScheduledInstancesIpv6Address", + "traits": { + "smithy.api#xmlName": "Ipv6Address" + } + } + }, + "com.amazonaws.ec2#ScheduledInstancesLaunchSpecification": { + "type": "structure", + "members": { + "BlockDeviceMappings": { + "target": "com.amazonaws.ec2#ScheduledInstancesBlockDeviceMappingSet", + "traits": { + "smithy.api#documentation": "

The block device mapping entries.

", + "smithy.api#xmlName": "BlockDeviceMapping" + } + }, + "EbsOptimized": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

\n

Default: false\n

" + } + }, + "IamInstanceProfile": { + "target": "com.amazonaws.ec2#ScheduledInstancesIamInstanceProfile", + "traits": { + "smithy.api#documentation": "

The IAM instance profile.

" + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Amazon Machine Image (AMI).

", + "smithy.api#required": {} + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The instance type.

" + } + }, + "KernelId": { + "target": "com.amazonaws.ec2#KernelId", + "traits": { + "smithy.api#documentation": "

The ID of the kernel.

" + } + }, + "KeyName": { + "target": "com.amazonaws.ec2#KeyPairName", + "traits": { + "smithy.api#documentation": "

The name of the key pair.

" + } + }, + "Monitoring": { + "target": "com.amazonaws.ec2#ScheduledInstancesMonitoring", + "traits": { + "smithy.api#documentation": "

Enable or disable monitoring for the instances.

" + } + }, + "NetworkInterfaces": { + "target": "com.amazonaws.ec2#ScheduledInstancesNetworkInterfaceSet", + "traits": { + "smithy.api#documentation": "

The network interfaces.

", + "smithy.api#xmlName": "NetworkInterface" + } + }, + "Placement": { + "target": "com.amazonaws.ec2#ScheduledInstancesPlacement", + "traits": { + "smithy.api#documentation": "

The placement information.

" + } + }, + "RamdiskId": { + "target": "com.amazonaws.ec2#RamdiskId", + "traits": { + "smithy.api#documentation": "

The ID of the RAM disk.

" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.ec2#ScheduledInstancesSecurityGroupIdSet", + "traits": { + "smithy.api#documentation": "

The IDs of the security groups.

", + "smithy.api#xmlName": "SecurityGroupId" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "smithy.api#documentation": "

The ID of the subnet in which to launch the instances.

" + } + }, + "UserData": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The base64-encoded MIME user data.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the launch specification for a Scheduled Instance.

\n

If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet.\n You can specify the subnet using either SubnetId or NetworkInterface.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.ec2#ScheduledInstancesMonitoring": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether monitoring is enabled.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes whether monitoring is enabled for a Scheduled Instance.

" + } + }, + "com.amazonaws.ec2#ScheduledInstancesNetworkInterface": { + "type": "structure", + "members": { + "AssociatePublicIpAddress": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether to assign a public IPv4 address to instances launched in a VPC. The\n public IPv4 address can only be assigned to a network interface for eth0, and can only be\n assigned to a new network interface, not an existing one. You cannot specify more than one\n network interface in the request. If launching into a default subnet, the default value is\n true.

\n

Amazon Web Services charges for all public IPv4 addresses, including public IPv4 addresses \nassociated with running instances and Elastic IP addresses. For more information, see the Public IPv4 Address tab on the Amazon VPC pricing page.

" + } + }, + "DeleteOnTermination": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether to delete the interface when the instance is terminated.

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The description.

" + } + }, + "DeviceIndex": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The index of the device for the network interface attachment.

" + } + }, + "Groups": { + "target": "com.amazonaws.ec2#ScheduledInstancesSecurityGroupIdSet", + "traits": { + "smithy.api#documentation": "

The IDs of the security groups.

", + "smithy.api#xmlName": "Group" + } + }, + "Ipv6AddressCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The number of IPv6 addresses to assign to the network interface. The IPv6 addresses are automatically selected from the subnet range.

" + } + }, + "Ipv6Addresses": { + "target": "com.amazonaws.ec2#ScheduledInstancesIpv6AddressList", + "traits": { + "smithy.api#documentation": "

The specific IPv6 addresses from the subnet range.

", + "smithy.api#xmlName": "Ipv6Address" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "smithy.api#documentation": "

The ID of the network interface.

" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IPv4 address of the network interface within the subnet.

" + } + }, + "PrivateIpAddressConfigs": { + "target": "com.amazonaws.ec2#PrivateIpAddressConfigSet", + "traits": { + "smithy.api#documentation": "

The private IPv4 addresses.

", + "smithy.api#xmlName": "PrivateIpAddressConfig" + } + }, + "SecondaryPrivateIpAddressCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The number of secondary private IPv4 addresses.

" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "smithy.api#documentation": "

The ID of the subnet.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a network interface for a Scheduled Instance.

" + } + }, + "com.amazonaws.ec2#ScheduledInstancesNetworkInterfaceSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ScheduledInstancesNetworkInterface", + "traits": { + "smithy.api#xmlName": "NetworkInterface" + } + } + }, + "com.amazonaws.ec2#ScheduledInstancesPlacement": { + "type": "structure", + "members": { + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone.

" + } + }, + "GroupName": { + "target": "com.amazonaws.ec2#PlacementGroupName", + "traits": { + "smithy.api#documentation": "

The name of the placement group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the placement for a Scheduled Instance.

" + } + }, + "com.amazonaws.ec2#ScheduledInstancesPrivateIpAddressConfig": { + "type": "structure", + "members": { + "Primary": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether this is a primary IPv4 address. Otherwise, this is a secondary IPv4 address.

" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IPv4 address.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a private IPv4 address for a Scheduled Instance.

" + } + }, + "com.amazonaws.ec2#ScheduledInstancesSecurityGroupIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "smithy.api#xmlName": "SecurityGroupId" + } + } + }, + "com.amazonaws.ec2#SearchLocalGatewayRoutes": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#SearchLocalGatewayRoutesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#SearchLocalGatewayRoutesResult" + }, + "traits": { + "smithy.api#documentation": "

Searches for routes in the specified local gateway route table.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Routes", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#SearchLocalGatewayRoutesRequest": { + "type": "structure", + "members": { + "LocalGatewayRouteTableId": { + "target": "com.amazonaws.ec2#LocalGatewayRoutetableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the local gateway route table.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#SearchLocalGatewayRoutesResult": { + "type": "structure", + "members": { + "Routes": { + "target": "com.amazonaws.ec2#LocalGatewayRouteList", + "traits": { + "aws.protocols#ec2QueryName": "RouteSet", + "smithy.api#documentation": "

Information about the routes.

", + "smithy.api#xmlName": "routeSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#SearchTransitGatewayMulticastGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#SearchTransitGatewayMulticastGroupsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#SearchTransitGatewayMulticastGroupsResult" + }, + "traits": { + "smithy.api#documentation": "

Searches one or more transit gateway multicast groups and returns the group membership information.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "MulticastGroups", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#SearchTransitGatewayMulticastGroupsRequest": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#TransitGatewayMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#SearchTransitGatewayMulticastGroupsResult": { + "type": "structure", + "members": { + "MulticastGroups": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastGroupList", + "traits": { + "aws.protocols#ec2QueryName": "MulticastGroups", + "smithy.api#documentation": "

Information about the transit gateway multicast group.

", + "smithy.api#xmlName": "multicastGroups" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#SearchTransitGatewayRoutes": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#SearchTransitGatewayRoutesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#SearchTransitGatewayRoutesResult" + }, + "traits": { + "smithy.api#documentation": "

Searches for routes in the specified transit gateway route table.

" + } + }, + "com.amazonaws.ec2#SearchTransitGatewayRoutesRequest": { + "type": "structure", + "members": { + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway route table.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#required": {}, + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#TransitGatewayMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of routes to return. If a value is not provided, the default is\n 1000.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#SearchTransitGatewayRoutesResult": { + "type": "structure", + "members": { + "Routes": { + "target": "com.amazonaws.ec2#TransitGatewayRouteList", + "traits": { + "aws.protocols#ec2QueryName": "RouteSet", + "smithy.api#documentation": "

Information about the routes.

", + "smithy.api#xmlName": "routeSet" + } + }, + "AdditionalRoutesAvailable": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "AdditionalRoutesAvailable", + "smithy.api#documentation": "

Indicates whether there are additional routes available.

", + "smithy.api#xmlName": "additionalRoutesAvailable" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#SecurityGroup": { + "type": "structure", + "members": { + "GroupId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupId", + "smithy.api#documentation": "

The ID of the security group.

", + "smithy.api#xmlName": "groupId" + } + }, + "IpPermissionsEgress": { + "target": "com.amazonaws.ec2#IpPermissionList", + "traits": { + "aws.protocols#ec2QueryName": "IpPermissionsEgress", + "smithy.api#documentation": "

The outbound rules associated with the security group.

", + "smithy.api#xmlName": "ipPermissionsEgress" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the security group.

", + "smithy.api#xmlName": "tagSet" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC for the security group.

", + "smithy.api#xmlName": "vpcId" + } + }, + "SecurityGroupArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroupArn", + "smithy.api#documentation": "

The ARN of the security group.

", + "smithy.api#xmlName": "securityGroupArn" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The Amazon Web Services account ID of the owner of the security group.

", + "smithy.api#xmlName": "ownerId" + } + }, + "GroupName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupName", + "smithy.api#documentation": "

The name of the security group.

", + "smithy.api#xmlName": "groupName" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupDescription", + "smithy.api#documentation": "

A description of the security group.

", + "smithy.api#xmlName": "groupDescription" + } + }, + "IpPermissions": { + "target": "com.amazonaws.ec2#IpPermissionList", + "traits": { + "aws.protocols#ec2QueryName": "IpPermissions", + "smithy.api#documentation": "

The inbound rules associated with the security group.

", + "smithy.api#xmlName": "ipPermissions" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a security group.

" + } + }, + "com.amazonaws.ec2#SecurityGroupForVpc": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The security group's description.

", + "smithy.api#xmlName": "description" + } + }, + "GroupName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupName", + "smithy.api#documentation": "

The security group name.

", + "smithy.api#xmlName": "groupName" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The security group owner ID.

", + "smithy.api#xmlName": "ownerId" + } + }, + "GroupId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupId", + "smithy.api#documentation": "

The security group ID.

", + "smithy.api#xmlName": "groupId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The security group tags.

", + "smithy.api#xmlName": "tagSet" + } + }, + "PrimaryVpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrimaryVpcId", + "smithy.api#documentation": "

The VPC ID in which the security group was created.

", + "smithy.api#xmlName": "primaryVpcId" + } + } + }, + "traits": { + "smithy.api#documentation": "

A security group that can be used by interfaces in the VPC.

" + } + }, + "com.amazonaws.ec2#SecurityGroupForVpcList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SecurityGroupForVpc", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SecurityGroupId": { + "type": "string" + }, + "com.amazonaws.ec2#SecurityGroupIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SecurityGroupIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SecurityGroupIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "smithy.api#xmlName": "SecurityGroupId" + } + } + }, + "com.amazonaws.ec2#SecurityGroupIdStringListRequest": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "smithy.api#xmlName": "SecurityGroupId" + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 16 + } + } + }, + "com.amazonaws.ec2#SecurityGroupIdentifier": { + "type": "structure", + "members": { + "GroupId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupId", + "smithy.api#documentation": "

The ID of the security group.

", + "smithy.api#xmlName": "groupId" + } + }, + "GroupName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupName", + "smithy.api#documentation": "

The name of the security group.

", + "smithy.api#xmlName": "groupName" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a security group.

" + } + }, + "com.amazonaws.ec2#SecurityGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SecurityGroup", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SecurityGroupName": { + "type": "string" + }, + "com.amazonaws.ec2#SecurityGroupReference": { + "type": "structure", + "members": { + "GroupId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupId", + "smithy.api#documentation": "

The ID of your security group.

", + "smithy.api#xmlName": "groupId" + } + }, + "ReferencingVpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ReferencingVpcId", + "smithy.api#documentation": "

The ID of the VPC with the referencing security group.

", + "smithy.api#xmlName": "referencingVpcId" + } + }, + "VpcPeeringConnectionId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcPeeringConnectionId", + "smithy.api#documentation": "

The ID of the VPC peering connection (if applicable). For more information about security group referencing for peering connections, see \n Update your security groups to reference peer security groups \n in the VPC Peering Guide.

", + "smithy.api#xmlName": "vpcPeeringConnectionId" + } + }, + "TransitGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayId", + "smithy.api#documentation": "\n

This parameter is in preview and may not be available for your account.

\n \n

The ID of the transit gateway (if applicable).

", + "smithy.api#xmlName": "transitGatewayId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a VPC with a security group that references your security group.

" + } + }, + "com.amazonaws.ec2#SecurityGroupReferences": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SecurityGroupReference", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SecurityGroupReferencingSupportValue": { + "type": "enum", + "members": { + "enable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enable" + } + }, + "disable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disable" + } + } + } + }, + "com.amazonaws.ec2#SecurityGroupRule": { + "type": "structure", + "members": { + "SecurityGroupRuleId": { + "target": "com.amazonaws.ec2#SecurityGroupRuleId", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroupRuleId", + "smithy.api#documentation": "

The ID of the security group rule.

", + "smithy.api#xmlName": "securityGroupRuleId" + } + }, + "GroupId": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "aws.protocols#ec2QueryName": "GroupId", + "smithy.api#documentation": "

The ID of the security group.

", + "smithy.api#xmlName": "groupId" + } + }, + "GroupOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupOwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the security group.

", + "smithy.api#xmlName": "groupOwnerId" + } + }, + "IsEgress": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "IsEgress", + "smithy.api#documentation": "

Indicates whether the security group rule is an outbound rule.

", + "smithy.api#xmlName": "isEgress" + } + }, + "IpProtocol": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IpProtocol", + "smithy.api#documentation": "

The IP protocol name (tcp, udp, icmp,\n icmpv6) or number (see Protocol Numbers).

\n

Use -1 to specify all protocols.

", + "smithy.api#xmlName": "ipProtocol" + } + }, + "FromPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "FromPort", + "smithy.api#documentation": "

If the protocol is TCP or UDP, this is the start of the port range.\n If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types).

", + "smithy.api#xmlName": "fromPort" + } + }, + "ToPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "ToPort", + "smithy.api#documentation": "

If the protocol is TCP or UDP, this is the end of the port range.\n If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). \n If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes).

", + "smithy.api#xmlName": "toPort" + } + }, + "CidrIpv4": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CidrIpv4", + "smithy.api#documentation": "

The IPv4 CIDR range.

", + "smithy.api#xmlName": "cidrIpv4" + } + }, + "CidrIpv6": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CidrIpv6", + "smithy.api#documentation": "

The IPv6 CIDR range.

", + "smithy.api#xmlName": "cidrIpv6" + } + }, + "PrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "aws.protocols#ec2QueryName": "PrefixListId", + "smithy.api#documentation": "

The ID of the prefix list.

", + "smithy.api#xmlName": "prefixListId" + } + }, + "ReferencedGroupInfo": { + "target": "com.amazonaws.ec2#ReferencedSecurityGroup", + "traits": { + "aws.protocols#ec2QueryName": "ReferencedGroupInfo", + "smithy.api#documentation": "

Describes the security group that is referenced in the rule.

", + "smithy.api#xmlName": "referencedGroupInfo" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The security group rule description.

", + "smithy.api#xmlName": "description" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags applied to the security group rule.

", + "smithy.api#xmlName": "tagSet" + } + }, + "SecurityGroupRuleArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroupRuleArn", + "smithy.api#documentation": "

The ARN of the security group rule.

", + "smithy.api#xmlName": "securityGroupRuleArn" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a security group rule.

" + } + }, + "com.amazonaws.ec2#SecurityGroupRuleDescription": { + "type": "structure", + "members": { + "SecurityGroupRuleId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ID of the security group rule.

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The description of the security group rule.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the description of a security group rule.

\n

You can use this when you want to update the security group rule description for either an inbound or outbound rule.

" + } + }, + "com.amazonaws.ec2#SecurityGroupRuleDescriptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SecurityGroupRuleDescription", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SecurityGroupRuleId": { + "type": "string" + }, + "com.amazonaws.ec2#SecurityGroupRuleIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SecurityGroupRuleList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SecurityGroupRule", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SecurityGroupRuleRequest": { + "type": "structure", + "members": { + "IpProtocol": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IP protocol name (tcp, udp, icmp,\n icmpv6) or number (see Protocol Numbers).

\n

Use -1 to specify all protocols.

" + } + }, + "FromPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

If the protocol is TCP or UDP, this is the start of the port range.\n If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types).

" + } + }, + "ToPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

If the protocol is TCP or UDP, this is the end of the port range.\n If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). \n If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes).

" + } + }, + "CidrIpv4": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IPv4 CIDR range. To specify a single IPv4 address, use the /32 prefix length.

" + } + }, + "CidrIpv6": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IPv6 CIDR range. To specify a single IPv6 address, use the /128 prefix length.

" + } + }, + "PrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the prefix list.

" + } + }, + "ReferencedGroupId": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "smithy.api#documentation": "

The ID of the security group that is referenced in the security group rule.

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The description of the security group rule.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a security group rule.

\n

You must specify exactly one of the following parameters, based on the rule type:

\n \n

When you modify a rule, you cannot change the rule type. For example, if the rule \n uses an IPv4 address range, you must use CidrIpv4 to specify a new IPv4 \n address range.

" + } + }, + "com.amazonaws.ec2#SecurityGroupRuleUpdate": { + "type": "structure", + "members": { + "SecurityGroupRuleId": { + "target": "com.amazonaws.ec2#SecurityGroupRuleId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the security group rule.

", + "smithy.api#required": {} + } + }, + "SecurityGroupRule": { + "target": "com.amazonaws.ec2#SecurityGroupRuleRequest", + "traits": { + "smithy.api#documentation": "

Information about the security group rule.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an update to a security group rule.

" + } + }, + "com.amazonaws.ec2#SecurityGroupRuleUpdateList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SecurityGroupRuleUpdate", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SecurityGroupStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SecurityGroupName", + "traits": { + "smithy.api#xmlName": "SecurityGroup" + } + } + }, + "com.amazonaws.ec2#SecurityGroupVpcAssociation": { + "type": "structure", + "members": { + "GroupId": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "aws.protocols#ec2QueryName": "GroupId", + "smithy.api#documentation": "

The association's security group ID.

", + "smithy.api#xmlName": "groupId" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The association's VPC ID.

", + "smithy.api#xmlName": "vpcId" + } + }, + "VpcOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcOwnerId", + "smithy.api#documentation": "

The Amazon Web Services account ID of the owner of the VPC.

", + "smithy.api#xmlName": "vpcOwnerId" + } + }, + "State": { + "target": "com.amazonaws.ec2#SecurityGroupVpcAssociationState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The association's state.

", + "smithy.api#xmlName": "state" + } + }, + "StateReason": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StateReason", + "smithy.api#documentation": "

The association's state reason.

", + "smithy.api#xmlName": "stateReason" + } + } + }, + "traits": { + "smithy.api#documentation": "

A security group association with a VPC that you made with AssociateSecurityGroupVpc.

" + } + }, + "com.amazonaws.ec2#SecurityGroupVpcAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SecurityGroupVpcAssociation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SecurityGroupVpcAssociationState": { + "type": "enum", + "members": { + "associating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associating" + } + }, + "associated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associated" + } + }, + "association_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "association-failed" + } + }, + "disassociating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociating" + } + }, + "disassociated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociated" + } + }, + "disassociation_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociation-failed" + } + } + } + }, + "com.amazonaws.ec2#SelfServicePortal": { + "type": "enum", + "members": { + "enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + }, + "disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + } + } + }, + "com.amazonaws.ec2#SendDiagnosticInterrupt": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#SendDiagnosticInterruptRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Sends a diagnostic interrupt to the specified Amazon EC2 instance to trigger a\n kernel panic (on Linux instances), or a blue\n screen/stop error (on Windows instances). For\n instances based on Intel and AMD processors, the interrupt is received as a\n non-maskable interrupt (NMI).

\n

In general, the operating system crashes and reboots when a kernel panic or stop error\n is triggered. The operating system can also be configured to perform diagnostic tasks,\n such as generating a memory dump file, loading a secondary kernel, or obtaining a call\n trace.

\n

Before sending a diagnostic interrupt to your instance, ensure that its operating\n system is configured to perform the required diagnostic tasks.

\n

For more information about configuring your operating system to generate a crash dump\n when a kernel panic or stop error occurs, see Send a diagnostic interrupt\n (for advanced users) in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#SendDiagnosticInterruptRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#SensitiveUrl": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.ec2#SensitiveUserData": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.ec2#ServiceConfiguration": { + "type": "structure", + "members": { + "ServiceType": { + "target": "com.amazonaws.ec2#ServiceTypeDetailSet", + "traits": { + "aws.protocols#ec2QueryName": "ServiceType", + "smithy.api#documentation": "

The type of service.

", + "smithy.api#xmlName": "serviceType" + } + }, + "ServiceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ServiceId", + "smithy.api#documentation": "

The ID of the service.

", + "smithy.api#xmlName": "serviceId" + } + }, + "ServiceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ServiceName", + "smithy.api#documentation": "

The name of the service.

", + "smithy.api#xmlName": "serviceName" + } + }, + "ServiceState": { + "target": "com.amazonaws.ec2#ServiceState", + "traits": { + "aws.protocols#ec2QueryName": "ServiceState", + "smithy.api#documentation": "

The service state.

", + "smithy.api#xmlName": "serviceState" + } + }, + "AvailabilityZones": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZoneSet", + "smithy.api#documentation": "

The Availability Zones in which the service is available.

", + "smithy.api#xmlName": "availabilityZoneSet" + } + }, + "AcceptanceRequired": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "AcceptanceRequired", + "smithy.api#documentation": "

Indicates whether requests from other Amazon Web Services accounts to create an endpoint to the service must first be accepted.

", + "smithy.api#xmlName": "acceptanceRequired" + } + }, + "ManagesVpcEndpoints": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "ManagesVpcEndpoints", + "smithy.api#documentation": "

Indicates whether the service manages its VPC endpoints. Management of the service VPC\n endpoints using the VPC endpoint API is restricted.

", + "smithy.api#xmlName": "managesVpcEndpoints" + } + }, + "NetworkLoadBalancerArns": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "NetworkLoadBalancerArnSet", + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the Network Load Balancers for the service.

", + "smithy.api#xmlName": "networkLoadBalancerArnSet" + } + }, + "GatewayLoadBalancerArns": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "GatewayLoadBalancerArnSet", + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service.

", + "smithy.api#xmlName": "gatewayLoadBalancerArnSet" + } + }, + "SupportedIpAddressTypes": { + "target": "com.amazonaws.ec2#SupportedIpAddressTypes", + "traits": { + "aws.protocols#ec2QueryName": "SupportedIpAddressTypeSet", + "smithy.api#documentation": "

The supported IP address types.

", + "smithy.api#xmlName": "supportedIpAddressTypeSet" + } + }, + "BaseEndpointDnsNames": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "BaseEndpointDnsNameSet", + "smithy.api#documentation": "

The DNS names for the service.

", + "smithy.api#xmlName": "baseEndpointDnsNameSet" + } + }, + "PrivateDnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateDnsName", + "smithy.api#documentation": "

The private DNS name for the service.

", + "smithy.api#xmlName": "privateDnsName" + } + }, + "PrivateDnsNameConfiguration": { + "target": "com.amazonaws.ec2#PrivateDnsNameConfiguration", + "traits": { + "aws.protocols#ec2QueryName": "PrivateDnsNameConfiguration", + "smithy.api#documentation": "

Information about the endpoint service private DNS name configuration.

", + "smithy.api#xmlName": "privateDnsNameConfiguration" + } + }, + "PayerResponsibility": { + "target": "com.amazonaws.ec2#PayerResponsibility", + "traits": { + "aws.protocols#ec2QueryName": "PayerResponsibility", + "smithy.api#documentation": "

The payer responsibility.

", + "smithy.api#xmlName": "payerResponsibility" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the service.

", + "smithy.api#xmlName": "tagSet" + } + }, + "SupportedRegions": { + "target": "com.amazonaws.ec2#SupportedRegionSet", + "traits": { + "aws.protocols#ec2QueryName": "SupportedRegionSet", + "smithy.api#documentation": "

The supported Regions.

", + "smithy.api#xmlName": "supportedRegionSet" + } + }, + "RemoteAccessEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "RemoteAccessEnabled", + "smithy.api#documentation": "

Indicates whether consumers can access the service from a Region other than the \n Region where the service is hosted.

", + "smithy.api#xmlName": "remoteAccessEnabled" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a service configuration for a VPC endpoint service.

" + } + }, + "com.amazonaws.ec2#ServiceConfigurationSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ServiceConfiguration", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ServiceConnectivityType": { + "type": "enum", + "members": { + "ipv4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv4" + } + }, + "ipv6": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv6" + } + } + } + }, + "com.amazonaws.ec2#ServiceDetail": { + "type": "structure", + "members": { + "ServiceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ServiceName", + "smithy.api#documentation": "

The name of the service.

", + "smithy.api#xmlName": "serviceName" + } + }, + "ServiceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ServiceId", + "smithy.api#documentation": "

The ID of the endpoint service.

", + "smithy.api#xmlName": "serviceId" + } + }, + "ServiceType": { + "target": "com.amazonaws.ec2#ServiceTypeDetailSet", + "traits": { + "aws.protocols#ec2QueryName": "ServiceType", + "smithy.api#documentation": "

The type of service.

", + "smithy.api#xmlName": "serviceType" + } + }, + "ServiceRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ServiceRegion", + "smithy.api#documentation": "

The Region where the service is hosted.

", + "smithy.api#xmlName": "serviceRegion" + } + }, + "AvailabilityZones": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZoneSet", + "smithy.api#documentation": "

The Availability Zones in which the service is available.

", + "smithy.api#xmlName": "availabilityZoneSet" + } + }, + "Owner": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Owner", + "smithy.api#documentation": "

The Amazon Web Services account ID of the service owner.

", + "smithy.api#xmlName": "owner" + } + }, + "BaseEndpointDnsNames": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "BaseEndpointDnsNameSet", + "smithy.api#documentation": "

The DNS names for the service.

", + "smithy.api#xmlName": "baseEndpointDnsNameSet" + } + }, + "PrivateDnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateDnsName", + "smithy.api#documentation": "

The private DNS name for the service.

", + "smithy.api#xmlName": "privateDnsName" + } + }, + "PrivateDnsNames": { + "target": "com.amazonaws.ec2#PrivateDnsDetailsSet", + "traits": { + "aws.protocols#ec2QueryName": "PrivateDnsNameSet", + "smithy.api#documentation": "

The private DNS names assigned to the VPC endpoint service.

", + "smithy.api#xmlName": "privateDnsNameSet" + } + }, + "VpcEndpointPolicySupported": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "VpcEndpointPolicySupported", + "smithy.api#documentation": "

Indicates whether the service supports endpoint policies.

", + "smithy.api#xmlName": "vpcEndpointPolicySupported" + } + }, + "AcceptanceRequired": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "AcceptanceRequired", + "smithy.api#documentation": "

Indicates whether VPC endpoint connection requests to the service must be accepted by the service owner.

", + "smithy.api#xmlName": "acceptanceRequired" + } + }, + "ManagesVpcEndpoints": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "ManagesVpcEndpoints", + "smithy.api#documentation": "

Indicates whether the service manages its VPC endpoints. Management of the service VPC\n endpoints using the VPC endpoint API is restricted.

", + "smithy.api#xmlName": "managesVpcEndpoints" + } + }, + "PayerResponsibility": { + "target": "com.amazonaws.ec2#PayerResponsibility", + "traits": { + "aws.protocols#ec2QueryName": "PayerResponsibility", + "smithy.api#documentation": "

The payer responsibility.

", + "smithy.api#xmlName": "payerResponsibility" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the service.

", + "smithy.api#xmlName": "tagSet" + } + }, + "PrivateDnsNameVerificationState": { + "target": "com.amazonaws.ec2#DnsNameState", + "traits": { + "aws.protocols#ec2QueryName": "PrivateDnsNameVerificationState", + "smithy.api#documentation": "

The verification state of the VPC endpoint service.

\n

Consumers of the endpoint service cannot use the private name when the state is not verified.

", + "smithy.api#xmlName": "privateDnsNameVerificationState" + } + }, + "SupportedIpAddressTypes": { + "target": "com.amazonaws.ec2#SupportedIpAddressTypes", + "traits": { + "aws.protocols#ec2QueryName": "SupportedIpAddressTypeSet", + "smithy.api#documentation": "

The supported IP address types.

", + "smithy.api#xmlName": "supportedIpAddressTypeSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a VPC endpoint service.

" + } + }, + "com.amazonaws.ec2#ServiceDetailSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ServiceDetail", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ServiceNetworkArn": { + "type": "string" + }, + "com.amazonaws.ec2#ServiceState": { + "type": "enum", + "members": { + "Pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "Available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Available" + } + }, + "Deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "Deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleted" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + } + } + }, + "com.amazonaws.ec2#ServiceType": { + "type": "enum", + "members": { + "Interface": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Interface" + } + }, + "Gateway": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Gateway" + } + }, + "GatewayLoadBalancer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GatewayLoadBalancer" + } + } + } + }, + "com.amazonaws.ec2#ServiceTypeDetail": { + "type": "structure", + "members": { + "ServiceType": { + "target": "com.amazonaws.ec2#ServiceType", + "traits": { + "aws.protocols#ec2QueryName": "ServiceType", + "smithy.api#documentation": "

The type of service.

", + "smithy.api#xmlName": "serviceType" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the type of service for a VPC endpoint.

" + } + }, + "com.amazonaws.ec2#ServiceTypeDetailSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ServiceTypeDetail", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ShutdownBehavior": { + "type": "enum", + "members": { + "stop": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "stop" + } + }, + "terminate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "terminate" + } + } + } + }, + "com.amazonaws.ec2#SlotDateTimeRangeRequest": { + "type": "structure", + "members": { + "EarliestTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The earliest date and time, in UTC, for the Scheduled Instance to start.

", + "smithy.api#required": {} + } + }, + "LatestTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The latest date and time, in UTC, for the Scheduled Instance to start. This value must be later than or equal to the earliest date and at most three months in the future.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the time period for a Scheduled Instance to start its first schedule. The time period must span less than one day.

" + } + }, + "com.amazonaws.ec2#SlotStartTimeRangeRequest": { + "type": "structure", + "members": { + "EarliestTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "smithy.api#documentation": "

The earliest date and time, in UTC, for the Scheduled Instance to start.

" + } + }, + "LatestTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "smithy.api#documentation": "

The latest date and time, in UTC, for the Scheduled Instance to start.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the time period for a Scheduled Instance to start its first schedule.

" + } + }, + "com.amazonaws.ec2#Snapshot": { + "type": "structure", + "members": { + "OwnerAlias": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerAlias", + "smithy.api#documentation": "

The Amazon Web Services owner alias, from an Amazon-maintained list (amazon). This is not \n the user-configured Amazon Web Services account alias set using the IAM console.

", + "smithy.api#xmlName": "ownerAlias" + } + }, + "OutpostArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OutpostArn", + "smithy.api#documentation": "

The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the \n \t\tAmazon EBS User Guide.

", + "smithy.api#xmlName": "outpostArn" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the snapshot.

", + "smithy.api#xmlName": "tagSet" + } + }, + "StorageTier": { + "target": "com.amazonaws.ec2#StorageTier", + "traits": { + "aws.protocols#ec2QueryName": "StorageTier", + "smithy.api#documentation": "

The storage tier in which the snapshot is stored. standard indicates \n that the snapshot is stored in the standard snapshot storage tier and that it is ready \n for use. archive indicates that the snapshot is currently archived and that \n it must be restored before it can be used.

", + "smithy.api#xmlName": "storageTier" + } + }, + "RestoreExpiryTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "RestoreExpiryTime", + "smithy.api#documentation": "

Only for archived snapshots that are temporarily restored. Indicates the date and \n time when a temporarily restored snapshot will be automatically re-archived.

", + "smithy.api#xmlName": "restoreExpiryTime" + } + }, + "SseType": { + "target": "com.amazonaws.ec2#SSEType", + "traits": { + "aws.protocols#ec2QueryName": "SseType", + "smithy.api#documentation": "

Reserved for future use.

", + "smithy.api#xmlName": "sseType" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone or Local Zone of the snapshot. For example, us-west-1a \n (Availability Zone) or us-west-2-lax-1a (Local Zone).

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "TransferType": { + "target": "com.amazonaws.ec2#TransferType", + "traits": { + "aws.protocols#ec2QueryName": "TransferType", + "smithy.api#documentation": "\n

Only for snapshot copies.

\n \n

Indicates whether the snapshot copy was created with a standard or time-based \n snapshot copy operation. Time-based snapshot copy operations complete within the \n completion duration specified in the request. Standard snapshot copy operations \n are completed on a best-effort basis.

\n ", + "smithy.api#xmlName": "transferType" + } + }, + "CompletionDurationMinutes": { + "target": "com.amazonaws.ec2#SnapshotCompletionDurationMinutesResponse", + "traits": { + "aws.protocols#ec2QueryName": "CompletionDurationMinutes", + "smithy.api#documentation": "\n

Only for snapshot copies created with time-based snapshot copy operations.

\n \n

The completion duration requested for the time-based snapshot copy operation.

", + "smithy.api#xmlName": "completionDurationMinutes" + } + }, + "CompletionTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "CompletionTime", + "smithy.api#documentation": "

The time stamp when the snapshot was completed.

", + "smithy.api#xmlName": "completionTime" + } + }, + "SnapshotId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The ID of the snapshot. Each snapshot receives a unique identifier when it is\n created.

", + "smithy.api#xmlName": "snapshotId" + } + }, + "VolumeId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VolumeId", + "smithy.api#documentation": "

The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any\n purpose.

", + "smithy.api#xmlName": "volumeId" + } + }, + "State": { + "target": "com.amazonaws.ec2#SnapshotState", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The snapshot state.

", + "smithy.api#xmlName": "status" + } + }, + "StateMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails\n (for example, if the proper KMS permissions are not obtained) this field displays error\n state details to help you diagnose why the error occurred. This parameter is only returned by\n DescribeSnapshots.

", + "smithy.api#xmlName": "statusMessage" + } + }, + "StartTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "StartTime", + "smithy.api#documentation": "

The time stamp when the snapshot was initiated.

", + "smithy.api#xmlName": "startTime" + } + }, + "Progress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Progress", + "smithy.api#documentation": "

The progress of the snapshot, as a percentage.

", + "smithy.api#xmlName": "progress" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the EBS snapshot.

", + "smithy.api#xmlName": "ownerId" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description for the snapshot.

", + "smithy.api#xmlName": "description" + } + }, + "VolumeSize": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "VolumeSize", + "smithy.api#documentation": "

The size of the volume, in GiB.

", + "smithy.api#xmlName": "volumeSize" + } + }, + "Encrypted": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Encrypted", + "smithy.api#documentation": "

Indicates whether the snapshot is encrypted.

", + "smithy.api#xmlName": "encrypted" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KmsKeyId", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key that was used to protect the\n volume encryption key for the parent volume.

", + "smithy.api#xmlName": "kmsKeyId" + } + }, + "DataEncryptionKeyId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DataEncryptionKeyId", + "smithy.api#documentation": "

The data encryption key identifier for the snapshot. This value is a unique identifier\n that corresponds to the data encryption key that was used to encrypt the original volume or\n snapshot copy. Because data encryption keys are inherited by volumes created from snapshots,\n and vice versa, if snapshots share the same data encryption key identifier, then they belong\n to the same volume/snapshot lineage. This parameter is only returned by DescribeSnapshots.

", + "smithy.api#xmlName": "dataEncryptionKeyId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a snapshot.

" + } + }, + "com.amazonaws.ec2#SnapshotAttributeName": { + "type": "enum", + "members": { + "productCodes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "productCodes" + } + }, + "createVolumePermission": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "createVolumePermission" + } + } + } + }, + "com.amazonaws.ec2#SnapshotBlockPublicAccessState": { + "type": "enum", + "members": { + "block_all_sharing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "block-all-sharing" + } + }, + "block_new_sharing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "block-new-sharing" + } + }, + "unblocked": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unblocked" + } + } + } + }, + "com.amazonaws.ec2#SnapshotCompletionDurationMinutesRequest": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 2880 + } + } + }, + "com.amazonaws.ec2#SnapshotCompletionDurationMinutesResponse": { + "type": "integer" + }, + "com.amazonaws.ec2#SnapshotDetail": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description for the snapshot.

", + "smithy.api#xmlName": "description" + } + }, + "DeviceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DeviceName", + "smithy.api#documentation": "

The block device mapping for the snapshot.

", + "smithy.api#xmlName": "deviceName" + } + }, + "DiskImageSize": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "DiskImageSize", + "smithy.api#documentation": "

The size of the disk in the snapshot, in GiB.

", + "smithy.api#xmlName": "diskImageSize" + } + }, + "Format": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Format", + "smithy.api#documentation": "

The format of the disk image from which the snapshot is created.

", + "smithy.api#xmlName": "format" + } + }, + "Progress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Progress", + "smithy.api#documentation": "

The percentage of progress for the task.

", + "smithy.api#xmlName": "progress" + } + }, + "SnapshotId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The snapshot ID of the disk being imported.

", + "smithy.api#xmlName": "snapshotId" + } + }, + "Status": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

A brief status of the snapshot creation.

", + "smithy.api#xmlName": "status" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

A detailed status message for the snapshot creation.

", + "smithy.api#xmlName": "statusMessage" + } + }, + "Url": { + "target": "com.amazonaws.ec2#SensitiveUrl", + "traits": { + "aws.protocols#ec2QueryName": "Url", + "smithy.api#documentation": "

The URL used to access the disk image.

", + "smithy.api#xmlName": "url" + } + }, + "UserBucket": { + "target": "com.amazonaws.ec2#UserBucketDetails", + "traits": { + "aws.protocols#ec2QueryName": "UserBucket", + "smithy.api#documentation": "

The Amazon S3 bucket for the disk image.

", + "smithy.api#xmlName": "userBucket" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the snapshot created from the imported disk.

" + } + }, + "com.amazonaws.ec2#SnapshotDetailList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SnapshotDetail", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SnapshotDiskContainer": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The description of the disk image being imported.

" + } + }, + "Format": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The format of the disk image being imported.

\n

Valid values: VHD | VMDK | RAW\n

" + } + }, + "Url": { + "target": "com.amazonaws.ec2#SensitiveUrl", + "traits": { + "smithy.api#documentation": "

The URL to the Amazon S3-based disk image being imported. It can either be a https URL (https://..) or an Amazon\n S3 URL (s3://..).

" + } + }, + "UserBucket": { + "target": "com.amazonaws.ec2#UserBucket", + "traits": { + "smithy.api#documentation": "

The Amazon S3 bucket for the disk image.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The disk container object for the import snapshot request.

" + } + }, + "com.amazonaws.ec2#SnapshotId": { + "type": "string" + }, + "com.amazonaws.ec2#SnapshotIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SnapshotId", + "traits": { + "smithy.api#xmlName": "SnapshotId" + } + } + }, + "com.amazonaws.ec2#SnapshotInfo": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

Description specified by the CreateSnapshotRequest that has been applied to all \n snapshots.

", + "smithy.api#xmlName": "description" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Tags associated with this snapshot.

", + "smithy.api#xmlName": "tagSet" + } + }, + "Encrypted": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Encrypted", + "smithy.api#documentation": "

Indicates whether the snapshot is encrypted.

", + "smithy.api#xmlName": "encrypted" + } + }, + "VolumeId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VolumeId", + "smithy.api#documentation": "

Source volume from which this snapshot was created.

", + "smithy.api#xmlName": "volumeId" + } + }, + "State": { + "target": "com.amazonaws.ec2#SnapshotState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

Current state of the snapshot.

", + "smithy.api#xmlName": "state" + } + }, + "VolumeSize": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "VolumeSize", + "smithy.api#documentation": "

Size of the volume from which this snapshot was created.

", + "smithy.api#xmlName": "volumeSize" + } + }, + "StartTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "StartTime", + "smithy.api#documentation": "

Time this snapshot was started. This is the same for all snapshots initiated by the\n same request.

", + "smithy.api#xmlName": "startTime" + } + }, + "Progress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Progress", + "smithy.api#documentation": "

Progress this snapshot has made towards completing.

", + "smithy.api#xmlName": "progress" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

Account id used when creating this snapshot.

", + "smithy.api#xmlName": "ownerId" + } + }, + "SnapshotId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

Snapshot id that can be used to describe this snapshot.

", + "smithy.api#xmlName": "snapshotId" + } + }, + "OutpostArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OutpostArn", + "smithy.api#documentation": "

The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the \n \t\tAmazon EBS User Guide.

", + "smithy.api#xmlName": "outpostArn" + } + }, + "SseType": { + "target": "com.amazonaws.ec2#SSEType", + "traits": { + "aws.protocols#ec2QueryName": "SseType", + "smithy.api#documentation": "

Reserved for future use.

", + "smithy.api#xmlName": "sseType" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone or Local Zone of the snapshots. For example, us-west-1a \n (Availability Zone) or us-west-2-lax-1a (Local Zone).

", + "smithy.api#xmlName": "availabilityZone" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a snapshot.

" + } + }, + "com.amazonaws.ec2#SnapshotList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Snapshot", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SnapshotLocationEnum": { + "type": "enum", + "members": { + "REGIONAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "regional" + } + }, + "LOCAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "local" + } + } + } + }, + "com.amazonaws.ec2#SnapshotRecycleBinInfo": { + "type": "structure", + "members": { + "SnapshotId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The ID of the snapshot.

", + "smithy.api#xmlName": "snapshotId" + } + }, + "RecycleBinEnterTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "RecycleBinEnterTime", + "smithy.api#documentation": "

The date and time when the snaphsot entered the Recycle Bin.

", + "smithy.api#xmlName": "recycleBinEnterTime" + } + }, + "RecycleBinExitTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "RecycleBinExitTime", + "smithy.api#documentation": "

The date and time when the snapshot is to be permanently deleted from the Recycle Bin.

", + "smithy.api#xmlName": "recycleBinExitTime" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description for the snapshot.

", + "smithy.api#xmlName": "description" + } + }, + "VolumeId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VolumeId", + "smithy.api#documentation": "

The ID of the volume from which the snapshot was created.

", + "smithy.api#xmlName": "volumeId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a snapshot that is currently in the Recycle Bin.

" + } + }, + "com.amazonaws.ec2#SnapshotRecycleBinInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SnapshotRecycleBinInfo", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SnapshotSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SnapshotInfo", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SnapshotState": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "completed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "completed" + } + }, + "error": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "error" + } + }, + "recoverable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "recoverable" + } + }, + "recovering": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "recovering" + } + } + } + }, + "com.amazonaws.ec2#SnapshotTaskDetail": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description of the disk image being imported.

", + "smithy.api#xmlName": "description" + } + }, + "DiskImageSize": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "DiskImageSize", + "smithy.api#documentation": "

The size of the disk in the snapshot, in GiB.

", + "smithy.api#xmlName": "diskImageSize" + } + }, + "Encrypted": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Encrypted", + "smithy.api#documentation": "

Indicates whether the snapshot is encrypted.

", + "smithy.api#xmlName": "encrypted" + } + }, + "Format": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Format", + "smithy.api#documentation": "

The format of the disk image from which the snapshot is created.

", + "smithy.api#xmlName": "format" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KmsKeyId", + "smithy.api#documentation": "

The identifier for the KMS key that was used to create the encrypted snapshot.

", + "smithy.api#xmlName": "kmsKeyId" + } + }, + "Progress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Progress", + "smithy.api#documentation": "

The percentage of completion for the import snapshot task.

", + "smithy.api#xmlName": "progress" + } + }, + "SnapshotId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The snapshot ID of the disk being imported.

", + "smithy.api#xmlName": "snapshotId" + } + }, + "Status": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

A brief status for the import snapshot task.

", + "smithy.api#xmlName": "status" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

A detailed status message for the import snapshot task.

", + "smithy.api#xmlName": "statusMessage" + } + }, + "Url": { + "target": "com.amazonaws.ec2#SensitiveUrl", + "traits": { + "aws.protocols#ec2QueryName": "Url", + "smithy.api#documentation": "

The URL of the disk image from which the snapshot is created.

", + "smithy.api#xmlName": "url" + } + }, + "UserBucket": { + "target": "com.amazonaws.ec2#UserBucketDetails", + "traits": { + "aws.protocols#ec2QueryName": "UserBucket", + "smithy.api#documentation": "

The Amazon S3 bucket for the disk image.

", + "smithy.api#xmlName": "userBucket" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the import snapshot task.

" + } + }, + "com.amazonaws.ec2#SnapshotTierStatus": { + "type": "structure", + "members": { + "SnapshotId": { + "target": "com.amazonaws.ec2#SnapshotId", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The ID of the snapshot.

", + "smithy.api#xmlName": "snapshotId" + } + }, + "VolumeId": { + "target": "com.amazonaws.ec2#VolumeId", + "traits": { + "aws.protocols#ec2QueryName": "VolumeId", + "smithy.api#documentation": "

The ID of the volume from which the snapshot was created.

", + "smithy.api#xmlName": "volumeId" + } + }, + "Status": { + "target": "com.amazonaws.ec2#SnapshotState", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The state of the snapshot.

", + "smithy.api#xmlName": "status" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the snapshot.

", + "smithy.api#xmlName": "ownerId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags that are assigned to the snapshot.

", + "smithy.api#xmlName": "tagSet" + } + }, + "StorageTier": { + "target": "com.amazonaws.ec2#StorageTier", + "traits": { + "aws.protocols#ec2QueryName": "StorageTier", + "smithy.api#documentation": "

The storage tier in which the snapshot is stored. standard indicates \n that the snapshot is stored in the standard snapshot storage tier and that it is ready \n for use. archive indicates that the snapshot is currently archived and that \n it must be restored before it can be used.

", + "smithy.api#xmlName": "storageTier" + } + }, + "LastTieringStartTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "LastTieringStartTime", + "smithy.api#documentation": "

The date and time when the last archive or restore process was started.

", + "smithy.api#xmlName": "lastTieringStartTime" + } + }, + "LastTieringProgress": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "LastTieringProgress", + "smithy.api#documentation": "

The progress of the last archive or restore process, as a percentage.

", + "smithy.api#xmlName": "lastTieringProgress" + } + }, + "LastTieringOperationStatus": { + "target": "com.amazonaws.ec2#TieringOperationStatus", + "traits": { + "aws.protocols#ec2QueryName": "LastTieringOperationStatus", + "smithy.api#documentation": "

The status of the last archive or restore process.

", + "smithy.api#xmlName": "lastTieringOperationStatus" + } + }, + "LastTieringOperationStatusDetail": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LastTieringOperationStatusDetail", + "smithy.api#documentation": "

A message describing the status of the last archive or restore process.

", + "smithy.api#xmlName": "lastTieringOperationStatusDetail" + } + }, + "ArchivalCompleteTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "ArchivalCompleteTime", + "smithy.api#documentation": "

The date and time when the last archive process was completed.

", + "smithy.api#xmlName": "archivalCompleteTime" + } + }, + "RestoreExpiryTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "RestoreExpiryTime", + "smithy.api#documentation": "

Only for archived snapshots that are temporarily restored. Indicates the date and \n time when a temporarily restored snapshot will be automatically re-archived.

", + "smithy.api#xmlName": "restoreExpiryTime" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about a snapshot's storage tier.

" + } + }, + "com.amazonaws.ec2#SpotAllocationStrategy": { + "type": "enum", + "members": { + "LOWEST_PRICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "lowest-price" + } + }, + "DIVERSIFIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "diversified" + } + }, + "CAPACITY_OPTIMIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "capacity-optimized" + } + }, + "CAPACITY_OPTIMIZED_PRIORITIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "capacity-optimized-prioritized" + } + }, + "PRICE_CAPACITY_OPTIMIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "price-capacity-optimized" + } + } + } + }, + "com.amazonaws.ec2#SpotCapacityRebalance": { + "type": "structure", + "members": { + "ReplacementStrategy": { + "target": "com.amazonaws.ec2#ReplacementStrategy", + "traits": { + "aws.protocols#ec2QueryName": "ReplacementStrategy", + "smithy.api#documentation": "

The replacement strategy to use. Only available for fleets of type\n maintain.

\n

\n launch - Spot Fleet launches a new replacement Spot Instance when a\n rebalance notification is emitted for an existing Spot Instance in the fleet. Spot Fleet\n does not terminate the instances that receive a rebalance notification. You can\n terminate the old instances, or you can leave them running. You are charged for all\n instances while they are running.

\n

\n launch-before-terminate - Spot Fleet launches a new replacement Spot\n Instance when a rebalance notification is emitted for an existing Spot Instance in the\n fleet, and then, after a delay that you specify (in TerminationDelay),\n terminates the instances that received a rebalance notification.

", + "smithy.api#xmlName": "replacementStrategy" + } + }, + "TerminationDelay": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TerminationDelay", + "smithy.api#documentation": "

The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot\n Instance after launching a new replacement Spot Instance.

\n

Required when ReplacementStrategy is set to launch-before-terminate.

\n

Not valid when ReplacementStrategy is set to launch.

\n

Valid values: Minimum value of 120 seconds. Maximum value of 7200 seconds.

", + "smithy.api#xmlName": "terminationDelay" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Spot Instance replacement strategy to use when Amazon EC2 emits a signal that your\n Spot Instance is at an elevated risk of being interrupted. For more information, see\n Capacity\n rebalancing in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#SpotDatafeedSubscription": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Bucket", + "smithy.api#documentation": "

The name of the Amazon S3 bucket where the Spot Instance data feed is located.

", + "smithy.api#xmlName": "bucket" + } + }, + "Fault": { + "target": "com.amazonaws.ec2#SpotInstanceStateFault", + "traits": { + "aws.protocols#ec2QueryName": "Fault", + "smithy.api#documentation": "

The fault codes for the Spot Instance request, if any.

", + "smithy.api#xmlName": "fault" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The Amazon Web Services account ID of the account.

", + "smithy.api#xmlName": "ownerId" + } + }, + "Prefix": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Prefix", + "smithy.api#documentation": "

The prefix for the data feed files.

", + "smithy.api#xmlName": "prefix" + } + }, + "State": { + "target": "com.amazonaws.ec2#DatafeedSubscriptionState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the Spot Instance data feed subscription.

", + "smithy.api#xmlName": "state" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the data feed for a Spot Instance.

" + } + }, + "com.amazonaws.ec2#SpotFleetLaunchSpecification": { + "type": "structure", + "members": { + "AddressingType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AddressingType", + "smithy.api#documentation": "

Deprecated.

", + "smithy.api#xmlName": "addressingType" + } + }, + "BlockDeviceMappings": { + "target": "com.amazonaws.ec2#BlockDeviceMappingList", + "traits": { + "aws.protocols#ec2QueryName": "BlockDeviceMapping", + "smithy.api#documentation": "

One or more block devices that are mapped to the Spot Instances. You can't specify both\n a snapshot ID and an encryption value. This is because only blank volumes can be\n encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its\n encryption status is used for the volume encryption status.

", + "smithy.api#xmlName": "blockDeviceMapping" + } + }, + "EbsOptimized": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EbsOptimized", + "smithy.api#documentation": "

Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

\n

Default: false\n

", + "smithy.api#xmlName": "ebsOptimized" + } + }, + "IamInstanceProfile": { + "target": "com.amazonaws.ec2#IamInstanceProfileSpecification", + "traits": { + "aws.protocols#ec2QueryName": "IamInstanceProfile", + "smithy.api#documentation": "

The IAM instance profile.

", + "smithy.api#xmlName": "iamInstanceProfile" + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the AMI.

", + "smithy.api#xmlName": "imageId" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type.

", + "smithy.api#xmlName": "instanceType" + } + }, + "KernelId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KernelId", + "smithy.api#documentation": "

The ID of the kernel.

", + "smithy.api#xmlName": "kernelId" + } + }, + "KeyName": { + "target": "com.amazonaws.ec2#KeyPairName", + "traits": { + "aws.protocols#ec2QueryName": "KeyName", + "smithy.api#documentation": "

The name of the key pair.

", + "smithy.api#xmlName": "keyName" + } + }, + "Monitoring": { + "target": "com.amazonaws.ec2#SpotFleetMonitoring", + "traits": { + "aws.protocols#ec2QueryName": "Monitoring", + "smithy.api#documentation": "

Enable or disable monitoring for the instances.

", + "smithy.api#xmlName": "monitoring" + } + }, + "NetworkInterfaces": { + "target": "com.amazonaws.ec2#InstanceNetworkInterfaceSpecificationList", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceSet", + "smithy.api#documentation": "

The network interfaces.

\n \n

\n SpotFleetLaunchSpecification does not support Elastic Fabric Adapter (EFA). \n You must use LaunchTemplateConfig instead.

\n ", + "smithy.api#xmlName": "networkInterfaceSet" + } + }, + "Placement": { + "target": "com.amazonaws.ec2#SpotPlacement", + "traits": { + "aws.protocols#ec2QueryName": "Placement", + "smithy.api#documentation": "

The placement information.

", + "smithy.api#xmlName": "placement" + } + }, + "RamdiskId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RamdiskId", + "smithy.api#documentation": "

The ID of the RAM disk. Some kernels require additional drivers at launch. Check the kernel \n requirements for information about whether you need to specify a RAM disk. To find kernel \n requirements, refer to the Amazon Web Services Resource Center and search for the kernel ID.

", + "smithy.api#xmlName": "ramdiskId" + } + }, + "SpotPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SpotPrice", + "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to \n increased interruptions. If you do not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.

\n ", + "smithy.api#xmlName": "spotPrice" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The IDs of the subnets in which to launch the instances. To specify multiple subnets, separate\n them using commas; for example, \"subnet-1234abcdeexample1, subnet-0987cdef6example2\".

\n

If you specify a network interface, you must specify any subnets as part of the\n network interface instead of using this parameter.

", + "smithy.api#xmlName": "subnetId" + } + }, + "UserData": { + "target": "com.amazonaws.ec2#SensitiveUserData", + "traits": { + "aws.protocols#ec2QueryName": "UserData", + "smithy.api#documentation": "

The base64-encoded user data that instances use when starting up. User data is limited to 16 KB.

", + "smithy.api#xmlName": "userData" + } + }, + "WeightedCapacity": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "WeightedCapacity", + "smithy.api#documentation": "

The number of units provided by the specified instance type. These are the same units\n that you chose to set the target capacity in terms of instances, or a performance\n characteristic such as vCPUs, memory, or I/O.

\n

If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the\n number of instances to the next whole number. If this value is not specified, the default\n is 1.

\n \n

When specifying weights, the price used in the lowestPrice and\n priceCapacityOptimized allocation strategies is per\n unit hour (where the instance price is divided by the specified\n weight). However, if all the specified weights are above the requested\n TargetCapacity, resulting in only 1 instance being launched, the price\n used is per instance hour.

\n ", + "smithy.api#xmlName": "weightedCapacity" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#SpotFleetTagSpecificationList", + "traits": { + "aws.protocols#ec2QueryName": "TagSpecificationSet", + "smithy.api#documentation": "

The tags to apply during creation.

", + "smithy.api#xmlName": "tagSpecificationSet" + } + }, + "InstanceRequirements": { + "target": "com.amazonaws.ec2#InstanceRequirements", + "traits": { + "aws.protocols#ec2QueryName": "InstanceRequirements", + "smithy.api#documentation": "

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will\n identify instance types with those attributes.

\n \n

If you specify InstanceRequirements, you can't specify\n InstanceType.

\n ", + "smithy.api#xmlName": "instanceRequirements" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.ec2#GroupIdentifierList", + "traits": { + "aws.protocols#ec2QueryName": "GroupSet", + "smithy.api#documentation": "

The security groups.

\n

If you specify a network interface, you must specify any security groups as part of\n the network interface instead of using this parameter.

", + "smithy.api#xmlName": "groupSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the launch specification for one or more Spot Instances. If you include\n On-Demand capacity in your fleet request or want to specify an EFA network device, you\n can't use SpotFleetLaunchSpecification; you must use LaunchTemplateConfig.

" + } + }, + "com.amazonaws.ec2#SpotFleetMonitoring": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Enabled", + "smithy.api#documentation": "

Enables monitoring for the instance.

\n

Default: false\n

", + "smithy.api#xmlName": "enabled" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes whether monitoring is enabled.

" + } + }, + "com.amazonaws.ec2#SpotFleetRequestConfig": { + "type": "structure", + "members": { + "ActivityStatus": { + "target": "com.amazonaws.ec2#ActivityStatus", + "traits": { + "aws.protocols#ec2QueryName": "ActivityStatus", + "smithy.api#documentation": "

The progress of the Spot Fleet request. \n If there is an error, the status is error.\n After all requests are placed, the status is pending_fulfillment.\n If the size of the fleet is equal to or greater than its target capacity, the status is fulfilled.\n If the size of the fleet is decreased, the status is pending_termination\n while Spot Instances are terminating.

", + "smithy.api#xmlName": "activityStatus" + } + }, + "CreateTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreateTime", + "smithy.api#documentation": "

The creation date and time of the request.

", + "smithy.api#xmlName": "createTime" + } + }, + "SpotFleetRequestConfig": { + "target": "com.amazonaws.ec2#SpotFleetRequestConfigData", + "traits": { + "aws.protocols#ec2QueryName": "SpotFleetRequestConfig", + "smithy.api#documentation": "

The configuration of the Spot Fleet request.

", + "smithy.api#xmlName": "spotFleetRequestConfig" + } + }, + "SpotFleetRequestId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SpotFleetRequestId", + "smithy.api#documentation": "

The ID of the Spot Fleet request.

", + "smithy.api#xmlName": "spotFleetRequestId" + } + }, + "SpotFleetRequestState": { + "target": "com.amazonaws.ec2#BatchState", + "traits": { + "aws.protocols#ec2QueryName": "SpotFleetRequestState", + "smithy.api#documentation": "

The state of the Spot Fleet request.

", + "smithy.api#xmlName": "spotFleetRequestState" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags for a Spot Fleet resource.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Spot Fleet request.

" + } + }, + "com.amazonaws.ec2#SpotFleetRequestConfigData": { + "type": "structure", + "members": { + "AllocationStrategy": { + "target": "com.amazonaws.ec2#AllocationStrategy", + "traits": { + "aws.protocols#ec2QueryName": "AllocationStrategy", + "smithy.api#documentation": "

The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance\n pools specified by the Spot Fleet launch configuration. For more information, see Allocation\n strategies for Spot Instances in the Amazon EC2 User Guide.

\n
\n
priceCapacityOptimized (recommended)
\n
\n

Spot Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. Spot Fleet then requests Spot Instances from the lowest priced of these pools.

\n
\n
capacityOptimized
\n
\n

Spot Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. To give certain\n instance types a higher chance of launching first, use\n capacityOptimizedPrioritized. Set a priority for each instance type by\n using the Priority parameter for LaunchTemplateOverrides. You can\n assign the same priority to different LaunchTemplateOverrides. EC2 implements\n the priorities on a best-effort basis, but optimizes for capacity first.\n capacityOptimizedPrioritized is supported only if your Spot Fleet uses a\n launch template. Note that if the OnDemandAllocationStrategy is set to\n prioritized, the same priority is applied when fulfilling On-Demand\n capacity.

\n
\n
diversified
\n
\n

Spot Fleet requests instances from all of the Spot Instance pools that you\n specify.

\n
\n
lowestPrice (not recommended)
\n
\n \n

We don't recommend the lowestPrice allocation strategy because\n it has the highest risk of interruption for your Spot Instances.

\n \n

Spot Fleet requests instances from the lowest priced Spot Instance pool that has available\n capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances\n come from the next lowest priced pool that has available capacity. If a pool runs\n out of capacity before fulfilling your desired capacity, Spot Fleet will continue to\n fulfill your request by drawing from the next lowest priced pool. To ensure that\n your desired capacity is met, you might receive Spot Instances from several pools. Because\n this strategy only considers instance price and not capacity availability, it\n might lead to high interruption rates.

\n
\n
\n

Default: lowestPrice\n

", + "smithy.api#xmlName": "allocationStrategy" + } + }, + "OnDemandAllocationStrategy": { + "target": "com.amazonaws.ec2#OnDemandAllocationStrategy", + "traits": { + "aws.protocols#ec2QueryName": "OnDemandAllocationStrategy", + "smithy.api#documentation": "

The order of the launch template overrides to use in fulfilling On-Demand capacity. If\n you specify lowestPrice, Spot Fleet uses price to determine the order, launching\n the lowest price first. If you specify prioritized, Spot Fleet uses the priority\n that you assign to each Spot Fleet launch template override, launching the highest priority\n first. If you do not specify a value, Spot Fleet defaults to lowestPrice.

", + "smithy.api#xmlName": "onDemandAllocationStrategy" + } + }, + "SpotMaintenanceStrategies": { + "target": "com.amazonaws.ec2#SpotMaintenanceStrategies", + "traits": { + "aws.protocols#ec2QueryName": "SpotMaintenanceStrategies", + "smithy.api#documentation": "

The strategies for managing your Spot Instances that are at an elevated risk of being\n interrupted.

", + "smithy.api#xmlName": "spotMaintenanceStrategies" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of your\n listings. This helps to avoid duplicate listings. For more information, see Ensuring Idempotency.

", + "smithy.api#xmlName": "clientToken" + } + }, + "ExcessCapacityTerminationPolicy": { + "target": "com.amazonaws.ec2#ExcessCapacityTerminationPolicy", + "traits": { + "aws.protocols#ec2QueryName": "ExcessCapacityTerminationPolicy", + "smithy.api#documentation": "

Indicates whether running instances should be terminated if you decrease the\n target capacity of the Spot Fleet request below the current size of the Spot Fleet.

\n

Supported only for fleets of type maintain.

", + "smithy.api#xmlName": "excessCapacityTerminationPolicy" + } + }, + "FulfilledCapacity": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "FulfilledCapacity", + "smithy.api#documentation": "

The number of units fulfilled by this request compared to the set target capacity. You\n cannot set this value.

", + "smithy.api#xmlName": "fulfilledCapacity" + } + }, + "OnDemandFulfilledCapacity": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "OnDemandFulfilledCapacity", + "smithy.api#documentation": "

The number of On-Demand units fulfilled by this request compared to the set target\n On-Demand capacity.

", + "smithy.api#xmlName": "onDemandFulfilledCapacity" + } + }, + "IamFleetRole": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IamFleetRole", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role\n that grants the Spot Fleet the permission to request, launch, terminate, and tag instances\n on your behalf. For more information, see Spot\n Fleet prerequisites in the Amazon EC2 User Guide. Spot Fleet can\n terminate Spot Instances on your behalf when you cancel its Spot Fleet request using CancelSpotFleetRequests or when the Spot Fleet request expires, if you set\n TerminateInstancesWithExpiration.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "iamFleetRole" + } + }, + "LaunchSpecifications": { + "target": "com.amazonaws.ec2#LaunchSpecsList", + "traits": { + "aws.protocols#ec2QueryName": "LaunchSpecifications", + "smithy.api#documentation": "

The launch specifications for the Spot Fleet request. If you specify\n LaunchSpecifications, you can't specify\n LaunchTemplateConfigs. If you include On-Demand capacity in your\n request, you must use LaunchTemplateConfigs.

\n \n

If an AMI specified in a launch specification is deregistered or disabled, no new\n instances can be launched from the AMI. For fleets of type maintain, the\n target capacity will not be maintained.

\n ", + "smithy.api#xmlName": "launchSpecifications" + } + }, + "LaunchTemplateConfigs": { + "target": "com.amazonaws.ec2#LaunchTemplateConfigList", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateConfigs", + "smithy.api#documentation": "

The launch template and overrides. If you specify LaunchTemplateConfigs,\n you can't specify LaunchSpecifications. If you include On-Demand capacity\n in your request, you must use LaunchTemplateConfigs.

", + "smithy.api#xmlName": "launchTemplateConfigs" + } + }, + "SpotPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SpotPrice", + "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend \n using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.

\n ", + "smithy.api#xmlName": "spotPrice" + } + }, + "TargetCapacity": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TargetCapacity", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of units to request for the Spot Fleet. You can choose to set the target\n capacity in terms of instances or a performance characteristic that is important to your\n application workload, such as vCPUs, memory, or I/O. If the request type is\n maintain, you can specify a target capacity of 0 and add capacity\n later.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "targetCapacity" + } + }, + "OnDemandTargetCapacity": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "OnDemandTargetCapacity", + "smithy.api#documentation": "

The number of On-Demand units to request. You can choose to set the target capacity in\n terms of instances or a performance characteristic that is important to your application\n workload, such as vCPUs, memory, or I/O. If the request type is maintain,\n you can specify a target capacity of 0 and add capacity later.

", + "smithy.api#xmlName": "onDemandTargetCapacity" + } + }, + "OnDemandMaxTotalPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OnDemandMaxTotalPrice", + "smithy.api#documentation": "

The maximum amount per hour for On-Demand Instances that you're willing to pay. You\n can use the onDemandMaxTotalPrice parameter, the\n spotMaxTotalPrice parameter, or both parameters to ensure that your\n fleet cost does not exceed your budget. If you set a maximum price per hour for the\n On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the\n maximum amount you're willing to pay. When the maximum amount you're willing to pay is\n reached, the fleet stops launching instances even if it hasn’t met the target\n capacity.

\n \n

If your fleet includes T instances that are configured as unlimited,\n and if their average CPU usage exceeds the baseline utilization, you will incur a charge\n for surplus credits. The onDemandMaxTotalPrice does not account for surplus\n credits, and, if you use surplus credits, your final cost might be higher than what you\n specified for onDemandMaxTotalPrice. For more information, see Surplus credits can incur charges in the\n Amazon EC2 User Guide.

\n ", + "smithy.api#xmlName": "onDemandMaxTotalPrice" + } + }, + "SpotMaxTotalPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SpotMaxTotalPrice", + "smithy.api#documentation": "

The maximum amount per hour for Spot Instances that you're willing to pay. You can use\n the spotMaxTotalPrice parameter, the onDemandMaxTotalPrice\n parameter, or both parameters to ensure that your fleet cost does not exceed your budget.\n If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will\n launch instances until it reaches the maximum amount you're willing to pay. When the\n maximum amount you're willing to pay is reached, the fleet stops launching instances even\n if it hasn’t met the target capacity.

\n \n

If your fleet includes T instances that are configured as unlimited,\n and if their average CPU usage exceeds the baseline utilization, you will incur a charge\n for surplus credits. The spotMaxTotalPrice does not account for surplus\n credits, and, if you use surplus credits, your final cost might be higher than what you\n specified for spotMaxTotalPrice. For more information, see Surplus credits can incur charges in the\n Amazon EC2 User Guide.

\n ", + "smithy.api#xmlName": "spotMaxTotalPrice" + } + }, + "TerminateInstancesWithExpiration": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "TerminateInstancesWithExpiration", + "smithy.api#documentation": "

Indicates whether running Spot Instances are terminated when the Spot Fleet request\n expires.

", + "smithy.api#xmlName": "terminateInstancesWithExpiration" + } + }, + "Type": { + "target": "com.amazonaws.ec2#FleetType", + "traits": { + "aws.protocols#ec2QueryName": "Type", + "smithy.api#documentation": "

The type of request. Indicates whether the Spot Fleet only requests the target\n capacity or also attempts to maintain it. When this value is request, the\n Spot Fleet only places the required requests. It does not attempt to replenish Spot\n Instances if capacity is diminished, nor does it submit requests in alternative Spot\n pools if capacity is not available. When this value is maintain, the Spot\n Fleet maintains the target capacity. The Spot Fleet places the required requests to meet\n capacity and automatically replenishes any interrupted instances. Default:\n maintain. instant is listed but is not used by Spot\n Fleet.

", + "smithy.api#xmlName": "type" + } + }, + "ValidFrom": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "ValidFrom", + "smithy.api#documentation": "

The start date and time of the request, in UTC format\n (YYYY-MM-DDTHH:MM:SSZ).\n By default, Amazon EC2 starts fulfilling the request immediately.

", + "smithy.api#xmlName": "validFrom" + } + }, + "ValidUntil": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "ValidUntil", + "smithy.api#documentation": "

The end date and time of the request, in UTC format\n (YYYY-MM-DDTHH:MM:SSZ).\n After the end date and time, no new Spot Instance requests are placed or able to fulfill\n the request. If no value is specified, the Spot Fleet request remains until you cancel\n it.

", + "smithy.api#xmlName": "validUntil" + } + }, + "ReplaceUnhealthyInstances": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "ReplaceUnhealthyInstances", + "smithy.api#documentation": "

Indicates whether Spot Fleet should replace unhealthy instances.

", + "smithy.api#xmlName": "replaceUnhealthyInstances" + } + }, + "InstanceInterruptionBehavior": { + "target": "com.amazonaws.ec2#InstanceInterruptionBehavior", + "traits": { + "aws.protocols#ec2QueryName": "InstanceInterruptionBehavior", + "smithy.api#documentation": "

The behavior when a Spot Instance is interrupted. The default is\n terminate.

", + "smithy.api#xmlName": "instanceInterruptionBehavior" + } + }, + "LoadBalancersConfig": { + "target": "com.amazonaws.ec2#LoadBalancersConfig", + "traits": { + "aws.protocols#ec2QueryName": "LoadBalancersConfig", + "smithy.api#documentation": "

One or more Classic Load Balancers and target groups to attach to the Spot Fleet\n request. Spot Fleet registers the running Spot Instances with the specified Classic Load\n Balancers and target groups.

\n

With Network Load Balancers, Spot Fleet cannot register instances that have the\n following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2,\n M3, and T1.

", + "smithy.api#xmlName": "loadBalancersConfig" + } + }, + "InstancePoolsToUseCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "InstancePoolsToUseCount", + "smithy.api#documentation": "

The number of Spot pools across which to allocate your target Spot capacity. Valid\n only when Spot AllocationStrategy is set to\n lowest-price. Spot Fleet selects the cheapest Spot pools and evenly\n allocates your target Spot capacity across the number of Spot pools that you\n specify.

\n

Note that Spot Fleet attempts to draw Spot Instances from the number of pools that you specify on a\n best effort basis. If a pool runs out of Spot capacity before fulfilling your target\n capacity, Spot Fleet will continue to fulfill your request by drawing from the next cheapest\n pool. To ensure that your target capacity is met, you might receive Spot Instances from more than\n the number of pools that you specified. Similarly, if most of the pools have no Spot\n capacity, you might receive your full target capacity from fewer than the number of\n pools that you specified.

", + "smithy.api#xmlName": "instancePoolsToUseCount" + } + }, + "Context": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Context", + "smithy.api#documentation": "

Reserved.

", + "smithy.api#xmlName": "context" + } + }, + "TargetCapacityUnitType": { + "target": "com.amazonaws.ec2#TargetCapacityUnitType", + "traits": { + "aws.protocols#ec2QueryName": "TargetCapacityUnitType", + "smithy.api#documentation": "

The unit for the target capacity. You can specify this parameter only when \n using attribute-based instance type selection.

\n

Default: units (the number of instances)

", + "smithy.api#xmlName": "targetCapacityUnitType" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The key-value pair for tagging the Spot Fleet request on creation. The value for\n ResourceType must be spot-fleet-request, otherwise the\n Spot Fleet request fails. To tag instances at launch, specify the tags in the launch\n template (valid only if you use LaunchTemplateConfigs) or in\n the \n SpotFleetTagSpecification\n (valid only if you use\n LaunchSpecifications). For information about tagging after launch, see\n Tag your resources.

", + "smithy.api#xmlName": "TagSpecification" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the configuration of a Spot Fleet request.

" + } + }, + "com.amazonaws.ec2#SpotFleetRequestConfigSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SpotFleetRequestConfig", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SpotFleetRequestId": { + "type": "string" + }, + "com.amazonaws.ec2#SpotFleetRequestIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SpotFleetRequestId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SpotFleetTagSpecification": { + "type": "structure", + "members": { + "ResourceType": { + "target": "com.amazonaws.ec2#ResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The type of resource. Currently, the only resource type that is supported is\n instance. To tag the Spot Fleet request on creation, use the\n TagSpecifications parameter in \n SpotFleetRequestConfigData\n .

", + "smithy.api#xmlName": "resourceType" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "Tag", + "smithy.api#documentation": "

The tags.

", + "smithy.api#xmlName": "tag" + } + } + }, + "traits": { + "smithy.api#documentation": "

The tags for a Spot Fleet resource.

" + } + }, + "com.amazonaws.ec2#SpotFleetTagSpecificationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SpotFleetTagSpecification", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SpotInstanceInterruptionBehavior": { + "type": "enum", + "members": { + "hibernate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hibernate" + } + }, + "stop": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "stop" + } + }, + "terminate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "terminate" + } + } + } + }, + "com.amazonaws.ec2#SpotInstanceRequest": { + "type": "structure", + "members": { + "ActualBlockHourlyPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ActualBlockHourlyPrice", + "smithy.api#documentation": "

Deprecated.

", + "smithy.api#xmlName": "actualBlockHourlyPrice" + } + }, + "AvailabilityZoneGroup": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZoneGroup", + "smithy.api#documentation": "

The Availability Zone group. If you specify the same Availability Zone group for all Spot Instance requests, all Spot Instances are launched in the same Availability Zone.

", + "smithy.api#xmlName": "availabilityZoneGroup" + } + }, + "BlockDurationMinutes": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "BlockDurationMinutes", + "smithy.api#documentation": "

Deprecated.

", + "smithy.api#xmlName": "blockDurationMinutes" + } + }, + "CreateTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreateTime", + "smithy.api#documentation": "

The date and time when the Spot Instance request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", + "smithy.api#xmlName": "createTime" + } + }, + "Fault": { + "target": "com.amazonaws.ec2#SpotInstanceStateFault", + "traits": { + "aws.protocols#ec2QueryName": "Fault", + "smithy.api#documentation": "

The fault codes for the Spot Instance request, if any.

", + "smithy.api#xmlName": "fault" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The instance ID, if an instance has been launched to fulfill the Spot Instance request.

", + "smithy.api#xmlName": "instanceId" + } + }, + "LaunchGroup": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LaunchGroup", + "smithy.api#documentation": "

The instance launch group. Launch groups are Spot Instances that launch together and terminate together.

", + "smithy.api#xmlName": "launchGroup" + } + }, + "LaunchSpecification": { + "target": "com.amazonaws.ec2#LaunchSpecification", + "traits": { + "aws.protocols#ec2QueryName": "LaunchSpecification", + "smithy.api#documentation": "

Additional information for launching instances.

", + "smithy.api#xmlName": "launchSpecification" + } + }, + "LaunchedAvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LaunchedAvailabilityZone", + "smithy.api#documentation": "

The Availability Zone in which the request is launched.

", + "smithy.api#xmlName": "launchedAvailabilityZone" + } + }, + "ProductDescription": { + "target": "com.amazonaws.ec2#RIProductDescription", + "traits": { + "aws.protocols#ec2QueryName": "ProductDescription", + "smithy.api#documentation": "

The product description associated with the Spot Instance.

", + "smithy.api#xmlName": "productDescription" + } + }, + "SpotInstanceRequestId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SpotInstanceRequestId", + "smithy.api#documentation": "

The ID of the Spot Instance request.

", + "smithy.api#xmlName": "spotInstanceRequestId" + } + }, + "SpotPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SpotPrice", + "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend \n using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.

\n ", + "smithy.api#xmlName": "spotPrice" + } + }, + "State": { + "target": "com.amazonaws.ec2#SpotInstanceState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the Spot Instance request. Spot request status information helps track your Spot\n Instance requests. For more information, see Spot request status in the\n Amazon EC2 User Guide.

", + "smithy.api#xmlName": "state" + } + }, + "Status": { + "target": "com.amazonaws.ec2#SpotInstanceStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The status code and status message describing the Spot Instance request.

", + "smithy.api#xmlName": "status" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the resource.

", + "smithy.api#xmlName": "tagSet" + } + }, + "Type": { + "target": "com.amazonaws.ec2#SpotInstanceType", + "traits": { + "aws.protocols#ec2QueryName": "Type", + "smithy.api#documentation": "

The Spot Instance request type.

", + "smithy.api#xmlName": "type" + } + }, + "ValidFrom": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "ValidFrom", + "smithy.api#documentation": "

The start date of the request, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).\n The request becomes active at this date and time.

", + "smithy.api#xmlName": "validFrom" + } + }, + "ValidUntil": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "ValidUntil", + "smithy.api#documentation": "

The end date of the request, in UTC format\n (YYYY-MM-DDTHH:MM:SSZ).

\n ", + "smithy.api#xmlName": "validUntil" + } + }, + "InstanceInterruptionBehavior": { + "target": "com.amazonaws.ec2#InstanceInterruptionBehavior", + "traits": { + "aws.protocols#ec2QueryName": "InstanceInterruptionBehavior", + "smithy.api#documentation": "

The behavior when a Spot Instance is interrupted.

", + "smithy.api#xmlName": "instanceInterruptionBehavior" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Spot Instance request.

" + } + }, + "com.amazonaws.ec2#SpotInstanceRequestId": { + "type": "string" + }, + "com.amazonaws.ec2#SpotInstanceRequestIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SpotInstanceRequestId", + "traits": { + "smithy.api#xmlName": "SpotInstanceRequestId" + } + } + }, + "com.amazonaws.ec2#SpotInstanceRequestList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SpotInstanceRequest", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SpotInstanceState": { + "type": "enum", + "members": { + "open": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "open" + } + }, + "active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "closed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "closed" + } + }, + "cancelled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cancelled" + } + }, + "failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + }, + "disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + } + } + }, + "com.amazonaws.ec2#SpotInstanceStateFault": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The reason code for the Spot Instance state change.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

The message for the Spot Instance state change.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Spot Instance state change.

" + } + }, + "com.amazonaws.ec2#SpotInstanceStatus": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The status code. For a list of status codes, see Spot request status codes in the Amazon EC2 User Guide.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

The description for the status code.

", + "smithy.api#xmlName": "message" + } + }, + "UpdateTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "UpdateTime", + "smithy.api#documentation": "

The date and time of the most recent status update, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).

", + "smithy.api#xmlName": "updateTime" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the status of a Spot Instance request.

" + } + }, + "com.amazonaws.ec2#SpotInstanceType": { + "type": "enum", + "members": { + "one_time": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "one-time" + } + }, + "persistent": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "persistent" + } + } + } + }, + "com.amazonaws.ec2#SpotMaintenanceStrategies": { + "type": "structure", + "members": { + "CapacityRebalance": { + "target": "com.amazonaws.ec2#SpotCapacityRebalance", + "traits": { + "aws.protocols#ec2QueryName": "CapacityRebalance", + "smithy.api#documentation": "

The Spot Instance replacement strategy to use when Amazon EC2 emits a signal that your\n Spot Instance is at an elevated risk of being interrupted. For more information, see\n Capacity\n rebalancing in the Amazon EC2 User Guide.

", + "smithy.api#xmlName": "capacityRebalance" + } + } + }, + "traits": { + "smithy.api#documentation": "

The strategies for managing your Spot Instances that are at an elevated risk of being\n interrupted.

" + } + }, + "com.amazonaws.ec2#SpotMarketOptions": { + "type": "structure", + "members": { + "MaxPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The maximum hourly price that you're willing to pay for a Spot Instance. We do not\n recommend using this parameter because it can lead to increased interruptions. If you do\n not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your Spot Instances will be interrupted more\n frequently than if you do not specify this parameter.

\n " + } + }, + "SpotInstanceType": { + "target": "com.amazonaws.ec2#SpotInstanceType", + "traits": { + "smithy.api#documentation": "

The Spot Instance request type. For RunInstances, persistent\n Spot Instance requests are only supported when the instance interruption behavior is\n either hibernate or stop.

" + } + }, + "BlockDurationMinutes": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

Deprecated.

" + } + }, + "ValidUntil": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "smithy.api#documentation": "

The end date of the request, in UTC format\n (YYYY-MM-DDTHH:MM:SSZ).\n Supported only for persistent requests.

\n " + } + }, + "InstanceInterruptionBehavior": { + "target": "com.amazonaws.ec2#InstanceInterruptionBehavior", + "traits": { + "smithy.api#documentation": "

The behavior when a Spot Instance is interrupted.

\n

If Configured (for \n HibernationOptions\n ) is set to true, the\n InstanceInterruptionBehavior parameter is automatically set to\n hibernate. If you set it to stop or\n terminate, you'll get an error.

\n

If Configured (for \n HibernationOptions\n ) is set to false or\n null, the InstanceInterruptionBehavior parameter is\n automatically set to terminate. You can also set it to stop or\n hibernate.

\n

For more information, see Interruption\n behavior in the Amazon EC2 User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options for Spot Instances.

" + } + }, + "com.amazonaws.ec2#SpotOptions": { + "type": "structure", + "members": { + "AllocationStrategy": { + "target": "com.amazonaws.ec2#SpotAllocationStrategy", + "traits": { + "aws.protocols#ec2QueryName": "AllocationStrategy", + "smithy.api#documentation": "

The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance\n pools specified by the EC2 Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the\n Amazon EC2 User Guide.

\n
\n
price-capacity-optimized (recommended)
\n
\n

EC2 Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. EC2 Fleet then requests Spot Instances from the lowest priced of these pools.

\n
\n
capacity-optimized
\n
\n

EC2 Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. To give certain\n instance types a higher chance of launching first, use\n capacity-optimized-prioritized. Set a priority for each instance type by\n using the Priority parameter for LaunchTemplateOverrides. You can\n assign the same priority to different LaunchTemplateOverrides. EC2 implements\n the priorities on a best-effort basis, but optimizes for capacity first.\n capacity-optimized-prioritized is supported only if your EC2 Fleet uses a\n launch template. Note that if the On-Demand AllocationStrategy is set to\n prioritized, the same priority is applied when fulfilling On-Demand\n capacity.

\n
\n
diversified
\n
\n

EC2 Fleet requests instances from all of the Spot Instance pools that you\n specify.

\n
\n
lowest-price (not recommended)
\n
\n \n

We don't recommend the lowest-price allocation strategy because\n it has the highest risk of interruption for your Spot Instances.

\n \n

EC2 Fleet requests instances from the lowest priced Spot Instance pool that has available\n capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances\n come from the next lowest priced pool that has available capacity. If a pool runs\n out of capacity before fulfilling your desired capacity, EC2 Fleet will continue to\n fulfill your request by drawing from the next lowest priced pool. To ensure that\n your desired capacity is met, you might receive Spot Instances from several pools. Because\n this strategy only considers instance price and not capacity availability, it\n might lead to high interruption rates.

\n
\n
\n

Default: lowest-price\n

", + "smithy.api#xmlName": "allocationStrategy" + } + }, + "MaintenanceStrategies": { + "target": "com.amazonaws.ec2#FleetSpotMaintenanceStrategies", + "traits": { + "aws.protocols#ec2QueryName": "MaintenanceStrategies", + "smithy.api#documentation": "

The strategies for managing your workloads on your Spot Instances that will be\n interrupted. Currently only the capacity rebalance strategy is available.

", + "smithy.api#xmlName": "maintenanceStrategies" + } + }, + "InstanceInterruptionBehavior": { + "target": "com.amazonaws.ec2#SpotInstanceInterruptionBehavior", + "traits": { + "aws.protocols#ec2QueryName": "InstanceInterruptionBehavior", + "smithy.api#documentation": "

The behavior when a Spot Instance is interrupted.

\n

Default: terminate\n

", + "smithy.api#xmlName": "instanceInterruptionBehavior" + } + }, + "InstancePoolsToUseCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "InstancePoolsToUseCount", + "smithy.api#documentation": "

The number of Spot pools across which to allocate your target Spot capacity. Supported\n only when AllocationStrategy is set to lowest-price. EC2 Fleet selects\n the cheapest Spot pools and evenly allocates your target Spot capacity across the number of\n Spot pools that you specify.

\n

Note that EC2 Fleet attempts to draw Spot Instances from the number of pools that you specify on a\n best effort basis. If a pool runs out of Spot capacity before fulfilling your target\n capacity, EC2 Fleet will continue to fulfill your request by drawing from the next cheapest\n pool. To ensure that your target capacity is met, you might receive Spot Instances from more than\n the number of pools that you specified. Similarly, if most of the pools have no Spot\n capacity, you might receive your full target capacity from fewer than the number of pools\n that you specified.

", + "smithy.api#xmlName": "instancePoolsToUseCount" + } + }, + "SingleInstanceType": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "SingleInstanceType", + "smithy.api#documentation": "

Indicates that the fleet uses a single instance type to launch all Spot Instances in the\n fleet.

\n

Supported only for fleets of type instant.

", + "smithy.api#xmlName": "singleInstanceType" + } + }, + "SingleAvailabilityZone": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "SingleAvailabilityZone", + "smithy.api#documentation": "

Indicates that the fleet launches all Spot Instances into a single Availability Zone.

\n

Supported only for fleets of type instant.

", + "smithy.api#xmlName": "singleAvailabilityZone" + } + }, + "MinTargetCapacity": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "MinTargetCapacity", + "smithy.api#documentation": "

The minimum target capacity for Spot Instances in the fleet. If this minimum capacity isn't\n reached, no instances are launched.

\n

Constraints: Maximum value of 1000. Supported only for fleets of type\n instant.

\n

At least one of the following must be specified: SingleAvailabilityZone |\n SingleInstanceType\n

", + "smithy.api#xmlName": "minTargetCapacity" + } + }, + "MaxTotalPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "MaxTotalPrice", + "smithy.api#documentation": "

The maximum amount per hour for Spot Instances that you're willing to pay. We do not recommend\n using this parameter because it can lead to increased interruptions. If you do not specify\n this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.

\n \n \n

If your fleet includes T instances that are configured as unlimited, and\n if their average CPU usage exceeds the baseline utilization, you will incur a charge for\n surplus credits. The maxTotalPrice does not account for surplus credits,\n and, if you use surplus credits, your final cost might be higher than what you specified\n for maxTotalPrice. For more information, see Surplus credits can incur charges in the\n Amazon EC2 User Guide.

\n ", + "smithy.api#xmlName": "maxTotalPrice" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the configuration of Spot Instances in an EC2 Fleet.

" + } + }, + "com.amazonaws.ec2#SpotOptionsRequest": { + "type": "structure", + "members": { + "AllocationStrategy": { + "target": "com.amazonaws.ec2#SpotAllocationStrategy", + "traits": { + "smithy.api#documentation": "

The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance\n pools specified by the EC2 Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the\n Amazon EC2 User Guide.

\n
\n
price-capacity-optimized (recommended)
\n
\n

EC2 Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. EC2 Fleet then requests Spot Instances from the lowest priced of these pools.

\n
\n
capacity-optimized
\n
\n

EC2 Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. To give certain\n instance types a higher chance of launching first, use\n capacity-optimized-prioritized. Set a priority for each instance type by\n using the Priority parameter for LaunchTemplateOverrides. You can\n assign the same priority to different LaunchTemplateOverrides. EC2 implements\n the priorities on a best-effort basis, but optimizes for capacity first.\n capacity-optimized-prioritized is supported only if your EC2 Fleet uses a\n launch template. Note that if the On-Demand AllocationStrategy is set to\n prioritized, the same priority is applied when fulfilling On-Demand\n capacity.

\n
\n
diversified
\n
\n

EC2 Fleet requests instances from all of the Spot Instance pools that you\n specify.

\n
\n
lowest-price (not recommended)
\n
\n \n

We don't recommend the lowest-price allocation strategy because\n it has the highest risk of interruption for your Spot Instances.

\n \n

EC2 Fleet requests instances from the lowest priced Spot Instance pool that\n has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances\n come from the next lowest priced pool that has available capacity. If a pool runs out of\n capacity before fulfilling your desired capacity, EC2 Fleet will continue to fulfill your\n request by drawing from the next lowest priced pool. To ensure that your desired capacity is\n met, you might receive Spot Instances from several pools. Because this strategy only considers instance \n price and not capacity availability, it might lead to high interruption rates.

\n
\n
\n

Default: lowest-price\n

" + } + }, + "MaintenanceStrategies": { + "target": "com.amazonaws.ec2#FleetSpotMaintenanceStrategiesRequest", + "traits": { + "smithy.api#documentation": "

The strategies for managing your Spot Instances that are at an elevated risk of being\n interrupted.

" + } + }, + "InstanceInterruptionBehavior": { + "target": "com.amazonaws.ec2#SpotInstanceInterruptionBehavior", + "traits": { + "smithy.api#documentation": "

The behavior when a Spot Instance is interrupted.

\n

Default: terminate\n

" + } + }, + "InstancePoolsToUseCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The number of Spot pools across which to allocate your target Spot capacity. Supported\n only when Spot AllocationStrategy is set to lowest-price. EC2 Fleet\n selects the cheapest Spot pools and evenly allocates your target Spot capacity across the\n number of Spot pools that you specify.

\n

Note that EC2 Fleet attempts to draw Spot Instances from the number of pools that you specify on a\n best effort basis. If a pool runs out of Spot capacity before fulfilling your target\n capacity, EC2 Fleet will continue to fulfill your request by drawing from the next cheapest\n pool. To ensure that your target capacity is met, you might receive Spot Instances from more than\n the number of pools that you specified. Similarly, if most of the pools have no Spot\n capacity, you might receive your full target capacity from fewer than the number of pools\n that you specified.

" + } + }, + "SingleInstanceType": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates that the fleet uses a single instance type to launch all Spot Instances in the\n fleet.

\n

Supported only for fleets of type instant.

" + } + }, + "SingleAvailabilityZone": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates that the fleet launches all Spot Instances into a single Availability Zone.

\n

Supported only for fleets of type instant.

" + } + }, + "MinTargetCapacity": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The minimum target capacity for Spot Instances in the fleet. If this minimum capacity isn't\n reached, no instances are launched.

\n

Constraints: Maximum value of 1000. Supported only for fleets of type\n instant.

\n

At least one of the following must be specified: SingleAvailabilityZone |\n SingleInstanceType\n

" + } + }, + "MaxTotalPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The maximum amount per hour for Spot Instances that you're willing to pay. We do not recommend\n using this parameter because it can lead to increased interruptions. If you do not specify\n this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.

\n \n \n

If your fleet includes T instances that are configured as unlimited, and\n if their average CPU usage exceeds the baseline utilization, you will incur a charge for\n surplus credits. The MaxTotalPrice does not account for surplus credits,\n and, if you use surplus credits, your final cost might be higher than what you specified\n for MaxTotalPrice. For more information, see Surplus credits can incur charges in the\n Amazon EC2 User Guide.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the configuration of Spot Instances in an EC2 Fleet request.

" + } + }, + "com.amazonaws.ec2#SpotPlacement": { + "type": "structure", + "members": { + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone.

\n

[Spot Fleet only] To specify multiple Availability Zones, separate them using commas;\n for example, \"us-west-2a, us-west-2b\".

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "GroupName": { + "target": "com.amazonaws.ec2#PlacementGroupName", + "traits": { + "aws.protocols#ec2QueryName": "GroupName", + "smithy.api#documentation": "

The name of the placement group.

", + "smithy.api#xmlName": "groupName" + } + }, + "Tenancy": { + "target": "com.amazonaws.ec2#Tenancy", + "traits": { + "aws.protocols#ec2QueryName": "Tenancy", + "smithy.api#documentation": "

The tenancy of the instance (if the instance is running in a VPC). An instance with a\n tenancy of dedicated runs on single-tenant hardware. The host\n tenancy is not supported for Spot Instances.

", + "smithy.api#xmlName": "tenancy" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes Spot Instance placement.

" + } + }, + "com.amazonaws.ec2#SpotPlacementScore": { + "type": "structure", + "members": { + "Region": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Region", + "smithy.api#documentation": "

The Region.

", + "smithy.api#xmlName": "region" + } + }, + "AvailabilityZoneId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZoneId", + "smithy.api#documentation": "

The Availability Zone.

", + "smithy.api#xmlName": "availabilityZoneId" + } + }, + "Score": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Score", + "smithy.api#documentation": "

The placement score, on a scale from 1 to 10. A score of\n 10 indicates that your Spot request is highly likely to succeed in this\n Region or Availability Zone. A score of 1 indicates that your Spot request is\n not likely to succeed.

", + "smithy.api#xmlName": "score" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Spot placement score for this Region or Availability Zone. The score is calculated\n based on the assumption that the capacity-optimized allocation strategy is\n used and that all of the Availability Zones in the Region can be used.

" + } + }, + "com.amazonaws.ec2#SpotPlacementScores": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SpotPlacementScore", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SpotPlacementScoresMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 10, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#SpotPlacementScoresTargetCapacity": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 2000000000 + } + } + }, + "com.amazonaws.ec2#SpotPrice": { + "type": "structure", + "members": { + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type.

", + "smithy.api#xmlName": "instanceType" + } + }, + "ProductDescription": { + "target": "com.amazonaws.ec2#RIProductDescription", + "traits": { + "aws.protocols#ec2QueryName": "ProductDescription", + "smithy.api#documentation": "

A general description of the AMI.

", + "smithy.api#xmlName": "productDescription" + } + }, + "SpotPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SpotPrice", + "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend \n using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.

\n ", + "smithy.api#xmlName": "spotPrice" + } + }, + "Timestamp": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "Timestamp", + "smithy.api#documentation": "

The date and time the request was created, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).

", + "smithy.api#xmlName": "timestamp" + } + } + }, + "traits": { + "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend \n using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.

\n " + } + }, + "com.amazonaws.ec2#SpotPriceHistoryList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SpotPrice", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SpreadLevel": { + "type": "enum", + "members": { + "host": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "host" + } + }, + "rack": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rack" + } + } + } + }, + "com.amazonaws.ec2#StaleIpPermission": { + "type": "structure", + "members": { + "FromPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "FromPort", + "smithy.api#documentation": "

If the protocol is TCP or UDP, this is the start of the port range. \n If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types).

", + "smithy.api#xmlName": "fromPort" + } + }, + "IpProtocol": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IpProtocol", + "smithy.api#documentation": "

The IP protocol name (tcp, udp, icmp, icmpv6) or number\n (see Protocol Numbers).

", + "smithy.api#xmlName": "ipProtocol" + } + }, + "IpRanges": { + "target": "com.amazonaws.ec2#IpRanges", + "traits": { + "aws.protocols#ec2QueryName": "IpRanges", + "smithy.api#documentation": "

The IP ranges. Not applicable for stale security group rules.

", + "smithy.api#xmlName": "ipRanges" + } + }, + "PrefixListIds": { + "target": "com.amazonaws.ec2#PrefixListIdSet", + "traits": { + "aws.protocols#ec2QueryName": "PrefixListIds", + "smithy.api#documentation": "

The prefix list IDs. Not applicable for stale security group rules.

", + "smithy.api#xmlName": "prefixListIds" + } + }, + "ToPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "ToPort", + "smithy.api#documentation": "

If the protocol is TCP or UDP, this is the end of the port range.\n If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes).

", + "smithy.api#xmlName": "toPort" + } + }, + "UserIdGroupPairs": { + "target": "com.amazonaws.ec2#UserIdGroupPairSet", + "traits": { + "aws.protocols#ec2QueryName": "Groups", + "smithy.api#documentation": "

The security group pairs. Returns the ID of the referenced security group and VPC, and the ID and status of the VPC peering connection.

", + "smithy.api#xmlName": "groups" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a stale rule in a security group.

" + } + }, + "com.amazonaws.ec2#StaleIpPermissionSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#StaleIpPermission", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#StaleSecurityGroup": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description of the security group.

", + "smithy.api#xmlName": "description" + } + }, + "GroupId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupId", + "smithy.api#documentation": "

The ID of the security group.

", + "smithy.api#xmlName": "groupId" + } + }, + "GroupName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupName", + "smithy.api#documentation": "

The name of the security group.

", + "smithy.api#xmlName": "groupName" + } + }, + "StaleIpPermissions": { + "target": "com.amazonaws.ec2#StaleIpPermissionSet", + "traits": { + "aws.protocols#ec2QueryName": "StaleIpPermissions", + "smithy.api#documentation": "

Information about the stale inbound rules in the security group.

", + "smithy.api#xmlName": "staleIpPermissions" + } + }, + "StaleIpPermissionsEgress": { + "target": "com.amazonaws.ec2#StaleIpPermissionSet", + "traits": { + "aws.protocols#ec2QueryName": "StaleIpPermissionsEgress", + "smithy.api#documentation": "

Information about the stale outbound rules in the security group.

", + "smithy.api#xmlName": "staleIpPermissionsEgress" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC for the security group.

", + "smithy.api#xmlName": "vpcId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a stale security group (a security group that contains stale rules).

" + } + }, + "com.amazonaws.ec2#StaleSecurityGroupSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#StaleSecurityGroup", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#StartDeclarativePoliciesReport": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#StartDeclarativePoliciesReportRequest" + }, + "output": { + "target": "com.amazonaws.ec2#StartDeclarativePoliciesReportResult" + }, + "traits": { + "smithy.api#documentation": "

Generates an account status report. The report is generated asynchronously, and can\n take several hours to complete.

\n

The report provides the current status of all attributes supported by declarative\n policies for the accounts within the specified scope. The scope is determined by the\n specified TargetId, which can represent an individual account, or all the\n accounts that fall under the specified organizational unit (OU) or root (the entire\n Amazon Web Services Organization).

\n

The report is saved to your specified S3 bucket, using the following path structure\n (with the italicized placeholders representing your specific\n values):

\n

\n s3://amzn-s3-demo-bucket/your-optional-s3-prefix/ec2_targetId_reportId_yyyyMMddThhmmZ.csv\n

\n

\n Prerequisites for generating a report\n

\n \n

For more information, including the required IAM permissions to run this API, see\n Generating the account status report for declarative policies in the\n Amazon Web Services Organizations User Guide.

" + } + }, + "com.amazonaws.ec2#StartDeclarativePoliciesReportRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "S3Bucket": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the S3 bucket where the report will be saved. The bucket must be in the\n same Region where the report generation request is made.

", + "smithy.api#required": {} + } + }, + "S3Prefix": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The prefix for your S3 object.

" + } + }, + "TargetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The root ID, organizational unit ID, or account ID.

\n

Format:

\n ", + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply.

", + "smithy.api#xmlName": "TagSpecification" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#StartDeclarativePoliciesReportResult": { + "type": "structure", + "members": { + "ReportId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ReportId", + "smithy.api#documentation": "

The ID of the report.

", + "smithy.api#xmlName": "reportId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#StartInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#StartInstancesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#StartInstancesResult" + }, + "traits": { + "smithy.api#documentation": "

Starts an Amazon EBS-backed instance that you've previously stopped.

\n

Instances that use Amazon EBS volumes as their root devices can be quickly stopped and\n started. When an instance is stopped, the compute resources are released and you are not\n billed for instance usage. However, your root partition Amazon EBS volume remains and\n continues to persist your data, and you are charged for Amazon EBS volume usage. You can\n restart your instance at any time. Every time you start your instance, Amazon EC2\n charges a one-minute minimum for instance usage, and thereafter charges per second for\n instance usage.

\n

Before stopping an instance, make sure it is in a state from which it can be\n restarted. Stopping an instance does not preserve data stored in RAM.

\n

Performing this operation on an instance that uses an instance store as its root\n device returns an error.

\n

If you attempt to start a T3 instance with host tenancy and the\n unlimited CPU credit option, the request fails. The\n unlimited CPU credit option is not supported on Dedicated Hosts. Before\n you start the instance, either change its CPU credit option to standard, or\n change its tenancy to default or dedicated.

\n

For more information, see Stop and start Amazon EC2\n instances in the Amazon EC2 User Guide.

", + "smithy.api#examples": [ + { + "title": "To start a stopped EC2 instance", + "documentation": "This example starts the specified EC2 instance.", + "input": { + "InstanceIds": [ + "i-1234567890abcdef0" + ] + }, + "output": { + "StartingInstances": [ + { + "InstanceId": "i-1234567890abcdef0", + "CurrentState": { + "Code": 0, + "Name": "pending" + }, + "PreviousState": { + "Code": 80, + "Name": "stopped" + } + } + ] + } + } + ] + } + }, + "com.amazonaws.ec2#StartInstancesRequest": { + "type": "structure", + "members": { + "InstanceIds": { + "target": "com.amazonaws.ec2#InstanceIdStringList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the instances.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "InstanceId" + } + }, + "AdditionalInfo": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AdditionalInfo", + "smithy.api#documentation": "

Reserved.

", + "smithy.api#xmlName": "additionalInfo" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#StartInstancesResult": { + "type": "structure", + "members": { + "StartingInstances": { + "target": "com.amazonaws.ec2#InstanceStateChangeList", + "traits": { + "aws.protocols#ec2QueryName": "InstancesSet", + "smithy.api#documentation": "

Information about the started instances.

", + "smithy.api#xmlName": "instancesSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#StartNetworkInsightsAccessScopeAnalysis": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#StartNetworkInsightsAccessScopeAnalysisRequest" + }, + "output": { + "target": "com.amazonaws.ec2#StartNetworkInsightsAccessScopeAnalysisResult" + }, + "traits": { + "smithy.api#documentation": "

Starts analyzing the specified Network Access Scope.

" + } + }, + "com.amazonaws.ec2#StartNetworkInsightsAccessScopeAnalysisRequest": { + "type": "structure", + "members": { + "NetworkInsightsAccessScopeId": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Network Access Scope.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, \n see How to ensure idempotency.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#StartNetworkInsightsAccessScopeAnalysisResult": { + "type": "structure", + "members": { + "NetworkInsightsAccessScopeAnalysis": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysis", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeAnalysis", + "smithy.api#documentation": "

The Network Access Scope analysis.

", + "smithy.api#xmlName": "networkInsightsAccessScopeAnalysis" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#StartNetworkInsightsAnalysis": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#StartNetworkInsightsAnalysisRequest" + }, + "output": { + "target": "com.amazonaws.ec2#StartNetworkInsightsAnalysisResult" + }, + "traits": { + "smithy.api#documentation": "

Starts analyzing the specified path. If the path is reachable, the\n operation returns the shortest feasible path.

" + } + }, + "com.amazonaws.ec2#StartNetworkInsightsAnalysisRequest": { + "type": "structure", + "members": { + "NetworkInsightsPathId": { + "target": "com.amazonaws.ec2#NetworkInsightsPathId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the path.

", + "smithy.api#required": {} + } + }, + "AdditionalAccounts": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The member accounts that contain resources that the path can traverse.

", + "smithy.api#xmlName": "AdditionalAccount" + } + }, + "FilterInArns": { + "target": "com.amazonaws.ec2#ArnList", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the resources that the path must traverse.

", + "smithy.api#xmlName": "FilterInArn" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, \n see How to ensure idempotency.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#StartNetworkInsightsAnalysisResult": { + "type": "structure", + "members": { + "NetworkInsightsAnalysis": { + "target": "com.amazonaws.ec2#NetworkInsightsAnalysis", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAnalysis", + "smithy.api#documentation": "

Information about the network insights analysis.

", + "smithy.api#xmlName": "networkInsightsAnalysis" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#StartVpcEndpointServicePrivateDnsVerification": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#StartVpcEndpointServicePrivateDnsVerificationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#StartVpcEndpointServicePrivateDnsVerificationResult" + }, + "traits": { + "smithy.api#documentation": "

Initiates the verification process to prove that the service provider owns the private\n DNS name domain for the endpoint service.

\n

The service provider must successfully perform the verification before the consumer can use the name to access the service.

\n

Before the service provider runs this command, they must add a record to the DNS server.

" + } + }, + "com.amazonaws.ec2#StartVpcEndpointServicePrivateDnsVerificationRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ServiceId": { + "target": "com.amazonaws.ec2#VpcEndpointServiceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the endpoint service.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#StartVpcEndpointServicePrivateDnsVerificationResult": { + "type": "structure", + "members": { + "ReturnValue": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#State": { + "type": "enum", + "members": { + "PendingAcceptance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PendingAcceptance" + } + }, + "Pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "Available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Available" + } + }, + "Deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "Deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleted" + } + }, + "Rejected": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Rejected" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "Expired": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Expired" + } + }, + "Partial": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Partial" + } + } + } + }, + "com.amazonaws.ec2#StateReason": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The reason code for the state change.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

The message for the state change.

\n ", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a state change.

" + } + }, + "com.amazonaws.ec2#StaticSourcesSupportValue": { + "type": "enum", + "members": { + "enable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enable" + } + }, + "disable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disable" + } + } + } + }, + "com.amazonaws.ec2#StatisticType": { + "type": "enum", + "members": { + "p50": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "p50" + } + } + } + }, + "com.amazonaws.ec2#Status": { + "type": "enum", + "members": { + "moveInProgress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MoveInProgress" + } + }, + "inVpc": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InVpc" + } + }, + "inClassic": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InClassic" + } + } + } + }, + "com.amazonaws.ec2#StatusName": { + "type": "enum", + "members": { + "reachability": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "reachability" + } + } + } + }, + "com.amazonaws.ec2#StatusType": { + "type": "enum", + "members": { + "passed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "passed" + } + }, + "failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + }, + "insufficient_data": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "insufficient-data" + } + }, + "initializing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "initializing" + } + } + } + }, + "com.amazonaws.ec2#StopInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#StopInstancesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#StopInstancesResult" + }, + "traits": { + "smithy.api#documentation": "

Stops an Amazon EBS-backed instance. For more information, see Stop and start\n Amazon EC2 instances in the Amazon EC2 User\n Guide.

\n

You can use the Stop action to hibernate an instance if the instance is enabled\n for hibernation and it meets the hibernation\n prerequisites. For more information, see Hibernate your Amazon EC2\n instance in the Amazon EC2 User Guide.

\n

We don't charge usage for a stopped instance, or data transfer fees; however, your\n root partition Amazon EBS volume remains and continues to persist your data, and you are\n charged for Amazon EBS volume usage. Every time you start your instance, Amazon EC2\n charges a one-minute minimum for instance usage, and thereafter charges per second for\n instance usage.

\n

You can't stop or hibernate instance store-backed instances. You can't use the Stop\n action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate\n Spot Instances when they are interrupted. For more information, see Hibernating interrupted Spot Instances in the\n Amazon EC2 User Guide.

\n

When you stop or hibernate an instance, we shut it down. You can restart your instance\n at any time. Before stopping or hibernating an instance, make sure it is in a state from\n which it can be restarted. Stopping an instance does not preserve data stored in RAM,\n but hibernating an instance does preserve data stored in RAM. If an instance cannot\n hibernate successfully, a normal shutdown occurs.

\n

Stopping and hibernating an instance is different to rebooting or terminating it. For\n example, when you stop or hibernate an instance, the root device and any other devices\n attached to the instance persist. When you terminate an instance, the root device and\n any other devices attached during the instance launch are automatically deleted. For\n more information about the differences between rebooting, stopping, hibernating, and\n terminating instances, see Instance lifecycle\n in the Amazon EC2 User Guide.

\n

When you stop an instance, we attempt to shut it down forcibly after a short while. If\n your instance appears stuck in the stopping state after a period of time, there may be\n an issue with the underlying host computer. For more information, see Troubleshoot\n stopping your instance in the Amazon EC2 User Guide.

", + "smithy.api#examples": [ + { + "title": "To stop a running EC2 instance", + "documentation": "This example stops the specified EC2 instance.", + "input": { + "InstanceIds": [ + "i-1234567890abcdef0" + ] + }, + "output": { + "StoppingInstances": [ + { + "InstanceId": "i-1234567890abcdef0", + "CurrentState": { + "Code": 64, + "Name": "stopping" + }, + "PreviousState": { + "Code": 16, + "Name": "running" + } + } + ] + } + } + ] + } + }, + "com.amazonaws.ec2#StopInstancesRequest": { + "type": "structure", + "members": { + "InstanceIds": { + "target": "com.amazonaws.ec2#InstanceIdStringList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the instances.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "InstanceId" + } + }, + "Hibernate": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Hibernates the instance if the instance was enabled for hibernation at launch. If the\n instance cannot hibernate successfully, a normal shutdown occurs. For more information,\n see Hibernate\n your instance in the Amazon EC2 User Guide.

\n

Default: false\n

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "Force": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Force", + "smithy.api#documentation": "

Forces the instances to stop. The instances do not have an opportunity to flush file\n system caches or file system metadata. If you use this option, you must perform file\n system check and repair procedures. This option is not recommended for Windows\n instances.

\n

Default: false\n

", + "smithy.api#xmlName": "force" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#StopInstancesResult": { + "type": "structure", + "members": { + "StoppingInstances": { + "target": "com.amazonaws.ec2#InstanceStateChangeList", + "traits": { + "aws.protocols#ec2QueryName": "InstancesSet", + "smithy.api#documentation": "

Information about the stopped instances.

", + "smithy.api#xmlName": "instancesSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#Storage": { + "type": "structure", + "members": { + "S3": { + "target": "com.amazonaws.ec2#S3Storage", + "traits": { + "smithy.api#documentation": "

An Amazon S3 storage location.

", + "smithy.api#xmlName": "S3" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the storage location for an instance store-backed AMI.

" + } + }, + "com.amazonaws.ec2#StorageLocation": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the S3 bucket.

" + } + }, + "Key": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The key.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a storage location in Amazon S3.

" + } + }, + "com.amazonaws.ec2#StorageTier": { + "type": "enum", + "members": { + "archive": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "archive" + } + }, + "standard": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "standard" + } + } + } + }, + "com.amazonaws.ec2#StoreImageTaskResult": { + "type": "structure", + "members": { + "AmiId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AmiId", + "smithy.api#documentation": "

The ID of the AMI that is being stored.

", + "smithy.api#xmlName": "amiId" + } + }, + "TaskStartTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "TaskStartTime", + "smithy.api#documentation": "

The time the task started.

", + "smithy.api#xmlName": "taskStartTime" + } + }, + "Bucket": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Bucket", + "smithy.api#documentation": "

The name of the Amazon S3 bucket that contains the stored AMI object.

", + "smithy.api#xmlName": "bucket" + } + }, + "S3objectKey": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "S3objectKey", + "smithy.api#documentation": "

The name of the stored AMI object in the bucket.

", + "smithy.api#xmlName": "s3objectKey" + } + }, + "ProgressPercentage": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "ProgressPercentage", + "smithy.api#documentation": "

The progress of the task as a percentage.

", + "smithy.api#xmlName": "progressPercentage" + } + }, + "StoreTaskState": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StoreTaskState", + "smithy.api#documentation": "

The state of the store task (InProgress, Completed, or\n Failed).

", + "smithy.api#xmlName": "storeTaskState" + } + }, + "StoreTaskFailureReason": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StoreTaskFailureReason", + "smithy.api#documentation": "

If the tasks fails, the reason for the failure is returned. If the task succeeds,\n null is returned.

", + "smithy.api#xmlName": "storeTaskFailureReason" + } + } + }, + "traits": { + "smithy.api#documentation": "

The information about the AMI store task, including the progress of the task.

" + } + }, + "com.amazonaws.ec2#StoreImageTaskResultSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#StoreImageTaskResult", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#String": { + "type": "string" + }, + "com.amazonaws.ec2#StringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#StringType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64000 + } + } + }, + "com.amazonaws.ec2#Subnet": { + "type": "structure", + "members": { + "AvailabilityZoneId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZoneId", + "smithy.api#documentation": "

The AZ ID of the subnet.

", + "smithy.api#xmlName": "availabilityZoneId" + } + }, + "EnableLniAtDeviceIndex": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "EnableLniAtDeviceIndex", + "smithy.api#documentation": "

\n Indicates the device position for local network interfaces in this subnet. For example, \n 1 indicates local network interfaces in this subnet are the secondary \n network interface (eth1). \n

", + "smithy.api#xmlName": "enableLniAtDeviceIndex" + } + }, + "MapCustomerOwnedIpOnLaunch": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "MapCustomerOwnedIpOnLaunch", + "smithy.api#documentation": "

Indicates whether a network interface created in this subnet (including a network\n interface created by RunInstances) receives a customer-owned IPv4 address.

", + "smithy.api#xmlName": "mapCustomerOwnedIpOnLaunch" + } + }, + "CustomerOwnedIpv4Pool": { + "target": "com.amazonaws.ec2#CoipPoolId", + "traits": { + "aws.protocols#ec2QueryName": "CustomerOwnedIpv4Pool", + "smithy.api#documentation": "

The customer-owned IPv4 address pool associated with the subnet.

", + "smithy.api#xmlName": "customerOwnedIpv4Pool" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the subnet.

", + "smithy.api#xmlName": "ownerId" + } + }, + "AssignIpv6AddressOnCreation": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "AssignIpv6AddressOnCreation", + "smithy.api#documentation": "

Indicates whether a network interface created in this subnet (including a network\n interface created by RunInstances) receives an IPv6 address.

", + "smithy.api#xmlName": "assignIpv6AddressOnCreation" + } + }, + "Ipv6CidrBlockAssociationSet": { + "target": "com.amazonaws.ec2#SubnetIpv6CidrBlockAssociationSet", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6CidrBlockAssociationSet", + "smithy.api#documentation": "

Information about the IPv6 CIDR blocks associated with the subnet.

", + "smithy.api#xmlName": "ipv6CidrBlockAssociationSet" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the subnet.

", + "smithy.api#xmlName": "tagSet" + } + }, + "SubnetArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SubnetArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the subnet.

", + "smithy.api#xmlName": "subnetArn" + } + }, + "OutpostArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OutpostArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost.

", + "smithy.api#xmlName": "outpostArn" + } + }, + "EnableDns64": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EnableDns64", + "smithy.api#documentation": "

Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet \n should return synthetic IPv6 addresses for IPv4-only destinations.

", + "smithy.api#xmlName": "enableDns64" + } + }, + "Ipv6Native": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6Native", + "smithy.api#documentation": "

Indicates whether this is an IPv6 only subnet.

", + "smithy.api#xmlName": "ipv6Native" + } + }, + "PrivateDnsNameOptionsOnLaunch": { + "target": "com.amazonaws.ec2#PrivateDnsNameOptionsOnLaunch", + "traits": { + "aws.protocols#ec2QueryName": "PrivateDnsNameOptionsOnLaunch", + "smithy.api#documentation": "

The type of hostnames to assign to instances in the subnet at launch. An instance hostname\n is based on the IPv4 address or ID of the instance.

", + "smithy.api#xmlName": "privateDnsNameOptionsOnLaunch" + } + }, + "BlockPublicAccessStates": { + "target": "com.amazonaws.ec2#BlockPublicAccessStates", + "traits": { + "aws.protocols#ec2QueryName": "BlockPublicAccessStates", + "smithy.api#documentation": "

The state of VPC Block Public Access (BPA).

", + "smithy.api#xmlName": "blockPublicAccessStates" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet.

", + "smithy.api#xmlName": "subnetId" + } + }, + "State": { + "target": "com.amazonaws.ec2#SubnetState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of the subnet.

", + "smithy.api#xmlName": "state" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC the subnet is in.

", + "smithy.api#xmlName": "vpcId" + } + }, + "CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CidrBlock", + "smithy.api#documentation": "

The IPv4 CIDR block assigned to the subnet.

", + "smithy.api#xmlName": "cidrBlock" + } + }, + "AvailableIpAddressCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "AvailableIpAddressCount", + "smithy.api#documentation": "

The number of unused private IPv4 addresses in the subnet. The IPv4 addresses for any\n\t\t\tstopped instances are considered unavailable.

", + "smithy.api#xmlName": "availableIpAddressCount" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone of the subnet.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "DefaultForAz": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DefaultForAz", + "smithy.api#documentation": "

Indicates whether this is the default subnet for the Availability Zone.

", + "smithy.api#xmlName": "defaultForAz" + } + }, + "MapPublicIpOnLaunch": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "MapPublicIpOnLaunch", + "smithy.api#documentation": "

Indicates whether instances launched in this subnet receive a public IPv4 address.

\n

Amazon Web Services charges for all public IPv4 addresses, including public IPv4 addresses \nassociated with running instances and Elastic IP addresses. For more information, see the Public IPv4 Address tab on the Amazon VPC pricing page.

", + "smithy.api#xmlName": "mapPublicIpOnLaunch" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a subnet.

" + } + }, + "com.amazonaws.ec2#SubnetAssociation": { + "type": "structure", + "members": { + "SubnetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet.

", + "smithy.api#xmlName": "subnetId" + } + }, + "State": { + "target": "com.amazonaws.ec2#TransitGatewayMulitcastDomainAssociationState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the subnet association.

", + "smithy.api#xmlName": "state" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the subnet association with the transit gateway multicast domain.

" + } + }, + "com.amazonaws.ec2#SubnetAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SubnetAssociation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SubnetCidrAssociationId": { + "type": "string" + }, + "com.amazonaws.ec2#SubnetCidrBlockState": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.ec2#SubnetCidrBlockStateCode", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of a CIDR block.

", + "smithy.api#xmlName": "state" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

A message about the status of the CIDR block, if applicable.

", + "smithy.api#xmlName": "statusMessage" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the state of a CIDR block.

" + } + }, + "com.amazonaws.ec2#SubnetCidrBlockStateCode": { + "type": "enum", + "members": { + "associating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associating" + } + }, + "associated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associated" + } + }, + "disassociating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociating" + } + }, + "disassociated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociated" + } + }, + "failing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failing" + } + }, + "failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + } + } + }, + "com.amazonaws.ec2#SubnetCidrReservation": { + "type": "structure", + "members": { + "SubnetCidrReservationId": { + "target": "com.amazonaws.ec2#SubnetCidrReservationId", + "traits": { + "aws.protocols#ec2QueryName": "SubnetCidrReservationId", + "smithy.api#documentation": "

The ID of the subnet CIDR reservation.

", + "smithy.api#xmlName": "subnetCidrReservationId" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet.

", + "smithy.api#xmlName": "subnetId" + } + }, + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Cidr", + "smithy.api#documentation": "

The CIDR that has been reserved.

", + "smithy.api#xmlName": "cidr" + } + }, + "ReservationType": { + "target": "com.amazonaws.ec2#SubnetCidrReservationType", + "traits": { + "aws.protocols#ec2QueryName": "ReservationType", + "smithy.api#documentation": "

The type of reservation.

", + "smithy.api#xmlName": "reservationType" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the account that owns the subnet CIDR reservation.

", + "smithy.api#xmlName": "ownerId" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description assigned to the subnet CIDR reservation.

", + "smithy.api#xmlName": "description" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the subnet CIDR reservation.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a subnet CIDR reservation.

" + } + }, + "com.amazonaws.ec2#SubnetCidrReservationId": { + "type": "string" + }, + "com.amazonaws.ec2#SubnetCidrReservationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SubnetCidrReservation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SubnetCidrReservationType": { + "type": "enum", + "members": { + "prefix": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "prefix" + } + }, + "explicit": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "explicit" + } + } + } + }, + "com.amazonaws.ec2#SubnetConfiguration": { + "type": "structure", + "members": { + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "smithy.api#documentation": "

The ID of the subnet.

" + } + }, + "Ipv4": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IPv4 address to assign to the endpoint network interface in the subnet. You must provide \n an IPv4 address if the VPC endpoint supports IPv4.

\n

If you specify an IPv4 address when modifying a VPC endpoint, we replace the existing \n endpoint network interface with a new endpoint network interface with this IP address. \n This process temporarily disconnects the subnet and the VPC endpoint.

" + } + }, + "Ipv6": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IPv6 address to assign to the endpoint network interface in the subnet. You must provide \n an IPv6 address if the VPC endpoint supports IPv6.

\n

If you specify an IPv6 address when modifying a VPC endpoint, we replace the existing \n endpoint network interface with a new endpoint network interface with this IP address. \n This process temporarily disconnects the subnet and the VPC endpoint.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the configuration of a subnet for a VPC endpoint.

" + } + }, + "com.amazonaws.ec2#SubnetConfigurationsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SubnetConfiguration", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SubnetId": { + "type": "string" + }, + "com.amazonaws.ec2#SubnetIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "smithy.api#xmlName": "SubnetId" + } + } + }, + "com.amazonaws.ec2#SubnetIpPrefixes": { + "type": "structure", + "members": { + "SubnetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

ID of the subnet.

", + "smithy.api#xmlName": "subnetId" + } + }, + "IpPrefixes": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "IpPrefixSet", + "smithy.api#documentation": "

Array of SubnetIpPrefixes objects.

", + "smithy.api#xmlName": "ipPrefixSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Prefixes of the subnet IP.

" + } + }, + "com.amazonaws.ec2#SubnetIpPrefixesList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SubnetIpPrefixes", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SubnetIpv6CidrBlockAssociation": { + "type": "structure", + "members": { + "AssociationId": { + "target": "com.amazonaws.ec2#SubnetCidrAssociationId", + "traits": { + "aws.protocols#ec2QueryName": "AssociationId", + "smithy.api#documentation": "

The ID of the association.

", + "smithy.api#xmlName": "associationId" + } + }, + "Ipv6CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6CidrBlock", + "smithy.api#documentation": "

The IPv6 CIDR block.

", + "smithy.api#xmlName": "ipv6CidrBlock" + } + }, + "Ipv6CidrBlockState": { + "target": "com.amazonaws.ec2#SubnetCidrBlockState", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6CidrBlockState", + "smithy.api#documentation": "

The state of the CIDR block.

", + "smithy.api#xmlName": "ipv6CidrBlockState" + } + }, + "Ipv6AddressAttribute": { + "target": "com.amazonaws.ec2#Ipv6AddressAttribute", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6AddressAttribute", + "smithy.api#documentation": "

Public IPv6 addresses are those advertised on the internet from Amazon Web Services. Private IP addresses are not and cannot be advertised on the internet from Amazon Web Services.

", + "smithy.api#xmlName": "ipv6AddressAttribute" + } + }, + "IpSource": { + "target": "com.amazonaws.ec2#IpSource", + "traits": { + "aws.protocols#ec2QueryName": "IpSource", + "smithy.api#documentation": "

The source that allocated the IP address space. byoip or amazon indicates public IP address space allocated by Amazon or space that you have allocated with Bring your own IP (BYOIP). none indicates private space.

", + "smithy.api#xmlName": "ipSource" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an association between a subnet and an IPv6 CIDR block.

" + } + }, + "com.amazonaws.ec2#SubnetIpv6CidrBlockAssociationSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SubnetIpv6CidrBlockAssociation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SubnetList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Subnet", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SubnetState": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "unavailable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unavailable" + } + } + } + }, + "com.amazonaws.ec2#Subscription": { + "type": "structure", + "members": { + "Source": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Source", + "smithy.api#documentation": "

The Region or Availability Zone that's the source for the subscription. For example, us-east-1.

", + "smithy.api#xmlName": "source" + } + }, + "Destination": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Destination", + "smithy.api#documentation": "

The Region or Availability Zone that's the target for the subscription. For example, eu-west-1.

", + "smithy.api#xmlName": "destination" + } + }, + "Metric": { + "target": "com.amazonaws.ec2#MetricType", + "traits": { + "aws.protocols#ec2QueryName": "Metric", + "smithy.api#documentation": "

The metric used for the subscription.

", + "smithy.api#xmlName": "metric" + } + }, + "Statistic": { + "target": "com.amazonaws.ec2#StatisticType", + "traits": { + "aws.protocols#ec2QueryName": "Statistic", + "smithy.api#documentation": "

The statistic used for the subscription.

", + "smithy.api#xmlName": "statistic" + } + }, + "Period": { + "target": "com.amazonaws.ec2#PeriodType", + "traits": { + "aws.protocols#ec2QueryName": "Period", + "smithy.api#documentation": "

The data aggregation time for the subscription.

", + "smithy.api#xmlName": "period" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an Infrastructure Performance subscription.

" + } + }, + "com.amazonaws.ec2#SubscriptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Subscription", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SuccessfulInstanceCreditSpecificationItem": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#xmlName": "instanceId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the burstable performance instance whose credit option for CPU usage was\n successfully modified.

" + } + }, + "com.amazonaws.ec2#SuccessfulInstanceCreditSpecificationSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SuccessfulInstanceCreditSpecificationItem", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SuccessfulQueuedPurchaseDeletion": { + "type": "structure", + "members": { + "ReservedInstancesId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstancesId", + "smithy.api#documentation": "

The ID of the Reserved Instance.

", + "smithy.api#xmlName": "reservedInstancesId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Reserved Instance whose queued purchase was successfully deleted.

" + } + }, + "com.amazonaws.ec2#SuccessfulQueuedPurchaseDeletionSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SuccessfulQueuedPurchaseDeletion", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SummaryStatus": { + "type": "enum", + "members": { + "ok": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ok" + } + }, + "impaired": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "impaired" + } + }, + "insufficient_data": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "insufficient-data" + } + }, + "not_applicable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "not-applicable" + } + }, + "initializing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "initializing" + } + } + } + }, + "com.amazonaws.ec2#SupportedAdditionalProcessorFeature": { + "type": "enum", + "members": { + "AMD_SEV_SNP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "amd-sev-snp" + } + } + } + }, + "com.amazonaws.ec2#SupportedAdditionalProcessorFeatureList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SupportedAdditionalProcessorFeature", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SupportedIpAddressTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ServiceConnectivityType", + "traits": { + "smithy.api#xmlName": "item" + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2 + } + } + }, + "com.amazonaws.ec2#SupportedRegionDetail": { + "type": "structure", + "members": { + "Region": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Region", + "smithy.api#documentation": "

The Region code.

", + "smithy.api#xmlName": "region" + } + }, + "ServiceState": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ServiceState", + "smithy.api#documentation": "

The service state. The possible values are Pending, Available, \n Deleting, Deleted, Failed, and Closed.

", + "smithy.api#xmlName": "serviceState" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a supported Region.

" + } + }, + "com.amazonaws.ec2#SupportedRegionSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SupportedRegionDetail", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Key", + "smithy.api#documentation": "

The key of the tag.

\n

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. \n May not begin with aws:.

", + "smithy.api#xmlName": "key" + } + }, + "Value": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Value", + "smithy.api#documentation": "

The value of the tag.

\n

Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

", + "smithy.api#xmlName": "value" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a tag.

" + } + }, + "com.amazonaws.ec2#TagDescription": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Key", + "smithy.api#documentation": "

The tag key.

", + "smithy.api#xmlName": "key" + } + }, + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The ID of the resource.

", + "smithy.api#xmlName": "resourceId" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#ResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The resource type.

", + "smithy.api#xmlName": "resourceType" + } + }, + "Value": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Value", + "smithy.api#documentation": "

The tag value.

", + "smithy.api#xmlName": "value" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a tag.

" + } + }, + "com.amazonaws.ec2#TagDescriptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TagDescription", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Tag", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TagSpecification": { + "type": "structure", + "members": { + "ResourceType": { + "target": "com.amazonaws.ec2#ResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The type of resource to tag on creation.

", + "smithy.api#xmlName": "resourceType" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the resource.

", + "smithy.api#xmlName": "Tag" + } + } + }, + "traits": { + "smithy.api#documentation": "

The tags to apply to a resource when the resource is being created. When you specify a tag, you must \n specify the resource type to tag, otherwise the request will fail.

\n \n

The Valid Values lists all the resource types that can be tagged.\n However, the action you're using might not support tagging all of these resource types.\n If you try to tag a resource type that is unsupported for the action you're using,\n you'll get an error.

\n " + } + }, + "com.amazonaws.ec2#TagSpecificationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TagSpecification", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TaggableResourceId": { + "type": "string" + }, + "com.amazonaws.ec2#TargetCapacitySpecification": { + "type": "structure", + "members": { + "TotalTargetCapacity": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TotalTargetCapacity", + "smithy.api#documentation": "

The number of units to request, filled the default target capacity type.

", + "smithy.api#xmlName": "totalTargetCapacity" + } + }, + "OnDemandTargetCapacity": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "OnDemandTargetCapacity", + "smithy.api#documentation": "

The number of On-Demand units to request. If you specify a target capacity for Spot units, you cannot specify a target capacity for On-Demand units.

", + "smithy.api#xmlName": "onDemandTargetCapacity" + } + }, + "SpotTargetCapacity": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "SpotTargetCapacity", + "smithy.api#documentation": "

The maximum number of Spot units to launch. If you specify a target capacity for On-Demand units, you cannot specify a target capacity for Spot units.

", + "smithy.api#xmlName": "spotTargetCapacity" + } + }, + "DefaultTargetCapacityType": { + "target": "com.amazonaws.ec2#DefaultTargetCapacityType", + "traits": { + "aws.protocols#ec2QueryName": "DefaultTargetCapacityType", + "smithy.api#documentation": "

The default target capacity type.

", + "smithy.api#xmlName": "defaultTargetCapacityType" + } + }, + "TargetCapacityUnitType": { + "target": "com.amazonaws.ec2#TargetCapacityUnitType", + "traits": { + "aws.protocols#ec2QueryName": "TargetCapacityUnitType", + "smithy.api#documentation": "

The unit for the target capacity.

", + "smithy.api#xmlName": "targetCapacityUnitType" + } + } + }, + "traits": { + "smithy.api#documentation": "

The number of units to request. You can choose to set the target capacity in terms of\n instances or a performance characteristic that is important to your application workload,\n such as vCPUs, memory, or I/O. If the request type is maintain, you can\n specify a target capacity of 0 and add capacity later.

\n

You can use the On-Demand Instance MaxTotalPrice parameter, the Spot Instance\n MaxTotalPrice, or both to ensure that your fleet cost does not exceed your\n budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, EC2 Fleet\n will launch instances until it reaches the maximum amount that you're willing to pay. When\n the maximum amount you're willing to pay is reached, the fleet stops launching instances\n even if it hasn’t met the target capacity. The MaxTotalPrice parameters are\n located in OnDemandOptions \n and SpotOptions.

" + } + }, + "com.amazonaws.ec2#TargetCapacitySpecificationRequest": { + "type": "structure", + "members": { + "TotalTargetCapacity": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of units to request, filled using the default target capacity type.

", + "smithy.api#required": {} + } + }, + "OnDemandTargetCapacity": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The number of On-Demand units to request.

" + } + }, + "SpotTargetCapacity": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The number of Spot units to request.

" + } + }, + "DefaultTargetCapacityType": { + "target": "com.amazonaws.ec2#DefaultTargetCapacityType", + "traits": { + "smithy.api#documentation": "

The default target capacity type.

" + } + }, + "TargetCapacityUnitType": { + "target": "com.amazonaws.ec2#TargetCapacityUnitType", + "traits": { + "smithy.api#documentation": "

The unit for the target capacity. You can specify this parameter only when using\n attributed-based instance type selection.

\n

Default: units (the number of instances)

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The number of units to request. You can choose to set the target capacity as the number of \n instances. Or you can set the target capacity to a performance characteristic that is important to your application workload,\n such as vCPUs, memory, or I/O. If the request type is maintain, you can\n specify a target capacity of 0 and add capacity later.

\n

You can use the On-Demand Instance MaxTotalPrice parameter, the Spot Instance\n MaxTotalPrice parameter, or both parameters to ensure that your fleet cost\n does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances\n in your request, EC2 Fleet will launch instances until it reaches the maximum amount that you're\n willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops\n launching instances even if it hasn't met the target capacity. The\n MaxTotalPrice parameters are located in OnDemandOptionsRequest \n and SpotOptionsRequest.

" + } + }, + "com.amazonaws.ec2#TargetCapacityUnitType": { + "type": "enum", + "members": { + "VCPU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vcpu" + } + }, + "MEMORY_MIB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "memory-mib" + } + }, + "UNITS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "units" + } + } + } + }, + "com.amazonaws.ec2#TargetConfiguration": { + "type": "structure", + "members": { + "InstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "InstanceCount", + "smithy.api#documentation": "

The number of instances the Convertible Reserved Instance offering can be applied to. This parameter is \n reserved and cannot be specified in a request

", + "smithy.api#xmlName": "instanceCount" + } + }, + "OfferingId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OfferingId", + "smithy.api#documentation": "

The ID of the Convertible Reserved Instance offering.

", + "smithy.api#xmlName": "offeringId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the Convertible Reserved Instance offering.

" + } + }, + "com.amazonaws.ec2#TargetConfigurationRequest": { + "type": "structure", + "members": { + "InstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The number of instances the Convertible Reserved Instance offering can be applied to. This parameter is reserved and cannot \n be specified in a request

" + } + }, + "OfferingId": { + "target": "com.amazonaws.ec2#ReservedInstancesOfferingId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Convertible Reserved Instance offering ID.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the target configuration.

" + } + }, + "com.amazonaws.ec2#TargetConfigurationRequestSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TargetConfigurationRequest", + "traits": { + "smithy.api#xmlName": "TargetConfigurationRequest" + } + } + }, + "com.amazonaws.ec2#TargetGroup": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Arn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the target group.

", + "smithy.api#xmlName": "arn" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a load balancer target group.

" + } + }, + "com.amazonaws.ec2#TargetGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TargetGroup", + "traits": { + "smithy.api#xmlName": "item" + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.ec2#TargetGroupsConfig": { + "type": "structure", + "members": { + "TargetGroups": { + "target": "com.amazonaws.ec2#TargetGroups", + "traits": { + "aws.protocols#ec2QueryName": "TargetGroups", + "smithy.api#documentation": "

One or more target groups.

", + "smithy.api#xmlName": "targetGroups" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the target groups to attach to a Spot Fleet. Spot Fleet registers the\n running Spot Instances with these target groups.

" + } + }, + "com.amazonaws.ec2#TargetNetwork": { + "type": "structure", + "members": { + "AssociationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AssociationId", + "smithy.api#documentation": "

The ID of the association.

", + "smithy.api#xmlName": "associationId" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC in which the target network (subnet) is located.

", + "smithy.api#xmlName": "vpcId" + } + }, + "TargetNetworkId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TargetNetworkId", + "smithy.api#documentation": "

The ID of the subnet specified as the target network.

", + "smithy.api#xmlName": "targetNetworkId" + } + }, + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientVpnEndpointId", + "smithy.api#documentation": "

The ID of the Client VPN endpoint with which the target network is associated.

", + "smithy.api#xmlName": "clientVpnEndpointId" + } + }, + "Status": { + "target": "com.amazonaws.ec2#AssociationStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The current state of the target network association.

", + "smithy.api#xmlName": "status" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroups", + "smithy.api#documentation": "

The IDs of the security groups applied to the target network association.

", + "smithy.api#xmlName": "securityGroups" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a target network associated with a Client VPN endpoint.

" + } + }, + "com.amazonaws.ec2#TargetNetworkSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TargetNetwork", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TargetReservationValue": { + "type": "structure", + "members": { + "ReservationValue": { + "target": "com.amazonaws.ec2#ReservationValue", + "traits": { + "aws.protocols#ec2QueryName": "ReservationValue", + "smithy.api#documentation": "

The total value of the Convertible Reserved Instances that make up the exchange. This is the sum of\n the list value, remaining upfront price, and additional upfront cost of the exchange.

", + "smithy.api#xmlName": "reservationValue" + } + }, + "TargetConfiguration": { + "target": "com.amazonaws.ec2#TargetConfiguration", + "traits": { + "aws.protocols#ec2QueryName": "TargetConfiguration", + "smithy.api#documentation": "

The configuration of the Convertible Reserved Instances that make up the exchange.

", + "smithy.api#xmlName": "targetConfiguration" + } + } + }, + "traits": { + "smithy.api#documentation": "

The total value of the new Convertible Reserved Instances.

" + } + }, + "com.amazonaws.ec2#TargetReservationValueSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TargetReservationValue", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TargetStorageTier": { + "type": "enum", + "members": { + "archive": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "archive" + } + } + } + }, + "com.amazonaws.ec2#TelemetryStatus": { + "type": "enum", + "members": { + "UP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UP" + } + }, + "DOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOWN" + } + } + } + }, + "com.amazonaws.ec2#Tenancy": { + "type": "enum", + "members": { + "default": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "default" + } + }, + "dedicated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dedicated" + } + }, + "host": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "host" + } + } + } + }, + "com.amazonaws.ec2#TerminateClientVpnConnections": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#TerminateClientVpnConnectionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#TerminateClientVpnConnectionsResult" + }, + "traits": { + "smithy.api#documentation": "

Terminates active Client VPN endpoint connections. This action can be used to terminate a specific client connection, or up to five connections established by a specific user.

" + } + }, + "com.amazonaws.ec2#TerminateClientVpnConnectionsRequest": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#ClientVpnEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Client VPN endpoint to which the client is connected.

", + "smithy.api#required": {} + } + }, + "ConnectionId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ID of the client connection to be terminated.

" + } + }, + "Username": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the user who initiated the connection. Use this option to terminate all active connections for \n\t\t\tthe specified user. This option can only be used if the user has established up to five connections.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#TerminateClientVpnConnectionsResult": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientVpnEndpointId", + "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", + "smithy.api#xmlName": "clientVpnEndpointId" + } + }, + "Username": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Username", + "smithy.api#documentation": "

The user who established the terminated client connections.

", + "smithy.api#xmlName": "username" + } + }, + "ConnectionStatuses": { + "target": "com.amazonaws.ec2#TerminateConnectionStatusSet", + "traits": { + "aws.protocols#ec2QueryName": "ConnectionStatuses", + "smithy.api#documentation": "

The current state of the client connections.

", + "smithy.api#xmlName": "connectionStatuses" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#TerminateConnectionStatus": { + "type": "structure", + "members": { + "ConnectionId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ConnectionId", + "smithy.api#documentation": "

The ID of the client connection.

", + "smithy.api#xmlName": "connectionId" + } + }, + "PreviousStatus": { + "target": "com.amazonaws.ec2#ClientVpnConnectionStatus", + "traits": { + "aws.protocols#ec2QueryName": "PreviousStatus", + "smithy.api#documentation": "

The state of the client connection.

", + "smithy.api#xmlName": "previousStatus" + } + }, + "CurrentStatus": { + "target": "com.amazonaws.ec2#ClientVpnConnectionStatus", + "traits": { + "aws.protocols#ec2QueryName": "CurrentStatus", + "smithy.api#documentation": "

A message about the status of the client connection, if applicable.

", + "smithy.api#xmlName": "currentStatus" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a terminated Client VPN endpoint client connection.

" + } + }, + "com.amazonaws.ec2#TerminateConnectionStatusSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TerminateConnectionStatus", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TerminateInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#TerminateInstancesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#TerminateInstancesResult" + }, + "traits": { + "smithy.api#documentation": "

Shuts down the specified instances. This operation is idempotent; if you terminate an\n instance more than once, each call succeeds.

\n

If you specify multiple instances and the request fails (for example, because of a\n single incorrect instance ID), none of the instances are terminated.

\n

If you terminate multiple instances across multiple Availability Zones, and one or\n more of the specified instances are enabled for termination protection, the request\n fails with the following results:

\n \n

For example, say you have the following instances:

\n \n

If you attempt to terminate all of these instances in the same request, the request\n reports failure with the following results:

\n \n

Terminated instances remain visible after termination (for approximately one\n hour).

\n

By default, Amazon EC2 deletes all EBS volumes that were attached when the instance\n launched. Volumes attached after instance launch continue running.

\n

You can stop, start, and terminate EBS-backed instances. You can only terminate\n instance store-backed instances. What happens to an instance differs if you stop it or\n terminate it. For example, when you stop an instance, the root device and any other\n devices attached to the instance persist. When you terminate an instance, any attached\n EBS volumes with the DeleteOnTermination block device mapping parameter set\n to true are automatically deleted. For more information about the\n differences between stopping and terminating instances, see Instance lifecycle\n in the Amazon EC2 User Guide.

\n

For more information about troubleshooting, see Troubleshooting terminating your instance in the\n Amazon EC2 User Guide.

", + "smithy.api#examples": [ + { + "title": "To terminate an EC2 instance", + "documentation": "This example terminates the specified EC2 instance.", + "input": { + "InstanceIds": [ + "i-1234567890abcdef0" + ] + }, + "output": { + "TerminatingInstances": [ + { + "InstanceId": "i-1234567890abcdef0", + "CurrentState": { + "Code": 32, + "Name": "shutting-down" + }, + "PreviousState": { + "Code": 16, + "Name": "running" + } + } + ] + } + } + ] + } + }, + "com.amazonaws.ec2#TerminateInstancesRequest": { + "type": "structure", + "members": { + "InstanceIds": { + "target": "com.amazonaws.ec2#InstanceIdStringList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the instances.

\n

Constraints: Up to 1000 instance IDs. We recommend breaking up this request into\n smaller batches.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "InstanceId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#TerminateInstancesResult": { + "type": "structure", + "members": { + "TerminatingInstances": { + "target": "com.amazonaws.ec2#InstanceStateChangeList", + "traits": { + "aws.protocols#ec2QueryName": "InstancesSet", + "smithy.api#documentation": "

Information about the terminated instances.

", + "smithy.api#xmlName": "instancesSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ThreadsPerCore": { + "type": "integer" + }, + "com.amazonaws.ec2#ThreadsPerCoreList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ThreadsPerCore", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ThroughResourcesStatement": { + "type": "structure", + "members": { + "ResourceStatement": { + "target": "com.amazonaws.ec2#ResourceStatement", + "traits": { + "aws.protocols#ec2QueryName": "ResourceStatement", + "smithy.api#documentation": "

The resource statement.

", + "smithy.api#xmlName": "resourceStatement" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a through resource statement.

" + } + }, + "com.amazonaws.ec2#ThroughResourcesStatementList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ThroughResourcesStatement", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ThroughResourcesStatementRequest": { + "type": "structure", + "members": { + "ResourceStatement": { + "target": "com.amazonaws.ec2#ResourceStatementRequest", + "traits": { + "smithy.api#documentation": "

The resource statement.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a through resource statement.

" + } + }, + "com.amazonaws.ec2#ThroughResourcesStatementRequestList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ThroughResourcesStatementRequest", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TieringOperationStatus": { + "type": "enum", + "members": { + "archival_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "archival-in-progress" + } + }, + "archival_completed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "archival-completed" + } + }, + "archival_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "archival-failed" + } + }, + "temporary_restore_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "temporary-restore-in-progress" + } + }, + "temporary_restore_completed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "temporary-restore-completed" + } + }, + "temporary_restore_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "temporary-restore-failed" + } + }, + "permanent_restore_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "permanent-restore-in-progress" + } + }, + "permanent_restore_completed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "permanent-restore-completed" + } + }, + "permanent_restore_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "permanent-restore-failed" + } + } + } + }, + "com.amazonaws.ec2#TokenState": { + "type": "enum", + "members": { + "valid": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "valid" + } + }, + "expired": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "expired" + } + } + } + }, + "com.amazonaws.ec2#TotalLocalStorageGB": { + "type": "structure", + "members": { + "Min": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "Min", + "smithy.api#documentation": "

The minimum amount of total local storage, in GB. If this parameter is not specified, there is\n no minimum limit.

", + "smithy.api#xmlName": "min" + } + }, + "Max": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "Max", + "smithy.api#documentation": "

The maximum amount of total local storage, in GB. If this parameter is not specified, there is\n no maximum limit.

", + "smithy.api#xmlName": "max" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum and maximum amount of total local storage, in GB.

" + } + }, + "com.amazonaws.ec2#TotalLocalStorageGBRequest": { + "type": "structure", + "members": { + "Min": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "smithy.api#documentation": "

The minimum amount of total local storage, in GB. To specify no minimum limit, omit this\n parameter.

" + } + }, + "Max": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "smithy.api#documentation": "

The maximum amount of total local storage, in GB. To specify no maximum limit, omit this\n parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum and maximum amount of total local storage, in GB.

" + } + }, + "com.amazonaws.ec2#TotalMediaMemory": { + "type": "integer" + }, + "com.amazonaws.ec2#TotalNeuronMemory": { + "type": "integer" + }, + "com.amazonaws.ec2#TpmSupportValues": { + "type": "enum", + "members": { + "v2_0": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "v2.0" + } + } + } + }, + "com.amazonaws.ec2#TrafficDirection": { + "type": "enum", + "members": { + "ingress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ingress" + } + }, + "egress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "egress" + } + } + } + }, + "com.amazonaws.ec2#TrafficMirrorFilter": { + "type": "structure", + "members": { + "TrafficMirrorFilterId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TrafficMirrorFilterId", + "smithy.api#documentation": "

The ID of the Traffic Mirror filter.

", + "smithy.api#xmlName": "trafficMirrorFilterId" + } + }, + "IngressFilterRules": { + "target": "com.amazonaws.ec2#TrafficMirrorFilterRuleList", + "traits": { + "aws.protocols#ec2QueryName": "IngressFilterRuleSet", + "smithy.api#documentation": "

Information about the ingress rules that are associated with the Traffic Mirror filter.

", + "smithy.api#xmlName": "ingressFilterRuleSet" + } + }, + "EgressFilterRules": { + "target": "com.amazonaws.ec2#TrafficMirrorFilterRuleList", + "traits": { + "aws.protocols#ec2QueryName": "EgressFilterRuleSet", + "smithy.api#documentation": "

Information about the egress rules that are associated with the Traffic Mirror filter.

", + "smithy.api#xmlName": "egressFilterRuleSet" + } + }, + "NetworkServices": { + "target": "com.amazonaws.ec2#TrafficMirrorNetworkServiceList", + "traits": { + "aws.protocols#ec2QueryName": "NetworkServiceSet", + "smithy.api#documentation": "

The network service traffic that is associated with the Traffic Mirror filter.

", + "smithy.api#xmlName": "networkServiceSet" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description of the Traffic Mirror filter.

", + "smithy.api#xmlName": "description" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the Traffic Mirror filter.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the Traffic Mirror filter.

" + } + }, + "com.amazonaws.ec2#TrafficMirrorFilterId": { + "type": "string" + }, + "com.amazonaws.ec2#TrafficMirrorFilterIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TrafficMirrorFilterId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TrafficMirrorFilterRule": { + "type": "structure", + "members": { + "TrafficMirrorFilterRuleId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TrafficMirrorFilterRuleId", + "smithy.api#documentation": "

The ID of the Traffic Mirror rule.

", + "smithy.api#xmlName": "trafficMirrorFilterRuleId" + } + }, + "TrafficMirrorFilterId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TrafficMirrorFilterId", + "smithy.api#documentation": "

The ID of the Traffic Mirror filter that the rule is associated with.

", + "smithy.api#xmlName": "trafficMirrorFilterId" + } + }, + "TrafficDirection": { + "target": "com.amazonaws.ec2#TrafficDirection", + "traits": { + "aws.protocols#ec2QueryName": "TrafficDirection", + "smithy.api#documentation": "

The traffic direction assigned to the Traffic Mirror rule.

", + "smithy.api#xmlName": "trafficDirection" + } + }, + "RuleNumber": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "RuleNumber", + "smithy.api#documentation": "

The rule number of the Traffic Mirror rule.

", + "smithy.api#xmlName": "ruleNumber" + } + }, + "RuleAction": { + "target": "com.amazonaws.ec2#TrafficMirrorRuleAction", + "traits": { + "aws.protocols#ec2QueryName": "RuleAction", + "smithy.api#documentation": "

The action assigned to the Traffic Mirror rule.

", + "smithy.api#xmlName": "ruleAction" + } + }, + "Protocol": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Protocol", + "smithy.api#documentation": "

The protocol assigned to the Traffic Mirror rule.

", + "smithy.api#xmlName": "protocol" + } + }, + "DestinationPortRange": { + "target": "com.amazonaws.ec2#TrafficMirrorPortRange", + "traits": { + "aws.protocols#ec2QueryName": "DestinationPortRange", + "smithy.api#documentation": "

The destination port range assigned to the Traffic Mirror rule.

", + "smithy.api#xmlName": "destinationPortRange" + } + }, + "SourcePortRange": { + "target": "com.amazonaws.ec2#TrafficMirrorPortRange", + "traits": { + "aws.protocols#ec2QueryName": "SourcePortRange", + "smithy.api#documentation": "

The source port range assigned to the Traffic Mirror rule.

", + "smithy.api#xmlName": "sourcePortRange" + } + }, + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationCidrBlock", + "smithy.api#documentation": "

The destination CIDR block assigned to the Traffic Mirror rule.

", + "smithy.api#xmlName": "destinationCidrBlock" + } + }, + "SourceCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SourceCidrBlock", + "smithy.api#documentation": "

The source CIDR block assigned to the Traffic Mirror rule.

", + "smithy.api#xmlName": "sourceCidrBlock" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description of the Traffic Mirror rule.

", + "smithy.api#xmlName": "description" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Tags on Traffic Mirroring filter rules.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the Traffic Mirror rule.

" + } + }, + "com.amazonaws.ec2#TrafficMirrorFilterRuleField": { + "type": "enum", + "members": { + "destination_port_range": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "destination-port-range" + } + }, + "source_port_range": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "source-port-range" + } + }, + "protocol": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "protocol" + } + }, + "description": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "description" + } + } + } + }, + "com.amazonaws.ec2#TrafficMirrorFilterRuleFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TrafficMirrorFilterRuleField" + } + }, + "com.amazonaws.ec2#TrafficMirrorFilterRuleIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TrafficMirrorFilterRuleIdWithResolver", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TrafficMirrorFilterRuleIdWithResolver": { + "type": "string" + }, + "com.amazonaws.ec2#TrafficMirrorFilterRuleList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TrafficMirrorFilterRule", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TrafficMirrorFilterRuleSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TrafficMirrorFilterRule", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TrafficMirrorFilterSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TrafficMirrorFilter", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TrafficMirrorNetworkService": { + "type": "enum", + "members": { + "amazon_dns": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "amazon-dns" + } + } + } + }, + "com.amazonaws.ec2#TrafficMirrorNetworkServiceList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TrafficMirrorNetworkService", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TrafficMirrorPortRange": { + "type": "structure", + "members": { + "FromPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "FromPort", + "smithy.api#documentation": "

The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols.

", + "smithy.api#xmlName": "fromPort" + } + }, + "ToPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "ToPort", + "smithy.api#documentation": "

The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols.

", + "smithy.api#xmlName": "toPort" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the Traffic Mirror port range.

" + } + }, + "com.amazonaws.ec2#TrafficMirrorPortRangeRequest": { + "type": "structure", + "members": { + "FromPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The first port in the Traffic Mirror port range. This applies to the TCP and UDP protocols.

" + } + }, + "ToPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The last port in the Traffic Mirror port range. This applies to the TCP and UDP protocols.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the Traffic Mirror filter rule port range.

" + } + }, + "com.amazonaws.ec2#TrafficMirrorRuleAction": { + "type": "enum", + "members": { + "accept": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "accept" + } + }, + "reject": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "reject" + } + } + } + }, + "com.amazonaws.ec2#TrafficMirrorSession": { + "type": "structure", + "members": { + "TrafficMirrorSessionId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TrafficMirrorSessionId", + "smithy.api#documentation": "

The ID for the Traffic Mirror session.

", + "smithy.api#xmlName": "trafficMirrorSessionId" + } + }, + "TrafficMirrorTargetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TrafficMirrorTargetId", + "smithy.api#documentation": "

The ID of the Traffic Mirror target.

", + "smithy.api#xmlName": "trafficMirrorTargetId" + } + }, + "TrafficMirrorFilterId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TrafficMirrorFilterId", + "smithy.api#documentation": "

The ID of the Traffic Mirror filter.

", + "smithy.api#xmlName": "trafficMirrorFilterId" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of the Traffic Mirror session's network interface.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the account that owns the Traffic Mirror session.

", + "smithy.api#xmlName": "ownerId" + } + }, + "PacketLength": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "PacketLength", + "smithy.api#documentation": "

The number of bytes in each packet to mirror. These are the bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. Do not specify this parameter when you want to mirror the entire packet

", + "smithy.api#xmlName": "packetLength" + } + }, + "SessionNumber": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "SessionNumber", + "smithy.api#documentation": "

The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.

\n

Valid values are 1-32766.

", + "smithy.api#xmlName": "sessionNumber" + } + }, + "VirtualNetworkId": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "VirtualNetworkId", + "smithy.api#documentation": "

The virtual network ID associated with the Traffic Mirror session.

", + "smithy.api#xmlName": "virtualNetworkId" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description of the Traffic Mirror session.

", + "smithy.api#xmlName": "description" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the Traffic Mirror session.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Traffic Mirror session.

" + } + }, + "com.amazonaws.ec2#TrafficMirrorSessionField": { + "type": "enum", + "members": { + "packet_length": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "packet-length" + } + }, + "description": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "description" + } + }, + "virtual_network_id": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "virtual-network-id" + } + } + } + }, + "com.amazonaws.ec2#TrafficMirrorSessionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TrafficMirrorSessionField" + } + }, + "com.amazonaws.ec2#TrafficMirrorSessionId": { + "type": "string" + }, + "com.amazonaws.ec2#TrafficMirrorSessionIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TrafficMirrorSessionId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TrafficMirrorSessionSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TrafficMirrorSession", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TrafficMirrorTarget": { + "type": "structure", + "members": { + "TrafficMirrorTargetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TrafficMirrorTargetId", + "smithy.api#documentation": "

The ID of the Traffic Mirror target.

", + "smithy.api#xmlName": "trafficMirrorTargetId" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The network interface ID that is attached to the target.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "NetworkLoadBalancerArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkLoadBalancerArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Network Load Balancer.

", + "smithy.api#xmlName": "networkLoadBalancerArn" + } + }, + "Type": { + "target": "com.amazonaws.ec2#TrafficMirrorTargetType", + "traits": { + "aws.protocols#ec2QueryName": "Type", + "smithy.api#documentation": "

The type of Traffic Mirror target.

", + "smithy.api#xmlName": "type" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

Information about the Traffic Mirror target.

", + "smithy.api#xmlName": "description" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the account that owns the Traffic Mirror target.

", + "smithy.api#xmlName": "ownerId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the Traffic Mirror target.

", + "smithy.api#xmlName": "tagSet" + } + }, + "GatewayLoadBalancerEndpointId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GatewayLoadBalancerEndpointId", + "smithy.api#documentation": "

The ID of the Gateway Load Balancer endpoint.

", + "smithy.api#xmlName": "gatewayLoadBalancerEndpointId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Traffic Mirror target.

" + } + }, + "com.amazonaws.ec2#TrafficMirrorTargetId": { + "type": "string" + }, + "com.amazonaws.ec2#TrafficMirrorTargetIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TrafficMirrorTargetId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TrafficMirrorTargetSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TrafficMirrorTarget", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TrafficMirrorTargetType": { + "type": "enum", + "members": { + "network_interface": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "network-interface" + } + }, + "network_load_balancer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "network-load-balancer" + } + }, + "gateway_load_balancer_endpoint": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "gateway-load-balancer-endpoint" + } + } + } + }, + "com.amazonaws.ec2#TrafficMirroringMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#TrafficType": { + "type": "enum", + "members": { + "ACCEPT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCEPT" + } + }, + "REJECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REJECT" + } + }, + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + } + } + }, + "com.amazonaws.ec2#TransferType": { + "type": "enum", + "members": { + "time_based": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "time-based" + } + }, + "standard": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "standard" + } + } + } + }, + "com.amazonaws.ec2#TransitAssociationGatewayId": { + "type": "string" + }, + "com.amazonaws.ec2#TransitGateway": { + "type": "structure", + "members": { + "TransitGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayId", + "smithy.api#documentation": "

The ID of the transit gateway.

", + "smithy.api#xmlName": "transitGatewayId" + } + }, + "TransitGatewayArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the transit gateway.

", + "smithy.api#xmlName": "transitGatewayArn" + } + }, + "State": { + "target": "com.amazonaws.ec2#TransitGatewayState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the transit gateway.

", + "smithy.api#xmlName": "state" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the transit gateway.

", + "smithy.api#xmlName": "ownerId" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description of the transit gateway.

", + "smithy.api#xmlName": "description" + } + }, + "CreationTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreationTime", + "smithy.api#documentation": "

The creation time.

", + "smithy.api#xmlName": "creationTime" + } + }, + "Options": { + "target": "com.amazonaws.ec2#TransitGatewayOptions", + "traits": { + "aws.protocols#ec2QueryName": "Options", + "smithy.api#documentation": "

The transit gateway options.

", + "smithy.api#xmlName": "options" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags for the transit gateway.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a transit gateway.

" + } + }, + "com.amazonaws.ec2#TransitGatewayAssociation": { + "type": "structure", + "members": { + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTableId", + "smithy.api#documentation": "

The ID of the transit gateway route table.

", + "smithy.api#xmlName": "transitGatewayRouteTableId" + } + }, + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", + "smithy.api#documentation": "

The ID of the attachment.

", + "smithy.api#xmlName": "transitGatewayAttachmentId" + } + }, + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The ID of the resource.

", + "smithy.api#xmlName": "resourceId" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The resource type. Note that the tgw-peering resource type has been deprecated.

", + "smithy.api#xmlName": "resourceType" + } + }, + "State": { + "target": "com.amazonaws.ec2#TransitGatewayAssociationState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the association.

", + "smithy.api#xmlName": "state" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an association between a resource attachment and a transit gateway route table.

" + } + }, + "com.amazonaws.ec2#TransitGatewayAssociationState": { + "type": "enum", + "members": { + "associating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associating" + } + }, + "associated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associated" + } + }, + "disassociating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociating" + } + }, + "disassociated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociated" + } + } + } + }, + "com.amazonaws.ec2#TransitGatewayAttachment": { + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", + "smithy.api#documentation": "

The ID of the attachment.

", + "smithy.api#xmlName": "transitGatewayAttachmentId" + } + }, + "TransitGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayId", + "smithy.api#documentation": "

The ID of the transit gateway.

", + "smithy.api#xmlName": "transitGatewayId" + } + }, + "TransitGatewayOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayOwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the transit gateway.

", + "smithy.api#xmlName": "transitGatewayOwnerId" + } + }, + "ResourceOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceOwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the resource.

", + "smithy.api#xmlName": "resourceOwnerId" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The resource type. Note that the tgw-peering resource type has been deprecated.

", + "smithy.api#xmlName": "resourceType" + } + }, + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The ID of the resource.

", + "smithy.api#xmlName": "resourceId" + } + }, + "State": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The attachment state. Note that the initiating state has been deprecated.

", + "smithy.api#xmlName": "state" + } + }, + "Association": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentAssociation", + "traits": { + "aws.protocols#ec2QueryName": "Association", + "smithy.api#documentation": "

The association.

", + "smithy.api#xmlName": "association" + } + }, + "CreationTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreationTime", + "smithy.api#documentation": "

The creation time.

", + "smithy.api#xmlName": "creationTime" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags for the attachment.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an attachment between a resource and a transit gateway.

" + } + }, + "com.amazonaws.ec2#TransitGatewayAttachmentAssociation": { + "type": "structure", + "members": { + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTableId", + "smithy.api#documentation": "

The ID of the route table for the transit gateway.

", + "smithy.api#xmlName": "transitGatewayRouteTableId" + } + }, + "State": { + "target": "com.amazonaws.ec2#TransitGatewayAssociationState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the association.

", + "smithy.api#xmlName": "state" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an association.

" + } + }, + "com.amazonaws.ec2#TransitGatewayAttachmentBgpConfiguration": { + "type": "structure", + "members": { + "TransitGatewayAsn": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAsn", + "smithy.api#documentation": "

The transit gateway Autonomous System Number (ASN).

", + "smithy.api#xmlName": "transitGatewayAsn" + } + }, + "PeerAsn": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "PeerAsn", + "smithy.api#documentation": "

The peer Autonomous System Number (ASN).

", + "smithy.api#xmlName": "peerAsn" + } + }, + "TransitGatewayAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAddress", + "smithy.api#documentation": "

The interior BGP peer IP address for the transit gateway.

", + "smithy.api#xmlName": "transitGatewayAddress" + } + }, + "PeerAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PeerAddress", + "smithy.api#documentation": "

The interior BGP peer IP address for the appliance.

", + "smithy.api#xmlName": "peerAddress" + } + }, + "BgpStatus": { + "target": "com.amazonaws.ec2#BgpStatus", + "traits": { + "aws.protocols#ec2QueryName": "BgpStatus", + "smithy.api#documentation": "

The BGP status.

", + "smithy.api#xmlName": "bgpStatus" + } + } + }, + "traits": { + "smithy.api#documentation": "

The BGP configuration information.

" + } + }, + "com.amazonaws.ec2#TransitGatewayAttachmentBgpConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentBgpConfiguration", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayAttachmentId": { + "type": "string" + }, + "com.amazonaws.ec2#TransitGatewayAttachmentIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId" + } + }, + "com.amazonaws.ec2#TransitGatewayAttachmentList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayAttachment", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayAttachmentPropagation": { + "type": "structure", + "members": { + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTableId", + "smithy.api#documentation": "

The ID of the propagation route table.

", + "smithy.api#xmlName": "transitGatewayRouteTableId" + } + }, + "State": { + "target": "com.amazonaws.ec2#TransitGatewayPropagationState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the propagation route table.

", + "smithy.api#xmlName": "state" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a propagation route table.

" + } + }, + "com.amazonaws.ec2#TransitGatewayAttachmentPropagationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentPropagation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayAttachmentResourceType": { + "type": "enum", + "members": { + "vpc": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vpc" + } + }, + "vpn": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vpn" + } + }, + "direct_connect_gateway": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "direct-connect-gateway" + } + }, + "connect": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "connect" + } + }, + "peering": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "peering" + } + }, + "tgw_peering": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "tgw-peering" + } + } + } + }, + "com.amazonaws.ec2#TransitGatewayAttachmentState": { + "type": "enum", + "members": { + "initiating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "initiating" + } + }, + "initiatingRequest": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "initiatingRequest" + } + }, + "pendingAcceptance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pendingAcceptance" + } + }, + "rollingBack": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rollingBack" + } + }, + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "modifying": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modifying" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + }, + "deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted" + } + }, + "failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + }, + "rejected": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rejected" + } + }, + "rejecting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rejecting" + } + }, + "failing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failing" + } + } + } + }, + "com.amazonaws.ec2#TransitGatewayCidrBlockStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayConnect": { + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", + "smithy.api#documentation": "

The ID of the Connect attachment.

", + "smithy.api#xmlName": "transitGatewayAttachmentId" + } + }, + "TransportTransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "aws.protocols#ec2QueryName": "TransportTransitGatewayAttachmentId", + "smithy.api#documentation": "

The ID of the attachment from which the Connect attachment was created.

", + "smithy.api#xmlName": "transportTransitGatewayAttachmentId" + } + }, + "TransitGatewayId": { + "target": "com.amazonaws.ec2#TransitGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayId", + "smithy.api#documentation": "

The ID of the transit gateway.

", + "smithy.api#xmlName": "transitGatewayId" + } + }, + "State": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the attachment.

", + "smithy.api#xmlName": "state" + } + }, + "CreationTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreationTime", + "smithy.api#documentation": "

The creation time.

", + "smithy.api#xmlName": "creationTime" + } + }, + "Options": { + "target": "com.amazonaws.ec2#TransitGatewayConnectOptions", + "traits": { + "aws.protocols#ec2QueryName": "Options", + "smithy.api#documentation": "

The Connect attachment options.

", + "smithy.api#xmlName": "options" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags for the attachment.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a transit gateway Connect attachment.

" + } + }, + "com.amazonaws.ec2#TransitGatewayConnectList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayConnect", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayConnectOptions": { + "type": "structure", + "members": { + "Protocol": { + "target": "com.amazonaws.ec2#ProtocolValue", + "traits": { + "aws.protocols#ec2QueryName": "Protocol", + "smithy.api#documentation": "

The tunnel protocol.

", + "smithy.api#xmlName": "protocol" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the Connect attachment options.

" + } + }, + "com.amazonaws.ec2#TransitGatewayConnectPeer": { + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", + "smithy.api#documentation": "

The ID of the Connect attachment.

", + "smithy.api#xmlName": "transitGatewayAttachmentId" + } + }, + "TransitGatewayConnectPeerId": { + "target": "com.amazonaws.ec2#TransitGatewayConnectPeerId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayConnectPeerId", + "smithy.api#documentation": "

The ID of the Connect peer.

", + "smithy.api#xmlName": "transitGatewayConnectPeerId" + } + }, + "State": { + "target": "com.amazonaws.ec2#TransitGatewayConnectPeerState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the Connect peer.

", + "smithy.api#xmlName": "state" + } + }, + "CreationTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreationTime", + "smithy.api#documentation": "

The creation time.

", + "smithy.api#xmlName": "creationTime" + } + }, + "ConnectPeerConfiguration": { + "target": "com.amazonaws.ec2#TransitGatewayConnectPeerConfiguration", + "traits": { + "aws.protocols#ec2QueryName": "ConnectPeerConfiguration", + "smithy.api#documentation": "

The Connect peer details.

", + "smithy.api#xmlName": "connectPeerConfiguration" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags for the Connect peer.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a transit gateway Connect peer.

" + } + }, + "com.amazonaws.ec2#TransitGatewayConnectPeerConfiguration": { + "type": "structure", + "members": { + "TransitGatewayAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAddress", + "smithy.api#documentation": "

The Connect peer IP address on the transit gateway side of the tunnel.

", + "smithy.api#xmlName": "transitGatewayAddress" + } + }, + "PeerAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PeerAddress", + "smithy.api#documentation": "

The Connect peer IP address on the appliance side of the tunnel.

", + "smithy.api#xmlName": "peerAddress" + } + }, + "InsideCidrBlocks": { + "target": "com.amazonaws.ec2#InsideCidrBlocksStringList", + "traits": { + "aws.protocols#ec2QueryName": "InsideCidrBlocks", + "smithy.api#documentation": "

The range of interior BGP peer IP addresses.

", + "smithy.api#xmlName": "insideCidrBlocks" + } + }, + "Protocol": { + "target": "com.amazonaws.ec2#ProtocolValue", + "traits": { + "aws.protocols#ec2QueryName": "Protocol", + "smithy.api#documentation": "

The tunnel protocol.

", + "smithy.api#xmlName": "protocol" + } + }, + "BgpConfigurations": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentBgpConfigurationList", + "traits": { + "aws.protocols#ec2QueryName": "BgpConfigurations", + "smithy.api#documentation": "

The BGP configuration details.

", + "smithy.api#xmlName": "bgpConfigurations" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the Connect peer details.

" + } + }, + "com.amazonaws.ec2#TransitGatewayConnectPeerId": { + "type": "string" + }, + "com.amazonaws.ec2#TransitGatewayConnectPeerIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayConnectPeerId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayConnectPeerList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayConnectPeer", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayConnectPeerState": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + }, + "deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted" + } + } + } + }, + "com.amazonaws.ec2#TransitGatewayConnectRequestBgpOptions": { + "type": "structure", + "members": { + "PeerAsn": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "smithy.api#documentation": "

The peer Autonomous System Number (ASN).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The BGP options for the Connect attachment.

" + } + }, + "com.amazonaws.ec2#TransitGatewayId": { + "type": "string" + }, + "com.amazonaws.ec2#TransitGatewayIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGateway", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#TransitGatewayMulitcastDomainAssociationState": { + "type": "enum", + "members": { + "pendingAcceptance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pendingAcceptance" + } + }, + "associating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associating" + } + }, + "associated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associated" + } + }, + "disassociating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociating" + } + }, + "disassociated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociated" + } + }, + "rejected": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rejected" + } + }, + "failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + } + } + }, + "com.amazonaws.ec2#TransitGatewayMulticastDeregisteredGroupMembers": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayMulticastDomainId", + "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

", + "smithy.api#xmlName": "transitGatewayMulticastDomainId" + } + }, + "DeregisteredNetworkInterfaceIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "DeregisteredNetworkInterfaceIds", + "smithy.api#documentation": "

The network interface IDs of the deregistered members.

", + "smithy.api#xmlName": "deregisteredNetworkInterfaceIds" + } + }, + "GroupIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupIpAddress", + "smithy.api#documentation": "

The IP address assigned to the transit gateway multicast group.

", + "smithy.api#xmlName": "groupIpAddress" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the deregistered transit gateway multicast group members.

" + } + }, + "com.amazonaws.ec2#TransitGatewayMulticastDeregisteredGroupSources": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayMulticastDomainId", + "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

", + "smithy.api#xmlName": "transitGatewayMulticastDomainId" + } + }, + "DeregisteredNetworkInterfaceIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "DeregisteredNetworkInterfaceIds", + "smithy.api#documentation": "

The network interface IDs of the non-registered members.

", + "smithy.api#xmlName": "deregisteredNetworkInterfaceIds" + } + }, + "GroupIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupIpAddress", + "smithy.api#documentation": "

The IP address assigned to the transit gateway multicast group.

", + "smithy.api#xmlName": "groupIpAddress" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the deregistered transit gateway multicast group sources.

" + } + }, + "com.amazonaws.ec2#TransitGatewayMulticastDomain": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayMulticastDomainId", + "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

", + "smithy.api#xmlName": "transitGatewayMulticastDomainId" + } + }, + "TransitGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayId", + "smithy.api#documentation": "

The ID of the transit gateway.

", + "smithy.api#xmlName": "transitGatewayId" + } + }, + "TransitGatewayMulticastDomainArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayMulticastDomainArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the transit gateway multicast domain.

", + "smithy.api#xmlName": "transitGatewayMulticastDomainArn" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the transit gateway multicast domain.

", + "smithy.api#xmlName": "ownerId" + } + }, + "Options": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainOptions", + "traits": { + "aws.protocols#ec2QueryName": "Options", + "smithy.api#documentation": "

The options for the transit gateway multicast domain.

", + "smithy.api#xmlName": "options" + } + }, + "State": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the transit gateway multicast domain.

", + "smithy.api#xmlName": "state" + } + }, + "CreationTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreationTime", + "smithy.api#documentation": "

The time the transit gateway multicast domain was created.

", + "smithy.api#xmlName": "creationTime" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags for the transit gateway multicast domain.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the transit gateway multicast domain.

" + } + }, + "com.amazonaws.ec2#TransitGatewayMulticastDomainAssociation": { + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", + "smithy.api#documentation": "

The ID of the transit gateway attachment.

", + "smithy.api#xmlName": "transitGatewayAttachmentId" + } + }, + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The ID of the resource.

", + "smithy.api#xmlName": "resourceId" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The type of resource, for example a VPC attachment.

", + "smithy.api#xmlName": "resourceType" + } + }, + "ResourceOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceOwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the transit gateway multicast domain association resource.

", + "smithy.api#xmlName": "resourceOwnerId" + } + }, + "Subnet": { + "target": "com.amazonaws.ec2#SubnetAssociation", + "traits": { + "aws.protocols#ec2QueryName": "Subnet", + "smithy.api#documentation": "

The subnet associated with the transit gateway multicast domain.

", + "smithy.api#xmlName": "subnet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the resources associated with the transit gateway multicast domain.

" + } + }, + "com.amazonaws.ec2#TransitGatewayMulticastDomainAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainAssociation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayMulticastDomainAssociations": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayMulticastDomainId", + "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

", + "smithy.api#xmlName": "transitGatewayMulticastDomainId" + } + }, + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", + "smithy.api#documentation": "

The ID of the transit gateway attachment.

", + "smithy.api#xmlName": "transitGatewayAttachmentId" + } + }, + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The ID of the resource.

", + "smithy.api#xmlName": "resourceId" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The type of resource, for example a VPC attachment.

", + "smithy.api#xmlName": "resourceType" + } + }, + "ResourceOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceOwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the resource.

", + "smithy.api#xmlName": "resourceOwnerId" + } + }, + "Subnets": { + "target": "com.amazonaws.ec2#SubnetAssociationList", + "traits": { + "aws.protocols#ec2QueryName": "Subnets", + "smithy.api#documentation": "

The subnets associated with the multicast domain.

", + "smithy.api#xmlName": "subnets" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the multicast domain associations.

" + } + }, + "com.amazonaws.ec2#TransitGatewayMulticastDomainId": { + "type": "string" + }, + "com.amazonaws.ec2#TransitGatewayMulticastDomainIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayMulticastDomainList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomain", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayMulticastDomainOptions": { + "type": "structure", + "members": { + "Igmpv2Support": { + "target": "com.amazonaws.ec2#Igmpv2SupportValue", + "traits": { + "aws.protocols#ec2QueryName": "Igmpv2Support", + "smithy.api#documentation": "

Indicates whether Internet Group Management Protocol (IGMP) version 2 is turned on for the transit gateway multicast domain.

", + "smithy.api#xmlName": "igmpv2Support" + } + }, + "StaticSourcesSupport": { + "target": "com.amazonaws.ec2#StaticSourcesSupportValue", + "traits": { + "aws.protocols#ec2QueryName": "StaticSourcesSupport", + "smithy.api#documentation": "

Indicates whether support for statically configuring transit gateway multicast group sources is turned on.

", + "smithy.api#xmlName": "staticSourcesSupport" + } + }, + "AutoAcceptSharedAssociations": { + "target": "com.amazonaws.ec2#AutoAcceptSharedAssociationsValue", + "traits": { + "aws.protocols#ec2QueryName": "AutoAcceptSharedAssociations", + "smithy.api#documentation": "

Indicates whether to automatically cross-account subnet associations that are associated with the transit gateway multicast domain.

", + "smithy.api#xmlName": "autoAcceptSharedAssociations" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the options for a transit gateway multicast domain.

" + } + }, + "com.amazonaws.ec2#TransitGatewayMulticastDomainState": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + }, + "deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted" + } + } + } + }, + "com.amazonaws.ec2#TransitGatewayMulticastGroup": { + "type": "structure", + "members": { + "GroupIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupIpAddress", + "smithy.api#documentation": "

The IP address assigned to the transit gateway multicast group.

", + "smithy.api#xmlName": "groupIpAddress" + } + }, + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", + "smithy.api#documentation": "

The ID of the transit gateway attachment.

", + "smithy.api#xmlName": "transitGatewayAttachmentId" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet.

", + "smithy.api#xmlName": "subnetId" + } + }, + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The ID of the resource.

", + "smithy.api#xmlName": "resourceId" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The type of resource, for example a VPC attachment.

", + "smithy.api#xmlName": "resourceType" + } + }, + "ResourceOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceOwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the transit gateway multicast domain group resource.

", + "smithy.api#xmlName": "resourceOwnerId" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of the transit gateway attachment.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "GroupMember": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "GroupMember", + "smithy.api#documentation": "

Indicates that the resource is a transit gateway multicast group member.

", + "smithy.api#xmlName": "groupMember" + } + }, + "GroupSource": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "GroupSource", + "smithy.api#documentation": "

Indicates that the resource is a transit gateway multicast group member.

", + "smithy.api#xmlName": "groupSource" + } + }, + "MemberType": { + "target": "com.amazonaws.ec2#MembershipType", + "traits": { + "aws.protocols#ec2QueryName": "MemberType", + "smithy.api#documentation": "

The member type (for example, static).

", + "smithy.api#xmlName": "memberType" + } + }, + "SourceType": { + "target": "com.amazonaws.ec2#MembershipType", + "traits": { + "aws.protocols#ec2QueryName": "SourceType", + "smithy.api#documentation": "

The source type.

", + "smithy.api#xmlName": "sourceType" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the transit gateway multicast group resources.

" + } + }, + "com.amazonaws.ec2#TransitGatewayMulticastGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastGroup", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayMulticastRegisteredGroupMembers": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayMulticastDomainId", + "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

", + "smithy.api#xmlName": "transitGatewayMulticastDomainId" + } + }, + "RegisteredNetworkInterfaceIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "RegisteredNetworkInterfaceIds", + "smithy.api#documentation": "

The ID of the registered network interfaces.

", + "smithy.api#xmlName": "registeredNetworkInterfaceIds" + } + }, + "GroupIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupIpAddress", + "smithy.api#documentation": "

The IP address assigned to the transit gateway multicast group.

", + "smithy.api#xmlName": "groupIpAddress" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the registered transit gateway multicast group members.

" + } + }, + "com.amazonaws.ec2#TransitGatewayMulticastRegisteredGroupSources": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayMulticastDomainId", + "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

", + "smithy.api#xmlName": "transitGatewayMulticastDomainId" + } + }, + "RegisteredNetworkInterfaceIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "RegisteredNetworkInterfaceIds", + "smithy.api#documentation": "

The IDs of the network interfaces members registered with the transit gateway multicast group.

", + "smithy.api#xmlName": "registeredNetworkInterfaceIds" + } + }, + "GroupIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupIpAddress", + "smithy.api#documentation": "

The IP address assigned to the transit gateway multicast group.

", + "smithy.api#xmlName": "groupIpAddress" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the members registered with the transit gateway multicast group.

" + } + }, + "com.amazonaws.ec2#TransitGatewayNetworkInterfaceIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayOptions": { + "type": "structure", + "members": { + "AmazonSideAsn": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "AmazonSideAsn", + "smithy.api#documentation": "

A private Autonomous System Number (ASN) for the Amazon side of a BGP session. \n The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs.

", + "smithy.api#xmlName": "amazonSideAsn" + } + }, + "TransitGatewayCidrBlocks": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayCidrBlocks", + "smithy.api#documentation": "

The transit gateway CIDR blocks.

", + "smithy.api#xmlName": "transitGatewayCidrBlocks" + } + }, + "AutoAcceptSharedAttachments": { + "target": "com.amazonaws.ec2#AutoAcceptSharedAttachmentsValue", + "traits": { + "aws.protocols#ec2QueryName": "AutoAcceptSharedAttachments", + "smithy.api#documentation": "

Indicates whether attachment requests are automatically accepted.

", + "smithy.api#xmlName": "autoAcceptSharedAttachments" + } + }, + "DefaultRouteTableAssociation": { + "target": "com.amazonaws.ec2#DefaultRouteTableAssociationValue", + "traits": { + "aws.protocols#ec2QueryName": "DefaultRouteTableAssociation", + "smithy.api#documentation": "

Indicates whether resource attachments are automatically associated with the default association route table.

", + "smithy.api#xmlName": "defaultRouteTableAssociation" + } + }, + "AssociationDefaultRouteTableId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AssociationDefaultRouteTableId", + "smithy.api#documentation": "

The ID of the default association route table.

", + "smithy.api#xmlName": "associationDefaultRouteTableId" + } + }, + "DefaultRouteTablePropagation": { + "target": "com.amazonaws.ec2#DefaultRouteTablePropagationValue", + "traits": { + "aws.protocols#ec2QueryName": "DefaultRouteTablePropagation", + "smithy.api#documentation": "

Indicates whether resource attachments automatically propagate routes to the default propagation route table.

", + "smithy.api#xmlName": "defaultRouteTablePropagation" + } + }, + "PropagationDefaultRouteTableId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PropagationDefaultRouteTableId", + "smithy.api#documentation": "

The ID of the default propagation route table.

", + "smithy.api#xmlName": "propagationDefaultRouteTableId" + } + }, + "VpnEcmpSupport": { + "target": "com.amazonaws.ec2#VpnEcmpSupportValue", + "traits": { + "aws.protocols#ec2QueryName": "VpnEcmpSupport", + "smithy.api#documentation": "

Indicates whether Equal Cost Multipath Protocol support is enabled.

", + "smithy.api#xmlName": "vpnEcmpSupport" + } + }, + "DnsSupport": { + "target": "com.amazonaws.ec2#DnsSupportValue", + "traits": { + "aws.protocols#ec2QueryName": "DnsSupport", + "smithy.api#documentation": "

Indicates whether DNS support is enabled.

", + "smithy.api#xmlName": "dnsSupport" + } + }, + "SecurityGroupReferencingSupport": { + "target": "com.amazonaws.ec2#SecurityGroupReferencingSupportValue", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroupReferencingSupport", + "smithy.api#documentation": "

Enables you to reference a security group across VPCs attached to a transit gateway to simplify security group management.\n\n

\n

This option is disabled by default.

", + "smithy.api#xmlName": "securityGroupReferencingSupport" + } + }, + "MulticastSupport": { + "target": "com.amazonaws.ec2#MulticastSupportValue", + "traits": { + "aws.protocols#ec2QueryName": "MulticastSupport", + "smithy.api#documentation": "

Indicates whether multicast is enabled on the transit gateway

", + "smithy.api#xmlName": "multicastSupport" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the options for a transit gateway.

" + } + }, + "com.amazonaws.ec2#TransitGatewayPeeringAttachment": { + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", + "smithy.api#documentation": "

The ID of the transit gateway peering attachment.

", + "smithy.api#xmlName": "transitGatewayAttachmentId" + } + }, + "AccepterTransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AccepterTransitGatewayAttachmentId", + "smithy.api#documentation": "

The ID of the accepter transit gateway attachment.

", + "smithy.api#xmlName": "accepterTransitGatewayAttachmentId" + } + }, + "RequesterTgwInfo": { + "target": "com.amazonaws.ec2#PeeringTgwInfo", + "traits": { + "aws.protocols#ec2QueryName": "RequesterTgwInfo", + "smithy.api#documentation": "

Information about the requester transit gateway.

", + "smithy.api#xmlName": "requesterTgwInfo" + } + }, + "AccepterTgwInfo": { + "target": "com.amazonaws.ec2#PeeringTgwInfo", + "traits": { + "aws.protocols#ec2QueryName": "AccepterTgwInfo", + "smithy.api#documentation": "

Information about the accepter transit gateway.

", + "smithy.api#xmlName": "accepterTgwInfo" + } + }, + "Options": { + "target": "com.amazonaws.ec2#TransitGatewayPeeringAttachmentOptions", + "traits": { + "aws.protocols#ec2QueryName": "Options", + "smithy.api#documentation": "

Details about the transit gateway peering attachment.

", + "smithy.api#xmlName": "options" + } + }, + "Status": { + "target": "com.amazonaws.ec2#PeeringAttachmentStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The status of the transit gateway peering attachment.

", + "smithy.api#xmlName": "status" + } + }, + "State": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the transit gateway peering attachment. Note that the initiating state has been deprecated.

", + "smithy.api#xmlName": "state" + } + }, + "CreationTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreationTime", + "smithy.api#documentation": "

The time the transit gateway peering attachment was created.

", + "smithy.api#xmlName": "creationTime" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags for the transit gateway peering attachment.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the transit gateway peering attachment.

" + } + }, + "com.amazonaws.ec2#TransitGatewayPeeringAttachmentList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayPeeringAttachment", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayPeeringAttachmentOptions": { + "type": "structure", + "members": { + "DynamicRouting": { + "target": "com.amazonaws.ec2#DynamicRoutingValue", + "traits": { + "aws.protocols#ec2QueryName": "DynamicRouting", + "smithy.api#documentation": "

Describes whether dynamic routing is enabled or disabled for the transit gateway peering attachment.

", + "smithy.api#xmlName": "dynamicRouting" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes dynamic routing for the transit gateway peering attachment.

" + } + }, + "com.amazonaws.ec2#TransitGatewayPolicyRule": { + "type": "structure", + "members": { + "SourceCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SourceCidrBlock", + "smithy.api#documentation": "

The source CIDR block for the transit gateway policy rule.

", + "smithy.api#xmlName": "sourceCidrBlock" + } + }, + "SourcePortRange": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SourcePortRange", + "smithy.api#documentation": "

The port range for the transit gateway policy rule. Currently this is set to * (all).

", + "smithy.api#xmlName": "sourcePortRange" + } + }, + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationCidrBlock", + "smithy.api#documentation": "

The destination CIDR block for the transit gateway policy rule.

", + "smithy.api#xmlName": "destinationCidrBlock" + } + }, + "DestinationPortRange": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationPortRange", + "smithy.api#documentation": "

The port range for the transit gateway policy rule. Currently this is set to * (all).

", + "smithy.api#xmlName": "destinationPortRange" + } + }, + "Protocol": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Protocol", + "smithy.api#documentation": "

The protocol used by the transit gateway policy rule.

", + "smithy.api#xmlName": "protocol" + } + }, + "MetaData": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyRuleMetaData", + "traits": { + "aws.protocols#ec2QueryName": "MetaData", + "smithy.api#documentation": "

The meta data tags used for the transit gateway policy rule.

", + "smithy.api#xmlName": "metaData" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a rule associated with a transit gateway policy.

" + } + }, + "com.amazonaws.ec2#TransitGatewayPolicyRuleMetaData": { + "type": "structure", + "members": { + "MetaDataKey": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "MetaDataKey", + "smithy.api#documentation": "

The key name for the transit gateway policy rule meta data tag.

", + "smithy.api#xmlName": "metaDataKey" + } + }, + "MetaDataValue": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "MetaDataValue", + "smithy.api#documentation": "

The value of the key for the transit gateway policy rule meta data tag.

", + "smithy.api#xmlName": "metaDataValue" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the meta data tags associated with a transit gateway policy rule.

" + } + }, + "com.amazonaws.ec2#TransitGatewayPolicyTable": { + "type": "structure", + "members": { + "TransitGatewayPolicyTableId": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayPolicyTableId", + "smithy.api#documentation": "

The ID of the transit gateway policy table.

", + "smithy.api#xmlName": "transitGatewayPolicyTableId" + } + }, + "TransitGatewayId": { + "target": "com.amazonaws.ec2#TransitGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayId", + "smithy.api#documentation": "

The ID of the transit gateway.

", + "smithy.api#xmlName": "transitGatewayId" + } + }, + "State": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the transit gateway policy table

", + "smithy.api#xmlName": "state" + } + }, + "CreationTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreationTime", + "smithy.api#documentation": "

The timestamp when the transit gateway policy table was created.

", + "smithy.api#xmlName": "creationTime" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

he key-value pairs associated with the transit gateway policy table.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a transit gateway policy table.

" + } + }, + "com.amazonaws.ec2#TransitGatewayPolicyTableAssociation": { + "type": "structure", + "members": { + "TransitGatewayPolicyTableId": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayPolicyTableId", + "smithy.api#documentation": "

The ID of the transit gateway policy table.

", + "smithy.api#xmlName": "transitGatewayPolicyTableId" + } + }, + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", + "smithy.api#documentation": "

The ID of the transit gateway attachment.

", + "smithy.api#xmlName": "transitGatewayAttachmentId" + } + }, + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The resource ID of the transit gateway attachment.

", + "smithy.api#xmlName": "resourceId" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The resource type for the transit gateway policy table association.

", + "smithy.api#xmlName": "resourceType" + } + }, + "State": { + "target": "com.amazonaws.ec2#TransitGatewayAssociationState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the transit gateway policy table association.

", + "smithy.api#xmlName": "state" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a transit gateway policy table association.

" + } + }, + "com.amazonaws.ec2#TransitGatewayPolicyTableAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableAssociation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayPolicyTableEntry": { + "type": "structure", + "members": { + "PolicyRuleNumber": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PolicyRuleNumber", + "smithy.api#documentation": "

The rule number for the transit gateway policy table entry.

", + "smithy.api#xmlName": "policyRuleNumber" + } + }, + "PolicyRule": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyRule", + "traits": { + "aws.protocols#ec2QueryName": "PolicyRule", + "smithy.api#documentation": "

The policy rule associated with the transit gateway policy table.

", + "smithy.api#xmlName": "policyRule" + } + }, + "TargetRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "aws.protocols#ec2QueryName": "TargetRouteTableId", + "smithy.api#documentation": "

The ID of the target route table.

", + "smithy.api#xmlName": "targetRouteTableId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a transit gateway policy table entry

" + } + }, + "com.amazonaws.ec2#TransitGatewayPolicyTableEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableEntry", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayPolicyTableId": { + "type": "string" + }, + "com.amazonaws.ec2#TransitGatewayPolicyTableIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayPolicyTableList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTable", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayPolicyTableState": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + }, + "deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted" + } + } + } + }, + "com.amazonaws.ec2#TransitGatewayPrefixListAttachment": { + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", + "smithy.api#documentation": "

The ID of the attachment.

", + "smithy.api#xmlName": "transitGatewayAttachmentId" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The resource type. Note that the tgw-peering resource type has been deprecated.

", + "smithy.api#xmlName": "resourceType" + } + }, + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The ID of the resource.

", + "smithy.api#xmlName": "resourceId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a transit gateway prefix list attachment.

" + } + }, + "com.amazonaws.ec2#TransitGatewayPrefixListReference": { + "type": "structure", + "members": { + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTableId", + "smithy.api#documentation": "

The ID of the transit gateway route table.

", + "smithy.api#xmlName": "transitGatewayRouteTableId" + } + }, + "PrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "aws.protocols#ec2QueryName": "PrefixListId", + "smithy.api#documentation": "

The ID of the prefix list.

", + "smithy.api#xmlName": "prefixListId" + } + }, + "PrefixListOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrefixListOwnerId", + "smithy.api#documentation": "

The ID of the prefix list owner.

", + "smithy.api#xmlName": "prefixListOwnerId" + } + }, + "State": { + "target": "com.amazonaws.ec2#TransitGatewayPrefixListReferenceState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the prefix list reference.

", + "smithy.api#xmlName": "state" + } + }, + "Blackhole": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Blackhole", + "smithy.api#documentation": "

Indicates whether traffic that matches this route is dropped.

", + "smithy.api#xmlName": "blackhole" + } + }, + "TransitGatewayAttachment": { + "target": "com.amazonaws.ec2#TransitGatewayPrefixListAttachment", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAttachment", + "smithy.api#documentation": "

Information about the transit gateway attachment.

", + "smithy.api#xmlName": "transitGatewayAttachment" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a prefix list reference.

" + } + }, + "com.amazonaws.ec2#TransitGatewayPrefixListReferenceSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayPrefixListReference", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayPrefixListReferenceState": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "modifying": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modifying" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + } + } + }, + "com.amazonaws.ec2#TransitGatewayPropagation": { + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", + "smithy.api#documentation": "

The ID of the attachment.

", + "smithy.api#xmlName": "transitGatewayAttachmentId" + } + }, + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The ID of the resource.

", + "smithy.api#xmlName": "resourceId" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The resource type. Note that the tgw-peering resource type has been deprecated.

", + "smithy.api#xmlName": "resourceType" + } + }, + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTableId", + "smithy.api#documentation": "

The ID of the transit gateway route table.

", + "smithy.api#xmlName": "transitGatewayRouteTableId" + } + }, + "State": { + "target": "com.amazonaws.ec2#TransitGatewayPropagationState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state.

", + "smithy.api#xmlName": "state" + } + }, + "TransitGatewayRouteTableAnnouncementId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTableAnnouncementId", + "smithy.api#documentation": "

The ID of the transit gateway route table announcement.

", + "smithy.api#xmlName": "transitGatewayRouteTableAnnouncementId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes route propagation.

" + } + }, + "com.amazonaws.ec2#TransitGatewayPropagationState": { + "type": "enum", + "members": { + "enabling": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabling" + } + }, + "enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + }, + "disabling": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabling" + } + }, + "disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + } + } + }, + "com.amazonaws.ec2#TransitGatewayRequestOptions": { + "type": "structure", + "members": { + "AmazonSideAsn": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "smithy.api#documentation": "

A private Autonomous System Number (ASN) for the Amazon side of a BGP session. \n The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs. The default is 64512.

" + } + }, + "AutoAcceptSharedAttachments": { + "target": "com.amazonaws.ec2#AutoAcceptSharedAttachmentsValue", + "traits": { + "smithy.api#documentation": "

Enable or disable automatic acceptance of attachment requests. Disabled by default.

" + } + }, + "DefaultRouteTableAssociation": { + "target": "com.amazonaws.ec2#DefaultRouteTableAssociationValue", + "traits": { + "smithy.api#documentation": "

Enable or disable automatic association with the default association route table. Enabled by default.

" + } + }, + "DefaultRouteTablePropagation": { + "target": "com.amazonaws.ec2#DefaultRouteTablePropagationValue", + "traits": { + "smithy.api#documentation": "

Enable or disable automatic propagation of routes to the default propagation route table. Enabled by default.

" + } + }, + "VpnEcmpSupport": { + "target": "com.amazonaws.ec2#VpnEcmpSupportValue", + "traits": { + "smithy.api#documentation": "

Enable or disable Equal Cost Multipath Protocol support. Enabled by default.

" + } + }, + "DnsSupport": { + "target": "com.amazonaws.ec2#DnsSupportValue", + "traits": { + "smithy.api#documentation": "

Enable or disable DNS support. Enabled by default.

" + } + }, + "SecurityGroupReferencingSupport": { + "target": "com.amazonaws.ec2#SecurityGroupReferencingSupportValue", + "traits": { + "smithy.api#documentation": "

Enables you to reference a security group across VPCs attached to a transit gateway to simplify security group management.\n\n

\n

This option is disabled by default.

\n

For more information about security group referencing, see Security group referencing in the Amazon Web Services Transit Gateways Guide.

" + } + }, + "MulticastSupport": { + "target": "com.amazonaws.ec2#MulticastSupportValue", + "traits": { + "smithy.api#documentation": "

Indicates whether multicast is enabled on the transit gateway

" + } + }, + "TransitGatewayCidrBlocks": { + "target": "com.amazonaws.ec2#TransitGatewayCidrBlockStringList", + "traits": { + "smithy.api#documentation": "

One or more IPv4 or IPv6 CIDR blocks for the transit gateway. Must be a size /24 CIDR block or larger for IPv4, or a size /64 CIDR block or larger for IPv6.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the options for a transit gateway.

" + } + }, + "com.amazonaws.ec2#TransitGatewayRoute": { + "type": "structure", + "members": { + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationCidrBlock", + "smithy.api#documentation": "

The CIDR block used for destination matches.

", + "smithy.api#xmlName": "destinationCidrBlock" + } + }, + "PrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "aws.protocols#ec2QueryName": "PrefixListId", + "smithy.api#documentation": "

The ID of the prefix list used for destination matches.

", + "smithy.api#xmlName": "prefixListId" + } + }, + "TransitGatewayRouteTableAnnouncementId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTableAnnouncementId", + "smithy.api#documentation": "

The ID of the transit gateway route table announcement.

", + "smithy.api#xmlName": "transitGatewayRouteTableAnnouncementId" + } + }, + "TransitGatewayAttachments": { + "target": "com.amazonaws.ec2#TransitGatewayRouteAttachmentList", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAttachments", + "smithy.api#documentation": "

The attachments.

", + "smithy.api#xmlName": "transitGatewayAttachments" + } + }, + "Type": { + "target": "com.amazonaws.ec2#TransitGatewayRouteType", + "traits": { + "aws.protocols#ec2QueryName": "Type", + "smithy.api#documentation": "

The route type.

", + "smithy.api#xmlName": "type" + } + }, + "State": { + "target": "com.amazonaws.ec2#TransitGatewayRouteState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the route.

", + "smithy.api#xmlName": "state" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a route for a transit gateway route table.

" + } + }, + "com.amazonaws.ec2#TransitGatewayRouteAttachment": { + "type": "structure", + "members": { + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The ID of the resource.

", + "smithy.api#xmlName": "resourceId" + } + }, + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", + "smithy.api#documentation": "

The ID of the attachment.

", + "smithy.api#xmlName": "transitGatewayAttachmentId" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The resource type. Note that the tgw-peering resource type has been deprecated.

", + "smithy.api#xmlName": "resourceType" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a route attachment.

" + } + }, + "com.amazonaws.ec2#TransitGatewayRouteAttachmentList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayRouteAttachment", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayRouteList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayRoute", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayRouteState": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "blackhole": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "blackhole" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + }, + "deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted" + } + } + } + }, + "com.amazonaws.ec2#TransitGatewayRouteTable": { + "type": "structure", + "members": { + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTableId", + "smithy.api#documentation": "

The ID of the transit gateway route table.

", + "smithy.api#xmlName": "transitGatewayRouteTableId" + } + }, + "TransitGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayId", + "smithy.api#documentation": "

The ID of the transit gateway.

", + "smithy.api#xmlName": "transitGatewayId" + } + }, + "State": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the transit gateway route table.

", + "smithy.api#xmlName": "state" + } + }, + "DefaultAssociationRouteTable": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DefaultAssociationRouteTable", + "smithy.api#documentation": "

Indicates whether this is the default association route table for the transit gateway.

", + "smithy.api#xmlName": "defaultAssociationRouteTable" + } + }, + "DefaultPropagationRouteTable": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DefaultPropagationRouteTable", + "smithy.api#documentation": "

Indicates whether this is the default propagation route table for the transit gateway.

", + "smithy.api#xmlName": "defaultPropagationRouteTable" + } + }, + "CreationTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreationTime", + "smithy.api#documentation": "

The creation time.

", + "smithy.api#xmlName": "creationTime" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the route table.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a transit gateway route table.

" + } + }, + "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncement": { + "type": "structure", + "members": { + "TransitGatewayRouteTableAnnouncementId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTableAnnouncementId", + "smithy.api#documentation": "

The ID of the transit gateway route table announcement.

", + "smithy.api#xmlName": "transitGatewayRouteTableAnnouncementId" + } + }, + "TransitGatewayId": { + "target": "com.amazonaws.ec2#TransitGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayId", + "smithy.api#documentation": "

The ID of the transit gateway.

", + "smithy.api#xmlName": "transitGatewayId" + } + }, + "CoreNetworkId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CoreNetworkId", + "smithy.api#documentation": "

The ID of the core network for the transit gateway route table announcement.

", + "smithy.api#xmlName": "coreNetworkId" + } + }, + "PeerTransitGatewayId": { + "target": "com.amazonaws.ec2#TransitGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "PeerTransitGatewayId", + "smithy.api#documentation": "

The ID of the peer transit gateway.

", + "smithy.api#xmlName": "peerTransitGatewayId" + } + }, + "PeerCoreNetworkId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PeerCoreNetworkId", + "smithy.api#documentation": "

The ID of the core network ID for the peer.

", + "smithy.api#xmlName": "peerCoreNetworkId" + } + }, + "PeeringAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "aws.protocols#ec2QueryName": "PeeringAttachmentId", + "smithy.api#documentation": "

The ID of the peering attachment.

", + "smithy.api#xmlName": "peeringAttachmentId" + } + }, + "AnnouncementDirection": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementDirection", + "traits": { + "aws.protocols#ec2QueryName": "AnnouncementDirection", + "smithy.api#documentation": "

The direction for the route table announcement.

", + "smithy.api#xmlName": "announcementDirection" + } + }, + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTableId", + "smithy.api#documentation": "

The ID of the transit gateway route table.

", + "smithy.api#xmlName": "transitGatewayRouteTableId" + } + }, + "State": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the transit gateway announcement.

", + "smithy.api#xmlName": "state" + } + }, + "CreationTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreationTime", + "smithy.api#documentation": "

The timestamp when the transit gateway route table announcement was created.

", + "smithy.api#xmlName": "creationTime" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The key-value pairs associated with the route table announcement.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a transit gateway route table announcement.

" + } + }, + "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementDirection": { + "type": "enum", + "members": { + "outgoing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "outgoing" + } + }, + "incoming": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "incoming" + } + } + } + }, + "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementId": { + "type": "string" + }, + "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncement", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementState": { + "type": "enum", + "members": { + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "failing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failing" + } + }, + "failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + }, + "deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted" + } + } + } + }, + "com.amazonaws.ec2#TransitGatewayRouteTableAssociation": { + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", + "smithy.api#documentation": "

The ID of the attachment.

", + "smithy.api#xmlName": "transitGatewayAttachmentId" + } + }, + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The ID of the resource.

", + "smithy.api#xmlName": "resourceId" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The resource type. Note that the tgw-peering resource type has been deprecated.

", + "smithy.api#xmlName": "resourceType" + } + }, + "State": { + "target": "com.amazonaws.ec2#TransitGatewayAssociationState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the association.

", + "smithy.api#xmlName": "state" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an association between a route table and a resource attachment.

" + } + }, + "com.amazonaws.ec2#TransitGatewayRouteTableAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableAssociation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayRouteTableId": { + "type": "string" + }, + "com.amazonaws.ec2#TransitGatewayRouteTableIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayRouteTableList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTable", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayRouteTablePropagation": { + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", + "smithy.api#documentation": "

The ID of the attachment.

", + "smithy.api#xmlName": "transitGatewayAttachmentId" + } + }, + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The ID of the resource.

", + "smithy.api#xmlName": "resourceId" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The type of resource. Note that the tgw-peering resource type has been deprecated.

", + "smithy.api#xmlName": "resourceType" + } + }, + "State": { + "target": "com.amazonaws.ec2#TransitGatewayPropagationState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the resource.

", + "smithy.api#xmlName": "state" + } + }, + "TransitGatewayRouteTableAnnouncementId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTableAnnouncementId", + "smithy.api#documentation": "

The ID of the transit gateway route table announcement.

", + "smithy.api#xmlName": "transitGatewayRouteTableAnnouncementId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a route table propagation.

" + } + }, + "com.amazonaws.ec2#TransitGatewayRouteTablePropagationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTablePropagation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayRouteTableRoute": { + "type": "structure", + "members": { + "DestinationCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationCidr", + "smithy.api#documentation": "

The CIDR block used for destination matches.

", + "smithy.api#xmlName": "destinationCidr" + } + }, + "State": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the route.

", + "smithy.api#xmlName": "state" + } + }, + "RouteOrigin": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RouteOrigin", + "smithy.api#documentation": "

The route origin. The following are the possible values:

\n ", + "smithy.api#xmlName": "routeOrigin" + } + }, + "PrefixListId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrefixListId", + "smithy.api#documentation": "

The ID of the prefix list.

", + "smithy.api#xmlName": "prefixListId" + } + }, + "AttachmentId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AttachmentId", + "smithy.api#documentation": "

The ID of the route attachment.

", + "smithy.api#xmlName": "attachmentId" + } + }, + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The ID of the resource for the route attachment.

", + "smithy.api#xmlName": "resourceId" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The resource type for the route attachment.

", + "smithy.api#xmlName": "resourceType" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a route in a transit gateway route table.

" + } + }, + "com.amazonaws.ec2#TransitGatewayRouteTableState": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + }, + "deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted" + } + } + } + }, + "com.amazonaws.ec2#TransitGatewayRouteType": { + "type": "enum", + "members": { + "static": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "static" + } + }, + "propagated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "propagated" + } + } + } + }, + "com.amazonaws.ec2#TransitGatewayState": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "modifying": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modifying" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + }, + "deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted" + } + } + } + }, + "com.amazonaws.ec2#TransitGatewaySubnetIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayVpcAttachment": { + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", + "smithy.api#documentation": "

The ID of the attachment.

", + "smithy.api#xmlName": "transitGatewayAttachmentId" + } + }, + "TransitGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayId", + "smithy.api#documentation": "

The ID of the transit gateway.

", + "smithy.api#xmlName": "transitGatewayId" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "vpcId" + } + }, + "VpcOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcOwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the VPC.

", + "smithy.api#xmlName": "vpcOwnerId" + } + }, + "State": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the VPC attachment. Note that the initiating state has been deprecated.

", + "smithy.api#xmlName": "state" + } + }, + "SubnetIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "SubnetIds", + "smithy.api#documentation": "

The IDs of the subnets.

", + "smithy.api#xmlName": "subnetIds" + } + }, + "CreationTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreationTime", + "smithy.api#documentation": "

The creation time.

", + "smithy.api#xmlName": "creationTime" + } + }, + "Options": { + "target": "com.amazonaws.ec2#TransitGatewayVpcAttachmentOptions", + "traits": { + "aws.protocols#ec2QueryName": "Options", + "smithy.api#documentation": "

The VPC attachment options.

", + "smithy.api#xmlName": "options" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags for the VPC attachment.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a VPC attachment.

" + } + }, + "com.amazonaws.ec2#TransitGatewayVpcAttachmentList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayVpcAttachment", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayVpcAttachmentOptions": { + "type": "structure", + "members": { + "DnsSupport": { + "target": "com.amazonaws.ec2#DnsSupportValue", + "traits": { + "aws.protocols#ec2QueryName": "DnsSupport", + "smithy.api#documentation": "

Indicates whether DNS support is enabled.

", + "smithy.api#xmlName": "dnsSupport" + } + }, + "SecurityGroupReferencingSupport": { + "target": "com.amazonaws.ec2#SecurityGroupReferencingSupportValue", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroupReferencingSupport", + "smithy.api#documentation": "

Enables you to reference a security group across VPCs attached to a transit gateway to simplify security group management.

\n

This option is enabled by default.

\n

For more information about security group referencing, see Security group referencing in the Amazon Web Services Transit Gateways Guide.

", + "smithy.api#xmlName": "securityGroupReferencingSupport" + } + }, + "Ipv6Support": { + "target": "com.amazonaws.ec2#Ipv6SupportValue", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6Support", + "smithy.api#documentation": "

Indicates whether IPv6 support is disabled.

", + "smithy.api#xmlName": "ipv6Support" + } + }, + "ApplianceModeSupport": { + "target": "com.amazonaws.ec2#ApplianceModeSupportValue", + "traits": { + "aws.protocols#ec2QueryName": "ApplianceModeSupport", + "smithy.api#documentation": "

Indicates whether appliance mode support is enabled.

", + "smithy.api#xmlName": "applianceModeSupport" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the VPC attachment options.

" + } + }, + "com.amazonaws.ec2#TransportProtocol": { + "type": "enum", + "members": { + "tcp": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "tcp" + } + }, + "udp": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "udp" + } + } + } + }, + "com.amazonaws.ec2#TrunkInterfaceAssociation": { + "type": "structure", + "members": { + "AssociationId": { + "target": "com.amazonaws.ec2#TrunkInterfaceAssociationId", + "traits": { + "aws.protocols#ec2QueryName": "AssociationId", + "smithy.api#documentation": "

The ID of the association.

", + "smithy.api#xmlName": "associationId" + } + }, + "BranchInterfaceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "BranchInterfaceId", + "smithy.api#documentation": "

The ID of the branch network interface.

", + "smithy.api#xmlName": "branchInterfaceId" + } + }, + "TrunkInterfaceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TrunkInterfaceId", + "smithy.api#documentation": "

The ID of the trunk network interface.

", + "smithy.api#xmlName": "trunkInterfaceId" + } + }, + "InterfaceProtocol": { + "target": "com.amazonaws.ec2#InterfaceProtocolType", + "traits": { + "aws.protocols#ec2QueryName": "InterfaceProtocol", + "smithy.api#documentation": "

The interface protocol. Valid values are VLAN and GRE.

", + "smithy.api#xmlName": "interfaceProtocol" + } + }, + "VlanId": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "VlanId", + "smithy.api#documentation": "

The ID of the VLAN when you use the VLAN protocol.

", + "smithy.api#xmlName": "vlanId" + } + }, + "GreKey": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "GreKey", + "smithy.api#documentation": "

The application key when you use the GRE protocol.

", + "smithy.api#xmlName": "greKey" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags for the trunk interface association.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an association between a branch network interface with a trunk network interface.

" + } + }, + "com.amazonaws.ec2#TrunkInterfaceAssociationId": { + "type": "string" + }, + "com.amazonaws.ec2#TrunkInterfaceAssociationIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TrunkInterfaceAssociationId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TrunkInterfaceAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TrunkInterfaceAssociation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TrustProviderType": { + "type": "enum", + "members": { + "user": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "user" + } + }, + "device": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "device" + } + } + } + }, + "com.amazonaws.ec2#TunnelInsideIpVersion": { + "type": "enum", + "members": { + "ipv4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv4" + } + }, + "ipv6": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv6" + } + } + } + }, + "com.amazonaws.ec2#TunnelOption": { + "type": "structure", + "members": { + "OutsideIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OutsideIpAddress", + "smithy.api#documentation": "

The external IP address of the VPN tunnel.

", + "smithy.api#xmlName": "outsideIpAddress" + } + }, + "TunnelInsideCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TunnelInsideCidr", + "smithy.api#documentation": "

The range of inside IPv4 addresses for the tunnel.

", + "smithy.api#xmlName": "tunnelInsideCidr" + } + }, + "TunnelInsideIpv6Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TunnelInsideIpv6Cidr", + "smithy.api#documentation": "

The range of inside IPv6 addresses for the tunnel.

", + "smithy.api#xmlName": "tunnelInsideIpv6Cidr" + } + }, + "PreSharedKey": { + "target": "com.amazonaws.ec2#preSharedKey", + "traits": { + "aws.protocols#ec2QueryName": "PreSharedKey", + "smithy.api#documentation": "

The pre-shared key (PSK) to establish initial authentication between the virtual\n private gateway and the customer gateway.

", + "smithy.api#xmlName": "preSharedKey" + } + }, + "Phase1LifetimeSeconds": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Phase1LifetimeSeconds", + "smithy.api#documentation": "

The lifetime for phase 1 of the IKE negotiation, in seconds.

", + "smithy.api#xmlName": "phase1LifetimeSeconds" + } + }, + "Phase2LifetimeSeconds": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Phase2LifetimeSeconds", + "smithy.api#documentation": "

The lifetime for phase 2 of the IKE negotiation, in seconds.

", + "smithy.api#xmlName": "phase2LifetimeSeconds" + } + }, + "RekeyMarginTimeSeconds": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "RekeyMarginTimeSeconds", + "smithy.api#documentation": "

The margin time, in seconds, before the phase 2 lifetime expires, during which the\n Amazon Web Services side of the VPN connection performs an IKE rekey.

", + "smithy.api#xmlName": "rekeyMarginTimeSeconds" + } + }, + "RekeyFuzzPercentage": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "RekeyFuzzPercentage", + "smithy.api#documentation": "

The percentage of the rekey window determined by RekeyMarginTimeSeconds\n during which the rekey time is randomly selected.

", + "smithy.api#xmlName": "rekeyFuzzPercentage" + } + }, + "ReplayWindowSize": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "ReplayWindowSize", + "smithy.api#documentation": "

The number of packets in an IKE replay window.

", + "smithy.api#xmlName": "replayWindowSize" + } + }, + "DpdTimeoutSeconds": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "DpdTimeoutSeconds", + "smithy.api#documentation": "

The number of seconds after which a DPD timeout occurs.

", + "smithy.api#xmlName": "dpdTimeoutSeconds" + } + }, + "DpdTimeoutAction": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DpdTimeoutAction", + "smithy.api#documentation": "

The action to take after a DPD timeout occurs.

", + "smithy.api#xmlName": "dpdTimeoutAction" + } + }, + "Phase1EncryptionAlgorithms": { + "target": "com.amazonaws.ec2#Phase1EncryptionAlgorithmsList", + "traits": { + "aws.protocols#ec2QueryName": "Phase1EncryptionAlgorithmSet", + "smithy.api#documentation": "

The permitted encryption algorithms for the VPN tunnel for phase 1 IKE\n negotiations.

", + "smithy.api#xmlName": "phase1EncryptionAlgorithmSet" + } + }, + "Phase2EncryptionAlgorithms": { + "target": "com.amazonaws.ec2#Phase2EncryptionAlgorithmsList", + "traits": { + "aws.protocols#ec2QueryName": "Phase2EncryptionAlgorithmSet", + "smithy.api#documentation": "

The permitted encryption algorithms for the VPN tunnel for phase 2 IKE\n negotiations.

", + "smithy.api#xmlName": "phase2EncryptionAlgorithmSet" + } + }, + "Phase1IntegrityAlgorithms": { + "target": "com.amazonaws.ec2#Phase1IntegrityAlgorithmsList", + "traits": { + "aws.protocols#ec2QueryName": "Phase1IntegrityAlgorithmSet", + "smithy.api#documentation": "

The permitted integrity algorithms for the VPN tunnel for phase 1 IKE\n negotiations.

", + "smithy.api#xmlName": "phase1IntegrityAlgorithmSet" + } + }, + "Phase2IntegrityAlgorithms": { + "target": "com.amazonaws.ec2#Phase2IntegrityAlgorithmsList", + "traits": { + "aws.protocols#ec2QueryName": "Phase2IntegrityAlgorithmSet", + "smithy.api#documentation": "

The permitted integrity algorithms for the VPN tunnel for phase 2 IKE\n negotiations.

", + "smithy.api#xmlName": "phase2IntegrityAlgorithmSet" + } + }, + "Phase1DHGroupNumbers": { + "target": "com.amazonaws.ec2#Phase1DHGroupNumbersList", + "traits": { + "aws.protocols#ec2QueryName": "Phase1DHGroupNumberSet", + "smithy.api#documentation": "

The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE\n negotiations.

", + "smithy.api#xmlName": "phase1DHGroupNumberSet" + } + }, + "Phase2DHGroupNumbers": { + "target": "com.amazonaws.ec2#Phase2DHGroupNumbersList", + "traits": { + "aws.protocols#ec2QueryName": "Phase2DHGroupNumberSet", + "smithy.api#documentation": "

The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE\n negotiations.

", + "smithy.api#xmlName": "phase2DHGroupNumberSet" + } + }, + "IkeVersions": { + "target": "com.amazonaws.ec2#IKEVersionsList", + "traits": { + "aws.protocols#ec2QueryName": "IkeVersionSet", + "smithy.api#documentation": "

The IKE versions that are permitted for the VPN tunnel.

", + "smithy.api#xmlName": "ikeVersionSet" + } + }, + "StartupAction": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StartupAction", + "smithy.api#documentation": "

The action to take when the establishing the VPN tunnels for a VPN connection.

", + "smithy.api#xmlName": "startupAction" + } + }, + "LogOptions": { + "target": "com.amazonaws.ec2#VpnTunnelLogOptions", + "traits": { + "aws.protocols#ec2QueryName": "LogOptions", + "smithy.api#documentation": "

Options for logging VPN tunnel activity.

", + "smithy.api#xmlName": "logOptions" + } + }, + "EnableTunnelLifecycleControl": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EnableTunnelLifecycleControl", + "smithy.api#documentation": "

Status of tunnel endpoint lifecycle control feature.

", + "smithy.api#xmlName": "enableTunnelLifecycleControl" + } + } + }, + "traits": { + "smithy.api#documentation": "

The VPN tunnel options.

" + } + }, + "com.amazonaws.ec2#TunnelOptionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TunnelOption", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#UnassignIpv6Addresses": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#UnassignIpv6AddressesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#UnassignIpv6AddressesResult" + }, + "traits": { + "smithy.api#documentation": "

Unassigns one or more IPv6 addresses IPv4 Prefix Delegation prefixes from a network interface.

" + } + }, + "com.amazonaws.ec2#UnassignIpv6AddressesRequest": { + "type": "structure", + "members": { + "Ipv6Prefixes": { + "target": "com.amazonaws.ec2#IpPrefixList", + "traits": { + "smithy.api#documentation": "

The IPv6 prefixes to unassign from the network interface.

", + "smithy.api#xmlName": "Ipv6Prefix" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "Ipv6Addresses": { + "target": "com.amazonaws.ec2#Ipv6AddressList", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6Addresses", + "smithy.api#documentation": "

The IPv6 addresses to unassign from the network interface.

", + "smithy.api#xmlName": "ipv6Addresses" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#UnassignIpv6AddressesResult": { + "type": "structure", + "members": { + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "UnassignedIpv6Addresses": { + "target": "com.amazonaws.ec2#Ipv6AddressList", + "traits": { + "aws.protocols#ec2QueryName": "UnassignedIpv6Addresses", + "smithy.api#documentation": "

The IPv6 addresses that have been unassigned from the network interface.

", + "smithy.api#xmlName": "unassignedIpv6Addresses" + } + }, + "UnassignedIpv6Prefixes": { + "target": "com.amazonaws.ec2#IpPrefixList", + "traits": { + "aws.protocols#ec2QueryName": "UnassignedIpv6PrefixSet", + "smithy.api#documentation": "

The IPv4 prefixes that have been unassigned from the network interface.

", + "smithy.api#xmlName": "unassignedIpv6PrefixSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#UnassignPrivateIpAddresses": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#UnassignPrivateIpAddressesRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Unassigns one or more secondary private IP addresses, or IPv4 Prefix Delegation prefixes from a \n \tnetwork interface.

", + "smithy.api#examples": [ + { + "title": "To unassign a secondary private IP address from a network interface", + "documentation": "This example unassigns the specified private IP address from the specified network interface.", + "input": { + "NetworkInterfaceId": "eni-e5aa89a3", + "PrivateIpAddresses": [ + "10.0.0.82" + ] + } + } + ] + } + }, + "com.amazonaws.ec2#UnassignPrivateIpAddressesRequest": { + "type": "structure", + "members": { + "Ipv4Prefixes": { + "target": "com.amazonaws.ec2#IpPrefixList", + "traits": { + "smithy.api#documentation": "

The IPv4 prefixes to unassign from the network interface.

", + "smithy.api#xmlName": "Ipv4Prefix" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "PrivateIpAddresses": { + "target": "com.amazonaws.ec2#PrivateIpAddressStringList", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddress", + "smithy.api#documentation": "

The secondary private IP addresses to unassign from the network interface. You can specify this \n \toption multiple times to unassign more than one IP address.

", + "smithy.api#xmlName": "privateIpAddress" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for UnassignPrivateIpAddresses.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#UnassignPrivateNatGatewayAddress": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#UnassignPrivateNatGatewayAddressRequest" + }, + "output": { + "target": "com.amazonaws.ec2#UnassignPrivateNatGatewayAddressResult" + }, + "traits": { + "smithy.api#documentation": "

Unassigns secondary private IPv4 addresses from a private NAT gateway. You cannot unassign your primary private IP. For more information, \n see Edit secondary IP address associations \n in the Amazon VPC User Guide.

\n

While unassigning is in progress, you cannot assign/unassign additional IP addresses while the connections are being drained. You are, however, allowed to delete the NAT gateway.

\n

A private IP address will only be released at the end of MaxDrainDurationSeconds. The\n private IP addresses stay associated and support the existing connections, but do not\n support any new connections (new connections are distributed across the remaining\n assigned private IP address). After the existing connections drain out, the private IP\n addresses are released.

\n

\n

" + } + }, + "com.amazonaws.ec2#UnassignPrivateNatGatewayAddressRequest": { + "type": "structure", + "members": { + "NatGatewayId": { + "target": "com.amazonaws.ec2#NatGatewayId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the NAT gateway.

", + "smithy.api#required": {} + } + }, + "PrivateIpAddresses": { + "target": "com.amazonaws.ec2#IpList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The private IPv4 addresses you want to unassign.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "PrivateIpAddress" + } + }, + "MaxDrainDurationSeconds": { + "target": "com.amazonaws.ec2#DrainSeconds", + "traits": { + "smithy.api#documentation": "

The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress. Default value is 350 seconds.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#UnassignPrivateNatGatewayAddressResult": { + "type": "structure", + "members": { + "NatGatewayId": { + "target": "com.amazonaws.ec2#NatGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "NatGatewayId", + "smithy.api#documentation": "

The ID of the NAT gateway.

", + "smithy.api#xmlName": "natGatewayId" + } + }, + "NatGatewayAddresses": { + "target": "com.amazonaws.ec2#NatGatewayAddressList", + "traits": { + "aws.protocols#ec2QueryName": "NatGatewayAddressSet", + "smithy.api#documentation": "

Information about the NAT gateway IP addresses.

", + "smithy.api#xmlName": "natGatewayAddressSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#UnlimitedSupportedInstanceFamily": { + "type": "enum", + "members": { + "t2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t2" + } + }, + "t3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t3" + } + }, + "t3a": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t3a" + } + }, + "t4g": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t4g" + } + } + } + }, + "com.amazonaws.ec2#UnlockSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#UnlockSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.ec2#UnlockSnapshotResult" + }, + "traits": { + "smithy.api#documentation": "

Unlocks a snapshot that is locked in governance mode or that is locked in compliance mode \n but still in the cooling-off period. You can't unlock a snapshot that is locked in compliance \n mode after the cooling-off period has expired.

" + } + }, + "com.amazonaws.ec2#UnlockSnapshotRequest": { + "type": "structure", + "members": { + "SnapshotId": { + "target": "com.amazonaws.ec2#SnapshotId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the snapshot to unlock.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#UnlockSnapshotResult": { + "type": "structure", + "members": { + "SnapshotId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The ID of the snapshot.

", + "smithy.api#xmlName": "snapshotId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#UnmonitorInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#UnmonitorInstancesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#UnmonitorInstancesResult" + }, + "traits": { + "smithy.api#documentation": "

Disables detailed monitoring for a running instance. For more information, see Monitoring\n your instances and volumes in the\n Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#UnmonitorInstancesRequest": { + "type": "structure", + "members": { + "InstanceIds": { + "target": "com.amazonaws.ec2#InstanceIdStringList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the instances.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "InstanceId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#UnmonitorInstancesResult": { + "type": "structure", + "members": { + "InstanceMonitorings": { + "target": "com.amazonaws.ec2#InstanceMonitoringList", + "traits": { + "aws.protocols#ec2QueryName": "InstancesSet", + "smithy.api#documentation": "

The monitoring information.

", + "smithy.api#xmlName": "instancesSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#UnsuccessfulInstanceCreditSpecificationErrorCode": { + "type": "enum", + "members": { + "INVALID_INSTANCE_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidInstanceID.Malformed" + } + }, + "INSTANCE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidInstanceID.NotFound" + } + }, + "INCORRECT_INSTANCE_STATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IncorrectInstanceState" + } + }, + "INSTANCE_CREDIT_SPECIFICATION_NOT_SUPPORTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InstanceCreditSpecification.NotSupported" + } + } + } + }, + "com.amazonaws.ec2#UnsuccessfulInstanceCreditSpecificationItem": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#xmlName": "instanceId" + } + }, + "Error": { + "target": "com.amazonaws.ec2#UnsuccessfulInstanceCreditSpecificationItemError", + "traits": { + "aws.protocols#ec2QueryName": "Error", + "smithy.api#documentation": "

The applicable error for the burstable performance instance whose credit option for\n CPU usage was not modified.

", + "smithy.api#xmlName": "error" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the burstable performance instance whose credit option for CPU usage was not\n modified.

" + } + }, + "com.amazonaws.ec2#UnsuccessfulInstanceCreditSpecificationItemError": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#UnsuccessfulInstanceCreditSpecificationErrorCode", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The error code.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

The applicable error message.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the error for the burstable performance instance whose credit option\n for CPU usage was not modified.

" + } + }, + "com.amazonaws.ec2#UnsuccessfulInstanceCreditSpecificationSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#UnsuccessfulInstanceCreditSpecificationItem", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#UnsuccessfulItem": { + "type": "structure", + "members": { + "Error": { + "target": "com.amazonaws.ec2#UnsuccessfulItemError", + "traits": { + "aws.protocols#ec2QueryName": "Error", + "smithy.api#documentation": "

Information about the error.

", + "smithy.api#xmlName": "error" + } + }, + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The ID of the resource.

", + "smithy.api#xmlName": "resourceId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about items that were not successfully processed in a batch call.

" + } + }, + "com.amazonaws.ec2#UnsuccessfulItemError": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The error code.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

The error message accompanying the error code.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the error that occurred. For more information about errors, see Error codes.

" + } + }, + "com.amazonaws.ec2#UnsuccessfulItemList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#UnsuccessfulItem", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#UnsuccessfulItemSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#UnsuccessfulItem", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#UpdateSecurityGroupRuleDescriptionsEgress": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#UpdateSecurityGroupRuleDescriptionsEgressRequest" + }, + "output": { + "target": "com.amazonaws.ec2#UpdateSecurityGroupRuleDescriptionsEgressResult" + }, + "traits": { + "smithy.api#documentation": "

Updates the description of an egress (outbound) security group rule. You\n\t\t\tcan replace an existing description, or add a description to a rule that did not have one\n\t\t\tpreviously. You can remove a description for a security group rule by omitting the \n\t\t\tdescription parameter in the request.

", + "smithy.api#examples": [ + { + "title": "To update an outbound security group rule description", + "documentation": "This example updates the description for the specified security group rule.", + "input": { + "GroupId": "sg-123abc12", + "IpPermissions": [ + { + "IpProtocol": "tcp", + "FromPort": 80, + "ToPort": 80, + "IpRanges": [ + { + "CidrIp": "203.0.113.0/24", + "Description": "Outbound HTTP access to server 2" + } + ] + } + ] + }, + "output": {} + } + ] + } + }, + "com.amazonaws.ec2#UpdateSecurityGroupRuleDescriptionsEgressRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "GroupId": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "smithy.api#documentation": "

The ID of the security group. You must specify either the security group ID or the\n\t\t\tsecurity group name in the request. For security groups in a nondefault VPC, you must\n\t\t\tspecify the security group ID.

" + } + }, + "GroupName": { + "target": "com.amazonaws.ec2#SecurityGroupName", + "traits": { + "smithy.api#documentation": "

[Default VPC] The name of the security group. You must specify either the security group\n\t\t\tID or the security group name.

" + } + }, + "IpPermissions": { + "target": "com.amazonaws.ec2#IpPermissionList", + "traits": { + "smithy.api#documentation": "

The IP permissions for the security group rule. You must specify either the IP permissions\n\t\t or the description.

" + } + }, + "SecurityGroupRuleDescriptions": { + "target": "com.amazonaws.ec2#SecurityGroupRuleDescriptionList", + "traits": { + "smithy.api#documentation": "

The description for the egress security group rules. You must specify either the\n description or the IP permissions.

", + "smithy.api#xmlName": "SecurityGroupRuleDescription" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#UpdateSecurityGroupRuleDescriptionsEgressResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#UpdateSecurityGroupRuleDescriptionsIngress": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#UpdateSecurityGroupRuleDescriptionsIngressRequest" + }, + "output": { + "target": "com.amazonaws.ec2#UpdateSecurityGroupRuleDescriptionsIngressResult" + }, + "traits": { + "smithy.api#documentation": "

Updates the description of an ingress (inbound) security group rule. You can replace an\n\t\t\texisting description, or add a description to a rule that did not have one previously.\n\t\t You can remove a description for a security group rule by omitting the description \n\t\t parameter in the request.

", + "smithy.api#examples": [ + { + "title": "To update an inbound security group rule description", + "documentation": "This example updates the description for the specified security group rule.", + "input": { + "GroupId": "sg-123abc12", + "IpPermissions": [ + { + "IpProtocol": "tcp", + "FromPort": 22, + "ToPort": 22, + "IpRanges": [ + { + "CidrIp": "203.0.113.0/16", + "Description": "SSH access from the LA office" + } + ] + } + ] + }, + "output": {} + } + ] + } + }, + "com.amazonaws.ec2#UpdateSecurityGroupRuleDescriptionsIngressRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "GroupId": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "smithy.api#documentation": "

The ID of the security group. You must specify either the security group ID or the\n\t\t\tsecurity group name in the request. For security groups in a nondefault VPC, you must\n\t\t\tspecify the security group ID.

" + } + }, + "GroupName": { + "target": "com.amazonaws.ec2#SecurityGroupName", + "traits": { + "smithy.api#documentation": "

[Default VPC] The name of the security group. You must specify either the\n security group ID or the security group name. For security groups in a\n nondefault VPC, you must specify the security group ID.

" + } + }, + "IpPermissions": { + "target": "com.amazonaws.ec2#IpPermissionList", + "traits": { + "smithy.api#documentation": "

The IP permissions for the security group rule. You must specify either IP permissions\n\t\t or a description.

" + } + }, + "SecurityGroupRuleDescriptions": { + "target": "com.amazonaws.ec2#SecurityGroupRuleDescriptionList", + "traits": { + "smithy.api#documentation": "

The description for the ingress security group rules. You must specify either\n a description or IP permissions.

", + "smithy.api#xmlName": "SecurityGroupRuleDescription" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#UpdateSecurityGroupRuleDescriptionsIngressResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#UsageClassType": { + "type": "enum", + "members": { + "spot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "spot" + } + }, + "on_demand": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "on-demand" + } + }, + "capacity_block": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "capacity-block" + } + } + } + }, + "com.amazonaws.ec2#UsageClassTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#UsageClassType", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#UserBucket": { + "type": "structure", + "members": { + "S3Bucket": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon S3 bucket where the disk image is located.

" + } + }, + "S3Key": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The file name of the disk image.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the Amazon S3 bucket for the disk image.

" + } + }, + "com.amazonaws.ec2#UserBucketDetails": { + "type": "structure", + "members": { + "S3Bucket": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "S3Bucket", + "smithy.api#documentation": "

The Amazon S3 bucket from which the disk image was created.

", + "smithy.api#xmlName": "s3Bucket" + } + }, + "S3Key": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "S3Key", + "smithy.api#documentation": "

The file name of the disk image.

", + "smithy.api#xmlName": "s3Key" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the Amazon S3 bucket for the disk image.

" + } + }, + "com.amazonaws.ec2#UserData": { + "type": "structure", + "members": { + "Data": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Data", + "smithy.api#documentation": "

The user data. If you are using an Amazon Web Services SDK or command line tool, Base64-encoding is performed for you, and you\n can load the text from a file. Otherwise, you must provide Base64-encoded text.

", + "smithy.api#xmlName": "data" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the user data for an instance.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.ec2#UserGroupStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "UserGroup" + } + } + }, + "com.amazonaws.ec2#UserIdGroupPair": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description for the security group rule that references this user ID group\n\t\t\tpair.

\n

Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9,\n spaces, and ._-:/()#,@[]+=;{}!$*

", + "smithy.api#xmlName": "description" + } + }, + "UserId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "UserId", + "smithy.api#documentation": "

The ID of an Amazon Web Services account.

\n

For a referenced security group in another VPC, the account ID of the referenced\n security group is returned in the response. If the referenced security group is deleted,\n this value is not returned.

", + "smithy.api#xmlName": "userId" + } + }, + "GroupName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupName", + "smithy.api#documentation": "

[Default VPC] The name of the security group. For a security group in a nondefault VPC, \n use the security group ID.

\n

For a referenced security group in another VPC, this value is not returned if the\n referenced security group is deleted.

", + "smithy.api#xmlName": "groupName" + } + }, + "GroupId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupId", + "smithy.api#documentation": "

The ID of the security group.

", + "smithy.api#xmlName": "groupId" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC for the referenced security group, if applicable.

", + "smithy.api#xmlName": "vpcId" + } + }, + "VpcPeeringConnectionId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcPeeringConnectionId", + "smithy.api#documentation": "

The ID of the VPC peering connection, if applicable.

", + "smithy.api#xmlName": "vpcPeeringConnectionId" + } + }, + "PeeringStatus": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PeeringStatus", + "smithy.api#documentation": "

The status of a VPC peering connection, if applicable.

", + "smithy.api#xmlName": "peeringStatus" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a security group and Amazon Web Services account ID pair.

" + } + }, + "com.amazonaws.ec2#UserIdGroupPairList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#UserIdGroupPair", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#UserIdGroupPairSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#UserIdGroupPair", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#UserIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "UserId" + } + } + }, + "com.amazonaws.ec2#UserTrustProviderType": { + "type": "enum", + "members": { + "iam_identity_center": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "iam-identity-center" + } + }, + "oidc": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "oidc" + } + } + } + }, + "com.amazonaws.ec2#VCpuCount": { + "type": "integer" + }, + "com.amazonaws.ec2#VCpuCountRange": { + "type": "structure", + "members": { + "Min": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Min", + "smithy.api#documentation": "

The minimum number of vCPUs. If the value is 0, there is no minimum\n limit.

", + "smithy.api#xmlName": "min" + } + }, + "Max": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Max", + "smithy.api#documentation": "

The maximum number of vCPUs. If this parameter is not specified, there is no maximum\n limit.

", + "smithy.api#xmlName": "max" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum and maximum number of vCPUs.

" + } + }, + "com.amazonaws.ec2#VCpuCountRangeRequest": { + "type": "structure", + "members": { + "Min": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The minimum number of vCPUs. To specify no minimum limit, specify 0.

", + "smithy.api#required": {} + } + }, + "Max": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of vCPUs. To specify no maximum limit, omit this parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum and maximum number of vCPUs.

" + } + }, + "com.amazonaws.ec2#VCpuInfo": { + "type": "structure", + "members": { + "DefaultVCpus": { + "target": "com.amazonaws.ec2#VCpuCount", + "traits": { + "aws.protocols#ec2QueryName": "DefaultVCpus", + "smithy.api#documentation": "

The default number of vCPUs for the instance type.

", + "smithy.api#xmlName": "defaultVCpus" + } + }, + "DefaultCores": { + "target": "com.amazonaws.ec2#CoreCount", + "traits": { + "aws.protocols#ec2QueryName": "DefaultCores", + "smithy.api#documentation": "

The default number of cores for the instance type.

", + "smithy.api#xmlName": "defaultCores" + } + }, + "DefaultThreadsPerCore": { + "target": "com.amazonaws.ec2#ThreadsPerCore", + "traits": { + "aws.protocols#ec2QueryName": "DefaultThreadsPerCore", + "smithy.api#documentation": "

The default number of threads per core for the instance type.

", + "smithy.api#xmlName": "defaultThreadsPerCore" + } + }, + "ValidCores": { + "target": "com.amazonaws.ec2#CoreCountList", + "traits": { + "aws.protocols#ec2QueryName": "ValidCores", + "smithy.api#documentation": "

The valid number of cores that can be configured for the instance type.

", + "smithy.api#xmlName": "validCores" + } + }, + "ValidThreadsPerCore": { + "target": "com.amazonaws.ec2#ThreadsPerCoreList", + "traits": { + "aws.protocols#ec2QueryName": "ValidThreadsPerCore", + "smithy.api#documentation": "

The valid number of threads per core that can be configured for the instance type.

", + "smithy.api#xmlName": "validThreadsPerCore" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the vCPU configurations for the instance type.

" + } + }, + "com.amazonaws.ec2#ValidationError": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The error code that indicates why the parameter or parameter combination is not valid.\n For more information about error codes, see Error codes.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

The error message that describes why the parameter or parameter combination is not\n valid. For more information about error messages, see Error codes.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

The error code and error message that is returned for a parameter or parameter\n combination that is not valid when a new launch template or new version of a launch\n template is created.

" + } + }, + "com.amazonaws.ec2#ValidationWarning": { + "type": "structure", + "members": { + "Errors": { + "target": "com.amazonaws.ec2#ErrorSet", + "traits": { + "aws.protocols#ec2QueryName": "ErrorSet", + "smithy.api#documentation": "

The error codes and error messages.

", + "smithy.api#xmlName": "errorSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

The error codes and error messages that are returned for the parameters or parameter\n combinations that are not valid when a new launch template or new version of a launch\n template is created.

" + } + }, + "com.amazonaws.ec2#ValueStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VerificationMethod": { + "type": "enum", + "members": { + "remarks_x509": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "remarks-x509" + } + }, + "dns_token": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dns-token" + } + } + } + }, + "com.amazonaws.ec2#VerifiedAccessEndpoint": { + "type": "structure", + "members": { + "VerifiedAccessInstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessInstanceId", + "smithy.api#documentation": "

The ID of the Amazon Web Services Verified Access instance.

", + "smithy.api#xmlName": "verifiedAccessInstanceId" + } + }, + "VerifiedAccessGroupId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessGroupId", + "smithy.api#documentation": "

The ID of the Amazon Web Services Verified Access group.

", + "smithy.api#xmlName": "verifiedAccessGroupId" + } + }, + "VerifiedAccessEndpointId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessEndpointId", + "smithy.api#documentation": "

The ID of the Amazon Web Services Verified Access endpoint.

", + "smithy.api#xmlName": "verifiedAccessEndpointId" + } + }, + "ApplicationDomain": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ApplicationDomain", + "smithy.api#documentation": "

The DNS name for users to reach your application.

", + "smithy.api#xmlName": "applicationDomain" + } + }, + "EndpointType": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointType", + "traits": { + "aws.protocols#ec2QueryName": "EndpointType", + "smithy.api#documentation": "

The type of Amazon Web Services Verified Access endpoint. Incoming application requests will be sent to an IP\n address, load balancer or a network interface depending on the endpoint type\n specified.

", + "smithy.api#xmlName": "endpointType" + } + }, + "AttachmentType": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointAttachmentType", + "traits": { + "aws.protocols#ec2QueryName": "AttachmentType", + "smithy.api#documentation": "

The type of attachment used to provide connectivity between the Amazon Web Services Verified Access endpoint and the\n application.

", + "smithy.api#xmlName": "attachmentType" + } + }, + "DomainCertificateArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DomainCertificateArn", + "smithy.api#documentation": "

The ARN of a public TLS/SSL certificate imported into or created with ACM.

", + "smithy.api#xmlName": "domainCertificateArn" + } + }, + "EndpointDomain": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "EndpointDomain", + "smithy.api#documentation": "

A DNS name that is generated for the endpoint.

", + "smithy.api#xmlName": "endpointDomain" + } + }, + "DeviceValidationDomain": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DeviceValidationDomain", + "smithy.api#documentation": "

Returned if endpoint has a device trust provider attached.

", + "smithy.api#xmlName": "deviceValidationDomain" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.ec2#SecurityGroupIdList", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroupIdSet", + "smithy.api#documentation": "

The IDs of the security groups for the endpoint.

", + "smithy.api#xmlName": "securityGroupIdSet" + } + }, + "LoadBalancerOptions": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointLoadBalancerOptions", + "traits": { + "aws.protocols#ec2QueryName": "LoadBalancerOptions", + "smithy.api#documentation": "

The load balancer details if creating the Amazon Web Services Verified Access endpoint as\n load-balancertype.

", + "smithy.api#xmlName": "loadBalancerOptions" + } + }, + "NetworkInterfaceOptions": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointEniOptions", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceOptions", + "smithy.api#documentation": "

The options for network-interface type endpoint.

", + "smithy.api#xmlName": "networkInterfaceOptions" + } + }, + "Status": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The endpoint status.

", + "smithy.api#xmlName": "status" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description for the Amazon Web Services Verified Access endpoint.

", + "smithy.api#xmlName": "description" + } + }, + "CreationTime": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CreationTime", + "smithy.api#documentation": "

The creation time.

", + "smithy.api#xmlName": "creationTime" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LastUpdatedTime", + "smithy.api#documentation": "

The last updated time.

", + "smithy.api#xmlName": "lastUpdatedTime" + } + }, + "DeletionTime": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DeletionTime", + "smithy.api#documentation": "

The deletion time.

", + "smithy.api#xmlName": "deletionTime" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags.

", + "smithy.api#xmlName": "tagSet" + } + }, + "SseSpecification": { + "target": "com.amazonaws.ec2#VerifiedAccessSseSpecificationResponse", + "traits": { + "aws.protocols#ec2QueryName": "SseSpecification", + "smithy.api#documentation": "

The options in use for server side encryption.

", + "smithy.api#xmlName": "sseSpecification" + } + }, + "RdsOptions": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointRdsOptions", + "traits": { + "aws.protocols#ec2QueryName": "RdsOptions", + "smithy.api#documentation": "

The options for an RDS endpoint.

", + "smithy.api#xmlName": "rdsOptions" + } + }, + "CidrOptions": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointCidrOptions", + "traits": { + "aws.protocols#ec2QueryName": "CidrOptions", + "smithy.api#documentation": "

The options for a CIDR endpoint.

", + "smithy.api#xmlName": "cidrOptions" + } + } + }, + "traits": { + "smithy.api#documentation": "

An Amazon Web Services Verified Access endpoint specifies the application that Amazon Web Services Verified Access provides access to. It must be\n attached to an Amazon Web Services Verified Access group. An Amazon Web Services Verified Access endpoint must also have an attached access policy\n before you attached it to a group.

" + } + }, + "com.amazonaws.ec2#VerifiedAccessEndpointAttachmentType": { + "type": "enum", + "members": { + "vpc": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vpc" + } + } + } + }, + "com.amazonaws.ec2#VerifiedAccessEndpointCidrOptions": { + "type": "structure", + "members": { + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Cidr", + "smithy.api#documentation": "

The CIDR.

", + "smithy.api#xmlName": "cidr" + } + }, + "PortRanges": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointPortRangeList", + "traits": { + "aws.protocols#ec2QueryName": "PortRangeSet", + "smithy.api#documentation": "

The port ranges.

", + "smithy.api#xmlName": "portRangeSet" + } + }, + "Protocol": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointProtocol", + "traits": { + "aws.protocols#ec2QueryName": "Protocol", + "smithy.api#documentation": "

The protocol.

", + "smithy.api#xmlName": "protocol" + } + }, + "SubnetIds": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointSubnetIdList", + "traits": { + "aws.protocols#ec2QueryName": "SubnetIdSet", + "smithy.api#documentation": "

The IDs of the subnets.

", + "smithy.api#xmlName": "subnetIdSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the CIDR options for a Verified Access endpoint.

" + } + }, + "com.amazonaws.ec2#VerifiedAccessEndpointEniOptions": { + "type": "structure", + "members": { + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "Protocol": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointProtocol", + "traits": { + "aws.protocols#ec2QueryName": "Protocol", + "smithy.api#documentation": "

The IP protocol.

", + "smithy.api#xmlName": "protocol" + } + }, + "Port": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointPortNumber", + "traits": { + "aws.protocols#ec2QueryName": "Port", + "smithy.api#documentation": "

The IP port number.

", + "smithy.api#xmlName": "port" + } + }, + "PortRanges": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointPortRangeList", + "traits": { + "aws.protocols#ec2QueryName": "PortRangeSet", + "smithy.api#documentation": "

The port ranges.

", + "smithy.api#xmlName": "portRangeSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Options for a network-interface type endpoint.

" + } + }, + "com.amazonaws.ec2#VerifiedAccessEndpointId": { + "type": "string" + }, + "com.amazonaws.ec2#VerifiedAccessEndpointIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VerifiedAccessEndpointList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpoint", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VerifiedAccessEndpointLoadBalancerOptions": { + "type": "structure", + "members": { + "Protocol": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointProtocol", + "traits": { + "aws.protocols#ec2QueryName": "Protocol", + "smithy.api#documentation": "

The IP protocol.

", + "smithy.api#xmlName": "protocol" + } + }, + "Port": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointPortNumber", + "traits": { + "aws.protocols#ec2QueryName": "Port", + "smithy.api#documentation": "

The IP port number.

", + "smithy.api#xmlName": "port" + } + }, + "LoadBalancerArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LoadBalancerArn", + "smithy.api#documentation": "

The ARN of the load balancer.

", + "smithy.api#xmlName": "loadBalancerArn" + } + }, + "SubnetIds": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointSubnetIdList", + "traits": { + "aws.protocols#ec2QueryName": "SubnetIdSet", + "smithy.api#documentation": "

The IDs of the subnets.

", + "smithy.api#xmlName": "subnetIdSet" + } + }, + "PortRanges": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointPortRangeList", + "traits": { + "aws.protocols#ec2QueryName": "PortRangeSet", + "smithy.api#documentation": "

The port ranges.

", + "smithy.api#xmlName": "portRangeSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a load balancer when creating an Amazon Web Services Verified Access endpoint using the\n load-balancer type.

" + } + }, + "com.amazonaws.ec2#VerifiedAccessEndpointPortNumber": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 65535 + } + } + }, + "com.amazonaws.ec2#VerifiedAccessEndpointPortRange": { + "type": "structure", + "members": { + "FromPort": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointPortNumber", + "traits": { + "aws.protocols#ec2QueryName": "FromPort", + "smithy.api#documentation": "

The start of the port range.

", + "smithy.api#xmlName": "fromPort" + } + }, + "ToPort": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointPortNumber", + "traits": { + "aws.protocols#ec2QueryName": "ToPort", + "smithy.api#documentation": "

The end of the port range.

", + "smithy.api#xmlName": "toPort" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a port range.

" + } + }, + "com.amazonaws.ec2#VerifiedAccessEndpointPortRangeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointPortRange", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VerifiedAccessEndpointProtocol": { + "type": "enum", + "members": { + "http": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "http" + } + }, + "https": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "https" + } + }, + "tcp": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "tcp" + } + } + } + }, + "com.amazonaws.ec2#VerifiedAccessEndpointRdsOptions": { + "type": "structure", + "members": { + "Protocol": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointProtocol", + "traits": { + "aws.protocols#ec2QueryName": "Protocol", + "smithy.api#documentation": "

The protocol.

", + "smithy.api#xmlName": "protocol" + } + }, + "Port": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointPortNumber", + "traits": { + "aws.protocols#ec2QueryName": "Port", + "smithy.api#documentation": "

The port.

", + "smithy.api#xmlName": "port" + } + }, + "RdsDbInstanceArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RdsDbInstanceArn", + "smithy.api#documentation": "

The ARN of the RDS instance.

", + "smithy.api#xmlName": "rdsDbInstanceArn" + } + }, + "RdsDbClusterArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RdsDbClusterArn", + "smithy.api#documentation": "

The ARN of the DB cluster.

", + "smithy.api#xmlName": "rdsDbClusterArn" + } + }, + "RdsDbProxyArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RdsDbProxyArn", + "smithy.api#documentation": "

The ARN of the RDS proxy.

", + "smithy.api#xmlName": "rdsDbProxyArn" + } + }, + "RdsEndpoint": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RdsEndpoint", + "smithy.api#documentation": "

The RDS endpoint.

", + "smithy.api#xmlName": "rdsEndpoint" + } + }, + "SubnetIds": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointSubnetIdList", + "traits": { + "aws.protocols#ec2QueryName": "SubnetIdSet", + "smithy.api#documentation": "

The IDs of the subnets.

", + "smithy.api#xmlName": "subnetIdSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the RDS options for a Verified Access endpoint.

" + } + }, + "com.amazonaws.ec2#VerifiedAccessEndpointStatus": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointStatusCode", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The status code of the Verified Access endpoint.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

The status message of the Verified Access endpoint.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the status of a Verified Access endpoint.

" + } + }, + "com.amazonaws.ec2#VerifiedAccessEndpointStatusCode": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "updating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "updating" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + }, + "deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted" + } + } + } + }, + "com.amazonaws.ec2#VerifiedAccessEndpointSubnetIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VerifiedAccessEndpointTarget": { + "type": "structure", + "members": { + "VerifiedAccessEndpointId": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointId", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessEndpointId", + "smithy.api#documentation": "

The ID of the Verified Access endpoint.

", + "smithy.api#xmlName": "verifiedAccessEndpointId" + } + }, + "VerifiedAccessEndpointTargetIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessEndpointTargetIpAddress", + "smithy.api#documentation": "

The IP address of the target.

", + "smithy.api#xmlName": "verifiedAccessEndpointTargetIpAddress" + } + }, + "VerifiedAccessEndpointTargetDns": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessEndpointTargetDns", + "smithy.api#documentation": "

The DNS name of the target.

", + "smithy.api#xmlName": "verifiedAccessEndpointTargetDns" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the targets for the specified Verified Access endpoint.

" + } + }, + "com.amazonaws.ec2#VerifiedAccessEndpointTargetList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointTarget", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VerifiedAccessEndpointType": { + "type": "enum", + "members": { + "load_balancer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "load-balancer" + } + }, + "network_interface": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "network-interface" + } + }, + "rds": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rds" + } + }, + "cidr": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cidr" + } + } + } + }, + "com.amazonaws.ec2#VerifiedAccessGroup": { + "type": "structure", + "members": { + "VerifiedAccessGroupId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessGroupId", + "smithy.api#documentation": "

The ID of the Verified Access group.

", + "smithy.api#xmlName": "verifiedAccessGroupId" + } + }, + "VerifiedAccessInstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessInstanceId", + "smithy.api#documentation": "

The ID of the Amazon Web Services Verified Access instance.

", + "smithy.api#xmlName": "verifiedAccessInstanceId" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description for the Amazon Web Services Verified Access group.

", + "smithy.api#xmlName": "description" + } + }, + "Owner": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Owner", + "smithy.api#documentation": "

The Amazon Web Services account number that owns the group.

", + "smithy.api#xmlName": "owner" + } + }, + "VerifiedAccessGroupArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessGroupArn", + "smithy.api#documentation": "

The ARN of the Verified Access group.

", + "smithy.api#xmlName": "verifiedAccessGroupArn" + } + }, + "CreationTime": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CreationTime", + "smithy.api#documentation": "

The creation time.

", + "smithy.api#xmlName": "creationTime" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LastUpdatedTime", + "smithy.api#documentation": "

The last updated time.

", + "smithy.api#xmlName": "lastUpdatedTime" + } + }, + "DeletionTime": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DeletionTime", + "smithy.api#documentation": "

The deletion time.

", + "smithy.api#xmlName": "deletionTime" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags.

", + "smithy.api#xmlName": "tagSet" + } + }, + "SseSpecification": { + "target": "com.amazonaws.ec2#VerifiedAccessSseSpecificationResponse", + "traits": { + "aws.protocols#ec2QueryName": "SseSpecification", + "smithy.api#documentation": "

The options in use for server side encryption.

", + "smithy.api#xmlName": "sseSpecification" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Verified Access group.

" + } + }, + "com.amazonaws.ec2#VerifiedAccessGroupId": { + "type": "string" + }, + "com.amazonaws.ec2#VerifiedAccessGroupIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VerifiedAccessGroupId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VerifiedAccessGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VerifiedAccessGroup", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VerifiedAccessInstance": { + "type": "structure", + "members": { + "VerifiedAccessInstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessInstanceId", + "smithy.api#documentation": "

The ID of the Amazon Web Services Verified Access instance.

", + "smithy.api#xmlName": "verifiedAccessInstanceId" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description for the Amazon Web Services Verified Access instance.

", + "smithy.api#xmlName": "description" + } + }, + "VerifiedAccessTrustProviders": { + "target": "com.amazonaws.ec2#VerifiedAccessTrustProviderCondensedList", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessTrustProviderSet", + "smithy.api#documentation": "

The IDs of the Amazon Web Services Verified Access trust providers.

", + "smithy.api#xmlName": "verifiedAccessTrustProviderSet" + } + }, + "CreationTime": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CreationTime", + "smithy.api#documentation": "

The creation time.

", + "smithy.api#xmlName": "creationTime" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LastUpdatedTime", + "smithy.api#documentation": "

The last updated time.

", + "smithy.api#xmlName": "lastUpdatedTime" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags.

", + "smithy.api#xmlName": "tagSet" + } + }, + "FipsEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "FipsEnabled", + "smithy.api#documentation": "

Indicates whether support for Federal Information Processing Standards (FIPS) is enabled on the instance.

", + "smithy.api#xmlName": "fipsEnabled" + } + }, + "CidrEndpointsCustomSubDomain": { + "target": "com.amazonaws.ec2#VerifiedAccessInstanceCustomSubDomain", + "traits": { + "aws.protocols#ec2QueryName": "CidrEndpointsCustomSubDomain", + "smithy.api#documentation": "

The custom subdomain.

", + "smithy.api#xmlName": "cidrEndpointsCustomSubDomain" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Verified Access instance.

" + } + }, + "com.amazonaws.ec2#VerifiedAccessInstanceCustomSubDomain": { + "type": "structure", + "members": { + "SubDomain": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SubDomain", + "smithy.api#documentation": "

The subdomain.

", + "smithy.api#xmlName": "subDomain" + } + }, + "Nameservers": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "NameserverSet", + "smithy.api#documentation": "

The name servers.

", + "smithy.api#xmlName": "nameserverSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a custom subdomain for a network CIDR endpoint for Verified Access.

" + } + }, + "com.amazonaws.ec2#VerifiedAccessInstanceId": { + "type": "string" + }, + "com.amazonaws.ec2#VerifiedAccessInstanceIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VerifiedAccessInstanceId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VerifiedAccessInstanceList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VerifiedAccessInstance", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VerifiedAccessInstanceLoggingConfiguration": { + "type": "structure", + "members": { + "VerifiedAccessInstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessInstanceId", + "smithy.api#documentation": "

The ID of the Amazon Web Services Verified Access instance.

", + "smithy.api#xmlName": "verifiedAccessInstanceId" + } + }, + "AccessLogs": { + "target": "com.amazonaws.ec2#VerifiedAccessLogs", + "traits": { + "aws.protocols#ec2QueryName": "AccessLogs", + "smithy.api#documentation": "

Details about the logging options.

", + "smithy.api#xmlName": "accessLogs" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes logging options for an Amazon Web Services Verified Access instance.

" + } + }, + "com.amazonaws.ec2#VerifiedAccessInstanceLoggingConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VerifiedAccessInstanceLoggingConfiguration", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VerifiedAccessInstanceOpenVpnClientConfiguration": { + "type": "structure", + "members": { + "Config": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Config", + "smithy.api#documentation": "

The base64-encoded Open VPN client configuration.

", + "smithy.api#xmlName": "config" + } + }, + "Routes": { + "target": "com.amazonaws.ec2#VerifiedAccessInstanceOpenVpnClientConfigurationRouteList", + "traits": { + "aws.protocols#ec2QueryName": "RouteSet", + "smithy.api#documentation": "

The routes.

", + "smithy.api#xmlName": "routeSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a set of routes.

" + } + }, + "com.amazonaws.ec2#VerifiedAccessInstanceOpenVpnClientConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VerifiedAccessInstanceOpenVpnClientConfiguration", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VerifiedAccessInstanceOpenVpnClientConfigurationRoute": { + "type": "structure", + "members": { + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Cidr", + "smithy.api#documentation": "

The CIDR block.

", + "smithy.api#xmlName": "cidr" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a route.

" + } + }, + "com.amazonaws.ec2#VerifiedAccessInstanceOpenVpnClientConfigurationRouteList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VerifiedAccessInstanceOpenVpnClientConfigurationRoute", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VerifiedAccessInstanceUserTrustProviderClientConfiguration": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.ec2#UserTrustProviderType", + "traits": { + "aws.protocols#ec2QueryName": "Type", + "smithy.api#documentation": "

The trust provider type.

", + "smithy.api#xmlName": "type" + } + }, + "Scopes": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Scopes", + "smithy.api#documentation": "

The set of user claims to be requested from the IdP.

", + "smithy.api#xmlName": "scopes" + } + }, + "Issuer": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Issuer", + "smithy.api#documentation": "

The OIDC issuer identifier of the IdP.

", + "smithy.api#xmlName": "issuer" + } + }, + "AuthorizationEndpoint": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AuthorizationEndpoint", + "smithy.api#documentation": "

The authorization endpoint of the IdP.

", + "smithy.api#xmlName": "authorizationEndpoint" + } + }, + "PublicSigningKeyEndpoint": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicSigningKeyEndpoint", + "smithy.api#documentation": "

The public signing key endpoint.

", + "smithy.api#xmlName": "publicSigningKeyEndpoint" + } + }, + "TokenEndpoint": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TokenEndpoint", + "smithy.api#documentation": "

The token endpoint of the IdP.

", + "smithy.api#xmlName": "tokenEndpoint" + } + }, + "UserInfoEndpoint": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "UserInfoEndpoint", + "smithy.api#documentation": "

The user info endpoint of the IdP.

", + "smithy.api#xmlName": "userInfoEndpoint" + } + }, + "ClientId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientId", + "smithy.api#documentation": "

The OAuth 2.0 client identifier.

", + "smithy.api#xmlName": "clientId" + } + }, + "ClientSecret": { + "target": "com.amazonaws.ec2#ClientSecretType", + "traits": { + "aws.protocols#ec2QueryName": "ClientSecret", + "smithy.api#documentation": "

The OAuth 2.0 client secret.

", + "smithy.api#xmlName": "clientSecret" + } + }, + "PkceEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "PkceEnabled", + "smithy.api#documentation": "

Indicates whether Proof of Key Code Exchange (PKCE) is enabled.

", + "smithy.api#xmlName": "pkceEnabled" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the trust provider.

" + } + }, + "com.amazonaws.ec2#VerifiedAccessLogCloudWatchLogsDestination": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Enabled", + "smithy.api#documentation": "

Indicates whether logging is enabled.

", + "smithy.api#xmlName": "enabled" + } + }, + "DeliveryStatus": { + "target": "com.amazonaws.ec2#VerifiedAccessLogDeliveryStatus", + "traits": { + "aws.protocols#ec2QueryName": "DeliveryStatus", + "smithy.api#documentation": "

The delivery status for access logs.

", + "smithy.api#xmlName": "deliveryStatus" + } + }, + "LogGroup": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LogGroup", + "smithy.api#documentation": "

The ID of the CloudWatch Logs log group.

", + "smithy.api#xmlName": "logGroup" + } + } + }, + "traits": { + "smithy.api#documentation": "

Options for CloudWatch Logs as a logging destination.

" + } + }, + "com.amazonaws.ec2#VerifiedAccessLogCloudWatchLogsDestinationOptions": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Indicates whether logging is enabled.

", + "smithy.api#required": {} + } + }, + "LogGroup": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ID of the CloudWatch Logs log group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Options for CloudWatch Logs as a logging destination.

" + } + }, + "com.amazonaws.ec2#VerifiedAccessLogDeliveryStatus": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#VerifiedAccessLogDeliveryStatusCode", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The status code.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

The status message.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a log delivery status.

" + } + }, + "com.amazonaws.ec2#VerifiedAccessLogDeliveryStatusCode": { + "type": "enum", + "members": { + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "success" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + } + } + }, + "com.amazonaws.ec2#VerifiedAccessLogKinesisDataFirehoseDestination": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Enabled", + "smithy.api#documentation": "

Indicates whether logging is enabled.

", + "smithy.api#xmlName": "enabled" + } + }, + "DeliveryStatus": { + "target": "com.amazonaws.ec2#VerifiedAccessLogDeliveryStatus", + "traits": { + "aws.protocols#ec2QueryName": "DeliveryStatus", + "smithy.api#documentation": "

The delivery status.

", + "smithy.api#xmlName": "deliveryStatus" + } + }, + "DeliveryStream": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DeliveryStream", + "smithy.api#documentation": "

The ID of the delivery stream.

", + "smithy.api#xmlName": "deliveryStream" + } + } + }, + "traits": { + "smithy.api#documentation": "

Options for Kinesis as a logging destination.

" + } + }, + "com.amazonaws.ec2#VerifiedAccessLogKinesisDataFirehoseDestinationOptions": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Indicates whether logging is enabled.

", + "smithy.api#required": {} + } + }, + "DeliveryStream": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ID of the delivery stream.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes Amazon Kinesis Data Firehose logging options.

" + } + }, + "com.amazonaws.ec2#VerifiedAccessLogOptions": { + "type": "structure", + "members": { + "S3": { + "target": "com.amazonaws.ec2#VerifiedAccessLogS3DestinationOptions", + "traits": { + "smithy.api#documentation": "

Sends Verified Access logs to Amazon S3.

" + } + }, + "CloudWatchLogs": { + "target": "com.amazonaws.ec2#VerifiedAccessLogCloudWatchLogsDestinationOptions", + "traits": { + "smithy.api#documentation": "

Sends Verified Access logs to CloudWatch Logs.

" + } + }, + "KinesisDataFirehose": { + "target": "com.amazonaws.ec2#VerifiedAccessLogKinesisDataFirehoseDestinationOptions", + "traits": { + "smithy.api#documentation": "

Sends Verified Access logs to Kinesis.

" + } + }, + "LogVersion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The logging version.

\n

Valid values: ocsf-0.1 | ocsf-1.0.0-rc.2\n

" + } + }, + "IncludeTrustContext": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether to include trust data sent by trust providers in the logs.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Options for Verified Access logs.

" + } + }, + "com.amazonaws.ec2#VerifiedAccessLogS3Destination": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Enabled", + "smithy.api#documentation": "

Indicates whether logging is enabled.

", + "smithy.api#xmlName": "enabled" + } + }, + "DeliveryStatus": { + "target": "com.amazonaws.ec2#VerifiedAccessLogDeliveryStatus", + "traits": { + "aws.protocols#ec2QueryName": "DeliveryStatus", + "smithy.api#documentation": "

The delivery status.

", + "smithy.api#xmlName": "deliveryStatus" + } + }, + "BucketName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "BucketName", + "smithy.api#documentation": "

The bucket name.

", + "smithy.api#xmlName": "bucketName" + } + }, + "Prefix": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Prefix", + "smithy.api#documentation": "

The bucket prefix.

", + "smithy.api#xmlName": "prefix" + } + }, + "BucketOwner": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "BucketOwner", + "smithy.api#documentation": "

The Amazon Web Services account number that owns the bucket.

", + "smithy.api#xmlName": "bucketOwner" + } + } + }, + "traits": { + "smithy.api#documentation": "

Options for Amazon S3 as a logging destination.

" + } + }, + "com.amazonaws.ec2#VerifiedAccessLogS3DestinationOptions": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Indicates whether logging is enabled.

", + "smithy.api#required": {} + } + }, + "BucketName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The bucket name.

" + } + }, + "Prefix": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The bucket prefix.

" + } + }, + "BucketOwner": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the Amazon S3 bucket.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Options for Amazon S3 as a logging destination.

" + } + }, + "com.amazonaws.ec2#VerifiedAccessLogs": { + "type": "structure", + "members": { + "S3": { + "target": "com.amazonaws.ec2#VerifiedAccessLogS3Destination", + "traits": { + "aws.protocols#ec2QueryName": "S3", + "smithy.api#documentation": "

Amazon S3 logging options.

", + "smithy.api#xmlName": "s3" + } + }, + "CloudWatchLogs": { + "target": "com.amazonaws.ec2#VerifiedAccessLogCloudWatchLogsDestination", + "traits": { + "aws.protocols#ec2QueryName": "CloudWatchLogs", + "smithy.api#documentation": "

CloudWatch Logs logging destination.

", + "smithy.api#xmlName": "cloudWatchLogs" + } + }, + "KinesisDataFirehose": { + "target": "com.amazonaws.ec2#VerifiedAccessLogKinesisDataFirehoseDestination", + "traits": { + "aws.protocols#ec2QueryName": "KinesisDataFirehose", + "smithy.api#documentation": "

Kinesis logging destination.

", + "smithy.api#xmlName": "kinesisDataFirehose" + } + }, + "LogVersion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LogVersion", + "smithy.api#documentation": "

The log version.

", + "smithy.api#xmlName": "logVersion" + } + }, + "IncludeTrustContext": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "IncludeTrustContext", + "smithy.api#documentation": "

Indicates whether trust data is included in the logs.

", + "smithy.api#xmlName": "includeTrustContext" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the options for Verified Access logs.

" + } + }, + "com.amazonaws.ec2#VerifiedAccessSseSpecificationRequest": { + "type": "structure", + "members": { + "CustomerManagedKeyEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

\n Enable or disable the use of customer managed KMS keys for server side encryption.\n

\n

Valid values: True | False\n

" + } + }, + "KmsKeyArn": { + "target": "com.amazonaws.ec2#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

\n The ARN of the KMS key.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Verified Access provides server side encryption by default to data at rest using Amazon Web Services-owned KMS keys. You also have the option of using customer managed KMS keys, which can be specified using the options below. \n

" + } + }, + "com.amazonaws.ec2#VerifiedAccessSseSpecificationResponse": { + "type": "structure", + "members": { + "CustomerManagedKeyEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "CustomerManagedKeyEnabled", + "smithy.api#documentation": "

Indicates whether customer managed KMS keys are in use for server side encryption.

\n

Valid values: True | False\n

", + "smithy.api#xmlName": "customerManagedKeyEnabled" + } + }, + "KmsKeyArn": { + "target": "com.amazonaws.ec2#KmsKeyArn", + "traits": { + "aws.protocols#ec2QueryName": "KmsKeyArn", + "smithy.api#documentation": "

The ARN of the KMS key.

", + "smithy.api#xmlName": "kmsKeyArn" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options in use for server side encryption.

" + } + }, + "com.amazonaws.ec2#VerifiedAccessTrustProvider": { + "type": "structure", + "members": { + "VerifiedAccessTrustProviderId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessTrustProviderId", + "smithy.api#documentation": "

The ID of the Amazon Web Services Verified Access trust provider.

", + "smithy.api#xmlName": "verifiedAccessTrustProviderId" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description for the Amazon Web Services Verified Access trust provider.

", + "smithy.api#xmlName": "description" + } + }, + "TrustProviderType": { + "target": "com.amazonaws.ec2#TrustProviderType", + "traits": { + "aws.protocols#ec2QueryName": "TrustProviderType", + "smithy.api#documentation": "

The type of Verified Access trust provider.

", + "smithy.api#xmlName": "trustProviderType" + } + }, + "UserTrustProviderType": { + "target": "com.amazonaws.ec2#UserTrustProviderType", + "traits": { + "aws.protocols#ec2QueryName": "UserTrustProviderType", + "smithy.api#documentation": "

The type of user-based trust provider.

", + "smithy.api#xmlName": "userTrustProviderType" + } + }, + "DeviceTrustProviderType": { + "target": "com.amazonaws.ec2#DeviceTrustProviderType", + "traits": { + "aws.protocols#ec2QueryName": "DeviceTrustProviderType", + "smithy.api#documentation": "

The type of device-based trust provider.

", + "smithy.api#xmlName": "deviceTrustProviderType" + } + }, + "OidcOptions": { + "target": "com.amazonaws.ec2#OidcOptions", + "traits": { + "aws.protocols#ec2QueryName": "OidcOptions", + "smithy.api#documentation": "

The options for an OpenID Connect-compatible user-identity trust provider.

", + "smithy.api#xmlName": "oidcOptions" + } + }, + "DeviceOptions": { + "target": "com.amazonaws.ec2#DeviceOptions", + "traits": { + "aws.protocols#ec2QueryName": "DeviceOptions", + "smithy.api#documentation": "

The options for device-identity trust provider.

", + "smithy.api#xmlName": "deviceOptions" + } + }, + "PolicyReferenceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PolicyReferenceName", + "smithy.api#documentation": "

The identifier to be used when working with policy rules.

", + "smithy.api#xmlName": "policyReferenceName" + } + }, + "CreationTime": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CreationTime", + "smithy.api#documentation": "

The creation time.

", + "smithy.api#xmlName": "creationTime" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LastUpdatedTime", + "smithy.api#documentation": "

The last updated time.

", + "smithy.api#xmlName": "lastUpdatedTime" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags.

", + "smithy.api#xmlName": "tagSet" + } + }, + "SseSpecification": { + "target": "com.amazonaws.ec2#VerifiedAccessSseSpecificationResponse", + "traits": { + "aws.protocols#ec2QueryName": "SseSpecification", + "smithy.api#documentation": "

The options in use for server side encryption.

", + "smithy.api#xmlName": "sseSpecification" + } + }, + "NativeApplicationOidcOptions": { + "target": "com.amazonaws.ec2#NativeApplicationOidcOptions", + "traits": { + "aws.protocols#ec2QueryName": "NativeApplicationOidcOptions", + "smithy.api#documentation": "

The OpenID Connect (OIDC) options.

", + "smithy.api#xmlName": "nativeApplicationOidcOptions" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Verified Access trust provider.

" + } + }, + "com.amazonaws.ec2#VerifiedAccessTrustProviderCondensed": { + "type": "structure", + "members": { + "VerifiedAccessTrustProviderId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessTrustProviderId", + "smithy.api#documentation": "

The ID of the trust provider.

", + "smithy.api#xmlName": "verifiedAccessTrustProviderId" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description of trust provider.

", + "smithy.api#xmlName": "description" + } + }, + "TrustProviderType": { + "target": "com.amazonaws.ec2#TrustProviderType", + "traits": { + "aws.protocols#ec2QueryName": "TrustProviderType", + "smithy.api#documentation": "

The type of trust provider (user- or device-based).

", + "smithy.api#xmlName": "trustProviderType" + } + }, + "UserTrustProviderType": { + "target": "com.amazonaws.ec2#UserTrustProviderType", + "traits": { + "aws.protocols#ec2QueryName": "UserTrustProviderType", + "smithy.api#documentation": "

The type of user-based trust provider.

", + "smithy.api#xmlName": "userTrustProviderType" + } + }, + "DeviceTrustProviderType": { + "target": "com.amazonaws.ec2#DeviceTrustProviderType", + "traits": { + "aws.protocols#ec2QueryName": "DeviceTrustProviderType", + "smithy.api#documentation": "

The type of device-based trust provider.

", + "smithy.api#xmlName": "deviceTrustProviderType" + } + } + }, + "traits": { + "smithy.api#documentation": "

Condensed information about a trust provider.

" + } + }, + "com.amazonaws.ec2#VerifiedAccessTrustProviderCondensedList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VerifiedAccessTrustProviderCondensed", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VerifiedAccessTrustProviderId": { + "type": "string" + }, + "com.amazonaws.ec2#VerifiedAccessTrustProviderIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VerifiedAccessTrustProviderId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VerifiedAccessTrustProviderList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VerifiedAccessTrustProvider", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VersionDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + } + } + }, + "com.amazonaws.ec2#VersionStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VgwTelemetry": { + "type": "structure", + "members": { + "AcceptedRouteCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "AcceptedRouteCount", + "smithy.api#documentation": "

The number of accepted routes.

", + "smithy.api#xmlName": "acceptedRouteCount" + } + }, + "LastStatusChange": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "LastStatusChange", + "smithy.api#documentation": "

The date and time of the last change in status. This field is updated when changes in IKE (Phase 1), IPSec (Phase 2), or BGP status are detected.

", + "smithy.api#xmlName": "lastStatusChange" + } + }, + "OutsideIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OutsideIpAddress", + "smithy.api#documentation": "

The Internet-routable IP address of the virtual private gateway's outside\n interface.

", + "smithy.api#xmlName": "outsideIpAddress" + } + }, + "Status": { + "target": "com.amazonaws.ec2#TelemetryStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The status of the VPN tunnel.

", + "smithy.api#xmlName": "status" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

If an error occurs, a description of the error.

", + "smithy.api#xmlName": "statusMessage" + } + }, + "CertificateArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CertificateArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the VPN tunnel endpoint certificate.

", + "smithy.api#xmlName": "certificateArn" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes telemetry for a VPN tunnel.

" + } + }, + "com.amazonaws.ec2#VgwTelemetryList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VgwTelemetry", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VirtualizationType": { + "type": "enum", + "members": { + "hvm": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hvm" + } + }, + "paravirtual": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "paravirtual" + } + } + } + }, + "com.amazonaws.ec2#VirtualizationTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VirtualizationType", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VirtualizationTypeSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VirtualizationType", + "traits": { + "smithy.api#xmlName": "item" + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2 + } + } + }, + "com.amazonaws.ec2#Volume": { + "type": "structure", + "members": { + "OutpostArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OutpostArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost.

", + "smithy.api#xmlName": "outpostArn" + } + }, + "Iops": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Iops", + "smithy.api#documentation": "

The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents \n the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline \n performance of the volume and the rate at which the volume accumulates I/O credits for bursting.

", + "smithy.api#xmlName": "iops" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the volume.

", + "smithy.api#xmlName": "tagSet" + } + }, + "VolumeType": { + "target": "com.amazonaws.ec2#VolumeType", + "traits": { + "aws.protocols#ec2QueryName": "VolumeType", + "smithy.api#documentation": "

The volume type.

", + "smithy.api#xmlName": "volumeType" + } + }, + "FastRestored": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "FastRestored", + "smithy.api#documentation": "\n

This parameter is not returned by CreateVolume.

\n \n

Indicates whether the volume was created using fast snapshot restore.

", + "smithy.api#xmlName": "fastRestored" + } + }, + "MultiAttachEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "MultiAttachEnabled", + "smithy.api#documentation": "

Indicates whether Amazon EBS Multi-Attach is enabled.

", + "smithy.api#xmlName": "multiAttachEnabled" + } + }, + "Throughput": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Throughput", + "smithy.api#documentation": "

The throughput that the volume supports, in MiB/s.

", + "smithy.api#xmlName": "throughput" + } + }, + "SseType": { + "target": "com.amazonaws.ec2#SSEType", + "traits": { + "aws.protocols#ec2QueryName": "SseType", + "smithy.api#documentation": "\n

This parameter is not returned by CreateVolume.

\n \n

Reserved for future use.

", + "smithy.api#xmlName": "sseType" + } + }, + "Operator": { + "target": "com.amazonaws.ec2#OperatorResponse", + "traits": { + "aws.protocols#ec2QueryName": "Operator", + "smithy.api#documentation": "

The service provider that manages the volume.

", + "smithy.api#xmlName": "operator" + } + }, + "VolumeId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VolumeId", + "smithy.api#documentation": "

The ID of the volume.

", + "smithy.api#xmlName": "volumeId" + } + }, + "Size": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Size", + "smithy.api#documentation": "

The size of the volume, in GiBs.

", + "smithy.api#xmlName": "size" + } + }, + "SnapshotId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The snapshot from which the volume was created, if applicable.

", + "smithy.api#xmlName": "snapshotId" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone for the volume.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "State": { + "target": "com.amazonaws.ec2#VolumeState", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The volume state.

", + "smithy.api#xmlName": "status" + } + }, + "CreateTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreateTime", + "smithy.api#documentation": "

The time stamp when volume creation was initiated.

", + "smithy.api#xmlName": "createTime" + } + }, + "Attachments": { + "target": "com.amazonaws.ec2#VolumeAttachmentList", + "traits": { + "aws.protocols#ec2QueryName": "AttachmentSet", + "smithy.api#documentation": "\n

This parameter is not returned by CreateVolume.

\n \n

Information about the volume attachments.

", + "smithy.api#xmlName": "attachmentSet" + } + }, + "Encrypted": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Encrypted", + "smithy.api#documentation": "

Indicates whether the volume is encrypted.

", + "smithy.api#xmlName": "encrypted" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KmsKeyId", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key that was used to protect the\n volume encryption key for the volume.

", + "smithy.api#xmlName": "kmsKeyId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a volume.

" + } + }, + "com.amazonaws.ec2#VolumeAttachment": { + "type": "structure", + "members": { + "DeleteOnTermination": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DeleteOnTermination", + "smithy.api#documentation": "

Indicates whether the EBS volume is deleted on instance termination.

", + "smithy.api#xmlName": "deleteOnTermination" + } + }, + "AssociatedResource": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AssociatedResource", + "smithy.api#documentation": "

The ARN of the Amazon ECS or Fargate task \n to which the volume is attached.

", + "smithy.api#xmlName": "associatedResource" + } + }, + "InstanceOwningService": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceOwningService", + "smithy.api#documentation": "

The service principal of Amazon Web Services service that owns the underlying \n instance to which the volume is attached.

\n

This parameter is returned only for volumes that are attached to \n Fargate tasks.

", + "smithy.api#xmlName": "instanceOwningService" + } + }, + "VolumeId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VolumeId", + "smithy.api#documentation": "

The ID of the volume.

", + "smithy.api#xmlName": "volumeId" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance.

\n

If the volume is attached to a Fargate task, this parameter \n returns null.

", + "smithy.api#xmlName": "instanceId" + } + }, + "Device": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Device", + "smithy.api#documentation": "

The device name.

\n

If the volume is attached to a Fargate task, this parameter \n returns null.

", + "smithy.api#xmlName": "device" + } + }, + "State": { + "target": "com.amazonaws.ec2#VolumeAttachmentState", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The attachment state of the volume.

", + "smithy.api#xmlName": "status" + } + }, + "AttachTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "AttachTime", + "smithy.api#documentation": "

The time stamp when the attachment initiated.

", + "smithy.api#xmlName": "attachTime" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes volume attachment details.

" + } + }, + "com.amazonaws.ec2#VolumeAttachmentList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VolumeAttachment", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VolumeAttachmentState": { + "type": "enum", + "members": { + "attaching": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "attaching" + } + }, + "attached": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "attached" + } + }, + "detaching": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "detaching" + } + }, + "detached": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "detached" + } + }, + "busy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "busy" + } + } + } + }, + "com.amazonaws.ec2#VolumeAttributeName": { + "type": "enum", + "members": { + "autoEnableIO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "autoEnableIO" + } + }, + "productCodes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "productCodes" + } + } + } + }, + "com.amazonaws.ec2#VolumeDetail": { + "type": "structure", + "members": { + "Size": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "Size", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The size of the volume, in GiB.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "size" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an EBS volume.

" + } + }, + "com.amazonaws.ec2#VolumeId": { + "type": "string" + }, + "com.amazonaws.ec2#VolumeIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VolumeId", + "traits": { + "smithy.api#xmlName": "VolumeId" + } + } + }, + "com.amazonaws.ec2#VolumeIdWithResolver": { + "type": "string" + }, + "com.amazonaws.ec2#VolumeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Volume", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VolumeModification": { + "type": "structure", + "members": { + "VolumeId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VolumeId", + "smithy.api#documentation": "

The ID of the volume.

", + "smithy.api#xmlName": "volumeId" + } + }, + "ModificationState": { + "target": "com.amazonaws.ec2#VolumeModificationState", + "traits": { + "aws.protocols#ec2QueryName": "ModificationState", + "smithy.api#documentation": "

The current modification state.

", + "smithy.api#xmlName": "modificationState" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

A status message about the modification progress or failure.

", + "smithy.api#xmlName": "statusMessage" + } + }, + "TargetSize": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TargetSize", + "smithy.api#documentation": "

The target size of the volume, in GiB.

", + "smithy.api#xmlName": "targetSize" + } + }, + "TargetIops": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TargetIops", + "smithy.api#documentation": "

The target IOPS rate of the volume.

", + "smithy.api#xmlName": "targetIops" + } + }, + "TargetVolumeType": { + "target": "com.amazonaws.ec2#VolumeType", + "traits": { + "aws.protocols#ec2QueryName": "TargetVolumeType", + "smithy.api#documentation": "

The target EBS volume type of the volume.

", + "smithy.api#xmlName": "targetVolumeType" + } + }, + "TargetThroughput": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TargetThroughput", + "smithy.api#documentation": "

The target throughput of the volume, in MiB/s.

", + "smithy.api#xmlName": "targetThroughput" + } + }, + "TargetMultiAttachEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "TargetMultiAttachEnabled", + "smithy.api#documentation": "

The target setting for Amazon EBS Multi-Attach.

", + "smithy.api#xmlName": "targetMultiAttachEnabled" + } + }, + "OriginalSize": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "OriginalSize", + "smithy.api#documentation": "

The original size of the volume, in GiB.

", + "smithy.api#xmlName": "originalSize" + } + }, + "OriginalIops": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "OriginalIops", + "smithy.api#documentation": "

The original IOPS rate of the volume.

", + "smithy.api#xmlName": "originalIops" + } + }, + "OriginalVolumeType": { + "target": "com.amazonaws.ec2#VolumeType", + "traits": { + "aws.protocols#ec2QueryName": "OriginalVolumeType", + "smithy.api#documentation": "

The original EBS volume type of the volume.

", + "smithy.api#xmlName": "originalVolumeType" + } + }, + "OriginalThroughput": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "OriginalThroughput", + "smithy.api#documentation": "

The original throughput of the volume, in MiB/s.

", + "smithy.api#xmlName": "originalThroughput" + } + }, + "OriginalMultiAttachEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "OriginalMultiAttachEnabled", + "smithy.api#documentation": "

The original setting for Amazon EBS Multi-Attach.

", + "smithy.api#xmlName": "originalMultiAttachEnabled" + } + }, + "Progress": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "Progress", + "smithy.api#documentation": "

The modification progress, from 0 to 100 percent complete.

", + "smithy.api#xmlName": "progress" + } + }, + "StartTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "StartTime", + "smithy.api#documentation": "

The modification start time.

", + "smithy.api#xmlName": "startTime" + } + }, + "EndTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "EndTime", + "smithy.api#documentation": "

The modification completion or failure time.

", + "smithy.api#xmlName": "endTime" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the modification status of an EBS volume.

" + } + }, + "com.amazonaws.ec2#VolumeModificationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VolumeModification", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VolumeModificationState": { + "type": "enum", + "members": { + "modifying": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modifying" + } + }, + "optimizing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "optimizing" + } + }, + "completed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "completed" + } + }, + "failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + } + } + }, + "com.amazonaws.ec2#VolumeState": { + "type": "enum", + "members": { + "creating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "creating" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "in_use": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "in-use" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + }, + "deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted" + } + }, + "error": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "error" + } + } + } + }, + "com.amazonaws.ec2#VolumeStatusAction": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The code identifying the operation, for example, enable-volume-io.

", + "smithy.api#xmlName": "code" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description of the operation.

", + "smithy.api#xmlName": "description" + } + }, + "EventId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "EventId", + "smithy.api#documentation": "

The ID of the event associated with this operation.

", + "smithy.api#xmlName": "eventId" + } + }, + "EventType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "EventType", + "smithy.api#documentation": "

The event type associated with this operation.

", + "smithy.api#xmlName": "eventType" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a volume status operation code.

" + } + }, + "com.amazonaws.ec2#VolumeStatusActionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VolumeStatusAction", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VolumeStatusAttachmentStatus": { + "type": "structure", + "members": { + "IoPerformance": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IoPerformance", + "smithy.api#documentation": "

The maximum IOPS supported by the attached instance.

", + "smithy.api#xmlName": "ioPerformance" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the attached instance.

", + "smithy.api#xmlName": "instanceId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the instances to which the volume is attached.

" + } + }, + "com.amazonaws.ec2#VolumeStatusAttachmentStatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VolumeStatusAttachmentStatus", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VolumeStatusDetails": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.ec2#VolumeStatusName", + "traits": { + "aws.protocols#ec2QueryName": "Name", + "smithy.api#documentation": "

The name of the volume status.

", + "smithy.api#xmlName": "name" + } + }, + "Status": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The intended status of the volume status.

", + "smithy.api#xmlName": "status" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a volume status.

" + } + }, + "com.amazonaws.ec2#VolumeStatusDetailsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VolumeStatusDetails", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VolumeStatusEvent": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description of the event.

", + "smithy.api#xmlName": "description" + } + }, + "EventId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "EventId", + "smithy.api#documentation": "

The ID of this event.

", + "smithy.api#xmlName": "eventId" + } + }, + "EventType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "EventType", + "smithy.api#documentation": "

The type of this event.

", + "smithy.api#xmlName": "eventType" + } + }, + "NotAfter": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "NotAfter", + "smithy.api#documentation": "

The latest end time of the event.

", + "smithy.api#xmlName": "notAfter" + } + }, + "NotBefore": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "NotBefore", + "smithy.api#documentation": "

The earliest start time of the event.

", + "smithy.api#xmlName": "notBefore" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance associated with the event.

", + "smithy.api#xmlName": "instanceId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a volume status event.

" + } + }, + "com.amazonaws.ec2#VolumeStatusEventsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VolumeStatusEvent", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VolumeStatusInfo": { + "type": "structure", + "members": { + "Details": { + "target": "com.amazonaws.ec2#VolumeStatusDetailsList", + "traits": { + "aws.protocols#ec2QueryName": "Details", + "smithy.api#documentation": "

The details of the volume status.

", + "smithy.api#xmlName": "details" + } + }, + "Status": { + "target": "com.amazonaws.ec2#VolumeStatusInfoStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The status of the volume.

", + "smithy.api#xmlName": "status" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the status of a volume.

" + } + }, + "com.amazonaws.ec2#VolumeStatusInfoStatus": { + "type": "enum", + "members": { + "ok": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ok" + } + }, + "impaired": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "impaired" + } + }, + "insufficient_data": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "insufficient-data" + } + } + } + }, + "com.amazonaws.ec2#VolumeStatusItem": { + "type": "structure", + "members": { + "Actions": { + "target": "com.amazonaws.ec2#VolumeStatusActionsList", + "traits": { + "aws.protocols#ec2QueryName": "ActionsSet", + "smithy.api#documentation": "

The details of the operation.

", + "smithy.api#xmlName": "actionsSet" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone of the volume.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "OutpostArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OutpostArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost.

", + "smithy.api#xmlName": "outpostArn" + } + }, + "Events": { + "target": "com.amazonaws.ec2#VolumeStatusEventsList", + "traits": { + "aws.protocols#ec2QueryName": "EventsSet", + "smithy.api#documentation": "

A list of events associated with the volume.

", + "smithy.api#xmlName": "eventsSet" + } + }, + "VolumeId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VolumeId", + "smithy.api#documentation": "

The volume ID.

", + "smithy.api#xmlName": "volumeId" + } + }, + "VolumeStatus": { + "target": "com.amazonaws.ec2#VolumeStatusInfo", + "traits": { + "aws.protocols#ec2QueryName": "VolumeStatus", + "smithy.api#documentation": "

The volume status.

", + "smithy.api#xmlName": "volumeStatus" + } + }, + "AttachmentStatuses": { + "target": "com.amazonaws.ec2#VolumeStatusAttachmentStatusList", + "traits": { + "aws.protocols#ec2QueryName": "AttachmentStatuses", + "smithy.api#documentation": "

Information about the instances to which the volume is attached.

", + "smithy.api#xmlName": "attachmentStatuses" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the volume status.

" + } + }, + "com.amazonaws.ec2#VolumeStatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VolumeStatusItem", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VolumeStatusName": { + "type": "enum", + "members": { + "io_enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "io-enabled" + } + }, + "io_performance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "io-performance" + } + } + } + }, + "com.amazonaws.ec2#VolumeType": { + "type": "enum", + "members": { + "standard": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "standard" + } + }, + "io1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "io1" + } + }, + "io2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "io2" + } + }, + "gp2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "gp2" + } + }, + "sc1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sc1" + } + }, + "st1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "st1" + } + }, + "gp3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "gp3" + } + } + } + }, + "com.amazonaws.ec2#Vpc": { + "type": "structure", + "members": { + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the VPC.

", + "smithy.api#xmlName": "ownerId" + } + }, + "InstanceTenancy": { + "target": "com.amazonaws.ec2#Tenancy", + "traits": { + "aws.protocols#ec2QueryName": "InstanceTenancy", + "smithy.api#documentation": "

The allowed tenancy of instances launched into the VPC.

", + "smithy.api#xmlName": "instanceTenancy" + } + }, + "Ipv6CidrBlockAssociationSet": { + "target": "com.amazonaws.ec2#VpcIpv6CidrBlockAssociationSet", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6CidrBlockAssociationSet", + "smithy.api#documentation": "

Information about the IPv6 CIDR blocks associated with the VPC.

", + "smithy.api#xmlName": "ipv6CidrBlockAssociationSet" + } + }, + "CidrBlockAssociationSet": { + "target": "com.amazonaws.ec2#VpcCidrBlockAssociationSet", + "traits": { + "aws.protocols#ec2QueryName": "CidrBlockAssociationSet", + "smithy.api#documentation": "

Information about the IPv4 CIDR blocks associated with the VPC.

", + "smithy.api#xmlName": "cidrBlockAssociationSet" + } + }, + "IsDefault": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "IsDefault", + "smithy.api#documentation": "

Indicates whether the VPC is the default VPC.

", + "smithy.api#xmlName": "isDefault" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the VPC.

", + "smithy.api#xmlName": "tagSet" + } + }, + "BlockPublicAccessStates": { + "target": "com.amazonaws.ec2#BlockPublicAccessStates", + "traits": { + "aws.protocols#ec2QueryName": "BlockPublicAccessStates", + "smithy.api#documentation": "

The state of VPC Block Public Access (BPA).

", + "smithy.api#xmlName": "blockPublicAccessStates" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "vpcId" + } + }, + "State": { + "target": "com.amazonaws.ec2#VpcState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of the VPC.

", + "smithy.api#xmlName": "state" + } + }, + "CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CidrBlock", + "smithy.api#documentation": "

The primary IPv4 CIDR block for the VPC.

", + "smithy.api#xmlName": "cidrBlock" + } + }, + "DhcpOptionsId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DhcpOptionsId", + "smithy.api#documentation": "

The ID of the set of DHCP options you've associated with the VPC.

", + "smithy.api#xmlName": "dhcpOptionsId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a VPC.

" + } + }, + "com.amazonaws.ec2#VpcAttachment": { + "type": "structure", + "members": { + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "vpcId" + } + }, + "State": { + "target": "com.amazonaws.ec2#AttachmentStatus", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of the attachment.

", + "smithy.api#xmlName": "state" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an attachment between a virtual private gateway and a VPC.

" + } + }, + "com.amazonaws.ec2#VpcAttachmentList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VpcAttachment", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VpcAttributeName": { + "type": "enum", + "members": { + "enableDnsSupport": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enableDnsSupport" + } + }, + "enableDnsHostnames": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enableDnsHostnames" + } + }, + "enableNetworkAddressUsageMetrics": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enableNetworkAddressUsageMetrics" + } + } + } + }, + "com.amazonaws.ec2#VpcBlockPublicAccessExclusion": { + "type": "structure", + "members": { + "ExclusionId": { + "target": "com.amazonaws.ec2#VpcBlockPublicAccessExclusionId", + "traits": { + "aws.protocols#ec2QueryName": "ExclusionId", + "smithy.api#documentation": "

The ID of the exclusion.

", + "smithy.api#xmlName": "exclusionId" + } + }, + "InternetGatewayExclusionMode": { + "target": "com.amazonaws.ec2#InternetGatewayExclusionMode", + "traits": { + "aws.protocols#ec2QueryName": "InternetGatewayExclusionMode", + "smithy.api#documentation": "

The exclusion mode for internet gateway traffic.

\n ", + "smithy.api#xmlName": "internetGatewayExclusionMode" + } + }, + "ResourceArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "ResourceArn", + "smithy.api#documentation": "

The ARN of the exclusion.

", + "smithy.api#xmlName": "resourceArn" + } + }, + "State": { + "target": "com.amazonaws.ec2#VpcBlockPublicAccessExclusionState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the exclusion.

", + "smithy.api#xmlName": "state" + } + }, + "Reason": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Reason", + "smithy.api#documentation": "

The reason for the current exclusion state.

", + "smithy.api#xmlName": "reason" + } + }, + "CreationTimestamp": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreationTimestamp", + "smithy.api#documentation": "

When the exclusion was created.

", + "smithy.api#xmlName": "creationTimestamp" + } + }, + "LastUpdateTimestamp": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "LastUpdateTimestamp", + "smithy.api#documentation": "

When the exclusion was last updated.

", + "smithy.api#xmlName": "lastUpdateTimestamp" + } + }, + "DeletionTimestamp": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "DeletionTimestamp", + "smithy.api#documentation": "

When the exclusion was deleted.

", + "smithy.api#xmlName": "deletionTimestamp" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

\n tag - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

A VPC BPA exclusion is a mode that can be applied to a single VPC or subnet that exempts it from the account’s BPA mode and will allow bidirectional or egress-only access. You can create BPA exclusions for VPCs and subnets even when BPA is not enabled on the account to ensure that there is no traffic disruption to the exclusions when VPC BPA is turned on. To learn more about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User Guide.

" + } + }, + "com.amazonaws.ec2#VpcBlockPublicAccessExclusionId": { + "type": "string" + }, + "com.amazonaws.ec2#VpcBlockPublicAccessExclusionIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VpcBlockPublicAccessExclusionId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VpcBlockPublicAccessExclusionList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VpcBlockPublicAccessExclusion", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VpcBlockPublicAccessExclusionState": { + "type": "enum", + "members": { + "create_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "create-in-progress" + } + }, + "create_complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "create-complete" + } + }, + "create_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "create-failed" + } + }, + "update_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "update-in-progress" + } + }, + "update_complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "update-complete" + } + }, + "update_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "update-failed" + } + }, + "delete_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "delete-in-progress" + } + }, + "delete_complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "delete-complete" + } + }, + "disable_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disable-in-progress" + } + }, + "disable_complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disable-complete" + } + } + } + }, + "com.amazonaws.ec2#VpcBlockPublicAccessExclusionsAllowed": { + "type": "enum", + "members": { + "allowed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "allowed" + } + }, + "not_allowed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "not-allowed" + } + } + } + }, + "com.amazonaws.ec2#VpcBlockPublicAccessOptions": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AwsAccountId", + "smithy.api#documentation": "

An Amazon Web Services account ID.

", + "smithy.api#xmlName": "awsAccountId" + } + }, + "AwsRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AwsRegion", + "smithy.api#documentation": "

An Amazon Web Services Region.

", + "smithy.api#xmlName": "awsRegion" + } + }, + "State": { + "target": "com.amazonaws.ec2#VpcBlockPublicAccessState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of VPC BPA.

", + "smithy.api#xmlName": "state" + } + }, + "InternetGatewayBlockMode": { + "target": "com.amazonaws.ec2#InternetGatewayBlockMode", + "traits": { + "aws.protocols#ec2QueryName": "InternetGatewayBlockMode", + "smithy.api#documentation": "

The current mode of VPC BPA.

\n ", + "smithy.api#xmlName": "internetGatewayBlockMode" + } + }, + "Reason": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Reason", + "smithy.api#documentation": "

The reason for the current state.

", + "smithy.api#xmlName": "reason" + } + }, + "LastUpdateTimestamp": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "LastUpdateTimestamp", + "smithy.api#documentation": "

The last time the VPC BPA mode was updated.

", + "smithy.api#xmlName": "lastUpdateTimestamp" + } + }, + "ManagedBy": { + "target": "com.amazonaws.ec2#ManagedBy", + "traits": { + "aws.protocols#ec2QueryName": "ManagedBy", + "smithy.api#documentation": "

The entity that manages the state of VPC BPA. Possible values include:

\n ", + "smithy.api#xmlName": "managedBy" + } + }, + "ExclusionsAllowed": { + "target": "com.amazonaws.ec2#VpcBlockPublicAccessExclusionsAllowed", + "traits": { + "aws.protocols#ec2QueryName": "ExclusionsAllowed", + "smithy.api#documentation": "

Determines if exclusions are allowed. If you have enabled VPC BPA at the Organization level, exclusions may be\n not-allowed. Otherwise, they are allowed.

", + "smithy.api#xmlName": "exclusionsAllowed" + } + } + }, + "traits": { + "smithy.api#documentation": "

VPC Block Public Access (BPA) enables you to block resources in VPCs and subnets that you own in a Region from reaching or being reached from the internet through internet gateways and egress-only internet gateways. To learn more about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User Guide.

" + } + }, + "com.amazonaws.ec2#VpcBlockPublicAccessState": { + "type": "enum", + "members": { + "default_state": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "default-state" + } + }, + "update_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "update-in-progress" + } + }, + "update_complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "update-complete" + } + } + } + }, + "com.amazonaws.ec2#VpcCidrAssociationId": { + "type": "string" + }, + "com.amazonaws.ec2#VpcCidrBlockAssociation": { + "type": "structure", + "members": { + "AssociationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AssociationId", + "smithy.api#documentation": "

The association ID for the IPv4 CIDR block.

", + "smithy.api#xmlName": "associationId" + } + }, + "CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CidrBlock", + "smithy.api#documentation": "

The IPv4 CIDR block.

", + "smithy.api#xmlName": "cidrBlock" + } + }, + "CidrBlockState": { + "target": "com.amazonaws.ec2#VpcCidrBlockState", + "traits": { + "aws.protocols#ec2QueryName": "CidrBlockState", + "smithy.api#documentation": "

Information about the state of the CIDR block.

", + "smithy.api#xmlName": "cidrBlockState" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an IPv4 CIDR block associated with a VPC.

" + } + }, + "com.amazonaws.ec2#VpcCidrBlockAssociationSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VpcCidrBlockAssociation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VpcCidrBlockState": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.ec2#VpcCidrBlockStateCode", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the CIDR block.

", + "smithy.api#xmlName": "state" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

A message about the status of the CIDR block, if applicable.

", + "smithy.api#xmlName": "statusMessage" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the state of a CIDR block.

" + } + }, + "com.amazonaws.ec2#VpcCidrBlockStateCode": { + "type": "enum", + "members": { + "associating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associating" + } + }, + "associated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associated" + } + }, + "disassociating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociating" + } + }, + "disassociated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociated" + } + }, + "failing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failing" + } + }, + "failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + } + } + }, + "com.amazonaws.ec2#VpcClassicLink": { + "type": "structure", + "members": { + "ClassicLinkEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "ClassicLinkEnabled", + "smithy.api#documentation": "

Indicates whether the VPC is enabled for ClassicLink.

", + "smithy.api#xmlName": "classicLinkEnabled" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the VPC.

", + "smithy.api#xmlName": "tagSet" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "vpcId" + } + } + }, + "traits": { + "smithy.api#documentation": "\n

Deprecated.

\n \n

Describes whether a VPC is enabled for ClassicLink.

" + } + }, + "com.amazonaws.ec2#VpcClassicLinkIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#xmlName": "VpcId" + } + } + }, + "com.amazonaws.ec2#VpcClassicLinkList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VpcClassicLink", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VpcEndpoint": { + "type": "structure", + "members": { + "VpcEndpointId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcEndpointId", + "smithy.api#documentation": "

The ID of the endpoint.

", + "smithy.api#xmlName": "vpcEndpointId" + } + }, + "VpcEndpointType": { + "target": "com.amazonaws.ec2#VpcEndpointType", + "traits": { + "aws.protocols#ec2QueryName": "VpcEndpointType", + "smithy.api#documentation": "

The type of endpoint.

", + "smithy.api#xmlName": "vpcEndpointType" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC to which the endpoint is associated.

", + "smithy.api#xmlName": "vpcId" + } + }, + "ServiceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ServiceName", + "smithy.api#documentation": "

The name of the service to which the endpoint is associated.

", + "smithy.api#xmlName": "serviceName" + } + }, + "State": { + "target": "com.amazonaws.ec2#State", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the endpoint.

", + "smithy.api#xmlName": "state" + } + }, + "PolicyDocument": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PolicyDocument", + "smithy.api#documentation": "

The policy document associated with the endpoint, if applicable.

", + "smithy.api#xmlName": "policyDocument" + } + }, + "RouteTableIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "RouteTableIdSet", + "smithy.api#documentation": "

(Gateway endpoint) The IDs of the route tables associated with the endpoint.

", + "smithy.api#xmlName": "routeTableIdSet" + } + }, + "SubnetIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "SubnetIdSet", + "smithy.api#documentation": "

(Interface endpoint) The subnets for the endpoint.

", + "smithy.api#xmlName": "subnetIdSet" + } + }, + "Groups": { + "target": "com.amazonaws.ec2#GroupIdentifierSet", + "traits": { + "aws.protocols#ec2QueryName": "GroupSet", + "smithy.api#documentation": "

(Interface endpoint) Information about the security groups that are associated with\n the network interface.

", + "smithy.api#xmlName": "groupSet" + } + }, + "IpAddressType": { + "target": "com.amazonaws.ec2#IpAddressType", + "traits": { + "aws.protocols#ec2QueryName": "IpAddressType", + "smithy.api#documentation": "

The IP address type for the endpoint.

", + "smithy.api#xmlName": "ipAddressType" + } + }, + "DnsOptions": { + "target": "com.amazonaws.ec2#DnsOptions", + "traits": { + "aws.protocols#ec2QueryName": "DnsOptions", + "smithy.api#documentation": "

The DNS options for the endpoint.

", + "smithy.api#xmlName": "dnsOptions" + } + }, + "PrivateDnsEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "PrivateDnsEnabled", + "smithy.api#documentation": "

(Interface endpoint) Indicates whether the VPC is associated with a private hosted zone.

", + "smithy.api#xmlName": "privateDnsEnabled" + } + }, + "RequesterManaged": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "RequesterManaged", + "smithy.api#documentation": "

Indicates whether the endpoint is being managed by its service.

", + "smithy.api#xmlName": "requesterManaged" + } + }, + "NetworkInterfaceIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceIdSet", + "smithy.api#documentation": "

(Interface endpoint) The network interfaces for the endpoint.

", + "smithy.api#xmlName": "networkInterfaceIdSet" + } + }, + "DnsEntries": { + "target": "com.amazonaws.ec2#DnsEntrySet", + "traits": { + "aws.protocols#ec2QueryName": "DnsEntrySet", + "smithy.api#documentation": "

(Interface endpoint) The DNS entries for the endpoint.

", + "smithy.api#xmlName": "dnsEntrySet" + } + }, + "CreationTimestamp": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreationTimestamp", + "smithy.api#documentation": "

The date and time that the endpoint was created.

", + "smithy.api#xmlName": "creationTimestamp" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the endpoint.

", + "smithy.api#xmlName": "tagSet" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the endpoint.

", + "smithy.api#xmlName": "ownerId" + } + }, + "LastError": { + "target": "com.amazonaws.ec2#LastError", + "traits": { + "aws.protocols#ec2QueryName": "LastError", + "smithy.api#documentation": "

The last error that occurred for endpoint.

", + "smithy.api#xmlName": "lastError" + } + }, + "Ipv4Prefixes": { + "target": "com.amazonaws.ec2#SubnetIpPrefixesList", + "traits": { + "aws.protocols#ec2QueryName": "Ipv4PrefixSet", + "smithy.api#documentation": "

Array of IPv4 prefixes.

", + "smithy.api#xmlName": "ipv4PrefixSet" + } + }, + "Ipv6Prefixes": { + "target": "com.amazonaws.ec2#SubnetIpPrefixesList", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6PrefixSet", + "smithy.api#documentation": "

Array of IPv6 prefixes.

", + "smithy.api#xmlName": "ipv6PrefixSet" + } + }, + "FailureReason": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "FailureReason", + "smithy.api#documentation": "

Reason for the failure.

", + "smithy.api#xmlName": "failureReason" + } + }, + "ServiceNetworkArn": { + "target": "com.amazonaws.ec2#ServiceNetworkArn", + "traits": { + "aws.protocols#ec2QueryName": "ServiceNetworkArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service network.

", + "smithy.api#xmlName": "serviceNetworkArn" + } + }, + "ResourceConfigurationArn": { + "target": "com.amazonaws.ec2#ResourceConfigurationArn", + "traits": { + "aws.protocols#ec2QueryName": "ResourceConfigurationArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource configuration.

", + "smithy.api#xmlName": "resourceConfigurationArn" + } + }, + "ServiceRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ServiceRegion", + "smithy.api#documentation": "

The Region where the service is hosted.

", + "smithy.api#xmlName": "serviceRegion" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a VPC endpoint.

" + } + }, + "com.amazonaws.ec2#VpcEndpointAssociation": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Id", + "smithy.api#documentation": "

The ID of the VPC endpoint association.

", + "smithy.api#xmlName": "id" + } + }, + "VpcEndpointId": { + "target": "com.amazonaws.ec2#VpcEndpointId", + "traits": { + "aws.protocols#ec2QueryName": "VpcEndpointId", + "smithy.api#documentation": "

The ID of the VPC endpoint.

", + "smithy.api#xmlName": "vpcEndpointId" + } + }, + "ServiceNetworkArn": { + "target": "com.amazonaws.ec2#ServiceNetworkArn", + "traits": { + "aws.protocols#ec2QueryName": "ServiceNetworkArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service network.

", + "smithy.api#xmlName": "serviceNetworkArn" + } + }, + "ServiceNetworkName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ServiceNetworkName", + "smithy.api#documentation": "

The name of the service network.

", + "smithy.api#xmlName": "serviceNetworkName" + } + }, + "AssociatedResourceAccessibility": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AssociatedResourceAccessibility", + "smithy.api#documentation": "

The connectivity status of the resources associated to a VPC endpoint. The resource is\n accessible if the associated resource configuration is AVAILABLE, otherwise\n the resource is inaccessible.

", + "smithy.api#xmlName": "associatedResourceAccessibility" + } + }, + "FailureReason": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "FailureReason", + "smithy.api#documentation": "

A message related to why an VPC endpoint association failed.

", + "smithy.api#xmlName": "failureReason" + } + }, + "FailureCode": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "FailureCode", + "smithy.api#documentation": "

An error code related to why an VPC endpoint association failed.

", + "smithy.api#xmlName": "failureCode" + } + }, + "DnsEntry": { + "target": "com.amazonaws.ec2#DnsEntry", + "traits": { + "aws.protocols#ec2QueryName": "DnsEntry", + "smithy.api#documentation": "

The DNS entry of the VPC endpoint association.

", + "smithy.api#xmlName": "dnsEntry" + } + }, + "PrivateDnsEntry": { + "target": "com.amazonaws.ec2#DnsEntry", + "traits": { + "aws.protocols#ec2QueryName": "PrivateDnsEntry", + "smithy.api#documentation": "

The private DNS entry of the VPC endpoint association.

", + "smithy.api#xmlName": "privateDnsEntry" + } + }, + "AssociatedResourceArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AssociatedResourceArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the associated resource.

", + "smithy.api#xmlName": "associatedResourceArn" + } + }, + "ResourceConfigurationGroupArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceConfigurationGroupArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource configuration group.

", + "smithy.api#xmlName": "resourceConfigurationGroupArn" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags to apply to the VPC endpoint association.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the VPC resources, VPC endpoint services, Lattice services, or service\n networks associated with the VPC endpoint.

" + } + }, + "com.amazonaws.ec2#VpcEndpointAssociationSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VpcEndpointAssociation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VpcEndpointConnection": { + "type": "structure", + "members": { + "ServiceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ServiceId", + "smithy.api#documentation": "

The ID of the service to which the endpoint is connected.

", + "smithy.api#xmlName": "serviceId" + } + }, + "VpcEndpointId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcEndpointId", + "smithy.api#documentation": "

The ID of the VPC endpoint.

", + "smithy.api#xmlName": "vpcEndpointId" + } + }, + "VpcEndpointOwner": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcEndpointOwner", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the VPC endpoint.

", + "smithy.api#xmlName": "vpcEndpointOwner" + } + }, + "VpcEndpointState": { + "target": "com.amazonaws.ec2#State", + "traits": { + "aws.protocols#ec2QueryName": "VpcEndpointState", + "smithy.api#documentation": "

The state of the VPC endpoint.

", + "smithy.api#xmlName": "vpcEndpointState" + } + }, + "CreationTimestamp": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreationTimestamp", + "smithy.api#documentation": "

The date and time that the VPC endpoint was created.

", + "smithy.api#xmlName": "creationTimestamp" + } + }, + "DnsEntries": { + "target": "com.amazonaws.ec2#DnsEntrySet", + "traits": { + "aws.protocols#ec2QueryName": "DnsEntrySet", + "smithy.api#documentation": "

The DNS entries for the VPC endpoint.

", + "smithy.api#xmlName": "dnsEntrySet" + } + }, + "NetworkLoadBalancerArns": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "NetworkLoadBalancerArnSet", + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the network load balancers for the service.

", + "smithy.api#xmlName": "networkLoadBalancerArnSet" + } + }, + "GatewayLoadBalancerArns": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "GatewayLoadBalancerArnSet", + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service.

", + "smithy.api#xmlName": "gatewayLoadBalancerArnSet" + } + }, + "IpAddressType": { + "target": "com.amazonaws.ec2#IpAddressType", + "traits": { + "aws.protocols#ec2QueryName": "IpAddressType", + "smithy.api#documentation": "

The IP address type for the endpoint.

", + "smithy.api#xmlName": "ipAddressType" + } + }, + "VpcEndpointConnectionId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcEndpointConnectionId", + "smithy.api#documentation": "

The ID of the VPC endpoint connection.

", + "smithy.api#xmlName": "vpcEndpointConnectionId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags.

", + "smithy.api#xmlName": "tagSet" + } + }, + "VpcEndpointRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcEndpointRegion", + "smithy.api#documentation": "

The Region of the endpoint.

", + "smithy.api#xmlName": "vpcEndpointRegion" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a VPC endpoint connection to a service.

" + } + }, + "com.amazonaws.ec2#VpcEndpointConnectionSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VpcEndpointConnection", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VpcEndpointId": { + "type": "string" + }, + "com.amazonaws.ec2#VpcEndpointIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VpcEndpointId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VpcEndpointRouteTableIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#RouteTableId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VpcEndpointSecurityGroupIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VpcEndpointServiceId": { + "type": "string" + }, + "com.amazonaws.ec2#VpcEndpointServiceIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VpcEndpointServiceId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VpcEndpointSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VpcEndpoint", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VpcEndpointSubnetIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VpcEndpointType": { + "type": "enum", + "members": { + "Interface": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Interface" + } + }, + "Gateway": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Gateway" + } + }, + "GatewayLoadBalancer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GatewayLoadBalancer" + } + }, + "Resource": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Resource" + } + }, + "ServiceNetwork": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ServiceNetwork" + } + } + } + }, + "com.amazonaws.ec2#VpcFlowLogId": { + "type": "string" + }, + "com.amazonaws.ec2#VpcId": { + "type": "string" + }, + "com.amazonaws.ec2#VpcIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#xmlName": "VpcId" + } + } + }, + "com.amazonaws.ec2#VpcIpv6CidrBlockAssociation": { + "type": "structure", + "members": { + "AssociationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AssociationId", + "smithy.api#documentation": "

The association ID for the IPv6 CIDR block.

", + "smithy.api#xmlName": "associationId" + } + }, + "Ipv6CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6CidrBlock", + "smithy.api#documentation": "

The IPv6 CIDR block.

", + "smithy.api#xmlName": "ipv6CidrBlock" + } + }, + "Ipv6CidrBlockState": { + "target": "com.amazonaws.ec2#VpcCidrBlockState", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6CidrBlockState", + "smithy.api#documentation": "

Information about the state of the CIDR block.

", + "smithy.api#xmlName": "ipv6CidrBlockState" + } + }, + "NetworkBorderGroup": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkBorderGroup", + "smithy.api#documentation": "

The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from\n which Amazon Web Services advertises IP addresses, for example, us-east-1-wl1-bos-wlz-1.

", + "smithy.api#xmlName": "networkBorderGroup" + } + }, + "Ipv6Pool": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6Pool", + "smithy.api#documentation": "

The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.

", + "smithy.api#xmlName": "ipv6Pool" + } + }, + "Ipv6AddressAttribute": { + "target": "com.amazonaws.ec2#Ipv6AddressAttribute", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6AddressAttribute", + "smithy.api#documentation": "

Public IPv6 addresses are those advertised on the internet from Amazon Web Services. Private IP addresses are not and cannot be advertised on the internet from Amazon Web Services.

", + "smithy.api#xmlName": "ipv6AddressAttribute" + } + }, + "IpSource": { + "target": "com.amazonaws.ec2#IpSource", + "traits": { + "aws.protocols#ec2QueryName": "IpSource", + "smithy.api#documentation": "

The source that allocated the IP address space. byoip or amazon indicates public IP address space allocated by Amazon or space that you have allocated with Bring your own IP (BYOIP). none indicates private space.

", + "smithy.api#xmlName": "ipSource" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an IPv6 CIDR block associated with a VPC.

" + } + }, + "com.amazonaws.ec2#VpcIpv6CidrBlockAssociationSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VpcIpv6CidrBlockAssociation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VpcList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Vpc", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VpcPeeringConnection": { + "type": "structure", + "members": { + "AccepterVpcInfo": { + "target": "com.amazonaws.ec2#VpcPeeringConnectionVpcInfo", + "traits": { + "aws.protocols#ec2QueryName": "AccepterVpcInfo", + "smithy.api#documentation": "

Information about the accepter VPC. CIDR block information is only returned when describing an active VPC peering connection.

", + "smithy.api#xmlName": "accepterVpcInfo" + } + }, + "ExpirationTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "ExpirationTime", + "smithy.api#documentation": "

The time that an unaccepted VPC peering connection will expire.

", + "smithy.api#xmlName": "expirationTime" + } + }, + "RequesterVpcInfo": { + "target": "com.amazonaws.ec2#VpcPeeringConnectionVpcInfo", + "traits": { + "aws.protocols#ec2QueryName": "RequesterVpcInfo", + "smithy.api#documentation": "

Information about the requester VPC. CIDR block information is only returned when describing an active VPC peering connection.

", + "smithy.api#xmlName": "requesterVpcInfo" + } + }, + "Status": { + "target": "com.amazonaws.ec2#VpcPeeringConnectionStateReason", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The status of the VPC peering connection.

", + "smithy.api#xmlName": "status" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the resource.

", + "smithy.api#xmlName": "tagSet" + } + }, + "VpcPeeringConnectionId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcPeeringConnectionId", + "smithy.api#documentation": "

The ID of the VPC peering connection.

", + "smithy.api#xmlName": "vpcPeeringConnectionId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a VPC peering connection.

" + } + }, + "com.amazonaws.ec2#VpcPeeringConnectionId": { + "type": "string" + }, + "com.amazonaws.ec2#VpcPeeringConnectionIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VpcPeeringConnectionId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VpcPeeringConnectionIdWithResolver": { + "type": "string" + }, + "com.amazonaws.ec2#VpcPeeringConnectionList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VpcPeeringConnection", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VpcPeeringConnectionOptionsDescription": { + "type": "structure", + "members": { + "AllowDnsResolutionFromRemoteVpc": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "AllowDnsResolutionFromRemoteVpc", + "smithy.api#documentation": "

Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses \n when queried from instances in a peer VPC.

", + "smithy.api#xmlName": "allowDnsResolutionFromRemoteVpc" + } + }, + "AllowEgressFromLocalClassicLinkToRemoteVpc": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "AllowEgressFromLocalClassicLinkToRemoteVpc", + "smithy.api#documentation": "

Deprecated.

", + "smithy.api#xmlName": "allowEgressFromLocalClassicLinkToRemoteVpc" + } + }, + "AllowEgressFromLocalVpcToRemoteClassicLink": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "AllowEgressFromLocalVpcToRemoteClassicLink", + "smithy.api#documentation": "

Deprecated.

", + "smithy.api#xmlName": "allowEgressFromLocalVpcToRemoteClassicLink" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the VPC peering connection options.

" + } + }, + "com.amazonaws.ec2#VpcPeeringConnectionStateReason": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#VpcPeeringConnectionStateReasonCode", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The status of the VPC peering connection.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

A message that provides more information about the status, if applicable.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the status of a VPC peering connection.

" + } + }, + "com.amazonaws.ec2#VpcPeeringConnectionStateReasonCode": { + "type": "enum", + "members": { + "initiating_request": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "initiating-request" + } + }, + "pending_acceptance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending-acceptance" + } + }, + "active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted" + } + }, + "rejected": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rejected" + } + }, + "failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + }, + "expired": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "expired" + } + }, + "provisioning": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "provisioning" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + } + } + }, + "com.amazonaws.ec2#VpcPeeringConnectionVpcInfo": { + "type": "structure", + "members": { + "CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CidrBlock", + "smithy.api#documentation": "

The IPv4 CIDR block for the VPC.

", + "smithy.api#xmlName": "cidrBlock" + } + }, + "Ipv6CidrBlockSet": { + "target": "com.amazonaws.ec2#Ipv6CidrBlockSet", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6CidrBlockSet", + "smithy.api#documentation": "

The IPv6 CIDR block for the VPC.

", + "smithy.api#xmlName": "ipv6CidrBlockSet" + } + }, + "CidrBlockSet": { + "target": "com.amazonaws.ec2#CidrBlockSet", + "traits": { + "aws.protocols#ec2QueryName": "CidrBlockSet", + "smithy.api#documentation": "

Information about the IPv4 CIDR blocks for the VPC.

", + "smithy.api#xmlName": "cidrBlockSet" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the VPC.

", + "smithy.api#xmlName": "ownerId" + } + }, + "PeeringOptions": { + "target": "com.amazonaws.ec2#VpcPeeringConnectionOptionsDescription", + "traits": { + "aws.protocols#ec2QueryName": "PeeringOptions", + "smithy.api#documentation": "

Information about the VPC peering connection options for the accepter or requester VPC.

", + "smithy.api#xmlName": "peeringOptions" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "vpcId" + } + }, + "Region": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Region", + "smithy.api#documentation": "

The Region in which the VPC is located.

", + "smithy.api#xmlName": "region" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a VPC in a VPC peering connection.

" + } + }, + "com.amazonaws.ec2#VpcState": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + } + } + }, + "com.amazonaws.ec2#VpcTenancy": { + "type": "enum", + "members": { + "default": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "default" + } + } + } + }, + "com.amazonaws.ec2#VpnConnection": { + "type": "structure", + "members": { + "Category": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Category", + "smithy.api#documentation": "

The category of the VPN connection. A value of VPN indicates an Amazon Web Services VPN connection. A value of VPN-Classic indicates an Amazon Web Services Classic VPN connection.

", + "smithy.api#xmlName": "category" + } + }, + "TransitGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayId", + "smithy.api#documentation": "

The ID of the transit gateway associated with the VPN connection.

", + "smithy.api#xmlName": "transitGatewayId" + } + }, + "CoreNetworkArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CoreNetworkArn", + "smithy.api#documentation": "

The ARN of the core network.

", + "smithy.api#xmlName": "coreNetworkArn" + } + }, + "CoreNetworkAttachmentArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CoreNetworkAttachmentArn", + "smithy.api#documentation": "

The ARN of the core network attachment.

", + "smithy.api#xmlName": "coreNetworkAttachmentArn" + } + }, + "GatewayAssociationState": { + "target": "com.amazonaws.ec2#GatewayAssociationState", + "traits": { + "aws.protocols#ec2QueryName": "GatewayAssociationState", + "smithy.api#documentation": "

The current state of the gateway association.

", + "smithy.api#xmlName": "gatewayAssociationState" + } + }, + "Options": { + "target": "com.amazonaws.ec2#VpnConnectionOptions", + "traits": { + "aws.protocols#ec2QueryName": "Options", + "smithy.api#documentation": "

The VPN connection options.

", + "smithy.api#xmlName": "options" + } + }, + "Routes": { + "target": "com.amazonaws.ec2#VpnStaticRouteList", + "traits": { + "aws.protocols#ec2QueryName": "Routes", + "smithy.api#documentation": "

The static routes associated with the VPN connection.

", + "smithy.api#xmlName": "routes" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the VPN connection.

", + "smithy.api#xmlName": "tagSet" + } + }, + "VgwTelemetry": { + "target": "com.amazonaws.ec2#VgwTelemetryList", + "traits": { + "aws.protocols#ec2QueryName": "VgwTelemetry", + "smithy.api#documentation": "

Information about the VPN tunnel.

", + "smithy.api#xmlName": "vgwTelemetry" + } + }, + "VpnConnectionId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpnConnectionId", + "smithy.api#documentation": "

The ID of the VPN connection.

", + "smithy.api#xmlName": "vpnConnectionId" + } + }, + "State": { + "target": "com.amazonaws.ec2#VpnState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of the VPN connection.

", + "smithy.api#xmlName": "state" + } + }, + "CustomerGatewayConfiguration": { + "target": "com.amazonaws.ec2#customerGatewayConfiguration", + "traits": { + "aws.protocols#ec2QueryName": "CustomerGatewayConfiguration", + "smithy.api#documentation": "

The configuration information for the VPN connection's customer gateway (in the native\n XML format). This element is always present in the CreateVpnConnection\n response; however, it's present in the DescribeVpnConnections response\n only if the VPN connection is in the pending or available\n state.

", + "smithy.api#xmlName": "customerGatewayConfiguration" + } + }, + "Type": { + "target": "com.amazonaws.ec2#GatewayType", + "traits": { + "aws.protocols#ec2QueryName": "Type", + "smithy.api#documentation": "

The type of VPN connection.

", + "smithy.api#xmlName": "type" + } + }, + "CustomerGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CustomerGatewayId", + "smithy.api#documentation": "

The ID of the customer gateway at your end of the VPN connection.

", + "smithy.api#xmlName": "customerGatewayId" + } + }, + "VpnGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpnGatewayId", + "smithy.api#documentation": "

The ID of the virtual private gateway at the Amazon Web Services side of the VPN\n connection.

", + "smithy.api#xmlName": "vpnGatewayId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a VPN connection.

" + } + }, + "com.amazonaws.ec2#VpnConnectionDeviceSampleConfiguration": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.ec2#VpnConnectionDeviceType": { + "type": "structure", + "members": { + "VpnConnectionDeviceTypeId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpnConnectionDeviceTypeId", + "smithy.api#documentation": "

Customer gateway device identifier.

", + "smithy.api#xmlName": "vpnConnectionDeviceTypeId" + } + }, + "Vendor": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Vendor", + "smithy.api#documentation": "

Customer gateway device vendor.

", + "smithy.api#xmlName": "vendor" + } + }, + "Platform": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Platform", + "smithy.api#documentation": "

Customer gateway device platform.

", + "smithy.api#xmlName": "platform" + } + }, + "Software": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Software", + "smithy.api#documentation": "

Customer gateway device software version.

", + "smithy.api#xmlName": "software" + } + } + }, + "traits": { + "smithy.api#documentation": "

List of customer gateway devices that have a sample configuration file available for\n use. You can also see the list of device types with sample configuration files available\n under Your customer\n gateway device in the Amazon Web Services Site-to-Site VPN User Guide.

" + } + }, + "com.amazonaws.ec2#VpnConnectionDeviceTypeId": { + "type": "string" + }, + "com.amazonaws.ec2#VpnConnectionDeviceTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VpnConnectionDeviceType", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VpnConnectionId": { + "type": "string" + }, + "com.amazonaws.ec2#VpnConnectionIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VpnConnectionId", + "traits": { + "smithy.api#xmlName": "VpnConnectionId" + } + } + }, + "com.amazonaws.ec2#VpnConnectionList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VpnConnection", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VpnConnectionOptions": { + "type": "structure", + "members": { + "EnableAcceleration": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EnableAcceleration", + "smithy.api#documentation": "

Indicates whether acceleration is enabled for the VPN connection.

", + "smithy.api#xmlName": "enableAcceleration" + } + }, + "StaticRoutesOnly": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "StaticRoutesOnly", + "smithy.api#documentation": "

Indicates whether the VPN connection uses static routes only. Static routes must be\n used for devices that don't support BGP.

", + "smithy.api#xmlName": "staticRoutesOnly" + } + }, + "LocalIpv4NetworkCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LocalIpv4NetworkCidr", + "smithy.api#documentation": "

The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.

", + "smithy.api#xmlName": "localIpv4NetworkCidr" + } + }, + "RemoteIpv4NetworkCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RemoteIpv4NetworkCidr", + "smithy.api#documentation": "

The IPv4 CIDR on the Amazon Web Services side of the VPN connection.

", + "smithy.api#xmlName": "remoteIpv4NetworkCidr" + } + }, + "LocalIpv6NetworkCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LocalIpv6NetworkCidr", + "smithy.api#documentation": "

The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.

", + "smithy.api#xmlName": "localIpv6NetworkCidr" + } + }, + "RemoteIpv6NetworkCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RemoteIpv6NetworkCidr", + "smithy.api#documentation": "

The IPv6 CIDR on the Amazon Web Services side of the VPN connection.

", + "smithy.api#xmlName": "remoteIpv6NetworkCidr" + } + }, + "OutsideIpAddressType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OutsideIpAddressType", + "smithy.api#documentation": "

The type of IPv4 address assigned to the outside interface of the customer gateway.

\n

Valid values: PrivateIpv4 | PublicIpv4\n

\n

Default: PublicIpv4\n

", + "smithy.api#xmlName": "outsideIpAddressType" + } + }, + "TransportTransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransportTransitGatewayAttachmentId", + "smithy.api#documentation": "

The transit gateway attachment ID in use for the VPN tunnel.

", + "smithy.api#xmlName": "transportTransitGatewayAttachmentId" + } + }, + "TunnelInsideIpVersion": { + "target": "com.amazonaws.ec2#TunnelInsideIpVersion", + "traits": { + "aws.protocols#ec2QueryName": "TunnelInsideIpVersion", + "smithy.api#documentation": "

Indicates whether the VPN tunnels process IPv4 or IPv6 traffic.

", + "smithy.api#xmlName": "tunnelInsideIpVersion" + } + }, + "TunnelOptions": { + "target": "com.amazonaws.ec2#TunnelOptionsList", + "traits": { + "aws.protocols#ec2QueryName": "TunnelOptionSet", + "smithy.api#documentation": "

Indicates the VPN tunnel options.

", + "smithy.api#xmlName": "tunnelOptionSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes VPN connection options.

" + } + }, + "com.amazonaws.ec2#VpnConnectionOptionsSpecification": { + "type": "structure", + "members": { + "EnableAcceleration": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicate whether to enable acceleration for the VPN connection.

\n

Default: false\n

" + } + }, + "TunnelInsideIpVersion": { + "target": "com.amazonaws.ec2#TunnelInsideIpVersion", + "traits": { + "smithy.api#documentation": "

Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.

\n

Default: ipv4\n

" + } + }, + "TunnelOptions": { + "target": "com.amazonaws.ec2#VpnTunnelOptionsSpecificationsList", + "traits": { + "smithy.api#documentation": "

The tunnel options for the VPN connection.

" + } + }, + "LocalIpv4NetworkCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.

\n

Default: 0.0.0.0/0\n

" + } + }, + "RemoteIpv4NetworkCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IPv4 CIDR on the Amazon Web Services side of the VPN connection.

\n

Default: 0.0.0.0/0\n

" + } + }, + "LocalIpv6NetworkCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.

\n

Default: ::/0\n

" + } + }, + "RemoteIpv6NetworkCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IPv6 CIDR on the Amazon Web Services side of the VPN connection.

\n

Default: ::/0\n

" + } + }, + "OutsideIpAddressType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The type of IPv4 address assigned to the outside interface of the customer gateway device.

\n

Valid values: PrivateIpv4 | PublicIpv4\n

\n

Default: PublicIpv4\n

" + } + }, + "TransportTransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#documentation": "

The transit gateway attachment ID to use for the VPN tunnel.

\n

Required if OutsideIpAddressType is set to PrivateIpv4.

" + } + }, + "StaticRoutesOnly": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "StaticRoutesOnly", + "smithy.api#documentation": "

Indicate whether the VPN connection uses static routes only. If you are creating a VPN\n connection for a device that does not support BGP, you must specify true.\n Use CreateVpnConnectionRoute to create a static route.

\n

Default: false\n

", + "smithy.api#xmlName": "staticRoutesOnly" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes VPN connection options.

" + } + }, + "com.amazonaws.ec2#VpnEcmpSupportValue": { + "type": "enum", + "members": { + "enable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enable" + } + }, + "disable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disable" + } + } + } + }, + "com.amazonaws.ec2#VpnGateway": { + "type": "structure", + "members": { + "AmazonSideAsn": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "AmazonSideAsn", + "smithy.api#documentation": "

The private Autonomous System Number (ASN) for the Amazon side of a BGP\n session.

", + "smithy.api#xmlName": "amazonSideAsn" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the virtual private gateway.

", + "smithy.api#xmlName": "tagSet" + } + }, + "VpnGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpnGatewayId", + "smithy.api#documentation": "

The ID of the virtual private gateway.

", + "smithy.api#xmlName": "vpnGatewayId" + } + }, + "State": { + "target": "com.amazonaws.ec2#VpnState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of the virtual private gateway.

", + "smithy.api#xmlName": "state" + } + }, + "Type": { + "target": "com.amazonaws.ec2#GatewayType", + "traits": { + "aws.protocols#ec2QueryName": "Type", + "smithy.api#documentation": "

The type of VPN connection the virtual private gateway supports.

", + "smithy.api#xmlName": "type" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone where the virtual private gateway was created, if applicable.\n This field may be empty or not returned.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "VpcAttachments": { + "target": "com.amazonaws.ec2#VpcAttachmentList", + "traits": { + "aws.protocols#ec2QueryName": "Attachments", + "smithy.api#documentation": "

Any VPCs attached to the virtual private gateway.

", + "smithy.api#xmlName": "attachments" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a virtual private gateway.

" + } + }, + "com.amazonaws.ec2#VpnGatewayId": { + "type": "string" + }, + "com.amazonaws.ec2#VpnGatewayIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VpnGatewayId", + "traits": { + "smithy.api#xmlName": "VpnGatewayId" + } + } + }, + "com.amazonaws.ec2#VpnGatewayList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VpnGateway", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VpnProtocol": { + "type": "enum", + "members": { + "openvpn": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "openvpn" + } + } + } + }, + "com.amazonaws.ec2#VpnState": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + }, + "deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted" + } + } + } + }, + "com.amazonaws.ec2#VpnStaticRoute": { + "type": "structure", + "members": { + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationCidrBlock", + "smithy.api#documentation": "

The CIDR block associated with the local subnet of the customer data center.

", + "smithy.api#xmlName": "destinationCidrBlock" + } + }, + "Source": { + "target": "com.amazonaws.ec2#VpnStaticRouteSource", + "traits": { + "aws.protocols#ec2QueryName": "Source", + "smithy.api#documentation": "

Indicates how the routes were provided.

", + "smithy.api#xmlName": "source" + } + }, + "State": { + "target": "com.amazonaws.ec2#VpnState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of the static route.

", + "smithy.api#xmlName": "state" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a static route for a VPN connection.

" + } + }, + "com.amazonaws.ec2#VpnStaticRouteList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VpnStaticRoute", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VpnStaticRouteSource": { + "type": "enum", + "members": { + "Static": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Static" + } + } + } + }, + "com.amazonaws.ec2#VpnTunnelLogOptions": { + "type": "structure", + "members": { + "CloudWatchLogOptions": { + "target": "com.amazonaws.ec2#CloudWatchLogOptions", + "traits": { + "aws.protocols#ec2QueryName": "CloudWatchLogOptions", + "smithy.api#documentation": "

Options for sending VPN tunnel logs to CloudWatch.

", + "smithy.api#xmlName": "cloudWatchLogOptions" + } + } + }, + "traits": { + "smithy.api#documentation": "

Options for logging VPN tunnel activity.

" + } + }, + "com.amazonaws.ec2#VpnTunnelLogOptionsSpecification": { + "type": "structure", + "members": { + "CloudWatchLogOptions": { + "target": "com.amazonaws.ec2#CloudWatchLogOptionsSpecification", + "traits": { + "smithy.api#documentation": "

Options for sending VPN tunnel logs to CloudWatch.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Options for logging VPN tunnel activity.

" + } + }, + "com.amazonaws.ec2#VpnTunnelOptionsSpecification": { + "type": "structure", + "members": { + "TunnelInsideCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The range of inside IPv4 addresses for the tunnel. Any specified CIDR blocks must be\n unique across all VPN connections that use the same virtual private gateway.

\n

Constraints: A size /30 CIDR block from the 169.254.0.0/16 range. The\n following CIDR blocks are reserved and cannot be used:

\n " + } + }, + "TunnelInsideIpv6Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The range of inside IPv6 addresses for the tunnel. Any specified CIDR blocks must be\n unique across all VPN connections that use the same transit gateway.

\n

Constraints: A size /126 CIDR block from the local fd00::/8 range.

" + } + }, + "PreSharedKey": { + "target": "com.amazonaws.ec2#preSharedKey", + "traits": { + "smithy.api#documentation": "

The pre-shared key (PSK) to establish initial authentication between the virtual\n private gateway and customer gateway.

\n

Constraints: Allowed characters are alphanumeric characters, periods (.), and\n underscores (_). Must be between 8 and 64 characters in length and cannot start with\n zero (0).

" + } + }, + "Phase1LifetimeSeconds": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The lifetime for phase 1 of the IKE negotiation, in seconds.

\n

Constraints: A value between 900 and 28,800.

\n

Default: 28800\n

" + } + }, + "Phase2LifetimeSeconds": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The lifetime for phase 2 of the IKE negotiation, in seconds.

\n

Constraints: A value between 900 and 3,600. The value must be less than the value for\n Phase1LifetimeSeconds.

\n

Default: 3600\n

" + } + }, + "RekeyMarginTimeSeconds": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The margin time, in seconds, before the phase 2 lifetime expires, during which the\n Amazon Web Services side of the VPN connection performs an IKE rekey. The exact time\n of the rekey is randomly selected based on the value for\n RekeyFuzzPercentage.

\n

Constraints: A value between 60 and half of Phase2LifetimeSeconds.

\n

Default: 270\n

" + } + }, + "RekeyFuzzPercentage": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The percentage of the rekey window (determined by RekeyMarginTimeSeconds)\n during which the rekey time is randomly selected.

\n

Constraints: A value between 0 and 100.

\n

Default: 100\n

" + } + }, + "ReplayWindowSize": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The number of packets in an IKE replay window.

\n

Constraints: A value between 64 and 2048.

\n

Default: 1024\n

" + } + }, + "DPDTimeoutSeconds": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The number of seconds after which a DPD timeout occurs.

\n

Constraints: A value greater than or equal to 30.

\n

Default: 30\n

" + } + }, + "DPDTimeoutAction": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The action to take after DPD timeout occurs. Specify restart to restart\n the IKE initiation. Specify clear to end the IKE session.

\n

Valid Values: clear | none | restart\n

\n

Default: clear\n

" + } + }, + "Phase1EncryptionAlgorithms": { + "target": "com.amazonaws.ec2#Phase1EncryptionAlgorithmsRequestList", + "traits": { + "smithy.api#documentation": "

One or more encryption algorithms that are permitted for the VPN tunnel for phase 1\n IKE negotiations.

\n

Valid values: AES128 | AES256 | AES128-GCM-16 |\n AES256-GCM-16\n

", + "smithy.api#xmlName": "Phase1EncryptionAlgorithm" + } + }, + "Phase2EncryptionAlgorithms": { + "target": "com.amazonaws.ec2#Phase2EncryptionAlgorithmsRequestList", + "traits": { + "smithy.api#documentation": "

One or more encryption algorithms that are permitted for the VPN tunnel for phase 2\n IKE negotiations.

\n

Valid values: AES128 | AES256 | AES128-GCM-16 |\n AES256-GCM-16\n

", + "smithy.api#xmlName": "Phase2EncryptionAlgorithm" + } + }, + "Phase1IntegrityAlgorithms": { + "target": "com.amazonaws.ec2#Phase1IntegrityAlgorithmsRequestList", + "traits": { + "smithy.api#documentation": "

One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE\n negotiations.

\n

Valid values: SHA1 | SHA2-256 | SHA2-384 |\n SHA2-512\n

", + "smithy.api#xmlName": "Phase1IntegrityAlgorithm" + } + }, + "Phase2IntegrityAlgorithms": { + "target": "com.amazonaws.ec2#Phase2IntegrityAlgorithmsRequestList", + "traits": { + "smithy.api#documentation": "

One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE\n negotiations.

\n

Valid values: SHA1 | SHA2-256 | SHA2-384 |\n SHA2-512\n

", + "smithy.api#xmlName": "Phase2IntegrityAlgorithm" + } + }, + "Phase1DHGroupNumbers": { + "target": "com.amazonaws.ec2#Phase1DHGroupNumbersRequestList", + "traits": { + "smithy.api#documentation": "

One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for\n phase 1 IKE negotiations.

\n

Valid values: 2 | 14 | 15 | 16 |\n 17 | 18 | 19 | 20 |\n 21 | 22 | 23 | 24\n

", + "smithy.api#xmlName": "Phase1DHGroupNumber" + } + }, + "Phase2DHGroupNumbers": { + "target": "com.amazonaws.ec2#Phase2DHGroupNumbersRequestList", + "traits": { + "smithy.api#documentation": "

One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for\n phase 2 IKE negotiations.

\n

Valid values: 2 | 5 | 14 | 15 |\n 16 | 17 | 18 | 19 |\n 20 | 21 | 22 | 23 |\n 24\n

", + "smithy.api#xmlName": "Phase2DHGroupNumber" + } + }, + "IKEVersions": { + "target": "com.amazonaws.ec2#IKEVersionsRequestList", + "traits": { + "smithy.api#documentation": "

The IKE versions that are permitted for the VPN tunnel.

\n

Valid values: ikev1 | ikev2\n

", + "smithy.api#xmlName": "IKEVersion" + } + }, + "StartupAction": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The action to take when the establishing the tunnel for the VPN connection. By\n default, your customer gateway device must initiate the IKE negotiation and bring up the\n tunnel. Specify start for Amazon Web Services to initiate the IKE\n negotiation.

\n

Valid Values: add | start\n

\n

Default: add\n

" + } + }, + "LogOptions": { + "target": "com.amazonaws.ec2#VpnTunnelLogOptionsSpecification", + "traits": { + "smithy.api#documentation": "

Options for logging VPN tunnel activity.

" + } + }, + "EnableTunnelLifecycleControl": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Turn on or off tunnel endpoint lifecycle control feature.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The tunnel options for a single VPN tunnel.

" + } + }, + "com.amazonaws.ec2#VpnTunnelOptionsSpecificationsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VpnTunnelOptionsSpecification" + } + }, + "com.amazonaws.ec2#WeekDay": { + "type": "enum", + "members": { + "sunday": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sunday" + } + }, + "monday": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "monday" + } + }, + "tuesday": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "tuesday" + } + }, + "wednesday": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "wednesday" + } + }, + "thursday": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "thursday" + } + }, + "friday": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "friday" + } + }, + "saturday": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "saturday" + } + } + } + }, + "com.amazonaws.ec2#WithdrawByoipCidr": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#WithdrawByoipCidrRequest" + }, + "output": { + "target": "com.amazonaws.ec2#WithdrawByoipCidrResult" + }, + "traits": { + "smithy.api#documentation": "

Stops advertising an address range that is provisioned as an address pool.

\n

You can perform this operation at most once every 10 seconds, even if you specify different \n address ranges each time.

\n

It can take a few minutes before traffic to the specified addresses stops routing to Amazon Web Services\n because of BGP propagation delays.

" + } + }, + "com.amazonaws.ec2#WithdrawByoipCidrRequest": { + "type": "structure", + "members": { + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The address range, in CIDR notation.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#WithdrawByoipCidrResult": { + "type": "structure", + "members": { + "ByoipCidr": { + "target": "com.amazonaws.ec2#ByoipCidr", + "traits": { + "aws.protocols#ec2QueryName": "ByoipCidr", + "smithy.api#documentation": "

Information about the address pool.

", + "smithy.api#xmlName": "byoipCidr" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ZoneIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "ZoneId" + } + } + }, + "com.amazonaws.ec2#ZoneNameStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "ZoneName" + } + } + }, + "com.amazonaws.ec2#customerGatewayConfiguration": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.ec2#preSharedKey": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.ec2#scope": { + "type": "enum", + "members": { + "AVAILABILITY_ZONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Availability Zone" + } + }, + "REGIONAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Region" + } + } + } + }, + "com.amazonaws.ec2#snapshotTierStatusSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SnapshotTierStatus", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#totalFpgaMemory": { + "type": "integer" + }, + "com.amazonaws.ec2#totalGpuMemory": { + "type": "integer" + }, + "com.amazonaws.ec2#totalInferenceMemory": { + "type": "integer" + } + } +} \ No newline at end of file diff --git a/pkg/testdata/codegen/sdk-codegen/aws-models/ecr.json b/pkg/testdata/codegen/sdk-codegen/aws-models/ecr.json new file mode 100644 index 00000000..9b6a6f86 --- /dev/null +++ b/pkg/testdata/codegen/sdk-codegen/aws-models/ecr.json @@ -0,0 +1,8685 @@ +{ + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.ecr#AccountSettingName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.ecr#AccountSettingValue": { + "type": "string" + }, + "com.amazonaws.ecr#AmazonEC2ContainerRegistry_V20150921": { + "type": "service", + "version": "2015-09-21", + "operations": [ + { + "target": "com.amazonaws.ecr#BatchCheckLayerAvailability" + }, + { + "target": "com.amazonaws.ecr#BatchDeleteImage" + }, + { + "target": "com.amazonaws.ecr#BatchGetImage" + }, + { + "target": "com.amazonaws.ecr#BatchGetRepositoryScanningConfiguration" + }, + { + "target": "com.amazonaws.ecr#CompleteLayerUpload" + }, + { + "target": "com.amazonaws.ecr#CreatePullThroughCacheRule" + }, + { + "target": "com.amazonaws.ecr#CreateRepository" + }, + { + "target": "com.amazonaws.ecr#CreateRepositoryCreationTemplate" + }, + { + "target": "com.amazonaws.ecr#DeleteLifecyclePolicy" + }, + { + "target": "com.amazonaws.ecr#DeletePullThroughCacheRule" + }, + { + "target": "com.amazonaws.ecr#DeleteRegistryPolicy" + }, + { + "target": "com.amazonaws.ecr#DeleteRepository" + }, + { + "target": "com.amazonaws.ecr#DeleteRepositoryCreationTemplate" + }, + { + "target": "com.amazonaws.ecr#DeleteRepositoryPolicy" + }, + { + "target": "com.amazonaws.ecr#DescribeImageReplicationStatus" + }, + { + "target": "com.amazonaws.ecr#DescribeImages" + }, + { + "target": "com.amazonaws.ecr#DescribeImageScanFindings" + }, + { + "target": "com.amazonaws.ecr#DescribePullThroughCacheRules" + }, + { + "target": "com.amazonaws.ecr#DescribeRegistry" + }, + { + "target": "com.amazonaws.ecr#DescribeRepositories" + }, + { + "target": "com.amazonaws.ecr#DescribeRepositoryCreationTemplates" + }, + { + "target": "com.amazonaws.ecr#GetAccountSetting" + }, + { + "target": "com.amazonaws.ecr#GetAuthorizationToken" + }, + { + "target": "com.amazonaws.ecr#GetDownloadUrlForLayer" + }, + { + "target": "com.amazonaws.ecr#GetLifecyclePolicy" + }, + { + "target": "com.amazonaws.ecr#GetLifecyclePolicyPreview" + }, + { + "target": "com.amazonaws.ecr#GetRegistryPolicy" + }, + { + "target": "com.amazonaws.ecr#GetRegistryScanningConfiguration" + }, + { + "target": "com.amazonaws.ecr#GetRepositoryPolicy" + }, + { + "target": "com.amazonaws.ecr#InitiateLayerUpload" + }, + { + "target": "com.amazonaws.ecr#ListImages" + }, + { + "target": "com.amazonaws.ecr#ListTagsForResource" + }, + { + "target": "com.amazonaws.ecr#PutAccountSetting" + }, + { + "target": "com.amazonaws.ecr#PutImage" + }, + { + "target": "com.amazonaws.ecr#PutImageScanningConfiguration" + }, + { + "target": "com.amazonaws.ecr#PutImageTagMutability" + }, + { + "target": "com.amazonaws.ecr#PutLifecyclePolicy" + }, + { + "target": "com.amazonaws.ecr#PutRegistryPolicy" + }, + { + "target": "com.amazonaws.ecr#PutRegistryScanningConfiguration" + }, + { + "target": "com.amazonaws.ecr#PutReplicationConfiguration" + }, + { + "target": "com.amazonaws.ecr#SetRepositoryPolicy" + }, + { + "target": "com.amazonaws.ecr#StartImageScan" + }, + { + "target": "com.amazonaws.ecr#StartLifecyclePolicyPreview" + }, + { + "target": "com.amazonaws.ecr#TagResource" + }, + { + "target": "com.amazonaws.ecr#UntagResource" + }, + { + "target": "com.amazonaws.ecr#UpdatePullThroughCacheRule" + }, + { + "target": "com.amazonaws.ecr#UpdateRepositoryCreationTemplate" + }, + { + "target": "com.amazonaws.ecr#UploadLayerPart" + }, + { + "target": "com.amazonaws.ecr#ValidatePullThroughCacheRule" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "ECR", + "arnNamespace": "ecr", + "cloudFormationName": "ECR", + "cloudTrailEventSource": "ecr.amazonaws.com", + "endpointPrefix": "api.ecr" + }, + "aws.auth#sigv4": { + "name": "ecr" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "Amazon Elastic Container Registry\n

Amazon Elastic Container Registry (Amazon ECR) is a managed container image registry service. Customers can use the\n familiar Docker CLI, or their preferred client, to push, pull, and manage images. Amazon ECR\n provides a secure, scalable, and reliable registry for your Docker or Open Container\n Initiative (OCI) images. Amazon ECR supports private repositories with resource-based\n permissions using IAM so that specific users or Amazon EC2 instances can access\n repositories and images.

\n

Amazon ECR has service endpoints in each supported Region. For more information, see Amazon ECR endpoints in the\n Amazon Web Services General Reference.

", + "smithy.api#title": "Amazon Elastic Container Registry", + "smithy.api#xmlNamespace": { + "uri": "http://ecr.amazonaws.com/doc/2015-09-21/" + }, + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://api.ecr-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws" + ] + } + ], + "endpoint": { + "url": "https://ecr-fips.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-us-gov" + ] + } + ], + "endpoint": { + "url": "https://ecr-fips.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://api.ecr-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://api.ecr.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://api.ecr.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.af-south-1.amazonaws.com" + } + }, + "params": { + "Region": "af-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.ap-east-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.ap-south-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.eu-north-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.eu-south-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.eu-west-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.eu-west-3.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.me-south-1.amazonaws.com" + } + }, + "params": { + "Region": "me-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.sa-east-1.amazonaws.com" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ecr-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ecr-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ecr-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ecr-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://api.ecr-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://api.ecr-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ecr-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ecr-fips.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://api.ecr-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.us-iso-west-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.ecr#Arch": { + "type": "string" + }, + "com.amazonaws.ecr#Arn": { + "type": "string" + }, + "com.amazonaws.ecr#Attribute": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.ecr#AttributeKey", + "traits": { + "smithy.api#documentation": "

The attribute key.

", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.ecr#AttributeValue", + "traits": { + "smithy.api#documentation": "

The value assigned to the attribute key.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used in the ImageScanFinding data type.

" + } + }, + "com.amazonaws.ecr#AttributeKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.ecr#AttributeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#Attribute" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.ecr#AttributeValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.ecr#Author": { + "type": "string" + }, + "com.amazonaws.ecr#AuthorizationData": { + "type": "structure", + "members": { + "authorizationToken": { + "target": "com.amazonaws.ecr#Base64", + "traits": { + "smithy.api#documentation": "

A base64-encoded string that contains authorization data for the specified Amazon ECR\n registry. When the string is decoded, it is presented in the format\n user:password for private registry authentication using docker\n login.

" + } + }, + "expiresAt": { + "target": "com.amazonaws.ecr#ExpirationTimestamp", + "traits": { + "smithy.api#documentation": "

The Unix time in seconds and milliseconds when the authorization token expires.\n Authorization tokens are valid for 12 hours.

" + } + }, + "proxyEndpoint": { + "target": "com.amazonaws.ecr#ProxyEndpoint", + "traits": { + "smithy.api#documentation": "

The registry URL to use for this authorization token in a docker login\n command. The Amazon ECR registry URL format is\n https://aws_account_id.dkr.ecr.region.amazonaws.com. For example,\n https://012345678910.dkr.ecr.us-east-1.amazonaws.com..

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object representing authorization data for an Amazon ECR registry.

" + } + }, + "com.amazonaws.ecr#AuthorizationDataList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#AuthorizationData" + } + }, + "com.amazonaws.ecr#AwsEcrContainerImageDetails": { + "type": "structure", + "members": { + "architecture": { + "target": "com.amazonaws.ecr#Arch", + "traits": { + "smithy.api#documentation": "

The architecture of the Amazon ECR container image.

" + } + }, + "author": { + "target": "com.amazonaws.ecr#Author", + "traits": { + "smithy.api#documentation": "

The image author of the Amazon ECR container image.

" + } + }, + "imageHash": { + "target": "com.amazonaws.ecr#ImageDigest", + "traits": { + "smithy.api#documentation": "

The image hash of the Amazon ECR container image.

" + } + }, + "imageTags": { + "target": "com.amazonaws.ecr#ImageTagsList", + "traits": { + "smithy.api#documentation": "

The image tags attached to the Amazon ECR container image.

" + } + }, + "platform": { + "target": "com.amazonaws.ecr#Platform", + "traits": { + "smithy.api#documentation": "

The platform of the Amazon ECR container image.

" + } + }, + "pushedAt": { + "target": "com.amazonaws.ecr#Date", + "traits": { + "smithy.api#documentation": "

The date and time the Amazon ECR container image was pushed.

" + } + }, + "registry": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The registry the Amazon ECR container image belongs to.

" + } + }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The name of the repository the Amazon ECR container image resides in.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The image details of the Amazon ECR container image.

" + } + }, + "com.amazonaws.ecr#Base64": { + "type": "string", + "traits": { + "smithy.api#pattern": "^\\S+$" + } + }, + "com.amazonaws.ecr#BaseScore": { + "type": "double", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.ecr#BatchCheckLayerAvailability": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#BatchCheckLayerAvailabilityRequest" + }, + "output": { + "target": "com.amazonaws.ecr#BatchCheckLayerAvailabilityResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#RepositoryNotFoundException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Checks the availability of one or more image layers in a repository.

\n

When an image is pushed to a repository, each image layer is checked to verify if it\n has been uploaded before. If it has been uploaded, then the image layer is\n skipped.

\n \n

This operation is used by the Amazon ECR proxy and is not generally used by\n customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

\n " + } + }, + "com.amazonaws.ecr#BatchCheckLayerAvailabilityRequest": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID associated with the registry that contains the image layers to\n check. If you do not specify a registry, the default registry is assumed.

" + } + }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The name of the repository that is associated with the image layers to check.

", + "smithy.api#required": {} + } + }, + "layerDigests": { + "target": "com.amazonaws.ecr#BatchedOperationLayerDigestList", + "traits": { + "smithy.api#documentation": "

The digests of the image layers to check.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#BatchCheckLayerAvailabilityResponse": { + "type": "structure", + "members": { + "layers": { + "target": "com.amazonaws.ecr#LayerList", + "traits": { + "smithy.api#documentation": "

A list of image layer objects corresponding to the image layer references in the\n request.

" + } + }, + "failures": { + "target": "com.amazonaws.ecr#LayerFailureList", + "traits": { + "smithy.api#documentation": "

Any failures associated with the call.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#BatchDeleteImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#BatchDeleteImageRequest" + }, + "output": { + "target": "com.amazonaws.ecr#BatchDeleteImageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#RepositoryNotFoundException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a list of specified images within a repository. Images are specified with\n either an imageTag or imageDigest.

\n

You can remove a tag from an image by specifying the image's tag in your request. When\n you remove the last tag from an image, the image is deleted from your repository.

\n

You can completely delete an image (and all of its tags) by specifying the image's\n digest in your request.

", + "smithy.api#examples": [ + { + "title": "To delete multiple images", + "documentation": "This example deletes images with the tags precise and trusty in a repository called ubuntu in the default registry for an account.", + "input": { + "repositoryName": "ubuntu", + "imageIds": [ + { + "imageTag": "precise" + } + ] + }, + "output": { + "failures": [], + "imageIds": [ + { + "imageTag": "precise", + "imageDigest": "sha256:examplee6d1e504117a17000003d3753086354a38375961f2e665416ef4b1b2f" + } + ] + } + } + ] + } + }, + "com.amazonaws.ecr#BatchDeleteImageRequest": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID associated with the registry that contains the image to delete.\n If you do not specify a registry, the default registry is assumed.

" + } + }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The repository that contains the image to delete.

", + "smithy.api#required": {} + } + }, + "imageIds": { + "target": "com.amazonaws.ecr#ImageIdentifierList", + "traits": { + "smithy.api#documentation": "

A list of image ID references that correspond to images to delete. The format of the\n imageIds reference is imageTag=tag or\n imageDigest=digest.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Deletes specified images within a specified repository. Images are specified with\n either the imageTag or imageDigest.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#BatchDeleteImageResponse": { + "type": "structure", + "members": { + "imageIds": { + "target": "com.amazonaws.ecr#ImageIdentifierList", + "traits": { + "smithy.api#documentation": "

The image IDs of the deleted images.

" + } + }, + "failures": { + "target": "com.amazonaws.ecr#ImageFailureList", + "traits": { + "smithy.api#documentation": "

Any failures associated with the call.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#BatchGetImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#BatchGetImageRequest" + }, + "output": { + "target": "com.amazonaws.ecr#BatchGetImageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#LimitExceededException" + }, + { + "target": "com.amazonaws.ecr#RepositoryNotFoundException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#UnableToGetUpstreamImageException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets detailed information for an image. Images are specified with either an\n imageTag or imageDigest.

\n

When an image is pulled, the BatchGetImage API is called once to retrieve the image\n manifest.

", + "smithy.api#examples": [ + { + "title": "To obtain multiple images in a single request", + "documentation": "This example obtains information for an image with a specified image digest ID from the repository named ubuntu in the current account.", + "input": { + "repositoryName": "ubuntu", + "imageIds": [ + { + "imageTag": "precise" + } + ] + }, + "output": { + "images": [ + { + "imageManifest": "{\n \"schemaVersion\": 1,\n \"name\": \"ubuntu\",\n \"tag\": \"precise\",\n...", + "repositoryName": "ubuntu", + "registryId": "244698725403", + "imageId": { + "imageTag": "precise", + "imageDigest": "sha256:example76bdff6d83a09ba2a818f0d00000063724a9ac3ba5019c56f74ebf42a" + } + } + ], + "failures": [] + } + } + ] + } + }, + "com.amazonaws.ecr#BatchGetImageRequest": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID associated with the registry that contains the images to\n describe. If you do not specify a registry, the default registry is assumed.

" + } + }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The repository that contains the images to describe.

", + "smithy.api#required": {} + } + }, + "imageIds": { + "target": "com.amazonaws.ecr#ImageIdentifierList", + "traits": { + "smithy.api#documentation": "

A list of image ID references that correspond to images to describe. The format of the\n imageIds reference is imageTag=tag or\n imageDigest=digest.

", + "smithy.api#required": {} + } + }, + "acceptedMediaTypes": { + "target": "com.amazonaws.ecr#MediaTypeList", + "traits": { + "smithy.api#documentation": "

The accepted media types for the request.

\n

Valid values: application/vnd.docker.distribution.manifest.v1+json |\n application/vnd.docker.distribution.manifest.v2+json |\n application/vnd.oci.image.manifest.v1+json\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#BatchGetImageResponse": { + "type": "structure", + "members": { + "images": { + "target": "com.amazonaws.ecr#ImageList", + "traits": { + "smithy.api#documentation": "

A list of image objects corresponding to the image references in the request.

" + } + }, + "failures": { + "target": "com.amazonaws.ecr#ImageFailureList", + "traits": { + "smithy.api#documentation": "

Any failures associated with the call.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#BatchGetRepositoryScanningConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#BatchGetRepositoryScanningConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.ecr#BatchGetRepositoryScanningConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#RepositoryNotFoundException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the scanning configuration for one or more repositories.

" + } + }, + "com.amazonaws.ecr#BatchGetRepositoryScanningConfigurationRequest": { + "type": "structure", + "members": { + "repositoryNames": { + "target": "com.amazonaws.ecr#ScanningConfigurationRepositoryNameList", + "traits": { + "smithy.api#documentation": "

One or more repository names to get the scanning configuration for.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#BatchGetRepositoryScanningConfigurationResponse": { + "type": "structure", + "members": { + "scanningConfigurations": { + "target": "com.amazonaws.ecr#RepositoryScanningConfigurationList", + "traits": { + "smithy.api#documentation": "

The scanning configuration for the requested repositories.

" + } + }, + "failures": { + "target": "com.amazonaws.ecr#RepositoryScanningConfigurationFailureList", + "traits": { + "smithy.api#documentation": "

Any failures associated with the call.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#BatchedOperationLayerDigest": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + } + } + }, + "com.amazonaws.ecr#BatchedOperationLayerDigestList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#BatchedOperationLayerDigest" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.ecr#CompleteLayerUpload": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#CompleteLayerUploadRequest" + }, + "output": { + "target": "com.amazonaws.ecr#CompleteLayerUploadResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#EmptyUploadException" + }, + { + "target": "com.amazonaws.ecr#InvalidLayerException" + }, + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#KmsException" + }, + { + "target": "com.amazonaws.ecr#LayerAlreadyExistsException" + }, + { + "target": "com.amazonaws.ecr#LayerPartTooSmallException" + }, + { + "target": "com.amazonaws.ecr#RepositoryNotFoundException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#UploadNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Informs Amazon ECR that the image layer upload has completed for a specified registry,\n repository name, and upload ID. You can optionally provide a sha256 digest\n of the image layer for data validation purposes.

\n

When an image is pushed, the CompleteLayerUpload API is called once per each new image\n layer to verify that the upload has completed.

\n \n

This operation is used by the Amazon ECR proxy and is not generally used by\n customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

\n " + } + }, + "com.amazonaws.ecr#CompleteLayerUploadRequest": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID associated with the registry to which to upload layers.\n If you do not specify a registry, the default registry is assumed.

" + } + }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The name of the repository to associate with the image layer.

", + "smithy.api#required": {} + } + }, + "uploadId": { + "target": "com.amazonaws.ecr#UploadId", + "traits": { + "smithy.api#documentation": "

The upload ID from a previous InitiateLayerUpload operation to\n associate with the image layer.

", + "smithy.api#required": {} + } + }, + "layerDigests": { + "target": "com.amazonaws.ecr#LayerDigestList", + "traits": { + "smithy.api#documentation": "

The sha256 digest of the image layer.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#CompleteLayerUploadResponse": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The registry ID associated with the request.

" + } + }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The repository name associated with the request.

" + } + }, + "uploadId": { + "target": "com.amazonaws.ecr#UploadId", + "traits": { + "smithy.api#documentation": "

The upload ID associated with the layer.

" + } + }, + "layerDigest": { + "target": "com.amazonaws.ecr#LayerDigest", + "traits": { + "smithy.api#documentation": "

The sha256 digest of the image layer.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#CreatePullThroughCacheRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#CreatePullThroughCacheRuleRequest" + }, + "output": { + "target": "com.amazonaws.ecr#CreatePullThroughCacheRuleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#LimitExceededException" + }, + { + "target": "com.amazonaws.ecr#PullThroughCacheRuleAlreadyExistsException" + }, + { + "target": "com.amazonaws.ecr#SecretNotFoundException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#UnableToAccessSecretException" + }, + { + "target": "com.amazonaws.ecr#UnableToDecryptSecretValueException" + }, + { + "target": "com.amazonaws.ecr#UnsupportedUpstreamRegistryException" + }, + { + "target": "com.amazonaws.ecr#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a pull through cache rule. A pull through cache rule provides a way to cache\n images from an upstream registry source in your Amazon ECR private registry. For more\n information, see Using pull through cache\n rules in the Amazon Elastic Container Registry User Guide.

" + } + }, + "com.amazonaws.ecr#CreatePullThroughCacheRuleRequest": { + "type": "structure", + "members": { + "ecrRepositoryPrefix": { + "target": "com.amazonaws.ecr#PullThroughCacheRuleRepositoryPrefix", + "traits": { + "smithy.api#documentation": "

The repository name prefix to use when caching images from the source registry.

", + "smithy.api#required": {} + } + }, + "upstreamRegistryUrl": { + "target": "com.amazonaws.ecr#Url", + "traits": { + "smithy.api#documentation": "

The registry URL of the upstream public registry to use as the source for the pull\n through cache rule. The following is the syntax to use for each supported upstream\n registry.

\n ", + "smithy.api#required": {} + } + }, + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID associated with the registry to create the pull through cache\n rule for. If you do not specify a registry, the default registry is assumed.

" + } + }, + "upstreamRegistry": { + "target": "com.amazonaws.ecr#UpstreamRegistry", + "traits": { + "smithy.api#documentation": "

The name of the upstream registry.

" + } + }, + "credentialArn": { + "target": "com.amazonaws.ecr#CredentialArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that identifies the credentials to authenticate\n to the upstream registry.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#CreatePullThroughCacheRuleResponse": { + "type": "structure", + "members": { + "ecrRepositoryPrefix": { + "target": "com.amazonaws.ecr#PullThroughCacheRuleRepositoryPrefix", + "traits": { + "smithy.api#documentation": "

The Amazon ECR repository prefix associated with the pull through cache rule.

" + } + }, + "upstreamRegistryUrl": { + "target": "com.amazonaws.ecr#Url", + "traits": { + "smithy.api#documentation": "

The upstream registry URL associated with the pull through cache rule.

" + } + }, + "createdAt": { + "target": "com.amazonaws.ecr#CreationTimestamp", + "traits": { + "smithy.api#documentation": "

The date and time, in JavaScript date format, when the pull through cache rule was\n created.

" + } + }, + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The registry ID associated with the request.

" + } + }, + "upstreamRegistry": { + "target": "com.amazonaws.ecr#UpstreamRegistry", + "traits": { + "smithy.api#documentation": "

The name of the upstream registry associated with the pull through cache rule.

" + } + }, + "credentialArn": { + "target": "com.amazonaws.ecr#CredentialArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret associated with the pull through cache\n rule.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#CreateRepository": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#CreateRepositoryRequest" + }, + "output": { + "target": "com.amazonaws.ecr#CreateRepositoryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#InvalidTagParameterException" + }, + { + "target": "com.amazonaws.ecr#KmsException" + }, + { + "target": "com.amazonaws.ecr#LimitExceededException" + }, + { + "target": "com.amazonaws.ecr#RepositoryAlreadyExistsException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#TooManyTagsException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a repository. For more information, see Amazon ECR repositories in the\n Amazon Elastic Container Registry User Guide.

", + "smithy.api#examples": [ + { + "title": "To create a new repository", + "documentation": "This example creates a repository called nginx-web-app inside the project-a namespace in the default registry for an account.", + "input": { + "repositoryName": "project-a/nginx-web-app" + }, + "output": { + "repository": { + "registryId": "012345678901", + "repositoryName": "project-a/nginx-web-app", + "repositoryArn": "arn:aws:ecr:us-west-2:012345678901:repository/project-a/nginx-web-app" + } + } + } + ] + } + }, + "com.amazonaws.ecr#CreateRepositoryCreationTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#CreateRepositoryCreationTemplateRequest" + }, + "output": { + "target": "com.amazonaws.ecr#CreateRepositoryCreationTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#LimitExceededException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#TemplateAlreadyExistsException" + }, + { + "target": "com.amazonaws.ecr#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a repository creation template. This template is used to define the settings\n for repositories created by Amazon ECR on your behalf. For example, repositories created\n through pull through cache actions. For more information, see Private\n repository creation templates in the\n Amazon Elastic Container Registry User Guide.

" + } + }, + "com.amazonaws.ecr#CreateRepositoryCreationTemplateRequest": { + "type": "structure", + "members": { + "prefix": { + "target": "com.amazonaws.ecr#Prefix", + "traits": { + "smithy.api#documentation": "

The repository namespace prefix to associate with the template. All repositories\n created using this namespace prefix will have the settings defined in this template\n applied. For example, a prefix of prod would apply to all repositories\n beginning with prod/. Similarly, a prefix of prod/team would\n apply to all repositories beginning with prod/team/.

\n

To apply a template to all repositories in your registry that don't have an associated\n creation template, you can use ROOT as the prefix.

\n \n

There is always an assumed / applied to the end of the prefix. If you\n specify ecr-public as the prefix, Amazon ECR treats that as\n ecr-public/. When using a pull through cache rule, the repository\n prefix you specify during rule creation is what you should specify as your\n repository creation template prefix as well.

\n ", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.ecr#RepositoryTemplateDescription", + "traits": { + "smithy.api#documentation": "

A description for the repository creation template.

" + } + }, + "encryptionConfiguration": { + "target": "com.amazonaws.ecr#EncryptionConfigurationForRepositoryCreationTemplate", + "traits": { + "smithy.api#documentation": "

The encryption configuration to use for repositories created using the\n template.

" + } + }, + "resourceTags": { + "target": "com.amazonaws.ecr#TagList", + "traits": { + "smithy.api#documentation": "

The metadata to apply to the repository to help you categorize and organize. Each tag\n consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.

" + } + }, + "imageTagMutability": { + "target": "com.amazonaws.ecr#ImageTagMutability", + "traits": { + "smithy.api#documentation": "

The tag mutability setting for the repository. If this parameter is omitted, the\n default setting of MUTABLE will be used which will allow image tags to be\n overwritten. If IMMUTABLE is specified, all image tags within the\n repository will be immutable which will prevent them from being overwritten.

" + } + }, + "repositoryPolicy": { + "target": "com.amazonaws.ecr#RepositoryPolicyText", + "traits": { + "smithy.api#documentation": "

The repository policy to apply to repositories created using the template. A\n repository policy is a permissions policy associated with a repository to control access\n permissions.

" + } + }, + "lifecyclePolicy": { + "target": "com.amazonaws.ecr#LifecyclePolicyTextForRepositoryCreationTemplate", + "traits": { + "smithy.api#documentation": "

The lifecycle policy to use for repositories created using the template.

" + } + }, + "appliedFor": { + "target": "com.amazonaws.ecr#RCTAppliedForList", + "traits": { + "smithy.api#documentation": "

A list of enumerable strings representing the Amazon ECR repository creation scenarios that\n this template will apply towards. The two supported scenarios are\n PULL_THROUGH_CACHE and REPLICATION\n

", + "smithy.api#required": {} + } + }, + "customRoleArn": { + "target": "com.amazonaws.ecr#CustomRoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of the role to be assumed by Amazon ECR. This role must be in the same account as\n the registry that you are configuring. Amazon ECR will assume your supplied role when the\n customRoleArn is specified. When this field isn't specified, Amazon ECR will use the\n service-linked role for the repository creation template.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#CreateRepositoryCreationTemplateResponse": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The registry ID associated with the request.

" + } + }, + "repositoryCreationTemplate": { + "target": "com.amazonaws.ecr#RepositoryCreationTemplate", + "traits": { + "smithy.api#documentation": "

The details of the repository creation template associated with the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#CreateRepositoryRequest": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID associated with the registry to create the repository.\n If you do not specify a registry, the default registry is assumed.

" + } + }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The name to use for the repository. The repository name may be specified on its own\n (such as nginx-web-app) or it can be prepended with a namespace to group\n the repository into a category (such as project-a/nginx-web-app).

\n

The repository name must start with a letter and can only contain lowercase letters,\n numbers, hyphens, underscores, and forward slashes.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.ecr#TagList", + "traits": { + "smithy.api#documentation": "

The metadata that you apply to the repository to help you categorize and organize\n them. Each tag consists of a key and an optional value, both of which you define.\n Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.

" + } + }, + "imageTagMutability": { + "target": "com.amazonaws.ecr#ImageTagMutability", + "traits": { + "smithy.api#documentation": "

The tag mutability setting for the repository. If this parameter is omitted, the\n default setting of MUTABLE will be used which will allow image tags to be\n overwritten. If IMMUTABLE is specified, all image tags within the\n repository will be immutable which will prevent them from being overwritten.

" + } + }, + "imageScanningConfiguration": { + "target": "com.amazonaws.ecr#ImageScanningConfiguration", + "traits": { + "smithy.api#documentation": "

The image scanning configuration for the repository. This determines whether images\n are scanned for known vulnerabilities after being pushed to the repository.

" + } + }, + "encryptionConfiguration": { + "target": "com.amazonaws.ecr#EncryptionConfiguration", + "traits": { + "smithy.api#documentation": "

The encryption configuration for the repository. This determines how the contents of\n your repository are encrypted at rest.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#CreateRepositoryResponse": { + "type": "structure", + "members": { + "repository": { + "target": "com.amazonaws.ecr#Repository", + "traits": { + "smithy.api#documentation": "

The repository that was created.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#CreationTimestamp": { + "type": "timestamp" + }, + "com.amazonaws.ecr#CredentialArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 50, + "max": 612 + }, + "smithy.api#pattern": "^arn:aws:secretsmanager:[a-zA-Z0-9-:]+:secret:ecr\\-pullthroughcache\\/[a-zA-Z0-9\\/_+=.@-]+$" + } + }, + "com.amazonaws.ecr#CustomRoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + } + } + }, + "com.amazonaws.ecr#CvssScore": { + "type": "structure", + "members": { + "baseScore": { + "target": "com.amazonaws.ecr#BaseScore", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The base CVSS score used for the finding.

" + } + }, + "scoringVector": { + "target": "com.amazonaws.ecr#ScoringVector", + "traits": { + "smithy.api#documentation": "

The vector string of the CVSS score.

" + } + }, + "source": { + "target": "com.amazonaws.ecr#Source", + "traits": { + "smithy.api#documentation": "

The source of the CVSS score.

" + } + }, + "version": { + "target": "com.amazonaws.ecr#Version", + "traits": { + "smithy.api#documentation": "

The version of CVSS used for the score.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The CVSS score for a finding.

" + } + }, + "com.amazonaws.ecr#CvssScoreAdjustment": { + "type": "structure", + "members": { + "metric": { + "target": "com.amazonaws.ecr#Metric", + "traits": { + "smithy.api#documentation": "

The metric used to adjust the CVSS score.

" + } + }, + "reason": { + "target": "com.amazonaws.ecr#Reason", + "traits": { + "smithy.api#documentation": "

The reason the CVSS score has been adjustment.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details on adjustments Amazon Inspector made to the CVSS score for a finding.

" + } + }, + "com.amazonaws.ecr#CvssScoreAdjustmentList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#CvssScoreAdjustment" + } + }, + "com.amazonaws.ecr#CvssScoreDetails": { + "type": "structure", + "members": { + "adjustments": { + "target": "com.amazonaws.ecr#CvssScoreAdjustmentList", + "traits": { + "smithy.api#documentation": "

An object that contains details about adjustment Amazon Inspector made to the CVSS score.

" + } + }, + "score": { + "target": "com.amazonaws.ecr#Score", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The CVSS score.

" + } + }, + "scoreSource": { + "target": "com.amazonaws.ecr#Source", + "traits": { + "smithy.api#documentation": "

The source for the CVSS score.

" + } + }, + "scoringVector": { + "target": "com.amazonaws.ecr#ScoringVector", + "traits": { + "smithy.api#documentation": "

The vector for the CVSS score.

" + } + }, + "version": { + "target": "com.amazonaws.ecr#Version", + "traits": { + "smithy.api#documentation": "

The CVSS version used in scoring.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the CVSS score.

" + } + }, + "com.amazonaws.ecr#CvssScoreList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#CvssScore" + } + }, + "com.amazonaws.ecr#Date": { + "type": "timestamp" + }, + "com.amazonaws.ecr#DeleteLifecyclePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#DeleteLifecyclePolicyRequest" + }, + "output": { + "target": "com.amazonaws.ecr#DeleteLifecyclePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#LifecyclePolicyNotFoundException" + }, + { + "target": "com.amazonaws.ecr#RepositoryNotFoundException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the lifecycle policy associated with the specified repository.

" + } + }, + "com.amazonaws.ecr#DeleteLifecyclePolicyRequest": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID associated with the registry that contains the repository.\n If you do not specify a registry, the default registry is assumed.

" + } + }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The name of the repository.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#DeleteLifecyclePolicyResponse": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The registry ID associated with the request.

" + } + }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The repository name associated with the request.

" + } + }, + "lifecyclePolicyText": { + "target": "com.amazonaws.ecr#LifecyclePolicyText", + "traits": { + "smithy.api#documentation": "

The JSON lifecycle policy text.

" + } + }, + "lastEvaluatedAt": { + "target": "com.amazonaws.ecr#EvaluationTimestamp", + "traits": { + "smithy.api#documentation": "

The time stamp of the last time that the lifecycle policy was run.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#DeletePullThroughCacheRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#DeletePullThroughCacheRuleRequest" + }, + "output": { + "target": "com.amazonaws.ecr#DeletePullThroughCacheRuleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#PullThroughCacheRuleNotFoundException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a pull through cache rule.

" + } + }, + "com.amazonaws.ecr#DeletePullThroughCacheRuleRequest": { + "type": "structure", + "members": { + "ecrRepositoryPrefix": { + "target": "com.amazonaws.ecr#PullThroughCacheRuleRepositoryPrefix", + "traits": { + "smithy.api#documentation": "

The Amazon ECR repository prefix associated with the pull through cache rule to\n delete.

", + "smithy.api#required": {} + } + }, + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID associated with the registry that contains the pull through cache\n rule. If you do not specify a registry, the default registry is assumed.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#DeletePullThroughCacheRuleResponse": { + "type": "structure", + "members": { + "ecrRepositoryPrefix": { + "target": "com.amazonaws.ecr#PullThroughCacheRuleRepositoryPrefix", + "traits": { + "smithy.api#documentation": "

The Amazon ECR repository prefix associated with the request.

" + } + }, + "upstreamRegistryUrl": { + "target": "com.amazonaws.ecr#Url", + "traits": { + "smithy.api#documentation": "

The upstream registry URL associated with the pull through cache rule.

" + } + }, + "createdAt": { + "target": "com.amazonaws.ecr#CreationTimestamp", + "traits": { + "smithy.api#documentation": "

The timestamp associated with the pull through cache rule.

" + } + }, + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The registry ID associated with the request.

" + } + }, + "credentialArn": { + "target": "com.amazonaws.ecr#CredentialArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret associated with the pull through cache\n rule.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#DeleteRegistryPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#DeleteRegistryPolicyRequest" + }, + "output": { + "target": "com.amazonaws.ecr#DeleteRegistryPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#RegistryPolicyNotFoundException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the registry permissions policy.

" + } + }, + "com.amazonaws.ecr#DeleteRegistryPolicyRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#DeleteRegistryPolicyResponse": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The registry ID associated with the request.

" + } + }, + "policyText": { + "target": "com.amazonaws.ecr#RegistryPolicyText", + "traits": { + "smithy.api#documentation": "

The contents of the registry permissions policy that was deleted.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#DeleteRepository": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#DeleteRepositoryRequest" + }, + "output": { + "target": "com.amazonaws.ecr#DeleteRepositoryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#KmsException" + }, + { + "target": "com.amazonaws.ecr#RepositoryNotEmptyException" + }, + { + "target": "com.amazonaws.ecr#RepositoryNotFoundException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a repository. If the repository isn't empty, you must either delete the\n contents of the repository or use the force option to delete the repository\n and have Amazon ECR delete all of its contents on your behalf.

", + "smithy.api#examples": [ + { + "title": "To force delete a repository", + "documentation": "This example force deletes a repository named ubuntu in the default registry for an account. The force parameter is required if the repository contains images.", + "input": { + "repositoryName": "ubuntu", + "force": true + }, + "output": { + "repository": { + "registryId": "012345678901", + "repositoryName": "ubuntu", + "repositoryArn": "arn:aws:ecr:us-west-2:012345678901:repository/ubuntu" + } + } + } + ] + } + }, + "com.amazonaws.ecr#DeleteRepositoryCreationTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#DeleteRepositoryCreationTemplateRequest" + }, + "output": { + "target": "com.amazonaws.ecr#DeleteRepositoryCreationTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#TemplateNotFoundException" + }, + { + "target": "com.amazonaws.ecr#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a repository creation template.

" + } + }, + "com.amazonaws.ecr#DeleteRepositoryCreationTemplateRequest": { + "type": "structure", + "members": { + "prefix": { + "target": "com.amazonaws.ecr#Prefix", + "traits": { + "smithy.api#documentation": "

The repository namespace prefix associated with the repository creation\n template.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#DeleteRepositoryCreationTemplateResponse": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The registry ID associated with the request.

" + } + }, + "repositoryCreationTemplate": { + "target": "com.amazonaws.ecr#RepositoryCreationTemplate", + "traits": { + "smithy.api#documentation": "

The details of the repository creation template that was deleted.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#DeleteRepositoryPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#DeleteRepositoryPolicyRequest" + }, + "output": { + "target": "com.amazonaws.ecr#DeleteRepositoryPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#RepositoryNotFoundException" + }, + { + "target": "com.amazonaws.ecr#RepositoryPolicyNotFoundException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the repository policy associated with the specified repository.

", + "smithy.api#examples": [ + { + "title": "To delete the policy associated with a repository", + "documentation": "This example deletes the policy associated with the repository named ubuntu in the current account.", + "input": { + "repositoryName": "ubuntu" + }, + "output": { + "policyText": "{ ... }", + "repositoryName": "ubuntu", + "registryId": "012345678901" + } + } + ] + } + }, + "com.amazonaws.ecr#DeleteRepositoryPolicyRequest": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID associated with the registry that contains the repository policy\n to delete. If you do not specify a registry, the default registry is assumed.

" + } + }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The name of the repository that is associated with the repository policy to\n delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#DeleteRepositoryPolicyResponse": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The registry ID associated with the request.

" + } + }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The repository name associated with the request.

" + } + }, + "policyText": { + "target": "com.amazonaws.ecr#RepositoryPolicyText", + "traits": { + "smithy.api#documentation": "

The JSON repository policy that was deleted from the repository.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#DeleteRepositoryRequest": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID associated with the registry that contains the repository to\n delete. If you do not specify a registry, the default registry is assumed.

" + } + }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The name of the repository to delete.

", + "smithy.api#required": {} + } + }, + "force": { + "target": "com.amazonaws.ecr#ForceFlag", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

If true, deleting the repository force deletes the contents of the repository. If\n false, the repository must be empty before attempting to delete it.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#DeleteRepositoryResponse": { + "type": "structure", + "members": { + "repository": { + "target": "com.amazonaws.ecr#Repository", + "traits": { + "smithy.api#documentation": "

The repository that was deleted.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#DescribeImageReplicationStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#DescribeImageReplicationStatusRequest" + }, + "output": { + "target": "com.amazonaws.ecr#DescribeImageReplicationStatusResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#ImageNotFoundException" + }, + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#RepositoryNotFoundException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the replication status for a specified image.

" + } + }, + "com.amazonaws.ecr#DescribeImageReplicationStatusRequest": { + "type": "structure", + "members": { + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The name of the repository that the image is in.

", + "smithy.api#required": {} + } + }, + "imageId": { + "target": "com.amazonaws.ecr#ImageIdentifier", + "traits": { + "smithy.api#required": {} + } + }, + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID associated with the registry. If you do not specify a registry, the default registry is assumed.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#DescribeImageReplicationStatusResponse": { + "type": "structure", + "members": { + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The repository name associated with the request.

" + } + }, + "imageId": { + "target": "com.amazonaws.ecr#ImageIdentifier" + }, + "replicationStatuses": { + "target": "com.amazonaws.ecr#ImageReplicationStatusList", + "traits": { + "smithy.api#documentation": "

The replication status details for the images in the specified repository.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#DescribeImageScanFindings": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#DescribeImageScanFindingsRequest" + }, + "output": { + "target": "com.amazonaws.ecr#DescribeImageScanFindingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#ImageNotFoundException" + }, + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#RepositoryNotFoundException" + }, + { + "target": "com.amazonaws.ecr#ScanNotFoundException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the scan findings for the specified image.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + }, + "smithy.waiters#waitable": { + "ImageScanComplete": { + "documentation": "Wait until an image scan is complete and findings can be accessed", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "imageScanStatus.status", + "expected": "COMPLETE", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "imageScanStatus.status", + "expected": "FAILED", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 5 + } + } + } + }, + "com.amazonaws.ecr#DescribeImageScanFindingsRequest": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID associated with the registry that contains the repository in\n which to describe the image scan findings for. If you do not specify a registry, the default registry is assumed.

" + } + }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The repository for the image for which to describe the scan findings.

", + "smithy.api#required": {} + } + }, + "imageId": { + "target": "com.amazonaws.ecr#ImageIdentifier", + "traits": { + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.ecr#NextToken", + "traits": { + "smithy.api#documentation": "

The nextToken value returned from a previous paginated\n DescribeImageScanFindings request where maxResults was\n used and the results exceeded the value of that parameter. Pagination continues from the\n end of the previous results that returned the nextToken value. This value\n is null when there are no more results to return.

" + } + }, + "maxResults": { + "target": "com.amazonaws.ecr#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of image scan results returned by\n DescribeImageScanFindings in paginated output. When this parameter is\n used, DescribeImageScanFindings only returns maxResults\n results in a single page along with a nextToken response element. The\n remaining results of the initial request can be seen by sending another\n DescribeImageScanFindings request with the returned\n nextToken value. This value can be between 1 and 1000. If this\n parameter is not used, then DescribeImageScanFindings returns up to 100\n results and a nextToken value, if applicable.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#DescribeImageScanFindingsResponse": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The registry ID associated with the request.

" + } + }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The repository name associated with the request.

" + } + }, + "imageId": { + "target": "com.amazonaws.ecr#ImageIdentifier" + }, + "imageScanStatus": { + "target": "com.amazonaws.ecr#ImageScanStatus", + "traits": { + "smithy.api#documentation": "

The current state of the scan.

" + } + }, + "imageScanFindings": { + "target": "com.amazonaws.ecr#ImageScanFindings", + "traits": { + "smithy.api#documentation": "

The information contained in the image scan findings.

" + } + }, + "nextToken": { + "target": "com.amazonaws.ecr#NextToken", + "traits": { + "smithy.api#documentation": "

The nextToken value to include in a future\n DescribeImageScanFindings request. When the results of a\n DescribeImageScanFindings request exceed maxResults, this\n value can be used to retrieve the next page of results. This value is null when there\n are no more results to return.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#DescribeImages": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#DescribeImagesRequest" + }, + "output": { + "target": "com.amazonaws.ecr#DescribeImagesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#ImageNotFoundException" + }, + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#RepositoryNotFoundException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns metadata about the images in a repository.

\n \n

Beginning with Docker version 1.9, the Docker client compresses image layers\n before pushing them to a V2 Docker registry. The output of the docker\n images command shows the uncompressed image size, so it may return a\n larger image size than the image sizes returned by DescribeImages.

\n ", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "imageDetails", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.ecr#DescribeImagesFilter": { + "type": "structure", + "members": { + "tagStatus": { + "target": "com.amazonaws.ecr#TagStatus", + "traits": { + "smithy.api#documentation": "

The tag status with which to filter your DescribeImages results. You\n can filter results based on whether they are TAGGED or\n UNTAGGED.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object representing a filter on a DescribeImages\n operation.

" + } + }, + "com.amazonaws.ecr#DescribeImagesRequest": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID associated with the registry that contains the repository in\n which to describe images. If you do not specify a registry, the default registry is assumed.

" + } + }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The repository that contains the images to describe.

", + "smithy.api#required": {} + } + }, + "imageIds": { + "target": "com.amazonaws.ecr#ImageIdentifierList", + "traits": { + "smithy.api#documentation": "

The list of image IDs for the requested repository.

" + } + }, + "nextToken": { + "target": "com.amazonaws.ecr#NextToken", + "traits": { + "smithy.api#documentation": "

The nextToken value returned from a previous paginated\n DescribeImages request where maxResults was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the nextToken value. This value is\n null when there are no more results to return. This option cannot be\n used when you specify images with imageIds.

" + } + }, + "maxResults": { + "target": "com.amazonaws.ecr#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of repository results returned by DescribeImages in\n paginated output. When this parameter is used, DescribeImages only returns\n maxResults results in a single page along with a nextToken\n response element. The remaining results of the initial request can be seen by sending\n another DescribeImages request with the returned nextToken\n value. This value can be between 1 and 1000. If this\n parameter is not used, then DescribeImages returns up to\n 100 results and a nextToken value, if applicable. This\n option cannot be used when you specify images with imageIds.

" + } + }, + "filter": { + "target": "com.amazonaws.ecr#DescribeImagesFilter", + "traits": { + "smithy.api#documentation": "

The filter key and value with which to filter your DescribeImages\n results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#DescribeImagesResponse": { + "type": "structure", + "members": { + "imageDetails": { + "target": "com.amazonaws.ecr#ImageDetailList", + "traits": { + "smithy.api#documentation": "

A list of ImageDetail objects that contain data about the\n image.

" + } + }, + "nextToken": { + "target": "com.amazonaws.ecr#NextToken", + "traits": { + "smithy.api#documentation": "

The nextToken value to include in a future DescribeImages\n request. When the results of a DescribeImages request exceed\n maxResults, this value can be used to retrieve the next page of\n results. This value is null when there are no more results to\n return.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#DescribePullThroughCacheRules": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#DescribePullThroughCacheRulesRequest" + }, + "output": { + "target": "com.amazonaws.ecr#DescribePullThroughCacheRulesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#PullThroughCacheRuleNotFoundException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the pull through cache rules for a registry.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "pullThroughCacheRules", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.ecr#DescribePullThroughCacheRulesRequest": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID associated with the registry to return the pull through cache\n rules for. If you do not specify a registry, the default registry is assumed.

" + } + }, + "ecrRepositoryPrefixes": { + "target": "com.amazonaws.ecr#PullThroughCacheRuleRepositoryPrefixList", + "traits": { + "smithy.api#documentation": "

The Amazon ECR repository prefixes associated with the pull through cache rules to return.\n If no repository prefix value is specified, all pull through cache rules are\n returned.

" + } + }, + "nextToken": { + "target": "com.amazonaws.ecr#NextToken", + "traits": { + "smithy.api#documentation": "

The nextToken value returned from a previous paginated\n DescribePullThroughCacheRulesRequest request where\n maxResults was used and the results exceeded the value of that\n parameter. Pagination continues from the end of the previous results that returned the\n nextToken value. This value is null when there are no more results to\n return.

" + } + }, + "maxResults": { + "target": "com.amazonaws.ecr#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of pull through cache rules returned by\n DescribePullThroughCacheRulesRequest in paginated output. When this\n parameter is used, DescribePullThroughCacheRulesRequest only returns\n maxResults results in a single page along with a nextToken\n response element. The remaining results of the initial request can be seen by sending\n another DescribePullThroughCacheRulesRequest request with the returned\n nextToken value. This value can be between 1 and 1000. If this\n parameter is not used, then DescribePullThroughCacheRulesRequest returns up\n to 100 results and a nextToken value, if applicable.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#DescribePullThroughCacheRulesResponse": { + "type": "structure", + "members": { + "pullThroughCacheRules": { + "target": "com.amazonaws.ecr#PullThroughCacheRuleList", + "traits": { + "smithy.api#documentation": "

The details of the pull through cache rules.

" + } + }, + "nextToken": { + "target": "com.amazonaws.ecr#NextToken", + "traits": { + "smithy.api#documentation": "

The nextToken value to include in a future\n DescribePullThroughCacheRulesRequest request. When the results of a\n DescribePullThroughCacheRulesRequest request exceed\n maxResults, this value can be used to retrieve the next page of\n results. This value is null when there are no more results to return.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#DescribeRegistry": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#DescribeRegistryRequest" + }, + "output": { + "target": "com.amazonaws.ecr#DescribeRegistryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the settings for a registry. The replication configuration for a repository\n can be created or updated with the PutReplicationConfiguration API\n action.

" + } + }, + "com.amazonaws.ecr#DescribeRegistryRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#DescribeRegistryResponse": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The registry ID associated with the request.

" + } + }, + "replicationConfiguration": { + "target": "com.amazonaws.ecr#ReplicationConfiguration", + "traits": { + "smithy.api#documentation": "

The replication configuration for the registry.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#DescribeRepositories": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#DescribeRepositoriesRequest" + }, + "output": { + "target": "com.amazonaws.ecr#DescribeRepositoriesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#RepositoryNotFoundException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes image repositories in a registry.

", + "smithy.api#examples": [ + { + "title": "To describe all repositories in the current account", + "documentation": "The following example obtains a list and description of all repositories in the default registry to which the current user has access.", + "output": { + "repositories": [ + { + "registryId": "012345678910", + "repositoryName": "ubuntu", + "repositoryArn": "arn:aws:ecr:us-west-2:012345678910:repository/ubuntu" + }, + { + "registryId": "012345678910", + "repositoryName": "test", + "repositoryArn": "arn:aws:ecr:us-west-2:012345678910:repository/test" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "repositories", + "pageSize": "maxResults" + }, + "smithy.test#smokeTests": [ + { + "id": "DescribeRepositoriesSuccess", + "params": {}, + "vendorParams": { + "region": "us-west-2" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "success": {} + } + } + ] + } + }, + "com.amazonaws.ecr#DescribeRepositoriesRequest": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID associated with the registry that contains the repositories to be\n described. If you do not specify a registry, the default registry is assumed.

" + } + }, + "repositoryNames": { + "target": "com.amazonaws.ecr#RepositoryNameList", + "traits": { + "smithy.api#documentation": "

A list of repositories to describe. If this parameter is omitted, then all\n repositories in a registry are described.

" + } + }, + "nextToken": { + "target": "com.amazonaws.ecr#NextToken", + "traits": { + "smithy.api#documentation": "

The nextToken value returned from a previous paginated\n DescribeRepositories request where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is\n null when there are no more results to return. This option cannot be\n used when you specify repositories with repositoryNames.

\n \n

This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.

\n " + } + }, + "maxResults": { + "target": "com.amazonaws.ecr#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of repository results returned by DescribeRepositories\n in paginated output. When this parameter is used, DescribeRepositories only\n returns maxResults results in a single page along with a\n nextToken response element. The remaining results of the initial\n request can be seen by sending another DescribeRepositories request with\n the returned nextToken value. This value can be between 1\n and 1000. If this parameter is not used, then\n DescribeRepositories returns up to 100 results and a\n nextToken value, if applicable. This option cannot be used when you\n specify repositories with repositoryNames.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#DescribeRepositoriesResponse": { + "type": "structure", + "members": { + "repositories": { + "target": "com.amazonaws.ecr#RepositoryList", + "traits": { + "smithy.api#documentation": "

A list of repository objects corresponding to valid repositories.

" + } + }, + "nextToken": { + "target": "com.amazonaws.ecr#NextToken", + "traits": { + "smithy.api#documentation": "

The nextToken value to include in a future\n DescribeRepositories request. When the results of a\n DescribeRepositories request exceed maxResults, this value\n can be used to retrieve the next page of results. This value is null when\n there are no more results to return.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#DescribeRepositoryCreationTemplates": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#DescribeRepositoryCreationTemplatesRequest" + }, + "output": { + "target": "com.amazonaws.ecr#DescribeRepositoryCreationTemplatesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns details about the repository creation templates in a registry. The\n prefixes request parameter can be used to return the details for a\n specific repository creation template.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "repositoryCreationTemplates", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.ecr#DescribeRepositoryCreationTemplatesRequest": { + "type": "structure", + "members": { + "prefixes": { + "target": "com.amazonaws.ecr#PrefixList", + "traits": { + "smithy.api#documentation": "

The repository namespace prefixes associated with the repository creation templates to\n describe. If this value is not specified, all repository creation templates are\n returned.

" + } + }, + "nextToken": { + "target": "com.amazonaws.ecr#NextToken", + "traits": { + "smithy.api#documentation": "

The nextToken value returned from a previous paginated\n DescribeRepositoryCreationTemplates request where\n maxResults was used and the results exceeded the value of that\n parameter. Pagination continues from the end of the previous results that returned the\n nextToken value. This value is null when there are no more\n results to return.

\n \n

This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.

\n " + } + }, + "maxResults": { + "target": "com.amazonaws.ecr#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of repository results returned by\n DescribeRepositoryCreationTemplatesRequest in paginated output. When\n this parameter is used, DescribeRepositoryCreationTemplatesRequest only\n returns maxResults results in a single page along with a\n nextToken response element. The remaining results of the initial\n request can be seen by sending another\n DescribeRepositoryCreationTemplatesRequest request with the returned\n nextToken value. This value can be between 1 and\n 1000. If this parameter is not used, then\n DescribeRepositoryCreationTemplatesRequest returns up to\n 100 results and a nextToken value, if applicable.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#DescribeRepositoryCreationTemplatesResponse": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The registry ID associated with the request.

" + } + }, + "repositoryCreationTemplates": { + "target": "com.amazonaws.ecr#RepositoryCreationTemplateList", + "traits": { + "smithy.api#documentation": "

The details of the repository creation templates.

" + } + }, + "nextToken": { + "target": "com.amazonaws.ecr#NextToken", + "traits": { + "smithy.api#documentation": "

The nextToken value to include in a future\n DescribeRepositoryCreationTemplates request. When the results of a\n DescribeRepositoryCreationTemplates request exceed\n maxResults, this value can be used to retrieve the next page of\n results. This value is null when there are no more results to\n return.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#EmptyUploadException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage", + "traits": { + "smithy.api#documentation": "

The error message associated with the exception.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The specified layer upload does not contain any layer parts.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecr#EncryptionConfiguration": { + "type": "structure", + "members": { + "encryptionType": { + "target": "com.amazonaws.ecr#EncryptionType", + "traits": { + "smithy.api#documentation": "

The encryption type to use.

\n

If you use the KMS encryption type, the contents of the repository will\n be encrypted using server-side encryption with Key Management Service key stored in KMS. When you\n use KMS to encrypt your data, you can either use the default Amazon Web Services managed KMS key\n for Amazon ECR, or specify your own KMS key, which you already created.

\n

If you use the KMS_DSSE encryption type, the contents of the repository\n will be encrypted with two layers of encryption using server-side encryption with the\n KMS Management Service key stored in KMS. Similar to the KMS encryption\n type, you can either use the default Amazon Web Services managed KMS key for Amazon ECR, or specify your\n own KMS key, which you've already created.

\n

If you use the AES256 encryption type, Amazon ECR uses server-side encryption\n with Amazon S3-managed encryption keys which encrypts the images in the repository using an\n AES256 encryption algorithm.

\n

For more information, see Amazon ECR encryption at\n rest in the Amazon Elastic Container Registry User Guide.

", + "smithy.api#required": {} + } + }, + "kmsKey": { + "target": "com.amazonaws.ecr#KmsKey", + "traits": { + "smithy.api#documentation": "

If you use the KMS encryption type, specify the KMS key to use for\n encryption. The alias, key ID, or full ARN of the KMS key can be specified. The key\n must exist in the same Region as the repository. If no key is specified, the default\n Amazon Web Services managed KMS key for Amazon ECR will be used.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The encryption configuration for the repository. This determines how the contents of\n your repository are encrypted at rest.

\n

By default, when no encryption configuration is set or the AES256\n encryption type is used, Amazon ECR uses server-side encryption with Amazon S3-managed encryption\n keys which encrypts your data at rest using an AES256 encryption algorithm. This does\n not require any action on your part.

\n

For more control over the encryption of the contents of your repository, you can use\n server-side encryption with Key Management Service key stored in Key Management Service (KMS) to encrypt your\n images. For more information, see Amazon ECR encryption at\n rest in the Amazon Elastic Container Registry User Guide.

" + } + }, + "com.amazonaws.ecr#EncryptionConfigurationForRepositoryCreationTemplate": { + "type": "structure", + "members": { + "encryptionType": { + "target": "com.amazonaws.ecr#EncryptionType", + "traits": { + "smithy.api#documentation": "

The encryption type to use.

\n

If you use the KMS encryption type, the contents of the repository will\n be encrypted using server-side encryption with Key Management Service key stored in KMS. When you\n use KMS to encrypt your data, you can either use the default Amazon Web Services managed KMS key\n for Amazon ECR, or specify your own KMS key, which you already created. For more\n information, see Protecting data using server-side\n encryption with an KMS key stored in Key Management Service (SSE-KMS) in the\n Amazon Simple Storage Service Console Developer Guide.

\n

If you use the AES256 encryption type, Amazon ECR uses server-side encryption\n with Amazon S3-managed encryption keys which encrypts the images in the repository using an\n AES256 encryption algorithm. For more information, see Protecting data using\n server-side encryption with Amazon S3-managed encryption keys (SSE-S3) in the\n Amazon Simple Storage Service Console Developer Guide.

", + "smithy.api#required": {} + } + }, + "kmsKey": { + "target": "com.amazonaws.ecr#KmsKeyForRepositoryCreationTemplate", + "traits": { + "smithy.api#documentation": "

If you use the KMS encryption type, specify the KMS key to use for\n encryption. The full ARN of the KMS key must be specified. The key must exist in the\n same Region as the repository. If no key is specified, the default Amazon Web Services managed KMS\n key for Amazon ECR will be used.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The encryption configuration to associate with the repository creation\n template.

" + } + }, + "com.amazonaws.ecr#EncryptionType": { + "type": "enum", + "members": { + "AES256": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AES256" + } + }, + "KMS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KMS" + } + }, + "KMS_DSSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KMS_DSSE" + } + } + } + }, + "com.amazonaws.ecr#EnhancedImageScanFinding": { + "type": "structure", + "members": { + "awsAccountId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID associated with the image.

" + } + }, + "description": { + "target": "com.amazonaws.ecr#FindingDescription", + "traits": { + "smithy.api#documentation": "

The description of the finding.

" + } + }, + "findingArn": { + "target": "com.amazonaws.ecr#FindingArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the finding.

" + } + }, + "firstObservedAt": { + "target": "com.amazonaws.ecr#Date", + "traits": { + "smithy.api#documentation": "

The date and time that the finding was first observed.

" + } + }, + "lastObservedAt": { + "target": "com.amazonaws.ecr#Date", + "traits": { + "smithy.api#documentation": "

The date and time that the finding was last observed.

" + } + }, + "packageVulnerabilityDetails": { + "target": "com.amazonaws.ecr#PackageVulnerabilityDetails", + "traits": { + "smithy.api#documentation": "

An object that contains the details of a package vulnerability finding.

" + } + }, + "remediation": { + "target": "com.amazonaws.ecr#Remediation", + "traits": { + "smithy.api#documentation": "

An object that contains the details about how to remediate a finding.

" + } + }, + "resources": { + "target": "com.amazonaws.ecr#ResourceList", + "traits": { + "smithy.api#documentation": "

Contains information on the resources involved in a finding.

" + } + }, + "score": { + "target": "com.amazonaws.ecr#Score", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The Amazon Inspector score given to the finding.

" + } + }, + "scoreDetails": { + "target": "com.amazonaws.ecr#ScoreDetails", + "traits": { + "smithy.api#documentation": "

An object that contains details of the Amazon Inspector score.

" + } + }, + "severity": { + "target": "com.amazonaws.ecr#Severity", + "traits": { + "smithy.api#documentation": "

The severity of the finding.

" + } + }, + "status": { + "target": "com.amazonaws.ecr#Status", + "traits": { + "smithy.api#documentation": "

The status of the finding.

" + } + }, + "title": { + "target": "com.amazonaws.ecr#Title", + "traits": { + "smithy.api#documentation": "

The title of the finding.

" + } + }, + "type": { + "target": "com.amazonaws.ecr#Type", + "traits": { + "smithy.api#documentation": "

The type of the finding.

" + } + }, + "updatedAt": { + "target": "com.amazonaws.ecr#Date", + "traits": { + "smithy.api#documentation": "

The date and time the finding was last updated at.

" + } + }, + "fixAvailable": { + "target": "com.amazonaws.ecr#FixAvailable", + "traits": { + "smithy.api#documentation": "

Details on whether a fix is available through a version update. This value can be\n YES, NO, or PARTIAL. A PARTIAL\n fix means that some, but not all, of the packages identified in the finding have fixes\n available through updated versions.

" + } + }, + "exploitAvailable": { + "target": "com.amazonaws.ecr#ExploitAvailable", + "traits": { + "smithy.api#documentation": "

If a finding discovered in your environment has an exploit available.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The details of an enhanced image scan. This is returned when enhanced scanning is\n enabled for your private registry.

" + } + }, + "com.amazonaws.ecr#EnhancedImageScanFindingList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#EnhancedImageScanFinding" + } + }, + "com.amazonaws.ecr#Epoch": { + "type": "integer" + }, + "com.amazonaws.ecr#EvaluationTimestamp": { + "type": "timestamp" + }, + "com.amazonaws.ecr#ExceptionMessage": { + "type": "string" + }, + "com.amazonaws.ecr#ExpirationTimestamp": { + "type": "timestamp" + }, + "com.amazonaws.ecr#ExploitAvailable": { + "type": "string" + }, + "com.amazonaws.ecr#FilePath": { + "type": "string" + }, + "com.amazonaws.ecr#FindingArn": { + "type": "string" + }, + "com.amazonaws.ecr#FindingDescription": { + "type": "string" + }, + "com.amazonaws.ecr#FindingName": { + "type": "string" + }, + "com.amazonaws.ecr#FindingSeverity": { + "type": "enum", + "members": { + "INFORMATIONAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INFORMATIONAL" + } + }, + "LOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOW" + } + }, + "MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIUM" + } + }, + "HIGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HIGH" + } + }, + "CRITICAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CRITICAL" + } + }, + "UNDEFINED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNDEFINED" + } + } + } + }, + "com.amazonaws.ecr#FindingSeverityCounts": { + "type": "map", + "key": { + "target": "com.amazonaws.ecr#FindingSeverity" + }, + "value": { + "target": "com.amazonaws.ecr#SeverityCount" + } + }, + "com.amazonaws.ecr#FixAvailable": { + "type": "string" + }, + "com.amazonaws.ecr#FixedInVersion": { + "type": "string" + }, + "com.amazonaws.ecr#ForceFlag": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.ecr#GetAccountSetting": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#GetAccountSettingRequest" + }, + "output": { + "target": "com.amazonaws.ecr#GetAccountSettingResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the account setting value for the specified setting name.

" + } + }, + "com.amazonaws.ecr#GetAccountSettingRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.ecr#AccountSettingName", + "traits": { + "smithy.api#documentation": "

The name of the account setting, such as BASIC_SCAN_TYPE_VERSION or\n REGISTRY_POLICY_SCOPE.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#GetAccountSettingResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.ecr#AccountSettingName", + "traits": { + "smithy.api#documentation": "

Retrieves the name of the account setting.

" + } + }, + "value": { + "target": "com.amazonaws.ecr#AccountSettingName", + "traits": { + "smithy.api#documentation": "

The setting value for the setting name. The following are valid values for the basic scan\n type being used: AWS_NATIVE or CLAIR. The following are valid\n values for the registry policy scope being used: V1 or\n V2.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#GetAuthorizationToken": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#GetAuthorizationTokenRequest" + }, + "output": { + "target": "com.amazonaws.ecr#GetAuthorizationTokenResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves an authorization token. An authorization token represents your IAM\n authentication credentials and can be used to access any Amazon ECR registry that your IAM\n principal has access to. The authorization token is valid for 12 hours.

\n

The authorizationToken returned is a base64 encoded string that can be\n decoded and used in a docker login command to authenticate to a registry.\n The CLI offers an get-login-password command that simplifies the login\n process. For more information, see Registry\n authentication in the Amazon Elastic Container Registry User Guide.

" + } + }, + "com.amazonaws.ecr#GetAuthorizationTokenRegistryIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#RegistryId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.ecr#GetAuthorizationTokenRequest": { + "type": "structure", + "members": { + "registryIds": { + "target": "com.amazonaws.ecr#GetAuthorizationTokenRegistryIdList", + "traits": { + "smithy.api#deprecated": { + "message": "This field is deprecated. The returned authorization token can be used to access any Amazon ECR registry that the IAM principal has access to, specifying a registry ID doesn't change the permissions scope of the authorization token." + }, + "smithy.api#documentation": "

A list of Amazon Web Services account IDs that are associated with the registries for which to get\n AuthorizationData objects. If you do not specify a registry, the default registry is assumed.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#GetAuthorizationTokenResponse": { + "type": "structure", + "members": { + "authorizationData": { + "target": "com.amazonaws.ecr#AuthorizationDataList", + "traits": { + "smithy.api#documentation": "

A list of authorization token data objects that correspond to the\n registryIds values in the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#GetDownloadUrlForLayer": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#GetDownloadUrlForLayerRequest" + }, + "output": { + "target": "com.amazonaws.ecr#GetDownloadUrlForLayerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#LayerInaccessibleException" + }, + { + "target": "com.amazonaws.ecr#LayersNotFoundException" + }, + { + "target": "com.amazonaws.ecr#RepositoryNotFoundException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#UnableToGetUpstreamLayerException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer. You can\n only get URLs for image layers that are referenced in an image.

\n

When an image is pulled, the GetDownloadUrlForLayer API is called once per image layer\n that is not already cached.

\n \n

This operation is used by the Amazon ECR proxy and is not generally used by\n customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

\n " + } + }, + "com.amazonaws.ecr#GetDownloadUrlForLayerRequest": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID associated with the registry that contains the image layer to\n download. If you do not specify a registry, the default registry is assumed.

" + } + }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The name of the repository that is associated with the image layer to download.

", + "smithy.api#required": {} + } + }, + "layerDigest": { + "target": "com.amazonaws.ecr#LayerDigest", + "traits": { + "smithy.api#documentation": "

The digest of the image layer to download.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#GetDownloadUrlForLayerResponse": { + "type": "structure", + "members": { + "downloadUrl": { + "target": "com.amazonaws.ecr#Url", + "traits": { + "smithy.api#documentation": "

The pre-signed Amazon S3 download URL for the requested layer.

" + } + }, + "layerDigest": { + "target": "com.amazonaws.ecr#LayerDigest", + "traits": { + "smithy.api#documentation": "

The digest of the image layer to download.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#GetLifecyclePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#GetLifecyclePolicyRequest" + }, + "output": { + "target": "com.amazonaws.ecr#GetLifecyclePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#LifecyclePolicyNotFoundException" + }, + { + "target": "com.amazonaws.ecr#RepositoryNotFoundException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the lifecycle policy for the specified repository.

" + } + }, + "com.amazonaws.ecr#GetLifecyclePolicyPreview": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#GetLifecyclePolicyPreviewRequest" + }, + "output": { + "target": "com.amazonaws.ecr#GetLifecyclePolicyPreviewResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#LifecyclePolicyPreviewNotFoundException" + }, + { + "target": "com.amazonaws.ecr#RepositoryNotFoundException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the results of the lifecycle policy preview request for the specified\n repository.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "previewResults", + "pageSize": "maxResults" + }, + "smithy.waiters#waitable": { + "LifecyclePolicyPreviewComplete": { + "documentation": "Wait until a lifecycle policy preview request is complete and results can be accessed", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "status", + "expected": "COMPLETE", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "status", + "expected": "FAILED", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 5 + } + } + } + }, + "com.amazonaws.ecr#GetLifecyclePolicyPreviewRequest": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID associated with the registry that contains the repository.\n If you do not specify a registry, the default registry is assumed.

" + } + }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The name of the repository.

", + "smithy.api#required": {} + } + }, + "imageIds": { + "target": "com.amazonaws.ecr#ImageIdentifierList", + "traits": { + "smithy.api#documentation": "

The list of imageIDs to be included.

" + } + }, + "nextToken": { + "target": "com.amazonaws.ecr#NextToken", + "traits": { + "smithy.api#documentation": "

The nextToken value returned from a previous paginated\u2028\n GetLifecyclePolicyPreviewRequest request where maxResults\n was used and the\u2028 results exceeded the value of that parameter. Pagination continues\n from the end of the\u2028 previous results that returned the nextToken value.\n This value is\u2028 null when there are no more results to return. This option\n cannot be used when you specify images with imageIds.

" + } + }, + "maxResults": { + "target": "com.amazonaws.ecr#LifecyclePreviewMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of repository results returned by\n GetLifecyclePolicyPreviewRequest in\u2028 paginated output. When this\n parameter is used, GetLifecyclePolicyPreviewRequest only returns\u2028\n maxResults results in a single page along with a\n nextToken\u2028 response element. The remaining results of the initial request\n can be seen by sending\u2028 another GetLifecyclePolicyPreviewRequest request\n with the returned nextToken\u2028 value. This value can be between\n 1 and 1000. If this\u2028 parameter is not used, then\n GetLifecyclePolicyPreviewRequest returns up to\u2028 100\n results and a nextToken value, if\u2028 applicable. This option cannot be used\n when you specify images with imageIds.

" + } + }, + "filter": { + "target": "com.amazonaws.ecr#LifecyclePolicyPreviewFilter", + "traits": { + "smithy.api#documentation": "

An optional parameter that filters results based on image tag status and all tags, if\n tagged.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#GetLifecyclePolicyPreviewResponse": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The registry ID associated with the request.

" + } + }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The repository name associated with the request.

" + } + }, + "lifecyclePolicyText": { + "target": "com.amazonaws.ecr#LifecyclePolicyText", + "traits": { + "smithy.api#documentation": "

The JSON lifecycle policy text.

" + } + }, + "status": { + "target": "com.amazonaws.ecr#LifecyclePolicyPreviewStatus", + "traits": { + "smithy.api#documentation": "

The status of the lifecycle policy preview request.

" + } + }, + "nextToken": { + "target": "com.amazonaws.ecr#NextToken", + "traits": { + "smithy.api#documentation": "

The nextToken value to include in a future\n GetLifecyclePolicyPreview request. When the results of a\n GetLifecyclePolicyPreview request exceed maxResults, this\n value can be used to retrieve the next page of results. This value is null\n when there are no more results to return.

" + } + }, + "previewResults": { + "target": "com.amazonaws.ecr#LifecyclePolicyPreviewResultList", + "traits": { + "smithy.api#documentation": "

The results of the lifecycle policy preview request.

" + } + }, + "summary": { + "target": "com.amazonaws.ecr#LifecyclePolicyPreviewSummary", + "traits": { + "smithy.api#documentation": "

The list of images that is returned as a result of the action.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#GetLifecyclePolicyRequest": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID associated with the registry that contains the repository.\n If you do not specify a registry, the default registry is assumed.

" + } + }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The name of the repository.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#GetLifecyclePolicyResponse": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The registry ID associated with the request.

" + } + }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The repository name associated with the request.

" + } + }, + "lifecyclePolicyText": { + "target": "com.amazonaws.ecr#LifecyclePolicyText", + "traits": { + "smithy.api#documentation": "

The JSON lifecycle policy text.

" + } + }, + "lastEvaluatedAt": { + "target": "com.amazonaws.ecr#EvaluationTimestamp", + "traits": { + "smithy.api#documentation": "

The time stamp of the last time that the lifecycle policy was run.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#GetRegistryPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#GetRegistryPolicyRequest" + }, + "output": { + "target": "com.amazonaws.ecr#GetRegistryPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#RegistryPolicyNotFoundException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the permissions policy for a registry.

" + } + }, + "com.amazonaws.ecr#GetRegistryPolicyRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#GetRegistryPolicyResponse": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The registry ID associated with the request.

" + } + }, + "policyText": { + "target": "com.amazonaws.ecr#RegistryPolicyText", + "traits": { + "smithy.api#documentation": "

The JSON text of the permissions policy for a registry.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#GetRegistryScanningConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#GetRegistryScanningConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.ecr#GetRegistryScanningConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the scanning configuration for a registry.

" + } + }, + "com.amazonaws.ecr#GetRegistryScanningConfigurationRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#GetRegistryScanningConfigurationResponse": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The registry ID associated with the request.

" + } + }, + "scanningConfiguration": { + "target": "com.amazonaws.ecr#RegistryScanningConfiguration", + "traits": { + "smithy.api#documentation": "

The scanning configuration for the registry.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#GetRepositoryPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#GetRepositoryPolicyRequest" + }, + "output": { + "target": "com.amazonaws.ecr#GetRepositoryPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#RepositoryNotFoundException" + }, + { + "target": "com.amazonaws.ecr#RepositoryPolicyNotFoundException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the repository policy for the specified repository.

", + "smithy.api#examples": [ + { + "title": "To get the current policy for a repository", + "documentation": "This example obtains the repository policy for the repository named ubuntu.", + "input": { + "repositoryName": "ubuntu" + }, + "output": { + "policyText": "{\n \"Version\" : \"2008-10-17\",\n \"Statement\" : [ {\n \"Sid\" : \"new statement\",\n \"Effect\" : \"Allow\",\n \"Principal\" : {\n \"AWS\" : \"arn:aws:iam::012345678901:role/CodeDeployDemo\"\n },\n\"Action\" : [ \"ecr:GetDownloadUrlForLayer\", \"ecr:BatchGetImage\", \"ecr:BatchCheckLayerAvailability\" ]\n } ]\n}", + "repositoryName": "ubuntu", + "registryId": "012345678901" + } + } + ] + } + }, + "com.amazonaws.ecr#GetRepositoryPolicyRequest": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID associated with the registry that contains the repository.\n If you do not specify a registry, the default registry is assumed.

" + } + }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The name of the repository with the policy to retrieve.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#GetRepositoryPolicyResponse": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The registry ID associated with the request.

" + } + }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The repository name associated with the request.

" + } + }, + "policyText": { + "target": "com.amazonaws.ecr#RepositoryPolicyText", + "traits": { + "smithy.api#documentation": "

The JSON repository policy text associated with the repository.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#Image": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID associated with the registry containing the image.

" + } + }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The name of the repository associated with the image.

" + } + }, + "imageId": { + "target": "com.amazonaws.ecr#ImageIdentifier", + "traits": { + "smithy.api#documentation": "

An object containing the image tag and image digest associated with an image.

" + } + }, + "imageManifest": { + "target": "com.amazonaws.ecr#ImageManifest", + "traits": { + "smithy.api#documentation": "

The image manifest associated with the image.

" + } + }, + "imageManifestMediaType": { + "target": "com.amazonaws.ecr#MediaType", + "traits": { + "smithy.api#documentation": "

The manifest media type of the image.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object representing an Amazon ECR image.

" + } + }, + "com.amazonaws.ecr#ImageActionType": { + "type": "enum", + "members": { + "EXPIRE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPIRE" + } + } + } + }, + "com.amazonaws.ecr#ImageAlreadyExistsException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage", + "traits": { + "smithy.api#documentation": "

The error message associated with the exception.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The specified image has already been pushed, and there were no changes to the manifest\n or image tag after the last push.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecr#ImageCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.ecr#ImageDetail": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID associated with the registry to which this image belongs.

" + } + }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The name of the repository to which this image belongs.

" + } + }, + "imageDigest": { + "target": "com.amazonaws.ecr#ImageDigest", + "traits": { + "smithy.api#documentation": "

The sha256 digest of the image manifest.

" + } + }, + "imageTags": { + "target": "com.amazonaws.ecr#ImageTagList", + "traits": { + "smithy.api#documentation": "

The list of tags associated with this image.

" + } + }, + "imageSizeInBytes": { + "target": "com.amazonaws.ecr#ImageSizeInBytes", + "traits": { + "smithy.api#documentation": "

The size, in bytes, of the image in the repository.

\n

If the image is a manifest list, this will be the max size of all manifests in the\n list.

\n \n

Beginning with Docker version 1.9, the Docker client compresses image layers\n before pushing them to a V2 Docker registry. The output of the docker\n images command shows the uncompressed image size, so it may return a\n larger image size than the image sizes returned by DescribeImages.

\n " + } + }, + "imagePushedAt": { + "target": "com.amazonaws.ecr#PushTimestamp", + "traits": { + "smithy.api#documentation": "

The date and time, expressed in standard JavaScript date format, at which the current\n image was pushed to the repository.

" + } + }, + "imageScanStatus": { + "target": "com.amazonaws.ecr#ImageScanStatus", + "traits": { + "smithy.api#documentation": "

The current state of the scan.

" + } + }, + "imageScanFindingsSummary": { + "target": "com.amazonaws.ecr#ImageScanFindingsSummary", + "traits": { + "smithy.api#documentation": "

A summary of the last completed image scan.

" + } + }, + "imageManifestMediaType": { + "target": "com.amazonaws.ecr#MediaType", + "traits": { + "smithy.api#documentation": "

The media type of the image manifest.

" + } + }, + "artifactMediaType": { + "target": "com.amazonaws.ecr#MediaType", + "traits": { + "smithy.api#documentation": "

The artifact media type of the image.

" + } + }, + "lastRecordedPullTime": { + "target": "com.amazonaws.ecr#RecordedPullTimestamp", + "traits": { + "smithy.api#documentation": "

The date and time, expressed in standard JavaScript date format, when Amazon ECR recorded\n the last image pull.

\n \n

Amazon ECR refreshes the last image pull timestamp at least once every 24 hours. For\n example, if you pull an image once a day then the lastRecordedPullTime\n timestamp will indicate the exact time that the image was last pulled. However, if\n you pull an image once an hour, because Amazon ECR refreshes the\n lastRecordedPullTime timestamp at least once every 24 hours, the\n result may not be the exact time that the image was last pulled.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that describes an image returned by a DescribeImages\n operation.

" + } + }, + "com.amazonaws.ecr#ImageDetailList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#ImageDetail" + } + }, + "com.amazonaws.ecr#ImageDigest": { + "type": "string" + }, + "com.amazonaws.ecr#ImageDigestDoesNotMatchException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The specified image digest does not match the digest that Amazon ECR calculated for the\n image.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecr#ImageFailure": { + "type": "structure", + "members": { + "imageId": { + "target": "com.amazonaws.ecr#ImageIdentifier", + "traits": { + "smithy.api#documentation": "

The image ID associated with the failure.

" + } + }, + "failureCode": { + "target": "com.amazonaws.ecr#ImageFailureCode", + "traits": { + "smithy.api#documentation": "

The code associated with the failure.

" + } + }, + "failureReason": { + "target": "com.amazonaws.ecr#ImageFailureReason", + "traits": { + "smithy.api#documentation": "

The reason for the failure.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object representing an Amazon ECR image failure.

" + } + }, + "com.amazonaws.ecr#ImageFailureCode": { + "type": "enum", + "members": { + "InvalidImageDigest": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidImageDigest" + } + }, + "InvalidImageTag": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidImageTag" + } + }, + "ImageTagDoesNotMatchDigest": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ImageTagDoesNotMatchDigest" + } + }, + "ImageNotFound": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ImageNotFound" + } + }, + "MissingDigestAndTag": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MissingDigestAndTag" + } + }, + "ImageReferencedByManifestList": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ImageReferencedByManifestList" + } + }, + "KmsError": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KmsError" + } + }, + "UpstreamAccessDenied": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpstreamAccessDenied" + } + }, + "UpstreamTooManyRequests": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpstreamTooManyRequests" + } + }, + "UpstreamUnavailable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpstreamUnavailable" + } + } + } + }, + "com.amazonaws.ecr#ImageFailureList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#ImageFailure" + } + }, + "com.amazonaws.ecr#ImageFailureReason": { + "type": "string" + }, + "com.amazonaws.ecr#ImageIdentifier": { + "type": "structure", + "members": { + "imageDigest": { + "target": "com.amazonaws.ecr#ImageDigest", + "traits": { + "smithy.api#documentation": "

The sha256 digest of the image manifest.

" + } + }, + "imageTag": { + "target": "com.amazonaws.ecr#ImageTag", + "traits": { + "smithy.api#documentation": "

The tag used for the image.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object with identifying information for an image in an Amazon ECR repository.

" + } + }, + "com.amazonaws.ecr#ImageIdentifierList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#ImageIdentifier" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.ecr#ImageList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#Image" + } + }, + "com.amazonaws.ecr#ImageManifest": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4194304 + } + } + }, + "com.amazonaws.ecr#ImageNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The image requested does not exist in the specified repository.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecr#ImageReplicationStatus": { + "type": "structure", + "members": { + "region": { + "target": "com.amazonaws.ecr#Region", + "traits": { + "smithy.api#documentation": "

The destination Region for the image replication.

" + } + }, + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID associated with the registry to which the image belongs.

" + } + }, + "status": { + "target": "com.amazonaws.ecr#ReplicationStatus", + "traits": { + "smithy.api#documentation": "

The image replication status.

" + } + }, + "failureCode": { + "target": "com.amazonaws.ecr#ReplicationError", + "traits": { + "smithy.api#documentation": "

The failure code for a replication that has failed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The status of the replication process for an image.

" + } + }, + "com.amazonaws.ecr#ImageReplicationStatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#ImageReplicationStatus" + } + }, + "com.amazonaws.ecr#ImageScanFinding": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.ecr#FindingName", + "traits": { + "smithy.api#documentation": "

The name associated with the finding, usually a CVE number.

" + } + }, + "description": { + "target": "com.amazonaws.ecr#FindingDescription", + "traits": { + "smithy.api#documentation": "

The description of the finding.

" + } + }, + "uri": { + "target": "com.amazonaws.ecr#Url", + "traits": { + "smithy.api#documentation": "

A link containing additional details about the security vulnerability.

" + } + }, + "severity": { + "target": "com.amazonaws.ecr#FindingSeverity", + "traits": { + "smithy.api#documentation": "

The finding severity.

" + } + }, + "attributes": { + "target": "com.amazonaws.ecr#AttributeList", + "traits": { + "smithy.api#documentation": "

A collection of attributes of the host from which the finding is generated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about an image scan finding.

" + } + }, + "com.amazonaws.ecr#ImageScanFindingList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#ImageScanFinding" + } + }, + "com.amazonaws.ecr#ImageScanFindings": { + "type": "structure", + "members": { + "imageScanCompletedAt": { + "target": "com.amazonaws.ecr#ScanTimestamp", + "traits": { + "smithy.api#documentation": "

The time of the last completed image scan.

" + } + }, + "vulnerabilitySourceUpdatedAt": { + "target": "com.amazonaws.ecr#VulnerabilitySourceUpdateTimestamp", + "traits": { + "smithy.api#documentation": "

The time when the vulnerability data was last scanned.

" + } + }, + "findingSeverityCounts": { + "target": "com.amazonaws.ecr#FindingSeverityCounts", + "traits": { + "smithy.api#documentation": "

The image vulnerability counts, sorted by severity.

" + } + }, + "findings": { + "target": "com.amazonaws.ecr#ImageScanFindingList", + "traits": { + "smithy.api#documentation": "

The findings from the image scan.

" + } + }, + "enhancedFindings": { + "target": "com.amazonaws.ecr#EnhancedImageScanFindingList", + "traits": { + "smithy.api#documentation": "

Details about the enhanced scan findings from Amazon Inspector.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The details of an image scan.

" + } + }, + "com.amazonaws.ecr#ImageScanFindingsSummary": { + "type": "structure", + "members": { + "imageScanCompletedAt": { + "target": "com.amazonaws.ecr#ScanTimestamp", + "traits": { + "smithy.api#documentation": "

The time of the last completed image scan.

" + } + }, + "vulnerabilitySourceUpdatedAt": { + "target": "com.amazonaws.ecr#VulnerabilitySourceUpdateTimestamp", + "traits": { + "smithy.api#documentation": "

The time when the vulnerability data was last scanned.

" + } + }, + "findingSeverityCounts": { + "target": "com.amazonaws.ecr#FindingSeverityCounts", + "traits": { + "smithy.api#documentation": "

The image vulnerability counts, sorted by severity.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A summary of the last completed image scan.

" + } + }, + "com.amazonaws.ecr#ImageScanStatus": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.ecr#ScanStatus", + "traits": { + "smithy.api#documentation": "

The current state of an image scan.

" + } + }, + "description": { + "target": "com.amazonaws.ecr#ScanStatusDescription", + "traits": { + "smithy.api#documentation": "

The description of the image scan status.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The current status of an image scan.

" + } + }, + "com.amazonaws.ecr#ImageScanningConfiguration": { + "type": "structure", + "members": { + "scanOnPush": { + "target": "com.amazonaws.ecr#ScanOnPushFlag", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

The setting that determines whether images are scanned after being pushed to a\n repository. If set to true, images will be scanned after being pushed. If\n this parameter is not specified, it will default to false and images will\n not be scanned unless a scan is manually started with the API_StartImageScan API.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The image scanning configuration for a repository.

" + } + }, + "com.amazonaws.ecr#ImageSizeInBytes": { + "type": "long" + }, + "com.amazonaws.ecr#ImageTag": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + } + } + }, + "com.amazonaws.ecr#ImageTagAlreadyExistsException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The specified image is tagged with a tag that already exists. The repository is\n configured for tag immutability.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecr#ImageTagList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#ImageTag" + } + }, + "com.amazonaws.ecr#ImageTagMutability": { + "type": "enum", + "members": { + "MUTABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MUTABLE" + } + }, + "IMMUTABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMMUTABLE" + } + } + } + }, + "com.amazonaws.ecr#ImageTagsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#ImageTag" + } + }, + "com.amazonaws.ecr#InitiateLayerUpload": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#InitiateLayerUploadRequest" + }, + "output": { + "target": "com.amazonaws.ecr#InitiateLayerUploadResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#KmsException" + }, + { + "target": "com.amazonaws.ecr#RepositoryNotFoundException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Notifies Amazon ECR that you intend to upload an image layer.

\n

When an image is pushed, the InitiateLayerUpload API is called once per image layer\n that has not already been uploaded. Whether or not an image layer has been uploaded is\n determined by the BatchCheckLayerAvailability API action.

\n \n

This operation is used by the Amazon ECR proxy and is not generally used by\n customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

\n " + } + }, + "com.amazonaws.ecr#InitiateLayerUploadRequest": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID associated with the registry to which you intend to upload\n layers. If you do not specify a registry, the default registry is assumed.

" + } + }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The name of the repository to which you intend to upload layers.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#InitiateLayerUploadResponse": { + "type": "structure", + "members": { + "uploadId": { + "target": "com.amazonaws.ecr#UploadId", + "traits": { + "smithy.api#documentation": "

The upload ID for the layer upload. This parameter is passed to further UploadLayerPart and CompleteLayerUpload\n operations.

" + } + }, + "partSize": { + "target": "com.amazonaws.ecr#PartSize", + "traits": { + "smithy.api#documentation": "

The size, in bytes, that Amazon ECR expects future layer part uploads to be.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#InvalidLayerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage", + "traits": { + "smithy.api#documentation": "

The error message associated with the exception.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The layer digest calculation performed by Amazon ECR upon receipt of the image layer does\n not match the digest specified.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecr#InvalidLayerPartException": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The registry ID associated with the exception.

" + } + }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The repository name associated with the exception.

" + } + }, + "uploadId": { + "target": "com.amazonaws.ecr#UploadId", + "traits": { + "smithy.api#documentation": "

The upload ID associated with the exception.

" + } + }, + "lastValidByteReceived": { + "target": "com.amazonaws.ecr#PartSize", + "traits": { + "smithy.api#documentation": "

The last valid byte received from the layer part upload that is associated with the\n exception.

" + } + }, + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage", + "traits": { + "smithy.api#documentation": "

The error message associated with the exception.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The layer part size is not valid, or the first byte specified is not consecutive to\n the last byte of a previous layer part upload.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecr#InvalidParameterException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage", + "traits": { + "smithy.api#documentation": "

The error message associated with the exception.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The specified parameter is invalid. Review the available parameters for the API\n request.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecr#InvalidTagParameterException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

An invalid parameter has been specified. Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecr#IsPTCRuleValid": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.ecr#KmsError": { + "type": "string" + }, + "com.amazonaws.ecr#KmsException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage" + }, + "kmsError": { + "target": "com.amazonaws.ecr#KmsError", + "traits": { + "smithy.api#documentation": "

The error code returned by KMS.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The operation failed due to a KMS exception.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecr#KmsKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.ecr#KmsKeyForRepositoryCreationTemplate": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "^$|arn:aws:kms:[a-z0-9-]+:[0-9]{12}:key\\/[a-z0-9-]+$" + } + }, + "com.amazonaws.ecr#Layer": { + "type": "structure", + "members": { + "layerDigest": { + "target": "com.amazonaws.ecr#LayerDigest", + "traits": { + "smithy.api#documentation": "

The sha256 digest of the image layer.

" + } + }, + "layerAvailability": { + "target": "com.amazonaws.ecr#LayerAvailability", + "traits": { + "smithy.api#documentation": "

The availability status of the image layer.

" + } + }, + "layerSize": { + "target": "com.amazonaws.ecr#LayerSizeInBytes", + "traits": { + "smithy.api#documentation": "

The size, in bytes, of the image layer.

" + } + }, + "mediaType": { + "target": "com.amazonaws.ecr#MediaType", + "traits": { + "smithy.api#documentation": "

The media type of the layer, such as\n application/vnd.docker.image.rootfs.diff.tar.gzip or\n application/vnd.oci.image.layer.v1.tar+gzip.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object representing an Amazon ECR image layer.

" + } + }, + "com.amazonaws.ecr#LayerAlreadyExistsException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage", + "traits": { + "smithy.api#documentation": "

The error message associated with the exception.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The image layer already exists in the associated repository.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecr#LayerAvailability": { + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "UNAVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNAVAILABLE" + } + } + } + }, + "com.amazonaws.ecr#LayerDigest": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9-_+.]+:[a-fA-F0-9]+$" + } + }, + "com.amazonaws.ecr#LayerDigestList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#LayerDigest" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.ecr#LayerFailure": { + "type": "structure", + "members": { + "layerDigest": { + "target": "com.amazonaws.ecr#BatchedOperationLayerDigest", + "traits": { + "smithy.api#documentation": "

The layer digest associated with the failure.

" + } + }, + "failureCode": { + "target": "com.amazonaws.ecr#LayerFailureCode", + "traits": { + "smithy.api#documentation": "

The failure code associated with the failure.

" + } + }, + "failureReason": { + "target": "com.amazonaws.ecr#LayerFailureReason", + "traits": { + "smithy.api#documentation": "

The reason for the failure.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object representing an Amazon ECR image layer failure.

" + } + }, + "com.amazonaws.ecr#LayerFailureCode": { + "type": "enum", + "members": { + "InvalidLayerDigest": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidLayerDigest" + } + }, + "MissingLayerDigest": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MissingLayerDigest" + } + } + } + }, + "com.amazonaws.ecr#LayerFailureList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#LayerFailure" + } + }, + "com.amazonaws.ecr#LayerFailureReason": { + "type": "string" + }, + "com.amazonaws.ecr#LayerInaccessibleException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage", + "traits": { + "smithy.api#documentation": "

The error message associated with the exception.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The specified layer is not available because it is not associated with an image.\n Unassociated image layers may be cleaned up at any time.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecr#LayerList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#Layer" + } + }, + "com.amazonaws.ecr#LayerPartBlob": { + "type": "blob", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20971520 + } + } + }, + "com.amazonaws.ecr#LayerPartTooSmallException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage", + "traits": { + "smithy.api#documentation": "

The error message associated with the exception.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Layer parts must be at least 5 MiB in size.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecr#LayerSizeInBytes": { + "type": "long" + }, + "com.amazonaws.ecr#LayersNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage", + "traits": { + "smithy.api#documentation": "

The error message associated with the exception.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The specified layers could not be found, or the specified layer is not valid for this\n repository.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecr#LifecyclePolicyNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The lifecycle policy could not be found, and no policy is set to the\n repository.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecr#LifecyclePolicyPreviewFilter": { + "type": "structure", + "members": { + "tagStatus": { + "target": "com.amazonaws.ecr#TagStatus", + "traits": { + "smithy.api#documentation": "

The tag status of the image.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The filter for the lifecycle policy preview.

" + } + }, + "com.amazonaws.ecr#LifecyclePolicyPreviewInProgressException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The previous lifecycle policy preview request has not completed. Wait and try\n again.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecr#LifecyclePolicyPreviewNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

There is no dry run for this repository.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecr#LifecyclePolicyPreviewResult": { + "type": "structure", + "members": { + "imageTags": { + "target": "com.amazonaws.ecr#ImageTagList", + "traits": { + "smithy.api#documentation": "

The list of tags associated with this image.

" + } + }, + "imageDigest": { + "target": "com.amazonaws.ecr#ImageDigest", + "traits": { + "smithy.api#documentation": "

The sha256 digest of the image manifest.

" + } + }, + "imagePushedAt": { + "target": "com.amazonaws.ecr#PushTimestamp", + "traits": { + "smithy.api#documentation": "

The date and time, expressed in standard JavaScript date format, at which the current\n image was pushed to the repository.

" + } + }, + "action": { + "target": "com.amazonaws.ecr#LifecyclePolicyRuleAction", + "traits": { + "smithy.api#documentation": "

The type of action to be taken.

" + } + }, + "appliedRulePriority": { + "target": "com.amazonaws.ecr#LifecyclePolicyRulePriority", + "traits": { + "smithy.api#documentation": "

The priority of the applied rule.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The result of the lifecycle policy preview.

" + } + }, + "com.amazonaws.ecr#LifecyclePolicyPreviewResultList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#LifecyclePolicyPreviewResult" + } + }, + "com.amazonaws.ecr#LifecyclePolicyPreviewStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETE" + } + }, + "EXPIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPIRED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.ecr#LifecyclePolicyPreviewSummary": { + "type": "structure", + "members": { + "expiringImageTotalCount": { + "target": "com.amazonaws.ecr#ImageCount", + "traits": { + "smithy.api#documentation": "

The number of expiring images.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The summary of the lifecycle policy preview request.

" + } + }, + "com.amazonaws.ecr#LifecyclePolicyRuleAction": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.ecr#ImageActionType", + "traits": { + "smithy.api#documentation": "

The type of action to be taken.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The type of action to be taken.

" + } + }, + "com.amazonaws.ecr#LifecyclePolicyRulePriority": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.ecr#LifecyclePolicyText": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 100, + "max": 30720 + } + } + }, + "com.amazonaws.ecr#LifecyclePolicyTextForRepositoryCreationTemplate": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 30720 + } + } + }, + "com.amazonaws.ecr#LifecyclePreviewMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.ecr#LimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage", + "traits": { + "smithy.api#documentation": "

The error message associated with the exception.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The operation did not succeed because it would have exceeded a service limit for your\n account. For more information, see Amazon ECR service quotas in\n the Amazon Elastic Container Registry User Guide.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecr#ListImages": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#ListImagesRequest" + }, + "output": { + "target": "com.amazonaws.ecr#ListImagesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#RepositoryNotFoundException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all the image IDs for the specified repository.

\n

You can filter images based on whether or not they are tagged by using the\n tagStatus filter and specifying either TAGGED,\n UNTAGGED or ANY. For example, you can filter your results\n to return only UNTAGGED images and then pipe that result to a BatchDeleteImage operation to delete them. Or, you can filter your\n results to return only TAGGED images to list all of the tags in your\n repository.

", + "smithy.api#examples": [ + { + "title": "To list all images in a repository", + "documentation": "This example lists all of the images in the repository named ubuntu in the default registry in the current account. ", + "input": { + "repositoryName": "ubuntu" + }, + "output": { + "imageIds": [ + { + "imageTag": "precise", + "imageDigest": "sha256:764f63476bdff6d83a09ba2a818f0d35757063724a9ac3ba5019c56f74ebf42a" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "imageIds", + "pageSize": "maxResults" + }, + "smithy.test#smokeTests": [ + { + "id": "ListImagesFailure", + "params": { + "repositoryName": "not-a-real-repository" + }, + "vendorParams": { + "region": "us-west-2" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "failure": {} + } + } + ] + } + }, + "com.amazonaws.ecr#ListImagesFilter": { + "type": "structure", + "members": { + "tagStatus": { + "target": "com.amazonaws.ecr#TagStatus", + "traits": { + "smithy.api#documentation": "

The tag status with which to filter your ListImages results. You can\n filter results based on whether they are TAGGED or\n UNTAGGED.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object representing a filter on a ListImages operation.

" + } + }, + "com.amazonaws.ecr#ListImagesRequest": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID associated with the registry that contains the repository in\n which to list images. If you do not specify a registry, the default registry is assumed.

" + } + }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The repository with image IDs to be listed.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.ecr#NextToken", + "traits": { + "smithy.api#documentation": "

The nextToken value returned from a previous paginated\n ListImages request where maxResults was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the nextToken value. This value is\n null when there are no more results to return.

\n \n

This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.

\n " + } + }, + "maxResults": { + "target": "com.amazonaws.ecr#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of image results returned by ListImages in paginated\n output. When this parameter is used, ListImages only returns\n maxResults results in a single page along with a nextToken\n response element. The remaining results of the initial request can be seen by sending\n another ListImages request with the returned nextToken value.\n This value can be between 1 and 1000. If this parameter is\n not used, then ListImages returns up to 100 results and a\n nextToken value, if applicable.

" + } + }, + "filter": { + "target": "com.amazonaws.ecr#ListImagesFilter", + "traits": { + "smithy.api#documentation": "

The filter key and value with which to filter your ListImages\n results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#ListImagesResponse": { + "type": "structure", + "members": { + "imageIds": { + "target": "com.amazonaws.ecr#ImageIdentifierList", + "traits": { + "smithy.api#documentation": "

The list of image IDs for the requested repository.

" + } + }, + "nextToken": { + "target": "com.amazonaws.ecr#NextToken", + "traits": { + "smithy.api#documentation": "

The nextToken value to include in a future ListImages\n request. When the results of a ListImages request exceed\n maxResults, this value can be used to retrieve the next page of\n results. This value is null when there are no more results to\n return.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.ecr#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#RepositoryNotFoundException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

List the tags for an Amazon ECR resource.

" + } + }, + "com.amazonaws.ecr#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.ecr#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the\n only supported resource is an Amazon ECR repository.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.ecr#TagList", + "traits": { + "smithy.api#documentation": "

The tags for the resource.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.ecr#MediaType": { + "type": "string" + }, + "com.amazonaws.ecr#MediaTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#MediaType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.ecr#Metric": { + "type": "string" + }, + "com.amazonaws.ecr#NextToken": { + "type": "string" + }, + "com.amazonaws.ecr#PTCValidateFailure": { + "type": "string" + }, + "com.amazonaws.ecr#PackageManager": { + "type": "string" + }, + "com.amazonaws.ecr#PackageVulnerabilityDetails": { + "type": "structure", + "members": { + "cvss": { + "target": "com.amazonaws.ecr#CvssScoreList", + "traits": { + "smithy.api#documentation": "

An object that contains details about the CVSS score of a finding.

" + } + }, + "referenceUrls": { + "target": "com.amazonaws.ecr#ReferenceUrlsList", + "traits": { + "smithy.api#documentation": "

One or more URLs that contain details about this vulnerability type.

" + } + }, + "relatedVulnerabilities": { + "target": "com.amazonaws.ecr#RelatedVulnerabilitiesList", + "traits": { + "smithy.api#documentation": "

One or more vulnerabilities related to the one identified in this finding.

" + } + }, + "source": { + "target": "com.amazonaws.ecr#Source", + "traits": { + "smithy.api#documentation": "

The source of the vulnerability information.

" + } + }, + "sourceUrl": { + "target": "com.amazonaws.ecr#Url", + "traits": { + "smithy.api#documentation": "

A URL to the source of the vulnerability information.

" + } + }, + "vendorCreatedAt": { + "target": "com.amazonaws.ecr#Date", + "traits": { + "smithy.api#documentation": "

The date and time that this vulnerability was first added to the vendor's\n database.

" + } + }, + "vendorSeverity": { + "target": "com.amazonaws.ecr#Severity", + "traits": { + "smithy.api#documentation": "

The severity the vendor has given to this vulnerability type.

" + } + }, + "vendorUpdatedAt": { + "target": "com.amazonaws.ecr#Date", + "traits": { + "smithy.api#documentation": "

The date and time the vendor last updated this vulnerability in their database.

" + } + }, + "vulnerabilityId": { + "target": "com.amazonaws.ecr#VulnerabilityId", + "traits": { + "smithy.api#documentation": "

The ID given to this vulnerability.

" + } + }, + "vulnerablePackages": { + "target": "com.amazonaws.ecr#VulnerablePackagesList", + "traits": { + "smithy.api#documentation": "

The packages impacted by this vulnerability.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a package vulnerability finding.

" + } + }, + "com.amazonaws.ecr#PartSize": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.ecr#Platform": { + "type": "string" + }, + "com.amazonaws.ecr#Prefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^((?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*/?|ROOT)$" + } + }, + "com.amazonaws.ecr#PrefixList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#Prefix" + } + }, + "com.amazonaws.ecr#ProxyEndpoint": { + "type": "string" + }, + "com.amazonaws.ecr#PullThroughCacheRule": { + "type": "structure", + "members": { + "ecrRepositoryPrefix": { + "target": "com.amazonaws.ecr#PullThroughCacheRuleRepositoryPrefix", + "traits": { + "smithy.api#documentation": "

The Amazon ECR repository prefix associated with the pull through cache rule.

" + } + }, + "upstreamRegistryUrl": { + "target": "com.amazonaws.ecr#Url", + "traits": { + "smithy.api#documentation": "

The upstream registry URL associated with the pull through cache rule.

" + } + }, + "createdAt": { + "target": "com.amazonaws.ecr#CreationTimestamp", + "traits": { + "smithy.api#documentation": "

The date and time the pull through cache was created.

" + } + }, + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID associated with the registry the pull through cache rule is\n associated with.

" + } + }, + "credentialArn": { + "target": "com.amazonaws.ecr#CredentialArn", + "traits": { + "smithy.api#documentation": "

The ARN of the Secrets Manager secret associated with the pull through cache rule.

" + } + }, + "upstreamRegistry": { + "target": "com.amazonaws.ecr#UpstreamRegistry", + "traits": { + "smithy.api#documentation": "

The name of the upstream source registry associated with the pull through cache\n rule.

" + } + }, + "updatedAt": { + "target": "com.amazonaws.ecr#UpdatedTimestamp", + "traits": { + "smithy.api#documentation": "

The date and time, in JavaScript date format, when the pull through cache rule was\n last updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The details of a pull through cache rule.

" + } + }, + "com.amazonaws.ecr#PullThroughCacheRuleAlreadyExistsException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

A pull through cache rule with these settings already exists for the private\n registry.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecr#PullThroughCacheRuleList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#PullThroughCacheRule" + } + }, + "com.amazonaws.ecr#PullThroughCacheRuleNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The pull through cache rule was not found. Specify a valid pull through cache rule and\n try again.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecr#PullThroughCacheRuleRepositoryPrefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 30 + }, + "smithy.api#pattern": "^(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*$" + } + }, + "com.amazonaws.ecr#PullThroughCacheRuleRepositoryPrefixList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#PullThroughCacheRuleRepositoryPrefix" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.ecr#PushTimestamp": { + "type": "timestamp" + }, + "com.amazonaws.ecr#PutAccountSetting": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#PutAccountSettingRequest" + }, + "output": { + "target": "com.amazonaws.ecr#PutAccountSettingResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#LimitExceededException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Allows you to change the basic scan type version or registry policy scope.

" + } + }, + "com.amazonaws.ecr#PutAccountSettingRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.ecr#AccountSettingName", + "traits": { + "smithy.api#documentation": "

The name of the account setting, such as BASIC_SCAN_TYPE_VERSION or\n REGISTRY_POLICY_SCOPE.

", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.ecr#AccountSettingValue", + "traits": { + "smithy.api#documentation": "

Setting value that is specified. The following are valid values for the basic scan\n type being used: AWS_NATIVE or CLAIR. The following are valid\n values for the registry policy scope being used: V1 or\n V2.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#PutAccountSettingResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.ecr#AccountSettingName", + "traits": { + "smithy.api#documentation": "

Retrieves the name of the account setting.

" + } + }, + "value": { + "target": "com.amazonaws.ecr#AccountSettingValue", + "traits": { + "smithy.api#documentation": "

Retrieves the value of the specified account setting.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#PutImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#PutImageRequest" + }, + "output": { + "target": "com.amazonaws.ecr#PutImageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#ImageAlreadyExistsException" + }, + { + "target": "com.amazonaws.ecr#ImageDigestDoesNotMatchException" + }, + { + "target": "com.amazonaws.ecr#ImageTagAlreadyExistsException" + }, + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#KmsException" + }, + { + "target": "com.amazonaws.ecr#LayersNotFoundException" + }, + { + "target": "com.amazonaws.ecr#LimitExceededException" + }, + { + "target": "com.amazonaws.ecr#ReferencedImagesNotFoundException" + }, + { + "target": "com.amazonaws.ecr#RepositoryNotFoundException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates or updates the image manifest and tags associated with an image.

\n

When an image is pushed and all new image layers have been uploaded, the PutImage API\n is called once to create or update the image manifest and the tags associated with the\n image.

\n \n

This operation is used by the Amazon ECR proxy and is not generally used by\n customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

\n " + } + }, + "com.amazonaws.ecr#PutImageRequest": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID associated with the registry that contains the repository in\n which to put the image. If you do not specify a registry, the default registry is assumed.

" + } + }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The name of the repository in which to put the image.

", + "smithy.api#required": {} + } + }, + "imageManifest": { + "target": "com.amazonaws.ecr#ImageManifest", + "traits": { + "smithy.api#documentation": "

The image manifest corresponding to the image to be uploaded.

", + "smithy.api#required": {} + } + }, + "imageManifestMediaType": { + "target": "com.amazonaws.ecr#MediaType", + "traits": { + "smithy.api#documentation": "

The media type of the image manifest. If you push an image manifest that does not\n contain the mediaType field, you must specify the\n imageManifestMediaType in the request.

" + } + }, + "imageTag": { + "target": "com.amazonaws.ecr#ImageTag", + "traits": { + "smithy.api#documentation": "

The tag to associate with the image. This parameter is required for images that use\n the Docker Image Manifest V2 Schema 2 or Open Container Initiative (OCI) formats.

" + } + }, + "imageDigest": { + "target": "com.amazonaws.ecr#ImageDigest", + "traits": { + "smithy.api#documentation": "

The image digest of the image manifest corresponding to the image.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#PutImageResponse": { + "type": "structure", + "members": { + "image": { + "target": "com.amazonaws.ecr#Image", + "traits": { + "smithy.api#documentation": "

Details of the image uploaded.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#PutImageScanningConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#PutImageScanningConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.ecr#PutImageScanningConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#RepositoryNotFoundException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\n

The PutImageScanningConfiguration API is being deprecated, in favor\n of specifying the image scanning configuration at the registry level. For more\n information, see PutRegistryScanningConfiguration.

\n \n

Updates the image scanning configuration for the specified repository.

" + } + }, + "com.amazonaws.ecr#PutImageScanningConfigurationRequest": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID associated with the registry that contains the repository in\n which to update the image scanning configuration setting.\n If you do not specify a registry, the default registry is assumed.

" + } + }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The name of the repository in which to update the image scanning configuration\n setting.

", + "smithy.api#required": {} + } + }, + "imageScanningConfiguration": { + "target": "com.amazonaws.ecr#ImageScanningConfiguration", + "traits": { + "smithy.api#documentation": "

The image scanning configuration for the repository. This setting determines whether\n images are scanned for known vulnerabilities after being pushed to the\n repository.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#PutImageScanningConfigurationResponse": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The registry ID associated with the request.

" + } + }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The repository name associated with the request.

" + } + }, + "imageScanningConfiguration": { + "target": "com.amazonaws.ecr#ImageScanningConfiguration", + "traits": { + "smithy.api#documentation": "

The image scanning configuration setting for the repository.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#PutImageTagMutability": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#PutImageTagMutabilityRequest" + }, + "output": { + "target": "com.amazonaws.ecr#PutImageTagMutabilityResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#RepositoryNotFoundException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the image tag mutability settings for the specified repository. For more\n information, see Image tag\n mutability in the Amazon Elastic Container Registry User Guide.

" + } + }, + "com.amazonaws.ecr#PutImageTagMutabilityRequest": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID associated with the registry that contains the repository in\n which to update the image tag mutability settings. If you do not specify a registry, the default registry is assumed.

" + } + }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The name of the repository in which to update the image tag mutability\n settings.

", + "smithy.api#required": {} + } + }, + "imageTagMutability": { + "target": "com.amazonaws.ecr#ImageTagMutability", + "traits": { + "smithy.api#documentation": "

The tag mutability setting for the repository. If MUTABLE is specified,\n image tags can be overwritten. If IMMUTABLE is specified, all image tags\n within the repository will be immutable which will prevent them from being\n overwritten.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#PutImageTagMutabilityResponse": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The registry ID associated with the request.

" + } + }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The repository name associated with the request.

" + } + }, + "imageTagMutability": { + "target": "com.amazonaws.ecr#ImageTagMutability", + "traits": { + "smithy.api#documentation": "

The image tag mutability setting for the repository.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#PutLifecyclePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#PutLifecyclePolicyRequest" + }, + "output": { + "target": "com.amazonaws.ecr#PutLifecyclePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#RepositoryNotFoundException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates or updates the lifecycle policy for the specified repository. For more\n information, see Lifecycle policy\n template.

" + } + }, + "com.amazonaws.ecr#PutLifecyclePolicyRequest": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID associated with the registry that contains the repository. If you\n do\u2028 not specify a registry, the default registry is assumed.

" + } + }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The name of the repository to receive the policy.

", + "smithy.api#required": {} + } + }, + "lifecyclePolicyText": { + "target": "com.amazonaws.ecr#LifecyclePolicyText", + "traits": { + "smithy.api#documentation": "

The JSON repository policy text to apply to the repository.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#PutLifecyclePolicyResponse": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The registry ID associated with the request.

" + } + }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The repository name associated with the request.

" + } + }, + "lifecyclePolicyText": { + "target": "com.amazonaws.ecr#LifecyclePolicyText", + "traits": { + "smithy.api#documentation": "

The JSON repository policy text.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#PutRegistryPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#PutRegistryPolicyRequest" + }, + "output": { + "target": "com.amazonaws.ecr#PutRegistryPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates or updates the permissions policy for your registry.

\n

A registry policy is used to specify permissions for another Amazon Web Services account and is used\n when configuring cross-account replication. For more information, see Registry permissions in the Amazon Elastic Container Registry User Guide.

" + } + }, + "com.amazonaws.ecr#PutRegistryPolicyRequest": { + "type": "structure", + "members": { + "policyText": { + "target": "com.amazonaws.ecr#RegistryPolicyText", + "traits": { + "smithy.api#documentation": "

The JSON policy text to apply to your registry. The policy text follows the same\n format as IAM policy text. For more information, see Registry\n permissions in the Amazon Elastic Container Registry User Guide.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#PutRegistryPolicyResponse": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The registry ID associated with the request.

" + } + }, + "policyText": { + "target": "com.amazonaws.ecr#RegistryPolicyText", + "traits": { + "smithy.api#documentation": "

The JSON policy text for your registry.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#PutRegistryScanningConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#PutRegistryScanningConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.ecr#PutRegistryScanningConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates or updates the scanning configuration for your private registry.

" + } + }, + "com.amazonaws.ecr#PutRegistryScanningConfigurationRequest": { + "type": "structure", + "members": { + "scanType": { + "target": "com.amazonaws.ecr#ScanType", + "traits": { + "smithy.api#documentation": "

The scanning type to set for the registry.

\n

When a registry scanning configuration is not defined, by default the\n BASIC scan type is used. When basic scanning is used, you may specify\n filters to determine which individual repositories, or all repositories, are scanned\n when new images are pushed to those repositories. Alternatively, you can do manual scans\n of images with basic scanning.

\n

When the ENHANCED scan type is set, Amazon Inspector provides automated\n vulnerability scanning. You may choose between continuous scanning or scan on push and\n you may specify filters to determine which individual repositories, or all repositories,\n are scanned.

" + } + }, + "rules": { + "target": "com.amazonaws.ecr#RegistryScanningRuleList", + "traits": { + "smithy.api#documentation": "

The scanning rules to use for the registry. A scanning rule is used to determine which\n repository filters are used and at what frequency scanning will occur.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#PutRegistryScanningConfigurationResponse": { + "type": "structure", + "members": { + "registryScanningConfiguration": { + "target": "com.amazonaws.ecr#RegistryScanningConfiguration", + "traits": { + "smithy.api#documentation": "

The scanning configuration for your registry.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#PutReplicationConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#PutReplicationConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.ecr#PutReplicationConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates or updates the replication configuration for a registry. The existing\n replication configuration for a repository can be retrieved with the DescribeRegistry API action. The first time the\n PutReplicationConfiguration API is called, a service-linked IAM role is created in\n your account for the replication process. For more information, see Using\n service-linked roles for Amazon ECR in the Amazon Elastic Container Registry User Guide.\n For more information on the custom role for replication, see Creating an IAM role for replication.

\n \n

When configuring cross-account replication, the destination account must grant the\n source account permission to replicate. This permission is controlled using a\n registry permissions policy. For more information, see PutRegistryPolicy.

\n " + } + }, + "com.amazonaws.ecr#PutReplicationConfigurationRequest": { + "type": "structure", + "members": { + "replicationConfiguration": { + "target": "com.amazonaws.ecr#ReplicationConfiguration", + "traits": { + "smithy.api#documentation": "

An object representing the replication configuration for a registry.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#PutReplicationConfigurationResponse": { + "type": "structure", + "members": { + "replicationConfiguration": { + "target": "com.amazonaws.ecr#ReplicationConfiguration", + "traits": { + "smithy.api#documentation": "

The contents of the replication configuration for the registry.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#RCTAppliedFor": { + "type": "enum", + "members": { + "REPLICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REPLICATION" + } + }, + "PULL_THROUGH_CACHE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PULL_THROUGH_CACHE" + } + } + } + }, + "com.amazonaws.ecr#RCTAppliedForList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#RCTAppliedFor" + } + }, + "com.amazonaws.ecr#Reason": { + "type": "string" + }, + "com.amazonaws.ecr#Recommendation": { + "type": "structure", + "members": { + "url": { + "target": "com.amazonaws.ecr#Url", + "traits": { + "smithy.api#documentation": "

The URL address to the CVE remediation recommendations.

" + } + }, + "text": { + "target": "com.amazonaws.ecr#RecommendationText", + "traits": { + "smithy.api#documentation": "

The recommended course of action to remediate the finding.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the recommended course of action to remediate the finding.

" + } + }, + "com.amazonaws.ecr#RecommendationText": { + "type": "string" + }, + "com.amazonaws.ecr#RecordedPullTimestamp": { + "type": "timestamp" + }, + "com.amazonaws.ecr#ReferenceUrlsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#Url" + } + }, + "com.amazonaws.ecr#ReferencedImagesNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The manifest list is referencing an image that does not exist.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecr#Region": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 25 + }, + "smithy.api#pattern": "^[0-9a-z-]{2,25}$" + } + }, + "com.amazonaws.ecr#RegistryId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9]{12}$" + } + }, + "com.amazonaws.ecr#RegistryPolicyNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The registry doesn't have an associated registry policy.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecr#RegistryPolicyText": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10240 + } + } + }, + "com.amazonaws.ecr#RegistryScanningConfiguration": { + "type": "structure", + "members": { + "scanType": { + "target": "com.amazonaws.ecr#ScanType", + "traits": { + "smithy.api#documentation": "

The type of scanning configured for the registry.

" + } + }, + "rules": { + "target": "com.amazonaws.ecr#RegistryScanningRuleList", + "traits": { + "smithy.api#documentation": "

The scanning rules associated with the registry.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The scanning configuration for a private registry.

" + } + }, + "com.amazonaws.ecr#RegistryScanningRule": { + "type": "structure", + "members": { + "scanFrequency": { + "target": "com.amazonaws.ecr#ScanFrequency", + "traits": { + "smithy.api#documentation": "

The frequency that scans are performed at for a private registry. When the\n ENHANCED scan type is specified, the supported scan frequencies are\n CONTINUOUS_SCAN and SCAN_ON_PUSH. When the\n BASIC scan type is specified, the SCAN_ON_PUSH scan\n frequency is supported. If scan on push is not specified, then the MANUAL\n scan frequency is set by default.

", + "smithy.api#required": {} + } + }, + "repositoryFilters": { + "target": "com.amazonaws.ecr#ScanningRepositoryFilterList", + "traits": { + "smithy.api#documentation": "

The repository filters associated with the scanning configuration for a private\n registry.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The details of a scanning rule for a private registry.

" + } + }, + "com.amazonaws.ecr#RegistryScanningRuleList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#RegistryScanningRule" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2 + } + } + }, + "com.amazonaws.ecr#RelatedVulnerabilitiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#RelatedVulnerability" + } + }, + "com.amazonaws.ecr#RelatedVulnerability": { + "type": "string" + }, + "com.amazonaws.ecr#Release": { + "type": "string" + }, + "com.amazonaws.ecr#Remediation": { + "type": "structure", + "members": { + "recommendation": { + "target": "com.amazonaws.ecr#Recommendation", + "traits": { + "smithy.api#documentation": "

An object that contains information about the recommended course of action to\n remediate the finding.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information on how to remediate a finding.

" + } + }, + "com.amazonaws.ecr#ReplicationConfiguration": { + "type": "structure", + "members": { + "rules": { + "target": "com.amazonaws.ecr#ReplicationRuleList", + "traits": { + "smithy.api#documentation": "

An array of objects representing the replication destinations and repository filters\n for a replication configuration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The replication configuration for a registry.

" + } + }, + "com.amazonaws.ecr#ReplicationDestination": { + "type": "structure", + "members": { + "region": { + "target": "com.amazonaws.ecr#Region", + "traits": { + "smithy.api#documentation": "

The Region to replicate to.

", + "smithy.api#required": {} + } + }, + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID of the Amazon ECR private registry to replicate to. When configuring\n cross-Region replication within your own registry, specify your own account ID.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An array of objects representing the destination for a replication rule.

" + } + }, + "com.amazonaws.ecr#ReplicationDestinationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#ReplicationDestination" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.ecr#ReplicationError": { + "type": "string" + }, + "com.amazonaws.ecr#ReplicationRule": { + "type": "structure", + "members": { + "destinations": { + "target": "com.amazonaws.ecr#ReplicationDestinationList", + "traits": { + "smithy.api#documentation": "

An array of objects representing the destination for a replication rule.

", + "smithy.api#required": {} + } + }, + "repositoryFilters": { + "target": "com.amazonaws.ecr#RepositoryFilterList", + "traits": { + "smithy.api#documentation": "

An array of objects representing the filters for a replication rule. Specifying a\n repository filter for a replication rule provides a method for controlling which\n repositories in a private registry are replicated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An array of objects representing the replication destinations and repository filters\n for a replication configuration.

" + } + }, + "com.amazonaws.ecr#ReplicationRuleList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#ReplicationRule" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.ecr#ReplicationStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETE" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.ecr#Repository": { + "type": "structure", + "members": { + "repositoryArn": { + "target": "com.amazonaws.ecr#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the repository. The ARN contains the arn:aws:ecr namespace, followed by the region of the\n repository, Amazon Web Services account ID of the repository owner, repository namespace, and repository name.\n For example, arn:aws:ecr:region:012345678910:repository-namespace/repository-name.

" + } + }, + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID associated with the registry that contains the repository.

" + } + }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The name of the repository.

" + } + }, + "repositoryUri": { + "target": "com.amazonaws.ecr#Url", + "traits": { + "smithy.api#documentation": "

The URI for the repository. You can use this URI for container image push\n and pull operations.

" + } + }, + "createdAt": { + "target": "com.amazonaws.ecr#CreationTimestamp", + "traits": { + "smithy.api#documentation": "

The date and time, in JavaScript date format, when the repository was created.

" + } + }, + "imageTagMutability": { + "target": "com.amazonaws.ecr#ImageTagMutability", + "traits": { + "smithy.api#documentation": "

The tag mutability setting for the repository.

" + } + }, + "imageScanningConfiguration": { + "target": "com.amazonaws.ecr#ImageScanningConfiguration" + }, + "encryptionConfiguration": { + "target": "com.amazonaws.ecr#EncryptionConfiguration", + "traits": { + "smithy.api#documentation": "

The encryption configuration for the repository. This determines how the contents of\n your repository are encrypted at rest.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object representing a repository.

" + } + }, + "com.amazonaws.ecr#RepositoryAlreadyExistsException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage", + "traits": { + "smithy.api#documentation": "

The error message associated with the exception.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The specified repository already exists in the specified registry.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecr#RepositoryCreationTemplate": { + "type": "structure", + "members": { + "prefix": { + "target": "com.amazonaws.ecr#Prefix", + "traits": { + "smithy.api#documentation": "

The repository namespace prefix associated with the repository creation\n template.

" + } + }, + "description": { + "target": "com.amazonaws.ecr#RepositoryTemplateDescription", + "traits": { + "smithy.api#documentation": "

The description associated with the repository creation template.

" + } + }, + "encryptionConfiguration": { + "target": "com.amazonaws.ecr#EncryptionConfigurationForRepositoryCreationTemplate", + "traits": { + "smithy.api#documentation": "

The encryption configuration associated with the repository creation template.

" + } + }, + "resourceTags": { + "target": "com.amazonaws.ecr#TagList", + "traits": { + "smithy.api#documentation": "

The metadata to apply to the repository to help you categorize and organize. Each tag\n consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.

" + } + }, + "imageTagMutability": { + "target": "com.amazonaws.ecr#ImageTagMutability", + "traits": { + "smithy.api#documentation": "

The tag mutability setting for the repository. If this parameter is omitted, the\n default setting of MUTABLE will be used which will allow image tags to be overwritten.\n If IMMUTABLE is specified, all image tags within the repository will be immutable which\n will prevent them from being overwritten.

" + } + }, + "repositoryPolicy": { + "target": "com.amazonaws.ecr#RepositoryPolicyText", + "traits": { + "smithy.api#documentation": "

he repository policy to apply to repositories created using the template. A repository\n policy is a permissions policy associated with a repository to control access\n permissions.

" + } + }, + "lifecyclePolicy": { + "target": "com.amazonaws.ecr#LifecyclePolicyTextForRepositoryCreationTemplate", + "traits": { + "smithy.api#documentation": "

The lifecycle policy to use for repositories created using the template.

" + } + }, + "appliedFor": { + "target": "com.amazonaws.ecr#RCTAppliedForList", + "traits": { + "smithy.api#documentation": "

A list of enumerable Strings representing the repository creation scenarios that this\n template will apply towards. The two supported scenarios are PULL_THROUGH_CACHE and\n REPLICATION

" + } + }, + "customRoleArn": { + "target": "com.amazonaws.ecr#CustomRoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of the role to be assumed by Amazon ECR. Amazon ECR will assume your supplied role\n when the customRoleArn is specified. When this field isn't specified, Amazon ECR will use the\n service-linked role for the repository creation template.

" + } + }, + "createdAt": { + "target": "com.amazonaws.ecr#Date", + "traits": { + "smithy.api#documentation": "

The date and time, in JavaScript date format, when the repository creation template\n was created.

" + } + }, + "updatedAt": { + "target": "com.amazonaws.ecr#Date", + "traits": { + "smithy.api#documentation": "

The date and time, in JavaScript date format, when the repository creation template\n was last updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The details of the repository creation template associated with the request.

" + } + }, + "com.amazonaws.ecr#RepositoryCreationTemplateList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#RepositoryCreationTemplate" + } + }, + "com.amazonaws.ecr#RepositoryFilter": { + "type": "structure", + "members": { + "filter": { + "target": "com.amazonaws.ecr#RepositoryFilterValue", + "traits": { + "smithy.api#documentation": "

The repository filter details. When the PREFIX_MATCH filter type is\n specified, this value is required and should be the repository name prefix to configure\n replication for.

", + "smithy.api#required": {} + } + }, + "filterType": { + "target": "com.amazonaws.ecr#RepositoryFilterType", + "traits": { + "smithy.api#documentation": "

The repository filter type. The only supported value is PREFIX_MATCH,\n which is a repository name prefix specified with the filter\n parameter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The filter settings used with image replication. Specifying a repository filter to a\n replication rule provides a method for controlling which repositories in a private\n registry are replicated. If no filters are added, the contents of all repositories are\n replicated.

" + } + }, + "com.amazonaws.ecr#RepositoryFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#RepositoryFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.ecr#RepositoryFilterType": { + "type": "enum", + "members": { + "PREFIX_MATCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PREFIX_MATCH" + } + } + } + }, + "com.amazonaws.ecr#RepositoryFilterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 256 + }, + "smithy.api#pattern": "^(?:[a-z0-9]+(?:[._-][a-z0-9]*)*/)*[a-z0-9]*(?:[._-][a-z0-9]*)*$" + } + }, + "com.amazonaws.ecr#RepositoryList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#Repository" + } + }, + "com.amazonaws.ecr#RepositoryName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 256 + }, + "smithy.api#pattern": "^(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*$" + } + }, + "com.amazonaws.ecr#RepositoryNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#RepositoryName" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.ecr#RepositoryNotEmptyException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage", + "traits": { + "smithy.api#documentation": "

The error message associated with the exception.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The specified repository contains images. To delete a repository that contains images,\n you must force the deletion with the force parameter.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecr#RepositoryNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage", + "traits": { + "smithy.api#documentation": "

The error message associated with the exception.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The specified repository could not be found. Check the spelling of the specified\n repository and ensure that you are performing operations on the correct registry.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecr#RepositoryPolicyNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage", + "traits": { + "smithy.api#documentation": "

The error message associated with the exception.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The specified repository and registry combination does not have an associated\n repository policy.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecr#RepositoryPolicyText": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10240 + } + } + }, + "com.amazonaws.ecr#RepositoryScanningConfiguration": { + "type": "structure", + "members": { + "repositoryArn": { + "target": "com.amazonaws.ecr#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the repository.

" + } + }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The name of the repository.

" + } + }, + "scanOnPush": { + "target": "com.amazonaws.ecr#ScanOnPushFlag", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether or not scan on push is configured for the repository.

" + } + }, + "scanFrequency": { + "target": "com.amazonaws.ecr#ScanFrequency", + "traits": { + "smithy.api#documentation": "

The scan frequency for the repository.

" + } + }, + "appliedScanFilters": { + "target": "com.amazonaws.ecr#ScanningRepositoryFilterList", + "traits": { + "smithy.api#documentation": "

The scan filters applied to the repository.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The details of the scanning configuration for a repository.

" + } + }, + "com.amazonaws.ecr#RepositoryScanningConfigurationFailure": { + "type": "structure", + "members": { + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The name of the repository.

" + } + }, + "failureCode": { + "target": "com.amazonaws.ecr#ScanningConfigurationFailureCode", + "traits": { + "smithy.api#documentation": "

The failure code.

" + } + }, + "failureReason": { + "target": "com.amazonaws.ecr#ScanningConfigurationFailureReason", + "traits": { + "smithy.api#documentation": "

The reason for the failure.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The details about any failures associated with the scanning configuration of a\n repository.

" + } + }, + "com.amazonaws.ecr#RepositoryScanningConfigurationFailureList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#RepositoryScanningConfigurationFailure" + } + }, + "com.amazonaws.ecr#RepositoryScanningConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#RepositoryScanningConfiguration" + } + }, + "com.amazonaws.ecr#RepositoryTemplateDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.ecr#Resource": { + "type": "structure", + "members": { + "details": { + "target": "com.amazonaws.ecr#ResourceDetails", + "traits": { + "smithy.api#documentation": "

An object that contains details about the resource involved in a finding.

" + } + }, + "id": { + "target": "com.amazonaws.ecr#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the resource.

" + } + }, + "tags": { + "target": "com.amazonaws.ecr#Tags", + "traits": { + "smithy.api#documentation": "

The tags attached to the resource.

" + } + }, + "type": { + "target": "com.amazonaws.ecr#Type", + "traits": { + "smithy.api#documentation": "

The type of resource.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the resource involved in a finding.

" + } + }, + "com.amazonaws.ecr#ResourceDetails": { + "type": "structure", + "members": { + "awsEcrContainerImage": { + "target": "com.amazonaws.ecr#AwsEcrContainerImageDetails", + "traits": { + "smithy.api#documentation": "

An object that contains details about the Amazon ECR container image involved in the\n finding.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about the resource involved in the finding.

" + } + }, + "com.amazonaws.ecr#ResourceId": { + "type": "string" + }, + "com.amazonaws.ecr#ResourceList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#Resource" + } + }, + "com.amazonaws.ecr#ScanFrequency": { + "type": "enum", + "members": { + "SCAN_ON_PUSH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCAN_ON_PUSH" + } + }, + "CONTINUOUS_SCAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTINUOUS_SCAN" + } + }, + "MANUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANUAL" + } + } + } + }, + "com.amazonaws.ecr#ScanNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The specified image scan could not be found. Ensure that image scanning is enabled on\n the repository and try again.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecr#ScanOnPushFlag": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.ecr#ScanStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETE" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "UNSUPPORTED_IMAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNSUPPORTED_IMAGE" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "SCAN_ELIGIBILITY_EXPIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCAN_ELIGIBILITY_EXPIRED" + } + }, + "FINDINGS_UNAVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FINDINGS_UNAVAILABLE" + } + } + } + }, + "com.amazonaws.ecr#ScanStatusDescription": { + "type": "string" + }, + "com.amazonaws.ecr#ScanTimestamp": { + "type": "timestamp" + }, + "com.amazonaws.ecr#ScanType": { + "type": "enum", + "members": { + "BASIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BASIC" + } + }, + "ENHANCED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENHANCED" + } + } + } + }, + "com.amazonaws.ecr#ScanningConfigurationFailureCode": { + "type": "enum", + "members": { + "REPOSITORY_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REPOSITORY_NOT_FOUND" + } + } + } + }, + "com.amazonaws.ecr#ScanningConfigurationFailureReason": { + "type": "string" + }, + "com.amazonaws.ecr#ScanningConfigurationRepositoryNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#RepositoryName" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.ecr#ScanningRepositoryFilter": { + "type": "structure", + "members": { + "filter": { + "target": "com.amazonaws.ecr#ScanningRepositoryFilterValue", + "traits": { + "smithy.api#documentation": "

The filter to use when scanning.

", + "smithy.api#required": {} + } + }, + "filterType": { + "target": "com.amazonaws.ecr#ScanningRepositoryFilterType", + "traits": { + "smithy.api#documentation": "

The type associated with the filter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The details of a scanning repository filter. For more information on how to use\n filters, see Using\n filters in the Amazon Elastic Container Registry User Guide.

" + } + }, + "com.amazonaws.ecr#ScanningRepositoryFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#ScanningRepositoryFilter" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.ecr#ScanningRepositoryFilterType": { + "type": "enum", + "members": { + "WILDCARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WILDCARD" + } + } + } + }, + "com.amazonaws.ecr#ScanningRepositoryFilterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-z0-9*](?:[._\\-/a-z0-9*]?[a-z0-9*]+)*$" + } + }, + "com.amazonaws.ecr#Score": { + "type": "double", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.ecr#ScoreDetails": { + "type": "structure", + "members": { + "cvss": { + "target": "com.amazonaws.ecr#CvssScoreDetails", + "traits": { + "smithy.api#documentation": "

An object that contains details about the CVSS score given to a finding.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the Amazon Inspector score given to a finding.

" + } + }, + "com.amazonaws.ecr#ScoringVector": { + "type": "string" + }, + "com.amazonaws.ecr#SecretNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The ARN of the secret specified in the pull through cache rule was not found. Update\n the pull through cache rule with a valid secret ARN and try again.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecr#ServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage", + "traits": { + "smithy.api#documentation": "

The error message associated with the exception.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

These errors are usually caused by a server-side issue.

", + "smithy.api#error": "server" + } + }, + "com.amazonaws.ecr#SetRepositoryPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#SetRepositoryPolicyRequest" + }, + "output": { + "target": "com.amazonaws.ecr#SetRepositoryPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#RepositoryNotFoundException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Applies a repository policy to the specified repository to control access permissions.\n For more information, see Amazon ECR Repository\n policies in the Amazon Elastic Container Registry User Guide.

" + } + }, + "com.amazonaws.ecr#SetRepositoryPolicyRequest": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID associated with the registry that contains the repository.\n If you do not specify a registry, the default registry is assumed.

" + } + }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The name of the repository to receive the policy.

", + "smithy.api#required": {} + } + }, + "policyText": { + "target": "com.amazonaws.ecr#RepositoryPolicyText", + "traits": { + "smithy.api#documentation": "

The JSON repository policy text to apply to the repository. For more information, see\n Amazon ECR repository\n policies in the Amazon Elastic Container Registry User Guide.

", + "smithy.api#required": {} + } + }, + "force": { + "target": "com.amazonaws.ecr#ForceFlag", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

If the policy you are attempting to set on a repository policy would prevent you from\n setting another policy in the future, you must force the SetRepositoryPolicy operation. This is intended to prevent accidental\n repository lock outs.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#SetRepositoryPolicyResponse": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The registry ID associated with the request.

" + } + }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The repository name associated with the request.

" + } + }, + "policyText": { + "target": "com.amazonaws.ecr#RepositoryPolicyText", + "traits": { + "smithy.api#documentation": "

The JSON repository policy text applied to the repository.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#Severity": { + "type": "string" + }, + "com.amazonaws.ecr#SeverityCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.ecr#Source": { + "type": "string" + }, + "com.amazonaws.ecr#SourceLayerHash": { + "type": "string" + }, + "com.amazonaws.ecr#StartImageScan": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#StartImageScanRequest" + }, + "output": { + "target": "com.amazonaws.ecr#StartImageScanResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#ImageNotFoundException" + }, + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#LimitExceededException" + }, + { + "target": "com.amazonaws.ecr#RepositoryNotFoundException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#UnsupportedImageTypeException" + }, + { + "target": "com.amazonaws.ecr#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts an image vulnerability scan. An image scan can only be started once per 24\n hours on an individual image. This limit includes if an image was scanned on initial\n push. For more information, see Image scanning in the\n Amazon Elastic Container Registry User Guide.

" + } + }, + "com.amazonaws.ecr#StartImageScanRequest": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID associated with the registry that contains the repository in\n which to start an image scan request. If you do not specify a registry, the default registry is assumed.

" + } + }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The name of the repository that contains the images to scan.

", + "smithy.api#required": {} + } + }, + "imageId": { + "target": "com.amazonaws.ecr#ImageIdentifier", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#StartImageScanResponse": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The registry ID associated with the request.

" + } + }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The repository name associated with the request.

" + } + }, + "imageId": { + "target": "com.amazonaws.ecr#ImageIdentifier" + }, + "imageScanStatus": { + "target": "com.amazonaws.ecr#ImageScanStatus", + "traits": { + "smithy.api#documentation": "

The current state of the scan.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#StartLifecyclePolicyPreview": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#StartLifecyclePolicyPreviewRequest" + }, + "output": { + "target": "com.amazonaws.ecr#StartLifecyclePolicyPreviewResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#LifecyclePolicyNotFoundException" + }, + { + "target": "com.amazonaws.ecr#LifecyclePolicyPreviewInProgressException" + }, + { + "target": "com.amazonaws.ecr#RepositoryNotFoundException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts a preview of a lifecycle policy for the specified repository. This allows you\n to see the results before associating the lifecycle policy with the repository.

" + } + }, + "com.amazonaws.ecr#StartLifecyclePolicyPreviewRequest": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID associated with the registry that contains the repository.\n If you do not specify a registry, the default registry is assumed.

" + } + }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The name of the repository to be evaluated.

", + "smithy.api#required": {} + } + }, + "lifecyclePolicyText": { + "target": "com.amazonaws.ecr#LifecyclePolicyText", + "traits": { + "smithy.api#documentation": "

The policy to be evaluated against. If you do not specify a policy, the current policy\n for the repository is used.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#StartLifecyclePolicyPreviewResponse": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The registry ID associated with the request.

" + } + }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The repository name associated with the request.

" + } + }, + "lifecyclePolicyText": { + "target": "com.amazonaws.ecr#LifecyclePolicyText", + "traits": { + "smithy.api#documentation": "

The JSON repository policy text.

" + } + }, + "status": { + "target": "com.amazonaws.ecr#LifecyclePolicyPreviewStatus", + "traits": { + "smithy.api#documentation": "

The status of the lifecycle policy preview request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#Status": { + "type": "string" + }, + "com.amazonaws.ecr#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.ecr#TagKey", + "traits": { + "smithy.api#documentation": "

One part of a key-value pair that make up a tag. A key is a general label\n that acts like a category for more specific tag values.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.ecr#TagValue", + "traits": { + "smithy.api#documentation": "

A value acts as a descriptor within a tag category (key).

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The metadata to apply to a resource to help you categorize and organize them. Each tag\n consists of a key and a value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.

" + } + }, + "com.amazonaws.ecr#TagKey": { + "type": "string" + }, + "com.amazonaws.ecr#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#TagKey" + } + }, + "com.amazonaws.ecr#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#Tag" + } + }, + "com.amazonaws.ecr#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.ecr#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#InvalidTagParameterException" + }, + { + "target": "com.amazonaws.ecr#RepositoryNotFoundException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#TooManyTagsException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds specified tags to a resource with the specified ARN. Existing tags on a resource\n are not changed if they are not specified in the request parameters.

" + } + }, + "com.amazonaws.ecr#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.ecr#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the the resource to which to add tags. Currently, the only supported\n resource is an Amazon ECR repository.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.ecr#TagList", + "traits": { + "smithy.api#documentation": "

The tags to add to the resource. A tag is an array of key-value pairs.\n Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#TagStatus": { + "type": "enum", + "members": { + "TAGGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TAGGED" + } + }, + "UNTAGGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNTAGGED" + } + }, + "ANY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANY" + } + } + } + }, + "com.amazonaws.ecr#TagValue": { + "type": "string" + }, + "com.amazonaws.ecr#Tags": { + "type": "map", + "key": { + "target": "com.amazonaws.ecr#TagKey" + }, + "value": { + "target": "com.amazonaws.ecr#TagValue" + } + }, + "com.amazonaws.ecr#TemplateAlreadyExistsException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The repository creation template already exists. Specify a unique prefix and try\n again.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecr#TemplateNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The specified repository creation template can't be found. Verify the registry ID and\n prefix and try again.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecr#Title": { + "type": "string" + }, + "com.amazonaws.ecr#TooManyTagsException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The list of tags on the repository is over the limit. The maximum number of tags that\n can be applied to a repository is 50.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecr#Type": { + "type": "string" + }, + "com.amazonaws.ecr#UnableToAccessSecretException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The secret is unable to be accessed. Verify the resource permissions for the secret\n and try again.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecr#UnableToDecryptSecretValueException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The secret is accessible but is unable to be decrypted. Verify the resource\n permisisons and try again.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecr#UnableToGetUpstreamImageException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The image or images were unable to be pulled using the pull through cache rule. This\n is usually caused because of an issue with the Secrets Manager secret containing the credentials\n for the upstream registry.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecr#UnableToGetUpstreamLayerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

There was an issue getting the upstream layer matching the pull through cache\n rule.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecr#UnsupportedImageTypeException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The image is of a type that cannot be scanned.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecr#UnsupportedUpstreamRegistryException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The specified upstream registry isn't supported.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecr#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.ecr#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#InvalidTagParameterException" + }, + { + "target": "com.amazonaws.ecr#RepositoryNotFoundException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#TooManyTagsException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes specified tags from a resource.

" + } + }, + "com.amazonaws.ecr#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.ecr#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource from which to remove tags. Currently, the only supported\n resource is an Amazon ECR repository.

", + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.ecr#TagKeyList", + "traits": { + "smithy.api#documentation": "

The keys of the tags to be removed.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#UpdatePullThroughCacheRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#UpdatePullThroughCacheRuleRequest" + }, + "output": { + "target": "com.amazonaws.ecr#UpdatePullThroughCacheRuleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#PullThroughCacheRuleNotFoundException" + }, + { + "target": "com.amazonaws.ecr#SecretNotFoundException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#UnableToAccessSecretException" + }, + { + "target": "com.amazonaws.ecr#UnableToDecryptSecretValueException" + }, + { + "target": "com.amazonaws.ecr#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an existing pull through cache rule.

" + } + }, + "com.amazonaws.ecr#UpdatePullThroughCacheRuleRequest": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID associated with the registry associated with the pull through\n cache rule. If you do not specify a registry, the default registry is assumed.

" + } + }, + "ecrRepositoryPrefix": { + "target": "com.amazonaws.ecr#PullThroughCacheRuleRepositoryPrefix", + "traits": { + "smithy.api#documentation": "

The repository name prefix to use when caching images from the source registry.

", + "smithy.api#required": {} + } + }, + "credentialArn": { + "target": "com.amazonaws.ecr#CredentialArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that identifies the credentials to authenticate\n to the upstream registry.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#UpdatePullThroughCacheRuleResponse": { + "type": "structure", + "members": { + "ecrRepositoryPrefix": { + "target": "com.amazonaws.ecr#PullThroughCacheRuleRepositoryPrefix", + "traits": { + "smithy.api#documentation": "

The Amazon ECR repository prefix associated with the pull through cache rule.

" + } + }, + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The registry ID associated with the request.

" + } + }, + "updatedAt": { + "target": "com.amazonaws.ecr#UpdatedTimestamp", + "traits": { + "smithy.api#documentation": "

The date and time, in JavaScript date format, when the pull through cache rule was\n updated.

" + } + }, + "credentialArn": { + "target": "com.amazonaws.ecr#CredentialArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret associated with the pull through cache\n rule.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#UpdateRepositoryCreationTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#UpdateRepositoryCreationTemplateRequest" + }, + "output": { + "target": "com.amazonaws.ecr#UpdateRepositoryCreationTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#TemplateNotFoundException" + }, + { + "target": "com.amazonaws.ecr#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an existing repository creation template.

" + } + }, + "com.amazonaws.ecr#UpdateRepositoryCreationTemplateRequest": { + "type": "structure", + "members": { + "prefix": { + "target": "com.amazonaws.ecr#Prefix", + "traits": { + "smithy.api#documentation": "

The repository namespace prefix that matches an existing repository creation template\n in the registry. All repositories created using this namespace prefix will have the\n settings defined in this template applied. For example, a prefix of prod\n would apply to all repositories beginning with prod/. This includes a\n repository named prod/team1 as well as a repository named\n prod/repository1.

\n

To apply a template to all repositories in your registry that don't have an associated\n creation template, you can use ROOT as the prefix.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.ecr#RepositoryTemplateDescription", + "traits": { + "smithy.api#documentation": "

A description for the repository creation template.

" + } + }, + "encryptionConfiguration": { + "target": "com.amazonaws.ecr#EncryptionConfigurationForRepositoryCreationTemplate" + }, + "resourceTags": { + "target": "com.amazonaws.ecr#TagList", + "traits": { + "smithy.api#documentation": "

The metadata to apply to the repository to help you categorize and organize. Each tag\n consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.

" + } + }, + "imageTagMutability": { + "target": "com.amazonaws.ecr#ImageTagMutability", + "traits": { + "smithy.api#documentation": "

Updates the tag mutability setting for the repository. If this parameter is omitted,\n the default setting of MUTABLE will be used which will allow image tags to\n be overwritten. If IMMUTABLE is specified, all image tags within the\n repository will be immutable which will prevent them from being overwritten.

" + } + }, + "repositoryPolicy": { + "target": "com.amazonaws.ecr#RepositoryPolicyText", + "traits": { + "smithy.api#documentation": "

Updates the repository policy created using the template. A repository policy is a\n permissions policy associated with a repository to control access permissions.

" + } + }, + "lifecyclePolicy": { + "target": "com.amazonaws.ecr#LifecyclePolicyTextForRepositoryCreationTemplate", + "traits": { + "smithy.api#documentation": "

Updates the lifecycle policy associated with the specified repository creation\n template.

" + } + }, + "appliedFor": { + "target": "com.amazonaws.ecr#RCTAppliedForList", + "traits": { + "smithy.api#documentation": "

Updates the list of enumerable strings representing the Amazon ECR repository creation\n scenarios that this template will apply towards. The two supported scenarios are\n PULL_THROUGH_CACHE and REPLICATION\n

" + } + }, + "customRoleArn": { + "target": "com.amazonaws.ecr#CustomRoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of the role to be assumed by Amazon ECR. This role must be in the same account as\n the registry that you are configuring. Amazon ECR will assume your supplied role when the\n customRoleArn is specified. When this field isn't specified, Amazon ECR will use the\n service-linked role for the repository creation template.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#UpdateRepositoryCreationTemplateResponse": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The registry ID associated with the request.

" + } + }, + "repositoryCreationTemplate": { + "target": "com.amazonaws.ecr#RepositoryCreationTemplate", + "traits": { + "smithy.api#documentation": "

The details of the repository creation template associated with the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#UpdatedTimestamp": { + "type": "timestamp" + }, + "com.amazonaws.ecr#UploadId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" + } + }, + "com.amazonaws.ecr#UploadLayerPart": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#UploadLayerPartRequest" + }, + "output": { + "target": "com.amazonaws.ecr#UploadLayerPartResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidLayerPartException" + }, + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#KmsException" + }, + { + "target": "com.amazonaws.ecr#LimitExceededException" + }, + { + "target": "com.amazonaws.ecr#RepositoryNotFoundException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#UploadNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Uploads an image layer part to Amazon ECR.

\n

When an image is pushed, each new image layer is uploaded in parts. The maximum size\n of each image layer part can be 20971520 bytes (or about 20MB). The UploadLayerPart API\n is called once per each new image layer part.

\n \n

This operation is used by the Amazon ECR proxy and is not generally used by\n customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

\n " + } + }, + "com.amazonaws.ecr#UploadLayerPartRequest": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID associated with the registry to which you are uploading layer\n parts. If you do not specify a registry, the default registry is assumed.

" + } + }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The name of the repository to which you are uploading layer parts.

", + "smithy.api#required": {} + } + }, + "uploadId": { + "target": "com.amazonaws.ecr#UploadId", + "traits": { + "smithy.api#documentation": "

The upload ID from a previous InitiateLayerUpload operation to\n associate with the layer part upload.

", + "smithy.api#required": {} + } + }, + "partFirstByte": { + "target": "com.amazonaws.ecr#PartSize", + "traits": { + "smithy.api#documentation": "

The position of the first byte of the layer part witin the overall image layer.

", + "smithy.api#required": {} + } + }, + "partLastByte": { + "target": "com.amazonaws.ecr#PartSize", + "traits": { + "smithy.api#documentation": "

The position of the last byte of the layer part within the overall image layer.

", + "smithy.api#required": {} + } + }, + "layerPartBlob": { + "target": "com.amazonaws.ecr#LayerPartBlob", + "traits": { + "smithy.api#documentation": "

The base64-encoded layer part payload.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#UploadLayerPartResponse": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The registry ID associated with the request.

" + } + }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The repository name associated with the request.

" + } + }, + "uploadId": { + "target": "com.amazonaws.ecr#UploadId", + "traits": { + "smithy.api#documentation": "

The upload ID associated with the request.

" + } + }, + "lastByteReceived": { + "target": "com.amazonaws.ecr#PartSize", + "traits": { + "smithy.api#documentation": "

The integer value of the last byte received in the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#UploadNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage", + "traits": { + "smithy.api#documentation": "

The error message associated with the exception.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The upload could not be found, or the specified upload ID is not valid for this\n repository.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecr#UpstreamRegistry": { + "type": "enum", + "members": { + "EcrPublic": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ecr-public" + } + }, + "Quay": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "quay" + } + }, + "K8s": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "k8s" + } + }, + "DockerHub": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "docker-hub" + } + }, + "GitHubContainerRegistry": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "github-container-registry" + } + }, + "AzureContainerRegistry": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "azure-container-registry" + } + }, + "GitLabContainerRegistry": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "gitlab-container-registry" + } + } + } + }, + "com.amazonaws.ecr#Url": { + "type": "string" + }, + "com.amazonaws.ecr#ValidatePullThroughCacheRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#ValidatePullThroughCacheRuleRequest" + }, + "output": { + "target": "com.amazonaws.ecr#ValidatePullThroughCacheRuleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#PullThroughCacheRuleNotFoundException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Validates an existing pull through cache rule for an upstream registry that requires\n authentication. This will retrieve the contents of the Amazon Web Services Secrets Manager secret, verify the\n syntax, and then validate that authentication to the upstream registry is\n successful.

" + } + }, + "com.amazonaws.ecr#ValidatePullThroughCacheRuleRequest": { + "type": "structure", + "members": { + "ecrRepositoryPrefix": { + "target": "com.amazonaws.ecr#PullThroughCacheRuleRepositoryPrefix", + "traits": { + "smithy.api#documentation": "

The repository name prefix associated with the pull through cache rule.

", + "smithy.api#required": {} + } + }, + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The registry ID associated with the pull through cache rule.\n If you do not specify a registry, the default registry is assumed.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#ValidatePullThroughCacheRuleResponse": { + "type": "structure", + "members": { + "ecrRepositoryPrefix": { + "target": "com.amazonaws.ecr#PullThroughCacheRuleRepositoryPrefix", + "traits": { + "smithy.api#documentation": "

The Amazon ECR repository prefix associated with the pull through cache rule.

" + } + }, + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The registry ID associated with the request.

" + } + }, + "upstreamRegistryUrl": { + "target": "com.amazonaws.ecr#Url", + "traits": { + "smithy.api#documentation": "

The upstream registry URL associated with the pull through cache rule.

" + } + }, + "credentialArn": { + "target": "com.amazonaws.ecr#CredentialArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret associated with the pull through cache\n rule.

" + } + }, + "isValid": { + "target": "com.amazonaws.ecr#IsPTCRuleValid", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether or not the pull through cache rule was validated. If true, Amazon ECR\n was able to reach the upstream registry and authentication was successful. If\n false, there was an issue and validation failed. The\n failure reason indicates the cause.

" + } + }, + "failure": { + "target": "com.amazonaws.ecr#PTCValidateFailure", + "traits": { + "smithy.api#documentation": "

The reason the validation failed. For more details about possible causes and how to\n address them, see Using pull through cache\n rules in the Amazon Elastic Container Registry User Guide.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

There was an exception validating this request.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.ecr#Version": { + "type": "string" + }, + "com.amazonaws.ecr#VulnerabilityId": { + "type": "string" + }, + "com.amazonaws.ecr#VulnerabilitySourceUpdateTimestamp": { + "type": "timestamp" + }, + "com.amazonaws.ecr#VulnerablePackage": { + "type": "structure", + "members": { + "arch": { + "target": "com.amazonaws.ecr#Arch", + "traits": { + "smithy.api#documentation": "

The architecture of the vulnerable package.

" + } + }, + "epoch": { + "target": "com.amazonaws.ecr#Epoch", + "traits": { + "smithy.api#documentation": "

The epoch of the vulnerable package.

" + } + }, + "filePath": { + "target": "com.amazonaws.ecr#FilePath", + "traits": { + "smithy.api#documentation": "

The file path of the vulnerable package.

" + } + }, + "name": { + "target": "com.amazonaws.ecr#VulnerablePackageName", + "traits": { + "smithy.api#documentation": "

The name of the vulnerable package.

" + } + }, + "packageManager": { + "target": "com.amazonaws.ecr#PackageManager", + "traits": { + "smithy.api#documentation": "

The package manager of the vulnerable package.

" + } + }, + "release": { + "target": "com.amazonaws.ecr#Release", + "traits": { + "smithy.api#documentation": "

The release of the vulnerable package.

" + } + }, + "sourceLayerHash": { + "target": "com.amazonaws.ecr#SourceLayerHash", + "traits": { + "smithy.api#documentation": "

The source layer hash of the vulnerable package.

" + } + }, + "version": { + "target": "com.amazonaws.ecr#Version", + "traits": { + "smithy.api#documentation": "

The version of the vulnerable package.

" + } + }, + "fixedInVersion": { + "target": "com.amazonaws.ecr#FixedInVersion", + "traits": { + "smithy.api#documentation": "

The version of the package that contains the vulnerability fix.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information on the vulnerable package identified by a finding.

" + } + }, + "com.amazonaws.ecr#VulnerablePackageName": { + "type": "string" + }, + "com.amazonaws.ecr#VulnerablePackagesList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#VulnerablePackage" + } + } + } +} \ No newline at end of file diff --git a/pkg/testdata/codegen/sdk-codegen/aws-models/eks.json b/pkg/testdata/codegen/sdk-codegen/aws-models/eks.json new file mode 100644 index 00000000..6b5b638e --- /dev/null +++ b/pkg/testdata/codegen/sdk-codegen/aws-models/eks.json @@ -0,0 +1,11734 @@ +{ + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.eks#AMITypes": { + "type": "enum", + "members": { + "AL2_x86_64": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AL2_x86_64" + } + }, + "AL2_x86_64_GPU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AL2_x86_64_GPU" + } + }, + "AL2_ARM_64": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AL2_ARM_64" + } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } + }, + "BOTTLEROCKET_ARM_64": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BOTTLEROCKET_ARM_64" + } + }, + "BOTTLEROCKET_x86_64": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BOTTLEROCKET_x86_64" + } + }, + "BOTTLEROCKET_ARM_64_NVIDIA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BOTTLEROCKET_ARM_64_NVIDIA" + } + }, + "BOTTLEROCKET_x86_64_NVIDIA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BOTTLEROCKET_x86_64_NVIDIA" + } + }, + "WINDOWS_CORE_2019_x86_64": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_CORE_2019_x86_64" + } + }, + "WINDOWS_FULL_2019_x86_64": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_FULL_2019_x86_64" + } + }, + "WINDOWS_CORE_2022_x86_64": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_CORE_2022_x86_64" + } + }, + "WINDOWS_FULL_2022_x86_64": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_FULL_2022_x86_64" + } + }, + "AL2023_x86_64_STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AL2023_x86_64_STANDARD" + } + }, + "AL2023_ARM_64_STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AL2023_ARM_64_STANDARD" + } + }, + "AL2023_x86_64_NEURON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AL2023_x86_64_NEURON" + } + }, + "AL2023_x86_64_NVIDIA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AL2023_x86_64_NVIDIA" + } + } + } + }, + "com.amazonaws.eks#AWSWesleyFrontend": { + "type": "service", + "version": "2017-11-01", + "operations": [ + { + "target": "com.amazonaws.eks#AssociateAccessPolicy" + }, + { + "target": "com.amazonaws.eks#AssociateEncryptionConfig" + }, + { + "target": "com.amazonaws.eks#AssociateIdentityProviderConfig" + }, + { + "target": "com.amazonaws.eks#CreateAccessEntry" + }, + { + "target": "com.amazonaws.eks#CreateAddon" + }, + { + "target": "com.amazonaws.eks#CreateCluster" + }, + { + "target": "com.amazonaws.eks#CreateEksAnywhereSubscription" + }, + { + "target": "com.amazonaws.eks#CreateFargateProfile" + }, + { + "target": "com.amazonaws.eks#CreateNodegroup" + }, + { + "target": "com.amazonaws.eks#CreatePodIdentityAssociation" + }, + { + "target": "com.amazonaws.eks#DeleteAccessEntry" + }, + { + "target": "com.amazonaws.eks#DeleteAddon" + }, + { + "target": "com.amazonaws.eks#DeleteCluster" + }, + { + "target": "com.amazonaws.eks#DeleteEksAnywhereSubscription" + }, + { + "target": "com.amazonaws.eks#DeleteFargateProfile" + }, + { + "target": "com.amazonaws.eks#DeleteNodegroup" + }, + { + "target": "com.amazonaws.eks#DeletePodIdentityAssociation" + }, + { + "target": "com.amazonaws.eks#DeregisterCluster" + }, + { + "target": "com.amazonaws.eks#DescribeAccessEntry" + }, + { + "target": "com.amazonaws.eks#DescribeAddon" + }, + { + "target": "com.amazonaws.eks#DescribeAddonConfiguration" + }, + { + "target": "com.amazonaws.eks#DescribeAddonVersions" + }, + { + "target": "com.amazonaws.eks#DescribeCluster" + }, + { + "target": "com.amazonaws.eks#DescribeClusterVersions" + }, + { + "target": "com.amazonaws.eks#DescribeEksAnywhereSubscription" + }, + { + "target": "com.amazonaws.eks#DescribeFargateProfile" + }, + { + "target": "com.amazonaws.eks#DescribeIdentityProviderConfig" + }, + { + "target": "com.amazonaws.eks#DescribeInsight" + }, + { + "target": "com.amazonaws.eks#DescribeNodegroup" + }, + { + "target": "com.amazonaws.eks#DescribePodIdentityAssociation" + }, + { + "target": "com.amazonaws.eks#DescribeUpdate" + }, + { + "target": "com.amazonaws.eks#DisassociateAccessPolicy" + }, + { + "target": "com.amazonaws.eks#DisassociateIdentityProviderConfig" + }, + { + "target": "com.amazonaws.eks#ListAccessEntries" + }, + { + "target": "com.amazonaws.eks#ListAccessPolicies" + }, + { + "target": "com.amazonaws.eks#ListAddons" + }, + { + "target": "com.amazonaws.eks#ListAssociatedAccessPolicies" + }, + { + "target": "com.amazonaws.eks#ListClusters" + }, + { + "target": "com.amazonaws.eks#ListEksAnywhereSubscriptions" + }, + { + "target": "com.amazonaws.eks#ListFargateProfiles" + }, + { + "target": "com.amazonaws.eks#ListIdentityProviderConfigs" + }, + { + "target": "com.amazonaws.eks#ListInsights" + }, + { + "target": "com.amazonaws.eks#ListNodegroups" + }, + { + "target": "com.amazonaws.eks#ListPodIdentityAssociations" + }, + { + "target": "com.amazonaws.eks#ListTagsForResource" + }, + { + "target": "com.amazonaws.eks#ListUpdates" + }, + { + "target": "com.amazonaws.eks#RegisterCluster" + }, + { + "target": "com.amazonaws.eks#TagResource" + }, + { + "target": "com.amazonaws.eks#UntagResource" + }, + { + "target": "com.amazonaws.eks#UpdateAccessEntry" + }, + { + "target": "com.amazonaws.eks#UpdateAddon" + }, + { + "target": "com.amazonaws.eks#UpdateClusterConfig" + }, + { + "target": "com.amazonaws.eks#UpdateClusterVersion" + }, + { + "target": "com.amazonaws.eks#UpdateEksAnywhereSubscription" + }, + { + "target": "com.amazonaws.eks#UpdateNodegroupConfig" + }, + { + "target": "com.amazonaws.eks#UpdateNodegroupVersion" + }, + { + "target": "com.amazonaws.eks#UpdatePodIdentityAssociation" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "EKS", + "arnNamespace": "eks", + "cloudFormationName": "EKS", + "cloudTrailEventSource": "eks.amazonaws.com", + "endpointPrefix": "eks" + }, + "aws.auth#sigv4": { + "name": "eks" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

Amazon Elastic Kubernetes Service (Amazon EKS) is a managed service that makes it easy\n for you to run Kubernetes on Amazon Web Services without needing to setup or maintain your own\n Kubernetes control plane. Kubernetes is an open-source system for automating the deployment,\n scaling, and management of containerized applications.

\n

Amazon EKS runs up-to-date versions of the open-source Kubernetes software, so you\n can use all the existing plugins and tooling from the Kubernetes community. Applications\n running on Amazon EKS are fully compatible with applications running on any\n standard Kubernetes environment, whether running in on-premises data centers or public\n clouds. This means that you can easily migrate any standard Kubernetes application to Amazon EKS without any code modification required.

", + "smithy.api#title": "Amazon Elastic Kubernetes Service", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://eks-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws" + ] + } + ], + "endpoint": { + "url": "https://fips.eks.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-us-gov" + ] + } + ], + "endpoint": { + "url": "https://eks.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://eks-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://eks.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://eks.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.af-south-1.amazonaws.com" + } + }, + "params": { + "Region": "af-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.ap-east-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.ap-south-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.eu-north-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.eu-south-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.eu-west-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.eu-west-3.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.me-south-1.amazonaws.com" + } + }, + "params": { + "Region": "me-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.sa-east-1.amazonaws.com" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://fips.eks.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://fips.eks.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://fips.eks.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://fips.eks.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://eks-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://eks.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://eks-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://eks.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://eks-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://eks.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.eks#AccessConfigResponse": { + "type": "structure", + "members": { + "bootstrapClusterCreatorAdminPermissions": { + "target": "com.amazonaws.eks#BoxedBoolean", + "traits": { + "smithy.api#documentation": "

Specifies whether or not the cluster creator IAM principal was set as a\n cluster admin access entry during cluster creation time.

" + } + }, + "authenticationMode": { + "target": "com.amazonaws.eks#AuthenticationMode", + "traits": { + "smithy.api#documentation": "

The current authentication mode of the cluster.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The access configuration for the cluster.

" + } + }, + "com.amazonaws.eks#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

You do not have sufficient access to perform this action.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

You don't have permissions to perform the requested operation. The IAM principal\n making the request must have at least one IAM permissions policy attached\n that grants the required permissions. For more information, see Access\n management in the IAM User Guide.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.eks#AccessEntry": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of your cluster.

" + } + }, + "principalArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM principal for the access entry. If you ever delete\n the IAM principal with this ARN, the access entry isn't automatically\n deleted. We recommend that you delete the access entry with an ARN for an IAM principal that you delete. If you don't delete the access entry and ever\n recreate the IAM principal, even if it has the same ARN, the access\n entry won't work. This is because even though the ARN is the same for the recreated\n IAM principal, the roleID or userID (you\n can see this with the Security Token Service\n GetCallerIdentity API) is different for the recreated IAM\n principal than it was for the original IAM principal. Even though you\n don't see the IAM principal's roleID or userID\n for an access entry, Amazon EKS stores it with the access entry.

" + } + }, + "kubernetesGroups": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

A name that you've specified in a Kubernetes RoleBinding or\n ClusterRoleBinding object so that Kubernetes authorizes the\n principalARN access to cluster objects.

" + } + }, + "accessEntryArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The ARN of the access entry.

" + } + }, + "createdAt": { + "target": "com.amazonaws.eks#Timestamp", + "traits": { + "smithy.api#documentation": "

The Unix epoch timestamp at object creation.

" + } + }, + "modifiedAt": { + "target": "com.amazonaws.eks#Timestamp", + "traits": { + "smithy.api#documentation": "

The Unix epoch timestamp for the last modification to the object.

" + } + }, + "tags": { + "target": "com.amazonaws.eks#TagMap", + "traits": { + "smithy.api#documentation": "

Metadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.

" + } + }, + "username": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of a user that can authenticate to your cluster.

" + } + }, + "type": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The type of the access entry.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An access entry allows an IAM principal (user or role) to access your\n cluster. Access entries can replace the need to maintain the aws-auth\n ConfigMap for authentication. For more information about access entries,\n see Access\n entries in the Amazon EKS User Guide.

" + } + }, + "com.amazonaws.eks#AccessPoliciesList": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#AccessPolicy" + } + }, + "com.amazonaws.eks#AccessPolicy": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the access policy.

" + } + }, + "arn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The ARN of the access policy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An access policy includes permissions that allow Amazon EKS to authorize an\n IAM principal to work with Kubernetes objects on your cluster. The policies are\n managed by Amazon EKS, but they're not IAM policies. You can't\n view the permissions in the policies using the API. The permissions for many of the\n policies are similar to the Kubernetes cluster-admin, admin,\n edit, and view cluster roles. For more information about\n these cluster roles, see User-facing roles in the Kubernetes documentation. To view the contents of the\n policies, see Access\n policy permissions in the Amazon EKS User Guide.

" + } + }, + "com.amazonaws.eks#AccessScope": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.eks#AccessScopeType", + "traits": { + "smithy.api#documentation": "

The scope type of an access policy.

" + } + }, + "namespaces": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

A Kubernetes namespace that an access policy is scoped to. A value is required\n if you specified namespace for Type.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The scope of an AccessPolicy that's associated to an\n AccessEntry.

" + } + }, + "com.amazonaws.eks#AccessScopeType": { + "type": "enum", + "members": { + "cluster": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cluster" + } + }, + "namespace": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "namespace" + } + } + } + }, + "com.amazonaws.eks#AdditionalInfoMap": { + "type": "map", + "key": { + "target": "com.amazonaws.eks#String" + }, + "value": { + "target": "com.amazonaws.eks#String" + } + }, + "com.amazonaws.eks#Addon": { + "type": "structure", + "members": { + "addonName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the add-on.

" + } + }, + "clusterName": { + "target": "com.amazonaws.eks#ClusterName", + "traits": { + "smithy.api#documentation": "

The name of your cluster.

" + } + }, + "status": { + "target": "com.amazonaws.eks#AddonStatus", + "traits": { + "smithy.api#documentation": "

The status of the add-on.

" + } + }, + "addonVersion": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The version of the add-on.

" + } + }, + "health": { + "target": "com.amazonaws.eks#AddonHealth", + "traits": { + "smithy.api#documentation": "

An object that represents the health of the add-on.

" + } + }, + "addonArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the add-on.

" + } + }, + "createdAt": { + "target": "com.amazonaws.eks#Timestamp", + "traits": { + "smithy.api#documentation": "

The Unix epoch timestamp at object creation.

" + } + }, + "modifiedAt": { + "target": "com.amazonaws.eks#Timestamp", + "traits": { + "smithy.api#documentation": "

The Unix epoch timestamp for the last modification to the object.

" + } + }, + "serviceAccountRoleArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that's bound to the Kubernetes\n ServiceAccount object that the add-on uses.

" + } + }, + "tags": { + "target": "com.amazonaws.eks#TagMap", + "traits": { + "smithy.api#documentation": "

Metadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.

" + } + }, + "publisher": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The publisher of the add-on.

" + } + }, + "owner": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The owner of the add-on.

" + } + }, + "marketplaceInformation": { + "target": "com.amazonaws.eks#MarketplaceInformation", + "traits": { + "smithy.api#documentation": "

Information about an Amazon EKS add-on from the Amazon Web Services Marketplace.

" + } + }, + "configurationValues": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The configuration values that you provided.

" + } + }, + "podIdentityAssociations": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

An array of Pod Identity Assocations owned by the Addon. Each EKS Pod Identity association maps a role to a service account in a namespace in the cluster.

\n

For more information, see Attach an IAM Role to an Amazon EKS add-on using Pod Identity in the EKS User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An Amazon EKS add-on. For more information, see Amazon EKS add-ons in\n the Amazon EKS User Guide.

" + } + }, + "com.amazonaws.eks#AddonCompatibilityDetail": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon EKS add-on.

" + } + }, + "compatibleVersions": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

A list of compatible add-on versions.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains compatibility information for an Amazon EKS add-on.

" + } + }, + "com.amazonaws.eks#AddonCompatibilityDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#AddonCompatibilityDetail" + } + }, + "com.amazonaws.eks#AddonHealth": { + "type": "structure", + "members": { + "issues": { + "target": "com.amazonaws.eks#AddonIssueList", + "traits": { + "smithy.api#documentation": "

An object representing the health issues for an add-on.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The health of the add-on.

" + } + }, + "com.amazonaws.eks#AddonInfo": { + "type": "structure", + "members": { + "addonName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the add-on.

" + } + }, + "type": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The type of the add-on.

" + } + }, + "addonVersions": { + "target": "com.amazonaws.eks#AddonVersionInfoList", + "traits": { + "smithy.api#documentation": "

An object representing information about available add-on versions and compatible\n Kubernetes versions.

" + } + }, + "publisher": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The publisher of the add-on.

" + } + }, + "owner": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The owner of the add-on.

" + } + }, + "marketplaceInformation": { + "target": "com.amazonaws.eks#MarketplaceInformation", + "traits": { + "smithy.api#documentation": "

Information about the add-on from the Amazon Web Services Marketplace.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an add-on.

" + } + }, + "com.amazonaws.eks#AddonIssue": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.eks#AddonIssueCode", + "traits": { + "smithy.api#documentation": "

A code that describes the type of issue.

" + } + }, + "message": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

A message that provides details about the issue and what might cause it.

" + } + }, + "resourceIds": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

The resource IDs of the issue.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An issue related to an add-on.

" + } + }, + "com.amazonaws.eks#AddonIssueCode": { + "type": "enum", + "members": { + "ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AccessDenied" + } + }, + "INTERNAL_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InternalFailure" + } + }, + "CLUSTER_UNREACHABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ClusterUnreachable" + } + }, + "INSUFFICIENT_NUMBER_OF_REPLICAS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InsufficientNumberOfReplicas" + } + }, + "CONFIGURATION_CONFLICT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ConfigurationConflict" + } + }, + "ADMISSION_REQUEST_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AdmissionRequestDenied" + } + }, + "UNSUPPORTED_ADDON_MODIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UnsupportedAddonModification" + } + }, + "K8S_RESOURCE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "K8sResourceNotFound" + } + }, + "ADDON_SUBSCRIPTION_NEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AddonSubscriptionNeeded" + } + }, + "ADDON_PERMISSION_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AddonPermissionFailure" + } + } + } + }, + "com.amazonaws.eks#AddonIssueList": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#AddonIssue" + } + }, + "com.amazonaws.eks#AddonPodIdentityAssociations": { + "type": "structure", + "members": { + "serviceAccount": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of a Kubernetes Service Account.

", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The ARN of an IAM Role.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A type of Pod Identity Association owned by an Amazon EKS Add-on.

\n

Each EKS Pod Identity Association maps a role to a service account in a namespace in the cluster.

\n

For more information, see Attach an IAM Role to an Amazon EKS add-on using Pod Identity in the EKS User Guide.

" + } + }, + "com.amazonaws.eks#AddonPodIdentityAssociationsList": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#AddonPodIdentityAssociations" + } + }, + "com.amazonaws.eks#AddonPodIdentityConfiguration": { + "type": "structure", + "members": { + "serviceAccount": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Kubernetes Service Account name used by the addon.

" + } + }, + "recommendedManagedPolicies": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

A suggested IAM Policy for the addon.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about how to configure IAM for an Addon.

" + } + }, + "com.amazonaws.eks#AddonPodIdentityConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#AddonPodIdentityConfiguration" + } + }, + "com.amazonaws.eks#AddonStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + }, + "DEGRADED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEGRADED" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + } + } + }, + "com.amazonaws.eks#AddonVersionInfo": { + "type": "structure", + "members": { + "addonVersion": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The version of the add-on.

" + } + }, + "architecture": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

The architectures that the version supports.

" + } + }, + "computeTypes": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

Indicates the compute type of the addon version.

" + } + }, + "compatibilities": { + "target": "com.amazonaws.eks#Compatibilities", + "traits": { + "smithy.api#documentation": "

An object representing the compatibilities of a version.

" + } + }, + "requiresConfiguration": { + "target": "com.amazonaws.eks#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the add-on requires configuration.

" + } + }, + "requiresIamPermissions": { + "target": "com.amazonaws.eks#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates if the Addon requires IAM Permissions to operate, such as networking permissions.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an add-on version.

" + } + }, + "com.amazonaws.eks#AddonVersionInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#AddonVersionInfo" + } + }, + "com.amazonaws.eks#Addons": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#AddonInfo" + } + }, + "com.amazonaws.eks#AssociateAccessPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#AssociateAccessPolicyRequest" + }, + "output": { + "target": "com.amazonaws.eks#AssociateAccessPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Associates an access policy and its scope to an access entry. For more information\n about associating access policies, see Associating and disassociating\n access policies to and from access entries in the Amazon EKS User Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/clusters/{clusterName}/access-entries/{principalArn}/access-policies", + "code": 200 + } + } + }, + "com.amazonaws.eks#AssociateAccessPolicyRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of your cluster.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "principalArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM user or role for the AccessEntry\n that you're associating the access policy to.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "policyArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The ARN of the AccessPolicy that you're associating. For a list of\n ARNs, use ListAccessPolicies.

", + "smithy.api#required": {} + } + }, + "accessScope": { + "target": "com.amazonaws.eks#AccessScope", + "traits": { + "smithy.api#documentation": "

The scope for the AccessPolicy. You can scope access policies to an\n entire cluster or to specific Kubernetes namespaces.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#AssociateAccessPolicyResponse": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of your cluster.

" + } + }, + "principalArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM principal for the AccessEntry.

" + } + }, + "associatedAccessPolicy": { + "target": "com.amazonaws.eks#AssociatedAccessPolicy", + "traits": { + "smithy.api#documentation": "

The AccessPolicy and scope associated to the\n AccessEntry.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#AssociateEncryptionConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#AssociateEncryptionConfigRequest" + }, + "output": { + "target": "com.amazonaws.eks#AssociateEncryptionConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceInUseException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Associates an encryption configuration to an existing cluster.

\n

Use this API to enable encryption on existing clusters that don't already have\n encryption enabled. This allows you to implement a defense-in-depth security strategy\n without migrating applications to new Amazon EKS clusters.

", + "smithy.api#http": { + "method": "POST", + "uri": "/clusters/{clusterName}/encryption-config/associate", + "code": 200 + } + } + }, + "com.amazonaws.eks#AssociateEncryptionConfigRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of your cluster.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "encryptionConfig": { + "target": "com.amazonaws.eks#EncryptionConfigList", + "traits": { + "smithy.api#documentation": "

The configuration you are using for encryption.

", + "smithy.api#required": {} + } + }, + "clientRequestToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#AssociateEncryptionConfigResponse": { + "type": "structure", + "members": { + "update": { + "target": "com.amazonaws.eks#Update" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#AssociateIdentityProviderConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#AssociateIdentityProviderConfigRequest" + }, + "output": { + "target": "com.amazonaws.eks#AssociateIdentityProviderConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceInUseException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Associates an identity provider configuration to a cluster.

\n

If you want to authenticate identities using an identity provider, you can create an\n identity provider configuration and associate it to your cluster. After configuring\n authentication to your cluster you can create Kubernetes Role and\n ClusterRole objects, assign permissions to them, and then bind them to\n the identities using Kubernetes RoleBinding and ClusterRoleBinding\n objects. For more information see Using RBAC\n Authorization in the Kubernetes documentation.

", + "smithy.api#http": { + "method": "POST", + "uri": "/clusters/{clusterName}/identity-provider-configs/associate", + "code": 200 + } + } + }, + "com.amazonaws.eks#AssociateIdentityProviderConfigRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of your cluster.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "oidc": { + "target": "com.amazonaws.eks#OidcIdentityProviderConfigRequest", + "traits": { + "smithy.api#documentation": "

An object representing an OpenID Connect (OIDC) identity provider configuration.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.eks#TagMap", + "traits": { + "smithy.api#documentation": "

Metadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.

" + } + }, + "clientRequestToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#AssociateIdentityProviderConfigResponse": { + "type": "structure", + "members": { + "update": { + "target": "com.amazonaws.eks#Update" + }, + "tags": { + "target": "com.amazonaws.eks#TagMap", + "traits": { + "smithy.api#documentation": "

The tags for the resource.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#AssociatedAccessPoliciesList": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#AssociatedAccessPolicy" + } + }, + "com.amazonaws.eks#AssociatedAccessPolicy": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The ARN of the AccessPolicy.

" + } + }, + "accessScope": { + "target": "com.amazonaws.eks#AccessScope", + "traits": { + "smithy.api#documentation": "

The scope of the access policy.

" + } + }, + "associatedAt": { + "target": "com.amazonaws.eks#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time the AccessPolicy was associated with an\n AccessEntry.

" + } + }, + "modifiedAt": { + "target": "com.amazonaws.eks#Timestamp", + "traits": { + "smithy.api#documentation": "

The Unix epoch timestamp for the last modification to the object.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An access policy association.

" + } + }, + "com.amazonaws.eks#AuthenticationMode": { + "type": "enum", + "members": { + "API": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "API" + } + }, + "API_AND_CONFIG_MAP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "API_AND_CONFIG_MAP" + } + }, + "CONFIG_MAP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONFIG_MAP" + } + } + } + }, + "com.amazonaws.eks#AutoScalingGroup": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the Auto Scaling group associated with an Amazon EKS managed\n node group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An Auto Scaling group that is associated with an Amazon EKS managed node\n group.

" + } + }, + "com.amazonaws.eks#AutoScalingGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#AutoScalingGroup" + } + }, + "com.amazonaws.eks#BadRequestException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

This exception is thrown if the request contains a semantic error. The precise meaning\n will depend on the API, and will be documented in the error message.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This exception is thrown if the request contains a semantic error. The precise meaning\n will depend on the API, and will be documented in the error message.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.eks#BlockStorage": { + "type": "structure", + "members": { + "enabled": { + "target": "com.amazonaws.eks#BoxedBoolean", + "traits": { + "smithy.api#documentation": "

Indicates if the block storage capability is enabled on your EKS Auto Mode cluster. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your Amazon Web Services account.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your Amazon Web Services account. For more information, see EKS Auto Mode block storage capability in the EKS User Guide.

" + } + }, + "com.amazonaws.eks#Boolean": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.eks#BoxedBoolean": { + "type": "boolean" + }, + "com.amazonaws.eks#BoxedInteger": { + "type": "integer" + }, + "com.amazonaws.eks#Capacity": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.eks#CapacityTypes": { + "type": "enum", + "members": { + "ON_DEMAND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ON_DEMAND" + } + }, + "SPOT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SPOT" + } + }, + "CAPACITY_BLOCK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CAPACITY_BLOCK" + } + } + } + }, + "com.amazonaws.eks#Category": { + "type": "enum", + "members": { + "UPGRADE_READINESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPGRADE_READINESS" + } + } + } + }, + "com.amazonaws.eks#CategoryList": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#Category" + } + }, + "com.amazonaws.eks#Certificate": { + "type": "structure", + "members": { + "data": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Base64-encoded certificate data required to communicate with your cluster. Add\n this to the certificate-authority-data section of the\n kubeconfig file for your cluster.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object representing the certificate-authority-data for your\n cluster.

" + } + }, + "com.amazonaws.eks#ClientException": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon EKS cluster associated with the exception.

" + } + }, + "nodegroupName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon EKS managed node group associated with the exception.

" + } + }, + "addonName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon EKS add-on name associated with the exception.

" + } + }, + "subscriptionId": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon EKS subscription ID with the exception.

" + } + }, + "message": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

These errors are usually caused by a client action. Actions can include using an\n action or resource on behalf of an IAM principal that doesn't have permissions to use\n the action or resource or specifying an identifier that is not valid.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

These errors are usually caused by a client action. Actions can include using an\n action or resource on behalf of an IAM principal that doesn't have permissions to use\n the action or resource or specifying an identifier that is not valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.eks#ClientStat": { + "type": "structure", + "members": { + "userAgent": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The user agent of the Kubernetes client using the deprecated resource.

" + } + }, + "numberOfRequestsLast30Days": { + "target": "com.amazonaws.eks#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of requests from the Kubernetes client seen over the last 30 days.

" + } + }, + "lastRequestTime": { + "target": "com.amazonaws.eks#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of the last request seen from the Kubernetes client.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about clients using the deprecated resources.

" + } + }, + "com.amazonaws.eks#ClientStats": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#ClientStat" + } + }, + "com.amazonaws.eks#Cluster": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of your cluster.

" + } + }, + "arn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

" + } + }, + "createdAt": { + "target": "com.amazonaws.eks#Timestamp", + "traits": { + "smithy.api#documentation": "

The Unix epoch timestamp at object creation.

" + } + }, + "version": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Kubernetes server version for the cluster.

" + } + }, + "endpoint": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The endpoint for your Kubernetes API server.

" + } + }, + "roleArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes\n control plane to make calls to Amazon Web Services API operations on your behalf.

" + } + }, + "resourcesVpcConfig": { + "target": "com.amazonaws.eks#VpcConfigResponse", + "traits": { + "smithy.api#documentation": "

The VPC configuration used by the cluster control plane. Amazon EKS VPC\n resources have specific requirements to work properly with Kubernetes. For more information,\n see Cluster VPC\n considerations and Cluster security group considerations in the\n Amazon EKS User Guide.

" + } + }, + "kubernetesNetworkConfig": { + "target": "com.amazonaws.eks#KubernetesNetworkConfigResponse", + "traits": { + "smithy.api#documentation": "

The Kubernetes network configuration for the cluster.

" + } + }, + "logging": { + "target": "com.amazonaws.eks#Logging", + "traits": { + "smithy.api#documentation": "

The logging configuration for your cluster.

" + } + }, + "identity": { + "target": "com.amazonaws.eks#Identity", + "traits": { + "smithy.api#documentation": "

The identity provider information for the cluster.

" + } + }, + "status": { + "target": "com.amazonaws.eks#ClusterStatus", + "traits": { + "smithy.api#documentation": "

The current status of the cluster.

" + } + }, + "certificateAuthority": { + "target": "com.amazonaws.eks#Certificate", + "traits": { + "smithy.api#documentation": "

The certificate-authority-data for your cluster.

" + } + }, + "clientRequestToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.

" + } + }, + "platformVersion": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The platform version of your Amazon EKS cluster. For more information about\n clusters deployed on the Amazon Web Services Cloud, see Platform\n versions in the \n Amazon EKS User Guide\n . For more information\n about local clusters deployed on an Outpost, see Amazon EKS local cluster platform versions in the\n \n Amazon EKS User Guide\n .

" + } + }, + "tags": { + "target": "com.amazonaws.eks#TagMap", + "traits": { + "smithy.api#documentation": "

Metadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.

" + } + }, + "encryptionConfig": { + "target": "com.amazonaws.eks#EncryptionConfigList", + "traits": { + "smithy.api#documentation": "

The encryption configuration for the cluster.

" + } + }, + "connectorConfig": { + "target": "com.amazonaws.eks#ConnectorConfigResponse", + "traits": { + "smithy.api#documentation": "

The configuration used to connect to a cluster for registration.

" + } + }, + "id": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The ID of your local Amazon EKS cluster on an Amazon Web Services Outpost. This\n property isn't available for an Amazon EKS cluster on the Amazon Web Services\n cloud.

" + } + }, + "health": { + "target": "com.amazonaws.eks#ClusterHealth", + "traits": { + "smithy.api#documentation": "

An object representing the health of your Amazon EKS cluster.

" + } + }, + "outpostConfig": { + "target": "com.amazonaws.eks#OutpostConfigResponse", + "traits": { + "smithy.api#documentation": "

An object representing the configuration of your local Amazon EKS cluster on\n an Amazon Web Services Outpost. This object isn't available for clusters on the Amazon Web Services cloud.

" + } + }, + "accessConfig": { + "target": "com.amazonaws.eks#AccessConfigResponse", + "traits": { + "smithy.api#documentation": "

The access configuration for the cluster.

" + } + }, + "upgradePolicy": { + "target": "com.amazonaws.eks#UpgradePolicyResponse", + "traits": { + "smithy.api#documentation": "

This value indicates if extended support is enabled or disabled for the cluster.

\n

\n Learn more about EKS Extended Support in the EKS User Guide.\n

" + } + }, + "zonalShiftConfig": { + "target": "com.amazonaws.eks#ZonalShiftConfigResponse", + "traits": { + "smithy.api#documentation": "

The configuration for zonal shift for the cluster.

" + } + }, + "remoteNetworkConfig": { + "target": "com.amazonaws.eks#RemoteNetworkConfigResponse", + "traits": { + "smithy.api#documentation": "

The configuration in the cluster for EKS Hybrid Nodes. You can't change or update this\n configuration after the cluster is created.

" + } + }, + "computeConfig": { + "target": "com.amazonaws.eks#ComputeConfigResponse", + "traits": { + "smithy.api#documentation": "

Indicates the current configuration of the compute capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your Amazon Web Services account. For more information, see EKS Auto Mode compute capability in the EKS User Guide.

" + } + }, + "storageConfig": { + "target": "com.amazonaws.eks#StorageConfigResponse", + "traits": { + "smithy.api#documentation": "

Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your Amazon Web Services account. For more information, see EKS Auto Mode block storage capability in the EKS User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object representing an Amazon EKS cluster.

" + } + }, + "com.amazonaws.eks#ClusterHealth": { + "type": "structure", + "members": { + "issues": { + "target": "com.amazonaws.eks#ClusterIssueList", + "traits": { + "smithy.api#documentation": "

An object representing the health issues of your Amazon EKS cluster.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object representing the health of your Amazon EKS cluster.

" + } + }, + "com.amazonaws.eks#ClusterIssue": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.eks#ClusterIssueCode", + "traits": { + "smithy.api#documentation": "

The error code of the issue.

" + } + }, + "message": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

A description of the issue.

" + } + }, + "resourceIds": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

The resource IDs that the issue relates to.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An issue with your Amazon EKS cluster.

" + } + }, + "com.amazonaws.eks#ClusterIssueCode": { + "type": "enum", + "members": { + "ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AccessDenied" + } + }, + "CLUSTER_UNREACHABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ClusterUnreachable" + } + }, + "CONFIGURATION_CONFLICT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ConfigurationConflict" + } + }, + "INTERNAL_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InternalFailure" + } + }, + "RESOURCE_LIMIT_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ResourceLimitExceeded" + } + }, + "RESOURCE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ResourceNotFound" + } + }, + "IAM_ROLE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IamRoleNotFound" + } + }, + "VPC_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VpcNotFound" + } + }, + "INSUFFICIENT_FREE_ADDRESSES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InsufficientFreeAddresses" + } + }, + "EC2_SERVICE_NOT_SUBSCRIBED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ec2ServiceNotSubscribed" + } + }, + "EC2_SUBNET_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ec2SubnetNotFound" + } + }, + "EC2_SECURITY_GROUP_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ec2SecurityGroupNotFound" + } + }, + "KMS_GRANT_REVOKED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KmsGrantRevoked" + } + }, + "KMS_KEY_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KmsKeyNotFound" + } + }, + "KMS_KEY_MARKED_FOR_DELETION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KmsKeyMarkedForDeletion" + } + }, + "KMS_KEY_DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KmsKeyDisabled" + } + }, + "STS_REGIONAL_ENDPOINT_DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StsRegionalEndpointDisabled" + } + }, + "UNSUPPORTED_VERSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UnsupportedVersion" + } + }, + "OTHER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Other" + } + } + } + }, + "com.amazonaws.eks#ClusterIssueList": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#ClusterIssue" + } + }, + "com.amazonaws.eks#ClusterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[0-9A-Za-z][A-Za-z0-9\\-_]*$" + } + }, + "com.amazonaws.eks#ClusterStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + } + } + }, + "com.amazonaws.eks#ClusterVersionInformation": { + "type": "structure", + "members": { + "clusterVersion": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Kubernetes version for the cluster.

" + } + }, + "clusterType": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The type of cluster this version is for.

" + } + }, + "defaultPlatformVersion": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

Default platform version for this Kubernetes version.

" + } + }, + "defaultVersion": { + "target": "com.amazonaws.eks#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates if this is a default version.

" + } + }, + "releaseDate": { + "target": "com.amazonaws.eks#Timestamp", + "traits": { + "smithy.api#documentation": "

The release date of this cluster version.

" + } + }, + "endOfStandardSupportDate": { + "target": "com.amazonaws.eks#Timestamp", + "traits": { + "smithy.api#documentation": "

Date when standard support ends for this version.

" + } + }, + "endOfExtendedSupportDate": { + "target": "com.amazonaws.eks#Timestamp", + "traits": { + "smithy.api#documentation": "

Date when extended support ends for this version.

" + } + }, + "status": { + "target": "com.amazonaws.eks#ClusterVersionStatus", + "traits": { + "smithy.api#documentation": "

Current status of this cluster version.

" + } + }, + "kubernetesPatchVersion": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The patch version of Kubernetes for this cluster version.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about a specific EKS cluster version.

" + } + }, + "com.amazonaws.eks#ClusterVersionList": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#ClusterVersionInformation" + } + }, + "com.amazonaws.eks#ClusterVersionStatus": { + "type": "enum", + "members": { + "unsupported": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unsupported" + } + }, + "standard_support": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "standard-support" + } + }, + "extended_support": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "extended-support" + } + } + } + }, + "com.amazonaws.eks#Compatibilities": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#Compatibility" + } + }, + "com.amazonaws.eks#Compatibility": { + "type": "structure", + "members": { + "clusterVersion": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The supported Kubernetes version of the cluster.

" + } + }, + "platformVersions": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

The supported compute platform.

" + } + }, + "defaultVersion": { + "target": "com.amazonaws.eks#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

The supported default version.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Compatibility information.

" + } + }, + "com.amazonaws.eks#ComputeConfigRequest": { + "type": "structure", + "members": { + "enabled": { + "target": "com.amazonaws.eks#BoxedBoolean", + "traits": { + "smithy.api#documentation": "

Request to enable or disable the compute capability on your EKS Auto Mode cluster. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your Amazon Web Services account.

" + } + }, + "nodePools": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

Configuration for node pools that defines the compute resources for your EKS Auto Mode cluster. For more information, see EKS Auto Mode Node Pools in the EKS User Guide.

" + } + }, + "nodeRoleArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM Role EKS will assign to EC2 Managed Instances in your EKS Auto Mode cluster. This value cannot be changed after the compute capability of EKS Auto Mode is enabled. For more information, see the IAM Reference in the EKS User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Request to update the configuration of the compute capability of your EKS Auto Mode cluster. For example, enable the capability. For more information, see EKS Auto Mode compute capability in the EKS User Guide.

" + } + }, + "com.amazonaws.eks#ComputeConfigResponse": { + "type": "structure", + "members": { + "enabled": { + "target": "com.amazonaws.eks#BoxedBoolean", + "traits": { + "smithy.api#documentation": "

Indicates if the compute capability is enabled on your EKS Auto Mode cluster. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your Amazon Web Services account.

" + } + }, + "nodePools": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

Indicates the current configuration of node pools in your EKS Auto Mode cluster. For more information, see EKS Auto Mode Node Pools in the EKS User Guide.

" + } + }, + "nodeRoleArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM Role EKS will assign to EC2 Managed Instances in your EKS Auto Mode cluster.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Indicates the status of the request to update the compute capability of your EKS Auto Mode cluster.

" + } + }, + "com.amazonaws.eks#ConnectorConfigProvider": { + "type": "enum", + "members": { + "EKS_ANYWHERE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EKS_ANYWHERE" + } + }, + "ANTHOS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANTHOS" + } + }, + "GKE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GKE" + } + }, + "AKS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AKS" + } + }, + "OPENSHIFT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPENSHIFT" + } + }, + "TANZU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TANZU" + } + }, + "RANCHER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RANCHER" + } + }, + "EC2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC2" + } + }, + "OTHER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OTHER" + } + } + } + }, + "com.amazonaws.eks#ConnectorConfigRequest": { + "type": "structure", + "members": { + "roleArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role that is authorized to request the connector\n configuration.

", + "smithy.api#required": {} + } + }, + "provider": { + "target": "com.amazonaws.eks#ConnectorConfigProvider", + "traits": { + "smithy.api#documentation": "

The cloud provider for the target cluster to connect.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration sent to a cluster for configuration.

" + } + }, + "com.amazonaws.eks#ConnectorConfigResponse": { + "type": "structure", + "members": { + "activationId": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

A unique ID associated with the cluster for registration purposes.

" + } + }, + "activationCode": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

A unique code associated with the cluster for registration purposes.

" + } + }, + "activationExpiry": { + "target": "com.amazonaws.eks#Timestamp", + "traits": { + "smithy.api#documentation": "

The expiration time of the connected cluster. The cluster's YAML file must be applied\n through the native provider.

" + } + }, + "provider": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The cluster's cloud service provider.

" + } + }, + "roleArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role to communicate with services from the connected Kubernetes\n cluster.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The full description of your connected cluster.

" + } + }, + "com.amazonaws.eks#ControlPlanePlacementRequest": { + "type": "structure", + "members": { + "groupName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the placement group for the Kubernetes control plane instances. This setting\n can't be changed after cluster creation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The placement configuration for all the control plane instances of your local Amazon EKS cluster on an Amazon Web Services Outpost. For more information, see\n Capacity\n considerations in the Amazon EKS User Guide.

" + } + }, + "com.amazonaws.eks#ControlPlanePlacementResponse": { + "type": "structure", + "members": { + "groupName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the placement group for the Kubernetes control plane instances.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The placement configuration for all the control plane instances of your local Amazon EKS cluster on an Amazon Web Services Outpost. For more information, see\n Capacity considerations in the Amazon EKS User Guide.

" + } + }, + "com.amazonaws.eks#CreateAccessConfigRequest": { + "type": "structure", + "members": { + "bootstrapClusterCreatorAdminPermissions": { + "target": "com.amazonaws.eks#BoxedBoolean", + "traits": { + "smithy.api#documentation": "

Specifies whether or not the cluster creator IAM principal was set as a\n cluster admin access entry during cluster creation time. The default value is\n true.

" + } + }, + "authenticationMode": { + "target": "com.amazonaws.eks#AuthenticationMode", + "traits": { + "smithy.api#documentation": "

The desired authentication mode for the cluster. If you create a cluster by using the\n EKS API, Amazon Web Services SDKs, or CloudFormation, the default is CONFIG_MAP. If you create\n the cluster by using the Amazon Web Services Management Console, the default value is\n API_AND_CONFIG_MAP.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The access configuration information for the cluster.

" + } + }, + "com.amazonaws.eks#CreateAccessEntry": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#CreateAccessEntryRequest" + }, + "output": { + "target": "com.amazonaws.eks#CreateAccessEntryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceInUseException" + }, + { + "target": "com.amazonaws.eks#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an access entry.

\n

An access entry allows an IAM principal to access your cluster. Access\n entries can replace the need to maintain entries in the aws-auth\n ConfigMap for authentication. You have the following options for\n authorizing an IAM principal to access Kubernetes objects on your cluster: Kubernetes\n role-based access control (RBAC), Amazon EKS, or both. Kubernetes RBAC authorization\n requires you to create and manage Kubernetes Role, ClusterRole,\n RoleBinding, and ClusterRoleBinding objects, in addition\n to managing access entries. If you use Amazon EKS authorization exclusively, you\n don't need to create and manage Kubernetes Role, ClusterRole,\n RoleBinding, and ClusterRoleBinding objects.

\n

For more information about access entries, see Access entries in the\n Amazon EKS User Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/clusters/{clusterName}/access-entries", + "code": 200 + } + } + }, + "com.amazonaws.eks#CreateAccessEntryRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of your cluster.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "principalArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM principal for the AccessEntry. You can specify one ARN for each access entry. You can't specify the\n same ARN in more than one access entry. This value can't be changed after access entry\n creation.

\n

The valid principals differ depending on the type of the access entry in the\n type field. The only valid ARN is IAM roles for the types of access\n entries for nodes: \n . You can use every IAM principal type for STANDARD access entries.\n You can't use the STS session principal type with access entries because this is a\n temporary principal for each session and not a permanent identity that can be assigned\n permissions.

\n

\n IAM best practices recommend using IAM roles with\n temporary credentials, rather than IAM users with long-term credentials.\n

", + "smithy.api#required": {} + } + }, + "kubernetesGroups": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

The value for name that you've specified for kind: Group as\n a subject in a Kubernetes RoleBinding or\n ClusterRoleBinding object. Amazon EKS doesn't confirm that the\n value for name exists in any bindings on your cluster. You can specify one\n or more names.

\n

Kubernetes authorizes the principalArn of the access entry to access any\n cluster objects that you've specified in a Kubernetes Role or\n ClusterRole object that is also specified in a binding's\n roleRef. For more information about creating Kubernetes\n RoleBinding, ClusterRoleBinding, Role, or\n ClusterRole objects, see Using RBAC\n Authorization in the Kubernetes documentation.

\n

If you want Amazon EKS to authorize the principalArn (instead of,\n or in addition to Kubernetes authorizing the principalArn), you can associate\n one or more access policies to the access entry using\n AssociateAccessPolicy. If you associate any access policies, the\n principalARN has all permissions assigned in the associated access\n policies and all permissions in any Kubernetes Role or ClusterRole\n objects that the group names are bound to.

" + } + }, + "tags": { + "target": "com.amazonaws.eks#TagMap", + "traits": { + "smithy.api#documentation": "

Metadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.

" + } + }, + "clientRequestToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.

", + "smithy.api#idempotencyToken": {} + } + }, + "username": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The username to authenticate to Kubernetes with. We recommend not specifying a username and\n letting Amazon EKS specify it for you. For more information about the value\n Amazon EKS specifies for you, or constraints before specifying your own\n username, see Creating\n access entries in the Amazon EKS User Guide.

" + } + }, + "type": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The type of the new access entry. Valid values are Standard,\n FARGATE_LINUX, EC2_LINUX, and\n EC2_WINDOWS.

\n

If the principalArn is for an IAM role that's used for\n self-managed Amazon EC2 nodes, specify EC2_LINUX or\n EC2_WINDOWS. Amazon EKS grants the necessary permissions to the\n node for you. If the principalArn is for any other purpose, specify\n STANDARD. If you don't specify a value, Amazon EKS sets the\n value to STANDARD. It's unnecessary to create access entries for IAM roles used with Fargate profiles or managed Amazon EC2 nodes, because Amazon EKS creates entries in the\n aws-auth\n ConfigMap for the roles. You can't change this value once you've created\n the access entry.

\n

If you set the value to EC2_LINUX or EC2_WINDOWS, you can't\n specify values for kubernetesGroups, or associate an\n AccessPolicy to the access entry.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#CreateAccessEntryResponse": { + "type": "structure", + "members": { + "accessEntry": { + "target": "com.amazonaws.eks#AccessEntry" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#CreateAddon": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#CreateAddonRequest" + }, + "output": { + "target": "com.amazonaws.eks#CreateAddonResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceInUseException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an Amazon EKS add-on.

\n

Amazon EKS add-ons help to automate the provisioning and lifecycle management\n of common operational software for Amazon EKS clusters. For more information,\n see Amazon EKS add-ons in the Amazon EKS User Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/clusters/{clusterName}/addons", + "code": 200 + } + } + }, + "com.amazonaws.eks#CreateAddonRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#ClusterName", + "traits": { + "smithy.api#documentation": "

The name of your cluster.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "addonName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the add-on. The name must match one of the names returned by\n DescribeAddonVersions.

", + "smithy.api#required": {} + } + }, + "addonVersion": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The version of the add-on. The version must match one of the versions returned by \n DescribeAddonVersions\n .

" + } + }, + "serviceAccountRoleArn": { + "target": "com.amazonaws.eks#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account. The role must be assigned the IAM permissions required by the add-on. If you don't specify an existing IAM role, then the add-on uses the\n permissions assigned to the node IAM role. For more information, see Amazon EKS node IAM role in the Amazon EKS User Guide.

\n \n

To specify an existing IAM role, you must have an IAM OpenID Connect (OIDC) provider created for\n your cluster. For more information, see Enabling\n IAM roles for service accounts on your cluster in the\n Amazon EKS User Guide.

\n " + } + }, + "resolveConflicts": { + "target": "com.amazonaws.eks#ResolveConflicts", + "traits": { + "smithy.api#documentation": "

How to resolve field value conflicts for an Amazon EKS add-on. Conflicts are\n handled based on the value you choose:

\n \n

If you don't currently have the self-managed version of the add-on installed on your\n cluster, the Amazon EKS add-on is installed. Amazon EKS sets all values\n to default values, regardless of the option that you specify.

" + } + }, + "clientRequestToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.

", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.eks#TagMap", + "traits": { + "smithy.api#documentation": "

Metadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.

" + } + }, + "configurationValues": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The set of configuration values for the add-on that's created. The values that you\n provide are validated against the schema returned by\n DescribeAddonConfiguration.

" + } + }, + "podIdentityAssociations": { + "target": "com.amazonaws.eks#AddonPodIdentityAssociationsList", + "traits": { + "smithy.api#documentation": "

An array of Pod Identity Assocations to be created. Each EKS Pod Identity association maps a Kubernetes service account to an IAM Role.

\n

For more information, see Attach an IAM Role to an Amazon EKS add-on using Pod Identity in the EKS User Guide.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#CreateAddonResponse": { + "type": "structure", + "members": { + "addon": { + "target": "com.amazonaws.eks#Addon" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#CreateCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#CreateClusterRequest" + }, + "output": { + "target": "com.amazonaws.eks#CreateClusterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#ResourceInUseException" + }, + { + "target": "com.amazonaws.eks#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.eks#ServerException" + }, + { + "target": "com.amazonaws.eks#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.eks#UnsupportedAvailabilityZoneException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an Amazon EKS control plane.

\n

The Amazon EKS control plane consists of control plane instances that run the\n Kubernetes software, such as etcd and the API server. The control plane runs in\n an account managed by Amazon Web Services, and the Kubernetes API is exposed by the Amazon EKS API server endpoint. Each Amazon EKS cluster control plane is\n single tenant and unique. It runs on its own set of Amazon EC2 instances.

\n

The cluster control plane is provisioned across multiple Availability Zones and\n fronted by an Elastic Load Balancing\n Network Load Balancer. Amazon EKS also provisions elastic network interfaces in\n your VPC subnets to provide connectivity from the control plane instances to the nodes\n (for example, to support kubectl exec, logs, and\n proxy data flows).

\n

Amazon EKS nodes run in your Amazon Web Services account and connect to your\n cluster's control plane over the Kubernetes API server endpoint and a certificate file that\n is created for your cluster.

\n

You can use the endpointPublicAccess and\n endpointPrivateAccess parameters to enable or disable public and\n private access to your cluster's Kubernetes API server endpoint. By default, public access is\n enabled, and private access is disabled. For more information, see Amazon EKS Cluster Endpoint Access Control in the\n \n Amazon EKS User Guide\n .

\n

You can use the logging parameter to enable or disable exporting the\n Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster\n control plane logs aren't exported to CloudWatch Logs. For more information, see\n Amazon EKS Cluster Control Plane Logs in the\n \n Amazon EKS User Guide\n .

\n \n

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to\n exported control plane logs. For more information, see CloudWatch\n Pricing.

\n \n

In most cases, it takes several minutes to create a cluster. After you create an\n Amazon EKS cluster, you must configure your Kubernetes tooling to communicate\n with the API server and launch nodes into your cluster. For more information, see Allowing users to\n access your cluster and Launching\n Amazon EKS nodes in the Amazon EKS User Guide.

", + "smithy.api#examples": [ + { + "title": "To create a new cluster", + "documentation": "The following example creates an Amazon EKS cluster called prod.", + "input": { + "name": "prod", + "version": "1.10", + "roleArn": "arn:aws:iam::012345678910:role/eks-service-role-AWSServiceRoleForAmazonEKS-J7ONKE3BQ4PI", + "resourcesVpcConfig": { + "subnetIds": [ + "subnet-6782e71e", + "subnet-e7e761ac" + ], + "securityGroupIds": [ + "sg-6979fe18" + ] + }, + "clientRequestToken": "1d2129a1-3d38-460a-9756-e5b91fddb951" + }, + "output": {} + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/clusters", + "code": 200 + } + } + }, + "com.amazonaws.eks#CreateClusterRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.eks#ClusterName", + "traits": { + "smithy.api#documentation": "

The unique name to give to your cluster. The name can contain only alphanumeric characters (case-sensitive),\nhyphens, and underscores. It must start with an alphanumeric character and can't be longer than\n100 characters. The name must be unique within the Amazon Web Services Region and Amazon Web Services account that you're \ncreating the cluster in.

", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The desired Kubernetes version for your cluster. If you don't specify a value here, the\n default version available in Amazon EKS is used.

\n \n

The default version might not be the latest version available.

\n " + } + }, + "roleArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes\n control plane to make calls to Amazon Web Services API operations on your behalf. For\n more information, see Amazon EKS Service IAM Role in the \n Amazon EKS User Guide\n .

", + "smithy.api#required": {} + } + }, + "resourcesVpcConfig": { + "target": "com.amazonaws.eks#VpcConfigRequest", + "traits": { + "smithy.api#documentation": "

The VPC configuration that's used by the cluster control plane. Amazon EKS VPC\n resources have specific requirements to work properly with Kubernetes. For more information,\n see Cluster VPC\n Considerations and Cluster Security Group Considerations in the\n Amazon EKS User Guide. You must specify at least two subnets. You can specify up to five\n security groups. However, we recommend that you use a dedicated security group for your\n cluster control plane.

", + "smithy.api#required": {} + } + }, + "kubernetesNetworkConfig": { + "target": "com.amazonaws.eks#KubernetesNetworkConfigRequest", + "traits": { + "smithy.api#documentation": "

The Kubernetes network configuration for the cluster.

" + } + }, + "logging": { + "target": "com.amazonaws.eks#Logging", + "traits": { + "smithy.api#documentation": "

Enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster control plane logs in the\n \n Amazon EKS User Guide\n .

\n \n

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to\n exported control plane logs. For more information, see CloudWatch\n Pricing.

\n " + } + }, + "clientRequestToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.

", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.eks#TagMap", + "traits": { + "smithy.api#documentation": "

Metadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.

" + } + }, + "encryptionConfig": { + "target": "com.amazonaws.eks#EncryptionConfigList", + "traits": { + "smithy.api#documentation": "

The encryption configuration for the cluster.

" + } + }, + "outpostConfig": { + "target": "com.amazonaws.eks#OutpostConfigRequest", + "traits": { + "smithy.api#documentation": "

An object representing the configuration of your local Amazon EKS cluster on\n an Amazon Web Services Outpost. Before creating a local cluster on an Outpost, review\n Local clusters\n for Amazon EKS on Amazon Web Services Outposts in the\n Amazon EKS User Guide. This object isn't available for creating Amazon EKS clusters\n on the Amazon Web Services cloud.

" + } + }, + "accessConfig": { + "target": "com.amazonaws.eks#CreateAccessConfigRequest", + "traits": { + "smithy.api#documentation": "

The access configuration for the cluster.

" + } + }, + "bootstrapSelfManagedAddons": { + "target": "com.amazonaws.eks#BoxedBoolean", + "traits": { + "smithy.api#documentation": "

If you set this value to False when creating a cluster, the default networking add-ons will not be installed.

\n

The default networking addons include vpc-cni, coredns, and kube-proxy.

\n

Use this option when you plan to install third-party alternative add-ons or self-manage the default networking add-ons.

" + } + }, + "upgradePolicy": { + "target": "com.amazonaws.eks#UpgradePolicyRequest", + "traits": { + "smithy.api#documentation": "

New clusters, by default, have extended support enabled. You can disable extended support when creating a cluster by setting this value to STANDARD.

" + } + }, + "zonalShiftConfig": { + "target": "com.amazonaws.eks#ZonalShiftConfigRequest", + "traits": { + "smithy.api#documentation": "

Enable or disable ARC zonal shift for the cluster. If zonal shift is enabled, Amazon Web Services\n configures zonal autoshift for the cluster.

\n

Zonal shift is a feature of\n Amazon Application Recovery Controller (ARC). ARC zonal shift is designed to be a temporary measure that allows you to move\n traffic for a resource away from an impaired AZ until the zonal shift expires or you cancel\n it. You can extend the zonal shift if necessary.

\n

You can start a zonal shift for an EKS cluster, or you can allow Amazon Web Services to do it for you\n by enabling zonal autoshift. This shift updates the flow of\n east-to-west network traffic in your cluster to only consider network endpoints for Pods\n running on worker nodes in healthy AZs. Additionally, any ALB or NLB handling ingress\n traffic for applications in your EKS cluster will automatically route traffic to targets in\n the healthy AZs. For more information about zonal shift in EKS, see Learn about Amazon Application Recovery Controller (ARC)\n Zonal Shift in Amazon EKS in the\n \n Amazon EKS User Guide\n .

" + } + }, + "remoteNetworkConfig": { + "target": "com.amazonaws.eks#RemoteNetworkConfigRequest", + "traits": { + "smithy.api#documentation": "

The configuration in the cluster for EKS Hybrid Nodes. You can't change or update this\n configuration after the cluster is created.

" + } + }, + "computeConfig": { + "target": "com.amazonaws.eks#ComputeConfigRequest", + "traits": { + "smithy.api#documentation": "

Enable or disable the compute capability of EKS Auto Mode when creating your EKS Auto Mode cluster. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your Amazon Web Services account

" + } + }, + "storageConfig": { + "target": "com.amazonaws.eks#StorageConfigRequest", + "traits": { + "smithy.api#documentation": "

Enable or disable the block storage capability of EKS Auto Mode when creating your EKS Auto Mode cluster. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your Amazon Web Services account.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#CreateClusterResponse": { + "type": "structure", + "members": { + "cluster": { + "target": "com.amazonaws.eks#Cluster", + "traits": { + "smithy.api#documentation": "

The full description of your new cluster.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#CreateEksAnywhereSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#CreateEksAnywhereSubscriptionRequest" + }, + "output": { + "target": "com.amazonaws.eks#CreateEksAnywhereSubscriptionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.eks#ServerException" + }, + { + "target": "com.amazonaws.eks#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an EKS Anywhere subscription. When a subscription is created, it is a contract\n agreement for the length of the term specified in the request. Licenses that are used to\n validate support are provisioned in Amazon Web Services License Manager and the caller account is\n granted access to EKS Anywhere Curated Packages.

", + "smithy.api#http": { + "method": "POST", + "uri": "/eks-anywhere-subscriptions", + "code": 200 + } + } + }, + "com.amazonaws.eks#CreateEksAnywhereSubscriptionRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.eks#EksAnywhereSubscriptionName", + "traits": { + "smithy.api#documentation": "

The unique name for your subscription. It must be unique in your Amazon Web Services account in the\n Amazon Web Services Region you're creating the subscription in. The name can contain only alphanumeric\n characters (case-sensitive), hyphens, and underscores. It must start with an alphabetic\n character and can't be longer than 100 characters.

", + "smithy.api#required": {} + } + }, + "term": { + "target": "com.amazonaws.eks#EksAnywhereSubscriptionTerm", + "traits": { + "smithy.api#documentation": "

An object representing the term duration and term unit type of your subscription. This\n determines the term length of your subscription. Valid values are MONTHS for term unit\n and 12 or 36 for term duration, indicating a 12 month or 36 month subscription. This\n value cannot be changed after creating the subscription.

", + "smithy.api#required": {} + } + }, + "licenseQuantity": { + "target": "com.amazonaws.eks#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of licenses to purchase with the subscription. Valid values are between 1\n and 100. This value can't be changed after creating the subscription.

" + } + }, + "licenseType": { + "target": "com.amazonaws.eks#EksAnywhereSubscriptionLicenseType", + "traits": { + "smithy.api#documentation": "

The license type for all licenses in the subscription. Valid value is CLUSTER. With\n the CLUSTER license type, each license covers support for a single EKS Anywhere\n cluster.

" + } + }, + "autoRenew": { + "target": "com.amazonaws.eks#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A boolean indicating whether the subscription auto renews at the end of the\n term.

" + } + }, + "clientRequestToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.

", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.eks#TagMap", + "traits": { + "smithy.api#documentation": "

The metadata for a subscription to assist with categorization and organization. Each\n tag consists of a key and an optional value. Subscription tags don't propagate to any\n other resources associated with the subscription.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#CreateEksAnywhereSubscriptionResponse": { + "type": "structure", + "members": { + "subscription": { + "target": "com.amazonaws.eks#EksAnywhereSubscription", + "traits": { + "smithy.api#documentation": "

The full description of the subscription.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#CreateFargateProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#CreateFargateProfileRequest" + }, + "output": { + "target": "com.amazonaws.eks#CreateFargateProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.eks#ServerException" + }, + { + "target": "com.amazonaws.eks#UnsupportedAvailabilityZoneException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an Fargate profile for your Amazon EKS cluster. You\n must have at least one Fargate profile in a cluster to be able to run\n pods on Fargate.

\n

The Fargate profile allows an administrator to declare which pods run\n on Fargate and specify which pods run on which Fargate\n profile. This declaration is done through the profile’s selectors. Each profile can have\n up to five selectors that contain a namespace and labels. A namespace is required for\n every selector. The label field consists of multiple optional key-value pairs. Pods that\n match the selectors are scheduled on Fargate. If a to-be-scheduled pod\n matches any of the selectors in the Fargate profile, then that pod is run\n on Fargate.

\n

When you create a Fargate profile, you must specify a pod execution\n role to use with the pods that are scheduled with the profile. This role is added to the\n cluster's Kubernetes Role Based\n Access Control (RBAC) for authorization so that the kubelet\n that is running on the Fargate infrastructure can register with your\n Amazon EKS cluster so that it can appear in your cluster as a node. The pod\n execution role also provides IAM permissions to the Fargate infrastructure to allow read access to Amazon ECR image repositories. For\n more information, see Pod Execution Role in the Amazon EKS User Guide.

\n

Fargate profiles are immutable. However, you can create a new updated\n profile to replace an existing profile and then delete the original after the updated\n profile has finished creating.

\n

If any Fargate profiles in a cluster are in the DELETING\n status, you must wait for that Fargate profile to finish deleting before\n you can create any other profiles in that cluster.

\n

For more information, see Fargate profile in the\n Amazon EKS User Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/clusters/{clusterName}/fargate-profiles", + "code": 200 + } + } + }, + "com.amazonaws.eks#CreateFargateProfileRequest": { + "type": "structure", + "members": { + "fargateProfileName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the Fargate profile.

", + "smithy.api#required": {} + } + }, + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of your cluster.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "podExecutionRoleArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Pod execution role to use for a Pod\n that matches the selectors in the Fargate profile. The Pod\n execution role allows Fargate infrastructure to register with your\n cluster as a node, and it provides read access to Amazon ECR image repositories.\n For more information, see \n Pod execution\n role in the Amazon EKS User Guide.

", + "smithy.api#required": {} + } + }, + "subnets": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

The IDs of subnets to launch a Pod into. A Pod running on\n Fargate isn't assigned a public IP address, so only private subnets\n (with no direct route to an Internet Gateway) are accepted for this parameter.

" + } + }, + "selectors": { + "target": "com.amazonaws.eks#FargateProfileSelectors", + "traits": { + "smithy.api#documentation": "

The selectors to match for a Pod to use this Fargate\n profile. Each selector must have an associated Kubernetes namespace. Optionally,\n you can also specify labels for a namespace. You may specify\n up to five selectors in a Fargate profile.

" + } + }, + "clientRequestToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.

", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.eks#TagMap", + "traits": { + "smithy.api#documentation": "

Metadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#CreateFargateProfileResponse": { + "type": "structure", + "members": { + "fargateProfile": { + "target": "com.amazonaws.eks#FargateProfile", + "traits": { + "smithy.api#documentation": "

The full description of your new Fargate profile.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#CreateNodegroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#CreateNodegroupRequest" + }, + "output": { + "target": "com.amazonaws.eks#CreateNodegroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceInUseException" + }, + { + "target": "com.amazonaws.eks#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.eks#ServerException" + }, + { + "target": "com.amazonaws.eks#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a managed node group for an Amazon EKS cluster.

\n

You can only create a node group for your cluster that is equal to the current Kubernetes\n version for the cluster. All node groups are created with the latest AMI release version\n for the respective minor Kubernetes version of the cluster, unless you deploy a custom AMI\n using a launch template. For more information about using launch templates, see Customizing managed nodes with launch templates.

\n

An Amazon EKS managed node group is an Amazon EC2\n Auto Scaling group and associated Amazon EC2 instances that are managed by\n Amazon Web Services for an Amazon EKS cluster. For more information, see\n Managed node groups in the Amazon EKS User Guide.

\n \n

Windows AMI types are only supported for commercial Amazon Web Services Regions\n that support Windows on Amazon EKS.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/clusters/{clusterName}/node-groups", + "code": 200 + } + } + }, + "com.amazonaws.eks#CreateNodegroupRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of your cluster.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nodegroupName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The unique name to give your node group.

", + "smithy.api#required": {} + } + }, + "scalingConfig": { + "target": "com.amazonaws.eks#NodegroupScalingConfig", + "traits": { + "smithy.api#documentation": "

The scaling configuration details for the Auto Scaling group that is created for your\n node group.

" + } + }, + "diskSize": { + "target": "com.amazonaws.eks#BoxedInteger", + "traits": { + "smithy.api#documentation": "

The root device disk size (in GiB) for your node group instances. The default disk\n size is 20 GiB for Linux and Bottlerocket. The default disk size is 50 GiB for Windows.\n If you specify launchTemplate, then don't specify diskSize, or the node group \n deployment will fail. For more information about using launch templates with Amazon EKS, see Customizing managed nodes with launch templates in the Amazon EKS User Guide.

" + } + }, + "subnets": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

The subnets to use for the Auto Scaling group that is created for your node group.\n If you specify launchTemplate, then don't specify \n SubnetId\n in your launch template, or the node group deployment\n will fail. For more information about using launch templates with Amazon EKS, see Customizing managed nodes with launch templates in the Amazon EKS User Guide.

", + "smithy.api#required": {} + } + }, + "instanceTypes": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

Specify the instance types for a node group. If you specify a GPU instance type, make\n sure to also specify an applicable GPU AMI type with the amiType parameter.\n If you specify launchTemplate, then you can specify zero or one instance\n type in your launch template or you can specify 0-20 instance types\n for instanceTypes. If however, you specify an instance type in your launch\n template and specify any instanceTypes, the node group\n deployment will fail. If you don't specify an instance type in a launch template or for\n instanceTypes, then t3.medium is used, by default. If you\n specify Spot for capacityType, then we recommend specifying\n multiple values for instanceTypes. For more information, see Managed node group capacity types and Customizing managed nodes with launch templates in\n the Amazon EKS User Guide.

" + } + }, + "amiType": { + "target": "com.amazonaws.eks#AMITypes", + "traits": { + "smithy.api#documentation": "

The AMI type for your node group. If you specify launchTemplate, and your launch template uses a custom AMI,\n then don't specify amiType, or the node group deployment\n will fail. If your launch template uses a Windows custom AMI, then add\n eks:kube-proxy-windows to your Windows nodes rolearn in\n the aws-auth\n ConfigMap. For more information about using launch templates with Amazon EKS, see Customizing managed nodes with launch templates in the Amazon EKS User Guide.

" + } + }, + "remoteAccess": { + "target": "com.amazonaws.eks#RemoteAccessConfig", + "traits": { + "smithy.api#documentation": "

The remote access configuration to use with your node group. For Linux, the protocol\n is SSH. For Windows, the protocol is RDP. If you specify launchTemplate, then don't specify \n remoteAccess, or the node group deployment will fail.\n For more information about using launch templates with Amazon EKS, see Customizing managed nodes with launch templates in the Amazon EKS User Guide.

" + } + }, + "nodeRole": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to associate with your node group. The\n Amazon EKS worker node kubelet daemon makes calls to Amazon Web Services APIs on your behalf. Nodes receive permissions for these API calls\n through an IAM instance profile and associated policies. Before you can\n launch nodes and register them into a cluster, you must create an IAM\n role for those nodes to use when they are launched. For more information, see Amazon EKS node IAM role in the\n \n Amazon EKS User Guide\n . If you specify launchTemplate, then don't specify \n \n IamInstanceProfile\n in your launch template, or the node group \n deployment will fail. For more information about using launch templates with Amazon EKS, see Customizing managed nodes with launch templates in the Amazon EKS User Guide.

", + "smithy.api#required": {} + } + }, + "labels": { + "target": "com.amazonaws.eks#labelsMap", + "traits": { + "smithy.api#documentation": "

The Kubernetes labels to apply to the nodes in the node group when they are\n created.

" + } + }, + "taints": { + "target": "com.amazonaws.eks#taintsList", + "traits": { + "smithy.api#documentation": "

The Kubernetes taints to be applied to the nodes in the node group. For more information,\n see Node taints on\n managed node groups.

" + } + }, + "tags": { + "target": "com.amazonaws.eks#TagMap", + "traits": { + "smithy.api#documentation": "

Metadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.

" + } + }, + "clientRequestToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.

", + "smithy.api#idempotencyToken": {} + } + }, + "launchTemplate": { + "target": "com.amazonaws.eks#LaunchTemplateSpecification", + "traits": { + "smithy.api#documentation": "

An object representing a node group's launch template specification. When using this\n object, don't directly specify instanceTypes, diskSize, or\n remoteAccess. Make sure that\n the launch template meets the requirements in launchTemplateSpecification. Also refer to\n Customizing managed nodes with launch templates in\n the Amazon EKS User Guide.

" + } + }, + "updateConfig": { + "target": "com.amazonaws.eks#NodegroupUpdateConfig", + "traits": { + "smithy.api#documentation": "

The node group update configuration.

" + } + }, + "nodeRepairConfig": { + "target": "com.amazonaws.eks#NodeRepairConfig", + "traits": { + "smithy.api#documentation": "

The node auto repair configuration for the node group.

" + } + }, + "capacityType": { + "target": "com.amazonaws.eks#CapacityTypes", + "traits": { + "smithy.api#documentation": "

The capacity type for your node group.

" + } + }, + "version": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Kubernetes version to use for your managed nodes. By default, the Kubernetes version of the\n cluster is used, and this is the only accepted specified value. If you specify launchTemplate,\n and your launch template uses a custom AMI, then don't specify version, or the node group \n deployment will fail. For more information about using launch templates with Amazon EKS, see Customizing managed nodes with launch templates in the Amazon EKS User Guide.

" + } + }, + "releaseVersion": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The AMI version of the Amazon EKS optimized AMI to use with your node group.\n By default, the latest available AMI version for the node group's current Kubernetes version\n is used. For information about Linux versions, see Amazon EKS optimized Amazon Linux AMI versions in the Amazon EKS User Guide. Amazon EKS managed node groups support the November 2022 and later releases of the\n Windows AMIs. For information about Windows versions, see Amazon EKS optimized Windows AMI versions in the\n Amazon EKS User Guide.

\n

If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify \n releaseVersion, or the node group deployment will fail.\n For more information about using launch templates with Amazon EKS, see Customizing managed nodes with launch templates in the Amazon EKS User Guide.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#CreateNodegroupResponse": { + "type": "structure", + "members": { + "nodegroup": { + "target": "com.amazonaws.eks#Nodegroup", + "traits": { + "smithy.api#documentation": "

The full description of your new node group.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#CreatePodIdentityAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#CreatePodIdentityAssociationRequest" + }, + "output": { + "target": "com.amazonaws.eks#CreatePodIdentityAssociationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceInUseException" + }, + { + "target": "com.amazonaws.eks#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an EKS Pod Identity association between a service account in an Amazon EKS cluster and an IAM role\n with EKS Pod Identity. Use EKS Pod Identity to give temporary IAM credentials to\n pods and the credentials are rotated automatically.

\n

Amazon EKS Pod Identity associations provide the ability to manage credentials for your applications, similar to the way that Amazon EC2 instance profiles provide credentials to Amazon EC2 instances.

\n

If a pod uses a service account that has an association, Amazon EKS sets environment variables\n in the containers of the pod. The environment variables configure the Amazon Web Services SDKs,\n including the Command Line Interface, to use the EKS Pod Identity credentials.

\n

Pod Identity is a simpler method than IAM roles for service\n accounts, as this method doesn't use OIDC identity providers.\n Additionally, you can configure a role for Pod Identity once, and reuse it across\n clusters.

", + "smithy.api#http": { + "method": "POST", + "uri": "/clusters/{clusterName}/pod-identity-associations", + "code": 200 + } + } + }, + "com.amazonaws.eks#CreatePodIdentityAssociationRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the cluster to create the association in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "namespace": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the Kubernetes namespace inside the cluster to create the association in. The\n service account and the pods that use the service account must be in this\n namespace.

", + "smithy.api#required": {} + } + }, + "serviceAccount": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the Kubernetes service account inside the cluster to associate the IAM credentials with.

", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to associate with the service account. The EKS Pod Identity\n agent manages credentials to assume this role for applications in the containers in the\n pods that use this service account.

", + "smithy.api#required": {} + } + }, + "clientRequestToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.

", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.eks#TagMap", + "traits": { + "smithy.api#documentation": "

Metadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.

\n

The following basic restrictions apply to tags:

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#CreatePodIdentityAssociationResponse": { + "type": "structure", + "members": { + "association": { + "target": "com.amazonaws.eks#PodIdentityAssociation", + "traits": { + "smithy.api#documentation": "

The full description of your new association.

\n

The description includes an ID for the association. Use the ID of the association in further\n actions to manage the association.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#DeleteAccessEntry": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#DeleteAccessEntryRequest" + }, + "output": { + "target": "com.amazonaws.eks#DeleteAccessEntryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an access entry.

\n

Deleting an access entry of a type other than Standard can cause your\n cluster to function improperly. If you delete an access entry in error, you can recreate\n it.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/clusters/{clusterName}/access-entries/{principalArn}", + "code": 200 + } + } + }, + "com.amazonaws.eks#DeleteAccessEntryRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of your cluster.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "principalArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM principal for the AccessEntry.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#DeleteAccessEntryResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#DeleteAddon": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#DeleteAddonRequest" + }, + "output": { + "target": "com.amazonaws.eks#DeleteAddonResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an Amazon EKS add-on.

\n

When you remove an add-on, it's deleted from the cluster. You can always manually\n start an add-on on the cluster using the Kubernetes API.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/clusters/{clusterName}/addons/{addonName}", + "code": 200 + } + } + }, + "com.amazonaws.eks#DeleteAddonRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#ClusterName", + "traits": { + "smithy.api#documentation": "

The name of your cluster.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "addonName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the add-on. The name must match one of the names returned by \n ListAddons\n .

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "preserve": { + "target": "com.amazonaws.eks#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on. If an IAM\n account is associated with the add-on, it isn't removed.

", + "smithy.api#httpQuery": "preserve" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#DeleteAddonResponse": { + "type": "structure", + "members": { + "addon": { + "target": "com.amazonaws.eks#Addon" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#DeleteCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#DeleteClusterRequest" + }, + "output": { + "target": "com.amazonaws.eks#DeleteClusterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#ResourceInUseException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + }, + { + "target": "com.amazonaws.eks#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an Amazon EKS cluster control plane.

\n

If you have active services in your cluster that are associated with a load balancer,\n you must delete those services before deleting the cluster so that the load balancers\n are deleted properly. Otherwise, you can have orphaned resources in your VPC that\n prevent you from being able to delete the VPC. For more information, see Deleting a\n cluster in the Amazon EKS User Guide.

\n

If you have managed node groups or Fargate profiles attached to the\n cluster, you must delete them first. For more information, see\n DeleteNodgroup and DeleteFargateProfile.

", + "smithy.api#examples": [ + { + "title": "To delete a cluster", + "documentation": "This example command deletes a cluster named `devel` in your default region.", + "input": { + "name": "devel" + }, + "output": {} + } + ], + "smithy.api#http": { + "method": "DELETE", + "uri": "/clusters/{name}", + "code": 200 + } + } + }, + "com.amazonaws.eks#DeleteClusterRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the cluster to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#DeleteClusterResponse": { + "type": "structure", + "members": { + "cluster": { + "target": "com.amazonaws.eks#Cluster", + "traits": { + "smithy.api#documentation": "

The full description of the cluster to delete.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#DeleteEksAnywhereSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#DeleteEksAnywhereSubscriptionRequest" + }, + "output": { + "target": "com.amazonaws.eks#DeleteEksAnywhereSubscriptionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an expired or inactive subscription. Deleting inactive subscriptions removes\n them from the Amazon Web Services Management Console view and from list/describe API responses.\n Subscriptions can only be cancelled within 7 days of creation and are cancelled by\n creating a ticket in the Amazon Web Services Support Center.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/eks-anywhere-subscriptions/{id}", + "code": 200 + } + } + }, + "com.amazonaws.eks#DeleteEksAnywhereSubscriptionRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The ID of the subscription.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#DeleteEksAnywhereSubscriptionResponse": { + "type": "structure", + "members": { + "subscription": { + "target": "com.amazonaws.eks#EksAnywhereSubscription", + "traits": { + "smithy.api#documentation": "

The full description of the subscription to be deleted.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#DeleteFargateProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#DeleteFargateProfileRequest" + }, + "output": { + "target": "com.amazonaws.eks#DeleteFargateProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an Fargate profile.

\n

When you delete a Fargate profile, any Pod running on\n Fargate that was created with the profile is deleted. If the\n Pod matches another Fargate profile, then it is\n scheduled on Fargate with that profile. If it no longer matches any\n Fargate profiles, then it's not scheduled on Fargate\n and may remain in a pending state.

\n

Only one Fargate profile in a cluster can be in the\n DELETING status at a time. You must wait for a Fargate\n profile to finish deleting before you can delete any other profiles in that\n cluster.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/clusters/{clusterName}/fargate-profiles/{fargateProfileName}", + "code": 200 + } + } + }, + "com.amazonaws.eks#DeleteFargateProfileRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of your cluster.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "fargateProfileName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the Fargate profile to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#DeleteFargateProfileResponse": { + "type": "structure", + "members": { + "fargateProfile": { + "target": "com.amazonaws.eks#FargateProfile", + "traits": { + "smithy.api#documentation": "

The deleted Fargate profile.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#DeleteNodegroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#DeleteNodegroupRequest" + }, + "output": { + "target": "com.amazonaws.eks#DeleteNodegroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#ResourceInUseException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + }, + { + "target": "com.amazonaws.eks#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a managed node group.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/clusters/{clusterName}/node-groups/{nodegroupName}", + "code": 200 + } + } + }, + "com.amazonaws.eks#DeleteNodegroupRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of your cluster.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nodegroupName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the node group to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#DeleteNodegroupResponse": { + "type": "structure", + "members": { + "nodegroup": { + "target": "com.amazonaws.eks#Nodegroup", + "traits": { + "smithy.api#documentation": "

The full description of your deleted node group.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#DeletePodIdentityAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#DeletePodIdentityAssociationRequest" + }, + "output": { + "target": "com.amazonaws.eks#DeletePodIdentityAssociationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a EKS Pod Identity association.

\n

The temporary Amazon Web Services credentials from the previous IAM role session might still be valid until the session expiry. If you need to immediately revoke the temporary session credentials, then go to the role in the IAM console.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/clusters/{clusterName}/pod-identity-associations/{associationId}", + "code": 200 + } + } + }, + "com.amazonaws.eks#DeletePodIdentityAssociationRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The cluster name that

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "associationId": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The ID of the association to be deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#DeletePodIdentityAssociationResponse": { + "type": "structure", + "members": { + "association": { + "target": "com.amazonaws.eks#PodIdentityAssociation", + "traits": { + "smithy.api#documentation": "

The full description of the EKS Pod Identity association that was deleted.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#DeprecationDetail": { + "type": "structure", + "members": { + "usage": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The deprecated version of the resource.

" + } + }, + "replacedWith": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The newer version of the resource to migrate to if applicable.

" + } + }, + "stopServingVersion": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The version of the software where the deprecated resource version will stop being\n served.

" + } + }, + "startServingReplacementVersion": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The version of the software where the newer resource version became available to\n migrate to if applicable.

" + } + }, + "clientStats": { + "target": "com.amazonaws.eks#ClientStats", + "traits": { + "smithy.api#documentation": "

Details about Kubernetes clients using the deprecated resources.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The summary information about deprecated resource usage for an insight check in the\n UPGRADE_READINESS category.

" + } + }, + "com.amazonaws.eks#DeprecationDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#DeprecationDetail" + } + }, + "com.amazonaws.eks#DeregisterCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#DeregisterClusterRequest" + }, + "output": { + "target": "com.amazonaws.eks#DeregisterClusterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#AccessDeniedException" + }, + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#ResourceInUseException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + }, + { + "target": "com.amazonaws.eks#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Deregisters a connected cluster to remove it from the Amazon EKS control\n plane.

\n

A connected cluster is a Kubernetes cluster that you've connected to your control plane\n using the Amazon EKS Connector.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/cluster-registrations/{name}", + "code": 200 + } + } + }, + "com.amazonaws.eks#DeregisterClusterRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the connected cluster to deregister.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#DeregisterClusterResponse": { + "type": "structure", + "members": { + "cluster": { + "target": "com.amazonaws.eks#Cluster" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#DescribeAccessEntry": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#DescribeAccessEntryRequest" + }, + "output": { + "target": "com.amazonaws.eks#DescribeAccessEntryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes an access entry.

", + "smithy.api#http": { + "method": "GET", + "uri": "/clusters/{clusterName}/access-entries/{principalArn}", + "code": 200 + } + } + }, + "com.amazonaws.eks#DescribeAccessEntryRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of your cluster.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "principalArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM principal for the AccessEntry.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#DescribeAccessEntryResponse": { + "type": "structure", + "members": { + "accessEntry": { + "target": "com.amazonaws.eks#AccessEntry", + "traits": { + "smithy.api#documentation": "

Information about the access entry.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#DescribeAddon": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#DescribeAddonRequest" + }, + "output": { + "target": "com.amazonaws.eks#DescribeAddonResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes an Amazon EKS add-on.

", + "smithy.api#http": { + "method": "GET", + "uri": "/clusters/{clusterName}/addons/{addonName}", + "code": 200 + }, + "smithy.waiters#waitable": { + "AddonActive": { + "acceptors": [ + { + "state": "failure", + "matcher": { + "output": { + "path": "addon.status", + "expected": "CREATE_FAILED", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "addon.status", + "expected": "DEGRADED", + "comparator": "stringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "output": { + "path": "addon.status", + "expected": "ACTIVE", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 10 + }, + "AddonDeleted": { + "acceptors": [ + { + "state": "failure", + "matcher": { + "output": { + "path": "addon.status", + "expected": "DELETE_FAILED", + "comparator": "stringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "errorType": "ResourceNotFoundException" + } + } + ], + "minDelay": 10 + } + } + } + }, + "com.amazonaws.eks#DescribeAddonConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#DescribeAddonConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.eks#DescribeAddonConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns configuration options.

", + "smithy.api#http": { + "method": "GET", + "uri": "/addons/configuration-schemas", + "code": 200 + } + } + }, + "com.amazonaws.eks#DescribeAddonConfigurationRequest": { + "type": "structure", + "members": { + "addonName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the add-on. The name must match one of the names returned by\n DescribeAddonVersions.

", + "smithy.api#httpQuery": "addonName", + "smithy.api#required": {} + } + }, + "addonVersion": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The version of the add-on. The version must match one of the versions returned by \n DescribeAddonVersions\n .

", + "smithy.api#httpQuery": "addonVersion", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#DescribeAddonConfigurationResponse": { + "type": "structure", + "members": { + "addonName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the add-on.

" + } + }, + "addonVersion": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The version of the add-on. The version must match one of the versions returned by \n DescribeAddonVersions\n .

" + } + }, + "configurationSchema": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

A JSON schema that's used to validate the configuration values you provide when an\n add-on is created or updated.

" + } + }, + "podIdentityConfiguration": { + "target": "com.amazonaws.eks#AddonPodIdentityConfigurationList", + "traits": { + "smithy.api#documentation": "

The Kubernetes service account name used by the addon, and any suggested IAM policies. Use this information to create an IAM Role for the Addon.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#DescribeAddonRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#ClusterName", + "traits": { + "smithy.api#documentation": "

The name of your cluster.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "addonName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the add-on. The name must match one of the names returned by \n ListAddons\n .

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#DescribeAddonResponse": { + "type": "structure", + "members": { + "addon": { + "target": "com.amazonaws.eks#Addon" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#DescribeAddonVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#DescribeAddonVersionsRequest" + }, + "output": { + "target": "com.amazonaws.eks#DescribeAddonVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the versions for an add-on.

\n

Information such as the Kubernetes versions that you can use the add-on with, the\n owner, publisher, and the type of the add-on\n are returned.

", + "smithy.api#http": { + "method": "GET", + "uri": "/addons/supported-versions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "addons", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.eks#DescribeAddonVersionsRequest": { + "type": "structure", + "members": { + "kubernetesVersion": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Kubernetes versions that you can use the add-on with.

", + "smithy.api#httpQuery": "kubernetesVersion" + } + }, + "maxResults": { + "target": "com.amazonaws.eks#DescribeAddonVersionsRequestMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results, returned in paginated output. You receive\n maxResults in a single page, along with a nextToken\n response element. You can see the remaining results of the initial request by sending\n another request with the returned nextToken value. This value can be\n between 1 and 100. If you don't use this parameter,\n 100 results and a nextToken value, if applicable, are\n returned.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.

\n \n

This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.

\n ", + "smithy.api#httpQuery": "nextToken" + } + }, + "addonName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the add-on. The name must match one of the names returned by \n ListAddons\n .

", + "smithy.api#httpQuery": "addonName" + } + }, + "types": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

The type of the add-on. For valid types, don't specify a value for this\n property.

", + "smithy.api#httpQuery": "types" + } + }, + "publishers": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

The publisher of the add-on. For valid publishers, don't specify a value\n for this property.

", + "smithy.api#httpQuery": "publishers" + } + }, + "owners": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

The owner of the add-on. For valid owners, don't specify a value for this\n property.

", + "smithy.api#httpQuery": "owners" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#DescribeAddonVersionsRequestMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.eks#DescribeAddonVersionsResponse": { + "type": "structure", + "members": { + "addons": { + "target": "com.amazonaws.eks#Addons", + "traits": { + "smithy.api#documentation": "

The list of available versions with Kubernetes version compatibility and other\n properties.

" + } + }, + "nextToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The nextToken value to include in a future\n DescribeAddonVersions request. When the results of a\n DescribeAddonVersions request exceed maxResults, you can\n use this value to retrieve the next page of results. This value is null\n when there are no more results to return.

\n \n

This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.

\n " + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#DescribeCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#DescribeClusterRequest" + }, + "output": { + "target": "com.amazonaws.eks#DescribeClusterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + }, + { + "target": "com.amazonaws.eks#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes an Amazon EKS cluster.

\n

The API server endpoint and certificate authority data returned by this operation are\n required for kubelet and kubectl to communicate with your\n Kubernetes API server. For more information, see Creating or\n updating a kubeconfig file for an Amazon EKS\n cluster.

\n \n

The API server endpoint and certificate authority data aren't available until the\n cluster reaches the ACTIVE state.

\n ", + "smithy.api#examples": [ + { + "title": "To describe a cluster", + "documentation": "This example command provides a description of the specified cluster in your default region.", + "input": { + "name": "devel" + }, + "output": { + "cluster": { + "name": "devel", + "arn": "arn:aws:eks:us-west-2:012345678910:cluster/devel", + "createdAt": 1.527807879988E9, + "version": "1.10", + "endpoint": "https://A0DCCD80A04F01705DD065655C30CC3D.yl4.us-west-2.eks.amazonaws.com", + "roleArn": "arn:aws:iam::012345678910:role/eks-service-role-AWSServiceRoleForAmazonEKS-J7ONKE3BQ4PI", + "resourcesVpcConfig": { + "subnetIds": [ + "subnet-6782e71e", + "subnet-e7e761ac" + ], + "securityGroupIds": [ + "sg-6979fe18" + ], + "vpcId": "vpc-950809ec" + }, + "status": "ACTIVE", + "certificateAuthority": { + "data": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUN5RENDQWJDZ0F3SUJBZ0lCQURBTkJna3Foa2lHOXcwQkFRc0ZBREFWTVJNd0VRWURWUVFERXdwcmRXSmwKY201bGRHVnpNQjRYRFRFNE1EVXpNVEl6TVRFek1Wb1hEVEk0TURVeU9ESXpNVEV6TVZvd0ZURVRNQkVHQTFVRQpBeE1LYTNWaVpYSnVaWFJsY3pDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnRVBBRENDQVFvQ2dnRUJBTTZWCjVUaG4rdFcySm9Xa2hQMzRlVUZMNitaRXJOZGIvWVdrTmtDdWNGS2RaaXl2TjlMVmdvUmV2MjlFVFZlN1ZGbSsKUTJ3ZURyRXJiQyt0dVlibkFuN1ZLYmE3ay9hb1BHekZMdmVnb0t6b0M1N2NUdGVwZzRIazRlK2tIWHNaME10MApyb3NzcjhFM1ROeExETnNJTThGL1cwdjhsTGNCbWRPcjQyV2VuTjFHZXJnaDNSZ2wzR3JIazBnNTU0SjFWenJZCm9hTi8zODFUczlOTFF2QTBXb0xIcjBFRlZpTFdSZEoyZ3lXaC9ybDVyOFNDOHZaQXg1YW1BU0hVd01aTFpWRC8KTDBpOW4wRVM0MkpVdzQyQmxHOEdpd3NhTkJWV3lUTHZKclNhRXlDSHFtVVZaUTFDZkFXUjl0L3JleVVOVXM3TApWV1FqM3BFbk9RMitMSWJrc0RzQ0F3RUFBYU1qTUNFd0RnWURWUjBQQVFIL0JBUURBZ0trTUE4R0ExVWRFd0VCCi93UUZNQU1CQWY4d0RRWUpLb1pJaHZjTkFRRUxCUUFEZ2dFQkFNZ3RsQ1dIQ2U2YzVHMXl2YlFTS0Q4K2hUalkKSm1NSG56L2EvRGt0WG9YUjFVQzIrZUgzT1BZWmVjRVZZZHVaSlZCckNNQ2VWR0ZkeWdBYlNLc1FxWDg0S2RXbAp1MU5QaERDSmEyRHliN2pVMUV6VThTQjFGZUZ5ZFE3a0hNS1E1blpBRVFQOTY4S01hSGUrSm0yQ2x1UFJWbEJVCjF4WlhTS1gzTVZ0K1Q0SU1EV2d6c3JRSjVuQkRjdEtLcUZtM3pKdVVubHo5ZEpVckdscEltMjVJWXJDckxYUFgKWkUwRUtRNWEzMHhkVWNrTHRGQkQrOEtBdFdqSS9yZUZPNzM1YnBMdVoyOTBaNm42QlF3elRrS0p4cnhVc3QvOAppNGsxcnlsaUdWMm5SSjBUYjNORkczNHgrYWdzYTRoSTFPbU90TFM0TmgvRXJxT3lIUXNDc2hEQUtKUT0KLS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQo=" + } + } + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/clusters/{name}", + "code": 200 + }, + "smithy.waiters#waitable": { + "ClusterActive": { + "acceptors": [ + { + "state": "failure", + "matcher": { + "output": { + "path": "cluster.status", + "expected": "DELETING", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "cluster.status", + "expected": "FAILED", + "comparator": "stringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "output": { + "path": "cluster.status", + "expected": "ACTIVE", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 30 + }, + "ClusterDeleted": { + "acceptors": [ + { + "state": "failure", + "matcher": { + "output": { + "path": "cluster.status", + "expected": "ACTIVE", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "cluster.status", + "expected": "CREATING", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "cluster.status", + "expected": "PENDING", + "comparator": "stringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "errorType": "ResourceNotFoundException" + } + } + ], + "minDelay": 30 + } + } + } + }, + "com.amazonaws.eks#DescribeClusterRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of your cluster.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#DescribeClusterResponse": { + "type": "structure", + "members": { + "cluster": { + "target": "com.amazonaws.eks#Cluster", + "traits": { + "smithy.api#documentation": "

The full description of your specified cluster.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#DescribeClusterVersionMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.eks#DescribeClusterVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#DescribeClusterVersionsRequest" + }, + "output": { + "target": "com.amazonaws.eks#DescribeClusterVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists available Kubernetes versions for Amazon EKS clusters.

", + "smithy.api#http": { + "method": "GET", + "uri": "/cluster-versions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "clusterVersions", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.eks#DescribeClusterVersionsRequest": { + "type": "structure", + "members": { + "clusterType": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The type of cluster to filter versions by.

", + "smithy.api#httpQuery": "clusterType" + } + }, + "maxResults": { + "target": "com.amazonaws.eks#DescribeClusterVersionMaxResults", + "traits": { + "smithy.api#documentation": "

Maximum number of results to return.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

Pagination token for the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "defaultOnly": { + "target": "com.amazonaws.eks#BoxedBoolean", + "traits": { + "smithy.api#documentation": "

Filter to show only default versions.

", + "smithy.api#httpQuery": "defaultOnly" + } + }, + "includeAll": { + "target": "com.amazonaws.eks#BoxedBoolean", + "traits": { + "smithy.api#documentation": "

Include all available versions in the response.

", + "smithy.api#httpQuery": "includeAll" + } + }, + "clusterVersions": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

List of specific cluster versions to describe.

", + "smithy.api#httpQuery": "clusterVersions" + } + }, + "status": { + "target": "com.amazonaws.eks#ClusterVersionStatus", + "traits": { + "smithy.api#documentation": "

Filter versions by their current status.

", + "smithy.api#httpQuery": "status" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#DescribeClusterVersionsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

Pagination token for the next set of results.

" + } + }, + "clusterVersions": { + "target": "com.amazonaws.eks#ClusterVersionList", + "traits": { + "smithy.api#documentation": "

List of cluster version information objects.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#DescribeEksAnywhereSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#DescribeEksAnywhereSubscriptionRequest" + }, + "output": { + "target": "com.amazonaws.eks#DescribeEksAnywhereSubscriptionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + }, + { + "target": "com.amazonaws.eks#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns descriptive information about a subscription.

", + "smithy.api#http": { + "method": "GET", + "uri": "/eks-anywhere-subscriptions/{id}", + "code": 200 + } + } + }, + "com.amazonaws.eks#DescribeEksAnywhereSubscriptionRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The ID of the subscription.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#DescribeEksAnywhereSubscriptionResponse": { + "type": "structure", + "members": { + "subscription": { + "target": "com.amazonaws.eks#EksAnywhereSubscription", + "traits": { + "smithy.api#documentation": "

The full description of the subscription.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#DescribeFargateProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#DescribeFargateProfileRequest" + }, + "output": { + "target": "com.amazonaws.eks#DescribeFargateProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes an Fargate profile.

", + "smithy.api#http": { + "method": "GET", + "uri": "/clusters/{clusterName}/fargate-profiles/{fargateProfileName}", + "code": 200 + }, + "smithy.waiters#waitable": { + "FargateProfileActive": { + "acceptors": [ + { + "state": "failure", + "matcher": { + "output": { + "path": "fargateProfile.status", + "expected": "CREATE_FAILED", + "comparator": "stringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "output": { + "path": "fargateProfile.status", + "expected": "ACTIVE", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 10 + }, + "FargateProfileDeleted": { + "acceptors": [ + { + "state": "failure", + "matcher": { + "output": { + "path": "fargateProfile.status", + "expected": "DELETE_FAILED", + "comparator": "stringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "errorType": "ResourceNotFoundException" + } + } + ], + "minDelay": 30 + } + } + } + }, + "com.amazonaws.eks#DescribeFargateProfileRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of your cluster.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "fargateProfileName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the Fargate profile to describe.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#DescribeFargateProfileResponse": { + "type": "structure", + "members": { + "fargateProfile": { + "target": "com.amazonaws.eks#FargateProfile", + "traits": { + "smithy.api#documentation": "

The full description of your Fargate profile.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#DescribeIdentityProviderConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#DescribeIdentityProviderConfigRequest" + }, + "output": { + "target": "com.amazonaws.eks#DescribeIdentityProviderConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + }, + { + "target": "com.amazonaws.eks#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes an identity provider configuration.

", + "smithy.api#http": { + "method": "POST", + "uri": "/clusters/{clusterName}/identity-provider-configs/describe", + "code": 200 + } + } + }, + "com.amazonaws.eks#DescribeIdentityProviderConfigRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of your cluster.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identityProviderConfig": { + "target": "com.amazonaws.eks#IdentityProviderConfig", + "traits": { + "smithy.api#documentation": "

An object representing an identity provider configuration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#DescribeIdentityProviderConfigResponse": { + "type": "structure", + "members": { + "identityProviderConfig": { + "target": "com.amazonaws.eks#IdentityProviderConfigResponse", + "traits": { + "smithy.api#documentation": "

The object that represents an OpenID Connect (OIDC) identity provider\n configuration.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#DescribeInsight": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#DescribeInsightRequest" + }, + "output": { + "target": "com.amazonaws.eks#DescribeInsightResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns details about an insight that you specify using its ID.

", + "smithy.api#http": { + "method": "GET", + "uri": "/clusters/{clusterName}/insights/{id}", + "code": 200 + } + } + }, + "com.amazonaws.eks#DescribeInsightRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the cluster to describe the insight for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The identity of the insight to describe.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#DescribeInsightResponse": { + "type": "structure", + "members": { + "insight": { + "target": "com.amazonaws.eks#Insight", + "traits": { + "smithy.api#documentation": "

The full description of the insight.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#DescribeNodegroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#DescribeNodegroupRequest" + }, + "output": { + "target": "com.amazonaws.eks#DescribeNodegroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + }, + { + "target": "com.amazonaws.eks#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes a managed node group.

", + "smithy.api#http": { + "method": "GET", + "uri": "/clusters/{clusterName}/node-groups/{nodegroupName}", + "code": 200 + }, + "smithy.waiters#waitable": { + "NodegroupActive": { + "acceptors": [ + { + "state": "failure", + "matcher": { + "output": { + "path": "nodegroup.status", + "expected": "CREATE_FAILED", + "comparator": "stringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "output": { + "path": "nodegroup.status", + "expected": "ACTIVE", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 30 + }, + "NodegroupDeleted": { + "acceptors": [ + { + "state": "failure", + "matcher": { + "output": { + "path": "nodegroup.status", + "expected": "DELETE_FAILED", + "comparator": "stringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "errorType": "ResourceNotFoundException" + } + } + ], + "minDelay": 30 + } + } + } + }, + "com.amazonaws.eks#DescribeNodegroupRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of your cluster.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nodegroupName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the node group to describe.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#DescribeNodegroupResponse": { + "type": "structure", + "members": { + "nodegroup": { + "target": "com.amazonaws.eks#Nodegroup", + "traits": { + "smithy.api#documentation": "

The full description of your node group.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#DescribePodIdentityAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#DescribePodIdentityAssociationRequest" + }, + "output": { + "target": "com.amazonaws.eks#DescribePodIdentityAssociationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns descriptive information about an EKS Pod Identity association.

\n

This action requires the ID of the association. You can get the ID from the response to\n the CreatePodIdentityAssocation for newly created associations. Or, you can\n list the IDs for associations with ListPodIdentityAssociations and filter the\n list by namespace or service account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/clusters/{clusterName}/pod-identity-associations/{associationId}", + "code": 200 + } + } + }, + "com.amazonaws.eks#DescribePodIdentityAssociationRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the cluster that the association is in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "associationId": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The ID of the association that you want the description of.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#DescribePodIdentityAssociationResponse": { + "type": "structure", + "members": { + "association": { + "target": "com.amazonaws.eks#PodIdentityAssociation", + "traits": { + "smithy.api#documentation": "

The full description of the EKS Pod Identity association.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#DescribeUpdate": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#DescribeUpdateRequest" + }, + "output": { + "target": "com.amazonaws.eks#DescribeUpdateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes an update to an Amazon EKS resource.

\n

When the status of the update is Succeeded, the update is complete. If an\n update fails, the status is Failed, and an error detail explains the reason\n for the failure.

", + "smithy.api#http": { + "method": "GET", + "uri": "/clusters/{name}/updates/{updateId}", + "code": 200 + } + } + }, + "com.amazonaws.eks#DescribeUpdateRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon EKS cluster associated with the update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "updateId": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The ID of the update to describe.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nodegroupName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon EKS node group associated with the update. This\n parameter is required if the update is a node group update.

", + "smithy.api#httpQuery": "nodegroupName" + } + }, + "addonName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the add-on. The name must match one of the names returned by \n ListAddons\n . This parameter is required if the update is an add-on update.

", + "smithy.api#httpQuery": "addonName" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an update request.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#DescribeUpdateResponse": { + "type": "structure", + "members": { + "update": { + "target": "com.amazonaws.eks#Update", + "traits": { + "smithy.api#documentation": "

The full description of the specified update.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#DisassociateAccessPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#DisassociateAccessPolicyRequest" + }, + "output": { + "target": "com.amazonaws.eks#DisassociateAccessPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Disassociates an access policy from an access entry.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/clusters/{clusterName}/access-entries/{principalArn}/access-policies/{policyArn}", + "code": 200 + } + } + }, + "com.amazonaws.eks#DisassociateAccessPolicyRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of your cluster.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "principalArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM principal for the AccessEntry.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "policyArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The ARN of the policy to disassociate from the access entry. For a list of\n associated policies ARNs, use ListAssociatedAccessPolicies.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#DisassociateAccessPolicyResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#DisassociateIdentityProviderConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#DisassociateIdentityProviderConfigRequest" + }, + "output": { + "target": "com.amazonaws.eks#DisassociateIdentityProviderConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceInUseException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Disassociates an identity provider configuration from a cluster.

\n

If you disassociate an identity provider from your cluster, users included in the\n provider can no longer access the cluster. However, you can still access the cluster\n with IAM principals.

", + "smithy.api#http": { + "method": "POST", + "uri": "/clusters/{clusterName}/identity-provider-configs/disassociate", + "code": 200 + } + } + }, + "com.amazonaws.eks#DisassociateIdentityProviderConfigRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of your cluster.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identityProviderConfig": { + "target": "com.amazonaws.eks#IdentityProviderConfig", + "traits": { + "smithy.api#documentation": "

An object representing an identity provider configuration.

", + "smithy.api#required": {} + } + }, + "clientRequestToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#DisassociateIdentityProviderConfigResponse": { + "type": "structure", + "members": { + "update": { + "target": "com.amazonaws.eks#Update" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#EksAnywhereSubscription": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

UUID identifying a subscription.

" + } + }, + "arn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the subscription.

" + } + }, + "createdAt": { + "target": "com.amazonaws.eks#Timestamp", + "traits": { + "smithy.api#documentation": "

The Unix timestamp in seconds for when the subscription was created.

" + } + }, + "effectiveDate": { + "target": "com.amazonaws.eks#Timestamp", + "traits": { + "smithy.api#documentation": "

The Unix timestamp in seconds for when the subscription is effective.

" + } + }, + "expirationDate": { + "target": "com.amazonaws.eks#Timestamp", + "traits": { + "smithy.api#documentation": "

The Unix timestamp in seconds for when the subscription will expire or auto renew,\n depending on the auto renew configuration of the subscription object.

" + } + }, + "licenseQuantity": { + "target": "com.amazonaws.eks#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of licenses included in a subscription. Valid values are between 1 and\n 100.

" + } + }, + "licenseType": { + "target": "com.amazonaws.eks#EksAnywhereSubscriptionLicenseType", + "traits": { + "smithy.api#documentation": "

The type of licenses included in the subscription. Valid value is CLUSTER. With the\n CLUSTER license type, each license covers support for a single EKS Anywhere\n cluster.

" + } + }, + "term": { + "target": "com.amazonaws.eks#EksAnywhereSubscriptionTerm", + "traits": { + "smithy.api#documentation": "

An EksAnywhereSubscriptionTerm object.

" + } + }, + "status": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The status of a subscription.

" + } + }, + "autoRenew": { + "target": "com.amazonaws.eks#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A boolean indicating whether or not a subscription will auto renew when it\n expires.

" + } + }, + "licenseArns": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

Amazon Web Services License Manager ARN associated with the subscription.

" + } + }, + "tags": { + "target": "com.amazonaws.eks#TagMap", + "traits": { + "smithy.api#documentation": "

The metadata for a subscription to assist with categorization and organization. Each\n tag consists of a key and an optional value. Subscription tags do not propagate to any\n other resources associated with the subscription.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An EKS Anywhere subscription authorizing the customer to support for licensed clusters\n and access to EKS Anywhere Curated Packages.

" + } + }, + "com.amazonaws.eks#EksAnywhereSubscriptionLicenseType": { + "type": "enum", + "members": { + "Cluster": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Cluster" + } + } + } + }, + "com.amazonaws.eks#EksAnywhereSubscriptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#EksAnywhereSubscription" + } + }, + "com.amazonaws.eks#EksAnywhereSubscriptionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[0-9A-Za-z][A-Za-z0-9\\-_]*$" + } + }, + "com.amazonaws.eks#EksAnywhereSubscriptionStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "EXPIRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPIRING" + } + }, + "EXPIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPIRED" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + } + } + }, + "com.amazonaws.eks#EksAnywhereSubscriptionStatusValues": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#EksAnywhereSubscriptionStatus" + } + }, + "com.amazonaws.eks#EksAnywhereSubscriptionTerm": { + "type": "structure", + "members": { + "duration": { + "target": "com.amazonaws.eks#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The duration of the subscription term. Valid values are 12 and 36, indicating a 12\n month or 36 month subscription.

" + } + }, + "unit": { + "target": "com.amazonaws.eks#EksAnywhereSubscriptionTermUnit", + "traits": { + "smithy.api#documentation": "

The term unit of the subscription. Valid value is MONTHS.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object representing the term duration and term unit type of your subscription. This\n determines the term length of your subscription. Valid values are MONTHS for term unit\n and 12 or 36 for term duration, indicating a 12 month or 36 month subscription.

" + } + }, + "com.amazonaws.eks#EksAnywhereSubscriptionTermUnit": { + "type": "enum", + "members": { + "MONTHS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MONTHS" + } + } + } + }, + "com.amazonaws.eks#ElasticLoadBalancing": { + "type": "structure", + "members": { + "enabled": { + "target": "com.amazonaws.eks#BoxedBoolean", + "traits": { + "smithy.api#documentation": "

Indicates if the load balancing capability is enabled on your EKS Auto Mode cluster. If the load balancing capability is enabled, EKS Auto Mode will create and delete load balancers in your Amazon Web Services account.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Indicates the current configuration of the load balancing capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. For more information, see EKS Auto Mode load balancing capability in the EKS User Guide.

" + } + }, + "com.amazonaws.eks#EncryptionConfig": { + "type": "structure", + "members": { + "resources": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

Specifies the resources to be encrypted. The only supported value is\n secrets.

" + } + }, + "provider": { + "target": "com.amazonaws.eks#Provider", + "traits": { + "smithy.api#documentation": "

Key Management Service (KMS) key. Either the ARN or the alias can be\n used.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The encryption configuration for the cluster.

" + } + }, + "com.amazonaws.eks#EncryptionConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#EncryptionConfig" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.eks#ErrorCode": { + "type": "enum", + "members": { + "SUBNET_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SubnetNotFound" + } + }, + "SECURITY_GROUP_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SecurityGroupNotFound" + } + }, + "ENI_LIMIT_REACHED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EniLimitReached" + } + }, + "IP_NOT_AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IpNotAvailable" + } + }, + "ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AccessDenied" + } + }, + "OPERATION_NOT_PERMITTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OperationNotPermitted" + } + }, + "VPC_ID_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VpcIdNotFound" + } + }, + "UNKNOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Unknown" + } + }, + "NODE_CREATION_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NodeCreationFailure" + } + }, + "POD_EVICTION_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PodEvictionFailure" + } + }, + "INSUFFICIENT_FREE_ADDRESSES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InsufficientFreeAddresses" + } + }, + "CLUSTER_UNREACHABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ClusterUnreachable" + } + }, + "INSUFFICIENT_NUMBER_OF_REPLICAS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InsufficientNumberOfReplicas" + } + }, + "CONFIGURATION_CONFLICT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ConfigurationConflict" + } + }, + "ADMISSION_REQUEST_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AdmissionRequestDenied" + } + }, + "UNSUPPORTED_ADDON_MODIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UnsupportedAddonModification" + } + }, + "K8S_RESOURCE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "K8sResourceNotFound" + } + } + } + }, + "com.amazonaws.eks#ErrorDetail": { + "type": "structure", + "members": { + "errorCode": { + "target": "com.amazonaws.eks#ErrorCode", + "traits": { + "smithy.api#documentation": "

A brief description of the error.

\n " + } + }, + "errorMessage": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

A more complete description of the error.

" + } + }, + "resourceIds": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

An optional field that contains the resource IDs associated with the error.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object representing an error when an asynchronous operation fails.

" + } + }, + "com.amazonaws.eks#ErrorDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#ErrorDetail" + } + }, + "com.amazonaws.eks#FargateProfile": { + "type": "structure", + "members": { + "fargateProfileName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the Fargate profile.

" + } + }, + "fargateProfileArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The full Amazon Resource Name (ARN) of the Fargate profile.

" + } + }, + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of your cluster.

" + } + }, + "createdAt": { + "target": "com.amazonaws.eks#Timestamp", + "traits": { + "smithy.api#documentation": "

The Unix epoch timestamp at object creation.

" + } + }, + "podExecutionRoleArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Pod execution role to use for any Pod\n that matches the selectors in the Fargate profile. For more information,\n see \n Pod execution role in the Amazon EKS User Guide.

" + } + }, + "subnets": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

The IDs of subnets to launch a Pod into.

" + } + }, + "selectors": { + "target": "com.amazonaws.eks#FargateProfileSelectors", + "traits": { + "smithy.api#documentation": "

The selectors to match for a Pod to use this Fargate\n profile.

" + } + }, + "status": { + "target": "com.amazonaws.eks#FargateProfileStatus", + "traits": { + "smithy.api#documentation": "

The current status of the Fargate profile.

" + } + }, + "tags": { + "target": "com.amazonaws.eks#TagMap", + "traits": { + "smithy.api#documentation": "

Metadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.

" + } + }, + "health": { + "target": "com.amazonaws.eks#FargateProfileHealth", + "traits": { + "smithy.api#documentation": "

The health status of the Fargate profile. If there are issues with\n your Fargate profile's health, they are listed here.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object representing an Fargate profile.

" + } + }, + "com.amazonaws.eks#FargateProfileHealth": { + "type": "structure", + "members": { + "issues": { + "target": "com.amazonaws.eks#FargateProfileIssueList", + "traits": { + "smithy.api#documentation": "

Any issues that are associated with the Fargate profile.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The health status of the Fargate profile. If there are issues with\n your Fargate profile's health, they are listed here.

" + } + }, + "com.amazonaws.eks#FargateProfileIssue": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.eks#FargateProfileIssueCode", + "traits": { + "smithy.api#documentation": "

A brief description of the error.

" + } + }, + "message": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The error message associated with the issue.

" + } + }, + "resourceIds": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services resources that are affected by this issue.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An issue that is associated with the Fargate profile.

" + } + }, + "com.amazonaws.eks#FargateProfileIssueCode": { + "type": "enum", + "members": { + "POD_EXECUTION_ROLE_ALREADY_IN_USE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PodExecutionRoleAlreadyInUse" + } + }, + "ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AccessDenied" + } + }, + "CLUSTER_UNREACHABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ClusterUnreachable" + } + }, + "INTERNAL_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InternalFailure" + } + } + } + }, + "com.amazonaws.eks#FargateProfileIssueList": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#FargateProfileIssue" + } + }, + "com.amazonaws.eks#FargateProfileLabel": { + "type": "map", + "key": { + "target": "com.amazonaws.eks#String" + }, + "value": { + "target": "com.amazonaws.eks#String" + } + }, + "com.amazonaws.eks#FargateProfileSelector": { + "type": "structure", + "members": { + "namespace": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Kubernetes namespace that the selector should match.

" + } + }, + "labels": { + "target": "com.amazonaws.eks#FargateProfileLabel", + "traits": { + "smithy.api#documentation": "

The Kubernetes labels that the selector should match. A pod must contain all of the labels\n that are specified in the selector for it to be considered a match.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object representing an Fargate profile selector.

" + } + }, + "com.amazonaws.eks#FargateProfileSelectors": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#FargateProfileSelector" + } + }, + "com.amazonaws.eks#FargateProfileStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + } + } + }, + "com.amazonaws.eks#FargateProfilesRequestMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.eks#Identity": { + "type": "structure", + "members": { + "oidc": { + "target": "com.amazonaws.eks#OIDC", + "traits": { + "smithy.api#documentation": "

An object representing the OpenID Connect\n identity provider information.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object representing an identity provider.

" + } + }, + "com.amazonaws.eks#IdentityProviderConfig": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The type of the identity provider configuration. The only type available is\n oidc.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the identity provider configuration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An object representing an identity provider configuration.

" + } + }, + "com.amazonaws.eks#IdentityProviderConfigResponse": { + "type": "structure", + "members": { + "oidc": { + "target": "com.amazonaws.eks#OidcIdentityProviderConfig", + "traits": { + "smithy.api#documentation": "

An object representing an OpenID Connect (OIDC) identity provider configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The full description of your identity configuration.

" + } + }, + "com.amazonaws.eks#IdentityProviderConfigs": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#IdentityProviderConfig" + } + }, + "com.amazonaws.eks#IncludeClustersList": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#String" + } + }, + "com.amazonaws.eks#Insight": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The ID of the insight.

" + } + }, + "name": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the insight.

" + } + }, + "category": { + "target": "com.amazonaws.eks#Category", + "traits": { + "smithy.api#documentation": "

The category of the insight.

" + } + }, + "kubernetesVersion": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Kubernetes minor version associated with an insight if applicable.

" + } + }, + "lastRefreshTime": { + "target": "com.amazonaws.eks#Timestamp", + "traits": { + "smithy.api#documentation": "

The time Amazon EKS last successfully completed a refresh of this insight check on the\n cluster.

" + } + }, + "lastTransitionTime": { + "target": "com.amazonaws.eks#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the status of the insight last changed.

" + } + }, + "description": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The description of the insight which includes alert criteria, remediation\n recommendation, and additional resources (contains Markdown).

" + } + }, + "insightStatus": { + "target": "com.amazonaws.eks#InsightStatus", + "traits": { + "smithy.api#documentation": "

An object containing more detail on the status of the insight resource.

" + } + }, + "recommendation": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

A summary of how to remediate the finding of this insight if applicable.

" + } + }, + "additionalInfo": { + "target": "com.amazonaws.eks#AdditionalInfoMap", + "traits": { + "smithy.api#documentation": "

Links to sources that provide additional context on the insight.

" + } + }, + "resources": { + "target": "com.amazonaws.eks#InsightResourceDetails", + "traits": { + "smithy.api#documentation": "

The details about each resource listed in the insight check result.

" + } + }, + "categorySpecificSummary": { + "target": "com.amazonaws.eks#InsightCategorySpecificSummary", + "traits": { + "smithy.api#documentation": "

Summary information that relates to the category of the insight. Currently only\n returned with certain insights having category UPGRADE_READINESS.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A check that provides recommendations to remedy potential upgrade-impacting\n issues.

" + } + }, + "com.amazonaws.eks#InsightCategorySpecificSummary": { + "type": "structure", + "members": { + "deprecationDetails": { + "target": "com.amazonaws.eks#DeprecationDetails", + "traits": { + "smithy.api#documentation": "

The summary information about deprecated resource usage for an insight check in the\n UPGRADE_READINESS category.

" + } + }, + "addonCompatibilityDetails": { + "target": "com.amazonaws.eks#AddonCompatibilityDetails", + "traits": { + "smithy.api#documentation": "

A list of AddonCompatibilityDetail objects for Amazon EKS add-ons.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Summary information that relates to the category of the insight. Currently only\n returned with certain insights having category UPGRADE_READINESS.

" + } + }, + "com.amazonaws.eks#InsightResourceDetail": { + "type": "structure", + "members": { + "insightStatus": { + "target": "com.amazonaws.eks#InsightStatus", + "traits": { + "smithy.api#documentation": "

An object containing more detail on the status of the insight resource.

" + } + }, + "kubernetesResourceUri": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Kubernetes resource URI if applicable.

" + } + }, + "arn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) if applicable.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Returns information about the resource being evaluated.

" + } + }, + "com.amazonaws.eks#InsightResourceDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#InsightResourceDetail" + } + }, + "com.amazonaws.eks#InsightStatus": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.eks#InsightStatusValue", + "traits": { + "smithy.api#documentation": "

The status of the resource.

" + } + }, + "reason": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

Explanation on the reasoning for the status of the resource.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The status of the insight.

" + } + }, + "com.amazonaws.eks#InsightStatusValue": { + "type": "enum", + "members": { + "PASSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PASSING" + } + }, + "WARNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WARNING" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + }, + "UNKNOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNKNOWN" + } + } + } + }, + "com.amazonaws.eks#InsightStatusValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#InsightStatusValue" + } + }, + "com.amazonaws.eks#InsightSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#InsightSummary" + } + }, + "com.amazonaws.eks#InsightSummary": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The ID of the insight.

" + } + }, + "name": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the insight.

" + } + }, + "category": { + "target": "com.amazonaws.eks#Category", + "traits": { + "smithy.api#documentation": "

The category of the insight.

" + } + }, + "kubernetesVersion": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Kubernetes minor version associated with an insight if applicable.

" + } + }, + "lastRefreshTime": { + "target": "com.amazonaws.eks#Timestamp", + "traits": { + "smithy.api#documentation": "

The time Amazon EKS last successfully completed a refresh of this insight check on the\n cluster.

" + } + }, + "lastTransitionTime": { + "target": "com.amazonaws.eks#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the status of the insight last changed.

" + } + }, + "description": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The description of the insight which includes alert criteria, remediation\n recommendation, and additional resources (contains Markdown).

" + } + }, + "insightStatus": { + "target": "com.amazonaws.eks#InsightStatus", + "traits": { + "smithy.api#documentation": "

An object containing more detail on the status of the insight.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The summarized description of the insight.

" + } + }, + "com.amazonaws.eks#InsightsFilter": { + "type": "structure", + "members": { + "categories": { + "target": "com.amazonaws.eks#CategoryList", + "traits": { + "smithy.api#documentation": "

The categories to use to filter insights.

" + } + }, + "kubernetesVersions": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

The Kubernetes versions to use to filter the insights.

" + } + }, + "statuses": { + "target": "com.amazonaws.eks#InsightStatusValueList", + "traits": { + "smithy.api#documentation": "

The statuses to use to filter the insights.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The criteria to use for the insights.

" + } + }, + "com.amazonaws.eks#Integer": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.eks#InvalidParameterException": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon EKS cluster associated with the exception.

" + } + }, + "nodegroupName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon EKS managed node group associated with the exception.

" + } + }, + "fargateProfileName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Fargate profile associated with the exception.

" + } + }, + "addonName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The specified parameter for the add-on name is invalid. Review the available\n parameters for the API request

" + } + }, + "subscriptionId": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon EKS subscription ID with the exception.

" + } + }, + "message": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The specified parameter is invalid. Review the available parameters for the API\n request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The specified parameter is invalid. Review the available parameters for the API\n request.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.eks#InvalidRequestException": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon EKS cluster associated with the exception.

" + } + }, + "nodegroupName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon EKS managed node group associated with the exception.

" + } + }, + "addonName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The request is invalid given the state of the add-on name. Check the state of the\n cluster and the associated operations.

" + } + }, + "subscriptionId": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon EKS subscription ID with the exception.

" + } + }, + "message": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon EKS add-on name associated with the exception.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The request is invalid given the state of the cluster. Check the state of the cluster\n and the associated operations.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.eks#IpFamily": { + "type": "enum", + "members": { + "IPV4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv4" + } + }, + "IPV6": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv6" + } + } + } + }, + "com.amazonaws.eks#Issue": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.eks#NodegroupIssueCode", + "traits": { + "smithy.api#documentation": "

A brief description of the error.

\n " + } + }, + "message": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The error message associated with the issue.

" + } + }, + "resourceIds": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services resources that are afflicted by this issue.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object representing an issue with an Amazon EKS resource.

" + } + }, + "com.amazonaws.eks#IssueList": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#Issue" + } + }, + "com.amazonaws.eks#KubernetesNetworkConfigRequest": { + "type": "structure", + "members": { + "serviceIpv4Cidr": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

Don't specify a value if you select ipv6 for ipFamily. The CIDR block to assign Kubernetes service IP addresses from. If\n you don't specify a block, Kubernetes assigns addresses from either the\n 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. We recommend\n that you specify a block that does not overlap with resources in other networks that are\n peered or connected to your VPC. The block must meet the following requirements:

\n \n \n

You can only specify a custom CIDR block when you create a cluster. You can't\n change this value after the cluster is created.

\n " + } + }, + "ipFamily": { + "target": "com.amazonaws.eks#IpFamily", + "traits": { + "smithy.api#documentation": "

Specify which IP family is used to assign Kubernetes pod and service IP addresses. If you\n don't specify a value, ipv4 is used by default. You can only specify an IP\n family when you create a cluster and can't change this value once the cluster is\n created. If you specify ipv6, the VPC and subnets that you specify for\n cluster creation must have both IPv4 and IPv6 CIDR blocks\n assigned to them. You can't specify ipv6 for clusters in China\n Regions.

\n

You can only specify ipv6 for 1.21 and later clusters that\n use version 1.10.1 or later of the Amazon VPC CNI add-on. If you specify\n ipv6, then ensure that your VPC meets the requirements listed in the\n considerations listed in Assigning IPv6 addresses to pods and\n services in the Amazon EKS User Guide. Kubernetes assigns services\n IPv6 addresses from the unique local address range\n (fc00::/7). You can't specify a custom IPv6 CIDR block.\n Pod addresses are assigned from the subnet's IPv6 CIDR.

" + } + }, + "elasticLoadBalancing": { + "target": "com.amazonaws.eks#ElasticLoadBalancing", + "traits": { + "smithy.api#documentation": "

Request to enable or disable the load balancing capability on your EKS Auto Mode cluster. For more information, see EKS Auto Mode load balancing capability in the EKS User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Kubernetes network configuration for the cluster.

" + } + }, + "com.amazonaws.eks#KubernetesNetworkConfigResponse": { + "type": "structure", + "members": { + "serviceIpv4Cidr": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The CIDR block that Kubernetes Pod and Service object IP\n addresses are assigned from. Kubernetes assigns addresses from an IPv4 CIDR\n block assigned to a subnet that the node is in. If you didn't specify a CIDR block when\n you created the cluster, then Kubernetes assigns addresses from either the\n 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. If this was\n specified, then it was specified when the cluster was created and it can't be\n changed.

" + } + }, + "serviceIpv6Cidr": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The CIDR block that Kubernetes pod and service IP addresses are assigned from if you\n created a 1.21 or later cluster with version 1.10.1 or later of the Amazon VPC CNI add-on and\n specified ipv6 for ipFamily when you\n created the cluster. Kubernetes assigns service addresses from the unique local address range\n (fc00::/7) because you can't specify a custom IPv6 CIDR block when you\n create the cluster.

" + } + }, + "ipFamily": { + "target": "com.amazonaws.eks#IpFamily", + "traits": { + "smithy.api#documentation": "

The IP family used to assign Kubernetes Pod and Service objects\n IP addresses. The IP family is always ipv4, unless you have a\n 1.21 or later cluster running version 1.10.1 or later of\n the Amazon VPC CNI plugin for Kubernetes and specified ipv6 when you created the cluster.\n

" + } + }, + "elasticLoadBalancing": { + "target": "com.amazonaws.eks#ElasticLoadBalancing", + "traits": { + "smithy.api#documentation": "

Indicates the current configuration of the load balancing capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Kubernetes network configuration for the cluster. The response contains a value for\n serviceIpv6Cidr or serviceIpv4Cidr, but not both.

" + } + }, + "com.amazonaws.eks#LaunchTemplateSpecification": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the launch template.

\n

You must specify either the launch template name or the launch template ID in the\n request, but not both.

" + } + }, + "version": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The version number of the launch template to use. If no version is specified, then the\n template's default version is used.

" + } + }, + "id": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The ID of the launch template.

\n

You must specify either the launch template ID or the launch template name in the\n request, but not both.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object representing a node group launch template specification. The launch template\n can't include \n SubnetId\n , \n IamInstanceProfile\n , \n RequestSpotInstances\n , \n HibernationOptions\n , or \n TerminateInstances\n , or the node group deployment or\n update will fail. For more information about launch templates, see \n CreateLaunchTemplate\n in the Amazon EC2 API\n Reference. For more information about using launch templates with Amazon EKS, see Customizing managed nodes with launch templates in the Amazon EKS User Guide.

\n

You must specify either the launch template ID or the launch template name in the\n request, but not both.

" + } + }, + "com.amazonaws.eks#ListAccessEntries": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#ListAccessEntriesRequest" + }, + "output": { + "target": "com.amazonaws.eks#ListAccessEntriesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the access entries for your cluster.

", + "smithy.api#http": { + "method": "GET", + "uri": "/clusters/{clusterName}/access-entries", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "accessEntries", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.eks#ListAccessEntriesRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of your cluster.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "associatedPolicyArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The ARN of an AccessPolicy. When you specify an access policy ARN,\n only the access entries associated to that access policy are returned. For a list of\n available policy ARNs, use ListAccessPolicies.

", + "smithy.api#httpQuery": "associatedPolicyArn" + } + }, + "maxResults": { + "target": "com.amazonaws.eks#ListAccessEntriesRequestMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results, returned in paginated output. You receive\n maxResults in a single page, along with a nextToken\n response element. You can see the remaining results of the initial request by sending\n another request with the returned nextToken value. This value can be\n between 1 and 100. If you don't use this parameter,\n 100 results and a nextToken value, if applicable, are\n returned.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.

\n \n

This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.

\n ", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#ListAccessEntriesRequestMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.eks#ListAccessEntriesResponse": { + "type": "structure", + "members": { + "accessEntries": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

The list of access entries that exist for the cluster.

" + } + }, + "nextToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.

\n \n

This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.

\n " + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#ListAccessPolicies": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#ListAccessPoliciesRequest" + }, + "output": { + "target": "com.amazonaws.eks#ListAccessPoliciesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the available access policies.

", + "smithy.api#http": { + "method": "GET", + "uri": "/access-policies", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "accessPolicies", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.eks#ListAccessPoliciesRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.eks#ListAccessPoliciesRequestMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results, returned in paginated output. You receive\n maxResults in a single page, along with a nextToken\n response element. You can see the remaining results of the initial request by sending\n another request with the returned nextToken value. This value can be\n between 1 and 100. If you don't use this parameter,\n 100 results and a nextToken value, if applicable, are\n returned.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.

\n \n

This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.

\n ", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#ListAccessPoliciesRequestMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.eks#ListAccessPoliciesResponse": { + "type": "structure", + "members": { + "accessPolicies": { + "target": "com.amazonaws.eks#AccessPoliciesList", + "traits": { + "smithy.api#documentation": "

The list of available access policies. You can't view the contents of an access policy\n using the API. To view the contents, see Access\n policy permissions in the Amazon EKS User Guide.

" + } + }, + "nextToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.

\n \n

This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.

\n " + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#ListAddons": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#ListAddonsRequest" + }, + "output": { + "target": "com.amazonaws.eks#ListAddonsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the installed add-ons.

", + "smithy.api#http": { + "method": "GET", + "uri": "/clusters/{clusterName}/addons", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "addons", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.eks#ListAddonsRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#ClusterName", + "traits": { + "smithy.api#documentation": "

The name of your cluster.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.eks#ListAddonsRequestMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results, returned in paginated output. You receive\n maxResults in a single page, along with a nextToken\n response element. You can see the remaining results of the initial request by sending\n another request with the returned nextToken value. This value can be\n between 1 and 100. If you don't use this parameter,\n 100 results and a nextToken value, if applicable, are\n returned.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.

\n \n

This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.

\n ", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#ListAddonsRequestMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.eks#ListAddonsResponse": { + "type": "structure", + "members": { + "addons": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

A list of installed add-ons.

" + } + }, + "nextToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The nextToken value to include in a future ListAddons\n request. When the results of a ListAddons request exceed\n maxResults, you can use this value to retrieve the next page of\n results. This value is null when there are no more results to\n return.

\n \n

This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.

\n " + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#ListAssociatedAccessPolicies": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#ListAssociatedAccessPoliciesRequest" + }, + "output": { + "target": "com.amazonaws.eks#ListAssociatedAccessPoliciesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the access policies associated with an access entry.

", + "smithy.api#http": { + "method": "GET", + "uri": "/clusters/{clusterName}/access-entries/{principalArn}/access-policies", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "associatedAccessPolicies", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.eks#ListAssociatedAccessPoliciesRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of your cluster.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "principalArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM principal for the AccessEntry.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.eks#ListAssociatedAccessPoliciesRequestMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results, returned in paginated output. You receive\n maxResults in a single page, along with a nextToken\n response element. You can see the remaining results of the initial request by sending\n another request with the returned nextToken value. This value can be\n between 1 and 100. If you don't use this parameter,\n 100 results and a nextToken value, if applicable, are\n returned.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.

\n \n

This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.

\n ", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#ListAssociatedAccessPoliciesRequestMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.eks#ListAssociatedAccessPoliciesResponse": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of your cluster.

" + } + }, + "principalArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM principal for the AccessEntry.

" + } + }, + "nextToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.

\n \n

This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.

\n " + } + }, + "associatedAccessPolicies": { + "target": "com.amazonaws.eks#AssociatedAccessPoliciesList", + "traits": { + "smithy.api#documentation": "

The list of access policies associated with the access entry.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#ListClusters": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#ListClustersRequest" + }, + "output": { + "target": "com.amazonaws.eks#ListClustersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#ServerException" + }, + { + "target": "com.amazonaws.eks#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the Amazon EKS clusters in your Amazon Web Services account in the\n specified Amazon Web Services Region.

", + "smithy.api#examples": [ + { + "title": "To list your available clusters", + "documentation": "This example command lists all of your available clusters in your default region.", + "output": { + "clusters": [ + "devel", + "prod" + ] + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/clusters", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "clusters", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.eks#ListClustersRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.eks#ListClustersRequestMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results, returned in paginated output. You receive\n maxResults in a single page, along with a nextToken\n response element. You can see the remaining results of the initial request by sending\n another request with the returned nextToken value. This value can be\n between 1 and 100. If you don't use this parameter,\n 100 results and a nextToken value, if applicable, are\n returned.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.

\n \n

This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.

\n ", + "smithy.api#httpQuery": "nextToken" + } + }, + "include": { + "target": "com.amazonaws.eks#IncludeClustersList", + "traits": { + "smithy.api#documentation": "

Indicates whether external clusters are included in the returned list. Use\n 'all' to return https://docs.aws.amazon.com/eks/latest/userguide/eks-connector.htmlconnected clusters, or blank to\n return only Amazon EKS clusters. 'all' must be in lowercase\n otherwise an error occurs.

", + "smithy.api#httpQuery": "include" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#ListClustersRequestMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.eks#ListClustersResponse": { + "type": "structure", + "members": { + "clusters": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

A list of all of the clusters for your account in the specified Amazon Web Services Region.

" + } + }, + "nextToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.

\n \n

This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.

\n " + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#ListEksAnywhereSubscriptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#ListEksAnywhereSubscriptionsRequest" + }, + "output": { + "target": "com.amazonaws.eks#ListEksAnywhereSubscriptionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#ServerException" + }, + { + "target": "com.amazonaws.eks#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Displays the full description of the subscription.

", + "smithy.api#http": { + "method": "GET", + "uri": "/eks-anywhere-subscriptions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "subscriptions", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.eks#ListEksAnywhereSubscriptionsRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.eks#ListEksAnywhereSubscriptionsRequestMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of cluster results returned by ListEksAnywhereSubscriptions in\n paginated output. When you use this parameter, ListEksAnywhereSubscriptions returns only\n maxResults results in a single page along with a nextToken response element. You can see\n the remaining results of the initial request by sending another\n ListEksAnywhereSubscriptions request with the returned nextToken value. This value can\n be between 1 and 100. If you don't use this parameter, ListEksAnywhereSubscriptions\n returns up to 10 results and a nextToken value if applicable.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The nextToken value returned from a previous paginated\n ListEksAnywhereSubscriptions request where maxResults was\n used and the results exceeded the value of that parameter. Pagination continues from the\n end of the previous results that returned the nextToken value.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "includeStatus": { + "target": "com.amazonaws.eks#EksAnywhereSubscriptionStatusValues", + "traits": { + "smithy.api#documentation": "

An array of subscription statuses to filter on.

", + "smithy.api#httpQuery": "includeStatus" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#ListEksAnywhereSubscriptionsRequestMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.eks#ListEksAnywhereSubscriptionsResponse": { + "type": "structure", + "members": { + "subscriptions": { + "target": "com.amazonaws.eks#EksAnywhereSubscriptionList", + "traits": { + "smithy.api#documentation": "

A list of all subscription objects in the region, filtered by includeStatus and\n paginated by nextToken and maxResults.

" + } + }, + "nextToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The nextToken value to include in a future ListEksAnywhereSubscriptions request. When\n the results of a ListEksAnywhereSubscriptions request exceed maxResults, you can use\n this value to retrieve the next page of results. This value is null when there are no\n more results to return.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#ListFargateProfiles": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#ListFargateProfilesRequest" + }, + "output": { + "target": "com.amazonaws.eks#ListFargateProfilesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the Fargate profiles associated with the specified cluster in\n your Amazon Web Services account in the specified Amazon Web Services Region.

", + "smithy.api#http": { + "method": "GET", + "uri": "/clusters/{clusterName}/fargate-profiles", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "fargateProfileNames", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.eks#ListFargateProfilesRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of your cluster.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.eks#FargateProfilesRequestMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results, returned in paginated output. You receive\n maxResults in a single page, along with a nextToken\n response element. You can see the remaining results of the initial request by sending\n another request with the returned nextToken value. This value can be\n between 1 and 100. If you don't use this parameter,\n 100 results and a nextToken value, if applicable, are\n returned.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.

\n \n

This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.

\n ", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#ListFargateProfilesResponse": { + "type": "structure", + "members": { + "fargateProfileNames": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

A list of all of the Fargate profiles associated with the specified\n cluster.

" + } + }, + "nextToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.

\n \n

This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.

\n " + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#ListIdentityProviderConfigs": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#ListIdentityProviderConfigsRequest" + }, + "output": { + "target": "com.amazonaws.eks#ListIdentityProviderConfigsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + }, + { + "target": "com.amazonaws.eks#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the identity provider configurations for your cluster.

", + "smithy.api#http": { + "method": "GET", + "uri": "/clusters/{clusterName}/identity-provider-configs", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "identityProviderConfigs", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.eks#ListIdentityProviderConfigsRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of your cluster.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.eks#ListIdentityProviderConfigsRequestMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results, returned in paginated output. You receive\n maxResults in a single page, along with a nextToken\n response element. You can see the remaining results of the initial request by sending\n another request with the returned nextToken value. This value can be\n between 1 and 100. If you don't use this parameter,\n 100 results and a nextToken value, if applicable, are\n returned.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.

\n \n

This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.

\n ", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#ListIdentityProviderConfigsRequestMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.eks#ListIdentityProviderConfigsResponse": { + "type": "structure", + "members": { + "identityProviderConfigs": { + "target": "com.amazonaws.eks#IdentityProviderConfigs", + "traits": { + "smithy.api#documentation": "

The identity provider configurations for the cluster.

" + } + }, + "nextToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The nextToken value to include in a future\n ListIdentityProviderConfigsResponse request. When the results of a\n ListIdentityProviderConfigsResponse request exceed\n maxResults, you can use this value to retrieve the next page of\n results. This value is null when there are no more results to\n return.

\n \n

This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.

\n " + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#ListInsights": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#ListInsightsRequest" + }, + "output": { + "target": "com.amazonaws.eks#ListInsightsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of all insights checked for against the specified cluster. You can\n filter which insights are returned by category, associated Kubernetes version, and\n status.

", + "smithy.api#http": { + "method": "POST", + "uri": "/clusters/{clusterName}/insights", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "insights", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.eks#ListInsightsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.eks#ListInsightsRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon EKS cluster associated with the insights.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "filter": { + "target": "com.amazonaws.eks#InsightsFilter", + "traits": { + "smithy.api#documentation": "

The criteria to filter your list of insights for your cluster. You can filter which\n insights are returned by category, associated Kubernetes version, and status.

" + } + }, + "maxResults": { + "target": "com.amazonaws.eks#ListInsightsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of identity provider configurations returned by\n ListInsights in paginated output. When you use this parameter,\n ListInsights returns only maxResults results in a single\n page along with a nextToken response element. You can see the remaining\n results of the initial request by sending another ListInsights request with\n the returned nextToken value. This value can be between 1\n and 100. If you don't use this parameter, ListInsights\n returns up to 100 results and a nextToken value, if\n applicable.

" + } + }, + "nextToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The nextToken value returned from a previous paginated\n ListInsights request. When the results of a ListInsights\n request exceed maxResults, you can use this value to retrieve the next page\n of results. This value is null when there are no more results to\n return.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#ListInsightsResponse": { + "type": "structure", + "members": { + "insights": { + "target": "com.amazonaws.eks#InsightSummaries", + "traits": { + "smithy.api#documentation": "

The returned list of insights.

" + } + }, + "nextToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The nextToken value to include in a future ListInsights\n request. When the results of a ListInsights request exceed\n maxResults, you can use this value to retrieve the next page of\n results. This value is null when there are no more results to\n return.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#ListNodegroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#ListNodegroupsRequest" + }, + "output": { + "target": "com.amazonaws.eks#ListNodegroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + }, + { + "target": "com.amazonaws.eks#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the managed node groups associated with the specified cluster in your Amazon Web Services account in the specified Amazon Web Services Region. Self-managed node\n groups aren't listed.

", + "smithy.api#http": { + "method": "GET", + "uri": "/clusters/{clusterName}/node-groups", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "nodegroups", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.eks#ListNodegroupsRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of your cluster.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.eks#ListNodegroupsRequestMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results, returned in paginated output. You receive\n maxResults in a single page, along with a nextToken\n response element. You can see the remaining results of the initial request by sending\n another request with the returned nextToken value. This value can be\n between 1 and 100. If you don't use this parameter,\n 100 results and a nextToken value, if applicable, are\n returned.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.

\n \n

This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.

\n ", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#ListNodegroupsRequestMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.eks#ListNodegroupsResponse": { + "type": "structure", + "members": { + "nodegroups": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

A list of all of the node groups associated with the specified cluster.

" + } + }, + "nextToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.

\n \n

This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.

\n " + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#ListPodIdentityAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#ListPodIdentityAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.eks#ListPodIdentityAssociationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

List the EKS Pod Identity associations in a cluster. You can filter the list by the namespace that the\n association is in or the service account that the association uses.

", + "smithy.api#http": { + "method": "GET", + "uri": "/clusters/{clusterName}/pod-identity-associations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "associations", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.eks#ListPodIdentityAssociationsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.eks#ListPodIdentityAssociationsRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the cluster that the associations are in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "namespace": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the Kubernetes namespace inside the cluster that the associations are in.

", + "smithy.api#httpQuery": "namespace" + } + }, + "serviceAccount": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the Kubernetes service account that the associations use.

", + "smithy.api#httpQuery": "serviceAccount" + } + }, + "maxResults": { + "target": "com.amazonaws.eks#ListPodIdentityAssociationsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of EKS Pod Identity association results returned by\n ListPodIdentityAssociations in paginated output. When you use this\n parameter, ListPodIdentityAssociations returns only maxResults\n results in a single page along with a nextToken response element. You can\n see the remaining results of the initial request by sending another\n ListPodIdentityAssociations request with the returned\n nextToken value. This value can be between 1 and\n 100. If you don't use this parameter,\n ListPodIdentityAssociations returns up to 100 results\n and a nextToken value if applicable.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The nextToken value returned from a previous paginated\n ListUpdates request where maxResults was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the nextToken value.

\n \n

This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.

\n ", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#ListPodIdentityAssociationsResponse": { + "type": "structure", + "members": { + "associations": { + "target": "com.amazonaws.eks#PodIdentityAssociationSummaries", + "traits": { + "smithy.api#documentation": "

The list of summarized descriptions of the associations that are in the cluster and match\n any filters that you provided.

\n

Each summary is simplified by removing these fields compared to the full \n PodIdentityAssociation\n :

\n " + } + }, + "nextToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The nextToken value to include in a future\n ListPodIdentityAssociations request. When the results of a\n ListPodIdentityAssociations request exceed maxResults, you\n can use this value to retrieve the next page of results. This value is null\n when there are no more results to return.

\n \n

This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.

\n " + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.eks#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#BadRequestException" + }, + { + "target": "com.amazonaws.eks#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

List the tags for an Amazon EKS resource.

", + "smithy.api#examples": [ + { + "title": "To list tags for a cluster", + "documentation": "This example lists all of the tags for the `beta` cluster.", + "input": { + "resourceArn": "arn:aws:eks:us-west-2:012345678910:cluster/beta" + }, + "output": { + "tags": { + "aws:tag:domain": "beta" + } + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.eks#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the resource to list tags for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.eks#TagMap", + "traits": { + "smithy.api#documentation": "

The tags for the resource.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#ListUpdates": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#ListUpdatesRequest" + }, + "output": { + "target": "com.amazonaws.eks#ListUpdatesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the updates associated with an Amazon EKS resource in your Amazon Web Services account, in the specified Amazon Web Services Region.

", + "smithy.api#http": { + "method": "GET", + "uri": "/clusters/{name}/updates", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "updateIds", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.eks#ListUpdatesRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon EKS cluster to list updates for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nodegroupName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon EKS managed node group to list updates for.

", + "smithy.api#httpQuery": "nodegroupName" + } + }, + "addonName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The names of the installed add-ons that have available updates.

", + "smithy.api#httpQuery": "addonName" + } + }, + "nextToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.

\n \n

This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.

\n ", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.eks#ListUpdatesRequestMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results, returned in paginated output. You receive\n maxResults in a single page, along with a nextToken\n response element. You can see the remaining results of the initial request by sending\n another request with the returned nextToken value. This value can be\n between 1 and 100. If you don't use this parameter,\n 100 results and a nextToken value, if applicable, are\n returned.

", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#ListUpdatesRequestMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.eks#ListUpdatesResponse": { + "type": "structure", + "members": { + "updateIds": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

A list of all the updates for the specified cluster and Region.

" + } + }, + "nextToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.

\n \n

This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.

\n " + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#LogSetup": { + "type": "structure", + "members": { + "types": { + "target": "com.amazonaws.eks#LogTypes", + "traits": { + "smithy.api#documentation": "

The available cluster control plane log types.

" + } + }, + "enabled": { + "target": "com.amazonaws.eks#BoxedBoolean", + "traits": { + "smithy.api#documentation": "

If a log type is enabled, that log type exports its control plane logs to CloudWatch Logs. If a log type isn't enabled, that log type doesn't export its control\n plane logs. Each individual log type can be enabled or disabled independently.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object representing the enabled or disabled Kubernetes control plane logs for your\n cluster.

" + } + }, + "com.amazonaws.eks#LogSetups": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#LogSetup" + } + }, + "com.amazonaws.eks#LogType": { + "type": "enum", + "members": { + "API": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "api" + } + }, + "AUDIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "audit" + } + }, + "AUTHENTICATOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "authenticator" + } + }, + "CONTROLLER_MANAGER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "controllerManager" + } + }, + "SCHEDULER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scheduler" + } + } + } + }, + "com.amazonaws.eks#LogTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#LogType" + } + }, + "com.amazonaws.eks#Logging": { + "type": "structure", + "members": { + "clusterLogging": { + "target": "com.amazonaws.eks#LogSetups", + "traits": { + "smithy.api#documentation": "

The cluster control plane logging configuration for your cluster.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object representing the logging configuration for resources in your cluster.

" + } + }, + "com.amazonaws.eks#MarketplaceInformation": { + "type": "structure", + "members": { + "productId": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The product ID from the Amazon Web Services Marketplace.

" + } + }, + "productUrl": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The product URL from the Amazon Web Services Marketplace.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an Amazon EKS add-on from the Amazon Web Services Marketplace.

" + } + }, + "com.amazonaws.eks#NodeRepairConfig": { + "type": "structure", + "members": { + "enabled": { + "target": "com.amazonaws.eks#BoxedBoolean", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable node auto repair for the node group. Node auto repair is \n disabled by default.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The node auto repair configuration for the node group.

" + } + }, + "com.amazonaws.eks#Nodegroup": { + "type": "structure", + "members": { + "nodegroupName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name associated with an Amazon EKS managed node group.

" + } + }, + "nodegroupArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the managed node group.

" + } + }, + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of your cluster.

" + } + }, + "version": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Kubernetes version of the managed node group.

" + } + }, + "releaseVersion": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

If the node group was deployed using a launch template with a custom AMI, then this is\n the AMI ID that was specified in the launch template. For node groups that weren't\n deployed using a launch template, this is the version of the Amazon EKS\n optimized AMI that the node group was deployed with.

" + } + }, + "createdAt": { + "target": "com.amazonaws.eks#Timestamp", + "traits": { + "smithy.api#documentation": "

The Unix epoch timestamp at object creation.

" + } + }, + "modifiedAt": { + "target": "com.amazonaws.eks#Timestamp", + "traits": { + "smithy.api#documentation": "

The Unix epoch timestamp for the last modification to the object.

" + } + }, + "status": { + "target": "com.amazonaws.eks#NodegroupStatus", + "traits": { + "smithy.api#documentation": "

The current status of the managed node group.

" + } + }, + "capacityType": { + "target": "com.amazonaws.eks#CapacityTypes", + "traits": { + "smithy.api#documentation": "

The capacity type of your managed node group.

" + } + }, + "scalingConfig": { + "target": "com.amazonaws.eks#NodegroupScalingConfig", + "traits": { + "smithy.api#documentation": "

The scaling configuration details for the Auto Scaling group that is associated with\n your node group.

" + } + }, + "instanceTypes": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

If the node group wasn't deployed with a launch template, then this is the instance\n type that is associated with the node group. If the node group was deployed with a\n launch template, then this is null.

" + } + }, + "subnets": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

The subnets that were specified for the Auto Scaling group that is associated with\n your node group.

" + } + }, + "remoteAccess": { + "target": "com.amazonaws.eks#RemoteAccessConfig", + "traits": { + "smithy.api#documentation": "

If the node group wasn't deployed with a launch template, then this is the remote\n access configuration that is associated with the node group. If the node group was\n deployed with a launch template, then this is null.

" + } + }, + "amiType": { + "target": "com.amazonaws.eks#AMITypes", + "traits": { + "smithy.api#documentation": "

If the node group was deployed using a launch template with a custom AMI, then this is\n CUSTOM. For node groups that weren't deployed using a launch template,\n this is the AMI type that was specified in the node group configuration.

" + } + }, + "nodeRole": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The IAM role associated with your node group. The Amazon EKS\n node kubelet daemon makes calls to Amazon Web Services APIs on your behalf.\n Nodes receive permissions for these API calls through an IAM instance\n profile and associated policies.

" + } + }, + "labels": { + "target": "com.amazonaws.eks#labelsMap", + "traits": { + "smithy.api#documentation": "

The Kubernetes labels applied to the nodes in the node group.

\n \n

Only labels that are applied with the Amazon EKS API are\n shown here. There may be other Kubernetes labels applied to the nodes in\n this group.

\n " + } + }, + "taints": { + "target": "com.amazonaws.eks#taintsList", + "traits": { + "smithy.api#documentation": "

The Kubernetes taints to be applied to the nodes in the node group when they are created.\n Effect is one of No_Schedule, Prefer_No_Schedule, or\n No_Execute. Kubernetes taints can be used together with tolerations to\n control how workloads are scheduled to your nodes. For more information, see Node taints on managed node groups.

" + } + }, + "resources": { + "target": "com.amazonaws.eks#NodegroupResources", + "traits": { + "smithy.api#documentation": "

The resources associated with the node group, such as Auto Scaling groups and security\n groups for remote access.

" + } + }, + "diskSize": { + "target": "com.amazonaws.eks#BoxedInteger", + "traits": { + "smithy.api#documentation": "

If the node group wasn't deployed with a launch template, then this is the disk size\n in the node group configuration. If the node group was deployed with a launch template,\n then this is null.

" + } + }, + "health": { + "target": "com.amazonaws.eks#NodegroupHealth", + "traits": { + "smithy.api#documentation": "

The health status of the node group. If there are issues with your node group's\n health, they are listed here.

" + } + }, + "updateConfig": { + "target": "com.amazonaws.eks#NodegroupUpdateConfig", + "traits": { + "smithy.api#documentation": "

The node group update configuration.

" + } + }, + "nodeRepairConfig": { + "target": "com.amazonaws.eks#NodeRepairConfig", + "traits": { + "smithy.api#documentation": "

The node auto repair configuration for the node group.

" + } + }, + "launchTemplate": { + "target": "com.amazonaws.eks#LaunchTemplateSpecification", + "traits": { + "smithy.api#documentation": "

If a launch template was used to create the node group, then this is the launch\n template that was used.

" + } + }, + "tags": { + "target": "com.amazonaws.eks#TagMap", + "traits": { + "smithy.api#documentation": "

Metadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object representing an Amazon EKS managed node group.

" + } + }, + "com.amazonaws.eks#NodegroupHealth": { + "type": "structure", + "members": { + "issues": { + "target": "com.amazonaws.eks#IssueList", + "traits": { + "smithy.api#documentation": "

Any issues that are associated with the node group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object representing the health status of the node group.

" + } + }, + "com.amazonaws.eks#NodegroupIssueCode": { + "type": "enum", + "members": { + "AUTO_SCALING_GROUP_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AutoScalingGroupNotFound" + } + }, + "AUTO_SCALING_GROUP_INVALID_CONFIGURATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AutoScalingGroupInvalidConfiguration" + } + }, + "EC2_SECURITY_GROUP_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ec2SecurityGroupNotFound" + } + }, + "EC2_SECURITY_GROUP_DELETION_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ec2SecurityGroupDeletionFailure" + } + }, + "EC2_LAUNCH_TEMPLATE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ec2LaunchTemplateNotFound" + } + }, + "EC2_LAUNCH_TEMPLATE_VERSION_MISMATCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ec2LaunchTemplateVersionMismatch" + } + }, + "EC2_SUBNET_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ec2SubnetNotFound" + } + }, + "EC2_SUBNET_INVALID_CONFIGURATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ec2SubnetInvalidConfiguration" + } + }, + "IAM_INSTANCE_PROFILE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IamInstanceProfileNotFound" + } + }, + "EC2_SUBNET_MISSING_IPV6_ASSIGNMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ec2SubnetMissingIpv6Assignment" + } + }, + "IAM_LIMIT_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IamLimitExceeded" + } + }, + "IAM_NODE_ROLE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IamNodeRoleNotFound" + } + }, + "NODE_CREATION_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NodeCreationFailure" + } + }, + "ASG_INSTANCE_LAUNCH_FAILURES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AsgInstanceLaunchFailures" + } + }, + "INSTANCE_LIMIT_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InstanceLimitExceeded" + } + }, + "INSUFFICIENT_FREE_ADDRESSES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InsufficientFreeAddresses" + } + }, + "ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AccessDenied" + } + }, + "INTERNAL_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InternalFailure" + } + }, + "CLUSTER_UNREACHABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ClusterUnreachable" + } + }, + "AMI_ID_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AmiIdNotFound" + } + }, + "AUTO_SCALING_GROUP_OPT_IN_REQUIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AutoScalingGroupOptInRequired" + } + }, + "AUTO_SCALING_GROUP_RATE_LIMIT_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AutoScalingGroupRateLimitExceeded" + } + }, + "EC2_LAUNCH_TEMPLATE_DELETION_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ec2LaunchTemplateDeletionFailure" + } + }, + "EC2_LAUNCH_TEMPLATE_INVALID_CONFIGURATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ec2LaunchTemplateInvalidConfiguration" + } + }, + "EC2_LAUNCH_TEMPLATE_MAX_LIMIT_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ec2LaunchTemplateMaxLimitExceeded" + } + }, + "EC2_SUBNET_LIST_TOO_LONG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ec2SubnetListTooLong" + } + }, + "IAM_THROTTLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IamThrottling" + } + }, + "NODE_TERMINATION_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NodeTerminationFailure" + } + }, + "POD_EVICTION_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PodEvictionFailure" + } + }, + "SOURCE_EC2_LAUNCH_TEMPLATE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SourceEc2LaunchTemplateNotFound" + } + }, + "LIMIT_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LimitExceeded" + } + }, + "UNKNOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Unknown" + } + }, + "AUTO_SCALING_GROUP_INSTANCE_REFRESH_ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AutoScalingGroupInstanceRefreshActive" + } + }, + "KUBERNETES_LABEL_INVALID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KubernetesLabelInvalid" + } + }, + "EC2_LAUNCH_TEMPLATE_VERSION_MAX_LIMIT_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ec2LaunchTemplateVersionMaxLimitExceeded" + } + }, + "EC2_INSTANCE_TYPE_DOES_NOT_EXIST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ec2InstanceTypeDoesNotExist" + } + } + } + }, + "com.amazonaws.eks#NodegroupResources": { + "type": "structure", + "members": { + "autoScalingGroups": { + "target": "com.amazonaws.eks#AutoScalingGroupList", + "traits": { + "smithy.api#documentation": "

The Auto Scaling groups associated with the node group.

" + } + }, + "remoteAccessSecurityGroup": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The remote access security group associated with the node group. This security group\n controls SSH access to the nodes.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object representing the resources associated with the node group, such as Auto\n Scaling groups and security groups for remote access.

" + } + }, + "com.amazonaws.eks#NodegroupScalingConfig": { + "type": "structure", + "members": { + "minSize": { + "target": "com.amazonaws.eks#ZeroCapacity", + "traits": { + "smithy.api#documentation": "

The minimum number of nodes that the managed node group can scale in to.

" + } + }, + "maxSize": { + "target": "com.amazonaws.eks#Capacity", + "traits": { + "smithy.api#documentation": "

The maximum number of nodes that the managed node group can scale out to. For\n information about the maximum number that you can specify, see Amazon EKS service quotas in the Amazon EKS User Guide.

" + } + }, + "desiredSize": { + "target": "com.amazonaws.eks#ZeroCapacity", + "traits": { + "smithy.api#documentation": "

The current number of nodes that the managed node group should maintain.

\n \n

If you use the Kubernetes Cluster\n Autoscaler, you shouldn't change the desiredSize value\n directly, as this can cause the Cluster Autoscaler to suddenly scale up or scale\n down.

\n \n

Whenever this parameter changes, the number of worker nodes in the node group is\n updated to the specified size. If this parameter is given a value that is smaller than\n the current number of running worker nodes, the necessary number of worker nodes are\n terminated to match the given value.\n \n When using CloudFormation, no action occurs if you remove this parameter from your CFN\n template.

\n

This parameter can be different from minSize in some cases, such as when\n starting with extra hosts for testing. This parameter can also be different when you\n want to start with an estimated number of needed hosts, but let the Cluster Autoscaler\n reduce the number if there are too many. When the Cluster Autoscaler is used, the\n desiredSize parameter is altered by the Cluster Autoscaler (but can be\n out-of-date for short periods of time). the Cluster Autoscaler doesn't scale a managed\n node group lower than minSize or higher than maxSize.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object representing the scaling configuration details for the Auto Scaling\n group that is associated with your node group. When creating a node group, you must\n specify all or none of the properties. When updating a node group, you can specify any\n or none of the properties.

" + } + }, + "com.amazonaws.eks#NodegroupStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + }, + "DEGRADED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEGRADED" + } + } + } + }, + "com.amazonaws.eks#NodegroupUpdateConfig": { + "type": "structure", + "members": { + "maxUnavailable": { + "target": "com.amazonaws.eks#NonZeroInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of nodes unavailable at once during a version update. Nodes are\n updated in parallel. This value or maxUnavailablePercentage is required to\n have a value.The maximum number is 100.

" + } + }, + "maxUnavailablePercentage": { + "target": "com.amazonaws.eks#PercentCapacity", + "traits": { + "smithy.api#documentation": "

The maximum percentage of nodes unavailable during a version update. This percentage\n of nodes are updated in parallel, up to 100 nodes at once. This value or\n maxUnavailable is required to have a value.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The node group update configuration.

" + } + }, + "com.amazonaws.eks#NonZeroInteger": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.eks#NotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

A service resource associated with the request could not be found. Clients should not\n retry such requests.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A service resource associated with the request could not be found. Clients should not\n retry such requests.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.eks#OIDC": { + "type": "structure", + "members": { + "issuer": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The issuer URL for the OIDC identity provider.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object representing the OpenID Connect\n (OIDC) identity provider information for the cluster.

" + } + }, + "com.amazonaws.eks#OidcIdentityProviderConfig": { + "type": "structure", + "members": { + "identityProviderConfigName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the configuration.

" + } + }, + "identityProviderConfigArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The ARN of the configuration.

" + } + }, + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of your cluster.

" + } + }, + "issuerUrl": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The URL of the OIDC identity provider that allows the API server to discover public\n signing keys for verifying tokens.

" + } + }, + "clientId": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

This is also known as audience. The ID of the client application\n that makes authentication requests to the OIDC identity provider.

" + } + }, + "usernameClaim": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The JSON Web token (JWT) claim that is used as the username.

" + } + }, + "usernamePrefix": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The prefix that is prepended to username claims to prevent clashes with existing\n names. The prefix can't contain system:\n

" + } + }, + "groupsClaim": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The JSON web token (JWT) claim that the provider uses to return your groups.

" + } + }, + "groupsPrefix": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The prefix that is prepended to group claims to prevent clashes with existing names\n (such as system: groups). For example, the value oidc: creates\n group names like oidc:engineering and oidc:infra. The prefix\n can't contain system:\n

" + } + }, + "requiredClaims": { + "target": "com.amazonaws.eks#requiredClaimsMap", + "traits": { + "smithy.api#documentation": "

The key-value pairs that describe required claims in the identity token. If set, each\n claim is verified to be present in the token with a matching value.

" + } + }, + "tags": { + "target": "com.amazonaws.eks#TagMap", + "traits": { + "smithy.api#documentation": "

Metadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.

" + } + }, + "status": { + "target": "com.amazonaws.eks#configStatus", + "traits": { + "smithy.api#documentation": "

The status of the OIDC identity provider.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object representing the configuration for an OpenID Connect (OIDC) identity provider.\n

" + } + }, + "com.amazonaws.eks#OidcIdentityProviderConfigRequest": { + "type": "structure", + "members": { + "identityProviderConfigName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the OIDC provider configuration.

", + "smithy.api#required": {} + } + }, + "issuerUrl": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The URL of the OIDC identity provider that allows the API server to discover public\n signing keys for verifying tokens. The URL must begin with https:// and\n should correspond to the iss claim in the provider's OIDC ID tokens.\n Based on the OIDC standard, path components are allowed but query parameters are not.\n Typically the URL consists of only a hostname, like\n https://server.example.org or https://example.com. This\n URL should point to the level below .well-known/openid-configuration and\n must be publicly accessible over the internet.

", + "smithy.api#required": {} + } + }, + "clientId": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

This is also known as audience. The ID for the client application\n that makes authentication requests to the OIDC identity provider.

", + "smithy.api#required": {} + } + }, + "usernameClaim": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The JSON Web Token (JWT) claim to use as the username. The default is\n sub, which is expected to be a unique identifier of the end user. You can\n choose other claims, such as email or name, depending on the\n OIDC identity provider. Claims other than email are prefixed with the\n issuer URL to prevent naming clashes with other plug-ins.

" + } + }, + "usernamePrefix": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The prefix that is prepended to username claims to prevent clashes with existing\n names. If you do not provide this field, and username is a value other than\n email, the prefix defaults to issuerurl#. You can use the\n value - to disable all prefixing.

" + } + }, + "groupsClaim": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The JWT claim that the provider uses to return your groups.

" + } + }, + "groupsPrefix": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The prefix that is prepended to group claims to prevent clashes with existing names\n (such as system: groups). For example, the value oidc: will\n create group names like oidc:engineering and\n oidc:infra.

" + } + }, + "requiredClaims": { + "target": "com.amazonaws.eks#requiredClaimsMap", + "traits": { + "smithy.api#documentation": "

The key value pairs that describe required claims in the identity token. If set, each\n claim is verified to be present in the token with a matching value. For the maximum\n number of claims that you can require, see Amazon EKS service\n quotas in the Amazon EKS User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object representing an OpenID Connect (OIDC) configuration. Before associating an\n OIDC identity provider to your cluster, review the considerations in Authenticating\n users for your cluster from an OIDC identity provider in the\n Amazon EKS User Guide.

" + } + }, + "com.amazonaws.eks#OutpostConfigRequest": { + "type": "structure", + "members": { + "outpostArns": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

The ARN of the Outpost that you want to use for your local Amazon EKS\n cluster on Outposts. Only a single Outpost ARN is supported.

", + "smithy.api#required": {} + } + }, + "controlPlaneInstanceType": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon EC2 instance type that you want to use for your local Amazon EKS cluster on Outposts. Choose an instance type based on the number of nodes\n that your cluster will have. For more information, see Capacity\n considerations in the Amazon EKS User Guide.

\n

The instance type that you specify is used for all Kubernetes control plane instances. The\n instance type can't be changed after cluster creation. The control plane is not\n automatically scaled by Amazon EKS.

\n

", + "smithy.api#required": {} + } + }, + "controlPlanePlacement": { + "target": "com.amazonaws.eks#ControlPlanePlacementRequest", + "traits": { + "smithy.api#documentation": "

An object representing the placement configuration for all the control plane instances\n of your local Amazon EKS cluster on an Amazon Web Services Outpost. For more\n information, see Capacity considerations in the Amazon EKS User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of your local Amazon EKS cluster on an Amazon Web Services\n Outpost. Before creating a cluster on an Outpost, review Creating a local\n cluster on an Outpost in the Amazon EKS User Guide. This API isn't available for\n Amazon EKS clusters on the Amazon Web Services cloud.

" + } + }, + "com.amazonaws.eks#OutpostConfigResponse": { + "type": "structure", + "members": { + "outpostArns": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

The ARN of the Outpost that you specified for use with your local Amazon EKS\n cluster on Outposts.

", + "smithy.api#required": {} + } + }, + "controlPlaneInstanceType": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon EC2 instance type used for the control plane. The instance type is\n the same for all control plane instances.

", + "smithy.api#required": {} + } + }, + "controlPlanePlacement": { + "target": "com.amazonaws.eks#ControlPlanePlacementResponse", + "traits": { + "smithy.api#documentation": "

An object representing the placement configuration for all the control plane instances\n of your local Amazon EKS cluster on an Amazon Web Services Outpost. For more\n information, see Capacity\n considerations in the Amazon EKS User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object representing the configuration of your local Amazon EKS cluster on\n an Amazon Web Services Outpost. This API isn't available for Amazon EKS clusters\n on the Amazon Web Services cloud.

" + } + }, + "com.amazonaws.eks#PercentCapacity": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.eks#PodIdentityAssociation": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the cluster that the association is in.

" + } + }, + "namespace": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the Kubernetes namespace inside the cluster to create the association in. The\n service account and the pods that use the service account must be in this\n namespace.

" + } + }, + "serviceAccount": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the Kubernetes service account inside the cluster to associate the IAM credentials with.

" + } + }, + "roleArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to associate with the service account. The EKS Pod Identity\n agent manages credentials to assume this role for applications in the containers in the\n pods that use this service account.

" + } + }, + "associationArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the association.

" + } + }, + "associationId": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The ID of the association.

" + } + }, + "tags": { + "target": "com.amazonaws.eks#TagMap", + "traits": { + "smithy.api#documentation": "

Metadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.

\n

The following basic restrictions apply to tags:

\n " + } + }, + "createdAt": { + "target": "com.amazonaws.eks#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp that the association was created at.

" + } + }, + "modifiedAt": { + "target": "com.amazonaws.eks#Timestamp", + "traits": { + "smithy.api#documentation": "

The most recent timestamp that the association was modified at

" + } + }, + "ownerArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

If defined, the Pod Identity Association is owned by an Amazon EKS Addon.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Amazon EKS Pod Identity associations provide the ability to manage credentials for your applications, similar to the way that Amazon EC2 instance profiles provide credentials to Amazon EC2 instances.

" + } + }, + "com.amazonaws.eks#PodIdentityAssociationSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#PodIdentityAssociationSummary" + } + }, + "com.amazonaws.eks#PodIdentityAssociationSummary": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the cluster that the association is in.

" + } + }, + "namespace": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the Kubernetes namespace inside the cluster to create the association in. The\n service account and the pods that use the service account must be in this\n namespace.

" + } + }, + "serviceAccount": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the Kubernetes service account inside the cluster to associate the IAM\n credentials with.

" + } + }, + "associationArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the association.

" + } + }, + "associationId": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The ID of the association.

" + } + }, + "ownerArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

If defined, the Pod Identity Association is owned by an Amazon EKS Addon.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The summarized description of the association.

\n

Each summary is simplified by removing these fields compared to the full \n PodIdentityAssociation\n :

\n " + } + }, + "com.amazonaws.eks#Provider": { + "type": "structure", + "members": { + "keyArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

Amazon Resource Name (ARN) or alias of the KMS key. The KMS key must be\n symmetric and created in the same Amazon Web Services Region as the cluster. If the\n KMS key was created in a different account, the IAM principal must\n have access to the KMS key. For more information, see Allowing\n users in other accounts to use a KMS key in the\n Key Management Service Developer Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Identifies the Key Management Service (KMS) key used to encrypt the\n secrets.

" + } + }, + "com.amazonaws.eks#RegisterCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#RegisterClusterRequest" + }, + "output": { + "target": "com.amazonaws.eks#RegisterClusterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#AccessDeniedException" + }, + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#ResourceInUseException" + }, + { + "target": "com.amazonaws.eks#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.eks#ResourcePropagationDelayException" + }, + { + "target": "com.amazonaws.eks#ServerException" + }, + { + "target": "com.amazonaws.eks#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Connects a Kubernetes cluster to the Amazon EKS control plane.

\n

Any Kubernetes cluster can be connected to the Amazon EKS control plane to view\n current information about the cluster and its nodes.

\n

Cluster connection requires two steps. First, send a \n RegisterClusterRequest\n to add it to the Amazon EKS\n control plane.

\n

Second, a Manifest containing the activationID and\n activationCode must be applied to the Kubernetes cluster through it's native\n provider to provide visibility.

\n

After the manifest is updated and applied, the connected cluster is visible to the\n Amazon EKS control plane. If the manifest isn't applied within three days,\n the connected cluster will no longer be visible and must be deregistered using\n DeregisterCluster.

", + "smithy.api#http": { + "method": "POST", + "uri": "/cluster-registrations", + "code": 200 + } + } + }, + "com.amazonaws.eks#RegisterClusterRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.eks#ClusterName", + "traits": { + "smithy.api#documentation": "

A unique name for this cluster in your Amazon Web Services Region.

", + "smithy.api#required": {} + } + }, + "connectorConfig": { + "target": "com.amazonaws.eks#ConnectorConfigRequest", + "traits": { + "smithy.api#documentation": "

The configuration settings required to connect the Kubernetes cluster to the Amazon EKS control plane.

", + "smithy.api#required": {} + } + }, + "clientRequestToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.

", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.eks#TagMap", + "traits": { + "smithy.api#documentation": "

Metadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#RegisterClusterResponse": { + "type": "structure", + "members": { + "cluster": { + "target": "com.amazonaws.eks#Cluster" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#RemoteAccessConfig": { + "type": "structure", + "members": { + "ec2SshKey": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon EC2 SSH key name that provides access for SSH communication with\n the nodes in the managed node group. For more information, see Amazon EC2 key pairs and Linux instances in the Amazon Elastic Compute Cloud User Guide for Linux Instances. For\n Windows, an Amazon EC2 SSH key is used to obtain the RDP password. For more\n information, see Amazon EC2 key pairs and Windows instances in\n the Amazon Elastic Compute Cloud User Guide for Windows Instances.

" + } + }, + "sourceSecurityGroups": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

The security group IDs that are allowed SSH access (port 22) to the nodes. For\n Windows, the port is 3389. If you specify an Amazon EC2 SSH key but don't\n specify a source security group when you create a managed node group, then the port on\n the nodes is opened to the internet (0.0.0.0/0). For more information, see\n Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object representing the remote access configuration for the managed node\n group.

" + } + }, + "com.amazonaws.eks#RemoteNetworkConfigRequest": { + "type": "structure", + "members": { + "remoteNodeNetworks": { + "target": "com.amazonaws.eks#RemoteNodeNetworkList", + "traits": { + "smithy.api#documentation": "

The list of network CIDRs that can contain hybrid nodes.

\n

These CIDR blocks define the expected IP address range of the hybrid nodes that join\n the cluster. These blocks are typically determined by your network administrator.

\n

Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, \n 10.2.0.0/16).

\n

It must satisfy the following requirements:

\n " + } + }, + "remotePodNetworks": { + "target": "com.amazonaws.eks#RemotePodNetworkList", + "traits": { + "smithy.api#documentation": "

The list of network CIDRs that can contain pods that run Kubernetes webhooks on hybrid nodes.

\n

These CIDR blocks are determined by configuring your Container Network Interface (CNI)\n plugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn't\n available for on-premises and edge locations.

\n

Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, \n 10.2.0.0/16).

\n

It must satisfy the following requirements:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration in the cluster for EKS Hybrid Nodes. You can't change or update this\n configuration after the cluster is created.

" + } + }, + "com.amazonaws.eks#RemoteNetworkConfigResponse": { + "type": "structure", + "members": { + "remoteNodeNetworks": { + "target": "com.amazonaws.eks#RemoteNodeNetworkList", + "traits": { + "smithy.api#documentation": "

The list of network CIDRs that can contain hybrid nodes.

" + } + }, + "remotePodNetworks": { + "target": "com.amazonaws.eks#RemotePodNetworkList", + "traits": { + "smithy.api#documentation": "

The list of network CIDRs that can contain pods that run Kubernetes webhooks on hybrid nodes.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration in the cluster for EKS Hybrid Nodes. You can't change or update this\n configuration after the cluster is created.

" + } + }, + "com.amazonaws.eks#RemoteNodeNetwork": { + "type": "structure", + "members": { + "cidrs": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

A network CIDR that can contain hybrid nodes.

\n

These CIDR blocks define the expected IP address range of the hybrid nodes that join\n the cluster. These blocks are typically determined by your network administrator.

\n

Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, \n 10.2.0.0/16).

\n

It must satisfy the following requirements:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

A network CIDR that can contain hybrid nodes.

\n

These CIDR blocks define the expected IP address range of the hybrid nodes that join\n the cluster. These blocks are typically determined by your network administrator.

\n

Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, \n 10.2.0.0/16).

\n

It must satisfy the following requirements:

\n " + } + }, + "com.amazonaws.eks#RemoteNodeNetworkList": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#RemoteNodeNetwork" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.eks#RemotePodNetwork": { + "type": "structure", + "members": { + "cidrs": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

A network CIDR that can contain pods that run Kubernetes webhooks on hybrid nodes.

\n

These CIDR blocks are determined by configuring your Container Network Interface (CNI)\n plugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn't\n available for on-premises and edge locations.

\n

Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, \n 10.2.0.0/16).

\n

It must satisfy the following requirements:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

A network CIDR that can contain pods that run Kubernetes webhooks on hybrid nodes.

\n

These CIDR blocks are determined by configuring your Container Network Interface (CNI)\n plugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn't\n available for on-premises and edge locations.

\n

Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, \n 10.2.0.0/16).

\n

It must satisfy the following requirements:

\n " + } + }, + "com.amazonaws.eks#RemotePodNetworkList": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#RemotePodNetwork" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.eks#ResolveConflicts": { + "type": "enum", + "members": { + "OVERWRITE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OVERWRITE" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "PRESERVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRESERVE" + } + } + } + }, + "com.amazonaws.eks#ResourceInUseException": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon EKS cluster associated with the exception.

" + } + }, + "nodegroupName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon EKS managed node group associated with the exception.

" + } + }, + "addonName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The specified add-on name is in use.

" + } + }, + "message": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon EKS message associated with the exception.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The specified resource is in use.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.eks#ResourceLimitExceededException": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon EKS cluster associated with the exception.

" + } + }, + "nodegroupName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon EKS managed node group associated with the exception.

" + } + }, + "subscriptionId": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon EKS subscription ID with the exception.

" + } + }, + "message": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon EKS message associated with the exception.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

You have encountered a service limit on the specified resource.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.eks#ResourceNotFoundException": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon EKS cluster associated with the exception.

" + } + }, + "nodegroupName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon EKS managed node group associated with the exception.

" + } + }, + "fargateProfileName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Fargate profile associated with the exception.

" + } + }, + "addonName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon EKS add-on name associated with the exception.

" + } + }, + "subscriptionId": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon EKS subscription ID with the exception.

" + } + }, + "message": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon EKS message associated with the exception.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The specified resource could not be found. You can view your available clusters with\n ListClusters. You can view your available managed node groups with\n ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.eks#ResourcePropagationDelayException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

Required resources (such as service-linked roles) were created and are still\n propagating. Retry later.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Required resources (such as service-linked roles) were created and are still\n propagating. Retry later.

", + "smithy.api#error": "client", + "smithy.api#httpError": 428 + } + }, + "com.amazonaws.eks#RoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.eks#ServerException": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon EKS cluster associated with the exception.

" + } + }, + "nodegroupName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon EKS managed node group associated with the exception.

" + } + }, + "addonName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon EKS add-on name associated with the exception.

" + } + }, + "subscriptionId": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon EKS subscription ID with the exception.

" + } + }, + "message": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

These errors are usually caused by a server-side issue.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

These errors are usually caused by a server-side issue.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.eks#ServiceUnavailableException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The request has failed due to a temporary failure of the server.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The service is unavailable. Back off and retry the operation.

", + "smithy.api#error": "server", + "smithy.api#httpError": 503 + } + }, + "com.amazonaws.eks#StorageConfigRequest": { + "type": "structure", + "members": { + "blockStorage": { + "target": "com.amazonaws.eks#BlockStorage", + "traits": { + "smithy.api#documentation": "

Request to configure EBS Block Storage settings for your EKS Auto Mode cluster.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Request to update the configuration of the storage capability of your EKS Auto Mode cluster. For example, enable the capability. For more information, see EKS Auto Mode block storage capability in the EKS User Guide.

" + } + }, + "com.amazonaws.eks#StorageConfigResponse": { + "type": "structure", + "members": { + "blockStorage": { + "target": "com.amazonaws.eks#BlockStorage", + "traits": { + "smithy.api#documentation": "

Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Indicates the status of the request to update the block storage capability of your EKS Auto Mode cluster.

" + } + }, + "com.amazonaws.eks#String": { + "type": "string" + }, + "com.amazonaws.eks#StringList": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#String" + } + }, + "com.amazonaws.eks#SupportType": { + "type": "enum", + "members": { + "STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STANDARD" + } + }, + "EXTENDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXTENDED" + } + } + } + }, + "com.amazonaws.eks#TagKey": { + "type": "string", + "traits": { + "smithy.api#documentation": "

One part of a key-value pair that make up a tag. A key is a general label\n that acts like a category for more specific tag values.

", + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.eks#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.eks#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.eks#TagKey" + }, + "value": { + "target": "com.amazonaws.eks#TagValue" + }, + "traits": { + "smithy.api#documentation": "

The metadata that you apply to a resource to help you categorize and organize them.\n Each tag consists of a key and an optional value. You define them.

\n

The following basic restrictions apply to tags:

\n ", + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.eks#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.eks#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#BadRequestException" + }, + { + "target": "com.amazonaws.eks#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Associates the specified tags to an Amazon EKS resource with the specified\n resourceArn. If existing tags on a resource are not specified in the\n request parameters, they aren't changed. When a resource is deleted, the tags associated\n with that resource are also deleted. Tags that you create for Amazon EKS\n resources don't propagate to any other resources associated with the cluster. For\n example, if you tag a cluster with this operation, that tag doesn't automatically\n propagate to the subnets and nodes associated with the cluster.

", + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.eks#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to add tags to.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.eks#TagMap", + "traits": { + "smithy.api#documentation": "

Metadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#TagValue": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The optional part of a key-value pair that make up a tag. A value acts as\n a descriptor within a tag category (key).

", + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.eks#Taint": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.eks#taintKey", + "traits": { + "smithy.api#documentation": "

The key of the taint.

" + } + }, + "value": { + "target": "com.amazonaws.eks#taintValue", + "traits": { + "smithy.api#documentation": "

The value of the taint.

" + } + }, + "effect": { + "target": "com.amazonaws.eks#TaintEffect", + "traits": { + "smithy.api#documentation": "

The effect of the taint.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A property that allows a node to repel a Pod. For more information, see\n Node taints on\n managed node groups in the Amazon EKS User Guide.

" + } + }, + "com.amazonaws.eks#TaintEffect": { + "type": "enum", + "members": { + "NO_SCHEDULE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_SCHEDULE" + } + }, + "NO_EXECUTE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_EXECUTE" + } + }, + "PREFER_NO_SCHEDULE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PREFER_NO_SCHEDULE" + } + } + } + }, + "com.amazonaws.eks#Timestamp": { + "type": "timestamp" + }, + "com.amazonaws.eks#UnsupportedAvailabilityZoneException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

At least one of your specified cluster subnets is in an Availability Zone that does\n not support Amazon EKS. The exception output specifies the supported\n Availability Zones for your account, from which you can choose subnets for your\n cluster.

" + } + }, + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon EKS cluster associated with the exception.

" + } + }, + "nodegroupName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon EKS managed node group associated with the exception.

" + } + }, + "validZones": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

The supported Availability Zones for your account. Choose subnets in these\n Availability Zones for your cluster.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

At least one of your specified cluster subnets is in an Availability Zone that does\n not support Amazon EKS. The exception output specifies the supported\n Availability Zones for your account, from which you can choose subnets for your\n cluster.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.eks#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.eks#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#BadRequestException" + }, + { + "target": "com.amazonaws.eks#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes specified tags from an Amazon EKS resource.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.eks#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to delete tags from.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.eks#TagKeyList", + "traits": { + "smithy.api#documentation": "

The keys of the tags to remove.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#Update": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

A UUID that is used to track the update.

" + } + }, + "status": { + "target": "com.amazonaws.eks#UpdateStatus", + "traits": { + "smithy.api#documentation": "

The current status of the update.

" + } + }, + "type": { + "target": "com.amazonaws.eks#UpdateType", + "traits": { + "smithy.api#documentation": "

The type of the update.

" + } + }, + "params": { + "target": "com.amazonaws.eks#UpdateParams", + "traits": { + "smithy.api#documentation": "

A key-value map that contains the parameters associated with the update.

" + } + }, + "createdAt": { + "target": "com.amazonaws.eks#Timestamp", + "traits": { + "smithy.api#documentation": "

The Unix epoch timestamp at object creation.

" + } + }, + "errors": { + "target": "com.amazonaws.eks#ErrorDetails", + "traits": { + "smithy.api#documentation": "

Any errors associated with a Failed update.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object representing an asynchronous update.

" + } + }, + "com.amazonaws.eks#UpdateAccessConfigRequest": { + "type": "structure", + "members": { + "authenticationMode": { + "target": "com.amazonaws.eks#AuthenticationMode", + "traits": { + "smithy.api#documentation": "

The desired authentication mode for the cluster.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The access configuration information for the cluster.

" + } + }, + "com.amazonaws.eks#UpdateAccessEntry": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#UpdateAccessEntryRequest" + }, + "output": { + "target": "com.amazonaws.eks#UpdateAccessEntryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an access entry.

", + "smithy.api#http": { + "method": "POST", + "uri": "/clusters/{clusterName}/access-entries/{principalArn}", + "code": 200 + } + } + }, + "com.amazonaws.eks#UpdateAccessEntryRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of your cluster.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "principalArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM principal for the AccessEntry.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "kubernetesGroups": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

The value for name that you've specified for kind: Group as\n a subject in a Kubernetes RoleBinding or\n ClusterRoleBinding object. Amazon EKS doesn't confirm that the\n value for name exists in any bindings on your cluster. You can specify one\n or more names.

\n

Kubernetes authorizes the principalArn of the access entry to access any\n cluster objects that you've specified in a Kubernetes Role or\n ClusterRole object that is also specified in a binding's\n roleRef. For more information about creating Kubernetes\n RoleBinding, ClusterRoleBinding, Role, or\n ClusterRole objects, see Using RBAC\n Authorization in the Kubernetes documentation.

\n

If you want Amazon EKS to authorize the principalArn (instead of,\n or in addition to Kubernetes authorizing the principalArn), you can associate\n one or more access policies to the access entry using\n AssociateAccessPolicy. If you associate any access policies, the\n principalARN has all permissions assigned in the associated access\n policies and all permissions in any Kubernetes Role or ClusterRole\n objects that the group names are bound to.

" + } + }, + "clientRequestToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.

", + "smithy.api#idempotencyToken": {} + } + }, + "username": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The username to authenticate to Kubernetes with. We recommend not specifying a username and\n letting Amazon EKS specify it for you. For more information about the value\n Amazon EKS specifies for you, or constraints before specifying your own\n username, see Creating\n access entries in the Amazon EKS User Guide.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#UpdateAccessEntryResponse": { + "type": "structure", + "members": { + "accessEntry": { + "target": "com.amazonaws.eks#AccessEntry", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM principal for the AccessEntry.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#UpdateAddon": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#UpdateAddonRequest" + }, + "output": { + "target": "com.amazonaws.eks#UpdateAddonResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceInUseException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an Amazon EKS add-on.

", + "smithy.api#http": { + "method": "POST", + "uri": "/clusters/{clusterName}/addons/{addonName}/update", + "code": 200 + } + } + }, + "com.amazonaws.eks#UpdateAddonRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#ClusterName", + "traits": { + "smithy.api#documentation": "

The name of your cluster.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "addonName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the add-on. The name must match one of the names returned by \n ListAddons\n .

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "addonVersion": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The version of the add-on. The version must match one of the versions returned by \n DescribeAddonVersions\n .

" + } + }, + "serviceAccountRoleArn": { + "target": "com.amazonaws.eks#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account. The role must be assigned the IAM permissions required by the add-on. If you don't specify an existing IAM role, then the add-on uses the\n permissions assigned to the node IAM role. For more information, see Amazon EKS node IAM role in the Amazon EKS User Guide.

\n \n

To specify an existing IAM role, you must have an IAM OpenID Connect (OIDC) provider created for\n your cluster. For more information, see Enabling\n IAM roles for service accounts on your cluster in the\n Amazon EKS User Guide.

\n " + } + }, + "resolveConflicts": { + "target": "com.amazonaws.eks#ResolveConflicts", + "traits": { + "smithy.api#documentation": "

How to resolve field value conflicts for an Amazon EKS add-on if you've\n changed a value from the Amazon EKS default value. Conflicts are handled based\n on the option you choose:

\n " + } + }, + "clientRequestToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.

", + "smithy.api#idempotencyToken": {} + } + }, + "configurationValues": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The set of configuration values for the add-on that's created. The values that you\n provide are validated against the schema returned by\n DescribeAddonConfiguration.

" + } + }, + "podIdentityAssociations": { + "target": "com.amazonaws.eks#AddonPodIdentityAssociationsList", + "traits": { + "smithy.api#documentation": "

An array of Pod Identity Assocations to be updated. Each EKS Pod Identity association maps a Kubernetes service account to an IAM Role. If this value is left blank, no change. If an empty array is provided, existing Pod Identity Assocations owned by the Addon are deleted.

\n

For more information, see Attach an IAM Role to an Amazon EKS add-on using Pod Identity in the EKS User Guide.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#UpdateAddonResponse": { + "type": "structure", + "members": { + "update": { + "target": "com.amazonaws.eks#Update" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#UpdateClusterConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#UpdateClusterConfigRequest" + }, + "output": { + "target": "com.amazonaws.eks#UpdateClusterConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceInUseException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an Amazon EKS cluster configuration. Your cluster continues to\n function during the update. The response output includes an update ID that you can use\n to track the status of your cluster update with DescribeUpdate\"/>.

\n

You can use this API operation to enable or disable exporting the Kubernetes control plane\n logs for your cluster to CloudWatch Logs. By default, cluster control plane logs\n aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster control plane logs in the\n \n Amazon EKS User Guide\n .

\n \n

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to\n exported control plane logs. For more information, see CloudWatch\n Pricing.

\n \n

You can also use this API operation to enable or disable public and private access to\n your cluster's Kubernetes API server endpoint. By default, public access is enabled, and\n private access is disabled. For more information, see Amazon EKS cluster endpoint access control in the\n \n Amazon EKS User Guide\n .

\n

You can also use this API operation to choose different subnets and security groups\n for the cluster. You must specify at least two subnets that are in different\n Availability Zones. You can't change which VPC the subnets are from, the subnets must be\n in the same VPC as the subnets that the cluster was created with. For more information\n about the VPC requirements, see https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html in the \n Amazon EKS User Guide\n .

\n

You can also use this API operation to enable or disable ARC zonal shift. If zonal shift is enabled, Amazon Web Services\n configures zonal autoshift for the cluster.

\n

Cluster updates are asynchronous, and they should finish within a few minutes. During\n an update, the cluster status moves to UPDATING (this status transition is\n eventually consistent). When the update is complete (either Failed or\n Successful), the cluster status moves to Active.

", + "smithy.api#http": { + "method": "POST", + "uri": "/clusters/{name}/update-config", + "code": 200 + } + } + }, + "com.amazonaws.eks#UpdateClusterConfigRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon EKS cluster to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "resourcesVpcConfig": { + "target": "com.amazonaws.eks#VpcConfigRequest" + }, + "logging": { + "target": "com.amazonaws.eks#Logging", + "traits": { + "smithy.api#documentation": "

Enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS cluster control plane logs in the\n \n Amazon EKS User Guide\n .

\n \n

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to\n exported control plane logs. For more information, see CloudWatch\n Pricing.

\n " + } + }, + "clientRequestToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.

", + "smithy.api#idempotencyToken": {} + } + }, + "accessConfig": { + "target": "com.amazonaws.eks#UpdateAccessConfigRequest", + "traits": { + "smithy.api#documentation": "

The access configuration for the cluster.

" + } + }, + "upgradePolicy": { + "target": "com.amazonaws.eks#UpgradePolicyRequest", + "traits": { + "smithy.api#documentation": "

You can enable or disable extended support for clusters currently on standard support. You cannot disable extended support once it starts. You must enable extended support before your cluster exits standard support.

" + } + }, + "zonalShiftConfig": { + "target": "com.amazonaws.eks#ZonalShiftConfigRequest", + "traits": { + "smithy.api#documentation": "

Enable or disable ARC zonal shift for the cluster. If zonal shift is enabled, Amazon Web Services\n configures zonal autoshift for the cluster.

\n

Zonal shift is a feature of\n Amazon Application Recovery Controller (ARC). ARC zonal shift is designed to be a temporary measure that allows you to move\n traffic for a resource away from an impaired AZ until the zonal shift expires or you cancel\n it. You can extend the zonal shift if necessary.

\n

You can start a zonal shift for an EKS cluster, or you can allow Amazon Web Services to do it for you\n by enabling zonal autoshift. This shift updates the flow of\n east-to-west network traffic in your cluster to only consider network endpoints for Pods\n running on worker nodes in healthy AZs. Additionally, any ALB or NLB handling ingress\n traffic for applications in your EKS cluster will automatically route traffic to targets in\n the healthy AZs. For more information about zonal shift in EKS, see Learn about Amazon Application Recovery Controller (ARC)\n Zonal Shift in Amazon EKS in the\n \n Amazon EKS User Guide\n .

" + } + }, + "computeConfig": { + "target": "com.amazonaws.eks#ComputeConfigRequest", + "traits": { + "smithy.api#documentation": "

Update the configuration of the compute capability of your EKS Auto Mode cluster. For example, enable the capability.

" + } + }, + "kubernetesNetworkConfig": { + "target": "com.amazonaws.eks#KubernetesNetworkConfigRequest" + }, + "storageConfig": { + "target": "com.amazonaws.eks#StorageConfigRequest", + "traits": { + "smithy.api#documentation": "

Update the configuration of the block storage capability of your EKS Auto Mode cluster. For example, enable the capability.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#UpdateClusterConfigResponse": { + "type": "structure", + "members": { + "update": { + "target": "com.amazonaws.eks#Update" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#UpdateClusterVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#UpdateClusterVersionRequest" + }, + "output": { + "target": "com.amazonaws.eks#UpdateClusterVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceInUseException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an Amazon EKS cluster to the specified Kubernetes version. Your cluster\n continues to function during the update. The response output includes an update ID that\n you can use to track the status of your cluster update with the DescribeUpdate API operation.

\n

Cluster updates are asynchronous, and they should finish within a few minutes. During\n an update, the cluster status moves to UPDATING (this status transition is\n eventually consistent). When the update is complete (either Failed or\n Successful), the cluster status moves to Active.

\n

If your cluster has managed node groups attached to it, all of your node groups’ Kubernetes\n versions must match the cluster’s Kubernetes version in order to update the cluster to a new\n Kubernetes version.

", + "smithy.api#http": { + "method": "POST", + "uri": "/clusters/{name}/updates", + "code": 200 + } + } + }, + "com.amazonaws.eks#UpdateClusterVersionRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon EKS cluster to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The desired Kubernetes version following a successful update.

", + "smithy.api#required": {} + } + }, + "clientRequestToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#UpdateClusterVersionResponse": { + "type": "structure", + "members": { + "update": { + "target": "com.amazonaws.eks#Update", + "traits": { + "smithy.api#documentation": "

The full description of the specified update

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#UpdateEksAnywhereSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#UpdateEksAnywhereSubscriptionRequest" + }, + "output": { + "target": "com.amazonaws.eks#UpdateEksAnywhereSubscriptionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Update an EKS Anywhere Subscription. Only auto renewal and tags can be updated after\n subscription creation.

", + "smithy.api#http": { + "method": "POST", + "uri": "/eks-anywhere-subscriptions/{id}", + "code": 200 + } + } + }, + "com.amazonaws.eks#UpdateEksAnywhereSubscriptionRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The ID of the subscription.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "autoRenew": { + "target": "com.amazonaws.eks#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A boolean indicating whether or not to automatically renew the subscription.

", + "smithy.api#required": {} + } + }, + "clientRequestToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier to ensure the idempotency of the request.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#UpdateEksAnywhereSubscriptionResponse": { + "type": "structure", + "members": { + "subscription": { + "target": "com.amazonaws.eks#EksAnywhereSubscription", + "traits": { + "smithy.api#documentation": "

The full description of the updated subscription.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#UpdateLabelsPayload": { + "type": "structure", + "members": { + "addOrUpdateLabels": { + "target": "com.amazonaws.eks#labelsMap", + "traits": { + "smithy.api#documentation": "

The Kubernetes labels to add or update.

" + } + }, + "removeLabels": { + "target": "com.amazonaws.eks#labelsKeyList", + "traits": { + "smithy.api#documentation": "

The Kubernetes labels to remove.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object representing a Kubernetes label change for a managed node\n group.

" + } + }, + "com.amazonaws.eks#UpdateNodegroupConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#UpdateNodegroupConfigRequest" + }, + "output": { + "target": "com.amazonaws.eks#UpdateNodegroupConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceInUseException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an Amazon EKS managed node group configuration. Your node group\n continues to function during the update. The response output includes an update ID that\n you can use to track the status of your node group update with the DescribeUpdate API operation. Currently you can update the Kubernetes labels\n for a node group or the scaling configuration.

", + "smithy.api#http": { + "method": "POST", + "uri": "/clusters/{clusterName}/node-groups/{nodegroupName}/update-config", + "code": 200 + } + } + }, + "com.amazonaws.eks#UpdateNodegroupConfigRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of your cluster.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nodegroupName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the managed node group to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "labels": { + "target": "com.amazonaws.eks#UpdateLabelsPayload", + "traits": { + "smithy.api#documentation": "

The Kubernetes labels to apply to the nodes in the node group after the\n update.

" + } + }, + "taints": { + "target": "com.amazonaws.eks#UpdateTaintsPayload", + "traits": { + "smithy.api#documentation": "

The Kubernetes taints to be applied to the nodes in the node group after the update. For\n more information, see Node taints on\n managed node groups.

" + } + }, + "scalingConfig": { + "target": "com.amazonaws.eks#NodegroupScalingConfig", + "traits": { + "smithy.api#documentation": "

The scaling configuration details for the Auto Scaling group after the update.

" + } + }, + "updateConfig": { + "target": "com.amazonaws.eks#NodegroupUpdateConfig", + "traits": { + "smithy.api#documentation": "

The node group update configuration.

" + } + }, + "nodeRepairConfig": { + "target": "com.amazonaws.eks#NodeRepairConfig", + "traits": { + "smithy.api#documentation": "

The node auto repair configuration for the node group.

" + } + }, + "clientRequestToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#UpdateNodegroupConfigResponse": { + "type": "structure", + "members": { + "update": { + "target": "com.amazonaws.eks#Update" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#UpdateNodegroupVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#UpdateNodegroupVersionRequest" + }, + "output": { + "target": "com.amazonaws.eks#UpdateNodegroupVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceInUseException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the Kubernetes version or AMI version of an Amazon EKS managed node\n group.

\n

You can update a node group using a launch template only if the node group was\n originally deployed with a launch template. If you need to update a custom AMI in a node\n group that was deployed with a launch template, then update your custom AMI, specify the\n new ID in a new version of the launch template, and then update the node group to the\n new version of the launch template.

\n

If you update without a launch template, then you can update to the latest available\n AMI version of a node group's current Kubernetes version by not specifying a Kubernetes version in\n the request. You can update to the latest AMI version of your cluster's current Kubernetes\n version by specifying your cluster's Kubernetes version in the request. For information about\n Linux versions, see Amazon EKS optimized Amazon Linux AMI versions in the\n Amazon EKS User Guide. For information about Windows versions, see Amazon EKS optimized Windows AMI versions in the\n Amazon EKS User Guide.

\n

You cannot roll back a node group to an earlier Kubernetes version or AMI version.

\n

When a node in a managed node group is terminated due to a scaling action or update,\n every Pod on that node is drained first. Amazon EKS attempts to\n drain the nodes gracefully and will fail if it is unable to do so. You can\n force the update if Amazon EKS is unable to drain the nodes as\n a result of a Pod disruption budget issue.

", + "smithy.api#http": { + "method": "POST", + "uri": "/clusters/{clusterName}/node-groups/{nodegroupName}/update-version", + "code": 200 + } + } + }, + "com.amazonaws.eks#UpdateNodegroupVersionRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of your cluster.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nodegroupName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the managed node group to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Kubernetes version to update to. If no version is specified, then the Kubernetes version of\n the node group does not change. You can specify the Kubernetes version of the cluster to\n update the node group to the latest AMI version of the cluster's Kubernetes version.\n If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify version,\n or the node group update will fail. For more information about using launch templates with Amazon EKS, see Customizing managed nodes with launch templates in the Amazon EKS User Guide.

" + } + }, + "releaseVersion": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The AMI version of the Amazon EKS optimized AMI to use for the update. By\n default, the latest available AMI version for the node group's Kubernetes version is used.\n For information about Linux versions, see Amazon EKS optimized Amazon Linux AMI versions in the Amazon EKS User Guide. Amazon EKS managed node groups support the November 2022 and later releases of the\n Windows AMIs. For information about Windows versions, see Amazon EKS optimized Windows AMI versions in the\n Amazon EKS User Guide.

\n

If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify \n releaseVersion, or the node group update will fail.\n For more information about using launch templates with Amazon EKS, see Customizing managed nodes with launch templates in the Amazon EKS User Guide.

" + } + }, + "launchTemplate": { + "target": "com.amazonaws.eks#LaunchTemplateSpecification", + "traits": { + "smithy.api#documentation": "

An object representing a node group's launch template specification. You can only\n update a node group using a launch template if the node group was originally deployed\n with a launch template.

" + } + }, + "force": { + "target": "com.amazonaws.eks#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Force the update if any Pod on the existing node group can't be drained\n due to a Pod disruption budget issue. If an update fails because all Pods\n can't be drained, you can force the update after it fails to terminate the old node\n whether or not any Pod is running on the node.

" + } + }, + "clientRequestToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#UpdateNodegroupVersionResponse": { + "type": "structure", + "members": { + "update": { + "target": "com.amazonaws.eks#Update" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#UpdateParam": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.eks#UpdateParamType", + "traits": { + "smithy.api#documentation": "

The keys associated with an update request.

" + } + }, + "value": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The value of the keys submitted as part of an update request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object representing the details of an update request.

" + } + }, + "com.amazonaws.eks#UpdateParamType": { + "type": "enum", + "members": { + "VERSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Version" + } + }, + "PLATFORM_VERSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PlatformVersion" + } + }, + "ENDPOINT_PRIVATE_ACCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EndpointPrivateAccess" + } + }, + "ENDPOINT_PUBLIC_ACCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EndpointPublicAccess" + } + }, + "CLUSTER_LOGGING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ClusterLogging" + } + }, + "DESIRED_SIZE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DesiredSize" + } + }, + "LABELS_TO_ADD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LabelsToAdd" + } + }, + "LABELS_TO_REMOVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LabelsToRemove" + } + }, + "TAINTS_TO_ADD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TaintsToAdd" + } + }, + "TAINTS_TO_REMOVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TaintsToRemove" + } + }, + "MAX_SIZE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MaxSize" + } + }, + "MIN_SIZE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MinSize" + } + }, + "RELEASE_VERSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ReleaseVersion" + } + }, + "PUBLIC_ACCESS_CIDRS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PublicAccessCidrs" + } + }, + "LAUNCH_TEMPLATE_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LaunchTemplateName" + } + }, + "LAUNCH_TEMPLATE_VERSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LaunchTemplateVersion" + } + }, + "IDENTITY_PROVIDER_CONFIG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IdentityProviderConfig" + } + }, + "ENCRYPTION_CONFIG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EncryptionConfig" + } + }, + "ADDON_VERSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AddonVersion" + } + }, + "SERVICE_ACCOUNT_ROLE_ARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ServiceAccountRoleArn" + } + }, + "RESOLVE_CONFLICTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ResolveConflicts" + } + }, + "MAX_UNAVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MaxUnavailable" + } + }, + "MAX_UNAVAILABLE_PERCENTAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MaxUnavailablePercentage" + } + }, + "NODE_REPAIR_ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NodeRepairEnabled" + } + }, + "CONFIGURATION_VALUES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ConfigurationValues" + } + }, + "SECURITY_GROUPS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SecurityGroups" + } + }, + "SUBNETS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Subnets" + } + }, + "AUTHENTICATION_MODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AuthenticationMode" + } + }, + "POD_IDENTITY_ASSOCIATIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PodIdentityAssociations" + } + }, + "UPGRADE_POLICY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpgradePolicy" + } + }, + "ZONAL_SHIFT_CONFIG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZonalShiftConfig" + } + }, + "COMPUTE_CONFIG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ComputeConfig" + } + }, + "STORAGE_CONFIG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StorageConfig" + } + }, + "KUBERNETES_NETWORK_CONFIG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KubernetesNetworkConfig" + } + } + } + }, + "com.amazonaws.eks#UpdateParams": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#UpdateParam" + } + }, + "com.amazonaws.eks#UpdatePodIdentityAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#UpdatePodIdentityAssociationRequest" + }, + "output": { + "target": "com.amazonaws.eks#UpdatePodIdentityAssociationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a EKS Pod Identity association. Only the IAM role can be changed; an association can't be moved\n between clusters, namespaces, or service accounts. If you need to edit the namespace\n or service account, you need to delete the association and then create a new\n association with your desired settings.

", + "smithy.api#http": { + "method": "POST", + "uri": "/clusters/{clusterName}/pod-identity-associations/{associationId}", + "code": 200 + } + } + }, + "com.amazonaws.eks#UpdatePodIdentityAssociationRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the cluster that you want to update the association in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "associationId": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The ID of the association to be updated.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The new IAM role to change the

" + } + }, + "clientRequestToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#UpdatePodIdentityAssociationResponse": { + "type": "structure", + "members": { + "association": { + "target": "com.amazonaws.eks#PodIdentityAssociation", + "traits": { + "smithy.api#documentation": "

The full description of the EKS Pod Identity association that was updated.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#UpdateStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Cancelled" + } + }, + "SUCCESSFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Successful" + } + } + } + }, + "com.amazonaws.eks#UpdateTaintsPayload": { + "type": "structure", + "members": { + "addOrUpdateTaints": { + "target": "com.amazonaws.eks#taintsList", + "traits": { + "smithy.api#documentation": "

Kubernetes taints to be added or updated.

" + } + }, + "removeTaints": { + "target": "com.amazonaws.eks#taintsList", + "traits": { + "smithy.api#documentation": "

Kubernetes taints to remove.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object representing the details of an update to a taints payload. For more\n information, see Node taints on\n managed node groups in the Amazon EKS User Guide.

" + } + }, + "com.amazonaws.eks#UpdateType": { + "type": "enum", + "members": { + "VERSION_UPDATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VersionUpdate" + } + }, + "ENDPOINT_ACCESS_UPDATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EndpointAccessUpdate" + } + }, + "LOGGING_UPDATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LoggingUpdate" + } + }, + "CONFIG_UPDATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ConfigUpdate" + } + }, + "ASSOCIATE_IDENTITY_PROVIDER_CONFIG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AssociateIdentityProviderConfig" + } + }, + "DISASSOCIATE_IDENTITY_PROVIDER_CONFIG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DisassociateIdentityProviderConfig" + } + }, + "ASSOCIATE_ENCRYPTION_CONFIG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AssociateEncryptionConfig" + } + }, + "ADDON_UPDATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AddonUpdate" + } + }, + "VPC_CONFIG_UPDATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VpcConfigUpdate" + } + }, + "ACCESS_CONFIG_UPDATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AccessConfigUpdate" + } + }, + "UPGRADE_POLICY_UPDATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpgradePolicyUpdate" + } + }, + "ZONAL_SHIFT_CONFIG_UPDATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZonalShiftConfigUpdate" + } + }, + "AUTO_MODE_UPDATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AutoModeUpdate" + } + } + } + }, + "com.amazonaws.eks#UpgradePolicyRequest": { + "type": "structure", + "members": { + "supportType": { + "target": "com.amazonaws.eks#SupportType", + "traits": { + "smithy.api#documentation": "

If the cluster is set to EXTENDED, it will enter extended support at the end of standard support. If the cluster is set to STANDARD, it will be automatically upgraded at the end of standard support.

\n

\n Learn more about EKS Extended Support in the EKS User Guide.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The support policy to use for the cluster. Extended support allows you to remain on specific Kubernetes versions for longer. Clusters in extended support have higher costs. The default value is EXTENDED. Use STANDARD to disable extended support.

\n

\n Learn more about EKS Extended Support in the EKS User Guide.\n

" + } + }, + "com.amazonaws.eks#UpgradePolicyResponse": { + "type": "structure", + "members": { + "supportType": { + "target": "com.amazonaws.eks#SupportType", + "traits": { + "smithy.api#documentation": "

If the cluster is set to EXTENDED, it will enter extended support at the end of standard support. If the cluster is set to STANDARD, it will be automatically upgraded at the end of standard support.

\n

\n Learn more about EKS Extended Support in the EKS User Guide.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This value indicates if extended support is enabled or disabled for the cluster.

\n

\n Learn more about EKS Extended Support in the EKS User Guide.\n

" + } + }, + "com.amazonaws.eks#VpcConfigRequest": { + "type": "structure", + "members": { + "subnetIds": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

Specify subnets for your Amazon EKS nodes. Amazon EKS creates\n cross-account elastic network interfaces in these subnets to allow communication between\n your nodes and the Kubernetes control plane.

" + } + }, + "securityGroupIds": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

Specify one or more security groups for the cross-account elastic network interfaces\n that Amazon EKS creates to use that allow communication between your nodes and\n the Kubernetes control plane. If you don't specify any security groups, then familiarize\n yourself with the difference between Amazon EKS defaults for clusters deployed\n with Kubernetes. For more information, see Amazon EKS security group\n considerations in the \n Amazon EKS User Guide\n .

" + } + }, + "endpointPublicAccess": { + "target": "com.amazonaws.eks#BoxedBoolean", + "traits": { + "smithy.api#documentation": "

Set this value to false to disable public access to your cluster's Kubernetes\n API server endpoint. If you disable public access, your cluster's Kubernetes API server can\n only receive requests from within the cluster VPC. The default value for this parameter\n is true, which enables public access for your Kubernetes API server. For more\n information, see Amazon EKS cluster endpoint access control in\n the \n Amazon EKS User Guide\n .

" + } + }, + "endpointPrivateAccess": { + "target": "com.amazonaws.eks#BoxedBoolean", + "traits": { + "smithy.api#documentation": "

Set this value to true to enable private access for your cluster's Kubernetes\n API server endpoint. If you enable private access, Kubernetes API requests from within your\n cluster's VPC use the private VPC endpoint. The default value for this parameter is\n false, which disables private access for your Kubernetes API server. If you\n disable private access and you have nodes or Fargate pods in the\n cluster, then ensure that publicAccessCidrs includes the necessary CIDR\n blocks for communication with the nodes or Fargate pods. For more\n information, see Amazon EKS cluster endpoint access control in\n the \n Amazon EKS User Guide\n .

" + } + }, + "publicAccessCidrs": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

The CIDR blocks that are allowed access to your cluster's public Kubernetes API server\n endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that\n you specify is denied. The default value is 0.0.0.0/0. If you've disabled\n private endpoint access, make sure that you specify the necessary CIDR blocks for every\n node and Fargate\n Pod in the cluster. For more information, see Amazon EKS cluster endpoint access control in the\n \n Amazon EKS User Guide\n .

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object representing the VPC configuration to use for an Amazon EKS\n cluster.

" + } + }, + "com.amazonaws.eks#VpcConfigResponse": { + "type": "structure", + "members": { + "subnetIds": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

The subnets associated with your cluster.

" + } + }, + "securityGroupIds": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

The security groups associated with the cross-account elastic network interfaces that\n are used to allow communication between your nodes and the Kubernetes control plane.

" + } + }, + "clusterSecurityGroupId": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The cluster security group that was created by Amazon EKS for the cluster.\n Managed node groups use this security group for control-plane-to-data-plane\n communication.

" + } + }, + "vpcId": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The VPC associated with your cluster.

" + } + }, + "endpointPublicAccess": { + "target": "com.amazonaws.eks#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the public API server endpoint is enabled.

" + } + }, + "endpointPrivateAccess": { + "target": "com.amazonaws.eks#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

This parameter indicates whether the Amazon EKS private API server endpoint is\n enabled. If the Amazon EKS private API server endpoint is enabled, Kubernetes API\n requests that originate from within your cluster's VPC use the private VPC endpoint\n instead of traversing the internet. If this value is disabled and you have nodes or\n Fargate pods in the cluster, then ensure that\n publicAccessCidrs includes the necessary CIDR blocks for communication\n with the nodes or Fargate pods. For more information, see Amazon EKS cluster endpoint access control in the\n \n Amazon EKS User Guide\n .

" + } + }, + "publicAccessCidrs": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

The CIDR blocks that are allowed access to your cluster's public Kubernetes API server\n endpoint.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object representing an Amazon EKS cluster VPC configuration\n response.

" + } + }, + "com.amazonaws.eks#ZeroCapacity": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.eks#ZonalShiftConfigRequest": { + "type": "structure", + "members": { + "enabled": { + "target": "com.amazonaws.eks#BoxedBoolean", + "traits": { + "smithy.api#documentation": "

If zonal shift is enabled, Amazon Web Services configures zonal autoshift for the cluster.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for zonal shift for the cluster.

" + } + }, + "com.amazonaws.eks#ZonalShiftConfigResponse": { + "type": "structure", + "members": { + "enabled": { + "target": "com.amazonaws.eks#BoxedBoolean", + "traits": { + "smithy.api#documentation": "

Whether the zonal shift is enabled.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The status of zonal shift configuration for the cluster

" + } + }, + "com.amazonaws.eks#configStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + } + } + }, + "com.amazonaws.eks#labelKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + } + } + }, + "com.amazonaws.eks#labelValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + } + } + }, + "com.amazonaws.eks#labelsKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#String" + } + }, + "com.amazonaws.eks#labelsMap": { + "type": "map", + "key": { + "target": "com.amazonaws.eks#labelKey" + }, + "value": { + "target": "com.amazonaws.eks#labelValue" + } + }, + "com.amazonaws.eks#requiredClaimsKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + } + } + }, + "com.amazonaws.eks#requiredClaimsMap": { + "type": "map", + "key": { + "target": "com.amazonaws.eks#requiredClaimsKey" + }, + "value": { + "target": "com.amazonaws.eks#requiredClaimsValue" + } + }, + "com.amazonaws.eks#requiredClaimsValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 253 + } + } + }, + "com.amazonaws.eks#taintKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + } + } + }, + "com.amazonaws.eks#taintValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + } + } + }, + "com.amazonaws.eks#taintsList": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#Taint" + } + } + } +} \ No newline at end of file diff --git a/pkg/testdata/codegen/sdk-codegen/aws-models/elasticache.json b/pkg/testdata/codegen/sdk-codegen/aws-models/elasticache.json new file mode 100644 index 00000000..5d4356c7 --- /dev/null +++ b/pkg/testdata/codegen/sdk-codegen/aws-models/elasticache.json @@ -0,0 +1,16575 @@ +{ + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.elasticache#APICallRateForCustomerExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "APICallRateForCustomerExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The customer has exceeded the allowed rate of API calls.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#AZMode": { + "type": "enum", + "members": { + "SINGLE_AZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "single-az" + } + }, + "CROSS_AZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cross-az" + } + } + } + }, + "com.amazonaws.elasticache#AccessString": { + "type": "string", + "traits": { + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.elasticache#AddTagsToResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#AddTagsToResourceMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#TagListMessage" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#CacheClusterNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#CacheParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#CacheSecurityGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#CacheSubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidARNFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidReplicationGroupStateFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidServerlessCacheSnapshotStateFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidServerlessCacheStateFault" + }, + { + "target": "com.amazonaws.elasticache#ReplicationGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#ReservedCacheNodeNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#ServerlessCacheNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#ServerlessCacheSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#SnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#TagQuotaPerResourceExceeded" + }, + { + "target": "com.amazonaws.elasticache#UserGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#UserNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

A tag is a key-value pair where the key and value are case-sensitive. You can use tags\n to categorize and track all your ElastiCache resources, with the exception of global\n replication group. When you add or remove tags on replication groups, those actions will\n be replicated to all nodes in the replication group. For more information, see Resource-level permissions.

\n

For example, you can use cost-allocation tags to your ElastiCache resources, Amazon\n generates a cost allocation report as a comma-separated value (CSV) file with your usage\n and costs aggregated by your tags. You can apply tags that represent business categories\n (such as cost centers, application names, or owners) to organize your costs across\n multiple services.

\n

For more information, see Using Cost Allocation Tags in\n Amazon ElastiCache in the ElastiCache User\n Guide.

", + "smithy.api#examples": [ + { + "title": "AddTagsToResource", + "documentation": "Adds up to 10 tags, key/value pairs, to a cluster or snapshot resource.", + "input": { + "ResourceName": "arn:aws:elasticache:us-east-1:1234567890:cluster:my-mem-cluster", + "Tags": [ + { + "Value": "20150202", + "Key": "APIVersion" + }, + { + "Value": "ElastiCache", + "Key": "Service" + } + ] + }, + "output": { + "TagList": [ + { + "Value": "20150202", + "Key": "APIVersion" + }, + { + "Value": "ElastiCache", + "Key": "Service" + } + ] + } + } + ] + } + }, + "com.amazonaws.elasticache#AddTagsToResourceMessage": { + "type": "structure", + "members": { + "ResourceName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to which the tags are to be added, for\n example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or\n arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.\n ElastiCache resources are cluster and\n snapshot.

\n

For more information about ARNs, see Amazon Resource Names (ARNs)\n and Amazon Service Namespaces.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.elasticache#TagList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must\n be accompanied by a tag value, although null is accepted.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of an AddTagsToResource operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#AllowedNodeGroupId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4 + }, + "smithy.api#pattern": "^\\d+$" + } + }, + "com.amazonaws.elasticache#AllowedNodeTypeModificationsMessage": { + "type": "structure", + "members": { + "ScaleUpModifications": { + "target": "com.amazonaws.elasticache#NodeTypeList", + "traits": { + "smithy.api#documentation": "

A string list, each element of which specifies a cache node type which you can use to\n scale your cluster or replication group.

\n

When scaling up a Valkey or Redis OSS cluster or replication group using\n ModifyCacheCluster or ModifyReplicationGroup, use a value\n from this list for the CacheNodeType parameter.

" + } + }, + "ScaleDownModifications": { + "target": "com.amazonaws.elasticache#NodeTypeList", + "traits": { + "smithy.api#documentation": "

A string list, each element of which specifies a cache node type which you can use to\n scale your cluster or replication group. When scaling down a Valkey or Redis OSS cluster or\n replication group using ModifyCacheCluster or ModifyReplicationGroup, use a value from\n this list for the CacheNodeType parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the allowed node types you can use to modify your cluster or replication\n group.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#AmazonElastiCacheV9": { + "type": "service", + "version": "2015-02-02", + "operations": [ + { + "target": "com.amazonaws.elasticache#AddTagsToResource" + }, + { + "target": "com.amazonaws.elasticache#AuthorizeCacheSecurityGroupIngress" + }, + { + "target": "com.amazonaws.elasticache#BatchApplyUpdateAction" + }, + { + "target": "com.amazonaws.elasticache#BatchStopUpdateAction" + }, + { + "target": "com.amazonaws.elasticache#CompleteMigration" + }, + { + "target": "com.amazonaws.elasticache#CopyServerlessCacheSnapshot" + }, + { + "target": "com.amazonaws.elasticache#CopySnapshot" + }, + { + "target": "com.amazonaws.elasticache#CreateCacheCluster" + }, + { + "target": "com.amazonaws.elasticache#CreateCacheParameterGroup" + }, + { + "target": "com.amazonaws.elasticache#CreateCacheSecurityGroup" + }, + { + "target": "com.amazonaws.elasticache#CreateCacheSubnetGroup" + }, + { + "target": "com.amazonaws.elasticache#CreateGlobalReplicationGroup" + }, + { + "target": "com.amazonaws.elasticache#CreateReplicationGroup" + }, + { + "target": "com.amazonaws.elasticache#CreateServerlessCache" + }, + { + "target": "com.amazonaws.elasticache#CreateServerlessCacheSnapshot" + }, + { + "target": "com.amazonaws.elasticache#CreateSnapshot" + }, + { + "target": "com.amazonaws.elasticache#CreateUser" + }, + { + "target": "com.amazonaws.elasticache#CreateUserGroup" + }, + { + "target": "com.amazonaws.elasticache#DecreaseNodeGroupsInGlobalReplicationGroup" + }, + { + "target": "com.amazonaws.elasticache#DecreaseReplicaCount" + }, + { + "target": "com.amazonaws.elasticache#DeleteCacheCluster" + }, + { + "target": "com.amazonaws.elasticache#DeleteCacheParameterGroup" + }, + { + "target": "com.amazonaws.elasticache#DeleteCacheSecurityGroup" + }, + { + "target": "com.amazonaws.elasticache#DeleteCacheSubnetGroup" + }, + { + "target": "com.amazonaws.elasticache#DeleteGlobalReplicationGroup" + }, + { + "target": "com.amazonaws.elasticache#DeleteReplicationGroup" + }, + { + "target": "com.amazonaws.elasticache#DeleteServerlessCache" + }, + { + "target": "com.amazonaws.elasticache#DeleteServerlessCacheSnapshot" + }, + { + "target": "com.amazonaws.elasticache#DeleteSnapshot" + }, + { + "target": "com.amazonaws.elasticache#DeleteUser" + }, + { + "target": "com.amazonaws.elasticache#DeleteUserGroup" + }, + { + "target": "com.amazonaws.elasticache#DescribeCacheClusters" + }, + { + "target": "com.amazonaws.elasticache#DescribeCacheEngineVersions" + }, + { + "target": "com.amazonaws.elasticache#DescribeCacheParameterGroups" + }, + { + "target": "com.amazonaws.elasticache#DescribeCacheParameters" + }, + { + "target": "com.amazonaws.elasticache#DescribeCacheSecurityGroups" + }, + { + "target": "com.amazonaws.elasticache#DescribeCacheSubnetGroups" + }, + { + "target": "com.amazonaws.elasticache#DescribeEngineDefaultParameters" + }, + { + "target": "com.amazonaws.elasticache#DescribeEvents" + }, + { + "target": "com.amazonaws.elasticache#DescribeGlobalReplicationGroups" + }, + { + "target": "com.amazonaws.elasticache#DescribeReplicationGroups" + }, + { + "target": "com.amazonaws.elasticache#DescribeReservedCacheNodes" + }, + { + "target": "com.amazonaws.elasticache#DescribeReservedCacheNodesOfferings" + }, + { + "target": "com.amazonaws.elasticache#DescribeServerlessCaches" + }, + { + "target": "com.amazonaws.elasticache#DescribeServerlessCacheSnapshots" + }, + { + "target": "com.amazonaws.elasticache#DescribeServiceUpdates" + }, + { + "target": "com.amazonaws.elasticache#DescribeSnapshots" + }, + { + "target": "com.amazonaws.elasticache#DescribeUpdateActions" + }, + { + "target": "com.amazonaws.elasticache#DescribeUserGroups" + }, + { + "target": "com.amazonaws.elasticache#DescribeUsers" + }, + { + "target": "com.amazonaws.elasticache#DisassociateGlobalReplicationGroup" + }, + { + "target": "com.amazonaws.elasticache#ExportServerlessCacheSnapshot" + }, + { + "target": "com.amazonaws.elasticache#FailoverGlobalReplicationGroup" + }, + { + "target": "com.amazonaws.elasticache#IncreaseNodeGroupsInGlobalReplicationGroup" + }, + { + "target": "com.amazonaws.elasticache#IncreaseReplicaCount" + }, + { + "target": "com.amazonaws.elasticache#ListAllowedNodeTypeModifications" + }, + { + "target": "com.amazonaws.elasticache#ListTagsForResource" + }, + { + "target": "com.amazonaws.elasticache#ModifyCacheCluster" + }, + { + "target": "com.amazonaws.elasticache#ModifyCacheParameterGroup" + }, + { + "target": "com.amazonaws.elasticache#ModifyCacheSubnetGroup" + }, + { + "target": "com.amazonaws.elasticache#ModifyGlobalReplicationGroup" + }, + { + "target": "com.amazonaws.elasticache#ModifyReplicationGroup" + }, + { + "target": "com.amazonaws.elasticache#ModifyReplicationGroupShardConfiguration" + }, + { + "target": "com.amazonaws.elasticache#ModifyServerlessCache" + }, + { + "target": "com.amazonaws.elasticache#ModifyUser" + }, + { + "target": "com.amazonaws.elasticache#ModifyUserGroup" + }, + { + "target": "com.amazonaws.elasticache#PurchaseReservedCacheNodesOffering" + }, + { + "target": "com.amazonaws.elasticache#RebalanceSlotsInGlobalReplicationGroup" + }, + { + "target": "com.amazonaws.elasticache#RebootCacheCluster" + }, + { + "target": "com.amazonaws.elasticache#RemoveTagsFromResource" + }, + { + "target": "com.amazonaws.elasticache#ResetCacheParameterGroup" + }, + { + "target": "com.amazonaws.elasticache#RevokeCacheSecurityGroupIngress" + }, + { + "target": "com.amazonaws.elasticache#StartMigration" + }, + { + "target": "com.amazonaws.elasticache#TestFailover" + }, + { + "target": "com.amazonaws.elasticache#TestMigration" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "ElastiCache", + "arnNamespace": "elasticache", + "cloudFormationName": "ElastiCache", + "cloudTrailEventSource": "elasticache.amazonaws.com", + "endpointPrefix": "elasticache" + }, + "aws.auth#sigv4": { + "name": "elasticache" + }, + "aws.protocols#awsQuery": {}, + "smithy.api#documentation": "Amazon ElastiCache\n

Amazon ElastiCache is a web service that makes it easier to set up, operate, and scale\n a distributed cache in the cloud.

\n

With ElastiCache, customers get all of the benefits of a high-performance, in-memory\n cache with less of the administrative burden involved in launching and managing a\n distributed cache. The service makes setup, scaling, and cluster failure handling much\n simpler than in a self-managed cache deployment.

\n

In addition, through integration with Amazon CloudWatch, customers get enhanced\n visibility into the key performance statistics associated with their cache and can\n receive alarms if a part of their cache runs hot.

", + "smithy.api#title": "Amazon ElastiCache", + "smithy.api#xmlNamespace": { + "uri": "http://elasticache.amazonaws.com/doc/2015-02-02/" + }, + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://elasticache-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-us-gov" + ] + } + ], + "endpoint": { + "url": "https://elasticache.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://elasticache-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://elasticache.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://elasticache.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://elasticache.af-south-1.amazonaws.com" + } + }, + "params": { + "Region": "af-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://elasticache.ap-east-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://elasticache.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://elasticache.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://elasticache.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://elasticache.ap-south-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://elasticache.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://elasticache.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://elasticache.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://elasticache.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://elasticache.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://elasticache.eu-north-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://elasticache.eu-south-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://elasticache.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://elasticache.eu-west-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://elasticache.eu-west-3.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://elasticache.me-south-1.amazonaws.com" + } + }, + "params": { + "Region": "me-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://elasticache.sa-east-1.amazonaws.com" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://elasticache.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://elasticache-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://elasticache.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://elasticache-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://elasticache.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://elasticache-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://elasticache.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://elasticache-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://elasticache-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://elasticache.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://elasticache.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://elasticache.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://elasticache-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://elasticache-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://elasticache.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://elasticache.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://elasticache.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://elasticache.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://elasticache-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://elasticache.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://elasticache.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://elasticache.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://elasticache.us-iso-west-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://elasticache-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://elasticache.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://elasticache-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.elasticache#AuthTokenUpdateStatus": { + "type": "enum", + "members": { + "SETTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SETTING" + } + }, + "ROTATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROTATING" + } + } + } + }, + "com.amazonaws.elasticache#AuthTokenUpdateStrategyType": { + "type": "enum", + "members": { + "SET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SET" + } + }, + "ROTATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROTATE" + } + }, + "DELETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE" + } + } + } + }, + "com.amazonaws.elasticache#Authentication": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.elasticache#AuthenticationType", + "traits": { + "smithy.api#documentation": "

Indicates whether the user requires a password to authenticate.

" + } + }, + "PasswordCount": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of passwords belonging to the user. The maximum is two.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Indicates whether the user requires a password to authenticate.

" + } + }, + "com.amazonaws.elasticache#AuthenticationMode": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.elasticache#InputAuthenticationType", + "traits": { + "smithy.api#documentation": "

Specifies the authentication type. Possible options are IAM authentication, password\n and no password.

" + } + }, + "Passwords": { + "target": "com.amazonaws.elasticache#PasswordListInput", + "traits": { + "smithy.api#documentation": "

Specifies the passwords to use for authentication if Type is set to\n password.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the authentication mode to use.

" + } + }, + "com.amazonaws.elasticache#AuthenticationType": { + "type": "enum", + "members": { + "PASSWORD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "password" + } + }, + "NO_PASSWORD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "no-password" + } + }, + "IAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "iam" + } + } + } + }, + "com.amazonaws.elasticache#AuthorizationAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AuthorizationAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The specified Amazon EC2 security group is already authorized for the specified cache\n security group.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#AuthorizationNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AuthorizationNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified Amazon EC2 security group is not authorized for the specified cache\n security group.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.elasticache#AuthorizeCacheSecurityGroupIngress": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#AuthorizeCacheSecurityGroupIngressMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#AuthorizeCacheSecurityGroupIngressResult" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#AuthorizationAlreadyExistsFault" + }, + { + "target": "com.amazonaws.elasticache#CacheSecurityGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidCacheSecurityGroupStateFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + } + ], + "traits": { + "smithy.api#documentation": "

Allows network ingress to a cache security group. Applications using ElastiCache must\n be running on Amazon EC2, and Amazon EC2 security groups are used as the authorization\n mechanism.

\n \n

You cannot authorize ingress from an Amazon EC2 security group in one region to an\n ElastiCache cluster in another region.

\n ", + "smithy.api#examples": [ + { + "title": "AuthorizeCacheCacheSecurityGroupIngress", + "documentation": "Allows network ingress to a cache security group. Applications using ElastiCache must be running on Amazon EC2. Amazon EC2 security groups are used as the authorization mechanism.", + "input": { + "CacheSecurityGroupName": "my-sec-grp", + "EC2SecurityGroupName": "my-ec2-sec-grp", + "EC2SecurityGroupOwnerId": "1234567890" + } + } + ] + } + }, + "com.amazonaws.elasticache#AuthorizeCacheSecurityGroupIngressMessage": { + "type": "structure", + "members": { + "CacheSecurityGroupName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The cache security group that allows network ingress.

", + "smithy.api#required": {} + } + }, + "EC2SecurityGroupName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon EC2 security group to be authorized for ingress to the cache security\n group.

", + "smithy.api#required": {} + } + }, + "EC2SecurityGroupOwnerId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon account number of the Amazon EC2 security group owner. Note that this is\n not the same thing as an Amazon access key ID - you must provide a valid Amazon account\n number for this parameter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of an AuthorizeCacheSecurityGroupIngress operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#AuthorizeCacheSecurityGroupIngressResult": { + "type": "structure", + "members": { + "CacheSecurityGroup": { + "target": "com.amazonaws.elasticache#CacheSecurityGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#AutomaticFailoverStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + }, + "ENABLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabling" + } + }, + "DISABLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabling" + } + } + } + }, + "com.amazonaws.elasticache#AvailabilityZone": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the Availability Zone.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an Availability Zone in which the cluster is launched.

" + } + }, + "com.amazonaws.elasticache#AvailabilityZonesList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#xmlName": "AvailabilityZone" + } + } + }, + "com.amazonaws.elasticache#AwsQueryErrorMessage": { + "type": "string" + }, + "com.amazonaws.elasticache#BatchApplyUpdateAction": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#BatchApplyUpdateActionMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#UpdateActionResultsMessage" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#ServiceUpdateNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Apply the service update. For more information on service updates and applying them,\n see Applying Service\n Updates.

" + } + }, + "com.amazonaws.elasticache#BatchApplyUpdateActionMessage": { + "type": "structure", + "members": { + "ReplicationGroupIds": { + "target": "com.amazonaws.elasticache#ReplicationGroupIdList", + "traits": { + "smithy.api#documentation": "

The replication group IDs

" + } + }, + "CacheClusterIds": { + "target": "com.amazonaws.elasticache#CacheClusterIdList", + "traits": { + "smithy.api#documentation": "

The cache cluster IDs

" + } + }, + "ServiceUpdateName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The unique ID of the service update

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#BatchStopUpdateAction": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#BatchStopUpdateActionMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#UpdateActionResultsMessage" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#ServiceUpdateNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Stop the service update. For more information on service updates and stopping them,\n see Stopping\n Service Updates.

" + } + }, + "com.amazonaws.elasticache#BatchStopUpdateActionMessage": { + "type": "structure", + "members": { + "ReplicationGroupIds": { + "target": "com.amazonaws.elasticache#ReplicationGroupIdList", + "traits": { + "smithy.api#documentation": "

The replication group IDs

" + } + }, + "CacheClusterIds": { + "target": "com.amazonaws.elasticache#CacheClusterIdList", + "traits": { + "smithy.api#documentation": "

The cache cluster IDs

" + } + }, + "ServiceUpdateName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The unique ID of the service update

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#Boolean": { + "type": "boolean" + }, + "com.amazonaws.elasticache#BooleanOptional": { + "type": "boolean" + }, + "com.amazonaws.elasticache#CacheCluster": { + "type": "structure", + "members": { + "CacheClusterId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The user-supplied identifier of the cluster. This identifier is a unique key that\n identifies a cluster.

" + } + }, + "ConfigurationEndpoint": { + "target": "com.amazonaws.elasticache#Endpoint", + "traits": { + "smithy.api#documentation": "

Represents a Memcached cluster endpoint which can be used by an application to connect\n to any node in the cluster. The configuration endpoint will always have\n .cfg in it.

\n

Example: mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211\n

" + } + }, + "ClientDownloadLandingPage": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The URL of the web page where you can download the latest ElastiCache client\n library.

" + } + }, + "CacheNodeType": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the compute and memory capacity node type for the cluster.

\n

The following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.

\n \n

\n Additional node type info\n

\n " + } + }, + "Engine": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the cache engine (memcached or redis) to be used\n for this cluster.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The version of the cache engine that is used in this cluster.

" + } + }, + "CacheClusterStatus": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The current state of this cluster, one of the following values:\n available, creating, deleted,\n deleting, incompatible-network, modifying,\n rebooting cluster nodes, restore-failed, or\n snapshotting.

" + } + }, + "NumCacheNodes": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of cache nodes in the cluster.

\n

For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this\n value must be between 1 and 40.

" + } + }, + "PreferredAvailabilityZone": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the Availability Zone in which the cluster is located or \"Multiple\" if the\n cache nodes are located in different Availability Zones.

" + } + }, + "PreferredOutpostArn": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The outpost ARN in which the cache cluster is created.

" + } + }, + "CacheClusterCreateTime": { + "target": "com.amazonaws.elasticache#TStamp", + "traits": { + "smithy.api#documentation": "

The date and time when the cluster was created.

" + } + }, + "PreferredMaintenanceWindow": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

Specifies the weekly time range during which maintenance on the cluster is performed.\n It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The\n minimum maintenance window is a 60 minute period.

\n

Valid values for ddd are:

\n \n

Example: sun:23:00-mon:01:30\n

" + } + }, + "PendingModifiedValues": { + "target": "com.amazonaws.elasticache#PendingModifiedValues" + }, + "NotificationConfiguration": { + "target": "com.amazonaws.elasticache#NotificationConfiguration", + "traits": { + "smithy.api#documentation": "

Describes a notification topic and its status. Notification topics are used for\n publishing ElastiCache events to subscribers using Amazon Simple Notification Service\n (SNS).

" + } + }, + "CacheSecurityGroups": { + "target": "com.amazonaws.elasticache#CacheSecurityGroupMembershipList", + "traits": { + "smithy.api#documentation": "

A list of cache security group elements, composed of name and status\n sub-elements.

" + } + }, + "CacheParameterGroup": { + "target": "com.amazonaws.elasticache#CacheParameterGroupStatus", + "traits": { + "smithy.api#documentation": "

Status of the cache parameter group.

" + } + }, + "CacheSubnetGroupName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the cache subnet group associated with the cluster.

" + } + }, + "CacheNodes": { + "target": "com.amazonaws.elasticache#CacheNodeList", + "traits": { + "smithy.api#documentation": "

A list of cache nodes that are members of the cluster.

" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.elasticache#Boolean", + "traits": { + "smithy.api#documentation": "

 If you are running Valkey or Redis OSS engine version 6.0 or later, set this parameter to yes if\n you want to opt-in to the next auto minor version upgrade campaign. This parameter is\n disabled for previous versions. 

" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.elasticache#SecurityGroupMembershipList", + "traits": { + "smithy.api#documentation": "

A list of VPC Security Groups associated with the cluster.

" + } + }, + "ReplicationGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The replication group to which this cluster belongs. If this field is empty, the\n cluster is not associated with any replication group.

" + } + }, + "SnapshotRetentionLimit": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days for which ElastiCache retains automatic cluster snapshots before\n deleting them. For example, if you set SnapshotRetentionLimit to 5, a\n snapshot that was taken today is retained for 5 days before being deleted.

\n \n

If the value of SnapshotRetentionLimit is set to zero (0), backups are turned\n off.

\n " + } + }, + "SnapshotWindow": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot\n of your cluster.

\n

Example: 05:00-09:00\n

" + } + }, + "AuthTokenEnabled": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A flag that enables using an AuthToken (password) when issuing Valkey or Redis OSS \n commands.

\n

Default: false\n

" + } + }, + "AuthTokenLastModifiedDate": { + "target": "com.amazonaws.elasticache#TStamp", + "traits": { + "smithy.api#documentation": "

The date the auth token was last modified

" + } + }, + "TransitEncryptionEnabled": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A flag that enables in-transit encryption when set to true.

\n

\n Required: Only available when creating a replication\n group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or\n later.

\n

Default: false\n

" + } + }, + "AtRestEncryptionEnabled": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A flag that enables encryption at-rest when set to true.

\n

You cannot modify the value of AtRestEncryptionEnabled after the cluster\n is created. To enable at-rest encryption on a cluster you must set\n AtRestEncryptionEnabled to true when you create a\n cluster.

\n

\n Required: Only available when creating a replication\n group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or\n later.

\n

Default: false\n

" + } + }, + "ARN": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The ARN (Amazon Resource Name) of the cache cluster.

" + } + }, + "ReplicationGroupLogDeliveryEnabled": { + "target": "com.amazonaws.elasticache#Boolean", + "traits": { + "smithy.api#documentation": "

A boolean value indicating whether log delivery is enabled for the replication\n group.

" + } + }, + "LogDeliveryConfigurations": { + "target": "com.amazonaws.elasticache#LogDeliveryConfigurationList", + "traits": { + "smithy.api#documentation": "

Returns the destination, format and type of the logs.

" + } + }, + "NetworkType": { + "target": "com.amazonaws.elasticache#NetworkType", + "traits": { + "smithy.api#documentation": "

Must be either ipv4 | ipv6 | dual_stack. IPv6\n is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2\n and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

" + } + }, + "IpDiscovery": { + "target": "com.amazonaws.elasticache#IpDiscovery", + "traits": { + "smithy.api#documentation": "

The network type associated with the cluster, either ipv4 |\n ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2\n and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

" + } + }, + "TransitEncryptionMode": { + "target": "com.amazonaws.elasticache#TransitEncryptionMode", + "traits": { + "smithy.api#documentation": "

A setting that allows you to migrate your clients to use in-transit encryption, with\n no downtime.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains all of the attributes of a specific cluster.

" + } + }, + "com.amazonaws.elasticache#CacheClusterAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "CacheClusterAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

You already have a cluster with the given identifier.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#CacheClusterIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#String" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.elasticache#CacheClusterList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#CacheCluster", + "traits": { + "smithy.api#xmlName": "CacheCluster" + } + } + }, + "com.amazonaws.elasticache#CacheClusterMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

Provides an identifier to allow retrieval of paginated results.

" + } + }, + "CacheClusters": { + "target": "com.amazonaws.elasticache#CacheClusterList", + "traits": { + "smithy.api#documentation": "

A list of clusters. Each item in the list contains detailed information about one\n cluster.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a DescribeCacheClusters operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#CacheClusterNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "CacheClusterNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The requested cluster ID does not refer to an existing cluster.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.elasticache#CacheEngineVersion": { + "type": "structure", + "members": { + "Engine": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the cache engine.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The version number of the cache engine.

" + } + }, + "CacheParameterGroupFamily": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the cache parameter group family associated with this cache engine.

\n

Valid values are: memcached1.4 | memcached1.5 |\n memcached1.6 | redis2.6 | redis2.8 |\n redis3.2 | redis4.0 | redis5.0 |\n redis6.x | redis7\n

" + } + }, + "CacheEngineDescription": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The description of the cache engine.

" + } + }, + "CacheEngineVersionDescription": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The description of the cache engine version.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides all of the details about a particular cache engine version.

" + } + }, + "com.amazonaws.elasticache#CacheEngineVersionList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#CacheEngineVersion", + "traits": { + "smithy.api#xmlName": "CacheEngineVersion" + } + } + }, + "com.amazonaws.elasticache#CacheEngineVersionMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

Provides an identifier to allow retrieval of paginated results.

" + } + }, + "CacheEngineVersions": { + "target": "com.amazonaws.elasticache#CacheEngineVersionList", + "traits": { + "smithy.api#documentation": "

A list of cache engine version details. Each element in the list contains detailed\n information about one cache engine version.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a DescribeCacheEngineVersions\n operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#CacheNode": { + "type": "structure", + "members": { + "CacheNodeId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The\n combination of cluster ID and node ID uniquely identifies every cache node used in a\n customer's Amazon account.

" + } + }, + "CacheNodeStatus": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The current state of this cache node, one of the following values:\n available, creating, rebooting, or\n deleting.

" + } + }, + "CacheNodeCreateTime": { + "target": "com.amazonaws.elasticache#TStamp", + "traits": { + "smithy.api#documentation": "

The date and time when the cache node was created.

" + } + }, + "Endpoint": { + "target": "com.amazonaws.elasticache#Endpoint", + "traits": { + "smithy.api#documentation": "

The hostname for connecting to this cache node.

" + } + }, + "ParameterGroupStatus": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The status of the parameter group applied to this cache node.

" + } + }, + "SourceCacheNodeId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The ID of the primary node to which this read replica node is synchronized. If this\n field is empty, this node is not associated with a primary cluster.

" + } + }, + "CustomerAvailabilityZone": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone where this node was created and now resides.

" + } + }, + "CustomerOutpostArn": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The customer outpost ARN of the cache node.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents an individual cache node within a cluster. Each cache node runs its own\n instance of the cluster's protocol-compliant caching software - either Memcached, Valkey or Redis OSS.

\n

The following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.

\n \n

\n Additional node type info\n

\n " + } + }, + "com.amazonaws.elasticache#CacheNodeIdsList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#xmlName": "CacheNodeId" + } + } + }, + "com.amazonaws.elasticache#CacheNodeList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#CacheNode", + "traits": { + "smithy.api#xmlName": "CacheNode" + } + } + }, + "com.amazonaws.elasticache#CacheNodeTypeSpecificParameter": { + "type": "structure", + "members": { + "ParameterName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the parameter.

" + } + }, + "Description": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

A description of the parameter.

" + } + }, + "Source": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The source of the parameter value.

" + } + }, + "DataType": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The valid data type for the parameter.

" + } + }, + "AllowedValues": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The valid range of values for the parameter.

" + } + }, + "IsModifiable": { + "target": "com.amazonaws.elasticache#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether (true) or not (false) the parameter can be\n modified. Some parameters have security or operational implications that prevent them\n from being changed.

" + } + }, + "MinimumEngineVersion": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The earliest cache engine version to which the parameter can apply.

" + } + }, + "CacheNodeTypeSpecificValues": { + "target": "com.amazonaws.elasticache#CacheNodeTypeSpecificValueList", + "traits": { + "smithy.api#documentation": "

A list of cache node types and their corresponding values for this parameter.

" + } + }, + "ChangeType": { + "target": "com.amazonaws.elasticache#ChangeType", + "traits": { + "smithy.api#documentation": "

Indicates whether a change to the parameter is applied immediately or requires a\n reboot for the change to be applied. You can force a reboot or wait until the next\n maintenance window's reboot. For more information, see Rebooting a\n Cluster.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A parameter that has a different value for each cache node type it is applied to. For\n example, in a Valkey or Redis OSS cluster, a cache.m1.large cache node type would have a\n larger maxmemory value than a cache.m1.small type.

" + } + }, + "com.amazonaws.elasticache#CacheNodeTypeSpecificParametersList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#CacheNodeTypeSpecificParameter", + "traits": { + "smithy.api#xmlName": "CacheNodeTypeSpecificParameter" + } + } + }, + "com.amazonaws.elasticache#CacheNodeTypeSpecificValue": { + "type": "structure", + "members": { + "CacheNodeType": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The cache node type for which this value applies.

" + } + }, + "Value": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The value for the cache node type.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A value that applies only to a certain cache node type.

" + } + }, + "com.amazonaws.elasticache#CacheNodeTypeSpecificValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#CacheNodeTypeSpecificValue", + "traits": { + "smithy.api#xmlName": "CacheNodeTypeSpecificValue" + } + } + }, + "com.amazonaws.elasticache#CacheNodeUpdateStatus": { + "type": "structure", + "members": { + "CacheNodeId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The node ID of the cache cluster

" + } + }, + "NodeUpdateStatus": { + "target": "com.amazonaws.elasticache#NodeUpdateStatus", + "traits": { + "smithy.api#documentation": "

The update status of the node

" + } + }, + "NodeDeletionDate": { + "target": "com.amazonaws.elasticache#TStamp", + "traits": { + "smithy.api#documentation": "

The deletion date of the node

" + } + }, + "NodeUpdateStartDate": { + "target": "com.amazonaws.elasticache#TStamp", + "traits": { + "smithy.api#documentation": "

The start date of the update for a node

" + } + }, + "NodeUpdateEndDate": { + "target": "com.amazonaws.elasticache#TStamp", + "traits": { + "smithy.api#documentation": "

The end date of the update for a node

" + } + }, + "NodeUpdateInitiatedBy": { + "target": "com.amazonaws.elasticache#NodeUpdateInitiatedBy", + "traits": { + "smithy.api#documentation": "

Reflects whether the update was initiated by the customer or automatically\n applied

" + } + }, + "NodeUpdateInitiatedDate": { + "target": "com.amazonaws.elasticache#TStamp", + "traits": { + "smithy.api#documentation": "

The date when the update is triggered

" + } + }, + "NodeUpdateStatusModifiedDate": { + "target": "com.amazonaws.elasticache#TStamp", + "traits": { + "smithy.api#documentation": "

The date when the NodeUpdateStatus was last modified>

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The status of the service update on the cache node

" + } + }, + "com.amazonaws.elasticache#CacheNodeUpdateStatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#CacheNodeUpdateStatus", + "traits": { + "smithy.api#xmlName": "CacheNodeUpdateStatus" + } + } + }, + "com.amazonaws.elasticache#CacheParameterGroup": { + "type": "structure", + "members": { + "CacheParameterGroupName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the cache parameter group.

" + } + }, + "CacheParameterGroupFamily": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the cache parameter group family that this cache parameter group is\n compatible with.

\n

Valid values are: memcached1.4 | memcached1.5 |\n memcached1.6 | redis2.6 | redis2.8 |\n redis3.2 | redis4.0 | redis5.0 |\n redis6.x | redis7\n

" + } + }, + "Description": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The description for this cache parameter group.

" + } + }, + "IsGlobal": { + "target": "com.amazonaws.elasticache#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the parameter group is associated with a Global datastore

" + } + }, + "ARN": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The ARN (Amazon Resource Name) of the cache parameter group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a CreateCacheParameterGroup operation.

" + } + }, + "com.amazonaws.elasticache#CacheParameterGroupAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "CacheParameterGroupAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

A cache parameter group with the requested name already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#CacheParameterGroupDetails": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

Provides an identifier to allow retrieval of paginated results.

" + } + }, + "Parameters": { + "target": "com.amazonaws.elasticache#ParametersList", + "traits": { + "smithy.api#documentation": "

A list of Parameter instances.

" + } + }, + "CacheNodeTypeSpecificParameters": { + "target": "com.amazonaws.elasticache#CacheNodeTypeSpecificParametersList", + "traits": { + "smithy.api#documentation": "

A list of parameters specific to a particular cache node type. Each element in the\n list contains detailed information about one parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a DescribeCacheParameters operation.

" + } + }, + "com.amazonaws.elasticache#CacheParameterGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#CacheParameterGroup", + "traits": { + "smithy.api#xmlName": "CacheParameterGroup" + } + } + }, + "com.amazonaws.elasticache#CacheParameterGroupNameMessage": { + "type": "structure", + "members": { + "CacheParameterGroupName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the cache parameter group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of one of the following operations:

\n " + } + }, + "com.amazonaws.elasticache#CacheParameterGroupNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "CacheParameterGroupNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The requested cache parameter group name does not refer to an existing cache parameter\n group.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.elasticache#CacheParameterGroupQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "CacheParameterGroupQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request cannot be processed because it would exceed the maximum number of cache\n security groups.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#CacheParameterGroupStatus": { + "type": "structure", + "members": { + "CacheParameterGroupName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the cache parameter group.

" + } + }, + "ParameterApplyStatus": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The status of parameter updates.

" + } + }, + "CacheNodeIdsToReboot": { + "target": "com.amazonaws.elasticache#CacheNodeIdsList", + "traits": { + "smithy.api#documentation": "

A list of the cache node IDs which need to be rebooted for parameter changes to be\n applied. A node ID is a numeric identifier (0001, 0002, etc.).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Status of the cache parameter group.

" + } + }, + "com.amazonaws.elasticache#CacheParameterGroupsMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

Provides an identifier to allow retrieval of paginated results.

" + } + }, + "CacheParameterGroups": { + "target": "com.amazonaws.elasticache#CacheParameterGroupList", + "traits": { + "smithy.api#documentation": "

A list of cache parameter groups. Each element in the list contains detailed\n information about one cache parameter group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a DescribeCacheParameterGroups operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#CacheSecurityGroup": { + "type": "structure", + "members": { + "OwnerId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The Amazon account ID of the cache security group owner.

" + } + }, + "CacheSecurityGroupName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the cache security group.

" + } + }, + "Description": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The description of the cache security group.

" + } + }, + "EC2SecurityGroups": { + "target": "com.amazonaws.elasticache#EC2SecurityGroupList", + "traits": { + "smithy.api#documentation": "

A list of Amazon EC2 security groups that are associated with this cache security\n group.

" + } + }, + "ARN": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The ARN of the cache security group,

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of one of the following operations:

\n " + } + }, + "com.amazonaws.elasticache#CacheSecurityGroupAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "CacheSecurityGroupAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

A cache security group with the specified name already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#CacheSecurityGroupMembership": { + "type": "structure", + "members": { + "CacheSecurityGroupName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the cache security group.

" + } + }, + "Status": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The membership status in the cache security group. The status changes when a cache\n security group is modified, or when the cache security groups assigned to a cluster are\n modified.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a cluster's status within a particular cache security group.

" + } + }, + "com.amazonaws.elasticache#CacheSecurityGroupMembershipList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#CacheSecurityGroupMembership", + "traits": { + "smithy.api#xmlName": "CacheSecurityGroup" + } + } + }, + "com.amazonaws.elasticache#CacheSecurityGroupMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

Provides an identifier to allow retrieval of paginated results.

" + } + }, + "CacheSecurityGroups": { + "target": "com.amazonaws.elasticache#CacheSecurityGroups", + "traits": { + "smithy.api#documentation": "

A list of cache security groups. Each element in the list contains detailed\n information about one group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a DescribeCacheSecurityGroups operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#CacheSecurityGroupNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#xmlName": "CacheSecurityGroupName" + } + } + }, + "com.amazonaws.elasticache#CacheSecurityGroupNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "CacheSecurityGroupNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The requested cache security group name does not refer to an existing cache security\n group.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.elasticache#CacheSecurityGroupQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "QuotaExceeded.CacheSecurityGroup", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request cannot be processed because it would exceed the allowed number of cache\n security groups.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#CacheSecurityGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#CacheSecurityGroup", + "traits": { + "smithy.api#xmlName": "CacheSecurityGroup" + } + } + }, + "com.amazonaws.elasticache#CacheSubnetGroup": { + "type": "structure", + "members": { + "CacheSubnetGroupName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the cache subnet group.

" + } + }, + "CacheSubnetGroupDescription": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The description of the cache subnet group.

" + } + }, + "VpcId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.

" + } + }, + "Subnets": { + "target": "com.amazonaws.elasticache#SubnetList", + "traits": { + "smithy.api#documentation": "

A list of subnets associated with the cache subnet group.

" + } + }, + "ARN": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The ARN (Amazon Resource Name) of the cache subnet group.

" + } + }, + "SupportedNetworkTypes": { + "target": "com.amazonaws.elasticache#NetworkTypeList", + "traits": { + "smithy.api#documentation": "

Either ipv4 | ipv6 | dual_stack. IPv6 is\n supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2\n and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of one of the following operations:

\n " + } + }, + "com.amazonaws.elasticache#CacheSubnetGroupAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "CacheSubnetGroupAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The requested cache subnet group name is already in use by an existing cache subnet\n group.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#CacheSubnetGroupInUse": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "CacheSubnetGroupInUse", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The requested cache subnet group is currently in use.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#CacheSubnetGroupMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

Provides an identifier to allow retrieval of paginated results.

" + } + }, + "CacheSubnetGroups": { + "target": "com.amazonaws.elasticache#CacheSubnetGroups", + "traits": { + "smithy.api#documentation": "

A list of cache subnet groups. Each element in the list contains detailed information\n about one group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a DescribeCacheSubnetGroups operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#CacheSubnetGroupNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "CacheSubnetGroupNotFoundFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The requested cache subnet group name does not refer to an existing cache subnet\n group.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#CacheSubnetGroupQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "CacheSubnetGroupQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request cannot be processed because it would exceed the allowed number of cache\n subnet groups.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#CacheSubnetGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#CacheSubnetGroup", + "traits": { + "smithy.api#xmlName": "CacheSubnetGroup" + } + } + }, + "com.amazonaws.elasticache#CacheSubnetQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "CacheSubnetQuotaExceededFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request cannot be processed because it would exceed the allowed number of subnets\n in a cache subnet group.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#CacheUsageLimits": { + "type": "structure", + "members": { + "DataStorage": { + "target": "com.amazonaws.elasticache#DataStorage", + "traits": { + "smithy.api#documentation": "

\n The maximum data storage limit in the cache, expressed in Gigabytes.\n

" + } + }, + "ECPUPerSecond": { + "target": "com.amazonaws.elasticache#ECPUPerSecond" + } + }, + "traits": { + "smithy.api#documentation": "

The usage limits for storage and ElastiCache Processing Units for the cache.

" + } + }, + "com.amazonaws.elasticache#ChangeType": { + "type": "enum", + "members": { + "immediate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "immediate" + } + }, + "requires_reboot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "requires-reboot" + } + } + } + }, + "com.amazonaws.elasticache#CloudWatchLogsDestinationDetails": { + "type": "structure", + "members": { + "LogGroup": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the CloudWatch Logs log group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration details of the CloudWatch Logs destination.

" + } + }, + "com.amazonaws.elasticache#ClusterIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#xmlName": "ClusterId" + } + } + }, + "com.amazonaws.elasticache#ClusterMode": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + }, + "COMPATIBLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "compatible" + } + } + } + }, + "com.amazonaws.elasticache#ClusterQuotaForCustomerExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ClusterQuotaForCustomerExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request cannot be processed because it would exceed the allowed number of clusters\n per customer.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#CompleteMigration": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#CompleteMigrationMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#CompleteMigrationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#InvalidReplicationGroupStateFault" + }, + { + "target": "com.amazonaws.elasticache#ReplicationGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#ReplicationGroupNotUnderMigrationFault" + } + ], + "traits": { + "smithy.api#documentation": "

Complete the migration of data.

" + } + }, + "com.amazonaws.elasticache#CompleteMigrationMessage": { + "type": "structure", + "members": { + "ReplicationGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the replication group to which data is being migrated.

", + "smithy.api#required": {} + } + }, + "Force": { + "target": "com.amazonaws.elasticache#Boolean", + "traits": { + "smithy.api#documentation": "

Forces the migration to stop without ensuring that data is in sync. It is recommended\n to use this option only to abort the migration and not recommended when application\n wants to continue migration to ElastiCache.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#CompleteMigrationResponse": { + "type": "structure", + "members": { + "ReplicationGroup": { + "target": "com.amazonaws.elasticache#ReplicationGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#ConfigureShard": { + "type": "structure", + "members": { + "NodeGroupId": { + "target": "com.amazonaws.elasticache#AllowedNodeGroupId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The 4-digit id for the node group you are configuring. For Valkey or Redis OSS (cluster mode\n disabled) replication groups, the node group id is always 0001. To find a Valkey or Redis OSS (cluster mode enabled)'s node group's (shard's) id, see Finding a Shard's\n Id.

", + "smithy.api#required": {} + } + }, + "NewReplicaCount": { + "target": "com.amazonaws.elasticache#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of replicas you want in this node group at the end of this operation.\n The maximum value for NewReplicaCount is 5. The minimum value depends upon\n the type of Valkey or Redis OSS replication group you are working with.

\n

The minimum number of replicas in a shard or replication group is:

\n ", + "smithy.api#required": {} + } + }, + "PreferredAvailabilityZones": { + "target": "com.amazonaws.elasticache#PreferredAvailabilityZoneList", + "traits": { + "smithy.api#documentation": "

A list of PreferredAvailabilityZone strings that specify which\n availability zones the replication group's nodes are to be in. The nummber of\n PreferredAvailabilityZone values must equal the value of\n NewReplicaCount plus 1 to account for the primary node. If this member\n of ReplicaConfiguration is omitted, ElastiCache selects the\n availability zone for each of the replicas.

" + } + }, + "PreferredOutpostArns": { + "target": "com.amazonaws.elasticache#PreferredOutpostArnList", + "traits": { + "smithy.api#documentation": "

The outpost ARNs in which the cache cluster is created.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Node group (shard) configuration options when adding or removing replicas. Each\n node group (shard) configuration has the following members: NodeGroupId,\n NewReplicaCount, and PreferredAvailabilityZones.

" + } + }, + "com.amazonaws.elasticache#CopyServerlessCacheSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#CopyServerlessCacheSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.elasticache#CopyServerlessCacheSnapshotResponse" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#InvalidServerlessCacheSnapshotStateFault" + }, + { + "target": "com.amazonaws.elasticache#ServerlessCacheSnapshotAlreadyExistsFault" + }, + { + "target": "com.amazonaws.elasticache#ServerlessCacheSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#ServerlessCacheSnapshotQuotaExceededFault" + }, + { + "target": "com.amazonaws.elasticache#ServiceLinkedRoleNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#TagQuotaPerResourceExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a copy of an existing serverless cache’s snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.

" + } + }, + "com.amazonaws.elasticache#CopyServerlessCacheSnapshotRequest": { + "type": "structure", + "members": { + "SourceServerlessCacheSnapshotName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier of the existing serverless cache’s snapshot to be copied. Available for Valkey, Redis OSS and Serverless Memcached only.

", + "smithy.api#required": {} + } + }, + "TargetServerlessCacheSnapshotName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier for the snapshot to be created. Available for Valkey, Redis OSS and Serverless Memcached only.

", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The identifier of the KMS key used to encrypt the target snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.

" + } + }, + "Tags": { + "target": "com.amazonaws.elasticache#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags to be added to the target snapshot resource. A tag is a key-value pair. Available for Valkey, Redis OSS and Serverless Memcached only. Default: NULL

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#CopyServerlessCacheSnapshotResponse": { + "type": "structure", + "members": { + "ServerlessCacheSnapshot": { + "target": "com.amazonaws.elasticache#ServerlessCacheSnapshot", + "traits": { + "smithy.api#documentation": "

The response for the attempt to copy the serverless cache snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#CopySnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#CopySnapshotMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#CopySnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#InvalidSnapshotStateFault" + }, + { + "target": "com.amazonaws.elasticache#SnapshotAlreadyExistsFault" + }, + { + "target": "com.amazonaws.elasticache#SnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#SnapshotQuotaExceededFault" + }, + { + "target": "com.amazonaws.elasticache#TagQuotaPerResourceExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Makes a copy of an existing snapshot.

\n \n

This operation is valid for Valkey or Redis OSS only.

\n \n \n

Users or groups that have permissions to use the CopySnapshot\n operation can create their own Amazon S3 buckets and copy snapshots to it. To\n control access to your snapshots, use an IAM policy to control who has the ability\n to use the CopySnapshot operation. For more information about using IAM\n to control the use of ElastiCache operations, see Exporting\n Snapshots and Authentication & Access\n Control.

\n \n

You could receive the following error messages.

\n

\n Error Messages\n

\n ", + "smithy.api#examples": [ + { + "title": "CopySnapshot", + "documentation": "Copies a snapshot to a specified name.", + "input": { + "SourceSnapshotName": "my-snapshot", + "TargetSnapshotName": "my-snapshot-copy", + "TargetBucket": "" + }, + "output": { + "Snapshot": { + "Engine": "redis", + "CacheParameterGroupName": "default.redis3.2", + "VpcId": "vpc-3820329f3", + "CacheClusterId": "my-redis4", + "SnapshotRetentionLimit": 7, + "NumCacheNodes": 1, + "SnapshotName": "my-snapshot-copy", + "CacheClusterCreateTime": "2016-12-21T22:24:04.955Z", + "AutoMinorVersionUpgrade": true, + "PreferredAvailabilityZone": "us-east-1c", + "SnapshotStatus": "creating", + "SnapshotSource": "manual", + "SnapshotWindow": "07:00-08:00", + "EngineVersion": "3.2.4", + "NodeSnapshots": [ + { + "CacheSize": "3 MB", + "SnapshotCreateTime": "2016-12-28T07:00:52Z", + "CacheNodeId": "0001", + "CacheNodeCreateTime": "2016-12-21T22:24:04.955Z" + } + ], + "CacheSubnetGroupName": "default", + "Port": 6379, + "PreferredMaintenanceWindow": "tue:09:30-tue:10:30", + "CacheNodeType": "cache.m3.large" + } + } + } + ] + } + }, + "com.amazonaws.elasticache#CopySnapshotMessage": { + "type": "structure", + "members": { + "SourceSnapshotName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of an existing snapshot from which to make a copy.

", + "smithy.api#required": {} + } + }, + "TargetSnapshotName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot,\n therefore this name must be unique within its context - ElastiCache or an Amazon S3\n bucket if exporting.

", + "smithy.api#required": {} + } + }, + "TargetBucket": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The Amazon S3 bucket to which the snapshot is exported. This parameter is used only\n when exporting a snapshot for external access.

\n

When using this parameter to export a snapshot, be sure Amazon ElastiCache has the\n needed permissions to this S3 bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the\n Amazon ElastiCache User Guide.

\n

For more information, see Exporting a\n Snapshot in the Amazon ElastiCache User Guide.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The ID of the KMS key used to encrypt the target snapshot.

" + } + }, + "Tags": { + "target": "com.amazonaws.elasticache#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must\n be accompanied by a tag value, although null is accepted.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a CopySnapshotMessage operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#CopySnapshotResult": { + "type": "structure", + "members": { + "Snapshot": { + "target": "com.amazonaws.elasticache#Snapshot" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#CreateCacheCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#CreateCacheClusterMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#CreateCacheClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#CacheClusterAlreadyExistsFault" + }, + { + "target": "com.amazonaws.elasticache#CacheParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#CacheSecurityGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#CacheSubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#ClusterQuotaForCustomerExceededFault" + }, + { + "target": "com.amazonaws.elasticache#InsufficientCacheClusterCapacityFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#InvalidReplicationGroupStateFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidVPCNetworkStateFault" + }, + { + "target": "com.amazonaws.elasticache#NodeQuotaForClusterExceededFault" + }, + { + "target": "com.amazonaws.elasticache#NodeQuotaForCustomerExceededFault" + }, + { + "target": "com.amazonaws.elasticache#ReplicationGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#TagQuotaPerResourceExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a cluster. All nodes in the cluster run the same protocol-compliant cache\n engine software, either Memcached, Valkey or Redis OSS.

\n

This operation is not supported for Valkey or Redis OSS (cluster mode enabled) clusters.

", + "smithy.api#examples": [ + { + "title": "CreateCacheCluster", + "documentation": "Creates a Memcached cluster with 2 nodes. ", + "input": { + "CacheClusterId": "my-memcached-cluster", + "AZMode": "cross-az", + "NumCacheNodes": 2, + "CacheNodeType": "cache.r3.large", + "Engine": "memcached", + "EngineVersion": "1.4.24", + "CacheSubnetGroupName": "default", + "Port": 11211 + }, + "output": { + "CacheCluster": { + "Engine": "memcached", + "CacheParameterGroup": { + "CacheNodeIdsToReboot": [], + "CacheParameterGroupName": "default.memcached1.4", + "ParameterApplyStatus": "in-sync" + }, + "CacheClusterId": "my-memcached-cluster", + "CacheSecurityGroups": [], + "NumCacheNodes": 2, + "AutoMinorVersionUpgrade": true, + "CacheClusterStatus": "creating", + "PreferredAvailabilityZone": "Multiple", + "ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:", + "CacheSubnetGroupName": "default", + "EngineVersion": "1.4.24", + "PendingModifiedValues": {}, + "PreferredMaintenanceWindow": "wed:09:00-wed:10:00", + "CacheNodeType": "cache.r3.large" + } + } + }, + { + "title": "CreateCacheCluster", + "documentation": "Creates a Redis cluster with 1 node. ", + "input": { + "CacheClusterId": "my-redis", + "PreferredAvailabilityZone": "us-east-1c", + "NumCacheNodes": 1, + "CacheNodeType": "cache.r3.larage", + "Engine": "redis", + "EngineVersion": "3.2.4", + "CacheSubnetGroupName": "default", + "Port": 6379, + "SnapshotRetentionLimit": 7, + "AutoMinorVersionUpgrade": true + }, + "output": { + "CacheCluster": { + "Engine": "redis", + "CacheParameterGroup": { + "CacheNodeIdsToReboot": [], + "CacheParameterGroupName": "default.redis3.2", + "ParameterApplyStatus": "in-sync" + }, + "SnapshotRetentionLimit": 7, + "CacheClusterId": "my-redis", + "CacheSecurityGroups": [], + "NumCacheNodes": 1, + "SnapshotWindow": "10: 00-11: 00", + "AutoMinorVersionUpgrade": true, + "CacheClusterStatus": "creating", + "PreferredAvailabilityZone": "us-east-1c", + "ClientDownloadLandingPage": "https: //console.aws.amazon.com/elasticache/home#client-download: ", + "CacheSubnetGroupName": "default", + "EngineVersion": "3.2.4", + "PendingModifiedValues": {}, + "PreferredMaintenanceWindow": "fri: 05: 30-fri: 06: 30", + "CacheNodeType": "cache.m3.large" + } + } + } + ] + } + }, + "com.amazonaws.elasticache#CreateCacheClusterMessage": { + "type": "structure", + "members": { + "CacheClusterId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The node group (shard) identifier. This parameter is stored as a lowercase\n string.

\n

\n Constraints:\n

\n ", + "smithy.api#required": {} + } + }, + "ReplicationGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The ID of the replication group to which this cluster should belong. If this parameter\n is specified, the cluster is added to the specified replication group as a read replica;\n otherwise, the cluster is a standalone primary that is not part of any replication\n group.

\n

If the specified replication group is Multi-AZ enabled and the Availability Zone is\n not specified, the cluster is created in Availability Zones that provide the best spread\n of read replicas across Availability Zones.

\n \n

This parameter is only valid if the Engine parameter is\n redis.

\n " + } + }, + "AZMode": { + "target": "com.amazonaws.elasticache#AZMode", + "traits": { + "smithy.api#documentation": "

Specifies whether the nodes in this Memcached cluster are created in a single\n Availability Zone or created across multiple Availability Zones in the cluster's\n region.

\n

This parameter is only supported for Memcached clusters.

\n

If the AZMode and PreferredAvailabilityZones are not\n specified, ElastiCache assumes single-az mode.

" + } + }, + "PreferredAvailabilityZone": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The EC2 Availability Zone in which the cluster is created.

\n

All nodes belonging to this cluster are placed in the preferred Availability Zone. If\n you want to create your nodes across multiple Availability Zones, use\n PreferredAvailabilityZones.

\n

Default: System chosen Availability Zone.

" + } + }, + "PreferredAvailabilityZones": { + "target": "com.amazonaws.elasticache#PreferredAvailabilityZoneList", + "traits": { + "smithy.api#documentation": "

A list of the Availability Zones in which cache nodes are created. The order of the\n zones in the list is not important.

\n

This option is only supported on Memcached.

\n \n

If you are creating your cluster in an Amazon VPC (recommended) you can only\n locate nodes in Availability Zones that are associated with the subnets in the\n selected subnet group.

\n

The number of Availability Zones listed must equal the value of\n NumCacheNodes.

\n \n

If you want all the nodes in the same Availability Zone, use\n PreferredAvailabilityZone instead, or repeat the Availability Zone\n multiple times in the list.

\n

Default: System chosen Availability Zones.

" + } + }, + "NumCacheNodes": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The initial number of cache nodes that the cluster has.

\n

For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this\n value must be between 1 and 40.

\n

If you need more than 40 nodes for your Memcached cluster, please fill out the\n ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/.

" + } + }, + "CacheNodeType": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The compute and memory capacity of the nodes in the node group (shard).

\n

The following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.

\n \n

\n Additional node type info\n

\n " + } + }, + "Engine": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the cache engine to be used for this cluster.

\n

Valid values for this parameter are: memcached |\n redis\n

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The version number of the cache engine to be used for this cluster. To view the\n supported cache engine versions, use the DescribeCacheEngineVersions operation.

\n

\n Important: You can upgrade to a newer engine version\n (see Selecting\n a Cache Engine and Version), but you cannot downgrade to an earlier engine\n version. If you want to use an earlier engine version, you must delete the existing\n cluster or replication group and create it anew with the earlier engine version.

" + } + }, + "CacheParameterGroupName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the parameter group to associate with this cluster. If this argument is\n omitted, the default parameter group for the specified engine is used. You cannot use\n any parameter group which has cluster-enabled='yes' when creating a\n cluster.

" + } + }, + "CacheSubnetGroupName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the subnet group to be used for the cluster.

\n

Use this parameter only when you are creating a cluster in an Amazon Virtual Private\n Cloud (Amazon VPC).

\n \n

If you're going to launch your cluster in an Amazon VPC, you need to create a\n subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.

\n " + } + }, + "CacheSecurityGroupNames": { + "target": "com.amazonaws.elasticache#CacheSecurityGroupNameList", + "traits": { + "smithy.api#documentation": "

A list of security group names to associate with this cluster.

\n

Use this parameter only when you are creating a cluster outside of an Amazon Virtual\n Private Cloud (Amazon VPC).

" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.elasticache#SecurityGroupIdsList", + "traits": { + "smithy.api#documentation": "

One or more VPC security groups associated with the cluster.

\n

Use this parameter only when you are creating a cluster in an Amazon Virtual Private\n Cloud (Amazon VPC).

" + } + }, + "Tags": { + "target": "com.amazonaws.elasticache#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags to be added to this resource.

" + } + }, + "SnapshotArns": { + "target": "com.amazonaws.elasticache#SnapshotArnsList", + "traits": { + "smithy.api#documentation": "

A single-element string list containing an Amazon Resource Name (ARN) that uniquely\n identifies a Valkey or Redis OSS RDB snapshot file stored in Amazon S3. The snapshot file is used to\n populate the node group (shard). The Amazon S3 object name in the ARN cannot contain any\n commas.

\n \n

This parameter is only valid if the Engine parameter is\n redis.

\n \n

Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb\n

" + } + }, + "SnapshotName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of a Valkey or Redis OSS snapshot from which to restore data into the new node group\n (shard). The snapshot status changes to restoring while the new node group\n (shard) is being created.

\n \n

This parameter is only valid if the Engine parameter is\n redis.

\n " + } + }, + "PreferredMaintenanceWindow": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

Specifies the weekly time range during which maintenance on the cluster is performed.\n It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The\n minimum maintenance window is a 60 minute period.

" + } + }, + "Port": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port number on which each of the cache nodes accepts connections.

" + } + }, + "NotificationTopicArn": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic\n to which notifications are sent.

\n \n

The Amazon SNS topic owner must be the same as the cluster owner.

\n " + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "

 If you are running Valkey 7.2 and above or Redis OSS engine version 6.0 and above, set this parameter to yes \n to opt-in to the next auto minor version upgrade campaign. This parameter is\n disabled for previous versions. 

" + } + }, + "SnapshotRetentionLimit": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days for which ElastiCache retains automatic snapshots before deleting\n them. For example, if you set SnapshotRetentionLimit to 5, a snapshot taken\n today is retained for 5 days before being deleted.

\n \n

This parameter is only valid if the Engine parameter is\n redis.

\n \n

Default: 0 (i.e., automatic backups are disabled for this cache cluster).

" + } + }, + "SnapshotWindow": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot\n of your node group (shard).

\n

Example: 05:00-09:00\n

\n

If you do not specify this parameter, ElastiCache automatically chooses an appropriate\n time range.

\n \n

This parameter is only valid if the Engine parameter is\n redis.

\n " + } + }, + "AuthToken": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

\n Reserved parameter. The password used to access a\n password protected server.

\n

Password constraints:

\n \n

For more information, see AUTH\n password at http://redis.io/commands/AUTH.

" + } + }, + "OutpostMode": { + "target": "com.amazonaws.elasticache#OutpostMode", + "traits": { + "smithy.api#documentation": "

Specifies whether the nodes in the cluster are created in a single outpost or across\n multiple outposts.

" + } + }, + "PreferredOutpostArn": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The outpost ARN in which the cache cluster is created.

" + } + }, + "PreferredOutpostArns": { + "target": "com.amazonaws.elasticache#PreferredOutpostArnList", + "traits": { + "smithy.api#documentation": "

The outpost ARNs in which the cache cluster is created.

" + } + }, + "LogDeliveryConfigurations": { + "target": "com.amazonaws.elasticache#LogDeliveryConfigurationRequestList", + "traits": { + "smithy.api#documentation": "

Specifies the destination, format and type of the logs.

" + } + }, + "TransitEncryptionEnabled": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A flag that enables in-transit encryption when set to true.

" + } + }, + "NetworkType": { + "target": "com.amazonaws.elasticache#NetworkType", + "traits": { + "smithy.api#documentation": "

Must be either ipv4 | ipv6 | dual_stack. IPv6\n is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2\n and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

" + } + }, + "IpDiscovery": { + "target": "com.amazonaws.elasticache#IpDiscovery", + "traits": { + "smithy.api#documentation": "

The network type you choose when modifying a cluster, either ipv4 |\n ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2\n and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a CreateCacheCluster operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#CreateCacheClusterResult": { + "type": "structure", + "members": { + "CacheCluster": { + "target": "com.amazonaws.elasticache#CacheCluster" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#CreateCacheParameterGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#CreateCacheParameterGroupMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#CreateCacheParameterGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#CacheParameterGroupAlreadyExistsFault" + }, + { + "target": "com.amazonaws.elasticache#CacheParameterGroupQuotaExceededFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidCacheParameterGroupStateFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#TagQuotaPerResourceExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new Amazon ElastiCache cache parameter group. An ElastiCache cache parameter\n group is a collection of parameters and their values that are applied to all of the\n nodes in any cluster or replication group using the CacheParameterGroup.

\n

A newly created CacheParameterGroup is an exact duplicate of the default parameter\n group for the CacheParameterGroupFamily. To customize the newly created\n CacheParameterGroup you can change the values of specific parameters. For more\n information, see:

\n ", + "smithy.api#examples": [ + { + "title": "CreateCacheParameterGroup", + "documentation": "Creates the Amazon ElastiCache parameter group custom-redis2-8.", + "input": { + "CacheParameterGroupName": "custom-redis2-8", + "CacheParameterGroupFamily": "redis2.8", + "Description": "Custom Redis 2.8 parameter group." + }, + "output": { + "CacheParameterGroup": { + "CacheParameterGroupName": "custom-redis2-8", + "CacheParameterGroupFamily": "redis2.8", + "Description": "Custom Redis 2.8 parameter group." + } + } + } + ] + } + }, + "com.amazonaws.elasticache#CreateCacheParameterGroupMessage": { + "type": "structure", + "members": { + "CacheParameterGroupName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A user-specified name for the cache parameter group.

", + "smithy.api#required": {} + } + }, + "CacheParameterGroupFamily": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the cache parameter group family that the cache parameter group can be\n used with.

\n

Valid values are: memcached1.4 | memcached1.5 |\n memcached1.6 | redis2.6 | redis2.8 |\n redis3.2 | redis4.0 | redis5.0 |\n redis6.x | redis7\n

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A user-specified description for the cache parameter group.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.elasticache#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must\n be accompanied by a tag value, although null is accepted.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a CreateCacheParameterGroup operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#CreateCacheParameterGroupResult": { + "type": "structure", + "members": { + "CacheParameterGroup": { + "target": "com.amazonaws.elasticache#CacheParameterGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#CreateCacheSecurityGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#CreateCacheSecurityGroupMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#CreateCacheSecurityGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#CacheSecurityGroupAlreadyExistsFault" + }, + { + "target": "com.amazonaws.elasticache#CacheSecurityGroupQuotaExceededFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#TagQuotaPerResourceExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new cache security group. Use a cache security group to control access to\n one or more clusters.

\n

Cache security groups are only used when you are creating a cluster outside of an\n Amazon Virtual Private Cloud (Amazon VPC). If you are creating a cluster inside of a\n VPC, use a cache subnet group instead. For more information, see CreateCacheSubnetGroup.

", + "smithy.api#examples": [ + { + "title": "CreateCacheSecurityGroup", + "documentation": "Creates an ElastiCache security group. ElastiCache security groups are only for clusters not running in an AWS VPC.", + "input": { + "CacheSecurityGroupName": "my-cache-sec-grp", + "Description": "Example ElastiCache security group." + } + } + ] + } + }, + "com.amazonaws.elasticache#CreateCacheSecurityGroupMessage": { + "type": "structure", + "members": { + "CacheSecurityGroupName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A name for the cache security group. This value is stored as a lowercase\n string.

\n

Constraints: Must contain no more than 255 alphanumeric characters. Cannot be the word\n \"Default\".

\n

Example: mysecuritygroup\n

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A description for the cache security group.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.elasticache#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must\n be accompanied by a tag value, although null is accepted.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a CreateCacheSecurityGroup operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#CreateCacheSecurityGroupResult": { + "type": "structure", + "members": { + "CacheSecurityGroup": { + "target": "com.amazonaws.elasticache#CacheSecurityGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#CreateCacheSubnetGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#CreateCacheSubnetGroupMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#CreateCacheSubnetGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#CacheSubnetGroupAlreadyExistsFault" + }, + { + "target": "com.amazonaws.elasticache#CacheSubnetGroupQuotaExceededFault" + }, + { + "target": "com.amazonaws.elasticache#CacheSubnetQuotaExceededFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidSubnet" + }, + { + "target": "com.amazonaws.elasticache#SubnetNotAllowedFault" + }, + { + "target": "com.amazonaws.elasticache#TagQuotaPerResourceExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new cache subnet group.

\n

Use this parameter only when you are creating a cluster in an Amazon Virtual Private\n Cloud (Amazon VPC).

", + "smithy.api#examples": [ + { + "title": "CreateCacheSubnet", + "documentation": "Creates a new cache subnet group.", + "input": { + "CacheSubnetGroupName": "my-sn-grp2", + "CacheSubnetGroupDescription": "Sample subnet group", + "SubnetIds": [ + "subnet-6f28c982", + "subnet-bcd382f3", + "subnet-845b3e7c0" + ] + }, + "output": { + "CacheSubnetGroup": { + "VpcId": "vpc-91280df6", + "CacheSubnetGroupDescription": "My subnet group.", + "Subnets": [ + { + "SubnetIdentifier": "subnet-6f28c982", + "SubnetAvailabilityZone": { + "Name": "us-east-1a" + } + }, + { + "SubnetIdentifier": "subnet-bcd382f3", + "SubnetAvailabilityZone": { + "Name": "us-east-1c" + } + }, + { + "SubnetIdentifier": "subnet-845b3e7c0", + "SubnetAvailabilityZone": { + "Name": "us-east-1b" + } + } + ], + "CacheSubnetGroupName": "my-sn-grp" + } + } + } + ] + } + }, + "com.amazonaws.elasticache#CreateCacheSubnetGroupMessage": { + "type": "structure", + "members": { + "CacheSubnetGroupName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A name for the cache subnet group. This value is stored as a lowercase string.

\n

Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

\n

Example: mysubnetgroup\n

", + "smithy.api#required": {} + } + }, + "CacheSubnetGroupDescription": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A description for the cache subnet group.

", + "smithy.api#required": {} + } + }, + "SubnetIds": { + "target": "com.amazonaws.elasticache#SubnetIdentifierList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A list of VPC subnet IDs for the cache subnet group.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.elasticache#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must\n be accompanied by a tag value, although null is accepted.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a CreateCacheSubnetGroup operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#CreateCacheSubnetGroupResult": { + "type": "structure", + "members": { + "CacheSubnetGroup": { + "target": "com.amazonaws.elasticache#CacheSubnetGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#CreateGlobalReplicationGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#CreateGlobalReplicationGroupMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#CreateGlobalReplicationGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#GlobalReplicationGroupAlreadyExistsFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#InvalidReplicationGroupStateFault" + }, + { + "target": "com.amazonaws.elasticache#ReplicationGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#ServiceLinkedRoleNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Global Datastore offers fully managed, fast, reliable and secure\n cross-region replication. Using Global Datastore with Valkey or Redis OSS, you can create cross-region\n read replica clusters for ElastiCache to enable low-latency reads and disaster\n recovery across regions. For more information, see Replication\n Across Regions Using Global Datastore.

\n " + } + }, + "com.amazonaws.elasticache#CreateGlobalReplicationGroupMessage": { + "type": "structure", + "members": { + "GlobalReplicationGroupIdSuffix": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The suffix name of a Global datastore. Amazon ElastiCache automatically applies a\n prefix to the Global datastore ID when it is created. Each Amazon Region has its own\n prefix. For instance, a Global datastore ID created in the US-West-1 region will begin\n with \"dsdfu\" along with the suffix name you provide. The suffix, combined with the\n auto-generated prefix, guarantees uniqueness of the Global datastore name across\n multiple regions.

\n

For a full list of Amazon Regions and their respective Global datastore iD prefixes,\n see Using the Amazon CLI with Global datastores .

", + "smithy.api#required": {} + } + }, + "GlobalReplicationGroupDescription": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

Provides details of the Global datastore

" + } + }, + "PrimaryReplicationGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the primary cluster that accepts writes and will replicate updates to the\n secondary cluster.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#CreateGlobalReplicationGroupResult": { + "type": "structure", + "members": { + "GlobalReplicationGroup": { + "target": "com.amazonaws.elasticache#GlobalReplicationGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#CreateReplicationGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#CreateReplicationGroupMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#CreateReplicationGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#CacheClusterNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#CacheParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#CacheSecurityGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#CacheSubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#ClusterQuotaForCustomerExceededFault" + }, + { + "target": "com.amazonaws.elasticache#GlobalReplicationGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#InsufficientCacheClusterCapacityFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidCacheClusterStateFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidGlobalReplicationGroupStateFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#InvalidUserGroupStateFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidVPCNetworkStateFault" + }, + { + "target": "com.amazonaws.elasticache#NodeGroupsPerReplicationGroupQuotaExceededFault" + }, + { + "target": "com.amazonaws.elasticache#NodeQuotaForClusterExceededFault" + }, + { + "target": "com.amazonaws.elasticache#NodeQuotaForCustomerExceededFault" + }, + { + "target": "com.amazonaws.elasticache#ReplicationGroupAlreadyExistsFault" + }, + { + "target": "com.amazonaws.elasticache#TagQuotaPerResourceExceeded" + }, + { + "target": "com.amazonaws.elasticache#UserGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a Valkey or Redis OSS (cluster mode disabled) or a Valkey or Redis OSS (cluster mode enabled) replication\n group.

\n

This API can be used to create a standalone regional replication group or a secondary\n replication group associated with a Global datastore.

\n

A Valkey or Redis OSS (cluster mode disabled) replication group is a collection of nodes, where\n one of the nodes is a read/write primary and the others are read-only replicas.\n Writes to the primary are asynchronously propagated to the replicas.

\n

A Valkey or Redis OSS cluster-mode enabled cluster is comprised of from 1 to 90 shards (API/CLI:\n node groups). Each shard has a primary node and up to 5 read-only replica nodes. The\n configuration can range from 90 shards and 0 replicas to 15 shards and 5 replicas, which\n is the maximum number or replicas allowed.

\n

The node or shard limit can be increased to a maximum of 500 per cluster if the Valkey or Redis OSS \n engine version is 5.0.6 or higher. For example, you can choose to configure a 500 node\n cluster that ranges between 83 shards (one primary and 5 replicas per shard) and 500\n shards (single primary and no replicas). Make sure there are enough available IP\n addresses to accommodate the increase. Common pitfalls include the subnets in the subnet\n group have too small a CIDR range or the subnets are shared and heavily used by other\n clusters. For more information, see Creating a Subnet\n Group. For versions below 5.0.6, the limit is 250 per cluster.

\n

To request a limit increase, see Amazon Service Limits and\n choose the limit type Nodes per cluster per instance\n type.

\n

When a Valkey or Redis OSS (cluster mode disabled) replication group has been successfully created,\n you can add one or more read replicas to it, up to a total of 5 read replicas. If you\n need to increase or decrease the number of node groups (console: shards), you can use scaling. \n For more information, see Scaling self-designed clusters in the ElastiCache User\n Guide.

\n \n

This operation is valid for Valkey and Redis OSS only.

\n ", + "smithy.api#examples": [ + { + "title": "CreateCacheReplicationGroup", + "documentation": "Creates a Redis replication group with 3 nodes.", + "input": { + "ReplicationGroupId": "my-redis-rg", + "ReplicationGroupDescription": "A Redis replication group.", + "AutomaticFailoverEnabled": true, + "NumCacheClusters": 3, + "CacheNodeType": "cache.m3.medium", + "Engine": "redis", + "EngineVersion": "2.8.24", + "SnapshotRetentionLimit": 30 + }, + "output": { + "ReplicationGroup": { + "Status": "creating", + "Description": "A Redis replication group.", + "ReplicationGroupId": "my-redis-rg", + "AutomaticFailover": "enabling", + "SnapshottingClusterId": "my-redis-rg-002", + "MemberClusters": [ + "my-redis-rg-001", + "my-redis-rg-002", + "my-redis-rg-003" + ], + "PendingModifiedValues": {} + } + } + }, + { + "title": "CreateReplicationGroup", + "documentation": "Creates a Redis (cluster mode enabled) replication group with two shards. One shard has one read replica node and the other shard has two read replicas.", + "input": { + "ReplicationGroupId": "clustered-redis-rg", + "ReplicationGroupDescription": "A multi-sharded replication group", + "NumNodeGroups": 2, + "NodeGroupConfiguration": [ + { + "Slots": "0-8999", + "PrimaryAvailabilityZone": "us-east-1c", + "ReplicaCount": 1, + "ReplicaAvailabilityZones": [ + "us-east-1b" + ] + }, + { + "Slots": "9000-16383", + "PrimaryAvailabilityZone": "us-east-1a", + "ReplicaCount": 2, + "ReplicaAvailabilityZones": [ + "us-east-1a", + "us-east-1c" + ] + } + ], + "CacheNodeType": "cache.m3.medium", + "Engine": "redis", + "EngineVersion": "3.2.4", + "CacheParameterGroupName": "default.redis3.2.cluster.on", + "AutoMinorVersionUpgrade": true, + "SnapshotRetentionLimit": 8 + }, + "output": { + "ReplicationGroup": { + "Status": "creating", + "Description": "Sharded replication group", + "ReplicationGroupId": "clustered-redis-rg", + "SnapshotRetentionLimit": 8, + "AutomaticFailover": "enabled", + "SnapshotWindow": "05:30-06:30", + "MemberClusters": [ + "rc-rg3-0001-001", + "rc-rg3-0001-002", + "rc-rg3-0002-001", + "rc-rg3-0002-002", + "rc-rg3-0002-003" + ], + "PendingModifiedValues": {} + } + } + } + ] + } + }, + "com.amazonaws.elasticache#CreateReplicationGroupMessage": { + "type": "structure", + "members": { + "ReplicationGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The replication group identifier. This parameter is stored as a lowercase\n string.

\n

Constraints:

\n ", + "smithy.api#required": {} + } + }, + "ReplicationGroupDescription": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A user-created description for the replication group.

", + "smithy.api#required": {} + } + }, + "GlobalReplicationGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the Global datastore

" + } + }, + "PrimaryClusterId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The identifier of the cluster that serves as the primary for this replication group.\n This cluster must already exist and have a status of available.

\n

This parameter is not required if NumCacheClusters,\n NumNodeGroups, or ReplicasPerNodeGroup is\n specified.

" + } + }, + "AutomaticFailoverEnabled": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether a read-only replica is automatically promoted to read/write primary\n if the existing primary fails.

\n

\n AutomaticFailoverEnabled must be enabled for Valkey or Redis OSS (cluster mode enabled)\n replication groups.

\n

Default: false

" + } + }, + "MultiAZEnabled": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more\n information, see Minimizing Downtime: Multi-AZ.

" + } + }, + "NumCacheClusters": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of clusters this replication group initially has.

\n

This parameter is not used if there is more than one node group (shard). You should\n use ReplicasPerNodeGroup instead.

\n

If AutomaticFailoverEnabled is true, the value of this\n parameter must be at least 2. If AutomaticFailoverEnabled is\n false you can omit this parameter (it will default to 1), or you can\n explicitly set it to a value between 2 and 6.

\n

The maximum permitted value for NumCacheClusters is 6 (1 primary plus 5\n replicas).

" + } + }, + "PreferredCacheClusterAZs": { + "target": "com.amazonaws.elasticache#AvailabilityZonesList", + "traits": { + "smithy.api#documentation": "

A list of EC2 Availability Zones in which the replication group's clusters are\n created. The order of the Availability Zones in the list is the order in which clusters\n are allocated. The primary cluster is created in the first AZ in the list.

\n

This parameter is not used if there is more than one node group (shard). You should\n use NodeGroupConfiguration instead.

\n \n

If you are creating your replication group in an Amazon VPC (recommended), you can\n only locate clusters in Availability Zones associated with the subnets in the\n selected subnet group.

\n

The number of Availability Zones listed must equal the value of\n NumCacheClusters.

\n \n

Default: system chosen Availability Zones.

" + } + }, + "NumNodeGroups": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

An optional parameter that specifies the number of node groups (shards) for this Valkey or Redis OSS (cluster mode enabled) replication group. For Valkey or Redis OSS (cluster mode disabled) either omit\n this parameter or set it to 1.

\n

Default: 1

" + } + }, + "ReplicasPerNodeGroup": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

An optional parameter that specifies the number of replica nodes in each node group\n (shard). Valid values are 0 to 5.

" + } + }, + "NodeGroupConfiguration": { + "target": "com.amazonaws.elasticache#NodeGroupConfigurationList", + "traits": { + "smithy.api#documentation": "

A list of node group (shard) configuration options. Each node group (shard)\n configuration has the following members: PrimaryAvailabilityZone,\n ReplicaAvailabilityZones, ReplicaCount, and\n Slots.

\n

If you're creating a Valkey or Redis OSS (cluster mode disabled) or a Valkey or Redis OSS (cluster mode enabled)\n replication group, you can use this parameter to individually configure each node group\n (shard), or you can omit this parameter. However, it is required when seeding a Valkey or Redis OSS (cluster mode enabled) cluster from a S3 rdb file. You must configure each node group\n (shard) using this parameter because you must specify the slots for each node\n group.

" + } + }, + "CacheNodeType": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The compute and memory capacity of the nodes in the node group (shard).

\n

The following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.

\n \n

\n Additional node type info\n

\n " + } + }, + "Engine": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the cache engine to be used for the clusters in this replication group.\n The value must be set to Redis.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The version number of the cache engine to be used for the clusters in this replication\n group. To view the supported cache engine versions, use the\n DescribeCacheEngineVersions operation.

\n

\n Important: You can upgrade to a newer engine version\n (see Selecting\n a Cache Engine and Version) in the ElastiCache User\n Guide, but you cannot downgrade to an earlier engine version. If you want\n to use an earlier engine version, you must delete the existing cluster or replication\n group and create it anew with the earlier engine version.

" + } + }, + "CacheParameterGroupName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the parameter group to associate with this replication group. If this\n argument is omitted, the default cache parameter group for the specified engine is\n used.

\n

If you are running Valkey or Redis OSS version 3.2.4 or later, only one node group (shard), and want\n to use a default parameter group, we recommend that you specify the parameter group by\n name.

\n " + } + }, + "CacheSubnetGroupName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the cache subnet group to be used for the replication group.

\n \n

If you're going to launch your cluster in an Amazon VPC, you need to create a\n subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.

\n " + } + }, + "CacheSecurityGroupNames": { + "target": "com.amazonaws.elasticache#CacheSecurityGroupNameList", + "traits": { + "smithy.api#documentation": "

A list of cache security group names to associate with this replication group.

" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.elasticache#SecurityGroupIdsList", + "traits": { + "smithy.api#documentation": "

One or more Amazon VPC security groups associated with this replication group.

\n

Use this parameter only when you are creating a replication group in an Amazon Virtual\n Private Cloud (Amazon VPC).

" + } + }, + "Tags": { + "target": "com.amazonaws.elasticache#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags to be added to this resource. Tags are comma-separated key,value pairs\n (e.g. Key=myKey, Value=myKeyValue. You can include multiple\n tags as shown following: Key=myKey, Value=myKeyValue\n Key=mySecondKey, Value=mySecondKeyValue. Tags on\n replication groups will be replicated to all nodes.

" + } + }, + "SnapshotArns": { + "target": "com.amazonaws.elasticache#SnapshotArnsList", + "traits": { + "smithy.api#documentation": "

A list of Amazon Resource Names (ARN) that uniquely identify the Valkey or Redis OSS RDB snapshot\n files stored in Amazon S3. The snapshot files are used to populate the new replication\n group. The Amazon S3 object name in the ARN cannot contain any commas. The new\n replication group will have the number of node groups (console: shards) specified by the\n parameter NumNodeGroups or the number of node groups configured by\n NodeGroupConfiguration regardless of the number of ARNs\n specified here.

\n

Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb\n

" + } + }, + "SnapshotName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of a snapshot from which to restore data into the new replication group. The\n snapshot status changes to restoring while the new replication group is\n being created.

" + } + }, + "PreferredMaintenanceWindow": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

Specifies the weekly time range during which maintenance on the cluster is performed.\n It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The\n minimum maintenance window is a 60 minute period.

\n

Valid values for ddd are:

\n \n

Example: sun:23:00-mon:01:30\n

" + } + }, + "Port": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port number on which each member of the replication group accepts\n connections.

" + } + }, + "NotificationTopicArn": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic\n to which notifications are sent.

\n \n

The Amazon SNS topic owner must be the same as the cluster owner.

\n " + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "

 If you are running Valkey 7.2 and above or Redis OSS engine version 6.0 and above, set this parameter to yes \n to opt-in to the next auto minor version upgrade campaign. This parameter is\n disabled for previous versions. 

" + } + }, + "SnapshotRetentionLimit": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days for which ElastiCache retains automatic snapshots before deleting\n them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that\n was taken today is retained for 5 days before being deleted.

\n

Default: 0 (i.e., automatic backups are disabled for this cluster).

" + } + }, + "SnapshotWindow": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot\n of your node group (shard).

\n

Example: 05:00-09:00\n

\n

If you do not specify this parameter, ElastiCache automatically chooses an appropriate\n time range.

" + } + }, + "AuthToken": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

\n Reserved parameter. The password used to access a\n password protected server.

\n

\n AuthToken can be specified only on replication groups where\n TransitEncryptionEnabled is true.

\n \n

For HIPAA compliance, you must specify TransitEncryptionEnabled as\n true, an AuthToken, and a\n CacheSubnetGroup.

\n \n

Password constraints:

\n \n

For more information, see AUTH\n password at http://redis.io/commands/AUTH.

" + } + }, + "TransitEncryptionEnabled": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A flag that enables in-transit encryption when set to true.

\n

This parameter is valid only if the Engine parameter is\n redis, the EngineVersion parameter is 3.2.6,\n 4.x or later, and the cluster is being created in an Amazon VPC.

\n

If you enable in-transit encryption, you must also specify a value for\n CacheSubnetGroup.

\n

\n Required: Only available when creating a replication\n group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or\n later.

\n

Default: false\n

\n \n

For HIPAA compliance, you must specify TransitEncryptionEnabled as\n true, an AuthToken, and a\n CacheSubnetGroup.

\n " + } + }, + "AtRestEncryptionEnabled": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A flag that enables encryption at rest when set to true.

\n

You cannot modify the value of AtRestEncryptionEnabled after the\n replication group is created. To enable encryption at rest on a replication group you\n must set AtRestEncryptionEnabled to true when you create the\n replication group.

\n

\n Required: Only available when creating a replication\n group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or\n later.

\n

Default: false\n

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The ID of the KMS key used to encrypt the disk in the cluster.

" + } + }, + "UserGroupIds": { + "target": "com.amazonaws.elasticache#UserGroupIdListInput", + "traits": { + "smithy.api#documentation": "

The user group to associate with the replication group.

" + } + }, + "LogDeliveryConfigurations": { + "target": "com.amazonaws.elasticache#LogDeliveryConfigurationRequestList", + "traits": { + "smithy.api#documentation": "

Specifies the destination, format and type of the logs.

" + } + }, + "DataTieringEnabled": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Enables data tiering. Data tiering is only supported for replication groups using the\n r6gd node type. This parameter must be set to true when using r6gd nodes. For more\n information, see Data tiering.

" + } + }, + "NetworkType": { + "target": "com.amazonaws.elasticache#NetworkType", + "traits": { + "smithy.api#documentation": "

Must be either ipv4 | ipv6 | dual_stack. IPv6\n is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2\n and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

" + } + }, + "IpDiscovery": { + "target": "com.amazonaws.elasticache#IpDiscovery", + "traits": { + "smithy.api#documentation": "

The network type you choose when creating a replication group, either\n ipv4 | ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2\n and above or Memcached engine version 1.6.6 and above on all instances built on\n the Nitro system.

" + } + }, + "TransitEncryptionMode": { + "target": "com.amazonaws.elasticache#TransitEncryptionMode", + "traits": { + "smithy.api#documentation": "

A setting that allows you to migrate your clients to use in-transit encryption, with\n no downtime.

\n

When setting TransitEncryptionEnabled to true, you can set\n your TransitEncryptionMode to preferred in the same request,\n to allow both encrypted and unencrypted connections at the same time. Once you migrate\n all your Valkey or Redis OSS clients to use encrypted connections you can modify the value to\n required to allow encrypted connections only.

\n

Setting TransitEncryptionMode to required is a two-step\n process that requires you to first set the TransitEncryptionMode to\n preferred, after that you can set TransitEncryptionMode to\n required.

\n

This process will not trigger the replacement of the replication group.

" + } + }, + "ClusterMode": { + "target": "com.amazonaws.elasticache#ClusterMode", + "traits": { + "smithy.api#documentation": "

Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first\n set the cluster mode to Compatible. Compatible mode allows your Valkey or Redis OSS clients to connect\n using both cluster mode enabled and cluster mode disabled. After you migrate all Valkey or Redis OSS \n clients to use cluster mode enabled, you can then complete cluster mode configuration\n and set the cluster mode to Enabled.

" + } + }, + "ServerlessCacheSnapshotName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the snapshot used to create a replication group. Available for Valkey, Redis OSS only.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a CreateReplicationGroup operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#CreateReplicationGroupResult": { + "type": "structure", + "members": { + "ReplicationGroup": { + "target": "com.amazonaws.elasticache#ReplicationGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#CreateServerlessCache": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#CreateServerlessCacheRequest" + }, + "output": { + "target": "com.amazonaws.elasticache#CreateServerlessCacheResponse" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#InvalidCredentialsException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#InvalidServerlessCacheStateFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidUserGroupStateFault" + }, + { + "target": "com.amazonaws.elasticache#ServerlessCacheAlreadyExistsFault" + }, + { + "target": "com.amazonaws.elasticache#ServerlessCacheNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#ServerlessCacheQuotaForCustomerExceededFault" + }, + { + "target": "com.amazonaws.elasticache#ServiceLinkedRoleNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#TagQuotaPerResourceExceeded" + }, + { + "target": "com.amazonaws.elasticache#UserGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a serverless cache.

" + } + }, + "com.amazonaws.elasticache#CreateServerlessCacheRequest": { + "type": "structure", + "members": { + "ServerlessCacheName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

User-provided identifier for the serverless cache. This parameter is stored as a lowercase string.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

User-provided description for the serverless cache. \n The default is NULL, i.e. if no description is provided then an empty string will be returned. \n The maximum length is 255 characters.

" + } + }, + "Engine": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the cache engine to be used for creating the serverless cache.

", + "smithy.api#required": {} + } + }, + "MajorEngineVersion": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The version of the cache engine that will be used to create the serverless cache.

" + } + }, + "CacheUsageLimits": { + "target": "com.amazonaws.elasticache#CacheUsageLimits", + "traits": { + "smithy.api#documentation": "

Sets the cache usage limits for storage and ElastiCache Processing Units for the cache.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

ARN of the customer managed key for encrypting the data at rest. If no KMS key is provided, a default service key is used.

" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.elasticache#SecurityGroupIdsList", + "traits": { + "smithy.api#documentation": "

A list of the one or more VPC security groups to be associated with the serverless cache. \n The security group will authorize traffic access for the VPC end-point (private-link). \n If no other information is given this will be the VPC’s Default Security Group that is associated with the cluster VPC \n end-point.

" + } + }, + "SnapshotArnsToRestore": { + "target": "com.amazonaws.elasticache#SnapshotArnsList", + "traits": { + "smithy.api#documentation": "

The ARN(s) of the snapshot that the new serverless cache will be created from. Available for Valkey, Redis OSS and Serverless Memcached only.

" + } + }, + "Tags": { + "target": "com.amazonaws.elasticache#TagList", + "traits": { + "smithy.api#documentation": "

The list of tags (key, value) pairs to be added to the serverless cache resource. Default is NULL.

" + } + }, + "UserGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The identifier of the UserGroup to be associated with the serverless cache. Available for Valkey and Redis OSS only. Default is NULL.

" + } + }, + "SubnetIds": { + "target": "com.amazonaws.elasticache#SubnetIdsList", + "traits": { + "smithy.api#documentation": "

A list of the identifiers of the subnets where the VPC endpoint for the serverless cache will be deployed. \n All the subnetIds must belong to the same VPC.

" + } + }, + "SnapshotRetentionLimit": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of snapshots that will be retained for the serverless cache that is being created. \n As new snapshots beyond this limit are added, the oldest snapshots will be deleted on a rolling basis. Available for Valkey, Redis OSS and Serverless Memcached only.

" + } + }, + "DailySnapshotTime": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The daily time that snapshots will be created from the new serverless cache. By default this number is populated with \n 0, i.e. no snapshots will be created on an automatic daily basis. Available for Valkey, Redis OSS and Serverless Memcached only.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#CreateServerlessCacheResponse": { + "type": "structure", + "members": { + "ServerlessCache": { + "target": "com.amazonaws.elasticache#ServerlessCache", + "traits": { + "smithy.api#documentation": "

The response for the attempt to create the serverless cache.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#CreateServerlessCacheSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#CreateServerlessCacheSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.elasticache#CreateServerlessCacheSnapshotResponse" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#InvalidServerlessCacheStateFault" + }, + { + "target": "com.amazonaws.elasticache#ServerlessCacheNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#ServerlessCacheSnapshotAlreadyExistsFault" + }, + { + "target": "com.amazonaws.elasticache#ServerlessCacheSnapshotQuotaExceededFault" + }, + { + "target": "com.amazonaws.elasticache#ServiceLinkedRoleNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#TagQuotaPerResourceExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

This API creates a copy of an entire ServerlessCache at a specific moment in time. Available for Valkey, Redis OSS and Serverless Memcached only.

" + } + }, + "com.amazonaws.elasticache#CreateServerlessCacheSnapshotRequest": { + "type": "structure", + "members": { + "ServerlessCacheSnapshotName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name for the snapshot being created. Must be unique for the customer account. Available for Valkey, Redis OSS and Serverless Memcached only.\n Must be between 1 and 255 characters.

", + "smithy.api#required": {} + } + }, + "ServerlessCacheName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of an existing serverless cache. The snapshot is created from this cache. Available for Valkey, Redis OSS and Serverless Memcached only.

", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The ID of the KMS key used to encrypt the snapshot. Available for Valkey, Redis OSS and Serverless Memcached only. Default: NULL

" + } + }, + "Tags": { + "target": "com.amazonaws.elasticache#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags to be added to the snapshot resource. A tag is a key-value pair. Available for Valkey, Redis OSS and Serverless Memcached only.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#CreateServerlessCacheSnapshotResponse": { + "type": "structure", + "members": { + "ServerlessCacheSnapshot": { + "target": "com.amazonaws.elasticache#ServerlessCacheSnapshot", + "traits": { + "smithy.api#documentation": "

The state of a serverless cache snapshot at a specific point in time, to the millisecond. Available for Valkey, Redis OSS and Serverless Memcached only.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#CreateSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#CreateSnapshotMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#CreateSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#CacheClusterNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidCacheClusterStateFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#InvalidReplicationGroupStateFault" + }, + { + "target": "com.amazonaws.elasticache#ReplicationGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#SnapshotAlreadyExistsFault" + }, + { + "target": "com.amazonaws.elasticache#SnapshotFeatureNotSupportedFault" + }, + { + "target": "com.amazonaws.elasticache#SnapshotQuotaExceededFault" + }, + { + "target": "com.amazonaws.elasticache#TagQuotaPerResourceExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a copy of an entire cluster or replication group at a specific moment in\n time.

\n \n

This operation is valid for Valkey or Redis OSS only.

\n ", + "smithy.api#examples": [ + { + "title": "CreateSnapshot - NonClustered Redis, 2 read-replicas", + "documentation": "Creates a snapshot of a non-clustered Redis cluster that has only three nodes, primary and two read-replicas. CacheClusterId must be a specific node in the cluster.", + "input": { + "CacheClusterId": "threenoderedis-001", + "SnapshotName": "snapshot-2" + }, + "output": { + "Snapshot": { + "Engine": "redis", + "CacheParameterGroupName": "default.redis3.2", + "VpcId": "vpc-73c3cd17", + "CacheClusterId": "threenoderedis-001", + "SnapshotRetentionLimit": 1, + "NumCacheNodes": 1, + "SnapshotName": "snapshot-2", + "CacheClusterCreateTime": "2017-02-03T15:43:36.278Z", + "AutoMinorVersionUpgrade": true, + "PreferredAvailabilityZone": "us-west-2c", + "SnapshotStatus": "creating", + "SnapshotSource": "manual", + "SnapshotWindow": "00:00-01:00", + "EngineVersion": "3.2.4", + "NodeSnapshots": [ + { + "CacheSize": "", + "CacheNodeId": "0001", + "CacheNodeCreateTime": "2017-02-03T15:43:36.278Z" + } + ], + "CacheSubnetGroupName": "default", + "Port": 6379, + "PreferredMaintenanceWindow": "sat:08:00-sat:09:00", + "CacheNodeType": "cache.m3.medium" + } + } + }, + { + "title": "CreateSnapshot - NonClustered Redis, no read-replicas", + "documentation": "Creates a snapshot of a non-clustered Redis cluster that has only one node.", + "input": { + "CacheClusterId": "onenoderedis", + "SnapshotName": "snapshot-1" + }, + "output": { + "Snapshot": { + "Engine": "redis", + "CacheParameterGroupName": "default.redis3.2", + "VpcId": "vpc-73c3cd17", + "CacheClusterId": "onenoderedis", + "SnapshotRetentionLimit": 1, + "NumCacheNodes": 1, + "SnapshotName": "snapshot-1", + "CacheClusterCreateTime": "2017-02-03T15:43:36.278Z", + "AutoMinorVersionUpgrade": true, + "PreferredAvailabilityZone": "us-west-2c", + "SnapshotStatus": "creating", + "SnapshotSource": "manual", + "SnapshotWindow": "00:00-01:00", + "EngineVersion": "3.2.4", + "NodeSnapshots": [ + { + "CacheSize": "", + "CacheNodeId": "0001", + "CacheNodeCreateTime": "2017-02-03T15:43:36.278Z" + } + ], + "CacheSubnetGroupName": "default", + "Port": 6379, + "PreferredMaintenanceWindow": "sat:08:00-sat:09:00", + "CacheNodeType": "cache.m3.medium" + } + } + }, + { + "title": "CreateSnapshot-clustered Redis", + "documentation": "Creates a snapshot of a clustered Redis cluster that has 2 shards, each with a primary and 4 read-replicas.", + "input": { + "ReplicationGroupId": "clusteredredis", + "SnapshotName": "snapshot-2x5" + }, + "output": { + "Snapshot": { + "Engine": "redis", + "CacheParameterGroupName": "default.redis3.2.cluster.on", + "VpcId": "vpc-73c3cd17", + "NodeSnapshots": [ + { + "CacheSize": "", + "NodeGroupId": "0001" + }, + { + "CacheSize": "", + "NodeGroupId": "0002" + } + ], + "NumNodeGroups": 2, + "SnapshotName": "snapshot-2x5", + "ReplicationGroupId": "clusteredredis", + "AutoMinorVersionUpgrade": true, + "SnapshotRetentionLimit": 1, + "AutomaticFailover": "enabled", + "SnapshotStatus": "creating", + "SnapshotSource": "manual", + "SnapshotWindow": "12:00-13:00", + "EngineVersion": "3.2.4", + "CacheSubnetGroupName": "default", + "ReplicationGroupDescription": "Redis cluster with 2 shards.", + "Port": 6379, + "PreferredMaintenanceWindow": "mon:09:30-mon:10:30", + "CacheNodeType": "cache.m3.medium" + } + } + } + ] + } + }, + "com.amazonaws.elasticache#CreateSnapshotMessage": { + "type": "structure", + "members": { + "ReplicationGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The identifier of an existing replication group. The snapshot is created from this\n replication group.

" + } + }, + "CacheClusterId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The identifier of an existing cluster. The snapshot is created from this\n cluster.

" + } + }, + "SnapshotName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A name for the snapshot being created.

", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The ID of the KMS key used to encrypt the snapshot.

" + } + }, + "Tags": { + "target": "com.amazonaws.elasticache#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must\n be accompanied by a tag value, although null is accepted.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a CreateSnapshot operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#CreateSnapshotResult": { + "type": "structure", + "members": { + "Snapshot": { + "target": "com.amazonaws.elasticache#Snapshot" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#CreateUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#CreateUserMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#User" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#DuplicateUserNameFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#ServiceLinkedRoleNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#TagQuotaPerResourceExceeded" + }, + { + "target": "com.amazonaws.elasticache#UserAlreadyExistsFault" + }, + { + "target": "com.amazonaws.elasticache#UserQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

For Valkey engine version 7.2 onwards and Redis OSS 6.0 and onwards: Creates a user. For more information, see\n Using Role Based Access Control (RBAC).

" + } + }, + "com.amazonaws.elasticache#CreateUserGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#CreateUserGroupMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#UserGroup" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#DefaultUserRequired" + }, + { + "target": "com.amazonaws.elasticache#DuplicateUserNameFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#ServiceLinkedRoleNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#TagQuotaPerResourceExceeded" + }, + { + "target": "com.amazonaws.elasticache#UserGroupAlreadyExistsFault" + }, + { + "target": "com.amazonaws.elasticache#UserGroupQuotaExceededFault" + }, + { + "target": "com.amazonaws.elasticache#UserNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

For Valkey engine version 7.2 onwards and Redis OSS 6.0 onwards: Creates a user group. For more\n information, see Using Role Based Access Control (RBAC)\n

" + } + }, + "com.amazonaws.elasticache#CreateUserGroupMessage": { + "type": "structure", + "members": { + "UserGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the user group.

", + "smithy.api#required": {} + } + }, + "Engine": { + "target": "com.amazonaws.elasticache#EngineType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The current supported value is Redis user.

", + "smithy.api#required": {} + } + }, + "UserIds": { + "target": "com.amazonaws.elasticache#UserIdListInput", + "traits": { + "smithy.api#documentation": "

The list of user IDs that belong to the user group.

" + } + }, + "Tags": { + "target": "com.amazonaws.elasticache#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must\n be accompanied by a tag value, although null is accepted. Available for Valkey and Redis OSS only.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#CreateUserMessage": { + "type": "structure", + "members": { + "UserId": { + "target": "com.amazonaws.elasticache#UserId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the user.

", + "smithy.api#required": {} + } + }, + "UserName": { + "target": "com.amazonaws.elasticache#UserName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The username of the user.

", + "smithy.api#required": {} + } + }, + "Engine": { + "target": "com.amazonaws.elasticache#EngineType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The current supported value is Redis.

", + "smithy.api#required": {} + } + }, + "Passwords": { + "target": "com.amazonaws.elasticache#PasswordListInput", + "traits": { + "smithy.api#documentation": "

Passwords used for this user. You can create up to two passwords for each user.

" + } + }, + "AccessString": { + "target": "com.amazonaws.elasticache#AccessString", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Access permissions string used for this user.

", + "smithy.api#required": {} + } + }, + "NoPasswordRequired": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates a password is not required for this user.

" + } + }, + "Tags": { + "target": "com.amazonaws.elasticache#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must\n be accompanied by a tag value, although null is accepted.

" + } + }, + "AuthenticationMode": { + "target": "com.amazonaws.elasticache#AuthenticationMode", + "traits": { + "smithy.api#documentation": "

Specifies how to authenticate the user.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#CustomerNodeEndpoint": { + "type": "structure", + "members": { + "Address": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The address of the node endpoint

" + } + }, + "Port": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port of the node endpoint

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The endpoint from which data should be migrated.

" + } + }, + "com.amazonaws.elasticache#CustomerNodeEndpointList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#CustomerNodeEndpoint" + } + }, + "com.amazonaws.elasticache#DataStorage": { + "type": "structure", + "members": { + "Maximum": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The upper limit for data storage the cache is set to use.

" + } + }, + "Minimum": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The lower limit for data storage the cache is set to use.

" + } + }, + "Unit": { + "target": "com.amazonaws.elasticache#DataStorageUnit", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The unit that the storage is measured in, in GB.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The data storage limit.

" + } + }, + "com.amazonaws.elasticache#DataStorageUnit": { + "type": "enum", + "members": { + "GB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GB" + } + } + } + }, + "com.amazonaws.elasticache#DataTieringStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + } + } + }, + "com.amazonaws.elasticache#DecreaseNodeGroupsInGlobalReplicationGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#DecreaseNodeGroupsInGlobalReplicationGroupMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#DecreaseNodeGroupsInGlobalReplicationGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#GlobalReplicationGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidGlobalReplicationGroupStateFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + } + ], + "traits": { + "smithy.api#documentation": "

Decreases the number of node groups in a Global datastore

" + } + }, + "com.amazonaws.elasticache#DecreaseNodeGroupsInGlobalReplicationGroupMessage": { + "type": "structure", + "members": { + "GlobalReplicationGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Global datastore

", + "smithy.api#required": {} + } + }, + "NodeGroupCount": { + "target": "com.amazonaws.elasticache#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of node groups (shards) that results from the modification of the shard\n configuration

", + "smithy.api#required": {} + } + }, + "GlobalNodeGroupsToRemove": { + "target": "com.amazonaws.elasticache#GlobalNodeGroupIdList", + "traits": { + "smithy.api#documentation": "

If the value of NodeGroupCount is less than the current number of node groups\n (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required.\n GlobalNodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster.\n ElastiCache will attempt to remove all node groups listed by\n GlobalNodeGroupsToRemove from the cluster.

" + } + }, + "GlobalNodeGroupsToRetain": { + "target": "com.amazonaws.elasticache#GlobalNodeGroupIdList", + "traits": { + "smithy.api#documentation": "

If the value of NodeGroupCount is less than the current number of node groups\n (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required.\n GlobalNodeGroupsToRetain is a list of NodeGroupIds to retain from the cluster.\n ElastiCache will attempt to retain all node groups listed by\n GlobalNodeGroupsToRetain from the cluster.

" + } + }, + "ApplyImmediately": { + "target": "com.amazonaws.elasticache#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Indicates that the shard reconfiguration process begins immediately. At present, the\n only permitted value for this parameter is true.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#DecreaseNodeGroupsInGlobalReplicationGroupResult": { + "type": "structure", + "members": { + "GlobalReplicationGroup": { + "target": "com.amazonaws.elasticache#GlobalReplicationGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#DecreaseReplicaCount": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#DecreaseReplicaCountMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#DecreaseReplicaCountResult" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#ClusterQuotaForCustomerExceededFault" + }, + { + "target": "com.amazonaws.elasticache#InsufficientCacheClusterCapacityFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidCacheClusterStateFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#InvalidReplicationGroupStateFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidVPCNetworkStateFault" + }, + { + "target": "com.amazonaws.elasticache#NodeGroupsPerReplicationGroupQuotaExceededFault" + }, + { + "target": "com.amazonaws.elasticache#NodeQuotaForCustomerExceededFault" + }, + { + "target": "com.amazonaws.elasticache#NoOperationFault" + }, + { + "target": "com.amazonaws.elasticache#ReplicationGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#ServiceLinkedRoleNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Dynamically decreases the number of replicas in a Valkey or Redis OSS (cluster mode disabled)\n replication group or the number of replica nodes in one or more node groups (shards) of\n a Valkey or Redis OSS (cluster mode enabled) replication group. This operation is performed with no\n cluster down time.

" + } + }, + "com.amazonaws.elasticache#DecreaseReplicaCountMessage": { + "type": "structure", + "members": { + "ReplicationGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The id of the replication group from which you want to remove replica\n nodes.

", + "smithy.api#required": {} + } + }, + "NewReplicaCount": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of read replica nodes you want at the completion of this operation. For Valkey or Redis OSS (cluster mode disabled) replication groups, this is the number of replica nodes in\n the replication group. For Valkey or Redis OSS (cluster mode enabled) replication groups, this is the\n number of replica nodes in each of the replication group's node groups.

\n

The minimum number of replicas in a shard or replication group is:

\n " + } + }, + "ReplicaConfiguration": { + "target": "com.amazonaws.elasticache#ReplicaConfigurationList", + "traits": { + "smithy.api#documentation": "

A list of ConfigureShard objects that can be used to configure each\n shard in a Valkey or Redis OSS (cluster mode enabled) replication group. The\n ConfigureShard has three members: NewReplicaCount,\n NodeGroupId, and PreferredAvailabilityZones.

" + } + }, + "ReplicasToRemove": { + "target": "com.amazonaws.elasticache#RemoveReplicasList", + "traits": { + "smithy.api#documentation": "

A list of the node ids to remove from the replication group or node group\n (shard).

" + } + }, + "ApplyImmediately": { + "target": "com.amazonaws.elasticache#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

If True, the number of replica nodes is decreased immediately.\n ApplyImmediately=False is not currently supported.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#DecreaseReplicaCountResult": { + "type": "structure", + "members": { + "ReplicationGroup": { + "target": "com.amazonaws.elasticache#ReplicationGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#DefaultUserAssociatedToUserGroupFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DefaultUserAssociatedToUserGroup", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The default user assigned to the user group.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#DefaultUserRequired": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DefaultUserRequired", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

You must add default user to a user group.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#DeleteCacheCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#DeleteCacheClusterMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#DeleteCacheClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#CacheClusterNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidCacheClusterStateFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#SnapshotAlreadyExistsFault" + }, + { + "target": "com.amazonaws.elasticache#SnapshotFeatureNotSupportedFault" + }, + { + "target": "com.amazonaws.elasticache#SnapshotQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a previously provisioned cluster. DeleteCacheCluster deletes all\n associated cache nodes, node endpoints and the cluster itself. When you receive a\n successful response from this operation, Amazon ElastiCache immediately begins deleting\n the cluster; you cannot cancel or revert this operation.

\n

This operation is not valid for:

\n ", + "smithy.api#examples": [ + { + "title": "DeleteCacheCluster", + "documentation": "Deletes an Amazon ElastiCache cluster.", + "input": { + "CacheClusterId": "my-memcached" + }, + "output": { + "CacheCluster": { + "Engine": "memcached", + "CacheParameterGroup": { + "CacheNodeIdsToReboot": [], + "CacheParameterGroupName": "default.memcached1.4", + "ParameterApplyStatus": "in-sync" + }, + "CacheClusterId": "my-memcached", + "PreferredAvailabilityZone": "Multiple", + "ConfigurationEndpoint": { + "Port": 11211, + "Address": "my-memcached2.ameaqx.cfg.use1.cache.amazonaws.com" + }, + "CacheSecurityGroups": [], + "CacheClusterCreateTime": "2016-12-22T16:05:17.314Z", + "AutoMinorVersionUpgrade": true, + "CacheClusterStatus": "deleting", + "NumCacheNodes": 2, + "ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:", + "CacheSubnetGroupName": "default", + "EngineVersion": "1.4.24", + "PendingModifiedValues": {}, + "PreferredMaintenanceWindow": "tue:07:30-tue:08:30", + "CacheNodeType": "cache.r3.large" + } + } + } + ] + } + }, + "com.amazonaws.elasticache#DeleteCacheClusterMessage": { + "type": "structure", + "members": { + "CacheClusterId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The cluster identifier for the cluster to be deleted. This parameter is not case\n sensitive.

", + "smithy.api#required": {} + } + }, + "FinalSnapshotIdentifier": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The user-supplied name of a final cluster snapshot. This is the unique name that\n identifies the snapshot. ElastiCache creates the snapshot, and then deletes the cluster\n immediately afterward.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a DeleteCacheCluster operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#DeleteCacheClusterResult": { + "type": "structure", + "members": { + "CacheCluster": { + "target": "com.amazonaws.elasticache#CacheCluster" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#DeleteCacheParameterGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#DeleteCacheParameterGroupMessage" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#CacheParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidCacheParameterGroupStateFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified cache parameter group. You cannot delete a cache parameter group\n if it is associated with any cache clusters. You cannot delete the default cache\n parameter groups in your account.

", + "smithy.api#examples": [ + { + "title": "DeleteCacheParameterGroup", + "documentation": "Deletes the Amazon ElastiCache parameter group custom-mem1-4.", + "input": { + "CacheParameterGroupName": "custom-mem1-4" + } + } + ] + } + }, + "com.amazonaws.elasticache#DeleteCacheParameterGroupMessage": { + "type": "structure", + "members": { + "CacheParameterGroupName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the cache parameter group to delete.

\n \n

The specified cache security group must not be associated with any\n clusters.

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a DeleteCacheParameterGroup operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#DeleteCacheSecurityGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#DeleteCacheSecurityGroupMessage" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#CacheSecurityGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidCacheSecurityGroupStateFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a cache security group.

\n \n

You cannot delete a cache security group if it is associated with any\n clusters.

\n ", + "smithy.api#examples": [ + { + "title": "DeleteCacheSecurityGroup", + "documentation": "Deletes a cache security group.", + "input": { + "CacheSecurityGroupName": "my-sec-group" + } + } + ] + } + }, + "com.amazonaws.elasticache#DeleteCacheSecurityGroupMessage": { + "type": "structure", + "members": { + "CacheSecurityGroupName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the cache security group to delete.

\n \n

You cannot delete the default security group.

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a DeleteCacheSecurityGroup operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#DeleteCacheSubnetGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#DeleteCacheSubnetGroupMessage" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#CacheSubnetGroupInUse" + }, + { + "target": "com.amazonaws.elasticache#CacheSubnetGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a cache subnet group.

\n \n

You cannot delete a default cache subnet group or one that is associated with any\n clusters.

\n ", + "smithy.api#examples": [ + { + "title": "DeleteCacheSubnetGroup", + "documentation": "Deletes the Amazon ElastiCache subnet group my-subnet-group.", + "input": { + "CacheSubnetGroupName": "my-subnet-group" + } + } + ] + } + }, + "com.amazonaws.elasticache#DeleteCacheSubnetGroupMessage": { + "type": "structure", + "members": { + "CacheSubnetGroupName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the cache subnet group to delete.

\n

Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a DeleteCacheSubnetGroup operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#DeleteGlobalReplicationGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#DeleteGlobalReplicationGroupMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#DeleteGlobalReplicationGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#GlobalReplicationGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidGlobalReplicationGroupStateFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + } + ], + "traits": { + "smithy.api#documentation": "

Deleting a Global datastore is a two-step process:

\n \n

Since the Global Datastore has only a primary cluster, you can delete the Global\n Datastore while retaining the primary by setting\n RetainPrimaryReplicationGroup=true. The primary cluster is never\n deleted when deleting a Global Datastore. It can only be deleted when it no longer is\n associated with any Global Datastore.

\n

When you receive a successful response from this operation, Amazon ElastiCache\n immediately begins deleting the selected resources; you cannot cancel or revert this\n operation.

" + } + }, + "com.amazonaws.elasticache#DeleteGlobalReplicationGroupMessage": { + "type": "structure", + "members": { + "GlobalReplicationGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Global datastore

", + "smithy.api#required": {} + } + }, + "RetainPrimaryReplicationGroup": { + "target": "com.amazonaws.elasticache#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The primary replication group is retained as a standalone replication group.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#DeleteGlobalReplicationGroupResult": { + "type": "structure", + "members": { + "GlobalReplicationGroup": { + "target": "com.amazonaws.elasticache#GlobalReplicationGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#DeleteReplicationGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#DeleteReplicationGroupMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#DeleteReplicationGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#InvalidReplicationGroupStateFault" + }, + { + "target": "com.amazonaws.elasticache#ReplicationGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#SnapshotAlreadyExistsFault" + }, + { + "target": "com.amazonaws.elasticache#SnapshotFeatureNotSupportedFault" + }, + { + "target": "com.amazonaws.elasticache#SnapshotQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an existing replication group. By default, this operation deletes the entire\n replication group, including the primary/primaries and all of the read replicas. If the\n replication group has only one primary, you can optionally delete only the read\n replicas, while retaining the primary by setting\n RetainPrimaryCluster=true.

\n

When you receive a successful response from this operation, Amazon ElastiCache\n immediately begins deleting the selected resources; you cannot cancel or revert this\n operation.

\n \n
    \n
  • \n

    \n CreateSnapshot permission is required to create a final snapshot. \n Without this permission, the API call will fail with an Access Denied exception.

    \n
    • \n
  • \n

    This operation is valid for Redis OSS only.

    \n
    • \n
\n ", + "smithy.api#examples": [ + { + "title": "DeleteReplicationGroup", + "documentation": "Deletes the Amazon ElastiCache replication group my-redis-rg.", + "input": { + "ReplicationGroupId": "my-redis-rg", + "RetainPrimaryCluster": false + }, + "output": { + "ReplicationGroup": { + "Status": "deleting", + "AutomaticFailover": "disabled", + "Description": "simple redis cluster", + "ReplicationGroupId": "my-redis-rg", + "PendingModifiedValues": {} + } + } + } + ] + } + }, + "com.amazonaws.elasticache#DeleteReplicationGroupMessage": { + "type": "structure", + "members": { + "ReplicationGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier for the cluster to be deleted. This parameter is not case\n sensitive.

", + "smithy.api#required": {} + } + }, + "RetainPrimaryCluster": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "

If set to true, all of the read replicas are deleted, but the primary\n node is retained.

" + } + }, + "FinalSnapshotIdentifier": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of a final node group (shard) snapshot. ElastiCache creates the snapshot from\n the primary node in the cluster, rather than one of the replicas; this is to ensure that\n it captures the freshest data. After the final snapshot is taken, the replication group\n is immediately deleted.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a DeleteReplicationGroup operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#DeleteReplicationGroupResult": { + "type": "structure", + "members": { + "ReplicationGroup": { + "target": "com.amazonaws.elasticache#ReplicationGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#DeleteServerlessCache": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#DeleteServerlessCacheRequest" + }, + "output": { + "target": "com.amazonaws.elasticache#DeleteServerlessCacheResponse" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#InvalidCredentialsException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#InvalidServerlessCacheStateFault" + }, + { + "target": "com.amazonaws.elasticache#ServerlessCacheNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#ServerlessCacheSnapshotAlreadyExistsFault" + }, + { + "target": "com.amazonaws.elasticache#ServiceLinkedRoleNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a specified existing serverless cache.

\n \n

\n CreateServerlessCacheSnapshot permission is required to create a final snapshot. \n Without this permission, the API call will fail with an Access Denied exception.

\n " + } + }, + "com.amazonaws.elasticache#DeleteServerlessCacheRequest": { + "type": "structure", + "members": { + "ServerlessCacheName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier of the serverless cache to be deleted.

", + "smithy.api#required": {} + } + }, + "FinalSnapshotName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

Name of the final snapshot to be taken before the serverless cache is deleted. Available for Valkey, Redis OSS and Serverless Memcached only.\n Default: NULL, i.e. a final snapshot is not taken.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#DeleteServerlessCacheResponse": { + "type": "structure", + "members": { + "ServerlessCache": { + "target": "com.amazonaws.elasticache#ServerlessCache", + "traits": { + "smithy.api#documentation": "

Provides the details of the specified serverless cache that is about to be deleted.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#DeleteServerlessCacheSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#DeleteServerlessCacheSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.elasticache#DeleteServerlessCacheSnapshotResponse" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#InvalidServerlessCacheSnapshotStateFault" + }, + { + "target": "com.amazonaws.elasticache#ServerlessCacheSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#ServiceLinkedRoleNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an existing serverless cache snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.

" + } + }, + "com.amazonaws.elasticache#DeleteServerlessCacheSnapshotRequest": { + "type": "structure", + "members": { + "ServerlessCacheSnapshotName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Idenfitier of the snapshot to be deleted. Available for Valkey, Redis OSS and Serverless Memcached only.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#DeleteServerlessCacheSnapshotResponse": { + "type": "structure", + "members": { + "ServerlessCacheSnapshot": { + "target": "com.amazonaws.elasticache#ServerlessCacheSnapshot", + "traits": { + "smithy.api#documentation": "

The snapshot to be deleted. Available for Valkey, Redis OSS and Serverless Memcached only.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#DeleteSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#DeleteSnapshotMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#DeleteSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#InvalidSnapshotStateFault" + }, + { + "target": "com.amazonaws.elasticache#SnapshotNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an existing snapshot. When you receive a successful response from this\n operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or\n revert this operation.

\n \n

This operation is valid for Valkey or Redis OSS only.

\n ", + "smithy.api#examples": [ + { + "title": "DeleteSnapshot", + "documentation": "Deletes the Redis snapshot snapshot-20160822.", + "input": { + "SnapshotName": "snapshot-20161212" + }, + "output": { + "Snapshot": { + "Engine": "redis", + "CacheParameterGroupName": "default.redis3.2", + "VpcId": "vpc-91280df6", + "CacheClusterId": "my-redis5", + "SnapshotRetentionLimit": 7, + "NumCacheNodes": 1, + "SnapshotName": "snapshot-20161212", + "CacheClusterCreateTime": "2016-12-21T22:27:12.543Z", + "AutoMinorVersionUpgrade": true, + "PreferredAvailabilityZone": "us-east-1c", + "SnapshotStatus": "deleting", + "SnapshotSource": "manual", + "SnapshotWindow": "10:00-11:00", + "EngineVersion": "3.2.4", + "NodeSnapshots": [ + { + "CacheSize": "3 MB", + "SnapshotCreateTime": "2016-12-21T22:30:26Z", + "CacheNodeId": "0001", + "CacheNodeCreateTime": "2016-12-21T22:27:12.543Z" + } + ], + "CacheSubnetGroupName": "default", + "Port": 6379, + "PreferredMaintenanceWindow": "fri:05:30-fri:06:30", + "CacheNodeType": "cache.m3.large" + } + } + } + ] + } + }, + "com.amazonaws.elasticache#DeleteSnapshotMessage": { + "type": "structure", + "members": { + "SnapshotName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the snapshot to be deleted.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a DeleteSnapshot operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#DeleteSnapshotResult": { + "type": "structure", + "members": { + "Snapshot": { + "target": "com.amazonaws.elasticache#Snapshot" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#DeleteUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#DeleteUserMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#User" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#DefaultUserAssociatedToUserGroupFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#InvalidUserStateFault" + }, + { + "target": "com.amazonaws.elasticache#ServiceLinkedRoleNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#UserNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

For Valkey engine version 7.2 onwards and Redis OSS 6.0 onwards: Deletes a user. The user will be removed from\n all user groups and in turn removed from all replication groups. For more information,\n see Using Role Based Access Control (RBAC).

" + } + }, + "com.amazonaws.elasticache#DeleteUserGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#DeleteUserGroupMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#UserGroup" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#InvalidUserGroupStateFault" + }, + { + "target": "com.amazonaws.elasticache#ServiceLinkedRoleNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#UserGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

For Valkey engine version 7.2 onwards and Redis OSS 6.0 onwards: Deletes a user group. The user group must first\n be disassociated from the replication group before it can be deleted. For more\n information, see Using Role Based Access Control (RBAC).

" + } + }, + "com.amazonaws.elasticache#DeleteUserGroupMessage": { + "type": "structure", + "members": { + "UserGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the user group.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#DeleteUserMessage": { + "type": "structure", + "members": { + "UserId": { + "target": "com.amazonaws.elasticache#UserId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the user.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#DescribeCacheClusters": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#DescribeCacheClustersMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#CacheClusterMessage" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#CacheClusterNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about all provisioned clusters if no cluster identifier is\n specified, or about a specific cache cluster if a cluster identifier is supplied.

\n

By default, abbreviated information about the clusters is returned. You can use the\n optional ShowCacheNodeInfo flag to retrieve detailed information\n about the cache nodes associated with the clusters. These details include the DNS\n address and port for the cache node endpoint.

\n

If the cluster is in the creating state, only cluster-level\n information is displayed until all of the nodes are successfully provisioned.

\n

If the cluster is in the deleting state, only cluster-level\n information is displayed.

\n

If cache nodes are currently being added to the cluster, node endpoint information and\n creation time for the additional nodes are not displayed until they are completely\n provisioned. When the cluster state is available, the cluster is\n ready for use.

\n

If cache nodes are currently being removed from the cluster, no endpoint information\n for the removed nodes is displayed.

", + "smithy.api#examples": [ + { + "title": "DescribeCacheClusters", + "documentation": "Lists the details for the cache cluster my-mem-cluster.", + "input": { + "CacheClusterId": "my-mem-cluster", + "ShowCacheNodeInfo": true + }, + "output": { + "CacheClusters": [ + { + "Engine": "memcached", + "CacheNodes": [ + { + "CacheNodeId": "0001", + "Endpoint": { + "Port": 11211, + "Address": "my-mem-cluster.ameaqx.0001.use1.cache.amazonaws.com" + }, + "CacheNodeStatus": "available", + "ParameterGroupStatus": "in-sync", + "CacheNodeCreateTime": "2016-12-21T21:59:43.794Z", + "CustomerAvailabilityZone": "us-east-1b" + }, + { + "CacheNodeId": "0002", + "Endpoint": { + "Port": 11211, + "Address": "my-mem-cluster.ameaqx.0002.use1.cache.amazonaws.com" + }, + "CacheNodeStatus": "available", + "ParameterGroupStatus": "in-sync", + "CacheNodeCreateTime": "2016-12-21T21:59:43.794Z", + "CustomerAvailabilityZone": "us-east-1a" + } + ], + "CacheParameterGroup": { + "CacheNodeIdsToReboot": [], + "CacheParameterGroupName": "default.memcached1.4", + "ParameterApplyStatus": "in-sync" + }, + "CacheClusterId": "my-mem-cluster", + "PreferredAvailabilityZone": "Multiple", + "ConfigurationEndpoint": { + "Port": 11211, + "Address": "my-mem-cluster.ameaqx.cfg.use1.cache.amazonaws.com" + }, + "CacheSecurityGroups": [], + "CacheClusterCreateTime": "2016-12-21T21:59:43.794Z", + "AutoMinorVersionUpgrade": true, + "CacheClusterStatus": "available", + "NumCacheNodes": 2, + "ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:", + "CacheSubnetGroupName": "default", + "EngineVersion": "1.4.24", + "PendingModifiedValues": {}, + "PreferredMaintenanceWindow": "wed:06:00-wed:07:00", + "CacheNodeType": "cache.t2.medium" + } + ] + } + }, + { + "title": "DescribeCacheClusters", + "documentation": "Lists the details for up to 50 cache clusters.", + "input": { + "CacheClusterId": "my-mem-cluster" + }, + "output": { + "CacheClusters": [ + { + "Engine": "memcached", + "CacheParameterGroup": { + "CacheNodeIdsToReboot": [], + "CacheParameterGroupName": "default.memcached1.4", + "ParameterApplyStatus": "in-sync" + }, + "CacheClusterId": "my-mem-cluster", + "PreferredAvailabilityZone": "Multiple", + "ConfigurationEndpoint": { + "Port": 11211, + "Address": "my-mem-cluster.abcdef.cfg.use1.cache.amazonaws.com" + }, + "CacheSecurityGroups": [], + "CacheClusterCreateTime": "2016-12-21T21:59:43.794Z", + "AutoMinorVersionUpgrade": true, + "CacheClusterStatus": "available", + "NumCacheNodes": 2, + "ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:", + "CacheSubnetGroupName": "default", + "EngineVersion": "1.4.24", + "PendingModifiedValues": {}, + "PreferredMaintenanceWindow": "wed:06:00-wed:07:00", + "CacheNodeType": "cache.t2.medium" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "CacheClusters", + "pageSize": "MaxRecords" + }, + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "CacheClusterAvailable": { + "documentation": "Wait until ElastiCache cluster is available.", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "CacheClusters[].CacheClusterStatus", + "expected": "available", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "CacheClusters[].CacheClusterStatus", + "expected": "deleted", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "CacheClusters[].CacheClusterStatus", + "expected": "deleting", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "CacheClusters[].CacheClusterStatus", + "expected": "incompatible-network", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "CacheClusters[].CacheClusterStatus", + "expected": "restore-failed", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 15 + }, + "CacheClusterDeleted": { + "documentation": "Wait until ElastiCache cluster is deleted.", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "CacheClusters[].CacheClusterStatus", + "expected": "deleted", + "comparator": "allStringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "errorType": "CacheClusterNotFound" + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "CacheClusters[].CacheClusterStatus", + "expected": "available", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "CacheClusters[].CacheClusterStatus", + "expected": "creating", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "CacheClusters[].CacheClusterStatus", + "expected": "incompatible-network", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "CacheClusters[].CacheClusterStatus", + "expected": "modifying", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "CacheClusters[].CacheClusterStatus", + "expected": "restore-failed", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "CacheClusters[].CacheClusterStatus", + "expected": "snapshotting", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 15 + } + } + } + }, + "com.amazonaws.elasticache#DescribeCacheClustersMessage": { + "type": "structure", + "members": { + "CacheClusterId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The user-supplied cluster identifier. If this parameter is specified, only information\n about that specific cluster is returned. This parameter isn't case sensitive.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a marker is included in the response so\n that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: minimum 20; maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "ShowCacheNodeInfo": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "

An optional flag that can be included in the DescribeCacheCluster request\n to retrieve information about the individual cache nodes.

" + } + }, + "ShowCacheClustersNotInReplicationGroups": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "

An optional flag that can be included in the DescribeCacheCluster request\n to show only nodes (API/CLI: clusters) that are not members of a replication group. In\n practice, this means Memcached and single node Valkey or Redis OSS clusters.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a DescribeCacheClusters operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#DescribeCacheEngineVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#DescribeCacheEngineVersionsMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#CacheEngineVersionMessage" + }, + "traits": { + "smithy.api#documentation": "

Returns a list of the available cache engines and their versions.

", + "smithy.api#examples": [ + { + "title": "DescribeCacheEngineVersions", + "documentation": "Lists the details for up to 25 Memcached and Redis cache engine versions.", + "output": { + "CacheEngineVersions": [ + { + "Engine": "memcached", + "CacheEngineDescription": "memcached", + "CacheEngineVersionDescription": "memcached version 1.4.14", + "CacheParameterGroupFamily": "memcached1.4", + "EngineVersion": "1.4.14" + }, + { + "Engine": "memcached", + "CacheEngineDescription": "memcached", + "CacheEngineVersionDescription": "memcached version 1.4.24", + "CacheParameterGroupFamily": "memcached1.4", + "EngineVersion": "1.4.24" + }, + { + "Engine": "memcached", + "CacheEngineDescription": "memcached", + "CacheEngineVersionDescription": "memcached version 1.4.33", + "CacheParameterGroupFamily": "memcached1.4", + "EngineVersion": "1.4.33" + }, + { + "Engine": "memcached", + "CacheEngineDescription": "memcached", + "CacheEngineVersionDescription": "memcached version 1.4.5", + "CacheParameterGroupFamily": "memcached1.4", + "EngineVersion": "1.4.5" + }, + { + "Engine": "redis", + "CacheEngineDescription": "Redis", + "CacheEngineVersionDescription": "redis version 2.6.13", + "CacheParameterGroupFamily": "redis2.6", + "EngineVersion": "2.6.13" + }, + { + "Engine": "redis", + "CacheEngineDescription": "Redis", + "CacheEngineVersionDescription": "redis version 2.8.19", + "CacheParameterGroupFamily": "redis2.8", + "EngineVersion": "2.8.19" + }, + { + "Engine": "redis", + "CacheEngineDescription": "Redis", + "CacheEngineVersionDescription": "redis version 2.8.21", + "CacheParameterGroupFamily": "redis2.8", + "EngineVersion": "2.8.21" + }, + { + "Engine": "redis", + "CacheEngineDescription": "Redis", + "CacheEngineVersionDescription": "redis version 2.8.22 R5", + "CacheParameterGroupFamily": "redis2.8", + "EngineVersion": "2.8.22" + }, + { + "Engine": "redis", + "CacheEngineDescription": "Redis", + "CacheEngineVersionDescription": "redis version 2.8.23 R4", + "CacheParameterGroupFamily": "redis2.8", + "EngineVersion": "2.8.23" + }, + { + "Engine": "redis", + "CacheEngineDescription": "Redis", + "CacheEngineVersionDescription": "redis version 2.8.24 R3", + "CacheParameterGroupFamily": "redis2.8", + "EngineVersion": "2.8.24" + }, + { + "Engine": "redis", + "CacheEngineDescription": "Redis", + "CacheEngineVersionDescription": "redis version 2.8.6", + "CacheParameterGroupFamily": "redis2.8", + "EngineVersion": "2.8.6" + }, + { + "Engine": "redis", + "CacheEngineDescription": "Redis", + "CacheEngineVersionDescription": "redis version 3.2.4", + "CacheParameterGroupFamily": "redis3.2", + "EngineVersion": "3.2.4" + } + ] + } + }, + { + "title": "DescribeCacheEngineVersions", + "documentation": "Lists the details for up to 50 Redis cache engine versions.", + "input": { + "Engine": "redis", + "MaxRecords": 50, + "DefaultOnly": false + }, + "output": { + "Marker": "", + "CacheEngineVersions": [ + { + "Engine": "redis", + "CacheEngineDescription": "Redis", + "CacheEngineVersionDescription": "redis version 2.6.13", + "CacheParameterGroupFamily": "redis2.6", + "EngineVersion": "2.6.13" + }, + { + "Engine": "redis", + "CacheEngineDescription": "Redis", + "CacheEngineVersionDescription": "redis version 2.8.19", + "CacheParameterGroupFamily": "redis2.8", + "EngineVersion": "2.8.19" + }, + { + "Engine": "redis", + "CacheEngineDescription": "Redis", + "CacheEngineVersionDescription": "redis version 2.8.21", + "CacheParameterGroupFamily": "redis2.8", + "EngineVersion": "2.8.21" + }, + { + "Engine": "redis", + "CacheEngineDescription": "Redis", + "CacheEngineVersionDescription": "redis version 2.8.22 R5", + "CacheParameterGroupFamily": "redis2.8", + "EngineVersion": "2.8.22" + }, + { + "Engine": "redis", + "CacheEngineDescription": "Redis", + "CacheEngineVersionDescription": "redis version 2.8.23 R4", + "CacheParameterGroupFamily": "redis2.8", + "EngineVersion": "2.8.23" + }, + { + "Engine": "redis", + "CacheEngineDescription": "Redis", + "CacheEngineVersionDescription": "redis version 2.8.24 R3", + "CacheParameterGroupFamily": "redis2.8", + "EngineVersion": "2.8.24" + }, + { + "Engine": "redis", + "CacheEngineDescription": "Redis", + "CacheEngineVersionDescription": "redis version 2.8.6", + "CacheParameterGroupFamily": "redis2.8", + "EngineVersion": "2.8.6" + }, + { + "Engine": "redis", + "CacheEngineDescription": "Redis", + "CacheEngineVersionDescription": "redis version 3.2.4", + "CacheParameterGroupFamily": "redis3.2", + "EngineVersion": "3.2.4" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "CacheEngineVersions", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.elasticache#DescribeCacheEngineVersionsMessage": { + "type": "structure", + "members": { + "Engine": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The cache engine to return. Valid values: memcached |\n redis\n

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The cache engine version to return.

\n

Example: 1.4.14\n

" + } + }, + "CacheParameterGroupFamily": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of a specific cache parameter group family to return details for.

\n

Valid values are: memcached1.4 | memcached1.5 |\n memcached1.6 | redis2.6 | redis2.8 |\n redis3.2 | redis4.0 | redis5.0 |\n redis6.x | redis6.2 | redis7 | valkey7\n

\n

Constraints:

\n " + } + }, + "MaxRecords": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a marker is included in the response so\n that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: minimum 20; maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "DefaultOnly": { + "target": "com.amazonaws.elasticache#Boolean", + "traits": { + "smithy.api#documentation": "

If true, specifies that only the default version of the specified engine\n or engine and major version combination is to be returned.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a DescribeCacheEngineVersions operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#DescribeCacheParameterGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#DescribeCacheParameterGroupsMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#CacheParameterGroupsMessage" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#CacheParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of cache parameter group descriptions. If a cache parameter group name\n is specified, the list contains only the descriptions for that group.

", + "smithy.api#examples": [ + { + "title": "DescribeCacheParameterGroups", + "documentation": "Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list contains only the descriptions for that group.", + "input": { + "CacheParameterGroupName": "custom-mem1-4" + }, + "output": { + "CacheParameterGroups": [ + { + "CacheParameterGroupName": "custom-mem1-4", + "CacheParameterGroupFamily": "memcached1.4", + "Description": "Custom memcache param group" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "CacheParameterGroups", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.elasticache#DescribeCacheParameterGroupsMessage": { + "type": "structure", + "members": { + "CacheParameterGroupName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of a specific cache parameter group to return details for.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a marker is included in the response so\n that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: minimum 20; maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a DescribeCacheParameterGroups operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#DescribeCacheParameters": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#DescribeCacheParametersMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#CacheParameterGroupDetails" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#CacheParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the detailed parameter list for a particular cache parameter group.

", + "smithy.api#examples": [ + { + "title": "DescribeCacheParameters", + "documentation": "Lists up to 100 user parameter values for the parameter group custom.redis2.8.", + "input": { + "CacheParameterGroupName": "custom-redis2-8", + "Source": "user", + "MaxRecords": 100 + }, + "output": { + "Marker": "", + "Parameters": [ + { + "Description": "Apply rehashing or not.", + "DataType": "string", + "ChangeType": "requires-reboot", + "IsModifiable": true, + "AllowedValues": "yes,no", + "Source": "system", + "ParameterValue": "yes", + "ParameterName": "activerehashing", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "fsync policy for AOF persistence", + "DataType": "string", + "ChangeType": "immediate", + "IsModifiable": true, + "AllowedValues": "always,everysec,no", + "Source": "system", + "ParameterValue": "everysec", + "ParameterName": "appendfsync", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "Enable Redis persistence.", + "DataType": "string", + "ChangeType": "immediate", + "IsModifiable": true, + "AllowedValues": "yes,no", + "Source": "system", + "ParameterValue": "no", + "ParameterName": "appendonly", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "Normal client output buffer hard limit in bytes.", + "DataType": "integer", + "ChangeType": "immediate", + "IsModifiable": true, + "AllowedValues": "0-", + "Source": "system", + "ParameterValue": "0", + "ParameterName": "client-output-buffer-limit-normal-hard-limit", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "Normal client output buffer soft limit in bytes.", + "DataType": "integer", + "ChangeType": "immediate", + "IsModifiable": true, + "AllowedValues": "0-", + "Source": "system", + "ParameterValue": "0", + "ParameterName": "client-output-buffer-limit-normal-soft-limit", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "Normal client output buffer soft limit in seconds.", + "DataType": "integer", + "ChangeType": "immediate", + "IsModifiable": true, + "AllowedValues": "0-", + "Source": "system", + "ParameterValue": "0", + "ParameterName": "client-output-buffer-limit-normal-soft-seconds", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "Pubsub client output buffer hard limit in bytes.", + "DataType": "integer", + "ChangeType": "immediate", + "IsModifiable": true, + "AllowedValues": "0-", + "Source": "system", + "ParameterValue": "33554432", + "ParameterName": "client-output-buffer-limit-pubsub-hard-limit", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "Pubsub client output buffer soft limit in bytes.", + "DataType": "integer", + "ChangeType": "immediate", + "IsModifiable": true, + "AllowedValues": "0-", + "Source": "system", + "ParameterValue": "8388608", + "ParameterName": "client-output-buffer-limit-pubsub-soft-limit", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "Pubsub client output buffer soft limit in seconds.", + "DataType": "integer", + "ChangeType": "immediate", + "IsModifiable": true, + "AllowedValues": "0-", + "Source": "system", + "ParameterValue": "60", + "ParameterName": "client-output-buffer-limit-pubsub-soft-seconds", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "Slave client output buffer soft limit in seconds.", + "DataType": "integer", + "ChangeType": "immediate", + "IsModifiable": false, + "AllowedValues": "0-", + "Source": "system", + "ParameterValue": "60", + "ParameterName": "client-output-buffer-limit-slave-soft-seconds", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "If enabled, clients who attempt to write to a read-only slave will be disconnected. Applicable to 2.8.23 and higher.", + "DataType": "string", + "ChangeType": "immediate", + "IsModifiable": true, + "AllowedValues": "yes,no", + "Source": "system", + "ParameterValue": "yes", + "ParameterName": "close-on-slave-write", + "MinimumEngineVersion": "2.8.23" + }, + { + "Description": "Set the number of databases.", + "DataType": "integer", + "ChangeType": "requires-reboot", + "IsModifiable": true, + "AllowedValues": "1-1200000", + "Source": "system", + "ParameterValue": "16", + "ParameterName": "databases", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "The maximum number of hash entries in order for the dataset to be compressed.", + "DataType": "integer", + "ChangeType": "immediate", + "IsModifiable": true, + "AllowedValues": "0-", + "Source": "system", + "ParameterValue": "512", + "ParameterName": "hash-max-ziplist-entries", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "The threshold of biggest hash entries in order for the dataset to be compressed.", + "DataType": "integer", + "ChangeType": "immediate", + "IsModifiable": true, + "AllowedValues": "0-", + "Source": "system", + "ParameterValue": "64", + "ParameterName": "hash-max-ziplist-value", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "The maximum number of list entries in order for the dataset to be compressed.", + "DataType": "integer", + "ChangeType": "immediate", + "IsModifiable": true, + "AllowedValues": "0-", + "Source": "system", + "ParameterValue": "512", + "ParameterName": "list-max-ziplist-entries", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "The threshold of biggest list entries in order for the dataset to be compressed.", + "DataType": "integer", + "ChangeType": "immediate", + "IsModifiable": true, + "AllowedValues": "0-", + "Source": "system", + "ParameterValue": "64", + "ParameterName": "list-max-ziplist-value", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "Max execution time of a Lua script in milliseconds. 0 for unlimited execution without warnings.", + "DataType": "integer", + "ChangeType": "immediate", + "IsModifiable": false, + "AllowedValues": "5000", + "Source": "system", + "ParameterValue": "5000", + "ParameterName": "lua-time-limit", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "The maximum number of Redis clients.", + "DataType": "integer", + "ChangeType": "requires-reboot", + "IsModifiable": false, + "AllowedValues": "1-65000", + "Source": "system", + "ParameterValue": "65000", + "ParameterName": "maxclients", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "Max memory policy.", + "DataType": "string", + "ChangeType": "immediate", + "IsModifiable": true, + "AllowedValues": "volatile-lru,allkeys-lru,volatile-random,allkeys-random,volatile-ttl,noeviction", + "Source": "system", + "ParameterValue": "volatile-lru", + "ParameterName": "maxmemory-policy", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "Max memory samples.", + "DataType": "integer", + "ChangeType": "immediate", + "IsModifiable": true, + "AllowedValues": "1-", + "Source": "system", + "ParameterValue": "3", + "ParameterName": "maxmemory-samples", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "Maximum number of seconds within which the master must receive a ping from a slave to take writes. Use this parameter together with min-slaves-to-write to regulate when the master stops accepting writes. Setting this value to 0 means the master always takes writes.", + "DataType": "integer", + "ChangeType": "immediate", + "IsModifiable": true, + "AllowedValues": "0-", + "Source": "system", + "ParameterValue": "10", + "ParameterName": "min-slaves-max-lag", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "Number of slaves that must be connected in order for master to take writes. Use this parameter together with min-slaves-max-lag to regulate when the master stops accepting writes. Setting this to 0 means the master always takes writes.", + "DataType": "integer", + "ChangeType": "immediate", + "IsModifiable": true, + "AllowedValues": "0-", + "Source": "system", + "ParameterValue": "0", + "ParameterName": "min-slaves-to-write", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "The keyspace events for Redis to notify Pub/Sub clients about. By default all notifications are disabled", + "DataType": "string", + "ChangeType": "immediate", + "Source": "system", + "IsModifiable": true, + "ParameterName": "notify-keyspace-events", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "The replication backlog size in bytes for PSYNC. This is the size of the buffer which accumulates slave data when slave is disconnected for some time, so that when slave reconnects again, only transfer the portion of data which the slave missed. Minimum value is 16K.", + "DataType": "integer", + "ChangeType": "immediate", + "IsModifiable": true, + "AllowedValues": "16384-", + "Source": "system", + "ParameterValue": "1048576", + "ParameterName": "repl-backlog-size", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "The amount of time in seconds after the master no longer have any slaves connected for the master to free the replication backlog. A value of 0 means to never release the backlog.", + "DataType": "integer", + "ChangeType": "immediate", + "IsModifiable": true, + "AllowedValues": "0-", + "Source": "system", + "ParameterValue": "3600", + "ParameterName": "repl-backlog-ttl", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "The timeout in seconds for bulk transfer I/O during sync and master timeout from the perspective of the slave, and slave timeout from the perspective of the master.", + "DataType": "integer", + "ChangeType": "immediate", + "IsModifiable": true, + "AllowedValues": "11-", + "Source": "system", + "ParameterValue": "60", + "ParameterName": "repl-timeout", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "The amount of memory reserved for non-cache memory usage, in bytes. You may want to increase this parameter for nodes with read replicas, AOF enabled, etc, to reduce swap usage.", + "DataType": "integer", + "ChangeType": "immediate", + "IsModifiable": true, + "AllowedValues": "0-", + "Source": "system", + "ParameterValue": "0", + "ParameterName": "reserved-memory", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "The limit in the size of the set in order for the dataset to be compressed.", + "DataType": "integer", + "ChangeType": "immediate", + "IsModifiable": true, + "AllowedValues": "0-", + "Source": "system", + "ParameterValue": "512", + "ParameterName": "set-max-intset-entries", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "Configures if chaining of slaves is allowed", + "DataType": "string", + "ChangeType": "immediate", + "IsModifiable": false, + "AllowedValues": "yes,no", + "Source": "system", + "ParameterValue": "no", + "ParameterName": "slave-allow-chaining", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "The execution time, in microseconds, to exceed in order for the command to get logged. Note that a negative number disables the slow log, while a value of zero forces the logging of every command.", + "DataType": "integer", + "ChangeType": "immediate", + "IsModifiable": true, + "AllowedValues": "-", + "Source": "system", + "ParameterValue": "10000", + "ParameterName": "slowlog-log-slower-than", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "The length of the slow log. There is no limit to this length. Just be aware that it will consume memory. You can reclaim memory used by the slow log with SLOWLOG RESET.", + "DataType": "integer", + "ChangeType": "immediate", + "IsModifiable": true, + "AllowedValues": "0-", + "Source": "system", + "ParameterValue": "128", + "ParameterName": "slowlog-max-len", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "If non-zero, send ACKs every given number of seconds.", + "DataType": "integer", + "ChangeType": "immediate", + "IsModifiable": true, + "AllowedValues": "0-", + "Source": "system", + "ParameterValue": "0", + "ParameterName": "tcp-keepalive", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "Close connection if client is idle for a given number of seconds, or never if 0.", + "DataType": "integer", + "ChangeType": "immediate", + "IsModifiable": true, + "AllowedValues": "0,20-", + "Source": "system", + "ParameterValue": "0", + "ParameterName": "timeout", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "The maximum number of sorted set entries in order for the dataset to be compressed.", + "DataType": "integer", + "ChangeType": "immediate", + "IsModifiable": true, + "AllowedValues": "0-", + "Source": "system", + "ParameterValue": "128", + "ParameterName": "zset-max-ziplist-entries", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "The threshold of biggest sorted set entries in order for the dataset to be compressed.", + "DataType": "integer", + "ChangeType": "immediate", + "IsModifiable": true, + "AllowedValues": "0-", + "Source": "system", + "ParameterValue": "64", + "ParameterName": "zset-max-ziplist-value", + "MinimumEngineVersion": "2.8.6" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Parameters", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.elasticache#DescribeCacheParametersMessage": { + "type": "structure", + "members": { + "CacheParameterGroupName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of a specific cache parameter group to return details for.

", + "smithy.api#required": {} + } + }, + "Source": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The parameter types to return.

\n

Valid values: user | system |\n engine-default\n

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a marker is included in the response so\n that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: minimum 20; maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a DescribeCacheParameters operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#DescribeCacheSecurityGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#DescribeCacheSecurityGroupsMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#CacheSecurityGroupMessage" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#CacheSecurityGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of cache security group descriptions. If a cache security group name is\n specified, the list contains only the description of that group. This applicable only\n when you have ElastiCache in Classic setup

", + "smithy.api#examples": [ + { + "title": "DescribeCacheSecurityGroups", + "documentation": "Returns a list of cache security group descriptions. If a cache security group name is specified, the list contains only the description of that group.", + "input": { + "CacheSecurityGroupName": "my-sec-group" + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "CacheSecurityGroups", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.elasticache#DescribeCacheSecurityGroupsMessage": { + "type": "structure", + "members": { + "CacheSecurityGroupName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the cache security group to return details for.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a marker is included in the response so\n that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: minimum 20; maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a DescribeCacheSecurityGroups operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#DescribeCacheSubnetGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#DescribeCacheSubnetGroupsMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#CacheSubnetGroupMessage" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#CacheSubnetGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of cache subnet group descriptions. If a subnet group name is\n specified, the list contains only the description of that group. This is applicable only\n when you have ElastiCache in VPC setup. All ElastiCache clusters now launch in VPC by\n default.

", + "smithy.api#examples": [ + { + "title": "DescribeCacheSubnetGroups", + "documentation": "Describes up to 25 cache subnet groups.", + "input": { + "MaxRecords": 25 + }, + "output": { + "Marker": "", + "CacheSubnetGroups": [ + { + "VpcId": "vpc-91280df6", + "CacheSubnetGroupDescription": "Default CacheSubnetGroup", + "Subnets": [ + { + "SubnetIdentifier": "subnet-1a2b3c4d", + "SubnetAvailabilityZone": { + "Name": "us-east-1a" + } + }, + { + "SubnetIdentifier": "subnet-a1b2c3d4", + "SubnetAvailabilityZone": { + "Name": "us-east-1c" + } + }, + { + "SubnetIdentifier": "subnet-abcd1234", + "SubnetAvailabilityZone": { + "Name": "us-east-1e" + } + }, + { + "SubnetIdentifier": "subnet-1234abcd", + "SubnetAvailabilityZone": { + "Name": "us-east-1b" + } + } + ], + "CacheSubnetGroupName": "default" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "CacheSubnetGroups", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.elasticache#DescribeCacheSubnetGroupsMessage": { + "type": "structure", + "members": { + "CacheSubnetGroupName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the cache subnet group to return details for.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a marker is included in the response so\n that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: minimum 20; maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a DescribeCacheSubnetGroups operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#DescribeEngineDefaultParameters": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#DescribeEngineDefaultParametersMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#DescribeEngineDefaultParametersResult" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the default engine and system parameter information for the specified cache\n engine.

", + "smithy.api#examples": [ + { + "title": "DescribeEngineDefaultParameters", + "documentation": "Returns the default engine and system parameter information for the specified cache engine.", + "input": { + "CacheParameterGroupFamily": "redis2.8", + "MaxRecords": 25 + }, + "output": { + "EngineDefaults": { + "Marker": "bWluLXNsYXZlcy10by13cml0ZQ==", + "CacheParameterGroupFamily": "redis2.8", + "Parameters": [ + { + "Description": "Apply rehashing or not.", + "DataType": "string", + "ChangeType": "requires-reboot", + "IsModifiable": true, + "AllowedValues": "yes,no", + "Source": "system", + "ParameterValue": "yes", + "ParameterName": "activerehashing", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "fsync policy for AOF persistence", + "DataType": "string", + "ChangeType": "immediate", + "IsModifiable": true, + "AllowedValues": "always,everysec,no", + "Source": "system", + "ParameterValue": "everysec", + "ParameterName": "appendfsync", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "Enable Redis persistence.", + "DataType": "string", + "ChangeType": "immediate", + "IsModifiable": true, + "AllowedValues": "yes,no", + "Source": "system", + "ParameterValue": "no", + "ParameterName": "appendonly", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "Normal client output buffer hard limit in bytes.", + "DataType": "integer", + "ChangeType": "immediate", + "IsModifiable": true, + "AllowedValues": "0-", + "Source": "system", + "ParameterValue": "0", + "ParameterName": "client-output-buffer-limit-normal-hard-limit", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "Normal client output buffer soft limit in bytes.", + "DataType": "integer", + "ChangeType": "immediate", + "IsModifiable": true, + "AllowedValues": "0-", + "Source": "system", + "ParameterValue": "0", + "ParameterName": "client-output-buffer-limit-normal-soft-limit", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "Normal client output buffer soft limit in seconds.", + "DataType": "integer", + "ChangeType": "immediate", + "IsModifiable": true, + "AllowedValues": "0-", + "Source": "system", + "ParameterValue": "0", + "ParameterName": "client-output-buffer-limit-normal-soft-seconds", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "Pubsub client output buffer hard limit in bytes.", + "DataType": "integer", + "ChangeType": "immediate", + "IsModifiable": true, + "AllowedValues": "0-", + "Source": "system", + "ParameterValue": "33554432", + "ParameterName": "client-output-buffer-limit-pubsub-hard-limit", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "Pubsub client output buffer soft limit in bytes.", + "DataType": "integer", + "ChangeType": "immediate", + "IsModifiable": true, + "AllowedValues": "0-", + "Source": "system", + "ParameterValue": "8388608", + "ParameterName": "client-output-buffer-limit-pubsub-soft-limit", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "Pubsub client output buffer soft limit in seconds.", + "DataType": "integer", + "ChangeType": "immediate", + "IsModifiable": true, + "AllowedValues": "0-", + "Source": "system", + "ParameterValue": "60", + "ParameterName": "client-output-buffer-limit-pubsub-soft-seconds", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "Slave client output buffer soft limit in seconds.", + "DataType": "integer", + "ChangeType": "immediate", + "IsModifiable": false, + "AllowedValues": "0-", + "Source": "system", + "ParameterValue": "60", + "ParameterName": "client-output-buffer-limit-slave-soft-seconds", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "If enabled, clients who attempt to write to a read-only slave will be disconnected. Applicable to 2.8.23 and higher.", + "DataType": "string", + "ChangeType": "immediate", + "IsModifiable": true, + "AllowedValues": "yes,no", + "Source": "system", + "ParameterValue": "yes", + "ParameterName": "close-on-slave-write", + "MinimumEngineVersion": "2.8.23" + }, + { + "Description": "Set the number of databases.", + "DataType": "integer", + "ChangeType": "requires-reboot", + "IsModifiable": true, + "AllowedValues": "1-1200000", + "Source": "system", + "ParameterValue": "16", + "ParameterName": "databases", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "The maximum number of hash entries in order for the dataset to be compressed.", + "DataType": "integer", + "ChangeType": "immediate", + "IsModifiable": true, + "AllowedValues": "0-", + "Source": "system", + "ParameterValue": "512", + "ParameterName": "hash-max-ziplist-entries", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "The threshold of biggest hash entries in order for the dataset to be compressed.", + "DataType": "integer", + "ChangeType": "immediate", + "IsModifiable": true, + "AllowedValues": "0-", + "Source": "system", + "ParameterValue": "64", + "ParameterName": "hash-max-ziplist-value", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "The maximum number of list entries in order for the dataset to be compressed.", + "DataType": "integer", + "ChangeType": "immediate", + "IsModifiable": true, + "AllowedValues": "0-", + "Source": "system", + "ParameterValue": "512", + "ParameterName": "list-max-ziplist-entries", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "The threshold of biggest list entries in order for the dataset to be compressed.", + "DataType": "integer", + "ChangeType": "immediate", + "IsModifiable": true, + "AllowedValues": "0-", + "Source": "system", + "ParameterValue": "64", + "ParameterName": "list-max-ziplist-value", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "Max execution time of a Lua script in milliseconds. 0 for unlimited execution without warnings.", + "DataType": "integer", + "ChangeType": "immediate", + "IsModifiable": false, + "AllowedValues": "5000", + "Source": "system", + "ParameterValue": "5000", + "ParameterName": "lua-time-limit", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "The maximum number of Redis clients.", + "DataType": "integer", + "ChangeType": "requires-reboot", + "IsModifiable": false, + "AllowedValues": "1-65000", + "Source": "system", + "ParameterValue": "65000", + "ParameterName": "maxclients", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "Max memory policy.", + "DataType": "string", + "ChangeType": "immediate", + "IsModifiable": true, + "AllowedValues": "volatile-lru,allkeys-lru,volatile-random,allkeys-random,volatile-ttl,noeviction", + "Source": "system", + "ParameterValue": "volatile-lru", + "ParameterName": "maxmemory-policy", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "Max memory samples.", + "DataType": "integer", + "ChangeType": "immediate", + "IsModifiable": true, + "AllowedValues": "1-", + "Source": "system", + "ParameterValue": "3", + "ParameterName": "maxmemory-samples", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "Maximum number of seconds within which the master must receive a ping from a slave to take writes. Use this parameter together with min-slaves-to-write to regulate when the master stops accepting writes. Setting this value to 0 means the master always takes writes.", + "DataType": "integer", + "ChangeType": "immediate", + "IsModifiable": true, + "AllowedValues": "0-", + "Source": "system", + "ParameterValue": "10", + "ParameterName": "min-slaves-max-lag", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "Number of slaves that must be connected in order for master to take writes. Use this parameter together with min-slaves-max-lag to regulate when the master stops accepting writes. Setting this to 0 means the master always takes writes.", + "DataType": "integer", + "ChangeType": "immediate", + "IsModifiable": true, + "AllowedValues": "0-", + "Source": "system", + "ParameterValue": "0", + "ParameterName": "min-slaves-to-write", + "MinimumEngineVersion": "2.8.6" + } + ], + "CacheNodeTypeSpecificParameters": [ + { + "Description": "Slave client output buffer hard limit in bytes.", + "DataType": "integer", + "ChangeType": "immediate", + "AllowedValues": "0-", + "Source": "system", + "IsModifiable": false, + "CacheNodeTypeSpecificValues": [ + { + "Value": "650117120", + "CacheNodeType": "cache.c1.xlarge" + }, + { + "Value": "702545920", + "CacheNodeType": "cache.m1.large" + }, + { + "Value": "309329920", + "CacheNodeType": "cache.m1.medium" + }, + { + "Value": "94371840", + "CacheNodeType": "cache.m1.small" + }, + { + "Value": "1488977920", + "CacheNodeType": "cache.m1.xlarge" + }, + { + "Value": "3502243840", + "CacheNodeType": "cache.m2.2xlarge" + }, + { + "Value": "7088373760", + "CacheNodeType": "cache.m2.4xlarge" + }, + { + "Value": "1709178880", + "CacheNodeType": "cache.m2.xlarge" + }, + { + "Value": "2998927360", + "CacheNodeType": "cache.m3.2xlarge" + }, + { + "Value": "650117120", + "CacheNodeType": "cache.m3.large" + }, + { + "Value": "309329920", + "CacheNodeType": "cache.m3.medium" + }, + { + "Value": "1426063360", + "CacheNodeType": "cache.m3.xlarge" + }, + { + "Value": "16604761424", + "CacheNodeType": "cache.m4.10xlarge" + }, + { + "Value": "3188912636", + "CacheNodeType": "cache.m4.2xlarge" + }, + { + "Value": "6525729063", + "CacheNodeType": "cache.m4.4xlarge" + }, + { + "Value": "689259315", + "CacheNodeType": "cache.m4.large" + }, + { + "Value": "1532850176", + "CacheNodeType": "cache.m4.xlarge" + }, + { + "Value": "6081740800", + "CacheNodeType": "cache.r3.2xlarge" + }, + { + "Value": "12268339200", + "CacheNodeType": "cache.r3.4xlarge" + }, + { + "Value": "24536678400", + "CacheNodeType": "cache.r3.8xlarge" + }, + { + "Value": "1468006400", + "CacheNodeType": "cache.r3.large" + }, + { + "Value": "3040870400", + "CacheNodeType": "cache.r3.xlarge" + }, + { + "Value": "14260633", + "CacheNodeType": "cache.t1.micro" + }, + { + "Value": "346134937", + "CacheNodeType": "cache.t2.medium" + }, + { + "Value": "58195968", + "CacheNodeType": "cache.t2.micro" + }, + { + "Value": "166513868", + "CacheNodeType": "cache.t2.small" + } + ], + "ParameterName": "client-output-buffer-limit-slave-hard-limit", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "Slave client output buffer soft limit in bytes.", + "DataType": "integer", + "ChangeType": "immediate", + "AllowedValues": "0-", + "Source": "system", + "IsModifiable": false, + "CacheNodeTypeSpecificValues": [ + { + "Value": "650117120", + "CacheNodeType": "cache.c1.xlarge" + }, + { + "Value": "702545920", + "CacheNodeType": "cache.m1.large" + }, + { + "Value": "309329920", + "CacheNodeType": "cache.m1.medium" + }, + { + "Value": "94371840", + "CacheNodeType": "cache.m1.small" + }, + { + "Value": "1488977920", + "CacheNodeType": "cache.m1.xlarge" + }, + { + "Value": "3502243840", + "CacheNodeType": "cache.m2.2xlarge" + }, + { + "Value": "7088373760", + "CacheNodeType": "cache.m2.4xlarge" + }, + { + "Value": "1709178880", + "CacheNodeType": "cache.m2.xlarge" + }, + { + "Value": "2998927360", + "CacheNodeType": "cache.m3.2xlarge" + }, + { + "Value": "650117120", + "CacheNodeType": "cache.m3.large" + }, + { + "Value": "309329920", + "CacheNodeType": "cache.m3.medium" + }, + { + "Value": "1426063360", + "CacheNodeType": "cache.m3.xlarge" + }, + { + "Value": "16604761424", + "CacheNodeType": "cache.m4.10xlarge" + }, + { + "Value": "3188912636", + "CacheNodeType": "cache.m4.2xlarge" + }, + { + "Value": "6525729063", + "CacheNodeType": "cache.m4.4xlarge" + }, + { + "Value": "689259315", + "CacheNodeType": "cache.m4.large" + }, + { + "Value": "1532850176", + "CacheNodeType": "cache.m4.xlarge" + }, + { + "Value": "6081740800", + "CacheNodeType": "cache.r3.2xlarge" + }, + { + "Value": "12268339200", + "CacheNodeType": "cache.r3.4xlarge" + }, + { + "Value": "24536678400", + "CacheNodeType": "cache.r3.8xlarge" + }, + { + "Value": "1468006400", + "CacheNodeType": "cache.r3.large" + }, + { + "Value": "3040870400", + "CacheNodeType": "cache.r3.xlarge" + }, + { + "Value": "14260633", + "CacheNodeType": "cache.t1.micro" + }, + { + "Value": "346134937", + "CacheNodeType": "cache.t2.medium" + }, + { + "Value": "58195968", + "CacheNodeType": "cache.t2.micro" + }, + { + "Value": "166513868", + "CacheNodeType": "cache.t2.small" + } + ], + "ParameterName": "client-output-buffer-limit-slave-soft-limit", + "MinimumEngineVersion": "2.8.6" + }, + { + "Description": "The maximum configurable amount of memory to use to store items, in bytes.", + "DataType": "integer", + "ChangeType": "immediate", + "AllowedValues": "0-", + "Source": "system", + "IsModifiable": false, + "CacheNodeTypeSpecificValues": [ + { + "Value": "6501171200", + "CacheNodeType": "cache.c1.xlarge" + }, + { + "Value": "7025459200", + "CacheNodeType": "cache.m1.large" + }, + { + "Value": "3093299200", + "CacheNodeType": "cache.m1.medium" + }, + { + "Value": "943718400", + "CacheNodeType": "cache.m1.small" + }, + { + "Value": "14889779200", + "CacheNodeType": "cache.m1.xlarge" + }, + { + "Value": "35022438400", + "CacheNodeType": "cache.m2.2xlarge" + }, + { + "Value": "70883737600", + "CacheNodeType": "cache.m2.4xlarge" + }, + { + "Value": "17091788800", + "CacheNodeType": "cache.m2.xlarge" + }, + { + "Value": "29989273600", + "CacheNodeType": "cache.m3.2xlarge" + }, + { + "Value": "6501171200", + "CacheNodeType": "cache.m3.large" + }, + { + "Value": "2988441600", + "CacheNodeType": "cache.m3.medium" + }, + { + "Value": "14260633600", + "CacheNodeType": "cache.m3.xlarge" + }, + { + "Value": "166047614239", + "CacheNodeType": "cache.m4.10xlarge" + }, + { + "Value": "31889126359", + "CacheNodeType": "cache.m4.2xlarge" + }, + { + "Value": "65257290629", + "CacheNodeType": "cache.m4.4xlarge" + }, + { + "Value": "6892593152", + "CacheNodeType": "cache.m4.large" + }, + { + "Value": "15328501760", + "CacheNodeType": "cache.m4.xlarge" + }, + { + "Value": "62495129600", + "CacheNodeType": "cache.r3.2xlarge" + }, + { + "Value": "126458265600", + "CacheNodeType": "cache.r3.4xlarge" + }, + { + "Value": "254384537600", + "CacheNodeType": "cache.r3.8xlarge" + }, + { + "Value": "14470348800", + "CacheNodeType": "cache.r3.large" + }, + { + "Value": "30513561600", + "CacheNodeType": "cache.r3.xlarge" + }, + { + "Value": "142606336", + "CacheNodeType": "cache.t1.micro" + }, + { + "Value": "3461349376", + "CacheNodeType": "cache.t2.medium" + }, + { + "Value": "581959680", + "CacheNodeType": "cache.t2.micro" + }, + { + "Value": "1665138688", + "CacheNodeType": "cache.t2.small" + } + ], + "ParameterName": "maxmemory", + "MinimumEngineVersion": "2.8.6" + } + ] + } + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "EngineDefaults.Marker", + "items": "EngineDefaults.Parameters", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.elasticache#DescribeEngineDefaultParametersMessage": { + "type": "structure", + "members": { + "CacheParameterGroupFamily": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the cache parameter group family.

\n

Valid values are: memcached1.4 | memcached1.5 |\n memcached1.6 | redis2.6 | redis2.8 |\n redis3.2 | redis4.0 | redis5.0 |\n redis6.x | redis6.2 | redis7\n

", + "smithy.api#required": {} + } + }, + "MaxRecords": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a marker is included in the response so\n that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: minimum 20; maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a DescribeEngineDefaultParameters\n operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#DescribeEngineDefaultParametersResult": { + "type": "structure", + "members": { + "EngineDefaults": { + "target": "com.amazonaws.elasticache#EngineDefaults" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#DescribeEvents": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#DescribeEventsMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#EventsMessage" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns events related to clusters, cache security groups, and cache parameter groups.\n You can obtain events specific to a particular cluster, cache security group, or cache\n parameter group by providing the name as a parameter.

\n

By default, only the events occurring within the last hour are returned; however, you\n can retrieve up to 14 days' worth of events if necessary.

", + "smithy.api#examples": [ + { + "title": "DescribeEvents", + "documentation": "Describes all the cache-cluster events for the past 120 minutes.", + "input": { + "SourceType": "cache-cluster", + "Duration": 360 + }, + "output": { + "Marker": "", + "Events": [ + { + "Date": "2016-12-22T16:27:56.088Z", + "Message": "Added cache node 0001 in availability zone us-east-1e", + "SourceIdentifier": "redis-cluster", + "SourceType": "cache-cluster" + }, + { + "Date": "2016-12-22T16:27:56.078Z", + "Message": "Cache cluster created", + "SourceIdentifier": "redis-cluster", + "SourceType": "cache-cluster" + }, + { + "Date": "2016-12-22T16:05:17.326Z", + "Message": "Added cache node 0002 in availability zone us-east-1c", + "SourceIdentifier": "my-memcached2", + "SourceType": "cache-cluster" + }, + { + "Date": "2016-12-22T16:05:17.323Z", + "Message": "Added cache node 0001 in availability zone us-east-1e", + "SourceIdentifier": "my-memcached2", + "SourceType": "cache-cluster" + }, + { + "Date": "2016-12-22T16:05:17.314Z", + "Message": "Cache cluster created", + "SourceIdentifier": "my-memcached2", + "SourceType": "cache-cluster" + } + ] + } + }, + { + "title": "DescribeEvents", + "documentation": "Describes all the replication-group events from 3:00P to 5:00P on November 11, 2016.", + "input": { + "StartTime": "2016-12-22T15:00:00.000Z" + }, + "output": { + "Marker": "", + "Events": [ + { + "Date": "2016-12-22T21:35:46.674Z", + "Message": "Snapshot succeeded for snapshot with ID 'cr-bkup' of replication group with ID 'clustered-redis'", + "SourceIdentifier": "clustered-redis-0001-001", + "SourceType": "cache-cluster" + }, + { + "Date": "2016-12-22T16:27:56.088Z", + "Message": "Added cache node 0001 in availability zone us-east-1e", + "SourceIdentifier": "redis-cluster", + "SourceType": "cache-cluster" + }, + { + "Date": "2016-12-22T16:27:56.078Z", + "Message": "Cache cluster created", + "SourceIdentifier": "redis-cluster", + "SourceType": "cache-cluster" + }, + { + "Date": "2016-12-22T16:05:17.326Z", + "Message": "Added cache node 0002 in availability zone us-east-1c", + "SourceIdentifier": "my-memcached2", + "SourceType": "cache-cluster" + }, + { + "Date": "2016-12-22T16:05:17.323Z", + "Message": "Added cache node 0001 in availability zone us-east-1e", + "SourceIdentifier": "my-memcached2", + "SourceType": "cache-cluster" + }, + { + "Date": "2016-12-22T16:05:17.314Z", + "Message": "Cache cluster created", + "SourceIdentifier": "my-memcached2", + "SourceType": "cache-cluster" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Events", + "pageSize": "MaxRecords" + }, + "smithy.test#smokeTests": [ + { + "id": "DescribeEventsSuccess", + "params": {}, + "vendorParams": { + "region": "us-west-2" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "success": {} + } + } + ] + } + }, + "com.amazonaws.elasticache#DescribeEventsMessage": { + "type": "structure", + "members": { + "SourceIdentifier": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The identifier of the event source for which events are returned. If not specified,\n all sources are included in the response.

" + } + }, + "SourceType": { + "target": "com.amazonaws.elasticache#SourceType", + "traits": { + "smithy.api#documentation": "

The event source to retrieve events for. If no value is specified, all events are\n returned.

" + } + }, + "StartTime": { + "target": "com.amazonaws.elasticache#TStamp", + "traits": { + "smithy.api#documentation": "

The beginning of the time interval to retrieve events for, specified in ISO 8601\n format.

\n

\n Example: 2017-03-30T07:03:49.555Z

" + } + }, + "EndTime": { + "target": "com.amazonaws.elasticache#TStamp", + "traits": { + "smithy.api#documentation": "

The end of the time interval for which to retrieve events, specified in ISO 8601\n format.

\n

\n Example: 2017-03-30T07:03:49.555Z

" + } + }, + "Duration": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of minutes worth of events to retrieve.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a marker is included in the response so\n that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: minimum 20; maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a DescribeEvents operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#DescribeGlobalReplicationGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#DescribeGlobalReplicationGroupsMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#DescribeGlobalReplicationGroupsResult" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#GlobalReplicationGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a particular global replication group. If no identifier is\n specified, returns information about all Global datastores.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "GlobalReplicationGroups", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.elasticache#DescribeGlobalReplicationGroupsMessage": { + "type": "structure", + "members": { + "GlobalReplicationGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the Global datastore

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a marker is included in the response so that the\n remaining results can be retrieved.

" + } + }, + "Marker": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "ShowMemberInfo": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Returns the list of members that comprise the Global datastore.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#DescribeGlobalReplicationGroupsResult": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords. >

" + } + }, + "GlobalReplicationGroups": { + "target": "com.amazonaws.elasticache#GlobalReplicationGroupList", + "traits": { + "smithy.api#documentation": "

Indicates the slot configuration and global identifier for each slice group.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#DescribeReplicationGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#DescribeReplicationGroupsMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#ReplicationGroupMessage" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#ReplicationGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a particular replication group. If no identifier is\n specified, DescribeReplicationGroups returns information about all\n replication groups.

\n \n

This operation is valid for Valkey or Redis OSS only.

\n ", + "smithy.api#examples": [ + { + "title": "DescribeReplicationGroups", + "documentation": "Returns information about the replication group myreplgroup.", + "output": { + "Marker": "", + "ReplicationGroups": [ + { + "Status": "available", + "Description": "Test cluster", + "NodeGroups": [ + { + "Status": "available", + "NodeGroupId": "0001", + "NodeGroupMembers": [ + { + "PreferredAvailabilityZone": "us-east-1e", + "CacheNodeId": "0001", + "CacheClusterId": "clustered-redis-0001-001" + }, + { + "PreferredAvailabilityZone": "us-east-1c", + "CacheNodeId": "0001", + "CacheClusterId": "clustered-redis-0001-002" + } + ] + }, + { + "Status": "available", + "NodeGroupId": "0002", + "NodeGroupMembers": [ + { + "PreferredAvailabilityZone": "us-east-1c", + "CacheNodeId": "0001", + "CacheClusterId": "clustered-redis-0002-001" + }, + { + "PreferredAvailabilityZone": "us-east-1b", + "CacheNodeId": "0001", + "CacheClusterId": "clustered-redis-0002-002" + } + ] + } + ], + "ReplicationGroupId": "clustered-redis", + "AutomaticFailover": "enabled", + "MemberClusters": [ + "clustered-redis-0001-001", + "clustered-redis-0001-002", + "clustered-redis-0002-001", + "clustered-redis-0002-002" + ], + "PendingModifiedValues": {} + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "ReplicationGroups", + "pageSize": "MaxRecords" + }, + "smithy.waiters#waitable": { + "ReplicationGroupAvailable": { + "documentation": "Wait until ElastiCache replication group is available.", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "ReplicationGroups[].Status", + "expected": "available", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ReplicationGroups[].Status", + "expected": "deleted", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 15 + }, + "ReplicationGroupDeleted": { + "documentation": "Wait until ElastiCache replication group is deleted.", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "ReplicationGroups[].Status", + "expected": "deleted", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ReplicationGroups[].Status", + "expected": "available", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "errorType": "ReplicationGroupNotFoundFault" + } + } + ], + "minDelay": 15 + } + } + } + }, + "com.amazonaws.elasticache#DescribeReplicationGroupsMessage": { + "type": "structure", + "members": { + "ReplicationGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The identifier for the replication group to be described. This parameter is not case\n sensitive.

\n

If you do not specify this parameter, information about all replication groups is\n returned.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a marker is included in the response so\n that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: minimum 20; maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a DescribeReplicationGroups operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#DescribeReservedCacheNodes": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#DescribeReservedCacheNodesMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#ReservedCacheNodeMessage" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#ReservedCacheNodeNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about reserved cache nodes for this account, or about a specified\n reserved cache node.

", + "smithy.api#examples": [ + { + "title": "DescribeReservedCacheNodes", + "documentation": "Returns information about reserved cache nodes for this account, or about a specified reserved cache node. If the account has no reserved cache nodes, the operation returns an empty list, as shown here.", + "input": { + "MaxRecords": 25 + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "ReservedCacheNodes", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.elasticache#DescribeReservedCacheNodesMessage": { + "type": "structure", + "members": { + "ReservedCacheNodeId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The reserved cache node identifier filter value. Use this parameter to show only the\n reservation that matches the specified reservation ID.

" + } + }, + "ReservedCacheNodesOfferingId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The offering identifier filter value. Use this parameter to show only purchased\n reservations matching the specified offering identifier.

" + } + }, + "CacheNodeType": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The cache node type filter value. Use this parameter to show only those reservations\n matching the specified cache node type.

\n

The following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.

\n \n

\n Additional node type info\n

\n " + } + }, + "Duration": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The duration filter value, specified in years or seconds. Use this parameter to show\n only reservations for this duration.

\n

Valid Values: 1 | 3 | 31536000 | 94608000\n

" + } + }, + "ProductDescription": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The product description filter value. Use this parameter to show only those\n reservations matching the specified product description.

" + } + }, + "OfferingType": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The offering type filter value. Use this parameter to show only the available\n offerings matching the specified offering type.

\n

Valid values: \"Light Utilization\"|\"Medium Utilization\"|\"Heavy Utilization\"|\"All\n Upfront\"|\"Partial Upfront\"| \"No Upfront\"\n

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a marker is included in the response so\n that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: minimum 20; maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a DescribeReservedCacheNodes operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#DescribeReservedCacheNodesOfferings": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#DescribeReservedCacheNodesOfferingsMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#ReservedCacheNodesOfferingMessage" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#ReservedCacheNodesOfferingNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Lists available reserved cache node offerings.

", + "smithy.api#examples": [ + { + "title": "DescribeReseredCacheNodeOfferings", + "documentation": "Lists available reserved cache node offerings for cache.r3.large nodes with a 3 year commitment.", + "input": { + "ReservedCacheNodesOfferingId": "", + "CacheNodeType": "cache.r3.large", + "Duration": "3", + "OfferingType": "Light Utilization", + "MaxRecords": 25 + }, + "output": { + "Marker": "", + "ReservedCacheNodesOfferings": [] + } + }, + { + "title": "DescribeReseredCacheNodeOfferings", + "documentation": "Lists available reserved cache node offerings.", + "input": { + "MaxRecords": 20 + }, + "output": { + "Marker": "1ef01f5b-433f-94ff-a530-61a56bfc8e7a", + "ReservedCacheNodesOfferings": [ + { + "OfferingType": "Medium Utilization", + "FixedPrice": 157.0, + "ReservedCacheNodesOfferingId": "0167633d-37f6-4222-b872-b1f22eb79ba4", + "UsagePrice": 0.017, + "RecurringCharges": [], + "ProductDescription": "memcached", + "Duration": 94608000, + "CacheNodeType": "cache.m1.small" + }, + { + "OfferingType": "Heavy Utilization", + "FixedPrice": 1248.0, + "ReservedCacheNodesOfferingId": "02c04e13-baca-4e71-9ceb-620eed94827d", + "UsagePrice": 0.0, + "RecurringCharges": [ + { + "RecurringChargeAmount": 0.077, + "RecurringChargeFrequency": "Hourly" + } + ], + "ProductDescription": "redis", + "Duration": 94608000, + "CacheNodeType": "cache.m4.xlarge" + }, + { + "OfferingType": "Medium Utilization", + "FixedPrice": 2381.0, + "ReservedCacheNodesOfferingId": "02e1755e-76e8-48e3-8d82-820a5726a458", + "UsagePrice": 0.276, + "RecurringCharges": [], + "ProductDescription": "memcached", + "Duration": 94608000, + "CacheNodeType": "cache.m2.4xlarge" + }, + { + "OfferingType": "Heavy Utilization", + "FixedPrice": 188.0, + "ReservedCacheNodesOfferingId": "03315215-7b87-421a-a3dd-785021e4113f", + "UsagePrice": 0.0, + "RecurringCharges": [ + { + "RecurringChargeAmount": 0.013, + "RecurringChargeFrequency": "Hourly" + } + ], + "ProductDescription": "redis", + "Duration": 94608000, + "CacheNodeType": "cache.m1.small" + }, + { + "OfferingType": "Heavy Utilization", + "FixedPrice": 6158.0, + "ReservedCacheNodesOfferingId": "05ffbb44-2ace-4476-a2a5-8ec99f866fb3", + "UsagePrice": 0.0, + "RecurringCharges": [ + { + "RecurringChargeAmount": 1.125, + "RecurringChargeFrequency": "Hourly" + } + ], + "ProductDescription": "redis", + "Duration": 31536000, + "CacheNodeType": "cache.m4.10xlarge" + }, + { + "OfferingType": "Medium Utilization", + "FixedPrice": 101.0, + "ReservedCacheNodesOfferingId": "065c71ae-4a4e-4f1e-bebf-37525f4c6cb2", + "UsagePrice": 0.023, + "RecurringCharges": [], + "ProductDescription": "redis", + "Duration": 31536000, + "CacheNodeType": "cache.m1.small" + }, + { + "OfferingType": "Medium Utilization", + "FixedPrice": 314.0, + "ReservedCacheNodesOfferingId": "06774b12-7f5e-48c1-907a-f286c63f327d", + "UsagePrice": 0.034, + "RecurringCharges": [], + "ProductDescription": "memcached", + "Duration": 94608000, + "CacheNodeType": "cache.m1.medium" + }, + { + "OfferingType": "Light Utilization", + "FixedPrice": 163.0, + "ReservedCacheNodesOfferingId": "0924ac6b-847f-4761-ba6b-4290b2adf719", + "UsagePrice": 0.137, + "RecurringCharges": [], + "ProductDescription": "memcached", + "Duration": 31536000, + "CacheNodeType": "cache.m2.xlarge" + }, + { + "OfferingType": "Heavy Utilization", + "FixedPrice": 719.0, + "ReservedCacheNodesOfferingId": "09eeb126-69b6-4d3f-8f94-ca3510629f53", + "UsagePrice": 0.0, + "RecurringCharges": [ + { + "RecurringChargeAmount": 0.049, + "RecurringChargeFrequency": "Hourly" + } + ], + "ProductDescription": "redis", + "Duration": 94608000, + "CacheNodeType": "cache.m2.xlarge" + }, + { + "OfferingType": "Heavy Utilization", + "FixedPrice": 4132.0, + "ReservedCacheNodesOfferingId": "0a516ad8-557f-4310-9dd0-2448c2ff4d62", + "UsagePrice": 0.0, + "RecurringCharges": [ + { + "RecurringChargeAmount": 0.182, + "RecurringChargeFrequency": "Hourly" + } + ], + "ProductDescription": "redis", + "Duration": 94608000, + "CacheNodeType": "cache.r3.2xlarge" + }, + { + "OfferingType": "Light Utilization", + "FixedPrice": 875.0, + "ReservedCacheNodesOfferingId": "0b0c1cc5-2177-4150-95d7-c67ec34dcb19", + "UsagePrice": 0.363, + "RecurringCharges": [], + "ProductDescription": "memcached", + "Duration": 94608000, + "CacheNodeType": "cache.c1.xlarge" + }, + { + "OfferingType": "Heavy Utilization", + "FixedPrice": 12483.0, + "ReservedCacheNodesOfferingId": "0c2b139b-1cff-43d0-8fba-0c753f9b1950", + "UsagePrice": 0.0, + "RecurringCharges": [ + { + "RecurringChargeAmount": 0.76, + "RecurringChargeFrequency": "Hourly" + } + ], + "ProductDescription": "memcached", + "Duration": 94608000, + "CacheNodeType": "cache.m4.10xlarge" + }, + { + "OfferingType": "Heavy Utilization", + "FixedPrice": 1620.0, + "ReservedCacheNodesOfferingId": "0c52115b-38cb-47a2-8dbc-e02e40b6a13f", + "UsagePrice": 0.0, + "RecurringCharges": [ + { + "RecurringChargeAmount": 0.207, + "RecurringChargeFrequency": "Hourly" + } + ], + "ProductDescription": "memcached", + "Duration": 31536000, + "CacheNodeType": "cache.c1.xlarge" + }, + { + "OfferingType": "Medium Utilization", + "FixedPrice": 2381.0, + "ReservedCacheNodesOfferingId": "12fcb19c-5416-4e1d-934f-28f1e2cb8599", + "UsagePrice": 0.276, + "RecurringCharges": [], + "ProductDescription": "redis", + "Duration": 94608000, + "CacheNodeType": "cache.m2.4xlarge" + }, + { + "OfferingType": "Heavy Utilization", + "FixedPrice": 616.0, + "ReservedCacheNodesOfferingId": "13af20ad-914d-4d8b-9763-fa2e565f3549", + "UsagePrice": 0.0, + "RecurringCharges": [ + { + "RecurringChargeAmount": 0.112, + "RecurringChargeFrequency": "Hourly" + } + ], + "ProductDescription": "memcached", + "Duration": 31536000, + "CacheNodeType": "cache.m4.xlarge" + }, + { + "OfferingType": "Heavy Utilization", + "FixedPrice": 16528.0, + "ReservedCacheNodesOfferingId": "14da3d3f-b526-4dbf-b09b-355578b2a576", + "UsagePrice": 0.0, + "RecurringCharges": [ + { + "RecurringChargeAmount": 0.729, + "RecurringChargeFrequency": "Hourly" + } + ], + "ProductDescription": "memcached", + "Duration": 94608000, + "CacheNodeType": "cache.r3.8xlarge" + }, + { + "OfferingType": "Light Utilization", + "FixedPrice": 140.0, + "ReservedCacheNodesOfferingId": "15d7018c-71fb-4717-8409-4bdcdca18da7", + "UsagePrice": 0.052, + "RecurringCharges": [], + "ProductDescription": "redis", + "Duration": 94608000, + "CacheNodeType": "cache.m1.medium" + }, + { + "OfferingType": "Heavy Utilization", + "FixedPrice": 4993.0, + "ReservedCacheNodesOfferingId": "1ae7ec5f-a76e-49b6-822b-629b1768a13a", + "UsagePrice": 0.0, + "RecurringCharges": [ + { + "RecurringChargeAmount": 0.304, + "RecurringChargeFrequency": "Hourly" + } + ], + "ProductDescription": "memcached", + "Duration": 94608000, + "CacheNodeType": "cache.m4.4xlarge" + }, + { + "OfferingType": "Heavy Utilization", + "FixedPrice": 1772.0, + "ReservedCacheNodesOfferingId": "1d31242b-3925-48d1-b882-ce03204e6013", + "UsagePrice": 0.0, + "RecurringCharges": [ + { + "RecurringChargeAmount": 0.25, + "RecurringChargeFrequency": "Hourly" + } + ], + "ProductDescription": "redis", + "Duration": 31536000, + "CacheNodeType": "cache.m3.2xlarge" + }, + { + "OfferingType": "Medium Utilization", + "FixedPrice": 54.0, + "ReservedCacheNodesOfferingId": "1ef01f5b-94ff-433f-a530-61a56bfc8e7a", + "UsagePrice": 0.008, + "RecurringCharges": [], + "ProductDescription": "memcached", + "Duration": 31536000, + "CacheNodeType": "cache.t1.micro" + } + ] + } + }, + { + "title": "DescribeReseredCacheNodeOfferings", + "documentation": "Lists available reserved cache node offerings.", + "input": { + "ReservedCacheNodesOfferingId": "438012d3-4052-4cc7-b2e3-8d3372e0e706", + "CacheNodeType": "", + "Duration": "", + "ProductDescription": "", + "OfferingType": "", + "MaxRecords": 25, + "Marker": "" + }, + "output": { + "Marker": "", + "ReservedCacheNodesOfferings": [] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "ReservedCacheNodesOfferings", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.elasticache#DescribeReservedCacheNodesOfferingsMessage": { + "type": "structure", + "members": { + "ReservedCacheNodesOfferingId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The offering identifier filter value. Use this parameter to show only the available\n offering that matches the specified reservation identifier.

\n

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706\n

" + } + }, + "CacheNodeType": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The cache node type filter value. Use this parameter to show only the available\n offerings matching the specified cache node type.

\n

The following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.

\n \n

\n Additional node type info\n

\n " + } + }, + "Duration": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

Duration filter value, specified in years or seconds. Use this parameter to show only\n reservations for a given duration.

\n

Valid Values: 1 | 3 | 31536000 | 94608000\n

" + } + }, + "ProductDescription": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The product description filter value. Use this parameter to show only the available\n offerings matching the specified product description.

" + } + }, + "OfferingType": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The offering type filter value. Use this parameter to show only the available\n offerings matching the specified offering type.

\n

Valid Values: \"Light Utilization\"|\"Medium Utilization\"|\"Heavy Utilization\" |\"All\n Upfront\"|\"Partial Upfront\"| \"No Upfront\"\n

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a marker is included in the response so\n that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: minimum 20; maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a DescribeReservedCacheNodesOfferings\n operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#DescribeServerlessCacheSnapshots": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#DescribeServerlessCacheSnapshotsRequest" + }, + "output": { + "target": "com.amazonaws.elasticache#DescribeServerlessCacheSnapshotsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#ServerlessCacheNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#ServerlessCacheSnapshotNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about serverless cache snapshots. \n By default, this API lists all of the customer’s serverless cache snapshots. \n It can also describe a single serverless cache snapshot, or the snapshots associated with \n a particular serverless cache. Available for Valkey, Redis OSS and Serverless Memcached only.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ServerlessCacheSnapshots", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.elasticache#DescribeServerlessCacheSnapshotsRequest": { + "type": "structure", + "members": { + "ServerlessCacheName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The identifier of serverless cache. If this parameter is specified, \n only snapshots associated with that specific serverless cache are described. Available for Valkey, Redis OSS and Serverless Memcached only.

" + } + }, + "ServerlessCacheSnapshotName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The identifier of the serverless cache’s snapshot.\n If this parameter is specified, only this snapshot is described. Available for Valkey, Redis OSS and Serverless Memcached only.

" + } + }, + "SnapshotType": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The type of snapshot that is being described. Available for Valkey, Redis OSS and Serverless Memcached only.

" + } + }, + "NextToken": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

An optional marker returned from a prior request to support pagination of results from this operation. \n If this parameter is specified, the response includes only records beyond the marker, \n up to the value specified by max-results. Available for Valkey, Redis OSS and Serverless Memcached only.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than \n the specified max-results value, a market is included in the response so that remaining results \n can be retrieved. Available for Valkey, Redis OSS and Serverless Memcached only.The default is 50. The Validation Constraints are a maximum of 50.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#DescribeServerlessCacheSnapshotsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

An optional marker returned from a prior request to support pagination of results from this operation. \n If this parameter is specified, the response includes only records beyond the marker, \n up to the value specified by max-results. Available for Valkey, Redis OSS and Serverless Memcached only.

" + } + }, + "ServerlessCacheSnapshots": { + "target": "com.amazonaws.elasticache#ServerlessCacheSnapshotList", + "traits": { + "smithy.api#documentation": "

The serverless caches snapshots associated with a given description request. Available for Valkey, Redis OSS and Serverless Memcached only.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#DescribeServerlessCaches": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#DescribeServerlessCachesRequest" + }, + "output": { + "target": "com.amazonaws.elasticache#DescribeServerlessCachesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#ServerlessCacheNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a specific serverless cache. \n If no identifier is specified, then the API returns information on all the serverless caches belonging to \n this Amazon Web Services account.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ServerlessCaches", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.elasticache#DescribeServerlessCachesRequest": { + "type": "structure", + "members": { + "ServerlessCacheName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The identifier for the serverless cache. If this parameter is specified, \n only information about that specific serverless cache is returned. Default: NULL

" + } + }, + "MaxResults": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records in the response. If more records exist than the specified max-records value, \n the next token is included in the response so that remaining results can be retrieved. \n The default is 50.

" + } + }, + "NextToken": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

An optional marker returned from a prior request to support pagination of results from this operation. \n If this parameter is specified, the response includes only records beyond the marker, \n up to the value specified by MaxResults.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#DescribeServerlessCachesResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

An optional marker returned from a prior request to support pagination of results from this operation. \n If this parameter is specified, the response includes only records beyond the marker, \n up to the value specified by MaxResults.

" + } + }, + "ServerlessCaches": { + "target": "com.amazonaws.elasticache#ServerlessCacheList", + "traits": { + "smithy.api#documentation": "

The serverless caches associated with a given description request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#DescribeServiceUpdates": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#DescribeServiceUpdatesMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#ServiceUpdatesMessage" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#ServiceUpdateNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns details of the service updates

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "ServiceUpdates", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.elasticache#DescribeServiceUpdatesMessage": { + "type": "structure", + "members": { + "ServiceUpdateName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The unique ID of the service update

" + } + }, + "ServiceUpdateStatus": { + "target": "com.amazonaws.elasticache#ServiceUpdateStatusList", + "traits": { + "smithy.api#documentation": "

The status of the service update

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response

" + } + }, + "Marker": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#DescribeSnapshots": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#DescribeSnapshotsMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#DescribeSnapshotsListMessage" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#CacheClusterNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#SnapshotNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about cluster or replication group snapshots. By default,\n DescribeSnapshots lists all of your snapshots; it can optionally\n describe a single snapshot, or just the snapshots associated with a particular cache\n cluster.

\n \n

This operation is valid for Valkey or Redis OSS only.

\n ", + "smithy.api#examples": [ + { + "title": "DescribeSnapshots", + "documentation": "Returns information about the snapshot mysnapshot. By default.", + "input": { + "SnapshotName": "snapshot-20161212" + }, + "output": { + "Marker": "", + "Snapshots": [ + { + "Engine": "redis", + "CacheParameterGroupName": "default.redis3.2", + "VpcId": "vpc-91280df6", + "CacheClusterId": "my-redis5", + "SnapshotRetentionLimit": 7, + "NumCacheNodes": 1, + "SnapshotName": "snapshot-20161212", + "CacheClusterCreateTime": "2016-12-21T22:27:12.543Z", + "AutoMinorVersionUpgrade": true, + "PreferredAvailabilityZone": "us-east-1c", + "SnapshotStatus": "available", + "SnapshotSource": "manual", + "SnapshotWindow": "10:00-11:00", + "EngineVersion": "3.2.4", + "NodeSnapshots": [ + { + "CacheSize": "3 MB", + "SnapshotCreateTime": "2016-12-21T22:30:26Z", + "CacheNodeId": "0001", + "CacheNodeCreateTime": "2016-12-21T22:27:12.543Z" + } + ], + "CacheSubnetGroupName": "default", + "Port": 6379, + "PreferredMaintenanceWindow": "fri:05:30-fri:06:30", + "CacheNodeType": "cache.m3.large" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Snapshots", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.elasticache#DescribeSnapshotsListMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "Snapshots": { + "target": "com.amazonaws.elasticache#SnapshotList", + "traits": { + "smithy.api#documentation": "

A list of snapshots. Each item in the list contains detailed information about one\n snapshot.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a DescribeSnapshots operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#DescribeSnapshotsMessage": { + "type": "structure", + "members": { + "ReplicationGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

A user-supplied replication group identifier. If this parameter is specified, only\n snapshots associated with that specific replication group are described.

" + } + }, + "CacheClusterId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

A user-supplied cluster identifier. If this parameter is specified, only snapshots\n associated with that specific cluster are described.

" + } + }, + "SnapshotName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

A user-supplied name of the snapshot. If this parameter is specified, only this\n snapshot are described.

" + } + }, + "SnapshotSource": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

If set to system, the output shows snapshots that were automatically\n created by ElastiCache. If set to user the output shows snapshots that were\n manually created. If omitted, the output shows both automatically and manually created\n snapshots.

" + } + }, + "Marker": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a marker is included in the response so\n that the remaining results can be retrieved.

\n

Default: 50

\n

Constraints: minimum 20; maximum 50.

" + } + }, + "ShowNodeGroupConfig": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A Boolean value which if true, the node group (shard) configuration is included in the\n snapshot description.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a DescribeSnapshotsMessage operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#DescribeUpdateActions": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#DescribeUpdateActionsMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#UpdateActionsMessage" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns details of the update actions

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "UpdateActions", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.elasticache#DescribeUpdateActionsMessage": { + "type": "structure", + "members": { + "ServiceUpdateName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The unique ID of the service update

" + } + }, + "ReplicationGroupIds": { + "target": "com.amazonaws.elasticache#ReplicationGroupIdList", + "traits": { + "smithy.api#documentation": "

The replication group IDs

" + } + }, + "CacheClusterIds": { + "target": "com.amazonaws.elasticache#CacheClusterIdList", + "traits": { + "smithy.api#documentation": "

The cache cluster IDs

" + } + }, + "Engine": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The Elasticache engine to which the update applies. Either Valkey, Redis OSS or Memcached.

" + } + }, + "ServiceUpdateStatus": { + "target": "com.amazonaws.elasticache#ServiceUpdateStatusList", + "traits": { + "smithy.api#documentation": "

The status of the service update

" + } + }, + "ServiceUpdateTimeRange": { + "target": "com.amazonaws.elasticache#TimeRangeFilter", + "traits": { + "smithy.api#documentation": "

The range of time specified to search for service updates that are in available\n status

" + } + }, + "UpdateActionStatus": { + "target": "com.amazonaws.elasticache#UpdateActionStatusList", + "traits": { + "smithy.api#documentation": "

The status of the update action.

" + } + }, + "ShowNodeLevelUpdateStatus": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Dictates whether to include node level update status in the response

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response

" + } + }, + "Marker": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#DescribeUserGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#DescribeUserGroupsMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#DescribeUserGroupsResult" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#ServiceLinkedRoleNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#UserGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of user groups.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "UserGroups", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.elasticache#DescribeUserGroupsMessage": { + "type": "structure", + "members": { + "UserGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The ID of the user group.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a marker is included in the response so that the\n remaining results can be retrieved.

" + } + }, + "Marker": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords. >

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#DescribeUserGroupsResult": { + "type": "structure", + "members": { + "UserGroups": { + "target": "com.amazonaws.elasticache#UserGroupList", + "traits": { + "smithy.api#documentation": "

Returns a list of user groups.

" + } + }, + "Marker": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.>

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#DescribeUsers": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#DescribeUsersMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#DescribeUsersResult" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#ServiceLinkedRoleNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#UserNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of users.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Users", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.elasticache#DescribeUsersMessage": { + "type": "structure", + "members": { + "Engine": { + "target": "com.amazonaws.elasticache#EngineType", + "traits": { + "smithy.api#documentation": "

The engine.

" + } + }, + "UserId": { + "target": "com.amazonaws.elasticache#UserId", + "traits": { + "smithy.api#documentation": "

The ID of the user.

" + } + }, + "Filters": { + "target": "com.amazonaws.elasticache#FilterList", + "traits": { + "smithy.api#documentation": "

Filter to determine the list of User IDs to return.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a marker is included in the response so that the\n remaining results can be retrieved.

" + } + }, + "Marker": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords. >

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#DescribeUsersResult": { + "type": "structure", + "members": { + "Users": { + "target": "com.amazonaws.elasticache#UserList", + "traits": { + "smithy.api#documentation": "

A list of users.

" + } + }, + "Marker": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords. >

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#DestinationDetails": { + "type": "structure", + "members": { + "CloudWatchLogsDetails": { + "target": "com.amazonaws.elasticache#CloudWatchLogsDestinationDetails", + "traits": { + "smithy.api#documentation": "

The configuration details of the CloudWatch Logs destination.

" + } + }, + "KinesisFirehoseDetails": { + "target": "com.amazonaws.elasticache#KinesisFirehoseDestinationDetails", + "traits": { + "smithy.api#documentation": "

The configuration details of the Kinesis Data Firehose destination.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose\n destination.

" + } + }, + "com.amazonaws.elasticache#DestinationType": { + "type": "enum", + "members": { + "CloudWatchLogs": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cloudwatch-logs" + } + }, + "KinesisFirehose": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "kinesis-firehose" + } + } + } + }, + "com.amazonaws.elasticache#DisassociateGlobalReplicationGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#DisassociateGlobalReplicationGroupMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#DisassociateGlobalReplicationGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#GlobalReplicationGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidGlobalReplicationGroupStateFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + } + ], + "traits": { + "smithy.api#documentation": "

Remove a secondary cluster from the Global datastore using the Global datastore name.\n The secondary cluster will no longer receive updates from the primary cluster, but will\n remain as a standalone cluster in that Amazon region.

" + } + }, + "com.amazonaws.elasticache#DisassociateGlobalReplicationGroupMessage": { + "type": "structure", + "members": { + "GlobalReplicationGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Global datastore

", + "smithy.api#required": {} + } + }, + "ReplicationGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the secondary cluster you wish to remove from the Global datastore

", + "smithy.api#required": {} + } + }, + "ReplicationGroupRegion": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon region of secondary cluster you wish to remove from the Global\n datastore

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#DisassociateGlobalReplicationGroupResult": { + "type": "structure", + "members": { + "GlobalReplicationGroup": { + "target": "com.amazonaws.elasticache#GlobalReplicationGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#Double": { + "type": "double" + }, + "com.amazonaws.elasticache#DuplicateUserNameFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DuplicateUserName", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

A user with this username already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#EC2SecurityGroup": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The status of the Amazon EC2 security group.

" + } + }, + "EC2SecurityGroupName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon EC2 security group.

" + } + }, + "EC2SecurityGroupOwnerId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The Amazon account ID of the Amazon EC2 security group owner.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides ownership and status information for an Amazon EC2 security group.

" + } + }, + "com.amazonaws.elasticache#EC2SecurityGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#EC2SecurityGroup", + "traits": { + "smithy.api#xmlName": "EC2SecurityGroup" + } + } + }, + "com.amazonaws.elasticache#ECPUPerSecond": { + "type": "structure", + "members": { + "Maximum": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The configuration for the maximum number of ECPUs the cache can consume per second.

" + } + }, + "Minimum": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The configuration for the minimum number of ECPUs the cache should be able consume per second.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for the number of ElastiCache Processing Units (ECPU) the cache can consume per second.

" + } + }, + "com.amazonaws.elasticache#Endpoint": { + "type": "structure", + "members": { + "Address": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The DNS hostname of the cache node.

" + } + }, + "Port": { + "target": "com.amazonaws.elasticache#Integer", + "traits": { + "smithy.api#documentation": "

The port number that the cache engine is listening on.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the information required for client programs to connect to a cache\n node. This value is read-only.

" + } + }, + "com.amazonaws.elasticache#EngineDefaults": { + "type": "structure", + "members": { + "CacheParameterGroupFamily": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the cache parameter group family to which the engine default\n parameters apply.

\n

Valid values are: memcached1.4 | memcached1.5 |\n memcached1.6 | redis2.6 | redis2.8 |\n redis3.2 | redis4.0 | redis5.0 |\n redis6.0 | redis6.x | redis7\n

" + } + }, + "Marker": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

Provides an identifier to allow retrieval of paginated results.

" + } + }, + "Parameters": { + "target": "com.amazonaws.elasticache#ParametersList", + "traits": { + "smithy.api#documentation": "

Contains a list of engine default parameters.

" + } + }, + "CacheNodeTypeSpecificParameters": { + "target": "com.amazonaws.elasticache#CacheNodeTypeSpecificParametersList", + "traits": { + "smithy.api#documentation": "

A list of parameters specific to a particular cache node type. Each element in the\n list contains detailed information about one parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a DescribeEngineDefaultParameters\n operation.

" + } + }, + "com.amazonaws.elasticache#EngineType": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z]*$" + } + }, + "com.amazonaws.elasticache#Event": { + "type": "structure", + "members": { + "SourceIdentifier": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The identifier for the source of the event. For example, if the event occurred at the\n cluster level, the identifier would be the name of the cluster.

" + } + }, + "SourceType": { + "target": "com.amazonaws.elasticache#SourceType", + "traits": { + "smithy.api#documentation": "

Specifies the origin of this event - a cluster, a parameter group, a security group,\n etc.

" + } + }, + "Message": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The text of the event.

" + } + }, + "Date": { + "target": "com.amazonaws.elasticache#TStamp", + "traits": { + "smithy.api#documentation": "

The date and time when the event occurred.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a single occurrence of something interesting within the system. Some\n examples of events are creating a cluster, adding or removing a cache node, or rebooting\n a node.

" + } + }, + "com.amazonaws.elasticache#EventList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#Event", + "traits": { + "smithy.api#xmlName": "Event" + } + } + }, + "com.amazonaws.elasticache#EventsMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

Provides an identifier to allow retrieval of paginated results.

" + } + }, + "Events": { + "target": "com.amazonaws.elasticache#EventList", + "traits": { + "smithy.api#documentation": "

A list of events. Each element in the list contains detailed information about one\n event.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a DescribeEvents operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#ExceptionMessage": { + "type": "string" + }, + "com.amazonaws.elasticache#ExportServerlessCacheSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#ExportServerlessCacheSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.elasticache#ExportServerlessCacheSnapshotResponse" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#InvalidServerlessCacheSnapshotStateFault" + }, + { + "target": "com.amazonaws.elasticache#ServerlessCacheSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#ServiceLinkedRoleNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Provides the functionality to export the serverless cache snapshot data to Amazon S3. Available for Valkey and Redis OSS only.

" + } + }, + "com.amazonaws.elasticache#ExportServerlessCacheSnapshotRequest": { + "type": "structure", + "members": { + "ServerlessCacheSnapshotName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier of the serverless cache snapshot to be exported to S3. Available for Valkey and Redis OSS only.

", + "smithy.api#required": {} + } + }, + "S3BucketName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Name of the Amazon S3 bucket to export the snapshot to. The Amazon S3 bucket must also be in same region \n as the snapshot. Available for Valkey and Redis OSS only.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#ExportServerlessCacheSnapshotResponse": { + "type": "structure", + "members": { + "ServerlessCacheSnapshot": { + "target": "com.amazonaws.elasticache#ServerlessCacheSnapshot", + "traits": { + "smithy.api#documentation": "

The state of a serverless cache at a specific point in time, to the millisecond. Available for Valkey, Redis OSS and Serverless Memcached only.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#FailoverGlobalReplicationGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#FailoverGlobalReplicationGroupMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#FailoverGlobalReplicationGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#GlobalReplicationGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidGlobalReplicationGroupStateFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + } + ], + "traits": { + "smithy.api#documentation": "

Used to failover the primary region to a secondary region. The secondary region will\n become primary, and all other clusters will become secondary.

" + } + }, + "com.amazonaws.elasticache#FailoverGlobalReplicationGroupMessage": { + "type": "structure", + "members": { + "GlobalReplicationGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Global datastore

", + "smithy.api#required": {} + } + }, + "PrimaryRegion": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon region of the primary cluster of the Global datastore

", + "smithy.api#required": {} + } + }, + "PrimaryReplicationGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the primary replication group

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#FailoverGlobalReplicationGroupResult": { + "type": "structure", + "members": { + "GlobalReplicationGroup": { + "target": "com.amazonaws.elasticache#GlobalReplicationGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#Filter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.elasticache#FilterName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The property being filtered. For example, UserId.

", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.elasticache#FilterValueList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The property values to filter on. For example, \"user-123\".

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Used to streamline results of a search based on the property being filtered.

" + } + }, + "com.amazonaws.elasticache#FilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#Filter" + } + }, + "com.amazonaws.elasticache#FilterName": { + "type": "string", + "traits": { + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.elasticache#FilterValue": { + "type": "string", + "traits": { + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.elasticache#FilterValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#FilterValue" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.elasticache#GlobalNodeGroup": { + "type": "structure", + "members": { + "GlobalNodeGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the global node group

" + } + }, + "Slots": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The keyspace for this node group

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Indicates the slot configuration and global identifier for a slice group.

" + } + }, + "com.amazonaws.elasticache#GlobalNodeGroupIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#xmlName": "GlobalNodeGroupId" + } + } + }, + "com.amazonaws.elasticache#GlobalNodeGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#GlobalNodeGroup", + "traits": { + "smithy.api#xmlName": "GlobalNodeGroup" + } + } + }, + "com.amazonaws.elasticache#GlobalReplicationGroup": { + "type": "structure", + "members": { + "GlobalReplicationGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the Global datastore

" + } + }, + "GlobalReplicationGroupDescription": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The optional description of the Global datastore

" + } + }, + "Status": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The status of the Global datastore

" + } + }, + "CacheNodeType": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The cache node type of the Global datastore

" + } + }, + "Engine": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The ElastiCache engine. For Valkey or Redis OSS only.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The ElastiCache engine version.

" + } + }, + "Members": { + "target": "com.amazonaws.elasticache#GlobalReplicationGroupMemberList", + "traits": { + "smithy.api#documentation": "

The replication groups that comprise the Global datastore.

" + } + }, + "ClusterEnabled": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A flag that indicates whether the Global datastore is cluster enabled.

" + } + }, + "GlobalNodeGroups": { + "target": "com.amazonaws.elasticache#GlobalNodeGroupList", + "traits": { + "smithy.api#documentation": "

Indicates the slot configuration and global identifier for each slice group.

" + } + }, + "AuthTokenEnabled": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A flag that enables using an AuthToken (password) when issuing Valkey or Redis OSS \n commands.

\n

Default: false\n

" + } + }, + "TransitEncryptionEnabled": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A flag that enables in-transit encryption when set to true.

\n

\n Required: Only available when creating a replication\n group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or\n later.

" + } + }, + "AtRestEncryptionEnabled": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A flag that enables encryption at rest when set to true.

\n

You cannot modify the value of AtRestEncryptionEnabled after the\n replication group is created. To enable encryption at rest on a replication group you\n must set AtRestEncryptionEnabled to true when you create the\n replication group.

\n

\n Required: Only available when creating a replication\n group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or\n later.

" + } + }, + "ARN": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The ARN (Amazon Resource Name) of the global replication group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Consists of a primary cluster that accepts writes and an associated secondary cluster\n that resides in a different Amazon region. The secondary cluster accepts only reads. The\n primary cluster automatically replicates updates to the secondary cluster.

\n " + } + }, + "com.amazonaws.elasticache#GlobalReplicationGroupAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "GlobalReplicationGroupAlreadyExistsFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The Global datastore name already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#GlobalReplicationGroupInfo": { + "type": "structure", + "members": { + "GlobalReplicationGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the Global datastore

" + } + }, + "GlobalReplicationGroupMemberRole": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The role of the replication group in a Global datastore. Can be primary or\n secondary.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The name of the Global datastore and role of this replication group in the Global\n datastore.

" + } + }, + "com.amazonaws.elasticache#GlobalReplicationGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#GlobalReplicationGroup", + "traits": { + "smithy.api#xmlName": "GlobalReplicationGroup" + } + } + }, + "com.amazonaws.elasticache#GlobalReplicationGroupMember": { + "type": "structure", + "members": { + "ReplicationGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The replication group id of the Global datastore member.

" + } + }, + "ReplicationGroupRegion": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The Amazon region of the Global datastore member.

" + } + }, + "Role": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

Indicates the role of the replication group, primary or secondary.

" + } + }, + "AutomaticFailover": { + "target": "com.amazonaws.elasticache#AutomaticFailoverStatus", + "traits": { + "smithy.api#documentation": "

Indicates whether automatic failover is enabled for the replication group.

" + } + }, + "Status": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The status of the membership of the replication group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A member of a Global datastore. It contains the Replication Group Id, the Amazon\n region and the role of the replication group.

" + } + }, + "com.amazonaws.elasticache#GlobalReplicationGroupMemberList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#GlobalReplicationGroupMember", + "traits": { + "smithy.api#xmlName": "GlobalReplicationGroupMember" + } + } + }, + "com.amazonaws.elasticache#GlobalReplicationGroupNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "GlobalReplicationGroupNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The Global datastore does not exist

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.elasticache#IncreaseNodeGroupsInGlobalReplicationGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#IncreaseNodeGroupsInGlobalReplicationGroupMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#IncreaseNodeGroupsInGlobalReplicationGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#GlobalReplicationGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidGlobalReplicationGroupStateFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + } + ], + "traits": { + "smithy.api#documentation": "

Increase the number of node groups in the Global datastore

" + } + }, + "com.amazonaws.elasticache#IncreaseNodeGroupsInGlobalReplicationGroupMessage": { + "type": "structure", + "members": { + "GlobalReplicationGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Global datastore

", + "smithy.api#required": {} + } + }, + "NodeGroupCount": { + "target": "com.amazonaws.elasticache#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Total number of node groups you want

", + "smithy.api#required": {} + } + }, + "RegionalConfigurations": { + "target": "com.amazonaws.elasticache#RegionalConfigurationList", + "traits": { + "smithy.api#documentation": "

Describes the replication group IDs, the Amazon regions where they are stored and the\n shard configuration for each that comprise the Global datastore

" + } + }, + "ApplyImmediately": { + "target": "com.amazonaws.elasticache#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Indicates that the process begins immediately. At present, the only permitted value\n for this parameter is true.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#IncreaseNodeGroupsInGlobalReplicationGroupResult": { + "type": "structure", + "members": { + "GlobalReplicationGroup": { + "target": "com.amazonaws.elasticache#GlobalReplicationGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#IncreaseReplicaCount": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#IncreaseReplicaCountMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#IncreaseReplicaCountResult" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#ClusterQuotaForCustomerExceededFault" + }, + { + "target": "com.amazonaws.elasticache#InsufficientCacheClusterCapacityFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidCacheClusterStateFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidKMSKeyFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#InvalidReplicationGroupStateFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidVPCNetworkStateFault" + }, + { + "target": "com.amazonaws.elasticache#NodeGroupsPerReplicationGroupQuotaExceededFault" + }, + { + "target": "com.amazonaws.elasticache#NodeQuotaForCustomerExceededFault" + }, + { + "target": "com.amazonaws.elasticache#NoOperationFault" + }, + { + "target": "com.amazonaws.elasticache#ReplicationGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Dynamically increases the number of replicas in a Valkey or Redis OSS (cluster mode disabled)\n replication group or the number of replica nodes in one or more node groups (shards) of\n a Valkey or Redis OSS (cluster mode enabled) replication group. This operation is performed with no\n cluster down time.

" + } + }, + "com.amazonaws.elasticache#IncreaseReplicaCountMessage": { + "type": "structure", + "members": { + "ReplicationGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The id of the replication group to which you want to add replica nodes.

", + "smithy.api#required": {} + } + }, + "NewReplicaCount": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of read replica nodes you want at the completion of this operation. For Valkey or Redis OSS (cluster mode disabled) replication groups, this is the number of replica nodes in\n the replication group. For Valkey or Redis OSS (cluster mode enabled) replication groups, this is the\n number of replica nodes in each of the replication group's node groups.

" + } + }, + "ReplicaConfiguration": { + "target": "com.amazonaws.elasticache#ReplicaConfigurationList", + "traits": { + "smithy.api#documentation": "

A list of ConfigureShard objects that can be used to configure each\n shard in a Valkey or Redis OSS (cluster mode enabled) replication group. The\n ConfigureShard has three members: NewReplicaCount,\n NodeGroupId, and PreferredAvailabilityZones.

" + } + }, + "ApplyImmediately": { + "target": "com.amazonaws.elasticache#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

If True, the number of replica nodes is increased immediately.\n ApplyImmediately=False is not currently supported.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#IncreaseReplicaCountResult": { + "type": "structure", + "members": { + "ReplicationGroup": { + "target": "com.amazonaws.elasticache#ReplicationGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#InputAuthenticationType": { + "type": "enum", + "members": { + "PASSWORD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "password" + } + }, + "NO_PASSWORD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "no-password-required" + } + }, + "IAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "iam" + } + } + } + }, + "com.amazonaws.elasticache#InsufficientCacheClusterCapacityFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InsufficientCacheClusterCapacity", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The requested cache node type is not available in the specified Availability Zone. For\n more information, see InsufficientCacheClusterCapacity in the ElastiCache User Guide.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#Integer": { + "type": "integer" + }, + "com.amazonaws.elasticache#IntegerOptional": { + "type": "integer" + }, + "com.amazonaws.elasticache#InvalidARNFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidARN", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The requested Amazon Resource Name (ARN) does not refer to an existing\n resource.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#InvalidCacheClusterStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidCacheClusterState", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The requested cluster is not in the available state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#InvalidCacheParameterGroupStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidCacheParameterGroupState", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The current state of the cache parameter group does not allow the requested operation\n to occur.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#InvalidCacheSecurityGroupStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidCacheSecurityGroupState", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The current state of the cache security group does not allow deletion.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#InvalidCredentialsException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidCredentialsException", + "httpResponseCode": 408 + }, + "smithy.api#documentation": "

You must enter valid credentials.

", + "smithy.api#error": "client", + "smithy.api#httpError": 408 + } + }, + "com.amazonaws.elasticache#InvalidGlobalReplicationGroupStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidGlobalReplicationGroupState", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The Global datastore is not available or in primary-only state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#InvalidKMSKeyFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidKMSKeyFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The KMS key supplied is not valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#InvalidParameterCombinationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#AwsQueryErrorMessage", + "traits": { + "smithy.api#documentation": "

Two or more parameters that must not be used together were used together.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidParameterCombination", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Two or more incompatible parameters were specified.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#InvalidParameterValueException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#AwsQueryErrorMessage", + "traits": { + "smithy.api#documentation": "

A parameter value is invalid.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidParameterValue", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The value for a parameter is invalid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#InvalidReplicationGroupStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidReplicationGroupState", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The requested replication group is not in the available state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#InvalidServerlessCacheSnapshotStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidServerlessCacheSnapshotStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The state of the serverless cache snapshot was not received. Available for Valkey, Redis OSS and Serverless Memcached only.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#InvalidServerlessCacheStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidServerlessCacheStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The account for these credentials is not currently active.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#InvalidSnapshotStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidSnapshotState", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The current state of the snapshot does not allow the requested operation to\n occur.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#InvalidSubnet": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidSubnet", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

An invalid subnet identifier was specified.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#InvalidUserGroupStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidUserGroupState", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The user group is not in an active state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#InvalidUserStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidUserState", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The user is not in active state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#InvalidVPCNetworkStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidVPCNetworkStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The VPC network is in an invalid state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#IpDiscovery": { + "type": "enum", + "members": { + "IPV4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv4" + } + }, + "IPV6": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv6" + } + } + } + }, + "com.amazonaws.elasticache#KeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#String" + } + }, + "com.amazonaws.elasticache#KinesisFirehoseDestinationDetails": { + "type": "structure", + "members": { + "DeliveryStream": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the Kinesis Data Firehose delivery stream.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration details of the Kinesis Data Firehose destination.

" + } + }, + "com.amazonaws.elasticache#ListAllowedNodeTypeModifications": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#ListAllowedNodeTypeModificationsMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#AllowedNodeTypeModificationsMessage" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#CacheClusterNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#ReplicationGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all available node types that you can scale with your cluster's replication\n group's current node type.

\n

When you use the ModifyCacheCluster or\n ModifyReplicationGroup operations to scale your cluster or replication\n group, the value of the CacheNodeType parameter must be one of the node\n types returned by this operation.

", + "smithy.api#examples": [ + { + "title": "ListAllowedNodeTypeModifications", + "documentation": "Lists all available node types that you can scale your Redis cluster's or replication group's current node type up to.", + "input": { + "CacheClusterId": "mycluster" + }, + "output": { + "ScaleUpModifications": [] + } + }, + { + "title": "ListAllowedNodeTypeModifications", + "documentation": "Lists all available node types that you can scale your Redis cluster's or replication group's current node type up to.", + "input": { + "ReplicationGroupId": "myreplgroup" + }, + "output": { + "ScaleUpModifications": [ + "cache.m4.10xlarge", + "cache.m4.2xlarge", + "cache.m4.4xlarge", + "cache.m4.xlarge", + "cache.r3.2xlarge", + "cache.r3.4xlarge", + "cache.r3.8xlarge", + "cache.r3.xlarge" + ] + } + } + ] + } + }, + "com.amazonaws.elasticache#ListAllowedNodeTypeModificationsMessage": { + "type": "structure", + "members": { + "CacheClusterId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the cluster you want to scale up to a larger node instanced type.\n ElastiCache uses the cluster id to identify the current node type of this cluster and\n from that to create a list of node types you can scale up to.

\n \n

You must provide a value for either the CacheClusterId or the\n ReplicationGroupId.

\n " + } + }, + "ReplicationGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the replication group want to scale up to a larger node type. ElastiCache\n uses the replication group id to identify the current node type being used by this\n replication group, and from that to create a list of node types you can scale up\n to.

\n \n

You must provide a value for either the CacheClusterId or the\n ReplicationGroupId.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

The input parameters for the ListAllowedNodeTypeModifications\n operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#ListTagsForResourceMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#TagListMessage" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#CacheClusterNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#CacheParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#CacheSecurityGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#CacheSubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidARNFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidReplicationGroupStateFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidServerlessCacheSnapshotStateFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidServerlessCacheStateFault" + }, + { + "target": "com.amazonaws.elasticache#ReplicationGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#ReservedCacheNodeNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#ServerlessCacheNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#ServerlessCacheSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#SnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#UserGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#UserNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all tags currently on a named resource.

\n

A tag is a key-value pair where the key and value are case-sensitive. You can use\n tags to categorize and track all your ElastiCache resources, with the exception of\n global replication group. When you add or remove tags on replication groups, those\n actions will be replicated to all nodes in the replication group. For more information,\n see Resource-level permissions.

\n

If the cluster is not in the available state,\n ListTagsForResource returns an error.

", + "smithy.api#examples": [ + { + "title": "ListTagsForResource", + "documentation": "Lists all cost allocation tags currently on the named resource. A cost allocation tag is a key-value pair where the key is case-sensitive and the value is optional. You can use cost allocation tags to categorize and track your AWS costs.", + "input": { + "ResourceName": "arn:aws:elasticache:us-west-2::cluster:mycluster" + }, + "output": { + "TagList": [ + { + "Value": "20150202", + "Key": "APIVersion" + }, + { + "Value": "ElastiCache", + "Key": "Service" + } + ] + } + } + ] + } + }, + "com.amazonaws.elasticache#ListTagsForResourceMessage": { + "type": "structure", + "members": { + "ResourceName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource for which you want the list of tags,\n for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or\n arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.

\n

For more information about ARNs, see Amazon Resource Names (ARNs)\n and Amazon Web\n Services Service Namespaces.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The input parameters for the ListTagsForResource operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#LogDeliveryConfiguration": { + "type": "structure", + "members": { + "LogType": { + "target": "com.amazonaws.elasticache#LogType", + "traits": { + "smithy.api#documentation": "

Refers to slow-log or\n engine-log.

" + } + }, + "DestinationType": { + "target": "com.amazonaws.elasticache#DestinationType", + "traits": { + "smithy.api#documentation": "

Returns the destination type, either cloudwatch-logs or\n kinesis-firehose.

" + } + }, + "DestinationDetails": { + "target": "com.amazonaws.elasticache#DestinationDetails", + "traits": { + "smithy.api#documentation": "

Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose\n destination.

" + } + }, + "LogFormat": { + "target": "com.amazonaws.elasticache#LogFormat", + "traits": { + "smithy.api#documentation": "

Returns the log format, either JSON or TEXT.

" + } + }, + "Status": { + "target": "com.amazonaws.elasticache#LogDeliveryConfigurationStatus", + "traits": { + "smithy.api#documentation": "

Returns the log delivery configuration status. Values are one of enabling\n | disabling | modifying | active |\n error\n

" + } + }, + "Message": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

Returns an error message for the log delivery configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Returns the destination, format and type of the logs.

" + } + }, + "com.amazonaws.elasticache#LogDeliveryConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#LogDeliveryConfiguration", + "traits": { + "smithy.api#xmlName": "LogDeliveryConfiguration" + } + } + }, + "com.amazonaws.elasticache#LogDeliveryConfigurationRequest": { + "type": "structure", + "members": { + "LogType": { + "target": "com.amazonaws.elasticache#LogType", + "traits": { + "smithy.api#documentation": "

Refers to slow-log or\n engine-log..

" + } + }, + "DestinationType": { + "target": "com.amazonaws.elasticache#DestinationType", + "traits": { + "smithy.api#documentation": "

Specify either cloudwatch-logs or kinesis-firehose as the\n destination type.

" + } + }, + "DestinationDetails": { + "target": "com.amazonaws.elasticache#DestinationDetails", + "traits": { + "smithy.api#documentation": "

Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose\n destination.

" + } + }, + "LogFormat": { + "target": "com.amazonaws.elasticache#LogFormat", + "traits": { + "smithy.api#documentation": "

Specifies either JSON or TEXT

" + } + }, + "Enabled": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specify if log delivery is enabled. Default true.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the destination, format and type of the logs.

" + } + }, + "com.amazonaws.elasticache#LogDeliveryConfigurationRequestList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#LogDeliveryConfigurationRequest", + "traits": { + "smithy.api#xmlName": "LogDeliveryConfigurationRequest" + } + } + }, + "com.amazonaws.elasticache#LogDeliveryConfigurationStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "ENABLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabling" + } + }, + "MODIFYING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modifying" + } + }, + "DISABLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabling" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "error" + } + } + } + }, + "com.amazonaws.elasticache#LogFormat": { + "type": "enum", + "members": { + "TEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "text" + } + }, + "JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "json" + } + } + } + }, + "com.amazonaws.elasticache#LogType": { + "type": "enum", + "members": { + "SLOW_LOG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "slow-log" + } + }, + "ENGINE_LOG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "engine-log" + } + } + } + }, + "com.amazonaws.elasticache#ModifyCacheCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#ModifyCacheClusterMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#ModifyCacheClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#CacheClusterNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#CacheParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#CacheSecurityGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#InsufficientCacheClusterCapacityFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidCacheClusterStateFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidCacheSecurityGroupStateFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#InvalidVPCNetworkStateFault" + }, + { + "target": "com.amazonaws.elasticache#NodeQuotaForClusterExceededFault" + }, + { + "target": "com.amazonaws.elasticache#NodeQuotaForCustomerExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies the settings for a cluster. You can use this operation to change one or more\n cluster configuration parameters by specifying the parameters and the new values.

", + "smithy.api#examples": [ + { + "title": "ModifyCacheCluster", + "documentation": "Copies a snapshot to a specified name.", + "input": { + "CacheClusterId": "redis-cluster", + "ApplyImmediately": true, + "SnapshotRetentionLimit": 14 + }, + "output": { + "CacheCluster": { + "Engine": "redis", + "CacheParameterGroup": { + "CacheNodeIdsToReboot": [], + "CacheParameterGroupName": "default.redis3.2", + "ParameterApplyStatus": "in-sync" + }, + "SnapshotRetentionLimit": 14, + "CacheClusterId": "redis-cluster", + "CacheSecurityGroups": [], + "NumCacheNodes": 1, + "SnapshotWindow": "07:00-08:00", + "CacheClusterCreateTime": "2016-12-22T16:27:56.078Z", + "AutoMinorVersionUpgrade": true, + "CacheClusterStatus": "available", + "PreferredAvailabilityZone": "us-east-1e", + "ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:", + "CacheSubnetGroupName": "default", + "EngineVersion": "3.2.4", + "PendingModifiedValues": {}, + "PreferredMaintenanceWindow": "fri:09:00-fri:10:00", + "CacheNodeType": "cache.r3.large" + } + } + } + ] + } + }, + "com.amazonaws.elasticache#ModifyCacheClusterMessage": { + "type": "structure", + "members": { + "CacheClusterId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The cluster identifier. This value is stored as a lowercase string.

", + "smithy.api#required": {} + } + }, + "NumCacheNodes": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of cache nodes that the cluster should have. If the value for\n NumCacheNodes is greater than the sum of the number of current cache\n nodes and the number of cache nodes pending creation (which may be zero), more nodes are\n added. If the value is less than the number of existing cache nodes, nodes are removed.\n If the value is equal to the number of current cache nodes, any pending add or remove\n requests are canceled.

\n

If you are removing cache nodes, you must use the CacheNodeIdsToRemove\n parameter to provide the IDs of the specific cache nodes to remove.

\n

For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this\n value must be between 1 and 40.

\n \n

Adding or removing Memcached cache nodes can be applied immediately or as a\n pending operation (see ApplyImmediately).

\n

A pending operation to modify the number of cache nodes in a cluster during its\n maintenance window, whether by adding or removing nodes in accordance with the scale\n out architecture, is not queued. The customer's latest request to add or remove\n nodes to the cluster overrides any previous pending operations to modify the number\n of cache nodes in the cluster. For example, a request to remove 2 nodes would\n override a previous pending operation to remove 3 nodes. Similarly, a request to add\n 2 nodes would override a previous pending operation to remove 3 nodes and vice\n versa. As Memcached cache nodes may now be provisioned in different Availability\n Zones with flexible cache node placement, a request to add nodes does not\n automatically override a previous pending operation to add nodes. The customer can\n modify the previous pending operation to add more nodes or explicitly cancel the\n pending request and retry the new request. To cancel pending operations to modify\n the number of cache nodes in a cluster, use the ModifyCacheCluster\n request and set NumCacheNodes equal to the number of cache nodes\n currently in the cluster.

\n " + } + }, + "CacheNodeIdsToRemove": { + "target": "com.amazonaws.elasticache#CacheNodeIdsList", + "traits": { + "smithy.api#documentation": "

A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002,\n etc.). This parameter is only valid when NumCacheNodes is less than the\n existing number of cache nodes. The number of cache node IDs supplied in this parameter\n must match the difference between the existing number of cache nodes in the cluster or\n pending cache nodes, whichever is greater, and the value of NumCacheNodes\n in the request.

\n

For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number\n of cache nodes in this ModifyCacheCluster call is 5, you must list 2 (7 -\n 5) cache node IDs to remove.

" + } + }, + "AZMode": { + "target": "com.amazonaws.elasticache#AZMode", + "traits": { + "smithy.api#documentation": "

Specifies whether the new nodes in this Memcached cluster are all created in a single\n Availability Zone or created across multiple Availability Zones.

\n

Valid values: single-az | cross-az.

\n

This option is only supported for Memcached clusters.

\n \n

You cannot specify single-az if the Memcached cluster already has\n cache nodes in different Availability Zones. If cross-az is specified,\n existing Memcached nodes remain in their current Availability Zone.

\n

Only newly created nodes are located in different Availability Zones.

\n " + } + }, + "NewAvailabilityZones": { + "target": "com.amazonaws.elasticache#PreferredAvailabilityZoneList", + "traits": { + "smithy.api#documentation": "\n

This option is only supported on Memcached clusters.

\n \n

The list of Availability Zones where the new Memcached cache nodes are created.

\n

This parameter is only valid when NumCacheNodes in the request is greater\n than the sum of the number of active cache nodes and the number of cache nodes pending\n creation (which may be zero). The number of Availability Zones supplied in this list\n must match the cache nodes being added in this request.

\n

Scenarios:

\n
    \n
  • \n

    \n Scenario 1: You have 3 active nodes and wish\n to add 2 nodes. Specify NumCacheNodes=5 (3 + 2) and optionally\n specify two Availability Zones for the two new nodes.

    \n
    • \n
  • \n

    \n Scenario 2: You have 3 active nodes and 2\n nodes pending creation (from the scenario 1 call) and want to add 1 more node.\n Specify NumCacheNodes=6 ((3 + 2) + 1) and optionally specify an\n Availability Zone for the new node.

    \n
    • \n
  • \n

    \n Scenario 3: You want to cancel all pending\n operations. Specify NumCacheNodes=3 to cancel all pending\n operations.

    \n
    • \n
\n

The Availability Zone placement of nodes pending creation cannot be modified. If you\n wish to cancel any nodes pending creation, add 0 nodes by setting\n NumCacheNodes to the number of current nodes.

\n

If cross-az is specified, existing Memcached nodes remain in their\n current Availability Zone. Only newly created nodes can be located in different\n Availability Zones. For guidance on how to move existing Memcached nodes to different\n Availability Zones, see the Availability Zone\n Considerations section of Cache Node\n Considerations for Memcached.

\n

\n Impact of new add/remove requests upon pending requests\n

\n
    \n
  • \n

    Scenario-1

    \n
      \n
    • \n

      Pending Action: Delete

      \n
      • \n
    • \n

      New Request: Delete

      \n
      • \n
    • \n

      Result: The new delete, pending or immediate, replaces the pending\n delete.

      \n
      • \n
    \n
    • \n
  • \n

    Scenario-2

    \n
      \n
    • \n

      Pending Action: Delete

      \n
      • \n
    • \n

      New Request: Create

      \n
      • \n
    • \n

      Result: The new create, pending or immediate, replaces the pending\n delete.

      \n
      • \n
    \n
    • \n
  • \n

    Scenario-3

    \n
      \n
    • \n

      Pending Action: Create

      \n
      • \n
    • \n

      New Request: Delete

      \n
      • \n
    • \n

      Result: The new delete, pending or immediate, replaces the pending\n create.

      \n
      • \n
    \n
    • \n
  • \n

    Scenario-4

    \n
      \n
    • \n

      Pending Action: Create

      \n
      • \n
    • \n

      New Request: Create

      \n
      • \n
    • \n

      Result: The new create is added to the pending create.

      \n \n

      \n Important: If the new create\n request is Apply Immediately - Yes,\n all creates are performed immediately. If the new create request is\n Apply Immediately - No, all\n creates are pending.

      \n       \n
      • \n
    \n
    • \n
" + } + }, + "CacheSecurityGroupNames": { + "target": "com.amazonaws.elasticache#CacheSecurityGroupNameList", + "traits": { + "smithy.api#documentation": "

A list of cache security group names to authorize on this cluster. This change is\n asynchronously applied as soon as possible.

\n

You can use this parameter only with clusters that are created outside of an Amazon\n Virtual Private Cloud (Amazon VPC).

\n

Constraints: Must contain no more than 255 alphanumeric characters. Must not be\n \"Default\".

" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.elasticache#SecurityGroupIdsList", + "traits": { + "smithy.api#documentation": "

Specifies the VPC Security Groups associated with the cluster.

\n

This parameter can be used only with clusters that are created in an Amazon Virtual\n Private Cloud (Amazon VPC).

" + } + }, + "PreferredMaintenanceWindow": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

Specifies the weekly time range during which maintenance on the cluster is performed.\n It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The\n minimum maintenance window is a 60 minute period.

\n

Valid values for ddd are:

\n
    \n
  • \n

    \n sun\n

    \n
    • \n
  • \n

    \n mon\n

    \n
    • \n
  • \n

    \n tue\n

    \n
    • \n
  • \n

    \n wed\n

    \n
    • \n
  • \n

    \n thu\n

    \n
    • \n
  • \n

    \n fri\n

    \n
    • \n
  • \n

    \n sat\n

    \n
    • \n
\n

Example: sun:23:00-mon:01:30\n

" + } + }, + "NotificationTopicArn": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are\n sent.

\n \n

The Amazon SNS topic owner must be same as the cluster owner.

\n " + } + }, + "CacheParameterGroupName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the cache parameter group to apply to this cluster. This change is\n asynchronously applied as soon as possible for parameters when the\n ApplyImmediately parameter is specified as true for this\n request.

" + } + }, + "NotificationTopicStatus": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The status of the Amazon SNS notification topic. Notifications are sent only if the\n status is active.

\n

Valid values: active | inactive\n

" + } + }, + "ApplyImmediately": { + "target": "com.amazonaws.elasticache#Boolean", + "traits": { + "smithy.api#documentation": "

If true, this parameter causes the modifications in this request and any\n pending modifications to be applied, asynchronously and as soon as possible, regardless\n of the PreferredMaintenanceWindow setting for the cluster.

\n

If false, changes to the cluster are applied on the next maintenance\n reboot, or the next failure reboot, whichever occurs first.

\n \n

If you perform a ModifyCacheCluster before a pending modification is\n applied, the pending modification is replaced by the newer modification.

\n \n

Valid values: true | false\n

\n

Default: false\n

" + } + }, + "Engine": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

Modifies the engine listed in a cluster message. The options are redis, memcached or valkey.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The upgraded version of the cache engine to be run on the cache nodes.

\n

\n Important: You can upgrade to a newer engine version\n (see Selecting\n a Cache Engine and Version), but you cannot downgrade to an earlier engine\n version. If you want to use an earlier engine version, you must delete the existing\n cluster and create it anew with the earlier engine version.

" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "

 If you are running Valkey 7.2 or Redis OSS engine version 6.0 or later, set this parameter to yes \n to opt-in to the next auto minor version upgrade campaign. This parameter is\n disabled for previous versions. 

" + } + }, + "SnapshotRetentionLimit": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days for which ElastiCache retains automatic cluster snapshots before\n deleting them. For example, if you set SnapshotRetentionLimit to 5, a\n snapshot that was taken today is retained for 5 days before being deleted.

\n \n

If the value of SnapshotRetentionLimit is set to zero (0), backups\n are turned off.

\n " + } + }, + "SnapshotWindow": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot\n of your cluster.

" + } + }, + "CacheNodeType": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

A valid cache node type that you want to scale this cluster up to.

" + } + }, + "AuthToken": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

Reserved parameter. The password used to access a password protected server. This\n parameter must be specified with the auth-token-update parameter. Password\n constraints:

\n
    \n
  • \n

    Must be only printable ASCII characters

    \n
    • \n
  • \n

    Must be at least 16 characters and no more than 128 characters in\n length

    \n
    • \n
  • \n

    Cannot contain any of the following characters: '/', '\"', or '@', '%'

    \n
    • \n
\n

For more information, see AUTH password at AUTH.

" + } + }, + "AuthTokenUpdateStrategy": { + "target": "com.amazonaws.elasticache#AuthTokenUpdateStrategyType", + "traits": { + "smithy.api#documentation": "

Specifies the strategy to use to update the AUTH token. This parameter must be\n specified with the auth-token parameter. Possible values:

\n
    \n
  • \n

    ROTATE - default, if no update strategy is provided

    \n
    • \n
  • \n

    SET - allowed only after ROTATE

    \n
    • \n
  • \n

    DELETE - allowed only when transitioning to RBAC

    \n
    • \n
\n

For more information, see Authenticating Users with AUTH\n

" + } + }, + "LogDeliveryConfigurations": { + "target": "com.amazonaws.elasticache#LogDeliveryConfigurationRequestList", + "traits": { + "smithy.api#documentation": "

Specifies the destination, format and type of the logs.

" + } + }, + "IpDiscovery": { + "target": "com.amazonaws.elasticache#IpDiscovery", + "traits": { + "smithy.api#documentation": "

The network type you choose when modifying a cluster, either ipv4 |\n ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2\n and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a ModifyCacheCluster operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#ModifyCacheClusterResult": { + "type": "structure", + "members": { + "CacheCluster": { + "target": "com.amazonaws.elasticache#CacheCluster" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#ModifyCacheParameterGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#ModifyCacheParameterGroupMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#CacheParameterGroupNameMessage" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#CacheParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidCacheParameterGroupStateFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidGlobalReplicationGroupStateFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies the parameters of a cache parameter group. You can modify up to 20 parameters\n in a single request by submitting a list parameter name and value pairs.

", + "smithy.api#examples": [ + { + "title": "ModifyCacheParameterGroup", + "documentation": "Modifies one or more parameter values in the specified parameter group. You cannot modify any default parameter group.", + "input": { + "CacheParameterGroupName": "custom-mem1-4", + "ParameterNameValues": [ + { + "ParameterName": "binding_protocol", + "ParameterValue": "ascii" + }, + { + "ParameterName": "chunk_size", + "ParameterValue": "96" + } + ] + }, + "output": { + "CacheParameterGroupName": "custom-mem1-4" + } + } + ] + } + }, + "com.amazonaws.elasticache#ModifyCacheParameterGroupMessage": { + "type": "structure", + "members": { + "CacheParameterGroupName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the cache parameter group to modify.

", + "smithy.api#required": {} + } + }, + "ParameterNameValues": { + "target": "com.amazonaws.elasticache#ParameterNameValueList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An array of parameter names and values for the parameter update. You must supply at\n least one parameter name and value; subsequent arguments are optional. A maximum of 20\n parameters may be modified per request.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a ModifyCacheParameterGroup operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#ModifyCacheSubnetGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#ModifyCacheSubnetGroupMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#ModifyCacheSubnetGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#CacheSubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#CacheSubnetQuotaExceededFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidSubnet" + }, + { + "target": "com.amazonaws.elasticache#SubnetInUse" + }, + { + "target": "com.amazonaws.elasticache#SubnetNotAllowedFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies an existing cache subnet group.

", + "smithy.api#examples": [ + { + "title": "ModifyCacheSubnetGroup", + "documentation": "Modifies an existing ElastiCache subnet group.", + "input": { + "CacheSubnetGroupName": "my-sn-grp", + "SubnetIds": [ + "subnet-bcde2345" + ] + }, + "output": { + "CacheSubnetGroup": { + "VpcId": "vpc-91280df6", + "CacheSubnetGroupDescription": "My subnet group.", + "Subnets": [ + { + "SubnetIdentifier": "subnet-a1b2c3d4", + "SubnetAvailabilityZone": { + "Name": "us-east-1c" + } + }, + { + "SubnetIdentifier": "subnet-1a2b3c4d", + "SubnetAvailabilityZone": { + "Name": "us-east-1e" + } + }, + { + "SubnetIdentifier": "subnet-bcde2345", + "SubnetAvailabilityZone": { + "Name": "us-east-1e" + } + }, + { + "SubnetIdentifier": "subnet-1234abcd", + "SubnetAvailabilityZone": { + "Name": "us-east-1c" + } + }, + { + "SubnetIdentifier": "subnet-abcd1234", + "SubnetAvailabilityZone": { + "Name": "us-east-1b" + } + } + ], + "CacheSubnetGroupName": "my-sn-grp" + } + } + } + ] + } + }, + "com.amazonaws.elasticache#ModifyCacheSubnetGroupMessage": { + "type": "structure", + "members": { + "CacheSubnetGroupName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name for the cache subnet group. This value is stored as a lowercase\n string.

\n

Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

\n

Example: mysubnetgroup\n

", + "smithy.api#required": {} + } + }, + "CacheSubnetGroupDescription": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

A description of the cache subnet group.

" + } + }, + "SubnetIds": { + "target": "com.amazonaws.elasticache#SubnetIdentifierList", + "traits": { + "smithy.api#documentation": "

The EC2 subnet IDs for the cache subnet group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a ModifyCacheSubnetGroup operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#ModifyCacheSubnetGroupResult": { + "type": "structure", + "members": { + "CacheSubnetGroup": { + "target": "com.amazonaws.elasticache#CacheSubnetGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#ModifyGlobalReplicationGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#ModifyGlobalReplicationGroupMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#ModifyGlobalReplicationGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#GlobalReplicationGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidGlobalReplicationGroupStateFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies the settings for a Global datastore.

" + } + }, + "com.amazonaws.elasticache#ModifyGlobalReplicationGroupMessage": { + "type": "structure", + "members": { + "GlobalReplicationGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Global datastore

", + "smithy.api#required": {} + } + }, + "ApplyImmediately": { + "target": "com.amazonaws.elasticache#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

This parameter causes the modifications in this request and any pending modifications\n to be applied, asynchronously and as soon as possible. Modifications to Global\n Replication Groups cannot be requested to be applied in PreferredMaintenceWindow.\n

", + "smithy.api#required": {} + } + }, + "CacheNodeType": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

A valid cache node type that you want to scale this Global datastore to.

" + } + }, + "Engine": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

Modifies the engine listed in a global replication group message. The options are redis, memcached or valkey.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The upgraded version of the cache engine to be run on the clusters in the Global\n datastore.

" + } + }, + "CacheParameterGroupName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the cache parameter group to use with the Global datastore. It must be\n compatible with the major engine version used by the Global datastore.

" + } + }, + "GlobalReplicationGroupDescription": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

A description of the Global datastore

" + } + }, + "AutomaticFailoverEnabled": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Determines whether a read replica is automatically promoted to read/write primary if\n the existing primary encounters a failure.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#ModifyGlobalReplicationGroupResult": { + "type": "structure", + "members": { + "GlobalReplicationGroup": { + "target": "com.amazonaws.elasticache#GlobalReplicationGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#ModifyReplicationGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#ModifyReplicationGroupMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#ModifyReplicationGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#CacheClusterNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#CacheParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#CacheSecurityGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#InsufficientCacheClusterCapacityFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidCacheClusterStateFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidCacheSecurityGroupStateFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidKMSKeyFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#InvalidReplicationGroupStateFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidUserGroupStateFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidVPCNetworkStateFault" + }, + { + "target": "com.amazonaws.elasticache#NodeQuotaForClusterExceededFault" + }, + { + "target": "com.amazonaws.elasticache#NodeQuotaForCustomerExceededFault" + }, + { + "target": "com.amazonaws.elasticache#ReplicationGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#UserGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies the settings for a replication group. This is limited to Valkey and Redis OSS 7 and above.

\n \n \n

This operation is valid for Valkey or Redis OSS only.

\n ", + "smithy.api#examples": [ + { + "title": "ModifyReplicationGroup", + "documentation": "", + "input": { + "ReplicationGroupId": "my-redis-rg", + "ReplicationGroupDescription": "Modified replication group", + "SnapshottingClusterId": "my-redis-rg-001", + "ApplyImmediately": true, + "SnapshotRetentionLimit": 30 + }, + "output": { + "ReplicationGroup": { + "Status": "available", + "Description": "Modified replication group", + "NodeGroups": [ + { + "Status": "available", + "NodeGroupMembers": [ + { + "CurrentRole": "primary", + "PreferredAvailabilityZone": "us-east-1b", + "CacheNodeId": "0001", + "ReadEndpoint": { + "Port": 6379, + "Address": "my-redis-rg-001.abcdef.0001.use1.cache.amazonaws.com" + }, + "CacheClusterId": "my-redis-rg-001" + }, + { + "CurrentRole": "replica", + "PreferredAvailabilityZone": "us-east-1a", + "CacheNodeId": "0001", + "ReadEndpoint": { + "Port": 6379, + "Address": "my-redis-rg-002.abcdef.0001.use1.cache.amazonaws.com" + }, + "CacheClusterId": "my-redis-rg-002" + }, + { + "CurrentRole": "replica", + "PreferredAvailabilityZone": "us-east-1c", + "CacheNodeId": "0001", + "ReadEndpoint": { + "Port": 6379, + "Address": "my-redis-rg-003.abcdef.0001.use1.cache.amazonaws.com" + }, + "CacheClusterId": "my-redis-rg-003" + } + ], + "NodeGroupId": "0001", + "PrimaryEndpoint": { + "Port": 6379, + "Address": "my-redis-rg.abcdef.ng.0001.use1.cache.amazonaws.com" + } + } + ], + "ReplicationGroupId": "my-redis-rg", + "AutomaticFailover": "enabled", + "SnapshottingClusterId": "my-redis-rg-002", + "MemberClusters": [ + "my-redis-rg-001", + "my-redis-rg-002", + "my-redis-rg-003" + ], + "PendingModifiedValues": {} + } + } + } + ] + } + }, + "com.amazonaws.elasticache#ModifyReplicationGroupMessage": { + "type": "structure", + "members": { + "ReplicationGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier of the replication group to modify.

", + "smithy.api#required": {} + } + }, + "ReplicationGroupDescription": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

A description for the replication group. Maximum length is 255 characters.

" + } + }, + "PrimaryClusterId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

For replication groups with a single primary, if this parameter is specified,\n ElastiCache promotes the specified cluster in the specified replication group to the\n primary role. The nodes of all other clusters in the replication group are read\n replicas.

" + } + }, + "SnapshottingClusterId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The cluster ID that is used as the daily snapshot source for the replication group.\n This parameter cannot be set for Valkey or Redis OSS (cluster mode enabled) replication groups.

" + } + }, + "AutomaticFailoverEnabled": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Determines whether a read replica is automatically promoted to read/write primary if\n the existing primary encounters a failure.

\n

Valid values: true | false\n

" + } + }, + "MultiAZEnabled": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A flag to indicate MultiAZ is enabled.

" + } + }, + "NodeGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

Deprecated. This parameter is not used.

" + } + }, + "CacheSecurityGroupNames": { + "target": "com.amazonaws.elasticache#CacheSecurityGroupNameList", + "traits": { + "smithy.api#documentation": "

A list of cache security group names to authorize for the clusters in this replication\n group. This change is asynchronously applied as soon as possible.

\n

This parameter can be used only with replication group containing clusters running\n outside of an Amazon Virtual Private Cloud (Amazon VPC).

\n

Constraints: Must contain no more than 255 alphanumeric characters. Must not be\n Default.

" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.elasticache#SecurityGroupIdsList", + "traits": { + "smithy.api#documentation": "

Specifies the VPC Security Groups associated with the clusters in the replication\n group.

\n

This parameter can be used only with replication group containing clusters running in\n an Amazon Virtual Private Cloud (Amazon VPC).

" + } + }, + "PreferredMaintenanceWindow": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

Specifies the weekly time range during which maintenance on the cluster is performed.\n It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The\n minimum maintenance window is a 60 minute period.

\n

Valid values for ddd are:

\n
    \n
  • \n

    \n sun\n

    \n
    • \n
  • \n

    \n mon\n

    \n
    • \n
  • \n

    \n tue\n

    \n
    • \n
  • \n

    \n wed\n

    \n
    • \n
  • \n

    \n thu\n

    \n
    • \n
  • \n

    \n fri\n

    \n
    • \n
  • \n

    \n sat\n

    \n
    • \n
\n

Example: sun:23:00-mon:01:30\n

" + } + }, + "NotificationTopicArn": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are\n sent.

\n \n

The Amazon SNS topic owner must be same as the replication group owner.

\n " + } + }, + "CacheParameterGroupName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the cache parameter group to apply to all of the clusters in this\n replication group. This change is asynchronously applied as soon as possible for\n parameters when the ApplyImmediately parameter is specified as\n true for this request.

" + } + }, + "NotificationTopicStatus": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The status of the Amazon SNS notification topic for the replication group.\n Notifications are sent only if the status is active.

\n

Valid values: active | inactive\n

" + } + }, + "ApplyImmediately": { + "target": "com.amazonaws.elasticache#Boolean", + "traits": { + "smithy.api#documentation": "

If true, this parameter causes the modifications in this request and any\n pending modifications to be applied, asynchronously and as soon as possible, regardless\n of the PreferredMaintenanceWindow setting for the replication group.

\n

If false, changes to the nodes in the replication group are applied on\n the next maintenance reboot, or the next failure reboot, whichever occurs first.

\n

Valid values: true | false\n

\n

Default: false\n

" + } + }, + "Engine": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

Modifies the engine listed in a replication group message. The options are redis, memcached or valkey.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The upgraded version of the cache engine to be run on the clusters in the replication\n group.

\n

\n Important: You can upgrade to a newer engine version\n (see Selecting\n a Cache Engine and Version), but you cannot downgrade to an earlier engine\n version. If you want to use an earlier engine version, you must delete the existing\n replication group and create it anew with the earlier engine version.

" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "

 If you are running Valkey or Redis OSS engine version 6.0 or later, set this parameter to yes if\n you want to opt-in to the next auto minor version upgrade campaign. This parameter is\n disabled for previous versions. 

" + } + }, + "SnapshotRetentionLimit": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days for which ElastiCache retains automatic node group (shard)\n snapshots before deleting them. For example, if you set\n SnapshotRetentionLimit to 5, a snapshot that was taken today is\n retained for 5 days before being deleted.

\n

\n Important If the value of SnapshotRetentionLimit is\n set to zero (0), backups are turned off.

" + } + }, + "SnapshotWindow": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot\n of the node group (shard) specified by SnapshottingClusterId.

\n

Example: 05:00-09:00\n

\n

If you do not specify this parameter, ElastiCache automatically chooses an appropriate\n time range.

" + } + }, + "CacheNodeType": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

A valid cache node type that you want to scale this replication group to.

" + } + }, + "AuthToken": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

Reserved parameter. The password used to access a password protected server. This\n parameter must be specified with the auth-token-update-strategy parameter.\n Password constraints:

\n
    \n
  • \n

    Must be only printable ASCII characters

    \n
    • \n
  • \n

    Must be at least 16 characters and no more than 128 characters in\n length

    \n
    • \n
  • \n

    Cannot contain any of the following characters: '/', '\"', or '@', '%'

    \n
    • \n
\n

For more information, see AUTH password at AUTH.

" + } + }, + "AuthTokenUpdateStrategy": { + "target": "com.amazonaws.elasticache#AuthTokenUpdateStrategyType", + "traits": { + "smithy.api#documentation": "

Specifies the strategy to use to update the AUTH token. This parameter must be\n specified with the auth-token parameter. Possible values:

\n
    \n
  • \n

    ROTATE - default, if no update strategy is provided

    \n
    • \n
  • \n

    SET - allowed only after ROTATE

    \n
    • \n
  • \n

    DELETE - allowed only when transitioning to RBAC

    \n
    • \n
\n

For more information, see Authenticating Users with AUTH\n

" + } + }, + "UserGroupIdsToAdd": { + "target": "com.amazonaws.elasticache#UserGroupIdList", + "traits": { + "smithy.api#documentation": "

The ID of the user group you are associating with the replication group.

" + } + }, + "UserGroupIdsToRemove": { + "target": "com.amazonaws.elasticache#UserGroupIdList", + "traits": { + "smithy.api#documentation": "

The ID of the user group to disassociate from the replication group, meaning the users\n in the group no longer can access the replication group.

" + } + }, + "RemoveUserGroups": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Removes the user group associated with this replication group.

" + } + }, + "LogDeliveryConfigurations": { + "target": "com.amazonaws.elasticache#LogDeliveryConfigurationRequestList", + "traits": { + "smithy.api#documentation": "

Specifies the destination, format and type of the logs.

" + } + }, + "IpDiscovery": { + "target": "com.amazonaws.elasticache#IpDiscovery", + "traits": { + "smithy.api#documentation": "

The network type you choose when modifying a cluster, either ipv4 |\n ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2\n and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

" + } + }, + "TransitEncryptionEnabled": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A flag that enables in-transit encryption when set to true. If you are enabling\n in-transit encryption for an existing cluster, you must also set\n TransitEncryptionMode to preferred.

" + } + }, + "TransitEncryptionMode": { + "target": "com.amazonaws.elasticache#TransitEncryptionMode", + "traits": { + "smithy.api#documentation": "

A setting that allows you to migrate your clients to use in-transit encryption, with\n no downtime.

\n

You must set TransitEncryptionEnabled to true, for your\n existing cluster, and set TransitEncryptionMode to preferred\n in the same request to allow both encrypted and unencrypted connections at the same\n time. Once you migrate all your Valkey or Redis OSS clients to use encrypted connections you can set\n the value to required to allow encrypted connections only.

\n

Setting TransitEncryptionMode to required is a two-step\n process that requires you to first set the TransitEncryptionMode to\n preferred, after that you can set TransitEncryptionMode to\n required.

" + } + }, + "ClusterMode": { + "target": "com.amazonaws.elasticache#ClusterMode", + "traits": { + "smithy.api#documentation": "

Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first\n set the cluster mode to Compatible. Compatible mode allows your Valkey or Redis OSS clients to connect\n using both cluster mode enabled and cluster mode disabled. After you migrate all Valkey or Redis OSS\n clients to use cluster mode enabled, you can then complete cluster mode configuration\n and set the cluster mode to Enabled.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a ModifyReplicationGroups operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#ModifyReplicationGroupResult": { + "type": "structure", + "members": { + "ReplicationGroup": { + "target": "com.amazonaws.elasticache#ReplicationGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#ModifyReplicationGroupShardConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#ModifyReplicationGroupShardConfigurationMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#ModifyReplicationGroupShardConfigurationResult" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#InsufficientCacheClusterCapacityFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidCacheClusterStateFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidKMSKeyFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#InvalidReplicationGroupStateFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidVPCNetworkStateFault" + }, + { + "target": "com.amazonaws.elasticache#NodeGroupsPerReplicationGroupQuotaExceededFault" + }, + { + "target": "com.amazonaws.elasticache#NodeQuotaForCustomerExceededFault" + }, + { + "target": "com.amazonaws.elasticache#ReplicationGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies a replication group's shards (node groups) by allowing you to add shards,\n remove shards, or rebalance the keyspaces among existing shards.

" + } + }, + "com.amazonaws.elasticache#ModifyReplicationGroupShardConfigurationMessage": { + "type": "structure", + "members": { + "ReplicationGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Valkey or Redis OSS (cluster mode enabled) cluster (replication group) on which the\n shards are to be configured.

", + "smithy.api#required": {} + } + }, + "NodeGroupCount": { + "target": "com.amazonaws.elasticache#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of node groups (shards) that results from the modification of the shard\n configuration.

", + "smithy.api#required": {} + } + }, + "ApplyImmediately": { + "target": "com.amazonaws.elasticache#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Indicates that the shard reconfiguration process begins immediately. At present, the\n only permitted value for this parameter is true.

\n

Value: true

", + "smithy.api#required": {} + } + }, + "ReshardingConfiguration": { + "target": "com.amazonaws.elasticache#ReshardingConfigurationList", + "traits": { + "smithy.api#documentation": "

Specifies the preferred availability zones for each node group in the cluster. If the\n value of NodeGroupCount is greater than the current number of node groups\n (shards), you can use this parameter to specify the preferred availability zones of the\n cluster's shards. If you omit this parameter ElastiCache selects availability zones for\n you.

\n

You can specify this parameter only if the value of NodeGroupCount is\n greater than the current number of node groups (shards).

" + } + }, + "NodeGroupsToRemove": { + "target": "com.amazonaws.elasticache#NodeGroupsToRemoveList", + "traits": { + "smithy.api#documentation": "

If the value of NodeGroupCount is less than the current number of node\n groups (shards), then either NodeGroupsToRemove or\n NodeGroupsToRetain is required. NodeGroupsToRemove is a\n list of NodeGroupIds to remove from the cluster.

\n

ElastiCache will attempt to remove all node groups listed by\n NodeGroupsToRemove from the cluster.

" + } + }, + "NodeGroupsToRetain": { + "target": "com.amazonaws.elasticache#NodeGroupsToRetainList", + "traits": { + "smithy.api#documentation": "

If the value of NodeGroupCount is less than the current number of node\n groups (shards), then either NodeGroupsToRemove or\n NodeGroupsToRetain is required. NodeGroupsToRetain is a\n list of NodeGroupIds to retain in the cluster.

\n

ElastiCache will attempt to remove all node groups except those listed by\n NodeGroupsToRetain from the cluster.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input for a ModifyReplicationGroupShardConfiguration\n operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#ModifyReplicationGroupShardConfigurationResult": { + "type": "structure", + "members": { + "ReplicationGroup": { + "target": "com.amazonaws.elasticache#ReplicationGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#ModifyServerlessCache": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#ModifyServerlessCacheRequest" + }, + "output": { + "target": "com.amazonaws.elasticache#ModifyServerlessCacheResponse" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#InvalidCredentialsException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#InvalidServerlessCacheStateFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidUserGroupStateFault" + }, + { + "target": "com.amazonaws.elasticache#ServerlessCacheNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#ServiceLinkedRoleNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#UserGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

This API modifies the attributes of a serverless cache.

" + } + }, + "com.amazonaws.elasticache#ModifyServerlessCacheRequest": { + "type": "structure", + "members": { + "ServerlessCacheName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

User-provided identifier for the serverless cache to be modified.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

User provided description for the serverless cache. \n Default = NULL, i.e. the existing description is not removed/modified. \n The description has a maximum length of 255 characters.

" + } + }, + "CacheUsageLimits": { + "target": "com.amazonaws.elasticache#CacheUsageLimits", + "traits": { + "smithy.api#documentation": "

Modify the cache usage limit for the serverless cache.

" + } + }, + "RemoveUserGroup": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "

The identifier of the UserGroup to be removed from association with the Valkey and Redis OSS serverless cache. Available for Valkey and Redis OSS only. Default is NULL.

" + } + }, + "UserGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The identifier of the UserGroup to be associated with the serverless cache. Available for Valkey and Redis OSS only. \n Default is NULL - the existing UserGroup is not removed.

" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.elasticache#SecurityGroupIdsList", + "traits": { + "smithy.api#documentation": "

The new list of VPC security groups to be associated with the serverless cache. \n Populating this list means the current VPC security groups will be removed. \n This security group is used to authorize traffic access for the VPC end-point (private-link). \n Default = NULL - the existing list of VPC security groups is not removed.

" + } + }, + "SnapshotRetentionLimit": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days for which Elasticache retains automatic snapshots before deleting them. \n Available for Valkey, Redis OSS and Serverless Memcached only.\n Default = NULL, i.e. the existing snapshot-retention-limit will not be removed or modified. \n The maximum value allowed is 35 days.

" + } + }, + "DailySnapshotTime": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The daily time during which Elasticache begins taking a daily snapshot of the serverless cache. Available for Valkey, Redis OSS and Serverless Memcached only.\n The default is NULL, i.e. the existing snapshot time configured for the cluster is not removed.

" + } + }, + "Engine": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

Modifies the engine listed in a serverless cache request. The options are redis, memcached or valkey.

" + } + }, + "MajorEngineVersion": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

Modifies the engine vesion listed in a serverless cache request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#ModifyServerlessCacheResponse": { + "type": "structure", + "members": { + "ServerlessCache": { + "target": "com.amazonaws.elasticache#ServerlessCache", + "traits": { + "smithy.api#documentation": "

The response for the attempt to modify the serverless cache.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#ModifyUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#ModifyUserMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#User" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#InvalidUserStateFault" + }, + { + "target": "com.amazonaws.elasticache#ServiceLinkedRoleNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#UserNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Changes user password(s) and/or access string.

" + } + }, + "com.amazonaws.elasticache#ModifyUserGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#ModifyUserGroupMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#UserGroup" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#DefaultUserRequired" + }, + { + "target": "com.amazonaws.elasticache#DuplicateUserNameFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#InvalidUserGroupStateFault" + }, + { + "target": "com.amazonaws.elasticache#ServiceLinkedRoleNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#UserGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#UserNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Changes the list of users that belong to the user group.

" + } + }, + "com.amazonaws.elasticache#ModifyUserGroupMessage": { + "type": "structure", + "members": { + "UserGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the user group.

", + "smithy.api#required": {} + } + }, + "UserIdsToAdd": { + "target": "com.amazonaws.elasticache#UserIdListInput", + "traits": { + "smithy.api#documentation": "

The list of user IDs to add to the user group.

" + } + }, + "UserIdsToRemove": { + "target": "com.amazonaws.elasticache#UserIdListInput", + "traits": { + "smithy.api#documentation": "

The list of user IDs to remove from the user group.

" + } + }, + "Engine": { + "target": "com.amazonaws.elasticache#EngineType", + "traits": { + "smithy.api#documentation": "

The engine for a user group.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#ModifyUserMessage": { + "type": "structure", + "members": { + "UserId": { + "target": "com.amazonaws.elasticache#UserId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the user.

", + "smithy.api#required": {} + } + }, + "AccessString": { + "target": "com.amazonaws.elasticache#AccessString", + "traits": { + "smithy.api#documentation": "

Access permissions string used for this user.

" + } + }, + "AppendAccessString": { + "target": "com.amazonaws.elasticache#AccessString", + "traits": { + "smithy.api#documentation": "

Adds additional user permissions to the access string.

" + } + }, + "Passwords": { + "target": "com.amazonaws.elasticache#PasswordListInput", + "traits": { + "smithy.api#documentation": "

The passwords belonging to the user. You are allowed up to two.

" + } + }, + "NoPasswordRequired": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates no password is required for the user.

" + } + }, + "AuthenticationMode": { + "target": "com.amazonaws.elasticache#AuthenticationMode", + "traits": { + "smithy.api#documentation": "

Specifies how to authenticate the user.

" + } + }, + "Engine": { + "target": "com.amazonaws.elasticache#EngineType", + "traits": { + "smithy.api#documentation": "

The engine for a specific user.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#MultiAZStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + } + } + }, + "com.amazonaws.elasticache#NetworkType": { + "type": "enum", + "members": { + "IPV4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv4" + } + }, + "IPV6": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv6" + } + }, + "DUAL_STACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dual_stack" + } + } + } + }, + "com.amazonaws.elasticache#NetworkTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#NetworkType" + } + }, + "com.amazonaws.elasticache#NoOperationFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "NoOperationFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The operation was not performed because no changes were required.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#NodeGroup": { + "type": "structure", + "members": { + "NodeGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The identifier for the node group (shard). A Valkey or Redis OSS (cluster mode disabled) replication\n group contains only 1 node group; therefore, the node group ID is 0001. A Valkey or Redis OSS (cluster mode enabled) replication group contains 1 to 90 node groups numbered 0001 to 0090.\n Optionally, the user can provide the id for a node group.

" + } + }, + "Status": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The current state of this replication group - creating,\n available, modifying, deleting.

" + } + }, + "PrimaryEndpoint": { + "target": "com.amazonaws.elasticache#Endpoint", + "traits": { + "smithy.api#documentation": "

The endpoint of the primary node in this node group (shard).

" + } + }, + "ReaderEndpoint": { + "target": "com.amazonaws.elasticache#Endpoint", + "traits": { + "smithy.api#documentation": "

The endpoint of the replica nodes in this node group (shard). This value is read-only.

" + } + }, + "Slots": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The keyspace for this node group (shard).

" + } + }, + "NodeGroupMembers": { + "target": "com.amazonaws.elasticache#NodeGroupMemberList", + "traits": { + "smithy.api#documentation": "

A list containing information about individual nodes within the node group\n (shard).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a collection of cache nodes in a replication group. One node in the node\n group is the read/write primary node. All the other nodes are read-only Replica\n nodes.

" + } + }, + "com.amazonaws.elasticache#NodeGroupConfiguration": { + "type": "structure", + "members": { + "NodeGroupId": { + "target": "com.amazonaws.elasticache#AllowedNodeGroupId", + "traits": { + "smithy.api#documentation": "

Either the ElastiCache supplied 4-digit id or a user supplied id for the\n node group these configuration values apply to.

" + } + }, + "Slots": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

A string that specifies the keyspace for a particular node group. Keyspaces range from\n 0 to 16,383. The string is in the format startkey-endkey.

\n

Example: \"0-3999\"\n

" + } + }, + "ReplicaCount": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of read replica nodes in this node group (shard).

" + } + }, + "PrimaryAvailabilityZone": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone where the primary node of this node group (shard) is\n launched.

" + } + }, + "ReplicaAvailabilityZones": { + "target": "com.amazonaws.elasticache#AvailabilityZonesList", + "traits": { + "smithy.api#documentation": "

A list of Availability Zones to be used for the read replicas. The number of\n Availability Zones in this list must match the value of ReplicaCount or\n ReplicasPerNodeGroup if not specified.

" + } + }, + "PrimaryOutpostArn": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The outpost ARN of the primary node.

" + } + }, + "ReplicaOutpostArns": { + "target": "com.amazonaws.elasticache#OutpostArnsList", + "traits": { + "smithy.api#documentation": "

The outpost ARN of the node replicas.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Node group (shard) configuration options. Each node group (shard) configuration has\n the following: Slots, PrimaryAvailabilityZone,\n ReplicaAvailabilityZones, ReplicaCount.

" + } + }, + "com.amazonaws.elasticache#NodeGroupConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#NodeGroupConfiguration", + "traits": { + "smithy.api#xmlName": "NodeGroupConfiguration" + } + } + }, + "com.amazonaws.elasticache#NodeGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#NodeGroup", + "traits": { + "smithy.api#xmlName": "NodeGroup" + } + } + }, + "com.amazonaws.elasticache#NodeGroupMember": { + "type": "structure", + "members": { + "CacheClusterId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The ID of the cluster to which the node belongs.

" + } + }, + "CacheNodeId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002,\n etc.).

" + } + }, + "ReadEndpoint": { + "target": "com.amazonaws.elasticache#Endpoint", + "traits": { + "smithy.api#documentation": "

The information required for client programs to connect to a node for read operations.\n The read endpoint is only applicable on Valkey or Redis OSS (cluster mode disabled) clusters.

" + } + }, + "PreferredAvailabilityZone": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the Availability Zone in which the node is located.

" + } + }, + "PreferredOutpostArn": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The outpost ARN of the node group member.

" + } + }, + "CurrentRole": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The role that is currently assigned to the node - primary or\n replica. This member is only applicable for Valkey or Redis OSS (cluster mode\n disabled) replication groups.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a single node within a node group (shard).

" + } + }, + "com.amazonaws.elasticache#NodeGroupMemberList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#NodeGroupMember", + "traits": { + "smithy.api#xmlName": "NodeGroupMember" + } + } + }, + "com.amazonaws.elasticache#NodeGroupMemberUpdateStatus": { + "type": "structure", + "members": { + "CacheClusterId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The cache cluster ID

" + } + }, + "CacheNodeId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The node ID of the cache cluster

" + } + }, + "NodeUpdateStatus": { + "target": "com.amazonaws.elasticache#NodeUpdateStatus", + "traits": { + "smithy.api#documentation": "

The update status of the node

" + } + }, + "NodeDeletionDate": { + "target": "com.amazonaws.elasticache#TStamp", + "traits": { + "smithy.api#documentation": "

The deletion date of the node

" + } + }, + "NodeUpdateStartDate": { + "target": "com.amazonaws.elasticache#TStamp", + "traits": { + "smithy.api#documentation": "

The start date of the update for a node

" + } + }, + "NodeUpdateEndDate": { + "target": "com.amazonaws.elasticache#TStamp", + "traits": { + "smithy.api#documentation": "

The end date of the update for a node

" + } + }, + "NodeUpdateInitiatedBy": { + "target": "com.amazonaws.elasticache#NodeUpdateInitiatedBy", + "traits": { + "smithy.api#documentation": "

Reflects whether the update was initiated by the customer or automatically\n applied

" + } + }, + "NodeUpdateInitiatedDate": { + "target": "com.amazonaws.elasticache#TStamp", + "traits": { + "smithy.api#documentation": "

The date when the update is triggered

" + } + }, + "NodeUpdateStatusModifiedDate": { + "target": "com.amazonaws.elasticache#TStamp", + "traits": { + "smithy.api#documentation": "

The date when the NodeUpdateStatus was last modified

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The status of the service update on the node group member

" + } + }, + "com.amazonaws.elasticache#NodeGroupMemberUpdateStatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#NodeGroupMemberUpdateStatus", + "traits": { + "smithy.api#xmlName": "NodeGroupMemberUpdateStatus" + } + } + }, + "com.amazonaws.elasticache#NodeGroupNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "NodeGroupNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The node group specified by the NodeGroupId parameter could not be found.\n Please verify that the node group exists and that you spelled the\n NodeGroupId value correctly.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.elasticache#NodeGroupUpdateStatus": { + "type": "structure", + "members": { + "NodeGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The ID of the node group

" + } + }, + "NodeGroupMemberUpdateStatus": { + "target": "com.amazonaws.elasticache#NodeGroupMemberUpdateStatusList", + "traits": { + "smithy.api#documentation": "

The status of the service update on the node group member

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The status of the service update on the node group

" + } + }, + "com.amazonaws.elasticache#NodeGroupUpdateStatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#NodeGroupUpdateStatus", + "traits": { + "smithy.api#xmlName": "NodeGroupUpdateStatus" + } + } + }, + "com.amazonaws.elasticache#NodeGroupsPerReplicationGroupQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "NodeGroupsPerReplicationGroupQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request cannot be processed because it would exceed the maximum allowed number of\n node groups (shards) in a single replication group. The default maximum is 90

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#NodeGroupsToRemoveList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#AllowedNodeGroupId", + "traits": { + "smithy.api#xmlName": "NodeGroupToRemove" + } + } + }, + "com.amazonaws.elasticache#NodeGroupsToRetainList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#AllowedNodeGroupId", + "traits": { + "smithy.api#xmlName": "NodeGroupToRetain" + } + } + }, + "com.amazonaws.elasticache#NodeQuotaForClusterExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "NodeQuotaForClusterExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request cannot be processed because it would exceed the allowed number of cache\n nodes in a single cluster.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#NodeQuotaForCustomerExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "NodeQuotaForCustomerExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request cannot be processed because it would exceed the allowed number of cache\n nodes per customer.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#NodeSnapshot": { + "type": "structure", + "members": { + "CacheClusterId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

A unique identifier for the source cluster.

" + } + }, + "NodeGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

A unique identifier for the source node group (shard).

" + } + }, + "CacheNodeId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The cache node identifier for the node in the source cluster.

" + } + }, + "NodeGroupConfiguration": { + "target": "com.amazonaws.elasticache#NodeGroupConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for the source node group (shard).

" + } + }, + "CacheSize": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The size of the cache on the source cache node.

" + } + }, + "CacheNodeCreateTime": { + "target": "com.amazonaws.elasticache#TStamp", + "traits": { + "smithy.api#documentation": "

The date and time when the cache node was created in the source cluster.

" + } + }, + "SnapshotCreateTime": { + "target": "com.amazonaws.elasticache#TStamp", + "traits": { + "smithy.api#documentation": "

The date and time when the source node's metadata and cache data set was obtained for\n the snapshot.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents an individual cache node in a snapshot of a cluster.

" + } + }, + "com.amazonaws.elasticache#NodeSnapshotList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#NodeSnapshot", + "traits": { + "smithy.api#xmlName": "NodeSnapshot" + } + } + }, + "com.amazonaws.elasticache#NodeTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#String" + } + }, + "com.amazonaws.elasticache#NodeUpdateInitiatedBy": { + "type": "enum", + "members": { + "SYSTEM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "system" + } + }, + "CUSTOMER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "customer" + } + } + } + }, + "com.amazonaws.elasticache#NodeUpdateStatus": { + "type": "enum", + "members": { + "NOT_APPLIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "not-applied" + } + }, + "WAITING_TO_START": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "waiting-to-start" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "in-progress" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "stopping" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "stopped" + } + }, + "COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "complete" + } + } + } + }, + "com.amazonaws.elasticache#NotificationConfiguration": { + "type": "structure", + "members": { + "TopicArn": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the topic.

" + } + }, + "TopicStatus": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The current state of the topic.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a notification topic and its status. Notification topics are used for\n publishing ElastiCache events to subscribers using Amazon Simple Notification Service\n (SNS).

" + } + }, + "com.amazonaws.elasticache#OutpostArnsList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#xmlName": "OutpostArn" + } + } + }, + "com.amazonaws.elasticache#OutpostMode": { + "type": "enum", + "members": { + "SINGLE_OUTPOST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "single-outpost" + } + }, + "CROSS_OUTPOST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cross-outpost" + } + } + } + }, + "com.amazonaws.elasticache#Parameter": { + "type": "structure", + "members": { + "ParameterName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the parameter.

" + } + }, + "ParameterValue": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The value of the parameter.

" + } + }, + "Description": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

A description of the parameter.

" + } + }, + "Source": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The source of the parameter.

" + } + }, + "DataType": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The valid data type for the parameter.

" + } + }, + "AllowedValues": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The valid range of values for the parameter.

" + } + }, + "IsModifiable": { + "target": "com.amazonaws.elasticache#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether (true) or not (false) the parameter can be\n modified. Some parameters have security or operational implications that prevent them\n from being changed.

" + } + }, + "MinimumEngineVersion": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The earliest cache engine version to which the parameter can apply.

" + } + }, + "ChangeType": { + "target": "com.amazonaws.elasticache#ChangeType", + "traits": { + "smithy.api#documentation": "

Indicates whether a change to the parameter is applied immediately or requires a\n reboot for the change to be applied. You can force a reboot or wait until the next\n maintenance window's reboot. For more information, see Rebooting a\n Cluster.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an individual setting that controls some aspect of ElastiCache\n behavior.

" + } + }, + "com.amazonaws.elasticache#ParameterNameValue": { + "type": "structure", + "members": { + "ParameterName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the parameter.

" + } + }, + "ParameterValue": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The value of the parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a name-value pair that is used to update the value of a parameter.

" + } + }, + "com.amazonaws.elasticache#ParameterNameValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#ParameterNameValue", + "traits": { + "smithy.api#xmlName": "ParameterNameValue" + } + } + }, + "com.amazonaws.elasticache#ParametersList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#Parameter", + "traits": { + "smithy.api#xmlName": "Parameter" + } + } + }, + "com.amazonaws.elasticache#PasswordListInput": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#String" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.elasticache#PendingAutomaticFailoverStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + } + } + }, + "com.amazonaws.elasticache#PendingLogDeliveryConfiguration": { + "type": "structure", + "members": { + "LogType": { + "target": "com.amazonaws.elasticache#LogType", + "traits": { + "smithy.api#documentation": "

Refers to slow-log or\n engine-log..

" + } + }, + "DestinationType": { + "target": "com.amazonaws.elasticache#DestinationType", + "traits": { + "smithy.api#documentation": "

Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose.

" + } + }, + "DestinationDetails": { + "target": "com.amazonaws.elasticache#DestinationDetails", + "traits": { + "smithy.api#documentation": "

Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose\n destination.

" + } + }, + "LogFormat": { + "target": "com.amazonaws.elasticache#LogFormat", + "traits": { + "smithy.api#documentation": "

Returns the log format, either JSON or TEXT

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The log delivery configurations being modified

" + } + }, + "com.amazonaws.elasticache#PendingLogDeliveryConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#PendingLogDeliveryConfiguration" + } + }, + "com.amazonaws.elasticache#PendingModifiedValues": { + "type": "structure", + "members": { + "NumCacheNodes": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The new number of cache nodes for the cluster.

\n

For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this\n value must be between 1 and 40.

" + } + }, + "CacheNodeIdsToRemove": { + "target": "com.amazonaws.elasticache#CacheNodeIdsList", + "traits": { + "smithy.api#documentation": "

A list of cache node IDs that are being removed (or will be removed) from the cluster.\n A node ID is a 4-digit numeric identifier (0001, 0002, etc.).

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The new cache engine version that the cluster runs.

" + } + }, + "CacheNodeType": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The cache node type that this cluster or replication group is scaled to.

" + } + }, + "AuthTokenStatus": { + "target": "com.amazonaws.elasticache#AuthTokenUpdateStatus", + "traits": { + "smithy.api#documentation": "

The auth token status

" + } + }, + "LogDeliveryConfigurations": { + "target": "com.amazonaws.elasticache#PendingLogDeliveryConfigurationList", + "traits": { + "smithy.api#documentation": "

The log delivery configurations being modified

" + } + }, + "TransitEncryptionEnabled": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A flag that enables in-transit encryption when set to true.

" + } + }, + "TransitEncryptionMode": { + "target": "com.amazonaws.elasticache#TransitEncryptionMode", + "traits": { + "smithy.api#documentation": "

A setting that allows you to migrate your clients to use in-transit encryption, with\n no downtime.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A group of settings that are applied to the cluster in the future, or that are\n currently being applied.

" + } + }, + "com.amazonaws.elasticache#PreferredAvailabilityZoneList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#xmlName": "PreferredAvailabilityZone" + } + } + }, + "com.amazonaws.elasticache#PreferredOutpostArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#xmlName": "PreferredOutpostArn" + } + } + }, + "com.amazonaws.elasticache#ProcessedUpdateAction": { + "type": "structure", + "members": { + "ReplicationGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The ID of the replication group

" + } + }, + "CacheClusterId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The ID of the cache cluster

" + } + }, + "ServiceUpdateName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The unique ID of the service update

" + } + }, + "UpdateActionStatus": { + "target": "com.amazonaws.elasticache#UpdateActionStatus", + "traits": { + "smithy.api#documentation": "

The status of the update action on the Valkey or Redis OSS cluster

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Update action that has been processed for the corresponding apply/stop request

" + } + }, + "com.amazonaws.elasticache#ProcessedUpdateActionList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#ProcessedUpdateAction", + "traits": { + "smithy.api#xmlName": "ProcessedUpdateAction" + } + } + }, + "com.amazonaws.elasticache#PurchaseReservedCacheNodesOffering": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#PurchaseReservedCacheNodesOfferingMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#PurchaseReservedCacheNodesOfferingResult" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#ReservedCacheNodeAlreadyExistsFault" + }, + { + "target": "com.amazonaws.elasticache#ReservedCacheNodeQuotaExceededFault" + }, + { + "target": "com.amazonaws.elasticache#ReservedCacheNodesOfferingNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#TagQuotaPerResourceExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Allows you to purchase a reserved cache node offering. Reserved nodes are not eligible\n for cancellation and are non-refundable. For more information, see Managing Costs with Reserved Nodes.

", + "smithy.api#examples": [ + { + "title": "PurchaseReservedCacheNodesOfferings", + "documentation": "Allows you to purchase a reserved cache node offering.", + "input": { + "ReservedCacheNodesOfferingId": "1ef01f5b-94ff-433f-a530-61a56bfc8e7a" + } + } + ] + } + }, + "com.amazonaws.elasticache#PurchaseReservedCacheNodesOfferingMessage": { + "type": "structure", + "members": { + "ReservedCacheNodesOfferingId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the reserved cache node offering to purchase.

\n

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706\n

", + "smithy.api#required": {} + } + }, + "ReservedCacheNodeId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

A customer-specified identifier to track this reservation.

\n \n

The Reserved Cache Node ID is an unique customer-specified identifier to track\n this reservation. If this parameter is not specified, ElastiCache automatically\n generates an identifier for the reservation.

\n \n

Example: myreservationID

" + } + }, + "CacheNodeCount": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of cache node instances to reserve.

\n

Default: 1\n

" + } + }, + "Tags": { + "target": "com.amazonaws.elasticache#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must\n be accompanied by a tag value, although null is accepted.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a PurchaseReservedCacheNodesOffering\n operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#PurchaseReservedCacheNodesOfferingResult": { + "type": "structure", + "members": { + "ReservedCacheNode": { + "target": "com.amazonaws.elasticache#ReservedCacheNode" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#RebalanceSlotsInGlobalReplicationGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#RebalanceSlotsInGlobalReplicationGroupMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#RebalanceSlotsInGlobalReplicationGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#GlobalReplicationGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidGlobalReplicationGroupStateFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + } + ], + "traits": { + "smithy.api#documentation": "

Redistribute slots to ensure uniform distribution across existing shards in the\n cluster.

" + } + }, + "com.amazonaws.elasticache#RebalanceSlotsInGlobalReplicationGroupMessage": { + "type": "structure", + "members": { + "GlobalReplicationGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Global datastore

", + "smithy.api#required": {} + } + }, + "ApplyImmediately": { + "target": "com.amazonaws.elasticache#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

If True, redistribution is applied immediately.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#RebalanceSlotsInGlobalReplicationGroupResult": { + "type": "structure", + "members": { + "GlobalReplicationGroup": { + "target": "com.amazonaws.elasticache#GlobalReplicationGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#RebootCacheCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#RebootCacheClusterMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#RebootCacheClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#CacheClusterNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidCacheClusterStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Reboots some, or all, of the cache nodes within a provisioned cluster. This operation\n applies any modified cache parameter groups to the cluster. The reboot operation takes\n place as soon as possible, and results in a momentary outage to the cluster. During the\n reboot, the cluster status is set to REBOOTING.

\n

The reboot causes the contents of the cache (for each cache node being rebooted) to be\n lost.

\n

When the reboot is complete, a cluster event is created.

\n

Rebooting a cluster is currently supported on Memcached, Valkey and Redis OSS (cluster mode\n disabled) clusters. Rebooting is not supported on Valkey or Redis OSS (cluster mode enabled)\n clusters.

\n

If you make changes to parameters that require a Valkey or Redis OSS (cluster mode enabled) cluster\n reboot for the changes to be applied, see Rebooting a Cluster for an alternate process.

", + "smithy.api#examples": [ + { + "title": "RebootCacheCluster", + "documentation": "Reboots the specified nodes in the names cluster.", + "input": { + "CacheClusterId": "custom-mem1-4 ", + "CacheNodeIdsToReboot": [ + "0001", + "0002" + ] + }, + "output": { + "CacheCluster": { + "Engine": "memcached", + "CacheParameterGroup": { + "CacheNodeIdsToReboot": [], + "CacheParameterGroupName": "default.memcached1.4", + "ParameterApplyStatus": "in-sync" + }, + "CacheClusterId": "my-mem-cluster", + "PreferredAvailabilityZone": "Multiple", + "ConfigurationEndpoint": { + "Port": 11211, + "Address": "my-mem-cluster.abcdef.cfg.use1.cache.amazonaws.com" + }, + "CacheSecurityGroups": [], + "CacheClusterCreateTime": "2016-12-21T21:59:43.794Z", + "AutoMinorVersionUpgrade": true, + "CacheClusterStatus": "rebooting cache cluster nodes", + "NumCacheNodes": 2, + "ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:", + "CacheSubnetGroupName": "default", + "EngineVersion": "1.4.24", + "PendingModifiedValues": {}, + "PreferredMaintenanceWindow": "wed:06:00-wed:07:00", + "CacheNodeType": "cache.t2.medium" + } + } + } + ] + } + }, + "com.amazonaws.elasticache#RebootCacheClusterMessage": { + "type": "structure", + "members": { + "CacheClusterId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The cluster identifier. This parameter is stored as a lowercase string.

", + "smithy.api#required": {} + } + }, + "CacheNodeIdsToReboot": { + "target": "com.amazonaws.elasticache#CacheNodeIdsList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002,\n etc.). To reboot an entire cluster, specify all of the cache node IDs.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a RebootCacheCluster operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#RebootCacheClusterResult": { + "type": "structure", + "members": { + "CacheCluster": { + "target": "com.amazonaws.elasticache#CacheCluster" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#RecurringCharge": { + "type": "structure", + "members": { + "RecurringChargeAmount": { + "target": "com.amazonaws.elasticache#Double", + "traits": { + "smithy.api#documentation": "

The monetary amount of the recurring charge.

" + } + }, + "RecurringChargeFrequency": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The frequency of the recurring charge.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the specific price and frequency of a recurring charges for a reserved cache\n node, or for a reserved cache node offering.

" + } + }, + "com.amazonaws.elasticache#RecurringChargeList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#RecurringCharge", + "traits": { + "smithy.api#xmlName": "RecurringCharge" + } + } + }, + "com.amazonaws.elasticache#RegionalConfiguration": { + "type": "structure", + "members": { + "ReplicationGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the secondary cluster

", + "smithy.api#required": {} + } + }, + "ReplicationGroupRegion": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon region where the cluster is stored

", + "smithy.api#required": {} + } + }, + "ReshardingConfiguration": { + "target": "com.amazonaws.elasticache#ReshardingConfigurationList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A list of PreferredAvailabilityZones objects that specifies the\n configuration of a node group in the resharded cluster.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of the replication groups

" + } + }, + "com.amazonaws.elasticache#RegionalConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#RegionalConfiguration", + "traits": { + "smithy.api#xmlName": "RegionalConfiguration" + } + } + }, + "com.amazonaws.elasticache#RemoveReplicasList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#String" + } + }, + "com.amazonaws.elasticache#RemoveTagsFromResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#RemoveTagsFromResourceMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#TagListMessage" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#CacheClusterNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#CacheParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#CacheSecurityGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#CacheSubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidARNFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidReplicationGroupStateFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidServerlessCacheSnapshotStateFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidServerlessCacheStateFault" + }, + { + "target": "com.amazonaws.elasticache#ReplicationGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#ReservedCacheNodeNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#ServerlessCacheNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#ServerlessCacheSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#SnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#TagNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#UserGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#UserNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Removes the tags identified by the TagKeys list from the named resource.\n A tag is a key-value pair where the key and value are case-sensitive. You can use tags\n to categorize and track all your ElastiCache resources, with the exception of global\n replication group. When you add or remove tags on replication groups, those actions will\n be replicated to all nodes in the replication group. For more information, see Resource-level permissions.

", + "smithy.api#examples": [ + { + "title": "RemoveTagsFromResource", + "documentation": "Removes tags identified by a list of tag keys from the list of tags on the specified resource.", + "input": { + "ResourceName": "arn:aws:elasticache:us-east-1:1234567890:cluster:my-mem-cluster", + "TagKeys": [ + "A", + "C", + "E" + ] + }, + "output": { + "TagList": [ + { + "Value": "Banana", + "Key": "B" + }, + { + "Value": "Dog", + "Key": "D" + }, + { + "Value": "Fox", + "Key": "F" + }, + { + "Value": "", + "Key": "I" + }, + { + "Value": "Kite", + "Key": "K" + } + ] + } + } + ] + } + }, + "com.amazonaws.elasticache#RemoveTagsFromResourceMessage": { + "type": "structure", + "members": { + "ResourceName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource from which you want the tags removed,\n for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or\n arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.

\n

For more information about ARNs, see Amazon Resource Names (ARNs)\n and Amazon Service Namespaces.

", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.elasticache#KeyList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A list of TagKeys identifying the tags you want removed from the named\n resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a RemoveTagsFromResource operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#ReplicaConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#ConfigureShard", + "traits": { + "smithy.api#xmlName": "ConfigureShard" + } + } + }, + "com.amazonaws.elasticache#ReplicationGroup": { + "type": "structure", + "members": { + "ReplicationGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The identifier for the replication group.

" + } + }, + "Description": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The user supplied description of the replication group.

" + } + }, + "GlobalReplicationGroupInfo": { + "target": "com.amazonaws.elasticache#GlobalReplicationGroupInfo", + "traits": { + "smithy.api#documentation": "

The name of the Global datastore and role of this replication group in the Global\n datastore.

" + } + }, + "Status": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The current state of this replication group - creating,\n available, modifying, deleting,\n create-failed, snapshotting.

" + } + }, + "PendingModifiedValues": { + "target": "com.amazonaws.elasticache#ReplicationGroupPendingModifiedValues", + "traits": { + "smithy.api#documentation": "

A group of settings to be applied to the replication group, either immediately or\n during the next maintenance window.

" + } + }, + "MemberClusters": { + "target": "com.amazonaws.elasticache#ClusterIdList", + "traits": { + "smithy.api#documentation": "

The names of all the cache clusters that are part of this replication group.

" + } + }, + "NodeGroups": { + "target": "com.amazonaws.elasticache#NodeGroupList", + "traits": { + "smithy.api#documentation": "

A list of node groups in this replication group. For Valkey or Redis OSS (cluster mode disabled)\n replication groups, this is a single-element list. For Valkey or Redis OSS (cluster mode enabled)\n replication groups, the list contains an entry for each node group (shard).

" + } + }, + "SnapshottingClusterId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The cluster ID that is used as the daily snapshot source for the replication\n group.

" + } + }, + "AutomaticFailover": { + "target": "com.amazonaws.elasticache#AutomaticFailoverStatus", + "traits": { + "smithy.api#documentation": "

Indicates the status of automatic failover for this Valkey or Redis OSS replication group.

" + } + }, + "MultiAZ": { + "target": "com.amazonaws.elasticache#MultiAZStatus", + "traits": { + "smithy.api#documentation": "

A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more\n information, see Minimizing Downtime: Multi-AZ\n

" + } + }, + "ConfigurationEndpoint": { + "target": "com.amazonaws.elasticache#Endpoint", + "traits": { + "smithy.api#documentation": "

The configuration endpoint for this replication group. Use the configuration endpoint\n to connect to this replication group.

" + } + }, + "SnapshotRetentionLimit": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days for which ElastiCache retains automatic cluster snapshots before\n deleting them. For example, if you set SnapshotRetentionLimit to 5, a\n snapshot that was taken today is retained for 5 days before being deleted.

\n \n

If the value of SnapshotRetentionLimit is set to zero (0), backups\n are turned off.

\n " + } + }, + "SnapshotWindow": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot\n of your node group (shard).

\n

Example: 05:00-09:00\n

\n

If you do not specify this parameter, ElastiCache automatically chooses an appropriate\n time range.

\n \n

This parameter is only valid if the Engine parameter is\n redis.

\n " + } + }, + "ClusterEnabled": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A flag indicating whether or not this replication group is cluster enabled; i.e.,\n whether its data can be partitioned across multiple shards (API/CLI: node\n groups).

\n

Valid values: true | false\n

" + } + }, + "CacheNodeType": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the compute and memory capacity node type for each node in the replication\n group.

" + } + }, + "AuthTokenEnabled": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A flag that enables using an AuthToken (password) when issuing Valkey or Redis OSS \n commands.

\n

Default: false\n

" + } + }, + "AuthTokenLastModifiedDate": { + "target": "com.amazonaws.elasticache#TStamp", + "traits": { + "smithy.api#documentation": "

The date the auth token was last modified

" + } + }, + "TransitEncryptionEnabled": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A flag that enables in-transit encryption when set to true.

\n

\n Required: Only available when creating a replication\n group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or\n later.

\n

Default: false\n

" + } + }, + "AtRestEncryptionEnabled": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A flag that enables encryption at-rest when set to true.

\n

You cannot modify the value of AtRestEncryptionEnabled after the cluster\n is created. To enable encryption at-rest on a cluster you must set\n AtRestEncryptionEnabled to true when you create a\n cluster.

\n

\n Required: Only available when creating a replication\n group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or\n later.

\n

Default: false\n

" + } + }, + "MemberClustersOutpostArns": { + "target": "com.amazonaws.elasticache#ReplicationGroupOutpostArnList", + "traits": { + "smithy.api#documentation": "

The outpost ARNs of the replication group's member clusters.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The ID of the KMS key used to encrypt the disk in the cluster.

" + } + }, + "ARN": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The ARN (Amazon Resource Name) of the replication group.

" + } + }, + "UserGroupIds": { + "target": "com.amazonaws.elasticache#UserGroupIdList", + "traits": { + "smithy.api#documentation": "

The ID of the user group associated to the replication group.

" + } + }, + "LogDeliveryConfigurations": { + "target": "com.amazonaws.elasticache#LogDeliveryConfigurationList", + "traits": { + "smithy.api#documentation": "

Returns the destination, format and type of the logs.

" + } + }, + "ReplicationGroupCreateTime": { + "target": "com.amazonaws.elasticache#TStamp", + "traits": { + "smithy.api#documentation": "

The date and time when the cluster was created.

" + } + }, + "DataTiering": { + "target": "com.amazonaws.elasticache#DataTieringStatus", + "traits": { + "smithy.api#documentation": "

Enables data tiering. Data tiering is only supported for replication groups using the\n r6gd node type. This parameter must be set to true when using r6gd nodes. For more\n information, see Data tiering.

" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.elasticache#Boolean", + "traits": { + "smithy.api#documentation": "

If you are running Valkey 7.2 and above, or Redis OSS engine version 6.0 and above, set this parameter to yes if you\n want to opt-in to the next auto minor version upgrade campaign. This parameter is\n disabled for previous versions.

" + } + }, + "NetworkType": { + "target": "com.amazonaws.elasticache#NetworkType", + "traits": { + "smithy.api#documentation": "

Must be either ipv4 | ipv6 | dual_stack. IPv6\n is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2\n and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

" + } + }, + "IpDiscovery": { + "target": "com.amazonaws.elasticache#IpDiscovery", + "traits": { + "smithy.api#documentation": "

The network type you choose when modifying a cluster, either ipv4 |\n ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2\n and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

" + } + }, + "TransitEncryptionMode": { + "target": "com.amazonaws.elasticache#TransitEncryptionMode", + "traits": { + "smithy.api#documentation": "

A setting that allows you to migrate your clients to use in-transit encryption, with\n no downtime.

" + } + }, + "ClusterMode": { + "target": "com.amazonaws.elasticache#ClusterMode", + "traits": { + "smithy.api#documentation": "

Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first\n set the cluster mode to Compatible. Compatible mode allows your Valkey or Redis OSS clients to connect\n using both cluster mode enabled and cluster mode disabled. After you migrate all Valkey or Redis OSS \n clients to use cluster mode enabled, you can then complete cluster mode configuration\n and set the cluster mode to Enabled.

" + } + }, + "Engine": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The engine used in a replication group. The options are redis, memcached or valkey.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains all of the attributes of a specific Valkey or Redis OSS replication group.

" + } + }, + "com.amazonaws.elasticache#ReplicationGroupAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ReplicationGroupAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The specified replication group already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#ReplicationGroupAlreadyUnderMigrationFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ReplicationGroupAlreadyUnderMigrationFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The targeted replication group is not available.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#ReplicationGroupIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#String" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.elasticache#ReplicationGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#ReplicationGroup", + "traits": { + "smithy.api#xmlName": "ReplicationGroup" + } + } + }, + "com.amazonaws.elasticache#ReplicationGroupMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

Provides an identifier to allow retrieval of paginated results.

" + } + }, + "ReplicationGroups": { + "target": "com.amazonaws.elasticache#ReplicationGroupList", + "traits": { + "smithy.api#documentation": "

A list of replication groups. Each item in the list contains detailed information\n about one replication group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a DescribeReplicationGroups operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#ReplicationGroupNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ReplicationGroupNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified replication group does not exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.elasticache#ReplicationGroupNotUnderMigrationFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ReplicationGroupNotUnderMigrationFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The designated replication group is not available for data migration.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#ReplicationGroupOutpostArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#xmlName": "ReplicationGroupOutpostArn" + } + } + }, + "com.amazonaws.elasticache#ReplicationGroupPendingModifiedValues": { + "type": "structure", + "members": { + "PrimaryClusterId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The primary cluster ID that is applied immediately (if\n --apply-immediately was specified), or during the next maintenance\n window.

" + } + }, + "AutomaticFailoverStatus": { + "target": "com.amazonaws.elasticache#PendingAutomaticFailoverStatus", + "traits": { + "smithy.api#documentation": "

Indicates the status of automatic failover for this Valkey or Redis OSS replication group.

" + } + }, + "Resharding": { + "target": "com.amazonaws.elasticache#ReshardingStatus", + "traits": { + "smithy.api#documentation": "

The status of an online resharding operation.

" + } + }, + "AuthTokenStatus": { + "target": "com.amazonaws.elasticache#AuthTokenUpdateStatus", + "traits": { + "smithy.api#documentation": "

The auth token status

" + } + }, + "UserGroups": { + "target": "com.amazonaws.elasticache#UserGroupsUpdateStatus", + "traits": { + "smithy.api#documentation": "

The user group being modified.

" + } + }, + "LogDeliveryConfigurations": { + "target": "com.amazonaws.elasticache#PendingLogDeliveryConfigurationList", + "traits": { + "smithy.api#documentation": "

The log delivery configurations being modified

" + } + }, + "TransitEncryptionEnabled": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A flag that enables in-transit encryption when set to true.

" + } + }, + "TransitEncryptionMode": { + "target": "com.amazonaws.elasticache#TransitEncryptionMode", + "traits": { + "smithy.api#documentation": "

A setting that allows you to migrate your clients to use in-transit encryption, with\n no downtime.

" + } + }, + "ClusterMode": { + "target": "com.amazonaws.elasticache#ClusterMode", + "traits": { + "smithy.api#documentation": "

Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first\n set the cluster mode to Compatible. Compatible mode allows your Valkey or Redis OSS clients to connect\n using both cluster mode enabled and cluster mode disabled. After you migrate all Valkey or Redis OSS\n clients to use cluster mode enabled, you can then complete cluster mode configuration\n and set the cluster mode to Enabled.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The settings to be applied to the Valkey or Redis OSS replication group, either immediately or\n during the next maintenance window.

" + } + }, + "com.amazonaws.elasticache#ReservedCacheNode": { + "type": "structure", + "members": { + "ReservedCacheNodeId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The unique identifier for the reservation.

" + } + }, + "ReservedCacheNodesOfferingId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The offering identifier.

" + } + }, + "CacheNodeType": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The cache node type for the reserved cache nodes.

\n

The following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.

\n
    \n
  • \n

    General purpose:

    \n
      \n
    • \n

      Current generation:

      \n

      \n M7g node types:\n \t\t\t\t\tcache.m7g.large,\n \t\t\t\t\tcache.m7g.xlarge,\n \t\t\t\t\tcache.m7g.2xlarge,\n \t\t\t\t\tcache.m7g.4xlarge,\n \t\t\t\t\tcache.m7g.8xlarge,\n \t\t\t\t\tcache.m7g.12xlarge,\n \t\t\t\t\tcache.m7g.16xlarge\n

      \n \n

      For region availability, see Supported Node Types\n

      \n       \n

      \n M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n

      \n

      \n M5 node types:\n cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n

      \n

      \n M4 node types:\n cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n

      \n

      \n T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n

      \n

      \n T3 node types:\n cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n

      \n

      \n T2 node types:\n cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n

      \n
      • \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n T1 node types:\n cache.t1.micro\n

      \n

      \n M1 node types:\n cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n

      \n

      \n M3 node types:\n cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n

      \n
      • \n
    \n
    • \n
  • \n

    Compute optimized:

    \n
      \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n C1 node types:\n cache.c1.xlarge\n

      \n
      • \n
    \n
    • \n
  • \n

    Memory optimized:

    \n
      \n
    • \n

      Current generation:

      \n

      \n R7g node types:\t\n\t\t\t\t\t\t\tcache.r7g.large,\n\t\t\t\t\t\t\tcache.r7g.xlarge,\n\t\t\t\t\t\t\tcache.r7g.2xlarge,\n\t\t\t\t\t\t\tcache.r7g.4xlarge,\n\t\t\t\t\t\t\tcache.r7g.8xlarge,\n\t\t\t\t\t\t\tcache.r7g.12xlarge,\n\t\t\t\t\t\t\tcache.r7g.16xlarge\n

      \n \n

      For region availability, see Supported Node Types\n

      \n       \n

      \n R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t\t\tcache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n

      \n

      \n R5 node types:\n cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n

      \n

      \n R4 node types:\n cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n

      \n
      • \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n M2 node types:\n cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n

      \n

      \n R3 node types:\n cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n

      \n
      • \n
    \n
    • \n
\n

\n Additional node type info\n

\n
    \n
  • \n

    All current generation instance types are created in Amazon VPC by\n default.

    \n
    • \n
  • \n

    Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.

    \n
    • \n
  • \n

    Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1\n instances.

    \n
    • \n
  • \n

    The configuration variables appendonly and\n appendfsync are not supported on Valkey, or on Redis OSS version 2.8.22 and\n later.

    \n
    • \n
" + } + }, + "StartTime": { + "target": "com.amazonaws.elasticache#TStamp", + "traits": { + "smithy.api#documentation": "

The time the reservation started.

" + } + }, + "Duration": { + "target": "com.amazonaws.elasticache#Integer", + "traits": { + "smithy.api#documentation": "

The duration of the reservation in seconds.

" + } + }, + "FixedPrice": { + "target": "com.amazonaws.elasticache#Double", + "traits": { + "smithy.api#documentation": "

The fixed price charged for this reserved cache node.

" + } + }, + "UsagePrice": { + "target": "com.amazonaws.elasticache#Double", + "traits": { + "smithy.api#documentation": "

The hourly price charged for this reserved cache node.

" + } + }, + "CacheNodeCount": { + "target": "com.amazonaws.elasticache#Integer", + "traits": { + "smithy.api#documentation": "

The number of cache nodes that have been reserved.

" + } + }, + "ProductDescription": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The description of the reserved cache node.

" + } + }, + "OfferingType": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The offering type of this reserved cache node.

" + } + }, + "State": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The state of the reserved cache node.

" + } + }, + "RecurringCharges": { + "target": "com.amazonaws.elasticache#RecurringChargeList", + "traits": { + "smithy.api#documentation": "

The recurring price charged to run this reserved cache node.

" + } + }, + "ReservationARN": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the reserved cache node.

\n

Example:\n arn:aws:elasticache:us-east-1:123456789012:reserved-instance:ri-2017-03-27-08-33-25-582\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a PurchaseReservedCacheNodesOffering\n operation.

" + } + }, + "com.amazonaws.elasticache#ReservedCacheNodeAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ReservedCacheNodeAlreadyExists", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

You already have a reservation with the given identifier.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.elasticache#ReservedCacheNodeList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#ReservedCacheNode", + "traits": { + "smithy.api#xmlName": "ReservedCacheNode" + } + } + }, + "com.amazonaws.elasticache#ReservedCacheNodeMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

Provides an identifier to allow retrieval of paginated results.

" + } + }, + "ReservedCacheNodes": { + "target": "com.amazonaws.elasticache#ReservedCacheNodeList", + "traits": { + "smithy.api#documentation": "

A list of reserved cache nodes. Each element in the list contains detailed information\n about one node.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a DescribeReservedCacheNodes operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#ReservedCacheNodeNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ReservedCacheNodeNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The requested reserved cache node was not found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.elasticache#ReservedCacheNodeQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ReservedCacheNodeQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request cannot be processed because it would exceed the user's cache node\n quota.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#ReservedCacheNodesOffering": { + "type": "structure", + "members": { + "ReservedCacheNodesOfferingId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

A unique identifier for the reserved cache node offering.

" + } + }, + "CacheNodeType": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The cache node type for the reserved cache node.

\n

The following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.

\n
    \n
  • \n

    General purpose:

    \n
      \n
    • \n

      Current generation:

      \n

      \n M7g node types:\n \t\t\t\t\tcache.m7g.large,\n \t\t\t\t\tcache.m7g.xlarge,\n \t\t\t\t\tcache.m7g.2xlarge,\n \t\t\t\t\tcache.m7g.4xlarge,\n \t\t\t\t\tcache.m7g.8xlarge,\n \t\t\t\t\tcache.m7g.12xlarge,\n \t\t\t\t\tcache.m7g.16xlarge\n

      \n \n

      For region availability, see Supported Node Types\n

      \n       \n

      \n M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n

      \n

      \n M5 node types:\n cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n

      \n

      \n M4 node types:\n cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n

      \n

      \n T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n

      \n

      \n T3 node types:\n cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n

      \n

      \n T2 node types:\n cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n

      \n
      • \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n T1 node types:\n cache.t1.micro\n

      \n

      \n M1 node types:\n cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n

      \n

      \n M3 node types:\n cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n

      \n
      • \n
    \n
    • \n
  • \n

    Compute optimized:

    \n
      \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n C1 node types:\n cache.c1.xlarge\n

      \n
      • \n
    \n
    • \n
  • \n

    Memory optimized:

    \n
      \n
    • \n

      Current generation:

      \n

      \n R7g node types:\t\n\t\t\t\t\t\t\tcache.r7g.large,\n\t\t\t\t\t\t\tcache.r7g.xlarge,\n\t\t\t\t\t\t\tcache.r7g.2xlarge,\n\t\t\t\t\t\t\tcache.r7g.4xlarge,\n\t\t\t\t\t\t\tcache.r7g.8xlarge,\n\t\t\t\t\t\t\tcache.r7g.12xlarge,\n\t\t\t\t\t\t\tcache.r7g.16xlarge\n

      \n \n

      For region availability, see Supported Node Types\n

      \n       \n

      \n R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t\t\tcache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n

      \n

      \n R5 node types:\n cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n

      \n

      \n R4 node types:\n cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n

      \n
      • \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n M2 node types:\n cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n

      \n

      \n R3 node types:\n cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n

      \n
      • \n
    \n
    • \n
\n

\n Additional node type info\n

\n
    \n
  • \n

    All current generation instance types are created in Amazon VPC by\n default.

    \n
    • \n
  • \n

    Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.

    \n
    • \n
  • \n

    Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1\n instances.

    \n
    • \n
  • \n

    The configuration variables appendonly and\n appendfsync are not supported on Valkey, or on Redis OSS version 2.8.22 and\n later.

    \n
    • \n
" + } + }, + "Duration": { + "target": "com.amazonaws.elasticache#Integer", + "traits": { + "smithy.api#documentation": "

The duration of the offering. in seconds.

" + } + }, + "FixedPrice": { + "target": "com.amazonaws.elasticache#Double", + "traits": { + "smithy.api#documentation": "

The fixed price charged for this offering.

" + } + }, + "UsagePrice": { + "target": "com.amazonaws.elasticache#Double", + "traits": { + "smithy.api#documentation": "

The hourly price charged for this offering.

" + } + }, + "ProductDescription": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The cache engine used by the offering.

" + } + }, + "OfferingType": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The offering type.

" + } + }, + "RecurringCharges": { + "target": "com.amazonaws.elasticache#RecurringChargeList", + "traits": { + "smithy.api#documentation": "

The recurring price charged to run this reserved cache node.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes all of the attributes of a reserved cache node offering.

" + } + }, + "com.amazonaws.elasticache#ReservedCacheNodesOfferingList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#ReservedCacheNodesOffering", + "traits": { + "smithy.api#xmlName": "ReservedCacheNodesOffering" + } + } + }, + "com.amazonaws.elasticache#ReservedCacheNodesOfferingMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

Provides an identifier to allow retrieval of paginated results.

" + } + }, + "ReservedCacheNodesOfferings": { + "target": "com.amazonaws.elasticache#ReservedCacheNodesOfferingList", + "traits": { + "smithy.api#documentation": "

A list of reserved cache node offerings. Each element in the list contains detailed\n information about one offering.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a DescribeReservedCacheNodesOfferings\n operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#ReservedCacheNodesOfferingNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ReservedCacheNodesOfferingNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The requested cache node offering does not exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.elasticache#ResetCacheParameterGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#ResetCacheParameterGroupMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#CacheParameterGroupNameMessage" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#CacheParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidCacheParameterGroupStateFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidGlobalReplicationGroupStateFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies the parameters of a cache parameter group to the engine or system default\n value. You can reset specific parameters by submitting a list of parameter names. To\n reset the entire cache parameter group, specify the ResetAllParameters and\n CacheParameterGroupName parameters.

", + "smithy.api#examples": [ + { + "title": "ResetCacheParameterGroup", + "documentation": "Modifies the parameters of a cache parameter group to the engine or system default value.", + "input": { + "CacheParameterGroupName": "custom-mem1-4", + "ResetAllParameters": true + }, + "output": { + "CacheParameterGroupName": "custom-mem1-4" + } + } + ] + } + }, + "com.amazonaws.elasticache#ResetCacheParameterGroupMessage": { + "type": "structure", + "members": { + "CacheParameterGroupName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the cache parameter group to reset.

", + "smithy.api#required": {} + } + }, + "ResetAllParameters": { + "target": "com.amazonaws.elasticache#Boolean", + "traits": { + "smithy.api#documentation": "

If true, all parameters in the cache parameter group are reset to their\n default values. If false, only the parameters listed by\n ParameterNameValues are reset to their default values.

\n

Valid values: true | false\n

" + } + }, + "ParameterNameValues": { + "target": "com.amazonaws.elasticache#ParameterNameValueList", + "traits": { + "smithy.api#documentation": "

An array of parameter names to reset to their default values. If\n ResetAllParameters is true, do not use\n ParameterNameValues. If ResetAllParameters is\n false, you must specify the name of at least one parameter to\n reset.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a ResetCacheParameterGroup operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#ReshardingConfiguration": { + "type": "structure", + "members": { + "NodeGroupId": { + "target": "com.amazonaws.elasticache#AllowedNodeGroupId", + "traits": { + "smithy.api#documentation": "

Either the ElastiCache supplied 4-digit id or a user supplied id for the\n node group these configuration values apply to.

" + } + }, + "PreferredAvailabilityZones": { + "target": "com.amazonaws.elasticache#AvailabilityZonesList", + "traits": { + "smithy.api#documentation": "

A list of preferred availability zones for the nodes in this cluster.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of PreferredAvailabilityZones objects that specifies the\n configuration of a node group in the resharded cluster.

" + } + }, + "com.amazonaws.elasticache#ReshardingConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#ReshardingConfiguration", + "traits": { + "smithy.api#xmlName": "ReshardingConfiguration" + } + } + }, + "com.amazonaws.elasticache#ReshardingStatus": { + "type": "structure", + "members": { + "SlotMigration": { + "target": "com.amazonaws.elasticache#SlotMigration", + "traits": { + "smithy.api#documentation": "

Represents the progress of an online resharding operation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The status of an online resharding operation.

" + } + }, + "com.amazonaws.elasticache#RevokeCacheSecurityGroupIngress": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#RevokeCacheSecurityGroupIngressMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#RevokeCacheSecurityGroupIngressResult" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#AuthorizationNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#CacheSecurityGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidCacheSecurityGroupStateFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + } + ], + "traits": { + "smithy.api#documentation": "

Revokes ingress from a cache security group. Use this operation to disallow access\n from an Amazon EC2 security group that had been previously authorized.

", + "smithy.api#examples": [ + { + "title": "DescribeCacheSecurityGroups", + "documentation": "Returns a list of cache security group descriptions. If a cache security group name is specified, the list contains only the description of that group.", + "input": { + "CacheSecurityGroupName": "my-sec-grp", + "EC2SecurityGroupName": "my-ec2-sec-grp", + "EC2SecurityGroupOwnerId": "1234567890" + } + } + ] + } + }, + "com.amazonaws.elasticache#RevokeCacheSecurityGroupIngressMessage": { + "type": "structure", + "members": { + "CacheSecurityGroupName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the cache security group to revoke ingress from.

", + "smithy.api#required": {} + } + }, + "EC2SecurityGroupName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Amazon EC2 security group to revoke access from.

", + "smithy.api#required": {} + } + }, + "EC2SecurityGroupOwnerId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon account number of the Amazon EC2 security group owner. Note that this is\n not the same thing as an Amazon access key ID - you must provide a valid Amazon account\n number for this parameter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a RevokeCacheSecurityGroupIngress\n operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#RevokeCacheSecurityGroupIngressResult": { + "type": "structure", + "members": { + "CacheSecurityGroup": { + "target": "com.amazonaws.elasticache#CacheSecurityGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#SecurityGroupIdsList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#xmlName": "SecurityGroupId" + } + } + }, + "com.amazonaws.elasticache#SecurityGroupMembership": { + "type": "structure", + "members": { + "SecurityGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The identifier of the cache security group.

" + } + }, + "Status": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The status of the cache security group membership. The status changes whenever a cache\n security group is modified, or when the cache security groups assigned to a cluster are\n modified.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a single cache security group and its status.

" + } + }, + "com.amazonaws.elasticache#SecurityGroupMembershipList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#SecurityGroupMembership" + } + }, + "com.amazonaws.elasticache#ServerlessCache": { + "type": "structure", + "members": { + "ServerlessCacheName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The unique identifier of the serverless cache.

" + } + }, + "Description": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

A description of the serverless cache.

" + } + }, + "CreateTime": { + "target": "com.amazonaws.elasticache#TStamp", + "traits": { + "smithy.api#documentation": "

When the serverless cache was created.

" + } + }, + "Status": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The current status of the serverless cache. The allowed values are CREATING, AVAILABLE, DELETING, CREATE-FAILED and MODIFYING.

" + } + }, + "Engine": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The engine the serverless cache is compatible with.

" + } + }, + "MajorEngineVersion": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The version number of the engine the serverless cache is compatible with.

" + } + }, + "FullEngineVersion": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name and version number of the engine the serverless cache is compatible with.

" + } + }, + "CacheUsageLimits": { + "target": "com.amazonaws.elasticache#CacheUsageLimits", + "traits": { + "smithy.api#documentation": "

The cache usage limit for the serverless cache.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt data at rest in the serverless cache.

" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.elasticache#SecurityGroupIdsList", + "traits": { + "smithy.api#documentation": "

The IDs of the EC2 security groups associated with the serverless \n cache.

" + } + }, + "Endpoint": { + "target": "com.amazonaws.elasticache#Endpoint" + }, + "ReaderEndpoint": { + "target": "com.amazonaws.elasticache#Endpoint" + }, + "ARN": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the serverless cache.

" + } + }, + "UserGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The identifier of the user group associated with the serverless cache. Available for Valkey and Redis OSS only. Default is NULL.

" + } + }, + "SubnetIds": { + "target": "com.amazonaws.elasticache#SubnetIdsList", + "traits": { + "smithy.api#documentation": "

If no subnet IDs are given and your VPC is in us-west-1, then ElastiCache will select 2 default subnets across AZs in your VPC. \n For all other Regions, if no subnet IDs are given then ElastiCache will select 3 default subnets across AZs in your default VPC.

" + } + }, + "SnapshotRetentionLimit": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The current setting for the number of serverless cache snapshots the system will retain. Available for Valkey, Redis OSS and Serverless Memcached only.

" + } + }, + "DailySnapshotTime": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The daily time that a cache snapshot will be created. Default is NULL, i.e. snapshots will not be created at a\n specific time on a daily basis. Available for Valkey, Redis OSS and Serverless Memcached only.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The resource representing a serverless cache.

" + } + }, + "com.amazonaws.elasticache#ServerlessCacheAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ServerlessCacheAlreadyExistsFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

A serverless cache with this name already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#ServerlessCacheConfiguration": { + "type": "structure", + "members": { + "ServerlessCacheName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The identifier of a serverless cache.

" + } + }, + "Engine": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The engine that the serverless cache is configured with.

" + } + }, + "MajorEngineVersion": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The engine version number that the serverless cache is configured with.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration settings for a specific serverless cache.

" + } + }, + "com.amazonaws.elasticache#ServerlessCacheList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#ServerlessCache" + } + }, + "com.amazonaws.elasticache#ServerlessCacheNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ServerlessCacheNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The serverless cache was not found or does not exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.elasticache#ServerlessCacheQuotaForCustomerExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ServerlessCacheQuotaForCustomerExceededFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The number of serverless caches exceeds the customer quota.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#ServerlessCacheSnapshot": { + "type": "structure", + "members": { + "ServerlessCacheSnapshotName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The identifier of a serverless cache snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.

" + } + }, + "ARN": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a serverless cache snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services Key Management Service (KMS) key of a serverless cache snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.

" + } + }, + "SnapshotType": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The type of snapshot of serverless cache. Available for Valkey, Redis OSS and Serverless Memcached only.

" + } + }, + "Status": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The current status of the serverless cache. Available for Valkey, Redis OSS and Serverless Memcached only.

" + } + }, + "CreateTime": { + "target": "com.amazonaws.elasticache#TStamp", + "traits": { + "smithy.api#documentation": "

The date and time that the source serverless cache's metadata and cache data set was obtained for\n the snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.

" + } + }, + "ExpiryTime": { + "target": "com.amazonaws.elasticache#TStamp", + "traits": { + "smithy.api#documentation": "

The time that the serverless cache snapshot will expire. Available for Valkey, Redis OSS and Serverless Memcached only.

" + } + }, + "BytesUsedForCache": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The total size of a serverless cache snapshot, in bytes. Available for Valkey, Redis OSS and Serverless Memcached only.

" + } + }, + "ServerlessCacheConfiguration": { + "target": "com.amazonaws.elasticache#ServerlessCacheConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of the serverless cache, at the time the snapshot was taken. Available for Valkey, Redis OSS and Serverless Memcached only.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The resource representing a serverless cache snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.

" + } + }, + "com.amazonaws.elasticache#ServerlessCacheSnapshotAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ServerlessCacheSnapshotAlreadyExistsFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

A serverless cache snapshot with this name already exists. Available for Valkey, Redis OSS and Serverless Memcached only.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#ServerlessCacheSnapshotList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#ServerlessCacheSnapshot", + "traits": { + "smithy.api#xmlName": "ServerlessCacheSnapshot" + } + } + }, + "com.amazonaws.elasticache#ServerlessCacheSnapshotNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ServerlessCacheSnapshotNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

This serverless cache snapshot could not be found or does not exist. Available for Valkey, Redis OSS and Serverless Memcached only.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.elasticache#ServerlessCacheSnapshotQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ServerlessCacheSnapshotQuotaExceededFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The number of serverless cache snapshots exceeds the customer snapshot quota. Available for Valkey, Redis OSS and Serverless Memcached only.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#ServiceLinkedRoleNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ServiceLinkedRoleNotFoundFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The specified service linked role (SLR) was not found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#ServiceUpdate": { + "type": "structure", + "members": { + "ServiceUpdateName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The unique ID of the service update

" + } + }, + "ServiceUpdateReleaseDate": { + "target": "com.amazonaws.elasticache#TStamp", + "traits": { + "smithy.api#documentation": "

The date when the service update is initially available

" + } + }, + "ServiceUpdateEndDate": { + "target": "com.amazonaws.elasticache#TStamp", + "traits": { + "smithy.api#documentation": "

The date after which the service update is no longer available

" + } + }, + "ServiceUpdateSeverity": { + "target": "com.amazonaws.elasticache#ServiceUpdateSeverity", + "traits": { + "smithy.api#documentation": "

The severity of the service update

" + } + }, + "ServiceUpdateRecommendedApplyByDate": { + "target": "com.amazonaws.elasticache#TStamp", + "traits": { + "smithy.api#documentation": "

The recommendend date to apply the service update in order to ensure compliance. For\n information on compliance, see Self-Service Security Updates for Compliance.

" + } + }, + "ServiceUpdateStatus": { + "target": "com.amazonaws.elasticache#ServiceUpdateStatus", + "traits": { + "smithy.api#documentation": "

The status of the service update

" + } + }, + "ServiceUpdateDescription": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

Provides details of the service update

" + } + }, + "ServiceUpdateType": { + "target": "com.amazonaws.elasticache#ServiceUpdateType", + "traits": { + "smithy.api#documentation": "

Reflects the nature of the service update

" + } + }, + "Engine": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The Elasticache engine to which the update applies. Either Valkey, Redis OSS or Memcached.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The Elasticache engine version to which the update applies. Either Valkey, Redis OSS or Memcached\n engine version.

" + } + }, + "AutoUpdateAfterRecommendedApplyByDate": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether the service update will be automatically applied once the\n recommended apply-by date has expired.

" + } + }, + "EstimatedUpdateTime": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The estimated length of time the service update will take

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An update that you can apply to your Valkey or Redis OSS clusters.

" + } + }, + "com.amazonaws.elasticache#ServiceUpdateList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#ServiceUpdate", + "traits": { + "smithy.api#xmlName": "ServiceUpdate" + } + } + }, + "com.amazonaws.elasticache#ServiceUpdateNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ServiceUpdateNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The service update doesn't exist

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.elasticache#ServiceUpdateSeverity": { + "type": "enum", + "members": { + "CRITICAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "critical" + } + }, + "IMPORTANT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "important" + } + }, + "MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "medium" + } + }, + "LOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "low" + } + } + } + }, + "com.amazonaws.elasticache#ServiceUpdateStatus": { + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cancelled" + } + }, + "EXPIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "expired" + } + } + } + }, + "com.amazonaws.elasticache#ServiceUpdateStatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#ServiceUpdateStatus" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3 + } + } + }, + "com.amazonaws.elasticache#ServiceUpdateType": { + "type": "enum", + "members": { + "SECURITY_UPDATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "security-update" + } + } + } + }, + "com.amazonaws.elasticache#ServiceUpdatesMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "ServiceUpdates": { + "target": "com.amazonaws.elasticache#ServiceUpdateList", + "traits": { + "smithy.api#documentation": "

A list of service updates

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#SlaMet": { + "type": "enum", + "members": { + "YES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "yes" + } + }, + "NO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "no" + } + }, + "NA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "n/a" + } + } + } + }, + "com.amazonaws.elasticache#SlotMigration": { + "type": "structure", + "members": { + "ProgressPercentage": { + "target": "com.amazonaws.elasticache#Double", + "traits": { + "smithy.api#documentation": "

The percentage of the slot migration that is complete.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the progress of an online resharding operation.

" + } + }, + "com.amazonaws.elasticache#Snapshot": { + "type": "structure", + "members": { + "SnapshotName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of a snapshot. For an automatic snapshot, the name is system-generated. For a\n manual snapshot, this is the user-provided name.

" + } + }, + "ReplicationGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The unique identifier of the source replication group.

" + } + }, + "ReplicationGroupDescription": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

A description of the source replication group.

" + } + }, + "CacheClusterId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The user-supplied identifier of the source cluster.

" + } + }, + "SnapshotStatus": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The status of the snapshot. Valid values: creating |\n available | restoring | copying |\n deleting.

" + } + }, + "SnapshotSource": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

Indicates whether the snapshot is from an automatic backup (automated) or\n was created manually (manual).

" + } + }, + "CacheNodeType": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the compute and memory capacity node type for the source cluster.

\n

The following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.

\n
    \n
  • \n

    General purpose:

    \n
      \n
    • \n

      Current generation:

      \n

      \n M7g node types:\n \t\t\t\t\tcache.m7g.large,\n \t\t\t\t\tcache.m7g.xlarge,\n \t\t\t\t\tcache.m7g.2xlarge,\n \t\t\t\t\tcache.m7g.4xlarge,\n \t\t\t\t\tcache.m7g.8xlarge,\n \t\t\t\t\tcache.m7g.12xlarge,\n \t\t\t\t\tcache.m7g.16xlarge\n

      \n \n

      For region availability, see Supported Node Types\n

      \n       \n

      \n M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n

      \n

      \n M5 node types:\n cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n

      \n

      \n M4 node types:\n cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n

      \n

      \n T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n

      \n

      \n T3 node types:\n cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n

      \n

      \n T2 node types:\n cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n

      \n
      • \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n T1 node types:\n cache.t1.micro\n

      \n

      \n M1 node types:\n cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n

      \n

      \n M3 node types:\n cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n

      \n
      • \n
    \n
    • \n
  • \n

    Compute optimized:

    \n
      \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n C1 node types:\n cache.c1.xlarge\n

      \n
      • \n
    \n
    • \n
  • \n

    Memory optimized:

    \n
      \n
    • \n

      Current generation:

      \n

      \n R7g node types:\t\n\t\t\t\t\t\t\tcache.r7g.large,\n\t\t\t\t\t\t\tcache.r7g.xlarge,\n\t\t\t\t\t\t\tcache.r7g.2xlarge,\n\t\t\t\t\t\t\tcache.r7g.4xlarge,\n\t\t\t\t\t\t\tcache.r7g.8xlarge,\n\t\t\t\t\t\t\tcache.r7g.12xlarge,\n\t\t\t\t\t\t\tcache.r7g.16xlarge\n

      \n \n

      For region availability, see Supported Node Types\n

      \n       \n

      \n R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t\t\tcache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n

      \n

      \n R5 node types:\n cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n

      \n

      \n R4 node types:\n cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n

      \n
      • \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n M2 node types:\n cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n

      \n

      \n R3 node types:\n cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n

      \n
      • \n
    \n
    • \n
\n

\n Additional node type info\n

\n
    \n
  • \n

    All current generation instance types are created in Amazon VPC by\n default.

    \n
    • \n
  • \n

    Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.

    \n
    • \n
  • \n

    Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1\n instances.

    \n
    • \n
  • \n

    The configuration variables appendonly and\n appendfsync are not supported on Valkey, or on Redis OSS version 2.8.22 and\n later.

    \n
    • \n
" + } + }, + "Engine": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the cache engine (memcached or redis) used by\n the source cluster.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The version of the cache engine version that is used by the source cluster.

" + } + }, + "NumCacheNodes": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of cache nodes in the source cluster.

\n

For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this\n value must be between 1 and 40.

" + } + }, + "PreferredAvailabilityZone": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the Availability Zone in which the source cluster is located.

" + } + }, + "PreferredOutpostArn": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The ARN (Amazon Resource Name) of the preferred outpost.

" + } + }, + "CacheClusterCreateTime": { + "target": "com.amazonaws.elasticache#TStamp", + "traits": { + "smithy.api#documentation": "

The date and time when the source cluster was created.

" + } + }, + "PreferredMaintenanceWindow": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

Specifies the weekly time range during which maintenance on the cluster is performed.\n It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The\n minimum maintenance window is a 60 minute period.

\n

Valid values for ddd are:

\n
    \n
  • \n

    \n sun\n

    \n
    • \n
  • \n

    \n mon\n

    \n
    • \n
  • \n

    \n tue\n

    \n
    • \n
  • \n

    \n wed\n

    \n
    • \n
  • \n

    \n thu\n

    \n
    • \n
  • \n

    \n fri\n

    \n
    • \n
  • \n

    \n sat\n

    \n
    • \n
\n

Example: sun:23:00-mon:01:30\n

" + } + }, + "TopicArn": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing\n notifications.

" + } + }, + "Port": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port number used by each cache nodes in the source cluster.

" + } + }, + "CacheParameterGroupName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The cache parameter group that is associated with the source cluster.

" + } + }, + "CacheSubnetGroupName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the cache subnet group associated with the source cluster.

" + } + }, + "VpcId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the\n source cluster.

" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.elasticache#Boolean", + "traits": { + "smithy.api#documentation": "

 If you are running Valkey 7.2 and above or Redis OSS engine version 6.0 and above, set this parameter to yes if\n you want to opt-in to the next auto minor version upgrade campaign. This parameter is\n disabled for previous versions. 

" + } + }, + "SnapshotRetentionLimit": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

For an automatic snapshot, the number of days for which ElastiCache retains the\n snapshot before deleting it.

\n

For manual snapshots, this field reflects the SnapshotRetentionLimit for\n the source cluster when the snapshot was created. This field is otherwise ignored:\n Manual snapshots do not expire, and can only be deleted using the\n DeleteSnapshot operation.

\n

\n Important If the value of SnapshotRetentionLimit is set\n to zero (0), backups are turned off.

" + } + }, + "SnapshotWindow": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The daily time range during which ElastiCache takes daily snapshots of the source\n cluster.

" + } + }, + "NumNodeGroups": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of node groups (shards) in this snapshot. When restoring from a snapshot,\n the number of node groups (shards) in the snapshot and in the restored replication group\n must be the same.

" + } + }, + "AutomaticFailover": { + "target": "com.amazonaws.elasticache#AutomaticFailoverStatus", + "traits": { + "smithy.api#documentation": "

Indicates the status of automatic failover for the source Valkey or Redis OSS replication\n group.

" + } + }, + "NodeSnapshots": { + "target": "com.amazonaws.elasticache#NodeSnapshotList", + "traits": { + "smithy.api#documentation": "

A list of the cache nodes in the source cluster.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The ID of the KMS key used to encrypt the snapshot.

" + } + }, + "ARN": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The ARN (Amazon Resource Name) of the snapshot.

" + } + }, + "DataTiering": { + "target": "com.amazonaws.elasticache#DataTieringStatus", + "traits": { + "smithy.api#documentation": "

Enables data tiering. Data tiering is only supported for replication groups using the\n r6gd node type. This parameter must be set to true when using r6gd nodes. For more\n information, see Data tiering.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a copy of an entire Valkey or Redis OSS cluster as of the time when the snapshot was\n taken.

" + } + }, + "com.amazonaws.elasticache#SnapshotAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SnapshotAlreadyExistsFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

You already have a snapshot with the given name.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#SnapshotArnsList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#xmlName": "SnapshotArn" + } + } + }, + "com.amazonaws.elasticache#SnapshotFeatureNotSupportedFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SnapshotFeatureNotSupportedFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

You attempted one of the following operations:

\n
    \n
  • \n

    Creating a snapshot of a Valkey or Redis OSS cluster running on a\n cache.t1.micro cache node.

    \n
    • \n
  • \n

    Creating a snapshot of a cluster that is running Memcached rather than\n Valkey or Redis OSS.

    \n
    • \n
\n

Neither of these are supported by ElastiCache.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#SnapshotList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#Snapshot", + "traits": { + "smithy.api#xmlName": "Snapshot" + } + } + }, + "com.amazonaws.elasticache#SnapshotNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SnapshotNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The requested snapshot name does not refer to an existing snapshot.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.elasticache#SnapshotQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SnapshotQuotaExceededFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request cannot be processed because it would exceed the maximum number of\n snapshots.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#SourceType": { + "type": "enum", + "members": { + "cache_cluster": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cache-cluster" + } + }, + "cache_parameter_group": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cache-parameter-group" + } + }, + "cache_security_group": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cache-security-group" + } + }, + "cache_subnet_group": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cache-subnet-group" + } + }, + "replication_group": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "replication-group" + } + }, + "serverless_cache": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "serverless-cache" + } + }, + "serverless_cache_snapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "serverless-cache-snapshot" + } + }, + "user": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "user" + } + }, + "user_group": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "user-group" + } + } + } + }, + "com.amazonaws.elasticache#StartMigration": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#StartMigrationMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#StartMigrationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#InvalidReplicationGroupStateFault" + }, + { + "target": "com.amazonaws.elasticache#ReplicationGroupAlreadyUnderMigrationFault" + }, + { + "target": "com.amazonaws.elasticache#ReplicationGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Start the migration of data.

" + } + }, + "com.amazonaws.elasticache#StartMigrationMessage": { + "type": "structure", + "members": { + "ReplicationGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the replication group to which data should be migrated.

", + "smithy.api#required": {} + } + }, + "CustomerNodeEndpointList": { + "target": "com.amazonaws.elasticache#CustomerNodeEndpointList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

List of endpoints from which data should be migrated. For Valkey or Redis OSS (cluster mode\n disabled), the list should have only one element.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#StartMigrationResponse": { + "type": "structure", + "members": { + "ReplicationGroup": { + "target": "com.amazonaws.elasticache#ReplicationGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#String": { + "type": "string" + }, + "com.amazonaws.elasticache#Subnet": { + "type": "structure", + "members": { + "SubnetIdentifier": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The unique identifier for the subnet.

" + } + }, + "SubnetAvailabilityZone": { + "target": "com.amazonaws.elasticache#AvailabilityZone", + "traits": { + "smithy.api#documentation": "

The Availability Zone associated with the subnet.

" + } + }, + "SubnetOutpost": { + "target": "com.amazonaws.elasticache#SubnetOutpost", + "traits": { + "smithy.api#documentation": "

The outpost ARN of the subnet.

" + } + }, + "SupportedNetworkTypes": { + "target": "com.amazonaws.elasticache#NetworkTypeList", + "traits": { + "smithy.api#documentation": "

Either ipv4 | ipv6 | dual_stack. IPv6 is\n supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2\n and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the subnet associated with a cluster. This parameter refers to subnets\n defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.

" + } + }, + "com.amazonaws.elasticache#SubnetIdentifierList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#xmlName": "SubnetIdentifier" + } + } + }, + "com.amazonaws.elasticache#SubnetIdsList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#xmlName": "SubnetId" + } + } + }, + "com.amazonaws.elasticache#SubnetInUse": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SubnetInUse", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The requested subnet is being used by another cache subnet group.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#SubnetList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#Subnet", + "traits": { + "smithy.api#xmlName": "Subnet" + } + } + }, + "com.amazonaws.elasticache#SubnetNotAllowedFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SubnetNotAllowedFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

At least one subnet ID does not match the other subnet IDs. This mismatch typically\n occurs when a user sets one subnet ID to a regional Availability Zone and a different\n one to an outpost. Or when a user sets the subnet ID to an Outpost when not subscribed\n on this service.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#SubnetOutpost": { + "type": "structure", + "members": { + "SubnetOutpostArn": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The outpost ARN of the subnet.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The ID of the outpost subnet.

" + } + }, + "com.amazonaws.elasticache#TStamp": { + "type": "timestamp" + }, + "com.amazonaws.elasticache#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The key for the tag. May not be null.

" + } + }, + "Value": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The tag's value. May be null.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A tag that can be added to an ElastiCache cluster or replication group. Tags are\n composed of a Key/Value pair. You can use tags to categorize and track all your\n ElastiCache resources, with the exception of global replication group. When you add or\n remove tags on replication groups, those actions will be replicated to all nodes in the\n replication group. A tag with a null Value is permitted.

" + } + }, + "com.amazonaws.elasticache#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#Tag", + "traits": { + "smithy.api#xmlName": "Tag" + } + } + }, + "com.amazonaws.elasticache#TagListMessage": { + "type": "structure", + "members": { + "TagList": { + "target": "com.amazonaws.elasticache#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags as key-value pairs.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output from the AddTagsToResource,\n ListTagsForResource, and RemoveTagsFromResource\n operations.

" + } + }, + "com.amazonaws.elasticache#TagNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "TagNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The requested tag was not found on this resource.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.elasticache#TagQuotaPerResourceExceeded": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "TagQuotaPerResourceExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request cannot be processed because it would cause the resource to have more than\n the allowed number of tags. The maximum number of tags permitted on a resource is\n 50.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#TestFailover": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#TestFailoverMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#TestFailoverResult" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#APICallRateForCustomerExceededFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidCacheClusterStateFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidKMSKeyFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#InvalidReplicationGroupStateFault" + }, + { + "target": "com.amazonaws.elasticache#NodeGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#ReplicationGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#TestFailoverNotAvailableFault" + } + ], + "traits": { + "smithy.api#documentation": "

Represents the input of a TestFailover operation which tests automatic\n failover on a specified node group (called shard in the console) in a replication group\n (called cluster in the console).

\n

This API is designed for testing the behavior of your application in case of\n ElastiCache failover. It is not designed to be an operational tool for initiating a\n failover to overcome a problem you may have with the cluster. Moreover, in certain\n conditions such as large-scale operational events, Amazon may block this API.

\n

\n Note the following\n

\n
    \n
  • \n

    A customer can use this operation to test automatic failover on up to 15 shards\n (called node groups in the ElastiCache API and Amazon CLI) in any rolling\n 24-hour period.

    \n
    • \n
  • \n

    If calling this operation on shards in different clusters (called replication\n groups in the API and CLI), the calls can be made concurrently.

    \n

    \n
    • \n
  • \n

    If calling this operation multiple times on different shards in the same Valkey or Redis OSS (cluster mode enabled) replication group, the first node replacement must\n complete before a subsequent call can be made.

    \n
    • \n
  • \n

    To determine whether the node replacement is complete you can check Events\n using the Amazon ElastiCache console, the Amazon CLI, or the ElastiCache API.\n Look for the following automatic failover related events, listed here in order\n of occurrance:

    \n
      \n
    1. \n

      Replication group message: Test Failover API called for node\n group \n

      \n
      2. \n
    2. \n

      Cache cluster message: Failover from primary node\n to replica node \n completed\n

      \n
      3. \n
    3. \n

      Replication group message: Failover from primary node\n to replica node \n completed\n

      \n
      4. \n
    4. \n

      Cache cluster message: Recovering cache nodes\n \n

      \n
      5. \n
    5. \n

      Cache cluster message: Finished recovery for cache nodes\n \n

      \n
      6. \n
    \n

    For more information see:

    \n \n
    • \n
\n

Also see, Testing\n Multi-AZ in the ElastiCache User Guide.

" + } + }, + "com.amazonaws.elasticache#TestFailoverMessage": { + "type": "structure", + "members": { + "ReplicationGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the replication group (console: cluster) whose automatic failover is being\n tested by this operation.

", + "smithy.api#required": {} + } + }, + "NodeGroupId": { + "target": "com.amazonaws.elasticache#AllowedNodeGroupId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the node group (called shard in the console) in this replication group on\n which automatic failover is to be tested. You may test automatic failover on up to 15\n node groups in any rolling 24-hour period.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#TestFailoverNotAvailableFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "TestFailoverNotAvailableFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The TestFailover action is not available.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#TestFailoverResult": { + "type": "structure", + "members": { + "ReplicationGroup": { + "target": "com.amazonaws.elasticache#ReplicationGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#TestMigration": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#TestMigrationMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#TestMigrationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#InvalidReplicationGroupStateFault" + }, + { + "target": "com.amazonaws.elasticache#ReplicationGroupAlreadyUnderMigrationFault" + }, + { + "target": "com.amazonaws.elasticache#ReplicationGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Async API to test connection between source and target replication group.

" + } + }, + "com.amazonaws.elasticache#TestMigrationMessage": { + "type": "structure", + "members": { + "ReplicationGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the replication group to which data is to be migrated.

", + "smithy.api#required": {} + } + }, + "CustomerNodeEndpointList": { + "target": "com.amazonaws.elasticache#CustomerNodeEndpointList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

List of endpoints from which data should be migrated. List should have only one\n element.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticache#TestMigrationResponse": { + "type": "structure", + "members": { + "ReplicationGroup": { + "target": "com.amazonaws.elasticache#ReplicationGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#TimeRangeFilter": { + "type": "structure", + "members": { + "StartTime": { + "target": "com.amazonaws.elasticache#TStamp", + "traits": { + "smithy.api#documentation": "

The start time of the time range filter

" + } + }, + "EndTime": { + "target": "com.amazonaws.elasticache#TStamp", + "traits": { + "smithy.api#documentation": "

The end time of the time range filter

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Filters update actions from the service updates that are in available status during\n the time range.

" + } + }, + "com.amazonaws.elasticache#TransitEncryptionMode": { + "type": "enum", + "members": { + "PREFERRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "preferred" + } + }, + "REQUIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "required" + } + } + } + }, + "com.amazonaws.elasticache#UGReplicationGroupIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#String" + } + }, + "com.amazonaws.elasticache#UGServerlessCacheIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#String" + } + }, + "com.amazonaws.elasticache#UnprocessedUpdateAction": { + "type": "structure", + "members": { + "ReplicationGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The replication group ID

" + } + }, + "CacheClusterId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The ID of the cache cluster

" + } + }, + "ServiceUpdateName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The unique ID of the service update

" + } + }, + "ErrorType": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The error type for requests that are not processed

" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The error message that describes the reason the request was not processed

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Update action that has failed to be processed for the corresponding apply/stop\n request

" + } + }, + "com.amazonaws.elasticache#UnprocessedUpdateActionList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#UnprocessedUpdateAction", + "traits": { + "smithy.api#xmlName": "UnprocessedUpdateAction" + } + } + }, + "com.amazonaws.elasticache#UpdateAction": { + "type": "structure", + "members": { + "ReplicationGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The ID of the replication group

" + } + }, + "CacheClusterId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The ID of the cache cluster

" + } + }, + "ServiceUpdateName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The unique ID of the service update

" + } + }, + "ServiceUpdateReleaseDate": { + "target": "com.amazonaws.elasticache#TStamp", + "traits": { + "smithy.api#documentation": "

The date the update is first available

" + } + }, + "ServiceUpdateSeverity": { + "target": "com.amazonaws.elasticache#ServiceUpdateSeverity", + "traits": { + "smithy.api#documentation": "

The severity of the service update

" + } + }, + "ServiceUpdateStatus": { + "target": "com.amazonaws.elasticache#ServiceUpdateStatus", + "traits": { + "smithy.api#documentation": "

The status of the service update

" + } + }, + "ServiceUpdateRecommendedApplyByDate": { + "target": "com.amazonaws.elasticache#TStamp", + "traits": { + "smithy.api#documentation": "

The recommended date to apply the service update to ensure compliance. For information\n on compliance, see Self-Service Security Updates for Compliance.

" + } + }, + "ServiceUpdateType": { + "target": "com.amazonaws.elasticache#ServiceUpdateType", + "traits": { + "smithy.api#documentation": "

Reflects the nature of the service update

" + } + }, + "UpdateActionAvailableDate": { + "target": "com.amazonaws.elasticache#TStamp", + "traits": { + "smithy.api#documentation": "

The date that the service update is available to a replication group

" + } + }, + "UpdateActionStatus": { + "target": "com.amazonaws.elasticache#UpdateActionStatus", + "traits": { + "smithy.api#documentation": "

The status of the update action

" + } + }, + "NodesUpdated": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The progress of the service update on the replication group

" + } + }, + "UpdateActionStatusModifiedDate": { + "target": "com.amazonaws.elasticache#TStamp", + "traits": { + "smithy.api#documentation": "

The date when the UpdateActionStatus was last modified

" + } + }, + "SlaMet": { + "target": "com.amazonaws.elasticache#SlaMet", + "traits": { + "smithy.api#documentation": "

If yes, all nodes in the replication group have been updated by the recommended\n apply-by date. If no, at least one node in the replication group have not been updated\n by the recommended apply-by date. If N/A, the replication group was created after the\n recommended apply-by date.

" + } + }, + "NodeGroupUpdateStatus": { + "target": "com.amazonaws.elasticache#NodeGroupUpdateStatusList", + "traits": { + "smithy.api#documentation": "

The status of the service update on the node group

" + } + }, + "CacheNodeUpdateStatus": { + "target": "com.amazonaws.elasticache#CacheNodeUpdateStatusList", + "traits": { + "smithy.api#documentation": "

The status of the service update on the cache node

" + } + }, + "EstimatedUpdateTime": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The estimated length of time for the update to complete

" + } + }, + "Engine": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The Elasticache engine to which the update applies. Either Valkey, Redis OSS or Memcached.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The status of the service update for a specific replication group

" + } + }, + "com.amazonaws.elasticache#UpdateActionList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#UpdateAction", + "traits": { + "smithy.api#xmlName": "UpdateAction" + } + } + }, + "com.amazonaws.elasticache#UpdateActionResultsMessage": { + "type": "structure", + "members": { + "ProcessedUpdateActions": { + "target": "com.amazonaws.elasticache#ProcessedUpdateActionList", + "traits": { + "smithy.api#documentation": "

Update actions that have been processed successfully

" + } + }, + "UnprocessedUpdateActions": { + "target": "com.amazonaws.elasticache#UnprocessedUpdateActionList", + "traits": { + "smithy.api#documentation": "

Update actions that haven't been processed successfully

" + } + } + } + }, + "com.amazonaws.elasticache#UpdateActionStatus": { + "type": "enum", + "members": { + "NOT_APPLIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "not-applied" + } + }, + "WAITING_TO_START": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "waiting-to-start" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "in-progress" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "stopping" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "stopped" + } + }, + "COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "complete" + } + }, + "SCHEDULING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scheduling" + } + }, + "SCHEDULED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scheduled" + } + }, + "NOT_APPLICABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "not-applicable" + } + } + } + }, + "com.amazonaws.elasticache#UpdateActionStatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#UpdateActionStatus" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 9 + } + } + }, + "com.amazonaws.elasticache#UpdateActionsMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "UpdateActions": { + "target": "com.amazonaws.elasticache#UpdateActionList", + "traits": { + "smithy.api#documentation": "

Returns a list of update actions

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#User": { + "type": "structure", + "members": { + "UserId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The ID of the user.

" + } + }, + "UserName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The username of the user.

" + } + }, + "Status": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

Indicates the user status. Can be \"active\", \"modifying\" or \"deleting\".

" + } + }, + "Engine": { + "target": "com.amazonaws.elasticache#EngineType", + "traits": { + "smithy.api#documentation": "

The current supported value is Redis.

" + } + }, + "MinimumEngineVersion": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The minimum engine version required, which is Redis OSS 6.0

" + } + }, + "AccessString": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

Access permissions string used for this user.

" + } + }, + "UserGroupIds": { + "target": "com.amazonaws.elasticache#UserGroupIdList", + "traits": { + "smithy.api#documentation": "

Returns a list of the user group IDs the user belongs to.

" + } + }, + "Authentication": { + "target": "com.amazonaws.elasticache#Authentication", + "traits": { + "smithy.api#documentation": "

Denotes whether the user requires a password to authenticate.

" + } + }, + "ARN": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user.

" + } + } + } + }, + "com.amazonaws.elasticache#UserAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "UserAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

A user with this ID already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#UserGroup": { + "type": "structure", + "members": { + "UserGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The ID of the user group.

" + } + }, + "Status": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

Indicates user group status. Can be \"creating\", \"active\", \"modifying\",\n \"deleting\".

" + } + }, + "Engine": { + "target": "com.amazonaws.elasticache#EngineType", + "traits": { + "smithy.api#documentation": "

The current supported value is Redis user.

" + } + }, + "UserIds": { + "target": "com.amazonaws.elasticache#UserIdList", + "traits": { + "smithy.api#documentation": "

The list of user IDs that belong to the user group.

" + } + }, + "MinimumEngineVersion": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The minimum engine version required, which is Redis OSS 6.0

" + } + }, + "PendingChanges": { + "target": "com.amazonaws.elasticache#UserGroupPendingChanges", + "traits": { + "smithy.api#documentation": "

A list of updates being applied to the user group.

" + } + }, + "ReplicationGroups": { + "target": "com.amazonaws.elasticache#UGReplicationGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of replication groups that the user group can access.

" + } + }, + "ServerlessCaches": { + "target": "com.amazonaws.elasticache#UGServerlessCacheIdList", + "traits": { + "smithy.api#documentation": "

Indicates which serverless caches the specified user group is associated with. Available for Valkey, Redis OSS and Serverless Memcached only.

" + } + }, + "ARN": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user group.

" + } + } + } + }, + "com.amazonaws.elasticache#UserGroupAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "UserGroupAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The user group with this ID already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#UserGroupId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9\\-]*$" + } + }, + "com.amazonaws.elasticache#UserGroupIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#UserGroupId" + } + }, + "com.amazonaws.elasticache#UserGroupIdListInput": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#UserGroupId" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.elasticache#UserGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#UserGroup" + } + }, + "com.amazonaws.elasticache#UserGroupNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "UserGroupNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The user group was not found or does not exist

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.elasticache#UserGroupPendingChanges": { + "type": "structure", + "members": { + "UserIdsToRemove": { + "target": "com.amazonaws.elasticache#UserIdList", + "traits": { + "smithy.api#documentation": "

The list of user IDs to remove.

" + } + }, + "UserIdsToAdd": { + "target": "com.amazonaws.elasticache#UserIdList", + "traits": { + "smithy.api#documentation": "

The list of user IDs to add.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Returns the updates being applied to the user group.

" + } + }, + "com.amazonaws.elasticache#UserGroupQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "UserGroupQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The number of users exceeds the user group limit.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#UserGroupsUpdateStatus": { + "type": "structure", + "members": { + "UserGroupIdsToAdd": { + "target": "com.amazonaws.elasticache#UserGroupIdList", + "traits": { + "smithy.api#documentation": "

The ID of the user group to add.

" + } + }, + "UserGroupIdsToRemove": { + "target": "com.amazonaws.elasticache#UserGroupIdList", + "traits": { + "smithy.api#documentation": "

The ID of the user group to remove.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The status of the user group update.

" + } + }, + "com.amazonaws.elasticache#UserId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9\\-]*$" + } + }, + "com.amazonaws.elasticache#UserIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#UserId" + } + }, + "com.amazonaws.elasticache#UserIdListInput": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#UserId" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.elasticache#UserList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#User" + } + }, + "com.amazonaws.elasticache#UserName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.elasticache#UserNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "UserNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The user does not exist or could not be found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.elasticache#UserQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "UserQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The quota of users has been exceeded.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + } + } +} \ No newline at end of file diff --git a/pkg/testdata/codegen/sdk-codegen/aws-models/emrcontainers.json b/pkg/testdata/codegen/sdk-codegen/aws-models/emrcontainers.json new file mode 100644 index 00000000..7b1f8818 --- /dev/null +++ b/pkg/testdata/codegen/sdk-codegen/aws-models/emrcontainers.json @@ -0,0 +1,4853 @@ +{ + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.emrcontainers#ACMCertArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 44, + "max": 2048 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):acm:.+:(\\d{12}):certificate/.+$" + } + }, + "com.amazonaws.emrcontainers#AuthorizationConfiguration": { + "type": "structure", + "members": { + "lakeFormationConfiguration": { + "target": "com.amazonaws.emrcontainers#LakeFormationConfiguration", + "traits": { + "smithy.api#documentation": "

Lake Formation related configuration inputs for the security\n configuration.

" + } + }, + "encryptionConfiguration": { + "target": "com.amazonaws.emrcontainers#EncryptionConfiguration", + "traits": { + "smithy.api#documentation": "

Encryption-related configuration input for the security configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Authorization-related configuration inputs for the security configuration.

" + } + }, + "com.amazonaws.emrcontainers#AwsChicagoWebService": { + "type": "service", + "version": "2020-10-01", + "operations": [ + { + "target": "com.amazonaws.emrcontainers#CancelJobRun" + }, + { + "target": "com.amazonaws.emrcontainers#CreateJobTemplate" + }, + { + "target": "com.amazonaws.emrcontainers#CreateManagedEndpoint" + }, + { + "target": "com.amazonaws.emrcontainers#CreateSecurityConfiguration" + }, + { + "target": "com.amazonaws.emrcontainers#CreateVirtualCluster" + }, + { + "target": "com.amazonaws.emrcontainers#DeleteJobTemplate" + }, + { + "target": "com.amazonaws.emrcontainers#DeleteManagedEndpoint" + }, + { + "target": "com.amazonaws.emrcontainers#DeleteVirtualCluster" + }, + { + "target": "com.amazonaws.emrcontainers#DescribeJobRun" + }, + { + "target": "com.amazonaws.emrcontainers#DescribeJobTemplate" + }, + { + "target": "com.amazonaws.emrcontainers#DescribeManagedEndpoint" + }, + { + "target": "com.amazonaws.emrcontainers#DescribeSecurityConfiguration" + }, + { + "target": "com.amazonaws.emrcontainers#DescribeVirtualCluster" + }, + { + "target": "com.amazonaws.emrcontainers#GetManagedEndpointSessionCredentials" + }, + { + "target": "com.amazonaws.emrcontainers#ListJobRuns" + }, + { + "target": "com.amazonaws.emrcontainers#ListJobTemplates" + }, + { + "target": "com.amazonaws.emrcontainers#ListManagedEndpoints" + }, + { + "target": "com.amazonaws.emrcontainers#ListSecurityConfigurations" + }, + { + "target": "com.amazonaws.emrcontainers#ListTagsForResource" + }, + { + "target": "com.amazonaws.emrcontainers#ListVirtualClusters" + }, + { + "target": "com.amazonaws.emrcontainers#StartJobRun" + }, + { + "target": "com.amazonaws.emrcontainers#TagResource" + }, + { + "target": "com.amazonaws.emrcontainers#UntagResource" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "EMR containers", + "arnNamespace": "emr-containers", + "cloudFormationName": "EMRcontainers", + "cloudTrailEventSource": "emrcontainers.amazonaws.com", + "endpointPrefix": "emr-containers" + }, + "aws.auth#sigv4": { + "name": "emr-containers" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

Amazon EMR on EKS provides a deployment option for Amazon EMR that allows\n you to run open-source big data frameworks on Amazon Elastic Kubernetes Service (Amazon EKS).\n With this deployment option, you can focus on running analytics workloads while Amazon EMR on EKS builds, configures, and manages containers for open-source applications.\n For more information about Amazon EMR on EKS concepts and tasks, see What is\n Amazon EMR on EKS.

\n

\n Amazon EMR containers is the API name for Amazon EMR on EKS. The emr-containers prefix is used in the following\n scenarios:

\n
    \n
  • \n

    It is the prefix in the CLI commands for Amazon EMR on EKS. For example,\n aws emr-containers start-job-run.

    \n
    • \n
  • \n

    It is the prefix before IAM policy actions for Amazon EMR on EKS. For\n example, \"Action\": [ \"emr-containers:StartJobRun\"]. For more\n information, see Policy actions for Amazon EMR on EKS.

    \n
    • \n
  • \n

    It is the prefix used in Amazon EMR on EKS service endpoints. For example,\n emr-containers.us-east-2.amazonaws.com. For more information, see\n Amazon EMR on EKSService Endpoints.

    \n
    • \n
", + "smithy.api#title": "Amazon EMR Containers", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://emr-containers-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-gov-east-1" + ] + } + ], + "endpoint": { + "url": "https://emr-containers.us-gov-east-1.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-gov-west-1" + ] + } + ], + "endpoint": { + "url": "https://emr-containers.us-gov-west-1.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://emr-containers-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://emr-containers.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://emr-containers.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-containers.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-containers.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-containers.ap-south-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-containers.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-containers.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-containers.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-containers-fips.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-containers.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-containers.eu-north-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-containers.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-containers.eu-west-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-containers.eu-west-3.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-containers.sa-east-1.amazonaws.com" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-containers.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-containers-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-containers.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-containers-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-containers.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-containers-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-containers.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-containers-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-containers-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-containers.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-containers.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-containers.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-containers-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-containers-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-containers.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-containers.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-containers.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-containers.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-containers.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-containers-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-containers.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-containers-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-containers.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-containers-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-containers.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.emrcontainers#Base64Encoded": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5000 + }, + "smithy.api#pattern": "^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{4}|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$" + } + }, + "com.amazonaws.emrcontainers#Boolean": { + "type": "boolean" + }, + "com.amazonaws.emrcontainers#CancelJobRun": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#CancelJobRunRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#CancelJobRunResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Cancels a job run. A job run is a unit of work, such as a Spark jar, PySpark script, or\n SparkSQL query, that you submit to Amazon EMR on EKS.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/virtualclusters/{virtualClusterId}/jobruns/{id}", + "code": 200 + } + } + }, + "com.amazonaws.emrcontainers#CancelJobRunRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the job run to cancel.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "virtualClusterId": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the virtual cluster for which the job run will be canceled.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#CancelJobRunResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The output contains the ID of the cancelled job run.

" + } + }, + "virtualClusterId": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The output contains the virtual cluster ID for which the job run is cancelled.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.emrcontainers#Certificate": { + "type": "structure", + "members": { + "certificateArn": { + "target": "com.amazonaws.emrcontainers#ACMCertArn", + "traits": { + "smithy.api#documentation": "

The ARN of the certificate generated for managed endpoint.

" + } + }, + "certificateData": { + "target": "com.amazonaws.emrcontainers#Base64Encoded", + "traits": { + "smithy.api#documentation": "

The base64 encoded PEM certificate data generated for managed endpoint.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The entity representing certificate data generated for managed endpoint.

" + } + }, + "com.amazonaws.emrcontainers#CertificateProviderType": { + "type": "enum", + "members": { + "PEM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PEM" + } + } + } + }, + "com.amazonaws.emrcontainers#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.emrcontainers#CloudWatchMonitoringConfiguration": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.emrcontainers#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group for log publishing.

", + "smithy.api#required": {} + } + }, + "logStreamNamePrefix": { + "target": "com.amazonaws.emrcontainers#String256", + "traits": { + "smithy.api#documentation": "

The specified name prefix for log streams.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A configuration for CloudWatch monitoring. You can configure your jobs to send log\n information to CloudWatch Logs.

" + } + }, + "com.amazonaws.emrcontainers#ClusterId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[0-9A-Za-z][A-Za-z0-9\\-_]*$" + } + }, + "com.amazonaws.emrcontainers#Configuration": { + "type": "structure", + "members": { + "classification": { + "target": "com.amazonaws.emrcontainers#String1024", + "traits": { + "smithy.api#documentation": "

The classification within a configuration.

", + "smithy.api#required": {} + } + }, + "properties": { + "target": "com.amazonaws.emrcontainers#SensitivePropertiesMap", + "traits": { + "smithy.api#documentation": "

A set of properties specified within a configuration classification.

" + } + }, + "configurations": { + "target": "com.amazonaws.emrcontainers#ConfigurationList", + "traits": { + "smithy.api#documentation": "

A list of additional configurations to apply within a configuration object.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A configuration specification to be used when provisioning virtual clusters, which can\n include configurations for applications and software bundled with Amazon EMR on EKS. A\n configuration consists of a classification, properties, and optional nested configurations.\n A classification refers to an application-specific configuration file. Properties are the\n settings you want to change in that file.

" + } + }, + "com.amazonaws.emrcontainers#ConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.emrcontainers#Configuration" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.emrcontainers#ConfigurationOverrides": { + "type": "structure", + "members": { + "applicationConfiguration": { + "target": "com.amazonaws.emrcontainers#ConfigurationList", + "traits": { + "smithy.api#documentation": "

The configurations for the application running by the job run.

" + } + }, + "monitoringConfiguration": { + "target": "com.amazonaws.emrcontainers#MonitoringConfiguration", + "traits": { + "smithy.api#documentation": "

The configurations for monitoring.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A configuration specification to be used to override existing configurations.

" + } + }, + "com.amazonaws.emrcontainers#ContainerInfo": { + "type": "union", + "members": { + "eksInfo": { + "target": "com.amazonaws.emrcontainers#EksInfo", + "traits": { + "smithy.api#documentation": "

The information about the Amazon EKS cluster.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The information about the container used for a job run or a managed endpoint.

" + } + }, + "com.amazonaws.emrcontainers#ContainerLogRotationConfiguration": { + "type": "structure", + "members": { + "rotationSize": { + "target": "com.amazonaws.emrcontainers#RotationSize", + "traits": { + "smithy.api#documentation": "

The file size at which to rotate logs. Minimum of 2KB, Maximum of 2GB.

", + "smithy.api#required": {} + } + }, + "maxFilesToKeep": { + "target": "com.amazonaws.emrcontainers#MaxFilesToKeep", + "traits": { + "smithy.api#documentation": "

The number of files to keep in container after rotation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The settings for container log rotation.

" + } + }, + "com.amazonaws.emrcontainers#ContainerProvider": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.emrcontainers#ContainerProviderType", + "traits": { + "smithy.api#documentation": "

The type of the container provider. Amazon EKS is the only supported type as of\n now.

", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.emrcontainers#ClusterId", + "traits": { + "smithy.api#documentation": "

The ID of the container cluster.

", + "smithy.api#required": {} + } + }, + "info": { + "target": "com.amazonaws.emrcontainers#ContainerInfo", + "traits": { + "smithy.api#documentation": "

The information about the container cluster.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The information about the container provider.

" + } + }, + "com.amazonaws.emrcontainers#ContainerProviderType": { + "type": "enum", + "members": { + "EKS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EKS" + } + } + } + }, + "com.amazonaws.emrcontainers#CreateJobTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#CreateJobTemplateRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#CreateJobTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a job template. Job template stores values of StartJobRun API request in a\n template and can be used to start a job run. Job template allows two use cases: avoid\n repeating recurring StartJobRun API request values, enforcing certain values in StartJobRun\n API request.

", + "smithy.api#http": { + "method": "POST", + "uri": "/jobtemplates", + "code": 200 + } + } + }, + "com.amazonaws.emrcontainers#CreateJobTemplateRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.emrcontainers#ResourceNameString", + "traits": { + "smithy.api#documentation": "

The specified name of the job template.

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.emrcontainers#ClientToken", + "traits": { + "smithy.api#documentation": "

The client token of the job template.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "jobTemplateData": { + "target": "com.amazonaws.emrcontainers#JobTemplateData", + "traits": { + "smithy.api#documentation": "

The job template data which holds values of StartJobRun API request.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.emrcontainers#TagMap", + "traits": { + "smithy.api#documentation": "

The tags that are associated with the job template.

" + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.emrcontainers#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The KMS key ARN used to encrypt the job template.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#CreateJobTemplateResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

This output display the created job template ID.

" + } + }, + "name": { + "target": "com.amazonaws.emrcontainers#ResourceNameString", + "traits": { + "smithy.api#documentation": "

This output displays the name of the created job template.

" + } + }, + "arn": { + "target": "com.amazonaws.emrcontainers#JobTemplateArn", + "traits": { + "smithy.api#documentation": "

This output display the ARN of the created job template.

" + } + }, + "createdAt": { + "target": "com.amazonaws.emrcontainers#Date", + "traits": { + "smithy.api#documentation": "

This output displays the date and time when the job template was created.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.emrcontainers#CreateManagedEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#CreateManagedEndpointRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#CreateManagedEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a managed endpoint. A managed endpoint is a gateway that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can\n communicate with your virtual cluster.

", + "smithy.api#http": { + "method": "POST", + "uri": "/virtualclusters/{virtualClusterId}/endpoints", + "code": 200 + } + } + }, + "com.amazonaws.emrcontainers#CreateManagedEndpointRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.emrcontainers#ResourceNameString", + "traits": { + "smithy.api#documentation": "

The name of the managed endpoint.

", + "smithy.api#required": {} + } + }, + "virtualClusterId": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the virtual cluster for which a managed endpoint is created.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.emrcontainers#EndpointType", + "traits": { + "smithy.api#documentation": "

The type of the managed endpoint.

", + "smithy.api#required": {} + } + }, + "releaseLabel": { + "target": "com.amazonaws.emrcontainers#ReleaseLabel", + "traits": { + "smithy.api#documentation": "

The Amazon EMR release version.

", + "smithy.api#required": {} + } + }, + "executionRoleArn": { + "target": "com.amazonaws.emrcontainers#IAMRoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of the execution role.

", + "smithy.api#required": {} + } + }, + "certificateArn": { + "target": "com.amazonaws.emrcontainers#ACMCertArn", + "traits": { + "smithy.api#deprecated": { + "message": "Customer provided certificate-arn is deprecated and would be removed in future." + }, + "smithy.api#documentation": "

The certificate ARN provided by users for the managed endpoint. This field is under\n deprecation and will be removed in future releases.

" + } + }, + "configurationOverrides": { + "target": "com.amazonaws.emrcontainers#ConfigurationOverrides", + "traits": { + "smithy.api#documentation": "

The configuration settings that will be used to override existing configurations.

" + } + }, + "clientToken": { + "target": "com.amazonaws.emrcontainers#ClientToken", + "traits": { + "smithy.api#documentation": "

The client idempotency token for this create call.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.emrcontainers#TagMap", + "traits": { + "smithy.api#documentation": "

The tags of the managed endpoint.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#CreateManagedEndpointResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The output contains the ID of the managed endpoint.

" + } + }, + "name": { + "target": "com.amazonaws.emrcontainers#ResourceNameString", + "traits": { + "smithy.api#documentation": "

The output contains the name of the managed endpoint.

" + } + }, + "arn": { + "target": "com.amazonaws.emrcontainers#EndpointArn", + "traits": { + "smithy.api#documentation": "

The output contains the ARN of the managed endpoint.

" + } + }, + "virtualClusterId": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The output contains the ID of the virtual cluster.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.emrcontainers#CreateSecurityConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#CreateSecurityConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#CreateSecurityConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a security configuration. Security configurations in Amazon EMR on EKS are\n templates for different security setups. You can use security configurations to configure\n the Lake Formation integration setup. You can also create a security configuration\n to re-use a security setup each time you create a virtual cluster.

", + "smithy.api#http": { + "method": "POST", + "uri": "/securityconfigurations", + "code": 200 + } + } + }, + "com.amazonaws.emrcontainers#CreateSecurityConfigurationRequest": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.emrcontainers#ClientToken", + "traits": { + "smithy.api#documentation": "

The client idempotency token to use when creating the security configuration.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.emrcontainers#ResourceNameString", + "traits": { + "smithy.api#documentation": "

The name of the security configuration.

", + "smithy.api#required": {} + } + }, + "securityConfigurationData": { + "target": "com.amazonaws.emrcontainers#SecurityConfigurationData", + "traits": { + "smithy.api#documentation": "

Security configuration input for the request.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.emrcontainers#TagMap", + "traits": { + "smithy.api#documentation": "

The tags to add to the security configuration.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#CreateSecurityConfigurationResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the security configuration.

" + } + }, + "name": { + "target": "com.amazonaws.emrcontainers#ResourceNameString", + "traits": { + "smithy.api#documentation": "

The name of the security configuration.

" + } + }, + "arn": { + "target": "com.amazonaws.emrcontainers#SecurityConfigurationArn", + "traits": { + "smithy.api#documentation": "

The ARN (Amazon Resource Name) of the security configuration.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.emrcontainers#CreateVirtualCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#CreateVirtualClusterRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#CreateVirtualClusterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#EKSRequestThrottledException" + }, + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any\n additional resource in your system. A single virtual cluster maps to a single Kubernetes\n namespace. Given this relationship, you can model virtual clusters the same way you model\n Kubernetes namespaces to meet your requirements.

", + "smithy.api#http": { + "method": "POST", + "uri": "/virtualclusters", + "code": 200 + } + } + }, + "com.amazonaws.emrcontainers#CreateVirtualClusterRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.emrcontainers#ResourceNameString", + "traits": { + "smithy.api#documentation": "

The specified name of the virtual cluster.

", + "smithy.api#required": {} + } + }, + "containerProvider": { + "target": "com.amazonaws.emrcontainers#ContainerProvider", + "traits": { + "smithy.api#documentation": "

The container provider of the virtual cluster.

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.emrcontainers#ClientToken", + "traits": { + "smithy.api#documentation": "

The client token of the virtual cluster.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.emrcontainers#TagMap", + "traits": { + "smithy.api#documentation": "

The tags assigned to the virtual cluster.

" + } + }, + "securityConfigurationId": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the security configuration.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#CreateVirtualClusterResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

This output contains the virtual cluster ID.

" + } + }, + "name": { + "target": "com.amazonaws.emrcontainers#ResourceNameString", + "traits": { + "smithy.api#documentation": "

This output contains the name of the virtual cluster.

" + } + }, + "arn": { + "target": "com.amazonaws.emrcontainers#VirtualClusterArn", + "traits": { + "smithy.api#documentation": "

This output contains the ARN of virtual cluster.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.emrcontainers#CredentialType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^.*\\S.*$" + } + }, + "com.amazonaws.emrcontainers#Credentials": { + "type": "union", + "members": { + "token": { + "target": "com.amazonaws.emrcontainers#Token", + "traits": { + "smithy.api#documentation": "

The actual session token being returned.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The structure containing the session token being returned.

" + } + }, + "com.amazonaws.emrcontainers#Date": { + "type": "timestamp", + "traits": { + "smithy.api#timestampFormat": "date-time" + } + }, + "com.amazonaws.emrcontainers#DeleteJobTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#DeleteJobTemplateRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#DeleteJobTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a job template. Job template stores values of StartJobRun API request in a\n template and can be used to start a job run. Job template allows two use cases: avoid\n repeating recurring StartJobRun API request values, enforcing certain values in StartJobRun\n API request.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/jobtemplates/{id}", + "code": 200 + } + } + }, + "com.amazonaws.emrcontainers#DeleteJobTemplateRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the job template that will be deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#DeleteJobTemplateResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

This output contains the ID of the job template that was deleted.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.emrcontainers#DeleteManagedEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#DeleteManagedEndpointRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#DeleteManagedEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a managed endpoint. A managed endpoint is a gateway that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can\n communicate with your virtual cluster.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/virtualclusters/{virtualClusterId}/endpoints/{id}", + "code": 200 + } + } + }, + "com.amazonaws.emrcontainers#DeleteManagedEndpointRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the managed endpoint.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "virtualClusterId": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the endpoint's virtual cluster.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#DeleteManagedEndpointResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The output displays the ID of the managed endpoint.

" + } + }, + "virtualClusterId": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The output displays the ID of the endpoint's virtual cluster.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.emrcontainers#DeleteVirtualCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#DeleteVirtualClusterRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#DeleteVirtualClusterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any\n additional resource in your system. A single virtual cluster maps to a single Kubernetes\n namespace. Given this relationship, you can model virtual clusters the same way you model\n Kubernetes namespaces to meet your requirements.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/virtualclusters/{id}", + "code": 200 + } + } + }, + "com.amazonaws.emrcontainers#DeleteVirtualClusterRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the virtual cluster that will be deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#DeleteVirtualClusterResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

This output contains the ID of the virtual cluster that will be deleted.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.emrcontainers#DescribeJobRun": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#DescribeJobRunRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#DescribeJobRunResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Displays detailed information about a job run. A job run is a unit of work, such as a\n Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.

", + "smithy.api#http": { + "method": "GET", + "uri": "/virtualclusters/{virtualClusterId}/jobruns/{id}", + "code": 200 + } + } + }, + "com.amazonaws.emrcontainers#DescribeJobRunRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the job run request.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "virtualClusterId": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the virtual cluster for which the job run is submitted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#DescribeJobRunResponse": { + "type": "structure", + "members": { + "jobRun": { + "target": "com.amazonaws.emrcontainers#JobRun", + "traits": { + "smithy.api#documentation": "

The output displays information about a job run.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.emrcontainers#DescribeJobTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#DescribeJobTemplateRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#DescribeJobTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Displays detailed information about a specified job template. Job template stores values\n of StartJobRun API request in a template and can be used to start a job run. Job template\n allows two use cases: avoid repeating recurring StartJobRun API request values, enforcing\n certain values in StartJobRun API request.

", + "smithy.api#http": { + "method": "GET", + "uri": "/jobtemplates/{id}", + "code": 200 + } + } + }, + "com.amazonaws.emrcontainers#DescribeJobTemplateRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the job template that will be described.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#DescribeJobTemplateResponse": { + "type": "structure", + "members": { + "jobTemplate": { + "target": "com.amazonaws.emrcontainers#JobTemplate", + "traits": { + "smithy.api#documentation": "

This output displays information about the specified job template.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.emrcontainers#DescribeManagedEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#DescribeManagedEndpointRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#DescribeManagedEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Displays detailed information about a managed endpoint. A managed endpoint is a gateway\n that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual cluster.

", + "smithy.api#http": { + "method": "GET", + "uri": "/virtualclusters/{virtualClusterId}/endpoints/{id}", + "code": 200 + } + } + }, + "com.amazonaws.emrcontainers#DescribeManagedEndpointRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

This output displays ID of the managed endpoint.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "virtualClusterId": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the endpoint's virtual cluster.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#DescribeManagedEndpointResponse": { + "type": "structure", + "members": { + "endpoint": { + "target": "com.amazonaws.emrcontainers#Endpoint", + "traits": { + "smithy.api#documentation": "

This output displays information about a managed endpoint.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.emrcontainers#DescribeSecurityConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#DescribeSecurityConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#DescribeSecurityConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Displays detailed information about a specified security configuration. Security\n configurations in Amazon EMR on EKS are templates for different security setups. You\n can use security configurations to configure the Lake Formation integration setup.\n You can also create a security configuration to re-use a security setup each time you\n create a virtual cluster.

", + "smithy.api#http": { + "method": "GET", + "uri": "/securityconfigurations/{id}", + "code": 200 + } + } + }, + "com.amazonaws.emrcontainers#DescribeSecurityConfigurationRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the security configuration.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#DescribeSecurityConfigurationResponse": { + "type": "structure", + "members": { + "securityConfiguration": { + "target": "com.amazonaws.emrcontainers#SecurityConfiguration", + "traits": { + "smithy.api#documentation": "

Details of the security configuration.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.emrcontainers#DescribeVirtualCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#DescribeVirtualClusterRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#DescribeVirtualClusterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Displays detailed information about a specified virtual cluster. Virtual cluster is a\n managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual\n clusters. They do not consume any additional resource in your system. A single virtual\n cluster maps to a single Kubernetes namespace. Given this relationship, you can model\n virtual clusters the same way you model Kubernetes namespaces to meet your\n requirements.

", + "smithy.api#http": { + "method": "GET", + "uri": "/virtualclusters/{id}", + "code": 200 + } + } + }, + "com.amazonaws.emrcontainers#DescribeVirtualClusterRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the virtual cluster that will be described.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#DescribeVirtualClusterResponse": { + "type": "structure", + "members": { + "virtualCluster": { + "target": "com.amazonaws.emrcontainers#VirtualCluster", + "traits": { + "smithy.api#documentation": "

This output displays information about the specified virtual cluster.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.emrcontainers#EKSRequestThrottledException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.emrcontainers#String1024" + } + }, + "traits": { + "smithy.api#documentation": "

The request exceeded the Amazon EKS API operation limits.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.emrcontainers#EksInfo": { + "type": "structure", + "members": { + "namespace": { + "target": "com.amazonaws.emrcontainers#KubernetesNamespace", + "traits": { + "smithy.api#documentation": "

The namespaces of the Amazon EKS cluster.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The information about the Amazon EKS cluster.

" + } + }, + "com.amazonaws.emrcontainers#EncryptionConfiguration": { + "type": "structure", + "members": { + "inTransitEncryptionConfiguration": { + "target": "com.amazonaws.emrcontainers#InTransitEncryptionConfiguration", + "traits": { + "smithy.api#documentation": "

In-transit encryption-related input for the security configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configurations related to encryption for the security configuration.

" + } + }, + "com.amazonaws.emrcontainers#Endpoint": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the endpoint.

" + } + }, + "name": { + "target": "com.amazonaws.emrcontainers#ResourceNameString", + "traits": { + "smithy.api#documentation": "

The name of the endpoint.

" + } + }, + "arn": { + "target": "com.amazonaws.emrcontainers#EndpointArn", + "traits": { + "smithy.api#documentation": "

The ARN of the endpoint.

" + } + }, + "virtualClusterId": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the endpoint's virtual cluster.

" + } + }, + "type": { + "target": "com.amazonaws.emrcontainers#EndpointType", + "traits": { + "smithy.api#documentation": "

The type of the endpoint.

" + } + }, + "state": { + "target": "com.amazonaws.emrcontainers#EndpointState", + "traits": { + "smithy.api#documentation": "

The state of the endpoint.

" + } + }, + "releaseLabel": { + "target": "com.amazonaws.emrcontainers#ReleaseLabel", + "traits": { + "smithy.api#documentation": "

The EMR release version to be used for the endpoint.

" + } + }, + "executionRoleArn": { + "target": "com.amazonaws.emrcontainers#IAMRoleArn", + "traits": { + "smithy.api#documentation": "

The execution role ARN of the endpoint.

" + } + }, + "certificateArn": { + "target": "com.amazonaws.emrcontainers#ACMCertArn", + "traits": { + "smithy.api#deprecated": { + "message": "Customer provided certificate-arn is deprecated and would be removed in future." + }, + "smithy.api#documentation": "

The certificate ARN of the endpoint. This field is under deprecation and will be removed\n in future.

" + } + }, + "certificateAuthority": { + "target": "com.amazonaws.emrcontainers#Certificate", + "traits": { + "smithy.api#documentation": "

The certificate generated by emr control plane on customer behalf to secure the managed\n endpoint.

" + } + }, + "configurationOverrides": { + "target": "com.amazonaws.emrcontainers#ConfigurationOverrides", + "traits": { + "smithy.api#documentation": "

The configuration settings that are used to override existing configurations for\n endpoints.

" + } + }, + "serverUrl": { + "target": "com.amazonaws.emrcontainers#UriString", + "traits": { + "smithy.api#documentation": "

The server URL of the endpoint.

" + } + }, + "createdAt": { + "target": "com.amazonaws.emrcontainers#Date", + "traits": { + "smithy.api#documentation": "

The date and time when the endpoint was created.

" + } + }, + "securityGroup": { + "target": "com.amazonaws.emrcontainers#String256", + "traits": { + "smithy.api#documentation": "

The security group configuration of the endpoint.

" + } + }, + "subnetIds": { + "target": "com.amazonaws.emrcontainers#SubnetIds", + "traits": { + "smithy.api#documentation": "

The subnet IDs of the endpoint.

" + } + }, + "stateDetails": { + "target": "com.amazonaws.emrcontainers#String256", + "traits": { + "smithy.api#documentation": "

Additional details of the endpoint state.

" + } + }, + "failureReason": { + "target": "com.amazonaws.emrcontainers#FailureReason", + "traits": { + "smithy.api#documentation": "

The reasons why the endpoint has failed.

" + } + }, + "tags": { + "target": "com.amazonaws.emrcontainers#TagMap", + "traits": { + "smithy.api#documentation": "

The tags of the endpoint.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This entity represents the endpoint that is managed by Amazon EMR on EKS.

" + } + }, + "com.amazonaws.emrcontainers#EndpointArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 60, + "max": 1024 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):emr-containers:.+:(\\d{12}):\\/virtualclusters\\/[0-9a-zA-Z]+\\/endpoints\\/[0-9a-zA-Z]+$" + } + }, + "com.amazonaws.emrcontainers#EndpointState": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "TERMINATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TERMINATING" + } + }, + "TERMINATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TERMINATED" + } + }, + "TERMINATED_WITH_ERRORS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TERMINATED_WITH_ERRORS" + } + } + } + }, + "com.amazonaws.emrcontainers#EndpointStates": { + "type": "list", + "member": { + "target": "com.amazonaws.emrcontainers#EndpointState" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.emrcontainers#EndpointType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.emrcontainers#EndpointTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.emrcontainers#EndpointType" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.emrcontainers#Endpoints": { + "type": "list", + "member": { + "target": "com.amazonaws.emrcontainers#Endpoint" + } + }, + "com.amazonaws.emrcontainers#EntryPointArgument": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10280 + }, + "smithy.api#pattern": "\\S", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.emrcontainers#EntryPointArguments": { + "type": "list", + "member": { + "target": "com.amazonaws.emrcontainers#EntryPointArgument" + } + }, + "com.amazonaws.emrcontainers#EntryPointPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "\\S", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.emrcontainers#FailureReason": { + "type": "enum", + "members": { + "INTERNAL_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_ERROR" + } + }, + "USER_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USER_ERROR" + } + }, + "VALIDATION_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALIDATION_ERROR" + } + }, + "CLUSTER_UNAVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLUSTER_UNAVAILABLE" + } + } + } + }, + "com.amazonaws.emrcontainers#GetManagedEndpointSessionCredentials": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#GetManagedEndpointSessionCredentialsRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#GetManagedEndpointSessionCredentialsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#RequestThrottledException" + }, + { + "target": "com.amazonaws.emrcontainers#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Generate a session token to connect to a managed endpoint.

", + "smithy.api#http": { + "method": "POST", + "uri": "/virtualclusters/{virtualClusterIdentifier}/endpoints/{endpointIdentifier}/credentials", + "code": 200 + } + } + }, + "com.amazonaws.emrcontainers#GetManagedEndpointSessionCredentialsRequest": { + "type": "structure", + "members": { + "endpointIdentifier": { + "target": "com.amazonaws.emrcontainers#String2048", + "traits": { + "smithy.api#documentation": "

The ARN of the managed endpoint for which the request is submitted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "virtualClusterIdentifier": { + "target": "com.amazonaws.emrcontainers#String2048", + "traits": { + "smithy.api#documentation": "

The ARN of the Virtual Cluster which the Managed Endpoint belongs to.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "executionRoleArn": { + "target": "com.amazonaws.emrcontainers#IAMRoleArn", + "traits": { + "smithy.api#documentation": "

The IAM Execution Role ARN that will be used by the job run.

", + "smithy.api#required": {} + } + }, + "credentialType": { + "target": "com.amazonaws.emrcontainers#CredentialType", + "traits": { + "smithy.api#documentation": "

Type of the token requested. Currently supported and default value of this field is\n “TOKEN.”

", + "smithy.api#required": {} + } + }, + "durationInSeconds": { + "target": "com.amazonaws.emrcontainers#JavaInteger", + "traits": { + "smithy.api#documentation": "

Duration in seconds for which the session token is valid. The default duration is 15\n minutes and the maximum is 12 hours.

" + } + }, + "logContext": { + "target": "com.amazonaws.emrcontainers#LogContext", + "traits": { + "smithy.api#documentation": "

String identifier used to separate sections of the execution logs uploaded to S3.

" + } + }, + "clientToken": { + "target": "com.amazonaws.emrcontainers#ClientToken", + "traits": { + "smithy.api#documentation": "

The client idempotency token of the job run request.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#GetManagedEndpointSessionCredentialsResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The identifier of the session token returned.

" + } + }, + "credentials": { + "target": "com.amazonaws.emrcontainers#Credentials", + "traits": { + "smithy.api#documentation": "

The structure containing the session credentials.

" + } + }, + "expiresAt": { + "target": "com.amazonaws.emrcontainers#Date", + "traits": { + "smithy.api#documentation": "

The date and time when the session token will expire.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.emrcontainers#IAMRoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):iam::(\\d{12})?:(role((\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F))[\\w+=,.@-]+)$" + } + }, + "com.amazonaws.emrcontainers#InTransitEncryptionConfiguration": { + "type": "structure", + "members": { + "tlsCertificateConfiguration": { + "target": "com.amazonaws.emrcontainers#TLSCertificateConfiguration", + "traits": { + "smithy.api#documentation": "

TLS certificate-related configuration input for the security configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configurations related to in-transit encryption for the security configuration.

" + } + }, + "com.amazonaws.emrcontainers#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.emrcontainers#String1024" + } + }, + "traits": { + "smithy.api#documentation": "

This is an internal server exception.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.emrcontainers#JavaInteger": { + "type": "integer" + }, + "com.amazonaws.emrcontainers#JobArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 60, + "max": 1024 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):emr-containers:.+:(\\d{12}):\\/virtualclusters\\/[0-9a-zA-Z]+\\/jobruns\\/[0-9a-zA-Z]+$" + } + }, + "com.amazonaws.emrcontainers#JobDriver": { + "type": "structure", + "members": { + "sparkSubmitJobDriver": { + "target": "com.amazonaws.emrcontainers#SparkSubmitJobDriver", + "traits": { + "smithy.api#documentation": "

The job driver parameters specified for spark submit.

" + } + }, + "sparkSqlJobDriver": { + "target": "com.amazonaws.emrcontainers#SparkSqlJobDriver", + "traits": { + "smithy.api#documentation": "

The job driver for job type.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specify the driver that the job runs on. Exactly one of the two available job drivers is\n required, either sparkSqlJobDriver or sparkSubmitJobDriver.

" + } + }, + "com.amazonaws.emrcontainers#JobRun": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the job run.

" + } + }, + "name": { + "target": "com.amazonaws.emrcontainers#ResourceNameString", + "traits": { + "smithy.api#documentation": "

The name of the job run.

" + } + }, + "virtualClusterId": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the job run's virtual cluster.

" + } + }, + "arn": { + "target": "com.amazonaws.emrcontainers#JobArn", + "traits": { + "smithy.api#documentation": "

The ARN of job run.

" + } + }, + "state": { + "target": "com.amazonaws.emrcontainers#JobRunState", + "traits": { + "smithy.api#documentation": "

The state of the job run.

" + } + }, + "clientToken": { + "target": "com.amazonaws.emrcontainers#ClientToken", + "traits": { + "smithy.api#documentation": "

The client token used to start a job run.

" + } + }, + "executionRoleArn": { + "target": "com.amazonaws.emrcontainers#IAMRoleArn", + "traits": { + "smithy.api#documentation": "

The execution role ARN of the job run.

" + } + }, + "releaseLabel": { + "target": "com.amazonaws.emrcontainers#ReleaseLabel", + "traits": { + "smithy.api#documentation": "

The release version of Amazon EMR.

" + } + }, + "configurationOverrides": { + "target": "com.amazonaws.emrcontainers#ConfigurationOverrides", + "traits": { + "smithy.api#documentation": "

The configuration settings that are used to override default configuration.

" + } + }, + "jobDriver": { + "target": "com.amazonaws.emrcontainers#JobDriver", + "traits": { + "smithy.api#documentation": "

Parameters of job driver for the job run.

" + } + }, + "createdAt": { + "target": "com.amazonaws.emrcontainers#Date", + "traits": { + "smithy.api#documentation": "

The date and time when the job run was created.

" + } + }, + "createdBy": { + "target": "com.amazonaws.emrcontainers#RequestIdentityUserArn", + "traits": { + "smithy.api#documentation": "

The user who created the job run.

" + } + }, + "finishedAt": { + "target": "com.amazonaws.emrcontainers#Date", + "traits": { + "smithy.api#documentation": "

The date and time when the job run has finished.

" + } + }, + "stateDetails": { + "target": "com.amazonaws.emrcontainers#String256", + "traits": { + "smithy.api#documentation": "

Additional details of the job run state.

" + } + }, + "failureReason": { + "target": "com.amazonaws.emrcontainers#FailureReason", + "traits": { + "smithy.api#documentation": "

The reasons why the job run has failed.

" + } + }, + "tags": { + "target": "com.amazonaws.emrcontainers#TagMap", + "traits": { + "smithy.api#documentation": "

The assigned tags of the job run.

" + } + }, + "retryPolicyConfiguration": { + "target": "com.amazonaws.emrcontainers#RetryPolicyConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of the retry policy that the job runs on.

" + } + }, + "retryPolicyExecution": { + "target": "com.amazonaws.emrcontainers#RetryPolicyExecution", + "traits": { + "smithy.api#documentation": "

The current status of the retry policy executed on the job.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This entity describes a job run. A job run is a unit of work, such as a Spark jar,\n PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.

" + } + }, + "com.amazonaws.emrcontainers#JobRunState": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "SUBMITTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUBMITTED" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLED" + } + }, + "CANCEL_PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCEL_PENDING" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + } + } + }, + "com.amazonaws.emrcontainers#JobRunStates": { + "type": "list", + "member": { + "target": "com.amazonaws.emrcontainers#JobRunState" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.emrcontainers#JobRuns": { + "type": "list", + "member": { + "target": "com.amazonaws.emrcontainers#JobRun" + } + }, + "com.amazonaws.emrcontainers#JobTemplate": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.emrcontainers#ResourceNameString", + "traits": { + "smithy.api#documentation": "

The name of the job template.

" + } + }, + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the job template.

" + } + }, + "arn": { + "target": "com.amazonaws.emrcontainers#JobTemplateArn", + "traits": { + "smithy.api#documentation": "

The ARN of the job template.

" + } + }, + "createdAt": { + "target": "com.amazonaws.emrcontainers#Date", + "traits": { + "smithy.api#documentation": "

The date and time when the job template was created.

" + } + }, + "createdBy": { + "target": "com.amazonaws.emrcontainers#RequestIdentityUserArn", + "traits": { + "smithy.api#documentation": "

The user who created the job template.

" + } + }, + "tags": { + "target": "com.amazonaws.emrcontainers#TagMap", + "traits": { + "smithy.api#documentation": "

The tags assigned to the job template.

" + } + }, + "jobTemplateData": { + "target": "com.amazonaws.emrcontainers#JobTemplateData", + "traits": { + "smithy.api#documentation": "

The job template data which holds values of StartJobRun API request.

", + "smithy.api#required": {} + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.emrcontainers#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The KMS key ARN used to encrypt the job template.

" + } + }, + "decryptionError": { + "target": "com.amazonaws.emrcontainers#String2048", + "traits": { + "smithy.api#documentation": "

The error message in case the decryption of job template fails.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This entity describes a job template. Job template stores values of StartJobRun API\n request in a template and can be used to start a job run. Job template allows two use\n cases: avoid repeating recurring StartJobRun API request values, enforcing certain values\n in StartJobRun API request.

" + } + }, + "com.amazonaws.emrcontainers#JobTemplateArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 60, + "max": 1024 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):emr-containers:.+:(\\d{12}):\\/jobtemplates\\/[0-9a-zA-Z]+$" + } + }, + "com.amazonaws.emrcontainers#JobTemplateData": { + "type": "structure", + "members": { + "executionRoleArn": { + "target": "com.amazonaws.emrcontainers#ParametricIAMRoleArn", + "traits": { + "smithy.api#documentation": "

The execution role ARN of the job run.

", + "smithy.api#required": {} + } + }, + "releaseLabel": { + "target": "com.amazonaws.emrcontainers#ParametricReleaseLabel", + "traits": { + "smithy.api#documentation": "

The release version of Amazon EMR.

", + "smithy.api#required": {} + } + }, + "configurationOverrides": { + "target": "com.amazonaws.emrcontainers#ParametricConfigurationOverrides", + "traits": { + "smithy.api#documentation": "

The configuration settings that are used to override defaults configuration.

" + } + }, + "jobDriver": { + "target": "com.amazonaws.emrcontainers#JobDriver", + "traits": { + "smithy.api#required": {} + } + }, + "parameterConfiguration": { + "target": "com.amazonaws.emrcontainers#TemplateParameterConfigurationMap", + "traits": { + "smithy.api#documentation": "

The configuration of parameters existing in the job template.

" + } + }, + "jobTags": { + "target": "com.amazonaws.emrcontainers#TagMap", + "traits": { + "smithy.api#documentation": "

The tags assigned to jobs started using the job template.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The values of StartJobRun API requests used in job runs started using the job\n template.

" + } + }, + "com.amazonaws.emrcontainers#JobTemplates": { + "type": "list", + "member": { + "target": "com.amazonaws.emrcontainers#JobTemplate" + } + }, + "com.amazonaws.emrcontainers#KmsKeyArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 2048 + }, + "smithy.api#pattern": "^(arn:(aws[a-zA-Z0-9-]*):kms:.+:(\\d{12})?:key\\/[(0-9a-zA-Z)-?]+|\\$\\{[a-zA-Z]\\w*\\})$" + } + }, + "com.amazonaws.emrcontainers#KubernetesNamespace": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" + } + }, + "com.amazonaws.emrcontainers#LakeFormationConfiguration": { + "type": "structure", + "members": { + "authorizedSessionTagValue": { + "target": "com.amazonaws.emrcontainers#SessionTagValue", + "traits": { + "smithy.api#documentation": "

The session tag to authorize Amazon EMR on EKS for API calls to Lake Formation.

" + } + }, + "secureNamespaceInfo": { + "target": "com.amazonaws.emrcontainers#SecureNamespaceInfo", + "traits": { + "smithy.api#documentation": "

The namespace input of the system job.

" + } + }, + "queryEngineRoleArn": { + "target": "com.amazonaws.emrcontainers#IAMRoleArn", + "traits": { + "smithy.api#documentation": "

The query engine IAM role ARN that is tied to the secure Spark job. The\n QueryEngine role assumes the JobExecutionRole to execute all\n the Lake Formation calls.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Lake Formation related configuration inputs for the security\n configuration.

" + } + }, + "com.amazonaws.emrcontainers#ListJobRuns": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#ListJobRunsRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#ListJobRunsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists job runs based on a set of parameters. A job run is a unit of work, such as a\n Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.

", + "smithy.api#http": { + "method": "GET", + "uri": "/virtualclusters/{virtualClusterId}/jobruns", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "jobRuns", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.emrcontainers#ListJobRunsRequest": { + "type": "structure", + "members": { + "virtualClusterId": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the virtual cluster for which to list the job run.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "createdBefore": { + "target": "com.amazonaws.emrcontainers#Date", + "traits": { + "smithy.api#documentation": "

The date and time before which the job runs were submitted.

", + "smithy.api#httpQuery": "createdBefore" + } + }, + "createdAfter": { + "target": "com.amazonaws.emrcontainers#Date", + "traits": { + "smithy.api#documentation": "

The date and time after which the job runs were submitted.

", + "smithy.api#httpQuery": "createdAfter" + } + }, + "name": { + "target": "com.amazonaws.emrcontainers#ResourceNameString", + "traits": { + "smithy.api#documentation": "

The name of the job run.

", + "smithy.api#httpQuery": "name" + } + }, + "states": { + "target": "com.amazonaws.emrcontainers#JobRunStates", + "traits": { + "smithy.api#documentation": "

The states of the job run.

", + "smithy.api#httpQuery": "states" + } + }, + "maxResults": { + "target": "com.amazonaws.emrcontainers#JavaInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of job runs that can be listed.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.emrcontainers#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of job runs to return.

", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#ListJobRunsResponse": { + "type": "structure", + "members": { + "jobRuns": { + "target": "com.amazonaws.emrcontainers#JobRuns", + "traits": { + "smithy.api#documentation": "

This output lists information about the specified job runs.

" + } + }, + "nextToken": { + "target": "com.amazonaws.emrcontainers#NextToken", + "traits": { + "smithy.api#documentation": "

This output displays the token for the next set of job runs.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.emrcontainers#ListJobTemplates": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#ListJobTemplatesRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#ListJobTemplatesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists job templates based on a set of parameters. Job template stores values of\n StartJobRun API request in a template and can be used to start a job run. Job template\n allows two use cases: avoid repeating recurring StartJobRun API request values, enforcing\n certain values in StartJobRun API request.

", + "smithy.api#http": { + "method": "GET", + "uri": "/jobtemplates", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "templates", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.emrcontainers#ListJobTemplatesRequest": { + "type": "structure", + "members": { + "createdAfter": { + "target": "com.amazonaws.emrcontainers#Date", + "traits": { + "smithy.api#documentation": "

The date and time after which the job templates were created.

", + "smithy.api#httpQuery": "createdAfter" + } + }, + "createdBefore": { + "target": "com.amazonaws.emrcontainers#Date", + "traits": { + "smithy.api#documentation": "

The date and time before which the job templates were created.

", + "smithy.api#httpQuery": "createdBefore" + } + }, + "maxResults": { + "target": "com.amazonaws.emrcontainers#JavaInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of job templates that can be listed.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.emrcontainers#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of job templates to return.

", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#ListJobTemplatesResponse": { + "type": "structure", + "members": { + "templates": { + "target": "com.amazonaws.emrcontainers#JobTemplates", + "traits": { + "smithy.api#documentation": "

This output lists information about the specified job templates.

" + } + }, + "nextToken": { + "target": "com.amazonaws.emrcontainers#NextToken", + "traits": { + "smithy.api#documentation": "

This output displays the token for the next set of job templates.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.emrcontainers#ListManagedEndpoints": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#ListManagedEndpointsRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#ListManagedEndpointsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists managed endpoints based on a set of parameters. A managed endpoint is a gateway\n that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual cluster.

", + "smithy.api#http": { + "method": "GET", + "uri": "/virtualclusters/{virtualClusterId}/endpoints", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "endpoints", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.emrcontainers#ListManagedEndpointsRequest": { + "type": "structure", + "members": { + "virtualClusterId": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the virtual cluster.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "createdBefore": { + "target": "com.amazonaws.emrcontainers#Date", + "traits": { + "smithy.api#documentation": "

The date and time before which the endpoints are created.

", + "smithy.api#httpQuery": "createdBefore" + } + }, + "createdAfter": { + "target": "com.amazonaws.emrcontainers#Date", + "traits": { + "smithy.api#documentation": "

The date and time after which the endpoints are created.

", + "smithy.api#httpQuery": "createdAfter" + } + }, + "types": { + "target": "com.amazonaws.emrcontainers#EndpointTypes", + "traits": { + "smithy.api#documentation": "

The types of the managed endpoints.

", + "smithy.api#httpQuery": "types" + } + }, + "states": { + "target": "com.amazonaws.emrcontainers#EndpointStates", + "traits": { + "smithy.api#documentation": "

The states of the managed endpoints.

", + "smithy.api#httpQuery": "states" + } + }, + "maxResults": { + "target": "com.amazonaws.emrcontainers#JavaInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of managed endpoints that can be listed.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.emrcontainers#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of managed endpoints to return.

", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#ListManagedEndpointsResponse": { + "type": "structure", + "members": { + "endpoints": { + "target": "com.amazonaws.emrcontainers#Endpoints", + "traits": { + "smithy.api#documentation": "

The managed endpoints to be listed.

" + } + }, + "nextToken": { + "target": "com.amazonaws.emrcontainers#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of endpoints to return.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.emrcontainers#ListSecurityConfigurations": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#ListSecurityConfigurationsRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#ListSecurityConfigurationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists security configurations based on a set of parameters. Security configurations in\n Amazon EMR on EKS are templates for different security setups. You can use security\n configurations to configure the Lake Formation integration setup. You can also\n create a security configuration to re-use a security setup each time you create a virtual\n cluster.

", + "smithy.api#http": { + "method": "GET", + "uri": "/securityconfigurations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "securityConfigurations", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.emrcontainers#ListSecurityConfigurationsRequest": { + "type": "structure", + "members": { + "createdAfter": { + "target": "com.amazonaws.emrcontainers#Date", + "traits": { + "smithy.api#documentation": "

The date and time after which the security configuration was created.

", + "smithy.api#httpQuery": "createdAfter" + } + }, + "createdBefore": { + "target": "com.amazonaws.emrcontainers#Date", + "traits": { + "smithy.api#documentation": "

The date and time before which the security configuration was created.

", + "smithy.api#httpQuery": "createdBefore" + } + }, + "maxResults": { + "target": "com.amazonaws.emrcontainers#JavaInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of security configurations the operation can list.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.emrcontainers#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of security configurations to return.

", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#ListSecurityConfigurationsResponse": { + "type": "structure", + "members": { + "securityConfigurations": { + "target": "com.amazonaws.emrcontainers#SecurityConfigurations", + "traits": { + "smithy.api#documentation": "

The list of returned security configurations.

" + } + }, + "nextToken": { + "target": "com.amazonaws.emrcontainers#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of security configurations to return.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.emrcontainers#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the tags assigned to the resources.

", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.emrcontainers#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.emrcontainers#RsiArn", + "traits": { + "smithy.api#documentation": "

The ARN of tagged resources.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.emrcontainers#TagMap", + "traits": { + "smithy.api#documentation": "

The tags assigned to resources.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.emrcontainers#ListVirtualClusters": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#ListVirtualClustersRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#ListVirtualClustersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists information about the specified virtual cluster. Virtual cluster is a managed\n entity on Amazon EMR on EKS. You can create, describe, list and delete virtual\n clusters. They do not consume any additional resource in your system. A single virtual\n cluster maps to a single Kubernetes namespace. Given this relationship, you can model\n virtual clusters the same way you model Kubernetes namespaces to meet your\n requirements.

", + "smithy.api#http": { + "method": "GET", + "uri": "/virtualclusters", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "virtualClusters", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.emrcontainers#ListVirtualClustersRequest": { + "type": "structure", + "members": { + "containerProviderId": { + "target": "com.amazonaws.emrcontainers#String1024", + "traits": { + "smithy.api#documentation": "

The container provider ID of the virtual cluster.

", + "smithy.api#httpQuery": "containerProviderId" + } + }, + "containerProviderType": { + "target": "com.amazonaws.emrcontainers#ContainerProviderType", + "traits": { + "smithy.api#documentation": "

The container provider type of the virtual cluster. Amazon EKS is the only\n supported type as of now.

", + "smithy.api#httpQuery": "containerProviderType" + } + }, + "createdAfter": { + "target": "com.amazonaws.emrcontainers#Date", + "traits": { + "smithy.api#documentation": "

The date and time after which the virtual clusters are created.

", + "smithy.api#httpQuery": "createdAfter" + } + }, + "createdBefore": { + "target": "com.amazonaws.emrcontainers#Date", + "traits": { + "smithy.api#documentation": "

The date and time before which the virtual clusters are created.

", + "smithy.api#httpQuery": "createdBefore" + } + }, + "states": { + "target": "com.amazonaws.emrcontainers#VirtualClusterStates", + "traits": { + "smithy.api#documentation": "

The states of the requested virtual clusters.

", + "smithy.api#httpQuery": "states" + } + }, + "maxResults": { + "target": "com.amazonaws.emrcontainers#JavaInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of virtual clusters that can be listed.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.emrcontainers#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of virtual clusters to return.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "eksAccessEntryIntegrated": { + "target": "com.amazonaws.emrcontainers#Boolean", + "traits": { + "smithy.api#documentation": "

Optional Boolean that specifies whether the operation should return the \n virtual clusters that have the access entry integration enabled or disabled. If not specified,\n the operation returns all applicable virtual clusters.

", + "smithy.api#httpQuery": "eksAccessEntryIntegrated" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#ListVirtualClustersResponse": { + "type": "structure", + "members": { + "virtualClusters": { + "target": "com.amazonaws.emrcontainers#VirtualClusters", + "traits": { + "smithy.api#documentation": "

This output lists the specified virtual clusters.

" + } + }, + "nextToken": { + "target": "com.amazonaws.emrcontainers#NextToken", + "traits": { + "smithy.api#documentation": "

This output displays the token for the next set of virtual clusters.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.emrcontainers#LogContext": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": "^((?!.*-s3alias)(?!xn--.*)[a-z0-9][-a-z0-9.]*)?[a-z0-9]$" + } + }, + "com.amazonaws.emrcontainers#LogGroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[\\.\\-_/#A-Za-z0-9]+$" + } + }, + "com.amazonaws.emrcontainers#MaxFilesToKeep": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.emrcontainers#MonitoringConfiguration": { + "type": "structure", + "members": { + "persistentAppUI": { + "target": "com.amazonaws.emrcontainers#PersistentAppUI", + "traits": { + "smithy.api#documentation": "

Monitoring configurations for the persistent application UI.

" + } + }, + "cloudWatchMonitoringConfiguration": { + "target": "com.amazonaws.emrcontainers#CloudWatchMonitoringConfiguration", + "traits": { + "smithy.api#documentation": "

Monitoring configurations for CloudWatch.

" + } + }, + "s3MonitoringConfiguration": { + "target": "com.amazonaws.emrcontainers#S3MonitoringConfiguration", + "traits": { + "smithy.api#documentation": "

Amazon S3 configuration for monitoring log publishing.

" + } + }, + "containerLogRotationConfiguration": { + "target": "com.amazonaws.emrcontainers#ContainerLogRotationConfiguration", + "traits": { + "smithy.api#documentation": "

Enable or disable container log rotation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration setting for monitoring.

" + } + }, + "com.amazonaws.emrcontainers#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.emrcontainers#ParametricCloudWatchMonitoringConfiguration": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.emrcontainers#TemplateParameter", + "traits": { + "smithy.api#documentation": "

The name of the log group for log publishing.

" + } + }, + "logStreamNamePrefix": { + "target": "com.amazonaws.emrcontainers#String256", + "traits": { + "smithy.api#documentation": "

The specified name prefix for log streams.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A configuration for CloudWatch monitoring. You can configure your jobs to send log\n information to CloudWatch Logs. This data type allows job template parameters to be\n specified within.

" + } + }, + "com.amazonaws.emrcontainers#ParametricConfigurationOverrides": { + "type": "structure", + "members": { + "applicationConfiguration": { + "target": "com.amazonaws.emrcontainers#ConfigurationList", + "traits": { + "smithy.api#documentation": "

The configurations for the application running by the job run.

" + } + }, + "monitoringConfiguration": { + "target": "com.amazonaws.emrcontainers#ParametricMonitoringConfiguration", + "traits": { + "smithy.api#documentation": "

The configurations for monitoring.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A configuration specification to be used to override existing configurations. This data\n type allows job template parameters to be specified within.

" + } + }, + "com.amazonaws.emrcontainers#ParametricIAMRoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 4, + "max": 2048 + }, + "smithy.api#pattern": "^(^arn:(aws[a-zA-Z0-9-]*):iam::(\\d{12})?:(role((\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F))[\\w+=,.@-]+)$)|([\\.\\-_\\#A-Za-z0-9\\$\\{\\}]+)$" + } + }, + "com.amazonaws.emrcontainers#ParametricMonitoringConfiguration": { + "type": "structure", + "members": { + "persistentAppUI": { + "target": "com.amazonaws.emrcontainers#TemplateParameter", + "traits": { + "smithy.api#documentation": "

Monitoring configurations for the persistent application UI.

" + } + }, + "cloudWatchMonitoringConfiguration": { + "target": "com.amazonaws.emrcontainers#ParametricCloudWatchMonitoringConfiguration", + "traits": { + "smithy.api#documentation": "

Monitoring configurations for CloudWatch.

" + } + }, + "s3MonitoringConfiguration": { + "target": "com.amazonaws.emrcontainers#ParametricS3MonitoringConfiguration", + "traits": { + "smithy.api#documentation": "

Amazon S3 configuration for monitoring log publishing.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration setting for monitoring. This data type allows job template parameters to\n be specified within.

" + } + }, + "com.amazonaws.emrcontainers#ParametricReleaseLabel": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^([\\.\\-_/A-Za-z0-9]+|\\$\\{[a-zA-Z]\\w*\\})$" + } + }, + "com.amazonaws.emrcontainers#ParametricS3MonitoringConfiguration": { + "type": "structure", + "members": { + "logUri": { + "target": "com.amazonaws.emrcontainers#UriString", + "traits": { + "smithy.api#documentation": "

Amazon S3 destination URI for log publishing.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Amazon S3 configuration for monitoring log publishing. You can configure your jobs to\n send log information to Amazon S3. This data type allows job template parameters to be\n specified within.

" + } + }, + "com.amazonaws.emrcontainers#PersistentAppUI": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.emrcontainers#ReleaseLabel": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[\\.\\-_/A-Za-z0-9]+$" + } + }, + "com.amazonaws.emrcontainers#RequestIdentityUserArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):(iam|sts)::(\\d{12})?:[\\w/+=,.@-]+$" + } + }, + "com.amazonaws.emrcontainers#RequestThrottledException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.emrcontainers#String1024" + } + }, + "traits": { + "smithy.api#documentation": "

The request throttled.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.emrcontainers#ResourceIdString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[0-9a-z]+$" + } + }, + "com.amazonaws.emrcontainers#ResourceNameString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[\\.\\-_/#A-Za-z0-9]+$" + } + }, + "com.amazonaws.emrcontainers#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.emrcontainers#String1024" + } + }, + "traits": { + "smithy.api#documentation": "

The specified resource was not found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.emrcontainers#RetryPolicyConfiguration": { + "type": "structure", + "members": { + "maxAttempts": { + "target": "com.amazonaws.emrcontainers#JavaInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of attempts on the job's driver.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of the retry policy that the job runs on.

" + } + }, + "com.amazonaws.emrcontainers#RetryPolicyExecution": { + "type": "structure", + "members": { + "currentAttemptCount": { + "target": "com.amazonaws.emrcontainers#JavaInteger", + "traits": { + "smithy.api#documentation": "

The current number of attempts made on the driver of the job.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The current status of the retry policy executed on the job.

" + } + }, + "com.amazonaws.emrcontainers#RotationSize": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 12 + }, + "smithy.api#pattern": "^\\d+(\\.\\d+)?[KMG][Bb]?$" + } + }, + "com.amazonaws.emrcontainers#RsiArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 60, + "max": 500 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):emr-containers:.+:(\\d{12}):/virtualclusters/.+$" + } + }, + "com.amazonaws.emrcontainers#S3MonitoringConfiguration": { + "type": "structure", + "members": { + "logUri": { + "target": "com.amazonaws.emrcontainers#UriString", + "traits": { + "smithy.api#documentation": "

Amazon S3 destination URI for log publishing.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Amazon S3 configuration for monitoring log publishing. You can configure your jobs to\n send log information to Amazon S3.

" + } + }, + "com.amazonaws.emrcontainers#SecretsManagerArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 2048 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):secretsmanager:.+:(\\d{12}):secret:[0-9a-zA-Z/_+=.@-]+$" + } + }, + "com.amazonaws.emrcontainers#SecureNamespaceInfo": { + "type": "structure", + "members": { + "clusterId": { + "target": "com.amazonaws.emrcontainers#ClusterId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon EKS cluster where Amazon EMR on EKS jobs run.

" + } + }, + "namespace": { + "target": "com.amazonaws.emrcontainers#KubernetesNamespace", + "traits": { + "smithy.api#documentation": "

The namespace of the Amazon EKS cluster where the system jobs run.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Namespace inputs for the system job.

" + } + }, + "com.amazonaws.emrcontainers#SecurityConfiguration": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the security configuration.

" + } + }, + "name": { + "target": "com.amazonaws.emrcontainers#ResourceNameString", + "traits": { + "smithy.api#documentation": "

The name of the security configuration.

" + } + }, + "arn": { + "target": "com.amazonaws.emrcontainers#SecurityConfigurationArn", + "traits": { + "smithy.api#documentation": "

The ARN (Amazon Resource Name) of the security configuration.

" + } + }, + "createdAt": { + "target": "com.amazonaws.emrcontainers#Date", + "traits": { + "smithy.api#documentation": "

The date and time that the job run was created.

" + } + }, + "createdBy": { + "target": "com.amazonaws.emrcontainers#RequestIdentityUserArn", + "traits": { + "smithy.api#documentation": "

The user who created the job run.

" + } + }, + "securityConfigurationData": { + "target": "com.amazonaws.emrcontainers#SecurityConfigurationData", + "traits": { + "smithy.api#documentation": "

Security configuration inputs for the request.

" + } + }, + "tags": { + "target": "com.amazonaws.emrcontainers#TagMap", + "traits": { + "smithy.api#documentation": "

The tags to assign to the security configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Inputs related to the security configuration. Security configurations in Amazon EMR on EKS are templates for different security setups. You can use security\n configurations to configure the Lake Formation integration setup. You can also\n create a security configuration to re-use a security setup each time you create a virtual\n cluster.

" + } + }, + "com.amazonaws.emrcontainers#SecurityConfigurationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 60, + "max": 1024 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):emr-containers:.+:(\\d{12}):\\/securityconfigurations\\/[0-9a-zA-Z]+$" + } + }, + "com.amazonaws.emrcontainers#SecurityConfigurationData": { + "type": "structure", + "members": { + "authorizationConfiguration": { + "target": "com.amazonaws.emrcontainers#AuthorizationConfiguration", + "traits": { + "smithy.api#documentation": "

Authorization-related configuration input for the security configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configurations related to the security configuration for the request.

" + } + }, + "com.amazonaws.emrcontainers#SecurityConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.emrcontainers#SecurityConfiguration" + } + }, + "com.amazonaws.emrcontainers#SensitivePropertiesMap": { + "type": "map", + "key": { + "target": "com.amazonaws.emrcontainers#String1024" + }, + "value": { + "target": "com.amazonaws.emrcontainers#String1024" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.emrcontainers#SessionTagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[\\.\\-_/#A-Za-z0-9 ]+$" + } + }, + "com.amazonaws.emrcontainers#SparkSqlJobDriver": { + "type": "structure", + "members": { + "entryPoint": { + "target": "com.amazonaws.emrcontainers#EntryPointPath", + "traits": { + "smithy.api#documentation": "

The SQL file to be executed.

" + } + }, + "sparkSqlParameters": { + "target": "com.amazonaws.emrcontainers#SparkSqlParameters", + "traits": { + "smithy.api#documentation": "

The Spark parameters to be included in the Spark SQL command.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The job driver for job type.

" + } + }, + "com.amazonaws.emrcontainers#SparkSqlParameters": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 102400 + }, + "smithy.api#pattern": "\\S", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.emrcontainers#SparkSubmitJobDriver": { + "type": "structure", + "members": { + "entryPoint": { + "target": "com.amazonaws.emrcontainers#EntryPointPath", + "traits": { + "smithy.api#documentation": "

The entry point of job application.

", + "smithy.api#required": {} + } + }, + "entryPointArguments": { + "target": "com.amazonaws.emrcontainers#EntryPointArguments", + "traits": { + "smithy.api#documentation": "

The arguments for job application.

" + } + }, + "sparkSubmitParameters": { + "target": "com.amazonaws.emrcontainers#SparkSubmitParameters", + "traits": { + "smithy.api#documentation": "

The Spark submit parameters that are used for job runs.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The information about job driver for Spark submit.

" + } + }, + "com.amazonaws.emrcontainers#SparkSubmitParameters": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 102400 + }, + "smithy.api#pattern": "\\S", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.emrcontainers#StartJobRun": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#StartJobRunRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#StartJobRunResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts a job run. A job run is a unit of work, such as a Spark jar, PySpark script, or\n SparkSQL query, that you submit to Amazon EMR on EKS.

", + "smithy.api#http": { + "method": "POST", + "uri": "/virtualclusters/{virtualClusterId}/jobruns", + "code": 200 + } + } + }, + "com.amazonaws.emrcontainers#StartJobRunRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.emrcontainers#ResourceNameString", + "traits": { + "smithy.api#documentation": "

The name of the job run.

" + } + }, + "virtualClusterId": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The virtual cluster ID for which the job run request is submitted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.emrcontainers#ClientToken", + "traits": { + "smithy.api#documentation": "

The client idempotency token of the job run request.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "executionRoleArn": { + "target": "com.amazonaws.emrcontainers#IAMRoleArn", + "traits": { + "smithy.api#documentation": "

The execution role ARN for the job run.

" + } + }, + "releaseLabel": { + "target": "com.amazonaws.emrcontainers#ReleaseLabel", + "traits": { + "smithy.api#documentation": "

The Amazon EMR release version to use for the job run.

" + } + }, + "jobDriver": { + "target": "com.amazonaws.emrcontainers#JobDriver", + "traits": { + "smithy.api#documentation": "

The job driver for the job run.

" + } + }, + "configurationOverrides": { + "target": "com.amazonaws.emrcontainers#ConfigurationOverrides", + "traits": { + "smithy.api#documentation": "

The configuration overrides for the job run.

" + } + }, + "tags": { + "target": "com.amazonaws.emrcontainers#TagMap", + "traits": { + "smithy.api#documentation": "

The tags assigned to job runs.

" + } + }, + "jobTemplateId": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The job template ID to be used to start the job run.

" + } + }, + "jobTemplateParameters": { + "target": "com.amazonaws.emrcontainers#TemplateParameterInputMap", + "traits": { + "smithy.api#documentation": "

The values of job template parameters to start a job run.

" + } + }, + "retryPolicyConfiguration": { + "target": "com.amazonaws.emrcontainers#RetryPolicyConfiguration", + "traits": { + "smithy.api#documentation": "

The retry policy configuration for the job run.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#StartJobRunResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

This output displays the started job run ID.

" + } + }, + "name": { + "target": "com.amazonaws.emrcontainers#ResourceNameString", + "traits": { + "smithy.api#documentation": "

This output displays the name of the started job run.

" + } + }, + "arn": { + "target": "com.amazonaws.emrcontainers#JobArn", + "traits": { + "smithy.api#documentation": "

This output lists the ARN of job run.

" + } + }, + "virtualClusterId": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

This output displays the virtual cluster ID for which the job run was submitted.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.emrcontainers#String1024": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.emrcontainers#String128": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.emrcontainers#String2048": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.emrcontainers#String256": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.emrcontainers#StringEmpty256": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.emrcontainers#SubnetIds": { + "type": "list", + "member": { + "target": "com.amazonaws.emrcontainers#String256" + } + }, + "com.amazonaws.emrcontainers#TLSCertificateConfiguration": { + "type": "structure", + "members": { + "certificateProviderType": { + "target": "com.amazonaws.emrcontainers#CertificateProviderType", + "traits": { + "smithy.api#documentation": "

The TLS certificate type. Acceptable values: PEM or\n Custom.

" + } + }, + "publicCertificateSecretArn": { + "target": "com.amazonaws.emrcontainers#SecretsManagerArn", + "traits": { + "smithy.api#documentation": "

Secrets Manager ARN that contains the public TLS certificate contents, used for\n communication between the user job and the system job.

" + } + }, + "privateCertificateSecretArn": { + "target": "com.amazonaws.emrcontainers#SecretsManagerArn", + "traits": { + "smithy.api#documentation": "

Secrets Manager ARN that contains the private TLS certificate contents, used for\n communication between the user job and the system job.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configurations related to the TLS certificate for the security configuration.

" + } + }, + "com.amazonaws.emrcontainers#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.emrcontainers#String128" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.emrcontainers#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.emrcontainers#String128" + }, + "value": { + "target": "com.amazonaws.emrcontainers#StringEmpty256" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.emrcontainers#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Assigns tags to resources. A tag is a label that you assign to an Amazon Web Services\n resource. Each tag consists of a key and an optional value, both of which you define. Tags\n enable you to categorize your Amazon Web Services resources by attributes such as purpose,\n owner, or environment. When you have many resources of the same type, you can quickly\n identify a specific resource based on the tags you've assigned to it. For example, you can\n define a set of tags for your Amazon EMR on EKS clusters to help you track each\n cluster's owner and stack level. We recommend that you devise a consistent set of tag keys\n for each resource type. You can then search and filter the resources based on the tags that\n you add.

", + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.emrcontainers#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.emrcontainers#RsiArn", + "traits": { + "smithy.api#documentation": "

The ARN of resources.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.emrcontainers#TagMap", + "traits": { + "smithy.api#documentation": "

The tags assigned to resources.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.emrcontainers#TemplateParameter": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[\\.\\-_/#A-Za-z0-9\\$\\{\\}]+$" + } + }, + "com.amazonaws.emrcontainers#TemplateParameterConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.emrcontainers#TemplateParameterDataType", + "traits": { + "smithy.api#documentation": "

The type of the job template parameter. Allowed values are: ‘STRING’, ‘NUMBER’.

" + } + }, + "defaultValue": { + "target": "com.amazonaws.emrcontainers#String1024", + "traits": { + "smithy.api#documentation": "

The default value for the job template parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of a job template parameter.

" + } + }, + "com.amazonaws.emrcontainers#TemplateParameterConfigurationMap": { + "type": "map", + "key": { + "target": "com.amazonaws.emrcontainers#TemplateParameterName" + }, + "value": { + "target": "com.amazonaws.emrcontainers#TemplateParameterConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.emrcontainers#TemplateParameterDataType": { + "type": "enum", + "members": { + "NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NUMBER" + } + }, + "STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRING" + } + } + } + }, + "com.amazonaws.emrcontainers#TemplateParameterInputMap": { + "type": "map", + "key": { + "target": "com.amazonaws.emrcontainers#TemplateParameterName" + }, + "value": { + "target": "com.amazonaws.emrcontainers#String1024" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.emrcontainers#TemplateParameterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[\\.\\-_\\#A-Za-z0-9]+$" + } + }, + "com.amazonaws.emrcontainers#Token": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#pattern": "^.*\\S.*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.emrcontainers#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes tags from resources.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.emrcontainers#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.emrcontainers#RsiArn", + "traits": { + "smithy.api#documentation": "

The ARN of resources.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.emrcontainers#TagKeyList", + "traits": { + "smithy.api#documentation": "

The tag keys of the resources.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.emrcontainers#UriString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10280 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\r\\n\\t]*$" + } + }, + "com.amazonaws.emrcontainers#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.emrcontainers#String1024" + } + }, + "traits": { + "smithy.api#documentation": "

There are invalid parameters in the client request.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.emrcontainers#VirtualCluster": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the virtual cluster.

" + } + }, + "name": { + "target": "com.amazonaws.emrcontainers#ResourceNameString", + "traits": { + "smithy.api#documentation": "

The name of the virtual cluster.

" + } + }, + "arn": { + "target": "com.amazonaws.emrcontainers#VirtualClusterArn", + "traits": { + "smithy.api#documentation": "

The ARN of the virtual cluster.

" + } + }, + "state": { + "target": "com.amazonaws.emrcontainers#VirtualClusterState", + "traits": { + "smithy.api#documentation": "

The state of the virtual cluster.

" + } + }, + "containerProvider": { + "target": "com.amazonaws.emrcontainers#ContainerProvider", + "traits": { + "smithy.api#documentation": "

The container provider of the virtual cluster.

" + } + }, + "createdAt": { + "target": "com.amazonaws.emrcontainers#Date", + "traits": { + "smithy.api#documentation": "

The date and time when the virtual cluster is created.

" + } + }, + "tags": { + "target": "com.amazonaws.emrcontainers#TagMap", + "traits": { + "smithy.api#documentation": "

The assigned tags of the virtual cluster.

" + } + }, + "securityConfigurationId": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the security configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This entity describes a virtual cluster. A virtual cluster is a Kubernetes namespace\n that Amazon EMR is registered with. Amazon EMR uses virtual clusters to run\n jobs and host endpoints. Multiple virtual clusters can be backed by the same physical\n cluster. However, each virtual cluster maps to one namespace on an Amazon EKS\n cluster. Virtual clusters do not create any active resources that contribute to your bill\n or that require lifecycle management outside the service.

" + } + }, + "com.amazonaws.emrcontainers#VirtualClusterArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 60, + "max": 1024 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):emr-containers:.+:(\\d{12}):\\/virtualclusters\\/[0-9a-zA-Z]+$" + } + }, + "com.amazonaws.emrcontainers#VirtualClusterState": { + "type": "enum", + "members": { + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "TERMINATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TERMINATING" + } + }, + "TERMINATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TERMINATED" + } + }, + "ARRESTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARRESTED" + } + } + } + }, + "com.amazonaws.emrcontainers#VirtualClusterStates": { + "type": "list", + "member": { + "target": "com.amazonaws.emrcontainers#VirtualClusterState" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.emrcontainers#VirtualClusters": { + "type": "list", + "member": { + "target": "com.amazonaws.emrcontainers#VirtualCluster" + } + } + } +} \ No newline at end of file diff --git a/pkg/testdata/codegen/sdk-codegen/aws-models/eventbridge.json b/pkg/testdata/codegen/sdk-codegen/aws-models/eventbridge.json new file mode 100644 index 00000000..e3810dfa --- /dev/null +++ b/pkg/testdata/codegen/sdk-codegen/aws-models/eventbridge.json @@ -0,0 +1,10021 @@ +{ + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.eventbridge#AWSEvents": { + "type": "service", + "version": "2015-10-07", + "operations": [ + { + "target": "com.amazonaws.eventbridge#ActivateEventSource" + }, + { + "target": "com.amazonaws.eventbridge#CancelReplay" + }, + { + "target": "com.amazonaws.eventbridge#CreateApiDestination" + }, + { + "target": "com.amazonaws.eventbridge#CreateArchive" + }, + { + "target": "com.amazonaws.eventbridge#CreateConnection" + }, + { + "target": "com.amazonaws.eventbridge#CreateEndpoint" + }, + { + "target": "com.amazonaws.eventbridge#CreateEventBus" + }, + { + "target": "com.amazonaws.eventbridge#CreatePartnerEventSource" + }, + { + "target": "com.amazonaws.eventbridge#DeactivateEventSource" + }, + { + "target": "com.amazonaws.eventbridge#DeauthorizeConnection" + }, + { + "target": "com.amazonaws.eventbridge#DeleteApiDestination" + }, + { + "target": "com.amazonaws.eventbridge#DeleteArchive" + }, + { + "target": "com.amazonaws.eventbridge#DeleteConnection" + }, + { + "target": "com.amazonaws.eventbridge#DeleteEndpoint" + }, + { + "target": "com.amazonaws.eventbridge#DeleteEventBus" + }, + { + "target": "com.amazonaws.eventbridge#DeletePartnerEventSource" + }, + { + "target": "com.amazonaws.eventbridge#DeleteRule" + }, + { + "target": "com.amazonaws.eventbridge#DescribeApiDestination" + }, + { + "target": "com.amazonaws.eventbridge#DescribeArchive" + }, + { + "target": "com.amazonaws.eventbridge#DescribeConnection" + }, + { + "target": "com.amazonaws.eventbridge#DescribeEndpoint" + }, + { + "target": "com.amazonaws.eventbridge#DescribeEventBus" + }, + { + "target": "com.amazonaws.eventbridge#DescribeEventSource" + }, + { + "target": "com.amazonaws.eventbridge#DescribePartnerEventSource" + }, + { + "target": "com.amazonaws.eventbridge#DescribeReplay" + }, + { + "target": "com.amazonaws.eventbridge#DescribeRule" + }, + { + "target": "com.amazonaws.eventbridge#DisableRule" + }, + { + "target": "com.amazonaws.eventbridge#EnableRule" + }, + { + "target": "com.amazonaws.eventbridge#ListApiDestinations" + }, + { + "target": "com.amazonaws.eventbridge#ListArchives" + }, + { + "target": "com.amazonaws.eventbridge#ListConnections" + }, + { + "target": "com.amazonaws.eventbridge#ListEndpoints" + }, + { + "target": "com.amazonaws.eventbridge#ListEventBuses" + }, + { + "target": "com.amazonaws.eventbridge#ListEventSources" + }, + { + "target": "com.amazonaws.eventbridge#ListPartnerEventSourceAccounts" + }, + { + "target": "com.amazonaws.eventbridge#ListPartnerEventSources" + }, + { + "target": "com.amazonaws.eventbridge#ListReplays" + }, + { + "target": "com.amazonaws.eventbridge#ListRuleNamesByTarget" + }, + { + "target": "com.amazonaws.eventbridge#ListRules" + }, + { + "target": "com.amazonaws.eventbridge#ListTagsForResource" + }, + { + "target": "com.amazonaws.eventbridge#ListTargetsByRule" + }, + { + "target": "com.amazonaws.eventbridge#PutEvents" + }, + { + "target": "com.amazonaws.eventbridge#PutPartnerEvents" + }, + { + "target": "com.amazonaws.eventbridge#PutPermission" + }, + { + "target": "com.amazonaws.eventbridge#PutRule" + }, + { + "target": "com.amazonaws.eventbridge#PutTargets" + }, + { + "target": "com.amazonaws.eventbridge#RemovePermission" + }, + { + "target": "com.amazonaws.eventbridge#RemoveTargets" + }, + { + "target": "com.amazonaws.eventbridge#StartReplay" + }, + { + "target": "com.amazonaws.eventbridge#TagResource" + }, + { + "target": "com.amazonaws.eventbridge#TestEventPattern" + }, + { + "target": "com.amazonaws.eventbridge#UntagResource" + }, + { + "target": "com.amazonaws.eventbridge#UpdateApiDestination" + }, + { + "target": "com.amazonaws.eventbridge#UpdateArchive" + }, + { + "target": "com.amazonaws.eventbridge#UpdateConnection" + }, + { + "target": "com.amazonaws.eventbridge#UpdateEndpoint" + }, + { + "target": "com.amazonaws.eventbridge#UpdateEventBus" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "EventBridge", + "arnNamespace": "events", + "cloudFormationName": "Events", + "cloudTrailEventSource": "events.amazonaws.com", + "endpointPrefix": "events" + }, + "aws.auth#sigv4": { + "name": "events" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "

Amazon EventBridge helps you to respond to state changes in your Amazon Web Services\n resources. When your resources change state, they automatically send events to an event\n stream. You can create rules that match selected events in the stream and route them to\n targets to take action. You can also use rules to take action on a predetermined schedule. For\n example, you can configure rules to:

\n
    \n
  • \n

    Automatically invoke an Lambda function to update DNS entries when an\n event notifies you that Amazon EC2 instance enters the running state.

    \n
    • \n
  • \n

    Direct specific API records from CloudTrail to an Amazon Kinesis\n data stream for detailed analysis of potential security or availability risks.

    \n
    • \n
  • \n

    Periodically invoke a built-in target to create a snapshot of an Amazon EBS\n volume.

    \n
    • \n
\n

For more information about the features of Amazon EventBridge, see the Amazon EventBridge User\n Guide.

", + "smithy.api#title": "Amazon EventBridge", + "smithy.api#xmlNamespace": { + "uri": "http://events.amazonaws.com/doc/2015-10-07" + }, + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + }, + "EndpointId": { + "required": false, + "documentation": "Operation parameter for EndpointId", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "EndpointId" + } + ] + }, + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + }, + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "isValidHostLabel", + "argv": [ + { + "ref": "EndpointId" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": { + "authSchemes": [ + { + "name": "sigv4a", + "signingName": "events", + "signingRegionSet": [ + "*" + ] + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://{EndpointId}.endpoint.events.{PartitionResult#dualStackDnsSuffix}", + "properties": { + "authSchemes": [ + { + "name": "sigv4a", + "signingName": "events", + "signingRegionSet": [ + "*" + ] + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{EndpointId}.endpoint.events.{PartitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "name": "sigv4a", + "signingName": "events", + "signingRegionSet": [ + "*" + ] + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: FIPS is not supported with EventBridge multi-region endpoints.", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "EndpointId must be a valid host label.", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://events-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-gov-east-1" + ] + } + ], + "endpoint": { + "url": "https://events.us-gov-east-1.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-gov-west-1" + ] + } + ], + "endpoint": { + "url": "https://events.us-gov-west-1.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://events-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://events.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://events.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://events.af-south-1.amazonaws.com" + } + }, + "params": { + "Region": "af-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://events.ap-east-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://events.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://events.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://events.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://events.ap-south-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://events.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://events.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://events.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://events.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://events.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://events.eu-north-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://events.eu-south-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://events.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://events.eu-west-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://events.eu-west-3.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://events.me-south-1.amazonaws.com" + } + }, + "params": { + "Region": "me-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://events.sa-east-1.amazonaws.com" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://events.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://events-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://events.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://events-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://events.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://events-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://events.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://events-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://events-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://events.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://events.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://events.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://events-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://events-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://events.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://events.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://events.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://events.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://events.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://events-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://events.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://events.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://events.us-iso-west-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://events-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://events.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://events-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + }, + { + "documentation": "Valid endpointId with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "signingName": "events", + "name": "sigv4a", + "signingRegionSet": [ + "*" + ] + } + ] + }, + "url": "https://abc123.456def.endpoint.events.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1" + }, + "operationName": "PutEvents", + "operationParams": { + "EndpointId": "abc123.456def", + "Entries": [ + { + "DetailType": "detailType", + "Detail": "{ \"test\": [\"test\"] }", + "EventBusName": "my-sdk-app" + } + ] + } + } + ], + "params": { + "EndpointId": "abc123.456def", + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-east-1" + } + }, + { + "documentation": "Valid EndpointId with dualstack disabled and fips enabled", + "expect": { + "error": "Invalid Configuration: FIPS is not supported with EventBridge multi-region endpoints." + }, + "params": { + "EndpointId": "abc123.456def", + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-east-1" + } + }, + { + "documentation": "Valid EndpointId with dualstack enabled and fips enabled", + "expect": { + "error": "Invalid Configuration: FIPS is not supported with EventBridge multi-region endpoints." + }, + "params": { + "EndpointId": "abc123.456def", + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-east-1" + } + }, + { + "documentation": "Invalid EndpointId", + "expect": { + "error": "EndpointId must be a valid host label." + }, + "params": { + "EndpointId": "badactor.com?foo=bar", + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-east-1" + } + }, + { + "documentation": "Invalid EndpointId (empty)", + "expect": { + "error": "EndpointId must be a valid host label." + }, + "params": { + "EndpointId": "", + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-east-1" + } + }, + { + "documentation": "Valid endpointId with fips disabled and dualstack true", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "signingName": "events", + "name": "sigv4a", + "signingRegionSet": [ + "*" + ] + } + ] + }, + "url": "https://abc123.456def.endpoint.events.api.aws" + } + }, + "params": { + "EndpointId": "abc123.456def", + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-east-1" + } + }, + { + "documentation": "Valid endpointId with custom sdk endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "signingName": "events", + "name": "sigv4a", + "signingRegionSet": [ + "*" + ] + } + ] + }, + "url": "https://example.com" + } + }, + "params": { + "EndpointId": "abc123.456def", + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Valid EndpointId with DualStack enabled and partition does not support DualStack", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "EndpointId": "abc123.456def", + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-isob-east-1" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.eventbridge#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.eventbridge#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

You do not have the necessary permissons for this action.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.eventbridge#AccountId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "^\\d{12}$" + } + }, + "com.amazonaws.eventbridge#Action": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^events:[a-zA-Z]+$" + } + }, + "com.amazonaws.eventbridge#ActivateEventSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#ActivateEventSourceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#InvalidStateException" + }, + { + "target": "com.amazonaws.eventbridge#OperationDisabledException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Activates a partner event source that has been deactivated. Once activated, your matching\n event bus will start receiving events from the event source.

" + } + }, + "com.amazonaws.eventbridge#ActivateEventSourceRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.eventbridge#EventSourceName", + "traits": { + "smithy.api#documentation": "

The name of the partner event source to activate.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#ApiDestination": { + "type": "structure", + "members": { + "ApiDestinationArn": { + "target": "com.amazonaws.eventbridge#ApiDestinationArn", + "traits": { + "smithy.api#documentation": "

The ARN of the API destination.

" + } + }, + "Name": { + "target": "com.amazonaws.eventbridge#ApiDestinationName", + "traits": { + "smithy.api#documentation": "

The name of the API destination.

" + } + }, + "ApiDestinationState": { + "target": "com.amazonaws.eventbridge#ApiDestinationState", + "traits": { + "smithy.api#documentation": "

The state of the API destination.

" + } + }, + "ConnectionArn": { + "target": "com.amazonaws.eventbridge#ConnectionArn", + "traits": { + "smithy.api#documentation": "

The ARN of the connection specified for the API destination.

" + } + }, + "InvocationEndpoint": { + "target": "com.amazonaws.eventbridge#HttpsEndpoint", + "traits": { + "smithy.api#documentation": "

The URL to the endpoint for the API destination.

" + } + }, + "HttpMethod": { + "target": "com.amazonaws.eventbridge#ApiDestinationHttpMethod", + "traits": { + "smithy.api#documentation": "

The method to use to connect to the HTTP endpoint.

" + } + }, + "InvocationRateLimitPerSecond": { + "target": "com.amazonaws.eventbridge#ApiDestinationInvocationRateLimitPerSecond", + "traits": { + "smithy.api#documentation": "

The maximum number of invocations per second to send to the HTTP endpoint.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

A time stamp for the time that the API destination was created.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

A time stamp for the time that the API destination was last modified.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about an API destination.

" + } + }, + "com.amazonaws.eventbridge#ApiDestinationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1600 + }, + "smithy.api#pattern": "^arn:aws([a-z]|\\-)*:events:([a-z]|\\d|\\-)*:([0-9]{12})?:api-destination\\/[\\.\\-_A-Za-z0-9]+\\/[\\-A-Za-z0-9]+$" + } + }, + "com.amazonaws.eventbridge#ApiDestinationDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.eventbridge#ApiDestinationHttpMethod": { + "type": "enum", + "members": { + "POST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POST" + } + }, + "GET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GET" + } + }, + "HEAD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HEAD" + } + }, + "OPTIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPTIONS" + } + }, + "PUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PUT" + } + }, + "PATCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PATCH" + } + }, + "DELETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE" + } + } + } + }, + "com.amazonaws.eventbridge#ApiDestinationInvocationRateLimitPerSecond": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.eventbridge#ApiDestinationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[\\.\\-_A-Za-z0-9]+$" + } + }, + "com.amazonaws.eventbridge#ApiDestinationResponseList": { + "type": "list", + "member": { + "target": "com.amazonaws.eventbridge#ApiDestination" + } + }, + "com.amazonaws.eventbridge#ApiDestinationState": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "INACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACTIVE" + } + } + } + }, + "com.amazonaws.eventbridge#AppSyncParameters": { + "type": "structure", + "members": { + "GraphQLOperation": { + "target": "com.amazonaws.eventbridge#GraphQLOperation", + "traits": { + "smithy.api#documentation": "

The GraphQL operation; that is, the query, mutation, or subscription to be parsed and\n executed by the GraphQL service.

\n

For more information, see Operations in the AppSync User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the GraphQL operation to be parsed and executed, if the event target is an\n AppSync API.

" + } + }, + "com.amazonaws.eventbridge#Archive": { + "type": "structure", + "members": { + "ArchiveName": { + "target": "com.amazonaws.eventbridge#ArchiveName", + "traits": { + "smithy.api#documentation": "

The name of the archive.

" + } + }, + "EventSourceArn": { + "target": "com.amazonaws.eventbridge#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the event bus associated with the archive. Only events from this event bus are\n sent to the archive.

" + } + }, + "State": { + "target": "com.amazonaws.eventbridge#ArchiveState", + "traits": { + "smithy.api#documentation": "

The current state of the archive.

" + } + }, + "StateReason": { + "target": "com.amazonaws.eventbridge#ArchiveStateReason", + "traits": { + "smithy.api#documentation": "

A description for the reason that the archive is in the current state.

" + } + }, + "RetentionDays": { + "target": "com.amazonaws.eventbridge#RetentionDays", + "traits": { + "smithy.api#documentation": "

The number of days to retain events in the archive before they are deleted.

" + } + }, + "SizeBytes": { + "target": "com.amazonaws.eventbridge#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The size of the archive, in bytes.

" + } + }, + "EventCount": { + "target": "com.amazonaws.eventbridge#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of events in the archive.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

The time stamp for the time that the archive was created.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An Archive object that contains details about an archive.

" + } + }, + "com.amazonaws.eventbridge#ArchiveArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1600 + }, + "smithy.api#pattern": "^arn:aws([a-z]|\\-)*:events:([a-z]|\\d|\\-)*:([0-9]{12})?:.+\\/.+$" + } + }, + "com.amazonaws.eventbridge#ArchiveDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.eventbridge#ArchiveName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 48 + }, + "smithy.api#pattern": "^[\\.\\-_A-Za-z0-9]+$" + } + }, + "com.amazonaws.eventbridge#ArchiveResponseList": { + "type": "list", + "member": { + "target": "com.amazonaws.eventbridge#Archive" + } + }, + "com.amazonaws.eventbridge#ArchiveState": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + } + } + }, + "com.amazonaws.eventbridge#ArchiveStateReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.eventbridge#Arn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1600 + } + } + }, + "com.amazonaws.eventbridge#AssignPublicIp": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.eventbridge#AuthHeaderParameters": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[ \\t]*[^\\x00-\\x1F:\\x7F]+([ \\t]+[^\\x00-\\x1F:\\x7F]+)*[ \\t]*$" + } + }, + "com.amazonaws.eventbridge#AuthHeaderParametersSensitive": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[ \\t]*[^\\x00-\\x1F:\\x7F]+([ \\t]+[^\\x00-\\x1F:\\x7F]+)*[ \\t]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.eventbridge#AwsVpcConfiguration": { + "type": "structure", + "members": { + "Subnets": { + "target": "com.amazonaws.eventbridge#StringList", + "traits": { + "smithy.api#documentation": "

Specifies the subnets associated with the task. These subnets must all be in the same VPC.\n You can specify as many as 16 subnets.

", + "smithy.api#required": {} + } + }, + "SecurityGroups": { + "target": "com.amazonaws.eventbridge#StringList", + "traits": { + "smithy.api#documentation": "

Specifies the security groups associated with the task. These security groups must all be\n in the same VPC. You can specify as many as five security groups. If you do not specify a\n security group, the default security group for the VPC is used.

" + } + }, + "AssignPublicIp": { + "target": "com.amazonaws.eventbridge#AssignPublicIp", + "traits": { + "smithy.api#documentation": "

Specifies whether the task's elastic network interface receives a public IP address. You\n can specify ENABLED only when LaunchType in\n EcsParameters is set to FARGATE.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This structure specifies the VPC subnets and security groups for the task, and whether a\n public IP address is to be used. This structure is relevant only for ECS tasks that use the\n awsvpc network mode.

" + } + }, + "com.amazonaws.eventbridge#BatchArrayProperties": { + "type": "structure", + "members": { + "Size": { + "target": "com.amazonaws.eventbridge#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The size of the array, if this is an array batch job. Valid values are integers between 2\n and 10,000.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The array properties for the submitted job, such as the size of the array. The array size\n can be between 2 and 10,000. If you specify array properties for a job, it becomes an array\n job. This parameter is used only if the target is an Batch job.

" + } + }, + "com.amazonaws.eventbridge#BatchParameters": { + "type": "structure", + "members": { + "JobDefinition": { + "target": "com.amazonaws.eventbridge#String", + "traits": { + "smithy.api#documentation": "

The ARN or name of the job definition to use if the event target is an Batch job. This job definition must already exist.

", + "smithy.api#required": {} + } + }, + "JobName": { + "target": "com.amazonaws.eventbridge#String", + "traits": { + "smithy.api#documentation": "

The name to use for this execution of the job, if the target is an Batch\n job.

", + "smithy.api#required": {} + } + }, + "ArrayProperties": { + "target": "com.amazonaws.eventbridge#BatchArrayProperties", + "traits": { + "smithy.api#documentation": "

The array properties for the submitted job, such as the size of the array. The array size\n can be between 2 and 10,000. If you specify array properties for a job, it becomes an array\n job. This parameter is used only if the target is an Batch job.

" + } + }, + "RetryStrategy": { + "target": "com.amazonaws.eventbridge#BatchRetryStrategy", + "traits": { + "smithy.api#documentation": "

The retry strategy to use for failed jobs, if the target is an Batch job.\n The retry strategy is the number of times to retry the failed job execution. Valid values are\n 1–10. When you specify a retry strategy here, it overrides the retry strategy defined in the\n job definition.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The custom parameters to be used when the target is an Batch job.

" + } + }, + "com.amazonaws.eventbridge#BatchRetryStrategy": { + "type": "structure", + "members": { + "Attempts": { + "target": "com.amazonaws.eventbridge#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of times to attempt to retry, if the job fails. Valid values are 1–10.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The retry strategy to use for failed jobs, if the target is an Batch job.\n If you specify a retry strategy here, it overrides the retry strategy defined in the job\n definition.

" + } + }, + "com.amazonaws.eventbridge#Boolean": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.eventbridge#CancelReplay": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#CancelReplayRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#CancelReplayResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.eventbridge#IllegalStatusException" + }, + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Cancels the specified replay.

" + } + }, + "com.amazonaws.eventbridge#CancelReplayRequest": { + "type": "structure", + "members": { + "ReplayName": { + "target": "com.amazonaws.eventbridge#ReplayName", + "traits": { + "smithy.api#documentation": "

The name of the replay to cancel.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#CancelReplayResponse": { + "type": "structure", + "members": { + "ReplayArn": { + "target": "com.amazonaws.eventbridge#ReplayArn", + "traits": { + "smithy.api#documentation": "

The ARN of the replay to cancel.

" + } + }, + "State": { + "target": "com.amazonaws.eventbridge#ReplayState", + "traits": { + "smithy.api#documentation": "

The current state of the replay.

" + } + }, + "StateReason": { + "target": "com.amazonaws.eventbridge#ReplayStateReason", + "traits": { + "smithy.api#documentation": "

The reason that the replay is in the current state.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eventbridge#CapacityProvider": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.eventbridge#CapacityProviderStrategy": { + "type": "list", + "member": { + "target": "com.amazonaws.eventbridge#CapacityProviderStrategyItem" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 6 + } + } + }, + "com.amazonaws.eventbridge#CapacityProviderStrategyItem": { + "type": "structure", + "members": { + "capacityProvider": { + "target": "com.amazonaws.eventbridge#CapacityProvider", + "traits": { + "smithy.api#documentation": "

The short name of the capacity provider.

", + "smithy.api#required": {} + } + }, + "weight": { + "target": "com.amazonaws.eventbridge#CapacityProviderStrategyItemWeight", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The weight value designates the relative percentage of the total number of tasks launched\n that should use the specified capacity provider. The weight value is taken into consideration\n after the base value, if defined, is satisfied.

" + } + }, + "base": { + "target": "com.amazonaws.eventbridge#CapacityProviderStrategyItemBase", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The base value designates how many tasks, at a minimum, to run on the specified capacity\n provider. Only one capacity provider in a capacity provider strategy can have a base defined.\n If no value is specified, the default value of 0 is used.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The details of a capacity provider strategy. To learn more, see CapacityProviderStrategyItem in the Amazon ECS API Reference.

" + } + }, + "com.amazonaws.eventbridge#CapacityProviderStrategyItemBase": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 100000 + } + } + }, + "com.amazonaws.eventbridge#CapacityProviderStrategyItemWeight": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 1000 + } + } + }, + "com.amazonaws.eventbridge#ConcurrentModificationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.eventbridge#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

There is concurrent modification on a rule, target, archive, or replay.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.eventbridge#Condition": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.eventbridge#String", + "traits": { + "smithy.api#documentation": "

Specifies the type of condition. Currently the only supported value is\n StringEquals.

", + "smithy.api#required": {} + } + }, + "Key": { + "target": "com.amazonaws.eventbridge#String", + "traits": { + "smithy.api#documentation": "

Specifies the key for the condition. Currently the only supported key is\n aws:PrincipalOrgID.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.eventbridge#String", + "traits": { + "smithy.api#documentation": "

Specifies the value for the key. Currently, this must be the ID of the\n organization.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A JSON string which you can use to limit the event bus permissions you are granting to\n only accounts that fulfill the condition. Currently, the only supported condition is\n membership in a certain Amazon Web Services organization. The string must contain\n Type, Key, and Value fields. The Value\n field specifies the ID of the Amazon Web Services organization. Following is an example value\n for Condition:

\n

\n '{\"Type\" : \"StringEquals\", \"Key\": \"aws:PrincipalOrgID\", \"Value\":\n \"o-1234567890\"}'\n

" + } + }, + "com.amazonaws.eventbridge#Connection": { + "type": "structure", + "members": { + "ConnectionArn": { + "target": "com.amazonaws.eventbridge#ConnectionArn", + "traits": { + "smithy.api#documentation": "

The ARN of the connection.

" + } + }, + "Name": { + "target": "com.amazonaws.eventbridge#ConnectionName", + "traits": { + "smithy.api#documentation": "

The name of the connection.

" + } + }, + "ConnectionState": { + "target": "com.amazonaws.eventbridge#ConnectionState", + "traits": { + "smithy.api#documentation": "

The state of the connection.

" + } + }, + "StateReason": { + "target": "com.amazonaws.eventbridge#ConnectionStateReason", + "traits": { + "smithy.api#documentation": "

The reason that the connection is in the connection state.

" + } + }, + "AuthorizationType": { + "target": "com.amazonaws.eventbridge#ConnectionAuthorizationType", + "traits": { + "smithy.api#documentation": "

The authorization type specified for the connection.

\n \n

OAUTH tokens are refreshed when a 401 or 407 response is returned.

\n " + } + }, + "CreationTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

A time stamp for the time that the connection was created.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

A time stamp for the time that the connection was last modified.

" + } + }, + "LastAuthorizedTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

A time stamp for the time that the connection was last authorized.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a connection.

" + } + }, + "com.amazonaws.eventbridge#ConnectionApiKeyAuthResponseParameters": { + "type": "structure", + "members": { + "ApiKeyName": { + "target": "com.amazonaws.eventbridge#AuthHeaderParameters", + "traits": { + "smithy.api#documentation": "

The name of the header to use for the APIKeyValue used for\n authorization.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the authorization parameters for the connection if API Key is specified as the\n authorization type.

" + } + }, + "com.amazonaws.eventbridge#ConnectionArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1600 + }, + "smithy.api#pattern": "^arn:aws([a-z]|\\-)*:events:([a-z]|\\d|\\-)*:([0-9]{12})?:connection\\/[\\.\\-_A-Za-z0-9]+\\/[\\-A-Za-z0-9]+$" + } + }, + "com.amazonaws.eventbridge#ConnectionAuthResponseParameters": { + "type": "structure", + "members": { + "BasicAuthParameters": { + "target": "com.amazonaws.eventbridge#ConnectionBasicAuthResponseParameters", + "traits": { + "smithy.api#documentation": "

The authorization parameters for Basic authorization.

" + } + }, + "OAuthParameters": { + "target": "com.amazonaws.eventbridge#ConnectionOAuthResponseParameters", + "traits": { + "smithy.api#documentation": "

The OAuth parameters to use for authorization.

" + } + }, + "ApiKeyAuthParameters": { + "target": "com.amazonaws.eventbridge#ConnectionApiKeyAuthResponseParameters", + "traits": { + "smithy.api#documentation": "

The API Key parameters to use for authorization.

" + } + }, + "InvocationHttpParameters": { + "target": "com.amazonaws.eventbridge#ConnectionHttpParameters", + "traits": { + "smithy.api#documentation": "

Additional parameters for the connection that are passed through with every invocation to\n the HTTP endpoint.

" + } + }, + "ConnectivityParameters": { + "target": "com.amazonaws.eventbridge#DescribeConnectionConnectivityParameters", + "traits": { + "smithy.api#documentation": "

For private OAuth authentication endpoints. The parameters EventBridge uses to authenticate against the endpoint.

\n

For more information, see Authorization methods for connections in the \n Amazon EventBridge User Guide\n .

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Tthe authorization parameters to use for the connection.

" + } + }, + "com.amazonaws.eventbridge#ConnectionAuthorizationType": { + "type": "enum", + "members": { + "BASIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BASIC" + } + }, + "OAUTH_CLIENT_CREDENTIALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OAUTH_CLIENT_CREDENTIALS" + } + }, + "API_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "API_KEY" + } + } + } + }, + "com.amazonaws.eventbridge#ConnectionBasicAuthResponseParameters": { + "type": "structure", + "members": { + "Username": { + "target": "com.amazonaws.eventbridge#AuthHeaderParameters", + "traits": { + "smithy.api#documentation": "

The user name to use for Basic authorization.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The authorization parameters for the connection if Basic is specified as the\n authorization type.

" + } + }, + "com.amazonaws.eventbridge#ConnectionBodyParameter": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.eventbridge#String", + "traits": { + "smithy.api#documentation": "

The key for the parameter.

" + } + }, + "Value": { + "target": "com.amazonaws.eventbridge#SensitiveString", + "traits": { + "smithy.api#documentation": "

The value associated with the key.

" + } + }, + "IsValueSecret": { + "target": "com.amazonaws.eventbridge#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether the value is secret.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Additional parameter included in the body. You can include up to 100 additional body\n parameters per request. An event payload cannot exceed 64 KB.

" + } + }, + "com.amazonaws.eventbridge#ConnectionBodyParametersList": { + "type": "list", + "member": { + "target": "com.amazonaws.eventbridge#ConnectionBodyParameter" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.eventbridge#ConnectionDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.eventbridge#ConnectionHeaderParameter": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.eventbridge#HeaderKey", + "traits": { + "smithy.api#documentation": "

The key for the parameter.

" + } + }, + "Value": { + "target": "com.amazonaws.eventbridge#HeaderValueSensitive", + "traits": { + "smithy.api#documentation": "

The value associated with the key.

" + } + }, + "IsValueSecret": { + "target": "com.amazonaws.eventbridge#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether the value is a secret.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Additional parameter included in the header. You can include up to 100 additional header\n parameters per request. An event payload cannot exceed 64 KB.

" + } + }, + "com.amazonaws.eventbridge#ConnectionHeaderParametersList": { + "type": "list", + "member": { + "target": "com.amazonaws.eventbridge#ConnectionHeaderParameter" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.eventbridge#ConnectionHttpParameters": { + "type": "structure", + "members": { + "HeaderParameters": { + "target": "com.amazonaws.eventbridge#ConnectionHeaderParametersList", + "traits": { + "smithy.api#documentation": "

Any additional header parameters for the connection.

" + } + }, + "QueryStringParameters": { + "target": "com.amazonaws.eventbridge#ConnectionQueryStringParametersList", + "traits": { + "smithy.api#documentation": "

Any additional query string parameters for the connection.

" + } + }, + "BodyParameters": { + "target": "com.amazonaws.eventbridge#ConnectionBodyParametersList", + "traits": { + "smithy.api#documentation": "

Any additional body string parameters for the connection.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Any additional parameters for the connection.

" + } + }, + "com.amazonaws.eventbridge#ConnectionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[\\.\\-_A-Za-z0-9]+$" + } + }, + "com.amazonaws.eventbridge#ConnectionOAuthClientResponseParameters": { + "type": "structure", + "members": { + "ClientID": { + "target": "com.amazonaws.eventbridge#AuthHeaderParameters", + "traits": { + "smithy.api#documentation": "

The client ID associated with the response to the connection request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The client response parameters for the connection when OAuth is specified as the\n authorization type.

" + } + }, + "com.amazonaws.eventbridge#ConnectionOAuthHttpMethod": { + "type": "enum", + "members": { + "GET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GET" + } + }, + "POST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POST" + } + }, + "PUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PUT" + } + } + } + }, + "com.amazonaws.eventbridge#ConnectionOAuthResponseParameters": { + "type": "structure", + "members": { + "ClientParameters": { + "target": "com.amazonaws.eventbridge#ConnectionOAuthClientResponseParameters", + "traits": { + "smithy.api#documentation": "

Details about the client parameters returned when OAuth is specified as the authorization type.

" + } + }, + "AuthorizationEndpoint": { + "target": "com.amazonaws.eventbridge#HttpsEndpoint", + "traits": { + "smithy.api#documentation": "

The URL to the HTTP endpoint that authorized the request.

" + } + }, + "HttpMethod": { + "target": "com.amazonaws.eventbridge#ConnectionOAuthHttpMethod", + "traits": { + "smithy.api#documentation": "

The method used to connect to the HTTP endpoint.

" + } + }, + "OAuthHttpParameters": { + "target": "com.amazonaws.eventbridge#ConnectionHttpParameters", + "traits": { + "smithy.api#documentation": "

The additional HTTP parameters used for the OAuth authorization request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The response parameters when OAuth is specified as the authorization type.

" + } + }, + "com.amazonaws.eventbridge#ConnectionQueryStringParameter": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.eventbridge#QueryStringKey", + "traits": { + "smithy.api#documentation": "

The key for a query string parameter.

" + } + }, + "Value": { + "target": "com.amazonaws.eventbridge#QueryStringValueSensitive", + "traits": { + "smithy.api#documentation": "

The value associated with the key for the query string parameter.

" + } + }, + "IsValueSecret": { + "target": "com.amazonaws.eventbridge#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether the value is secret.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Any additional query string parameter for the connection. You can include up to 100 additional\n query string parameters per request. Each additional parameter counts towards the event\n payload size, which cannot exceed 64 KB.

" + } + }, + "com.amazonaws.eventbridge#ConnectionQueryStringParametersList": { + "type": "list", + "member": { + "target": "com.amazonaws.eventbridge#ConnectionQueryStringParameter" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.eventbridge#ConnectionResponseList": { + "type": "list", + "member": { + "target": "com.amazonaws.eventbridge#Connection" + } + }, + "com.amazonaws.eventbridge#ConnectionState": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "AUTHORIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTHORIZED" + } + }, + "DEAUTHORIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEAUTHORIZED" + } + }, + "AUTHORIZING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTHORIZING" + } + }, + "DEAUTHORIZING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEAUTHORIZING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "FAILED_CONNECTIVITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED_CONNECTIVITY" + } + } + } + }, + "com.amazonaws.eventbridge#ConnectionStateReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.eventbridge#ConnectivityResourceConfigurationArn": { + "type": "structure", + "members": { + "ResourceConfigurationArn": { + "target": "com.amazonaws.eventbridge#ResourceConfigurationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource configuration for the resource endpoint.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource configuration for the resource endpoint.

" + } + }, + "com.amazonaws.eventbridge#ConnectivityResourceParameters": { + "type": "structure", + "members": { + "ResourceParameters": { + "target": "com.amazonaws.eventbridge#ConnectivityResourceConfigurationArn", + "traits": { + "smithy.api#documentation": "

The parameters for EventBridge to use when invoking the resource endpoint.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters for EventBridge to use when invoking the resource endpoint.

" + } + }, + "com.amazonaws.eventbridge#CreateApiDestination": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#CreateApiDestinationRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#CreateApiDestinationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#LimitExceededException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an API destination, which is an HTTP invocation endpoint configured as a target\n for events.

\n

API destinations do not support private destinations, such as interface VPC\n endpoints.

\n

For more information, see API destinations in the\n EventBridge User Guide.

" + } + }, + "com.amazonaws.eventbridge#CreateApiDestinationRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.eventbridge#ApiDestinationName", + "traits": { + "smithy.api#documentation": "

The name for the API destination to create.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.eventbridge#ApiDestinationDescription", + "traits": { + "smithy.api#documentation": "

A description for the API destination to create.

" + } + }, + "ConnectionArn": { + "target": "com.amazonaws.eventbridge#ConnectionArn", + "traits": { + "smithy.api#documentation": "

The ARN of the connection to use for the API destination. The destination endpoint must\n support the authorization type specified for the connection.

", + "smithy.api#required": {} + } + }, + "InvocationEndpoint": { + "target": "com.amazonaws.eventbridge#HttpsEndpoint", + "traits": { + "smithy.api#documentation": "

The URL to the HTTP invocation endpoint for the API destination.

", + "smithy.api#required": {} + } + }, + "HttpMethod": { + "target": "com.amazonaws.eventbridge#ApiDestinationHttpMethod", + "traits": { + "smithy.api#documentation": "

The method to use for the request to the HTTP invocation endpoint.

", + "smithy.api#required": {} + } + }, + "InvocationRateLimitPerSecond": { + "target": "com.amazonaws.eventbridge#ApiDestinationInvocationRateLimitPerSecond", + "traits": { + "smithy.api#documentation": "

The maximum number of requests per second to send to the HTTP invocation endpoint.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#CreateApiDestinationResponse": { + "type": "structure", + "members": { + "ApiDestinationArn": { + "target": "com.amazonaws.eventbridge#ApiDestinationArn", + "traits": { + "smithy.api#documentation": "

The ARN of the API destination that was created by the request.

" + } + }, + "ApiDestinationState": { + "target": "com.amazonaws.eventbridge#ApiDestinationState", + "traits": { + "smithy.api#documentation": "

The state of the API destination that was created by the request.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

A time stamp indicating the time that the API destination was created.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

A time stamp indicating the time that the API destination was last modified.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eventbridge#CreateArchive": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#CreateArchiveRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#CreateArchiveResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#InvalidEventPatternException" + }, + { + "target": "com.amazonaws.eventbridge#LimitExceededException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an archive of events with the specified settings. When you create an archive,\n incoming events might not immediately start being sent to the archive. Allow a short period of\n time for changes to take effect. If you do not specify a pattern to filter events sent to the\n archive, all events are sent to the archive except replayed events. Replayed events are not\n sent to an archive.

\n \n

Archives and schema discovery are not supported for event buses encrypted using a\n customer managed key. EventBridge returns an error if:

\n
    \n
  • \n

    You call \n CreateArchive\n on an event bus set to use a customer managed key for encryption.

    \n
    • \n
  • \n

    You call \n CreateDiscoverer\n on an event bus set to use a customer managed key for encryption.

    \n
    • \n
  • \n

    You call \n UpdatedEventBus\n to set a customer managed key on an event bus with an archives or schema discovery enabled.

    \n
    • \n
\n

To enable archives or schema discovery on an event bus, choose to\n use an Amazon Web Services owned key. For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.

\n " + } + }, + "com.amazonaws.eventbridge#CreateArchiveRequest": { + "type": "structure", + "members": { + "ArchiveName": { + "target": "com.amazonaws.eventbridge#ArchiveName", + "traits": { + "smithy.api#documentation": "

The name for the archive to create.

", + "smithy.api#required": {} + } + }, + "EventSourceArn": { + "target": "com.amazonaws.eventbridge#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the event bus that sends events to the archive.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.eventbridge#ArchiveDescription", + "traits": { + "smithy.api#documentation": "

A description for the archive.

" + } + }, + "EventPattern": { + "target": "com.amazonaws.eventbridge#EventPattern", + "traits": { + "smithy.api#documentation": "

An event pattern to use to filter events sent to the archive.

" + } + }, + "RetentionDays": { + "target": "com.amazonaws.eventbridge#RetentionDays", + "traits": { + "smithy.api#documentation": "

The number of days to retain events for. Default value is 0. If set to 0, events are\n retained indefinitely

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#CreateArchiveResponse": { + "type": "structure", + "members": { + "ArchiveArn": { + "target": "com.amazonaws.eventbridge#ArchiveArn", + "traits": { + "smithy.api#documentation": "

The ARN of the archive that was created.

" + } + }, + "State": { + "target": "com.amazonaws.eventbridge#ArchiveState", + "traits": { + "smithy.api#documentation": "

The state of the archive that was created.

" + } + }, + "StateReason": { + "target": "com.amazonaws.eventbridge#ArchiveStateReason", + "traits": { + "smithy.api#documentation": "

The reason that the archive is in the state.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the archive was created.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eventbridge#CreateConnection": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#CreateConnectionRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#CreateConnectionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#AccessDeniedException" + }, + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#LimitExceededException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eventbridge#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a connection. A connection defines the authorization type and credentials to use\n for authorization with an API destination HTTP endpoint.

\n

For more information, see Connections for endpoint targets in the Amazon EventBridge User Guide.

" + } + }, + "com.amazonaws.eventbridge#CreateConnectionApiKeyAuthRequestParameters": { + "type": "structure", + "members": { + "ApiKeyName": { + "target": "com.amazonaws.eventbridge#AuthHeaderParameters", + "traits": { + "smithy.api#documentation": "

The name of the API key to use for authorization.

", + "smithy.api#required": {} + } + }, + "ApiKeyValue": { + "target": "com.amazonaws.eventbridge#AuthHeaderParametersSensitive", + "traits": { + "smithy.api#documentation": "

The value for the API key to use for authorization.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The API key authorization parameters for the connection.

" + } + }, + "com.amazonaws.eventbridge#CreateConnectionAuthRequestParameters": { + "type": "structure", + "members": { + "BasicAuthParameters": { + "target": "com.amazonaws.eventbridge#CreateConnectionBasicAuthRequestParameters", + "traits": { + "smithy.api#documentation": "

The Basic\n authorization parameters to use for the connection.

" + } + }, + "OAuthParameters": { + "target": "com.amazonaws.eventbridge#CreateConnectionOAuthRequestParameters", + "traits": { + "smithy.api#documentation": "

The OAuth\n authorization parameters to use for the connection.

" + } + }, + "ApiKeyAuthParameters": { + "target": "com.amazonaws.eventbridge#CreateConnectionApiKeyAuthRequestParameters", + "traits": { + "smithy.api#documentation": "

The API\n key authorization parameters to use for the connection.

" + } + }, + "InvocationHttpParameters": { + "target": "com.amazonaws.eventbridge#ConnectionHttpParameters", + "traits": { + "smithy.api#documentation": "

The API key authorization\n parameters to use for the connection. Note that if you include additional parameters for the\n target of a rule via HttpParameters, including query strings, the parameters\n added for the connection take precedence.

" + } + }, + "ConnectivityParameters": { + "target": "com.amazonaws.eventbridge#ConnectivityResourceParameters", + "traits": { + "smithy.api#documentation": "

If you specify a private OAuth endpoint, the parameters for EventBridge to use when authenticating against the endpoint.

\n

For more information, see Authorization methods for connections in the \n Amazon EventBridge User Guide\n .

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The authorization parameters for the connection.

\n

You must include only authorization parameters for the AuthorizationType you specify.

" + } + }, + "com.amazonaws.eventbridge#CreateConnectionBasicAuthRequestParameters": { + "type": "structure", + "members": { + "Username": { + "target": "com.amazonaws.eventbridge#AuthHeaderParameters", + "traits": { + "smithy.api#documentation": "

The user name to use for Basic authorization.

", + "smithy.api#required": {} + } + }, + "Password": { + "target": "com.amazonaws.eventbridge#AuthHeaderParametersSensitive", + "traits": { + "smithy.api#documentation": "

The password associated with the user name to use for Basic authorization.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the Basic authorization parameters to use for the connection.

" + } + }, + "com.amazonaws.eventbridge#CreateConnectionOAuthClientRequestParameters": { + "type": "structure", + "members": { + "ClientID": { + "target": "com.amazonaws.eventbridge#AuthHeaderParameters", + "traits": { + "smithy.api#documentation": "

The client ID to use for OAuth authorization for the connection.

", + "smithy.api#required": {} + } + }, + "ClientSecret": { + "target": "com.amazonaws.eventbridge#AuthHeaderParametersSensitive", + "traits": { + "smithy.api#documentation": "

The client secret associated with the client ID to use for OAuth authorization for the\n connection.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The Basic authorization parameters to use for the connection.

" + } + }, + "com.amazonaws.eventbridge#CreateConnectionOAuthRequestParameters": { + "type": "structure", + "members": { + "ClientParameters": { + "target": "com.amazonaws.eventbridge#CreateConnectionOAuthClientRequestParameters", + "traits": { + "smithy.api#documentation": "

The client parameters for OAuth authorization.

", + "smithy.api#required": {} + } + }, + "AuthorizationEndpoint": { + "target": "com.amazonaws.eventbridge#HttpsEndpoint", + "traits": { + "smithy.api#documentation": "

The URL to the authorization endpoint when OAuth is specified as the authorization\n type.

", + "smithy.api#required": {} + } + }, + "HttpMethod": { + "target": "com.amazonaws.eventbridge#ConnectionOAuthHttpMethod", + "traits": { + "smithy.api#documentation": "

The method to use for the authorization request.

", + "smithy.api#required": {} + } + }, + "OAuthHttpParameters": { + "target": "com.amazonaws.eventbridge#ConnectionHttpParameters", + "traits": { + "smithy.api#documentation": "

Details about the additional\n parameters to use for the connection.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the OAuth authorization parameters to use for the connection.

" + } + }, + "com.amazonaws.eventbridge#CreateConnectionRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.eventbridge#ConnectionName", + "traits": { + "smithy.api#documentation": "

The name for the connection to create.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.eventbridge#ConnectionDescription", + "traits": { + "smithy.api#documentation": "

A description for the connection to create.

" + } + }, + "AuthorizationType": { + "target": "com.amazonaws.eventbridge#ConnectionAuthorizationType", + "traits": { + "smithy.api#documentation": "

The type of authorization to use for the connection.

\n \n

OAUTH tokens are refreshed when a 401 or 407 response is returned.

\n ", + "smithy.api#required": {} + } + }, + "AuthParameters": { + "target": "com.amazonaws.eventbridge#CreateConnectionAuthRequestParameters", + "traits": { + "smithy.api#documentation": "

The\n authorization parameters to use to authorize with the endpoint.

\n

You must include only authorization parameters for the AuthorizationType you specify.

", + "smithy.api#required": {} + } + }, + "InvocationConnectivityParameters": { + "target": "com.amazonaws.eventbridge#ConnectivityResourceParameters", + "traits": { + "smithy.api#documentation": "

For connections to private resource endpoints, the parameters to use for invoking the resource endpoint.

\n

For more information, see Connecting to private resources in the \n Amazon EventBridge User Guide\n .

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#CreateConnectionResponse": { + "type": "structure", + "members": { + "ConnectionArn": { + "target": "com.amazonaws.eventbridge#ConnectionArn", + "traits": { + "smithy.api#documentation": "

The ARN of the connection that was created by the request.

" + } + }, + "ConnectionState": { + "target": "com.amazonaws.eventbridge#ConnectionState", + "traits": { + "smithy.api#documentation": "

The state of the connection that was created by the request.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

A time stamp for the time that the connection was created.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

A time stamp for the time that the connection was last updated.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eventbridge#CreateEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#CreateEndpointRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#CreateEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#LimitExceededException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceAlreadyExistsException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a global endpoint. Global endpoints improve your application's availability by\n making it regional-fault tolerant. To do this, you define a primary and secondary Region with\n event buses in each Region. You also create a Amazon Route 53 health check that will\n tell EventBridge to route events to the secondary Region when an \"unhealthy\" state is\n encountered and events will be routed back to the primary Region when the health check reports\n a \"healthy\" state.

" + } + }, + "com.amazonaws.eventbridge#CreateEndpointRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.eventbridge#EndpointName", + "traits": { + "smithy.api#documentation": "

The name of the global endpoint. For example,\n \"Name\":\"us-east-2-custom_bus_A-endpoint\".

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.eventbridge#EndpointDescription", + "traits": { + "smithy.api#documentation": "

A description of the global endpoint.

" + } + }, + "RoutingConfig": { + "target": "com.amazonaws.eventbridge#RoutingConfig", + "traits": { + "smithy.api#documentation": "

Configure the routing policy, including the health check and secondary Region..

", + "smithy.api#required": {} + } + }, + "ReplicationConfig": { + "target": "com.amazonaws.eventbridge#ReplicationConfig", + "traits": { + "smithy.api#documentation": "

Enable or disable event replication. The default state is ENABLED which means\n you must supply a RoleArn. If you don't have a RoleArn or you don't\n want event replication enabled, set the state to DISABLED.

" + } + }, + "EventBuses": { + "target": "com.amazonaws.eventbridge#EndpointEventBusList", + "traits": { + "smithy.api#documentation": "

Define the event buses used.

\n \n

The names of the event buses must be identical in each Region.

\n ", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.eventbridge#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of the role used for replication.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#CreateEndpointResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.eventbridge#EndpointName", + "traits": { + "smithy.api#documentation": "

The name of the endpoint that was created by this request.

" + } + }, + "Arn": { + "target": "com.amazonaws.eventbridge#EndpointArn", + "traits": { + "smithy.api#documentation": "

The ARN of the endpoint that was created by this request.

" + } + }, + "RoutingConfig": { + "target": "com.amazonaws.eventbridge#RoutingConfig", + "traits": { + "smithy.api#documentation": "

The routing configuration defined by this request.

" + } + }, + "ReplicationConfig": { + "target": "com.amazonaws.eventbridge#ReplicationConfig", + "traits": { + "smithy.api#documentation": "

Whether event replication was enabled or disabled by this request.

" + } + }, + "EventBuses": { + "target": "com.amazonaws.eventbridge#EndpointEventBusList", + "traits": { + "smithy.api#documentation": "

The event buses used by this request.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.eventbridge#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of the role used by event replication for this request.

" + } + }, + "State": { + "target": "com.amazonaws.eventbridge#EndpointState", + "traits": { + "smithy.api#documentation": "

The state of the endpoint that was created by this request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eventbridge#CreateEventBus": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#CreateEventBusRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#CreateEventBusResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#InvalidStateException" + }, + { + "target": "com.amazonaws.eventbridge#LimitExceededException" + }, + { + "target": "com.amazonaws.eventbridge#OperationDisabledException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new event bus within your account. This can be a custom event bus which you can\n use to receive events from your custom applications and services, or it can be a partner event\n bus which can be matched to a partner event source.

" + } + }, + "com.amazonaws.eventbridge#CreateEventBusRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.eventbridge#EventBusName", + "traits": { + "smithy.api#documentation": "

The name of the new event bus.

\n

Custom event bus names can't contain the / character, but you can use the\n / character in partner event bus names. In addition, for partner event buses,\n the name must exactly match the name of the partner event source that this event bus is\n matched to.

\n

You can't use the name default for a custom event bus, as this name is\n already used for your account's default event bus.

", + "smithy.api#required": {} + } + }, + "EventSourceName": { + "target": "com.amazonaws.eventbridge#EventSourceName", + "traits": { + "smithy.api#documentation": "

If you are creating a partner event bus, this specifies the partner event source that the\n new event bus will be matched with.

" + } + }, + "Description": { + "target": "com.amazonaws.eventbridge#EventBusDescription", + "traits": { + "smithy.api#documentation": "

The event bus description.

" + } + }, + "KmsKeyIdentifier": { + "target": "com.amazonaws.eventbridge#KmsKeyIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier of the KMS\n customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on this event bus. The identifier can be the key \n Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.

\n

If you do not specify a customer managed key identifier, EventBridge uses an\n Amazon Web Services owned key to encrypt events on the event bus.

\n

For more information, see Managing keys in the Key Management Service\n Developer Guide.

\n \n

Archives and schema discovery are not supported for event buses encrypted using a\n customer managed key. EventBridge returns an error if:

\n
    \n
  • \n

    You call \n CreateArchive\n on an event bus set to use a customer managed key for encryption.

    \n
    • \n
  • \n

    You call \n CreateDiscoverer\n on an event bus set to use a customer managed key for encryption.

    \n
    • \n
  • \n

    You call \n UpdatedEventBus\n to set a customer managed key on an event bus with an archives or schema discovery enabled.

    \n
    • \n
\n

To enable archives or schema discovery on an event bus, choose to\n use an Amazon Web Services owned key. For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.

\n " + } + }, + "DeadLetterConfig": { + "target": "com.amazonaws.eventbridge#DeadLetterConfig" + }, + "Tags": { + "target": "com.amazonaws.eventbridge#TagList", + "traits": { + "smithy.api#documentation": "

Tags to associate with the event bus.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#CreateEventBusResponse": { + "type": "structure", + "members": { + "EventBusArn": { + "target": "com.amazonaws.eventbridge#String", + "traits": { + "smithy.api#documentation": "

The ARN of the new event bus.

" + } + }, + "Description": { + "target": "com.amazonaws.eventbridge#EventBusDescription", + "traits": { + "smithy.api#documentation": "

The event bus description.

" + } + }, + "KmsKeyIdentifier": { + "target": "com.amazonaws.eventbridge#KmsKeyIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier of the KMS\n customer managed key for EventBridge to use to encrypt events on this event bus, if one has been specified.

\n

For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.

" + } + }, + "DeadLetterConfig": { + "target": "com.amazonaws.eventbridge#DeadLetterConfig" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eventbridge#CreatePartnerEventSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#CreatePartnerEventSourceRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#CreatePartnerEventSourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#LimitExceededException" + }, + { + "target": "com.amazonaws.eventbridge#OperationDisabledException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceAlreadyExistsException" + } + ], + "traits": { + "smithy.api#documentation": "

Called by an SaaS partner to create a partner event source. This operation is not used by\n Amazon Web Services customers.

\n

Each partner event source can be used by one Amazon Web Services account to create a\n matching partner event bus in that Amazon Web Services account. A SaaS partner must create one\n partner event source for each Amazon Web Services account that wants to receive those event\n types.

\n

A partner event source creates events based on resources within the SaaS partner's service\n or application.

\n

An Amazon Web Services account that creates a partner event bus that matches the partner\n event source can use that event bus to receive events from the partner, and then process them\n using Amazon Web Services Events rules and targets.

\n

Partner event source names follow this format:

\n

\n \n partner_name/event_namespace/event_name\n \n

\n
    \n
  • \n

    \n partner_name is determined during partner registration, and\n identifies the partner to Amazon Web Services customers.

    \n
    • \n
  • \n

    \n event_namespace is determined by the partner, and is a way for\n the partner to categorize their events.

    \n
    • \n
  • \n

    \n event_name is determined by the partner, and should uniquely\n identify an event-generating resource within the partner system.

    \n

    The event_name must be unique across all Amazon Web Services\n customers. This is because the event source is a shared resource between the partner and\n customer accounts, and each partner event source unique in the partner account.

    \n
    • \n
\n

The combination of event_namespace and\n event_name should help Amazon Web Services customers decide whether to\n create an event bus to receive these events.

" + } + }, + "com.amazonaws.eventbridge#CreatePartnerEventSourceRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.eventbridge#EventSourceName", + "traits": { + "smithy.api#documentation": "

The name of the partner event source. This name must be unique and must be in the format\n \n partner_name/event_namespace/event_name\n .\n The Amazon Web Services account that wants to use this partner event source must create a\n partner event bus with a name that matches the name of the partner event source.

", + "smithy.api#required": {} + } + }, + "Account": { + "target": "com.amazonaws.eventbridge#AccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID that is permitted to create a matching partner event bus\n for this partner event source.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#CreatePartnerEventSourceResponse": { + "type": "structure", + "members": { + "EventSourceArn": { + "target": "com.amazonaws.eventbridge#String", + "traits": { + "smithy.api#documentation": "

The ARN of the partner event source.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eventbridge#CreatedBy": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.eventbridge#Database": { + "type": "string", + "traits": { + "smithy.api#documentation": "Redshift Database", + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.eventbridge#DbUser": { + "type": "string", + "traits": { + "smithy.api#documentation": "Database user name", + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.eventbridge#DeactivateEventSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#DeactivateEventSourceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#InvalidStateException" + }, + { + "target": "com.amazonaws.eventbridge#OperationDisabledException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

You can use this operation to temporarily stop receiving events from the specified partner\n event source. The matching event bus is not deleted.

\n

When you deactivate a partner event source, the source goes into PENDING state. If it\n remains in PENDING state for more than two weeks, it is deleted.

\n

To activate a deactivated partner event source, use ActivateEventSource.

" + } + }, + "com.amazonaws.eventbridge#DeactivateEventSourceRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.eventbridge#EventSourceName", + "traits": { + "smithy.api#documentation": "

The name of the partner event source to deactivate.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#DeadLetterConfig": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.eventbridge#ResourceArn", + "traits": { + "smithy.api#documentation": "

The ARN of the SQS queue specified as the target for the dead-letter queue.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration details of the Amazon SQS queue for EventBridge to use as a\n dead-letter queue (DLQ).

\n

For more information, see Using dead-letter queues to process undelivered events in the EventBridge User\n Guide.

" + } + }, + "com.amazonaws.eventbridge#DeauthorizeConnection": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#DeauthorizeConnectionRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#DeauthorizeConnectionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes all authorization parameters from the connection. This lets you remove the secret\n from the connection so you can reuse it without having to create a new connection.

" + } + }, + "com.amazonaws.eventbridge#DeauthorizeConnectionRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.eventbridge#ConnectionName", + "traits": { + "smithy.api#documentation": "

The name of the connection to remove authorization from.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#DeauthorizeConnectionResponse": { + "type": "structure", + "members": { + "ConnectionArn": { + "target": "com.amazonaws.eventbridge#ConnectionArn", + "traits": { + "smithy.api#documentation": "

The ARN of the connection that authorization was removed from.

" + } + }, + "ConnectionState": { + "target": "com.amazonaws.eventbridge#ConnectionState", + "traits": { + "smithy.api#documentation": "

The state of the connection.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

A time stamp for the time that the connection was created.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

A time stamp for the time that the connection was last updated.

" + } + }, + "LastAuthorizedTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

A time stamp for the time that the connection was last authorized.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eventbridge#DeleteApiDestination": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#DeleteApiDestinationRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#DeleteApiDestinationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified API destination.

" + } + }, + "com.amazonaws.eventbridge#DeleteApiDestinationRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.eventbridge#ApiDestinationName", + "traits": { + "smithy.api#documentation": "

The name of the destination to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#DeleteApiDestinationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eventbridge#DeleteArchive": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#DeleteArchiveRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#DeleteArchiveResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified archive.

" + } + }, + "com.amazonaws.eventbridge#DeleteArchiveRequest": { + "type": "structure", + "members": { + "ArchiveName": { + "target": "com.amazonaws.eventbridge#ArchiveName", + "traits": { + "smithy.api#documentation": "

The name of the archive to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#DeleteArchiveResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eventbridge#DeleteConnection": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#DeleteConnectionRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#DeleteConnectionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a connection.

" + } + }, + "com.amazonaws.eventbridge#DeleteConnectionRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.eventbridge#ConnectionName", + "traits": { + "smithy.api#documentation": "

The name of the connection to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#DeleteConnectionResponse": { + "type": "structure", + "members": { + "ConnectionArn": { + "target": "com.amazonaws.eventbridge#ConnectionArn", + "traits": { + "smithy.api#documentation": "

The ARN of the connection that was deleted.

" + } + }, + "ConnectionState": { + "target": "com.amazonaws.eventbridge#ConnectionState", + "traits": { + "smithy.api#documentation": "

The state of the connection before it was deleted.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

A time stamp for the time that the connection was created.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

A time stamp for the time that the connection was last modified before it was\n deleted.

" + } + }, + "LastAuthorizedTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

A time stamp for the time that the connection was last authorized before it wa\n deleted.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eventbridge#DeleteEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#DeleteEndpointRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#DeleteEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Delete an existing global endpoint. For more information about global endpoints, see\n Making applications Regional-fault tolerant with global endpoints and event\n replication in the \n Amazon EventBridge User Guide\n .

" + } + }, + "com.amazonaws.eventbridge#DeleteEndpointRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.eventbridge#EndpointName", + "traits": { + "smithy.api#documentation": "

The name of the endpoint you want to delete. For example,\n \"Name\":\"us-east-2-custom_bus_A-endpoint\"..

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#DeleteEndpointResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eventbridge#DeleteEventBus": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#DeleteEventBusRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.eventbridge#InternalException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified custom event bus or partner event bus. All rules associated with\n this event bus need to be deleted. You can't delete your account's default event bus.

" + } + }, + "com.amazonaws.eventbridge#DeleteEventBusRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.eventbridge#EventBusName", + "traits": { + "smithy.api#documentation": "

The name of the event bus to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#DeletePartnerEventSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#DeletePartnerEventSourceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#OperationDisabledException" + } + ], + "traits": { + "smithy.api#documentation": "

This operation is used by SaaS partners to delete a partner event source. This operation\n is not used by Amazon Web Services customers.

\n

When you delete an event source, the status of the corresponding partner event bus in the\n Amazon Web Services customer account becomes DELETED.

\n

" + } + }, + "com.amazonaws.eventbridge#DeletePartnerEventSourceRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.eventbridge#EventSourceName", + "traits": { + "smithy.api#documentation": "

The name of the event source to delete.

", + "smithy.api#required": {} + } + }, + "Account": { + "target": "com.amazonaws.eventbridge#AccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID of the Amazon Web Services customer that the event source\n was created for.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#DeleteRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#DeleteRuleRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#ManagedRuleException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified rule.

\n

Before you can delete the rule, you must remove all targets, using RemoveTargets.

\n

When you delete a rule, incoming events might continue to match to the deleted rule. Allow\n a short period of time for changes to take effect.

\n

If you call delete rule multiple times for the same rule, all calls will succeed. When you\n call delete rule for a non-existent custom eventbus, ResourceNotFoundException is\n returned.

\n

Managed rules are rules created and managed by another Amazon Web Services service on your\n behalf. These rules are created by those other Amazon Web Services services to support\n functionality in those services. You can delete these rules using the Force\n option, but you should do so only if you are sure the other service is not still using that\n rule.

" + } + }, + "com.amazonaws.eventbridge#DeleteRuleRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.eventbridge#RuleName", + "traits": { + "smithy.api#documentation": "

The name of the rule.

", + "smithy.api#required": {} + } + }, + "EventBusName": { + "target": "com.amazonaws.eventbridge#EventBusNameOrArn", + "traits": { + "smithy.api#documentation": "

The name or ARN of the event bus associated with the rule. If you omit this, the default\n event bus is used.

" + } + }, + "Force": { + "target": "com.amazonaws.eventbridge#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

If this is a managed rule, created by an Amazon Web Services service on your behalf, you\n must specify Force as True to delete the rule. This parameter is\n ignored for rules that are not managed rules. You can check whether a rule is a managed rule\n by using DescribeRule or ListRules and checking the\n ManagedBy field of the response.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#DescribeApiDestination": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#DescribeApiDestinationRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#DescribeApiDestinationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves details about an API destination.

" + } + }, + "com.amazonaws.eventbridge#DescribeApiDestinationRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.eventbridge#ApiDestinationName", + "traits": { + "smithy.api#documentation": "

The name of the API destination to retrieve.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#DescribeApiDestinationResponse": { + "type": "structure", + "members": { + "ApiDestinationArn": { + "target": "com.amazonaws.eventbridge#ApiDestinationArn", + "traits": { + "smithy.api#documentation": "

The ARN of the API destination retrieved.

" + } + }, + "Name": { + "target": "com.amazonaws.eventbridge#ApiDestinationName", + "traits": { + "smithy.api#documentation": "

The name of the API destination retrieved.

" + } + }, + "Description": { + "target": "com.amazonaws.eventbridge#ApiDestinationDescription", + "traits": { + "smithy.api#documentation": "

The description for the API destination retrieved.

" + } + }, + "ApiDestinationState": { + "target": "com.amazonaws.eventbridge#ApiDestinationState", + "traits": { + "smithy.api#documentation": "

The state of the API destination retrieved.

" + } + }, + "ConnectionArn": { + "target": "com.amazonaws.eventbridge#ConnectionArn", + "traits": { + "smithy.api#documentation": "

The ARN of the connection specified for the API destination retrieved.

" + } + }, + "InvocationEndpoint": { + "target": "com.amazonaws.eventbridge#HttpsEndpoint", + "traits": { + "smithy.api#documentation": "

The URL to use to connect to the HTTP endpoint.

" + } + }, + "HttpMethod": { + "target": "com.amazonaws.eventbridge#ApiDestinationHttpMethod", + "traits": { + "smithy.api#documentation": "

The method to use to connect to the HTTP endpoint.

" + } + }, + "InvocationRateLimitPerSecond": { + "target": "com.amazonaws.eventbridge#ApiDestinationInvocationRateLimitPerSecond", + "traits": { + "smithy.api#documentation": "

The maximum number of invocations per second to specified for the API destination. Note\n that if you set the invocation rate maximum to a value lower the rate necessary to send all\n events received on to the destination HTTP endpoint, some events may not be delivered within\n the 24-hour retry window. If you plan to set the rate lower than the rate necessary to deliver\n all events, consider using a dead-letter queue to catch events that are not delivered within\n 24 hours.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

A time stamp for the time that the API destination was created.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

A time stamp for the time that the API destination was last modified.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eventbridge#DescribeArchive": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#DescribeArchiveRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#DescribeArchiveResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves details about an archive.

" + } + }, + "com.amazonaws.eventbridge#DescribeArchiveRequest": { + "type": "structure", + "members": { + "ArchiveName": { + "target": "com.amazonaws.eventbridge#ArchiveName", + "traits": { + "smithy.api#documentation": "

The name of the archive to retrieve.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#DescribeArchiveResponse": { + "type": "structure", + "members": { + "ArchiveArn": { + "target": "com.amazonaws.eventbridge#ArchiveArn", + "traits": { + "smithy.api#documentation": "

The ARN of the archive.

" + } + }, + "ArchiveName": { + "target": "com.amazonaws.eventbridge#ArchiveName", + "traits": { + "smithy.api#documentation": "

The name of the archive.

" + } + }, + "EventSourceArn": { + "target": "com.amazonaws.eventbridge#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the event source associated with the archive.

" + } + }, + "Description": { + "target": "com.amazonaws.eventbridge#ArchiveDescription", + "traits": { + "smithy.api#documentation": "

The description of the archive.

" + } + }, + "EventPattern": { + "target": "com.amazonaws.eventbridge#EventPattern", + "traits": { + "smithy.api#documentation": "

The event pattern used to filter events sent to the archive.

" + } + }, + "State": { + "target": "com.amazonaws.eventbridge#ArchiveState", + "traits": { + "smithy.api#documentation": "

The state of the archive.

" + } + }, + "StateReason": { + "target": "com.amazonaws.eventbridge#ArchiveStateReason", + "traits": { + "smithy.api#documentation": "

The reason that the archive is in the state.

" + } + }, + "RetentionDays": { + "target": "com.amazonaws.eventbridge#RetentionDays", + "traits": { + "smithy.api#documentation": "

The number of days to retain events for in the archive.

" + } + }, + "SizeBytes": { + "target": "com.amazonaws.eventbridge#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The size of the archive in bytes.

" + } + }, + "EventCount": { + "target": "com.amazonaws.eventbridge#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of events in the archive.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the archive was created.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eventbridge#DescribeConnection": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#DescribeConnectionRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#DescribeConnectionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves details about a connection.

" + } + }, + "com.amazonaws.eventbridge#DescribeConnectionConnectivityParameters": { + "type": "structure", + "members": { + "ResourceParameters": { + "target": "com.amazonaws.eventbridge#DescribeConnectionResourceParameters", + "traits": { + "smithy.api#documentation": "

The parameters for EventBridge to use when invoking the resource endpoint.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

If the connection uses a private OAuth endpoint, the parameters for EventBridge to use when authenticating against the endpoint.

\n

For more information, see Authorization methods for connections in the \n Amazon EventBridge User Guide\n .

" + } + }, + "com.amazonaws.eventbridge#DescribeConnectionRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.eventbridge#ConnectionName", + "traits": { + "smithy.api#documentation": "

The name of the connection to retrieve.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#DescribeConnectionResourceParameters": { + "type": "structure", + "members": { + "ResourceConfigurationArn": { + "target": "com.amazonaws.eventbridge#ResourceConfigurationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource configuration for the private API.

", + "smithy.api#required": {} + } + }, + "ResourceAssociationArn": { + "target": "com.amazonaws.eventbridge#ResourceAssociationArn", + "traits": { + "smithy.api#documentation": "

For connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API's resource configuration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters for EventBridge to use when invoking the resource endpoint.

" + } + }, + "com.amazonaws.eventbridge#DescribeConnectionResponse": { + "type": "structure", + "members": { + "ConnectionArn": { + "target": "com.amazonaws.eventbridge#ConnectionArn", + "traits": { + "smithy.api#documentation": "

The ARN of the connection retrieved.

" + } + }, + "Name": { + "target": "com.amazonaws.eventbridge#ConnectionName", + "traits": { + "smithy.api#documentation": "

The name of the connection retrieved.

" + } + }, + "Description": { + "target": "com.amazonaws.eventbridge#ConnectionDescription", + "traits": { + "smithy.api#documentation": "

The description for the connection retrieved.

" + } + }, + "InvocationConnectivityParameters": { + "target": "com.amazonaws.eventbridge#DescribeConnectionConnectivityParameters", + "traits": { + "smithy.api#documentation": "

For connections to private resource endpoints. The parameters EventBridge uses to invoke the resource endpoint.

\n

For more information, see Connecting to private resources in the \n Amazon EventBridge User Guide\n .

" + } + }, + "ConnectionState": { + "target": "com.amazonaws.eventbridge#ConnectionState", + "traits": { + "smithy.api#documentation": "

The state of the connection retrieved.

" + } + }, + "StateReason": { + "target": "com.amazonaws.eventbridge#ConnectionStateReason", + "traits": { + "smithy.api#documentation": "

The reason that the connection is in the current connection state.

" + } + }, + "AuthorizationType": { + "target": "com.amazonaws.eventbridge#ConnectionAuthorizationType", + "traits": { + "smithy.api#documentation": "

The type of authorization specified for the connection.

" + } + }, + "SecretArn": { + "target": "com.amazonaws.eventbridge#SecretsManagerSecretArn", + "traits": { + "smithy.api#documentation": "

The ARN of the secret created from the authorization parameters specified for the\n connection.

" + } + }, + "AuthParameters": { + "target": "com.amazonaws.eventbridge#ConnectionAuthResponseParameters", + "traits": { + "smithy.api#documentation": "

The parameters to use for authorization for the connection.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

A time stamp for the time that the connection was created.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

A time stamp for the time that the connection was last modified.

" + } + }, + "LastAuthorizedTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

A time stamp for the time that the connection was last authorized.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eventbridge#DescribeEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#DescribeEndpointRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#DescribeEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Get the information about an existing global endpoint. For more information about global\n endpoints, see Making applications\n Regional-fault tolerant with global endpoints and event replication in the\n \n Amazon EventBridge User Guide\n .

" + } + }, + "com.amazonaws.eventbridge#DescribeEndpointRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.eventbridge#EndpointName", + "traits": { + "smithy.api#documentation": "

The name of the endpoint you want to get information about. For example,\n \"Name\":\"us-east-2-custom_bus_A-endpoint\".

", + "smithy.api#required": {} + } + }, + "HomeRegion": { + "target": "com.amazonaws.eventbridge#HomeRegion", + "traits": { + "smithy.api#documentation": "

The primary Region of the endpoint you want to get information about. For example\n \"HomeRegion\": \"us-east-1\".

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#DescribeEndpointResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.eventbridge#EndpointName", + "traits": { + "smithy.api#documentation": "

The name of the endpoint you asked for information about.

" + } + }, + "Description": { + "target": "com.amazonaws.eventbridge#EndpointDescription", + "traits": { + "smithy.api#documentation": "

The description of the endpoint you asked for information about.

" + } + }, + "Arn": { + "target": "com.amazonaws.eventbridge#EndpointArn", + "traits": { + "smithy.api#documentation": "

The ARN of the endpoint you asked for information about.

" + } + }, + "RoutingConfig": { + "target": "com.amazonaws.eventbridge#RoutingConfig", + "traits": { + "smithy.api#documentation": "

The routing configuration of the endpoint you asked for information about.

" + } + }, + "ReplicationConfig": { + "target": "com.amazonaws.eventbridge#ReplicationConfig", + "traits": { + "smithy.api#documentation": "

Whether replication is enabled or disabled for the endpoint you asked for information\n about.

" + } + }, + "EventBuses": { + "target": "com.amazonaws.eventbridge#EndpointEventBusList", + "traits": { + "smithy.api#documentation": "

The event buses being used by the endpoint you asked for information about.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.eventbridge#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of the role used by the endpoint you asked for information about.

" + } + }, + "EndpointId": { + "target": "com.amazonaws.eventbridge#EndpointId", + "traits": { + "smithy.api#documentation": "

The ID of the endpoint you asked for information about.

" + } + }, + "EndpointUrl": { + "target": "com.amazonaws.eventbridge#EndpointUrl", + "traits": { + "smithy.api#documentation": "

The URL of the endpoint you asked for information about.

" + } + }, + "State": { + "target": "com.amazonaws.eventbridge#EndpointState", + "traits": { + "smithy.api#documentation": "

The current state of the endpoint you asked for information about.

" + } + }, + "StateReason": { + "target": "com.amazonaws.eventbridge#EndpointStateReason", + "traits": { + "smithy.api#documentation": "

The reason the endpoint you asked for information about is in its current state.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the endpoint you asked for information about was created.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

The last time the endpoint you asked for information about was modified.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eventbridge#DescribeEventBus": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#DescribeEventBusRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#DescribeEventBusResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Displays details about an event bus in your account. This can include the external Amazon Web Services accounts that are permitted to write events to your default event bus, and the\n associated policy. For custom event buses and partner event buses, it displays the name, ARN,\n policy, state, and creation time.

\n

To enable your account to receive events from other accounts on its default event bus,\n use PutPermission.

\n

For more information about partner event buses, see CreateEventBus.

" + } + }, + "com.amazonaws.eventbridge#DescribeEventBusRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.eventbridge#EventBusNameOrArn", + "traits": { + "smithy.api#documentation": "

The name or ARN of the event bus to show details for. If you omit this, the default event\n bus is displayed.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#DescribeEventBusResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.eventbridge#String", + "traits": { + "smithy.api#documentation": "

The name of the event bus. Currently, this is always default.

" + } + }, + "Arn": { + "target": "com.amazonaws.eventbridge#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the account permitted to write events to the current account.

" + } + }, + "Description": { + "target": "com.amazonaws.eventbridge#EventBusDescription", + "traits": { + "smithy.api#documentation": "

The event bus description.

" + } + }, + "KmsKeyIdentifier": { + "target": "com.amazonaws.eventbridge#KmsKeyIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier of the KMS\n customer managed key for EventBridge to use to encrypt events on this event bus, if one has been specified.

\n

For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.

" + } + }, + "DeadLetterConfig": { + "target": "com.amazonaws.eventbridge#DeadLetterConfig" + }, + "Policy": { + "target": "com.amazonaws.eventbridge#String", + "traits": { + "smithy.api#documentation": "

The policy that enables the external account to send events to your account.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the event bus was created.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the event bus was last modified.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eventbridge#DescribeEventSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#DescribeEventSourceRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#DescribeEventSourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#OperationDisabledException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

This operation lists details about a partner event source that is shared with your\n account.

" + } + }, + "com.amazonaws.eventbridge#DescribeEventSourceRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.eventbridge#EventSourceName", + "traits": { + "smithy.api#documentation": "

The name of the partner event source to display the details of.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#DescribeEventSourceResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.eventbridge#String", + "traits": { + "smithy.api#documentation": "

The ARN of the partner event source.

" + } + }, + "CreatedBy": { + "target": "com.amazonaws.eventbridge#String", + "traits": { + "smithy.api#documentation": "

The name of the SaaS partner that created the event source.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the event source was created.

" + } + }, + "ExpirationTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the event source will expire if you do not create a matching event\n bus.

" + } + }, + "Name": { + "target": "com.amazonaws.eventbridge#String", + "traits": { + "smithy.api#documentation": "

The name of the partner event source.

" + } + }, + "State": { + "target": "com.amazonaws.eventbridge#EventSourceState", + "traits": { + "smithy.api#documentation": "

The state of the event source. If it is ACTIVE, you have already created a matching event\n bus for this event source, and that event bus is active. If it is PENDING, either you haven't\n yet created a matching event bus, or that event bus is deactivated. If it is DELETED, you have\n created a matching event bus, but the event source has since been deleted.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eventbridge#DescribePartnerEventSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#DescribePartnerEventSourceRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#DescribePartnerEventSourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#OperationDisabledException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

An SaaS partner can use this operation to list details about a partner event source that\n they have created. Amazon Web Services customers do not use this operation. Instead, Amazon Web Services customers can use DescribeEventSource to see details about a partner event source that is shared with\n them.

" + } + }, + "com.amazonaws.eventbridge#DescribePartnerEventSourceRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.eventbridge#EventSourceName", + "traits": { + "smithy.api#documentation": "

The name of the event source to display.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#DescribePartnerEventSourceResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.eventbridge#String", + "traits": { + "smithy.api#documentation": "

The ARN of the event source.

" + } + }, + "Name": { + "target": "com.amazonaws.eventbridge#String", + "traits": { + "smithy.api#documentation": "

The name of the event source.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eventbridge#DescribeReplay": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#DescribeReplayRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#DescribeReplayResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves details about a replay. Use DescribeReplay to determine the\n progress of a running replay. A replay processes events to replay based on the time in the\n event, and replays them using 1 minute intervals. If you use StartReplay and\n specify an EventStartTime and an EventEndTime that covers a 20\n minute time range, the events are replayed from the first minute of that 20 minute range\n first. Then the events from the second minute are replayed. You can use\n DescribeReplay to determine the progress of a replay. The value returned for\n EventLastReplayedTime indicates the time within the specified time range\n associated with the last event replayed.

" + } + }, + "com.amazonaws.eventbridge#DescribeReplayRequest": { + "type": "structure", + "members": { + "ReplayName": { + "target": "com.amazonaws.eventbridge#ReplayName", + "traits": { + "smithy.api#documentation": "

The name of the replay to retrieve.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#DescribeReplayResponse": { + "type": "structure", + "members": { + "ReplayName": { + "target": "com.amazonaws.eventbridge#ReplayName", + "traits": { + "smithy.api#documentation": "

The name of the replay.

" + } + }, + "ReplayArn": { + "target": "com.amazonaws.eventbridge#ReplayArn", + "traits": { + "smithy.api#documentation": "

The ARN of the replay.

" + } + }, + "Description": { + "target": "com.amazonaws.eventbridge#ReplayDescription", + "traits": { + "smithy.api#documentation": "

The description of the replay.

" + } + }, + "State": { + "target": "com.amazonaws.eventbridge#ReplayState", + "traits": { + "smithy.api#documentation": "

The current state of the replay.

" + } + }, + "StateReason": { + "target": "com.amazonaws.eventbridge#ReplayStateReason", + "traits": { + "smithy.api#documentation": "

The reason that the replay is in the current state.

" + } + }, + "EventSourceArn": { + "target": "com.amazonaws.eventbridge#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the archive events were replayed from.

" + } + }, + "Destination": { + "target": "com.amazonaws.eventbridge#ReplayDestination", + "traits": { + "smithy.api#documentation": "

A ReplayDestination object that contains details about the replay.

" + } + }, + "EventStartTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

The time stamp of the first event that was last replayed from the archive.

" + } + }, + "EventEndTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

The time stamp for the last event that was replayed from the archive.

" + } + }, + "EventLastReplayedTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the event was last replayed.

" + } + }, + "ReplayStartTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

A time stamp for the time that the replay started.

" + } + }, + "ReplayEndTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

A time stamp for the time that the replay stopped.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eventbridge#DescribeRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#DescribeRuleRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#DescribeRuleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the specified rule.

\n

DescribeRule does not list the targets of a rule. To see the targets associated with a\n rule, use ListTargetsByRule.

", + "smithy.test#smokeTests": [ + { + "id": "DescribeRuleFailure", + "params": { + "Name": "fake-rule" + }, + "vendorParams": { + "region": "us-west-2" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "failure": {} + } + } + ] + } + }, + "com.amazonaws.eventbridge#DescribeRuleRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.eventbridge#RuleName", + "traits": { + "smithy.api#documentation": "

The name of the rule.

", + "smithy.api#required": {} + } + }, + "EventBusName": { + "target": "com.amazonaws.eventbridge#EventBusNameOrArn", + "traits": { + "smithy.api#documentation": "

The name or ARN of the event bus associated with the rule. If you omit this, the default\n event bus is used.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#DescribeRuleResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.eventbridge#RuleName", + "traits": { + "smithy.api#documentation": "

The name of the rule.

" + } + }, + "Arn": { + "target": "com.amazonaws.eventbridge#RuleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the rule.

" + } + }, + "EventPattern": { + "target": "com.amazonaws.eventbridge#EventPattern", + "traits": { + "smithy.api#documentation": "

The event pattern. For more information, see Events and Event\n Patterns in the \n Amazon EventBridge User Guide\n .

" + } + }, + "ScheduleExpression": { + "target": "com.amazonaws.eventbridge#ScheduleExpression", + "traits": { + "smithy.api#documentation": "

The scheduling expression. For example, \"cron(0 20 * * ? *)\", \"rate(5 minutes)\".

" + } + }, + "State": { + "target": "com.amazonaws.eventbridge#RuleState", + "traits": { + "smithy.api#documentation": "

Specifies whether the rule is enabled or disabled.

" + } + }, + "Description": { + "target": "com.amazonaws.eventbridge#RuleDescription", + "traits": { + "smithy.api#documentation": "

The description of the rule.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.eventbridge#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

" + } + }, + "ManagedBy": { + "target": "com.amazonaws.eventbridge#ManagedBy", + "traits": { + "smithy.api#documentation": "

If this is a managed rule, created by an Amazon Web Services service on your behalf, this\n field displays the principal name of the Amazon Web Services service that created the\n rule.

" + } + }, + "EventBusName": { + "target": "com.amazonaws.eventbridge#EventBusName", + "traits": { + "smithy.api#documentation": "

The name of the event bus associated with the rule.

" + } + }, + "CreatedBy": { + "target": "com.amazonaws.eventbridge#CreatedBy", + "traits": { + "smithy.api#documentation": "

The account ID of the user that created the rule. If you use PutRule to put a\n rule on an event bus in another account, the other account is the owner of the rule, and the\n rule ARN includes the account ID for that account. However, the value for\n CreatedBy is the account ID as the account that created the rule in the other\n account.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eventbridge#DisableRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#DisableRuleRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#ManagedRuleException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Disables the specified rule. A disabled rule won't match any events, and won't\n self-trigger if it has a schedule expression.

\n

When you disable a rule, incoming events might continue to match to the disabled rule.\n Allow a short period of time for changes to take effect.

" + } + }, + "com.amazonaws.eventbridge#DisableRuleRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.eventbridge#RuleName", + "traits": { + "smithy.api#documentation": "

The name of the rule.

", + "smithy.api#required": {} + } + }, + "EventBusName": { + "target": "com.amazonaws.eventbridge#EventBusNameOrArn", + "traits": { + "smithy.api#documentation": "

The name or ARN of the event bus associated with the rule. If you omit this, the default\n event bus is used.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#EcsParameters": { + "type": "structure", + "members": { + "TaskDefinitionArn": { + "target": "com.amazonaws.eventbridge#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the task definition to use if the event target is an Amazon ECS task.

", + "smithy.api#required": {} + } + }, + "TaskCount": { + "target": "com.amazonaws.eventbridge#LimitMin1", + "traits": { + "smithy.api#documentation": "

The number of tasks to create based on TaskDefinition. The default is\n 1.

" + } + }, + "LaunchType": { + "target": "com.amazonaws.eventbridge#LaunchType", + "traits": { + "smithy.api#documentation": "

Specifies the launch type on which your task is running. The launch type that you specify\n here must match one of the launch type (compatibilities) of the target task. The\n FARGATE value is supported only in the Regions where Fargate\n with Amazon ECS is supported. For more information, see Fargate on Amazon ECS in the Amazon Elastic Container Service Developer\n Guide.

" + } + }, + "NetworkConfiguration": { + "target": "com.amazonaws.eventbridge#NetworkConfiguration", + "traits": { + "smithy.api#documentation": "

Use this structure if the Amazon ECS task uses the awsvpc network\n mode. This structure specifies the VPC subnets and security groups associated with the task,\n and whether a public IP address is to be used. This structure is required if\n LaunchType is FARGATE because the awsvpc mode is\n required for Fargate tasks.

\n

If you specify NetworkConfiguration when the target ECS task does not use the\n awsvpc network mode, the task fails.

" + } + }, + "PlatformVersion": { + "target": "com.amazonaws.eventbridge#String", + "traits": { + "smithy.api#documentation": "

Specifies the platform version for the task. Specify only the numeric portion of the\n platform version, such as 1.1.0.

\n

This structure is used only if LaunchType is FARGATE. For more\n information about valid platform versions, see Fargate\n Platform Versions in the Amazon Elastic Container Service Developer\n Guide.

" + } + }, + "Group": { + "target": "com.amazonaws.eventbridge#String", + "traits": { + "smithy.api#documentation": "

Specifies an ECS task group for the task. The maximum length is 255 characters.

" + } + }, + "CapacityProviderStrategy": { + "target": "com.amazonaws.eventbridge#CapacityProviderStrategy", + "traits": { + "smithy.api#documentation": "

The capacity provider strategy to use for the task.

\n

If a capacityProviderStrategy is specified, the launchType\n parameter must be omitted. If no capacityProviderStrategy or launchType is\n specified, the defaultCapacityProviderStrategy for the cluster is used.

" + } + }, + "EnableECSManagedTags": { + "target": "com.amazonaws.eventbridge#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether to enable Amazon ECS managed tags for the task. For more\n information, see Tagging Your Amazon ECS\n Resources in the Amazon Elastic Container Service Developer Guide.

" + } + }, + "EnableExecuteCommand": { + "target": "com.amazonaws.eventbridge#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether or not to enable the execute command functionality for the containers in this\n task. If true, this enables execute command functionality on all containers in the\n task.

" + } + }, + "PlacementConstraints": { + "target": "com.amazonaws.eventbridge#PlacementConstraints", + "traits": { + "smithy.api#documentation": "

An array of placement constraint objects to use for the task. You can specify up to 10\n constraints per task (including constraints in the task definition and those specified at\n runtime).

" + } + }, + "PlacementStrategy": { + "target": "com.amazonaws.eventbridge#PlacementStrategies", + "traits": { + "smithy.api#documentation": "

The placement strategy objects to use for the task. You can specify a maximum of five\n strategy rules per task.

" + } + }, + "PropagateTags": { + "target": "com.amazonaws.eventbridge#PropagateTags", + "traits": { + "smithy.api#documentation": "

Specifies whether to propagate the tags from the task definition to the task. If no value\n is specified, the tags are not propagated. Tags can only be propagated to the task during task\n creation. To add tags to a task after task creation, use the TagResource API action.

" + } + }, + "ReferenceId": { + "target": "com.amazonaws.eventbridge#ReferenceId", + "traits": { + "smithy.api#documentation": "

The reference ID to use for the task.

" + } + }, + "Tags": { + "target": "com.amazonaws.eventbridge#TagList", + "traits": { + "smithy.api#documentation": "

The metadata that you apply to the task to help you categorize and organize them. Each tag\n consists of a key and an optional value, both of which you define. To learn more, see RunTask in the Amazon ECS API Reference.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The custom parameters to be used when the target is an Amazon ECS task.

" + } + }, + "com.amazonaws.eventbridge#EnableRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#EnableRuleRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#ManagedRuleException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Enables the specified rule. If the rule does not exist, the operation fails.

\n

When you enable a rule, incoming events might not immediately start matching to a newly\n enabled rule. Allow a short period of time for changes to take effect.

" + } + }, + "com.amazonaws.eventbridge#EnableRuleRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.eventbridge#RuleName", + "traits": { + "smithy.api#documentation": "

The name of the rule.

", + "smithy.api#required": {} + } + }, + "EventBusName": { + "target": "com.amazonaws.eventbridge#EventBusNameOrArn", + "traits": { + "smithy.api#documentation": "

The name or ARN of the event bus associated with the rule. If you omit this, the default\n event bus is used.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#Endpoint": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.eventbridge#EndpointName", + "traits": { + "smithy.api#documentation": "

The name of the endpoint.

" + } + }, + "Description": { + "target": "com.amazonaws.eventbridge#EndpointDescription", + "traits": { + "smithy.api#documentation": "

A description for the endpoint.

" + } + }, + "Arn": { + "target": "com.amazonaws.eventbridge#EndpointArn", + "traits": { + "smithy.api#documentation": "

The ARN of the endpoint.

" + } + }, + "RoutingConfig": { + "target": "com.amazonaws.eventbridge#RoutingConfig", + "traits": { + "smithy.api#documentation": "

The routing configuration of the endpoint.

" + } + }, + "ReplicationConfig": { + "target": "com.amazonaws.eventbridge#ReplicationConfig", + "traits": { + "smithy.api#documentation": "

Whether event replication was enabled or disabled for this endpoint. The default state is\n ENABLED which means you must supply a RoleArn. If you don't have a\n RoleArn or you don't want event replication enabled, set the state to\n DISABLED.

" + } + }, + "EventBuses": { + "target": "com.amazonaws.eventbridge#EndpointEventBusList", + "traits": { + "smithy.api#documentation": "

The event buses being used by the endpoint.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.eventbridge#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of the role used by event replication for the endpoint.

" + } + }, + "EndpointId": { + "target": "com.amazonaws.eventbridge#EndpointId", + "traits": { + "smithy.api#documentation": "

The URL subdomain of the endpoint. For example, if the URL for Endpoint is\n https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is\n abcde.veo.

" + } + }, + "EndpointUrl": { + "target": "com.amazonaws.eventbridge#EndpointUrl", + "traits": { + "smithy.api#documentation": "

The URL of the endpoint.

" + } + }, + "State": { + "target": "com.amazonaws.eventbridge#EndpointState", + "traits": { + "smithy.api#documentation": "

The current state of the endpoint.

" + } + }, + "StateReason": { + "target": "com.amazonaws.eventbridge#EndpointStateReason", + "traits": { + "smithy.api#documentation": "

The reason the endpoint is in its current state.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the endpoint was created.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

The last time the endpoint was modified.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A global endpoint used to improve your application's availability by making it\n regional-fault tolerant. For more information about global endpoints, see Making\n applications Regional-fault tolerant with global endpoints and event replication in\n the \n Amazon EventBridge User Guide\n .

" + } + }, + "com.amazonaws.eventbridge#EndpointArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1600 + }, + "smithy.api#pattern": "^arn:aws([a-z]|\\-)*:events:([a-z]|\\d|\\-)*:([0-9]{12})?:endpoint\\/[/\\.\\-_A-Za-z0-9]+$" + } + }, + "com.amazonaws.eventbridge#EndpointDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.eventbridge#EndpointEventBus": { + "type": "structure", + "members": { + "EventBusArn": { + "target": "com.amazonaws.eventbridge#NonPartnerEventBusArn", + "traits": { + "smithy.api#documentation": "

The ARN of the event bus the endpoint is associated with.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The event buses the endpoint is associated with.

" + } + }, + "com.amazonaws.eventbridge#EndpointEventBusList": { + "type": "list", + "member": { + "target": "com.amazonaws.eventbridge#EndpointEventBus" + }, + "traits": { + "smithy.api#length": { + "min": 2, + "max": 2 + } + } + }, + "com.amazonaws.eventbridge#EndpointId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#pattern": "^[A-Za-z0-9\\-]+[\\.][A-Za-z0-9\\-]+$" + } + }, + "com.amazonaws.eventbridge#EndpointList": { + "type": "list", + "member": { + "target": "com.amazonaws.eventbridge#Endpoint" + } + }, + "com.amazonaws.eventbridge#EndpointName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[\\.\\-_A-Za-z0-9]+$" + } + }, + "com.amazonaws.eventbridge#EndpointState": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + } + } + }, + "com.amazonaws.eventbridge#EndpointStateReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.eventbridge#EndpointUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^(https://)?[\\.\\-a-z0-9]+$" + } + }, + "com.amazonaws.eventbridge#ErrorCode": { + "type": "string" + }, + "com.amazonaws.eventbridge#ErrorMessage": { + "type": "string" + }, + "com.amazonaws.eventbridge#EventBus": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.eventbridge#String", + "traits": { + "smithy.api#documentation": "

The name of the event bus.

" + } + }, + "Arn": { + "target": "com.amazonaws.eventbridge#String", + "traits": { + "smithy.api#documentation": "

The ARN of the event bus.

" + } + }, + "Description": { + "target": "com.amazonaws.eventbridge#EventBusDescription", + "traits": { + "smithy.api#documentation": "

The event bus description.

" + } + }, + "Policy": { + "target": "com.amazonaws.eventbridge#String", + "traits": { + "smithy.api#documentation": "

The permissions policy of the event bus, describing which other Amazon Web Services\n accounts can write events to this event bus.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the event bus was created.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the event bus was last modified.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An event bus receives events from a source, uses rules to evaluate them, applies any\n configured input transformation, and routes them to the appropriate target(s). Your account's\n default event bus receives events from Amazon Web Services services. A custom event bus can\n receive events from your custom applications and services. A partner event bus receives events\n from an event source created by an SaaS partner. These events come from the partners services\n or applications.

" + } + }, + "com.amazonaws.eventbridge#EventBusDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + } + } + }, + "com.amazonaws.eventbridge#EventBusList": { + "type": "list", + "member": { + "target": "com.amazonaws.eventbridge#EventBus" + } + }, + "com.amazonaws.eventbridge#EventBusName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[/\\.\\-_A-Za-z0-9]+$" + } + }, + "com.amazonaws.eventbridge#EventBusNameOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1600 + }, + "smithy.api#pattern": "^(arn:aws[\\w-]*:events:[a-z]{2}-[a-z]+-[\\w-]+:[0-9]{12}:event-bus\\/)?[/\\.\\-_A-Za-z0-9]+$" + } + }, + "com.amazonaws.eventbridge#EventId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + } + } + }, + "com.amazonaws.eventbridge#EventPattern": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4096 + } + } + }, + "com.amazonaws.eventbridge#EventResource": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + } + } + }, + "com.amazonaws.eventbridge#EventResourceList": { + "type": "list", + "member": { + "target": "com.amazonaws.eventbridge#EventResource" + } + }, + "com.amazonaws.eventbridge#EventSource": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.eventbridge#String", + "traits": { + "smithy.api#documentation": "

The ARN of the event source.

" + } + }, + "CreatedBy": { + "target": "com.amazonaws.eventbridge#String", + "traits": { + "smithy.api#documentation": "

The name of the partner that created the event source.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time the event source was created.

" + } + }, + "ExpirationTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the event source will expire, if the Amazon Web Services account\n doesn't create a matching event bus for it.

" + } + }, + "Name": { + "target": "com.amazonaws.eventbridge#String", + "traits": { + "smithy.api#documentation": "

The name of the event source.

" + } + }, + "State": { + "target": "com.amazonaws.eventbridge#EventSourceState", + "traits": { + "smithy.api#documentation": "

The state of the event source. If it is ACTIVE, you have already created a matching event\n bus for this event source, and that event bus is active. If it is PENDING, either you haven't\n yet created a matching event bus, or that event bus is deactivated. If it is DELETED, you have\n created a matching event bus, but the event source has since been deleted.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A partner event source is created by an SaaS partner. If a customer creates a partner\n event bus that matches this event source, that Amazon Web Services account can receive events\n from the partner's applications or services.

" + } + }, + "com.amazonaws.eventbridge#EventSourceList": { + "type": "list", + "member": { + "target": "com.amazonaws.eventbridge#EventSource" + } + }, + "com.amazonaws.eventbridge#EventSourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^aws\\.partner(/[\\.\\-_A-Za-z0-9]+){2,}$" + } + }, + "com.amazonaws.eventbridge#EventSourceNamePrefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[/\\.\\-_A-Za-z0-9]+$" + } + }, + "com.amazonaws.eventbridge#EventSourceState": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + } + } + }, + "com.amazonaws.eventbridge#EventTime": { + "type": "timestamp" + }, + "com.amazonaws.eventbridge#FailoverConfig": { + "type": "structure", + "members": { + "Primary": { + "target": "com.amazonaws.eventbridge#Primary", + "traits": { + "smithy.api#documentation": "

The main Region of the endpoint.

", + "smithy.api#required": {} + } + }, + "Secondary": { + "target": "com.amazonaws.eventbridge#Secondary", + "traits": { + "smithy.api#documentation": "

The Region that events are routed to when failover is triggered or event replication is\n enabled.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The failover configuration for an endpoint. This includes what triggers failover and what\n happens when it's triggered.

" + } + }, + "com.amazonaws.eventbridge#GraphQLOperation": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1048576 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.eventbridge#HeaderKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^[!#$%&'*+-.^_`|~0-9a-zA-Z]+$" + } + }, + "com.amazonaws.eventbridge#HeaderParametersMap": { + "type": "map", + "key": { + "target": "com.amazonaws.eventbridge#HeaderKey" + }, + "value": { + "target": "com.amazonaws.eventbridge#HeaderValue" + } + }, + "com.amazonaws.eventbridge#HeaderValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^[ \\t]*[\\x20-\\x7E]+([ \\t]+[\\x20-\\x7E]+)*[ \\t]*$" + } + }, + "com.amazonaws.eventbridge#HeaderValueSensitive": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^[ \\t]*[\\x20-\\x7E]+([ \\t]+[\\x20-\\x7E]+)*[ \\t]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.eventbridge#HealthCheck": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1600 + }, + "smithy.api#pattern": "^arn:aws([a-z]|\\-)*:route53:::healthcheck/[\\-a-z0-9]+$" + } + }, + "com.amazonaws.eventbridge#HomeRegion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 9, + "max": 20 + }, + "smithy.api#pattern": "^[\\-a-z0-9]+$" + } + }, + "com.amazonaws.eventbridge#HttpParameters": { + "type": "structure", + "members": { + "PathParameterValues": { + "target": "com.amazonaws.eventbridge#PathParameterList", + "traits": { + "smithy.api#documentation": "

The path parameter values to be used to populate API Gateway API or EventBridge ApiDestination path wildcards (\"*\").

" + } + }, + "HeaderParameters": { + "target": "com.amazonaws.eventbridge#HeaderParametersMap", + "traits": { + "smithy.api#documentation": "

The headers that need to be sent as part of request invoking the API Gateway API or\n EventBridge ApiDestination.

" + } + }, + "QueryStringParameters": { + "target": "com.amazonaws.eventbridge#QueryStringParametersMap", + "traits": { + "smithy.api#documentation": "

The query string keys/values that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

These are custom parameter to be used when the target is an API Gateway APIs or\n EventBridge ApiDestinations. In the latter case, these are merged with any\n InvocationParameters specified on the Connection, with any values from the Connection taking\n precedence.

" + } + }, + "com.amazonaws.eventbridge#HttpsEndpoint": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^((%[0-9A-Fa-f]{2}|[-()_.!~*';/?:@\\x26=+$,A-Za-z0-9])+)([).!';/?:,])?$" + } + }, + "com.amazonaws.eventbridge#IamRoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z-]*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$" + } + }, + "com.amazonaws.eventbridge#IllegalStatusException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.eventbridge#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

An error occurred because a replay can be canceled only when the state is Running or\n Starting.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.eventbridge#InputTransformer": { + "type": "structure", + "members": { + "InputPathsMap": { + "target": "com.amazonaws.eventbridge#TransformerPaths", + "traits": { + "smithy.api#documentation": "

Map of JSON paths to be extracted from the event. You can then insert these in the\n template in InputTemplate to produce the output you want to be sent to the\n target.

\n

\n InputPathsMap is an array key-value pairs, where each value is a valid JSON\n path. You can have as many as 100 key-value pairs. You must use JSON dot notation, not bracket\n notation.

\n

The keys cannot start with \"Amazon Web Services.\"

" + } + }, + "InputTemplate": { + "target": "com.amazonaws.eventbridge#TransformerInput", + "traits": { + "smithy.api#documentation": "

Input template where you specify placeholders that will be filled with the values of the\n keys from InputPathsMap to customize the data sent to the target. Enclose each\n InputPathsMaps value in brackets: <value>

\n

If InputTemplate is a JSON object (surrounded by curly braces), the following\n restrictions apply:

\n
    \n
  • \n

    The placeholder cannot be used as an object key.

    \n
    • \n
\n

The following example shows the syntax for using InputPathsMap and\n InputTemplate.

\n

\n \"InputTransformer\":\n

\n

\n {\n

\n

\n \"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\":\n \"$.detail.status\"},\n

\n

\n \"InputTemplate\": \" is in state \"\n

\n

\n }\n

\n

To have the InputTemplate include quote marks within a JSON string, escape\n each quote marks with a slash, as in the following example:

\n

\n \"InputTransformer\":\n

\n

\n {\n

\n

\n \"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\":\n \"$.detail.status\"},\n

\n

\n \"InputTemplate\": \" is in state \\\"\\\"\"\n

\n

\n }\n

\n

The InputTemplate can also be valid JSON with varibles in quotes or out, as\n in the following example:

\n

\n \"InputTransformer\":\n

\n

\n {\n

\n

\n \"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\":\n \"$.detail.status\"},\n

\n

\n \"InputTemplate\": '{\"myInstance\": ,\"myStatus\": \" is\n in state \\\"\\\"\"}'\n

\n

\n }\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters needed for you to provide custom input to a target based on one or\n more pieces of data extracted from the event.

" + } + }, + "com.amazonaws.eventbridge#InputTransformerPathKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9\\_\\-]+$" + } + }, + "com.amazonaws.eventbridge#Integer": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.eventbridge#InternalException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.eventbridge#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

This exception occurs due to unexpected causes.

", + "smithy.api#error": "server" + } + }, + "com.amazonaws.eventbridge#InvalidEventPatternException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.eventbridge#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The event pattern is not valid.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.eventbridge#InvalidStateException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.eventbridge#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The specified state is not a valid state for an event source.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.eventbridge#KinesisParameters": { + "type": "structure", + "members": { + "PartitionKeyPath": { + "target": "com.amazonaws.eventbridge#TargetPartitionKeyPath", + "traits": { + "smithy.api#documentation": "

The JSON path to be extracted from the event and used as the partition key. For more\n information, see Amazon Kinesis Streams Key\n Concepts in the Amazon Kinesis Streams Developer Guide.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

This object enables you to specify a JSON path to extract from the event and use as the\n partition key for the Amazon Kinesis data stream, so that you can control the shard to which\n the event goes. If you do not include this parameter, the default is to use the\n eventId as the partition key.

" + } + }, + "com.amazonaws.eventbridge#KmsKeyIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + } + } + }, + "com.amazonaws.eventbridge#LaunchType": { + "type": "enum", + "members": { + "EC2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC2" + } + }, + "FARGATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FARGATE" + } + }, + "EXTERNAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXTERNAL" + } + } + } + }, + "com.amazonaws.eventbridge#LimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.eventbridge#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The request failed because it attempted to create resource beyond the allowed service\n quota.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.eventbridge#LimitMax100": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.eventbridge#LimitMin1": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.eventbridge#ListApiDestinations": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#ListApiDestinationsRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#ListApiDestinationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#InternalException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a list of API destination in the account in the current Region.

" + } + }, + "com.amazonaws.eventbridge#ListApiDestinationsRequest": { + "type": "structure", + "members": { + "NamePrefix": { + "target": "com.amazonaws.eventbridge#ApiDestinationName", + "traits": { + "smithy.api#documentation": "

A name prefix to filter results returned. Only API destinations with a name that starts\n with the prefix are returned.

" + } + }, + "ConnectionArn": { + "target": "com.amazonaws.eventbridge#ConnectionArn", + "traits": { + "smithy.api#documentation": "

The ARN of the connection specified for the API destination.

" + } + }, + "NextToken": { + "target": "com.amazonaws.eventbridge#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned by a previous call, which you can use to retrieve the next set of results.

\n

The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using\n the returned token. Keep all other arguments unchanged.

\n

Using an expired pagination token results in an HTTP 400 InvalidToken error.

" + } + }, + "Limit": { + "target": "com.amazonaws.eventbridge#LimitMax100", + "traits": { + "smithy.api#documentation": "

The maximum number of API destinations to include in the response.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#ListApiDestinationsResponse": { + "type": "structure", + "members": { + "ApiDestinations": { + "target": "com.amazonaws.eventbridge#ApiDestinationResponseList", + "traits": { + "smithy.api#documentation": "

An array that includes information about each API\n destination.

" + } + }, + "NextToken": { + "target": "com.amazonaws.eventbridge#NextToken", + "traits": { + "smithy.api#documentation": "

A token indicating there are more results available. If there are no more results, no token is included in the response.

\n

The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using\n the returned token. Keep all other arguments unchanged.

\n

Using an expired pagination token results in an HTTP 400 InvalidToken error.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eventbridge#ListArchives": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#ListArchivesRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#ListArchivesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists your archives. You can either list all the archives or you can provide a prefix to\n match to the archive names. Filter parameters are exclusive.

" + } + }, + "com.amazonaws.eventbridge#ListArchivesRequest": { + "type": "structure", + "members": { + "NamePrefix": { + "target": "com.amazonaws.eventbridge#ArchiveName", + "traits": { + "smithy.api#documentation": "

A name prefix to filter the archives returned. Only archives with name that match the\n prefix are returned.

" + } + }, + "EventSourceArn": { + "target": "com.amazonaws.eventbridge#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the event source associated with the archive.

" + } + }, + "State": { + "target": "com.amazonaws.eventbridge#ArchiveState", + "traits": { + "smithy.api#documentation": "

The state of the archive.

" + } + }, + "NextToken": { + "target": "com.amazonaws.eventbridge#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned by a previous call, which you can use to retrieve the next set of results.

\n

The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using\n the returned token. Keep all other arguments unchanged.

\n

Using an expired pagination token results in an HTTP 400 InvalidToken error.

" + } + }, + "Limit": { + "target": "com.amazonaws.eventbridge#LimitMax100", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#ListArchivesResponse": { + "type": "structure", + "members": { + "Archives": { + "target": "com.amazonaws.eventbridge#ArchiveResponseList", + "traits": { + "smithy.api#documentation": "

An array of Archive objects that include details about an archive.

" + } + }, + "NextToken": { + "target": "com.amazonaws.eventbridge#NextToken", + "traits": { + "smithy.api#documentation": "

A token indicating there are more results available. If there are no more results, no token is included in the response.

\n

The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using\n the returned token. Keep all other arguments unchanged.

\n

Using an expired pagination token results in an HTTP 400 InvalidToken error.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eventbridge#ListConnections": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#ListConnectionsRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#ListConnectionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#InternalException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a list of connections from the account.

" + } + }, + "com.amazonaws.eventbridge#ListConnectionsRequest": { + "type": "structure", + "members": { + "NamePrefix": { + "target": "com.amazonaws.eventbridge#ConnectionName", + "traits": { + "smithy.api#documentation": "

A name prefix to filter results returned. Only connections with a name that starts with\n the prefix are returned.

" + } + }, + "ConnectionState": { + "target": "com.amazonaws.eventbridge#ConnectionState", + "traits": { + "smithy.api#documentation": "

The state of the connection.

" + } + }, + "NextToken": { + "target": "com.amazonaws.eventbridge#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned by a previous call, which you can use to retrieve the next set of results.

\n

The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using\n the returned token. Keep all other arguments unchanged.

\n

Using an expired pagination token results in an HTTP 400 InvalidToken error.

" + } + }, + "Limit": { + "target": "com.amazonaws.eventbridge#LimitMax100", + "traits": { + "smithy.api#documentation": "

The maximum number of connections to return.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#ListConnectionsResponse": { + "type": "structure", + "members": { + "Connections": { + "target": "com.amazonaws.eventbridge#ConnectionResponseList", + "traits": { + "smithy.api#documentation": "

An array of connections objects that include details about the connections.

" + } + }, + "NextToken": { + "target": "com.amazonaws.eventbridge#NextToken", + "traits": { + "smithy.api#documentation": "

A token indicating there are more results available. If there are no more results, no token is included in the response.

\n

The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using\n the returned token. Keep all other arguments unchanged.

\n

Using an expired pagination token results in an HTTP 400 InvalidToken error.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eventbridge#ListEndpoints": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#ListEndpointsRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#ListEndpointsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#InternalException" + } + ], + "traits": { + "smithy.api#documentation": "

List the global endpoints associated with this account. For more information about global\n endpoints, see Making applications\n Regional-fault tolerant with global endpoints and event replication in the\n \n Amazon EventBridge User Guide\n .

" + } + }, + "com.amazonaws.eventbridge#ListEndpointsRequest": { + "type": "structure", + "members": { + "NamePrefix": { + "target": "com.amazonaws.eventbridge#EndpointName", + "traits": { + "smithy.api#documentation": "

A value that will return a subset of the endpoints associated with this account. For\n example, \"NamePrefix\": \"ABC\" will return all endpoints with \"ABC\" in the\n name.

" + } + }, + "HomeRegion": { + "target": "com.amazonaws.eventbridge#HomeRegion", + "traits": { + "smithy.api#documentation": "

The primary Region of the endpoints associated with this account. For example\n \"HomeRegion\": \"us-east-1\".

" + } + }, + "NextToken": { + "target": "com.amazonaws.eventbridge#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned by a previous call, which you can use to retrieve the next set of results.

\n

The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using\n the returned token. Keep all other arguments unchanged.

\n

Using an expired pagination token results in an HTTP 400 InvalidToken error.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.eventbridge#LimitMax100", + "traits": { + "smithy.api#documentation": "

The maximum number of results returned by the call.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#ListEndpointsResponse": { + "type": "structure", + "members": { + "Endpoints": { + "target": "com.amazonaws.eventbridge#EndpointList", + "traits": { + "smithy.api#documentation": "

The endpoints returned by the call.

" + } + }, + "NextToken": { + "target": "com.amazonaws.eventbridge#NextToken", + "traits": { + "smithy.api#documentation": "

A token indicating there are more results available. If there are no more results, no token is included in the response.

\n

The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using\n the returned token. Keep all other arguments unchanged.

\n

Using an expired pagination token results in an HTTP 400 InvalidToken error.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eventbridge#ListEventBuses": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#ListEventBusesRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#ListEventBusesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#InternalException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all the event buses in your account, including the default event bus, custom event\n buses, and partner event buses.

" + } + }, + "com.amazonaws.eventbridge#ListEventBusesRequest": { + "type": "structure", + "members": { + "NamePrefix": { + "target": "com.amazonaws.eventbridge#EventBusName", + "traits": { + "smithy.api#documentation": "

Specifying this limits the results to only those event buses with names that start with\n the specified prefix.

" + } + }, + "NextToken": { + "target": "com.amazonaws.eventbridge#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned by a previous call, which you can use to retrieve the next set of results.

\n

The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using\n the returned token. Keep all other arguments unchanged.

\n

Using an expired pagination token results in an HTTP 400 InvalidToken error.

" + } + }, + "Limit": { + "target": "com.amazonaws.eventbridge#LimitMax100", + "traits": { + "smithy.api#documentation": "

Specifying this limits the number of results returned by this operation. The operation\n also returns a NextToken which you can use in a subsequent operation to retrieve the next set\n of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#ListEventBusesResponse": { + "type": "structure", + "members": { + "EventBuses": { + "target": "com.amazonaws.eventbridge#EventBusList", + "traits": { + "smithy.api#documentation": "

This list of event buses.

" + } + }, + "NextToken": { + "target": "com.amazonaws.eventbridge#NextToken", + "traits": { + "smithy.api#documentation": "

A token indicating there are more results available. If there are no more results, no token is included in the response.

\n

The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using\n the returned token. Keep all other arguments unchanged.

\n

Using an expired pagination token results in an HTTP 400 InvalidToken error.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eventbridge#ListEventSources": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#ListEventSourcesRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#ListEventSourcesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#OperationDisabledException" + } + ], + "traits": { + "smithy.api#documentation": "

You can use this to see all the partner event sources that have been shared with your\n Amazon Web Services account. For more information about partner event sources, see CreateEventBus.

" + } + }, + "com.amazonaws.eventbridge#ListEventSourcesRequest": { + "type": "structure", + "members": { + "NamePrefix": { + "target": "com.amazonaws.eventbridge#EventSourceNamePrefix", + "traits": { + "smithy.api#documentation": "

Specifying this limits the results to only those partner event sources with names that\n start with the specified prefix.

" + } + }, + "NextToken": { + "target": "com.amazonaws.eventbridge#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned by a previous call, which you can use to retrieve the next set of results.

\n

The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using\n the returned token. Keep all other arguments unchanged.

\n

Using an expired pagination token results in an HTTP 400 InvalidToken error.

" + } + }, + "Limit": { + "target": "com.amazonaws.eventbridge#LimitMax100", + "traits": { + "smithy.api#documentation": "

Specifying this limits the number of results returned by this operation. The operation\n also returns a NextToken which you can use in a subsequent operation to retrieve the next set\n of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#ListEventSourcesResponse": { + "type": "structure", + "members": { + "EventSources": { + "target": "com.amazonaws.eventbridge#EventSourceList", + "traits": { + "smithy.api#documentation": "

The list of event sources.

" + } + }, + "NextToken": { + "target": "com.amazonaws.eventbridge#NextToken", + "traits": { + "smithy.api#documentation": "

A token indicating there are more results available. If there are no more results, no token is included in the response.

\n

The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using\n the returned token. Keep all other arguments unchanged.

\n

Using an expired pagination token results in an HTTP 400 InvalidToken error.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eventbridge#ListPartnerEventSourceAccounts": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#ListPartnerEventSourceAccountsRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#ListPartnerEventSourceAccountsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#OperationDisabledException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

An SaaS partner can use this operation to display the Amazon Web Services account ID that a\n particular partner event source name is associated with. This operation is not used by Amazon Web Services customers.

" + } + }, + "com.amazonaws.eventbridge#ListPartnerEventSourceAccountsRequest": { + "type": "structure", + "members": { + "EventSourceName": { + "target": "com.amazonaws.eventbridge#EventSourceName", + "traits": { + "smithy.api#documentation": "

The name of the partner event source to display account information about.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.eventbridge#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned by a previous call, which you can use to retrieve the next set of results.

\n

The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using\n the returned token. Keep all other arguments unchanged.

\n

Using an expired pagination token results in an HTTP 400 InvalidToken error.

" + } + }, + "Limit": { + "target": "com.amazonaws.eventbridge#LimitMax100", + "traits": { + "smithy.api#documentation": "

Specifying this limits the number of results returned by this operation. The operation\n also returns a NextToken which you can use in a subsequent operation to retrieve the next set\n of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#ListPartnerEventSourceAccountsResponse": { + "type": "structure", + "members": { + "PartnerEventSourceAccounts": { + "target": "com.amazonaws.eventbridge#PartnerEventSourceAccountList", + "traits": { + "smithy.api#documentation": "

The list of partner event sources returned by the operation.

" + } + }, + "NextToken": { + "target": "com.amazonaws.eventbridge#NextToken", + "traits": { + "smithy.api#documentation": "

A token indicating there are more results available. If there are no more results, no token is included in the response.

\n

The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using\n the returned token. Keep all other arguments unchanged.

\n

Using an expired pagination token results in an HTTP 400 InvalidToken error.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eventbridge#ListPartnerEventSources": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#ListPartnerEventSourcesRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#ListPartnerEventSourcesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#OperationDisabledException" + } + ], + "traits": { + "smithy.api#documentation": "

An SaaS partner can use this operation to list all the partner event source names that\n they have created. This operation is not used by Amazon Web Services customers.

" + } + }, + "com.amazonaws.eventbridge#ListPartnerEventSourcesRequest": { + "type": "structure", + "members": { + "NamePrefix": { + "target": "com.amazonaws.eventbridge#PartnerEventSourceNamePrefix", + "traits": { + "smithy.api#documentation": "

If you specify this, the results are limited to only those partner event sources that\n start with the string you specify.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.eventbridge#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned by a previous call, which you can use to retrieve the next set of results.

\n

The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using\n the returned token. Keep all other arguments unchanged.

\n

Using an expired pagination token results in an HTTP 400 InvalidToken error.

" + } + }, + "Limit": { + "target": "com.amazonaws.eventbridge#LimitMax100", + "traits": { + "smithy.api#documentation": "

pecifying this limits the number of results returned by this operation. The operation also\n returns a NextToken which you can use in a subsequent operation to retrieve the next set of\n results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#ListPartnerEventSourcesResponse": { + "type": "structure", + "members": { + "PartnerEventSources": { + "target": "com.amazonaws.eventbridge#PartnerEventSourceList", + "traits": { + "smithy.api#documentation": "

The list of partner event sources returned by the operation.

" + } + }, + "NextToken": { + "target": "com.amazonaws.eventbridge#NextToken", + "traits": { + "smithy.api#documentation": "

A token indicating there are more results available. If there are no more results, no token is included in the response.

\n

The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using\n the returned token. Keep all other arguments unchanged.

\n

Using an expired pagination token results in an HTTP 400 InvalidToken error.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eventbridge#ListReplays": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#ListReplaysRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#ListReplaysResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#InternalException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists your replays. You can either list all the replays or you can provide a prefix to\n match to the replay names. Filter parameters are exclusive.

" + } + }, + "com.amazonaws.eventbridge#ListReplaysRequest": { + "type": "structure", + "members": { + "NamePrefix": { + "target": "com.amazonaws.eventbridge#ReplayName", + "traits": { + "smithy.api#documentation": "

A name prefix to filter the replays returned. Only replays with name that match the prefix\n are returned.

" + } + }, + "State": { + "target": "com.amazonaws.eventbridge#ReplayState", + "traits": { + "smithy.api#documentation": "

The state of the replay.

" + } + }, + "EventSourceArn": { + "target": "com.amazonaws.eventbridge#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the archive from which the events are replayed.

" + } + }, + "NextToken": { + "target": "com.amazonaws.eventbridge#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned by a previous call, which you can use to retrieve the next set of results.

\n

The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using\n the returned token. Keep all other arguments unchanged.

\n

Using an expired pagination token results in an HTTP 400 InvalidToken error.

" + } + }, + "Limit": { + "target": "com.amazonaws.eventbridge#LimitMax100", + "traits": { + "smithy.api#documentation": "

The maximum number of replays to retrieve.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#ListReplaysResponse": { + "type": "structure", + "members": { + "Replays": { + "target": "com.amazonaws.eventbridge#ReplayList", + "traits": { + "smithy.api#documentation": "

An array of Replay objects that contain information about the replay.

" + } + }, + "NextToken": { + "target": "com.amazonaws.eventbridge#NextToken", + "traits": { + "smithy.api#documentation": "

A token indicating there are more results available. If there are no more results, no token is included in the response.

\n

The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using\n the returned token. Keep all other arguments unchanged.

\n

Using an expired pagination token results in an HTTP 400 InvalidToken error.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eventbridge#ListRuleNamesByTarget": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#ListRuleNamesByTargetRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#ListRuleNamesByTargetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the rules for the specified target. You can see which of the rules in Amazon\n EventBridge can invoke a specific target in your account.

\n

The maximum number of results per page for requests is 100.

" + } + }, + "com.amazonaws.eventbridge#ListRuleNamesByTargetRequest": { + "type": "structure", + "members": { + "TargetArn": { + "target": "com.amazonaws.eventbridge#TargetArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the target resource.

", + "smithy.api#required": {} + } + }, + "EventBusName": { + "target": "com.amazonaws.eventbridge#EventBusNameOrArn", + "traits": { + "smithy.api#documentation": "

The name or ARN of the event bus to list rules for. If you omit this, the default event\n bus is used.

" + } + }, + "NextToken": { + "target": "com.amazonaws.eventbridge#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned by a previous call, which you can use to retrieve the next set of results.

\n

The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using\n the returned token. Keep all other arguments unchanged.

\n

Using an expired pagination token results in an HTTP 400 InvalidToken error.

" + } + }, + "Limit": { + "target": "com.amazonaws.eventbridge#LimitMax100", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#ListRuleNamesByTargetResponse": { + "type": "structure", + "members": { + "RuleNames": { + "target": "com.amazonaws.eventbridge#RuleNameList", + "traits": { + "smithy.api#documentation": "

The names of the rules that can invoke the given target.

" + } + }, + "NextToken": { + "target": "com.amazonaws.eventbridge#NextToken", + "traits": { + "smithy.api#documentation": "

A token indicating there are more results available. If there are no more results, no token is included in the response.

\n

The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using\n the returned token. Keep all other arguments unchanged.

\n

Using an expired pagination token results in an HTTP 400 InvalidToken error.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eventbridge#ListRules": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#ListRulesRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#ListRulesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists your Amazon EventBridge rules. You can either list all the rules or you can\n provide a prefix to match to the rule names.

\n

The maximum number of results per page for requests is 100.

\n

ListRules does not list the targets of a rule. To see the targets associated with a rule,\n use ListTargetsByRule.

", + "smithy.test#smokeTests": [ + { + "id": "ListRulesSuccess", + "params": {}, + "vendorParams": { + "region": "us-west-2" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "success": {} + } + } + ] + } + }, + "com.amazonaws.eventbridge#ListRulesRequest": { + "type": "structure", + "members": { + "NamePrefix": { + "target": "com.amazonaws.eventbridge#RuleName", + "traits": { + "smithy.api#documentation": "

The prefix matching the rule name.

" + } + }, + "EventBusName": { + "target": "com.amazonaws.eventbridge#EventBusNameOrArn", + "traits": { + "smithy.api#documentation": "

The name or ARN of the event bus to list the rules for. If you omit this, the default\n event bus is used.

" + } + }, + "NextToken": { + "target": "com.amazonaws.eventbridge#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned by a previous call, which you can use to retrieve the next set of results.

\n

The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using\n the returned token. Keep all other arguments unchanged.

\n

Using an expired pagination token results in an HTTP 400 InvalidToken error.

" + } + }, + "Limit": { + "target": "com.amazonaws.eventbridge#LimitMax100", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#ListRulesResponse": { + "type": "structure", + "members": { + "Rules": { + "target": "com.amazonaws.eventbridge#RuleResponseList", + "traits": { + "smithy.api#documentation": "

The rules that match the specified criteria.

" + } + }, + "NextToken": { + "target": "com.amazonaws.eventbridge#NextToken", + "traits": { + "smithy.api#documentation": "

A token indicating there are more results available. If there are no more results, no token is included in the response.

\n

The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using\n the returned token. Keep all other arguments unchanged.

\n

Using an expired pagination token results in an HTTP 400 InvalidToken error.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eventbridge#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Displays the tags associated with an EventBridge resource. In EventBridge, rules and event\n buses can be tagged.

" + } + }, + "com.amazonaws.eventbridge#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.eventbridge#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the EventBridge resource for which you want to view tags.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.eventbridge#TagList", + "traits": { + "smithy.api#documentation": "

The list of tag keys and values associated with the resource you specified

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eventbridge#ListTargetsByRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#ListTargetsByRuleRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#ListTargetsByRuleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the targets assigned to the specified rule.

\n

The maximum number of results per page for requests is 100.

" + } + }, + "com.amazonaws.eventbridge#ListTargetsByRuleRequest": { + "type": "structure", + "members": { + "Rule": { + "target": "com.amazonaws.eventbridge#RuleName", + "traits": { + "smithy.api#documentation": "

The name of the rule.

", + "smithy.api#required": {} + } + }, + "EventBusName": { + "target": "com.amazonaws.eventbridge#EventBusNameOrArn", + "traits": { + "smithy.api#documentation": "

The name or ARN of the event bus associated with the rule. If you omit this, the default\n event bus is used.

" + } + }, + "NextToken": { + "target": "com.amazonaws.eventbridge#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned by a previous call, which you can use to retrieve the next set of results.

\n

The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using\n the returned token. Keep all other arguments unchanged.

\n

Using an expired pagination token results in an HTTP 400 InvalidToken error.

" + } + }, + "Limit": { + "target": "com.amazonaws.eventbridge#LimitMax100", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#ListTargetsByRuleResponse": { + "type": "structure", + "members": { + "Targets": { + "target": "com.amazonaws.eventbridge#TargetList", + "traits": { + "smithy.api#documentation": "

The targets assigned to the rule.

" + } + }, + "NextToken": { + "target": "com.amazonaws.eventbridge#NextToken", + "traits": { + "smithy.api#documentation": "

A token indicating there are more results available. If there are no more results, no token is included in the response.

\n

The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using\n the returned token. Keep all other arguments unchanged.

\n

Using an expired pagination token results in an HTTP 400 InvalidToken error.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eventbridge#Long": { + "type": "long", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.eventbridge#ManagedBy": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.eventbridge#ManagedRuleException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.eventbridge#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

This rule was created by an Amazon Web Services service on behalf of your account. It is\n managed by that service. If you see this error in response to DeleteRule or\n RemoveTargets, you can use the Force parameter in those calls to\n delete the rule or remove targets from the rule. You cannot modify these managed rules by\n using DisableRule, EnableRule, PutTargets,\n PutRule, TagResource, or UntagResource.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.eventbridge#MaximumEventAgeInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 60, + "max": 86400 + } + } + }, + "com.amazonaws.eventbridge#MaximumRetryAttempts": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 185 + } + } + }, + "com.amazonaws.eventbridge#MessageGroupId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.eventbridge#NetworkConfiguration": { + "type": "structure", + "members": { + "awsvpcConfiguration": { + "target": "com.amazonaws.eventbridge#AwsVpcConfiguration", + "traits": { + "smithy.api#documentation": "

Use this structure to specify the VPC subnets and security groups for the task, and\n whether a public IP address is to be used. This structure is relevant only for ECS tasks that\n use the awsvpc network mode.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This structure specifies the network configuration for an ECS task.

" + } + }, + "com.amazonaws.eventbridge#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.eventbridge#NonPartnerEventBusArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^arn:aws[a-z-]*:events:[a-z]{2}-[a-z-]+-\\d+:\\d{12}:event-bus/[\\w.-]+$" + } + }, + "com.amazonaws.eventbridge#NonPartnerEventBusName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[\\.\\-_A-Za-z0-9]+$" + } + }, + "com.amazonaws.eventbridge#NonPartnerEventBusNameOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1600 + }, + "smithy.api#pattern": "^(arn:aws[\\w-]*:events:[a-z]{2}-[a-z]+-[\\w-]+:[0-9]{12}:event-bus\\/)?[\\.\\-_A-Za-z0-9]+$" + } + }, + "com.amazonaws.eventbridge#OperationDisabledException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.eventbridge#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The operation you are attempting is not available in this region.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.eventbridge#PartnerEventSource": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.eventbridge#String", + "traits": { + "smithy.api#documentation": "

The ARN of the partner event source.

" + } + }, + "Name": { + "target": "com.amazonaws.eventbridge#String", + "traits": { + "smithy.api#documentation": "

The name of the partner event source.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A partner event source is created by an SaaS partner. If a customer creates a partner\n event bus that matches this event source, that Amazon Web Services account can receive events\n from the partner's applications or services.

" + } + }, + "com.amazonaws.eventbridge#PartnerEventSourceAccount": { + "type": "structure", + "members": { + "Account": { + "target": "com.amazonaws.eventbridge#AccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID that the partner event source was offered to.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time the event source was created.

" + } + }, + "ExpirationTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the event source will expire, if the Amazon Web Services account\n doesn't create a matching event bus for it.

" + } + }, + "State": { + "target": "com.amazonaws.eventbridge#EventSourceState", + "traits": { + "smithy.api#documentation": "

The state of the event source. If it is ACTIVE, you have already created a matching event\n bus for this event source, and that event bus is active. If it is PENDING, either you haven't\n yet created a matching event bus, or that event bus is deactivated. If it is DELETED, you have\n created a matching event bus, but the event source has since been deleted.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account that a partner event source has been offered to.

" + } + }, + "com.amazonaws.eventbridge#PartnerEventSourceAccountList": { + "type": "list", + "member": { + "target": "com.amazonaws.eventbridge#PartnerEventSourceAccount" + } + }, + "com.amazonaws.eventbridge#PartnerEventSourceList": { + "type": "list", + "member": { + "target": "com.amazonaws.eventbridge#PartnerEventSource" + } + }, + "com.amazonaws.eventbridge#PartnerEventSourceNamePrefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^aws\\.partner/[\\.\\-_A-Za-z0-9]+/[/\\.\\-_A-Za-z0-9]*$" + } + }, + "com.amazonaws.eventbridge#PathParameter": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(?!\\s*$).+$" + } + }, + "com.amazonaws.eventbridge#PathParameterList": { + "type": "list", + "member": { + "target": "com.amazonaws.eventbridge#PathParameter" + } + }, + "com.amazonaws.eventbridge#PlacementConstraint": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.eventbridge#PlacementConstraintType", + "traits": { + "smithy.api#documentation": "

The type of constraint. Use distinctInstance to ensure that each task in a particular\n group is running on a different container instance. Use memberOf to restrict the selection to\n a group of valid candidates.

" + } + }, + "expression": { + "target": "com.amazonaws.eventbridge#PlacementConstraintExpression", + "traits": { + "smithy.api#documentation": "

A cluster query language expression to apply to the constraint. You cannot specify an\n expression if the constraint type is distinctInstance. To learn more, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object representing a constraint on task placement. To learn more, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide.

" + } + }, + "com.amazonaws.eventbridge#PlacementConstraintExpression": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2000 + } + } + }, + "com.amazonaws.eventbridge#PlacementConstraintType": { + "type": "enum", + "members": { + "DISTINCT_INSTANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "distinctInstance" + } + }, + "MEMBER_OF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "memberOf" + } + } + } + }, + "com.amazonaws.eventbridge#PlacementConstraints": { + "type": "list", + "member": { + "target": "com.amazonaws.eventbridge#PlacementConstraint" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.eventbridge#PlacementStrategies": { + "type": "list", + "member": { + "target": "com.amazonaws.eventbridge#PlacementStrategy" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.eventbridge#PlacementStrategy": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.eventbridge#PlacementStrategyType", + "traits": { + "smithy.api#documentation": "

The type of placement strategy. The random placement strategy randomly places tasks on\n available candidates. The spread placement strategy spreads placement across available\n candidates evenly based on the field parameter. The binpack strategy places tasks on available\n candidates that have the least available amount of the resource that is specified with the\n field parameter. For example, if you binpack on memory, a task is placed on the instance with\n the least amount of remaining memory (but still enough to run the task).

" + } + }, + "field": { + "target": "com.amazonaws.eventbridge#PlacementStrategyField", + "traits": { + "smithy.api#documentation": "

The field to apply the placement strategy against. For the spread placement strategy,\n valid values are instanceId (or host, which has the same effect), or any platform or custom\n attribute that is applied to a container instance, such as attribute:ecs.availability-zone.\n For the binpack placement strategy, valid values are cpu and memory. For the random placement\n strategy, this field is not used.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The task placement strategy for a task or service. To learn more, see Task Placement Strategies in the Amazon Elastic Container Service Service Developer\n Guide.

" + } + }, + "com.amazonaws.eventbridge#PlacementStrategyField": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + } + } + }, + "com.amazonaws.eventbridge#PlacementStrategyType": { + "type": "enum", + "members": { + "RANDOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "random" + } + }, + "SPREAD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "spread" + } + }, + "BINPACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "binpack" + } + } + } + }, + "com.amazonaws.eventbridge#PolicyLengthExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.eventbridge#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The event bus policy is too long. For more information, see the limits.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.eventbridge#Primary": { + "type": "structure", + "members": { + "HealthCheck": { + "target": "com.amazonaws.eventbridge#HealthCheck", + "traits": { + "smithy.api#documentation": "

The ARN of the health check used by the endpoint to determine whether failover is\n triggered.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The primary Region of the endpoint.

" + } + }, + "com.amazonaws.eventbridge#Principal": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 12 + }, + "smithy.api#pattern": "^(\\d{12}|\\*)$" + } + }, + "com.amazonaws.eventbridge#PropagateTags": { + "type": "enum", + "members": { + "TASK_DEFINITION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TASK_DEFINITION" + } + } + } + }, + "com.amazonaws.eventbridge#PutEvents": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#PutEventsRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#PutEventsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#InternalException" + } + ], + "traits": { + "smithy.api#documentation": "

Sends custom events to Amazon EventBridge so that they can be matched to rules.

\n

The maximum size for a PutEvents event entry is 256 KB. Entry size is calculated including\n the event and any necessary characters and keys of the JSON representation of the event. To\n learn more, see Calculating PutEvents event entry\n size in the \n Amazon EventBridge User Guide\n \n

\n

PutEvents accepts the data in JSON format. For the JSON number (integer) data type, the\n constraints are: a minimum value of -9,223,372,036,854,775,808 and a maximum value of\n 9,223,372,036,854,775,807.

\n \n

PutEvents will only process nested JSON up to 1000 levels deep.

\n " + } + }, + "com.amazonaws.eventbridge#PutEventsRequest": { + "type": "structure", + "members": { + "Entries": { + "target": "com.amazonaws.eventbridge#PutEventsRequestEntryList", + "traits": { + "smithy.api#documentation": "

The entry that defines an event in your system. You can specify several parameters for the\n entry such as the source and type of the event, resources associated with the event, and so\n on.

", + "smithy.api#required": {} + } + }, + "EndpointId": { + "target": "com.amazonaws.eventbridge#EndpointId", + "traits": { + "smithy.api#documentation": "

The URL subdomain of the endpoint. For example, if the URL for Endpoint is\n https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is\n abcde.veo.

\n \n

When using Java, you must include auth-crt on the class path.

\n ", + "smithy.rules#contextParam": { + "name": "EndpointId" + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#PutEventsRequestEntry": { + "type": "structure", + "members": { + "Time": { + "target": "com.amazonaws.eventbridge#EventTime", + "traits": { + "smithy.api#documentation": "

The time stamp of the event, per RFC3339. If no time stamp is provided, the time stamp of the PutEvents call is used.

" + } + }, + "Source": { + "target": "com.amazonaws.eventbridge#String", + "traits": { + "smithy.api#documentation": "

The source of the event.

\n \n

\n Detail, DetailType, and Source are required for EventBridge to successfully send an event to an event bus. \n If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. \n If you submit a request in which none of the entries have each of these properties, EventBridge fails the entire request.\n

\n " + } + }, + "Resources": { + "target": "com.amazonaws.eventbridge#EventResourceList", + "traits": { + "smithy.api#documentation": "

Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns.\n Any number, including zero, may be present.

" + } + }, + "DetailType": { + "target": "com.amazonaws.eventbridge#String", + "traits": { + "smithy.api#documentation": "

Free-form string, with a maximum of 128 characters, used to decide what fields to expect\n in the event detail.

\n \n

\n Detail, DetailType, and Source are required for EventBridge to successfully send an event to an event bus. \n If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. \n If you submit a request in which none of the entries have each of these properties, EventBridge fails the entire request.\n

\n " + } + }, + "Detail": { + "target": "com.amazonaws.eventbridge#String", + "traits": { + "smithy.api#documentation": "

A valid JSON object. There is no other schema imposed. The JSON object may contain fields\n and nested sub-objects.

\n \n

\n Detail, DetailType, and Source are required for EventBridge to successfully send an event to an event bus. \n If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. \n If you submit a request in which none of the entries have each of these properties, EventBridge fails the entire request.\n

\n " + } + }, + "EventBusName": { + "target": "com.amazonaws.eventbridge#NonPartnerEventBusNameOrArn", + "traits": { + "smithy.api#documentation": "

The name or ARN of the event bus to receive the event. Only the rules that are associated\n with this event bus are used to match the event. If you omit this, the default event bus is\n used.

\n \n

If you're using a global endpoint with a custom bus, you can enter either the name or\n Amazon Resource Name (ARN) of the event bus in either the primary or secondary Region here. EventBridge then\n determines the corresponding event bus in the other Region based on the endpoint referenced\n by the EndpointId. Specifying the event bus ARN is preferred.

\n " + } + }, + "TraceHeader": { + "target": "com.amazonaws.eventbridge#TraceHeader", + "traits": { + "smithy.api#documentation": "

An X-Ray trace header, which is an http header (X-Amzn-Trace-Id) that\n contains the trace-id associated with the event.

\n

To learn more about X-Ray trace headers, see Tracing\n header in the X-Ray Developer Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents an event to be submitted.

" + } + }, + "com.amazonaws.eventbridge#PutEventsRequestEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.eventbridge#PutEventsRequestEntry" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.eventbridge#PutEventsResponse": { + "type": "structure", + "members": { + "FailedEntryCount": { + "target": "com.amazonaws.eventbridge#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of failed entries.

" + } + }, + "Entries": { + "target": "com.amazonaws.eventbridge#PutEventsResultEntryList", + "traits": { + "smithy.api#documentation": "

The successfully and unsuccessfully ingested events results. If the ingestion was\n successful, the entry has the event ID in it. Otherwise, you can use the error code and error\n message to identify the problem with the entry.

\n

For each record, the index of the response element is the same as the index in the request\n array.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eventbridge#PutEventsResultEntry": { + "type": "structure", + "members": { + "EventId": { + "target": "com.amazonaws.eventbridge#EventId", + "traits": { + "smithy.api#documentation": "

The ID of the event.

" + } + }, + "ErrorCode": { + "target": "com.amazonaws.eventbridge#ErrorCode", + "traits": { + "smithy.api#documentation": "

The error code that indicates why the event submission failed.

\n

Retryable errors include:

\n
    \n
  • \n

    \n \n InternalFailure\n \n

    \n

    The request processing has failed because of an unknown error, exception or\n failure.

    \n
    • \n
  • \n

    \n \n ThrottlingException\n \n

    \n

    The request was denied due to request throttling.

    \n
    • \n
\n

Non-retryable errors include:

\n
    \n
  • \n

    \n \n AccessDeniedException\n \n

    \n

    You do not have sufficient access to perform this action.

    \n
    • \n
  • \n

    \n InvalidAccountIdException\n

    \n

    The account ID provided is not valid.

    \n
    • \n
  • \n

    \n InvalidArgument\n

    \n

    A specified parameter is not valid.

    \n
    • \n
  • \n

    \n MalformedDetail\n

    \n

    The JSON provided is not valid.

    \n
    • \n
  • \n

    \n RedactionFailure\n

    \n

    Redacting the CloudTrail event failed.

    \n
    • \n
  • \n

    \n NotAuthorizedForSourceException\n

    \n

    You do not have permissions to publish events with this source onto this event\n bus.

    \n
    • \n
  • \n

    \n NotAuthorizedForDetailTypeException\n

    \n

    You do not have permissions to publish events with this detail type onto this event\n bus.

    \n
    • \n
" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.eventbridge#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The error message that explains why the event submission failed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the results of an event submitted to an event bus.

\n

If the submission was successful, the entry has the event ID in it. Otherwise, you can use\n the error code and error message to identify the problem with the entry.

\n

For information about the errors that are common to all actions, see Common\n Errors.

" + } + }, + "com.amazonaws.eventbridge#PutEventsResultEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.eventbridge#PutEventsResultEntry" + } + }, + "com.amazonaws.eventbridge#PutPartnerEvents": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#PutPartnerEventsRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#PutPartnerEventsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#OperationDisabledException" + } + ], + "traits": { + "smithy.api#documentation": "

This is used by SaaS partners to write events to a customer's partner event bus. Amazon Web Services customers do not use this operation.

\n

For information on calculating event batch size, see Calculating EventBridge PutEvents event\n entry size in the EventBridge User Guide.

" + } + }, + "com.amazonaws.eventbridge#PutPartnerEventsRequest": { + "type": "structure", + "members": { + "Entries": { + "target": "com.amazonaws.eventbridge#PutPartnerEventsRequestEntryList", + "traits": { + "smithy.api#documentation": "

The list of events to write to the event bus.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#PutPartnerEventsRequestEntry": { + "type": "structure", + "members": { + "Time": { + "target": "com.amazonaws.eventbridge#EventTime", + "traits": { + "smithy.api#documentation": "

The date and time of the event.

" + } + }, + "Source": { + "target": "com.amazonaws.eventbridge#EventSourceName", + "traits": { + "smithy.api#documentation": "

The event source that is generating the entry.

\n \n

\n Detail, DetailType, and Source are required for EventBridge to successfully send an event to an event bus. \n If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. \n If you submit a request in which none of the entries have each of these properties, EventBridge fails the entire request.\n

\n " + } + }, + "Resources": { + "target": "com.amazonaws.eventbridge#EventResourceList", + "traits": { + "smithy.api#documentation": "

Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns.\n Any number, including zero, may be present.

" + } + }, + "DetailType": { + "target": "com.amazonaws.eventbridge#String", + "traits": { + "smithy.api#documentation": "

A free-form string, with a maximum of 128 characters, used to decide what fields to expect\n in the event detail.

\n \n

\n Detail, DetailType, and Source are required for EventBridge to successfully send an event to an event bus. \n If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. \n If you submit a request in which none of the entries have each of these properties, EventBridge fails the entire request.\n

\n " + } + }, + "Detail": { + "target": "com.amazonaws.eventbridge#String", + "traits": { + "smithy.api#documentation": "

A valid JSON string. There is no other schema imposed. The JSON string may contain fields\n and nested sub-objects.

\n \n

\n Detail, DetailType, and Source are required for EventBridge to successfully send an event to an event bus. \n If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. \n If you submit a request in which none of the entries have each of these properties, EventBridge fails the entire request.\n

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

The details about an event generated by an SaaS partner.

" + } + }, + "com.amazonaws.eventbridge#PutPartnerEventsRequestEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.eventbridge#PutPartnerEventsRequestEntry" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.eventbridge#PutPartnerEventsResponse": { + "type": "structure", + "members": { + "FailedEntryCount": { + "target": "com.amazonaws.eventbridge#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of events from this operation that could not be written to the partner event\n bus.

" + } + }, + "Entries": { + "target": "com.amazonaws.eventbridge#PutPartnerEventsResultEntryList", + "traits": { + "smithy.api#documentation": "

The results for each event entry the partner submitted in this request. If the event was\n successfully submitted, the entry has the event ID in it. Otherwise, you can use the error\n code and error message to identify the problem with the entry.

\n

For each record, the index of the response element is the same as the index in the request\n array.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eventbridge#PutPartnerEventsResultEntry": { + "type": "structure", + "members": { + "EventId": { + "target": "com.amazonaws.eventbridge#EventId", + "traits": { + "smithy.api#documentation": "

The ID of the event.

" + } + }, + "ErrorCode": { + "target": "com.amazonaws.eventbridge#ErrorCode", + "traits": { + "smithy.api#documentation": "

The error code that indicates why the event submission failed.

" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.eventbridge#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The error message that explains why the event submission failed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The result of an event entry the partner submitted in this request. If the event was\n successfully submitted, the entry has the event ID in it. Otherwise, you can use the error\n code and error message to identify the problem with the entry.

" + } + }, + "com.amazonaws.eventbridge#PutPartnerEventsResultEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.eventbridge#PutPartnerEventsResultEntry" + } + }, + "com.amazonaws.eventbridge#PutPermission": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#PutPermissionRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#OperationDisabledException" + }, + { + "target": "com.amazonaws.eventbridge#PolicyLengthExceededException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Running PutPermission permits the specified Amazon Web Services account or Amazon Web Services organization\n to put events to the specified event bus. Amazon EventBridge rules in your account are triggered by these events arriving to an event bus in your\n account.

\n

For another account to send events to your account, that external account must have an\n EventBridge rule with your account's event bus as a target.

\n

To enable multiple Amazon Web Services accounts to put events to your event bus, run\n PutPermission once for each of these accounts. Or, if all the accounts are\n members of the same Amazon Web Services organization, you can run PutPermission\n once specifying Principal as \"*\" and specifying the Amazon Web Services\n organization ID in Condition, to grant permissions to all accounts in that\n organization.

\n

If you grant permissions using an organization, then accounts in that organization must\n specify a RoleArn with proper permissions when they use PutTarget to\n add your account's event bus as a target. For more information, see Sending and\n Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User Guide.

\n

The permission policy on the event bus cannot exceed 10 KB in size.

" + } + }, + "com.amazonaws.eventbridge#PutPermissionRequest": { + "type": "structure", + "members": { + "EventBusName": { + "target": "com.amazonaws.eventbridge#NonPartnerEventBusName", + "traits": { + "smithy.api#documentation": "

The name of the event bus associated with the rule. If you omit this, the default event\n bus is used.

" + } + }, + "Action": { + "target": "com.amazonaws.eventbridge#Action", + "traits": { + "smithy.api#documentation": "

The action that you are enabling the other account to perform.

" + } + }, + "Principal": { + "target": "com.amazonaws.eventbridge#Principal", + "traits": { + "smithy.api#documentation": "

The 12-digit Amazon Web Services account ID that you are permitting to put events to your\n default event bus. Specify \"*\" to permit any account to put events to your default event\n bus.

\n

If you specify \"*\" without specifying Condition, avoid creating rules that\n may match undesirable events. To create more secure rules, make sure that the event pattern\n for each rule contains an account field with a specific account ID from which to\n receive events. Rules with an account field do not match any events sent from other\n accounts.

" + } + }, + "StatementId": { + "target": "com.amazonaws.eventbridge#StatementId", + "traits": { + "smithy.api#documentation": "

An identifier string for the external account that you are granting permissions to. If you\n later want to revoke the permission for this external account, specify this\n StatementId when you run RemovePermission.

\n \n

Each StatementId must be unique.

\n " + } + }, + "Condition": { + "target": "com.amazonaws.eventbridge#Condition", + "traits": { + "smithy.api#documentation": "

This parameter enables you to limit the permission to accounts that fulfill a certain\n condition, such as being a member of a certain Amazon Web Services organization. For more\n information about Amazon Web Services Organizations, see What Is Amazon Web Services\n Organizations in the Amazon Web Services Organizations User\n Guide.

\n

If you specify Condition with an Amazon Web Services organization ID, and\n specify \"*\" as the value for Principal, you grant permission to all the accounts\n in the named organization.

\n

The Condition is a JSON string which must contain Type,\n Key, and Value fields.

" + } + }, + "Policy": { + "target": "com.amazonaws.eventbridge#String", + "traits": { + "smithy.api#documentation": "

A JSON string that describes the permission policy statement. You can include a\n Policy parameter in the request instead of using the StatementId,\n Action, Principal, or Condition parameters.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#PutRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#PutRuleRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#PutRuleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#InvalidEventPatternException" + }, + { + "target": "com.amazonaws.eventbridge#LimitExceededException" + }, + { + "target": "com.amazonaws.eventbridge#ManagedRuleException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates or updates the specified rule. Rules are enabled by default, or based on value of\n the state. You can disable a rule using DisableRule.

\n

A single rule watches for events from a single event bus. Events generated by Amazon Web Services services go to your account's default event bus. Events generated by SaaS partner\n services or applications go to the matching partner event bus. If you have custom applications\n or services, you can specify whether their events go to your default event bus or a custom\n event bus that you have created. For more information, see CreateEventBus.

\n

If you are updating an existing rule, the rule is replaced with what you specify in this\n PutRule command. If you omit arguments in PutRule, the old values\n for those arguments are not kept. Instead, they are replaced with null values.

\n

When you create or update a rule, incoming events might not immediately start matching to\n new or updated rules. Allow a short period of time for changes to take effect.

\n

A rule must contain at least an EventPattern or ScheduleExpression. Rules with\n EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions\n self-trigger based on the given schedule. A rule can have both an EventPattern and a\n ScheduleExpression, in which case the rule triggers on matching events as well as on a\n schedule.

\n

When you initially create a rule, you can optionally assign one or more tags to the rule.\n Tags can help you organize and categorize your resources. You can also use them to scope user\n permissions, by granting a user permission to access or change only rules with certain tag\n values. To use the PutRule operation and assign tags, you must have both the\n events:PutRule and events:TagResource permissions.

\n

If you are updating an existing rule, any tags you specify in the PutRule\n operation are ignored. To update the tags of an existing rule, use TagResource and UntagResource.

\n

Most services in Amazon Web Services treat : or / as the same character in Amazon Resource\n Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to\n use the correct ARN characters when creating event patterns so that they match the ARN syntax\n in the event you want to match.

\n

In EventBridge, it is possible to create rules that lead to infinite loops, where a rule\n is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket,\n and trigger software to change them to the desired state. If the rule is not written\n carefully, the subsequent change to the ACLs fires the rule again, creating an infinite\n loop.

\n

To prevent this, write the rules so that the triggered actions do not re-fire the same\n rule. For example, your rule could fire only if ACLs are found to be in a bad state, instead\n of after any change.

\n

An infinite loop can quickly cause higher than expected charges. We recommend that you use\n budgeting, which alerts you when charges exceed your specified limit. For more information,\n see Managing Your Costs with\n Budgets.

\n

To create a rule that filters for management events from Amazon Web Services services, see \n Receiving read-only management events from Amazon Web Services services in the \n EventBridge User Guide.

" + } + }, + "com.amazonaws.eventbridge#PutRuleRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.eventbridge#RuleName", + "traits": { + "smithy.api#documentation": "

The name of the rule that you are creating or updating.

", + "smithy.api#required": {} + } + }, + "ScheduleExpression": { + "target": "com.amazonaws.eventbridge#ScheduleExpression", + "traits": { + "smithy.api#documentation": "

The scheduling expression. For example, \"cron(0 20 * * ? *)\" or \"rate(5 minutes)\".

" + } + }, + "EventPattern": { + "target": "com.amazonaws.eventbridge#EventPattern", + "traits": { + "smithy.api#documentation": "

The event pattern. For more information, see Amazon EventBridge event\n patterns in the \n Amazon EventBridge User Guide\n .

" + } + }, + "State": { + "target": "com.amazonaws.eventbridge#RuleState", + "traits": { + "smithy.api#documentation": "

The state of the rule.

\n

Valid values include:

\n
    \n
  • \n

    \n DISABLED: The rule is disabled. EventBridge does not match any events against the rule.

    \n
    • \n
  • \n

    \n ENABLED: The rule is enabled. \n EventBridge matches events against the rule, except for Amazon Web Services management events delivered through CloudTrail.

    \n
    • \n
  • \n

    \n ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS: The rule is enabled for all\n events, including Amazon Web Services management events delivered through CloudTrail.

    \n

    Management events provide visibility into management operations that are performed on\n resources in your Amazon Web Services account. These are also known as control plane\n operations. For more information, see Logging management events in the CloudTrail User\n Guide, and Filtering management events from Amazon Web Services services in the\n \n Amazon EventBridge User Guide\n .

    \n

    This value is only valid for rules on the default event bus \n or custom event buses. \n It does not apply to partner event buses.

    \n
    • \n
" + } + }, + "Description": { + "target": "com.amazonaws.eventbridge#RuleDescription", + "traits": { + "smithy.api#documentation": "

A description of the rule.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.eventbridge#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

\n

If you're setting an event bus in another account as the target and that account granted\n permission to your account through an organization instead of directly by the account ID, you\n must specify a RoleArn with proper permissions in the Target\n structure, instead of here in this parameter.

" + } + }, + "Tags": { + "target": "com.amazonaws.eventbridge#TagList", + "traits": { + "smithy.api#documentation": "

The list of key-value pairs to associate with the rule.

" + } + }, + "EventBusName": { + "target": "com.amazonaws.eventbridge#EventBusNameOrArn", + "traits": { + "smithy.api#documentation": "

The name or ARN of the event bus to associate with this rule. If you omit this, the\n default event bus is used.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#PutRuleResponse": { + "type": "structure", + "members": { + "RuleArn": { + "target": "com.amazonaws.eventbridge#RuleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the rule.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eventbridge#PutTargets": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#PutTargetsRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#PutTargetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#LimitExceededException" + }, + { + "target": "com.amazonaws.eventbridge#ManagedRuleException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds the specified targets to the specified rule, or updates the targets if they are\n already associated with the rule.

\n

Targets are the resources that are invoked when a rule is triggered.

\n

The maximum number of entries per request is 10.

\n \n

Each rule can have up to five (5) targets associated with it at one time.

\n \n

For a list of services you can configure as targets for events, see EventBridge targets\n in the \n Amazon EventBridge User Guide\n .

\n

Creating rules with built-in targets is supported only in the Amazon Web Services Management Console. The\n built-in targets are:

\n
    \n
  • \n

    \n Amazon EBS CreateSnapshot API call\n

    \n
    • \n
  • \n

    \n Amazon EC2 RebootInstances API call\n

    \n
    • \n
  • \n

    \n Amazon EC2 StopInstances API call\n

    \n
    • \n
  • \n

    \n Amazon EC2 TerminateInstances API call\n

    \n
    • \n
\n

For some target types, PutTargets provides target-specific parameters. If the\n target is a Kinesis data stream, you can optionally specify which shard the event\n goes to by using the KinesisParameters argument. To invoke a command on multiple\n EC2 instances with one rule, you can use the RunCommandParameters field.

\n

To be able to make API calls against the resources that you own, Amazon EventBridge\n needs the appropriate permissions:

\n
    \n
  • \n

    For Lambda and Amazon SNS resources, EventBridge relies\n on resource-based policies.

    \n
    • \n
  • \n

    For EC2 instances, Kinesis Data Streams, Step Functions state machines and\n API Gateway APIs, EventBridge relies on IAM roles that you specify in the\n RoleARN argument in PutTargets.

    \n
    • \n
\n

For more information, see Authentication\n and Access Control in the \n Amazon EventBridge User Guide\n .

\n

If another Amazon Web Services account is in the same region and has granted you permission\n (using PutPermission), you can send events to that account. Set that account's\n event bus as a target of the rules in your account. To send the matched events to the other\n account, specify that account's event bus as the Arn value when you run\n PutTargets. If your account sends events to another account, your account is\n charged for each sent event. Each event sent to another account is charged as a custom event.\n The account receiving the event is not charged. For more information, see Amazon EventBridge Pricing.

\n \n

\n Input, InputPath, and InputTransformer are not\n available with PutTarget if the target is an event bus of a different Amazon Web Services account.

\n \n

If you are setting the event bus of another account as the target, and that account\n granted permission to your account through an organization instead of directly by the account\n ID, then you must specify a RoleArn with proper permissions in the\n Target structure. For more information, see Sending and\n Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User Guide.

\n \n

If you have an IAM role on a cross-account event bus target, a PutTargets\n call without a role on the same target (same Id and Arn) will not\n remove the role.

\n \n

For more information about enabling cross-account events, see PutPermission.

\n

\n Input, InputPath, and\n InputTransformer are mutually exclusive and optional\n parameters of a target. When a rule is triggered due to a matched event:

\n
    \n
  • \n

    If none of the following arguments are specified for a target, then the entire event\n is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or\n Amazon ECS task, in which case nothing from the event is passed to the target).

    \n
    • \n
  • \n

    If Input is specified in the form of valid JSON, then\n the matched event is overridden with this constant.

    \n
    • \n
  • \n

    If InputPath is specified in the form of JSONPath\n (for example, $.detail), then only the part of the event specified in the\n path is passed to the target (for example, only the detail part of the event is\n passed).

    \n
    • \n
  • \n

    If InputTransformer is specified, then one or more\n specified JSONPaths are extracted from the event and used as values in a template that you\n specify as the input to the target.

    \n
    • \n
\n

When you specify InputPath or InputTransformer, you must use\n JSON dot notation, not bracket notation.

\n

When you add targets to a rule and the associated rule triggers soon after, new or updated\n targets might not be immediately invoked. Allow a short period of time for changes to take\n effect.

\n

This action can partially fail if too many requests are made at the same time. If that\n happens, FailedEntryCount is non-zero in the response and each entry in\n FailedEntries provides the ID of the failed target and the error code.

" + } + }, + "com.amazonaws.eventbridge#PutTargetsRequest": { + "type": "structure", + "members": { + "Rule": { + "target": "com.amazonaws.eventbridge#RuleName", + "traits": { + "smithy.api#documentation": "

The name of the rule.

", + "smithy.api#required": {} + } + }, + "EventBusName": { + "target": "com.amazonaws.eventbridge#EventBusNameOrArn", + "traits": { + "smithy.api#documentation": "

The name or ARN of the event bus associated with the rule. If you omit this, the default\n event bus is used.

" + } + }, + "Targets": { + "target": "com.amazonaws.eventbridge#TargetList", + "traits": { + "smithy.api#documentation": "

The targets to update or add to the rule.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#PutTargetsResponse": { + "type": "structure", + "members": { + "FailedEntryCount": { + "target": "com.amazonaws.eventbridge#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of failed entries.

" + } + }, + "FailedEntries": { + "target": "com.amazonaws.eventbridge#PutTargetsResultEntryList", + "traits": { + "smithy.api#documentation": "

The failed target entries.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eventbridge#PutTargetsResultEntry": { + "type": "structure", + "members": { + "TargetId": { + "target": "com.amazonaws.eventbridge#TargetId", + "traits": { + "smithy.api#documentation": "

The ID of the target.

" + } + }, + "ErrorCode": { + "target": "com.amazonaws.eventbridge#ErrorCode", + "traits": { + "smithy.api#documentation": "

The error code that indicates why the target addition failed. If the value is\n ConcurrentModificationException, too many requests were made at the same\n time.

" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.eventbridge#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The error message that explains why the target addition failed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a target that failed to be added to a rule.

" + } + }, + "com.amazonaws.eventbridge#PutTargetsResultEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.eventbridge#PutTargetsResultEntry" + } + }, + "com.amazonaws.eventbridge#QueryStringKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^[^\\x00-\\x1F\\x7F]+$" + } + }, + "com.amazonaws.eventbridge#QueryStringParametersMap": { + "type": "map", + "key": { + "target": "com.amazonaws.eventbridge#QueryStringKey" + }, + "value": { + "target": "com.amazonaws.eventbridge#QueryStringValue" + } + }, + "com.amazonaws.eventbridge#QueryStringValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^[^\\x00-\\x09\\x0B\\x0C\\x0E-\\x1F\\x7F]+$" + } + }, + "com.amazonaws.eventbridge#QueryStringValueSensitive": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^[^\\x00-\\x09\\x0B\\x0C\\x0E-\\x1F\\x7F]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.eventbridge#RedshiftDataParameters": { + "type": "structure", + "members": { + "SecretManagerArn": { + "target": "com.amazonaws.eventbridge#RedshiftSecretManagerArn", + "traits": { + "smithy.api#documentation": "

The name or ARN of the secret that enables access to the database. Required when\n authenticating using Amazon Web Services Secrets Manager.

" + } + }, + "Database": { + "target": "com.amazonaws.eventbridge#Database", + "traits": { + "smithy.api#documentation": "

The name of the database. Required when authenticating using temporary credentials.

", + "smithy.api#required": {} + } + }, + "DbUser": { + "target": "com.amazonaws.eventbridge#DbUser", + "traits": { + "smithy.api#documentation": "

The database user name. Required when authenticating using temporary credentials.

" + } + }, + "Sql": { + "target": "com.amazonaws.eventbridge#Sql", + "traits": { + "smithy.api#documentation": "

The SQL statement text to run.

" + } + }, + "StatementName": { + "target": "com.amazonaws.eventbridge#StatementName", + "traits": { + "smithy.api#documentation": "

The name of the SQL statement. You can name the SQL statement when you create it to\n identify the query.

" + } + }, + "WithEvent": { + "target": "com.amazonaws.eventbridge#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to send an event back to EventBridge after the SQL statement\n runs.

" + } + }, + "Sqls": { + "target": "com.amazonaws.eventbridge#Sqls", + "traits": { + "smithy.api#documentation": "

One or more SQL statements to run. The SQL statements are run as a single transaction.\n They run serially in the order of the array. Subsequent SQL statements don't start until the\n previous statement in the array completes. If any SQL statement fails, then because they are\n run as one transaction, all work is rolled back.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

These are custom parameters to be used when the target is a Amazon Redshift cluster\n to invoke the Amazon Redshift Data API\n ExecuteStatement based on EventBridge events.

" + } + }, + "com.amazonaws.eventbridge#RedshiftSecretManagerArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "Optional SecretManager ARN which stores the database credentials", + "smithy.api#length": { + "min": 1, + "max": 1600 + }, + "smithy.api#pattern": "^(^arn:aws([a-z]|\\-)*:secretsmanager:[a-z0-9-.]+:.*)|(\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*)$" + } + }, + "com.amazonaws.eventbridge#ReferenceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.eventbridge#RemovePermission": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#RemovePermissionRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#OperationDisabledException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Revokes the permission of another Amazon Web Services account to be able to put events to\n the specified event bus. Specify the account to revoke by the StatementId value\n that you associated with the account when you granted it permission with\n PutPermission. You can find the StatementId by using DescribeEventBus.

" + } + }, + "com.amazonaws.eventbridge#RemovePermissionRequest": { + "type": "structure", + "members": { + "StatementId": { + "target": "com.amazonaws.eventbridge#StatementId", + "traits": { + "smithy.api#documentation": "

The statement ID corresponding to the account that is no longer allowed to put events to\n the default event bus.

" + } + }, + "RemoveAllPermissions": { + "target": "com.amazonaws.eventbridge#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether to remove all permissions.

" + } + }, + "EventBusName": { + "target": "com.amazonaws.eventbridge#NonPartnerEventBusName", + "traits": { + "smithy.api#documentation": "

The name of the event bus to revoke permissions for. If you omit this, the default event\n bus is used.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#RemoveTargets": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#RemoveTargetsRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#RemoveTargetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#ManagedRuleException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes the specified targets from the specified rule. When the rule is triggered, those\n targets are no longer be invoked.

\n \n

A successful execution of RemoveTargets doesn't guarantee all targets are\n removed from the rule, it means that the target(s) listed in the request are removed.

\n \n

When you remove a target, when the associated rule triggers, removed targets might\n continue to be invoked. Allow a short period of time for changes to take effect.

\n

This action can partially fail if too many requests are made at the same time. If that\n happens, FailedEntryCount is non-zero in the response and each entry in\n FailedEntries provides the ID of the failed target and the error code.

\n

The maximum number of entries per request is 10.

" + } + }, + "com.amazonaws.eventbridge#RemoveTargetsRequest": { + "type": "structure", + "members": { + "Rule": { + "target": "com.amazonaws.eventbridge#RuleName", + "traits": { + "smithy.api#documentation": "

The name of the rule.

", + "smithy.api#required": {} + } + }, + "EventBusName": { + "target": "com.amazonaws.eventbridge#EventBusNameOrArn", + "traits": { + "smithy.api#documentation": "

The name or ARN of the event bus associated with the rule. If you omit this, the default\n event bus is used.

" + } + }, + "Ids": { + "target": "com.amazonaws.eventbridge#TargetIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the targets to remove from the rule.

", + "smithy.api#required": {} + } + }, + "Force": { + "target": "com.amazonaws.eventbridge#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

If this is a managed rule, created by an Amazon Web Services service on your behalf, you\n must specify Force as True to remove targets. This parameter is\n ignored for rules that are not managed rules. You can check whether a rule is a managed rule\n by using DescribeRule or ListRules and checking the\n ManagedBy field of the response.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#RemoveTargetsResponse": { + "type": "structure", + "members": { + "FailedEntryCount": { + "target": "com.amazonaws.eventbridge#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of failed entries.

" + } + }, + "FailedEntries": { + "target": "com.amazonaws.eventbridge#RemoveTargetsResultEntryList", + "traits": { + "smithy.api#documentation": "

The failed target entries.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eventbridge#RemoveTargetsResultEntry": { + "type": "structure", + "members": { + "TargetId": { + "target": "com.amazonaws.eventbridge#TargetId", + "traits": { + "smithy.api#documentation": "

The ID of the target.

" + } + }, + "ErrorCode": { + "target": "com.amazonaws.eventbridge#ErrorCode", + "traits": { + "smithy.api#documentation": "

The error code that indicates why the target removal failed. If the value is\n ConcurrentModificationException, too many requests were made at the same\n time.

" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.eventbridge#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The error message that explains why the target removal failed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a target that failed to be removed from a rule.

" + } + }, + "com.amazonaws.eventbridge#RemoveTargetsResultEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.eventbridge#RemoveTargetsResultEntry" + } + }, + "com.amazonaws.eventbridge#Replay": { + "type": "structure", + "members": { + "ReplayName": { + "target": "com.amazonaws.eventbridge#ReplayName", + "traits": { + "smithy.api#documentation": "

The name of the replay.

" + } + }, + "EventSourceArn": { + "target": "com.amazonaws.eventbridge#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the archive to replay event from.

" + } + }, + "State": { + "target": "com.amazonaws.eventbridge#ReplayState", + "traits": { + "smithy.api#documentation": "

The current state of the replay.

" + } + }, + "StateReason": { + "target": "com.amazonaws.eventbridge#ReplayStateReason", + "traits": { + "smithy.api#documentation": "

A description of why the replay is in the current state.

" + } + }, + "EventStartTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

A time stamp for the time to start replaying events. This is determined by the time in the\n event as described in Time.

" + } + }, + "EventEndTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

A time stamp for the time to start replaying events. Any event with a creation time prior\n to the EventEndTime specified is replayed.

" + } + }, + "EventLastReplayedTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

A time stamp for the time that the last event was replayed.

" + } + }, + "ReplayStartTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

A time stamp for the time that the replay started.

" + } + }, + "ReplayEndTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

A time stamp for the time that the replay completed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A Replay object that contains details about a replay.

" + } + }, + "com.amazonaws.eventbridge#ReplayArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1600 + }, + "smithy.api#pattern": "^arn:aws([a-z]|\\-)*:events:([a-z]|\\d|\\-)*:([0-9]{12})?:.+\\/[\\.\\-_A-Za-z0-9]+$" + } + }, + "com.amazonaws.eventbridge#ReplayDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.eventbridge#ReplayDestination": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.eventbridge#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the event bus to replay event to. You can replay events only to the event bus\n specified to create the archive.

", + "smithy.api#required": {} + } + }, + "FilterArns": { + "target": "com.amazonaws.eventbridge#ReplayDestinationFilters", + "traits": { + "smithy.api#documentation": "

A list of ARNs for rules to replay events to.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A ReplayDestination object that contains details about a replay.

" + } + }, + "com.amazonaws.eventbridge#ReplayDestinationFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.eventbridge#Arn" + } + }, + "com.amazonaws.eventbridge#ReplayList": { + "type": "list", + "member": { + "target": "com.amazonaws.eventbridge#Replay" + } + }, + "com.amazonaws.eventbridge#ReplayName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[\\.\\-_A-Za-z0-9]+$" + } + }, + "com.amazonaws.eventbridge#ReplayState": { + "type": "enum", + "members": { + "STARTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTING" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "CANCELLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLING" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.eventbridge#ReplayStateReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.eventbridge#ReplicationConfig": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.eventbridge#ReplicationState", + "traits": { + "smithy.api#documentation": "

The state of event replication.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Endpoints can replicate all events to the secondary Region.

" + } + }, + "com.amazonaws.eventbridge#ReplicationState": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.eventbridge#ResourceAlreadyExistsException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.eventbridge#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The resource you are trying to create already exists.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.eventbridge#ResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1600 + } + } + }, + "com.amazonaws.eventbridge#ResourceAssociationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 17, + "max": 2048 + }, + "smithy.api#pattern": "^arn:[a-z0-9\\\\-]+:vpc-lattice:[a-zA-Z0-9\\\\-]+:\\\\d{12}:servicenetworkresourceassociation/snra-[0-9a-z]{17}$" + } + }, + "com.amazonaws.eventbridge#ResourceConfigurationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "^(?:^arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:resourceconfiguration/rcfg-[0-9a-z]{17}$|^$)$" + } + }, + "com.amazonaws.eventbridge#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.eventbridge#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

An entity that you specified does not exist.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.eventbridge#RetentionDays": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.eventbridge#RetryPolicy": { + "type": "structure", + "members": { + "MaximumRetryAttempts": { + "target": "com.amazonaws.eventbridge#MaximumRetryAttempts", + "traits": { + "smithy.api#documentation": "

The maximum number of retry attempts to make before the request fails. Retry attempts\n continue until either the maximum number of attempts is made or until the duration of the\n MaximumEventAgeInSeconds is met.

" + } + }, + "MaximumEventAgeInSeconds": { + "target": "com.amazonaws.eventbridge#MaximumEventAgeInSeconds", + "traits": { + "smithy.api#documentation": "

The maximum amount of time, in seconds, to continue to make retry attempts.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A RetryPolicy object that includes information about the retry policy\n settings.

" + } + }, + "com.amazonaws.eventbridge#RoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1600 + } + } + }, + "com.amazonaws.eventbridge#Route": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 9, + "max": 20 + }, + "smithy.api#pattern": "^[\\-a-z0-9]+$" + } + }, + "com.amazonaws.eventbridge#RoutingConfig": { + "type": "structure", + "members": { + "FailoverConfig": { + "target": "com.amazonaws.eventbridge#FailoverConfig", + "traits": { + "smithy.api#documentation": "

The failover configuration for an endpoint. This includes what triggers failover and what\n happens when it's triggered.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The routing configuration of the endpoint.

" + } + }, + "com.amazonaws.eventbridge#Rule": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.eventbridge#RuleName", + "traits": { + "smithy.api#documentation": "

The name of the rule.

" + } + }, + "Arn": { + "target": "com.amazonaws.eventbridge#RuleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the rule.

" + } + }, + "EventPattern": { + "target": "com.amazonaws.eventbridge#EventPattern", + "traits": { + "smithy.api#documentation": "

The event pattern of the rule. For more information, see Events and Event\n Patterns in the \n Amazon EventBridge User Guide\n .

" + } + }, + "State": { + "target": "com.amazonaws.eventbridge#RuleState", + "traits": { + "smithy.api#documentation": "

The state of the rule.

\n

Valid values include:

\n
    \n
  • \n

    \n DISABLED: The rule is disabled. EventBridge does not match any events against the rule.

    \n
    • \n
  • \n

    \n ENABLED: The rule is enabled. \n EventBridge matches events against the rule, except for Amazon Web Services management events delivered through CloudTrail.

    \n
    • \n
  • \n

    \n ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS: The rule is enabled for all\n events, including Amazon Web Services management events delivered through CloudTrail.

    \n

    Management events provide visibility into management operations that are performed on\n resources in your Amazon Web Services account. These are also known as control plane\n operations. For more information, see Logging management events in the CloudTrail User\n Guide, and Filtering management events from Amazon Web Services services in the\n \n Amazon EventBridge User Guide\n .

    \n

    This value is only valid for rules on the default event bus \n or custom event buses. \n It does not apply to partner event buses.

    \n
    • \n
" + } + }, + "Description": { + "target": "com.amazonaws.eventbridge#RuleDescription", + "traits": { + "smithy.api#documentation": "

The description of the rule.

" + } + }, + "ScheduleExpression": { + "target": "com.amazonaws.eventbridge#ScheduleExpression", + "traits": { + "smithy.api#documentation": "

The scheduling expression. For example, \"cron(0 20 * * ? *)\", \"rate(5 minutes)\". For more\n information, see Creating an Amazon EventBridge rule\n that runs on a schedule.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.eventbridge#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role that is used for target invocation.

\n

If you're setting an event bus in another account as the target and that account granted\n permission to your account through an organization instead of directly by the account ID, you\n must specify a RoleArn with proper permissions in the Target\n structure, instead of here in this parameter.

" + } + }, + "ManagedBy": { + "target": "com.amazonaws.eventbridge#ManagedBy", + "traits": { + "smithy.api#documentation": "

If the rule was created on behalf of your account by an Amazon Web Services service, this\n field displays the principal name of the service that created the rule.

" + } + }, + "EventBusName": { + "target": "com.amazonaws.eventbridge#EventBusName", + "traits": { + "smithy.api#documentation": "

The name or ARN of the event bus associated with the rule. If you omit this, the default\n event bus is used.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a rule in Amazon EventBridge.

" + } + }, + "com.amazonaws.eventbridge#RuleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1600 + } + } + }, + "com.amazonaws.eventbridge#RuleDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + } + } + }, + "com.amazonaws.eventbridge#RuleName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[\\.\\-_A-Za-z0-9]+$" + } + }, + "com.amazonaws.eventbridge#RuleNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.eventbridge#RuleName" + } + }, + "com.amazonaws.eventbridge#RuleResponseList": { + "type": "list", + "member": { + "target": "com.amazonaws.eventbridge#Rule" + } + }, + "com.amazonaws.eventbridge#RuleState": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + }, + "ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS" + } + } + } + }, + "com.amazonaws.eventbridge#RunCommandParameters": { + "type": "structure", + "members": { + "RunCommandTargets": { + "target": "com.amazonaws.eventbridge#RunCommandTargets", + "traits": { + "smithy.api#documentation": "

Currently, we support including only one RunCommandTarget block, which specifies either an\n array of InstanceIds or a tag.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

This parameter contains the criteria (either InstanceIds or a tag) used to specify which\n EC2 instances are to be sent the command.

" + } + }, + "com.amazonaws.eventbridge#RunCommandTarget": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.eventbridge#RunCommandTargetKey", + "traits": { + "smithy.api#documentation": "

Can be either tag:\n tag-key or\n InstanceIds.

", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.eventbridge#RunCommandTargetValues", + "traits": { + "smithy.api#documentation": "

If Key is tag:\n tag-key, Values\n is a list of tag values. If Key is InstanceIds, Values\n is a list of Amazon EC2 instance IDs.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the EC2 instances that are to be sent the command, specified as\n key-value pairs. Each RunCommandTarget block can include only one key, but this\n key may specify multiple values.

" + } + }, + "com.amazonaws.eventbridge#RunCommandTargetKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*$" + } + }, + "com.amazonaws.eventbridge#RunCommandTargetValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.eventbridge#RunCommandTargetValues": { + "type": "list", + "member": { + "target": "com.amazonaws.eventbridge#RunCommandTargetValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.eventbridge#RunCommandTargets": { + "type": "list", + "member": { + "target": "com.amazonaws.eventbridge#RunCommandTarget" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.eventbridge#SageMakerPipelineParameter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.eventbridge#SageMakerPipelineParameterName", + "traits": { + "smithy.api#documentation": "

Name of parameter to start execution of a SageMaker Model Building\n Pipeline.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.eventbridge#SageMakerPipelineParameterValue", + "traits": { + "smithy.api#documentation": "

Value of parameter to start execution of a SageMaker Model Building\n Pipeline.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Name/Value pair of a parameter to start execution of a SageMaker Model Building\n Pipeline.

" + } + }, + "com.amazonaws.eventbridge#SageMakerPipelineParameterList": { + "type": "list", + "member": { + "target": "com.amazonaws.eventbridge#SageMakerPipelineParameter" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.eventbridge#SageMakerPipelineParameterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + } + }, + "com.amazonaws.eventbridge#SageMakerPipelineParameterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.eventbridge#SageMakerPipelineParameters": { + "type": "structure", + "members": { + "PipelineParameterList": { + "target": "com.amazonaws.eventbridge#SageMakerPipelineParameterList", + "traits": { + "smithy.api#documentation": "

List of Parameter names and values for SageMaker Model Building Pipeline\n execution.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

These are custom parameters to use when the target is a SageMaker Model Building\n Pipeline that starts based on EventBridge events.

" + } + }, + "com.amazonaws.eventbridge#ScheduleExpression": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.eventbridge#Secondary": { + "type": "structure", + "members": { + "Route": { + "target": "com.amazonaws.eventbridge#Route", + "traits": { + "smithy.api#documentation": "

Defines the secondary Region.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The secondary Region that processes events when failover is triggered or replication is\n enabled.

" + } + }, + "com.amazonaws.eventbridge#SecretsManagerSecretArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws([a-z]|\\-)*:secretsmanager:([a-z]|\\d|\\-)*:([0-9]{12})?:secret:[\\/_+=\\.@\\-A-Za-z0-9]+$" + } + }, + "com.amazonaws.eventbridge#SensitiveString": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.eventbridge#Sql": { + "type": "string", + "traits": { + "smithy.api#documentation": "A single Redshift SQL", + "smithy.api#length": { + "min": 1, + "max": 100000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.eventbridge#Sqls": { + "type": "list", + "member": { + "target": "com.amazonaws.eventbridge#Sql" + }, + "traits": { + "smithy.api#documentation": "A list of SQLs.", + "smithy.api#length": { + "min": 0, + "max": 40 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.eventbridge#SqsParameters": { + "type": "structure", + "members": { + "MessageGroupId": { + "target": "com.amazonaws.eventbridge#MessageGroupId", + "traits": { + "smithy.api#documentation": "

The FIFO message group ID to use as the target.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This structure includes the custom parameter to be used when the target is an SQS FIFO\n queue.

" + } + }, + "com.amazonaws.eventbridge#StartReplay": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#StartReplayRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#StartReplayResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#InvalidEventPatternException" + }, + { + "target": "com.amazonaws.eventbridge#LimitExceededException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts the specified replay. Events are not necessarily replayed in the exact same order\n that they were added to the archive. A replay processes events to replay based on the time in\n the event, and replays them using 1 minute intervals. If you specify an\n EventStartTime and an EventEndTime that covers a 20 minute time\n range, the events are replayed from the first minute of that 20 minute range first. Then the\n events from the second minute are replayed. You can use DescribeReplay to\n determine the progress of a replay. The value returned for EventLastReplayedTime\n indicates the time within the specified time range associated with the last event\n replayed.

" + } + }, + "com.amazonaws.eventbridge#StartReplayRequest": { + "type": "structure", + "members": { + "ReplayName": { + "target": "com.amazonaws.eventbridge#ReplayName", + "traits": { + "smithy.api#documentation": "

The name of the replay to start.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.eventbridge#ReplayDescription", + "traits": { + "smithy.api#documentation": "

A description for the replay to start.

" + } + }, + "EventSourceArn": { + "target": "com.amazonaws.eventbridge#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the archive to replay events from.

", + "smithy.api#required": {} + } + }, + "EventStartTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

A time stamp for the time to start replaying events. Only events that occurred between the\n EventStartTime and EventEndTime are replayed.

", + "smithy.api#required": {} + } + }, + "EventEndTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

A time stamp for the time to stop replaying events. Only events that occurred between the\n EventStartTime and EventEndTime are replayed.

", + "smithy.api#required": {} + } + }, + "Destination": { + "target": "com.amazonaws.eventbridge#ReplayDestination", + "traits": { + "smithy.api#documentation": "

A ReplayDestination object that includes details about the destination for\n the replay.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#StartReplayResponse": { + "type": "structure", + "members": { + "ReplayArn": { + "target": "com.amazonaws.eventbridge#ReplayArn", + "traits": { + "smithy.api#documentation": "

The ARN of the replay.

" + } + }, + "State": { + "target": "com.amazonaws.eventbridge#ReplayState", + "traits": { + "smithy.api#documentation": "

The state of the replay.

" + } + }, + "StateReason": { + "target": "com.amazonaws.eventbridge#ReplayStateReason", + "traits": { + "smithy.api#documentation": "

The reason that the replay is in the state.

" + } + }, + "ReplayStartTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the replay started.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eventbridge#StatementId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-_]+$" + } + }, + "com.amazonaws.eventbridge#StatementName": { + "type": "string", + "traits": { + "smithy.api#documentation": "A name for Redshift DataAPI statement which can be used as filter of\n ListStatement.", + "smithy.api#length": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.eventbridge#String": { + "type": "string" + }, + "com.amazonaws.eventbridge#StringList": { + "type": "list", + "member": { + "target": "com.amazonaws.eventbridge#String" + } + }, + "com.amazonaws.eventbridge#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.eventbridge#TagKey", + "traits": { + "smithy.api#documentation": "

A string you can use to assign a value. The combination of tag keys and values can help\n you organize and categorize your resources.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.eventbridge#TagValue", + "traits": { + "smithy.api#documentation": "

The value for the specified tag key.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A key-value pair associated with an Amazon Web Services resource. In EventBridge,\n rules and event buses support tagging.

" + } + }, + "com.amazonaws.eventbridge#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.eventbridge#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.eventbridge#TagKey" + } + }, + "com.amazonaws.eventbridge#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.eventbridge#Tag" + } + }, + "com.amazonaws.eventbridge#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#ManagedRuleException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Assigns one or more tags (key-value pairs) to the specified EventBridge resource. Tags can\n help you organize and categorize your resources. You can also use them to scope user\n permissions by granting a user permission to access or change only resources with certain tag\n values. In EventBridge, rules and event buses can be tagged.

\n

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as\n strings of characters.

\n

You can use the TagResource action with a resource that already has tags. If\n you specify a new tag key, this tag is appended to the list of tags associated with the\n resource. If you specify a tag key that is already associated with the resource, the new tag\n value that you specify replaces the previous value for that tag.

\n

You can associate as many as 50 tags with a resource.

" + } + }, + "com.amazonaws.eventbridge#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.eventbridge#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the EventBridge resource that you're adding tags to.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.eventbridge#TagList", + "traits": { + "smithy.api#documentation": "

The list of key-value pairs to associate with the resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eventbridge#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.eventbridge#Target": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.eventbridge#TargetId", + "traits": { + "smithy.api#documentation": "

The ID of the target within the specified rule. Use this ID to reference the target when\n updating the rule. We recommend using a memorable and unique string.

", + "smithy.api#required": {} + } + }, + "Arn": { + "target": "com.amazonaws.eventbridge#TargetArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the target.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.eventbridge#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is triggered. If\n one rule triggers multiple targets, you can use a different IAM role for each target.

" + } + }, + "Input": { + "target": "com.amazonaws.eventbridge#TargetInput", + "traits": { + "smithy.api#documentation": "

Valid JSON text passed to the target. In this case, nothing from the event itself is\n passed to the target. For more information, see The JavaScript Object Notation (JSON) Data\n Interchange Format.

" + } + }, + "InputPath": { + "target": "com.amazonaws.eventbridge#TargetInputPath", + "traits": { + "smithy.api#documentation": "

The value of the JSONPath that is used for extracting part of the matched event when\n passing it to the target. You may use JSON dot notation or bracket notation. For more\n information about JSON paths, see JSONPath.

" + } + }, + "InputTransformer": { + "target": "com.amazonaws.eventbridge#InputTransformer", + "traits": { + "smithy.api#documentation": "

Settings to enable you to provide custom input to a target based on certain event data.\n You can extract one or more key-value pairs from the event and then use that data to send\n customized input to the target.

" + } + }, + "KinesisParameters": { + "target": "com.amazonaws.eventbridge#KinesisParameters", + "traits": { + "smithy.api#documentation": "

The custom parameter you can use to control the shard assignment, when the target is a\n Kinesis data stream. If you do not include this parameter, the default is to use the\n eventId as the partition key.

" + } + }, + "RunCommandParameters": { + "target": "com.amazonaws.eventbridge#RunCommandParameters", + "traits": { + "smithy.api#documentation": "

Parameters used when you are using the rule to invoke Amazon EC2 Run Command.

" + } + }, + "EcsParameters": { + "target": "com.amazonaws.eventbridge#EcsParameters", + "traits": { + "smithy.api#documentation": "

Contains the Amazon ECS task definition and task count to be used, if the event target is\n an Amazon ECS task. For more information about Amazon ECS tasks, see Task\n Definitions in the Amazon EC2 Container Service Developer\n Guide.

" + } + }, + "BatchParameters": { + "target": "com.amazonaws.eventbridge#BatchParameters", + "traits": { + "smithy.api#documentation": "

If the event target is an Batch job, this contains the job definition, job\n name, and other parameters. For more information, see Jobs in the Batch\n User Guide.

" + } + }, + "SqsParameters": { + "target": "com.amazonaws.eventbridge#SqsParameters", + "traits": { + "smithy.api#documentation": "

Contains the message group ID to use when the target is a FIFO queue.

\n

If you specify an SQS FIFO queue as a target, the queue must have content-based\n deduplication enabled.

" + } + }, + "HttpParameters": { + "target": "com.amazonaws.eventbridge#HttpParameters", + "traits": { + "smithy.api#documentation": "

Contains the HTTP parameters to use when the target is a API Gateway endpoint or\n EventBridge ApiDestination.

\n

If you specify an API Gateway API or EventBridge ApiDestination as a target,\n you can use this parameter to specify headers, path parameters, and query string keys/values\n as part of your target invoking request. If you're using ApiDestinations, the corresponding\n Connection can also have these values configured. In case of any conflicting keys, values from\n the Connection take precedence.

" + } + }, + "RedshiftDataParameters": { + "target": "com.amazonaws.eventbridge#RedshiftDataParameters", + "traits": { + "smithy.api#documentation": "

Contains the Amazon Redshift Data API parameters to use when the target is a Amazon Redshift cluster.

\n

If you specify a Amazon Redshift Cluster as a Target, you can use this to specify\n parameters to invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.

" + } + }, + "SageMakerPipelineParameters": { + "target": "com.amazonaws.eventbridge#SageMakerPipelineParameters", + "traits": { + "smithy.api#documentation": "

Contains the SageMaker Model Building Pipeline parameters to start execution of a\n SageMaker Model Building Pipeline.

\n

If you specify a SageMaker Model Building Pipeline as a target, you can use this\n to specify parameters to start a pipeline execution based on EventBridge events.

" + } + }, + "DeadLetterConfig": { + "target": "com.amazonaws.eventbridge#DeadLetterConfig", + "traits": { + "smithy.api#documentation": "

The DeadLetterConfig that defines the target queue to send dead-letter queue\n events to.

" + } + }, + "RetryPolicy": { + "target": "com.amazonaws.eventbridge#RetryPolicy", + "traits": { + "smithy.api#documentation": "

The retry policy configuration to use\n for the dead-letter queue.

" + } + }, + "AppSyncParameters": { + "target": "com.amazonaws.eventbridge#AppSyncParameters", + "traits": { + "smithy.api#documentation": "

Contains the GraphQL operation to be parsed and executed, if the event target is an\n AppSync API.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Targets are the resources to be invoked when a rule is triggered. For a complete list of\n services and resources that can be set as a target, see PutTargets.

\n

If you are setting the event bus of another account as the target, and that account\n granted permission to your account through an organization instead of directly by the account\n ID, then you must specify a RoleArn with proper permissions in the\n Target structure. For more information, see Sending and\n Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User Guide.

" + } + }, + "com.amazonaws.eventbridge#TargetArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1600 + } + } + }, + "com.amazonaws.eventbridge#TargetId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[\\.\\-_A-Za-z0-9]+$" + } + }, + "com.amazonaws.eventbridge#TargetIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.eventbridge#TargetId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.eventbridge#TargetInput": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 8192 + } + } + }, + "com.amazonaws.eventbridge#TargetInputPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.eventbridge#TargetList": { + "type": "list", + "member": { + "target": "com.amazonaws.eventbridge#Target" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.eventbridge#TargetPartitionKeyPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.eventbridge#TestEventPattern": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#TestEventPatternRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#TestEventPatternResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#InvalidEventPatternException" + } + ], + "traits": { + "smithy.api#documentation": "

Tests whether the specified event pattern matches the provided event.

\n

Most services in Amazon Web Services treat : or / as the same character in Amazon Resource\n Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be\n sure to use the correct ARN characters when creating event patterns so that they match the ARN\n syntax in the event you want to match.

" + } + }, + "com.amazonaws.eventbridge#TestEventPatternRequest": { + "type": "structure", + "members": { + "EventPattern": { + "target": "com.amazonaws.eventbridge#EventPattern", + "traits": { + "smithy.api#documentation": "

The event pattern. For more information, see Events and Event\n Patterns in the \n Amazon EventBridge User Guide\n .

", + "smithy.api#required": {} + } + }, + "Event": { + "target": "com.amazonaws.eventbridge#String", + "traits": { + "smithy.api#documentation": "

The event, in JSON format, to test against the event pattern. The JSON must follow the\n format specified in Amazon Web Services Events, and\n the following fields are mandatory:

\n
    \n
  • \n

    \n id\n

    \n
    • \n
  • \n

    \n account\n

    \n
    • \n
  • \n

    \n source\n

    \n
    • \n
  • \n

    \n time\n

    \n
    • \n
  • \n

    \n region\n

    \n
    • \n
  • \n

    \n resources\n

    \n
    • \n
  • \n

    \n detail-type\n

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#TestEventPatternResponse": { + "type": "structure", + "members": { + "Result": { + "target": "com.amazonaws.eventbridge#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the event matches the event pattern.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eventbridge#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.eventbridge#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

This request cannot be completed due to throttling issues.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.eventbridge#Timestamp": { + "type": "timestamp" + }, + "com.amazonaws.eventbridge#TraceHeader": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.eventbridge#TransformerInput": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 8192 + } + } + }, + "com.amazonaws.eventbridge#TransformerPaths": { + "type": "map", + "key": { + "target": "com.amazonaws.eventbridge#InputTransformerPathKey" + }, + "value": { + "target": "com.amazonaws.eventbridge#TargetInputPath" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.eventbridge#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#ManagedRuleException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes one or more tags from the specified EventBridge resource. In Amazon EventBridge, rules and event buses can be tagged.

" + } + }, + "com.amazonaws.eventbridge#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.eventbridge#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the EventBridge resource from which you are removing tags.

", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.eventbridge#TagKeyList", + "traits": { + "smithy.api#documentation": "

The list of tag keys to remove from the resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eventbridge#UpdateApiDestination": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#UpdateApiDestinationRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#UpdateApiDestinationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#LimitExceededException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an API destination.

" + } + }, + "com.amazonaws.eventbridge#UpdateApiDestinationRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.eventbridge#ApiDestinationName", + "traits": { + "smithy.api#documentation": "

The name of the API destination to update.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.eventbridge#ApiDestinationDescription", + "traits": { + "smithy.api#documentation": "

The name of the API destination to update.

" + } + }, + "ConnectionArn": { + "target": "com.amazonaws.eventbridge#ConnectionArn", + "traits": { + "smithy.api#documentation": "

The ARN of the connection to use for the API destination.

" + } + }, + "InvocationEndpoint": { + "target": "com.amazonaws.eventbridge#HttpsEndpoint", + "traits": { + "smithy.api#documentation": "

The URL to the endpoint to use for the API destination.

" + } + }, + "HttpMethod": { + "target": "com.amazonaws.eventbridge#ApiDestinationHttpMethod", + "traits": { + "smithy.api#documentation": "

The method to use for the API destination.

" + } + }, + "InvocationRateLimitPerSecond": { + "target": "com.amazonaws.eventbridge#ApiDestinationInvocationRateLimitPerSecond", + "traits": { + "smithy.api#documentation": "

The maximum number of invocations per second to send to the API destination.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#UpdateApiDestinationResponse": { + "type": "structure", + "members": { + "ApiDestinationArn": { + "target": "com.amazonaws.eventbridge#ApiDestinationArn", + "traits": { + "smithy.api#documentation": "

The ARN of the API destination that was updated.

" + } + }, + "ApiDestinationState": { + "target": "com.amazonaws.eventbridge#ApiDestinationState", + "traits": { + "smithy.api#documentation": "

The state of the API destination that was updated.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

A time stamp for the time that the API destination was created.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

A time stamp for the time that the API destination was last modified.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eventbridge#UpdateArchive": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#UpdateArchiveRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#UpdateArchiveResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#InvalidEventPatternException" + }, + { + "target": "com.amazonaws.eventbridge#LimitExceededException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the specified archive.

" + } + }, + "com.amazonaws.eventbridge#UpdateArchiveRequest": { + "type": "structure", + "members": { + "ArchiveName": { + "target": "com.amazonaws.eventbridge#ArchiveName", + "traits": { + "smithy.api#documentation": "

The name of the archive to update.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.eventbridge#ArchiveDescription", + "traits": { + "smithy.api#documentation": "

The description for the archive.

" + } + }, + "EventPattern": { + "target": "com.amazonaws.eventbridge#EventPattern", + "traits": { + "smithy.api#documentation": "

The event pattern to use to filter events sent to the archive.

" + } + }, + "RetentionDays": { + "target": "com.amazonaws.eventbridge#RetentionDays", + "traits": { + "smithy.api#documentation": "

The number of days to retain events in the archive.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#UpdateArchiveResponse": { + "type": "structure", + "members": { + "ArchiveArn": { + "target": "com.amazonaws.eventbridge#ArchiveArn", + "traits": { + "smithy.api#documentation": "

The ARN of the archive.

" + } + }, + "State": { + "target": "com.amazonaws.eventbridge#ArchiveState", + "traits": { + "smithy.api#documentation": "

The state of the archive.

" + } + }, + "StateReason": { + "target": "com.amazonaws.eventbridge#ArchiveStateReason", + "traits": { + "smithy.api#documentation": "

The reason that the archive is in the current state.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the archive was updated.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eventbridge#UpdateConnection": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#UpdateConnectionRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#UpdateConnectionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#AccessDeniedException" + }, + { + "target": "com.amazonaws.eventbridge#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#LimitExceededException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eventbridge#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates settings for a connection.

" + } + }, + "com.amazonaws.eventbridge#UpdateConnectionApiKeyAuthRequestParameters": { + "type": "structure", + "members": { + "ApiKeyName": { + "target": "com.amazonaws.eventbridge#AuthHeaderParameters", + "traits": { + "smithy.api#documentation": "

The name of the API key to use for authorization.

" + } + }, + "ApiKeyValue": { + "target": "com.amazonaws.eventbridge#AuthHeaderParametersSensitive", + "traits": { + "smithy.api#documentation": "

The value associated with the API key to use for authorization.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the API key authorization parameters to use to update the connection.

" + } + }, + "com.amazonaws.eventbridge#UpdateConnectionAuthRequestParameters": { + "type": "structure", + "members": { + "BasicAuthParameters": { + "target": "com.amazonaws.eventbridge#UpdateConnectionBasicAuthRequestParameters", + "traits": { + "smithy.api#documentation": "

The\n authorization parameters for Basic authorization.

" + } + }, + "OAuthParameters": { + "target": "com.amazonaws.eventbridge#UpdateConnectionOAuthRequestParameters", + "traits": { + "smithy.api#documentation": "

The\n authorization parameters for OAuth authorization.

" + } + }, + "ApiKeyAuthParameters": { + "target": "com.amazonaws.eventbridge#UpdateConnectionApiKeyAuthRequestParameters", + "traits": { + "smithy.api#documentation": "

The\n authorization parameters for API key authorization.

" + } + }, + "InvocationHttpParameters": { + "target": "com.amazonaws.eventbridge#ConnectionHttpParameters", + "traits": { + "smithy.api#documentation": "

The additional parameters to\n use for the connection.

" + } + }, + "ConnectivityParameters": { + "target": "com.amazonaws.eventbridge#ConnectivityResourceParameters", + "traits": { + "smithy.api#documentation": "

If you specify a private OAuth endpoint, the parameters for EventBridge to use when authenticating against the endpoint.

\n

For more information, see Authorization methods for connections in the \n Amazon EventBridge User Guide\n .

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the additional parameters to use for the connection.

" + } + }, + "com.amazonaws.eventbridge#UpdateConnectionBasicAuthRequestParameters": { + "type": "structure", + "members": { + "Username": { + "target": "com.amazonaws.eventbridge#AuthHeaderParameters", + "traits": { + "smithy.api#documentation": "

The user name to use for Basic authorization.

" + } + }, + "Password": { + "target": "com.amazonaws.eventbridge#AuthHeaderParametersSensitive", + "traits": { + "smithy.api#documentation": "

The password associated with the user name to use for Basic authorization.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Basic authorization parameters for the connection.

" + } + }, + "com.amazonaws.eventbridge#UpdateConnectionOAuthClientRequestParameters": { + "type": "structure", + "members": { + "ClientID": { + "target": "com.amazonaws.eventbridge#AuthHeaderParameters", + "traits": { + "smithy.api#documentation": "

The client ID to use for OAuth authorization.

" + } + }, + "ClientSecret": { + "target": "com.amazonaws.eventbridge#AuthHeaderParametersSensitive", + "traits": { + "smithy.api#documentation": "

The client secret assciated with the client ID to use for OAuth authorization.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The OAuth authorization parameters to use for the connection.

" + } + }, + "com.amazonaws.eventbridge#UpdateConnectionOAuthRequestParameters": { + "type": "structure", + "members": { + "ClientParameters": { + "target": "com.amazonaws.eventbridge#UpdateConnectionOAuthClientRequestParameters", + "traits": { + "smithy.api#documentation": "

The\n client parameters to use for the connection when OAuth is specified as the authorization\n type.

" + } + }, + "AuthorizationEndpoint": { + "target": "com.amazonaws.eventbridge#HttpsEndpoint", + "traits": { + "smithy.api#documentation": "

The URL to the authorization endpoint when OAuth is specified as the authorization\n type.

" + } + }, + "HttpMethod": { + "target": "com.amazonaws.eventbridge#ConnectionOAuthHttpMethod", + "traits": { + "smithy.api#documentation": "

The method used to connect to the HTTP endpoint.

" + } + }, + "OAuthHttpParameters": { + "target": "com.amazonaws.eventbridge#ConnectionHttpParameters", + "traits": { + "smithy.api#documentation": "

The additional HTTP parameters used for the OAuth authorization request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The OAuth request parameters to use for the connection.

" + } + }, + "com.amazonaws.eventbridge#UpdateConnectionRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.eventbridge#ConnectionName", + "traits": { + "smithy.api#documentation": "

The name of the connection to update.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.eventbridge#ConnectionDescription", + "traits": { + "smithy.api#documentation": "

A description for the connection.

" + } + }, + "AuthorizationType": { + "target": "com.amazonaws.eventbridge#ConnectionAuthorizationType", + "traits": { + "smithy.api#documentation": "

The type of authorization to use for the connection.

" + } + }, + "AuthParameters": { + "target": "com.amazonaws.eventbridge#UpdateConnectionAuthRequestParameters", + "traits": { + "smithy.api#documentation": "

The authorization parameters to use for the connection.

" + } + }, + "InvocationConnectivityParameters": { + "target": "com.amazonaws.eventbridge#ConnectivityResourceParameters", + "traits": { + "smithy.api#documentation": "

For connections to private resource endpoints, the parameters to use for invoking the resource endpoint.

\n

For more information, see Connecting to private resources in the \n Amazon EventBridge User Guide\n .

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#UpdateConnectionResponse": { + "type": "structure", + "members": { + "ConnectionArn": { + "target": "com.amazonaws.eventbridge#ConnectionArn", + "traits": { + "smithy.api#documentation": "

The ARN of the connection that was updated.

" + } + }, + "ConnectionState": { + "target": "com.amazonaws.eventbridge#ConnectionState", + "traits": { + "smithy.api#documentation": "

The state of the connection that was updated.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

A time stamp for the time that the connection was created.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

A time stamp for the time that the connection was last modified.

" + } + }, + "LastAuthorizedTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

A time stamp for the time that the connection was last authorized.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eventbridge#UpdateEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#UpdateEndpointRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#UpdateEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Update an existing endpoint. For more information about global endpoints, see Making\n applications Regional-fault tolerant with global endpoints and event replication in\n the \n Amazon EventBridge User Guide\n .

" + } + }, + "com.amazonaws.eventbridge#UpdateEndpointRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.eventbridge#EndpointName", + "traits": { + "smithy.api#documentation": "

The name of the endpoint you want to update.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.eventbridge#EndpointDescription", + "traits": { + "smithy.api#documentation": "

A description for the endpoint.

" + } + }, + "RoutingConfig": { + "target": "com.amazonaws.eventbridge#RoutingConfig", + "traits": { + "smithy.api#documentation": "

Configure the routing policy, including the health check and secondary Region.

" + } + }, + "ReplicationConfig": { + "target": "com.amazonaws.eventbridge#ReplicationConfig", + "traits": { + "smithy.api#documentation": "

Whether event replication was enabled or disabled by this request.

" + } + }, + "EventBuses": { + "target": "com.amazonaws.eventbridge#EndpointEventBusList", + "traits": { + "smithy.api#documentation": "

Define event buses used for replication.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.eventbridge#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of the role used by event replication for this request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#UpdateEndpointResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.eventbridge#EndpointName", + "traits": { + "smithy.api#documentation": "

The name of the endpoint you updated in this request.

" + } + }, + "Arn": { + "target": "com.amazonaws.eventbridge#EndpointArn", + "traits": { + "smithy.api#documentation": "

The ARN of the endpoint you updated in this request.

" + } + }, + "RoutingConfig": { + "target": "com.amazonaws.eventbridge#RoutingConfig", + "traits": { + "smithy.api#documentation": "

The routing configuration you updated in this request.

" + } + }, + "ReplicationConfig": { + "target": "com.amazonaws.eventbridge#ReplicationConfig", + "traits": { + "smithy.api#documentation": "

Whether event replication was enabled or disabled for the endpoint you updated in this\n request.

" + } + }, + "EventBuses": { + "target": "com.amazonaws.eventbridge#EndpointEventBusList", + "traits": { + "smithy.api#documentation": "

The event buses used for replication for the endpoint you updated in this request.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.eventbridge#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of the role used by event replication for the endpoint you updated in this\n request.

" + } + }, + "EndpointId": { + "target": "com.amazonaws.eventbridge#EndpointId", + "traits": { + "smithy.api#documentation": "

The ID of the endpoint you updated in this request.

" + } + }, + "EndpointUrl": { + "target": "com.amazonaws.eventbridge#EndpointUrl", + "traits": { + "smithy.api#documentation": "

The URL of the endpoint you updated in this request.

" + } + }, + "State": { + "target": "com.amazonaws.eventbridge#EndpointState", + "traits": { + "smithy.api#documentation": "

The state of the endpoint you updated in this request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eventbridge#UpdateEventBus": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#UpdateEventBusRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#UpdateEventBusResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#OperationDisabledException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the specified event bus.

" + } + }, + "com.amazonaws.eventbridge#UpdateEventBusRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.eventbridge#EventBusName", + "traits": { + "smithy.api#documentation": "

The name of the event bus.

" + } + }, + "KmsKeyIdentifier": { + "target": "com.amazonaws.eventbridge#KmsKeyIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier of the KMS\n customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on this event bus. The identifier can be the key \n Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.

\n

If you do not specify a customer managed key identifier, EventBridge uses an\n Amazon Web Services owned key to encrypt events on the event bus.

\n

For more information, see Managing keys in the Key Management Service\n Developer Guide.

\n \n

Archives and schema discovery are not supported for event buses encrypted using a\n customer managed key. EventBridge returns an error if:

\n
    \n
  • \n

    You call \n CreateArchive\n on an event bus set to use a customer managed key for encryption.

    \n
    • \n
  • \n

    You call \n CreateDiscoverer\n on an event bus set to use a customer managed key for encryption.

    \n
    • \n
  • \n

    You call \n UpdatedEventBus\n to set a customer managed key on an event bus with an archives or schema discovery enabled.

    \n
    • \n
\n

To enable archives or schema discovery on an event bus, choose to\n use an Amazon Web Services owned key. For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.

\n " + } + }, + "Description": { + "target": "com.amazonaws.eventbridge#EventBusDescription", + "traits": { + "smithy.api#documentation": "

The event bus description.

" + } + }, + "DeadLetterConfig": { + "target": "com.amazonaws.eventbridge#DeadLetterConfig" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#UpdateEventBusResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.eventbridge#String", + "traits": { + "smithy.api#documentation": "

The event bus Amazon Resource Name (ARN).

" + } + }, + "Name": { + "target": "com.amazonaws.eventbridge#EventBusName", + "traits": { + "smithy.api#documentation": "

The event bus name.

" + } + }, + "KmsKeyIdentifier": { + "target": "com.amazonaws.eventbridge#KmsKeyIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier of the KMS\n customer managed key for EventBridge to use to encrypt events on this event bus, if one has been specified.

\n

For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.

" + } + }, + "Description": { + "target": "com.amazonaws.eventbridge#EventBusDescription", + "traits": { + "smithy.api#documentation": "

The event bus description.

" + } + }, + "DeadLetterConfig": { + "target": "com.amazonaws.eventbridge#DeadLetterConfig" + } + }, + "traits": { + "smithy.api#output": {} + } + } + } +} \ No newline at end of file diff --git a/pkg/testdata/codegen/sdk-codegen/aws-models/iam.json b/pkg/testdata/codegen/sdk-codegen/aws-models/iam.json new file mode 100644 index 00000000..5fa57c25 --- /dev/null +++ b/pkg/testdata/codegen/sdk-codegen/aws-models/iam.json @@ -0,0 +1,17486 @@ +{ + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.iam#AWSIdentityManagementV20100508": { + "type": "service", + "version": "2010-05-08", + "operations": [ + { + "target": "com.amazonaws.iam#AddClientIDToOpenIDConnectProvider" + }, + { + "target": "com.amazonaws.iam#AddRoleToInstanceProfile" + }, + { + "target": "com.amazonaws.iam#AddUserToGroup" + }, + { + "target": "com.amazonaws.iam#AttachGroupPolicy" + }, + { + "target": "com.amazonaws.iam#AttachRolePolicy" + }, + { + "target": "com.amazonaws.iam#AttachUserPolicy" + }, + { + "target": "com.amazonaws.iam#ChangePassword" + }, + { + "target": "com.amazonaws.iam#CreateAccessKey" + }, + { + "target": "com.amazonaws.iam#CreateAccountAlias" + }, + { + "target": "com.amazonaws.iam#CreateGroup" + }, + { + "target": "com.amazonaws.iam#CreateInstanceProfile" + }, + { + "target": "com.amazonaws.iam#CreateLoginProfile" + }, + { + "target": "com.amazonaws.iam#CreateOpenIDConnectProvider" + }, + { + "target": "com.amazonaws.iam#CreatePolicy" + }, + { + "target": "com.amazonaws.iam#CreatePolicyVersion" + }, + { + "target": "com.amazonaws.iam#CreateRole" + }, + { + "target": "com.amazonaws.iam#CreateSAMLProvider" + }, + { + "target": "com.amazonaws.iam#CreateServiceLinkedRole" + }, + { + "target": "com.amazonaws.iam#CreateServiceSpecificCredential" + }, + { + "target": "com.amazonaws.iam#CreateUser" + }, + { + "target": "com.amazonaws.iam#CreateVirtualMFADevice" + }, + { + "target": "com.amazonaws.iam#DeactivateMFADevice" + }, + { + "target": "com.amazonaws.iam#DeleteAccessKey" + }, + { + "target": "com.amazonaws.iam#DeleteAccountAlias" + }, + { + "target": "com.amazonaws.iam#DeleteAccountPasswordPolicy" + }, + { + "target": "com.amazonaws.iam#DeleteGroup" + }, + { + "target": "com.amazonaws.iam#DeleteGroupPolicy" + }, + { + "target": "com.amazonaws.iam#DeleteInstanceProfile" + }, + { + "target": "com.amazonaws.iam#DeleteLoginProfile" + }, + { + "target": "com.amazonaws.iam#DeleteOpenIDConnectProvider" + }, + { + "target": "com.amazonaws.iam#DeletePolicy" + }, + { + "target": "com.amazonaws.iam#DeletePolicyVersion" + }, + { + "target": "com.amazonaws.iam#DeleteRole" + }, + { + "target": "com.amazonaws.iam#DeleteRolePermissionsBoundary" + }, + { + "target": "com.amazonaws.iam#DeleteRolePolicy" + }, + { + "target": "com.amazonaws.iam#DeleteSAMLProvider" + }, + { + "target": "com.amazonaws.iam#DeleteServerCertificate" + }, + { + "target": "com.amazonaws.iam#DeleteServiceLinkedRole" + }, + { + "target": "com.amazonaws.iam#DeleteServiceSpecificCredential" + }, + { + "target": "com.amazonaws.iam#DeleteSigningCertificate" + }, + { + "target": "com.amazonaws.iam#DeleteSSHPublicKey" + }, + { + "target": "com.amazonaws.iam#DeleteUser" + }, + { + "target": "com.amazonaws.iam#DeleteUserPermissionsBoundary" + }, + { + "target": "com.amazonaws.iam#DeleteUserPolicy" + }, + { + "target": "com.amazonaws.iam#DeleteVirtualMFADevice" + }, + { + "target": "com.amazonaws.iam#DetachGroupPolicy" + }, + { + "target": "com.amazonaws.iam#DetachRolePolicy" + }, + { + "target": "com.amazonaws.iam#DetachUserPolicy" + }, + { + "target": "com.amazonaws.iam#DisableOrganizationsRootCredentialsManagement" + }, + { + "target": "com.amazonaws.iam#DisableOrganizationsRootSessions" + }, + { + "target": "com.amazonaws.iam#EnableMFADevice" + }, + { + "target": "com.amazonaws.iam#EnableOrganizationsRootCredentialsManagement" + }, + { + "target": "com.amazonaws.iam#EnableOrganizationsRootSessions" + }, + { + "target": "com.amazonaws.iam#GenerateCredentialReport" + }, + { + "target": "com.amazonaws.iam#GenerateOrganizationsAccessReport" + }, + { + "target": "com.amazonaws.iam#GenerateServiceLastAccessedDetails" + }, + { + "target": "com.amazonaws.iam#GetAccessKeyLastUsed" + }, + { + "target": "com.amazonaws.iam#GetAccountAuthorizationDetails" + }, + { + "target": "com.amazonaws.iam#GetAccountPasswordPolicy" + }, + { + "target": "com.amazonaws.iam#GetAccountSummary" + }, + { + "target": "com.amazonaws.iam#GetContextKeysForCustomPolicy" + }, + { + "target": "com.amazonaws.iam#GetContextKeysForPrincipalPolicy" + }, + { + "target": "com.amazonaws.iam#GetCredentialReport" + }, + { + "target": "com.amazonaws.iam#GetGroup" + }, + { + "target": "com.amazonaws.iam#GetGroupPolicy" + }, + { + "target": "com.amazonaws.iam#GetInstanceProfile" + }, + { + "target": "com.amazonaws.iam#GetLoginProfile" + }, + { + "target": "com.amazonaws.iam#GetMFADevice" + }, + { + "target": "com.amazonaws.iam#GetOpenIDConnectProvider" + }, + { + "target": "com.amazonaws.iam#GetOrganizationsAccessReport" + }, + { + "target": "com.amazonaws.iam#GetPolicy" + }, + { + "target": "com.amazonaws.iam#GetPolicyVersion" + }, + { + "target": "com.amazonaws.iam#GetRole" + }, + { + "target": "com.amazonaws.iam#GetRolePolicy" + }, + { + "target": "com.amazonaws.iam#GetSAMLProvider" + }, + { + "target": "com.amazonaws.iam#GetServerCertificate" + }, + { + "target": "com.amazonaws.iam#GetServiceLastAccessedDetails" + }, + { + "target": "com.amazonaws.iam#GetServiceLastAccessedDetailsWithEntities" + }, + { + "target": "com.amazonaws.iam#GetServiceLinkedRoleDeletionStatus" + }, + { + "target": "com.amazonaws.iam#GetSSHPublicKey" + }, + { + "target": "com.amazonaws.iam#GetUser" + }, + { + "target": "com.amazonaws.iam#GetUserPolicy" + }, + { + "target": "com.amazonaws.iam#ListAccessKeys" + }, + { + "target": "com.amazonaws.iam#ListAccountAliases" + }, + { + "target": "com.amazonaws.iam#ListAttachedGroupPolicies" + }, + { + "target": "com.amazonaws.iam#ListAttachedRolePolicies" + }, + { + "target": "com.amazonaws.iam#ListAttachedUserPolicies" + }, + { + "target": "com.amazonaws.iam#ListEntitiesForPolicy" + }, + { + "target": "com.amazonaws.iam#ListGroupPolicies" + }, + { + "target": "com.amazonaws.iam#ListGroups" + }, + { + "target": "com.amazonaws.iam#ListGroupsForUser" + }, + { + "target": "com.amazonaws.iam#ListInstanceProfiles" + }, + { + "target": "com.amazonaws.iam#ListInstanceProfilesForRole" + }, + { + "target": "com.amazonaws.iam#ListInstanceProfileTags" + }, + { + "target": "com.amazonaws.iam#ListMFADevices" + }, + { + "target": "com.amazonaws.iam#ListMFADeviceTags" + }, + { + "target": "com.amazonaws.iam#ListOpenIDConnectProviders" + }, + { + "target": "com.amazonaws.iam#ListOpenIDConnectProviderTags" + }, + { + "target": "com.amazonaws.iam#ListOrganizationsFeatures" + }, + { + "target": "com.amazonaws.iam#ListPolicies" + }, + { + "target": "com.amazonaws.iam#ListPoliciesGrantingServiceAccess" + }, + { + "target": "com.amazonaws.iam#ListPolicyTags" + }, + { + "target": "com.amazonaws.iam#ListPolicyVersions" + }, + { + "target": "com.amazonaws.iam#ListRolePolicies" + }, + { + "target": "com.amazonaws.iam#ListRoles" + }, + { + "target": "com.amazonaws.iam#ListRoleTags" + }, + { + "target": "com.amazonaws.iam#ListSAMLProviders" + }, + { + "target": "com.amazonaws.iam#ListSAMLProviderTags" + }, + { + "target": "com.amazonaws.iam#ListServerCertificates" + }, + { + "target": "com.amazonaws.iam#ListServerCertificateTags" + }, + { + "target": "com.amazonaws.iam#ListServiceSpecificCredentials" + }, + { + "target": "com.amazonaws.iam#ListSigningCertificates" + }, + { + "target": "com.amazonaws.iam#ListSSHPublicKeys" + }, + { + "target": "com.amazonaws.iam#ListUserPolicies" + }, + { + "target": "com.amazonaws.iam#ListUsers" + }, + { + "target": "com.amazonaws.iam#ListUserTags" + }, + { + "target": "com.amazonaws.iam#ListVirtualMFADevices" + }, + { + "target": "com.amazonaws.iam#PutGroupPolicy" + }, + { + "target": "com.amazonaws.iam#PutRolePermissionsBoundary" + }, + { + "target": "com.amazonaws.iam#PutRolePolicy" + }, + { + "target": "com.amazonaws.iam#PutUserPermissionsBoundary" + }, + { + "target": "com.amazonaws.iam#PutUserPolicy" + }, + { + "target": "com.amazonaws.iam#RemoveClientIDFromOpenIDConnectProvider" + }, + { + "target": "com.amazonaws.iam#RemoveRoleFromInstanceProfile" + }, + { + "target": "com.amazonaws.iam#RemoveUserFromGroup" + }, + { + "target": "com.amazonaws.iam#ResetServiceSpecificCredential" + }, + { + "target": "com.amazonaws.iam#ResyncMFADevice" + }, + { + "target": "com.amazonaws.iam#SetDefaultPolicyVersion" + }, + { + "target": "com.amazonaws.iam#SetSecurityTokenServicePreferences" + }, + { + "target": "com.amazonaws.iam#SimulateCustomPolicy" + }, + { + "target": "com.amazonaws.iam#SimulatePrincipalPolicy" + }, + { + "target": "com.amazonaws.iam#TagInstanceProfile" + }, + { + "target": "com.amazonaws.iam#TagMFADevice" + }, + { + "target": "com.amazonaws.iam#TagOpenIDConnectProvider" + }, + { + "target": "com.amazonaws.iam#TagPolicy" + }, + { + "target": "com.amazonaws.iam#TagRole" + }, + { + "target": "com.amazonaws.iam#TagSAMLProvider" + }, + { + "target": "com.amazonaws.iam#TagServerCertificate" + }, + { + "target": "com.amazonaws.iam#TagUser" + }, + { + "target": "com.amazonaws.iam#UntagInstanceProfile" + }, + { + "target": "com.amazonaws.iam#UntagMFADevice" + }, + { + "target": "com.amazonaws.iam#UntagOpenIDConnectProvider" + }, + { + "target": "com.amazonaws.iam#UntagPolicy" + }, + { + "target": "com.amazonaws.iam#UntagRole" + }, + { + "target": "com.amazonaws.iam#UntagSAMLProvider" + }, + { + "target": "com.amazonaws.iam#UntagServerCertificate" + }, + { + "target": "com.amazonaws.iam#UntagUser" + }, + { + "target": "com.amazonaws.iam#UpdateAccessKey" + }, + { + "target": "com.amazonaws.iam#UpdateAccountPasswordPolicy" + }, + { + "target": "com.amazonaws.iam#UpdateAssumeRolePolicy" + }, + { + "target": "com.amazonaws.iam#UpdateGroup" + }, + { + "target": "com.amazonaws.iam#UpdateLoginProfile" + }, + { + "target": "com.amazonaws.iam#UpdateOpenIDConnectProviderThumbprint" + }, + { + "target": "com.amazonaws.iam#UpdateRole" + }, + { + "target": "com.amazonaws.iam#UpdateRoleDescription" + }, + { + "target": "com.amazonaws.iam#UpdateSAMLProvider" + }, + { + "target": "com.amazonaws.iam#UpdateServerCertificate" + }, + { + "target": "com.amazonaws.iam#UpdateServiceSpecificCredential" + }, + { + "target": "com.amazonaws.iam#UpdateSigningCertificate" + }, + { + "target": "com.amazonaws.iam#UpdateSSHPublicKey" + }, + { + "target": "com.amazonaws.iam#UpdateUser" + }, + { + "target": "com.amazonaws.iam#UploadServerCertificate" + }, + { + "target": "com.amazonaws.iam#UploadSigningCertificate" + }, + { + "target": "com.amazonaws.iam#UploadSSHPublicKey" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "IAM", + "arnNamespace": "iam", + "cloudFormationName": "IAM", + "cloudTrailEventSource": "iam.amazonaws.com", + "endpointPrefix": "iam" + }, + "aws.auth#sigv4": { + "name": "iam" + }, + "aws.protocols#awsQuery": {}, + "smithy.api#documentation": "Identity and Access Management\n

Identity and Access Management (IAM) is a web service for securely controlling \n access to Amazon Web Services services. With IAM, you can centrally manage users, security credentials\n such as access keys, and permissions that control which Amazon Web Services resources users and \n applications can access. For more information about IAM, see Identity and Access Management (IAM) and the Identity and Access Management User Guide.

", + "smithy.api#title": "AWS Identity and Access Management", + "smithy.api#xmlNamespace": { + "uri": "https://iam.amazonaws.com/doc/2010-05-08/" + }, + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "endpoint": { + "url": "https://iam.amazonaws.com", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "iam", + "signingRegion": "us-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "endpoint": { + "url": "https://iam-fips.amazonaws.com", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "iam", + "signingRegion": "us-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-cn" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "endpoint": { + "url": "https://iam.cn-north-1.amazonaws.com.cn", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "iam", + "signingRegion": "cn-north-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-us-gov" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "endpoint": { + "url": "https://iam.us-gov.amazonaws.com", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "iam", + "signingRegion": "us-gov-west-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-us-gov" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "endpoint": { + "url": "https://iam.us-gov.amazonaws.com", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "iam", + "signingRegion": "us-gov-west-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-iso" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "endpoint": { + "url": "https://iam.us-iso-east-1.c2s.ic.gov", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "iam", + "signingRegion": "us-iso-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-iso-b" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "endpoint": { + "url": "https://iam.us-isob-east-1.sc2s.sgov.gov", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "iam", + "signingRegion": "us-isob-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-iso-e" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "endpoint": { + "url": "https://iam.eu-isoe-west-1.cloud.adc-e.uk", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "iam", + "signingRegion": "eu-isoe-west-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-iso-f" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "endpoint": { + "url": "https://iam.us-isof-south-1.csp.hci.ic.gov", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "iam", + "signingRegion": "us-isof-south-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://iam-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://iam-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://iam.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://iam.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region aws-global with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "iam", + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://iam.amazonaws.com" + } + }, + "params": { + "Region": "aws-global", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region aws-global with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "iam", + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://iam-fips.amazonaws.com" + } + }, + "params": { + "Region": "aws-global", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://iam-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "iam", + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://iam-fips.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://iam.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "iam", + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://iam.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region aws-cn-global with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "iam", + "signingRegion": "cn-north-1" + } + ] + }, + "url": "https://iam.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "aws-cn-global", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://iam-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://iam-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://iam.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "iam", + "signingRegion": "cn-north-1" + } + ] + }, + "url": "https://iam.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region aws-us-gov-global with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "iam", + "signingRegion": "us-gov-west-1" + } + ] + }, + "url": "https://iam.us-gov.amazonaws.com" + } + }, + "params": { + "Region": "aws-us-gov-global", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region aws-us-gov-global with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "iam", + "signingRegion": "us-gov-west-1" + } + ] + }, + "url": "https://iam.us-gov.amazonaws.com" + } + }, + "params": { + "Region": "aws-us-gov-global", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://iam-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "iam", + "signingRegion": "us-gov-west-1" + } + ] + }, + "url": "https://iam.us-gov.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://iam.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "iam", + "signingRegion": "us-gov-west-1" + } + ] + }, + "url": "https://iam.us-gov.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region aws-iso-global with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "iam", + "signingRegion": "us-iso-east-1" + } + ] + }, + "url": "https://iam.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "aws-iso-global", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://iam-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "iam", + "signingRegion": "us-iso-east-1" + } + ] + }, + "url": "https://iam.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region aws-iso-b-global with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "iam", + "signingRegion": "us-isob-east-1" + } + ] + }, + "url": "https://iam.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "aws-iso-b-global", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://iam-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "iam", + "signingRegion": "us-isob-east-1" + } + ] + }, + "url": "https://iam.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "iam", + "signingRegion": "eu-isoe-west-1" + } + ] + }, + "url": "https://iam.eu-isoe-west-1.cloud.adc-e.uk" + } + }, + "params": { + "Region": "eu-isoe-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "iam", + "signingRegion": "us-isof-south-1" + } + ] + }, + "url": "https://iam.us-isof-south-1.csp.hci.ic.gov" + } + }, + "params": { + "Region": "us-isof-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.iam#AccessAdvisorUsageGranularityType": { + "type": "enum", + "members": { + "SERVICE_LEVEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVICE_LEVEL" + } + }, + "ACTION_LEVEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTION_LEVEL" + } + } + } + }, + "com.amazonaws.iam#AccessDetail": { + "type": "structure", + "members": { + "ServiceName": { + "target": "com.amazonaws.iam#serviceNameType", + "traits": { + "smithy.api#documentation": "

The name of the service in which access was attempted.

", + "smithy.api#required": {} + } + }, + "ServiceNamespace": { + "target": "com.amazonaws.iam#serviceNamespaceType", + "traits": { + "smithy.api#documentation": "

The namespace of the service in which access was attempted.

\n

To learn the service namespace of a service, see Actions, resources, and condition keys for Amazon Web Services services in the\n Service Authorization Reference. Choose the name of the service to\n view details for that service. In the first paragraph, find the service prefix. For\n example, (service prefix: a4b). For more information about service namespaces,\n see Amazon Web Services\n service namespaces in the Amazon Web Services General Reference.

", + "smithy.api#required": {} + } + }, + "Region": { + "target": "com.amazonaws.iam#stringType", + "traits": { + "smithy.api#documentation": "

The Region where the last service access attempt occurred.

\n

This field is null if no principals in the reported Organizations entity attempted to access the\n service within the tracking period.

" + } + }, + "EntityPath": { + "target": "com.amazonaws.iam#organizationsEntityPathType", + "traits": { + "smithy.api#documentation": "

The path of the Organizations entity (root, organizational unit, or account) from which an\n authenticated principal last attempted to access the service. Amazon Web Services does not report\n unauthenticated requests.

\n

This field is null if no principals (IAM users, IAM roles, or root user) in the\n reported Organizations entity attempted to access the service within the tracking period.

" + } + }, + "LastAuthenticatedTime": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when an authenticated principal most recently attempted to access the\n service. Amazon Web Services does not report unauthenticated requests.

\n

This field is null if no principals in the reported Organizations entity attempted to access the\n service within the tracking period.

" + } + }, + "TotalAuthenticatedEntities": { + "target": "com.amazonaws.iam#integerType", + "traits": { + "smithy.api#documentation": "

The number of accounts with authenticated principals (root user, IAM users, and IAM\n roles) that attempted to access the service in the tracking period.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that contains details about when a principal in the reported Organizations entity\n last attempted to access an Amazon Web Services service. A principal can be an IAM user, an IAM role,\n or the Amazon Web Services account root user within the reported Organizations entity.

\n

This data type is a response element in the GetOrganizationsAccessReport operation.

" + } + }, + "com.amazonaws.iam#AccessDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#AccessDetail" + } + }, + "com.amazonaws.iam#AccessKey": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#userNameType", + "traits": { + "smithy.api#documentation": "

The name of the IAM user that the access key is associated with.

", + "smithy.api#required": {} + } + }, + "AccessKeyId": { + "target": "com.amazonaws.iam#accessKeyIdType", + "traits": { + "smithy.api#documentation": "

The ID for this access key.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.iam#statusType", + "traits": { + "smithy.api#documentation": "

The status of the access key. Active means that the key is valid for API\n calls, while Inactive means it is not.

", + "smithy.api#required": {} + } + }, + "SecretAccessKey": { + "target": "com.amazonaws.iam#accessKeySecretType", + "traits": { + "smithy.api#documentation": "

The secret key used to sign requests.

", + "smithy.api#required": {} + } + }, + "CreateDate": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date when the access key was created.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about an Amazon Web Services access key.

\n

This data type is used as a response element in the CreateAccessKey\n and ListAccessKeys operations.

\n \n

The SecretAccessKey value is returned only in response to CreateAccessKey. You can get a secret access key only when you first\n create an access key; you cannot recover the secret access key later. If you lose a\n secret access key, you must create a new access key.

\n " + } + }, + "com.amazonaws.iam#AccessKeyLastUsed": { + "type": "structure", + "members": { + "LastUsedDate": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the access key was most recently used. This field is null in the\n following situations:

\n
    \n
  • \n

    The user does not have an access key.

    \n
    • \n
  • \n

    An access key exists but has not been used since IAM began tracking this\n information.

    \n
    • \n
  • \n

    There is no sign-in data associated with the user.

    \n
    • \n
" + } + }, + "ServiceName": { + "target": "com.amazonaws.iam#stringType", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Web Services service with which this access key was most recently used. The\n value of this field is \"N/A\" in the following situations:

\n
    \n
  • \n

    The user does not have an access key.

    \n
    • \n
  • \n

    An access key exists but has not been used since IAM started tracking this\n information.

    \n
    • \n
  • \n

    There is no sign-in data associated with the user.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Region": { + "target": "com.amazonaws.iam#stringType", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region where this access key was most recently used. The value for this field\n is \"N/A\" in the following situations:

\n
    \n
  • \n

    The user does not have an access key.

    \n
    • \n
  • \n

    An access key exists but has not been used since IAM began tracking this\n information.

    \n
    • \n
  • \n

    There is no sign-in data associated with the user.

    \n
    • \n
\n

For more information about Amazon Web Services Regions, see Regions and endpoints in the Amazon Web Services\n General Reference.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the last time an Amazon Web Services access key was used since IAM began\n tracking this information on April 22, 2015.

\n

This data type is used as a response element in the GetAccessKeyLastUsed operation.

" + } + }, + "com.amazonaws.iam#AccessKeyMetadata": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#userNameType", + "traits": { + "smithy.api#documentation": "

The name of the IAM user that the key is associated with.

" + } + }, + "AccessKeyId": { + "target": "com.amazonaws.iam#accessKeyIdType", + "traits": { + "smithy.api#documentation": "

The ID for this access key.

" + } + }, + "Status": { + "target": "com.amazonaws.iam#statusType", + "traits": { + "smithy.api#documentation": "

The status of the access key. Active means that the key is valid for API\n calls; Inactive means it is not.

" + } + }, + "CreateDate": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date when the access key was created.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about an Amazon Web Services access key, without its secret key.

\n

This data type is used as a response element in the ListAccessKeys\n operation.

" + } + }, + "com.amazonaws.iam#AccountNotManagementOrDelegatedAdministratorException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.iam#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The request was rejected because the account making the request is not the management\n account or delegated administrator account for centralized root\n access.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.iam#ActionNameListType": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#ActionNameType" + } + }, + "com.amazonaws.iam#ActionNameType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 128 + } + } + }, + "com.amazonaws.iam#AddClientIDToOpenIDConnectProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#AddClientIDToOpenIDConnectProviderRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds a new client ID (also known as audience) to the list of client IDs already\n registered for the specified IAM OpenID Connect (OIDC) provider resource.

\n

This operation is idempotent; it does not fail or return an error if you add an\n existing client ID to the provider.

", + "smithy.api#examples": [ + { + "title": "To add a client ID (audience) to an Open-ID Connect (OIDC) provider", + "documentation": "The following add-client-id-to-open-id-connect-provider command adds the client ID my-application-ID to the OIDC provider named server.example.com:", + "input": { + "ClientID": "my-application-ID", + "OpenIDConnectProviderArn": "arn:aws:iam::123456789012:oidc-provider/server.example.com" + } + } + ] + } + }, + "com.amazonaws.iam#AddClientIDToOpenIDConnectProviderRequest": { + "type": "structure", + "members": { + "OpenIDConnectProviderArn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM OpenID Connect (OIDC) provider resource to\n add the client ID to. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders operation.

", + "smithy.api#required": {} + } + }, + "ClientID": { + "target": "com.amazonaws.iam#clientIDType", + "traits": { + "smithy.api#documentation": "

The client ID (also known as audience) to add to the IAM OpenID Connect provider\n resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#AddRoleToInstanceProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#AddRoleToInstanceProfileRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#EntityAlreadyExistsException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + }, + { + "target": "com.amazonaws.iam#UnmodifiableEntityException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds the specified IAM role to the specified instance profile. An instance profile\n can contain only one role, and this quota cannot be increased. You can remove the\n existing role and then add a different role to an instance profile. You must then wait\n for the change to appear across all of Amazon Web Services because of eventual\n consistency. To force the change, you must disassociate the instance profile and then associate the\n instance profile, or you can stop your instance and then restart it.

\n \n

The caller of this operation must be granted the PassRole permission\n on the IAM role by a permissions policy.

\n \n

For more information about roles, see IAM roles in the\n IAM User Guide. For more information about instance profiles,\n see Using\n instance profiles in the IAM User Guide.

", + "smithy.api#examples": [ + { + "title": "To add a role to an instance profile", + "documentation": "The following command adds the role named S3Access to the instance profile named Webserver:", + "input": { + "RoleName": "S3Access", + "InstanceProfileName": "Webserver" + } + } + ] + } + }, + "com.amazonaws.iam#AddRoleToInstanceProfileRequest": { + "type": "structure", + "members": { + "InstanceProfileName": { + "target": "com.amazonaws.iam#instanceProfileNameType", + "traits": { + "smithy.api#documentation": "

The name of the instance profile to update.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "RoleName": { + "target": "com.amazonaws.iam#roleNameType", + "traits": { + "smithy.api#documentation": "

The name of the role to add.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#AddUserToGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#AddUserToGroupRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds the specified user to the specified group.

", + "smithy.api#examples": [ + { + "title": "To add a user to an IAM group", + "documentation": "The following command adds an IAM user named Bob to the IAM group named Admins:", + "input": { + "UserName": "Bob", + "GroupName": "Admins" + } + } + ] + } + }, + "com.amazonaws.iam#AddUserToGroupRequest": { + "type": "structure", + "members": { + "GroupName": { + "target": "com.amazonaws.iam#groupNameType", + "traits": { + "smithy.api#documentation": "

The name of the group to update.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "UserName": { + "target": "com.amazonaws.iam#existingUserNameType", + "traits": { + "smithy.api#documentation": "

The name of the user to add.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#ArnListType": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#arnType" + } + }, + "com.amazonaws.iam#AttachGroupPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#AttachGroupPolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#PolicyNotAttachableException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Attaches the specified managed policy to the specified IAM group.

\n

You use this operation to attach a managed policy to a group. To embed an inline\n policy in a group, use \n PutGroupPolicy\n .

\n

As a best practice, you can validate your IAM policies. \n To learn more, see Validating IAM policies \n in the IAM User Guide.

\n

For more information about policies, see Managed policies and inline\n policies in the IAM User Guide.

", + "smithy.api#examples": [ + { + "title": "To attach a managed policy to an IAM group", + "documentation": "The following command attaches the AWS managed policy named ReadOnlyAccess to the IAM group named Finance.", + "input": { + "GroupName": "Finance", + "PolicyArn": "arn:aws:iam::aws:policy/ReadOnlyAccess" + } + } + ] + } + }, + "com.amazonaws.iam#AttachGroupPolicyRequest": { + "type": "structure", + "members": { + "GroupName": { + "target": "com.amazonaws.iam#groupNameType", + "traits": { + "smithy.api#documentation": "

The name (friendly name, not ARN) of the group to attach the policy to.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "PolicyArn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM policy you want to attach.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#AttachRolePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#AttachRolePolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#PolicyNotAttachableException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + }, + { + "target": "com.amazonaws.iam#UnmodifiableEntityException" + } + ], + "traits": { + "smithy.api#documentation": "

Attaches the specified managed policy to the specified IAM role. When you attach a\n managed policy to a role, the managed policy becomes part of the role's permission\n (access) policy.

\n \n

You cannot use a managed policy as the role's trust policy. The role's trust\n policy is created at the same time as the role, using \n CreateRole\n . You can update a role's trust policy using\n \n UpdateAssumerolePolicy\n .

\n \n

Use this operation to attach a managed policy to a role. To embed\n an inline policy in a role, use \n PutRolePolicy\n . For more information about policies, see Managed\n policies and inline policies in the\n IAM User Guide.

\n

As a best practice, you can validate your IAM policies. \n To learn more, see Validating IAM policies \n in the IAM User Guide.

", + "smithy.api#examples": [ + { + "title": "To attach a managed policy to an IAM role", + "documentation": "The following command attaches the AWS managed policy named ReadOnlyAccess to the IAM role named ReadOnlyRole.", + "input": { + "RoleName": "ReadOnlyRole", + "PolicyArn": "arn:aws:iam::aws:policy/ReadOnlyAccess" + } + } + ] + } + }, + "com.amazonaws.iam#AttachRolePolicyRequest": { + "type": "structure", + "members": { + "RoleName": { + "target": "com.amazonaws.iam#roleNameType", + "traits": { + "smithy.api#documentation": "

The name (friendly name, not ARN) of the role to attach the policy to.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "PolicyArn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM policy you want to attach.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#AttachUserPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#AttachUserPolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#PolicyNotAttachableException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Attaches the specified managed policy to the specified user.

\n

You use this operation to attach a managed policy to a user. To\n embed an inline policy in a user, use \n PutUserPolicy\n .

\n

As a best practice, you can validate your IAM policies. \n To learn more, see Validating IAM policies \n in the IAM User Guide.

\n

For more information about policies, see Managed policies and inline\n policies in the IAM User Guide.

", + "smithy.api#examples": [ + { + "title": "To attach a managed policy to an IAM user", + "documentation": "The following command attaches the AWS managed policy named AdministratorAccess to the IAM user named Alice.", + "input": { + "UserName": "Alice", + "PolicyArn": "arn:aws:iam::aws:policy/AdministratorAccess" + } + } + ] + } + }, + "com.amazonaws.iam#AttachUserPolicyRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#userNameType", + "traits": { + "smithy.api#documentation": "

The name (friendly name, not ARN) of the IAM user to attach the policy to.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "PolicyArn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM policy you want to attach.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#AttachedPermissionsBoundary": { + "type": "structure", + "members": { + "PermissionsBoundaryType": { + "target": "com.amazonaws.iam#PermissionsBoundaryAttachmentType", + "traits": { + "smithy.api#documentation": "

The permissions boundary usage type that indicates what type of IAM resource is used\n as the permissions boundary for an entity. This data type can only have a value of\n Policy.

" + } + }, + "PermissionsBoundaryArn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The ARN of the policy used to set the permissions boundary for the user or role.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about an attached permissions boundary.

\n

An attached permissions boundary is a managed policy that has been attached to a user or\n role to set the permissions boundary.

\n

For more information about permissions boundaries, see Permissions boundaries for IAM\n identities in the IAM User Guide.

" + } + }, + "com.amazonaws.iam#AttachedPolicy": { + "type": "structure", + "members": { + "PolicyName": { + "target": "com.amazonaws.iam#policyNameType", + "traits": { + "smithy.api#documentation": "

The friendly name of the attached policy.

" + } + }, + "PolicyArn": { + "target": "com.amazonaws.iam#arnType" + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about an attached policy.

\n

An attached policy is a managed policy that has been attached to a user, group, or role.\n This data type is used as a response element in the ListAttachedGroupPolicies, ListAttachedRolePolicies, ListAttachedUserPolicies, and GetAccountAuthorizationDetails operations.

\n

For more information about managed policies, refer to Managed policies and inline\n policies in the IAM User Guide.

" + } + }, + "com.amazonaws.iam#BootstrapDatum": { + "type": "blob", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.iam#CallerIsNotManagementAccountException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.iam#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The request was rejected because the account making the request is not the management\n account for the organization.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.iam#CertificationKeyType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\u0020-\\u00FF]+$" + } + }, + "com.amazonaws.iam#CertificationMapType": { + "type": "map", + "key": { + "target": "com.amazonaws.iam#CertificationKeyType" + }, + "value": { + "target": "com.amazonaws.iam#CertificationValueType" + } + }, + "com.amazonaws.iam#CertificationValueType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + }, + "smithy.api#pattern": "^[\\u0020-\\u00FF]+$" + } + }, + "com.amazonaws.iam#ChangePassword": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#ChangePasswordRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#EntityTemporarilyUnmodifiableException" + }, + { + "target": "com.amazonaws.iam#InvalidUserTypeException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#PasswordPolicyViolationException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Changes the password of the IAM user who is calling this operation. This operation\n can be performed using the CLI, the Amazon Web Services API, or the My\n Security Credentials page in the Amazon Web Services Management Console. The Amazon Web Services account root user password is\n not affected by this operation.

\n

Use UpdateLoginProfile to use the CLI, the Amazon Web Services API, or the\n Users page in the IAM console to change the\n password for any IAM user. For more information about modifying passwords, see Managing\n passwords in the IAM User Guide.

", + "smithy.api#examples": [ + { + "title": "To change the password for your IAM user", + "documentation": "The following command changes the password for the current IAM user.", + "input": { + "NewPassword": "]35d/{pB9Fo9wJ", + "OldPassword": "3s0K_;xh4~8XXI" + } + } + ] + } + }, + "com.amazonaws.iam#ChangePasswordRequest": { + "type": "structure", + "members": { + "OldPassword": { + "target": "com.amazonaws.iam#passwordType", + "traits": { + "smithy.api#documentation": "

The IAM user's current password.

", + "smithy.api#required": {} + } + }, + "NewPassword": { + "target": "com.amazonaws.iam#passwordType", + "traits": { + "smithy.api#documentation": "

The new password. The new password must conform to the Amazon Web Services account's password\n policy, if one exists.

\n

The regex pattern \n that is used to validate this parameter is a string of characters. That string can include almost any printable \n ASCII character from the space (\\u0020) through the end of the ASCII character range (\\u00FF). \n You can also include the tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D) \n characters. Any of these characters are valid in a password. However, many tools, such \n as the Amazon Web Services Management Console, might restrict the ability to type certain characters because they have \n special meaning within that tool.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#ColumnNumber": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.iam#ConcurrentModificationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iam#ConcurrentModificationMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ConcurrentModification", + "httpResponseCode": 409 + }, + "smithy.api#documentation": "

The request was rejected because multiple requests to change this object were submitted\n simultaneously. Wait a few minutes and submit your request again.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.iam#ConcurrentModificationMessage": { + "type": "string" + }, + "com.amazonaws.iam#ContextEntry": { + "type": "structure", + "members": { + "ContextKeyName": { + "target": "com.amazonaws.iam#ContextKeyNameType", + "traits": { + "smithy.api#documentation": "

The full name of a condition context key, including the service prefix. For example,\n aws:SourceIp or s3:VersionId.

" + } + }, + "ContextKeyValues": { + "target": "com.amazonaws.iam#ContextKeyValueListType", + "traits": { + "smithy.api#documentation": "

The value (or values, if the condition context key supports multiple values) to provide\n to the simulation when the key is referenced by a Condition element in an\n input policy.

" + } + }, + "ContextKeyType": { + "target": "com.amazonaws.iam#ContextKeyTypeEnum", + "traits": { + "smithy.api#documentation": "

The data type of the value (or values) specified in the ContextKeyValues\n parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a condition context key. It includes the name of the key and\n specifies the value (or values, if the context key supports multiple values) to use in the\n simulation. This information is used when evaluating the Condition elements of\n the input policies.

\n

This data type is used as an input parameter to SimulateCustomPolicy\n and SimulatePrincipalPolicy.

" + } + }, + "com.amazonaws.iam#ContextEntryListType": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#ContextEntry" + } + }, + "com.amazonaws.iam#ContextKeyNameType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 5, + "max": 256 + } + } + }, + "com.amazonaws.iam#ContextKeyNamesResultListType": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#ContextKeyNameType" + } + }, + "com.amazonaws.iam#ContextKeyTypeEnum": { + "type": "enum", + "members": { + "STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "string" + } + }, + "STRING_LIST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "stringList" + } + }, + "NUMERIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "numeric" + } + }, + "NUMERIC_LIST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "numericList" + } + }, + "BOOLEAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "boolean" + } + }, + "BOOLEAN_LIST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "booleanList" + } + }, + "IP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ip" + } + }, + "IP_LIST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipList" + } + }, + "BINARY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "binary" + } + }, + "BINARY_LIST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "binaryList" + } + }, + "DATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "date" + } + }, + "DATE_LIST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dateList" + } + } + } + }, + "com.amazonaws.iam#ContextKeyValueListType": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#ContextKeyValueType" + } + }, + "com.amazonaws.iam#ContextKeyValueType": { + "type": "string" + }, + "com.amazonaws.iam#CreateAccessKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#CreateAccessKeyRequest" + }, + "output": { + "target": "com.amazonaws.iam#CreateAccessKeyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new Amazon Web Services secret access key and corresponding Amazon Web Services access key ID for the\n specified user. The default status for new keys is Active.

\n

If you do not specify a user name, IAM determines the user name implicitly based on\n the Amazon Web Services access key ID signing the request. This operation works for access keys under\n the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root\n user credentials. This is true even if the Amazon Web Services account has no associated users.

\n

For information about quotas on the number of keys you can create, see IAM and STS\n quotas in the IAM User Guide.

\n \n

To ensure the security of your Amazon Web Services account, the secret access key is accessible\n only during key and user creation. You must save the key (for example, in a text\n file) if you want to be able to access it again. If a secret key is lost, you can\n delete the access keys for the associated user and then create new keys.

\n ", + "smithy.api#examples": [ + { + "title": "To create an access key for an IAM user", + "documentation": "The following command creates an access key (access key ID and secret access key) for the IAM user named Bob.", + "input": { + "UserName": "Bob" + }, + "output": { + "AccessKey": { + "UserName": "Bob", + "Status": "Active", + "CreateDate": "2015-03-09T18:39:23.411Z", + "SecretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY", + "AccessKeyId": "AKIAIOSFODNN7EXAMPLE" + } + } + } + ] + } + }, + "com.amazonaws.iam#CreateAccessKeyRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#existingUserNameType", + "traits": { + "smithy.api#documentation": "

The name of the IAM user that the new key will belong to.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#CreateAccessKeyResponse": { + "type": "structure", + "members": { + "AccessKey": { + "target": "com.amazonaws.iam#AccessKey", + "traits": { + "smithy.api#documentation": "

A structure with details about the access key.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful CreateAccessKey request.\n

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#CreateAccountAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#CreateAccountAliasRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.iam#EntityAlreadyExistsException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an alias for your Amazon Web Services account. For information about using an Amazon Web Services account\n alias, see Creating, deleting, and\n listing an Amazon Web Services account alias in the Amazon Web Services Sign-In User\n Guide.

", + "smithy.api#examples": [ + { + "title": "To create an account alias", + "documentation": "The following command associates the alias examplecorp to your AWS account.", + "input": { + "AccountAlias": "examplecorp" + } + } + ] + } + }, + "com.amazonaws.iam#CreateAccountAliasRequest": { + "type": "structure", + "members": { + "AccountAlias": { + "target": "com.amazonaws.iam#accountAliasType", + "traits": { + "smithy.api#documentation": "

The account alias to create.

\n

This parameter allows (through its regex pattern) a string of characters consisting of \n lowercase letters, digits, and dashes. You cannot start or finish with a dash, nor can you have \n two dashes in a row.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#CreateGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#CreateGroupRequest" + }, + "output": { + "target": "com.amazonaws.iam#CreateGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#EntityAlreadyExistsException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new group.

\n

For information about the number of groups you can create, see IAM and STS\n quotas in the IAM User Guide.

", + "smithy.api#examples": [ + { + "title": "To create an IAM group", + "documentation": "The following command creates an IAM group named Admins.", + "input": { + "GroupName": "Admins" + }, + "output": { + "Group": { + "Path": "/", + "CreateDate": "2015-03-09T20:30:24.940Z", + "GroupId": "AIDGPMS9RO4H3FEXAMPLE", + "Arn": "arn:aws:iam::123456789012:group/Admins", + "GroupName": "Admins" + } + } + } + ] + } + }, + "com.amazonaws.iam#CreateGroupRequest": { + "type": "structure", + "members": { + "Path": { + "target": "com.amazonaws.iam#pathType", + "traits": { + "smithy.api#documentation": "

The path to the group. For more information about paths, see IAM\n identifiers in the IAM User Guide.

\n

This parameter is optional. If it is not included, it defaults to a slash (/).

\n

This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including \n most punctuation characters, digits, and upper and lowercased letters.

" + } + }, + "GroupName": { + "target": "com.amazonaws.iam#groupNameType", + "traits": { + "smithy.api#documentation": "

The name of the group to create. Do not include the path in this value.

\n

IAM user, group, role, and policy names must be unique within the account. Names are\n not distinguished by case. For example, you cannot create resources named both\n \"MyResource\" and \"myresource\".

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#CreateGroupResponse": { + "type": "structure", + "members": { + "Group": { + "target": "com.amazonaws.iam#Group", + "traits": { + "smithy.api#documentation": "

A structure containing details about the new group.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful CreateGroup request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#CreateInstanceProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#CreateInstanceProfileRequest" + }, + "output": { + "target": "com.amazonaws.iam#CreateInstanceProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.iam#EntityAlreadyExistsException" + }, + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new instance profile. For information about instance profiles, see Using\n roles for applications on Amazon EC2 in the\n IAM User Guide, and Instance profiles in the Amazon EC2 User Guide.

\n

For information about the number of instance profiles you can create, see IAM object\n quotas in the IAM User Guide.

", + "smithy.api#examples": [ + { + "title": "To create an instance profile", + "documentation": "The following command creates an instance profile named Webserver that is ready to have a role attached and then be associated with an EC2 instance.", + "input": { + "InstanceProfileName": "Webserver" + }, + "output": { + "InstanceProfile": { + "InstanceProfileId": "AIPAJMBYC7DLSPEXAMPLE", + "Roles": [], + "CreateDate": "2015-03-09T20:33:19.626Z", + "InstanceProfileName": "Webserver", + "Path": "/", + "Arn": "arn:aws:iam::123456789012:instance-profile/Webserver" + } + } + } + ] + } + }, + "com.amazonaws.iam#CreateInstanceProfileRequest": { + "type": "structure", + "members": { + "InstanceProfileName": { + "target": "com.amazonaws.iam#instanceProfileNameType", + "traits": { + "smithy.api#documentation": "

The name of the instance profile to create.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "Path": { + "target": "com.amazonaws.iam#pathType", + "traits": { + "smithy.api#documentation": "

The path to the instance profile. For more information about paths, see IAM\n Identifiers in the IAM User Guide.

\n

This parameter is optional. If it is not included, it defaults to a slash (/).

\n

This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including \n most punctuation characters, digits, and upper and lowercased letters.

" + } + }, + "Tags": { + "target": "com.amazonaws.iam#tagListType", + "traits": { + "smithy.api#documentation": "

A list of tags that you want to attach to the newly created IAM instance profile.\n Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

\n \n

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request \n fails and the resource is not created.

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#CreateInstanceProfileResponse": { + "type": "structure", + "members": { + "InstanceProfile": { + "target": "com.amazonaws.iam#InstanceProfile", + "traits": { + "smithy.api#documentation": "

A structure containing details about the new instance profile.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful CreateInstanceProfile request.\n

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#CreateLoginProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#CreateLoginProfileRequest" + }, + "output": { + "target": "com.amazonaws.iam#CreateLoginProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#EntityAlreadyExistsException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#PasswordPolicyViolationException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a password for the specified IAM user. A password allows an IAM user to\n access Amazon Web Services services through the Amazon Web Services Management Console.

\n

You can use the CLI, the Amazon Web Services API, or the Users\n page in the IAM console to create a password for any IAM user. Use ChangePassword to update your own existing password in the My Security Credentials page in the Amazon Web Services Management Console.

\n

For more information about managing passwords, see Managing passwords in the\n IAM User Guide.

", + "smithy.api#examples": [ + { + "title": "To create an instance profile", + "documentation": "The following command changes IAM user Bob's password and sets the flag that required Bob to change the password the next time he signs in.", + "input": { + "UserName": "Bob", + "Password": "h]6EszR}vJ*m", + "PasswordResetRequired": true + }, + "output": { + "LoginProfile": { + "UserName": "Bob", + "CreateDate": "2015-03-10T20:55:40.274Z", + "PasswordResetRequired": true + } + } + } + ] + } + }, + "com.amazonaws.iam#CreateLoginProfileRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#userNameType", + "traits": { + "smithy.api#documentation": "

The name of the IAM user to create a password for. The user must already\n exist.

\n

This parameter is optional. If no user name is included, it defaults to the principal\n making the request. When you make this request with root user credentials, you must use\n an AssumeRoot session to omit the user name.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } + }, + "Password": { + "target": "com.amazonaws.iam#passwordType", + "traits": { + "smithy.api#documentation": "

The new password for the user.

\n

This parameter must be omitted when you make the request with an AssumeRoot session. It is required in all other cases.

\n

The regex pattern \n that is used to validate this parameter is a string of characters. That string can include almost any printable \n ASCII character from the space (\\u0020) through the end of the ASCII character range (\\u00FF). \n You can also include the tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D) \n characters. Any of these characters are valid in a password. However, many tools, such \n as the Amazon Web Services Management Console, might restrict the ability to type certain characters because they have \n special meaning within that tool.

" + } + }, + "PasswordResetRequired": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether the user is required to set a new password on next sign-in.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#CreateLoginProfileResponse": { + "type": "structure", + "members": { + "LoginProfile": { + "target": "com.amazonaws.iam#LoginProfile", + "traits": { + "smithy.api#documentation": "

A structure containing the user name and password create date.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful CreateLoginProfile request.\n

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#CreateOpenIDConnectProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#CreateOpenIDConnectProviderRequest" + }, + "output": { + "target": "com.amazonaws.iam#CreateOpenIDConnectProviderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.iam#EntityAlreadyExistsException" + }, + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#OpenIdIdpCommunicationErrorException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an IAM entity to describe an identity provider (IdP) that supports OpenID Connect (OIDC).

\n

The OIDC provider that you create with this operation can be used as a principal in a\n role's trust policy. Such a policy establishes a trust relationship between Amazon Web Services and\n the OIDC provider.

\n

If you are using an OIDC identity provider from Google, Facebook, or Amazon Cognito, you don't\n need to create a separate IAM identity provider. These OIDC identity providers are\n already built-in to Amazon Web Services and are available for your use. Instead, you can move directly\n to creating new roles using your identity provider. To learn more, see Creating\n a role for web identity or OpenID connect federation in the IAM\n User Guide.

\n

When you create the IAM OIDC provider, you specify the following:

\n
    \n
  • \n

    The URL of the OIDC identity provider (IdP) to trust

    \n
    • \n
  • \n

    A list of client IDs (also known as audiences) that identify the application\n or applications allowed to authenticate using the OIDC provider

    \n
    • \n
  • \n

    A list of tags that are attached to the specified IAM OIDC provider

    \n
    • \n
  • \n

    A list of thumbprints of one or more server certificates that the IdP\n uses

    \n
    • \n
\n

You get all of this information from the OIDC IdP you want to use to access\n Amazon Web Services.

\n \n

Amazon Web Services secures communication with OIDC identity providers (IdPs) using our library of\n trusted root certificate authorities (CAs) to verify the JSON Web Key Set (JWKS)\n endpoint's TLS certificate. If your OIDC IdP relies on a certificate that is not signed\n by one of these trusted CAs, only then we secure communication using the thumbprints set\n in the IdP's configuration.

\n \n \n

The trust for the OIDC provider is derived from the IAM provider that this\n operation creates. Therefore, it is best to limit access to the CreateOpenIDConnectProvider operation to highly privileged\n users.

\n ", + "smithy.api#examples": [ + { + "title": "To create an instance profile", + "documentation": "The following example defines a new OIDC provider in IAM with a client ID of my-application-id and pointing at the server with a URL of https://server.example.com.", + "input": { + "ClientIDList": [ + "my-application-id" + ], + "ThumbprintList": [ + "3768084dfb3d2b68b7897bf5f565da8efEXAMPLE" + ], + "Url": "https://server.example.com" + }, + "output": { + "OpenIDConnectProviderArn": "arn:aws:iam::123456789012:oidc-provider/server.example.com" + } + } + ] + } + }, + "com.amazonaws.iam#CreateOpenIDConnectProviderRequest": { + "type": "structure", + "members": { + "Url": { + "target": "com.amazonaws.iam#OpenIDConnectProviderUrlType", + "traits": { + "smithy.api#documentation": "

The URL of the identity provider. The URL must begin with https:// and\n should correspond to the iss claim in the provider's OpenID Connect ID\n tokens. Per the OIDC standard, path components are allowed but query parameters are not.\n Typically the URL consists of only a hostname, like\n https://server.example.org or https://example.com. The URL\n should not contain a port number.

\n

You cannot register the same provider multiple times in a single Amazon Web Services account. If you\n try to submit a URL that has already been used for an OpenID Connect provider in the\n Amazon Web Services account, you will get an error.

", + "smithy.api#required": {} + } + }, + "ClientIDList": { + "target": "com.amazonaws.iam#clientIDListType", + "traits": { + "smithy.api#documentation": "

Provides a list of client IDs, also known as audiences. When a mobile or web app\n registers with an OpenID Connect provider, they establish a value that identifies the\n application. This is the value that's sent as the client_id parameter on\n OAuth requests.

\n

You can register multiple client IDs with the same provider. For example, you might\n have multiple applications that use the same OIDC provider. You cannot register more\n than 100 client IDs with a single IAM OIDC provider.

\n

There is no defined format for a client ID. The\n CreateOpenIDConnectProviderRequest operation accepts client IDs up to\n 255 characters long.

" + } + }, + "ThumbprintList": { + "target": "com.amazonaws.iam#thumbprintListType", + "traits": { + "smithy.api#documentation": "

A list of server certificate thumbprints for the OpenID Connect (OIDC) identity\n provider's server certificates. Typically this list includes only one entry. However,\n IAM lets you have up to five thumbprints for an OIDC provider. This lets you maintain\n multiple thumbprints if the identity provider is rotating certificates.

\n

This parameter is optional. If it is not included, IAM will retrieve and use the top\n intermediate certificate authority (CA) thumbprint of the OpenID Connect identity\n provider server certificate.

\n

The server certificate thumbprint is the hex-encoded SHA-1 hash value of the X.509\n certificate used by the domain where the OpenID Connect provider makes its keys\n available. It is always a 40-character string.

\n

For example, assume that the OIDC provider is server.example.com and the\n provider stores its keys at https://keys.server.example.com/openid-connect. In that\n case, the thumbprint string would be the hex-encoded SHA-1 hash value of the certificate\n used by https://keys.server.example.com.\n

\n

For more information about obtaining the OIDC provider thumbprint, see Obtaining the\n thumbprint for an OpenID Connect provider in the IAM user\n Guide.

" + } + }, + "Tags": { + "target": "com.amazonaws.iam#tagListType", + "traits": { + "smithy.api#documentation": "

A list of tags that you want to attach to the new IAM OpenID Connect (OIDC) provider.\n Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

\n \n

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request \n fails and the resource is not created.

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#CreateOpenIDConnectProviderResponse": { + "type": "structure", + "members": { + "OpenIDConnectProviderArn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the new IAM OpenID Connect provider that is\n created. For more information, see OpenIDConnectProviderListEntry.\n

" + } + }, + "Tags": { + "target": "com.amazonaws.iam#tagListType", + "traits": { + "smithy.api#documentation": "

A list of tags that are attached to the new IAM OIDC provider. The returned list of\n tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful CreateOpenIDConnectProvider\n request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#CreatePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#CreatePolicyRequest" + }, + "output": { + "target": "com.amazonaws.iam#CreatePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.iam#EntityAlreadyExistsException" + }, + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#MalformedPolicyDocumentException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new managed policy for your Amazon Web Services account.

\n

This operation creates a policy version with a version identifier of v1\n and sets v1 as the policy's default version. For more information about policy versions,\n see Versioning for managed policies in the\n IAM User Guide.

\n

As a best practice, you can validate your IAM policies. \n To learn more, see Validating IAM policies \n in the IAM User Guide.

\n

For more information about managed policies in general, see Managed\n policies and inline policies in the\n IAM User Guide.

" + } + }, + "com.amazonaws.iam#CreatePolicyRequest": { + "type": "structure", + "members": { + "PolicyName": { + "target": "com.amazonaws.iam#policyNameType", + "traits": { + "smithy.api#documentation": "

The friendly name of the policy.

\n

IAM user, group, role, and policy names must be unique within the account. Names are\n not distinguished by case. For example, you cannot create resources named both\n \"MyResource\" and \"myresource\".

", + "smithy.api#required": {} + } + }, + "Path": { + "target": "com.amazonaws.iam#policyPathType", + "traits": { + "smithy.api#documentation": "

The path for the policy.

\n

For more information about paths, see IAM identifiers in the\n IAM User Guide.

\n

This parameter is optional. If it is not included, it defaults to a slash (/).

\n

This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including \n most punctuation characters, digits, and upper and lowercased letters.

\n \n

You cannot use an asterisk (*) in the path name.

\n " + } + }, + "PolicyDocument": { + "target": "com.amazonaws.iam#policyDocumentType", + "traits": { + "smithy.api#documentation": "

The JSON policy document that you want to use as the content for the new\n policy.

\n

You must provide policies in JSON format in IAM. However, for CloudFormation\n templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to\n IAM.

\n

The maximum length of the policy document that you can pass in this operation,\n including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.

\n

To learn more about JSON policy grammar, see Grammar of the IAM JSON\n policy language in the IAM User Guide.

\n

The regex pattern \n used to validate this parameter is a string of characters consisting of the following:

\n
    \n
  • \n

    Any printable ASCII \n character ranging from the space character (\\u0020) through the end of the ASCII character range

    \n
    • \n
  • \n

    The printable characters in the Basic Latin and Latin-1 Supplement character set \n (through \\u00FF)

    \n
    • \n
  • \n

    The special characters tab (\\u0009), line feed (\\u000A), and \n carriage return (\\u000D)

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.iam#policyDescriptionType", + "traits": { + "smithy.api#documentation": "

A friendly description of the policy.

\n

Typically used to store information about the permissions defined in the policy. For\n example, \"Grants access to production DynamoDB tables.\"

\n

The policy description is immutable. After a value is assigned, it cannot be\n changed.

" + } + }, + "Tags": { + "target": "com.amazonaws.iam#tagListType", + "traits": { + "smithy.api#documentation": "

A list of tags that you want to attach to the new IAM customer managed policy.\n Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

\n \n

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request \n fails and the resource is not created.

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#CreatePolicyResponse": { + "type": "structure", + "members": { + "Policy": { + "target": "com.amazonaws.iam#Policy", + "traits": { + "smithy.api#documentation": "

A structure containing details about the new policy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful CreatePolicy request.\n

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#CreatePolicyVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#CreatePolicyVersionRequest" + }, + "output": { + "target": "com.amazonaws.iam#CreatePolicyVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#MalformedPolicyDocumentException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new version of the specified managed policy. To update a managed policy, you\n create a new policy version. A managed policy can have up to five versions. If the\n policy has five versions, you must delete an existing version using DeletePolicyVersion before you create a new version.

\n

Optionally, you can set the new version as the policy's default version. The default\n version is the version that is in effect for the IAM users, groups, and roles to which\n the policy is attached.

\n

For more information about managed policy versions, see Versioning for managed\n policies in the IAM User Guide.

" + } + }, + "com.amazonaws.iam#CreatePolicyVersionRequest": { + "type": "structure", + "members": { + "PolicyArn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM policy to which you want to add a new\n version.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

", + "smithy.api#required": {} + } + }, + "PolicyDocument": { + "target": "com.amazonaws.iam#policyDocumentType", + "traits": { + "smithy.api#documentation": "

The JSON policy document that you want to use as the content for this new version of\n the policy.

\n

You must provide policies in JSON format in IAM. However, for CloudFormation\n templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to\n IAM.

\n

The maximum length of the policy document that you can pass in this operation,\n including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.

\n

The regex pattern \n used to validate this parameter is a string of characters consisting of the following:

\n
    \n
  • \n

    Any printable ASCII \n character ranging from the space character (\\u0020) through the end of the ASCII character range

    \n
    • \n
  • \n

    The printable characters in the Basic Latin and Latin-1 Supplement character set \n (through \\u00FF)

    \n
    • \n
  • \n

    The special characters tab (\\u0009), line feed (\\u000A), and \n carriage return (\\u000D)

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "SetAsDefault": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether to set this version as the policy's default version.

\n

When this parameter is true, the new policy version becomes the operative\n version. That is, it becomes the version that is in effect for the IAM users, groups,\n and roles that the policy is attached to.

\n

For more information about managed policy versions, see Versioning for managed\n policies in the IAM User Guide.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#CreatePolicyVersionResponse": { + "type": "structure", + "members": { + "PolicyVersion": { + "target": "com.amazonaws.iam#PolicyVersion", + "traits": { + "smithy.api#documentation": "

A structure containing details about the new policy version.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful CreatePolicyVersion request.\n

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#CreateRole": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#CreateRoleRequest" + }, + "output": { + "target": "com.amazonaws.iam#CreateRoleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.iam#EntityAlreadyExistsException" + }, + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#MalformedPolicyDocumentException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new role for your Amazon Web Services account.

\n

For more information about roles, see IAM roles in the\n IAM User Guide. For information about quotas for role names\n and the number of roles you can create, see IAM and STS quotas in the\n IAM User Guide.

", + "smithy.api#examples": [ + { + "title": "To create an IAM role", + "documentation": "The following command creates a role named Test-Role and attaches a trust policy that you must convert from JSON to a string. Upon success, the response includes the same policy as a URL-encoded JSON string.", + "input": { + "AssumeRolePolicyDocument": "", + "Path": "/", + "RoleName": "Test-Role" + }, + "output": { + "Role": { + "Arn": "arn:aws:iam::123456789012:role/Test-Role", + "AssumeRolePolicyDocument": "", + "CreateDate": "2013-06-07T20:43:32.821Z", + "Path": "/", + "RoleId": "AKIAIOSFODNN7EXAMPLE", + "RoleName": "Test-Role" + } + } + } + ] + } + }, + "com.amazonaws.iam#CreateRoleRequest": { + "type": "structure", + "members": { + "Path": { + "target": "com.amazonaws.iam#pathType", + "traits": { + "smithy.api#documentation": "

The path to the role. For more information about paths, see IAM\n Identifiers in the IAM User Guide.

\n

This parameter is optional. If it is not included, it defaults to a slash (/).

\n

This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including \n most punctuation characters, digits, and upper and lowercased letters.

" + } + }, + "RoleName": { + "target": "com.amazonaws.iam#roleNameType", + "traits": { + "smithy.api#documentation": "

The name of the role to create.

\n

IAM user, group, role, and policy names must be unique within the account. Names are\n not distinguished by case. For example, you cannot create resources named both\n \"MyResource\" and \"myresource\".

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "AssumeRolePolicyDocument": { + "target": "com.amazonaws.iam#policyDocumentType", + "traits": { + "smithy.api#documentation": "

The trust relationship policy document that grants an entity permission to assume the\n role.

\n

In IAM, you must provide a JSON policy that has been converted to a string. However,\n for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML\n format. CloudFormation always converts a YAML policy to JSON format before submitting it to\n IAM.

\n

The regex pattern \n used to validate this parameter is a string of characters consisting of the following:

\n
    \n
  • \n

    Any printable ASCII \n character ranging from the space character (\\u0020) through the end of the ASCII character range

    \n
    • \n
  • \n

    The printable characters in the Basic Latin and Latin-1 Supplement character set \n (through \\u00FF)

    \n
    • \n
  • \n

    The special characters tab (\\u0009), line feed (\\u000A), and \n carriage return (\\u000D)

    \n
    • \n
\n

Upon success, the response includes the same trust policy in JSON format.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.iam#roleDescriptionType", + "traits": { + "smithy.api#documentation": "

A description of the role.

" + } + }, + "MaxSessionDuration": { + "target": "com.amazonaws.iam#roleMaxSessionDurationType", + "traits": { + "smithy.api#documentation": "

The maximum session duration (in seconds) that you want to set for the specified role.\n If you do not specify a value for this setting, the default value of one hour is\n applied. This setting can have a value from 1 hour to 12 hours.

\n

Anyone who assumes the role from the CLI or API can use the\n DurationSeconds API parameter or the duration-seconds\n CLI parameter to request a longer session. The MaxSessionDuration setting\n determines the maximum duration that can be requested using the\n DurationSeconds parameter. If users don't specify a value for the\n DurationSeconds parameter, their security credentials are valid for one\n hour by default. This applies when you use the AssumeRole* API operations\n or the assume-role* CLI operations but does not apply when you use those\n operations to create a console URL. For more information, see Using IAM\n roles in the IAM User Guide.

" + } + }, + "PermissionsBoundary": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The ARN of the managed policy that is used to set the permissions boundary for the\n role.

\n

A permissions boundary policy defines the maximum permissions that identity-based\n policies can grant to an entity, but does not grant permissions. Permissions boundaries\n do not define the maximum permissions that a resource-based policy can grant to an\n entity. To learn more, see Permissions boundaries\n for IAM entities in the IAM User Guide.

\n

For more information about policy types, see Policy types\n in the IAM User Guide.

" + } + }, + "Tags": { + "target": "com.amazonaws.iam#tagListType", + "traits": { + "smithy.api#documentation": "

A list of tags that you want to attach to the new role. Each tag consists of a key name and an associated value.\n For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

\n \n

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request \n fails and the resource is not created.

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#CreateRoleResponse": { + "type": "structure", + "members": { + "Role": { + "target": "com.amazonaws.iam#Role", + "traits": { + "smithy.api#documentation": "

A structure containing details about the new role.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful CreateRole request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#CreateSAMLProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#CreateSAMLProviderRequest" + }, + "output": { + "target": "com.amazonaws.iam#CreateSAMLProviderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.iam#EntityAlreadyExistsException" + }, + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an IAM resource that describes an identity provider (IdP) that supports SAML\n 2.0.

\n

The SAML provider resource that you create with this operation can be used as a\n principal in an IAM role's trust policy. Such a policy can enable federated users who\n sign in using the SAML IdP to assume the role. You can create an IAM role that\n supports Web-based single sign-on (SSO) to the Amazon Web Services Management Console or one that supports API access\n to Amazon Web Services.

\n

When you create the SAML provider resource, you upload a SAML metadata document that\n you get from your IdP. That document includes the issuer's name, expiration information,\n and keys that can be used to validate the SAML authentication response (assertions) that\n the IdP sends. You must generate the metadata document using the identity management\n software that is used as your organization's IdP.

\n \n

This operation requires Signature Version 4.

\n \n

For more information, see Enabling SAML 2.0\n federated users to access the Amazon Web Services Management Console and About SAML 2.0-based\n federation in the IAM User Guide.

" + } + }, + "com.amazonaws.iam#CreateSAMLProviderRequest": { + "type": "structure", + "members": { + "SAMLMetadataDocument": { + "target": "com.amazonaws.iam#SAMLMetadataDocumentType", + "traits": { + "smithy.api#documentation": "

An XML document generated by an identity provider (IdP) that supports SAML 2.0. The\n document includes the issuer's name, expiration information, and keys that can be used\n to validate the SAML authentication response (assertions) that are received from the\n IdP. You must generate the metadata document using the identity management software that\n is used as your organization's IdP.

\n

For more information, see About SAML 2.0-based\n federation in the IAM User Guide\n

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.iam#SAMLProviderNameType", + "traits": { + "smithy.api#documentation": "

The name of the provider to create.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.iam#tagListType", + "traits": { + "smithy.api#documentation": "

A list of tags that you want to attach to the new IAM SAML provider.\n Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

\n \n

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request \n fails and the resource is not created.

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#CreateSAMLProviderResponse": { + "type": "structure", + "members": { + "SAMLProviderArn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the new SAML provider resource in IAM.

" + } + }, + "Tags": { + "target": "com.amazonaws.iam#tagListType", + "traits": { + "smithy.api#documentation": "

A list of tags that are attached to the new IAM SAML provider. The returned list of tags is sorted by tag key.\n For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful CreateSAMLProvider request.\n

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#CreateServiceLinkedRole": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#CreateServiceLinkedRoleRequest" + }, + "output": { + "target": "com.amazonaws.iam#CreateServiceLinkedRoleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an IAM role that is linked to a specific Amazon Web Services service. The service controls\n the attached policies and when the role can be deleted. This helps ensure that the\n service is not broken by an unexpectedly changed or deleted role, which could put your\n Amazon Web Services resources into an unknown state. Allowing the service to control the role helps\n improve service stability and proper cleanup when a service and its role are no longer\n needed. For more information, see Using service-linked\n roles in the IAM User Guide.

\n

To attach a policy to this service-linked role, you must make the request using the\n Amazon Web Services service that depends on this role.

" + } + }, + "com.amazonaws.iam#CreateServiceLinkedRoleRequest": { + "type": "structure", + "members": { + "AWSServiceName": { + "target": "com.amazonaws.iam#groupNameType", + "traits": { + "smithy.api#documentation": "

The service principal for the Amazon Web Services service to which this role is attached. You use a\n string similar to a URL but without the http:// in front. For example:\n elasticbeanstalk.amazonaws.com.

\n

Service principals are unique and case-sensitive. To find the exact service principal\n for your service-linked role, see Amazon Web Services services\n that work with IAM in the IAM User Guide. Look for\n the services that have Yes in the Service-Linked Role column. Choose the Yes link to view the service-linked role documentation for that\n service.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.iam#roleDescriptionType", + "traits": { + "smithy.api#documentation": "

The description of the role.

" + } + }, + "CustomSuffix": { + "target": "com.amazonaws.iam#customSuffixType", + "traits": { + "smithy.api#documentation": "

\n

A string that you provide, which is combined with the service-provided prefix to form\n the complete role name. If you make multiple requests for the same service, then you\n must supply a different CustomSuffix for each request. Otherwise the\n request fails with a duplicate role name error. For example, you could add\n -1 or -debug to the suffix.

\n

Some services do not support the CustomSuffix parameter. If you provide\n an optional suffix and the operation fails, try the operation again without the\n suffix.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#CreateServiceLinkedRoleResponse": { + "type": "structure", + "members": { + "Role": { + "target": "com.amazonaws.iam#Role", + "traits": { + "smithy.api#documentation": "

A Role object that contains details about the newly created\n role.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#CreateServiceSpecificCredential": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#CreateServiceSpecificCredentialRequest" + }, + "output": { + "target": "com.amazonaws.iam#CreateServiceSpecificCredentialResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceNotSupportedException" + } + ], + "traits": { + "smithy.api#documentation": "

Generates a set of credentials consisting of a user name and password that can be used\n to access the service specified in the request. These credentials are generated by\n IAM, and can be used only for the specified service.

\n

You can have a maximum of two sets of service-specific credentials for each supported\n service per user.

\n

You can create service-specific credentials for CodeCommit and Amazon Keyspaces (for Apache\n Cassandra).

\n

You can reset the password to a new service-generated value by calling ResetServiceSpecificCredential.

\n

For more information about service-specific credentials, see Using IAM\n with CodeCommit: Git credentials, SSH keys, and Amazon Web Services access keys in the\n IAM User Guide.

" + } + }, + "com.amazonaws.iam#CreateServiceSpecificCredentialRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#userNameType", + "traits": { + "smithy.api#documentation": "

The name of the IAM user that is to be associated with the credentials. The new\n service-specific credentials have the same permissions as the associated user except\n that they can be used only to access the specified service.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "ServiceName": { + "target": "com.amazonaws.iam#serviceName", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Web Services service that is to be associated with the credentials. The\n service you specify here is the only service that can be accessed using these\n credentials.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#CreateServiceSpecificCredentialResponse": { + "type": "structure", + "members": { + "ServiceSpecificCredential": { + "target": "com.amazonaws.iam#ServiceSpecificCredential", + "traits": { + "smithy.api#documentation": "

A structure that contains information about the newly created service-specific\n credential.

\n \n

This is the only time that the password for this credential set is available. It\n cannot be recovered later. Instead, you must reset the password with ResetServiceSpecificCredential.

\n " + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#CreateUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#CreateUserRequest" + }, + "output": { + "target": "com.amazonaws.iam#CreateUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.iam#EntityAlreadyExistsException" + }, + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new IAM user for your Amazon Web Services account.

\n

For information about quotas for the number of IAM users you can create, see IAM and STS\n quotas in the IAM User Guide.

", + "smithy.api#examples": [ + { + "title": "To create an IAM user", + "documentation": "The following create-user command creates an IAM user named Bob in the current account.", + "input": { + "UserName": "Bob" + }, + "output": { + "User": { + "UserName": "Bob", + "Path": "/", + "CreateDate": "2013-06-08T03:20:41.270Z", + "UserId": "AKIAIOSFODNN7EXAMPLE", + "Arn": "arn:aws:iam::123456789012:user/Bob" + } + } + } + ] + } + }, + "com.amazonaws.iam#CreateUserRequest": { + "type": "structure", + "members": { + "Path": { + "target": "com.amazonaws.iam#pathType", + "traits": { + "smithy.api#documentation": "

The path for the user name. For more information about paths, see IAM\n identifiers in the IAM User Guide.

\n

This parameter is optional. If it is not included, it defaults to a slash (/).

\n

This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including \n most punctuation characters, digits, and upper and lowercased letters.

" + } + }, + "UserName": { + "target": "com.amazonaws.iam#userNameType", + "traits": { + "smithy.api#documentation": "

The name of the user to create.

\n

IAM user, group, role, and policy names must be unique within the account. Names are\n not distinguished by case. For example, you cannot create resources named both\n \"MyResource\" and \"myresource\".

", + "smithy.api#required": {} + } + }, + "PermissionsBoundary": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The ARN of the managed policy that is used to set the permissions boundary for the\n user.

\n

A permissions boundary policy defines the maximum permissions that identity-based\n policies can grant to an entity, but does not grant permissions. Permissions boundaries\n do not define the maximum permissions that a resource-based policy can grant to an\n entity. To learn more, see Permissions boundaries\n for IAM entities in the IAM User Guide.

\n

For more information about policy types, see Policy types\n in the IAM User Guide.

" + } + }, + "Tags": { + "target": "com.amazonaws.iam#tagListType", + "traits": { + "smithy.api#documentation": "

A list of tags that you want to attach to the new user. Each tag consists of a key name and an associated value.\n For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

\n \n

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request \n fails and the resource is not created.

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#CreateUserResponse": { + "type": "structure", + "members": { + "User": { + "target": "com.amazonaws.iam#User", + "traits": { + "smithy.api#documentation": "

A structure with details about the new IAM user.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful CreateUser request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#CreateVirtualMFADevice": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#CreateVirtualMFADeviceRequest" + }, + "output": { + "target": "com.amazonaws.iam#CreateVirtualMFADeviceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.iam#EntityAlreadyExistsException" + }, + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new virtual MFA device for the Amazon Web Services account. After creating the virtual\n MFA, use EnableMFADevice to attach the MFA device to an IAM user.\n For more information about creating and working with virtual MFA devices, see Using a virtual MFA\n device in the IAM User Guide.

\n

For information about the maximum number of MFA devices you can create, see IAM and STS\n quotas in the IAM User Guide.

\n \n

The seed information contained in the QR code and the Base32 string should be\n treated like any other secret access information. In other words, protect the seed\n information as you would your Amazon Web Services access keys or your passwords. After you\n provision your virtual device, you should ensure that the information is destroyed\n following secure procedures.

\n " + } + }, + "com.amazonaws.iam#CreateVirtualMFADeviceRequest": { + "type": "structure", + "members": { + "Path": { + "target": "com.amazonaws.iam#pathType", + "traits": { + "smithy.api#documentation": "

The path for the virtual MFA device. For more information about paths, see IAM\n identifiers in the IAM User Guide.

\n

This parameter is optional. If it is not included, it defaults to a slash (/).

\n

This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including \n most punctuation characters, digits, and upper and lowercased letters.

" + } + }, + "VirtualMFADeviceName": { + "target": "com.amazonaws.iam#virtualMFADeviceName", + "traits": { + "smithy.api#documentation": "

The name of the virtual MFA device, which must be unique. Use with path to uniquely\n identify a virtual MFA device.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.iam#tagListType", + "traits": { + "smithy.api#documentation": "

A list of tags that you want to attach to the new IAM virtual MFA device.\n Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

\n \n

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request \n fails and the resource is not created.

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#CreateVirtualMFADeviceResponse": { + "type": "structure", + "members": { + "VirtualMFADevice": { + "target": "com.amazonaws.iam#VirtualMFADevice", + "traits": { + "smithy.api#documentation": "

A structure containing details about the new virtual MFA device.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful CreateVirtualMFADevice request.\n

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#CredentialReportExpiredException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iam#credentialReportExpiredExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ReportExpired", + "httpResponseCode": 410 + }, + "smithy.api#documentation": "

The request was rejected because the most recent credential report has expired. To\n generate a new credential report, use GenerateCredentialReport. For more\n information about credential report expiration, see Getting credential reports in the\n IAM User Guide.

", + "smithy.api#error": "client", + "smithy.api#httpError": 410 + } + }, + "com.amazonaws.iam#CredentialReportNotPresentException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iam#credentialReportNotPresentExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ReportNotPresent", + "httpResponseCode": 410 + }, + "smithy.api#documentation": "

The request was rejected because the credential report does not exist. To generate a\n credential report, use GenerateCredentialReport.

", + "smithy.api#error": "client", + "smithy.api#httpError": 410 + } + }, + "com.amazonaws.iam#CredentialReportNotReadyException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iam#credentialReportNotReadyExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ReportInProgress", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The request was rejected because the credential report is still being generated.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.iam#DeactivateMFADevice": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#DeactivateMFADeviceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.iam#EntityTemporarilyUnmodifiableException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Deactivates the specified MFA device and removes it from association with the user\n name for which it was originally enabled.

\n

For more information about creating and working with virtual MFA devices, see Enabling a virtual\n multi-factor authentication (MFA) device in the\n IAM User Guide.

" + } + }, + "com.amazonaws.iam#DeactivateMFADeviceRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#existingUserNameType", + "traits": { + "smithy.api#documentation": "

The name of the user whose MFA device you want to deactivate.

\n

This parameter is optional. If no user name is included, it defaults to the principal\n making the request. When you make this request with root user credentials, you must use\n an AssumeRoot session to omit the user name.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } + }, + "SerialNumber": { + "target": "com.amazonaws.iam#serialNumberType", + "traits": { + "smithy.api#documentation": "

The serial number that uniquely identifies the MFA device. For virtual MFA devices,\n the serial number is the device ARN.

\n

This parameter allows (through its regex pattern) a string of characters consisting \n of upper and lowercase alphanumeric characters with no spaces. You can also include any of the \n following characters: =,.@:/-

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#DeleteAccessKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#DeleteAccessKeyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the access key pair associated with the specified IAM user.

\n

If you do not specify a user name, IAM determines the user name implicitly based on\n the Amazon Web Services access key ID signing the request. This operation works for access keys under\n the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root\n user credentials even if the Amazon Web Services account has no associated users.

", + "smithy.api#examples": [ + { + "title": "To delete an access key for an IAM user", + "documentation": "The following command deletes one access key (access key ID and secret access key) assigned to the IAM user named Bob.", + "input": { + "UserName": "Bob", + "AccessKeyId": "AKIDPMS9RO4H3FEXAMPLE" + } + } + ] + } + }, + "com.amazonaws.iam#DeleteAccessKeyRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#existingUserNameType", + "traits": { + "smithy.api#documentation": "

The name of the user whose access key pair you want to delete.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } + }, + "AccessKeyId": { + "target": "com.amazonaws.iam#accessKeyIdType", + "traits": { + "smithy.api#documentation": "

The access key ID for the access key ID and secret access key you want to\n delete.

\n

This parameter allows (through its regex pattern) a string of characters that can \n consist of any upper or lowercased letter or digit.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#DeleteAccountAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#DeleteAccountAliasRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified Amazon Web Services account alias. For information about using an Amazon Web Services\n account alias, see Creating, deleting, and\n listing an Amazon Web Services account alias in the Amazon Web Services Sign-In User\n Guide.

", + "smithy.api#examples": [ + { + "title": "To delete an account alias", + "documentation": "The following command removes the alias mycompany from the current AWS account:", + "input": { + "AccountAlias": "mycompany" + } + } + ] + } + }, + "com.amazonaws.iam#DeleteAccountAliasRequest": { + "type": "structure", + "members": { + "AccountAlias": { + "target": "com.amazonaws.iam#accountAliasType", + "traits": { + "smithy.api#documentation": "

The name of the account alias to delete.

\n

This parameter allows (through its regex pattern) a string of characters consisting of \n lowercase letters, digits, and dashes. You cannot start or finish with a dash, nor can you have \n two dashes in a row.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#DeleteAccountPasswordPolicy": { + "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the password policy for the Amazon Web Services account. There are no parameters.

", + "smithy.api#examples": [ + { + "title": "To delete the current account password policy", + "documentation": "The following command removes the password policy from the current AWS account:" + } + ] + } + }, + "com.amazonaws.iam#DeleteConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iam#deleteConflictMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DeleteConflict", + "httpResponseCode": 409 + }, + "smithy.api#documentation": "

The request was rejected because it attempted to delete a resource that has attached\n subordinate entities. The error message describes these entities.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.iam#DeleteGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#DeleteGroupRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#DeleteConflictException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified IAM group. The group must not contain any users or have any\n attached policies.

" + } + }, + "com.amazonaws.iam#DeleteGroupPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#DeleteGroupPolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified inline policy that is embedded in the specified IAM\n group.

\n

A group can also have managed policies attached to it. To detach a managed policy from\n a group, use DetachGroupPolicy. For more information about policies,\n refer to Managed policies and inline\n policies in the IAM User Guide.

", + "smithy.api#examples": [ + { + "title": "To delete a policy from an IAM group", + "documentation": "The following command deletes the policy named ExamplePolicy from the group named Admins:", + "input": { + "GroupName": "Admins", + "PolicyName": "ExamplePolicy" + } + } + ] + } + }, + "com.amazonaws.iam#DeleteGroupPolicyRequest": { + "type": "structure", + "members": { + "GroupName": { + "target": "com.amazonaws.iam#groupNameType", + "traits": { + "smithy.api#documentation": "

The name (friendly name, not ARN) identifying the group that the policy is embedded\n in.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "PolicyName": { + "target": "com.amazonaws.iam#policyNameType", + "traits": { + "smithy.api#documentation": "

The name identifying the policy document to delete.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#DeleteGroupRequest": { + "type": "structure", + "members": { + "GroupName": { + "target": "com.amazonaws.iam#groupNameType", + "traits": { + "smithy.api#documentation": "

The name of the IAM group to delete.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#DeleteInstanceProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#DeleteInstanceProfileRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#DeleteConflictException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified instance profile. The instance profile must not have an\n associated role.

\n \n

Make sure that you do not have any Amazon EC2 instances running with the instance\n profile you are about to delete. Deleting a role or instance profile that is\n associated with a running instance will break any applications running on the\n instance.

\n \n

For more information about instance profiles, see Using\n instance profiles in the IAM User Guide.

", + "smithy.api#examples": [ + { + "title": "To delete an instance profile", + "documentation": "The following command deletes the instance profile named ExampleInstanceProfile", + "input": { + "InstanceProfileName": "ExampleInstanceProfile" + } + } + ] + } + }, + "com.amazonaws.iam#DeleteInstanceProfileRequest": { + "type": "structure", + "members": { + "InstanceProfileName": { + "target": "com.amazonaws.iam#instanceProfileNameType", + "traits": { + "smithy.api#documentation": "

The name of the instance profile to delete.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#DeleteLoginProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#DeleteLoginProfileRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#EntityTemporarilyUnmodifiableException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the password for the specified IAM user, For more information, see Managing\n passwords for IAM users.

\n

You can use the CLI, the Amazon Web Services API, or the Users\n page in the IAM console to delete a password for any IAM user. You can use ChangePassword to update, but not delete, your own password in the\n My Security Credentials page in the\n Amazon Web Services Management Console.

\n \n

Deleting a user's password does not prevent a user from accessing Amazon Web Services through\n the command line interface or the API. To prevent all user access, you must also\n either make any access keys inactive or delete them. For more information about\n making keys inactive or deleting them, see UpdateAccessKey and\n DeleteAccessKey.

\n ", + "smithy.api#examples": [ + { + "title": "To delete a password for an IAM user", + "documentation": "The following command deletes the password for the IAM user named Bob.", + "input": { + "UserName": "Bob" + } + } + ] + } + }, + "com.amazonaws.iam#DeleteLoginProfileRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#userNameType", + "traits": { + "smithy.api#documentation": "

The name of the user whose password you want to delete.

\n

This parameter is optional. If no user name is included, it defaults to the principal\n making the request. When you make this request with root user credentials, you must use\n an AssumeRoot session to omit the user name.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#DeleteOpenIDConnectProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#DeleteOpenIDConnectProviderRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an OpenID Connect identity provider (IdP) resource object in IAM.

\n

Deleting an IAM OIDC provider resource does not update any roles that reference the\n provider as a principal in their trust policies. Any attempt to assume a role that\n references a deleted provider fails.

\n

This operation is idempotent; it does not fail or return an error if you call the\n operation for a provider that does not exist.

" + } + }, + "com.amazonaws.iam#DeleteOpenIDConnectProviderRequest": { + "type": "structure", + "members": { + "OpenIDConnectProviderArn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM OpenID Connect provider resource object to\n delete. You can get a list of OpenID Connect provider resource ARNs by using the ListOpenIDConnectProviders operation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#DeletePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#DeletePolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#DeleteConflictException" + }, + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified managed policy.

\n

Before you can delete a managed policy, you must first detach the policy from all\n users, groups, and roles that it is attached to. In addition, you must delete all the\n policy's versions. The following steps describe the process for deleting a managed\n policy:

\n
    \n
  • \n

    Detach the policy from all users, groups, and roles that the policy is\n attached to, using DetachUserPolicy, DetachGroupPolicy, or DetachRolePolicy. To\n list all the users, groups, and roles that a policy is attached to, use ListEntitiesForPolicy.

    \n
    • \n
  • \n

    Delete all versions of the policy using DeletePolicyVersion.\n To list the policy's versions, use ListPolicyVersions. You\n cannot use DeletePolicyVersion to delete the version that is\n marked as the default version. You delete the policy's default version in the\n next step of the process.

    \n
    • \n
  • \n

    Delete the policy (this automatically deletes the policy's default version)\n using this operation.

    \n
    • \n
\n

For information about managed policies, see Managed policies and inline\n policies in the IAM User Guide.

" + } + }, + "com.amazonaws.iam#DeletePolicyRequest": { + "type": "structure", + "members": { + "PolicyArn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM policy you want to delete.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#DeletePolicyVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#DeletePolicyVersionRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#DeleteConflictException" + }, + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified version from the specified managed policy.

\n

You cannot delete the default version from a policy using this operation. To delete\n the default version from a policy, use DeletePolicy. To find out which\n version of a policy is marked as the default version, use ListPolicyVersions.

\n

For information about versions for managed policies, see Versioning for managed\n policies in the IAM User Guide.

" + } + }, + "com.amazonaws.iam#DeletePolicyVersionRequest": { + "type": "structure", + "members": { + "PolicyArn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM policy from which you want to delete a\n version.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

", + "smithy.api#required": {} + } + }, + "VersionId": { + "target": "com.amazonaws.iam#policyVersionIdType", + "traits": { + "smithy.api#documentation": "

The policy version to delete.

\n

This parameter allows (through its regex pattern) a string of characters that \n consists of the lowercase letter 'v' followed by one or two digits, and optionally \n followed by a period '.' and a string of letters and digits.

\n

For more information about managed policy versions, see Versioning for managed\n policies in the IAM User Guide.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#DeleteRole": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#DeleteRoleRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.iam#DeleteConflictException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + }, + { + "target": "com.amazonaws.iam#UnmodifiableEntityException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified role. Unlike the Amazon Web Services Management Console, when you delete a role\n programmatically, you must delete the items attached to the role manually, or the\n deletion fails. For more information, see Deleting an IAM role. Before attempting to delete a role, remove the\n following attached items:

\n \n \n

Make sure that you do not have any Amazon EC2 instances running with the role you are\n about to delete. Deleting a role or instance profile that is associated with a\n running instance will break any applications running on the instance.

\n ", + "smithy.api#examples": [ + { + "title": "To delete an IAM role", + "documentation": "The following command removes the role named Test-Role.", + "input": { + "RoleName": "Test-Role" + } + } + ] + } + }, + "com.amazonaws.iam#DeleteRolePermissionsBoundary": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#DeleteRolePermissionsBoundaryRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + }, + { + "target": "com.amazonaws.iam#UnmodifiableEntityException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the permissions boundary for the specified IAM role.

\n

You cannot set the boundary for a service-linked role.

\n \n

Deleting the permissions boundary for a role might increase its permissions. For\n example, it might allow anyone who assumes the role to perform all the actions\n granted in its permissions policies.

\n " + } + }, + "com.amazonaws.iam#DeleteRolePermissionsBoundaryRequest": { + "type": "structure", + "members": { + "RoleName": { + "target": "com.amazonaws.iam#roleNameType", + "traits": { + "smithy.api#documentation": "

The name (friendly name, not ARN) of the IAM role from which you want to remove the\n permissions boundary.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#DeleteRolePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#DeleteRolePolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + }, + { + "target": "com.amazonaws.iam#UnmodifiableEntityException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified inline policy that is embedded in the specified IAM\n role.

\n

A role can also have managed policies attached to it. To detach a managed policy from\n a role, use DetachRolePolicy. For more information about policies,\n refer to Managed policies and inline\n policies in the IAM User Guide.

", + "smithy.api#examples": [ + { + "title": "To remove a policy from an IAM role", + "documentation": "The following command removes the policy named ExamplePolicy from the role named Test-Role.", + "input": { + "RoleName": "Test-Role", + "PolicyName": "ExamplePolicy" + } + } + ] + } + }, + "com.amazonaws.iam#DeleteRolePolicyRequest": { + "type": "structure", + "members": { + "RoleName": { + "target": "com.amazonaws.iam#roleNameType", + "traits": { + "smithy.api#documentation": "

The name (friendly name, not ARN) identifying the role that the policy is embedded\n in.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "PolicyName": { + "target": "com.amazonaws.iam#policyNameType", + "traits": { + "smithy.api#documentation": "

The name of the inline policy to delete from the specified IAM role.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#DeleteRoleRequest": { + "type": "structure", + "members": { + "RoleName": { + "target": "com.amazonaws.iam#roleNameType", + "traits": { + "smithy.api#documentation": "

The name of the role to delete.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#DeleteSAMLProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#DeleteSAMLProviderRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a SAML provider resource in IAM.

\n

Deleting the provider resource from IAM does not update any roles that reference the\n SAML provider resource's ARN as a principal in their trust policies. Any attempt to\n assume a role that references a non-existent provider resource ARN fails.

\n \n

This operation requires Signature Version 4.

\n " + } + }, + "com.amazonaws.iam#DeleteSAMLProviderRequest": { + "type": "structure", + "members": { + "SAMLProviderArn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SAML provider to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#DeleteSSHPublicKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#DeleteSSHPublicKeyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#NoSuchEntityException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified SSH public key.

\n

The SSH public key deleted by this operation is used only for authenticating the\n associated IAM user to an CodeCommit repository. For more information about using SSH keys\n to authenticate to an CodeCommit repository, see Set up CodeCommit for\n SSH connections in the CodeCommit User Guide.

" + } + }, + "com.amazonaws.iam#DeleteSSHPublicKeyRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#userNameType", + "traits": { + "smithy.api#documentation": "

The name of the IAM user associated with the SSH public key.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "SSHPublicKeyId": { + "target": "com.amazonaws.iam#publicKeyIdType", + "traits": { + "smithy.api#documentation": "

The unique identifier for the SSH public key.

\n

This parameter allows (through its regex pattern) a string of characters that can \n consist of any upper or lowercased letter or digit.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#DeleteServerCertificate": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#DeleteServerCertificateRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#DeleteConflictException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified server certificate.

\n

For more information about working with server certificates, see Working\n with server certificates in the IAM User Guide. This\n topic also includes a list of Amazon Web Services services that can use the server certificates that\n you manage with IAM.

\n \n

If you are using a server certificate with Elastic Load Balancing, deleting the\n certificate could have implications for your application. If Elastic Load Balancing\n doesn't detect the deletion of bound certificates, it may continue to use the\n certificates. This could cause Elastic Load Balancing to stop accepting traffic. We\n recommend that you remove the reference to the certificate from Elastic Load\n Balancing before using this command to delete the certificate. For more information,\n see DeleteLoadBalancerListeners in the Elastic Load Balancing API\n Reference.

\n " + } + }, + "com.amazonaws.iam#DeleteServerCertificateRequest": { + "type": "structure", + "members": { + "ServerCertificateName": { + "target": "com.amazonaws.iam#serverCertificateNameType", + "traits": { + "smithy.api#documentation": "

The name of the server certificate you want to delete.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#DeleteServiceLinkedRole": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#DeleteServiceLinkedRoleRequest" + }, + "output": { + "target": "com.amazonaws.iam#DeleteServiceLinkedRoleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Submits a service-linked role deletion request and returns a\n DeletionTaskId, which you can use to check the status of the deletion.\n Before you call this operation, confirm that the role has no active sessions and that\n any resources used by the role in the linked service are deleted. If you call this\n operation more than once for the same service-linked role and an earlier deletion task\n is not complete, then the DeletionTaskId of the earlier request is\n returned.

\n

If you submit a deletion request for a service-linked role whose linked service is\n still accessing a resource, then the deletion task fails. If it fails, the GetServiceLinkedRoleDeletionStatus operation returns the reason for the\n failure, usually including the resources that must be deleted. To delete the\n service-linked role, you must first remove those resources from the linked service and\n then submit the deletion request again. Resources are specific to the service that is\n linked to the role. For more information about removing resources from a service, see\n the Amazon Web Services documentation for your\n service.

\n

For more information about service-linked roles, see Roles terms and concepts: Amazon Web Services service-linked role in the\n IAM User Guide.

" + } + }, + "com.amazonaws.iam#DeleteServiceLinkedRoleRequest": { + "type": "structure", + "members": { + "RoleName": { + "target": "com.amazonaws.iam#roleNameType", + "traits": { + "smithy.api#documentation": "

The name of the service-linked role to be deleted.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#DeleteServiceLinkedRoleResponse": { + "type": "structure", + "members": { + "DeletionTaskId": { + "target": "com.amazonaws.iam#DeletionTaskIdType", + "traits": { + "smithy.api#documentation": "

The deletion task identifier that you can use to check the status of the deletion.\n This identifier is returned in the format\n task/aws-service-role///.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#DeleteServiceSpecificCredential": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#DeleteServiceSpecificCredentialRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#NoSuchEntityException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified service-specific credential.

" + } + }, + "com.amazonaws.iam#DeleteServiceSpecificCredentialRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#userNameType", + "traits": { + "smithy.api#documentation": "

The name of the IAM user associated with the service-specific credential. If this\n value is not specified, then the operation assumes the user whose credentials are used\n to call the operation.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } + }, + "ServiceSpecificCredentialId": { + "target": "com.amazonaws.iam#serviceSpecificCredentialId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the service-specific credential. You can get this value by\n calling ListServiceSpecificCredentials.

\n

This parameter allows (through its regex pattern) a string of characters that can \n consist of any upper or lowercased letter or digit.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#DeleteSigningCertificate": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#DeleteSigningCertificateRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a signing certificate associated with the specified IAM user.

\n

If you do not specify a user name, IAM determines the user name implicitly based on\n the Amazon Web Services access key ID signing the request. This operation works for access keys under\n the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root\n user credentials even if the Amazon Web Services account has no associated IAM users.

", + "smithy.api#examples": [ + { + "title": "To delete a signing certificate for an IAM user", + "documentation": "The following command deletes the specified signing certificate for the IAM user named Anika.", + "input": { + "UserName": "Anika", + "CertificateId": "TA7SMP42TDN5Z26OBPJE7EXAMPLE" + } + } + ] + } + }, + "com.amazonaws.iam#DeleteSigningCertificateRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#existingUserNameType", + "traits": { + "smithy.api#documentation": "

The name of the user the signing certificate belongs to.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } + }, + "CertificateId": { + "target": "com.amazonaws.iam#certificateIdType", + "traits": { + "smithy.api#documentation": "

The ID of the signing certificate to delete.

\n

The format of this parameter, as described by its regex pattern, is a string of\n characters that can be upper- or lower-cased letters or digits.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#DeleteUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#DeleteUserRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.iam#DeleteConflictException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified IAM user. Unlike the Amazon Web Services Management Console, when you delete a user\n programmatically, you must delete the items attached to the user manually, or the\n deletion fails. For more information, see Deleting an IAM\n user. Before attempting to delete a user, remove the following items:

\n ", + "smithy.api#examples": [ + { + "title": "To delete an IAM user", + "documentation": "The following command removes the IAM user named Bob from the current account.", + "input": { + "UserName": "Bob" + } + } + ] + } + }, + "com.amazonaws.iam#DeleteUserPermissionsBoundary": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#DeleteUserPermissionsBoundaryRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the permissions boundary for the specified IAM user.

\n \n

Deleting the permissions boundary for a user might increase its permissions by\n allowing the user to perform all the actions granted in its permissions policies.\n

\n " + } + }, + "com.amazonaws.iam#DeleteUserPermissionsBoundaryRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#userNameType", + "traits": { + "smithy.api#documentation": "

The name (friendly name, not ARN) of the IAM user from which you want to remove the\n permissions boundary.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#DeleteUserPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#DeleteUserPolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified inline policy that is embedded in the specified IAM\n user.

\n

A user can also have managed policies attached to it. To detach a managed policy from\n a user, use DetachUserPolicy. For more information about policies,\n refer to Managed policies and inline\n policies in the IAM User Guide.

", + "smithy.api#examples": [ + { + "title": "To remove a policy from an IAM user", + "documentation": "The following delete-user-policy command removes the specified policy from the IAM user named Juan:", + "input": { + "UserName": "Juan", + "PolicyName": "ExamplePolicy" + } + } + ] + } + }, + "com.amazonaws.iam#DeleteUserPolicyRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#existingUserNameType", + "traits": { + "smithy.api#documentation": "

The name (friendly name, not ARN) identifying the user that the policy is embedded\n in.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "PolicyName": { + "target": "com.amazonaws.iam#policyNameType", + "traits": { + "smithy.api#documentation": "

The name identifying the policy document to delete.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#DeleteUserRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#existingUserNameType", + "traits": { + "smithy.api#documentation": "

The name of the user to delete.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#DeleteVirtualMFADevice": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#DeleteVirtualMFADeviceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.iam#DeleteConflictException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a virtual MFA device.

\n \n

You must deactivate a user's virtual MFA device before you can delete it. For\n information about deactivating MFA devices, see DeactivateMFADevice.

\n ", + "smithy.api#examples": [ + { + "title": "To remove a virtual MFA device", + "documentation": "The following delete-virtual-mfa-device command removes the specified MFA device from the current AWS account.", + "input": { + "SerialNumber": "arn:aws:iam::123456789012:mfa/ExampleName" + } + } + ] + } + }, + "com.amazonaws.iam#DeleteVirtualMFADeviceRequest": { + "type": "structure", + "members": { + "SerialNumber": { + "target": "com.amazonaws.iam#serialNumberType", + "traits": { + "smithy.api#documentation": "

The serial number that uniquely identifies the MFA device. For virtual MFA devices,\n the serial number is the same as the ARN.

\n

This parameter allows (through its regex pattern) a string of characters consisting \n of upper and lowercase alphanumeric characters with no spaces. You can also include any of the \n following characters: =,.@:/-

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#DeletionTaskFailureReasonType": { + "type": "structure", + "members": { + "Reason": { + "target": "com.amazonaws.iam#ReasonType", + "traits": { + "smithy.api#documentation": "

A short description of the reason that the service-linked role deletion failed.

" + } + }, + "RoleUsageList": { + "target": "com.amazonaws.iam#RoleUsageListType", + "traits": { + "smithy.api#documentation": "

A list of objects that contains details about the service-linked role deletion failure,\n if that information is returned by the service. If the service-linked role has active\n sessions or if any resources that were used by the role have not been deleted from the\n linked service, the role can't be deleted. This parameter includes a list of the resources\n that are associated with the role and the Region in which the resources are being\n used.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The reason that the service-linked role deletion failed.

\n

This data type is used as a response element in the GetServiceLinkedRoleDeletionStatus operation.

" + } + }, + "com.amazonaws.iam#DeletionTaskIdType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.iam#DeletionTaskStatusType": { + "type": "enum", + "members": { + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "NOT_STARTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_STARTED" + } + } + } + }, + "com.amazonaws.iam#DetachGroupPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#DetachGroupPolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes the specified managed policy from the specified IAM group.

\n

A group can also have inline policies embedded with it. To delete an inline policy,\n use DeleteGroupPolicy. For information about policies, see Managed\n policies and inline policies in the\n IAM User Guide.

" + } + }, + "com.amazonaws.iam#DetachGroupPolicyRequest": { + "type": "structure", + "members": { + "GroupName": { + "target": "com.amazonaws.iam#groupNameType", + "traits": { + "smithy.api#documentation": "

The name (friendly name, not ARN) of the IAM group to detach the policy from.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "PolicyArn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM policy you want to detach.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#DetachRolePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#DetachRolePolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + }, + { + "target": "com.amazonaws.iam#UnmodifiableEntityException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes the specified managed policy from the specified role.

\n

A role can also have inline policies embedded with it. To delete an inline policy, use\n DeleteRolePolicy. For information about policies, see Managed\n policies and inline policies in the\n IAM User Guide.

" + } + }, + "com.amazonaws.iam#DetachRolePolicyRequest": { + "type": "structure", + "members": { + "RoleName": { + "target": "com.amazonaws.iam#roleNameType", + "traits": { + "smithy.api#documentation": "

The name (friendly name, not ARN) of the IAM role to detach the policy from.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "PolicyArn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM policy you want to detach.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#DetachUserPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#DetachUserPolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes the specified managed policy from the specified user.

\n

A user can also have inline policies embedded with it. To delete an inline policy, use\n DeleteUserPolicy. For information about policies, see Managed\n policies and inline policies in the\n IAM User Guide.

" + } + }, + "com.amazonaws.iam#DetachUserPolicyRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#userNameType", + "traits": { + "smithy.api#documentation": "

The name (friendly name, not ARN) of the IAM user to detach the policy from.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "PolicyArn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM policy you want to detach.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#DisableOrganizationsRootCredentialsManagement": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#DisableOrganizationsRootCredentialsManagementRequest" + }, + "output": { + "target": "com.amazonaws.iam#DisableOrganizationsRootCredentialsManagementResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#AccountNotManagementOrDelegatedAdministratorException" + }, + { + "target": "com.amazonaws.iam#OrganizationNotFoundException" + }, + { + "target": "com.amazonaws.iam#OrganizationNotInAllFeaturesModeException" + }, + { + "target": "com.amazonaws.iam#ServiceAccessNotEnabledException" + } + ], + "traits": { + "smithy.api#documentation": "

Disables the management of privileged root user credentials across member accounts in\n your organization. When you disable this feature, the management account and the\n delegated admininstrator for IAM can no longer manage root user credentials for member\n accounts in your organization.

", + "smithy.api#examples": [ + { + "title": "To disable the RootCredentialsManagement feature in your organization", + "documentation": "The following command disables the management of privileged root user credentials across member accounts in your organization.", + "output": { + "OrganizationId": "o-aa111bb222", + "EnabledFeatures": [ + "RootSessions" + ] + } + } + ] + } + }, + "com.amazonaws.iam#DisableOrganizationsRootCredentialsManagementRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#DisableOrganizationsRootCredentialsManagementResponse": { + "type": "structure", + "members": { + "OrganizationId": { + "target": "com.amazonaws.iam#OrganizationIdType", + "traits": { + "smithy.api#documentation": "

The unique identifier (ID) of an organization.

" + } + }, + "EnabledFeatures": { + "target": "com.amazonaws.iam#FeaturesListType", + "traits": { + "smithy.api#documentation": "

The features enabled for centralized root access for member accounts in your\n organization.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#DisableOrganizationsRootSessions": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#DisableOrganizationsRootSessionsRequest" + }, + "output": { + "target": "com.amazonaws.iam#DisableOrganizationsRootSessionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#AccountNotManagementOrDelegatedAdministratorException" + }, + { + "target": "com.amazonaws.iam#OrganizationNotFoundException" + }, + { + "target": "com.amazonaws.iam#OrganizationNotInAllFeaturesModeException" + }, + { + "target": "com.amazonaws.iam#ServiceAccessNotEnabledException" + } + ], + "traits": { + "smithy.api#documentation": "

Disables root user sessions for privileged tasks across member accounts in your\n organization. When you disable this feature, the management account and the delegated\n admininstrator for IAM can no longer perform privileged tasks on member accounts in\n your organization.

", + "smithy.api#examples": [ + { + "title": "To disable the RootSessions feature in your organization", + "documentation": "The following command disables root user sessions for privileged tasks across member accounts in your organization.", + "output": { + "OrganizationId": "o-aa111bb222", + "EnabledFeatures": [ + "RootCredentialsManagement" + ] + } + } + ] + } + }, + "com.amazonaws.iam#DisableOrganizationsRootSessionsRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#DisableOrganizationsRootSessionsResponse": { + "type": "structure", + "members": { + "OrganizationId": { + "target": "com.amazonaws.iam#OrganizationIdType", + "traits": { + "smithy.api#documentation": "

The unique identifier (ID) of an organization.

" + } + }, + "EnabledFeatures": { + "target": "com.amazonaws.iam#FeaturesListType", + "traits": { + "smithy.api#documentation": "

The features you have enabled for centralized root access of member accounts in your\n organization.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#DuplicateCertificateException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iam#duplicateCertificateMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DuplicateCertificate", + "httpResponseCode": 409 + }, + "smithy.api#documentation": "

The request was rejected because the same certificate is associated with an IAM user in\n the account.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.iam#DuplicateSSHPublicKeyException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iam#duplicateSSHPublicKeyMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DuplicateSSHPublicKey", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request was rejected because the SSH public key is already associated with the\n specified IAM user.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.iam#EnableMFADevice": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#EnableMFADeviceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.iam#EntityAlreadyExistsException" + }, + { + "target": "com.amazonaws.iam#EntityTemporarilyUnmodifiableException" + }, + { + "target": "com.amazonaws.iam#InvalidAuthenticationCodeException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Enables the specified MFA device and associates it with the specified IAM user. When\n enabled, the MFA device is required for every subsequent login by the IAM user\n associated with the device.

" + } + }, + "com.amazonaws.iam#EnableMFADeviceRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#existingUserNameType", + "traits": { + "smithy.api#documentation": "

The name of the IAM user for whom you want to enable the MFA device.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "SerialNumber": { + "target": "com.amazonaws.iam#serialNumberType", + "traits": { + "smithy.api#documentation": "

The serial number that uniquely identifies the MFA device. For virtual MFA devices,\n the serial number is the device ARN.

\n

This parameter allows (through its regex pattern) a string of characters consisting \n of upper and lowercase alphanumeric characters with no spaces. You can also include any of the \n following characters: =,.@:/-

", + "smithy.api#required": {} + } + }, + "AuthenticationCode1": { + "target": "com.amazonaws.iam#authenticationCodeType", + "traits": { + "smithy.api#documentation": "

An authentication code emitted by the device.

\n

The format for this parameter is a string of six digits.

\n \n

Submit your request immediately after generating the authentication codes. If you\n generate the codes and then wait too long to submit the request, the MFA device\n successfully associates with the user but the MFA device becomes out of sync. This\n happens because time-based one-time passwords (TOTP) expire after a short period of\n time. If this happens, you can resync the\n device.

\n ", + "smithy.api#required": {} + } + }, + "AuthenticationCode2": { + "target": "com.amazonaws.iam#authenticationCodeType", + "traits": { + "smithy.api#documentation": "

A subsequent authentication code emitted by the device.

\n

The format for this parameter is a string of six digits.

\n \n

Submit your request immediately after generating the authentication codes. If you\n generate the codes and then wait too long to submit the request, the MFA device\n successfully associates with the user but the MFA device becomes out of sync. This\n happens because time-based one-time passwords (TOTP) expire after a short period of\n time. If this happens, you can resync the\n device.

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#EnableOrganizationsRootCredentialsManagement": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#EnableOrganizationsRootCredentialsManagementRequest" + }, + "output": { + "target": "com.amazonaws.iam#EnableOrganizationsRootCredentialsManagementResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#AccountNotManagementOrDelegatedAdministratorException" + }, + { + "target": "com.amazonaws.iam#CallerIsNotManagementAccountException" + }, + { + "target": "com.amazonaws.iam#OrganizationNotFoundException" + }, + { + "target": "com.amazonaws.iam#OrganizationNotInAllFeaturesModeException" + }, + { + "target": "com.amazonaws.iam#ServiceAccessNotEnabledException" + } + ], + "traits": { + "smithy.api#documentation": "

Enables the management of privileged root user credentials across member accounts in your\n organization. When you enable root credentials management for centralized root access, the management account and the delegated\n admininstrator for IAM can manage root user credentials for member accounts in your\n organization.

\n

Before you enable centralized root access, you must have an account configured with\n the following settings:

\n
    \n
  • \n

    You must manage your Amazon Web Services accounts in Organizations.

    \n
    • \n
  • \n

    Enable trusted access for Identity and Access Management in Organizations. For details, see\n IAM and Organizations in the Organizations User\n Guide.

    \n
    • \n
", + "smithy.api#examples": [ + { + "title": "To enable the RootCredentialsManagement feature in your organization", + "documentation": "The following command enables the management of privileged root user credentials across member accounts in your organization.", + "output": { + "OrganizationId": "o-aa111bb222", + "EnabledFeatures": [ + "RootCredentialsManagement" + ] + } + } + ] + } + }, + "com.amazonaws.iam#EnableOrganizationsRootCredentialsManagementRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#EnableOrganizationsRootCredentialsManagementResponse": { + "type": "structure", + "members": { + "OrganizationId": { + "target": "com.amazonaws.iam#OrganizationIdType", + "traits": { + "smithy.api#documentation": "

The unique identifier (ID) of an organization.

" + } + }, + "EnabledFeatures": { + "target": "com.amazonaws.iam#FeaturesListType", + "traits": { + "smithy.api#documentation": "

The features you have enabled for centralized root access.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#EnableOrganizationsRootSessions": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#EnableOrganizationsRootSessionsRequest" + }, + "output": { + "target": "com.amazonaws.iam#EnableOrganizationsRootSessionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#AccountNotManagementOrDelegatedAdministratorException" + }, + { + "target": "com.amazonaws.iam#CallerIsNotManagementAccountException" + }, + { + "target": "com.amazonaws.iam#OrganizationNotFoundException" + }, + { + "target": "com.amazonaws.iam#OrganizationNotInAllFeaturesModeException" + }, + { + "target": "com.amazonaws.iam#ServiceAccessNotEnabledException" + } + ], + "traits": { + "smithy.api#documentation": "

Allows the management account or delegated administrator to perform privileged tasks\n on member accounts in your organization. For more information, see Centrally manage root access for member accounts in the Identity and Access Management\n User Guide.

\n

Before you enable this feature, you must have an account configured with the following\n settings:

\n
    \n
  • \n

    You must manage your Amazon Web Services accounts in Organizations.

    \n
    • \n
  • \n

    Enable trusted access for Identity and Access Management in Organizations. For details, see\n IAM and Organizations in the Organizations User\n Guide.

    \n
    • \n
", + "smithy.api#examples": [ + { + "title": "To enable the RootSessions feature in your organization", + "documentation": "The following command allows the management account or delegated administrator to perform privileged tasks on member accounts in your organization.", + "output": { + "OrganizationId": "o-aa111bb222", + "EnabledFeatures": [ + "RootCredentialsManagement", + "RootSessions" + ] + } + } + ] + } + }, + "com.amazonaws.iam#EnableOrganizationsRootSessionsRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#EnableOrganizationsRootSessionsResponse": { + "type": "structure", + "members": { + "OrganizationId": { + "target": "com.amazonaws.iam#OrganizationIdType", + "traits": { + "smithy.api#documentation": "

The unique identifier (ID) of an organization.

" + } + }, + "EnabledFeatures": { + "target": "com.amazonaws.iam#FeaturesListType", + "traits": { + "smithy.api#documentation": "

The features you have enabled for centralized root access.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#EntityAlreadyExistsException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iam#entityAlreadyExistsMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "EntityAlreadyExists", + "httpResponseCode": 409 + }, + "smithy.api#documentation": "

The request was rejected because it attempted to create a resource that already\n exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.iam#EntityDetails": { + "type": "structure", + "members": { + "EntityInfo": { + "target": "com.amazonaws.iam#EntityInfo", + "traits": { + "smithy.api#documentation": "

The EntityInfo object that contains details about the entity (user or\n role).

", + "smithy.api#required": {} + } + }, + "LastAuthenticated": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the authenticated entity last attempted to access Amazon Web Services. Amazon Web Services does\n not report unauthenticated requests.

\n

This field is null if no IAM entities attempted to access the service within the\n tracking period.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that contains details about when the IAM entities (users or roles) were last\n used in an attempt to access the specified Amazon Web Services service.

\n

This data type is a response element in the GetServiceLastAccessedDetailsWithEntities operation.

" + } + }, + "com.amazonaws.iam#EntityInfo": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.iam#userNameType", + "traits": { + "smithy.api#documentation": "

The name of the entity (user or role).

", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.iam#policyOwnerEntityType", + "traits": { + "smithy.api#documentation": "

The type of entity (user or role).

", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.iam#idType", + "traits": { + "smithy.api#documentation": "

The identifier of the entity (user or role).

", + "smithy.api#required": {} + } + }, + "Path": { + "target": "com.amazonaws.iam#pathType", + "traits": { + "smithy.api#documentation": "

The path to the entity (user or role). For more information about paths, see IAM\n identifiers in the IAM User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about the specified entity (user or role).

\n

This data type is an element of the EntityDetails object.

" + } + }, + "com.amazonaws.iam#EntityTemporarilyUnmodifiableException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iam#entityTemporarilyUnmodifiableMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "EntityTemporarilyUnmodifiable", + "httpResponseCode": 409 + }, + "smithy.api#documentation": "

The request was rejected because it referenced an entity that is temporarily unmodifiable,\n such as a user name that was deleted and then recreated. The error indicates that the request\n is likely to succeed if you try again after waiting several minutes. The error message\n describes the entity.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.iam#EntityType": { + "type": "enum", + "members": { + "User": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "User" + } + }, + "Role": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Role" + } + }, + "Group": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Group" + } + }, + "LocalManagedPolicy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LocalManagedPolicy" + } + }, + "AWSManagedPolicy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWSManagedPolicy" + } + } + } + }, + "com.amazonaws.iam#ErrorDetails": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.iam#stringType", + "traits": { + "smithy.api#documentation": "

Detailed information about the reason that the operation failed.

", + "smithy.api#required": {} + } + }, + "Code": { + "target": "com.amazonaws.iam#stringType", + "traits": { + "smithy.api#documentation": "

The error code associated with the operation failure.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the reason that the operation failed.

\n

This data type is used as a response element in the GetOrganizationsAccessReport, GetServiceLastAccessedDetails, and GetServiceLastAccessedDetailsWithEntities operations.

" + } + }, + "com.amazonaws.iam#EvalDecisionDetailsType": { + "type": "map", + "key": { + "target": "com.amazonaws.iam#EvalDecisionSourceType" + }, + "value": { + "target": "com.amazonaws.iam#PolicyEvaluationDecisionType" + } + }, + "com.amazonaws.iam#EvalDecisionSourceType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 256 + } + } + }, + "com.amazonaws.iam#EvaluationResult": { + "type": "structure", + "members": { + "EvalActionName": { + "target": "com.amazonaws.iam#ActionNameType", + "traits": { + "smithy.api#documentation": "

The name of the API operation tested on the indicated resource.

", + "smithy.api#required": {} + } + }, + "EvalResourceName": { + "target": "com.amazonaws.iam#ResourceNameType", + "traits": { + "smithy.api#documentation": "

The ARN of the resource that the indicated API operation was tested on.

" + } + }, + "EvalDecision": { + "target": "com.amazonaws.iam#PolicyEvaluationDecisionType", + "traits": { + "smithy.api#documentation": "

The result of the simulation.

", + "smithy.api#required": {} + } + }, + "MatchedStatements": { + "target": "com.amazonaws.iam#StatementListType", + "traits": { + "smithy.api#documentation": "

A list of the statements in the input policies that determine the result for this\n scenario. Remember that even if multiple statements allow the operation on the resource, if\n only one statement denies that operation, then the explicit deny overrides any allow. In\n addition, the deny statement is the only entry included in the result.

" + } + }, + "MissingContextValues": { + "target": "com.amazonaws.iam#ContextKeyNamesResultListType", + "traits": { + "smithy.api#documentation": "

A list of context keys that are required by the included input policies but that were\n not provided by one of the input parameters. This list is used when the resource in a\n simulation is \"*\", either explicitly, or when the ResourceArns parameter\n blank. If you include a list of resources, then any missing context values are instead\n included under the ResourceSpecificResults section. To discover the context\n keys used by a set of policies, you can call GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy.

" + } + }, + "OrganizationsDecisionDetail": { + "target": "com.amazonaws.iam#OrganizationsDecisionDetail", + "traits": { + "smithy.api#documentation": "

A structure that details how Organizations and its service control policies affect the results of\n the simulation. Only applies if the simulated user's account is part of an\n organization.

" + } + }, + "PermissionsBoundaryDecisionDetail": { + "target": "com.amazonaws.iam#PermissionsBoundaryDecisionDetail", + "traits": { + "smithy.api#documentation": "

Contains information about the effect that a permissions boundary has on a policy\n simulation when the boundary is applied to an IAM entity.

" + } + }, + "EvalDecisionDetails": { + "target": "com.amazonaws.iam#EvalDecisionDetailsType", + "traits": { + "smithy.api#documentation": "

Additional details about the results of the cross-account evaluation decision. This\n parameter is populated for only cross-account simulations. It contains a brief summary of\n how each policy type contributes to the final evaluation decision.

\n

If the simulation evaluates policies within the same account and includes a resource\n ARN, then the parameter is present but the response is empty. If the simulation evaluates\n policies within the same account and specifies all resources (*), then the\n parameter is not returned.

\n

When you make a cross-account request, Amazon Web Services evaluates the request in the trusting\n account and the trusted account. The request is allowed only if both evaluations return\n true. For more information about how policies are evaluated, see Evaluating policies within a single account.

\n

If an Organizations SCP included in the evaluation denies access, the simulation ends. In\n this case, policy evaluation does not proceed any further and this parameter is not\n returned.

" + } + }, + "ResourceSpecificResults": { + "target": "com.amazonaws.iam#ResourceSpecificResultListType", + "traits": { + "smithy.api#documentation": "

The individual results of the simulation of the API operation specified in\n EvalActionName on each resource.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the results of a simulation.

\n

This data type is used by the return parameter of \n SimulateCustomPolicy\n and \n SimulatePrincipalPolicy\n .

" + } + }, + "com.amazonaws.iam#EvaluationResultsListType": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#EvaluationResult" + } + }, + "com.amazonaws.iam#ExceptionMessage": { + "type": "string" + }, + "com.amazonaws.iam#FeatureType": { + "type": "enum", + "members": { + "ROOT_CREDENTIALS_MANAGEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RootCredentialsManagement" + } + }, + "ROOT_SESSIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RootSessions" + } + } + } + }, + "com.amazonaws.iam#FeaturesListType": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#FeatureType" + } + }, + "com.amazonaws.iam#GenerateCredentialReport": { + "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, + "output": { + "target": "com.amazonaws.iam#GenerateCredentialReportResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Generates a credential report for the Amazon Web Services account. For more information about the\n credential report, see Getting credential reports in\n the IAM User Guide.

" + } + }, + "com.amazonaws.iam#GenerateCredentialReportResponse": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.iam#ReportStateType", + "traits": { + "smithy.api#documentation": "

Information about the state of the credential report.

" + } + }, + "Description": { + "target": "com.amazonaws.iam#ReportStateDescriptionType", + "traits": { + "smithy.api#documentation": "

Information about the credential report.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful GenerateCredentialReport\n request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#GenerateOrganizationsAccessReport": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#GenerateOrganizationsAccessReportRequest" + }, + "output": { + "target": "com.amazonaws.iam#GenerateOrganizationsAccessReportResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#ReportGenerationLimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Generates a report for service last accessed data for Organizations. You can generate a\n report for any entities (organization root, organizational unit, or account) or policies\n in your organization.

\n

To call this operation, you must be signed in using your Organizations management account\n credentials. You can use your long-term IAM user or root user credentials, or temporary\n credentials from assuming an IAM role. SCPs must be enabled for your organization\n root. You must have the required IAM and Organizations permissions. For more information, see\n Refining permissions using service last accessed data in the\n IAM User Guide.

\n

You can generate a service last accessed data report for entities by specifying only\n the entity's path. This data includes a list of services that are allowed by any service\n control policies (SCPs) that apply to the entity.

\n

You can generate a service last accessed data report for a policy by specifying an\n entity's path and an optional Organizations policy ID. This data includes a list of services that\n are allowed by the specified SCP.

\n

For each service in both report types, the data includes the most recent account\n activity that the policy allows to account principals in the entity or the entity's\n children. For important information about the data, reporting period, permissions\n required, troubleshooting, and supported Regions see Reducing permissions using\n service last accessed data in the\n IAM User Guide.

\n \n

The data includes all attempts to access Amazon Web Services, not just the successful ones. This\n includes all attempts that were made using the Amazon Web Services Management Console, the Amazon Web Services API through any\n of the SDKs, or any of the command line tools. An unexpected entry in the service\n last accessed data does not mean that an account has been compromised, because the\n request might have been denied. Refer to your CloudTrail logs as the authoritative\n source for information about all API calls and whether they were successful or\n denied access. For more information, see Logging IAM events with\n CloudTrail in the IAM User Guide.

\n \n

This operation returns a JobId. Use this parameter in the \n GetOrganizationsAccessReport\n operation to check the status of\n the report generation. To check the status of this request, use the JobId\n parameter in the \n GetOrganizationsAccessReport\n operation\n and test the JobStatus response parameter. When the job is complete, you\n can retrieve the report.

\n

To generate a service last accessed data report for entities, specify an entity path\n without specifying the optional Organizations policy ID. The type of entity that you specify\n determines the data returned in the report.

\n
    \n
  • \n

    \n Root – When you specify the\n organizations root as the entity, the resulting report lists all of the services\n allowed by SCPs that are attached to your root. For each service, the report\n includes data for all accounts in your organization except the\n management account, because the management account is not limited by SCPs.

    \n
    • \n
  • \n

    \n OU – When you specify an\n organizational unit (OU) as the entity, the resulting report lists all of the\n services allowed by SCPs that are attached to the OU and its parents. For each\n service, the report includes data for all accounts in the OU or its children.\n This data excludes the management account, because the management account is not\n limited by SCPs.

    \n
    • \n
  • \n

    \n management account – When you specify the\n management account, the resulting report lists all Amazon Web Services services, because the\n management account is not limited by SCPs. For each service, the report includes\n data for only the management account.

    \n
    • \n
  • \n

    \n Account – When you specify another\n account as the entity, the resulting report lists all of the services allowed by\n SCPs that are attached to the account and its parents. For each service, the\n report includes data for only the specified account.

    \n
    • \n
\n

To generate a service last accessed data report for policies, specify an entity path\n and the optional Organizations policy ID. The type of entity that you specify determines the data\n returned for each service.

\n
    \n
  • \n

    \n Root – When you specify the root\n entity and a policy ID, the resulting report lists all of the services that are\n allowed by the specified SCP. For each service, the report includes data for all\n accounts in your organization to which the SCP applies. This data excludes the\n management account, because the management account is not limited by SCPs. If the\n SCP is not attached to any entities in the organization, then the report will\n return a list of services with no data.

    \n
    • \n
  • \n

    \n OU – When you specify an OU entity and\n a policy ID, the resulting report lists all of the services that are allowed by\n the specified SCP. For each service, the report includes data for all accounts\n in the OU or its children to which the SCP applies. This means that other\n accounts outside the OU that are affected by the SCP might not be included in\n the data. This data excludes the management account, because the\n management account is not limited by SCPs. If the SCP is not attached to the OU\n or one of its children, the report will return a list of services with no\n data.

    \n
    • \n
  • \n

    \n management account – When you specify the\n management account, the resulting report lists all Amazon Web Services services, because the\n management account is not limited by SCPs. If you specify a policy ID in the CLI\n or API, the policy is ignored. For each service, the report includes data for\n only the management account.

    \n
    • \n
  • \n

    \n Account – When you specify another\n account entity and a policy ID, the resulting report lists all of the services\n that are allowed by the specified SCP. For each service, the report includes\n data for only the specified account. This means that other accounts in the\n organization that are affected by the SCP might not be included in the data. If\n the SCP is not attached to the account, the report will return a list of\n services with no data.

    \n
    • \n
\n \n

Service last accessed data does not use other policy types when determining\n whether a principal could access a service. These other policy types include\n identity-based policies, resource-based policies, access control lists, IAM\n permissions boundaries, and STS assume role policies. It only applies SCP logic.\n For more about the evaluation of policy types, see Evaluating policies in the\n IAM User Guide.

\n \n

For more information about service last accessed data, see Reducing policy scope by\n viewing user activity in the IAM User Guide.

", + "smithy.api#examples": [ + { + "title": "To generate a service last accessed data report for an organizational unit", + "documentation": "The following operation generates a report for the organizational unit ou-rge0-awexample", + "input": { + "EntityPath": "o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-1a2b3c-k9l8m7n6o5example" + }, + "output": { + "JobId": "examplea-1234-b567-cde8-90fg123abcd4" + } + } + ] + } + }, + "com.amazonaws.iam#GenerateOrganizationsAccessReportRequest": { + "type": "structure", + "members": { + "EntityPath": { + "target": "com.amazonaws.iam#organizationsEntityPathType", + "traits": { + "smithy.api#documentation": "

The path of the Organizations entity (root, OU, or account). You can build an entity path\n using the known structure of your organization. For example, assume that your account ID\n is 123456789012 and its parent OU ID is ou-rge0-awsabcde. The\n organization root ID is r-f6g7h8i9j0example and your organization ID is\n o-a1b2c3d4e5. Your entity path is\n o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-rge0-awsabcde/123456789012.

", + "smithy.api#required": {} + } + }, + "OrganizationsPolicyId": { + "target": "com.amazonaws.iam#organizationsPolicyIdType", + "traits": { + "smithy.api#documentation": "

The identifier of the Organizations service control policy (SCP). This parameter is\n optional.

\n

This ID is used to generate information about when an account principal that is\n limited by the SCP attempted to access an Amazon Web Services service.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#GenerateOrganizationsAccessReportResponse": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.iam#jobIDType", + "traits": { + "smithy.api#documentation": "

The job identifier that you can use in the GetOrganizationsAccessReport operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#GenerateServiceLastAccessedDetails": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#GenerateServiceLastAccessedDetailsRequest" + }, + "output": { + "target": "com.amazonaws.iam#GenerateServiceLastAccessedDetailsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + } + ], + "traits": { + "smithy.api#documentation": "

Generates a report that includes details about when an IAM resource (user, group,\n role, or policy) was last used in an attempt to access Amazon Web Services services. Recent activity\n usually appears within four hours. IAM reports activity for at least the last 400\n days, or less if your Region began supporting this feature within the last year. For\n more information, see Regions where data is tracked. For more information about services and\n actions for which action last accessed information is displayed, see IAM\n action last accessed information services and actions.

\n \n

The service last accessed data includes all attempts to access an Amazon Web Services API, not\n just the successful ones. This includes all attempts that were made using the\n Amazon Web Services Management Console, the Amazon Web Services API through any of the SDKs, or any of the command line tools.\n An unexpected entry in the service last accessed data does not mean that your\n account has been compromised, because the request might have been denied. Refer to\n your CloudTrail logs as the authoritative source for information about all API calls\n and whether they were successful or denied access. For more information, see Logging\n IAM events with CloudTrail in the\n IAM User Guide.

\n \n

The GenerateServiceLastAccessedDetails operation returns a\n JobId. Use this parameter in the following operations to retrieve the\n following details from your report:

\n
    \n
  • \n

    \n GetServiceLastAccessedDetails – Use this operation\n for users, groups, roles, or policies to list every Amazon Web Services service that the\n resource could access using permissions policies. For each service, the response\n includes information about the most recent access attempt.

    \n

    The JobId returned by\n GenerateServiceLastAccessedDetail must be used by the same role\n within a session, or by the same user when used to call\n GetServiceLastAccessedDetail.

    \n
    • \n
  • \n

    \n GetServiceLastAccessedDetailsWithEntities – Use this\n operation for groups and policies to list information about the associated\n entities (users or roles) that attempted to access a specific Amazon Web Services service.\n

    \n
    • \n
\n

To check the status of the GenerateServiceLastAccessedDetails request,\n use the JobId parameter in the same operations and test the\n JobStatus response parameter.

\n

For additional information about the permissions policies that allow an identity\n (user, group, or role) to access specific services, use the ListPoliciesGrantingServiceAccess operation.

\n \n

Service last accessed data does not use other policy types when determining\n whether a resource could access a service. These other policy types include\n resource-based policies, access control lists, Organizations policies, IAM permissions\n boundaries, and STS assume role policies. It only applies permissions policy\n logic. For more about the evaluation of policy types, see Evaluating policies in the\n IAM User Guide.

\n \n

For more information about service and action last accessed data, see Reducing permissions using service last accessed data in the\n IAM User Guide.

", + "smithy.api#examples": [ + { + "title": "To generate a service last accessed data report for a policy", + "documentation": "The following operation generates a report for the policy: ExamplePolicy1", + "input": { + "Arn": "arn:aws:iam::123456789012:policy/ExamplePolicy1" + }, + "output": { + "JobId": "examplef-1305-c245-eba4-71fe298bcda7" + } + } + ] + } + }, + "com.amazonaws.iam#GenerateServiceLastAccessedDetailsRequest": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM resource (user, group, role, or managed policy) used to generate\n information about when the resource was last used in an attempt to access an Amazon Web Services\n service.

", + "smithy.api#required": {} + } + }, + "Granularity": { + "target": "com.amazonaws.iam#AccessAdvisorUsageGranularityType", + "traits": { + "smithy.api#documentation": "

The level of detail that you want to generate. You can specify whether you want to\n generate information about the last attempt to access services or actions. If you\n specify service-level granularity, this operation generates only service data. If you\n specify action-level granularity, it generates service and action data. If you don't\n include this optional parameter, the operation generates service data.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#GenerateServiceLastAccessedDetailsResponse": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.iam#jobIDType", + "traits": { + "smithy.api#documentation": "

The JobId that you can use in the GetServiceLastAccessedDetails or GetServiceLastAccessedDetailsWithEntities operations. The\n JobId returned by GenerateServiceLastAccessedDetail must\n be used by the same role within a session, or by the same user when used to call\n GetServiceLastAccessedDetail.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#GetAccessKeyLastUsed": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#GetAccessKeyLastUsedRequest" + }, + "output": { + "target": "com.amazonaws.iam#GetAccessKeyLastUsedResponse" + }, + "traits": { + "smithy.api#documentation": "

Retrieves information about when the specified access key was last used. The\n information includes the date and time of last use, along with the Amazon Web Services service and\n Region that were specified in the last request made with that key.

" + } + }, + "com.amazonaws.iam#GetAccessKeyLastUsedRequest": { + "type": "structure", + "members": { + "AccessKeyId": { + "target": "com.amazonaws.iam#accessKeyIdType", + "traits": { + "smithy.api#documentation": "

The identifier of an access key.

\n

This parameter allows (through its regex pattern) a string of characters that can \n consist of any upper or lowercased letter or digit.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#GetAccessKeyLastUsedResponse": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#existingUserNameType", + "traits": { + "smithy.api#documentation": "

The name of the IAM user that owns this access key.

\n

" + } + }, + "AccessKeyLastUsed": { + "target": "com.amazonaws.iam#AccessKeyLastUsed", + "traits": { + "smithy.api#documentation": "

Contains information about the last time the access key was used.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful GetAccessKeyLastUsed request.\n It is also returned as a member of the AccessKeyMetaData structure returned\n by the ListAccessKeys action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#GetAccountAuthorizationDetails": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#GetAccountAuthorizationDetailsRequest" + }, + "output": { + "target": "com.amazonaws.iam#GetAccountAuthorizationDetailsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves information about all IAM users, groups, roles, and policies in your Amazon Web Services\n account, including their relationships to one another. Use this operation to obtain a\n snapshot of the configuration of IAM permissions (users, groups, roles, and policies)\n in your account.

\n \n

Policies returned by this operation are URL-encoded compliant \n with RFC 3986. You can use a URL \n decoding method to convert the policy back to plain JSON text. For example, if you use Java, you \n can use the decode method of the java.net.URLDecoder utility class in \n the Java SDK. Other languages and SDKs provide similar functionality.

\n \n

You can optionally filter the results using the Filter parameter. You can\n paginate the results using the MaxItems and Marker\n parameters.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.iam#GetAccountAuthorizationDetailsRequest": { + "type": "structure", + "members": { + "Filter": { + "target": "com.amazonaws.iam#entityListType", + "traits": { + "smithy.api#documentation": "

A list of entity types used to filter the results. Only the entities that match the\n types you specify are included in the output. Use the value\n LocalManagedPolicy to include customer managed policies.

\n

The format for this parameter is a comma-separated (if more than one) list of strings.\n Each string value in the list must be one of the valid values listed below.

" + } + }, + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#markerType", + "traits": { + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#GetAccountAuthorizationDetailsResponse": { + "type": "structure", + "members": { + "UserDetailList": { + "target": "com.amazonaws.iam#userDetailListType", + "traits": { + "smithy.api#documentation": "

A list containing information about IAM users.

" + } + }, + "GroupDetailList": { + "target": "com.amazonaws.iam#groupDetailListType", + "traits": { + "smithy.api#documentation": "

A list containing information about IAM groups.

" + } + }, + "RoleDetailList": { + "target": "com.amazonaws.iam#roleDetailListType", + "traits": { + "smithy.api#documentation": "

A list containing information about IAM roles.

" + } + }, + "Policies": { + "target": "com.amazonaws.iam#ManagedPolicyDetailListType", + "traits": { + "smithy.api#documentation": "

A list containing information about managed policies.

" + } + }, + "IsTruncated": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#responseMarkerType", + "traits": { + "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful GetAccountAuthorizationDetails\n request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#GetAccountPasswordPolicy": { + "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, + "output": { + "target": "com.amazonaws.iam#GetAccountPasswordPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the password policy for the Amazon Web Services account. This tells you the complexity\n requirements and mandatory rotation periods for the IAM user passwords in your account.\n For more information about using a password policy, see Managing an IAM password\n policy.

", + "smithy.api#examples": [ + { + "title": "To see the current account password policy", + "documentation": "The following command displays details about the password policy for the current AWS account.", + "output": { + "PasswordPolicy": { + "AllowUsersToChangePassword": false, + "RequireNumbers": true, + "RequireLowercaseCharacters": false, + "RequireUppercaseCharacters": false, + "MinimumPasswordLength": 8, + "RequireSymbols": true, + "ExpirePasswords": false, + "PasswordReusePrevention": 12, + "MaxPasswordAge": 90, + "HardExpiry": false + } + } + } + ] + } + }, + "com.amazonaws.iam#GetAccountPasswordPolicyResponse": { + "type": "structure", + "members": { + "PasswordPolicy": { + "target": "com.amazonaws.iam#PasswordPolicy", + "traits": { + "smithy.api#documentation": "

A structure that contains details about the account's password policy.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful GetAccountPasswordPolicy\n request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#GetAccountSummary": { + "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, + "output": { + "target": "com.amazonaws.iam#GetAccountSummaryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves information about IAM entity usage and IAM quotas in the Amazon Web Services\n account.

\n

For information about IAM quotas, see IAM and STS quotas in the\n IAM User Guide.

", + "smithy.api#examples": [ + { + "title": "To get information about IAM entity quotas and usage in the current account", + "documentation": "The following command returns information about the IAM entity quotas and usage in the current AWS account.", + "output": { + "SummaryMap": { + "Users": 27, + "UsersQuota": 5000, + "Groups": 15, + "GroupsQuota": 100, + "Policies": 8, + "PoliciesQuota": 1000, + "PolicySizeQuota": 5120, + "PolicyVersionsInUse": 22, + "PolicyVersionsInUseQuota": 10000, + "VersionsPerPolicyQuota": 5, + "ServerCertificates": 1, + "ServerCertificatesQuota": 20, + "UserPolicySizeQuota": 2048, + "GroupPolicySizeQuota": 5120, + "GroupsPerUserQuota": 10, + "GlobalEndpointTokenVersion": 2, + "SigningCertificatesPerUserQuota": 2, + "AccessKeysPerUserQuota": 2, + "MFADevices": 6, + "MFADevicesInUse": 3, + "AccountMFAEnabled": 0, + "AccountAccessKeysPresent": 1, + "AccountSigningCertificatesPresent": 0, + "AttachedPoliciesPerGroupQuota": 10, + "AttachedPoliciesPerRoleQuota": 10, + "AttachedPoliciesPerUserQuota": 10 + } + } + } + ] + } + }, + "com.amazonaws.iam#GetAccountSummaryResponse": { + "type": "structure", + "members": { + "SummaryMap": { + "target": "com.amazonaws.iam#summaryMapType", + "traits": { + "smithy.api#documentation": "

A set of key–value pairs containing information about IAM entity usage and\n IAM quotas.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful GetAccountSummary request.\n

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#GetContextKeysForCustomPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#GetContextKeysForCustomPolicyRequest" + }, + "output": { + "target": "com.amazonaws.iam#GetContextKeysForPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#InvalidInputException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a list of all of the context keys referenced in the input policies. The policies\n are supplied as a list of one or more strings. To get the context keys from policies\n associated with an IAM user, group, or role, use GetContextKeysForPrincipalPolicy.

\n

Context keys are variables maintained by Amazon Web Services and its services that provide details\n about the context of an API query request. Context keys can be evaluated by testing\n against a value specified in an IAM policy. Use\n GetContextKeysForCustomPolicy to understand what key names and values\n you must supply when you call SimulateCustomPolicy. Note that all\n parameters are shown in unencoded form here for clarity but must be URL encoded to be\n included as a part of a real HTML request.

" + } + }, + "com.amazonaws.iam#GetContextKeysForCustomPolicyRequest": { + "type": "structure", + "members": { + "PolicyInputList": { + "target": "com.amazonaws.iam#SimulationPolicyListType", + "traits": { + "smithy.api#documentation": "

A list of policies for which you want the list of context keys referenced in those\n policies. Each document is specified as a string containing the complete, valid JSON\n text of an IAM policy.

\n

The regex pattern \n used to validate this parameter is a string of characters consisting of the following:

\n
    \n
  • \n

    Any printable ASCII \n character ranging from the space character (\\u0020) through the end of the ASCII character range

    \n
    • \n
  • \n

    The printable characters in the Basic Latin and Latin-1 Supplement character set \n (through \\u00FF)

    \n
    • \n
  • \n

    The special characters tab (\\u0009), line feed (\\u000A), and \n carriage return (\\u000D)

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#GetContextKeysForPolicyResponse": { + "type": "structure", + "members": { + "ContextKeyNames": { + "target": "com.amazonaws.iam#ContextKeyNamesResultListType", + "traits": { + "smithy.api#documentation": "

The list of context keys that are referenced in the input policies.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful GetContextKeysForPrincipalPolicy or GetContextKeysForCustomPolicy request.

" + } + }, + "com.amazonaws.iam#GetContextKeysForPrincipalPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#GetContextKeysForPrincipalPolicyRequest" + }, + "output": { + "target": "com.amazonaws.iam#GetContextKeysForPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a list of all of the context keys referenced in all the IAM policies that are\n attached to the specified IAM entity. The entity can be an IAM user, group, or role.\n If you specify a user, then the request also includes all of the policies attached to\n groups that the user is a member of.

\n

You can optionally include a list of one or more additional policies, specified as\n strings. If you want to include only a list of policies by string,\n use GetContextKeysForCustomPolicy instead.

\n

\n Note: This operation discloses information about the\n permissions granted to other users. If you do not want users to see other user's\n permissions, then consider allowing them to use GetContextKeysForCustomPolicy instead.

\n

Context keys are variables maintained by Amazon Web Services and its services that provide details\n about the context of an API query request. Context keys can be evaluated by testing\n against a value in an IAM policy. Use GetContextKeysForPrincipalPolicy to understand what key names and values you must supply when you call SimulatePrincipalPolicy.

" + } + }, + "com.amazonaws.iam#GetContextKeysForPrincipalPolicyRequest": { + "type": "structure", + "members": { + "PolicySourceArn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The ARN of a user, group, or role whose policies contain the context keys that you\n want listed. If you specify a user, the list includes context keys that are found in all\n policies that are attached to the user. The list also includes all groups that the user\n is a member of. If you pick a group or a role, then it includes only those context keys\n that are found in policies attached to that entity. Note that all parameters are shown\n in unencoded form here for clarity, but must be URL encoded to be included as a part of\n a real HTML request.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

", + "smithy.api#required": {} + } + }, + "PolicyInputList": { + "target": "com.amazonaws.iam#SimulationPolicyListType", + "traits": { + "smithy.api#documentation": "

An optional list of additional policies for which you want the list of context keys\n that are referenced.

\n

The regex pattern \n used to validate this parameter is a string of characters consisting of the following:

\n
    \n
  • \n

    Any printable ASCII \n character ranging from the space character (\\u0020) through the end of the ASCII character range

    \n
    • \n
  • \n

    The printable characters in the Basic Latin and Latin-1 Supplement character set \n (through \\u00FF)

    \n
    • \n
  • \n

    The special characters tab (\\u0009), line feed (\\u000A), and \n carriage return (\\u000D)

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#GetCredentialReport": { + "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, + "output": { + "target": "com.amazonaws.iam#GetCredentialReportResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#CredentialReportExpiredException" + }, + { + "target": "com.amazonaws.iam#CredentialReportNotPresentException" + }, + { + "target": "com.amazonaws.iam#CredentialReportNotReadyException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a credential report for the Amazon Web Services account. For more information about the\n credential report, see Getting credential reports in\n the IAM User Guide.

" + } + }, + "com.amazonaws.iam#GetCredentialReportResponse": { + "type": "structure", + "members": { + "Content": { + "target": "com.amazonaws.iam#ReportContentType", + "traits": { + "smithy.api#documentation": "

Contains the credential report. The report is Base64-encoded.

" + } + }, + "ReportFormat": { + "target": "com.amazonaws.iam#ReportFormatType", + "traits": { + "smithy.api#documentation": "

The format (MIME type) of the credential report.

" + } + }, + "GeneratedTime": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date and time when the credential report was created, in ISO 8601 date-time format.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful GetCredentialReport request.\n

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#GetGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#GetGroupRequest" + }, + "output": { + "target": "com.amazonaws.iam#GetGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of IAM users that are in the specified IAM group. You can paginate\n the results using the MaxItems and Marker parameters.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Users", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.iam#GetGroupPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#GetGroupPolicyRequest" + }, + "output": { + "target": "com.amazonaws.iam#GetGroupPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the specified inline policy document that is embedded in the specified IAM\n group.

\n \n

Policies returned by this operation are URL-encoded compliant \n with RFC 3986. You can use a URL \n decoding method to convert the policy back to plain JSON text. For example, if you use Java, you \n can use the decode method of the java.net.URLDecoder utility class in \n the Java SDK. Other languages and SDKs provide similar functionality.

\n \n

An IAM group can also have managed policies attached to it. To retrieve a managed\n policy document that is attached to a group, use GetPolicy to\n determine the policy's default version, then use GetPolicyVersion to\n retrieve the policy document.

\n

For more information about policies, see Managed policies and inline\n policies in the IAM User Guide.

" + } + }, + "com.amazonaws.iam#GetGroupPolicyRequest": { + "type": "structure", + "members": { + "GroupName": { + "target": "com.amazonaws.iam#groupNameType", + "traits": { + "smithy.api#documentation": "

The name of the group the policy is associated with.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "PolicyName": { + "target": "com.amazonaws.iam#policyNameType", + "traits": { + "smithy.api#documentation": "

The name of the policy document to get.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#GetGroupPolicyResponse": { + "type": "structure", + "members": { + "GroupName": { + "target": "com.amazonaws.iam#groupNameType", + "traits": { + "smithy.api#documentation": "

The group the policy is associated with.

", + "smithy.api#required": {} + } + }, + "PolicyName": { + "target": "com.amazonaws.iam#policyNameType", + "traits": { + "smithy.api#documentation": "

The name of the policy.

", + "smithy.api#required": {} + } + }, + "PolicyDocument": { + "target": "com.amazonaws.iam#policyDocumentType", + "traits": { + "smithy.api#documentation": "

The policy document.

\n

IAM stores policies in JSON format. However, resources that were created using CloudFormation\n templates can be formatted in YAML. CloudFormation always converts a YAML policy to JSON format\n before submitting it to IAM.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful GetGroupPolicy request.\n

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#GetGroupRequest": { + "type": "structure", + "members": { + "GroupName": { + "target": "com.amazonaws.iam#groupNameType", + "traits": { + "smithy.api#documentation": "

The name of the group.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "Marker": { + "target": "com.amazonaws.iam#markerType", + "traits": { + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + } + }, + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#GetGroupResponse": { + "type": "structure", + "members": { + "Group": { + "target": "com.amazonaws.iam#Group", + "traits": { + "smithy.api#documentation": "

A structure that contains details about the group.

", + "smithy.api#required": {} + } + }, + "Users": { + "target": "com.amazonaws.iam#userListType", + "traits": { + "smithy.api#documentation": "

A list of users in the group.

", + "smithy.api#required": {} + } + }, + "IsTruncated": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#responseMarkerType", + "traits": { + "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful GetGroup request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#GetInstanceProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#GetInstanceProfileRequest" + }, + "output": { + "target": "com.amazonaws.iam#GetInstanceProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves information about the specified instance profile, including the instance\n profile's path, GUID, ARN, and role. For more information about instance profiles, see\n Using\n instance profiles in the IAM User Guide.

", + "smithy.api#examples": [ + { + "title": "To get information about an instance profile", + "documentation": "The following command gets information about the instance profile named ExampleInstanceProfile.", + "input": { + "InstanceProfileName": "ExampleInstanceProfile" + }, + "output": { + "InstanceProfile": { + "InstanceProfileId": "AID2MAB8DPLSRHEXAMPLE", + "Roles": [ + { + "AssumeRolePolicyDocument": "", + "RoleId": "AIDGPMS9RO4H3FEXAMPLE", + "CreateDate": "2013-01-09T06:33:26Z", + "Path": "/", + "RoleName": "Test-Role", + "Arn": "arn:aws:iam::336924118301:role/Test-Role" + } + ], + "CreateDate": "2013-06-12T23:52:02Z", + "InstanceProfileName": "ExampleInstanceProfile", + "Path": "/", + "Arn": "arn:aws:iam::336924118301:instance-profile/ExampleInstanceProfile" + } + } + } + ], + "smithy.waiters#waitable": { + "InstanceProfileExists": { + "acceptors": [ + { + "state": "success", + "matcher": { + "success": true + } + }, + { + "state": "retry", + "matcher": { + "errorType": "NoSuchEntityException" + } + } + ], + "minDelay": 1 + } + } + } + }, + "com.amazonaws.iam#GetInstanceProfileRequest": { + "type": "structure", + "members": { + "InstanceProfileName": { + "target": "com.amazonaws.iam#instanceProfileNameType", + "traits": { + "smithy.api#documentation": "

The name of the instance profile to get information about.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#GetInstanceProfileResponse": { + "type": "structure", + "members": { + "InstanceProfile": { + "target": "com.amazonaws.iam#InstanceProfile", + "traits": { + "smithy.api#documentation": "

A structure containing details about the instance profile.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful GetInstanceProfile request.\n

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#GetLoginProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#GetLoginProfileRequest" + }, + "output": { + "target": "com.amazonaws.iam#GetLoginProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the user name for the specified IAM user. A login profile is created when\n you create a password for the user to access the Amazon Web Services Management Console. If the user does not exist\n or does not have a password, the operation returns a 404 (NoSuchEntity)\n error.

\n

If you create an IAM user with access to the console, the CreateDate\n reflects the date you created the initial password for the user.

\n

If you create an IAM user with programmatic access, and then later add a password\n for the user to access the Amazon Web Services Management Console, the CreateDate reflects the initial\n password creation date. A user with programmatic access does not have a login profile\n unless you create a password for the user to access the Amazon Web Services Management Console.

", + "smithy.api#examples": [ + { + "title": "To get password information for an IAM user", + "documentation": "The following command gets information about the password for the IAM user named Anika.", + "input": { + "UserName": "Anika" + }, + "output": { + "LoginProfile": { + "UserName": "Anika", + "CreateDate": "2012-09-21T23:03:39Z" + } + } + } + ] + } + }, + "com.amazonaws.iam#GetLoginProfileRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#userNameType", + "traits": { + "smithy.api#documentation": "

The name of the user whose login profile you want to retrieve.

\n

This parameter is optional. If no user name is included, it defaults to the principal\n making the request. When you make this request with root user credentials, you must use\n an AssumeRoot session to omit the user name.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#GetLoginProfileResponse": { + "type": "structure", + "members": { + "LoginProfile": { + "target": "com.amazonaws.iam#LoginProfile", + "traits": { + "smithy.api#documentation": "

A structure containing the user name and the profile creation date for the\n user.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful GetLoginProfile request.\n

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#GetMFADevice": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#GetMFADeviceRequest" + }, + "output": { + "target": "com.amazonaws.iam#GetMFADeviceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves information about an MFA device for a specified user.

" + } + }, + "com.amazonaws.iam#GetMFADeviceRequest": { + "type": "structure", + "members": { + "SerialNumber": { + "target": "com.amazonaws.iam#serialNumberType", + "traits": { + "smithy.api#documentation": "

Serial number that uniquely identifies the MFA device. For this API, we only accept\n FIDO security key ARNs.

", + "smithy.api#required": {} + } + }, + "UserName": { + "target": "com.amazonaws.iam#userNameType", + "traits": { + "smithy.api#documentation": "

The friendly name identifying the user.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#GetMFADeviceResponse": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#userNameType", + "traits": { + "smithy.api#documentation": "

The friendly name identifying the user.

" + } + }, + "SerialNumber": { + "target": "com.amazonaws.iam#serialNumberType", + "traits": { + "smithy.api#documentation": "

Serial number that uniquely identifies the MFA device. For this API, we only accept\n FIDO security key ARNs.

", + "smithy.api#required": {} + } + }, + "EnableDate": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date that a specified user's MFA device was first enabled.

" + } + }, + "Certifications": { + "target": "com.amazonaws.iam#CertificationMapType", + "traits": { + "smithy.api#documentation": "

The certifications of a specified user's MFA device. We currently provide FIPS-140-2,\n FIPS-140-3, and FIDO certification levels obtained from FIDO Alliance Metadata Service\n (MDS).

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#GetOpenIDConnectProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#GetOpenIDConnectProviderRequest" + }, + "output": { + "target": "com.amazonaws.iam#GetOpenIDConnectProviderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about the specified OpenID Connect (OIDC) provider resource object\n in IAM.

" + } + }, + "com.amazonaws.iam#GetOpenIDConnectProviderRequest": { + "type": "structure", + "members": { + "OpenIDConnectProviderArn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the OIDC provider resource object in IAM to get\n information for. You can get a list of OIDC provider resource ARNs by using the ListOpenIDConnectProviders operation.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#GetOpenIDConnectProviderResponse": { + "type": "structure", + "members": { + "Url": { + "target": "com.amazonaws.iam#OpenIDConnectProviderUrlType", + "traits": { + "smithy.api#documentation": "

The URL that the IAM OIDC provider resource object is associated with. For more\n information, see CreateOpenIDConnectProvider.

" + } + }, + "ClientIDList": { + "target": "com.amazonaws.iam#clientIDListType", + "traits": { + "smithy.api#documentation": "

A list of client IDs (also known as audiences) that are associated with the specified\n IAM OIDC provider resource object. For more information, see CreateOpenIDConnectProvider.

" + } + }, + "ThumbprintList": { + "target": "com.amazonaws.iam#thumbprintListType", + "traits": { + "smithy.api#documentation": "

A list of certificate thumbprints that are associated with the specified IAM OIDC\n provider resource object. For more information, see CreateOpenIDConnectProvider.

" + } + }, + "CreateDate": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date and time when the IAM OIDC provider resource object was created in the\n Amazon Web Services account.

" + } + }, + "Tags": { + "target": "com.amazonaws.iam#tagListType", + "traits": { + "smithy.api#documentation": "

A list of tags that are attached to the specified IAM OIDC provider. The returned list of tags is sorted by tag key.\n For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful GetOpenIDConnectProvider\n request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#GetOrganizationsAccessReport": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#GetOrganizationsAccessReportRequest" + }, + "output": { + "target": "com.amazonaws.iam#GetOrganizationsAccessReportResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#NoSuchEntityException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the service last accessed data report for Organizations that was previously\n generated using the \n GenerateOrganizationsAccessReport\n \n operation. This operation retrieves the status of your report job and the report\n contents.

\n

Depending on the parameters that you passed when you generated the report, the data\n returned could include different information. For details, see GenerateOrganizationsAccessReport.

\n

To call this operation, you must be signed in to the management account in your\n organization. SCPs must be enabled for your organization root. You must have permissions\n to perform this operation. For more information, see Refining permissions using\n service last accessed data in the\n IAM User Guide.

\n

For each service that principals in an account (root user, IAM users, or IAM roles)\n could access using SCPs, the operation returns details about the most recent access\n attempt. If there was no attempt, the service is listed without details about the most\n recent attempt to access the service. If the operation fails, it returns the reason that\n it failed.

\n

By default, the list is sorted by service namespace.

", + "smithy.api#examples": [ + { + "title": "To get details from a previously generated organizational unit report", + "documentation": "The following operation gets details about the report with the job ID: examplea-1234-b567-cde8-90fg123abcd4", + "input": { + "JobId": "examplea-1234-b567-cde8-90fg123abcd4" + }, + "output": { + "IsTruncated": false, + "JobCompletionDate": "2019-06-18T19:47:35.241Z", + "JobCreationDate": "2019-06-18T19:47:31.466Z", + "JobStatus": "COMPLETED", + "NumberOfServicesAccessible": 3, + "NumberOfServicesNotAccessed": 1, + "AccessDetails": [ + { + "EntityPath": "o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-1a2b3c-k9l8m7n6o5example/111122223333", + "LastAuthenticatedTime": "2019-05-25T16:29:52Z", + "Region": "us-east-1", + "ServiceName": "Amazon DynamoDB", + "ServiceNamespace": "dynamodb", + "TotalAuthenticatedEntities": 2 + }, + { + "EntityPath": "o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-1a2b3c-k9l8m7n6o5example/123456789012", + "LastAuthenticatedTime": "2019-06-15T13:12:06Z", + "Region": "us-east-1", + "ServiceName": "AWS Identity and Access Management", + "ServiceNamespace": "iam", + "TotalAuthenticatedEntities": 4 + }, + { + "ServiceName": "Amazon Simple Storage Service", + "ServiceNamespace": "s3", + "TotalAuthenticatedEntities": 0 + } + ] + } + } + ] + } + }, + "com.amazonaws.iam#GetOrganizationsAccessReportRequest": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.iam#jobIDType", + "traits": { + "smithy.api#documentation": "

The identifier of the request generated by the GenerateOrganizationsAccessReport operation.

", + "smithy.api#required": {} + } + }, + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#markerType", + "traits": { + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + } + }, + "SortKey": { + "target": "com.amazonaws.iam#sortKeyType", + "traits": { + "smithy.api#documentation": "

The key that is used to sort the results. If you choose the namespace key, the results\n are returned in alphabetical order. If you choose the time key, the results are sorted\n numerically by the date and time.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#GetOrganizationsAccessReportResponse": { + "type": "structure", + "members": { + "JobStatus": { + "target": "com.amazonaws.iam#jobStatusType", + "traits": { + "smithy.api#documentation": "

The status of the job.

", + "smithy.api#required": {} + } + }, + "JobCreationDate": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the report job was created.

", + "smithy.api#required": {} + } + }, + "JobCompletionDate": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the generated report job was completed or failed.

\n

This field is null if the job is still in progress, as indicated by a job status value\n of IN_PROGRESS.

" + } + }, + "NumberOfServicesAccessible": { + "target": "com.amazonaws.iam#integerType", + "traits": { + "smithy.api#documentation": "

The number of services that the applicable SCPs allow account principals to\n access.

" + } + }, + "NumberOfServicesNotAccessed": { + "target": "com.amazonaws.iam#integerType", + "traits": { + "smithy.api#documentation": "

The number of services that account principals are allowed but did not attempt to\n access.

" + } + }, + "AccessDetails": { + "target": "com.amazonaws.iam#AccessDetails", + "traits": { + "smithy.api#documentation": "

An object that contains details about the most recent attempt to access the\n service.

" + } + }, + "IsTruncated": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#markerType", + "traits": { + "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" + } + }, + "ErrorDetails": { + "target": "com.amazonaws.iam#ErrorDetails" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#GetPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#GetPolicyRequest" + }, + "output": { + "target": "com.amazonaws.iam#GetPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves information about the specified managed policy, including the policy's\n default version and the total number of IAM users, groups, and roles to which the\n policy is attached. To retrieve the list of the specific users, groups, and roles that\n the policy is attached to, use ListEntitiesForPolicy. This operation\n returns metadata about the policy. To retrieve the actual policy document for a specific\n version of the policy, use GetPolicyVersion.

\n

This operation retrieves information about managed policies. To retrieve information\n about an inline policy that is embedded with an IAM user, group, or role, use GetUserPolicy, GetGroupPolicy, or GetRolePolicy.

\n

For more information about policies, see Managed policies and inline\n policies in the IAM User Guide.

", + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "PolicyExists": { + "acceptors": [ + { + "state": "success", + "matcher": { + "success": true + } + }, + { + "state": "retry", + "matcher": { + "errorType": "NoSuchEntity" + } + } + ], + "minDelay": 1 + } + } + } + }, + "com.amazonaws.iam#GetPolicyRequest": { + "type": "structure", + "members": { + "PolicyArn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the managed policy that you want information\n about.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#GetPolicyResponse": { + "type": "structure", + "members": { + "Policy": { + "target": "com.amazonaws.iam#Policy", + "traits": { + "smithy.api#documentation": "

A structure containing details about the policy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful GetPolicy request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#GetPolicyVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#GetPolicyVersionRequest" + }, + "output": { + "target": "com.amazonaws.iam#GetPolicyVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves information about the specified version of the specified managed policy,\n including the policy document.

\n \n

Policies returned by this operation are URL-encoded compliant \n with RFC 3986. You can use a URL \n decoding method to convert the policy back to plain JSON text. For example, if you use Java, you \n can use the decode method of the java.net.URLDecoder utility class in \n the Java SDK. Other languages and SDKs provide similar functionality.

\n \n

To list the available versions for a policy, use ListPolicyVersions.

\n

This operation retrieves information about managed policies. To retrieve information\n about an inline policy that is embedded in a user, group, or role, use GetUserPolicy, GetGroupPolicy, or GetRolePolicy.

\n

For more information about the types of policies, see Managed policies and inline\n policies in the IAM User Guide.

\n

For more information about managed policy versions, see Versioning for managed\n policies in the IAM User Guide.

" + } + }, + "com.amazonaws.iam#GetPolicyVersionRequest": { + "type": "structure", + "members": { + "PolicyArn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the managed policy that you want information\n about.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

", + "smithy.api#required": {} + } + }, + "VersionId": { + "target": "com.amazonaws.iam#policyVersionIdType", + "traits": { + "smithy.api#documentation": "

Identifies the policy version to retrieve.

\n

This parameter allows (through its regex pattern) a string of characters that \n consists of the lowercase letter 'v' followed by one or two digits, and optionally \n followed by a period '.' and a string of letters and digits.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#GetPolicyVersionResponse": { + "type": "structure", + "members": { + "PolicyVersion": { + "target": "com.amazonaws.iam#PolicyVersion", + "traits": { + "smithy.api#documentation": "

A structure containing details about the policy version.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful GetPolicyVersion request.\n

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#GetRole": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#GetRoleRequest" + }, + "output": { + "target": "com.amazonaws.iam#GetRoleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves information about the specified role, including the role's path, GUID, ARN,\n and the role's trust policy that grants permission to assume the role. For more\n information about roles, see IAM roles in the\n IAM User Guide.

\n \n

Policies returned by this operation are URL-encoded compliant \n with RFC 3986. You can use a URL \n decoding method to convert the policy back to plain JSON text. For example, if you use Java, you \n can use the decode method of the java.net.URLDecoder utility class in \n the Java SDK. Other languages and SDKs provide similar functionality.

\n ", + "smithy.api#examples": [ + { + "title": "To get information about an IAM role", + "documentation": "The following command gets information about the role named Test-Role.", + "input": { + "RoleName": "Test-Role" + }, + "output": { + "Role": { + "Arn": "arn:aws:iam::123456789012:role/Test-Role", + "AssumeRolePolicyDocument": "", + "CreateDate": "2013-04-18T05:01:58Z", + "MaxSessionDuration": 3600, + "Path": "/", + "RoleId": "AROADBQP57FF2AEXAMPLE", + "RoleLastUsed": { + "LastUsedDate": "2019-11-18T05:01:58Z", + "Region": "us-east-1" + }, + "RoleName": "Test-Role" + } + } + } + ], + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "RoleExists": { + "acceptors": [ + { + "state": "success", + "matcher": { + "success": true + } + }, + { + "state": "retry", + "matcher": { + "errorType": "NoSuchEntity" + } + } + ], + "minDelay": 1 + } + } + } + }, + "com.amazonaws.iam#GetRolePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#GetRolePolicyRequest" + }, + "output": { + "target": "com.amazonaws.iam#GetRolePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the specified inline policy document that is embedded with the specified\n IAM role.

\n \n

Policies returned by this operation are URL-encoded compliant \n with RFC 3986. You can use a URL \n decoding method to convert the policy back to plain JSON text. For example, if you use Java, you \n can use the decode method of the java.net.URLDecoder utility class in \n the Java SDK. Other languages and SDKs provide similar functionality.

\n \n

An IAM role can also have managed policies attached to it. To retrieve a managed\n policy document that is attached to a role, use GetPolicy to determine\n the policy's default version, then use GetPolicyVersion to retrieve\n the policy document.

\n

For more information about policies, see Managed policies and inline\n policies in the IAM User Guide.

\n

For more information about roles, see IAM roles in the\n IAM User Guide.

" + } + }, + "com.amazonaws.iam#GetRolePolicyRequest": { + "type": "structure", + "members": { + "RoleName": { + "target": "com.amazonaws.iam#roleNameType", + "traits": { + "smithy.api#documentation": "

The name of the role associated with the policy.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "PolicyName": { + "target": "com.amazonaws.iam#policyNameType", + "traits": { + "smithy.api#documentation": "

The name of the policy document to get.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#GetRolePolicyResponse": { + "type": "structure", + "members": { + "RoleName": { + "target": "com.amazonaws.iam#roleNameType", + "traits": { + "smithy.api#documentation": "

The role the policy is associated with.

", + "smithy.api#required": {} + } + }, + "PolicyName": { + "target": "com.amazonaws.iam#policyNameType", + "traits": { + "smithy.api#documentation": "

The name of the policy.

", + "smithy.api#required": {} + } + }, + "PolicyDocument": { + "target": "com.amazonaws.iam#policyDocumentType", + "traits": { + "smithy.api#documentation": "

The policy document.

\n

IAM stores policies in JSON format. However, resources that were created using CloudFormation\n templates can be formatted in YAML. CloudFormation always converts a YAML policy to JSON format\n before submitting it to IAM.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful GetRolePolicy request.\n

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#GetRoleRequest": { + "type": "structure", + "members": { + "RoleName": { + "target": "com.amazonaws.iam#roleNameType", + "traits": { + "smithy.api#documentation": "

The name of the IAM role to get information about.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#GetRoleResponse": { + "type": "structure", + "members": { + "Role": { + "target": "com.amazonaws.iam#Role", + "traits": { + "smithy.api#documentation": "

A structure containing details about the IAM role.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful GetRole request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#GetSAMLProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#GetSAMLProviderRequest" + }, + "output": { + "target": "com.amazonaws.iam#GetSAMLProviderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the SAML provider metadocument that was uploaded when the IAM SAML provider\n resource object was created or updated.

\n \n

This operation requires Signature Version 4.

\n " + } + }, + "com.amazonaws.iam#GetSAMLProviderRequest": { + "type": "structure", + "members": { + "SAMLProviderArn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SAML provider resource object in IAM to get\n information about.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#GetSAMLProviderResponse": { + "type": "structure", + "members": { + "SAMLMetadataDocument": { + "target": "com.amazonaws.iam#SAMLMetadataDocumentType", + "traits": { + "smithy.api#documentation": "

The XML metadata document that includes information about an identity provider.

" + } + }, + "CreateDate": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date and time when the SAML provider was created.

" + } + }, + "ValidUntil": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The expiration date and time for the SAML provider.

" + } + }, + "Tags": { + "target": "com.amazonaws.iam#tagListType", + "traits": { + "smithy.api#documentation": "

A list of tags that are attached to the specified IAM SAML provider. The returned list of tags is sorted by tag key.\n For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful GetSAMLProvider request.\n

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#GetSSHPublicKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#GetSSHPublicKeyRequest" + }, + "output": { + "target": "com.amazonaws.iam#GetSSHPublicKeyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#UnrecognizedPublicKeyEncodingException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the specified SSH public key, including metadata about the key.

\n

The SSH public key retrieved by this operation is used only for authenticating the\n associated IAM user to an CodeCommit repository. For more information about using SSH keys\n to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH\n connections in the CodeCommit User Guide.

" + } + }, + "com.amazonaws.iam#GetSSHPublicKeyRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#userNameType", + "traits": { + "smithy.api#documentation": "

The name of the IAM user associated with the SSH public key.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "SSHPublicKeyId": { + "target": "com.amazonaws.iam#publicKeyIdType", + "traits": { + "smithy.api#documentation": "

The unique identifier for the SSH public key.

\n

This parameter allows (through its regex pattern) a string of characters that can \n consist of any upper or lowercased letter or digit.

", + "smithy.api#required": {} + } + }, + "Encoding": { + "target": "com.amazonaws.iam#encodingType", + "traits": { + "smithy.api#documentation": "

Specifies the public key encoding format to use in the response. To retrieve the\n public key in ssh-rsa format, use SSH. To retrieve the public key in PEM\n format, use PEM.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#GetSSHPublicKeyResponse": { + "type": "structure", + "members": { + "SSHPublicKey": { + "target": "com.amazonaws.iam#SSHPublicKey", + "traits": { + "smithy.api#documentation": "

A structure containing details about the SSH public key.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful GetSSHPublicKey\n request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#GetServerCertificate": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#GetServerCertificateRequest" + }, + "output": { + "target": "com.amazonaws.iam#GetServerCertificateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves information about the specified server certificate stored in IAM.

\n

For more information about working with server certificates, see Working\n with server certificates in the IAM User Guide. This\n topic includes a list of Amazon Web Services services that can use the server certificates that you\n manage with IAM.

" + } + }, + "com.amazonaws.iam#GetServerCertificateRequest": { + "type": "structure", + "members": { + "ServerCertificateName": { + "target": "com.amazonaws.iam#serverCertificateNameType", + "traits": { + "smithy.api#documentation": "

The name of the server certificate you want to retrieve information about.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#GetServerCertificateResponse": { + "type": "structure", + "members": { + "ServerCertificate": { + "target": "com.amazonaws.iam#ServerCertificate", + "traits": { + "smithy.api#documentation": "

A structure containing details about the server certificate.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful GetServerCertificate request.\n

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#GetServiceLastAccessedDetails": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#GetServiceLastAccessedDetailsRequest" + }, + "output": { + "target": "com.amazonaws.iam#GetServiceLastAccessedDetailsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a service last accessed report that was created using the\n GenerateServiceLastAccessedDetails operation. You can use the\n JobId parameter in GetServiceLastAccessedDetails to\n retrieve the status of your report job. When the report is complete, you can retrieve\n the generated report. The report includes a list of Amazon Web Services services that the resource\n (user, group, role, or managed policy) can access.

\n \n

Service last accessed data does not use other policy types when determining\n whether a resource could access a service. These other policy types include\n resource-based policies, access control lists, Organizations policies, IAM permissions\n boundaries, and STS assume role policies. It only applies permissions policy\n logic. For more about the evaluation of policy types, see Evaluating policies in the\n IAM User Guide.

\n \n

For each service that the resource could access using permissions policies, the\n operation returns details about the most recent access attempt. If there was no attempt,\n the service is listed without details about the most recent attempt to access the\n service. If the operation fails, the GetServiceLastAccessedDetails\n operation returns the reason that it failed.

\n

The GetServiceLastAccessedDetails operation returns a list of services.\n This list includes the number of entities that have attempted to access the service and\n the date and time of the last attempt. It also returns the ARN of the following entity,\n depending on the resource ARN that you used to generate the report:

\n
    \n
  • \n

    \n User – Returns the user ARN that you\n used to generate the report

    \n
    • \n
  • \n

    \n Group – Returns the ARN of the group\n member (user) that last attempted to access the service

    \n
    • \n
  • \n

    \n Role – Returns the role ARN that you\n used to generate the report

    \n
    • \n
  • \n

    \n Policy – Returns the ARN of the user\n or role that last used the policy to attempt to access the service

    \n
    • \n
\n

By default, the list is sorted by service namespace.

\n

If you specified ACTION_LEVEL granularity when you generated the report,\n this operation returns service and action last accessed data. This includes the most\n recent access attempt for each tracked action within a service. Otherwise, this\n operation returns only service data.

\n

For more information about service and action last accessed data, see Reducing permissions using service last accessed data in the\n IAM User Guide.

", + "smithy.api#examples": [ + { + "title": "To get details from a previously-generated report", + "documentation": "The following operation gets details about the report with the job ID: examplef-1305-c245-eba4-71fe298bcda7", + "input": { + "JobId": "examplef-1305-c245-eba4-71fe298bcda7" + }, + "output": { + "JobStatus": "COMPLETED", + "JobCreationDate": "2018-10-24T19:47:31.466Z", + "ServicesLastAccessed": [ + { + "TotalAuthenticatedEntities": 2, + "LastAuthenticated": "2018-10-24T19:11:00Z", + "ServiceNamespace": "iam", + "LastAuthenticatedEntity": "arn:aws:iam::123456789012:user/AWSExampleUser01", + "ServiceName": "AWS Identity and Access Management" + }, + { + "TotalAuthenticatedEntities": 0, + "ServiceNamespace": "s3", + "ServiceName": "Amazon Simple Storage Service" + } + ], + "JobCompletionDate": "2018-10-24T19:47:35.241Z", + "IsTruncated": false + } + } + ] + } + }, + "com.amazonaws.iam#GetServiceLastAccessedDetailsRequest": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.iam#jobIDType", + "traits": { + "smithy.api#documentation": "

The ID of the request generated by the GenerateServiceLastAccessedDetails operation. The JobId\n returned by GenerateServiceLastAccessedDetail must be used by the same role\n within a session, or by the same user when used to call\n GetServiceLastAccessedDetail.

", + "smithy.api#required": {} + } + }, + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#markerType", + "traits": { + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#GetServiceLastAccessedDetailsResponse": { + "type": "structure", + "members": { + "JobStatus": { + "target": "com.amazonaws.iam#jobStatusType", + "traits": { + "smithy.api#documentation": "

The status of the job.

", + "smithy.api#required": {} + } + }, + "JobType": { + "target": "com.amazonaws.iam#AccessAdvisorUsageGranularityType", + "traits": { + "smithy.api#documentation": "

The type of job. Service jobs return information about when each service was last\n accessed. Action jobs also include information about when tracked actions within the\n service were last accessed.

" + } + }, + "JobCreationDate": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the report job was created.

", + "smithy.api#required": {} + } + }, + "ServicesLastAccessed": { + "target": "com.amazonaws.iam#ServicesLastAccessed", + "traits": { + "smithy.api#documentation": "

A ServiceLastAccessed object that contains details about the most recent\n attempt to access the service.

", + "smithy.api#required": {} + } + }, + "JobCompletionDate": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the generated report job was completed or failed.

\n

This field is null if the job is still in progress, as indicated by a job status value\n of IN_PROGRESS.

", + "smithy.api#required": {} + } + }, + "IsTruncated": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#responseMarkerType", + "traits": { + "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" + } + }, + "Error": { + "target": "com.amazonaws.iam#ErrorDetails", + "traits": { + "smithy.api#documentation": "

An object that contains details about the reason the operation failed.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#GetServiceLastAccessedDetailsWithEntities": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#GetServiceLastAccessedDetailsWithEntitiesRequest" + }, + "output": { + "target": "com.amazonaws.iam#GetServiceLastAccessedDetailsWithEntitiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + } + ], + "traits": { + "smithy.api#documentation": "

After you generate a group or policy report using the\n GenerateServiceLastAccessedDetails operation, you can use the\n JobId parameter in\n GetServiceLastAccessedDetailsWithEntities. This operation retrieves the\n status of your report job and a list of entities that could have used group or policy\n permissions to access the specified service.

\n
    \n
  • \n

    \n Group – For a group report, this\n operation returns a list of users in the group that could have used the group’s\n policies in an attempt to access the service.

    \n
    • \n
  • \n

    \n Policy – For a policy report, this\n operation returns a list of entities (users or roles) that could have used the\n policy in an attempt to access the service.

    \n
    • \n
\n

You can also use this operation for user or role reports to retrieve details about\n those entities.

\n

If the operation fails, the GetServiceLastAccessedDetailsWithEntities\n operation returns the reason that it failed.

\n

By default, the list of associated entities is sorted by date, with the most recent\n access listed first.

", + "smithy.api#examples": [ + { + "title": "To get sntity details from a previously-generated report", + "documentation": "The following operation returns details about the entities that attempted to access the IAM service.", + "input": { + "JobId": "examplef-1305-c245-eba4-71fe298bcda7", + "ServiceNamespace": "iam" + }, + "output": { + "JobStatus": "COMPLETED", + "JobCreationDate": "2018-10-24T19:47:31.466Z", + "JobCompletionDate": "2018-10-24T19:47:35.241Z", + "EntityDetailsList": [ + { + "EntityInfo": { + "Id": "AIDAEX2EXAMPLEB6IGCDC", + "Name": "AWSExampleUser01", + "Type": "USER", + "Path": "/", + "Arn": "arn:aws:iam::123456789012:user/AWSExampleUser01" + }, + "LastAuthenticated": "2018-10-24T19:10:00Z" + }, + { + "EntityInfo": { + "Id": "AROAEAEXAMPLEIANXSIU4", + "Name": "AWSExampleRole01", + "Type": "ROLE", + "Path": "/", + "Arn": "arn:aws:iam::123456789012:role/AWSExampleRole01" + } + } + ], + "IsTruncated": false + } + } + ] + } + }, + "com.amazonaws.iam#GetServiceLastAccessedDetailsWithEntitiesRequest": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.iam#jobIDType", + "traits": { + "smithy.api#documentation": "

The ID of the request generated by the GenerateServiceLastAccessedDetails\n operation.

", + "smithy.api#required": {} + } + }, + "ServiceNamespace": { + "target": "com.amazonaws.iam#serviceNamespaceType", + "traits": { + "smithy.api#documentation": "

The service namespace for an Amazon Web Services service. Provide the service namespace to learn\n when the IAM entity last attempted to access the specified service.

\n

To learn the service namespace for a service, see Actions, resources, and condition keys for Amazon Web Services services in the\n IAM User Guide. Choose the name of the service to view\n details for that service. In the first paragraph, find the service prefix. For example,\n (service prefix: a4b). For more information about service namespaces,\n see Amazon Web Services\n service namespaces in the Amazon Web Services General Reference.

", + "smithy.api#required": {} + } + }, + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#markerType", + "traits": { + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#GetServiceLastAccessedDetailsWithEntitiesResponse": { + "type": "structure", + "members": { + "JobStatus": { + "target": "com.amazonaws.iam#jobStatusType", + "traits": { + "smithy.api#documentation": "

The status of the job.

", + "smithy.api#required": {} + } + }, + "JobCreationDate": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the report job was created.

", + "smithy.api#required": {} + } + }, + "JobCompletionDate": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the generated report job was completed or failed.

\n

This field is null if the job is still in progress, as indicated by a job status value\n of IN_PROGRESS.

", + "smithy.api#required": {} + } + }, + "EntityDetailsList": { + "target": "com.amazonaws.iam#entityDetailsListType", + "traits": { + "smithy.api#documentation": "

An EntityDetailsList object that contains details about when an IAM\n entity (user or role) used group or policy permissions in an attempt to access the\n specified Amazon Web Services service.

", + "smithy.api#required": {} + } + }, + "IsTruncated": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#responseMarkerType", + "traits": { + "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" + } + }, + "Error": { + "target": "com.amazonaws.iam#ErrorDetails", + "traits": { + "smithy.api#documentation": "

An object that contains details about the reason the operation failed.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#GetServiceLinkedRoleDeletionStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#GetServiceLinkedRoleDeletionStatusRequest" + }, + "output": { + "target": "com.amazonaws.iam#GetServiceLinkedRoleDeletionStatusResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the status of your service-linked role deletion. After you use DeleteServiceLinkedRole to submit a service-linked role for deletion,\n you can use the DeletionTaskId parameter in\n GetServiceLinkedRoleDeletionStatus to check the status of the deletion.\n If the deletion fails, this operation returns the reason that it failed, if that\n information is returned by the service.

" + } + }, + "com.amazonaws.iam#GetServiceLinkedRoleDeletionStatusRequest": { + "type": "structure", + "members": { + "DeletionTaskId": { + "target": "com.amazonaws.iam#DeletionTaskIdType", + "traits": { + "smithy.api#documentation": "

The deletion task identifier. This identifier is returned by the DeleteServiceLinkedRole operation in the format\n task/aws-service-role///.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#GetServiceLinkedRoleDeletionStatusResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.iam#DeletionTaskStatusType", + "traits": { + "smithy.api#documentation": "

The status of the deletion.

", + "smithy.api#required": {} + } + }, + "Reason": { + "target": "com.amazonaws.iam#DeletionTaskFailureReasonType", + "traits": { + "smithy.api#documentation": "

An object that contains details about the reason the deletion failed.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#GetUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#GetUserRequest" + }, + "output": { + "target": "com.amazonaws.iam#GetUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves information about the specified IAM user, including the user's creation\n date, path, unique ID, and ARN.

\n

If you do not specify a user name, IAM determines the user name implicitly based on\n the Amazon Web Services access key ID used to sign the request to this operation.

", + "smithy.api#examples": [ + { + "title": "To get information about an IAM user", + "documentation": "The following command gets information about the IAM user named Bob.", + "input": { + "UserName": "Bob" + }, + "output": { + "User": { + "UserName": "Bob", + "Path": "/", + "CreateDate": "2012-09-21T23:03:13Z", + "UserId": "AKIAIOSFODNN7EXAMPLE", + "Arn": "arn:aws:iam::123456789012:user/Bob" + } + } + } + ], + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.test#smokeTests": [ + { + "id": "GetUserFailure", + "params": { + "UserName": "fake_user" + }, + "vendorParams": { + "region": "us-east-1" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "failure": {} + } + } + ], + "smithy.waiters#waitable": { + "UserExists": { + "acceptors": [ + { + "state": "success", + "matcher": { + "success": true + } + }, + { + "state": "retry", + "matcher": { + "errorType": "NoSuchEntity" + } + } + ], + "minDelay": 1 + } + } + } + }, + "com.amazonaws.iam#GetUserPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#GetUserPolicyRequest" + }, + "output": { + "target": "com.amazonaws.iam#GetUserPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the specified inline policy document that is embedded in the specified IAM\n user.

\n \n

Policies returned by this operation are URL-encoded compliant \n with RFC 3986. You can use a URL \n decoding method to convert the policy back to plain JSON text. For example, if you use Java, you \n can use the decode method of the java.net.URLDecoder utility class in \n the Java SDK. Other languages and SDKs provide similar functionality.

\n \n

An IAM user can also have managed policies attached to it. To retrieve a managed\n policy document that is attached to a user, use GetPolicy to determine\n the policy's default version. Then use GetPolicyVersion to retrieve\n the policy document.

\n

For more information about policies, see Managed policies and inline\n policies in the IAM User Guide.

" + } + }, + "com.amazonaws.iam#GetUserPolicyRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#existingUserNameType", + "traits": { + "smithy.api#documentation": "

The name of the user who the policy is associated with.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "PolicyName": { + "target": "com.amazonaws.iam#policyNameType", + "traits": { + "smithy.api#documentation": "

The name of the policy document to get.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#GetUserPolicyResponse": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#existingUserNameType", + "traits": { + "smithy.api#documentation": "

The user the policy is associated with.

", + "smithy.api#required": {} + } + }, + "PolicyName": { + "target": "com.amazonaws.iam#policyNameType", + "traits": { + "smithy.api#documentation": "

The name of the policy.

", + "smithy.api#required": {} + } + }, + "PolicyDocument": { + "target": "com.amazonaws.iam#policyDocumentType", + "traits": { + "smithy.api#documentation": "

The policy document.

\n

IAM stores policies in JSON format. However, resources that were created using CloudFormation\n templates can be formatted in YAML. CloudFormation always converts a YAML policy to JSON format\n before submitting it to IAM.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful GetUserPolicy request.\n

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#GetUserRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#existingUserNameType", + "traits": { + "smithy.api#documentation": "

The name of the user to get information about.

\n

This parameter is optional. If it is not included, it defaults to the user making the\n request. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#GetUserResponse": { + "type": "structure", + "members": { + "User": { + "target": "com.amazonaws.iam#User", + "traits": { + "smithy.api#documentation": "

A structure containing details about the IAM user.

\n \n

Due to a service issue, password last used data does not include password use from\n May 3, 2018 22:50 PDT to May 23, 2018 14:08 PDT. This affects last sign-in dates shown in the IAM console and password last used\n dates in the IAM credential\n report, and returned by this operation. If users signed in during the\n affected time, the password last used date that is returned is the date the user\n last signed in before May 3, 2018. For users that signed in after May 23, 2018 14:08\n PDT, the returned password last used date is accurate.

\n

You can use password last used information to identify unused credentials for\n deletion. For example, you might delete users who did not sign in to Amazon Web Services in the\n last 90 days. In cases like this, we recommend that you adjust your evaluation\n window to include dates after May 23, 2018. Alternatively, if your users use access\n keys to access Amazon Web Services programmatically you can refer to access key last used\n information because it is accurate for all dates.

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful GetUser request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#Group": { + "type": "structure", + "members": { + "Path": { + "target": "com.amazonaws.iam#pathType", + "traits": { + "smithy.api#documentation": "

The path to the group. For more information about paths, see IAM identifiers in the\n IAM User Guide.

", + "smithy.api#required": {} + } + }, + "GroupName": { + "target": "com.amazonaws.iam#groupNameType", + "traits": { + "smithy.api#documentation": "

The friendly name that identifies the group.

", + "smithy.api#required": {} + } + }, + "GroupId": { + "target": "com.amazonaws.iam#idType", + "traits": { + "smithy.api#documentation": "

The stable and unique string identifying the group. For more information about IDs, see\n IAM\n identifiers in the IAM User Guide.

", + "smithy.api#required": {} + } + }, + "Arn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) specifying the group. For more information about ARNs\n and how to use them in policies, see IAM identifiers in the\n IAM User Guide.

", + "smithy.api#required": {} + } + }, + "CreateDate": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the group was created.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about an IAM group entity.

\n

This data type is used as a response element in the following operations:

\n " + } + }, + "com.amazonaws.iam#GroupDetail": { + "type": "structure", + "members": { + "Path": { + "target": "com.amazonaws.iam#pathType", + "traits": { + "smithy.api#documentation": "

The path to the group. For more information about paths, see IAM identifiers in the\n IAM User Guide.

" + } + }, + "GroupName": { + "target": "com.amazonaws.iam#groupNameType", + "traits": { + "smithy.api#documentation": "

The friendly name that identifies the group.

" + } + }, + "GroupId": { + "target": "com.amazonaws.iam#idType", + "traits": { + "smithy.api#documentation": "

The stable and unique string identifying the group. For more information about IDs, see\n IAM\n identifiers in the IAM User Guide.

" + } + }, + "Arn": { + "target": "com.amazonaws.iam#arnType" + }, + "CreateDate": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the group was created.

" + } + }, + "GroupPolicyList": { + "target": "com.amazonaws.iam#policyDetailListType", + "traits": { + "smithy.api#documentation": "

A list of the inline policies embedded in the group.

" + } + }, + "AttachedManagedPolicies": { + "target": "com.amazonaws.iam#attachedPoliciesListType", + "traits": { + "smithy.api#documentation": "

A list of the managed policies attached to the group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about an IAM group, including all of the group's policies.

\n

This data type is used as a response element in the GetAccountAuthorizationDetails operation.

" + } + }, + "com.amazonaws.iam#InstanceProfile": { + "type": "structure", + "members": { + "Path": { + "target": "com.amazonaws.iam#pathType", + "traits": { + "smithy.api#documentation": "

The path to the instance profile. For more information about paths, see IAM\n identifiers in the IAM User Guide.

", + "smithy.api#required": {} + } + }, + "InstanceProfileName": { + "target": "com.amazonaws.iam#instanceProfileNameType", + "traits": { + "smithy.api#documentation": "

The name identifying the instance profile.

", + "smithy.api#required": {} + } + }, + "InstanceProfileId": { + "target": "com.amazonaws.iam#idType", + "traits": { + "smithy.api#documentation": "

The stable and unique string identifying the instance profile. For more information\n about IDs, see IAM identifiers in the IAM User Guide.

", + "smithy.api#required": {} + } + }, + "Arn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) specifying the instance profile. For more information\n about ARNs and how to use them in policies, see IAM identifiers in the\n IAM User Guide.

", + "smithy.api#required": {} + } + }, + "CreateDate": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date when the instance profile was created.

", + "smithy.api#required": {} + } + }, + "Roles": { + "target": "com.amazonaws.iam#roleListType", + "traits": { + "smithy.api#documentation": "

The role associated with the instance profile.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.iam#tagListType", + "traits": { + "smithy.api#documentation": "

A list of tags that are attached to the instance profile. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about an instance profile.

\n

This data type is used as a response element in the following operations:

\n " + } + }, + "com.amazonaws.iam#InvalidAuthenticationCodeException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iam#invalidAuthenticationCodeMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidAuthenticationCode", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "

The request was rejected because the authentication code was not recognized. The error\n message describes the specific error.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.iam#InvalidCertificateException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iam#invalidCertificateMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidCertificate", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request was rejected because the certificate is invalid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.iam#InvalidInputException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iam#invalidInputMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidInput", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request was rejected because an invalid or out-of-range value was supplied for an\n input parameter.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.iam#InvalidPublicKeyException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iam#invalidPublicKeyMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidPublicKey", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request was rejected because the public key is malformed or otherwise invalid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.iam#InvalidUserTypeException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iam#invalidUserTypeMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidUserType", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request was rejected because the type of user for the transaction was\n incorrect.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.iam#KeyPairMismatchException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iam#keyPairMismatchMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "KeyPairMismatch", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request was rejected because the public key certificate and the private key do not\n match.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.iam#LimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iam#limitExceededMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "LimitExceeded", + "httpResponseCode": 409 + }, + "smithy.api#documentation": "

The request was rejected because it attempted to create resources beyond the current\n Amazon Web Services account limits. The error message describes the limit exceeded.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.iam#LineNumber": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.iam#ListAccessKeys": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#ListAccessKeysRequest" + }, + "output": { + "target": "com.amazonaws.iam#ListAccessKeysResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about the access key IDs associated with the specified IAM user.\n If there is none, the operation returns an empty list.

\n

Although each user is limited to a small number of keys, you can still paginate the\n results using the MaxItems and Marker parameters.

\n

If the UserName is not specified, the user name is determined implicitly\n based on the Amazon Web Services access key ID used to sign the request. If a temporary access key is\n used, then UserName is required. If a long-term key is assigned to the\n user, then UserName is not required.

\n

This operation works for access keys under the Amazon Web Services account. If the Amazon Web Services account has\n no associated users, the root user returns it's own access key IDs by running this\n command.

\n \n

To ensure the security of your Amazon Web Services account, the secret access key is accessible\n only during key and user creation.

\n ", + "smithy.api#examples": [ + { + "title": "To list the access key IDs for an IAM user", + "documentation": "The following command lists the access keys IDs for the IAM user named Alice.", + "input": { + "UserName": "Alice" + }, + "output": { + "AccessKeyMetadata": [ + { + "UserName": "Alice", + "Status": "Active", + "CreateDate": "2016-12-01T22:19:58Z", + "AccessKeyId": "AKIA111111111EXAMPLE" + }, + { + "UserName": "Alice", + "Status": "Active", + "CreateDate": "2016-12-01T22:20:01Z", + "AccessKeyId": "AKIA222222222EXAMPLE" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "AccessKeyMetadata", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.iam#ListAccessKeysRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#existingUserNameType", + "traits": { + "smithy.api#documentation": "

The name of the user.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#markerType", + "traits": { + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + } + }, + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#ListAccessKeysResponse": { + "type": "structure", + "members": { + "AccessKeyMetadata": { + "target": "com.amazonaws.iam#accessKeyMetadataListType", + "traits": { + "smithy.api#documentation": "

A list of objects containing metadata about the access keys.

", + "smithy.api#required": {} + } + }, + "IsTruncated": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#responseMarkerType", + "traits": { + "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful ListAccessKeys request.\n

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#ListAccountAliases": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#ListAccountAliasesRequest" + }, + "output": { + "target": "com.amazonaws.iam#ListAccountAliasesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the account alias associated with the Amazon Web Services account (Note: you can have only\n one). For information about using an Amazon Web Services account alias, see Creating,\n deleting, and listing an Amazon Web Services account alias in the Amazon Web Services Sign-In\n User Guide.

", + "smithy.api#examples": [ + { + "title": "To list account aliases", + "documentation": "The following command lists the aliases for the current account.", + "output": { + "AccountAliases": [ + "exmaple-corporation" + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "AccountAliases", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.iam#ListAccountAliasesRequest": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.iam#markerType", + "traits": { + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + } + }, + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#ListAccountAliasesResponse": { + "type": "structure", + "members": { + "AccountAliases": { + "target": "com.amazonaws.iam#accountAliasListType", + "traits": { + "smithy.api#documentation": "

A list of aliases associated with the account. Amazon Web Services supports only one alias per\n account.

", + "smithy.api#required": {} + } + }, + "IsTruncated": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#responseMarkerType", + "traits": { + "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful ListAccountAliases request.\n

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#ListAttachedGroupPolicies": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#ListAttachedGroupPoliciesRequest" + }, + "output": { + "target": "com.amazonaws.iam#ListAttachedGroupPoliciesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all managed policies that are attached to the specified IAM group.

\n

An IAM group can also have inline policies embedded with it. To list the inline\n policies for a group, use ListGroupPolicies. For information about\n policies, see Managed policies and inline\n policies in the IAM User Guide.

\n

You can paginate the results using the MaxItems and Marker\n parameters. You can use the PathPrefix parameter to limit the list of\n policies to only those matching the specified path prefix. If there are no policies\n attached to the specified group (or none that match the specified path prefix), the\n operation returns an empty list.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "AttachedPolicies", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.iam#ListAttachedGroupPoliciesRequest": { + "type": "structure", + "members": { + "GroupName": { + "target": "com.amazonaws.iam#groupNameType", + "traits": { + "smithy.api#documentation": "

The name (friendly name, not ARN) of the group to list attached policies for.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "PathPrefix": { + "target": "com.amazonaws.iam#policyPathType", + "traits": { + "smithy.api#documentation": "

The path prefix for filtering the results. This parameter is optional. If it is not\n included, it defaults to a slash (/), listing all policies.

\n

This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including \n most punctuation characters, digits, and upper and lowercased letters.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#markerType", + "traits": { + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + } + }, + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#ListAttachedGroupPoliciesResponse": { + "type": "structure", + "members": { + "AttachedPolicies": { + "target": "com.amazonaws.iam#attachedPoliciesListType", + "traits": { + "smithy.api#documentation": "

A list of the attached policies.

" + } + }, + "IsTruncated": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#responseMarkerType", + "traits": { + "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful ListAttachedGroupPolicies\n request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#ListAttachedRolePolicies": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#ListAttachedRolePoliciesRequest" + }, + "output": { + "target": "com.amazonaws.iam#ListAttachedRolePoliciesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all managed policies that are attached to the specified IAM role.

\n

An IAM role can also have inline policies embedded with it. To list the inline\n policies for a role, use ListRolePolicies. For information about\n policies, see Managed policies and inline\n policies in the IAM User Guide.

\n

You can paginate the results using the MaxItems and Marker\n parameters. You can use the PathPrefix parameter to limit the list of\n policies to only those matching the specified path prefix. If there are no policies\n attached to the specified role (or none that match the specified path prefix), the\n operation returns an empty list.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "AttachedPolicies", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.iam#ListAttachedRolePoliciesRequest": { + "type": "structure", + "members": { + "RoleName": { + "target": "com.amazonaws.iam#roleNameType", + "traits": { + "smithy.api#documentation": "

The name (friendly name, not ARN) of the role to list attached policies for.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "PathPrefix": { + "target": "com.amazonaws.iam#policyPathType", + "traits": { + "smithy.api#documentation": "

The path prefix for filtering the results. This parameter is optional. If it is not\n included, it defaults to a slash (/), listing all policies.

\n

This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including \n most punctuation characters, digits, and upper and lowercased letters.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#markerType", + "traits": { + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + } + }, + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#ListAttachedRolePoliciesResponse": { + "type": "structure", + "members": { + "AttachedPolicies": { + "target": "com.amazonaws.iam#attachedPoliciesListType", + "traits": { + "smithy.api#documentation": "

A list of the attached policies.

" + } + }, + "IsTruncated": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#responseMarkerType", + "traits": { + "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful ListAttachedRolePolicies\n request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#ListAttachedUserPolicies": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#ListAttachedUserPoliciesRequest" + }, + "output": { + "target": "com.amazonaws.iam#ListAttachedUserPoliciesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all managed policies that are attached to the specified IAM user.

\n

An IAM user can also have inline policies embedded with it. To list the inline\n policies for a user, use ListUserPolicies. For information about\n policies, see Managed policies and inline\n policies in the IAM User Guide.

\n

You can paginate the results using the MaxItems and Marker\n parameters. You can use the PathPrefix parameter to limit the list of\n policies to only those matching the specified path prefix. If there are no policies\n attached to the specified group (or none that match the specified path prefix), the\n operation returns an empty list.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "AttachedPolicies", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.iam#ListAttachedUserPoliciesRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#userNameType", + "traits": { + "smithy.api#documentation": "

The name (friendly name, not ARN) of the user to list attached policies for.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "PathPrefix": { + "target": "com.amazonaws.iam#policyPathType", + "traits": { + "smithy.api#documentation": "

The path prefix for filtering the results. This parameter is optional. If it is not\n included, it defaults to a slash (/), listing all policies.

\n

This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including \n most punctuation characters, digits, and upper and lowercased letters.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#markerType", + "traits": { + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + } + }, + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#ListAttachedUserPoliciesResponse": { + "type": "structure", + "members": { + "AttachedPolicies": { + "target": "com.amazonaws.iam#attachedPoliciesListType", + "traits": { + "smithy.api#documentation": "

A list of the attached policies.

" + } + }, + "IsTruncated": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#responseMarkerType", + "traits": { + "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful ListAttachedUserPolicies\n request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#ListEntitiesForPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#ListEntitiesForPolicyRequest" + }, + "output": { + "target": "com.amazonaws.iam#ListEntitiesForPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all IAM users, groups, and roles that the specified managed policy is attached\n to.

\n

You can use the optional EntityFilter parameter to limit the results to a\n particular type of entity (users, groups, or roles). For example, to list only the roles\n that are attached to the specified policy, set EntityFilter to\n Role.

\n

You can paginate the results using the MaxItems and Marker\n parameters.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.iam#ListEntitiesForPolicyRequest": { + "type": "structure", + "members": { + "PolicyArn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM policy for which you want the\n versions.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

", + "smithy.api#required": {} + } + }, + "EntityFilter": { + "target": "com.amazonaws.iam#EntityType", + "traits": { + "smithy.api#documentation": "

The entity type to use for filtering the results.

\n

For example, when EntityFilter is Role, only the roles that\n are attached to the specified policy are returned. This parameter is optional. If it is\n not included, all attached entities (users, groups, and roles) are returned. The\n argument for this parameter must be one of the valid values listed below.

" + } + }, + "PathPrefix": { + "target": "com.amazonaws.iam#pathType", + "traits": { + "smithy.api#documentation": "

The path prefix for filtering the results. This parameter is optional. If it is not\n included, it defaults to a slash (/), listing all entities.

\n

This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including \n most punctuation characters, digits, and upper and lowercased letters.

" + } + }, + "PolicyUsageFilter": { + "target": "com.amazonaws.iam#PolicyUsageType", + "traits": { + "smithy.api#documentation": "

The policy usage method to use for filtering the results.

\n

To list only permissions policies,\n set PolicyUsageFilter to PermissionsPolicy. To list only\n the policies used to set permissions boundaries, set the value\n to PermissionsBoundary.

\n

This parameter is optional. If it is not included, all policies are returned.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#markerType", + "traits": { + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + } + }, + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#ListEntitiesForPolicyResponse": { + "type": "structure", + "members": { + "PolicyGroups": { + "target": "com.amazonaws.iam#PolicyGroupListType", + "traits": { + "smithy.api#documentation": "

A list of IAM groups that the policy is attached to.

" + } + }, + "PolicyUsers": { + "target": "com.amazonaws.iam#PolicyUserListType", + "traits": { + "smithy.api#documentation": "

A list of IAM users that the policy is attached to.

" + } + }, + "PolicyRoles": { + "target": "com.amazonaws.iam#PolicyRoleListType", + "traits": { + "smithy.api#documentation": "

A list of IAM roles that the policy is attached to.

" + } + }, + "IsTruncated": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#responseMarkerType", + "traits": { + "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful ListEntitiesForPolicy request.\n

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#ListGroupPolicies": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#ListGroupPoliciesRequest" + }, + "output": { + "target": "com.amazonaws.iam#ListGroupPoliciesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the names of the inline policies that are embedded in the specified IAM\n group.

\n

An IAM group can also have managed policies attached to it. To list the managed\n policies that are attached to a group, use ListAttachedGroupPolicies.\n For more information about policies, see Managed policies and inline\n policies in the IAM User Guide.

\n

You can paginate the results using the MaxItems and Marker\n parameters. If there are no inline policies embedded with the specified group, the\n operation returns an empty list.

", + "smithy.api#examples": [ + { + "title": "To list the in-line policies for an IAM group", + "documentation": "The following command lists the names of in-line policies that are embedded in the IAM group named Admins.", + "input": { + "GroupName": "Admins" + }, + "output": { + "PolicyNames": [ + "AdminRoot", + "KeyPolicy" + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "PolicyNames", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.iam#ListGroupPoliciesRequest": { + "type": "structure", + "members": { + "GroupName": { + "target": "com.amazonaws.iam#groupNameType", + "traits": { + "smithy.api#documentation": "

The name of the group to list policies for.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "Marker": { + "target": "com.amazonaws.iam#markerType", + "traits": { + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + } + }, + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#ListGroupPoliciesResponse": { + "type": "structure", + "members": { + "PolicyNames": { + "target": "com.amazonaws.iam#policyNameListType", + "traits": { + "smithy.api#documentation": "

A list of policy names.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "IsTruncated": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#responseMarkerType", + "traits": { + "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful ListGroupPolicies request.\n

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#ListGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#ListGroupsRequest" + }, + "output": { + "target": "com.amazonaws.iam#ListGroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the IAM groups that have the specified path prefix.

\n

You can paginate the results using the MaxItems and Marker\n parameters.

", + "smithy.api#examples": [ + { + "title": "To list the IAM groups for the current account", + "documentation": "The following command lists the IAM groups in the current account:", + "output": { + "Groups": [ + { + "Path": "/division_abc/subdivision_xyz/", + "GroupName": "Admins", + "CreateDate": "2016-12-15T21:40:08.121Z", + "GroupId": "AGPA1111111111EXAMPLE", + "Arn": "arn:aws:iam::123456789012:group/Admins" + }, + { + "Path": "/division_abc/subdivision_xyz/product_1234/engineering/", + "GroupName": "Test", + "CreateDate": "2016-11-30T14:10:01.156Z", + "GroupId": "AGP22222222222EXAMPLE", + "Arn": "arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/engineering/Test" + }, + { + "Path": "/division_abc/subdivision_xyz/product_1234/", + "GroupName": "Managers", + "CreateDate": "2016-06-12T20:14:52.032Z", + "GroupId": "AGPI3333333333EXAMPLE", + "Arn": "arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/Managers" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Groups", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.iam#ListGroupsForUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#ListGroupsForUserRequest" + }, + "output": { + "target": "com.amazonaws.iam#ListGroupsForUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the IAM groups that the specified IAM user belongs to.

\n

You can paginate the results using the MaxItems and Marker\n parameters.

", + "smithy.api#examples": [ + { + "title": "To list the groups that an IAM user belongs to", + "documentation": "The following command displays the groups that the IAM user named Bob belongs to.", + "input": { + "UserName": "Bob" + }, + "output": { + "Groups": [ + { + "Path": "/division_abc/subdivision_xyz/product_1234/engineering/", + "GroupName": "Test", + "CreateDate": "2016-11-30T14:10:01.156Z", + "GroupId": "AGP2111111111EXAMPLE", + "Arn": "arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/engineering/Test" + }, + { + "Path": "/division_abc/subdivision_xyz/product_1234/", + "GroupName": "Managers", + "CreateDate": "2016-06-12T20:14:52.032Z", + "GroupId": "AGPI222222222SEXAMPLE", + "Arn": "arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/Managers" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Groups", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.iam#ListGroupsForUserRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#existingUserNameType", + "traits": { + "smithy.api#documentation": "

The name of the user to list groups for.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "Marker": { + "target": "com.amazonaws.iam#markerType", + "traits": { + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + } + }, + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#ListGroupsForUserResponse": { + "type": "structure", + "members": { + "Groups": { + "target": "com.amazonaws.iam#groupListType", + "traits": { + "smithy.api#documentation": "

A list of groups.

", + "smithy.api#required": {} + } + }, + "IsTruncated": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#responseMarkerType", + "traits": { + "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful ListGroupsForUser request.\n

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#ListGroupsRequest": { + "type": "structure", + "members": { + "PathPrefix": { + "target": "com.amazonaws.iam#pathPrefixType", + "traits": { + "smithy.api#documentation": "

The path prefix for filtering the results. For example, the prefix\n /division_abc/subdivision_xyz/ gets all groups whose path starts with\n /division_abc/subdivision_xyz/.

\n

This parameter is optional. If it is not included, it defaults to a slash (/), listing\n all groups. This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including \n most punctuation characters, digits, and upper and lowercased letters.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#markerType", + "traits": { + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + } + }, + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#ListGroupsResponse": { + "type": "structure", + "members": { + "Groups": { + "target": "com.amazonaws.iam#groupListType", + "traits": { + "smithy.api#documentation": "

A list of groups.

", + "smithy.api#required": {} + } + }, + "IsTruncated": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#responseMarkerType", + "traits": { + "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful ListGroups request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#ListInstanceProfileTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#ListInstanceProfileTagsRequest" + }, + "output": { + "target": "com.amazonaws.iam#ListInstanceProfileTagsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the tags that are attached to the specified IAM instance profile. The returned list of tags is sorted by tag key.\n For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Tags", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.iam#ListInstanceProfileTagsRequest": { + "type": "structure", + "members": { + "InstanceProfileName": { + "target": "com.amazonaws.iam#instanceProfileNameType", + "traits": { + "smithy.api#documentation": "

The name of the IAM instance profile whose tags you want to see.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "Marker": { + "target": "com.amazonaws.iam#markerType", + "traits": { + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + } + }, + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#ListInstanceProfileTagsResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.iam#tagListType", + "traits": { + "smithy.api#documentation": "

The list of tags that are currently attached to the IAM instance profile. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.

", + "smithy.api#required": {} + } + }, + "IsTruncated": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#responseMarkerType", + "traits": { + "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#ListInstanceProfiles": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#ListInstanceProfilesRequest" + }, + "output": { + "target": "com.amazonaws.iam#ListInstanceProfilesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the instance profiles that have the specified path prefix. If there are none,\n the operation returns an empty list. For more information about instance profiles, see\n Using\n instance profiles in the IAM User Guide.

\n \n

IAM resource-listing operations return a subset of the available \n attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for an instance profile, see GetInstanceProfile.

\n \n

You can paginate the results using the MaxItems and Marker\n parameters.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "InstanceProfiles", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.iam#ListInstanceProfilesForRole": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#ListInstanceProfilesForRoleRequest" + }, + "output": { + "target": "com.amazonaws.iam#ListInstanceProfilesForRoleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the instance profiles that have the specified associated IAM role. If there\n are none, the operation returns an empty list. For more information about instance\n profiles, go to Using\n instance profiles in the IAM User Guide.

\n

You can paginate the results using the MaxItems and Marker\n parameters.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "InstanceProfiles", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.iam#ListInstanceProfilesForRoleRequest": { + "type": "structure", + "members": { + "RoleName": { + "target": "com.amazonaws.iam#roleNameType", + "traits": { + "smithy.api#documentation": "

The name of the role to list instance profiles for.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "Marker": { + "target": "com.amazonaws.iam#markerType", + "traits": { + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + } + }, + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#ListInstanceProfilesForRoleResponse": { + "type": "structure", + "members": { + "InstanceProfiles": { + "target": "com.amazonaws.iam#instanceProfileListType", + "traits": { + "smithy.api#documentation": "

A list of instance profiles.

", + "smithy.api#required": {} + } + }, + "IsTruncated": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#responseMarkerType", + "traits": { + "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful ListInstanceProfilesForRole\n request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#ListInstanceProfilesRequest": { + "type": "structure", + "members": { + "PathPrefix": { + "target": "com.amazonaws.iam#pathPrefixType", + "traits": { + "smithy.api#documentation": "

The path prefix for filtering the results. For example, the prefix\n /application_abc/component_xyz/ gets all instance profiles whose path\n starts with /application_abc/component_xyz/.

\n

This parameter is optional. If it is not included, it defaults to a slash (/), listing\n all instance profiles. This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including \n most punctuation characters, digits, and upper and lowercased letters.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#markerType", + "traits": { + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + } + }, + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#ListInstanceProfilesResponse": { + "type": "structure", + "members": { + "InstanceProfiles": { + "target": "com.amazonaws.iam#instanceProfileListType", + "traits": { + "smithy.api#documentation": "

A list of instance profiles.

", + "smithy.api#required": {} + } + }, + "IsTruncated": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#responseMarkerType", + "traits": { + "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful ListInstanceProfiles request.\n

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#ListMFADeviceTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#ListMFADeviceTagsRequest" + }, + "output": { + "target": "com.amazonaws.iam#ListMFADeviceTagsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the tags that are attached to the specified IAM virtual multi-factor authentication (MFA) device. The returned list of tags is\n sorted by tag key. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Tags", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.iam#ListMFADeviceTagsRequest": { + "type": "structure", + "members": { + "SerialNumber": { + "target": "com.amazonaws.iam#serialNumberType", + "traits": { + "smithy.api#documentation": "

The unique identifier for the IAM virtual MFA device whose tags you want to see.\n For virtual MFA devices, the serial number is the same as the ARN.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "Marker": { + "target": "com.amazonaws.iam#markerType", + "traits": { + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + } + }, + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#ListMFADeviceTagsResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.iam#tagListType", + "traits": { + "smithy.api#documentation": "

The list of tags that are currently attached to the virtual MFA device. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.

", + "smithy.api#required": {} + } + }, + "IsTruncated": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#responseMarkerType", + "traits": { + "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#ListMFADevices": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#ListMFADevicesRequest" + }, + "output": { + "target": "com.amazonaws.iam#ListMFADevicesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the MFA devices for an IAM user. If the request includes a IAM user name,\n then this operation lists all the MFA devices associated with the specified user. If you\n do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services\n access key ID signing the request for this operation.

\n

You can paginate the results using the MaxItems and Marker\n parameters.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "MFADevices", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.iam#ListMFADevicesRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#existingUserNameType", + "traits": { + "smithy.api#documentation": "

The name of the user whose MFA devices you want to list.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#markerType", + "traits": { + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + } + }, + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#ListMFADevicesResponse": { + "type": "structure", + "members": { + "MFADevices": { + "target": "com.amazonaws.iam#mfaDeviceListType", + "traits": { + "smithy.api#documentation": "

A list of MFA devices.

", + "smithy.api#required": {} + } + }, + "IsTruncated": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#responseMarkerType", + "traits": { + "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful ListMFADevices request.\n

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#ListOpenIDConnectProviderTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#ListOpenIDConnectProviderTagsRequest" + }, + "output": { + "target": "com.amazonaws.iam#ListOpenIDConnectProviderTagsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the tags that are attached to the specified OpenID Connect (OIDC)-compatible\n identity provider. The returned list of tags is sorted by tag key. For more information, see About web identity\n federation.

\n

For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Tags", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.iam#ListOpenIDConnectProviderTagsRequest": { + "type": "structure", + "members": { + "OpenIDConnectProviderArn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The ARN of the OpenID Connect (OIDC) identity provider whose tags you want to\n see.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "Marker": { + "target": "com.amazonaws.iam#markerType", + "traits": { + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + } + }, + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#ListOpenIDConnectProviderTagsResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.iam#tagListType", + "traits": { + "smithy.api#documentation": "

The list of tags that are currently attached to the OpenID Connect (OIDC) identity\n provider. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.

", + "smithy.api#required": {} + } + }, + "IsTruncated": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#responseMarkerType", + "traits": { + "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#ListOpenIDConnectProviders": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#ListOpenIDConnectProvidersRequest" + }, + "output": { + "target": "com.amazonaws.iam#ListOpenIDConnectProvidersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists information about the IAM OpenID Connect (OIDC) provider resource objects\n defined in the Amazon Web Services account.

\n \n

IAM resource-listing operations return a subset of the available \n attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for an OIDC provider, see GetOpenIDConnectProvider.

\n " + } + }, + "com.amazonaws.iam#ListOpenIDConnectProvidersRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#ListOpenIDConnectProvidersResponse": { + "type": "structure", + "members": { + "OpenIDConnectProviderList": { + "target": "com.amazonaws.iam#OpenIDConnectProviderListType", + "traits": { + "smithy.api#documentation": "

The list of IAM OIDC provider resource objects defined in the Amazon Web Services account.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful ListOpenIDConnectProviders\n request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#ListOrganizationsFeatures": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#ListOrganizationsFeaturesRequest" + }, + "output": { + "target": "com.amazonaws.iam#ListOrganizationsFeaturesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#AccountNotManagementOrDelegatedAdministratorException" + }, + { + "target": "com.amazonaws.iam#OrganizationNotFoundException" + }, + { + "target": "com.amazonaws.iam#OrganizationNotInAllFeaturesModeException" + }, + { + "target": "com.amazonaws.iam#ServiceAccessNotEnabledException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the centralized root access features enabled for your organization. For more\n information, see Centrally manage root access for member accounts.

", + "smithy.api#examples": [ + { + "title": "To list the centralized root access features enabled for your organization", + "documentation": "he following command lists the centralized root access features enabled for your organization.", + "output": { + "OrganizationId": "o-aa111bb222", + "EnabledFeatures": [ + "RootCredentialsManagement" + ] + } + } + ] + } + }, + "com.amazonaws.iam#ListOrganizationsFeaturesRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#ListOrganizationsFeaturesResponse": { + "type": "structure", + "members": { + "OrganizationId": { + "target": "com.amazonaws.iam#OrganizationIdType", + "traits": { + "smithy.api#documentation": "

The unique identifier (ID) of an organization.

" + } + }, + "EnabledFeatures": { + "target": "com.amazonaws.iam#FeaturesListType", + "traits": { + "smithy.api#documentation": "

Specifies the features that are currently available in your organization.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#ListPolicies": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#ListPoliciesRequest" + }, + "output": { + "target": "com.amazonaws.iam#ListPoliciesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all the managed policies that are available in your Amazon Web Services account, including\n your own customer-defined managed policies and all Amazon Web Services managed policies.

\n

You can filter the list of policies that is returned using the optional\n OnlyAttached, Scope, and PathPrefix\n parameters. For example, to list only the customer managed policies in your Amazon Web Services\n account, set Scope to Local. To list only Amazon Web Services managed\n policies, set Scope to AWS.

\n

You can paginate the results using the MaxItems and Marker\n parameters.

\n

For more information about managed policies, see Managed policies and inline\n policies in the IAM User Guide.

\n \n

IAM resource-listing operations return a subset of the available \n attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a customer manged policy, see\n GetPolicy.

\n ", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Policies", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.iam#ListPoliciesGrantingServiceAccess": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#ListPoliciesGrantingServiceAccessRequest" + }, + "output": { + "target": "com.amazonaws.iam#ListPoliciesGrantingServiceAccessResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a list of policies that the IAM identity (user, group, or role) can use to\n access each specified service.

\n \n

This operation does not use other policy types when determining whether a resource\n could access a service. These other policy types include resource-based policies,\n access control lists, Organizations policies, IAM permissions boundaries, and STS\n assume role policies. It only applies permissions policy logic. For more about the\n evaluation of policy types, see Evaluating policies in the\n IAM User Guide.

\n \n

The list of policies returned by the operation depends on the ARN of the identity that\n you provide.

\n
    \n
  • \n

    \n User – The list of policies includes\n the managed and inline policies that are attached to the user directly. The list\n also includes any additional managed and inline policies that are attached to\n the group to which the user belongs.

    \n
    • \n
  • \n

    \n Group – The list of policies includes\n only the managed and inline policies that are attached to the group directly.\n Policies that are attached to the group’s user are not included.

    \n
    • \n
  • \n

    \n Role – The list of policies includes\n only the managed and inline policies that are attached to the role.

    \n
    • \n
\n

For each managed policy, this operation returns the ARN and policy name. For each\n inline policy, it returns the policy name and the entity to which it is attached. Inline\n policies do not have an ARN. For more information about these policy types, see Managed policies and inline policies in the\n IAM User Guide.

\n

Policies that are attached to users and roles as permissions boundaries are not\n returned. To view which managed policy is currently used to set the permissions boundary\n for a user or role, use the GetUser or GetRole\n operations.

", + "smithy.api#examples": [ + { + "title": "To list policies that allow access to a service", + "documentation": "The following operation lists policies that allow ExampleUser01 to access IAM or EC2.", + "input": { + "Arn": "arn:aws:iam::123456789012:user/ExampleUser01", + "ServiceNamespaces": [ + "iam", + "ec2" + ] + }, + "output": { + "IsTruncated": false, + "PoliciesGrantingServiceAccess": [ + { + "Policies": [ + { + "PolicyArn": "arn:aws:iam::123456789012:policy/ExampleIamPolicy", + "PolicyType": "MANAGED", + "PolicyName": "ExampleIamPolicy" + }, + { + "EntityName": "AWSExampleGroup1", + "EntityType": "GROUP", + "PolicyType": "INLINE", + "PolicyName": "ExampleGroup1Policy" + } + ], + "ServiceNamespace": "iam" + }, + { + "Policies": [ + { + "PolicyArn": "arn:aws:iam::123456789012:policy/ExampleEc2Policy", + "PolicyType": "MANAGED", + "PolicyName": "ExampleEc2Policy" + } + ], + "ServiceNamespace": "ec2" + } + ] + } + } + ] + } + }, + "com.amazonaws.iam#ListPoliciesGrantingServiceAccessEntry": { + "type": "structure", + "members": { + "ServiceNamespace": { + "target": "com.amazonaws.iam#serviceNamespaceType", + "traits": { + "smithy.api#documentation": "

The namespace of the service that was accessed.

\n

To learn the service namespace of a service, see Actions, resources, and condition keys for Amazon Web Services services in the\n Service Authorization Reference. Choose the name of the service to\n view details for that service. In the first paragraph, find the service prefix. For\n example, (service prefix: a4b). For more information about service namespaces,\n see Amazon Web Services\n service namespaces in the Amazon Web Services General Reference.

" + } + }, + "Policies": { + "target": "com.amazonaws.iam#policyGrantingServiceAccessListType", + "traits": { + "smithy.api#documentation": "

The PoliciesGrantingServiceAccess object that contains details about the\n policy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about the permissions policies that are attached to the specified\n identity (user, group, or role).

\n

This data type is used as a response element in the ListPoliciesGrantingServiceAccess operation.

" + } + }, + "com.amazonaws.iam#ListPoliciesGrantingServiceAccessRequest": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.iam#markerType", + "traits": { + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + } + }, + "Arn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM identity (user, group, or role) whose policies you want to\n list.

", + "smithy.api#required": {} + } + }, + "ServiceNamespaces": { + "target": "com.amazonaws.iam#serviceNamespaceListType", + "traits": { + "smithy.api#documentation": "

The service namespace for the Amazon Web Services services whose policies you want to list.

\n

To learn the service namespace for a service, see Actions, resources, and condition keys for Amazon Web Services services in the\n IAM User Guide. Choose the name of the service to view\n details for that service. In the first paragraph, find the service prefix. For example,\n (service prefix: a4b). For more information about service namespaces,\n see Amazon Web Services\n service namespaces in the Amazon Web Services General Reference.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#ListPoliciesGrantingServiceAccessResponse": { + "type": "structure", + "members": { + "PoliciesGrantingServiceAccess": { + "target": "com.amazonaws.iam#listPolicyGrantingServiceAccessResponseListType", + "traits": { + "smithy.api#documentation": "

A ListPoliciesGrantingServiceAccess object that contains details about\n the permissions policies attached to the specified identity (user, group, or\n role).

", + "smithy.api#required": {} + } + }, + "IsTruncated": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your results were\n truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. We recommend that you check\n IsTruncated after every call to ensure that you receive all your\n results.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#responseMarkerType", + "traits": { + "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#ListPoliciesRequest": { + "type": "structure", + "members": { + "Scope": { + "target": "com.amazonaws.iam#policyScopeType", + "traits": { + "smithy.api#documentation": "

The scope to use for filtering the results.

\n

To list only Amazon Web Services managed policies, set Scope to AWS. To\n list only the customer managed policies in your Amazon Web Services account, set Scope to\n Local.

\n

This parameter is optional. If it is not included, or if it is set to\n All, all policies are returned.

" + } + }, + "OnlyAttached": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag to filter the results to only the attached policies.

\n

When OnlyAttached is true, the returned list contains only\n the policies that are attached to an IAM user, group, or role. When\n OnlyAttached is false, or when the parameter is not\n included, all policies are returned.

" + } + }, + "PathPrefix": { + "target": "com.amazonaws.iam#policyPathType", + "traits": { + "smithy.api#documentation": "

The path prefix for filtering the results. This parameter is optional. If it is not\n included, it defaults to a slash (/), listing all policies. This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including \n most punctuation characters, digits, and upper and lowercased letters.

" + } + }, + "PolicyUsageFilter": { + "target": "com.amazonaws.iam#PolicyUsageType", + "traits": { + "smithy.api#documentation": "

The policy usage method to use for filtering the results.

\n

To list only permissions policies,\n set PolicyUsageFilter to PermissionsPolicy. To list only\n the policies used to set permissions boundaries, set the value\n to PermissionsBoundary.

\n

This parameter is optional. If it is not included, all policies are returned.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#markerType", + "traits": { + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + } + }, + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#ListPoliciesResponse": { + "type": "structure", + "members": { + "Policies": { + "target": "com.amazonaws.iam#policyListType", + "traits": { + "smithy.api#documentation": "

A list of policies.

" + } + }, + "IsTruncated": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#responseMarkerType", + "traits": { + "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful ListPolicies request.\n

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#ListPolicyTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#ListPolicyTagsRequest" + }, + "output": { + "target": "com.amazonaws.iam#ListPolicyTagsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the tags that are attached to the specified IAM customer managed policy.\n The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Tags", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.iam#ListPolicyTagsRequest": { + "type": "structure", + "members": { + "PolicyArn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM customer managed policy whose tags you want to see.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "Marker": { + "target": "com.amazonaws.iam#markerType", + "traits": { + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + } + }, + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#ListPolicyTagsResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.iam#tagListType", + "traits": { + "smithy.api#documentation": "

The list of tags that are currently attached to the IAM customer managed policy.\n Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.

", + "smithy.api#required": {} + } + }, + "IsTruncated": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#responseMarkerType", + "traits": { + "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#ListPolicyVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#ListPolicyVersionsRequest" + }, + "output": { + "target": "com.amazonaws.iam#ListPolicyVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists information about the versions of the specified managed policy, including the\n version that is currently set as the policy's default version.

\n

For more information about managed policies, see Managed policies and inline\n policies in the IAM User Guide.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Versions", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.iam#ListPolicyVersionsRequest": { + "type": "structure", + "members": { + "PolicyArn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM policy for which you want the\n versions.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

", + "smithy.api#required": {} + } + }, + "Marker": { + "target": "com.amazonaws.iam#markerType", + "traits": { + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + } + }, + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#ListPolicyVersionsResponse": { + "type": "structure", + "members": { + "Versions": { + "target": "com.amazonaws.iam#policyDocumentVersionListType", + "traits": { + "smithy.api#documentation": "

A list of policy versions.

\n

For more information about managed policy versions, see Versioning for managed\n policies in the IAM User Guide.

" + } + }, + "IsTruncated": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#responseMarkerType", + "traits": { + "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful ListPolicyVersions request.\n

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#ListRolePolicies": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#ListRolePoliciesRequest" + }, + "output": { + "target": "com.amazonaws.iam#ListRolePoliciesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the names of the inline policies that are embedded in the specified IAM\n role.

\n

An IAM role can also have managed policies attached to it. To list the managed\n policies that are attached to a role, use ListAttachedRolePolicies.\n For more information about policies, see Managed policies and inline\n policies in the IAM User Guide.

\n

You can paginate the results using the MaxItems and Marker\n parameters. If there are no inline policies embedded with the specified role, the\n operation returns an empty list.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "PolicyNames", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.iam#ListRolePoliciesRequest": { + "type": "structure", + "members": { + "RoleName": { + "target": "com.amazonaws.iam#roleNameType", + "traits": { + "smithy.api#documentation": "

The name of the role to list policies for.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "Marker": { + "target": "com.amazonaws.iam#markerType", + "traits": { + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + } + }, + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#ListRolePoliciesResponse": { + "type": "structure", + "members": { + "PolicyNames": { + "target": "com.amazonaws.iam#policyNameListType", + "traits": { + "smithy.api#documentation": "

A list of policy names.

", + "smithy.api#required": {} + } + }, + "IsTruncated": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#responseMarkerType", + "traits": { + "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful ListRolePolicies request.\n

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#ListRoleTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#ListRoleTagsRequest" + }, + "output": { + "target": "com.amazonaws.iam#ListRoleTagsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the tags that are attached to the specified role. The returned list of tags is\n sorted by tag key. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

", + "smithy.api#examples": [ + { + "title": "To list the tags attached to an IAM role", + "documentation": "The following example shows how to list the tags attached to a role.", + "input": { + "RoleName": "taggedrole1" + }, + "output": { + "Tags": [ + { + "Key": "Dept", + "Value": "12345" + }, + { + "Key": "Team", + "Value": "Accounting" + } + ], + "IsTruncated": false + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Tags", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.iam#ListRoleTagsRequest": { + "type": "structure", + "members": { + "RoleName": { + "target": "com.amazonaws.iam#roleNameType", + "traits": { + "smithy.api#documentation": "

The name of the IAM role for which you want to see the list of tags.

\n

This parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "Marker": { + "target": "com.amazonaws.iam#markerType", + "traits": { + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + } + }, + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#ListRoleTagsResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.iam#tagListType", + "traits": { + "smithy.api#documentation": "

The list of tags that are currently attached to the role. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.

", + "smithy.api#required": {} + } + }, + "IsTruncated": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#responseMarkerType", + "traits": { + "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#ListRoles": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#ListRolesRequest" + }, + "output": { + "target": "com.amazonaws.iam#ListRolesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the IAM roles that have the specified path prefix. If there are none, the\n operation returns an empty list. For more information about roles, see IAM roles in the\n IAM User Guide.

\n \n

IAM resource-listing operations return a subset of the available \n attributes for the resource. This operation does not return the following attributes, even though they are an attribute of the returned object:

\n
    \n
  • \n

    PermissionsBoundary

    \n
    • \n
  • \n

    RoleLastUsed

    \n
    • \n
  • \n

    Tags

    \n
    • \n
\n

To view all of the information for a role, see GetRole.

\n \n

You can paginate the results using the MaxItems and Marker\n parameters.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Roles", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.iam#ListRolesRequest": { + "type": "structure", + "members": { + "PathPrefix": { + "target": "com.amazonaws.iam#pathPrefixType", + "traits": { + "smithy.api#documentation": "

The path prefix for filtering the results. For example, the prefix\n /application_abc/component_xyz/ gets all roles whose path starts with\n /application_abc/component_xyz/.

\n

This parameter is optional. If it is not included, it defaults to a slash (/), listing\n all roles. This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including \n most punctuation characters, digits, and upper and lowercased letters.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#markerType", + "traits": { + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + } + }, + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#ListRolesResponse": { + "type": "structure", + "members": { + "Roles": { + "target": "com.amazonaws.iam#roleListType", + "traits": { + "smithy.api#documentation": "

A list of roles.

", + "smithy.api#required": {} + } + }, + "IsTruncated": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#responseMarkerType", + "traits": { + "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful ListRoles request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#ListSAMLProviderTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#ListSAMLProviderTagsRequest" + }, + "output": { + "target": "com.amazonaws.iam#ListSAMLProviderTagsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the tags that are attached to the specified Security Assertion Markup Language\n (SAML) identity provider. The returned list of tags is sorted by tag key. For more information, see About SAML 2.0-based\n federation.

\n

For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Tags", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.iam#ListSAMLProviderTagsRequest": { + "type": "structure", + "members": { + "SAMLProviderArn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The ARN of the Security Assertion Markup Language (SAML) identity provider whose tags\n you want to see.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "Marker": { + "target": "com.amazonaws.iam#markerType", + "traits": { + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + } + }, + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#ListSAMLProviderTagsResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.iam#tagListType", + "traits": { + "smithy.api#documentation": "

The list of tags that are currently attached to the Security Assertion Markup Language\n (SAML) identity provider. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.

", + "smithy.api#required": {} + } + }, + "IsTruncated": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#responseMarkerType", + "traits": { + "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#ListSAMLProviders": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#ListSAMLProvidersRequest" + }, + "output": { + "target": "com.amazonaws.iam#ListSAMLProvidersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the SAML provider resource objects defined in IAM in the account.\n IAM resource-listing operations return a subset of the available \n attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a SAML provider, see GetSAMLProvider.

\n \n

This operation requires Signature Version 4.

\n " + } + }, + "com.amazonaws.iam#ListSAMLProvidersRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#ListSAMLProvidersResponse": { + "type": "structure", + "members": { + "SAMLProviderList": { + "target": "com.amazonaws.iam#SAMLProviderListType", + "traits": { + "smithy.api#documentation": "

The list of SAML provider resource objects defined in IAM for this Amazon Web Services\n account.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful ListSAMLProviders request.\n

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#ListSSHPublicKeys": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#ListSSHPublicKeysRequest" + }, + "output": { + "target": "com.amazonaws.iam#ListSSHPublicKeysResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#NoSuchEntityException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about the SSH public keys associated with the specified IAM\n user. If none exists, the operation returns an empty list.

\n

The SSH public keys returned by this operation are used only for authenticating the\n IAM user to an CodeCommit repository. For more information about using SSH keys to\n authenticate to an CodeCommit repository, see Set up CodeCommit for\n SSH connections in the CodeCommit User Guide.

\n

Although each user is limited to a small number of keys, you can still paginate the\n results using the MaxItems and Marker parameters.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "SSHPublicKeys", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.iam#ListSSHPublicKeysRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#userNameType", + "traits": { + "smithy.api#documentation": "

The name of the IAM user to list SSH public keys for. If none is specified, the\n UserName field is determined implicitly based on the Amazon Web Services access key\n used to sign the request.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#markerType", + "traits": { + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + } + }, + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#ListSSHPublicKeysResponse": { + "type": "structure", + "members": { + "SSHPublicKeys": { + "target": "com.amazonaws.iam#SSHPublicKeyListType", + "traits": { + "smithy.api#documentation": "

A list of the SSH public keys assigned to IAM user.

" + } + }, + "IsTruncated": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#responseMarkerType", + "traits": { + "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful ListSSHPublicKeys\n request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#ListServerCertificateTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#ListServerCertificateTagsRequest" + }, + "output": { + "target": "com.amazonaws.iam#ListServerCertificateTagsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the tags that are attached to the specified IAM server certificate. The\n returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

\n \n

For certificates in a Region supported by Certificate Manager (ACM), we\n recommend that you don't use IAM server certificates. Instead, use ACM to provision,\n manage, and deploy your server certificates. For more information about IAM server\n certificates, Working with server\n certificates in the IAM User Guide.

\n ", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Tags", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.iam#ListServerCertificateTagsRequest": { + "type": "structure", + "members": { + "ServerCertificateName": { + "target": "com.amazonaws.iam#serverCertificateNameType", + "traits": { + "smithy.api#documentation": "

The name of the IAM server certificate whose tags you want to see.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "Marker": { + "target": "com.amazonaws.iam#markerType", + "traits": { + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + } + }, + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#ListServerCertificateTagsResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.iam#tagListType", + "traits": { + "smithy.api#documentation": "

The list of tags that are currently attached to the IAM server certificate.\n Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.

", + "smithy.api#required": {} + } + }, + "IsTruncated": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#responseMarkerType", + "traits": { + "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#ListServerCertificates": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#ListServerCertificatesRequest" + }, + "output": { + "target": "com.amazonaws.iam#ListServerCertificatesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the server certificates stored in IAM that have the specified path prefix. If\n none exist, the operation returns an empty list.

\n

You can paginate the results using the MaxItems and Marker\n parameters.

\n

For more information about working with server certificates, see Working\n with server certificates in the IAM User Guide. This\n topic also includes a list of Amazon Web Services services that can use the server certificates that\n you manage with IAM.

\n \n

IAM resource-listing operations return a subset of the available \n attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a servercertificate, see GetServerCertificate.

\n ", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "ServerCertificateMetadataList", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.iam#ListServerCertificatesRequest": { + "type": "structure", + "members": { + "PathPrefix": { + "target": "com.amazonaws.iam#pathPrefixType", + "traits": { + "smithy.api#documentation": "

The path prefix for filtering the results. For example:\n /company/servercerts would get all server certificates for which the\n path starts with /company/servercerts.

\n

This parameter is optional. If it is not included, it defaults to a slash (/), listing\n all server certificates. This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including \n most punctuation characters, digits, and upper and lowercased letters.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#markerType", + "traits": { + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + } + }, + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#ListServerCertificatesResponse": { + "type": "structure", + "members": { + "ServerCertificateMetadataList": { + "target": "com.amazonaws.iam#serverCertificateMetadataListType", + "traits": { + "smithy.api#documentation": "

A list of server certificates.

", + "smithy.api#required": {} + } + }, + "IsTruncated": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#responseMarkerType", + "traits": { + "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful ListServerCertificates request.\n

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#ListServiceSpecificCredentials": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#ListServiceSpecificCredentialsRequest" + }, + "output": { + "target": "com.amazonaws.iam#ListServiceSpecificCredentialsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceNotSupportedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about the service-specific credentials associated with the\n specified IAM user. If none exists, the operation returns an empty list. The\n service-specific credentials returned by this operation are used only for authenticating\n the IAM user to a specific service. For more information about using service-specific\n credentials to authenticate to an Amazon Web Services service, see Set up service-specific credentials\n in the CodeCommit User Guide.

" + } + }, + "com.amazonaws.iam#ListServiceSpecificCredentialsRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#userNameType", + "traits": { + "smithy.api#documentation": "

The name of the user whose service-specific credentials you want information about. If\n this value is not specified, then the operation assumes the user whose credentials are\n used to call the operation.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } + }, + "ServiceName": { + "target": "com.amazonaws.iam#serviceName", + "traits": { + "smithy.api#documentation": "

Filters the returned results to only those for the specified Amazon Web Services service. If not\n specified, then Amazon Web Services returns service-specific credentials for all services.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#ListServiceSpecificCredentialsResponse": { + "type": "structure", + "members": { + "ServiceSpecificCredentials": { + "target": "com.amazonaws.iam#ServiceSpecificCredentialsListType", + "traits": { + "smithy.api#documentation": "

A list of structures that each contain details about a service-specific\n credential.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#ListSigningCertificates": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#ListSigningCertificatesRequest" + }, + "output": { + "target": "com.amazonaws.iam#ListSigningCertificatesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about the signing certificates associated with the specified IAM\n user. If none exists, the operation returns an empty list.

\n

Although each user is limited to a small number of signing certificates, you can still\n paginate the results using the MaxItems and Marker\n parameters.

\n

If the UserName field is not specified, the user name is determined\n implicitly based on the Amazon Web Services access key ID used to sign the request for this operation.\n This operation works for access keys under the Amazon Web Services account. Consequently, you can use\n this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no\n associated users.

", + "smithy.api#examples": [ + { + "title": "To list the signing certificates for an IAM user", + "documentation": "The following command lists the signing certificates for the IAM user named Bob.", + "input": { + "UserName": "Bob" + }, + "output": { + "Certificates": [ + { + "UserName": "Bob", + "Status": "Active", + "CertificateBody": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", + "CertificateId": "TA7SMP42TDN5Z26OBPJE7EXAMPLE", + "UploadDate": "2013-06-06T21:40:08Z" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Certificates", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.iam#ListSigningCertificatesRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#existingUserNameType", + "traits": { + "smithy.api#documentation": "

The name of the IAM user whose signing certificates you want to examine.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#markerType", + "traits": { + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + } + }, + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#ListSigningCertificatesResponse": { + "type": "structure", + "members": { + "Certificates": { + "target": "com.amazonaws.iam#certificateListType", + "traits": { + "smithy.api#documentation": "

A list of the user's signing certificate information.

", + "smithy.api#required": {} + } + }, + "IsTruncated": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#responseMarkerType", + "traits": { + "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful ListSigningCertificates\n request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#ListUserPolicies": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#ListUserPoliciesRequest" + }, + "output": { + "target": "com.amazonaws.iam#ListUserPoliciesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the names of the inline policies embedded in the specified IAM user.

\n

An IAM user can also have managed policies attached to it. To list the managed\n policies that are attached to a user, use ListAttachedUserPolicies.\n For more information about policies, see Managed policies and inline\n policies in the IAM User Guide.

\n

You can paginate the results using the MaxItems and Marker\n parameters. If there are no inline policies embedded with the specified user, the\n operation returns an empty list.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "PolicyNames", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.iam#ListUserPoliciesRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#existingUserNameType", + "traits": { + "smithy.api#documentation": "

The name of the user to list policies for.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "Marker": { + "target": "com.amazonaws.iam#markerType", + "traits": { + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + } + }, + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#ListUserPoliciesResponse": { + "type": "structure", + "members": { + "PolicyNames": { + "target": "com.amazonaws.iam#policyNameListType", + "traits": { + "smithy.api#documentation": "

A list of policy names.

", + "smithy.api#required": {} + } + }, + "IsTruncated": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#responseMarkerType", + "traits": { + "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful ListUserPolicies request.\n

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#ListUserTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#ListUserTagsRequest" + }, + "output": { + "target": "com.amazonaws.iam#ListUserTagsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the tags that are attached to the specified IAM user. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

", + "smithy.api#examples": [ + { + "title": "To list the tags attached to an IAM user", + "documentation": "The following example shows how to list the tags attached to a user.", + "input": { + "UserName": "anika" + }, + "output": { + "Tags": [ + { + "Key": "Dept", + "Value": "12345" + }, + { + "Key": "Team", + "Value": "Accounting" + } + ], + "IsTruncated": false + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Tags", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.iam#ListUserTagsRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#existingUserNameType", + "traits": { + "smithy.api#documentation": "

The name of the IAM user whose tags you want to see.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "Marker": { + "target": "com.amazonaws.iam#markerType", + "traits": { + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + } + }, + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#ListUserTagsResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.iam#tagListType", + "traits": { + "smithy.api#documentation": "

The list of tags that are currently attached to the user. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.

", + "smithy.api#required": {} + } + }, + "IsTruncated": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#responseMarkerType", + "traits": { + "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#ListUsers": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#ListUsersRequest" + }, + "output": { + "target": "com.amazonaws.iam#ListUsersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the IAM users that have the specified path prefix. If no path prefix is\n specified, the operation returns all users in the Amazon Web Services account. If there are none, the\n operation returns an empty list.

\n \n

IAM resource-listing operations return a subset of the available \n attributes for the resource. This operation does not return the following attributes, even though they are an attribute of the returned object:

\n
    \n
  • \n

    PermissionsBoundary

    \n
    • \n
  • \n

    Tags

    \n
    • \n
\n

To view all of the information for a user, see GetUser.

\n \n

You can paginate the results using the MaxItems and Marker\n parameters.

", + "smithy.api#examples": [ + { + "title": "To list IAM users", + "documentation": "The following command lists the IAM users in the current account.", + "output": { + "Users": [ + { + "UserId": "AID2MAB8DPLSRHEXAMPLE", + "Path": "/division_abc/subdivision_xyz/engineering/", + "UserName": "Juan", + "Arn": "arn:aws:iam::123456789012:user/division_abc/subdivision_xyz/engineering/Juan", + "CreateDate": "2012-09-05T19:38:48Z", + "PasswordLastUsed": "2016-09-08T21:47:36Z" + }, + { + "UserId": "AIDIODR4TAW7CSEXAMPLE", + "Path": "/division_abc/subdivision_xyz/engineering/", + "UserName": "Anika", + "Arn": "arn:aws:iam::123456789012:user/division_abc/subdivision_xyz/engineering/Anika", + "CreateDate": "2014-04-09T15:43:45Z", + "PasswordLastUsed": "2016-09-24T16:18:07Z" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Users", + "pageSize": "MaxItems" + }, + "smithy.test#smokeTests": [ + { + "id": "ListUsersSuccess", + "params": {}, + "vendorParams": { + "region": "us-east-1" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "success": {} + } + } + ] + } + }, + "com.amazonaws.iam#ListUsersRequest": { + "type": "structure", + "members": { + "PathPrefix": { + "target": "com.amazonaws.iam#pathPrefixType", + "traits": { + "smithy.api#documentation": "

The path prefix for filtering the results. For example:\n /division_abc/subdivision_xyz/, which would get all user names whose\n path starts with /division_abc/subdivision_xyz/.

\n

This parameter is optional. If it is not included, it defaults to a slash (/), listing\n all user names. This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including \n most punctuation characters, digits, and upper and lowercased letters.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#markerType", + "traits": { + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + } + }, + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#ListUsersResponse": { + "type": "structure", + "members": { + "Users": { + "target": "com.amazonaws.iam#userListType", + "traits": { + "smithy.api#documentation": "

A list of users.

", + "smithy.api#required": {} + } + }, + "IsTruncated": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#responseMarkerType", + "traits": { + "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful ListUsers request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#ListVirtualMFADevices": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#ListVirtualMFADevicesRequest" + }, + "output": { + "target": "com.amazonaws.iam#ListVirtualMFADevicesResponse" + }, + "traits": { + "smithy.api#documentation": "

Lists the virtual MFA devices defined in the Amazon Web Services account by assignment status. If\n you do not specify an assignment status, the operation returns a list of all virtual MFA\n devices. Assignment status can be Assigned, Unassigned, or\n Any.

\n \n

IAM resource-listing operations return a subset of the available \n attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view tag information for a virtual MFA device, see ListMFADeviceTags.

\n \n

You can paginate the results using the MaxItems and Marker\n parameters.

", + "smithy.api#examples": [ + { + "title": "To list virtual MFA devices", + "documentation": "The following command lists the virtual MFA devices that have been configured for the current account.", + "output": { + "VirtualMFADevices": [ + { + "SerialNumber": "arn:aws:iam::123456789012:mfa/ExampleMFADevice" + }, + { + "SerialNumber": "arn:aws:iam::123456789012:mfa/Juan" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "VirtualMFADevices", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.iam#ListVirtualMFADevicesRequest": { + "type": "structure", + "members": { + "AssignmentStatus": { + "target": "com.amazonaws.iam#assignmentStatusType", + "traits": { + "smithy.api#documentation": "

The status (Unassigned or Assigned) of the devices to list.\n If you do not specify an AssignmentStatus, the operation defaults to\n Any, which lists both assigned and unassigned virtual MFA\n devices.,

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#markerType", + "traits": { + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + } + }, + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#ListVirtualMFADevicesResponse": { + "type": "structure", + "members": { + "VirtualMFADevices": { + "target": "com.amazonaws.iam#virtualMFADeviceListType", + "traits": { + "smithy.api#documentation": "

The list of virtual MFA devices in the current account that match the\n AssignmentStatus value that was passed in the request.

", + "smithy.api#required": {} + } + }, + "IsTruncated": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#responseMarkerType", + "traits": { + "smithy.api#documentation": "

When IsTruncated is true, this element is present and\n contains the value to use for the Marker parameter in a subsequent\n pagination request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful ListVirtualMFADevices request.\n

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#LoginProfile": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#userNameType", + "traits": { + "smithy.api#documentation": "

The name of the user, which can be used for signing in to the Amazon Web Services Management Console.

", + "smithy.api#required": {} + } + }, + "CreateDate": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date when the password for the user was created.

", + "smithy.api#required": {} + } + }, + "PasswordResetRequired": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether the user is required to set a new password on next sign-in.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the user name and password create date for a user.

\n

This data type is used as a response element in the CreateLoginProfile and GetLoginProfile operations.

" + } + }, + "com.amazonaws.iam#MFADevice": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#userNameType", + "traits": { + "smithy.api#documentation": "

The user with whom the MFA device is associated.

", + "smithy.api#required": {} + } + }, + "SerialNumber": { + "target": "com.amazonaws.iam#serialNumberType", + "traits": { + "smithy.api#documentation": "

The serial number that uniquely identifies the MFA device. For virtual MFA devices, the\n serial number is the device ARN.

", + "smithy.api#required": {} + } + }, + "EnableDate": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date when the MFA device was enabled for the user.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about an MFA device.

\n

This data type is used as a response element in the ListMFADevices\n operation.

" + } + }, + "com.amazonaws.iam#MalformedCertificateException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iam#malformedCertificateMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "MalformedCertificate", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request was rejected because the certificate was malformed or expired. The error\n message describes the specific error.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.iam#MalformedPolicyDocumentException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iam#malformedPolicyDocumentMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "MalformedPolicyDocument", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request was rejected because the policy document was malformed. The error message\n describes the specific error.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.iam#ManagedPolicyDetail": { + "type": "structure", + "members": { + "PolicyName": { + "target": "com.amazonaws.iam#policyNameType", + "traits": { + "smithy.api#documentation": "

The friendly name (not ARN) identifying the policy.

" + } + }, + "PolicyId": { + "target": "com.amazonaws.iam#idType", + "traits": { + "smithy.api#documentation": "

The stable and unique string identifying the policy.

\n

For more information about IDs, see IAM identifiers in the\n IAM User Guide.

" + } + }, + "Arn": { + "target": "com.amazonaws.iam#arnType" + }, + "Path": { + "target": "com.amazonaws.iam#policyPathType", + "traits": { + "smithy.api#documentation": "

The path to the policy.

\n

For more information about paths, see IAM identifiers in the\n IAM User Guide.

" + } + }, + "DefaultVersionId": { + "target": "com.amazonaws.iam#policyVersionIdType", + "traits": { + "smithy.api#documentation": "

The identifier for the version of the policy that is set as the default (operative)\n version.

\n

For more information about policy versions, see Versioning for managed\n policies in the IAM User Guide.

" + } + }, + "AttachmentCount": { + "target": "com.amazonaws.iam#attachmentCountType", + "traits": { + "smithy.api#documentation": "

The number of principal entities (users, groups, and roles) that the policy is attached\n to.

" + } + }, + "PermissionsBoundaryUsageCount": { + "target": "com.amazonaws.iam#attachmentCountType", + "traits": { + "smithy.api#documentation": "

The number of entities (users and roles) for which the policy is used as the permissions\n boundary.

\n

For more information about permissions boundaries, see Permissions boundaries for IAM\n identities in the IAM User Guide.

" + } + }, + "IsAttachable": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether the policy can be attached to an IAM user, group, or role.

" + } + }, + "Description": { + "target": "com.amazonaws.iam#policyDescriptionType", + "traits": { + "smithy.api#documentation": "

A friendly description of the policy.

" + } + }, + "CreateDate": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the policy was created.

" + } + }, + "UpdateDate": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the policy was last updated.

\n

When a policy has only one version, this field contains the date and time when the\n policy was created. When a policy has more than one version, this field contains the date\n and time when the most recent policy version was created.

" + } + }, + "PolicyVersionList": { + "target": "com.amazonaws.iam#policyDocumentVersionListType", + "traits": { + "smithy.api#documentation": "

A list containing information about the versions of the policy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a managed policy, including the policy's ARN, versions, and\n the number of principal entities (users, groups, and roles) that the policy is attached\n to.

\n

This data type is used as a response element in the GetAccountAuthorizationDetails operation.

\n

For more information about managed policies, see Managed policies and inline\n policies in the IAM User Guide.

" + } + }, + "com.amazonaws.iam#ManagedPolicyDetailListType": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#ManagedPolicyDetail" + } + }, + "com.amazonaws.iam#NoSuchEntityException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iam#noSuchEntityMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "NoSuchEntity", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The request was rejected because it referenced a resource entity that does not exist. The\n error message describes the resource.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.iam#OpenIDConnectProviderListEntry": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.iam#arnType" + } + }, + "traits": { + "smithy.api#documentation": "

Contains the Amazon Resource Name (ARN) for an IAM OpenID Connect provider.

" + } + }, + "com.amazonaws.iam#OpenIDConnectProviderListType": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#OpenIDConnectProviderListEntry" + }, + "traits": { + "smithy.api#documentation": "

Contains a list of IAM OpenID Connect providers.

" + } + }, + "com.amazonaws.iam#OpenIDConnectProviderUrlType": { + "type": "string", + "traits": { + "smithy.api#documentation": "

Contains a URL that specifies the endpoint for an OpenID Connect provider.

", + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.iam#OpenIdIdpCommunicationErrorException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iam#openIdIdpCommunicationErrorExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "OpenIdIdpCommunicationError", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request failed because IAM cannot connect to the OpenID Connect identity provider\n URL.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.iam#OrganizationIdType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 34 + }, + "smithy.api#pattern": "^o-[a-z0-9]{10,32}$" + } + }, + "com.amazonaws.iam#OrganizationNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.iam#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The request was rejected because no organization is associated with your account.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.iam#OrganizationNotInAllFeaturesModeException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.iam#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The request was rejected because your organization does not have All features enabled. For\n more information, see Available feature sets in the Organizations User\n Guide.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.iam#OrganizationsDecisionDetail": { + "type": "structure", + "members": { + "AllowedByOrganizations": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether the simulated operation is allowed by the Organizations service control\n policies that impact the simulated user's account.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the effect that Organizations has on a policy simulation.

" + } + }, + "com.amazonaws.iam#PasswordPolicy": { + "type": "structure", + "members": { + "MinimumPasswordLength": { + "target": "com.amazonaws.iam#minimumPasswordLengthType", + "traits": { + "smithy.api#documentation": "

Minimum length to require for IAM user passwords.

" + } + }, + "RequireSymbols": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether IAM user passwords must contain at least one of the following\n symbols:

\n

! @ # $ % ^ & * ( ) _ + - = [ ] { } | '

" + } + }, + "RequireNumbers": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether IAM user passwords must contain at least one numeric character (0 to\n 9).

" + } + }, + "RequireUppercaseCharacters": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether IAM user passwords must contain at least one uppercase character (A\n to Z).

" + } + }, + "RequireLowercaseCharacters": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether IAM user passwords must contain at least one lowercase character (a\n to z).

" + } + }, + "AllowUsersToChangePassword": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether IAM users are allowed to change their own password. Gives IAM\n users permissions to iam:ChangePassword for only their user and to the\n iam:GetAccountPasswordPolicy action. This option does not attach a\n permissions policy to each user, rather the permissions are applied at the account-level\n for all users by IAM.

" + } + }, + "ExpirePasswords": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether passwords in the account expire. Returns true if\n MaxPasswordAge contains a value greater than 0. Returns false if\n MaxPasswordAge is 0 or not present.

" + } + }, + "MaxPasswordAge": { + "target": "com.amazonaws.iam#maxPasswordAgeType", + "traits": { + "smithy.api#documentation": "

The number of days that an IAM user password is valid.

" + } + }, + "PasswordReusePrevention": { + "target": "com.amazonaws.iam#passwordReusePreventionType", + "traits": { + "smithy.api#documentation": "

Specifies the number of previous passwords that IAM users are prevented from\n reusing.

" + } + }, + "HardExpiry": { + "target": "com.amazonaws.iam#booleanObjectType", + "traits": { + "smithy.api#documentation": "

Specifies whether IAM users are prevented from setting a new password via the\n Amazon Web Services Management Console after their password has expired. The IAM user cannot access the console until\n an administrator resets the password. IAM users with iam:ChangePassword\n permission and active access keys can reset their own expired console password using the\n CLI or API.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the account password policy.

\n

This data type is used as a response element in the GetAccountPasswordPolicy operation.

" + } + }, + "com.amazonaws.iam#PasswordPolicyViolationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iam#passwordPolicyViolationMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "PasswordPolicyViolation", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request was rejected because the provided password did not meet the requirements\n imposed by the account password policy.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.iam#PermissionsBoundaryAttachmentType": { + "type": "enum", + "members": { + "Policy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PermissionsBoundaryPolicy" + } + } + } + }, + "com.amazonaws.iam#PermissionsBoundaryDecisionDetail": { + "type": "structure", + "members": { + "AllowedByPermissionsBoundary": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether an action is allowed by a permissions boundary that is applied to an\n IAM entity (user or role). A value of true means that the permissions\n boundary does not deny the action. This means that the policy includes an\n Allow statement that matches the request. In this case, if an\n identity-based policy also allows the action, the request is allowed. A value of\n false means that either the requested action is not allowed (implicitly\n denied) or that the action is explicitly denied by the permissions boundary. In both of\n these cases, the action is not allowed, regardless of the identity-based policy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the effect that a permissions boundary has on a policy\n simulation when the boundary is applied to an IAM entity.

" + } + }, + "com.amazonaws.iam#Policy": { + "type": "structure", + "members": { + "PolicyName": { + "target": "com.amazonaws.iam#policyNameType", + "traits": { + "smithy.api#documentation": "

The friendly name (not ARN) identifying the policy.

" + } + }, + "PolicyId": { + "target": "com.amazonaws.iam#idType", + "traits": { + "smithy.api#documentation": "

The stable and unique string identifying the policy.

\n

For more information about IDs, see IAM identifiers in the\n IAM User Guide.

" + } + }, + "Arn": { + "target": "com.amazonaws.iam#arnType" + }, + "Path": { + "target": "com.amazonaws.iam#policyPathType", + "traits": { + "smithy.api#documentation": "

The path to the policy.

\n

For more information about paths, see IAM identifiers in the\n IAM User Guide.

" + } + }, + "DefaultVersionId": { + "target": "com.amazonaws.iam#policyVersionIdType", + "traits": { + "smithy.api#documentation": "

The identifier for the version of the policy that is set as the default version.

" + } + }, + "AttachmentCount": { + "target": "com.amazonaws.iam#attachmentCountType", + "traits": { + "smithy.api#documentation": "

The number of entities (users, groups, and roles) that the policy is attached to.

" + } + }, + "PermissionsBoundaryUsageCount": { + "target": "com.amazonaws.iam#attachmentCountType", + "traits": { + "smithy.api#documentation": "

The number of entities (users and roles) for which the policy is used to set the\n permissions boundary.

\n

For more information about permissions boundaries, see Permissions boundaries for IAM\n identities in the IAM User Guide.

" + } + }, + "IsAttachable": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether the policy can be attached to an IAM user, group, or role.

" + } + }, + "Description": { + "target": "com.amazonaws.iam#policyDescriptionType", + "traits": { + "smithy.api#documentation": "

A friendly description of the policy.

\n

This element is included in the response to the GetPolicy operation.\n It is not included in the response to the ListPolicies operation.

" + } + }, + "CreateDate": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the policy was created.

" + } + }, + "UpdateDate": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the policy was last updated.

\n

When a policy has only one version, this field contains the date and time when the\n policy was created. When a policy has more than one version, this field contains the date\n and time when the most recent policy version was created.

" + } + }, + "Tags": { + "target": "com.amazonaws.iam#tagListType", + "traits": { + "smithy.api#documentation": "

A list of tags that are attached to the instance profile. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a managed policy.

\n

This data type is used as a response element in the CreatePolicy,\n GetPolicy, and ListPolicies operations.

\n

For more information about managed policies, refer to Managed policies and inline\n policies in the IAM User Guide.

" + } + }, + "com.amazonaws.iam#PolicyDetail": { + "type": "structure", + "members": { + "PolicyName": { + "target": "com.amazonaws.iam#policyNameType", + "traits": { + "smithy.api#documentation": "

The name of the policy.

" + } + }, + "PolicyDocument": { + "target": "com.amazonaws.iam#policyDocumentType", + "traits": { + "smithy.api#documentation": "

The policy document.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about an IAM policy, including the policy document.

\n

This data type is used as a response element in the GetAccountAuthorizationDetails operation.

" + } + }, + "com.amazonaws.iam#PolicyEvaluationDecisionType": { + "type": "enum", + "members": { + "ALLOWED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "allowed" + } + }, + "EXPLICIT_DENY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "explicitDeny" + } + }, + "IMPLICIT_DENY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "implicitDeny" + } + } + } + }, + "com.amazonaws.iam#PolicyEvaluationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iam#policyEvaluationErrorMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "PolicyEvaluation", + "httpResponseCode": 500 + }, + "smithy.api#documentation": "

The request failed because a provided policy could not be successfully evaluated. An\n additional detailed message indicates the source of the failure.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.iam#PolicyGrantingServiceAccess": { + "type": "structure", + "members": { + "PolicyName": { + "target": "com.amazonaws.iam#policyNameType", + "traits": { + "smithy.api#documentation": "

The policy name.

", + "smithy.api#required": {} + } + }, + "PolicyType": { + "target": "com.amazonaws.iam#policyType", + "traits": { + "smithy.api#documentation": "

The policy type. For more information about these policy types, see Managed\n policies and inline policies in the\n IAM User Guide.

", + "smithy.api#required": {} + } + }, + "PolicyArn": { + "target": "com.amazonaws.iam#arnType" + }, + "EntityType": { + "target": "com.amazonaws.iam#policyOwnerEntityType", + "traits": { + "smithy.api#documentation": "

The type of entity (user or role) that used the policy to access the service to which\n the inline policy is attached.

\n

This field is null for managed policies. For more information about these policy types,\n see Managed policies and inline policies in the\n IAM User Guide.

" + } + }, + "EntityName": { + "target": "com.amazonaws.iam#entityNameType", + "traits": { + "smithy.api#documentation": "

The name of the entity (user or role) to which the inline policy is attached.

\n

This field is null for managed policies. For more information about these policy types,\n see Managed policies and inline policies in the\n IAM User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about the permissions policies that are attached to the specified\n identity (user, group, or role).

\n

This data type is an element of the ListPoliciesGrantingServiceAccessEntry object.

" + } + }, + "com.amazonaws.iam#PolicyGroup": { + "type": "structure", + "members": { + "GroupName": { + "target": "com.amazonaws.iam#groupNameType", + "traits": { + "smithy.api#documentation": "

The name (friendly name, not ARN) identifying the group.

" + } + }, + "GroupId": { + "target": "com.amazonaws.iam#idType", + "traits": { + "smithy.api#documentation": "

The stable and unique string identifying the group. For more information about IDs, see\n IAM\n identifiers in the IAM User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a group that a managed policy is attached to.

\n

This data type is used as a response element in the ListEntitiesForPolicy operation.

\n

For more information about managed policies, refer to Managed policies and inline\n policies in the IAM User Guide.

" + } + }, + "com.amazonaws.iam#PolicyGroupListType": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#PolicyGroup" + } + }, + "com.amazonaws.iam#PolicyIdentifierType": { + "type": "string" + }, + "com.amazonaws.iam#PolicyNotAttachableException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iam#policyNotAttachableMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "PolicyNotAttachable", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request failed because Amazon Web Services service role policies can only be attached to the\n service-linked role for that service.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.iam#PolicyRole": { + "type": "structure", + "members": { + "RoleName": { + "target": "com.amazonaws.iam#roleNameType", + "traits": { + "smithy.api#documentation": "

The name (friendly name, not ARN) identifying the role.

" + } + }, + "RoleId": { + "target": "com.amazonaws.iam#idType", + "traits": { + "smithy.api#documentation": "

The stable and unique string identifying the role. For more information about IDs, see\n IAM\n identifiers in the IAM User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a role that a managed policy is attached to.

\n

This data type is used as a response element in the ListEntitiesForPolicy operation.

\n

For more information about managed policies, refer to Managed policies and inline\n policies in the IAM User Guide.

" + } + }, + "com.amazonaws.iam#PolicyRoleListType": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#PolicyRole" + } + }, + "com.amazonaws.iam#PolicySourceType": { + "type": "enum", + "members": { + "USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "user" + } + }, + "GROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "group" + } + }, + "ROLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "role" + } + }, + "AWS_MANAGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "aws-managed" + } + }, + "USER_MANAGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "user-managed" + } + }, + "RESOURCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "resource" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "none" + } + } + } + }, + "com.amazonaws.iam#PolicyUsageType": { + "type": "enum", + "members": { + "PermissionsPolicy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PermissionsPolicy" + } + }, + "PermissionsBoundary": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PermissionsBoundary" + } + } + }, + "traits": { + "smithy.api#documentation": "

The policy usage type that indicates whether the policy is used as a permissions policy\n or as the permissions boundary for an entity.

\n

For more information about permissions boundaries, see Permissions boundaries for IAM\n identities in the IAM User Guide.

" + } + }, + "com.amazonaws.iam#PolicyUser": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#userNameType", + "traits": { + "smithy.api#documentation": "

The name (friendly name, not ARN) identifying the user.

" + } + }, + "UserId": { + "target": "com.amazonaws.iam#idType", + "traits": { + "smithy.api#documentation": "

The stable and unique string identifying the user. For more information about IDs, see\n IAM\n identifiers in the IAM User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a user that a managed policy is attached to.

\n

This data type is used as a response element in the ListEntitiesForPolicy operation.

\n

For more information about managed policies, refer to Managed policies and inline\n policies in the IAM User Guide.

" + } + }, + "com.amazonaws.iam#PolicyUserListType": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#PolicyUser" + } + }, + "com.amazonaws.iam#PolicyVersion": { + "type": "structure", + "members": { + "Document": { + "target": "com.amazonaws.iam#policyDocumentType", + "traits": { + "smithy.api#documentation": "

The policy document.

\n

The policy document is returned in the response to the GetPolicyVersion and GetAccountAuthorizationDetails operations. It is not returned in\n the response to the CreatePolicyVersion or ListPolicyVersions operations.

\n

The policy document returned in this structure is URL-encoded compliant with RFC 3986. You can use a URL decoding\n method to convert the policy back to plain JSON text. For example, if you use Java, you can\n use the decode method of the java.net.URLDecoder utility class in\n the Java SDK. Other languages and SDKs provide similar functionality.

" + } + }, + "VersionId": { + "target": "com.amazonaws.iam#policyVersionIdType", + "traits": { + "smithy.api#documentation": "

The identifier for the policy version.

\n

Policy version identifiers always begin with v (always lowercase). When a\n policy is created, the first policy version is v1.

" + } + }, + "IsDefaultVersion": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether the policy version is set as the policy's default version.

" + } + }, + "CreateDate": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the policy version was created.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a version of a managed policy.

\n

This data type is used as a response element in the CreatePolicyVersion, GetPolicyVersion, ListPolicyVersions, and GetAccountAuthorizationDetails operations.

\n

For more information about managed policies, refer to Managed policies and inline\n policies in the IAM User Guide.

" + } + }, + "com.amazonaws.iam#Position": { + "type": "structure", + "members": { + "Line": { + "target": "com.amazonaws.iam#LineNumber", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The line containing the specified position in the document.

" + } + }, + "Column": { + "target": "com.amazonaws.iam#ColumnNumber", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The column in the line containing the specified position in the document.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the row and column of a location of a Statement element in a\n policy document.

\n

This data type is used as a member of the \n Statement\n type.

" + } + }, + "com.amazonaws.iam#PutGroupPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#PutGroupPolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#MalformedPolicyDocumentException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds or updates an inline policy document that is embedded in the specified IAM\n group.

\n

A user can also have managed policies attached to it. To attach a managed policy to a\n group, use \n AttachGroupPolicy\n . To create a new managed policy, use\n \n CreatePolicy\n . For information about policies, see Managed\n policies and inline policies in the\n IAM User Guide.

\n

For information about the maximum number of inline policies that you can embed in a\n group, see IAM and STS quotas in the IAM User Guide.

\n \n

Because policy documents can be large, you should use POST rather than GET when\n calling PutGroupPolicy. For general information about using the Query\n API with IAM, see Making query requests in the\n IAM User Guide.

\n ", + "smithy.api#examples": [ + { + "title": "To add a policy to a group", + "documentation": "The following command adds a policy named AllPerms to the IAM group named Admins.", + "input": { + "GroupName": "Admins", + "PolicyName": "AllPerms", + "PolicyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Action\":\"*\",\"Resource\":\"*\"}}" + } + } + ] + } + }, + "com.amazonaws.iam#PutGroupPolicyRequest": { + "type": "structure", + "members": { + "GroupName": { + "target": "com.amazonaws.iam#groupNameType", + "traits": { + "smithy.api#documentation": "

The name of the group to associate the policy with.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-.

", + "smithy.api#required": {} + } + }, + "PolicyName": { + "target": "com.amazonaws.iam#policyNameType", + "traits": { + "smithy.api#documentation": "

The name of the policy document.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "PolicyDocument": { + "target": "com.amazonaws.iam#policyDocumentType", + "traits": { + "smithy.api#documentation": "

The policy document.

\n

You must provide policies in JSON format in IAM. However, for CloudFormation templates\n formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always\n converts a YAML policy to JSON format before submitting it to IAM.

\n

The regex pattern \n used to validate this parameter is a string of characters consisting of the following:

\n
    \n
  • \n

    Any printable ASCII \n character ranging from the space character (\\u0020) through the end of the ASCII character range

    \n
    • \n
  • \n

    The printable characters in the Basic Latin and Latin-1 Supplement character set \n (through \\u00FF)

    \n
    • \n
  • \n

    The special characters tab (\\u0009), line feed (\\u000A), and \n carriage return (\\u000D)

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#PutRolePermissionsBoundary": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#PutRolePermissionsBoundaryRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#PolicyNotAttachableException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + }, + { + "target": "com.amazonaws.iam#UnmodifiableEntityException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds or updates the policy that is specified as the IAM role's permissions boundary.\n You can use an Amazon Web Services managed policy or a customer managed policy to set the boundary for\n a role. Use the boundary to control the maximum permissions that the role can have.\n Setting a permissions boundary is an advanced feature that can affect the permissions\n for the role.

\n

You cannot set the boundary for a service-linked role.

\n \n

Policies used as permissions boundaries do not provide permissions. You must also\n attach a permissions policy to the role. To learn how the effective permissions for\n a role are evaluated, see IAM JSON policy\n evaluation logic in the IAM User Guide.

\n " + } + }, + "com.amazonaws.iam#PutRolePermissionsBoundaryRequest": { + "type": "structure", + "members": { + "RoleName": { + "target": "com.amazonaws.iam#roleNameType", + "traits": { + "smithy.api#documentation": "

The name (friendly name, not ARN) of the IAM role for which you want to set the\n permissions boundary.

", + "smithy.api#required": {} + } + }, + "PermissionsBoundary": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The ARN of the managed policy that is used to set the permissions boundary for the\n role.

\n

A permissions boundary policy defines the maximum permissions that identity-based\n policies can grant to an entity, but does not grant permissions. Permissions boundaries\n do not define the maximum permissions that a resource-based policy can grant to an\n entity. To learn more, see Permissions boundaries\n for IAM entities in the IAM User Guide.

\n

For more information about policy types, see Policy types\n in the IAM User Guide.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#PutRolePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#PutRolePolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#MalformedPolicyDocumentException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + }, + { + "target": "com.amazonaws.iam#UnmodifiableEntityException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds or updates an inline policy document that is embedded in the specified IAM\n role.

\n

When you embed an inline policy in a role, the inline policy is used as part of the\n role's access (permissions) policy. The role's trust policy is created at the same time\n as the role, using \n CreateRole\n .\n You can update a role's trust policy using \n UpdateAssumeRolePolicy\n . For more information about roles,\n see IAM\n roles in the IAM User Guide.

\n

A role can also have a managed policy attached to it. To attach a managed policy to a\n role, use \n AttachRolePolicy\n . To create a new managed policy, use\n \n CreatePolicy\n . For information about policies, see Managed\n policies and inline policies in the\n IAM User Guide.

\n

For information about the maximum number of inline policies that you can embed with a\n role, see IAM and STS quotas in the IAM User Guide.

\n \n

Because policy documents can be large, you should use POST rather than GET when\n calling PutRolePolicy. For general information about using the Query\n API with IAM, see Making query requests in the\n IAM User Guide.

\n ", + "smithy.api#examples": [ + { + "title": "To attach a permissions policy to an IAM role", + "documentation": "The following command adds a permissions policy to the role named Test-Role.", + "input": { + "RoleName": "S3Access", + "PolicyName": "S3AccessPolicy", + "PolicyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Action\":\"s3:*\",\"Resource\":\"*\"}}" + } + } + ] + } + }, + "com.amazonaws.iam#PutRolePolicyRequest": { + "type": "structure", + "members": { + "RoleName": { + "target": "com.amazonaws.iam#roleNameType", + "traits": { + "smithy.api#documentation": "

The name of the role to associate the policy with.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "PolicyName": { + "target": "com.amazonaws.iam#policyNameType", + "traits": { + "smithy.api#documentation": "

The name of the policy document.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "PolicyDocument": { + "target": "com.amazonaws.iam#policyDocumentType", + "traits": { + "smithy.api#documentation": "

The policy document.

\n

You must provide policies in JSON format in IAM. However, for CloudFormation\n templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to\n IAM.

\n

The regex pattern \n used to validate this parameter is a string of characters consisting of the following:

\n
    \n
  • \n

    Any printable ASCII \n character ranging from the space character (\\u0020) through the end of the ASCII character range

    \n
    • \n
  • \n

    The printable characters in the Basic Latin and Latin-1 Supplement character set \n (through \\u00FF)

    \n
    • \n
  • \n

    The special characters tab (\\u0009), line feed (\\u000A), and \n carriage return (\\u000D)

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#PutUserPermissionsBoundary": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#PutUserPermissionsBoundaryRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#PolicyNotAttachableException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds or updates the policy that is specified as the IAM user's permissions\n boundary. You can use an Amazon Web Services managed policy or a customer managed policy to set the\n boundary for a user. Use the boundary to control the maximum permissions that the user\n can have. Setting a permissions boundary is an advanced feature that can affect the\n permissions for the user.

\n \n

Policies that are used as permissions boundaries do not provide permissions. You\n must also attach a permissions policy to the user. To learn how the effective\n permissions for a user are evaluated, see IAM JSON policy\n evaluation logic in the IAM User Guide.

\n " + } + }, + "com.amazonaws.iam#PutUserPermissionsBoundaryRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#userNameType", + "traits": { + "smithy.api#documentation": "

The name (friendly name, not ARN) of the IAM user for which you want to set the\n permissions boundary.

", + "smithy.api#required": {} + } + }, + "PermissionsBoundary": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The ARN of the managed policy that is used to set the permissions boundary for the\n user.

\n

A permissions boundary policy defines the maximum permissions that identity-based\n policies can grant to an entity, but does not grant permissions. Permissions boundaries\n do not define the maximum permissions that a resource-based policy can grant to an\n entity. To learn more, see Permissions boundaries\n for IAM entities in the IAM User Guide.

\n

For more information about policy types, see Policy types\n in the IAM User Guide.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#PutUserPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#PutUserPolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#MalformedPolicyDocumentException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds or updates an inline policy document that is embedded in the specified IAM\n user.

\n

An IAM user can also have a managed policy attached to it. To attach a managed\n policy to a user, use \n AttachUserPolicy\n . To create a new managed policy, use\n \n CreatePolicy\n . For information about policies, see Managed\n policies and inline policies in the\n IAM User Guide.

\n

For information about the maximum number of inline policies that you can embed in a\n user, see IAM and STS quotas in the IAM User Guide.

\n \n

Because policy documents can be large, you should use POST rather than GET when\n calling PutUserPolicy. For general information about using the Query\n API with IAM, see Making query requests in the\n IAM User Guide.

\n ", + "smithy.api#examples": [ + { + "title": "To attach a policy to an IAM user", + "documentation": "The following command attaches a policy to the IAM user named Bob.", + "input": { + "UserName": "Bob", + "PolicyName": "AllAccessPolicy", + "PolicyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Action\":\"*\",\"Resource\":\"*\"}}" + } + } + ] + } + }, + "com.amazonaws.iam#PutUserPolicyRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#existingUserNameType", + "traits": { + "smithy.api#documentation": "

The name of the user to associate the policy with.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "PolicyName": { + "target": "com.amazonaws.iam#policyNameType", + "traits": { + "smithy.api#documentation": "

The name of the policy document.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "PolicyDocument": { + "target": "com.amazonaws.iam#policyDocumentType", + "traits": { + "smithy.api#documentation": "

The policy document.

\n

You must provide policies in JSON format in IAM. However, for CloudFormation\n templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to\n IAM.

\n

The regex pattern \n used to validate this parameter is a string of characters consisting of the following:

\n
    \n
  • \n

    Any printable ASCII \n character ranging from the space character (\\u0020) through the end of the ASCII character range

    \n
    • \n
  • \n

    The printable characters in the Basic Latin and Latin-1 Supplement character set \n (through \\u00FF)

    \n
    • \n
  • \n

    The special characters tab (\\u0009), line feed (\\u000A), and \n carriage return (\\u000D)

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#ReasonType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + } + } + }, + "com.amazonaws.iam#RegionNameType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.iam#RemoveClientIDFromOpenIDConnectProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#RemoveClientIDFromOpenIDConnectProviderRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes the specified client ID (also known as audience) from the list of client IDs\n registered for the specified IAM OpenID Connect (OIDC) provider resource\n object.

\n

This operation is idempotent; it does not fail or return an error if you try to remove\n a client ID that does not exist.

" + } + }, + "com.amazonaws.iam#RemoveClientIDFromOpenIDConnectProviderRequest": { + "type": "structure", + "members": { + "OpenIDConnectProviderArn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM OIDC provider resource to remove the\n client ID from. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders operation.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

", + "smithy.api#required": {} + } + }, + "ClientID": { + "target": "com.amazonaws.iam#clientIDType", + "traits": { + "smithy.api#documentation": "

The client ID (also known as audience) to remove from the IAM OIDC provider\n resource. For more information about client IDs, see CreateOpenIDConnectProvider.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#RemoveRoleFromInstanceProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#RemoveRoleFromInstanceProfileRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + }, + { + "target": "com.amazonaws.iam#UnmodifiableEntityException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes the specified IAM role from the specified Amazon EC2 instance profile.

\n \n

Make sure that you do not have any Amazon EC2 instances running with the role you are\n about to remove from the instance profile. Removing a role from an instance profile\n that is associated with a running instance might break any applications running on\n the instance.

\n \n

For more information about roles, see IAM roles in the\n IAM User Guide. For more information about instance profiles,\n see Using\n instance profiles in the IAM User Guide.

", + "smithy.api#examples": [ + { + "title": "To remove a role from an instance profile", + "documentation": "The following command removes the role named Test-Role from the instance profile named ExampleInstanceProfile.", + "input": { + "RoleName": "Test-Role", + "InstanceProfileName": "ExampleInstanceProfile" + } + } + ] + } + }, + "com.amazonaws.iam#RemoveRoleFromInstanceProfileRequest": { + "type": "structure", + "members": { + "InstanceProfileName": { + "target": "com.amazonaws.iam#instanceProfileNameType", + "traits": { + "smithy.api#documentation": "

The name of the instance profile to update.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "RoleName": { + "target": "com.amazonaws.iam#roleNameType", + "traits": { + "smithy.api#documentation": "

The name of the role to remove.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#RemoveUserFromGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#RemoveUserFromGroupRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes the specified user from the specified group.

", + "smithy.api#examples": [ + { + "title": "To remove a user from an IAM group", + "documentation": "The following command removes the user named Bob from the IAM group named Admins.", + "input": { + "UserName": "Bob", + "GroupName": "Admins" + } + } + ] + } + }, + "com.amazonaws.iam#RemoveUserFromGroupRequest": { + "type": "structure", + "members": { + "GroupName": { + "target": "com.amazonaws.iam#groupNameType", + "traits": { + "smithy.api#documentation": "

The name of the group to update.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "UserName": { + "target": "com.amazonaws.iam#existingUserNameType", + "traits": { + "smithy.api#documentation": "

The name of the user to remove.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#ReportContentType": { + "type": "blob" + }, + "com.amazonaws.iam#ReportFormatType": { + "type": "enum", + "members": { + "text_csv": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "text/csv" + } + } + } + }, + "com.amazonaws.iam#ReportGenerationLimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iam#reportGenerationLimitExceededMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ReportGenerationLimitExceeded", + "httpResponseCode": 409 + }, + "smithy.api#documentation": "

The request failed because the maximum number of concurrent requests for this account are\n already running.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.iam#ReportStateDescriptionType": { + "type": "string" + }, + "com.amazonaws.iam#ReportStateType": { + "type": "enum", + "members": { + "STARTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTED" + } + }, + "INPROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INPROGRESS" + } + }, + "COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETE" + } + } + } + }, + "com.amazonaws.iam#ResetServiceSpecificCredential": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#ResetServiceSpecificCredentialRequest" + }, + "output": { + "target": "com.amazonaws.iam#ResetServiceSpecificCredentialResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#NoSuchEntityException" + } + ], + "traits": { + "smithy.api#documentation": "

Resets the password for a service-specific credential. The new password is Amazon Web Services\n generated and cryptographically strong. It cannot be configured by the user. Resetting\n the password immediately invalidates the previous password associated with this\n user.

" + } + }, + "com.amazonaws.iam#ResetServiceSpecificCredentialRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#userNameType", + "traits": { + "smithy.api#documentation": "

The name of the IAM user associated with the service-specific credential. If this\n value is not specified, then the operation assumes the user whose credentials are used\n to call the operation.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } + }, + "ServiceSpecificCredentialId": { + "target": "com.amazonaws.iam#serviceSpecificCredentialId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the service-specific credential.

\n

This parameter allows (through its regex pattern) a string of characters that can \n consist of any upper or lowercased letter or digit.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#ResetServiceSpecificCredentialResponse": { + "type": "structure", + "members": { + "ServiceSpecificCredential": { + "target": "com.amazonaws.iam#ServiceSpecificCredential", + "traits": { + "smithy.api#documentation": "

A structure with details about the updated service-specific credential, including the\n new password.

\n \n

This is the only time that you can access the\n password. You cannot recover the password later, but you can reset it again.

\n " + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#ResourceHandlingOptionType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.iam#ResourceNameListType": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#ResourceNameType" + } + }, + "com.amazonaws.iam#ResourceNameType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.iam#ResourceSpecificResult": { + "type": "structure", + "members": { + "EvalResourceName": { + "target": "com.amazonaws.iam#ResourceNameType", + "traits": { + "smithy.api#documentation": "

The name of the simulated resource, in Amazon Resource Name (ARN) format.

", + "smithy.api#required": {} + } + }, + "EvalResourceDecision": { + "target": "com.amazonaws.iam#PolicyEvaluationDecisionType", + "traits": { + "smithy.api#documentation": "

The result of the simulation of the simulated API operation on the resource specified in\n EvalResourceName.

", + "smithy.api#required": {} + } + }, + "MatchedStatements": { + "target": "com.amazonaws.iam#StatementListType", + "traits": { + "smithy.api#documentation": "

A list of the statements in the input policies that determine the result for this part\n of the simulation. Remember that even if multiple statements allow the operation on the\n resource, if any statement denies that operation, then the explicit\n deny overrides any allow. In addition, the deny statement is the only entry included in the\n result.

" + } + }, + "MissingContextValues": { + "target": "com.amazonaws.iam#ContextKeyNamesResultListType", + "traits": { + "smithy.api#documentation": "

A list of context keys that are required by the included input policies but that were\n not provided by one of the input parameters. This list is used when a list of ARNs is\n included in the ResourceArns parameter instead of \"*\". If you do not specify\n individual resources, by setting ResourceArns to \"*\" or by not including the\n ResourceArns parameter, then any missing context values are instead\n included under the EvaluationResults section. To discover the context keys\n used by a set of policies, you can call GetContextKeysForCustomPolicy or\n GetContextKeysForPrincipalPolicy.

" + } + }, + "EvalDecisionDetails": { + "target": "com.amazonaws.iam#EvalDecisionDetailsType", + "traits": { + "smithy.api#documentation": "

Additional details about the results of the evaluation decision on a single resource.\n This parameter is returned only for cross-account simulations. This parameter explains how\n each policy type contributes to the resource-specific evaluation decision.

" + } + }, + "PermissionsBoundaryDecisionDetail": { + "target": "com.amazonaws.iam#PermissionsBoundaryDecisionDetail", + "traits": { + "smithy.api#documentation": "

Contains information about the effect that a permissions boundary has on a policy\n simulation when that boundary is applied to an IAM entity.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of the simulation of a single API operation call on a single\n resource.

\n

This data type is used by a member of the EvaluationResult data\n type.

" + } + }, + "com.amazonaws.iam#ResourceSpecificResultListType": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#ResourceSpecificResult" + } + }, + "com.amazonaws.iam#ResyncMFADevice": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#ResyncMFADeviceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.iam#InvalidAuthenticationCodeException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Synchronizes the specified MFA device with its IAM resource object on the Amazon Web Services\n servers.

\n

For more information about creating and working with virtual MFA devices, see Using a virtual MFA\n device in the IAM User Guide.

" + } + }, + "com.amazonaws.iam#ResyncMFADeviceRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#existingUserNameType", + "traits": { + "smithy.api#documentation": "

The name of the user whose MFA device you want to resynchronize.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "SerialNumber": { + "target": "com.amazonaws.iam#serialNumberType", + "traits": { + "smithy.api#documentation": "

Serial number that uniquely identifies the MFA device.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "AuthenticationCode1": { + "target": "com.amazonaws.iam#authenticationCodeType", + "traits": { + "smithy.api#documentation": "

An authentication code emitted by the device.

\n

The format for this parameter is a sequence of six digits.

", + "smithy.api#required": {} + } + }, + "AuthenticationCode2": { + "target": "com.amazonaws.iam#authenticationCodeType", + "traits": { + "smithy.api#documentation": "

A subsequent authentication code emitted by the device.

\n

The format for this parameter is a sequence of six digits.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#Role": { + "type": "structure", + "members": { + "Path": { + "target": "com.amazonaws.iam#pathType", + "traits": { + "smithy.api#documentation": "

The path to the role. For more information about paths, see IAM identifiers in the\n IAM User Guide.

", + "smithy.api#required": {} + } + }, + "RoleName": { + "target": "com.amazonaws.iam#roleNameType", + "traits": { + "smithy.api#documentation": "

The friendly name that identifies the role.

", + "smithy.api#required": {} + } + }, + "RoleId": { + "target": "com.amazonaws.iam#idType", + "traits": { + "smithy.api#documentation": "

The stable and unique string identifying the role. For more information about IDs, see\n IAM\n identifiers in the IAM User Guide.

", + "smithy.api#required": {} + } + }, + "Arn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and\n how to use them in policies, see IAM identifiers in the\n IAM User Guide guide.

", + "smithy.api#required": {} + } + }, + "CreateDate": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the role was created.

", + "smithy.api#required": {} + } + }, + "AssumeRolePolicyDocument": { + "target": "com.amazonaws.iam#policyDocumentType", + "traits": { + "smithy.api#documentation": "

The policy that grants an entity permission to assume the role.

" + } + }, + "Description": { + "target": "com.amazonaws.iam#roleDescriptionType", + "traits": { + "smithy.api#documentation": "

A description of the role that you provide.

" + } + }, + "MaxSessionDuration": { + "target": "com.amazonaws.iam#roleMaxSessionDurationType", + "traits": { + "smithy.api#documentation": "

The maximum session duration (in seconds) for the specified role. Anyone who uses the\n CLI, or API to assume the role can specify the duration using the optional\n DurationSeconds API parameter or duration-seconds CLI\n parameter.

" + } + }, + "PermissionsBoundary": { + "target": "com.amazonaws.iam#AttachedPermissionsBoundary", + "traits": { + "smithy.api#documentation": "

The ARN of the policy used to set the permissions boundary for the role.

\n

For more information about permissions boundaries, see Permissions boundaries for IAM\n identities in the IAM User Guide.

" + } + }, + "Tags": { + "target": "com.amazonaws.iam#tagListType", + "traits": { + "smithy.api#documentation": "

A list of tags that are attached to the role. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

" + } + }, + "RoleLastUsed": { + "target": "com.amazonaws.iam#RoleLastUsed", + "traits": { + "smithy.api#documentation": "

Contains information about the last time that an IAM role was used. This includes the\n date and time and the Region in which the role was last used. Activity is only reported for\n the trailing 400 days. This period can be shorter if your Region began supporting these\n features within the last year. The role might have been used more than 400 days ago. For\n more information, see Regions where data is tracked in the IAM user\n Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about an IAM role. This structure is returned as a response\n element in several API operations that interact with roles.

" + } + }, + "com.amazonaws.iam#RoleDetail": { + "type": "structure", + "members": { + "Path": { + "target": "com.amazonaws.iam#pathType", + "traits": { + "smithy.api#documentation": "

The path to the role. For more information about paths, see IAM identifiers in the\n IAM User Guide.

" + } + }, + "RoleName": { + "target": "com.amazonaws.iam#roleNameType", + "traits": { + "smithy.api#documentation": "

The friendly name that identifies the role.

" + } + }, + "RoleId": { + "target": "com.amazonaws.iam#idType", + "traits": { + "smithy.api#documentation": "

The stable and unique string identifying the role. For more information about IDs, see\n IAM\n identifiers in the IAM User Guide.

" + } + }, + "Arn": { + "target": "com.amazonaws.iam#arnType" + }, + "CreateDate": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the role was created.

" + } + }, + "AssumeRolePolicyDocument": { + "target": "com.amazonaws.iam#policyDocumentType", + "traits": { + "smithy.api#documentation": "

The trust policy that grants permission to assume the role.

" + } + }, + "InstanceProfileList": { + "target": "com.amazonaws.iam#instanceProfileListType", + "traits": { + "smithy.api#documentation": "

A list of instance profiles that contain this role.

" + } + }, + "RolePolicyList": { + "target": "com.amazonaws.iam#policyDetailListType", + "traits": { + "smithy.api#documentation": "

A list of inline policies embedded in the role. These policies are the role's access\n (permissions) policies.

" + } + }, + "AttachedManagedPolicies": { + "target": "com.amazonaws.iam#attachedPoliciesListType", + "traits": { + "smithy.api#documentation": "

A list of managed policies attached to the role. These policies are the role's access\n (permissions) policies.

" + } + }, + "PermissionsBoundary": { + "target": "com.amazonaws.iam#AttachedPermissionsBoundary", + "traits": { + "smithy.api#documentation": "

The ARN of the policy used to set the permissions boundary for the role.

\n

For more information about permissions boundaries, see Permissions boundaries for IAM\n identities in the IAM User Guide.

" + } + }, + "Tags": { + "target": "com.amazonaws.iam#tagListType", + "traits": { + "smithy.api#documentation": "

A list of tags that are attached to the role. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

" + } + }, + "RoleLastUsed": { + "target": "com.amazonaws.iam#RoleLastUsed", + "traits": { + "smithy.api#documentation": "

Contains information about the last time that an IAM role was used. This includes the\n date and time and the Region in which the role was last used. Activity is only reported for\n the trailing 400 days. This period can be shorter if your Region began supporting these\n features within the last year. The role might have been used more than 400 days ago. For\n more information, see Regions where data is tracked in the IAM User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about an IAM role, including all of the role's policies.

\n

This data type is used as a response element in the GetAccountAuthorizationDetails operation.

" + } + }, + "com.amazonaws.iam#RoleLastUsed": { + "type": "structure", + "members": { + "LastUsedDate": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format that the role was last used.

\n

This field is null if the role has not been used within the IAM tracking period. For\n more information about the tracking period, see Regions where data is tracked in the IAM User Guide.\n

" + } + }, + "Region": { + "target": "com.amazonaws.iam#stringType", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Web Services Region in which the role was last used.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the last time that an IAM role was used. This includes the\n date and time and the Region in which the role was last used. Activity is only reported for\n the trailing 400 days. This period can be shorter if your Region began supporting these\n features within the last year. The role might have been used more than 400 days ago. For\n more information, see Regions where data is tracked in the IAM user\n Guide.

\n

This data type is returned as a response element in the GetRole and\n GetAccountAuthorizationDetails operations.

" + } + }, + "com.amazonaws.iam#RoleUsageListType": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#RoleUsageType" + } + }, + "com.amazonaws.iam#RoleUsageType": { + "type": "structure", + "members": { + "Region": { + "target": "com.amazonaws.iam#RegionNameType", + "traits": { + "smithy.api#documentation": "

The name of the Region where the service-linked role is being used.

" + } + }, + "Resources": { + "target": "com.amazonaws.iam#ArnListType", + "traits": { + "smithy.api#documentation": "

The name of the resource that is using the service-linked role.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that contains details about how a service-linked role is used, if that\n information is returned by the service.

\n

This data type is used as a response element in the GetServiceLinkedRoleDeletionStatus operation.

" + } + }, + "com.amazonaws.iam#SAMLMetadataDocumentType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1000, + "max": 10000000 + } + } + }, + "com.amazonaws.iam#SAMLProviderListEntry": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SAML provider.

" + } + }, + "ValidUntil": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The expiration date and time for the SAML provider.

" + } + }, + "CreateDate": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date and time when the SAML provider was created.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the list of SAML providers for this account.

" + } + }, + "com.amazonaws.iam#SAMLProviderListType": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#SAMLProviderListEntry" + } + }, + "com.amazonaws.iam#SAMLProviderNameType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\w._-]+$" + } + }, + "com.amazonaws.iam#SSHPublicKey": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#userNameType", + "traits": { + "smithy.api#documentation": "

The name of the IAM user associated with the SSH public key.

", + "smithy.api#required": {} + } + }, + "SSHPublicKeyId": { + "target": "com.amazonaws.iam#publicKeyIdType", + "traits": { + "smithy.api#documentation": "

The unique identifier for the SSH public key.

", + "smithy.api#required": {} + } + }, + "Fingerprint": { + "target": "com.amazonaws.iam#publicKeyFingerprintType", + "traits": { + "smithy.api#documentation": "

The MD5 message digest of the SSH public key.

", + "smithy.api#required": {} + } + }, + "SSHPublicKeyBody": { + "target": "com.amazonaws.iam#publicKeyMaterialType", + "traits": { + "smithy.api#documentation": "

The SSH public key.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.iam#statusType", + "traits": { + "smithy.api#documentation": "

The status of the SSH public key. Active means that the key can be used for\n authentication with an CodeCommit repository. Inactive means that the key cannot be\n used.

", + "smithy.api#required": {} + } + }, + "UploadDate": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the SSH public key was uploaded.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about an SSH public key.

\n

This data type is used as a response element in the GetSSHPublicKey\n and UploadSSHPublicKey operations.

" + } + }, + "com.amazonaws.iam#SSHPublicKeyListType": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#SSHPublicKeyMetadata" + } + }, + "com.amazonaws.iam#SSHPublicKeyMetadata": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#userNameType", + "traits": { + "smithy.api#documentation": "

The name of the IAM user associated with the SSH public key.

", + "smithy.api#required": {} + } + }, + "SSHPublicKeyId": { + "target": "com.amazonaws.iam#publicKeyIdType", + "traits": { + "smithy.api#documentation": "

The unique identifier for the SSH public key.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.iam#statusType", + "traits": { + "smithy.api#documentation": "

The status of the SSH public key. Active means that the key can be used for\n authentication with an CodeCommit repository. Inactive means that the key cannot be\n used.

", + "smithy.api#required": {} + } + }, + "UploadDate": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the SSH public key was uploaded.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about an SSH public key, without the key's body or\n fingerprint.

\n

This data type is used as a response element in the ListSSHPublicKeys\n operation.

" + } + }, + "com.amazonaws.iam#ServerCertificate": { + "type": "structure", + "members": { + "ServerCertificateMetadata": { + "target": "com.amazonaws.iam#ServerCertificateMetadata", + "traits": { + "smithy.api#documentation": "

The meta information of the server certificate, such as its name, path, ID, and\n ARN.

", + "smithy.api#required": {} + } + }, + "CertificateBody": { + "target": "com.amazonaws.iam#certificateBodyType", + "traits": { + "smithy.api#documentation": "

The contents of the public key certificate.

", + "smithy.api#required": {} + } + }, + "CertificateChain": { + "target": "com.amazonaws.iam#certificateChainType", + "traits": { + "smithy.api#documentation": "

The contents of the public key certificate chain.

" + } + }, + "Tags": { + "target": "com.amazonaws.iam#tagListType", + "traits": { + "smithy.api#documentation": "

A list of tags that are attached to the server certificate. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a server certificate.

\n

This data type is used as a response element in the GetServerCertificate operation.

" + } + }, + "com.amazonaws.iam#ServerCertificateMetadata": { + "type": "structure", + "members": { + "Path": { + "target": "com.amazonaws.iam#pathType", + "traits": { + "smithy.api#documentation": "

The path to the server certificate. For more information about paths, see IAM\n identifiers in the IAM User Guide.

", + "smithy.api#required": {} + } + }, + "ServerCertificateName": { + "target": "com.amazonaws.iam#serverCertificateNameType", + "traits": { + "smithy.api#documentation": "

The name that identifies the server certificate.

", + "smithy.api#required": {} + } + }, + "ServerCertificateId": { + "target": "com.amazonaws.iam#idType", + "traits": { + "smithy.api#documentation": "

The stable and unique string identifying the server certificate. For more information\n about IDs, see IAM identifiers in the IAM User Guide.

", + "smithy.api#required": {} + } + }, + "Arn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) specifying the server certificate. For more information\n about ARNs and how to use them in policies, see IAM identifiers in the\n IAM User Guide.

", + "smithy.api#required": {} + } + }, + "UploadDate": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date when the server certificate was uploaded.

" + } + }, + "Expiration": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date on which the certificate is set to expire.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a server certificate without its certificate body,\n certificate chain, and private key.

\n

This data type is used as a response element in the UploadServerCertificate and ListServerCertificates\n operations.

" + } + }, + "com.amazonaws.iam#ServiceAccessNotEnabledException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.iam#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The request was rejected because trusted access is not enabled for IAM in Organizations. For details, see IAM and Organizations in the Organizations User Guide.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.iam#ServiceFailureException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iam#serviceFailureExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ServiceFailure", + "httpResponseCode": 500 + }, + "smithy.api#documentation": "

The request processing has failed because of an unknown error, exception or\n failure.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.iam#ServiceLastAccessed": { + "type": "structure", + "members": { + "ServiceName": { + "target": "com.amazonaws.iam#serviceNameType", + "traits": { + "smithy.api#documentation": "

The name of the service in which access was attempted.

", + "smithy.api#required": {} + } + }, + "LastAuthenticated": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when an authenticated entity most recently attempted to access the\n service. Amazon Web Services does not report unauthenticated requests.

\n

This field is null if no IAM entities attempted to access the service within the\n tracking period.

" + } + }, + "ServiceNamespace": { + "target": "com.amazonaws.iam#serviceNamespaceType", + "traits": { + "smithy.api#documentation": "

The namespace of the service in which access was attempted.

\n

To learn the service namespace of a service, see Actions, resources, and condition keys for Amazon Web Services services in the\n Service Authorization Reference. Choose the name of the service to\n view details for that service. In the first paragraph, find the service prefix. For\n example, (service prefix: a4b). For more information about service namespaces,\n see Amazon Web Services\n Service Namespaces in the Amazon Web Services General Reference.

", + "smithy.api#required": {} + } + }, + "LastAuthenticatedEntity": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The ARN of the authenticated entity (user or role) that last attempted to access the\n service. Amazon Web Services does not report unauthenticated requests.

\n

This field is null if no IAM entities attempted to access the service within the\n tracking period.

" + } + }, + "LastAuthenticatedRegion": { + "target": "com.amazonaws.iam#stringType", + "traits": { + "smithy.api#documentation": "

The Region from which the authenticated entity (user or role) last attempted to access\n the service. Amazon Web Services does not report unauthenticated requests.

\n

This field is null if no IAM entities attempted to access the service within the\n tracking period.

" + } + }, + "TotalAuthenticatedEntities": { + "target": "com.amazonaws.iam#integerType", + "traits": { + "smithy.api#documentation": "

The total number of authenticated principals (root user, IAM users, or IAM roles)\n that have attempted to access the service.

\n

This field is null if no principals attempted to access the service within the tracking period.

" + } + }, + "TrackedActionsLastAccessed": { + "target": "com.amazonaws.iam#TrackedActionsLastAccessed", + "traits": { + "smithy.api#documentation": "

An object that contains details about the most recent attempt to access a tracked action\n within the service.

\n

This field is null if there no tracked actions or if the principal did not use the\n tracked actions within the tracking period. This field is also null if the report was generated at the\n service level and not the action level. For more information, see the\n Granularity field in GenerateServiceLastAccessedDetails.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about the most recent attempt to access the service.

\n

This data type is used as a response element in the GetServiceLastAccessedDetails operation.

" + } + }, + "com.amazonaws.iam#ServiceNotSupportedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iam#serviceNotSupportedMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "NotSupportedService", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified service does not support service-specific credentials.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.iam#ServiceSpecificCredential": { + "type": "structure", + "members": { + "CreateDate": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the service-specific credential were created.

", + "smithy.api#required": {} + } + }, + "ServiceName": { + "target": "com.amazonaws.iam#serviceName", + "traits": { + "smithy.api#documentation": "

The name of the service associated with the service-specific credential.

", + "smithy.api#required": {} + } + }, + "ServiceUserName": { + "target": "com.amazonaws.iam#serviceUserName", + "traits": { + "smithy.api#documentation": "

The generated user name for the service-specific credential. This value is generated by\n combining the IAM user's name combined with the ID number of the Amazon Web Services account, as in\n jane-at-123456789012, for example. This value cannot be configured by the\n user.

", + "smithy.api#required": {} + } + }, + "ServicePassword": { + "target": "com.amazonaws.iam#servicePassword", + "traits": { + "smithy.api#documentation": "

The generated password for the service-specific credential.

", + "smithy.api#required": {} + } + }, + "ServiceSpecificCredentialId": { + "target": "com.amazonaws.iam#serviceSpecificCredentialId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the service-specific credential.

", + "smithy.api#required": {} + } + }, + "UserName": { + "target": "com.amazonaws.iam#userNameType", + "traits": { + "smithy.api#documentation": "

The name of the IAM user associated with the service-specific credential.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.iam#statusType", + "traits": { + "smithy.api#documentation": "

The status of the service-specific credential. Active means that the key is\n valid for API calls, while Inactive means it is not.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details of a service-specific credential.

" + } + }, + "com.amazonaws.iam#ServiceSpecificCredentialMetadata": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#userNameType", + "traits": { + "smithy.api#documentation": "

The name of the IAM user associated with the service-specific credential.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.iam#statusType", + "traits": { + "smithy.api#documentation": "

The status of the service-specific credential. Active means that the key is\n valid for API calls, while Inactive means it is not.

", + "smithy.api#required": {} + } + }, + "ServiceUserName": { + "target": "com.amazonaws.iam#serviceUserName", + "traits": { + "smithy.api#documentation": "

The generated user name for the service-specific credential.

", + "smithy.api#required": {} + } + }, + "CreateDate": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the service-specific credential were created.

", + "smithy.api#required": {} + } + }, + "ServiceSpecificCredentialId": { + "target": "com.amazonaws.iam#serviceSpecificCredentialId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the service-specific credential.

", + "smithy.api#required": {} + } + }, + "ServiceName": { + "target": "com.amazonaws.iam#serviceName", + "traits": { + "smithy.api#documentation": "

The name of the service associated with the service-specific credential.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains additional details about a service-specific credential.

" + } + }, + "com.amazonaws.iam#ServiceSpecificCredentialsListType": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#ServiceSpecificCredentialMetadata" + } + }, + "com.amazonaws.iam#ServicesLastAccessed": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#ServiceLastAccessed" + } + }, + "com.amazonaws.iam#SetDefaultPolicyVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#SetDefaultPolicyVersionRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Sets the specified version of the specified policy as the policy's default (operative)\n version.

\n

This operation affects all users, groups, and roles that the policy is attached to. To\n list the users, groups, and roles that the policy is attached to, use ListEntitiesForPolicy.

\n

For information about managed policies, see Managed policies and inline\n policies in the IAM User Guide.

" + } + }, + "com.amazonaws.iam#SetDefaultPolicyVersionRequest": { + "type": "structure", + "members": { + "PolicyArn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM policy whose default version you want to\n set.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

", + "smithy.api#required": {} + } + }, + "VersionId": { + "target": "com.amazonaws.iam#policyVersionIdType", + "traits": { + "smithy.api#documentation": "

The version of the policy to set as the default (operative) version.

\n

For more information about managed policy versions, see Versioning for managed\n policies in the IAM User Guide.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#SetSecurityTokenServicePreferences": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#SetSecurityTokenServicePreferencesRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Sets the specified version of the global endpoint token as the token version used for\n the Amazon Web Services account.

\n

By default, Security Token Service (STS) is available as a global service, and all STS requests\n go to a single endpoint at https://sts.amazonaws.com. Amazon Web Services recommends\n using Regional STS endpoints to reduce latency, build in redundancy, and increase\n session token availability. For information about Regional endpoints for STS, see\n Security Token Service\n endpoints and quotas in the Amazon Web Services General Reference.

\n

If you make an STS call to the global endpoint, the resulting session tokens might\n be valid in some Regions but not others. It depends on the version that is set in this\n operation. Version 1 tokens are valid only in Amazon Web Services Regions that are\n available by default. These tokens do not work in manually enabled Regions, such as Asia\n Pacific (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2\n tokens are longer and might affect systems where you temporarily store tokens. For\n information, see Activating and\n deactivating STS in an Amazon Web Services Region in the\n IAM User Guide.

\n

To view the current session token version, see the\n GlobalEndpointTokenVersion entry in the response of the GetAccountSummary operation.

", + "smithy.api#examples": [ + { + "title": "To delete an access key for an IAM user", + "documentation": "The following command sets the STS global endpoint token to version 2. Version 2 tokens are valid in all Regions.", + "input": { + "GlobalEndpointTokenVersion": "v2Token" + } + } + ] + } + }, + "com.amazonaws.iam#SetSecurityTokenServicePreferencesRequest": { + "type": "structure", + "members": { + "GlobalEndpointTokenVersion": { + "target": "com.amazonaws.iam#globalEndpointTokenVersion", + "traits": { + "smithy.api#documentation": "

The version of the global endpoint token. Version 1 tokens are valid only in Amazon Web Services Regions that are available by default. These tokens do not work in\n manually enabled Regions, such as Asia Pacific (Hong Kong). Version 2 tokens are valid\n in all Regions. However, version 2 tokens are longer and might affect systems where you\n temporarily store tokens.

\n

For information, see Activating and\n deactivating STS in an Amazon Web Services Region in the\n IAM User Guide.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#SigningCertificate": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#userNameType", + "traits": { + "smithy.api#documentation": "

The name of the user the signing certificate is associated with.

", + "smithy.api#required": {} + } + }, + "CertificateId": { + "target": "com.amazonaws.iam#certificateIdType", + "traits": { + "smithy.api#documentation": "

The ID for the signing certificate.

", + "smithy.api#required": {} + } + }, + "CertificateBody": { + "target": "com.amazonaws.iam#certificateBodyType", + "traits": { + "smithy.api#documentation": "

The contents of the signing certificate.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.iam#statusType", + "traits": { + "smithy.api#documentation": "

The status of the signing certificate. Active means that the key is valid\n for API calls, while Inactive means it is not.

", + "smithy.api#required": {} + } + }, + "UploadDate": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date when the signing certificate was uploaded.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about an X.509 signing certificate.

\n

This data type is used as a response element in the UploadSigningCertificate and ListSigningCertificates\n operations.

" + } + }, + "com.amazonaws.iam#SimulateCustomPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#SimulateCustomPolicyRequest" + }, + "output": { + "target": "com.amazonaws.iam#SimulatePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#PolicyEvaluationException" + } + ], + "traits": { + "smithy.api#documentation": "

Simulate how a set of IAM policies and optionally a resource-based policy works with\n a list of API operations and Amazon Web Services resources to determine the policies' effective\n permissions. The policies are provided as strings.

\n

The simulation does not perform the API operations; it only checks the authorization\n to determine if the simulated policies allow or deny the operations. You can simulate\n resources that don't exist in your account.

\n

If you want to simulate existing policies that are attached to an IAM user, group,\n or role, use SimulatePrincipalPolicy instead.

\n

Context keys are variables that are maintained by Amazon Web Services and its services and which\n provide details about the context of an API query request. You can use the\n Condition element of an IAM policy to evaluate context keys. To get\n the list of context keys that the policies require for correct simulation, use GetContextKeysForCustomPolicy.

\n

If the output is long, you can use MaxItems and Marker\n parameters to paginate the results.

\n \n

The IAM policy simulator evaluates statements in the identity-based policy and\n the inputs that you provide during simulation. The policy simulator results can\n differ from your live Amazon Web Services environment. We recommend that you check your policies\n against your live Amazon Web Services environment after testing using the policy simulator to\n confirm that you have the desired results. For more information about using the\n policy simulator, see Testing IAM\n policies with the IAM policy simulator in the\n IAM User Guide.

\n ", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "EvaluationResults", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.iam#SimulateCustomPolicyRequest": { + "type": "structure", + "members": { + "PolicyInputList": { + "target": "com.amazonaws.iam#SimulationPolicyListType", + "traits": { + "smithy.api#documentation": "

A list of policy documents to include in the simulation. Each document is specified as\n a string containing the complete, valid JSON text of an IAM policy. Do not include any\n resource-based policies in this parameter. Any resource-based policy must be submitted\n with the ResourcePolicy parameter. The policies cannot be \"scope-down\"\n policies, such as you could include in a call to GetFederationToken or one of\n the AssumeRole API operations. In other words, do not use policies designed to\n restrict what a user can do while using the temporary credentials.

\n

The maximum length of the policy document that you can pass in this operation,\n including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.

\n

The regex pattern \n used to validate this parameter is a string of characters consisting of the following:

\n
    \n
  • \n

    Any printable ASCII \n character ranging from the space character (\\u0020) through the end of the ASCII character range

    \n
    • \n
  • \n

    The printable characters in the Basic Latin and Latin-1 Supplement character set \n (through \\u00FF)

    \n
    • \n
  • \n

    The special characters tab (\\u0009), line feed (\\u000A), and \n carriage return (\\u000D)

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "PermissionsBoundaryPolicyInputList": { + "target": "com.amazonaws.iam#SimulationPolicyListType", + "traits": { + "smithy.api#documentation": "

The IAM permissions boundary policy to simulate. The permissions boundary sets the\n maximum permissions that an IAM entity can have. You can input only one permissions\n boundary when you pass a policy to this operation. For more information about\n permissions boundaries, see Permissions boundaries for IAM\n entities in the IAM User Guide. The policy input is\n specified as a string that contains the complete, valid JSON text of a permissions\n boundary policy.

\n

The maximum length of the policy document that you can pass in this operation,\n including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.

\n

The regex pattern \n used to validate this parameter is a string of characters consisting of the following:

\n
    \n
  • \n

    Any printable ASCII \n character ranging from the space character (\\u0020) through the end of the ASCII character range

    \n
    • \n
  • \n

    The printable characters in the Basic Latin and Latin-1 Supplement character set \n (through \\u00FF)

    \n
    • \n
  • \n

    The special characters tab (\\u0009), line feed (\\u000A), and \n carriage return (\\u000D)

    \n
    • \n
" + } + }, + "ActionNames": { + "target": "com.amazonaws.iam#ActionNameListType", + "traits": { + "smithy.api#documentation": "

A list of names of API operations to evaluate in the simulation. Each operation is\n evaluated against each resource. Each operation must include the service identifier,\n such as iam:CreateUser. This operation does not support using wildcards (*)\n in an action name.

", + "smithy.api#required": {} + } + }, + "ResourceArns": { + "target": "com.amazonaws.iam#ResourceNameListType", + "traits": { + "smithy.api#documentation": "

A list of ARNs of Amazon Web Services resources to include in the simulation. If this parameter is\n not provided, then the value defaults to * (all resources). Each API in the\n ActionNames parameter is evaluated for each resource in this list. The\n simulation determines the access result (allowed or denied) of each combination and\n reports it in the response. You can simulate resources that don't exist in your\n account.

\n

The simulation does not automatically retrieve policies for the specified resources.\n If you want to include a resource policy in the simulation, then you must include the\n policy as a string in the ResourcePolicy parameter.

\n

If you include a ResourcePolicy, then it must be applicable to all of the\n resources included in the simulation or you receive an invalid input error.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

\n \n

Simulation of resource-based policies isn't supported for IAM roles.

\n " + } + }, + "ResourcePolicy": { + "target": "com.amazonaws.iam#policyDocumentType", + "traits": { + "smithy.api#documentation": "

A resource-based policy to include in the simulation provided as a string. Each\n resource in the simulation is treated as if it had this policy attached. You can include\n only one resource-based policy in a simulation.

\n

The maximum length of the policy document that you can pass in this operation,\n including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.

\n

The regex pattern \n used to validate this parameter is a string of characters consisting of the following:

\n
    \n
  • \n

    Any printable ASCII \n character ranging from the space character (\\u0020) through the end of the ASCII character range

    \n
    • \n
  • \n

    The printable characters in the Basic Latin and Latin-1 Supplement character set \n (through \\u00FF)

    \n
    • \n
  • \n

    The special characters tab (\\u0009), line feed (\\u000A), and \n carriage return (\\u000D)

    \n
    • \n
\n \n

Simulation of resource-based policies isn't supported for IAM roles.

\n " + } + }, + "ResourceOwner": { + "target": "com.amazonaws.iam#ResourceNameType", + "traits": { + "smithy.api#documentation": "

An ARN representing the Amazon Web Services account ID that specifies the owner of any simulated\n resource that does not identify its owner in the resource ARN. Examples of resource ARNs\n include an S3 bucket or object. If ResourceOwner is specified, it is also\n used as the account owner of any ResourcePolicy included in the simulation.\n If the ResourceOwner parameter is not specified, then the owner of the\n resources and the resource policy defaults to the account of the identity provided in\n CallerArn. This parameter is required only if you specify a\n resource-based policy and account that owns the resource is different from the account\n that owns the simulated calling user CallerArn.

\n

The ARN for an account uses the following syntax:\n arn:aws:iam::AWS-account-ID:root. For example,\n to represent the account with the 112233445566 ID, use the following ARN:\n arn:aws:iam::112233445566-ID:root.

" + } + }, + "CallerArn": { + "target": "com.amazonaws.iam#ResourceNameType", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM user that you want to use as the simulated caller of the API\n operations. CallerArn is required if you include a\n ResourcePolicy so that the policy's Principal element has\n a value to use in evaluating the policy.

\n

You can specify only the ARN of an IAM user. You cannot specify the ARN of an\n assumed role, federated user, or a service principal.

" + } + }, + "ContextEntries": { + "target": "com.amazonaws.iam#ContextEntryListType", + "traits": { + "smithy.api#documentation": "

A list of context keys and corresponding values for the simulation to use. Whenever a\n context key is evaluated in one of the simulated IAM permissions policies, the\n corresponding value is supplied.

" + } + }, + "ResourceHandlingOption": { + "target": "com.amazonaws.iam#ResourceHandlingOptionType", + "traits": { + "smithy.api#documentation": "

Specifies the type of simulation to run. Different API operations that support\n resource-based policies require different combinations of resources. By specifying the\n type of simulation to run, you enable the policy simulator to enforce the presence of\n the required resources to ensure reliable simulation results. If your simulation does\n not match one of the following scenarios, then you can omit this parameter. The\n following list shows each of the supported scenario values and the resources that you\n must define to run the simulation.

\n

Each of the Amazon EC2 scenarios requires that you specify instance, image, and security\n group resources. If your scenario includes an EBS volume, then you must specify that\n volume as a resource. If the Amazon EC2 scenario includes VPC, then you must supply the\n network interface resource. If it includes an IP subnet, then you must specify the\n subnet resource. For more information on the Amazon EC2 scenario options, see Supported platforms in the Amazon EC2 User Guide.

\n
    \n
  • \n

    \n EC2-VPC-InstanceStore\n

    \n

    instance, image, security group, network interface

    \n
    • \n
  • \n

    \n EC2-VPC-InstanceStore-Subnet\n

    \n

    instance, image, security group, network interface, subnet

    \n
    • \n
  • \n

    \n EC2-VPC-EBS\n

    \n

    instance, image, security group, network interface, volume

    \n
    • \n
  • \n

    \n EC2-VPC-EBS-Subnet\n

    \n

    instance, image, security group, network interface, subnet, volume

    \n
    • \n
" + } + }, + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#markerType", + "traits": { + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#SimulatePolicyResponse": { + "type": "structure", + "members": { + "EvaluationResults": { + "target": "com.amazonaws.iam#EvaluationResultsListType", + "traits": { + "smithy.api#documentation": "

The results of the simulation.

" + } + }, + "IsTruncated": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#responseMarkerType", + "traits": { + "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful SimulatePrincipalPolicy or\n SimulateCustomPolicy request.

" + } + }, + "com.amazonaws.iam#SimulatePrincipalPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#SimulatePrincipalPolicyRequest" + }, + "output": { + "target": "com.amazonaws.iam#SimulatePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#PolicyEvaluationException" + } + ], + "traits": { + "smithy.api#documentation": "

Simulate how a set of IAM policies attached to an IAM entity works with a list of\n API operations and Amazon Web Services resources to determine the policies' effective permissions. The\n entity can be an IAM user, group, or role. If you specify a user, then the simulation\n also includes all of the policies that are attached to groups that the user belongs to.\n You can simulate resources that don't exist in your account.

\n

You can optionally include a list of one or more additional policies specified as\n strings to include in the simulation. If you want to simulate only policies specified as\n strings, use SimulateCustomPolicy instead.

\n

You can also optionally include one resource-based policy to be evaluated with each of\n the resources included in the simulation for IAM users only.

\n

The simulation does not perform the API operations; it only checks the authorization\n to determine if the simulated policies allow or deny the operations.

\n

\n Note: This operation discloses information about the\n permissions granted to other users. If you do not want users to see other user's\n permissions, then consider allowing them to use SimulateCustomPolicy\n instead.

\n

Context keys are variables maintained by Amazon Web Services and its services that provide details\n about the context of an API query request. You can use the Condition\n element of an IAM policy to evaluate context keys. To get the list of context keys\n that the policies require for correct simulation, use GetContextKeysForPrincipalPolicy.

\n

If the output is long, you can use the MaxItems and Marker\n parameters to paginate the results.

\n \n

The IAM policy simulator evaluates statements in the identity-based policy and\n the inputs that you provide during simulation. The policy simulator results can\n differ from your live Amazon Web Services environment. We recommend that you check your policies\n against your live Amazon Web Services environment after testing using the policy simulator to\n confirm that you have the desired results. For more information about using the\n policy simulator, see Testing IAM\n policies with the IAM policy simulator in the\n IAM User Guide.

\n ", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "EvaluationResults", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.iam#SimulatePrincipalPolicyRequest": { + "type": "structure", + "members": { + "PolicySourceArn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a user, group, or role whose policies you want to\n include in the simulation. If you specify a user, group, or role, the simulation\n includes all policies that are associated with that entity. If you specify a user, the\n simulation also includes all policies that are attached to any groups the user belongs\n to.

\n

The maximum length of the policy document that you can pass in this operation,\n including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

", + "smithy.api#required": {} + } + }, + "PolicyInputList": { + "target": "com.amazonaws.iam#SimulationPolicyListType", + "traits": { + "smithy.api#documentation": "

An optional list of additional policy documents to include in the simulation. Each\n document is specified as a string containing the complete, valid JSON text of an IAM\n policy.

\n

The regex pattern \n used to validate this parameter is a string of characters consisting of the following:

\n
    \n
  • \n

    Any printable ASCII \n character ranging from the space character (\\u0020) through the end of the ASCII character range

    \n
    • \n
  • \n

    The printable characters in the Basic Latin and Latin-1 Supplement character set \n (through \\u00FF)

    \n
    • \n
  • \n

    The special characters tab (\\u0009), line feed (\\u000A), and \n carriage return (\\u000D)

    \n
    • \n
" + } + }, + "PermissionsBoundaryPolicyInputList": { + "target": "com.amazonaws.iam#SimulationPolicyListType", + "traits": { + "smithy.api#documentation": "

The IAM permissions boundary policy to simulate. The permissions boundary sets the\n maximum permissions that the entity can have. You can input only one permissions\n boundary when you pass a policy to this operation. An IAM entity can only have one\n permissions boundary in effect at a time. For example, if a permissions boundary is\n attached to an entity and you pass in a different permissions boundary policy using this\n parameter, then the new permissions boundary policy is used for the simulation. For more\n information about permissions boundaries, see Permissions boundaries for IAM\n entities in the IAM User Guide. The policy input is\n specified as a string containing the complete, valid JSON text of a permissions boundary\n policy.

\n

The maximum length of the policy document that you can pass in this operation,\n including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.

\n

The regex pattern \n used to validate this parameter is a string of characters consisting of the following:

\n
    \n
  • \n

    Any printable ASCII \n character ranging from the space character (\\u0020) through the end of the ASCII character range

    \n
    • \n
  • \n

    The printable characters in the Basic Latin and Latin-1 Supplement character set \n (through \\u00FF)

    \n
    • \n
  • \n

    The special characters tab (\\u0009), line feed (\\u000A), and \n carriage return (\\u000D)

    \n
    • \n
" + } + }, + "ActionNames": { + "target": "com.amazonaws.iam#ActionNameListType", + "traits": { + "smithy.api#documentation": "

A list of names of API operations to evaluate in the simulation. Each operation is\n evaluated for each resource. Each operation must include the service identifier, such as\n iam:CreateUser.

", + "smithy.api#required": {} + } + }, + "ResourceArns": { + "target": "com.amazonaws.iam#ResourceNameListType", + "traits": { + "smithy.api#documentation": "

A list of ARNs of Amazon Web Services resources to include in the simulation. If this parameter is\n not provided, then the value defaults to * (all resources). Each API in the\n ActionNames parameter is evaluated for each resource in this list. The\n simulation determines the access result (allowed or denied) of each combination and\n reports it in the response. You can simulate resources that don't exist in your\n account.

\n

The simulation does not automatically retrieve policies for the specified resources.\n If you want to include a resource policy in the simulation, then you must include the\n policy as a string in the ResourcePolicy parameter.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

\n \n

Simulation of resource-based policies isn't supported for IAM roles.

\n " + } + }, + "ResourcePolicy": { + "target": "com.amazonaws.iam#policyDocumentType", + "traits": { + "smithy.api#documentation": "

A resource-based policy to include in the simulation provided as a string. Each\n resource in the simulation is treated as if it had this policy attached. You can include\n only one resource-based policy in a simulation.

\n

The maximum length of the policy document that you can pass in this operation,\n including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.

\n

The regex pattern \n used to validate this parameter is a string of characters consisting of the following:

\n
    \n
  • \n

    Any printable ASCII \n character ranging from the space character (\\u0020) through the end of the ASCII character range

    \n
    • \n
  • \n

    The printable characters in the Basic Latin and Latin-1 Supplement character set \n (through \\u00FF)

    \n
    • \n
  • \n

    The special characters tab (\\u0009), line feed (\\u000A), and \n carriage return (\\u000D)

    \n
    • \n
\n \n

Simulation of resource-based policies isn't supported for IAM roles.

\n " + } + }, + "ResourceOwner": { + "target": "com.amazonaws.iam#ResourceNameType", + "traits": { + "smithy.api#documentation": "

An Amazon Web Services account ID that specifies the owner of any simulated resource that does not\n identify its owner in the resource ARN. Examples of resource ARNs include an S3 bucket\n or object. If ResourceOwner is specified, it is also used as the account\n owner of any ResourcePolicy included in the simulation. If the\n ResourceOwner parameter is not specified, then the owner of the\n resources and the resource policy defaults to the account of the identity provided in\n CallerArn. This parameter is required only if you specify a\n resource-based policy and account that owns the resource is different from the account\n that owns the simulated calling user CallerArn.

" + } + }, + "CallerArn": { + "target": "com.amazonaws.iam#ResourceNameType", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM user that you want to specify as the simulated caller of the API\n operations. If you do not specify a CallerArn, it defaults to the ARN of\n the user that you specify in PolicySourceArn, if you specified a user. If\n you include both a PolicySourceArn (for example,\n arn:aws:iam::123456789012:user/David) and a CallerArn (for\n example, arn:aws:iam::123456789012:user/Bob), the result is that you\n simulate calling the API operations as Bob, as if Bob had David's policies.

\n

You can specify only the ARN of an IAM user. You cannot specify the ARN of an\n assumed role, federated user, or a service principal.

\n

\n CallerArn is required if you include a ResourcePolicy and\n the PolicySourceArn is not the ARN for an IAM user. This is required so\n that the resource-based policy's Principal element has a value to use in\n evaluating the policy.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

" + } + }, + "ContextEntries": { + "target": "com.amazonaws.iam#ContextEntryListType", + "traits": { + "smithy.api#documentation": "

A list of context keys and corresponding values for the simulation to use. Whenever a\n context key is evaluated in one of the simulated IAM permissions policies, the\n corresponding value is supplied.

" + } + }, + "ResourceHandlingOption": { + "target": "com.amazonaws.iam#ResourceHandlingOptionType", + "traits": { + "smithy.api#documentation": "

Specifies the type of simulation to run. Different API operations that support\n resource-based policies require different combinations of resources. By specifying the\n type of simulation to run, you enable the policy simulator to enforce the presence of\n the required resources to ensure reliable simulation results. If your simulation does\n not match one of the following scenarios, then you can omit this parameter. The\n following list shows each of the supported scenario values and the resources that you\n must define to run the simulation.

\n

Each of the Amazon EC2 scenarios requires that you specify instance, image, and security\n group resources. If your scenario includes an EBS volume, then you must specify that\n volume as a resource. If the Amazon EC2 scenario includes VPC, then you must supply the\n network interface resource. If it includes an IP subnet, then you must specify the\n subnet resource. For more information on the Amazon EC2 scenario options, see Supported platforms in the Amazon EC2 User Guide.

\n
    \n
  • \n

    \n EC2-VPC-InstanceStore\n

    \n

    instance, image, security group, network interface

    \n
    • \n
  • \n

    \n EC2-VPC-InstanceStore-Subnet\n

    \n

    instance, image, security group, network interface, subnet

    \n
    • \n
  • \n

    \n EC2-VPC-EBS\n

    \n

    instance, image, security group, network interface, volume

    \n
    • \n
  • \n

    \n EC2-VPC-EBS-Subnet\n

    \n

    instance, image, security group, network interface, subnet, volume

    \n
    • \n
" + } + }, + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#markerType", + "traits": { + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#SimulationPolicyListType": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#policyDocumentType" + } + }, + "com.amazonaws.iam#Statement": { + "type": "structure", + "members": { + "SourcePolicyId": { + "target": "com.amazonaws.iam#PolicyIdentifierType", + "traits": { + "smithy.api#documentation": "

The identifier of the policy that was provided as an input.

" + } + }, + "SourcePolicyType": { + "target": "com.amazonaws.iam#PolicySourceType", + "traits": { + "smithy.api#documentation": "

The type of the policy.

" + } + }, + "StartPosition": { + "target": "com.amazonaws.iam#Position", + "traits": { + "smithy.api#documentation": "

The row and column of the beginning of the Statement in an IAM\n policy.

" + } + }, + "EndPosition": { + "target": "com.amazonaws.iam#Position", + "traits": { + "smithy.api#documentation": "

The row and column of the end of a Statement in an IAM policy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains a reference to a Statement element in a policy document that\n determines the result of the simulation.

\n

This data type is used by the MatchedStatements member of the \n EvaluationResult\n type.

" + } + }, + "com.amazonaws.iam#StatementListType": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#Statement" + } + }, + "com.amazonaws.iam#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.iam#tagKeyType", + "traits": { + "smithy.api#documentation": "

The key name that can be used to look up or retrieve the associated value. For example,\n Department or Cost Center are common choices.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.iam#tagValueType", + "traits": { + "smithy.api#documentation": "

The value associated with this tag. For example, tags with a key name of\n Department could have values such as Human Resources,\n Accounting, and Support. Tags with a key name of Cost\n Center might have values that consist of the number associated with the different\n cost centers in your company. Typically, many resources have tags with the same key name but\n with different values.

\n \n

Amazon Web Services always interprets the tag Value as a single string. If you need to\n store an array, you can store comma-separated values in the string. However, you must\n interpret the value in your code.

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that represents user-provided metadata that can be associated with an IAM\n resource. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

" + } + }, + "com.amazonaws.iam#TagInstanceProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#TagInstanceProfileRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds one or more tags to an IAM instance profile. If a tag with the same key name\n already exists, then that tag is overwritten with the new value.

\n

Each tag consists of a key name and an associated value. By assigning tags to your resources, you can do the\n following:

\n
    \n
  • \n

    \n Administrative grouping and discovery - Attach\n tags to resources to aid in organization and search. For example, you could search for all\n resources with the key name Project and the value\n MyImportantProject. Or search for all resources with the key name\n Cost Center and the value 41200.

    \n
    • \n
  • \n

    \n Access control - Include tags in IAM user-based\n and resource-based policies. You can use tags to restrict access to only an IAM instance\n profile that has a specified tag attached. For examples of policies that show how to use\n tags to control access, see Control access using IAM tags in the\n IAM User Guide.

    \n
    • \n
\n \n
    \n
  • \n

    If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request \n fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

    \n
    • \n
  • \n

    Amazon Web Services always interprets the tag Value as a single string. If you\n need to store an array, you can store comma-separated values in the string. However, you\n must interpret the value in your code.

    \n
    • \n
\n " + } + }, + "com.amazonaws.iam#TagInstanceProfileRequest": { + "type": "structure", + "members": { + "InstanceProfileName": { + "target": "com.amazonaws.iam#instanceProfileNameType", + "traits": { + "smithy.api#documentation": "

The name of the IAM instance profile to which you want to add tags.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.iam#tagListType", + "traits": { + "smithy.api#documentation": "

The list of tags that you want to attach to the IAM instance profile.\n Each tag consists of a key name and an associated value.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#TagMFADevice": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#TagMFADeviceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds one or more tags to an IAM virtual multi-factor authentication (MFA) device. If\n a tag with the same key name already exists, then that tag is overwritten with the new\n value.

\n

A tag consists of a key name and an associated value. By assigning tags to your\n resources, you can do the following:

\n
    \n
  • \n

    \n Administrative grouping and discovery - Attach\n tags to resources to aid in organization and search. For example, you could search for all\n resources with the key name Project and the value\n MyImportantProject. Or search for all resources with the key name\n Cost Center and the value 41200.

    \n
    • \n
  • \n

    \n Access control - Include tags in IAM user-based\n and resource-based policies. You can use tags to restrict access to only an IAM virtual\n MFA device that has a specified tag attached. For examples of policies that show how to\n use tags to control access, see Control access using IAM tags in the\n IAM User Guide.

    \n
    • \n
\n \n
    \n
  • \n

    If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request \n fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

    \n
    • \n
  • \n

    Amazon Web Services always interprets the tag Value as a single string. If you\n need to store an array, you can store comma-separated values in the string. However, you\n must interpret the value in your code.

    \n
    • \n
\n " + } + }, + "com.amazonaws.iam#TagMFADeviceRequest": { + "type": "structure", + "members": { + "SerialNumber": { + "target": "com.amazonaws.iam#serialNumberType", + "traits": { + "smithy.api#documentation": "

The unique identifier for the IAM virtual MFA device to which you want to add tags.\n For virtual MFA devices, the serial number is the same as the ARN.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.iam#tagListType", + "traits": { + "smithy.api#documentation": "

The list of tags that you want to attach to the IAM virtual MFA device.\n Each tag consists of a key name and an associated value.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#TagOpenIDConnectProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#TagOpenIDConnectProviderRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds one or more tags to an OpenID Connect (OIDC)-compatible identity provider. For\n more information about these providers, see About web identity federation. If\n a tag with the same key name already exists, then that tag is overwritten with the new\n value.

\n

A tag consists of a key name and an associated value. By assigning tags to your\n resources, you can do the following:

\n
    \n
  • \n

    \n Administrative grouping and discovery - Attach\n tags to resources to aid in organization and search. For example, you could search for all\n resources with the key name Project and the value\n MyImportantProject. Or search for all resources with the key name\n Cost Center and the value 41200.

    \n
    • \n
  • \n

    \n Access control - Include tags in IAM identity-based\n and resource-based policies. You can use tags to restrict access to only an OIDC provider\n that has a specified tag attached. For examples of policies that show how to use tags to\n control access, see Control access using IAM tags in the\n IAM User Guide.

    \n
    • \n
\n \n
    \n
  • \n

    If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request \n fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

    \n
    • \n
  • \n

    Amazon Web Services always interprets the tag Value as a single string. If you\n need to store an array, you can store comma-separated values in the string. However, you\n must interpret the value in your code.

    \n
    • \n
\n " + } + }, + "com.amazonaws.iam#TagOpenIDConnectProviderRequest": { + "type": "structure", + "members": { + "OpenIDConnectProviderArn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The ARN of the OIDC identity provider in IAM to which you want to add tags.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.iam#tagListType", + "traits": { + "smithy.api#documentation": "

The list of tags that you want to attach to the OIDC identity provider in IAM.\n Each tag consists of a key name and an associated value.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#TagPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#TagPolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds one or more tags to an IAM customer managed policy. If a tag with the same key\n name already exists, then that tag is overwritten with the new value.

\n

A tag consists of a key name and an associated value. By assigning tags to your\n resources, you can do the following:

\n
    \n
  • \n

    \n Administrative grouping and discovery - Attach\n tags to resources to aid in organization and search. For example, you could search for all\n resources with the key name Project and the value\n MyImportantProject. Or search for all resources with the key name\n Cost Center and the value 41200.

    \n
    • \n
  • \n

    \n Access control - Include tags in IAM user-based\n and resource-based policies. You can use tags to restrict access to only an IAM customer\n managed policy that has a specified tag attached. For examples of policies that show how\n to use tags to control access, see Control access using IAM tags in the\n IAM User Guide.

    \n
    • \n
\n \n
    \n
  • \n

    If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request \n fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

    \n
    • \n
  • \n

    Amazon Web Services always interprets the tag Value as a single string. If you\n need to store an array, you can store comma-separated values in the string. However, you\n must interpret the value in your code.

    \n
    • \n
\n " + } + }, + "com.amazonaws.iam#TagPolicyRequest": { + "type": "structure", + "members": { + "PolicyArn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM customer managed policy to which you want to add tags.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.iam#tagListType", + "traits": { + "smithy.api#documentation": "

The list of tags that you want to attach to the IAM customer managed policy.\n Each tag consists of a key name and an associated value.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#TagRole": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#TagRoleRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds one or more tags to an IAM role. The role can be a regular role or a\n service-linked role. If a tag with the same key name already exists, then that tag is\n overwritten with the new value.

\n

A tag consists of a key name and an associated value. By assigning tags to your\n resources, you can do the following:

\n
    \n
  • \n

    \n Administrative grouping and discovery - Attach\n tags to resources to aid in organization and search. For example, you could search for all\n resources with the key name Project and the value\n MyImportantProject. Or search for all resources with the key name\n Cost Center and the value 41200.

    \n
    • \n
  • \n

    \n Access control - Include tags in IAM user-based\n and resource-based policies. You can use tags to restrict access to only an IAM role\n that has a specified tag attached. You can also restrict access to only those resources\n that have a certain tag attached. For examples of policies that show how to use tags to\n control access, see Control access using IAM tags in the\n IAM User Guide.

    \n
    • \n
  • \n

    \n Cost allocation - Use tags to help track which\n individuals and teams are using which Amazon Web Services resources.

    \n
    • \n
\n \n
    \n
  • \n

    If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request \n fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

    \n
    • \n
  • \n

    Amazon Web Services always interprets the tag Value as a single string. If you\n need to store an array, you can store comma-separated values in the string. However, you\n must interpret the value in your code.

    \n
    • \n
\n \n

For more information about tagging, see Tagging IAM identities in the\n IAM User Guide.

", + "smithy.api#examples": [ + { + "title": "To add a tag key and value to an IAM role", + "documentation": "The following example shows how to add tags to an existing role.", + "input": { + "RoleName": "taggedrole", + "Tags": [ + { + "Key": "Dept", + "Value": "Accounting" + }, + { + "Key": "CostCenter", + "Value": "12345" + } + ] + } + } + ] + } + }, + "com.amazonaws.iam#TagRoleRequest": { + "type": "structure", + "members": { + "RoleName": { + "target": "com.amazonaws.iam#roleNameType", + "traits": { + "smithy.api#documentation": "

The name of the IAM role to which you want to add tags.

\n

This parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.iam#tagListType", + "traits": { + "smithy.api#documentation": "

The list of tags that you want to attach to the IAM role. Each tag consists of a key name and an associated value.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#TagSAMLProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#TagSAMLProviderRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds one or more tags to a Security Assertion Markup Language (SAML) identity provider.\n For more information about these providers, see About SAML 2.0-based federation .\n If a tag with the same key name already exists, then that tag is overwritten with the new\n value.

\n

A tag consists of a key name and an associated value. By assigning tags to your\n resources, you can do the following:

\n
    \n
  • \n

    \n Administrative grouping and discovery - Attach\n tags to resources to aid in organization and search. For example, you could search for all\n resources with the key name Project and the value\n MyImportantProject. Or search for all resources with the key name\n Cost Center and the value 41200.

    \n
    • \n
  • \n

    \n Access control - Include tags in IAM user-based\n and resource-based policies. You can use tags to restrict access to only a SAML identity\n provider that has a specified tag attached. For examples of policies that show how to use\n tags to control access, see Control access using IAM tags in the\n IAM User Guide.

    \n
    • \n
\n \n
    \n
  • \n

    If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request \n fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

    \n
    • \n
  • \n

    Amazon Web Services always interprets the tag Value as a single string. If you\n need to store an array, you can store comma-separated values in the string. However, you\n must interpret the value in your code.

    \n
    • \n
\n " + } + }, + "com.amazonaws.iam#TagSAMLProviderRequest": { + "type": "structure", + "members": { + "SAMLProviderArn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The ARN of the SAML identity provider in IAM to which you want to add tags.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.iam#tagListType", + "traits": { + "smithy.api#documentation": "

The list of tags that you want to attach to the SAML identity provider in IAM.\n Each tag consists of a key name and an associated value.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#TagServerCertificate": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#TagServerCertificateRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds one or more tags to an IAM server certificate. If a tag with the same key name\n already exists, then that tag is overwritten with the new value.

\n \n

For certificates in a Region supported by Certificate Manager (ACM), we\n recommend that you don't use IAM server certificates. Instead, use ACM to provision,\n manage, and deploy your server certificates. For more information about IAM server\n certificates, Working with server\n certificates in the IAM User Guide.

\n \n

A tag consists of a key name and an associated value. By assigning tags to your\n resources, you can do the following:

\n
    \n
  • \n

    \n Administrative grouping and discovery - Attach\n tags to resources to aid in organization and search. For example, you could search for all\n resources with the key name Project and the value\n MyImportantProject. Or search for all resources with the key name\n Cost Center and the value 41200.

    \n
    • \n
  • \n

    \n Access control - Include tags in IAM user-based\n and resource-based policies. You can use tags to restrict access to only a server\n certificate that has a specified tag attached. For examples of policies that show how to\n use tags to control access, see Control access using IAM tags in the\n IAM User Guide.

    \n
    • \n
  • \n

    \n Cost allocation - Use tags to help track which\n individuals and teams are using which Amazon Web Services resources.

    \n
    • \n
\n \n
    \n
  • \n

    If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request \n fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

    \n
    • \n
  • \n

    Amazon Web Services always interprets the tag Value as a single string. If you\n need to store an array, you can store comma-separated values in the string. However, you\n must interpret the value in your code.

    \n
    • \n
\n " + } + }, + "com.amazonaws.iam#TagServerCertificateRequest": { + "type": "structure", + "members": { + "ServerCertificateName": { + "target": "com.amazonaws.iam#serverCertificateNameType", + "traits": { + "smithy.api#documentation": "

The name of the IAM server certificate to which you want to add tags.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.iam#tagListType", + "traits": { + "smithy.api#documentation": "

The list of tags that you want to attach to the IAM server certificate.\n Each tag consists of a key name and an associated value.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#TagUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#TagUserRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds one or more tags to an IAM user. If a tag with the same key name already exists,\n then that tag is overwritten with the new value.

\n

A tag consists of a key name and an associated value. By assigning tags to your\n resources, you can do the following:

\n
    \n
  • \n

    \n Administrative grouping and discovery - Attach\n tags to resources to aid in organization and search. For example, you could search for all\n resources with the key name Project and the value\n MyImportantProject. Or search for all resources with the key name\n Cost Center and the value 41200.

    \n
    • \n
  • \n

    \n Access control - Include tags in IAM identity-based\n and resource-based policies. You can use tags to restrict access to only an IAM\n requesting user that has a specified tag attached. You can also restrict access to only\n those resources that have a certain tag attached. For examples of policies that show how\n to use tags to control access, see Control access using IAM tags in the\n IAM User Guide.

    \n
    • \n
  • \n

    \n Cost allocation - Use tags to help track which\n individuals and teams are using which Amazon Web Services resources.

    \n
    • \n
\n \n
    \n
  • \n

    If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request \n fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

    \n
    • \n
  • \n

    Amazon Web Services always interprets the tag Value as a single string. If you\n need to store an array, you can store comma-separated values in the string. However, you\n must interpret the value in your code.

    \n
    • \n
\n \n

For more information about tagging, see Tagging IAM identities in the\n IAM User Guide.

", + "smithy.api#examples": [ + { + "title": "To add a tag key and value to an IAM user", + "documentation": "The following example shows how to add tags to an existing user.", + "input": { + "UserName": "anika", + "Tags": [ + { + "Key": "Dept", + "Value": "Accounting" + }, + { + "Key": "CostCenter", + "Value": "12345" + } + ] + } + } + ] + } + }, + "com.amazonaws.iam#TagUserRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#existingUserNameType", + "traits": { + "smithy.api#documentation": "

The name of the IAM user to which you want to add tags.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.iam#tagListType", + "traits": { + "smithy.api#documentation": "

The list of tags that you want to attach to the IAM user. Each tag consists of a key name and an associated value.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#TrackedActionLastAccessed": { + "type": "structure", + "members": { + "ActionName": { + "target": "com.amazonaws.iam#stringType", + "traits": { + "smithy.api#documentation": "

The name of the tracked action to which access was attempted. Tracked actions are\n actions that report activity to IAM.

" + } + }, + "LastAccessedEntity": { + "target": "com.amazonaws.iam#arnType" + }, + "LastAccessedTime": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when an authenticated entity most recently attempted to access the\n tracked service. Amazon Web Services does not report unauthenticated requests.

\n

This field is null if no IAM entities attempted to access the service within the\n tracking period.

" + } + }, + "LastAccessedRegion": { + "target": "com.amazonaws.iam#stringType", + "traits": { + "smithy.api#documentation": "

The Region from which the authenticated entity (user or role) last attempted to access\n the tracked action. Amazon Web Services does not report unauthenticated requests.

\n

This field is null if no IAM entities attempted to access the service within the\n tracking period.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about the most recent attempt to access an action within the\n service.

\n

This data type is used as a response element in the GetServiceLastAccessedDetails operation.

" + } + }, + "com.amazonaws.iam#TrackedActionsLastAccessed": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#TrackedActionLastAccessed" + } + }, + "com.amazonaws.iam#UnmodifiableEntityException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iam#unmodifiableEntityMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "UnmodifiableEntity", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request was rejected because service-linked roles are protected Amazon Web Services resources. Only\n the service that depends on the service-linked role can modify or delete the role on your\n behalf. The error message includes the name of the service that depends on this service-linked\n role. You must request the change through that service.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.iam#UnrecognizedPublicKeyEncodingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iam#unrecognizedPublicKeyEncodingMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "UnrecognizedPublicKeyEncoding", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request was rejected because the public key encoding format is unsupported or\n unrecognized.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.iam#UntagInstanceProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#UntagInstanceProfileRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes the specified tags from the IAM instance profile. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

" + } + }, + "com.amazonaws.iam#UntagInstanceProfileRequest": { + "type": "structure", + "members": { + "InstanceProfileName": { + "target": "com.amazonaws.iam#instanceProfileNameType", + "traits": { + "smithy.api#documentation": "

The name of the IAM instance profile from which you want to remove tags.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.iam#tagKeyListType", + "traits": { + "smithy.api#documentation": "

A list of key names as a simple array of strings. The tags with matching keys are\n removed from the specified instance profile.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#UntagMFADevice": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#UntagMFADeviceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes the specified tags from the IAM virtual multi-factor authentication (MFA)\n device. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

" + } + }, + "com.amazonaws.iam#UntagMFADeviceRequest": { + "type": "structure", + "members": { + "SerialNumber": { + "target": "com.amazonaws.iam#serialNumberType", + "traits": { + "smithy.api#documentation": "

The unique identifier for the IAM virtual MFA device from which you want to remove\n tags. For virtual MFA devices, the serial number is the same as the ARN.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.iam#tagKeyListType", + "traits": { + "smithy.api#documentation": "

A list of key names as a simple array of strings. The tags with matching keys are\n removed from the specified instance profile.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#UntagOpenIDConnectProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#UntagOpenIDConnectProviderRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes the specified tags from the specified OpenID Connect (OIDC)-compatible identity\n provider in IAM. For more information about OIDC providers, see About web identity federation.\n For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

" + } + }, + "com.amazonaws.iam#UntagOpenIDConnectProviderRequest": { + "type": "structure", + "members": { + "OpenIDConnectProviderArn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The ARN of the OIDC provider in IAM from which you want to remove tags.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.iam#tagKeyListType", + "traits": { + "smithy.api#documentation": "

A list of key names as a simple array of strings. The tags with matching keys are\n removed from the specified OIDC provider.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#UntagPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#UntagPolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes the specified tags from the customer managed policy. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

" + } + }, + "com.amazonaws.iam#UntagPolicyRequest": { + "type": "structure", + "members": { + "PolicyArn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM customer managed policy from which you want to remove\n tags.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.iam#tagKeyListType", + "traits": { + "smithy.api#documentation": "

A list of key names as a simple array of strings. The tags with matching keys are\n removed from the specified policy.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#UntagRole": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#UntagRoleRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes the specified tags from the role. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

", + "smithy.api#examples": [ + { + "title": "To remove a tag from an IAM role", + "documentation": "The following example shows how to remove a tag with the key 'Dept' from a role named 'taggedrole'.", + "input": { + "RoleName": "taggedrole", + "TagKeys": [ + "Dept" + ] + } + } + ] + } + }, + "com.amazonaws.iam#UntagRoleRequest": { + "type": "structure", + "members": { + "RoleName": { + "target": "com.amazonaws.iam#roleNameType", + "traits": { + "smithy.api#documentation": "

The name of the IAM role from which you want to remove tags.

\n

This parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.iam#tagKeyListType", + "traits": { + "smithy.api#documentation": "

A list of key names as a simple array of strings. The tags with matching keys are\n removed from the specified role.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#UntagSAMLProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#UntagSAMLProviderRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes the specified tags from the specified Security Assertion Markup Language (SAML)\n identity provider in IAM. For more information about these providers, see About web identity\n federation. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

" + } + }, + "com.amazonaws.iam#UntagSAMLProviderRequest": { + "type": "structure", + "members": { + "SAMLProviderArn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The ARN of the SAML identity provider in IAM from which you want to remove\n tags.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.iam#tagKeyListType", + "traits": { + "smithy.api#documentation": "

A list of key names as a simple array of strings. The tags with matching keys are\n removed from the specified SAML identity provider.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#UntagServerCertificate": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#UntagServerCertificateRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes the specified tags from the IAM server certificate.\n For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

\n \n

For certificates in a Region supported by Certificate Manager (ACM), we\n recommend that you don't use IAM server certificates. Instead, use ACM to provision,\n manage, and deploy your server certificates. For more information about IAM server\n certificates, Working with server\n certificates in the IAM User Guide.

\n " + } + }, + "com.amazonaws.iam#UntagServerCertificateRequest": { + "type": "structure", + "members": { + "ServerCertificateName": { + "target": "com.amazonaws.iam#serverCertificateNameType", + "traits": { + "smithy.api#documentation": "

The name of the IAM server certificate from which you want to remove tags.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.iam#tagKeyListType", + "traits": { + "smithy.api#documentation": "

A list of key names as a simple array of strings. The tags with matching keys are\n removed from the specified IAM server certificate.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#UntagUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#UntagUserRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes the specified tags from the user. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

", + "smithy.api#examples": [ + { + "title": "To remove a tag from an IAM user", + "documentation": "The following example shows how to remove tags that are attached to a user named 'anika'.", + "input": { + "UserName": "anika", + "TagKeys": [ + "Dept" + ] + } + } + ] + } + }, + "com.amazonaws.iam#UntagUserRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#existingUserNameType", + "traits": { + "smithy.api#documentation": "

The name of the IAM user from which you want to remove tags.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.iam#tagKeyListType", + "traits": { + "smithy.api#documentation": "

A list of key names as a simple array of strings. The tags with matching keys are\n removed from the specified user.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#UpdateAccessKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#UpdateAccessKeyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Changes the status of the specified access key from Active to Inactive, or vice versa.\n This operation can be used to disable a user's key as part of a key rotation\n workflow.

\n

If the UserName is not specified, the user name is determined implicitly\n based on the Amazon Web Services access key ID used to sign the request. If a temporary access key is\n used, then UserName is required. If a long-term key is assigned to the\n user, then UserName is not required. This operation works for access keys\n under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user\n credentials even if the Amazon Web Services account has no associated users.

\n

For information about rotating keys, see Managing keys and certificates\n in the IAM User Guide.

", + "smithy.api#examples": [ + { + "title": "To activate or deactivate an access key for an IAM user", + "documentation": "The following command deactivates the specified access key (access key ID and secret access key) for the IAM user named Bob.", + "input": { + "UserName": "Bob", + "Status": "Inactive", + "AccessKeyId": "AKIAIOSFODNN7EXAMPLE" + } + } + ] + } + }, + "com.amazonaws.iam#UpdateAccessKeyRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#existingUserNameType", + "traits": { + "smithy.api#documentation": "

The name of the user whose key you want to update.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } + }, + "AccessKeyId": { + "target": "com.amazonaws.iam#accessKeyIdType", + "traits": { + "smithy.api#documentation": "

The access key ID of the secret access key you want to update.

\n

This parameter allows (through its regex pattern) a string of characters that can \n consist of any upper or lowercased letter or digit.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.iam#statusType", + "traits": { + "smithy.api#documentation": "

The status you want to assign to the secret access key. Active means\n that the key can be used for programmatic calls to Amazon Web Services, while Inactive\n means that the key cannot be used.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#UpdateAccountPasswordPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#UpdateAccountPasswordPolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#MalformedPolicyDocumentException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the password policy settings for the Amazon Web Services account.

\n \n

This operation does not support partial updates. No parameters are required, but\n if you do not specify a parameter, that parameter's value reverts to its default\n value. See the Request Parameters section for each\n parameter's default value. Also note that some parameters do not allow the default\n parameter to be explicitly set. Instead, to invoke the default value, do not include\n that parameter when you invoke the operation.

\n \n

For more information about using a password policy, see Managing an IAM password\n policy in the IAM User Guide.

", + "smithy.api#examples": [ + { + "title": "To set or change the current account password policy", + "documentation": "The following command sets the password policy to require a minimum length of eight characters and to require one or more numbers in the password:", + "input": { + "MinimumPasswordLength": 8, + "RequireNumbers": true + } + } + ] + } + }, + "com.amazonaws.iam#UpdateAccountPasswordPolicyRequest": { + "type": "structure", + "members": { + "MinimumPasswordLength": { + "target": "com.amazonaws.iam#minimumPasswordLengthType", + "traits": { + "smithy.api#documentation": "

The minimum number of characters allowed in an IAM user password.

\n

If you do not specify a value for this parameter, then the operation uses the default\n value of 6.

" + } + }, + "RequireSymbols": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether IAM user passwords must contain at least one of the following\n non-alphanumeric characters:

\n

! @ # $ % ^ & * ( ) _ + - = [ ] { } | '

\n

If you do not specify a value for this parameter, then the operation uses the default\n value of false. The result is that passwords do not require at least one\n symbol character.

" + } + }, + "RequireNumbers": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether IAM user passwords must contain at least one numeric character (0\n to 9).

\n

If you do not specify a value for this parameter, then the operation uses the default\n value of false. The result is that passwords do not require at least one\n numeric character.

" + } + }, + "RequireUppercaseCharacters": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether IAM user passwords must contain at least one uppercase character\n from the ISO basic Latin alphabet (A to Z).

\n

If you do not specify a value for this parameter, then the operation uses the default\n value of false. The result is that passwords do not require at least one\n uppercase character.

" + } + }, + "RequireLowercaseCharacters": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether IAM user passwords must contain at least one lowercase character\n from the ISO basic Latin alphabet (a to z).

\n

If you do not specify a value for this parameter, then the operation uses the default\n value of false. The result is that passwords do not require at least one\n lowercase character.

" + } + }, + "AllowUsersToChangePassword": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Allows all IAM users in your account to use the Amazon Web Services Management Console to change their own\n passwords. For more information, see Permitting\n IAM users to change their own passwords in the\n IAM User Guide.

\n

If you do not specify a value for this parameter, then the operation uses the default\n value of false. The result is that IAM users in the account do not\n automatically have permissions to change their own password.

" + } + }, + "MaxPasswordAge": { + "target": "com.amazonaws.iam#maxPasswordAgeType", + "traits": { + "smithy.api#documentation": "

The number of days that an IAM user password is valid.

\n

If you do not specify a value for this parameter, then the operation uses the default\n value of 0. The result is that IAM user passwords never expire.

" + } + }, + "PasswordReusePrevention": { + "target": "com.amazonaws.iam#passwordReusePreventionType", + "traits": { + "smithy.api#documentation": "

Specifies the number of previous passwords that IAM users are prevented from\n reusing.

\n

If you do not specify a value for this parameter, then the operation uses the default\n value of 0. The result is that IAM users are not prevented from reusing\n previous passwords.

" + } + }, + "HardExpiry": { + "target": "com.amazonaws.iam#booleanObjectType", + "traits": { + "smithy.api#documentation": "

Prevents IAM users who are accessing the account via the Amazon Web Services Management Console from setting a\n new console password after their password has expired. The IAM user cannot access the\n console until an administrator resets the password.

\n

If you do not specify a value for this parameter, then the operation uses the default\n value of false. The result is that IAM users can change their passwords\n after they expire and continue to sign in as the user.

\n \n

In the Amazon Web Services Management Console, the custom password policy option Allow\n users to change their own password gives IAM users permissions to\n iam:ChangePassword for only their user and to the\n iam:GetAccountPasswordPolicy action. This option does not attach a\n permissions policy to each user, rather the permissions are applied at the\n account-level for all users by IAM. IAM users with\n iam:ChangePassword permission and active access keys can reset\n their own expired console password using the CLI or API.

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#UpdateAssumeRolePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#UpdateAssumeRolePolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#MalformedPolicyDocumentException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + }, + { + "target": "com.amazonaws.iam#UnmodifiableEntityException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the policy that grants an IAM entity permission to assume a role. This is\n typically referred to as the \"role trust policy\". For more information about roles, see\n Using roles to\n delegate permissions and federate identities.

", + "smithy.api#examples": [ + { + "title": "To update the trust policy for an IAM role", + "documentation": "The following command updates the role trust policy for the role named Test-Role:", + "input": { + "PolicyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"Service\":[\"ec2.amazonaws.com\"]},\"Action\":[\"sts:AssumeRole\"]}]}", + "RoleName": "S3AccessForEC2Instances" + } + } + ] + } + }, + "com.amazonaws.iam#UpdateAssumeRolePolicyRequest": { + "type": "structure", + "members": { + "RoleName": { + "target": "com.amazonaws.iam#roleNameType", + "traits": { + "smithy.api#documentation": "

The name of the role to update with the new policy.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "PolicyDocument": { + "target": "com.amazonaws.iam#policyDocumentType", + "traits": { + "smithy.api#documentation": "

The policy that grants an entity permission to assume the role.

\n

You must provide policies in JSON format in IAM. However, for CloudFormation\n templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to\n IAM.

\n

The regex pattern \n used to validate this parameter is a string of characters consisting of the following:

\n
    \n
  • \n

    Any printable ASCII \n character ranging from the space character (\\u0020) through the end of the ASCII character range

    \n
    • \n
  • \n

    The printable characters in the Basic Latin and Latin-1 Supplement character set \n (through \\u00FF)

    \n
    • \n
  • \n

    The special characters tab (\\u0009), line feed (\\u000A), and \n carriage return (\\u000D)

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#UpdateGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#UpdateGroupRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#EntityAlreadyExistsException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the name and/or the path of the specified IAM group.

\n \n

You should understand the implications of changing a group's path or name. For\n more information, see Renaming users and\n groups in the IAM User Guide.

\n \n \n

The person making the request (the principal), must have permission to change the\n role group with the old name and the new name. For example, to change the group\n named Managers to MGRs, the principal must have a policy\n that allows them to update both groups. If the principal has permission to update\n the Managers group, but not the MGRs group, then the\n update fails. For more information about permissions, see Access management.\n

\n ", + "smithy.api#examples": [ + { + "title": "To rename an IAM group", + "documentation": "The following command changes the name of the IAM group Test to Test-1.", + "input": { + "GroupName": "Test", + "NewGroupName": "Test-1" + } + } + ] + } + }, + "com.amazonaws.iam#UpdateGroupRequest": { + "type": "structure", + "members": { + "GroupName": { + "target": "com.amazonaws.iam#groupNameType", + "traits": { + "smithy.api#documentation": "

Name of the IAM group to update. If you're changing the name of the group, this is\n the original name.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "NewPath": { + "target": "com.amazonaws.iam#pathType", + "traits": { + "smithy.api#documentation": "

New path for the IAM group. Only include this if changing the group's path.

\n

This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including \n most punctuation characters, digits, and upper and lowercased letters.

" + } + }, + "NewGroupName": { + "target": "com.amazonaws.iam#groupNameType", + "traits": { + "smithy.api#documentation": "

New name for the IAM group. Only include this if changing the group's name.

\n

IAM user, group, role, and policy names must be unique within the account. Names are\n not distinguished by case. For example, you cannot create resources named both\n \"MyResource\" and \"myresource\".

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#UpdateLoginProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#UpdateLoginProfileRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#EntityTemporarilyUnmodifiableException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#PasswordPolicyViolationException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Changes the password for the specified IAM user. You can use the CLI, the Amazon Web Services\n API, or the Users page in the IAM console to change\n the password for any IAM user. Use ChangePassword to change your own\n password in the My Security Credentials page in the\n Amazon Web Services Management Console.

\n

For more information about modifying passwords, see Managing passwords in the\n IAM User Guide.

", + "smithy.api#examples": [ + { + "title": "To change the password for an IAM user", + "documentation": "The following command creates or changes the password for the IAM user named Bob.", + "input": { + "UserName": "Bob", + "Password": "SomeKindOfPassword123!@#" + } + } + ] + } + }, + "com.amazonaws.iam#UpdateLoginProfileRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#userNameType", + "traits": { + "smithy.api#documentation": "

The name of the user whose password you want to update.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "Password": { + "target": "com.amazonaws.iam#passwordType", + "traits": { + "smithy.api#documentation": "

The new password for the specified IAM user.

\n

The regex pattern \n used to validate this parameter is a string of characters consisting of the following:

\n
    \n
  • \n

    Any printable ASCII \n character ranging from the space character (\\u0020) through the end of the ASCII character range

    \n
    • \n
  • \n

    The printable characters in the Basic Latin and Latin-1 Supplement character set \n (through \\u00FF)

    \n
    • \n
  • \n

    The special characters tab (\\u0009), line feed (\\u000A), and \n carriage return (\\u000D)

    \n
    • \n
\n

However, the format can be further restricted by the account administrator by setting\n a password policy on the Amazon Web Services account. For more information, see UpdateAccountPasswordPolicy.

" + } + }, + "PasswordResetRequired": { + "target": "com.amazonaws.iam#booleanObjectType", + "traits": { + "smithy.api#documentation": "

Allows this new password to be used only once by requiring the specified IAM user to\n set a new password on next sign-in.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#UpdateOpenIDConnectProviderThumbprint": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#UpdateOpenIDConnectProviderThumbprintRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Replaces the existing list of server certificate thumbprints associated with an OpenID\n Connect (OIDC) provider resource object with a new list of thumbprints.

\n

The list that you pass with this operation completely replaces the existing list of\n thumbprints. (The lists are not merged.)

\n

Typically, you need to update a thumbprint only when the identity provider certificate\n changes, which occurs rarely. However, if the provider's certificate\n does change, any attempt to assume an IAM role that specifies\n the OIDC provider as a principal fails until the certificate thumbprint is\n updated.

\n \n

Amazon Web Services secures communication with OIDC identity providers (IdPs) using our library of\n trusted root certificate authorities (CAs) to verify the JSON Web Key Set (JWKS)\n endpoint's TLS certificate. If your OIDC IdP relies on a certificate that is not signed\n by one of these trusted CAs, only then we secure communication using the thumbprints set\n in the IdP's configuration.

\n \n \n

Trust for the OIDC provider is derived from the provider certificate and is\n validated by the thumbprint. Therefore, it is best to limit access to the\n UpdateOpenIDConnectProviderThumbprint operation to highly\n privileged users.

\n " + } + }, + "com.amazonaws.iam#UpdateOpenIDConnectProviderThumbprintRequest": { + "type": "structure", + "members": { + "OpenIDConnectProviderArn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM OIDC provider resource object for which\n you want to update the thumbprint. You can get a list of OIDC provider ARNs by using the\n ListOpenIDConnectProviders operation.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

", + "smithy.api#required": {} + } + }, + "ThumbprintList": { + "target": "com.amazonaws.iam#thumbprintListType", + "traits": { + "smithy.api#documentation": "

A list of certificate thumbprints that are associated with the specified IAM OpenID\n Connect provider. For more information, see CreateOpenIDConnectProvider.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#UpdateRole": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#UpdateRoleRequest" + }, + "output": { + "target": "com.amazonaws.iam#UpdateRoleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + }, + { + "target": "com.amazonaws.iam#UnmodifiableEntityException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the description or maximum session duration setting of a role.

" + } + }, + "com.amazonaws.iam#UpdateRoleDescription": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#UpdateRoleDescriptionRequest" + }, + "output": { + "target": "com.amazonaws.iam#UpdateRoleDescriptionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + }, + { + "target": "com.amazonaws.iam#UnmodifiableEntityException" + } + ], + "traits": { + "smithy.api#documentation": "

Use UpdateRole instead.

\n

Modifies only the description of a role. This operation performs the same function as\n the Description parameter in the UpdateRole operation.

" + } + }, + "com.amazonaws.iam#UpdateRoleDescriptionRequest": { + "type": "structure", + "members": { + "RoleName": { + "target": "com.amazonaws.iam#roleNameType", + "traits": { + "smithy.api#documentation": "

The name of the role that you want to modify.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.iam#roleDescriptionType", + "traits": { + "smithy.api#documentation": "

The new description that you want to apply to the specified role.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#UpdateRoleDescriptionResponse": { + "type": "structure", + "members": { + "Role": { + "target": "com.amazonaws.iam#Role", + "traits": { + "smithy.api#documentation": "

A structure that contains details about the modified role.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#UpdateRoleRequest": { + "type": "structure", + "members": { + "RoleName": { + "target": "com.amazonaws.iam#roleNameType", + "traits": { + "smithy.api#documentation": "

The name of the role that you want to modify.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.iam#roleDescriptionType", + "traits": { + "smithy.api#documentation": "

The new description that you want to apply to the specified role.

" + } + }, + "MaxSessionDuration": { + "target": "com.amazonaws.iam#roleMaxSessionDurationType", + "traits": { + "smithy.api#documentation": "

The maximum session duration (in seconds) that you want to set for the specified role.\n If you do not specify a value for this setting, the default value of one hour is\n applied. This setting can have a value from 1 hour to 12 hours.

\n

Anyone who assumes the role from the CLI or API can use the\n DurationSeconds API parameter or the duration-seconds\n CLI parameter to request a longer session. The MaxSessionDuration setting\n determines the maximum duration that can be requested using the\n DurationSeconds parameter. If users don't specify a value for the\n DurationSeconds parameter, their security credentials are valid for one\n hour by default. This applies when you use the AssumeRole* API operations\n or the assume-role* CLI operations but does not apply when you use those\n operations to create a console URL. For more information, see Using IAM\n roles in the IAM User Guide.

\n \n

IAM role credentials provided by Amazon EC2 instances assigned to the role are not\n subject to the specified maximum session duration.

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#UpdateRoleResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#UpdateSAMLProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#UpdateSAMLProviderRequest" + }, + "output": { + "target": "com.amazonaws.iam#UpdateSAMLProviderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the metadata document for an existing SAML provider resource object.

\n \n

This operation requires Signature Version 4.

\n " + } + }, + "com.amazonaws.iam#UpdateSAMLProviderRequest": { + "type": "structure", + "members": { + "SAMLMetadataDocument": { + "target": "com.amazonaws.iam#SAMLMetadataDocumentType", + "traits": { + "smithy.api#documentation": "

An XML document generated by an identity provider (IdP) that supports SAML 2.0. The\n document includes the issuer's name, expiration information, and keys that can be used\n to validate the SAML authentication response (assertions) that are received from the\n IdP. You must generate the metadata document using the identity management software that\n is used as your organization's IdP.

", + "smithy.api#required": {} + } + }, + "SAMLProviderArn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SAML provider to update.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#UpdateSAMLProviderResponse": { + "type": "structure", + "members": { + "SAMLProviderArn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SAML provider that was updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful UpdateSAMLProvider request.\n

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#UpdateSSHPublicKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#UpdateSSHPublicKeyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#NoSuchEntityException" + } + ], + "traits": { + "smithy.api#documentation": "

Sets the status of an IAM user's SSH public key to active or inactive. SSH public\n keys that are inactive cannot be used for authentication. This operation can be used to\n disable a user's SSH public key as part of a key rotation work flow.

\n

The SSH public key affected by this operation is used only for authenticating the\n associated IAM user to an CodeCommit repository. For more information about using SSH keys\n to authenticate to an CodeCommit repository, see Set up CodeCommit for\n SSH connections in the CodeCommit User Guide.

" + } + }, + "com.amazonaws.iam#UpdateSSHPublicKeyRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#userNameType", + "traits": { + "smithy.api#documentation": "

The name of the IAM user associated with the SSH public key.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "SSHPublicKeyId": { + "target": "com.amazonaws.iam#publicKeyIdType", + "traits": { + "smithy.api#documentation": "

The unique identifier for the SSH public key.

\n

This parameter allows (through its regex pattern) a string of characters that can \n consist of any upper or lowercased letter or digit.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.iam#statusType", + "traits": { + "smithy.api#documentation": "

The status to assign to the SSH public key. Active means that the key can\n be used for authentication with an CodeCommit repository. Inactive means that\n the key cannot be used.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#UpdateServerCertificate": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#UpdateServerCertificateRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#EntityAlreadyExistsException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the name and/or the path of the specified server certificate stored in\n IAM.

\n

For more information about working with server certificates, see Working\n with server certificates in the IAM User Guide. This\n topic also includes a list of Amazon Web Services services that can use the server certificates that\n you manage with IAM.

\n \n

You should understand the implications of changing a server certificate's path or\n name. For more information, see Renaming a server certificate in the\n IAM User Guide.

\n \n \n

The person making the request (the principal), must have permission to change the\n server certificate with the old name and the new name. For example, to change the\n certificate named ProductionCert to ProdCert, the\n principal must have a policy that allows them to update both certificates. If the\n principal has permission to update the ProductionCert group, but not\n the ProdCert certificate, then the update fails. For more information\n about permissions, see Access management in the IAM User Guide.

\n " + } + }, + "com.amazonaws.iam#UpdateServerCertificateRequest": { + "type": "structure", + "members": { + "ServerCertificateName": { + "target": "com.amazonaws.iam#serverCertificateNameType", + "traits": { + "smithy.api#documentation": "

The name of the server certificate that you want to update.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "NewPath": { + "target": "com.amazonaws.iam#pathType", + "traits": { + "smithy.api#documentation": "

The new path for the server certificate. Include this only if you are updating the\n server certificate's path.

\n

This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including \n most punctuation characters, digits, and upper and lowercased letters.

" + } + }, + "NewServerCertificateName": { + "target": "com.amazonaws.iam#serverCertificateNameType", + "traits": { + "smithy.api#documentation": "

The new name for the server certificate. Include this only if you are updating the\n server certificate's name. The name of the certificate cannot contain any spaces.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#UpdateServiceSpecificCredential": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#UpdateServiceSpecificCredentialRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#NoSuchEntityException" + } + ], + "traits": { + "smithy.api#documentation": "

Sets the status of a service-specific credential to Active or\n Inactive. Service-specific credentials that are inactive cannot be used\n for authentication to the service. This operation can be used to disable a user's\n service-specific credential as part of a credential rotation work flow.

" + } + }, + "com.amazonaws.iam#UpdateServiceSpecificCredentialRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#userNameType", + "traits": { + "smithy.api#documentation": "

The name of the IAM user associated with the service-specific credential. If you do\n not specify this value, then the operation assumes the user whose credentials are used\n to call the operation.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } + }, + "ServiceSpecificCredentialId": { + "target": "com.amazonaws.iam#serviceSpecificCredentialId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the service-specific credential.

\n

This parameter allows (through its regex pattern) a string of characters that can \n consist of any upper or lowercased letter or digit.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.iam#statusType", + "traits": { + "smithy.api#documentation": "

The status to be assigned to the service-specific credential.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#UpdateSigningCertificate": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#UpdateSigningCertificateRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Changes the status of the specified user signing certificate from active to disabled,\n or vice versa. This operation can be used to disable an IAM user's signing\n certificate as part of a certificate rotation work flow.

\n

If the UserName field is not specified, the user name is determined\n implicitly based on the Amazon Web Services access key ID used to sign the request. This operation\n works for access keys under the Amazon Web Services account. Consequently, you can use this operation\n to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated\n users.

", + "smithy.api#examples": [ + { + "title": "To change the active status of a signing certificate for an IAM user", + "documentation": "The following command changes the status of a signing certificate for a user named Bob to Inactive.", + "input": { + "UserName": "Bob", + "CertificateId": "TA7SMP42TDN5Z26OBPJE7EXAMPLE", + "Status": "Inactive" + } + } + ] + } + }, + "com.amazonaws.iam#UpdateSigningCertificateRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#existingUserNameType", + "traits": { + "smithy.api#documentation": "

The name of the IAM user the signing certificate belongs to.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } + }, + "CertificateId": { + "target": "com.amazonaws.iam#certificateIdType", + "traits": { + "smithy.api#documentation": "

The ID of the signing certificate you want to update.

\n

This parameter allows (through its regex pattern) a string of characters that can \n consist of any upper or lowercased letter or digit.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.iam#statusType", + "traits": { + "smithy.api#documentation": "

The status you want to assign to the certificate. Active means that the\n certificate can be used for programmatic calls to Amazon Web Services Inactive means that\n the certificate cannot be used.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#UpdateUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#UpdateUserRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iam#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.iam#EntityAlreadyExistsException" + }, + { + "target": "com.amazonaws.iam#EntityTemporarilyUnmodifiableException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the name and/or the path of the specified IAM user.

\n \n

You should understand the implications of changing an IAM user's path or\n name. For more information, see Renaming an IAM\n user and Renaming an IAM\n group in the IAM User Guide.

\n \n \n

To change a user name, the requester must have appropriate permissions on both\n the source object and the target object. For example, to change Bob to Robert, the\n entity making the request must have permission on Bob and Robert, or must have\n permission on all (*). For more information about permissions, see Permissions and policies.

\n ", + "smithy.api#examples": [ + { + "title": "To change an IAM user's name", + "documentation": "The following command changes the name of the IAM user Bob to Robert. It does not change the user's path.", + "input": { + "UserName": "Bob", + "NewUserName": "Robert" + } + } + ] + } + }, + "com.amazonaws.iam#UpdateUserRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#existingUserNameType", + "traits": { + "smithy.api#documentation": "

Name of the user to update. If you're changing the name of the user, this is the\n original user name.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "NewPath": { + "target": "com.amazonaws.iam#pathType", + "traits": { + "smithy.api#documentation": "

New path for the IAM user. Include this parameter only if you're changing the user's\n path.

\n

This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including \n most punctuation characters, digits, and upper and lowercased letters.

" + } + }, + "NewUserName": { + "target": "com.amazonaws.iam#userNameType", + "traits": { + "smithy.api#documentation": "

New name for the user. Include this parameter only if you're changing the user's\n name.

\n

IAM user, group, role, and policy names must be unique within the account. Names are\n not distinguished by case. For example, you cannot create resources named both\n \"MyResource\" and \"myresource\".

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#UploadSSHPublicKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#UploadSSHPublicKeyRequest" + }, + "output": { + "target": "com.amazonaws.iam#UploadSSHPublicKeyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#DuplicateSSHPublicKeyException" + }, + { + "target": "com.amazonaws.iam#InvalidPublicKeyException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#UnrecognizedPublicKeyEncodingException" + } + ], + "traits": { + "smithy.api#documentation": "

Uploads an SSH public key and associates it with the specified IAM user.

\n

The SSH public key uploaded by this operation can be used only for authenticating the\n associated IAM user to an CodeCommit repository. For more information about using SSH keys\n to authenticate to an CodeCommit repository, see Set up CodeCommit for\n SSH connections in the CodeCommit User Guide.

" + } + }, + "com.amazonaws.iam#UploadSSHPublicKeyRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#userNameType", + "traits": { + "smithy.api#documentation": "

The name of the IAM user to associate the SSH public key with.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "SSHPublicKeyBody": { + "target": "com.amazonaws.iam#publicKeyMaterialType", + "traits": { + "smithy.api#documentation": "

The SSH public key. The public key must be encoded in ssh-rsa format or PEM format.\n The minimum bit-length of the public key is 2048 bits. For example, you can generate a\n 2048-bit key, and the resulting PEM file is 1679 bytes long.

\n

The regex pattern \n used to validate this parameter is a string of characters consisting of the following:

\n
    \n
  • \n

    Any printable ASCII \n character ranging from the space character (\\u0020) through the end of the ASCII character range

    \n
    • \n
  • \n

    The printable characters in the Basic Latin and Latin-1 Supplement character set \n (through \\u00FF)

    \n
    • \n
  • \n

    The special characters tab (\\u0009), line feed (\\u000A), and \n carriage return (\\u000D)

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#UploadSSHPublicKeyResponse": { + "type": "structure", + "members": { + "SSHPublicKey": { + "target": "com.amazonaws.iam#SSHPublicKey", + "traits": { + "smithy.api#documentation": "

Contains information about the SSH public key.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful UploadSSHPublicKey\n request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#UploadServerCertificate": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#UploadServerCertificateRequest" + }, + "output": { + "target": "com.amazonaws.iam#UploadServerCertificateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.iam#EntityAlreadyExistsException" + }, + { + "target": "com.amazonaws.iam#InvalidInputException" + }, + { + "target": "com.amazonaws.iam#KeyPairMismatchException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#MalformedCertificateException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Uploads a server certificate entity for the Amazon Web Services account. The server certificate\n entity includes a public key certificate, a private key, and an optional certificate\n chain, which should all be PEM-encoded.

\n

We recommend that you use Certificate Manager to\n provision, manage, and deploy your server certificates. With ACM you can request a\n certificate, deploy it to Amazon Web Services resources, and let ACM handle certificate renewals for\n you. Certificates provided by ACM are free. For more information about using ACM,\n see the Certificate Manager User\n Guide.

\n

For more information about working with server certificates, see Working\n with server certificates in the IAM User Guide. This\n topic includes a list of Amazon Web Services services that can use the server certificates that you\n manage with IAM.

\n

For information about the number of server certificates you can upload, see IAM and STS\n quotas in the IAM User Guide.

\n \n

Because the body of the public key certificate, private key, and the certificate\n chain can be large, you should use POST rather than GET when calling\n UploadServerCertificate. For information about setting up\n signatures and authorization through the API, see Signing Amazon Web Services API\n requests in the Amazon Web Services General Reference. For general\n information about using the Query API with IAM, see Calling the API by making HTTP query\n requests in the IAM User Guide.

\n ", + "smithy.api#examples": [ + { + "title": "To upload a server certificate to your AWS account", + "documentation": "The following upload-server-certificate command uploads a server certificate to your AWS account:", + "input": { + "ServerCertificateName": "ProdServerCert", + "Path": "/company/servercerts/", + "CertificateBody": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", + "PrivateKey": "-----BEGIN DSA PRIVATE KEY----------END DSA PRIVATE KEY-----" + }, + "output": { + "ServerCertificateMetadata": { + "ServerCertificateName": "ProdServerCert", + "Path": "/company/servercerts/", + "Arn": "arn:aws:iam::123456789012:server-certificate/company/servercerts/ProdServerCert", + "UploadDate": "2010-05-08T01:02:03.004Z", + "ServerCertificateId": "ASCA1111111111EXAMPLE", + "Expiration": "2012-05-08T01:02:03.004Z" + } + } + } + ] + } + }, + "com.amazonaws.iam#UploadServerCertificateRequest": { + "type": "structure", + "members": { + "Path": { + "target": "com.amazonaws.iam#pathType", + "traits": { + "smithy.api#documentation": "

The path for the server certificate. For more information about paths, see IAM\n identifiers in the IAM User Guide.

\n

This parameter is optional. If it is not included, it defaults to a slash (/).\n This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including \n most punctuation characters, digits, and upper and lowercased letters.

\n \n

If you are uploading a server certificate specifically for use with Amazon\n CloudFront distributions, you must specify a path using the path\n parameter. The path must begin with /cloudfront and must include a\n trailing slash (for example, /cloudfront/test/).

\n " + } + }, + "ServerCertificateName": { + "target": "com.amazonaws.iam#serverCertificateNameType", + "traits": { + "smithy.api#documentation": "

The name for the server certificate. Do not include the path in this value. The name\n of the certificate cannot contain any spaces.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, + "CertificateBody": { + "target": "com.amazonaws.iam#certificateBodyType", + "traits": { + "smithy.api#documentation": "

The contents of the public key certificate in PEM-encoded format.

\n

The regex pattern \n used to validate this parameter is a string of characters consisting of the following:

\n
    \n
  • \n

    Any printable ASCII \n character ranging from the space character (\\u0020) through the end of the ASCII character range

    \n
    • \n
  • \n

    The printable characters in the Basic Latin and Latin-1 Supplement character set \n (through \\u00FF)

    \n
    • \n
  • \n

    The special characters tab (\\u0009), line feed (\\u000A), and \n carriage return (\\u000D)

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "PrivateKey": { + "target": "com.amazonaws.iam#privateKeyType", + "traits": { + "smithy.api#documentation": "

The contents of the private key in PEM-encoded format.

\n

The regex pattern \n used to validate this parameter is a string of characters consisting of the following:

\n
    \n
  • \n

    Any printable ASCII \n character ranging from the space character (\\u0020) through the end of the ASCII character range

    \n
    • \n
  • \n

    The printable characters in the Basic Latin and Latin-1 Supplement character set \n (through \\u00FF)

    \n
    • \n
  • \n

    The special characters tab (\\u0009), line feed (\\u000A), and \n carriage return (\\u000D)

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "CertificateChain": { + "target": "com.amazonaws.iam#certificateChainType", + "traits": { + "smithy.api#documentation": "

The contents of the certificate chain. This is typically a concatenation of the\n PEM-encoded public key certificates of the chain.

\n

The regex pattern \n used to validate this parameter is a string of characters consisting of the following:

\n
    \n
  • \n

    Any printable ASCII \n character ranging from the space character (\\u0020) through the end of the ASCII character range

    \n
    • \n
  • \n

    The printable characters in the Basic Latin and Latin-1 Supplement character set \n (through \\u00FF)

    \n
    • \n
  • \n

    The special characters tab (\\u0009), line feed (\\u000A), and \n carriage return (\\u000D)

    \n
    • \n
" + } + }, + "Tags": { + "target": "com.amazonaws.iam#tagListType", + "traits": { + "smithy.api#documentation": "

A list of tags that you want to attach to the new IAM server certificate resource.\n Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

\n \n

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request \n fails and the resource is not created.

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#UploadServerCertificateResponse": { + "type": "structure", + "members": { + "ServerCertificateMetadata": { + "target": "com.amazonaws.iam#ServerCertificateMetadata", + "traits": { + "smithy.api#documentation": "

The meta information of the uploaded server certificate without its certificate body,\n certificate chain, and private key.

" + } + }, + "Tags": { + "target": "com.amazonaws.iam#tagListType", + "traits": { + "smithy.api#documentation": "

A list of tags that are attached to the new IAM server certificate. The returned list of tags is sorted by tag key.\n For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful UploadServerCertificate\n request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#UploadSigningCertificate": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#UploadSigningCertificateRequest" + }, + "output": { + "target": "com.amazonaws.iam#UploadSigningCertificateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.iam#DuplicateCertificateException" + }, + { + "target": "com.amazonaws.iam#EntityAlreadyExistsException" + }, + { + "target": "com.amazonaws.iam#InvalidCertificateException" + }, + { + "target": "com.amazonaws.iam#LimitExceededException" + }, + { + "target": "com.amazonaws.iam#MalformedCertificateException" + }, + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Uploads an X.509 signing certificate and associates it with the specified IAM user.\n Some Amazon Web Services services require you to use certificates to validate requests that are signed\n with a corresponding private key. When you upload the certificate, its default status is\n Active.

\n

For information about when you would use an X.509 signing certificate, see Managing\n server certificates in IAM in the\n IAM User Guide.

\n

If the UserName is not specified, the IAM user name is determined\n implicitly based on the Amazon Web Services access key ID used to sign the request. This operation\n works for access keys under the Amazon Web Services account. Consequently, you can use this operation\n to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated\n users.

\n \n

Because the body of an X.509 certificate can be large, you should use POST rather\n than GET when calling UploadSigningCertificate. For information about\n setting up signatures and authorization through the API, see Signing\n Amazon Web Services API requests in the Amazon Web Services General Reference. For\n general information about using the Query API with IAM, see Making query\n requests in the IAM User Guide.

\n ", + "smithy.api#examples": [ + { + "title": "To upload a signing certificate for an IAM user", + "documentation": "The following command uploads a signing certificate for the IAM user named Bob.", + "input": { + "UserName": "Bob", + "CertificateBody": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----" + }, + "output": { + "Certificate": { + "CertificateId": "ID123456789012345EXAMPLE", + "UserName": "Bob", + "Status": "Active", + "CertificateBody": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", + "UploadDate": "2015-06-06T21:40:08.121Z" + } + } + } + ] + } + }, + "com.amazonaws.iam#UploadSigningCertificateRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#existingUserNameType", + "traits": { + "smithy.api#documentation": "

The name of the user the signing certificate is for.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } + }, + "CertificateBody": { + "target": "com.amazonaws.iam#certificateBodyType", + "traits": { + "smithy.api#documentation": "

The contents of the signing certificate.

\n

The regex pattern \n used to validate this parameter is a string of characters consisting of the following:

\n
    \n
  • \n

    Any printable ASCII \n character ranging from the space character (\\u0020) through the end of the ASCII character range

    \n
    • \n
  • \n

    The printable characters in the Basic Latin and Latin-1 Supplement character set \n (through \\u00FF)

    \n
    • \n
  • \n

    The special characters tab (\\u0009), line feed (\\u000A), and \n carriage return (\\u000D)

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#UploadSigningCertificateResponse": { + "type": "structure", + "members": { + "Certificate": { + "target": "com.amazonaws.iam#SigningCertificate", + "traits": { + "smithy.api#documentation": "

Information about the certificate.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the response to a successful UploadSigningCertificate\n request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.iam#User": { + "type": "structure", + "members": { + "Path": { + "target": "com.amazonaws.iam#pathType", + "traits": { + "smithy.api#documentation": "

The path to the user. For more information about paths, see IAM identifiers in the\n IAM User Guide.

\n

The ARN of the policy used to set the permissions boundary for the user.

", + "smithy.api#required": {} + } + }, + "UserName": { + "target": "com.amazonaws.iam#userNameType", + "traits": { + "smithy.api#documentation": "

The friendly name identifying the user.

", + "smithy.api#required": {} + } + }, + "UserId": { + "target": "com.amazonaws.iam#idType", + "traits": { + "smithy.api#documentation": "

The stable and unique string identifying the user. For more information about IDs, see\n IAM\n identifiers in the IAM User Guide.

", + "smithy.api#required": {} + } + }, + "Arn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs\n and how to use ARNs in policies, see IAM Identifiers in the\n IAM User Guide.

", + "smithy.api#required": {} + } + }, + "CreateDate": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the user was created.

", + "smithy.api#required": {} + } + }, + "PasswordLastUsed": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the user's password was last used to sign in to an Amazon Web Services website.\n For a list of Amazon Web Services websites that capture a user's last sign-in time, see the Credential\n reports topic in the IAM User Guide. If a password is\n used more than once in a five-minute span, only the first use is returned in this field. If\n the field is null (no value), then it indicates that they never signed in with a password.\n This can be because:

\n
    \n
  • \n

    The user never had a password.

    \n
    • \n
  • \n

    A password exists but has not been used since IAM started tracking this\n information on October 20, 2014.

    \n
    • \n
\n

A null value does not mean that the user never had a password.\n Also, if the user does not currently have a password but had one in the past, then this\n field contains the date and time the most recent password was used.

\n

This value is returned only in the GetUser and ListUsers operations.

" + } + }, + "PermissionsBoundary": { + "target": "com.amazonaws.iam#AttachedPermissionsBoundary", + "traits": { + "smithy.api#documentation": "

For more information about permissions boundaries, see Permissions boundaries for IAM\n identities in the IAM User Guide.

" + } + }, + "Tags": { + "target": "com.amazonaws.iam#tagListType", + "traits": { + "smithy.api#documentation": "

A list of tags that are associated with the user. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about an IAM user entity.

\n

This data type is used as a response element in the following operations:

\n " + } + }, + "com.amazonaws.iam#UserDetail": { + "type": "structure", + "members": { + "Path": { + "target": "com.amazonaws.iam#pathType", + "traits": { + "smithy.api#documentation": "

The path to the user. For more information about paths, see IAM identifiers in the\n IAM User Guide.

" + } + }, + "UserName": { + "target": "com.amazonaws.iam#userNameType", + "traits": { + "smithy.api#documentation": "

The friendly name identifying the user.

" + } + }, + "UserId": { + "target": "com.amazonaws.iam#idType", + "traits": { + "smithy.api#documentation": "

The stable and unique string identifying the user. For more information about IDs, see\n IAM\n identifiers in the IAM User Guide.

" + } + }, + "Arn": { + "target": "com.amazonaws.iam#arnType" + }, + "CreateDate": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the user was created.

" + } + }, + "UserPolicyList": { + "target": "com.amazonaws.iam#policyDetailListType", + "traits": { + "smithy.api#documentation": "

A list of the inline policies embedded in the user.

" + } + }, + "GroupList": { + "target": "com.amazonaws.iam#groupNameListType", + "traits": { + "smithy.api#documentation": "

A list of IAM groups that the user is in.

" + } + }, + "AttachedManagedPolicies": { + "target": "com.amazonaws.iam#attachedPoliciesListType", + "traits": { + "smithy.api#documentation": "

A list of the managed policies attached to the user.

" + } + }, + "PermissionsBoundary": { + "target": "com.amazonaws.iam#AttachedPermissionsBoundary", + "traits": { + "smithy.api#documentation": "

The ARN of the policy used to set the permissions boundary for the user.

\n

For more information about permissions boundaries, see Permissions boundaries for IAM\n identities in the IAM User Guide.

" + } + }, + "Tags": { + "target": "com.amazonaws.iam#tagListType", + "traits": { + "smithy.api#documentation": "

A list of tags that are associated with the user. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about an IAM user, including all the user's policies and all the\n IAM groups the user is in.

\n

This data type is used as a response element in the GetAccountAuthorizationDetails operation.

" + } + }, + "com.amazonaws.iam#VirtualMFADevice": { + "type": "structure", + "members": { + "SerialNumber": { + "target": "com.amazonaws.iam#serialNumberType", + "traits": { + "smithy.api#documentation": "

The serial number associated with VirtualMFADevice.

", + "smithy.api#required": {} + } + }, + "Base32StringSeed": { + "target": "com.amazonaws.iam#BootstrapDatum", + "traits": { + "smithy.api#documentation": "

The base32 seed defined as specified in RFC3548. The Base32StringSeed is base32-encoded.

" + } + }, + "QRCodePNG": { + "target": "com.amazonaws.iam#BootstrapDatum", + "traits": { + "smithy.api#documentation": "

A QR code PNG image that encodes\n otpauth://totp/$virtualMFADeviceName@$AccountName?secret=$Base32String\n where $virtualMFADeviceName is one of the create call arguments.\n AccountName is the user name if set (otherwise, the account ID otherwise),\n and Base32String is the seed in base32 format. The Base32String\n value is base64-encoded.

" + } + }, + "User": { + "target": "com.amazonaws.iam#User", + "traits": { + "smithy.api#documentation": "

The IAM user associated with this virtual MFA device.

" + } + }, + "EnableDate": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date and time on which the virtual MFA device was enabled.

" + } + }, + "Tags": { + "target": "com.amazonaws.iam#tagListType", + "traits": { + "smithy.api#documentation": "

A list of tags that are attached to the virtual MFA device. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a virtual MFA device.

" + } + }, + "com.amazonaws.iam#accessKeyIdType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 16, + "max": 128 + }, + "smithy.api#pattern": "^[\\w]+$" + } + }, + "com.amazonaws.iam#accessKeyMetadataListType": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#AccessKeyMetadata" + }, + "traits": { + "smithy.api#documentation": "

Contains a list of access key metadata.

\n

This data type is used as a response element in the ListAccessKeys\n operation.

" + } + }, + "com.amazonaws.iam#accessKeySecretType": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.iam#accountAliasListType": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#accountAliasType" + } + }, + "com.amazonaws.iam#accountAliasType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": "^[a-z0-9]([a-z0-9]|-(?!-)){1,61}[a-z0-9]$" + } + }, + "com.amazonaws.iam#arnType": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.

\n

For more information about ARNs, go to Amazon Resource Names (ARNs) in\n the Amazon Web Services General Reference.

", + "smithy.api#length": { + "min": 20, + "max": 2048 + } + } + }, + "com.amazonaws.iam#assignmentStatusType": { + "type": "enum", + "members": { + "Assigned": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Assigned" + } + }, + "Unassigned": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Unassigned" + } + }, + "Any": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Any" + } + } + } + }, + "com.amazonaws.iam#attachedPoliciesListType": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#AttachedPolicy" + } + }, + "com.amazonaws.iam#attachmentCountType": { + "type": "integer" + }, + "com.amazonaws.iam#authenticationCodeType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 6, + "max": 6 + }, + "smithy.api#pattern": "^[\\d]+$" + } + }, + "com.amazonaws.iam#booleanObjectType": { + "type": "boolean" + }, + "com.amazonaws.iam#booleanType": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.iam#certificateBodyType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16384 + }, + "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+$" + } + }, + "com.amazonaws.iam#certificateChainType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2097152 + }, + "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+$" + } + }, + "com.amazonaws.iam#certificateIdType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 24, + "max": 128 + }, + "smithy.api#pattern": "^[\\w]+$" + } + }, + "com.amazonaws.iam#certificateListType": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#SigningCertificate" + }, + "traits": { + "smithy.api#documentation": "

Contains a list of signing certificates.

\n

This data type is used as a response element in the ListSigningCertificates operation.

" + } + }, + "com.amazonaws.iam#clientIDListType": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#clientIDType" + } + }, + "com.amazonaws.iam#clientIDType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.iam#credentialReportExpiredExceptionMessage": { + "type": "string" + }, + "com.amazonaws.iam#credentialReportNotPresentExceptionMessage": { + "type": "string" + }, + "com.amazonaws.iam#credentialReportNotReadyExceptionMessage": { + "type": "string" + }, + "com.amazonaws.iam#customSuffixType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[\\w+=,.@-]+$" + } + }, + "com.amazonaws.iam#dateType": { + "type": "timestamp" + }, + "com.amazonaws.iam#deleteConflictMessage": { + "type": "string" + }, + "com.amazonaws.iam#duplicateCertificateMessage": { + "type": "string" + }, + "com.amazonaws.iam#duplicateSSHPublicKeyMessage": { + "type": "string" + }, + "com.amazonaws.iam#encodingType": { + "type": "enum", + "members": { + "SSH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SSH" + } + }, + "PEM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PEM" + } + } + } + }, + "com.amazonaws.iam#entityAlreadyExistsMessage": { + "type": "string" + }, + "com.amazonaws.iam#entityDetailsListType": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#EntityDetails" + } + }, + "com.amazonaws.iam#entityListType": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#EntityType" + } + }, + "com.amazonaws.iam#entityNameType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\w+=,.@-]+$" + } + }, + "com.amazonaws.iam#entityTemporarilyUnmodifiableMessage": { + "type": "string" + }, + "com.amazonaws.iam#existingUserNameType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\w+=,.@-]+$" + } + }, + "com.amazonaws.iam#globalEndpointTokenVersion": { + "type": "enum", + "members": { + "v1Token": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "v1Token" + } + }, + "v2Token": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "v2Token" + } + } + } + }, + "com.amazonaws.iam#groupDetailListType": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#GroupDetail" + } + }, + "com.amazonaws.iam#groupListType": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#Group" + }, + "traits": { + "smithy.api#documentation": "

Contains a list of IAM groups.

\n

This data type is used as a response element in the ListGroups\n operation.

" + } + }, + "com.amazonaws.iam#groupNameListType": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#groupNameType" + } + }, + "com.amazonaws.iam#groupNameType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\w+=,.@-]+$" + } + }, + "com.amazonaws.iam#idType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 16, + "max": 128 + }, + "smithy.api#pattern": "^[\\w]+$" + } + }, + "com.amazonaws.iam#instanceProfileListType": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#InstanceProfile" + }, + "traits": { + "smithy.api#documentation": "

Contains a list of instance profiles.

" + } + }, + "com.amazonaws.iam#instanceProfileNameType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\w+=,.@-]+$" + } + }, + "com.amazonaws.iam#integerType": { + "type": "integer" + }, + "com.amazonaws.iam#invalidAuthenticationCodeMessage": { + "type": "string" + }, + "com.amazonaws.iam#invalidCertificateMessage": { + "type": "string" + }, + "com.amazonaws.iam#invalidInputMessage": { + "type": "string" + }, + "com.amazonaws.iam#invalidPublicKeyMessage": { + "type": "string" + }, + "com.amazonaws.iam#invalidUserTypeMessage": { + "type": "string" + }, + "com.amazonaws.iam#jobIDType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + } + } + }, + "com.amazonaws.iam#jobStatusType": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.iam#keyPairMismatchMessage": { + "type": "string" + }, + "com.amazonaws.iam#limitExceededMessage": { + "type": "string" + }, + "com.amazonaws.iam#listPolicyGrantingServiceAccessResponseListType": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#ListPoliciesGrantingServiceAccessEntry" + } + }, + "com.amazonaws.iam#malformedCertificateMessage": { + "type": "string" + }, + "com.amazonaws.iam#malformedPolicyDocumentMessage": { + "type": "string" + }, + "com.amazonaws.iam#markerType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 320 + }, + "smithy.api#pattern": "^[\\u0020-\\u00FF]+$" + } + }, + "com.amazonaws.iam#maxItemsType": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.iam#maxPasswordAgeType": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1095 + } + } + }, + "com.amazonaws.iam#mfaDeviceListType": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#MFADevice" + }, + "traits": { + "smithy.api#documentation": "

Contains a list of MFA devices.

\n

This data type is used as a response element in the ListMFADevices and\n ListVirtualMFADevices operations.

" + } + }, + "com.amazonaws.iam#minimumPasswordLengthType": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 6, + "max": 128 + } + } + }, + "com.amazonaws.iam#noSuchEntityMessage": { + "type": "string" + }, + "com.amazonaws.iam#openIdIdpCommunicationErrorExceptionMessage": { + "type": "string" + }, + "com.amazonaws.iam#organizationsEntityPathType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 19, + "max": 427 + }, + "smithy.api#pattern": "^o-[0-9a-z]{10,32}\\/r-[0-9a-z]{4,32}[0-9a-z-\\/]*$" + } + }, + "com.amazonaws.iam#organizationsPolicyIdType": { + "type": "string", + "traits": { + "smithy.api#pattern": "^p-[0-9a-zA-Z_]{8,128}$" + } + }, + "com.amazonaws.iam#passwordPolicyViolationMessage": { + "type": "string" + }, + "com.amazonaws.iam#passwordReusePreventionType": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 24 + } + } + }, + "com.amazonaws.iam#passwordType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.iam#pathPrefixType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^\\u002F[\\u0021-\\u007F]*$" + } + }, + "com.amazonaws.iam#pathType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^(\\u002F)|(\\u002F[\\u0021-\\u007E]+\\u002F)$" + } + }, + "com.amazonaws.iam#policyDescriptionType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + } + } + }, + "com.amazonaws.iam#policyDetailListType": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#PolicyDetail" + } + }, + "com.amazonaws.iam#policyDocumentType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 131072 + }, + "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+$" + } + }, + "com.amazonaws.iam#policyDocumentVersionListType": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#PolicyVersion" + } + }, + "com.amazonaws.iam#policyEvaluationErrorMessage": { + "type": "string" + }, + "com.amazonaws.iam#policyGrantingServiceAccessListType": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#PolicyGrantingServiceAccess" + } + }, + "com.amazonaws.iam#policyListType": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#Policy" + } + }, + "com.amazonaws.iam#policyNameListType": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#policyNameType" + }, + "traits": { + "smithy.api#documentation": "

Contains a list of policy names.

\n

This data type is used as a response element in the ListPolicies\n operation.

" + } + }, + "com.amazonaws.iam#policyNameType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\w+=,.@-]+$" + } + }, + "com.amazonaws.iam#policyNotAttachableMessage": { + "type": "string" + }, + "com.amazonaws.iam#policyOwnerEntityType": { + "type": "enum", + "members": { + "USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USER" + } + }, + "ROLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROLE" + } + }, + "GROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GROUP" + } + } + } + }, + "com.amazonaws.iam#policyPathType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^((/[A-Za-z0-9\\.,\\+@=_-]+)*)/$" + } + }, + "com.amazonaws.iam#policyScopeType": { + "type": "enum", + "members": { + "All": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "All" + } + }, + "AWS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS" + } + }, + "Local": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Local" + } + } + } + }, + "com.amazonaws.iam#policyType": { + "type": "enum", + "members": { + "INLINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INLINE" + } + }, + "MANAGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANAGED" + } + } + } + }, + "com.amazonaws.iam#policyVersionIdType": { + "type": "string", + "traits": { + "smithy.api#pattern": "^v[1-9][0-9]*(\\.[A-Za-z0-9-]*)?$" + } + }, + "com.amazonaws.iam#privateKeyType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16384 + }, + "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.iam#publicKeyFingerprintType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 48, + "max": 48 + }, + "smithy.api#pattern": "^[:\\w]+$" + } + }, + "com.amazonaws.iam#publicKeyIdType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 128 + }, + "smithy.api#pattern": "^[\\w]+$" + } + }, + "com.amazonaws.iam#publicKeyMaterialType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16384 + }, + "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+$" + } + }, + "com.amazonaws.iam#reportGenerationLimitExceededMessage": { + "type": "string" + }, + "com.amazonaws.iam#responseMarkerType": { + "type": "string" + }, + "com.amazonaws.iam#roleDescriptionType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + }, + "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]*$" + } + }, + "com.amazonaws.iam#roleDetailListType": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#RoleDetail" + } + }, + "com.amazonaws.iam#roleListType": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#Role" + }, + "traits": { + "smithy.api#documentation": "

Contains a list of IAM roles.

\n

This data type is used as a response element in the ListRoles\n operation.

" + } + }, + "com.amazonaws.iam#roleMaxSessionDurationType": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 3600, + "max": 43200 + } + } + }, + "com.amazonaws.iam#roleNameType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[\\w+=,.@-]+$" + } + }, + "com.amazonaws.iam#serialNumberType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 9, + "max": 256 + }, + "smithy.api#pattern": "^[\\w+=/:,.@-]+$" + } + }, + "com.amazonaws.iam#serverCertificateMetadataListType": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#ServerCertificateMetadata" + } + }, + "com.amazonaws.iam#serverCertificateNameType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\w+=,.@-]+$" + } + }, + "com.amazonaws.iam#serviceFailureExceptionMessage": { + "type": "string" + }, + "com.amazonaws.iam#serviceName": { + "type": "string" + }, + "com.amazonaws.iam#serviceNameType": { + "type": "string" + }, + "com.amazonaws.iam#serviceNamespaceListType": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#serviceNamespaceType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.iam#serviceNamespaceType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[\\w-]*$" + } + }, + "com.amazonaws.iam#serviceNotSupportedMessage": { + "type": "string" + }, + "com.amazonaws.iam#servicePassword": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.iam#serviceSpecificCredentialId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 128 + }, + "smithy.api#pattern": "^[\\w]+$" + } + }, + "com.amazonaws.iam#serviceUserName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 17, + "max": 200 + }, + "smithy.api#pattern": "^[\\w+=,.@-]+$" + } + }, + "com.amazonaws.iam#sortKeyType": { + "type": "enum", + "members": { + "SERVICE_NAMESPACE_ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVICE_NAMESPACE_ASCENDING" + } + }, + "SERVICE_NAMESPACE_DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVICE_NAMESPACE_DESCENDING" + } + }, + "LAST_AUTHENTICATED_TIME_ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAST_AUTHENTICATED_TIME_ASCENDING" + } + }, + "LAST_AUTHENTICATED_TIME_DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAST_AUTHENTICATED_TIME_DESCENDING" + } + } + } + }, + "com.amazonaws.iam#statusType": { + "type": "enum", + "members": { + "Active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active" + } + }, + "Inactive": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Inactive" + } + } + } + }, + "com.amazonaws.iam#stringType": { + "type": "string" + }, + "com.amazonaws.iam#summaryKeyType": { + "type": "enum", + "members": { + "Users": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Users" + } + }, + "UsersQuota": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UsersQuota" + } + }, + "Groups": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Groups" + } + }, + "GroupsQuota": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GroupsQuota" + } + }, + "ServerCertificates": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ServerCertificates" + } + }, + "ServerCertificatesQuota": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ServerCertificatesQuota" + } + }, + "UserPolicySizeQuota": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UserPolicySizeQuota" + } + }, + "GroupPolicySizeQuota": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GroupPolicySizeQuota" + } + }, + "GroupsPerUserQuota": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GroupsPerUserQuota" + } + }, + "SigningCertificatesPerUserQuota": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SigningCertificatesPerUserQuota" + } + }, + "AccessKeysPerUserQuota": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AccessKeysPerUserQuota" + } + }, + "MFADevices": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MFADevices" + } + }, + "MFADevicesInUse": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MFADevicesInUse" + } + }, + "AccountMFAEnabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AccountMFAEnabled" + } + }, + "AccountAccessKeysPresent": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AccountAccessKeysPresent" + } + }, + "AccountPasswordPresent": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AccountPasswordPresent" + } + }, + "AccountSigningCertificatesPresent": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AccountSigningCertificatesPresent" + } + }, + "AttachedPoliciesPerGroupQuota": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AttachedPoliciesPerGroupQuota" + } + }, + "AttachedPoliciesPerRoleQuota": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AttachedPoliciesPerRoleQuota" + } + }, + "AttachedPoliciesPerUserQuota": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AttachedPoliciesPerUserQuota" + } + }, + "Policies": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Policies" + } + }, + "PoliciesQuota": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PoliciesQuota" + } + }, + "PolicySizeQuota": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PolicySizeQuota" + } + }, + "PolicyVersionsInUse": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PolicyVersionsInUse" + } + }, + "PolicyVersionsInUseQuota": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PolicyVersionsInUseQuota" + } + }, + "VersionsPerPolicyQuota": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VersionsPerPolicyQuota" + } + }, + "GlobalEndpointTokenVersion": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GlobalEndpointTokenVersion" + } + } + } + }, + "com.amazonaws.iam#summaryMapType": { + "type": "map", + "key": { + "target": "com.amazonaws.iam#summaryKeyType" + }, + "value": { + "target": "com.amazonaws.iam#summaryValueType" + } + }, + "com.amazonaws.iam#summaryValueType": { + "type": "integer" + }, + "com.amazonaws.iam#tagKeyListType": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#tagKeyType" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.iam#tagKeyType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]+$" + } + }, + "com.amazonaws.iam#tagListType": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#Tag" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.iam#tagValueType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*$" + } + }, + "com.amazonaws.iam#thumbprintListType": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#thumbprintType" + }, + "traits": { + "smithy.api#documentation": "

Contains a list of thumbprints of identity provider server certificates.

" + } + }, + "com.amazonaws.iam#thumbprintType": { + "type": "string", + "traits": { + "smithy.api#documentation": "

Contains a thumbprint for an identity provider's server certificate.

\n

The identity provider's server certificate thumbprint is the hex-encoded SHA-1 hash\n value of the self-signed X.509 certificate. This thumbprint is used by the domain where the\n OpenID Connect provider makes its keys available. The thumbprint is always a 40-character\n string.

", + "smithy.api#length": { + "min": 40, + "max": 40 + } + } + }, + "com.amazonaws.iam#unmodifiableEntityMessage": { + "type": "string" + }, + "com.amazonaws.iam#unrecognizedPublicKeyEncodingMessage": { + "type": "string" + }, + "com.amazonaws.iam#userDetailListType": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#UserDetail" + } + }, + "com.amazonaws.iam#userListType": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#User" + }, + "traits": { + "smithy.api#documentation": "

Contains a list of users.

\n

This data type is used as a response element in the GetGroup and ListUsers operations.

" + } + }, + "com.amazonaws.iam#userNameType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[\\w+=,.@-]+$" + } + }, + "com.amazonaws.iam#virtualMFADeviceListType": { + "type": "list", + "member": { + "target": "com.amazonaws.iam#VirtualMFADevice" + } + }, + "com.amazonaws.iam#virtualMFADeviceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#pattern": "^[\\w+=,.@-]+$" + } + } + } +} \ No newline at end of file diff --git a/pkg/testdata/codegen/sdk-codegen/aws-models/lambda.json b/pkg/testdata/codegen/sdk-codegen/aws-models/lambda.json new file mode 100644 index 00000000..c694885d --- /dev/null +++ b/pkg/testdata/codegen/sdk-codegen/aws-models/lambda.json @@ -0,0 +1,13473 @@ +{ + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.lambda#AWSGirApiService": { + "type": "service", + "version": "2015-03-31", + "operations": [ + { + "target": "com.amazonaws.lambda#AddLayerVersionPermission" + }, + { + "target": "com.amazonaws.lambda#AddPermission" + }, + { + "target": "com.amazonaws.lambda#CreateAlias" + }, + { + "target": "com.amazonaws.lambda#CreateCodeSigningConfig" + }, + { + "target": "com.amazonaws.lambda#CreateEventSourceMapping" + }, + { + "target": "com.amazonaws.lambda#CreateFunction" + }, + { + "target": "com.amazonaws.lambda#CreateFunctionUrlConfig" + }, + { + "target": "com.amazonaws.lambda#DeleteAlias" + }, + { + "target": "com.amazonaws.lambda#DeleteCodeSigningConfig" + }, + { + "target": "com.amazonaws.lambda#DeleteEventSourceMapping" + }, + { + "target": "com.amazonaws.lambda#DeleteFunction" + }, + { + "target": "com.amazonaws.lambda#DeleteFunctionCodeSigningConfig" + }, + { + "target": "com.amazonaws.lambda#DeleteFunctionConcurrency" + }, + { + "target": "com.amazonaws.lambda#DeleteFunctionEventInvokeConfig" + }, + { + "target": "com.amazonaws.lambda#DeleteFunctionUrlConfig" + }, + { + "target": "com.amazonaws.lambda#DeleteLayerVersion" + }, + { + "target": "com.amazonaws.lambda#DeleteProvisionedConcurrencyConfig" + }, + { + "target": "com.amazonaws.lambda#GetAccountSettings" + }, + { + "target": "com.amazonaws.lambda#GetAlias" + }, + { + "target": "com.amazonaws.lambda#GetCodeSigningConfig" + }, + { + "target": "com.amazonaws.lambda#GetEventSourceMapping" + }, + { + "target": "com.amazonaws.lambda#GetFunction" + }, + { + "target": "com.amazonaws.lambda#GetFunctionCodeSigningConfig" + }, + { + "target": "com.amazonaws.lambda#GetFunctionConcurrency" + }, + { + "target": "com.amazonaws.lambda#GetFunctionConfiguration" + }, + { + "target": "com.amazonaws.lambda#GetFunctionEventInvokeConfig" + }, + { + "target": "com.amazonaws.lambda#GetFunctionRecursionConfig" + }, + { + "target": "com.amazonaws.lambda#GetFunctionUrlConfig" + }, + { + "target": "com.amazonaws.lambda#GetLayerVersion" + }, + { + "target": "com.amazonaws.lambda#GetLayerVersionByArn" + }, + { + "target": "com.amazonaws.lambda#GetLayerVersionPolicy" + }, + { + "target": "com.amazonaws.lambda#GetPolicy" + }, + { + "target": "com.amazonaws.lambda#GetProvisionedConcurrencyConfig" + }, + { + "target": "com.amazonaws.lambda#GetRuntimeManagementConfig" + }, + { + "target": "com.amazonaws.lambda#Invoke" + }, + { + "target": "com.amazonaws.lambda#InvokeAsync" + }, + { + "target": "com.amazonaws.lambda#InvokeWithResponseStream" + }, + { + "target": "com.amazonaws.lambda#ListAliases" + }, + { + "target": "com.amazonaws.lambda#ListCodeSigningConfigs" + }, + { + "target": "com.amazonaws.lambda#ListEventSourceMappings" + }, + { + "target": "com.amazonaws.lambda#ListFunctionEventInvokeConfigs" + }, + { + "target": "com.amazonaws.lambda#ListFunctions" + }, + { + "target": "com.amazonaws.lambda#ListFunctionsByCodeSigningConfig" + }, + { + "target": "com.amazonaws.lambda#ListFunctionUrlConfigs" + }, + { + "target": "com.amazonaws.lambda#ListLayers" + }, + { + "target": "com.amazonaws.lambda#ListLayerVersions" + }, + { + "target": "com.amazonaws.lambda#ListProvisionedConcurrencyConfigs" + }, + { + "target": "com.amazonaws.lambda#ListTags" + }, + { + "target": "com.amazonaws.lambda#ListVersionsByFunction" + }, + { + "target": "com.amazonaws.lambda#PublishLayerVersion" + }, + { + "target": "com.amazonaws.lambda#PublishVersion" + }, + { + "target": "com.amazonaws.lambda#PutFunctionCodeSigningConfig" + }, + { + "target": "com.amazonaws.lambda#PutFunctionConcurrency" + }, + { + "target": "com.amazonaws.lambda#PutFunctionEventInvokeConfig" + }, + { + "target": "com.amazonaws.lambda#PutFunctionRecursionConfig" + }, + { + "target": "com.amazonaws.lambda#PutProvisionedConcurrencyConfig" + }, + { + "target": "com.amazonaws.lambda#PutRuntimeManagementConfig" + }, + { + "target": "com.amazonaws.lambda#RemoveLayerVersionPermission" + }, + { + "target": "com.amazonaws.lambda#RemovePermission" + }, + { + "target": "com.amazonaws.lambda#TagResource" + }, + { + "target": "com.amazonaws.lambda#UntagResource" + }, + { + "target": "com.amazonaws.lambda#UpdateAlias" + }, + { + "target": "com.amazonaws.lambda#UpdateCodeSigningConfig" + }, + { + "target": "com.amazonaws.lambda#UpdateEventSourceMapping" + }, + { + "target": "com.amazonaws.lambda#UpdateFunctionCode" + }, + { + "target": "com.amazonaws.lambda#UpdateFunctionConfiguration" + }, + { + "target": "com.amazonaws.lambda#UpdateFunctionEventInvokeConfig" + }, + { + "target": "com.amazonaws.lambda#UpdateFunctionUrlConfig" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Lambda", + "arnNamespace": "lambda", + "cloudFormationName": "Lambda", + "cloudTrailEventSource": "lambda.amazonaws.com", + "endpointPrefix": "lambda" + }, + "aws.auth#sigv4": { + "name": "lambda" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "Lambda\n

\n Overview\n

\n

Lambda is a compute service that lets you run code without provisioning or managing servers.\n Lambda runs your code on a high-availability compute infrastructure and performs all of the\n administration of the compute resources, including server and operating system maintenance, capacity provisioning\n and automatic scaling, code monitoring and logging. With Lambda, you can run code for virtually any\n type of application or backend service. For more information about the Lambda service, see What is Lambda in the Lambda Developer Guide.

\n

The Lambda API Reference provides information about\n each of the API methods, including details about the parameters in each API request and\n response.

\n

\n

You can use Software Development Kits (SDKs), Integrated Development Environment (IDE) Toolkits, and command\n line tools to access the API. For installation instructions, see Tools for\n Amazon Web Services.

\n

For a list of Region-specific endpoints that Lambda supports, \n see Lambda\n endpoints and quotas in the Amazon Web Services General Reference..

\n

When making the API calls, you will need to\n authenticate your request by providing a signature. Lambda supports signature version 4. For more information,\n see Signature Version 4 signing process in the\n Amazon Web Services General Reference..

\n

\n CA certificates\n

\n

Because Amazon Web Services SDKs use the CA certificates from your computer, changes to the certificates on the Amazon Web Services servers\n can cause connection failures when you attempt to use an SDK. You can prevent these failures by keeping your\n computer's CA certificates and operating system up-to-date. If you encounter this issue in a corporate\n environment and do not manage your own computer, you might need to ask an administrator to assist with the\n update process. The following list shows minimum operating system and Java versions:

\n
    \n
  • \n

    Microsoft Windows versions that have updates from January 2005 or later installed contain at least one\n of the required CAs in their trust list.

    \n
    • \n
  • \n

    Mac OS X 10.4 with Java for Mac OS X 10.4 Release 5 (February 2007), Mac OS X 10.5 (October 2007), and\n later versions contain at least one of the required CAs in their trust list.

    \n
    • \n
  • \n

    Red Hat Enterprise Linux 5 (March 2007), 6, and 7 and CentOS 5, 6, and 7 all contain at least one of the\n required CAs in their default trusted CA list.

    \n
    • \n
  • \n

    Java 1.4.2_12 (May 2006), 5 Update 2 (March 2005), and all later versions, including Java 6 (December\n 2006), 7, and 8, contain at least one of the required CAs in their default trusted CA list.

    \n
    • \n
\n

When accessing the Lambda management console or Lambda API endpoints, whether through browsers or\n programmatically, you will need to ensure your client machines support any of the following CAs:

\n
    \n
  • \n

    Amazon Root CA 1

    \n
    • \n
  • \n

    Starfield Services Root Certificate Authority - G2

    \n
    • \n
  • \n

    Starfield Class 2 Certification Authority

    \n
    • \n
\n

Root certificates from the first two authorities are available from Amazon trust services, but keeping your computer\n up-to-date is the more straightforward solution. To learn more about ACM-provided certificates, see Amazon Web Services Certificate Manager FAQs.\n

", + "smithy.api#title": "AWS Lambda", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://lambda-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://lambda-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://lambda.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://lambda.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.af-south-1.amazonaws.com" + } + }, + "params": { + "Region": "af-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.af-south-1.api.aws" + } + }, + "params": { + "Region": "af-south-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.ap-east-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.ap-east-1.api.aws" + } + }, + "params": { + "Region": "ap-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.ap-northeast-1.api.aws" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.ap-northeast-2.api.aws" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.ap-northeast-3.api.aws" + } + }, + "params": { + "Region": "ap-northeast-3", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.ap-south-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.ap-south-1.api.aws" + } + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.ap-southeast-1.api.aws" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.ap-southeast-2.api.aws" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.ap-southeast-3.api.aws" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.ca-central-1.api.aws" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.eu-central-1.api.aws" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.eu-north-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.eu-north-1.api.aws" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.eu-south-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.eu-south-1.api.aws" + } + }, + "params": { + "Region": "eu-south-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.eu-west-1.api.aws" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.eu-west-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.eu-west-2.api.aws" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.eu-west-3.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.eu-west-3.api.aws" + } + }, + "params": { + "Region": "eu-west-3", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.me-south-1.amazonaws.com" + } + }, + "params": { + "Region": "me-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.me-south-1.api.aws" + } + }, + "params": { + "Region": "me-south-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.sa-east-1.amazonaws.com" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.sa-east-1.api.aws" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.us-east-2.api.aws" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.us-west-1.api.aws" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.us-west-2.api.aws" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda-fips.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.us-iso-west-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.lambda#AccountLimit": { + "type": "structure", + "members": { + "TotalCodeSize": { + "target": "com.amazonaws.lambda#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The amount of storage space that you can use for all deployment packages and layer archives.

" + } + }, + "CodeSizeUnzipped": { + "target": "com.amazonaws.lambda#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum size of a function's deployment package and layers when they're extracted.

" + } + }, + "CodeSizeZipped": { + "target": "com.amazonaws.lambda#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum size of a deployment package when it's uploaded directly to Lambda. Use Amazon S3 for larger\n files.

" + } + }, + "ConcurrentExecutions": { + "target": "com.amazonaws.lambda#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of simultaneous function executions.

" + } + }, + "UnreservedConcurrentExecutions": { + "target": "com.amazonaws.lambda#UnreservedConcurrentExecutions", + "traits": { + "smithy.api#documentation": "

The maximum number of simultaneous function executions, minus the capacity that's reserved for individual\n functions with PutFunctionConcurrency.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Limits that are related to concurrency and storage. All file and storage sizes are in bytes.

" + } + }, + "com.amazonaws.lambda#AccountUsage": { + "type": "structure", + "members": { + "TotalCodeSize": { + "target": "com.amazonaws.lambda#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The amount of storage space, in bytes, that's being used by deployment packages and layer archives.

" + } + }, + "FunctionCount": { + "target": "com.amazonaws.lambda#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of Lambda functions.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The number of functions and amount of storage in use.

" + } + }, + "com.amazonaws.lambda#Action": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(lambda:[*]|lambda:[a-zA-Z]+|[*])$" + } + }, + "com.amazonaws.lambda#AddLayerVersionPermission": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#AddLayerVersionPermissionRequest" + }, + "output": { + "target": "com.amazonaws.lambda#AddLayerVersionPermissionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#PolicyLengthExceededException" + }, + { + "target": "com.amazonaws.lambda#PreconditionFailedException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds permissions to the resource-based policy of a version of an Lambda\n layer. Use this action to grant layer\n usage permission to other accounts. You can grant permission to a single account, all accounts in an organization,\n or all Amazon Web Services accounts.

\n

To revoke permission, call RemoveLayerVersionPermission with the statement ID that you\n specified when you added it.

", + "smithy.api#examples": [ + { + "title": "To add permissions to a layer version", + "documentation": "The following example grants permission for the account 223456789012 to use version 1 of a layer named my-layer.", + "input": { + "LayerName": "my-layer", + "VersionNumber": 1, + "StatementId": "xaccount", + "Action": "lambda:GetLayerVersion", + "Principal": "223456789012" + }, + "output": { + "Statement": "{\"Sid\":\"xaccount\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::223456789012:root\"},\"Action\":\"lambda:GetLayerVersion\",\"Resource\":\"arn:aws:lambda:us-east-2:123456789012:layer:my-layer:1\"}", + "RevisionId": "35d87451-f796-4a3f-a618-95a3671b0a0c" + } + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/2018-10-31/layers/{LayerName}/versions/{VersionNumber}/policy", + "code": 201 + } + } + }, + "com.amazonaws.lambda#AddLayerVersionPermissionRequest": { + "type": "structure", + "members": { + "LayerName": { + "target": "com.amazonaws.lambda#LayerName", + "traits": { + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the layer.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VersionNumber": { + "target": "com.amazonaws.lambda#LayerVersionNumber", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The version number.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "StatementId": { + "target": "com.amazonaws.lambda#StatementId", + "traits": { + "smithy.api#documentation": "

An identifier that distinguishes the policy from others on the same layer version.

", + "smithy.api#required": {} + } + }, + "Action": { + "target": "com.amazonaws.lambda#LayerPermissionAllowedAction", + "traits": { + "smithy.api#documentation": "

The API action that grants access to the layer. For example, lambda:GetLayerVersion.

", + "smithy.api#required": {} + } + }, + "Principal": { + "target": "com.amazonaws.lambda#LayerPermissionAllowedPrincipal", + "traits": { + "smithy.api#documentation": "

An account ID, or * to grant layer usage permission to all\n accounts in an organization, or all Amazon Web Services accounts (if organizationId is not specified).\n For the last case, make sure that you really do want all Amazon Web Services accounts to have usage permission to this layer.\n

", + "smithy.api#required": {} + } + }, + "OrganizationId": { + "target": "com.amazonaws.lambda#OrganizationId", + "traits": { + "smithy.api#documentation": "

With the principal set to *, grant permission to all accounts in the specified\n organization.

" + } + }, + "RevisionId": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

Only update the policy if the revision ID matches the ID specified. Use this option to avoid modifying a\n policy that has changed since you last read it.

", + "smithy.api#httpQuery": "RevisionId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#AddLayerVersionPermissionResponse": { + "type": "structure", + "members": { + "Statement": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

The permission statement.

" + } + }, + "RevisionId": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

A unique identifier for the current revision of the policy.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lambda#AddPermission": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#AddPermissionRequest" + }, + "output": { + "target": "com.amazonaws.lambda#AddPermissionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#PolicyLengthExceededException" + }, + { + "target": "com.amazonaws.lambda#PreconditionFailedException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Grants a principal \n permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict\n access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name\n (ARN) of that version or alias to invoke the function. Note: Lambda does not support adding policies\n to version $LATEST.

\n

To grant permission to another account, specify the account ID as the Principal. To grant\n permission to an organization defined in Organizations, specify the organization ID as the\n PrincipalOrgID. For Amazon Web Services services, the principal is a domain-style identifier that\n the service defines, such as s3.amazonaws.com or sns.amazonaws.com. For Amazon Web Services services, you can also specify the ARN of the associated resource as the SourceArn. If\n you grant permission to a service principal without specifying the source, other accounts could potentially\n configure resources in their account to invoke your Lambda function.

\n

This operation adds a statement to a resource-based permissions policy for the function. For more information\n about function policies, see Using resource-based policies for Lambda.

", + "smithy.api#examples": [ + { + "title": "To grant Amazon S3 permission to invoke a function", + "documentation": "The following example adds permission for Amazon S3 to invoke a Lambda function named my-function for notifications from a bucket named my-bucket-1xpuxmplzrlbh in account 123456789012.", + "input": { + "FunctionName": "my-function", + "StatementId": "s3", + "Action": "lambda:InvokeFunction", + "Principal": "s3.amazonaws.com", + "SourceArn": "arn:aws:s3:::my-bucket-1xpuxmplzrlbh/*", + "SourceAccount": "123456789012" + }, + "output": { + "Statement": "{\"Sid\":\"s3\",\"Effect\":\"Allow\",\"Principal\":{\"Service\":\"s3.amazonaws.com\"},\"Action\":\"lambda:InvokeFunction\",\"Resource\":\"arn:aws:lambda:us-east-2:123456789012:function:my-function\",\"Condition\":{\"StringEquals\":{\"AWS:SourceAccount\":\"123456789012\"},\"ArnLike\":{\"AWS:SourceArn\":\"arn:aws:s3:::my-bucket-1xpuxmplzrlbh\"}}}" + } + }, + { + "title": "To grant another account permission to invoke a function", + "documentation": "The following example adds permission for account 223456789012 invoke a Lambda function named my-function.", + "input": { + "FunctionName": "my-function", + "StatementId": "xaccount", + "Action": "lambda:InvokeFunction", + "Principal": "223456789012" + }, + "output": { + "Statement": "{\"Sid\":\"xaccount\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::223456789012:root\"},\"Action\":\"lambda:InvokeFunction\",\"Resource\":\"arn:aws:lambda:us-east-2:123456789012:function:my-function\"}" + } + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/2015-03-31/functions/{FunctionName}/policy", + "code": 201 + } + } + }, + "com.amazonaws.lambda#AddPermissionRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "

The name or ARN of the Lambda function, version, or alias.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function (name-only), my-function:v1 (with alias).

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\n If you specify only the function name, it is limited to 64 characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "StatementId": { + "target": "com.amazonaws.lambda#StatementId", + "traits": { + "smithy.api#documentation": "

A statement identifier that differentiates the statement from others in the same policy.

", + "smithy.api#required": {} + } + }, + "Action": { + "target": "com.amazonaws.lambda#Action", + "traits": { + "smithy.api#documentation": "

The action that the principal can use on the function. For example, lambda:InvokeFunction or\n lambda:GetFunction.

", + "smithy.api#required": {} + } + }, + "Principal": { + "target": "com.amazonaws.lambda#Principal", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services service, Amazon Web Services account, IAM user, or IAM role that invokes the function. If you specify a\n service, use SourceArn or SourceAccount to limit who can invoke the function through\n that service.

", + "smithy.api#required": {} + } + }, + "SourceArn": { + "target": "com.amazonaws.lambda#Arn", + "traits": { + "smithy.api#documentation": "

For Amazon Web Services services, the ARN of the Amazon Web Services resource that invokes the function. For\n example, an Amazon S3 bucket or Amazon SNS topic.

\n

Note that Lambda configures the comparison using the StringLike operator.

" + } + }, + "SourceAccount": { + "target": "com.amazonaws.lambda#SourceOwner", + "traits": { + "smithy.api#documentation": "

For Amazon Web Services service, the ID of the Amazon Web Services account that owns the resource. Use this\n together with SourceArn to ensure that the specified account owns the resource. It is possible for an\n Amazon S3 bucket to be deleted by its owner and recreated by another account.

" + } + }, + "EventSourceToken": { + "target": "com.amazonaws.lambda#EventSourceToken", + "traits": { + "smithy.api#documentation": "

For Alexa Smart Home functions, a token that the invoker must supply.

" + } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#Qualifier", + "traits": { + "smithy.api#documentation": "

Specify a version or alias to add permissions to a published version of the function.

", + "smithy.api#httpQuery": "Qualifier" + } + }, + "RevisionId": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

Update the policy only if the revision ID matches the ID that's specified. Use this option to avoid modifying a\n policy that has changed since you last read it.

" + } + }, + "PrincipalOrgID": { + "target": "com.amazonaws.lambda#PrincipalOrgID", + "traits": { + "smithy.api#documentation": "

The identifier for your organization in Organizations. Use this to grant permissions to all the\n Amazon Web Services accounts under this organization.

" + } + }, + "FunctionUrlAuthType": { + "target": "com.amazonaws.lambda#FunctionUrlAuthType", + "traits": { + "smithy.api#documentation": "

The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated\n users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information,\n see Security and auth model for Lambda function URLs.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#AddPermissionResponse": { + "type": "structure", + "members": { + "Statement": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

The permission statement that's added to the function policy.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lambda#AdditionalVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[0-9]+$" + } + }, + "com.amazonaws.lambda#AdditionalVersionWeights": { + "type": "map", + "key": { + "target": "com.amazonaws.lambda#AdditionalVersion" + }, + "value": { + "target": "com.amazonaws.lambda#Weight" + } + }, + "com.amazonaws.lambda#Alias": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(?!^[0-9]+$)([a-zA-Z0-9-_]+)$" + } + }, + "com.amazonaws.lambda#AliasConfiguration": { + "type": "structure", + "members": { + "AliasArn": { + "target": "com.amazonaws.lambda#FunctionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the alias.

" + } + }, + "Name": { + "target": "com.amazonaws.lambda#Alias", + "traits": { + "smithy.api#documentation": "

The name of the alias.

" + } + }, + "FunctionVersion": { + "target": "com.amazonaws.lambda#Version", + "traits": { + "smithy.api#documentation": "

The function version that the alias invokes.

" + } + }, + "Description": { + "target": "com.amazonaws.lambda#Description", + "traits": { + "smithy.api#documentation": "

A description of the alias.

" + } + }, + "RoutingConfig": { + "target": "com.amazonaws.lambda#AliasRoutingConfiguration", + "traits": { + "smithy.api#documentation": "

The routing\n configuration of the alias.

" + } + }, + "RevisionId": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

A unique identifier that changes when you update the alias.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides configuration information about a Lambda function alias.

" + } + }, + "com.amazonaws.lambda#AliasList": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#AliasConfiguration" + } + }, + "com.amazonaws.lambda#AliasRoutingConfiguration": { + "type": "structure", + "members": { + "AdditionalVersionWeights": { + "target": "com.amazonaws.lambda#AdditionalVersionWeights", + "traits": { + "smithy.api#documentation": "

The second version, and the percentage of traffic that's routed to it.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The traffic-shifting configuration of a Lambda function alias.

" + } + }, + "com.amazonaws.lambda#AllowCredentials": { + "type": "boolean" + }, + "com.amazonaws.lambda#AllowMethodsList": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#Method" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 6 + } + } + }, + "com.amazonaws.lambda#AllowOriginsList": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#Origin" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.lambda#AllowedPublishers": { + "type": "structure", + "members": { + "SigningProfileVersionArns": { + "target": "com.amazonaws.lambda#SigningProfileVersionArns", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for each of the signing profiles. A signing profile defines a trusted user\n who can sign a code package.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

List of signing profiles that can sign a code package.

" + } + }, + "com.amazonaws.lambda#AmazonManagedKafkaEventSourceConfig": { + "type": "structure", + "members": { + "ConsumerGroupId": { + "target": "com.amazonaws.lambda#URI", + "traits": { + "smithy.api#documentation": "

The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources.\n After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see\n Customizable consumer group ID.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.

" + } + }, + "com.amazonaws.lambda#ApplicationLogLevel": { + "type": "enum", + "members": { + "Trace": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRACE" + } + }, + "Debug": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEBUG" + } + }, + "Info": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INFO" + } + }, + "Warn": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WARN" + } + }, + "Error": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + }, + "Fatal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FATAL" + } + } + } + }, + "com.amazonaws.lambda#Architecture": { + "type": "enum", + "members": { + "x86_64": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x86_64" + } + }, + "arm64": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "arm64" + } + } + } + }, + "com.amazonaws.lambda#ArchitecturesList": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#Architecture" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.lambda#Arn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-])+:([a-z]{2}(-gov)?-[a-z]+-\\d{1})?:(\\d{12})?:(.*)$" + } + }, + "com.amazonaws.lambda#BatchSize": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 10000 + } + } + }, + "com.amazonaws.lambda#BisectBatchOnFunctionError": { + "type": "boolean" + }, + "com.amazonaws.lambda#Blob": { + "type": "blob", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.lambda#BlobStream": { + "type": "blob", + "traits": { + "smithy.api#streaming": {} + } + }, + "com.amazonaws.lambda#Boolean": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.lambda#CodeSigningConfig": { + "type": "structure", + "members": { + "CodeSigningConfigId": { + "target": "com.amazonaws.lambda#CodeSigningConfigId", + "traits": { + "smithy.api#documentation": "

Unique identifer for the Code signing configuration.

", + "smithy.api#required": {} + } + }, + "CodeSigningConfigArn": { + "target": "com.amazonaws.lambda#CodeSigningConfigArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Code signing configuration.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.lambda#Description", + "traits": { + "smithy.api#documentation": "

Code signing configuration description.

" + } + }, + "AllowedPublishers": { + "target": "com.amazonaws.lambda#AllowedPublishers", + "traits": { + "smithy.api#documentation": "

List of allowed publishers.

", + "smithy.api#required": {} + } + }, + "CodeSigningPolicies": { + "target": "com.amazonaws.lambda#CodeSigningPolicies", + "traits": { + "smithy.api#documentation": "

The code signing policy controls the validation failure action for signature mismatch or expiry.

", + "smithy.api#required": {} + } + }, + "LastModified": { + "target": "com.amazonaws.lambda#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the Code signing configuration was last modified, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about a Code signing configuration.

" + } + }, + "com.amazonaws.lambda#CodeSigningConfigArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:code-signing-config:csc-[a-z0-9]{17}$" + } + }, + "com.amazonaws.lambda#CodeSigningConfigId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^csc-[a-zA-Z0-9-_\\.]{17}$" + } + }, + "com.amazonaws.lambda#CodeSigningConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#CodeSigningConfig" + } + }, + "com.amazonaws.lambda#CodeSigningConfigNotFoundException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String" + }, + "Message": { + "target": "com.amazonaws.lambda#String" + } + }, + "traits": { + "smithy.api#documentation": "

The specified code signing configuration does not exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.lambda#CodeSigningPolicies": { + "type": "structure", + "members": { + "UntrustedArtifactOnDeployment": { + "target": "com.amazonaws.lambda#CodeSigningPolicy", + "traits": { + "smithy.api#documentation": "

Code signing configuration policy for deployment validation failure. If you set the policy to\n Enforce, Lambda blocks the deployment request if signature validation checks fail. If you set the\n policy to Warn, Lambda allows the deployment and creates a CloudWatch log.

\n

Default value: Warn\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Code signing configuration policies specify the validation failure action for signature mismatch or\n expiry.

" + } + }, + "com.amazonaws.lambda#CodeSigningPolicy": { + "type": "enum", + "members": { + "Warn": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Warn" + } + }, + "Enforce": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enforce" + } + } + } + }, + "com.amazonaws.lambda#CodeStorageExceededException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

The exception type.

" + } + }, + "message": { + "target": "com.amazonaws.lambda#String" + } + }, + "traits": { + "smithy.api#documentation": "

Your Amazon Web Services account has exceeded its maximum total code size. For more information, see Lambda quotas.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.lambda#CodeVerificationFailedException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String" + }, + "Message": { + "target": "com.amazonaws.lambda#String" + } + }, + "traits": { + "smithy.api#documentation": "

The code signature failed one or more of the validation checks for signature mismatch or expiry, and the code\n signing policy is set to ENFORCE. Lambda blocks the deployment.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.lambda#CollectionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 57 + }, + "smithy.api#pattern": "^(^(?!(system\\x2e)))(^[_a-zA-Z0-9])([^$]*)$" + } + }, + "com.amazonaws.lambda#CompatibleArchitectures": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#Architecture" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2 + } + } + }, + "com.amazonaws.lambda#CompatibleRuntimes": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#Runtime" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 15 + } + } + }, + "com.amazonaws.lambda#Concurrency": { + "type": "structure", + "members": { + "ReservedConcurrentExecutions": { + "target": "com.amazonaws.lambda#ReservedConcurrentExecutions", + "traits": { + "smithy.api#documentation": "

The number of concurrent executions that are reserved for this function. For more information, see Managing Lambda reserved\n concurrency.

" + } + } + } + }, + "com.amazonaws.lambda#Cors": { + "type": "structure", + "members": { + "AllowCredentials": { + "target": "com.amazonaws.lambda#AllowCredentials", + "traits": { + "smithy.api#documentation": "

Whether to allow cookies or other credentials in requests to your function URL. The default is\n false.

" + } + }, + "AllowHeaders": { + "target": "com.amazonaws.lambda#HeadersList", + "traits": { + "smithy.api#documentation": "

The HTTP headers that origins can include in requests to your function URL. For example: Date, Keep-Alive,\n X-Custom-Header.

" + } + }, + "AllowMethods": { + "target": "com.amazonaws.lambda#AllowMethodsList", + "traits": { + "smithy.api#documentation": "

The HTTP methods that are allowed when calling your function URL. For example: GET, POST, DELETE,\n or the wildcard character (*).

" + } + }, + "AllowOrigins": { + "target": "com.amazonaws.lambda#AllowOriginsList", + "traits": { + "smithy.api#documentation": "

The origins that can access your function URL. You can list any number of specific origins, separated by a comma. For example:\n https://www.example.com, http://localhost:60905.

\n

Alternatively, you can grant access to all origins using the wildcard character (*).

" + } + }, + "ExposeHeaders": { + "target": "com.amazonaws.lambda#HeadersList", + "traits": { + "smithy.api#documentation": "

The HTTP headers in your function response that you want to expose to origins that call your function URL. For example:\n Date, Keep-Alive, X-Custom-Header.

" + } + }, + "MaxAge": { + "target": "com.amazonaws.lambda#MaxAge", + "traits": { + "smithy.api#documentation": "

The maximum amount of time, in seconds, that web browsers can cache results of a preflight request. By\n default, this is set to 0, which means that the browser doesn't cache results.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The cross-origin resource sharing\n (CORS) settings for your Lambda function URL. Use CORS to grant access to your function URL\n from any origin. You can also use CORS to control access for specific HTTP headers and methods in requests to your\n function URL.

" + } + }, + "com.amazonaws.lambda#CreateAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#CreateAliasRequest" + }, + "output": { + "target": "com.amazonaws.lambda#AliasConfiguration" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an alias for a\n Lambda function version. Use aliases to provide clients with a function identifier that you can update to invoke a\n different version.

\n

You can also map an alias to split invocation requests between two versions. Use the\n RoutingConfig parameter to specify a second version and the percentage of invocation requests that\n it receives.

", + "smithy.api#examples": [ + { + "title": "To create an alias for a Lambda function", + "documentation": "The following example creates an alias named LIVE that points to version 1 of the my-function Lambda function.", + "input": { + "FunctionName": "my-function", + "Name": "LIVE", + "FunctionVersion": "1", + "Description": "alias for live version of function" + }, + "output": { + "FunctionVersion": "1", + "Name": "LIVE", + "AliasArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:LIVE", + "RevisionId": "873282ed-xmpl-4dc8-a069-d0c647e470c6", + "Description": "alias for live version of function" + } + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/2015-03-31/functions/{FunctionName}/aliases", + "code": 201 + } + } + }, + "com.amazonaws.lambda#CreateAliasRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name - MyFunction.

    \n
    • \n
  • \n

    \n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

    \n
    • \n
  • \n

    \n Partial ARN - 123456789012:function:MyFunction.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.lambda#Alias", + "traits": { + "smithy.api#documentation": "

The name of the alias.

", + "smithy.api#required": {} + } + }, + "FunctionVersion": { + "target": "com.amazonaws.lambda#Version", + "traits": { + "smithy.api#documentation": "

The function version that the alias invokes.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.lambda#Description", + "traits": { + "smithy.api#documentation": "

A description of the alias.

" + } + }, + "RoutingConfig": { + "target": "com.amazonaws.lambda#AliasRoutingConfiguration", + "traits": { + "smithy.api#documentation": "

The routing\n configuration of the alias.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#CreateCodeSigningConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#CreateCodeSigningConfigRequest" + }, + "output": { + "target": "com.amazonaws.lambda#CreateCodeSigningConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a code signing configuration. A code signing configuration defines a list of\n allowed signing profiles and defines the code-signing validation policy (action to be taken if deployment\n validation checks fail).

", + "smithy.api#http": { + "method": "POST", + "uri": "/2020-04-22/code-signing-configs", + "code": 201 + } + } + }, + "com.amazonaws.lambda#CreateCodeSigningConfigRequest": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.lambda#Description", + "traits": { + "smithy.api#documentation": "

Descriptive name for this code signing configuration.

" + } + }, + "AllowedPublishers": { + "target": "com.amazonaws.lambda#AllowedPublishers", + "traits": { + "smithy.api#documentation": "

Signing profiles for this code signing configuration.

", + "smithy.api#required": {} + } + }, + "CodeSigningPolicies": { + "target": "com.amazonaws.lambda#CodeSigningPolicies", + "traits": { + "smithy.api#documentation": "

The code signing policies define the actions to take if the validation checks fail.

" + } + }, + "Tags": { + "target": "com.amazonaws.lambda#Tags", + "traits": { + "smithy.api#documentation": "

A list of tags to add to the code signing configuration.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#CreateCodeSigningConfigResponse": { + "type": "structure", + "members": { + "CodeSigningConfig": { + "target": "com.amazonaws.lambda#CodeSigningConfig", + "traits": { + "smithy.api#documentation": "

The code signing configuration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lambda#CreateEventSourceMapping": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#CreateEventSourceMappingRequest" + }, + "output": { + "target": "com.amazonaws.lambda#EventSourceMappingConfiguration" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a mapping between an event source and an Lambda function. Lambda reads items from the event source and invokes the function.

\n

For details about how to configure different event sources, see the following topics.

\n \n

The following error handling options are available only for DynamoDB and Kinesis event sources:

\n
    \n
  • \n

    \n BisectBatchOnFunctionError – If the function returns an error, split the batch in two and retry.

    \n
    • \n
  • \n

    \n MaximumRecordAgeInSeconds – Discard records older than the specified age. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires

    \n
    • \n
  • \n

    \n MaximumRetryAttempts – Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.

    \n
    • \n
  • \n

    \n ParallelizationFactor – Process multiple batches from each shard concurrently.

    \n
    • \n
\n

For stream sources (DynamoDB, Kinesis, Amazon MSK, and self-managed Apache Kafka), the following option is also available:

\n
    \n
  • \n

    \n DestinationConfig – Send discarded records to an Amazon SQS queue, Amazon SNS topic, or \n Amazon S3 bucket.

    \n
    • \n
\n

For information about which configuration parameters apply to each event source, see the following topics.

\n ", + "smithy.api#examples": [ + { + "title": "To create a mapping between an event source and an AWS Lambda function", + "documentation": "The following example creates a mapping between an SQS queue and the my-function Lambda function.", + "input": { + "EventSourceArn": "arn:aws:sqs:us-west-2:123456789012:my-queue", + "FunctionName": "my-function", + "BatchSize": 5 + }, + "output": { + "UUID": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "StateTransitionReason": "USER_INITIATED", + "LastModified": 1.569284520333E9, + "BatchSize": 5, + "State": "Creating", + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "EventSourceArn": "arn:aws:sqs:us-west-2:123456789012:my-queue" + } + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/2015-03-31/event-source-mappings", + "code": 202 + } + } + }, + "com.amazonaws.lambda#CreateEventSourceMappingRequest": { + "type": "structure", + "members": { + "EventSourceArn": { + "target": "com.amazonaws.lambda#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the event source.

\n
    \n
  • \n

    \n Amazon Kinesis – The ARN of the data stream or a stream consumer.

    \n
    • \n
  • \n

    \n Amazon DynamoDB Streams – The ARN of the stream.

    \n
    • \n
  • \n

    \n Amazon Simple Queue Service – The ARN of the queue.

    \n
    • \n
  • \n

    \n Amazon Managed Streaming for Apache Kafka – The ARN of the cluster or the ARN of the VPC connection (for cross-account event source mappings).

    \n
    • \n
  • \n

    \n Amazon MQ – The ARN of the broker.

    \n
    • \n
  • \n

    \n Amazon DocumentDB – The ARN of the DocumentDB change stream.

    \n
    • \n
" + } + }, + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – MyFunction.

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

    \n
    • \n
  • \n

    \n Version or Alias ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:MyFunction.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64\n characters in length.

", + "smithy.api#required": {} + } + }, + "Enabled": { + "target": "com.amazonaws.lambda#Enabled", + "traits": { + "smithy.api#documentation": "

When true, the event source mapping is active. When false, Lambda pauses polling and invocation.

\n

Default: True

" + } + }, + "BatchSize": { + "target": "com.amazonaws.lambda#BatchSize", + "traits": { + "smithy.api#documentation": "

The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation\n (6 MB).

\n
    \n
  • \n

    \n Amazon Kinesis – Default 100. Max 10,000.

    \n
    • \n
  • \n

    \n Amazon DynamoDB Streams – Default 100. Max 10,000.

    \n
    • \n
  • \n

    \n Amazon Simple Queue Service – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.

    \n
    • \n
  • \n

    \n Amazon Managed Streaming for Apache Kafka – Default 100. Max 10,000.

    \n
    • \n
  • \n

    \n Self-managed Apache Kafka – Default 100. Max 10,000.

    \n
    • \n
  • \n

    \n Amazon MQ (ActiveMQ and RabbitMQ) – Default 100. Max 10,000.

    \n
    • \n
  • \n

    \n DocumentDB – Default 100. Max 10,000.

    \n
    • \n
" + } + }, + "FilterCriteria": { + "target": "com.amazonaws.lambda#FilterCriteria", + "traits": { + "smithy.api#documentation": "

An object that defines the filter criteria that\n determine whether Lambda should process an event. For more information, see Lambda event filtering.

" + } + }, + "MaximumBatchingWindowInSeconds": { + "target": "com.amazonaws.lambda#MaximumBatchingWindowInSeconds", + "traits": { + "smithy.api#documentation": "

The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.\n You can configure MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of seconds.

\n

For Kinesis, DynamoDB, and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, the default\n batching window is 500 ms. Note that because you can only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it.\n To restore the default batching window, you must create a new event source mapping.

\n

Related setting: For Kinesis, DynamoDB, and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

" + } + }, + "ParallelizationFactor": { + "target": "com.amazonaws.lambda#ParallelizationFactor", + "traits": { + "smithy.api#documentation": "

(Kinesis and DynamoDB Streams only) The number of batches to process from each shard concurrently.

" + } + }, + "StartingPosition": { + "target": "com.amazonaws.lambda#EventSourcePosition", + "traits": { + "smithy.api#documentation": "

The position in a stream from which to start reading. Required for Amazon Kinesis and\n Amazon DynamoDB Stream event sources. AT_TIMESTAMP is supported only for\n Amazon Kinesis streams, Amazon DocumentDB, Amazon MSK, and self-managed Apache Kafka.

" + } + }, + "StartingPositionTimestamp": { + "target": "com.amazonaws.lambda#Date", + "traits": { + "smithy.api#documentation": "

With StartingPosition set to AT_TIMESTAMP, the time from which to start\n reading. StartingPositionTimestamp cannot be in the future.

" + } + }, + "DestinationConfig": { + "target": "com.amazonaws.lambda#DestinationConfig", + "traits": { + "smithy.api#documentation": "

(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Kafka only) A configuration object that specifies the destination of an event after Lambda processes it.

" + } + }, + "MaximumRecordAgeInSeconds": { + "target": "com.amazonaws.lambda#MaximumRecordAgeInSeconds", + "traits": { + "smithy.api#documentation": "

(Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is infinite (-1).

" + } + }, + "BisectBatchOnFunctionError": { + "target": "com.amazonaws.lambda#BisectBatchOnFunctionError", + "traits": { + "smithy.api#documentation": "

(Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.

" + } + }, + "MaximumRetryAttempts": { + "target": "com.amazonaws.lambda#MaximumRetryAttemptsEventSourceMapping", + "traits": { + "smithy.api#documentation": "

(Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.

" + } + }, + "Tags": { + "target": "com.amazonaws.lambda#Tags", + "traits": { + "smithy.api#documentation": "

A list of tags to apply to the event source mapping.

" + } + }, + "TumblingWindowInSeconds": { + "target": "com.amazonaws.lambda#TumblingWindowInSeconds", + "traits": { + "smithy.api#documentation": "

(Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window.

" + } + }, + "Topics": { + "target": "com.amazonaws.lambda#Topics", + "traits": { + "smithy.api#documentation": "

The name of the Kafka topic.

" + } + }, + "Queues": { + "target": "com.amazonaws.lambda#Queues", + "traits": { + "smithy.api#documentation": "

(MQ) The name of the Amazon MQ broker destination queue to consume.

" + } + }, + "SourceAccessConfigurations": { + "target": "com.amazonaws.lambda#SourceAccessConfigurations", + "traits": { + "smithy.api#documentation": "

An array of authentication protocols or VPC components required to secure your event source.

" + } + }, + "SelfManagedEventSource": { + "target": "com.amazonaws.lambda#SelfManagedEventSource", + "traits": { + "smithy.api#documentation": "

The self-managed Apache Kafka cluster to receive records from.

" + } + }, + "FunctionResponseTypes": { + "target": "com.amazonaws.lambda#FunctionResponseTypeList", + "traits": { + "smithy.api#documentation": "

(Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.

" + } + }, + "AmazonManagedKafkaEventSourceConfig": { + "target": "com.amazonaws.lambda#AmazonManagedKafkaEventSourceConfig", + "traits": { + "smithy.api#documentation": "

Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.

" + } + }, + "SelfManagedKafkaEventSourceConfig": { + "target": "com.amazonaws.lambda#SelfManagedKafkaEventSourceConfig", + "traits": { + "smithy.api#documentation": "

Specific configuration settings for a self-managed Apache Kafka event source.

" + } + }, + "ScalingConfig": { + "target": "com.amazonaws.lambda#ScalingConfig", + "traits": { + "smithy.api#documentation": "

(Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.

" + } + }, + "DocumentDBEventSourceConfig": { + "target": "com.amazonaws.lambda#DocumentDBEventSourceConfig", + "traits": { + "smithy.api#documentation": "

Specific configuration settings for a DocumentDB event source.

" + } + }, + "KMSKeyArn": { + "target": "com.amazonaws.lambda#KMSKeyArn", + "traits": { + "smithy.api#documentation": "

\n The ARN of the Key Management Service (KMS) customer managed key that Lambda\n uses to encrypt your function's filter criteria.\n By default, Lambda does not encrypt your filter criteria object. Specify this\n property to encrypt data using your own customer managed key.\n

" + } + }, + "MetricsConfig": { + "target": "com.amazonaws.lambda#EventSourceMappingMetricsConfig", + "traits": { + "smithy.api#documentation": "

The metrics configuration for your event source. For more information, see Event source mapping metrics.

" + } + }, + "ProvisionedPollerConfig": { + "target": "com.amazonaws.lambda#ProvisionedPollerConfig", + "traits": { + "smithy.api#documentation": "

(Amazon MSK and self-managed Apache Kafka only) The Provisioned Mode configuration for the event source.\n For more information, see Provisioned Mode.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#CreateFunction": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#CreateFunctionRequest" + }, + "output": { + "target": "com.amazonaws.lambda#FunctionConfiguration" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#CodeSigningConfigNotFoundException" + }, + { + "target": "com.amazonaws.lambda#CodeStorageExceededException" + }, + { + "target": "com.amazonaws.lambda#CodeVerificationFailedException" + }, + { + "target": "com.amazonaws.lambda#InvalidCodeSignatureException" + }, + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a Lambda function. To create a function, you need a deployment package and an execution role. The\n deployment package is a .zip file archive or container image that contains your function code. The execution role\n grants the function permission to use Amazon Web Services services, such as Amazon CloudWatch Logs for log\n streaming and X-Ray for request tracing.

\n

If the deployment package is a container\n image, then you set the package type to Image. For a container image, the code property\n must include the URI of a container image in the Amazon ECR registry. You do not need to specify the\n handler and runtime properties.

\n

If the deployment package is a .zip file archive, then\n you set the package type to Zip. For a .zip file archive, the code property specifies the location of\n the .zip file. You must also specify the handler and runtime properties. The code in the deployment package must\n be compatible with the target instruction set architecture of the function (x86-64 or\n arm64). If you do not specify the architecture, then the default value is\n x86-64.

\n

When you create a function, Lambda provisions an instance of the function and its supporting\n resources. If your function connects to a VPC, this process can take a minute or so. During this time, you can't\n invoke or modify the function. The State, StateReason, and StateReasonCode\n fields in the response from GetFunctionConfiguration indicate when the function is ready to\n invoke. For more information, see Lambda function states.

\n

A function has an unpublished version, and can have published versions and aliases. The unpublished version\n changes when you update your function's code and configuration. A published version is a snapshot of your function\n code and configuration that can't be changed. An alias is a named resource that maps to a version, and can be\n changed to map to a different version. Use the Publish parameter to create version 1 of\n your function from its initial configuration.

\n

The other parameters let you configure version-specific and function-level settings. You can modify\n version-specific settings later with UpdateFunctionConfiguration. Function-level settings apply\n to both the unpublished and published versions of the function, and include tags (TagResource)\n and per-function concurrency limits (PutFunctionConcurrency).

\n

You can use code signing if your deployment package is a .zip file archive. To enable code signing for this\n function, specify the ARN of a code-signing configuration. When a user attempts to deploy a code package with\n UpdateFunctionCode, Lambda checks that the code package has a valid signature from\n a trusted publisher. The code-signing configuration includes set of signing profiles, which define the trusted\n publishers for this function.

\n

If another Amazon Web Services account or an Amazon Web Services service invokes your function, use AddPermission to grant permission by creating a resource-based Identity and Access Management (IAM) policy. You can grant permissions at the function level, on a version, or on an alias.

\n

To invoke your function directly, use Invoke. To invoke your function in response to events\n in other Amazon Web Services services, create an event source mapping (CreateEventSourceMapping),\n or configure a function trigger in the other service. For more information, see Invoking Lambda\n functions.

", + "smithy.api#examples": [ + { + "title": "To create a function", + "documentation": "The following example creates a function with a deployment package in Amazon S3 and enables X-Ray tracing and environment variable encryption.", + "input": { + "FunctionName": "my-function", + "Runtime": "nodejs12.x", + "Role": "arn:aws:iam::123456789012:role/lambda-role", + "Handler": "index.handler", + "Code": { + "S3Bucket": "my-bucket-1xpuxmplzrlbh", + "S3Key": "function.zip" + }, + "Description": "Process image objects from Amazon S3.", + "Timeout": 15, + "MemorySize": 256, + "Publish": true, + "Environment": { + "Variables": { + "BUCKET": "my-bucket-1xpuxmplzrlbh", + "PREFIX": "inbound" + } + }, + "KMSKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966", + "TracingConfig": { + "Mode": "Active" + }, + "Tags": { + "DEPARTMENT": "Assets" + } + }, + "output": { + "FunctionName": "my-function", + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "Runtime": "nodejs12.x", + "Role": "arn:aws:iam::123456789012:role/lambda-role", + "Handler": "index.handler", + "CodeSize": 5797206, + "Description": "Process image objects from Amazon S3.", + "Timeout": 15, + "MemorySize": 256, + "LastModified": "2020-04-10T19:06:32.563+0000", + "CodeSha256": "YFgDgEKG3ugvF1+pX64gV6tu9qNuIYNUdgJm8nCxsm4=", + "Version": "1", + "Environment": { + "Variables": { + "PREFIX": "inbound", + "BUCKET": "my-bucket-1xpuxmplzrlbh" + } + }, + "KMSKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966", + "TracingConfig": { + "Mode": "Active" + }, + "RevisionId": "b75dcd81-xmpl-48a8-a75a-93ba8b5b9727", + "State": "Active", + "LastUpdateStatus": "Successful" + } + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/2015-03-31/functions", + "code": 201 + } + } + }, + "com.amazonaws.lambda#CreateFunctionRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function.

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#required": {} + } + }, + "Runtime": { + "target": "com.amazonaws.lambda#Runtime", + "traits": { + "smithy.api#documentation": "

The identifier of the function's \n runtime. Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in\n an error if you're deploying a function using a container image.

\n

The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing\n functions shortly after each runtime is deprecated. For more information, see\n Runtime use after deprecation.

\n

For a list of all currently supported runtimes, see\n Supported runtimes.

" + } + }, + "Role": { + "target": "com.amazonaws.lambda#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the function's execution role.

", + "smithy.api#required": {} + } + }, + "Handler": { + "target": "com.amazonaws.lambda#Handler", + "traits": { + "smithy.api#documentation": "

The name of the method within your code that Lambda calls to run your function. \nHandler is required if the deployment package is a .zip file archive. The format includes the\n file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information,\n see Lambda programming model.

" + } + }, + "Code": { + "target": "com.amazonaws.lambda#FunctionCode", + "traits": { + "smithy.api#documentation": "

The code for the function.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.lambda#Description", + "traits": { + "smithy.api#documentation": "

A description of the function.

" + } + }, + "Timeout": { + "target": "com.amazonaws.lambda#Timeout", + "traits": { + "smithy.api#documentation": "

The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The\n maximum allowed value is 900 seconds. For more information, see Lambda execution environment.

" + } + }, + "MemorySize": { + "target": "com.amazonaws.lambda#MemorySize", + "traits": { + "smithy.api#documentation": "

The amount of memory available to the function at runtime.\n Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB.

" + } + }, + "Publish": { + "target": "com.amazonaws.lambda#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Set to true to publish the first version of the function during creation.

" + } + }, + "VpcConfig": { + "target": "com.amazonaws.lambda#VpcConfig", + "traits": { + "smithy.api#documentation": "

For network connectivity to Amazon Web Services resources in a VPC, specify a list of security groups and subnets in the VPC.\n When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more\n information, see Configuring a Lambda function to access resources in a VPC.

" + } + }, + "PackageType": { + "target": "com.amazonaws.lambda#PackageType", + "traits": { + "smithy.api#documentation": "

The type of deployment package. Set to Image for container image and set to Zip for .zip file archive.

" + } + }, + "DeadLetterConfig": { + "target": "com.amazonaws.lambda#DeadLetterConfig", + "traits": { + "smithy.api#documentation": "

A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events\n when they fail processing. For more information, see Dead-letter queues.

" + } + }, + "Environment": { + "target": "com.amazonaws.lambda#Environment", + "traits": { + "smithy.api#documentation": "

Environment variables that are accessible from function code during execution.

" + } + }, + "KMSKeyArn": { + "target": "com.amazonaws.lambda#KMSKeyArn", + "traits": { + "smithy.api#documentation": "

The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt the following resources:

\n
    \n
  • \n

    The function's environment variables.

    \n
    • \n
  • \n

    The function's Lambda SnapStart snapshots.

    \n
    • \n
  • \n

    When used with SourceKMSKeyArn, the unzipped version of the .zip deployment package that's used for function invocations. For more information, see \nSpecifying a customer managed key for Lambda.

    \n
    • \n
  • \n

    The optimized version of the container image that's used for function invocations. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). For more information, see Function lifecycle.

    \n
    • \n
\n

If you don't provide a customer managed key, Lambda uses an Amazon Web Services owned key or an Amazon Web Services managed key.

" + } + }, + "TracingConfig": { + "target": "com.amazonaws.lambda#TracingConfig", + "traits": { + "smithy.api#documentation": "

Set Mode to Active to sample and trace a subset of incoming requests with\nX-Ray.

" + } + }, + "Tags": { + "target": "com.amazonaws.lambda#Tags", + "traits": { + "smithy.api#documentation": "

A list of tags to apply to the\n function.

" + } + }, + "Layers": { + "target": "com.amazonaws.lambda#LayerList", + "traits": { + "smithy.api#documentation": "

A list of function layers\n to add to the function's execution environment. Specify each layer by its ARN, including the version.

" + } + }, + "FileSystemConfigs": { + "target": "com.amazonaws.lambda#FileSystemConfigList", + "traits": { + "smithy.api#documentation": "

Connection settings for an Amazon EFS file system.

" + } + }, + "ImageConfig": { + "target": "com.amazonaws.lambda#ImageConfig", + "traits": { + "smithy.api#documentation": "

Container image configuration\n values that override the values in the container image Dockerfile.

" + } + }, + "CodeSigningConfigArn": { + "target": "com.amazonaws.lambda#CodeSigningConfigArn", + "traits": { + "smithy.api#documentation": "

To enable code signing for this function, specify the ARN of a code-signing configuration. A code-signing configuration\nincludes a set of signing profiles, which define the trusted publishers for this function.

" + } + }, + "Architectures": { + "target": "com.amazonaws.lambda#ArchitecturesList", + "traits": { + "smithy.api#documentation": "

The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64).\n The default value is x86_64.

" + } + }, + "EphemeralStorage": { + "target": "com.amazonaws.lambda#EphemeralStorage", + "traits": { + "smithy.api#documentation": "

The size of the function's /tmp directory in MB. The default value is 512, but can be any whole\n number between 512 and 10,240 MB. For more information, see Configuring ephemeral storage (console).

" + } + }, + "SnapStart": { + "target": "com.amazonaws.lambda#SnapStart", + "traits": { + "smithy.api#documentation": "

The function's SnapStart setting.

" + } + }, + "LoggingConfig": { + "target": "com.amazonaws.lambda#LoggingConfig", + "traits": { + "smithy.api#documentation": "

The function's Amazon CloudWatch Logs configuration settings.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#CreateFunctionUrlConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#CreateFunctionUrlConfigRequest" + }, + "output": { + "target": "com.amazonaws.lambda#CreateFunctionUrlConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a Lambda function URL with the specified configuration parameters. A function URL is\n a dedicated HTTP(S) endpoint that you can use to invoke your function.

", + "smithy.api#http": { + "method": "POST", + "uri": "/2021-10-31/functions/{FunctionName}/url", + "code": 201 + } + } + }, + "com.amazonaws.lambda#CreateFunctionUrlConfigRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function.

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#FunctionUrlQualifier", + "traits": { + "smithy.api#documentation": "

The alias name.

", + "smithy.api#httpQuery": "Qualifier" + } + }, + "AuthType": { + "target": "com.amazonaws.lambda#FunctionUrlAuthType", + "traits": { + "smithy.api#documentation": "

The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated\n users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information,\n see Security and auth model for Lambda function URLs.

", + "smithy.api#required": {} + } + }, + "Cors": { + "target": "com.amazonaws.lambda#Cors", + "traits": { + "smithy.api#documentation": "

The cross-origin resource sharing (CORS) settings\n for your function URL.

" + } + }, + "InvokeMode": { + "target": "com.amazonaws.lambda#InvokeMode", + "traits": { + "smithy.api#documentation": "

Use one of the following options:

\n
    \n
  • \n

    \n BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results \n are available when the payload is complete. The maximum payload size is 6 MB.

    \n
    • \n
  • \n

    \n RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using \n the InvokeWithResponseStream API operation. The maximum response payload size is 20 MB, however, you can request a quota increase.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#CreateFunctionUrlConfigResponse": { + "type": "structure", + "members": { + "FunctionUrl": { + "target": "com.amazonaws.lambda#FunctionUrl", + "traits": { + "smithy.api#documentation": "

The HTTP URL endpoint for your function.

", + "smithy.api#required": {} + } + }, + "FunctionArn": { + "target": "com.amazonaws.lambda#FunctionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of your function.

", + "smithy.api#required": {} + } + }, + "AuthType": { + "target": "com.amazonaws.lambda#FunctionUrlAuthType", + "traits": { + "smithy.api#documentation": "

The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated\n users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information,\n see Security and auth model for Lambda function URLs.

", + "smithy.api#required": {} + } + }, + "Cors": { + "target": "com.amazonaws.lambda#Cors", + "traits": { + "smithy.api#documentation": "

The cross-origin resource sharing (CORS) settings\n for your function URL.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.lambda#Timestamp", + "traits": { + "smithy.api#documentation": "

When the function URL was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

", + "smithy.api#required": {} + } + }, + "InvokeMode": { + "target": "com.amazonaws.lambda#InvokeMode", + "traits": { + "smithy.api#documentation": "

Use one of the following options:

\n
    \n
  • \n

    \n BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results \n are available when the payload is complete. The maximum payload size is 6 MB.

    \n
    • \n
  • \n

    \n RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using \n the InvokeWithResponseStream API operation. The maximum response payload size is 20 MB, however, you can request a quota increase.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lambda#DatabaseName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[^ /\\.$\\x22]*$" + } + }, + "com.amazonaws.lambda#Date": { + "type": "timestamp" + }, + "com.amazonaws.lambda#DeadLetterConfig": { + "type": "structure", + "members": { + "TargetArn": { + "target": "com.amazonaws.lambda#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The dead-letter queue for\n failed asynchronous invocations.

" + } + }, + "com.amazonaws.lambda#DeleteAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#DeleteAliasRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a Lambda function alias.

", + "smithy.api#examples": [ + { + "title": "To delete a Lambda function alias", + "documentation": "The following example deletes an alias named BLUE from a function named my-function", + "input": { + "FunctionName": "my-function", + "Name": "BLUE" + } + } + ], + "smithy.api#http": { + "method": "DELETE", + "uri": "/2015-03-31/functions/{FunctionName}/aliases/{Name}", + "code": 204 + } + } + }, + "com.amazonaws.lambda#DeleteAliasRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name - MyFunction.

    \n
    • \n
  • \n

    \n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

    \n
    • \n
  • \n

    \n Partial ARN - 123456789012:function:MyFunction.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.lambda#Alias", + "traits": { + "smithy.api#documentation": "

The name of the alias.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#DeleteCodeSigningConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#DeleteCodeSigningConfigRequest" + }, + "output": { + "target": "com.amazonaws.lambda#DeleteCodeSigningConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the code signing configuration. You can delete the code signing configuration only if no function is\n using it.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/2020-04-22/code-signing-configs/{CodeSigningConfigArn}", + "code": 204 + } + } + }, + "com.amazonaws.lambda#DeleteCodeSigningConfigRequest": { + "type": "structure", + "members": { + "CodeSigningConfigArn": { + "target": "com.amazonaws.lambda#CodeSigningConfigArn", + "traits": { + "smithy.api#documentation": "

The The Amazon Resource Name (ARN) of the code signing configuration.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#DeleteCodeSigningConfigResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lambda#DeleteEventSourceMapping": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#DeleteEventSourceMappingRequest" + }, + "output": { + "target": "com.amazonaws.lambda#EventSourceMappingConfiguration" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceInUseException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an event source\n mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.

\n

When you delete an event source mapping, it enters a Deleting state and might not be completely\n deleted for several seconds.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/2015-03-31/event-source-mappings/{UUID}", + "code": 202 + } + } + }, + "com.amazonaws.lambda#DeleteEventSourceMappingRequest": { + "type": "structure", + "members": { + "UUID": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

The identifier of the event source mapping.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#DeleteFunction": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#DeleteFunctionRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a Lambda function. To delete a specific function version, use the Qualifier parameter.\n Otherwise, all versions and aliases are deleted. This doesn't require the user to have explicit\n permissions for DeleteAlias.

\n

To delete Lambda event source mappings that invoke a function, use DeleteEventSourceMapping. For Amazon Web Services services and resources that invoke your function\n directly, delete the trigger in the service where you originally configured it.

", + "smithy.api#examples": [ + { + "title": "To delete a version of a Lambda function", + "documentation": "The following example deletes version 1 of a Lambda function named my-function.", + "input": { + "FunctionName": "my-function", + "Qualifier": "1" + } + } + ], + "smithy.api#http": { + "method": "DELETE", + "uri": "/2015-03-31/functions/{FunctionName}", + "code": 204 + } + } + }, + "com.amazonaws.lambda#DeleteFunctionCodeSigningConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#DeleteFunctionCodeSigningConfigRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#CodeSigningConfigNotFoundException" + }, + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes the code signing configuration from the function.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/2020-06-30/functions/{FunctionName}/code-signing-config", + "code": 204 + } + } + }, + "com.amazonaws.lambda#DeleteFunctionCodeSigningConfigRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name - MyFunction.

    \n
    • \n
  • \n

    \n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

    \n
    • \n
  • \n

    \n Partial ARN - 123456789012:function:MyFunction.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#DeleteFunctionConcurrency": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#DeleteFunctionConcurrencyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes a concurrent execution limit from a function.

", + "smithy.api#examples": [ + { + "title": "To remove the reserved concurrent execution limit from a function", + "documentation": "The following example deletes the reserved concurrent execution limit from a function named my-function.", + "input": { + "FunctionName": "my-function" + } + } + ], + "smithy.api#http": { + "method": "DELETE", + "uri": "/2017-10-31/functions/{FunctionName}/concurrency", + "code": 204 + } + } + }, + "com.amazonaws.lambda#DeleteFunctionConcurrencyRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function.

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#DeleteFunctionEventInvokeConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#DeleteFunctionEventInvokeConfigRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the configuration for asynchronous invocation for a function, version, or alias.

\n

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

", + "smithy.api#examples": [ + { + "title": "To delete an asynchronous invocation configuration", + "documentation": "The following example deletes the asynchronous invocation configuration for the GREEN alias of a function named my-function.", + "input": { + "FunctionName": "my-function", + "Qualifier": "GREEN" + } + } + ], + "smithy.api#http": { + "method": "DELETE", + "uri": "/2019-09-25/functions/{FunctionName}/event-invoke-config", + "code": 204 + } + } + }, + "com.amazonaws.lambda#DeleteFunctionEventInvokeConfigRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "

The name or ARN of the Lambda function, version, or alias.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name - my-function (name-only), my-function:v1 (with alias).

    \n
    • \n
  • \n

    \n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN - 123456789012:function:my-function.

    \n
    • \n
\n

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\n If you specify only the function name, it is limited to 64 characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#Qualifier", + "traits": { + "smithy.api#documentation": "

A version number or alias name.

", + "smithy.api#httpQuery": "Qualifier" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#DeleteFunctionRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "

The name or ARN of the Lambda function or version.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function (name-only), my-function:1 (with version).

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\n If you specify only the function name, it is limited to 64 characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#Qualifier", + "traits": { + "smithy.api#documentation": "

Specify a version to delete. You can't delete a version that an alias references.

", + "smithy.api#httpQuery": "Qualifier" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#DeleteFunctionUrlConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#DeleteFunctionUrlConfigRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a Lambda function URL. When you delete a function URL, you\n can't recover it. Creating a new function URL results in a different URL address.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/2021-10-31/functions/{FunctionName}/url", + "code": 204 + } + } + }, + "com.amazonaws.lambda#DeleteFunctionUrlConfigRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function.

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#FunctionUrlQualifier", + "traits": { + "smithy.api#documentation": "

The alias name.

", + "smithy.api#httpQuery": "Qualifier" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#DeleteLayerVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#DeleteLayerVersionRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a version of an Lambda\n layer. Deleted versions can no longer be viewed or added to functions. To avoid\n breaking functions, a copy of the version remains in Lambda until no functions refer to it.

", + "smithy.api#examples": [ + { + "title": "To delete a version of a Lambda layer", + "documentation": "The following example deletes version 2 of a layer named my-layer.", + "input": { + "LayerName": "my-layer", + "VersionNumber": 2 + } + } + ], + "smithy.api#http": { + "method": "DELETE", + "uri": "/2018-10-31/layers/{LayerName}/versions/{VersionNumber}", + "code": 204 + } + } + }, + "com.amazonaws.lambda#DeleteLayerVersionRequest": { + "type": "structure", + "members": { + "LayerName": { + "target": "com.amazonaws.lambda#LayerName", + "traits": { + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the layer.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VersionNumber": { + "target": "com.amazonaws.lambda#LayerVersionNumber", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The version number.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#DeleteProvisionedConcurrencyConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#DeleteProvisionedConcurrencyConfigRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the provisioned concurrency configuration for a function.

", + "smithy.api#examples": [ + { + "title": "To delete a provisioned concurrency configuration", + "documentation": "The following example deletes the provisioned concurrency configuration for the GREEN alias of a function named my-function.", + "input": { + "FunctionName": "my-function", + "Qualifier": "GREEN" + } + } + ], + "smithy.api#http": { + "method": "DELETE", + "uri": "/2019-09-30/functions/{FunctionName}/provisioned-concurrency", + "code": 204 + } + } + }, + "com.amazonaws.lambda#DeleteProvisionedConcurrencyConfigRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function.

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#Qualifier", + "traits": { + "smithy.api#documentation": "

The version number or alias name.

", + "smithy.api#httpQuery": "Qualifier", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.lambda#DestinationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 350 + }, + "smithy.api#pattern": "^$|arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-])+:([a-z]{2}(-gov)?-[a-z]+-\\d{1})?:(\\d{12})?:(.*)$" + } + }, + "com.amazonaws.lambda#DestinationConfig": { + "type": "structure", + "members": { + "OnSuccess": { + "target": "com.amazonaws.lambda#OnSuccess", + "traits": { + "smithy.api#documentation": "

The destination configuration for successful invocations.

" + } + }, + "OnFailure": { + "target": "com.amazonaws.lambda#OnFailure", + "traits": { + "smithy.api#documentation": "

The destination configuration for failed invocations.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A configuration object that specifies the destination of an event after Lambda processes it.

" + } + }, + "com.amazonaws.lambda#DocumentDBEventSourceConfig": { + "type": "structure", + "members": { + "DatabaseName": { + "target": "com.amazonaws.lambda#DatabaseName", + "traits": { + "smithy.api#documentation": "

\n The name of the database to consume within the DocumentDB cluster.\n

" + } + }, + "CollectionName": { + "target": "com.amazonaws.lambda#CollectionName", + "traits": { + "smithy.api#documentation": "

\n The name of the collection to consume within the database. If you do not specify a collection, Lambda consumes all collections.\n

" + } + }, + "FullDocument": { + "target": "com.amazonaws.lambda#FullDocument", + "traits": { + "smithy.api#documentation": "

\n Determines what DocumentDB sends to your event stream during document update operations. If set to UpdateLookup, DocumentDB sends a delta describing the changes, along with a copy of the entire document. Otherwise, DocumentDB sends only a partial document that contains the changes.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Specific configuration settings for a DocumentDB event source.\n

" + } + }, + "com.amazonaws.lambda#EC2AccessDeniedException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String" + }, + "Message": { + "target": "com.amazonaws.lambda#String" + } + }, + "traits": { + "smithy.api#documentation": "

Need additional permissions to configure VPC settings.

", + "smithy.api#error": "server", + "smithy.api#httpError": 502 + } + }, + "com.amazonaws.lambda#EC2ThrottledException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String" + }, + "Message": { + "target": "com.amazonaws.lambda#String" + } + }, + "traits": { + "smithy.api#documentation": "

Amazon EC2 throttled Lambda during Lambda function initialization using\n the execution role provided for the function.

", + "smithy.api#error": "server", + "smithy.api#httpError": 502 + } + }, + "com.amazonaws.lambda#EC2UnexpectedException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String" + }, + "Message": { + "target": "com.amazonaws.lambda#String" + }, + "EC2ErrorCode": { + "target": "com.amazonaws.lambda#String" + } + }, + "traits": { + "smithy.api#documentation": "

Lambda received an unexpected Amazon EC2 client exception while setting up for the\n Lambda function.

", + "smithy.api#error": "server", + "smithy.api#httpError": 502 + } + }, + "com.amazonaws.lambda#EFSIOException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String" + }, + "Message": { + "target": "com.amazonaws.lambda#String" + } + }, + "traits": { + "smithy.api#documentation": "

An error occurred when reading from or writing to a connected file system.

", + "smithy.api#error": "client", + "smithy.api#httpError": 410 + } + }, + "com.amazonaws.lambda#EFSMountConnectivityException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String" + }, + "Message": { + "target": "com.amazonaws.lambda#String" + } + }, + "traits": { + "smithy.api#documentation": "

The Lambda function couldn't make a network connection to the configured file system.

", + "smithy.api#error": "client", + "smithy.api#httpError": 408 + } + }, + "com.amazonaws.lambda#EFSMountFailureException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String" + }, + "Message": { + "target": "com.amazonaws.lambda#String" + } + }, + "traits": { + "smithy.api#documentation": "

The Lambda function couldn't mount the configured file system due to a permission or configuration\n issue.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.lambda#EFSMountTimeoutException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String" + }, + "Message": { + "target": "com.amazonaws.lambda#String" + } + }, + "traits": { + "smithy.api#documentation": "

The Lambda function made a network connection to the configured file system, but the mount\n operation timed out.

", + "smithy.api#error": "client", + "smithy.api#httpError": 408 + } + }, + "com.amazonaws.lambda#ENILimitReachedException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String" + }, + "Message": { + "target": "com.amazonaws.lambda#String" + } + }, + "traits": { + "smithy.api#documentation": "

Lambda couldn't create an elastic network interface in the VPC, specified as part of Lambda function configuration, because the limit for network interfaces has been reached. For more\n information, see Lambda\n quotas.

", + "smithy.api#error": "server", + "smithy.api#httpError": 502 + } + }, + "com.amazonaws.lambda#Enabled": { + "type": "boolean" + }, + "com.amazonaws.lambda#EndPointType": { + "type": "enum", + "members": { + "KAFKA_BOOTSTRAP_SERVERS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KAFKA_BOOTSTRAP_SERVERS" + } + } + } + }, + "com.amazonaws.lambda#Endpoint": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + }, + "smithy.api#pattern": "^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]):[0-9]{1,5}$" + } + }, + "com.amazonaws.lambda#EndpointLists": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#Endpoint" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.lambda#Endpoints": { + "type": "map", + "key": { + "target": "com.amazonaws.lambda#EndPointType" + }, + "value": { + "target": "com.amazonaws.lambda#EndpointLists" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.lambda#Environment": { + "type": "structure", + "members": { + "Variables": { + "target": "com.amazonaws.lambda#EnvironmentVariables", + "traits": { + "smithy.api#documentation": "

Environment variable key-value pairs. For more information, see Using Lambda environment variables.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A function's environment variable settings. You can use environment variables to adjust your function's\n behavior without updating code. An environment variable is a pair of strings that are stored in a function's\n version-specific configuration.

" + } + }, + "com.amazonaws.lambda#EnvironmentError": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

The error code.

" + } + }, + "Message": { + "target": "com.amazonaws.lambda#SensitiveString", + "traits": { + "smithy.api#documentation": "

The error message.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Error messages for environment variables that couldn't be applied.

" + } + }, + "com.amazonaws.lambda#EnvironmentResponse": { + "type": "structure", + "members": { + "Variables": { + "target": "com.amazonaws.lambda#EnvironmentVariables", + "traits": { + "smithy.api#documentation": "

Environment variable key-value pairs. Omitted from CloudTrail logs.

" + } + }, + "Error": { + "target": "com.amazonaws.lambda#EnvironmentError", + "traits": { + "smithy.api#documentation": "

Error messages for environment variables that couldn't be applied.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The results of an operation to update or read environment variables. If the operation succeeds, the response\n contains the environment variables. If it fails, the response contains details about the error.

" + } + }, + "com.amazonaws.lambda#EnvironmentVariableName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z]([a-zA-Z0-9_])+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.lambda#EnvironmentVariableValue": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.lambda#EnvironmentVariables": { + "type": "map", + "key": { + "target": "com.amazonaws.lambda#EnvironmentVariableName" + }, + "value": { + "target": "com.amazonaws.lambda#EnvironmentVariableValue" + }, + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.lambda#EphemeralStorage": { + "type": "structure", + "members": { + "Size": { + "target": "com.amazonaws.lambda#EphemeralStorageSize", + "traits": { + "smithy.api#documentation": "

The size of the function's /tmp directory.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The size of the function's /tmp directory in MB. The default value is 512, but can be any whole\n number between 512 and 10,240 MB. For more information, see Configuring ephemeral storage (console).

" + } + }, + "com.amazonaws.lambda#EphemeralStorageSize": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 512, + "max": 10240 + } + } + }, + "com.amazonaws.lambda#EventSourceMappingArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 85, + "max": 120 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:\\d{12}:event-source-mapping:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" + } + }, + "com.amazonaws.lambda#EventSourceMappingConfiguration": { + "type": "structure", + "members": { + "UUID": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

The identifier of the event source mapping.

" + } + }, + "StartingPosition": { + "target": "com.amazonaws.lambda#EventSourcePosition", + "traits": { + "smithy.api#documentation": "

The position in a stream from which to start reading. Required for Amazon Kinesis and\n Amazon DynamoDB Stream event sources. AT_TIMESTAMP is supported only for\n Amazon Kinesis streams, Amazon DocumentDB, Amazon MSK, and self-managed Apache Kafka.

" + } + }, + "StartingPositionTimestamp": { + "target": "com.amazonaws.lambda#Date", + "traits": { + "smithy.api#documentation": "

With StartingPosition set to AT_TIMESTAMP, the time from which to start\n reading. StartingPositionTimestamp cannot be in the future.

" + } + }, + "BatchSize": { + "target": "com.amazonaws.lambda#BatchSize", + "traits": { + "smithy.api#documentation": "

The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).

\n

Default value: Varies by service. For Amazon SQS, the default is 10. For all other services, the default is 100.

\n

Related setting: When you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

" + } + }, + "MaximumBatchingWindowInSeconds": { + "target": "com.amazonaws.lambda#MaximumBatchingWindowInSeconds", + "traits": { + "smithy.api#documentation": "

The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.\n You can configure MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of seconds.

\n

For streams and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, the default\n batching window is 500 ms. Note that because you can only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it.\n To restore the default batching window, you must create a new event source mapping.

\n

Related setting: For streams and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

" + } + }, + "ParallelizationFactor": { + "target": "com.amazonaws.lambda#ParallelizationFactor", + "traits": { + "smithy.api#documentation": "

(Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1.

" + } + }, + "EventSourceArn": { + "target": "com.amazonaws.lambda#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the event source.

" + } + }, + "FilterCriteria": { + "target": "com.amazonaws.lambda#FilterCriteria", + "traits": { + "smithy.api#documentation": "

An object that defines the filter criteria that\n determine whether Lambda should process an event. For more information, see Lambda event filtering.

\n

If filter criteria is encrypted, this field shows up as null in the response\n of ListEventSourceMapping API calls. You can view this field in plaintext in the response of\n GetEventSourceMapping and DeleteEventSourceMapping calls if you have\n kms:Decrypt permissions for the correct KMS key.

" + } + }, + "FunctionArn": { + "target": "com.amazonaws.lambda#FunctionArn", + "traits": { + "smithy.api#documentation": "

The ARN of the Lambda function.

" + } + }, + "LastModified": { + "target": "com.amazonaws.lambda#Date", + "traits": { + "smithy.api#documentation": "

The date that the event source mapping was last updated or that its state changed.

" + } + }, + "LastProcessingResult": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

The result of the last Lambda invocation of your function.

" + } + }, + "State": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

The state of the event source mapping. It can be one of the following: Creating,\n Enabling, Enabled, Disabling, Disabled,\n Updating, or Deleting.

" + } + }, + "StateTransitionReason": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

Indicates whether a user or Lambda made the last change to the event source mapping.

" + } + }, + "DestinationConfig": { + "target": "com.amazonaws.lambda#DestinationConfig", + "traits": { + "smithy.api#documentation": "

(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka event sources only) A configuration object that specifies the destination of an event after Lambda processes it.

" + } + }, + "Topics": { + "target": "com.amazonaws.lambda#Topics", + "traits": { + "smithy.api#documentation": "

The name of the Kafka topic.

" + } + }, + "Queues": { + "target": "com.amazonaws.lambda#Queues", + "traits": { + "smithy.api#documentation": "

(Amazon MQ) The name of the Amazon MQ broker destination queue to consume.

" + } + }, + "SourceAccessConfigurations": { + "target": "com.amazonaws.lambda#SourceAccessConfigurations", + "traits": { + "smithy.api#documentation": "

An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.

" + } + }, + "SelfManagedEventSource": { + "target": "com.amazonaws.lambda#SelfManagedEventSource", + "traits": { + "smithy.api#documentation": "

The self-managed Apache Kafka cluster for your event source.

" + } + }, + "MaximumRecordAgeInSeconds": { + "target": "com.amazonaws.lambda#MaximumRecordAgeInSeconds", + "traits": { + "smithy.api#documentation": "

(Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is -1,\nwhich sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.

\n \n

The minimum valid value for maximum record age is 60s. Although values less than 60 and greater than -1 fall within the parameter's absolute range, they are not allowed

\n " + } + }, + "BisectBatchOnFunctionError": { + "target": "com.amazonaws.lambda#BisectBatchOnFunctionError", + "traits": { + "smithy.api#documentation": "

(Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false.

" + } + }, + "MaximumRetryAttempts": { + "target": "com.amazonaws.lambda#MaximumRetryAttemptsEventSourceMapping", + "traits": { + "smithy.api#documentation": "

(Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is -1,\nwhich sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source.

" + } + }, + "TumblingWindowInSeconds": { + "target": "com.amazonaws.lambda#TumblingWindowInSeconds", + "traits": { + "smithy.api#documentation": "

(Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window.

" + } + }, + "FunctionResponseTypes": { + "target": "com.amazonaws.lambda#FunctionResponseTypeList", + "traits": { + "smithy.api#documentation": "

(Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.

" + } + }, + "AmazonManagedKafkaEventSourceConfig": { + "target": "com.amazonaws.lambda#AmazonManagedKafkaEventSourceConfig", + "traits": { + "smithy.api#documentation": "

Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.

" + } + }, + "SelfManagedKafkaEventSourceConfig": { + "target": "com.amazonaws.lambda#SelfManagedKafkaEventSourceConfig", + "traits": { + "smithy.api#documentation": "

Specific configuration settings for a self-managed Apache Kafka event source.

" + } + }, + "ScalingConfig": { + "target": "com.amazonaws.lambda#ScalingConfig", + "traits": { + "smithy.api#documentation": "

(Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.

" + } + }, + "DocumentDBEventSourceConfig": { + "target": "com.amazonaws.lambda#DocumentDBEventSourceConfig", + "traits": { + "smithy.api#documentation": "

Specific configuration settings for a DocumentDB event source.

" + } + }, + "KMSKeyArn": { + "target": "com.amazonaws.lambda#KMSKeyArn", + "traits": { + "smithy.api#documentation": "

\n The ARN of the Key Management Service (KMS) customer managed key that Lambda\n uses to encrypt your function's filter criteria.

" + } + }, + "FilterCriteriaError": { + "target": "com.amazonaws.lambda#FilterCriteriaError", + "traits": { + "smithy.api#documentation": "

An object that contains details about an error related to filter criteria encryption.

" + } + }, + "EventSourceMappingArn": { + "target": "com.amazonaws.lambda#EventSourceMappingArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the event source mapping.

" + } + }, + "MetricsConfig": { + "target": "com.amazonaws.lambda#EventSourceMappingMetricsConfig", + "traits": { + "smithy.api#documentation": "

The metrics configuration for your event source. For more information, see Event source mapping metrics.

" + } + }, + "ProvisionedPollerConfig": { + "target": "com.amazonaws.lambda#ProvisionedPollerConfig", + "traits": { + "smithy.api#documentation": "

(Amazon MSK and self-managed Apache Kafka only) The Provisioned Mode configuration for the event source.\n For more information, see Provisioned Mode.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A mapping between an Amazon Web Services resource and a Lambda function. For details, see CreateEventSourceMapping.

" + } + }, + "com.amazonaws.lambda#EventSourceMappingMetric": { + "type": "enum", + "members": { + "EventCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EventCount" + } + } + } + }, + "com.amazonaws.lambda#EventSourceMappingMetricList": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#EventSourceMappingMetric" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.lambda#EventSourceMappingMetricsConfig": { + "type": "structure", + "members": { + "Metrics": { + "target": "com.amazonaws.lambda#EventSourceMappingMetricList", + "traits": { + "smithy.api#documentation": "

\n The metrics you want your event source mapping to produce. Include EventCount to receive event source mapping\n metrics related to the number of events processed by your event source mapping. For more information about these metrics,\n see \n Event source mapping metrics.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The metrics configuration for your event source. Use this configuration object to define which metrics you want your\n event source mapping to produce.

" + } + }, + "com.amazonaws.lambda#EventSourceMappingsList": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#EventSourceMappingConfiguration" + } + }, + "com.amazonaws.lambda#EventSourcePosition": { + "type": "enum", + "members": { + "TRIM_HORIZON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRIM_HORIZON" + } + }, + "LATEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LATEST" + } + }, + "AT_TIMESTAMP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AT_TIMESTAMP" + } + } + } + }, + "com.amazonaws.lambda#EventSourceToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._\\-]+$" + } + }, + "com.amazonaws.lambda#FileSystemArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + }, + "smithy.api#pattern": "^arn:aws[a-zA-Z-]*:elasticfilesystem:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:access-point/fsap-[a-f0-9]{17}$" + } + }, + "com.amazonaws.lambda#FileSystemConfig": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.lambda#FileSystemArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file\n system.

", + "smithy.api#required": {} + } + }, + "LocalMountPath": { + "target": "com.amazonaws.lambda#LocalMountPath", + "traits": { + "smithy.api#documentation": "

The path where the function can access the file system, starting with /mnt/.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the connection between a Lambda function and an Amazon EFS file system.

" + } + }, + "com.amazonaws.lambda#FileSystemConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#FileSystemConfig" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.lambda#Filter": { + "type": "structure", + "members": { + "Pattern": { + "target": "com.amazonaws.lambda#Pattern", + "traits": { + "smithy.api#documentation": "

\n A filter pattern. For more information on the syntax of a filter pattern, see\n \n Filter rule syntax.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n A structure within a FilterCriteria object that defines an event filtering pattern.\n

" + } + }, + "com.amazonaws.lambda#FilterCriteria": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.lambda#FilterList", + "traits": { + "smithy.api#documentation": "

\n A list of filters.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n An object that contains the filters for an event source.\n

" + } + }, + "com.amazonaws.lambda#FilterCriteriaError": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.lambda#FilterCriteriaErrorCode", + "traits": { + "smithy.api#documentation": "

The KMS exception that resulted from filter criteria encryption or decryption.

" + } + }, + "Message": { + "target": "com.amazonaws.lambda#FilterCriteriaErrorMessage", + "traits": { + "smithy.api#documentation": "

The error message.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that contains details about an error related to filter criteria encryption.

" + } + }, + "com.amazonaws.lambda#FilterCriteriaErrorCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 50 + }, + "smithy.api#pattern": "^[A-Za-z]+Exception$" + } + }, + "com.amazonaws.lambda#FilterCriteriaErrorMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 2048 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.lambda#FilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#Filter" + } + }, + "com.amazonaws.lambda#FullDocument": { + "type": "enum", + "members": { + "UpdateLookup": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateLookup" + } + }, + "Default": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Default" + } + } + } + }, + "com.amazonaws.lambda#FunctionArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?$" + } + }, + "com.amazonaws.lambda#FunctionArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#FunctionArn" + } + }, + "com.amazonaws.lambda#FunctionCode": { + "type": "structure", + "members": { + "ZipFile": { + "target": "com.amazonaws.lambda#Blob", + "traits": { + "smithy.api#documentation": "

The base64-encoded contents of the deployment package. Amazon Web Services SDK and CLI clients handle the encoding for\n you.

" + } + }, + "S3Bucket": { + "target": "com.amazonaws.lambda#S3Bucket", + "traits": { + "smithy.api#documentation": "

An Amazon S3 bucket in the same Amazon Web Services Region as your function. The bucket can be in a different Amazon Web Services account.

" + } + }, + "S3Key": { + "target": "com.amazonaws.lambda#S3Key", + "traits": { + "smithy.api#documentation": "

The Amazon S3 key of the deployment package.

" + } + }, + "S3ObjectVersion": { + "target": "com.amazonaws.lambda#S3ObjectVersion", + "traits": { + "smithy.api#documentation": "

For versioned objects, the version of the deployment package object to use.

" + } + }, + "ImageUri": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

URI of a container image in the\n Amazon ECR registry.

" + } + }, + "SourceKMSKeyArn": { + "target": "com.amazonaws.lambda#KMSKeyArn", + "traits": { + "smithy.api#documentation": "

The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt your function's \n.zip deployment package. If you don't provide a customer managed key, Lambda uses an Amazon Web Services owned key.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The code for the Lambda function. You can either specify an object in Amazon S3, upload a\n .zip file archive deployment package directly, or specify the URI of a container image.

" + } + }, + "com.amazonaws.lambda#FunctionCodeLocation": { + "type": "structure", + "members": { + "RepositoryType": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

The service that's hosting the file.

" + } + }, + "Location": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

A presigned URL that you can use to download the deployment package.

" + } + }, + "ImageUri": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

URI of a container image in the Amazon ECR registry.

" + } + }, + "ResolvedImageUri": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

The resolved URI for the image.

" + } + }, + "SourceKMSKeyArn": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt your function's \n.zip deployment package. If you don't provide a customer managed key, Lambda uses an Amazon Web Services owned key.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about a function's deployment package.

" + } + }, + "com.amazonaws.lambda#FunctionConfiguration": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#NamespacedFunctionName", + "traits": { + "smithy.api#documentation": "

The name of the function.

" + } + }, + "FunctionArn": { + "target": "com.amazonaws.lambda#NameSpacedFunctionArn", + "traits": { + "smithy.api#documentation": "

The function's Amazon Resource Name (ARN).

" + } + }, + "Runtime": { + "target": "com.amazonaws.lambda#Runtime", + "traits": { + "smithy.api#documentation": "

The identifier of the function's \n runtime. Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in\n an error if you're deploying a function using a container image.

\n

The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing\n functions shortly after each runtime is deprecated. For more information, see\n Runtime use after deprecation.

\n

For a list of all currently supported runtimes, see\n Supported runtimes.

" + } + }, + "Role": { + "target": "com.amazonaws.lambda#RoleArn", + "traits": { + "smithy.api#documentation": "

The function's execution role.

" + } + }, + "Handler": { + "target": "com.amazonaws.lambda#Handler", + "traits": { + "smithy.api#documentation": "

The function that Lambda calls to begin running your function.

" + } + }, + "CodeSize": { + "target": "com.amazonaws.lambda#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The size of the function's deployment package, in bytes.

" + } + }, + "Description": { + "target": "com.amazonaws.lambda#Description", + "traits": { + "smithy.api#documentation": "

The function's description.

" + } + }, + "Timeout": { + "target": "com.amazonaws.lambda#Timeout", + "traits": { + "smithy.api#documentation": "

The amount of time in seconds that Lambda allows a function to run before stopping it.

" + } + }, + "MemorySize": { + "target": "com.amazonaws.lambda#MemorySize", + "traits": { + "smithy.api#documentation": "

The amount of memory available to the function at runtime.

" + } + }, + "LastModified": { + "target": "com.amazonaws.lambda#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

" + } + }, + "CodeSha256": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

The SHA256 hash of the function's deployment package.

" + } + }, + "Version": { + "target": "com.amazonaws.lambda#Version", + "traits": { + "smithy.api#documentation": "

The version of the Lambda function.

" + } + }, + "VpcConfig": { + "target": "com.amazonaws.lambda#VpcConfigResponse", + "traits": { + "smithy.api#documentation": "

The function's networking configuration.

" + } + }, + "DeadLetterConfig": { + "target": "com.amazonaws.lambda#DeadLetterConfig", + "traits": { + "smithy.api#documentation": "

The function's dead letter queue.

" + } + }, + "Environment": { + "target": "com.amazonaws.lambda#EnvironmentResponse", + "traits": { + "smithy.api#documentation": "

The function's environment variables. Omitted from CloudTrail logs.

" + } + }, + "KMSKeyArn": { + "target": "com.amazonaws.lambda#KMSKeyArn", + "traits": { + "smithy.api#documentation": "

The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt the following resources:

\n
    \n
  • \n

    The function's environment variables.

    \n
    • \n
  • \n

    The function's Lambda SnapStart snapshots.

    \n
    • \n
  • \n

    When used with SourceKMSKeyArn, the unzipped version of the .zip deployment package that's used for function invocations. For more information, see \n Specifying a customer managed key for Lambda.

    \n
    • \n
  • \n

    The optimized version of the container image that's used for function invocations. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). For more information, see Function lifecycle.

    \n
    • \n
\n

If you don't provide a customer managed key, Lambda uses an Amazon Web Services owned key or an Amazon Web Services managed key.

" + } + }, + "TracingConfig": { + "target": "com.amazonaws.lambda#TracingConfigResponse", + "traits": { + "smithy.api#documentation": "

The function's X-Ray tracing configuration.

" + } + }, + "MasterArn": { + "target": "com.amazonaws.lambda#FunctionArn", + "traits": { + "smithy.api#documentation": "

For Lambda@Edge functions, the ARN of the main function.

" + } + }, + "RevisionId": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

The latest updated revision of the function or alias.

" + } + }, + "Layers": { + "target": "com.amazonaws.lambda#LayersReferenceList", + "traits": { + "smithy.api#documentation": "

The function's layers.

" + } + }, + "State": { + "target": "com.amazonaws.lambda#State", + "traits": { + "smithy.api#documentation": "

The current state of the function. When the state is Inactive, you can reactivate the function by\n invoking it.

" + } + }, + "StateReason": { + "target": "com.amazonaws.lambda#StateReason", + "traits": { + "smithy.api#documentation": "

The reason for the function's current state.

" + } + }, + "StateReasonCode": { + "target": "com.amazonaws.lambda#StateReasonCode", + "traits": { + "smithy.api#documentation": "

The reason code for the function's current state. When the code is Creating, you can't invoke or\n modify the function.

" + } + }, + "LastUpdateStatus": { + "target": "com.amazonaws.lambda#LastUpdateStatus", + "traits": { + "smithy.api#documentation": "

The status of the last update that was performed on the function. This is first set to Successful\n after function creation completes.

" + } + }, + "LastUpdateStatusReason": { + "target": "com.amazonaws.lambda#LastUpdateStatusReason", + "traits": { + "smithy.api#documentation": "

The reason for the last update that was performed on the function.

" + } + }, + "LastUpdateStatusReasonCode": { + "target": "com.amazonaws.lambda#LastUpdateStatusReasonCode", + "traits": { + "smithy.api#documentation": "

The reason code for the last update that was performed on the function.

" + } + }, + "FileSystemConfigs": { + "target": "com.amazonaws.lambda#FileSystemConfigList", + "traits": { + "smithy.api#documentation": "

Connection settings for an Amazon EFS file system.

" + } + }, + "PackageType": { + "target": "com.amazonaws.lambda#PackageType", + "traits": { + "smithy.api#documentation": "

The type of deployment package. Set to Image for container image and set Zip for .zip file archive.

" + } + }, + "ImageConfigResponse": { + "target": "com.amazonaws.lambda#ImageConfigResponse", + "traits": { + "smithy.api#documentation": "

The function's image configuration values.

" + } + }, + "SigningProfileVersionArn": { + "target": "com.amazonaws.lambda#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the signing profile version.

" + } + }, + "SigningJobArn": { + "target": "com.amazonaws.lambda#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the signing job.

" + } + }, + "Architectures": { + "target": "com.amazonaws.lambda#ArchitecturesList", + "traits": { + "smithy.api#documentation": "

The instruction set architecture that the function supports. Architecture is a string array with one of the \n valid values. The default architecture value is x86_64.

" + } + }, + "EphemeralStorage": { + "target": "com.amazonaws.lambda#EphemeralStorage", + "traits": { + "smithy.api#documentation": "

The size of the function's /tmp directory in MB. The default value is 512, but can be any whole\n number between 512 and 10,240 MB. For more information, see Configuring ephemeral storage (console).

" + } + }, + "SnapStart": { + "target": "com.amazonaws.lambda#SnapStartResponse", + "traits": { + "smithy.api#documentation": "

Set ApplyOn to PublishedVersions to create a snapshot of the initialized execution\n environment when you publish a function version. For more information, see Improving startup performance with Lambda SnapStart.

" + } + }, + "RuntimeVersionConfig": { + "target": "com.amazonaws.lambda#RuntimeVersionConfig", + "traits": { + "smithy.api#documentation": "

The ARN of the runtime and any errors that occured.

" + } + }, + "LoggingConfig": { + "target": "com.amazonaws.lambda#LoggingConfig", + "traits": { + "smithy.api#documentation": "

The function's Amazon CloudWatch Logs configuration settings.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about a function's configuration.

" + } + }, + "com.amazonaws.lambda#FunctionEventInvokeConfig": { + "type": "structure", + "members": { + "LastModified": { + "target": "com.amazonaws.lambda#Date", + "traits": { + "smithy.api#documentation": "

The date and time that the configuration was last updated.

" + } + }, + "FunctionArn": { + "target": "com.amazonaws.lambda#FunctionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the function.

" + } + }, + "MaximumRetryAttempts": { + "target": "com.amazonaws.lambda#MaximumRetryAttempts", + "traits": { + "smithy.api#documentation": "

The maximum number of times to retry when the function returns an error.

" + } + }, + "MaximumEventAgeInSeconds": { + "target": "com.amazonaws.lambda#MaximumEventAgeInSeconds", + "traits": { + "smithy.api#documentation": "

The maximum age of a request that Lambda sends to a function for processing.

" + } + }, + "DestinationConfig": { + "target": "com.amazonaws.lambda#DestinationConfig", + "traits": { + "smithy.api#documentation": "

A destination for events after they have been sent to a function for processing.

\n

\n Destinations\n

\n
    \n
  • \n

    \n Function - The Amazon Resource Name (ARN) of a Lambda function.

    \n
    • \n
  • \n

    \n Queue - The ARN of a standard SQS queue.

    \n
    • \n
  • \n

    \n Bucket - The ARN of an Amazon S3 bucket.

    \n
    • \n
  • \n

    \n Topic - The ARN of a standard SNS topic.

    \n
    • \n
  • \n

    \n Event Bus - The ARN of an Amazon EventBridge event bus.

    \n
    • \n
\n \n

S3 buckets are supported only for on-failure destinations. To retain records of successful invocations, use another destination type.

\n " + } + } + } + }, + "com.amazonaws.lambda#FunctionEventInvokeConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#FunctionEventInvokeConfig" + } + }, + "com.amazonaws.lambda#FunctionList": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#FunctionConfiguration" + } + }, + "com.amazonaws.lambda#FunctionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 140 + }, + "smithy.api#pattern": "^(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\\$LATEST|[a-zA-Z0-9-_]+))?$" + } + }, + "com.amazonaws.lambda#FunctionResponseType": { + "type": "enum", + "members": { + "ReportBatchItemFailures": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ReportBatchItemFailures" + } + } + } + }, + "com.amazonaws.lambda#FunctionResponseTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#FunctionResponseType" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.lambda#FunctionUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 40, + "max": 100 + } + } + }, + "com.amazonaws.lambda#FunctionUrlAuthType": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "AWS_IAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_IAM" + } + } + } + }, + "com.amazonaws.lambda#FunctionUrlConfig": { + "type": "structure", + "members": { + "FunctionUrl": { + "target": "com.amazonaws.lambda#FunctionUrl", + "traits": { + "smithy.api#documentation": "

The HTTP URL endpoint for your function.

", + "smithy.api#required": {} + } + }, + "FunctionArn": { + "target": "com.amazonaws.lambda#FunctionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of your function.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.lambda#Timestamp", + "traits": { + "smithy.api#documentation": "

When the function URL was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.lambda#Timestamp", + "traits": { + "smithy.api#documentation": "

When the function URL configuration was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

", + "smithy.api#required": {} + } + }, + "Cors": { + "target": "com.amazonaws.lambda#Cors", + "traits": { + "smithy.api#documentation": "

The cross-origin resource sharing (CORS) settings\n for your function URL.

" + } + }, + "AuthType": { + "target": "com.amazonaws.lambda#FunctionUrlAuthType", + "traits": { + "smithy.api#documentation": "

The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated\n users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information,\n see Security and auth model for Lambda function URLs.

", + "smithy.api#required": {} + } + }, + "InvokeMode": { + "target": "com.amazonaws.lambda#InvokeMode", + "traits": { + "smithy.api#documentation": "

Use one of the following options:

\n
    \n
  • \n

    \n BUFFERED – This is the default option. Lambda invokes your function\n using the Invoke API operation. Invocation results are available when the\n payload is complete. The maximum payload size is 6 MB.

    \n
    • \n
  • \n

    \n RESPONSE_STREAM – Your function streams payload results as they become available.\n Lambda invokes your function using the InvokeWithResponseStream\n API operation. The maximum response payload size is 20 MB, however, you can request a quota increase.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about a Lambda function URL.

" + } + }, + "com.amazonaws.lambda#FunctionUrlConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#FunctionUrlConfig" + } + }, + "com.amazonaws.lambda#FunctionUrlQualifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(^\\$LATEST$)|((?!^[0-9]+$)([a-zA-Z0-9-_]+))$" + } + }, + "com.amazonaws.lambda#FunctionVersion": { + "type": "enum", + "members": { + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + } + } + }, + "com.amazonaws.lambda#GetAccountSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#GetAccountSettingsRequest" + }, + "output": { + "target": "com.amazonaws.lambda#GetAccountSettingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves details about your account's limits and usage in an Amazon Web Services Region.

", + "smithy.api#examples": [ + { + "title": "To get account settings", + "documentation": "This operation takes no parameters and returns details about storage and concurrency quotas in the current Region.", + "output": { + "AccountLimit": { + "CodeSizeUnzipped": 262144000, + "UnreservedConcurrentExecutions": 1000, + "ConcurrentExecutions": 1000, + "CodeSizeZipped": 52428800, + "TotalCodeSize": 80530636800 + }, + "AccountUsage": { + "FunctionCount": 4, + "TotalCodeSize": 9426 + } + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/2016-08-19/account-settings", + "code": 200 + } + } + }, + "com.amazonaws.lambda#GetAccountSettingsRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#GetAccountSettingsResponse": { + "type": "structure", + "members": { + "AccountLimit": { + "target": "com.amazonaws.lambda#AccountLimit", + "traits": { + "smithy.api#documentation": "

Limits that are related to concurrency and code storage.

" + } + }, + "AccountUsage": { + "target": "com.amazonaws.lambda#AccountUsage", + "traits": { + "smithy.api#documentation": "

The number of functions and amount of storage in use.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lambda#GetAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#GetAliasRequest" + }, + "output": { + "target": "com.amazonaws.lambda#AliasConfiguration" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns details about a Lambda function alias.

", + "smithy.api#examples": [ + { + "title": "To get a Lambda function alias", + "documentation": "The following example returns details about an alias named BLUE for a function named my-function", + "input": { + "FunctionName": "my-function", + "Name": "BLUE" + }, + "output": { + "AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:BLUE", + "Name": "BLUE", + "FunctionVersion": "3", + "RevisionId": "594f41fb-xmpl-4c20-95c7-6ca5f2a92c93", + "Description": "Production environment BLUE." + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/2015-03-31/functions/{FunctionName}/aliases/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.lambda#GetAliasRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name - MyFunction.

    \n
    • \n
  • \n

    \n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

    \n
    • \n
  • \n

    \n Partial ARN - 123456789012:function:MyFunction.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.lambda#Alias", + "traits": { + "smithy.api#documentation": "

The name of the alias.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#GetCodeSigningConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#GetCodeSigningConfigRequest" + }, + "output": { + "target": "com.amazonaws.lambda#GetCodeSigningConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about the specified code signing configuration.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2020-04-22/code-signing-configs/{CodeSigningConfigArn}", + "code": 200 + } + } + }, + "com.amazonaws.lambda#GetCodeSigningConfigRequest": { + "type": "structure", + "members": { + "CodeSigningConfigArn": { + "target": "com.amazonaws.lambda#CodeSigningConfigArn", + "traits": { + "smithy.api#documentation": "

The The Amazon Resource Name (ARN) of the code signing configuration.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#GetCodeSigningConfigResponse": { + "type": "structure", + "members": { + "CodeSigningConfig": { + "target": "com.amazonaws.lambda#CodeSigningConfig", + "traits": { + "smithy.api#documentation": "

The code signing configuration

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lambda#GetEventSourceMapping": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#GetEventSourceMappingRequest" + }, + "output": { + "target": "com.amazonaws.lambda#EventSourceMappingConfiguration" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns details about an event source mapping. You can get the identifier of a mapping from the output of\n ListEventSourceMappings.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2015-03-31/event-source-mappings/{UUID}", + "code": 200 + } + } + }, + "com.amazonaws.lambda#GetEventSourceMappingRequest": { + "type": "structure", + "members": { + "UUID": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

The identifier of the event source mapping.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#GetFunction": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#GetFunctionRequest" + }, + "output": { + "target": "com.amazonaws.lambda#GetFunctionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about the function or function version, with a link to download the deployment package\n that's valid for 10 minutes. If you specify a function version, only details that are specific to that version are\n returned.

", + "smithy.api#examples": [ + { + "title": "To get a Lambda function", + "documentation": "The following example returns code and configuration details for version 1 of a function named my-function.", + "input": { + "FunctionName": "my-function", + "Qualifier": "1" + }, + "output": { + "Configuration": { + "FunctionName": "my-function", + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "Runtime": "nodejs12.x", + "Role": "arn:aws:iam::123456789012:role/lambda-role", + "Handler": "index.handler", + "CodeSize": 5797206, + "Description": "Process image objects from Amazon S3.", + "Timeout": 15, + "MemorySize": 256, + "LastModified": "2020-04-10T19:06:32.563+0000", + "CodeSha256": "YFgDgEKG3ugvF1+pX64gV6tu9qNuIYNUdgJm8nCxsm4=", + "Version": "$LATEST", + "Environment": { + "Variables": { + "PREFIX": "inbound", + "BUCKET": "my-bucket-1xpuxmplzrlbh" + } + }, + "KMSKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966", + "TracingConfig": { + "Mode": "Active" + }, + "RevisionId": "b75dcd81-xmpl-48a8-a75a-93ba8b5b9727", + "State": "Active", + "LastUpdateStatus": "Successful" + }, + "Code": { + "RepositoryType": "S3", + "Location": "https://awslambda-us-west-2-tasks.s3.us-west-2.amazonaws.com/snapshots/123456789012/my-function-e7d9d1ed-xmpl-4f79-904a-4b87f2681f30?versionId=sH3TQwBOaUy..." + }, + "Tags": { + "DEPARTMENT": "Assets" + } + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/2015-03-31/functions/{FunctionName}", + "code": 200 + }, + "smithy.waiters#waitable": { + "FunctionActiveV2": { + "documentation": "Waits for the function's State to be Active. This waiter uses GetFunction API. This should be used after new function creation.", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "Configuration.State", + "expected": "Active", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Configuration.State", + "expected": "Failed", + "comparator": "stringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "output": { + "path": "Configuration.State", + "expected": "Pending", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 1 + }, + "FunctionExists": { + "acceptors": [ + { + "state": "success", + "matcher": { + "success": true + } + }, + { + "state": "retry", + "matcher": { + "errorType": "ResourceNotFoundException" + } + } + ], + "minDelay": 1 + }, + "FunctionUpdatedV2": { + "documentation": "Waits for the function's LastUpdateStatus to be Successful. This waiter uses GetFunction API. This should be used after function updates.", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "Configuration.LastUpdateStatus", + "expected": "Successful", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Configuration.LastUpdateStatus", + "expected": "Failed", + "comparator": "stringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "output": { + "path": "Configuration.LastUpdateStatus", + "expected": "InProgress", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 1 + } + } + } + }, + "com.amazonaws.lambda#GetFunctionCodeSigningConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#GetFunctionCodeSigningConfigRequest" + }, + "output": { + "target": "com.amazonaws.lambda#GetFunctionCodeSigningConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the code signing configuration for the specified function.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2020-06-30/functions/{FunctionName}/code-signing-config", + "code": 200 + } + } + }, + "com.amazonaws.lambda#GetFunctionCodeSigningConfigRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name - MyFunction.

    \n
    • \n
  • \n

    \n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

    \n
    • \n
  • \n

    \n Partial ARN - 123456789012:function:MyFunction.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#GetFunctionCodeSigningConfigResponse": { + "type": "structure", + "members": { + "CodeSigningConfigArn": { + "target": "com.amazonaws.lambda#CodeSigningConfigArn", + "traits": { + "smithy.api#documentation": "

The The Amazon Resource Name (ARN) of the code signing configuration.

", + "smithy.api#required": {} + } + }, + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name - MyFunction.

    \n
    • \n
  • \n

    \n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

    \n
    • \n
  • \n

    \n Partial ARN - 123456789012:function:MyFunction.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lambda#GetFunctionConcurrency": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#GetFunctionConcurrencyRequest" + }, + "output": { + "target": "com.amazonaws.lambda#GetFunctionConcurrencyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns details about the reserved concurrency configuration for a function. To set a concurrency limit for a\n function, use PutFunctionConcurrency.

", + "smithy.api#examples": [ + { + "title": "To get the reserved concurrency setting for a function", + "documentation": "The following example returns the reserved concurrency setting for a function named my-function.", + "input": { + "FunctionName": "my-function" + }, + "output": { + "ReservedConcurrentExecutions": 250 + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/2019-09-30/functions/{FunctionName}/concurrency", + "code": 200 + } + } + }, + "com.amazonaws.lambda#GetFunctionConcurrencyRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function.

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#GetFunctionConcurrencyResponse": { + "type": "structure", + "members": { + "ReservedConcurrentExecutions": { + "target": "com.amazonaws.lambda#ReservedConcurrentExecutions", + "traits": { + "smithy.api#documentation": "

The number of simultaneous executions that are reserved for the function.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lambda#GetFunctionConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#GetFunctionConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.lambda#FunctionConfiguration" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the version-specific settings of a Lambda function or version. The output includes only options that\n can vary between versions of a function. To modify these settings, use UpdateFunctionConfiguration.

\n

To get all of a function's details, including function-level settings, use GetFunction.

", + "smithy.api#examples": [ + { + "title": "To get a Lambda function's event source mapping", + "documentation": "The following example returns and configuration details for version 1 of a function named my-function.", + "input": { + "FunctionName": "my-function", + "Qualifier": "1" + }, + "output": { + "FunctionName": "my-function", + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "Runtime": "nodejs12.x", + "Role": "arn:aws:iam::123456789012:role/lambda-role", + "Handler": "index.handler", + "CodeSize": 5797206, + "Description": "Process image objects from Amazon S3.", + "Timeout": 15, + "MemorySize": 256, + "LastModified": "2020-04-10T19:06:32.563+0000", + "CodeSha256": "YFgDgEKG3ugvF1+pX64gV6tu9qNuIYNUdgJm8nCxsm4=", + "Version": "$LATEST", + "Environment": { + "Variables": { + "PREFIX": "inbound", + "BUCKET": "my-bucket-1xpuxmplzrlbh" + } + }, + "KMSKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966", + "TracingConfig": { + "Mode": "Active" + }, + "RevisionId": "b75dcd81-xmpl-48a8-a75a-93ba8b5b9727", + "State": "Active", + "LastUpdateStatus": "Successful" + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/2015-03-31/functions/{FunctionName}/configuration", + "code": 200 + }, + "smithy.waiters#waitable": { + "FunctionActive": { + "documentation": "Waits for the function's State to be Active. This waiter uses GetFunctionConfiguration API. This should be used after new function creation.", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "State", + "expected": "Active", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "State", + "expected": "Failed", + "comparator": "stringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "output": { + "path": "State", + "expected": "Pending", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 5 + }, + "FunctionUpdated": { + "documentation": "Waits for the function's LastUpdateStatus to be Successful. This waiter uses GetFunctionConfiguration API. This should be used after function updates.", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "LastUpdateStatus", + "expected": "Successful", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "LastUpdateStatus", + "expected": "Failed", + "comparator": "stringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "output": { + "path": "LastUpdateStatus", + "expected": "InProgress", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 5 + }, + "PublishedVersionActive": { + "documentation": "Waits for the published version's State to be Active. This waiter uses GetFunctionConfiguration API. This should be used after new version is published.", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "State", + "expected": "Active", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "State", + "expected": "Failed", + "comparator": "stringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "output": { + "path": "State", + "expected": "Pending", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 5 + } + } + } + }, + "com.amazonaws.lambda#GetFunctionConfigurationRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#NamespacedFunctionName", + "traits": { + "smithy.api#documentation": "

The name or ARN of the Lambda function, version, or alias.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function (name-only), my-function:v1 (with alias).

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\n If you specify only the function name, it is limited to 64 characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#Qualifier", + "traits": { + "smithy.api#documentation": "

Specify a version or alias to get details about a published version of the function.

", + "smithy.api#httpQuery": "Qualifier" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#GetFunctionEventInvokeConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#GetFunctionEventInvokeConfigRequest" + }, + "output": { + "target": "com.amazonaws.lambda#FunctionEventInvokeConfig" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the configuration for asynchronous invocation for a function, version, or alias.

\n

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2019-09-25/functions/{FunctionName}/event-invoke-config", + "code": 200 + } + } + }, + "com.amazonaws.lambda#GetFunctionEventInvokeConfigRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "

The name or ARN of the Lambda function, version, or alias.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name - my-function (name-only), my-function:v1 (with alias).

    \n
    • \n
  • \n

    \n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN - 123456789012:function:my-function.

    \n
    • \n
\n

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\n If you specify only the function name, it is limited to 64 characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#Qualifier", + "traits": { + "smithy.api#documentation": "

A version number or alias name.

", + "smithy.api#httpQuery": "Qualifier" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#GetFunctionRecursionConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#GetFunctionRecursionConfigRequest" + }, + "output": { + "target": "com.amazonaws.lambda#GetFunctionRecursionConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns your function's recursive loop detection configuration. \n

", + "smithy.api#http": { + "method": "GET", + "uri": "/2024-08-31/functions/{FunctionName}/recursion-config", + "code": 200 + } + } + }, + "com.amazonaws.lambda#GetFunctionRecursionConfigRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#UnqualifiedFunctionName", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#GetFunctionRecursionConfigResponse": { + "type": "structure", + "members": { + "RecursiveLoop": { + "target": "com.amazonaws.lambda#RecursiveLoop", + "traits": { + "smithy.api#documentation": "

If your function's recursive loop detection configuration is Allow, Lambda doesn't take any action when it \n detects your function being invoked as part of a recursive loop.

\n

If your function's recursive loop detection configuration is Terminate, Lambda stops your function being \n invoked and notifies you when it detects your function being invoked as part of a recursive loop.

\n

By default, Lambda sets your function's configuration to Terminate. You can update this \n configuration using the PutFunctionRecursionConfig action.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lambda#GetFunctionRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#NamespacedFunctionName", + "traits": { + "smithy.api#documentation": "

The name or ARN of the Lambda function, version, or alias.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function (name-only), my-function:v1 (with alias).

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\n If you specify only the function name, it is limited to 64 characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#Qualifier", + "traits": { + "smithy.api#documentation": "

Specify a version or alias to get details about a published version of the function.

", + "smithy.api#httpQuery": "Qualifier" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#GetFunctionResponse": { + "type": "structure", + "members": { + "Configuration": { + "target": "com.amazonaws.lambda#FunctionConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of the function or version.

" + } + }, + "Code": { + "target": "com.amazonaws.lambda#FunctionCodeLocation", + "traits": { + "smithy.api#documentation": "

The deployment package of the function or version.

" + } + }, + "Tags": { + "target": "com.amazonaws.lambda#Tags", + "traits": { + "smithy.api#documentation": "

The function's tags. Lambda\n returns tag data only if you have explicit allow permissions for lambda:ListTags.

" + } + }, + "TagsError": { + "target": "com.amazonaws.lambda#TagsError", + "traits": { + "smithy.api#documentation": "

An object that contains details about an error related to retrieving tags.

" + } + }, + "Concurrency": { + "target": "com.amazonaws.lambda#Concurrency", + "traits": { + "smithy.api#documentation": "

The function's reserved\n concurrency.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lambda#GetFunctionUrlConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#GetFunctionUrlConfigRequest" + }, + "output": { + "target": "com.amazonaws.lambda#GetFunctionUrlConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns details about a Lambda function URL.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2021-10-31/functions/{FunctionName}/url", + "code": 200 + } + } + }, + "com.amazonaws.lambda#GetFunctionUrlConfigRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function.

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#FunctionUrlQualifier", + "traits": { + "smithy.api#documentation": "

The alias name.

", + "smithy.api#httpQuery": "Qualifier" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#GetFunctionUrlConfigResponse": { + "type": "structure", + "members": { + "FunctionUrl": { + "target": "com.amazonaws.lambda#FunctionUrl", + "traits": { + "smithy.api#documentation": "

The HTTP URL endpoint for your function.

", + "smithy.api#required": {} + } + }, + "FunctionArn": { + "target": "com.amazonaws.lambda#FunctionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of your function.

", + "smithy.api#required": {} + } + }, + "AuthType": { + "target": "com.amazonaws.lambda#FunctionUrlAuthType", + "traits": { + "smithy.api#documentation": "

The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated\n users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information,\n see Security and auth model for Lambda function URLs.

", + "smithy.api#required": {} + } + }, + "Cors": { + "target": "com.amazonaws.lambda#Cors", + "traits": { + "smithy.api#documentation": "

The cross-origin resource sharing (CORS) settings\n for your function URL.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.lambda#Timestamp", + "traits": { + "smithy.api#documentation": "

When the function URL was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.lambda#Timestamp", + "traits": { + "smithy.api#documentation": "

When the function URL configuration was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

", + "smithy.api#required": {} + } + }, + "InvokeMode": { + "target": "com.amazonaws.lambda#InvokeMode", + "traits": { + "smithy.api#documentation": "

Use one of the following options:

\n
    \n
  • \n

    \n BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results \n are available when the payload is complete. The maximum payload size is 6 MB.

    \n
    • \n
  • \n

    \n RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using \n the InvokeWithResponseStream API operation. The maximum response payload size is 20 MB, however, you can request a quota increase.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lambda#GetLayerVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#GetLayerVersionRequest" + }, + "output": { + "target": "com.amazonaws.lambda#GetLayerVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a version of an Lambda\n layer, with a link to download the layer archive\n that's valid for 10 minutes.

", + "smithy.api#examples": [ + { + "title": "To get information about a Lambda layer version", + "documentation": "The following example returns information for version 1 of a layer named my-layer.", + "input": { + "LayerName": "my-layer", + "VersionNumber": 1 + }, + "output": { + "Content": { + "Location": "https://awslambda-us-east-2-layers.s3.us-east-2.amazonaws.com/snapshots/123456789012/my-layer-4aaa2fbb-ff77-4b0a-ad92-5b78a716a96a?versionId=27iWyA73cCAYqyH...", + "CodeSha256": "tv9jJO+rPbXUUXuRKi7CwHzKtLDkDRJLB3cC3Z/ouXo=", + "CodeSize": 169 + }, + "LayerArn": "arn:aws:lambda:us-east-2:123456789012:layer:my-layer", + "LayerVersionArn": "arn:aws:lambda:us-east-2:123456789012:layer:my-layer:1", + "Description": "My Python layer", + "CreatedDate": "2018-11-14T23:03:52.894+0000", + "Version": 1, + "LicenseInfo": "MIT", + "CompatibleRuntimes": [ + "python3.6", + "python3.7" + ] + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/2018-10-31/layers/{LayerName}/versions/{VersionNumber}", + "code": 200 + } + } + }, + "com.amazonaws.lambda#GetLayerVersionByArn": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#GetLayerVersionByArnRequest" + }, + "output": { + "target": "com.amazonaws.lambda#GetLayerVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a version of an Lambda\n layer, with a link to download the layer archive\n that's valid for 10 minutes.

", + "smithy.api#examples": [ + { + "title": "To get information about a Lambda layer version", + "documentation": "The following example returns information about the layer version with the specified Amazon Resource Name (ARN).", + "input": { + "Arn": "arn:aws:lambda:ca-central-1:123456789012:layer:blank-python-lib:3" + }, + "output": { + "Content": { + "Location": "https://awslambda-us-east-2-layers.s3.us-east-2.amazonaws.com/snapshots/123456789012/blank-python-lib-e5212378-xmpl-44ee-8398-9d8ec5113949?versionId=WbZnvf...", + "CodeSha256": "6x+xmpl/M3BnQUk7gS9sGmfeFsR/npojXoA3fZUv4eU=", + "CodeSize": 9529009 + }, + "LayerArn": "arn:aws:lambda:us-east-2:123456789012:layer:blank-python-lib", + "LayerVersionArn": "arn:aws:lambda:us-east-2:123456789012:layer:blank-python-lib:3", + "Description": "Dependencies for the blank-python sample app.", + "CreatedDate": "2020-03-31T00:35:18.949+0000", + "Version": 3, + "CompatibleRuntimes": [ + "python3.8" + ] + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/2018-10-31/layers?find=LayerVersion", + "code": 200 + } + } + }, + "com.amazonaws.lambda#GetLayerVersionByArnRequest": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.lambda#LayerVersionArn", + "traits": { + "smithy.api#documentation": "

The ARN of the layer version.

", + "smithy.api#httpQuery": "Arn", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#GetLayerVersionPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#GetLayerVersionPolicyRequest" + }, + "output": { + "target": "com.amazonaws.lambda#GetLayerVersionPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the permission policy for a version of an Lambda\n layer. For more information, see AddLayerVersionPermission.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2018-10-31/layers/{LayerName}/versions/{VersionNumber}/policy", + "code": 200 + } + } + }, + "com.amazonaws.lambda#GetLayerVersionPolicyRequest": { + "type": "structure", + "members": { + "LayerName": { + "target": "com.amazonaws.lambda#LayerName", + "traits": { + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the layer.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VersionNumber": { + "target": "com.amazonaws.lambda#LayerVersionNumber", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The version number.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#GetLayerVersionPolicyResponse": { + "type": "structure", + "members": { + "Policy": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

The policy document.

" + } + }, + "RevisionId": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

A unique identifier for the current revision of the policy.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lambda#GetLayerVersionRequest": { + "type": "structure", + "members": { + "LayerName": { + "target": "com.amazonaws.lambda#LayerName", + "traits": { + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the layer.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VersionNumber": { + "target": "com.amazonaws.lambda#LayerVersionNumber", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The version number.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#GetLayerVersionResponse": { + "type": "structure", + "members": { + "Content": { + "target": "com.amazonaws.lambda#LayerVersionContentOutput", + "traits": { + "smithy.api#documentation": "

Details about the layer version.

" + } + }, + "LayerArn": { + "target": "com.amazonaws.lambda#LayerArn", + "traits": { + "smithy.api#documentation": "

The ARN of the layer.

" + } + }, + "LayerVersionArn": { + "target": "com.amazonaws.lambda#LayerVersionArn", + "traits": { + "smithy.api#documentation": "

The ARN of the layer version.

" + } + }, + "Description": { + "target": "com.amazonaws.lambda#Description", + "traits": { + "smithy.api#documentation": "

The description of the version.

" + } + }, + "CreatedDate": { + "target": "com.amazonaws.lambda#Timestamp", + "traits": { + "smithy.api#documentation": "

The date that the layer version was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

" + } + }, + "Version": { + "target": "com.amazonaws.lambda#LayerVersionNumber", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The version number.

" + } + }, + "CompatibleRuntimes": { + "target": "com.amazonaws.lambda#CompatibleRuntimes", + "traits": { + "smithy.api#documentation": "

The layer's compatible runtimes.

\n

The following list includes deprecated runtimes. For more information, see\n Runtime use after deprecation.

\n

For a list of all currently supported runtimes, see\n Supported runtimes.

" + } + }, + "LicenseInfo": { + "target": "com.amazonaws.lambda#LicenseInfo", + "traits": { + "smithy.api#documentation": "

The layer's software license.

" + } + }, + "CompatibleArchitectures": { + "target": "com.amazonaws.lambda#CompatibleArchitectures", + "traits": { + "smithy.api#documentation": "

A list of compatible \ninstruction set architectures.

" + } + } + } + }, + "com.amazonaws.lambda#GetPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#GetPolicyRequest" + }, + "output": { + "target": "com.amazonaws.lambda#GetPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the resource-based IAM policy for a function, version, or alias.

", + "smithy.api#examples": [ + { + "title": "To retrieve a Lambda function policy", + "documentation": "The following example returns the resource-based policy for version 1 of a Lambda function named my-function.", + "input": { + "FunctionName": "my-function", + "Qualifier": "1" + }, + "output": { + "Policy": "{\"Version\":\"2012-10-17\",\"Id\":\"default\",\"Statement\":[{\"Sid\":\"xaccount\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789012:root\"},\"Action\":\"lambda:InvokeFunction\",\"Resource\":\"arn:aws:lambda:us-east-2:123456789012:function:my-function:1\"}]}", + "RevisionId": "4843f2f6-7c59-4fda-b484-afd0bc0e22b8" + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/2015-03-31/functions/{FunctionName}/policy", + "code": 200 + } + } + }, + "com.amazonaws.lambda#GetPolicyRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#NamespacedFunctionName", + "traits": { + "smithy.api#documentation": "

The name or ARN of the Lambda function, version, or alias.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function (name-only), my-function:v1 (with alias).

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\n If you specify only the function name, it is limited to 64 characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#Qualifier", + "traits": { + "smithy.api#documentation": "

Specify a version or alias to get the policy for that resource.

", + "smithy.api#httpQuery": "Qualifier" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#GetPolicyResponse": { + "type": "structure", + "members": { + "Policy": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

The resource-based policy.

" + } + }, + "RevisionId": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

A unique identifier for the current revision of the policy.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lambda#GetProvisionedConcurrencyConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#GetProvisionedConcurrencyConfigRequest" + }, + "output": { + "target": "com.amazonaws.lambda#GetProvisionedConcurrencyConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ProvisionedConcurrencyConfigNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the provisioned concurrency configuration for a function's alias or version.

", + "smithy.api#examples": [ + { + "title": "To get a provisioned concurrency configuration", + "documentation": "The following example returns details for the provisioned concurrency configuration for the BLUE alias of the specified function.", + "input": { + "FunctionName": "my-function", + "Qualifier": "BLUE" + }, + "output": { + "RequestedProvisionedConcurrentExecutions": 100, + "AvailableProvisionedConcurrentExecutions": 100, + "AllocatedProvisionedConcurrentExecutions": 100, + "Status": "READY", + "LastModified": "2019-12-31T20:28:49+0000" + } + }, + { + "title": "To view a provisioned concurrency configuration", + "documentation": "The following example displays details for the provisioned concurrency configuration for the BLUE alias of the specified function.", + "input": { + "FunctionName": "my-function", + "Qualifier": "BLUE" + }, + "output": { + "RequestedProvisionedConcurrentExecutions": 100, + "AvailableProvisionedConcurrentExecutions": 100, + "AllocatedProvisionedConcurrentExecutions": 100, + "Status": "READY", + "LastModified": "2019-12-31T20:28:49+0000" + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/2019-09-30/functions/{FunctionName}/provisioned-concurrency", + "code": 200 + } + } + }, + "com.amazonaws.lambda#GetProvisionedConcurrencyConfigRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function.

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#Qualifier", + "traits": { + "smithy.api#documentation": "

The version number or alias name.

", + "smithy.api#httpQuery": "Qualifier", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#GetProvisionedConcurrencyConfigResponse": { + "type": "structure", + "members": { + "RequestedProvisionedConcurrentExecutions": { + "target": "com.amazonaws.lambda#PositiveInteger", + "traits": { + "smithy.api#documentation": "

The amount of provisioned concurrency requested.

" + } + }, + "AvailableProvisionedConcurrentExecutions": { + "target": "com.amazonaws.lambda#NonNegativeInteger", + "traits": { + "smithy.api#documentation": "

The amount of provisioned concurrency available.

" + } + }, + "AllocatedProvisionedConcurrentExecutions": { + "target": "com.amazonaws.lambda#NonNegativeInteger", + "traits": { + "smithy.api#documentation": "

The amount of provisioned concurrency allocated. When a weighted alias is used during linear and canary deployments, this value fluctuates depending on the amount of concurrency that is provisioned for the function versions.

" + } + }, + "Status": { + "target": "com.amazonaws.lambda#ProvisionedConcurrencyStatusEnum", + "traits": { + "smithy.api#documentation": "

The status of the allocation process.

" + } + }, + "StatusReason": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

For failed allocations, the reason that provisioned concurrency could not be allocated.

" + } + }, + "LastModified": { + "target": "com.amazonaws.lambda#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that a user last updated the configuration, in ISO 8601 format.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lambda#GetRuntimeManagementConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#GetRuntimeManagementConfigRequest" + }, + "output": { + "target": "com.amazonaws.lambda#GetRuntimeManagementConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the runtime management configuration for a function's version. If the runtime update mode is Manual, this includes the ARN of the \n runtime version and the runtime update mode. If the runtime update mode is Auto or Function update, \n this includes the runtime update mode and null is returned for the ARN. For more information, see Runtime updates.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2021-07-20/functions/{FunctionName}/runtime-management-config", + "code": 200 + } + } + }, + "com.amazonaws.lambda#GetRuntimeManagementConfigRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#NamespacedFunctionName", + "traits": { + "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function.

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#Qualifier", + "traits": { + "smithy.api#documentation": "

Specify a version of the function. This can be $LATEST or a published version number. If no value is specified, the configuration for the \n $LATEST version is returned.

", + "smithy.api#httpQuery": "Qualifier" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#GetRuntimeManagementConfigResponse": { + "type": "structure", + "members": { + "UpdateRuntimeOn": { + "target": "com.amazonaws.lambda#UpdateRuntimeOn", + "traits": { + "smithy.api#documentation": "

The current runtime update mode of the function.

" + } + }, + "RuntimeVersionArn": { + "target": "com.amazonaws.lambda#RuntimeVersionArn", + "traits": { + "smithy.api#documentation": "

The ARN of the runtime the function is configured to use. If the runtime update mode is Manual, the ARN is returned, otherwise null \n is returned.

" + } + }, + "FunctionArn": { + "target": "com.amazonaws.lambda#NameSpacedFunctionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of your function.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lambda#Handler": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + }, + "smithy.api#pattern": "^[^\\s]+$" + } + }, + "com.amazonaws.lambda#Header": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.lambda#HeadersList": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#Header" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.lambda#HttpStatus": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.lambda#ImageConfig": { + "type": "structure", + "members": { + "EntryPoint": { + "target": "com.amazonaws.lambda#StringList", + "traits": { + "smithy.api#documentation": "

Specifies the entry point to their application, which is typically the location of the runtime\n executable.

" + } + }, + "Command": { + "target": "com.amazonaws.lambda#StringList", + "traits": { + "smithy.api#documentation": "

Specifies parameters that you want to pass in with ENTRYPOINT.

" + } + }, + "WorkingDirectory": { + "target": "com.amazonaws.lambda#WorkingDirectory", + "traits": { + "smithy.api#documentation": "

Specifies the working directory.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration values that override the container image Dockerfile settings. For more information, see Container image\n settings.

" + } + }, + "com.amazonaws.lambda#ImageConfigError": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

Error code.

" + } + }, + "Message": { + "target": "com.amazonaws.lambda#SensitiveString", + "traits": { + "smithy.api#documentation": "

Error message.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Error response to GetFunctionConfiguration.

" + } + }, + "com.amazonaws.lambda#ImageConfigResponse": { + "type": "structure", + "members": { + "ImageConfig": { + "target": "com.amazonaws.lambda#ImageConfig", + "traits": { + "smithy.api#documentation": "

Configuration values that override the container image Dockerfile.

" + } + }, + "Error": { + "target": "com.amazonaws.lambda#ImageConfigError", + "traits": { + "smithy.api#documentation": "

Error response to GetFunctionConfiguration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Response to a GetFunctionConfiguration request.

" + } + }, + "com.amazonaws.lambda#Integer": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.lambda#InvalidCodeSignatureException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String" + }, + "Message": { + "target": "com.amazonaws.lambda#String" + } + }, + "traits": { + "smithy.api#documentation": "

The code signature failed the integrity check. If the integrity check fails, then Lambda blocks\n deployment, even if the code signing policy is set to WARN.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.lambda#InvalidParameterValueException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

The exception type.

" + } + }, + "message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

The exception message.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

One of the parameters in the request is not valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.lambda#InvalidRequestContentException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

The exception type.

" + } + }, + "message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

The exception message.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The request body could not be parsed as JSON.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.lambda#InvalidRuntimeException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String" + }, + "Message": { + "target": "com.amazonaws.lambda#String" + } + }, + "traits": { + "smithy.api#documentation": "

The runtime or runtime version specified is not supported.

", + "smithy.api#error": "server", + "smithy.api#httpError": 502 + } + }, + "com.amazonaws.lambda#InvalidSecurityGroupIDException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String" + }, + "Message": { + "target": "com.amazonaws.lambda#String" + } + }, + "traits": { + "smithy.api#documentation": "

The security group ID provided in the Lambda function VPC configuration is not valid.

", + "smithy.api#error": "server", + "smithy.api#httpError": 502 + } + }, + "com.amazonaws.lambda#InvalidSubnetIDException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String" + }, + "Message": { + "target": "com.amazonaws.lambda#String" + } + }, + "traits": { + "smithy.api#documentation": "

The subnet ID provided in the Lambda function VPC configuration is not valid.

", + "smithy.api#error": "server", + "smithy.api#httpError": 502 + } + }, + "com.amazonaws.lambda#InvalidZipFileException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String" + }, + "Message": { + "target": "com.amazonaws.lambda#String" + } + }, + "traits": { + "smithy.api#documentation": "

Lambda could not unzip the deployment package.

", + "smithy.api#error": "server", + "smithy.api#httpError": 502 + } + }, + "com.amazonaws.lambda#InvocationRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#NamespacedFunctionName", + "traits": { + "smithy.api#documentation": "

The name or ARN of the Lambda function, version, or alias.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function (name-only), my-function:v1 (with alias).

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\n If you specify only the function name, it is limited to 64 characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "InvocationType": { + "target": "com.amazonaws.lambda#InvocationType", + "traits": { + "smithy.api#documentation": "

Choose from the following options.

\n
    \n
  • \n

    \n RequestResponse (default) – Invoke the function synchronously. Keep the connection open until\n the function returns a response or times out. The API response includes the function response and additional\n data.

    \n
    • \n
  • \n

    \n Event – Invoke the function asynchronously. Send events that fail multiple times to the\n function's dead-letter queue (if one is configured). The API response only includes a status code.

    \n
    • \n
  • \n

    \n DryRun – Validate parameter values and verify that the user or role has permission to invoke\n the function.

    \n
    • \n
", + "smithy.api#httpHeader": "X-Amz-Invocation-Type" + } + }, + "LogType": { + "target": "com.amazonaws.lambda#LogType", + "traits": { + "smithy.api#documentation": "

Set to Tail to include the execution log in the response. Applies to synchronously invoked functions only.

", + "smithy.api#httpHeader": "X-Amz-Log-Type" + } + }, + "ClientContext": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context\n object. Lambda passes the ClientContext object to your function for\n synchronous invocations only.

", + "smithy.api#httpHeader": "X-Amz-Client-Context" + } + }, + "Payload": { + "target": "com.amazonaws.lambda#Blob", + "traits": { + "smithy.api#documentation": "

The JSON that you want to provide to your Lambda function as input.

\n

You can enter the JSON directly. For example, --payload '{ \"key\": \"value\" }'. You can also\n specify a file path. For example, --payload file://payload.json.

", + "smithy.api#httpPayload": {} + } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#Qualifier", + "traits": { + "smithy.api#documentation": "

Specify a version or alias to invoke a published version of the function.

", + "smithy.api#httpQuery": "Qualifier" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#InvocationResponse": { + "type": "structure", + "members": { + "StatusCode": { + "target": "com.amazonaws.lambda#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status code is in the 200 range for a successful request. For the RequestResponse\n invocation type, this status code is 200. For the Event invocation type, this status code is 202. For\n the DryRun invocation type, the status code is 204.

", + "smithy.api#httpResponseCode": {} + } + }, + "FunctionError": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

If present, indicates that an error occurred during function execution. Details about the error are included\n in the response payload.

", + "smithy.api#httpHeader": "X-Amz-Function-Error" + } + }, + "LogResult": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

The last 4 KB of the execution log, which is base64-encoded.

", + "smithy.api#httpHeader": "X-Amz-Log-Result" + } + }, + "Payload": { + "target": "com.amazonaws.lambda#Blob", + "traits": { + "smithy.api#documentation": "

The response from the function, or an error object.

", + "smithy.api#httpPayload": {} + } + }, + "ExecutedVersion": { + "target": "com.amazonaws.lambda#Version", + "traits": { + "smithy.api#documentation": "

The version of the function that executed. When you invoke a function with an alias, this indicates which\n version the alias resolved to.

", + "smithy.api#httpHeader": "X-Amz-Executed-Version" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lambda#InvocationType": { + "type": "enum", + "members": { + "Event": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Event" + } + }, + "RequestResponse": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RequestResponse" + } + }, + "DryRun": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DryRun" + } + } + } + }, + "com.amazonaws.lambda#Invoke": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#InvocationRequest" + }, + "output": { + "target": "com.amazonaws.lambda#InvocationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#EC2AccessDeniedException" + }, + { + "target": "com.amazonaws.lambda#EC2ThrottledException" + }, + { + "target": "com.amazonaws.lambda#EC2UnexpectedException" + }, + { + "target": "com.amazonaws.lambda#EFSIOException" + }, + { + "target": "com.amazonaws.lambda#EFSMountConnectivityException" + }, + { + "target": "com.amazonaws.lambda#EFSMountFailureException" + }, + { + "target": "com.amazonaws.lambda#EFSMountTimeoutException" + }, + { + "target": "com.amazonaws.lambda#ENILimitReachedException" + }, + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#InvalidRequestContentException" + }, + { + "target": "com.amazonaws.lambda#InvalidRuntimeException" + }, + { + "target": "com.amazonaws.lambda#InvalidSecurityGroupIDException" + }, + { + "target": "com.amazonaws.lambda#InvalidSubnetIDException" + }, + { + "target": "com.amazonaws.lambda#InvalidZipFileException" + }, + { + "target": "com.amazonaws.lambda#KMSAccessDeniedException" + }, + { + "target": "com.amazonaws.lambda#KMSDisabledException" + }, + { + "target": "com.amazonaws.lambda#KMSInvalidStateException" + }, + { + "target": "com.amazonaws.lambda#KMSNotFoundException" + }, + { + "target": "com.amazonaws.lambda#RecursiveInvocationException" + }, + { + "target": "com.amazonaws.lambda#RequestTooLargeException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotReadyException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#SnapStartException" + }, + { + "target": "com.amazonaws.lambda#SnapStartNotReadyException" + }, + { + "target": "com.amazonaws.lambda#SnapStartTimeoutException" + }, + { + "target": "com.amazonaws.lambda#SubnetIPAddressLimitReachedException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + }, + { + "target": "com.amazonaws.lambda#UnsupportedMediaTypeException" + } + ], + "traits": { + "smithy.api#documentation": "

Invokes a Lambda function. You can invoke a function synchronously (and wait for the response), or\n asynchronously. By default, Lambda invokes your function synchronously (i.e. theInvocationType\n is RequestResponse). To invoke a function asynchronously, set InvocationType to\n Event. Lambda passes the ClientContext object to your function for\n synchronous invocations only.

\n

For synchronous invocation,\n details about the function response, including errors, are included in the response body and headers. For either\n invocation type, you can find more information in the execution log and trace.

\n

When an error occurs, your function may be invoked multiple times. Retry behavior varies by error type,\n client, event source, and invocation type. For example, if you invoke a function asynchronously and it returns an\n error, Lambda executes the function up to two more times. For more information, see Error handling and automatic retries in\n Lambda.

\n

For asynchronous invocation,\n Lambda adds events to a queue before sending them to your function. If your function does not have enough capacity\n to keep up with the queue, events may be lost. Occasionally, your function may receive the same event multiple\n times, even if no error occurs. To retain events that were not processed, configure your function with a dead-letter queue.

\n

The status code in the API response doesn't reflect function errors. Error codes are reserved for errors that\n prevent your function from executing, such as permissions errors, quota errors, or issues with your function's code and\n configuration. For example, Lambda returns TooManyRequestsException if running the\n function would cause you to exceed a concurrency limit at either the account level\n (ConcurrentInvocationLimitExceeded) or function level\n (ReservedFunctionConcurrentInvocationLimitExceeded).

\n

For functions with a long timeout, your client might disconnect during synchronous invocation while it waits\n for a response. Configure your HTTP client, SDK, firewall, proxy, or operating system to allow for long\n connections with timeout or keep-alive settings.

\n

This operation requires permission for the lambda:InvokeFunction action. For details on how to set up\n permissions for cross-account invocations, see Granting function\n access to other accounts.

", + "smithy.api#examples": [ + { + "title": "To invoke a Lambda function", + "documentation": "The following example invokes version 1 of a function named my-function with an empty event payload.", + "input": { + "FunctionName": "my-function", + "Payload": "{}", + "Qualifier": "1" + }, + "output": { + "StatusCode": 200, + "Payload": "200 SUCCESS" + } + }, + { + "title": "To invoke a Lambda function asynchronously", + "documentation": "The following example invokes version 1 of a function named my-function asynchronously.", + "input": { + "FunctionName": "my-function", + "Payload": "{}", + "InvocationType": "Event", + "Qualifier": "1" + }, + "output": { + "StatusCode": 202, + "Payload": "" + } + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/2015-03-31/functions/{FunctionName}/invocations", + "code": 200 + } + } + }, + "com.amazonaws.lambda#InvokeAsync": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#InvokeAsyncRequest" + }, + "output": { + "target": "com.amazonaws.lambda#InvokeAsyncResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidRequestContentException" + }, + { + "target": "com.amazonaws.lambda#InvalidRuntimeException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + } + ], + "traits": { + "smithy.api#deprecated": {}, + "smithy.api#documentation": "\n

For asynchronous function invocation, use Invoke.

\n \n

Invokes a function asynchronously.

\n \n

If you do use the InvokeAsync action, note that it doesn't support the use of X-Ray active tracing. Trace ID is not \n propagated to the function, even if X-Ray active tracing is turned on.

\n ", + "smithy.api#examples": [ + { + "title": "To invoke a Lambda function asynchronously", + "documentation": "The following example invokes a Lambda function asynchronously", + "input": { + "FunctionName": "my-function", + "InvokeArgs": "{}" + }, + "output": { + "Status": 202 + } + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/2014-11-13/functions/{FunctionName}/invoke-async", + "code": 202 + } + } + }, + "com.amazonaws.lambda#InvokeAsyncRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#NamespacedFunctionName", + "traits": { + "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function.

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "InvokeArgs": { + "target": "com.amazonaws.lambda#BlobStream", + "traits": { + "smithy.api#documentation": "

The JSON that you want to provide to your Lambda function as input.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#deprecated": {}, + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#InvokeAsyncResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.lambda#HttpStatus", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The status code.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

A success response (202 Accepted) indicates that the request is queued for invocation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.lambda#InvokeMode": { + "type": "enum", + "members": { + "BUFFERED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BUFFERED" + } + }, + "RESPONSE_STREAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESPONSE_STREAM" + } + } + } + }, + "com.amazonaws.lambda#InvokeResponseStreamUpdate": { + "type": "structure", + "members": { + "Payload": { + "target": "com.amazonaws.lambda#Blob", + "traits": { + "smithy.api#documentation": "

Data returned by your Lambda function.

", + "smithy.api#eventPayload": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A chunk of the streamed response payload.

" + } + }, + "com.amazonaws.lambda#InvokeWithResponseStream": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#InvokeWithResponseStreamRequest" + }, + "output": { + "target": "com.amazonaws.lambda#InvokeWithResponseStreamResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#EC2AccessDeniedException" + }, + { + "target": "com.amazonaws.lambda#EC2ThrottledException" + }, + { + "target": "com.amazonaws.lambda#EC2UnexpectedException" + }, + { + "target": "com.amazonaws.lambda#EFSIOException" + }, + { + "target": "com.amazonaws.lambda#EFSMountConnectivityException" + }, + { + "target": "com.amazonaws.lambda#EFSMountFailureException" + }, + { + "target": "com.amazonaws.lambda#EFSMountTimeoutException" + }, + { + "target": "com.amazonaws.lambda#ENILimitReachedException" + }, + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#InvalidRequestContentException" + }, + { + "target": "com.amazonaws.lambda#InvalidRuntimeException" + }, + { + "target": "com.amazonaws.lambda#InvalidSecurityGroupIDException" + }, + { + "target": "com.amazonaws.lambda#InvalidSubnetIDException" + }, + { + "target": "com.amazonaws.lambda#InvalidZipFileException" + }, + { + "target": "com.amazonaws.lambda#KMSAccessDeniedException" + }, + { + "target": "com.amazonaws.lambda#KMSDisabledException" + }, + { + "target": "com.amazonaws.lambda#KMSInvalidStateException" + }, + { + "target": "com.amazonaws.lambda#KMSNotFoundException" + }, + { + "target": "com.amazonaws.lambda#RecursiveInvocationException" + }, + { + "target": "com.amazonaws.lambda#RequestTooLargeException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotReadyException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#SnapStartException" + }, + { + "target": "com.amazonaws.lambda#SnapStartNotReadyException" + }, + { + "target": "com.amazonaws.lambda#SnapStartTimeoutException" + }, + { + "target": "com.amazonaws.lambda#SubnetIPAddressLimitReachedException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + }, + { + "target": "com.amazonaws.lambda#UnsupportedMediaTypeException" + } + ], + "traits": { + "smithy.api#documentation": "

Configure your Lambda functions to stream response payloads back to clients. For more information, see Configuring a Lambda function to stream responses.

\n

This operation requires permission for the lambda:InvokeFunction action. For details on how to set up\n permissions for cross-account invocations, see Granting function\n access to other accounts.

", + "smithy.api#http": { + "method": "POST", + "uri": "/2021-11-15/functions/{FunctionName}/response-streaming-invocations", + "code": 200 + } + } + }, + "com.amazonaws.lambda#InvokeWithResponseStreamCompleteEvent": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

An error code.

" + } + }, + "ErrorDetails": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

The details of any returned error.

" + } + }, + "LogResult": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

The last 4 KB of the execution log, which is base64-encoded.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A response confirming that the event stream is complete.

" + } + }, + "com.amazonaws.lambda#InvokeWithResponseStreamRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#NamespacedFunctionName", + "traits": { + "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function.

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "InvocationType": { + "target": "com.amazonaws.lambda#ResponseStreamingInvocationType", + "traits": { + "smithy.api#documentation": "

Use one of the following options:

\n
    \n
  • \n

    \n RequestResponse (default) – Invoke the function synchronously. Keep the\n connection open until the function returns a response or times out. The API operation\n response includes the function response and additional data.

    \n
    • \n
  • \n

    \n DryRun – Validate parameter values and verify that the IAM user or role has permission to invoke\n the function.

    \n
    • \n
", + "smithy.api#httpHeader": "X-Amz-Invocation-Type" + } + }, + "LogType": { + "target": "com.amazonaws.lambda#LogType", + "traits": { + "smithy.api#documentation": "

Set to Tail to include the execution log in the response. Applies to synchronously invoked functions only.

", + "smithy.api#httpHeader": "X-Amz-Log-Type" + } + }, + "ClientContext": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context\n object.

", + "smithy.api#httpHeader": "X-Amz-Client-Context" + } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#Qualifier", + "traits": { + "smithy.api#documentation": "

The alias name.

", + "smithy.api#httpQuery": "Qualifier" + } + }, + "Payload": { + "target": "com.amazonaws.lambda#Blob", + "traits": { + "smithy.api#documentation": "

The JSON that you want to provide to your Lambda function as input.

\n

You can enter the JSON directly. For example, --payload '{ \"key\": \"value\" }'. You can also\n specify a file path. For example, --payload file://payload.json.

", + "smithy.api#httpPayload": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#InvokeWithResponseStreamResponse": { + "type": "structure", + "members": { + "StatusCode": { + "target": "com.amazonaws.lambda#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

For a successful request, the HTTP status code is in the 200 range. For the\n RequestResponse invocation type, this status code is 200. For the DryRun\n invocation type, this status code is 204.

", + "smithy.api#httpResponseCode": {} + } + }, + "ExecutedVersion": { + "target": "com.amazonaws.lambda#Version", + "traits": { + "smithy.api#documentation": "

The version of the function that executed. When you invoke a function with an alias, this\n indicates which version the alias resolved to.

", + "smithy.api#httpHeader": "X-Amz-Executed-Version" + } + }, + "EventStream": { + "target": "com.amazonaws.lambda#InvokeWithResponseStreamResponseEvent", + "traits": { + "smithy.api#documentation": "

The stream of response payloads.

", + "smithy.api#httpPayload": {} + } + }, + "ResponseStreamContentType": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

The type of data the stream is returning.

", + "smithy.api#httpHeader": "Content-Type" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lambda#InvokeWithResponseStreamResponseEvent": { + "type": "union", + "members": { + "PayloadChunk": { + "target": "com.amazonaws.lambda#InvokeResponseStreamUpdate", + "traits": { + "smithy.api#documentation": "

A chunk of the streamed response payload.

" + } + }, + "InvokeComplete": { + "target": "com.amazonaws.lambda#InvokeWithResponseStreamCompleteEvent", + "traits": { + "smithy.api#documentation": "

An object that's returned when the stream has ended and all the payload chunks have been\n returned.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that includes a chunk of the response payload. When the stream has ended, Lambda includes a InvokeComplete object.

", + "smithy.api#streaming": {} + } + }, + "com.amazonaws.lambda#KMSAccessDeniedException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String" + }, + "Message": { + "target": "com.amazonaws.lambda#String" + } + }, + "traits": { + "smithy.api#documentation": "

Lambda couldn't decrypt the environment variables because KMS access was denied.\n Check the Lambda function's KMS permissions.

", + "smithy.api#error": "server", + "smithy.api#httpError": 502 + } + }, + "com.amazonaws.lambda#KMSDisabledException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String" + }, + "Message": { + "target": "com.amazonaws.lambda#String" + } + }, + "traits": { + "smithy.api#documentation": "

Lambda couldn't decrypt the environment variables because the KMS key used is\n disabled. Check the Lambda function's KMS key settings.

", + "smithy.api#error": "server", + "smithy.api#httpError": 502 + } + }, + "com.amazonaws.lambda#KMSInvalidStateException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String" + }, + "Message": { + "target": "com.amazonaws.lambda#String" + } + }, + "traits": { + "smithy.api#documentation": "

Lambda couldn't decrypt the environment variables because the state of the KMS key used is not valid for Decrypt. Check the function's KMS key settings.

", + "smithy.api#error": "server", + "smithy.api#httpError": 502 + } + }, + "com.amazonaws.lambda#KMSKeyArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$" + } + }, + "com.amazonaws.lambda#KMSNotFoundException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String" + }, + "Message": { + "target": "com.amazonaws.lambda#String" + } + }, + "traits": { + "smithy.api#documentation": "

Lambda couldn't decrypt the environment variables because the KMS key was not\n found. Check the function's KMS key settings.

", + "smithy.api#error": "server", + "smithy.api#httpError": 502 + } + }, + "com.amazonaws.lambda#LastUpdateStatus": { + "type": "enum", + "members": { + "Successful": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Successful" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "InProgress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + } + } + }, + "com.amazonaws.lambda#LastUpdateStatusReason": { + "type": "string" + }, + "com.amazonaws.lambda#LastUpdateStatusReasonCode": { + "type": "enum", + "members": { + "EniLimitExceeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EniLimitExceeded" + } + }, + "InsufficientRolePermissions": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InsufficientRolePermissions" + } + }, + "InvalidConfiguration": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidConfiguration" + } + }, + "InternalError": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InternalError" + } + }, + "SubnetOutOfIPAddresses": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SubnetOutOfIPAddresses" + } + }, + "InvalidSubnet": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidSubnet" + } + }, + "InvalidSecurityGroup": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidSecurityGroup" + } + }, + "ImageDeleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ImageDeleted" + } + }, + "ImageAccessDenied": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ImageAccessDenied" + } + }, + "InvalidImage": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidImage" + } + }, + "KMSKeyAccessDenied": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KMSKeyAccessDenied" + } + }, + "KMSKeyNotFound": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KMSKeyNotFound" + } + }, + "InvalidStateKMSKey": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidStateKMSKey" + } + }, + "DisabledKMSKey": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DisabledKMSKey" + } + }, + "EFSIOError": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EFSIOError" + } + }, + "EFSMountConnectivityError": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EFSMountConnectivityError" + } + }, + "EFSMountFailure": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EFSMountFailure" + } + }, + "EFSMountTimeout": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EFSMountTimeout" + } + }, + "InvalidRuntime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidRuntime" + } + }, + "InvalidZipFileException": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidZipFileException" + } + }, + "FunctionError": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FunctionError" + } + } + } + }, + "com.amazonaws.lambda#Layer": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.lambda#LayerVersionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the function layer.

" + } + }, + "CodeSize": { + "target": "com.amazonaws.lambda#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The size of the layer archive in bytes.

" + } + }, + "SigningProfileVersionArn": { + "target": "com.amazonaws.lambda#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for a signing profile version.

" + } + }, + "SigningJobArn": { + "target": "com.amazonaws.lambda#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a signing job.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An Lambda\n layer.

" + } + }, + "com.amazonaws.lambda#LayerArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 140 + }, + "smithy.api#pattern": "^arn:[a-zA-Z0-9-]+:lambda:[a-zA-Z0-9-]+:\\d{12}:layer:[a-zA-Z0-9-_]+$" + } + }, + "com.amazonaws.lambda#LayerList": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#LayerVersionArn" + } + }, + "com.amazonaws.lambda#LayerName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 140 + }, + "smithy.api#pattern": "^(arn:[a-zA-Z0-9-]+:lambda:[a-zA-Z0-9-]+:\\d{12}:layer:[a-zA-Z0-9-_]+)|[a-zA-Z0-9-_]+$" + } + }, + "com.amazonaws.lambda#LayerPermissionAllowedAction": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 22 + }, + "smithy.api#pattern": "^lambda:GetLayerVersion$" + } + }, + "com.amazonaws.lambda#LayerPermissionAllowedPrincipal": { + "type": "string", + "traits": { + "smithy.api#pattern": "^\\d{12}|\\*|arn:(aws[a-zA-Z-]*):iam::\\d{12}:root$" + } + }, + "com.amazonaws.lambda#LayerVersionArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 140 + }, + "smithy.api#pattern": "^arn:[a-zA-Z0-9-]+:lambda:[a-zA-Z0-9-]+:\\d{12}:layer:[a-zA-Z0-9-_]+:[0-9]+$" + } + }, + "com.amazonaws.lambda#LayerVersionContentInput": { + "type": "structure", + "members": { + "S3Bucket": { + "target": "com.amazonaws.lambda#S3Bucket", + "traits": { + "smithy.api#documentation": "

The Amazon S3 bucket of the layer archive.

" + } + }, + "S3Key": { + "target": "com.amazonaws.lambda#S3Key", + "traits": { + "smithy.api#documentation": "

The Amazon S3 key of the layer archive.

" + } + }, + "S3ObjectVersion": { + "target": "com.amazonaws.lambda#S3ObjectVersion", + "traits": { + "smithy.api#documentation": "

For versioned objects, the version of the layer archive object to use.

" + } + }, + "ZipFile": { + "target": "com.amazonaws.lambda#Blob", + "traits": { + "smithy.api#documentation": "

The base64-encoded contents of the layer archive. Amazon Web Services SDK and Amazon Web Services CLI clients handle the encoding for\n you.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A ZIP archive that contains the contents of an Lambda\n layer. You can specify either an Amazon S3 location,\n or upload a layer archive directly.

" + } + }, + "com.amazonaws.lambda#LayerVersionContentOutput": { + "type": "structure", + "members": { + "Location": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

A link to the layer archive in Amazon S3 that is valid for 10 minutes.

" + } + }, + "CodeSha256": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

The SHA-256 hash of the layer archive.

" + } + }, + "CodeSize": { + "target": "com.amazonaws.lambda#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The size of the layer archive in bytes.

" + } + }, + "SigningProfileVersionArn": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for a signing profile version.

" + } + }, + "SigningJobArn": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a signing job.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about a version of an Lambda\n layer.

" + } + }, + "com.amazonaws.lambda#LayerVersionNumber": { + "type": "long", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.lambda#LayerVersionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#LayerVersionsListItem" + } + }, + "com.amazonaws.lambda#LayerVersionsListItem": { + "type": "structure", + "members": { + "LayerVersionArn": { + "target": "com.amazonaws.lambda#LayerVersionArn", + "traits": { + "smithy.api#documentation": "

The ARN of the layer version.

" + } + }, + "Version": { + "target": "com.amazonaws.lambda#LayerVersionNumber", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The version number.

" + } + }, + "Description": { + "target": "com.amazonaws.lambda#Description", + "traits": { + "smithy.api#documentation": "

The description of the version.

" + } + }, + "CreatedDate": { + "target": "com.amazonaws.lambda#Timestamp", + "traits": { + "smithy.api#documentation": "

The date that the version was created, in ISO 8601 format. For example, 2018-11-27T15:10:45.123+0000.

" + } + }, + "CompatibleRuntimes": { + "target": "com.amazonaws.lambda#CompatibleRuntimes", + "traits": { + "smithy.api#documentation": "

The layer's compatible runtimes.

\n

The following list includes deprecated runtimes. For more information, see\n Runtime use after deprecation.

\n

For a list of all currently supported runtimes, see\n Supported runtimes.

" + } + }, + "LicenseInfo": { + "target": "com.amazonaws.lambda#LicenseInfo", + "traits": { + "smithy.api#documentation": "

The layer's open-source license.

" + } + }, + "CompatibleArchitectures": { + "target": "com.amazonaws.lambda#CompatibleArchitectures", + "traits": { + "smithy.api#documentation": "

A list of compatible \n instruction set architectures.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about a version of an Lambda\n layer.

" + } + }, + "com.amazonaws.lambda#LayersList": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#LayersListItem" + } + }, + "com.amazonaws.lambda#LayersListItem": { + "type": "structure", + "members": { + "LayerName": { + "target": "com.amazonaws.lambda#LayerName", + "traits": { + "smithy.api#documentation": "

The name of the layer.

" + } + }, + "LayerArn": { + "target": "com.amazonaws.lambda#LayerArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the function layer.

" + } + }, + "LatestMatchingVersion": { + "target": "com.amazonaws.lambda#LayerVersionsListItem", + "traits": { + "smithy.api#documentation": "

The newest version of the layer.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about an Lambda\n layer.

" + } + }, + "com.amazonaws.lambda#LayersReferenceList": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#Layer" + } + }, + "com.amazonaws.lambda#LicenseInfo": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + } + } + }, + "com.amazonaws.lambda#ListAliases": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#ListAliasesRequest" + }, + "output": { + "target": "com.amazonaws.lambda#ListAliasesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of aliases\n for a Lambda function.

", + "smithy.api#examples": [ + { + "title": "To list a function's aliases", + "documentation": "The following example returns a list of aliases for a function named my-function.", + "input": { + "FunctionName": "my-function" + }, + "output": { + "Aliases": [ + { + "AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:BETA", + "RevisionId": "a410117f-xmpl-494e-8035-7e204bb7933b", + "FunctionVersion": "2", + "Name": "BLUE", + "Description": "Production environment BLUE.", + "RoutingConfig": { + "AdditionalVersionWeights": { + "1": 0.7 + } + } + }, + { + "AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:LIVE", + "RevisionId": "21d40116-xmpl-40ba-9360-3ea284da1bb5", + "FunctionVersion": "1", + "Name": "GREEN", + "Description": "Production environment GREEN." + } + ] + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/2015-03-31/functions/{FunctionName}/aliases", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "NextMarker", + "items": "Aliases", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.lambda#ListAliasesRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name - MyFunction.

    \n
    • \n
  • \n

    \n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

    \n
    • \n
  • \n

    \n Partial ARN - 123456789012:function:MyFunction.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "FunctionVersion": { + "target": "com.amazonaws.lambda#Version", + "traits": { + "smithy.api#documentation": "

Specify a function version to only list aliases that invoke that version.

", + "smithy.api#httpQuery": "FunctionVersion" + } + }, + "Marker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

", + "smithy.api#httpQuery": "Marker" + } + }, + "MaxItems": { + "target": "com.amazonaws.lambda#MaxListItems", + "traits": { + "smithy.api#documentation": "

Limit the number of aliases returned.

", + "smithy.api#httpQuery": "MaxItems" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#ListAliasesResponse": { + "type": "structure", + "members": { + "NextMarker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

The pagination token that's included if more results are available.

" + } + }, + "Aliases": { + "target": "com.amazonaws.lambda#AliasList", + "traits": { + "smithy.api#documentation": "

A list of aliases.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lambda#ListCodeSigningConfigs": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#ListCodeSigningConfigsRequest" + }, + "output": { + "target": "com.amazonaws.lambda#ListCodeSigningConfigsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of code\n signing configurations. A request returns up to 10,000 configurations per\n call. You can use the MaxItems parameter to return fewer configurations per call.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2020-04-22/code-signing-configs", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "NextMarker", + "items": "CodeSigningConfigs", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.lambda#ListCodeSigningConfigsRequest": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

", + "smithy.api#httpQuery": "Marker" + } + }, + "MaxItems": { + "target": "com.amazonaws.lambda#MaxListItems", + "traits": { + "smithy.api#documentation": "

Maximum number of items to return.

", + "smithy.api#httpQuery": "MaxItems" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#ListCodeSigningConfigsResponse": { + "type": "structure", + "members": { + "NextMarker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

The pagination token that's included if more results are available.

" + } + }, + "CodeSigningConfigs": { + "target": "com.amazonaws.lambda#CodeSigningConfigList", + "traits": { + "smithy.api#documentation": "

The code signing configurations

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lambda#ListEventSourceMappings": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#ListEventSourceMappingsRequest" + }, + "output": { + "target": "com.amazonaws.lambda#ListEventSourceMappingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists event source mappings. Specify an EventSourceArn to show only event source mappings for a\n single event source.

", + "smithy.api#examples": [ + { + "title": "To list the event source mappings for a function", + "documentation": "The following example returns a list of the event source mappings for a function named my-function.", + "input": { + "FunctionName": "my-function" + }, + "output": { + "EventSourceMappings": [ + { + "UUID": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "StateTransitionReason": "USER_INITIATED", + "LastModified": 1.569284520333E9, + "BatchSize": 5, + "State": "Enabled", + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "EventSourceArn": "arn:aws:sqs:us-west-2:123456789012:mySQSqueue" + } + ] + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/2015-03-31/event-source-mappings", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "NextMarker", + "items": "EventSourceMappings", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.lambda#ListEventSourceMappingsRequest": { + "type": "structure", + "members": { + "EventSourceArn": { + "target": "com.amazonaws.lambda#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the event source.

\n
    \n
  • \n

    \n Amazon Kinesis – The ARN of the data stream or a stream consumer.

    \n
    • \n
  • \n

    \n Amazon DynamoDB Streams – The ARN of the stream.

    \n
    • \n
  • \n

    \n Amazon Simple Queue Service – The ARN of the queue.

    \n
    • \n
  • \n

    \n Amazon Managed Streaming for Apache Kafka – The ARN of the cluster or the ARN of the VPC connection (for cross-account event source mappings).

    \n
    • \n
  • \n

    \n Amazon MQ – The ARN of the broker.

    \n
    • \n
  • \n

    \n Amazon DocumentDB – The ARN of the DocumentDB change stream.

    \n
    • \n
", + "smithy.api#httpQuery": "EventSourceArn" + } + }, + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – MyFunction.

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

    \n
    • \n
  • \n

    \n Version or Alias ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:MyFunction.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64\n characters in length.

", + "smithy.api#httpQuery": "FunctionName" + } + }, + "Marker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

A pagination token returned by a previous call.

", + "smithy.api#httpQuery": "Marker" + } + }, + "MaxItems": { + "target": "com.amazonaws.lambda#MaxListItems", + "traits": { + "smithy.api#documentation": "

The maximum number of event source mappings to return. Note that ListEventSourceMappings returns a maximum of\n 100 items in each response, even if you set the number higher.

", + "smithy.api#httpQuery": "MaxItems" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#ListEventSourceMappingsResponse": { + "type": "structure", + "members": { + "NextMarker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

A pagination token that's returned when the response doesn't contain all event source mappings.

" + } + }, + "EventSourceMappings": { + "target": "com.amazonaws.lambda#EventSourceMappingsList", + "traits": { + "smithy.api#documentation": "

A list of event source mappings.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lambda#ListFunctionEventInvokeConfigs": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#ListFunctionEventInvokeConfigsRequest" + }, + "output": { + "target": "com.amazonaws.lambda#ListFunctionEventInvokeConfigsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a list of configurations for asynchronous invocation for a function.

\n

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

", + "smithy.api#examples": [ + { + "title": "To view a list of asynchronous invocation configurations", + "documentation": "The following example returns a list of asynchronous invocation configurations for a function named my-function.", + "input": { + "FunctionName": "my-function" + }, + "output": { + "FunctionEventInvokeConfigs": [ + { + "LastModified": 1.577824406719E9, + "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:GREEN", + "MaximumRetryAttempts": 2, + "MaximumEventAgeInSeconds": 1800 + }, + { + "LastModified": 1.577824396653E9, + "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:BLUE", + "MaximumRetryAttempts": 0, + "MaximumEventAgeInSeconds": 3600 + } + ] + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/2019-09-25/functions/{FunctionName}/event-invoke-config/list", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "NextMarker", + "items": "FunctionEventInvokeConfigs", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.lambda#ListFunctionEventInvokeConfigsRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name - my-function.

    \n
    • \n
  • \n

    \n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN - 123456789012:function:my-function.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Marker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

", + "smithy.api#httpQuery": "Marker" + } + }, + "MaxItems": { + "target": "com.amazonaws.lambda#MaxFunctionEventInvokeConfigListItems", + "traits": { + "smithy.api#documentation": "

The maximum number of configurations to return.

", + "smithy.api#httpQuery": "MaxItems" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#ListFunctionEventInvokeConfigsResponse": { + "type": "structure", + "members": { + "FunctionEventInvokeConfigs": { + "target": "com.amazonaws.lambda#FunctionEventInvokeConfigList", + "traits": { + "smithy.api#documentation": "

A list of configurations.

" + } + }, + "NextMarker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

The pagination token that's included if more results are available.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lambda#ListFunctionUrlConfigs": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#ListFunctionUrlConfigsRequest" + }, + "output": { + "target": "com.amazonaws.lambda#ListFunctionUrlConfigsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of Lambda function URLs for the specified function.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2021-10-31/functions/{FunctionName}/urls", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "NextMarker", + "items": "FunctionUrlConfigs", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.lambda#ListFunctionUrlConfigsRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function.

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Marker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

", + "smithy.api#httpQuery": "Marker" + } + }, + "MaxItems": { + "target": "com.amazonaws.lambda#MaxItems", + "traits": { + "smithy.api#documentation": "

The maximum number of function URLs to return in the response. Note that ListFunctionUrlConfigs\n returns a maximum of 50 items in each response, even if you set the number higher.

", + "smithy.api#httpQuery": "MaxItems" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#ListFunctionUrlConfigsResponse": { + "type": "structure", + "members": { + "FunctionUrlConfigs": { + "target": "com.amazonaws.lambda#FunctionUrlConfigList", + "traits": { + "smithy.api#documentation": "

A list of function URL configurations.

", + "smithy.api#required": {} + } + }, + "NextMarker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

The pagination token that's included if more results are available.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lambda#ListFunctions": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#ListFunctionsRequest" + }, + "output": { + "target": "com.amazonaws.lambda#ListFunctionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of Lambda functions, with the version-specific configuration of each. Lambda returns up to 50\n functions per call.

\n

Set FunctionVersion to ALL to include all published versions of each function in\n addition to the unpublished version.

\n \n

The ListFunctions operation returns a subset of the FunctionConfiguration fields.\n To get the additional fields (State, StateReasonCode, StateReason, LastUpdateStatus, LastUpdateStatusReason,\n LastUpdateStatusReasonCode, RuntimeVersionConfig) for a function or version, use GetFunction.

\n ", + "smithy.api#examples": [ + { + "title": "To get a list of Lambda functions", + "documentation": "This operation returns a list of Lambda functions.", + "output": { + "NextMarker": "", + "Functions": [ + { + "TracingConfig": { + "Mode": "PassThrough" + }, + "Version": "$LATEST", + "CodeSha256": "dBG9m8SGdmlEjw/JYXlhhvCrAv5TxvXsbL/RMr0fT/I=", + "FunctionName": "helloworld", + "MemorySize": 128, + "RevisionId": "1718e831-badf-4253-9518-d0644210af7b", + "CodeSize": 294, + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:helloworld", + "Handler": "helloworld.handler", + "Role": "arn:aws:iam::123456789012:role/service-role/MyTestFunction-role-zgur6bf4", + "Timeout": 3, + "LastModified": "2019-09-23T18:32:33.857+0000", + "Runtime": "nodejs10.x", + "Description": "" + }, + { + "TracingConfig": { + "Mode": "PassThrough" + }, + "Version": "$LATEST", + "CodeSha256": "sU0cJ2/hOZevwV/lTxCuQqK3gDZP3i8gUoqUUVRmY6E=", + "FunctionName": "my-function", + "VpcConfig": { + "SubnetIds": [], + "VpcId": "", + "SecurityGroupIds": [] + }, + "MemorySize": 256, + "RevisionId": "93017fc9-59cb-41dc-901b-4845ce4bf668", + "CodeSize": 266, + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "Handler": "index.handler", + "Role": "arn:aws:iam::123456789012:role/service-role/helloWorldPython-role-uy3l9qyq", + "Timeout": 3, + "LastModified": "2019-10-01T16:47:28.490+0000", + "Runtime": "nodejs10.x", + "Description": "" + } + ] + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/2015-03-31/functions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "NextMarker", + "items": "Functions", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.lambda#ListFunctionsByCodeSigningConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#ListFunctionsByCodeSigningConfigRequest" + }, + "output": { + "target": "com.amazonaws.lambda#ListFunctionsByCodeSigningConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + } + ], + "traits": { + "smithy.api#documentation": "

List the functions that use the specified code signing configuration. You can use this method prior to deleting a\n code signing configuration, to verify that no functions are using it.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2020-04-22/code-signing-configs/{CodeSigningConfigArn}/functions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "NextMarker", + "items": "FunctionArns", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.lambda#ListFunctionsByCodeSigningConfigRequest": { + "type": "structure", + "members": { + "CodeSigningConfigArn": { + "target": "com.amazonaws.lambda#CodeSigningConfigArn", + "traits": { + "smithy.api#documentation": "

The The Amazon Resource Name (ARN) of the code signing configuration.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Marker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

", + "smithy.api#httpQuery": "Marker" + } + }, + "MaxItems": { + "target": "com.amazonaws.lambda#MaxListItems", + "traits": { + "smithy.api#documentation": "

Maximum number of items to return.

", + "smithy.api#httpQuery": "MaxItems" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#ListFunctionsByCodeSigningConfigResponse": { + "type": "structure", + "members": { + "NextMarker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

The pagination token that's included if more results are available.

" + } + }, + "FunctionArns": { + "target": "com.amazonaws.lambda#FunctionArnList", + "traits": { + "smithy.api#documentation": "

The function ARNs.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lambda#ListFunctionsRequest": { + "type": "structure", + "members": { + "MasterRegion": { + "target": "com.amazonaws.lambda#MasterRegion", + "traits": { + "smithy.api#documentation": "

For Lambda@Edge functions, the Amazon Web Services Region of the master function. For example,\n us-east-1 filters the list of functions to include only Lambda@Edge functions replicated from a\n master function in US East (N. Virginia). If specified, you must set FunctionVersion to\n ALL.

", + "smithy.api#httpQuery": "MasterRegion" + } + }, + "FunctionVersion": { + "target": "com.amazonaws.lambda#FunctionVersion", + "traits": { + "smithy.api#documentation": "

Set to ALL to include entries for all published versions of each function.

", + "smithy.api#httpQuery": "FunctionVersion" + } + }, + "Marker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

", + "smithy.api#httpQuery": "Marker" + } + }, + "MaxItems": { + "target": "com.amazonaws.lambda#MaxListItems", + "traits": { + "smithy.api#documentation": "

The maximum number of functions to return in the response. Note that ListFunctions returns a maximum of 50 items in each response,\n even if you set the number higher.

", + "smithy.api#httpQuery": "MaxItems" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#ListFunctionsResponse": { + "type": "structure", + "members": { + "NextMarker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

The pagination token that's included if more results are available.

" + } + }, + "Functions": { + "target": "com.amazonaws.lambda#FunctionList", + "traits": { + "smithy.api#documentation": "

A list of Lambda functions.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of Lambda functions.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.lambda#ListLayerVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#ListLayerVersionsRequest" + }, + "output": { + "target": "com.amazonaws.lambda#ListLayerVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the versions of an Lambda\n layer. Versions that have been deleted aren't listed. Specify a runtime identifier to list only\n versions that indicate that they're compatible with that runtime. Specify a compatible architecture to include only \n layer versions that are compatible with that architecture.

", + "smithy.api#examples": [ + { + "title": "To list versions of a layer", + "documentation": "The following example displays information about the versions for the layer named blank-java-lib", + "input": { + "LayerName": "blank-java-lib" + }, + "output": { + "LayerVersions": [ + { + "LayerVersionArn": "arn:aws:lambda:us-east-2:123456789012:layer:blank-java-lib:7", + "Version": 7, + "Description": "Dependencies for the blank-java sample app.", + "CreatedDate": "2020-03-18T23:38:42.284+0000", + "CompatibleRuntimes": [ + "java8" + ] + }, + { + "LayerVersionArn": "arn:aws:lambda:us-east-2:123456789012:layer:blank-java-lib:6", + "Version": 6, + "Description": "Dependencies for the blank-java sample app.", + "CreatedDate": "2020-03-17T07:24:21.960+0000", + "CompatibleRuntimes": [ + "java8" + ] + } + ] + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/2018-10-31/layers/{LayerName}/versions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "NextMarker", + "items": "LayerVersions", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.lambda#ListLayerVersionsRequest": { + "type": "structure", + "members": { + "CompatibleRuntime": { + "target": "com.amazonaws.lambda#Runtime", + "traits": { + "smithy.api#documentation": "

A runtime identifier.

\n

The following list includes deprecated runtimes. For more information, see\n Runtime use after deprecation.

\n

For a list of all currently supported runtimes, see\n Supported runtimes.

", + "smithy.api#httpQuery": "CompatibleRuntime" + } + }, + "LayerName": { + "target": "com.amazonaws.lambda#LayerName", + "traits": { + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the layer.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Marker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

A pagination token returned by a previous call.

", + "smithy.api#httpQuery": "Marker" + } + }, + "MaxItems": { + "target": "com.amazonaws.lambda#MaxLayerListItems", + "traits": { + "smithy.api#documentation": "

The maximum number of versions to return.

", + "smithy.api#httpQuery": "MaxItems" + } + }, + "CompatibleArchitecture": { + "target": "com.amazonaws.lambda#Architecture", + "traits": { + "smithy.api#documentation": "

The compatible \ninstruction set architecture.

", + "smithy.api#httpQuery": "CompatibleArchitecture" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#ListLayerVersionsResponse": { + "type": "structure", + "members": { + "NextMarker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

A pagination token returned when the response doesn't contain all versions.

" + } + }, + "LayerVersions": { + "target": "com.amazonaws.lambda#LayerVersionsList", + "traits": { + "smithy.api#documentation": "

A list of versions.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lambda#ListLayers": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#ListLayersRequest" + }, + "output": { + "target": "com.amazonaws.lambda#ListLayersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists Lambda\n layers and shows information about the latest version of each. Specify a\n runtime\n identifier to list only layers that indicate that they're compatible with that\n runtime. Specify a compatible architecture to include only layers that are compatible with\n that instruction set architecture.

", + "smithy.api#examples": [ + { + "title": "To list the layers that are compatible with your function's runtime", + "documentation": "The following example returns information about layers that are compatible with the Python 3.7 runtime.", + "input": { + "CompatibleRuntime": "python3.7" + }, + "output": { + "Layers": [ + { + "LayerName": "my-layer", + "LayerArn": "arn:aws:lambda:us-east-2:123456789012:layer:my-layer", + "LatestMatchingVersion": { + "LayerVersionArn": "arn:aws:lambda:us-east-2:123456789012:layer:my-layer:2", + "Version": 2, + "Description": "My layer", + "CreatedDate": "2018-11-15T00:37:46.592+0000", + "CompatibleRuntimes": [ + "python3.6", + "python3.7" + ] + } + } + ] + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/2018-10-31/layers", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "NextMarker", + "items": "Layers", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.lambda#ListLayersRequest": { + "type": "structure", + "members": { + "CompatibleRuntime": { + "target": "com.amazonaws.lambda#Runtime", + "traits": { + "smithy.api#documentation": "

A runtime identifier.

\n

The following list includes deprecated runtimes. For more information, see\n Runtime use after deprecation.

\n

For a list of all currently supported runtimes, see\n Supported runtimes.

", + "smithy.api#httpQuery": "CompatibleRuntime" + } + }, + "Marker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

A pagination token returned by a previous call.

", + "smithy.api#httpQuery": "Marker" + } + }, + "MaxItems": { + "target": "com.amazonaws.lambda#MaxLayerListItems", + "traits": { + "smithy.api#documentation": "

The maximum number of layers to return.

", + "smithy.api#httpQuery": "MaxItems" + } + }, + "CompatibleArchitecture": { + "target": "com.amazonaws.lambda#Architecture", + "traits": { + "smithy.api#documentation": "

The compatible \ninstruction set architecture.

", + "smithy.api#httpQuery": "CompatibleArchitecture" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#ListLayersResponse": { + "type": "structure", + "members": { + "NextMarker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

A pagination token returned when the response doesn't contain all layers.

" + } + }, + "Layers": { + "target": "com.amazonaws.lambda#LayersList", + "traits": { + "smithy.api#documentation": "

A list of function layers.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lambda#ListProvisionedConcurrencyConfigs": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#ListProvisionedConcurrencyConfigsRequest" + }, + "output": { + "target": "com.amazonaws.lambda#ListProvisionedConcurrencyConfigsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a list of provisioned concurrency configurations for a function.

", + "smithy.api#examples": [ + { + "title": "To get a list of provisioned concurrency configurations", + "documentation": "The following example returns a list of provisioned concurrency configurations for a function named my-function.", + "input": { + "FunctionName": "my-function" + }, + "output": { + "ProvisionedConcurrencyConfigs": [ + { + "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:GREEN", + "RequestedProvisionedConcurrentExecutions": 100, + "AvailableProvisionedConcurrentExecutions": 100, + "AllocatedProvisionedConcurrentExecutions": 100, + "Status": "READY", + "LastModified": "2019-12-31T20:29:00+0000" + }, + { + "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:BLUE", + "RequestedProvisionedConcurrentExecutions": 100, + "AvailableProvisionedConcurrentExecutions": 100, + "AllocatedProvisionedConcurrentExecutions": 100, + "Status": "READY", + "LastModified": "2019-12-31T20:28:49+0000" + } + ] + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/2019-09-30/functions/{FunctionName}/provisioned-concurrency?List=ALL", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "NextMarker", + "items": "ProvisionedConcurrencyConfigs", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.lambda#ListProvisionedConcurrencyConfigsRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function.

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Marker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

", + "smithy.api#httpQuery": "Marker" + } + }, + "MaxItems": { + "target": "com.amazonaws.lambda#MaxProvisionedConcurrencyConfigListItems", + "traits": { + "smithy.api#documentation": "

Specify a number to limit the number of configurations returned.

", + "smithy.api#httpQuery": "MaxItems" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#ListProvisionedConcurrencyConfigsResponse": { + "type": "structure", + "members": { + "ProvisionedConcurrencyConfigs": { + "target": "com.amazonaws.lambda#ProvisionedConcurrencyConfigList", + "traits": { + "smithy.api#documentation": "

A list of provisioned concurrency configurations.

" + } + }, + "NextMarker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

The pagination token that's included if more results are available.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lambda#ListTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#ListTagsRequest" + }, + "output": { + "target": "com.amazonaws.lambda#ListTagsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a function, event source mapping, or code signing configuration's tags. You can\n also view function tags with GetFunction.

", + "smithy.api#examples": [ + { + "title": "To retrieve the list of tags for a Lambda function", + "documentation": "The following example displays the tags attached to the my-function Lambda function.", + "input": { + "Resource": "arn:aws:lambda:us-west-2:123456789012:function:my-function" + }, + "output": { + "Tags": { + "Category": "Web Tools", + "Department": "Sales" + } + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/2017-03-31/tags/{Resource}", + "code": 200 + } + } + }, + "com.amazonaws.lambda#ListTagsRequest": { + "type": "structure", + "members": { + "Resource": { + "target": "com.amazonaws.lambda#TaggableResource", + "traits": { + "smithy.api#documentation": "

The resource's Amazon Resource Name (ARN). \n Note: Lambda does not support adding tags to function aliases or versions.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#ListTagsResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.lambda#Tags", + "traits": { + "smithy.api#documentation": "

The function's tags.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lambda#ListVersionsByFunction": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#ListVersionsByFunctionRequest" + }, + "output": { + "target": "com.amazonaws.lambda#ListVersionsByFunctionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of versions,\n with the version-specific configuration of each. Lambda returns up to 50 versions per call.

", + "smithy.api#examples": [ + { + "title": "To list versions of a function", + "documentation": "The following example returns a list of versions of a function named my-function", + "input": { + "FunctionName": "my-function" + }, + "output": { + "Versions": [ + { + "FunctionName": "my-function", + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "Runtime": "nodejs12.x", + "Role": "arn:aws:iam::123456789012:role/lambda-role", + "Handler": "index.handler", + "CodeSize": 5797206, + "Description": "Process image objects from Amazon S3.", + "Timeout": 15, + "MemorySize": 256, + "LastModified": "2020-04-10T19:06:32.563+0000", + "CodeSha256": "YFgDgEKG3ugvF1+pX64gV6tu9qNuIYNUdgJm8nCxsm4=", + "Version": "$LATEST", + "Environment": { + "Variables": { + "PREFIX": "inbound", + "BUCKET": "my-bucket-1xpuxmplzrlbh" + } + }, + "KMSKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966", + "TracingConfig": { + "Mode": "Active" + }, + "RevisionId": "850ca006-2d98-4ff4-86db-8766e9d32fe9" + }, + { + "FunctionName": "my-function", + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "Runtime": "nodejs12.x", + "Role": "arn:aws:iam::123456789012:role/lambda-role", + "Handler": "index.handler", + "CodeSize": 5797206, + "Description": "Process image objects from Amazon S3.", + "Timeout": 5, + "MemorySize": 256, + "LastModified": "2020-04-10T19:06:32.563+0000", + "CodeSha256": "YFgDgEKG3ugvF1+pX64gV6tu9qNuIYNUdgJm8nCxsm4=", + "Version": "1", + "Environment": { + "Variables": { + "PREFIX": "inbound", + "BUCKET": "my-bucket-1xpuxmplzrlbh" + } + }, + "KMSKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966", + "TracingConfig": { + "Mode": "Active" + }, + "RevisionId": "b75dcd81-xmpl-48a8-a75a-93ba8b5b9727" + } + ] + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/2015-03-31/functions/{FunctionName}/versions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "NextMarker", + "items": "Versions", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.lambda#ListVersionsByFunctionRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#NamespacedFunctionName", + "traits": { + "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name - MyFunction.

    \n
    • \n
  • \n

    \n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

    \n
    • \n
  • \n

    \n Partial ARN - 123456789012:function:MyFunction.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Marker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

", + "smithy.api#httpQuery": "Marker" + } + }, + "MaxItems": { + "target": "com.amazonaws.lambda#MaxListItems", + "traits": { + "smithy.api#documentation": "

The maximum number of versions to return. Note that ListVersionsByFunction returns a maximum of 50 items in each response, \n even if you set the number higher.

", + "smithy.api#httpQuery": "MaxItems" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#ListVersionsByFunctionResponse": { + "type": "structure", + "members": { + "NextMarker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

The pagination token that's included if more results are available.

" + } + }, + "Versions": { + "target": "com.amazonaws.lambda#FunctionList", + "traits": { + "smithy.api#documentation": "

A list of Lambda function versions.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lambda#LocalMountPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 160 + }, + "smithy.api#pattern": "^/mnt/[a-zA-Z0-9-_.]+$" + } + }, + "com.amazonaws.lambda#LogFormat": { + "type": "enum", + "members": { + "Json": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSON" + } + }, + "Text": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Text" + } + } + } + }, + "com.amazonaws.lambda#LogGroup": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[\\.\\-_/#A-Za-z0-9]+$" + } + }, + "com.amazonaws.lambda#LogType": { + "type": "enum", + "members": { + "None": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "None" + } + }, + "Tail": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Tail" + } + } + } + }, + "com.amazonaws.lambda#LoggingConfig": { + "type": "structure", + "members": { + "LogFormat": { + "target": "com.amazonaws.lambda#LogFormat", + "traits": { + "smithy.api#documentation": "

The format in which Lambda sends your function's application and system logs to CloudWatch. Select between \n plain text and structured JSON.

" + } + }, + "ApplicationLogLevel": { + "target": "com.amazonaws.lambda#ApplicationLogLevel", + "traits": { + "smithy.api#documentation": "

Set this property to filter the application logs for your function that Lambda sends to CloudWatch. Lambda only sends application logs at the \n selected level of detail and lower, where TRACE is the highest level and FATAL is the lowest.

" + } + }, + "SystemLogLevel": { + "target": "com.amazonaws.lambda#SystemLogLevel", + "traits": { + "smithy.api#documentation": "

Set this property to filter the system logs for your function that Lambda sends to CloudWatch. Lambda only sends system logs at the \n selected level of detail and lower, where DEBUG is the highest level and WARN is the lowest.

" + } + }, + "LogGroup": { + "target": "com.amazonaws.lambda#LogGroup", + "traits": { + "smithy.api#documentation": "

The name of the Amazon CloudWatch log group the function sends logs to. By default, Lambda functions send logs to a default \n log group named /aws/lambda/. To use a different log group, enter an existing log group or enter a new log group name.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The function's Amazon CloudWatch Logs configuration settings.

" + } + }, + "com.amazonaws.lambda#Long": { + "type": "long", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.lambda#MasterRegion": { + "type": "string", + "traits": { + "smithy.api#pattern": "^ALL|[a-z]{2}(-gov)?-[a-z]+-\\d{1}$" + } + }, + "com.amazonaws.lambda#MaxAge": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 86400 + } + } + }, + "com.amazonaws.lambda#MaxFunctionEventInvokeConfigListItems": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.lambda#MaxItems": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.lambda#MaxLayerListItems": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.lambda#MaxListItems": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 10000 + } + } + }, + "com.amazonaws.lambda#MaxProvisionedConcurrencyConfigListItems": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.lambda#MaximumBatchingWindowInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 300 + } + } + }, + "com.amazonaws.lambda#MaximumConcurrency": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 2, + "max": 1000 + } + } + }, + "com.amazonaws.lambda#MaximumEventAgeInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 60, + "max": 21600 + } + } + }, + "com.amazonaws.lambda#MaximumNumberOfPollers": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 2000 + } + } + }, + "com.amazonaws.lambda#MaximumRecordAgeInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": -1, + "max": 604800 + } + } + }, + "com.amazonaws.lambda#MaximumRetryAttempts": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 2 + } + } + }, + "com.amazonaws.lambda#MaximumRetryAttemptsEventSourceMapping": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": -1, + "max": 10000 + } + } + }, + "com.amazonaws.lambda#MemorySize": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 128, + "max": 10240 + } + } + }, + "com.amazonaws.lambda#Method": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 6 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.lambda#MinimumNumberOfPollers": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.lambda#NameSpacedFunctionArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_\\.]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?$" + } + }, + "com.amazonaws.lambda#NamespacedFunctionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 170 + }, + "smithy.api#pattern": "^(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_\\.]+)(:(\\$LATEST|[a-zA-Z0-9-_]+))?$" + } + }, + "com.amazonaws.lambda#NamespacedStatementId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^([a-zA-Z0-9-_.]+)$" + } + }, + "com.amazonaws.lambda#NonNegativeInteger": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.lambda#NullableBoolean": { + "type": "boolean" + }, + "com.amazonaws.lambda#OnFailure": { + "type": "structure", + "members": { + "Destination": { + "target": "com.amazonaws.lambda#DestinationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the destination resource.

\n

To retain records of unsuccessful asynchronous invocations,\n you can configure an Amazon SNS topic, Amazon SQS queue, Amazon S3 bucket, Lambda function,\n or Amazon EventBridge event bus as the destination.

\n

To retain records of failed invocations from Kinesis, \n DynamoDB, self-managed Kafka or\n Amazon MSK,\n you can configure an Amazon SNS topic, Amazon SQS queue, or Amazon S3 bucket as the destination.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A destination for events that failed processing.

" + } + }, + "com.amazonaws.lambda#OnSuccess": { + "type": "structure", + "members": { + "Destination": { + "target": "com.amazonaws.lambda#DestinationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the destination resource.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A destination for events that were processed successfully.

\n

To retain records of successful asynchronous invocations,\n you can configure an Amazon SNS topic, Amazon SQS queue, Lambda function,\n or Amazon EventBridge event bus as the destination.

" + } + }, + "com.amazonaws.lambda#OrganizationId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 34 + }, + "smithy.api#pattern": "^o-[a-z0-9]{10,32}$" + } + }, + "com.amazonaws.lambda#Origin": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 253 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.lambda#PackageType": { + "type": "enum", + "members": { + "Zip": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Zip" + } + }, + "Image": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Image" + } + } + } + }, + "com.amazonaws.lambda#ParallelizationFactor": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.lambda#Pattern": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4096 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.lambda#PolicyLengthExceededException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String" + }, + "message": { + "target": "com.amazonaws.lambda#String" + } + }, + "traits": { + "smithy.api#documentation": "

The permissions policy for the resource is too large. For more information, see Lambda quotas.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.lambda#PositiveInteger": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.lambda#PreconditionFailedException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

The exception type.

" + } + }, + "message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

The exception message.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The RevisionId provided does not match the latest RevisionId for the Lambda function or alias.

\n
    \n
  • \n

    \n For AddPermission and RemovePermission API operations: Call GetPolicy to retrieve the latest RevisionId for your resource.

    \n
    • \n
  • \n

    \n For all other API operations: Call GetFunction or GetAlias to retrieve the latest RevisionId for your resource.

    \n
    • \n
", + "smithy.api#error": "client", + "smithy.api#httpError": 412 + } + }, + "com.amazonaws.lambda#Principal": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[^\\s]+$" + } + }, + "com.amazonaws.lambda#PrincipalOrgID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 34 + }, + "smithy.api#pattern": "^o-[a-z0-9]{10,32}$" + } + }, + "com.amazonaws.lambda#ProvisionedConcurrencyConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#ProvisionedConcurrencyConfigListItem" + } + }, + "com.amazonaws.lambda#ProvisionedConcurrencyConfigListItem": { + "type": "structure", + "members": { + "FunctionArn": { + "target": "com.amazonaws.lambda#FunctionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the alias or version.

" + } + }, + "RequestedProvisionedConcurrentExecutions": { + "target": "com.amazonaws.lambda#PositiveInteger", + "traits": { + "smithy.api#documentation": "

The amount of provisioned concurrency requested.

" + } + }, + "AvailableProvisionedConcurrentExecutions": { + "target": "com.amazonaws.lambda#NonNegativeInteger", + "traits": { + "smithy.api#documentation": "

The amount of provisioned concurrency available.

" + } + }, + "AllocatedProvisionedConcurrentExecutions": { + "target": "com.amazonaws.lambda#NonNegativeInteger", + "traits": { + "smithy.api#documentation": "

The amount of provisioned concurrency allocated. When a weighted alias is used during linear and canary deployments, this value fluctuates depending on the amount of concurrency that is provisioned for the function versions.

" + } + }, + "Status": { + "target": "com.amazonaws.lambda#ProvisionedConcurrencyStatusEnum", + "traits": { + "smithy.api#documentation": "

The status of the allocation process.

" + } + }, + "StatusReason": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

For failed allocations, the reason that provisioned concurrency could not be allocated.

" + } + }, + "LastModified": { + "target": "com.amazonaws.lambda#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that a user last updated the configuration, in ISO 8601 format.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the provisioned concurrency configuration for a function alias or version.

" + } + }, + "com.amazonaws.lambda#ProvisionedConcurrencyConfigNotFoundException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String" + }, + "message": { + "target": "com.amazonaws.lambda#String" + } + }, + "traits": { + "smithy.api#documentation": "

The specified configuration does not exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.lambda#ProvisionedConcurrencyStatusEnum": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.lambda#ProvisionedPollerConfig": { + "type": "structure", + "members": { + "MinimumPollers": { + "target": "com.amazonaws.lambda#MinimumNumberOfPollers", + "traits": { + "smithy.api#documentation": "

The minimum number of event pollers this event source can scale down to.

" + } + }, + "MaximumPollers": { + "target": "com.amazonaws.lambda#MaximumNumberOfPollers", + "traits": { + "smithy.api#documentation": "

The maximum number of event pollers this event source can scale up to.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The \n Provisioned Mode configuration for the event source. Use Provisioned Mode to customize the minimum and maximum number of event pollers\n for your event source. An event poller is a compute unit that provides approximately 5 MBps of throughput.

" + } + }, + "com.amazonaws.lambda#PublishLayerVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#PublishLayerVersionRequest" + }, + "output": { + "target": "com.amazonaws.lambda#PublishLayerVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#CodeStorageExceededException" + }, + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an Lambda\n layer from a ZIP archive. Each time you call PublishLayerVersion with the same\n layer name, a new version is created.

\n

Add layers to your function with CreateFunction or UpdateFunctionConfiguration.

", + "smithy.api#examples": [ + { + "title": "To create a Lambda layer version", + "documentation": "The following example creates a new Python library layer version. The command retrieves the layer content a file named layer.zip in the specified S3 bucket.", + "input": { + "LayerName": "my-layer", + "Description": "My Python layer", + "Content": { + "S3Bucket": "lambda-layers-us-west-2-123456789012", + "S3Key": "layer.zip" + }, + "CompatibleRuntimes": [ + "python3.6", + "python3.7" + ], + "LicenseInfo": "MIT" + }, + "output": { + "Content": { + "Location": "https://awslambda-us-west-2-layers.s3.us-west-2.amazonaws.com/snapshots/123456789012/my-layer-4aaa2fbb-ff77-4b0a-ad92-5b78a716a96a?versionId=27iWyA73cCAYqyH...", + "CodeSha256": "tv9jJO+rPbXUUXuRKi7CwHzKtLDkDRJLB3cC3Z/ouXo=", + "CodeSize": 169 + }, + "LayerArn": "arn:aws:lambda:us-west-2:123456789012:layer:my-layer", + "LayerVersionArn": "arn:aws:lambda:us-west-2:123456789012:layer:my-layer:1", + "Description": "My Python layer", + "CreatedDate": "2018-11-14T23:03:52.894+0000", + "Version": 1, + "LicenseInfo": "MIT", + "CompatibleRuntimes": [ + "python3.6", + "python3.7" + ] + } + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/2018-10-31/layers/{LayerName}/versions", + "code": 201 + } + } + }, + "com.amazonaws.lambda#PublishLayerVersionRequest": { + "type": "structure", + "members": { + "LayerName": { + "target": "com.amazonaws.lambda#LayerName", + "traits": { + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the layer.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.lambda#Description", + "traits": { + "smithy.api#documentation": "

The description of the version.

" + } + }, + "Content": { + "target": "com.amazonaws.lambda#LayerVersionContentInput", + "traits": { + "smithy.api#documentation": "

The function layer archive.

", + "smithy.api#required": {} + } + }, + "CompatibleRuntimes": { + "target": "com.amazonaws.lambda#CompatibleRuntimes", + "traits": { + "smithy.api#documentation": "

A list of compatible function\n runtimes. Used for filtering with ListLayers and ListLayerVersions.

\n

The following list includes deprecated runtimes. For more information, see Runtime deprecation policy.

" + } + }, + "LicenseInfo": { + "target": "com.amazonaws.lambda#LicenseInfo", + "traits": { + "smithy.api#documentation": "

The layer's software license. It can be any of the following:

\n
    \n
  • \n

    An SPDX license identifier. For example,\n MIT.

    \n
    • \n
  • \n

    The URL of a license hosted on the internet. For example,\n https://opensource.org/licenses/MIT.

    \n
    • \n
  • \n

    The full text of the license.

    \n
    • \n
" + } + }, + "CompatibleArchitectures": { + "target": "com.amazonaws.lambda#CompatibleArchitectures", + "traits": { + "smithy.api#documentation": "

A list of compatible \ninstruction set architectures.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#PublishLayerVersionResponse": { + "type": "structure", + "members": { + "Content": { + "target": "com.amazonaws.lambda#LayerVersionContentOutput", + "traits": { + "smithy.api#documentation": "

Details about the layer version.

" + } + }, + "LayerArn": { + "target": "com.amazonaws.lambda#LayerArn", + "traits": { + "smithy.api#documentation": "

The ARN of the layer.

" + } + }, + "LayerVersionArn": { + "target": "com.amazonaws.lambda#LayerVersionArn", + "traits": { + "smithy.api#documentation": "

The ARN of the layer version.

" + } + }, + "Description": { + "target": "com.amazonaws.lambda#Description", + "traits": { + "smithy.api#documentation": "

The description of the version.

" + } + }, + "CreatedDate": { + "target": "com.amazonaws.lambda#Timestamp", + "traits": { + "smithy.api#documentation": "

The date that the layer version was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

" + } + }, + "Version": { + "target": "com.amazonaws.lambda#LayerVersionNumber", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The version number.

" + } + }, + "CompatibleRuntimes": { + "target": "com.amazonaws.lambda#CompatibleRuntimes", + "traits": { + "smithy.api#documentation": "

The layer's compatible runtimes.

\n

The following list includes deprecated runtimes. For more information, see\n Runtime use after deprecation.

\n

For a list of all currently supported runtimes, see\n Supported runtimes.

" + } + }, + "LicenseInfo": { + "target": "com.amazonaws.lambda#LicenseInfo", + "traits": { + "smithy.api#documentation": "

The layer's software license.

" + } + }, + "CompatibleArchitectures": { + "target": "com.amazonaws.lambda#CompatibleArchitectures", + "traits": { + "smithy.api#documentation": "

A list of compatible \ninstruction set architectures.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lambda#PublishVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#PublishVersionRequest" + }, + "output": { + "target": "com.amazonaws.lambda#FunctionConfiguration" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#CodeStorageExceededException" + }, + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#PreconditionFailedException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a version from the\n current code and configuration of a function. Use versions to create a snapshot of your function code and\n configuration that doesn't change.

\n

Lambda doesn't publish a version if the function's configuration and code haven't changed since the last\n version. Use UpdateFunctionCode or UpdateFunctionConfiguration to update the\n function before publishing a version.

\n

Clients can invoke versions directly or with an alias. To create an alias, use CreateAlias.

", + "smithy.api#examples": [ + { + "title": "To publish a version of a Lambda function", + "documentation": "This operation publishes a version of a Lambda function", + "input": { + "FunctionName": "myFunction", + "CodeSha256": "", + "Description": "" + }, + "output": { + "FunctionName": "my-function", + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "Runtime": "nodejs12.x", + "Role": "arn:aws:iam::123456789012:role/lambda-role", + "Handler": "index.handler", + "CodeSize": 5797206, + "Description": "Process image objects from Amazon S3.", + "Timeout": 5, + "MemorySize": 256, + "LastModified": "2020-04-10T19:06:32.563+0000", + "CodeSha256": "YFgDgEKG3ugvF1+pX64gV6tu9qNuIYNUdgJm8nCxsm4=", + "Version": "1", + "Environment": { + "Variables": { + "PREFIX": "inbound", + "BUCKET": "my-bucket-1xpuxmplzrlbh" + } + }, + "KMSKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966", + "TracingConfig": { + "Mode": "Active" + }, + "RevisionId": "b75dcd81-xmpl-48a8-a75a-93ba8b5b9727", + "State": "Active", + "LastUpdateStatus": "Successful" + } + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/2015-03-31/functions/{FunctionName}/versions", + "code": 201 + } + } + }, + "com.amazonaws.lambda#PublishVersionRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name - MyFunction.

    \n
    • \n
  • \n

    \n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

    \n
    • \n
  • \n

    \n Partial ARN - 123456789012:function:MyFunction.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "CodeSha256": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

Only publish a version if the hash value matches the value that's specified. Use this option to avoid\n publishing a version if the function code has changed since you last updated it. You can get the hash for the\n version that you uploaded from the output of UpdateFunctionCode.

" + } + }, + "Description": { + "target": "com.amazonaws.lambda#Description", + "traits": { + "smithy.api#documentation": "

A description for the version to override the description in the function configuration.

" + } + }, + "RevisionId": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

Only update the function if the revision ID matches the ID that's specified. Use this option to avoid\n publishing a version if the function configuration has changed since you last updated it.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#PutFunctionCodeSigningConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#PutFunctionCodeSigningConfigRequest" + }, + "output": { + "target": "com.amazonaws.lambda#PutFunctionCodeSigningConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#CodeSigningConfigNotFoundException" + }, + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Update the code signing configuration for the function. Changes to the code signing configuration take effect the\n next time a user tries to deploy a code package to the function.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/2020-06-30/functions/{FunctionName}/code-signing-config", + "code": 200 + } + } + }, + "com.amazonaws.lambda#PutFunctionCodeSigningConfigRequest": { + "type": "structure", + "members": { + "CodeSigningConfigArn": { + "target": "com.amazonaws.lambda#CodeSigningConfigArn", + "traits": { + "smithy.api#documentation": "

The The Amazon Resource Name (ARN) of the code signing configuration.

", + "smithy.api#required": {} + } + }, + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name - MyFunction.

    \n
    • \n
  • \n

    \n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

    \n
    • \n
  • \n

    \n Partial ARN - 123456789012:function:MyFunction.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#PutFunctionCodeSigningConfigResponse": { + "type": "structure", + "members": { + "CodeSigningConfigArn": { + "target": "com.amazonaws.lambda#CodeSigningConfigArn", + "traits": { + "smithy.api#documentation": "

The The Amazon Resource Name (ARN) of the code signing configuration.

", + "smithy.api#required": {} + } + }, + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name - MyFunction.

    \n
    • \n
  • \n

    \n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

    \n
    • \n
  • \n

    \n Partial ARN - 123456789012:function:MyFunction.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lambda#PutFunctionConcurrency": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#PutFunctionConcurrencyRequest" + }, + "output": { + "target": "com.amazonaws.lambda#Concurrency" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Sets the maximum number of simultaneous executions for a function, and reserves capacity for that concurrency\n level.

\n

Concurrency settings apply to the function as a whole, including all published versions and the unpublished\n version. Reserving concurrency both ensures that your function has capacity to process the specified number of\n events simultaneously, and prevents it from scaling beyond that level. Use GetFunction to see\n the current setting for a function.

\n

Use GetAccountSettings to see your Regional concurrency limit. You can reserve concurrency\n for as many functions as you like, as long as you leave at least 100 simultaneous executions unreserved for\n functions that aren't configured with a per-function limit. For more information, see Lambda function scaling.

", + "smithy.api#examples": [ + { + "title": "To configure a reserved concurrency limit for a function", + "documentation": "The following example configures 100 reserved concurrent executions for the my-function function.", + "input": { + "FunctionName": "my-function", + "ReservedConcurrentExecutions": 100 + }, + "output": { + "ReservedConcurrentExecutions": 100 + } + } + ], + "smithy.api#http": { + "method": "PUT", + "uri": "/2017-10-31/functions/{FunctionName}/concurrency", + "code": 200 + } + } + }, + "com.amazonaws.lambda#PutFunctionConcurrencyRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function.

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ReservedConcurrentExecutions": { + "target": "com.amazonaws.lambda#ReservedConcurrentExecutions", + "traits": { + "smithy.api#documentation": "

The number of simultaneous executions to reserve for the function.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#PutFunctionEventInvokeConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#PutFunctionEventInvokeConfigRequest" + }, + "output": { + "target": "com.amazonaws.lambda#FunctionEventInvokeConfig" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Configures options for asynchronous\n invocation on a function, version, or alias. If a configuration already exists for a function, version,\n or alias, this operation overwrites it. If you exclude any settings, they are removed. To set one option without\n affecting existing settings for other options, use UpdateFunctionEventInvokeConfig.

\n

By default, Lambda retries an asynchronous invocation twice if the function returns an error. It retains\n events in a queue for up to six hours. When an event fails all processing attempts or stays in the asynchronous\n invocation queue for too long, Lambda discards it. To retain discarded events, configure a dead-letter queue with\n UpdateFunctionConfiguration.

\n

To send an invocation record to a queue, topic, S3 bucket, function, or event bus, specify a destination. You can configure separate destinations for successful invocations (on-success) and events\n that fail all processing attempts (on-failure). You can configure destinations in addition to or instead of a\n dead-letter queue.

\n \n

S3 buckets are supported only for on-failure destinations. To retain records of successful invocations, use another destination type.

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/2019-09-25/functions/{FunctionName}/event-invoke-config", + "code": 200 + } + } + }, + "com.amazonaws.lambda#PutFunctionEventInvokeConfigRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "

The name or ARN of the Lambda function, version, or alias.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name - my-function (name-only), my-function:v1 (with alias).

    \n
    • \n
  • \n

    \n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN - 123456789012:function:my-function.

    \n
    • \n
\n

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\n If you specify only the function name, it is limited to 64 characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#Qualifier", + "traits": { + "smithy.api#documentation": "

A version number or alias name.

", + "smithy.api#httpQuery": "Qualifier" + } + }, + "MaximumRetryAttempts": { + "target": "com.amazonaws.lambda#MaximumRetryAttempts", + "traits": { + "smithy.api#documentation": "

The maximum number of times to retry when the function returns an error.

" + } + }, + "MaximumEventAgeInSeconds": { + "target": "com.amazonaws.lambda#MaximumEventAgeInSeconds", + "traits": { + "smithy.api#documentation": "

The maximum age of a request that Lambda sends to a function for processing.

" + } + }, + "DestinationConfig": { + "target": "com.amazonaws.lambda#DestinationConfig", + "traits": { + "smithy.api#documentation": "

A destination for events after they have been sent to a function for processing.

\n

\n Destinations\n

\n
    \n
  • \n

    \n Function - The Amazon Resource Name (ARN) of a Lambda function.

    \n
    • \n
  • \n

    \n Queue - The ARN of a standard SQS queue.

    \n
    • \n
  • \n

    \n Bucket - The ARN of an Amazon S3 bucket.

    \n
    • \n
  • \n

    \n Topic - The ARN of a standard SNS topic.

    \n
    • \n
  • \n

    \n Event Bus - The ARN of an Amazon EventBridge event bus.

    \n
    • \n
\n \n

S3 buckets are supported only for on-failure destinations. To retain records of successful invocations, use another destination type.

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#PutFunctionRecursionConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#PutFunctionRecursionConfigRequest" + }, + "output": { + "target": "com.amazonaws.lambda#PutFunctionRecursionConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Sets your function's recursive loop detection configuration.

\n

When you configure a Lambda function to output to the same service or resource that invokes the function, it's possible to create \n an infinite recursive loop. For example, a Lambda function might write a message to an Amazon Simple Queue Service (Amazon SQS) queue, which then invokes the same \n function. This invocation causes the function to write another message to the queue, which in turn invokes the function again.

\n

Lambda can detect certain types of recursive loops shortly after they occur. When Lambda detects a recursive loop and your \n function's recursive loop detection configuration is set to Terminate, it stops your function being invoked and notifies\n you.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/2024-08-31/functions/{FunctionName}/recursion-config", + "code": 200 + } + } + }, + "com.amazonaws.lambda#PutFunctionRecursionConfigRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#UnqualifiedFunctionName", + "traits": { + "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function.

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RecursiveLoop": { + "target": "com.amazonaws.lambda#RecursiveLoop", + "traits": { + "smithy.api#documentation": "

If you set your function's recursive loop detection configuration to Allow, Lambda doesn't take any action when it \n detects your function being invoked as part of a recursive loop. We recommend that you only use this setting if your design intentionally uses a \n Lambda function to write data back to the same Amazon Web Services resource that invokes it.

\n

If you set your function's recursive loop detection configuration to Terminate, Lambda stops your function being \n invoked and notifies you when it detects your function being invoked as part of a recursive loop.

\n

By default, Lambda sets your function's configuration to Terminate.

\n \n

If your design intentionally uses a Lambda function to write data back to the same Amazon Web Services resource that invokes\n the function, then use caution and implement suitable guard rails to prevent unexpected charges being billed to\n your Amazon Web Services account. To learn more about best practices for using recursive invocation patterns, see Recursive patterns that cause\n run-away Lambda functions in Serverless Land.

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#PutFunctionRecursionConfigResponse": { + "type": "structure", + "members": { + "RecursiveLoop": { + "target": "com.amazonaws.lambda#RecursiveLoop", + "traits": { + "smithy.api#documentation": "

The status of your function's recursive loop detection configuration.

\n

When this value is set to Allowand Lambda detects your function being invoked as part of a recursive \n loop, it doesn't take any action.

\n

When this value is set to Terminate and Lambda detects your function being invoked as part of a recursive \n loop, it stops your function being invoked and notifies you.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lambda#PutProvisionedConcurrencyConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#PutProvisionedConcurrencyConfigRequest" + }, + "output": { + "target": "com.amazonaws.lambda#PutProvisionedConcurrencyConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds a provisioned concurrency configuration to a function's alias or version.

", + "smithy.api#examples": [ + { + "title": "To allocate provisioned concurrency", + "documentation": "The following example allocates 100 provisioned concurrency for the BLUE alias of the specified function.", + "input": { + "FunctionName": "my-function", + "Qualifier": "BLUE", + "ProvisionedConcurrentExecutions": 100 + }, + "output": { + "RequestedProvisionedConcurrentExecutions": 100, + "AllocatedProvisionedConcurrentExecutions": 0, + "Status": "IN_PROGRESS", + "LastModified": "2019-11-21T19:32:12+0000" + } + } + ], + "smithy.api#http": { + "method": "PUT", + "uri": "/2019-09-30/functions/{FunctionName}/provisioned-concurrency", + "code": 202 + } + } + }, + "com.amazonaws.lambda#PutProvisionedConcurrencyConfigRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function.

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#Qualifier", + "traits": { + "smithy.api#documentation": "

The version number or alias name.

", + "smithy.api#httpQuery": "Qualifier", + "smithy.api#required": {} + } + }, + "ProvisionedConcurrentExecutions": { + "target": "com.amazonaws.lambda#PositiveInteger", + "traits": { + "smithy.api#documentation": "

The amount of provisioned concurrency to allocate for the version or alias.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#PutProvisionedConcurrencyConfigResponse": { + "type": "structure", + "members": { + "RequestedProvisionedConcurrentExecutions": { + "target": "com.amazonaws.lambda#PositiveInteger", + "traits": { + "smithy.api#documentation": "

The amount of provisioned concurrency requested.

" + } + }, + "AvailableProvisionedConcurrentExecutions": { + "target": "com.amazonaws.lambda#NonNegativeInteger", + "traits": { + "smithy.api#documentation": "

The amount of provisioned concurrency available.

" + } + }, + "AllocatedProvisionedConcurrentExecutions": { + "target": "com.amazonaws.lambda#NonNegativeInteger", + "traits": { + "smithy.api#documentation": "

The amount of provisioned concurrency allocated. When a weighted alias is used during linear and canary deployments, this value fluctuates depending on the amount of concurrency that is provisioned for the function versions.

" + } + }, + "Status": { + "target": "com.amazonaws.lambda#ProvisionedConcurrencyStatusEnum", + "traits": { + "smithy.api#documentation": "

The status of the allocation process.

" + } + }, + "StatusReason": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

For failed allocations, the reason that provisioned concurrency could not be allocated.

" + } + }, + "LastModified": { + "target": "com.amazonaws.lambda#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that a user last updated the configuration, in ISO 8601 format.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lambda#PutRuntimeManagementConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#PutRuntimeManagementConfigRequest" + }, + "output": { + "target": "com.amazonaws.lambda#PutRuntimeManagementConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Sets the runtime management configuration for a function's version. For more information, \n see Runtime updates.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/2021-07-20/functions/{FunctionName}/runtime-management-config", + "code": 200 + } + } + }, + "com.amazonaws.lambda#PutRuntimeManagementConfigRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function.

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#Qualifier", + "traits": { + "smithy.api#documentation": "

Specify a version of the function. This can be $LATEST or a published version number. If no value is specified, the configuration for the \n $LATEST version is returned.

", + "smithy.api#httpQuery": "Qualifier" + } + }, + "UpdateRuntimeOn": { + "target": "com.amazonaws.lambda#UpdateRuntimeOn", + "traits": { + "smithy.api#documentation": "

Specify the runtime update mode.

\n
    \n
  • \n

    \n Auto (default) - Automatically update to the most recent and secure runtime version using a Two-phase runtime version rollout. This is the best \n choice for most customers to ensure they always benefit from runtime updates.

    \n
    • \n
  • \n

    \n Function update - Lambda updates the runtime of your function to the most recent and secure runtime version when you update your \n function. This approach synchronizes runtime updates with function deployments, giving you control over when runtime updates are applied and allowing you to detect and \n mitigate rare runtime update incompatibilities early. When using this setting, you need to regularly update your functions to keep their runtime up-to-date.

    \n
    • \n
  • \n

    \n Manual - You specify a runtime version in your function configuration. The function will use this runtime version indefinitely. \n In the rare case where a new runtime version is incompatible with an existing function, this allows you to roll back your function to an earlier runtime version. For more information, \n see Roll back a runtime version.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "RuntimeVersionArn": { + "target": "com.amazonaws.lambda#RuntimeVersionArn", + "traits": { + "smithy.api#documentation": "

The ARN of the runtime version you want the function to use.

\n \n

This is only required if you're using the Manual runtime update mode.

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#PutRuntimeManagementConfigResponse": { + "type": "structure", + "members": { + "UpdateRuntimeOn": { + "target": "com.amazonaws.lambda#UpdateRuntimeOn", + "traits": { + "smithy.api#documentation": "

The runtime update mode.

", + "smithy.api#required": {} + } + }, + "FunctionArn": { + "target": "com.amazonaws.lambda#FunctionArn", + "traits": { + "smithy.api#documentation": "

The ARN of the function

", + "smithy.api#required": {} + } + }, + "RuntimeVersionArn": { + "target": "com.amazonaws.lambda#RuntimeVersionArn", + "traits": { + "smithy.api#documentation": "

The ARN of the runtime the function is configured to use. If the runtime update mode is manual, the ARN is returned, otherwise null \n is returned.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lambda#Qualifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(|[a-zA-Z0-9$_-]+)$" + } + }, + "com.amazonaws.lambda#Queue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + }, + "smithy.api#pattern": "^[\\s\\S]*$" + } + }, + "com.amazonaws.lambda#Queues": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#Queue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.lambda#RecursiveInvocationException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

The exception type.

" + } + }, + "Message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

The exception message.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Lambda has detected your function being invoked in a recursive loop with other Amazon Web Services resources and stopped your function's invocation.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.lambda#RecursiveLoop": { + "type": "enum", + "members": { + "Allow": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Allow" + } + }, + "Terminate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terminate" + } + } + } + }, + "com.amazonaws.lambda#RemoveLayerVersionPermission": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#RemoveLayerVersionPermissionRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#PreconditionFailedException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes a statement from the permissions policy for a version of an Lambda\n layer. For more information, see\n AddLayerVersionPermission.

", + "smithy.api#examples": [ + { + "title": "To delete layer-version permissions", + "documentation": "The following example deletes permission for an account to configure a layer version.", + "input": { + "LayerName": "my-layer", + "VersionNumber": 1, + "StatementId": "xaccount" + } + } + ], + "smithy.api#http": { + "method": "DELETE", + "uri": "/2018-10-31/layers/{LayerName}/versions/{VersionNumber}/policy/{StatementId}", + "code": 204 + } + } + }, + "com.amazonaws.lambda#RemoveLayerVersionPermissionRequest": { + "type": "structure", + "members": { + "LayerName": { + "target": "com.amazonaws.lambda#LayerName", + "traits": { + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the layer.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VersionNumber": { + "target": "com.amazonaws.lambda#LayerVersionNumber", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The version number.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "StatementId": { + "target": "com.amazonaws.lambda#StatementId", + "traits": { + "smithy.api#documentation": "

The identifier that was specified when the statement was added.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RevisionId": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

Only update the policy if the revision ID matches the ID specified. Use this option to avoid modifying a\n policy that has changed since you last read it.

", + "smithy.api#httpQuery": "RevisionId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#RemovePermission": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#RemovePermissionRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#PreconditionFailedException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Revokes function-use permission from an Amazon Web Services service or another Amazon Web Services account. You\n can get the ID of the statement from the output of GetPolicy.

", + "smithy.api#examples": [ + { + "title": "To remove a Lambda function's permissions", + "documentation": "The following example removes a permissions statement named xaccount from the PROD alias of a function named my-function.", + "input": { + "FunctionName": "my-function", + "StatementId": "xaccount", + "Qualifier": "PROD" + } + } + ], + "smithy.api#http": { + "method": "DELETE", + "uri": "/2015-03-31/functions/{FunctionName}/policy/{StatementId}", + "code": 204 + } + } + }, + "com.amazonaws.lambda#RemovePermissionRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "

The name or ARN of the Lambda function, version, or alias.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function (name-only), my-function:v1 (with alias).

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\n If you specify only the function name, it is limited to 64 characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "StatementId": { + "target": "com.amazonaws.lambda#NamespacedStatementId", + "traits": { + "smithy.api#documentation": "

Statement ID of the permission to remove.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#Qualifier", + "traits": { + "smithy.api#documentation": "

Specify a version or alias to remove permissions from a published version of the function.

", + "smithy.api#httpQuery": "Qualifier" + } + }, + "RevisionId": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

Update the policy only if the revision ID matches the ID that's specified. Use this option to avoid modifying a\n policy that has changed since you last read it.

", + "smithy.api#httpQuery": "RevisionId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#RequestTooLargeException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String" + }, + "message": { + "target": "com.amazonaws.lambda#String" + } + }, + "traits": { + "smithy.api#documentation": "

The request payload exceeded the Invoke request body JSON input quota. For more information, see Lambda\n quotas.

", + "smithy.api#error": "client", + "smithy.api#httpError": 413 + } + }, + "com.amazonaws.lambda#ReservedConcurrentExecutions": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.lambda#ResourceArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$" + } + }, + "com.amazonaws.lambda#ResourceConflictException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

The exception type.

" + } + }, + "message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

The exception message.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The resource already exists, or another operation is in progress.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.lambda#ResourceInUseException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String" + }, + "Message": { + "target": "com.amazonaws.lambda#String" + } + }, + "traits": { + "smithy.api#documentation": "

The operation conflicts with the resource's availability. For example, you tried to update an event source\n mapping in the CREATING state, or you tried to delete an event source mapping currently UPDATING.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.lambda#ResourceNotFoundException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String" + }, + "Message": { + "target": "com.amazonaws.lambda#String" + } + }, + "traits": { + "smithy.api#documentation": "

The resource specified in the request does not exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.lambda#ResourceNotReadyException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

The exception type.

" + } + }, + "message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

The exception message.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The function is inactive and its VPC connection is no longer available. Wait for the VPC connection to\n reestablish and try again.

", + "smithy.api#error": "server", + "smithy.api#httpError": 502 + } + }, + "com.amazonaws.lambda#ResponseStreamingInvocationType": { + "type": "enum", + "members": { + "RequestResponse": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RequestResponse" + } + }, + "DryRun": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DryRun" + } + } + } + }, + "com.amazonaws.lambda#RoleArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$" + } + }, + "com.amazonaws.lambda#Runtime": { + "type": "enum", + "members": { + "nodejs": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nodejs" + } + }, + "nodejs43": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nodejs4.3" + } + }, + "nodejs610": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nodejs6.10" + } + }, + "nodejs810": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nodejs8.10" + } + }, + "nodejs10x": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nodejs10.x" + } + }, + "nodejs12x": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nodejs12.x" + } + }, + "nodejs14x": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nodejs14.x" + } + }, + "nodejs16x": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nodejs16.x" + } + }, + "java8": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "java8" + } + }, + "java8al2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "java8.al2" + } + }, + "java11": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "java11" + } + }, + "python27": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "python2.7" + } + }, + "python36": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "python3.6" + } + }, + "python37": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "python3.7" + } + }, + "python38": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "python3.8" + } + }, + "python39": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "python3.9" + } + }, + "dotnetcore10": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dotnetcore1.0" + } + }, + "dotnetcore20": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dotnetcore2.0" + } + }, + "dotnetcore21": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dotnetcore2.1" + } + }, + "dotnetcore31": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dotnetcore3.1" + } + }, + "dotnet6": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dotnet6" + } + }, + "dotnet8": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dotnet8" + } + }, + "nodejs43edge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nodejs4.3-edge" + } + }, + "go1x": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "go1.x" + } + }, + "ruby25": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ruby2.5" + } + }, + "ruby27": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ruby2.7" + } + }, + "provided": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "provided" + } + }, + "providedal2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "provided.al2" + } + }, + "nodejs18x": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nodejs18.x" + } + }, + "python310": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "python3.10" + } + }, + "java17": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "java17" + } + }, + "ruby32": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ruby3.2" + } + }, + "ruby33": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ruby3.3" + } + }, + "python311": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "python3.11" + } + }, + "nodejs20x": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nodejs20.x" + } + }, + "providedal2023": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "provided.al2023" + } + }, + "python312": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "python3.12" + } + }, + "java21": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "java21" + } + }, + "python313": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "python3.13" + } + }, + "nodejs22x": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nodejs22.x" + } + } + } + }, + "com.amazonaws.lambda#RuntimeVersionArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 26, + "max": 2048 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*):lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}::runtime:.+$" + } + }, + "com.amazonaws.lambda#RuntimeVersionConfig": { + "type": "structure", + "members": { + "RuntimeVersionArn": { + "target": "com.amazonaws.lambda#RuntimeVersionArn", + "traits": { + "smithy.api#documentation": "

The ARN of the runtime version you want the function to use.

" + } + }, + "Error": { + "target": "com.amazonaws.lambda#RuntimeVersionError", + "traits": { + "smithy.api#documentation": "

Error response when Lambda is unable to retrieve the runtime version for a function.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The ARN of the runtime and any errors that occured.

" + } + }, + "com.amazonaws.lambda#RuntimeVersionError": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

The error code.

" + } + }, + "Message": { + "target": "com.amazonaws.lambda#SensitiveString", + "traits": { + "smithy.api#documentation": "

The error message.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Any error returned when the runtime version information for the function could not be retrieved.

" + } + }, + "com.amazonaws.lambda#S3Bucket": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": "^[0-9A-Za-z\\.\\-_]*(?Limits the number of concurrent instances that the Amazon SQS event source can invoke.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

(Amazon SQS only) The scaling configuration for the event source. To remove the configuration, pass an empty value.

" + } + }, + "com.amazonaws.lambda#SecurityGroupId": { + "type": "string" + }, + "com.amazonaws.lambda#SecurityGroupIds": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#SecurityGroupId" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.lambda#SelfManagedEventSource": { + "type": "structure", + "members": { + "Endpoints": { + "target": "com.amazonaws.lambda#Endpoints", + "traits": { + "smithy.api#documentation": "

The list of bootstrap servers for your Kafka brokers in the following format: \"KAFKA_BOOTSTRAP_SERVERS\":\n [\"abc.xyz.com:xxxx\",\"abc2.xyz.com:xxxx\"].

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The self-managed Apache Kafka cluster for your event source.

" + } + }, + "com.amazonaws.lambda#SelfManagedKafkaEventSourceConfig": { + "type": "structure", + "members": { + "ConsumerGroupId": { + "target": "com.amazonaws.lambda#URI", + "traits": { + "smithy.api#documentation": "

The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources.\n After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see\n Customizable consumer group ID.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specific configuration settings for a self-managed Apache Kafka event source.

" + } + }, + "com.amazonaws.lambda#SensitiveString": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.lambda#ServiceException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String" + }, + "Message": { + "target": "com.amazonaws.lambda#String" + } + }, + "traits": { + "smithy.api#documentation": "

The Lambda service encountered an internal error.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.lambda#SigningProfileVersionArns": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#Arn" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.lambda#SnapStart": { + "type": "structure", + "members": { + "ApplyOn": { + "target": "com.amazonaws.lambda#SnapStartApplyOn", + "traits": { + "smithy.api#documentation": "

Set to PublishedVersions to create a snapshot of the initialized execution environment when you publish a function version.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The function's Lambda SnapStart setting. Set ApplyOn to PublishedVersions to create a\n snapshot of the initialized execution environment when you publish a function version.

" + } + }, + "com.amazonaws.lambda#SnapStartApplyOn": { + "type": "enum", + "members": { + "PublishedVersions": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PublishedVersions" + } + }, + "None": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "None" + } + } + } + }, + "com.amazonaws.lambda#SnapStartException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String" + }, + "Message": { + "target": "com.amazonaws.lambda#String" + } + }, + "traits": { + "smithy.api#documentation": "

The afterRestore()\n runtime hook encountered an error. For more information, check the Amazon CloudWatch logs.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.lambda#SnapStartNotReadyException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String" + }, + "Message": { + "target": "com.amazonaws.lambda#String" + } + }, + "traits": { + "smithy.api#documentation": "

Lambda is initializing your function. You can invoke the function when the function state becomes Active.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.lambda#SnapStartOptimizationStatus": { + "type": "enum", + "members": { + "On": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "On" + } + }, + "Off": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Off" + } + } + } + }, + "com.amazonaws.lambda#SnapStartResponse": { + "type": "structure", + "members": { + "ApplyOn": { + "target": "com.amazonaws.lambda#SnapStartApplyOn", + "traits": { + "smithy.api#documentation": "

When set to PublishedVersions, Lambda creates a snapshot of the execution environment when you publish a function version.

" + } + }, + "OptimizationStatus": { + "target": "com.amazonaws.lambda#SnapStartOptimizationStatus", + "traits": { + "smithy.api#documentation": "

When you provide a qualified Amazon Resource Name (ARN), this response element indicates whether SnapStart is activated for the specified function version.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The function's SnapStart setting.

" + } + }, + "com.amazonaws.lambda#SnapStartTimeoutException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String" + }, + "Message": { + "target": "com.amazonaws.lambda#String" + } + }, + "traits": { + "smithy.api#documentation": "

Lambda couldn't restore the snapshot within the timeout limit.

", + "smithy.api#error": "client", + "smithy.api#httpError": 408 + } + }, + "com.amazonaws.lambda#SourceAccessConfiguration": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#SourceAccessType", + "traits": { + "smithy.api#documentation": "

The type of authentication protocol, VPC components, or virtual host for your event source. For example: \"Type\":\"SASL_SCRAM_512_AUTH\".

\n
    \n
  • \n

    \n BASIC_AUTH – (Amazon MQ) The Secrets Manager secret that stores your broker credentials.

    \n
    • \n
  • \n

    \n BASIC_AUTH – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL/PLAIN authentication of your Apache Kafka brokers.

    \n
    • \n
  • \n

    \n VPC_SUBNET – (Self-managed Apache Kafka) The subnets associated with your VPC. Lambda connects to these subnets to fetch data from your self-managed Apache Kafka cluster.

    \n
    • \n
  • \n

    \n VPC_SECURITY_GROUP – (Self-managed Apache Kafka) The VPC security group used to manage access to your self-managed Apache Kafka brokers.

    \n
    • \n
  • \n

    \n SASL_SCRAM_256_AUTH – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-256 authentication of your self-managed Apache Kafka brokers.

    \n
    • \n
  • \n

    \n SASL_SCRAM_512_AUTH – (Amazon MSK, Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-512 authentication of your self-managed Apache Kafka brokers.

    \n
    • \n
  • \n

    \n VIRTUAL_HOST –- (RabbitMQ) The name of the virtual host in your RabbitMQ broker. Lambda uses this RabbitMQ host as the event source. \n This property cannot be specified in an UpdateEventSourceMapping API call.

    \n
    • \n
  • \n

    \n CLIENT_CERTIFICATE_TLS_AUTH – (Amazon MSK, self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the certificate chain (X.509 PEM), \n private key (PKCS#8 PEM), and private key password (optional) used for mutual TLS authentication of your MSK/Apache Kafka brokers.

    \n
    • \n
  • \n

    \n SERVER_ROOT_CA_CERTIFICATE – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the root CA certificate (X.509 PEM) used for TLS encryption of your Apache Kafka brokers.\n

    \n
    • \n
" + } + }, + "URI": { + "target": "com.amazonaws.lambda#URI", + "traits": { + "smithy.api#documentation": "

The value for your chosen configuration in Type. For example: \"URI\": \"arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName\".

" + } + } + }, + "traits": { + "smithy.api#documentation": "

To secure and define access to your event source, you can specify the authentication protocol, VPC components, or virtual host.

" + } + }, + "com.amazonaws.lambda#SourceAccessConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#SourceAccessConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 22 + } + } + }, + "com.amazonaws.lambda#SourceAccessType": { + "type": "enum", + "members": { + "BASIC_AUTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BASIC_AUTH" + } + }, + "VPC_SUBNET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VPC_SUBNET" + } + }, + "VPC_SECURITY_GROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VPC_SECURITY_GROUP" + } + }, + "SASL_SCRAM_512_AUTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SASL_SCRAM_512_AUTH" + } + }, + "SASL_SCRAM_256_AUTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SASL_SCRAM_256_AUTH" + } + }, + "VIRTUAL_HOST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VIRTUAL_HOST" + } + }, + "CLIENT_CERTIFICATE_TLS_AUTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLIENT_CERTIFICATE_TLS_AUTH" + } + }, + "SERVER_ROOT_CA_CERTIFICATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVER_ROOT_CA_CERTIFICATE" + } + } + } + }, + "com.amazonaws.lambda#SourceOwner": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 12 + }, + "smithy.api#pattern": "^\\d{12}$" + } + }, + "com.amazonaws.lambda#State": { + "type": "enum", + "members": { + "Pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "Active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active" + } + }, + "Inactive": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Inactive" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + } + } + }, + "com.amazonaws.lambda#StateReason": { + "type": "string" + }, + "com.amazonaws.lambda#StateReasonCode": { + "type": "enum", + "members": { + "Idle": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Idle" + } + }, + "Creating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Creating" + } + }, + "Restoring": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Restoring" + } + }, + "EniLimitExceeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EniLimitExceeded" + } + }, + "InsufficientRolePermissions": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InsufficientRolePermissions" + } + }, + "InvalidConfiguration": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidConfiguration" + } + }, + "InternalError": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InternalError" + } + }, + "SubnetOutOfIPAddresses": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SubnetOutOfIPAddresses" + } + }, + "InvalidSubnet": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidSubnet" + } + }, + "InvalidSecurityGroup": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidSecurityGroup" + } + }, + "ImageDeleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ImageDeleted" + } + }, + "ImageAccessDenied": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ImageAccessDenied" + } + }, + "InvalidImage": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidImage" + } + }, + "KMSKeyAccessDenied": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KMSKeyAccessDenied" + } + }, + "KMSKeyNotFound": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KMSKeyNotFound" + } + }, + "InvalidStateKMSKey": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidStateKMSKey" + } + }, + "DisabledKMSKey": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DisabledKMSKey" + } + }, + "EFSIOError": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EFSIOError" + } + }, + "EFSMountConnectivityError": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EFSMountConnectivityError" + } + }, + "EFSMountFailure": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EFSMountFailure" + } + }, + "EFSMountTimeout": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EFSMountTimeout" + } + }, + "InvalidRuntime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidRuntime" + } + }, + "InvalidZipFileException": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidZipFileException" + } + }, + "FunctionError": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FunctionError" + } + } + } + }, + "com.amazonaws.lambda#StatementId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^([a-zA-Z0-9-_]+)$" + } + }, + "com.amazonaws.lambda#String": { + "type": "string" + }, + "com.amazonaws.lambda#StringList": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#String" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1500 + } + } + }, + "com.amazonaws.lambda#SubnetIPAddressLimitReachedException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String" + }, + "Message": { + "target": "com.amazonaws.lambda#String" + } + }, + "traits": { + "smithy.api#documentation": "

Lambda couldn't set up VPC access for the Lambda function because one or more\n configured subnets has no available IP addresses.

", + "smithy.api#error": "server", + "smithy.api#httpError": 502 + } + }, + "com.amazonaws.lambda#SubnetId": { + "type": "string" + }, + "com.amazonaws.lambda#SubnetIds": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#SubnetId" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 16 + } + } + }, + "com.amazonaws.lambda#SystemLogLevel": { + "type": "enum", + "members": { + "Debug": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEBUG" + } + }, + "Info": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INFO" + } + }, + "Warn": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WARN" + } + } + } + }, + "com.amazonaws.lambda#TagKey": { + "type": "string" + }, + "com.amazonaws.lambda#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#TagKey" + } + }, + "com.amazonaws.lambda#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#TagResourceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds tags to a function, event source mapping, or code signing configuration.

", + "smithy.api#examples": [ + { + "title": "To add tags to an existing Lambda function", + "documentation": "The following example adds a tag with the key name DEPARTMENT and a value of 'Department A' to the specified Lambda function.", + "input": { + "Resource": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "Tags": { + "DEPARTMENT": "Department A" + } + } + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/2017-03-31/tags/{Resource}", + "code": 204 + } + } + }, + "com.amazonaws.lambda#TagResourceRequest": { + "type": "structure", + "members": { + "Resource": { + "target": "com.amazonaws.lambda#TaggableResource", + "traits": { + "smithy.api#documentation": "

The resource's Amazon Resource Name (ARN).

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.lambda#Tags", + "traits": { + "smithy.api#documentation": "

A list of tags to apply to the resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#TagValue": { + "type": "string" + }, + "com.amazonaws.lambda#TaggableResource": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*):lambda:[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:\\d{12}:(function:[a-zA-Z0-9-_]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?|code-signing-config:csc-[a-z0-9]{17}|event-source-mapping:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$" + } + }, + "com.amazonaws.lambda#Tags": { + "type": "map", + "key": { + "target": "com.amazonaws.lambda#TagKey" + }, + "value": { + "target": "com.amazonaws.lambda#TagValue" + } + }, + "com.amazonaws.lambda#TagsError": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.lambda#TagsErrorCode", + "traits": { + "smithy.api#documentation": "

The error code.

", + "smithy.api#required": {} + } + }, + "Message": { + "target": "com.amazonaws.lambda#TagsErrorMessage", + "traits": { + "smithy.api#documentation": "

The error message.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that contains details about an error related to retrieving tags.

" + } + }, + "com.amazonaws.lambda#TagsErrorCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 21 + }, + "smithy.api#pattern": "^[A-Za-z]+Exception$" + } + }, + "com.amazonaws.lambda#TagsErrorMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 84, + "max": 1000 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.lambda#ThrottleReason": { + "type": "enum", + "members": { + "ConcurrentInvocationLimitExceeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ConcurrentInvocationLimitExceeded" + } + }, + "FunctionInvocationRateLimitExceeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FunctionInvocationRateLimitExceeded" + } + }, + "ReservedFunctionConcurrentInvocationLimitExceeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ReservedFunctionConcurrentInvocationLimitExceeded" + } + }, + "ReservedFunctionInvocationRateLimitExceeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ReservedFunctionInvocationRateLimitExceeded" + } + }, + "CallerRateLimitExceeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CallerRateLimitExceeded" + } + }, + "ConcurrentSnapshotCreateLimitExceeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ConcurrentSnapshotCreateLimitExceeded" + } + } + } + }, + "com.amazonaws.lambda#Timeout": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.lambda#Timestamp": { + "type": "string" + }, + "com.amazonaws.lambda#TooManyRequestsException": { + "type": "structure", + "members": { + "retryAfterSeconds": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

The number of seconds the caller should wait before retrying.

", + "smithy.api#httpHeader": "Retry-After" + } + }, + "Type": { + "target": "com.amazonaws.lambda#String" + }, + "message": { + "target": "com.amazonaws.lambda#String" + }, + "Reason": { + "target": "com.amazonaws.lambda#ThrottleReason" + } + }, + "traits": { + "smithy.api#documentation": "

The request throughput limit was exceeded. For more information, see Lambda quotas.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.lambda#Topic": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 249 + }, + "smithy.api#pattern": "^[^.]([a-zA-Z0-9\\-_.]+)$" + } + }, + "com.amazonaws.lambda#Topics": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#Topic" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.lambda#TracingConfig": { + "type": "structure", + "members": { + "Mode": { + "target": "com.amazonaws.lambda#TracingMode", + "traits": { + "smithy.api#documentation": "

The tracing mode.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The function's X-Ray tracing configuration.\n To sample and record incoming requests, set Mode to Active.

" + } + }, + "com.amazonaws.lambda#TracingConfigResponse": { + "type": "structure", + "members": { + "Mode": { + "target": "com.amazonaws.lambda#TracingMode", + "traits": { + "smithy.api#documentation": "

The tracing mode.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The function's X-Ray tracing configuration.

" + } + }, + "com.amazonaws.lambda#TracingMode": { + "type": "enum", + "members": { + "Active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active" + } + }, + "PassThrough": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PassThrough" + } + } + } + }, + "com.amazonaws.lambda#TumblingWindowInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 900 + } + } + }, + "com.amazonaws.lambda#URI": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-\\/*:_+=.@-]*$" + } + }, + "com.amazonaws.lambda#UnqualifiedFunctionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 140 + }, + "smithy.api#pattern": "^(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)$" + } + }, + "com.amazonaws.lambda#UnreservedConcurrentExecutions": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.lambda#UnsupportedMediaTypeException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String" + }, + "message": { + "target": "com.amazonaws.lambda#String" + } + }, + "traits": { + "smithy.api#documentation": "

The content type of the Invoke request body is not JSON.

", + "smithy.api#error": "client", + "smithy.api#httpError": 415 + } + }, + "com.amazonaws.lambda#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#UntagResourceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes tags from a function, event source mapping, or code signing configuration.

", + "smithy.api#examples": [ + { + "title": "To remove tags from an existing Lambda function", + "documentation": "The following example removes the tag with the key name DEPARTMENT tag from the my-function Lambda function.", + "input": { + "Resource": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "TagKeys": [ + "DEPARTMENT" + ] + } + } + ], + "smithy.api#http": { + "method": "DELETE", + "uri": "/2017-03-31/tags/{Resource}", + "code": 204 + } + } + }, + "com.amazonaws.lambda#UntagResourceRequest": { + "type": "structure", + "members": { + "Resource": { + "target": "com.amazonaws.lambda#TaggableResource", + "traits": { + "smithy.api#documentation": "

The resource's Amazon Resource Name (ARN).

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.lambda#TagKeyList", + "traits": { + "smithy.api#documentation": "

A list of tag keys to remove from the resource.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#UpdateAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#UpdateAliasRequest" + }, + "output": { + "target": "com.amazonaws.lambda#AliasConfiguration" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#PreconditionFailedException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the configuration of a Lambda function alias.

", + "smithy.api#examples": [ + { + "title": "To update a function alias", + "documentation": "The following example updates the alias named BLUE to send 30% of traffic to version 2 and 70% to version 1.", + "input": { + "FunctionName": "my-function", + "Name": "BLUE", + "FunctionVersion": "2", + "RoutingConfig": { + "AdditionalVersionWeights": { + "1": 0.7 + } + } + }, + "output": { + "FunctionVersion": "2", + "Name": "BLUE", + "AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:BLUE", + "RevisionId": "594f41fb-xmpl-4c20-95c7-6ca5f2a92c93", + "Description": "Production environment BLUE.", + "RoutingConfig": { + "AdditionalVersionWeights": { + "1": 0.7 + } + } + } + } + ], + "smithy.api#http": { + "method": "PUT", + "uri": "/2015-03-31/functions/{FunctionName}/aliases/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.lambda#UpdateAliasRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name - MyFunction.

    \n
    • \n
  • \n

    \n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

    \n
    • \n
  • \n

    \n Partial ARN - 123456789012:function:MyFunction.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.lambda#Alias", + "traits": { + "smithy.api#documentation": "

The name of the alias.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "FunctionVersion": { + "target": "com.amazonaws.lambda#Version", + "traits": { + "smithy.api#documentation": "

The function version that the alias invokes.

" + } + }, + "Description": { + "target": "com.amazonaws.lambda#Description", + "traits": { + "smithy.api#documentation": "

A description of the alias.

" + } + }, + "RoutingConfig": { + "target": "com.amazonaws.lambda#AliasRoutingConfiguration", + "traits": { + "smithy.api#documentation": "

The routing\n configuration of the alias.

" + } + }, + "RevisionId": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

Only update the alias if the revision ID matches the ID that's specified. Use this option to avoid modifying\n an alias that has changed since you last read it.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#UpdateCodeSigningConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#UpdateCodeSigningConfigRequest" + }, + "output": { + "target": "com.amazonaws.lambda#UpdateCodeSigningConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + } + ], + "traits": { + "smithy.api#documentation": "

Update the code signing configuration. Changes to the code signing configuration take effect the next time a\n user tries to deploy a code package to the function.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/2020-04-22/code-signing-configs/{CodeSigningConfigArn}", + "code": 200 + } + } + }, + "com.amazonaws.lambda#UpdateCodeSigningConfigRequest": { + "type": "structure", + "members": { + "CodeSigningConfigArn": { + "target": "com.amazonaws.lambda#CodeSigningConfigArn", + "traits": { + "smithy.api#documentation": "

The The Amazon Resource Name (ARN) of the code signing configuration.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.lambda#Description", + "traits": { + "smithy.api#documentation": "

Descriptive name for this code signing configuration.

" + } + }, + "AllowedPublishers": { + "target": "com.amazonaws.lambda#AllowedPublishers", + "traits": { + "smithy.api#documentation": "

Signing profiles for this code signing configuration.

" + } + }, + "CodeSigningPolicies": { + "target": "com.amazonaws.lambda#CodeSigningPolicies", + "traits": { + "smithy.api#documentation": "

The code signing policy.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#UpdateCodeSigningConfigResponse": { + "type": "structure", + "members": { + "CodeSigningConfig": { + "target": "com.amazonaws.lambda#CodeSigningConfig", + "traits": { + "smithy.api#documentation": "

The code signing configuration

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lambda#UpdateEventSourceMapping": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#UpdateEventSourceMappingRequest" + }, + "output": { + "target": "com.amazonaws.lambda#EventSourceMappingConfiguration" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceInUseException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an event source mapping. You can change the function that Lambda invokes, or pause\n invocation and resume later from the same location.

\n

For details about how to configure different event sources, see the following topics.

\n \n

The following error handling options are available only for DynamoDB and Kinesis event sources:

\n
    \n
  • \n

    \n BisectBatchOnFunctionError – If the function returns an error, split the batch in two and retry.

    \n
    • \n
  • \n

    \n MaximumRecordAgeInSeconds – Discard records older than the specified age. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires

    \n
    • \n
  • \n

    \n MaximumRetryAttempts – Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.

    \n
    • \n
  • \n

    \n ParallelizationFactor – Process multiple batches from each shard concurrently.

    \n
    • \n
\n

For stream sources (DynamoDB, Kinesis, Amazon MSK, and self-managed Apache Kafka), the following option is also available:

\n
    \n
  • \n

    \n DestinationConfig – Send discarded records to an Amazon SQS queue, Amazon SNS topic, or \n Amazon S3 bucket.

    \n
    • \n
\n

For information about which configuration parameters apply to each event source, see the following topics.

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/2015-03-31/event-source-mappings/{UUID}", + "code": 202 + } + } + }, + "com.amazonaws.lambda#UpdateEventSourceMappingRequest": { + "type": "structure", + "members": { + "UUID": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

The identifier of the event source mapping.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – MyFunction.

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

    \n
    • \n
  • \n

    \n Version or Alias ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:MyFunction.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64\n characters in length.

" + } + }, + "Enabled": { + "target": "com.amazonaws.lambda#Enabled", + "traits": { + "smithy.api#documentation": "

When true, the event source mapping is active. When false, Lambda pauses polling and invocation.

\n

Default: True

" + } + }, + "BatchSize": { + "target": "com.amazonaws.lambda#BatchSize", + "traits": { + "smithy.api#documentation": "

The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation\n (6 MB).

\n
    \n
  • \n

    \n Amazon Kinesis – Default 100. Max 10,000.

    \n
    • \n
  • \n

    \n Amazon DynamoDB Streams – Default 100. Max 10,000.

    \n
    • \n
  • \n

    \n Amazon Simple Queue Service – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.

    \n
    • \n
  • \n

    \n Amazon Managed Streaming for Apache Kafka – Default 100. Max 10,000.

    \n
    • \n
  • \n

    \n Self-managed Apache Kafka – Default 100. Max 10,000.

    \n
    • \n
  • \n

    \n Amazon MQ (ActiveMQ and RabbitMQ) – Default 100. Max 10,000.

    \n
    • \n
  • \n

    \n DocumentDB – Default 100. Max 10,000.

    \n
    • \n
" + } + }, + "FilterCriteria": { + "target": "com.amazonaws.lambda#FilterCriteria", + "traits": { + "smithy.api#documentation": "

An object that defines the filter criteria that\n determine whether Lambda should process an event. For more information, see Lambda event filtering.

" + } + }, + "MaximumBatchingWindowInSeconds": { + "target": "com.amazonaws.lambda#MaximumBatchingWindowInSeconds", + "traits": { + "smithy.api#documentation": "

The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.\n You can configure MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of seconds.

\n

For Kinesis, DynamoDB, and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, the default\n batching window is 500 ms. Note that because you can only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it.\n To restore the default batching window, you must create a new event source mapping.

\n

Related setting: For Kinesis, DynamoDB, and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

" + } + }, + "DestinationConfig": { + "target": "com.amazonaws.lambda#DestinationConfig", + "traits": { + "smithy.api#documentation": "

(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Kafka only) A configuration object that specifies the destination of an event after Lambda processes it.

" + } + }, + "MaximumRecordAgeInSeconds": { + "target": "com.amazonaws.lambda#MaximumRecordAgeInSeconds", + "traits": { + "smithy.api#documentation": "

(Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is infinite (-1).

" + } + }, + "BisectBatchOnFunctionError": { + "target": "com.amazonaws.lambda#BisectBatchOnFunctionError", + "traits": { + "smithy.api#documentation": "

(Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.

" + } + }, + "MaximumRetryAttempts": { + "target": "com.amazonaws.lambda#MaximumRetryAttemptsEventSourceMapping", + "traits": { + "smithy.api#documentation": "

(Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.

" + } + }, + "ParallelizationFactor": { + "target": "com.amazonaws.lambda#ParallelizationFactor", + "traits": { + "smithy.api#documentation": "

(Kinesis and DynamoDB Streams only) The number of batches to process from each shard concurrently.

" + } + }, + "SourceAccessConfigurations": { + "target": "com.amazonaws.lambda#SourceAccessConfigurations", + "traits": { + "smithy.api#documentation": "

An array of authentication protocols or VPC components required to secure your event source.

" + } + }, + "TumblingWindowInSeconds": { + "target": "com.amazonaws.lambda#TumblingWindowInSeconds", + "traits": { + "smithy.api#documentation": "

(Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window.

" + } + }, + "FunctionResponseTypes": { + "target": "com.amazonaws.lambda#FunctionResponseTypeList", + "traits": { + "smithy.api#documentation": "

(Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.

" + } + }, + "ScalingConfig": { + "target": "com.amazonaws.lambda#ScalingConfig", + "traits": { + "smithy.api#documentation": "

(Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.

" + } + }, + "DocumentDBEventSourceConfig": { + "target": "com.amazonaws.lambda#DocumentDBEventSourceConfig", + "traits": { + "smithy.api#documentation": "

Specific configuration settings for a DocumentDB event source.

" + } + }, + "KMSKeyArn": { + "target": "com.amazonaws.lambda#KMSKeyArn", + "traits": { + "smithy.api#documentation": "

\n The ARN of the Key Management Service (KMS) customer managed key that Lambda\n uses to encrypt your function's filter criteria.\n By default, Lambda does not encrypt your filter criteria object. Specify this\n property to encrypt data using your own customer managed key.\n

" + } + }, + "MetricsConfig": { + "target": "com.amazonaws.lambda#EventSourceMappingMetricsConfig", + "traits": { + "smithy.api#documentation": "

The metrics configuration for your event source. For more information, see Event source mapping metrics.

" + } + }, + "ProvisionedPollerConfig": { + "target": "com.amazonaws.lambda#ProvisionedPollerConfig", + "traits": { + "smithy.api#documentation": "

(Amazon MSK and self-managed Apache Kafka only) The Provisioned Mode configuration for the event source.\n For more information, see Provisioned Mode.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#UpdateFunctionCode": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#UpdateFunctionCodeRequest" + }, + "output": { + "target": "com.amazonaws.lambda#FunctionConfiguration" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#CodeSigningConfigNotFoundException" + }, + { + "target": "com.amazonaws.lambda#CodeStorageExceededException" + }, + { + "target": "com.amazonaws.lambda#CodeVerificationFailedException" + }, + { + "target": "com.amazonaws.lambda#InvalidCodeSignatureException" + }, + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#PreconditionFailedException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a Lambda function's code. If code signing is enabled for the function, the code package\n must be signed by a trusted publisher. For more information, see Configuring code signing for Lambda.

\n

If the function's package type is Image, then you must specify the code package in\n ImageUri as the URI of a container image in the Amazon ECR registry.

\n

If the function's package type is Zip, then you must specify the deployment package as a .zip file\n archive. Enter the Amazon S3 bucket and key of the code .zip file location. You can also provide\n the function code inline using the ZipFile field.

\n

The code in the deployment package must be compatible with the target instruction set architecture of the\n function (x86-64 or arm64).

\n

The function's code is locked when you publish a version. You can't modify the code of a published version,\n only the unpublished version.

\n \n

For a function defined as a container image, Lambda resolves the image tag to an image digest. In\n Amazon ECR, if you update the image tag to a new image, Lambda does not automatically\n update the function.

\n ", + "smithy.api#examples": [ + { + "title": "To update a Lambda function's code", + "documentation": "The following example replaces the code of the unpublished ($LATEST) version of a function named my-function with the contents of the specified zip file in Amazon S3.", + "input": { + "FunctionName": "my-function", + "S3Bucket": "my-bucket-1xpuxmplzrlbh", + "S3Key": "function.zip" + }, + "output": { + "TracingConfig": { + "Mode": "PassThrough" + }, + "CodeSha256": "PFn4S+er27qk+UuZSTKEQfNKG/XNn7QJs90mJgq6oH8=", + "FunctionName": "my-function", + "CodeSize": 308, + "RevisionId": "873282ed-xmpl-4dc8-a069-d0c647e470c6", + "MemorySize": 128, + "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function", + "Version": "$LATEST", + "Role": "arn:aws:iam::123456789012:role/lambda-role", + "Timeout": 3, + "LastModified": "2019-08-14T22:26:11.234+0000", + "Handler": "index.handler", + "Runtime": "nodejs12.x", + "Description": "" + } + } + ], + "smithy.api#http": { + "method": "PUT", + "uri": "/2015-03-31/functions/{FunctionName}/code", + "code": 200 + } + } + }, + "com.amazonaws.lambda#UpdateFunctionCodeRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function.

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ZipFile": { + "target": "com.amazonaws.lambda#Blob", + "traits": { + "smithy.api#documentation": "

The base64-encoded contents of the deployment package. Amazon Web Services SDK and CLI clients \nhandle the encoding for you. Use only with a function defined with a .zip file archive deployment package.

" + } + }, + "S3Bucket": { + "target": "com.amazonaws.lambda#S3Bucket", + "traits": { + "smithy.api#documentation": "

An Amazon S3 bucket in the same Amazon Web Services Region as your function. The bucket can be in a different \nAmazon Web Services account. Use only with a function defined with a .zip file archive deployment package.

" + } + }, + "S3Key": { + "target": "com.amazonaws.lambda#S3Key", + "traits": { + "smithy.api#documentation": "

The Amazon S3 key of the deployment package. Use only with a function defined with a .zip file archive deployment package.

" + } + }, + "S3ObjectVersion": { + "target": "com.amazonaws.lambda#S3ObjectVersion", + "traits": { + "smithy.api#documentation": "

For versioned objects, the version of the deployment package object to use.

" + } + }, + "ImageUri": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

URI of a container image in the Amazon ECR registry. Do not use for a function defined with a .zip\n file archive.

" + } + }, + "Publish": { + "target": "com.amazonaws.lambda#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Set to true to publish a new version of the function after updating the code. This has the same effect as\n calling PublishVersion separately.

" + } + }, + "DryRun": { + "target": "com.amazonaws.lambda#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Set to true to validate the request parameters and access permissions without modifying the function\n code.

" + } + }, + "RevisionId": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

Update the function only if the revision ID matches the ID that's specified. Use this option to avoid modifying a\n function that has changed since you last read it.

" + } + }, + "Architectures": { + "target": "com.amazonaws.lambda#ArchitecturesList", + "traits": { + "smithy.api#documentation": "

The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64).\n The default value is x86_64.

" + } + }, + "SourceKMSKeyArn": { + "target": "com.amazonaws.lambda#KMSKeyArn", + "traits": { + "smithy.api#documentation": "

The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt your function's \n .zip deployment package. If you don't provide a customer managed key, Lambda uses an Amazon Web Services managed key.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#UpdateFunctionConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#UpdateFunctionConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.lambda#FunctionConfiguration" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#CodeSigningConfigNotFoundException" + }, + { + "target": "com.amazonaws.lambda#CodeVerificationFailedException" + }, + { + "target": "com.amazonaws.lambda#InvalidCodeSignatureException" + }, + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#PreconditionFailedException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Modify the version-specific settings of a Lambda function.

\n

When you update a function, Lambda provisions an instance of the function and its supporting\n resources. If your function connects to a VPC, this process can take a minute. During this time, you can't modify\n the function, but you can still invoke it. The LastUpdateStatus, LastUpdateStatusReason,\n and LastUpdateStatusReasonCode fields in the response from GetFunctionConfiguration\n indicate when the update is complete and the function is processing events with the new configuration. For more\n information, see Lambda\n function states.

\n

These settings can vary between versions of a function and are locked when you publish a version. You can't\n modify the configuration of a published version, only the unpublished version.

\n

To configure function concurrency, use PutFunctionConcurrency. To grant invoke permissions\n to an Amazon Web Services account or Amazon Web Services service, use AddPermission.

", + "smithy.api#examples": [ + { + "title": "To update a Lambda function's configuration", + "documentation": "The following example modifies the memory size to be 256 MB for the unpublished ($LATEST) version of a function named my-function.", + "input": { + "FunctionName": "my-function", + "MemorySize": 256 + }, + "output": { + "TracingConfig": { + "Mode": "PassThrough" + }, + "CodeSha256": "PFn4S+er27qk+UuZSTKEQfNKG/XNn7QJs90mJgq6oH8=", + "FunctionName": "my-function", + "CodeSize": 308, + "RevisionId": "873282ed-xmpl-4dc8-a069-d0c647e470c6", + "MemorySize": 256, + "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function", + "Version": "$LATEST", + "Role": "arn:aws:iam::123456789012:role/lambda-role", + "Timeout": 3, + "LastModified": "2019-08-14T22:26:11.234+0000", + "Handler": "index.handler", + "Runtime": "nodejs12.x", + "Description": "" + } + } + ], + "smithy.api#http": { + "method": "PUT", + "uri": "/2015-03-31/functions/{FunctionName}/configuration", + "code": 200 + } + } + }, + "com.amazonaws.lambda#UpdateFunctionConfigurationRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function.

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Role": { + "target": "com.amazonaws.lambda#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the function's execution role.

" + } + }, + "Handler": { + "target": "com.amazonaws.lambda#Handler", + "traits": { + "smithy.api#documentation": "

The name of the method within your code that Lambda calls to run your function. \nHandler is required if the deployment package is a .zip file archive. The format includes the\n file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information,\n see Lambda programming model.

" + } + }, + "Description": { + "target": "com.amazonaws.lambda#Description", + "traits": { + "smithy.api#documentation": "

A description of the function.

" + } + }, + "Timeout": { + "target": "com.amazonaws.lambda#Timeout", + "traits": { + "smithy.api#documentation": "

The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The\n maximum allowed value is 900 seconds. For more information, see Lambda execution environment.

" + } + }, + "MemorySize": { + "target": "com.amazonaws.lambda#MemorySize", + "traits": { + "smithy.api#documentation": "

The amount of memory available to the function at runtime.\n Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB.

" + } + }, + "VpcConfig": { + "target": "com.amazonaws.lambda#VpcConfig", + "traits": { + "smithy.api#documentation": "

For network connectivity to Amazon Web Services resources in a VPC, specify a list of security groups and subnets in the VPC.\n When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more\n information, see Configuring a Lambda function to access resources in a VPC.

" + } + }, + "Environment": { + "target": "com.amazonaws.lambda#Environment", + "traits": { + "smithy.api#documentation": "

Environment variables that are accessible from function code during execution.

" + } + }, + "Runtime": { + "target": "com.amazonaws.lambda#Runtime", + "traits": { + "smithy.api#documentation": "

The identifier of the function's \n runtime. Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in\n an error if you're deploying a function using a container image.

\n

The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing\n functions shortly after each runtime is deprecated. For more information, see\n Runtime use after deprecation.

\n

For a list of all currently supported runtimes, see\n Supported runtimes.

" + } + }, + "DeadLetterConfig": { + "target": "com.amazonaws.lambda#DeadLetterConfig", + "traits": { + "smithy.api#documentation": "

A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events\n when they fail processing. For more information, see Dead-letter queues.

" + } + }, + "KMSKeyArn": { + "target": "com.amazonaws.lambda#KMSKeyArn", + "traits": { + "smithy.api#documentation": "

The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt the following resources:

\n
    \n
  • \n

    The function's environment variables.

    \n
    • \n
  • \n

    The function's Lambda SnapStart snapshots.

    \n
    • \n
  • \n

    When used with SourceKMSKeyArn, the unzipped version of the .zip deployment package that's used for function invocations. For more information, see \nSpecifying a customer managed key for Lambda.

    \n
    • \n
  • \n

    The optimized version of the container image that's used for function invocations. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). For more information, see Function lifecycle.

    \n
    • \n
\n

If you don't provide a customer managed key, Lambda uses an Amazon Web Services owned key or an Amazon Web Services managed key.

" + } + }, + "TracingConfig": { + "target": "com.amazonaws.lambda#TracingConfig", + "traits": { + "smithy.api#documentation": "

Set Mode to Active to sample and trace a subset of incoming requests with\nX-Ray.

" + } + }, + "RevisionId": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

Update the function only if the revision ID matches the ID that's specified. Use this option to avoid modifying a\n function that has changed since you last read it.

" + } + }, + "Layers": { + "target": "com.amazonaws.lambda#LayerList", + "traits": { + "smithy.api#documentation": "

A list of function layers\n to add to the function's execution environment. Specify each layer by its ARN, including the version.

" + } + }, + "FileSystemConfigs": { + "target": "com.amazonaws.lambda#FileSystemConfigList", + "traits": { + "smithy.api#documentation": "

Connection settings for an Amazon EFS file system.

" + } + }, + "ImageConfig": { + "target": "com.amazonaws.lambda#ImageConfig", + "traits": { + "smithy.api#documentation": "

\n Container image configuration\n values that override the values in the container image Docker file.

" + } + }, + "EphemeralStorage": { + "target": "com.amazonaws.lambda#EphemeralStorage", + "traits": { + "smithy.api#documentation": "

The size of the function's /tmp directory in MB. The default value is 512, but can be any whole\n number between 512 and 10,240 MB. For more information, see Configuring ephemeral storage (console).

" + } + }, + "SnapStart": { + "target": "com.amazonaws.lambda#SnapStart", + "traits": { + "smithy.api#documentation": "

The function's SnapStart setting.

" + } + }, + "LoggingConfig": { + "target": "com.amazonaws.lambda#LoggingConfig", + "traits": { + "smithy.api#documentation": "

The function's Amazon CloudWatch Logs configuration settings.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#UpdateFunctionEventInvokeConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#UpdateFunctionEventInvokeConfigRequest" + }, + "output": { + "target": "com.amazonaws.lambda#FunctionEventInvokeConfig" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the configuration for asynchronous invocation for a function, version, or alias.

\n

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

", + "smithy.api#examples": [ + { + "title": "To update an asynchronous invocation configuration", + "documentation": "The following example adds an on-failure destination to the existing asynchronous invocation configuration for a function named my-function.", + "input": { + "FunctionName": "my-function", + "DestinationConfig": { + "OnFailure": { + "Destination": "arn:aws:sqs:us-east-2:123456789012:destination" + } + } + }, + "output": { + "LastModified": 1.573687896493E9, + "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:$LATEST", + "MaximumRetryAttempts": 0, + "MaximumEventAgeInSeconds": 3600, + "DestinationConfig": { + "OnSuccess": {}, + "OnFailure": { + "Destination": "arn:aws:sqs:us-east-2:123456789012:destination" + } + } + } + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/2019-09-25/functions/{FunctionName}/event-invoke-config", + "code": 200 + } + } + }, + "com.amazonaws.lambda#UpdateFunctionEventInvokeConfigRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "

The name or ARN of the Lambda function, version, or alias.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name - my-function (name-only), my-function:v1 (with alias).

    \n
    • \n
  • \n

    \n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN - 123456789012:function:my-function.

    \n
    • \n
\n

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\n If you specify only the function name, it is limited to 64 characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#Qualifier", + "traits": { + "smithy.api#documentation": "

A version number or alias name.

", + "smithy.api#httpQuery": "Qualifier" + } + }, + "MaximumRetryAttempts": { + "target": "com.amazonaws.lambda#MaximumRetryAttempts", + "traits": { + "smithy.api#documentation": "

The maximum number of times to retry when the function returns an error.

" + } + }, + "MaximumEventAgeInSeconds": { + "target": "com.amazonaws.lambda#MaximumEventAgeInSeconds", + "traits": { + "smithy.api#documentation": "

The maximum age of a request that Lambda sends to a function for processing.

" + } + }, + "DestinationConfig": { + "target": "com.amazonaws.lambda#DestinationConfig", + "traits": { + "smithy.api#documentation": "

A destination for events after they have been sent to a function for processing.

\n

\n Destinations\n

\n
    \n
  • \n

    \n Function - The Amazon Resource Name (ARN) of a Lambda function.

    \n
    • \n
  • \n

    \n Queue - The ARN of a standard SQS queue.

    \n
    • \n
  • \n

    \n Bucket - The ARN of an Amazon S3 bucket.

    \n
    • \n
  • \n

    \n Topic - The ARN of a standard SNS topic.

    \n
    • \n
  • \n

    \n Event Bus - The ARN of an Amazon EventBridge event bus.

    \n
    • \n
\n \n

S3 buckets are supported only for on-failure destinations. To retain records of successful invocations, use another destination type.

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#UpdateFunctionUrlConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#UpdateFunctionUrlConfigRequest" + }, + "output": { + "target": "com.amazonaws.lambda#UpdateFunctionUrlConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the configuration for a Lambda function URL.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/2021-10-31/functions/{FunctionName}/url", + "code": 200 + } + } + }, + "com.amazonaws.lambda#UpdateFunctionUrlConfigRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function.

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#FunctionUrlQualifier", + "traits": { + "smithy.api#documentation": "

The alias name.

", + "smithy.api#httpQuery": "Qualifier" + } + }, + "AuthType": { + "target": "com.amazonaws.lambda#FunctionUrlAuthType", + "traits": { + "smithy.api#documentation": "

The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated\n users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information,\n see Security and auth model for Lambda function URLs.

" + } + }, + "Cors": { + "target": "com.amazonaws.lambda#Cors", + "traits": { + "smithy.api#documentation": "

The cross-origin resource sharing (CORS) settings\n for your function URL.

" + } + }, + "InvokeMode": { + "target": "com.amazonaws.lambda#InvokeMode", + "traits": { + "smithy.api#documentation": "

Use one of the following options:

\n
    \n
  • \n

    \n BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results \n are available when the payload is complete. The maximum payload size is 6 MB.

    \n
    • \n
  • \n

    \n RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using \n the InvokeWithResponseStream API operation. The maximum response payload size is 20 MB, however, you can request a quota increase.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lambda#UpdateFunctionUrlConfigResponse": { + "type": "structure", + "members": { + "FunctionUrl": { + "target": "com.amazonaws.lambda#FunctionUrl", + "traits": { + "smithy.api#documentation": "

The HTTP URL endpoint for your function.

", + "smithy.api#required": {} + } + }, + "FunctionArn": { + "target": "com.amazonaws.lambda#FunctionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of your function.

", + "smithy.api#required": {} + } + }, + "AuthType": { + "target": "com.amazonaws.lambda#FunctionUrlAuthType", + "traits": { + "smithy.api#documentation": "

The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated\n users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information,\n see Security and auth model for Lambda function URLs.

", + "smithy.api#required": {} + } + }, + "Cors": { + "target": "com.amazonaws.lambda#Cors", + "traits": { + "smithy.api#documentation": "

The cross-origin resource sharing (CORS) settings\n for your function URL.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.lambda#Timestamp", + "traits": { + "smithy.api#documentation": "

When the function URL was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.lambda#Timestamp", + "traits": { + "smithy.api#documentation": "

When the function URL configuration was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

", + "smithy.api#required": {} + } + }, + "InvokeMode": { + "target": "com.amazonaws.lambda#InvokeMode", + "traits": { + "smithy.api#documentation": "

Use one of the following options:

\n
    \n
  • \n

    \n BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results \n are available when the payload is complete. The maximum payload size is 6 MB.

    \n
    • \n
  • \n

    \n RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using \n the InvokeWithResponseStream API operation. The maximum response payload size is 20 MB, however, you can request a quota increase.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lambda#UpdateRuntimeOn": { + "type": "enum", + "members": { + "Auto": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Auto" + } + }, + "Manual": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Manual" + } + }, + "FunctionUpdate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FunctionUpdate" + } + } + } + }, + "com.amazonaws.lambda#Version": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^(\\$LATEST|[0-9]+)$" + } + }, + "com.amazonaws.lambda#VpcConfig": { + "type": "structure", + "members": { + "SubnetIds": { + "target": "com.amazonaws.lambda#SubnetIds", + "traits": { + "smithy.api#documentation": "

A list of VPC subnet IDs.

" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.lambda#SecurityGroupIds", + "traits": { + "smithy.api#documentation": "

A list of VPC security group IDs.

" + } + }, + "Ipv6AllowedForDualStack": { + "target": "com.amazonaws.lambda#NullableBoolean", + "traits": { + "smithy.api#documentation": "

Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The VPC security groups and subnets that are attached to a Lambda function. For more information,\n see Configuring a Lambda\n function to access resources in a VPC.

" + } + }, + "com.amazonaws.lambda#VpcConfigResponse": { + "type": "structure", + "members": { + "SubnetIds": { + "target": "com.amazonaws.lambda#SubnetIds", + "traits": { + "smithy.api#documentation": "

A list of VPC subnet IDs.

" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.lambda#SecurityGroupIds", + "traits": { + "smithy.api#documentation": "

A list of VPC security group IDs.

" + } + }, + "VpcId": { + "target": "com.amazonaws.lambda#VpcId", + "traits": { + "smithy.api#documentation": "

The ID of the VPC.

" + } + }, + "Ipv6AllowedForDualStack": { + "target": "com.amazonaws.lambda#NullableBoolean", + "traits": { + "smithy.api#documentation": "

Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The VPC security groups and subnets that are attached to a Lambda function.

" + } + }, + "com.amazonaws.lambda#VpcId": { + "type": "string" + }, + "com.amazonaws.lambda#Weight": { + "type": "double", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0.0, + "max": 1.0 + } + } + }, + "com.amazonaws.lambda#WorkingDirectory": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + } + } + } + } +} \ No newline at end of file diff --git a/pkg/testdata/codegen/sdk-codegen/aws-models/memorydb.json b/pkg/testdata/codegen/sdk-codegen/aws-models/memorydb.json new file mode 100644 index 00000000..c879ccaf --- /dev/null +++ b/pkg/testdata/codegen/sdk-codegen/aws-models/memorydb.json @@ -0,0 +1,7608 @@ +{ + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.memorydb#ACL": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the Access Control List

" + } + }, + "Status": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

Indicates ACL status. Can be \"creating\", \"active\", \"modifying\", \"deleting\".

" + } + }, + "UserNames": { + "target": "com.amazonaws.memorydb#UserNameList", + "traits": { + "smithy.api#documentation": "

The list of user names that belong to the ACL.

" + } + }, + "MinimumEngineVersion": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The minimum engine version supported for the ACL

" + } + }, + "PendingChanges": { + "target": "com.amazonaws.memorydb#ACLPendingChanges", + "traits": { + "smithy.api#documentation": "

A list of updates being applied to the ACL.

" + } + }, + "Clusters": { + "target": "com.amazonaws.memorydb#ACLClusterNameList", + "traits": { + "smithy.api#documentation": "

A list of clusters associated with the ACL.

" + } + }, + "ARN": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the ACL

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An Access Control List. You can authenticate users with Access Contol Lists.\n \n ACLs enable you to control cluster access by grouping users. These Access control lists are designed as a way to organize access to clusters.

" + } + }, + "com.amazonaws.memorydb#ACLAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ACLAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#ACLClusterNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#String" + } + }, + "com.amazonaws.memorydb#ACLList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#ACL" + } + }, + "com.amazonaws.memorydb#ACLName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9\\-]*$" + } + }, + "com.amazonaws.memorydb#ACLNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#ACLName" + } + }, + "com.amazonaws.memorydb#ACLNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ACLNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.memorydb#ACLPendingChanges": { + "type": "structure", + "members": { + "UserNamesToRemove": { + "target": "com.amazonaws.memorydb#UserNameList", + "traits": { + "smithy.api#documentation": "

A list of user names being removed from the ACL

" + } + }, + "UserNamesToAdd": { + "target": "com.amazonaws.memorydb#UserNameList", + "traits": { + "smithy.api#documentation": "

A list of users being added to the ACL

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Returns the updates being applied to the ACL.

" + } + }, + "com.amazonaws.memorydb#ACLQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ACLQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#ACLsUpdateStatus": { + "type": "structure", + "members": { + "ACLToApply": { + "target": "com.amazonaws.memorydb#ACLName", + "traits": { + "smithy.api#documentation": "

A list of ACLs pending to be applied.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The status of the ACL update

" + } + }, + "com.amazonaws.memorydb#APICallRateForCustomerExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "APICallRateForCustomerExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#AZStatus": { + "type": "enum", + "members": { + "SingleAZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "singleaz" + } + }, + "MultiAZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "multiaz" + } + } + } + }, + "com.amazonaws.memorydb#AccessString": { + "type": "string", + "traits": { + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.memorydb#AmazonMemoryDB": { + "type": "service", + "version": "2021-01-01", + "operations": [ + { + "target": "com.amazonaws.memorydb#BatchUpdateCluster" + }, + { + "target": "com.amazonaws.memorydb#CopySnapshot" + }, + { + "target": "com.amazonaws.memorydb#CreateACL" + }, + { + "target": "com.amazonaws.memorydb#CreateCluster" + }, + { + "target": "com.amazonaws.memorydb#CreateMultiRegionCluster" + }, + { + "target": "com.amazonaws.memorydb#CreateParameterGroup" + }, + { + "target": "com.amazonaws.memorydb#CreateSnapshot" + }, + { + "target": "com.amazonaws.memorydb#CreateSubnetGroup" + }, + { + "target": "com.amazonaws.memorydb#CreateUser" + }, + { + "target": "com.amazonaws.memorydb#DeleteACL" + }, + { + "target": "com.amazonaws.memorydb#DeleteCluster" + }, + { + "target": "com.amazonaws.memorydb#DeleteMultiRegionCluster" + }, + { + "target": "com.amazonaws.memorydb#DeleteParameterGroup" + }, + { + "target": "com.amazonaws.memorydb#DeleteSnapshot" + }, + { + "target": "com.amazonaws.memorydb#DeleteSubnetGroup" + }, + { + "target": "com.amazonaws.memorydb#DeleteUser" + }, + { + "target": "com.amazonaws.memorydb#DescribeACLs" + }, + { + "target": "com.amazonaws.memorydb#DescribeClusters" + }, + { + "target": "com.amazonaws.memorydb#DescribeEngineVersions" + }, + { + "target": "com.amazonaws.memorydb#DescribeEvents" + }, + { + "target": "com.amazonaws.memorydb#DescribeMultiRegionClusters" + }, + { + "target": "com.amazonaws.memorydb#DescribeParameterGroups" + }, + { + "target": "com.amazonaws.memorydb#DescribeParameters" + }, + { + "target": "com.amazonaws.memorydb#DescribeReservedNodes" + }, + { + "target": "com.amazonaws.memorydb#DescribeReservedNodesOfferings" + }, + { + "target": "com.amazonaws.memorydb#DescribeServiceUpdates" + }, + { + "target": "com.amazonaws.memorydb#DescribeSnapshots" + }, + { + "target": "com.amazonaws.memorydb#DescribeSubnetGroups" + }, + { + "target": "com.amazonaws.memorydb#DescribeUsers" + }, + { + "target": "com.amazonaws.memorydb#FailoverShard" + }, + { + "target": "com.amazonaws.memorydb#ListAllowedMultiRegionClusterUpdates" + }, + { + "target": "com.amazonaws.memorydb#ListAllowedNodeTypeUpdates" + }, + { + "target": "com.amazonaws.memorydb#ListTags" + }, + { + "target": "com.amazonaws.memorydb#PurchaseReservedNodesOffering" + }, + { + "target": "com.amazonaws.memorydb#ResetParameterGroup" + }, + { + "target": "com.amazonaws.memorydb#TagResource" + }, + { + "target": "com.amazonaws.memorydb#UntagResource" + }, + { + "target": "com.amazonaws.memorydb#UpdateACL" + }, + { + "target": "com.amazonaws.memorydb#UpdateCluster" + }, + { + "target": "com.amazonaws.memorydb#UpdateMultiRegionCluster" + }, + { + "target": "com.amazonaws.memorydb#UpdateParameterGroup" + }, + { + "target": "com.amazonaws.memorydb#UpdateSubnetGroup" + }, + { + "target": "com.amazonaws.memorydb#UpdateUser" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "MemoryDB", + "arnNamespace": "memorydb", + "cloudFormationName": "MemoryDB", + "cloudTrailEventSource": "memorydb.amazonaws.com", + "endpointPrefix": "memory-db" + }, + "aws.auth#sigv4": { + "name": "memorydb" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "

MemoryDB is a fully managed, Redis OSS-compatible, in-memory database that delivers ultra-fast performance and Multi-AZ durability for modern applications built using microservices architectures.\n \n MemoryDB stores the entire database in-memory, enabling low latency and high throughput data access. It is compatible with Redis OSS, a popular open source data store, enabling you to leverage Redis OSS’ flexible and friendly data structures, APIs, and commands.

", + "smithy.api#title": "Amazon MemoryDB", + "smithy.api#xmlNamespace": { + "uri": "http://memorydb.amazonaws.com/doc/2021-01-01/" + }, + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://memory-db-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://memory-db-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://memory-db.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "fips" + ] + } + ], + "endpoint": { + "url": "https://memory-db-fips.us-west-1.amazonaws.com", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "memorydb", + "signingRegion": "us-west-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://memory-db.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://memory-db.ap-east-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://memory-db.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://memory-db.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://memory-db.ap-south-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://memory-db.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://memory-db.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://memory-db.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://memory-db.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://memory-db.eu-north-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://memory-db.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://memory-db.eu-west-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region fips with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "memorydb", + "signingRegion": "us-west-1" + } + ] + }, + "url": "https://memory-db-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "fips", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://memory-db.sa-east-1.amazonaws.com" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://memory-db.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://memory-db.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://memory-db.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://memory-db.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://memory-db-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://memory-db-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://memory-db.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://memory-db.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://memory-db.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://memory-db-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://memory-db-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://memory-db.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://memory-db-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://memory-db-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://memory-db.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://memory-db.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://memory-db-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://memory-db.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://memory-db-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://memory-db.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.memorydb#Authentication": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.memorydb#AuthenticationType", + "traits": { + "smithy.api#documentation": "

Indicates whether the user requires a password to authenticate.

" + } + }, + "PasswordCount": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of passwords belonging to the user. The maximum is two.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Denotes the user's authentication properties, such as whether it requires a password to authenticate. Used in output responses.

" + } + }, + "com.amazonaws.memorydb#AuthenticationMode": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.memorydb#InputAuthenticationType", + "traits": { + "smithy.api#documentation": "

Indicates whether the user requires a password to authenticate. All newly-created users require a password.

" + } + }, + "Passwords": { + "target": "com.amazonaws.memorydb#PasswordListInput", + "traits": { + "smithy.api#documentation": "

The password(s) used for authentication

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Denotes the user's authentication properties, such as whether it requires a password to authenticate. Used in output responses.

" + } + }, + "com.amazonaws.memorydb#AuthenticationType": { + "type": "enum", + "members": { + "PASSWORD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "password" + } + }, + "NO_PASSWORD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "no-password" + } + }, + "IAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "iam" + } + } + } + }, + "com.amazonaws.memorydb#AvailabilityZone": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the Availability Zone.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).

" + } + }, + "com.amazonaws.memorydb#AwsQueryErrorMessage": { + "type": "string" + }, + "com.amazonaws.memorydb#BatchUpdateCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#BatchUpdateClusterRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#BatchUpdateClusterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#ServiceUpdateNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Apply the service update to a list of clusters supplied. For more information on service updates and applying them, see Applying the service updates.

" + } + }, + "com.amazonaws.memorydb#BatchUpdateClusterRequest": { + "type": "structure", + "members": { + "ClusterNames": { + "target": "com.amazonaws.memorydb#ClusterNameList", + "traits": { + "smithy.api#documentation": "

The cluster names to apply the updates.

", + "smithy.api#required": {} + } + }, + "ServiceUpdate": { + "target": "com.amazonaws.memorydb#ServiceUpdateRequest", + "traits": { + "smithy.api#documentation": "

The unique ID of the service update

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.memorydb#BatchUpdateClusterResponse": { + "type": "structure", + "members": { + "ProcessedClusters": { + "target": "com.amazonaws.memorydb#ClusterList", + "traits": { + "smithy.api#documentation": "

The list of clusters that have been updated.

" + } + }, + "UnprocessedClusters": { + "target": "com.amazonaws.memorydb#UnprocessedClusterList", + "traits": { + "smithy.api#documentation": "

The list of clusters where updates have not been applied.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.memorydb#Boolean": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.memorydb#BooleanOptional": { + "type": "boolean" + }, + "com.amazonaws.memorydb#Cluster": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The user-supplied name of the cluster. This identifier is a unique key that identifies a cluster.

" + } + }, + "Description": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

A description of the cluster

" + } + }, + "Status": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The status of the cluster. For example, Available, Updating, Creating.

" + } + }, + "PendingUpdates": { + "target": "com.amazonaws.memorydb#ClusterPendingUpdates", + "traits": { + "smithy.api#documentation": "

A group of settings that are currently being applied.

" + } + }, + "MultiRegionClusterName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the multi-Region cluster that this cluster belongs to.

" + } + }, + "NumberOfShards": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of shards in the cluster

" + } + }, + "Shards": { + "target": "com.amazonaws.memorydb#ShardList", + "traits": { + "smithy.api#documentation": "

A list of shards that are members of the cluster.

" + } + }, + "AvailabilityMode": { + "target": "com.amazonaws.memorydb#AZStatus", + "traits": { + "smithy.api#documentation": "

Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).

" + } + }, + "ClusterEndpoint": { + "target": "com.amazonaws.memorydb#Endpoint", + "traits": { + "smithy.api#documentation": "

The cluster's configuration endpoint

" + } + }, + "NodeType": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The cluster's node type

" + } + }, + "Engine": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the engine used by the cluster.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The Redis OSS engine version used by the cluster

" + } + }, + "EnginePatchVersion": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The Redis OSS engine patch version used by the cluster

" + } + }, + "ParameterGroupName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the parameter group used by the cluster

" + } + }, + "ParameterGroupStatus": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The status of the parameter group used by the cluster, for example 'active' or 'applying'.

" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.memorydb#SecurityGroupMembershipList", + "traits": { + "smithy.api#documentation": "

A list of security groups used by the cluster

" + } + }, + "SubnetGroupName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the subnet group used by the cluster

" + } + }, + "TLSEnabled": { + "target": "com.amazonaws.memorydb#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A flag to indicate if In-transit encryption is enabled

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The ID of the KMS key used to encrypt the cluster

" + } + }, + "ARN": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

" + } + }, + "SnsTopicArn": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SNS notification topic

" + } + }, + "SnsTopicStatus": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The SNS topic must be in Active status to receive notifications

" + } + }, + "SnapshotRetentionLimit": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

" + } + }, + "MaintenanceWindow": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

" + } + }, + "SnapshotWindow": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.\n \n Example: 05:00-09:00\n \n If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.

" + } + }, + "ACLName": { + "target": "com.amazonaws.memorydb#ACLName", + "traits": { + "smithy.api#documentation": "

The name of the Access Control List associated with this cluster.

" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.memorydb#BooleanOptional", + "traits": { + "smithy.api#documentation": "

When set to true, the cluster will automatically receive minor engine version upgrades after launch.

" + } + }, + "DataTiering": { + "target": "com.amazonaws.memorydb#DataTieringStatus", + "traits": { + "smithy.api#documentation": "

Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. \n This parameter must be set when using r6gd nodes. For more information, see Data tiering.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains all of the attributes of a specific cluster.

" + } + }, + "com.amazonaws.memorydb#ClusterAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ClusterAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#ClusterConfiguration": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the cluster

" + } + }, + "Description": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The description of the cluster configuration

" + } + }, + "NodeType": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The node type used for the cluster

" + } + }, + "Engine": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the engine used by the cluster configuration.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The Redis OSS engine version used by the cluster

" + } + }, + "MaintenanceWindow": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The specified maintenance window for the cluster

" + } + }, + "TopicArn": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SNS notification topic for the cluster

" + } + }, + "Port": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port used by the cluster

" + } + }, + "ParameterGroupName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of parameter group used by the cluster

" + } + }, + "SubnetGroupName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the subnet group used by the cluster

" + } + }, + "VpcId": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The ID of the VPC the cluster belongs to

" + } + }, + "SnapshotRetentionLimit": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The snapshot retention limit set by the cluster

" + } + }, + "SnapshotWindow": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The snapshot window set by the cluster

" + } + }, + "NumShards": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of shards in the cluster

" + } + }, + "Shards": { + "target": "com.amazonaws.memorydb#ShardDetails", + "traits": { + "smithy.api#documentation": "

The list of shards in the cluster

" + } + }, + "MultiRegionParameterGroupName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the multi-Region parameter group associated with the cluster configuration.

" + } + }, + "MultiRegionClusterName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name for the multi-Region cluster associated with the cluster configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of cluster configuration options.

" + } + }, + "com.amazonaws.memorydb#ClusterList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#Cluster", + "traits": { + "smithy.api#xmlName": "Cluster" + } + } + }, + "com.amazonaws.memorydb#ClusterNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#String" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.memorydb#ClusterNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ClusterNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.memorydb#ClusterPendingUpdates": { + "type": "structure", + "members": { + "Resharding": { + "target": "com.amazonaws.memorydb#ReshardingStatus", + "traits": { + "smithy.api#documentation": "

The status of an online resharding operation.

" + } + }, + "ACLs": { + "target": "com.amazonaws.memorydb#ACLsUpdateStatus", + "traits": { + "smithy.api#documentation": "

A list of ACLs associated with the cluster that are being updated

" + } + }, + "ServiceUpdates": { + "target": "com.amazonaws.memorydb#PendingModifiedServiceUpdateList", + "traits": { + "smithy.api#documentation": "

A list of service updates being applied to the cluster

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of updates being applied to the cluster

" + } + }, + "com.amazonaws.memorydb#ClusterQuotaForCustomerExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ClusterQuotaForCustomerExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#CopySnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#CopySnapshotRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#CopySnapshotResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#InvalidSnapshotStateFault" + }, + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#SnapshotAlreadyExistsFault" + }, + { + "target": "com.amazonaws.memorydb#SnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#SnapshotQuotaExceededFault" + }, + { + "target": "com.amazonaws.memorydb#TagQuotaPerResourceExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Makes a copy of an existing snapshot.

" + } + }, + "com.amazonaws.memorydb#CopySnapshotRequest": { + "type": "structure", + "members": { + "SourceSnapshotName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of an existing snapshot from which to make a copy.

", + "smithy.api#required": {} + } + }, + "TargetSnapshotName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

A name for the snapshot copy. MemoryDB does not permit overwriting a snapshot, therefore this name must be unique within its context - MemoryDB or an Amazon S3 bucket if exporting.

", + "smithy.api#required": {} + } + }, + "TargetBucket": { + "target": "com.amazonaws.memorydb#TargetBucket", + "traits": { + "smithy.api#documentation": "

The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access.\n \n When using this parameter to export a snapshot, be sure MemoryDB has the needed permissions to this S3 bucket. For more information, see \n \n Step 2: Grant MemoryDB Access to Your Amazon S3 Bucket. \n \n

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.memorydb#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The ID of the KMS key used to encrypt the target snapshot.

" + } + }, + "Tags": { + "target": "com.amazonaws.memorydb#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.memorydb#CopySnapshotResponse": { + "type": "structure", + "members": { + "Snapshot": { + "target": "com.amazonaws.memorydb#Snapshot", + "traits": { + "smithy.api#documentation": "

Represents a copy of an entire cluster as of the time when the snapshot was taken.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.memorydb#CreateACL": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#CreateACLRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#CreateACLResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#ACLAlreadyExistsFault" + }, + { + "target": "com.amazonaws.memorydb#ACLQuotaExceededFault" + }, + { + "target": "com.amazonaws.memorydb#DefaultUserRequired" + }, + { + "target": "com.amazonaws.memorydb#DuplicateUserNameFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#TagQuotaPerResourceExceeded" + }, + { + "target": "com.amazonaws.memorydb#UserNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an Access Control List. For more information, see Authenticating users with Access Contol Lists (ACLs).

" + } + }, + "com.amazonaws.memorydb#CreateACLRequest": { + "type": "structure", + "members": { + "ACLName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the Access Control List.

", + "smithy.api#required": {} + } + }, + "UserNames": { + "target": "com.amazonaws.memorydb#UserNameListInput", + "traits": { + "smithy.api#documentation": "

The list of users that belong to the Access Control List.

" + } + }, + "Tags": { + "target": "com.amazonaws.memorydb#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.memorydb#CreateACLResponse": { + "type": "structure", + "members": { + "ACL": { + "target": "com.amazonaws.memorydb#ACL", + "traits": { + "smithy.api#documentation": "

The newly-created Access Control List.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.memorydb#CreateCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#CreateClusterRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#CreateClusterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#ACLNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#ClusterAlreadyExistsFault" + }, + { + "target": "com.amazonaws.memorydb#ClusterQuotaForCustomerExceededFault" + }, + { + "target": "com.amazonaws.memorydb#InsufficientClusterCapacityFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidACLStateFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidCredentialsException" + }, + { + "target": "com.amazonaws.memorydb#InvalidMultiRegionClusterStateFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#InvalidVPCNetworkStateFault" + }, + { + "target": "com.amazonaws.memorydb#MultiRegionClusterNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#NodeQuotaForClusterExceededFault" + }, + { + "target": "com.amazonaws.memorydb#NodeQuotaForCustomerExceededFault" + }, + { + "target": "com.amazonaws.memorydb#ParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#ShardsPerClusterQuotaExceededFault" + }, + { + "target": "com.amazonaws.memorydb#SubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#TagQuotaPerResourceExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a cluster. All nodes in the cluster run the same protocol-compliant engine software.

" + } + }, + "com.amazonaws.memorydb#CreateClusterRequest": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the cluster. This value must be unique as it also serves as the cluster identifier.

", + "smithy.api#required": {} + } + }, + "NodeType": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The compute and memory capacity of the nodes in the cluster.

", + "smithy.api#required": {} + } + }, + "MultiRegionClusterName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the multi-Region cluster to be created.

" + } + }, + "ParameterGroupName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the parameter group associated with the cluster.

" + } + }, + "Description": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

An optional description of the cluster.

" + } + }, + "NumShards": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of shards the cluster will contain. The default value is 1.

" + } + }, + "NumReplicasPerShard": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of replicas to apply to each shard. The default value is 1. The maximum is 5.

" + } + }, + "SubnetGroupName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the subnet group to be used for the cluster.

" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.memorydb#SecurityGroupIdsList", + "traits": { + "smithy.api#documentation": "

A list of security group names to associate with this cluster.

" + } + }, + "MaintenanceWindow": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

Specifies the weekly time range during which maintenance\n on the cluster is performed. It is specified as a range in\n the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum\n maintenance window is a 60 minute period.

\n

Valid values for ddd are:

\n
    \n
  • \n

    \n sun\n

    \n
    • \n
  • \n

    \n mon\n

    \n
    • \n
  • \n

    \n tue\n

    \n
    • \n
  • \n

    \n wed\n

    \n
    • \n
  • \n

    \n thu\n

    \n
    • \n
  • \n

    \n fri\n

    \n
    • \n
  • \n

    \n sat\n

    \n
    • \n
\n

Example: sun:23:00-mon:01:30\n

" + } + }, + "Port": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port number on which each of the nodes accepts connections.

" + } + }, + "SnsTopicArn": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.

" + } + }, + "TLSEnabled": { + "target": "com.amazonaws.memorydb#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A flag to enable in-transit encryption on the cluster.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The ID of the KMS key used to encrypt the cluster.

" + } + }, + "SnapshotArns": { + "target": "com.amazonaws.memorydb#SnapshotArnsList", + "traits": { + "smithy.api#documentation": "

A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new cluster. The Amazon S3 object name in the ARN cannot contain any commas.

" + } + }, + "SnapshotName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of a snapshot from which to restore data into the new cluster. The snapshot status changes to restoring while the new cluster is being created.

" + } + }, + "SnapshotRetentionLimit": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

" + } + }, + "Tags": { + "target": "com.amazonaws.memorydb#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue.

" + } + }, + "SnapshotWindow": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.

\n

Example: 05:00-09:00

\n

If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.

" + } + }, + "ACLName": { + "target": "com.amazonaws.memorydb#ACLName", + "traits": { + "smithy.api#documentation": "

The name of the Access Control List to associate with the cluster.

", + "smithy.api#required": {} + } + }, + "Engine": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the engine to be used for the cluster.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The version number of the Redis OSS engine to be used for the cluster.

" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.memorydb#BooleanOptional", + "traits": { + "smithy.api#documentation": "

When set to true, the cluster will automatically receive minor engine version upgrades after launch.

" + } + }, + "DataTiering": { + "target": "com.amazonaws.memorydb#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. \n This parameter must be set when using r6gd nodes. For more information, see Data tiering.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.memorydb#CreateClusterResponse": { + "type": "structure", + "members": { + "Cluster": { + "target": "com.amazonaws.memorydb#Cluster", + "traits": { + "smithy.api#documentation": "

The newly-created cluster.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.memorydb#CreateMultiRegionCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#CreateMultiRegionClusterRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#CreateMultiRegionClusterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#ClusterQuotaForCustomerExceededFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#MultiRegionClusterAlreadyExistsFault" + }, + { + "target": "com.amazonaws.memorydb#MultiRegionParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#TagQuotaPerResourceExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new multi-Region cluster.

" + } + }, + "com.amazonaws.memorydb#CreateMultiRegionClusterRequest": { + "type": "structure", + "members": { + "MultiRegionClusterNameSuffix": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

A suffix to be added to the multi-Region cluster name.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

A description for the multi-Region cluster.

" + } + }, + "Engine": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the engine to be used for the multi-Region cluster.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The version of the engine to be used for the multi-Region cluster.

" + } + }, + "NodeType": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The node type to be used for the multi-Region cluster.

", + "smithy.api#required": {} + } + }, + "MultiRegionParameterGroupName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the multi-Region parameter group to be associated with the cluster.

" + } + }, + "NumShards": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of shards for the multi-Region cluster.

" + } + }, + "TLSEnabled": { + "target": "com.amazonaws.memorydb#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Whether to enable TLS encryption for the multi-Region cluster.

" + } + }, + "Tags": { + "target": "com.amazonaws.memorydb#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags to be applied to the multi-Region cluster.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.memorydb#CreateMultiRegionClusterResponse": { + "type": "structure", + "members": { + "MultiRegionCluster": { + "target": "com.amazonaws.memorydb#MultiRegionCluster", + "traits": { + "smithy.api#documentation": "

Details about the newly created multi-Region cluster.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.memorydb#CreateParameterGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#CreateParameterGroupRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#CreateParameterGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterGroupStateFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#ParameterGroupAlreadyExistsFault" + }, + { + "target": "com.amazonaws.memorydb#ParameterGroupQuotaExceededFault" + }, + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#TagQuotaPerResourceExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new MemoryDB parameter group. A parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster. For \n more information, see Configuring engine parameters using parameter groups.\n \n

" + } + }, + "com.amazonaws.memorydb#CreateParameterGroupRequest": { + "type": "structure", + "members": { + "ParameterGroupName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the parameter group.

", + "smithy.api#required": {} + } + }, + "Family": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the parameter group family that the parameter group can be used with.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

An optional description of the parameter group.

" + } + }, + "Tags": { + "target": "com.amazonaws.memorydb#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.memorydb#CreateParameterGroupResponse": { + "type": "structure", + "members": { + "ParameterGroup": { + "target": "com.amazonaws.memorydb#ParameterGroup", + "traits": { + "smithy.api#documentation": "

The newly-created parameter group.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.memorydb#CreateSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#CreateSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#CreateSnapshotResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#ClusterNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidClusterStateFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#SnapshotAlreadyExistsFault" + }, + { + "target": "com.amazonaws.memorydb#SnapshotQuotaExceededFault" + }, + { + "target": "com.amazonaws.memorydb#TagQuotaPerResourceExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a copy of an entire cluster at a specific moment in time.

" + } + }, + "com.amazonaws.memorydb#CreateSnapshotRequest": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The snapshot is created from this cluster.

", + "smithy.api#required": {} + } + }, + "SnapshotName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

A name for the snapshot being created.

", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The ID of the KMS key used to encrypt the snapshot.

" + } + }, + "Tags": { + "target": "com.amazonaws.memorydb#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.memorydb#CreateSnapshotResponse": { + "type": "structure", + "members": { + "Snapshot": { + "target": "com.amazonaws.memorydb#Snapshot", + "traits": { + "smithy.api#documentation": "

The newly-created snapshot.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.memorydb#CreateSubnetGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#CreateSubnetGroupRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#CreateSubnetGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#InvalidSubnet" + }, + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#SubnetGroupAlreadyExistsFault" + }, + { + "target": "com.amazonaws.memorydb#SubnetGroupQuotaExceededFault" + }, + { + "target": "com.amazonaws.memorydb#SubnetNotAllowedFault" + }, + { + "target": "com.amazonaws.memorydb#SubnetQuotaExceededFault" + }, + { + "target": "com.amazonaws.memorydb#TagQuotaPerResourceExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a subnet group. A subnet group is a collection of subnets (typically private) that you can designate for your clusters running in an Amazon Virtual Private Cloud (VPC) environment.\n \n When you create a cluster in an Amazon VPC, you must specify a subnet group. MemoryDB uses that subnet group to choose a subnet and IP addresses within that subnet to associate with your nodes. \n For more information, see Subnets and subnet groups.

" + } + }, + "com.amazonaws.memorydb#CreateSubnetGroupRequest": { + "type": "structure", + "members": { + "SubnetGroupName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the subnet group.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

A description for the subnet group.

" + } + }, + "SubnetIds": { + "target": "com.amazonaws.memorydb#SubnetIdentifierList", + "traits": { + "smithy.api#documentation": "

A list of VPC subnet IDs for the subnet group.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.memorydb#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.memorydb#CreateSubnetGroupResponse": { + "type": "structure", + "members": { + "SubnetGroup": { + "target": "com.amazonaws.memorydb#SubnetGroup", + "traits": { + "smithy.api#documentation": "

The newly-created subnet group.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.memorydb#CreateUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#CreateUserRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#CreateUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#DuplicateUserNameFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#TagQuotaPerResourceExceeded" + }, + { + "target": "com.amazonaws.memorydb#UserAlreadyExistsFault" + }, + { + "target": "com.amazonaws.memorydb#UserQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a MemoryDB user. For more information, see Authenticating users with Access Contol Lists (ACLs).

" + } + }, + "com.amazonaws.memorydb#CreateUserRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.memorydb#UserName", + "traits": { + "smithy.api#documentation": "

The name of the user. This value must be unique as it also serves as the user identifier.

", + "smithy.api#required": {} + } + }, + "AuthenticationMode": { + "target": "com.amazonaws.memorydb#AuthenticationMode", + "traits": { + "smithy.api#documentation": "

Denotes the user's authentication properties, such as whether it requires a password to authenticate.

", + "smithy.api#required": {} + } + }, + "AccessString": { + "target": "com.amazonaws.memorydb#AccessString", + "traits": { + "smithy.api#documentation": "

Access permissions string used for this user.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.memorydb#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.memorydb#CreateUserResponse": { + "type": "structure", + "members": { + "User": { + "target": "com.amazonaws.memorydb#User", + "traits": { + "smithy.api#documentation": "

The newly-created user.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.memorydb#DataTieringStatus": { + "type": "enum", + "members": { + "TRUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "true" + } + }, + "FALSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "false" + } + } + } + }, + "com.amazonaws.memorydb#DefaultUserRequired": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DefaultUserRequired", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#DeleteACL": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#DeleteACLRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#DeleteACLResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#ACLNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidACLStateFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an Access Control List. The ACL must first be disassociated from the cluster before it can be deleted. For more information, see Authenticating users with Access Contol Lists (ACLs).

" + } + }, + "com.amazonaws.memorydb#DeleteACLRequest": { + "type": "structure", + "members": { + "ACLName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the Access Control List to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.memorydb#DeleteACLResponse": { + "type": "structure", + "members": { + "ACL": { + "target": "com.amazonaws.memorydb#ACL", + "traits": { + "smithy.api#documentation": "

The Access Control List object that has been deleted.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.memorydb#DeleteCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#DeleteClusterRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#DeleteClusterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#ClusterNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidClusterStateFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#SnapshotAlreadyExistsFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a cluster. It also deletes all associated nodes and node endpoints.

\n \n

\n CreateSnapshot permission is required to create a final snapshot. \n Without this permission, the API call will fail with an Access Denied exception.

\n " + } + }, + "com.amazonaws.memorydb#DeleteClusterRequest": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the cluster to be deleted

", + "smithy.api#required": {} + } + }, + "MultiRegionClusterName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the multi-Region cluster to be deleted.

" + } + }, + "FinalSnapshotName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The user-supplied name of a final cluster snapshot. This is the unique name that identifies the snapshot. MemoryDB creates the snapshot, and then deletes the cluster immediately afterward.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.memorydb#DeleteClusterResponse": { + "type": "structure", + "members": { + "Cluster": { + "target": "com.amazonaws.memorydb#Cluster", + "traits": { + "smithy.api#documentation": "

The cluster object that has been deleted.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.memorydb#DeleteMultiRegionCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#DeleteMultiRegionClusterRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#DeleteMultiRegionClusterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#InvalidMultiRegionClusterStateFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#MultiRegionClusterNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an existing multi-Region cluster.

" + } + }, + "com.amazonaws.memorydb#DeleteMultiRegionClusterRequest": { + "type": "structure", + "members": { + "MultiRegionClusterName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the multi-Region cluster to be deleted.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.memorydb#DeleteMultiRegionClusterResponse": { + "type": "structure", + "members": { + "MultiRegionCluster": { + "target": "com.amazonaws.memorydb#MultiRegionCluster", + "traits": { + "smithy.api#documentation": "

Details about the deleted multi-Region cluster.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.memorydb#DeleteParameterGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#DeleteParameterGroupRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#DeleteParameterGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterGroupStateFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#ParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified parameter group. You cannot delete a parameter group if it is associated with any clusters. \n You cannot delete the default parameter groups in your account.

" + } + }, + "com.amazonaws.memorydb#DeleteParameterGroupRequest": { + "type": "structure", + "members": { + "ParameterGroupName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the parameter group to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.memorydb#DeleteParameterGroupResponse": { + "type": "structure", + "members": { + "ParameterGroup": { + "target": "com.amazonaws.memorydb#ParameterGroup", + "traits": { + "smithy.api#documentation": "

The parameter group that has been deleted.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.memorydb#DeleteSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#DeleteSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#DeleteSnapshotResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#InvalidSnapshotStateFault" + }, + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#SnapshotNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an existing snapshot. When you receive a successful response from this operation, MemoryDB immediately begins deleting the snapshot; you cannot cancel or revert this operation.

" + } + }, + "com.amazonaws.memorydb#DeleteSnapshotRequest": { + "type": "structure", + "members": { + "SnapshotName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the snapshot to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.memorydb#DeleteSnapshotResponse": { + "type": "structure", + "members": { + "Snapshot": { + "target": "com.amazonaws.memorydb#Snapshot", + "traits": { + "smithy.api#documentation": "

The snapshot object that has been deleted.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.memorydb#DeleteSubnetGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#DeleteSubnetGroupRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#DeleteSubnetGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#SubnetGroupInUseFault" + }, + { + "target": "com.amazonaws.memorydb#SubnetGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a subnet group. You cannot delete a default subnet group or one that is associated with any clusters.

" + } + }, + "com.amazonaws.memorydb#DeleteSubnetGroupRequest": { + "type": "structure", + "members": { + "SubnetGroupName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the subnet group to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.memorydb#DeleteSubnetGroupResponse": { + "type": "structure", + "members": { + "SubnetGroup": { + "target": "com.amazonaws.memorydb#SubnetGroup", + "traits": { + "smithy.api#documentation": "

The subnet group object that has been deleted.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.memorydb#DeleteUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#DeleteUserRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#DeleteUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#InvalidUserStateFault" + }, + { + "target": "com.amazonaws.memorydb#UserNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a user. The user will be removed from all ACLs and in turn removed from all clusters.

" + } + }, + "com.amazonaws.memorydb#DeleteUserRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.memorydb#UserName", + "traits": { + "smithy.api#documentation": "

The name of the user to delete

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.memorydb#DeleteUserResponse": { + "type": "structure", + "members": { + "User": { + "target": "com.amazonaws.memorydb#User", + "traits": { + "smithy.api#documentation": "

The user object that has been deleted.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.memorydb#DescribeACLs": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#DescribeACLsRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#DescribeACLsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#ACLNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of ACLs.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ACLs", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.memorydb#DescribeACLsRequest": { + "type": "structure", + "members": { + "ACLName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the ACL.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

" + } + }, + "NextToken": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.memorydb#DescribeACLsResponse": { + "type": "structure", + "members": { + "ACLs": { + "target": "com.amazonaws.memorydb#ACLList", + "traits": { + "smithy.api#documentation": "

The list of ACLs.

" + } + }, + "NextToken": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.memorydb#DescribeClusters": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#DescribeClustersRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#DescribeClustersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#ClusterNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cluster if a cluster name is supplied.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Clusters", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.memorydb#DescribeClustersRequest": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the cluster.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

" + } + }, + "NextToken": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

" + } + }, + "ShowShardDetails": { + "target": "com.amazonaws.memorydb#BooleanOptional", + "traits": { + "smithy.api#documentation": "

An optional flag that can be included in the request to retrieve information about the individual shard(s).

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.memorydb#DescribeClustersResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

" + } + }, + "Clusters": { + "target": "com.amazonaws.memorydb#ClusterList", + "traits": { + "smithy.api#documentation": "

A list of clusters

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.memorydb#DescribeEngineVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#DescribeEngineVersionsRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#DescribeEngineVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of the available Redis OSS engine versions.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "EngineVersions", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.memorydb#DescribeEngineVersionsRequest": { + "type": "structure", + "members": { + "Engine": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the engine for which to list available versions.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The Redis OSS engine version

" + } + }, + "ParameterGroupFamily": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of a specific parameter group family to return details for.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

" + } + }, + "NextToken": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

" + } + }, + "DefaultOnly": { + "target": "com.amazonaws.memorydb#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

If true, specifies that only the default version of the specified engine or engine and major version combination is to be returned.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.memorydb#DescribeEngineVersionsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

" + } + }, + "EngineVersions": { + "target": "com.amazonaws.memorydb#EngineVersionInfoList", + "traits": { + "smithy.api#documentation": "

A list of engine version details. Each element in the list contains detailed information about one engine version.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.memorydb#DescribeEvents": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#DescribeEventsRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#DescribeEventsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns events related to clusters, security groups, and parameter groups. You can obtain events specific to a particular cluster, security group, or parameter group by providing the name as a parameter.\n \n By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Events", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.memorydb#DescribeEventsRequest": { + "type": "structure", + "members": { + "SourceName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The identifier of the event source for which events are returned. If not specified, all sources are included in the response.

" + } + }, + "SourceType": { + "target": "com.amazonaws.memorydb#SourceType", + "traits": { + "smithy.api#documentation": "

The event source to retrieve events for. If no value is specified, all events are returned.

" + } + }, + "StartTime": { + "target": "com.amazonaws.memorydb#TStamp", + "traits": { + "smithy.api#documentation": "

The beginning of the time interval to retrieve events for, specified in ISO 8601 format.\n \n Example: 2017-03-30T07:03:49.555Z

" + } + }, + "EndTime": { + "target": "com.amazonaws.memorydb#TStamp", + "traits": { + "smithy.api#documentation": "

The end of the time interval for which to retrieve events, specified in ISO 8601 format.\n \n Example: 2017-03-30T07:03:49.555Z

" + } + }, + "Duration": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of minutes worth of events to retrieve.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

" + } + }, + "NextToken": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.memorydb#DescribeEventsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

" + } + }, + "Events": { + "target": "com.amazonaws.memorydb#EventList", + "traits": { + "smithy.api#documentation": "

A list of events. Each element in the list contains detailed information about one event.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.memorydb#DescribeMultiRegionClusters": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#DescribeMultiRegionClustersRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#DescribeMultiRegionClustersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#ClusterNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#MultiRegionClusterNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns details about one or more multi-Region clusters.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "MultiRegionClusters", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.memorydb#DescribeMultiRegionClustersRequest": { + "type": "structure", + "members": { + "MultiRegionClusterName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of a specific multi-Region cluster to describe.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return.

" + } + }, + "NextToken": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

A token to specify where to start paginating.

" + } + }, + "ShowClusterDetails": { + "target": "com.amazonaws.memorydb#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Details about the multi-Region cluster.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.memorydb#DescribeMultiRegionClustersResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

A token to use to retrieve the next page of results.

" + } + }, + "MultiRegionClusters": { + "target": "com.amazonaws.memorydb#MultiRegionClusterList", + "traits": { + "smithy.api#documentation": "

A list of multi-Region clusters.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.memorydb#DescribeParameterGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#DescribeParameterGroupsRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#DescribeParameterGroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#ParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of parameter group descriptions. If a parameter group name is specified, the list contains only the descriptions for that group.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ParameterGroups", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.memorydb#DescribeParameterGroupsRequest": { + "type": "structure", + "members": { + "ParameterGroupName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of a specific parameter group to return details for.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

" + } + }, + "NextToken": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.memorydb#DescribeParameterGroupsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

" + } + }, + "ParameterGroups": { + "target": "com.amazonaws.memorydb#ParameterGroupList", + "traits": { + "smithy.api#documentation": "

A list of parameter groups. Each element in the list contains detailed information about one parameter group.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.memorydb#DescribeParameters": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#DescribeParametersRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#DescribeParametersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#ParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the detailed parameter list for a particular parameter group.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Parameters", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.memorydb#DescribeParametersRequest": { + "type": "structure", + "members": { + "ParameterGroupName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

he name of a specific parameter group to return details for.

", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

" + } + }, + "NextToken": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.memorydb#DescribeParametersResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

" + } + }, + "Parameters": { + "target": "com.amazonaws.memorydb#ParametersList", + "traits": { + "smithy.api#documentation": "

A list of parameters specific to a particular parameter group. Each element in the list contains detailed information about one parameter.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.memorydb#DescribeReservedNodes": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#DescribeReservedNodesRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#DescribeReservedNodesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#ReservedNodeNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about reserved nodes for this account, or about a specified reserved node.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ReservedNodes", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.memorydb#DescribeReservedNodesOfferings": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#DescribeReservedNodesOfferingsRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#DescribeReservedNodesOfferingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#ReservedNodesOfferingNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Lists available reserved node offerings.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ReservedNodesOfferings", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.memorydb#DescribeReservedNodesOfferingsRequest": { + "type": "structure", + "members": { + "ReservedNodesOfferingId": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.

" + } + }, + "NodeType": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The node type for the reserved nodes. For more information, see Supported node types.

" + } + }, + "Duration": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

Duration filter value, specified in years or seconds. Use this parameter to show only reservations for a given duration.

" + } + }, + "OfferingType": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type. \n Valid values: \"All Upfront\"|\"Partial Upfront\"| \"No Upfront\"

" + } + }, + "MaxResults": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

" + } + }, + "NextToken": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.memorydb#DescribeReservedNodesOfferingsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "ReservedNodesOfferings": { + "target": "com.amazonaws.memorydb#ReservedNodesOfferingList", + "traits": { + "smithy.api#documentation": "

Lists available reserved node offerings.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.memorydb#DescribeReservedNodesRequest": { + "type": "structure", + "members": { + "ReservationId": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The reserved node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.

" + } + }, + "ReservedNodesOfferingId": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.

" + } + }, + "NodeType": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The node type filter value. Use this parameter to show only those reservations matching the specified node type. For more information, see Supported node types.

" + } + }, + "Duration": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this duration.

" + } + }, + "OfferingType": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type. \n Valid values: \"All Upfront\"|\"Partial Upfront\"| \"No Upfront\"

" + } + }, + "MaxResults": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

" + } + }, + "NextToken": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.memorydb#DescribeReservedNodesResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "ReservedNodes": { + "target": "com.amazonaws.memorydb#ReservedNodeList", + "traits": { + "smithy.api#documentation": "

Returns information about reserved nodes for this account, or about a specified reserved node.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.memorydb#DescribeServiceUpdates": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#DescribeServiceUpdatesRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#DescribeServiceUpdatesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns details of the service updates.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ServiceUpdates", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.memorydb#DescribeServiceUpdatesRequest": { + "type": "structure", + "members": { + "ServiceUpdateName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The unique ID of the service update to describe.

" + } + }, + "ClusterNames": { + "target": "com.amazonaws.memorydb#ClusterNameList", + "traits": { + "smithy.api#documentation": "

The list of cluster names to identify service updates to apply.

" + } + }, + "Status": { + "target": "com.amazonaws.memorydb#ServiceUpdateStatusList", + "traits": { + "smithy.api#documentation": "

The status(es) of the service updates to filter on.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

" + } + }, + "NextToken": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.memorydb#DescribeServiceUpdatesResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

" + } + }, + "ServiceUpdates": { + "target": "com.amazonaws.memorydb#ServiceUpdateList", + "traits": { + "smithy.api#documentation": "

A list of service updates

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.memorydb#DescribeSnapshots": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#DescribeSnapshotsRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#DescribeSnapshotsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#SnapshotNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about cluster snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, \n or just the snapshots associated with a particular cluster.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Snapshots", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.memorydb#DescribeSnapshotsRequest": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.

" + } + }, + "SnapshotName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

A user-supplied name of the snapshot. If this parameter is specified, only this named snapshot is described.

" + } + }, + "Source": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

If set to system, the output shows snapshots that were automatically created by MemoryDB. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.

" + } + }, + "NextToken": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

" + } + }, + "ShowDetail": { + "target": "com.amazonaws.memorydb#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A Boolean value which if true, the shard configuration is included in the snapshot description.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.memorydb#DescribeSnapshotsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

" + } + }, + "Snapshots": { + "target": "com.amazonaws.memorydb#SnapshotList", + "traits": { + "smithy.api#documentation": "

A list of snapshots. Each item in the list contains detailed information about one snapshot.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.memorydb#DescribeSubnetGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#DescribeSubnetGroupsRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#DescribeSubnetGroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#SubnetGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "SubnetGroups", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.memorydb#DescribeSubnetGroupsRequest": { + "type": "structure", + "members": { + "SubnetGroupName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the subnet group to return details for.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

" + } + }, + "NextToken": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.memorydb#DescribeSubnetGroupsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

" + } + }, + "SubnetGroups": { + "target": "com.amazonaws.memorydb#SubnetGroupList", + "traits": { + "smithy.api#documentation": "

A list of subnet groups. Each element in the list contains detailed information about one group.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.memorydb#DescribeUsers": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#DescribeUsersRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#DescribeUsersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#UserNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of users.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Users", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.memorydb#DescribeUsersRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.memorydb#UserName", + "traits": { + "smithy.api#documentation": "

The name of the user.

" + } + }, + "Filters": { + "target": "com.amazonaws.memorydb#FilterList", + "traits": { + "smithy.api#documentation": "

Filter to determine the list of users to return.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

" + } + }, + "NextToken": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.memorydb#DescribeUsersResponse": { + "type": "structure", + "members": { + "Users": { + "target": "com.amazonaws.memorydb#UserList", + "traits": { + "smithy.api#documentation": "

A list of users.

" + } + }, + "NextToken": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.memorydb#Double": { + "type": "double", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.memorydb#DuplicateUserNameFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DuplicateUserName", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#Endpoint": { + "type": "structure", + "members": { + "Address": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The DNS hostname of the node.

" + } + }, + "Port": { + "target": "com.amazonaws.memorydb#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The port number that the engine is listening on.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the information required for client programs to connect to the cluster and its nodes.

" + } + }, + "com.amazonaws.memorydb#EngineVersionInfo": { + "type": "structure", + "members": { + "Engine": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the engine for which version information is provided.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The engine version

" + } + }, + "EnginePatchVersion": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The patched engine version

" + } + }, + "ParameterGroupFamily": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the parameter group family to which the engine default parameters apply.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details of the Redis OSS engine version

" + } + }, + "com.amazonaws.memorydb#EngineVersionInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#EngineVersionInfo" + } + }, + "com.amazonaws.memorydb#Event": { + "type": "structure", + "members": { + "SourceName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name for the source of the event. For example, if the event occurred at the cluster level, the identifier would be the name of the cluster.

" + } + }, + "SourceType": { + "target": "com.amazonaws.memorydb#SourceType", + "traits": { + "smithy.api#documentation": "

Specifies the origin of this event - a cluster, a parameter group, a security group, etc.

" + } + }, + "Message": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The text of the event.

" + } + }, + "Date": { + "target": "com.amazonaws.memorydb#TStamp", + "traits": { + "smithy.api#documentation": "

The date and time when the event occurred.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a single occurrence of something interesting within the system. Some examples of events are creating a cluster or adding or removing a \n node.

" + } + }, + "com.amazonaws.memorydb#EventList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#Event", + "traits": { + "smithy.api#xmlName": "Event" + } + } + }, + "com.amazonaws.memorydb#ExceptionMessage": { + "type": "string" + }, + "com.amazonaws.memorydb#FailoverShard": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#FailoverShardRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#FailoverShardResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#APICallRateForCustomerExceededFault" + }, + { + "target": "com.amazonaws.memorydb#ClusterNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidClusterStateFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidKMSKeyFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#ShardNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#TestFailoverNotAvailableFault" + } + ], + "traits": { + "smithy.api#documentation": "

Used to failover a shard. This API is designed for testing the behavior of your application in case of MemoryDB failover. It is not designed to be used as a production-level tool for initiating\n a failover to overcome a problem you may have with the cluster. Moreover, in certain conditions such as large scale operational events, Amazon may block this API.

" + } + }, + "com.amazonaws.memorydb#FailoverShardRequest": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The cluster being failed over.

", + "smithy.api#required": {} + } + }, + "ShardName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the shard.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.memorydb#FailoverShardResponse": { + "type": "structure", + "members": { + "Cluster": { + "target": "com.amazonaws.memorydb#Cluster", + "traits": { + "smithy.api#documentation": "

The cluster being failed over.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.memorydb#Filter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.memorydb#FilterName", + "traits": { + "smithy.api#documentation": "

The property being filtered. For example, UserName.

", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.memorydb#FilterValueList", + "traits": { + "smithy.api#documentation": "

The property values to filter on. For example, \"user-123\".

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Used to streamline results of a search based on the property being filtered.

" + } + }, + "com.amazonaws.memorydb#FilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#Filter" + } + }, + "com.amazonaws.memorydb#FilterName": { + "type": "string", + "traits": { + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.memorydb#FilterValue": { + "type": "string", + "traits": { + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.memorydb#FilterValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#FilterValue" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.memorydb#InputAuthenticationType": { + "type": "enum", + "members": { + "PASSWORD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "password" + } + }, + "IAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "iam" + } + } + } + }, + "com.amazonaws.memorydb#InsufficientClusterCapacityFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InsufficientClusterCapacity", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#Integer": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.memorydb#IntegerOptional": { + "type": "integer" + }, + "com.amazonaws.memorydb#InvalidACLStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidACLState", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#InvalidARNFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidARN", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#InvalidClusterStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidClusterState", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#InvalidCredentialsException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidCredentialsException", + "httpResponseCode": 408 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 408 + } + }, + "com.amazonaws.memorydb#InvalidKMSKeyFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidKMSKeyFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#InvalidMultiRegionClusterStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidMultiRegionClusterState", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The requested operation cannot be performed on the multi-Region cluster in its current state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#InvalidNodeStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidNodeState", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#InvalidParameterCombinationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#AwsQueryErrorMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidParameterCombination", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#InvalidParameterGroupStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidParameterGroupState", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#InvalidParameterValueException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#AwsQueryErrorMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidParameterValue", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#InvalidSnapshotStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidSnapshotState", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#InvalidSubnet": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidSubnet", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#InvalidUserStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidUserState", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#InvalidVPCNetworkStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidVPCNetworkStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#KeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#String" + } + }, + "com.amazonaws.memorydb#KmsKeyId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + } + } + }, + "com.amazonaws.memorydb#ListAllowedMultiRegionClusterUpdates": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#ListAllowedMultiRegionClusterUpdatesRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#ListAllowedMultiRegionClusterUpdatesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#MultiRegionClusterNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the allowed updates for a multi-Region cluster.

" + } + }, + "com.amazonaws.memorydb#ListAllowedMultiRegionClusterUpdatesRequest": { + "type": "structure", + "members": { + "MultiRegionClusterName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the multi-Region cluster.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.memorydb#ListAllowedMultiRegionClusterUpdatesResponse": { + "type": "structure", + "members": { + "ScaleUpNodeTypes": { + "target": "com.amazonaws.memorydb#NodeTypeList", + "traits": { + "smithy.api#documentation": "

The node types that the cluster can be scaled up to.

" + } + }, + "ScaleDownNodeTypes": { + "target": "com.amazonaws.memorydb#NodeTypeList", + "traits": { + "smithy.api#documentation": "

The node types that the cluster can be scaled down to.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.memorydb#ListAllowedNodeTypeUpdates": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#ListAllowedNodeTypeUpdatesRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#ListAllowedNodeTypeUpdatesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#ClusterNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all available node types that you can scale to from your cluster's current node type.\n \n When you use the UpdateCluster operation to scale your cluster, the value of the NodeType parameter must be one of the node types returned by this operation.

" + } + }, + "com.amazonaws.memorydb#ListAllowedNodeTypeUpdatesRequest": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the cluster you want to scale. MemoryDB uses the cluster name to identify the current node type being used by this cluster, and from that to create a list of node types\n you can scale up to.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.memorydb#ListAllowedNodeTypeUpdatesResponse": { + "type": "structure", + "members": { + "ScaleUpNodeTypes": { + "target": "com.amazonaws.memorydb#NodeTypeList", + "traits": { + "smithy.api#documentation": "

A list node types which you can use to scale up your cluster.

" + } + }, + "ScaleDownNodeTypes": { + "target": "com.amazonaws.memorydb#NodeTypeList", + "traits": { + "smithy.api#documentation": "

A list node types which you can use to scale down your cluster.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.memorydb#ListTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#ListTagsRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#ListTagsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#ACLNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#ClusterNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidARNFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidClusterStateFault" + }, + { + "target": "com.amazonaws.memorydb#MultiRegionClusterNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#MultiRegionParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#ParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#SnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#SubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#UserNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all tags currently on a named resource.\n \n A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track your MemoryDB resources. \n For more information, see Tagging your MemoryDB resources.

" + } + }, + "com.amazonaws.memorydb#ListTagsRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource for which you want the list of tags.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.memorydb#ListTagsResponse": { + "type": "structure", + "members": { + "TagList": { + "target": "com.amazonaws.memorydb#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags as key-value pairs.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.memorydb#MultiRegionCluster": { + "type": "structure", + "members": { + "MultiRegionClusterName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the multi-Region cluster.

" + } + }, + "Description": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The description of the multi-Region cluster.

" + } + }, + "Status": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The current status of the multi-Region cluster.

" + } + }, + "NodeType": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The node type used by the multi-Region cluster.

" + } + }, + "Engine": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the engine used by the multi-Region cluster.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The version of the engine used by the multi-Region cluster.

" + } + }, + "NumberOfShards": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of shards in the multi-Region cluster.

" + } + }, + "Clusters": { + "target": "com.amazonaws.memorydb#RegionalClusterList", + "traits": { + "smithy.api#documentation": "

The clusters in this multi-Region cluster.

" + } + }, + "MultiRegionParameterGroupName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the multi-Region parameter group associated with the cluster.

" + } + }, + "TLSEnabled": { + "target": "com.amazonaws.memorydb#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indiciates if the multi-Region cluster is TLS enabled.

" + } + }, + "ARN": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the multi-Region cluster.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a multi-Region cluster.

" + } + }, + "com.amazonaws.memorydb#MultiRegionClusterAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "MultiRegionClusterAlreadyExistsFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

A multi-Region cluster with the specified name already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#MultiRegionClusterList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#MultiRegionCluster" + } + }, + "com.amazonaws.memorydb#MultiRegionClusterNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "MultiRegionClusterNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified multi-Region cluster does not exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.memorydb#MultiRegionParameterGroupNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "MultiRegionParameterGroupNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified multi-Region parameter group does not exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.memorydb#NoOperationFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "NoOperationFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#Node": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The node identifier. A node name is a numeric identifier (0001, 0002, etc.). The combination of cluster name, shard name and node name uniquely identifies every node used in a customer's Amazon account.

" + } + }, + "Status": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The status of the service update on the node

" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone in which the node resides

" + } + }, + "CreateTime": { + "target": "com.amazonaws.memorydb#TStamp", + "traits": { + "smithy.api#documentation": "

The date and time when the node was created.

" + } + }, + "Endpoint": { + "target": "com.amazonaws.memorydb#Endpoint", + "traits": { + "smithy.api#documentation": "

The hostname for connecting to this node.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents an individual node within a cluster. Each node runs its own instance of the cluster's protocol-compliant caching software.

" + } + }, + "com.amazonaws.memorydb#NodeList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#Node", + "traits": { + "smithy.api#xmlName": "Node" + } + } + }, + "com.amazonaws.memorydb#NodeQuotaForClusterExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "NodeQuotaForClusterExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#NodeQuotaForCustomerExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "NodeQuotaForCustomerExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#NodeTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#String" + } + }, + "com.amazonaws.memorydb#Parameter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the parameter

" + } + }, + "Value": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The value of the parameter

" + } + }, + "Description": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

A description of the parameter

" + } + }, + "DataType": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The parameter's data type

" + } + }, + "AllowedValues": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The valid range of values for the parameter.

" + } + }, + "MinimumEngineVersion": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The earliest engine version to which the parameter can apply.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an individual setting that controls some aspect of MemoryDB behavior.

" + } + }, + "com.amazonaws.memorydb#ParameterGroup": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the parameter group

" + } + }, + "Family": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the parameter group family that this parameter group is compatible with.

" + } + }, + "Description": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

A description of the parameter group

" + } + }, + "ARN": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the parameter group

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a CreateParameterGroup operation. A parameter group represents a combination of specific values for the parameters that are passed to the engine software during startup.

" + } + }, + "com.amazonaws.memorydb#ParameterGroupAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ParameterGroupAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#ParameterGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#ParameterGroup", + "traits": { + "smithy.api#xmlName": "ParameterGroup" + } + } + }, + "com.amazonaws.memorydb#ParameterGroupNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ParameterGroupNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.memorydb#ParameterGroupQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ParameterGroupQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#ParameterNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#String" + } + }, + "com.amazonaws.memorydb#ParameterNameValue": { + "type": "structure", + "members": { + "ParameterName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the parameter

" + } + }, + "ParameterValue": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The value of the parameter

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a name-value pair that is used to update the value of a parameter.

" + } + }, + "com.amazonaws.memorydb#ParameterNameValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#ParameterNameValue", + "traits": { + "smithy.api#xmlName": "ParameterNameValue" + } + } + }, + "com.amazonaws.memorydb#ParametersList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#Parameter", + "traits": { + "smithy.api#xmlName": "Parameter" + } + } + }, + "com.amazonaws.memorydb#PasswordListInput": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#String" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.memorydb#PendingModifiedServiceUpdate": { + "type": "structure", + "members": { + "ServiceUpdateName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The unique ID of the service update

" + } + }, + "Status": { + "target": "com.amazonaws.memorydb#ServiceUpdateStatus", + "traits": { + "smithy.api#documentation": "

The status of the service update

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Update action that has yet to be processed for the corresponding apply/stop request

" + } + }, + "com.amazonaws.memorydb#PendingModifiedServiceUpdateList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#PendingModifiedServiceUpdate", + "traits": { + "smithy.api#xmlName": "PendingModifiedServiceUpdate" + } + } + }, + "com.amazonaws.memorydb#PurchaseReservedNodesOffering": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#PurchaseReservedNodesOfferingRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#PurchaseReservedNodesOfferingResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#ReservedNodeAlreadyExistsFault" + }, + { + "target": "com.amazonaws.memorydb#ReservedNodeQuotaExceededFault" + }, + { + "target": "com.amazonaws.memorydb#ReservedNodesOfferingNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#TagQuotaPerResourceExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Allows you to purchase a reserved node offering. Reserved nodes are not eligible for cancellation and are non-refundable.

" + } + }, + "com.amazonaws.memorydb#PurchaseReservedNodesOfferingRequest": { + "type": "structure", + "members": { + "ReservedNodesOfferingId": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The ID of the reserved node offering to purchase.

", + "smithy.api#required": {} + } + }, + "ReservationId": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

A customer-specified identifier to track this reservation.

" + } + }, + "NodeCount": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of node instances to reserve.

" + } + }, + "Tags": { + "target": "com.amazonaws.memorydb#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.memorydb#PurchaseReservedNodesOfferingResponse": { + "type": "structure", + "members": { + "ReservedNode": { + "target": "com.amazonaws.memorydb#ReservedNode", + "traits": { + "smithy.api#documentation": "

Represents the output of a PurchaseReservedNodesOffering operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.memorydb#RecurringCharge": { + "type": "structure", + "members": { + "RecurringChargeAmount": { + "target": "com.amazonaws.memorydb#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The amount of the recurring charge to run this reserved node.

" + } + }, + "RecurringChargeFrequency": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The frequency of the recurring price charged to run this reserved node.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The recurring charge to run this reserved node.

" + } + }, + "com.amazonaws.memorydb#RecurringChargeList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#RecurringCharge", + "traits": { + "smithy.api#xmlName": "RecurringCharge" + } + } + }, + "com.amazonaws.memorydb#RegionalCluster": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the Regional cluster

" + } + }, + "Region": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The Region the current Regional cluster is assigned to.

" + } + }, + "Status": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The status of the Regional cluster.

" + } + }, + "ARN": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) the Regional cluster

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a Regional cluster

" + } + }, + "com.amazonaws.memorydb#RegionalClusterList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#RegionalCluster", + "traits": { + "smithy.api#xmlName": "RegionalCluster" + } + } + }, + "com.amazonaws.memorydb#ReplicaConfigurationRequest": { + "type": "structure", + "members": { + "ReplicaCount": { + "target": "com.amazonaws.memorydb#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of replicas to scale up or down to

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A request to configure the number of replicas in a shard

" + } + }, + "com.amazonaws.memorydb#ReservedNode": { + "type": "structure", + "members": { + "ReservationId": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

A customer-specified identifier to track this reservation.

" + } + }, + "ReservedNodesOfferingId": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The ID of the reserved node offering to purchase.

" + } + }, + "NodeType": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The node type for the reserved nodes.

" + } + }, + "StartTime": { + "target": "com.amazonaws.memorydb#TStamp", + "traits": { + "smithy.api#documentation": "

The time the reservation started.

" + } + }, + "Duration": { + "target": "com.amazonaws.memorydb#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The duration of the reservation in seconds.

" + } + }, + "FixedPrice": { + "target": "com.amazonaws.memorydb#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The fixed price charged for this reserved node.

" + } + }, + "NodeCount": { + "target": "com.amazonaws.memorydb#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of nodes that have been reserved.

" + } + }, + "OfferingType": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The offering type of this reserved node.

" + } + }, + "State": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The state of the reserved node.

" + } + }, + "RecurringCharges": { + "target": "com.amazonaws.memorydb#RecurringChargeList", + "traits": { + "smithy.api#documentation": "

The recurring price charged to run this reserved node.

" + } + }, + "ARN": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the reserved node.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a PurchaseReservedNodesOffering operation.

" + } + }, + "com.amazonaws.memorydb#ReservedNodeAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ReservedNodeAlreadyExists", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

You already have a reservation with the given identifier.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.memorydb#ReservedNodeList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#ReservedNode", + "traits": { + "smithy.api#xmlName": "ReservedNode" + } + } + }, + "com.amazonaws.memorydb#ReservedNodeNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ReservedNodeNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The requested node does not exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.memorydb#ReservedNodeQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ReservedNodeQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request cannot be processed because it would exceed the user's node quota.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#ReservedNodesOffering": { + "type": "structure", + "members": { + "ReservedNodesOfferingId": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The offering identifier.

" + } + }, + "NodeType": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The node type for the reserved nodes. For more information, see Supported node types.

" + } + }, + "Duration": { + "target": "com.amazonaws.memorydb#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The duration of the reservation in seconds.

" + } + }, + "FixedPrice": { + "target": "com.amazonaws.memorydb#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The fixed price charged for this reserved node.

" + } + }, + "OfferingType": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The offering type of this reserved node.

" + } + }, + "RecurringCharges": { + "target": "com.amazonaws.memorydb#RecurringChargeList", + "traits": { + "smithy.api#documentation": "

The recurring price charged to run this reserved node.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The offering type of this node.

" + } + }, + "com.amazonaws.memorydb#ReservedNodesOfferingList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#ReservedNodesOffering", + "traits": { + "smithy.api#xmlName": "ReservedNodesOffering" + } + } + }, + "com.amazonaws.memorydb#ReservedNodesOfferingNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ReservedNodesOfferingNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The requested node offering does not exist.\n \n

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.memorydb#ResetParameterGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#ResetParameterGroupRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#ResetParameterGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterGroupStateFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#ParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies the parameters of a parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire parameter group, specify the AllParameters and ParameterGroupName parameters.

" + } + }, + "com.amazonaws.memorydb#ResetParameterGroupRequest": { + "type": "structure", + "members": { + "ParameterGroupName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the parameter group to reset.

", + "smithy.api#required": {} + } + }, + "AllParameters": { + "target": "com.amazonaws.memorydb#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

If true, all parameters in the parameter group are reset to their default values. If false, only the parameters listed by ParameterNames are reset to their default values.

" + } + }, + "ParameterNames": { + "target": "com.amazonaws.memorydb#ParameterNameList", + "traits": { + "smithy.api#documentation": "

An array of parameter names to reset to their default values. If AllParameters is true, do not use ParameterNames. If AllParameters is false, you must specify the name of at least one parameter to reset.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.memorydb#ResetParameterGroupResponse": { + "type": "structure", + "members": { + "ParameterGroup": { + "target": "com.amazonaws.memorydb#ParameterGroup", + "traits": { + "smithy.api#documentation": "

The parameter group being reset.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.memorydb#ReshardingStatus": { + "type": "structure", + "members": { + "SlotMigration": { + "target": "com.amazonaws.memorydb#SlotMigration", + "traits": { + "smithy.api#documentation": "

The status of the online resharding slot migration

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The status of the online resharding

" + } + }, + "com.amazonaws.memorydb#SecurityGroupIdsList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#xmlName": "SecurityGroupId" + } + } + }, + "com.amazonaws.memorydb#SecurityGroupMembership": { + "type": "structure", + "members": { + "SecurityGroupId": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The identifier of the security group.

" + } + }, + "Status": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The status of the security group membership. The status changes whenever a security group is modified, or when the security groups assigned to a cluster are modified.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a single security group and its status.

" + } + }, + "com.amazonaws.memorydb#SecurityGroupMembershipList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#SecurityGroupMembership" + } + }, + "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ServiceLinkedRoleNotFoundFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#ServiceUpdate": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the cluster to which the service update applies

" + } + }, + "ServiceUpdateName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The unique ID of the service update

" + } + }, + "ReleaseDate": { + "target": "com.amazonaws.memorydb#TStamp", + "traits": { + "smithy.api#documentation": "

The date when the service update is initially available

" + } + }, + "Description": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

Provides details of the service update

" + } + }, + "Status": { + "target": "com.amazonaws.memorydb#ServiceUpdateStatus", + "traits": { + "smithy.api#documentation": "

The status of the service update

" + } + }, + "Type": { + "target": "com.amazonaws.memorydb#ServiceUpdateType", + "traits": { + "smithy.api#documentation": "

Reflects the nature of the service update

" + } + }, + "Engine": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the engine for which a service update is available.

" + } + }, + "NodesUpdated": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

A list of nodes updated by the service update

" + } + }, + "AutoUpdateStartDate": { + "target": "com.amazonaws.memorydb#TStamp", + "traits": { + "smithy.api#documentation": "

The date at which the service update will be automatically applied

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An update that you can apply to your MemoryDB clusters.

" + } + }, + "com.amazonaws.memorydb#ServiceUpdateList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#ServiceUpdate", + "traits": { + "smithy.api#xmlName": "ServiceUpdate" + } + } + }, + "com.amazonaws.memorydb#ServiceUpdateNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ServiceUpdateNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.memorydb#ServiceUpdateRequest": { + "type": "structure", + "members": { + "ServiceUpdateNameToApply": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The unique ID of the service update

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A request to apply a service update

" + } + }, + "com.amazonaws.memorydb#ServiceUpdateStatus": { + "type": "enum", + "members": { + "NOT_APPLIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "in-progress" + } + }, + "COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "complete" + } + }, + "SCHEDULED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scheduled" + } + } + } + }, + "com.amazonaws.memorydb#ServiceUpdateStatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#ServiceUpdateStatus" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4 + } + } + }, + "com.amazonaws.memorydb#ServiceUpdateType": { + "type": "enum", + "members": { + "SECURITY_UPDATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "security-update" + } + } + } + }, + "com.amazonaws.memorydb#Shard": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the shard

" + } + }, + "Status": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The current state of this replication group - creating, available, modifying, deleting.

" + } + }, + "Slots": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The keyspace for this shard.

" + } + }, + "Nodes": { + "target": "com.amazonaws.memorydb#NodeList", + "traits": { + "smithy.api#documentation": "

A list containing information about individual nodes within the shard

" + } + }, + "NumberOfNodes": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of nodes in the shard

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a collection of nodes in a cluster. One node in the node group is the read/write primary node. All the other nodes are read-only Replica nodes.

" + } + }, + "com.amazonaws.memorydb#ShardConfiguration": { + "type": "structure", + "members": { + "Slots": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

A string that specifies the keyspace for a particular node group. Keyspaces range from 0 to 16,383. The string is in the format startkey-endkey.

" + } + }, + "ReplicaCount": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of read replica nodes in this shard.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Shard configuration options. Each shard configuration has the following: Slots and ReplicaCount.

" + } + }, + "com.amazonaws.memorydb#ShardConfigurationRequest": { + "type": "structure", + "members": { + "ShardCount": { + "target": "com.amazonaws.memorydb#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of shards in the cluster

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A request to configure the sharding properties of a cluster

" + } + }, + "com.amazonaws.memorydb#ShardDetail": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the shard

" + } + }, + "Configuration": { + "target": "com.amazonaws.memorydb#ShardConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration details of the shard

" + } + }, + "Size": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The size of the shard's snapshot

" + } + }, + "SnapshotCreationTime": { + "target": "com.amazonaws.memorydb#TStamp", + "traits": { + "smithy.api#documentation": "

The date and time that the shard's snapshot was created

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details of a shard in a snapshot

" + } + }, + "com.amazonaws.memorydb#ShardDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#ShardDetail" + } + }, + "com.amazonaws.memorydb#ShardList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#Shard", + "traits": { + "smithy.api#xmlName": "Shard" + } + } + }, + "com.amazonaws.memorydb#ShardNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ShardNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.memorydb#ShardsPerClusterQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ShardsPerClusterQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#SlotMigration": { + "type": "structure", + "members": { + "ProgressPercentage": { + "target": "com.amazonaws.memorydb#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The percentage of the slot migration that is complete.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the progress of an online resharding operation.

" + } + }, + "com.amazonaws.memorydb#Snapshot": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the snapshot

" + } + }, + "Status": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.

" + } + }, + "Source": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The ID of the KMS key used to encrypt the snapshot.

" + } + }, + "ARN": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The ARN (Amazon Resource Name) of the snapshot.

" + } + }, + "ClusterConfiguration": { + "target": "com.amazonaws.memorydb#ClusterConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of the cluster from which the snapshot was taken

" + } + }, + "DataTiering": { + "target": "com.amazonaws.memorydb#DataTieringStatus", + "traits": { + "smithy.api#documentation": "

Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. \n This parameter must be set when using r6gd nodes. For more information, see Data tiering.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a copy of an entire cluster as of the time when the snapshot was taken.

" + } + }, + "com.amazonaws.memorydb#SnapshotAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SnapshotAlreadyExistsFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#SnapshotArnsList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#xmlName": "SnapshotArn" + } + } + }, + "com.amazonaws.memorydb#SnapshotList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#Snapshot" + } + }, + "com.amazonaws.memorydb#SnapshotNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SnapshotNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.memorydb#SnapshotQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SnapshotQuotaExceededFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#SourceType": { + "type": "enum", + "members": { + "node": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "node" + } + }, + "parameter_group": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "parameter-group" + } + }, + "subnet_group": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "subnet-group" + } + }, + "cluster": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cluster" + } + }, + "user": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "user" + } + }, + "acl": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "acl" + } + } + } + }, + "com.amazonaws.memorydb#String": { + "type": "string" + }, + "com.amazonaws.memorydb#Subnet": { + "type": "structure", + "members": { + "Identifier": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The unique identifier for the subnet.

" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.memorydb#AvailabilityZone", + "traits": { + "smithy.api#documentation": "

The Availability Zone where the subnet resides

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the subnet associated with a cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with MemoryDB.

" + } + }, + "com.amazonaws.memorydb#SubnetGroup": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the subnet group

" + } + }, + "Description": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

A description of the subnet group

" + } + }, + "VpcId": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The Amazon Virtual Private Cloud identifier (VPC ID) of the subnet group.

" + } + }, + "Subnets": { + "target": "com.amazonaws.memorydb#SubnetList", + "traits": { + "smithy.api#documentation": "

A list of subnets associated with the subnet group.

" + } + }, + "ARN": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The ARN (Amazon Resource Name) of the subnet group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of one of the following operations:

\n
    \n
  • \n

    CreateSubnetGroup

    \n
    • \n
  • \n

    UpdateSubnetGroup

    \n
    • \n
\n

A subnet group is a collection of subnets (typically private) that you can designate for your clusters running in an Amazon Virtual Private Cloud (VPC) environment.

" + } + }, + "com.amazonaws.memorydb#SubnetGroupAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SubnetGroupAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#SubnetGroupInUseFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SubnetGroupInUse", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#SubnetGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#SubnetGroup" + } + }, + "com.amazonaws.memorydb#SubnetGroupNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SubnetGroupNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.memorydb#SubnetGroupQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SubnetGroupQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#SubnetIdentifierList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#xmlName": "SubnetIdentifier" + } + } + }, + "com.amazonaws.memorydb#SubnetInUse": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SubnetInUse", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#SubnetList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#Subnet", + "traits": { + "smithy.api#xmlName": "Subnet" + } + } + }, + "com.amazonaws.memorydb#SubnetNotAllowedFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SubnetNotAllowedFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#SubnetQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SubnetQuotaExceededFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#TStamp": { + "type": "timestamp" + }, + "com.amazonaws.memorydb#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The key for the tag. May not be null.

" + } + }, + "Value": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The tag's value. May be null.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A tag that can be added to an MemoryDB resource. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your MemoryDB resources. \n When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. A tag with a null Value is permitted. For more information, see \n Tagging your MemoryDB resources\n

" + } + }, + "com.amazonaws.memorydb#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#Tag", + "traits": { + "smithy.api#xmlName": "Tag" + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.memorydb#TagNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "TagNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.memorydb#TagQuotaPerResourceExceeded": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "TagQuotaPerResourceExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#ACLNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#ClusterNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidARNFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidClusterStateFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#MultiRegionClusterNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#MultiRegionParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#ParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#SnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#SubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#TagQuotaPerResourceExceeded" + }, + { + "target": "com.amazonaws.memorydb#UserNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your MemoryDB resources. \n\n When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. For more information, see \n\n Resource-level permissions.

\n

For example, you can use cost-allocation tags to your MemoryDB resources, Amazon generates a cost allocation report as a comma-separated value \n (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories \n (such as cost centers, application names, or owners) to organize your costs across multiple services.\n \n For more information, see Using Cost Allocation Tags.

" + } + }, + "com.amazonaws.memorydb#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to which the tags are to be added.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.memorydb#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.memorydb#TagResourceResponse": { + "type": "structure", + "members": { + "TagList": { + "target": "com.amazonaws.memorydb#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags as key-value pairs.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.memorydb#TargetBucket": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": "^[A-Za-z0-9._-]+$" + } + }, + "com.amazonaws.memorydb#TestFailoverNotAvailableFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "TestFailoverNotAvailableFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#UnprocessedCluster": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the cluster

" + } + }, + "ErrorType": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The error type associated with the update failure

" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The error message associated with the update failure

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A cluster whose updates have failed

" + } + }, + "com.amazonaws.memorydb#UnprocessedClusterList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#UnprocessedCluster", + "traits": { + "smithy.api#xmlName": "UnprocessedCluster" + } + } + }, + "com.amazonaws.memorydb#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#ACLNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#ClusterNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidARNFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidClusterStateFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#MultiRegionClusterNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#MultiRegionParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#ParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#SnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#SubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#TagNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#UserNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Use this operation to remove tags on a resource.

" + } + }, + "com.amazonaws.memorydb#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to which the tags are to be removed.

", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.memorydb#KeyList", + "traits": { + "smithy.api#documentation": "

The list of keys of the tags that are to be removed.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.memorydb#UntagResourceResponse": { + "type": "structure", + "members": { + "TagList": { + "target": "com.amazonaws.memorydb#TagList", + "traits": { + "smithy.api#documentation": "

The list of tags removed.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.memorydb#UpdateACL": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#UpdateACLRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#UpdateACLResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#ACLNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#DefaultUserRequired" + }, + { + "target": "com.amazonaws.memorydb#DuplicateUserNameFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidACLStateFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#UserNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Changes the list of users that belong to the Access Control List.

" + } + }, + "com.amazonaws.memorydb#UpdateACLRequest": { + "type": "structure", + "members": { + "ACLName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the Access Control List.

", + "smithy.api#required": {} + } + }, + "UserNamesToAdd": { + "target": "com.amazonaws.memorydb#UserNameListInput", + "traits": { + "smithy.api#documentation": "

The list of users to add to the Access Control List.

" + } + }, + "UserNamesToRemove": { + "target": "com.amazonaws.memorydb#UserNameListInput", + "traits": { + "smithy.api#documentation": "

The list of users to remove from the Access Control List.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.memorydb#UpdateACLResponse": { + "type": "structure", + "members": { + "ACL": { + "target": "com.amazonaws.memorydb#ACL", + "traits": { + "smithy.api#documentation": "

The updated Access Control List.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.memorydb#UpdateCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#UpdateClusterRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#UpdateClusterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#ACLNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#ClusterNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#ClusterQuotaForCustomerExceededFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidACLStateFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidClusterStateFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidKMSKeyFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidNodeStateFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#InvalidVPCNetworkStateFault" + }, + { + "target": "com.amazonaws.memorydb#NodeQuotaForClusterExceededFault" + }, + { + "target": "com.amazonaws.memorydb#NodeQuotaForCustomerExceededFault" + }, + { + "target": "com.amazonaws.memorydb#NoOperationFault" + }, + { + "target": "com.amazonaws.memorydb#ParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#ShardsPerClusterQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies the settings for a cluster. You can use this operation to change one or more cluster configuration settings by specifying the settings and the new values.

" + } + }, + "com.amazonaws.memorydb#UpdateClusterRequest": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the cluster to update.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The description of the cluster to update.

" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.memorydb#SecurityGroupIdsList", + "traits": { + "smithy.api#documentation": "

The SecurityGroupIds to update.

" + } + }, + "MaintenanceWindow": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

Specifies the weekly time range during which maintenance\n on the cluster is performed. It is specified as a range in\n the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum\n maintenance window is a 60 minute period.

\n

Valid values for ddd are:

\n
    \n
  • \n

    \n sun\n

    \n
    • \n
  • \n

    \n mon\n

    \n
    • \n
  • \n

    \n tue\n

    \n
    • \n
  • \n

    \n wed\n

    \n
    • \n
  • \n

    \n thu\n

    \n
    • \n
  • \n

    \n fri\n

    \n
    • \n
  • \n

    \n sat\n

    \n
    • \n
\n

Example: sun:23:00-mon:01:30\n

" + } + }, + "SnsTopicArn": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The SNS topic ARN to update.

" + } + }, + "SnsTopicStatus": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.

" + } + }, + "ParameterGroupName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the parameter group to update.

" + } + }, + "SnapshotWindow": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster.

" + } + }, + "SnapshotRetentionLimit": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days for which MemoryDB retains automatic cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

" + } + }, + "NodeType": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

A valid node type that you want to scale this cluster up or down to.

" + } + }, + "Engine": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the engine to be used for the cluster.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The upgraded version of the engine to be run on the nodes. You can upgrade to a newer engine version, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster and create it anew with the earlier engine version.

" + } + }, + "ReplicaConfiguration": { + "target": "com.amazonaws.memorydb#ReplicaConfigurationRequest", + "traits": { + "smithy.api#documentation": "

The number of replicas that will reside in each shard.

" + } + }, + "ShardConfiguration": { + "target": "com.amazonaws.memorydb#ShardConfigurationRequest", + "traits": { + "smithy.api#documentation": "

The number of shards in the cluster.

" + } + }, + "ACLName": { + "target": "com.amazonaws.memorydb#ACLName", + "traits": { + "smithy.api#documentation": "

The Access Control List that is associated with the cluster.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.memorydb#UpdateClusterResponse": { + "type": "structure", + "members": { + "Cluster": { + "target": "com.amazonaws.memorydb#Cluster", + "traits": { + "smithy.api#documentation": "

The updated cluster.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.memorydb#UpdateMultiRegionCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#UpdateMultiRegionClusterRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#UpdateMultiRegionClusterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#InvalidMultiRegionClusterStateFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#MultiRegionClusterNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#MultiRegionParameterGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the configuration of an existing multi-Region cluster.

" + } + }, + "com.amazonaws.memorydb#UpdateMultiRegionClusterRequest": { + "type": "structure", + "members": { + "MultiRegionClusterName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the multi-Region cluster to be updated.

", + "smithy.api#required": {} + } + }, + "NodeType": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The new node type to be used for the multi-Region cluster.

" + } + }, + "Description": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

A new description for the multi-Region cluster.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The new engine version to be used for the multi-Region cluster.

" + } + }, + "ShardConfiguration": { + "target": "com.amazonaws.memorydb#ShardConfigurationRequest" + }, + "MultiRegionParameterGroupName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The new multi-Region parameter group to be associated with the cluster.

" + } + }, + "UpdateStrategy": { + "target": "com.amazonaws.memorydb#UpdateStrategy", + "traits": { + "smithy.api#documentation": "

Whether to force the update even if it may cause data loss.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.memorydb#UpdateMultiRegionClusterResponse": { + "type": "structure", + "members": { + "MultiRegionCluster": { + "target": "com.amazonaws.memorydb#MultiRegionCluster", + "traits": { + "smithy.api#documentation": "

The status of updating the multi-Region cluster.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.memorydb#UpdateParameterGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#UpdateParameterGroupRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#UpdateParameterGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterGroupStateFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#ParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the parameters of a parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.

" + } + }, + "com.amazonaws.memorydb#UpdateParameterGroupRequest": { + "type": "structure", + "members": { + "ParameterGroupName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the parameter group to update.

", + "smithy.api#required": {} + } + }, + "ParameterNameValues": { + "target": "com.amazonaws.memorydb#ParameterNameValueList", + "traits": { + "smithy.api#documentation": "

An array of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional. A maximum of 20 parameters may be updated per request.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.memorydb#UpdateParameterGroupResponse": { + "type": "structure", + "members": { + "ParameterGroup": { + "target": "com.amazonaws.memorydb#ParameterGroup", + "traits": { + "smithy.api#documentation": "

The updated parameter group

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.memorydb#UpdateStrategy": { + "type": "enum", + "members": { + "COORDINATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "coordinated" + } + }, + "UNCOORDINATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "uncoordinated" + } + } + } + }, + "com.amazonaws.memorydb#UpdateSubnetGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#UpdateSubnetGroupRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#UpdateSubnetGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#InvalidSubnet" + }, + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#SubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#SubnetInUse" + }, + { + "target": "com.amazonaws.memorydb#SubnetNotAllowedFault" + }, + { + "target": "com.amazonaws.memorydb#SubnetQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a subnet group. For more information, see Updating a subnet group\n

" + } + }, + "com.amazonaws.memorydb#UpdateSubnetGroupRequest": { + "type": "structure", + "members": { + "SubnetGroupName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the subnet group

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

A description of the subnet group

" + } + }, + "SubnetIds": { + "target": "com.amazonaws.memorydb#SubnetIdentifierList", + "traits": { + "smithy.api#documentation": "

The EC2 subnet IDs for the subnet group.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.memorydb#UpdateSubnetGroupResponse": { + "type": "structure", + "members": { + "SubnetGroup": { + "target": "com.amazonaws.memorydb#SubnetGroup", + "traits": { + "smithy.api#documentation": "

The updated subnet group

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.memorydb#UpdateUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#UpdateUserRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#UpdateUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#InvalidUserStateFault" + }, + { + "target": "com.amazonaws.memorydb#UserNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Changes user password(s) and/or access string.

" + } + }, + "com.amazonaws.memorydb#UpdateUserRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.memorydb#UserName", + "traits": { + "smithy.api#documentation": "

The name of the user

", + "smithy.api#required": {} + } + }, + "AuthenticationMode": { + "target": "com.amazonaws.memorydb#AuthenticationMode", + "traits": { + "smithy.api#documentation": "

Denotes the user's authentication properties, such as whether it requires a password to authenticate.

" + } + }, + "AccessString": { + "target": "com.amazonaws.memorydb#AccessString", + "traits": { + "smithy.api#documentation": "

Access permissions string used for this user.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.memorydb#UpdateUserResponse": { + "type": "structure", + "members": { + "User": { + "target": "com.amazonaws.memorydb#User", + "traits": { + "smithy.api#documentation": "

The updated user

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.memorydb#User": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the user

" + } + }, + "Status": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

Indicates the user status. Can be \"active\", \"modifying\" or \"deleting\".

" + } + }, + "AccessString": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

Access permissions string used for this user.

" + } + }, + "ACLNames": { + "target": "com.amazonaws.memorydb#ACLNameList", + "traits": { + "smithy.api#documentation": "

The names of the Access Control Lists to which the user belongs

" + } + }, + "MinimumEngineVersion": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The minimum engine version supported for the user

" + } + }, + "Authentication": { + "target": "com.amazonaws.memorydb#Authentication", + "traits": { + "smithy.api#documentation": "

Denotes whether the user requires a password to authenticate.

" + } + }, + "ARN": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user.\n \n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

You create users and assign them specific permissions by using an access string. You assign the users to Access Control Lists aligned with a specific role (administrators, human resources) that are then deployed to one or more MemoryDB clusters.

" + } + }, + "com.amazonaws.memorydb#UserAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "UserAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#UserList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#User" + } + }, + "com.amazonaws.memorydb#UserName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9\\-]*$" + } + }, + "com.amazonaws.memorydb#UserNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#UserName" + } + }, + "com.amazonaws.memorydb#UserNameListInput": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#UserName" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.memorydb#UserNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "UserNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.memorydb#UserQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "UserQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + } + } +} \ No newline at end of file diff --git a/pkg/testdata/codegen/sdk-codegen/aws-models/mq.json b/pkg/testdata/codegen/sdk-codegen/aws-models/mq.json new file mode 100644 index 00000000..a83df820 --- /dev/null +++ b/pkg/testdata/codegen/sdk-codegen/aws-models/mq.json @@ -0,0 +1,5034 @@ +{ + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.mq#ActionRequired": { + "type": "structure", + "members": { + "ActionRequiredCode": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The code you can use to find instructions on the action required to resolve your broker issue.

", + "smithy.api#jsonName": "actionRequiredCode" + } + }, + "ActionRequiredInfo": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

Information about the action required to resolve your broker issue.

", + "smithy.api#jsonName": "actionRequiredInfo" + } + } + }, + "traits": { + "smithy.api#documentation": "

Action required for a broker.

" + } + }, + "com.amazonaws.mq#AuthenticationStrategy": { + "type": "enum", + "members": { + "SIMPLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SIMPLE" + } + }, + "LDAP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LDAP" + } + } + }, + "traits": { + "smithy.api#documentation": "

Optional. The authentication strategy used to secure the broker. The default is SIMPLE.

" + } + }, + "com.amazonaws.mq#AvailabilityZone": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

Id for the availability zone.

", + "smithy.api#jsonName": "name" + } + } + }, + "traits": { + "smithy.api#documentation": "

Name of the availability zone.

" + } + }, + "com.amazonaws.mq#BadRequestException": { + "type": "structure", + "members": { + "ErrorAttribute": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The attribute which caused the error.

", + "smithy.api#jsonName": "errorAttribute" + } + }, + "Message": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The explanation of the error.

", + "smithy.api#jsonName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Returns information about an error.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.mq#BrokerEngineType": { + "type": "structure", + "members": { + "EngineType": { + "target": "com.amazonaws.mq#EngineType", + "traits": { + "smithy.api#documentation": "

The broker's engine type.

", + "smithy.api#jsonName": "engineType" + } + }, + "EngineVersions": { + "target": "com.amazonaws.mq#__listOfEngineVersion", + "traits": { + "smithy.api#documentation": "

The list of engine versions.

", + "smithy.api#jsonName": "engineVersions" + } + } + }, + "traits": { + "smithy.api#documentation": "

Types of broker engines.

" + } + }, + "com.amazonaws.mq#BrokerInstance": { + "type": "structure", + "members": { + "ConsoleURL": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The brokers web console URL.

", + "smithy.api#jsonName": "consoleURL" + } + }, + "Endpoints": { + "target": "com.amazonaws.mq#__listOf__string", + "traits": { + "smithy.api#documentation": "

The broker's wire-level protocol endpoints.

", + "smithy.api#jsonName": "endpoints" + } + }, + "IpAddress": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The IP address of the Elastic Network Interface (ENI) attached to the broker. Does not apply to RabbitMQ brokers.

", + "smithy.api#jsonName": "ipAddress" + } + } + }, + "traits": { + "smithy.api#documentation": "

Returns information about all brokers.

" + } + }, + "com.amazonaws.mq#BrokerInstanceOption": { + "type": "structure", + "members": { + "AvailabilityZones": { + "target": "com.amazonaws.mq#__listOfAvailabilityZone", + "traits": { + "smithy.api#documentation": "

The list of available az.

", + "smithy.api#jsonName": "availabilityZones" + } + }, + "EngineType": { + "target": "com.amazonaws.mq#EngineType", + "traits": { + "smithy.api#documentation": "

The broker's engine type.

", + "smithy.api#jsonName": "engineType" + } + }, + "HostInstanceType": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The broker's instance type.

", + "smithy.api#jsonName": "hostInstanceType" + } + }, + "StorageType": { + "target": "com.amazonaws.mq#BrokerStorageType", + "traits": { + "smithy.api#documentation": "

The broker's storage type.

", + "smithy.api#jsonName": "storageType" + } + }, + "SupportedDeploymentModes": { + "target": "com.amazonaws.mq#__listOfDeploymentMode", + "traits": { + "smithy.api#documentation": "

The list of supported deployment modes.

", + "smithy.api#jsonName": "supportedDeploymentModes" + } + }, + "SupportedEngineVersions": { + "target": "com.amazonaws.mq#__listOf__string", + "traits": { + "smithy.api#documentation": "

The list of supported engine versions.

", + "smithy.api#jsonName": "supportedEngineVersions" + } + } + }, + "traits": { + "smithy.api#documentation": "

Option for host instance type.

" + } + }, + "com.amazonaws.mq#BrokerState": { + "type": "enum", + "members": { + "CREATION_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_IN_PROGRESS" + } + }, + "CREATION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_FAILED" + } + }, + "DELETION_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETION_IN_PROGRESS" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "REBOOT_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REBOOT_IN_PROGRESS" + } + }, + "CRITICAL_ACTION_REQUIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CRITICAL_ACTION_REQUIRED" + } + }, + "REPLICA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REPLICA" + } + } + }, + "traits": { + "smithy.api#documentation": "

The broker's status.

" + } + }, + "com.amazonaws.mq#BrokerStorageType": { + "type": "enum", + "members": { + "EBS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EBS" + } + }, + "EFS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EFS" + } + } + }, + "traits": { + "smithy.api#documentation": "

The broker's storage type.

EFS is not supported for RabbitMQ engine type.

" + } + }, + "com.amazonaws.mq#BrokerSummary": { + "type": "structure", + "members": { + "BrokerArn": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The broker's Amazon Resource Name (ARN).

", + "smithy.api#jsonName": "brokerArn" + } + }, + "BrokerId": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The unique ID that Amazon MQ generates for the broker.

", + "smithy.api#jsonName": "brokerId" + } + }, + "BrokerName": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The broker's name. This value is unique in your Amazon Web Services account, 1-50 characters long, and containing only letters, numbers, dashes, and underscores, and must not contain white spaces, brackets, wildcard characters, or special characters.

", + "smithy.api#jsonName": "brokerName" + } + }, + "BrokerState": { + "target": "com.amazonaws.mq#BrokerState", + "traits": { + "smithy.api#documentation": "

The broker's status.

", + "smithy.api#jsonName": "brokerState" + } + }, + "Created": { + "target": "com.amazonaws.mq#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

The time when the broker was created.

", + "smithy.api#jsonName": "created" + } + }, + "DeploymentMode": { + "target": "com.amazonaws.mq#DeploymentMode", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The broker's deployment mode.

", + "smithy.api#jsonName": "deploymentMode", + "smithy.api#required": {} + } + }, + "EngineType": { + "target": "com.amazonaws.mq#EngineType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of broker engine.

", + "smithy.api#jsonName": "engineType", + "smithy.api#required": {} + } + }, + "HostInstanceType": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The broker's instance type.

", + "smithy.api#jsonName": "hostInstanceType" + } + } + }, + "traits": { + "smithy.api#documentation": "

Returns information about all brokers.

" + } + }, + "com.amazonaws.mq#ChangeType": { + "type": "enum", + "members": { + "CREATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE" + } + }, + "UPDATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE" + } + }, + "DELETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE" + } + } + }, + "traits": { + "smithy.api#documentation": "

The type of change pending for the ActiveMQ user.

" + } + }, + "com.amazonaws.mq#Configuration": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Required. The ARN of the configuration.

", + "smithy.api#jsonName": "arn", + "smithy.api#required": {} + } + }, + "AuthenticationStrategy": { + "target": "com.amazonaws.mq#AuthenticationStrategy", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Optional. The authentication strategy associated with the configuration. The default is SIMPLE.

", + "smithy.api#jsonName": "authenticationStrategy", + "smithy.api#required": {} + } + }, + "Created": { + "target": "com.amazonaws.mq#__timestampIso8601", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Required. The date and time of the configuration revision.

", + "smithy.api#jsonName": "created", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Required. The description of the configuration.

", + "smithy.api#jsonName": "description", + "smithy.api#required": {} + } + }, + "EngineType": { + "target": "com.amazonaws.mq#EngineType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.

", + "smithy.api#jsonName": "engineType", + "smithy.api#required": {} + } + }, + "EngineVersion": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The broker engine version. Defaults to the latest available version for the specified broker engine type. For a list of supported engine versions, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.

", + "smithy.api#jsonName": "engineVersion", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Required. The unique ID that Amazon MQ generates for the configuration.

", + "smithy.api#jsonName": "id", + "smithy.api#required": {} + } + }, + "LatestRevision": { + "target": "com.amazonaws.mq#ConfigurationRevision", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Required. The latest revision of the configuration.

", + "smithy.api#jsonName": "latestRevision", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.

", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.mq#__mapOf__string", + "traits": { + "smithy.api#documentation": "

The list of all tags associated with this configuration.

", + "smithy.api#jsonName": "tags" + } + } + }, + "traits": { + "smithy.api#documentation": "

Returns information about all configurations.

" + } + }, + "com.amazonaws.mq#ConfigurationId": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Required. The unique ID that Amazon MQ generates for the configuration.

", + "smithy.api#jsonName": "id", + "smithy.api#required": {} + } + }, + "Revision": { + "target": "com.amazonaws.mq#__integer", + "traits": { + "smithy.api#documentation": "

The revision number of the configuration.

", + "smithy.api#jsonName": "revision" + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of information about the configuration.

" + } + }, + "com.amazonaws.mq#ConfigurationRevision": { + "type": "structure", + "members": { + "Created": { + "target": "com.amazonaws.mq#__timestampIso8601", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Required. The date and time of the configuration revision.

", + "smithy.api#jsonName": "created", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The description of the configuration revision.

", + "smithy.api#jsonName": "description" + } + }, + "Revision": { + "target": "com.amazonaws.mq#__integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Required. The revision number of the configuration.

", + "smithy.api#jsonName": "revision", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Returns information about the specified configuration revision.

" + } + }, + "com.amazonaws.mq#Configurations": { + "type": "structure", + "members": { + "Current": { + "target": "com.amazonaws.mq#ConfigurationId", + "traits": { + "smithy.api#documentation": "

The broker's current configuration.

", + "smithy.api#jsonName": "current" + } + }, + "History": { + "target": "com.amazonaws.mq#__listOfConfigurationId", + "traits": { + "smithy.api#documentation": "

The history of configurations applied to the broker.

", + "smithy.api#jsonName": "history" + } + }, + "Pending": { + "target": "com.amazonaws.mq#ConfigurationId", + "traits": { + "smithy.api#documentation": "

The broker's pending configuration.

", + "smithy.api#jsonName": "pending" + } + } + }, + "traits": { + "smithy.api#documentation": "

Broker configuration information

" + } + }, + "com.amazonaws.mq#ConflictException": { + "type": "structure", + "members": { + "ErrorAttribute": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The attribute which caused the error.

", + "smithy.api#jsonName": "errorAttribute" + } + }, + "Message": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The explanation of the error.

", + "smithy.api#jsonName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Returns information about an error.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.mq#CreateBroker": { + "type": "operation", + "input": { + "target": "com.amazonaws.mq#CreateBrokerRequest" + }, + "output": { + "target": "com.amazonaws.mq#CreateBrokerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mq#BadRequestException" + }, + { + "target": "com.amazonaws.mq#ConflictException" + }, + { + "target": "com.amazonaws.mq#ForbiddenException" + }, + { + "target": "com.amazonaws.mq#InternalServerErrorException" + }, + { + "target": "com.amazonaws.mq#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a broker. Note: This API is asynchronous.

To create a broker, you must either use the AmazonMQFullAccess IAM policy or include the following EC2 permissions in your IAM policy.

  • ec2:CreateNetworkInterface

    This permission is required to allow Amazon MQ to create an elastic network interface (ENI) on behalf of your account.

  • ec2:CreateNetworkInterfacePermission

    This permission is required to attach the ENI to the broker instance.

  • ec2:DeleteNetworkInterface

  • ec2:DeleteNetworkInterfacePermission

  • ec2:DetachNetworkInterface

  • ec2:DescribeInternetGateways

  • ec2:DescribeNetworkInterfaces

  • ec2:DescribeNetworkInterfacePermissions

  • ec2:DescribeRouteTables

  • ec2:DescribeSecurityGroups

  • ec2:DescribeSubnets

  • ec2:DescribeVpcs

For more information, see Create an IAM User and Get Your Amazon Web Services Credentials and Never Modify or Delete the Amazon MQ Elastic Network Interface in the Amazon MQ Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/brokers", + "code": 200 + } + } + }, + "com.amazonaws.mq#CreateBrokerRequest": { + "type": "structure", + "members": { + "AuthenticationStrategy": { + "target": "com.amazonaws.mq#AuthenticationStrategy", + "traits": { + "smithy.api#documentation": "

Optional. The authentication strategy used to secure the broker. The default is SIMPLE.

", + "smithy.api#jsonName": "authenticationStrategy" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.mq#__boolean", + "traits": { + "smithy.api#documentation": "

Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot. Set to true by default, if no value is specified.

Must be set to true for ActiveMQ brokers version 5.18 and above and for RabbitMQ brokers version 3.13 and above.

", + "smithy.api#jsonName": "autoMinorVersionUpgrade" + } + }, + "BrokerName": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Required. The broker's name. This value must be unique in your Amazon Web Services account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain white spaces, brackets, wildcard characters, or special characters.

Do not add personally identifiable information (PII) or other confidential or sensitive information in broker names. Broker names are accessible to other Amazon Web Services services, including CloudWatch Logs. Broker names are not intended to be used for private or sensitive data.

", + "smithy.api#jsonName": "brokerName", + "smithy.api#required": {} + } + }, + "Configuration": { + "target": "com.amazonaws.mq#ConfigurationId", + "traits": { + "smithy.api#documentation": "

A list of information about the configuration.

", + "smithy.api#jsonName": "configuration" + } + }, + "CreatorRequestId": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The unique ID that the requester receives for the created broker. Amazon MQ passes your ID with the API action.

We recommend using a Universally Unique Identifier (UUID) for the creatorRequestId. You may omit the creatorRequestId if your application doesn't require idempotency.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#jsonName": "creatorRequestId" + } + }, + "DeploymentMode": { + "target": "com.amazonaws.mq#DeploymentMode", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Required. The broker's deployment mode.

", + "smithy.api#jsonName": "deploymentMode", + "smithy.api#required": {} + } + }, + "EncryptionOptions": { + "target": "com.amazonaws.mq#EncryptionOptions", + "traits": { + "smithy.api#documentation": "

Encryption options for the broker.

", + "smithy.api#jsonName": "encryptionOptions" + } + }, + "EngineType": { + "target": "com.amazonaws.mq#EngineType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.

", + "smithy.api#jsonName": "engineType", + "smithy.api#required": {} + } + }, + "EngineVersion": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The broker engine version. Defaults to the latest available version for the specified broker engine type. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.

", + "smithy.api#jsonName": "engineVersion" + } + }, + "HostInstanceType": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Required. The broker's instance type.

", + "smithy.api#jsonName": "hostInstanceType", + "smithy.api#required": {} + } + }, + "LdapServerMetadata": { + "target": "com.amazonaws.mq#LdapServerMetadataInput", + "traits": { + "smithy.api#documentation": "

Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.

", + "smithy.api#jsonName": "ldapServerMetadata" + } + }, + "Logs": { + "target": "com.amazonaws.mq#Logs", + "traits": { + "smithy.api#documentation": "

Enables Amazon CloudWatch logging for brokers.

", + "smithy.api#jsonName": "logs" + } + }, + "MaintenanceWindowStartTime": { + "target": "com.amazonaws.mq#WeeklyStartTime", + "traits": { + "smithy.api#documentation": "

The parameters that determine the WeeklyStartTime.

", + "smithy.api#jsonName": "maintenanceWindowStartTime" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.mq#__boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Enables connections from applications outside of the VPC that hosts the broker's subnets. Set to false by default, if no value is provided.

", + "smithy.api#jsonName": "publiclyAccessible", + "smithy.api#required": {} + } + }, + "SecurityGroups": { + "target": "com.amazonaws.mq#__listOf__string", + "traits": { + "smithy.api#documentation": "

The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.

", + "smithy.api#jsonName": "securityGroups" + } + }, + "StorageType": { + "target": "com.amazonaws.mq#BrokerStorageType", + "traits": { + "smithy.api#documentation": "

The broker's storage type.

", + "smithy.api#jsonName": "storageType" + } + }, + "SubnetIds": { + "target": "com.amazonaws.mq#__listOf__string", + "traits": { + "smithy.api#documentation": "

The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones. If you specify more than one subnet, the subnets must be in different Availability Zones. Amazon MQ will not be able to create VPC endpoints for your broker with multiple subnets in the same Availability Zone. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ Amazon MQ for ActiveMQ deployment requires two subnets. A CLUSTER_MULTI_AZ Amazon MQ for RabbitMQ deployment has no subnet requirements when deployed with public accessibility. Deployment without public accessibility requires at least one subnet.

If you specify subnets in a shared VPC for a RabbitMQ broker, the associated VPC to which the specified subnets belong must be owned by your Amazon Web Services account. Amazon MQ will not be able to create VPC endpoints in VPCs that are not owned by your Amazon Web Services account.

", + "smithy.api#jsonName": "subnetIds" + } + }, + "Tags": { + "target": "com.amazonaws.mq#__mapOf__string", + "traits": { + "smithy.api#documentation": "

Create tags when creating the broker.

", + "smithy.api#jsonName": "tags" + } + }, + "Users": { + "target": "com.amazonaws.mq#__listOfUser", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The list of broker users (persons or applications) who can access queues and topics. For Amazon MQ for RabbitMQ brokers, one and only one administrative user is accepted and created when a broker is first provisioned. All subsequent broker users are created by making RabbitMQ API calls directly to brokers or via the RabbitMQ web console.

", + "smithy.api#jsonName": "users", + "smithy.api#required": {} + } + }, + "DataReplicationMode": { + "target": "com.amazonaws.mq#DataReplicationMode", + "traits": { + "smithy.api#documentation": "

Defines whether this broker is a part of a data replication pair.

", + "smithy.api#jsonName": "dataReplicationMode" + } + }, + "DataReplicationPrimaryBrokerArn": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the primary broker that is used to replicate data from in a data replication pair, and is applied to the replica broker. Must be set when dataReplicationMode is set to CRDR.

", + "smithy.api#jsonName": "dataReplicationPrimaryBrokerArn" + } + } + }, + "traits": { + "smithy.api#documentation": "

Creates a broker using the specified properties.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.mq#CreateBrokerResponse": { + "type": "structure", + "members": { + "BrokerArn": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The broker's Amazon Resource Name (ARN).

", + "smithy.api#jsonName": "brokerArn" + } + }, + "BrokerId": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The unique ID that Amazon MQ generates for the broker.

", + "smithy.api#jsonName": "brokerId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.mq#CreateConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.mq#CreateConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.mq#CreateConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mq#BadRequestException" + }, + { + "target": "com.amazonaws.mq#ConflictException" + }, + { + "target": "com.amazonaws.mq#ForbiddenException" + }, + { + "target": "com.amazonaws.mq#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version).

", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/configurations", + "code": 200 + } + } + }, + "com.amazonaws.mq#CreateConfigurationRequest": { + "type": "structure", + "members": { + "AuthenticationStrategy": { + "target": "com.amazonaws.mq#AuthenticationStrategy", + "traits": { + "smithy.api#documentation": "

Optional. The authentication strategy associated with the configuration. The default is SIMPLE.

", + "smithy.api#jsonName": "authenticationStrategy" + } + }, + "EngineType": { + "target": "com.amazonaws.mq#EngineType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.

", + "smithy.api#jsonName": "engineType", + "smithy.api#required": {} + } + }, + "EngineVersion": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The broker engine version. Defaults to the latest available version for the specified broker engine type. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.

", + "smithy.api#jsonName": "engineVersion" + } + }, + "Name": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.

", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.mq#__mapOf__string", + "traits": { + "smithy.api#documentation": "

Create tags when creating the configuration.

", + "smithy.api#jsonName": "tags" + } + } + }, + "traits": { + "smithy.api#documentation": "

Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version).

", + "smithy.api#input": {} + } + }, + "com.amazonaws.mq#CreateConfigurationResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

Required. The Amazon Resource Name (ARN) of the configuration.

", + "smithy.api#jsonName": "arn" + } + }, + "AuthenticationStrategy": { + "target": "com.amazonaws.mq#AuthenticationStrategy", + "traits": { + "smithy.api#documentation": "

Optional. The authentication strategy associated with the configuration. The default is SIMPLE.

", + "smithy.api#jsonName": "authenticationStrategy" + } + }, + "Created": { + "target": "com.amazonaws.mq#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

Required. The date and time of the configuration.

", + "smithy.api#jsonName": "created" + } + }, + "Id": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

Required. The unique ID that Amazon MQ generates for the configuration.

", + "smithy.api#jsonName": "id" + } + }, + "LatestRevision": { + "target": "com.amazonaws.mq#ConfigurationRevision", + "traits": { + "smithy.api#documentation": "

The latest revision of the configuration.

", + "smithy.api#jsonName": "latestRevision" + } + }, + "Name": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.

", + "smithy.api#jsonName": "name" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.mq#CreateTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.mq#CreateTagsRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.mq#BadRequestException" + }, + { + "target": "com.amazonaws.mq#ForbiddenException" + }, + { + "target": "com.amazonaws.mq#InternalServerErrorException" + }, + { + "target": "com.amazonaws.mq#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Add a tag to a resource.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/tags/{ResourceArn}", + "code": 204 + } + } + }, + "com.amazonaws.mq#CreateTagsRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource tag.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.mq#__mapOf__string", + "traits": { + "smithy.api#documentation": "

The key-value pair for the resource tag.

", + "smithy.api#jsonName": "tags" + } + } + }, + "traits": { + "smithy.api#documentation": "

A map of the key-value pairs for the resource tag.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.mq#CreateUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.mq#CreateUserRequest" + }, + "output": { + "target": "com.amazonaws.mq#CreateUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mq#BadRequestException" + }, + { + "target": "com.amazonaws.mq#ConflictException" + }, + { + "target": "com.amazonaws.mq#ForbiddenException" + }, + { + "target": "com.amazonaws.mq#InternalServerErrorException" + }, + { + "target": "com.amazonaws.mq#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an ActiveMQ user.

Do not add personally identifiable information (PII) or other confidential or sensitive information in broker usernames. Broker usernames are accessible to other Amazon Web Services services, including CloudWatch Logs. Broker usernames are not intended to be used for private or sensitive data.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/brokers/{BrokerId}/users/{Username}", + "code": 200 + } + } + }, + "com.amazonaws.mq#CreateUserRequest": { + "type": "structure", + "members": { + "BrokerId": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The unique ID that Amazon MQ generates for the broker.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ConsoleAccess": { + "target": "com.amazonaws.mq#__boolean", + "traits": { + "smithy.api#documentation": "

Enables access to the ActiveMQ Web Console for the ActiveMQ user.

", + "smithy.api#jsonName": "consoleAccess" + } + }, + "Groups": { + "target": "com.amazonaws.mq#__listOf__string", + "traits": { + "smithy.api#documentation": "

The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

", + "smithy.api#jsonName": "groups" + } + }, + "Password": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Required. The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas, colons, or equal signs (,:=).

", + "smithy.api#jsonName": "password", + "smithy.api#required": {} + } + }, + "Username": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ReplicationUser": { + "target": "com.amazonaws.mq#__boolean", + "traits": { + "smithy.api#documentation": "

Defines if this user is intended for CRDR replication purposes.

", + "smithy.api#jsonName": "replicationUser" + } + } + }, + "traits": { + "smithy.api#documentation": "

Creates a new ActiveMQ user.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.mq#CreateUserResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.mq#DataReplicationCounterpart": { + "type": "structure", + "members": { + "BrokerId": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Required. The unique broker id generated by Amazon MQ.

", + "smithy.api#jsonName": "brokerId", + "smithy.api#required": {} + } + }, + "Region": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Required. The region of the broker.

", + "smithy.api#jsonName": "region", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies a broker in a data replication pair.

" + } + }, + "com.amazonaws.mq#DataReplicationMetadataOutput": { + "type": "structure", + "members": { + "DataReplicationCounterpart": { + "target": "com.amazonaws.mq#DataReplicationCounterpart", + "traits": { + "smithy.api#documentation": "

Describes the replica/primary broker. Only returned if this broker is currently set as a primary or replica in the broker's dataReplicationRole property.

", + "smithy.api#jsonName": "dataReplicationCounterpart" + } + }, + "DataReplicationRole": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Defines the role of this broker in a data replication pair. When a replica broker is promoted to primary, this role is interchanged.

", + "smithy.api#jsonName": "dataReplicationRole", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The replication details of the data replication-enabled broker. Only returned if dataReplicationMode or pendingDataReplicationMode is set to CRDR.

" + } + }, + "com.amazonaws.mq#DataReplicationMode": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "CRDR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CRDR" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies whether a broker is a part of a data replication pair.

" + } + }, + "com.amazonaws.mq#DayOfWeek": { + "type": "enum", + "members": { + "MONDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MONDAY" + } + }, + "TUESDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TUESDAY" + } + }, + "WEDNESDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WEDNESDAY" + } + }, + "THURSDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THURSDAY" + } + }, + "FRIDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FRIDAY" + } + }, + "SATURDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SATURDAY" + } + }, + "SUNDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUNDAY" + } + } + } + }, + "com.amazonaws.mq#DeleteBroker": { + "type": "operation", + "input": { + "target": "com.amazonaws.mq#DeleteBrokerRequest" + }, + "output": { + "target": "com.amazonaws.mq#DeleteBrokerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mq#BadRequestException" + }, + { + "target": "com.amazonaws.mq#ForbiddenException" + }, + { + "target": "com.amazonaws.mq#InternalServerErrorException" + }, + { + "target": "com.amazonaws.mq#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a broker. Note: This API is asynchronous.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/v1/brokers/{BrokerId}", + "code": 200 + } + } + }, + "com.amazonaws.mq#DeleteBrokerRequest": { + "type": "structure", + "members": { + "BrokerId": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The unique ID that Amazon MQ generates for the broker.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.mq#DeleteBrokerResponse": { + "type": "structure", + "members": { + "BrokerId": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The unique ID that Amazon MQ generates for the broker.

", + "smithy.api#jsonName": "brokerId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.mq#DeleteTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.mq#DeleteTagsRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.mq#BadRequestException" + }, + { + "target": "com.amazonaws.mq#ForbiddenException" + }, + { + "target": "com.amazonaws.mq#InternalServerErrorException" + }, + { + "target": "com.amazonaws.mq#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes a tag from a resource.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/v1/tags/{ResourceArn}", + "code": 204 + } + } + }, + "com.amazonaws.mq#DeleteTagsRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource tag.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.mq#__listOf__string", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An array of tag keys to delete

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.mq#DeleteUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.mq#DeleteUserRequest" + }, + "output": { + "target": "com.amazonaws.mq#DeleteUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mq#BadRequestException" + }, + { + "target": "com.amazonaws.mq#ForbiddenException" + }, + { + "target": "com.amazonaws.mq#InternalServerErrorException" + }, + { + "target": "com.amazonaws.mq#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an ActiveMQ user.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/v1/brokers/{BrokerId}/users/{Username}", + "code": 200 + } + } + }, + "com.amazonaws.mq#DeleteUserRequest": { + "type": "structure", + "members": { + "BrokerId": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The unique ID that Amazon MQ generates for the broker.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Username": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.mq#DeleteUserResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.mq#DeploymentMode": { + "type": "enum", + "members": { + "SINGLE_INSTANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SINGLE_INSTANCE" + } + }, + "ACTIVE_STANDBY_MULTI_AZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE_STANDBY_MULTI_AZ" + } + }, + "CLUSTER_MULTI_AZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLUSTER_MULTI_AZ" + } + } + }, + "traits": { + "smithy.api#documentation": "

The broker's deployment mode.

" + } + }, + "com.amazonaws.mq#DescribeBroker": { + "type": "operation", + "input": { + "target": "com.amazonaws.mq#DescribeBrokerRequest" + }, + "output": { + "target": "com.amazonaws.mq#DescribeBrokerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mq#BadRequestException" + }, + { + "target": "com.amazonaws.mq#ForbiddenException" + }, + { + "target": "com.amazonaws.mq#InternalServerErrorException" + }, + { + "target": "com.amazonaws.mq#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about the specified broker.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/brokers/{BrokerId}", + "code": 200 + } + } + }, + "com.amazonaws.mq#DescribeBrokerEngineTypes": { + "type": "operation", + "input": { + "target": "com.amazonaws.mq#DescribeBrokerEngineTypesRequest" + }, + "output": { + "target": "com.amazonaws.mq#DescribeBrokerEngineTypesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mq#BadRequestException" + }, + { + "target": "com.amazonaws.mq#ForbiddenException" + }, + { + "target": "com.amazonaws.mq#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "

Describe available engine types and versions.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/broker-engine-types", + "code": 200 + } + } + }, + "com.amazonaws.mq#DescribeBrokerEngineTypesRequest": { + "type": "structure", + "members": { + "EngineType": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

Filter response by engine type.

", + "smithy.api#httpQuery": "engineType" + } + }, + "MaxResults": { + "target": "com.amazonaws.mq#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of brokers that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.mq#DescribeBrokerEngineTypesResponse": { + "type": "structure", + "members": { + "BrokerEngineTypes": { + "target": "com.amazonaws.mq#__listOfBrokerEngineType", + "traits": { + "smithy.api#documentation": "

List of available engine types and versions.

", + "smithy.api#jsonName": "brokerEngineTypes" + } + }, + "MaxResults": { + "target": "com.amazonaws.mq#__integerMin5Max100", + "traits": { + "smithy.api#documentation": "

Required. The maximum number of engine types that can be returned per page (20 by default). This value must be an integer from 5 to 100.

", + "smithy.api#jsonName": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.mq#DescribeBrokerInstanceOptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.mq#DescribeBrokerInstanceOptionsRequest" + }, + "output": { + "target": "com.amazonaws.mq#DescribeBrokerInstanceOptionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mq#BadRequestException" + }, + { + "target": "com.amazonaws.mq#ForbiddenException" + }, + { + "target": "com.amazonaws.mq#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "

Describe available broker instance options.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/broker-instance-options", + "code": 200 + } + } + }, + "com.amazonaws.mq#DescribeBrokerInstanceOptionsRequest": { + "type": "structure", + "members": { + "EngineType": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

Filter response by engine type.

", + "smithy.api#httpQuery": "engineType" + } + }, + "HostInstanceType": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

Filter response by host instance type.

", + "smithy.api#httpQuery": "hostInstanceType" + } + }, + "MaxResults": { + "target": "com.amazonaws.mq#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of brokers that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "StorageType": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

Filter response by storage type.

", + "smithy.api#httpQuery": "storageType" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.mq#DescribeBrokerInstanceOptionsResponse": { + "type": "structure", + "members": { + "BrokerInstanceOptions": { + "target": "com.amazonaws.mq#__listOfBrokerInstanceOption", + "traits": { + "smithy.api#documentation": "

List of available broker instance options.

", + "smithy.api#jsonName": "brokerInstanceOptions" + } + }, + "MaxResults": { + "target": "com.amazonaws.mq#__integerMin5Max100", + "traits": { + "smithy.api#documentation": "

Required. The maximum number of instance options that can be returned per page (20 by default). This value must be an integer from 5 to 100.

", + "smithy.api#jsonName": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.mq#DescribeBrokerRequest": { + "type": "structure", + "members": { + "BrokerId": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The unique ID that Amazon MQ generates for the broker.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.mq#DescribeBrokerResponse": { + "type": "structure", + "members": { + "ActionsRequired": { + "target": "com.amazonaws.mq#__listOfActionRequired", + "traits": { + "smithy.api#documentation": "

Actions required for a broker.

", + "smithy.api#jsonName": "actionsRequired" + } + }, + "AuthenticationStrategy": { + "target": "com.amazonaws.mq#AuthenticationStrategy", + "traits": { + "smithy.api#documentation": "

The authentication strategy used to secure the broker. The default is SIMPLE.

", + "smithy.api#jsonName": "authenticationStrategy" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.mq#__boolean", + "traits": { + "smithy.api#documentation": "

Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot.

", + "smithy.api#jsonName": "autoMinorVersionUpgrade" + } + }, + "BrokerArn": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The broker's Amazon Resource Name (ARN).

", + "smithy.api#jsonName": "brokerArn" + } + }, + "BrokerId": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The unique ID that Amazon MQ generates for the broker.

", + "smithy.api#jsonName": "brokerId" + } + }, + "BrokerInstances": { + "target": "com.amazonaws.mq#__listOfBrokerInstance", + "traits": { + "smithy.api#documentation": "

A list of information about allocated brokers.

", + "smithy.api#jsonName": "brokerInstances" + } + }, + "BrokerName": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The broker's name. This value must be unique in your Amazon Web Services account account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain white spaces, brackets, wildcard characters, or special characters.

", + "smithy.api#jsonName": "brokerName" + } + }, + "BrokerState": { + "target": "com.amazonaws.mq#BrokerState", + "traits": { + "smithy.api#documentation": "

The broker's status.

", + "smithy.api#jsonName": "brokerState" + } + }, + "Configurations": { + "target": "com.amazonaws.mq#Configurations", + "traits": { + "smithy.api#documentation": "

The list of all revisions for the specified configuration.

", + "smithy.api#jsonName": "configurations" + } + }, + "Created": { + "target": "com.amazonaws.mq#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

The time when the broker was created.

", + "smithy.api#jsonName": "created" + } + }, + "DeploymentMode": { + "target": "com.amazonaws.mq#DeploymentMode", + "traits": { + "smithy.api#documentation": "

The broker's deployment mode.

", + "smithy.api#jsonName": "deploymentMode" + } + }, + "EncryptionOptions": { + "target": "com.amazonaws.mq#EncryptionOptions", + "traits": { + "smithy.api#documentation": "

Encryption options for the broker.

", + "smithy.api#jsonName": "encryptionOptions" + } + }, + "EngineType": { + "target": "com.amazonaws.mq#EngineType", + "traits": { + "smithy.api#documentation": "

The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.

", + "smithy.api#jsonName": "engineType" + } + }, + "EngineVersion": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The broker engine version. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.

", + "smithy.api#jsonName": "engineVersion" + } + }, + "HostInstanceType": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The broker's instance type.

", + "smithy.api#jsonName": "hostInstanceType" + } + }, + "LdapServerMetadata": { + "target": "com.amazonaws.mq#LdapServerMetadataOutput", + "traits": { + "smithy.api#documentation": "

The metadata of the LDAP server used to authenticate and authorize connections to the broker.

", + "smithy.api#jsonName": "ldapServerMetadata" + } + }, + "Logs": { + "target": "com.amazonaws.mq#LogsSummary", + "traits": { + "smithy.api#documentation": "

The list of information about logs currently enabled and pending to be deployed for the specified broker.

", + "smithy.api#jsonName": "logs" + } + }, + "MaintenanceWindowStartTime": { + "target": "com.amazonaws.mq#WeeklyStartTime", + "traits": { + "smithy.api#documentation": "

The parameters that determine the WeeklyStartTime.

", + "smithy.api#jsonName": "maintenanceWindowStartTime" + } + }, + "PendingAuthenticationStrategy": { + "target": "com.amazonaws.mq#AuthenticationStrategy", + "traits": { + "smithy.api#documentation": "

The authentication strategy that will be applied when the broker is rebooted. The default is SIMPLE.

", + "smithy.api#jsonName": "pendingAuthenticationStrategy" + } + }, + "PendingEngineVersion": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The broker engine version to upgrade to. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.

", + "smithy.api#jsonName": "pendingEngineVersion" + } + }, + "PendingHostInstanceType": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The broker's host instance type to upgrade to. For a list of supported instance types, see Broker instance types.

", + "smithy.api#jsonName": "pendingHostInstanceType" + } + }, + "PendingLdapServerMetadata": { + "target": "com.amazonaws.mq#LdapServerMetadataOutput", + "traits": { + "smithy.api#documentation": "

The metadata of the LDAP server that will be used to authenticate and authorize connections to the broker after it is rebooted.

", + "smithy.api#jsonName": "pendingLdapServerMetadata" + } + }, + "PendingSecurityGroups": { + "target": "com.amazonaws.mq#__listOf__string", + "traits": { + "smithy.api#documentation": "

The list of pending security groups to authorize connections to brokers.

", + "smithy.api#jsonName": "pendingSecurityGroups" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.mq#__boolean", + "traits": { + "smithy.api#documentation": "

Enables connections from applications outside of the VPC that hosts the broker's subnets.

", + "smithy.api#jsonName": "publiclyAccessible" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.mq#__listOf__string", + "traits": { + "smithy.api#documentation": "

The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.

", + "smithy.api#jsonName": "securityGroups" + } + }, + "StorageType": { + "target": "com.amazonaws.mq#BrokerStorageType", + "traits": { + "smithy.api#documentation": "

The broker's storage type.

", + "smithy.api#jsonName": "storageType" + } + }, + "SubnetIds": { + "target": "com.amazonaws.mq#__listOf__string", + "traits": { + "smithy.api#documentation": "

The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.

", + "smithy.api#jsonName": "subnetIds" + } + }, + "Tags": { + "target": "com.amazonaws.mq#__mapOf__string", + "traits": { + "smithy.api#documentation": "

The list of all tags associated with this broker.

", + "smithy.api#jsonName": "tags" + } + }, + "Users": { + "target": "com.amazonaws.mq#__listOfUserSummary", + "traits": { + "smithy.api#documentation": "

The list of all broker usernames for the specified broker.

", + "smithy.api#jsonName": "users" + } + }, + "DataReplicationMetadata": { + "target": "com.amazonaws.mq#DataReplicationMetadataOutput", + "traits": { + "smithy.api#documentation": "

The replication details of the data replication-enabled broker. Only returned if dataReplicationMode is set to CRDR.

", + "smithy.api#jsonName": "dataReplicationMetadata" + } + }, + "DataReplicationMode": { + "target": "com.amazonaws.mq#DataReplicationMode", + "traits": { + "smithy.api#documentation": "

Describes whether this broker is a part of a data replication pair.

", + "smithy.api#jsonName": "dataReplicationMode" + } + }, + "PendingDataReplicationMetadata": { + "target": "com.amazonaws.mq#DataReplicationMetadataOutput", + "traits": { + "smithy.api#documentation": "

The pending replication details of the data replication-enabled broker. Only returned if pendingDataReplicationMode is set to CRDR.

", + "smithy.api#jsonName": "pendingDataReplicationMetadata" + } + }, + "PendingDataReplicationMode": { + "target": "com.amazonaws.mq#DataReplicationMode", + "traits": { + "smithy.api#documentation": "

Describes whether this broker will be a part of a data replication pair after reboot.

", + "smithy.api#jsonName": "pendingDataReplicationMode" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.mq#DescribeConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.mq#DescribeConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.mq#DescribeConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mq#BadRequestException" + }, + { + "target": "com.amazonaws.mq#ForbiddenException" + }, + { + "target": "com.amazonaws.mq#InternalServerErrorException" + }, + { + "target": "com.amazonaws.mq#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about the specified configuration.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/configurations/{ConfigurationId}", + "code": 200 + } + } + }, + "com.amazonaws.mq#DescribeConfigurationRequest": { + "type": "structure", + "members": { + "ConfigurationId": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The unique ID that Amazon MQ generates for the configuration.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.mq#DescribeConfigurationResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

Required. The ARN of the configuration.

", + "smithy.api#jsonName": "arn" + } + }, + "AuthenticationStrategy": { + "target": "com.amazonaws.mq#AuthenticationStrategy", + "traits": { + "smithy.api#documentation": "

Optional. The authentication strategy associated with the configuration. The default is SIMPLE.

", + "smithy.api#jsonName": "authenticationStrategy" + } + }, + "Created": { + "target": "com.amazonaws.mq#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

Required. The date and time of the configuration revision.

", + "smithy.api#jsonName": "created" + } + }, + "Description": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

Required. The description of the configuration.

", + "smithy.api#jsonName": "description" + } + }, + "EngineType": { + "target": "com.amazonaws.mq#EngineType", + "traits": { + "smithy.api#documentation": "

Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.

", + "smithy.api#jsonName": "engineType" + } + }, + "EngineVersion": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The broker engine version. Defaults to the latest available version for the specified broker engine type. For a list of supported engine versions, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.

", + "smithy.api#jsonName": "engineVersion" + } + }, + "Id": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

Required. The unique ID that Amazon MQ generates for the configuration.

", + "smithy.api#jsonName": "id" + } + }, + "LatestRevision": { + "target": "com.amazonaws.mq#ConfigurationRevision", + "traits": { + "smithy.api#documentation": "

Required. The latest revision of the configuration.

", + "smithy.api#jsonName": "latestRevision" + } + }, + "Name": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.

", + "smithy.api#jsonName": "name" + } + }, + "Tags": { + "target": "com.amazonaws.mq#__mapOf__string", + "traits": { + "smithy.api#documentation": "

The list of all tags associated with this configuration.

", + "smithy.api#jsonName": "tags" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.mq#DescribeConfigurationRevision": { + "type": "operation", + "input": { + "target": "com.amazonaws.mq#DescribeConfigurationRevisionRequest" + }, + "output": { + "target": "com.amazonaws.mq#DescribeConfigurationRevisionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mq#BadRequestException" + }, + { + "target": "com.amazonaws.mq#ForbiddenException" + }, + { + "target": "com.amazonaws.mq#InternalServerErrorException" + }, + { + "target": "com.amazonaws.mq#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the specified configuration revision for the specified configuration.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/configurations/{ConfigurationId}/revisions/{ConfigurationRevision}", + "code": 200 + } + } + }, + "com.amazonaws.mq#DescribeConfigurationRevisionRequest": { + "type": "structure", + "members": { + "ConfigurationId": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The unique ID that Amazon MQ generates for the configuration.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ConfigurationRevision": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The revision of the configuration.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.mq#DescribeConfigurationRevisionResponse": { + "type": "structure", + "members": { + "ConfigurationId": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

Required. The unique ID that Amazon MQ generates for the configuration.

", + "smithy.api#jsonName": "configurationId" + } + }, + "Created": { + "target": "com.amazonaws.mq#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

Required. The date and time of the configuration.

", + "smithy.api#jsonName": "created" + } + }, + "Data": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

Amazon MQ for ActiveMQ: the base64-encoded XML configuration. Amazon MQ for RabbitMQ: base64-encoded Cuttlefish.

", + "smithy.api#jsonName": "data" + } + }, + "Description": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The description of the configuration.

", + "smithy.api#jsonName": "description" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.mq#DescribeUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.mq#DescribeUserRequest" + }, + "output": { + "target": "com.amazonaws.mq#DescribeUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mq#BadRequestException" + }, + { + "target": "com.amazonaws.mq#ForbiddenException" + }, + { + "target": "com.amazonaws.mq#InternalServerErrorException" + }, + { + "target": "com.amazonaws.mq#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about an ActiveMQ user.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/brokers/{BrokerId}/users/{Username}", + "code": 200 + } + } + }, + "com.amazonaws.mq#DescribeUserRequest": { + "type": "structure", + "members": { + "BrokerId": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The unique ID that Amazon MQ generates for the broker.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Username": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.mq#DescribeUserResponse": { + "type": "structure", + "members": { + "BrokerId": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

Required. The unique ID that Amazon MQ generates for the broker.

", + "smithy.api#jsonName": "brokerId" + } + }, + "ConsoleAccess": { + "target": "com.amazonaws.mq#__boolean", + "traits": { + "smithy.api#documentation": "

Enables access to the the ActiveMQ Web Console for the ActiveMQ user.

", + "smithy.api#jsonName": "consoleAccess" + } + }, + "Groups": { + "target": "com.amazonaws.mq#__listOf__string", + "traits": { + "smithy.api#documentation": "

The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

", + "smithy.api#jsonName": "groups" + } + }, + "Pending": { + "target": "com.amazonaws.mq#UserPendingChanges", + "traits": { + "smithy.api#documentation": "

The status of the changes pending for the ActiveMQ user.

", + "smithy.api#jsonName": "pending" + } + }, + "Username": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

Required. The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

", + "smithy.api#jsonName": "username" + } + }, + "ReplicationUser": { + "target": "com.amazonaws.mq#__boolean", + "traits": { + "smithy.api#documentation": "

Describes whether the user is intended for data replication

", + "smithy.api#jsonName": "replicationUser" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.mq#EncryptionOptions": { + "type": "structure", + "members": { + "KmsKeyId": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The customer master key (CMK) to use for the A KMS (KMS). This key is used to encrypt your data at rest. If not provided, Amazon MQ will use a default CMK to encrypt your data.

", + "smithy.api#jsonName": "kmsKeyId" + } + }, + "UseAwsOwnedKey": { + "target": "com.amazonaws.mq#__boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Enables the use of an Amazon Web Services owned CMK using KMS (KMS). Set to true by default, if no value is provided, for example, for RabbitMQ brokers.

", + "smithy.api#jsonName": "useAwsOwnedKey", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Encryption options for the broker.

" + } + }, + "com.amazonaws.mq#EngineType": { + "type": "enum", + "members": { + "ACTIVEMQ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVEMQ" + } + }, + "RABBITMQ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RABBITMQ" + } + } + }, + "traits": { + "smithy.api#documentation": "

The type of broker engine. Amazon MQ supports ActiveMQ and RabbitMQ.

" + } + }, + "com.amazonaws.mq#EngineVersion": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

Id for the version.

", + "smithy.api#jsonName": "name" + } + } + }, + "traits": { + "smithy.api#documentation": "

Id of the engine version.

" + } + }, + "com.amazonaws.mq#ForbiddenException": { + "type": "structure", + "members": { + "ErrorAttribute": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The attribute which caused the error.

", + "smithy.api#jsonName": "errorAttribute" + } + }, + "Message": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The explanation of the error.

", + "smithy.api#jsonName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Returns information about an error.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.mq#InternalServerErrorException": { + "type": "structure", + "members": { + "ErrorAttribute": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The attribute which caused the error.

", + "smithy.api#jsonName": "errorAttribute" + } + }, + "Message": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The explanation of the error.

", + "smithy.api#jsonName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Returns information about an error.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.mq#LdapServerMetadataInput": { + "type": "structure", + "members": { + "Hosts": { + "target": "com.amazonaws.mq#__listOf__string", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies the location of the LDAP server such as Directory Service for Microsoft Active Directory. Optional failover server.

", + "smithy.api#jsonName": "hosts", + "smithy.api#required": {} + } + }, + "RoleBase": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The distinguished name of the node in the directory information tree (DIT) to search for roles or groups. For example, ou=group, ou=corp, dc=corp,\n dc=example, dc=com.

", + "smithy.api#jsonName": "roleBase", + "smithy.api#required": {} + } + }, + "RoleName": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.

", + "smithy.api#jsonName": "roleName" + } + }, + "RoleSearchMatching": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The LDAP search filter used to find roles within the roleBase. The distinguished name of the user matched by userSearchMatching is substituted into the {0} placeholder in the search filter. The client's username is substituted into the {1} placeholder. For example, if you set this option to (member=uid={1})for the user janedoe, the search filter becomes (member=uid=janedoe) after string substitution. It matches all role entries that have a member attribute equal to uid=janedoe under the subtree selected by the roleBase.

", + "smithy.api#jsonName": "roleSearchMatching", + "smithy.api#required": {} + } + }, + "RoleSearchSubtree": { + "target": "com.amazonaws.mq#__boolean", + "traits": { + "smithy.api#documentation": "

The directory search scope for the role. If set to true, scope is to search the entire subtree.

", + "smithy.api#jsonName": "roleSearchSubtree" + } + }, + "ServiceAccountPassword": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Service account password. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin,dc=corp, dc=example,\n dc=com.

", + "smithy.api#jsonName": "serviceAccountPassword", + "smithy.api#required": {} + } + }, + "ServiceAccountUsername": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Service account username. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin,dc=corp, dc=example,\n dc=com.

", + "smithy.api#jsonName": "serviceAccountUsername", + "smithy.api#required": {} + } + }, + "UserBase": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Select a particular subtree of the directory information tree (DIT) to search for user entries. The subtree is specified by a DN, which specifies the base node of the subtree. For example, by setting this option to ou=Users,ou=corp, dc=corp,\n dc=example, dc=com, the search for user entries is restricted to the subtree beneath ou=Users, ou=corp, dc=corp, dc=example, dc=com.

", + "smithy.api#jsonName": "userBase", + "smithy.api#required": {} + } + }, + "UserRoleName": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

Specifies the name of the LDAP attribute for the user group membership.

", + "smithy.api#jsonName": "userRoleName" + } + }, + "UserSearchMatching": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The LDAP search filter used to find users within the userBase. The client's username is substituted into the {0} placeholder in the search filter. For example, if this option is set to (uid={0}) and the received username is janedoe, the search filter becomes (uid=janedoe) after string substitution. It will result in matching an entry like uid=janedoe, ou=Users,ou=corp, dc=corp, dc=example,\n dc=com.

", + "smithy.api#jsonName": "userSearchMatching", + "smithy.api#required": {} + } + }, + "UserSearchSubtree": { + "target": "com.amazonaws.mq#__boolean", + "traits": { + "smithy.api#documentation": "

The directory search scope for the user. If set to true, scope is to search the entire subtree.

", + "smithy.api#jsonName": "userSearchSubtree" + } + } + }, + "traits": { + "smithy.api#documentation": "

Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker.

Does not apply to RabbitMQ brokers.

" + } + }, + "com.amazonaws.mq#LdapServerMetadataOutput": { + "type": "structure", + "members": { + "Hosts": { + "target": "com.amazonaws.mq#__listOf__string", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies the location of the LDAP server such as Directory Service for Microsoft Active Directory. Optional failover server.

", + "smithy.api#jsonName": "hosts", + "smithy.api#required": {} + } + }, + "RoleBase": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The distinguished name of the node in the directory information tree (DIT) to search for roles or groups. For example, ou=group, ou=corp, dc=corp,\n dc=example, dc=com.

", + "smithy.api#jsonName": "roleBase", + "smithy.api#required": {} + } + }, + "RoleName": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.

", + "smithy.api#jsonName": "roleName" + } + }, + "RoleSearchMatching": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The LDAP search filter used to find roles within the roleBase. The distinguished name of the user matched by userSearchMatching is substituted into the {0} placeholder in the search filter. The client's username is substituted into the {1} placeholder. For example, if you set this option to (member=uid={1})for the user janedoe, the search filter becomes (member=uid=janedoe) after string substitution. It matches all role entries that have a member attribute equal to uid=janedoe under the subtree selected by the roleBase.

", + "smithy.api#jsonName": "roleSearchMatching", + "smithy.api#required": {} + } + }, + "RoleSearchSubtree": { + "target": "com.amazonaws.mq#__boolean", + "traits": { + "smithy.api#documentation": "

The directory search scope for the role. If set to true, scope is to search the entire subtree.

", + "smithy.api#jsonName": "roleSearchSubtree" + } + }, + "ServiceAccountUsername": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Service account username. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin,dc=corp, dc=example,\n dc=com.

", + "smithy.api#jsonName": "serviceAccountUsername", + "smithy.api#required": {} + } + }, + "UserBase": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Select a particular subtree of the directory information tree (DIT) to search for user entries. The subtree is specified by a DN, which specifies the base node of the subtree. For example, by setting this option to ou=Users,ou=corp, dc=corp,\n dc=example, dc=com, the search for user entries is restricted to the subtree beneath ou=Users, ou=corp, dc=corp, dc=example, dc=com.

", + "smithy.api#jsonName": "userBase", + "smithy.api#required": {} + } + }, + "UserRoleName": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

Specifies the name of the LDAP attribute for the user group membership.

", + "smithy.api#jsonName": "userRoleName" + } + }, + "UserSearchMatching": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The LDAP search filter used to find users within the userBase. The client's username is substituted into the {0} placeholder in the search filter. For example, if this option is set to (uid={0}) and the received username is janedoe, the search filter becomes (uid=janedoe) after string substitution. It will result in matching an entry like uid=janedoe, ou=Users,ou=corp, dc=corp, dc=example,\n dc=com.

", + "smithy.api#jsonName": "userSearchMatching", + "smithy.api#required": {} + } + }, + "UserSearchSubtree": { + "target": "com.amazonaws.mq#__boolean", + "traits": { + "smithy.api#documentation": "

The directory search scope for the user. If set to true, scope is to search the entire subtree.

", + "smithy.api#jsonName": "userSearchSubtree" + } + } + }, + "traits": { + "smithy.api#documentation": "

Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker.

" + } + }, + "com.amazonaws.mq#ListBrokers": { + "type": "operation", + "input": { + "target": "com.amazonaws.mq#ListBrokersRequest" + }, + "output": { + "target": "com.amazonaws.mq#ListBrokersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mq#BadRequestException" + }, + { + "target": "com.amazonaws.mq#ForbiddenException" + }, + { + "target": "com.amazonaws.mq#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of all brokers.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/brokers", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "BrokerSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.mq#ListBrokersRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.mq#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of brokers that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.mq#ListBrokersResponse": { + "type": "structure", + "members": { + "BrokerSummaries": { + "target": "com.amazonaws.mq#__listOfBrokerSummary", + "traits": { + "smithy.api#documentation": "

A list of information about all brokers.

", + "smithy.api#jsonName": "brokerSummaries" + } + }, + "NextToken": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.mq#ListConfigurationRevisions": { + "type": "operation", + "input": { + "target": "com.amazonaws.mq#ListConfigurationRevisionsRequest" + }, + "output": { + "target": "com.amazonaws.mq#ListConfigurationRevisionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mq#BadRequestException" + }, + { + "target": "com.amazonaws.mq#ForbiddenException" + }, + { + "target": "com.amazonaws.mq#InternalServerErrorException" + }, + { + "target": "com.amazonaws.mq#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of all revisions for the specified configuration.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/configurations/{ConfigurationId}/revisions", + "code": 200 + } + } + }, + "com.amazonaws.mq#ListConfigurationRevisionsRequest": { + "type": "structure", + "members": { + "ConfigurationId": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The unique ID that Amazon MQ generates for the configuration.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.mq#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of brokers that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.mq#ListConfigurationRevisionsResponse": { + "type": "structure", + "members": { + "ConfigurationId": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The unique ID that Amazon MQ generates for the configuration.

", + "smithy.api#jsonName": "configurationId" + } + }, + "MaxResults": { + "target": "com.amazonaws.mq#__integer", + "traits": { + "smithy.api#documentation": "

The maximum number of configuration revisions that can be returned per page (20 by default). This value must be an integer from 5 to 100.

", + "smithy.api#jsonName": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

", + "smithy.api#jsonName": "nextToken" + } + }, + "Revisions": { + "target": "com.amazonaws.mq#__listOfConfigurationRevision", + "traits": { + "smithy.api#documentation": "

The list of all revisions for the specified configuration.

", + "smithy.api#jsonName": "revisions" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.mq#ListConfigurations": { + "type": "operation", + "input": { + "target": "com.amazonaws.mq#ListConfigurationsRequest" + }, + "output": { + "target": "com.amazonaws.mq#ListConfigurationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mq#BadRequestException" + }, + { + "target": "com.amazonaws.mq#ForbiddenException" + }, + { + "target": "com.amazonaws.mq#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of all configurations.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/configurations", + "code": 200 + } + } + }, + "com.amazonaws.mq#ListConfigurationsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.mq#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of brokers that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.mq#ListConfigurationsResponse": { + "type": "structure", + "members": { + "Configurations": { + "target": "com.amazonaws.mq#__listOfConfiguration", + "traits": { + "smithy.api#documentation": "

The list of all revisions for the specified configuration.

", + "smithy.api#jsonName": "configurations" + } + }, + "MaxResults": { + "target": "com.amazonaws.mq#__integer", + "traits": { + "smithy.api#documentation": "

The maximum number of configurations that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.

", + "smithy.api#jsonName": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.mq#ListTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.mq#ListTagsRequest" + }, + "output": { + "target": "com.amazonaws.mq#ListTagsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mq#BadRequestException" + }, + { + "target": "com.amazonaws.mq#ForbiddenException" + }, + { + "target": "com.amazonaws.mq#InternalServerErrorException" + }, + { + "target": "com.amazonaws.mq#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists tags for a resource.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/tags/{ResourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.mq#ListTagsRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource tag.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.mq#ListTagsResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.mq#__mapOf__string", + "traits": { + "smithy.api#documentation": "

The key-value pair for the resource tag.

", + "smithy.api#jsonName": "tags" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.mq#ListUsers": { + "type": "operation", + "input": { + "target": "com.amazonaws.mq#ListUsersRequest" + }, + "output": { + "target": "com.amazonaws.mq#ListUsersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mq#BadRequestException" + }, + { + "target": "com.amazonaws.mq#ForbiddenException" + }, + { + "target": "com.amazonaws.mq#InternalServerErrorException" + }, + { + "target": "com.amazonaws.mq#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of all ActiveMQ users.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/brokers/{BrokerId}/users", + "code": 200 + } + } + }, + "com.amazonaws.mq#ListUsersRequest": { + "type": "structure", + "members": { + "BrokerId": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The unique ID that Amazon MQ generates for the broker.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.mq#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of brokers that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.mq#ListUsersResponse": { + "type": "structure", + "members": { + "BrokerId": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

Required. The unique ID that Amazon MQ generates for the broker.

", + "smithy.api#jsonName": "brokerId" + } + }, + "MaxResults": { + "target": "com.amazonaws.mq#__integerMin5Max100", + "traits": { + "smithy.api#documentation": "

Required. The maximum number of ActiveMQ users that can be returned per page (20 by default). This value must be an integer from 5 to 100.

", + "smithy.api#jsonName": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

", + "smithy.api#jsonName": "nextToken" + } + }, + "Users": { + "target": "com.amazonaws.mq#__listOfUserSummary", + "traits": { + "smithy.api#documentation": "

Required. The list of all ActiveMQ usernames for the specified broker. Does not apply to RabbitMQ brokers.

", + "smithy.api#jsonName": "users" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.mq#Logs": { + "type": "structure", + "members": { + "Audit": { + "target": "com.amazonaws.mq#__boolean", + "traits": { + "smithy.api#documentation": "

Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. Does not apply to RabbitMQ brokers.

", + "smithy.api#jsonName": "audit" + } + }, + "General": { + "target": "com.amazonaws.mq#__boolean", + "traits": { + "smithy.api#documentation": "

Enables general logging.

", + "smithy.api#jsonName": "general" + } + } + }, + "traits": { + "smithy.api#documentation": "

The list of information about logs to be enabled for the specified broker.

" + } + }, + "com.amazonaws.mq#LogsSummary": { + "type": "structure", + "members": { + "Audit": { + "target": "com.amazonaws.mq#__boolean", + "traits": { + "smithy.api#documentation": "

Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged.

", + "smithy.api#jsonName": "audit" + } + }, + "AuditLogGroup": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The location of the CloudWatch Logs log group where audit logs are sent.

", + "smithy.api#jsonName": "auditLogGroup" + } + }, + "General": { + "target": "com.amazonaws.mq#__boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Enables general logging.

", + "smithy.api#jsonName": "general", + "smithy.api#required": {} + } + }, + "GeneralLogGroup": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The location of the CloudWatch Logs log group where general logs are sent.

", + "smithy.api#jsonName": "generalLogGroup", + "smithy.api#required": {} + } + }, + "Pending": { + "target": "com.amazonaws.mq#PendingLogs", + "traits": { + "smithy.api#documentation": "

The list of information about logs pending to be deployed for the specified broker.

", + "smithy.api#jsonName": "pending" + } + } + }, + "traits": { + "smithy.api#documentation": "

The list of information about logs currently enabled and pending to be deployed for the specified broker.

" + } + }, + "com.amazonaws.mq#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.mq#NotFoundException": { + "type": "structure", + "members": { + "ErrorAttribute": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The attribute which caused the error.

", + "smithy.api#jsonName": "errorAttribute" + } + }, + "Message": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The explanation of the error.

", + "smithy.api#jsonName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Returns information about an error.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.mq#PendingLogs": { + "type": "structure", + "members": { + "Audit": { + "target": "com.amazonaws.mq#__boolean", + "traits": { + "smithy.api#documentation": "

Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged.

", + "smithy.api#jsonName": "audit" + } + }, + "General": { + "target": "com.amazonaws.mq#__boolean", + "traits": { + "smithy.api#documentation": "

Enables general logging.

", + "smithy.api#jsonName": "general" + } + } + }, + "traits": { + "smithy.api#documentation": "

The list of information about logs to be enabled for the specified broker.

" + } + }, + "com.amazonaws.mq#Promote": { + "type": "operation", + "input": { + "target": "com.amazonaws.mq#PromoteRequest" + }, + "output": { + "target": "com.amazonaws.mq#PromoteResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mq#BadRequestException" + }, + { + "target": "com.amazonaws.mq#ForbiddenException" + }, + { + "target": "com.amazonaws.mq#InternalServerErrorException" + }, + { + "target": "com.amazonaws.mq#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Promotes a data replication replica broker to the primary broker role.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/brokers/{BrokerId}/promote", + "code": 200 + } + } + }, + "com.amazonaws.mq#PromoteMode": { + "type": "enum", + "members": { + "SWITCHOVER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SWITCHOVER" + } + }, + "FAILOVER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILOVER" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Promote mode requested.

" + } + }, + "com.amazonaws.mq#PromoteRequest": { + "type": "structure", + "members": { + "BrokerId": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The unique ID that Amazon MQ generates for the broker.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Mode": { + "target": "com.amazonaws.mq#PromoteMode", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Promote mode requested. Note: Valid values for the parameter are SWITCHOVER, FAILOVER.

", + "smithy.api#jsonName": "mode", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Promotes a data replication replica broker to the primary broker role.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.mq#PromoteResponse": { + "type": "structure", + "members": { + "BrokerId": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The unique ID that Amazon MQ generates for the broker.

", + "smithy.api#jsonName": "brokerId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.mq#RebootBroker": { + "type": "operation", + "input": { + "target": "com.amazonaws.mq#RebootBrokerRequest" + }, + "output": { + "target": "com.amazonaws.mq#RebootBrokerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mq#BadRequestException" + }, + { + "target": "com.amazonaws.mq#ForbiddenException" + }, + { + "target": "com.amazonaws.mq#InternalServerErrorException" + }, + { + "target": "com.amazonaws.mq#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Reboots a broker. Note: This API is asynchronous.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/brokers/{BrokerId}/reboot", + "code": 200 + } + } + }, + "com.amazonaws.mq#RebootBrokerRequest": { + "type": "structure", + "members": { + "BrokerId": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The unique ID that Amazon MQ generates for the broker.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.mq#RebootBrokerResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.mq#SanitizationWarning": { + "type": "structure", + "members": { + "AttributeName": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The name of the configuration attribute that has been sanitized.

", + "smithy.api#jsonName": "attributeName" + } + }, + "ElementName": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The name of the configuration element that has been sanitized.

", + "smithy.api#jsonName": "elementName" + } + }, + "Reason": { + "target": "com.amazonaws.mq#SanitizationWarningReason", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The reason for which the configuration elements or attributes were sanitized.

", + "smithy.api#jsonName": "reason", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Returns information about the configuration element or attribute that was sanitized in the configuration.

" + } + }, + "com.amazonaws.mq#SanitizationWarningReason": { + "type": "enum", + "members": { + "DISALLOWED_ELEMENT_REMOVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISALLOWED_ELEMENT_REMOVED" + } + }, + "DISALLOWED_ATTRIBUTE_REMOVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISALLOWED_ATTRIBUTE_REMOVED" + } + }, + "INVALID_ATTRIBUTE_VALUE_REMOVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_ATTRIBUTE_VALUE_REMOVED" + } + } + }, + "traits": { + "smithy.api#documentation": "

The reason for which the configuration elements or attributes were sanitized.

" + } + }, + "com.amazonaws.mq#UnauthorizedException": { + "type": "structure", + "members": { + "ErrorAttribute": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The attribute which caused the error.

", + "smithy.api#jsonName": "errorAttribute" + } + }, + "Message": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The explanation of the error.

", + "smithy.api#jsonName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Returns information about an error.

", + "smithy.api#error": "client", + "smithy.api#httpError": 401 + } + }, + "com.amazonaws.mq#UpdateBroker": { + "type": "operation", + "input": { + "target": "com.amazonaws.mq#UpdateBrokerRequest" + }, + "output": { + "target": "com.amazonaws.mq#UpdateBrokerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mq#BadRequestException" + }, + { + "target": "com.amazonaws.mq#ConflictException" + }, + { + "target": "com.amazonaws.mq#ForbiddenException" + }, + { + "target": "com.amazonaws.mq#InternalServerErrorException" + }, + { + "target": "com.amazonaws.mq#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds a pending configuration change to a broker.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/v1/brokers/{BrokerId}", + "code": 200 + } + } + }, + "com.amazonaws.mq#UpdateBrokerRequest": { + "type": "structure", + "members": { + "AuthenticationStrategy": { + "target": "com.amazonaws.mq#AuthenticationStrategy", + "traits": { + "smithy.api#documentation": "

Optional. The authentication strategy used to secure the broker. The default is SIMPLE.

", + "smithy.api#jsonName": "authenticationStrategy" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.mq#__boolean", + "traits": { + "smithy.api#documentation": "

Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot.

Must be set to true for ActiveMQ brokers version 5.18 and above and for RabbitMQ brokers version 3.13 and above.

", + "smithy.api#jsonName": "autoMinorVersionUpgrade" + } + }, + "BrokerId": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The unique ID that Amazon MQ generates for the broker.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Configuration": { + "target": "com.amazonaws.mq#ConfigurationId", + "traits": { + "smithy.api#documentation": "

A list of information about the configuration.

", + "smithy.api#jsonName": "configuration" + } + }, + "EngineVersion": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The broker engine version. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.

When upgrading to ActiveMQ version 5.18 and above or RabbitMQ version 3.13 and above, you must have autoMinorVersionUpgrade set to true for the broker.

", + "smithy.api#jsonName": "engineVersion" + } + }, + "HostInstanceType": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The broker's host instance type to upgrade to. For a list of supported instance types, see Broker instance types.

", + "smithy.api#jsonName": "hostInstanceType" + } + }, + "LdapServerMetadata": { + "target": "com.amazonaws.mq#LdapServerMetadataInput", + "traits": { + "smithy.api#documentation": "

Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.

", + "smithy.api#jsonName": "ldapServerMetadata" + } + }, + "Logs": { + "target": "com.amazonaws.mq#Logs", + "traits": { + "smithy.api#documentation": "

Enables Amazon CloudWatch logging for brokers.

", + "smithy.api#jsonName": "logs" + } + }, + "MaintenanceWindowStartTime": { + "target": "com.amazonaws.mq#WeeklyStartTime", + "traits": { + "smithy.api#documentation": "

The parameters that determine the WeeklyStartTime.

", + "smithy.api#jsonName": "maintenanceWindowStartTime" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.mq#__listOf__string", + "traits": { + "smithy.api#documentation": "

The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.

", + "smithy.api#jsonName": "securityGroups" + } + }, + "DataReplicationMode": { + "target": "com.amazonaws.mq#DataReplicationMode", + "traits": { + "smithy.api#documentation": "

Defines whether this broker is a part of a data replication pair.

", + "smithy.api#jsonName": "dataReplicationMode" + } + } + }, + "traits": { + "smithy.api#documentation": "

Updates the broker using the specified properties.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.mq#UpdateBrokerResponse": { + "type": "structure", + "members": { + "AuthenticationStrategy": { + "target": "com.amazonaws.mq#AuthenticationStrategy", + "traits": { + "smithy.api#documentation": "

Optional. The authentication strategy used to secure the broker. The default is SIMPLE.

", + "smithy.api#jsonName": "authenticationStrategy" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.mq#__boolean", + "traits": { + "smithy.api#documentation": "

Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot.

", + "smithy.api#jsonName": "autoMinorVersionUpgrade" + } + }, + "BrokerId": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

Required. The unique ID that Amazon MQ generates for the broker.

", + "smithy.api#jsonName": "brokerId" + } + }, + "Configuration": { + "target": "com.amazonaws.mq#ConfigurationId", + "traits": { + "smithy.api#documentation": "

The ID of the updated configuration.

", + "smithy.api#jsonName": "configuration" + } + }, + "EngineVersion": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The broker engine version to upgrade to. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.

", + "smithy.api#jsonName": "engineVersion" + } + }, + "HostInstanceType": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The broker's host instance type to upgrade to. For a list of supported instance types, see Broker instance types.

", + "smithy.api#jsonName": "hostInstanceType" + } + }, + "LdapServerMetadata": { + "target": "com.amazonaws.mq#LdapServerMetadataOutput", + "traits": { + "smithy.api#documentation": "

Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.

", + "smithy.api#jsonName": "ldapServerMetadata" + } + }, + "Logs": { + "target": "com.amazonaws.mq#Logs", + "traits": { + "smithy.api#documentation": "

The list of information about logs to be enabled for the specified broker.

", + "smithy.api#jsonName": "logs" + } + }, + "MaintenanceWindowStartTime": { + "target": "com.amazonaws.mq#WeeklyStartTime", + "traits": { + "smithy.api#documentation": "

The parameters that determine the WeeklyStartTime.

", + "smithy.api#jsonName": "maintenanceWindowStartTime" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.mq#__listOf__string", + "traits": { + "smithy.api#documentation": "

The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.

", + "smithy.api#jsonName": "securityGroups" + } + }, + "DataReplicationMetadata": { + "target": "com.amazonaws.mq#DataReplicationMetadataOutput", + "traits": { + "smithy.api#documentation": "

The replication details of the data replication-enabled broker. Only returned if dataReplicationMode is set to CRDR.

", + "smithy.api#jsonName": "dataReplicationMetadata" + } + }, + "DataReplicationMode": { + "target": "com.amazonaws.mq#DataReplicationMode", + "traits": { + "smithy.api#documentation": "

Describes whether this broker is a part of a data replication pair.

", + "smithy.api#jsonName": "dataReplicationMode" + } + }, + "PendingDataReplicationMetadata": { + "target": "com.amazonaws.mq#DataReplicationMetadataOutput", + "traits": { + "smithy.api#documentation": "

The pending replication details of the data replication-enabled broker. Only returned if pendingDataReplicationMode is set to CRDR.

", + "smithy.api#jsonName": "pendingDataReplicationMetadata" + } + }, + "PendingDataReplicationMode": { + "target": "com.amazonaws.mq#DataReplicationMode", + "traits": { + "smithy.api#documentation": "

Describes whether this broker will be a part of a data replication pair after reboot.

", + "smithy.api#jsonName": "pendingDataReplicationMode" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.mq#UpdateConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.mq#UpdateConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.mq#UpdateConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mq#BadRequestException" + }, + { + "target": "com.amazonaws.mq#ConflictException" + }, + { + "target": "com.amazonaws.mq#ForbiddenException" + }, + { + "target": "com.amazonaws.mq#InternalServerErrorException" + }, + { + "target": "com.amazonaws.mq#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the specified configuration.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/v1/configurations/{ConfigurationId}", + "code": 200 + } + } + }, + "com.amazonaws.mq#UpdateConfigurationRequest": { + "type": "structure", + "members": { + "ConfigurationId": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The unique ID that Amazon MQ generates for the configuration.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Data": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Amazon MQ for Active MQ: The base64-encoded XML configuration. Amazon MQ for RabbitMQ: the base64-encoded Cuttlefish configuration.

", + "smithy.api#jsonName": "data", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The description of the configuration.

", + "smithy.api#jsonName": "description" + } + } + }, + "traits": { + "smithy.api#documentation": "

Updates the specified configuration.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.mq#UpdateConfigurationResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the configuration.

", + "smithy.api#jsonName": "arn" + } + }, + "Created": { + "target": "com.amazonaws.mq#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

Required. The date and time of the configuration.

", + "smithy.api#jsonName": "created" + } + }, + "Id": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The unique ID that Amazon MQ generates for the configuration.

", + "smithy.api#jsonName": "id" + } + }, + "LatestRevision": { + "target": "com.amazonaws.mq#ConfigurationRevision", + "traits": { + "smithy.api#documentation": "

The latest revision of the configuration.

", + "smithy.api#jsonName": "latestRevision" + } + }, + "Name": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.

", + "smithy.api#jsonName": "name" + } + }, + "Warnings": { + "target": "com.amazonaws.mq#__listOfSanitizationWarning", + "traits": { + "smithy.api#documentation": "

The list of the first 20 warnings about the configuration elements or attributes that were sanitized.

", + "smithy.api#jsonName": "warnings" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.mq#UpdateUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.mq#UpdateUserRequest" + }, + "output": { + "target": "com.amazonaws.mq#UpdateUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mq#BadRequestException" + }, + { + "target": "com.amazonaws.mq#ConflictException" + }, + { + "target": "com.amazonaws.mq#ForbiddenException" + }, + { + "target": "com.amazonaws.mq#InternalServerErrorException" + }, + { + "target": "com.amazonaws.mq#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the information for an ActiveMQ user.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/v1/brokers/{BrokerId}/users/{Username}", + "code": 200 + } + } + }, + "com.amazonaws.mq#UpdateUserRequest": { + "type": "structure", + "members": { + "BrokerId": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The unique ID that Amazon MQ generates for the broker.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ConsoleAccess": { + "target": "com.amazonaws.mq#__boolean", + "traits": { + "smithy.api#documentation": "

Enables access to the the ActiveMQ Web Console for the ActiveMQ user.

", + "smithy.api#jsonName": "consoleAccess" + } + }, + "Groups": { + "target": "com.amazonaws.mq#__listOf__string", + "traits": { + "smithy.api#documentation": "

The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

", + "smithy.api#jsonName": "groups" + } + }, + "Password": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas, colons, or equal signs (,:=).

", + "smithy.api#jsonName": "password" + } + }, + "Username": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ReplicationUser": { + "target": "com.amazonaws.mq#__boolean", + "traits": { + "smithy.api#documentation": "

Defines whether the user is intended for data replication.

", + "smithy.api#jsonName": "replicationUser" + } + } + }, + "traits": { + "smithy.api#documentation": "

Updates the information for an ActiveMQ user.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.mq#UpdateUserResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.mq#User": { + "type": "structure", + "members": { + "ConsoleAccess": { + "target": "com.amazonaws.mq#__boolean", + "traits": { + "smithy.api#documentation": "

Enables access to the ActiveMQ Web Console for the ActiveMQ user. Does not apply to RabbitMQ brokers.

", + "smithy.api#jsonName": "consoleAccess" + } + }, + "Groups": { + "target": "com.amazonaws.mq#__listOf__string", + "traits": { + "smithy.api#documentation": "

The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long. Does not apply to RabbitMQ brokers.

", + "smithy.api#jsonName": "groups" + } + }, + "Password": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Required. The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas, colons, or equal signs (,:=).

", + "smithy.api#jsonName": "password", + "smithy.api#required": {} + } + }, + "Username": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The username of the broker user. The following restrictions apply to broker usernames:

  • For Amazon MQ for ActiveMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

  • para>For Amazon MQ for RabbitMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores (- . _). This value must not contain a tilde (~) character. Amazon MQ prohibts using guest as a valid usename. This value must be 2-100 characters long.

Do not add personally identifiable information (PII) or other confidential or sensitive information in broker usernames. Broker usernames are accessible to other Amazon Web Services services, including CloudWatch Logs. Broker usernames are not intended to be used for private or sensitive data.

", + "smithy.api#jsonName": "username", + "smithy.api#required": {} + } + }, + "ReplicationUser": { + "target": "com.amazonaws.mq#__boolean", + "traits": { + "smithy.api#documentation": "

Defines if this user is intended for CRDR replication purposes.

", + "smithy.api#jsonName": "replicationUser" + } + } + }, + "traits": { + "smithy.api#documentation": "

A user associated with the broker. For Amazon MQ for RabbitMQ brokers, one and only one administrative user is accepted and created when a broker is first provisioned. All subsequent broker users are created by making RabbitMQ API calls directly to brokers or via the RabbitMQ web console.

" + } + }, + "com.amazonaws.mq#UserPendingChanges": { + "type": "structure", + "members": { + "ConsoleAccess": { + "target": "com.amazonaws.mq#__boolean", + "traits": { + "smithy.api#documentation": "

Enables access to the the ActiveMQ Web Console for the ActiveMQ user.

", + "smithy.api#jsonName": "consoleAccess" + } + }, + "Groups": { + "target": "com.amazonaws.mq#__listOf__string", + "traits": { + "smithy.api#documentation": "

The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

", + "smithy.api#jsonName": "groups" + } + }, + "PendingChange": { + "target": "com.amazonaws.mq#ChangeType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Required. The type of change pending for the ActiveMQ user.

", + "smithy.api#jsonName": "pendingChange", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Returns information about the status of the changes pending for the ActiveMQ user.

" + } + }, + "com.amazonaws.mq#UserSummary": { + "type": "structure", + "members": { + "PendingChange": { + "target": "com.amazonaws.mq#ChangeType", + "traits": { + "smithy.api#documentation": "

The type of change pending for the broker user.

", + "smithy.api#jsonName": "pendingChange" + } + }, + "Username": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Required. The username of the broker user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

", + "smithy.api#jsonName": "username", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Returns a list of all broker users. Does not apply to RabbitMQ brokers.

" + } + }, + "com.amazonaws.mq#WeeklyStartTime": { + "type": "structure", + "members": { + "DayOfWeek": { + "target": "com.amazonaws.mq#DayOfWeek", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Required. The day of the week.

", + "smithy.api#jsonName": "dayOfWeek", + "smithy.api#required": {} + } + }, + "TimeOfDay": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Required. The time, in 24-hour format.

", + "smithy.api#jsonName": "timeOfDay", + "smithy.api#required": {} + } + }, + "TimeZone": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The time zone, UTC by default, in either the Country/City format, or the UTC offset format.

", + "smithy.api#jsonName": "timeZone" + } + } + }, + "traits": { + "smithy.api#documentation": "

The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.

" + } + }, + "com.amazonaws.mq#__boolean": { + "type": "boolean" + }, + "com.amazonaws.mq#__integer": { + "type": "integer" + }, + "com.amazonaws.mq#__integerMin5Max100": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 100 + } + } + }, + "com.amazonaws.mq#__listOfActionRequired": { + "type": "list", + "member": { + "target": "com.amazonaws.mq#ActionRequired" + } + }, + "com.amazonaws.mq#__listOfAvailabilityZone": { + "type": "list", + "member": { + "target": "com.amazonaws.mq#AvailabilityZone" + } + }, + "com.amazonaws.mq#__listOfBrokerEngineType": { + "type": "list", + "member": { + "target": "com.amazonaws.mq#BrokerEngineType" + } + }, + "com.amazonaws.mq#__listOfBrokerInstance": { + "type": "list", + "member": { + "target": "com.amazonaws.mq#BrokerInstance" + } + }, + "com.amazonaws.mq#__listOfBrokerInstanceOption": { + "type": "list", + "member": { + "target": "com.amazonaws.mq#BrokerInstanceOption" + } + }, + "com.amazonaws.mq#__listOfBrokerSummary": { + "type": "list", + "member": { + "target": "com.amazonaws.mq#BrokerSummary" + } + }, + "com.amazonaws.mq#__listOfConfiguration": { + "type": "list", + "member": { + "target": "com.amazonaws.mq#Configuration" + } + }, + "com.amazonaws.mq#__listOfConfigurationId": { + "type": "list", + "member": { + "target": "com.amazonaws.mq#ConfigurationId" + } + }, + "com.amazonaws.mq#__listOfConfigurationRevision": { + "type": "list", + "member": { + "target": "com.amazonaws.mq#ConfigurationRevision" + } + }, + "com.amazonaws.mq#__listOfDeploymentMode": { + "type": "list", + "member": { + "target": "com.amazonaws.mq#DeploymentMode" + } + }, + "com.amazonaws.mq#__listOfEngineVersion": { + "type": "list", + "member": { + "target": "com.amazonaws.mq#EngineVersion" + } + }, + "com.amazonaws.mq#__listOfSanitizationWarning": { + "type": "list", + "member": { + "target": "com.amazonaws.mq#SanitizationWarning" + } + }, + "com.amazonaws.mq#__listOfUser": { + "type": "list", + "member": { + "target": "com.amazonaws.mq#User" + } + }, + "com.amazonaws.mq#__listOfUserSummary": { + "type": "list", + "member": { + "target": "com.amazonaws.mq#UserSummary" + } + }, + "com.amazonaws.mq#__listOf__string": { + "type": "list", + "member": { + "target": "com.amazonaws.mq#__string" + } + }, + "com.amazonaws.mq#__mapOf__string": { + "type": "map", + "key": { + "target": "com.amazonaws.mq#__string" + }, + "value": { + "target": "com.amazonaws.mq#__string" + } + }, + "com.amazonaws.mq#__string": { + "type": "string" + }, + "com.amazonaws.mq#__timestampIso8601": { + "type": "timestamp", + "traits": { + "smithy.api#timestampFormat": "date-time" + } + }, + "com.amazonaws.mq#mq": { + "type": "service", + "version": "2017-11-27", + "operations": [ + { + "target": "com.amazonaws.mq#CreateBroker" + }, + { + "target": "com.amazonaws.mq#CreateConfiguration" + }, + { + "target": "com.amazonaws.mq#CreateTags" + }, + { + "target": "com.amazonaws.mq#CreateUser" + }, + { + "target": "com.amazonaws.mq#DeleteBroker" + }, + { + "target": "com.amazonaws.mq#DeleteTags" + }, + { + "target": "com.amazonaws.mq#DeleteUser" + }, + { + "target": "com.amazonaws.mq#DescribeBroker" + }, + { + "target": "com.amazonaws.mq#DescribeBrokerEngineTypes" + }, + { + "target": "com.amazonaws.mq#DescribeBrokerInstanceOptions" + }, + { + "target": "com.amazonaws.mq#DescribeConfiguration" + }, + { + "target": "com.amazonaws.mq#DescribeConfigurationRevision" + }, + { + "target": "com.amazonaws.mq#DescribeUser" + }, + { + "target": "com.amazonaws.mq#ListBrokers" + }, + { + "target": "com.amazonaws.mq#ListConfigurationRevisions" + }, + { + "target": "com.amazonaws.mq#ListConfigurations" + }, + { + "target": "com.amazonaws.mq#ListTags" + }, + { + "target": "com.amazonaws.mq#ListUsers" + }, + { + "target": "com.amazonaws.mq#Promote" + }, + { + "target": "com.amazonaws.mq#RebootBroker" + }, + { + "target": "com.amazonaws.mq#UpdateBroker" + }, + { + "target": "com.amazonaws.mq#UpdateConfiguration" + }, + { + "target": "com.amazonaws.mq#UpdateUser" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "mq", + "arnNamespace": "mq", + "cloudFormationName": "AmazonMQ", + "cloudTrailEventSource": "mq.amazonaws.com", + "endpointPrefix": "mq" + }, + "aws.auth#sigv4": { + "name": "mq" + }, + "aws.protocols#restJson1": {}, + "smithy.api#auth": [ + "aws.auth#sigv4" + ], + "smithy.api#documentation": "

Amazon MQ is a managed message broker service for Apache ActiveMQ and RabbitMQ that makes it easy to set up and operate message brokers in the cloud. A message broker allows software applications and components to communicate using various programming languages, operating systems, and formal messaging protocols.

", + "smithy.api#title": "AmazonMQ", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://mq-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://mq-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://mq.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://mq.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mq.af-south-1.amazonaws.com" + } + }, + "params": { + "Region": "af-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mq.ap-east-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mq.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mq.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mq.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mq.ap-south-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mq.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mq.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mq.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mq.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mq.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mq.eu-north-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mq.eu-south-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mq.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mq.eu-west-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mq.eu-west-3.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mq.me-south-1.amazonaws.com" + } + }, + "params": { + "Region": "me-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mq.sa-east-1.amazonaws.com" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mq.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mq-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mq.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mq-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mq.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mq-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mq.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mq-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://mq-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://mq.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mq.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mq.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://mq-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mq-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://mq.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mq.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mq-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mq.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mq-fips.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://mq-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://mq.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mq-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mq.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mq-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mq.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + } + } +} \ No newline at end of file diff --git a/pkg/testdata/codegen/sdk-codegen/aws-models/rds.json b/pkg/testdata/codegen/sdk-codegen/aws-models/rds.json new file mode 100644 index 00000000..a4182eca --- /dev/null +++ b/pkg/testdata/codegen/sdk-codegen/aws-models/rds.json @@ -0,0 +1,31844 @@ +{ + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.rds#AccountAttributesMessage": { + "type": "structure", + "members": { + "AccountQuotas": { + "target": "com.amazonaws.rds#AccountQuotaList", + "traits": { + "smithy.api#documentation": "

A list of AccountQuota objects. Within this list, each quota has a name, \n a count of usage toward the quota maximum, and a maximum value for the quota.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Data returned by the DescribeAccountAttributes action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#AccountQuota": { + "type": "structure", + "members": { + "AccountQuotaName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon RDS quota for this Amazon Web Services account.

" + } + }, + "Used": { + "target": "com.amazonaws.rds#Long", + "traits": { + "smithy.api#documentation": "

The amount currently used toward the quota maximum.

" + } + }, + "Max": { + "target": "com.amazonaws.rds#Long", + "traits": { + "smithy.api#documentation": "

The maximum allowed value for the quota.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a quota for an Amazon Web Services account.

\n

The following are account quotas:

\n
    \n
  • \n

    \n AllocatedStorage - The total allocated storage per account, in GiB.\n The used value is the total allocated storage in the account, in GiB.

    \n
    • \n
  • \n

    \n AuthorizationsPerDBSecurityGroup - The number of ingress rules per DB security group. \n The used value is the highest number of ingress rules in a DB security group in the account. Other \n DB security groups in the account might have a lower number of ingress rules.

    \n
    • \n
  • \n

    \n CustomEndpointsPerDBCluster - The number of custom endpoints per DB cluster. \n The used value is the highest number of custom endpoints in a DB clusters in the account. Other \n DB clusters in the account might have a lower number of custom endpoints.

    \n
    • \n
  • \n

    \n DBClusterParameterGroups - The number of DB cluster parameter groups\n per account, excluding default parameter groups. The used value is the count of\n nondefault DB cluster parameter groups in the account.

    \n
    • \n
  • \n

    \n DBClusterRoles - The number of associated Amazon Web Services Identity and Access Management (IAM) roles per DB cluster. \n The used value is the highest number of associated IAM roles for a DB cluster in the account. Other \n DB clusters in the account might have a lower number of associated IAM roles.

    \n
    • \n
  • \n

    \n DBClusters - The number of DB clusters per account. \n The used value is the count of DB clusters in the account.

    \n
    • \n
  • \n

    \n DBInstanceRoles - The number of associated IAM roles per DB instance. \n The used value is the highest number of associated IAM roles for a DB instance in the account. Other \n DB instances in the account might have a lower number of associated IAM roles.

    \n
    • \n
  • \n

    \n DBInstances - The number of DB instances per account. \n The used value is the count of the DB instances in the account.

    \n

    Amazon RDS DB instances, Amazon Aurora DB instances, Amazon Neptune instances, and Amazon DocumentDB \n instances apply to this quota.

    \n
    • \n
  • \n

    \n DBParameterGroups - The number of DB parameter groups per account,\n excluding default parameter groups. The used value is the count of nondefault DB\n parameter groups in the account.

    \n
    • \n
  • \n

    \n DBSecurityGroups - The number of DB security groups (not VPC\n security groups) per account, excluding the default security group. The used\n value is the count of nondefault DB security groups in the account.

    \n
    • \n
  • \n

    \n DBSubnetGroups - The number of DB subnet groups per account. \n The used value is the count of the DB subnet groups in the account.

    \n
    • \n
  • \n

    \n EventSubscriptions - The number of event subscriptions per account. \n The used value is the count of the event subscriptions in the account.

    \n
    • \n
  • \n

    \n ManualClusterSnapshots - The number of manual DB cluster snapshots per account. \n The used value is the count of the manual DB cluster snapshots in the account.

    \n
    • \n
  • \n

    \n ManualSnapshots - The number of manual DB instance snapshots per account. \n The used value is the count of the manual DB instance snapshots in the account.

    \n
    • \n
  • \n

    \n OptionGroups - The number of DB option groups per account, excluding\n default option groups. The used value is the count of nondefault DB option\n groups in the account.

    \n
    • \n
  • \n

    \n ReadReplicasPerMaster - The number of read replicas per DB\n instance. The used value is the highest number of read replicas for a DB\n instance in the account. Other DB instances in the account might have a lower\n number of read replicas.

    \n
    • \n
  • \n

    \n ReservedDBInstances - The number of reserved DB instances per account. \n The used value is the count of the active reserved DB instances in the account.

    \n
    • \n
  • \n

    \n SubnetsPerDBSubnetGroup - The number of subnets per DB subnet group. \n The used value is highest number of subnets for a DB subnet group in the account. Other \n DB subnet groups in the account might have a lower number of subnets.

    \n
    • \n
\n

For more information, see Quotas for Amazon RDS in the\n Amazon RDS User Guide and Quotas for Amazon Aurora in the\n Amazon Aurora User Guide.

" + } + }, + "com.amazonaws.rds#AccountQuotaList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#AccountQuota", + "traits": { + "smithy.api#xmlName": "AccountQuota" + } + } + }, + "com.amazonaws.rds#ActivityStreamMode": { + "type": "enum", + "members": { + "sync": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sync" + } + }, + "async": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "async" + } + } + } + }, + "com.amazonaws.rds#ActivityStreamModeList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String" + } + }, + "com.amazonaws.rds#ActivityStreamPolicyStatus": { + "type": "enum", + "members": { + "locked": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "locked" + } + }, + "unlocked": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unlocked" + } + }, + "locking_policy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "locking-policy" + } + }, + "unlocking_policy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unlocking-policy" + } + } + } + }, + "com.amazonaws.rds#ActivityStreamStatus": { + "type": "enum", + "members": { + "stopped": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "stopped" + } + }, + "starting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "starting" + } + }, + "started": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "started" + } + }, + "stopping": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "stopping" + } + } + } + }, + "com.amazonaws.rds#AddRoleToDBCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#AddRoleToDBClusterMessage" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterRoleAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBClusterRoleQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Associates an Identity and Access Management (IAM) role with a DB cluster.

", + "smithy.api#examples": [ + { + "title": "To associate an AWS Identity and Access Management (IAM) role with a DB cluster", + "documentation": "The following example associates a role with a DB cluster.", + "input": { + "DBClusterIdentifier": "mydbcluster", + "RoleArn": "arn:aws:iam::123456789012:role/RDSLoadFromS3" + } + } + ] + } + }, + "com.amazonaws.rds#AddRoleToDBClusterMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the DB cluster to associate the IAM role with.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to associate with the Aurora DB\n cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole.

", + "smithy.api#required": {} + } + }, + "FeatureName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the feature for the DB cluster that the IAM role is to be associated with. \n For information about supported feature names, see DBEngineVersion.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#AddRoleToDBInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#AddRoleToDBInstanceMessage" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceRoleAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceRoleQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance.

\n \n

To add a role to a DB instance, the status of the DB instance must be available.

\n \n

This command doesn't apply to RDS Custom.

", + "smithy.api#examples": [ + { + "title": "To associate an AWS Identity and Access Management (IAM) role with a DB instance", + "documentation": "The following example adds the role to a DB instance named test-instance.", + "input": { + "DBInstanceIdentifier": "test-instance", + "RoleArn": "arn:aws:iam::111122223333:role/rds-s3-integration-role", + "FeatureName": "S3_INTEGRATION" + } + } + ] + } + }, + "com.amazonaws.rds#AddRoleToDBInstanceMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the DB instance to associate the IAM role with.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to associate with the DB instance, for\n example arn:aws:iam::123456789012:role/AccessRole.

", + "smithy.api#required": {} + } + }, + "FeatureName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the feature for the DB instance that the IAM role is to be associated with. \n For information about supported feature names, see DBEngineVersion.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#AddSourceIdentifierToSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#AddSourceIdentifierToSubscriptionMessage" + }, + "output": { + "target": "com.amazonaws.rds#AddSourceIdentifierToSubscriptionResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#SourceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#SubscriptionNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Adds a source identifier to an existing RDS event notification subscription.

", + "smithy.api#examples": [ + { + "title": "To add a source identifier to a subscription", + "documentation": "The following example adds another source identifier to an existing subscription.", + "input": { + "SubscriptionName": "my-instance-events", + "SourceIdentifier": "test-instance-repl" + }, + "output": { + "EventSubscription": { + "SubscriptionCreationTime": "Tue Jul 31 23:22:01 UTC 2018", + "CustSubscriptionId": "my-instance-events", + "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events", + "Enabled": false, + "Status": "modifying", + "EventCategoriesList": [ + "backup", + "recovery" + ], + "CustomerAwsId": "123456789012", + "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events", + "SourceType": "db-instance", + "SourceIdsList": [ + "test-instance", + "test-instance-repl" + ] + } + } + } + ] + } + }, + "com.amazonaws.rds#AddSourceIdentifierToSubscriptionMessage": { + "type": "structure", + "members": { + "SubscriptionName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the RDS event notification subscription you want to add a source identifier to.

", + "smithy.api#required": {} + } + }, + "SourceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier of the event source to be added.

\n

Constraints:

\n
    \n
  • \n

    If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB security group, a DBSecurityGroupName value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is an RDS Proxy, a DBProxyName value must be supplied.

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#AddSourceIdentifierToSubscriptionResult": { + "type": "structure", + "members": { + "EventSubscription": { + "target": "com.amazonaws.rds#EventSubscription" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#AddTagsToResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#AddTagsToResourceMessage" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.rds#BlueGreenDeploymentNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBProxyNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSnapshotTenantDatabaseNotFoundFault" + }, + { + "target": "com.amazonaws.rds#IntegrationNotFoundFault" + }, + { + "target": "com.amazonaws.rds#TenantDatabaseNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS.

\n

For an overview on tagging your relational database resources, \n see Tagging Amazon RDS Resources\n or Tagging Amazon Aurora and Amazon RDS Resources.\n

", + "smithy.api#examples": [ + { + "title": "To add tags to a resource", + "documentation": "This example adds a tag to an option group.", + "input": { + "ResourceName": "arn:aws:rds:us-east-1:992648334831:og:mymysqloptiongroup", + "Tags": [ + { + "Key": "Staging", + "Value": "LocationDB" + } + ] + } + } + ] + } + }, + "com.amazonaws.rds#AddTagsToResourceMessage": { + "type": "structure", + "members": { + "ResourceName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon RDS resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about \n creating an ARN, \n see \n Constructing an RDS Amazon Resource Name (ARN).

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The tags to be assigned to the Amazon RDS resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#AmazonRDSv19": { + "type": "service", + "version": "2014-10-31", + "operations": [ + { + "target": "com.amazonaws.rds#AddRoleToDBCluster" + }, + { + "target": "com.amazonaws.rds#AddRoleToDBInstance" + }, + { + "target": "com.amazonaws.rds#AddSourceIdentifierToSubscription" + }, + { + "target": "com.amazonaws.rds#AddTagsToResource" + }, + { + "target": "com.amazonaws.rds#ApplyPendingMaintenanceAction" + }, + { + "target": "com.amazonaws.rds#AuthorizeDBSecurityGroupIngress" + }, + { + "target": "com.amazonaws.rds#BacktrackDBCluster" + }, + { + "target": "com.amazonaws.rds#CancelExportTask" + }, + { + "target": "com.amazonaws.rds#CopyDBClusterParameterGroup" + }, + { + "target": "com.amazonaws.rds#CopyDBClusterSnapshot" + }, + { + "target": "com.amazonaws.rds#CopyDBParameterGroup" + }, + { + "target": "com.amazonaws.rds#CopyDBSnapshot" + }, + { + "target": "com.amazonaws.rds#CopyOptionGroup" + }, + { + "target": "com.amazonaws.rds#CreateBlueGreenDeployment" + }, + { + "target": "com.amazonaws.rds#CreateCustomDBEngineVersion" + }, + { + "target": "com.amazonaws.rds#CreateDBCluster" + }, + { + "target": "com.amazonaws.rds#CreateDBClusterEndpoint" + }, + { + "target": "com.amazonaws.rds#CreateDBClusterParameterGroup" + }, + { + "target": "com.amazonaws.rds#CreateDBClusterSnapshot" + }, + { + "target": "com.amazonaws.rds#CreateDBInstance" + }, + { + "target": "com.amazonaws.rds#CreateDBInstanceReadReplica" + }, + { + "target": "com.amazonaws.rds#CreateDBParameterGroup" + }, + { + "target": "com.amazonaws.rds#CreateDBProxy" + }, + { + "target": "com.amazonaws.rds#CreateDBProxyEndpoint" + }, + { + "target": "com.amazonaws.rds#CreateDBSecurityGroup" + }, + { + "target": "com.amazonaws.rds#CreateDBShardGroup" + }, + { + "target": "com.amazonaws.rds#CreateDBSnapshot" + }, + { + "target": "com.amazonaws.rds#CreateDBSubnetGroup" + }, + { + "target": "com.amazonaws.rds#CreateEventSubscription" + }, + { + "target": "com.amazonaws.rds#CreateGlobalCluster" + }, + { + "target": "com.amazonaws.rds#CreateIntegration" + }, + { + "target": "com.amazonaws.rds#CreateOptionGroup" + }, + { + "target": "com.amazonaws.rds#CreateTenantDatabase" + }, + { + "target": "com.amazonaws.rds#DeleteBlueGreenDeployment" + }, + { + "target": "com.amazonaws.rds#DeleteCustomDBEngineVersion" + }, + { + "target": "com.amazonaws.rds#DeleteDBCluster" + }, + { + "target": "com.amazonaws.rds#DeleteDBClusterAutomatedBackup" + }, + { + "target": "com.amazonaws.rds#DeleteDBClusterEndpoint" + }, + { + "target": "com.amazonaws.rds#DeleteDBClusterParameterGroup" + }, + { + "target": "com.amazonaws.rds#DeleteDBClusterSnapshot" + }, + { + "target": "com.amazonaws.rds#DeleteDBInstance" + }, + { + "target": "com.amazonaws.rds#DeleteDBInstanceAutomatedBackup" + }, + { + "target": "com.amazonaws.rds#DeleteDBParameterGroup" + }, + { + "target": "com.amazonaws.rds#DeleteDBProxy" + }, + { + "target": "com.amazonaws.rds#DeleteDBProxyEndpoint" + }, + { + "target": "com.amazonaws.rds#DeleteDBSecurityGroup" + }, + { + "target": "com.amazonaws.rds#DeleteDBShardGroup" + }, + { + "target": "com.amazonaws.rds#DeleteDBSnapshot" + }, + { + "target": "com.amazonaws.rds#DeleteDBSubnetGroup" + }, + { + "target": "com.amazonaws.rds#DeleteEventSubscription" + }, + { + "target": "com.amazonaws.rds#DeleteGlobalCluster" + }, + { + "target": "com.amazonaws.rds#DeleteIntegration" + }, + { + "target": "com.amazonaws.rds#DeleteOptionGroup" + }, + { + "target": "com.amazonaws.rds#DeleteTenantDatabase" + }, + { + "target": "com.amazonaws.rds#DeregisterDBProxyTargets" + }, + { + "target": "com.amazonaws.rds#DescribeAccountAttributes" + }, + { + "target": "com.amazonaws.rds#DescribeBlueGreenDeployments" + }, + { + "target": "com.amazonaws.rds#DescribeCertificates" + }, + { + "target": "com.amazonaws.rds#DescribeDBClusterAutomatedBackups" + }, + { + "target": "com.amazonaws.rds#DescribeDBClusterBacktracks" + }, + { + "target": "com.amazonaws.rds#DescribeDBClusterEndpoints" + }, + { + "target": "com.amazonaws.rds#DescribeDBClusterParameterGroups" + }, + { + "target": "com.amazonaws.rds#DescribeDBClusterParameters" + }, + { + "target": "com.amazonaws.rds#DescribeDBClusters" + }, + { + "target": "com.amazonaws.rds#DescribeDBClusterSnapshotAttributes" + }, + { + "target": "com.amazonaws.rds#DescribeDBClusterSnapshots" + }, + { + "target": "com.amazonaws.rds#DescribeDBEngineVersions" + }, + { + "target": "com.amazonaws.rds#DescribeDBInstanceAutomatedBackups" + }, + { + "target": "com.amazonaws.rds#DescribeDBInstances" + }, + { + "target": "com.amazonaws.rds#DescribeDBLogFiles" + }, + { + "target": "com.amazonaws.rds#DescribeDBParameterGroups" + }, + { + "target": "com.amazonaws.rds#DescribeDBParameters" + }, + { + "target": "com.amazonaws.rds#DescribeDBProxies" + }, + { + "target": "com.amazonaws.rds#DescribeDBProxyEndpoints" + }, + { + "target": "com.amazonaws.rds#DescribeDBProxyTargetGroups" + }, + { + "target": "com.amazonaws.rds#DescribeDBProxyTargets" + }, + { + "target": "com.amazonaws.rds#DescribeDBRecommendations" + }, + { + "target": "com.amazonaws.rds#DescribeDBSecurityGroups" + }, + { + "target": "com.amazonaws.rds#DescribeDBShardGroups" + }, + { + "target": "com.amazonaws.rds#DescribeDBSnapshotAttributes" + }, + { + "target": "com.amazonaws.rds#DescribeDBSnapshots" + }, + { + "target": "com.amazonaws.rds#DescribeDBSnapshotTenantDatabases" + }, + { + "target": "com.amazonaws.rds#DescribeDBSubnetGroups" + }, + { + "target": "com.amazonaws.rds#DescribeEngineDefaultClusterParameters" + }, + { + "target": "com.amazonaws.rds#DescribeEngineDefaultParameters" + }, + { + "target": "com.amazonaws.rds#DescribeEventCategories" + }, + { + "target": "com.amazonaws.rds#DescribeEvents" + }, + { + "target": "com.amazonaws.rds#DescribeEventSubscriptions" + }, + { + "target": "com.amazonaws.rds#DescribeExportTasks" + }, + { + "target": "com.amazonaws.rds#DescribeGlobalClusters" + }, + { + "target": "com.amazonaws.rds#DescribeIntegrations" + }, + { + "target": "com.amazonaws.rds#DescribeOptionGroupOptions" + }, + { + "target": "com.amazonaws.rds#DescribeOptionGroups" + }, + { + "target": "com.amazonaws.rds#DescribeOrderableDBInstanceOptions" + }, + { + "target": "com.amazonaws.rds#DescribePendingMaintenanceActions" + }, + { + "target": "com.amazonaws.rds#DescribeReservedDBInstances" + }, + { + "target": "com.amazonaws.rds#DescribeReservedDBInstancesOfferings" + }, + { + "target": "com.amazonaws.rds#DescribeSourceRegions" + }, + { + "target": "com.amazonaws.rds#DescribeTenantDatabases" + }, + { + "target": "com.amazonaws.rds#DescribeValidDBInstanceModifications" + }, + { + "target": "com.amazonaws.rds#DisableHttpEndpoint" + }, + { + "target": "com.amazonaws.rds#DownloadDBLogFilePortion" + }, + { + "target": "com.amazonaws.rds#EnableHttpEndpoint" + }, + { + "target": "com.amazonaws.rds#FailoverDBCluster" + }, + { + "target": "com.amazonaws.rds#FailoverGlobalCluster" + }, + { + "target": "com.amazonaws.rds#ListTagsForResource" + }, + { + "target": "com.amazonaws.rds#ModifyActivityStream" + }, + { + "target": "com.amazonaws.rds#ModifyCertificates" + }, + { + "target": "com.amazonaws.rds#ModifyCurrentDBClusterCapacity" + }, + { + "target": "com.amazonaws.rds#ModifyCustomDBEngineVersion" + }, + { + "target": "com.amazonaws.rds#ModifyDBCluster" + }, + { + "target": "com.amazonaws.rds#ModifyDBClusterEndpoint" + }, + { + "target": "com.amazonaws.rds#ModifyDBClusterParameterGroup" + }, + { + "target": "com.amazonaws.rds#ModifyDBClusterSnapshotAttribute" + }, + { + "target": "com.amazonaws.rds#ModifyDBInstance" + }, + { + "target": "com.amazonaws.rds#ModifyDBParameterGroup" + }, + { + "target": "com.amazonaws.rds#ModifyDBProxy" + }, + { + "target": "com.amazonaws.rds#ModifyDBProxyEndpoint" + }, + { + "target": "com.amazonaws.rds#ModifyDBProxyTargetGroup" + }, + { + "target": "com.amazonaws.rds#ModifyDBRecommendation" + }, + { + "target": "com.amazonaws.rds#ModifyDBShardGroup" + }, + { + "target": "com.amazonaws.rds#ModifyDBSnapshot" + }, + { + "target": "com.amazonaws.rds#ModifyDBSnapshotAttribute" + }, + { + "target": "com.amazonaws.rds#ModifyDBSubnetGroup" + }, + { + "target": "com.amazonaws.rds#ModifyEventSubscription" + }, + { + "target": "com.amazonaws.rds#ModifyGlobalCluster" + }, + { + "target": "com.amazonaws.rds#ModifyIntegration" + }, + { + "target": "com.amazonaws.rds#ModifyOptionGroup" + }, + { + "target": "com.amazonaws.rds#ModifyTenantDatabase" + }, + { + "target": "com.amazonaws.rds#PromoteReadReplica" + }, + { + "target": "com.amazonaws.rds#PromoteReadReplicaDBCluster" + }, + { + "target": "com.amazonaws.rds#PurchaseReservedDBInstancesOffering" + }, + { + "target": "com.amazonaws.rds#RebootDBCluster" + }, + { + "target": "com.amazonaws.rds#RebootDBInstance" + }, + { + "target": "com.amazonaws.rds#RebootDBShardGroup" + }, + { + "target": "com.amazonaws.rds#RegisterDBProxyTargets" + }, + { + "target": "com.amazonaws.rds#RemoveFromGlobalCluster" + }, + { + "target": "com.amazonaws.rds#RemoveRoleFromDBCluster" + }, + { + "target": "com.amazonaws.rds#RemoveRoleFromDBInstance" + }, + { + "target": "com.amazonaws.rds#RemoveSourceIdentifierFromSubscription" + }, + { + "target": "com.amazonaws.rds#RemoveTagsFromResource" + }, + { + "target": "com.amazonaws.rds#ResetDBClusterParameterGroup" + }, + { + "target": "com.amazonaws.rds#ResetDBParameterGroup" + }, + { + "target": "com.amazonaws.rds#RestoreDBClusterFromS3" + }, + { + "target": "com.amazonaws.rds#RestoreDBClusterFromSnapshot" + }, + { + "target": "com.amazonaws.rds#RestoreDBClusterToPointInTime" + }, + { + "target": "com.amazonaws.rds#RestoreDBInstanceFromDBSnapshot" + }, + { + "target": "com.amazonaws.rds#RestoreDBInstanceFromS3" + }, + { + "target": "com.amazonaws.rds#RestoreDBInstanceToPointInTime" + }, + { + "target": "com.amazonaws.rds#RevokeDBSecurityGroupIngress" + }, + { + "target": "com.amazonaws.rds#StartActivityStream" + }, + { + "target": "com.amazonaws.rds#StartDBCluster" + }, + { + "target": "com.amazonaws.rds#StartDBInstance" + }, + { + "target": "com.amazonaws.rds#StartDBInstanceAutomatedBackupsReplication" + }, + { + "target": "com.amazonaws.rds#StartExportTask" + }, + { + "target": "com.amazonaws.rds#StopActivityStream" + }, + { + "target": "com.amazonaws.rds#StopDBCluster" + }, + { + "target": "com.amazonaws.rds#StopDBInstance" + }, + { + "target": "com.amazonaws.rds#StopDBInstanceAutomatedBackupsReplication" + }, + { + "target": "com.amazonaws.rds#SwitchoverBlueGreenDeployment" + }, + { + "target": "com.amazonaws.rds#SwitchoverGlobalCluster" + }, + { + "target": "com.amazonaws.rds#SwitchoverReadReplica" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "RDS", + "arnNamespace": "rds", + "cloudFormationName": "RDS", + "cloudTrailEventSource": "rds.amazonaws.com", + "endpointPrefix": "rds" + }, + "aws.auth#sigv4": { + "name": "rds" + }, + "aws.protocols#awsQuery": {}, + "smithy.api#documentation": "Amazon Relational Database Service\n

\n

Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and \n scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational \n database and manages common database administration tasks, freeing up developers to focus on what makes their applications \n and businesses unique.

\n

Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, \n Oracle, Db2, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools \n you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS \n automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS \n is flexible: you can scale your DB instance's compute resources and storage capacity to meet your \n application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for \n the resources you use.

\n

This interface reference for Amazon RDS contains documentation for a programming or command line interface \n you can use to manage Amazon RDS. Amazon RDS is asynchronous, which means that some interfaces might \n require techniques such as polling or callback functions to determine when a command has been applied. In this \n reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, \n or during the maintenance window. The reference structure is as follows, and we list following some related topics \n from the user guide.

\n

\n Amazon RDS API Reference\n

\n
    \n
  • \n

    For the alphabetical list of API actions, see \n API Actions.

    \n
    • \n
  • \n

    For the alphabetical list of data types, see \n Data Types.

    \n
    • \n
  • \n

    For a list of common query parameters, see \n Common Parameters.

    \n
    • \n
  • \n

    For descriptions of the error codes, see \n Common Errors.

    \n
    • \n
\n

\n Amazon RDS User Guide\n

\n ", + "smithy.api#title": "Amazon Relational Database Service", + "smithy.api#xmlNamespace": { + "uri": "http://rds.amazonaws.com/doc/2014-10-31/" + }, + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://rds-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-us-gov" + ] + } + ], + "endpoint": { + "url": "https://rds.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://rds-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://rds.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://rds.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.af-south-1.amazonaws.com" + } + }, + "params": { + "Region": "af-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.ap-east-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.ap-south-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.eu-north-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.eu-south-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.eu-west-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.eu-west-3.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.me-south-1.amazonaws.com" + } + }, + "params": { + "Region": "me-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.sa-east-1.amazonaws.com" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.us-iso-west-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.rds#ApplyMethod": { + "type": "enum", + "members": { + "immediate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "immediate" + } + }, + "pending_reboot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending-reboot" + } + } + } + }, + "com.amazonaws.rds#ApplyPendingMaintenanceAction": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ApplyPendingMaintenanceActionMessage" + }, + "output": { + "target": "com.amazonaws.rds#ApplyPendingMaintenanceActionResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Applies a pending maintenance action to a resource (for example, to a DB instance).

", + "smithy.api#examples": [ + { + "title": "To apply pending maintenance actions", + "documentation": "The following example applies the pending maintenance actions for a DB cluster.", + "input": { + "ResourceIdentifier": "arn:aws:rds:us-east-1:123456789012:cluster:my-db-cluster", + "ApplyAction": "system-update", + "OptInType": "immediate" + }, + "output": { + "ResourcePendingMaintenanceActions": { + "ResourceIdentifier": "arn:aws:rds:us-east-1:123456789012:cluster:my-db-cluster", + "PendingMaintenanceActionDetails": [ + { + "Action": "system-update", + "OptInStatus": "immediate", + "CurrentApplyDate": "2021-01-23T01:07:36.100Z", + "Description": "Upgrade to Aurora PostgreSQL 3.3.2" + } + ] + } + } + } + ] + } + }, + "com.amazonaws.rds#ApplyPendingMaintenanceActionMessage": { + "type": "structure", + "members": { + "ResourceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The RDS Amazon Resource Name (ARN) of the resource that the \n pending maintenance action applies to. For information about \n creating an ARN, \n see \n Constructing an RDS Amazon Resource Name (ARN).

", + "smithy.api#required": {} + } + }, + "ApplyAction": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The pending maintenance action to apply to this resource.

\n

Valid Values:

\n
    \n
  • \n

    \n ca-certificate-rotation\n

    \n
    • \n
  • \n

    \n db-upgrade\n

    \n
    • \n
  • \n

    \n hardware-maintenance\n

    \n
    • \n
  • \n

    \n os-upgrade\n

    \n
    • \n
  • \n

    \n system-update\n

    \n
    • \n
\n

For more information about these actions, see \n Maintenance actions for Amazon Aurora or \n Maintenance actions for Amazon RDS.

", + "smithy.api#required": {} + } + }, + "OptInType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in \n request of type immediate can't be undone.

\n

Valid Values:

\n
    \n
  • \n

    \n immediate - Apply the maintenance action immediately.

    \n
    • \n
  • \n

    \n next-maintenance - Apply the maintenance action during\n the next maintenance window for the resource.

    \n
    • \n
  • \n

    \n undo-opt-in - Cancel any existing next-maintenance\n opt-in requests.

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ApplyPendingMaintenanceActionResult": { + "type": "structure", + "members": { + "ResourcePendingMaintenanceActions": { + "target": "com.amazonaws.rds#ResourcePendingMaintenanceActions" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#Arn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + } + } + }, + "com.amazonaws.rds#AttributeValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#xmlName": "AttributeValue" + } + } + }, + "com.amazonaws.rds#AuditPolicyState": { + "type": "enum", + "members": { + "LOCKED_POLICY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "locked" + } + }, + "UNLOCKED_POLICY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unlocked" + } + } + } + }, + "com.amazonaws.rds#AuthScheme": { + "type": "enum", + "members": { + "SECRETS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SECRETS" + } + } + } + }, + "com.amazonaws.rds#AuthorizationAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AuthorizationAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The specified CIDR IP range or Amazon EC2 security group is already authorized for\n the specified DB security group.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#AuthorizationNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AuthorizationNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified CIDR IP range or Amazon EC2 security group might not be authorized\n for the specified DB security group.

\n

Or, RDS might not be authorized to perform necessary actions using IAM on your\n behalf.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#AuthorizationQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AuthorizationQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The DB security group authorization quota has been reached.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#AuthorizeDBSecurityGroupIngress": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#AuthorizeDBSecurityGroupIngressMessage" + }, + "output": { + "target": "com.amazonaws.rds#AuthorizeDBSecurityGroupIngressResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#AuthorizationAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#AuthorizationQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSecurityGroupStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security \n groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC \n instances. Second, IP ranges are available if the application accessing your database is running on the internet. \n Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId \n and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).

\n

You can't authorize ingress from an EC2 security group in one Amazon Web Services Region to an Amazon RDS DB instance in \n another. You can't authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.

\n

For an overview of CIDR ranges, go to the \n Wikipedia Tutorial.

\n \n

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – \n Here’s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

\n ", + "smithy.api#examples": [ + { + "title": "To authorize DB security group integress", + "documentation": "This example authorizes access to the specified security group by the specified CIDR block.", + "input": { + "DBSecurityGroupName": "mydbsecuritygroup", + "CIDRIP": "203.0.113.5/32" + }, + "output": { + "DBSecurityGroup": {} + } + } + ] + } + }, + "com.amazonaws.rds#AuthorizeDBSecurityGroupIngressMessage": { + "type": "structure", + "members": { + "DBSecurityGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the DB security group to add authorization to.

", + "smithy.api#required": {} + } + }, + "CIDRIP": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The IP range to authorize.

" + } + }, + "EC2SecurityGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Name of the EC2 security group to authorize.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName \n or EC2SecurityGroupId must be provided.

" + } + }, + "EC2SecurityGroupId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Id of the EC2 security group to authorize.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" + } + }, + "EC2SecurityGroupOwnerId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Amazon Web Services account number of the owner of the EC2 security group\n specified in the EC2SecurityGroupName parameter.\n The Amazon Web Services access key ID isn't an acceptable value.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#AuthorizeDBSecurityGroupIngressResult": { + "type": "structure", + "members": { + "DBSecurityGroup": { + "target": "com.amazonaws.rds#DBSecurityGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#AutomationMode": { + "type": "enum", + "members": { + "FULL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "full" + } + }, + "ALL_PAUSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "all-paused" + } + } + } + }, + "com.amazonaws.rds#AvailabilityZone": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the Availability Zone.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains Availability Zone information.

\n

This data type is used as an element in the OrderableDBInstanceOption\n data type.

" + } + }, + "com.amazonaws.rds#AvailabilityZoneList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#AvailabilityZone", + "traits": { + "smithy.api#xmlName": "AvailabilityZone" + } + } + }, + "com.amazonaws.rds#AvailabilityZones": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#xmlName": "AvailabilityZone" + } + } + }, + "com.amazonaws.rds#AvailableProcessorFeature": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the processor feature. Valid names are coreCount \n and threadsPerCore.

" + } + }, + "DefaultValue": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The default value for the processor feature of the DB instance class.

" + } + }, + "AllowedValues": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The allowed values for the processor feature of the DB instance class.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the available processor feature information for the DB instance class of a DB instance.

\n

For more information, see Configuring the\n Processor of the DB Instance Class in the Amazon RDS User Guide.\n \n

" + } + }, + "com.amazonaws.rds#AvailableProcessorFeatureList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#AvailableProcessorFeature", + "traits": { + "smithy.api#xmlName": "AvailableProcessorFeature" + } + } + }, + "com.amazonaws.rds#AwsBackupRecoveryPointArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 43, + "max": 350 + }, + "smithy.api#pattern": "^arn:aws[a-z-]*:backup:[-a-z0-9]+:[0-9]{12}:[-a-z]+:([a-z0-9\\-]+:)?[a-z][a-z0-9\\-]{0,255}$" + } + }, + "com.amazonaws.rds#BacktrackDBCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#BacktrackDBClusterMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBClusterBacktrack" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Backtracks a DB cluster to a specific time, without creating a new DB cluster.

\n

For more information on backtracking, see \n \n Backtracking an Aurora DB Cluster in the \n Amazon Aurora User Guide.

\n \n

This action applies only to Aurora MySQL DB clusters.

\n " + } + }, + "com.amazonaws.rds#BacktrackDBClusterMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The DB cluster identifier of the DB cluster to be backtracked. This parameter is\n stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 alphanumeric characters or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Example: my-cluster1\n

", + "smithy.api#required": {} + } + }, + "BacktrackTo": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The timestamp of the time to backtrack the DB cluster to, specified in ISO\n 8601 format. For more information about ISO 8601, see the ISO8601 Wikipedia\n page.\n

\n \n

If the specified time isn't a consistent time for the DB cluster, \n Aurora automatically chooses the nearest possible consistent time for the DB cluster.

\n \n

Constraints:

\n
    \n
  • \n

    Must contain a valid ISO 8601 timestamp.

    \n
    • \n
  • \n

    Can't contain a timestamp set in the future.

    \n
    • \n
\n

Example: 2017-07-08T18:00Z\n

", + "smithy.api#required": {} + } + }, + "Force": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to force the DB cluster to backtrack when binary logging is\n enabled. Otherwise, an error occurs when binary logging is enabled.

" + } + }, + "UseEarliestTimeOnPointInTimeUnavailable": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to backtrack the DB cluster to the earliest possible\n backtrack time when BacktrackTo is set to a timestamp earlier than the earliest\n backtrack time. When this parameter is disabled and BacktrackTo is set to a timestamp earlier than the earliest\n backtrack time, an error occurs.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#BackupPolicyNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "BackupPolicyNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#deprecated": { + "message": "Please avoid using this fault" + }, + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#BlueGreenDeployment": { + "type": "structure", + "members": { + "BlueGreenDeploymentIdentifier": { + "target": "com.amazonaws.rds#BlueGreenDeploymentIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the blue/green deployment.

" + } + }, + "BlueGreenDeploymentName": { + "target": "com.amazonaws.rds#BlueGreenDeploymentName", + "traits": { + "smithy.api#documentation": "

The user-supplied name of the blue/green deployment.

" + } + }, + "Source": { + "target": "com.amazonaws.rds#DatabaseArn", + "traits": { + "smithy.api#documentation": "

The source database for the blue/green deployment.

\n

Before switchover, the source database is the production database in the blue environment.

" + } + }, + "Target": { + "target": "com.amazonaws.rds#DatabaseArn", + "traits": { + "smithy.api#documentation": "

The target database for the blue/green deployment.

\n

Before switchover, the target database is the clone database in the green environment.

" + } + }, + "SwitchoverDetails": { + "target": "com.amazonaws.rds#SwitchoverDetailList", + "traits": { + "smithy.api#documentation": "

The details about each source and target resource in the blue/green deployment.

" + } + }, + "Tasks": { + "target": "com.amazonaws.rds#BlueGreenDeploymentTaskList", + "traits": { + "smithy.api#documentation": "

Either tasks to be performed or tasks that have been completed on the target database before switchover.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#BlueGreenDeploymentStatus", + "traits": { + "smithy.api#documentation": "

The status of the blue/green deployment.

\n

Valid Values:

\n
    \n
  • \n

    \n PROVISIONING - Resources are being created in the green environment.

    \n
    • \n
  • \n

    \n AVAILABLE - Resources are available in the green environment.

    \n
    • \n
  • \n

    \n SWITCHOVER_IN_PROGRESS - The deployment is being switched from the blue environment to the \n green environment.

    \n
    • \n
  • \n

    \n SWITCHOVER_COMPLETED - Switchover from the blue environment to the green environment is complete.

    \n
    • \n
  • \n

    \n INVALID_CONFIGURATION - Resources in the green environment are invalid, so switchover isn't possible.

    \n
    • \n
  • \n

    \n SWITCHOVER_FAILED - Switchover was attempted but failed.

    \n
    • \n
  • \n

    \n DELETING - The blue/green deployment is being deleted.

    \n
    • \n
" + } + }, + "StatusDetails": { + "target": "com.amazonaws.rds#BlueGreenDeploymentStatusDetails", + "traits": { + "smithy.api#documentation": "

Additional information about the status of the blue/green deployment.

" + } + }, + "CreateTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The time when the blue/green deployment was created, in Universal Coordinated Time\n (UTC).

" + } + }, + "DeleteTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The time when the blue/green deployment was deleted, in Universal Coordinated Time\n (UTC).

" + } + }, + "TagList": { + "target": "com.amazonaws.rds#TagList" + } + }, + "traits": { + "smithy.api#documentation": "

Details about a blue/green deployment.

\n

For more information, see Using Amazon RDS\n Blue/Green Deployments for database updates in the Amazon RDS User\n Guide and Using Amazon RDS\n Blue/Green Deployments for database updates in the Amazon Aurora\n User Guide.

" + } + }, + "com.amazonaws.rds#BlueGreenDeploymentAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "BlueGreenDeploymentAlreadyExistsFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

A blue/green deployment with the specified name already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#BlueGreenDeploymentIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[A-Za-z][0-9A-Za-z-:._]*$" + } + }, + "com.amazonaws.rds#BlueGreenDeploymentList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#BlueGreenDeployment" + } + }, + "com.amazonaws.rds#BlueGreenDeploymentName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 60 + }, + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$" + } + }, + "com.amazonaws.rds#BlueGreenDeploymentNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "BlueGreenDeploymentNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

\n BlueGreenDeploymentIdentifier doesn't refer to an existing blue/green deployment.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#BlueGreenDeploymentStatus": { + "type": "string" + }, + "com.amazonaws.rds#BlueGreenDeploymentStatusDetails": { + "type": "string" + }, + "com.amazonaws.rds#BlueGreenDeploymentTask": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.rds#BlueGreenDeploymentTaskName", + "traits": { + "smithy.api#documentation": "

The name of the blue/green deployment task.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#BlueGreenDeploymentTaskStatus", + "traits": { + "smithy.api#documentation": "

The status of the blue/green deployment task.

\n

Valid Values:

\n
    \n
  • \n

    \n PENDING - The resource is being prepared for deployment.

    \n
    • \n
  • \n

    \n IN_PROGRESS - The resource is being deployed.

    \n
    • \n
  • \n

    \n COMPLETED - The resource has been deployed.

    \n
    • \n
  • \n

    \n FAILED - Deployment of the resource failed.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about a task for a blue/green deployment.

\n

For more information, see Using Amazon RDS\n Blue/Green Deployments for database updates in the Amazon RDS User\n Guide and Using Amazon RDS\n Blue/Green Deployments for database updates in the Amazon Aurora\n User Guide.

" + } + }, + "com.amazonaws.rds#BlueGreenDeploymentTaskList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#BlueGreenDeploymentTask" + } + }, + "com.amazonaws.rds#BlueGreenDeploymentTaskName": { + "type": "string" + }, + "com.amazonaws.rds#BlueGreenDeploymentTaskStatus": { + "type": "string" + }, + "com.amazonaws.rds#Boolean": { + "type": "boolean" + }, + "com.amazonaws.rds#BooleanOptional": { + "type": "boolean" + }, + "com.amazonaws.rds#BucketName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.rds#CACertificateIdentifiersList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String" + } + }, + "com.amazonaws.rds#CancelExportTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CancelExportTaskMessage" + }, + "output": { + "target": "com.amazonaws.rds#ExportTask" + }, + "errors": [ + { + "target": "com.amazonaws.rds#ExportTaskNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidExportTaskStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Cancels an export task in progress that is exporting a snapshot or cluster to Amazon S3. \n Any data that has already been written to the S3 bucket isn't removed.

", + "smithy.api#examples": [ + { + "title": "To cancel a snapshot export to Amazon S3", + "documentation": "The following example cancels an export task in progress that is exporting a snapshot to Amazon S3.", + "input": { + "ExportTaskIdentifier": "my-s3-export-1" + }, + "output": { + "ExportTaskIdentifier": "my-s3-export-1", + "SourceArn": "arn:aws:rds:us-east-1:123456789012:snapshot:publisher-final-snapshot", + "SnapshotTime": "2019-03-24T20:01:09.815Z", + "S3Bucket": "mybucket", + "S3Prefix": "", + "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/export-snap-S3-role", + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/abcd0000-7bfd-4594-af38-aabbccddeeff", + "Status": "CANCELING", + "PercentProgress": 0, + "TotalExtractedDataInGB": 0 + } + } + ] + } + }, + "com.amazonaws.rds#CancelExportTaskMessage": { + "type": "structure", + "members": { + "ExportTaskIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier of the snapshot or cluster export task to cancel.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#Certificate": { + "type": "structure", + "members": { + "CertificateIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The unique key that identifies a certificate.

" + } + }, + "CertificateType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The type of the certificate.

" + } + }, + "Thumbprint": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The thumbprint of the certificate.

" + } + }, + "ValidFrom": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The starting date from which the certificate is valid.

" + } + }, + "ValidTill": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The final date that the certificate continues to be valid.

" + } + }, + "CertificateArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the certificate.

" + } + }, + "CustomerOverride": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether there is an override for the default certificate identifier.

" + } + }, + "CustomerOverrideValidTill": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

If there is an override for the default certificate identifier, when the override\n expires.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A CA certificate for an Amazon Web Services account.

\n

For more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.

" + } + }, + "com.amazonaws.rds#CertificateDetails": { + "type": "structure", + "members": { + "CAIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The CA identifier of the CA certificate used for the DB instance's server certificate.

" + } + }, + "ValidTill": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The expiration date of the DB instance’s server certificate.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The details of the DB instance’s server certificate.

\n

For more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.

" + } + }, + "com.amazonaws.rds#CertificateList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#Certificate", + "traits": { + "smithy.api#xmlName": "Certificate" + } + } + }, + "com.amazonaws.rds#CertificateMessage": { + "type": "structure", + "members": { + "DefaultCertificateForNewLaunches": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The default root CA for new databases created by your Amazon Web Services account. This is either the root CA override \n set on your Amazon Web Services account or the system default CA for the Region if no override exists. To override the default CA, use the \n ModifyCertificates operation.

" + } + }, + "Certificates": { + "target": "com.amazonaws.rds#CertificateList", + "traits": { + "smithy.api#documentation": "

The list of Certificate objects for the Amazon Web Services account.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeCertificates request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Data returned by the DescribeCertificates action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#CertificateNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "CertificateNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

\n CertificateIdentifier doesn't refer to an\n existing certificate.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#CharacterSet": { + "type": "structure", + "members": { + "CharacterSetName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the character set.

" + } + }, + "CharacterSetDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The description of the character set.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a response element in the action DescribeDBEngineVersions.

" + } + }, + "com.amazonaws.rds#ClientPasswordAuthType": { + "type": "enum", + "members": { + "MYSQL_NATIVE_PASSWORD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MYSQL_NATIVE_PASSWORD" + } + }, + "MYSQL_CACHING_SHA2_PASSWORD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MYSQL_CACHING_SHA2_PASSWORD" + } + }, + "POSTGRES_SCRAM_SHA_256": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POSTGRES_SCRAM_SHA_256" + } + }, + "POSTGRES_MD5": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POSTGRES_MD5" + } + }, + "SQL_SERVER_AUTHENTICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SQL_SERVER_AUTHENTICATION" + } + } + } + }, + "com.amazonaws.rds#CloudwatchLogsExportConfiguration": { + "type": "structure", + "members": { + "EnableLogTypes": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

The list of log types to enable.

\n

The following values are valid for each DB engine:

\n
    \n
  • \n

    Aurora MySQL - audit | error | general | slowquery\n

    \n
    • \n
  • \n

    Aurora PostgreSQL - postgresql\n

    \n
    • \n
  • \n

    RDS for MySQL - error | general | slowquery\n

    \n
    • \n
  • \n

    RDS for PostgreSQL - postgresql | upgrade\n

    \n
    • \n
" + } + }, + "DisableLogTypes": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

The list of log types to disable.

\n

The following values are valid for each DB engine:

\n
    \n
  • \n

    Aurora MySQL - audit | error | general | slowquery\n

    \n
    • \n
  • \n

    Aurora PostgreSQL - postgresql\n

    \n
    • \n
  • \n

    RDS for MySQL - error | general | slowquery\n

    \n
    • \n
  • \n

    RDS for PostgreSQL - postgresql | upgrade\n

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration setting for the log types to be enabled for export to CloudWatch\n Logs for a specific DB instance or DB cluster.

\n

The EnableLogTypes and DisableLogTypes arrays determine which logs will be exported\n (or not exported) to CloudWatch Logs. The values within these arrays depend on the DB\n engine being used.

\n

For more information about exporting CloudWatch Logs for Amazon RDS DB instances, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

For more information about exporting CloudWatch Logs for Amazon Aurora DB clusters, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

" + } + }, + "com.amazonaws.rds#ClusterPendingModifiedValues": { + "type": "structure", + "members": { + "PendingCloudwatchLogsExports": { + "target": "com.amazonaws.rds#PendingCloudwatchLogsExports" + }, + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DBClusterIdentifier value for the DB cluster.

" + } + }, + "MasterUserPassword": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The master credentials for the DB cluster.

" + } + }, + "IAMDatabaseAuthenticationEnabled": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The database engine version.

" + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days for which automatic DB snapshots are retained.

" + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The allocated storage size in gibibytes (GiB) for all database engines except Amazon Aurora. For Aurora, \n AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but \n instead automatically adjusts as needed.

" + } + }, + "RdsCustomClusterConfiguration": { + "target": "com.amazonaws.rds#RdsCustomClusterConfiguration", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The storage type for the DB cluster.

" + } + }, + "CertificateDetails": { + "target": "com.amazonaws.rds#CertificateDetails" + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a response element in the ModifyDBCluster operation and \n contains changes that will be applied during the next maintenance window.

" + } + }, + "com.amazonaws.rds#ClusterScalabilityType": { + "type": "enum", + "members": { + "STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "standard" + } + }, + "LIMITLESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "limitless" + } + } + } + }, + "com.amazonaws.rds#ConnectionPoolConfiguration": { + "type": "structure", + "members": { + "MaxConnectionsPercent": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the\n max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.

\n

If you specify MaxIdleConnectionsPercent, then you must also include a value for this parameter.

\n

Default: 10 for RDS for Microsoft SQL Server, and 100 for all other engines

\n

Constraints:

\n
    \n
  • \n

    Must be between 1 and 100.

    \n
    • \n
" + } + }, + "MaxIdleConnectionsPercent": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

A value that controls how actively the proxy closes idle database connections in the connection pool.\n The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.\n With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.

\n

If you specify this parameter, then you must also include a value for MaxConnectionsPercent.

\n

Default: The default value is half of the value of MaxConnectionsPercent. For example, if MaxConnectionsPercent is 80, then the default value of \n MaxIdleConnectionsPercent is 40. If the value of MaxConnectionsPercent isn't specified, then for SQL Server, MaxIdleConnectionsPercent is 5, and \n for all other engines, the default is 50.

\n

Constraints:

\n
    \n
  • \n

    Must be between 0 and the value of MaxConnectionsPercent.

    \n
    • \n
" + } + }, + "ConnectionBorrowTimeout": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of seconds for a proxy to wait for a connection to become available in the connection pool. This setting only applies when the\n proxy has opened its maximum number of connections and all connections are busy with client sessions.

\n

Default: 120\n

\n

Constraints:

\n
    \n
  • \n

    Must be between 0 and 3600.

    \n
    • \n
" + } + }, + "SessionPinningFilters": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

Each item in the list represents a class of SQL operations that normally cause all later statements\n in a session using a proxy to be pinned to the same underlying database connection. Including an item\n in the list exempts that class of SQL operations from the pinning behavior.

\n

Default: no session pinning filters

" + } + }, + "InitQuery": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

One or more SQL statements for the proxy to run when opening each new database connection.\n Typically used with SET statements to make sure that each connection has identical\n settings such as time zone and character set. For multiple statements, use semicolons as the separator.\n You can also include multiple variables in a single SET statement, such as\n SET x=1, y=2.

\n

Default: no initialization query

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the settings that control the size and behavior of the connection pool associated with a DBProxyTargetGroup.

" + } + }, + "com.amazonaws.rds#ConnectionPoolConfigurationInfo": { + "type": "structure", + "members": { + "MaxConnectionsPercent": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#documentation": "

The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the\n max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.

" + } + }, + "MaxIdleConnectionsPercent": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#documentation": "

Controls how actively the proxy closes idle database connections in the connection pool.\n The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.\n With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.

" + } + }, + "ConnectionBorrowTimeout": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#documentation": "

The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the\n proxy has opened its maximum number of connections and all connections are busy with client sessions.

" + } + }, + "SessionPinningFilters": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

Each item in the list represents a class of SQL operations that normally cause all later statements\n in a session using a proxy to be pinned to the same underlying database connection. Including an item\n in the list exempts that class of SQL operations from the pinning behavior. This setting is only supported for MySQL engine family databases. \n Currently, the only allowed value is EXCLUDE_VARIABLE_SETS.

" + } + }, + "InitQuery": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

One or more SQL statements for the proxy to run when opening each new database connection.\n Typically used with SET statements to make sure that each connection has identical\n settings such as time zone and character set. This setting is empty by default.\n For multiple statements, use semicolons as the separator.\n You can also include multiple variables in a single SET statement, such as\n SET x=1, y=2.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Displays the settings that control the size and behavior of the connection pool associated with a DBProxyTarget.

" + } + }, + "com.amazonaws.rds#ContextAttribute": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The key of ContextAttribute.

" + } + }, + "Value": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The value of ContextAttribute.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The additional attributes of RecommendedAction data type.

" + } + }, + "com.amazonaws.rds#ContextAttributeList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#ContextAttribute" + } + }, + "com.amazonaws.rds#CopyDBClusterParameterGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CopyDBClusterParameterGroupMessage" + }, + "output": { + "target": "com.amazonaws.rds#CopyDBClusterParameterGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBParameterGroupAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBParameterGroupQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Copies the specified DB cluster parameter group.

\n \n

You can't copy a default DB cluster parameter group. Instead, create a new custom DB cluster parameter group, which copies\n the default parameters and values for the specified DB cluster parameter group family.

\n ", + "smithy.api#examples": [ + { + "title": "To copy a DB cluster parameter group", + "documentation": "This example copies a DB cluster parameter group.", + "input": { + "SourceDBClusterParameterGroupIdentifier": "mydbclusterparametergroup", + "TargetDBClusterParameterGroupIdentifier": "mydbclusterparametergroup-copy", + "TargetDBClusterParameterGroupDescription": "My DB cluster parameter group copy" + }, + "output": { + "DBClusterParameterGroup": { + "DBClusterParameterGroupName": "mydbclusterparametergroup-copy", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterparametergroup-copy", + "DBParameterGroupFamily": "aurora-mysql5.7", + "Description": "My DB cluster parameter group copy" + } + } + } + ] + } + }, + "com.amazonaws.rds#CopyDBClusterParameterGroupMessage": { + "type": "structure", + "members": { + "SourceDBClusterParameterGroupIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group.\n For information about \n creating an ARN, \n see \n Constructing an ARN for Amazon RDS in the Amazon Aurora User Guide.

\n

Constraints:

\n
    \n
  • \n

    Must specify a valid DB cluster parameter group.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "TargetDBClusterParameterGroupIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier for the copied DB cluster parameter group.

\n

Constraints:

\n
    \n
  • \n

    Can't be null, empty, or blank

    \n
    • \n
  • \n

    Must contain from 1 to 255 letters, numbers, or hyphens

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
\n

Example: my-cluster-param-group1\n

", + "smithy.api#required": {} + } + }, + "TargetDBClusterParameterGroupDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A description for the copied DB cluster parameter group.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#CopyDBClusterParameterGroupResult": { + "type": "structure", + "members": { + "DBClusterParameterGroup": { + "target": "com.amazonaws.rds#DBClusterParameterGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#CopyDBClusterSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CopyDBClusterSnapshotMessage" + }, + "output": { + "target": "com.amazonaws.rds#CopyDBClusterSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterSnapshotAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterSnapshotStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + }, + { + "target": "com.amazonaws.rds#SnapshotQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Copies a snapshot of a DB cluster.

\n

To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier\n must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.

\n

You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case,\n the Amazon Web Services Region where you call the CopyDBClusterSnapshot operation is the\n destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy\n an encrypted DB cluster snapshot from another Amazon Web Services Region, you must provide the\n following values:

\n
    \n
  • \n

    \n KmsKeyId - The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to \n encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region.

    \n
    • \n
  • \n

    \n TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination Amazon Web Services Region.

    \n
    • \n
  • \n

    \n SourceDBClusterSnapshotIdentifier - The DB cluster snapshot\n identifier for the encrypted DB cluster snapshot to be copied. This identifier\n must be in the ARN format for the source Amazon Web Services Region and is the same value as\n the SourceDBClusterSnapshotIdentifier in the presigned URL.

    \n
    • \n
\n

To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified\n by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in \"copying\" status.

\n

For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region to another, see \n \n Copying a Snapshot in the Amazon Aurora User Guide.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

", + "smithy.api#examples": [ + { + "title": "To copy a DB cluster snapshot", + "documentation": "The following example creates a copy of a DB cluster snapshot, including its tags.", + "input": { + "SourceDBClusterSnapshotIdentifier": "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:rds:myaurora-2019-06-04-09-16", + "TargetDBClusterSnapshotIdentifier": "myclustersnapshotcopy", + "CopyTags": true + }, + "output": { + "DBClusterSnapshot": { + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1e" + ], + "DBClusterSnapshotIdentifier": "myclustersnapshotcopy", + "DBClusterIdentifier": "myaurora", + "SnapshotCreateTime": "2019-06-04T09:16:42.649Z", + "Engine": "aurora-mysql", + "AllocatedStorage": 0, + "Status": "available", + "Port": 0, + "VpcId": "vpc-123example", + "ClusterCreateTime": "2019-04-15T14:18:42.785Z", + "MasterUsername": "myadmin", + "EngineVersion": "5.7.mysql_aurora.2.04.2", + "LicenseModel": "aurora-mysql", + "SnapshotType": "manual", + "PercentProgress": 100, + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", + "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:myclustersnapshotcopy", + "IAMDatabaseAuthenticationEnabled": false + } + } + } + ] + } + }, + "com.amazonaws.rds#CopyDBClusterSnapshotMessage": { + "type": "structure", + "members": { + "SourceDBClusterSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier of the DB cluster snapshot to copy. This parameter isn't case-sensitive.

\n

You can't copy an encrypted, shared DB cluster snapshot from one Amazon Web Services Region to another.

\n

Constraints:

\n
    \n
  • \n

    Must specify a valid system snapshot in the \"available\" state.

    \n
    • \n
  • \n

    If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB snapshot identifier.

    \n
    • \n
  • \n

    If the source snapshot is in a different Amazon Web Services Region than the copy,\n specify a valid DB cluster snapshot ARN. For more information, go to\n \n Copying Snapshots Across Amazon Web Services Regions in the Amazon Aurora User Guide.

    \n
    • \n
\n

Example: my-cluster-snapshot1\n

", + "smithy.api#required": {} + } + }, + "TargetDBClusterSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Example: my-cluster-snapshot2\n

", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB cluster snapshot. \n The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS key.

\n

If you copy an encrypted DB cluster snapshot from your Amazon Web Services account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS key. \n If you don't specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot.

\n

If you copy an encrypted DB cluster snapshot that is shared from another Amazon Web Services account, then you must specify a value for KmsKeyId.

\n

To copy an encrypted DB cluster snapshot to another Amazon Web Services Region, you must set KmsKeyId to the Amazon Web Services KMS key identifier \n you want to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services \n Region that they are created in, and you can't use KMS keys from one Amazon Web Services Region \n in another Amazon Web Services Region.

\n

If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, \n an error is returned.

" + } + }, + "PreSignedUrl": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

When you are copying a DB cluster snapshot from one Amazon Web Services GovCloud (US) Region\n to another, the URL that contains a Signature Version 4 signed request for the\n CopyDBClusterSnapshot API operation in the Amazon Web Services Region that contains\n the source DB cluster snapshot to copy. Use the PreSignedUrl parameter when\n copying an encrypted DB cluster snapshot from another Amazon Web Services Region. Don't specify\n PreSignedUrl when copying an encrypted DB cluster snapshot in the same\n Amazon Web Services Region.

\n

This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other\n Amazon Web Services Regions.

\n

The presigned URL must be a valid request for the\n CopyDBClusterSnapshot API operation that can run in the source\n Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request\n must contain the following parameter values:

\n
    \n
  • \n

    \n KmsKeyId - The KMS key identifier for the KMS key\n to use to encrypt the copy of the DB cluster snapshot in the destination\n Amazon Web Services Region. This is the same identifier for both the\n CopyDBClusterSnapshot operation that is called in the\n destination Amazon Web Services Region, and the operation contained in the presigned\n URL.

    \n
    • \n
  • \n

    \n DestinationRegion - The name of the Amazon Web Services Region \n that the DB cluster snapshot is to be created in.

    \n
    • \n
  • \n

    \n SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster \n snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, \n if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier\n looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.

    \n
    • \n
\n

To learn how to generate a Signature Version 4 signed request, see \n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can run in the source Amazon Web Services Region.

\n " + } + }, + "CopyTags": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot. \n By default, tags are not copied.

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#CopyDBClusterSnapshotResult": { + "type": "structure", + "members": { + "DBClusterSnapshot": { + "target": "com.amazonaws.rds#DBClusterSnapshot" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#CopyDBParameterGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CopyDBParameterGroupMessage" + }, + "output": { + "target": "com.amazonaws.rds#CopyDBParameterGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBParameterGroupAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBParameterGroupQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Copies the specified DB parameter group.

\n \n

You can't copy a default DB parameter group. Instead, create a new custom DB parameter group, which copies the default\n parameters and values for the specified DB parameter group family.

\n ", + "smithy.api#examples": [ + { + "title": "To copy a DB parameter group", + "documentation": "The following example makes a copy of a DB parameter group.", + "input": { + "SourceDBParameterGroupIdentifier": "mydbpg", + "TargetDBParameterGroupIdentifier": "mydbpgcopy", + "TargetDBParameterGroupDescription": "Copy of mydbpg parameter group" + }, + "output": { + "DBParameterGroup": { + "DBParameterGroupName": "mydbpgcopy", + "DBParameterGroupArn": "arn:aws:rds:us-east-1:814387698303:pg:mydbpgcopy", + "DBParameterGroupFamily": "mysql5.7", + "Description": "Copy of mydbpg parameter group" + } + } + } + ] + } + }, + "com.amazonaws.rds#CopyDBParameterGroupMessage": { + "type": "structure", + "members": { + "SourceDBParameterGroupIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier or ARN for the source DB parameter group.\n For information about \n creating an ARN, \n see \n Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.

\n

Constraints:

\n
    \n
  • \n

    Must specify a valid DB parameter group.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "TargetDBParameterGroupIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier for the copied DB parameter group.

\n

Constraints:

\n
    \n
  • \n

    Can't be null, empty, or blank

    \n
    • \n
  • \n

    Must contain from 1 to 255 letters, numbers, or hyphens

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
\n

Example: my-db-parameter-group\n

", + "smithy.api#required": {} + } + }, + "TargetDBParameterGroupDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A description for the copied DB parameter group.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#CopyDBParameterGroupResult": { + "type": "structure", + "members": { + "DBParameterGroup": { + "target": "com.amazonaws.rds#DBParameterGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#CopyDBSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CopyDBSnapshotMessage" + }, + "output": { + "target": "com.amazonaws.rds#CopyDBSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#CustomAvailabilityZoneNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSnapshotAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSnapshotStateFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + }, + { + "target": "com.amazonaws.rds#SnapshotQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Copies the specified DB snapshot. The source DB snapshot must be in the available state.

\n

You can copy a snapshot from one Amazon Web Services Region to another. In that case, the\n Amazon Web Services Region where you call the CopyDBSnapshot operation is the destination\n Amazon Web Services Region for the DB snapshot copy.

\n

This command doesn't apply to RDS Custom.

\n

For more information about copying snapshots, see \n Copying a DB Snapshot in the Amazon RDS User Guide.

", + "smithy.api#examples": [ + { + "title": "To copy a DB snapshot", + "documentation": "The following example creates a copy of a DB snapshot.", + "input": { + "SourceDBSnapshotIdentifier": "rds:database-mysql-2019-06-06-08-38", + "TargetDBSnapshotIdentifier": "mydbsnapshotcopy" + }, + "output": { + "DBSnapshot": { + "VpcId": "vpc-6594f31c", + "Status": "creating", + "Encrypted": true, + "SourceDBSnapshotIdentifier": "arn:aws:rds:us-east-1:123456789012:snapshot:rds:database-mysql-2019-06-06-08-38", + "MasterUsername": "admin", + "Iops": 1000, + "Port": 3306, + "LicenseModel": "general-public-license", + "DBSnapshotArn": "arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshotcopy", + "EngineVersion": "5.6.40", + "OptionGroupName": "default:mysql-5-6", + "ProcessorFeatures": [], + "Engine": "mysql", + "StorageType": "io1", + "DbiResourceId": "db-ZI7UJ5BLKMBYFGX7FDENCKADC4", + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", + "SnapshotType": "manual", + "IAMDatabaseAuthenticationEnabled": false, + "SourceRegion": "us-east-1", + "DBInstanceIdentifier": "database-mysql", + "InstanceCreateTime": "2019-04-30T15:45:53.663Z", + "AvailabilityZone": "us-east-1f", + "PercentProgress": 0, + "AllocatedStorage": 100, + "DBSnapshotIdentifier": "mydbsnapshotcopy" + } + } + } + ] + } + }, + "com.amazonaws.rds#CopyDBSnapshotMessage": { + "type": "structure", + "members": { + "SourceDBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier for the source DB snapshot.

\n

If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB\n snapshot identifier. For example, you might specify\n rds:mysql-instance1-snapshot-20130805.

\n

If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB\n snapshot ARN. For example, you might specify\n arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.

\n

If you are copying from a shared manual DB snapshot, \n this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.

\n

If you are copying an encrypted snapshot this parameter must be in the ARN format for the source Amazon Web Services Region.

\n

Constraints:

\n
    \n
  • \n

    Must specify a valid system snapshot in the \"available\" state.

    \n
    • \n
\n

Example: rds:mydb-2012-04-02-00-01\n

\n

Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805\n

", + "smithy.api#required": {} + } + }, + "TargetDBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier for the copy of the snapshot.

\n

Constraints:

\n
    \n
  • \n

    Can't be null, empty, or blank

    \n
    • \n
  • \n

    Must contain from 1 to 255 letters, numbers, or hyphens

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
\n

Example: my-db-snapshot\n

", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB snapshot. \n The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you copy an encrypted DB snapshot from your Amazon Web Services account, \n you can specify a value for this parameter to encrypt the copy with a new KMS key. \n If you don't specify a value for this parameter, \n then the copy of the DB snapshot is encrypted with the same Amazon Web Services KMS key as the source DB snapshot.

\n

If you copy an encrypted DB snapshot that is shared from another Amazon Web Services account, \n then you must specify a value for this parameter.

\n

If you specify this parameter when you copy an unencrypted snapshot, \n the copy is encrypted.

\n

If you copy an encrypted snapshot to a different Amazon Web Services Region, then you must specify\n an Amazon Web Services KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region\n that they are created in, and you can't use KMS keys from one Amazon Web Services Region in another\n Amazon Web Services Region.

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + }, + "CopyTags": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to copy all tags from the source DB snapshot to the target DB snapshot. \n By default, tags aren't copied.

" + } + }, + "PreSignedUrl": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

When you are copying a snapshot from one Amazon Web Services GovCloud (US) Region to another, \n the URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API \n operation in the source Amazon Web Services Region that contains the source DB snapshot to copy.

\n

This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other\n Amazon Web Services Regions.

\n

You must specify this parameter when you copy an encrypted DB snapshot from another\n Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are \n copying an encrypted DB snapshot in the same Amazon Web Services Region.

\n

The presigned URL must be a valid request for the\n CopyDBClusterSnapshot API operation that can run in the source\n Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request\n must contain the following parameter values:

\n
    \n
  • \n

    \n DestinationRegion - The Amazon Web Services Region that the encrypted DB\n snapshot is copied to. This Amazon Web Services Region is the same one where the\n CopyDBSnapshot operation is called that contains this presigned\n URL.

    \n

    For example, if you copy an encrypted DB snapshot from the us-west-2\n Amazon Web Services Region to the us-east-1 Amazon Web Services Region, then you call the\n CopyDBSnapshot operation in the us-east-1 Amazon Web Services Region and\n provide a presigned URL that contains a call to the CopyDBSnapshot\n operation in the us-west-2 Amazon Web Services Region. For this example, the\n DestinationRegion in the presigned URL must be set to the\n us-east-1 Amazon Web Services Region.

    \n
    • \n
  • \n

    \n KmsKeyId - The KMS key identifier for the KMS key to use to\n encrypt the copy of the DB snapshot in the destination Amazon Web Services Region. This is the\n same identifier for both the CopyDBSnapshot operation that is\n called in the destination Amazon Web Services Region, and the operation contained in the\n presigned URL.

    \n
    • \n
  • \n

    \n SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be copied. \n This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. \n For example, if you are copying an encrypted DB snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBSnapshotIdentifier looks like\n the following example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115.

    \n
    • \n
\n

To learn how to generate a Signature Version 4 signed request, see \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can run in the source Amazon Web Services Region.

\n " + } + }, + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of an option group to associate with the copy of the snapshot.

\n

Specify this option if you are copying a snapshot from one Amazon Web Services Region to another,\n and your DB instance uses a nondefault option group. \n If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, \n you must specify this option when copying across Amazon Web Services Regions. \n For more information, see \n Option group considerations in the Amazon RDS User Guide.

" + } + }, + "TargetCustomAvailabilityZone": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The external custom Availability Zone (CAZ) identifier for the target CAZ.

\n

Example: rds-caz-aiqhTgQv.

" + } + }, + "CopyOptionGroup": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to copy the DB option group associated with the source DB snapshot to the target \n Amazon Web Services account and associate with the target DB snapshot. The associated option group can be copied only with \n cross-account snapshot copy calls.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#CopyDBSnapshotResult": { + "type": "structure", + "members": { + "DBSnapshot": { + "target": "com.amazonaws.rds#DBSnapshot" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#CopyOptionGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CopyOptionGroupMessage" + }, + "output": { + "target": "com.amazonaws.rds#CopyOptionGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#OptionGroupAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#OptionGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#OptionGroupQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Copies the specified option group.

", + "smithy.api#examples": [ + { + "title": "To copy an option group", + "documentation": "The following example makes a copy of an option group.", + "input": { + "SourceOptionGroupIdentifier": "myoptiongroup", + "TargetOptionGroupIdentifier": "new-option-group", + "TargetOptionGroupDescription": "My option group copy" + }, + "output": { + "OptionGroup": { + "Options": [], + "OptionGroupName": "new-option-group", + "MajorEngineVersion": "11.2", + "OptionGroupDescription": "My option group copy", + "AllowsVpcAndNonVpcInstanceMemberships": true, + "EngineName": "oracle-ee", + "OptionGroupArn": "arn:aws:rds:us-east-1:123456789012:og:new-option-group" + } + } + } + ] + } + }, + "com.amazonaws.rds#CopyOptionGroupMessage": { + "type": "structure", + "members": { + "SourceOptionGroupIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier for the source option group.

\n

Constraints:

\n
    \n
  • \n

    Must specify a valid option group.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "TargetOptionGroupIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier for the copied option group.

\n

Constraints:

\n
    \n
  • \n

    Can't be null, empty, or blank

    \n
    • \n
  • \n

    Must contain from 1 to 255 letters, numbers, or hyphens

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
\n

Example: my-option-group\n

", + "smithy.api#required": {} + } + }, + "TargetOptionGroupDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The description for the copied option group.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#CopyOptionGroupResult": { + "type": "structure", + "members": { + "OptionGroup": { + "target": "com.amazonaws.rds#OptionGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#CreateBlueGreenDeployment": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateBlueGreenDeploymentRequest" + }, + "output": { + "target": "com.amazonaws.rds#CreateBlueGreenDeploymentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#BlueGreenDeploymentAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InstanceQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#SourceClusterNotSupportedFault" + }, + { + "target": "com.amazonaws.rds#SourceDatabaseNotSupportedFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a blue/green deployment.

\n

A blue/green deployment creates a staging environment that copies the production environment. \n In a blue/green deployment, the blue environment is the current production environment. \n The green environment is the staging environment, and it stays in sync \n with the current production environment.

\n

You can make changes to the databases in the green environment without affecting \n production workloads. For example, you can upgrade the major or minor DB engine version, change \n database parameters, or make schema changes in the staging environment. You can thoroughly test \n changes in the green environment. When ready, you can switch over the environments to promote the \n green environment to be the new production environment. The switchover typically takes under a minute.

\n

For more information, see Using Amazon RDS Blue/Green Deployments \n for database updates in the Amazon RDS User Guide and \n \n Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora \n User Guide.

" + } + }, + "com.amazonaws.rds#CreateBlueGreenDeploymentRequest": { + "type": "structure", + "members": { + "BlueGreenDeploymentName": { + "target": "com.amazonaws.rds#BlueGreenDeploymentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the blue/green deployment.

\n

Constraints:

\n
    \n
  • \n

    Can't be the same as an existing blue/green deployment name in the same account and Amazon Web Services Region.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Source": { + "target": "com.amazonaws.rds#DatabaseArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source production database.

\n

Specify the database that you want to clone. The blue/green deployment creates this database in \n the green environment. You can make updates to the database in the green environment, such as an engine \n version upgrade. When you are ready, you can switch the database in the green environment to be the \n production database.

", + "smithy.api#required": {} + } + }, + "TargetEngineVersion": { + "target": "com.amazonaws.rds#TargetEngineVersion", + "traits": { + "smithy.api#documentation": "

The engine version of the database in the green environment.

\n

Specify the engine version to upgrade to in the green environment.

" + } + }, + "TargetDBParameterGroupName": { + "target": "com.amazonaws.rds#TargetDBParameterGroupName", + "traits": { + "smithy.api#documentation": "

The DB parameter group associated with the DB instance in the green environment.

\n

To test parameter changes, specify a DB parameter group that is different from the one associated \n with the source DB instance.

" + } + }, + "TargetDBClusterParameterGroupName": { + "target": "com.amazonaws.rds#TargetDBClusterParameterGroupName", + "traits": { + "smithy.api#documentation": "

The DB cluster parameter group associated with the Aurora DB cluster in the green environment.

\n

To test parameter changes, specify a DB cluster parameter group that is different from the one associated \n with the source DB cluster.

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

Tags to assign to the blue/green deployment.

" + } + }, + "TargetDBInstanceClass": { + "target": "com.amazonaws.rds#TargetDBInstanceClass", + "traits": { + "smithy.api#documentation": "

Specify the DB instance class for the databases in the green environment.

\n

This parameter only applies to RDS DB instances, because DB instances within an Aurora DB cluster can\n have multiple different instance classes. If you're creating a blue/green deployment from an Aurora DB cluster,\n don't specify this parameter. After the green environment is created, you can individually modify the instance classes \n of the DB instances within the green DB cluster.

" + } + }, + "UpgradeTargetStorageConfig": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Whether to upgrade the storage file system configuration on the green database. This\n option migrates the green DB instance from the older 32-bit file system to the preferred\n configuration. For more information, see Upgrading the storage file system for a DB instance.

" + } + }, + "TargetIops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to allocate for the green DB instance.\n For information about valid IOPS values, see \n Amazon RDS DB instance storage \n in the Amazon RDS User Guide.

\n

This setting doesn't apply to Amazon Aurora blue/green deployments.

" + } + }, + "TargetStorageType": { + "target": "com.amazonaws.rds#TargetStorageType", + "traits": { + "smithy.api#documentation": "

The storage type to associate with the green DB instance.

\n

Valid Values: gp2 | gp3 | io1 | io2\n

\n

This setting doesn't apply to Amazon Aurora blue/green deployments.

" + } + }, + "TargetAllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of storage in gibibytes (GiB) to allocate for the green DB instance. You can choose to\n increase or decrease the allocated storage on the green DB instance.

\n

This setting doesn't apply to Amazon Aurora blue/green deployments.

" + } + }, + "TargetStorageThroughput": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The storage throughput value for the green DB instance.

\n

This setting applies only to the gp3 storage type.

\n

This setting doesn't apply to Amazon Aurora blue/green deployments.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#CreateBlueGreenDeploymentResponse": { + "type": "structure", + "members": { + "BlueGreenDeployment": { + "target": "com.amazonaws.rds#BlueGreenDeployment" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#CreateCustomDBEngineVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateCustomDBEngineVersionMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBEngineVersion" + }, + "errors": [ + { + "target": "com.amazonaws.rds#CreateCustomDBEngineVersionFault" + }, + { + "target": "com.amazonaws.rds#CustomDBEngineVersionAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#CustomDBEngineVersionQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#Ec2ImagePropertiesNotSupportedFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a custom DB engine version (CEV).

" + } + }, + "com.amazonaws.rds#CreateCustomDBEngineVersionFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "CreateCustomDBEngineVersionFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

An error occurred while trying to create the CEV.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#CreateCustomDBEngineVersionMessage": { + "type": "structure", + "members": { + "Engine": { + "target": "com.amazonaws.rds#CustomEngineName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The database engine. RDS Custom for Oracle supports the following values:

\n
    \n
  • \n

    \n custom-oracle-ee\n

    \n
    • \n
  • \n

    \n custom-oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n custom-oracle-se2\n

    \n
    • \n
  • \n

    \n custom-oracle-se2-cdb\n

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#CustomEngineVersion", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of your CEV. The name format is 19.customized_string.\n For example, a valid CEV name is 19.my_cev1. This setting is required for RDS\n Custom for Oracle, but optional for Amazon RDS. The combination of Engine\n and EngineVersion is unique per customer per Region.

", + "smithy.api#required": {} + } + }, + "DatabaseInstallationFilesS3BucketName": { + "target": "com.amazonaws.rds#BucketName", + "traits": { + "smithy.api#documentation": "

The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid \n bucket name is my-custom-installation-files.

" + } + }, + "DatabaseInstallationFilesS3Prefix": { + "target": "com.amazonaws.rds#String255", + "traits": { + "smithy.api#documentation": "

The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid \n bucket name is 123456789012/cev1. If this setting isn't specified, no prefix is assumed.

" + } + }, + "ImageId": { + "target": "com.amazonaws.rds#String255", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Machine Image (AMI). For RDS Custom for SQL Server, an AMI ID is required \n to create a CEV. For RDS Custom for Oracle, the default is the most recent AMI available, \n but you can specify an AMI ID that was used in a different Oracle CEV. Find the AMIs \n used by your CEVs by calling the DescribeDBEngineVersions operation.

" + } + }, + "KMSKeyId": { + "target": "com.amazonaws.rds#KmsKeyIdOrArn", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for \n RDS Custom, but optional for Amazon RDS.

\n

If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. \n No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, \n follow the instructions in \n Creating a symmetric encryption KMS key in the Amazon Web Services Key Management Service\n Developer Guide.

\n

You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys.

" + } + }, + "Description": { + "target": "com.amazonaws.rds#Description", + "traits": { + "smithy.api#documentation": "

An optional description of your CEV.

" + } + }, + "Manifest": { + "target": "com.amazonaws.rds#CustomDBEngineVersionManifest", + "traits": { + "smithy.api#documentation": "

The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. \n Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which \n they are listed.

\n

The following JSON fields are valid:

\n
\n
MediaImportTemplateVersion
\n
\n

Version of the CEV manifest. The date is in the format YYYY-MM-DD.

\n
\n
databaseInstallationFileNames
\n
\n

Ordered list of installation files for the CEV.

\n
\n
opatchFileNames
\n
\n

Ordered list of OPatch installers used for the Oracle DB engine.

\n
\n
psuRuPatchFileNames
\n
\n

The PSU and RU patches for this CEV.

\n
\n
OtherPatchFileNames
\n
\n

The patches that are not in the list of PSU and RU patches. \n Amazon RDS applies these patches after applying the PSU and RU patches.

\n
\n
\n

For more information, see \n Creating the CEV manifest in the Amazon RDS User Guide.

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + }, + "SourceCustomDbEngineVersionIdentifier": { + "target": "com.amazonaws.rds#String255", + "traits": { + "smithy.api#documentation": "

The ARN of a CEV to use as a source for creating a new CEV. You can specify a different\n Amazon Machine Imagine (AMI) by using either Source or\n UseAwsProvidedLatestImage. You can't specify a different JSON manifest\n when you specify SourceCustomDbEngineVersionIdentifier.

" + } + }, + "UseAwsProvidedLatestImage": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for\n the CEV. If you specify UseAwsProvidedLatestImage, you can't also specify\n ImageId.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#CreateDBCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateDBClusterMessage" + }, + "output": { + "target": "com.amazonaws.rds#CreateDBClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DomainNotFoundFault" + }, + { + "target": "com.amazonaws.rds#GlobalClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InsufficientDBInstanceCapacityFault" + }, + { + "target": "com.amazonaws.rds#InsufficientStorageClusterCapacityFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSubnetGroupFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSubnetGroupStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidGlobalClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidSubnet" + }, + { + "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + }, + { + "target": "com.amazonaws.rds#OptionGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#StorageQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.

\n

If you create an Aurora DB cluster, the request creates an empty cluster. You must\n explicitly create the writer instance for your DB cluster using the CreateDBInstance operation. If you create a Multi-AZ DB cluster, the\n request creates a writer and two reader DB instances for you, each in a different\n Availability Zone.

\n

You can use the ReplicationSourceIdentifier parameter to create an Amazon\n Aurora DB cluster as a read replica of another DB cluster or Amazon RDS for MySQL or\n PostgreSQL DB instance. For more information about Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User\n Guide.

\n

You can also use the ReplicationSourceIdentifier parameter to create a\n Multi-AZ DB cluster read replica with an RDS for MySQL or PostgreSQL DB instance as the\n source. For more information about Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

", + "smithy.api#examples": [ + { + "title": "To create a MySQL 5.7-compatible DB cluster", + "documentation": "The following example creates a MySQL 5.7-compatible Aurora DB cluster.", + "input": { + "DBClusterIdentifier": "sample-cluster", + "Engine": "aurora-mysql", + "EngineVersion": "5.7.12", + "MasterUsername": "admin", + "MasterUserPassword": "mypassword", + "DBSubnetGroupName": "default", + "VpcSecurityGroupIds": [ + "sg-0b91305example" + ] + }, + "output": { + "DBCluster": { + "DBSubnetGroup": "default", + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-0b91305example", + "Status": "active" + } + ], + "AllocatedStorage": 1, + "AssociatedRoles": [], + "PreferredBackupWindow": "09:12-09:42", + "ClusterCreateTime": "2019-06-07T23:21:33.048Z", + "DeletionProtection": false, + "IAMDatabaseAuthenticationEnabled": false, + "ReadReplicaIdentifiers": [], + "EngineMode": "provisioned", + "Engine": "aurora-mysql", + "StorageEncrypted": false, + "MultiAZ": false, + "PreferredMaintenanceWindow": "mon:04:31-mon:05:01", + "HttpEndpointEnabled": false, + "BackupRetentionPeriod": 1, + "DbClusterResourceId": "cluster-ANPAJ4AE5446DAEXAMPLE", + "DBClusterIdentifier": "sample-cluster", + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1e" + ], + "MasterUsername": "master", + "EngineVersion": "5.7.12", + "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster", + "DBClusterMembers": [], + "Port": 3306, + "Status": "creating", + "Endpoint": "sample-cluster.cluster-cnpexample.us-east-1.rds.amazonaws.com", + "DBClusterParameterGroup": "default.aurora-mysql5.7", + "HostedZoneId": "Z2R2ITUGPM61AM", + "ReaderEndpoint": "sample-cluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com", + "CopyTagsToSnapshot": false + } + } + }, + { + "title": "To create a PostgreSQL-compatible DB cluster", + "documentation": "The following example creates a PostgreSQL-compatible Aurora DB cluster.", + "input": { + "DBClusterIdentifier": "sample-pg-cluster", + "Engine": "aurora-postgresql", + "MasterUsername": "admin", + "MasterUserPassword": "mypassword", + "VpcSecurityGroupIds": [ + "sg-0b91305example" + ], + "DBSubnetGroupName": "default" + }, + "output": { + "DBCluster": { + "Endpoint": "sample-pg-cluster.cluster-cnpexample.us-east-1.rds.amazonaws.com", + "HttpEndpointEnabled": false, + "DBClusterMembers": [], + "EngineMode": "provisioned", + "CopyTagsToSnapshot": false, + "HostedZoneId": "Z2R2ITUGPM61AM", + "IAMDatabaseAuthenticationEnabled": false, + "AllocatedStorage": 1, + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-0b91305example", + "Status": "active" + } + ], + "DeletionProtection": false, + "StorageEncrypted": false, + "BackupRetentionPeriod": 1, + "PreferredBackupWindow": "09:56-10:26", + "ClusterCreateTime": "2019-06-07T23:26:08.371Z", + "DBClusterParameterGroup": "default.aurora-postgresql9.6", + "EngineVersion": "9.6.9", + "Engine": "aurora-postgresql", + "Status": "creating", + "DBClusterIdentifier": "sample-pg-cluster", + "MultiAZ": false, + "Port": 5432, + "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:sample-pg-cluster", + "AssociatedRoles": [], + "DbClusterResourceId": "cluster-ANPAJ4AE5446DAEXAMPLE", + "PreferredMaintenanceWindow": "wed:03:33-wed:04:03", + "ReaderEndpoint": "sample-pg-cluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com", + "MasterUsername": "master", + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1c" + ], + "ReadReplicaIdentifiers": [], + "DBSubnetGroup": "default" + } + } + } + ] + } + }, + "com.amazonaws.rds#CreateDBClusterEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateDBClusterEndpointMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBClusterEndpoint" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterEndpointAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBClusterEndpointQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.

\n \n

This action applies only to Aurora DB clusters.

\n ", + "smithy.api#examples": [ + { + "title": "To create a custom DB cluster endpoint", + "documentation": "The following example creates a custom DB cluster endpoint and associate it with the specified Aurora DB cluster.", + "input": { + "DBClusterIdentifier": "mydbcluster", + "DBClusterEndpointIdentifier": "mycustomendpoint", + "EndpointType": "reader", + "StaticMembers": [ + "dbinstance1", + "dbinstance2" + ] + }, + "output": { + "DBClusterEndpointIdentifier": "mycustomendpoint", + "DBClusterIdentifier": "mydbcluster", + "DBClusterEndpointResourceIdentifier": "cluster-endpoint-ANPAJ4AE5446DAEXAMPLE", + "Endpoint": "mycustomendpoint.cluster-custom-cnpexample.us-east-1.rds.amazonaws.com", + "Status": "creating", + "EndpointType": "CUSTOM", + "CustomEndpointType": "READER", + "StaticMembers": [ + "dbinstance1", + "dbinstance2" + ], + "ExcludedMembers": [], + "DBClusterEndpointArn": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:mycustomendpoint" + } + } + ] + } + }, + "com.amazonaws.rds#CreateDBClusterEndpointMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is\n stored as a lowercase string.

", + "smithy.api#required": {} + } + }, + "DBClusterEndpointIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier to use for the new endpoint. This parameter is stored as a lowercase string.

", + "smithy.api#required": {} + } + }, + "EndpointType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of the endpoint, one of: READER, WRITER, ANY.

", + "smithy.api#required": {} + } + }, + "StaticMembers": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

List of DB instance identifiers that are part of the custom endpoint group.

" + } + }, + "ExcludedMembers": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

List of DB instance identifiers that aren't part of the custom endpoint group.\n All other eligible instances are reachable through the custom endpoint.\n This parameter is relevant only if the list of static members is empty.

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

The tags to be assigned to the Amazon RDS resource.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#CreateDBClusterMessage": { + "type": "structure", + "members": { + "AvailabilityZones": { + "target": "com.amazonaws.rds#AvailabilityZones", + "traits": { + "smithy.api#documentation": "

A list of Availability Zones (AZs) where you specifically want to create DB instances in the DB cluster.

\n

For information on AZs, see \n Availability Zones\n in the Amazon Aurora User Guide.

\n

Valid for Cluster Type: Aurora DB clusters only

\n

Constraints:

\n
    \n
  • \n

    Can't specify more than three AZs.

    \n
    • \n
" + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days for which automated backups are retained.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Default: 1\n

\n

Constraints:

\n
    \n
  • \n

    Must be a value from 1 to 35.

    \n
    • \n
" + } + }, + "CharacterSetName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the character set (CharacterSet) to associate the DB cluster with.

\n

Valid for Cluster Type: Aurora DB clusters only

" + } + }, + "DatabaseName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name for your database of up to 64 alphanumeric characters. \n A database named postgres is always created. If this parameter is specified, an additional database with this name is created.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier for this DB cluster. This parameter is stored as a lowercase string.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 (for Aurora DB clusters) or 1 to 52 (for Multi-AZ DB\n clusters) letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Example: my-cluster1\n

", + "smithy.api#required": {} + } + }, + "DBClusterParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB cluster parameter group to associate\n with this DB cluster. If you don't specify a value, then \n the default DB cluster parameter group for the specified DB engine and version is used.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DB cluster parameter group.

    \n
    • \n
" + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of EC2 VPC security groups to associate with this DB cluster.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A DB subnet group to associate with this DB cluster.

\n

This setting is required to create a Multi-AZ DB cluster.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Constraints:

\n
    \n
  • \n

    Must match the name of an existing DB subnet group.

    \n
    • \n
\n

Example: mydbsubnetgroup\n

" + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The database engine to use for this DB cluster.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Valid Values:

\n
    \n
  • \n

    \n aurora-mysql\n

    \n
    • \n
  • \n

    \n aurora-postgresql\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
  • \n

    \n neptune - For information about using Amazon Neptune, see the\n \n Amazon Neptune User Guide\n .

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version number of the database engine to use.

\n

To list all of the available engine versions for Aurora MySQL version 2 (5.7-compatible) and version 3 (MySQL 8.0-compatible),\n use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

You can supply either 5.7 or 8.0 to use the default engine version for Aurora MySQL version 2 or\n version 3, respectively.

\n

To list all of the available engine versions for Aurora PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for MySQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"\n

\n

For information about a specific engine, see the following topics:

\n \n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port number on which the instances in the DB cluster accept connections.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Valid Values: 1150-65535\n

\n

Default:

\n
    \n
  • \n

    RDS for MySQL and Aurora MySQL - 3306\n

    \n
    • \n
  • \n

    RDS for PostgreSQL and Aurora PostgreSQL - 5432\n

    \n
    • \n
" + } + }, + "MasterUsername": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the master user for the DB cluster.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Constraints:

\n
    \n
  • \n

    Must be 1 to 16 letters or numbers.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't be a reserved word for the chosen database engine.

    \n
    • \n
" + } + }, + "MasterUserPassword": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The password for the master database user.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Constraints:

\n
    \n
  • \n

    Must contain from 8 to 41 characters.

    \n
    • \n
  • \n

    Can contain any printable ASCII character except \"/\", \"\"\", or \"@\".

    \n
    • \n
  • \n

    Can't be specified if ManageMasterUserPassword is turned on.

    \n
    • \n
" + } + }, + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The option group to associate the DB cluster with.

\n

DB clusters are associated with a default option group that can't be modified.

" + } + }, + "PreferredBackupWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled\n using the BackupRetentionPeriod parameter.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To view the time blocks available, see \n \n Backup window in the Amazon Aurora User Guide.

\n

Constraints:

\n
    \n
  • \n

    Must be in the format hh24:mi-hh24:mi.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must not conflict with the preferred maintenance window.

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \n
" + } + }, + "PreferredMaintenanceWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The weekly time range during which system maintenance can occur.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

\n

Constraints:

\n
    \n
  • \n

    Must be in the format ddd:hh24:mi-ddd:hh24:mi.

    \n
    • \n
  • \n

    Days must be one of Mon | Tue | Wed | Thu | Fri | Sat | Sun.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \n
" + } + }, + "ReplicationSourceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB\n cluster is created as a read replica.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

Tags to assign to the DB cluster.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "StorageEncrypted": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the DB cluster is encrypted.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB cluster.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

When a KMS key isn't specified in KmsKeyId:

\n
    \n
  • \n

    If ReplicationSourceIdentifier identifies an encrypted\n source, then Amazon RDS uses the KMS key used to encrypt the\n source. Otherwise, Amazon RDS uses your default KMS key.

    \n
    • \n
  • \n

    If the StorageEncrypted parameter is enabled and\n ReplicationSourceIdentifier isn't specified, then Amazon RDS\n uses your default KMS key.

    \n
    • \n
\n

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.

\n

If you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, make\n sure to set KmsKeyId to a KMS key identifier that is valid in the destination Amazon Web Services\n Region. This KMS key is used to encrypt the read replica in that Amazon Web Services Region.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "PreSignedUrl": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

When you are replicating a DB cluster from one Amazon Web Services GovCloud (US) Region to another,\n an URL that contains a Signature Version 4 signed request for the\n CreateDBCluster operation to be called in the source Amazon Web Services Region where\n the DB cluster is replicated from. Specify PreSignedUrl only when you are\n performing cross-Region replication from an encrypted DB cluster.

\n

The presigned URL must be a valid request for the CreateDBCluster API\n operation that can run in the source Amazon Web Services Region that contains the encrypted DB\n cluster to copy.

\n

The presigned URL request must contain the following parameter values:

\n
    \n
  • \n

    \n KmsKeyId - The KMS key identifier for the KMS key to use to\n encrypt the copy of the DB cluster in the destination Amazon Web Services Region. This should\n refer to the same KMS key for both the CreateDBCluster operation\n that is called in the destination Amazon Web Services Region, and the operation contained in\n the presigned URL.

    \n
    • \n
  • \n

    \n DestinationRegion - The name of the Amazon Web Services Region that Aurora read replica will\n be created in.

    \n
    • \n
  • \n

    \n ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. \n This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an \n encrypted DB cluster from the us-west-2 Amazon Web Services Region, then your ReplicationSourceIdentifier would look like\n Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.

    \n
    • \n
\n

To learn how to generate a Signature Version 4 signed request, see \n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can run in the source Amazon Web Services Region.

\n \n

Valid for Cluster Type: Aurora DB clusters only

" + } + }, + "EnableIAMDatabaseAuthentication": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see IAM Database\n Authentication in the Amazon Aurora User Guide or\n IAM database\n authentication for MariaDB, MySQL, and PostgreSQL in the Amazon\n RDS User Guide.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "BacktrackWindow": { + "target": "com.amazonaws.rds#LongOptional", + "traits": { + "smithy.api#documentation": "

The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.

\n

Valid for Cluster Type: Aurora MySQL DB clusters only

\n

Default: 0\n

\n

Constraints:

\n
    \n
  • \n

    If specified, this value must be set to a number from 0 to 259,200 (72 hours).

    \n
    • \n
" + } + }, + "EnableCloudwatchLogsExports": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

The list of log types that need to be enabled for exporting to CloudWatch Logs.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

The following values are valid for each DB engine:

\n
    \n
  • \n

    Aurora MySQL - audit | error | general | slowquery\n

    \n
    • \n
  • \n

    Aurora PostgreSQL - postgresql\n

    \n
    • \n
  • \n

    RDS for MySQL - error | general | slowquery\n

    \n
    • \n
  • \n

    RDS for PostgreSQL - postgresql | upgrade\n

    \n
    • \n
\n

For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

" + } + }, + "EngineMode": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB engine mode of the DB cluster, either provisioned or serverless.

\n

The serverless engine mode only applies for Aurora Serverless v1 DB clusters. Aurora Serverless v2 DB clusters use the \n provisioned engine mode.

\n

For information about limitations and requirements for Serverless DB clusters, see the \n following sections in the Amazon Aurora User Guide:

\n \n

Valid for Cluster Type: Aurora DB clusters only

" + } + }, + "ScalingConfiguration": { + "target": "com.amazonaws.rds#ScalingConfiguration", + "traits": { + "smithy.api#documentation": "

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

\n

Valid for Cluster Type: Aurora DB clusters only

" + } + }, + "RdsCustomClusterConfiguration": { + "target": "com.amazonaws.rds#RdsCustomClusterConfiguration", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "GlobalClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The global cluster ID of an Aurora cluster that becomes the primary cluster\n in the new global database cluster.

\n

Valid for Cluster Type: Aurora DB clusters only

" + } + }, + "EnableHttpEndpoint": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable the HTTP endpoint for the DB cluster. By default, the HTTP endpoint \n isn't enabled.

\n

When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running\n SQL queries on the DB cluster. You can also query your database\n from inside the RDS console with the RDS query editor.

\n

For more information, see Using RDS Data API in the \n Amazon Aurora User Guide.

\n

Valid for Cluster Type: Aurora DB clusters only

" + } + }, + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster. \n The default is not to copy them.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "Domain": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Active Directory directory ID to create the DB cluster in.

\n

For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster.

\n

For more information, see Kerberos authentication\n in the Amazon Aurora User Guide.

\n

Valid for Cluster Type: Aurora DB clusters only

" + } + }, + "DomainIAMRoleName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the IAM role to use when making API calls to the Directory Service.

\n

Valid for Cluster Type: Aurora DB clusters only

" + } + }, + "EnableGlobalWriteForwarding": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster\n (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that\n are secondary clusters in an Aurora global database.

\n

You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter\n enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to\n this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the\n primary is demoted by a global cluster API operation, but it does nothing until then.

\n

Valid for Cluster Type: Aurora DB clusters only

" + } + }, + "DBClusterInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.

\n

For the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide.

\n

This setting is required to create a Multi-AZ DB cluster.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

" + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

\n

This setting is required to create a Multi-AZ DB cluster.

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The storage type to associate with the DB cluster.

\n

For information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters. For information on storage types for Multi-AZ DB\n clusters, see Settings for creating Multi-AZ DB clusters.

\n

This setting is required to create a Multi-AZ DB cluster.

\n

When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Valid Values:

\n
    \n
  • \n

    Aurora DB clusters - aurora | aurora-iopt1\n

    \n
    • \n
  • \n

    Multi-AZ DB clusters - io1 | io2 | gp3\n

    \n
    • \n
\n

Default:

\n
    \n
  • \n

    Aurora DB clusters - aurora\n

    \n
    • \n
  • \n

    Multi-AZ DB clusters - io1\n

    \n
    • \n
\n \n

When you create an Aurora DB cluster with the storage type set to aurora-iopt1, the storage type is returned\n in the response. The storage type isn't returned when you set it to aurora.

\n " + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated \n for each DB instance in the Multi-AZ DB cluster.

\n

For information about valid IOPS values, see Provisioned IOPS storage in the Amazon RDS\n User Guide.

\n

This setting is required to create a Multi-AZ DB cluster.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

\n

Constraints:

\n
    \n
  • \n

    Must be a multiple between .5 and 50 of the storage amount for the DB cluster.

    \n
    • \n
" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the DB cluster is publicly accessible.

\n

When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), \n its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, \n the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit it.

\n

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

\n

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

\n

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

\n
    \n
  • \n

    If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.

    \n
    • \n
  • \n

    If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.

    \n
    • \n
\n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n
    \n
  • \n

    If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.

    \n
    • \n
  • \n

    If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.

    \n
    • \n
" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. \n By default, minor engine upgrades are applied automatically.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB cluster

" + } + }, + "MonitoringInterval": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off \n collecting Enhanced Monitoring metrics, specify 0.

\n

If MonitoringRoleArn is specified, also set MonitoringInterval\n to a value other than 0.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60\n

\n

Default: 0\n

" + } + }, + "MonitoringRoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. \n An example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see Setting \n up and enabling Enhanced Monitoring in the Amazon RDS User Guide.

\n

If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "DatabaseInsightsMode": { + "target": "com.amazonaws.rds#DatabaseInsightsMode", + "traits": { + "smithy.api#documentation": "

The mode of Database Insights to enable for the DB cluster.

\n

If you set this value to advanced, you must also set the PerformanceInsightsEnabled\n parameter to true and the PerformanceInsightsRetentionPeriod parameter to 465.

\n

Valid for Cluster Type: Aurora DB clusters only

" + } + }, + "EnablePerformanceInsights": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to turn on Performance Insights for the DB cluster.

\n

For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "PerformanceInsightsKMSKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "PerformanceInsightsRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days to retain Performance Insights data.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Valid Values:

\n
    \n
  • \n

    \n 7\n

    \n
    • \n
  • \n

    \n month * 31, where month is a number of months from 1-23. \n Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)

    \n
    • \n
  • \n

    \n 731\n

    \n
    • \n
\n

Default: 7 days

\n

If you specify a retention period that isn't valid, such as 94, Amazon RDS issues an error.

" + } + }, + "EnableLimitlessDatabase": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group.

\n

Valid for: Aurora DB clusters only

\n \n

This setting is no longer used. Instead use the ClusterScalabilityType setting.

\n " + } + }, + "ServerlessV2ScalingConfiguration": { + "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" + }, + "NetworkType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The network type of the DB cluster.

\n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid for Cluster Type: Aurora DB clusters only

\n

Valid Values: IPV4 | DUAL\n

" + } + }, + "ClusterScalabilityType": { + "target": "com.amazonaws.rds#ClusterScalabilityType", + "traits": { + "smithy.api#documentation": "

Specifies the scalability mode of the Aurora DB cluster. When set to limitless, the cluster operates as an Aurora Limitless Database.\n When set to standard (the default), the cluster uses normal DB instance creation.

\n

Valid for: Aurora DB clusters only

\n \n

You can't modify this setting after you create the DB cluster.

\n " + } + }, + "DBSystemId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

" + } + }, + "ManageMasterUserPassword": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Constraints:

\n
    \n
  • \n

    Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword \n is specified.

    \n
    • \n
" + } + }, + "MasterUserSecretKmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and \n managed in Amazon Web Services Secrets Manager.

\n

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB cluster.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager \n KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't \n use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer \n managed KMS key.

\n

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "EnableLocalWriteForwarding": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By\n default, write operations aren't allowed on reader DB instances.

\n

Valid for: Aurora DB clusters only

" + } + }, + "CACertificateIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The CA certificate identifier to use for the DB cluster's server certificate.

\n

For more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide.

\n

Valid for Cluster Type: Multi-AZ DB clusters

" + } + }, + "EngineLifecycleSupport": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The life cycle type for this DB cluster.

\n \n

By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. \n At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, \n creating the DB cluster will fail if the DB major version is past its end of standard support date.

\n \n

You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, \n you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:

\n \n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled\n

\n

Default: open-source-rds-extended-support\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#CreateDBClusterParameterGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateDBClusterParameterGroupMessage" + }, + "output": { + "target": "com.amazonaws.rds#CreateDBClusterParameterGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBParameterGroupAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBParameterGroupQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new DB cluster parameter group.

\n

Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.

\n

A DB cluster parameter group is initially created with the default parameters for the\n database engine used by instances in the DB cluster. To provide custom values for any of the\n parameters, you must modify the group after creating it using\n ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to\n associate it with your DB cluster using ModifyDBCluster.

\n

When you associate a new DB cluster parameter group with a running Aurora DB cluster, reboot the DB\n instances in the DB cluster without failover for the new DB cluster parameter group and \n associated settings to take effect.

\n

When you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB\n cluster without failover for the new DB cluster parameter group and associated settings to take effect.

\n \n

After you create a DB cluster parameter group, you should wait at least 5 minutes\n before creating your first DB cluster that uses that DB cluster parameter group as\n the default parameter group. This allows Amazon RDS to fully complete the create\n action before the DB cluster parameter group is used as the default for a new DB\n cluster. This is especially important for parameters that are critical when creating\n the default database for a DB cluster, such as the character set for the default\n database defined by the character_set_database parameter. You can use\n the Parameter Groups option of the Amazon RDS console or the\n DescribeDBClusterParameters operation to verify that your DB\n cluster parameter group has been created or modified.

\n \n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

", + "smithy.api#examples": [ + { + "title": "To create a DB cluster parameter group", + "documentation": "The following example creates a DB cluster parameter group.", + "input": { + "DBClusterParameterGroupName": "mydbclusterparametergroup", + "DBParameterGroupFamily": "aurora5.6", + "Description": "My new cluster parameter group" + }, + "output": { + "DBClusterParameterGroup": { + "DBClusterParameterGroupName": "mydbclusterparametergroup", + "DBParameterGroupFamily": "aurora5.6", + "Description": "My new cluster parameter group", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterparametergroup" + } + } + } + ] + } + }, + "com.amazonaws.rds#CreateDBClusterParameterGroupMessage": { + "type": "structure", + "members": { + "DBClusterParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the DB cluster parameter group.

\n

Constraints:

\n
    \n
  • \n

    Must not match the name of an existing DB cluster parameter group.

    \n
    • \n
\n \n

This value is stored as a lowercase string.

\n ", + "smithy.api#required": {} + } + }, + "DBParameterGroupFamily": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster \n parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.

\n

\n Aurora MySQL\n

\n

Example: aurora-mysql5.7, aurora-mysql8.0\n

\n

\n Aurora PostgreSQL\n

\n

Example: aurora-postgresql14\n

\n

\n RDS for MySQL\n

\n

Example: mysql8.0\n

\n

\n RDS for PostgreSQL\n

\n

Example: postgres13\n

\n

To list all of the available parameter group families for a DB engine, use the following command:

\n

\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine \n

\n

For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command:

\n

\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine aurora-postgresql\n

\n \n

The output contains duplicates.

\n \n

The following are the valid DB engine values:

\n
    \n
  • \n

    \n aurora-mysql\n

    \n
    • \n
  • \n

    \n aurora-postgresql\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The description for the DB cluster parameter group.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

Tags to assign to the DB cluster parameter group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#CreateDBClusterParameterGroupResult": { + "type": "structure", + "members": { + "DBClusterParameterGroup": { + "target": "com.amazonaws.rds#DBClusterParameterGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#CreateDBClusterResult": { + "type": "structure", + "members": { + "DBCluster": { + "target": "com.amazonaws.rds#DBCluster" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#CreateDBClusterSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateDBClusterSnapshotMessage" + }, + "output": { + "target": "com.amazonaws.rds#CreateDBClusterSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterSnapshotAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterSnapshotStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#SnapshotQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a snapshot of a DB cluster.

\n

For more information on Amazon Aurora, see What is Amazon\n Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

", + "smithy.api#examples": [ + { + "title": "To create a DB cluster snapshot", + "documentation": "The following example creates a DB cluster snapshot.", + "input": { + "DBClusterSnapshotIdentifier": "mydbcluster", + "DBClusterIdentifier": "mydbclustersnapshot" + }, + "output": { + "DBClusterSnapshot": { + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1e" + ], + "DBClusterSnapshotIdentifier": "mydbclustersnapshot", + "DBClusterIdentifier": "mydbcluster", + "SnapshotCreateTime": "2019-06-18T21:21:00.469Z", + "Engine": "aurora-mysql", + "AllocatedStorage": 1, + "Status": "creating", + "Port": 0, + "VpcId": "vpc-6594f31c", + "ClusterCreateTime": "2019-04-15T14:18:42.785Z", + "MasterUsername": "myadmin", + "EngineVersion": "5.7.mysql_aurora.2.04.2", + "LicenseModel": "aurora-mysql", + "SnapshotType": "manual", + "PercentProgress": 0, + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", + "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:mydbclustersnapshot", + "IAMDatabaseAuthenticationEnabled": false + } + } + } + ] + } + }, + "com.amazonaws.rds#CreateDBClusterSnapshotMessage": { + "type": "structure", + "members": { + "DBClusterSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Example: my-cluster1-snapshot1\n

", + "smithy.api#required": {} + } + }, + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier of the DB cluster to create a snapshot for. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DBCluster.

    \n
    • \n
\n

Example: my-cluster1\n

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

The tags to be assigned to the DB cluster snapshot.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#CreateDBClusterSnapshotResult": { + "type": "structure", + "members": { + "DBClusterSnapshot": { + "target": "com.amazonaws.rds#DBClusterSnapshot" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#CreateDBInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateDBInstanceMessage" + }, + "output": { + "target": "com.amazonaws.rds#CreateDBInstanceResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#AuthorizationNotFoundFault" + }, + { + "target": "com.amazonaws.rds#BackupPolicyNotFoundFault" + }, + { + "target": "com.amazonaws.rds#CertificateNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DomainNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InstanceQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#InsufficientDBInstanceCapacityFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidSubnet" + }, + { + "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + }, + { + "target": "com.amazonaws.rds#NetworkTypeNotSupported" + }, + { + "target": "com.amazonaws.rds#OptionGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#ProvisionedIopsNotAvailableInAZFault" + }, + { + "target": "com.amazonaws.rds#StorageQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#StorageTypeNotSupportedFault" + }, + { + "target": "com.amazonaws.rds#TenantDatabaseQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new DB instance.

\n

The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster. \n For an Aurora DB cluster, you can call this operation multiple times to add more than one DB instance \n to the cluster.

\n

For more information about creating an RDS DB instance, see \n Creating an Amazon RDS DB instance in the Amazon RDS User Guide.

\n

For more information about creating a DB instance in an Aurora DB cluster, see \n \n Creating an Amazon Aurora DB cluster in the Amazon Aurora User Guide.

", + "smithy.api#examples": [ + { + "title": "To create a DB instance", + "documentation": "The following example uses the required options to launch a new DB instance.", + "input": { + "DBInstanceIdentifier": "test-mysql-instance", + "AllocatedStorage": 20, + "DBInstanceClass": "db.t3.micro", + "Engine": "mysql", + "MasterUsername": "admin", + "MasterUserPassword": "secret99" + }, + "output": { + "DBInstance": { + "DBInstanceIdentifier": "test-mysql-instance", + "DBInstanceClass": "db.t3.micro", + "Engine": "mysql", + "DBInstanceStatus": "creating", + "MasterUsername": "admin", + "AllocatedStorage": 20, + "PreferredBackupWindow": "12:55-13:25", + "BackupRetentionPeriod": 1, + "DBSecurityGroups": [], + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-12345abc", + "Status": "active" + } + ], + "DBParameterGroups": [ + { + "DBParameterGroupName": "default.mysql5.7", + "ParameterApplyStatus": "in-sync" + } + ], + "DBSubnetGroup": { + "DBSubnetGroupName": "default", + "DBSubnetGroupDescription": "default", + "VpcId": "vpc-2ff2ff2f", + "SubnetGroupStatus": "Complete", + "Subnets": [ + { + "SubnetIdentifier": "subnet-########", + "SubnetAvailabilityZone": { + "Name": "us-west-2c" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-########", + "SubnetAvailabilityZone": { + "Name": "us-west-2d" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-########", + "SubnetAvailabilityZone": { + "Name": "us-west-2a" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-########", + "SubnetAvailabilityZone": { + "Name": "us-west-2b" + }, + "SubnetStatus": "Active" + } + ] + }, + "PreferredMaintenanceWindow": "sun:08:07-sun:08:37", + "PendingModifiedValues": { + "MasterUserPassword": "****" + }, + "MultiAZ": false, + "EngineVersion": "5.7.22", + "AutoMinorVersionUpgrade": true, + "ReadReplicaDBInstanceIdentifiers": [], + "LicenseModel": "general-public-license", + "OptionGroupMemberships": [ + { + "OptionGroupName": "default:mysql-5-7", + "Status": "in-sync" + } + ], + "PubliclyAccessible": true, + "StorageType": "gp2", + "DbInstancePort": 0, + "StorageEncrypted": false, + "DbiResourceId": "db-5555EXAMPLE44444444EXAMPLE", + "CACertificateIdentifier": "rds-ca-2019", + "DomainMemberships": [], + "CopyTagsToSnapshot": false, + "MonitoringInterval": 0, + "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:test-mysql-instance", + "IAMDatabaseAuthenticationEnabled": false, + "PerformanceInsightsEnabled": false, + "DeletionProtection": false, + "AssociatedRoles": [] + } + } + } + ] + } + }, + "com.amazonaws.rds#CreateDBInstanceMessage": { + "type": "structure", + "members": { + "DBName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The meaning of this parameter differs according to the database engine you use.

\n
\n
Amazon Aurora MySQL
\n
\n

The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is\n created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created \n in the DB cluster.

\n

Constraints:

\n
    \n
  • \n

    Must contain 1 to 64 alphanumeric characters.

    \n
    • \n
  • \n

    Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

    \n
    • \n
  • \n

    Can't be a word reserved by the database engine.

    \n
    • \n
\n
\n
Amazon Aurora PostgreSQL
\n
\n

The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is\n created. A database named postgres is always created. If this parameter is specified, an additional database with this name is created.

\n

Constraints:

\n
    \n
  • \n

    It must contain 1 to 63 alphanumeric characters.

    \n
    • \n
  • \n

    Must begin with a letter. Subsequent characters can be letters, underscores, or digits\n (0 to 9).

    \n
    • \n
  • \n

    Can't be a word reserved by the database engine.

    \n
    • \n
\n
\n
Amazon RDS Custom for Oracle
\n
\n

The Oracle System ID (SID) of the created RDS Custom DB instance. If you don't specify a value, the default value is ORCL for non-CDBs and\n RDSCDB for CDBs.

\n

Default: ORCL\n

\n

Constraints:

\n
    \n
  • \n

    Must contain 1 to 8 alphanumeric characters.

    \n
    • \n
  • \n

    Must contain a letter.

    \n
    • \n
  • \n

    Can't be a word reserved by the database engine.

    \n
    • \n
\n
\n
Amazon RDS Custom for SQL Server
\n
\n

Not applicable. Must be null.

\n
\n
RDS for Db2
\n
\n

The name of the database to create when the DB instance is created. If\n this parameter isn't specified, no database is created in the DB instance.\n In some cases, we recommend that you don't add a database name. For more\n information, see Additional considerations in the Amazon RDS User\n Guide.

\n

Constraints:

\n
    \n
  • \n

    Must contain 1 to 64 letters or numbers.

    \n
    • \n
  • \n

    Must begin with a letter. Subsequent characters can be letters,\n underscores, or digits (0-9).

    \n
    • \n
  • \n

    Can't be a word reserved by the specified database engine.

    \n
    • \n
\n
\n
RDS for MariaDB
\n
\n

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

\n

Constraints:

\n
    \n
  • \n

    Must contain 1 to 64 letters or numbers.

    \n
    • \n
  • \n

    Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

    \n
    • \n
  • \n

    Can't be a word reserved by the specified database engine.

    \n
    • \n
\n
\n
RDS for MySQL
\n
\n

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

\n

Constraints:

\n
    \n
  • \n

    Must contain 1 to 64 letters or numbers.

    \n
    • \n
  • \n

    Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

    \n
    • \n
  • \n

    Can't be a word reserved by the specified database engine.

    \n
    • \n
\n
\n
RDS for Oracle
\n
\n

The Oracle System ID (SID) of the created DB instance. If you don't specify a value, \n the default value is ORCL. You can't specify the \n string null, or any other reserved word, for DBName.

\n

Default: ORCL\n

\n

Constraints:

\n
    \n
  • \n

    Can't be longer than 8 characters.

    \n
    • \n
\n
\n
RDS for PostgreSQL
\n
\n

The name of the database to create when the DB instance is created. A database named postgres is always created. If this parameter is specified, an additional database with this name is created.

\n

Constraints:

\n
    \n
  • \n

    Must contain 1 to 63 letters, numbers, or underscores.

    \n
    • \n
  • \n

    Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

    \n
    • \n
  • \n

    Can't be a word reserved by the specified database engine.

    \n
    • \n
\n
\n
RDS for SQL Server
\n
\n

Not applicable. Must be null.

\n
\n
" + } + }, + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier for this DB instance. This parameter is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Example: mydbinstance\n

", + "smithy.api#required": {} + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of storage in gibibytes (GiB) to allocate for the DB instance.

\n

This setting doesn't apply to Amazon Aurora DB instances. Aurora cluster volumes automatically grow as the amount of data in your \n database increases, though you are only charged for the space that you use in an Aurora cluster volume.

\n
\n
Amazon RDS Custom
\n
\n

Constraints to the amount of storage for each storage type are the following:

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2, gp3): Must be an integer from 40 to 65536 for RDS Custom for Oracle, \n 16384 for RDS Custom for SQL Server.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1, io2): Must be an integer from 40 to 65536 for RDS Custom for Oracle, \n 16384 for RDS Custom for SQL Server.

    \n
    • \n
\n
\n
RDS for Db2
\n
\n

Constraints to the amount of storage for each storage type are the following:

\n
    \n
  • \n

    General Purpose (SSD) storage (gp3): Must be an integer from 20 to 65536.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1, io2): Must be an integer from 100 to 65536.

    \n
    • \n
\n
\n
RDS for MariaDB
\n
\n

Constraints to the amount of storage for each storage type are the following:

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1, io2): Must be an integer from 100 to 65536.

    \n
    • \n
  • \n

    Magnetic storage (standard): Must be an integer from 5 to 3072.

    \n
    • \n
\n
\n
RDS for MySQL
\n
\n

Constraints to the amount of storage for each storage type are the following:

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1, io2): Must be an integer from 100 to 65536.

    \n
    • \n
  • \n

    Magnetic storage (standard): Must be an integer from 5 to 3072.

    \n
    • \n
\n
\n
RDS for Oracle
\n
\n

Constraints to the amount of storage for each storage type are the following:

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1, io2): Must be an integer from 100 to 65536.

    \n
    • \n
  • \n

    Magnetic storage (standard): Must be an integer from 10 to 3072.

    \n
    • \n
\n
\n
RDS for PostgreSQL
\n
\n

Constraints to the amount of storage for each storage type are the following:

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1, io2): Must be an integer from 100 to 65536.

    \n
    • \n
  • \n

    Magnetic storage (standard): Must be an integer from 5 to 3072.

    \n
    • \n
\n
\n
RDS for SQL Server
\n
\n

Constraints to the amount of storage for each storage type are the following:

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2, gp3):

    \n
      \n
    • \n

      Enterprise and Standard editions: Must be an integer from 20 to 16384.

      \n
      • \n
    • \n

      Web and Express editions: Must be an integer from 20 to 16384.

      \n
      • \n
    \n
    • \n
  • \n

    Provisioned IOPS storage (io1, io2):

    \n
      \n
    • \n

      Enterprise and Standard editions: Must be an integer from 100 to 16384.

      \n
      • \n
    • \n

      Web and Express editions: Must be an integer from 100 to 16384.

      \n
      • \n
    \n
    • \n
  • \n

    Magnetic storage (standard):

    \n
      \n
    • \n

      Enterprise and Standard editions: Must be an integer from 20 to 1024.

      \n
      • \n
    • \n

      Web and Express editions: Must be an integer from 20 to 1024.

      \n
      • \n
    \n
    • \n
\n
\n
" + } + }, + "DBInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The compute and memory capacity of the DB instance, for example db.m5.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.\n For the full list of DB instance classes, and availability for your engine, see\n DB instance \n classes in the Amazon RDS User Guide or \n Aurora \n DB instance classes in the Amazon Aurora User Guide.

", + "smithy.api#required": {} + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The database engine to use for this DB instance.

\n

Not every database engine is available in every Amazon Web Services Region.

\n

Valid Values:

\n
    \n
  • \n

    \n aurora-mysql (for Aurora MySQL DB instances)

    \n
    • \n
  • \n

    \n aurora-postgresql (for Aurora PostgreSQL DB instances)

    \n
    • \n
  • \n

    \n custom-oracle-ee (for RDS Custom for Oracle DB instances)

    \n
    • \n
  • \n

    \n custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances)

    \n
    • \n
  • \n

    \n custom-oracle-se2 (for RDS Custom for Oracle DB instances)

    \n
    • \n
  • \n

    \n custom-oracle-se2-cdb (for RDS Custom for Oracle DB\n instances)

    \n
    • \n
  • \n

    \n custom-sqlserver-ee (for RDS Custom for SQL Server DB instances)

    \n
    • \n
  • \n

    \n custom-sqlserver-se (for RDS Custom for SQL Server DB instances)

    \n
    • \n
  • \n

    \n custom-sqlserver-web (for RDS Custom for SQL Server DB instances)

    \n
    • \n
  • \n

    \n custom-sqlserver-dev (for RDS Custom for SQL Server DB instances)

    \n
    • \n
  • \n

    \n db2-ae\n

    \n
    • \n
  • \n

    \n db2-se\n

    \n
    • \n
  • \n

    \n mariadb\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n oracle-ee\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n oracle-se2\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
  • \n

    \n sqlserver-ee\n

    \n
    • \n
  • \n

    \n sqlserver-se\n

    \n
    • \n
  • \n

    \n sqlserver-ex\n

    \n
    • \n
  • \n

    \n sqlserver-web\n

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "MasterUsername": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name for the master user.

\n

This setting doesn't apply to Amazon Aurora DB instances. The name for the master user is managed by the DB cluster.

\n

This setting is required for RDS DB instances.

\n

Constraints:

\n
    \n
  • \n

    Must be 1 to 16 letters, numbers, or underscores.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't be a reserved word for the chosen database engine.

    \n
    • \n
" + } + }, + "MasterUserPassword": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The password for the master user.

\n

This setting doesn't apply to Amazon Aurora DB instances. The password for the master user is managed by the DB\n cluster.

\n

Constraints:

\n
    \n
  • \n

    Can't be specified if ManageMasterUserPassword is turned on.

    \n
    • \n
  • \n

    Can include any printable ASCII character except \"/\", \"\"\", or \"@\". For RDS for Oracle, can't include the \"&\" (ampersand) or the \"'\" (single quotes) character.

    \n
    • \n
\n

Length Constraints:

\n
    \n
  • \n

    RDS for Db2 - Must contain from 8 to 255 characters.

    \n
    • \n
  • \n

    RDS for MariaDB - Must contain from 8 to 41 characters.

    \n
    • \n
  • \n

    RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.

    \n
    • \n
  • \n

    RDS for MySQL - Must contain from 8 to 41 characters.

    \n
    • \n
  • \n

    RDS for Oracle - Must contain from 8 to 30 characters.

    \n
    • \n
  • \n

    RDS for PostgreSQL - Must contain from 8 to 128 characters.

    \n
    • \n
" + } + }, + "DBSecurityGroups": { + "target": "com.amazonaws.rds#DBSecurityGroupNameList", + "traits": { + "smithy.api#documentation": "

A list of DB security groups to associate with this DB instance.

\n

This setting applies to the legacy EC2-Classic platform, which is no longer used to create \n new DB instances. Use the VpcSecurityGroupIds setting instead.

" + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of Amazon EC2 VPC security groups to associate with this DB instance.

\n

This setting doesn't apply to Amazon Aurora DB instances. The associated list of EC2 VPC security groups is managed by\n the DB cluster.

\n

Default: The default EC2 VPC security group for the DB subnet group's VPC.

" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone (AZ) where the database will be created. For information on\n Amazon Web Services Regions and Availability Zones, see \n Regions\n and Availability Zones.

\n

For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these \n Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.

\n

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

\n

Constraints:

\n
    \n
  • \n

    The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment.

    \n
    • \n
  • \n

    The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.

    \n
    • \n
\n

Example: us-east-1d\n

" + } + }, + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A DB subnet group to associate with this DB instance.

\n

Constraints:

\n
    \n
  • \n

    Must match the name of an existing DB subnet group.

    \n
    • \n
\n

Example: mydbsubnetgroup\n

" + } + }, + "PreferredMaintenanceWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The time range each week during which system maintenance can occur. \n For more information, see Amazon RDS Maintenance Window \n in the Amazon RDS User Guide.\n

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week.

\n

Constraints:

\n
    \n
  • \n

    Must be in the format ddd:hh24:mi-ddd:hh24:mi.

    \n
    • \n
  • \n

    The day values must be mon | tue | wed | thu | fri | sat | sun.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must not conflict with the preferred backup window.

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \n
" + } + }, + "DBParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group to associate with this DB instance. If you don't specify a value, then \n Amazon RDS uses the default DB parameter group for the specified DB engine and version.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Constraints:

\n
    \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    The first character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
" + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days for which automated backups are retained. Setting this parameter to a positive number enables \n backups. Setting this parameter to 0 disables automated backups.

\n

This setting doesn't apply to Amazon Aurora DB instances. The retention period for automated backups is managed by the DB cluster.

\n

Default: 1\n

\n

Constraints:

\n
    \n
  • \n

    Must be a value from 0 to 35.

    \n
    • \n
  • \n

    Can't be set to 0 if the DB instance is a source to read replicas.

    \n
    • \n
  • \n

    Can't be set to 0 for an RDS Custom for Oracle DB instance.

    \n
    • \n
" + } + }, + "PreferredBackupWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.\n The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.

\n

This setting doesn't apply to Amazon Aurora DB instances. The daily time range for creating automated backups is managed by\n the DB cluster.

\n

Constraints:

\n
    \n
  • \n

    Must be in the format hh24:mi-hh24:mi.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must not conflict with the preferred maintenance window.

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \n
" + } + }, + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port number on which the database accepts connections.

\n

This setting doesn't apply to Aurora DB instances. The port number is managed by the cluster.

\n

Valid Values: 1150-65535\n

\n

Default:

\n
    \n
  • \n

    RDS for Db2 - 50000\n

    \n
    • \n
  • \n

    RDS for MariaDB - 3306\n

    \n
    • \n
  • \n

    RDS for Microsoft SQL Server - 1433\n

    \n
    • \n
  • \n

    RDS for MySQL - 3306\n

    \n
    • \n
  • \n

    RDS for Oracle - 1521\n

    \n
    • \n
  • \n

    RDS for PostgreSQL - 5432\n

    \n
    • \n
\n

Constraints:

\n
    \n
  • \n

    For RDS for Microsoft SQL Server, the value can't be 1234, 1434,\n 3260, 3343, 3389, 47001, or\n 49152-49156.

    \n
    • \n
" + } + }, + "MultiAZ": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the DB instance is a Multi-AZ deployment. You can't set \n the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

\n

This setting doesn't apply to the following DB instances:

\n
    \n
  • \n

    Amazon Aurora (DB instance Availability Zones (AZs) are managed by the DB cluster.)

    \n
    • \n
  • \n

    RDS Custom

    \n
    • \n
" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version number of the database engine to use.

\n

This setting doesn't apply to Amazon Aurora DB instances. The version number of the database engine the DB\n instance uses is managed by the DB cluster.

\n

For a list of valid engine versions, use the DescribeDBEngineVersions\n operation.

\n

The following are the database engines and links to information about the major and minor versions that are available with \n Amazon RDS. Not every database engine is available for every Amazon Web Services Region.

\n
\n
Amazon RDS Custom for Oracle
\n
\n

A custom engine version (CEV) that you have previously created. This setting is required for RDS Custom for Oracle. The CEV \n name has the following format: 19.customized_string. A valid CEV name is \n 19.my_cev1. For more information, see \n Creating an RDS Custom for Oracle DB instance in the Amazon RDS User Guide.

\n
\n
Amazon RDS Custom for SQL Server
\n
\n

See RDS Custom for SQL Server general requirements \n in the Amazon RDS User Guide.

\n
\n
RDS for Db2
\n
\n

For information, see Db2 on Amazon RDS versions in the \n Amazon RDS User Guide.

\n
\n
RDS for MariaDB
\n
\n

For information, see MariaDB on Amazon RDS versions in the \n Amazon RDS User Guide.

\n
\n
RDS for Microsoft SQL Server
\n
\n

For information, see Microsoft SQL Server versions on Amazon RDS in the \n Amazon RDS User Guide.

\n
\n
RDS for MySQL
\n
\n

For information, see MySQL on Amazon RDS versions in the \n Amazon RDS User Guide.

\n
\n
RDS for Oracle
\n
\n

For information, see Oracle Database Engine release notes in the \n Amazon RDS User Guide.

\n
\n
RDS for PostgreSQL
\n
\n

For information, see Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.

\n
\n
" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. \n By default, minor engine upgrades are applied automatically.

\n

If you create an RDS Custom DB instance, you must set AutoMinorVersionUpgrade to \n false.

" + } + }, + "LicenseModel": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The license model information for this DB instance.

\n \n

License models for RDS for Db2 require additional configuration. The Bring Your\n Own License (BYOL) model requires a custom parameter group and an Amazon Web Services License Manager self-managed license. The Db2 license through\n Amazon Web Services Marketplace model requires an Amazon Web Services Marketplace subscription. For more\n information, see Amazon RDS for Db2 licensing\n options in the Amazon RDS User Guide.

\n

The default for RDS for Db2 is bring-your-own-license.

\n \n

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

\n

Valid Values:

\n
    \n
  • \n

    RDS for Db2 - bring-your-own-license | marketplace-license\n

    \n
    • \n
  • \n

    RDS for MariaDB - general-public-license\n

    \n
    • \n
  • \n

    RDS for Microsoft SQL Server - license-included\n

    \n
    • \n
  • \n

    RDS for MySQL - general-public-license\n

    \n
    • \n
  • \n

    RDS for Oracle - bring-your-own-license | license-included\n

    \n
    • \n
  • \n

    RDS for PostgreSQL - postgresql-license\n

    \n
    • \n
" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance.\n For information about valid IOPS values, see \n Amazon RDS DB instance storage \n in the Amazon RDS User Guide.

\n

This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.

\n

Constraints:

\n
    \n
  • \n

    For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 \n of the storage amount for the DB instance.

    \n
    • \n
  • \n

    For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance.

    \n
    • \n
" + } + }, + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The option group to associate the DB instance with.

\n

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed \n from an option group. Also, that option group can't be removed from a DB instance after it is \n associated with a DB instance.

\n

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

" + } + }, + "CharacterSetName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

For supported engines, the character set (CharacterSet) to associate the DB instance with.

\n

This setting doesn't apply to the following DB instances:

\n
    \n
  • \n

    Amazon Aurora - The character set is managed by\n the DB cluster. For more information, see CreateDBCluster.

    \n
    • \n
  • \n

    RDS Custom - However, if you need to change the character set, \n you can change it on the database itself.

    \n
    • \n
" + } + }, + "NcharCharacterSetName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the NCHAR character set for the Oracle DB instance.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the DB instance is publicly accessible.

\n

When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), \n its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, \n the endpoint resolves to the private IP address. Access to the DB instance is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB instance doesn't permit it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

\n

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

\n
    \n
  • \n

    If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB instance is private.

    \n
    • \n
  • \n

    If the default VPC in the target Region has an internet gateway attached to it, the DB instance is public.

    \n
    • \n
\n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n
    \n
  • \n

    If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB instance is private.

    \n
    • \n
  • \n

    If the subnets are part of a VPC that has an internet gateway attached to it, the DB instance is public.

    \n
    • \n
" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

Tags to assign to the DB instance.

" + } + }, + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the DB cluster that this DB instance will belong to.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The storage type to associate with the DB instance.

\n

If you specify io1, io2, or gp3, you must also include a value for the\n Iops parameter.

\n

This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.

\n

Valid Values: gp2 | gp3 | io1 | io2 | standard\n

\n

Default: io1, if the Iops parameter\n is specified. Otherwise, gp2.

" + } + }, + "TdeCredentialArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN from the key store with which to associate the instance for TDE encryption.

\n

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

" + } + }, + "TdeCredentialPassword": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The password for the given ARN from the key store in order to access the device.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "StorageEncrypted": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifes whether the DB instance is encrypted. By default, it isn't encrypted.

\n

For RDS Custom DB instances, either enable this setting or leave it unset. Otherwise, Amazon RDS reports an error.

\n

This setting doesn't apply to Amazon Aurora DB instances. The encryption for DB instances is managed by the DB cluster.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB instance.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

This setting doesn't apply to Amazon Aurora DB instances. The Amazon Web Services KMS key identifier is managed by\n the DB cluster. For more information, see CreateDBCluster.

\n

If StorageEncrypted is enabled, and you do\n not specify a value for the KmsKeyId parameter, then\n Amazon RDS uses your default KMS key. There is a \n default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different\n default KMS key for each Amazon Web Services Region.

\n

For Amazon RDS Custom, a KMS key is required for DB instances. For most RDS engines, if you leave this parameter empty \n while enabling StorageEncrypted, the engine uses the default KMS key. However, RDS Custom \n doesn't use the default key when this parameter is empty. You must explicitly specify a key.

" + } + }, + "Domain": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Active Directory directory ID to create the DB instance in. Currently, you can create only Db2, MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

This setting doesn't apply to the following DB instances:

\n
    \n
  • \n

    Amazon Aurora (The domain is managed by the DB cluster.)

    \n
    • \n
  • \n

    RDS Custom

    \n
    • \n
" + } + }, + "DomainFqdn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The fully qualified domain name (FQDN) of an Active Directory domain.

\n

Constraints:

\n
    \n
  • \n

    Can't be longer than 64 characters.

    \n
    • \n
\n

Example: mymanagedADtest.mymanagedAD.mydomain\n

" + } + }, + "DomainOu": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Active Directory organizational unit for your DB instance to join.

\n

Constraints:

\n
    \n
  • \n

    Must be in the distinguished name format.

    \n
    • \n
  • \n

    Can't be longer than 64 characters.

    \n
    • \n
\n

Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain\n

" + } + }, + "DomainAuthSecretArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN for the Secrets Manager secret with the credentials for the user joining the domain.

\n

Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456\n

" + } + }, + "DomainDnsIps": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.

\n

Constraints:

\n
    \n
  • \n

    Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.

    \n
    • \n
\n

Example: 123.124.125.126,234.235.236.237\n

" + } + }, + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

\n

This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting.

" + } + }, + "MonitoringInterval": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for \n the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0.

\n

If MonitoringRoleArn is specified, then you must set MonitoringInterval\n to a value other than 0.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60\n

\n

Default: 0\n

" + } + }, + "MonitoringRoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see Setting Up and Enabling Enhanced Monitoring \n in the Amazon RDS User Guide.

\n

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "DomainIAMRoleName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the IAM role to use when making API calls to the Directory Service.

\n

This setting doesn't apply to the following DB instances:

\n
    \n
  • \n

    Amazon Aurora (The domain is managed by the DB cluster.)

    \n
    • \n
  • \n

    RDS Custom

    \n
    • \n
" + } + }, + "PromotionTier": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The order of priority in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Default: 1\n

\n

Valid Values: 0 - 15\n

" + } + }, + "Timezone": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The time zone of the DB instance. \n The time zone parameter is currently supported only by RDS for Db2 and\n RDS for SQL Server.

" + } + }, + "EnableIAMDatabaseAuthentication": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.

\n

For more information, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

\n

This setting doesn't apply to the following DB instances:

\n
    \n
  • \n

    Amazon Aurora (Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.)

    \n
    • \n
  • \n

    RDS Custom

    \n
    • \n
" + } + }, + "DatabaseInsightsMode": { + "target": "com.amazonaws.rds#DatabaseInsightsMode", + "traits": { + "smithy.api#documentation": "

The mode of Database Insights to enable for the DB instance.

\n

This setting only applies to Amazon Aurora DB instances.

\n \n

Currently, this value is inherited from the DB cluster and can't be changed.

\n " + } + }, + "EnablePerformanceInsights": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable Performance Insights for the DB instance. For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "PerformanceInsightsKMSKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "PerformanceInsightsRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days to retain Performance Insights data.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Valid Values:

\n
    \n
  • \n

    \n 7\n

    \n
    • \n
  • \n

    \n month * 31, where month is a number of months from 1-23. \n Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)

    \n
    • \n
  • \n

    \n 731\n

    \n
    • \n
\n

Default: 7 days

\n

If you specify a retention period that isn't valid, such as 94, Amazon RDS returns an error.

" + } + }, + "EnableCloudwatchLogsExports": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

The list of log types to enable for exporting to CloudWatch Logs. For more information, see \n \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

This setting doesn't apply to the following DB instances:

\n
    \n
  • \n

    Amazon Aurora (CloudWatch Logs exports are managed by the DB cluster.)

    \n
    • \n
  • \n

    RDS Custom

    \n
    • \n
\n

The following values are valid for each DB engine:

\n
    \n
  • \n

    RDS for Db2 - diag.log | notify.log\n

    \n
    • \n
  • \n

    RDS for MariaDB - audit | error | general | slowquery\n

    \n
    • \n
  • \n

    RDS for Microsoft SQL Server - agent | error\n

    \n
    • \n
  • \n

    RDS for MySQL - audit | error | general | slowquery\n

    \n
    • \n
  • \n

    RDS for Oracle - alert | audit | listener | trace | oemagent\n

    \n
    • \n
  • \n

    RDS for PostgreSQL - postgresql | upgrade\n

    \n
    • \n
" + } + }, + "ProcessorFeatures": { + "target": "com.amazonaws.rds#ProcessorFeatureList", + "traits": { + "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

\n

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.

\n

This setting doesn't apply to Amazon Aurora DB instances. You can enable or disable deletion protection for the DB cluster. \n For more information, see CreateDBCluster. DB instances in a DB \n cluster can be deleted even when deletion protection is enabled for the DB cluster.

" + } + }, + "MaxAllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

\n

For more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.

\n

This setting doesn't apply to the following DB instances:

\n
    \n
  • \n

    Amazon Aurora (Storage is managed by the DB cluster.)

    \n
    • \n
  • \n

    RDS Custom

    \n
    • \n
" + } + }, + "EnableCustomerOwnedIp": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable a customer-owned IP address (CoIP) for an RDS\n on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" + } + }, + "CustomIamInstanceProfile": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance.

\n

This setting is required for RDS Custom.

\n

Constraints:

\n
    \n
  • \n

    The profile must exist in your account.

    \n
    • \n
  • \n

    The profile must have an IAM role that Amazon EC2 has permissions to assume.

    \n
    • \n
  • \n

    The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

    \n
    • \n
\n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.

" + } + }, + "BackupTarget": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The location for storing automated backups and manual snapshots.

\n

Valid Values:

\n
    \n
  • \n

    \n outposts (Amazon Web Services Outposts)

    \n
    • \n
  • \n

    \n region (Amazon Web Services Region)

    \n
    • \n
\n

Default: region\n

\n

For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

" + } + }, + "NetworkType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The network type of the DB instance.

\n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

\n

Valid Values: IPV4 | DUAL\n

" + } + }, + "StorageThroughput": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The storage throughput value for the DB instance.

\n

This setting applies only to the gp3 storage type.

\n

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

" + } + }, + "ManageMasterUserPassword": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.\n

\n

Constraints:

\n
    \n
  • \n

    Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword \n is specified.

    \n
    • \n
" + } + }, + "MasterUserSecretKmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and \n managed in Amazon Web Services Secrets Manager.

\n

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB instance.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager \n KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't \n use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer \n managed KMS key.

\n

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.

" + } + }, + "CACertificateIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The CA certificate identifier to use for the DB instance's server certificate.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

For more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.

" + } + }, + "DBSystemId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Oracle system identifier (SID), which is the name of the Oracle database instance that \n manages your database files. In this context, the term \"Oracle database instance\" refers exclusively \n to the system global area (SGA) and Oracle background processes. If you don't specify a SID, \n the value defaults to RDSCDB. The Oracle SID is also the name of your CDB.

" + } + }, + "DedicatedLogVolume": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether the DB instance has a dedicated log volume (DLV) enabled.

" + } + }, + "MultiTenant": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to use the multi-tenant configuration or the single-tenant\n configuration (default). This parameter only applies to RDS for Oracle container\n database (CDB) engines.

\n

Note the following restrictions:

\n
    \n
  • \n

    The DB engine that you specify in the request must support the multi-tenant\n configuration. If you attempt to enable the multi-tenant configuration on a DB\n engine that doesn't support it, the request fails.

    \n
    • \n
  • \n

    If you specify the multi-tenant configuration when you create your DB instance,\n you can't later modify this DB instance to use the single-tenant configuration.

    \n
    • \n
" + } + }, + "EngineLifecycleSupport": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The life cycle type for this DB instance.

\n \n

By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. \n At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, \n creating the DB instance will fail if the DB major version is past its end of standard support date.

\n \n

This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.

\n

You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, \n you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon RDS User Guide.

\n

Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled\n

\n

Default: open-source-rds-extended-support\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#CreateDBInstanceReadReplica": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateDBInstanceReadReplicaMessage" + }, + "output": { + "target": "com.amazonaws.rds#CreateDBInstanceReadReplicaResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#CertificateNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupNotAllowedFault" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DomainNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InstanceQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#InsufficientDBInstanceCapacityFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSubnetGroupFault" + }, + { + "target": "com.amazonaws.rds#InvalidSubnet" + }, + { + "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + }, + { + "target": "com.amazonaws.rds#NetworkTypeNotSupported" + }, + { + "target": "com.amazonaws.rds#OptionGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#ProvisionedIopsNotAvailableInAZFault" + }, + { + "target": "com.amazonaws.rds#StorageQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#StorageTypeNotSupportedFault" + }, + { + "target": "com.amazonaws.rds#TenantDatabaseQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new DB instance that acts as a read replica for an existing source DB\n instance or Multi-AZ DB cluster. You can create a read replica for a DB instance running\n Db2, MariaDB, MySQL, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a\n Multi-AZ DB cluster running MySQL or PostgreSQL. For more information, see Working\n with read replicas and Migrating from a Multi-AZ DB cluster to a DB instance using a read replica in the Amazon RDS User Guide.

\n

Amazon Aurora doesn't support this operation. To create a DB instance for an Aurora DB cluster, use the CreateDBInstance\n operation.

\n

All read replica DB instances are created with backups disabled. All other attributes\n (including DB security groups and DB parameter groups) are inherited from the source DB\n instance or cluster, except as specified.

\n \n

Your source DB instance or cluster must have backup retention enabled.

\n ", + "smithy.api#examples": [ + { + "title": "To create a DB instance read replica", + "documentation": "This example creates a read replica of an existing DB instance named test-instance. The read replica is named test-instance-repl.", + "input": { + "DBInstanceIdentifier": "test-instance-repl", + "SourceDBInstanceIdentifier": "test-instance" + }, + "output": { + "DBInstance": { + "IAMDatabaseAuthenticationEnabled": false, + "MonitoringInterval": 0, + "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:test-instance-repl", + "ReadReplicaSourceDBInstanceIdentifier": "test-instance", + "DBInstanceIdentifier": "test-instance-repl" + } + } + } + ] + } + }, + "com.amazonaws.rds#CreateDBInstanceReadReplicaMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The DB instance identifier of the read replica. This identifier is the unique key\n that identifies a DB instance. This parameter is stored as a lowercase string.

", + "smithy.api#required": {} + } + }, + "SourceDBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the DB instance that will act as the source for the read replica.\n Each DB instance can have up to 15 read replicas, with the exception of Oracle and SQL\n Server, which can have up to five.

\n

Constraints:

\n
    \n
  • \n

    Must be the identifier of an existing Db2, MariaDB, MySQL, Oracle, PostgreSQL, or SQL Server DB\n instance.

    \n
    • \n
  • \n

    Can't be specified if the SourceDBClusterIdentifier parameter is\n also specified.

    \n
    • \n
  • \n

    For the limitations of Oracle read replicas, see Version and licensing considerations for RDS for Oracle replicas in the\n Amazon RDS User Guide.

    \n
    • \n
  • \n

    For the limitations of SQL Server read replicas, see Read replica limitations with SQL Server in the Amazon RDS User Guide.

    \n
    • \n
  • \n

    The specified DB instance must have automatic backups enabled, that is, its backup\n retention period must be greater than 0.

    \n
    • \n
  • \n

    If the source DB instance is in the same Amazon Web Services Region as the read replica, specify a valid DB\n instance identifier.

    \n
    • \n
  • \n

    If the source DB instance is in a different Amazon Web Services Region from the read\n replica, specify a valid DB instance ARN. For more information, see Constructing an ARN for Amazon RDS in the Amazon RDS User\n Guide. This doesn't apply to SQL Server or RDS Custom, which\n don't support cross-Region replicas.

    \n
    • \n
" + } + }, + "DBInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The compute and memory capacity of the read replica, for example\n db.m4.large. Not all DB instance classes are available in all Amazon Web Services\n Regions, or for all database engines. For the full list of DB instance classes, and\n availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

\n

Default: Inherits the value from the source DB instance.

" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone (AZ) where the read replica will be created.

\n

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

\n

Example: us-east-1d\n

" + } + }, + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port number that the DB instance uses for connections.

\n

Valid Values: 1150-65535\n

\n

Default: Inherits the value from the source DB instance.

" + } + }, + "MultiAZ": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the read replica is in a Multi-AZ deployment.

\n

You can create a read replica as a Multi-AZ DB instance. RDS creates a standby of your\n replica in another Availability Zone for failover support for the replica. Creating your\n read replica as a Multi-AZ DB instance is independent of whether the source is a\n Multi-AZ DB instance or a Multi-AZ DB cluster.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to automatically apply minor engine upgrades to the\n read replica during the maintenance window.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Default: Inherits the value from the source DB instance.

" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance.

" + } + }, + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The option group to associate the DB instance with. If not specified, RDS uses the option group\n associated with the source DB instance or cluster.

\n \n

For SQL Server, you must use the option group associated with the source.

\n \n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "DBParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group to associate with this read replica DB\n instance.

\n

For Single-AZ or Multi-AZ DB instance read replica instances, if you don't specify a\n value for DBParameterGroupName, then Amazon RDS uses the\n DBParameterGroup of the source DB instance for a same Region read\n replica, or the default DBParameterGroup for the specified DB engine for a\n cross-Region read replica.

\n

For Multi-AZ DB cluster same Region read replica instances, if you don't specify a\n value for DBParameterGroupName, then Amazon RDS uses the default\n DBParameterGroup.

\n

Specifying a parameter group for this operation is only supported for MySQL DB\n instances for cross-Region read replicas, for Multi-AZ DB cluster read replica\n instances, and for Oracle DB instances. It isn't supported for MySQL DB instances for\n same Region read replicas or for RDS Custom.

\n

Constraints:

\n
    \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the DB instance is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBInstance.

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + }, + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn't created in a VPC.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DB subnet group.

    \n
    • \n
  • \n

    The specified DB subnet group must be in the same Amazon Web Services Region in which the operation is running.

    \n
    • \n
  • \n

    All read replicas in one Amazon Web Services Region that are created from the same source DB\n instance must either:

    \n
      \n
    • \n

      Specify DB subnet groups from the same VPC. All these read replicas are created in the same\n VPC.

      \n
      • \n
    • \n

      Not specify a DB subnet group. All these read replicas are created outside of any\n VPC.

      \n
      • \n
    \n
    • \n
\n

Example: mydbsubnetgroup\n

" + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of Amazon EC2 VPC security groups to associate with the read replica.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Default: The default EC2 VPC security group for the DB subnet group's VPC.

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The storage type to associate with the read replica.

\n

If you specify io1, io2, or gp3, you must also include a value for the\n Iops parameter.

\n

Valid Values: gp2 | gp3 | io1 | io2 | standard\n

\n

Default: io1 if the Iops parameter\n is specified. Otherwise, gp2.

" + } + }, + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to copy all tags from the read replica to snapshots of\n the read replica. By default, tags aren't copied.

" + } + }, + "MonitoringInterval": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are\n collected for the read replica. To disable collection of Enhanced Monitoring metrics,\n specify 0. The default is 0.

\n

If MonitoringRoleArn is specified, then you must set MonitoringInterval\n to a value other than 0.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Valid Values: 0, 1, 5, 10, 15, 30, 60\n

\n

Default: 0\n

" + } + }, + "MonitoringRoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n go to To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

\n

If MonitoringInterval is set to a value other than 0, then you must \n supply a MonitoringRoleArn value.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted read replica.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you create an encrypted read replica in the same Amazon Web Services Region as the source DB\n instance or Multi-AZ DB cluster, don't specify a value for this parameter. A read\n replica in the same Amazon Web Services Region is always encrypted with the same KMS key as the source\n DB instance or cluster.

\n

If you create an encrypted read replica in a different Amazon Web Services Region, then you must\n specify a KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to\n the Amazon Web Services Region that they are created in, and you can't use KMS keys from one\n Amazon Web Services Region in another Amazon Web Services Region.

\n

You can't create an encrypted read replica from an unencrypted DB instance or\n Multi-AZ DB cluster.

\n

This setting doesn't apply to RDS Custom, which uses the same KMS key as the primary \n replica.

" + } + }, + "PreSignedUrl": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

When you are creating a read replica from one Amazon Web Services GovCloud (US) Region to another or\n from one China Amazon Web Services Region to another, the URL that contains a Signature Version 4\n signed request for the CreateDBInstanceReadReplica API operation in the\n source Amazon Web Services Region that contains the source DB instance.

\n

This setting applies only to Amazon Web Services GovCloud (US) Regions and \n China Amazon Web Services Regions. It's ignored in other Amazon Web Services Regions.

\n

This setting applies only when replicating from a source DB\n instance. Source DB clusters aren't supported in Amazon Web Services GovCloud (US) Regions and China Amazon Web Services Regions.

\n

You must specify this parameter when you create an encrypted read replica from\n another Amazon Web Services Region by using the Amazon RDS API. Don't specify\n PreSignedUrl when you are creating an encrypted read replica in the\n same Amazon Web Services Region.

\n

The presigned URL must be a valid request for the\n CreateDBInstanceReadReplica API operation that can run in the\n source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL\n request must contain the following parameter values:

\n
    \n
  • \n

    \n DestinationRegion - The Amazon Web Services Region that the encrypted read\n replica is created in. This Amazon Web Services Region is the same one where the\n CreateDBInstanceReadReplica operation is called that contains\n this presigned URL.

    \n

    For example, if you create an encrypted DB instance in the us-west-1\n Amazon Web Services Region, from a source DB instance in the us-east-2 Amazon Web Services Region, then you\n call the CreateDBInstanceReadReplica operation in the us-east-1\n Amazon Web Services Region and provide a presigned URL that contains a call to the\n CreateDBInstanceReadReplica operation in the us-west-2\n Amazon Web Services Region. For this example, the DestinationRegion in the\n presigned URL must be set to the us-east-1 Amazon Web Services Region.

    \n
    • \n
  • \n

    \n KmsKeyId - The KMS key identifier for the key to use to\n encrypt the read replica in the destination Amazon Web Services Region. This is the same\n identifier for both the CreateDBInstanceReadReplica operation that\n is called in the destination Amazon Web Services Region, and the operation contained in the\n presigned URL.

    \n
    • \n
  • \n

    \n SourceDBInstanceIdentifier - The DB instance identifier for the\n encrypted DB instance to be replicated. This identifier must be in the Amazon\n Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are\n creating an encrypted read replica from a DB instance in the us-west-2\n Amazon Web Services Region, then your SourceDBInstanceIdentifier looks like the\n following example:\n arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.

    \n
    • \n
\n

To learn how to generate a Signature Version 4 signed request, see \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can run in the source Amazon Web Services Region.

\n \n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "EnableIAMDatabaseAuthentication": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.

\n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "DatabaseInsightsMode": { + "target": "com.amazonaws.rds#DatabaseInsightsMode", + "traits": { + "smithy.api#documentation": "

The mode of Database Insights to enable for the read replica.

\n \n

Currently, this setting is not supported.

\n " + } + }, + "EnablePerformanceInsights": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable Performance Insights for the read replica.

\n

For more information, see Using\n Amazon Performance Insights in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "PerformanceInsightsKMSKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "PerformanceInsightsRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days to retain Performance Insights data.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Valid Values:

\n
    \n
  • \n

    \n 7\n

    \n
    • \n
  • \n

    \n month * 31, where month is a number of months from 1-23. \n Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)

    \n
    • \n
  • \n

    \n 731\n

    \n
    • \n
\n

Default: 7 days

\n

If you specify a retention period that isn't valid, such as 94, Amazon RDS returns an error.

" + } + }, + "EnableCloudwatchLogsExports": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

The list of logs that the new DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing\n Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "ProcessorFeatures": { + "target": "com.amazonaws.rds#ProcessorFeatureList", + "traits": { + "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "UseDefaultProcessorFeatures": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the DB instance class of the DB instance uses its default\n processor features.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable deletion protection for the DB instance. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.

" + } + }, + "Domain": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "DomainIAMRoleName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the IAM role to use when making API calls to the Directory\n Service.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "DomainFqdn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The fully qualified domain name (FQDN) of an Active Directory domain.

\n

Constraints:

\n
    \n
  • \n

    Can't be longer than 64 characters.

    \n
    • \n
\n

Example: mymanagedADtest.mymanagedAD.mydomain\n

" + } + }, + "DomainOu": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Active Directory organizational unit for your DB instance to join.

\n

Constraints:

\n
    \n
  • \n

    Must be in the distinguished name format.

    \n
    • \n
  • \n

    Can't be longer than 64 characters.

    \n
    • \n
\n

Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain\n

" + } + }, + "DomainAuthSecretArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN for the Secrets Manager secret with the credentials for the user joining the domain.

\n

Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456\n

" + } + }, + "DomainDnsIps": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.

\n

Constraints:

\n
    \n
  • \n

    Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.

    \n
    • \n
\n

Example: 123.124.125.126,234.235.236.237\n

" + } + }, + "ReplicaMode": { + "target": "com.amazonaws.rds#ReplicaMode", + "traits": { + "smithy.api#documentation": "

The open mode of the replica database: mounted or read-only.

\n \n

This parameter is only supported for Oracle DB instances.

\n \n

Mounted DB replicas are included in Oracle Database Enterprise Edition. The main use case for\n mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active\n Data Guard to transmit information to the mounted replica. Because it doesn't accept\n user connections, a mounted replica can't serve a read-only workload.

\n

You can create a combination of mounted and read-only DB replicas for the same primary DB instance.\n For more information, see Working with Oracle Read Replicas for Amazon RDS \n in the Amazon RDS User Guide.

\n

For RDS Custom, you must specify this parameter and set it to mounted. The value won't be set by default. \n After replica creation, you can manage the open mode manually.

" + } + }, + "MaxAllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

\n

For more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.

" + } + }, + "CustomIamInstanceProfile": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:

\n
    \n
  • \n

    The profile must exist in your account.

    \n
    • \n
  • \n

    The profile must have an IAM role that Amazon EC2 has permissions to assume.

    \n
    • \n
  • \n

    The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

    \n
    • \n
\n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.

\n

This setting is required for RDS Custom DB instances.

" + } + }, + "NetworkType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid Values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

The network type is determined by the DBSubnetGroup specified for read replica. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" + } + }, + "StorageThroughput": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Specifies the storage throughput value for the read replica.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora DB instances.

" + } + }, + "EnableCustomerOwnedIp": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable a customer-owned IP address (CoIP) for an RDS\n on Outposts read replica.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the read replica from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of storage (in gibibytes) to allocate initially for the read replica.\n Follow the allocation rules specified in CreateDBInstance.

\n

This setting isn't valid for RDS for SQL Server.

\n \n

Be sure to allocate enough storage for your read replica so that the create operation can succeed.\n You can also allocate additional storage for future growth.

\n " + } + }, + "SourceDBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the Multi-AZ DB cluster that will act as the source for the read\n replica. Each DB cluster can have up to 15 read replicas.

\n

Constraints:

\n
    \n
  • \n

    Must be the identifier of an existing Multi-AZ DB cluster.

    \n
    • \n
  • \n

    Can't be specified if the SourceDBInstanceIdentifier parameter is\n also specified.

    \n
    • \n
  • \n

    The specified DB cluster must have automatic backups enabled, that is, its\n backup retention period must be greater than 0.

    \n
    • \n
  • \n

    The source DB cluster must be in the same Amazon Web Services Region as the read replica.\n Cross-Region replication isn't supported.

    \n
    • \n
" + } + }, + "DedicatedLogVolume": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether the DB instance has a dedicated log volume (DLV) enabled.

" + } + }, + "UpgradeStorageConfig": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Whether to upgrade the storage file system configuration on the read replica. This option\n migrates the read replica from the old storage file system layout to the preferred layout.

" + } + }, + "CACertificateIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The CA certificate identifier to use for the read replica's server certificate.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

For more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#CreateDBInstanceReadReplicaResult": { + "type": "structure", + "members": { + "DBInstance": { + "target": "com.amazonaws.rds#DBInstance" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#CreateDBInstanceResult": { + "type": "structure", + "members": { + "DBInstance": { + "target": "com.amazonaws.rds#DBInstance" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#CreateDBParameterGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateDBParameterGroupMessage" + }, + "output": { + "target": "com.amazonaws.rds#CreateDBParameterGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBParameterGroupAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBParameterGroupQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new DB parameter group.

\n

A DB parameter group is initially created with the default parameters for the\n database engine used by the DB instance. To provide custom values for any of the\n parameters, you must modify the group after creating it using\n ModifyDBParameterGroup. Once you've created a DB parameter group, you need to\n associate it with your DB instance using ModifyDBInstance. When you associate\n a new DB parameter group with a running DB instance, you need to reboot the DB\n instance without failover for the new DB parameter group and associated settings to take effect.

\n

This command doesn't apply to RDS Custom.

\n \n

After you create a DB parameter group, you should wait at least 5 minutes\n before creating your first DB instance that uses that DB parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the create action before the parameter \n group is used as the default for a new DB instance. This is especially important for parameters \n that are critical when creating the default database for a DB instance, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBParameters command to verify \n that your DB parameter group has been created or modified.

\n ", + "smithy.api#examples": [ + { + "title": "To create a DB parameter group", + "documentation": "The following example creates a DB parameter group.", + "input": { + "DBParameterGroupName": "mydbparametergroup", + "DBParameterGroupFamily": "MySQL8.0", + "Description": "My new parameter group" + }, + "output": { + "DBParameterGroup": { + "DBParameterGroupName": "mydbparametergroup", + "DBParameterGroupFamily": "mysql8.0", + "Description": "My new parameter group", + "DBParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:pg:mydbparametergroup" + } + } + } + ] + } + }, + "com.amazonaws.rds#CreateDBParameterGroupMessage": { + "type": "structure", + "members": { + "DBParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the DB parameter group.

\n

Constraints:

\n
    \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
\n \n

This value is stored as a lowercase string.

\n ", + "smithy.api#required": {} + } + }, + "DBParameterGroupFamily": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.

\n

To list all of the available parameter group families for a DB engine, use the following command:

\n

\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine \n

\n

For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:

\n

\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine mysql\n

\n \n

The output contains duplicates.

\n \n

The following are the valid DB engine values:

\n
    \n
  • \n

    \n aurora-mysql\n

    \n
    • \n
  • \n

    \n aurora-postgresql\n

    \n
    • \n
  • \n

    \n db2-ae\n

    \n
    • \n
  • \n

    \n db2-se\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n oracle-ee\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n oracle-se2\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
  • \n

    \n sqlserver-ee\n

    \n
    • \n
  • \n

    \n sqlserver-se\n

    \n
    • \n
  • \n

    \n sqlserver-ex\n

    \n
    • \n
  • \n

    \n sqlserver-web\n

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The description for the DB parameter group.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

Tags to assign to the DB parameter group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#CreateDBParameterGroupResult": { + "type": "structure", + "members": { + "DBParameterGroup": { + "target": "com.amazonaws.rds#DBParameterGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#CreateDBProxy": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateDBProxyRequest" + }, + "output": { + "target": "com.amazonaws.rds#CreateDBProxyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBProxyAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBProxyQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#InvalidSubnet" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new DB proxy.

" + } + }, + "com.amazonaws.rds#CreateDBProxyEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateDBProxyEndpointRequest" + }, + "output": { + "target": "com.amazonaws.rds#CreateDBProxyEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBProxyEndpointAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBProxyEndpointQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#DBProxyNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBProxyStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidSubnet" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a DBProxyEndpoint. Only applies to proxies that are associated with Aurora DB clusters.\n You can use DB proxy endpoints to specify read/write or read-only access to the DB cluster. You can also use\n DB proxy endpoints to access a DB proxy through a different VPC than the proxy's default VPC.

" + } + }, + "com.amazonaws.rds#CreateDBProxyEndpointRequest": { + "type": "structure", + "members": { + "DBProxyName": { + "target": "com.amazonaws.rds#DBProxyName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the DB proxy associated with the DB proxy endpoint that you create.

", + "smithy.api#required": {} + } + }, + "DBProxyEndpointName": { + "target": "com.amazonaws.rds#DBProxyEndpointName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the DB proxy endpoint to create.

", + "smithy.api#required": {} + } + }, + "VpcSubnetIds": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The VPC subnet IDs for the DB proxy endpoint that you create. You can specify a\n different set of subnet IDs than for the original DB proxy.

", + "smithy.api#required": {} + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The VPC security group IDs for the DB proxy endpoint that you create. You can\n specify a different set of security group IDs than for the original DB proxy.\n The default is the default security group for the VPC.

" + } + }, + "TargetRole": { + "target": "com.amazonaws.rds#DBProxyEndpointTargetRole", + "traits": { + "smithy.api#documentation": "

The role of the DB proxy endpoint. The role determines whether the endpoint can be used for read/write\n or only read operations. The default is READ_WRITE. The only role that proxies for RDS for Microsoft SQL Server \n support is READ_WRITE.

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#CreateDBProxyEndpointResponse": { + "type": "structure", + "members": { + "DBProxyEndpoint": { + "target": "com.amazonaws.rds#DBProxyEndpoint", + "traits": { + "smithy.api#documentation": "

The DBProxyEndpoint object that is created by the API operation.\n The DB proxy endpoint that you create might provide capabilities such as read/write\n or read-only operations, or using a different VPC than the proxy's default VPC.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#CreateDBProxyRequest": { + "type": "structure", + "members": { + "DBProxyName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

", + "smithy.api#required": {} + } + }, + "EngineFamily": { + "target": "com.amazonaws.rds#EngineFamily", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The kinds of databases that the proxy can connect to. \n This value determines which database network protocol the proxy recognizes when it interprets\n network traffic to and from the database. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify MYSQL. \n For Aurora PostgreSQL and RDS for PostgreSQL databases, specify POSTGRESQL. For RDS for Microsoft SQL Server, specify \n SQLSERVER.

", + "smithy.api#required": {} + } + }, + "Auth": { + "target": "com.amazonaws.rds#UserAuthConfigList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The authorization mechanism that the proxy uses.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.

", + "smithy.api#required": {} + } + }, + "VpcSubnetIds": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

One or more VPC subnet IDs to associate with the new proxy.

", + "smithy.api#required": {} + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

One or more VPC security group IDs to associate with the new proxy.

" + } + }, + "RequireTLS": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.\n By enabling this setting, you can enforce encrypted TLS connections to the proxy.

" + } + }, + "IdleClientTimeout": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this\n value higher or lower than the connection timeout limit for the associated database.

" + } + }, + "DebugLogging": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the proxy includes detailed information about SQL statements in its logs.\n This information helps you to debug issues involving SQL behavior or the performance\n and scalability of the proxy connections. The debug information includes the text of\n SQL statements that you submit through the proxy. Thus, only enable this setting\n when needed for debugging, and only when you have security measures in place to\n safeguard any sensitive information that appears in the logs.

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#CreateDBProxyResponse": { + "type": "structure", + "members": { + "DBProxy": { + "target": "com.amazonaws.rds#DBProxy", + "traits": { + "smithy.api#documentation": "

The DBProxy structure corresponding to the new proxy.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#CreateDBSecurityGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateDBSecurityGroupMessage" + }, + "output": { + "target": "com.amazonaws.rds#CreateDBSecurityGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBSecurityGroupAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBSecurityGroupNotSupportedFault" + }, + { + "target": "com.amazonaws.rds#DBSecurityGroupQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new DB security group. DB security groups control access to a DB instance.

\n

A DB security group controls access to EC2-Classic DB instances that are not in a VPC.

\n \n

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – \n Here’s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

\n ", + "smithy.api#examples": [ + { + "title": "To create a DB security group.", + "documentation": "This example creates a DB security group.", + "input": { + "DBSecurityGroupName": "mydbsecuritygroup", + "DBSecurityGroupDescription": "My DB security group" + }, + "output": { + "DBSecurityGroup": {} + } + } + ] + } + }, + "com.amazonaws.rds#CreateDBSecurityGroupMessage": { + "type": "structure", + "members": { + "DBSecurityGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name for the DB security group. This value is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
  • \n

    Must not be \"Default\"

    \n
    • \n
\n

Example: mysecuritygroup\n

", + "smithy.api#required": {} + } + }, + "DBSecurityGroupDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The description for the DB security group.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

Tags to assign to the DB security group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#CreateDBSecurityGroupResult": { + "type": "structure", + "members": { + "DBSecurityGroup": { + "target": "com.amazonaws.rds#DBSecurityGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#CreateDBShardGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateDBShardGroupMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBShardGroup" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBShardGroupAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" + }, + { + "target": "com.amazonaws.rds#MaxDBShardGroupLimitReached" + }, + { + "target": "com.amazonaws.rds#NetworkTypeNotSupported" + }, + { + "target": "com.amazonaws.rds#UnsupportedDBEngineVersionFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new DB shard group for Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group.

\n

Valid for: Aurora DB clusters only

" + } + }, + "com.amazonaws.rds#CreateDBShardGroupMessage": { + "type": "structure", + "members": { + "DBShardGroupIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the DB shard group.

", + "smithy.api#required": {} + } + }, + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the primary DB cluster for the DB shard group.

", + "smithy.api#required": {} + } + }, + "ComputeRedundancy": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to create standby DB shard groups for the DB shard group. Valid values are the following:

\n
    \n
  • \n

    0 - Creates a DB shard group without a standby DB shard group. This is the default value.

    \n
    • \n
  • \n

    1 - Creates a DB shard group with a standby DB shard group in a different Availability Zone (AZ).

    \n
    • \n
  • \n

    2 - Creates a DB shard group with two standby DB shard groups in two different AZs.

    \n
    • \n
" + } + }, + "MaxACU": { + "target": "com.amazonaws.rds#DoubleOptional", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The maximum capacity of the DB shard group in Aurora capacity units (ACUs).

", + "smithy.api#required": {} + } + }, + "MinACU": { + "target": "com.amazonaws.rds#DoubleOptional", + "traits": { + "smithy.api#documentation": "

The minimum capacity of the DB shard group in Aurora capacity units (ACUs).

" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the DB shard group is publicly accessible.

\n

When the DB shard group is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from \n within the DB shard group's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB shard group's VPC. \n Access to the DB shard group is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB shard group doesn't permit it.

\n

When the DB shard group isn't publicly accessible, it is an internal DB shard group with a DNS name that resolves to a private IP address.

\n

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

\n

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

\n
    \n
  • \n

    If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB shard group is private.

    \n
    • \n
  • \n

    If the default VPC in the target Region has an internet gateway attached to it, the DB shard group is public.

    \n
    • \n
\n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n
    \n
  • \n

    If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB shard group is private.

    \n
    • \n
  • \n

    If the subnets are part of a VPC that has an internet gateway attached to it, the DB shard group is public.

    \n
    • \n
" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#CreateDBSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateDBSnapshotMessage" + }, + "output": { + "target": "com.amazonaws.rds#CreateDBSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSnapshotAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#SnapshotQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a snapshot of a DB instance. The source DB instance must be in the available or\n storage-optimization state.

", + "smithy.api#examples": [ + { + "title": "To create a DB snapshot", + "documentation": "The following example creates a DB snapshot.", + "input": { + "DBSnapshotIdentifier": "database-mysql", + "DBInstanceIdentifier": "mydbsnapshot" + }, + "output": { + "DBSnapshot": { + "DBSnapshotIdentifier": "mydbsnapshot", + "DBInstanceIdentifier": "database-mysql", + "Engine": "mysql", + "AllocatedStorage": 100, + "Status": "creating", + "Port": 3306, + "AvailabilityZone": "us-east-1b", + "VpcId": "vpc-6594f31c", + "InstanceCreateTime": "2019-04-30T15:45:53.663Z", + "MasterUsername": "admin", + "EngineVersion": "8.0.32", + "LicenseModel": "general-public-license", + "SnapshotType": "manual", + "Iops": 1000, + "OptionGroupName": "default:mysql-8-0", + "PercentProgress": 0, + "StorageType": "io1", + "Encrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", + "DBSnapshotArn": "arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshot", + "IAMDatabaseAuthenticationEnabled": false, + "ProcessorFeatures": [], + "DbiResourceId": "db-AKIAIOSFODNN7EXAMPLE" + } + } + } + ] + } + }, + "com.amazonaws.rds#CreateDBSnapshotMessage": { + "type": "structure", + "members": { + "DBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier for the DB snapshot.

\n

Constraints:

\n
    \n
  • \n

    Can't be null, empty, or blank

    \n
    • \n
  • \n

    Must contain from 1 to 255 letters, numbers, or hyphens

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
\n

Example: my-snapshot-id\n

", + "smithy.api#required": {} + } + }, + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier of the DB instance that you want to create the snapshot of.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DBInstance.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#CreateDBSnapshotResult": { + "type": "structure", + "members": { + "DBSnapshot": { + "target": "com.amazonaws.rds#DBSnapshot" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#CreateDBSubnetGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateDBSubnetGroupMessage" + }, + "output": { + "target": "com.amazonaws.rds#CreateDBSubnetGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBSubnetGroupAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#DBSubnetQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#InvalidSubnet" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.

", + "smithy.api#examples": [ + { + "title": "To create a DB subnet group", + "documentation": "The following example creates a DB subnet group called mysubnetgroup using existing subnets.", + "input": { + "DBSubnetGroupName": "mysubnetgroup", + "DBSubnetGroupDescription": "test DB subnet group", + "SubnetIds": [ + "subnet-0a1dc4e1a6f123456", + "subnet-070dd7ecb3aaaaaaa", + "subnet-00f5b198bc0abcdef" + ] + }, + "output": { + "DBSubnetGroup": { + "DBSubnetGroupName": "mysubnetgroup", + "DBSubnetGroupDescription": "test DB subnet group", + "VpcId": "vpc-0f08e7610a1b2c3d4", + "SubnetGroupStatus": "Complete", + "Subnets": [ + { + "SubnetIdentifier": "subnet-070dd7ecb3aaaaaaa", + "SubnetAvailabilityZone": { + "Name": "us-west-2b" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-00f5b198bc0abcdef", + "SubnetAvailabilityZone": { + "Name": "us-west-2d" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-0a1dc4e1a6f123456", + "SubnetAvailabilityZone": { + "Name": "us-west-2b" + }, + "SubnetStatus": "Active" + } + ], + "DBSubnetGroupArn": "arn:aws:rds:us-west-2:0123456789012:subgrp:mysubnetgroup" + } + } + } + ] + } + }, + "com.amazonaws.rds#CreateDBSubnetGroupMessage": { + "type": "structure", + "members": { + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name for the DB subnet group. This value is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens.

    \n
    • \n
  • \n

    Must not be default.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
\n

Example: mydbsubnetgroup\n

", + "smithy.api#required": {} + } + }, + "DBSubnetGroupDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The description for the DB subnet group.

", + "smithy.api#required": {} + } + }, + "SubnetIds": { + "target": "com.amazonaws.rds#SubnetIdentifierList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The EC2 Subnet IDs for the DB subnet group.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

Tags to assign to the DB subnet group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#CreateDBSubnetGroupResult": { + "type": "structure", + "members": { + "DBSubnetGroup": { + "target": "com.amazonaws.rds#DBSubnetGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#CreateEventSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateEventSubscriptionMessage" + }, + "output": { + "target": "com.amazonaws.rds#CreateEventSubscriptionResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#EventSubscriptionQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#SNSInvalidTopicFault" + }, + { + "target": "com.amazonaws.rds#SNSNoAuthorizationFault" + }, + { + "target": "com.amazonaws.rds#SNSTopicArnNotFoundFault" + }, + { + "target": "com.amazonaws.rds#SourceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#SubscriptionAlreadyExistFault" + }, + { + "target": "com.amazonaws.rds#SubscriptionCategoryNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an RDS event notification subscription. This operation requires a topic Amazon\n Resource Name (ARN) created by either the RDS console, the SNS console, or the SNS API.\n To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the\n topic. The ARN is displayed in the SNS console.

\n

You can specify the type of source (SourceType) that you want to be\n notified of and provide a list of RDS sources (SourceIds) that triggers the\n events. You can also provide a list of event categories (EventCategories)\n for events that you want to be notified of. For example, you can specify\n SourceType = db-instance, SourceIds =\n mydbinstance1, mydbinstance2 and\n EventCategories = Availability,\n Backup.

\n

If you specify both the SourceType and SourceIds, such as SourceType = db-instance\n and SourceIds = myDBInstance1, you are notified of all the db-instance events for\n the specified source. If you specify a SourceType but do not specify SourceIds,\n you receive notice of the events for that source type for all your RDS sources. If you\n don't specify either the SourceType or the SourceIds, you are notified of events\n generated from all RDS sources belonging to your customer account.

\n

For more information about subscribing to an event for RDS DB engines, see \n \n Subscribing to Amazon RDS event notification in the Amazon RDS User Guide.

\n

For more information about subscribing to an event for Aurora DB engines, see \n \n Subscribing to Amazon RDS event notification in the Amazon Aurora User Guide.

", + "smithy.api#examples": [ + { + "title": "To create an event subscription", + "documentation": "The following example creates a subscription for backup and recovery events for DB instances in the current AWS account. Notifications are sent to an Amazon Simple Notification Service topic.", + "input": { + "SubscriptionName": "my-instance-events", + "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events", + "SourceType": "db-instance", + "EventCategories": [ + "backup", + "recovery" + ] + }, + "output": { + "EventSubscription": { + "Status": "creating", + "CustSubscriptionId": "my-instance-events", + "SubscriptionCreationTime": "Tue Jul 31 23:22:01 UTC 2018", + "EventCategoriesList": [ + "backup", + "recovery" + ], + "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events", + "CustomerAwsId": "123456789012", + "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events", + "SourceType": "db-instance", + "Enabled": true + } + } + } + ] + } + }, + "com.amazonaws.rds#CreateEventSubscriptionMessage": { + "type": "structure", + "members": { + "SubscriptionName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the subscription.

\n

Constraints: The name must be less than 255 characters.

", + "smithy.api#required": {} + } + }, + "SnsTopicArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SNS topic created for event notification. SNS\n automatically creates the ARN when you create a topic and subscribe to it.

\n \n

RDS doesn't support FIFO (first in, first out) topics. For more information, see\n Message\n ordering and deduplication (FIFO topics) in the Amazon Simple\n Notification Service Developer Guide.

\n ", + "smithy.api#required": {} + } + }, + "SourceType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The type of source that is generating the events. For example, if you want to be\n notified of events generated by a DB instance, you set this parameter to\n db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are\n returned.

\n

Valid Values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy | zero-etl | custom-engine-version | blue-green-deployment \n

" + } + }, + "EventCategories": { + "target": "com.amazonaws.rds#EventCategoriesList", + "traits": { + "smithy.api#documentation": "

A list of event categories for a particular source type (SourceType)\n that you want to subscribe to. You can see a list of the categories for a given source type in the \"Amazon RDS event categories and event messages\" section of the \n Amazon RDS User Guide\n or the\n \n Amazon Aurora User Guide\n .\n You can also see this list by using the DescribeEventCategories operation.

" + } + }, + "SourceIds": { + "target": "com.amazonaws.rds#SourceIdsList", + "traits": { + "smithy.api#documentation": "

The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. \n An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens.

\n

Constraints:

\n
    \n
  • \n

    If SourceIds are supplied, SourceType must also be provided.

    \n
    • \n
  • \n

    If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB security group, a DBSecurityGroupName value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is an RDS Proxy, a DBProxyName value must be supplied.

    \n
    • \n
" + } + }, + "Enabled": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#CreateEventSubscriptionResult": { + "type": "structure", + "members": { + "EventSubscription": { + "target": "com.amazonaws.rds#EventSubscription" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#CreateGlobalCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateGlobalClusterMessage" + }, + "output": { + "target": "com.amazonaws.rds#CreateGlobalClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#GlobalClusterAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#GlobalClusterQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an Aurora global database\n spread across multiple Amazon Web Services Regions. The global database\n contains a single primary cluster with read-write capability,\n and a read-only secondary cluster that receives\n data from the primary cluster through high-speed replication\n performed by the Aurora storage subsystem.

\n

You can create a global database that is initially empty, and then \n create the primary and secondary DB clusters in the global database.\n Or you can specify an existing Aurora cluster during the create operation,\n and this cluster becomes the primary cluster of the global database.

\n \n

This operation applies only to Aurora DB clusters.

\n ", + "smithy.api#examples": [ + { + "title": "To create a global DB cluster", + "documentation": "The following example creates a new Aurora MySQL-compatible global DB cluster.", + "input": { + "GlobalClusterIdentifier": "myglobalcluster", + "Engine": "aurora-mysql" + }, + "output": { + "GlobalCluster": { + "GlobalClusterIdentifier": "myglobalcluster", + "GlobalClusterResourceId": "cluster-f0e523bfe07aabb", + "GlobalClusterArn": "arn:aws:rds::123456789012:global-cluster:myglobalcluster", + "Status": "available", + "Engine": "aurora-mysql", + "EngineVersion": "5.7.mysql_aurora.2.07.2", + "StorageEncrypted": false, + "DeletionProtection": false, + "GlobalClusterMembers": [] + } + } + } + ] + } + }, + "com.amazonaws.rds#CreateGlobalClusterMessage": { + "type": "structure", + "members": { + "GlobalClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The cluster identifier for this global database cluster. This parameter is stored as a lowercase string.

" + } + }, + "SourceDBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) to use as the primary cluster of the global database.

\n

If you provide a value for this parameter, don't specify values for the following settings because Amazon Aurora uses the values from the specified source DB cluster:

\n
    \n
  • \n

    \n DatabaseName\n

    \n
    • \n
  • \n

    \n Engine\n

    \n
    • \n
  • \n

    \n EngineVersion\n

    \n
    • \n
  • \n

    \n StorageEncrypted\n

    \n
    • \n
" + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The database engine to use for this global database cluster.

\n

Valid Values: aurora-mysql | aurora-postgresql\n

\n

Constraints:

\n
    \n
  • \n

    Can't be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the engine of the source DB cluster.

    \n
    • \n
" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The engine version to use for this global database cluster.

\n

Constraints:

\n
    \n
  • \n

    Can't be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the engine version of the source DB cluster.

    \n
    • \n
" + } + }, + "EngineLifecycleSupport": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The life cycle type for this global database cluster.

\n \n

By default, this value is set to open-source-rds-extended-support, which enrolls your global cluster into Amazon RDS Extended Support. \n At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, \n creating the global cluster will fail if the DB major version is past its end of standard support date.

\n \n

This setting only applies to Aurora PostgreSQL-based global databases.

\n

You can use this setting to enroll your global cluster into Amazon RDS Extended Support. With RDS Extended Support, \n you can run the selected major engine version on your global cluster past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon Aurora User Guide.

\n

Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled\n

\n

Default: open-source-rds-extended-support\n

" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable deletion protection for the new global database cluster.\n The global database can't be deleted when deletion protection is enabled.

" + } + }, + "DatabaseName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name for your database of up to 64 alphanumeric characters. If you don't specify\n a name, Amazon Aurora doesn't create a database in the global database cluster.

\n

Constraints:

\n
    \n
  • \n

    Can't be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the database name from the source DB cluster.

    \n
    • \n
" + } + }, + "StorageEncrypted": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable storage encryption for the new global database cluster.

\n

Constraints:

\n
    \n
  • \n

    Can't be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the setting from the source DB cluster.

    \n
    • \n
" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

Tags to assign to the global cluster.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#CreateGlobalClusterResult": { + "type": "structure", + "members": { + "GlobalCluster": { + "target": "com.amazonaws.rds#GlobalCluster" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#CreateIntegration": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateIntegrationMessage" + }, + "output": { + "target": "com.amazonaws.rds#Integration" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#IntegrationAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#IntegrationConflictOperationFault" + }, + { + "target": "com.amazonaws.rds#IntegrationQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a zero-ETL integration with Amazon Redshift.

", + "smithy.api#examples": [ + { + "title": "To create a zero-ETL integration", + "documentation": "The following example creates a zero-ETL integration with Amazon Redshift.", + "input": { + "IntegrationName": "my-integration", + "SourceArn": "arn:aws:rds:us-east-1:123456789012:cluster:my-cluster", + "TargetArn": "arn:aws:redshift-serverless:us-east-1:123456789012:namespace/62c70612-0302-4db7-8414-b5e3e049f0d8" + }, + "output": { + "IntegrationName": "my-integration", + "IntegrationArn": "arn:aws:rds:us-east-1:123456789012:integration:5b9f3d79-7392-4a3e-896c-58eaa1b53231", + "SourceArn": "arn:aws:rds:us-east-1:123456789012:cluster:my-cluster", + "TargetArn": "arn:aws:redshift-serverless:us-east-1:123456789012:namespace/62c70612-0302-4db7-8414-b5e3e049f0d8", + "Tags": [], + "CreateTime": "2023-12-28T17:20:20.629Z", + "KMSKeyId": "arn:aws:kms:us-east-1:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa", + "Status": "creating" + } + } + ] + } + }, + "com.amazonaws.rds#CreateIntegrationMessage": { + "type": "structure", + "members": { + "SourceArn": { + "target": "com.amazonaws.rds#SourceArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the database to use as the source for\n replication.

", + "smithy.api#required": {} + } + }, + "TargetArn": { + "target": "com.amazonaws.rds#Arn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the Redshift data warehouse to use as the target for replication.

", + "smithy.api#required": {} + } + }, + "IntegrationName": { + "target": "com.amazonaws.rds#IntegrationName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the integration.

", + "smithy.api#required": {} + } + }, + "KMSKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to\n encrypt the integration. If you don't specify an encryption key, RDS uses a default\n Amazon Web Services owned key.

" + } + }, + "AdditionalEncryptionContext": { + "target": "com.amazonaws.rds#EncryptionContextMap", + "traits": { + "smithy.api#documentation": "

An optional set of non-secret key–value pairs that contains additional contextual\n information about the data. For more information, see Encryption\n context in the Amazon Web Services Key Management Service Developer\n Guide.

\n

You can only include this parameter if you specify the KMSKeyId parameter.

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + }, + "DataFilter": { + "target": "com.amazonaws.rds#DataFilter", + "traits": { + "smithy.api#documentation": "

Data filtering options for the integration. For more information, see \n Data filtering for Aurora zero-ETL integrations with Amazon Redshift.\n

\n

Valid for: Integrations with Aurora MySQL source DB clusters only

" + } + }, + "Description": { + "target": "com.amazonaws.rds#IntegrationDescription", + "traits": { + "smithy.api#documentation": "

A description of the integration.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#CreateOptionGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateOptionGroupMessage" + }, + "output": { + "target": "com.amazonaws.rds#CreateOptionGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#OptionGroupAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#OptionGroupQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new option group. You can create up to 20 option groups.

\n

This command doesn't apply to RDS Custom.

", + "smithy.api#examples": [ + { + "title": "To Create an Amazon RDS option group", + "documentation": "The following example creates a new Amazon RDS option group for Oracle MySQL version 8,0 named MyOptionGroup.", + "input": { + "OptionGroupName": "MyOptionGroup", + "EngineName": "mysql", + "MajorEngineVersion": "8.0", + "OptionGroupDescription": "MySQL 8.0 option group" + }, + "output": { + "OptionGroup": { + "OptionGroupName": "myoptiongroup", + "OptionGroupDescription": "MySQL 8.0 option group", + "EngineName": "mysql", + "MajorEngineVersion": "8.0", + "Options": [], + "AllowsVpcAndNonVpcInstanceMemberships": true, + "OptionGroupArn": "arn:aws:rds:us-east-1:123456789012:og:myoptiongroup" + } + } + } + ] + } + }, + "com.amazonaws.rds#CreateOptionGroupMessage": { + "type": "structure", + "members": { + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies the name of the option group to be created.

\n

Constraints:

\n
    \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
\n

Example: myoptiongroup\n

", + "smithy.api#required": {} + } + }, + "EngineName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the engine to associate this option group with.

\n

Valid Values:

\n
    \n
  • \n

    \n db2-ae\n

    \n
    • \n
  • \n

    \n db2-se\n

    \n
    • \n
  • \n

    \n mariadb\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n oracle-ee\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n oracle-se2\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
  • \n

    \n sqlserver-ee\n

    \n
    • \n
  • \n

    \n sqlserver-se\n

    \n
    • \n
  • \n

    \n sqlserver-ex\n

    \n
    • \n
  • \n

    \n sqlserver-web\n

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "MajorEngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies the major version of the engine that this option group should be associated with.

", + "smithy.api#required": {} + } + }, + "OptionGroupDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The description of the option group.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

Tags to assign to the option group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#CreateOptionGroupResult": { + "type": "structure", + "members": { + "OptionGroup": { + "target": "com.amazonaws.rds#OptionGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#CreateTenantDatabase": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateTenantDatabaseMessage" + }, + "output": { + "target": "com.amazonaws.rds#CreateTenantDatabaseResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#TenantDatabaseAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#TenantDatabaseQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a tenant database in a DB instance that uses the multi-tenant configuration.\n Only RDS for Oracle container database (CDB) instances are supported.

" + } + }, + "com.amazonaws.rds#CreateTenantDatabaseMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The user-supplied DB instance identifier. RDS creates your tenant database in this DB\n instance. This parameter isn't case-sensitive.

", + "smithy.api#required": {} + } + }, + "TenantDBName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The user-supplied name of the tenant database that you want to create in your DB\n instance. This parameter has the same constraints as DBName in\n CreateDBInstance.

", + "smithy.api#required": {} + } + }, + "MasterUsername": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name for the master user account in your tenant database. RDS creates this user\n account in the tenant database and grants privileges to the master user. This parameter\n is case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must be 1 to 16 letters, numbers, or underscores.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't be a reserved word for the chosen database engine.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "MasterUserPassword": { + "target": "com.amazonaws.rds#SensitiveString", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The password for the master user in your tenant database.

\n

Constraints:

\n
    \n
  • \n

    Must be 8 to 30 characters.

    \n
    • \n
  • \n

    Can include any printable ASCII character except forward slash\n (/), double quote (\"), at symbol (@),\n ampersand (&), or single quote (').

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "CharacterSetName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The character set for your tenant database. If you don't specify a value, the\n character set name defaults to AL32UTF8.

" + } + }, + "NcharCharacterSetName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The NCHAR value for the tenant database.

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#CreateTenantDatabaseResult": { + "type": "structure", + "members": { + "TenantDatabase": { + "target": "com.amazonaws.rds#TenantDatabase" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#CustomAvailabilityZoneNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "CustomAvailabilityZoneNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

\n CustomAvailabilityZoneId doesn't refer to an existing custom\n Availability Zone identifier.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#CustomDBEngineVersionAMI": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A value that indicates the ID of the AMI.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A value that indicates the status of a custom engine version (CEV).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A value that indicates the AMI information.

" + } + }, + "com.amazonaws.rds#CustomDBEngineVersionAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "CustomDBEngineVersionAlreadyExistsFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

A CEV with the specified name already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#CustomDBEngineVersionManifest": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 51000 + }, + "smithy.api#pattern": "^[\\s\\S]*$" + } + }, + "com.amazonaws.rds#CustomDBEngineVersionNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "CustomDBEngineVersionNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified CEV was not found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#CustomDBEngineVersionQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "CustomDBEngineVersionQuotaExceededFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

You have exceeded your CEV quota.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#CustomEngineName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 35 + }, + "smithy.api#pattern": "^[A-Za-z0-9-]{1,35}$" + } + }, + "com.amazonaws.rds#CustomEngineVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 60 + }, + "smithy.api#pattern": "^[a-z0-9_.-]{1,60}$" + } + }, + "com.amazonaws.rds#CustomEngineVersionStatus": { + "type": "enum", + "members": { + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "inactive": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "inactive" + } + }, + "inactive_except_restore": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "inactive-except-restore" + } + } + } + }, + "com.amazonaws.rds#DBCluster": { + "type": "structure", + "members": { + "AllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). \n For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically\n adjusts as needed.

" + } + }, + "AvailabilityZones": { + "target": "com.amazonaws.rds#AvailabilityZones", + "traits": { + "smithy.api#documentation": "

The list of Availability Zones (AZs) where instances in the DB cluster can be created.

" + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days for which automatic DB snapshots are retained.

" + } + }, + "CharacterSetName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

If present, specifies the name of the character set that this cluster is associated with.

" + } + }, + "DatabaseName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the initial database that was specified for the DB cluster when it was created, if one was provided. This same name is returned for the life of the DB cluster.

" + } + }, + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The user-supplied identifier for the DB cluster. This identifier is the unique key that identifies a DB cluster.

" + } + }, + "DBClusterParameterGroup": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB cluster parameter group for the DB cluster.

" + } + }, + "DBSubnetGroup": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Information about the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The current state of this DB cluster.

" + } + }, + "AutomaticRestartTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The time when a stopped DB cluster is restarted automatically.

" + } + }, + "PercentProgress": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The progress of the operation as a percentage.

" + } + }, + "EarliestRestorableTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The earliest time to which a database can be restored with point-in-time\n restore.

" + } + }, + "Endpoint": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The connection endpoint for the primary instance of the DB cluster.

" + } + }, + "ReaderEndpoint": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances \n connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections \n to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. \n This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.

\n

If a failover occurs, and the Aurora Replica that you are connected to is promoted \n to be the primary instance, your connection is dropped. To \n continue sending your read workload to other Aurora Replicas in the cluster,\n you can then reconnect to the reader endpoint.

" + } + }, + "CustomEndpoints": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The custom endpoints associated with the DB cluster.

" + } + }, + "MultiAZ": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether the DB cluster has instances in multiple Availability Zones.

" + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The database engine used for this DB cluster.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version of the database engine.

" + } + }, + "LatestRestorableTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The latest time to which a database can be restored with point-in-time restore.

" + } + }, + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port that the database engine is listening on.

" + } + }, + "MasterUsername": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The master username for the DB cluster.

" + } + }, + "DBClusterOptionGroupMemberships": { + "target": "com.amazonaws.rds#DBClusterOptionGroupMemberships", + "traits": { + "smithy.api#documentation": "

The list of option group memberships for this DB cluster.

" + } + }, + "PreferredBackupWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The daily time range during which automated backups are\n created if automated backups are enabled, as determined\n by the BackupRetentionPeriod.

" + } + }, + "PreferredMaintenanceWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

" + } + }, + "ReplicationSourceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the source DB cluster if this DB cluster is a read\n replica.

" + } + }, + "ReadReplicaIdentifiers": { + "target": "com.amazonaws.rds#ReadReplicaIdentifierList", + "traits": { + "smithy.api#documentation": "

Contains one or more identifiers of the read replicas associated with this DB\n cluster.

" + } + }, + "StatusInfos": { + "target": "com.amazonaws.rds#DBClusterStatusInfoList", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

" + } + }, + "DBClusterMembers": { + "target": "com.amazonaws.rds#DBClusterMemberList", + "traits": { + "smithy.api#documentation": "

The list of DB instances that make up the DB cluster.

" + } + }, + "VpcSecurityGroups": { + "target": "com.amazonaws.rds#VpcSecurityGroupMembershipList", + "traits": { + "smithy.api#documentation": "

The list of VPC security groups that the DB cluster belongs to.

" + } + }, + "HostedZoneId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ID that Amazon Route 53 assigns when you create a hosted zone.

" + } + }, + "StorageEncrypted": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the DB cluster is encrypted.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" + } + }, + "DbClusterResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever \n the KMS key for the DB cluster is accessed.

" + } + }, + "DBClusterArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB cluster.

" + } + }, + "AssociatedRoles": { + "target": "com.amazonaws.rds#DBClusterRoles", + "traits": { + "smithy.api#documentation": "

A list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. \n IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services\n on your behalf.

" + } + }, + "IAMDatabaseAuthenticationEnabled": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

" + } + }, + "CloneGroupId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ID of the clone group with which the DB cluster is associated.

" + } + }, + "ClusterCreateTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The time when the DB cluster was created, in Universal Coordinated Time (UTC).

" + } + }, + "EarliestBacktrackTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The earliest time to which a DB cluster can be backtracked.

" + } + }, + "BacktrackWindow": { + "target": "com.amazonaws.rds#LongOptional", + "traits": { + "smithy.api#documentation": "

The target backtrack window, in seconds. If this value is set to 0, backtracking is\n disabled for the DB cluster. Otherwise, backtracking is enabled.

" + } + }, + "BacktrackConsumedChangeRecords": { + "target": "com.amazonaws.rds#LongOptional", + "traits": { + "smithy.api#documentation": "

The number of change records stored for Backtrack.

" + } + }, + "EnabledCloudwatchLogsExports": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

A list of log types that this DB cluster is configured to export to CloudWatch Logs.

\n

Log types vary by DB engine. For information about the log types for each DB engine, see\n Amazon RDS Database Log Files in the Amazon Aurora User Guide.\n

" + } + }, + "Capacity": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) \n when the cluster is paused.

\n

For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the \n Amazon Aurora User Guide.

" + } + }, + "EngineMode": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB engine mode of the DB cluster, either provisioned or serverless.

\n

For more information, see \n CreateDBCluster.

" + } + }, + "ScalingConfigurationInfo": { + "target": "com.amazonaws.rds#ScalingConfigurationInfo" + }, + "RdsCustomClusterConfiguration": { + "target": "com.amazonaws.rds#RdsCustomClusterConfiguration", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether the DB cluster has deletion protection enabled.\n The database can't be deleted when deletion protection is enabled.

" + } + }, + "HttpEndpointEnabled": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether the HTTP endpoint is enabled for an Aurora DB cluster.

\n

When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running\n SQL queries on the DB cluster. You can also query your database\n from inside the RDS console with the RDS query editor.

\n

For more information, see Using RDS Data API in the \n Amazon Aurora User Guide.

" + } + }, + "ActivityStreamMode": { + "target": "com.amazonaws.rds#ActivityStreamMode", + "traits": { + "smithy.api#documentation": "

The mode of the database activity stream.\n Database events such as a change or access generate an activity stream event.\n The database session can handle these events either synchronously or asynchronously.

" + } + }, + "ActivityStreamStatus": { + "target": "com.amazonaws.rds#ActivityStreamStatus", + "traits": { + "smithy.api#documentation": "

The status of the database activity stream.

" + } + }, + "ActivityStreamKmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" + } + }, + "ActivityStreamKinesisStreamName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Kinesis data stream used for the database activity stream.

" + } + }, + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.

" + } + }, + "CrossAccountClone": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.

" + } + }, + "DomainMemberships": { + "target": "com.amazonaws.rds#DomainMembershipList", + "traits": { + "smithy.api#documentation": "

The Active Directory Domain membership records associated with the DB cluster.

" + } + }, + "TagList": { + "target": "com.amazonaws.rds#TagList" + }, + "GlobalWriteForwardingStatus": { + "target": "com.amazonaws.rds#WriteForwardingStatus", + "traits": { + "smithy.api#documentation": "

The status of write forwarding for a secondary cluster in an Aurora global database.

" + } + }, + "GlobalWriteForwardingRequested": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether write forwarding is enabled for a secondary cluster\n in an Aurora global database. Because write forwarding takes time to enable, check the\n value of GlobalWriteForwardingStatus to confirm that the request has completed\n before using the write forwarding feature for this cluster.

" + } + }, + "PendingModifiedValues": { + "target": "com.amazonaws.rds#ClusterPendingModifiedValues", + "traits": { + "smithy.api#documentation": "

Information about pending changes to the DB cluster. This information is returned only when there are pending changes. Specific changes are identified by subelements.

" + } + }, + "DBClusterInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the compute and memory capacity class of the DB instance.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The storage type associated with the DB cluster.

" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The Provisioned IOPS (I/O operations per second) value.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether the DB cluster is publicly accessible.

\n

When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), \n its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, \n the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit it.

\n

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBCluster.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether minor version patches are applied automatically.

\n

This setting is for Aurora DB clusters and Multi-AZ DB clusters.

" + } + }, + "MonitoringInterval": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.

\n

This setting is only for -Aurora DB clusters and Multi-AZ DB clusters.

" + } + }, + "MonitoringRoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

\n

This setting is only for Aurora DB clusters and Multi-AZ DB clusters.

" + } + }, + "DatabaseInsightsMode": { + "target": "com.amazonaws.rds#DatabaseInsightsMode", + "traits": { + "smithy.api#documentation": "

The mode of Database Insights that is enabled for the DB cluster.

" + } + }, + "PerformanceInsightsEnabled": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether Performance Insights is enabled for the DB cluster.

\n

This setting is only for Aurora DB clusters and Multi-AZ DB clusters.

" + } + }, + "PerformanceInsightsKMSKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

This setting is only for Aurora DB clusters and Multi-AZ DB clusters.

" + } + }, + "PerformanceInsightsRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days to retain Performance Insights data.

\n

This setting is only for Aurora DB clusters and Multi-AZ DB clusters.

\n

Valid Values:

\n
    \n
  • \n

    \n 7\n

    \n
    • \n
  • \n

    \n month * 31, where month is a number of months from 1-23. \n Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)

    \n
    • \n
  • \n

    \n 731\n

    \n
    • \n
\n

Default: 7 days

" + } + }, + "ServerlessV2ScalingConfiguration": { + "target": "com.amazonaws.rds#ServerlessV2ScalingConfigurationInfo" + }, + "NetworkType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The network type of the DB instance.

\n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

This setting is only for Aurora DB clusters.

\n

Valid Values: IPV4 | DUAL\n

" + } + }, + "DBSystemId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

" + } + }, + "MasterUserSecret": { + "target": "com.amazonaws.rds#MasterUserSecret", + "traits": { + "smithy.api#documentation": "

The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n

" + } + }, + "IOOptimizedNextAllowedModificationTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The next time you can modify the DB cluster to use the aurora-iopt1 storage type.

\n

This setting is only for Aurora DB clusters.

" + } + }, + "LocalWriteForwardingStatus": { + "target": "com.amazonaws.rds#LocalWriteForwardingStatus", + "traits": { + "smithy.api#documentation": "

Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process \n of enabling it.

" + } + }, + "AwsBackupRecoveryPointArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

" + } + }, + "LimitlessDatabase": { + "target": "com.amazonaws.rds#LimitlessDatabase", + "traits": { + "smithy.api#documentation": "

The details for Aurora Limitless Database.

" + } + }, + "StorageThroughput": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The storage throughput for the DB cluster. The throughput is automatically set based on the IOPS that you provision, and is not configurable.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" + } + }, + "ClusterScalabilityType": { + "target": "com.amazonaws.rds#ClusterScalabilityType", + "traits": { + "smithy.api#documentation": "

The scalability mode of the Aurora DB cluster. When set to limitless, the cluster operates as an Aurora Limitless Database.\n When set to standard (the default), the cluster uses normal DB instance creation.

" + } + }, + "CertificateDetails": { + "target": "com.amazonaws.rds#CertificateDetails" + }, + "EngineLifecycleSupport": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The life cycle type for the DB cluster.

\n

For more information, see CreateDBCluster.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.

\n

For an Amazon Aurora DB cluster, this data type is used as a response element in the operations \n CreateDBCluster, DeleteDBCluster, DescribeDBClusters, \n FailoverDBCluster, ModifyDBCluster, PromoteReadReplicaDBCluster, \n RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot, \n RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster.

\n

For a Multi-AZ DB cluster, this data type is used as a response element in the operations \n CreateDBCluster, DeleteDBCluster, DescribeDBClusters, \n FailoverDBCluster, ModifyDBCluster, RebootDBCluster, \n RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" + } + }, + "com.amazonaws.rds#DBClusterAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterAlreadyExistsFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The user already has a DB cluster with the given identifier.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBClusterAutomatedBackup": { + "type": "structure", + "members": { + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the database engine for this automated backup.

" + } + }, + "VpcId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The VPC ID associated with the DB cluster.

" + } + }, + "DBClusterAutomatedBackupsArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the automated backups.

" + } + }, + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region.

" + } + }, + "RestoreWindow": { + "target": "com.amazonaws.rds#RestoreWindow" + }, + "MasterUsername": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The master user name of the automated backup.

" + } + }, + "DbClusterResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The resource ID for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region.

" + } + }, + "Region": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region associated with the automated backup.

" + } + }, + "LicenseModel": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The license model information for this DB cluster automated backup.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A list of status information for an automated backup:

\n
    \n
  • \n

    \n retained - Automated backups for deleted clusters.

    \n
    • \n
" + } + }, + "IAMDatabaseAuthenticationEnabled": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

" + } + }, + "ClusterCreateTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The time when the DB cluster was created, in Universal Coordinated Time (UTC).

" + } + }, + "StorageEncrypted": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the source DB cluster is encrypted.

" + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#documentation": "

For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). \n For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically\n adjusts as needed.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version of the database engine for the automated backup.

" + } + }, + "DBClusterArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the source DB cluster.

" + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The retention period for the automated backups.

" + } + }, + "EngineMode": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The engine mode of the database engine for the automated backup.

" + } + }, + "AvailabilityZones": { + "target": "com.amazonaws.rds#AvailabilityZones", + "traits": { + "smithy.api#documentation": "

The Availability Zones where instances in the DB cluster can be created. For information on\n Amazon Web Services Regions and Availability Zones, see \n Regions\n and Availability Zones.

" + } + }, + "Port": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#documentation": "

The port number that the automated backup used for connections.

\n

Default: Inherits from the source DB cluster

\n

Valid Values: 1150-65535\n

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key ID for an automated backup.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The storage type associated with the DB cluster.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The IOPS (I/O operations per second) value for the automated backup.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" + } + }, + "AwsBackupRecoveryPointArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

" + } + }, + "StorageThroughput": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The storage throughput for the automated backup. The throughput is automatically set based on the IOPS that you provision, and is not configurable.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An automated backup of a DB cluster. It consists of system backups, transaction logs, and the database cluster \n properties that existed at the time you deleted the source cluster.

" + } + }, + "com.amazonaws.rds#DBClusterAutomatedBackupList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBClusterAutomatedBackup", + "traits": { + "smithy.api#xmlName": "DBClusterAutomatedBackup" + } + } + }, + "com.amazonaws.rds#DBClusterAutomatedBackupMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The pagination token provided in the previous request. If this parameter is specified the response includes only \n records beyond the marker, up to MaxRecords.

" + } + }, + "DBClusterAutomatedBackups": { + "target": "com.amazonaws.rds#DBClusterAutomatedBackupList", + "traits": { + "smithy.api#documentation": "

A list of DBClusterAutomatedBackup backups.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DBClusterAutomatedBackupNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterAutomatedBackupNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

No automated backup for this DB cluster was found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBClusterAutomatedBackupQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterAutomatedBackupQuotaExceededFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The quota for retained automated backups was exceeded. This prevents you from retaining any additional automated \n backups. The retained automated backups quota is the same as your DB cluster quota.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBClusterBacktrack": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

" + } + }, + "BacktrackIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Contains the backtrack identifier.

" + } + }, + "BacktrackTo": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The timestamp of the time to which the DB cluster was backtracked.

" + } + }, + "BacktrackedFrom": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The timestamp of the time from which the DB cluster was backtracked.

" + } + }, + "BacktrackRequestCreationTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The timestamp of the time at which the backtrack was requested.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The status of the backtrack. This property returns one of the following\n values:

\n
    \n
  • \n

    \n applying - The backtrack is currently being applied to or rolled back from the DB cluster.

    \n
    • \n
  • \n

    \n completed - The backtrack has successfully been applied to or rolled back from the DB cluster.

    \n
    • \n
  • \n

    \n failed - An error occurred while the backtrack was applied to or rolled back from the DB cluster.

    \n
    • \n
  • \n

    \n pending - The backtrack is currently pending application to or rollback from the DB cluster.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a response element in the DescribeDBClusterBacktracks action.

" + } + }, + "com.amazonaws.rds#DBClusterBacktrackList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBClusterBacktrack", + "traits": { + "smithy.api#xmlName": "DBClusterBacktrack" + } + } + }, + "com.amazonaws.rds#DBClusterBacktrackMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a later DescribeDBClusterBacktracks request.

" + } + }, + "DBClusterBacktracks": { + "target": "com.amazonaws.rds#DBClusterBacktrackList", + "traits": { + "smithy.api#documentation": "

Contains a list of backtracks for the user.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBClusterBacktracks action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DBClusterBacktrackNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterBacktrackNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

\n BacktrackIdentifier doesn't refer to an existing backtrack.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBClusterCapacityInfo": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A user-supplied DB cluster identifier. This identifier is the unique key that\n identifies a DB cluster.

" + } + }, + "PendingCapacity": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

A value that specifies the capacity that the DB cluster scales to next.

" + } + }, + "CurrentCapacity": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The current capacity of the DB cluster.

" + } + }, + "SecondsBeforeTimeout": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of seconds before a call to ModifyCurrentDBClusterCapacity times out.

" + } + }, + "TimeoutAction": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The timeout action of a call to ModifyCurrentDBClusterCapacity, either \n ForceApplyCapacityChange or RollbackCapacityChange.

" + } + } + } + }, + "com.amazonaws.rds#DBClusterEndpoint": { + "type": "structure", + "members": { + "DBClusterEndpointIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier associated with the endpoint. This parameter is stored as a lowercase string.

" + } + }, + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is\n stored as a lowercase string.

" + } + }, + "DBClusterEndpointResourceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.

" + } + }, + "Endpoint": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DNS address of the endpoint.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that can't be used for a certain kind of cluster,\n such as a writer endpoint for a read-only secondary cluster in a global database.

" + } + }, + "EndpointType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The type of the endpoint. One of: READER, WRITER, CUSTOM.

" + } + }, + "CustomEndpointType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The type associated with a custom endpoint. One of: READER,\n WRITER, ANY.

" + } + }, + "StaticMembers": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

List of DB instance identifiers that are part of the custom endpoint group.

" + } + }, + "ExcludedMembers": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

List of DB instance identifiers that aren't part of the custom endpoint group.\n All other eligible instances are reachable through the custom endpoint.\n Only relevant if the list of static members is empty.

" + } + }, + "DBClusterEndpointArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the endpoint.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type represents the information you need to connect to an Amazon Aurora DB cluster.\n This data type is used as a response element in the following actions:

\n
    \n
  • \n

    \n CreateDBClusterEndpoint\n

    \n
    • \n
  • \n

    \n DescribeDBClusterEndpoints\n

    \n
    • \n
  • \n

    \n ModifyDBClusterEndpoint\n

    \n
    • \n
  • \n

    \n DeleteDBClusterEndpoint\n

    \n
    • \n
\n

For the data structure that represents Amazon RDS DB instance endpoints,\n see Endpoint.

" + } + }, + "com.amazonaws.rds#DBClusterEndpointAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterEndpointAlreadyExistsFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The specified custom endpoint can't be created because it already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBClusterEndpointList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBClusterEndpoint", + "traits": { + "smithy.api#xmlName": "DBClusterEndpointList" + } + } + }, + "com.amazonaws.rds#DBClusterEndpointMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterEndpoints request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "DBClusterEndpoints": { + "target": "com.amazonaws.rds#DBClusterEndpointList", + "traits": { + "smithy.api#documentation": "

Contains the details of the endpoints associated with the cluster\n and matching any filter conditions.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DBClusterEndpointNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterEndpointNotFoundFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The specified custom endpoint doesn't exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBClusterEndpointQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterEndpointQuotaExceededFault", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "

The cluster already has the maximum number of custom endpoints.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.rds#DBClusterIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[A-Za-z][0-9A-Za-z-:._]*$" + } + }, + "com.amazonaws.rds#DBClusterList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBCluster", + "traits": { + "smithy.api#xmlName": "DBCluster" + } + } + }, + "com.amazonaws.rds#DBClusterMember": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the instance identifier for this member of the DB cluster.

" + } + }, + "IsClusterWriter": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the cluster member is the primary DB instance for the DB cluster.

" + } + }, + "DBClusterParameterGroupStatus": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the status of the DB cluster parameter group for this member of the DB cluster.

" + } + }, + "PromotionTier": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

A value that specifies the order in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about an instance that is part of a DB cluster.

" + } + }, + "com.amazonaws.rds#DBClusterMemberList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBClusterMember", + "traits": { + "smithy.api#xmlName": "DBClusterMember" + } + } + }, + "com.amazonaws.rds#DBClusterMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a later DescribeDBClusters request.

" + } + }, + "DBClusters": { + "target": "com.amazonaws.rds#DBClusterList", + "traits": { + "smithy.api#documentation": "

Contains a list of DB clusters for the user.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBClusters action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DBClusterNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

\n DBClusterIdentifier doesn't refer to an existing DB cluster.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBClusterOptionGroupMemberships": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBClusterOptionGroupStatus", + "traits": { + "smithy.api#xmlName": "DBClusterOptionGroup" + } + } + }, + "com.amazonaws.rds#DBClusterOptionGroupStatus": { + "type": "structure", + "members": { + "DBClusterOptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the DB cluster option group.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the status of the DB cluster option group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains status information for a DB cluster option group.

" + } + }, + "com.amazonaws.rds#DBClusterParameterGroup": { + "type": "structure", + "members": { + "DBClusterParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB cluster parameter group.

" + } + }, + "DBParameterGroupFamily": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group family that this DB cluster parameter group is compatible with.

" + } + }, + "Description": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the customer-specified description for this DB cluster parameter group.

" + } + }, + "DBClusterParameterGroupArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB cluster parameter group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details of an Amazon RDS DB cluster parameter group.

\n

This data type is used as a response element in the DescribeDBClusterParameterGroups action.

" + } + }, + "com.amazonaws.rds#DBClusterParameterGroupDetails": { + "type": "structure", + "members": { + "Parameters": { + "target": "com.amazonaws.rds#ParametersList", + "traits": { + "smithy.api#documentation": "

Provides a list of parameters for the DB cluster parameter group.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details about a DB cluster parameter group including the parameters in the DB cluster parameter group.

" + } + }, + "com.amazonaws.rds#DBClusterParameterGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBClusterParameterGroup", + "traits": { + "smithy.api#xmlName": "DBClusterParameterGroup" + } + } + }, + "com.amazonaws.rds#DBClusterParameterGroupNameMessage": { + "type": "structure", + "members": { + "DBClusterParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB cluster parameter group.

\n

Constraints:

\n
    \n
  • \n

    Must be 1 to 255 letters or numbers.

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
\n \n

This value is stored as a lowercase string.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#DBClusterParameterGroupNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterParameterGroupNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

\n DBClusterParameterGroupName doesn't refer to an existing DB\n cluster parameter group.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBClusterParameterGroupsMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterParameterGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "DBClusterParameterGroups": { + "target": "com.amazonaws.rds#DBClusterParameterGroupList", + "traits": { + "smithy.api#documentation": "

A list of DB cluster parameter groups.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DBClusterQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterQuotaExceededFault", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "

The user attempted to create a new DB cluster and the user has already reached the\n maximum allowed DB cluster quota.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.rds#DBClusterRole": { + "type": "structure", + "members": { + "RoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following\n values:

\n
    \n
  • \n

    \n ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to\n access other Amazon Web Services on your behalf.

    \n
    • \n
  • \n

    \n PENDING - the IAM role ARN is being associated with the DB cluster.

    \n
    • \n
  • \n

    \n INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable\n to assume the IAM role in order to access other Amazon Web Services on your behalf.

    \n
    • \n
" + } + }, + "FeatureName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role.\n For information about supported feature names, see DBEngineVersion.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB cluster.

" + } + }, + "com.amazonaws.rds#DBClusterRoleAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterRoleAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The specified IAM role Amazon Resource Name (ARN) is already associated with the specified DB cluster.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBClusterRoleNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterRoleNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified IAM role Amazon Resource Name (ARN) isn't associated with the specified DB cluster.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBClusterRoleQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterRoleQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

You have exceeded the maximum number of IAM roles that can be associated with the specified DB cluster.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBClusterRoles": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBClusterRole", + "traits": { + "smithy.api#xmlName": "DBClusterRole" + } + } + }, + "com.amazonaws.rds#DBClusterSnapshot": { + "type": "structure", + "members": { + "AvailabilityZones": { + "target": "com.amazonaws.rds#AvailabilityZones", + "traits": { + "smithy.api#documentation": "

The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.

" + } + }, + "DBClusterSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the DB cluster snapshot.

" + } + }, + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.

" + } + }, + "SnapshotCreateTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The time when the snapshot was taken, in Universal Coordinated Time (UTC).

" + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the database engine for this DB cluster snapshot.

" + } + }, + "EngineMode": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The engine mode of the database engine for this DB cluster snapshot.

" + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#documentation": "

The allocated storage size of the DB cluster snapshot in gibibytes (GiB).

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The status of this DB cluster snapshot. Valid statuses are the following:

\n
    \n
  • \n

    \n available\n

    \n
    • \n
  • \n

    \n copying\n

    \n
    • \n
  • \n

    \n creating\n

    \n
    • \n
" + } + }, + "Port": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#documentation": "

The port that the DB cluster was listening on at the time of the snapshot.

" + } + }, + "VpcId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The VPC ID associated with the DB cluster snapshot.

" + } + }, + "ClusterCreateTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The time when the DB cluster was created, in Universal Coordinated Time (UTC).

" + } + }, + "MasterUsername": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The master username for this DB cluster snapshot.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version of the database engine for this DB cluster snapshot.

" + } + }, + "LicenseModel": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The license model information for this DB cluster snapshot.

" + } + }, + "SnapshotType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The type of the DB cluster snapshot.

" + } + }, + "PercentProgress": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#documentation": "

The percentage of the estimated data that has been transferred.

" + } + }, + "StorageEncrypted": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the DB cluster snapshot is encrypted.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" + } + }, + "DBClusterSnapshotArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB cluster snapshot.

" + } + }, + "SourceDBClusterSnapshotArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon\n Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.

" + } + }, + "IAMDatabaseAuthenticationEnabled": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

" + } + }, + "TagList": { + "target": "com.amazonaws.rds#TagList" + }, + "DBSystemId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The storage type associated with the DB cluster snapshot.

\n

This setting is only for Aurora DB clusters.

" + } + }, + "DbClusterResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The resource ID of the DB cluster that this DB cluster snapshot was created from.

" + } + }, + "StorageThroughput": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The storage throughput for the DB cluster snapshot. The throughput is automatically set based on the IOPS that you provision, and is not configurable.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details for an Amazon RDS DB cluster snapshot

\n

This data type is used as a response element \n in the DescribeDBClusterSnapshots action.

" + } + }, + "com.amazonaws.rds#DBClusterSnapshotAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterSnapshotAlreadyExistsFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The user already has a DB cluster snapshot with the given identifier.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBClusterSnapshotAttribute": { + "type": "structure", + "members": { + "AttributeName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the manual DB cluster snapshot attribute.

\n

The attribute named restore refers to the list of Amazon Web Services accounts that\n have permission to copy or restore the manual DB cluster snapshot. For more information, \n see the ModifyDBClusterSnapshotAttribute\n API action.

" + } + }, + "AttributeValues": { + "target": "com.amazonaws.rds#AttributeValueList", + "traits": { + "smithy.api#documentation": "

The value(s) for the manual DB cluster snapshot attribute.

\n

If the AttributeName field is set to restore, then this element\n returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual\n DB cluster snapshot. If a value of all is in the list, then the manual DB cluster snapshot\n is public and available for any Amazon Web Services account to copy or restore.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the name and values of a manual DB cluster snapshot attribute.

\n

Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts\n to restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute\n API action.

" + } + }, + "com.amazonaws.rds#DBClusterSnapshotAttributeList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBClusterSnapshotAttribute", + "traits": { + "smithy.api#xmlName": "DBClusterSnapshotAttribute" + } + } + }, + "com.amazonaws.rds#DBClusterSnapshotAttributesResult": { + "type": "structure", + "members": { + "DBClusterSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the manual DB cluster snapshot that the attributes apply to.

" + } + }, + "DBClusterSnapshotAttributes": { + "target": "com.amazonaws.rds#DBClusterSnapshotAttributeList", + "traits": { + "smithy.api#documentation": "

The list of attributes and values for the manual DB cluster snapshot.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes\n API action.

\n

Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts\n to copy or restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute\n API action.

" + } + }, + "com.amazonaws.rds#DBClusterSnapshotList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBClusterSnapshot", + "traits": { + "smithy.api#xmlName": "DBClusterSnapshot" + } + } + }, + "com.amazonaws.rds#DBClusterSnapshotMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterSnapshots request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "DBClusterSnapshots": { + "target": "com.amazonaws.rds#DBClusterSnapshotList", + "traits": { + "smithy.api#documentation": "

Provides a list of DB cluster snapshots for the user.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides a list of DB cluster snapshots for the user as the result of a call to the DescribeDBClusterSnapshots action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DBClusterSnapshotNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterSnapshotNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

\n DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBClusterStatusInfo": { + "type": "structure", + "members": { + "StatusType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

" + } + }, + "Normal": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

" + } + }, + "Message": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Reserved for future use.

" + } + }, + "com.amazonaws.rds#DBClusterStatusInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBClusterStatusInfo", + "traits": { + "smithy.api#xmlName": "DBClusterStatusInfo" + } + } + }, + "com.amazonaws.rds#DBEngineVersion": { + "type": "structure", + "members": { + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the database engine.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version number of the database engine.

" + } + }, + "DBParameterGroupFamily": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group family for the database engine.

" + } + }, + "DBEngineDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The description of the database engine.

" + } + }, + "DBEngineVersionDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The description of the database engine version.

" + } + }, + "DefaultCharacterSet": { + "target": "com.amazonaws.rds#CharacterSet", + "traits": { + "smithy.api#documentation": "

The default character set for new instances of this engine version,\n if the CharacterSetName parameter of the CreateDBInstance API\n isn't specified.

" + } + }, + "Image": { + "target": "com.amazonaws.rds#CustomDBEngineVersionAMI", + "traits": { + "smithy.api#documentation": "

The EC2 image

" + } + }, + "DBEngineMediaType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server.

" + } + }, + "SupportedCharacterSets": { + "target": "com.amazonaws.rds#SupportedCharacterSetsList", + "traits": { + "smithy.api#documentation": "

A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance operation.

" + } + }, + "SupportedNcharCharacterSets": { + "target": "com.amazonaws.rds#SupportedCharacterSetsList", + "traits": { + "smithy.api#documentation": "

A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName parameter of the CreateDBInstance operation.

" + } + }, + "ValidUpgradeTarget": { + "target": "com.amazonaws.rds#ValidUpgradeTargetList", + "traits": { + "smithy.api#documentation": "

A list of engine versions that this database engine version can be upgraded to.

" + } + }, + "SupportedTimezones": { + "target": "com.amazonaws.rds#SupportedTimezonesList", + "traits": { + "smithy.api#documentation": "

A list of the time zones supported by this engine for the\n Timezone parameter of the CreateDBInstance action.

" + } + }, + "ExportableLogTypes": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

The types of logs that the database engine has available for export to CloudWatch Logs.

" + } + }, + "SupportsLogExportsToCloudwatchLogs": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.

" + } + }, + "SupportsReadReplica": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the database engine version supports read replicas.

" + } + }, + "SupportedEngineModes": { + "target": "com.amazonaws.rds#EngineModeList", + "traits": { + "smithy.api#documentation": "

A list of the supported DB engine modes.

" + } + }, + "SupportedFeatureNames": { + "target": "com.amazonaws.rds#FeatureNameList", + "traits": { + "smithy.api#documentation": "

A list of features supported by the DB engine.

\n

The supported features vary by DB engine and DB engine version.

\n

To determine the supported features for a specific DB engine and DB engine version using the CLI, \n use the following command:

\n

\n aws rds describe-db-engine-versions --engine --engine-version \n

\n

For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, \n use the following command:

\n

\n aws rds describe-db-engine-versions --engine postgres --engine-version 13.3\n

\n

The supported features are listed under SupportedFeatureNames in the output.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The status of the DB engine version, either available or deprecated.

" + } + }, + "SupportsParallelQuery": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether you can use Aurora parallel query with a specific DB engine version.

" + } + }, + "SupportsGlobalDatabases": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether you can use Aurora global databases with a specific DB engine version.

" + } + }, + "MajorEngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The major engine version of the CEV.

" + } + }, + "DatabaseInstallationFilesS3BucketName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon S3 bucket that contains your database installation files.

" + } + }, + "DatabaseInstallationFilesS3Prefix": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon S3 directory that contains the database installation files. \n If not specified, then no prefix is assumed.

" + } + }, + "DBEngineVersionArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN of the custom engine version.

" + } + }, + "KMSKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for \n RDS Custom, but optional for Amazon RDS.

" + } + }, + "CreateTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The creation time of the DB engine version.

" + } + }, + "TagList": { + "target": "com.amazonaws.rds#TagList" + }, + "SupportsBabelfish": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the engine version supports Babelfish for Aurora PostgreSQL.

" + } + }, + "CustomDBEngineVersionManifest": { + "target": "com.amazonaws.rds#CustomDBEngineVersionManifest", + "traits": { + "smithy.api#documentation": "

JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). \n RDS Custom applies the patches in the order in which they're listed in the manifest. You can set the Oracle home, Oracle base, \n and UNIX/Linux user and group using the installation parameters. For more information, \n see JSON fields in the CEV manifest in the Amazon RDS User Guide.\n

" + } + }, + "SupportsLimitlessDatabase": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the DB engine version supports Aurora Limitless Database.

" + } + }, + "SupportsCertificateRotationWithoutRestart": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether the engine version supports rotating the server certificate without \n rebooting the DB instance.

" + } + }, + "SupportedCACertificateIdentifiers": { + "target": "com.amazonaws.rds#CACertificateIdentifiersList", + "traits": { + "smithy.api#documentation": "

A list of the supported CA certificate identifiers.

\n

For more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.

" + } + }, + "SupportsLocalWriteForwarding": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether the DB engine version supports forwarding write operations from reader DB instances \n to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.

\n

Valid for: Aurora DB clusters only

" + } + }, + "SupportsIntegrations": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the DB engine version supports zero-ETL integrations with\n Amazon Redshift.

" + } + }, + "ServerlessV2FeaturesSupport": { + "target": "com.amazonaws.rds#ServerlessV2FeaturesSupport", + "traits": { + "smithy.api#documentation": "

Specifies any Aurora Serverless v2 properties or limits that differ between Aurora engine versions.\n You can test the values of this attribute when deciding which Aurora version to use in a new or upgraded\n DB cluster. You can also retrieve the version of an existing DB cluster and check whether that version\n supports certain Aurora Serverless v2 features before you attempt to use those features.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a response element in the action DescribeDBEngineVersions.

" + } + }, + "com.amazonaws.rds#DBEngineVersionList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBEngineVersion", + "traits": { + "smithy.api#xmlName": "DBEngineVersion" + } + } + }, + "com.amazonaws.rds#DBEngineVersionMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "DBEngineVersions": { + "target": "com.amazonaws.rds#DBEngineVersionList", + "traits": { + "smithy.api#documentation": "

A list of DBEngineVersion elements.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBEngineVersions action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DBInstance": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

" + } + }, + "DBInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the compute and memory capacity class of the DB instance.

" + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The database engine used for this DB instance.

" + } + }, + "DBInstanceStatus": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The current state of this database.

\n

For information about DB instance statuses, see\n Viewing DB instance status \n in the Amazon RDS User Guide.\n

" + } + }, + "AutomaticRestartTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The time when a stopped DB instance is restarted automatically.

" + } + }, + "MasterUsername": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The master username for the DB instance.

" + } + }, + "DBName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The initial database name that you provided (if required) when you created\n the DB instance. This name is returned for the life of your DB instance. For an RDS for\n Oracle CDB instance, the name identifies the PDB rather than the CDB.

" + } + }, + "Endpoint": { + "target": "com.amazonaws.rds#Endpoint", + "traits": { + "smithy.api#documentation": "

The connection endpoint for the DB instance.

\n \n

The endpoint might not be shown for instances with the status of creating.

\n " + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#documentation": "

The amount of storage in gibibytes (GiB) allocated for the DB instance.

" + } + }, + "InstanceCreateTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The date and time when the DB instance was created.

" + } + }, + "PreferredBackupWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The daily time range during which automated backups are\n created if automated backups are enabled, as determined\n by the BackupRetentionPeriod.

" + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#documentation": "

The number of days for which automatic DB snapshots are retained.

" + } + }, + "DBSecurityGroups": { + "target": "com.amazonaws.rds#DBSecurityGroupMembershipList", + "traits": { + "smithy.api#documentation": "

A list of DB security group elements containing \n DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

" + } + }, + "VpcSecurityGroups": { + "target": "com.amazonaws.rds#VpcSecurityGroupMembershipList", + "traits": { + "smithy.api#documentation": "

The list of Amazon EC2 VPC security groups that the DB instance belongs to.

" + } + }, + "DBParameterGroups": { + "target": "com.amazonaws.rds#DBParameterGroupStatusList", + "traits": { + "smithy.api#documentation": "

The list of DB parameter groups applied to this DB instance.

" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the Availability Zone where the DB instance is located.

" + } + }, + "DBSubnetGroup": { + "target": "com.amazonaws.rds#DBSubnetGroup", + "traits": { + "smithy.api#documentation": "

Information about the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

" + } + }, + "PreferredMaintenanceWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

" + } + }, + "PendingModifiedValues": { + "target": "com.amazonaws.rds#PendingModifiedValues", + "traits": { + "smithy.api#documentation": "

Information about pending changes to the DB instance. This information is returned only when there are pending changes. Specific changes are identified by subelements.

" + } + }, + "LatestRestorableTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The latest time to which a database in this DB instance can be restored with point-in-time restore.

" + } + }, + "MultiAZ": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version of the database engine.

" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether minor version patches are applied automatically.

" + } + }, + "ReadReplicaSourceDBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the source DB instance if this DB instance is a read\n replica.

" + } + }, + "ReadReplicaDBInstanceIdentifiers": { + "target": "com.amazonaws.rds#ReadReplicaDBInstanceIdentifierList", + "traits": { + "smithy.api#documentation": "

The identifiers of the read replicas associated with this DB\n instance.

" + } + }, + "ReadReplicaDBClusterIdentifiers": { + "target": "com.amazonaws.rds#ReadReplicaDBClusterIdentifierList", + "traits": { + "smithy.api#documentation": "

The identifiers of Aurora DB clusters to which the RDS DB instance\n is replicated as a read replica. For example, when you create an Aurora read replica of\n an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is\n shown. This output doesn't contain information about cross-Region Aurora read\n replicas.

\n \n

Currently, each RDS DB instance can have only one Aurora read replica.

\n " + } + }, + "ReplicaMode": { + "target": "com.amazonaws.rds#ReplicaMode", + "traits": { + "smithy.api#documentation": "

The open mode of an Oracle read replica. The default is open-read-only. \n For more information, see Working with Oracle Read Replicas for Amazon RDS \n in the Amazon RDS User Guide.

\n \n

This attribute is only supported in RDS for Oracle.

\n " + } + }, + "LicenseModel": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The license model information for this DB instance. This setting doesn't apply to\n Amazon Aurora or RDS Custom DB instances.

" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The Provisioned IOPS (I/O operations per second) value for the DB instance.

" + } + }, + "OptionGroupMemberships": { + "target": "com.amazonaws.rds#OptionGroupMembershipList", + "traits": { + "smithy.api#documentation": "

The list of option group memberships for this DB instance.

" + } + }, + "CharacterSetName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

If present, specifies the name of the character set that this instance is associated with.

" + } + }, + "NcharCharacterSetName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the NCHAR character set for the Oracle DB instance. This character set specifies the\n Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.

" + } + }, + "SecondaryAvailabilityZone": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the DB instance is publicly accessible.

\n

When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), \n its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, \n the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBInstance.

" + } + }, + "StatusInfos": { + "target": "com.amazonaws.rds#DBInstanceStatusInfoList", + "traits": { + "smithy.api#documentation": "

The status of a read replica. If the DB instance isn't a read replica, the value is\n blank.

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The storage type associated with the DB instance.

" + } + }, + "TdeCredentialArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN from the key store with which the instance is associated for TDE encryption.

" + } + }, + "DbInstancePort": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#documentation": "

The port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

" + } + }, + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

If the DB instance is a member of a DB cluster, indicates the name of the DB cluster that the DB instance is a member of.

" + } + }, + "StorageEncrypted": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the DB instance is encrypted.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier \n for the encrypted DB instance.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" + } + }, + "DbiResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log \n entries whenever the Amazon Web Services KMS key for the DB instance is accessed.

" + } + }, + "CACertificateIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the CA certificate for this DB instance.

\n

For more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.

" + } + }, + "DomainMemberships": { + "target": "com.amazonaws.rds#DomainMembershipList", + "traits": { + "smithy.api#documentation": "

The Active Directory Domain membership records associated with the DB instance.

" + } + }, + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether tags are copied from the DB instance to snapshots of the DB instance.

\n

This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting. For more\n information, see DBCluster.

" + } + }, + "MonitoringInterval": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

" + } + }, + "EnhancedMonitoringResourceArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

" + } + }, + "MonitoringRoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

" + } + }, + "PromotionTier": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The order of priority in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

" + } + }, + "DBInstanceArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB instance.

" + } + }, + "Timezone": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The time zone of the DB instance.\n In most cases, the Timezone element is empty.\n Timezone content appears only for\n RDS for Db2 and RDS for SQL Server DB instances \n that were created with a time zone specified.

" + } + }, + "IAMDatabaseAuthenticationEnabled": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled for the DB instance.

\n

For a list of engine versions that support IAM database authentication, see \n IAM database authentication\n in the Amazon RDS User Guide and IAM \n database authentication in Aurora in the Amazon Aurora User Guide.

" + } + }, + "DatabaseInsightsMode": { + "target": "com.amazonaws.rds#DatabaseInsightsMode", + "traits": { + "smithy.api#documentation": "

The mode of Database Insights that is enabled for the instance.

" + } + }, + "PerformanceInsightsEnabled": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether Performance Insights is enabled for the DB instance.

" + } + }, + "PerformanceInsightsKMSKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" + } + }, + "PerformanceInsightsRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days to retain Performance Insights data.

\n

Valid Values:

\n
    \n
  • \n

    \n 7\n

    \n
    • \n
  • \n

    \n month * 31, where month is a number of months from 1-23. \n Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)

    \n
    • \n
  • \n

    \n 731\n

    \n
    • \n
\n

Default: 7 days

" + } + }, + "EnabledCloudwatchLogsExports": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

A list of log types that this DB instance is configured to export to CloudWatch Logs.

\n

Log types vary by DB engine. For information about the log types for each DB engine, see\n Monitoring Amazon RDS log files in the Amazon RDS User Guide.\n

" + } + }, + "ProcessorFeatures": { + "target": "com.amazonaws.rds#ProcessorFeatureList", + "traits": { + "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the DB instance has deletion protection enabled.\n The database can't be deleted when deletion protection is enabled.\n For more information, see \n \n Deleting a DB Instance.

" + } + }, + "AssociatedRoles": { + "target": "com.amazonaws.rds#DBInstanceRoles", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.

" + } + }, + "ListenerEndpoint": { + "target": "com.amazonaws.rds#Endpoint", + "traits": { + "smithy.api#documentation": "

The listener connection endpoint for SQL Server Always On.

" + } + }, + "MaxAllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

" + } + }, + "TagList": { + "target": "com.amazonaws.rds#TagList" + }, + "DBInstanceAutomatedBackupsReplications": { + "target": "com.amazonaws.rds#DBInstanceAutomatedBackupsReplicationList", + "traits": { + "smithy.api#documentation": "

The list of replicated automated backups associated with the DB instance.

" + } + }, + "CustomerOwnedIpEnabled": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" + } + }, + "AwsBackupRecoveryPointArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

" + } + }, + "ActivityStreamStatus": { + "target": "com.amazonaws.rds#ActivityStreamStatus", + "traits": { + "smithy.api#documentation": "

The status of the database activity stream.

" + } + }, + "ActivityStreamKmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. \n The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" + } + }, + "ActivityStreamKinesisStreamName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Kinesis data stream used for the database activity stream.

" + } + }, + "ActivityStreamMode": { + "target": "com.amazonaws.rds#ActivityStreamMode", + "traits": { + "smithy.api#documentation": "

The mode of the database activity stream. Database events such as a change or access generate \n an activity stream event. RDS for Oracle always handles these events asynchronously.

" + } + }, + "ActivityStreamEngineNativeAuditFieldsIncluded": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether engine-native audit fields are included in the database activity stream.

" + } + }, + "AutomationMode": { + "target": "com.amazonaws.rds#AutomationMode", + "traits": { + "smithy.api#documentation": "

The automation mode of the RDS Custom DB instance: full or all paused. \n If full, the DB instance automates monitoring and instance recovery. If \n all paused, the instance pauses automation for the duration set by \n --resume-full-automation-mode-minutes.

" + } + }, + "ResumeFullAutomationModeTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. \n The minimum value is 60 (default). The maximum value is 1,440.

" + } + }, + "CustomIamInstanceProfile": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:

\n
    \n
  • \n

    The profile must exist in your account.

    \n
    • \n
  • \n

    The profile must have an IAM role that Amazon EC2 has permissions to assume.

    \n
    • \n
  • \n

    The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

    \n
    • \n
\n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.

" + } + }, + "BackupTarget": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The location where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

" + } + }, + "NetworkType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The network type of the DB instance.

\n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide and \n \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid Values: IPV4 | DUAL\n

" + } + }, + "ActivityStreamPolicyStatus": { + "target": "com.amazonaws.rds#ActivityStreamPolicyStatus", + "traits": { + "smithy.api#documentation": "

The status of the policy state of the activity stream.

" + } + }, + "StorageThroughput": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The storage throughput for the DB instance.

\n

This setting applies only to the gp3 storage type.

" + } + }, + "DBSystemId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also\n the name of the CDB. This setting is only valid for RDS Custom DB instances.

" + } + }, + "MasterUserSecret": { + "target": "com.amazonaws.rds#MasterUserSecret", + "traits": { + "smithy.api#documentation": "

The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.\n

" + } + }, + "CertificateDetails": { + "target": "com.amazonaws.rds#CertificateDetails", + "traits": { + "smithy.api#documentation": "

The details of the DB instance's server certificate.

" + } + }, + "ReadReplicaSourceDBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the source DB cluster if this DB instance is a read\n replica.

" + } + }, + "PercentProgress": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The progress of the storage optimization operation as a percentage.

" + } + }, + "DedicatedLogVolume": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the DB instance has a dedicated log volume (DLV) enabled.

" + } + }, + "IsStorageConfigUpgradeAvailable": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether an upgrade is recommended for the storage file system configuration\n on the DB instance. To migrate to the preferred configuration, you can either create a\n blue/green deployment, or create a read replica from the DB instance. For more\n information, see Upgrading the storage file system for a DB instance.

" + } + }, + "MultiTenant": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the DB instance is in the multi-tenant configuration (TRUE) or the\n single-tenant configuration (FALSE).

" + } + }, + "EngineLifecycleSupport": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The life cycle type for the DB instance.

\n

For more information, see CreateDBInstance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details of an Amazon RDS DB instance.

\n

This data type is used as a response element in the operations CreateDBInstance, \n CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, \n ModifyDBInstance, PromoteReadReplica, RebootDBInstance, \n RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3, RestoreDBInstanceToPointInTime, \n StartDBInstance, and StopDBInstance.

" + } + }, + "com.amazonaws.rds#DBInstanceAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBInstanceAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The user already has a DB instance with the given identifier.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBInstanceAutomatedBackup": { + "type": "structure", + "members": { + "DBInstanceArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the automated backups.

" + } + }, + "DbiResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The resource ID for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

" + } + }, + "Region": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region associated with the automated backup.

" + } + }, + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

" + } + }, + "RestoreWindow": { + "target": "com.amazonaws.rds#RestoreWindow", + "traits": { + "smithy.api#documentation": "

The earliest and latest time a DB instance can be restored to.

" + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#documentation": "

The allocated storage size for the the automated backup in gibibytes (GiB).

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A list of status information for an automated backup:

\n
    \n
  • \n

    \n active - Automated backups for current instances.

    \n
    • \n
  • \n

    \n retained - Automated backups for deleted instances.

    \n
    • \n
  • \n

    \n creating - Automated backups that are waiting for the first automated snapshot to be available.

    \n
    • \n
" + } + }, + "Port": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#documentation": "

The port number that the automated backup used for connections.

\n

Default: Inherits from the source DB instance

\n

Valid Values: 1150-65535\n

" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone that the automated backup was created in. For information on\n Amazon Web Services Regions and Availability Zones, see \n Regions\n and Availability Zones.

" + } + }, + "VpcId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The VPC ID associated with the DB instance.

" + } + }, + "InstanceCreateTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The date and time when the DB instance was created.

" + } + }, + "MasterUsername": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The master user name of an automated backup.

" + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the database engine for this automated backup.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version of the database engine for the automated backup.

" + } + }, + "LicenseModel": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The license model information for the automated backup.

" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The IOPS (I/O operations per second) value for the automated backup.

" + } + }, + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.

" + } + }, + "TdeCredentialArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN from the key store with which the automated backup is associated for TDE encryption.

" + } + }, + "Encrypted": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the automated backup is encrypted.

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The storage type associated with the automated backup.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key ID for an automated backup.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" + } + }, + "Timezone": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The time zone of the automated backup. In most cases, the Timezone element is empty.\n Timezone content appears only for Microsoft SQL Server DB instances \n that were created with a time zone specified.

" + } + }, + "IAMDatabaseAuthenticationEnabled": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, \n and otherwise false.

" + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The retention period for the automated backups.

" + } + }, + "DBInstanceAutomatedBackupsArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the replicated automated backups.

" + } + }, + "DBInstanceAutomatedBackupsReplications": { + "target": "com.amazonaws.rds#DBInstanceAutomatedBackupsReplicationList", + "traits": { + "smithy.api#documentation": "

The list of replications to different Amazon Web Services Regions associated with the automated backup.

" + } + }, + "BackupTarget": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The location where automated backups are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

" + } + }, + "StorageThroughput": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The storage throughput for the automated backup.

" + } + }, + "AwsBackupRecoveryPointArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

" + } + }, + "DedicatedLogVolume": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether the DB instance has a dedicated log volume (DLV) enabled.

" + } + }, + "MultiTenant": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the automatic backup is for a DB instance in the multi-tenant\n configuration (TRUE) or the single-tenant configuration (FALSE).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An automated backup of a DB instance. It consists of system backups, transaction logs, and the database instance properties that\n existed at the time you deleted the source instance.

" + } + }, + "com.amazonaws.rds#DBInstanceAutomatedBackupList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBInstanceAutomatedBackup", + "traits": { + "smithy.api#xmlName": "DBInstanceAutomatedBackup" + } + } + }, + "com.amazonaws.rds#DBInstanceAutomatedBackupMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "DBInstanceAutomatedBackups": { + "target": "com.amazonaws.rds#DBInstanceAutomatedBackupList", + "traits": { + "smithy.api#documentation": "

A list of DBInstanceAutomatedBackup instances.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBInstanceAutomatedBackups action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DBInstanceAutomatedBackupNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBInstanceAutomatedBackupNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

No automated backup for this DB instance was found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBInstanceAutomatedBackupQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBInstanceAutomatedBackupQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The quota for retained automated backups was exceeded. This prevents you\n from retaining any additional automated backups. The retained automated backups \n quota is the same as your DB instance quota.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBInstanceAutomatedBackupsReplication": { + "type": "structure", + "members": { + "DBInstanceAutomatedBackupsArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replicated automated backups.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.

" + } + }, + "com.amazonaws.rds#DBInstanceAutomatedBackupsReplicationList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBInstanceAutomatedBackupsReplication", + "traits": { + "smithy.api#xmlName": "DBInstanceAutomatedBackupsReplication" + } + } + }, + "com.amazonaws.rds#DBInstanceList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBInstance", + "traits": { + "smithy.api#xmlName": "DBInstance" + } + } + }, + "com.amazonaws.rds#DBInstanceMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .

" + } + }, + "DBInstances": { + "target": "com.amazonaws.rds#DBInstanceList", + "traits": { + "smithy.api#documentation": "

A list of DBInstance instances.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBInstances action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DBInstanceNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBInstanceNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

\n DBInstanceIdentifier doesn't refer to an existing DB instance.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBInstanceNotReadyFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBInstanceNotReady", + "httpResponseCode": 503 + }, + "smithy.api#documentation": "

An attempt to download or examine log files didn't succeed because an Aurora Serverless v2 instance was paused.

", + "smithy.api#error": "server", + "smithy.api#httpError": 503 + } + }, + "com.amazonaws.rds#DBInstanceRole": { + "type": "structure", + "members": { + "RoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB\n instance.

" + } + }, + "FeatureName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role.\n For information about supported feature names, see DBEngineVersion.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Information about the state of association between the IAM role and the DB instance. The Status property returns one of the following\n values:

\n
    \n
  • \n

    \n ACTIVE - the IAM role ARN is associated with the DB instance and can be used to\n access other Amazon Web Services services on your behalf.

    \n
    • \n
  • \n

    \n PENDING - the IAM role ARN is being associated with the DB instance.

    \n
    • \n
  • \n

    \n INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable\n to assume the IAM role in order to access other Amazon Web Services services on your behalf.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance.

" + } + }, + "com.amazonaws.rds#DBInstanceRoleAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBInstanceRoleAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The specified RoleArn or FeatureName value is already associated with the DB instance.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBInstanceRoleNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBInstanceRoleNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified RoleArn value doesn't match the specified feature for\n the DB instance.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBInstanceRoleQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBInstanceRoleQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

You can't associate any more Amazon Web Services Identity and Access Management (IAM) roles with the DB instance because the quota has been reached.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBInstanceRoles": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBInstanceRole", + "traits": { + "smithy.api#xmlName": "DBInstanceRole" + } + } + }, + "com.amazonaws.rds#DBInstanceStatusInfo": { + "type": "structure", + "members": { + "StatusType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

This value is currently \"read replication.\"

" + } + }, + "Normal": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the instance is operating normally (TRUE) or is in an error state (FALSE).

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The status of the DB instance. For a StatusType of read replica, the values can be\n replicating, replication stop point set, replication stop point reached, error, stopped,\n or terminated.

" + } + }, + "Message": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides a list of status information for a DB instance.

" + } + }, + "com.amazonaws.rds#DBInstanceStatusInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBInstanceStatusInfo", + "traits": { + "smithy.api#xmlName": "DBInstanceStatusInfo" + } + } + }, + "com.amazonaws.rds#DBLogFileNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBLogFileNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

\n LogFileName doesn't refer to an existing DB log file.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBParameterGroup": { + "type": "structure", + "members": { + "DBParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group.

" + } + }, + "DBParameterGroupFamily": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group family that this DB parameter group is compatible with.

" + } + }, + "Description": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the customer-specified description for this DB parameter group.

" + } + }, + "DBParameterGroupArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB parameter group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details of an Amazon RDS DB parameter group.

\n

This data type is used as a response element in the DescribeDBParameterGroups action.

" + } + }, + "com.amazonaws.rds#DBParameterGroupAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBParameterGroupAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

A DB parameter group with the same name exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBParameterGroupDetails": { + "type": "structure", + "members": { + "Parameters": { + "target": "com.amazonaws.rds#ParametersList", + "traits": { + "smithy.api#documentation": "

A list of Parameter values.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBParameters action.

" + } + }, + "com.amazonaws.rds#DBParameterGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBParameterGroup", + "traits": { + "smithy.api#xmlName": "DBParameterGroup" + } + } + }, + "com.amazonaws.rds#DBParameterGroupNameMessage": { + "type": "structure", + "members": { + "DBParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the \n ModifyDBParameterGroup or ResetDBParameterGroup operation.

" + } + }, + "com.amazonaws.rds#DBParameterGroupNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBParameterGroupNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

\n DBParameterGroupName doesn't refer to an\n existing DB parameter group.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBParameterGroupQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBParameterGroupQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request would result in the user exceeding the allowed number of DB parameter\n groups.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBParameterGroupStatus": { + "type": "structure", + "members": { + "DBParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group.

" + } + }, + "ParameterApplyStatus": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The status of parameter updates. Valid values are:

\n
    \n
  • \n

    \n applying: The parameter group change is being applied to the\n database.

    \n
    • \n
  • \n

    \n failed-to-apply: The parameter group is in an invalid\n state.

    \n
    • \n
  • \n

    \n in-sync: The parameter group change is synchronized with the\n database.

    \n
    • \n
  • \n

    \n pending-database-upgrade: The parameter group change will be\n applied after the DB instance is upgraded.

    \n
    • \n
  • \n

    \n pending-reboot: The parameter group change will be applied after\n the DB instance reboots.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

The status of the DB parameter group.

\n

This data type is used as a response element in the following actions:

\n
    \n
  • \n

    \n CreateDBInstance\n

    \n
    • \n
  • \n

    \n CreateDBInstanceReadReplica\n

    \n
    • \n
  • \n

    \n DeleteDBInstance\n

    \n
    • \n
  • \n

    \n ModifyDBInstance\n

    \n
    • \n
  • \n

    \n RebootDBInstance\n

    \n
    • \n
  • \n

    \n RestoreDBInstanceFromDBSnapshot\n

    \n
    • \n
" + } + }, + "com.amazonaws.rds#DBParameterGroupStatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBParameterGroupStatus", + "traits": { + "smithy.api#xmlName": "DBParameterGroup" + } + } + }, + "com.amazonaws.rds#DBParameterGroupsMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "DBParameterGroups": { + "target": "com.amazonaws.rds#DBParameterGroupList", + "traits": { + "smithy.api#documentation": "

A list of DBParameterGroup instances.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBParameterGroups action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DBProxy": { + "type": "structure", + "members": { + "DBProxyName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.

" + } + }, + "DBProxyArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the proxy.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#DBProxyStatus", + "traits": { + "smithy.api#documentation": "

The current status of this proxy. A status of available means the\n proxy is ready to handle requests. Other values indicate that you must wait for\n the proxy to be ready, or take some action to resolve an issue.

" + } + }, + "EngineFamily": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The kinds of databases that the proxy can connect to. This value determines which database network protocol \n the proxy recognizes when it interprets network traffic to and from the database. MYSQL supports Aurora MySQL, \n RDS for MariaDB, and RDS for MySQL databases. POSTGRESQL supports Aurora PostgreSQL and RDS for PostgreSQL databases. \n SQLSERVER supports RDS for Microsoft SQL Server databases.

" + } + }, + "VpcId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the VPC ID of the DB proxy.

" + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

Provides a list of VPC security groups that the proxy belongs to.

" + } + }, + "VpcSubnetIds": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The EC2 subnet IDs for the proxy.

" + } + }, + "Auth": { + "target": "com.amazonaws.rds#UserAuthConfigInfoList", + "traits": { + "smithy.api#documentation": "

One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance\n or Aurora DB cluster.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.

" + } + }, + "Endpoint": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the\n connection string for a database client application.

" + } + }, + "RequireTLS": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.

" + } + }, + "IdleClientTimeout": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#documentation": "

The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection.\n The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by\n later connection requests.

\n

Default: 1800 (30 minutes)

\n

Constraints: 1 to 28,800

" + } + }, + "DebugLogging": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the proxy includes detailed information about SQL statements in its logs.\n This information helps you to debug issues involving SQL behavior or the performance\n and scalability of the proxy connections. The debug information includes the text of\n SQL statements that you submit through the proxy. Thus, only enable this setting\n when needed for debugging, and only when you have security measures in place to\n safeguard any sensitive information that appears in the logs.

" + } + }, + "CreatedDate": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The date and time when the proxy was first created.

" + } + }, + "UpdatedDate": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The date and time when the proxy was last updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The data structure representing a proxy managed by the RDS Proxy.

\n

This data type is used as a response element in the DescribeDBProxies action.

" + } + }, + "com.amazonaws.rds#DBProxyAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBProxyAlreadyExistsFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The specified proxy name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBProxyEndpoint": { + "type": "structure", + "members": { + "DBProxyEndpointName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name for the DB proxy endpoint. An identifier must begin with a letter and\n must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen\n or contain two consecutive hyphens.

" + } + }, + "DBProxyEndpointArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB proxy endpoint.

" + } + }, + "DBProxyName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the DB proxy that is associated with this DB proxy endpoint.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#DBProxyEndpointStatus", + "traits": { + "smithy.api#documentation": "

The current status of this DB proxy endpoint. A status of available means the\n endpoint is ready to handle requests. Other values indicate that you must wait for\n the endpoint to be ready, or take some action to resolve an issue.

" + } + }, + "VpcId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the VPC ID of the DB proxy endpoint.

" + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

Provides a list of VPC security groups that the DB proxy endpoint belongs to.

" + } + }, + "VpcSubnetIds": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The EC2 subnet IDs for the DB proxy endpoint.

" + } + }, + "Endpoint": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the\n connection string for a database client application.

" + } + }, + "CreatedDate": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The date and time when the DB proxy endpoint was first created.

" + } + }, + "TargetRole": { + "target": "com.amazonaws.rds#DBProxyEndpointTargetRole", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.

" + } + }, + "IsDefault": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether this endpoint is the default endpoint for the associated DB proxy.\n Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the\n DB proxy can be either read/write or read-only.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The data structure representing an endpoint associated with a DB proxy. RDS automatically creates one\n endpoint for each DB proxy. For Aurora DB clusters, you can associate additional endpoints with the same\n DB proxy. These endpoints can be read/write or read-only. They can also reside in different VPCs than the\n associated DB proxy.

\n

This data type is used as a response element in the DescribeDBProxyEndpoints operation.

" + } + }, + "com.amazonaws.rds#DBProxyEndpointAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBProxyEndpointAlreadyExistsFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The specified DB proxy endpoint name must be unique for all DB proxy endpoints owned by your Amazon Web Services account in the specified Amazon Web Services Region.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBProxyEndpointList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBProxyEndpoint" + } + }, + "com.amazonaws.rds#DBProxyEndpointName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$" + } + }, + "com.amazonaws.rds#DBProxyEndpointNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBProxyEndpointNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The DB proxy endpoint doesn't exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBProxyEndpointQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBProxyEndpointQuotaExceededFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The DB proxy already has the maximum number of endpoints.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBProxyEndpointStatus": { + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "MODIFYING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modifying" + } + }, + "INCOMPATIBLE_NETWORK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "incompatible-network" + } + }, + "INSUFFICIENT_RESOURCE_LIMITS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "insufficient-resource-limits" + } + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "creating" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + } + } + }, + "com.amazonaws.rds#DBProxyEndpointTargetRole": { + "type": "enum", + "members": { + "READ_WRITE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READ_WRITE" + } + }, + "READ_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READ_ONLY" + } + } + } + }, + "com.amazonaws.rds#DBProxyList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBProxy" + } + }, + "com.amazonaws.rds#DBProxyName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$" + } + }, + "com.amazonaws.rds#DBProxyNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBProxyNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBProxyQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBProxyQuotaExceededFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Your Amazon Web Services account already has the maximum number of proxies in the specified Amazon Web Services Region.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBProxyStatus": { + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "MODIFYING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modifying" + } + }, + "INCOMPATIBLE_NETWORK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "incompatible-network" + } + }, + "INSUFFICIENT_RESOURCE_LIMITS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "insufficient-resource-limits" + } + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "creating" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + }, + "SUSPENDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "suspended" + } + }, + "SUSPENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "suspending" + } + }, + "REACTIVATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "reactivating" + } + } + } + }, + "com.amazonaws.rds#DBProxyTarget": { + "type": "structure", + "members": { + "TargetArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster.

" + } + }, + "Endpoint": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The writer endpoint for the RDS DB instance or Aurora DB cluster.

" + } + }, + "TrackedClusterId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance.

" + } + }, + "RdsResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier representing the target. It can be the instance identifier for an RDS DB instance,\n or the cluster identifier for an Aurora DB cluster.

" + } + }, + "Port": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#documentation": "

The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.

" + } + }, + "Type": { + "target": "com.amazonaws.rds#TargetType", + "traits": { + "smithy.api#documentation": "

Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.

" + } + }, + "Role": { + "target": "com.amazonaws.rds#TargetRole", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the target of the proxy can be used for read/write or read-only operations.

" + } + }, + "TargetHealth": { + "target": "com.amazonaws.rds#TargetHealth", + "traits": { + "smithy.api#documentation": "

Information about the connection health of the RDS Proxy target.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details for an RDS Proxy target. It represents an RDS DB instance or Aurora DB cluster\n that the proxy can connect to. One or more targets are associated with an RDS Proxy target group.

\n

This data type is used as a response element in the DescribeDBProxyTargets action.

" + } + }, + "com.amazonaws.rds#DBProxyTargetAlreadyRegisteredFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBProxyTargetAlreadyRegisteredFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The proxy is already associated with the specified RDS DB instance or Aurora DB cluster.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBProxyTargetGroup": { + "type": "structure", + "members": { + "DBProxyName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the RDS proxy associated with this target group.

" + } + }, + "TargetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the target group. This name must be unique for all target groups owned by your Amazon Web Services account in the specified Amazon Web Services Region.

" + } + }, + "TargetGroupArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) representing the target group.

" + } + }, + "IsDefault": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether this target group is the first one used for connection requests by the associated proxy.\n Because each proxy is currently associated with a single target group, currently this setting\n is always true.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The current status of this target group. A status of available means the\n target group is correctly associated with a database. Other values indicate that you must wait for\n the target group to be ready, or take some action to resolve an issue.

" + } + }, + "ConnectionPoolConfig": { + "target": "com.amazonaws.rds#ConnectionPoolConfigurationInfo", + "traits": { + "smithy.api#documentation": "

The settings that determine the size and behavior of the connection pool for the target group.

" + } + }, + "CreatedDate": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The date and time when the target group was first created.

" + } + }, + "UpdatedDate": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The date and time when the target group was last updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a set of RDS DB instances, Aurora DB clusters, or both that a proxy can connect to. Currently, each target group\n is associated with exactly one RDS DB instance or Aurora DB cluster.

\n

This data type is used as a response element in the DescribeDBProxyTargetGroups action.

" + } + }, + "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBProxyTargetGroupNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBProxyTargetNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBProxyTargetNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified RDS DB instance or Aurora DB cluster isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBRecommendation": { + "type": "structure", + "members": { + "RecommendationId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The unique identifier of the recommendation.

" + } + }, + "TypeId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A value that indicates the type of recommendation. This value determines how the description is rendered.

" + } + }, + "Severity": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The severity level of the recommendation. The severity level can help you decide the \n urgency with which to address the recommendation.

\n

Valid values:

\n
    \n
  • \n

    \n high\n

    \n
    • \n
  • \n

    \n medium\n

    \n
    • \n
  • \n

    \n low\n

    \n
    • \n
  • \n

    \n informational\n

    \n
    • \n
" + } + }, + "ResourceArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the RDS resource associated with the recommendation.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The current status of the recommendation.

\n

Valid values:

\n
    \n
  • \n

    \n active - The recommendations which are ready for you to apply.

    \n
    • \n
  • \n

    \n pending - The applied or scheduled recommendations which are in progress.

    \n
    • \n
  • \n

    \n resolved - The recommendations which are completed.

    \n
    • \n
  • \n

    \n dismissed - The recommendations that you dismissed.

    \n
    • \n
" + } + }, + "CreatedTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The time when the recommendation was created. For example, 2023-09-28T01:13:53.931000+00:00.

" + } + }, + "UpdatedTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The time when the recommendation was last updated.

" + } + }, + "Detection": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A short description of the issue identified for this recommendation. The description might contain markdown.

" + } + }, + "Recommendation": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A short description of the recommendation to resolve an issue. The description might contain markdown.

" + } + }, + "Description": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A detailed description of the recommendation. The description might contain markdown.

" + } + }, + "Reason": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The reason why this recommendation was created. The information might contain markdown.

" + } + }, + "RecommendedActions": { + "target": "com.amazonaws.rds#RecommendedActionList", + "traits": { + "smithy.api#documentation": "

A list of recommended actions.

" + } + }, + "Category": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The category of the recommendation.

\n

Valid values:

\n
    \n
  • \n

    \n performance efficiency\n

    \n
    • \n
  • \n

    \n security\n

    \n
    • \n
  • \n

    \n reliability\n

    \n
    • \n
  • \n

    \n cost optimization\n

    \n
    • \n
  • \n

    \n operational excellence\n

    \n
    • \n
  • \n

    \n sustainability\n

    \n
    • \n
" + } + }, + "Source": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services service that generated the recommendations.

" + } + }, + "TypeDetection": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A short description of the recommendation type. The description might contain markdown.

" + } + }, + "TypeRecommendation": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A short description that summarizes the recommendation to fix all the issues of the recommendation type. The description might contain markdown.

" + } + }, + "Impact": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A short description that explains the possible impact of an issue.

" + } + }, + "AdditionalInfo": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Additional information about the recommendation. The information might contain markdown.

" + } + }, + "Links": { + "target": "com.amazonaws.rds#DocLinkList", + "traits": { + "smithy.api#documentation": "

A link to documentation that provides additional information about the recommendation.

" + } + }, + "IssueDetails": { + "target": "com.amazonaws.rds#IssueDetails", + "traits": { + "smithy.api#documentation": "

Details of the issue that caused the recommendation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The recommendation for your DB instances, DB clusters, and DB parameter groups.

" + } + }, + "com.amazonaws.rds#DBRecommendationList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBRecommendation" + } + }, + "com.amazonaws.rds#DBRecommendationMessage": { + "type": "structure", + "members": { + "DBRecommendation": { + "target": "com.amazonaws.rds#DBRecommendation" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DBRecommendationsMessage": { + "type": "structure", + "members": { + "DBRecommendations": { + "target": "com.amazonaws.rds#DBRecommendationList", + "traits": { + "smithy.api#documentation": "

A list of recommendations which is returned from DescribeDBRecommendations API request.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous DBRecommendationsMessage request. This token can be used \n later in a DescribeDBRecomendations request.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DBSecurityGroup": { + "type": "structure", + "members": { + "OwnerId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the Amazon Web Services ID of the owner of a specific DB security group.

" + } + }, + "DBSecurityGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the DB security group.

" + } + }, + "DBSecurityGroupDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the description of the DB security group.

" + } + }, + "VpcId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the VpcId of the DB security group.

" + } + }, + "EC2SecurityGroups": { + "target": "com.amazonaws.rds#EC2SecurityGroupList", + "traits": { + "smithy.api#documentation": "

Contains a list of EC2SecurityGroup elements.

" + } + }, + "IPRanges": { + "target": "com.amazonaws.rds#IPRangeList", + "traits": { + "smithy.api#documentation": "

Contains a list of IPRange elements.

" + } + }, + "DBSecurityGroupArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB security group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details for an Amazon RDS DB security group.

\n

This data type is used as a response element \n in the DescribeDBSecurityGroups action.

" + } + }, + "com.amazonaws.rds#DBSecurityGroupAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSecurityGroupAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

A DB security group with the name specified in\n DBSecurityGroupName already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBSecurityGroupMembership": { + "type": "structure", + "members": { + "DBSecurityGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB security group.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The status of the DB security group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a response element in the following actions:

\n
    \n
  • \n

    \n ModifyDBInstance\n

    \n
    • \n
  • \n

    \n RebootDBInstance\n

    \n
    • \n
  • \n

    \n RestoreDBInstanceFromDBSnapshot\n

    \n
    • \n
  • \n

    \n RestoreDBInstanceToPointInTime\n

    \n
    • \n
" + } + }, + "com.amazonaws.rds#DBSecurityGroupMembershipList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBSecurityGroupMembership", + "traits": { + "smithy.api#xmlName": "DBSecurityGroup" + } + } + }, + "com.amazonaws.rds#DBSecurityGroupMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "DBSecurityGroups": { + "target": "com.amazonaws.rds#DBSecurityGroups", + "traits": { + "smithy.api#documentation": "

A list of DBSecurityGroup instances.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBSecurityGroups action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DBSecurityGroupNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#xmlName": "DBSecurityGroupName" + } + } + }, + "com.amazonaws.rds#DBSecurityGroupNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSecurityGroupNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

\n DBSecurityGroupName doesn't refer to an existing DB security group.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBSecurityGroupNotSupportedFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSecurityGroupNotSupported", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

A DB security group isn't allowed for this action.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBSecurityGroupQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "QuotaExceeded.DBSecurityGroup", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request would result in the user exceeding the allowed number of DB security\n groups.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBSecurityGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBSecurityGroup", + "traits": { + "smithy.api#xmlName": "DBSecurityGroup" + } + } + }, + "com.amazonaws.rds#DBShardGroup": { + "type": "structure", + "members": { + "DBShardGroupResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region-unique, immutable identifier for the DB shard group.

" + } + }, + "DBShardGroupIdentifier": { + "target": "com.amazonaws.rds#DBShardGroupIdentifier", + "traits": { + "smithy.api#documentation": "

The name of the DB shard group.

" + } + }, + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the primary DB cluster for the DB shard group.

" + } + }, + "MaxACU": { + "target": "com.amazonaws.rds#DoubleOptional", + "traits": { + "smithy.api#documentation": "

The maximum capacity of the DB shard group in Aurora capacity units (ACUs).

" + } + }, + "MinACU": { + "target": "com.amazonaws.rds#DoubleOptional", + "traits": { + "smithy.api#documentation": "

The minimum capacity of the DB shard group in Aurora capacity units (ACUs).

" + } + }, + "ComputeRedundancy": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to create standby DB shard groups for the DB shard group. Valid values are the following:

\n
    \n
  • \n

    0 - Creates a DB shard group without a standby DB shard group. This is the default value.

    \n
    • \n
  • \n

    1 - Creates a DB shard group with a standby DB shard group in a different Availability Zone (AZ).

    \n
    • \n
  • \n

    2 - Creates a DB shard group with two standby DB shard groups in two different AZs.

    \n
    • \n
" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The status of the DB shard group.

" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether the DB shard group is publicly accessible.

\n

When the DB shard group is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB shard group's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB shard group's VPC. Access\n to the DB shard group is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB shard group doesn't permit\n it.

\n

When the DB shard group isn't publicly accessible, it is an internal DB shard group with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBShardGroup.

\n

This setting is only for Aurora Limitless Database.

" + } + }, + "Endpoint": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The connection endpoint for the DB shard group.

" + } + }, + "DBShardGroupArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB shard group.

" + } + }, + "TagList": { + "target": "com.amazonaws.rds#TagList" + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details for an Amazon RDS DB shard group.

" + } + }, + "com.amazonaws.rds#DBShardGroupAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBShardGroupAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The specified DB shard group name must be unique in your Amazon Web Services account in the specified Amazon Web Services Region.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBShardGroupIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$" + } + }, + "com.amazonaws.rds#DBShardGroupNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBShardGroupNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified DB shard group name wasn't found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBShardGroupsList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBShardGroup", + "traits": { + "smithy.api#xmlName": "DBShardGroup" + } + } + }, + "com.amazonaws.rds#DBSnapshot": { + "type": "structure", + "members": { + "DBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the identifier for the DB snapshot.

" + } + }, + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

" + } + }, + "SnapshotCreateTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.

" + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the database engine.

" + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#documentation": "

Specifies the allocated storage size in gibibytes (GiB).

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the status of this DB snapshot.

" + } + }, + "Port": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#documentation": "

Specifies the port that the database engine was listening on at the time of the snapshot.

" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

" + } + }, + "VpcId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the VPC ID associated with the DB snapshot.

" + } + }, + "InstanceCreateTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from\n which the snapshot was taken, was created.

" + } + }, + "MasterUsername": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the master username for the DB snapshot.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the version of the database engine.

" + } + }, + "LicenseModel": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

License model information for the restored DB instance.

" + } + }, + "SnapshotType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the type of the DB snapshot.

" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

" + } + }, + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the option group name for the DB snapshot.

" + } + }, + "PercentProgress": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#documentation": "

The percentage of the estimated data that has been transferred.

" + } + }, + "SourceRegion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region that the DB snapshot was created in or copied from.

" + } + }, + "SourceDBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the storage type associated with DB snapshot.

" + } + }, + "TdeCredentialArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN from the key store with which to associate the instance for TDE encryption.

" + } + }, + "Encrypted": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the DB snapshot is encrypted.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

If Encrypted is true, the Amazon Web Services KMS key identifier \n for the encrypted DB snapshot.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" + } + }, + "DBSnapshotArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB snapshot.

" + } + }, + "Timezone": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The time zone of the DB snapshot.\n In most cases, the Timezone element is empty.\n Timezone content appears only for\n snapshots taken from \n Microsoft SQL Server DB instances \n that were created with a time zone specified.

" + } + }, + "IAMDatabaseAuthenticationEnabled": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

" + } + }, + "ProcessorFeatures": { + "target": "com.amazonaws.rds#ProcessorFeatureList", + "traits": { + "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class\n of the DB instance when the DB snapshot was created.

" + } + }, + "DbiResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

" + } + }, + "TagList": { + "target": "com.amazonaws.rds#TagList" + }, + "OriginalSnapshotCreateTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.

" + } + }, + "SnapshotDatabaseTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The timestamp of the most recent transaction applied to the database that you're backing up. \n Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. \n In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed.

\n

If you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime \n with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than \n SnapshotDatabaseTime, then the replica lag is two hours.

" + } + }, + "SnapshotTarget": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

" + } + }, + "StorageThroughput": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Specifies the storage throughput for the DB snapshot.

" + } + }, + "DBSystemId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Oracle system identifier (SID), which is the name of the Oracle database instance that \n manages your database files. The Oracle SID is also the name of your CDB.

" + } + }, + "DedicatedLogVolume": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the DB instance has a dedicated log volume (DLV) enabled.

" + } + }, + "MultiTenant": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether the snapshot is of a DB instance using the multi-tenant\n configuration (TRUE) or the single-tenant configuration (FALSE).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details of an Amazon RDS DB snapshot.

\n

This data type is used as a response element \n in the DescribeDBSnapshots action.

" + } + }, + "com.amazonaws.rds#DBSnapshotAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSnapshotAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

\n DBSnapshotIdentifier is already used by an existing snapshot.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBSnapshotAttribute": { + "type": "structure", + "members": { + "AttributeName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the manual DB snapshot attribute.

\n

The attribute named restore refers to the list of Amazon Web Services accounts that\n have permission to copy or restore the manual DB cluster snapshot. For more information, \n see the ModifyDBSnapshotAttribute\n API action.

" + } + }, + "AttributeValues": { + "target": "com.amazonaws.rds#AttributeValueList", + "traits": { + "smithy.api#documentation": "

The value or values for the manual DB snapshot attribute.

\n

If the AttributeName field is set to restore, then this element\n returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual\n DB snapshot. If a value of all is in the list, then the manual DB snapshot\n is public and available for any Amazon Web Services account to copy or restore.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the name and values of a manual DB snapshot attribute

\n

Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts\n to restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute\n API.

" + } + }, + "com.amazonaws.rds#DBSnapshotAttributeList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBSnapshotAttribute", + "traits": { + "smithy.api#xmlName": "DBSnapshotAttribute" + } + } + }, + "com.amazonaws.rds#DBSnapshotAttributesResult": { + "type": "structure", + "members": { + "DBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the manual DB snapshot that the attributes apply to.

" + } + }, + "DBSnapshotAttributes": { + "target": "com.amazonaws.rds#DBSnapshotAttributeList", + "traits": { + "smithy.api#documentation": "

The list of attributes and values for the manual DB snapshot.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the results of a successful call to the DescribeDBSnapshotAttributes\n API action.

\n

Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts\n to copy or restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute\n API action.

" + } + }, + "com.amazonaws.rds#DBSnapshotList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBSnapshot", + "traits": { + "smithy.api#xmlName": "DBSnapshot" + } + } + }, + "com.amazonaws.rds#DBSnapshotMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "DBSnapshots": { + "target": "com.amazonaws.rds#DBSnapshotList", + "traits": { + "smithy.api#documentation": "

A list of DBSnapshot instances.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBSnapshots action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DBSnapshotNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSnapshotNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

\n DBSnapshotIdentifier doesn't refer to an existing DB snapshot.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBSnapshotTenantDatabase": { + "type": "structure", + "members": { + "DBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the snapshot of the DB instance.

" + } + }, + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ID for the DB instance that contains the tenant databases.

" + } + }, + "DbiResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The resource identifier of the source CDB instance. This identifier can't be changed\n and is unique to an Amazon Web Services Region.

" + } + }, + "EngineName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the database engine.

" + } + }, + "SnapshotType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The type of DB snapshot.

" + } + }, + "TenantDatabaseCreateTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The time the DB snapshot was taken, specified in Coordinated Universal Time (UTC). If\n you copy the snapshot, the creation time changes.

" + } + }, + "TenantDBName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the tenant database.

" + } + }, + "MasterUsername": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The master username of the tenant database.

" + } + }, + "TenantDatabaseResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The resource ID of the tenant database.

" + } + }, + "CharacterSetName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the character set of a tenant database.

" + } + }, + "DBSnapshotTenantDatabaseARN": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the snapshot tenant database.

" + } + }, + "NcharCharacterSetName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The NCHAR character set name of the tenant database.

" + } + }, + "TagList": { + "target": "com.amazonaws.rds#TagList" + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details of a tenant database in a snapshot of a DB instance.

" + } + }, + "com.amazonaws.rds#DBSnapshotTenantDatabaseNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSnapshotTenantDatabaseNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified snapshot tenant database wasn't found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBSnapshotTenantDatabasesList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBSnapshotTenantDatabase", + "traits": { + "smithy.api#xmlName": "DBSnapshotTenantDatabase" + } + } + }, + "com.amazonaws.rds#DBSnapshotTenantDatabasesMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value\n specified by MaxRecords.

" + } + }, + "DBSnapshotTenantDatabases": { + "target": "com.amazonaws.rds#DBSnapshotTenantDatabasesList", + "traits": { + "smithy.api#documentation": "

A list of DB snapshot tenant databases.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DBSubnetGroup": { + "type": "structure", + "members": { + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB subnet group.

" + } + }, + "DBSubnetGroupDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the description of the DB subnet group.

" + } + }, + "VpcId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the VpcId of the DB subnet group.

" + } + }, + "SubnetGroupStatus": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the status of the DB subnet group.

" + } + }, + "Subnets": { + "target": "com.amazonaws.rds#SubnetList", + "traits": { + "smithy.api#documentation": "

Contains a list of Subnet elements.

" + } + }, + "DBSubnetGroupArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB subnet group.

" + } + }, + "SupportedNetworkTypes": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The network type of the DB subnet group.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details of an Amazon RDS DB subnet group.

\n

This data type is used as a response element \n in the DescribeDBSubnetGroups action.

" + } + }, + "com.amazonaws.rds#DBSubnetGroupAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSubnetGroupAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

\n DBSubnetGroupName is already used by an existing DB subnet group.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSubnetGroupDoesNotCoverEnoughAZs", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBSubnetGroupMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "DBSubnetGroups": { + "target": "com.amazonaws.rds#DBSubnetGroups", + "traits": { + "smithy.api#documentation": "

A list of DBSubnetGroup instances.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBSubnetGroups action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DBSubnetGroupNotAllowedFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSubnetGroupNotAllowedFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The DBSubnetGroup shouldn't be specified while creating read replicas that lie\n in the same region as the source instance.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBSubnetGroupNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSubnetGroupNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

\n DBSubnetGroupName doesn't refer to an existing DB subnet group.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBSubnetGroupQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSubnetGroupQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request would result in the user exceeding the allowed number of DB subnet\n groups.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBSubnetGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBSubnetGroup", + "traits": { + "smithy.api#xmlName": "DBSubnetGroup" + } + } + }, + "com.amazonaws.rds#DBSubnetQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSubnetQuotaExceededFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request would result in the user exceeding the allowed number of subnets in a\n DB subnet groups.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBUpgradeDependencyFailureFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBUpgradeDependencyFailure", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The DB upgrade failed because a resource the DB depends on can't be\n modified.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DataFilter": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25600 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_ \"\\\\\\-$,*.:?+\\/]*$" + } + }, + "com.amazonaws.rds#DatabaseArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:[A-Za-z][0-9A-Za-z-:._]*$" + } + }, + "com.amazonaws.rds#DatabaseInsightsMode": { + "type": "enum", + "members": { + "STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "standard" + } + }, + "ADVANCED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "advanced" + } + } + } + }, + "com.amazonaws.rds#DeleteBlueGreenDeployment": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteBlueGreenDeploymentRequest" + }, + "output": { + "target": "com.amazonaws.rds#DeleteBlueGreenDeploymentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#BlueGreenDeploymentNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidBlueGreenDeploymentStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a blue/green deployment.

\n

For more information, see Using Amazon RDS\n Blue/Green Deployments for database updates in the Amazon RDS User\n Guide and Using Amazon RDS\n Blue/Green Deployments for database updates in the Amazon Aurora\n User Guide.

" + } + }, + "com.amazonaws.rds#DeleteBlueGreenDeploymentRequest": { + "type": "structure", + "members": { + "BlueGreenDeploymentIdentifier": { + "target": "com.amazonaws.rds#BlueGreenDeploymentIdentifier", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The unique identifier of the blue/green deployment to delete. This parameter isn't\n case-sensitive.

\n

Constraints:\n

\n
    \n
  • \n

    Must match an existing blue/green deployment identifier.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "DeleteTarget": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to delete the resources in the green environment. You can't specify\n this option if the blue/green deployment status is\n SWITCHOVER_COMPLETED.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DeleteBlueGreenDeploymentResponse": { + "type": "structure", + "members": { + "BlueGreenDeployment": { + "target": "com.amazonaws.rds#BlueGreenDeployment" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DeleteCustomDBEngineVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteCustomDBEngineVersionMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBEngineVersion" + }, + "errors": [ + { + "target": "com.amazonaws.rds#CustomDBEngineVersionNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidCustomDBEngineVersionStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a custom engine version. To run this command, make sure you meet the following prerequisites:

\n
    \n
  • \n

    The CEV must not be the default for RDS Custom. If it is, change the default \n before running this command.

    \n
    • \n
  • \n

    The CEV must not be associated with an RDS Custom DB instance, RDS Custom instance snapshot, \n or automated backup of your RDS Custom instance.

    \n
    • \n
\n

Typically, deletion takes a few minutes.

\n \n

The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with \n Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the \n DeleteCustomDbEngineVersion event aren't logged. However, you might see calls from the \n API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for \n the DeleteCustomDbEngineVersion event.

\n \n

For more information, see Deleting a\n CEV in the Amazon RDS User Guide.

" + } + }, + "com.amazonaws.rds#DeleteCustomDBEngineVersionMessage": { + "type": "structure", + "members": { + "Engine": { + "target": "com.amazonaws.rds#CustomEngineName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The database engine. RDS Custom for Oracle supports the following values:

\n
    \n
  • \n

    \n custom-oracle-ee\n

    \n
    • \n
  • \n

    \n custom-oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n custom-oracle-se2\n

    \n
    • \n
  • \n

    \n custom-oracle-se2-cdb\n

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#CustomEngineVersion", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The custom engine version (CEV) for your DB instance. This option is required for \n RDS Custom, but optional for Amazon RDS. The combination of Engine and \n EngineVersion is unique per customer per Amazon Web Services Region.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DeleteDBCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteDBClusterMessage" + }, + "output": { + "target": "com.amazonaws.rds#DeleteDBClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterAutomatedBackupQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterSnapshotAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterSnapshotStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#SnapshotQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

The DeleteDBCluster action deletes a previously provisioned DB cluster. \n When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. \n Manual DB cluster snapshots of the specified DB cluster are not deleted.

\n

If you're deleting a Multi-AZ DB cluster with read replicas, all cluster members are\n terminated and read replicas are promoted to standalone instances.

\n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

", + "smithy.api#examples": [ + { + "title": "To delete a DB cluster", + "documentation": "The following example deletes the DB cluster named mycluster and takes a final snapshot named mycluster-final-snapshot. The status of the DB cluster is available while the snapshot is being taken. ", + "input": { + "DBClusterIdentifier": "mycluster", + "SkipFinalSnapshot": false, + "FinalDBSnapshotIdentifier": "mycluster-final-snapshot" + }, + "output": { + "DBCluster": { + "AllocatedStorage": 20, + "AvailabilityZones": [ + "eu-central-1b", + "eu-central-1c", + "eu-central-1a" + ], + "BackupRetentionPeriod": 7, + "DBClusterIdentifier": "mycluster", + "DBClusterParameterGroup": "default.aurora-postgresql10", + "DBSubnetGroup": "default-vpc-aa11bb22", + "Status": "available" + } + } + } + ] + } + }, + "com.amazonaws.rds#DeleteDBClusterAutomatedBackup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteDBClusterAutomatedBackupMessage" + }, + "output": { + "target": "com.amazonaws.rds#DeleteDBClusterAutomatedBackupResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterAutomatedBackupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterAutomatedBackupStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes automated backups using the DbClusterResourceId value of the source DB cluster or the Amazon \n Resource Name (ARN) of the automated backups.

" + } + }, + "com.amazonaws.rds#DeleteDBClusterAutomatedBackupMessage": { + "type": "structure", + "members": { + "DbClusterResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DeleteDBClusterAutomatedBackupResult": { + "type": "structure", + "members": { + "DBClusterAutomatedBackup": { + "target": "com.amazonaws.rds#DBClusterAutomatedBackup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DeleteDBClusterEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteDBClusterEndpointMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBClusterEndpoint" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterEndpointNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterEndpointStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.

\n \n

This action only applies to Aurora DB clusters.

\n ", + "smithy.api#examples": [ + { + "title": "To delete a custom DB cluster endpoint", + "documentation": "The following example deletes the specified custom DB cluster endpoint.", + "input": { + "DBClusterEndpointIdentifier": "mycustomendpoint" + }, + "output": { + "DBClusterEndpointIdentifier": "mycustomendpoint", + "DBClusterIdentifier": "mydbcluster", + "DBClusterEndpointResourceIdentifier": "cluster-endpoint-ANPAJ4AE5446DAEXAMPLE", + "Endpoint": "mycustomendpoint.cluster-custom-cnpexample.us-east-1.rds.amazonaws.com", + "Status": "deleting", + "EndpointType": "CUSTOM", + "CustomEndpointType": "READER", + "StaticMembers": [ + "dbinstance1", + "dbinstance2", + "dbinstance3" + ], + "ExcludedMembers": [], + "DBClusterEndpointArn": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:mycustomendpoint" + } + } + ] + } + }, + "com.amazonaws.rds#DeleteDBClusterEndpointMessage": { + "type": "structure", + "members": { + "DBClusterEndpointIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier associated with the custom endpoint. This parameter is stored as a lowercase string.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DeleteDBClusterMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must match an existing DBClusterIdentifier.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "SkipFinalSnapshot": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether to skip the creation of a final DB cluster snapshot before RDS\n deletes the DB cluster. If you set this value to true, RDS doesn't create a\n final DB cluster snapshot. If you set this value to false or don't specify\n it, RDS creates a DB cluster snapshot before it deletes the DB cluster. By default, this\n parameter is disabled, so RDS creates a final DB cluster snapshot.

\n \n

If SkipFinalSnapshot is disabled, you must specify a value for the\n FinalDBSnapshotIdentifier parameter.

\n " + } + }, + "FinalDBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot\n is disabled.

\n \n

If you specify this parameter and also skip the creation of a final DB cluster\n snapshot with the SkipFinalShapshot parameter, the request results in\n an error.

\n \n

Constraints:

\n
    \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
" + } + }, + "DeleteAutomatedBackups": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to remove automated backups immediately after the DB\n cluster is deleted. This parameter isn't case-sensitive. The default is to remove \n automated backups immediately after the DB cluster is deleted.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DeleteDBClusterParameterGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteDBClusterParameterGroupMessage" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBParameterGroupStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.

\n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

", + "smithy.api#examples": [ + { + "title": "To delete a DB cluster parameter group", + "documentation": "The following example deletes the specified DB cluster parameter group.", + "input": { + "DBClusterParameterGroupName": "mydbclusterparametergroup" + } + } + ] + } + }, + "com.amazonaws.rds#DeleteDBClusterParameterGroupMessage": { + "type": "structure", + "members": { + "DBClusterParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the DB cluster parameter group.

\n

Constraints:

\n
    \n
  • \n

    Must be the name of an existing DB cluster parameter group.

    \n
    • \n
  • \n

    You can't delete a default DB cluster parameter group.

    \n
    • \n
  • \n

    Can't be associated with any DB clusters.

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DeleteDBClusterResult": { + "type": "structure", + "members": { + "DBCluster": { + "target": "com.amazonaws.rds#DBCluster" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DeleteDBClusterSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteDBClusterSnapshotMessage" + }, + "output": { + "target": "com.amazonaws.rds#DeleteDBClusterSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterSnapshotStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.

\n \n

The DB cluster snapshot must be in the available state to be\n deleted.

\n \n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

", + "smithy.api#examples": [ + { + "title": "To delete a DB cluster snapshot", + "documentation": "", + "input": { + "DBClusterSnapshotIdentifier": "mydbclustersnapshot" + }, + "output": { + "DBClusterSnapshot": { + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1e" + ], + "DBClusterSnapshotIdentifier": "mydbclustersnapshot", + "DBClusterIdentifier": "mydbcluster", + "SnapshotCreateTime": "2019-06-18T21:21:00.469Z", + "Engine": "aurora-mysql", + "AllocatedStorage": 0, + "Status": "available", + "Port": 0, + "VpcId": "vpc-6594f31c", + "ClusterCreateTime": "2019-04-15T14:18:42.785Z", + "MasterUsername": "myadmin", + "EngineVersion": "5.7.mysql_aurora.2.04.2", + "LicenseModel": "aurora-mysql", + "SnapshotType": "manual", + "PercentProgress": 100, + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", + "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:mydbclustersnapshot", + "IAMDatabaseAuthenticationEnabled": false + } + } + } + ] + } + }, + "com.amazonaws.rds#DeleteDBClusterSnapshotMessage": { + "type": "structure", + "members": { + "DBClusterSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier of the DB cluster snapshot to delete.

\n

Constraints: Must be the name of an existing DB cluster snapshot in the available state.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DeleteDBClusterSnapshotResult": { + "type": "structure", + "members": { + "DBClusterSnapshot": { + "target": "com.amazonaws.rds#DBClusterSnapshot" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DeleteDBInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteDBInstanceMessage" + }, + "output": { + "target": "com.amazonaws.rds#DeleteDBInstanceResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceAutomatedBackupQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSnapshotAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#SnapshotQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a previously provisioned DB instance. \n When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. \n However, manual DB snapshots of the DB instance aren't deleted.

\n

If you request a final DB snapshot, the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. \n This operation can't be canceled or reverted after it begins. To monitor the status of this operation, use DescribeDBInstance.

\n

When a DB instance is in a failure state and has a status of failed, incompatible-restore, \n or incompatible-network, you can only delete it when you skip creation of the final snapshot with the SkipFinalSnapshot parameter.

\n

If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following\n conditions are true:

\n
    \n
  • \n

    The DB cluster is a read replica of another Amazon Aurora DB cluster.

    \n
    • \n
  • \n

    The DB instance is the only instance in the DB cluster.

    \n
    • \n
\n

To delete a DB instance in this case, first use the PromoteReadReplicaDBCluster operation to promote the DB cluster so that it's no longer a read replica. \n After the promotion completes, use the DeleteDBInstance operation to delete the final instance in the DB cluster.

\n \n

For RDS Custom DB instances, deleting the DB instance permanently deletes the EC2 instance and the associated EBS volumes. Make sure that you don't terminate or delete \n these resources before you delete the DB instance. Otherwise, deleting the DB instance and creation of the final snapshot might fail.

\n ", + "smithy.api#examples": [ + { + "title": "To delete a DB instance", + "documentation": "The following example deletes the specified DB instance after creating a final DB snapshot named test-instance-final-snap.", + "input": { + "DBInstanceIdentifier": "test-instance", + "SkipFinalSnapshot": false, + "FinalDBSnapshotIdentifier": "test-instance-final-snap" + }, + "output": { + "DBInstance": { + "DBInstanceIdentifier": "test-instance", + "DBInstanceStatus": "deleting" + } + } + } + ] + } + }, + "com.amazonaws.rds#DeleteDBInstanceAutomatedBackup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteDBInstanceAutomatedBackupMessage" + }, + "output": { + "target": "com.amazonaws.rds#DeleteDBInstanceAutomatedBackupResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceAutomatedBackupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceAutomatedBackupStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes automated backups using the DbiResourceId value of the source DB instance or the Amazon Resource Name (ARN) of the automated backups.

", + "smithy.api#examples": [ + { + "title": "To delete a replicated automated backup from a Region", + "documentation": "The following example deletes the automated backup with the specified Amazon Resource Name (ARN).", + "input": { + "DBInstanceAutomatedBackupsArn": "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example" + }, + "output": { + "DBInstanceAutomatedBackup": { + "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db", + "DbiResourceId": "db-JKIB2GFQ5RV7REPLZA4EXAMPLE", + "Region": "us-east-1", + "DBInstanceIdentifier": "new-orcl-db", + "RestoreWindow": {}, + "AllocatedStorage": 20, + "Status": "deleting", + "Port": 1521, + "AvailabilityZone": "us-east-1b", + "VpcId": "vpc-########", + "InstanceCreateTime": "2020-12-04T15:28:31Z", + "MasterUsername": "admin", + "Engine": "oracle-se2", + "EngineVersion": "12.1.0.2.v21", + "LicenseModel": "bring-your-own-license", + "OptionGroupName": "default:oracle-se2-12-1", + "Encrypted": false, + "StorageType": "gp2", + "IAMDatabaseAuthenticationEnabled": false, + "BackupRetentionPeriod": 7, + "DBInstanceAutomatedBackupsArn": "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example" + } + } + } + ] + } + }, + "com.amazonaws.rds#DeleteDBInstanceAutomatedBackupMessage": { + "type": "structure", + "members": { + "DbiResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

" + } + }, + "DBInstanceAutomatedBackupsArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the automated backups to delete, for example,\n arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

\n

This setting doesn't apply to RDS Custom.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Parameter input for the DeleteDBInstanceAutomatedBackup operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DeleteDBInstanceAutomatedBackupResult": { + "type": "structure", + "members": { + "DBInstanceAutomatedBackup": { + "target": "com.amazonaws.rds#DBInstanceAutomatedBackup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DeleteDBInstanceMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must match the name of an existing DB instance.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "SkipFinalSnapshot": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether to skip the creation of a final DB snapshot before deleting the instance.\n If you enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, \n RDS creates a DB snapshot before the DB instance is deleted. By default, skip isn't enabled, \n and the DB snapshot is created.

\n \n

If you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier parameter.

\n \n

When a DB instance is in a failure state and has a status of failed, incompatible-restore, \n or incompatible-network, RDS can delete the instance only if you enable this parameter.

\n

If you delete a read replica or an RDS Custom instance, you must enable this setting.

\n

This setting is required for RDS Custom.

" + } + }, + "FinalDBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot\n parameter is disabled.

\n \n

If you enable this parameter and also enable SkipFinalShapshot, the command results in an error.

\n \n

This setting doesn't apply to RDS Custom.

\n

Constraints:

\n
    \n
  • \n

    Must be 1 to 255 letters or numbers.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
  • \n

    Can't be specified when deleting a read replica.

    \n
    • \n
" + } + }, + "DeleteAutomatedBackups": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to remove automated backups immediately after the DB\n instance is deleted. This parameter isn't case-sensitive. The default is to remove \n automated backups immediately after the DB instance is deleted.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DeleteDBInstanceResult": { + "type": "structure", + "members": { + "DBInstance": { + "target": "com.amazonaws.rds#DBInstance" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DeleteDBParameterGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteDBParameterGroupMessage" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBParameterGroupStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances.

", + "smithy.api#examples": [ + { + "title": "To delete a DB parameter group", + "documentation": "The following example deletes a DB parameter group.", + "input": { + "DBParameterGroupName": "mydbparametergroup" + } + } + ] + } + }, + "com.amazonaws.rds#DeleteDBParameterGroupMessage": { + "type": "structure", + "members": { + "DBParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the DB parameter group.

\n

Constraints:

\n
    \n
  • \n

    Must be the name of an existing DB parameter group

    \n
    • \n
  • \n

    You can't delete a default DB parameter group

    \n
    • \n
  • \n

    Can't be associated with any DB instances

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DeleteDBProxy": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteDBProxyRequest" + }, + "output": { + "target": "com.amazonaws.rds#DeleteDBProxyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBProxyNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBProxyStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an existing DB proxy.

" + } + }, + "com.amazonaws.rds#DeleteDBProxyEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteDBProxyEndpointRequest" + }, + "output": { + "target": "com.amazonaws.rds#DeleteDBProxyEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBProxyEndpointNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBProxyEndpointStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a DBProxyEndpoint. Doing so removes the ability to access the DB proxy using the\n endpoint that you defined. The endpoint that you delete might have provided capabilities such as read/write\n or read-only operations, or using a different VPC than the DB proxy's default VPC.

" + } + }, + "com.amazonaws.rds#DeleteDBProxyEndpointRequest": { + "type": "structure", + "members": { + "DBProxyEndpointName": { + "target": "com.amazonaws.rds#DBProxyEndpointName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the DB proxy endpoint to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DeleteDBProxyEndpointResponse": { + "type": "structure", + "members": { + "DBProxyEndpoint": { + "target": "com.amazonaws.rds#DBProxyEndpoint", + "traits": { + "smithy.api#documentation": "

The data structure representing the details of the DB proxy endpoint that you delete.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DeleteDBProxyRequest": { + "type": "structure", + "members": { + "DBProxyName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the DB proxy to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DeleteDBProxyResponse": { + "type": "structure", + "members": { + "DBProxy": { + "target": "com.amazonaws.rds#DBProxy", + "traits": { + "smithy.api#documentation": "

The data structure representing the details of the DB proxy that you delete.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DeleteDBSecurityGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteDBSecurityGroupMessage" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSecurityGroupStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a DB security group.

\n

The specified DB security group must not be associated with any DB instances.

\n \n

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – \n Here’s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

\n ", + "smithy.api#examples": [ + { + "title": "To delete a DB security group", + "documentation": "The following example deletes a DB security group.", + "input": { + "DBSecurityGroupName": "mysecgroup" + } + } + ] + } + }, + "com.amazonaws.rds#DeleteDBSecurityGroupMessage": { + "type": "structure", + "members": { + "DBSecurityGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the DB security group to delete.

\n \n

You can't delete the default DB security group.

\n \n

Constraints:

\n
    \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
  • \n

    Must not be \"Default\"

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DeleteDBShardGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteDBShardGroupMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBShardGroup" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBShardGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBShardGroupStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an Aurora Limitless Database DB shard group.

" + } + }, + "com.amazonaws.rds#DeleteDBShardGroupMessage": { + "type": "structure", + "members": { + "DBShardGroupIdentifier": { + "target": "com.amazonaws.rds#DBShardGroupIdentifier", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the DB shard group to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DeleteDBSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteDBSnapshotMessage" + }, + "output": { + "target": "com.amazonaws.rds#DeleteDBSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSnapshotStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a DB snapshot. If the snapshot is being copied, the copy operation is\n terminated.

\n \n

The DB snapshot must be in the available state to be deleted.

\n ", + "smithy.api#examples": [ + { + "title": "To delete a DB snapshot", + "documentation": "The following example deletes the specified DB snapshot.", + "input": { + "DBSnapshotIdentifier": "mydbsnapshot" + }, + "output": { + "DBSnapshot": { + "DBSnapshotIdentifier": "mydbsnapshot", + "DBInstanceIdentifier": "database-mysql", + "SnapshotCreateTime": "2019-06-18T22:08:40.702Z", + "Engine": "mysql", + "AllocatedStorage": 100, + "Status": "deleted", + "Port": 3306, + "AvailabilityZone": "us-east-1b", + "VpcId": "vpc-6594f31c", + "InstanceCreateTime": "2019-04-30T15:45:53.663Z", + "MasterUsername": "admin", + "EngineVersion": "5.6.40", + "LicenseModel": "general-public-license", + "SnapshotType": "manual", + "Iops": 1000, + "OptionGroupName": "default:mysql-5-6", + "PercentProgress": 100, + "StorageType": "io1", + "Encrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", + "DBSnapshotArn": "arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshot", + "IAMDatabaseAuthenticationEnabled": false, + "ProcessorFeatures": [], + "DbiResourceId": "db-AKIAIOSFODNN7EXAMPLE" + } + } + } + ] + } + }, + "com.amazonaws.rds#DeleteDBSnapshotMessage": { + "type": "structure", + "members": { + "DBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The DB snapshot identifier.

\n

Constraints: Must be the name of an existing DB snapshot in the available state.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DeleteDBSnapshotResult": { + "type": "structure", + "members": { + "DBSnapshot": { + "target": "com.amazonaws.rds#DBSnapshot" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DeleteDBSubnetGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteDBSubnetGroupMessage" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSubnetGroupStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSubnetStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a DB subnet group.

\n \n

The specified database subnet group must not be associated with any DB instances.

\n ", + "smithy.api#examples": [ + { + "title": "To delete a DB subnet group", + "documentation": "The following example deletes the DB subnet group called mysubnetgroup.", + "input": { + "DBSubnetGroupName": "mysubnetgroup" + } + } + ] + } + }, + "com.amazonaws.rds#DeleteDBSubnetGroupMessage": { + "type": "structure", + "members": { + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the database subnet group to delete.

\n \n

You can't delete the default subnet group.

\n \n

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

\n

Example: mydbsubnetgroup\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DeleteEventSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteEventSubscriptionMessage" + }, + "output": { + "target": "com.amazonaws.rds#DeleteEventSubscriptionResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#InvalidEventSubscriptionStateFault" + }, + { + "target": "com.amazonaws.rds#SubscriptionNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an RDS event notification subscription.

", + "smithy.api#examples": [ + { + "title": "To delete an event subscription", + "documentation": "The following example deletes the specified event subscription.", + "input": { + "SubscriptionName": "my-instance-events" + }, + "output": { + "EventSubscription": { + "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events", + "CustomerAwsId": "123456789012", + "Enabled": false, + "SourceIdsList": [ + "test-instance" + ], + "SourceType": "db-instance", + "EventCategoriesList": [ + "backup", + "recovery" + ], + "SubscriptionCreationTime": "2018-07-31 23:22:01.893", + "CustSubscriptionId": "my-instance-events", + "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events", + "Status": "deleting" + } + } + } + ] + } + }, + "com.amazonaws.rds#DeleteEventSubscriptionMessage": { + "type": "structure", + "members": { + "SubscriptionName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the RDS event notification subscription you want to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DeleteEventSubscriptionResult": { + "type": "structure", + "members": { + "EventSubscription": { + "target": "com.amazonaws.rds#EventSubscription" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DeleteGlobalCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteGlobalClusterMessage" + }, + "output": { + "target": "com.amazonaws.rds#DeleteGlobalClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#GlobalClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidGlobalClusterStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a global database cluster. The primary and secondary clusters must already be detached or\n destroyed first.

\n \n

This action only applies to Aurora DB clusters.

\n ", + "smithy.api#examples": [ + { + "title": "To delete a global DB cluster", + "documentation": "The following example deletes an Aurora MySQL-compatible global DB cluster.", + "input": { + "GlobalClusterIdentifier": "myglobalcluster" + }, + "output": { + "GlobalCluster": { + "GlobalClusterIdentifier": "myglobalcluster", + "GlobalClusterResourceId": "cluster-f0e523bfe07aabb", + "GlobalClusterArn": "arn:aws:rds::123456789012:global-cluster:myglobalcluster", + "Status": "available", + "Engine": "aurora-mysql", + "EngineVersion": "5.7.mysql_aurora.2.07.2", + "StorageEncrypted": false, + "DeletionProtection": false, + "GlobalClusterMembers": [] + } + } + } + ] + } + }, + "com.amazonaws.rds#DeleteGlobalClusterMessage": { + "type": "structure", + "members": { + "GlobalClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The cluster identifier of the global database cluster being deleted.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DeleteGlobalClusterResult": { + "type": "structure", + "members": { + "GlobalCluster": { + "target": "com.amazonaws.rds#GlobalCluster" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DeleteIntegration": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteIntegrationMessage" + }, + "output": { + "target": "com.amazonaws.rds#Integration" + }, + "errors": [ + { + "target": "com.amazonaws.rds#IntegrationConflictOperationFault" + }, + { + "target": "com.amazonaws.rds#IntegrationNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidIntegrationStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a zero-ETL integration with Amazon Redshift.

", + "smithy.api#examples": [ + { + "title": "To delete a zero-ETL integration", + "documentation": "The following example deletes a zero-ETL integration with Amazon Redshift.", + "input": { + "IntegrationIdentifier": "5b9f3d79-7392-4a3e-896c-58eaa1b53231" + }, + "output": { + "SourceArn": "arn:aws:rds:us-east-1:123456789012:cluster:my-cluster", + "IntegrationName": "my-integration", + "IntegrationArn": "arn:aws:rds:us-east-1:123456789012:integration:5b9f3d79-7392-4a3e-896c-58eaa1b53231", + "TargetArn": "arn:aws:redshift-serverless:us-east-1:123456789012:namespace/62c70612-0302-4db7-8414-b5e3e049f0d8", + "Tags": [], + "CreateTime": "2023-12-28T17:20:20.629Z", + "KMSKeyId": "arn:aws:kms:us-east-1:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa", + "Status": "deleting" + } + } + ] + } + }, + "com.amazonaws.rds#DeleteIntegrationMessage": { + "type": "structure", + "members": { + "IntegrationIdentifier": { + "target": "com.amazonaws.rds#IntegrationIdentifier", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The unique identifier of the integration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DeleteOptionGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteOptionGroupMessage" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.rds#InvalidOptionGroupStateFault" + }, + { + "target": "com.amazonaws.rds#OptionGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an existing option group.

", + "smithy.api#examples": [ + { + "title": "To delete an option group", + "documentation": "The following example deletes the specified option group.", + "input": { + "OptionGroupName": "myoptiongroup" + } + } + ] + } + }, + "com.amazonaws.rds#DeleteOptionGroupMessage": { + "type": "structure", + "members": { + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the option group to be deleted.

\n \n

You can't delete default option groups.

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DeleteTenantDatabase": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteTenantDatabaseMessage" + }, + "output": { + "target": "com.amazonaws.rds#DeleteTenantDatabaseResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#TenantDatabaseNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a tenant database from your DB instance. This command only applies to RDS for\n Oracle container database (CDB) instances.

\n

You can't delete a tenant database when it is the only tenant in the DB\n instance.

" + } + }, + "com.amazonaws.rds#DeleteTenantDatabaseMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The user-supplied identifier for the DB instance that contains the tenant database\n that you want to delete.

", + "smithy.api#required": {} + } + }, + "TenantDBName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The user-supplied name of the tenant database that you want to remove from your DB\n instance. Amazon RDS deletes the tenant database with this name. This parameter isn’t\n case-sensitive.

", + "smithy.api#required": {} + } + }, + "SkipFinalSnapshot": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether to skip the creation of a final DB snapshot before removing the\n tenant database from your DB instance. If you enable this parameter, RDS doesn't create\n a DB snapshot. If you don't enable this parameter, RDS creates a DB snapshot before it\n deletes the tenant database. By default, RDS doesn't skip the final snapshot. If you\n don't enable this parameter, you must specify the FinalDBSnapshotIdentifier\n parameter.

" + } + }, + "FinalDBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DBSnapshotIdentifier of the new DBSnapshot created when\n the SkipFinalSnapshot parameter is disabled.

\n \n

If you enable this parameter and also enable SkipFinalShapshot, the\n command results in an error.

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DeleteTenantDatabaseResult": { + "type": "structure", + "members": { + "TenantDatabase": { + "target": "com.amazonaws.rds#TenantDatabase" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DeregisterDBProxyTargets": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeregisterDBProxyTargetsRequest" + }, + "output": { + "target": "com.amazonaws.rds#DeregisterDBProxyTargetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBProxyNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBProxyTargetNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBProxyStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Remove the association between one or more DBProxyTarget data structures and a DBProxyTargetGroup.

" + } + }, + "com.amazonaws.rds#DeregisterDBProxyTargetsRequest": { + "type": "structure", + "members": { + "DBProxyName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier of the DBProxy that is associated with the DBProxyTargetGroup.

", + "smithy.api#required": {} + } + }, + "TargetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the DBProxyTargetGroup.

" + } + }, + "DBInstanceIdentifiers": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

One or more DB instance identifiers.

" + } + }, + "DBClusterIdentifiers": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

One or more DB cluster identifiers.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DeregisterDBProxyTargetsResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DescribeAccountAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeAccountAttributesMessage" + }, + "output": { + "target": "com.amazonaws.rds#AccountAttributesMessage" + }, + "traits": { + "smithy.api#documentation": "

Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.

\n

This command doesn't take any parameters.

", + "smithy.api#examples": [ + { + "title": "To describe account attributes", + "documentation": "The following example retrieves the attributes for the current AWS account.", + "output": { + "AccountQuotas": [ + { + "Max": 40, + "Used": 4, + "AccountQuotaName": "DBInstances" + }, + { + "Max": 40, + "Used": 0, + "AccountQuotaName": "ReservedDBInstances" + }, + { + "Max": 100000, + "Used": 40, + "AccountQuotaName": "AllocatedStorage" + }, + { + "Max": 25, + "Used": 0, + "AccountQuotaName": "DBSecurityGroups" + }, + { + "Max": 20, + "Used": 0, + "AccountQuotaName": "AuthorizationsPerDBSecurityGroup" + }, + { + "Max": 50, + "Used": 1, + "AccountQuotaName": "DBParameterGroups" + }, + { + "Max": 100, + "Used": 3, + "AccountQuotaName": "ManualSnapshots" + }, + { + "Max": 20, + "Used": 0, + "AccountQuotaName": "EventSubscriptions" + }, + { + "Max": 50, + "Used": 1, + "AccountQuotaName": "DBSubnetGroups" + }, + { + "Max": 20, + "Used": 1, + "AccountQuotaName": "OptionGroups" + }, + { + "Max": 20, + "Used": 6, + "AccountQuotaName": "SubnetsPerDBSubnetGroup" + }, + { + "Max": 5, + "Used": 0, + "AccountQuotaName": "ReadReplicasPerMaster" + }, + { + "Max": 40, + "Used": 1, + "AccountQuotaName": "DBClusters" + }, + { + "Max": 50, + "Used": 0, + "AccountQuotaName": "DBClusterParameterGroups" + }, + { + "Max": 5, + "Used": 0, + "AccountQuotaName": "DBClusterRoles" + } + ] + } + } + ] + } + }, + "com.amazonaws.rds#DescribeAccountAttributesMessage": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeBlueGreenDeployments": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeBlueGreenDeploymentsRequest" + }, + "output": { + "target": "com.amazonaws.rds#DescribeBlueGreenDeploymentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#BlueGreenDeploymentNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Describes one or more blue/green deployments.

\n

For more information, see Using Amazon RDS Blue/Green Deployments \n for database updates in the Amazon RDS User Guide and \n \n Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora \n User Guide.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "BlueGreenDeployments", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeBlueGreenDeploymentsRequest": { + "type": "structure", + "members": { + "BlueGreenDeploymentIdentifier": { + "target": "com.amazonaws.rds#BlueGreenDeploymentIdentifier", + "traits": { + "smithy.api#documentation": "

The blue/green deployment identifier. If you specify this parameter, the response only\n includes information about the specific blue/green deployment. This parameter isn't\n case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must match an existing blue/green deployment identifier.

    \n
    • \n
" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

A filter that specifies one or more blue/green deployments to describe.

\n

Valid Values:

\n
    \n
  • \n

    \n blue-green-deployment-identifier - Accepts system-generated\n identifiers for blue/green deployments. The results list only includes\n information about the blue/green deployments with the specified\n identifiers.

    \n
    • \n
  • \n

    \n blue-green-deployment-name - Accepts user-supplied names for blue/green deployments. \n The results list only includes information about the blue/green deployments with the \n specified names.

    \n
    • \n
  • \n

    \n source - Accepts source databases for a blue/green deployment. \n The results list only includes information about the blue/green deployments with \n the specified source databases.

    \n
    • \n
  • \n

    \n target - Accepts target databases for a blue/green deployment. \n The results list only includes information about the blue/green deployments with \n the specified target databases.

    \n
    • \n
" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeBlueGreenDeployments request. If you specify this parameter,\n the response only includes records beyond the marker, up to the value specified by\n MaxRecords.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#MaxRecords", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints:

\n
    \n
  • \n

    Must be a minimum of 20.

    \n
    • \n
  • \n

    Can't exceed 100.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeBlueGreenDeploymentsResponse": { + "type": "structure", + "members": { + "BlueGreenDeployments": { + "target": "com.amazonaws.rds#BlueGreenDeploymentList", + "traits": { + "smithy.api#documentation": "

A list of blue/green deployments in the current account and Amazon Web Services Region.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a later\n DescribeBlueGreenDeployments request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DescribeCertificates": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeCertificatesMessage" + }, + "output": { + "target": "com.amazonaws.rds#CertificateMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#CertificateNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the set of certificate authority (CA) certificates provided by Amazon RDS for this Amazon Web Services account.

\n

For more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Certificates", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeCertificatesMessage": { + "type": "structure", + "members": { + "CertificateIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The user-supplied certificate identifier. If this parameter is specified, information for only the identified certificate is returned. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must match an existing CertificateIdentifier.

    \n
    • \n
" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeCertificates request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBClusterAutomatedBackups": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBClusterAutomatedBackupsMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBClusterAutomatedBackupMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterAutomatedBackupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Displays backups for both current and deleted DB clusters. For example, use this operation to find details \n about automated backups for previously deleted clusters. Current clusters are returned for both the \n DescribeDBClusterAutomatedBackups and DescribeDBClusters operations.

\n

All parameters are optional.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBClusterAutomatedBackups", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeDBClusterAutomatedBackupsMessage": { + "type": "structure", + "members": { + "DbClusterResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The resource ID of the DB cluster that is the source of the automated backup. This parameter isn't case-sensitive.

" + } + }, + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

(Optional) The user-supplied DB cluster identifier. If this parameter is specified, it must\n match the identifier of an existing DB cluster. It returns information from the\n specific DB cluster's automated backup. This parameter isn't case-sensitive.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

A filter that specifies which resources to return based on status.

\n

Supported filters are the following:

\n
    \n
  • \n

    \n status\n

    \n
      \n
    • \n

      \n retained - Automated backups for deleted clusters and after backup replication is stopped.

      \n
      • \n
    \n
    • \n
  • \n

    \n db-cluster-id - Accepts DB cluster identifiers and Amazon Resource Names (ARNs). \n The results list includes only information about the DB cluster automated backups identified by these ARNs.

    \n
    • \n
  • \n

    \n db-cluster-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). \n The results list includes only information about the DB cluster resources identified by these ARNs.

    \n
    • \n
\n

Returns all resources by default. The status for each resource is specified in the response.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified MaxRecords \n value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The pagination token provided in the previous request. If this parameter is specified the response includes only \n records beyond the marker, up to MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBClusterBacktracks": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBClusterBacktracksMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBClusterBacktrackMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterBacktrackNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about backtracks for a DB cluster.

\n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n \n

This action only applies to Aurora MySQL DB clusters.

\n ", + "smithy.api#examples": [ + { + "title": "To describe backtracks for a DB cluster", + "documentation": "The following example retrieves details about the specified DB cluster.", + "input": { + "DBClusterIdentifier": "mydbcluster" + }, + "output": { + "DBClusterBacktracks": [ + { + "DBClusterIdentifier": "mydbcluster", + "BacktrackIdentifier": "2f5f5294-0dd2-44c9-9f50-EXAMPLE", + "BacktrackTo": "2021-02-12T04:59:22Z", + "BacktrackedFrom": "2021-02-12T14:37:31.640Z", + "BacktrackRequestCreationTime": "2021-02-12T14:36:18.819Z", + "Status": "COMPLETED" + }, + { + "DBClusterIdentifier": "mydbcluster", + "BacktrackIdentifier": "3c7a6421-af2a-4ea3-ae95-EXAMPLE", + "BacktrackTo": "2021-02-11T22:53:46Z", + "BacktrackedFrom": "2021-02-12T00:09:27.006Z", + "BacktrackRequestCreationTime": "2021-02-12T00:07:53.487Z", + "Status": "COMPLETED" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBClusterBacktracks", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeDBClusterBacktracksMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The DB cluster identifier of the DB cluster to be described. This parameter is\n stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 alphanumeric characters or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Example: my-cluster1\n

", + "smithy.api#required": {} + } + }, + "BacktrackIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

If specified, this value is the backtrack identifier of the backtrack to be\n described.

\n

Constraints:

\n \n

Example: 123e4567-e89b-12d3-a456-426655440000\n

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

A filter that specifies one or more DB clusters to describe. Supported filters\n include the following:

\n
    \n
  • \n

    \n db-cluster-backtrack-id - Accepts backtrack identifiers. The\n results list includes information about only the backtracks identified by these\n identifiers.

    \n
    • \n
  • \n

    \n db-cluster-backtrack-status - Accepts any of the following backtrack status values:

    \n
      \n
    • \n

      \n applying\n

      \n
      • \n
    • \n

      \n completed\n

      \n
      • \n
    • \n

      \n failed\n

      \n
      • \n
    • \n

      \n pending\n

      \n
      • \n
    \n

    The results list includes information about only the backtracks identified\n by these values.

    \n
    • \n
" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterBacktracks request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBClusterEndpoints": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBClusterEndpointsMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBClusterEndpointMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about endpoints for an Amazon Aurora DB cluster.

\n \n

This action only applies to Aurora DB clusters.

\n ", + "smithy.api#examples": [ + { + "title": "To describe DB cluster endpoints", + "documentation": "The following example retrieves details for your DB cluster endpoints. The most common kinds of Aurora clusters have two endpoints. One endpoint has type WRITER. You can use this endpoint for all SQL statements. The other endpoint has type READER. You can use this endpoint only for SELECT and other read-only SQL statements.", + "output": { + "DBClusterEndpoints": [ + { + "DBClusterIdentifier": "my-database-1", + "Endpoint": "my-database-1.cluster-cnpexample.us-east-1.rds.amazonaws.com", + "Status": "creating", + "EndpointType": "WRITER" + }, + { + "DBClusterIdentifier": "my-database-1", + "Endpoint": "my-database-1.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com", + "Status": "creating", + "EndpointType": "READER" + }, + { + "DBClusterIdentifier": "mydbcluster", + "Endpoint": "mydbcluster.cluster-cnpexamle.us-east-1.rds.amazonaws.com", + "Status": "available", + "EndpointType": "WRITER" + }, + { + "DBClusterIdentifier": "mydbcluster", + "Endpoint": "mydbcluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com", + "Status": "available", + "EndpointType": "READER" + } + ] + } + }, + { + "title": "To describe DB cluster endpoints of a single DB cluster", + "documentation": "The following example retrieves details for the DB cluster endpoints of a single specified DB cluster. Aurora Serverless clusters have only a single endpoint with a type of WRITER.", + "input": { + "DBClusterIdentifier": "serverless-cluster" + }, + "output": { + "DBClusterEndpoints": [ + { + "Status": "available", + "Endpoint": "serverless-cluster.cluster-cnpexample.us-east-1.rds.amazonaws.com", + "DBClusterIdentifier": "serverless-cluster", + "EndpointType": "WRITER" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBClusterEndpoints", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeDBClusterEndpointsMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is\n stored as a lowercase string.

" + } + }, + "DBClusterEndpointIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the endpoint to describe. This parameter is stored as a lowercase string.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

A set of name-value pairs that define which endpoints to include in the output.\n The filters are specified as name-value pairs, in the format\n Name=endpoint_type,Values=endpoint_type1,endpoint_type2,....\n Name can be one of: db-cluster-endpoint-type, db-cluster-endpoint-custom-type, db-cluster-endpoint-id, db-cluster-endpoint-status.\n Values for the db-cluster-endpoint-type filter can be one or more of: reader, writer, custom.\n Values for the db-cluster-endpoint-custom-type filter can be one or more of: reader, any.\n Values for the db-cluster-endpoint-status filter can be one or more of: available, creating, deleting, inactive, modifying.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterEndpoints request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBClusterParameterGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBClusterParameterGroupsMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBClusterParameterGroupsMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of DBClusterParameterGroup descriptions. If a \n DBClusterParameterGroupName parameter is specified,\n the list will contain only the description of the specified DB cluster parameter group.

\n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

", + "smithy.api#examples": [ + { + "title": "To describe DB cluster parameter groups", + "documentation": "The following example retrieves details for your DB cluster parameter groups.", + "output": { + "DBClusterParameterGroups": [ + { + "DBClusterParameterGroupName": "default.aurora-mysql5.7", + "DBParameterGroupFamily": "aurora-mysql5.7", + "Description": "Default cluster parameter group for aurora-mysql5.7", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:default.aurora-mysql5.7" + }, + { + "DBClusterParameterGroupName": "default.aurora-postgresql9.6", + "DBParameterGroupFamily": "aurora-postgresql9.6", + "Description": "Default cluster parameter group for aurora-postgresql9.6", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:default.aurora-postgresql9.6" + }, + { + "DBClusterParameterGroupName": "default.aurora5.6", + "DBParameterGroupFamily": "aurora5.6", + "Description": "Default cluster parameter group for aurora5.6", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:default.aurora5.6" + }, + { + "DBClusterParameterGroupName": "mydbclusterpg", + "DBParameterGroupFamily": "aurora-mysql5.7", + "Description": "My DB cluster parameter group", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterpg" + }, + { + "DBClusterParameterGroupName": "mydbclusterpgcopy", + "DBParameterGroupFamily": "aurora-mysql5.7", + "Description": "Copy of mydbclusterpg parameter group", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterpgcopy" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBClusterParameterGroups", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeDBClusterParameterGroupsMessage": { + "type": "structure", + "members": { + "DBClusterParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of a specific DB cluster parameter group to return details for.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBClusterParameterGroup.

    \n
    • \n
" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterParameterGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBClusterParameters": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBClusterParametersMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBClusterParameterGroupDetails" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the detailed parameter list for a particular DB cluster parameter group.

\n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

", + "smithy.api#examples": [ + { + "title": "To describe the parameters in a DB cluster parameter group", + "documentation": "The following example retrieves details about the parameters in a DB cluster parameter group.", + "input": { + "DBClusterParameterGroupName": "mydbclusterpg" + }, + "output": { + "Parameters": [ + { + "ParameterName": "allow-suspicious-udfs", + "Description": "Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded", + "Source": "engine-default", + "ApplyType": "static", + "DataType": "boolean", + "AllowedValues": "0,1", + "IsModifiable": false, + "ApplyMethod": "pending-reboot", + "SupportedEngineModes": [ + "provisioned" + ] + }, + { + "ParameterName": "aurora_lab_mode", + "ParameterValue": "0", + "Description": "Enables new features in the Aurora engine.", + "Source": "engine-default", + "ApplyType": "static", + "DataType": "boolean", + "AllowedValues": "0,1", + "IsModifiable": true, + "ApplyMethod": "pending-reboot", + "SupportedEngineModes": [ + "provisioned" + ] + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Parameters", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeDBClusterParametersMessage": { + "type": "structure", + "members": { + "DBClusterParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of a specific DB cluster parameter group to return parameter details for.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBClusterParameterGroup.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Source": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A specific source to return parameters for.

\n

Valid Values:

\n
    \n
  • \n

    \n engine-default\n

    \n
    • \n
  • \n

    \n system\n

    \n
    • \n
  • \n

    \n user\n

    \n
    • \n
" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

A filter that specifies one or more DB cluster parameters to describe.

\n

The only supported filter is parameter-name. The results list only includes information about the DB cluster parameters with these names.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBClusterSnapshotAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBClusterSnapshotAttributesMessage" + }, + "output": { + "target": "com.amazonaws.rds#DescribeDBClusterSnapshotAttributesResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.

\n

When sharing snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes\n returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are \n authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of\n values for the restore attribute, then the manual DB cluster snapshot is public and\n can be copied or restored by all Amazon Web Services accounts.

\n

To add or remove access for an Amazon Web Services account to copy or restore a manual DB cluster snapshot, or to make the\n manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.

", + "smithy.api#examples": [ + { + "title": "To describe the attribute names and values for a DB cluster snapshot", + "documentation": "The following example retrieves details of the attribute names and values for the specified DB cluster snapshot.", + "input": { + "DBClusterSnapshotIdentifier": "myclustersnapshot" + }, + "output": { + "DBClusterSnapshotAttributesResult": { + "DBClusterSnapshotIdentifier": "myclustersnapshot", + "DBClusterSnapshotAttributes": [ + { + "AttributeName": "restore", + "AttributeValues": [ + "123456789012" + ] + } + ] + } + } + } + ] + } + }, + "com.amazonaws.rds#DescribeDBClusterSnapshotAttributesMessage": { + "type": "structure", + "members": { + "DBClusterSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier for the DB cluster snapshot to describe the attributes for.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBClusterSnapshotAttributesResult": { + "type": "structure", + "members": { + "DBClusterSnapshotAttributesResult": { + "target": "com.amazonaws.rds#DBClusterSnapshotAttributesResult" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DescribeDBClusterSnapshots": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBClusterSnapshotsMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBClusterSnapshotMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about DB cluster snapshots. This API action supports pagination.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

", + "smithy.api#examples": [ + { + "title": "To describe a DB cluster snapshot for a DB cluster", + "documentation": "The following example retrieves the details for the DB cluster snapshots for the specified DB cluster.", + "input": { + "DBClusterIdentifier": "mydbcluster" + }, + "output": { + "DBClusterSnapshots": [ + { + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1e" + ], + "DBClusterSnapshotIdentifier": "myclustersnapshotcopy", + "DBClusterIdentifier": "mydbcluster", + "SnapshotCreateTime": "2019-06-04T09:16:42.649Z", + "Engine": "aurora-mysql", + "AllocatedStorage": 0, + "Status": "available", + "Port": 0, + "VpcId": "vpc-6594f31c", + "ClusterCreateTime": "2019-04-15T14:18:42.785Z", + "MasterUsername": "myadmin", + "EngineVersion": "5.7.mysql_aurora.2.04.2", + "LicenseModel": "aurora-mysql", + "SnapshotType": "manual", + "PercentProgress": 100, + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", + "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:814387698303:cluster-snapshot:myclustersnapshotcopy", + "IAMDatabaseAuthenticationEnabled": false + }, + { + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1e" + ], + "DBClusterSnapshotIdentifier": "rds:mydbcluster-2019-06-20-09-16", + "DBClusterIdentifier": "mydbcluster", + "SnapshotCreateTime": "2019-06-20T09:16:26.569Z", + "Engine": "aurora-mysql", + "AllocatedStorage": 0, + "Status": "available", + "Port": 0, + "VpcId": "vpc-6594f31c", + "ClusterCreateTime": "2019-04-15T14:18:42.785Z", + "MasterUsername": "myadmin", + "EngineVersion": "5.7.mysql_aurora.2.04.2", + "LicenseModel": "aurora-mysql", + "SnapshotType": "automated", + "PercentProgress": 100, + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:814387698303:key/AKIAIOSFODNN7EXAMPLE", + "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:rds:mydbcluster-2019-06-20-09-16", + "IAMDatabaseAuthenticationEnabled": false + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBClusterSnapshots", + "pageSize": "MaxRecords" + }, + "smithy.waiters#waitable": { + "DBClusterSnapshotAvailable": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "DBClusterSnapshots[].Status", + "expected": "available", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusterSnapshots[].Status", + "expected": "deleted", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusterSnapshots[].Status", + "expected": "deleting", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusterSnapshots[].Status", + "expected": "failed", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusterSnapshots[].Status", + "expected": "incompatible-restore", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusterSnapshots[].Status", + "expected": "incompatible-parameters", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 30 + }, + "DBClusterSnapshotDeleted": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "length(DBClusterSnapshots) == `0`", + "expected": "true", + "comparator": "booleanEquals" + } + } + }, + { + "state": "success", + "matcher": { + "errorType": "DBClusterSnapshotNotFoundFault" + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusterSnapshots[].Status", + "expected": "creating", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusterSnapshots[].Status", + "expected": "modifying", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusterSnapshots[].Status", + "expected": "rebooting", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusterSnapshots[].Status", + "expected": "resetting-master-credentials", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 30 + } + } + } + }, + "com.amazonaws.rds#DescribeDBClusterSnapshotsMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ID of the DB cluster to retrieve the list of DB cluster snapshots for. \n This parameter can't be used in conjunction with the\n DBClusterSnapshotIdentifier parameter.\n This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the identifier of an existing DBCluster.

    \n
    • \n
" + } + }, + "DBClusterSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A specific DB cluster snapshot identifier to describe. \n This parameter can't be used in conjunction with the\n DBClusterIdentifier parameter. \n This value is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the identifier of an existing DBClusterSnapshot.

    \n
    • \n
  • \n

    If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

    \n
    • \n
" + } + }, + "SnapshotType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The type of DB cluster snapshots to be returned. You can specify one of the following values:

\n
    \n
  • \n

    \n automated - Return all DB cluster snapshots that have been automatically taken by \n Amazon RDS for my Amazon Web Services account.

    \n
    • \n
  • \n

    \n manual - Return all DB cluster snapshots that have been taken by my Amazon Web Services account.

    \n
    • \n
  • \n

    \n shared - Return all manual DB cluster snapshots that have been shared to my Amazon Web Services account.

    \n
    • \n
  • \n

    \n public - Return all DB cluster snapshots that have been marked as public.

    \n
    • \n
\n

If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are\n returned. You can include shared DB cluster snapshots with these results by enabling the IncludeShared\n parameter. You can include public DB cluster snapshots with these results by enabling the \n IncludePublic parameter.

\n

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values\n of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is\n set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to\n public.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

A filter that specifies one or more DB cluster snapshots to describe.

\n

Supported filters:

\n
    \n
  • \n

    \n db-cluster-id - Accepts DB cluster identifiers and DB \n cluster Amazon Resource Names (ARNs).

    \n
    • \n
  • \n

    \n db-cluster-snapshot-id - Accepts DB cluster snapshot identifiers.

    \n
    • \n
  • \n

    \n snapshot-type - Accepts types of DB cluster snapshots.

    \n
    • \n
  • \n

    \n engine - Accepts names of database engines.

    \n
    • \n
" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterSnapshots request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "IncludeShared": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether to include shared manual DB cluster snapshots \n from other Amazon Web Services accounts that this Amazon Web Services account has been given \n permission to copy or restore. By default, these snapshots are not included.

\n

You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from\n another Amazon Web Services account by the ModifyDBClusterSnapshotAttribute API action.

" + } + }, + "IncludePublic": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether to include manual DB cluster snapshots that are public and can be copied \n or restored by any Amazon Web Services account. By default, the public snapshots are not included.

\n

You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

" + } + }, + "DbClusterResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A specific DB cluster resource ID to describe.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBClusters": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBClustersMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBClusterMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Describes existing Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

\n

This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

", + "smithy.api#examples": [ + { + "title": "To describe a DB cluster", + "documentation": "The following example retrieves the details of the specified DB cluster.", + "input": { + "DBClusterIdentifier": "mydbcluster" + }, + "output": { + "DBClusters": [ + { + "AllocatedStorage": 1, + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1e" + ], + "BackupRetentionPeriod": 1, + "DatabaseName": "mydbcluster", + "DBClusterIdentifier": "mydbcluster", + "DBClusterParameterGroup": "default.aurora-mysql5.7", + "DBSubnetGroup": "default", + "Status": "available", + "EarliestRestorableTime": "2019-06-19T09:16:28.210Z", + "Endpoint": "mydbcluster.cluster-cnpexample.us-east-1.rds.amazonaws.com", + "ReaderEndpoint": "mydbcluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com", + "MultiAZ": true, + "Engine": "aurora-mysql", + "EngineVersion": "5.7.mysql_aurora.2.04.2", + "LatestRestorableTime": "2019-06-20T22:38:14.908Z", + "Port": 3306, + "MasterUsername": "myadmin", + "PreferredBackupWindow": "09:09-09:39", + "PreferredMaintenanceWindow": "sat:04:09-sat:04:39", + "ReadReplicaIdentifiers": [], + "DBClusterMembers": [ + { + "DBInstanceIdentifier": "dbinstance3", + "IsClusterWriter": false, + "DBClusterParameterGroupStatus": "in-sync", + "PromotionTier": 1 + }, + { + "DBInstanceIdentifier": "dbinstance1", + "IsClusterWriter": false, + "DBClusterParameterGroupStatus": "in-sync", + "PromotionTier": 1 + }, + { + "DBInstanceIdentifier": "dbinstance2", + "IsClusterWriter": false, + "DBClusterParameterGroupStatus": "in-sync", + "PromotionTier": 1 + }, + { + "DBInstanceIdentifier": "mydbcluster", + "IsClusterWriter": false, + "DBClusterParameterGroupStatus": "in-sync", + "PromotionTier": 1 + }, + { + "DBInstanceIdentifier": "mydbcluster-us-east-1b", + "IsClusterWriter": false, + "DBClusterParameterGroupStatus": "in-sync", + "PromotionTier": 1 + }, + { + "DBInstanceIdentifier": "mydbcluster", + "IsClusterWriter": true, + "DBClusterParameterGroupStatus": "in-sync", + "PromotionTier": 1 + } + ], + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-0b9130572daf3dc16", + "Status": "active" + } + ], + "HostedZoneId": "Z2R2ITUGPM61AM", + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:814387698303:key/AKIAIOSFODNN7EXAMPLE", + "DbClusterResourceId": "cluster-AKIAIOSFODNN7EXAMPLE", + "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:mydbcluster", + "AssociatedRoles": [], + "IAMDatabaseAuthenticationEnabled": false, + "ClusterCreateTime": "2019-04-15T14:18:42.785Z", + "EngineMode": "provisioned", + "DeletionProtection": false, + "HttpEndpointEnabled": false + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBClusters", + "pageSize": "MaxRecords" + }, + "smithy.waiters#waitable": { + "DBClusterAvailable": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "DBClusters[].Status", + "expected": "available", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusters[].Status", + "expected": "deleted", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusters[].Status", + "expected": "deleting", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusters[].Status", + "expected": "failed", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusters[].Status", + "expected": "incompatible-restore", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusters[].Status", + "expected": "incompatible-parameters", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 30 + }, + "DBClusterDeleted": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "length(DBClusters) == `0`", + "expected": "true", + "comparator": "booleanEquals" + } + } + }, + { + "state": "success", + "matcher": { + "errorType": "DBClusterNotFoundFault" + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusters[].Status", + "expected": "creating", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusters[].Status", + "expected": "modifying", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusters[].Status", + "expected": "rebooting", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusters[].Status", + "expected": "resetting-master-credentials", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 30 + } + } + } + }, + "com.amazonaws.rds#DescribeDBClustersMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster. If this parameter is specified, \n information for only the specific DB cluster is returned. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match an existing DB cluster identifier.

    \n
    • \n
" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

A filter that specifies one or more DB clusters to describe.

\n

Supported Filters:

\n
    \n
  • \n

    \n clone-group-id - Accepts clone group identifiers. \n The results list only includes information about\n the DB clusters associated with these clone groups.

    \n
    • \n
  • \n

    \n db-cluster-id - Accepts DB cluster identifiers and DB \n cluster Amazon Resource Names (ARNs). The results list only includes information about\n the DB clusters identified by these ARNs.

    \n
    • \n
  • \n

    \n db-cluster-resource-id - Accepts DB cluster resource identifiers.\n The results list will only include information about the DB clusters identified\n by these DB cluster resource identifiers.

    \n
    • \n
  • \n

    \n domain - Accepts Active Directory directory IDs. \n The results list only includes information about\n the DB clusters associated with these domains.

    \n
    • \n
  • \n

    \n engine - Accepts engine names. \n The results list only includes information about\n the DB clusters for these engines.

    \n
    • \n
" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "IncludeShared": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the output includes information about clusters\n shared from other Amazon Web Services accounts.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBEngineVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBEngineVersionsMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBEngineVersionMessage" + }, + "traits": { + "smithy.api#documentation": "

Describes the properties of specific versions of DB engines.

", + "smithy.api#examples": [ + { + "title": "To describe the DB engine versions for the MySQL DB engine", + "documentation": "The following example displays details about each of the DB engine versions for the specified DB engine.", + "input": { + "Engine": "mysql" + }, + "output": { + "DBEngineVersions": [ + { + "Engine": "mysql", + "EngineVersion": "5.7.33", + "DBParameterGroupFamily": "mysql5.7", + "DBEngineDescription": "MySQL Community Edition", + "DBEngineVersionDescription": "MySQL 5.7.33", + "ValidUpgradeTarget": [ + { + "Engine": "mysql", + "EngineVersion": "5.7.34", + "Description": "MySQL 5.7.34", + "AutoUpgrade": false, + "IsMajorVersionUpgrade": false + }, + { + "Engine": "mysql", + "EngineVersion": "5.7.36", + "Description": "MySQL 5.7.36", + "AutoUpgrade": false, + "IsMajorVersionUpgrade": false + } + ] + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBEngineVersions", + "pageSize": "MaxRecords" + }, + "smithy.test#smokeTests": [ + { + "id": "DescribeDBEngineVersionsSuccess", + "params": {}, + "vendorParams": { + "region": "us-west-2" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "success": {} + } + } + ] + } + }, + "com.amazonaws.rds#DescribeDBEngineVersionsMessage": { + "type": "structure", + "members": { + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The database engine to return version details for.

\n

Valid Values:

\n
    \n
  • \n

    \n aurora-mysql\n

    \n
    • \n
  • \n

    \n aurora-postgresql\n

    \n
    • \n
  • \n

    \n custom-oracle-ee\n

    \n
    • \n
  • \n

    \n custom-oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n custom-oracle-se2\n

    \n
    • \n
  • \n

    \n custom-oracle-se2-cdb\n

    \n
    • \n
  • \n

    \n db2-ae\n

    \n
    • \n
  • \n

    \n db2-se\n

    \n
    • \n
  • \n

    \n mariadb\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n oracle-ee\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n oracle-se2\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
  • \n

    \n sqlserver-ee\n

    \n
    • \n
  • \n

    \n sqlserver-se\n

    \n
    • \n
  • \n

    \n sqlserver-ex\n

    \n
    • \n
  • \n

    \n sqlserver-web\n

    \n
    • \n
" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A specific database engine version to return details for.

\n

Example: 5.1.49\n

" + } + }, + "DBParameterGroupFamily": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of a specific DB parameter group family to return details for.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match an existing DB parameter group family.

    \n
    • \n
" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

A filter that specifies one or more DB engine versions to describe.

\n

Supported filters:

\n
    \n
  • \n

    \n db-parameter-group-family - Accepts parameter groups family names. \n The results list only includes information about\n the DB engine versions for these parameter group families.

    \n
    • \n
  • \n

    \n engine - Accepts engine names. \n The results list only includes information about\n the DB engine versions for these engines.

    \n
    • \n
  • \n

    \n engine-mode - Accepts DB engine modes. \n The results list only includes information about\n the DB engine versions for these engine modes. Valid \n DB engine modes are the following:

    \n
      \n
    • \n

      \n global\n

      \n
      • \n
    • \n

      \n multimaster\n

      \n
      • \n
    • \n

      \n parallelquery\n

      \n
      • \n
    • \n

      \n provisioned\n

      \n
      • \n
    • \n

      \n serverless\n

      \n
      • \n
    \n
    • \n
  • \n

    \n engine-version - Accepts engine versions. \n The results list only includes information about\n the DB engine versions for these engine versions.

    \n
    • \n
  • \n

    \n status - Accepts engine version statuses. \n The results list only includes information about\n the DB engine versions for these statuses. Valid statuses \n are the following:

    \n
      \n
    • \n

      \n available\n

      \n
      • \n
    • \n

      \n deprecated\n

      \n
      • \n
    \n
    • \n
" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more than the MaxRecords value is available, a pagination token called a marker is\n included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "DefaultOnly": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether to return only the default version of the specified engine or the engine and major version combination.

" + } + }, + "ListSupportedCharacterSets": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to list the supported character sets for each engine version.

\n

If this parameter is enabled and the requested engine supports the CharacterSetName parameter for\n CreateDBInstance, the response includes a list of supported character sets for each engine\n version.

\n

For RDS Custom, the default is not to list supported character sets. If you enable this parameter, RDS Custom returns no results.

" + } + }, + "ListSupportedTimezones": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to list the supported time zones for each engine version.

\n

If this parameter is enabled and the requested engine supports the TimeZone parameter for CreateDBInstance, \n the response includes a list of supported time zones for each engine version.

\n

For RDS Custom, the default is not to list supported time zones. If you enable this parameter, RDS Custom returns no results.

" + } + }, + "IncludeAll": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to also list the engine versions that aren't available. The default is to list only available engine versions.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBInstanceAutomatedBackups": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBInstanceAutomatedBackupsMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBInstanceAutomatedBackupMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceAutomatedBackupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Displays backups for both current and deleted\n instances. For example, use this operation to\n find details about automated backups for previously deleted instances. Current instances\n with retention periods greater than zero (0) are returned for both the \n DescribeDBInstanceAutomatedBackups and\n DescribeDBInstances operations.

\n

All parameters are optional.

", + "smithy.api#examples": [ + { + "title": "To describe the automated backups for a DB instance", + "documentation": "The following example displays details about the automated backups for the specified DB instance. The details include replicated automated backups in other AWS Regions.", + "input": { + "DBInstanceIdentifier": "new-orcl-db" + }, + "output": { + "DBInstanceAutomatedBackups": [ + { + "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db", + "DbiResourceId": "db-JKIB2GFQ5RV7REPLZA4EXAMPLE", + "Region": "us-east-1", + "DBInstanceIdentifier": "new-orcl-db", + "RestoreWindow": { + "EarliestTime": "2020-12-07T21:05:20.939Z", + "LatestTime": "2020-12-07T21:05:20.939Z" + }, + "AllocatedStorage": 20, + "Status": "replicating", + "Port": 1521, + "InstanceCreateTime": "2020-12-04T15:28:31Z", + "MasterUsername": "admin", + "Engine": "oracle-se2", + "EngineVersion": "12.1.0.2.v21", + "LicenseModel": "bring-your-own-license", + "OptionGroupName": "default:oracle-se2-12-1", + "Encrypted": false, + "StorageType": "gp2", + "IAMDatabaseAuthenticationEnabled": false, + "BackupRetentionPeriod": 14, + "DBInstanceAutomatedBackupsArn": "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBInstanceAutomatedBackups", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeDBInstanceAutomatedBackupsMessage": { + "type": "structure", + "members": { + "DbiResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The resource ID of the DB instance that is the source of \n the automated backup. This parameter isn't case-sensitive.

" + } + }, + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

(Optional) The user-supplied instance identifier. If this parameter is specified, it must\n match the identifier of an existing DB instance. It returns information from the\n specific DB instance's automated backup. This parameter isn't case-sensitive.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

A filter that specifies which resources to return based on status.

\n

Supported filters are the following:

\n
    \n
  • \n

    \n status\n

    \n
      \n
    • \n

      \n active - Automated backups for current instances.

      \n
      • \n
    • \n

      \n creating - Automated backups that are waiting for the first automated snapshot to be available.

      \n
      • \n
    • \n

      \n retained - Automated backups for deleted instances and after backup replication is stopped.

      \n
      • \n
    \n
    • \n
  • \n

    \n db-instance-id - Accepts DB instance identifiers and Amazon Resource Names (ARNs). \n The results list includes only information about the DB instance automated backups identified by these ARNs.

    \n
    • \n
  • \n

    \n dbi-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). \n The results list includes only information about the DB instance resources identified by these ARNs.

    \n
    • \n
\n

Returns all resources by default. The status for each resource is specified in the response.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified \n MaxRecords value, a pagination token called a marker is included in the response so that \n you can retrieve the remaining results.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The pagination token provided in the previous request. If this parameter is specified the response \n includes only records beyond the marker, up to MaxRecords.

" + } + }, + "DBInstanceAutomatedBackupsArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replicated automated backups, for example,\n arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

\n

This setting doesn't apply to RDS Custom.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Parameter input for DescribeDBInstanceAutomatedBackups.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBInstancesMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBInstanceMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Describes provisioned RDS instances. This API supports pagination.

\n \n

This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

\n ", + "smithy.api#examples": [ + { + "title": "To describe a DB instance", + "documentation": "The following example retrieves details about the specified DB instance.", + "input": { + "DBInstanceIdentifier": "mydbinstancecf" + }, + "output": { + "DBInstances": [ + { + "DBInstanceIdentifier": "mydbinstancecf", + "DBInstanceClass": "db.t3.small", + "Engine": "mysql", + "DBInstanceStatus": "available", + "MasterUsername": "admin", + "Endpoint": { + "Address": "mydbinstancecf.abcexample.us-east-1.rds.amazonaws.com", + "Port": 3306, + "HostedZoneId": "Z2R2ITUGPM61AM" + } + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBInstances", + "pageSize": "MaxRecords" + }, + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.test#smokeTests": [ + { + "id": "DescribeDBInstancesFailure", + "params": { + "DBInstanceIdentifier": "fake-id" + }, + "vendorParams": { + "region": "us-west-2" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "failure": {} + } + } + ], + "smithy.waiters#waitable": { + "DBInstanceAvailable": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "DBInstances[].DBInstanceStatus", + "expected": "available", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBInstances[].DBInstanceStatus", + "expected": "deleted", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBInstances[].DBInstanceStatus", + "expected": "deleting", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBInstances[].DBInstanceStatus", + "expected": "failed", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBInstances[].DBInstanceStatus", + "expected": "incompatible-restore", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBInstances[].DBInstanceStatus", + "expected": "incompatible-parameters", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 30 + }, + "DBInstanceDeleted": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "length(DBInstances) == `0`", + "expected": "true", + "comparator": "booleanEquals" + } + } + }, + { + "state": "success", + "matcher": { + "errorType": "DBInstanceNotFound" + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBInstances[].DBInstanceStatus", + "expected": "creating", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBInstances[].DBInstanceStatus", + "expected": "modifying", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBInstances[].DBInstanceStatus", + "expected": "rebooting", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBInstances[].DBInstanceStatus", + "expected": "resetting-master-credentials", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 30 + } + } + } + }, + "com.amazonaws.rds#DescribeDBInstancesMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The user-supplied instance identifier or the Amazon Resource Name (ARN) of the DB instance. If this parameter is specified, \n information from only the specific DB instance is returned. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the identifier of an existing DB instance.

    \n
    • \n
" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

A filter that specifies one or more DB instances to describe.

\n

Supported Filters:

\n
    \n
  • \n

    \n db-cluster-id - Accepts DB cluster identifiers and DB \n cluster Amazon Resource Names (ARNs). The results list only includes information about \n the DB instances associated with the DB clusters identified by these ARNs.

    \n
    • \n
  • \n

    \n db-instance-id - Accepts DB instance identifiers and DB \n instance Amazon Resource Names (ARNs). The results list only includes information about\n the DB instances identified by these ARNs.

    \n
    • \n
  • \n

    \n dbi-resource-id - Accepts DB instance resource identifiers. The results list \n only includes information about the DB instances identified by these DB instance resource identifiers.

    \n
    • \n
  • \n

    \n domain - Accepts Active Directory directory IDs. The results list only includes \n information about the DB instances associated with these domains.

    \n
    • \n
  • \n

    \n engine - Accepts engine names. The results list only includes information \n about the DB instances for these engines.

    \n
    • \n
" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBInstances request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBLogFiles": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBLogFilesMessage" + }, + "output": { + "target": "com.amazonaws.rds#DescribeDBLogFilesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceNotReadyFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of DB log files for the DB instance.

\n

This command doesn't apply to RDS Custom.

", + "smithy.api#examples": [ + { + "title": "To describe the log files for a DB instance", + "documentation": "The following example retrieves details about the log files for the specified DB instance.", + "input": { + "DBInstanceIdentifier": "test-instance" + }, + "output": { + "DescribeDBLogFiles": [ + { + "Size": 0, + "LastWritten": 1533060000000, + "LogFileName": "error/mysql-error-running.log" + }, + { + "Size": 2683, + "LastWritten": 1532994300000, + "LogFileName": "error/mysql-error-running.log.0" + }, + { + "Size": 107, + "LastWritten": 1533057300000, + "LogFileName": "error/mysql-error-running.log.18" + }, + { + "Size": 13105, + "LastWritten": 1532991000000, + "LogFileName": "error/mysql-error-running.log.23" + }, + { + "Size": 0, + "LastWritten": 1533061200000, + "LogFileName": "error/mysql-error.log" + }, + { + "Size": 3519, + "LastWritten": 1532989252000, + "LogFileName": "mysqlUpgrade" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DescribeDBLogFiles", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeDBLogFilesDetails": { + "type": "structure", + "members": { + "LogFileName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the log file for the specified DB instance.

" + } + }, + "LastWritten": { + "target": "com.amazonaws.rds#Long", + "traits": { + "smithy.api#documentation": "

A POSIX timestamp when the last log entry was written.

" + } + }, + "Size": { + "target": "com.amazonaws.rds#Long", + "traits": { + "smithy.api#documentation": "

The size, in bytes, of the log file for the specified DB instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a response element to DescribeDBLogFiles.

" + } + }, + "com.amazonaws.rds#DescribeDBLogFilesList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DescribeDBLogFilesDetails", + "traits": { + "smithy.api#xmlName": "DescribeDBLogFilesDetails" + } + } + }, + "com.amazonaws.rds#DescribeDBLogFilesMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The customer-assigned name of the DB instance that contains the log files you want to list.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DBInstance.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "FilenameContains": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Filters the available log files for log file names that contain the specified string.

" + } + }, + "FileLastWritten": { + "target": "com.amazonaws.rds#Long", + "traits": { + "smithy.api#documentation": "

Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds.

" + } + }, + "FileSize": { + "target": "com.amazonaws.rds#Long", + "traits": { + "smithy.api#documentation": "

Filters the available log files for files larger than the specified size.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBLogFilesResponse": { + "type": "structure", + "members": { + "DescribeDBLogFiles": { + "target": "com.amazonaws.rds#DescribeDBLogFilesList", + "traits": { + "smithy.api#documentation": "

The DB log files returned.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a later DescribeDBLogFiles request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The response from a call to DescribeDBLogFiles.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DescribeDBParameterGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBParameterGroupsMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBParameterGroupsMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified,\n the list will contain only the description of the specified DB parameter group.

", + "smithy.api#examples": [ + { + "title": "To describe your DB parameter groups", + "documentation": "The following example retrieves details about your DB parameter groups.", + "output": { + "DBParameterGroups": [ + { + "DBParameterGroupName": "default.aurora-mysql5.7", + "DBParameterGroupFamily": "aurora-mysql5.7", + "Description": "Default parameter group for aurora-mysql5.7", + "DBParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:pg:default.aurora-mysql5.7" + }, + { + "DBParameterGroupName": "default.aurora-postgresql9.6", + "DBParameterGroupFamily": "aurora-postgresql9.6", + "Description": "Default parameter group for aurora-postgresql9.6", + "DBParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:pg:default.aurora-postgresql9.6" + }, + { + "DBParameterGroupName": "default.aurora5.6", + "DBParameterGroupFamily": "aurora5.6", + "Description": "Default parameter group for aurora5.6", + "DBParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:pg:default.aurora5.6" + }, + { + "DBParameterGroupName": "default.mariadb10.1", + "DBParameterGroupFamily": "mariadb10.1", + "Description": "Default parameter group for mariadb10.1", + "DBParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:pg:default.mariadb10.1" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBParameterGroups", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeDBParameterGroupsMessage": { + "type": "structure", + "members": { + "DBParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of a specific DB parameter group to return details for.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBClusterParameterGroup.

    \n
    • \n
" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBParameterGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBParameters": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBParametersMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBParameterGroupDetails" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the detailed parameter list for a particular DB parameter group.

", + "smithy.api#examples": [ + { + "title": "To describe the parameters in a DB parameter group", + "documentation": "The following example retrieves the details of the specified DB parameter group.", + "input": { + "DBParameterGroupName": "mydbpg" + }, + "output": { + "Parameters": [ + { + "ParameterName": "allow-suspicious-udfs", + "Description": "Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded", + "Source": "engine-default", + "ApplyType": "static", + "DataType": "boolean", + "AllowedValues": "0,1", + "IsModifiable": false, + "ApplyMethod": "pending-reboot" + }, + { + "ParameterName": "auto_generate_certs", + "Description": "Controls whether the server autogenerates SSL key and certificate files in the data directory, if they do not already exist.", + "Source": "engine-default", + "ApplyType": "static", + "DataType": "boolean", + "AllowedValues": "0,1", + "IsModifiable": false, + "ApplyMethod": "pending-reboot" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Parameters", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeDBParametersMessage": { + "type": "structure", + "members": { + "DBParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of a specific DB parameter group to return details for.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBParameterGroup.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Source": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The parameter types to return.

\n

Default: All parameter types returned

\n

Valid Values: user | system | engine-default\n

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

A filter that specifies one or more DB parameters to describe.

\n

The only supported filter is parameter-name. The results list only includes information about the DB parameters with these names.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBProxies": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBProxiesRequest" + }, + "output": { + "target": "com.amazonaws.rds#DescribeDBProxiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBProxyNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about DB proxies.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBProxies", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeDBProxiesRequest": { + "type": "structure", + "members": { + "DBProxyName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB proxy. If you omit this parameter,\n the output includes information about all DB proxies owned by\n your Amazon Web Services account ID.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter is not currently supported.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#MaxRecords", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist\n than the specified MaxRecords value, a pagination token called a marker is\n included in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBProxiesResponse": { + "type": "structure", + "members": { + "DBProxies": { + "target": "com.amazonaws.rds#DBProxyList", + "traits": { + "smithy.api#documentation": "

A return value representing an arbitrary number of DBProxy data structures.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DescribeDBProxyEndpoints": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBProxyEndpointsRequest" + }, + "output": { + "target": "com.amazonaws.rds#DescribeDBProxyEndpointsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBProxyEndpointNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBProxyNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about DB proxy endpoints.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBProxyEndpoints", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeDBProxyEndpointsRequest": { + "type": "structure", + "members": { + "DBProxyName": { + "target": "com.amazonaws.rds#DBProxyName", + "traits": { + "smithy.api#documentation": "

The name of the DB proxy whose endpoints you want to describe. If you omit\n this parameter, the output includes information about all DB proxy endpoints\n associated with all your DB proxies.

" + } + }, + "DBProxyEndpointName": { + "target": "com.amazonaws.rds#DBProxyEndpointName", + "traits": { + "smithy.api#documentation": "

The name of a DB proxy endpoint to describe. If you omit this parameter,\n the output includes information about all DB proxy endpoints associated with\n the specified proxy.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter is not currently supported.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#MaxRecords", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist\n than the specified MaxRecords value, a pagination token called a marker is\n included in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBProxyEndpointsResponse": { + "type": "structure", + "members": { + "DBProxyEndpoints": { + "target": "com.amazonaws.rds#DBProxyEndpointList", + "traits": { + "smithy.api#documentation": "

The list of ProxyEndpoint objects returned by the API operation.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DescribeDBProxyTargetGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBProxyTargetGroupsRequest" + }, + "output": { + "target": "com.amazonaws.rds#DescribeDBProxyTargetGroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBProxyNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBProxyStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about DB proxy target groups, represented by DBProxyTargetGroup data structures.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "TargetGroups", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeDBProxyTargetGroupsRequest": { + "type": "structure", + "members": { + "DBProxyName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier of the DBProxy associated with the target group.

", + "smithy.api#required": {} + } + }, + "TargetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the DBProxyTargetGroup to describe.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter is not currently supported.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#MaxRecords", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that the remaining\n results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBProxyTargetGroupsResponse": { + "type": "structure", + "members": { + "TargetGroups": { + "target": "com.amazonaws.rds#TargetGroupList", + "traits": { + "smithy.api#documentation": "

An arbitrary number of DBProxyTargetGroup objects, containing details of the corresponding target groups.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DescribeDBProxyTargets": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBProxyTargetsRequest" + }, + "output": { + "target": "com.amazonaws.rds#DescribeDBProxyTargetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBProxyNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBProxyTargetNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBProxyStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about DBProxyTarget objects. This API supports pagination.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Targets", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeDBProxyTargetsRequest": { + "type": "structure", + "members": { + "DBProxyName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier of the DBProxyTarget to describe.

", + "smithy.api#required": {} + } + }, + "TargetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the DBProxyTargetGroup to describe.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter is not currently supported.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#MaxRecords", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that the remaining\n results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBProxyTargetsResponse": { + "type": "structure", + "members": { + "Targets": { + "target": "com.amazonaws.rds#TargetList", + "traits": { + "smithy.api#documentation": "

An arbitrary number of DBProxyTarget objects, containing details of the corresponding targets.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DescribeDBRecommendations": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBRecommendationsMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBRecommendationsMessage" + }, + "traits": { + "smithy.api#documentation": "

Describes the recommendations to resolve the issues for your DB instances, DB clusters, and DB parameter groups.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBRecommendations", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeDBRecommendationsMessage": { + "type": "structure", + "members": { + "LastUpdatedAfter": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

A filter to include only the recommendations that were updated after this specified time.

" + } + }, + "LastUpdatedBefore": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

A filter to include only the recommendations that were updated before this specified time.

" + } + }, + "Locale": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The language that you choose to return the list of recommendations.

\n

Valid values:

\n
    \n
  • \n

    \n en\n

    \n
    • \n
  • \n

    \n en_UK\n

    \n
    • \n
  • \n

    \n de\n

    \n
    • \n
  • \n

    \n es\n

    \n
    • \n
  • \n

    \n fr\n

    \n
    • \n
  • \n

    \n id\n

    \n
    • \n
  • \n

    \n it\n

    \n
    • \n
  • \n

    \n ja\n

    \n
    • \n
  • \n

    \n ko\n

    \n
    • \n
  • \n

    \n pt_BR\n

    \n
    • \n
  • \n

    \n zh_TW\n

    \n
    • \n
  • \n

    \n zh_CN\n

    \n
    • \n
" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

A filter that specifies one or more recommendations to describe.

\n

Supported Filters:

\n
    \n
  • \n

    \n recommendation-id - Accepts a list of recommendation identifiers. The results list\n only includes the recommendations whose identifier is one of the specified filter values.

    \n
    • \n
  • \n

    \n status - Accepts a list of recommendation statuses.

    \n

    Valid values:

    \n
      \n
    • \n

      \n active - The recommendations which are ready for you to apply.

      \n
      • \n
    • \n

      \n pending - The applied or scheduled recommendations which are in progress.

      \n
      • \n
    • \n

      \n resolved - The recommendations which are completed.

      \n
      • \n
    • \n

      \n dismissed - The recommendations that you dismissed.

      \n
      • \n
    \n

    The results list only includes the recommendations whose status is one of the specified filter values.

    \n
    • \n
  • \n

    \n severity - Accepts a list of recommendation severities. The results list only includes \n the recommendations whose severity is one of the specified filter values.

    \n

    Valid values:

    \n
      \n
    • \n

      \n high\n

      \n
      • \n
    • \n

      \n medium\n

      \n
      • \n
    • \n

      \n low\n

      \n
      • \n
    • \n

      \n informational\n

      \n
      • \n
    \n
    • \n
  • \n

    \n type-id - Accepts a list of recommendation type identifiers. The results list only\n includes the recommendations whose type is one of the specified filter values.

    \n
    • \n
  • \n

    \n dbi-resource-id - Accepts a list of database resource identifiers. The results list only\n includes the recommendations that generated for the specified databases.

    \n
    • \n
  • \n

    \n cluster-resource-id - Accepts a list of cluster resource identifiers. The results list only\n includes the recommendations that generated for the specified clusters.

    \n
    • \n
  • \n

    \n pg-arn - Accepts a list of parameter group ARNs. The results list only\n includes the recommendations that generated for the specified parameter groups.

    \n
    • \n
  • \n

    \n cluster-pg-arn - Accepts a list of cluster parameter group ARNs. The results list only\n includes the recommendations that generated for the specified cluster parameter groups.

    \n
    • \n
" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of recommendations to include in the response. If more records exist than the \n specified MaxRecords value, a pagination token called a marker is included in the response so \n that you can retrieve the remaining results.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeDBRecommendations request. \n If this parameter is specified, the response includes only records beyond the marker, up to the \n value specified by MaxRecords.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBSecurityGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBSecurityGroupsMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBSecurityGroupMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified,\n the list will contain only the descriptions of the specified DB security group.

\n \n

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – \n Here’s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

\n ", + "smithy.api#examples": [ + { + "title": "To list DB security group settings", + "documentation": "This example lists settings for the specified security group.", + "input": { + "DBSecurityGroupName": "mydbsecuritygroup" + }, + "output": {} + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBSecurityGroups", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeDBSecurityGroupsMessage": { + "type": "structure", + "members": { + "DBSecurityGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB security group to return details for.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBSecurityGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBShardGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBShardGroupsMessage" + }, + "output": { + "target": "com.amazonaws.rds#DescribeDBShardGroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBShardGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Describes existing Aurora Limitless Database DB shard groups.

" + } + }, + "com.amazonaws.rds#DescribeDBShardGroupsMessage": { + "type": "structure", + "members": { + "DBShardGroupIdentifier": { + "target": "com.amazonaws.rds#DBShardGroupIdentifier", + "traits": { + "smithy.api#documentation": "

The user-supplied DB shard group identifier. If this parameter is specified, information for only the specific DB shard group is returned. \n This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match an existing DB shard group identifier.

    \n
    • \n
" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

A filter that specifies one or more DB shard groups to describe.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeDBShardGroups request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#MaxRecords", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified MaxRecords\n value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBShardGroupsResponse": { + "type": "structure", + "members": { + "DBShardGroups": { + "target": "com.amazonaws.rds#DBShardGroupsList", + "traits": { + "smithy.api#documentation": "

Contains a list of DB shard groups for the user.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a later DescribeDBClusters request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DescribeDBSnapshotAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBSnapshotAttributesMessage" + }, + "output": { + "target": "com.amazonaws.rds#DescribeDBSnapshotAttributesResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of DB snapshot attribute names and values for a manual DB snapshot.

\n

When sharing snapshots with other Amazon Web Services accounts, DescribeDBSnapshotAttributes\n returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are \n authorized to copy or restore the manual DB snapshot. If all is included in the list of\n values for the restore attribute, then the manual DB snapshot is public and\n can be copied or restored by all Amazon Web Services accounts.

\n

To add or remove access for an Amazon Web Services account to copy or restore a manual DB snapshot, or to make the\n manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API action.

", + "smithy.api#examples": [ + { + "title": "To describe the attribute names and values for a DB snapshot", + "documentation": "The following example describes the attribute names and values for a DB snapshot.", + "input": { + "DBSnapshotIdentifier": "mydbsnapshot" + }, + "output": { + "DBSnapshotAttributesResult": { + "DBSnapshotIdentifier": "mydbsnapshot", + "DBSnapshotAttributes": [ + { + "AttributeName": "restore", + "AttributeValues": [ + "123456789012", + "210987654321" + ] + } + ] + } + } + } + ] + } + }, + "com.amazonaws.rds#DescribeDBSnapshotAttributesMessage": { + "type": "structure", + "members": { + "DBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier for the DB snapshot to describe the attributes for.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBSnapshotAttributesResult": { + "type": "structure", + "members": { + "DBSnapshotAttributesResult": { + "target": "com.amazonaws.rds#DBSnapshotAttributesResult" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DescribeDBSnapshotTenantDatabases": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBSnapshotTenantDatabasesMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBSnapshotTenantDatabasesMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the tenant databases that exist in a DB snapshot. This command only applies\n to RDS for Oracle DB instances in the multi-tenant configuration.

\n

You can use this command to inspect the tenant databases within a snapshot before\n restoring it. You can't directly interact with the tenant databases in a DB snapshot. If\n you restore a snapshot that was taken from DB instance using the multi-tenant\n configuration, you restore all its tenant databases.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBSnapshotTenantDatabases", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeDBSnapshotTenantDatabasesMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ID of the DB instance used to create the DB snapshots. This parameter isn't\n case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the identifier of an existing DBInstance.

    \n
    • \n
" + } + }, + "DBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ID of a DB snapshot that contains the tenant databases to describe. This value is\n stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    If you specify this parameter, the value must match the ID of an existing DB snapshot.

    \n
    • \n
  • \n

    If you specify an automatic snapshot, you must also specify\n SnapshotType.

    \n
    • \n
" + } + }, + "SnapshotType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The type of DB snapshots to be returned. You can specify one of the following\n values:

\n
    \n
  • \n

    \n automated – All DB snapshots that have been automatically taken\n by Amazon RDS for my Amazon Web Services account.

    \n
    • \n
  • \n

    \n manual – All DB snapshots that have been taken by my Amazon Web\n Services account.

    \n
    • \n
  • \n

    \n shared – All manual DB snapshots that have been shared to my\n Amazon Web Services account.

    \n
    • \n
  • \n

    \n public – All DB snapshots that have been marked as public.

    \n
    • \n
  • \n

    \n awsbackup – All DB snapshots managed by the Amazon Web Services Backup\n service.

    \n
    • \n
" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

A filter that specifies one or more tenant databases to describe.

\n

Supported filters:

\n
    \n
  • \n

    \n tenant-db-name - Tenant database names. The results list only\n includes information about the tenant databases that match these tenant DB\n names.

    \n
    • \n
  • \n

    \n tenant-database-resource-id - Tenant database resource\n identifiers. The results list only includes information about the tenant\n databases contained within the DB snapshots.

    \n
    • \n
  • \n

    \n dbi-resource-id - DB instance resource identifiers. The results\n list only includes information about snapshots containing tenant databases\n contained within the DB instances identified by these resource\n identifiers.

    \n
    • \n
  • \n

    \n db-instance-id - Accepts DB instance identifiers and DB instance\n Amazon Resource Names (ARNs).

    \n
    • \n
  • \n

    \n db-snapshot-id - Accepts DB snapshot identifiers.

    \n
    • \n
  • \n

    \n snapshot-type - Accepts types of DB snapshots.

    \n
    • \n
" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token called a marker is\n included in the response so that you can retrieve the remaining results.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBSnapshotTenantDatabases request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value\n specified by MaxRecords.

" + } + }, + "DbiResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A specific DB resource identifier to describe.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBSnapshots": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBSnapshotsMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBSnapshotMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about DB snapshots. This API action supports pagination.

", + "smithy.api#examples": [ + { + "title": "To describe a DB snapshot for a DB instance", + "documentation": "The following example retrieves the details of a DB snapshot for a DB instance.", + "input": { + "DBSnapshotIdentifier": "mydbsnapshot" + }, + "output": { + "DBSnapshots": [ + { + "DBSnapshotIdentifier": "mydbsnapshot", + "DBInstanceIdentifier": "mysqldb", + "SnapshotCreateTime": "2018-02-08T22:28:08.598Z", + "Engine": "mysql", + "AllocatedStorage": 20, + "Status": "available", + "Port": 3306, + "AvailabilityZone": "us-east-1f", + "VpcId": "vpc-6594f31c", + "InstanceCreateTime": "2018-02-08T22:24:55.973Z", + "MasterUsername": "mysqladmin", + "EngineVersion": "5.6.37", + "LicenseModel": "general-public-license", + "SnapshotType": "manual", + "OptionGroupName": "default:mysql-5-6", + "PercentProgress": 100, + "StorageType": "gp2", + "Encrypted": false, + "DBSnapshotArn": "arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshot", + "IAMDatabaseAuthenticationEnabled": false, + "ProcessorFeatures": [], + "DbiResourceId": "db-AKIAIOSFODNN7EXAMPLE" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBSnapshots", + "pageSize": "MaxRecords" + }, + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "DBSnapshotAvailable": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "DBSnapshots[].Status", + "expected": "available", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBSnapshots[].Status", + "expected": "deleted", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBSnapshots[].Status", + "expected": "deleting", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBSnapshots[].Status", + "expected": "failed", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBSnapshots[].Status", + "expected": "incompatible-restore", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBSnapshots[].Status", + "expected": "incompatible-parameters", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 30 + }, + "DBSnapshotDeleted": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "length(DBSnapshots) == `0`", + "expected": "true", + "comparator": "booleanEquals" + } + } + }, + { + "state": "success", + "matcher": { + "errorType": "DBSnapshotNotFound" + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBSnapshots[].Status", + "expected": "creating", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBSnapshots[].Status", + "expected": "modifying", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBSnapshots[].Status", + "expected": "rebooting", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBSnapshots[].Status", + "expected": "resetting-master-credentials", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 30 + } + } + } + }, + "com.amazonaws.rds#DescribeDBSnapshotsMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ID of the DB instance to retrieve the list of DB snapshots for. \n This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the identifier of an existing DBInstance.

    \n
    • \n
" + } + }, + "DBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A specific DB snapshot identifier to describe.\n This value is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the identifier of an existing DBSnapshot.

    \n
    • \n
  • \n

    If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

    \n
    • \n
" + } + }, + "SnapshotType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The type of snapshots to be returned. You can specify one of the following values:

\n
    \n
  • \n

    \n automated - Return all DB snapshots that have been automatically taken by \n Amazon RDS for my Amazon Web Services account.

    \n
    • \n
  • \n

    \n manual - Return all DB snapshots that have been taken by my Amazon Web Services account.

    \n
    • \n
  • \n

    \n shared - Return all manual DB snapshots that have been shared to my Amazon Web Services account.

    \n
    • \n
  • \n

    \n public - Return all DB snapshots that have been marked as public.

    \n
    • \n
  • \n

    \n awsbackup - Return the DB snapshots managed by the Amazon Web Services Backup service.

    \n

    For information about Amazon Web Services Backup, see the \n \n Amazon Web Services Backup Developer Guide.\n \n

    \n

    The awsbackup type does not apply to Aurora.

    \n
    • \n
\n

If you don't specify a SnapshotType value, then both automated and manual snapshots are\n returned. Shared and public DB snapshots are not included in the returned results by default.\n You can include shared snapshots with these results by enabling the IncludeShared\n parameter. You can include public snapshots with these results by enabling the \n IncludePublic parameter.

\n

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values\n of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is\n set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to\n public.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

A filter that specifies one or more DB snapshots to describe.

\n

Supported filters:

\n
    \n
  • \n

    \n db-instance-id - Accepts DB instance identifiers and DB \n instance Amazon Resource Names (ARNs).

    \n
    • \n
  • \n

    \n db-snapshot-id - Accepts DB snapshot identifiers.

    \n
    • \n
  • \n

    \n dbi-resource-id - Accepts identifiers of source DB instances.

    \n
    • \n
  • \n

    \n snapshot-type - Accepts types of DB snapshots.

    \n
    • \n
  • \n

    \n engine - Accepts names of database engines.

    \n
    • \n
" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBSnapshots request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "IncludeShared": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether to include shared manual DB cluster snapshots \n from other Amazon Web Services accounts that this Amazon Web Services account has been given \n permission to copy or restore. By default, these snapshots are not included.

\n

You can give an Amazon Web Services account permission to restore a manual DB snapshot from\n another Amazon Web Services account by using the ModifyDBSnapshotAttribute API action.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "IncludePublic": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether to include manual DB cluster snapshots that are public and can be copied \n or restored by any Amazon Web Services account. By default, the public snapshots are not included.

\n

You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "DbiResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A specific DB resource ID to describe.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBSubnetGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBSubnetGroupsMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBSubnetGroupMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

\n

For an overview of CIDR ranges, go to the \n Wikipedia Tutorial.

", + "smithy.api#examples": [ + { + "title": "To describe a DB subnet group", + "documentation": "The following example retrieves the details of the specified DB subnet group.", + "output": { + "DBSubnetGroups": [ + { + "DBSubnetGroupName": "mydbsubnetgroup", + "DBSubnetGroupDescription": "My DB Subnet Group", + "VpcId": "vpc-971c12ee", + "SubnetGroupStatus": "Complete", + "Subnets": [ + { + "SubnetIdentifier": "subnet-d8c8e7f4", + "SubnetAvailabilityZone": { + "Name": "us-east-1a" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-718fdc7d", + "SubnetAvailabilityZone": { + "Name": "us-east-1f" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-cbc8e7e7", + "SubnetAvailabilityZone": { + "Name": "us-east-1a" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-0ccde220", + "SubnetAvailabilityZone": { + "Name": "us-east-1a" + }, + "SubnetStatus": "Active" + } + ], + "DBSubnetGroupArn": "arn:aws:rds:us-east-1:123456789012:subgrp:mydbsubnetgroup" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBSubnetGroups", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeDBSubnetGroupsMessage": { + "type": "structure", + "members": { + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB subnet group to return details for.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeDBSubnetGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeEngineDefaultClusterParameters": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeEngineDefaultClusterParametersMessage" + }, + "output": { + "target": "com.amazonaws.rds#DescribeEngineDefaultClusterParametersResult" + }, + "traits": { + "smithy.api#documentation": "

Returns the default engine and system parameter information for the cluster database engine.

\n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

", + "smithy.api#examples": [ + { + "title": "To describe the default engine and system parameter information for the Aurora database engine", + "documentation": "The following example retrieves the details of the default engine and system parameter information for Aurora DB clusters with MySQL 5.7 compatibility.", + "input": { + "DBParameterGroupFamily": "aurora-mysql5.7" + }, + "output": { + "EngineDefaults": { + "Parameters": [ + { + "ParameterName": "aurora_load_from_s3_role", + "Description": "IAM role ARN used to load data from AWS S3", + "Source": "engine-default", + "ApplyType": "dynamic", + "DataType": "string", + "IsModifiable": true, + "SupportedEngineModes": [ + "provisioned" + ] + } + ] + } + } + } + ] + } + }, + "com.amazonaws.rds#DescribeEngineDefaultClusterParametersMessage": { + "type": "structure", + "members": { + "DBParameterGroupFamily": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the DB cluster parameter group family to return engine parameter information for.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeEngineDefaultClusterParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeEngineDefaultClusterParametersResult": { + "type": "structure", + "members": { + "EngineDefaults": { + "target": "com.amazonaws.rds#EngineDefaults" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DescribeEngineDefaultParameters": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeEngineDefaultParametersMessage" + }, + "output": { + "target": "com.amazonaws.rds#DescribeEngineDefaultParametersResult" + }, + "traits": { + "smithy.api#documentation": "

Returns the default engine and system parameter information for the specified database engine.

", + "smithy.api#examples": [ + { + "title": "To describe the default engine and system parameter information for the database engine", + "documentation": "The following example retrieves details for the default engine and system parameter information for MySQL 5.7 DB instances.", + "input": { + "DBParameterGroupFamily": "mysql5.7" + }, + "output": { + "EngineDefaults": { + "Parameters": [ + { + "ParameterName": "allow-suspicious-udfs", + "Description": "Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded", + "Source": "engine-default", + "ApplyType": "static", + "DataType": "boolean", + "AllowedValues": "0,1", + "IsModifiable": false + } + ] + } + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "EngineDefaults.Marker", + "items": "EngineDefaults.Parameters", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeEngineDefaultParametersMessage": { + "type": "structure", + "members": { + "DBParameterGroupFamily": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the DB parameter group family.

\n

Valid Values:

\n
    \n
  • \n

    \n aurora-mysql5.7\n

    \n
    • \n
  • \n

    \n aurora-mysql8.0\n

    \n
    • \n
  • \n

    \n aurora-postgresql10\n

    \n
    • \n
  • \n

    \n aurora-postgresql11\n

    \n
    • \n
  • \n

    \n aurora-postgresql12\n

    \n
    • \n
  • \n

    \n aurora-postgresql13\n

    \n
    • \n
  • \n

    \n aurora-postgresql14\n

    \n
    • \n
  • \n

    \n custom-oracle-ee-19\n

    \n
    • \n
  • \n

    \n custom-oracle-ee-cdb-19\n

    \n
    • \n
  • \n

    \n db2-ae\n

    \n
    • \n
  • \n

    \n db2-se\n

    \n
    • \n
  • \n

    \n mariadb10.2\n

    \n
    • \n
  • \n

    \n mariadb10.3\n

    \n
    • \n
  • \n

    \n mariadb10.4\n

    \n
    • \n
  • \n

    \n mariadb10.5\n

    \n
    • \n
  • \n

    \n mariadb10.6\n

    \n
    • \n
  • \n

    \n mysql5.7\n

    \n
    • \n
  • \n

    \n mysql8.0\n

    \n
    • \n
  • \n

    \n oracle-ee-19\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb-19\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb-21\n

    \n
    • \n
  • \n

    \n oracle-se2-19\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb-19\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb-21\n

    \n
    • \n
  • \n

    \n postgres10\n

    \n
    • \n
  • \n

    \n postgres11\n

    \n
    • \n
  • \n

    \n postgres12\n

    \n
    • \n
  • \n

    \n postgres13\n

    \n
    • \n
  • \n

    \n postgres14\n

    \n
    • \n
  • \n

    \n sqlserver-ee-11.0\n

    \n
    • \n
  • \n

    \n sqlserver-ee-12.0\n

    \n
    • \n
  • \n

    \n sqlserver-ee-13.0\n

    \n
    • \n
  • \n

    \n sqlserver-ee-14.0\n

    \n
    • \n
  • \n

    \n sqlserver-ee-15.0\n

    \n
    • \n
  • \n

    \n sqlserver-ex-11.0\n

    \n
    • \n
  • \n

    \n sqlserver-ex-12.0\n

    \n
    • \n
  • \n

    \n sqlserver-ex-13.0\n

    \n
    • \n
  • \n

    \n sqlserver-ex-14.0\n

    \n
    • \n
  • \n

    \n sqlserver-ex-15.0\n

    \n
    • \n
  • \n

    \n sqlserver-se-11.0\n

    \n
    • \n
  • \n

    \n sqlserver-se-12.0\n

    \n
    • \n
  • \n

    \n sqlserver-se-13.0\n

    \n
    • \n
  • \n

    \n sqlserver-se-14.0\n

    \n
    • \n
  • \n

    \n sqlserver-se-15.0\n

    \n
    • \n
  • \n

    \n sqlserver-web-11.0\n

    \n
    • \n
  • \n

    \n sqlserver-web-12.0\n

    \n
    • \n
  • \n

    \n sqlserver-web-13.0\n

    \n
    • \n
  • \n

    \n sqlserver-web-14.0\n

    \n
    • \n
  • \n

    \n sqlserver-web-15.0\n

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

A filter that specifies one or more parameters to describe.

\n

The only supported filter is parameter-name. The results list only includes information about the parameters with these names.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeEngineDefaultParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeEngineDefaultParametersResult": { + "type": "structure", + "members": { + "EngineDefaults": { + "target": "com.amazonaws.rds#EngineDefaults" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DescribeEventCategories": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeEventCategoriesMessage" + }, + "output": { + "target": "com.amazonaws.rds#EventCategoriesMessage" + }, + "traits": { + "smithy.api#documentation": "

Displays a list of categories for all event source types, or, if specified, for a specified source type.\n You can also see this list in the \"Amazon RDS event categories and event messages\" section of the \n Amazon RDS User Guide\n or the\n \n Amazon Aurora User Guide\n .

", + "smithy.api#examples": [ + { + "title": "To describe event categories", + "documentation": "The following example retrieves details about the event categories for all available event sources.", + "input": { + "SourceType": "", + "Filters": [] + }, + "output": { + "EventCategoriesMapList": [ + { + "SourceType": "db-instance", + "EventCategories": [ + "deletion", + "read replica", + "failover", + "restoration", + "maintenance", + "low storage", + "configuration change", + "backup", + "creation", + "availability", + "recovery", + "failure", + "backtrack", + "notification" + ] + }, + { + "SourceType": "db-security-group", + "EventCategories": [ + "configuration change", + "failure" + ] + }, + { + "SourceType": "db-parameter-group", + "EventCategories": [ + "configuration change" + ] + }, + { + "SourceType": "db-snapshot", + "EventCategories": [ + "deletion", + "creation", + "restoration", + "notification" + ] + }, + { + "SourceType": "db-cluster", + "EventCategories": [ + "failover", + "failure", + "notification" + ] + }, + { + "SourceType": "db-cluster-snapshot", + "EventCategories": [ + "backup" + ] + } + ] + } + } + ] + } + }, + "com.amazonaws.rds#DescribeEventCategoriesMessage": { + "type": "structure", + "members": { + "SourceType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The type of source that is generating the events. For RDS Proxy events, specify db-proxy.

\n

Valid Values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy\n

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeEventSubscriptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeEventSubscriptionsMessage" + }, + "output": { + "target": "com.amazonaws.rds#EventSubscriptionsMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#SubscriptionNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all the subscription descriptions for a customer account. The description for a subscription includes \n SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

\n

If you specify a SubscriptionName, lists the description for that subscription.

", + "smithy.api#examples": [ + { + "title": "To describe event subscriptions", + "documentation": "This example describes all of the Amazon RDS event subscriptions for the current AWS account.", + "output": { + "EventSubscriptionsList": [ + { + "EventCategoriesList": [ + "backup", + "recovery" + ], + "Enabled": true, + "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events", + "Status": "creating", + "SourceType": "db-instance", + "CustomerAwsId": "123456789012", + "SubscriptionCreationTime": "2018-07-31 23:22:01.893", + "CustSubscriptionId": "my-instance-events", + "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "EventSubscriptionsList", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeEventSubscriptionsMessage": { + "type": "structure", + "members": { + "SubscriptionName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the RDS event notification subscription you want to describe.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeOrderableDBInstanceOptions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeEvents": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeEventsMessage" + }, + "output": { + "target": "com.amazonaws.rds#EventsMessage" + }, + "traits": { + "smithy.api#documentation": "

Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. \n Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be \n obtained by providing the name as a parameter.

\n

For more information on working with events, see Monitoring Amazon RDS events in the Amazon RDS User Guide and Monitoring Amazon Aurora\n events in the Amazon Aurora User Guide.

\n \n

By default, RDS returns events that were generated in the past hour.

\n ", + "smithy.api#examples": [ + { + "title": "To describe events", + "documentation": "The following retrieves details for the events that have occurred for the specified DB instance.", + "input": { + "SourceIdentifier": "test-instance", + "SourceType": "db-instance" + }, + "output": { + "Events": [ + { + "SourceType": "db-instance", + "SourceIdentifier": "test-instance", + "EventCategories": [ + "backup" + ], + "Message": "Backing up DB instance", + "Date": "2018-07-31T23:09:23.983Z", + "SourceArn": "arn:aws:rds:us-east-1:123456789012:db:test-instance" + }, + { + "SourceType": "db-instance", + "SourceIdentifier": "test-instance", + "EventCategories": [ + "backup" + ], + "Message": "Finished DB Instance backup", + "Date": "2018-07-31T23:15:13.049Z", + "SourceArn": "arn:aws:rds:us-east-1:123456789012:db:test-instance" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Events", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeEventsMessage": { + "type": "structure", + "members": { + "SourceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.

\n

Constraints:

\n
    \n
  • \n

    If SourceIdentifier is supplied, SourceType must also be provided.

    \n
    • \n
  • \n

    If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB security group, a DBSecurityGroupName value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is an RDS Proxy, a DBProxyName value must be supplied.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
" + } + }, + "SourceType": { + "target": "com.amazonaws.rds#SourceType", + "traits": { + "smithy.api#documentation": "

The event source to retrieve events for. If no value is specified, all events are returned.

" + } + }, + "StartTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The beginning of the time interval to retrieve events for,\n specified in ISO 8601 format. For more information about ISO 8601, \n go to the ISO8601 Wikipedia page.\n

\n

Example: 2009-07-08T18:00Z

" + } + }, + "EndTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The end of the time interval for which to retrieve events,\n specified in ISO 8601 format. For more information about ISO 8601, \n go to the ISO8601 Wikipedia page.\n

\n

Example: 2009-07-08T18:00Z

" + } + }, + "Duration": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of minutes to retrieve events for.

\n

Default: 60

" + } + }, + "EventCategories": { + "target": "com.amazonaws.rds#EventCategoriesList", + "traits": { + "smithy.api#documentation": "

A list of event categories that trigger notifications for a event notification subscription.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeEvents request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeExportTasks": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeExportTasksMessage" + }, + "output": { + "target": "com.amazonaws.rds#ExportTasksMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#ExportTaskNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a snapshot or cluster export to Amazon S3. This API operation supports\n pagination.

", + "smithy.api#examples": [ + { + "title": "To describe snapshot export tasks", + "documentation": "The following example returns information about snapshot exports to Amazon S3.", + "output": { + "ExportTasks": [ + { + "ExportTaskIdentifier": "test-snapshot-export", + "SourceArn": "arn:aws:rds:us-west-2:123456789012:snapshot:test-snapshot", + "SnapshotTime": "2020-03-02T18:26:28.163Z", + "TaskStartTime": "2020-03-02T18:57:56.896Z", + "TaskEndTime": "2020-03-02T19:10:31.985Z", + "S3Bucket": "mybucket", + "S3Prefix": "", + "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/ExportRole", + "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff", + "Status": "COMPLETE", + "PercentProgress": 100, + "TotalExtractedDataInGB": 0 + }, + { + "ExportTaskIdentifier": "my-s3-export", + "SourceArn": "arn:aws:rds:us-west-2:123456789012:snapshot:db5-snapshot-test", + "SnapshotTime": "2020-03-27T20:48:42.023Z", + "S3Bucket": "mybucket", + "S3Prefix": "", + "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/ExportRole", + "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff", + "Status": "STARTING", + "PercentProgress": 0, + "TotalExtractedDataInGB": 0 + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "ExportTasks", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeExportTasksMessage": { + "type": "structure", + "members": { + "ExportTaskIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the snapshot or cluster export task to be described.

" + } + }, + "SourceArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

Filters specify one or more snapshot or cluster exports to describe. The filters are specified as name-value pairs that define what to\n include in the output. Filter names and values are case-sensitive.

\n

Supported filters include the following:

\n
    \n
  • \n

    \n export-task-identifier - An identifier for the snapshot or cluster export task.

    \n
    • \n
  • \n

    \n s3-bucket - The Amazon S3 bucket the data is exported to.

    \n
    • \n
  • \n

    \n source-arn - The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.

    \n
    • \n
  • \n

    \n status - The status of the export task. Must be lowercase. Valid statuses are the following:

    \n
      \n
    • \n

      \n canceled\n

      \n
      • \n
    • \n

      \n canceling\n

      \n
      • \n
    • \n

      \n complete\n

      \n
      • \n
    • \n

      \n failed\n

      \n
      • \n
    • \n

      \n in_progress\n

      \n
      • \n
    • \n

      \n starting\n

      \n
      • \n
    \n
    • \n
" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeExportTasks request.\n If you specify this parameter, the response includes only records beyond the marker,\n up to the value specified by the MaxRecords parameter.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#MaxRecords", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the \n specified value, a pagination token called a marker is included in the response. \n You can use the marker in a later DescribeExportTasks request \n to retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "SourceType": { + "target": "com.amazonaws.rds#ExportSourceType", + "traits": { + "smithy.api#documentation": "

The type of source for the export.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeGlobalClusters": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeGlobalClustersMessage" + }, + "output": { + "target": "com.amazonaws.rds#GlobalClustersMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#GlobalClusterNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about Aurora global database clusters. This API supports pagination.

\n

For more information on Amazon Aurora, see What is Amazon Aurora? in the\n Amazon Aurora User Guide.

\n \n

This action only applies to Aurora DB clusters.

\n ", + "smithy.api#examples": [ + { + "title": "To describe global DB clusters", + "documentation": "The following example lists Aurora global DB clusters in the current AWS Region.", + "output": { + "GlobalClusters": [ + { + "GlobalClusterIdentifier": "myglobalcluster", + "GlobalClusterResourceId": "cluster-f5982077e3b5aabb", + "GlobalClusterArn": "arn:aws:rds::123456789012:global-cluster:myglobalcluster", + "Status": "available", + "Engine": "aurora-mysql", + "EngineVersion": "5.7.mysql_aurora.2.07.2", + "StorageEncrypted": false, + "DeletionProtection": false, + "GlobalClusterMembers": [] + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "GlobalClusters", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeGlobalClustersMessage": { + "type": "structure", + "members": { + "GlobalClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match an existing DBClusterIdentifier.

    \n
    • \n
" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

A filter that specifies one or more global database clusters to describe. This parameter is case-sensitive.

\n

Currently, the only supported filter is region.

\n

If used, the request returns information about any global cluster with at least one member (primary or secondary) in the specified Amazon Web Services Regions.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified\n MaxRecords value, a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeGlobalClusters request. If\n this parameter is specified, the response includes only records beyond the marker, up to the value\n specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeIntegrations": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeIntegrationsMessage" + }, + "output": { + "target": "com.amazonaws.rds#DescribeIntegrationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#IntegrationNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Describe one or more zero-ETL integrations with Amazon Redshift.

", + "smithy.api#examples": [ + { + "title": "To describe a zero-ETL integration", + "documentation": "The following example retrieves information about a zero-ETL integration with Amazon Redshift.", + "input": { + "IntegrationIdentifier": "5b9f3d79-7392-4a3e-896c-58eaa1b53231" + }, + "output": { + "Integrations": [ + { + "IntegrationName": "my-integration", + "IntegrationArn": "arn:aws:rds:us-east-1:123456789012:integration:5b9f3d79-7392-4a3e-896c-58eaa1b53231", + "SourceArn": "arn:aws:rds:us-east-1:123456789012:cluster:my-cluster", + "TargetArn": "arn:aws:redshift-serverless:us-east-1:123456789012:namespace/62c70612-0302-4db7-8414-b5e3e049f0d8", + "Tags": [], + "CreateTime": "2023-12-28T17:20:20.629Z", + "KMSKeyId": "arn:aws:kms:us-east-1:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa", + "Status": "active" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Integrations", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeIntegrationsMessage": { + "type": "structure", + "members": { + "IntegrationIdentifier": { + "target": "com.amazonaws.rds#IntegrationIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the integration.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

A filter that specifies one or more resources to return.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token called a marker is\n included in the response so that you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#Marker", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeIntegrations\n request. If this parameter is specified, the response includes only records beyond the\n marker, up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeIntegrationsResponse": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#Marker", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a later DescribeIntegrations\n request.

" + } + }, + "Integrations": { + "target": "com.amazonaws.rds#IntegrationList", + "traits": { + "smithy.api#documentation": "

A list of integrations.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DescribeOptionGroupOptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeOptionGroupOptionsMessage" + }, + "output": { + "target": "com.amazonaws.rds#OptionGroupOptionsMessage" + }, + "traits": { + "smithy.api#documentation": "

Describes all available options for the specified engine.

", + "smithy.api#examples": [ + { + "title": "To describe all available options", + "documentation": "The following example lists the options for an RDS for MySQL version 8.0 DB instance.", + "input": { + "EngineName": "mysql", + "MajorEngineVersion": "8.0" + }, + "output": { + "OptionGroupOptions": [ + { + "Name": "MARIADB_AUDIT_PLUGIN", + "Description": "MariaDB Audit Plugin", + "EngineName": "mysql", + "MajorEngineVersion": "8.0", + "MinimumRequiredMinorEngineVersion": "25", + "PortRequired": false, + "OptionsDependedOn": [], + "OptionsConflictsWith": [], + "Persistent": false, + "Permanent": false, + "RequiresAutoMinorEngineVersionUpgrade": false, + "VpcOnly": false, + "OptionGroupOptionSettings": [ + { + "SettingName": "SERVER_AUDIT_INCL_USERS", + "SettingDescription": "Include specified users", + "ApplyType": "DYNAMIC", + "IsModifiable": true, + "IsRequired": false, + "MinimumEngineVersionPerAllowedValue": [] + }, + { + "SettingName": "SERVER_AUDIT_EXCL_USERS", + "SettingDescription": "Exclude specified users", + "ApplyType": "DYNAMIC", + "IsModifiable": true, + "IsRequired": false, + "MinimumEngineVersionPerAllowedValue": [] + } + ] + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "OptionGroupOptions", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeOptionGroupOptionsMessage": { + "type": "structure", + "members": { + "EngineName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the engine to describe options for.

\n

Valid Values:

\n
    \n
  • \n

    \n db2-ae\n

    \n
    • \n
  • \n

    \n db2-se\n

    \n
    • \n
  • \n

    \n mariadb\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n oracle-ee\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n oracle-se2\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
  • \n

    \n sqlserver-ee\n

    \n
    • \n
  • \n

    \n sqlserver-se\n

    \n
    • \n
  • \n

    \n sqlserver-ex\n

    \n
    • \n
  • \n

    \n sqlserver-web\n

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "MajorEngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

If specified, filters the results to include only options for the specified major engine version.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeOptionGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeOptionGroupsMessage" + }, + "output": { + "target": "com.amazonaws.rds#OptionGroups" + }, + "errors": [ + { + "target": "com.amazonaws.rds#OptionGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the available option groups.

", + "smithy.api#examples": [ + { + "title": "To describe the available option groups", + "documentation": "The following example lists the options groups for an Oracle Database 19c instance.", + "input": { + "EngineName": "oracle-ee", + "MajorEngineVersion": "19" + }, + "output": { + "OptionGroupsList": [ + { + "OptionGroupName": "default:oracle-ee-19", + "OptionGroupDescription": "Default option group for oracle-ee 19", + "EngineName": "oracle-ee", + "MajorEngineVersion": "19", + "Options": [], + "AllowsVpcAndNonVpcInstanceMemberships": true, + "OptionGroupArn": "arn:aws:rds:us-west-1:111122223333:og:default:oracle-ee-19" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "OptionGroupsList", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeOptionGroupsMessage": { + "type": "structure", + "members": { + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeOptionGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "EngineName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A filter to only include option groups associated with this database engine.

\n

Valid Values:

\n
    \n
  • \n

    \n db2-ae\n

    \n
    • \n
  • \n

    \n db2-se\n

    \n
    • \n
  • \n

    \n mariadb\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n oracle-ee\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n oracle-se2\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
  • \n

    \n sqlserver-ee\n

    \n
    • \n
  • \n

    \n sqlserver-se\n

    \n
    • \n
  • \n

    \n sqlserver-ex\n

    \n
    • \n
  • \n

    \n sqlserver-web\n

    \n
    • \n
" + } + }, + "MajorEngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeOrderableDBInstanceOptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeOrderableDBInstanceOptionsMessage" + }, + "output": { + "target": "com.amazonaws.rds#OrderableDBInstanceOptionsMessage" + }, + "traits": { + "smithy.api#documentation": "

Describes the orderable DB instance options for a specified DB engine.

", + "smithy.api#examples": [ + { + "title": "To describe orderable DB instance options", + "documentation": "The following example retrieves details about the orderable options for a DB instances running the MySQL DB engine.", + "input": { + "Engine": "mysql" + }, + "output": { + "OrderableDBInstanceOptions": [ + { + "Engine": "mysql", + "EngineVersion": "5.7.33", + "DBInstanceClass": "db.m4.10xlarge", + "LicenseModel": "general-public-license", + "AvailabilityZones": [ + { + "Name": "us-east-1a" + }, + { + "Name": "us-east-1b" + }, + { + "Name": "us-east-1c" + }, + { + "Name": "us-east-1d" + }, + { + "Name": "us-east-1e" + }, + { + "Name": "us-east-1f" + } + ], + "MultiAZCapable": true, + "ReadReplicaCapable": true, + "Vpc": true, + "SupportsStorageEncryption": true, + "StorageType": "gp2" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "OrderableDBInstanceOptions", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeOrderableDBInstanceOptionsMessage": { + "type": "structure", + "members": { + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the database engine to describe DB instance options for.

\n

Valid Values:

\n
    \n
  • \n

    \n aurora-mysql\n

    \n
    • \n
  • \n

    \n aurora-postgresql\n

    \n
    • \n
  • \n

    \n custom-oracle-ee\n

    \n
    • \n
  • \n

    \n custom-oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n custom-oracle-se2\n

    \n
    • \n
  • \n

    \n custom-oracle-se2-cdb\n

    \n
    • \n
  • \n

    \n db2-ae\n

    \n
    • \n
  • \n

    \n db2-se\n

    \n
    • \n
  • \n

    \n mariadb\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n oracle-ee\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n oracle-se2\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
  • \n

    \n sqlserver-ee\n

    \n
    • \n
  • \n

    \n sqlserver-se\n

    \n
    • \n
  • \n

    \n sqlserver-ex\n

    \n
    • \n
  • \n

    \n sqlserver-web\n

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A filter to include only the available options for the specified engine version.

" + } + }, + "DBInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A filter to include only the available options for the specified DB instance class.

" + } + }, + "LicenseModel": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A filter to include only the available options for the specified license model.

\n

RDS Custom supports only the BYOL licensing model.

" + } + }, + "AvailabilityZoneGroup": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available options for the Local Zones in the group.

\n

Omit this parameter to show the available options in the specified Amazon Web Services Region.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "Vpc": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to show only VPC or non-VPC offerings. RDS Custom supports \n only VPC offerings.

\n

RDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output \n shows VPC offerings.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 1000.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeOrderableDBInstanceOptions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribePendingMaintenanceActions": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribePendingMaintenanceActionsMessage" + }, + "output": { + "target": "com.amazonaws.rds#PendingMaintenanceActionsMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.

\n

This API follows an eventual consistency model. This means that the result of the\n DescribePendingMaintenanceActions command might not be immediately\n visible to all subsequent RDS commands. Keep this in mind when you use\n DescribePendingMaintenanceActions immediately after using a previous\n API command such as ApplyPendingMaintenanceActions.

", + "smithy.api#examples": [ + { + "title": "To list resources with at least one pending maintenance action", + "documentation": "The following example lists the pending maintenace action for a DB instance.", + "output": { + "PendingMaintenanceActions": [ + { + "ResourceIdentifier": "arn:aws:rds:us-west-2:123456789012:cluster:global-db1-cl1", + "PendingMaintenanceActionDetails": [ + { + "Action": "system-update", + "Description": "Upgrade to Aurora PostgreSQL 2.4.2" + } + ] + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "PendingMaintenanceActions", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribePendingMaintenanceActionsMessage": { + "type": "structure", + "members": { + "ResourceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN of a resource to return pending maintenance actions for.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

A filter that specifies one or more resources to return pending maintenance actions for.

\n

Supported filters:

\n
    \n
  • \n

    \n db-cluster-id - Accepts DB cluster identifiers and DB \n cluster Amazon Resource Names (ARNs). The results list only includes pending maintenance \n actions for the DB clusters identified by these ARNs.

    \n
    • \n
  • \n

    \n db-instance-id - Accepts DB instance identifiers and DB \n instance ARNs. The results list only includes pending maintenance \n actions for the DB instances identified by these ARNs.

    \n
    • \n
" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribePendingMaintenanceActions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to a number of records specified by MaxRecords.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeReservedDBInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeReservedDBInstancesMessage" + }, + "output": { + "target": "com.amazonaws.rds#ReservedDBInstanceMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#ReservedDBInstanceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about reserved DB instances for this account, or about a specified reserved DB instance.

", + "smithy.api#examples": [ + { + "title": "To describe reserved DB instances", + "documentation": "The following example retrieves details about any reserved DB instances in the current AWS account.", + "output": { + "ReservedDBInstances": [ + { + "ReservedDBInstanceId": "myreservedinstance", + "ReservedDBInstancesOfferingId": "12ab34cd-59af-4b2c-a660-1abcdef23456", + "DBInstanceClass": "db.t3.micro", + "StartTime": "2020-06-01T13:44:21.436Z", + "Duration": 31536000, + "FixedPrice": 0, + "UsagePrice": 0, + "CurrencyCode": "USD", + "DBInstanceCount": 1, + "ProductDescription": "sqlserver-ex(li)", + "OfferingType": "No Upfront", + "MultiAZ": false, + "State": "payment-pending", + "RecurringCharges": [ + { + "RecurringChargeAmount": 0.014, + "RecurringChargeFrequency": "Hourly" + } + ], + "ReservedDBInstanceArn": "arn:aws:rds:us-west-2:123456789012:ri:myreservedinstance", + "LeaseId": "a1b2c3d4-6b69-4a59-be89-5e11aa446666" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "ReservedDBInstances", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeReservedDBInstancesMessage": { + "type": "structure", + "members": { + "ReservedDBInstanceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.

" + } + }, + "ReservedDBInstancesOfferingId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.

" + } + }, + "DBInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.

" + } + }, + "Duration": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

\n

Valid Values: 1 | 3 | 31536000 | 94608000\n

" + } + }, + "ProductDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The product description filter value. Specify this parameter to show only those reservations matching the specified product description.

" + } + }, + "OfferingType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

\n

Valid Values: \"Partial Upfront\" | \"All Upfront\" | \"No Upfront\" \n

" + } + }, + "MultiAZ": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to show only those reservations that support Multi-AZ.

" + } + }, + "LeaseId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified lease ID.

\n \n

Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.

\n " + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more than the MaxRecords value is available, a pagination token called a marker is\n included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeReservedDBInstancesOfferings": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeReservedDBInstancesOfferingsMessage" + }, + "output": { + "target": "com.amazonaws.rds#ReservedDBInstancesOfferingMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#ReservedDBInstancesOfferingNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Lists available reserved DB instance offerings.

", + "smithy.api#examples": [ + { + "title": "To describe reserved DB instance offerings", + "documentation": "The following example retrieves details about reserved DB instance options for RDS for Oracle.", + "input": { + "ProductDescription": "oracle" + }, + "output": { + "ReservedDBInstancesOfferings": [ + { + "CurrencyCode": "USD", + "UsagePrice": 0, + "ProductDescription": "oracle-se2(li)", + "ReservedDBInstancesOfferingId": "005bdee3-9ef4-4182-aa0c-58ef7cb6c2f8", + "MultiAZ": true, + "DBInstanceClass": "db.m4.xlarge", + "OfferingType": "Partial Upfront", + "RecurringCharges": [ + { + "RecurringChargeAmount": 0.594, + "RecurringChargeFrequency": "Hourly" + } + ], + "FixedPrice": 4089, + "Duration": 31536000 + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "ReservedDBInstancesOfferings", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeReservedDBInstancesOfferingsMessage": { + "type": "structure", + "members": { + "ReservedDBInstancesOfferingId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.

\n

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706\n

" + } + }, + "DBInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

" + } + }, + "Duration": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

\n

Valid Values: 1 | 3 | 31536000 | 94608000\n

" + } + }, + "ProductDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Product description filter value. Specify this parameter to show only the available offerings that contain the specified product description.

\n \n

The results show offerings that partially match the filter value.

\n " + } + }, + "OfferingType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

\n

Valid Values: \"Partial Upfront\" | \"All Upfront\" | \"No Upfront\" \n

" + } + }, + "MultiAZ": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to show only those reservations that support Multi-AZ.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more than the MaxRecords value is available, a pagination token called a marker is\n included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeSourceRegions": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeSourceRegionsMessage" + }, + "output": { + "target": "com.amazonaws.rds#SourceRegionMessage" + }, + "traits": { + "smithy.api#documentation": "

Returns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create a read replica, \n copy a DB snapshot from, or replicate automated backups from.

\n

Use this operation to determine whether cross-Region features are supported between other Regions \n and your current Region. This operation supports pagination.

\n

To return information about the Regions that are enabled for your account, or all Regions, \n use the EC2 operation DescribeRegions. For more information, see \n \n DescribeRegions in the Amazon EC2 API Reference.

", + "smithy.api#examples": [ + { + "title": "To describe source Regions", + "documentation": "The following example retrieves details about all source AWS Regions where the current AWS Region can create a read replica, copy a DB snapshot from, or replicate automated backups from. It also shows that automated backups can be replicated only from US West (Oregon) to the destination AWS Region, US East (N. Virginia).", + "input": { + "RegionName": "us-east-1" + }, + "output": { + "SourceRegions": [ + { + "RegionName": "af-south-1", + "Endpoint": "https://rds.af-south-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": false + }, + { + "RegionName": "ap-east-1", + "Endpoint": "https://rds.ap-east-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": false + }, + { + "RegionName": "ap-northeast-1", + "Endpoint": "https://rds.ap-northeast-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true + }, + { + "RegionName": "ap-northeast-2", + "Endpoint": "https://rds.ap-northeast-2.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true + }, + { + "RegionName": "ap-northeast-3", + "Endpoint": "https://rds.ap-northeast-3.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": false + }, + { + "RegionName": "ap-south-1", + "Endpoint": "https://rds.ap-south-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true + }, + { + "RegionName": "ap-southeast-1", + "Endpoint": "https://rds.ap-southeast-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true + }, + { + "RegionName": "ap-southeast-2", + "Endpoint": "https://rds.ap-southeast-2.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true + }, + { + "RegionName": "ap-southeast-3", + "Endpoint": "https://rds.ap-southeast-3.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": false + }, + { + "RegionName": "ca-central-1", + "Endpoint": "https://rds.ca-central-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true + }, + { + "RegionName": "eu-north-1", + "Endpoint": "https://rds.eu-north-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true + }, + { + "RegionName": "eu-south-1", + "Endpoint": "https://rds.eu-south-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": false + }, + { + "RegionName": "eu-west-1", + "Endpoint": "https://rds.eu-west-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true + }, + { + "RegionName": "eu-west-2", + "Endpoint": "https://rds.eu-west-2.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true + }, + { + "RegionName": "eu-west-3", + "Endpoint": "https://rds.eu-west-3.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true + }, + { + "RegionName": "me-central-1", + "Endpoint": "https://rds.me-central-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": false + }, + { + "RegionName": "me-south-1", + "Endpoint": "https://rds.me-south-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": false + }, + { + "RegionName": "sa-east-1", + "Endpoint": "https://rds.sa-east-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true + }, + { + "RegionName": "us-east-2", + "Endpoint": "https://rds.us-east-2.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true + }, + { + "RegionName": "us-west-1", + "Endpoint": "https://rds.us-west-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true + }, + { + "RegionName": "us-west-2", + "Endpoint": "https://rds.us-west-2.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "SourceRegions", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeSourceRegionsMessage": { + "type": "structure", + "members": { + "RegionName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The source Amazon Web Services Region name. For example, us-east-1.

\n

Constraints:

\n
    \n
  • \n

    Must specify a valid Amazon Web Services Region name.

    \n
    • \n
" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist\n than the specified MaxRecords value, a pagination token called a marker is\n included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeSourceRegions request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeTenantDatabases": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeTenantDatabasesMessage" + }, + "output": { + "target": "com.amazonaws.rds#TenantDatabasesMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the tenant databases in a DB instance that uses the multi-tenant\n configuration. Only RDS for Oracle CDB instances are supported.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "TenantDatabases", + "pageSize": "MaxRecords" + }, + "smithy.waiters#waitable": { + "TenantDatabaseAvailable": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "TenantDatabases[].Status", + "expected": "available", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "TenantDatabases[].Status", + "expected": "deleted", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "TenantDatabases[].Status", + "expected": "incompatible-parameters", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "TenantDatabases[].Status", + "expected": "incompatible-restore", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 30 + }, + "TenantDatabaseDeleted": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "length(TenantDatabases) == `0`", + "expected": "true", + "comparator": "booleanEquals" + } + } + }, + { + "state": "success", + "matcher": { + "errorType": "DBInstanceNotFoundFault" + } + } + ], + "minDelay": 30 + } + } + } + }, + "com.amazonaws.rds#DescribeTenantDatabasesMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The user-supplied DB instance identifier, which must match the identifier of an\n existing instance owned by the Amazon Web Services account. This parameter isn't\n case-sensitive.

" + } + }, + "TenantDBName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The user-supplied tenant database name, which must match the name of an existing\n tenant database on the specified DB instance owned by your Amazon Web Services account. This parameter\n isn’t case-sensitive.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

A filter that specifies one or more database tenants to describe.

\n

Supported filters:

\n
    \n
  • \n

    \n tenant-db-name - Tenant database names. The results list only\n includes information about the tenant databases that match these tenant DB\n names.

    \n
    • \n
  • \n

    \n tenant-database-resource-id - Tenant database resource\n identifiers.

    \n
    • \n
  • \n

    \n dbi-resource-id - DB instance resource identifiers. The results\n list only includes information about the tenants contained within the DB\n instances identified by these resource identifiers.

    \n
    • \n
" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeTenantDatabases request. If this parameter is specified, the\n response includes only records beyond the marker, up to the value specified by\n MaxRecords.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token called a marker is\n included in the response so that you can retrieve the remaining results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeValidDBInstanceModifications": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeValidDBInstanceModificationsMessage" + }, + "output": { + "target": "com.amazonaws.rds#DescribeValidDBInstanceModificationsResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

You can call DescribeValidDBInstanceModifications to learn what modifications you can make to \n your DB instance. You can use this information when you call ModifyDBInstance.

\n

This command doesn't apply to RDS Custom.

", + "smithy.api#examples": [ + { + "title": "To describe valid modifications for a DB instance", + "documentation": "The following example retrieves details about the valid modifications for the specified DB instance.", + "input": { + "DBInstanceIdentifier": "database-test1" + }, + "output": { + "ValidDBInstanceModificationsMessage": { + "Storage": [ + { + "StorageType": "gp2", + "StorageSize": [ + { + "From": 20, + "To": 20, + "Step": 1 + }, + { + "From": 22, + "To": 6144, + "Step": 1 + } + ] + } + ] + } + } + } + ] + } + }, + "com.amazonaws.rds#DescribeValidDBInstanceModificationsMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The customer identifier or the ARN of your DB instance.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeValidDBInstanceModificationsResult": { + "type": "structure", + "members": { + "ValidDBInstanceModificationsMessage": { + "target": "com.amazonaws.rds#ValidDBInstanceModificationsMessage" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.rds#DisableHttpEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DisableHttpEndpointRequest" + }, + "output": { + "target": "com.amazonaws.rds#DisableHttpEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#InvalidResourceStateFault" + }, + { + "target": "com.amazonaws.rds#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Disables the HTTP endpoint for the specified DB cluster. Disabling this endpoint disables RDS Data API.

\n

For more information, see Using RDS Data API in the \n Amazon Aurora User Guide.

\n \n

This operation applies only to Aurora Serverless v2 and provisioned DB clusters. To disable the HTTP endpoint for Aurora Serverless v1 DB clusters, \n use the EnableHttpEndpoint parameter of the ModifyDBCluster operation.

\n " + } + }, + "com.amazonaws.rds#DisableHttpEndpointRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the DB cluster.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DisableHttpEndpointResponse": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN of the DB cluster.

" + } + }, + "HttpEndpointEnabled": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the HTTP endpoint is enabled or disabled for the DB cluster.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DocLink": { + "type": "structure", + "members": { + "Text": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The text with the link to documentation for the recommendation.

" + } + }, + "Url": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The URL for the documentation for the recommendation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A link to documentation that provides additional information for a recommendation.

" + } + }, + "com.amazonaws.rds#DocLinkList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DocLink" + } + }, + "com.amazonaws.rds#DomainMembership": { + "type": "structure", + "members": { + "Domain": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the Active Directory Domain.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.

" + } + }, + "FQDN": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The fully qualified domain name (FQDN) of the Active Directory Domain.

" + } + }, + "IAMRoleName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the IAM role used when making API calls to the Directory Service.

" + } + }, + "OU": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Active Directory organizational unit for the DB instance or cluster.

" + } + }, + "AuthSecretArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN for the Secrets Manager secret with the credentials for the user that's a member of the domain.

" + } + }, + "DnsIps": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The IPv4 DNS IP addresses of the primary and secondary Active Directory domain controllers.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An Active Directory Domain membership record associated with the DB instance or cluster.

" + } + }, + "com.amazonaws.rds#DomainMembershipList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DomainMembership", + "traits": { + "smithy.api#xmlName": "DomainMembership" + } + } + }, + "com.amazonaws.rds#DomainNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DomainNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

\n Domain doesn't refer to an existing Active Directory domain.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#Double": { + "type": "double" + }, + "com.amazonaws.rds#DoubleOptional": { + "type": "double" + }, + "com.amazonaws.rds#DoubleRange": { + "type": "structure", + "members": { + "From": { + "target": "com.amazonaws.rds#Double", + "traits": { + "smithy.api#documentation": "

The minimum value in the range.

" + } + }, + "To": { + "target": "com.amazonaws.rds#Double", + "traits": { + "smithy.api#documentation": "

The maximum value in the range.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A range of double values.

" + } + }, + "com.amazonaws.rds#DoubleRangeList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DoubleRange", + "traits": { + "smithy.api#xmlName": "DoubleRange" + } + } + }, + "com.amazonaws.rds#DownloadDBLogFilePortion": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DownloadDBLogFilePortionMessage" + }, + "output": { + "target": "com.amazonaws.rds#DownloadDBLogFilePortionDetails" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceNotReadyFault" + }, + { + "target": "com.amazonaws.rds#DBLogFileNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Downloads all or a portion of the specified log file, up to 1 MB in size.

\n

This command doesn't apply to RDS Custom.

", + "smithy.api#examples": [ + { + "title": "To download a DB log file", + "documentation": "The following example downloads only the latest part of your log file.", + "input": { + "DBInstanceIdentifier": "test-instance", + "LogFileName": "log.txt" + }, + "output": {} + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "pageSize": "NumberOfLines" + } + } + }, + "com.amazonaws.rds#DownloadDBLogFilePortionDetails": { + "type": "structure", + "members": { + "LogFileData": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Entries from the specified log file.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a later DownloadDBLogFilePortion request.

" + } + }, + "AdditionalDataPending": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value that, if true, indicates there is more data to be downloaded.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a response element to DownloadDBLogFilePortion.

" + } + }, + "com.amazonaws.rds#DownloadDBLogFilePortionMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The customer-assigned name of the DB instance that contains the log files you want to list.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DBInstance.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "LogFileName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the log file to be downloaded.

", + "smithy.api#required": {} + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The pagination token provided in the previous request or \"0\". If the Marker parameter is specified the response includes only records beyond the marker until the end of the file or up to NumberOfLines.

" + } + }, + "NumberOfLines": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#documentation": "

The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file is truncated at 1 MB in size.

\n

If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning \n or the end of the log file, depending on the value of the Marker parameter.

\n
    \n
  • \n

    If neither Marker or NumberOfLines are specified, the entire log file is returned up to a \n maximum of 10000 lines, starting with the most recent log entries first.

    \n
    • \n
  • \n

    If \n NumberOfLines is specified and Marker isn't specified, then the most recent lines from the end \n of the log file are returned.

    \n
    • \n
  • \n

    If Marker is specified as \"0\", then the specified \n number of lines from the beginning of the log file are returned.

    \n
    • \n
  • \n

    You can \n download the log file in blocks of lines by specifying the size of the block using \n the NumberOfLines parameter, and by specifying a value of \"0\" for the Marker parameter in your \n first request. Include the Marker value returned in the response as the Marker value for the next \n request, continuing until the AdditionalDataPending response element returns false.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#EC2SecurityGroup": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the status of the EC2 security group. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".

" + } + }, + "EC2SecurityGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the EC2 security group.

" + } + }, + "EC2SecurityGroupId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the id of the EC2 security group.

" + } + }, + "EC2SecurityGroupOwnerId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the Amazon Web Services ID of the owner of the EC2 security group\n specified in the EC2SecurityGroupName field.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a response element in the following actions:

\n
    \n
  • \n

    \n AuthorizeDBSecurityGroupIngress\n

    \n
    • \n
  • \n

    \n DescribeDBSecurityGroups\n

    \n
    • \n
  • \n

    \n RevokeDBSecurityGroupIngress\n

    \n
    • \n
" + } + }, + "com.amazonaws.rds#EC2SecurityGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#EC2SecurityGroup", + "traits": { + "smithy.api#xmlName": "EC2SecurityGroup" + } + } + }, + "com.amazonaws.rds#Ec2ImagePropertiesNotSupportedFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "Ec2ImagePropertiesNotSupportedFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The AMI configuration prerequisite has not been met.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#EnableHttpEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#EnableHttpEndpointRequest" + }, + "output": { + "target": "com.amazonaws.rds#EnableHttpEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#InvalidResourceStateFault" + }, + { + "target": "com.amazonaws.rds#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Enables the HTTP endpoint for the DB cluster. By default, the HTTP endpoint \n isn't enabled.

\n

When enabled, this endpoint provides a connectionless web service API (RDS Data API) \n for running SQL queries on the Aurora DB cluster. You can also query your database from inside the RDS console \n with the RDS query editor.

\n

For more information, see Using RDS Data API in the \n Amazon Aurora User Guide.

\n \n

This operation applies only to Aurora Serverless v2 and provisioned DB clusters. To enable the HTTP endpoint for Aurora Serverless v1 DB clusters, \n use the EnableHttpEndpoint parameter of the ModifyDBCluster operation.

\n " + } + }, + "com.amazonaws.rds#EnableHttpEndpointRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the DB cluster.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#EnableHttpEndpointResponse": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN of the DB cluster.

" + } + }, + "HttpEndpointEnabled": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the HTTP endpoint is enabled or disabled for the DB cluster.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#EncryptionContextMap": { + "type": "map", + "key": { + "target": "com.amazonaws.rds#String" + }, + "value": { + "target": "com.amazonaws.rds#String" + } + }, + "com.amazonaws.rds#Endpoint": { + "type": "structure", + "members": { + "Address": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the DNS address of the DB instance.

" + } + }, + "Port": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#documentation": "

Specifies the port that the database engine is listening on.

" + } + }, + "HostedZoneId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type represents the information you need to connect to an Amazon RDS DB instance.\n This data type is used as a response element in the following actions:

\n
    \n
  • \n

    \n CreateDBInstance\n

    \n
    • \n
  • \n

    \n DescribeDBInstances\n

    \n
    • \n
  • \n

    \n DeleteDBInstance\n

    \n
    • \n
\n

For the data structure that represents Amazon Aurora DB cluster endpoints,\n see DBClusterEndpoint.

" + } + }, + "com.amazonaws.rds#EngineDefaults": { + "type": "structure", + "members": { + "DBParameterGroupFamily": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the DB parameter group family that the engine default parameters apply to.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n EngineDefaults request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .

" + } + }, + "Parameters": { + "target": "com.amazonaws.rds#ParametersList", + "traits": { + "smithy.api#documentation": "

Contains a list of engine default parameters.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.

" + } + }, + "com.amazonaws.rds#EngineFamily": { + "type": "enum", + "members": { + "MYSQL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MYSQL" + } + }, + "POSTGRESQL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POSTGRESQL" + } + }, + "SQLSERVER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SQLSERVER" + } + } + } + }, + "com.amazonaws.rds#EngineModeList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String" + } + }, + "com.amazonaws.rds#Event": { + "type": "structure", + "members": { + "SourceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the identifier for the source of the event.

" + } + }, + "SourceType": { + "target": "com.amazonaws.rds#SourceType", + "traits": { + "smithy.api#documentation": "

Specifies the source type for this event.

" + } + }, + "Message": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the text of this event.

" + } + }, + "EventCategories": { + "target": "com.amazonaws.rds#EventCategoriesList", + "traits": { + "smithy.api#documentation": "

Specifies the category for the event.

" + } + }, + "Date": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

Specifies the date and time of the event.

" + } + }, + "SourceArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the event.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a response element in the DescribeEvents action.

" + } + }, + "com.amazonaws.rds#EventCategoriesList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#xmlName": "EventCategory" + } + } + }, + "com.amazonaws.rds#EventCategoriesMap": { + "type": "structure", + "members": { + "SourceType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The source type that the returned categories belong to

" + } + }, + "EventCategories": { + "target": "com.amazonaws.rds#EventCategoriesList", + "traits": { + "smithy.api#documentation": "

The event categories for the specified source type

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the results of a successful invocation of the DescribeEventCategories\n operation.

" + } + }, + "com.amazonaws.rds#EventCategoriesMapList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#EventCategoriesMap", + "traits": { + "smithy.api#xmlName": "EventCategoriesMap" + } + } + }, + "com.amazonaws.rds#EventCategoriesMessage": { + "type": "structure", + "members": { + "EventCategoriesMapList": { + "target": "com.amazonaws.rds#EventCategoriesMapList", + "traits": { + "smithy.api#documentation": "

A list of EventCategoriesMap data types.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Data returned from the DescribeEventCategories operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#EventList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#Event", + "traits": { + "smithy.api#xmlName": "Event" + } + } + }, + "com.amazonaws.rds#EventSubscription": { + "type": "structure", + "members": { + "CustomerAwsId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services customer account associated with the RDS event notification subscription.

" + } + }, + "CustSubscriptionId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The RDS event notification subscription Id.

" + } + }, + "SnsTopicArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The topic ARN of the RDS event notification subscription.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The status of the RDS event notification subscription.

\n

Constraints:

\n

Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

\n

The status \"no-permission\" indicates that RDS no longer has permission to post to the SNS topic. The status \"topic-not-exist\" indicates that the topic was deleted after the subscription was created.

" + } + }, + "SubscriptionCreationTime": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The time the RDS event notification subscription was created.

" + } + }, + "SourceType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The source type for the RDS event notification subscription.

" + } + }, + "SourceIdsList": { + "target": "com.amazonaws.rds#SourceIdsList", + "traits": { + "smithy.api#documentation": "

A list of source IDs for the RDS event notification subscription.

" + } + }, + "EventCategoriesList": { + "target": "com.amazonaws.rds#EventCategoriesList", + "traits": { + "smithy.api#documentation": "

A list of event categories for the RDS event notification subscription.

" + } + }, + "Enabled": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the subscription is enabled. True indicates the subscription is enabled.

" + } + }, + "EventSubscriptionArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the event subscription.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

" + } + }, + "com.amazonaws.rds#EventSubscriptionQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "EventSubscriptionQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

You have reached the maximum number of event subscriptions.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#EventSubscriptionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#EventSubscription", + "traits": { + "smithy.api#xmlName": "EventSubscription" + } + } + }, + "com.amazonaws.rds#EventSubscriptionsMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeOrderableDBInstanceOptions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "EventSubscriptionsList": { + "target": "com.amazonaws.rds#EventSubscriptionsList", + "traits": { + "smithy.api#documentation": "

A list of EventSubscriptions data types.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Data returned by the DescribeEventSubscriptions action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#EventsMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous \n Events request.\n If this parameter is specified, the response includes\n only records beyond the marker, \n up to the value specified by MaxRecords.

" + } + }, + "Events": { + "target": "com.amazonaws.rds#EventList", + "traits": { + "smithy.api#documentation": "

A list of Event instances.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeEvents action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#ExceptionMessage": { + "type": "string" + }, + "com.amazonaws.rds#ExportSourceType": { + "type": "enum", + "members": { + "SNAPSHOT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SNAPSHOT" + } + }, + "CLUSTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLUSTER" + } + } + } + }, + "com.amazonaws.rds#ExportTask": { + "type": "structure", + "members": { + "ExportTaskIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A unique identifier for the snapshot or cluster export task. This ID isn't an identifier for\n the Amazon S3 bucket where the data is exported.

" + } + }, + "SourceArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.

" + } + }, + "ExportOnly": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The data exported from the snapshot or cluster.

\n

Valid Values:

\n
    \n
  • \n

    \n database - Export all the data from a specified database.

    \n
    • \n
  • \n

    \n database.table\n table-name - \n Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.

    \n
    • \n
  • \n

    \n database.schema\n schema-name - Export a database schema of the snapshot or cluster. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

    \n
    • \n
  • \n

    \n database.schema.table\n table-name - Export a table of the database schema. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

    \n
    • \n
" + } + }, + "SnapshotTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The time when the snapshot was created.

" + } + }, + "TaskStartTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The time when the snapshot or cluster export task started.

" + } + }, + "TaskEndTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The time when the snapshot or cluster export task ended.

" + } + }, + "S3Bucket": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon S3 bucket where the snapshot or cluster is exported to.

" + } + }, + "S3Prefix": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon S3 bucket prefix that is the file name and path of the exported data.

" + } + }, + "IamRoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot or cluster.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The key identifier of the Amazon Web Services KMS key that is used to encrypt the data when it's exported to Amazon S3. \n The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the export\n must have encryption and decryption permissions to use this KMS key.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The progress status of the export task. The status can be one of the following:

\n
    \n
  • \n

    \n CANCELED\n

    \n
    • \n
  • \n

    \n CANCELING\n

    \n
    • \n
  • \n

    \n COMPLETE\n

    \n
    • \n
  • \n

    \n FAILED\n

    \n
    • \n
  • \n

    \n IN_PROGRESS\n

    \n
    • \n
  • \n

    \n STARTING\n

    \n
    • \n
" + } + }, + "PercentProgress": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#documentation": "

The progress of the snapshot or cluster export task as a percentage.

" + } + }, + "TotalExtractedDataInGB": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#documentation": "

The total amount of data exported, in gigabytes.

" + } + }, + "FailureCause": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The reason the export failed, if it failed.

" + } + }, + "WarningMessage": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A warning about the snapshot or cluster export task.

" + } + }, + "SourceType": { + "target": "com.amazonaws.rds#ExportSourceType", + "traits": { + "smithy.api#documentation": "

The type of source for the export.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details of a snapshot or cluster export to Amazon S3.

\n

This data type is used as a response element in the DescribeExportTasks operation.

" + } + }, + "com.amazonaws.rds#ExportTaskAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ExportTaskAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

You can't start an export task that's already running.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#ExportTaskNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ExportTaskNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The export task doesn't exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#ExportTasksList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#ExportTask", + "traits": { + "smithy.api#xmlName": "ExportTask" + } + } + }, + "com.amazonaws.rds#ExportTasksMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a later DescribeExportTasks\n request. A marker is used for pagination to identify the location to begin output for\n the next response of DescribeExportTasks.

" + } + }, + "ExportTasks": { + "target": "com.amazonaws.rds#ExportTasksList", + "traits": { + "smithy.api#documentation": "

Information about an export of a snapshot or cluster to Amazon S3.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#FailoverDBCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#FailoverDBClusterMessage" + }, + "output": { + "target": "com.amazonaws.rds#FailoverDBClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Forces a failover for a DB cluster.

\n

For an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances)\n in the DB cluster to be the primary DB instance (the cluster writer).

\n

For a Multi-AZ DB cluster, after RDS terminates the primary DB instance, the\n internal monitoring system detects that the primary DB instance is unhealthy and promotes a readable standby (read-only instances) \n in the DB cluster to be the primary DB instance (the cluster writer).\n Failover times are typically less than 35 seconds.

\n

An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists,\n when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readable standby \n DB instance when the primary DB instance fails.

\n

To simulate a failure of a primary instance for testing, you can force a failover. \n Because each instance in a DB cluster has its own endpoint address, make sure to clean up and re-establish any existing \n connections that use those endpoint addresses when the failover is complete.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

", + "smithy.api#examples": [ + { + "title": "To perform a failover for a DB cluster", + "documentation": "This example performs a failover for the specified DB cluster to the specified DB instance.", + "input": { + "DBClusterIdentifier": "myaurorainstance-cluster", + "TargetDBInstanceIdentifier": "myaurorareplica" + }, + "output": { + "DBCluster": {} + } + } + ] + } + }, + "com.amazonaws.rds#FailoverDBClusterMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier of the DB cluster to force a failover for. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DB cluster.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "TargetDBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB instance to promote to the primary DB instance.

\n

Specify the DB instance identifier for an Aurora Replica or a Multi-AZ readable standby in the DB cluster,\n for example mydbcluster-replica1.

\n

This setting isn't supported for RDS for MySQL Multi-AZ DB clusters.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#FailoverDBClusterResult": { + "type": "structure", + "members": { + "DBCluster": { + "target": "com.amazonaws.rds#DBCluster" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#FailoverGlobalCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#FailoverGlobalClusterMessage" + }, + "output": { + "target": "com.amazonaws.rds#FailoverGlobalClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#GlobalClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidGlobalClusterStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Promotes the specified secondary DB cluster to be the primary DB cluster in the global database cluster to fail over or switch over a global database. Switchover operations were previously called \"managed planned failovers.\"

\n \n

Although this operation can be used either to fail over or to switch over a global database cluster, its intended use is for global database failover. \n To switch over a global database cluster, we recommend that you use the SwitchoverGlobalCluster operation instead.

\n \n

How you use this operation depends on whether you are failing over or switching over your global database cluster:

\n
    \n
  • \n

    Failing over - Specify the AllowDataLoss parameter and don't specify the Switchover parameter.

    \n
    • \n
  • \n

    Switching over - Specify the Switchover parameter or omit it, but don't specify the AllowDataLoss parameter.

    \n
    • \n
\n

\n About failing over and switching over\n

\n

While failing over and switching over a global database cluster both change the primary DB cluster, you use these operations for different reasons:

\n
    \n
  • \n

    \n Failing over - Use this operation to respond to an unplanned event, such as a Regional disaster in the primary Region. \n Failing over can result in a loss of write transaction data that wasn't replicated to the chosen secondary before the failover event occurred. \n However, the recovery process that promotes a DB instance on the chosen seconday DB cluster to be the primary writer DB instance guarantees \n that the data is in a transactionally consistent state.

    \n

    For more information about failing over an Amazon Aurora global database, see\n Performing managed failovers for Aurora global databases in the Amazon Aurora User Guide.

    \n
    • \n
  • \n

    \n Switching over - Use this operation on a healthy global database cluster for planned events, such as Regional rotation or to \n fail back to the original primary DB cluster after a failover operation. With this operation, there is no data loss.

    \n

    For more information about switching over an Amazon Aurora global database, see\n Performing switchovers for Aurora global databases in the Amazon Aurora User Guide.

    \n
    • \n
" + } + }, + "com.amazonaws.rds#FailoverGlobalClusterMessage": { + "type": "structure", + "members": { + "GlobalClusterIdentifier": { + "target": "com.amazonaws.rds#GlobalClusterIdentifier", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier of the global database cluster (Aurora global database) this operation should apply to. \n The identifier is the unique key assigned by the user when the Aurora global database is created. In other words,\n it's the name of the Aurora global database.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing global database cluster.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "TargetDbClusterIdentifier": { + "target": "com.amazonaws.rds#DBClusterIdentifier", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier of the secondary Aurora DB cluster that you want to promote to the primary for the global database cluster. Use the Amazon Resource Name (ARN) for the identifier so that\n Aurora can locate the cluster in its Amazon Web Services Region.

", + "smithy.api#required": {} + } + }, + "AllowDataLoss": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to allow data loss for this global database cluster operation. Allowing data loss triggers a global failover operation.

\n

If you don't specify AllowDataLoss, the global database cluster operation defaults to a switchover.

\n

Constraints:

\n
    \n
  • \n

    Can't be specified together with the Switchover parameter.

    \n
    • \n
" + } + }, + "Switchover": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to switch over this global database cluster.

\n

Constraints:

\n
    \n
  • \n

    Can't be specified together with the AllowDataLoss parameter.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#FailoverGlobalClusterResult": { + "type": "structure", + "members": { + "GlobalCluster": { + "target": "com.amazonaws.rds#GlobalCluster" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#FailoverState": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.rds#FailoverStatus", + "traits": { + "smithy.api#documentation": "

The current status of the global cluster. Possible values are as follows:

\n
    \n
  • \n

    pending – The service received a request to switch over or fail over the global cluster. The\n global cluster's primary DB cluster and the specified secondary DB cluster are being verified before the operation\n starts.

    \n
    • \n
  • \n

    failing-over – Aurora is promoting the chosen secondary Aurora DB cluster to become the new primary DB cluster to fail over the global cluster.

    \n
    • \n
  • \n

    cancelling – The request to switch over or fail over the global cluster was cancelled and the primary\n Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states.

    \n
    • \n
  • \n

    switching-over – This status covers the range of Aurora internal operations that take place during the switchover process, such\n as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB cluster, and synchronizing replicas.

    \n
    • \n
" + } + }, + "FromDbClusterArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this\n state.

" + } + }, + "ToDbClusterArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being promoted, and which is associated\n with this state.

" + } + }, + "IsDataLossAllowed": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the operation is a global switchover or a global failover. If data loss is allowed, then the operation is a global failover. \n Otherwise, it's a switchover.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the state of scheduled or in-process operations on a\n global cluster (Aurora global database). This data type is empty unless a switchover \n or failover operation is scheduled or is in progress on the Aurora global database.

" + } + }, + "com.amazonaws.rds#FailoverStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "FAILING_OVER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failing-over" + } + }, + "CANCELLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cancelling" + } + } + } + }, + "com.amazonaws.rds#FeatureNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String" + } + }, + "com.amazonaws.rds#Filter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the filter. Filter names are case-sensitive.

", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.rds#FilterValueList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

One or more filter values. Filter values are case-sensitive.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A filter name and value pair that is used to return a more specific list of results \n from a describe operation. Filters can be used to match a set of resources by specific \n criteria, such as IDs. The filters supported by a describe operation are documented \n with the describe operation.

\n \n

Currently, wildcards are not supported in filters.

\n \n

The following actions can be filtered:

\n
    \n
  • \n

    \n DescribeDBClusterBacktracks\n

    \n
    • \n
  • \n

    \n DescribeDBClusterEndpoints\n

    \n
    • \n
  • \n

    \n DescribeDBClusters\n

    \n
    • \n
  • \n

    \n DescribeDBInstances\n

    \n
    • \n
  • \n

    \n DescribeDBRecommendations\n

    \n
    • \n
  • \n

    \n DescribeDBShardGroups\n

    \n
    • \n
  • \n

    \n DescribePendingMaintenanceActions\n

    \n
    • \n
" + } + }, + "com.amazonaws.rds#FilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#Filter", + "traits": { + "smithy.api#xmlName": "Filter" + } + } + }, + "com.amazonaws.rds#FilterValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#xmlName": "Value" + } + } + }, + "com.amazonaws.rds#GlobalCluster": { + "type": "structure", + "members": { + "GlobalClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Contains a user-supplied global database cluster identifier. This identifier is the unique key that\n identifies a global database cluster.

" + } + }, + "GlobalClusterResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in\n Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB cluster is accessed.

" + } + }, + "GlobalClusterArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the global database cluster.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the current state of this global database cluster.

" + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Aurora database engine used by the global database cluster.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Indicates the database engine version.

" + } + }, + "EngineLifecycleSupport": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The life cycle type for the global cluster.

\n

For more information, see CreateGlobalCluster.

" + } + }, + "DatabaseName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The default database name within the new global database cluster.

" + } + }, + "StorageEncrypted": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

The storage encryption setting for the global database cluster.

" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

The deletion protection setting for the new global database cluster.

" + } + }, + "GlobalClusterMembers": { + "target": "com.amazonaws.rds#GlobalClusterMemberList", + "traits": { + "smithy.api#documentation": "

The list of primary and secondary clusters within the global database cluster.

" + } + }, + "Endpoint": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

\n The writer endpoint for the new global database cluster. This endpoint always \n points to the writer DB instance in the current primary cluster.\n

" + } + }, + "FailoverState": { + "target": "com.amazonaws.rds#FailoverState", + "traits": { + "smithy.api#documentation": "

A data object containing all properties for the current state of an in-process or pending switchover or failover process for this global cluster (Aurora global database).\n This object is empty unless the SwitchoverGlobalCluster or FailoverGlobalCluster operation was called on this global cluster.

" + } + }, + "TagList": { + "target": "com.amazonaws.rds#TagList" + } + }, + "traits": { + "smithy.api#documentation": "

A data type representing an Aurora global database.

" + } + }, + "com.amazonaws.rds#GlobalClusterAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "GlobalClusterAlreadyExistsFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The GlobalClusterIdentifier already exists. Specify a new global database identifier \n (unique name) to create a new global database cluster or to rename an existing one.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#GlobalClusterIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[A-Za-z][0-9A-Za-z-:._]*$" + } + }, + "com.amazonaws.rds#GlobalClusterList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#GlobalCluster", + "traits": { + "smithy.api#xmlName": "GlobalClusterMember" + } + } + }, + "com.amazonaws.rds#GlobalClusterMember": { + "type": "structure", + "members": { + "DBClusterArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for each Aurora DB cluster in the global cluster.

" + } + }, + "Readers": { + "target": "com.amazonaws.rds#ReadersArnList", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for each read-only secondary cluster\n associated with the global cluster.

" + } + }, + "IsWriter": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the Aurora DB cluster is the primary cluster\n (that is, has read-write capability) for the global\n cluster with which it is associated.

" + } + }, + "GlobalWriteForwardingStatus": { + "target": "com.amazonaws.rds#WriteForwardingStatus", + "traits": { + "smithy.api#documentation": "

The status of write forwarding for a secondary cluster in the global cluster.

" + } + }, + "SynchronizationStatus": { + "target": "com.amazonaws.rds#GlobalClusterMemberSynchronizationStatus", + "traits": { + "smithy.api#documentation": "

The status of synchronization of each Aurora DB cluster in the global cluster.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A data structure with information about any primary and\n secondary clusters associated with a global cluster (Aurora global database).

" + } + }, + "com.amazonaws.rds#GlobalClusterMemberList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#GlobalClusterMember", + "traits": { + "smithy.api#xmlName": "GlobalClusterMember" + } + } + }, + "com.amazonaws.rds#GlobalClusterMemberSynchronizationStatus": { + "type": "enum", + "members": { + "CONNECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "connected" + } + }, + "PENDING_RESYNC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending-resync" + } + } + } + }, + "com.amazonaws.rds#GlobalClusterNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "GlobalClusterNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The GlobalClusterIdentifier doesn't refer to an existing global database cluster.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#GlobalClusterQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "GlobalClusterQuotaExceededFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The number of global database clusters for this account is already at the maximum allowed.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#GlobalClustersMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeGlobalClusters request.\n If this parameter is specified, the response includes\n only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "GlobalClusters": { + "target": "com.amazonaws.rds#GlobalClusterList", + "traits": { + "smithy.api#documentation": "

The list of global clusters returned by this request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#IAMAuthMode": { + "type": "enum", + "members": { + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + }, + "REQUIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REQUIRED" + } + }, + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + } + } + }, + "com.amazonaws.rds#IPRange": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The status of the IP range. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".

" + } + }, + "CIDRIP": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The IP range.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a response element in the DescribeDBSecurityGroups action.

" + } + }, + "com.amazonaws.rds#IPRangeList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#IPRange", + "traits": { + "smithy.api#xmlName": "IPRange" + } + } + }, + "com.amazonaws.rds#IamRoleMissingPermissionsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "IamRoleMissingPermissions", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The IAM role requires additional permissions to export to an Amazon S3 bucket.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#IamRoleNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "IamRoleNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The IAM role is missing for exporting to an Amazon S3 bucket.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#InstanceQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InstanceQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request would result in the user exceeding the allowed number of DB\n instances.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InsufficientAvailableIPsInSubnetFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InsufficientAvailableIPsInSubnetFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The requested operation can't be performed because there aren't enough available IP addresses \n in the proxy's subnets. Add more CIDR blocks to the VPC or remove IP address that aren't required \n from the subnets.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InsufficientDBClusterCapacityFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InsufficientDBClusterCapacityFault", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "

The DB cluster doesn't have enough capacity for the current operation.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.rds#InsufficientDBInstanceCapacityFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InsufficientDBInstanceCapacity", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The specified DB instance class isn't available in the specified Availability\n Zone.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InsufficientStorageClusterCapacityFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InsufficientStorageClusterCapacity", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

There is insufficient storage available for the current action. You might be able to\n resolve this error by updating your subnet group to use different Availability Zones\n that have more storage available.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#Integer": { + "type": "integer" + }, + "com.amazonaws.rds#IntegerOptional": { + "type": "integer" + }, + "com.amazonaws.rds#Integration": { + "type": "structure", + "members": { + "SourceArn": { + "target": "com.amazonaws.rds#SourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the database used as the source for\n replication.

" + } + }, + "TargetArn": { + "target": "com.amazonaws.rds#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the Redshift data warehouse used as the target for replication.

" + } + }, + "IntegrationName": { + "target": "com.amazonaws.rds#IntegrationName", + "traits": { + "smithy.api#documentation": "

The name of the integration.

" + } + }, + "IntegrationArn": { + "target": "com.amazonaws.rds#IntegrationArn", + "traits": { + "smithy.api#documentation": "

The ARN of the integration.

" + } + }, + "KMSKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key used to to\n encrypt the integration.

" + } + }, + "AdditionalEncryptionContext": { + "target": "com.amazonaws.rds#EncryptionContextMap", + "traits": { + "smithy.api#documentation": "

The encryption context for the integration. For more information, see Encryption context in the Amazon Web Services Key Management Service Developer\n Guide.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#IntegrationStatus", + "traits": { + "smithy.api#documentation": "

The current status of the integration.

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + }, + "CreateTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The time when the integration was created, in Universal Coordinated Time\n (UTC).

" + } + }, + "Errors": { + "target": "com.amazonaws.rds#IntegrationErrorList", + "traits": { + "smithy.api#documentation": "

Any errors associated with the integration.

" + } + }, + "DataFilter": { + "target": "com.amazonaws.rds#DataFilter", + "traits": { + "smithy.api#documentation": "

Data filters for the integration. These filters determine which tables\n from the source database are sent to the target Amazon Redshift data warehouse. \n

" + } + }, + "Description": { + "target": "com.amazonaws.rds#IntegrationDescription", + "traits": { + "smithy.api#documentation": "

A description of the integration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A zero-ETL integration with Amazon Redshift.

" + } + }, + "com.amazonaws.rds#IntegrationAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "IntegrationAlreadyExistsFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The integration you are trying to create already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#IntegrationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:rds(-[a-z]*)?:[a-z0-9\\-]*:[0-9]*:integration:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" + } + }, + "com.amazonaws.rds#IntegrationConflictOperationFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "IntegrationConflictOperationFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

A conflicting conditional operation is currently in progress against this resource.\n Typically occurs when there are multiple requests being made to the same resource at the same time,\n and these requests conflict with each other.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#IntegrationDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.rds#IntegrationError": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The error code associated with the integration.

", + "smithy.api#required": {} + } + }, + "ErrorMessage": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A message explaining the error.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An error associated with a zero-ETL integration with Amazon Redshift.

" + } + }, + "com.amazonaws.rds#IntegrationErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#IntegrationError", + "traits": { + "smithy.api#xmlName": "IntegrationError" + } + } + }, + "com.amazonaws.rds#IntegrationIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_:\\-\\/]+$" + } + }, + "com.amazonaws.rds#IntegrationList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#Integration", + "traits": { + "smithy.api#xmlName": "Integration" + } + } + }, + "com.amazonaws.rds#IntegrationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$" + } + }, + "com.amazonaws.rds#IntegrationNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "IntegrationNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified integration could not be found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#IntegrationQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "IntegrationQuotaExceededFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

You can't crate any more zero-ETL integrations because the quota has been reached.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#IntegrationStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "creating" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "MODIFYING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modifying" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + }, + "SYNCING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "syncing" + } + }, + "NEEDS_ATTENTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "needs_attention" + } + } + } + }, + "com.amazonaws.rds#InvalidBlueGreenDeploymentStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidBlueGreenDeploymentStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The blue/green deployment can't be switched over or deleted because there is an invalid configuration in \n the green environment.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidCustomDBEngineVersionStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidCustomDBEngineVersionStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

You can't delete the CEV.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidDBClusterAutomatedBackupStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBClusterAutomatedBackupStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The automated backup is in an invalid state. \n For example, this automated backup is associated with an active cluster.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidDBClusterCapacityFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBClusterCapacityFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

\n Capacity isn't a valid Aurora Serverless DB cluster\n capacity. Valid capacity values are 2, 4, 8, 16, \n 32, 64, 128, and 256.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidDBClusterEndpointStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBClusterEndpointStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The requested operation can't be performed on the endpoint while the endpoint is in this state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidDBClusterSnapshotStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBClusterSnapshotStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The supplied value isn't a valid DB cluster snapshot state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidDBClusterStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBClusterStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The requested operation can't be performed while the cluster is in this state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidDBInstanceAutomatedBackupStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBInstanceAutomatedBackupState", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The automated backup is in an invalid state. \n For example, this automated backup is associated with an active instance.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidDBInstanceStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBInstanceState", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The DB instance isn't in a valid state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidDBParameterGroupStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBParameterGroupState", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The DB parameter group is in use or is in an invalid state. If you are attempting\n to delete the parameter group, you can't delete it when the parameter group is in\n this state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidDBProxyEndpointStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBProxyEndpointStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

You can't perform this operation while the DB proxy endpoint is in a particular state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidDBProxyStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBProxyStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The requested operation can't be performed while the proxy is in this state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidDBSecurityGroupStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBSecurityGroupState", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The state of the DB security group doesn't allow deletion.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidDBShardGroupStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBShardGroupState", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The DB shard group must be in the available state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidDBSnapshotStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBSnapshotState", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The state of the DB snapshot doesn't allow deletion.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidDBSubnetGroupFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBSubnetGroupFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The DBSubnetGroup doesn't belong to the same VPC as that of an existing\n cross-region read replica of the same source instance.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidDBSubnetGroupStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBSubnetGroupStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The DB subnet group cannot be deleted because it's in use.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidDBSubnetStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBSubnetStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The DB subnet isn't in the available state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidEventSubscriptionStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidEventSubscriptionState", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This error can occur if someone else is modifying a subscription. You should retry the action.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidExportOnlyFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidExportOnly", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The export is invalid for exporting to an Amazon S3 bucket.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidExportSourceStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidExportSourceState", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The state of the export snapshot is invalid for exporting to an Amazon S3 bucket.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidExportTaskStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidExportTaskStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

You can't cancel an export task that has completed.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidGlobalClusterStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidGlobalClusterStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The global cluster is in an invalid state and can't perform the requested operation.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidIntegrationStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidIntegrationStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The integration is in an invalid state and can't perform the requested operation.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidOptionGroupStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidOptionGroupStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The option group isn't in the available state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidResourceStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidResourceStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The operation can't be performed because another operation is in progress.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidRestoreFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidRestoreFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Cannot restore from VPC backup to non-VPC DB instance.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidS3BucketFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidS3BucketFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The specified Amazon S3 bucket name can't be found or Amazon RDS isn't\n authorized to access the specified Amazon S3 bucket. Verify the SourceS3BucketName and S3IngestionRoleArn values and try again.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidSubnet": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidSubnet", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidVPCNetworkStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidVPCNetworkStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The DB subnet group doesn't cover all Availability Zones after it's\n created because of users' change.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#IssueDetails": { + "type": "structure", + "members": { + "PerformanceIssueDetails": { + "target": "com.amazonaws.rds#PerformanceIssueDetails", + "traits": { + "smithy.api#documentation": "

A detailed description of the issue when the recommendation category is performance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The details of an issue with your DB instances, DB clusters, and DB parameter groups.

" + } + }, + "com.amazonaws.rds#KMSKeyNotAccessibleFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "KMSKeyNotAccessibleFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

An error occurred accessing an Amazon Web Services KMS key.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#KeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String" + } + }, + "com.amazonaws.rds#KmsKeyIdOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_:\\-\\/]+$" + } + }, + "com.amazonaws.rds#LimitlessDatabase": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.rds#LimitlessDatabaseStatus", + "traits": { + "smithy.api#documentation": "

The status of Aurora Limitless Database.

" + } + }, + "MinRequiredACU": { + "target": "com.amazonaws.rds#DoubleOptional", + "traits": { + "smithy.api#documentation": "

The minimum required capacity for Aurora Limitless Database in Aurora capacity units (ACUs).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details for Aurora Limitless Database.

" + } + }, + "com.amazonaws.rds#LimitlessDatabaseStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "NOT_IN_USE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "not-in-use" + } + }, + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + }, + "ENABLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabling" + } + }, + "DISABLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabling" + } + }, + "MODIFYING_MAX_CAPACITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modifying-max-capacity" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "error" + } + } + } + }, + "com.amazonaws.rds#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ListTagsForResourceMessage" + }, + "output": { + "target": "com.amazonaws.rds#TagListMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#BlueGreenDeploymentNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBProxyNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSnapshotTenantDatabaseNotFoundFault" + }, + { + "target": "com.amazonaws.rds#IntegrationNotFoundFault" + }, + { + "target": "com.amazonaws.rds#TenantDatabaseNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all tags on an Amazon RDS resource.

\n

For an overview on tagging an Amazon RDS resource, \n see Tagging Amazon RDS Resources in the Amazon RDS User Guide\n or Tagging Amazon Aurora and Amazon RDS Resources in the Amazon Aurora User Guide.

", + "smithy.api#examples": [ + { + "title": "To list tags on an Amazon RDS resource", + "documentation": "The following example lists all tags on a DB instance.", + "input": { + "ResourceName": "arn:aws:rds:us-east-1:123456789012:db:orcl1" + }, + "output": { + "TagList": [ + { + "Key": "Environment", + "Value": "test" + }, + { + "Key": "Name", + "Value": "MyDatabase" + } + ] + } + } + ] + } + }, + "com.amazonaws.rds#ListTagsForResourceMessage": { + "type": "structure", + "members": { + "ResourceName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon RDS resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about \n creating an ARN, \n see \n Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#LocalWriteForwardingStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + }, + "ENABLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabling" + } + }, + "DISABLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabling" + } + }, + "REQUESTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "requested" + } + } + } + }, + "com.amazonaws.rds#LogTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String" + } + }, + "com.amazonaws.rds#Long": { + "type": "long" + }, + "com.amazonaws.rds#LongOptional": { + "type": "long" + }, + "com.amazonaws.rds#Marker": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 340 + } + } + }, + "com.amazonaws.rds#MasterUserSecret": { + "type": "structure", + "members": { + "SecretArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the secret.

" + } + }, + "SecretStatus": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The status of the secret.

\n

The possible status values include the following:

\n
    \n
  • \n

    \n creating - The secret is being created.

    \n
    • \n
  • \n

    \n active - The secret is available for normal use and rotation.

    \n
    • \n
  • \n

    \n rotating - The secret is being rotated.

    \n
    • \n
  • \n

    \n impaired - The secret can be used to access database credentials,\n but it can't be rotated. A secret might have this status if, for example,\n permissions are changed so that RDS can no longer access either the secret or\n the KMS key for the secret.

    \n

    When a secret has this status, you can correct the condition that caused the\n status. Alternatively, modify the DB instance to turn off automatic management\n of database credentials, and then modify the DB instance again to turn on\n automatic management of database credentials.

    \n
    • \n
" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier that is used to encrypt the secret.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n

" + } + }, + "com.amazonaws.rds#MaxDBShardGroupLimitReached": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "MaxDBShardGroupLimitReached", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The maximum number of DB shard groups for your Amazon Web Services account in the specified Amazon Web Services Region has been reached.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#MaxRecords": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 20, + "max": 100 + } + } + }, + "com.amazonaws.rds#Metric": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of a metric.

" + } + }, + "References": { + "target": "com.amazonaws.rds#MetricReferenceList", + "traits": { + "smithy.api#documentation": "

A list of metric references (thresholds).

" + } + }, + "StatisticsDetails": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The details of different statistics for a metric. The description might contain markdown.

" + } + }, + "MetricQuery": { + "target": "com.amazonaws.rds#MetricQuery", + "traits": { + "smithy.api#documentation": "

The query to retrieve metric data points.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The representation of a metric.

" + } + }, + "com.amazonaws.rds#MetricList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#Metric" + } + }, + "com.amazonaws.rds#MetricQuery": { + "type": "structure", + "members": { + "PerformanceInsightsMetricQuery": { + "target": "com.amazonaws.rds#PerformanceInsightsMetricQuery", + "traits": { + "smithy.api#documentation": "

The Performance Insights query that you can use to retrieve Performance Insights metric data points.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The query to retrieve metric data points.

" + } + }, + "com.amazonaws.rds#MetricReference": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the metric reference.

" + } + }, + "ReferenceDetails": { + "target": "com.amazonaws.rds#ReferenceDetails", + "traits": { + "smithy.api#documentation": "

The details of a performance issue.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The reference (threshold) for a metric.

" + } + }, + "com.amazonaws.rds#MetricReferenceList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#MetricReference" + } + }, + "com.amazonaws.rds#MinimumEngineVersionPerAllowedValue": { + "type": "structure", + "members": { + "AllowedValue": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The allowed value for an option setting.

" + } + }, + "MinimumEngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The minimum DB engine version required for the allowed value.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum DB engine version required for each corresponding allowed value for an option setting.

" + } + }, + "com.amazonaws.rds#MinimumEngineVersionPerAllowedValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#MinimumEngineVersionPerAllowedValue", + "traits": { + "smithy.api#xmlName": "MinimumEngineVersionPerAllowedValue" + } + } + }, + "com.amazonaws.rds#ModifyActivityStream": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyActivityStreamRequest" + }, + "output": { + "target": "com.amazonaws.rds#ModifyActivityStreamResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Changes the audit policy state of a database activity stream to either locked (default) or unlocked. A locked policy is read-only,\n whereas an unlocked policy is read/write. If your activity stream is started and locked, you can unlock it, customize your audit policy,\n and then lock your activity stream. Restarting the activity stream isn't required. For more information, see Modifying a database activity stream in the\n Amazon RDS User Guide.

\n

This operation is supported for RDS for Oracle and Microsoft SQL Server.

" + } + }, + "com.amazonaws.rds#ModifyActivityStreamRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the RDS for Oracle or Microsoft SQL Server DB instance.\n For example, arn:aws:rds:us-east-1:12345667890:db:my-orcl-db.

" + } + }, + "AuditPolicyState": { + "target": "com.amazonaws.rds#AuditPolicyState", + "traits": { + "smithy.api#documentation": "

The audit policy state. When a policy is unlocked, it is read/write. When it is locked, it is\n read-only. You can edit your audit policy only when the activity stream is unlocked or stopped.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ModifyActivityStreamResponse": { + "type": "structure", + "members": { + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of messages in the database activity stream.

" + } + }, + "KinesisStreamName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Kinesis data stream to be used for the database activity stream.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#ActivityStreamStatus", + "traits": { + "smithy.api#documentation": "

The status of the modification to the database activity stream.

" + } + }, + "Mode": { + "target": "com.amazonaws.rds#ActivityStreamMode", + "traits": { + "smithy.api#documentation": "

The mode of the database activity stream.

" + } + }, + "EngineNativeAuditFieldsIncluded": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether engine-native audit fields are included in the database activity stream.

" + } + }, + "PolicyStatus": { + "target": "com.amazonaws.rds#ActivityStreamPolicyStatus", + "traits": { + "smithy.api#documentation": "

The status of the modification to the policy state of the database activity stream.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#ModifyCertificates": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyCertificatesMessage" + }, + "output": { + "target": "com.amazonaws.rds#ModifyCertificatesResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#CertificateNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS)\n certificate for Amazon RDS for new DB instances, or remove the override.

\n

By using this operation, you can specify an RDS-approved SSL/TLS certificate for new DB\n instances that is different from the default certificate provided by RDS. You can also\n use this operation to remove the override, so that new DB instances use the default\n certificate provided by RDS.

\n

You might need to override the default certificate in the following situations:

\n
    \n
  • \n

    You already migrated your applications to support the latest certificate authority (CA) certificate, but the new CA certificate is not yet \n the RDS default CA certificate for the specified Amazon Web Services Region.

    \n
    • \n
  • \n

    RDS has already moved to a new default CA certificate for the specified Amazon Web Services\n Region, but you are still in the process of supporting the new CA certificate.\n In this case, you temporarily need additional time to finish your application\n changes.

    \n
    • \n
\n

For more information about rotating your SSL/TLS certificate for RDS DB engines, see \n \n Rotating Your SSL/TLS Certificate in the Amazon RDS User Guide.

\n

For more information about rotating your SSL/TLS certificate for Aurora DB engines, see \n \n Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.

", + "smithy.api#examples": [ + { + "title": "To temporarily override the system-default SSL/TLS certificate for new DB instances", + "documentation": "The following example temporarily overrides the system-default SSL/TLS certificate for new DB instances.", + "input": { + "CertificateIdentifier": "rds-ca-2019" + }, + "output": { + "Certificate": { + "CertificateIdentifier": "rds-ca-2019", + "CertificateType": "CA", + "Thumbprint": "EXAMPLE123456789012", + "ValidFrom": "2019-09-19T18:16:53Z", + "ValidTill": "2024-08-22T17:08:50Z", + "CertificateArn": "arn:aws:rds:us-east-1::cert:rds-ca-2019", + "CustomerOverride": true, + "CustomerOverrideValidTill": "2024-08-22T17:08:50Z" + } + } + } + ] + } + }, + "com.amazonaws.rds#ModifyCertificatesMessage": { + "type": "structure", + "members": { + "CertificateIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The new default certificate identifier to override the current one with.

\n

To determine the valid values, use the describe-certificates CLI\n command or the DescribeCertificates API operation.

" + } + }, + "RemoveCustomerOverride": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to remove the override for the default certificate. \n If the override is removed, the default certificate is the system\n default.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ModifyCertificatesResult": { + "type": "structure", + "members": { + "Certificate": { + "target": "com.amazonaws.rds#Certificate" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#ModifyCurrentDBClusterCapacity": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyCurrentDBClusterCapacityMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBClusterCapacityInfo" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterCapacityFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Set the capacity of an Aurora Serverless v1 DB cluster to a specific value.

\n

Aurora Serverless v1 scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale \n fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity \n to set the capacity explicitly.

\n

After this call sets the DB cluster capacity, Aurora Serverless v1 can automatically scale\n the DB cluster based on the cooldown period for scaling up and the cooldown period\n for scaling down.

\n

For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the \n Amazon Aurora User Guide.

\n \n

If you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that \n prevent Aurora Serverless v1 from finding a scaling point might be dropped. For more information about scaling points, \n see \n Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.

\n \n \n

This operation only applies to Aurora Serverless v1 DB clusters.

\n ", + "smithy.api#examples": [ + { + "title": "To scale the capacity of an Aurora Serverless DB cluster", + "documentation": "The following example scales the capacity of an Aurora Serverless DB cluster to 8.", + "input": { + "DBClusterIdentifier": "mydbcluster", + "Capacity": 8 + }, + "output": { + "DBClusterIdentifier": "mydbcluster", + "PendingCapacity": 8, + "CurrentCapacity": 1, + "SecondsBeforeTimeout": 300, + "TimeoutAction": "ForceApplyCapacityChange" + } + } + ] + } + }, + "com.amazonaws.rds#ModifyCurrentDBClusterCapacityMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DB cluster.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Capacity": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The DB cluster capacity.

\n

When you change the capacity of a paused Aurora Serverless v1 DB cluster, it automatically resumes.

\n

Constraints:

\n
    \n
  • \n

    For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

    \n
    • \n
  • \n

    For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

    \n
    • \n
" + } + }, + "SecondsBeforeTimeout": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point\n to perform seamless scaling before enforcing the timeout action. The default is\n 300.

\n

Specify a value between 10 and 600 seconds.

" + } + }, + "TimeoutAction": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.

\n

\n ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.

\n

\n RollbackCapacityChange ignores the capacity change if a scaling point isn't found in the timeout period.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ModifyCustomDBEngineVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyCustomDBEngineVersionMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBEngineVersion" + }, + "errors": [ + { + "target": "com.amazonaws.rds#CustomDBEngineVersionNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidCustomDBEngineVersionStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies the status of a custom engine version (CEV). You can find CEVs to modify by calling \n DescribeDBEngineVersions.

\n \n

The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with \n Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the \n ModifyCustomDbEngineVersion event aren't logged. However, you might see calls from the \n API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for \n the ModifyCustomDbEngineVersion event.

\n \n

For more information, see Modifying CEV status \n in the Amazon RDS User Guide.

" + } + }, + "com.amazonaws.rds#ModifyCustomDBEngineVersionMessage": { + "type": "structure", + "members": { + "Engine": { + "target": "com.amazonaws.rds#CustomEngineName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The database engine. RDS Custom for Oracle supports the following values:

\n
    \n
  • \n

    \n custom-oracle-ee\n

    \n
    • \n
  • \n

    \n custom-oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n custom-oracle-se2\n

    \n
    • \n
  • \n

    \n custom-oracle-se2-cdb\n

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#CustomEngineVersion", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The custom engine version (CEV) that you want to modify. This option is required for \n RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and \n EngineVersion is unique per customer per Amazon Web Services Region.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.rds#Description", + "traits": { + "smithy.api#documentation": "

An optional description of your CEV.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#CustomEngineVersionStatus", + "traits": { + "smithy.api#documentation": "

The availability status to be assigned to the CEV. Valid values are as follows:

\n
\n
available
\n
\n

You can use this CEV to create a new RDS Custom DB instance.

\n
\n
inactive
\n
\n

You can create a new RDS Custom instance by restoring a DB snapshot with this CEV. \n You can't patch or create new instances with this CEV.

\n
\n
\n

You can change any status to any status. A typical reason to change status is to prevent the accidental \n use of a CEV, or to make a deprecated CEV eligible for use again. For example, you might change the status \n of your CEV from available to inactive, and from inactive back to \n available. To change the availability status of the CEV, it must not currently be in use by an \n RDS Custom instance, snapshot, or automated backup.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ModifyDBCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyDBClusterMessage" + }, + "output": { + "target": "com.amazonaws.rds#ModifyDBClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DomainNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSecurityGroupStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSubnetGroupStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidSubnet" + }, + { + "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" + }, + { + "target": "com.amazonaws.rds#OptionGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#StorageQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#StorageTypeNotAvailableFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies the settings of an Amazon Aurora DB cluster or a Multi-AZ DB cluster. \n You can change one or more settings by specifying these parameters and the new values in the\n request.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

", + "smithy.api#examples": [ + { + "title": "To modify a DB cluster", + "documentation": "The following example changes the master user password for the DB cluster named cluster-2 and sets the backup retention period to 14 days. The ApplyImmediately parameter causes the changes to be made immediately, instead of waiting until the next maintenance window.", + "input": { + "DBClusterIdentifier": "cluster-2", + "ApplyImmediately": true, + "BackupRetentionPeriod": 14, + "MasterUserPassword": "newpassword99" + }, + "output": { + "DBCluster": { + "AllocatedStorage": 1, + "AvailabilityZones": [ + "eu-central-1b", + "eu-central-1c", + "eu-central-1a" + ], + "BackupRetentionPeriod": 14, + "DatabaseName": "", + "DBClusterIdentifier": "cluster-2", + "DBClusterParameterGroup": "default.aurora5.6", + "DBSubnetGroup": "default-vpc-2305ca49", + "Status": "available", + "EarliestRestorableTime": "2020-06-03T02:07:29.637Z", + "Endpoint": "cluster-2.cluster-############.eu-central-1.rds.amazonaws.com", + "ReaderEndpoint": "cluster-2.cluster-ro-############.eu-central-1.rds.amazonaws.com", + "MultiAZ": false, + "Engine": "aurora", + "EngineVersion": "5.6.10a", + "LatestRestorableTime": "2020-06-04T15:11:25.748Z", + "Port": 3306, + "MasterUsername": "admin", + "PreferredBackupWindow": "01:55-02:25", + "PreferredMaintenanceWindow": "thu:21:14-thu:21:44", + "ReadReplicaIdentifiers": [], + "DBClusterMembers": [ + { + "DBInstanceIdentifier": "cluster-2-instance-1", + "IsClusterWriter": true, + "DBClusterParameterGroupStatus": "in-sync", + "PromotionTier": 1 + } + ], + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-20a5c047", + "Status": "active" + } + ], + "HostedZoneId": "Z1RLNU0EXAMPLE", + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:eu-central-1:123456789012:key/d1bd7c8f-5cdb-49ca-8a62-a1b2c3d4e5f6", + "DbClusterResourceId": "cluster-AGJ7XI77XVIS6FUXHU1EXAMPLE", + "DBClusterArn": "arn:aws:rds:eu-central-1:123456789012:cluster:cluster-2", + "AssociatedRoles": [], + "IAMDatabaseAuthenticationEnabled": false, + "ClusterCreateTime": "2020-04-03T14:44:02.764Z", + "EngineMode": "provisioned", + "DeletionProtection": false, + "HttpEndpointEnabled": false, + "CopyTagsToSnapshot": true, + "CrossAccountClone": false, + "DomainMemberships": [] + } + } + } + ] + } + }, + "com.amazonaws.rds#ModifyDBClusterEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyDBClusterEndpointMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBClusterEndpoint" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterEndpointNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterEndpointStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies the properties of an endpoint in an Amazon Aurora DB cluster.

\n \n

This operation only applies to Aurora DB clusters.

\n ", + "smithy.api#examples": [ + { + "title": "To modify a custom DB cluster endpoint", + "documentation": "The following example modifies the specified custom DB cluster endpoint.", + "input": { + "DBClusterEndpointIdentifier": "mycustomendpoint", + "StaticMembers": [ + "dbinstance1", + "dbinstance2", + "dbinstance3" + ] + }, + "output": { + "DBClusterEndpointIdentifier": "mycustomendpoint", + "DBClusterIdentifier": "mydbcluster", + "DBClusterEndpointResourceIdentifier": "cluster-endpoint-ANPAJ4AE5446DAEXAMPLE", + "Endpoint": "mycustomendpoint.cluster-custom-cnpexample.us-east-1.rds.amazonaws.com", + "Status": "modifying", + "EndpointType": "CUSTOM", + "CustomEndpointType": "READER", + "StaticMembers": [ + "dbinstance1", + "dbinstance2", + "dbinstance3" + ], + "ExcludedMembers": [], + "DBClusterEndpointArn": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:mycustomendpoint" + } + } + ] + } + }, + "com.amazonaws.rds#ModifyDBClusterEndpointMessage": { + "type": "structure", + "members": { + "DBClusterEndpointIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier of the endpoint to modify. This parameter is stored as a lowercase string.

", + "smithy.api#required": {} + } + }, + "EndpointType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The type of the endpoint. One of: READER, WRITER, ANY.

" + } + }, + "StaticMembers": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

List of DB instance identifiers that are part of the custom endpoint group.

" + } + }, + "ExcludedMembers": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

List of DB instance identifiers that aren't part of the custom endpoint group.\n All other eligible instances are reachable through the custom endpoint.\n Only relevant if the list of static members is empty.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ModifyDBClusterMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DB cluster.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "NewDBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    The first character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Example: my-cluster2\n

" + } + }, + "ApplyImmediately": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the modifications in this request are asynchronously applied as soon as possible, regardless of the \n PreferredMaintenanceWindow setting for the DB cluster. If this parameter is disabled, changes to the DB cluster \n are applied during the next maintenance window.

\n

Most modifications can be applied immediately or during the next scheduled maintenance window. Some modifications, such as \n turning on deletion protection and changing the master password, are applied immediately—regardless of when you choose to apply them.

\n

By default, this parameter is disabled.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days for which automated backups are retained. Specify a minimum value of 1.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Default: 1\n

\n

Constraints:

\n
    \n
  • \n

    Must be a value from 1 to 35.

    \n
    • \n
" + } + }, + "DBClusterParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB cluster parameter group to use for the DB cluster.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of EC2 VPC security groups to associate with this DB cluster.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port number on which the DB cluster accepts connections.

\n

Valid for Cluster Type: Aurora DB clusters only

\n

Valid Values: 1150-65535\n

\n

Default: The same port as the original DB cluster.

" + } + }, + "MasterUserPassword": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The new password for the master database user.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Constraints:

\n
    \n
  • \n

    Must contain from 8 to 41 characters.

    \n
    • \n
  • \n

    Can contain any printable ASCII character except \"/\", \"\"\", or \"@\".

    \n
    • \n
  • \n

    Can't be specified if ManageMasterUserPassword is turned on.

    \n
    • \n
" + } + }, + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The option group to associate the DB cluster with.

\n

DB clusters are associated with a default option group that can't be modified.

" + } + }, + "PreferredBackupWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To view the time blocks available, see \n \n Backup window in the Amazon Aurora User Guide.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Constraints:

\n
    \n
  • \n

    Must be in the format hh24:mi-hh24:mi.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must not conflict with the preferred maintenance window.

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \n
" + } + }, + "PreferredMaintenanceWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

\n

Constraints:

\n
    \n
  • \n

    Must be in the format ddd:hh24:mi-ddd:hh24:mi.

    \n
    • \n
  • \n

    Days must be one of Mon | Tue | Wed | Thu | Fri | Sat | Sun.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \n
" + } + }, + "EnableIAMDatabaseAuthentication": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see IAM Database\n Authentication in the Amazon Aurora User Guide or\n IAM database\n authentication for MariaDB, MySQL, and PostgreSQL in the Amazon\n RDS User Guide.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "BacktrackWindow": { + "target": "com.amazonaws.rds#LongOptional", + "traits": { + "smithy.api#documentation": "

The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.

\n

Valid for Cluster Type: Aurora MySQL DB clusters only

\n

Default: 0\n

\n

Constraints:

\n
    \n
  • \n

    If specified, this value must be set to a number from 0 to 259,200 (72 hours).

    \n
    • \n
" + } + }, + "CloudwatchLogsExportConfiguration": { + "target": "com.amazonaws.rds#CloudwatchLogsExportConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

The following values are valid for each DB engine:

\n
    \n
  • \n

    Aurora MySQL - audit | error | general | slowquery\n

    \n
    • \n
  • \n

    Aurora PostgreSQL - postgresql\n

    \n
    • \n
  • \n

    RDS for MySQL - error | general | slowquery\n

    \n
    • \n
  • \n

    RDS for PostgreSQL - postgresql | upgrade\n

    \n
    • \n
\n

For more information about exporting CloudWatch Logs for Amazon RDS, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version number of the database engine to which you want to upgrade. Changing this\n parameter results in an outage. The change is applied during the next maintenance window\n unless ApplyImmediately is enabled.

\n

If the cluster that you're modifying has one or more read replicas, all replicas must\n be running an engine version that's the same or later than the version you\n specify.

\n

To list all of the available engine versions for Aurora MySQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query\n \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for Aurora PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for MySQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"\n

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "AllowMajorVersionUpgrade": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether major version upgrades are allowed.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Constraints:

\n
    \n
  • \n

    You must allow major version upgrades when specifying a value for the\n EngineVersion parameter that is a different major version than the DB\n cluster's current version.

    \n
    • \n
" + } + }, + "DBInstanceParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group to apply to all instances of the DB cluster.

\n \n

When you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB\n cluster isn't rebooted automatically. Also, parameter changes are applied immediately rather than \n during the next maintenance window.

\n \n

Valid for Cluster Type: Aurora DB clusters only

\n

Default: The existing name setting

\n

Constraints:

\n
    \n
  • \n

    The DB parameter group must be in the same DB parameter group family as this DB cluster.

    \n
    • \n
  • \n

    The DBInstanceParameterGroupName parameter is valid in combination with the\n AllowMajorVersionUpgrade parameter for a major version upgrade only.

    \n
    • \n
" + } + }, + "Domain": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Active Directory directory ID to move the DB cluster to. \n Specify none to remove the cluster from its current domain.\n The domain must be created prior to this operation.

\n

For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.

\n

Valid for Cluster Type: Aurora DB clusters only

" + } + }, + "DomainIAMRoleName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the IAM role to use when making API calls to the Directory Service.

\n

Valid for Cluster Type: Aurora DB clusters only

" + } + }, + "ScalingConfiguration": { + "target": "com.amazonaws.rds#ScalingConfiguration", + "traits": { + "smithy.api#documentation": "

The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.

\n

Valid for Cluster Type: Aurora DB clusters only

" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "EnableHttpEndpoint": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint \n isn't enabled.

\n

When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running\n SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database\n from inside the RDS console with the RDS query editor.

\n

For more information, see Using RDS Data API in the \n Amazon Aurora User Guide.

\n \n

This parameter applies only to Aurora Serverless v1 DB clusters. To enable or disable the HTTP endpoint for an Aurora\n Serverless v2 or provisioned DB cluster, use the EnableHttpEndpoint and DisableHttpEndpoint operations.

\n \n

Valid for Cluster Type: Aurora DB clusters only

" + } + }, + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster. \n The default is not to copy them.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "EnableGlobalWriteForwarding": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster\n (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that\n are secondary clusters in an Aurora global database.

\n

You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter\n enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to\n this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the\n primary is demoted by a global cluster API operation, but it does nothing until then.

\n

Valid for Cluster Type: Aurora DB clusters only

" + } + }, + "DBClusterInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.

\n

For the full list of DB instance classes and availability for your engine, see \n DB Instance Class in the Amazon RDS User Guide.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

" + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The storage type to associate with the DB cluster.

\n

For information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters. For information on storage types for Multi-AZ DB\n clusters, see Settings for creating Multi-AZ DB clusters.

\n

When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Valid Values:

\n
    \n
  • \n

    Aurora DB clusters - aurora | aurora-iopt1\n

    \n
    • \n
  • \n

    Multi-AZ DB clusters - io1 | io2 | gp3\n

    \n
    • \n
\n

Default:

\n
    \n
  • \n

    Aurora DB clusters - aurora\n

    \n
    • \n
  • \n

    Multi-AZ DB clusters - io1\n

    \n
    • \n
" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated \n for each DB instance in the Multi-AZ DB cluster.

\n

For information about valid IOPS values, see \n Amazon RDS Provisioned IOPS storage \n in the Amazon RDS User Guide.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

\n

Constraints:

\n
    \n
  • \n

    Must be a multiple between .5 and 50 of the storage amount for the DB cluster.

    \n
    • \n
" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. \n By default, minor engine upgrades are applied automatically.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "MonitoringInterval": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. \n To turn off collecting Enhanced Monitoring metrics, specify 0.

\n

If MonitoringRoleArn is specified, also set MonitoringInterval\n to a value other than 0.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

\n

Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60\n

\n

Default: 0\n

" + } + }, + "MonitoringRoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An\n example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.\n

\n

If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

" + } + }, + "DatabaseInsightsMode": { + "target": "com.amazonaws.rds#DatabaseInsightsMode", + "traits": { + "smithy.api#documentation": "

Specifies the mode of Database Insights to enable for the DB cluster.

\n

If you change the value from standard to advanced, you must set the \n PerformanceInsightsEnabled parameter to true and the \n PerformanceInsightsRetentionPeriod parameter to 465.

\n

If you change the value from advanced to standard, you must \n set the PerformanceInsightsEnabled parameter to false.

\n

Valid for Cluster Type: Aurora DB clusters only

" + } + }, + "EnablePerformanceInsights": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to turn on Performance Insights for the DB cluster.

\n

For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "PerformanceInsightsKMSKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "PerformanceInsightsRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days to retain Performance Insights data.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Valid Values:

\n
    \n
  • \n

    \n 7\n

    \n
    • \n
  • \n

    \n month * 31, where month is a number of months from 1-23. \n Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)

    \n
    • \n
  • \n

    \n 731\n

    \n
    • \n
\n

Default: 7 days

\n

If you specify a retention period that isn't valid, such as 94, Amazon RDS issues an error.

" + } + }, + "ServerlessV2ScalingConfiguration": { + "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" + }, + "NetworkType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The network type of the DB cluster.

\n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid for Cluster Type: Aurora DB clusters only

\n

Valid Values: IPV4 | DUAL\n

" + } + }, + "ManageMasterUserPassword": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

\n

If the DB cluster doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn \n on this management. In this case, you can't specify MasterUserPassword.

\n

If the DB cluster already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the \n master user password is not managed with Amazon Web Services Secrets Manager, then you must specify MasterUserPassword. \n In this case, RDS deletes the secret and uses the new password for the master user specified by \n MasterUserPassword.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "RotateMasterUserPassword": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the \n master user password.

\n

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB cluster. The secret value contains the updated password.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Constraints:

\n
    \n
  • \n

    You must apply the change immediately when rotating the master user password.

    \n
    • \n
" + } + }, + "MasterUserSecretKmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and \n managed in Amazon Web Services Secrets Manager.

\n

This setting is valid only if both of the following conditions are met:

\n
    \n
  • \n

    The DB cluster doesn't manage the master user password in Amazon Web Services Secrets Manager.

    \n

    If the DB cluster already manages the master user password in Amazon Web Services Secrets\n Manager, you can't change the KMS key that is used to encrypt the secret.

    \n
    • \n
  • \n

    You are turning on ManageMasterUserPassword to manage the master user password \n in Amazon Web Services Secrets Manager.

    \n

    If you are turning on ManageMasterUserPassword and don't specify \n MasterUserSecretKmsKeyId, then the aws/secretsmanager \n KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't \n use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer \n managed KMS key.

    \n
    • \n
\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "EngineMode": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB engine mode of the DB cluster, either provisioned or serverless.

\n \n

The DB engine mode can be modified only from serverless to provisioned.

\n \n

For more information, see \n CreateDBCluster.

\n

Valid for Cluster Type: Aurora DB clusters only

" + } + }, + "AllowEngineModeChange": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether engine mode changes from serverless to provisioned \n are allowed.

\n

Valid for Cluster Type: Aurora Serverless v1 DB clusters only

\n

Constraints:

\n
    \n
  • \n

    You must allow engine mode changes when specifying a different value for the EngineMode parameter\n from the DB cluster's current engine mode.

    \n
    • \n
" + } + }, + "EnableLocalWriteForwarding": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By\n default, write operations aren't allowed on reader DB instances.

\n

Valid for: Aurora DB clusters only

" + } + }, + "AwsBackupRecoveryPointArn": { + "target": "com.amazonaws.rds#AwsBackupRecoveryPointArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

" + } + }, + "EnableLimitlessDatabase": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group.

\n

Valid for: Aurora DB clusters only

\n \n

This setting is no longer used. Instead use the ClusterScalabilityType setting when you create your Aurora Limitless Database DB cluster.

\n " + } + }, + "CACertificateIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The CA certificate identifier to use for the DB cluster's server certificate.

\n

For more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide.

\n

Valid for Cluster Type: Multi-AZ DB clusters

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ModifyDBClusterParameterGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyDBClusterParameterGroupMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBClusterParameterGroupNameMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBParameterGroupStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies the parameters of a DB cluster parameter group. To modify more than one parameter,\n submit a list of the following: ParameterName, ParameterValue, \n and ApplyMethod. A maximum of 20\n parameters can be modified in a single request.

\n \n

After you create a DB cluster parameter group, you should wait at least 5 minutes\n before creating your first DB cluster that uses that DB cluster parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the create operation before the parameter \n group is used as the default for a new DB cluster. This is especially important for parameters \n that are critical when creating the default database for a DB cluster, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBClusterParameters operation to verify \n that your DB cluster parameter group has been created or modified.

\n

If the modified DB cluster parameter group is used by an Aurora Serverless v1 cluster, Aurora\n applies the update immediately. The cluster restart might interrupt your workload. In that case,\n your application must reopen any connections and retry any transactions that were active\n when the parameter changes took effect.

\n \n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n

", + "smithy.api#examples": [ + { + "title": "To modify parameters in a DB cluster parameter group", + "documentation": "The following example modifies the values of parameters in a DB cluster parameter group.", + "input": { + "DBClusterParameterGroupName": "mydbclusterpg", + "Parameters": [ + { + "ParameterName": "server_audit_logging", + "ParameterValue": "1", + "ApplyMethod": "immediate" + }, + { + "ParameterName": "server_audit_logs_upload", + "ParameterValue": "1", + "ApplyMethod": "immediate" + } + ] + }, + "output": { + "DBClusterParameterGroupName": "mydbclusterpg" + } + } + ] + } + }, + "com.amazonaws.rds#ModifyDBClusterParameterGroupMessage": { + "type": "structure", + "members": { + "DBClusterParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the DB cluster parameter group to modify.

", + "smithy.api#required": {} + } + }, + "Parameters": { + "target": "com.amazonaws.rds#ParametersList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A list of parameters in the DB cluster parameter group to modify.

\n

Valid Values (for the application method): immediate | pending-reboot\n

\n \n

You can use the immediate value with dynamic parameters only. You can use the \n pending-reboot value for both dynamic and static parameters.

\n

When the application method is immediate, changes to dynamic parameters are applied immediately \n to the DB clusters associated with the parameter group. When the application method is pending-reboot, \n changes to dynamic and static parameters are applied after a reboot without failover to the DB clusters associated with the \n parameter group.

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ModifyDBClusterResult": { + "type": "structure", + "members": { + "DBCluster": { + "target": "com.amazonaws.rds#DBCluster" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#ModifyDBClusterSnapshotAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyDBClusterSnapshotAttributeMessage" + }, + "output": { + "target": "com.amazonaws.rds#ModifyDBClusterSnapshotAttributeResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterSnapshotStateFault" + }, + { + "target": "com.amazonaws.rds#SharedSnapshotQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.

\n

To share a manual DB cluster snapshot with other Amazon Web Services accounts, specify\n restore as the AttributeName and use the\n ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are\n authorized to restore the manual DB cluster snapshot. Use the value all to\n make the manual DB cluster snapshot public, which means that it can be copied or\n restored by all Amazon Web Services accounts.

\n \n

Don't add the all value for any manual DB cluster snapshots\n that contain private information that you don't want available to all Amazon Web Services\n accounts.

\n \n

If a manual DB cluster snapshot is encrypted, it can be shared, but only by\n specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd\n parameter. You can't use all as a value for that parameter in this\n case.

\n

To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster\n snapshot, or whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API operation. The accounts are\n returned as values for the restore attribute.

", + "smithy.api#examples": [ + { + "title": "To modify a DB cluster snapshot attribute", + "documentation": "The following example makes changes to the specified DB cluster snapshot attribute.", + "input": { + "DBClusterSnapshotIdentifier": "myclustersnapshot", + "AttributeName": "restore", + "ValuesToAdd": [ + "123456789012" + ] + }, + "output": { + "DBClusterSnapshotAttributesResult": { + "DBClusterSnapshotIdentifier": "myclustersnapshot", + "DBClusterSnapshotAttributes": [ + { + "AttributeName": "restore", + "AttributeValues": [ + "123456789012" + ] + } + ] + } + } + } + ] + } + }, + "com.amazonaws.rds#ModifyDBClusterSnapshotAttributeMessage": { + "type": "structure", + "members": { + "DBClusterSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier for the DB cluster snapshot to modify the attributes for.

", + "smithy.api#required": {} + } + }, + "AttributeName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the DB cluster snapshot attribute to modify.

\n

To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, \n set this value to restore.

\n \n

To view the list of attributes available to modify, use the\n DescribeDBClusterSnapshotAttributes API operation.

\n ", + "smithy.api#required": {} + } + }, + "ValuesToAdd": { + "target": "com.amazonaws.rds#AttributeValueList", + "traits": { + "smithy.api#documentation": "

A list of DB cluster snapshot attributes to add to the attribute specified by AttributeName.

\n

To authorize other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more Amazon Web Services account\n IDs, or all to make the manual DB cluster snapshot restorable by \n any Amazon Web Services account. Do not add the all value for any\n manual DB cluster snapshots that contain private information that you don't want available\n to all Amazon Web Services accounts.

" + } + }, + "ValuesToRemove": { + "target": "com.amazonaws.rds#AttributeValueList", + "traits": { + "smithy.api#documentation": "

A list of DB cluster snapshot attributes to remove from the attribute specified by AttributeName.

\n

To remove authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this list to include\n one or more Amazon Web Services account\n identifiers, or all to remove authorization for any Amazon Web Services account to copy or\n restore the DB cluster snapshot. If you specify all, an Amazon Web Services account whose account ID is\n explicitly added to the restore attribute\n can still copy or restore a manual DB cluster snapshot.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ModifyDBClusterSnapshotAttributeResult": { + "type": "structure", + "members": { + "DBClusterSnapshotAttributesResult": { + "target": "com.amazonaws.rds#DBClusterSnapshotAttributesResult" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#ModifyDBInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyDBInstanceMessage" + }, + "output": { + "target": "com.amazonaws.rds#ModifyDBInstanceResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#AuthorizationNotFoundFault" + }, + { + "target": "com.amazonaws.rds#BackupPolicyNotFoundFault" + }, + { + "target": "com.amazonaws.rds#CertificateNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBUpgradeDependencyFailureFault" + }, + { + "target": "com.amazonaws.rds#DomainNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InsufficientDBInstanceCapacityFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSecurityGroupStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + }, + { + "target": "com.amazonaws.rds#NetworkTypeNotSupported" + }, + { + "target": "com.amazonaws.rds#OptionGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#ProvisionedIopsNotAvailableInAZFault" + }, + { + "target": "com.amazonaws.rds#StorageQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#StorageTypeNotSupportedFault" + }, + { + "target": "com.amazonaws.rds#TenantDatabaseQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies settings for a DB instance. \n You can change one or more database configuration parameters by specifying these parameters and the new values in the request.\n To learn what modifications you can make to your DB instance,\n call DescribeValidDBInstanceModifications\n before you call ModifyDBInstance.

", + "smithy.api#examples": [ + { + "title": "To modify a DB instance", + "documentation": "The following example associates an option group and a parameter group with a compatible Microsoft SQL Server DB instance. The ApplyImmediately parameter causes the option and parameter groups to be associated immediately, instead of waiting until the next maintenance window.", + "input": { + "DBInstanceIdentifier": "database-2", + "ApplyImmediately": true, + "DBParameterGroupName": "test-sqlserver-se-2017", + "OptionGroupName": "test-se-2017" + }, + "output": { + "DBInstance": { + "DBInstanceIdentifier": "database-2", + "DBInstanceClass": "db.r4.large", + "Engine": "sqlserver-se", + "DBInstanceStatus": "available", + "DBParameterGroups": [ + { + "DBParameterGroupName": "test-sqlserver-se-2017", + "ParameterApplyStatus": "applying" + } + ], + "AvailabilityZone": "us-west-2d", + "MultiAZ": true, + "EngineVersion": "14.00.3281.6.v1", + "AutoMinorVersionUpgrade": false, + "ReadReplicaDBInstanceIdentifiers": [], + "LicenseModel": "license-included", + "OptionGroupMemberships": [ + { + "OptionGroupName": "test-se-2017", + "Status": "pending-apply" + } + ], + "CharacterSetName": "SQL_Latin1_General_CP1_CI_AS", + "SecondaryAvailabilityZone": "us-west-2c", + "PubliclyAccessible": true, + "StorageType": "gp2", + "DeletionProtection": false, + "AssociatedRoles": [], + "MaxAllocatedStorage": 1000 + } + } + } + ] + } + }, + "com.amazonaws.rds#ModifyDBInstanceMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier of DB instance to modify. This value is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DB instance.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The new amount of storage in gibibytes (GiB) to allocate for the DB instance.

\n

For RDS for Db2, MariaDB, RDS for MySQL, RDS for Oracle, and RDS for PostgreSQL, \n the value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up \n so that they are 10% greater than the current value.

\n

For the valid values for allocated storage for each engine,\n see CreateDBInstance.

\n

Constraints:

\n
    \n
  • \n

    When you increase the allocated storage for a DB instance that uses\n Provisioned IOPS (gp3, io1, or io2\n storage type), you must also specify the Iops parameter. You can\n use the current value for Iops.

    \n
    • \n
" + } + }, + "DBInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The new compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all\n Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the \n Amazon RDS User Guide or \n Aurora\n DB instance classes in the Amazon Aurora User Guide. For RDS Custom, see DB instance class support for RDS Custom for Oracle and \n DB instance class support for RDS Custom for SQL Server.

\n

If you modify the DB instance class, an outage occurs during the change. The change is\n applied during the next maintenance window, unless you specify\n ApplyImmediately in your request.

\n

Default: Uses existing setting

\n

Constraints:

\n
    \n
  • \n

    If you are modifying the DB instance class and upgrading the engine version at the same time, the currently running engine version must be supported on the \n specified DB instance class. Otherwise, the operation returns an error. In this case, first run the operation to upgrade the engine version, \n and then run it again to modify the DB instance class.

    \n
    • \n
" + } + }, + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The new DB subnet group for the DB instance.\n You can use this parameter to move your DB instance to a different VPC.\n \n \n If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC.\n For more information, see \n Working with a DB instance in a VPC \n in the Amazon RDS User Guide.

\n

Changing the subnet group causes an outage during the change. \n The change is applied during the next maintenance window,\n unless you enable ApplyImmediately.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match existing DB subnet group.

    \n
    • \n
\n

Example: mydbsubnetgroup\n

" + } + }, + "DBSecurityGroups": { + "target": "com.amazonaws.rds#DBSecurityGroupNameList", + "traits": { + "smithy.api#documentation": "

A list of DB security groups to authorize on this DB instance. Changing this setting doesn't \n result in an outage and the change is asynchronously applied as soon as possible.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match existing DB security groups.

    \n
    • \n
" + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of Amazon EC2 VPC security groups to associate with this DB instance. This change is \n asynchronously applied as soon as possible.

\n

This setting doesn't apply to the following DB instances:

\n
    \n
  • \n

    Amazon Aurora (The associated list of EC2 VPC security groups is managed by\n the DB cluster. For more information, see ModifyDBCluster.)

    \n
    • \n
  • \n

    RDS Custom

    \n
    • \n
\n

Constraints:

\n
    \n
  • \n

    If supplied, must match existing VPC security group IDs.

    \n
    • \n
" + } + }, + "ApplyImmediately": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, \n regardless of the PreferredMaintenanceWindow setting for the DB instance. By default, this parameter is disabled.

\n

If this parameter is disabled, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage\n and are applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in \n Modifying a DB Instance in the \n Amazon RDS User Guide to see the impact of enabling or disabling ApplyImmediately for each modified parameter and to \n determine when the changes are applied.

" + } + }, + "MasterUserPassword": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The new password for the master user.

\n

Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. \n Between the time of the request and the completion of the request,\n the MasterUserPassword element exists in the\n PendingModifiedValues element of the operation response.

\n \n

Amazon RDS API operations never return the password, \n so this operation provides a way to regain access to a primary instance user if the password is lost. \n This includes restoring privileges that might have been accidentally revoked.

\n \n

This setting doesn't apply to the following DB instances:

\n
    \n
  • \n

    Amazon Aurora (The password for the master user is managed by the DB cluster. For\n more information, see ModifyDBCluster.)

    \n
    • \n
  • \n

    RDS Custom

    \n
    • \n
\n

Default: Uses existing setting

\n

Constraints:

\n
    \n
  • \n

    Can't be specified if ManageMasterUserPassword is turned on.

    \n
    • \n
  • \n

    Can include any printable ASCII character except \"/\", \"\"\", or \"@\". For RDS for Oracle, can't include the \"&\" (ampersand) or the \"'\" (single quotes) character.

    \n
    • \n
\n

Length Constraints:

\n
    \n
  • \n

    RDS for Db2 - Must contain from 8 to 255 characters.

    \n
    • \n
  • \n

    RDS for MariaDB - Must contain from 8 to 41 characters.

    \n
    • \n
  • \n

    RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.

    \n
    • \n
  • \n

    RDS for MySQL - Must contain from 8 to 41 characters.

    \n
    • \n
  • \n

    RDS for Oracle - Must contain from 8 to 30 characters.

    \n
    • \n
  • \n

    RDS for PostgreSQL - Must contain from 8 to 128 characters.

    \n
    • \n
" + } + }, + "DBParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group to apply to the DB instance.

\n

Changing this setting doesn't result in an outage. The parameter group name itself is changed\n immediately, but the actual parameter changes are not applied until you reboot the\n instance without failover. In this case, the DB instance isn't rebooted automatically, and the\n parameter changes aren't applied during the next maintenance window. However, if you modify \n dynamic parameters in the newly associated DB parameter group, these changes are applied \n immediately without a reboot.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Default: Uses existing setting

\n

Constraints:

\n
    \n
  • \n

    Must be in the same DB parameter group family as the DB instance.

    \n
    • \n
" + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

\n \n

Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.

\n \n

These changes are applied during the next maintenance window unless the ApplyImmediately parameter is enabled\n for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously\n applied as soon as possible.

\n

This setting doesn't apply to Amazon Aurora DB instances. The retention period for automated backups is managed by the DB\n cluster. For more information, see ModifyDBCluster.

\n

Default: Uses existing setting

\n

Constraints:

\n
    \n
  • \n

    Must be a value from 0 to 35.

    \n
    • \n
  • \n

    Can't be set to 0 if the DB instance is a source to \n read replicas.

    \n
    • \n
  • \n

    Can't be set to 0 for an RDS Custom for Oracle DB instance.

    \n
    • \n
" + } + }, + "PreferredBackupWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled,\n as determined by the BackupRetentionPeriod parameter. \n Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.\n The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.

\n

This setting doesn't apply to Amazon Aurora DB instances. The daily time range for creating automated backups is managed by\n the DB cluster. For more information, see ModifyDBCluster.

\n

Constraints:

\n
    \n
  • \n

    Must be in the format hh24:mi-hh24:mi.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must not conflict with the preferred maintenance window.

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \n
" + } + }, + "PreferredMaintenanceWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, which\n might result in an outage. Changing this parameter doesn't result in an outage, except\n in the following situation, and the change is asynchronously applied as soon as\n possible. If there are pending actions that cause a reboot, and the maintenance window\n is changed to include the current time, then changing this parameter causes a reboot\n of the DB instance. If you change this window to the current time, there must be at least 30\n minutes between the current time and end of the window to ensure pending changes are\n applied.

\n

For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.\n

\n

Default: Uses existing setting

\n

Constraints:

\n
    \n
  • \n

    Must be in the format ddd:hh24:mi-ddd:hh24:mi.

    \n
    • \n
  • \n

    The day values must be mon | tue | wed | thu | fri | sat | sun.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must not conflict with the preferred backup window.

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \n
" + } + }, + "MultiAZ": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result \n in an outage. The change is applied during the next maintenance window unless the ApplyImmediately \n parameter is enabled for this request.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version number of the database engine to upgrade to. \n Changing this parameter results in an outage and the change \n is applied during the next maintenance window\n unless the ApplyImmediately parameter is enabled for this request.

\n

For major version upgrades, if a nondefault DB parameter group is currently in use, a\n new DB parameter group in the DB parameter group family for the new engine version must\n be specified. The new DB parameter group can be the default for that DB parameter group\n family.

\n

If you specify only a major version, Amazon RDS updates the DB instance to the \n default minor version if the current minor version is lower.\n For information about valid engine versions, see CreateDBInstance, \n or call DescribeDBEngineVersions.

\n

If the instance that you're modifying is acting as a read replica, the engine version\n that you specify must be the same or higher than the version that the source DB instance\n or cluster is running.

\n

In RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the \n PATCH_DB_FAILURE lifecycle.

\n

Constraints:

\n
    \n
  • \n

    If you are upgrading the engine version and modifying the DB instance class at the same time, the currently running engine version must be supported on the \n specified DB instance class. Otherwise, the operation returns an error. In this case, first run the operation to upgrade the engine version, \n and then run it again to modify the DB instance class.

    \n
    • \n
" + } + }, + "AllowMajorVersionUpgrade": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether major version upgrades are allowed. Changing this parameter doesn't \n result in an outage and the change is asynchronously applied as soon as possible.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Constraints:

\n
    \n
  • \n

    Major version upgrades must be allowed when specifying a value \n for the EngineVersion parameter that's a different major version than the DB instance's current version.

    \n
    • \n
" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether minor version upgrades are applied automatically to the DB instance \n during the maintenance window. An outage occurs when all the following conditions are met:

\n
    \n
  • \n

    The automatic upgrade is enabled for the maintenance window.

    \n
    • \n
  • \n

    A newer minor version is available.

    \n
    • \n
  • \n

    RDS has enabled automatic patching for the engine version.

    \n
    • \n
\n

If any of the preceding conditions isn't met, Amazon RDS applies the change as soon as possible and\n doesn't cause an outage.

\n

For an RDS Custom DB instance, don't enable this setting. Otherwise, the operation returns an error.

" + } + }, + "LicenseModel": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The license model for the DB instance.

\n

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

\n

Valid Values:

\n
    \n
  • \n

    RDS for Db2 - bring-your-own-license\n

    \n
    • \n
  • \n

    RDS for MariaDB - general-public-license\n

    \n
    • \n
  • \n

    RDS for Microsoft SQL Server - license-included\n

    \n
    • \n
  • \n

    RDS for MySQL - general-public-license\n

    \n
    • \n
  • \n

    RDS for Oracle - bring-your-own-license | license-included\n

    \n
    • \n
  • \n

    RDS for PostgreSQL - postgresql-license\n

    \n
    • \n
" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The new Provisioned IOPS (I/O operations per second) value for the RDS instance.

\n

Changing this setting doesn't result in an outage and\n the change is applied during the next maintenance window\n unless the ApplyImmediately parameter is enabled for this request.\n If you are migrating from Provisioned IOPS to standard storage, set this value to 0. \n The DB instance will require a reboot for the change in storage type to take effect.

\n

If you choose to migrate your DB instance from using standard storage to Provisioned\n IOPS (io1), or from Provisioned IOPS to standard storage, the process can take time. The\n duration of the migration depends on several factors such as database load, storage\n size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any),\n and the number of prior scale storage operations. Typical migration times are under 24\n hours, but the process can take up to several days in some cases. During the migration,\n the DB instance is available for use, but might experience performance degradation.\n While the migration takes place, nightly backups for the instance are suspended. No\n other Amazon RDS operations can take place for the instance, including modifying the\n instance, rebooting the instance, deleting the instance, creating a read replica for the\n instance, and creating a DB snapshot of the instance.

\n

\n

Constraints:

\n
    \n
  • \n

    For RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for PostgreSQL - The value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

    \n
    • \n
  • \n

    When you increase the Provisioned IOPS, you must also specify the\n AllocatedStorage parameter. You can use the current value for\n AllocatedStorage.

    \n
    • \n
\n

Default: Uses existing setting

" + } + }, + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The option group to associate the DB instance with.

\n

Changing this parameter doesn't result in an outage, with one exception. If the parameter change results \n in an option group that enables OEM, it can cause a brief period, lasting less than a second, during which \n new connections are rejected but existing connections aren't interrupted.

\n

The change is applied during the next maintenance window unless the ApplyImmediately parameter \n is enabled for this request.

\n

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed \n from an option group, and that option group can't be removed from a DB instance after \n it is associated with a DB instance.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "NewDBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The new identifier for the DB instance when renaming a DB instance. When you change the DB instance \n identifier, an instance reboot occurs immediately if you enable ApplyImmediately, or will occur \n during the next maintenance window if you disable ApplyImmediately. This value is stored as a lowercase string.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    The first character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Example: mydbinstance\n

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The storage type to associate with the DB instance.

\n

If you specify io1, io2, or gp3 \n you must also include a value for the Iops parameter.

\n

If you choose to migrate your DB instance from using standard storage to gp2 (General\n Purpose SSD), gp3, or Provisioned IOPS (io1), or from these storage types to standard\n storage, the process can take time. The duration of the migration depends on several\n factors such as database load, storage size, storage type (standard or Provisioned\n IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage\n operations. Typical migration times are under 24 hours, but the process can take up to\n several days in some cases. During the migration, the DB instance is available for use,\n but might experience performance degradation. While the migration takes place, nightly\n backups for the instance are suspended. No other Amazon RDS operations can take place\n for the instance, including modifying the instance, rebooting the instance, deleting the\n instance, creating a read replica for the instance, and creating a DB snapshot of the\n instance.

\n

Valid Values: gp2 | gp3 | io1 | io2 | standard\n

\n

Default: io1, if the Iops parameter\n is specified. Otherwise, gp2.

" + } + }, + "TdeCredentialArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN from the key store with which to associate the instance for TDE encryption.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "TdeCredentialPassword": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The password for the given ARN from the key store in order to access the device.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "CACertificateIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The CA certificate identifier to use for the DB instance's server certificate.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

For more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.

" + } + }, + "Domain": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Active Directory directory ID to move the DB instance to. \n Specify none to remove the instance from its current domain.\n You must create the domain before this operation. Currently, you can create only Db2, MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "DomainFqdn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The fully qualified domain name (FQDN) of an Active Directory domain.

\n

Constraints:

\n
    \n
  • \n

    Can't be longer than 64 characters.

    \n
    • \n
\n

Example: mymanagedADtest.mymanagedAD.mydomain\n

" + } + }, + "DomainOu": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Active Directory organizational unit for your DB instance to join.

\n

Constraints:

\n
    \n
  • \n

    Must be in the distinguished name format.

    \n
    • \n
  • \n

    Can't be longer than 64 characters.

    \n
    • \n
\n

Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain\n

" + } + }, + "DomainAuthSecretArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN for the Secrets Manager secret with the credentials for the user joining the domain.

\n

Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456\n

" + } + }, + "DomainDnsIps": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.

\n

Constraints:

\n
    \n
  • \n

    Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.

    \n
    • \n
\n

Example: 123.124.125.126,234.235.236.237\n

" + } + }, + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags aren't copied.

\n

This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting. For more\n information, see ModifyDBCluster.

" + } + }, + "MonitoringInterval": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for \n the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0.

\n

If MonitoringRoleArn is specified, set MonitoringInterval\n to a value other than 0.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60\n

\n

Default: 0\n

" + } + }, + "DBPortNumber": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port number on which the database accepts connections.

\n

The value of the DBPortNumber parameter must not match any of the port values \n specified for options in the option group for the DB instance.

\n

If you change the DBPortNumber value, your database restarts regardless of \n the value of the ApplyImmediately parameter.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Valid Values: 1150-65535\n

\n

Default:

\n
    \n
  • \n

    Amazon Aurora - 3306\n

    \n
    • \n
  • \n

    RDS for Db2 - 50000\n

    \n
    • \n
  • \n

    RDS for MariaDB - 3306\n

    \n
    • \n
  • \n

    RDS for Microsoft SQL Server - 1433\n

    \n
    • \n
  • \n

    RDS for MySQL - 3306\n

    \n
    • \n
  • \n

    RDS for Oracle - 1521\n

    \n
    • \n
  • \n

    RDS for PostgreSQL - 5432\n

    \n
    • \n
\n

Constraints:

\n
    \n
  • \n

    For RDS for Microsoft SQL Server, the value can't be 1234, 1434,\n 3260, 3343, 3389, 47001, or\n 49152-49156.

    \n
    • \n
" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the DB instance is publicly accessible.

\n

When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), \n its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, \n the endpoint resolves to the private IP address. Access to the DB instance is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB instance doesn't permit it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

\n PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a \n public subnet and PubliclyAccessible must be enabled for it to be publicly accessible.

\n

Changes to the PubliclyAccessible parameter are applied immediately regardless\n of the value of the ApplyImmediately parameter.

" + } + }, + "MonitoringRoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.\n

\n

If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn \n value.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "DomainIAMRoleName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the IAM role to use when making API calls to the Directory Service.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "DisableDomain": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to remove the DB instance from the Active Directory domain.

" + } + }, + "PromotionTier": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The order of priority in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Default: 1\n

\n

Valid Values: 0 - 15\n

" + } + }, + "EnableIAMDatabaseAuthentication": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.

\n

This setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB\n cluster.

\n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "DatabaseInsightsMode": { + "target": "com.amazonaws.rds#DatabaseInsightsMode", + "traits": { + "smithy.api#documentation": "

Specifies the mode of Database Insights to enable for the DB instance.

\n

This setting only applies to Amazon Aurora DB instances.

\n \n

Currently, this value is inherited from the DB cluster and can't be changed.

\n " + } + }, + "EnablePerformanceInsights": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable Performance Insights for the DB instance.

\n

For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "PerformanceInsightsKMSKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "PerformanceInsightsRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days to retain Performance Insights data.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Valid Values:

\n
    \n
  • \n

    \n 7\n

    \n
    • \n
  • \n

    \n month * 31, where month is a number of months from 1-23. \n Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)

    \n
    • \n
  • \n

    \n 731\n

    \n
    • \n
\n

Default: 7 days

\n

If you specify a retention period that isn't valid, such as 94, Amazon RDS returns an error.

" + } + }, + "CloudwatchLogsExportConfiguration": { + "target": "com.amazonaws.rds#CloudwatchLogsExportConfiguration", + "traits": { + "smithy.api#documentation": "

The log types to be enabled for export to CloudWatch Logs for a \n specific DB instance.

\n

A change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance \n immediately. Therefore, the ApplyImmediately parameter has no effect.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

The following values are valid for each DB engine:

\n
    \n
  • \n

    Aurora MySQL - audit | error | general | slowquery\n

    \n
    • \n
  • \n

    Aurora PostgreSQL - postgresql\n

    \n
    • \n
  • \n

    RDS for MySQL - error | general | slowquery\n

    \n
    • \n
  • \n

    RDS for PostgreSQL - postgresql | upgrade\n

    \n
    • \n
\n

For more information about exporting CloudWatch Logs for Amazon RDS, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

" + } + }, + "ProcessorFeatures": { + "target": "com.amazonaws.rds#ProcessorFeatureList", + "traits": { + "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "UseDefaultProcessorFeatures": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the DB instance class of the DB instance uses its default\n processor features.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.

\n

This setting doesn't apply to Amazon Aurora DB instances. You can enable or disable deletion protection for the DB cluster. \n For more information, see ModifyDBCluster. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.

" + } + }, + "MaxAllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

\n

For more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "CertificateRotationRestart": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the DB instance is restarted when you rotate your \n SSL/TLS certificate.

\n

By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate \n is not updated until the DB instance is restarted.

\n \n

Set this parameter only if you are not using SSL/TLS to connect to the DB instance.

\n \n

If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your \n DB engine to rotate your SSL/TLS certificate:

\n \n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "ReplicaMode": { + "target": "com.amazonaws.rds#ReplicaMode", + "traits": { + "smithy.api#documentation": "

A value that sets the open mode of a replica database to either mounted or read-only.

\n \n

Currently, this parameter is only supported for Oracle DB instances.

\n \n

Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for \n mounted replicas is cross-Region disaster recovery. The primary database doesn't use \n Active Data Guard to transmit information to the mounted replica. Because it doesn't \n accept user connections, a mounted replica can't serve a read-only workload. \n For more information, see Working with Oracle Read Replicas for Amazon RDS \n in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "EnableCustomerOwnedIp": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" + } + }, + "AwsBackupRecoveryPointArn": { + "target": "com.amazonaws.rds#AwsBackupRecoveryPointArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "AutomationMode": { + "target": "com.amazonaws.rds#AutomationMode", + "traits": { + "smithy.api#documentation": "

The automation mode of the RDS Custom DB instance. \n If full, the DB instance automates monitoring and instance recovery. If \n all paused, the instance pauses automation for the duration set by \n ResumeFullAutomationModeMinutes.

" + } + }, + "ResumeFullAutomationModeMinutes": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of minutes to pause the automation. When the time period ends, RDS Custom resumes \n full automation.

\n

Default: 60\n

\n

Constraints:

\n
    \n
  • \n

    Must be at least 60.

    \n
    • \n
  • \n

    Must be no more than 1,440.

    \n
    • \n
" + } + }, + "NetworkType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The network type of the DB instance.

\n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

\n

Valid Values: IPV4 | DUAL\n

" + } + }, + "StorageThroughput": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The storage throughput value for the DB instance.

\n

This setting applies only to the gp3 storage type.

\n

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

" + } + }, + "ManageMasterUserPassword": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

\n

If the DB instance doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn \n on this management. In this case, you can't specify MasterUserPassword.

\n

If the DB instance already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the \n master user password is not managed with Amazon Web Services Secrets Manager, then you must specify MasterUserPassword. \n In this case, Amazon RDS deletes the secret and uses the new password for the master user specified by \n MasterUserPassword.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.\n

\n

Constraints:

\n
    \n
  • \n

    Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword \n is specified.

    \n
    • \n
" + } + }, + "RotateMasterUserPassword": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the \n master user password.

\n

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB cluster. The secret value contains the updated password.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.\n

\n

Constraints:

\n
    \n
  • \n

    You must apply the change immediately when rotating the master user password.

    \n
    • \n
" + } + }, + "MasterUserSecretKmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and \n managed in Amazon Web Services Secrets Manager.

\n

This setting is valid only if both of the following conditions are met:

\n
    \n
  • \n

    The DB instance doesn't manage the master user password in Amazon Web Services Secrets Manager.

    \n

    If the DB instance already manages the master user password in Amazon Web Services Secrets Manager, \n you can't change the KMS key used to encrypt the secret.

    \n
    • \n
  • \n

    You are turning on ManageMasterUserPassword to manage the master user password \n in Amazon Web Services Secrets Manager.

    \n

    If you are turning on ManageMasterUserPassword and don't specify \n MasterUserSecretKmsKeyId, then the aws/secretsmanager \n KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't \n use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer \n managed KMS key.

    \n
    • \n
\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.

" + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The target Oracle DB engine when you convert a non-CDB to a CDB. This intermediate step is necessary to upgrade an Oracle Database 19c non-CDB\n to an Oracle Database 21c CDB.

\n

Note the following requirements:

\n
    \n
  • \n

    Make sure that you specify oracle-ee-cdb or oracle-se2-cdb.

    \n
    • \n
  • \n

    Make sure that your DB engine runs Oracle Database 19c with an April 2021 or later RU.

    \n
    • \n
\n

Note the following limitations:

\n
    \n
  • \n

    You can't convert a CDB to a non-CDB.

    \n
    • \n
  • \n

    You can't convert a replica database.

    \n
    • \n
  • \n

    You can't convert a non-CDB to a CDB and upgrade the engine version in the\n same command.

    \n
    • \n
  • \n

    You can't convert the existing custom parameter or option group when it has\n options or parameters that are permanent or persistent. In this situation, the\n DB instance reverts to the default option and parameter group. To avoid\n reverting to the default, specify a new parameter group with\n --db-parameter-group-name and a new option group with\n --option-group-name.

    \n
    • \n
" + } + }, + "DedicatedLogVolume": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether the DB instance has a dedicated log volume (DLV) enabled.

" + } + }, + "MultiTenant": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the to convert your DB instance from the single-tenant configuration\n to the multi-tenant configuration. This parameter is supported only for RDS for Oracle\n CDB instances.

\n

During the conversion, RDS creates an initial tenant database and associates the DB\n name, master user name, character set, and national character set metadata with this\n database. The tags associated with the instance also propagate to the initial tenant\n database. You can add more tenant databases to your DB instance by using the\n CreateTenantDatabase operation.

\n \n

The conversion to the multi-tenant configuration is permanent and irreversible, so\n you can't later convert back to the single-tenant configuration. When you specify\n this parameter, you must also specify ApplyImmediately.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ModifyDBInstanceResult": { + "type": "structure", + "members": { + "DBInstance": { + "target": "com.amazonaws.rds#DBInstance" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#ModifyDBParameterGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyDBParameterGroupMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBParameterGroupNameMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBParameterGroupStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies the parameters of a DB parameter group. To modify more than one parameter,\n submit a list of the following: ParameterName, ParameterValue, and \n ApplyMethod. A maximum of 20 parameters can be modified in a single request.

\n \n

After you modify a DB parameter group, you should wait at least 5 minutes\n before creating your first DB instance that uses that DB parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the modify operation before the parameter \n group is used as the default for a new DB instance. This is especially important for parameters \n that are critical when creating the default database for a DB instance, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBParameters command to verify \n that your DB parameter group has been created or modified.

\n ", + "smithy.api#examples": [ + { + "title": "To modify a DB parameter group", + "documentation": "The following example changes the value of the clr enabled parameter in a DB parameter group. The value of the ApplyMethod parameter causes the DB parameter group to be modified immediately, instead of waiting until the next maintenance window.", + "input": { + "DBParameterGroupName": "test-sqlserver-se-2017", + "Parameters": [ + { + "ParameterName": "clr enabled", + "ParameterValue": "1", + "ApplyMethod": "immediate" + } + ] + }, + "output": { + "DBParameterGroupName": "test-sqlserver-se-2017" + } + } + ] + } + }, + "com.amazonaws.rds#ModifyDBParameterGroupMessage": { + "type": "structure", + "members": { + "DBParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the DB parameter group.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBParameterGroup.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Parameters": { + "target": "com.amazonaws.rds#ParametersList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An array of parameter names, values, and the application methods for the parameter update. At least one parameter name, value, and \n application method must be supplied; later arguments are optional. A maximum of 20 parameters can be modified in a single request.

\n

Valid Values (for the application method): immediate | pending-reboot\n

\n

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic \n and static parameters.

\n

When the application method is immediate, changes to dynamic parameters are applied immediately to the DB instances associated with \n the parameter group.

\n

When the application method is pending-reboot, changes to dynamic and static parameters are applied after a reboot without failover \n to the DB instances associated with the parameter group.

\n \n

You can't use pending-reboot with dynamic parameters on RDS for SQL Server DB instances. Use immediate.

\n \n

For more information on modifying DB parameters, see Working \n with DB parameter groups in the Amazon RDS User Guide.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ModifyDBProxy": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyDBProxyRequest" + }, + "output": { + "target": "com.amazonaws.rds#ModifyDBProxyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBProxyAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBProxyNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBProxyStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Changes the settings for an existing DB proxy.

" + } + }, + "com.amazonaws.rds#ModifyDBProxyEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyDBProxyEndpointRequest" + }, + "output": { + "target": "com.amazonaws.rds#ModifyDBProxyEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBProxyEndpointAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBProxyEndpointNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBProxyEndpointStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBProxyStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Changes the settings for an existing DB proxy endpoint.

" + } + }, + "com.amazonaws.rds#ModifyDBProxyEndpointRequest": { + "type": "structure", + "members": { + "DBProxyEndpointName": { + "target": "com.amazonaws.rds#DBProxyEndpointName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the DB proxy sociated with the DB proxy endpoint that you want to modify.

", + "smithy.api#required": {} + } + }, + "NewDBProxyEndpointName": { + "target": "com.amazonaws.rds#DBProxyEndpointName", + "traits": { + "smithy.api#documentation": "

The new identifier for the DBProxyEndpoint. An identifier must\n begin with a letter and must contain only ASCII letters, digits, and hyphens; it\n can't end with a hyphen or contain two consecutive hyphens.

" + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The VPC security group IDs for the DB proxy endpoint. When the DB proxy endpoint\n uses a different VPC than the original proxy, you also specify a different\n set of security group IDs than for the original proxy.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ModifyDBProxyEndpointResponse": { + "type": "structure", + "members": { + "DBProxyEndpoint": { + "target": "com.amazonaws.rds#DBProxyEndpoint", + "traits": { + "smithy.api#documentation": "

The DBProxyEndpoint object representing the new settings for the DB proxy endpoint.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#ModifyDBProxyRequest": { + "type": "structure", + "members": { + "DBProxyName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier for the DBProxy to modify.

", + "smithy.api#required": {} + } + }, + "NewDBProxyName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The new identifier for the DBProxy. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

" + } + }, + "Auth": { + "target": "com.amazonaws.rds#UserAuthConfigList", + "traits": { + "smithy.api#documentation": "

The new authentication settings for the DBProxy.

" + } + }, + "RequireTLS": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Whether Transport Layer Security (TLS) encryption is required for connections to the proxy.\n By enabling this setting, you can enforce encrypted TLS connections to the proxy, even if the associated database doesn't\n use TLS.

" + } + }, + "IdleClientTimeout": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this\n value higher or lower than the connection timeout limit for the associated database.

" + } + }, + "DebugLogging": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Whether the proxy includes detailed information about SQL statements in its logs.\n This information helps you to debug issues involving SQL behavior or the performance\n and scalability of the proxy connections. The debug information includes the text of\n SQL statements that you submit through the proxy. Thus, only enable this setting\n when needed for debugging, and only when you have security measures in place to\n safeguard any sensitive information that appears in the logs.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.

" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The new list of security groups for the DBProxy.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ModifyDBProxyResponse": { + "type": "structure", + "members": { + "DBProxy": { + "target": "com.amazonaws.rds#DBProxy", + "traits": { + "smithy.api#documentation": "

The DBProxy object representing the new settings for the proxy.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#ModifyDBProxyTargetGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyDBProxyTargetGroupRequest" + }, + "output": { + "target": "com.amazonaws.rds#ModifyDBProxyTargetGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBProxyNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBProxyStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies the properties of a DBProxyTargetGroup.

" + } + }, + "com.amazonaws.rds#ModifyDBProxyTargetGroupRequest": { + "type": "structure", + "members": { + "TargetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the target group to modify.

", + "smithy.api#required": {} + } + }, + "DBProxyName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the proxy.

", + "smithy.api#required": {} + } + }, + "ConnectionPoolConfig": { + "target": "com.amazonaws.rds#ConnectionPoolConfiguration", + "traits": { + "smithy.api#documentation": "

The settings that determine the size and behavior of the connection pool for the target group.

" + } + }, + "NewName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The new name for the modified DBProxyTarget. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ModifyDBProxyTargetGroupResponse": { + "type": "structure", + "members": { + "DBProxyTargetGroup": { + "target": "com.amazonaws.rds#DBProxyTargetGroup", + "traits": { + "smithy.api#documentation": "

The settings of the modified DBProxyTarget.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#ModifyDBRecommendation": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyDBRecommendationMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBRecommendationMessage" + }, + "traits": { + "smithy.api#documentation": "

Updates the recommendation status and recommended action status for the specified recommendation.

" + } + }, + "com.amazonaws.rds#ModifyDBRecommendationMessage": { + "type": "structure", + "members": { + "RecommendationId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier of the recommendation to update.

", + "smithy.api#required": {} + } + }, + "Locale": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The language of the modified recommendation.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The recommendation status to update.

\n

Valid values:

\n
    \n
  • \n

    active

    \n
    • \n
  • \n

    dismissed

    \n
    • \n
" + } + }, + "RecommendedActionUpdates": { + "target": "com.amazonaws.rds#RecommendedActionUpdateList", + "traits": { + "smithy.api#documentation": "

The list of recommended action status to update. You can update multiple recommended actions at one time.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ModifyDBShardGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyDBShardGroupMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBShardGroup" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBShardGroupAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBShardGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies the settings of an Aurora Limitless Database DB shard group. You can change one or more settings by \n specifying these parameters and the new values in the request.

" + } + }, + "com.amazonaws.rds#ModifyDBShardGroupMessage": { + "type": "structure", + "members": { + "DBShardGroupIdentifier": { + "target": "com.amazonaws.rds#DBShardGroupIdentifier", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the DB shard group to modify.

", + "smithy.api#required": {} + } + }, + "MaxACU": { + "target": "com.amazonaws.rds#DoubleOptional", + "traits": { + "smithy.api#documentation": "

The maximum capacity of the DB shard group in Aurora capacity units (ACUs).

" + } + }, + "MinACU": { + "target": "com.amazonaws.rds#DoubleOptional", + "traits": { + "smithy.api#documentation": "

The minimum capacity of the DB shard group in Aurora capacity units (ACUs).

" + } + }, + "ComputeRedundancy": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to create standby DB shard groups for the DB shard group. Valid values are the following:

\n
    \n
  • \n

    0 - Creates a DB shard group without a standby DB shard group. This is the default value.

    \n
    • \n
  • \n

    1 - Creates a DB shard group with a standby DB shard group in a different Availability Zone (AZ).

    \n
    • \n
  • \n

    2 - Creates a DB shard group with two standby DB shard groups in two different AZs.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ModifyDBSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyDBSnapshotMessage" + }, + "output": { + "target": "com.amazonaws.rds#ModifyDBSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted\n or unencrypted, but not shared or public.\n \n

\n

Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This operation\n doesn't apply to RDS Custom or RDS for Db2.

", + "smithy.api#examples": [ + { + "title": "To modify a DB snapshot", + "documentation": "The following example upgrades a PostgeSQL 10.6 snapshot named db5-snapshot-upg-test to PostgreSQL 11.7. The new DB engine version is shown after the snapshot has finished upgrading and its status is available.", + "input": { + "DBSnapshotIdentifier": "db5-snapshot-upg-test", + "EngineVersion": "11.7" + }, + "output": { + "DBSnapshot": { + "DBSnapshotIdentifier": "db5-snapshot-upg-test", + "DBInstanceIdentifier": "database-5", + "SnapshotCreateTime": "2020-03-27T20:49:17.092Z", + "Engine": "postgres", + "AllocatedStorage": 20, + "Status": "upgrading", + "Port": 5432, + "AvailabilityZone": "us-west-2a", + "VpcId": "vpc-2ff27557", + "InstanceCreateTime": "2020-03-27T19:59:04.735Z", + "MasterUsername": "postgres", + "EngineVersion": "10.6", + "LicenseModel": "postgresql-license", + "SnapshotType": "manual", + "OptionGroupName": "default:postgres-11", + "PercentProgress": 100, + "StorageType": "gp2", + "Encrypted": false, + "DBSnapshotArn": "arn:aws:rds:us-west-2:123456789012:snapshot:db5-snapshot-upg-test", + "IAMDatabaseAuthenticationEnabled": false, + "ProcessorFeatures": [], + "DbiResourceId": "db-GJMF75LM42IL6BTFRE4UZJ5YM4" + } + } + } + ] + } + }, + "com.amazonaws.rds#ModifyDBSnapshotAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyDBSnapshotAttributeMessage" + }, + "output": { + "target": "com.amazonaws.rds#ModifyDBSnapshotAttributeResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSnapshotStateFault" + }, + { + "target": "com.amazonaws.rds#SharedSnapshotQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.

\n

To share a manual DB snapshot with other Amazon Web Services accounts, specify restore\n as the AttributeName and use the ValuesToAdd parameter to add\n a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB snapshot.\n Uses the value all to make the manual DB snapshot public, which means it\n can be copied or restored by all Amazon Web Services accounts.

\n \n

Don't add the all value for any manual DB snapshots that\n contain private information that you don't want available to all Amazon Web Services\n accounts.

\n \n

If the manual DB snapshot is encrypted, it can be shared, but only by specifying a\n list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You\n can't use all as a value for that parameter in this case.

\n

To view which Amazon Web Services accounts have access to copy or restore a manual DB snapshot, or\n whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API operation. The accounts are returned as\n values for the restore attribute.

", + "smithy.api#examples": [ + { + "title": "To allow two AWS accounts to restore a DB snapshot", + "documentation": "The following example grants permission to two AWS accounts, with the identifiers 111122223333 and 444455556666, to restore the DB snapshot named mydbsnapshot.", + "input": { + "DBSnapshotIdentifier": "mydbsnapshot", + "AttributeName": "restore", + "ValuesToAdd": [ + "111122223333", + "444455556666" + ] + }, + "output": { + "DBSnapshotAttributesResult": { + "DBSnapshotIdentifier": "mydbsnapshot", + "DBSnapshotAttributes": [ + { + "AttributeName": "restore", + "AttributeValues": [ + "111122223333", + "444455556666" + ] + } + ] + } + } + }, + { + "title": "To prevent an AWS account from restoring a DB snapshot", + "documentation": "The following example removes permission from the AWS account with the identifier 444455556666 to restore the DB snapshot named mydbsnapshot.", + "input": { + "DBSnapshotIdentifier": "mydbsnapshot", + "AttributeName": "restore", + "ValuesToRemove": [ + "444455556666" + ] + }, + "output": { + "DBSnapshotAttributesResult": { + "DBSnapshotIdentifier": "mydbsnapshot", + "DBSnapshotAttributes": [ + { + "AttributeName": "restore", + "AttributeValues": [ + "111122223333" + ] + } + ] + } + } + } + ] + } + }, + "com.amazonaws.rds#ModifyDBSnapshotAttributeMessage": { + "type": "structure", + "members": { + "DBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier for the DB snapshot to modify the attributes for.

", + "smithy.api#required": {} + } + }, + "AttributeName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the DB snapshot attribute to modify.

\n

To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB snapshot, \n set this value to restore.

\n \n

To view the list of attributes available to modify, use the\n DescribeDBSnapshotAttributes API operation.

\n ", + "smithy.api#required": {} + } + }, + "ValuesToAdd": { + "target": "com.amazonaws.rds#AttributeValueList", + "traits": { + "smithy.api#documentation": "

A list of DB snapshot attributes to add to the attribute specified by AttributeName.

\n

To authorize other Amazon Web Services accounts to copy or restore a manual snapshot, set this list to include one or more Amazon Web Services account\n IDs, or all to make the manual DB snapshot restorable by \n any Amazon Web Services account. Do not add the all value for any\n manual DB snapshots that contain private information that you don't want available\n to all Amazon Web Services accounts.

" + } + }, + "ValuesToRemove": { + "target": "com.amazonaws.rds#AttributeValueList", + "traits": { + "smithy.api#documentation": "

A list of DB snapshot attributes to remove from the attribute specified by AttributeName.

\n

To remove authorization for other Amazon Web Services accounts to copy or restore a manual snapshot, set this list to include \n one or more Amazon Web Services account\n identifiers, or all to remove authorization for any Amazon Web Services account to copy or\n restore the DB snapshot. If you specify all, an Amazon Web Services account whose\n account ID is explicitly added to the restore attribute\n can still copy or restore the manual DB snapshot.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ModifyDBSnapshotAttributeResult": { + "type": "structure", + "members": { + "DBSnapshotAttributesResult": { + "target": "com.amazonaws.rds#DBSnapshotAttributesResult" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#ModifyDBSnapshotMessage": { + "type": "structure", + "members": { + "DBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier of the DB snapshot to modify.

", + "smithy.api#required": {} + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The engine version to upgrade the DB snapshot to.

\n

The following are the database engines and engine versions that are available when you upgrade a DB snapshot.

\n

\n MySQL\n

\n

For the list of engine versions that are available for upgrading a DB snapshot, see \n \n Upgrading a MySQL DB snapshot engine version in the Amazon RDS User Guide.\n

\n

\n Oracle\n

\n
    \n
  • \n

    \n 19.0.0.0.ru-2022-01.rur-2022-01.r1 (supported for 12.2.0.1 DB\n snapshots)

    \n
    • \n
  • \n

    \n 19.0.0.0.ru-2022-07.rur-2022-07.r1 (supported for 12.1.0.2 DB\n snapshots)

    \n
    • \n
  • \n

    \n 12.1.0.2.v8 (supported for 12.1.0.1 DB snapshots)

    \n
    • \n
  • \n

    \n 11.2.0.4.v12 (supported for 11.2.0.2 DB snapshots)

    \n
    • \n
  • \n

    \n 11.2.0.4.v11 (supported for 11.2.0.3 DB snapshots)

    \n
    • \n
\n

\n PostgreSQL\n

\n

For the list of engine versions that are available for upgrading a DB snapshot, see \n \n Upgrading a PostgreSQL DB snapshot engine version in the Amazon RDS User Guide.\n

" + } + }, + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The option group to identify with the upgraded DB snapshot.

\n

You can specify this parameter when you upgrade an Oracle DB snapshot.\n The same option group considerations apply when upgrading a DB snapshot as when upgrading a DB instance.\n For more information, see \n Option group considerations in the Amazon RDS User Guide.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ModifyDBSnapshotResult": { + "type": "structure", + "members": { + "DBSnapshot": { + "target": "com.amazonaws.rds#DBSnapshot" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#ModifyDBSubnetGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyDBSubnetGroupMessage" + }, + "output": { + "target": "com.amazonaws.rds#ModifyDBSubnetGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSubnetQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#InvalidSubnet" + }, + { + "target": "com.amazonaws.rds#SubnetAlreadyInUse" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.

", + "smithy.api#examples": [ + { + "title": "To modify a DB subnet group", + "documentation": "The following example adds a subnet with the ID subnet-08e41f9e230222222 to the DB subnet group named mysubnetgroup. To keep the existing subnets in the subnet group, include their IDs as values in the --subnet-ids option. Make sure to have subnets with at least two different Availability Zones in the DB subnet group.", + "input": { + "DBSubnetGroupName": "mysubnetgroup", + "DBSubnetGroupDescription": "", + "SubnetIds": [ + "subnet-0a1dc4e1a6f123456", + "subnet-070dd7ecb3aaaaaaa", + "subnet-00f5b198bc0abcdef", + "subnet-08e41f9e230222222" + ] + }, + "output": { + "DBSubnetGroup": { + "DBSubnetGroupName": "mysubnetgroup", + "DBSubnetGroupDescription": "test DB subnet group", + "VpcId": "vpc-0f08e7610a1b2c3d4", + "SubnetGroupStatus": "Complete", + "Subnets": [ + { + "SubnetIdentifier": "subnet-08e41f9e230222222", + "SubnetAvailabilityZone": { + "Name": "us-west-2a" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-070dd7ecb3aaaaaaa", + "SubnetAvailabilityZone": { + "Name": "us-west-2b" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-00f5b198bc0abcdef", + "SubnetAvailabilityZone": { + "Name": "us-west-2d" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-0a1dc4e1a6f123456", + "SubnetAvailabilityZone": { + "Name": "us-west-2b" + }, + "SubnetStatus": "Active" + } + ], + "DBSubnetGroupArn": "arn:aws:rds:us-west-2:123456789012:subgrp:mysubnetgroup" + } + } + } + ] + } + }, + "com.amazonaws.rds#ModifyDBSubnetGroupMessage": { + "type": "structure", + "members": { + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name for the DB subnet group. This value is stored as a lowercase string.\n You can't modify the default subnet group.

\n

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

\n

Example: mydbsubnetgroup\n

", + "smithy.api#required": {} + } + }, + "DBSubnetGroupDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The description for the DB subnet group.

" + } + }, + "SubnetIds": { + "target": "com.amazonaws.rds#SubnetIdentifierList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The EC2 subnet IDs for the DB subnet group.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ModifyDBSubnetGroupResult": { + "type": "structure", + "members": { + "DBSubnetGroup": { + "target": "com.amazonaws.rds#DBSubnetGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#ModifyEventSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyEventSubscriptionMessage" + }, + "output": { + "target": "com.amazonaws.rds#ModifyEventSubscriptionResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#EventSubscriptionQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#SNSInvalidTopicFault" + }, + { + "target": "com.amazonaws.rds#SNSNoAuthorizationFault" + }, + { + "target": "com.amazonaws.rds#SNSTopicArnNotFoundFault" + }, + { + "target": "com.amazonaws.rds#SubscriptionCategoryNotFoundFault" + }, + { + "target": "com.amazonaws.rds#SubscriptionNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies an existing RDS event notification subscription. You can't modify the source identifiers using this call. To change \n source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.

\n

You can see a list of the event categories for a given source type (SourceType) \n in Events in the Amazon RDS User Guide \n or by using the DescribeEventCategories operation.

", + "smithy.api#examples": [ + { + "title": "To modify an event subscription", + "documentation": "The following example turns off the specified event subscription, so that it no longer publishes notifications to the specified Amazon Simple Notification Service topic.", + "input": { + "SubscriptionName": "my-instance-events", + "Enabled": false + }, + "output": { + "EventSubscription": { + "EventCategoriesList": [ + "backup", + "recovery" + ], + "CustomerAwsId": "123456789012", + "SourceType": "db-instance", + "SubscriptionCreationTime": "Tue Jul 31 23:22:01 UTC 2018", + "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events", + "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events", + "CustSubscriptionId": "my-instance-events", + "Status": "modifying", + "Enabled": false + } + } + } + ] + } + }, + "com.amazonaws.rds#ModifyEventSubscriptionMessage": { + "type": "structure", + "members": { + "SubscriptionName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the RDS event notification subscription.

", + "smithy.api#required": {} + } + }, + "SnsTopicArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

" + } + }, + "SourceType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are returned.

\n

Valid Values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy | zero-etl | custom-engine-version | blue-green-deployment \n

" + } + }, + "EventCategories": { + "target": "com.amazonaws.rds#EventCategoriesList", + "traits": { + "smithy.api#documentation": "

A list of event categories for a source type (SourceType) that you want to subscribe to. \n You can see a list of the categories for a given source type \n in Events in the Amazon RDS User Guide \n or by using the DescribeEventCategories operation.

" + } + }, + "Enabled": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to activate the subscription.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ModifyEventSubscriptionResult": { + "type": "structure", + "members": { + "EventSubscription": { + "target": "com.amazonaws.rds#EventSubscription" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#ModifyGlobalCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyGlobalClusterMessage" + }, + "output": { + "target": "com.amazonaws.rds#ModifyGlobalClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#GlobalClusterAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#GlobalClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidGlobalClusterStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies a setting for an Amazon Aurora global database cluster. You can change one or more database configuration\n parameters by specifying these parameters and the new values in the request. For more information on\n Amazon Aurora, see What is Amazon Aurora? in the\n Amazon Aurora User Guide.

\n \n

This operation only applies to Aurora global database clusters.

\n ", + "smithy.api#examples": [ + { + "title": "To modify a global database cluster", + "documentation": "The following example enables deletion protection for an Aurora MySQL-based global database cluster.", + "input": { + "GlobalClusterIdentifier": "myglobalcluster", + "DeletionProtection": true + }, + "output": { + "GlobalCluster": { + "GlobalClusterIdentifier": "myglobalcluster", + "GlobalClusterResourceId": "cluster-f0e523bfe07aabb", + "GlobalClusterArn": "arn:aws:rds::123456789012:global-cluster:myglobalcluster", + "Status": "available", + "Engine": "aurora-mysql", + "EngineVersion": "5.7.mysql_aurora.2.07.2", + "StorageEncrypted": false, + "DeletionProtection": true, + "GlobalClusterMembers": [] + } + } + } + ] + } + }, + "com.amazonaws.rds#ModifyGlobalClusterMessage": { + "type": "structure", + "members": { + "GlobalClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The cluster identifier for the global cluster to modify. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing global database cluster.

    \n
    • \n
" + } + }, + "NewGlobalClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The new cluster identifier for the global database cluster.\n This value is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    The first character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Example: my-cluster2\n

" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable deletion protection for the global database cluster. The global database cluster\n can't be deleted when deletion protection is enabled.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version number of the database engine to which you want to upgrade. \n

\n

To list all of the available engine versions for aurora-mysql (for MySQL-based Aurora global databases), use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'\n

\n

To list all of the available engine versions for aurora-postgresql (for PostgreSQL-based Aurora global databases), use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-postgresql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'\n

" + } + }, + "AllowMajorVersionUpgrade": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to allow major version upgrades.

\n

Constraints: Must be enabled if you specify a value for the\n EngineVersion parameter that's a different major version than the global\n cluster's current version.

\n

If you upgrade the major version of a global database, the cluster and DB instance parameter\n groups are set to the default parameter groups for the new version. Apply any custom parameter\n groups after completing the upgrade.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ModifyGlobalClusterResult": { + "type": "structure", + "members": { + "GlobalCluster": { + "target": "com.amazonaws.rds#GlobalCluster" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#ModifyIntegration": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyIntegrationMessage" + }, + "output": { + "target": "com.amazonaws.rds#Integration" + }, + "errors": [ + { + "target": "com.amazonaws.rds#IntegrationConflictOperationFault" + }, + { + "target": "com.amazonaws.rds#IntegrationNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidIntegrationStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies a zero-ETL integration with Amazon Redshift.

\n \n

Currently, you can only modify integrations that have Aurora MySQL source DB clusters. Integrations with Aurora PostgreSQL and RDS sources currently don't support modifying the integration.

\n ", + "smithy.api#examples": [ + { + "title": "To modify a zero-ETL integration", + "documentation": "The following example modifies the name of an existing zero-ETL integration.", + "input": { + "IntegrationIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "IntegrationName": "my-renamed-integration" + }, + "output": { + "SourceArn": "arn:aws:rds:us-east-1:123456789012:cluster:my-cluster", + "IntegrationName": "my-renamed-integration", + "IntegrationArn": "arn:aws:rds:us-east-1:123456789012:integration:5b9f3d79-7392-4a3e-896c-58eaa1b53231", + "TargetArn": "arn:aws:redshift-serverless:us-east-1:123456789012:namespace/62c70612-0302-4db7-8414-b5e3e049f0d8", + "Tags": [], + "DataFilter": "include: *.*", + "CreateTime": "2023-12-28T17:20:20.629Z", + "KMSKeyId": "arn:aws:kms:us-east-1:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa", + "Status": "active" + } + } + ] + } + }, + "com.amazonaws.rds#ModifyIntegrationMessage": { + "type": "structure", + "members": { + "IntegrationIdentifier": { + "target": "com.amazonaws.rds#IntegrationIdentifier", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The unique identifier of the integration to modify.

", + "smithy.api#required": {} + } + }, + "IntegrationName": { + "target": "com.amazonaws.rds#IntegrationName", + "traits": { + "smithy.api#documentation": "

A new name for the integration.

" + } + }, + "DataFilter": { + "target": "com.amazonaws.rds#DataFilter", + "traits": { + "smithy.api#documentation": "

A new data filter for the integration. For more information, see \n Data filtering for Aurora zero-ETL integrations with Amazon Redshift.

" + } + }, + "Description": { + "target": "com.amazonaws.rds#IntegrationDescription", + "traits": { + "smithy.api#documentation": "

A new description for the integration.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ModifyOptionGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyOptionGroupMessage" + }, + "output": { + "target": "com.amazonaws.rds#ModifyOptionGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#InvalidOptionGroupStateFault" + }, + { + "target": "com.amazonaws.rds#OptionGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies an existing option group.

", + "smithy.api#examples": [ + { + "title": "To modify an option group", + "documentation": "The following example adds an option to an option group.", + "input": { + "OptionGroupName": "myawsuser-og02", + "OptionsToInclude": [ + { + "OptionName": "MEMCACHED", + "DBSecurityGroupMemberships": [ + "default" + ] + } + ], + "ApplyImmediately": true + }, + "output": { + "OptionGroup": {} + } + } + ] + } + }, + "com.amazonaws.rds#ModifyOptionGroupMessage": { + "type": "structure", + "members": { + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the option group to be modified.

\n

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance

", + "smithy.api#required": {} + } + }, + "OptionsToInclude": { + "target": "com.amazonaws.rds#OptionConfigurationList", + "traits": { + "smithy.api#documentation": "

Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.

" + } + }, + "OptionsToRemove": { + "target": "com.amazonaws.rds#OptionNamesList", + "traits": { + "smithy.api#documentation": "

Options in this list are removed from the option group.

" + } + }, + "ApplyImmediately": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether to apply the change immediately or during the next maintenance window for each instance associated with the option group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ModifyOptionGroupResult": { + "type": "structure", + "members": { + "OptionGroup": { + "target": "com.amazonaws.rds#OptionGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#ModifyTenantDatabase": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyTenantDatabaseMessage" + }, + "output": { + "target": "com.amazonaws.rds#ModifyTenantDatabaseResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#TenantDatabaseAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#TenantDatabaseNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies an existing tenant database in a DB instance. You can change the tenant\n database name or the master user password. This operation is supported only for RDS for\n Oracle CDB instances using the multi-tenant configuration.

" + } + }, + "com.amazonaws.rds#ModifyTenantDatabaseMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier of the DB instance that contains the tenant database that you are\n modifying. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DB instance.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "TenantDBName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The user-supplied name of the tenant database that you want to modify. This parameter\n isn’t case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing tenant database.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "MasterUserPassword": { + "target": "com.amazonaws.rds#SensitiveString", + "traits": { + "smithy.api#documentation": "

The new password for the master user of the specified tenant database in your DB\n instance.

\n \n

Amazon RDS operations never return the password, so this action provides a way to regain\n access to a tenant database user if the password is lost. This includes restoring\n privileges that might have been accidentally revoked.

\n \n

Constraints:

\n
    \n
  • \n

    Can include any printable ASCII character except /, \" (double\n quote), @, & (ampersand), and '\n (single quote).

    \n
    • \n
\n

Length constraints:

\n
    \n
  • \n

    Must contain between 8 and 30 characters.

    \n
    • \n
" + } + }, + "NewTenantDBName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The new name of the tenant database when renaming a tenant database. This parameter\n isn’t case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Can't be the string null or any other reserved word.

    \n
    • \n
  • \n

    Can't be longer than 8 characters.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ModifyTenantDatabaseResult": { + "type": "structure", + "members": { + "TenantDatabase": { + "target": "com.amazonaws.rds#TenantDatabase" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#NetworkTypeNotSupported": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "NetworkTypeNotSupported", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The network type is invalid for the DB instance. Valid nework type values are IPV4 and DUAL.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#Option": { + "type": "structure", + "members": { + "OptionName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the option.

" + } + }, + "OptionDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The description of the option.

" + } + }, + "Persistent": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether this option is persistent.

" + } + }, + "Permanent": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether this option is permanent.

" + } + }, + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

If required, the port configured for this option to use.

" + } + }, + "OptionVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version of the option.

" + } + }, + "OptionSettings": { + "target": "com.amazonaws.rds#OptionSettingConfigurationList", + "traits": { + "smithy.api#documentation": "

The option settings for this option.

" + } + }, + "DBSecurityGroupMemberships": { + "target": "com.amazonaws.rds#DBSecurityGroupMembershipList", + "traits": { + "smithy.api#documentation": "

If the option requires access to a port, then this DB security group allows access to the port.

" + } + }, + "VpcSecurityGroupMemberships": { + "target": "com.amazonaws.rds#VpcSecurityGroupMembershipList", + "traits": { + "smithy.api#documentation": "

If the option requires access to a port, then this VPC security group allows access to the port.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The details of an option.

" + } + }, + "com.amazonaws.rds#OptionConfiguration": { + "type": "structure", + "members": { + "OptionName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The configuration of options to include in a group.

", + "smithy.api#required": {} + } + }, + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The optional port for the option.

" + } + }, + "OptionVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version for the option.

" + } + }, + "DBSecurityGroupMemberships": { + "target": "com.amazonaws.rds#DBSecurityGroupNameList", + "traits": { + "smithy.api#documentation": "

A list of DB security groups used for this option.

" + } + }, + "VpcSecurityGroupMemberships": { + "target": "com.amazonaws.rds#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of VPC security group names used for this option.

" + } + }, + "OptionSettings": { + "target": "com.amazonaws.rds#OptionSettingsList", + "traits": { + "smithy.api#documentation": "

The option settings to include in an option group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of all available options for an option group.

" + } + }, + "com.amazonaws.rds#OptionConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#OptionConfiguration", + "traits": { + "smithy.api#xmlName": "OptionConfiguration" + } + } + }, + "com.amazonaws.rds#OptionGroup": { + "type": "structure", + "members": { + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the option group.

" + } + }, + "OptionGroupDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides a description of the option group.

" + } + }, + "EngineName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Indicates the name of the engine that this option group can be applied to.

" + } + }, + "MajorEngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Indicates the major engine version associated with this option group.

" + } + }, + "Options": { + "target": "com.amazonaws.rds#OptionsList", + "traits": { + "smithy.api#documentation": "

Indicates what options are available in the option group.

" + } + }, + "AllowsVpcAndNonVpcInstanceMemberships": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether this option group can be applied to both VPC \n and non-VPC instances. The value true indicates the option group \n can be applied to both VPC and non-VPC instances.

" + } + }, + "VpcId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank.\n If AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, \n then this option group can be applied to both VPC and non-VPC instances.\n If this field contains a value, then this option group can only be \n applied to instances that are in the VPC indicated by this field.

" + } + }, + "OptionGroupArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the Amazon Resource Name (ARN) for the option group.

" + } + }, + "SourceOptionGroup": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the option group from which this option group is copied.

" + } + }, + "SourceAccountId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the Amazon Web Services account ID for the option group from which this option group is copied.

" + } + }, + "CopyTimestamp": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

Indicates when the option group was copied.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#OptionGroupAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "OptionGroupAlreadyExistsFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The option group you are trying to create already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#OptionGroupMembership": { + "type": "structure", + "members": { + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the option group that the instance belongs to.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The status of the DB instance's option group membership. Valid values are: \n in-sync, \n pending-apply, \n pending-removal, \n pending-maintenance-apply, \n pending-maintenance-removal, \n applying, \n removing, \n and failed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information on the option groups the DB instance is a member of.

" + } + }, + "com.amazonaws.rds#OptionGroupMembershipList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#OptionGroupMembership", + "traits": { + "smithy.api#xmlName": "OptionGroupMembership" + } + } + }, + "com.amazonaws.rds#OptionGroupNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "OptionGroupNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified option group could not be found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#OptionGroupOption": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the option.

" + } + }, + "Description": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The description of the option.

" + } + }, + "EngineName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the engine that this option can be applied to.

" + } + }, + "MajorEngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Indicates the major engine version that the option is available for.

" + } + }, + "MinimumRequiredMinorEngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The minimum required engine version for the option to be applied.

" + } + }, + "PortRequired": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the option requires a port.

" + } + }, + "DefaultPort": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

If the option requires a port, specifies the default port for the option.

" + } + }, + "OptionsDependedOn": { + "target": "com.amazonaws.rds#OptionsDependedOn", + "traits": { + "smithy.api#documentation": "

The options that are prerequisites for this option.

" + } + }, + "OptionsConflictsWith": { + "target": "com.amazonaws.rds#OptionsConflictsWith", + "traits": { + "smithy.api#documentation": "

The options that conflict with this option.

" + } + }, + "Persistent": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Persistent options can't be removed from an option group while DB instances are associated with the option group. If you disassociate all DB instances from the option group, your can remove the persistent option from the option group.

" + } + }, + "Permanent": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Permanent options can never be removed from an option group. An option group containing a permanent option can't be removed from a DB instance.

" + } + }, + "RequiresAutoMinorEngineVersionUpgrade": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

If true, you must enable the Auto Minor Version Upgrade setting for your DB instance \n before you can use this option.\n You can enable Auto Minor Version Upgrade when you first create your DB instance,\n or by modifying your DB instance later.

" + } + }, + "VpcOnly": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

If true, you can only use this option with a DB instance that is in a VPC.

" + } + }, + "SupportsOptionVersionDowngrade": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

If true, you can change the option to an earlier version of the option. \n This only applies to options that have different versions available.

" + } + }, + "OptionGroupOptionSettings": { + "target": "com.amazonaws.rds#OptionGroupOptionSettingsList", + "traits": { + "smithy.api#documentation": "

The option settings that are available (and the default value) for each option in an option group.

" + } + }, + "OptionGroupOptionVersions": { + "target": "com.amazonaws.rds#OptionGroupOptionVersionsList", + "traits": { + "smithy.api#documentation": "

The versions that are available for the option.

" + } + }, + "CopyableCrossAccount": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether the option can be copied across Amazon Web Services accounts.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Available option.

" + } + }, + "com.amazonaws.rds#OptionGroupOptionSetting": { + "type": "structure", + "members": { + "SettingName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the option group option.

" + } + }, + "SettingDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The description of the option group option.

" + } + }, + "DefaultValue": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The default value for the option group option.

" + } + }, + "ApplyType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB engine specific parameter type for the option group option.

" + } + }, + "AllowedValues": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Indicates the acceptable values for the option group option.

" + } + }, + "IsModifiable": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether this option group option can be changed from the default value.

" + } + }, + "IsRequired": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether a value must be specified for this option setting of the option group option.

" + } + }, + "MinimumEngineVersionPerAllowedValue": { + "target": "com.amazonaws.rds#MinimumEngineVersionPerAllowedValueList", + "traits": { + "smithy.api#documentation": "

The minimum DB engine version required for the corresponding allowed value for this option setting.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Option group option settings are used to display settings available for each option with their default values and other information. These values are used with the DescribeOptionGroupOptions action.

" + } + }, + "com.amazonaws.rds#OptionGroupOptionSettingsList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#OptionGroupOptionSetting", + "traits": { + "smithy.api#xmlName": "OptionGroupOptionSetting" + } + } + }, + "com.amazonaws.rds#OptionGroupOptionVersionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#OptionVersion", + "traits": { + "smithy.api#xmlName": "OptionVersion" + } + } + }, + "com.amazonaws.rds#OptionGroupOptionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#OptionGroupOption", + "traits": { + "smithy.api#xmlName": "OptionGroupOption" + } + }, + "traits": { + "smithy.api#documentation": "

List of available option group options.

" + } + }, + "com.amazonaws.rds#OptionGroupOptionsMessage": { + "type": "structure", + "members": { + "OptionGroupOptions": { + "target": "com.amazonaws.rds#OptionGroupOptionsList" + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#OptionGroupQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "OptionGroupQuotaExceededFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The quota of 20 option groups was exceeded for this Amazon Web Services account.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#OptionGroups": { + "type": "structure", + "members": { + "OptionGroupsList": { + "target": "com.amazonaws.rds#OptionGroupsList", + "traits": { + "smithy.api#documentation": "

List of option groups.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

List of option groups.

" + } + }, + "com.amazonaws.rds#OptionGroupsList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#OptionGroup", + "traits": { + "smithy.api#xmlName": "OptionGroup" + } + } + }, + "com.amazonaws.rds#OptionNamesList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String" + } + }, + "com.amazonaws.rds#OptionSetting": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the option that has settings that you can set.

" + } + }, + "Value": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The current value of the option setting.

" + } + }, + "DefaultValue": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The default value of the option setting.

" + } + }, + "Description": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The description of the option setting.

" + } + }, + "ApplyType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB engine specific parameter type.

" + } + }, + "DataType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The data type of the option setting.

" + } + }, + "AllowedValues": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The allowed values of the option setting.

" + } + }, + "IsModifiable": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the option setting can be modified from the default.

" + } + }, + "IsCollection": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the option setting is part of a collection.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Option settings are the actual settings being applied or configured for that option. It is used when you modify an option group or describe option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting called SQLNET.ENCRYPTION_SERVER that can have several different values.

" + } + }, + "com.amazonaws.rds#OptionSettingConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#OptionSetting", + "traits": { + "smithy.api#xmlName": "OptionSetting" + } + } + }, + "com.amazonaws.rds#OptionSettingsList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#OptionSetting", + "traits": { + "smithy.api#xmlName": "OptionSetting" + } + } + }, + "com.amazonaws.rds#OptionVersion": { + "type": "structure", + "members": { + "Version": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version of the option.

" + } + }, + "IsDefault": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the version is the default version of the option.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The version for an option. Option group option versions are returned by \n the DescribeOptionGroupOptions action.

" + } + }, + "com.amazonaws.rds#OptionsConflictsWith": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#xmlName": "OptionConflictName" + } + } + }, + "com.amazonaws.rds#OptionsDependedOn": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#xmlName": "OptionName" + } + } + }, + "com.amazonaws.rds#OptionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#Option", + "traits": { + "smithy.api#xmlName": "Option" + } + } + }, + "com.amazonaws.rds#OrderableDBInstanceOption": { + "type": "structure", + "members": { + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The engine type of a DB instance.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The engine version of a DB instance.

" + } + }, + "DBInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB instance class for a DB instance.

" + } + }, + "LicenseModel": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The license model for a DB instance.

" + } + }, + "AvailabilityZoneGroup": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone group for a DB instance.

" + } + }, + "AvailabilityZones": { + "target": "com.amazonaws.rds#AvailabilityZoneList", + "traits": { + "smithy.api#documentation": "

A list of Availability Zones for a DB instance.

" + } + }, + "MultiAZCapable": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether a DB instance is Multi-AZ capable.

" + } + }, + "ReadReplicaCapable": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether a DB instance can have a read replica.

" + } + }, + "Vpc": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether a DB instance is in a VPC.

" + } + }, + "SupportsStorageEncryption": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether a DB instance supports encrypted storage.

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The storage type for a DB instance.

" + } + }, + "SupportsIops": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether a DB instance supports provisioned IOPS.

" + } + }, + "SupportsEnhancedMonitoring": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.

" + } + }, + "SupportsIAMDatabaseAuthentication": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether a DB instance supports IAM database authentication.

" + } + }, + "SupportsPerformanceInsights": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether a DB instance supports Performance Insights.

" + } + }, + "MinStorageSize": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Minimum storage size for a DB instance.

" + } + }, + "MaxStorageSize": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Maximum storage size for a DB instance.

" + } + }, + "MinIopsPerDbInstance": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Minimum total provisioned IOPS for a DB instance.

" + } + }, + "MaxIopsPerDbInstance": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Maximum total provisioned IOPS for a DB instance.

" + } + }, + "MinIopsPerGib": { + "target": "com.amazonaws.rds#DoubleOptional", + "traits": { + "smithy.api#documentation": "

Minimum provisioned IOPS per GiB for a DB instance.

" + } + }, + "MaxIopsPerGib": { + "target": "com.amazonaws.rds#DoubleOptional", + "traits": { + "smithy.api#documentation": "

Maximum provisioned IOPS per GiB for a DB instance.

" + } + }, + "AvailableProcessorFeatures": { + "target": "com.amazonaws.rds#AvailableProcessorFeatureList", + "traits": { + "smithy.api#documentation": "

A list of the available processor features for the DB instance class of a DB instance.

" + } + }, + "SupportedEngineModes": { + "target": "com.amazonaws.rds#EngineModeList", + "traits": { + "smithy.api#documentation": "

A list of the supported DB engine modes.

" + } + }, + "SupportsStorageAutoscaling": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.

" + } + }, + "SupportsKerberosAuthentication": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether a DB instance supports Kerberos Authentication.

" + } + }, + "OutpostCapable": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether a DB instance supports RDS on Outposts.

\n

For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.\n

" + } + }, + "SupportedActivityStreamModes": { + "target": "com.amazonaws.rds#ActivityStreamModeList", + "traits": { + "smithy.api#documentation": "

The list of supported modes for Database Activity Streams. Aurora PostgreSQL returns the value [sync,\n async]. Aurora MySQL and RDS for Oracle return [async] only. If Database Activity Streams \n isn't supported, the return value is an empty list.

" + } + }, + "SupportsGlobalDatabases": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.

" + } + }, + "SupportsClusters": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether DB instances can be configured as a Multi-AZ DB cluster.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" + } + }, + "SupportedNetworkTypes": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The network types supported by the DB instance (IPV4 or DUAL).

\n

A DB instance can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" + } + }, + "SupportsStorageThroughput": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether a DB instance supports storage throughput.

" + } + }, + "MinStorageThroughputPerDbInstance": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Minimum storage throughput for a DB instance.

" + } + }, + "MaxStorageThroughputPerDbInstance": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Maximum storage throughput for a DB instance.

" + } + }, + "MinStorageThroughputPerIops": { + "target": "com.amazonaws.rds#DoubleOptional", + "traits": { + "smithy.api#documentation": "

Minimum storage throughput to provisioned IOPS ratio for a DB instance.

" + } + }, + "MaxStorageThroughputPerIops": { + "target": "com.amazonaws.rds#DoubleOptional", + "traits": { + "smithy.api#documentation": "

Maximum storage throughput to provisioned IOPS ratio for a DB instance.

" + } + }, + "SupportsDedicatedLogVolume": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether a DB instance supports using a dedicated log volume (DLV).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains a list of available options for a DB instance.

\n

This data type is used as a response element in the DescribeOrderableDBInstanceOptions action.

" + } + }, + "com.amazonaws.rds#OrderableDBInstanceOptionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#OrderableDBInstanceOption", + "traits": { + "smithy.api#xmlName": "OrderableDBInstanceOption" + } + } + }, + "com.amazonaws.rds#OrderableDBInstanceOptionsMessage": { + "type": "structure", + "members": { + "OrderableDBInstanceOptions": { + "target": "com.amazonaws.rds#OrderableDBInstanceOptionsList", + "traits": { + "smithy.api#documentation": "

An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous \n OrderableDBInstanceOptions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#Outpost": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A data type that represents an Outpost.

\n

For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.\n

" + } + }, + "com.amazonaws.rds#Parameter": { + "type": "structure", + "members": { + "ParameterName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the parameter.

" + } + }, + "ParameterValue": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The value of the parameter.

" + } + }, + "Description": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides a description of the parameter.

" + } + }, + "Source": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The source of the parameter value.

" + } + }, + "ApplyType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the engine specific parameters type.

" + } + }, + "DataType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the valid data type for the parameter.

" + } + }, + "AllowedValues": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the valid range of values for the parameter.

" + } + }, + "IsModifiable": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether (true) or not (false) the parameter can be modified.\n Some parameters have security or operational implications\n that prevent them from being changed.

" + } + }, + "MinimumEngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The earliest engine version to which the parameter can apply.

" + } + }, + "ApplyMethod": { + "target": "com.amazonaws.rds#ApplyMethod", + "traits": { + "smithy.api#documentation": "

Indicates when to apply parameter updates.

" + } + }, + "SupportedEngineModes": { + "target": "com.amazonaws.rds#EngineModeList", + "traits": { + "smithy.api#documentation": "

The valid DB engine modes.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a request parameter in the\n ModifyDBParameterGroup and ResetDBParameterGroup actions.

\n

This data type is used as a response element in the \n DescribeEngineDefaultParameters and DescribeDBParameters actions.

" + } + }, + "com.amazonaws.rds#ParametersList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#Parameter", + "traits": { + "smithy.api#xmlName": "Parameter" + } + } + }, + "com.amazonaws.rds#PendingCloudwatchLogsExports": { + "type": "structure", + "members": { + "LogTypesToEnable": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.

" + } + }, + "LogTypesToDisable": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.

" + } + }, + "com.amazonaws.rds#PendingMaintenanceAction": { + "type": "structure", + "members": { + "Action": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The type of pending maintenance action that is available for the resource.

\n

For more information about maintenance actions, see Maintaining a DB instance.

\n

Valid Values:

\n
    \n
  • \n

    \n ca-certificate-rotation\n

    \n
    • \n
  • \n

    \n db-upgrade\n

    \n
    • \n
  • \n

    \n hardware-maintenance\n

    \n
    • \n
  • \n

    \n os-upgrade\n

    \n
    • \n
  • \n

    \n system-update\n

    \n
    • \n
\n

For more information about these actions, see \n Maintenance actions for Amazon Aurora or \n Maintenance actions for Amazon RDS.

" + } + }, + "AutoAppliedAfterDate": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The date of the maintenance window when the action is applied.\n The maintenance action is applied to the resource during\n its first maintenance window after this date.

" + } + }, + "ForcedApplyDate": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The date when the maintenance action is automatically applied.

\n

On this date, the maintenance action is applied to the resource as soon as possible, \n regardless of the maintenance window for the resource. There might be a delay of \n one or more days from this date before the maintenance action is applied.

" + } + }, + "OptInStatus": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Indicates the type of opt-in request that has been received for the resource.

" + } + }, + "CurrentApplyDate": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The effective date when the pending maintenance action is applied \n to the resource. This date takes into account opt-in requests received from\n the ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate,\n and the ForcedApplyDate. This value is blank if an \n opt-in request has not been received and nothing has been specified as\n AutoAppliedAfterDate or ForcedApplyDate.

" + } + }, + "Description": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A description providing more detail about the maintenance action.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about a pending maintenance action for a resource.

" + } + }, + "com.amazonaws.rds#PendingMaintenanceActionDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#PendingMaintenanceAction", + "traits": { + "smithy.api#xmlName": "PendingMaintenanceAction" + } + } + }, + "com.amazonaws.rds#PendingMaintenanceActions": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#ResourcePendingMaintenanceActions", + "traits": { + "smithy.api#xmlName": "ResourcePendingMaintenanceActions" + } + } + }, + "com.amazonaws.rds#PendingMaintenanceActionsMessage": { + "type": "structure", + "members": { + "PendingMaintenanceActions": { + "target": "com.amazonaws.rds#PendingMaintenanceActions", + "traits": { + "smithy.api#documentation": "

A list of the pending maintenance actions for the resource.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribePendingMaintenanceActions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to a number of records specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Data returned from the DescribePendingMaintenanceActions action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#PendingModifiedValues": { + "type": "structure", + "members": { + "DBInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the compute and memory capacity class for the DB instance.

" + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The allocated storage size for the DB instance specified in gibibytes (GiB).

" + } + }, + "MasterUserPassword": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The master credentials for the DB instance.

" + } + }, + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port for the DB instance.

" + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days for which automated backups are retained.

" + } + }, + "MultiAZ": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether the Single-AZ DB instance will change to a Multi-AZ deployment.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The database engine version.

" + } + }, + "LicenseModel": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The license model for the DB instance.

\n

Valid values: license-included | bring-your-own-license | \n general-public-license\n

" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The Provisioned IOPS value for the DB instance.

" + } + }, + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The database identifier for the DB instance.

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The storage type of the DB instance.

" + } + }, + "CACertificateIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the CA certificate for the DB instance.

\n

For more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.

" + } + }, + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB subnet group for the DB instance.

" + } + }, + "PendingCloudwatchLogsExports": { + "target": "com.amazonaws.rds#PendingCloudwatchLogsExports" + }, + "ProcessorFeatures": { + "target": "com.amazonaws.rds#ProcessorFeatureList", + "traits": { + "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class\n of the DB instance.

" + } + }, + "IAMDatabaseAuthenticationEnabled": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

" + } + }, + "AutomationMode": { + "target": "com.amazonaws.rds#AutomationMode", + "traits": { + "smithy.api#documentation": "

The automation mode of the RDS Custom DB instance: full or all-paused. \n If full, the DB instance automates monitoring and instance recovery. If \n all-paused, the instance pauses automation for the duration set by \n --resume-full-automation-mode-minutes.

" + } + }, + "ResumeFullAutomationModeTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. \n The minimum value is 60 (default). The maximum value is 1,440.

" + } + }, + "StorageThroughput": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The storage throughput of the DB instance.

" + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The database engine of the DB instance.

" + } + }, + "DedicatedLogVolume": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether the DB instance has a dedicated log volume (DLV) enabled.>

" + } + }, + "MultiTenant": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether the DB instance will change to the multi-tenant configuration (TRUE)\n or the single-tenant configuration (FALSE).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a response element in the ModifyDBInstance operation and \n contains changes that will be applied during the next maintenance window.

" + } + }, + "com.amazonaws.rds#PerformanceInsightsMetricDimensionGroup": { + "type": "structure", + "members": { + "Dimensions": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

A list of specific dimensions from a dimension group. If this list isn't included, then all of the dimensions in the group were requested, or are present in the response.

" + } + }, + "Group": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The available dimension groups for Performance Insights metric type.

" + } + }, + "Limit": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of items to fetch for this dimension group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A logical grouping of Performance Insights metrics for a related subject area. For example, the db.sql dimension group consists of the following dimensions:

\n
    \n
  • \n

    \n db.sql.id - The hash of a running SQL statement, generated by Performance Insights.

    \n
    • \n
  • \n

    \n db.sql.db_id - Either the SQL ID generated by the database engine, or a value generated by Performance Insights that begins with pi-.

    \n
    • \n
  • \n

    \n db.sql.statement - The full text of the SQL statement that is running, for example, SELECT * FROM employees.

    \n
    • \n
  • \n

    \n db.sql_tokenized.id - The hash of the SQL digest generated by Performance Insights.

    \n
    • \n
\n \n

Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.

\n " + } + }, + "com.amazonaws.rds#PerformanceInsightsMetricQuery": { + "type": "structure", + "members": { + "GroupBy": { + "target": "com.amazonaws.rds#PerformanceInsightsMetricDimensionGroup", + "traits": { + "smithy.api#documentation": "

A specification for how to aggregate the data points from a query result. You must\n specify a valid dimension group. Performance Insights will return all of the dimensions within that group,\n unless you provide the names of specific dimensions within that group. You can also request\n that Performance Insights return a limited number of values for a dimension.

" + } + }, + "Metric": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of a Performance Insights metric to be measured.

\n

Valid Values:

\n
    \n
  • \n

    \n db.load.avg - A scaled representation of the number of active sessions for the \n database engine.

    \n
    • \n
  • \n

    \n db.sampledload.avg - The raw number of active sessions for the database engine.

    \n
    • \n
  • \n

    The counter metrics listed in Performance Insights\n operating system counters in the Amazon Aurora User Guide.

    \n
    • \n
\n

If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg \n and db.sampledload.avg are the same value. If the number of active sessions is greater than the \n internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the\n scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than\n db.load.avg. For most use cases, you can query db.load.avg only.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A single Performance Insights metric query to process. You must provide the metric to the query. \n If other parameters aren't specified, Performance Insights returns all data points for the \n specified metric. Optionally, you can request the data points to be aggregated by dimension \n group (GroupBy) and return only those data points that match your criteria (Filter).

\n

Constraints:

\n
    \n
  • \n

    Must be a valid Performance Insights query.

    \n
    • \n
" + } + }, + "com.amazonaws.rds#PerformanceIssueDetails": { + "type": "structure", + "members": { + "StartTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The time when the performance issue started.

" + } + }, + "EndTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The time when the performance issue stopped.

" + } + }, + "Metrics": { + "target": "com.amazonaws.rds#MetricList", + "traits": { + "smithy.api#documentation": "

The metrics that are relevant to the performance issue.

" + } + }, + "Analysis": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The analysis of the performance issue. The information might contain markdown.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details of the performance issue.

" + } + }, + "com.amazonaws.rds#PointInTimeRestoreNotEnabledFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "PointInTimeRestoreNotEnabled", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

\n SourceDBInstanceIdentifier\n refers to a DB instance with\n BackupRetentionPeriod equal to 0.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#ProcessorFeature": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the processor feature. Valid names are coreCount and threadsPerCore.

" + } + }, + "Value": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The value of a processor feature.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the processor features of a DB instance class.

\n

To specify the number of CPU cores, use the coreCount feature name \n for the Name parameter. To specify the number of threads per core, use the\n threadsPerCore feature name for the Name parameter.

\n

You can set the processor features of the DB instance class for a DB instance when you\n call one of the following actions:

\n
    \n
  • \n

    \n CreateDBInstance\n

    \n
    • \n
  • \n

    \n ModifyDBInstance\n

    \n
    • \n
  • \n

    \n RestoreDBInstanceFromDBSnapshot\n

    \n
    • \n
  • \n

    \n RestoreDBInstanceFromS3\n

    \n
    • \n
  • \n

    \n RestoreDBInstanceToPointInTime\n

    \n
    • \n
\n

You can view the valid processor values for a particular instance class by calling the\n DescribeOrderableDBInstanceOptions action and specifying the\n instance class for the DBInstanceClass parameter.

\n

In addition, you can use the following actions for DB instance class processor information:

\n
    \n
  • \n

    \n DescribeDBInstances\n

    \n
    • \n
  • \n

    \n DescribeDBSnapshots\n

    \n
    • \n
  • \n

    \n DescribeValidDBInstanceModifications\n

    \n
    • \n
\n

If you call DescribeDBInstances, ProcessorFeature returns\n non-null values only if the following conditions are met:

\n
    \n
  • \n

    You are accessing an Oracle DB instance.

    \n
    • \n
  • \n

    Your Oracle DB instance class supports configuring the number of CPU cores and threads per core.

    \n
    • \n
  • \n

    The current number CPU cores and threads is set to a non-default value.

    \n
    • \n
\n

For more information, see \n Configuring the processor for a DB instance class in RDS for Oracle in the Amazon RDS User Guide.\n \n

" + } + }, + "com.amazonaws.rds#ProcessorFeatureList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#ProcessorFeature", + "traits": { + "smithy.api#xmlName": "ProcessorFeature" + } + } + }, + "com.amazonaws.rds#PromoteReadReplica": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#PromoteReadReplicaMessage" + }, + "output": { + "target": "com.amazonaws.rds#PromoteReadReplicaResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Promotes a read replica DB instance to a standalone DB instance.

\n \n
    \n
  • \n

    Backup duration is a function of the amount of changes to the database since the previous\n backup. If you plan to promote a read replica to a standalone instance, we\n recommend that you enable backups and complete at least one backup prior to\n promotion. In addition, a read replica cannot be promoted to a standalone\n instance when it is in the backing-up status. If you have\n enabled backups on your read replica, configure the automated backup window\n so that daily backups do not interfere with read replica\n promotion.

    \n
    • \n
  • \n

    This command doesn't apply to Aurora MySQL, Aurora PostgreSQL, or RDS Custom.

    \n
    • \n
\n ", + "smithy.api#examples": [ + { + "title": "To promote a read replica", + "documentation": "The following example promotes the specified read replica to become a standalone DB instance.", + "input": { + "DBInstanceIdentifier": "test-instance-repl" + }, + "output": { + "DBInstance": { + "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:test-instance-repl", + "StorageType": "standard", + "ReadReplicaSourceDBInstanceIdentifier": "test-instance", + "DBInstanceStatus": "modifying" + } + } + } + ] + } + }, + "com.amazonaws.rds#PromoteReadReplicaDBCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#PromoteReadReplicaDBClusterMessage" + }, + "output": { + "target": "com.amazonaws.rds#PromoteReadReplicaDBClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Promotes a read replica DB cluster to a standalone DB cluster.

" + } + }, + "com.amazonaws.rds#PromoteReadReplicaDBClusterMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier of the DB cluster read replica to promote. This parameter isn't\n case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DB cluster read replica.

    \n
    • \n
\n

Example: my-cluster-replica1\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#PromoteReadReplicaDBClusterResult": { + "type": "structure", + "members": { + "DBCluster": { + "target": "com.amazonaws.rds#DBCluster" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#PromoteReadReplicaMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The DB instance identifier. This value is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing read replica DB instance.

    \n
    • \n
\n

Example: mydbinstance\n

", + "smithy.api#required": {} + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

\n

Default: 1

\n

Constraints:

\n
    \n
  • \n

    Must be a value from 0 to 35.

    \n
    • \n
  • \n

    Can't be set to 0 if the DB instance is a source to read replicas.

    \n
    • \n
" + } + }, + "PreferredBackupWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To see the time blocks available, see \n \n Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.\n

\n

Constraints:

\n
    \n
  • \n

    Must be in the format hh24:mi-hh24:mi.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must not conflict with the preferred maintenance window.

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#PromoteReadReplicaResult": { + "type": "structure", + "members": { + "DBInstance": { + "target": "com.amazonaws.rds#DBInstance" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#ProvisionedIopsNotAvailableInAZFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ProvisionedIopsNotAvailableInAZFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Provisioned IOPS not available in the specified Availability Zone.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#PurchaseReservedDBInstancesOffering": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#PurchaseReservedDBInstancesOfferingMessage" + }, + "output": { + "target": "com.amazonaws.rds#PurchaseReservedDBInstancesOfferingResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#ReservedDBInstanceAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#ReservedDBInstanceQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#ReservedDBInstancesOfferingNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Purchases a reserved DB instance offering.

", + "smithy.api#examples": [ + { + "title": "To purchase a reserved DB instance", + "documentation": "The following example shows how to buy the reserved DB instance offering from the previous example.", + "input": { + "ReservedDBInstancesOfferingId": "", + "ReservedDBInstanceId": "8ba30be1-b9ec-447f-8f23-6114e3f4c7b4" + }, + "output": { + "ReservedDBInstance": { + "ReservedDBInstanceId": "ri-2020-06-29-16-54-57-670", + "ReservedDBInstancesOfferingId": "8ba30be1-b9ec-447f-8f23-6114e3f4c7b4", + "DBInstanceClass": "db.t2.micro", + "StartTime": "2020-06-29T16:54:57.670Z", + "Duration": 31536000, + "FixedPrice": 51, + "UsagePrice": 0, + "CurrencyCode": "USD", + "DBInstanceCount": 1, + "ProductDescription": "mysql", + "OfferingType": "Partial Upfront", + "MultiAZ": false, + "State": "payment-pending", + "RecurringCharges": [ + { + "RecurringChargeAmount": 0.006, + "RecurringChargeFrequency": "Hourly" + } + ], + "ReservedDBInstanceArn": "arn:aws:rds:us-west-2:123456789012:ri:ri-2020-06-29-16-54-57-670" + } + } + } + ] + } + }, + "com.amazonaws.rds#PurchaseReservedDBInstancesOfferingMessage": { + "type": "structure", + "members": { + "ReservedDBInstancesOfferingId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Reserved DB instance offering to purchase.

\n

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

", + "smithy.api#required": {} + } + }, + "ReservedDBInstanceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Customer-specified identifier to track this reservation.

\n

Example: myreservationID

" + } + }, + "DBInstanceCount": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of instances to reserve.

\n

Default: 1\n

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#PurchaseReservedDBInstancesOfferingResult": { + "type": "structure", + "members": { + "ReservedDBInstance": { + "target": "com.amazonaws.rds#ReservedDBInstance" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#Range": { + "type": "structure", + "members": { + "From": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#documentation": "

The minimum value in the range.

" + } + }, + "To": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#documentation": "

The maximum value in the range.

" + } + }, + "Step": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The step value for the range.\n For example, if you have a range of 5,000 to 10,000,\n with a step value of 1,000,\n the valid values start at 5,000 and step up by 1,000.\n Even though 7,500 is within the range,\n it isn't a valid value for the range.\n The valid values are 5,000, 6,000, 7,000, 8,000...

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A range of integer values.

" + } + }, + "com.amazonaws.rds#RangeList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#Range", + "traits": { + "smithy.api#xmlName": "Range" + } + } + }, + "com.amazonaws.rds#RdsCustomClusterConfiguration": { + "type": "structure", + "members": { + "InterconnectSubnetId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

" + } + }, + "TransitGatewayMulticastDomainId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

" + } + }, + "ReplicaMode": { + "target": "com.amazonaws.rds#ReplicaMode", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Reserved for future use.

" + } + }, + "com.amazonaws.rds#ReadReplicaDBClusterIdentifierList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#xmlName": "ReadReplicaDBClusterIdentifier" + } + } + }, + "com.amazonaws.rds#ReadReplicaDBInstanceIdentifierList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#xmlName": "ReadReplicaDBInstanceIdentifier" + } + } + }, + "com.amazonaws.rds#ReadReplicaIdentifierList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#xmlName": "ReadReplicaIdentifier" + } + } + }, + "com.amazonaws.rds#ReadersArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String" + } + }, + "com.amazonaws.rds#RebootDBCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#RebootDBClusterMessage" + }, + "output": { + "target": "com.amazonaws.rds#RebootDBClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

You might need to reboot your DB cluster, usually for maintenance reasons. \n For example, if you make certain modifications, \n or if you change the DB cluster parameter group associated with the DB cluster, \n reboot the DB cluster for the changes to take effect.

\n

Rebooting a DB cluster restarts the database engine service. Rebooting a DB \n cluster results in a momentary outage, during which the DB cluster status is set to rebooting.

\n

Use this operation only for a non-Aurora Multi-AZ DB cluster.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n

" + } + }, + "com.amazonaws.rds#RebootDBClusterMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The DB cluster identifier. This parameter is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DBCluster.

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#RebootDBClusterResult": { + "type": "structure", + "members": { + "DBCluster": { + "target": "com.amazonaws.rds#DBCluster" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#RebootDBInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#RebootDBInstanceMessage" + }, + "output": { + "target": "com.amazonaws.rds#RebootDBInstanceResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

You might need to reboot your DB instance, usually for maintenance reasons. \n For example, if you make certain modifications, \n or if you change the DB parameter group associated with the DB instance, \n you must reboot the instance for the changes to take effect.

\n

Rebooting a DB instance restarts the database engine service. \n Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.

\n

For more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide.\n

\n

This command doesn't apply to RDS Custom.

\n

If your DB instance is part of a Multi-AZ DB cluster, you can reboot the DB cluster with the RebootDBCluster operation.

", + "smithy.api#examples": [ + { + "title": "To reboot a DB instance", + "documentation": "The following example starts a reboot of the specified DB instance.", + "input": { + "DBInstanceIdentifier": "test-mysql-instance" + }, + "output": { + "DBInstance": { + "DBInstanceIdentifier": "test-mysql-instance", + "DBInstanceClass": "db.t3.micro", + "Engine": "mysql", + "DBInstanceStatus": "rebooting", + "MasterUsername": "admin", + "Endpoint": { + "Address": "test-mysql-instance.############.us-west-2.rds.amazonaws.com", + "Port": 3306, + "HostedZoneId": "Z1PVIF0EXAMPLE" + } + } + } + } + ] + } + }, + "com.amazonaws.rds#RebootDBInstanceMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The DB instance identifier. This parameter is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DBInstance.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "ForceFailover": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the reboot is conducted through a Multi-AZ failover.

\n

Constraint: You can't enable force failover if the instance isn't configured for Multi-AZ.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#RebootDBInstanceResult": { + "type": "structure", + "members": { + "DBInstance": { + "target": "com.amazonaws.rds#DBInstance" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#RebootDBShardGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#RebootDBShardGroupMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBShardGroup" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBShardGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBShardGroupStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

You might need to reboot your DB shard group, usually for maintenance reasons. For example, if you make certain modifications, reboot \n the DB shard group for the changes to take effect.

\n

This operation applies only to Aurora Limitless Database DBb shard groups.

" + } + }, + "com.amazonaws.rds#RebootDBShardGroupMessage": { + "type": "structure", + "members": { + "DBShardGroupIdentifier": { + "target": "com.amazonaws.rds#DBShardGroupIdentifier", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the DB shard group to reboot.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#RecommendedAction": { + "type": "structure", + "members": { + "ActionId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The unique identifier of the recommended action.

" + } + }, + "Title": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A short description to summarize the action. The description might contain markdown.

" + } + }, + "Description": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A detailed description of the action. The description might contain markdown.

" + } + }, + "Operation": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An API operation for the action.

" + } + }, + "Parameters": { + "target": "com.amazonaws.rds#RecommendedActionParameterList", + "traits": { + "smithy.api#documentation": "

The parameters for the API operation.

" + } + }, + "ApplyModes": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The methods to apply the recommended action.

\n

Valid values:

\n
    \n
  • \n

    \n manual - The action requires you to resolve the recommendation manually.

    \n
    • \n
  • \n

    \n immediately - The action is applied immediately.

    \n
    • \n
  • \n

    \n next-maintainance-window - The action is applied during the next scheduled maintainance.

    \n
    • \n
" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The status of the action.

\n
    \n
  • \n

    \n ready\n

    \n
    • \n
  • \n

    \n applied\n

    \n
    • \n
  • \n

    \n scheduled\n

    \n
    • \n
  • \n

    \n resolved\n

    \n
    • \n
" + } + }, + "IssueDetails": { + "target": "com.amazonaws.rds#IssueDetails", + "traits": { + "smithy.api#documentation": "

The details of the issue.

" + } + }, + "ContextAttributes": { + "target": "com.amazonaws.rds#ContextAttributeList", + "traits": { + "smithy.api#documentation": "

The supporting attributes to explain the recommended action.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The recommended actions to apply to resolve the issues associated with your DB instances, DB clusters, and DB parameter groups.

" + } + }, + "com.amazonaws.rds#RecommendedActionList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#RecommendedAction" + } + }, + "com.amazonaws.rds#RecommendedActionParameter": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The key of the parameter to use with the RecommendedAction API operation.

" + } + }, + "Value": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The value of the parameter to use with the RecommendedAction API operation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A single parameter to use with the RecommendedAction API operation to apply the action.

" + } + }, + "com.amazonaws.rds#RecommendedActionParameterList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#RecommendedActionParameter" + } + }, + "com.amazonaws.rds#RecommendedActionUpdate": { + "type": "structure", + "members": { + "ActionId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A unique identifier of the updated recommendation action.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of the updated recommendation action.

\n
    \n
  • \n

    \n applied\n

    \n
    • \n
  • \n

    \n scheduled\n

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The recommended status to update for the specified recommendation action ID.

" + } + }, + "com.amazonaws.rds#RecommendedActionUpdateList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#RecommendedActionUpdate" + } + }, + "com.amazonaws.rds#RecurringCharge": { + "type": "structure", + "members": { + "RecurringChargeAmount": { + "target": "com.amazonaws.rds#Double", + "traits": { + "smithy.api#documentation": "

The amount of the recurring charge.

" + } + }, + "RecurringChargeFrequency": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The frequency of the recurring charge.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a response element in the \n DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.

" + } + }, + "com.amazonaws.rds#RecurringChargeList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#RecurringCharge", + "traits": { + "smithy.api#xmlName": "RecurringCharge" + } + } + }, + "com.amazonaws.rds#ReferenceDetails": { + "type": "structure", + "members": { + "ScalarReferenceDetails": { + "target": "com.amazonaws.rds#ScalarReferenceDetails", + "traits": { + "smithy.api#documentation": "

The metric reference details when the reference is a scalar.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The reference details of a metric.

" + } + }, + "com.amazonaws.rds#RegisterDBProxyTargets": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#RegisterDBProxyTargetsRequest" + }, + "output": { + "target": "com.amazonaws.rds#RegisterDBProxyTargetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBProxyNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBProxyTargetAlreadyRegisteredFault" + }, + { + "target": "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InsufficientAvailableIPsInSubnetFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBProxyStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Associate one or more DBProxyTarget data structures with a DBProxyTargetGroup.

" + } + }, + "com.amazonaws.rds#RegisterDBProxyTargetsRequest": { + "type": "structure", + "members": { + "DBProxyName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier of the DBProxy that is associated with the DBProxyTargetGroup.

", + "smithy.api#required": {} + } + }, + "TargetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the DBProxyTargetGroup.

" + } + }, + "DBInstanceIdentifiers": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

One or more DB instance identifiers.

" + } + }, + "DBClusterIdentifiers": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

One or more DB cluster identifiers.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#RegisterDBProxyTargetsResponse": { + "type": "structure", + "members": { + "DBProxyTargets": { + "target": "com.amazonaws.rds#TargetList", + "traits": { + "smithy.api#documentation": "

One or more DBProxyTarget objects that are created when you register targets with a target group.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#RemoveFromGlobalCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#RemoveFromGlobalClusterMessage" + }, + "output": { + "target": "com.amazonaws.rds#RemoveFromGlobalClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#GlobalClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidGlobalClusterStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a\n standalone cluster with read-write capability instead of being read-only and receiving data from a\n primary cluster in a different Region.

\n \n

This operation only applies to Aurora DB clusters.

\n ", + "smithy.api#examples": [ + { + "title": "To detach an Aurora secondary cluster from an Aurora global database cluster", + "documentation": "The following example detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster changes from being read-only to a standalone cluster with read-write capability.", + "input": { + "GlobalClusterIdentifier": "myglobalcluster", + "DbClusterIdentifier": "arn:aws:rds:us-west-2:123456789012:cluster:DB-1" + }, + "output": { + "GlobalCluster": { + "GlobalClusterIdentifier": "myglobalcluster", + "GlobalClusterResourceId": "cluster-abc123def456gh", + "GlobalClusterArn": "arn:aws:rds::123456789012:global-cluster:myglobalcluster", + "Status": "available", + "Engine": "aurora-postgresql", + "EngineVersion": "10.11", + "StorageEncrypted": true, + "DeletionProtection": false, + "GlobalClusterMembers": [ + { + "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:js-global-cluster", + "Readers": [ + "arn:aws:rds:us-west-2:123456789012:cluster:DB-1" + ], + "IsWriter": true + }, + { + "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:DB-1", + "Readers": [], + "IsWriter": false, + "GlobalWriteForwardingStatus": "disabled" + } + ] + } + } + } + ] + } + }, + "com.amazonaws.rds#RemoveFromGlobalClusterMessage": { + "type": "structure", + "members": { + "GlobalClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The cluster identifier to detach from the Aurora global database cluster.

" + } + }, + "DbClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) identifying the cluster that was detached from the Aurora global database cluster.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#RemoveFromGlobalClusterResult": { + "type": "structure", + "members": { + "GlobalCluster": { + "target": "com.amazonaws.rds#GlobalCluster" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#RemoveRoleFromDBCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#RemoveRoleFromDBClusterMessage" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterRoleNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a\n DB cluster.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n

", + "smithy.api#examples": [ + { + "title": "To disassociate an Identity and Access Management (IAM) role from a DB cluster", + "documentation": "The following example removes a role from a DB cluster.", + "input": { + "DBClusterIdentifier": "mydbcluster", + "RoleArn": "arn:aws:iam::123456789012:role/RDSLoadFromS3" + } + } + ] + } + }, + "com.amazonaws.rds#RemoveRoleFromDBClusterMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the DB cluster to disassociate the IAM role from.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to disassociate from the Aurora DB cluster, for example\n arn:aws:iam::123456789012:role/AuroraAccessRole.

", + "smithy.api#required": {} + } + }, + "FeatureName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the feature for the DB cluster that the IAM role is to be disassociated from.\n For information about supported feature names, see DBEngineVersion.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#RemoveRoleFromDBInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#RemoveRoleFromDBInstanceMessage" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceRoleNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Disassociates an Amazon Web Services Identity and Access Management (IAM) role from a DB instance.

" + } + }, + "com.amazonaws.rds#RemoveRoleFromDBInstanceMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the DB instance to disassociate the IAM role from.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to disassociate from the DB instance,\n for example, arn:aws:iam::123456789012:role/AccessRole.

", + "smithy.api#required": {} + } + }, + "FeatureName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the feature for the DB instance that the IAM role is to be disassociated from.\n For information about supported feature names, see DBEngineVersion.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#RemoveSourceIdentifierFromSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#RemoveSourceIdentifierFromSubscriptionMessage" + }, + "output": { + "target": "com.amazonaws.rds#RemoveSourceIdentifierFromSubscriptionResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#SourceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#SubscriptionNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Removes a source identifier from an existing RDS event notification subscription.

", + "smithy.api#examples": [ + { + "title": "To remove a source identifier from a subscription", + "documentation": "The following example removes the specified source identifier from an existing subscription.", + "input": { + "SubscriptionName": "my-instance-events", + "SourceIdentifier": "test-instance-repl" + }, + "output": { + "EventSubscription": { + "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events", + "SubscriptionCreationTime": "Tue Jul 31 23:22:01 UTC 2018", + "EventCategoriesList": [ + "backup", + "recovery" + ], + "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events", + "Status": "modifying", + "CustSubscriptionId": "my-instance-events", + "CustomerAwsId": "123456789012", + "SourceIdsList": [ + "test-instance" + ], + "SourceType": "db-instance", + "Enabled": false + } + } + } + ] + } + }, + "com.amazonaws.rds#RemoveSourceIdentifierFromSubscriptionMessage": { + "type": "structure", + "members": { + "SubscriptionName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the RDS event notification subscription you want to remove a source identifier from.

", + "smithy.api#required": {} + } + }, + "SourceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The source identifier to be removed from the subscription, such as the DB instance identifier \n for a DB instance or the name of a security group.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#RemoveSourceIdentifierFromSubscriptionResult": { + "type": "structure", + "members": { + "EventSubscription": { + "target": "com.amazonaws.rds#EventSubscription" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#RemoveTagsFromResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#RemoveTagsFromResourceMessage" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.rds#BlueGreenDeploymentNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBProxyNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSnapshotTenantDatabaseNotFoundFault" + }, + { + "target": "com.amazonaws.rds#IntegrationNotFoundFault" + }, + { + "target": "com.amazonaws.rds#TenantDatabaseNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Removes metadata tags from an Amazon RDS resource.

\n

For an overview on tagging an Amazon RDS resource, \n see Tagging Amazon RDS Resources in the Amazon RDS User Guide\n or Tagging Amazon Aurora and Amazon RDS Resources in the Amazon Aurora User Guide.

", + "smithy.api#examples": [ + { + "title": "To remove tags from a resource", + "documentation": "The following example removes tags from a resource.", + "input": { + "ResourceName": "arn:aws:rds:us-east-1:123456789012:db:mydbinstance", + "TagKeys": [ + "Name", + "Environment" + ] + } + } + ] + } + }, + "com.amazonaws.rds#RemoveTagsFromResourceMessage": { + "type": "structure", + "members": { + "ResourceName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon RDS resource that the tags are removed from. This value is an Amazon Resource Name (ARN). For information about \n creating an ARN, \n see \n Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.\n

", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.rds#KeyList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The tag key (name) of the tag to be removed.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ReplicaMode": { + "type": "enum", + "members": { + "OPEN_READ_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "open-read-only" + } + }, + "MOUNTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "mounted" + } + } + } + }, + "com.amazonaws.rds#ReservedDBInstance": { + "type": "structure", + "members": { + "ReservedDBInstanceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The unique identifier for the reservation.

" + } + }, + "ReservedDBInstancesOfferingId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The offering identifier.

" + } + }, + "DBInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB instance class for the reserved DB instance.

" + } + }, + "StartTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The time the reservation started.

" + } + }, + "Duration": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#documentation": "

The duration of the reservation in seconds.

" + } + }, + "FixedPrice": { + "target": "com.amazonaws.rds#Double", + "traits": { + "smithy.api#documentation": "

The fixed price charged for this reserved DB instance.

" + } + }, + "UsagePrice": { + "target": "com.amazonaws.rds#Double", + "traits": { + "smithy.api#documentation": "

The hourly price charged for this reserved DB instance.

" + } + }, + "CurrencyCode": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The currency code for the reserved DB instance.

" + } + }, + "DBInstanceCount": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#documentation": "

The number of reserved DB instances.

" + } + }, + "ProductDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The description of the reserved DB instance.

" + } + }, + "OfferingType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The offering type of this reserved DB instance.

" + } + }, + "MultiAZ": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the reservation applies to Multi-AZ deployments.

" + } + }, + "State": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The state of the reserved DB instance.

" + } + }, + "RecurringCharges": { + "target": "com.amazonaws.rds#RecurringChargeList", + "traits": { + "smithy.api#documentation": "

The recurring price charged to run this reserved DB instance.

" + } + }, + "ReservedDBInstanceArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the reserved DB instance.

" + } + }, + "LeaseId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The unique identifier for the lease associated with the reserved DB instance.

\n \n

Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a response element in the \n DescribeReservedDBInstances and \n PurchaseReservedDBInstancesOffering actions.

" + } + }, + "com.amazonaws.rds#ReservedDBInstanceAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ReservedDBInstanceAlreadyExists", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

User already has a reservation with the given identifier.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#ReservedDBInstanceList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#ReservedDBInstance", + "traits": { + "smithy.api#xmlName": "ReservedDBInstance" + } + } + }, + "com.amazonaws.rds#ReservedDBInstanceMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "ReservedDBInstances": { + "target": "com.amazonaws.rds#ReservedDBInstanceList", + "traits": { + "smithy.api#documentation": "

A list of reserved DB instances.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeReservedDBInstances action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#ReservedDBInstanceNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ReservedDBInstanceNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified reserved DB Instance not found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#ReservedDBInstanceQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ReservedDBInstanceQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Request would exceed the user's DB Instance quota.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#ReservedDBInstancesOffering": { + "type": "structure", + "members": { + "ReservedDBInstancesOfferingId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The offering identifier.

" + } + }, + "DBInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB instance class for the reserved DB instance.

" + } + }, + "Duration": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#documentation": "

The duration of the offering in seconds.

" + } + }, + "FixedPrice": { + "target": "com.amazonaws.rds#Double", + "traits": { + "smithy.api#documentation": "

The fixed price charged for this offering.

" + } + }, + "UsagePrice": { + "target": "com.amazonaws.rds#Double", + "traits": { + "smithy.api#documentation": "

The hourly price charged for this offering.

" + } + }, + "CurrencyCode": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The currency code for the reserved DB instance offering.

" + } + }, + "ProductDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The database engine used by the offering.

" + } + }, + "OfferingType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The offering type.

" + } + }, + "MultiAZ": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the offering applies to Multi-AZ deployments.

" + } + }, + "RecurringCharges": { + "target": "com.amazonaws.rds#RecurringChargeList", + "traits": { + "smithy.api#documentation": "

The recurring price charged to run this reserved DB instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a response element in the DescribeReservedDBInstancesOfferings action.

" + } + }, + "com.amazonaws.rds#ReservedDBInstancesOfferingList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#ReservedDBInstancesOffering", + "traits": { + "smithy.api#xmlName": "ReservedDBInstancesOffering" + } + } + }, + "com.amazonaws.rds#ReservedDBInstancesOfferingMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "ReservedDBInstancesOfferings": { + "target": "com.amazonaws.rds#ReservedDBInstancesOfferingList", + "traits": { + "smithy.api#documentation": "

A list of reserved DB instance offerings.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#ReservedDBInstancesOfferingNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ReservedDBInstancesOfferingNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

Specified offering does not exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#ResetDBClusterParameterGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ResetDBClusterParameterGroupMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBClusterParameterGroupNameMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBParameterGroupStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies the parameters of a DB cluster parameter group to the default value. To\n reset specific parameters submit a list of the following: ParameterName \n and ApplyMethod. To reset the\n entire DB cluster parameter group, specify the DBClusterParameterGroupName \n and ResetAllParameters parameters.

\n

When resetting the entire group, dynamic parameters are updated immediately and static parameters\n are set to pending-reboot to take effect on the next DB instance restart \n or RebootDBInstance request. You must call RebootDBInstance for every\n DB instance in your DB cluster that you want the updated static parameter to apply to.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n

", + "smithy.api#examples": [ + { + "title": "To reset all parameters to their default values", + "documentation": "The following example resets all parameter values in a customer-created DB cluster parameter group to their default values.", + "input": { + "DBClusterParameterGroupName": "mydbclpg", + "ResetAllParameters": true + }, + "output": { + "DBClusterParameterGroupName": "mydbclpg" + } + } + ] + } + }, + "com.amazonaws.rds#ResetDBClusterParameterGroupMessage": { + "type": "structure", + "members": { + "DBClusterParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the DB cluster parameter group to reset.

", + "smithy.api#required": {} + } + }, + "ResetAllParameters": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether to reset all parameters in the DB cluster parameter group \n to their default values. You can't use this parameter if there \n is a list of parameter names specified for the Parameters parameter.

" + } + }, + "Parameters": { + "target": "com.amazonaws.rds#ParametersList", + "traits": { + "smithy.api#documentation": "

A list of parameter names in the DB cluster parameter group to reset to the default values. You can't use this\n parameter if the ResetAllParameters parameter is enabled.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ResetDBParameterGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ResetDBParameterGroupMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBParameterGroupNameMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBParameterGroupStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies the parameters of a DB parameter group to the engine/system default value.\n To reset specific parameters, provide a list of the following:\n ParameterName and ApplyMethod. To reset the entire DB\n parameter group, specify the DBParameterGroup name and\n ResetAllParameters parameters. When resetting the entire group, dynamic\n parameters are updated immediately and static parameters are set to\n pending-reboot to take effect on the next DB instance restart or\n RebootDBInstance request.

", + "smithy.api#examples": [ + { + "title": "To reset all parameters to their default values", + "documentation": "The following example resets all parameter values in a customer-created DB parameter group to their default values.", + "input": { + "DBParameterGroupName": "mypg", + "ResetAllParameters": true + }, + "output": { + "DBParameterGroupName": "mypg" + } + } + ] + } + }, + "com.amazonaws.rds#ResetDBParameterGroupMessage": { + "type": "structure", + "members": { + "DBParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the DB parameter group.

\n

Constraints:

\n
    \n
  • \n

    Must match the name of an existing DBParameterGroup.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "ResetAllParameters": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether to reset all parameters in the DB parameter group to default values. \n By default, all parameters in the DB parameter group are reset to default values.

" + } + }, + "Parameters": { + "target": "com.amazonaws.rds#ParametersList", + "traits": { + "smithy.api#documentation": "

To reset the entire DB parameter group, specify the DBParameterGroup\n name and ResetAllParameters parameters. To reset specific parameters,\n provide a list of the following: ParameterName and\n ApplyMethod. A maximum of 20 parameters can be modified in a single\n request.

\n

\n MySQL\n

\n

Valid Values (for Apply method): immediate | pending-reboot\n

\n

You can use the immediate value with dynamic parameters only. You can use \n the pending-reboot value for both dynamic and static parameters, and changes \n are applied when DB instance reboots.

\n

\n MariaDB\n

\n

Valid Values (for Apply method): immediate | pending-reboot\n

\n

You can use the immediate value with dynamic parameters only. You can use \n the pending-reboot value for both dynamic and static parameters, and changes \n are applied when DB instance reboots.

\n

\n Oracle\n

\n

Valid Values (for Apply method): pending-reboot\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ResourceNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ResourceNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified resource ID was not found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#ResourcePendingMaintenanceActions": { + "type": "structure", + "members": { + "ResourceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN of the resource that has pending maintenance actions.

" + } + }, + "PendingMaintenanceActionDetails": { + "target": "com.amazonaws.rds#PendingMaintenanceActionDetails", + "traits": { + "smithy.api#documentation": "

A list that provides details about the pending maintenance actions for the resource.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the pending maintenance actions for a resource.

" + } + }, + "com.amazonaws.rds#RestoreDBClusterFromS3": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#RestoreDBClusterFromS3Message" + }, + "output": { + "target": "com.amazonaws.rds#RestoreDBClusterFromS3Result" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DomainNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InsufficientStorageClusterCapacityFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSubnetGroupStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidS3BucketFault" + }, + { + "target": "com.amazonaws.rds#InvalidSubnet" + }, + { + "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + }, + { + "target": "com.amazonaws.rds#StorageQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#StorageTypeNotSupportedFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket.\n Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be\n created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the\n Amazon Aurora User Guide.

\n \n

This operation only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance operation to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterFromS3 operation has completed and the DB\n cluster is available.

\n \n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n \n

This operation only applies to Aurora DB clusters. The source DB engine must be MySQL.

\n ", + "smithy.api#examples": [ + { + "title": "To restore an Amazon Aurora DB cluster from Amazon S3", + "documentation": "The following example restores an Amazon Aurora MySQL version 5.7-compatible DB cluster from a MySQL 5.7 DB backup file in Amazon S3.", + "input": { + "DBClusterIdentifier": "cluster-s3-restore", + "Engine": "aurora-mysql", + "MasterUsername": "admin", + "MasterUserPassword": "mypassword", + "SourceEngine": "mysql", + "SourceEngineVersion": "5.7.28", + "S3BucketName": "mybucket", + "S3Prefix": "test-backup", + "S3IngestionRoleArn": "arn:aws:iam::123456789012:role/service-role/TestBackup" + }, + "output": { + "DBCluster": { + "AllocatedStorage": 1, + "AvailabilityZones": [ + "us-west-2c", + "us-west-2a", + "us-west-2b" + ], + "BackupRetentionPeriod": 1, + "DBClusterIdentifier": "cluster-s3-restore", + "DBClusterParameterGroup": "default.aurora-mysql5.7", + "DBSubnetGroup": "default", + "Status": "creating", + "Endpoint": "cluster-s3-restore.cluster-co3xyzabc123.us-west-2.rds.amazonaws.com", + "ReaderEndpoint": "cluster-s3-restore.cluster-ro-co3xyzabc123.us-west-2.rds.amazonaws.com", + "MultiAZ": false, + "Engine": "aurora-mysql", + "EngineVersion": "5.7.12", + "Port": 3306, + "MasterUsername": "admin", + "PreferredBackupWindow": "11:15-11:45", + "PreferredMaintenanceWindow": "thu:12:19-thu:12:49", + "ReadReplicaIdentifiers": [], + "DBClusterMembers": [], + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-########", + "Status": "active" + } + ], + "HostedZoneId": "Z1PVIF0EXAMPLE", + "StorageEncrypted": false, + "DbClusterResourceId": "cluster-SU5THYQQHOWCXZZDGXREXAMPLE", + "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:cluster-s3-restore", + "AssociatedRoles": [], + "IAMDatabaseAuthenticationEnabled": false, + "ClusterCreateTime": "2020-07-27T14:22:08.095Z", + "EngineMode": "provisioned", + "DeletionProtection": false, + "HttpEndpointEnabled": false, + "CopyTagsToSnapshot": false, + "CrossAccountClone": false, + "DomainMemberships": [] + } + } + } + ] + } + }, + "com.amazonaws.rds#RestoreDBClusterFromS3Message": { + "type": "structure", + "members": { + "AvailabilityZones": { + "target": "com.amazonaws.rds#AvailabilityZones", + "traits": { + "smithy.api#documentation": "

A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.

" + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1.

\n

Default: 1

\n

Constraints:

\n
    \n
  • \n

    Must be a value from 1 to 35

    \n
    • \n
" + } + }, + "CharacterSetName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.

" + } + }, + "DatabaseName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The database name for the restored DB cluster.

" + } + }, + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Example: my-cluster1\n

", + "smithy.api#required": {} + } + }, + "DBClusterParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB cluster parameter group to associate\n with the restored DB cluster. If this argument is omitted, the default parameter group for the engine version is used.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBClusterParameterGroup.

    \n
    • \n
" + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of EC2 VPC security groups to associate with the restored DB cluster.

" + } + }, + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A DB subnet group to associate with the restored DB cluster.

\n

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

\n

Example: mydbsubnetgroup\n

" + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the database engine to be used for this DB cluster.

\n

Valid Values: aurora-mysql (for Aurora MySQL)

", + "smithy.api#required": {} + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version number of the database engine to use.

\n

To list all of the available engine versions for aurora-mysql (Aurora MySQL), use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

\n Aurora MySQL\n

\n

Examples: 5.7.mysql_aurora.2.12.0, 8.0.mysql_aurora.3.04.0\n

" + } + }, + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port number on which the instances in the restored DB cluster accept connections.

\n

Default: 3306\n

" + } + }, + "MasterUsername": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the master user for the restored DB cluster.

\n

Constraints:

\n
    \n
  • \n

    Must be 1 to 16 letters or numbers.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't be a reserved word for the chosen database engine.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "MasterUserPassword": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".

\n

Constraints:

\n
    \n
  • \n

    Must contain from 8 to 41 characters.

    \n
    • \n
  • \n

    Can't be specified if ManageMasterUserPassword is turned on.

    \n
    • \n
" + } + }, + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A value that indicates that the restored DB cluster should be associated with the specified option group.

\n

Permanent options can't be removed from an option group. An option group can't be removed from a \n DB cluster once it is associated with a DB cluster.

" + } + }, + "PreferredBackupWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled\n using the BackupRetentionPeriod parameter.

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To view the time blocks available, see \n \n Backup window in the Amazon Aurora User Guide.

\n

Constraints:

\n
    \n
  • \n

    Must be in the format hh24:mi-hh24:mi.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must not conflict with the preferred maintenance window.

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \n
" + } + }, + "PreferredMaintenanceWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.

\n

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

\n

Constraints: Minimum 30-minute window.

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + }, + "StorageEncrypted": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the restored DB cluster is encrypted.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB cluster.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

If the StorageEncrypted parameter is enabled, and you do\n not specify a value for the KmsKeyId parameter, then\n Amazon RDS will use your default KMS key. There is a \n default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different\n default KMS key for each Amazon Web Services Region.

" + } + }, + "EnableIAMDatabaseAuthentication": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.

" + } + }, + "SourceEngine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier for the database engine that was backed up to create the files stored in the\n Amazon S3 bucket.

\n

Valid Values: mysql\n

", + "smithy.api#required": {} + } + }, + "SourceEngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The version of the database that the backup files were created from.

\n

MySQL versions 5.7 and 8.0 are supported.

\n

Example: 5.7.40, 8.0.28\n

", + "smithy.api#required": {} + } + }, + "S3BucketName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.

", + "smithy.api#required": {} + } + }, + "S3Prefix": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster.\n If you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is\n created by using all of the files in the Amazon S3 bucket.

" + } + }, + "S3IngestionRoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that authorizes\n Amazon RDS to access the Amazon S3 bucket on your behalf.

", + "smithy.api#required": {} + } + }, + "BacktrackWindow": { + "target": "com.amazonaws.rds#LongOptional", + "traits": { + "smithy.api#documentation": "

The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.

\n \n

Currently, Backtrack is only supported for Aurora MySQL DB clusters.

\n \n

Default: 0

\n

Constraints:

\n
    \n
  • \n

    If specified, this value must be set to a number from 0 to 259,200 (72 hours).

    \n
    • \n
" + } + }, + "EnableCloudwatchLogsExports": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used.

\n

\n Aurora MySQL\n

\n

Possible values are audit, error, general, and slowquery.

\n

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable deletion protection for the DB cluster. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.

" + } + }, + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

" + } + }, + "Domain": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specify the Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation.

\n

For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster.\n For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.

" + } + }, + "DomainIAMRoleName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specify the name of the IAM role to be used when making API calls to the Directory Service.

" + } + }, + "ServerlessV2ScalingConfiguration": { + "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" + }, + "NetworkType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The network type of the DB cluster.

\n

Valid Values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

" + } + }, + "ManageMasterUserPassword": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n

\n

Constraints:

\n
    \n
  • \n

    Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword \n is specified.

    \n
    • \n
" + } + }, + "MasterUserSecretKmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and \n managed in Amazon Web Services Secrets Manager.

\n

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB cluster.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager \n KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't \n use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer \n managed KMS key.

\n

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the storage type to be associated with the DB cluster.

\n

Valid Values: aurora, aurora-iopt1\n

\n

Default: aurora\n

\n

Valid for: Aurora DB clusters only

" + } + }, + "EngineLifecycleSupport": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The life cycle type for this DB cluster.

\n \n

By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. \n At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, \n RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.

\n \n

You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, \n you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:

\n \n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled\n

\n

Default: open-source-rds-extended-support\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#RestoreDBClusterFromS3Result": { + "type": "structure", + "members": { + "DBCluster": { + "target": "com.amazonaws.rds#DBCluster" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#RestoreDBClusterFromSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#RestoreDBClusterFromSnapshotMessage" + }, + "output": { + "target": "com.amazonaws.rds#RestoreDBClusterFromSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBClusterParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DomainNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InsufficientDBClusterCapacityFault" + }, + { + "target": "com.amazonaws.rds#InsufficientDBInstanceCapacityFault" + }, + { + "target": "com.amazonaws.rds#InsufficientStorageClusterCapacityFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterSnapshotStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSnapshotStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidRestoreFault" + }, + { + "target": "com.amazonaws.rds#InvalidSubnet" + }, + { + "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + }, + { + "target": "com.amazonaws.rds#OptionGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#StorageQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

\n

The target DB cluster is created from the source snapshot with a default\n configuration. If you don't specify a security group, the new DB cluster is\n associated with the default security group.

\n \n

This operation only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance operation to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterFromSnapshot operation has completed and the DB\n cluster is available.

\n \n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n

", + "smithy.api#examples": [ + { + "title": "To restore a DB cluster from a snapshot", + "documentation": "The following example restores an Aurora PostgreSQL DB cluster compatible with PostgreSQL version 10.7 from a DB cluster snapshot named test-instance-snapshot.", + "input": { + "DBClusterIdentifier": "newdbcluster", + "SnapshotIdentifier": "test-instance-snapshot", + "Engine": "aurora-postgresql", + "EngineVersion": "10.7" + }, + "output": { + "DBCluster": { + "AllocatedStorage": 1, + "AvailabilityZones": [ + "us-west-2c", + "us-west-2a", + "us-west-2b" + ], + "BackupRetentionPeriod": 7, + "DatabaseName": "", + "DBClusterIdentifier": "newdbcluster", + "DBClusterParameterGroup": "default.aurora-postgresql10", + "DBSubnetGroup": "default", + "Status": "creating", + "Endpoint": "newdbcluster.cluster-############.us-west-2.rds.amazonaws.com", + "ReaderEndpoint": "newdbcluster.cluster-ro-############.us-west-2.rds.amazonaws.com", + "MultiAZ": false, + "Engine": "aurora-postgresql", + "EngineVersion": "10.7", + "Port": 5432, + "MasterUsername": "postgres", + "PreferredBackupWindow": "09:33-10:03", + "PreferredMaintenanceWindow": "sun:12:22-sun:12:52", + "ReadReplicaIdentifiers": [], + "DBClusterMembers": [], + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-########", + "Status": "active" + } + ], + "HostedZoneId": "Z1PVIF0EXAMPLE", + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/287364e4-33e3-4755-a3b0-a1b2c3d4e5f6", + "DbClusterResourceId": "cluster-5DSB5IFQDDUVAWOUWM1EXAMPLE", + "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:newdbcluster", + "AssociatedRoles": [], + "IAMDatabaseAuthenticationEnabled": false, + "ClusterCreateTime": "2020-06-05T15:06:58.634Z", + "EngineMode": "provisioned", + "DeletionProtection": false, + "HttpEndpointEnabled": false, + "CopyTagsToSnapshot": false, + "CrossAccountClone": false, + "DomainMemberships": [] + } + } + } + ] + } + }, + "com.amazonaws.rds#RestoreDBClusterFromSnapshotMessage": { + "type": "structure", + "members": { + "AvailabilityZones": { + "target": "com.amazonaws.rds#AvailabilityZones", + "traits": { + "smithy.api#documentation": "

Provides the list of Availability Zones (AZs) where instances in the restored DB\n cluster can be created.

\n

Valid for: Aurora DB clusters only

" + } + }, + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the DB cluster to create from the DB snapshot or DB cluster snapshot.\n This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
\n

Example: my-snapshot-id\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

", + "smithy.api#required": {} + } + }, + "SnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier for the DB snapshot or DB cluster snapshot to restore from.

\n

You can use either the name or the Amazon Resource Name (ARN) to specify a DB\n cluster snapshot. However, you can use only the ARN to specify a DB snapshot.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing Snapshot.

    \n
    • \n
\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

", + "smithy.api#required": {} + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The database engine to use for the new DB cluster.

\n

Default: The same as source

\n

Constraint: Must be compatible with the engine of the source

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

", + "smithy.api#required": {} + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version of the database engine to use for the new DB cluster. If you don't specify an engine version, the default version\n for the database engine in the Amazon Web Services Region is used.

\n

To list all of the available engine versions for Aurora MySQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for Aurora PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for MySQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"\n

\n

\n Aurora MySQL\n

\n

See Database \n engine updates for Amazon Aurora MySQL in the Amazon Aurora User Guide.

\n

\n Aurora PostgreSQL\n

\n

See Amazon \n Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide.

\n

\n MySQL\n

\n

See Amazon \n RDS for MySQL in the Amazon RDS User Guide.\n

\n

\n PostgreSQL\n

\n

See Amazon \n RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port number on which the new DB cluster accepts connections.

\n

Constraints: This value must be 1150-65535\n

\n

Default: The same port as the original DB cluster.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB subnet group to use for the new DB cluster.

\n

Constraints: If supplied, must match the name of an existing DB subnet group.

\n

Example: mydbsubnetgroup\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "DatabaseName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The database name for the restored DB cluster.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the option group to use for the restored DB cluster.

\n

DB clusters are associated with a default option group that can't be modified.

" + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of VPC security groups that the new DB cluster will belong to.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

The tags to be assigned to the restored DB cluster.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from a DB\n snapshot or DB cluster snapshot.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

When you don't specify a value for the KmsKeyId parameter, then the\n following occurs:

\n
    \n
  • \n

    If the DB snapshot or DB cluster snapshot in\n SnapshotIdentifier is encrypted, then the restored DB cluster\n is encrypted using the KMS key that was used to encrypt the DB snapshot or DB\n cluster snapshot.

    \n
    • \n
  • \n

    If the DB snapshot or DB cluster snapshot in \n SnapshotIdentifier isn't encrypted, then the restored DB cluster\n isn't encrypted.

    \n
    • \n
\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "EnableIAMDatabaseAuthentication": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see IAM Database\n Authentication in the Amazon Aurora User Guide or\n IAM database\n authentication for MariaDB, MySQL, and PostgreSQL in the Amazon\n RDS User Guide.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "BacktrackWindow": { + "target": "com.amazonaws.rds#LongOptional", + "traits": { + "smithy.api#documentation": "

The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.

\n \n

Currently, Backtrack is only supported for Aurora MySQL DB clusters.

\n \n

Default: 0

\n

Constraints:

\n
    \n
  • \n

    If specified, this value must be set to a number from 0 to 259,200 (72 hours).

    \n
    • \n
\n

Valid for: Aurora DB clusters only

" + } + }, + "EnableCloudwatchLogsExports": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.\n The values in the list depend on the DB engine being used.

\n

\n RDS for MySQL\n

\n

Possible values are error, general, and slowquery.

\n

\n RDS for PostgreSQL\n

\n

Possible values are postgresql and upgrade.

\n

\n Aurora MySQL\n

\n

Possible values are audit, error, general, and slowquery.

\n

\n Aurora PostgreSQL\n

\n

Possible value is postgresql.

\n

For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "EngineMode": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB engine mode of the DB cluster, either provisioned or serverless.

\n

For more information, see \n CreateDBCluster.

\n

Valid for: Aurora DB clusters only

" + } + }, + "ScalingConfiguration": { + "target": "com.amazonaws.rds#ScalingConfiguration", + "traits": { + "smithy.api#documentation": "

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

\n

Valid for: Aurora DB clusters only

" + } + }, + "DBClusterParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB cluster parameter group to associate with this DB cluster. If this\n argument is omitted, the default DB cluster parameter group for the specified engine is\n used.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing default DB cluster parameter group.

    \n
    • \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable deletion protection for the DB cluster. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "Domain": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

Valid for: Aurora DB clusters only

" + } + }, + "DomainIAMRoleName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the IAM role to be used when making API calls to the Directory Service.

\n

Valid for: Aurora DB clusters only

" + } + }, + "DBClusterInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.

\n

For the full list of DB instance classes, and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n

\n

Valid for: Multi-AZ DB clusters only

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the storage type to be associated with the DB cluster.

\n

When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.

\n

Valid Values: aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters)

\n

Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters)

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for \n each DB instance in the Multi-AZ DB cluster.

\n

For information about valid IOPS values, \n see Amazon RDS Provisioned IOPS storage \n in the Amazon RDS User Guide.

\n

Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the DB cluster is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. \n Access to the DB cluster is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.

\n

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

\n

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

\n

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

\n
    \n
  • \n

    If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.

    \n
    • \n
  • \n

    If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.

    \n
    • \n
\n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n
    \n
  • \n

    If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.

    \n
    • \n
  • \n

    If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.

    \n
    • \n
\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "ServerlessV2ScalingConfiguration": { + "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" + }, + "NetworkType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The network type of the DB cluster.

\n

Valid Values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid for: Aurora DB clusters only

" + } + }, + "RdsCustomClusterConfiguration": { + "target": "com.amazonaws.rds#RdsCustomClusterConfiguration", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

" + } + }, + "MonitoringInterval": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off \n collecting Enhanced Monitoring metrics, specify 0.

\n

If MonitoringRoleArn is specified, also set MonitoringInterval to a value other than 0.

\n

Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60\n

\n

Default: 0\n

" + } + }, + "MonitoringRoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. \n An example is arn:aws:iam:123456789012:role/emaccess.

\n

If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.

" + } + }, + "EnablePerformanceInsights": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to turn on Performance Insights for the DB cluster.

" + } + }, + "PerformanceInsightsKMSKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. \n There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

" + } + }, + "PerformanceInsightsRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days to retain Performance Insights data.

\n

Valid Values:

\n
    \n
  • \n

    \n 7\n

    \n
    • \n
  • \n

    \n month * 31, where month is a number of months from 1-23. \n Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)

    \n
    • \n
  • \n

    \n 731\n

    \n
    • \n
\n

Default: 7 days

\n

If you specify a retention period that isn't valid, such as 94, Amazon RDS issues an error.

" + } + }, + "EngineLifecycleSupport": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The life cycle type for this DB cluster.

\n \n

By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. \n At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, \n RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.

\n \n

You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, \n you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:

\n \n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled\n

\n

Default: open-source-rds-extended-support\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#RestoreDBClusterFromSnapshotResult": { + "type": "structure", + "members": { + "DBCluster": { + "target": "com.amazonaws.rds#DBCluster" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#RestoreDBClusterToPointInTime": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#RestoreDBClusterToPointInTimeMessage" + }, + "output": { + "target": "com.amazonaws.rds#RestoreDBClusterToPointInTimeResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBClusterAutomatedBackupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DomainNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InsufficientDBClusterCapacityFault" + }, + { + "target": "com.amazonaws.rds#InsufficientDBInstanceCapacityFault" + }, + { + "target": "com.amazonaws.rds#InsufficientStorageClusterCapacityFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterSnapshotStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSnapshotStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidRestoreFault" + }, + { + "target": "com.amazonaws.rds#InvalidSubnet" + }, + { + "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + }, + { + "target": "com.amazonaws.rds#OptionGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#StorageQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Restores a DB cluster to an arbitrary point in time. Users can restore to any point\n in time before LatestRestorableTime for up to\n BackupRetentionPeriod days. The target DB cluster is created from the\n source DB cluster with the same configuration as the original DB cluster, except that\n the new DB cluster is created with the default DB security group.

\n \n

For Aurora, this operation only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance operation to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterToPointInTime operation has completed and the DB\n cluster is available.

\n \n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n

", + "smithy.api#examples": [ + { + "title": "To restore a DB cluster to a specified time", + "documentation": "The following example restores the DB cluster named database-4 to the latest possible time. Using copy-on-write as the restore type restores the new DB cluster as a clone of the source DB cluster.", + "input": { + "DBClusterIdentifier": "sample-cluster-clone", + "RestoreType": "copy-on-write", + "SourceDBClusterIdentifier": "database-4", + "UseLatestRestorableTime": true + }, + "output": { + "DBCluster": { + "AllocatedStorage": 1, + "AvailabilityZones": [ + "us-west-2c", + "us-west-2a", + "us-west-2b" + ], + "BackupRetentionPeriod": 7, + "DatabaseName": "", + "DBClusterIdentifier": "sample-cluster-clone", + "DBClusterParameterGroup": "default.aurora-postgresql10", + "DBSubnetGroup": "default", + "Status": "creating", + "Endpoint": "sample-cluster-clone.cluster-############.us-west-2.rds.amazonaws.com", + "ReaderEndpoint": "sample-cluster-clone.cluster-ro-############.us-west-2.rds.amazonaws.com", + "MultiAZ": false, + "Engine": "aurora-postgresql", + "EngineVersion": "10.7", + "Port": 5432, + "MasterUsername": "postgres", + "PreferredBackupWindow": "09:33-10:03", + "PreferredMaintenanceWindow": "sun:12:22-sun:12:52", + "ReadReplicaIdentifiers": [], + "DBClusterMembers": [], + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-########", + "Status": "active" + } + ], + "HostedZoneId": "Z1PVIF0EXAMPLE", + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/287364e4-33e3-4755-a3b0-a1b2c3d4e5f6", + "DbClusterResourceId": "cluster-BIZ77GDSA2XBSTNPFW1EXAMPLE", + "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster-clone", + "AssociatedRoles": [], + "IAMDatabaseAuthenticationEnabled": false, + "CloneGroupId": "8d19331a-099a-45a4-b4aa-11aa22bb33cc44dd", + "ClusterCreateTime": "2020-03-10T19:57:38.967Z", + "EngineMode": "provisioned", + "DeletionProtection": false, + "HttpEndpointEnabled": false, + "CopyTagsToSnapshot": false, + "CrossAccountClone": false + } + } + } + ] + } + }, + "com.amazonaws.rds#RestoreDBClusterToPointInTimeMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the new DB cluster to be created.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

", + "smithy.api#required": {} + } + }, + "RestoreType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The type of restore to be performed. You can specify one of the following values:

\n
    \n
  • \n

    \n full-copy - The new DB cluster is restored as a full copy of the\n source DB cluster.

    \n
    • \n
  • \n

    \n copy-on-write - The new DB cluster is restored as a clone of the\n source DB cluster.

    \n
    • \n
\n

If you don't specify a RestoreType value, then the new DB cluster is\n restored as a full copy of the source DB cluster.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "SourceDBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the source DB cluster from which to restore.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DBCluster.

    \n
    • \n
\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "RestoreToTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The date and time to restore the DB cluster to.

\n

Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

\n

Constraints:

\n
    \n
  • \n

    Must be before the latest restorable time for the DB instance

    \n
    • \n
  • \n

    Must be specified if UseLatestRestorableTime parameter isn't provided

    \n
    • \n
  • \n

    Can't be specified if the UseLatestRestorableTime parameter is enabled

    \n
    • \n
  • \n

    Can't be specified if the RestoreType parameter is copy-on-write\n

    \n
    • \n
\n

Example: 2015-03-07T23:45:00Z\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "UseLatestRestorableTime": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether to restore the DB cluster to the latest \n restorable backup time. By default, the DB cluster isn't restored to the latest \n restorable backup time.

\n

Constraints: Can't be specified if RestoreToTime parameter is provided.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port number on which the new DB cluster accepts connections.

\n

Constraints: A value from 1150-65535.

\n

Default: The default port for the engine.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB subnet group name to use for the new DB cluster.

\n

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

\n

Example: mydbsubnetgroup\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the option group for the new DB cluster.

\n

DB clusters are associated with a default option group that can't be modified.

" + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of VPC security groups that the new DB cluster belongs to.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different from the\n KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key\n identified by the KmsKeyId parameter.

\n

If you don't specify a value for the KmsKeyId parameter, then the following occurs:

\n
    \n
  • \n

    If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.

    \n
    • \n
  • \n

    If the DB cluster isn't encrypted, then the restored DB cluster isn't encrypted.

    \n
    • \n
\n

If DBClusterIdentifier refers to a DB cluster that isn't encrypted, then the restore request\n is rejected.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "EnableIAMDatabaseAuthentication": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see IAM Database\n Authentication in the Amazon Aurora User Guide or\n IAM database\n authentication for MariaDB, MySQL, and PostgreSQL in the Amazon\n RDS User Guide.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "BacktrackWindow": { + "target": "com.amazonaws.rds#LongOptional", + "traits": { + "smithy.api#documentation": "

The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.

\n

Default: 0

\n

Constraints:

\n
    \n
  • \n

    If specified, this value must be set to a number from 0 to 259,200 (72 hours).

    \n
    • \n
\n

Valid for: Aurora MySQL DB clusters only

" + } + }, + "EnableCloudwatchLogsExports": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used.

\n

\n RDS for MySQL\n

\n

Possible values are error, general, and slowquery.

\n

\n RDS for PostgreSQL\n

\n

Possible values are postgresql and upgrade.

\n

\n Aurora MySQL\n

\n

Possible values are audit, error, general, and slowquery.

\n

\n Aurora PostgreSQL\n

\n

Possible value is postgresql.

\n

For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "DBClusterParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the custom DB cluster parameter group to associate with this DB cluster.

\n

If the DBClusterParameterGroupName parameter is omitted, the default DB cluster parameter group for the specified\n engine is used.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DB cluster parameter group.

    \n
    • \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable deletion protection for the DB cluster. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "Domain": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation.

\n

For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster.\n For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" + } + }, + "DomainIAMRoleName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the IAM role to be used when making API calls to the Directory Service.

\n

Valid for: Aurora DB clusters only

" + } + }, + "ScalingConfiguration": { + "target": "com.amazonaws.rds#ScalingConfiguration", + "traits": { + "smithy.api#documentation": "

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

\n

Valid for: Aurora DB clusters only

" + } + }, + "EngineMode": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The engine mode of the new cluster. Specify provisioned or serverless,\n depending on the type of the cluster you are creating. You can create an Aurora Serverless v1 clone\n from a provisioned cluster, or a provisioned clone from an Aurora Serverless v1 cluster. To create a clone\n that is an Aurora Serverless v1 cluster, the original cluster must be an Aurora Serverless v1 cluster or\n an encrypted provisioned cluster. To create a full copy that is an Aurora Serverless v1 cluster, specify \n the engine mode serverless.

\n

Valid for: Aurora DB clusters only

" + } + }, + "DBClusterInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster,\n for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services\n Regions, or for all database engines.

\n

For the full list of DB instance classes, and availability for your engine, see \n DB instance class in the \n Amazon RDS User Guide.

\n

Valid for: Multi-AZ DB clusters only

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the storage type to be associated with the DB cluster.

\n

When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.

\n

Valid Values: aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters)

\n

Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters)

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the DB cluster is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB cluster's virtual private cloud (VPC). It resolves\n to the public IP address from outside of the DB cluster's VPC. \n Access to the DB cluster is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.

\n

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

\n

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

\n

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

\n
    \n
  • \n

    If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.

    \n
    • \n
  • \n

    If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.

    \n
    • \n
\n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n
    \n
  • \n

    If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.

    \n
    • \n
  • \n

    If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.

    \n
    • \n
\n

Valid for: Multi-AZ DB clusters only

" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for \n each DB instance in the Multi-AZ DB cluster.

\n

For information about valid IOPS values, \n see Amazon RDS Provisioned IOPS storage \n in the Amazon RDS User Guide.

\n

Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.

\n

Valid for: Multi-AZ DB clusters only

" + } + }, + "ServerlessV2ScalingConfiguration": { + "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" + }, + "NetworkType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The network type of the DB cluster.

\n

Valid Values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid for: Aurora DB clusters only

" + } + }, + "SourceDbClusterResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The resource ID of the source DB cluster from which to restore.

" + } + }, + "RdsCustomClusterConfiguration": { + "target": "com.amazonaws.rds#RdsCustomClusterConfiguration", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

" + } + }, + "MonitoringInterval": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off \n collecting Enhanced Monitoring metrics, specify 0.

\n

If MonitoringRoleArn is specified, also set MonitoringInterval to a value other than 0.

\n

Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60\n

\n

Default: 0\n

" + } + }, + "MonitoringRoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. \n An example is arn:aws:iam:123456789012:role/emaccess.

\n

If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.

" + } + }, + "EnablePerformanceInsights": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to turn on Performance Insights for the DB cluster.

" + } + }, + "PerformanceInsightsKMSKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. \n There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

" + } + }, + "PerformanceInsightsRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days to retain Performance Insights data.

\n

Valid Values:

\n
    \n
  • \n

    \n 7\n

    \n
    • \n
  • \n

    \n month * 31, where month is a number of months from 1-23. \n Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)

    \n
    • \n
  • \n

    \n 731\n

    \n
    • \n
\n

Default: 7 days

\n

If you specify a retention period that isn't valid, such as 94, Amazon RDS issues an error.

" + } + }, + "EngineLifecycleSupport": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The life cycle type for this DB cluster.

\n \n

By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. \n At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, \n RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.

\n \n

You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, \n you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:

\n \n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled\n

\n

Default: open-source-rds-extended-support\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#RestoreDBClusterToPointInTimeResult": { + "type": "structure", + "members": { + "DBCluster": { + "target": "com.amazonaws.rds#DBCluster" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#RestoreDBInstanceFromDBSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#RestoreDBInstanceFromDBSnapshotMessage" + }, + "output": { + "target": "com.amazonaws.rds#RestoreDBInstanceFromDBSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#AuthorizationNotFoundFault" + }, + { + "target": "com.amazonaws.rds#BackupPolicyNotFoundFault" + }, + { + "target": "com.amazonaws.rds#CertificateNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DomainNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InstanceQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#InsufficientDBInstanceCapacityFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSnapshotStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidRestoreFault" + }, + { + "target": "com.amazonaws.rds#InvalidSubnet" + }, + { + "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + }, + { + "target": "com.amazonaws.rds#NetworkTypeNotSupported" + }, + { + "target": "com.amazonaws.rds#OptionGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#ProvisionedIopsNotAvailableInAZFault" + }, + { + "target": "com.amazonaws.rds#StorageQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#StorageTypeNotSupportedFault" + }, + { + "target": "com.amazonaws.rds#TenantDatabaseQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with most\n of the source's original configuration, including the default security group and DB parameter group. By default, the new DB\n instance is created as a Single-AZ deployment, except when the instance is a SQL Server instance that has an option group\n associated with mirroring. In this case, the instance becomes a Multi-AZ deployment, not a Single-AZ deployment.

\n

If you want to replace your original DB instance with the new, restored DB instance, then rename your original DB instance\n before you call the RestoreDBInstanceFromDBSnapshot operation. RDS doesn't allow two DB instances with the same name. After you\n have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as\n the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot operation. The result is that you replace the original\n DB instance with the DB instance created from the snapshot.

\n

If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier\n must be the ARN of the shared DB snapshot.

\n

To restore from a DB snapshot with an unsupported engine version, you must first upgrade the \n engine version of the snapshot. For more information about upgrading a RDS for MySQL DB snapshot engine version, see Upgrading a MySQL DB snapshot engine version. \n For more information about upgrading a RDS for PostgreSQL DB snapshot engine version, Upgrading a PostgreSQL DB snapshot engine version.

\n \n

This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot.

\n ", + "smithy.api#examples": [ + { + "title": "To restore a DB instance from a DB snapshot", + "documentation": "The following example creates a new DB instance named db7-new-instance with the db.t3.small DB instance class from the specified DB snapshot. The source DB instance from which the snapshot was taken uses a deprecated DB instance class, so you can't upgrade it.", + "input": { + "DBInstanceIdentifier": "db7-new-instance", + "DBSnapshotIdentifier": "db7-test-snapshot", + "DBInstanceClass": "db.t3.small" + }, + "output": { + "DBInstance": { + "DBInstanceIdentifier": "db7-new-instance", + "DBInstanceClass": "db.t3.small", + "Engine": "mysql", + "DBInstanceStatus": "creating", + "PreferredMaintenanceWindow": "mon:07:37-mon:08:07", + "PendingModifiedValues": {}, + "MultiAZ": false, + "EngineVersion": "5.7.22", + "AutoMinorVersionUpgrade": true, + "ReadReplicaDBInstanceIdentifiers": [], + "LicenseModel": "general-public-license", + "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:db7-new-instance", + "IAMDatabaseAuthenticationEnabled": false, + "PerformanceInsightsEnabled": false, + "DeletionProtection": false, + "AssociatedRoles": [] + } + } + } + ] + } + }, + "com.amazonaws.rds#RestoreDBInstanceFromDBSnapshotMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 numbers, letters, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Example: my-snapshot-id\n

", + "smithy.api#required": {} + } + }, + "DBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the DB snapshot to restore from.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DB snapshot.

    \n
    • \n
  • \n

    Can't be specified when DBClusterSnapshotIdentifier is specified.

    \n
    • \n
  • \n

    Must be specified when DBClusterSnapshotIdentifier isn't specified.

    \n
    • \n
  • \n

    If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier\n must be the ARN of the shared DB snapshot.

    \n
    • \n
" + } + }, + "DBInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n

\n

Default: The same DBInstanceClass as the original DB instance.

" + } + }, + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port number on which the database accepts connections.

\n

Default: The same port as the original DB instance

\n

Constraints: Value must be 1150-65535\n

" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone (AZ) where the DB instance will be created.

\n

Default: A random, system-chosen Availability Zone.

\n

Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

\n

Example: us-east-1a\n

" + } + }, + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB subnet group to use for the new instance.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DB subnet group.

    \n
    • \n
\n

Example: mydbsubnetgroup\n

" + } + }, + "MultiAZ": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the DB instance is a Multi-AZ deployment.

\n

This setting doesn't apply to RDS Custom.

\n

Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the DB instance is publicly accessible.

\n

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB instance's virtual private cloud (VPC). \n It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled \n by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBInstance.

" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to automatically apply minor version upgrades to the DB instance \n during the maintenance window.

\n

If you restore an RDS Custom DB instance, you must disable this parameter.

" + } + }, + "LicenseModel": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

License model information for the restored DB instance.

\n \n

License models for RDS for Db2 require additional configuration. The Bring Your\n Own License (BYOL) model requires a custom parameter group and an Amazon Web Services License Manager self-managed license. The Db2 license through\n Amazon Web Services Marketplace model requires an Amazon Web Services Marketplace subscription. For more\n information, see Amazon RDS for Db2 licensing\n options in the Amazon RDS User Guide.

\n \n

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

\n

Valid Values:

\n
    \n
  • \n

    RDS for Db2 - bring-your-own-license | marketplace-license\n

    \n
    • \n
  • \n

    RDS for MariaDB - general-public-license\n

    \n
    • \n
  • \n

    RDS for Microsoft SQL Server - license-included\n

    \n
    • \n
  • \n

    RDS for MySQL - general-public-license\n

    \n
    • \n
  • \n

    RDS for Oracle - bring-your-own-license | license-included\n

    \n
    • \n
  • \n

    RDS for PostgreSQL - postgresql-license\n

    \n
    • \n
\n

Default: Same as the source.

" + } + }, + "DBName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the database for the restored DB instance.

\n

This parameter only applies to RDS for Oracle and RDS for SQL Server DB instances. It doesn't apply to the other engines or to RDS\n Custom DB instances.

" + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The database engine to use for the new instance.

\n

This setting doesn't apply to RDS Custom.

\n

Default: The same as source

\n

Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.

\n

Valid Values:

\n
    \n
  • \n

    \n db2-ae\n

    \n
    • \n
  • \n

    \n db2-se\n

    \n
    • \n
  • \n

    \n mariadb\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n oracle-ee\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n oracle-se2\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
  • \n

    \n sqlserver-ee\n

    \n
    • \n
  • \n

    \n sqlserver-se\n

    \n
    • \n
  • \n

    \n sqlserver-ex\n

    \n
    • \n
  • \n

    \n sqlserver-web\n

    \n
    • \n
" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. \n If this parameter isn't specified, the IOPS value is taken from the backup. \n If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. \n The conversion takes additional time, though your DB instance is available for connections before the conversion starts.

\n

The provisioned IOPS value must follow the requirements for your database engine.\n For more information, see \n Amazon RDS Provisioned IOPS storage \n in the Amazon RDS User Guide.\n

\n

Constraints: Must be an integer greater than 1000.

" + } + }, + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the option group to be used for the restored DB instance.

\n

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option \n group, and that option group can't be removed from a DB instance after it is associated with a DB instance.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the storage type to be associated with the DB instance.

\n

Valid Values: gp2 | gp3 | io1 | io2 | standard\n

\n

If you specify io1, io2, or gp3, you must also include a value for the\n Iops parameter.

\n

Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

" + } + }, + "TdeCredentialArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN from the key store with which to associate the instance for TDE encryption.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "TdeCredentialPassword": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The password for the given ARN from the key store in order to access the device.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of EC2 VPC security groups to associate with this DB instance.

\n

Default: The default EC2 VPC security group for the DB subnet group's VPC.

" + } + }, + "Domain": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Active Directory directory ID to restore the DB instance in.\n The domain/ must be created prior to this operation. Currently, you can create only Db2, MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "DomainFqdn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The fully qualified domain name (FQDN) of an Active Directory domain.

\n

Constraints:

\n
    \n
  • \n

    Can't be longer than 64 characters.

    \n
    • \n
\n

Example: mymanagedADtest.mymanagedAD.mydomain\n

" + } + }, + "DomainOu": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Active Directory organizational unit for your DB instance to join.

\n

Constraints:

\n
    \n
  • \n

    Must be in the distinguished name format.

    \n
    • \n
  • \n

    Can't be longer than 64 characters.

    \n
    • \n
\n

Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain\n

" + } + }, + "DomainAuthSecretArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN for the Secrets Manager secret with the credentials for the user joining the domain.

\n

Constraints:

\n
    \n
  • \n

    Can't be longer than 64 characters.

    \n
    • \n
\n

Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456\n

" + } + }, + "DomainDnsIps": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.

\n

Constraints:

\n
    \n
  • \n

    Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.

    \n
    • \n
\n

Example: 123.124.125.126,234.235.236.237\n

" + } + }, + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to copy all tags from the restored DB instance to snapshots of the DB instance.

\n

In most cases, tags aren't copied by default. However, when you restore a DB instance from a DB snapshot, RDS checks whether you \n specify new tags. If yes, the new tags are added to the restored DB instance. If there are no new tags, RDS looks for the tags from\n the source DB instance for the DB snapshot, and then adds those tags to the restored DB instance.

\n

For more information, see \n Copying tags to DB instance snapshots in the Amazon RDS User Guide.

" + } + }, + "DomainIAMRoleName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the IAM role to use when making API calls to the Directory Service.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "EnableIAMDatabaseAuthentication": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.

\n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "EnableCloudwatchLogsExports": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

The list of logs for the restored DB instance to export to CloudWatch Logs. The values\n in the list depend on the DB engine. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "ProcessorFeatures": { + "target": "com.amazonaws.rds#ProcessorFeatureList", + "traits": { + "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "UseDefaultProcessorFeatures": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the DB instance class of the DB instance uses its default\n processor features.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "DBParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group to associate with this DB instance.

\n

If you don't specify a value for DBParameterGroupName, then RDS uses the default DBParameterGroup \n for the specified DB engine.

\n

This setting doesn't apply to RDS Custom.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DB parameter group.

    \n
    • \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable deletion protection for the DB instance. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.

" + } + }, + "EnableCustomerOwnedIp": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

This setting doesn't apply to RDS Custom.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" + } + }, + "CustomIamInstanceProfile": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:

\n
    \n
  • \n

    The profile must exist in your account.

    \n
    • \n
  • \n

    The profile must have an IAM role that Amazon EC2 has permissions to assume.

    \n
    • \n
  • \n

    The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

    \n
    • \n
\n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.

\n

This setting is required for RDS Custom.

" + } + }, + "BackupTarget": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies where automated backups and manual snapshots are stored for the restored DB instance.

\n

Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.

\n

For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

" + } + }, + "NetworkType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid Values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" + } + }, + "StorageThroughput": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Specifies the storage throughput value for the DB instance.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora.

" + } + }, + "DBClusterSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the Multi-AZ DB cluster snapshot to restore from.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing Multi-AZ DB cluster snapshot.

    \n
    • \n
  • \n

    Can't be specified when DBSnapshotIdentifier is specified.

    \n
    • \n
  • \n

    Must be specified when DBSnapshotIdentifier isn't specified.

    \n
    • \n
  • \n

    If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier\n must be the ARN of the shared snapshot.

    \n
    • \n
  • \n

    Can't be the identifier of an Aurora DB cluster snapshot.

    \n
    • \n
" + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in\n CreateDBInstance.

\n

This setting isn't valid for RDS for SQL Server.

\n \n

Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also\n allocate additional storage for future growth.

\n " + } + }, + "DedicatedLogVolume": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable a dedicated log volume (DLV) for the DB instance.

" + } + }, + "CACertificateIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The CA certificate identifier to use for the DB instance's server certificate.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

For more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.

" + } + }, + "EngineLifecycleSupport": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The life cycle type for this DB instance.

\n \n

By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. \n At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, \n RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date.

\n \n

You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, \n you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon RDS User Guide.

\n

This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.

\n

Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled\n

\n

Default: open-source-rds-extended-support\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#RestoreDBInstanceFromDBSnapshotResult": { + "type": "structure", + "members": { + "DBInstance": { + "target": "com.amazonaws.rds#DBInstance" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#RestoreDBInstanceFromS3": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#RestoreDBInstanceFromS3Message" + }, + "output": { + "target": "com.amazonaws.rds#RestoreDBInstanceFromS3Result" + }, + "errors": [ + { + "target": "com.amazonaws.rds#AuthorizationNotFoundFault" + }, + { + "target": "com.amazonaws.rds#BackupPolicyNotFoundFault" + }, + { + "target": "com.amazonaws.rds#CertificateNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InstanceQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#InsufficientDBInstanceCapacityFault" + }, + { + "target": "com.amazonaws.rds#InvalidS3BucketFault" + }, + { + "target": "com.amazonaws.rds#InvalidSubnet" + }, + { + "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + }, + { + "target": "com.amazonaws.rds#NetworkTypeNotSupported" + }, + { + "target": "com.amazonaws.rds#OptionGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#ProvisionedIopsNotAvailableInAZFault" + }, + { + "target": "com.amazonaws.rds#StorageQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#StorageTypeNotSupportedFault" + } + ], + "traits": { + "smithy.api#documentation": "

Amazon Relational Database Service (Amazon RDS) \n supports importing MySQL databases by using backup files. \n You can create a backup of your on-premises database, \n store it on Amazon Simple Storage Service (Amazon S3), \n and then restore the backup file onto a new Amazon RDS DB instance running MySQL.\n For more information, see Importing Data into an Amazon RDS MySQL DB Instance \n in the Amazon RDS User Guide.\n

\n

This operation doesn't apply to RDS Custom.

" + } + }, + "com.amazonaws.rds#RestoreDBInstanceFromS3Message": { + "type": "structure", + "members": { + "DBName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the database to create when the DB instance is created.\n Follow the naming rules specified in CreateDBInstance.

" + } + }, + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The DB instance identifier. This parameter is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Example: mydbinstance\n

", + "smithy.api#required": {} + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of storage (in gibibytes) to allocate initially for the DB instance.\n Follow the allocation rules specified in CreateDBInstance.

\n

This setting isn't valid for RDS for SQL Server.

\n \n

Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed.\n You can also allocate additional storage for future growth.

\n " + } + }, + "DBInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The compute and memory capacity of the DB instance, \n for example db.m4.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, \n or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.\n

\n

Importing from Amazon S3 isn't supported on the db.t2.micro DB instance class.

", + "smithy.api#required": {} + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the database engine to be used for this instance.

\n

Valid Values: \n mysql\n

", + "smithy.api#required": {} + } + }, + "MasterUsername": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name for the master user.

\n

Constraints:

\n
    \n
  • \n

    Must be 1 to 16 letters or numbers.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't be a reserved word for the chosen database engine.

    \n
    • \n
" + } + }, + "MasterUserPassword": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The password for the master user.

\n

Constraints:

\n
    \n
  • \n

    Can't be specified if ManageMasterUserPassword is turned on.

    \n
    • \n
  • \n

    Can include any printable ASCII character except \"/\", \"\"\", or \"@\". For RDS for Oracle, can't include the \"&\" (ampersand) or the \"'\" (single quotes) character.

    \n
    • \n
\n

Length Constraints:

\n
    \n
  • \n

    RDS for Db2 - Must contain from 8 to 128 characters.

    \n
    • \n
  • \n

    RDS for MariaDB - Must contain from 8 to 41 characters.

    \n
    • \n
  • \n

    RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.

    \n
    • \n
  • \n

    RDS for MySQL - Must contain from 8 to 41 characters.

    \n
    • \n
  • \n

    RDS for Oracle - Must contain from 8 to 30 characters.

    \n
    • \n
  • \n

    RDS for PostgreSQL - Must contain from 8 to 128 characters.

    \n
    • \n
" + } + }, + "DBSecurityGroups": { + "target": "com.amazonaws.rds#DBSecurityGroupNameList", + "traits": { + "smithy.api#documentation": "

A list of DB security groups to associate with this DB instance.

\n

Default: The default DB security group for the database engine.

" + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of VPC security groups to associate with this DB instance.

" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone that the DB instance is created in. \n For information about Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide.\n

\n

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

\n

Example: us-east-1d\n

\n

Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. \n The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.

" + } + }, + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A DB subnet group to associate with this DB instance.

\n

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

\n

Example: mydbsubnetgroup\n

" + } + }, + "PreferredMaintenanceWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The time range each week during which system maintenance can occur, \n in Universal Coordinated Time (UTC). \n For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.\n

\n

Constraints:

\n
    \n
  • \n

    Must be in the format ddd:hh24:mi-ddd:hh24:mi.

    \n
    • \n
  • \n

    Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must not conflict with the preferred backup window.

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \n
" + } + }, + "DBParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group to associate with this DB instance.

\n

If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup \n for the specified DB engine is used.

" + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days for which automated backups are retained. \n Setting this parameter to a positive number enables backups.\n For more information, see CreateDBInstance.

" + } + }, + "PreferredBackupWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The time range each day \n during which automated backups are created \n if automated backups are enabled. \n For more information, see Backup window in the Amazon RDS User Guide.\n

\n

Constraints:

\n
    \n
  • \n

    Must be in the format hh24:mi-hh24:mi.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must not conflict with the preferred maintenance window.

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \n
" + } + }, + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port number on which the database accepts connections.

\n

Type: Integer

\n

Valid Values: 1150-65535\n

\n

Default: 3306\n

" + } + }, + "MultiAZ": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the DB instance is a Multi-AZ deployment. \n If the DB instance is a Multi-AZ deployment, you can't set the AvailabilityZone parameter.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version number of the database engine to use.\n Choose the latest minor version of your database engine. \n For information about engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.

" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to automatically apply minor engine upgrades \n to the DB instance during the maintenance window. By default, minor engine upgrades \n are not applied automatically.

" + } + }, + "LicenseModel": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The license model for this DB instance.\n Use general-public-license.

" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) \n to allocate initially for the DB instance.\n For information about valid IOPS values, \n see Amazon RDS Provisioned IOPS storage \n in the Amazon RDS User Guide.\n

" + } + }, + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the option group to associate with this DB instance. \n If this argument is omitted, the default option group for the specified engine is used.

" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the DB instance is publicly accessible.

\n

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB instance's virtual private cloud (VPC). \n It resolves to the public IP address from outside of the DB instance's VPC. \n Access to the DB instance is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB instance doesn't permit it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBInstance.

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags to associate with this DB instance.\n For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.\n

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the storage type to be associated with the DB instance.

\n

Valid Values: gp2 | gp3 | io1 | io2 | standard\n

\n

If you specify io1, io2, or gp3, \n you must also include a value for the Iops parameter.

\n

Default: io1 \n if the Iops parameter is specified; \n otherwise gp2\n

" + } + }, + "StorageEncrypted": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the new DB instance is encrypted or not.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB instance.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

If the StorageEncrypted parameter is enabled, \n and you do not specify a value for the KmsKeyId parameter, \n then Amazon RDS will use your default KMS key. \n There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

" + } + }, + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

" + } + }, + "MonitoringInterval": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The interval, in seconds, \n between points when Enhanced Monitoring metrics are collected for the DB instance. \n To disable collecting Enhanced Monitoring metrics, specify 0.

\n

If MonitoringRoleArn is specified, \n then you must also set MonitoringInterval to a value other than 0.

\n

Valid Values: 0, 1, 5, 10, 15, 30, 60

\n

Default: 0\n

" + } + }, + "MonitoringRoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN for the IAM role that permits RDS \n to send enhanced monitoring metrics to Amazon CloudWatch Logs. \n For example, arn:aws:iam:123456789012:role/emaccess. \n For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring \n in the Amazon RDS User Guide.\n

\n

If MonitoringInterval is set to a value other than 0, \n then you must supply a MonitoringRoleArn value.

" + } + }, + "EnableIAMDatabaseAuthentication": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.

\n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

" + } + }, + "SourceEngine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the engine of your source database.

\n

Valid Values: \n mysql\n

", + "smithy.api#required": {} + } + }, + "SourceEngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The version of the database that the backup files were created from.

\n

MySQL versions 5.6 and 5.7 are supported.

\n

Example: 5.6.40\n

", + "smithy.api#required": {} + } + }, + "S3BucketName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of your Amazon S3 bucket \n that contains your database backup file.

", + "smithy.api#required": {} + } + }, + "S3Prefix": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The prefix of your Amazon S3 bucket.

" + } + }, + "S3IngestionRoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An Amazon Web Services Identity and Access Management (IAM) role with a trust policy and a permissions policy that allows Amazon RDS to access your Amazon S3 bucket. \n For information about this role,\n see \n Creating an IAM role manually in the Amazon RDS User Guide.\n

", + "smithy.api#required": {} + } + }, + "DatabaseInsightsMode": { + "target": "com.amazonaws.rds#DatabaseInsightsMode", + "traits": { + "smithy.api#documentation": "

Specifies the mode of Database Insights to enable for the DB instance.

\n

This setting only applies to Amazon Aurora DB instances.

\n \n

Currently, this value is inherited from the DB cluster and can't be changed.

\n " + } + }, + "EnablePerformanceInsights": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable Performance Insights for the DB instance.

\n

For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.

" + } + }, + "PerformanceInsightsKMSKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

" + } + }, + "PerformanceInsightsRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n
    \n
  • \n

    7

    \n
    • \n
  • \n

    \n month * 31, where month is a number of months from 1-23

    \n
    • \n
  • \n

    731

    \n
    • \n
\n

For example, the following values are valid:

\n
    \n
  • \n

    93 (3 months * 31)

    \n
    • \n
  • \n

    341 (11 months * 31)

    \n
    • \n
  • \n

    589 (19 months * 31)

    \n
    • \n
  • \n

    731

    \n
    • \n
\n

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

" + } + }, + "EnableCloudwatchLogsExports": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

The list of logs that the restored DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

" + } + }, + "ProcessorFeatures": { + "target": "com.amazonaws.rds#ProcessorFeatureList", + "traits": { + "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

" + } + }, + "UseDefaultProcessorFeatures": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the DB instance class of the DB instance uses its default\n processor features.

" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable deletion protection for the DB instance. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.

" + } + }, + "MaxAllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

\n

For more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.

" + } + }, + "NetworkType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid Values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" + } + }, + "StorageThroughput": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Specifies the storage throughput value for the DB instance.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora.

" + } + }, + "ManageMasterUserPassword": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.\n

\n

Constraints:

\n
    \n
  • \n

    Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword \n is specified.

    \n
    • \n
" + } + }, + "MasterUserSecretKmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and \n managed in Amazon Web Services Secrets Manager.

\n

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB instance.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager \n KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't \n use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer \n managed KMS key.

\n

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.

" + } + }, + "DedicatedLogVolume": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable a dedicated log volume (DLV) for the DB instance.

" + } + }, + "CACertificateIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The CA certificate identifier to use for the DB instance's server certificate.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

For more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.

" + } + }, + "EngineLifecycleSupport": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The life cycle type for this DB instance.

\n \n

By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. \n At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, \n RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date.

\n \n

You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, \n you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon RDS User Guide.

\n

This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.

\n

Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled\n

\n

Default: open-source-rds-extended-support\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#RestoreDBInstanceFromS3Result": { + "type": "structure", + "members": { + "DBInstance": { + "target": "com.amazonaws.rds#DBInstance" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#RestoreDBInstanceToPointInTime": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#RestoreDBInstanceToPointInTimeMessage" + }, + "output": { + "target": "com.amazonaws.rds#RestoreDBInstanceToPointInTimeResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#AuthorizationNotFoundFault" + }, + { + "target": "com.amazonaws.rds#BackupPolicyNotFoundFault" + }, + { + "target": "com.amazonaws.rds#CertificateNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceAutomatedBackupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DomainNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InstanceQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#InsufficientDBInstanceCapacityFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidRestoreFault" + }, + { + "target": "com.amazonaws.rds#InvalidSubnet" + }, + { + "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + }, + { + "target": "com.amazonaws.rds#NetworkTypeNotSupported" + }, + { + "target": "com.amazonaws.rds#OptionGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#PointInTimeRestoreNotEnabledFault" + }, + { + "target": "com.amazonaws.rds#ProvisionedIopsNotAvailableInAZFault" + }, + { + "target": "com.amazonaws.rds#StorageQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#StorageTypeNotSupportedFault" + }, + { + "target": "com.amazonaws.rds#TenantDatabaseQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.

\n

The target database is created with most of the original configuration, but in a\n system-selected Availability Zone, with the default security group, the default subnet\n group, and the default DB parameter group. By default, the new DB instance is created as\n a single-AZ deployment except when the instance is a SQL Server instance that has an\n option group that is associated with mirroring; in this case, the instance becomes a\n mirrored deployment and not a single-AZ deployment.

\n \n

This operation doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime.

\n ", + "smithy.api#examples": [ + { + "title": "To restore a DB instance to a point in time", + "documentation": "The following example restores test-instance to a new DB instance named restored-test-instance, as of the specified time.", + "input": { + "SourceDBInstanceIdentifier": "test-instance", + "TargetDBInstanceIdentifier": "restored-test-instance", + "RestoreTime": "2018-07-30T23:45:00.000Z" + }, + "output": { + "DBInstance": { + "PubliclyAccessible": true, + "MasterUsername": "mymasteruser", + "MonitoringInterval": 0, + "LicenseModel": "general-public-license", + "VpcSecurityGroups": [ + { + "Status": "active", + "VpcSecurityGroupId": "sg-e5e5b0d2" + } + ], + "CopyTagsToSnapshot": false, + "OptionGroupMemberships": [ + { + "Status": "in-sync", + "OptionGroupName": "default:mysql-5-6" + } + ], + "PendingModifiedValues": {}, + "Engine": "mysql", + "MultiAZ": false, + "DBSecurityGroups": [], + "DBParameterGroups": [ + { + "DBParameterGroupName": "default.mysql5.6", + "ParameterApplyStatus": "in-sync" + } + ], + "AutoMinorVersionUpgrade": true, + "PreferredBackupWindow": "12:58-13:28", + "DBSubnetGroup": { + "Subnets": [ + { + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-77e8db03", + "SubnetAvailabilityZone": { + "Name": "us-west-2a" + } + }, + { + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-c39989a1", + "SubnetAvailabilityZone": { + "Name": "us-west-2b" + } + }, + { + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-4b267b0d", + "SubnetAvailabilityZone": { + "Name": "us-west-2c" + } + } + ], + "DBSubnetGroupName": "default", + "VpcId": "vpc-c1c5b3a3", + "DBSubnetGroupDescription": "default", + "SubnetGroupStatus": "Complete" + }, + "ReadReplicaDBInstanceIdentifiers": [], + "AllocatedStorage": 200, + "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:restored-test-instance", + "BackupRetentionPeriod": 7, + "DBName": "sample", + "PreferredMaintenanceWindow": "tue:10:16-tue:10:46", + "DBInstanceStatus": "available", + "EngineVersion": "5.6.27", + "AvailabilityZone": "us-west-2b", + "DomainMemberships": [], + "StorageType": "gp2", + "DbiResourceId": "db-VNZUCCBTEDC4WR7THXNJO72HVQ", + "CACertificateIdentifier": "rds-ca-2015", + "StorageEncrypted": false, + "DBInstanceClass": "db.t2.small", + "DbInstancePort": 0, + "DBInstanceIdentifier": "restored-test-instance" + } + } + } + ] + } + }, + "com.amazonaws.rds#RestoreDBInstanceToPointInTimeMessage": { + "type": "structure", + "members": { + "SourceDBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the source DB instance from which to restore.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DB instance.

    \n
    • \n
" + } + }, + "TargetDBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the new DB instance to create.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "RestoreTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The date and time to restore from.

\n

Constraints:

\n
    \n
  • \n

    Must be a time in Universal Coordinated Time (UTC) format.

    \n
    • \n
  • \n

    Must be before the latest restorable time for the DB instance.

    \n
    • \n
  • \n

    Can't be specified if the UseLatestRestorableTime parameter is enabled.

    \n
    • \n
\n

Example: 2009-09-07T23:45:00Z\n

" + } + }, + "UseLatestRestorableTime": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the DB instance is restored from the latest backup time. By default, the DB instance \n isn't restored from the latest backup time.

\n

Constraints:

\n
    \n
  • \n

    Can't be specified if the RestoreTime parameter is provided.

    \n
    • \n
" + } + }, + "DBInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The compute and memory capacity of the Amazon RDS DB instance, for example\n db.m4.large. Not all DB instance classes are available in all Amazon Web Services\n Regions, or for all database engines. For the full list of DB instance classes, and\n availability for your engine, see DB Instance\n Class in the Amazon RDS User Guide.

\n

Default: The same DB instance class as the original DB instance.

" + } + }, + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port number on which the database accepts connections.

\n

Default: The same port as the original DB instance.

\n

Constraints:

\n
    \n
  • \n

    The value must be 1150-65535.

    \n
    • \n
" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone (AZ) where the DB instance will be created.

\n

Default: A random, system-chosen Availability Zone.

\n

Constraints:

\n
    \n
  • \n

    You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

    \n
    • \n
\n

Example: us-east-1a\n

" + } + }, + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB subnet group name to use for the new instance.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DB subnet group.

    \n
    • \n
\n

Example: mydbsubnetgroup\n

" + } + }, + "MultiAZ": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Secifies whether the DB instance is a Multi-AZ deployment.

\n

This setting doesn't apply to RDS Custom.

\n

Constraints:

\n
    \n
  • \n

    You can't specify the AvailabilityZone parameter if the DB instance is a \n Multi-AZ deployment.

    \n
    • \n
" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the DB instance is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBInstance.

" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether minor version upgrades are applied automatically to the \n DB instance during the maintenance window.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "LicenseModel": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The license model information for the restored DB instance.

\n \n

License models for RDS for Db2 require additional configuration. The Bring Your\n Own License (BYOL) model requires a custom parameter group and an Amazon Web Services License Manager self-managed license. The Db2 license through\n Amazon Web Services Marketplace model requires an Amazon Web Services Marketplace subscription. For more\n information, see Amazon RDS for Db2 licensing\n options in the Amazon RDS User Guide.

\n \n

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

\n

Valid Values:

\n
    \n
  • \n

    RDS for Db2 - bring-your-own-license | marketplace-license\n

    \n
    • \n
  • \n

    RDS for MariaDB - general-public-license\n

    \n
    • \n
  • \n

    RDS for Microsoft SQL Server - license-included\n

    \n
    • \n
  • \n

    RDS for MySQL - general-public-license\n

    \n
    • \n
  • \n

    RDS for Oracle - bring-your-own-license | license-included\n

    \n
    • \n
  • \n

    RDS for PostgreSQL - postgresql-license\n

    \n
    • \n
\n

Default: Same as the source.

" + } + }, + "DBName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The database name for the restored DB instance.

\n

This parameter doesn't apply to the following DB instances:

\n
    \n
  • \n

    RDS Custom

    \n
    • \n
  • \n

    RDS for Db2

    \n
    • \n
  • \n

    RDS for MariaDB

    \n
    • \n
  • \n

    RDS for MySQL

    \n
    • \n
" + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The database engine to use for the new instance.

\n

This setting doesn't apply to RDS Custom.

\n

Valid Values:

\n
    \n
  • \n

    \n db2-ae\n

    \n
    • \n
  • \n

    \n db2-se\n

    \n
    • \n
  • \n

    \n mariadb\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n oracle-ee\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n oracle-se2\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
  • \n

    \n sqlserver-ee\n

    \n
    • \n
  • \n

    \n sqlserver-se\n

    \n
    • \n
  • \n

    \n sqlserver-ex\n

    \n
    • \n
  • \n

    \n sqlserver-web\n

    \n
    • \n
\n

Default: The same as source

\n

Constraints:

\n
    \n
  • \n

    Must be compatible with the engine of the source.

    \n
    • \n
" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance.

\n

This setting doesn't apply to SQL Server.

\n

Constraints:

\n
    \n
  • \n

    Must be an integer greater than 1000.

    \n
    • \n
" + } + }, + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the option group to use for the restored DB instance.

\n

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an \n option group, and that option group can't be removed from a DB instance after it is associated with a DB instance

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The storage type to associate with the DB instance.

\n

Valid Values: gp2 | gp3 | io1 | io2 | standard\n

\n

Default: io1, if the Iops parameter\n is specified. Otherwise, gp2.

\n

Constraints:

\n
    \n
  • \n

    If you specify io1, io2, or gp3, you must also include a value for the\n Iops parameter.

    \n
    • \n
" + } + }, + "TdeCredentialArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN from the key store with which to associate the instance for TDE encryption.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "TdeCredentialPassword": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The password for the given ARN from the key store in order to access the device.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of EC2 VPC security groups to associate with this DB instance.

\n

Default: The default EC2 VPC security group for the DB subnet group's VPC.

" + } + }, + "Domain": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Active Directory directory ID to restore the DB instance in.\n Create the domain before running this command. Currently, you can create only the MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.

\n

This setting doesn't apply to RDS Custom.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

" + } + }, + "DomainIAMRoleName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the IAM role to use when making API calls to the Directory Service.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "DomainFqdn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The fully qualified domain name (FQDN) of an Active Directory domain.

\n

Constraints:

\n
    \n
  • \n

    Can't be longer than 64 characters.

    \n
    • \n
\n

Example: mymanagedADtest.mymanagedAD.mydomain\n

" + } + }, + "DomainOu": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Active Directory organizational unit for your DB instance to join.

\n

Constraints:

\n
    \n
  • \n

    Must be in the distinguished name format.

    \n
    • \n
  • \n

    Can't be longer than 64 characters.

    \n
    • \n
\n

Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain\n

" + } + }, + "DomainAuthSecretArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN for the Secrets Manager secret with the credentials for the user joining the domain.

\n

Constraints:

\n
    \n
  • \n

    Can't be longer than 64 characters.

    \n
    • \n
\n

Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456\n

" + } + }, + "DomainDnsIps": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.

\n

Constraints:

\n
    \n
  • \n

    Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.

    \n
    • \n
\n

Example: 123.124.125.126,234.235.236.237\n

" + } + }, + "EnableIAMDatabaseAuthentication": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.

\n

This setting doesn't apply to RDS Custom.

\n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

" + } + }, + "EnableCloudwatchLogsExports": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

The list of logs that the restored DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "ProcessorFeatures": { + "target": "com.amazonaws.rds#ProcessorFeatureList", + "traits": { + "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "UseDefaultProcessorFeatures": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the DB instance class of the DB instance uses its default processor features.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "DBParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group to associate with this DB instance.

\n

If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup \n for the specified DB engine is used.

\n

This setting doesn't apply to RDS Custom.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DB parameter group.

    \n
    • \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.

" + } + }, + "SourceDbiResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The resource ID of the source DB instance from which to restore.

" + } + }, + "MaxAllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

\n

For more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "SourceDBInstanceAutomatedBackupsArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, \n arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "EnableCustomerOwnedIp": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

This setting doesn't apply to RDS Custom.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" + } + }, + "CustomIamInstanceProfile": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:

\n
    \n
  • \n

    The profile must exist in your account.

    \n
    • \n
  • \n

    The profile must have an IAM role that Amazon EC2 has permissions to assume.

    \n
    • \n
  • \n

    The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

    \n
    • \n
\n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.

\n

This setting is required for RDS Custom.

" + } + }, + "BackupTarget": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The location for storing automated backups and manual snapshots for the restored DB instance.

\n

Valid Values:

\n
    \n
  • \n

    \n outposts (Amazon Web Services Outposts)

    \n
    • \n
  • \n

    \n region (Amazon Web Services Region)

    \n
    • \n
\n

Default: region\n

\n

For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

" + } + }, + "NetworkType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The network type of the DB instance.

\n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

\n

Valid Values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
" + } + }, + "StorageThroughput": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The storage throughput value for the DB instance.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora.

" + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of storage (in gibibytes) to allocate initially for the DB instance.\n Follow the allocation rules specified in CreateDBInstance.

\n

This setting isn't valid for RDS for SQL Server.

\n \n

Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed.\n You can also allocate additional storage for future growth.

\n " + } + }, + "DedicatedLogVolume": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable a dedicated log volume (DLV) for the DB instance.

" + } + }, + "CACertificateIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The CA certificate identifier to use for the DB instance's server certificate.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

For more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.

" + } + }, + "EngineLifecycleSupport": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The life cycle type for this DB instance.

\n \n

By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. \n At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, \n RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date.

\n \n

You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, \n you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon RDS User Guide.

\n

This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.

\n

Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled\n

\n

Default: open-source-rds-extended-support\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#RestoreDBInstanceToPointInTimeResult": { + "type": "structure", + "members": { + "DBInstance": { + "target": "com.amazonaws.rds#DBInstance" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#RestoreWindow": { + "type": "structure", + "members": { + "EarliestTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The earliest time you can restore an instance to.

" + } + }, + "LatestTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The latest time you can restore an instance to.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Earliest and latest time an instance can be restored to:

" + } + }, + "com.amazonaws.rds#RevokeDBSecurityGroupIngress": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#RevokeDBSecurityGroupIngressMessage" + }, + "output": { + "target": "com.amazonaws.rds#RevokeDBSecurityGroupIngressResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#AuthorizationNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSecurityGroupStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC security groups. Required \n parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either \n EC2SecurityGroupName or EC2SecurityGroupId).

\n \n

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – \n Here’s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

\n ", + "smithy.api#examples": [ + { + "title": "To revoke ingress for a DB security group", + "documentation": "This example revokes ingress for the specified CIDR block associated with the specified DB security group.", + "input": { + "DBSecurityGroupName": "mydbsecuritygroup", + "CIDRIP": "203.0.113.5/32" + }, + "output": { + "DBSecurityGroup": {} + } + } + ] + } + }, + "com.amazonaws.rds#RevokeDBSecurityGroupIngressMessage": { + "type": "structure", + "members": { + "DBSecurityGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the DB security group to revoke ingress from.

", + "smithy.api#required": {} + } + }, + "CIDRIP": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The IP range to revoke access from. \n Must be a valid CIDR range. If CIDRIP is specified, \n EC2SecurityGroupName, EC2SecurityGroupId and EC2SecurityGroupOwnerId\n can't be provided.

" + } + }, + "EC2SecurityGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the EC2 security group to revoke access from.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" + } + }, + "EC2SecurityGroupId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The id of the EC2 security group to revoke access from.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" + } + }, + "EC2SecurityGroupOwnerId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account number of the owner of the EC2 security group\n specified in the EC2SecurityGroupName parameter.\n The Amazon Web Services access key ID isn't an acceptable value.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#RevokeDBSecurityGroupIngressResult": { + "type": "structure", + "members": { + "DBSecurityGroup": { + "target": "com.amazonaws.rds#DBSecurityGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#SNSInvalidTopicFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SNSInvalidTopic", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

SNS has responded that there is a problem with the SNS topic specified.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#SNSNoAuthorizationFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SNSNoAuthorization", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

You do not have permission to publish to the SNS topic ARN.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#SNSTopicArnNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SNSTopicArnNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The SNS topic ARN does not exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#ScalarReferenceDetails": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.rds#Double", + "traits": { + "smithy.api#documentation": "

The value of a scalar reference.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The metric reference details when the reference is a scalar.

" + } + }, + "com.amazonaws.rds#ScalingConfiguration": { + "type": "structure", + "members": { + "MinCapacity": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The minimum capacity for an Aurora DB cluster in serverless DB engine mode.

\n

For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

\n

For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

\n

The minimum capacity must be less than or equal to the maximum capacity.

" + } + }, + "MaxCapacity": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

\n

For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

\n

For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

\n

The maximum capacity must be greater than or equal to the minimum capacity.

" + } + }, + "AutoPause": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode.\n A DB cluster can be paused only when it's idle (it has no connections).

\n \n

If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot.\n In this case, the DB cluster is restored when there is a request to connect to it.

\n " + } + }, + "SecondsUntilAutoPause": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The time, in seconds, before an Aurora DB cluster in serverless mode is paused.

\n

Specify a value between 300 and 86,400 seconds.

" + } + }, + "TimeoutAction": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.

\n

\n ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.

\n

\n RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.

\n \n

If you specify ForceApplyCapacityChange, connections that\n prevent Aurora Serverless v1 from finding a scaling point might be dropped.

\n \n

For more information, see \n Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.

" + } + }, + "SecondsBeforeTimeout": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point\n to perform seamless scaling before enforcing the timeout action. The default is 300.

\n

Specify a value between 60 and 600 seconds.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the scaling configuration of an Aurora Serverless v1 DB cluster.

\n

For more information, see Using Amazon Aurora Serverless v1 in the\n Amazon Aurora User Guide.

" + } + }, + "com.amazonaws.rds#ScalingConfigurationInfo": { + "type": "structure", + "members": { + "MinCapacity": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The minimum capacity for an Aurora DB cluster in serverless DB engine mode.

" + } + }, + "MaxCapacity": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

" + } + }, + "AutoPause": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether automatic pause is allowed for the Aurora DB cluster\n in serverless DB engine mode.

\n

When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.

" + } + }, + "SecondsUntilAutoPause": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The remaining amount of time, in seconds, before the Aurora DB cluster in\n serverless mode is paused. A DB cluster can be paused only when\n it's idle (it has no connections).

" + } + }, + "TimeoutAction": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The action that occurs when Aurora times out while attempting to change the capacity of an\n Aurora Serverless v1 cluster. The value is either ForceApplyCapacityChange or\n RollbackCapacityChange.

\n

\n ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.

\n

\n RollbackCapacityChange ignores the capacity change if a scaling point isn't found in the timeout period.

" + } + }, + "SecondsBeforeTimeout": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of seconds before scaling times out. What happens when an attempted scaling action times out\n is determined by the TimeoutAction setting.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The scaling configuration for an Aurora DB cluster in serverless DB engine mode.

\n

For more information, see Using Amazon Aurora Serverless v1 in the\n Amazon Aurora User Guide.

" + } + }, + "com.amazonaws.rds#SensitiveString": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.rds#ServerlessV2FeaturesSupport": { + "type": "structure", + "members": { + "MinCapacity": { + "target": "com.amazonaws.rds#DoubleOptional", + "traits": { + "smithy.api#documentation": "

If the minimum capacity is 0 ACUs, the engine version supports the automatic pause/resume\n feature of Aurora Serverless v2.

" + } + }, + "MaxCapacity": { + "target": "com.amazonaws.rds#DoubleOptional", + "traits": { + "smithy.api#documentation": "

\n Specifies the upper Aurora Serverless v2 capacity limit for a particular engine version.\n Depending on the engine version, the maximum capacity for an Aurora Serverless v2 cluster might be\n 256 or 128.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies any Aurora Serverless v2 properties or limits that differ between Aurora engine versions.\n You can test the values of this attribute when deciding which Aurora version to use in a new or upgraded\n DB cluster. You can also retrieve the version of an existing DB cluster and check whether that version\n supports certain Aurora Serverless v2 features before you attempt to use those features.\n

" + } + }, + "com.amazonaws.rds#ServerlessV2ScalingConfiguration": { + "type": "structure", + "members": { + "MinCapacity": { + "target": "com.amazonaws.rds#DoubleOptional", + "traits": { + "smithy.api#documentation": "

The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster.\n You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on.\n For Aurora versions that support the Aurora Serverless v2 auto-pause feature, the smallest value that you can use is 0.\n For versions that don't support Aurora Serverless v2 auto-pause, the smallest value that you can use is 0.5.\n

" + } + }, + "MaxCapacity": { + "target": "com.amazonaws.rds#DoubleOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster.\n You can specify ACU values in half-step increments, such as 32, 32.5, 33, and so on. The largest value\n that you can use is 256 for recent Aurora versions, or 128 for older versions.

" + } + }, + "SecondsUntilAutoPause": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Specifies the number of seconds an Aurora Serverless v2 DB instance must be idle before\n Aurora attempts to automatically pause it.\n

\n

Specify a value between 300 seconds (five minutes) and 86,400 seconds (one day). The default is 300 seconds.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the scaling configuration of an Aurora Serverless v2 DB cluster.

\n

For more information, see Using Amazon Aurora Serverless v2 in the\n Amazon Aurora User Guide.

" + } + }, + "com.amazonaws.rds#ServerlessV2ScalingConfigurationInfo": { + "type": "structure", + "members": { + "MinCapacity": { + "target": "com.amazonaws.rds#DoubleOptional", + "traits": { + "smithy.api#documentation": "

The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster.\n You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on.\n For Aurora versions that support the Aurora Serverless v2 auto-pause feature, the smallest value that you can use is 0.\n For versions that don't support Aurora Serverless v2 auto-pause, the smallest value that you can use is 0.5.\n

" + } + }, + "MaxCapacity": { + "target": "com.amazonaws.rds#DoubleOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster.\n You can specify ACU values in half-step increments, such as 32, 32.5, 33, and so on. The largest value\n that you can use is 256 for recent Aurora versions, or 128 for older versions.

" + } + }, + "SecondsUntilAutoPause": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

\n The number of seconds an Aurora Serverless v2 DB instance must be idle before\n Aurora attempts to automatically pause it.\n This property is only shown when the minimum capacity for the cluster is set to 0 ACUs.\n Changing the minimum capacity to a nonzero value removes this property. If you later\n change the minimum capacity back to 0 ACUs, this property is reset to its default value\n unless you specify it again.\n

\n

This value ranges between 300 seconds (five minutes) and 86,400 seconds (one day). The default is 300 seconds.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The scaling configuration for an Aurora Serverless v2 DB cluster.

\n

For more information, see Using Amazon Aurora Serverless v2 in the\n Amazon Aurora User Guide.

" + } + }, + "com.amazonaws.rds#SharedSnapshotQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SharedSnapshotQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#SnapshotQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SnapshotQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request would result in the user exceeding the allowed number of DB\n snapshots.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#SourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:rds(-[a-z]*)?:[a-z0-9\\-]*:[0-9]*:(cluster|db):[a-z][a-z0-9]*(-[a-z0-9]+)*$" + } + }, + "com.amazonaws.rds#SourceClusterNotSupportedFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SourceClusterNotSupportedFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The source DB cluster isn't supported for a blue/green deployment.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#SourceDatabaseNotSupportedFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SourceDatabaseNotSupportedFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The source DB instance isn't supported for a blue/green deployment.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#SourceIdsList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#xmlName": "SourceId" + } + } + }, + "com.amazonaws.rds#SourceNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SourceNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The requested source could not be found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#SourceRegion": { + "type": "structure", + "members": { + "RegionName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the source Amazon Web Services Region.

" + } + }, + "Endpoint": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The endpoint for the source Amazon Web Services Region endpoint.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The status of the source Amazon Web Services Region.

" + } + }, + "SupportsDBInstanceAutomatedBackupsReplication": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the source Amazon Web Services Region supports replicating automated backups to the current Amazon Web Services Region.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains an Amazon Web Services Region name as the result of a successful call to the DescribeSourceRegions action.

" + } + }, + "com.amazonaws.rds#SourceRegionList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#SourceRegion", + "traits": { + "smithy.api#xmlName": "SourceRegion" + } + } + }, + "com.amazonaws.rds#SourceRegionMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "SourceRegions": { + "target": "com.amazonaws.rds#SourceRegionList", + "traits": { + "smithy.api#documentation": "

A list of SourceRegion instances that contains each source Amazon Web Services Region that the\n current Amazon Web Services Region can get a read replica or a DB snapshot from.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeSourceRegions action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#SourceType": { + "type": "enum", + "members": { + "db_instance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "db-instance" + } + }, + "db_parameter_group": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "db-parameter-group" + } + }, + "db_security_group": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "db-security-group" + } + }, + "db_snapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "db-snapshot" + } + }, + "db_cluster": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "db-cluster" + } + }, + "db_cluster_snapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "db-cluster-snapshot" + } + }, + "custom_engine_version": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "custom-engine-version" + } + }, + "db_proxy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "db-proxy" + } + }, + "blue_green_deployment": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "blue-green-deployment" + } + } + } + }, + "com.amazonaws.rds#StartActivityStream": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#StartActivityStreamRequest" + }, + "output": { + "target": "com.amazonaws.rds#StartActivityStreamResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + }, + { + "target": "com.amazonaws.rds#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Starts a database activity stream to monitor activity on the database.\n For more information, see \n \n Monitoring Amazon Aurora with Database Activity Streams\n in the Amazon Aurora User Guide or\n \n Monitoring Amazon RDS with Database Activity Streams\n in the Amazon RDS User Guide.

", + "smithy.api#examples": [ + { + "title": "To start a database activity stream", + "documentation": "The following example starts an asynchronous activity stream to monitor an Aurora cluster named my-pg-cluster.", + "input": { + "ResourceArn": "arn:aws:rds:us-east-1:1234567890123:cluster:my-pg-cluster", + "Mode": "async", + "KmsKeyId": "arn:aws:kms:us-east-1:1234567890123:key/a12c345d-6ef7-890g-h123-456i789jk0l1", + "ApplyImmediately": true + }, + "output": { + "KmsKeyId": "arn:aws:kms:us-east-1:1234567890123:key/a12c345d-6ef7-890g-h123-456i789jk0l1", + "KinesisStreamName": "aws-rds-das-cluster-0ABCDEFGHI1JKLM2NOPQ3R4S", + "Status": "starting", + "Mode": "async", + "ApplyImmediately": true + } + } + ] + } + }, + "com.amazonaws.rds#StartActivityStreamRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the DB cluster,\n for example, arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.

", + "smithy.api#required": {} + } + }, + "Mode": { + "target": "com.amazonaws.rds#ActivityStreamMode", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies the mode of the database activity stream.\n Database events such as a change or access generate an activity stream event.\n The database session can handle these events either synchronously or asynchronously.

", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encrypting messages in the database activity stream.\n The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

", + "smithy.api#required": {} + } + }, + "ApplyImmediately": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether or not the database activity stream is to start as soon as possible, \n regardless of the maintenance window for the database.

" + } + }, + "EngineNativeAuditFieldsIncluded": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the database activity stream includes engine-native audit fields. This option applies\n to an Oracle or Microsoft SQL Server DB instance. By default, no engine-native audit fields are included.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#StartActivityStreamResponse": { + "type": "structure", + "members": { + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of messages in the database activity stream.

" + } + }, + "KinesisStreamName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Kinesis data stream to be used for the database activity stream.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#ActivityStreamStatus", + "traits": { + "smithy.api#documentation": "

The status of the database activity stream.

" + } + }, + "Mode": { + "target": "com.amazonaws.rds#ActivityStreamMode", + "traits": { + "smithy.api#documentation": "

The mode of the database activity stream.

" + } + }, + "ApplyImmediately": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether or not the database activity stream will start as soon as possible, \n regardless of the maintenance window for the database.

" + } + }, + "EngineNativeAuditFieldsIncluded": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether engine-native audit fields are included in the database activity stream.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#StartDBCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#StartDBClusterMessage" + }, + "output": { + "target": "com.amazonaws.rds#StartDBClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster\n CLI command, or the StopDBCluster operation.

\n

For more information, see \n \n Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.

\n \n

This operation only applies to Aurora DB clusters.

\n ", + "smithy.api#examples": [ + { + "title": "To start a DB cluster", + "documentation": "The following example starts a DB cluster and its DB instances.", + "input": { + "DBClusterIdentifier": "mydbcluster" + }, + "output": { + "DBCluster": { + "AllocatedStorage": 1, + "AvailabilityZones": [ + "us-east-1a", + "us-east-1e", + "us-east-1b" + ], + "BackupRetentionPeriod": 1, + "DatabaseName": "mydb", + "DBClusterIdentifier": "mydbcluster" + } + } + } + ] + } + }, + "com.amazonaws.rds#StartDBClusterMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The DB cluster identifier of the Amazon Aurora DB cluster to be started. This parameter is stored as\n a lowercase string.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#StartDBClusterResult": { + "type": "structure", + "members": { + "DBCluster": { + "target": "com.amazonaws.rds#DBCluster" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#StartDBInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#StartDBInstanceMessage" + }, + "output": { + "target": "com.amazonaws.rds#StartDBInstanceResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#AuthorizationNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InsufficientDBInstanceCapacityFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidSubnet" + }, + { + "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + } + ], + "traits": { + "smithy.api#documentation": "

Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance operation.

\n

For more information, see \n \n Starting an Amazon RDS DB instance That Was Previously Stopped in the \n Amazon RDS User Guide.\n

\n \n

This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.\n For Aurora DB clusters, use StartDBCluster instead.

\n ", + "smithy.api#examples": [ + { + "title": "To start a DB instance", + "documentation": "The following example starts the specified DB instance.", + "input": { + "DBInstanceIdentifier": "test-instance" + }, + "output": { + "DBInstance": { + "DBInstanceStatus": "starting" + } + } + } + ] + } + }, + "com.amazonaws.rds#StartDBInstanceAutomatedBackupsReplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#StartDBInstanceAutomatedBackupsReplicationMessage" + }, + "output": { + "target": "com.amazonaws.rds#StartDBInstanceAutomatedBackupsReplicationResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceAutomatedBackupQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + }, + { + "target": "com.amazonaws.rds#StorageTypeNotSupportedFault" + } + ], + "traits": { + "smithy.api#documentation": "

Enables replication of automated backups to a different Amazon Web Services Region.

\n

This command doesn't apply to RDS Custom.

\n

For more information, see \n Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.\n

", + "smithy.api#examples": [ + { + "title": "To enable cross-Region automated backups", + "documentation": "The following example replicates automated backups from a DB instance in the US East (N. Virginia) Region. The backup retention period is 14 days.", + "input": { + "SourceDBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db", + "BackupRetentionPeriod": 14 + }, + "output": { + "DBInstanceAutomatedBackup": { + "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db", + "DbiResourceId": "db-JKIB2GFQ5RV7REPLZA4EXAMPLE", + "Region": "us-east-1", + "DBInstanceIdentifier": "new-orcl-db", + "RestoreWindow": {}, + "AllocatedStorage": 20, + "Status": "pending", + "Port": 1521, + "InstanceCreateTime": "2020-12-04T15:28:31Z", + "MasterUsername": "admin", + "Engine": "oracle-se2", + "EngineVersion": "12.1.0.2.v21", + "LicenseModel": "bring-your-own-license", + "OptionGroupName": "default:oracle-se2-12-1", + "Encrypted": false, + "StorageType": "gp2", + "IAMDatabaseAuthenticationEnabled": false, + "BackupRetentionPeriod": 14, + "DBInstanceAutomatedBackupsArn": "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example" + } + } + } + ] + } + }, + "com.amazonaws.rds#StartDBInstanceAutomatedBackupsReplicationMessage": { + "type": "structure", + "members": { + "SourceDBInstanceArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source DB instance for the replicated automated backups, for example, \n arn:aws:rds:us-west-2:123456789012:db:mydatabase.

", + "smithy.api#required": {} + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The retention period for the replicated automated backups.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of the replicated automated backups. The KMS key ID is the\n Amazon Resource Name (ARN) for the KMS encryption key in the destination Amazon Web Services Region, for example, \n arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE.

" + } + }, + "PreSignedUrl": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

In an Amazon Web Services GovCloud (US) Region, an URL that contains a Signature Version 4 signed request \n for the StartDBInstanceAutomatedBackupsReplication operation to call \n in the Amazon Web Services Region of the source DB instance. The presigned URL must be a valid request for the\n StartDBInstanceAutomatedBackupsReplication API operation that can run in \n the Amazon Web Services Region that contains the source DB instance.

\n

This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other\n Amazon Web Services Regions.

\n

To learn how to generate a Signature Version 4 signed request, see \n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can run in the source Amazon Web Services Region.

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#StartDBInstanceAutomatedBackupsReplicationResult": { + "type": "structure", + "members": { + "DBInstanceAutomatedBackup": { + "target": "com.amazonaws.rds#DBInstanceAutomatedBackup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#StartDBInstanceMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The user-supplied instance identifier.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#StartDBInstanceResult": { + "type": "structure", + "members": { + "DBInstance": { + "target": "com.amazonaws.rds#DBInstance" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#StartExportTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#StartExportTaskMessage" + }, + "output": { + "target": "com.amazonaws.rds#ExportTask" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.rds#ExportTaskAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#IamRoleMissingPermissionsFault" + }, + { + "target": "com.amazonaws.rds#IamRoleNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidExportOnlyFault" + }, + { + "target": "com.amazonaws.rds#InvalidExportSourceStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidS3BucketFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + } + ], + "traits": { + "smithy.api#documentation": "

Starts an export of DB snapshot or DB cluster data to Amazon S3. \n The provided IAM role must have access to the S3 bucket.

\n

You can't export snapshot data from Db2 or RDS Custom DB instances.

\n

For more information on exporting DB snapshot data, see \n Exporting DB snapshot \n data to Amazon S3 in the Amazon RDS User Guide\n or Exporting DB \n cluster snapshot data to Amazon S3 in the Amazon Aurora User Guide.

\n

For more information on exporting DB cluster data, see \n Exporting DB \n cluster data to Amazon S3 in the Amazon Aurora User Guide.

", + "smithy.api#examples": [ + { + "title": "To export a snapshot to Amazon S3", + "documentation": "The following example exports a DB snapshot named db5-snapshot-test to the Amazon S3 bucket named mybucket.", + "input": { + "ExportTaskIdentifier": "my-s3-export", + "SourceArn": "arn:aws:rds:us-west-2:123456789012:snapshot:db5-snapshot-test", + "S3BucketName": "mybucket", + "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/ExportRole", + "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff" + }, + "output": { + "ExportTaskIdentifier": "my-s3-export", + "SourceArn": "arn:aws:rds:us-west-2:123456789012:snapshot:db5-snapshot-test", + "SnapshotTime": "2020-03-27T20:48:42.023Z", + "S3Bucket": "mybucket", + "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/ExportRole", + "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff", + "Status": "STARTING", + "PercentProgress": 0, + "TotalExtractedDataInGB": 0 + } + } + ] + } + }, + "com.amazonaws.rds#StartExportTaskMessage": { + "type": "structure", + "members": { + "ExportTaskIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A unique identifier for the export task. This ID isn't an identifier for\n the Amazon S3 bucket where the data is to be exported.

", + "smithy.api#required": {} + } + }, + "SourceArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the snapshot or cluster to export to Amazon S3.

", + "smithy.api#required": {} + } + }, + "S3BucketName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Amazon S3 bucket to export the snapshot or cluster data to.

", + "smithy.api#required": {} + } + }, + "IamRoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the IAM role to use for writing to the Amazon S3 bucket \n when exporting a snapshot or cluster.

\n

In the IAM policy attached to your IAM role, include the following required actions to allow the transfer of files from Amazon\n RDS or Amazon Aurora to an S3 bucket:

\n
    \n
  • \n

    s3:PutObject*

    \n
    • \n
  • \n

    s3:GetObject*

    \n
    • \n
  • \n

    s3:ListBucket

    \n
    • \n
  • \n

    s3:DeleteObject*

    \n
    • \n
  • \n

    s3:GetBucketLocation

    \n
    • \n
\n

In the policy, include the resources to identify the S3 bucket and objects in the bucket. The following list of resources shows\n the Amazon Resource Name (ARN) format for accessing S3:

\n
    \n
  • \n

    \n arn:aws:s3:::your-s3-bucket\n \n

    \n
    • \n
  • \n

    \n arn:aws:s3:::your-s3-bucket/*\n

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Amazon Web Services KMS key to use to encrypt the data exported to Amazon S3. The Amazon Web Services KMS \n key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. \n The caller of this operation must be authorized to run the following operations. \n These can be set in the Amazon Web Services KMS key policy:

\n
    \n
  • \n

    kms:Encrypt

    \n
    • \n
  • \n

    kms:Decrypt

    \n
    • \n
  • \n

    kms:GenerateDataKey

    \n
    • \n
  • \n

    kms:GenerateDataKeyWithoutPlaintext

    \n
    • \n
  • \n

    kms:ReEncryptFrom

    \n
    • \n
  • \n

    kms:ReEncryptTo

    \n
    • \n
  • \n

    kms:CreateGrant

    \n
    • \n
  • \n

    kms:DescribeKey

    \n
    • \n
  • \n

    kms:RetireGrant

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "S3Prefix": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon S3 bucket prefix to use as the file name and path of the exported data.

" + } + }, + "ExportOnly": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The data to be exported from the snapshot or cluster. \n If this parameter isn't provided, all of the data is exported.

\n

Valid Values:

\n
    \n
  • \n

    \n database - Export all the data from a specified database.

    \n
    • \n
  • \n

    \n database.table\n table-name - \n Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.

    \n
    • \n
  • \n

    \n database.schema\n schema-name - Export a database schema of the snapshot or cluster. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

    \n
    • \n
  • \n

    \n database.schema.table\n table-name - Export a table of the database schema. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#StopActivityStream": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#StopActivityStreamRequest" + }, + "output": { + "target": "com.amazonaws.rds#StopActivityStreamResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Stops a database activity stream that was started using the Amazon Web Services console, \n the start-activity-stream CLI command, or the StartActivityStream operation.

\n

For more information, see \n \n Monitoring Amazon Aurora with Database Activity Streams\n in the Amazon Aurora User Guide\n or \n Monitoring Amazon RDS with Database Activity Streams\n in the Amazon RDS User Guide.

", + "smithy.api#examples": [ + { + "title": "To stop a database activity stream", + "documentation": "The following example stops an activity stream in an Aurora cluster named my-pg-cluster.", + "input": { + "ResourceArn": "arn:aws:rds:us-east-1:1234567890123:cluster:my-pg-cluster", + "ApplyImmediately": true + }, + "output": { + "KmsKeyId": "arn:aws:kms:us-east-1:1234567890123:key/a12c345d-6ef7-890g-h123-456i789jk0l1", + "KinesisStreamName": "aws-rds-das-cluster-0ABCDEFGHI1JKLM2NOPQ3R4S", + "Status": "stopping" + } + } + ] + } + }, + "com.amazonaws.rds#StopActivityStreamRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the DB cluster for the database activity stream.\n For example, arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.

", + "smithy.api#required": {} + } + }, + "ApplyImmediately": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether or not the database activity stream is to stop as soon as possible, \n regardless of the maintenance window for the database.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#StopActivityStreamResponse": { + "type": "structure", + "members": { + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" + } + }, + "KinesisStreamName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Kinesis data stream used for the database activity stream.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#ActivityStreamStatus", + "traits": { + "smithy.api#documentation": "

The status of the database activity stream.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#StopDBCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#StopDBClusterMessage" + }, + "output": { + "target": "com.amazonaws.rds#StopDBClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's\n metadata, including its endpoints and DB parameter groups. Aurora also\n retains the transaction logs so you can do a point-in-time restore if necessary.

\n

For more information, see \n \n Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.

\n \n

This operation only applies to Aurora DB clusters.

\n ", + "smithy.api#examples": [ + { + "title": "To stop a DB cluster", + "documentation": "The following example stops a DB cluster and its DB instances.", + "input": { + "DBClusterIdentifier": "mydbcluster" + }, + "output": { + "DBCluster": { + "AllocatedStorage": 1, + "AvailabilityZones": [ + "us-east-1a", + "us-east-1e", + "us-east-1b" + ], + "BackupRetentionPeriod": 1, + "DatabaseName": "mydb", + "DBClusterIdentifier": "mydbcluster" + } + } + } + ] + } + }, + "com.amazonaws.rds#StopDBClusterMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The DB cluster identifier of the Amazon Aurora DB cluster to be stopped. This parameter is stored as\n a lowercase string.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#StopDBClusterResult": { + "type": "structure", + "members": { + "DBCluster": { + "target": "com.amazonaws.rds#DBCluster" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#StopDBInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#StopDBInstanceMessage" + }, + "output": { + "target": "com.amazonaws.rds#StopDBInstanceResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSnapshotAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#SnapshotQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, \n DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if \n necessary.

\n

For more information, see \n \n Stopping an Amazon RDS DB Instance Temporarily in the \n Amazon RDS User Guide.\n

\n \n

This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.\n For Aurora clusters, use StopDBCluster instead.

\n ", + "smithy.api#examples": [ + { + "title": "To stop a DB instance", + "documentation": "The following example stops the specified DB instance.", + "input": { + "DBInstanceIdentifier": "test-instance" + }, + "output": { + "DBInstance": { + "DBInstanceStatus": "stopping" + } + } + } + ] + } + }, + "com.amazonaws.rds#StopDBInstanceAutomatedBackupsReplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#StopDBInstanceAutomatedBackupsReplicationMessage" + }, + "output": { + "target": "com.amazonaws.rds#StopDBInstanceAutomatedBackupsReplicationResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Stops automated backup replication for a DB instance.

\n

This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.

\n

For more information, see \n Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.\n

", + "smithy.api#examples": [ + { + "title": "To stop replicating automated backups", + "documentation": "The following example ends replication of automated backups. Replicated backups are retained according to the set backup retention period.", + "input": { + "SourceDBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db" + }, + "output": { + "DBInstanceAutomatedBackup": { + "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db", + "DbiResourceId": "db-JKIB2GFQ5RV7REPLZA4EXAMPLE", + "Region": "us-east-1", + "DBInstanceIdentifier": "new-orcl-db", + "RestoreWindow": { + "EarliestTime": "2020-12-04T23:13:21.030Z", + "LatestTime": "2020-12-07T19:59:57Z" + }, + "AllocatedStorage": 20, + "Status": "replicating", + "Port": 1521, + "InstanceCreateTime": "2020-12-04T15:28:31Z", + "MasterUsername": "admin", + "Engine": "oracle-se2", + "EngineVersion": "12.1.0.2.v21", + "LicenseModel": "bring-your-own-license", + "OptionGroupName": "default:oracle-se2-12-1", + "Encrypted": false, + "StorageType": "gp2", + "IAMDatabaseAuthenticationEnabled": false, + "BackupRetentionPeriod": 7, + "DBInstanceAutomatedBackupsArn": "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example" + } + } + } + ] + } + }, + "com.amazonaws.rds#StopDBInstanceAutomatedBackupsReplicationMessage": { + "type": "structure", + "members": { + "SourceDBInstanceArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source DB instance for which to stop replicating\n automate backups, for example,\n arn:aws:rds:us-west-2:123456789012:db:mydatabase.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#StopDBInstanceAutomatedBackupsReplicationResult": { + "type": "structure", + "members": { + "DBInstanceAutomatedBackup": { + "target": "com.amazonaws.rds#DBInstanceAutomatedBackup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#StopDBInstanceMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The user-supplied instance identifier.

", + "smithy.api#required": {} + } + }, + "DBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#StopDBInstanceResult": { + "type": "structure", + "members": { + "DBInstance": { + "target": "com.amazonaws.rds#DBInstance" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#StorageQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "StorageQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request would result in the user exceeding the allowed amount of storage\n available across all DB instances.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#StorageTypeNotAvailableFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "StorageTypeNotAvailableFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The aurora-iopt1 storage type isn't available, because you modified the DB cluster \n to use this storage type less than one month ago.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#StorageTypeNotSupportedFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "StorageTypeNotSupported", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The specified StorageType can't be associated with the DB instance.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#String": { + "type": "string" + }, + "com.amazonaws.rds#String255": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.rds#StringList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String" + } + }, + "com.amazonaws.rds#Subnet": { + "type": "structure", + "members": { + "SubnetIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the subnet.

" + } + }, + "SubnetAvailabilityZone": { + "target": "com.amazonaws.rds#AvailabilityZone" + }, + "SubnetOutpost": { + "target": "com.amazonaws.rds#Outpost", + "traits": { + "smithy.api#documentation": "

If the subnet is associated with an Outpost, this value specifies the Outpost.

\n

For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.\n

" + } + }, + "SubnetStatus": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The status of the subnet.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a response element for the DescribeDBSubnetGroups operation.

" + } + }, + "com.amazonaws.rds#SubnetAlreadyInUse": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SubnetAlreadyInUse", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The DB subnet is already in use in the Availability Zone.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#SubnetIdentifierList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#xmlName": "SubnetIdentifier" + } + } + }, + "com.amazonaws.rds#SubnetList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#Subnet", + "traits": { + "smithy.api#xmlName": "Subnet" + } + } + }, + "com.amazonaws.rds#SubscriptionAlreadyExistFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SubscriptionAlreadyExist", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The supplied subscription name already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#SubscriptionCategoryNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SubscriptionCategoryNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The supplied category does not exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#SubscriptionNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SubscriptionNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The subscription name does not exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#SupportedCharacterSetsList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#CharacterSet", + "traits": { + "smithy.api#xmlName": "CharacterSet" + } + } + }, + "com.amazonaws.rds#SupportedTimezonesList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#Timezone", + "traits": { + "smithy.api#xmlName": "Timezone" + } + } + }, + "com.amazonaws.rds#SwitchoverBlueGreenDeployment": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#SwitchoverBlueGreenDeploymentRequest" + }, + "output": { + "target": "com.amazonaws.rds#SwitchoverBlueGreenDeploymentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#BlueGreenDeploymentNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidBlueGreenDeploymentStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Switches over a blue/green deployment.

\n

Before you switch over, production traffic is routed to the databases in the blue environment. \n After you switch over, production traffic is routed to the databases in the green environment.

\n

For more information, see Using Amazon RDS\n Blue/Green Deployments for database updates in the Amazon RDS User\n Guide and Using Amazon RDS\n Blue/Green Deployments for database updates in the Amazon Aurora\n User Guide.

" + } + }, + "com.amazonaws.rds#SwitchoverBlueGreenDeploymentRequest": { + "type": "structure", + "members": { + "BlueGreenDeploymentIdentifier": { + "target": "com.amazonaws.rds#BlueGreenDeploymentIdentifier", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The resource ID of the blue/green deployment.

\n

Constraints:

\n
    \n
  • \n

    Must match an existing blue/green deployment resource ID.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "SwitchoverTimeout": { + "target": "com.amazonaws.rds#SwitchoverTimeout", + "traits": { + "smithy.api#documentation": "

The amount of time, in seconds, for the switchover to complete.

\n

Default: 300

\n

If the switchover takes longer than the specified duration, then any changes are rolled back, \n and no changes are made to the environments.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#SwitchoverBlueGreenDeploymentResponse": { + "type": "structure", + "members": { + "BlueGreenDeployment": { + "target": "com.amazonaws.rds#BlueGreenDeployment" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#SwitchoverDetail": { + "type": "structure", + "members": { + "SourceMember": { + "target": "com.amazonaws.rds#DatabaseArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a resource in the blue environment.

" + } + }, + "TargetMember": { + "target": "com.amazonaws.rds#DatabaseArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a resource in the green environment.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#SwitchoverDetailStatus", + "traits": { + "smithy.api#documentation": "

The switchover status of a resource in a blue/green deployment.

\n

Values:

\n
    \n
  • \n

    \n PROVISIONING - The resource is being prepared to switch\n over.

    \n
    • \n
  • \n

    \n AVAILABLE - The resource is ready to switch over.

    \n
    • \n
  • \n

    \n SWITCHOVER_IN_PROGRESS - The resource is being switched\n over.

    \n
    • \n
  • \n

    \n SWITCHOVER_COMPLETED - The resource has been switched\n over.

    \n
    • \n
  • \n

    \n SWITCHOVER_FAILED - The resource attempted to switch over but\n failed.

    \n
    • \n
  • \n

    \n MISSING_SOURCE - The source resource has been deleted.

    \n
    • \n
  • \n

    \n MISSING_TARGET - The target resource has been deleted.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details about a blue/green deployment.

\n

For more information, see Using Amazon RDS\n Blue/Green Deployments for database updates in the Amazon RDS User\n Guide and Using Amazon RDS\n Blue/Green Deployments for database updates in the Amazon Aurora\n User Guide.

" + } + }, + "com.amazonaws.rds#SwitchoverDetailList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#SwitchoverDetail" + } + }, + "com.amazonaws.rds#SwitchoverDetailStatus": { + "type": "string" + }, + "com.amazonaws.rds#SwitchoverGlobalCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#SwitchoverGlobalClusterMessage" + }, + "output": { + "target": "com.amazonaws.rds#SwitchoverGlobalClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#GlobalClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidGlobalClusterStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Switches over the specified secondary DB cluster to be the new primary DB cluster in the global database cluster. \n Switchover operations were previously called \"managed planned failovers.\"

\n

Aurora promotes the specified secondary cluster to assume full read/write capabilities and demotes the current primary cluster \n to a secondary (read-only) cluster, maintaining the orginal replication topology. All secondary clusters are synchronized with the primary \n at the beginning of the process so the new primary continues operations for the Aurora global database without losing any data. Your database \n is unavailable for a short time while the primary and selected secondary clusters are assuming their new roles. For more information about \n switching over an Aurora global database, see Performing switchovers for Amazon Aurora global databases in the Amazon Aurora User Guide.

\n \n

This operation is intended for controlled environments, for operations such as \"regional rotation\" or to fall back to the original \n primary after a global database failover.

\n " + } + }, + "com.amazonaws.rds#SwitchoverGlobalClusterMessage": { + "type": "structure", + "members": { + "GlobalClusterIdentifier": { + "target": "com.amazonaws.rds#GlobalClusterIdentifier", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier of the global database cluster to switch over. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing global database cluster (Aurora global database).

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "TargetDbClusterIdentifier": { + "target": "com.amazonaws.rds#DBClusterIdentifier", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier of the secondary Aurora DB cluster to promote to the new primary for the global database cluster. Use the Amazon Resource Name (ARN) for the identifier so that\n Aurora can locate the cluster in its Amazon Web Services Region.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#SwitchoverGlobalClusterResult": { + "type": "structure", + "members": { + "GlobalCluster": { + "target": "com.amazonaws.rds#GlobalCluster" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#SwitchoverReadReplica": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#SwitchoverReadReplicaMessage" + }, + "output": { + "target": "com.amazonaws.rds#SwitchoverReadReplicaResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Switches over an Oracle standby database in an Oracle Data Guard environment, making it the new\n primary database. Issue this command in the Region that hosts the current standby database.

" + } + }, + "com.amazonaws.rds#SwitchoverReadReplicaMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The DB instance identifier of the current standby database. This value is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing Oracle read replica DB instance.

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#SwitchoverReadReplicaResult": { + "type": "structure", + "members": { + "DBInstance": { + "target": "com.amazonaws.rds#DBInstance" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#SwitchoverTimeout": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 30 + } + } + }, + "com.amazonaws.rds#TStamp": { + "type": "timestamp" + }, + "com.amazonaws.rds#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").

" + } + }, + "Value": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

\n

For more information, see\n Tagging Amazon RDS resources in the Amazon RDS User Guide or \n Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.\n

" + } + }, + "com.amazonaws.rds#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#Tag", + "traits": { + "smithy.api#xmlName": "Tag" + } + }, + "traits": { + "smithy.api#documentation": "

A list of tags.

\n

For more information, see\n Tagging Amazon RDS resources in the Amazon RDS User Guide or \n Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.\n

" + } + }, + "com.amazonaws.rds#TagListMessage": { + "type": "structure", + "members": { + "TagList": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

List of tags returned by the ListTagsForResource operation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#TargetDBClusterParameterGroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[A-Za-z](?!.*--)[0-9A-Za-z-]*[^-]|^default(?!.*--)(?!.*\\.\\.)[0-9A-Za-z-.]*[^-]$" + } + }, + "com.amazonaws.rds#TargetDBInstanceClass": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 5, + "max": 20 + }, + "smithy.api#pattern": "^db\\.[0-9a-z]{2,6}\\.[0-9a-z]{4,9}$" + } + }, + "com.amazonaws.rds#TargetDBParameterGroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[A-Za-z](?!.*--)[0-9A-Za-z-]*[^-]|^default(?!.*--)(?!.*\\.\\.)[0-9A-Za-z-.]*[^-]$" + } + }, + "com.amazonaws.rds#TargetEngineVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[0-9A-Za-z-_.]+$" + } + }, + "com.amazonaws.rds#TargetGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBProxyTargetGroup" + } + }, + "com.amazonaws.rds#TargetHealth": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.rds#TargetState", + "traits": { + "smithy.api#documentation": "

The current state of the connection health lifecycle for the RDS Proxy target.\n The following is a typical lifecycle example for the states of an RDS Proxy target:

\n

\n registering > unavailable > available > unavailable > available\n

" + } + }, + "Reason": { + "target": "com.amazonaws.rds#TargetHealthReason", + "traits": { + "smithy.api#documentation": "

The reason for the current health State of the RDS Proxy target.

" + } + }, + "Description": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A description of the health of the RDS Proxy target. \n If the State is AVAILABLE, a description is not included.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the connection health of an RDS Proxy target.

" + } + }, + "com.amazonaws.rds#TargetHealthReason": { + "type": "enum", + "members": { + "UNREACHABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNREACHABLE" + } + }, + "CONNECTION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONNECTION_FAILED" + } + }, + "AUTH_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTH_FAILURE" + } + }, + "PENDING_PROXY_CAPACITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_PROXY_CAPACITY" + } + }, + "INVALID_REPLICATION_STATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_REPLICATION_STATE" + } + } + } + }, + "com.amazonaws.rds#TargetList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBProxyTarget" + } + }, + "com.amazonaws.rds#TargetRole": { + "type": "enum", + "members": { + "READ_WRITE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READ_WRITE" + } + }, + "READ_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READ_ONLY" + } + }, + "UNKNOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNKNOWN" + } + } + } + }, + "com.amazonaws.rds#TargetState": { + "type": "enum", + "members": { + "registering": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REGISTERING" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "unavailable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNAVAILABLE" + } + } + } + }, + "com.amazonaws.rds#TargetStorageType": { + "type": "string" + }, + "com.amazonaws.rds#TargetType": { + "type": "enum", + "members": { + "RDS_INSTANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RDS_INSTANCE" + } + }, + "RDS_SERVERLESS_ENDPOINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RDS_SERVERLESS_ENDPOINT" + } + }, + "TRACKED_CLUSTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRACKED_CLUSTER" + } + } + } + }, + "com.amazonaws.rds#TenantDatabase": { + "type": "structure", + "members": { + "TenantDatabaseCreateTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The creation time of the tenant database.

" + } + }, + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ID of the DB instance that contains the tenant database.

" + } + }, + "TenantDBName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The database name of the tenant database.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The status of the tenant database.

" + } + }, + "MasterUsername": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The master username of the tenant database.

" + } + }, + "DbiResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region-unique, immutable identifier for the DB instance.

" + } + }, + "TenantDatabaseResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region-unique, immutable identifier for the tenant database.

" + } + }, + "TenantDatabaseARN": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the tenant database.

" + } + }, + "CharacterSetName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The character set of the tenant database.

" + } + }, + "NcharCharacterSetName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The NCHAR character set name of the tenant database.

" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether deletion protection is enabled for the DB instance.

" + } + }, + "PendingModifiedValues": { + "target": "com.amazonaws.rds#TenantDatabasePendingModifiedValues", + "traits": { + "smithy.api#documentation": "

Information about pending changes for a tenant database.

" + } + }, + "TagList": { + "target": "com.amazonaws.rds#TagList" + } + }, + "traits": { + "smithy.api#documentation": "

A tenant database in the DB instance. This data type is an element in the response to\n the DescribeTenantDatabases action.

" + } + }, + "com.amazonaws.rds#TenantDatabaseAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "TenantDatabaseAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

You attempted to either create a tenant database that already exists or \n modify a tenant database to use the name of an existing tenant database.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#TenantDatabaseNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "TenantDatabaseNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified tenant database wasn't found in the DB instance.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#TenantDatabasePendingModifiedValues": { + "type": "structure", + "members": { + "MasterUserPassword": { + "target": "com.amazonaws.rds#SensitiveString", + "traits": { + "smithy.api#documentation": "

The master password for the tenant database.

" + } + }, + "TenantDBName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the tenant database.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A response element in the ModifyTenantDatabase operation that describes\n changes that will be applied. Specific changes are identified by subelements.

" + } + }, + "com.amazonaws.rds#TenantDatabaseQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "TenantDatabaseQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

You attempted to create more tenant databases than are permitted in your Amazon Web Services\n account.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#TenantDatabasesList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#TenantDatabase", + "traits": { + "smithy.api#xmlName": "TenantDatabase" + } + } + }, + "com.amazonaws.rds#TenantDatabasesMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeTenantDatabases request. If this parameter is specified, the\n response includes only records beyond the marker, up to the value specified by\n MaxRecords.

" + } + }, + "TenantDatabases": { + "target": "com.amazonaws.rds#TenantDatabasesList", + "traits": { + "smithy.api#documentation": "

An array of the tenant databases requested by the DescribeTenantDatabases\n operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#Timezone": { + "type": "structure", + "members": { + "TimezoneName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the time zone.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A time zone associated with a \n DBInstance \n or a DBSnapshot.\n This data type is an element in the response to \n the DescribeDBInstances, \n the DescribeDBSnapshots,\n and the DescribeDBEngineVersions\n actions.

" + } + }, + "com.amazonaws.rds#UnsupportedDBEngineVersionFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "UnsupportedDBEngineVersion", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The specified DB engine version isn't supported for Aurora Limitless Database.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#UpgradeTarget": { + "type": "structure", + "members": { + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the upgrade target database engine.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version number of the upgrade target database engine.

" + } + }, + "Description": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version of the database engine that a DB instance can be upgraded to.

" + } + }, + "AutoUpgrade": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.

\n

This parameter is dynamic, and is set by RDS.

" + } + }, + "IsMajorVersionUpgrade": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether upgrading to the target version requires upgrading the major version of the database engine.

" + } + }, + "SupportedEngineModes": { + "target": "com.amazonaws.rds#EngineModeList", + "traits": { + "smithy.api#documentation": "

A list of the supported DB engine modes for the target engine version.

" + } + }, + "SupportsParallelQuery": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether you can use Aurora parallel query with the target engine version.

" + } + }, + "SupportsGlobalDatabases": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether you can use Aurora global databases with the target engine version.

" + } + }, + "SupportsBabelfish": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether you can use Babelfish for Aurora PostgreSQL with the target engine version.

" + } + }, + "SupportsLimitlessDatabase": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether the DB engine version supports Aurora Limitless Database.

" + } + }, + "SupportsLocalWriteForwarding": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether the target engine version supports forwarding write operations from reader DB instances \n to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.

\n

Valid for: Aurora DB clusters only

" + } + }, + "SupportsIntegrations": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether the DB engine version supports zero-ETL integrations with\n Amazon Redshift.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The version of the database engine that a DB instance can be upgraded to.

" + } + }, + "com.amazonaws.rds#UserAuthConfig": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A user-specified description about the authentication used by a proxy to log in as a specific database user.

" + } + }, + "UserName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the database user to which the proxy connects.

" + } + }, + "AuthScheme": { + "target": "com.amazonaws.rds#AuthScheme", + "traits": { + "smithy.api#documentation": "

The type of authentication that the proxy uses for connections from the proxy to the underlying database.

" + } + }, + "SecretArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate\n to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.

" + } + }, + "IAMAuth": { + "target": "com.amazonaws.rds#IAMAuthMode", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. \n The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.

" + } + }, + "ClientPasswordAuthType": { + "target": "com.amazonaws.rds#ClientPasswordAuthType", + "traits": { + "smithy.api#documentation": "

The type of authentication the proxy uses for connections from clients.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the details of authentication used by a proxy to log in as a specific database user.

" + } + }, + "com.amazonaws.rds#UserAuthConfigInfo": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A user-specified description about the authentication used by a proxy to log in as a specific database user.

" + } + }, + "UserName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the database user to which the proxy connects.

" + } + }, + "AuthScheme": { + "target": "com.amazonaws.rds#AuthScheme", + "traits": { + "smithy.api#documentation": "

The type of authentication that the proxy uses for connections from the proxy to the underlying database.

" + } + }, + "SecretArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate\n to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.

" + } + }, + "IAMAuth": { + "target": "com.amazonaws.rds#IAMAuthMode", + "traits": { + "smithy.api#documentation": "

Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. \n The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.

" + } + }, + "ClientPasswordAuthType": { + "target": "com.amazonaws.rds#ClientPasswordAuthType", + "traits": { + "smithy.api#documentation": "

The type of authentication the proxy uses for connections from clients.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Returns the details of authentication used by a proxy to log in as a specific database user.

" + } + }, + "com.amazonaws.rds#UserAuthConfigInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#UserAuthConfigInfo" + } + }, + "com.amazonaws.rds#UserAuthConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#UserAuthConfig" + } + }, + "com.amazonaws.rds#ValidDBInstanceModificationsMessage": { + "type": "structure", + "members": { + "Storage": { + "target": "com.amazonaws.rds#ValidStorageOptionsList", + "traits": { + "smithy.api#documentation": "

Valid storage options for your DB instance.

" + } + }, + "ValidProcessorFeatures": { + "target": "com.amazonaws.rds#AvailableProcessorFeatureList", + "traits": { + "smithy.api#documentation": "

Valid processor features for your DB instance.

" + } + }, + "SupportsDedicatedLogVolume": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether a DB instance supports using a dedicated log volume (DLV).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about valid modifications that you can make to your DB instance.\n Contains the result of a successful call to the \n DescribeValidDBInstanceModifications action.\n You can use this information when you call\n ModifyDBInstance.

" + } + }, + "com.amazonaws.rds#ValidStorageOptions": { + "type": "structure", + "members": { + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The valid storage types for your DB instance.\n For example: gp2, gp3, io1, io2.

" + } + }, + "StorageSize": { + "target": "com.amazonaws.rds#RangeList", + "traits": { + "smithy.api#documentation": "

The valid range of storage in gibibytes (GiB).\n For example, 100 to 16,384.

" + } + }, + "ProvisionedIops": { + "target": "com.amazonaws.rds#RangeList", + "traits": { + "smithy.api#documentation": "

The valid range of provisioned IOPS.\n For example, 1000-256,000.

" + } + }, + "IopsToStorageRatio": { + "target": "com.amazonaws.rds#DoubleRangeList", + "traits": { + "smithy.api#documentation": "

The valid range of Provisioned IOPS to gibibytes of storage multiplier.\n For example, 3-10,\n which means that provisioned IOPS can be between 3 and 10 times storage.

" + } + }, + "SupportsStorageAutoscaling": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether or not Amazon RDS can automatically scale storage for DB instances that use the new instance class.

" + } + }, + "ProvisionedStorageThroughput": { + "target": "com.amazonaws.rds#RangeList", + "traits": { + "smithy.api#documentation": "

The valid range of provisioned storage throughput. For example, \n 500-4,000 mebibytes per second (MiBps).

" + } + }, + "StorageThroughputToIopsRatio": { + "target": "com.amazonaws.rds#DoubleRangeList", + "traits": { + "smithy.api#documentation": "

The valid range of storage throughput to provisioned IOPS ratios. For example, \n 0-0.25.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about valid modifications that you can make to your DB instance.\n Contains the result of a successful call to the \n DescribeValidDBInstanceModifications action.

" + } + }, + "com.amazonaws.rds#ValidStorageOptionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#ValidStorageOptions", + "traits": { + "smithy.api#xmlName": "ValidStorageOptions" + } + } + }, + "com.amazonaws.rds#ValidUpgradeTargetList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#UpgradeTarget", + "traits": { + "smithy.api#xmlName": "UpgradeTarget" + } + } + }, + "com.amazonaws.rds#VpcSecurityGroupIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#xmlName": "VpcSecurityGroupId" + } + } + }, + "com.amazonaws.rds#VpcSecurityGroupMembership": { + "type": "structure", + "members": { + "VpcSecurityGroupId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the VPC security group.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The membership status of the VPC security group.

\n

Currently, the only valid status is active.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a response element for queries on VPC security group membership.

" + } + }, + "com.amazonaws.rds#VpcSecurityGroupMembershipList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#VpcSecurityGroupMembership", + "traits": { + "smithy.api#xmlName": "VpcSecurityGroupMembership" + } + } + }, + "com.amazonaws.rds#WriteForwardingStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + }, + "ENABLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabling" + } + }, + "DISABLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabling" + } + }, + "UNKNOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unknown" + } + } + } + } + } +} \ No newline at end of file diff --git a/pkg/testdata/codegen/sdk-codegen/aws-models/s3.json b/pkg/testdata/codegen/sdk-codegen/aws-models/s3.json new file mode 100644 index 00000000..8f7dc389 --- /dev/null +++ b/pkg/testdata/codegen/sdk-codegen/aws-models/s3.json @@ -0,0 +1,36530 @@ +{ + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.s3#AbortDate": { + "type": "timestamp" + }, + "com.amazonaws.s3#AbortIncompleteMultipartUpload": { + "type": "structure", + "members": { + "DaysAfterInitiation": { + "target": "com.amazonaws.s3#DaysAfterInitiation", + "traits": { + "smithy.api#documentation": "

Specifies the number of days after which Amazon S3 aborts an incomplete multipart\n upload.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will\n wait before permanently removing all parts of the upload. For more information, see \n Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration in\n the Amazon S3 User Guide.

" + } + }, + "com.amazonaws.s3#AbortMultipartUpload": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#AbortMultipartUploadRequest" + }, + "output": { + "target": "com.amazonaws.s3#AbortMultipartUploadOutput" + }, + "errors": [ + { + "target": "com.amazonaws.s3#NoSuchUpload" + } + ], + "traits": { + "smithy.api#documentation": "

This operation aborts a multipart upload. After a multipart upload is aborted, no\n additional parts can be uploaded using that upload ID. The storage consumed by any\n previously uploaded parts will be freed. However, if any part uploads are currently in\n progress, those part uploads might or might not succeed. As a result, it might be necessary\n to abort a given multipart upload multiple times in order to completely free all storage\n consumed by all parts.

\n

To verify that all parts have been removed and prevent getting charged for the part\n storage, you should call the ListParts API operation and ensure\n that the parts list is empty.

\n \n
    \n
  • \n

    \n Directory buckets - If multipart\n uploads in a directory bucket are in progress, you can't delete the bucket until\n all the in-progress multipart uploads are aborted or completed. To delete these\n in-progress multipart uploads, use the ListMultipartUploads operation\n to list the in-progress multipart uploads in the bucket and use the\n AbortMultipartUpload operation to abort all the in-progress\n multipart uploads.

    \n
    • \n
  • \n

    \n Directory buckets -\n For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket-name.s3express-zone-id.region-code.amazonaws.com/key-name\n . Path-style requests are not supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the\n Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the\n Amazon S3 User Guide.

    \n
    • \n
\n \n
\n
Permissions
\n
\n
    \n
  • \n

    \n General purpose bucket permissions - For\n information about permissions required to use the multipart upload, see\n Multipart Upload and\n Permissions in the Amazon S3 User Guide.

    \n
    • \n
  • \n

    \n Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the \n CreateSession\n API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. \nAmazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see \n CreateSession\n .

    \n
    • \n
\n
\n
HTTP Host header syntax
\n
\n

\n Directory buckets - The HTTP Host header syntax is \n Bucket-name.s3express-zone-id.region-code.amazonaws.com.

\n
\n
\n

The following operations are related to AbortMultipartUpload:

\n ", + "smithy.api#examples": [ + { + "title": "To abort a multipart upload", + "documentation": "The following example aborts a multipart upload.", + "input": { + "Bucket": "examplebucket", + "Key": "bigobject", + "UploadId": "xadcOB_7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--" + }, + "output": {} + } + ], + "smithy.api#http": { + "method": "DELETE", + "uri": "/{Bucket}/{Key+}?x-id=AbortMultipartUpload", + "code": 204 + } + } + }, + "com.amazonaws.s3#AbortMultipartUploadOutput": { + "type": "structure", + "members": { + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3#AbortMultipartUploadRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name to which the upload was taking place.

\n

\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n \n

Access points and Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

Key of the object for which the multipart upload was initiated.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Key" + } + } + }, + "UploadId": { + "target": "com.amazonaws.s3#MultipartUploadId", + "traits": { + "smithy.api#documentation": "

Upload ID that identifies the multipart upload.

", + "smithy.api#httpQuery": "uploadId", + "smithy.api#required": {} + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + }, + "IfMatchInitiatedTime": { + "target": "com.amazonaws.s3#IfMatchInitiatedTime", + "traits": { + "smithy.api#documentation": "

If present, this header aborts an in progress multipart upload only if it was initiated on the provided timestamp.\n If the initiated timestamp of the multipart upload does not match the provided value, the operation returns a 412 Precondition Failed error. \n If the initiated timestamp matches or if the multipart upload doesn’t exist, the operation returns a 204 Success (No Content) response. \n

\n \n

This functionality is only supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-if-match-initiated-time" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#AbortRuleId": { + "type": "string" + }, + "com.amazonaws.s3#AccelerateConfiguration": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.s3#BucketAccelerateStatus", + "traits": { + "smithy.api#documentation": "

Specifies the transfer acceleration status of the bucket.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see\n Amazon S3\n Transfer Acceleration in the Amazon S3 User Guide.

" + } + }, + "com.amazonaws.s3#AcceptRanges": { + "type": "string" + }, + "com.amazonaws.s3#AccessControlPolicy": { + "type": "structure", + "members": { + "Grants": { + "target": "com.amazonaws.s3#Grants", + "traits": { + "smithy.api#documentation": "

A list of grants.

", + "smithy.api#xmlName": "AccessControlList" + } + }, + "Owner": { + "target": "com.amazonaws.s3#Owner", + "traits": { + "smithy.api#documentation": "

Container for the bucket owner's display name and ID.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the elements that set the ACL permissions for an object per grantee.

" + } + }, + "com.amazonaws.s3#AccessControlTranslation": { + "type": "structure", + "members": { + "Owner": { + "target": "com.amazonaws.s3#OwnerOverride", + "traits": { + "smithy.api#documentation": "

Specifies the replica ownership. For default and valid values, see PUT bucket\n replication in the Amazon S3 API Reference.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A container for information about access control for replicas.

" + } + }, + "com.amazonaws.s3#AccessKeyIdValue": { + "type": "string" + }, + "com.amazonaws.s3#AccessPointAlias": { + "type": "boolean" + }, + "com.amazonaws.s3#AccessPointArn": { + "type": "string" + }, + "com.amazonaws.s3#AccountId": { + "type": "string" + }, + "com.amazonaws.s3#AllowQuotedRecordDelimiter": { + "type": "boolean" + }, + "com.amazonaws.s3#AllowedHeader": { + "type": "string" + }, + "com.amazonaws.s3#AllowedHeaders": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#AllowedHeader" + } + }, + "com.amazonaws.s3#AllowedMethod": { + "type": "string" + }, + "com.amazonaws.s3#AllowedMethods": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#AllowedMethod" + } + }, + "com.amazonaws.s3#AllowedOrigin": { + "type": "string" + }, + "com.amazonaws.s3#AllowedOrigins": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#AllowedOrigin" + } + }, + "com.amazonaws.s3#AmazonS3": { + "type": "service", + "version": "2006-03-01", + "operations": [ + { + "target": "com.amazonaws.s3#AbortMultipartUpload" + }, + { + "target": "com.amazonaws.s3#CompleteMultipartUpload" + }, + { + "target": "com.amazonaws.s3#CopyObject" + }, + { + "target": "com.amazonaws.s3#CreateBucket" + }, + { + "target": "com.amazonaws.s3#CreateBucketMetadataTableConfiguration" + }, + { + "target": "com.amazonaws.s3#CreateMultipartUpload" + }, + { + "target": "com.amazonaws.s3#CreateSession" + }, + { + "target": "com.amazonaws.s3#DeleteBucket" + }, + { + "target": "com.amazonaws.s3#DeleteBucketAnalyticsConfiguration" + }, + { + "target": "com.amazonaws.s3#DeleteBucketCors" + }, + { + "target": "com.amazonaws.s3#DeleteBucketEncryption" + }, + { + "target": "com.amazonaws.s3#DeleteBucketIntelligentTieringConfiguration" + }, + { + "target": "com.amazonaws.s3#DeleteBucketInventoryConfiguration" + }, + { + "target": "com.amazonaws.s3#DeleteBucketLifecycle" + }, + { + "target": "com.amazonaws.s3#DeleteBucketMetadataTableConfiguration" + }, + { + "target": "com.amazonaws.s3#DeleteBucketMetricsConfiguration" + }, + { + "target": "com.amazonaws.s3#DeleteBucketOwnershipControls" + }, + { + "target": "com.amazonaws.s3#DeleteBucketPolicy" + }, + { + "target": "com.amazonaws.s3#DeleteBucketReplication" + }, + { + "target": "com.amazonaws.s3#DeleteBucketTagging" + }, + { + "target": "com.amazonaws.s3#DeleteBucketWebsite" + }, + { + "target": "com.amazonaws.s3#DeleteObject" + }, + { + "target": "com.amazonaws.s3#DeleteObjects" + }, + { + "target": "com.amazonaws.s3#DeleteObjectTagging" + }, + { + "target": "com.amazonaws.s3#DeletePublicAccessBlock" + }, + { + "target": "com.amazonaws.s3#GetBucketAccelerateConfiguration" + }, + { + "target": "com.amazonaws.s3#GetBucketAcl" + }, + { + "target": "com.amazonaws.s3#GetBucketAnalyticsConfiguration" + }, + { + "target": "com.amazonaws.s3#GetBucketCors" + }, + { + "target": "com.amazonaws.s3#GetBucketEncryption" + }, + { + "target": "com.amazonaws.s3#GetBucketIntelligentTieringConfiguration" + }, + { + "target": "com.amazonaws.s3#GetBucketInventoryConfiguration" + }, + { + "target": "com.amazonaws.s3#GetBucketLifecycleConfiguration" + }, + { + "target": "com.amazonaws.s3#GetBucketLocation" + }, + { + "target": "com.amazonaws.s3#GetBucketLogging" + }, + { + "target": "com.amazonaws.s3#GetBucketMetadataTableConfiguration" + }, + { + "target": "com.amazonaws.s3#GetBucketMetricsConfiguration" + }, + { + "target": "com.amazonaws.s3#GetBucketNotificationConfiguration" + }, + { + "target": "com.amazonaws.s3#GetBucketOwnershipControls" + }, + { + "target": "com.amazonaws.s3#GetBucketPolicy" + }, + { + "target": "com.amazonaws.s3#GetBucketPolicyStatus" + }, + { + "target": "com.amazonaws.s3#GetBucketReplication" + }, + { + "target": "com.amazonaws.s3#GetBucketRequestPayment" + }, + { + "target": "com.amazonaws.s3#GetBucketTagging" + }, + { + "target": "com.amazonaws.s3#GetBucketVersioning" + }, + { + "target": "com.amazonaws.s3#GetBucketWebsite" + }, + { + "target": "com.amazonaws.s3#GetObject" + }, + { + "target": "com.amazonaws.s3#GetObjectAcl" + }, + { + "target": "com.amazonaws.s3#GetObjectAttributes" + }, + { + "target": "com.amazonaws.s3#GetObjectLegalHold" + }, + { + "target": "com.amazonaws.s3#GetObjectLockConfiguration" + }, + { + "target": "com.amazonaws.s3#GetObjectRetention" + }, + { + "target": "com.amazonaws.s3#GetObjectTagging" + }, + { + "target": "com.amazonaws.s3#GetObjectTorrent" + }, + { + "target": "com.amazonaws.s3#GetPublicAccessBlock" + }, + { + "target": "com.amazonaws.s3#HeadBucket" + }, + { + "target": "com.amazonaws.s3#HeadObject" + }, + { + "target": "com.amazonaws.s3#ListBucketAnalyticsConfigurations" + }, + { + "target": "com.amazonaws.s3#ListBucketIntelligentTieringConfigurations" + }, + { + "target": "com.amazonaws.s3#ListBucketInventoryConfigurations" + }, + { + "target": "com.amazonaws.s3#ListBucketMetricsConfigurations" + }, + { + "target": "com.amazonaws.s3#ListBuckets" + }, + { + "target": "com.amazonaws.s3#ListDirectoryBuckets" + }, + { + "target": "com.amazonaws.s3#ListMultipartUploads" + }, + { + "target": "com.amazonaws.s3#ListObjects" + }, + { + "target": "com.amazonaws.s3#ListObjectsV2" + }, + { + "target": "com.amazonaws.s3#ListObjectVersions" + }, + { + "target": "com.amazonaws.s3#ListParts" + }, + { + "target": "com.amazonaws.s3#PutBucketAccelerateConfiguration" + }, + { + "target": "com.amazonaws.s3#PutBucketAcl" + }, + { + "target": "com.amazonaws.s3#PutBucketAnalyticsConfiguration" + }, + { + "target": "com.amazonaws.s3#PutBucketCors" + }, + { + "target": "com.amazonaws.s3#PutBucketEncryption" + }, + { + "target": "com.amazonaws.s3#PutBucketIntelligentTieringConfiguration" + }, + { + "target": "com.amazonaws.s3#PutBucketInventoryConfiguration" + }, + { + "target": "com.amazonaws.s3#PutBucketLifecycleConfiguration" + }, + { + "target": "com.amazonaws.s3#PutBucketLogging" + }, + { + "target": "com.amazonaws.s3#PutBucketMetricsConfiguration" + }, + { + "target": "com.amazonaws.s3#PutBucketNotificationConfiguration" + }, + { + "target": "com.amazonaws.s3#PutBucketOwnershipControls" + }, + { + "target": "com.amazonaws.s3#PutBucketPolicy" + }, + { + "target": "com.amazonaws.s3#PutBucketReplication" + }, + { + "target": "com.amazonaws.s3#PutBucketRequestPayment" + }, + { + "target": "com.amazonaws.s3#PutBucketTagging" + }, + { + "target": "com.amazonaws.s3#PutBucketVersioning" + }, + { + "target": "com.amazonaws.s3#PutBucketWebsite" + }, + { + "target": "com.amazonaws.s3#PutObject" + }, + { + "target": "com.amazonaws.s3#PutObjectAcl" + }, + { + "target": "com.amazonaws.s3#PutObjectLegalHold" + }, + { + "target": "com.amazonaws.s3#PutObjectLockConfiguration" + }, + { + "target": "com.amazonaws.s3#PutObjectRetention" + }, + { + "target": "com.amazonaws.s3#PutObjectTagging" + }, + { + "target": "com.amazonaws.s3#PutPublicAccessBlock" + }, + { + "target": "com.amazonaws.s3#RestoreObject" + }, + { + "target": "com.amazonaws.s3#SelectObjectContent" + }, + { + "target": "com.amazonaws.s3#UploadPart" + }, + { + "target": "com.amazonaws.s3#UploadPartCopy" + }, + { + "target": "com.amazonaws.s3#WriteGetObjectResponse" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "S3", + "arnNamespace": "s3", + "cloudFormationName": "S3", + "cloudTrailEventSource": "s3.amazonaws.com", + "endpointPrefix": "s3" + }, + "aws.auth#sigv4": { + "name": "s3" + }, + "aws.protocols#restXml": { + "noErrorWrapping": true + }, + "smithy.api#documentation": "

", + "smithy.api#suppress": [ + "RuleSetAuthSchemes" + ], + "smithy.api#title": "Amazon Simple Storage Service", + "smithy.api#xmlNamespace": { + "uri": "http://s3.amazonaws.com/doc/2006-03-01/" + }, + "smithy.rules#clientContextParams": { + "ForcePathStyle": { + "documentation": "Forces this client to use path-style addressing for buckets.", + "type": "boolean" + }, + "UseArnRegion": { + "documentation": "Enables this client to use an ARN's region when constructing an endpoint instead of the client's configured region.", + "type": "boolean" + }, + "DisableMultiRegionAccessPoints": { + "documentation": "Disables this client's usage of Multi-Region Access Points.", + "type": "boolean" + }, + "Accelerate": { + "documentation": "Enables this client to use S3 Transfer Acceleration endpoints.", + "type": "boolean" + }, + "DisableS3ExpressSessionAuth": { + "documentation": "Disables this client's usage of Session Auth for S3Express buckets and reverts to using conventional SigV4 for those.", + "type": "boolean" + } + }, + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Bucket": { + "required": false, + "documentation": "The S3 bucket used to send the request. This is an optional parameter that will be set automatically for operations that are scoped to an S3 bucket.", + "type": "String" + }, + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + }, + "ForcePathStyle": { + "builtIn": "AWS::S3::ForcePathStyle", + "required": true, + "default": false, + "documentation": "When true, force a path-style endpoint to be used where the bucket name is part of the path.", + "type": "Boolean" + }, + "Accelerate": { + "builtIn": "AWS::S3::Accelerate", + "required": true, + "default": false, + "documentation": "When true, use S3 Accelerate. NOTE: Not all regions support S3 accelerate.", + "type": "Boolean" + }, + "UseGlobalEndpoint": { + "builtIn": "AWS::S3::UseGlobalEndpoint", + "required": true, + "default": false, + "documentation": "Whether the global endpoint should be used, rather then the regional endpoint for us-east-1.", + "type": "Boolean" + }, + "UseObjectLambdaEndpoint": { + "required": false, + "documentation": "Internal parameter to use object lambda endpoint for an operation (eg: WriteGetObjectResponse)", + "type": "Boolean" + }, + "Key": { + "required": false, + "documentation": "The S3 Key used to send the request. This is an optional parameter that will be set automatically for operations that are scoped to an S3 Key.", + "type": "String" + }, + "Prefix": { + "required": false, + "documentation": "The S3 Prefix used to send the request. This is an optional parameter that will be set automatically for operations that are scoped to an S3 Prefix.", + "type": "String" + }, + "CopySource": { + "required": false, + "documentation": "The Copy Source used for Copy Object request. This is an optional parameter that will be set automatically for operations that are scoped to Copy Source.", + "type": "String" + }, + "DisableAccessPoints": { + "required": false, + "documentation": "Internal parameter to disable Access Point Buckets", + "type": "Boolean" + }, + "DisableMultiRegionAccessPoints": { + "builtIn": "AWS::S3::DisableMultiRegionAccessPoints", + "required": true, + "default": false, + "documentation": "Whether multi-region access points (MRAP) should be disabled.", + "type": "Boolean" + }, + "UseArnRegion": { + "builtIn": "AWS::S3::UseArnRegion", + "required": false, + "documentation": "When an Access Point ARN is provided and this flag is enabled, the SDK MUST use the ARN's region when constructing the endpoint instead of the client's configured region.", + "type": "Boolean" + }, + "UseS3ExpressControlEndpoint": { + "required": false, + "documentation": "Internal parameter to indicate whether S3Express operation should use control plane, (ex. CreateBucket)", + "type": "Boolean" + }, + "DisableS3ExpressSessionAuth": { + "required": false, + "documentation": "Parameter to indicate whether S3Express session auth should be disabled", + "type": "Boolean" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "Accelerate" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Accelerate cannot be used with FIPS", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + }, + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "error": "Cannot set dual-stack in combination with a custom endpoint.", + "type": "error" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "A custom endpoint cannot be combined with FIPS", + "type": "error" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "Accelerate" + }, + true + ] + } + ], + "error": "A custom endpoint cannot be combined with S3 Accelerate", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "partitionResult" + }, + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "partitionResult" + }, + "name" + ] + }, + "aws-cn" + ] + } + ], + "error": "Partition does not support FIPS", + "type": "error" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Bucket" + } + ] + }, + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 0, + 6, + true + ], + "assign": "bucketSuffix" + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "bucketSuffix" + }, + "--x-s3" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "S3Express does not support Dual-stack.", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "Accelerate" + }, + true + ] + } + ], + "error": "S3Express does not support S3 Accelerate.", + "type": "error" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "DisableS3ExpressSessionAuth" + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "DisableS3ExpressSessionAuth" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "url" + }, + "isIp" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "uriEncode", + "argv": [ + { + "ref": "Bucket" + } + ], + "assign": "uri_encoded_bucket" + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "{url#scheme}://{url#authority}/{uri_encoded_bucket}{url#path}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "aws.isVirtualHostableS3Bucket", + "argv": [ + { + "ref": "Bucket" + }, + false + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "{url#scheme}://{Bucket}.{url#authority}{url#path}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "S3Express bucket name is not a valid virtual hostable name.", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "url" + }, + "isIp" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "uriEncode", + "argv": [ + { + "ref": "Bucket" + } + ], + "assign": "uri_encoded_bucket" + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "{url#scheme}://{url#authority}/{uri_encoded_bucket}{url#path}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "aws.isVirtualHostableS3Bucket", + "argv": [ + { + "ref": "Bucket" + }, + false + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "{url#scheme}://{Bucket}.{url#authority}{url#path}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "S3Express bucket name is not a valid virtual hostable name.", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "UseS3ExpressControlEndpoint" + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseS3ExpressControlEndpoint" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "uriEncode", + "argv": [ + { + "ref": "Bucket" + } + ], + "assign": "uri_encoded_bucket" + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "endpoint": { + "url": "https://s3express-control-fips.{Region}.amazonaws.com/{uri_encoded_bucket}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://s3express-control.{Region}.amazonaws.com/{uri_encoded_bucket}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "aws.isVirtualHostableS3Bucket", + "argv": [ + { + "ref": "Bucket" + }, + false + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "DisableS3ExpressSessionAuth" + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "DisableS3ExpressSessionAuth" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 6, + 14, + true + ], + "assign": "s3expressAvailabilityZoneId" + }, + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 14, + 16, + true + ], + "assign": "s3expressAvailabilityZoneDelim" + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "s3expressAvailabilityZoneDelim" + }, + "--" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "endpoint": { + "url": "https://{Bucket}.s3express-fips-{s3expressAvailabilityZoneId}.{Region}.amazonaws.com", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{Bucket}.s3express-{s3expressAvailabilityZoneId}.{Region}.amazonaws.com", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 6, + 15, + true + ], + "assign": "s3expressAvailabilityZoneId" + }, + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 15, + 17, + true + ], + "assign": "s3expressAvailabilityZoneDelim" + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "s3expressAvailabilityZoneDelim" + }, + "--" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "endpoint": { + "url": "https://{Bucket}.s3express-fips-{s3expressAvailabilityZoneId}.{Region}.amazonaws.com", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{Bucket}.s3express-{s3expressAvailabilityZoneId}.{Region}.amazonaws.com", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 6, + 19, + true + ], + "assign": "s3expressAvailabilityZoneId" + }, + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 19, + 21, + true + ], + "assign": "s3expressAvailabilityZoneDelim" + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "s3expressAvailabilityZoneDelim" + }, + "--" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "endpoint": { + "url": "https://{Bucket}.s3express-fips-{s3expressAvailabilityZoneId}.{Region}.amazonaws.com", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{Bucket}.s3express-{s3expressAvailabilityZoneId}.{Region}.amazonaws.com", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 6, + 20, + true + ], + "assign": "s3expressAvailabilityZoneId" + }, + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 20, + 22, + true + ], + "assign": "s3expressAvailabilityZoneDelim" + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "s3expressAvailabilityZoneDelim" + }, + "--" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "endpoint": { + "url": "https://{Bucket}.s3express-fips-{s3expressAvailabilityZoneId}.{Region}.amazonaws.com", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{Bucket}.s3express-{s3expressAvailabilityZoneId}.{Region}.amazonaws.com", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 6, + 26, + true + ], + "assign": "s3expressAvailabilityZoneId" + }, + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 26, + 28, + true + ], + "assign": "s3expressAvailabilityZoneDelim" + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "s3expressAvailabilityZoneDelim" + }, + "--" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "endpoint": { + "url": "https://{Bucket}.s3express-fips-{s3expressAvailabilityZoneId}.{Region}.amazonaws.com", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{Bucket}.s3express-{s3expressAvailabilityZoneId}.{Region}.amazonaws.com", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Unrecognized S3Express bucket name format.", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 6, + 14, + true + ], + "assign": "s3expressAvailabilityZoneId" + }, + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 14, + 16, + true + ], + "assign": "s3expressAvailabilityZoneDelim" + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "s3expressAvailabilityZoneDelim" + }, + "--" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "endpoint": { + "url": "https://{Bucket}.s3express-fips-{s3expressAvailabilityZoneId}.{Region}.amazonaws.com", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{Bucket}.s3express-{s3expressAvailabilityZoneId}.{Region}.amazonaws.com", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 6, + 15, + true + ], + "assign": "s3expressAvailabilityZoneId" + }, + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 15, + 17, + true + ], + "assign": "s3expressAvailabilityZoneDelim" + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "s3expressAvailabilityZoneDelim" + }, + "--" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "endpoint": { + "url": "https://{Bucket}.s3express-fips-{s3expressAvailabilityZoneId}.{Region}.amazonaws.com", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{Bucket}.s3express-{s3expressAvailabilityZoneId}.{Region}.amazonaws.com", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 6, + 19, + true + ], + "assign": "s3expressAvailabilityZoneId" + }, + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 19, + 21, + true + ], + "assign": "s3expressAvailabilityZoneDelim" + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "s3expressAvailabilityZoneDelim" + }, + "--" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "endpoint": { + "url": "https://{Bucket}.s3express-fips-{s3expressAvailabilityZoneId}.{Region}.amazonaws.com", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{Bucket}.s3express-{s3expressAvailabilityZoneId}.{Region}.amazonaws.com", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 6, + 20, + true + ], + "assign": "s3expressAvailabilityZoneId" + }, + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 20, + 22, + true + ], + "assign": "s3expressAvailabilityZoneDelim" + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "s3expressAvailabilityZoneDelim" + }, + "--" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "endpoint": { + "url": "https://{Bucket}.s3express-fips-{s3expressAvailabilityZoneId}.{Region}.amazonaws.com", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{Bucket}.s3express-{s3expressAvailabilityZoneId}.{Region}.amazonaws.com", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 6, + 26, + true + ], + "assign": "s3expressAvailabilityZoneId" + }, + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 26, + 28, + true + ], + "assign": "s3expressAvailabilityZoneDelim" + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "s3expressAvailabilityZoneDelim" + }, + "--" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "endpoint": { + "url": "https://{Bucket}.s3express-fips-{s3expressAvailabilityZoneId}.{Region}.amazonaws.com", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{Bucket}.s3express-{s3expressAvailabilityZoneId}.{Region}.amazonaws.com", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Unrecognized S3Express bucket name format.", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "S3Express bucket name is not a valid virtual hostable name.", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Bucket" + } + ] + } + ] + }, + { + "fn": "isSet", + "argv": [ + { + "ref": "UseS3ExpressControlEndpoint" + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseS3ExpressControlEndpoint" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + } + ], + "endpoint": { + "url": "{url#scheme}://{url#authority}{url#path}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "endpoint": { + "url": "https://s3express-control-fips.{Region}.amazonaws.com", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://s3express-control.{Region}.amazonaws.com", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Bucket" + } + ] + }, + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 49, + 50, + true + ], + "assign": "hardwareType" + }, + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 8, + 12, + true + ], + "assign": "regionPrefix" + }, + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 0, + 7, + true + ], + "assign": "bucketAliasSuffix" + }, + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 32, + 49, + true + ], + "assign": "outpostId" + }, + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "regionPartition" + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "bucketAliasSuffix" + }, + "--op-s3" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "isValidHostLabel", + "argv": [ + { + "ref": "outpostId" + }, + false + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "hardwareType" + }, + "e" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "regionPrefix" + }, + "beta" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + } + ], + "error": "Expected a endpoint to be specified but no endpoint was found", + "type": "error" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + } + ], + "endpoint": { + "url": "https://{Bucket}.ec2.{url#authority}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4a", + "signingName": "s3-outposts", + "signingRegionSet": [ + "*" + ] + }, + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3-outposts", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{Bucket}.ec2.s3-outposts.{Region}.{regionPartition#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4a", + "signingName": "s3-outposts", + "signingRegionSet": [ + "*" + ] + }, + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3-outposts", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "hardwareType" + }, + "o" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "regionPrefix" + }, + "beta" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + } + ], + "error": "Expected a endpoint to be specified but no endpoint was found", + "type": "error" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + } + ], + "endpoint": { + "url": "https://{Bucket}.op-{outpostId}.{url#authority}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4a", + "signingName": "s3-outposts", + "signingRegionSet": [ + "*" + ] + }, + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3-outposts", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{Bucket}.op-{outpostId}.s3-outposts.{Region}.{regionPartition#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4a", + "signingName": "s3-outposts", + "signingRegionSet": [ + "*" + ] + }, + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3-outposts", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Unrecognized hardware type: \"Expected hardware type o or e but got {hardwareType}\"", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid ARN: The outpost Id must only contain a-z, A-Z, 0-9 and `-`.", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Bucket" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + } + ] + } + ], + "error": "Custom endpoint `{Endpoint}` was not a valid URI", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "ForcePathStyle" + }, + false + ] + }, + { + "fn": "aws.isVirtualHostableS3Bucket", + "argv": [ + { + "ref": "Bucket" + }, + false + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "partitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "isValidHostLabel", + "argv": [ + { + "ref": "Region" + }, + false + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "Accelerate" + }, + true + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "partitionResult" + }, + "name" + ] + }, + "aws-cn" + ] + } + ], + "error": "S3 Accelerate cannot be used in this region", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "Accelerate" + }, + false + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ], + "endpoint": { + "url": "https://{Bucket}.s3-fips.dualstack.us-east-1.{partitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "Accelerate" + }, + false + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseGlobalEndpoint" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://{Bucket}.s3-fips.dualstack.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "Accelerate" + }, + false + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseGlobalEndpoint" + }, + false + ] + } + ], + "endpoint": { + "url": "https://{Bucket}.s3-fips.dualstack.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "Accelerate" + }, + false + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ], + "endpoint": { + "url": "https://{Bucket}.s3-fips.us-east-1.{partitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "Accelerate" + }, + false + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseGlobalEndpoint" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://{Bucket}.s3-fips.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "Accelerate" + }, + false + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseGlobalEndpoint" + }, + false + ] + } + ], + "endpoint": { + "url": "https://{Bucket}.s3-fips.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "Accelerate" + }, + true + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ], + "endpoint": { + "url": "https://{Bucket}.s3-accelerate.dualstack.us-east-1.{partitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "Accelerate" + }, + true + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseGlobalEndpoint" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://{Bucket}.s3-accelerate.dualstack.{partitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "Accelerate" + }, + true + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseGlobalEndpoint" + }, + false + ] + } + ], + "endpoint": { + "url": "https://{Bucket}.s3-accelerate.dualstack.{partitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "Accelerate" + }, + false + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ], + "endpoint": { + "url": "https://{Bucket}.s3.dualstack.us-east-1.{partitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "Accelerate" + }, + false + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseGlobalEndpoint" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://{Bucket}.s3.dualstack.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "Accelerate" + }, + false + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseGlobalEndpoint" + }, + false + ] + } + ], + "endpoint": { + "url": "https://{Bucket}.s3.dualstack.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "Accelerate" + }, + false + ] + }, + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + }, + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "url" + }, + "isIp" + ] + }, + true + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ], + "endpoint": { + "url": "{url#scheme}://{url#authority}{url#normalizedPath}{Bucket}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "Accelerate" + }, + false + ] + }, + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + }, + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "url" + }, + "isIp" + ] + }, + false + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ], + "endpoint": { + "url": "{url#scheme}://{Bucket}.{url#authority}{url#path}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "Accelerate" + }, + false + ] + }, + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + }, + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "url" + }, + "isIp" + ] + }, + true + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseGlobalEndpoint" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-east-1" + ] + } + ], + "endpoint": { + "url": "{url#scheme}://{url#authority}{url#normalizedPath}{Bucket}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "{url#scheme}://{url#authority}{url#normalizedPath}{Bucket}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "Accelerate" + }, + false + ] + }, + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + }, + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "url" + }, + "isIp" + ] + }, + false + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseGlobalEndpoint" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-east-1" + ] + } + ], + "endpoint": { + "url": "{url#scheme}://{Bucket}.{url#authority}{url#path}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "{url#scheme}://{Bucket}.{url#authority}{url#path}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "Accelerate" + }, + false + ] + }, + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + }, + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "url" + }, + "isIp" + ] + }, + true + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseGlobalEndpoint" + }, + false + ] + } + ], + "endpoint": { + "url": "{url#scheme}://{url#authority}{url#normalizedPath}{Bucket}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "Accelerate" + }, + false + ] + }, + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + }, + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "url" + }, + "isIp" + ] + }, + false + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseGlobalEndpoint" + }, + false + ] + } + ], + "endpoint": { + "url": "{url#scheme}://{Bucket}.{url#authority}{url#path}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "Accelerate" + }, + true + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ], + "endpoint": { + "url": "https://{Bucket}.s3-accelerate.{partitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "Accelerate" + }, + true + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseGlobalEndpoint" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-east-1" + ] + } + ], + "endpoint": { + "url": "https://{Bucket}.s3-accelerate.{partitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{Bucket}.s3-accelerate.{partitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "Accelerate" + }, + true + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseGlobalEndpoint" + }, + false + ] + } + ], + "endpoint": { + "url": "https://{Bucket}.s3-accelerate.{partitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "Accelerate" + }, + false + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ], + "endpoint": { + "url": "https://{Bucket}.s3.{partitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "Accelerate" + }, + false + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseGlobalEndpoint" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-east-1" + ] + } + ], + "endpoint": { + "url": "https://{Bucket}.s3.{partitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{Bucket}.s3.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "Accelerate" + }, + false + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseGlobalEndpoint" + }, + false + ] + } + ], + "endpoint": { + "url": "https://{Bucket}.s3.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid region: region was not a valid DNS name.", + "type": "error" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + }, + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "url" + }, + "scheme" + ] + }, + "http" + ] + }, + { + "fn": "aws.isVirtualHostableS3Bucket", + "argv": [ + { + "ref": "Bucket" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "ForcePathStyle" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "Accelerate" + }, + false + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "partitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "isValidHostLabel", + "argv": [ + { + "ref": "Region" + }, + false + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "{url#scheme}://{Bucket}.{url#authority}{url#path}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid region: region was not a valid DNS name.", + "type": "error" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "ForcePathStyle" + }, + false + ] + }, + { + "fn": "aws.parseArn", + "argv": [ + { + "ref": "Bucket" + } + ], + "assign": "bucketArn" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "bucketArn" + }, + "resourceId[0]" + ], + "assign": "arnType" + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "arnType" + }, + "" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "bucketArn" + }, + "service" + ] + }, + "s3-object-lambda" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "arnType" + }, + "accesspoint" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "bucketArn" + }, + "resourceId[1]" + ], + "assign": "accessPointName" + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "accessPointName" + }, + "" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "S3 Object Lambda does not support Dual-stack", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "Accelerate" + }, + true + ] + } + ], + "error": "S3 Object Lambda does not support S3 Accelerate", + "type": "error" + }, + { + "conditions": [ + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "bucketArn" + }, + "region" + ] + }, + "" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "DisableAccessPoints" + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "DisableAccessPoints" + }, + true + ] + } + ], + "error": "Access points are not supported for this operation", + "type": "error" + }, + { + "conditions": [ + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "bucketArn" + }, + "resourceId[2]" + ] + } + ] + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "UseArnRegion" + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseArnRegion" + }, + false + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "bucketArn" + }, + "region" + ] + }, + "{Region}" + ] + } + ] + } + ], + "error": "Invalid configuration: region from ARN `{bucketArn#region}` does not match client region `{Region}` and UseArnRegion is `false`", + "type": "error" + }, + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "bucketArn" + }, + "region" + ] + } + ], + "assign": "bucketPartition" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "partitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "bucketPartition" + }, + "name" + ] + }, + { + "fn": "getAttr", + "argv": [ + { + "ref": "partitionResult" + }, + "name" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "isValidHostLabel", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "bucketArn" + }, + "region" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "bucketArn" + }, + "accountId" + ] + }, + "" + ] + } + ], + "error": "Invalid ARN: Missing account id", + "type": "error" + }, + { + "conditions": [ + { + "fn": "isValidHostLabel", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "bucketArn" + }, + "accountId" + ] + }, + false + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "isValidHostLabel", + "argv": [ + { + "ref": "accessPointName" + }, + false + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + } + ], + "endpoint": { + "url": "{url#scheme}://{accessPointName}-{bucketArn#accountId}.{url#authority}{url#path}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3-object-lambda", + "signingRegion": "{bucketArn#region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "endpoint": { + "url": "https://{accessPointName}-{bucketArn#accountId}.s3-object-lambda-fips.{bucketArn#region}.{bucketPartition#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3-object-lambda", + "signingRegion": "{bucketArn#region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{accessPointName}-{bucketArn#accountId}.s3-object-lambda.{bucketArn#region}.{bucketPartition#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3-object-lambda", + "signingRegion": "{bucketArn#region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid ARN: The access point name may only contain a-z, A-Z, 0-9 and `-`. Found: `{accessPointName}`", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid ARN: The account id may only contain a-z, A-Z, 0-9 and `-`. Found: `{bucketArn#accountId}`", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid region in ARN: `{bucketArn#region}` (invalid DNS name)", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Client was configured for partition `{partitionResult#name}` but ARN (`{Bucket}`) has `{bucketPartition#name}`", + "type": "error" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid ARN: The ARN may only contain a single resource component after `accesspoint`.", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid ARN: bucket ARN is missing a region", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid ARN: Expected a resource of the format `accesspoint:` but no name was provided", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid ARN: Object Lambda ARNs only support `accesspoint` arn types, but found: `{arnType}`", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "arnType" + }, + "accesspoint" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "bucketArn" + }, + "resourceId[1]" + ], + "assign": "accessPointName" + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "accessPointName" + }, + "" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "bucketArn" + }, + "region" + ] + }, + "" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "arnType" + }, + "accesspoint" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "bucketArn" + }, + "region" + ] + }, + "" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "DisableAccessPoints" + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "DisableAccessPoints" + }, + true + ] + } + ], + "error": "Access points are not supported for this operation", + "type": "error" + }, + { + "conditions": [ + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "bucketArn" + }, + "resourceId[2]" + ] + } + ] + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "UseArnRegion" + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseArnRegion" + }, + false + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "bucketArn" + }, + "region" + ] + }, + "{Region}" + ] + } + ] + } + ], + "error": "Invalid configuration: region from ARN `{bucketArn#region}` does not match client region `{Region}` and UseArnRegion is `false`", + "type": "error" + }, + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "bucketArn" + }, + "region" + ] + } + ], + "assign": "bucketPartition" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "partitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "bucketPartition" + }, + "name" + ] + }, + "{partitionResult#name}" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "isValidHostLabel", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "bucketArn" + }, + "region" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "bucketArn" + }, + "service" + ] + }, + "s3" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "isValidHostLabel", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "bucketArn" + }, + "accountId" + ] + }, + false + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "isValidHostLabel", + "argv": [ + { + "ref": "accessPointName" + }, + false + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "Accelerate" + }, + true + ] + } + ], + "error": "Access Points do not support S3 Accelerate", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "endpoint": { + "url": "https://{accessPointName}-{bucketArn#accountId}.s3-accesspoint-fips.dualstack.{bucketArn#region}.{bucketPartition#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{bucketArn#region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "endpoint": { + "url": "https://{accessPointName}-{bucketArn#accountId}.s3-accesspoint-fips.{bucketArn#region}.{bucketPartition#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{bucketArn#region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "endpoint": { + "url": "https://{accessPointName}-{bucketArn#accountId}.s3-accesspoint.dualstack.{bucketArn#region}.{bucketPartition#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{bucketArn#region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + }, + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + } + ], + "endpoint": { + "url": "{url#scheme}://{accessPointName}-{bucketArn#accountId}.{url#authority}{url#path}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{bucketArn#region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "endpoint": { + "url": "https://{accessPointName}-{bucketArn#accountId}.s3-accesspoint.{bucketArn#region}.{bucketPartition#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{bucketArn#region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid ARN: The access point name may only contain a-z, A-Z, 0-9 and `-`. Found: `{accessPointName}`", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid ARN: The account id may only contain a-z, A-Z, 0-9 and `-`. Found: `{bucketArn#accountId}`", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid ARN: The ARN was not for the S3 service, found: {bucketArn#service}", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid region in ARN: `{bucketArn#region}` (invalid DNS name)", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Client was configured for partition `{partitionResult#name}` but ARN (`{Bucket}`) has `{bucketPartition#name}`", + "type": "error" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid ARN: The ARN may only contain a single resource component after `accesspoint`.", + "type": "error" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isValidHostLabel", + "argv": [ + { + "ref": "accessPointName" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "S3 MRAP does not support dual-stack", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "S3 MRAP does not support FIPS", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "Accelerate" + }, + true + ] + } + ], + "error": "S3 MRAP does not support S3 Accelerate", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "DisableMultiRegionAccessPoints" + }, + true + ] + } + ], + "error": "Invalid configuration: Multi-Region Access Point ARNs are disabled.", + "type": "error" + }, + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "mrapPartition" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "mrapPartition" + }, + "name" + ] + }, + { + "fn": "getAttr", + "argv": [ + { + "ref": "bucketArn" + }, + "partition" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://{accessPointName}.accesspoint.s3-global.{mrapPartition#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4a", + "signingName": "s3", + "signingRegionSet": [ + "*" + ] + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Client was configured for partition `{mrapPartition#name}` but bucket referred to partition `{bucketArn#partition}`", + "type": "error" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Access Point Name", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid ARN: Expected a resource of the format `accesspoint:` but no name was provided", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "bucketArn" + }, + "service" + ] + }, + "s3-outposts" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "S3 Outposts does not support Dual-stack", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "S3 Outposts does not support FIPS", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "Accelerate" + }, + true + ] + } + ], + "error": "S3 Outposts does not support S3 Accelerate", + "type": "error" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "bucketArn" + }, + "resourceId[4]" + ] + } + ] + } + ], + "error": "Invalid Arn: Outpost Access Point ARN contains sub resources", + "type": "error" + }, + { + "conditions": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "bucketArn" + }, + "resourceId[1]" + ], + "assign": "outpostId" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "isValidHostLabel", + "argv": [ + { + "ref": "outpostId" + }, + false + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "UseArnRegion" + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseArnRegion" + }, + false + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "bucketArn" + }, + "region" + ] + }, + "{Region}" + ] + } + ] + } + ], + "error": "Invalid configuration: region from ARN `{bucketArn#region}` does not match client region `{Region}` and UseArnRegion is `false`", + "type": "error" + }, + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "bucketArn" + }, + "region" + ] + } + ], + "assign": "bucketPartition" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "partitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "bucketPartition" + }, + "name" + ] + }, + { + "fn": "getAttr", + "argv": [ + { + "ref": "partitionResult" + }, + "name" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "isValidHostLabel", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "bucketArn" + }, + "region" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "isValidHostLabel", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "bucketArn" + }, + "accountId" + ] + }, + false + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "bucketArn" + }, + "resourceId[2]" + ], + "assign": "outpostType" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "bucketArn" + }, + "resourceId[3]" + ], + "assign": "accessPointName" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "outpostType" + }, + "accesspoint" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + } + ], + "endpoint": { + "url": "https://{accessPointName}-{bucketArn#accountId}.{outpostId}.{url#authority}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4a", + "signingName": "s3-outposts", + "signingRegionSet": [ + "*" + ] + }, + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3-outposts", + "signingRegion": "{bucketArn#region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{accessPointName}-{bucketArn#accountId}.{outpostId}.s3-outposts.{bucketArn#region}.{bucketPartition#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4a", + "signingName": "s3-outposts", + "signingRegionSet": [ + "*" + ] + }, + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3-outposts", + "signingRegion": "{bucketArn#region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Expected an outpost type `accesspoint`, found {outpostType}", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid ARN: expected an access point name", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid ARN: Expected a 4-component resource", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid ARN: The account id may only contain a-z, A-Z, 0-9 and `-`. Found: `{bucketArn#accountId}`", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid region in ARN: `{bucketArn#region}` (invalid DNS name)", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Client was configured for partition `{partitionResult#name}` but ARN (`{Bucket}`) has `{bucketPartition#name}`", + "type": "error" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid ARN: The outpost Id may only contain a-z, A-Z, 0-9 and `-`. Found: `{outpostId}`", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid ARN: The Outpost Id was not set", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid ARN: Unrecognized format: {Bucket} (type: {arnType})", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid ARN: No ARN type specified", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 0, + 4, + false + ], + "assign": "arnPrefix" + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "arnPrefix" + }, + "arn:" + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "fn": "aws.parseArn", + "argv": [ + { + "ref": "Bucket" + } + ] + } + ] + } + ] + } + ], + "error": "Invalid ARN: `{Bucket}` was not a valid ARN", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "ForcePathStyle" + }, + true + ] + }, + { + "fn": "aws.parseArn", + "argv": [ + { + "ref": "Bucket" + } + ] + } + ], + "error": "Path-style addressing cannot be used with ARN buckets", + "type": "error" + }, + { + "conditions": [ + { + "fn": "uriEncode", + "argv": [ + { + "ref": "Bucket" + } + ], + "assign": "uri_encoded_bucket" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "partitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "Accelerate" + }, + false + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ], + "endpoint": { + "url": "https://s3-fips.dualstack.us-east-1.{partitionResult#dnsSuffix}/{uri_encoded_bucket}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseGlobalEndpoint" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://s3-fips.dualstack.{Region}.{partitionResult#dnsSuffix}/{uri_encoded_bucket}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseGlobalEndpoint" + }, + false + ] + } + ], + "endpoint": { + "url": "https://s3-fips.dualstack.{Region}.{partitionResult#dnsSuffix}/{uri_encoded_bucket}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ], + "endpoint": { + "url": "https://s3-fips.us-east-1.{partitionResult#dnsSuffix}/{uri_encoded_bucket}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseGlobalEndpoint" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://s3-fips.{Region}.{partitionResult#dnsSuffix}/{uri_encoded_bucket}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseGlobalEndpoint" + }, + false + ] + } + ], + "endpoint": { + "url": "https://s3-fips.{Region}.{partitionResult#dnsSuffix}/{uri_encoded_bucket}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ], + "endpoint": { + "url": "https://s3.dualstack.us-east-1.{partitionResult#dnsSuffix}/{uri_encoded_bucket}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseGlobalEndpoint" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://s3.dualstack.{Region}.{partitionResult#dnsSuffix}/{uri_encoded_bucket}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseGlobalEndpoint" + }, + false + ] + } + ], + "endpoint": { + "url": "https://s3.dualstack.{Region}.{partitionResult#dnsSuffix}/{uri_encoded_bucket}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + }, + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ], + "endpoint": { + "url": "{url#scheme}://{url#authority}{url#normalizedPath}{uri_encoded_bucket}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + }, + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseGlobalEndpoint" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-east-1" + ] + } + ], + "endpoint": { + "url": "{url#scheme}://{url#authority}{url#normalizedPath}{uri_encoded_bucket}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "{url#scheme}://{url#authority}{url#normalizedPath}{uri_encoded_bucket}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + }, + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseGlobalEndpoint" + }, + false + ] + } + ], + "endpoint": { + "url": "{url#scheme}://{url#authority}{url#normalizedPath}{uri_encoded_bucket}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ], + "endpoint": { + "url": "https://s3.{partitionResult#dnsSuffix}/{uri_encoded_bucket}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseGlobalEndpoint" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-east-1" + ] + } + ], + "endpoint": { + "url": "https://s3.{partitionResult#dnsSuffix}/{uri_encoded_bucket}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://s3.{Region}.{partitionResult#dnsSuffix}/{uri_encoded_bucket}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseGlobalEndpoint" + }, + false + ] + } + ], + "endpoint": { + "url": "https://s3.{Region}.{partitionResult#dnsSuffix}/{uri_encoded_bucket}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Path-style addressing cannot be used with S3 Accelerate", + "type": "error" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "UseObjectLambdaEndpoint" + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseObjectLambdaEndpoint" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "partitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "isValidHostLabel", + "argv": [ + { + "ref": "Region" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "S3 Object Lambda does not support Dual-stack", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "Accelerate" + }, + true + ] + } + ], + "error": "S3 Object Lambda does not support S3 Accelerate", + "type": "error" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + } + ], + "endpoint": { + "url": "{url#scheme}://{url#authority}{url#path}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3-object-lambda", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "endpoint": { + "url": "https://s3-object-lambda-fips.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3-object-lambda", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://s3-object-lambda.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3-object-lambda", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid region: region was not a valid DNS name.", + "type": "error" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Bucket" + } + ] + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "partitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "isValidHostLabel", + "argv": [ + { + "ref": "Region" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ], + "endpoint": { + "url": "https://s3-fips.dualstack.us-east-1.{partitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseGlobalEndpoint" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://s3-fips.dualstack.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseGlobalEndpoint" + }, + false + ] + } + ], + "endpoint": { + "url": "https://s3-fips.dualstack.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ], + "endpoint": { + "url": "https://s3-fips.us-east-1.{partitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseGlobalEndpoint" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://s3-fips.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseGlobalEndpoint" + }, + false + ] + } + ], + "endpoint": { + "url": "https://s3-fips.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ], + "endpoint": { + "url": "https://s3.dualstack.us-east-1.{partitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseGlobalEndpoint" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://s3.dualstack.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseGlobalEndpoint" + }, + false + ] + } + ], + "endpoint": { + "url": "https://s3.dualstack.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + }, + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ], + "endpoint": { + "url": "{url#scheme}://{url#authority}{url#path}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + }, + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseGlobalEndpoint" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-east-1" + ] + } + ], + "endpoint": { + "url": "{url#scheme}://{url#authority}{url#path}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "{url#scheme}://{url#authority}{url#path}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + }, + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseGlobalEndpoint" + }, + false + ] + } + ], + "endpoint": { + "url": "{url#scheme}://{url#authority}{url#path}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ], + "endpoint": { + "url": "https://s3.{partitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseGlobalEndpoint" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-east-1" + ] + } + ], + "endpoint": { + "url": "https://s3.{partitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://s3.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseGlobalEndpoint" + }, + false + ] + } + ], + "endpoint": { + "url": "https://s3.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid region: region was not a valid DNS name.", + "type": "error" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "A region must be set when sending requests to S3.", + "type": "error" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "region is not a valid DNS-suffix", + "expect": { + "error": "Invalid region: region was not a valid DNS name." + }, + "params": { + "Region": "a b", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false + } + }, + { + "documentation": "Invalid access point ARN: Not S3", + "expect": { + "error": "Invalid ARN: The ARN was not for the S3 service, found: not-s3" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:not-s3:us-west-2:123456789012:accesspoint:myendpoint", + "Key": "key" + } + } + ], + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "Bucket": "arn:aws:not-s3:us-west-2:123456789012:accesspoint:myendpoint" + } + }, + { + "documentation": "Invalid access point ARN: invalid resource", + "expect": { + "error": "Invalid ARN: The ARN may only contain a single resource component after `accesspoint`." + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:myendpoint:more-data", + "Key": "key" + } + } + ], + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:myendpoint:more-data" + } + }, + { + "documentation": "Invalid access point ARN: invalid no ap name", + "expect": { + "error": "Invalid ARN: Expected a resource of the format `accesspoint:` but no name was provided" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:", + "Key": "key" + } + } + ], + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:" + } + }, + { + "documentation": "Invalid access point ARN: AccountId is invalid", + "expect": { + "error": "Invalid ARN: The account id may only contain a-z, A-Z, 0-9 and `-`. Found: `123456_789012`" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3:us-west-2:123456_789012:accesspoint:apname", + "Key": "key" + } + } + ], + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "Bucket": "arn:aws:s3:us-west-2:123456_789012:accesspoint:apname" + } + }, + { + "documentation": "Invalid access point ARN: access point name is invalid", + "expect": { + "error": "Invalid ARN: The access point name may only contain a-z, A-Z, 0-9 and `-`. Found: `ap_name`" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:ap_name", + "Key": "key" + } + } + ], + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:ap_name" + } + }, + { + "documentation": "Access points (disable access points explicitly false)", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://myendpoint-123456789012.s3-accesspoint.us-west-2.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:myendpoint", + "Key": "key" + } + } + ], + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "DisableAccessPoints": false, + "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:myendpoint" + } + }, + { + "documentation": "Access points: partition does not support FIPS", + "expect": { + "error": "Partition does not support FIPS" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::UseFIPS": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3:cn-north-1:123456789012:accesspoint:myendpoint", + "Key": "key" + } + } + ], + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false, + "Accelerate": false, + "Bucket": "arn:aws:s3:cn-north-1:123456789012:accesspoint:myendpoint" + } + }, + { + "documentation": "Bucket region is invalid", + "expect": { + "error": "Invalid region in ARN: `us-west -2` (invalid DNS name)" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3:us-west -2:123456789012:accesspoint:myendpoint", + "Key": "key" + } + } + ], + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "DisableAccessPoints": false, + "Bucket": "arn:aws:s3:us-west -2:123456789012:accesspoint:myendpoint" + } + }, + { + "documentation": "Access points when Access points explicitly disabled (used for CreateBucket)", + "expect": { + "error": "Access points are not supported for this operation" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1" + }, + "operationName": "CreateBucket", + "operationParams": { + "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:myendpoint" + } + } + ], + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "DisableAccessPoints": true, + "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:myendpoint" + } + }, + { + "documentation": "missing arn type", + "expect": { + "error": "Invalid ARN: `arn:aws:s3:us-west-2:123456789012:` was not a valid ARN" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3:us-west-2:123456789012:", + "Key": "key" + } + } + ], + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "DisableAccessPoints": true, + "Bucket": "arn:aws:s3:us-west-2:123456789012:" + } + }, + { + "documentation": "SDK::Host + access point + Dualstack is an error", + "expect": { + "error": "Cannot set dual-stack in combination with a custom endpoint." + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::UseDualStack": true, + "SDK::Endpoint": "https://beta.example.com" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws-cn:s3:cn-north-1:123456789012:accesspoint:myendpoint", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "arn:aws-cn:s3:cn-north-1:123456789012:accesspoint:myendpoint", + "ForcePathStyle": false, + "Endpoint": "https://beta.example.com", + "Region": "cn-north-1", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "Access point ARN with FIPS & Dualstack", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://myendpoint-123456789012.s3-accesspoint-fips.dualstack.us-west-2.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:myendpoint", + "Key": "key" + } + } + ], + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true, + "Accelerate": false, + "DisableAccessPoints": false, + "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:myendpoint" + } + }, + { + "documentation": "Access point ARN with Dualstack", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://myendpoint-123456789012.s3-accesspoint.dualstack.us-west-2.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseDualStack": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:myendpoint", + "Key": "key" + } + } + ], + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Accelerate": false, + "DisableAccessPoints": false, + "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:myendpoint" + } + }, + { + "documentation": "vanilla MRAP", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4a", + "signingRegionSet": [ + "*" + ], + "signingName": "s3", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://mfzwi23gnjvgw.mrap.accesspoint.s3-global.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3::123456789012:accesspoint:mfzwi23gnjvgw.mrap", + "Key": "key" + } + } + ], + "params": { + "Bucket": "arn:aws:s3::123456789012:accesspoint:mfzwi23gnjvgw.mrap", + "Region": "us-east-1", + "DisableMultiRegionAccessPoints": false, + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false + } + }, + { + "documentation": "MRAP does not support FIPS", + "expect": { + "error": "S3 MRAP does not support FIPS" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3::123456789012:accesspoint:mfzwi23gnjvgw.mrap", + "Key": "key" + } + } + ], + "params": { + "Bucket": "arn:aws:s3::123456789012:accesspoint:mfzwi23gnjvgw.mrap", + "Region": "us-east-1", + "DisableMultiRegionAccessPoints": false, + "UseFIPS": true, + "UseDualStack": false, + "Accelerate": false + } + }, + { + "documentation": "MRAP does not support DualStack", + "expect": { + "error": "S3 MRAP does not support dual-stack" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseDualStack": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3::123456789012:accesspoint:mfzwi23gnjvgw.mrap", + "Key": "key" + } + } + ], + "params": { + "Bucket": "arn:aws:s3::123456789012:accesspoint:mfzwi23gnjvgw.mrap", + "Region": "us-east-1", + "DisableMultiRegionAccessPoints": false, + "UseFIPS": false, + "UseDualStack": true, + "Accelerate": false + } + }, + { + "documentation": "MRAP does not support S3 Accelerate", + "expect": { + "error": "S3 MRAP does not support S3 Accelerate" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::S3::Accelerate": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3::123456789012:accesspoint:mfzwi23gnjvgw.mrap", + "Key": "key" + } + } + ], + "params": { + "Bucket": "arn:aws:s3::123456789012:accesspoint:mfzwi23gnjvgw.mrap", + "Region": "us-east-1", + "DisableMultiRegionAccessPoints": false, + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": true + } + }, + { + "documentation": "MRAP explicitly disabled", + "expect": { + "error": "Invalid configuration: Multi-Region Access Point ARNs are disabled." + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::S3::DisableMultiRegionAccessPoints": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3::123456789012:accesspoint:mfzwi23gnjvgw.mrap", + "Key": "key" + } + } + ], + "params": { + "Bucket": "arn:aws:s3::123456789012:accesspoint:mfzwi23gnjvgw.mrap", + "Region": "us-east-1", + "DisableMultiRegionAccessPoints": true, + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false + } + }, + { + "documentation": "Dual-stack endpoint with path-style forced", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3.dualstack.us-west-2.amazonaws.com/bucketname" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::UseDualStack": true, + "AWS::S3::ForcePathStyle": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucketname", + "Key": "key" + } + } + ], + "params": { + "Bucket": "bucketname", + "Region": "us-west-2", + "ForcePathStyle": true, + "UseFIPS": false, + "Accelerate": false, + "UseDualStack": true + } + }, + { + "documentation": "Dual-stack endpoint + SDK::Host is error", + "expect": { + "error": "Cannot set dual-stack in combination with a custom endpoint." + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::UseDualStack": true, + "SDK::Endpoint": "https://abc.com", + "AWS::S3::ForcePathStyle": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucketname", + "Key": "key" + } + } + ], + "params": { + "Bucket": "bucketname", + "Region": "us-west-2", + "ForcePathStyle": true, + "UseFIPS": false, + "Accelerate": false, + "UseDualStack": true, + "Endpoint": "https://abc.com" + } + }, + { + "documentation": "path style + ARN bucket", + "expect": { + "error": "Path-style addressing cannot be used with ARN buckets" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::S3::ForcePathStyle": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3::123456789012:accesspoint:mfzwi23gnjvgw.mrap", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "arn:aws:s3::123456789012:accesspoint:mfzwi23gnjvgw.mrap", + "ForcePathStyle": true, + "Region": "us-west-2", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "implicit path style bucket + dualstack", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3.dualstack.us-west-2.amazonaws.com/99_ab" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::UseDualStack": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "99_ab", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "99_ab", + "Region": "us-west-2", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "implicit path style bucket + dualstack", + "expect": { + "error": "Cannot set dual-stack in combination with a custom endpoint." + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::UseDualStack": true, + "SDK::Endpoint": "http://abc.com" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "99_ab", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "99_ab", + "Region": "us-west-2", + "UseDualStack": true, + "UseFIPS": false, + "Endpoint": "http://abc.com" + } + }, + { + "documentation": "don't allow URL injections in the bucket", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3.us-west-2.amazonaws.com/example.com%23" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "example.com#", + "Key": "key" + } + } + ], + "params": { + "Bucket": "example.com#", + "Region": "us-west-2", + "UseDualStack": false, + "UseFIPS": false, + "Accelerate": false + } + }, + { + "documentation": "URI encode bucket names in the path", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3.us-west-2.amazonaws.com/bucket%20name" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket name", + "Key": "key" + } + } + ], + "params": { + "Bucket": "bucket name", + "Region": "us-west-2", + "UseDualStack": false, + "UseFIPS": false, + "Accelerate": false + } + }, + { + "documentation": "scheme is respected", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "af-south-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "http://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com/99_ab" + } + }, + "params": { + "Accelerate": false, + "Bucket": "99_ab", + "Endpoint": "http://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", + "Region": "af-south-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "scheme is respected (virtual addressing)", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "af-south-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "http://bucketname.control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com/foo" + } + }, + "params": { + "Accelerate": false, + "Bucket": "bucketname", + "Endpoint": "http://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com/foo", + "Region": "af-south-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "path style + implicit private link", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "af-south-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com/99_ab" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "af-south-1", + "SDK::Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "99_ab", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "99_ab", + "Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", + "Region": "af-south-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "invalid Endpoint override", + "expect": { + "error": "Custom endpoint `abcde://nota#url` was not a valid URI" + }, + "params": { + "Accelerate": false, + "Bucket": "bucketname", + "Endpoint": "abcde://nota#url", + "Region": "af-south-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "using an IPv4 address forces path style", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "af-south-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://123.123.0.1/bucketname" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "af-south-1", + "SDK::Endpoint": "https://123.123.0.1" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucketname", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "bucketname", + "Endpoint": "https://123.123.0.1", + "Region": "af-south-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "vanilla access point arn with region mismatch and UseArnRegion=false", + "expect": { + "error": "Invalid configuration: region from ARN `us-east-1` does not match client region `us-west-2` and UseArnRegion is `false`" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::S3::UseArnRegion": false + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3:us-east-1:123456789012:accesspoint:myendpoint", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "arn:aws:s3:us-east-1:123456789012:accesspoint:myendpoint", + "ForcePathStyle": false, + "UseArnRegion": false, + "Region": "us-west-2", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "vanilla access point arn with region mismatch and UseArnRegion unset", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://myendpoint-123456789012.s3-accesspoint.us-west-2.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:myendpoint", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:myendpoint", + "ForcePathStyle": false, + "Region": "us-east-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "vanilla access point arn with region mismatch and UseArnRegion=true", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://myendpoint-123456789012.s3-accesspoint.us-west-2.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::S3::UseArnRegion": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:myendpoint", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:myendpoint", + "ForcePathStyle": false, + "UseArnRegion": true, + "Region": "us-east-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "subdomains are not allowed in virtual buckets", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true, + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://s3.us-east-1.amazonaws.com/bucket.name" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket.name", + "Key": "key" + } + } + ], + "params": { + "Bucket": "bucket.name", + "Region": "us-east-1" + } + }, + { + "documentation": "bucket names with 3 characters are allowed in virtual buckets", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true, + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://aaa.s3.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "aaa", + "Key": "key" + } + } + ], + "params": { + "Bucket": "aaa", + "Region": "us-east-1" + } + }, + { + "documentation": "bucket names with fewer than 3 characters are not allowed in virtual host", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true, + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://s3.us-east-1.amazonaws.com/aa" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "aa", + "Key": "key" + } + } + ], + "params": { + "Bucket": "aa", + "Region": "us-east-1" + } + }, + { + "documentation": "bucket names with uppercase characters are not allowed in virtual host", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true, + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://s3.us-east-1.amazonaws.com/BucketName" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "BucketName", + "Key": "key" + } + } + ], + "params": { + "Bucket": "BucketName", + "Region": "us-east-1" + } + }, + { + "documentation": "subdomains are allowed in virtual buckets on http endpoints", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true, + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://bucket.name.example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "SDK::Endpoint": "http://example.com" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket.name", + "Key": "key" + } + } + ], + "params": { + "Bucket": "bucket.name", + "Region": "us-east-1", + "Endpoint": "http://example.com" + } + }, + { + "documentation": "no region set", + "expect": { + "error": "A region must be set when sending requests to S3." + }, + "params": { + "Bucket": "bucket-name" + } + }, + { + "documentation": "UseGlobalEndpoints=true, region=us-east-1 uses the global endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::S3::UseGlobalEndpoint": true + }, + "operationName": "ListBuckets" + } + ], + "params": { + "Region": "us-east-1", + "UseGlobalEndpoint": true, + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false + } + }, + { + "documentation": "UseGlobalEndpoints=true, region=us-west-2 uses the regional endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3.us-west-2.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::S3::UseGlobalEndpoint": true + }, + "operationName": "ListBuckets" + } + ], + "params": { + "Region": "us-west-2", + "UseGlobalEndpoint": true, + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false + } + }, + { + "documentation": "UseGlobalEndpoints=true, region=cn-north-1 uses the regional endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "cn-north-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3.cn-north-1.amazonaws.com.cn" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::S3::UseGlobalEndpoint": true + }, + "operationName": "ListBuckets" + } + ], + "params": { + "Region": "cn-north-1", + "UseGlobalEndpoint": true, + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false + } + }, + { + "documentation": "UseGlobalEndpoints=true, region=us-east-1, fips=true uses the regional endpoint with fips", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3-fips.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::S3::UseGlobalEndpoint": true + }, + "operationName": "ListBuckets" + } + ], + "params": { + "Region": "us-east-1", + "UseGlobalEndpoint": true, + "UseFIPS": true, + "UseDualStack": false, + "Accelerate": false + } + }, + { + "documentation": "UseGlobalEndpoints=true, region=us-east-1, dualstack=true uses the regional endpoint with dualstack", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3.dualstack.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseDualStack": true, + "AWS::S3::UseGlobalEndpoint": true + }, + "operationName": "ListBuckets" + } + ], + "params": { + "Region": "us-east-1", + "UseGlobalEndpoint": true, + "UseFIPS": false, + "UseDualStack": true, + "Accelerate": false + } + }, + { + "documentation": "UseGlobalEndpoints=true, region=us-east-1, dualstack and fips uses the regional endpoint with fips/dualstack", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3-fips.dualstack.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": true, + "AWS::S3::UseGlobalEndpoint": true + }, + "operationName": "ListBuckets" + } + ], + "params": { + "Region": "us-east-1", + "UseGlobalEndpoint": true, + "UseFIPS": true, + "UseDualStack": true, + "Accelerate": false + } + }, + { + "documentation": "UseGlobalEndpoints=true, region=us-east-1 with custom endpoint, uses custom", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "SDK::Endpoint": "https://example.com", + "AWS::S3::UseGlobalEndpoint": true + }, + "operationName": "ListBuckets" + } + ], + "params": { + "Region": "us-east-1", + "Endpoint": "https://example.com", + "UseGlobalEndpoint": true, + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false + } + }, + { + "documentation": "UseGlobalEndpoints=true, region=us-west-2 with custom endpoint, uses custom", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "SDK::Endpoint": "https://example.com", + "AWS::S3::UseGlobalEndpoint": true + }, + "operationName": "ListBuckets" + } + ], + "params": { + "Region": "us-west-2", + "Endpoint": "https://example.com", + "UseGlobalEndpoint": true, + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false + } + }, + { + "documentation": "UseGlobalEndpoints=true, region=us-east-1 with accelerate on non bucket case uses the global endpoint and ignores accelerate", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::S3::Accelerate": true, + "AWS::S3::UseGlobalEndpoint": true + }, + "operationName": "ListBuckets" + } + ], + "params": { + "Region": "us-east-1", + "UseGlobalEndpoint": true, + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": true + } + }, + { + "documentation": "aws-global region uses the global endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "aws-global" + }, + "operationName": "ListBuckets" + } + ], + "params": { + "Region": "aws-global", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false + } + }, + { + "documentation": "aws-global region with fips uses the regional endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3-fips.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "aws-global", + "AWS::UseFIPS": true + }, + "operationName": "ListBuckets" + } + ], + "params": { + "Region": "aws-global", + "UseFIPS": true, + "UseDualStack": false, + "Accelerate": false + } + }, + { + "documentation": "aws-global region with dualstack uses the regional endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3.dualstack.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "aws-global", + "AWS::UseDualStack": true + }, + "operationName": "ListBuckets" + } + ], + "params": { + "Region": "aws-global", + "UseFIPS": false, + "UseDualStack": true, + "Accelerate": false + } + }, + { + "documentation": "aws-global region with fips and dualstack uses the regional endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3-fips.dualstack.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "aws-global", + "AWS::UseFIPS": true, + "AWS::UseDualStack": true + }, + "operationName": "ListBuckets" + } + ], + "params": { + "Region": "aws-global", + "UseFIPS": true, + "UseDualStack": true, + "Accelerate": false + } + }, + { + "documentation": "aws-global region with accelerate on non-bucket case, uses global endpoint and ignores accelerate", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "aws-global", + "AWS::S3::Accelerate": true + }, + "operationName": "ListBuckets" + } + ], + "params": { + "Region": "aws-global", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": true + } + }, + { + "documentation": "aws-global region with custom endpoint, uses custom", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "aws-global", + "SDK::Endpoint": "https://example.com" + }, + "operationName": "ListBuckets" + } + ], + "params": { + "Region": "aws-global", + "Endpoint": "https://example.com", + "UseGlobalEndpoint": false, + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false + } + }, + { + "documentation": "virtual addressing, aws-global region uses the global endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://bucket-name.s3.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "aws-global" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Region": "aws-global", + "Bucket": "bucket-name", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false + } + }, + { + "documentation": "virtual addressing, aws-global region with Prefix, and Key uses the global endpoint. Prefix and Key parameters should not be used in endpoint evaluation.", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://bucket-name.s3.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "aws-global" + }, + "operationName": "ListObjects", + "operationParams": { + "Bucket": "bucket-name", + "Prefix": "prefix" + } + } + ], + "params": { + "Region": "aws-global", + "Bucket": "bucket-name", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "Prefix": "prefix", + "Key": "key" + } + }, + { + "documentation": "virtual addressing, aws-global region with Copy Source, and Key uses the global endpoint. Copy Source and Key parameters should not be used in endpoint evaluation.", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://bucket-name.s3.amazonaws.com" + } + }, + "params": { + "Region": "aws-global", + "Bucket": "bucket-name", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "CopySource": "/copy/source", + "Key": "key" + } + }, + { + "documentation": "virtual addressing, aws-global region with fips uses the regional fips endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://bucket-name.s3-fips.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "aws-global", + "AWS::UseFIPS": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Region": "aws-global", + "Bucket": "bucket-name", + "UseFIPS": true, + "UseDualStack": false, + "Accelerate": false + } + }, + { + "documentation": "virtual addressing, aws-global region with dualstack uses the regional dualstack endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://bucket-name.s3.dualstack.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "aws-global", + "AWS::UseDualStack": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Region": "aws-global", + "Bucket": "bucket-name", + "UseFIPS": false, + "UseDualStack": true, + "Accelerate": false + } + }, + { + "documentation": "virtual addressing, aws-global region with fips/dualstack uses the regional fips/dualstack endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://bucket-name.s3-fips.dualstack.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "aws-global", + "AWS::UseFIPS": true, + "AWS::UseDualStack": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Region": "aws-global", + "Bucket": "bucket-name", + "UseFIPS": true, + "UseDualStack": true, + "Accelerate": false + } + }, + { + "documentation": "virtual addressing, aws-global region with accelerate uses the global accelerate endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://bucket-name.s3-accelerate.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "aws-global", + "AWS::S3::Accelerate": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Region": "aws-global", + "Bucket": "bucket-name", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": true + } + }, + { + "documentation": "virtual addressing, aws-global region with custom endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://bucket-name.example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "aws-global", + "SDK::Endpoint": "https://example.com" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Region": "aws-global", + "Endpoint": "https://example.com", + "Bucket": "bucket-name", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false + } + }, + { + "documentation": "virtual addressing, UseGlobalEndpoint and us-east-1 region uses the global endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://bucket-name.s3.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::S3::UseGlobalEndpoint": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Region": "us-east-1", + "UseGlobalEndpoint": true, + "Bucket": "bucket-name", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false + } + }, + { + "documentation": "virtual addressing, UseGlobalEndpoint and us-west-2 region uses the regional endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://bucket-name.s3.us-west-2.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::S3::UseGlobalEndpoint": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Region": "us-west-2", + "UseGlobalEndpoint": true, + "Bucket": "bucket-name", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false + } + }, + { + "documentation": "virtual addressing, UseGlobalEndpoint and us-east-1 region and fips uses the regional fips endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://bucket-name.s3-fips.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::S3::UseGlobalEndpoint": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Region": "us-east-1", + "UseGlobalEndpoint": true, + "Bucket": "bucket-name", + "UseFIPS": true, + "UseDualStack": false, + "Accelerate": false + } + }, + { + "documentation": "virtual addressing, UseGlobalEndpoint and us-east-1 region and dualstack uses the regional dualstack endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://bucket-name.s3.dualstack.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseDualStack": true, + "AWS::S3::UseGlobalEndpoint": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Region": "us-east-1", + "UseGlobalEndpoint": true, + "Bucket": "bucket-name", + "UseFIPS": false, + "UseDualStack": true, + "Accelerate": false + } + }, + { + "documentation": "virtual addressing, UseGlobalEndpoint and us-east-1 region and accelerate uses the global accelerate endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://bucket-name.s3-accelerate.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::S3::Accelerate": true, + "AWS::S3::UseGlobalEndpoint": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Region": "us-east-1", + "UseGlobalEndpoint": true, + "Bucket": "bucket-name", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": true + } + }, + { + "documentation": "virtual addressing, UseGlobalEndpoint and us-east-1 region with custom endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://bucket-name.example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "SDK::Endpoint": "https://example.com", + "AWS::S3::UseGlobalEndpoint": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Region": "us-east-1", + "Endpoint": "https://example.com", + "UseGlobalEndpoint": true, + "Bucket": "bucket-name", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false + } + }, + { + "documentation": "ForcePathStyle, aws-global region uses the global endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3.amazonaws.com/bucket-name" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "aws-global", + "AWS::S3::ForcePathStyle": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Region": "aws-global", + "Bucket": "bucket-name", + "ForcePathStyle": true, + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false + } + }, + { + "documentation": "ForcePathStyle, aws-global region with fips is invalid", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "signingName": "s3", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true, + "name": "sigv4" + } + ] + }, + "url": "https://s3-fips.us-east-1.amazonaws.com/bucket-name" + } + }, + "params": { + "Region": "aws-global", + "Bucket": "bucket-name", + "ForcePathStyle": true, + "UseFIPS": true, + "UseDualStack": false, + "Accelerate": false + } + }, + { + "documentation": "ForcePathStyle, aws-global region with dualstack uses regional dualstack endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3.dualstack.us-east-1.amazonaws.com/bucket-name" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "aws-global", + "AWS::UseDualStack": true, + "AWS::S3::ForcePathStyle": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Region": "aws-global", + "Bucket": "bucket-name", + "ForcePathStyle": true, + "UseFIPS": false, + "UseDualStack": true, + "Accelerate": false + } + }, + { + "documentation": "ForcePathStyle, aws-global region custom endpoint uses the custom endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://example.com/bucket-name" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "aws-global", + "SDK::Endpoint": "https://example.com", + "AWS::S3::ForcePathStyle": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Region": "aws-global", + "Endpoint": "https://example.com", + "Bucket": "bucket-name", + "ForcePathStyle": true, + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false + } + }, + { + "documentation": "ForcePathStyle, UseGlobalEndpoint us-east-1 region uses the global endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3.amazonaws.com/bucket-name" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::S3::ForcePathStyle": true, + "AWS::S3::UseGlobalEndpoint": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Region": "us-east-1", + "Bucket": "bucket-name", + "UseGlobalEndpoint": true, + "ForcePathStyle": true, + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false + } + }, + { + "documentation": "ForcePathStyle, UseGlobalEndpoint us-west-2 region uses the regional endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3.us-west-2.amazonaws.com/bucket-name" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::S3::ForcePathStyle": true, + "AWS::S3::UseGlobalEndpoint": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Region": "us-west-2", + "Bucket": "bucket-name", + "UseGlobalEndpoint": true, + "ForcePathStyle": true, + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false + } + }, + { + "documentation": "ForcePathStyle, UseGlobalEndpoint us-east-1 region, dualstack uses the regional dualstack endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3.dualstack.us-east-1.amazonaws.com/bucket-name" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseDualStack": true, + "AWS::S3::ForcePathStyle": true, + "AWS::S3::UseGlobalEndpoint": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Region": "us-east-1", + "Bucket": "bucket-name", + "UseGlobalEndpoint": true, + "ForcePathStyle": true, + "UseFIPS": false, + "UseDualStack": true, + "Accelerate": false + } + }, + { + "documentation": "ForcePathStyle, UseGlobalEndpoint us-east-1 region custom endpoint uses the custom endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://example.com/bucket-name" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "SDK::Endpoint": "https://example.com", + "AWS::S3::ForcePathStyle": true, + "AWS::S3::UseGlobalEndpoint": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Region": "us-east-1", + "Bucket": "bucket-name", + "Endpoint": "https://example.com", + "UseGlobalEndpoint": true, + "ForcePathStyle": true, + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false + } + }, + { + "documentation": "ARN with aws-global region and UseArnRegion uses the regional endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4a", + "signingName": "s3-outposts", + "signingRegionSet": [ + "*" + ], + "disableDoubleEncoding": true + }, + { + "name": "sigv4", + "signingName": "s3-outposts", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://reports-123456789012.op-01234567890123456.s3-outposts.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "aws-global", + "AWS::S3::UseArnRegion": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost/op-01234567890123456/accesspoint/reports", + "Key": "key" + } + } + ], + "params": { + "Region": "aws-global", + "UseArnRegion": true, + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost/op-01234567890123456/accesspoint/reports" + } + }, + { + "documentation": "cross partition MRAP ARN is an error", + "expect": { + "error": "Client was configured for partition `aws` but bucket referred to partition `aws-cn`" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-1" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws-cn:s3::123456789012:accesspoint:mfzwi23gnjvgw.mrap", + "Key": "key" + } + } + ], + "params": { + "Bucket": "arn:aws-cn:s3::123456789012:accesspoint:mfzwi23gnjvgw.mrap", + "Region": "us-west-1" + } + }, + { + "documentation": "Endpoint override, accesspoint with HTTP, port", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "http://myendpoint-123456789012.beta.example.com:1234" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "SDK::Endpoint": "http://beta.example.com:1234" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:myendpoint", + "Key": "key" + } + } + ], + "params": { + "Endpoint": "http://beta.example.com:1234", + "Region": "us-west-2", + "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:myendpoint" + } + }, + { + "documentation": "Endpoint override, accesspoint with http, path, query, and port", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "http://myendpoint-123456789012.beta.example.com:1234/path" + } + }, + "params": { + "Region": "us-west-2", + "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:myendpoint", + "Endpoint": "http://beta.example.com:1234/path", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false + } + }, + { + "documentation": "non-bucket endpoint override with FIPS = error", + "expect": { + "error": "A custom endpoint cannot be combined with FIPS" + }, + "params": { + "Region": "us-west-2", + "Endpoint": "http://beta.example.com:1234/path", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "FIPS + dualstack + custom endpoint", + "expect": { + "error": "Cannot set dual-stack in combination with a custom endpoint." + }, + "params": { + "Region": "us-west-2", + "Endpoint": "http://beta.example.com:1234/path", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "dualstack + custom endpoint", + "expect": { + "error": "Cannot set dual-stack in combination with a custom endpoint." + }, + "params": { + "Region": "us-west-2", + "Endpoint": "http://beta.example.com:1234/path", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "custom endpoint without FIPS/dualstack", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "http://beta.example.com:1234/path" + } + }, + "params": { + "Region": "us-west-2", + "Endpoint": "http://beta.example.com:1234/path", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "s3 object lambda with access points disabled", + "expect": { + "error": "Access points are not supported for this operation" + }, + "params": { + "Region": "us-west-2", + "Bucket": "arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint:myendpoint", + "DisableAccessPoints": true + } + }, + { + "documentation": "non bucket + FIPS", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "standard non bucket endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "non bucket endpoint with FIPS + Dualstack", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3-fips.dualstack.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "non bucket endpoint with dualstack", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3.dualstack.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "use global endpoint + IP address endpoint override", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true, + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://127.0.0.1/bucket" + } + }, + "params": { + "Region": "us-east-1", + "Bucket": "bucket", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "http://127.0.0.1", + "UseGlobalEndpoint": true + } + }, + { + "documentation": "non-dns endpoint + global endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true, + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://s3.amazonaws.com/bucket%21" + } + }, + "params": { + "Region": "us-east-1", + "Bucket": "bucket!", + "UseFIPS": false, + "UseDualStack": false, + "UseGlobalEndpoint": true + } + }, + { + "documentation": "endpoint override + use global endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true, + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://foo.com/bucket%21" + } + }, + "params": { + "Region": "us-east-1", + "Bucket": "bucket!", + "UseFIPS": false, + "UseDualStack": false, + "UseGlobalEndpoint": true, + "Endpoint": "http://foo.com" + } + }, + { + "documentation": "FIPS + dualstack + non-bucket endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true, + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://s3-fips.dualstack.us-east-1.amazonaws.com/bucket%21" + } + }, + "params": { + "Region": "us-east-1", + "Bucket": "bucket!", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "FIPS + dualstack + non-DNS endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true, + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://s3-fips.dualstack.us-east-1.amazonaws.com/bucket%21" + } + }, + "params": { + "Region": "us-east-1", + "Bucket": "bucket!", + "ForcePathStyle": true, + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "endpoint override + FIPS + dualstack (BUG)", + "expect": { + "error": "A custom endpoint cannot be combined with FIPS" + }, + "params": { + "Region": "us-east-1", + "Bucket": "bucket!", + "ForcePathStyle": true, + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "http://foo.com" + } + }, + { + "documentation": "endpoint override + non-dns bucket + FIPS (BUG)", + "expect": { + "error": "A custom endpoint cannot be combined with FIPS" + }, + "params": { + "Region": "us-east-1", + "Bucket": "bucket!", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "http://foo.com" + } + }, + { + "documentation": "FIPS + bucket endpoint + force path style", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true, + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://s3-fips.us-east-1.amazonaws.com/bucket%21" + } + }, + "params": { + "Region": "us-east-1", + "Bucket": "bucket!", + "ForcePathStyle": true, + "UseFIPS": true, + "UseDualStack": false, + "UseGlobalEndpoint": true + } + }, + { + "documentation": "bucket + FIPS + force path style", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true, + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://s3-fips.dualstack.us-east-1.amazonaws.com/bucket" + } + }, + "params": { + "Region": "us-east-1", + "Bucket": "bucket", + "ForcePathStyle": true, + "UseFIPS": true, + "UseDualStack": true, + "UseGlobalEndpoint": true + } + }, + { + "documentation": "FIPS + dualstack + use global endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true, + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://bucket.s3-fips.dualstack.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "Bucket": "bucket", + "UseFIPS": true, + "UseDualStack": true, + "UseGlobalEndpoint": true + } + }, + { + "documentation": "URI encoded bucket + use global endpoint", + "expect": { + "error": "A custom endpoint cannot be combined with FIPS" + }, + "params": { + "Region": "us-east-1", + "Bucket": "bucket!", + "UseFIPS": true, + "UseDualStack": false, + "UseGlobalEndpoint": true, + "Endpoint": "https://foo.com" + } + }, + { + "documentation": "FIPS + path based endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true, + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://s3-fips.us-east-1.amazonaws.com/bucket%21" + } + }, + "params": { + "Region": "us-east-1", + "Bucket": "bucket!", + "UseFIPS": true, + "UseDualStack": false, + "Accelerate": false, + "UseGlobalEndpoint": true + } + }, + { + "documentation": "accelerate + dualstack + global endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true, + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://bucket.s3-accelerate.dualstack.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "Bucket": "bucket", + "UseFIPS": false, + "UseDualStack": true, + "Accelerate": true, + "UseGlobalEndpoint": true + } + }, + { + "documentation": "dualstack + global endpoint + non URI safe bucket", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true, + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://s3.dualstack.us-east-1.amazonaws.com/bucket%21" + } + }, + "params": { + "Region": "us-east-1", + "Bucket": "bucket!", + "Accelerate": false, + "UseDualStack": true, + "UseFIPS": false, + "UseGlobalEndpoint": true + } + }, + { + "documentation": "FIPS + uri encoded bucket", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true, + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://s3-fips.us-east-1.amazonaws.com/bucket%21" + } + }, + "params": { + "Region": "us-east-1", + "Bucket": "bucket!", + "ForcePathStyle": true, + "Accelerate": false, + "UseDualStack": false, + "UseFIPS": true, + "UseGlobalEndpoint": true + } + }, + { + "documentation": "endpoint override + non-uri safe endpoint + force path style", + "expect": { + "error": "A custom endpoint cannot be combined with FIPS" + }, + "params": { + "Region": "us-east-1", + "Bucket": "bucket!", + "ForcePathStyle": true, + "Accelerate": false, + "UseDualStack": false, + "UseFIPS": true, + "Endpoint": "http://foo.com", + "UseGlobalEndpoint": true + } + }, + { + "documentation": "FIPS + Dualstack + global endpoint + non-dns bucket", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true, + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://s3-fips.dualstack.us-east-1.amazonaws.com/bucket%21" + } + }, + "params": { + "Region": "us-east-1", + "Bucket": "bucket!", + "Accelerate": false, + "UseDualStack": true, + "UseFIPS": true, + "UseGlobalEndpoint": true + } + }, + { + "documentation": "endpoint override + FIPS + dualstack", + "expect": { + "error": "Cannot set dual-stack in combination with a custom endpoint." + }, + "params": { + "Region": "us-east-1", + "UseDualStack": true, + "UseFIPS": true, + "UseGlobalEndpoint": true, + "Endpoint": "http://foo.com" + } + }, + { + "documentation": "non-bucket endpoint override + dualstack + global endpoint", + "expect": { + "error": "Cannot set dual-stack in combination with a custom endpoint." + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "UseGlobalEndpoint": true, + "Endpoint": "http://foo.com" + } + }, + { + "documentation": "Endpoint override + UseGlobalEndpoint + us-east-1", + "expect": { + "error": "A custom endpoint cannot be combined with FIPS" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "UseGlobalEndpoint": true, + "Endpoint": "http://foo.com" + } + }, + { + "documentation": "non-FIPS partition with FIPS set + custom endpoint", + "expect": { + "error": "Partition does not support FIPS" + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false, + "UseGlobalEndpoint": true + } + }, + { + "documentation": "aws-global signs as us-east-1", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "signingRegion": "us-east-1", + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3-fips.dualstack.us-east-1.amazonaws.com/bucket%21" + } + }, + "params": { + "Region": "aws-global", + "Bucket": "bucket!", + "UseFIPS": true, + "Accelerate": false, + "UseDualStack": true + } + }, + { + "documentation": "aws-global signs as us-east-1", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "signingRegion": "us-east-1", + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://bucket.foo.com" + } + }, + "params": { + "Region": "aws-global", + "Bucket": "bucket", + "UseDualStack": false, + "UseFIPS": false, + "Accelerate": false, + "Endpoint": "https://foo.com" + } + }, + { + "documentation": "aws-global + dualstack + path-only bucket", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "signingRegion": "us-east-1", + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3.dualstack.us-east-1.amazonaws.com/bucket%21" + } + }, + "params": { + "Region": "aws-global", + "Bucket": "bucket!", + "UseDualStack": true, + "UseFIPS": false, + "Accelerate": false + } + }, + { + "documentation": "aws-global + path-only bucket", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "signingRegion": "us-east-1", + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3.amazonaws.com/bucket%21" + } + }, + "params": { + "Region": "aws-global", + "Bucket": "bucket!" + } + }, + { + "documentation": "aws-global + fips + custom endpoint", + "expect": { + "error": "A custom endpoint cannot be combined with FIPS" + }, + "params": { + "Region": "aws-global", + "Bucket": "bucket!", + "UseDualStack": false, + "UseFIPS": true, + "Accelerate": false, + "Endpoint": "http://foo.com" + } + }, + { + "documentation": "aws-global, endpoint override & path only-bucket", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "signingRegion": "us-east-1", + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true + } + ] + }, + "url": "http://foo.com/bucket%21" + } + }, + "params": { + "Region": "aws-global", + "Bucket": "bucket!", + "UseDualStack": false, + "UseFIPS": false, + "Accelerate": false, + "Endpoint": "http://foo.com" + } + }, + { + "documentation": "aws-global + dualstack + custom endpoint", + "expect": { + "error": "Cannot set dual-stack in combination with a custom endpoint." + }, + "params": { + "Region": "aws-global", + "UseDualStack": true, + "UseFIPS": false, + "Accelerate": false, + "Endpoint": "http://foo.com" + } + }, + { + "documentation": "accelerate, dualstack + aws-global", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "signingRegion": "us-east-1", + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://bucket.s3-accelerate.dualstack.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "aws-global", + "Bucket": "bucket", + "UseDualStack": true, + "UseFIPS": false, + "Accelerate": true + } + }, + { + "documentation": "FIPS + aws-global + path only bucket. This is not supported by S3 but we allow garbage in garbage out", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "signingRegion": "us-east-1", + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3-fips.dualstack.us-east-1.amazonaws.com/bucket%21" + } + }, + "params": { + "Region": "aws-global", + "Bucket": "bucket!", + "ForcePathStyle": true, + "UseDualStack": true, + "UseFIPS": true, + "Accelerate": false + } + }, + { + "documentation": "aws-global + FIPS + endpoint override.", + "expect": { + "error": "A custom endpoint cannot be combined with FIPS" + }, + "params": { + "Region": "aws-global", + "UseFIPS": true, + "Endpoint": "http://foo.com" + } + }, + { + "documentation": "force path style, FIPS, aws-global & endpoint override", + "expect": { + "error": "A custom endpoint cannot be combined with FIPS" + }, + "params": { + "Region": "aws-global", + "Bucket": "bucket!", + "ForcePathStyle": true, + "UseFIPS": true, + "Endpoint": "http://foo.com" + } + }, + { + "documentation": "ip address causes path style to be forced", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "signingRegion": "us-east-1", + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true + } + ] + }, + "url": "http://192.168.1.1/bucket" + } + }, + "params": { + "Region": "aws-global", + "Bucket": "bucket", + "Endpoint": "http://192.168.1.1" + } + }, + { + "documentation": "endpoint override with aws-global region", + "expect": { + "error": "Cannot set dual-stack in combination with a custom endpoint." + }, + "params": { + "Region": "aws-global", + "UseFIPS": true, + "UseDualStack": true, + "Endpoint": "http://foo.com" + } + }, + { + "documentation": "FIPS + path-only (TODO: consider making this an error)", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "signingRegion": "us-east-1", + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3-fips.us-east-1.amazonaws.com/bucket%21" + } + }, + "params": { + "Region": "aws-global", + "Bucket": "bucket!", + "UseFIPS": true + } + }, + { + "documentation": "empty arn type", + "expect": { + "error": "Invalid ARN: No ARN type specified" + }, + "params": { + "Region": "us-east-2", + "Bucket": "arn:aws:not-s3:us-west-2:123456789012::myendpoint" + } + }, + { + "documentation": "path style can't be used with accelerate", + "expect": { + "error": "Path-style addressing cannot be used with S3 Accelerate" + }, + "params": { + "Region": "us-east-2", + "Bucket": "bucket!", + "Accelerate": true + } + }, + { + "documentation": "invalid region", + "expect": { + "error": "Invalid region: region was not a valid DNS name." + }, + "params": { + "Region": "us-east-2!", + "Bucket": "bucket.subdomain", + "Endpoint": "http://foo.com" + } + }, + { + "documentation": "invalid region", + "expect": { + "error": "Invalid region: region was not a valid DNS name." + }, + "params": { + "Region": "us-east-2!", + "Bucket": "bucket", + "Endpoint": "http://foo.com" + } + }, + { + "documentation": "empty arn type", + "expect": { + "error": "Invalid Access Point Name" + }, + "params": { + "Region": "us-east-2", + "Bucket": "arn:aws:s3::123456789012:accesspoint:my_endpoint" + } + }, + { + "documentation": "empty arn type", + "expect": { + "error": "Client was configured for partition `aws` but ARN (`arn:aws:s3:cn-north-1:123456789012:accesspoint:my-endpoint`) has `aws-cn`" + }, + "params": { + "Region": "us-east-2", + "Bucket": "arn:aws:s3:cn-north-1:123456789012:accesspoint:my-endpoint", + "UseArnRegion": true + } + }, + { + "documentation": "invalid arn region", + "expect": { + "error": "Invalid region in ARN: `us-east_2` (invalid DNS name)" + }, + "params": { + "Region": "us-east-2", + "Bucket": "arn:aws:s3-object-lambda:us-east_2:123456789012:accesspoint:my-endpoint", + "UseArnRegion": true + } + }, + { + "documentation": "invalid ARN outpost", + "expect": { + "error": "Invalid ARN: The outpost Id may only contain a-z, A-Z, 0-9 and `-`. Found: `op_01234567890123456`" + }, + "params": { + "Region": "us-east-2", + "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost/op_01234567890123456/accesspoint/reports", + "UseArnRegion": true + } + }, + { + "documentation": "invalid ARN", + "expect": { + "error": "Invalid ARN: expected an access point name" + }, + "params": { + "Region": "us-east-2", + "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost/op-01234567890123456/reports" + } + }, + { + "documentation": "invalid ARN", + "expect": { + "error": "Invalid ARN: Expected a 4-component resource" + }, + "params": { + "Region": "us-east-2", + "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost/op-01234567890123456" + } + }, + { + "documentation": "invalid outpost type", + "expect": { + "error": "Expected an outpost type `accesspoint`, found not-accesspoint" + }, + "params": { + "Region": "us-east-2", + "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost/op-01234567890123456/not-accesspoint/reports" + } + }, + { + "documentation": "invalid outpost type", + "expect": { + "error": "Invalid region in ARN: `us-east_1` (invalid DNS name)" + }, + "params": { + "Region": "us-east-2", + "Bucket": "arn:aws:s3-outposts:us-east_1:123456789012:outpost/op-01234567890123456/not-accesspoint/reports" + } + }, + { + "documentation": "invalid outpost type", + "expect": { + "error": "Invalid ARN: The account id may only contain a-z, A-Z, 0-9 and `-`. Found: `12345_789012`" + }, + "params": { + "Region": "us-east-2", + "Bucket": "arn:aws:s3-outposts:us-east-1:12345_789012:outpost/op-01234567890123456/not-accesspoint/reports" + } + }, + { + "documentation": "invalid outpost type", + "expect": { + "error": "Invalid ARN: The Outpost Id was not set" + }, + "params": { + "Region": "us-east-2", + "Bucket": "arn:aws:s3-outposts:us-east-1:12345789012:outpost" + } + }, + { + "documentation": "use global endpoint virtual addressing", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "signingRegion": "us-east-2", + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true + } + ] + }, + "url": "http://bucket.example.com" + } + }, + "params": { + "Region": "us-east-2", + "Bucket": "bucket", + "Endpoint": "http://example.com", + "UseGlobalEndpoint": true + } + }, + { + "documentation": "global endpoint + ip address", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "signingRegion": "us-east-2", + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true + } + ] + }, + "url": "http://192.168.0.1/bucket" + } + }, + "params": { + "Region": "us-east-2", + "Bucket": "bucket", + "Endpoint": "http://192.168.0.1", + "UseGlobalEndpoint": true + } + }, + { + "documentation": "invalid outpost type", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "signingRegion": "us-east-2", + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3.us-east-2.amazonaws.com/bucket%21" + } + }, + "params": { + "Region": "us-east-2", + "Bucket": "bucket!", + "UseGlobalEndpoint": true + } + }, + { + "documentation": "invalid outpost type", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "signingRegion": "us-east-2", + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://bucket.s3-accelerate.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "Bucket": "bucket", + "Accelerate": true, + "UseGlobalEndpoint": true + } + }, + { + "documentation": "use global endpoint + custom endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "signingRegion": "us-east-2", + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true + } + ] + }, + "url": "http://foo.com/bucket%21" + } + }, + "params": { + "Region": "us-east-2", + "Bucket": "bucket!", + "UseGlobalEndpoint": true, + "Endpoint": "http://foo.com" + } + }, + { + "documentation": "use global endpoint, not us-east-1, force path style", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "signingRegion": "us-east-2", + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true + } + ] + }, + "url": "http://foo.com/bucket%21" + } + }, + "params": { + "Region": "us-east-2", + "Bucket": "bucket!", + "UseGlobalEndpoint": true, + "ForcePathStyle": true, + "Endpoint": "http://foo.com" + } + }, + { + "documentation": "vanilla virtual addressing@us-west-2", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://bucket-name.s3.us-west-2.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Region": "us-west-2", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "virtual addressing + dualstack@us-west-2", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://bucket-name.s3.dualstack.us-west-2.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::UseDualStack": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Region": "us-west-2", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "accelerate + dualstack@us-west-2", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://bucket-name.s3-accelerate.dualstack.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::UseDualStack": true, + "AWS::S3::Accelerate": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Accelerate": true, + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Region": "us-west-2", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "accelerate (dualstack=false)@us-west-2", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://bucket-name.s3-accelerate.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::S3::Accelerate": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Accelerate": true, + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Region": "us-west-2", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "virtual addressing + fips@us-west-2", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://bucket-name.s3-fips.us-west-2.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::UseFIPS": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Region": "us-west-2", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "virtual addressing + dualstack + fips@us-west-2", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://bucket-name.s3-fips.dualstack.us-west-2.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::UseFIPS": true, + "AWS::UseDualStack": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Region": "us-west-2", + "UseDualStack": true, + "UseFIPS": true + } + }, + { + "documentation": "accelerate + fips = error@us-west-2", + "expect": { + "error": "Accelerate cannot be used with FIPS" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::UseFIPS": true, + "AWS::S3::Accelerate": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Accelerate": true, + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Region": "us-west-2", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "vanilla virtual addressing@cn-north-1", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "cn-north-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://bucket-name.s3.cn-north-1.amazonaws.com.cn" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Region": "cn-north-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "virtual addressing + dualstack@cn-north-1", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "cn-north-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://bucket-name.s3.dualstack.cn-north-1.amazonaws.com.cn" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::UseDualStack": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Region": "cn-north-1", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "accelerate (dualstack=false)@cn-north-1", + "expect": { + "error": "S3 Accelerate cannot be used in this region" + }, + "params": { + "Accelerate": true, + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Region": "cn-north-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "virtual addressing + fips@cn-north-1", + "expect": { + "error": "Partition does not support FIPS" + }, + "params": { + "Accelerate": false, + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Region": "cn-north-1", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "vanilla virtual addressing@af-south-1", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "af-south-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://bucket-name.s3.af-south-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "af-south-1" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Region": "af-south-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "virtual addressing + dualstack@af-south-1", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "af-south-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://bucket-name.s3.dualstack.af-south-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "af-south-1", + "AWS::UseDualStack": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Region": "af-south-1", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "accelerate + dualstack@af-south-1", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "af-south-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://bucket-name.s3-accelerate.dualstack.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "af-south-1", + "AWS::UseDualStack": true, + "AWS::S3::Accelerate": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Accelerate": true, + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Region": "af-south-1", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "accelerate (dualstack=false)@af-south-1", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "af-south-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://bucket-name.s3-accelerate.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "af-south-1", + "AWS::S3::Accelerate": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Accelerate": true, + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Region": "af-south-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "virtual addressing + fips@af-south-1", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "af-south-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://bucket-name.s3-fips.af-south-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "af-south-1", + "AWS::UseFIPS": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Region": "af-south-1", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "virtual addressing + dualstack + fips@af-south-1", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "af-south-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://bucket-name.s3-fips.dualstack.af-south-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "af-south-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Region": "af-south-1", + "UseDualStack": true, + "UseFIPS": true + } + }, + { + "documentation": "accelerate + fips = error@af-south-1", + "expect": { + "error": "Accelerate cannot be used with FIPS" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "af-south-1", + "AWS::UseFIPS": true, + "AWS::S3::Accelerate": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Accelerate": true, + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Region": "af-south-1", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "vanilla path style@us-west-2", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3.us-west-2.amazonaws.com/bucket-name" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::S3::ForcePathStyle": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "bucket-name", + "ForcePathStyle": true, + "Region": "us-west-2", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "fips@us-gov-west-2, bucket is not S3-dns-compatible (subdomains)", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "signingName": "s3", + "signingRegion": "us-gov-west-1", + "disableDoubleEncoding": true, + "name": "sigv4" + } + ] + }, + "url": "https://s3-fips.us-gov-west-1.amazonaws.com/bucket.with.dots" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-gov-west-1", + "AWS::UseFIPS": true, + "AWS::S3::ForcePathStyle": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket.with.dots", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "bucket.with.dots", + "Region": "us-gov-west-1", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "path style + accelerate = error@us-west-2", + "expect": { + "error": "Path-style addressing cannot be used with S3 Accelerate" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::S3::ForcePathStyle": true, + "AWS::S3::Accelerate": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Accelerate": true, + "Bucket": "bucket-name", + "ForcePathStyle": true, + "Region": "us-west-2", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "path style + dualstack@us-west-2", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3.dualstack.us-west-2.amazonaws.com/bucket-name" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::UseDualStack": true, + "AWS::S3::ForcePathStyle": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "bucket-name", + "ForcePathStyle": true, + "Region": "us-west-2", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "path style + arn is error@us-west-2", + "expect": { + "error": "Path-style addressing cannot be used with ARN buckets" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::S3::ForcePathStyle": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:PARTITION:s3-outposts:REGION:123456789012:outpost:op-01234567890123456:bucket:mybucket", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "arn:PARTITION:s3-outposts:REGION:123456789012:outpost:op-01234567890123456:bucket:mybucket", + "ForcePathStyle": true, + "Region": "us-west-2", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "path style + invalid DNS name@us-west-2", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3.us-west-2.amazonaws.com/99a_b" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::S3::ForcePathStyle": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "99a_b", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "99a_b", + "ForcePathStyle": true, + "Region": "us-west-2", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "no path style + invalid DNS name@us-west-2", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3.us-west-2.amazonaws.com/99a_b" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "99a_b", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "99a_b", + "Region": "us-west-2", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "vanilla path style@cn-north-1", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "cn-north-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3.cn-north-1.amazonaws.com.cn/bucket-name" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::S3::ForcePathStyle": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "bucket-name", + "ForcePathStyle": true, + "Region": "cn-north-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "path style + fips@cn-north-1", + "expect": { + "error": "Partition does not support FIPS" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::UseFIPS": true, + "AWS::S3::ForcePathStyle": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "bucket-name", + "ForcePathStyle": true, + "Region": "cn-north-1", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "path style + accelerate = error@cn-north-1", + "expect": { + "error": "Path-style addressing cannot be used with S3 Accelerate" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::S3::ForcePathStyle": true, + "AWS::S3::Accelerate": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Accelerate": true, + "Bucket": "bucket-name", + "ForcePathStyle": true, + "Region": "cn-north-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "path style + dualstack@cn-north-1", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "cn-north-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3.dualstack.cn-north-1.amazonaws.com.cn/bucket-name" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::UseDualStack": true, + "AWS::S3::ForcePathStyle": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "bucket-name", + "ForcePathStyle": true, + "Region": "cn-north-1", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "path style + arn is error@cn-north-1", + "expect": { + "error": "Path-style addressing cannot be used with ARN buckets" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::S3::ForcePathStyle": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:PARTITION:s3-outposts:REGION:123456789012:outpost:op-01234567890123456:bucket:mybucket", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "arn:PARTITION:s3-outposts:REGION:123456789012:outpost:op-01234567890123456:bucket:mybucket", + "ForcePathStyle": true, + "Region": "cn-north-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "path style + invalid DNS name@cn-north-1", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "cn-north-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3.cn-north-1.amazonaws.com.cn/99a_b" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::S3::ForcePathStyle": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "99a_b", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "99a_b", + "ForcePathStyle": true, + "Region": "cn-north-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "no path style + invalid DNS name@cn-north-1", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "cn-north-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3.cn-north-1.amazonaws.com.cn/99a_b" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "99a_b", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "99a_b", + "Region": "cn-north-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "vanilla path style@af-south-1", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "af-south-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3.af-south-1.amazonaws.com/bucket-name" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "af-south-1", + "AWS::S3::ForcePathStyle": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "bucket-name", + "ForcePathStyle": true, + "Region": "af-south-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "path style + fips@af-south-1", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "signingName": "s3", + "signingRegion": "af-south-1", + "disableDoubleEncoding": true, + "name": "sigv4" + } + ] + }, + "url": "https://s3-fips.af-south-1.amazonaws.com/bucket-name" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "af-south-1", + "AWS::UseFIPS": true, + "AWS::S3::ForcePathStyle": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "bucket-name", + "ForcePathStyle": true, + "Region": "af-south-1", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "path style + accelerate = error@af-south-1", + "expect": { + "error": "Path-style addressing cannot be used with S3 Accelerate" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "af-south-1", + "AWS::S3::ForcePathStyle": true, + "AWS::S3::Accelerate": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Accelerate": true, + "Bucket": "bucket-name", + "ForcePathStyle": true, + "Region": "af-south-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "path style + dualstack@af-south-1", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "af-south-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3.dualstack.af-south-1.amazonaws.com/bucket-name" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "af-south-1", + "AWS::UseDualStack": true, + "AWS::S3::ForcePathStyle": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "bucket-name", + "ForcePathStyle": true, + "Region": "af-south-1", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "path style + arn is error@af-south-1", + "expect": { + "error": "Path-style addressing cannot be used with ARN buckets" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "af-south-1", + "AWS::S3::ForcePathStyle": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:PARTITION:s3-outposts:REGION:123456789012:outpost:op-01234567890123456:bucket:mybucket", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "arn:PARTITION:s3-outposts:REGION:123456789012:outpost:op-01234567890123456:bucket:mybucket", + "ForcePathStyle": true, + "Region": "af-south-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "path style + invalid DNS name@af-south-1", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "af-south-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3.af-south-1.amazonaws.com/99a_b" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "af-south-1", + "AWS::S3::ForcePathStyle": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "99a_b", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "99a_b", + "ForcePathStyle": true, + "Region": "af-south-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "no path style + invalid DNS name@af-south-1", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "af-south-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3.af-south-1.amazonaws.com/99a_b" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "af-south-1" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "99a_b", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "99a_b", + "Region": "af-south-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "virtual addressing + private link@us-west-2", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "http://bucket-name.control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "SDK::Endpoint": "http://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Endpoint": "http://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", + "Region": "us-west-2", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "path style + private link@us-west-2", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com/bucket-name" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "SDK::Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", + "AWS::S3::ForcePathStyle": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "bucket-name", + "ForcePathStyle": true, + "Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", + "Region": "us-west-2", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "SDK::Host + FIPS@us-west-2", + "expect": { + "error": "A custom endpoint cannot be combined with FIPS" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::UseFIPS": true, + "SDK::Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", + "Region": "us-west-2", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "SDK::Host + DualStack@us-west-2", + "expect": { + "error": "Cannot set dual-stack in combination with a custom endpoint." + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::UseDualStack": true, + "SDK::Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", + "Region": "us-west-2", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "SDK::HOST + accelerate@us-west-2", + "expect": { + "error": "A custom endpoint cannot be combined with S3 Accelerate" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "SDK::Endpoint": "http://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", + "AWS::S3::Accelerate": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Accelerate": true, + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Endpoint": "http://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", + "Region": "us-west-2", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "SDK::Host + access point ARN@us-west-2", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://myendpoint-123456789012.beta.example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "SDK::Endpoint": "https://beta.example.com" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:myendpoint", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:myendpoint", + "ForcePathStyle": false, + "Endpoint": "https://beta.example.com", + "Region": "us-west-2", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "virtual addressing + private link@cn-north-1", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "cn-north-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://bucket-name.control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "SDK::Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", + "Region": "cn-north-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "path style + private link@cn-north-1", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "cn-north-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com/bucket-name" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "SDK::Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", + "AWS::S3::ForcePathStyle": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "bucket-name", + "ForcePathStyle": true, + "Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", + "Region": "cn-north-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "FIPS@cn-north-1", + "expect": { + "error": "Partition does not support FIPS" + }, + "params": { + "Accelerate": false, + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Region": "cn-north-1", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "SDK::Host + DualStack@cn-north-1", + "expect": { + "error": "Cannot set dual-stack in combination with a custom endpoint." + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::UseDualStack": true, + "SDK::Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", + "Region": "cn-north-1", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "SDK::HOST + accelerate@cn-north-1", + "expect": { + "error": "A custom endpoint cannot be combined with S3 Accelerate" + }, + "params": { + "Accelerate": true, + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", + "Region": "cn-north-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "SDK::Host + access point ARN@cn-north-1", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "cn-north-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://myendpoint-123456789012.beta.example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "SDK::Endpoint": "https://beta.example.com" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws-cn:s3:cn-north-1:123456789012:accesspoint:myendpoint", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "arn:aws-cn:s3:cn-north-1:123456789012:accesspoint:myendpoint", + "ForcePathStyle": false, + "Endpoint": "https://beta.example.com", + "Region": "cn-north-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "virtual addressing + private link@af-south-1", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "af-south-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://bucket-name.control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "af-south-1", + "SDK::Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", + "Region": "af-south-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "path style + private link@af-south-1", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "af-south-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com/bucket-name" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "af-south-1", + "SDK::Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", + "AWS::S3::ForcePathStyle": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "bucket-name", + "ForcePathStyle": true, + "Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", + "Region": "af-south-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "SDK::Host + FIPS@af-south-1", + "expect": { + "error": "A custom endpoint cannot be combined with FIPS" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "af-south-1", + "AWS::UseFIPS": true, + "SDK::Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", + "Region": "af-south-1", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "SDK::Host + DualStack@af-south-1", + "expect": { + "error": "Cannot set dual-stack in combination with a custom endpoint." + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "af-south-1", + "AWS::UseDualStack": true, + "SDK::Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", + "Region": "af-south-1", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "SDK::HOST + accelerate@af-south-1", + "expect": { + "error": "A custom endpoint cannot be combined with S3 Accelerate" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "af-south-1", + "SDK::Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", + "AWS::S3::Accelerate": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Accelerate": true, + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", + "Region": "af-south-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "SDK::Host + access point ARN@af-south-1", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "af-south-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://myendpoint-123456789012.beta.example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "af-south-1", + "SDK::Endpoint": "https://beta.example.com" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3:af-south-1:123456789012:accesspoint:myendpoint", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "arn:aws:s3:af-south-1:123456789012:accesspoint:myendpoint", + "ForcePathStyle": false, + "Endpoint": "https://beta.example.com", + "Region": "af-south-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "vanilla access point arn@us-west-2", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://myendpoint-123456789012.s3-accesspoint.us-west-2.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:myendpoint", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:myendpoint", + "ForcePathStyle": false, + "Region": "us-west-2", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "access point arn + FIPS@us-west-2", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://myendpoint-123456789012.s3-accesspoint-fips.us-west-2.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::UseFIPS": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:myendpoint", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:myendpoint", + "ForcePathStyle": false, + "Region": "us-west-2", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "access point arn + accelerate = error@us-west-2", + "expect": { + "error": "Access Points do not support S3 Accelerate" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::S3::Accelerate": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:myendpoint", + "Key": "key" + } + } + ], + "params": { + "Accelerate": true, + "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:myendpoint", + "ForcePathStyle": false, + "Region": "us-west-2", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "access point arn + FIPS + DualStack@us-west-2", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://myendpoint-123456789012.s3-accesspoint-fips.dualstack.us-west-2.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::UseFIPS": true, + "AWS::UseDualStack": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:myendpoint", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:myendpoint", + "ForcePathStyle": false, + "Region": "us-west-2", + "UseDualStack": true, + "UseFIPS": true + } + }, + { + "documentation": "vanilla access point arn@cn-north-1", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "cn-north-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://myendpoint-123456789012.s3-accesspoint.cn-north-1.amazonaws.com.cn" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws-cn:s3:cn-north-1:123456789012:accesspoint:myendpoint", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "arn:aws-cn:s3:cn-north-1:123456789012:accesspoint:myendpoint", + "ForcePathStyle": false, + "Region": "cn-north-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "access point arn + FIPS@cn-north-1", + "expect": { + "error": "Partition does not support FIPS" + }, + "params": { + "Accelerate": false, + "Bucket": "arn:aws-cn:s3:cn-north-1:123456789012:accesspoint:myendpoint", + "ForcePathStyle": false, + "Region": "cn-north-1", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "access point arn + accelerate = error@cn-north-1", + "expect": { + "error": "Access Points do not support S3 Accelerate" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::S3::Accelerate": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws-cn:s3:cn-north-1:123456789012:accesspoint:myendpoint", + "Key": "key" + } + } + ], + "params": { + "Accelerate": true, + "Bucket": "arn:aws-cn:s3:cn-north-1:123456789012:accesspoint:myendpoint", + "ForcePathStyle": false, + "Region": "cn-north-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "access point arn + FIPS + DualStack@cn-north-1", + "expect": { + "error": "Partition does not support FIPS" + }, + "params": { + "Accelerate": false, + "Bucket": "arn:aws-cn:s3:cn-north-1:123456789012:accesspoint:myendpoint", + "ForcePathStyle": false, + "Region": "cn-north-1", + "UseDualStack": true, + "UseFIPS": true + } + }, + { + "documentation": "vanilla access point arn@af-south-1", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "af-south-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://myendpoint-123456789012.s3-accesspoint.af-south-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "af-south-1" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3:af-south-1:123456789012:accesspoint:myendpoint", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "arn:aws:s3:af-south-1:123456789012:accesspoint:myendpoint", + "ForcePathStyle": false, + "Region": "af-south-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "access point arn + FIPS@af-south-1", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "af-south-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://myendpoint-123456789012.s3-accesspoint-fips.af-south-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "af-south-1", + "AWS::UseFIPS": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3:af-south-1:123456789012:accesspoint:myendpoint", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "arn:aws:s3:af-south-1:123456789012:accesspoint:myendpoint", + "ForcePathStyle": false, + "Region": "af-south-1", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "access point arn + accelerate = error@af-south-1", + "expect": { + "error": "Access Points do not support S3 Accelerate" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "af-south-1", + "AWS::S3::Accelerate": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3:af-south-1:123456789012:accesspoint:myendpoint", + "Key": "key" + } + } + ], + "params": { + "Accelerate": true, + "Bucket": "arn:aws:s3:af-south-1:123456789012:accesspoint:myendpoint", + "ForcePathStyle": false, + "Region": "af-south-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "access point arn + FIPS + DualStack@af-south-1", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "af-south-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://myendpoint-123456789012.s3-accesspoint-fips.dualstack.af-south-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "af-south-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3:af-south-1:123456789012:accesspoint:myendpoint", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "arn:aws:s3:af-south-1:123456789012:accesspoint:myendpoint", + "ForcePathStyle": false, + "Region": "af-south-1", + "UseDualStack": true, + "UseFIPS": true + } + }, + { + "documentation": "S3 outposts vanilla test", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4a", + "signingName": "s3-outposts", + "signingRegionSet": [ + "*" + ], + "disableDoubleEncoding": true + }, + { + "name": "sigv4", + "signingName": "s3-outposts", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://reports-123456789012.op-01234567890123456.s3-outposts.us-west-2.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost/op-01234567890123456/accesspoint/reports", + "Key": "key" + } + } + ], + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost/op-01234567890123456/accesspoint/reports" + } + }, + { + "documentation": "S3 outposts custom endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4a", + "signingName": "s3-outposts", + "signingRegionSet": [ + "*" + ], + "disableDoubleEncoding": true + }, + { + "name": "sigv4", + "signingName": "s3-outposts", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://reports-123456789012.op-01234567890123456.example.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "SDK::Endpoint": "https://example.amazonaws.com" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost/op-01234567890123456/accesspoint/reports", + "Key": "key" + } + } + ], + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost/op-01234567890123456/accesspoint/reports", + "Endpoint": "https://example.amazonaws.com" + } + }, + { + "documentation": "outposts arn with region mismatch and UseArnRegion=false", + "expect": { + "error": "Invalid configuration: region from ARN `us-east-1` does not match client region `us-west-2` and UseArnRegion is `false`" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::S3::UseArnRegion": false + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "ForcePathStyle": false, + "UseArnRegion": false, + "Region": "us-west-2", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "outposts arn with region mismatch, custom region and UseArnRegion=false", + "expect": { + "error": "Invalid configuration: region from ARN `us-east-1` does not match client region `us-west-2` and UseArnRegion is `false`" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "SDK::Endpoint": "https://example.com", + "AWS::S3::UseArnRegion": false + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "Endpoint": "https://example.com", + "ForcePathStyle": false, + "UseArnRegion": false, + "Region": "us-west-2", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "outposts arn with region mismatch and UseArnRegion=true", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4a", + "signingName": "s3-outposts", + "signingRegionSet": [ + "*" + ], + "disableDoubleEncoding": true + }, + { + "name": "sigv4", + "signingName": "s3-outposts", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://myaccesspoint-123456789012.op-01234567890123456.s3-outposts.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::S3::UseArnRegion": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "ForcePathStyle": false, + "UseArnRegion": true, + "Region": "us-west-2", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "outposts arn with region mismatch and UseArnRegion unset", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4a", + "signingName": "s3-outposts", + "signingRegionSet": [ + "*" + ], + "disableDoubleEncoding": true + }, + { + "name": "sigv4", + "signingName": "s3-outposts", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://myaccesspoint-123456789012.op-01234567890123456.s3-outposts.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "ForcePathStyle": false, + "Region": "us-west-2", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "outposts arn with partition mismatch and UseArnRegion=true", + "expect": { + "error": "Client was configured for partition `aws` but ARN (`arn:aws:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint`) has `aws-cn`" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::S3::UseArnRegion": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "arn:aws:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "ForcePathStyle": false, + "UseArnRegion": true, + "Region": "us-west-2", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "ARN with UseGlobalEndpoint and use-east-1 region uses the regional endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4a", + "signingName": "s3-outposts", + "signingRegionSet": [ + "*" + ], + "disableDoubleEncoding": true + }, + { + "name": "sigv4", + "signingName": "s3-outposts", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://reports-123456789012.op-01234567890123456.s3-outposts.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::S3::UseGlobalEndpoint": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost/op-01234567890123456/accesspoint/reports", + "Key": "key" + } + } + ], + "params": { + "Region": "us-east-1", + "UseGlobalEndpoint": true, + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost/op-01234567890123456/accesspoint/reports" + } + }, + { + "documentation": "S3 outposts does not support dualstack", + "expect": { + "error": "S3 Outposts does not support Dual-stack" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Accelerate": false, + "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost/op-01234567890123456/accesspoint/reports" + } + }, + { + "documentation": "S3 outposts does not support fips", + "expect": { + "error": "S3 Outposts does not support FIPS" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Accelerate": false, + "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost/op-01234567890123456/accesspoint/reports" + } + }, + { + "documentation": "S3 outposts does not support accelerate", + "expect": { + "error": "S3 Outposts does not support S3 Accelerate" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": true, + "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost/op-01234567890123456/accesspoint/reports" + } + }, + { + "documentation": "validates against subresource", + "expect": { + "error": "Invalid Arn: Outpost Access Point ARN contains sub resources" + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:mybucket:object:foo" + } + }, + { + "documentation": "object lambda @us-east-1", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3-object-lambda", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://mybanner-123456789012.s3-object-lambda.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::S3::UseArnRegion": false + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3-object-lambda:us-east-1:123456789012:accesspoint/mybanner", + "Key": "key" + } + } + ], + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseArnRegion": false, + "Bucket": "arn:aws:s3-object-lambda:us-east-1:123456789012:accesspoint/mybanner" + } + }, + { + "documentation": "object lambda @us-west-2", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3-object-lambda", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://mybanner-123456789012.s3-object-lambda.us-west-2.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::S3::UseArnRegion": false + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint/mybanner", + "Key": "key" + } + } + ], + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseArnRegion": false, + "Bucket": "arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint/mybanner" + } + }, + { + "documentation": "object lambda, colon resource deliminator @us-west-2", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3-object-lambda", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://mybanner-123456789012.s3-object-lambda.us-west-2.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::S3::UseArnRegion": false + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint:mybanner", + "Key": "key" + } + } + ], + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseArnRegion": false, + "Bucket": "arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint:mybanner" + } + }, + { + "documentation": "object lambda @us-east-1, client region us-west-2, useArnRegion=true", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3-object-lambda", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://mybanner-123456789012.s3-object-lambda.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::S3::UseArnRegion": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3-object-lambda:us-east-1:123456789012:accesspoint/mybanner", + "Key": "key" + } + } + ], + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseArnRegion": true, + "Bucket": "arn:aws:s3-object-lambda:us-east-1:123456789012:accesspoint/mybanner" + } + }, + { + "documentation": "object lambda @us-east-1, client region s3-external-1, useArnRegion=true", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3-object-lambda", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://mybanner-123456789012.s3-object-lambda.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "s3-external-1", + "AWS::S3::UseArnRegion": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3-object-lambda:us-east-1:123456789012:accesspoint/mybanner", + "Key": "key" + } + } + ], + "params": { + "Region": "s3-external-1", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseArnRegion": true, + "Bucket": "arn:aws:s3-object-lambda:us-east-1:123456789012:accesspoint/mybanner" + } + }, + { + "documentation": "object lambda @us-east-1, client region s3-external-1, useArnRegion=false", + "expect": { + "error": "Invalid configuration: region from ARN `us-east-1` does not match client region `s3-external-1` and UseArnRegion is `false`" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "s3-external-1", + "AWS::S3::UseArnRegion": false + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3-object-lambda:us-east-1:123456789012:accesspoint/mybanner", + "Key": "key" + } + } + ], + "params": { + "Region": "s3-external-1", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseArnRegion": false, + "Bucket": "arn:aws:s3-object-lambda:us-east-1:123456789012:accesspoint/mybanner" + } + }, + { + "documentation": "object lambda @us-east-1, client region aws-global, useArnRegion=true", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3-object-lambda", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://mybanner-123456789012.s3-object-lambda.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "aws-global", + "AWS::S3::UseArnRegion": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3-object-lambda:us-east-1:123456789012:accesspoint/mybanner", + "Key": "key" + } + } + ], + "params": { + "Region": "aws-global", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseArnRegion": true, + "Bucket": "arn:aws:s3-object-lambda:us-east-1:123456789012:accesspoint/mybanner" + } + }, + { + "documentation": "object lambda @us-east-1, client region aws-global, useArnRegion=false", + "expect": { + "error": "Invalid configuration: region from ARN `us-east-1` does not match client region `aws-global` and UseArnRegion is `false`" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "aws-global", + "AWS::S3::UseArnRegion": false + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3-object-lambda:us-east-1:123456789012:accesspoint/mybanner", + "Key": "key" + } + } + ], + "params": { + "Region": "aws-global", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseArnRegion": false, + "Bucket": "arn:aws:s3-object-lambda:us-east-1:123456789012:accesspoint/mybanner" + } + }, + { + "documentation": "object lambda @cn-north-1, client region us-west-2 (cross partition), useArnRegion=true", + "expect": { + "error": "Client was configured for partition `aws` but ARN (`arn:aws-cn:s3-object-lambda:cn-north-1:123456789012:accesspoint/mybanner`) has `aws-cn`" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "aws-global", + "AWS::S3::UseArnRegion": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws-cn:s3-object-lambda:cn-north-1:123456789012:accesspoint/mybanner", + "Key": "key" + } + } + ], + "params": { + "Region": "aws-global", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseArnRegion": true, + "Bucket": "arn:aws-cn:s3-object-lambda:cn-north-1:123456789012:accesspoint/mybanner" + } + }, + { + "documentation": "object lambda with dualstack", + "expect": { + "error": "S3 Object Lambda does not support Dual-stack" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::UseDualStack": true, + "AWS::S3::UseArnRegion": false + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint/mybanner", + "Key": "key" + } + } + ], + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": true, + "Accelerate": false, + "UseArnRegion": false, + "Bucket": "arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint/mybanner" + } + }, + { + "documentation": "object lambda @us-gov-east-1", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3-object-lambda", + "signingRegion": "us-gov-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://mybanner-123456789012.s3-object-lambda.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseArnRegion": false, + "Bucket": "arn:aws-us-gov:s3-object-lambda:us-gov-east-1:123456789012:accesspoint/mybanner" + } + }, + { + "documentation": "object lambda @us-gov-east-1, with fips", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3-object-lambda", + "signingRegion": "us-gov-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://mybanner-123456789012.s3-object-lambda-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Accelerate": false, + "UseArnRegion": false, + "Bucket": "arn:aws-us-gov:s3-object-lambda:us-gov-east-1:123456789012:accesspoint/mybanner" + } + }, + { + "documentation": "object lambda @cn-north-1, with fips", + "expect": { + "error": "Partition does not support FIPS" + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false, + "Accelerate": false, + "UseArnRegion": false, + "Bucket": "arn:aws-cn:s3-object-lambda:cn-north-1:123456789012:accesspoint/mybanner" + } + }, + { + "documentation": "object lambda with accelerate", + "expect": { + "error": "S3 Object Lambda does not support S3 Accelerate" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::S3::Accelerate": true, + "AWS::S3::UseArnRegion": false + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint/mybanner", + "Key": "key" + } + } + ], + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": true, + "UseArnRegion": false, + "Bucket": "arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint/mybanner" + } + }, + { + "documentation": "object lambda with invalid arn - bad service and someresource", + "expect": { + "error": "Invalid ARN: Unrecognized format: arn:aws:sqs:us-west-2:123456789012:someresource (type: someresource)" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::S3::UseArnRegion": false + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:sqs:us-west-2:123456789012:someresource", + "Key": "key" + } + } + ], + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseArnRegion": false, + "Bucket": "arn:aws:sqs:us-west-2:123456789012:someresource" + } + }, + { + "documentation": "object lambda with invalid arn - invalid resource", + "expect": { + "error": "Invalid ARN: Object Lambda ARNs only support `accesspoint` arn types, but found: `bucket_name`" + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseArnRegion": false, + "Bucket": "arn:aws:s3-object-lambda:us-west-2:123456789012:bucket_name:mybucket" + } + }, + { + "documentation": "object lambda with invalid arn - missing region", + "expect": { + "error": "Invalid ARN: bucket ARN is missing a region" + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseArnRegion": false, + "Bucket": "arn:aws:s3-object-lambda::123456789012:accesspoint/mybanner" + } + }, + { + "documentation": "object lambda with invalid arn - missing account-id", + "expect": { + "error": "Invalid ARN: Missing account id" + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseArnRegion": true, + "Bucket": "arn:aws:s3-object-lambda:us-west-2::accesspoint/mybanner" + } + }, + { + "documentation": "object lambda with invalid arn - account id contains invalid characters", + "expect": { + "error": "Invalid ARN: The account id may only contain a-z, A-Z, 0-9 and `-`. Found: `123.45678.9012`" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::S3::UseArnRegion": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3-object-lambda:us-west-2:123.45678.9012:accesspoint:mybucket", + "Key": "key" + } + } + ], + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseArnRegion": true, + "Bucket": "arn:aws:s3-object-lambda:us-west-2:123.45678.9012:accesspoint:mybucket" + } + }, + { + "documentation": "object lambda with invalid arn - missing access point name", + "expect": { + "error": "Invalid ARN: Expected a resource of the format `accesspoint:` but no name was provided" + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseArnRegion": true, + "Bucket": "arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint" + } + }, + { + "documentation": "object lambda with invalid arn - access point name contains invalid character: *", + "expect": { + "error": "Invalid ARN: The access point name may only contain a-z, A-Z, 0-9 and `-`. Found: `*`" + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseArnRegion": true, + "Bucket": "arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint:*" + } + }, + { + "documentation": "object lambda with invalid arn - access point name contains invalid character: .", + "expect": { + "error": "Invalid ARN: The access point name may only contain a-z, A-Z, 0-9 and `-`. Found: `my.bucket`" + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseArnRegion": true, + "Bucket": "arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint:my.bucket" + } + }, + { + "documentation": "object lambda with invalid arn - access point name contains sub resources", + "expect": { + "error": "Invalid ARN: The ARN may only contain a single resource component after `accesspoint`." + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseArnRegion": true, + "Bucket": "arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint:mybucket:object:foo" + } + }, + { + "documentation": "object lambda with custom endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3-object-lambda", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://mybanner-123456789012.my-endpoint.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "SDK::Endpoint": "https://my-endpoint.com", + "AWS::S3::UseArnRegion": false + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint/mybanner", + "Key": "key" + } + } + ], + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseArnRegion": false, + "Bucket": "arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint/mybanner", + "Endpoint": "https://my-endpoint.com" + } + }, + { + "documentation": "object lambda arn with region mismatch and UseArnRegion=false", + "expect": { + "error": "Invalid configuration: region from ARN `us-east-1` does not match client region `us-west-2` and UseArnRegion is `false`" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::S3::UseArnRegion": false + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3-object-lambda:us-east-1:123456789012:accesspoint/mybanner", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "arn:aws:s3-object-lambda:us-east-1:123456789012:accesspoint/mybanner", + "ForcePathStyle": false, + "UseArnRegion": false, + "Region": "us-west-2", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "WriteGetObjectResponse @ us-west-2", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3-object-lambda", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3-object-lambda.us-west-2.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2" + }, + "operationName": "WriteGetObjectResponse", + "operationParams": { + "RequestRoute": "RequestRoute", + "RequestToken": "RequestToken" + } + } + ], + "params": { + "Accelerate": false, + "UseObjectLambdaEndpoint": true, + "Region": "us-west-2", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "WriteGetObjectResponse with custom endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3-object-lambda", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://my-endpoint.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "SDK::Endpoint": "https://my-endpoint.com" + }, + "operationName": "WriteGetObjectResponse", + "operationParams": { + "RequestRoute": "RequestRoute", + "RequestToken": "RequestToken" + } + } + ], + "params": { + "Accelerate": false, + "UseObjectLambdaEndpoint": true, + "Endpoint": "https://my-endpoint.com", + "Region": "us-west-2", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "WriteGetObjectResponse @ us-east-1", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3-object-lambda", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3-object-lambda.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1" + }, + "operationName": "WriteGetObjectResponse", + "operationParams": { + "RequestRoute": "RequestRoute", + "RequestToken": "RequestToken" + } + } + ], + "params": { + "Accelerate": false, + "UseObjectLambdaEndpoint": true, + "Region": "us-east-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "WriteGetObjectResponse with fips", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3-object-lambda", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3-object-lambda-fips.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true + }, + "operationName": "WriteGetObjectResponse", + "operationParams": { + "RequestRoute": "RequestRoute", + "RequestToken": "RequestToken" + } + } + ], + "params": { + "Accelerate": false, + "UseObjectLambdaEndpoint": true, + "Region": "us-east-1", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "WriteGetObjectResponse with dualstack", + "expect": { + "error": "S3 Object Lambda does not support Dual-stack" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseDualStack": true + }, + "operationName": "WriteGetObjectResponse", + "operationParams": { + "RequestRoute": "RequestRoute", + "RequestToken": "RequestToken" + } + } + ], + "params": { + "Accelerate": false, + "UseObjectLambdaEndpoint": true, + "Region": "us-east-1", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "WriteGetObjectResponse with accelerate", + "expect": { + "error": "S3 Object Lambda does not support S3 Accelerate" + }, + "params": { + "Accelerate": true, + "UseObjectLambdaEndpoint": true, + "Region": "us-east-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "WriteGetObjectResponse with fips in CN", + "expect": { + "error": "Partition does not support FIPS" + }, + "params": { + "Accelerate": false, + "Region": "cn-north-1", + "UseObjectLambdaEndpoint": true, + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "WriteGetObjectResponse with invalid partition", + "expect": { + "error": "Invalid region: region was not a valid DNS name." + }, + "params": { + "Accelerate": false, + "UseObjectLambdaEndpoint": true, + "Region": "not a valid DNS name", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "WriteGetObjectResponse with an unknown partition", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3-object-lambda", + "disableDoubleEncoding": true, + "signingRegion": "us-east.special" + } + ] + }, + "url": "https://s3-object-lambda.us-east.special.amazonaws.com" + } + }, + "params": { + "Accelerate": false, + "UseObjectLambdaEndpoint": true, + "Region": "us-east.special", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "S3 Outposts bucketAlias Real Outpost Prod us-west-1", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4a", + "signingName": "s3-outposts", + "signingRegionSet": [ + "*" + ], + "disableDoubleEncoding": true + }, + { + "name": "sigv4", + "signingName": "s3-outposts", + "signingRegion": "us-west-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://test-accessp-o0b1d075431d83bebde8xz5w8ijx1qzlbp3i3kuse10--op-s3.op-0b1d075431d83bebd.s3-outposts.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "Bucket": "test-accessp-o0b1d075431d83bebde8xz5w8ijx1qzlbp3i3kuse10--op-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false + } + }, + { + "documentation": "S3 Outposts bucketAlias Real Outpost Prod ap-east-1", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4a", + "signingName": "s3-outposts", + "signingRegionSet": [ + "*" + ], + "disableDoubleEncoding": true + }, + { + "name": "sigv4", + "signingName": "s3-outposts", + "signingRegion": "ap-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://test-accessp-o0b1d075431d83bebde8xz5w8ijx1qzlbp3i3kuse10--op-s3.op-0b1d075431d83bebd.s3-outposts.ap-east-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-east-1", + "Bucket": "test-accessp-o0b1d075431d83bebde8xz5w8ijx1qzlbp3i3kuse10--op-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false + } + }, + { + "documentation": "S3 Outposts bucketAlias Ec2 Outpost Prod us-east-1", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4a", + "signingName": "s3-outposts", + "signingRegionSet": [ + "*" + ], + "disableDoubleEncoding": true + }, + { + "name": "sigv4", + "signingName": "s3-outposts", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://test-accessp-e0000075431d83bebde8xz5w8ijx1qzlbp3i3kuse10--op-s3.ec2.s3-outposts.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "Bucket": "test-accessp-e0000075431d83bebde8xz5w8ijx1qzlbp3i3kuse10--op-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false + } + }, + { + "documentation": "S3 Outposts bucketAlias Ec2 Outpost Prod me-south-1", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4a", + "signingName": "s3-outposts", + "signingRegionSet": [ + "*" + ], + "disableDoubleEncoding": true + }, + { + "name": "sigv4", + "signingName": "s3-outposts", + "signingRegion": "me-south-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://test-accessp-e0000075431d83bebde8xz5w8ijx1qzlbp3i3kuse10--op-s3.ec2.s3-outposts.me-south-1.amazonaws.com" + } + }, + "params": { + "Region": "me-south-1", + "Bucket": "test-accessp-e0000075431d83bebde8xz5w8ijx1qzlbp3i3kuse10--op-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false + } + }, + { + "documentation": "S3 Outposts bucketAlias Real Outpost Beta", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4a", + "signingName": "s3-outposts", + "signingRegionSet": [ + "*" + ], + "disableDoubleEncoding": true + }, + { + "name": "sigv4", + "signingName": "s3-outposts", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://test-accessp-o0b1d075431d83bebde8xz5w8ijx1qzlbp3i3kbeta0--op-s3.op-0b1d075431d83bebd.example.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "Bucket": "test-accessp-o0b1d075431d83bebde8xz5w8ijx1qzlbp3i3kbeta0--op-s3", + "Endpoint": "https://example.amazonaws.com", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false + } + }, + { + "documentation": "S3 Outposts bucketAlias Ec2 Outpost Beta", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4a", + "signingName": "s3-outposts", + "signingRegionSet": [ + "*" + ], + "disableDoubleEncoding": true + }, + { + "name": "sigv4", + "signingName": "s3-outposts", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://161743052723-e00000136899934034jeahy1t8gpzpbwjj8kb7beta0--op-s3.ec2.example.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "Bucket": "161743052723-e00000136899934034jeahy1t8gpzpbwjj8kb7beta0--op-s3", + "Endpoint": "https://example.amazonaws.com", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false + } + }, + { + "documentation": "S3 Outposts bucketAlias - No endpoint set for beta", + "expect": { + "error": "Expected a endpoint to be specified but no endpoint was found" + }, + "params": { + "Region": "us-east-1", + "Bucket": "test-accessp-o0b1d075431d83bebde8xz5w8ijx1qzlbp3i3kbeta0--op-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false + } + }, + { + "documentation": "S3 Outposts bucketAlias Invalid hardware type", + "expect": { + "error": "Unrecognized hardware type: \"Expected hardware type o or e but got h\"" + }, + "params": { + "Region": "us-east-1", + "Bucket": "test-accessp-h0000075431d83bebde8xz5w8ijx1qzlbp3i3kuse10--op-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false + } + }, + { + "documentation": "S3 Outposts bucketAlias Special character in Outpost Arn", + "expect": { + "error": "Invalid ARN: The outpost Id must only contain a-z, A-Z, 0-9 and `-`." + }, + "params": { + "Region": "us-east-1", + "Bucket": "test-accessp-o00000754%1d83bebde8xz5w8ijx1qzlbp3i3kuse10--op-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false + } + }, + { + "documentation": "S3 Outposts bucketAlias - No endpoint set for beta", + "expect": { + "error": "Expected a endpoint to be specified but no endpoint was found" + }, + "params": { + "Region": "us-east-1", + "Bucket": "test-accessp-e0b1d075431d83bebde8xz5w8ijx1qzlbp3i3ebeta0--op-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false + } + }, + { + "documentation": "S3 Snow with bucket", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "snow", + "disableDoubleEncoding": true + } + ] + }, + "url": "http://10.0.1.12:433/bucketName" + } + }, + "params": { + "Region": "snow", + "Bucket": "bucketName", + "Endpoint": "http://10.0.1.12:433", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false + } + }, + { + "documentation": "S3 Snow without bucket", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "snow", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://10.0.1.12:433" + } + }, + "params": { + "Region": "snow", + "Endpoint": "https://10.0.1.12:433", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false + } + }, + { + "documentation": "S3 Snow no port", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "snow", + "disableDoubleEncoding": true + } + ] + }, + "url": "http://10.0.1.12/bucketName" + } + }, + "params": { + "Region": "snow", + "Bucket": "bucketName", + "Endpoint": "http://10.0.1.12", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false + } + }, + { + "documentation": "S3 Snow dns endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "snow", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://amazonaws.com/bucketName" + } + }, + "params": { + "Region": "snow", + "Bucket": "bucketName", + "Endpoint": "https://amazonaws.com", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false + } + }, + { + "documentation": "Data Plane with short zone name", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://mybucket--abcd-ab1--x-s3.s3express-abcd-ab1.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "mybucket--abcd-ab1--x-s3", + "Key": "key" + } + } + ], + "params": { + "Region": "us-east-1", + "Bucket": "mybucket--abcd-ab1--x-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseS3ExpressControlEndpoint": false + } + }, + { + "documentation": "Data Plane with short zone names (13 chars)", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://mybucket--test-zone-ab1--x-s3.s3express-test-zone-ab1.us-west-2.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "mybucket--test-zone-ab1--x-s3", + "Key": "key" + } + } + ], + "params": { + "Region": "us-west-2", + "Bucket": "mybucket--test-zone-ab1--x-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseS3ExpressControlEndpoint": false + } + }, + { + "documentation": "Data Plane with medium zone names (14 chars)", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://mybucket--test1-zone-ab1--x-s3.s3express-test1-zone-ab1.us-west-2.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "mybucket--test1-zone-ab1--x-s3", + "Key": "key" + } + } + ], + "params": { + "Region": "us-west-2", + "Bucket": "mybucket--test1-zone-ab1--x-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseS3ExpressControlEndpoint": false + } + }, + { + "documentation": "Data Plane with long zone names (20 chars)", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://mybucket--test1-long1-zone-ab1--x-s3.s3express-test1-long1-zone-ab1.us-west-2.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "mybucket--test1-long1-zone-ab1--x-s3", + "Key": "key" + } + } + ], + "params": { + "Region": "us-west-2", + "Bucket": "mybucket--test1-long1-zone-ab1--x-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseS3ExpressControlEndpoint": false + } + }, + { + "documentation": "Data Plane with short zone fips", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://mybucket--test-ab1--x-s3.s3express-fips-test-ab1.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "mybucket--test-ab1--x-s3", + "Key": "key" + } + } + ], + "params": { + "Region": "us-east-1", + "Bucket": "mybucket--test-ab1--x-s3", + "UseFIPS": true, + "UseDualStack": false, + "Accelerate": false, + "UseS3ExpressControlEndpoint": false + } + }, + { + "documentation": "Data Plane with short zone (13 chars) fips", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://mybucket--test-zone-ab1--x-s3.s3express-fips-test-zone-ab1.us-west-2.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::UseFIPS": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "mybucket--test-zone-ab1--x-s3", + "Key": "key" + } + } + ], + "params": { + "Region": "us-west-2", + "Bucket": "mybucket--test-zone-ab1--x-s3", + "UseFIPS": true, + "UseDualStack": false, + "Accelerate": false, + "UseS3ExpressControlEndpoint": false + } + }, + { + "documentation": "Data Plane with medium zone (14 chars) fips", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://mybucket--test1-zone-ab1--x-s3.s3express-fips-test1-zone-ab1.us-west-2.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::UseFIPS": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "mybucket--test1-zone-ab1--x-s3", + "Key": "key" + } + } + ], + "params": { + "Region": "us-west-2", + "Bucket": "mybucket--test1-zone-ab1--x-s3", + "UseFIPS": true, + "UseDualStack": false, + "Accelerate": false, + "UseS3ExpressControlEndpoint": false + } + }, + { + "documentation": "Data Plane with long zone (20 chars) fips", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://mybucket--test1-long1-zone-ab1--x-s3.s3express-fips-test1-long1-zone-ab1.us-west-2.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::UseFIPS": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "mybucket--test1-long1-zone-ab1--x-s3", + "Key": "key" + } + } + ], + "params": { + "Region": "us-west-2", + "Bucket": "mybucket--test1-long1-zone-ab1--x-s3", + "UseFIPS": true, + "UseDualStack": false, + "Accelerate": false, + "UseS3ExpressControlEndpoint": false + } + }, + { + "documentation": "Data Plane with long AZ", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://mybucket--test1-az1--x-s3.s3express-test1-az1.us-west-2.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "mybucket--test1-az1--x-s3", + "Key": "key" + } + } + ], + "params": { + "Region": "us-west-2", + "Bucket": "mybucket--test1-az1--x-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseS3ExpressControlEndpoint": false + } + }, + { + "documentation": "Data Plane with long AZ fips", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://mybucket--test1-az1--x-s3.s3express-fips-test1-az1.us-west-2.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::UseFIPS": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "mybucket--test1-az1--x-s3", + "Key": "key" + } + } + ], + "params": { + "Region": "us-west-2", + "Bucket": "mybucket--test1-az1--x-s3", + "UseFIPS": true, + "UseDualStack": false, + "Accelerate": false, + "UseS3ExpressControlEndpoint": false + } + }, + { + "documentation": "Control plane with short AZ bucket", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://s3express-control.us-east-1.amazonaws.com/mybucket--test-ab1--x-s3" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1" + }, + "operationName": "CreateBucket", + "operationParams": { + "Bucket": "mybucket--test-ab1--x-s3" + } + } + ], + "params": { + "Region": "us-east-1", + "Bucket": "mybucket--test-ab1--x-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseS3ExpressControlEndpoint": true, + "DisableS3ExpressSessionAuth": false + } + }, + { + "documentation": "Control plane with short AZ bucket and fips", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://s3express-control-fips.us-east-1.amazonaws.com/mybucket--test-ab1--x-s3" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true + }, + "operationName": "CreateBucket", + "operationParams": { + "Bucket": "mybucket--test-ab1--x-s3" + } + } + ], + "params": { + "Region": "us-east-1", + "Bucket": "mybucket--test-ab1--x-s3", + "UseFIPS": true, + "UseDualStack": false, + "Accelerate": false, + "UseS3ExpressControlEndpoint": true, + "DisableS3ExpressSessionAuth": false + } + }, + { + "documentation": "Control plane without bucket", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://s3express-control.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1" + }, + "operationName": "ListDirectoryBuckets" + } + ], + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseS3ExpressControlEndpoint": true, + "DisableS3ExpressSessionAuth": false + } + }, + { + "documentation": "Control plane without bucket and fips", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://s3express-control-fips.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true + }, + "operationName": "ListDirectoryBuckets" + } + ], + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Accelerate": false, + "UseS3ExpressControlEndpoint": true, + "DisableS3ExpressSessionAuth": false + } + }, + { + "documentation": "Data Plane sigv4 auth with short AZ", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://mybucket--usw2-az1--x-s3.s3express-usw2-az1.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "Bucket": "mybucket--usw2-az1--x-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "DisableS3ExpressSessionAuth": true + } + }, + { + "documentation": "Data Plane sigv4 auth with short zone (13 chars)", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://mybucket--test-zone-ab1--x-s3.s3express-test-zone-ab1.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "Bucket": "mybucket--test-zone-ab1--x-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "DisableS3ExpressSessionAuth": true + } + }, + { + "documentation": "Data Plane sigv4 auth with short AZ fips", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://mybucket--usw2-az1--x-s3.s3express-fips-usw2-az1.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "Bucket": "mybucket--usw2-az1--x-s3", + "UseFIPS": true, + "UseDualStack": false, + "Accelerate": false, + "DisableS3ExpressSessionAuth": true + } + }, + { + "documentation": "Data Plane sigv4 auth with short zone (13 chars) fips", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://mybucket--test-zone-ab1--x-s3.s3express-fips-test-zone-ab1.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "Bucket": "mybucket--test-zone-ab1--x-s3", + "UseFIPS": true, + "UseDualStack": false, + "Accelerate": false, + "DisableS3ExpressSessionAuth": true + } + }, + { + "documentation": "Data Plane sigv4 auth with long AZ", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://mybucket--test1-az1--x-s3.s3express-test1-az1.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "Bucket": "mybucket--test1-az1--x-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseS3ExpressControlEndpoint": false, + "DisableS3ExpressSessionAuth": true + } + }, + { + "documentation": "Data Plane sigv4 auth with medium zone(14 chars)", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://mybucket--test1-zone-ab1--x-s3.s3express-test1-zone-ab1.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "Bucket": "mybucket--test1-zone-ab1--x-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseS3ExpressControlEndpoint": false, + "DisableS3ExpressSessionAuth": true + } + }, + { + "documentation": "Data Plane sigv4 auth with long zone(20 chars)", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://mybucket--test1-long1-zone-ab1--x-s3.s3express-test1-long1-zone-ab1.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "Bucket": "mybucket--test1-long1-zone-ab1--x-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseS3ExpressControlEndpoint": false, + "DisableS3ExpressSessionAuth": true + } + }, + { + "documentation": "Data Plane sigv4 auth with long AZ fips", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://mybucket--test1-az1--x-s3.s3express-fips-test1-az1.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "Bucket": "mybucket--test1-az1--x-s3", + "UseFIPS": true, + "UseDualStack": false, + "Accelerate": false, + "UseS3ExpressControlEndpoint": false, + "DisableS3ExpressSessionAuth": true + } + }, + { + "documentation": "Data Plane sigv4 auth with medium zone (14 chars) fips", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://mybucket--test1-zone-ab1--x-s3.s3express-fips-test1-zone-ab1.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "Bucket": "mybucket--test1-zone-ab1--x-s3", + "UseFIPS": true, + "UseDualStack": false, + "Accelerate": false, + "UseS3ExpressControlEndpoint": false, + "DisableS3ExpressSessionAuth": true + } + }, + { + "documentation": "Data Plane sigv4 auth with long zone (20 chars) fips", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://mybucket--test1-long1-zone-ab1--x-s3.s3express-fips-test1-long1-zone-ab1.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "Bucket": "mybucket--test1-long1-zone-ab1--x-s3", + "UseFIPS": true, + "UseDualStack": false, + "Accelerate": false, + "UseS3ExpressControlEndpoint": false, + "DisableS3ExpressSessionAuth": true + } + }, + { + "documentation": "Control Plane host override", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://mybucket--usw2-az1--x-s3.custom.com" + } + }, + "params": { + "Region": "us-west-2", + "Bucket": "mybucket--usw2-az1--x-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseS3ExpressControlEndpoint": true, + "DisableS3ExpressSessionAuth": true, + "Endpoint": "https://custom.com" + } + }, + { + "documentation": "Control Plane host override no bucket", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://custom.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseS3ExpressControlEndpoint": true, + "DisableS3ExpressSessionAuth": true, + "Endpoint": "https://custom.com" + } + }, + { + "documentation": "Data plane host override non virtual session auth", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://10.0.0.1/mybucket--usw2-az1--x-s3" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "SDK::Endpoint": "https://10.0.0.1" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "mybucket--usw2-az1--x-s3", + "Key": "key" + } + } + ], + "params": { + "Region": "us-west-2", + "Bucket": "mybucket--usw2-az1--x-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "Endpoint": "https://10.0.0.1" + } + }, + { + "documentation": "Control Plane host override ip", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://10.0.0.1/mybucket--usw2-az1--x-s3" + } + }, + "params": { + "Region": "us-west-2", + "Bucket": "mybucket--usw2-az1--x-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseS3ExpressControlEndpoint": true, + "DisableS3ExpressSessionAuth": true, + "Endpoint": "https://10.0.0.1" + } + }, + { + "documentation": "Data plane host override", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://mybucket--usw2-az1--x-s3.custom.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "SDK::Endpoint": "https://custom.com" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "mybucket--usw2-az1--x-s3", + "Key": "key" + } + } + ], + "params": { + "Region": "us-west-2", + "Bucket": "mybucket--usw2-az1--x-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "Endpoint": "https://custom.com" + } + }, + { + "documentation": "bad format error", + "expect": { + "error": "Unrecognized S3Express bucket name format." + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "mybucket--usaz1--x-s3", + "Key": "key" + } + } + ], + "params": { + "Region": "us-east-1", + "Bucket": "mybucket--usaz1--x-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseS3ExpressControlEndpoint": false + } + }, + { + "documentation": "bad format error no session auth", + "expect": { + "error": "Unrecognized S3Express bucket name format." + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "mybucket--usaz1--x-s3", + "Key": "key" + } + } + ], + "params": { + "Region": "us-east-1", + "Bucket": "mybucket--usaz1--x-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseS3ExpressControlEndpoint": false, + "DisableS3ExpressSessionAuth": true + } + }, + { + "documentation": "dual-stack error", + "expect": { + "error": "S3Express does not support Dual-stack." + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseDualStack": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "mybucket--test-ab1--x-s3", + "Key": "key" + } + } + ], + "params": { + "Region": "us-east-1", + "Bucket": "mybucket--test-ab1--x-s3", + "UseFIPS": false, + "UseDualStack": true, + "Accelerate": false, + "UseS3ExpressControlEndpoint": false + } + }, + { + "documentation": "accelerate error", + "expect": { + "error": "S3Express does not support S3 Accelerate." + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::S3::Accelerate": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "mybucket--test-ab1--x-s3", + "Key": "key" + } + } + ], + "params": { + "Region": "us-east-1", + "Bucket": "mybucket--test-ab1--x-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": true, + "UseS3ExpressControlEndpoint": false + } + }, + { + "documentation": "Data plane bucket format error", + "expect": { + "error": "S3Express bucket name is not a valid virtual hostable name." + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "my.bucket--test-ab1--x-s3", + "Key": "key" + } + } + ], + "params": { + "Region": "us-east-1", + "Bucket": "my.bucket--test-ab1--x-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseS3ExpressControlEndpoint": false + } + }, + { + "documentation": "host override data plane bucket error session auth", + "expect": { + "error": "S3Express bucket name is not a valid virtual hostable name." + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "SDK::Endpoint": "https://custom.com" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "my.bucket--usw2-az1--x-s3", + "Key": "key" + } + } + ], + "params": { + "Region": "us-west-2", + "Bucket": "my.bucket--usw2-az1--x-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "Endpoint": "https://custom.com" + } + }, + { + "documentation": "host override data plane bucket error", + "expect": { + "error": "S3Express bucket name is not a valid virtual hostable name." + }, + "params": { + "Region": "us-west-2", + "Bucket": "my.bucket--usw2-az1--x-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "Endpoint": "https://custom.com", + "DisableS3ExpressSessionAuth": true + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.s3#AnalyticsAndOperator": { + "type": "structure", + "members": { + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "

The prefix to use when evaluating an AND predicate: The prefix that an object must have\n to be included in the metrics results.

" + } + }, + "Tags": { + "target": "com.amazonaws.s3#TagSet", + "traits": { + "smithy.api#documentation": "

The list of tags to use when evaluating an AND predicate.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Tag" + } + } + }, + "traits": { + "smithy.api#documentation": "

A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter.\n The operator must have at least two predicates in any combination, and an object must match\n all of the predicates for the filter to apply.

" + } + }, + "com.amazonaws.s3#AnalyticsConfiguration": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.s3#AnalyticsId", + "traits": { + "smithy.api#documentation": "

The ID that identifies the analytics configuration.

", + "smithy.api#required": {} + } + }, + "Filter": { + "target": "com.amazonaws.s3#AnalyticsFilter", + "traits": { + "smithy.api#documentation": "

The filter used to describe a set of objects for analyses. A filter must have exactly\n one prefix, one tag, or one conjunction (AnalyticsAndOperator). If no filter is provided,\n all objects will be considered in any analysis.

" + } + }, + "StorageClassAnalysis": { + "target": "com.amazonaws.s3#StorageClassAnalysis", + "traits": { + "smithy.api#documentation": "

Contains data related to access patterns to be collected and made available to analyze\n the tradeoffs between different storage classes.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the configuration and any analyses for the analytics filter of an Amazon S3\n bucket.

" + } + }, + "com.amazonaws.s3#AnalyticsConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#AnalyticsConfiguration" + } + }, + "com.amazonaws.s3#AnalyticsExportDestination": { + "type": "structure", + "members": { + "S3BucketDestination": { + "target": "com.amazonaws.s3#AnalyticsS3BucketDestination", + "traits": { + "smithy.api#documentation": "

A destination signifying output to an S3 bucket.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Where to publish the analytics results.

" + } + }, + "com.amazonaws.s3#AnalyticsFilter": { + "type": "union", + "members": { + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "

The prefix to use when evaluating an analytics filter.

" + } + }, + "Tag": { + "target": "com.amazonaws.s3#Tag", + "traits": { + "smithy.api#documentation": "

The tag to use when evaluating an analytics filter.

" + } + }, + "And": { + "target": "com.amazonaws.s3#AnalyticsAndOperator", + "traits": { + "smithy.api#documentation": "

A conjunction (logical AND) of predicates, which is used in evaluating an analytics\n filter. The operator must have at least two predicates.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The filter used to describe a set of objects for analyses. A filter must have exactly\n one prefix, one tag, or one conjunction (AnalyticsAndOperator). If no filter is provided,\n all objects will be considered in any analysis.

" + } + }, + "com.amazonaws.s3#AnalyticsId": { + "type": "string" + }, + "com.amazonaws.s3#AnalyticsS3BucketDestination": { + "type": "structure", + "members": { + "Format": { + "target": "com.amazonaws.s3#AnalyticsS3ExportFileFormat", + "traits": { + "smithy.api#documentation": "

Specifies the file format used when exporting data to Amazon S3.

", + "smithy.api#required": {} + } + }, + "BucketAccountId": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID that owns the destination S3 bucket. If no account ID is provided, the\n owner is not validated before exporting data.

\n \n

Although this value is optional, we strongly recommend that you set it to help\n prevent problems if the destination bucket ownership changes.

\n " + } + }, + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the bucket to which data is exported.

", + "smithy.api#required": {} + } + }, + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "

The prefix to use when exporting data. The prefix is prepended to all results.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about where to publish the analytics results.

" + } + }, + "com.amazonaws.s3#AnalyticsS3ExportFileFormat": { + "type": "enum", + "members": { + "CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CSV" + } + } + } + }, + "com.amazonaws.s3#ArchiveStatus": { + "type": "enum", + "members": { + "ARCHIVE_ACCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARCHIVE_ACCESS" + } + }, + "DEEP_ARCHIVE_ACCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEEP_ARCHIVE_ACCESS" + } + } + } + }, + "com.amazonaws.s3#Body": { + "type": "blob" + }, + "com.amazonaws.s3#Bucket": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket.

" + } + }, + "CreationDate": { + "target": "com.amazonaws.s3#CreationDate", + "traits": { + "smithy.api#documentation": "

Date the bucket was created. This date can change when making changes to your bucket,\n such as editing its bucket policy.

" + } + }, + "BucketRegion": { + "target": "com.amazonaws.s3#BucketRegion", + "traits": { + "smithy.api#documentation": "

\n BucketRegion indicates the Amazon Web Services region where the bucket is located. If the\n request contains at least one valid parameter, it is included in the response.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

In terms of implementation, a Bucket is a resource.

" + } + }, + "com.amazonaws.s3#BucketAccelerateStatus": { + "type": "enum", + "members": { + "Enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enabled" + } + }, + "Suspended": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Suspended" + } + } + } + }, + "com.amazonaws.s3#BucketAlreadyExists": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

The requested bucket name is not available. The bucket namespace is shared by all users\n of the system. Select a different name and try again.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.s3#BucketAlreadyOwnedByYou": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

The bucket you tried to create already exists, and you own it. Amazon S3 returns this error\n in all Amazon Web Services Regions except in the North Virginia Region. For legacy compatibility, if you\n re-create an existing bucket that you already own in the North Virginia Region, Amazon S3\n returns 200 OK and resets the bucket access control lists (ACLs).

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.s3#BucketCannedACL": { + "type": "enum", + "members": { + "private": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "private" + } + }, + "public_read": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "public-read" + } + }, + "public_read_write": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "public-read-write" + } + }, + "authenticated_read": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "authenticated-read" + } + } + } + }, + "com.amazonaws.s3#BucketInfo": { + "type": "structure", + "members": { + "DataRedundancy": { + "target": "com.amazonaws.s3#DataRedundancy", + "traits": { + "smithy.api#documentation": "

The number of Zone (Availability Zone or Local Zone) that's used for redundancy for the bucket.

" + } + }, + "Type": { + "target": "com.amazonaws.s3#BucketType", + "traits": { + "smithy.api#documentation": "

The type of bucket.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the information about the bucket that will be created. For more information\n about directory buckets, see Directory buckets in the Amazon S3 User Guide.

\n \n

This functionality is only supported by directory buckets.

\n " + } + }, + "com.amazonaws.s3#BucketKeyEnabled": { + "type": "boolean" + }, + "com.amazonaws.s3#BucketLifecycleConfiguration": { + "type": "structure", + "members": { + "Rules": { + "target": "com.amazonaws.s3#LifecycleRules", + "traits": { + "smithy.api#documentation": "

A lifecycle rule for individual objects in an Amazon S3 bucket.

", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Rule" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more\n information, see Object Lifecycle Management\n in the Amazon S3 User Guide.

" + } + }, + "com.amazonaws.s3#BucketLocationConstraint": { + "type": "enum", + "members": { + "af_south_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "af-south-1" + } + }, + "ap_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-east-1" + } + }, + "ap_northeast_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-northeast-1" + } + }, + "ap_northeast_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-northeast-2" + } + }, + "ap_northeast_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-northeast-3" + } + }, + "ap_south_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-south-1" + } + }, + "ap_south_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-south-2" + } + }, + "ap_southeast_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-1" + } + }, + "ap_southeast_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-2" + } + }, + "ap_southeast_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-3" + } + }, + "ca_central_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ca-central-1" + } + }, + "cn_north_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cn-north-1" + } + }, + "cn_northwest_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cn-northwest-1" + } + }, + "EU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EU" + } + }, + "eu_central_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-central-1" + } + }, + "eu_north_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-north-1" + } + }, + "eu_south_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-south-1" + } + }, + "eu_south_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-south-2" + } + }, + "eu_west_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-1" + } + }, + "eu_west_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-2" + } + }, + "eu_west_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-3" + } + }, + "me_south_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "me-south-1" + } + }, + "sa_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sa-east-1" + } + }, + "us_east_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-east-2" + } + }, + "us_gov_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-gov-east-1" + } + }, + "us_gov_west_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-gov-west-1" + } + }, + "us_west_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-west-1" + } + }, + "us_west_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-west-2" + } + } + } + }, + "com.amazonaws.s3#BucketLocationName": { + "type": "string" + }, + "com.amazonaws.s3#BucketLoggingStatus": { + "type": "structure", + "members": { + "LoggingEnabled": { + "target": "com.amazonaws.s3#LoggingEnabled" + } + }, + "traits": { + "smithy.api#documentation": "

Container for logging status information.

" + } + }, + "com.amazonaws.s3#BucketLogsPermission": { + "type": "enum", + "members": { + "FULL_CONTROL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FULL_CONTROL" + } + }, + "READ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READ" + } + }, + "WRITE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WRITE" + } + } + } + }, + "com.amazonaws.s3#BucketName": { + "type": "string" + }, + "com.amazonaws.s3#BucketRegion": { + "type": "string" + }, + "com.amazonaws.s3#BucketType": { + "type": "enum", + "members": { + "Directory": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Directory" + } + } + } + }, + "com.amazonaws.s3#BucketVersioningStatus": { + "type": "enum", + "members": { + "Enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enabled" + } + }, + "Suspended": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Suspended" + } + } + } + }, + "com.amazonaws.s3#Buckets": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#Bucket", + "traits": { + "smithy.api#xmlName": "Bucket" + } + } + }, + "com.amazonaws.s3#BypassGovernanceRetention": { + "type": "boolean" + }, + "com.amazonaws.s3#BytesProcessed": { + "type": "long" + }, + "com.amazonaws.s3#BytesReturned": { + "type": "long" + }, + "com.amazonaws.s3#BytesScanned": { + "type": "long" + }, + "com.amazonaws.s3#CORSConfiguration": { + "type": "structure", + "members": { + "CORSRules": { + "target": "com.amazonaws.s3#CORSRules", + "traits": { + "smithy.api#documentation": "

A set of origins and methods (cross-origin access that you want to allow). You can add\n up to 100 rules to the configuration.

", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "CORSRule" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more\n information, see Enabling\n Cross-Origin Resource Sharing in the\n Amazon S3 User Guide.

" + } + }, + "com.amazonaws.s3#CORSRule": { + "type": "structure", + "members": { + "ID": { + "target": "com.amazonaws.s3#ID", + "traits": { + "smithy.api#documentation": "

Unique identifier for the rule. The value cannot be longer than 255 characters.

" + } + }, + "AllowedHeaders": { + "target": "com.amazonaws.s3#AllowedHeaders", + "traits": { + "smithy.api#documentation": "

Headers that are specified in the Access-Control-Request-Headers header.\n These headers are allowed in a preflight OPTIONS request. In response to any preflight\n OPTIONS request, Amazon S3 returns any requested headers that are allowed.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "AllowedHeader" + } + }, + "AllowedMethods": { + "target": "com.amazonaws.s3#AllowedMethods", + "traits": { + "smithy.api#documentation": "

An HTTP method that you allow the origin to execute. Valid values are GET,\n PUT, HEAD, POST, and DELETE.

", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "AllowedMethod" + } + }, + "AllowedOrigins": { + "target": "com.amazonaws.s3#AllowedOrigins", + "traits": { + "smithy.api#documentation": "

One or more origins you want customers to be able to access the bucket from.

", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "AllowedOrigin" + } + }, + "ExposeHeaders": { + "target": "com.amazonaws.s3#ExposeHeaders", + "traits": { + "smithy.api#documentation": "

One or more headers in the response that you want customers to be able to access from\n their applications (for example, from a JavaScript XMLHttpRequest\n object).

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "ExposeHeader" + } + }, + "MaxAgeSeconds": { + "target": "com.amazonaws.s3#MaxAgeSeconds", + "traits": { + "smithy.api#documentation": "

The time in seconds that your browser is to cache the preflight response for the\n specified resource.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies a cross-origin access rule for an Amazon S3 bucket.

" + } + }, + "com.amazonaws.s3#CORSRules": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#CORSRule" + } + }, + "com.amazonaws.s3#CSVInput": { + "type": "structure", + "members": { + "FileHeaderInfo": { + "target": "com.amazonaws.s3#FileHeaderInfo", + "traits": { + "smithy.api#documentation": "

Describes the first line of input. Valid values are:

\n
    \n
  • \n

    \n NONE: First line is not a header.

    \n
    • \n
  • \n

    \n IGNORE: First line is a header, but you can't use the header values\n to indicate the column in an expression. You can use column position (such as _1, _2,\n …) to indicate the column (SELECT s._1 FROM OBJECT s).

    \n
    • \n
  • \n

    \n Use: First line is a header, and you can use the header value to\n identify a column in an expression (SELECT \"name\" FROM OBJECT).

    \n
    • \n
" + } + }, + "Comments": { + "target": "com.amazonaws.s3#Comments", + "traits": { + "smithy.api#documentation": "

A single character used to indicate that a row should be ignored when the character is\n present at the start of that row. You can specify any character to indicate a comment line.\n The default character is #.

\n

Default: #\n

" + } + }, + "QuoteEscapeCharacter": { + "target": "com.amazonaws.s3#QuoteEscapeCharacter", + "traits": { + "smithy.api#documentation": "

A single character used for escaping the quotation mark character inside an already\n escaped value. For example, the value \"\"\" a , b \"\"\" is parsed as \" a , b\n \".

" + } + }, + "RecordDelimiter": { + "target": "com.amazonaws.s3#RecordDelimiter", + "traits": { + "smithy.api#documentation": "

A single character used to separate individual records in the input. Instead of the\n default value, you can specify an arbitrary delimiter.

" + } + }, + "FieldDelimiter": { + "target": "com.amazonaws.s3#FieldDelimiter", + "traits": { + "smithy.api#documentation": "

A single character used to separate individual fields in a record. You can specify an\n arbitrary delimiter.

" + } + }, + "QuoteCharacter": { + "target": "com.amazonaws.s3#QuoteCharacter", + "traits": { + "smithy.api#documentation": "

A single character used for escaping when the field delimiter is part of the value. For\n example, if the value is a, b, Amazon S3 wraps this field value in quotation marks,\n as follows: \" a , b \".

\n

Type: String

\n

Default: \"\n

\n

Ancestors: CSV\n

" + } + }, + "AllowQuotedRecordDelimiter": { + "target": "com.amazonaws.s3#AllowQuotedRecordDelimiter", + "traits": { + "smithy.api#documentation": "

Specifies that CSV field values may contain quoted record delimiters and such records\n should be allowed. Default value is FALSE. Setting this value to TRUE may lower\n performance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes how an uncompressed comma-separated values (CSV)-formatted input object is\n formatted.

" + } + }, + "com.amazonaws.s3#CSVOutput": { + "type": "structure", + "members": { + "QuoteFields": { + "target": "com.amazonaws.s3#QuoteFields", + "traits": { + "smithy.api#documentation": "

Indicates whether to use quotation marks around output fields.

\n
    \n
  • \n

    \n ALWAYS: Always use quotation marks for output fields.

    \n
    • \n
  • \n

    \n ASNEEDED: Use quotation marks for output fields when needed.

    \n
    • \n
" + } + }, + "QuoteEscapeCharacter": { + "target": "com.amazonaws.s3#QuoteEscapeCharacter", + "traits": { + "smithy.api#documentation": "

The single character used for escaping the quote character inside an already escaped\n value.

" + } + }, + "RecordDelimiter": { + "target": "com.amazonaws.s3#RecordDelimiter", + "traits": { + "smithy.api#documentation": "

A single character used to separate individual records in the output. Instead of the\n default value, you can specify an arbitrary delimiter.

" + } + }, + "FieldDelimiter": { + "target": "com.amazonaws.s3#FieldDelimiter", + "traits": { + "smithy.api#documentation": "

The value used to separate individual fields in a record. You can specify an arbitrary\n delimiter.

" + } + }, + "QuoteCharacter": { + "target": "com.amazonaws.s3#QuoteCharacter", + "traits": { + "smithy.api#documentation": "

A single character used for escaping when the field delimiter is part of the value. For\n example, if the value is a, b, Amazon S3 wraps this field value in quotation marks,\n as follows: \" a , b \".

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes how uncompressed comma-separated values (CSV)-formatted results are\n formatted.

" + } + }, + "com.amazonaws.s3#CacheControl": { + "type": "string" + }, + "com.amazonaws.s3#Checksum": { + "type": "structure", + "members": { + "ChecksumCRC32": { + "target": "com.amazonaws.s3#ChecksumCRC32", + "traits": { + "smithy.api#documentation": "

The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

" + } + }, + "ChecksumCRC32C": { + "target": "com.amazonaws.s3#ChecksumCRC32C", + "traits": { + "smithy.api#documentation": "

The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

" + } + }, + "ChecksumSHA1": { + "target": "com.amazonaws.s3#ChecksumSHA1", + "traits": { + "smithy.api#documentation": "

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded\n with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

" + } + }, + "ChecksumSHA256": { + "target": "com.amazonaws.s3#ChecksumSHA256", + "traits": { + "smithy.api#documentation": "

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains all the possible checksum or digest values for an object.

" + } + }, + "com.amazonaws.s3#ChecksumAlgorithm": { + "type": "enum", + "members": { + "CRC32": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CRC32" + } + }, + "CRC32C": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CRC32C" + } + }, + "SHA1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHA1" + } + }, + "SHA256": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHA256" + } + } + } + }, + "com.amazonaws.s3#ChecksumAlgorithmList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#ChecksumAlgorithm" + } + }, + "com.amazonaws.s3#ChecksumCRC32": { + "type": "string" + }, + "com.amazonaws.s3#ChecksumCRC32C": { + "type": "string" + }, + "com.amazonaws.s3#ChecksumMode": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + } + } + }, + "com.amazonaws.s3#ChecksumSHA1": { + "type": "string" + }, + "com.amazonaws.s3#ChecksumSHA256": { + "type": "string" + }, + "com.amazonaws.s3#Code": { + "type": "string" + }, + "com.amazonaws.s3#Comments": { + "type": "string" + }, + "com.amazonaws.s3#CommonPrefix": { + "type": "structure", + "members": { + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "

Container for the specified common prefix.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Container for all (if there are any) keys between Prefix and the next occurrence of the\n string specified by a delimiter. CommonPrefixes lists keys that act like subdirectories in\n the directory specified by Prefix. For example, if the prefix is notes/ and the delimiter\n is a slash (/) as in notes/summer/july, the common prefix is notes/summer/.

" + } + }, + "com.amazonaws.s3#CommonPrefixList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#CommonPrefix" + } + }, + "com.amazonaws.s3#CompleteMultipartUpload": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#CompleteMultipartUploadRequest" + }, + "output": { + "target": "com.amazonaws.s3#CompleteMultipartUploadOutput" + }, + "traits": { + "smithy.api#documentation": "

Completes a multipart upload by assembling previously uploaded parts.

\n

You first initiate the multipart upload and then upload all parts using the UploadPart\n operation or the UploadPartCopy operation.\n After successfully uploading all relevant parts of an upload, you call this\n CompleteMultipartUpload operation to complete the upload. Upon receiving\n this request, Amazon S3 concatenates all the parts in ascending order by part number to create a\n new object. In the CompleteMultipartUpload request, you must provide the parts list and\n ensure that the parts list is complete. The CompleteMultipartUpload API operation\n concatenates the parts that you provide in the list. For each part in the list, you must\n provide the PartNumber value and the ETag value that are returned\n after that part was uploaded.

\n

The processing of a CompleteMultipartUpload request could take several minutes to\n finalize. After Amazon S3 begins processing the request, it sends an HTTP response header that\n specifies a 200 OK response. While processing is in progress, Amazon S3\n periodically sends white space characters to keep the connection from timing out. A request\n could fail after the initial 200 OK response has been sent. This means that a\n 200 OK response can contain either a success or an error. The error\n response might be embedded in the 200 OK response. If you call this API\n operation directly, make sure to design your application to parse the contents of the\n response and handle it appropriately. If you use Amazon Web Services SDKs, SDKs handle this condition.\n The SDKs detect the embedded error and apply error handling per your configuration settings\n (including automatically retrying the request as appropriate). If the condition persists,\n the SDKs throw an exception (or, for the SDKs that don't use exceptions, they return an\n error).

\n

Note that if CompleteMultipartUpload fails, applications should be prepared\n to retry any failed requests (including 500 error responses). For more information, see\n Amazon S3 Error\n Best Practices.

\n \n

You can't use Content-Type: application/x-www-form-urlencoded for the\n CompleteMultipartUpload requests. Also, if you don't provide a Content-Type\n header, CompleteMultipartUpload can still return a 200 OK\n response.

\n \n

For more information about multipart uploads, see Uploading Objects Using Multipart\n Upload in the Amazon S3 User Guide.

\n \n

\n Directory buckets -\n For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket-name.s3express-zone-id.region-code.amazonaws.com/key-name\n . Path-style requests are not supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the\n Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the\n Amazon S3 User Guide.

\n \n
\n
Permissions
\n
\n
    \n
  • \n

    \n General purpose bucket permissions - For\n information about permissions required to use the multipart upload API, see\n Multipart Upload and\n Permissions in the Amazon S3 User Guide.

    \n

    If you provide an additional checksum\n value in your MultipartUpload requests and the\n object is encrypted with Key Management Service, you must have permission to use the\n kms:Decrypt action for the\n CompleteMultipartUpload request to succeed.

    \n
    • \n
  • \n

    \n Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the \n CreateSession\n API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. \nAmazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see \n CreateSession\n .

    \n

    If the object is encrypted with SSE-KMS, you must also have the\n kms:GenerateDataKey and kms:Decrypt permissions\n in IAM identity-based policies and KMS key policies for the KMS\n key.

    \n
    • \n
\n
\n
Special errors
\n
\n
    \n
  • \n

    Error Code: EntityTooSmall\n

    \n
      \n
    • \n

      Description: Your proposed upload is smaller than the minimum\n allowed object size. Each part must be at least 5 MB in size, except\n the last part.

      \n
      • \n
    • \n

      HTTP Status Code: 400 Bad Request

      \n
      • \n
    \n
    • \n
  • \n

    Error Code: InvalidPart\n

    \n
      \n
    • \n

      Description: One or more of the specified parts could not be found.\n The part might not have been uploaded, or the specified ETag might not\n have matched the uploaded part's ETag.

      \n
      • \n
    • \n

      HTTP Status Code: 400 Bad Request

      \n
      • \n
    \n
    • \n
  • \n

    Error Code: InvalidPartOrder\n

    \n
      \n
    • \n

      Description: The list of parts was not in ascending order. The\n parts list must be specified in order by part number.

      \n
      • \n
    • \n

      HTTP Status Code: 400 Bad Request

      \n
      • \n
    \n
    • \n
  • \n

    Error Code: NoSuchUpload\n

    \n
      \n
    • \n

      Description: The specified multipart upload does not exist. The\n upload ID might be invalid, or the multipart upload might have been\n aborted or completed.

      \n
      • \n
    • \n

      HTTP Status Code: 404 Not Found

      \n
      • \n
    \n
    • \n
\n
\n
HTTP Host header syntax
\n
\n

\n Directory buckets - The HTTP Host header syntax is \n Bucket-name.s3express-zone-id.region-code.amazonaws.com.

\n
\n
\n

The following operations are related to CompleteMultipartUpload:

\n ", + "smithy.api#examples": [ + { + "title": "To complete multipart upload", + "documentation": "The following example completes a multipart upload.", + "input": { + "Bucket": "examplebucket", + "Key": "bigobject", + "MultipartUpload": { + "Parts": [ + { + "PartNumber": 1, + "ETag": "\"d8c2eafd90c266e19ab9dcacc479f8af\"" + }, + { + "PartNumber": 2, + "ETag": "\"d8c2eafd90c266e19ab9dcacc479f8af\"" + } + ] + }, + "UploadId": "7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--" + }, + "output": { + "ETag": "\"4d9031c7644d8081c2829f4ea23c55f7-2\"", + "Bucket": "acexamplebucket", + "Location": "https://examplebucket.s3..amazonaws.com/bigobject", + "Key": "bigobject" + } + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/{Bucket}/{Key+}", + "code": 200 + } + } + }, + "com.amazonaws.s3#CompleteMultipartUploadOutput": { + "type": "structure", + "members": { + "Location": { + "target": "com.amazonaws.s3#Location", + "traits": { + "smithy.api#documentation": "

The URI that identifies the newly created object.

" + } + }, + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket that contains the newly created object. Does not return the access point\n ARN or access point alias if used.

\n \n

Access points are not supported by directory buckets.

\n " + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

The object key of the newly created object.

" + } + }, + "Expiration": { + "target": "com.amazonaws.s3#Expiration", + "traits": { + "smithy.api#documentation": "

If the object expiration is configured, this will contain the expiration date\n (expiry-date) and rule ID (rule-id). The value of\n rule-id is URL-encoded.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-expiration" + } + }, + "ETag": { + "target": "com.amazonaws.s3#ETag", + "traits": { + "smithy.api#documentation": "

Entity tag that identifies the newly created object's data. Objects with different\n object data will have different entity tags. The entity tag is an opaque string. The entity\n tag may or may not be an MD5 digest of the object data. If the entity tag is not an MD5\n digest of the object data, it will contain one or more nonhexadecimal characters and/or\n will consist of less than 32 or more than 32 hexadecimal digits. For more information about\n how the entity tag is calculated, see Checking object\n integrity in the Amazon S3 User Guide.

" + } + }, + "ChecksumCRC32": { + "target": "com.amazonaws.s3#ChecksumCRC32", + "traits": { + "smithy.api#documentation": "

The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

" + } + }, + "ChecksumCRC32C": { + "target": "com.amazonaws.s3#ChecksumCRC32C", + "traits": { + "smithy.api#documentation": "

The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

" + } + }, + "ChecksumSHA1": { + "target": "com.amazonaws.s3#ChecksumSHA1", + "traits": { + "smithy.api#documentation": "

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded\n with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

" + } + }, + "ChecksumSHA256": { + "target": "com.amazonaws.s3#ChecksumSHA256", + "traits": { + "smithy.api#documentation": "

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

" + } + }, + "ServerSideEncryption": { + "target": "com.amazonaws.s3#ServerSideEncryption", + "traits": { + "smithy.api#documentation": "

The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).

", + "smithy.api#httpHeader": "x-amz-server-side-encryption" + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

Version ID of the newly created object, in case the bucket has versioning turned\n on.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-version-id" + } + }, + "SSEKMSKeyId": { + "target": "com.amazonaws.s3#SSEKMSKeyId", + "traits": { + "smithy.api#documentation": "

If present, indicates the ID of the KMS key that was used for object encryption.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" + } + }, + "BucketKeyEnabled": { + "target": "com.amazonaws.s3#BucketKeyEnabled", + "traits": { + "smithy.api#documentation": "

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption\n with Key Management Service (KMS) keys (SSE-KMS).

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" + } + }, + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#xmlName": "CompleteMultipartUploadResult" + } + }, + "com.amazonaws.s3#CompleteMultipartUploadRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

Name of the bucket to which the multipart upload was initiated.

\n

\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n \n

Access points and Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

Object key for which the multipart upload was initiated.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Key" + } + } + }, + "MultipartUpload": { + "target": "com.amazonaws.s3#CompletedMultipartUpload", + "traits": { + "smithy.api#documentation": "

The container for the multipart upload request information.

", + "smithy.api#httpPayload": {}, + "smithy.api#xmlName": "CompleteMultipartUpload" + } + }, + "UploadId": { + "target": "com.amazonaws.s3#MultipartUploadId", + "traits": { + "smithy.api#documentation": "

ID for the initiated multipart upload.

", + "smithy.api#httpQuery": "uploadId", + "smithy.api#required": {} + } + }, + "ChecksumCRC32": { + "target": "com.amazonaws.s3#ChecksumCRC32", + "traits": { + "smithy.api#documentation": "

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.\n This header specifies the base64-encoded, 32-bit CRC-32 checksum of the object. For more information, see\n Checking object integrity in the\n Amazon S3 User Guide.

", + "smithy.api#httpHeader": "x-amz-checksum-crc32" + } + }, + "ChecksumCRC32C": { + "target": "com.amazonaws.s3#ChecksumCRC32C", + "traits": { + "smithy.api#documentation": "

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.\n This header specifies the base64-encoded, 32-bit CRC-32C checksum of the object. For more information, see\n Checking object integrity in the\n Amazon S3 User Guide.

", + "smithy.api#httpHeader": "x-amz-checksum-crc32c" + } + }, + "ChecksumSHA1": { + "target": "com.amazonaws.s3#ChecksumSHA1", + "traits": { + "smithy.api#documentation": "

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.\n This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see\n Checking object integrity in the\n Amazon S3 User Guide.

", + "smithy.api#httpHeader": "x-amz-checksum-sha1" + } + }, + "ChecksumSHA256": { + "target": "com.amazonaws.s3#ChecksumSHA256", + "traits": { + "smithy.api#documentation": "

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.\n This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see\n Checking object integrity in the\n Amazon S3 User Guide.

", + "smithy.api#httpHeader": "x-amz-checksum-sha256" + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + }, + "IfMatch": { + "target": "com.amazonaws.s3#IfMatch", + "traits": { + "smithy.api#documentation": "

Uploads the object only if the ETag (entity tag) value provided during the WRITE\n operation matches the ETag of the object in S3. If the ETag values do not match, the\n operation returns a 412 Precondition Failed error.

\n

If a conflicting operation occurs during the upload S3 returns a 409\n ConditionalRequestConflict response. On a 409 failure you should fetch the object's ETag, re-initiate the\n multipart upload with CreateMultipartUpload, and re-upload each part.

\n

Expects the ETag value as a string.

\n

For more information about conditional requests, see RFC 7232, or Conditional requests in the Amazon S3 User Guide.

", + "smithy.api#httpHeader": "If-Match" + } + }, + "IfNoneMatch": { + "target": "com.amazonaws.s3#IfNoneMatch", + "traits": { + "smithy.api#documentation": "

Uploads the object only if the object key name does not already exist in the bucket\n specified. Otherwise, Amazon S3 returns a 412 Precondition Failed error.

\n

If a conflicting operation occurs during the upload S3 returns a 409\n ConditionalRequestConflict response. On a 409 failure you should re-initiate the\n multipart upload with CreateMultipartUpload and re-upload each part.

\n

Expects the '*' (asterisk) character.

\n

For more information about conditional requests, see RFC 7232, or Conditional requests in the Amazon S3 User Guide.

", + "smithy.api#httpHeader": "If-None-Match" + } + }, + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "traits": { + "smithy.api#documentation": "

The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is\n required only when the object was created using a checksum algorithm or if your bucket\n policy requires the use of SSE-C. For more information, see Protecting data using SSE-C keys in the Amazon S3 User\n Guide.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + } + }, + "SSECustomerKey": { + "target": "com.amazonaws.s3#SSECustomerKey", + "traits": { + "smithy.api#documentation": "

The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. \n For more information, see\n Protecting data using SSE-C keys in the\n Amazon S3 User Guide.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key" + } + }, + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "traits": { + "smithy.api#documentation": "

The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum \n algorithm. For more information,\n see Protecting data using SSE-C keys in the\n Amazon S3 User Guide.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#CompletedMultipartUpload": { + "type": "structure", + "members": { + "Parts": { + "target": "com.amazonaws.s3#CompletedPartList", + "traits": { + "smithy.api#documentation": "

Array of CompletedPart data types.

\n

If you do not supply a valid Part with your request, the service sends back\n an HTTP 400 response.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Part" + } + } + }, + "traits": { + "smithy.api#documentation": "

The container for the completed multipart upload details.

" + } + }, + "com.amazonaws.s3#CompletedPart": { + "type": "structure", + "members": { + "ETag": { + "target": "com.amazonaws.s3#ETag", + "traits": { + "smithy.api#documentation": "

Entity tag returned when the part was uploaded.

" + } + }, + "ChecksumCRC32": { + "target": "com.amazonaws.s3#ChecksumCRC32", + "traits": { + "smithy.api#documentation": "

The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

" + } + }, + "ChecksumCRC32C": { + "target": "com.amazonaws.s3#ChecksumCRC32C", + "traits": { + "smithy.api#documentation": "

The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

" + } + }, + "ChecksumSHA1": { + "target": "com.amazonaws.s3#ChecksumSHA1", + "traits": { + "smithy.api#documentation": "

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded\n with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

" + } + }, + "ChecksumSHA256": { + "target": "com.amazonaws.s3#ChecksumSHA256", + "traits": { + "smithy.api#documentation": "

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

" + } + }, + "PartNumber": { + "target": "com.amazonaws.s3#PartNumber", + "traits": { + "smithy.api#documentation": "

Part number that identifies the part. This is a positive integer between 1 and\n 10,000.

\n \n
    \n
  • \n

    \n General purpose buckets - In\n CompleteMultipartUpload, when a additional checksum (including\n x-amz-checksum-crc32, x-amz-checksum-crc32c,\n x-amz-checksum-sha1, or x-amz-checksum-sha256) is\n applied to each part, the PartNumber must start at 1 and the part\n numbers must be consecutive. Otherwise, Amazon S3 generates an HTTP 400 Bad\n Request status code and an InvalidPartOrder error\n code.

    \n
    • \n
  • \n

    \n Directory buckets - In\n CompleteMultipartUpload, the PartNumber must start at\n 1 and the part numbers must be consecutive.

    \n
    • \n
\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Details of the parts that were uploaded.

" + } + }, + "com.amazonaws.s3#CompletedPartList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#CompletedPart" + } + }, + "com.amazonaws.s3#CompressionType": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "GZIP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GZIP" + } + }, + "BZIP2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BZIP2" + } + } + } + }, + "com.amazonaws.s3#Condition": { + "type": "structure", + "members": { + "HttpErrorCodeReturnedEquals": { + "target": "com.amazonaws.s3#HttpErrorCodeReturnedEquals", + "traits": { + "smithy.api#documentation": "

The HTTP error code when the redirect is applied. In the event of an error, if the error\n code equals this value, then the specified redirect is applied. Required when parent\n element Condition is specified and sibling KeyPrefixEquals is not\n specified. If both are specified, then both must be true for the redirect to be\n applied.

" + } + }, + "KeyPrefixEquals": { + "target": "com.amazonaws.s3#KeyPrefixEquals", + "traits": { + "smithy.api#documentation": "

The object key name prefix when the redirect is applied. For example, to redirect\n requests for ExamplePage.html, the key prefix will be\n ExamplePage.html. To redirect request for all pages with the prefix\n docs/, the key prefix will be /docs, which identifies all\n objects in the docs/ folder. Required when the parent element\n Condition is specified and sibling HttpErrorCodeReturnedEquals\n is not specified. If both conditions are specified, both must be true for the redirect to\n be applied.

\n \n

Replacement must be made for object keys containing special characters (such as carriage returns) when using \n XML requests. For more information, see \n XML related object key constraints.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

A container for describing a condition that must be met for the specified redirect to\n apply. For example, 1. If request is for pages in the /docs folder, redirect\n to the /documents folder. 2. If request results in HTTP error 4xx, redirect\n request to another host where you might process the error.

" + } + }, + "com.amazonaws.s3#ConfirmRemoveSelfBucketAccess": { + "type": "boolean" + }, + "com.amazonaws.s3#ContentDisposition": { + "type": "string" + }, + "com.amazonaws.s3#ContentEncoding": { + "type": "string" + }, + "com.amazonaws.s3#ContentLanguage": { + "type": "string" + }, + "com.amazonaws.s3#ContentLength": { + "type": "long" + }, + "com.amazonaws.s3#ContentMD5": { + "type": "string" + }, + "com.amazonaws.s3#ContentRange": { + "type": "string" + }, + "com.amazonaws.s3#ContentType": { + "type": "string" + }, + "com.amazonaws.s3#ContinuationEvent": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.s3#CopyObject": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#CopyObjectRequest" + }, + "output": { + "target": "com.amazonaws.s3#CopyObjectOutput" + }, + "errors": [ + { + "target": "com.amazonaws.s3#ObjectNotInActiveTierError" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a copy of an object that is already stored in Amazon S3.

\n \n

You can store individual objects of up to 5 TB in Amazon S3. You create a copy of your\n object up to 5 GB in size in a single atomic action using this API. However, to copy an\n object greater than 5 GB, you must use the multipart upload Upload Part - Copy\n (UploadPartCopy) API. For more information, see Copy Object Using the\n REST Multipart Upload API.

\n \n

You can copy individual objects between general purpose buckets, between directory buckets,\n and between general purpose buckets and directory buckets.

\n \n
    \n
  • \n

    Amazon S3 supports copy operations using Multi-Region Access Points only as a\n destination when using the Multi-Region Access Point ARN.

    \n
    • \n
  • \n

    \n Directory buckets -\n For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket-name.s3express-zone-id.region-code.amazonaws.com/key-name\n . Path-style requests are not supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the\n Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the\n Amazon S3 User Guide.

    \n
    • \n
  • \n

    VPC endpoints don't support cross-Region requests (including copies). If you're\n using VPC endpoints, your source and destination buckets should be in the same\n Amazon Web Services Region as your VPC endpoint.

    \n
    • \n
\n \n

Both the Region that you want to copy the object from and the Region that you want to\n copy the object to must be enabled for your account. For more information about how to\n enable a Region for your account, see Enable or disable a Region for standalone accounts in the Amazon Web Services\n Account Management Guide.

\n \n

Amazon S3 transfer acceleration does not support cross-Region copies. If you request a\n cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad\n Request error. For more information, see Transfer\n Acceleration.

\n \n
\n
Authentication and authorization
\n
\n

All CopyObject requests must be authenticated and signed by using\n IAM credentials (access key ID and secret access key for the IAM identities).\n All headers with the x-amz- prefix, including\n x-amz-copy-source, must be signed. For more information, see\n REST Authentication.

\n

\n Directory buckets - You must use the\n IAM credentials to authenticate and authorize your access to the\n CopyObject API operation, instead of using the temporary security\n credentials through the CreateSession API operation.

\n

Amazon Web Services CLI or SDKs handles authentication and authorization on your\n behalf.

\n
\n
Permissions
\n
\n

You must have read access to the source object and\n write access to the destination bucket.

\n
    \n
  • \n

    \n General purpose bucket permissions - You\n must have permissions in an IAM policy based on the source and destination\n bucket types in a CopyObject operation.

    \n
      \n
    • \n

      If the source object is in a general purpose bucket, you must have\n \n s3:GetObject\n \n permission to read the source object that is being copied.

      \n
      • \n
    • \n

      If the destination bucket is a general purpose bucket, you must have\n \n s3:PutObject\n \n permission to write the object copy to the destination bucket.

      \n
      • \n
    \n
    • \n
  • \n

    \n Directory bucket permissions -\n You must have permissions in a bucket policy or an IAM identity-based policy based on the\n source and destination bucket types in a CopyObject\n operation.

    \n
      \n
    • \n

      If the source object that you want to copy is in a\n directory bucket, you must have the \n s3express:CreateSession\n permission in\n the Action element of a policy to read the object. By\n default, the session is in the ReadWrite mode. If you\n want to restrict the access, you can explicitly set the\n s3express:SessionMode condition key to\n ReadOnly on the copy source bucket.

      \n
      • \n
    • \n

      If the copy destination is a directory bucket, you must have the\n \n s3express:CreateSession\n permission in the\n Action element of a policy to write the object to the\n destination. The s3express:SessionMode condition key\n can't be set to ReadOnly on the copy destination bucket.\n

      \n
      • \n
    \n

    If the object is encrypted with SSE-KMS, you must also have the\n kms:GenerateDataKey and kms:Decrypt permissions\n in IAM identity-based policies and KMS key policies for the KMS\n key.

    \n

    For example policies, see Example bucket policies for S3 Express One Zone and Amazon Web Services Identity and Access Management (IAM) identity-based policies for\n S3 Express One Zone in the Amazon S3 User Guide.

    \n
    • \n
\n
\n
Response and special errors
\n
\n

When the request is an HTTP 1.1 request, the response is chunk encoded. When\n the request is not an HTTP 1.1 request, the response would not contain the\n Content-Length. You always need to read the entire response body\n to check if the copy succeeds.

\n
    \n
  • \n

    If the copy is successful, you receive a response with information about\n the copied object.

    \n
    • \n
  • \n

    A copy request might return an error when Amazon S3 receives the copy request\n or while Amazon S3 is copying the files. A 200 OK response can\n contain either a success or an error.

    \n
      \n
    • \n

      If the error occurs before the copy action starts, you receive a\n standard Amazon S3 error.

      \n
      • \n
    • \n

      If the error occurs during the copy operation, the error response\n is embedded in the 200 OK response. For example, in a\n cross-region copy, you may encounter throttling and receive a\n 200 OK response. For more information, see Resolve the Error 200 response when copying objects to\n Amazon S3. The 200 OK status code means the copy\n was accepted, but it doesn't mean the copy is complete. Another\n example is when you disconnect from Amazon S3 before the copy is complete,\n Amazon S3 might cancel the copy and you may receive a 200 OK\n response. You must stay connected to Amazon S3 until the entire response is\n successfully received and processed.

      \n

      If you call this API operation directly, make sure to design your\n application to parse the content of the response and handle it\n appropriately. If you use Amazon Web Services SDKs, SDKs handle this condition. The\n SDKs detect the embedded error and apply error handling per your\n configuration settings (including automatically retrying the request\n as appropriate). If the condition persists, the SDKs throw an\n exception (or, for the SDKs that don't use exceptions, they return an\n error).

      \n
      • \n
    \n
    • \n
\n
\n
Charge
\n
\n

The copy request charge is based on the storage class and Region that you\n specify for the destination object. The request can also result in a data\n retrieval charge for the source if the source storage class bills for data\n retrieval. If the copy source is in a different region, the data transfer is\n billed to the copy source account. For pricing information, see Amazon S3 pricing.

\n
\n
HTTP Host header syntax
\n
\n

\n Directory buckets - The HTTP Host header syntax is \n Bucket-name.s3express-zone-id.region-code.amazonaws.com.

\n
\n
\n

The following operations are related to CopyObject:

\n ", + "smithy.api#examples": [ + { + "title": "To copy an object", + "documentation": "The following example copies an object from one bucket to another.", + "input": { + "Bucket": "destinationbucket", + "CopySource": "/sourcebucket/HappyFacejpg", + "Key": "HappyFaceCopyjpg" + }, + "output": { + "CopyObjectResult": { + "LastModified": "2016-12-15T17:38:53.000Z", + "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"" + } + } + } + ], + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}/{Key+}?x-id=CopyObject", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "DisableS3ExpressSessionAuth": { + "value": true + } + } + } + }, + "com.amazonaws.s3#CopyObjectOutput": { + "type": "structure", + "members": { + "CopyObjectResult": { + "target": "com.amazonaws.s3#CopyObjectResult", + "traits": { + "smithy.api#documentation": "

Container for all response elements.

", + "smithy.api#httpPayload": {} + } + }, + "Expiration": { + "target": "com.amazonaws.s3#Expiration", + "traits": { + "smithy.api#documentation": "

If the object expiration is configured, the response includes this header.

\n \n

Object expiration information is not returned in directory buckets and this header returns the value \"NotImplemented\" in all responses for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-expiration" + } + }, + "CopySourceVersionId": { + "target": "com.amazonaws.s3#CopySourceVersionId", + "traits": { + "smithy.api#documentation": "

Version ID of the source object that was copied.

\n \n

This functionality is not supported when the source object is in a directory bucket.

\n ", + "smithy.api#httpHeader": "x-amz-copy-source-version-id" + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

Version ID of the newly created copy.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-version-id" + } + }, + "ServerSideEncryption": { + "target": "com.amazonaws.s3#ServerSideEncryption", + "traits": { + "smithy.api#documentation": "

The server-side encryption algorithm used when you store this object in Amazon S3 (for\n example, AES256, aws:kms, aws:kms:dsse).

", + "smithy.api#httpHeader": "x-amz-server-side-encryption" + } + }, + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "traits": { + "smithy.api#documentation": "

If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to confirm the encryption algorithm that's used.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + } + }, + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "traits": { + "smithy.api#documentation": "

If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to provide the round-trip message integrity verification\n of the customer-provided encryption key.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" + } + }, + "SSEKMSKeyId": { + "target": "com.amazonaws.s3#SSEKMSKeyId", + "traits": { + "smithy.api#documentation": "

If present, indicates the ID of the KMS key that was used for object encryption.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" + } + }, + "SSEKMSEncryptionContext": { + "target": "com.amazonaws.s3#SSEKMSEncryptionContext", + "traits": { + "smithy.api#documentation": "

If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption. The\n value of this header is a base64-encoded UTF-8 string holding JSON with the encryption\n context key-value pairs.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-context" + } + }, + "BucketKeyEnabled": { + "target": "com.amazonaws.s3#BucketKeyEnabled", + "traits": { + "smithy.api#documentation": "

Indicates whether the copied object uses an S3 Bucket Key for server-side encryption\n with Key Management Service (KMS) keys (SSE-KMS).

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" + } + }, + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3#CopyObjectRequest": { + "type": "structure", + "members": { + "ACL": { + "target": "com.amazonaws.s3#ObjectCannedACL", + "traits": { + "smithy.api#documentation": "

The canned access control list (ACL) to apply to the object.

\n

When you copy an object, the ACL metadata is not preserved and is set to\n private by default. Only the owner has full access control. To override the\n default ACL setting, specify a new ACL when you generate a copy request. For more\n information, see Using ACLs.

\n

If the destination bucket that you're copying objects to uses the bucket owner enforced\n setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions.\n Buckets that use this setting only accept PUT requests that don't specify an\n ACL or PUT requests that specify bucket owner full control ACLs, such as the\n bucket-owner-full-control canned ACL or an equivalent form of this ACL\n expressed in the XML format. For more information, see Controlling ownership of\n objects and disabling ACLs in the Amazon S3 User Guide.

\n \n
    \n
  • \n

    If your destination bucket uses the bucket owner enforced setting for Object\n Ownership, all objects written to the bucket by any account will be owned by the\n bucket owner.

    \n
    • \n
  • \n

    This functionality is not supported for directory buckets.

    \n
    • \n
  • \n

    This functionality is not supported for Amazon S3 on Outposts.

    \n
    • \n
\n ", + "smithy.api#httpHeader": "x-amz-acl" + } + }, + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the destination bucket.

\n

\n Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n \n

Copying objects across different Amazon Web Services Regions isn't supported when the source or destination bucket is in Amazon Web Services Local Zones. The source and destination buckets must have the same parent Amazon Web Services Region. Otherwise, \n you get an HTTP 400 Bad Request error with the error code InvalidRequest.

\n \n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n \n

Access points and Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "CacheControl": { + "target": "com.amazonaws.s3#CacheControl", + "traits": { + "smithy.api#documentation": "

Specifies the caching behavior along the request/reply chain.

", + "smithy.api#httpHeader": "Cache-Control" + } + }, + "ChecksumAlgorithm": { + "target": "com.amazonaws.s3#ChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "

Indicates the algorithm that you want Amazon S3 to use to create the checksum for the object. For more information, see\n Checking object integrity in\n the Amazon S3 User Guide.

\n

When you copy an object, if the source object has a checksum, that checksum value will\n be copied to the new object by default. If the CopyObject request does not\n include this x-amz-checksum-algorithm header, the checksum algorithm will be\n copied from the source object to the destination object (if it's present on the source\n object). You can optionally specify a different checksum algorithm to use with the\n x-amz-checksum-algorithm header. Unrecognized or unsupported values will\n respond with the HTTP status code 400 Bad Request.

\n \n

For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default checksum algorithm that's used for performance.

\n ", + "smithy.api#httpHeader": "x-amz-checksum-algorithm" + } + }, + "ContentDisposition": { + "target": "com.amazonaws.s3#ContentDisposition", + "traits": { + "smithy.api#documentation": "

Specifies presentational information for the object. Indicates whether an object should\n be displayed in a web browser or downloaded as a file. It allows specifying the desired\n filename for the downloaded file.

", + "smithy.api#httpHeader": "Content-Disposition" + } + }, + "ContentEncoding": { + "target": "com.amazonaws.s3#ContentEncoding", + "traits": { + "smithy.api#documentation": "

Specifies what content encodings have been applied to the object and thus what decoding\n mechanisms must be applied to obtain the media-type referenced by the Content-Type header\n field.

\n \n

For directory buckets, only the aws-chunked value is supported in this header field.

\n ", + "smithy.api#httpHeader": "Content-Encoding" + } + }, + "ContentLanguage": { + "target": "com.amazonaws.s3#ContentLanguage", + "traits": { + "smithy.api#documentation": "

The language the content is in.

", + "smithy.api#httpHeader": "Content-Language" + } + }, + "ContentType": { + "target": "com.amazonaws.s3#ContentType", + "traits": { + "smithy.api#documentation": "

A standard MIME type that describes the format of the object data.

", + "smithy.api#httpHeader": "Content-Type" + } + }, + "CopySource": { + "target": "com.amazonaws.s3#CopySource", + "traits": { + "smithy.api#documentation": "

Specifies the source object for the copy operation. The source object can be up to 5 GB.\n If the source object is an object that was uploaded by using a multipart upload, the object\n copy will be a single part object after the source object is copied to the destination\n bucket.

\n

You specify the value of the copy source in one of two formats, depending on whether you\n want to access the source object through an access point:

\n
    \n
  • \n

    For objects not accessed through an access point, specify the name of the source bucket\n and the key of the source object, separated by a slash (/). For example, to copy the\n object reports/january.pdf from the general purpose bucket\n awsexamplebucket, use\n awsexamplebucket/reports/january.pdf. The value must be URL-encoded.\n To copy the object reports/january.pdf from the directory bucket\n awsexamplebucket--use1-az5--x-s3, use\n awsexamplebucket--use1-az5--x-s3/reports/january.pdf. The value must\n be URL-encoded.

    \n
    • \n
  • \n

    For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:::accesspoint//object/. For example, to copy the object reports/january.pdf through access point my-access-point owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The value must be URL encoded.

    \n \n
      \n
    • \n

      Amazon S3 supports copy operations using Access points only when the source and destination buckets are in the same Amazon Web Services Region.

      \n
      • \n
    • \n

      Access points are not supported by directory buckets.

      \n
      • \n
    \n     \n

    Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:::outpost//object/. For example, to copy the object reports/january.pdf through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. The value must be URL-encoded.

    \n
    • \n
\n

If your source bucket versioning is enabled, the x-amz-copy-source header\n by default identifies the current version of an object to copy. If the current version is a\n delete marker, Amazon S3 behaves as if the object was deleted. To copy a different version, use\n the versionId query parameter. Specifically, append\n ?versionId= to the value (for example,\n awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893).\n If you don't specify a version ID, Amazon S3 copies the latest version of the source\n object.

\n

If you enable versioning on the destination bucket, Amazon S3 generates a unique version ID\n for the copied object. This version ID is different from the version ID of the source\n object. Amazon S3 returns the version ID of the copied object in the\n x-amz-version-id response header in the response.

\n

If you do not enable versioning or suspend it on the destination bucket, the version ID\n that Amazon S3 generates in the x-amz-version-id response header is always\n null.

\n \n

\n Directory buckets -\n S3 Versioning isn't enabled and supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-copy-source", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "CopySource" + } + } + }, + "CopySourceIfMatch": { + "target": "com.amazonaws.s3#CopySourceIfMatch", + "traits": { + "smithy.api#documentation": "

Copies the object if its entity tag (ETag) matches the specified tag.

\n

If both the x-amz-copy-source-if-match and\n x-amz-copy-source-if-unmodified-since headers are present in the request\n and evaluate as follows, Amazon S3 returns 200 OK and copies the data:

\n
    \n
  • \n

    \n x-amz-copy-source-if-match condition evaluates to true

    \n
    • \n
  • \n

    \n x-amz-copy-source-if-unmodified-since condition evaluates to\n false

    \n
    • \n
", + "smithy.api#httpHeader": "x-amz-copy-source-if-match" + } + }, + "CopySourceIfModifiedSince": { + "target": "com.amazonaws.s3#CopySourceIfModifiedSince", + "traits": { + "smithy.api#documentation": "

Copies the object if it has been modified since the specified time.

\n

If both the x-amz-copy-source-if-none-match and\n x-amz-copy-source-if-modified-since headers are present in the request and\n evaluate as follows, Amazon S3 returns the 412 Precondition Failed response\n code:

\n
    \n
  • \n

    \n x-amz-copy-source-if-none-match condition evaluates to false

    \n
    • \n
  • \n

    \n x-amz-copy-source-if-modified-since condition evaluates to\n true

    \n
    • \n
", + "smithy.api#httpHeader": "x-amz-copy-source-if-modified-since" + } + }, + "CopySourceIfNoneMatch": { + "target": "com.amazonaws.s3#CopySourceIfNoneMatch", + "traits": { + "smithy.api#documentation": "

Copies the object if its entity tag (ETag) is different than the specified ETag.

\n

If both the x-amz-copy-source-if-none-match and\n x-amz-copy-source-if-modified-since headers are present in the request and\n evaluate as follows, Amazon S3 returns the 412 Precondition Failed response\n code:

\n
    \n
  • \n

    \n x-amz-copy-source-if-none-match condition evaluates to false

    \n
    • \n
  • \n

    \n x-amz-copy-source-if-modified-since condition evaluates to\n true

    \n
    • \n
", + "smithy.api#httpHeader": "x-amz-copy-source-if-none-match" + } + }, + "CopySourceIfUnmodifiedSince": { + "target": "com.amazonaws.s3#CopySourceIfUnmodifiedSince", + "traits": { + "smithy.api#documentation": "

Copies the object if it hasn't been modified since the specified time.

\n

If both the x-amz-copy-source-if-match and\n x-amz-copy-source-if-unmodified-since headers are present in the request\n and evaluate as follows, Amazon S3 returns 200 OK and copies the data:

\n
    \n
  • \n

    \n x-amz-copy-source-if-match condition evaluates to true

    \n
    • \n
  • \n

    \n x-amz-copy-source-if-unmodified-since condition evaluates to\n false

    \n
    • \n
", + "smithy.api#httpHeader": "x-amz-copy-source-if-unmodified-since" + } + }, + "Expires": { + "target": "com.amazonaws.s3#Expires", + "traits": { + "smithy.api#documentation": "

The date and time at which the object is no longer cacheable.

", + "smithy.api#httpHeader": "Expires" + } + }, + "GrantFullControl": { + "target": "com.amazonaws.s3#GrantFullControl", + "traits": { + "smithy.api#documentation": "

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

\n \n
    \n
  • \n

    This functionality is not supported for directory buckets.

    \n
    • \n
  • \n

    This functionality is not supported for Amazon S3 on Outposts.

    \n
    • \n
\n ", + "smithy.api#httpHeader": "x-amz-grant-full-control" + } + }, + "GrantRead": { + "target": "com.amazonaws.s3#GrantRead", + "traits": { + "smithy.api#documentation": "

Allows grantee to read the object data and its metadata.

\n \n
    \n
  • \n

    This functionality is not supported for directory buckets.

    \n
    • \n
  • \n

    This functionality is not supported for Amazon S3 on Outposts.

    \n
    • \n
\n ", + "smithy.api#httpHeader": "x-amz-grant-read" + } + }, + "GrantReadACP": { + "target": "com.amazonaws.s3#GrantReadACP", + "traits": { + "smithy.api#documentation": "

Allows grantee to read the object ACL.

\n \n
    \n
  • \n

    This functionality is not supported for directory buckets.

    \n
    • \n
  • \n

    This functionality is not supported for Amazon S3 on Outposts.

    \n
    • \n
\n ", + "smithy.api#httpHeader": "x-amz-grant-read-acp" + } + }, + "GrantWriteACP": { + "target": "com.amazonaws.s3#GrantWriteACP", + "traits": { + "smithy.api#documentation": "

Allows grantee to write the ACL for the applicable object.

\n \n
    \n
  • \n

    This functionality is not supported for directory buckets.

    \n
    • \n
  • \n

    This functionality is not supported for Amazon S3 on Outposts.

    \n
    • \n
\n ", + "smithy.api#httpHeader": "x-amz-grant-write-acp" + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

The key of the destination object.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Key" + } + } + }, + "Metadata": { + "target": "com.amazonaws.s3#Metadata", + "traits": { + "smithy.api#documentation": "

A map of metadata to store with the object in S3.

", + "smithy.api#httpPrefixHeaders": "x-amz-meta-" + } + }, + "MetadataDirective": { + "target": "com.amazonaws.s3#MetadataDirective", + "traits": { + "smithy.api#documentation": "

Specifies whether the metadata is copied from the source object or replaced with\n metadata that's provided in the request. When copying an object, you can preserve all\n metadata (the default) or specify new metadata. If this header isn’t specified,\n COPY is the default behavior.

\n

\n General purpose bucket - For general purpose buckets, when you\n grant permissions, you can use the s3:x-amz-metadata-directive condition key\n to enforce certain metadata behavior when objects are uploaded. For more information, see\n Amazon S3\n condition key examples in the Amazon S3 User Guide.

\n \n

\n x-amz-website-redirect-location is unique to each object and is not\n copied when using the x-amz-metadata-directive header. To copy the value,\n you must specify x-amz-website-redirect-location in the request\n header.

\n ", + "smithy.api#httpHeader": "x-amz-metadata-directive" + } + }, + "TaggingDirective": { + "target": "com.amazonaws.s3#TaggingDirective", + "traits": { + "smithy.api#documentation": "

Specifies whether the object tag-set is copied from the source object or replaced with\n the tag-set that's provided in the request.

\n

The default value is COPY.

\n \n

\n Directory buckets - For directory buckets in a CopyObject operation, only the empty tag-set is supported. Any requests that attempt to write non-empty tags into directory buckets will receive a 501 Not Implemented status code. \nWhen the destination bucket is a directory bucket, you will receive a 501 Not Implemented response in any of the following situations:

\n
    \n
  • \n

    When you attempt to COPY the tag-set from an S3 source object that has non-empty tags.

    \n
    • \n
  • \n

    When you attempt to REPLACE the tag-set of a source object and set a non-empty value to x-amz-tagging.

    \n
    • \n
  • \n

    When you don't set the x-amz-tagging-directive header and the source object has non-empty tags. This is because the default value of x-amz-tagging-directive is COPY.

    \n
    • \n
\n

Because only the empty tag-set is supported for directory buckets in a CopyObject operation, the following situations are allowed:

\n
    \n
  • \n

    When you attempt to COPY the tag-set from a directory bucket source object that has no tags to a general purpose bucket. It copies an empty tag-set to the destination object.

    \n
    • \n
  • \n

    When you attempt to REPLACE the tag-set of a directory bucket source object and set the x-amz-tagging value of the directory bucket destination object to empty.

    \n
    • \n
  • \n

    When you attempt to REPLACE the tag-set of a general purpose bucket source object that has non-empty tags and set the x-amz-tagging value of the directory bucket destination object to empty.

    \n
    • \n
  • \n

    When you attempt to REPLACE the tag-set of a directory bucket source object and don't set the x-amz-tagging value of the directory bucket destination object. This is because the default value of x-amz-tagging is the empty value.

    \n
    • \n
\n ", + "smithy.api#httpHeader": "x-amz-tagging-directive" + } + }, + "ServerSideEncryption": { + "target": "com.amazonaws.s3#ServerSideEncryption", + "traits": { + "smithy.api#documentation": "

The server-side encryption algorithm used when storing this object in Amazon S3. Unrecognized\n or unsupported values won’t write a destination object and will receive a 400 Bad\n Request response.

\n

Amazon S3 automatically encrypts all new objects that are copied to an S3 bucket. When\n copying an object, if you don't specify encryption information in your copy request, the\n encryption setting of the target object is set to the default encryption configuration of\n the destination bucket. By default, all buckets have a base level of encryption\n configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). If the\n destination bucket has a different default encryption configuration, Amazon S3 uses the\n corresponding encryption key to encrypt the target object copy.

\n

With server-side encryption, Amazon S3 encrypts your data as it writes your data to disks in\n its data centers and decrypts the data when you access it. For more information about\n server-side encryption, see Using Server-Side Encryption\n in the Amazon S3 User Guide.

\n

\n General purpose buckets \n

\n
    \n
  • \n

    For general purpose buckets, there are the following supported options for server-side\n encryption: server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer\n server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), and server-side encryption\n with customer-provided encryption keys (SSE-C). Amazon S3 uses the corresponding\n KMS key, or a customer-provided key to encrypt the target object copy.

    \n
    • \n
  • \n

    When you perform a CopyObject operation, if you want to use a\n different type of encryption setting for the target object, you can specify\n appropriate encryption-related headers to encrypt the target object with an Amazon S3\n managed key, a KMS key, or a customer-provided key. If the encryption setting in\n your request is different from the default encryption configuration of the\n destination bucket, the encryption setting in your request takes precedence.

    \n
    • \n
\n

\n Directory buckets \n

\n
    \n
  • \n

    For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (aws:kms). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your \n CreateSession requests or PUT object requests. Then, new objects \n are automatically encrypted with the desired encryption settings. For more\n information, see Protecting data with server-side encryption in the Amazon S3 User Guide. For more information about the encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.

    \n
    • \n
  • \n

    To encrypt new object copies to a directory bucket with SSE-KMS, we recommend you\n specify SSE-KMS as the directory bucket's default encryption configuration with\n a KMS key (specifically, a customer managed key).\n The Amazon Web Services managed key (aws/s3) isn't supported. Your SSE-KMS\n configuration can only support 1 customer managed key per\n directory bucket for the lifetime of the bucket. After you specify a customer managed key for\n SSE-KMS, you can't override the customer managed key for the bucket's SSE-KMS\n configuration. Then, when you perform a CopyObject operation and want to\n specify server-side encryption settings for new object copies with SSE-KMS in the\n encryption-related request headers, you must ensure the encryption key is the same\n customer managed key that you specified for the directory bucket's default encryption\n configuration.\n

    \n
    • \n
", + "smithy.api#httpHeader": "x-amz-server-side-encryption" + } + }, + "StorageClass": { + "target": "com.amazonaws.s3#StorageClass", + "traits": { + "smithy.api#documentation": "

If the x-amz-storage-class header is not used, the copied object will be\n stored in the STANDARD Storage Class by default. The STANDARD\n storage class provides high durability and high availability. Depending on performance\n needs, you can specify a different Storage Class.

\n \n
    \n
  • \n

    \n Directory buckets -\n For directory buckets, only the S3 Express One Zone storage class is supported to store newly created objects. \nUnsupported storage class values won't write a destination object and will respond with the HTTP status code 400 Bad Request.

    \n
    • \n
  • \n

    \n Amazon S3 on Outposts - S3 on Outposts only\n uses the OUTPOSTS Storage Class.

    \n
    • \n
\n \n

You can use the CopyObject action to change the storage class of an object\n that is already stored in Amazon S3 by using the x-amz-storage-class header. For\n more information, see Storage Classes in the\n Amazon S3 User Guide.

\n

Before using an object as a source object for the copy operation, you must restore a\n copy of it if it meets any of the following conditions:

\n
    \n
  • \n

    The storage class of the source object is GLACIER or\n DEEP_ARCHIVE.

    \n
    • \n
  • \n

    The storage class of the source object is INTELLIGENT_TIERING and\n it's S3 Intelligent-Tiering access tier is Archive Access or\n Deep Archive Access.

    \n
    • \n
\n

For more information, see RestoreObject and Copying\n Objects in the Amazon S3 User Guide.

", + "smithy.api#httpHeader": "x-amz-storage-class" + } + }, + "WebsiteRedirectLocation": { + "target": "com.amazonaws.s3#WebsiteRedirectLocation", + "traits": { + "smithy.api#documentation": "

If the destination bucket is configured as a website, redirects requests for this object\n copy to another object in the same bucket or to an external URL. Amazon S3 stores the value of\n this header in the object metadata. This value is unique to each object and is not copied\n when using the x-amz-metadata-directive header. Instead, you may opt to\n provide this header in combination with the x-amz-metadata-directive\n header.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-website-redirect-location" + } + }, + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "traits": { + "smithy.api#documentation": "

Specifies the algorithm to use when encrypting the object (for example,\n AES256).

\n

When you perform a CopyObject operation, if you want to use a different\n type of encryption setting for the target object, you can specify appropriate\n encryption-related headers to encrypt the target object with an Amazon S3 managed key, a\n KMS key, or a customer-provided key. If the encryption setting in your request is\n different from the default encryption configuration of the destination bucket, the\n encryption setting in your request takes precedence.

\n \n

This functionality is not supported when the destination bucket is a directory bucket.

\n ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + } + }, + "SSECustomerKey": { + "target": "com.amazonaws.s3#SSECustomerKey", + "traits": { + "smithy.api#documentation": "

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This\n value is used to store the object and then it is discarded. Amazon S3 does not store the\n encryption key. The key must be appropriate for use with the algorithm specified in the\n x-amz-server-side-encryption-customer-algorithm header.

\n \n

This functionality is not supported when the destination bucket is a directory bucket.

\n ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key" + } + }, + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "traits": { + "smithy.api#documentation": "

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n this header for a message integrity check to ensure that the encryption key was transmitted\n without error.

\n \n

This functionality is not supported when the destination bucket is a directory bucket.

\n ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" + } + }, + "SSEKMSKeyId": { + "target": "com.amazonaws.s3#SSEKMSKeyId", + "traits": { + "smithy.api#documentation": "

Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption.\n All GET and PUT requests for an object protected by KMS will fail if they're not made via\n SSL or using SigV4. For information about configuring any of the officially supported Amazon Web Services\n SDKs and Amazon Web Services CLI, see Specifying the\n Signature Version in Request Authentication in the\n Amazon S3 User Guide.

\n

\n Directory buckets -\n If you specify x-amz-server-side-encryption with aws:kms, the \n x-amz-server-side-encryption-aws-kms-key-id header is implicitly assigned the ID of the KMS \n symmetric encryption customer managed key that's configured for your directory bucket's default encryption setting. \n If you want to specify the \n x-amz-server-side-encryption-aws-kms-key-id header explicitly, you can only specify it with the ID (Key ID or Key ARN) of the KMS \n customer managed key that's configured for your directory bucket's default encryption setting. Otherwise, you get an HTTP 400 Bad Request error. Only use the key ID or key ARN. The key alias format of the KMS key isn't supported. Your SSE-KMS configuration can only support 1 customer managed key per directory bucket for the lifetime of the bucket. \nThe Amazon Web Services managed key (aws/s3) isn't supported. \n

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" + } + }, + "SSEKMSEncryptionContext": { + "target": "com.amazonaws.s3#SSEKMSEncryptionContext", + "traits": { + "smithy.api#documentation": "

Specifies the Amazon Web Services KMS Encryption Context as an additional encryption context to use\n for the destination object encryption. The value of this header is a base64-encoded UTF-8\n string holding JSON with the encryption context key-value pairs.

\n

\n General purpose buckets - This value must be explicitly\n added to specify encryption context for CopyObject requests if you want an\n additional encryption context for your destination object. The additional encryption\n context of the source object won't be copied to the destination object. For more\n information, see Encryption\n context in the Amazon S3 User Guide.

\n

\n Directory buckets - You can optionally provide an explicit encryption context value. The value must match the default encryption context - the bucket Amazon Resource Name (ARN). An additional encryption context value is not supported.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-context" + } + }, + "BucketKeyEnabled": { + "target": "com.amazonaws.s3#BucketKeyEnabled", + "traits": { + "smithy.api#documentation": "

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with\n server-side encryption using Key Management Service (KMS) keys (SSE-KMS). If a target object uses\n SSE-KMS, you can enable an S3 Bucket Key for the object.

\n

Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object\n encryption with SSE-KMS. Specifying this header with a COPY action doesn’t affect\n bucket-level settings for S3 Bucket Key.

\n

For more information, see Amazon S3 Bucket Keys in the\n Amazon S3 User Guide.

\n \n

\n Directory buckets -\n S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets \nto directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through CopyObject. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.

\n ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" + } + }, + "CopySourceSSECustomerAlgorithm": { + "target": "com.amazonaws.s3#CopySourceSSECustomerAlgorithm", + "traits": { + "smithy.api#documentation": "

Specifies the algorithm to use when decrypting the source object (for example,\n AES256).

\n

If the source object for the copy is stored in Amazon S3 using SSE-C, you must provide the\n necessary encryption information in your request so that Amazon S3 can decrypt the object for\n copying.

\n \n

This functionality is not supported when the source object is in a directory bucket.

\n ", + "smithy.api#httpHeader": "x-amz-copy-source-server-side-encryption-customer-algorithm" + } + }, + "CopySourceSSECustomerKey": { + "target": "com.amazonaws.s3#CopySourceSSECustomerKey", + "traits": { + "smithy.api#documentation": "

Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source\n object. The encryption key provided in this header must be the same one that was used when\n the source object was created.

\n

If the source object for the copy is stored in Amazon S3 using SSE-C, you must provide the\n necessary encryption information in your request so that Amazon S3 can decrypt the object for\n copying.

\n \n

This functionality is not supported when the source object is in a directory bucket.

\n ", + "smithy.api#httpHeader": "x-amz-copy-source-server-side-encryption-customer-key" + } + }, + "CopySourceSSECustomerKeyMD5": { + "target": "com.amazonaws.s3#CopySourceSSECustomerKeyMD5", + "traits": { + "smithy.api#documentation": "

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n this header for a message integrity check to ensure that the encryption key was transmitted\n without error.

\n

If the source object for the copy is stored in Amazon S3 using SSE-C, you must provide the\n necessary encryption information in your request so that Amazon S3 can decrypt the object for\n copying.

\n \n

This functionality is not supported when the source object is in a directory bucket.

\n ", + "smithy.api#httpHeader": "x-amz-copy-source-server-side-encryption-customer-key-MD5" + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "Tagging": { + "target": "com.amazonaws.s3#TaggingHeader", + "traits": { + "smithy.api#documentation": "

The tag-set for the object copy in the destination bucket. This value must be used in\n conjunction with the x-amz-tagging-directive if you choose\n REPLACE for the x-amz-tagging-directive. If you choose\n COPY for the x-amz-tagging-directive, you don't need to set\n the x-amz-tagging header, because the tag-set will be copied from the source\n object directly. The tag-set must be encoded as URL Query parameters.

\n

The default value is the empty value.

\n \n

\n Directory buckets - For directory buckets in a CopyObject operation, only the empty tag-set is supported. Any requests that attempt to write non-empty tags into directory buckets will receive a 501 Not Implemented status code. \nWhen the destination bucket is a directory bucket, you will receive a 501 Not Implemented response in any of the following situations:

\n
    \n
  • \n

    When you attempt to COPY the tag-set from an S3 source object that has non-empty tags.

    \n
    • \n
  • \n

    When you attempt to REPLACE the tag-set of a source object and set a non-empty value to x-amz-tagging.

    \n
    • \n
  • \n

    When you don't set the x-amz-tagging-directive header and the source object has non-empty tags. This is because the default value of x-amz-tagging-directive is COPY.

    \n
    • \n
\n

Because only the empty tag-set is supported for directory buckets in a CopyObject operation, the following situations are allowed:

\n
    \n
  • \n

    When you attempt to COPY the tag-set from a directory bucket source object that has no tags to a general purpose bucket. It copies an empty tag-set to the destination object.

    \n
    • \n
  • \n

    When you attempt to REPLACE the tag-set of a directory bucket source object and set the x-amz-tagging value of the directory bucket destination object to empty.

    \n
    • \n
  • \n

    When you attempt to REPLACE the tag-set of a general purpose bucket source object that has non-empty tags and set the x-amz-tagging value of the directory bucket destination object to empty.

    \n
    • \n
  • \n

    When you attempt to REPLACE the tag-set of a directory bucket source object and don't set the x-amz-tagging value of the directory bucket destination object. This is because the default value of x-amz-tagging is the empty value.

    \n
    • \n
\n ", + "smithy.api#httpHeader": "x-amz-tagging" + } + }, + "ObjectLockMode": { + "target": "com.amazonaws.s3#ObjectLockMode", + "traits": { + "smithy.api#documentation": "

The Object Lock mode that you want to apply to the object copy.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-object-lock-mode" + } + }, + "ObjectLockRetainUntilDate": { + "target": "com.amazonaws.s3#ObjectLockRetainUntilDate", + "traits": { + "smithy.api#documentation": "

The date and time when you want the Object Lock of the object copy to expire.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-object-lock-retain-until-date" + } + }, + "ObjectLockLegalHoldStatus": { + "target": "com.amazonaws.s3#ObjectLockLegalHoldStatus", + "traits": { + "smithy.api#documentation": "

Specifies whether you want to apply a legal hold to the object copy.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-object-lock-legal-hold" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected destination bucket owner. If the account ID that you provide does not match the actual owner of the destination bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + }, + "ExpectedSourceBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected source bucket owner. If the account ID that you provide does not match the actual owner of the source bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-source-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#CopyObjectResult": { + "type": "structure", + "members": { + "ETag": { + "target": "com.amazonaws.s3#ETag", + "traits": { + "smithy.api#documentation": "

Returns the ETag of the new object. The ETag reflects only changes to the contents of an\n object, not its metadata.

" + } + }, + "LastModified": { + "target": "com.amazonaws.s3#LastModified", + "traits": { + "smithy.api#documentation": "

Creation date of the object.

" + } + }, + "ChecksumCRC32": { + "target": "com.amazonaws.s3#ChecksumCRC32", + "traits": { + "smithy.api#documentation": "

The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded\n with the object. For more information, see \n Checking object integrity in the Amazon S3 User Guide.

" + } + }, + "ChecksumCRC32C": { + "target": "com.amazonaws.s3#ChecksumCRC32C", + "traits": { + "smithy.api#documentation": "

The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded\n with the object. For more information, see \n Checking object integrity in the Amazon S3 User Guide.

" + } + }, + "ChecksumSHA1": { + "target": "com.amazonaws.s3#ChecksumSHA1", + "traits": { + "smithy.api#documentation": "

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded\n with the object. For more information, see \n Checking object integrity in the Amazon S3 User Guide.

" + } + }, + "ChecksumSHA256": { + "target": "com.amazonaws.s3#ChecksumSHA256", + "traits": { + "smithy.api#documentation": "

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded\n with the object. For more information, see \n Checking object integrity in the Amazon S3 User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Container for all response elements.

" + } + }, + "com.amazonaws.s3#CopyPartResult": { + "type": "structure", + "members": { + "ETag": { + "target": "com.amazonaws.s3#ETag", + "traits": { + "smithy.api#documentation": "

Entity tag of the object.

" + } + }, + "LastModified": { + "target": "com.amazonaws.s3#LastModified", + "traits": { + "smithy.api#documentation": "

Date and time at which the object was uploaded.

" + } + }, + "ChecksumCRC32": { + "target": "com.amazonaws.s3#ChecksumCRC32", + "traits": { + "smithy.api#documentation": "

The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

" + } + }, + "ChecksumCRC32C": { + "target": "com.amazonaws.s3#ChecksumCRC32C", + "traits": { + "smithy.api#documentation": "

The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

" + } + }, + "ChecksumSHA1": { + "target": "com.amazonaws.s3#ChecksumSHA1", + "traits": { + "smithy.api#documentation": "

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded\n with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

" + } + }, + "ChecksumSHA256": { + "target": "com.amazonaws.s3#ChecksumSHA256", + "traits": { + "smithy.api#documentation": "

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Container for all response elements.

" + } + }, + "com.amazonaws.s3#CopySource": { + "type": "string", + "traits": { + "smithy.api#pattern": "^\\/?.+\\/.+$" + } + }, + "com.amazonaws.s3#CopySourceIfMatch": { + "type": "string" + }, + "com.amazonaws.s3#CopySourceIfModifiedSince": { + "type": "timestamp" + }, + "com.amazonaws.s3#CopySourceIfNoneMatch": { + "type": "string" + }, + "com.amazonaws.s3#CopySourceIfUnmodifiedSince": { + "type": "timestamp" + }, + "com.amazonaws.s3#CopySourceRange": { + "type": "string" + }, + "com.amazonaws.s3#CopySourceSSECustomerAlgorithm": { + "type": "string" + }, + "com.amazonaws.s3#CopySourceSSECustomerKey": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.s3#CopySourceSSECustomerKeyMD5": { + "type": "string" + }, + "com.amazonaws.s3#CopySourceVersionId": { + "type": "string" + }, + "com.amazonaws.s3#CreateBucket": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#CreateBucketRequest" + }, + "output": { + "target": "com.amazonaws.s3#CreateBucketOutput" + }, + "errors": [ + { + "target": "com.amazonaws.s3#BucketAlreadyExists" + }, + { + "target": "com.amazonaws.s3#BucketAlreadyOwnedByYou" + } + ], + "traits": { + "smithy.api#documentation": "\n

This action creates an Amazon S3 bucket. To create an Amazon S3 on Outposts bucket, see \n CreateBucket\n .

\n \n

Creates a new S3 bucket. To create a bucket, you must set up Amazon S3 and have a valid Amazon Web Services\n Access Key ID to authenticate requests. Anonymous requests are never allowed to create\n buckets. By creating the bucket, you become the bucket owner.

\n

There are two types of buckets: general purpose buckets and directory buckets. For more\n information about these bucket types, see Creating, configuring, and\n working with Amazon S3 buckets in the Amazon S3 User Guide.

\n \n
    \n
  • \n

    \n General purpose buckets - If you send your\n CreateBucket request to the s3.amazonaws.com global\n endpoint, the request goes to the us-east-1 Region. So the signature\n calculations in Signature Version 4 must use us-east-1 as the Region,\n even if the location constraint in the request specifies another Region where the\n bucket is to be created. If you create a bucket in a Region other than US East (N.\n Virginia), your application must be able to handle 307 redirect. For more\n information, see Virtual hosting of\n buckets in the Amazon S3 User Guide.

    \n
    • \n
  • \n

    \n Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name\n . Virtual-hosted-style requests aren't supported. \nFor more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the\n Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the\n Amazon S3 User Guide.

    \n
    • \n
\n \n
\n
Permissions
\n
\n
    \n
  • \n

    \n General purpose bucket permissions - In\n addition to the s3:CreateBucket permission, the following\n permissions are required in a policy when your CreateBucket\n request includes specific headers:

    \n
      \n
    • \n

      \n Access control lists (ACLs)\n - In your CreateBucket request, if you specify an\n access control list (ACL) and set it to public-read,\n public-read-write, authenticated-read, or\n if you explicitly specify any other custom ACLs, both\n s3:CreateBucket and s3:PutBucketAcl\n permissions are required. In your CreateBucket request,\n if you set the ACL to private, or if you don't specify\n any ACLs, only the s3:CreateBucket permission is\n required.

      \n
      • \n
    • \n

      \n Object Lock - In your\n CreateBucket request, if you set\n x-amz-bucket-object-lock-enabled to true, the\n s3:PutBucketObjectLockConfiguration and\n s3:PutBucketVersioning permissions are\n required.

      \n
      • \n
    • \n

      \n S3 Object Ownership - If\n your CreateBucket request includes the\n x-amz-object-ownership header, then the\n s3:PutBucketOwnershipControls permission is\n required.

      \n \n

      To set an ACL on a bucket as part of a\n CreateBucket request, you must explicitly set S3\n Object Ownership for the bucket to a different value than the\n default, BucketOwnerEnforced. Additionally, if your\n desired bucket ACL grants public access, you must first create the\n bucket (without the bucket ACL) and then explicitly disable Block\n Public Access on the bucket before using PutBucketAcl\n to set the ACL. If you try to create a bucket with a public ACL,\n the request will fail.

      \n

      For the majority of modern use cases in S3, we recommend that\n you keep all Block Public Access settings enabled and keep ACLs\n disabled. If you would like to share data with users outside of\n your account, you can use bucket policies as needed. For more\n information, see Controlling ownership of objects and disabling ACLs for your\n bucket and Blocking public access to your Amazon S3 storage in\n the Amazon S3 User Guide.

      \n       \n
      • \n
    • \n

      \n S3 Block Public Access - If\n your specific use case requires granting public access to your S3\n resources, you can disable Block Public Access. Specifically, you can\n create a new bucket with Block Public Access enabled, then separately\n call the \n DeletePublicAccessBlock\n API. To use this operation, you must have the\n s3:PutBucketPublicAccessBlock permission. For more\n information about S3 Block Public Access, see Blocking public access to your Amazon S3 storage in the\n Amazon S3 User Guide.

      \n
      • \n
    \n
    • \n
  • \n

    \n Directory bucket permissions -\n You must have the s3express:CreateBucket permission in\n an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource.\n For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

    \n \n

    The permissions for ACLs, Object Lock, S3 Object Ownership, and S3\n Block Public Access are not supported for directory buckets. For\n directory buckets, all Block Public Access settings are enabled at the\n bucket level and S3 Object Ownership is set to Bucket owner enforced\n (ACLs disabled). These settings can't be modified.

    \n

    For more information about permissions for creating and working with\n directory buckets, see Directory buckets in the\n Amazon S3 User Guide. For more information about\n supported S3 features for directory buckets, see Features of S3 Express One Zone in the\n Amazon S3 User Guide.

    \n     \n
    • \n
\n
\n
HTTP Host header syntax
\n
\n

\n Directory buckets - The HTTP Host header syntax is s3express-control.region-code.amazonaws.com.

\n
\n
\n

The following operations are related to CreateBucket:

\n ", + "smithy.api#examples": [ + { + "title": "To create a bucket in a specific region", + "documentation": "The following example creates a bucket. The request specifies an AWS region where to create the bucket.", + "input": { + "Bucket": "examplebucket", + "CreateBucketConfiguration": { + "LocationConstraint": "eu-west-1" + } + }, + "output": { + "Location": "http://examplebucket..s3.amazonaws.com/" + } + }, + { + "title": "To create a bucket ", + "documentation": "The following example creates a bucket.", + "input": { + "Bucket": "examplebucket" + }, + "output": { + "Location": "/examplebucket" + } + } + ], + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + }, + "DisableAccessPoints": { + "value": true + } + } + } + }, + "com.amazonaws.s3#CreateBucketConfiguration": { + "type": "structure", + "members": { + "LocationConstraint": { + "target": "com.amazonaws.s3#BucketLocationConstraint", + "traits": { + "smithy.api#documentation": "

Specifies the Region where the bucket will be created. You might choose a Region to\n optimize latency, minimize costs, or address regulatory requirements. For example, if you\n reside in Europe, you will probably find it advantageous to create buckets in the Europe\n (Ireland) Region.

\n

If you don't specify a Region, the bucket is created in the US East (N. Virginia) Region\n (us-east-1) by default.

\n

For a list of the valid values for all of the Amazon Web Services Regions, see Regions and\n Endpoints.

\n \n

This functionality is not supported for directory buckets.

\n " + } + }, + "Location": { + "target": "com.amazonaws.s3#LocationInfo", + "traits": { + "smithy.api#documentation": "

Specifies the location where the bucket will be created.

\n

\n Directory buckets - The location type is Availability Zone or Local Zone. \n To use the Local Zone location type, your account must be enabled for Dedicated Local Zones. Otherwise, you get an HTTP 403 Forbidden error with the \n error code AccessDenied. To learn more, see Enable accounts for Dedicated Local Zones in the Amazon S3 User Guide.\n

\n \n

This functionality is only supported by directory buckets.

\n " + } + }, + "Bucket": { + "target": "com.amazonaws.s3#BucketInfo", + "traits": { + "smithy.api#documentation": "

Specifies the information about the bucket that will be created.

\n \n

This functionality is only supported by directory buckets.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration information for the bucket.

" + } + }, + "com.amazonaws.s3#CreateBucketMetadataTableConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#CreateBucketMetadataTableConfigurationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "aws.protocols#httpChecksum": { + "requestAlgorithmMember": "ChecksumAlgorithm", + "requestChecksumRequired": true + }, + "smithy.api#documentation": "

Creates a metadata table configuration for a general purpose bucket. For more\n information, see Accelerating data\n discovery with S3 Metadata in the Amazon S3 User Guide.

\n
\n
Permissions
\n
\n

To use this operation, you must have the following permissions. For more\n information, see Setting up\n permissions for configuring metadata tables in the\n Amazon S3 User Guide.

\n

If you also want to integrate your table bucket with Amazon Web Services analytics services so that you \n can query your metadata table, you need additional permissions. For more information, see \n \n Integrating Amazon S3 Tables with Amazon Web Services analytics services in the \n Amazon S3 User Guide.

\n
    \n
  • \n

    \n s3:CreateBucketMetadataTableConfiguration\n

    \n
    • \n
  • \n

    \n s3tables:CreateNamespace\n

    \n
    • \n
  • \n

    \n s3tables:GetTable\n

    \n
    • \n
  • \n

    \n s3tables:CreateTable\n

    \n
    • \n
  • \n

    \n s3tables:PutTablePolicy\n

    \n
    • \n
\n
\n
\n

The following operations are related to CreateBucketMetadataTableConfiguration:

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/{Bucket}?metadataTable", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#CreateBucketMetadataTableConfigurationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

\n The general purpose bucket that you want to create the metadata table configuration in.\n

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ContentMD5": { + "target": "com.amazonaws.s3#ContentMD5", + "traits": { + "smithy.api#documentation": "

\n The Content-MD5 header for the metadata table configuration.\n

", + "smithy.api#httpHeader": "Content-MD5" + } + }, + "ChecksumAlgorithm": { + "target": "com.amazonaws.s3#ChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "

\n The checksum algorithm to use with your metadata table configuration. \n

", + "smithy.api#httpHeader": "x-amz-sdk-checksum-algorithm" + } + }, + "MetadataTableConfiguration": { + "target": "com.amazonaws.s3#MetadataTableConfiguration", + "traits": { + "smithy.api#documentation": "

\n The contents of your metadata table configuration. \n

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {}, + "smithy.api#xmlName": "MetadataTableConfiguration" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

\n The expected owner of the general purpose bucket that contains your metadata table configuration.\n

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#CreateBucketOutput": { + "type": "structure", + "members": { + "Location": { + "target": "com.amazonaws.s3#Location", + "traits": { + "smithy.api#documentation": "

A forward slash followed by the name of the bucket.

", + "smithy.api#httpHeader": "Location" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3#CreateBucketRequest": { + "type": "structure", + "members": { + "ACL": { + "target": "com.amazonaws.s3#BucketCannedACL", + "traits": { + "smithy.api#documentation": "

The canned ACL to apply to the bucket.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-acl" + } + }, + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket to create.

\n

\n General purpose buckets - For information about bucket naming\n restrictions, see Bucket naming\n rules in the Amazon S3 User Guide.

\n

\n Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name\n . Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide\n

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "CreateBucketConfiguration": { + "target": "com.amazonaws.s3#CreateBucketConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration information for the bucket.

", + "smithy.api#httpPayload": {}, + "smithy.api#xmlName": "CreateBucketConfiguration" + } + }, + "GrantFullControl": { + "target": "com.amazonaws.s3#GrantFullControl", + "traits": { + "smithy.api#documentation": "

Allows grantee the read, write, read ACP, and write ACP permissions on the\n bucket.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-grant-full-control" + } + }, + "GrantRead": { + "target": "com.amazonaws.s3#GrantRead", + "traits": { + "smithy.api#documentation": "

Allows grantee to list the objects in the bucket.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-grant-read" + } + }, + "GrantReadACP": { + "target": "com.amazonaws.s3#GrantReadACP", + "traits": { + "smithy.api#documentation": "

Allows grantee to read the bucket ACL.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-grant-read-acp" + } + }, + "GrantWrite": { + "target": "com.amazonaws.s3#GrantWrite", + "traits": { + "smithy.api#documentation": "

Allows grantee to create new objects in the bucket.

\n

For the bucket and object owners of existing objects, also allows deletions and\n overwrites of those objects.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-grant-write" + } + }, + "GrantWriteACP": { + "target": "com.amazonaws.s3#GrantWriteACP", + "traits": { + "smithy.api#documentation": "

Allows grantee to write the ACL for the applicable bucket.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-grant-write-acp" + } + }, + "ObjectLockEnabledForBucket": { + "target": "com.amazonaws.s3#ObjectLockEnabledForBucket", + "traits": { + "smithy.api#documentation": "

Specifies whether you want S3 Object Lock to be enabled for the new bucket.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-bucket-object-lock-enabled" + } + }, + "ObjectOwnership": { + "target": "com.amazonaws.s3#ObjectOwnership", + "traits": { + "smithy.api#httpHeader": "x-amz-object-ownership" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#CreateMultipartUpload": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#CreateMultipartUploadRequest" + }, + "output": { + "target": "com.amazonaws.s3#CreateMultipartUploadOutput" + }, + "traits": { + "smithy.api#documentation": "

This action initiates a multipart upload and returns an upload ID. This upload ID is\n used to associate all of the parts in the specific multipart upload. You specify this\n upload ID in each of your subsequent upload part requests (see UploadPart). You also include this\n upload ID in the final request to either complete or abort the multipart upload request.\n For more information about multipart uploads, see Multipart Upload Overview in the\n Amazon S3 User Guide.

\n \n

After you initiate a multipart upload and upload one or more parts, to stop being\n charged for storing the uploaded parts, you must either complete or abort the multipart\n upload. Amazon S3 frees up the space used to store the parts and stops charging you for\n storing them only after you either complete or abort a multipart upload.

\n \n

If you have configured a lifecycle rule to abort incomplete multipart uploads, the\n created multipart upload must be completed within the number of days specified in the\n bucket lifecycle configuration. Otherwise, the incomplete multipart upload becomes eligible\n for an abort action and Amazon S3 aborts the multipart upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle\n Configuration.

\n \n
    \n
  • \n

    \n Directory buckets -\n S3 Lifecycle is not supported by directory buckets.

    \n
    • \n
  • \n

    \n Directory buckets -\n For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket-name.s3express-zone-id.region-code.amazonaws.com/key-name\n . Path-style requests are not supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the\n Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the\n Amazon S3 User Guide.

    \n
    • \n
\n \n
\n
Request signing
\n
\n

For request signing, multipart upload is just a series of regular requests. You\n initiate a multipart upload, send one or more requests to upload parts, and then\n complete the multipart upload process. You sign each request individually. There\n is nothing special about signing multipart upload requests. For more information\n about signing, see Authenticating\n Requests (Amazon Web Services Signature Version 4) in the\n Amazon S3 User Guide.

\n
\n
Permissions
\n
\n
    \n
  • \n

    \n General purpose bucket permissions - To\n perform a multipart upload with encryption using an Key Management Service (KMS)\n KMS key, the requester must have permission to the\n kms:Decrypt and kms:GenerateDataKey actions on\n the key. The requester must also have permissions for the\n kms:GenerateDataKey action for the\n CreateMultipartUpload API. Then, the requester needs\n permissions for the kms:Decrypt action on the\n UploadPart and UploadPartCopy APIs. These\n permissions are required because Amazon S3 must decrypt and read data from the\n encrypted file parts before it completes the multipart upload. For more\n information, see Multipart upload API and permissions and Protecting data\n using server-side encryption with Amazon Web Services KMS in the\n Amazon S3 User Guide.

    \n
    • \n
  • \n

    \n Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the \n CreateSession\n API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. \nAmazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see \n CreateSession\n .

    \n
    • \n
\n
\n
Encryption
\n
\n
    \n
  • \n

    \n General purpose buckets - Server-side\n encryption is for data encryption at rest. Amazon S3 encrypts your data as it\n writes it to disks in its data centers and decrypts it when you access it.\n Amazon S3 automatically encrypts all new objects that are uploaded to an S3\n bucket. When doing a multipart upload, if you don't specify encryption\n information in your request, the encryption setting of the uploaded parts is\n set to the default encryption configuration of the destination bucket. By\n default, all buckets have a base level of encryption configuration that uses\n server-side encryption with Amazon S3 managed keys (SSE-S3). If the destination\n bucket has a default encryption configuration that uses server-side\n encryption with an Key Management Service (KMS) key (SSE-KMS), or a customer-provided\n encryption key (SSE-C), Amazon S3 uses the corresponding KMS key, or a\n customer-provided key to encrypt the uploaded parts. When you perform a\n CreateMultipartUpload operation, if you want to use a different type of\n encryption setting for the uploaded parts, you can request that Amazon S3\n encrypts the object with a different encryption key (such as an Amazon S3 managed\n key, a KMS key, or a customer-provided key). When the encryption setting\n in your request is different from the default encryption configuration of\n the destination bucket, the encryption setting in your request takes\n precedence. If you choose to provide your own encryption key, the request\n headers you provide in UploadPart and\n UploadPartCopy\n requests must match the headers you used in the\n CreateMultipartUpload request.

    \n
      \n
    • \n

      Use KMS keys (SSE-KMS) that include the Amazon Web Services managed key\n (aws/s3) and KMS customer managed keys stored in Key Management Service\n (KMS) – If you want Amazon Web Services to manage the keys used to encrypt data,\n specify the following headers in the request.

      \n
        \n
      • \n

        \n x-amz-server-side-encryption\n

        \n
        • \n
      • \n

        \n x-amz-server-side-encryption-aws-kms-key-id\n

        \n
        • \n
      • \n

        \n x-amz-server-side-encryption-context\n

        \n
        • \n
      \n \n
        \n
      • \n

        If you specify\n x-amz-server-side-encryption:aws:kms, but\n don't provide\n x-amz-server-side-encryption-aws-kms-key-id,\n Amazon S3 uses the Amazon Web Services managed key (aws/s3 key) in\n KMS to protect the data.

        \n
        • \n
      • \n

        To perform a multipart upload with encryption by using an\n Amazon Web Services KMS key, the requester must have permission to the\n kms:Decrypt and\n kms:GenerateDataKey* actions on the key.\n These permissions are required because Amazon S3 must decrypt and\n read data from the encrypted file parts before it completes\n the multipart upload. For more information, see Multipart upload API and permissions and Protecting data using server-side encryption with Amazon Web Services\n KMS in the\n Amazon S3 User Guide.

        \n
        • \n
      • \n

        If your Identity and Access Management (IAM) user or role is in the same\n Amazon Web Services account as the KMS key, then you must have these\n permissions on the key policy. If your IAM user or role is\n in a different account from the key, then you must have the\n permissions on both the key policy and your IAM user or\n role.

        \n
        • \n
      • \n

        All GET and PUT requests for an\n object protected by KMS fail if you don't make them by\n using Secure Sockets Layer (SSL), Transport Layer Security\n (TLS), or Signature Version 4. For information about\n configuring any of the officially supported Amazon Web Services SDKs and\n Amazon Web Services CLI, see Specifying the Signature Version in\n Request Authentication in the\n Amazon S3 User Guide.

        \n
        • \n
      \n       \n

      For more information about server-side encryption with KMS keys\n (SSE-KMS), see Protecting\n Data Using Server-Side Encryption with KMS keys in the\n Amazon S3 User Guide.

      \n
      • \n
    • \n

      Use customer-provided encryption keys (SSE-C) – If you want to\n manage your own encryption keys, provide all the following headers in\n the request.

      \n
        \n
      • \n

        \n x-amz-server-side-encryption-customer-algorithm\n

        \n
        • \n
      • \n

        \n x-amz-server-side-encryption-customer-key\n

        \n
        • \n
      • \n

        \n x-amz-server-side-encryption-customer-key-MD5\n

        \n
        • \n
      \n

      For more information about server-side encryption with\n customer-provided encryption keys (SSE-C), see Protecting data using server-side encryption with\n customer-provided encryption keys (SSE-C) in the\n Amazon S3 User Guide.

      \n
      • \n
    \n
    • \n
  • \n

    \n Directory buckets -\n For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (aws:kms). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your \n CreateSession requests or PUT object requests. Then, new objects \n are automatically encrypted with the desired encryption settings. For more\n information, see Protecting data with server-side encryption in the Amazon S3 User Guide. For more information about the encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.

    \n

    In the Zonal endpoint API calls (except CopyObject and UploadPartCopy) using the REST API, the encryption request headers must match the encryption settings that are specified in the CreateSession request. \n You can't override the values of the encryption settings (x-amz-server-side-encryption, x-amz-server-side-encryption-aws-kms-key-id, x-amz-server-side-encryption-context, and x-amz-server-side-encryption-bucket-key-enabled) that are specified in the CreateSession request. \n You don't need to explicitly specify these encryption settings values in Zonal endpoint API calls, and \n Amazon S3 will use the encryption settings values from the CreateSession request to protect new objects in the directory bucket. \n

    \n \n

    When you use the CLI or the Amazon Web Services SDKs, for CreateSession, the session token refreshes automatically to avoid service interruptions when a session expires. The CLI or the Amazon Web Services SDKs use the bucket's default encryption configuration for the \n CreateSession request. It's not supported to override the encryption settings values in the CreateSession request. \n So in the Zonal endpoint API calls (except CopyObject and UploadPartCopy), \n the encryption request headers must match the default encryption configuration of the directory bucket.\n\n

    \n     \n \n

    For directory buckets, when you perform a\n CreateMultipartUpload operation and an\n UploadPartCopy operation, the request headers you provide\n in the CreateMultipartUpload request must match the default\n encryption configuration of the destination bucket.

    \n     \n
    • \n
\n
\n
HTTP Host header syntax
\n
\n

\n Directory buckets - The HTTP Host header syntax is \n Bucket-name.s3express-zone-id.region-code.amazonaws.com.

\n
\n
\n

The following operations are related to CreateMultipartUpload:

\n ", + "smithy.api#examples": [ + { + "title": "To initiate a multipart upload", + "documentation": "The following example initiates a multipart upload.", + "input": { + "Bucket": "examplebucket", + "Key": "largeobject" + }, + "output": { + "Bucket": "examplebucket", + "UploadId": "ibZBv_75gd9r8lH_gqXatLdxMVpAlj6ZQjEs.OwyF3953YdwbcQnMA2BLGn8Lx12fQNICtMw5KyteFeHw.Sjng--", + "Key": "largeobject" + } + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/{Bucket}/{Key+}?uploads", + "code": 200 + } + } + }, + "com.amazonaws.s3#CreateMultipartUploadOutput": { + "type": "structure", + "members": { + "AbortDate": { + "target": "com.amazonaws.s3#AbortDate", + "traits": { + "smithy.api#documentation": "

If the bucket has a lifecycle rule configured with an action to abort incomplete\n multipart uploads and the prefix in the lifecycle rule matches the object name in the\n request, the response includes this header. The header indicates when the initiated\n multipart upload becomes eligible for an abort operation. For more information, see \n Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration in\n the Amazon S3 User Guide.

\n

The response also includes the x-amz-abort-rule-id header that provides the\n ID of the lifecycle configuration rule that defines the abort action.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-abort-date" + } + }, + "AbortRuleId": { + "target": "com.amazonaws.s3#AbortRuleId", + "traits": { + "smithy.api#documentation": "

This header is returned along with the x-amz-abort-date header. It\n identifies the applicable lifecycle configuration rule that defines the action to abort\n incomplete multipart uploads.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-abort-rule-id" + } + }, + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket to which the multipart upload was initiated. Does not return the\n access point ARN or access point alias if used.

\n \n

Access points are not supported by directory buckets.

\n ", + "smithy.api#xmlName": "Bucket" + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

Object key for which the multipart upload was initiated.

" + } + }, + "UploadId": { + "target": "com.amazonaws.s3#MultipartUploadId", + "traits": { + "smithy.api#documentation": "

ID for the initiated multipart upload.

" + } + }, + "ServerSideEncryption": { + "target": "com.amazonaws.s3#ServerSideEncryption", + "traits": { + "smithy.api#documentation": "

The server-side encryption algorithm used when you store this object in Amazon S3 (for\n example, AES256, aws:kms).

", + "smithy.api#httpHeader": "x-amz-server-side-encryption" + } + }, + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "traits": { + "smithy.api#documentation": "

If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to confirm the encryption algorithm that's used.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + } + }, + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "traits": { + "smithy.api#documentation": "

If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to provide the round-trip message integrity verification\n of the customer-provided encryption key.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" + } + }, + "SSEKMSKeyId": { + "target": "com.amazonaws.s3#SSEKMSKeyId", + "traits": { + "smithy.api#documentation": "

If present, indicates the ID of the KMS key that was used for object encryption.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" + } + }, + "SSEKMSEncryptionContext": { + "target": "com.amazonaws.s3#SSEKMSEncryptionContext", + "traits": { + "smithy.api#documentation": "

If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption. The value of\n this header is a Base64-encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-context" + } + }, + "BucketKeyEnabled": { + "target": "com.amazonaws.s3#BucketKeyEnabled", + "traits": { + "smithy.api#documentation": "

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption\n with Key Management Service (KMS) keys (SSE-KMS).

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" + } + }, + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" + } + }, + "ChecksumAlgorithm": { + "target": "com.amazonaws.s3#ChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "

The algorithm that was used to create a checksum of the object.

", + "smithy.api#httpHeader": "x-amz-checksum-algorithm" + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#xmlName": "InitiateMultipartUploadResult" + } + }, + "com.amazonaws.s3#CreateMultipartUploadRequest": { + "type": "structure", + "members": { + "ACL": { + "target": "com.amazonaws.s3#ObjectCannedACL", + "traits": { + "smithy.api#documentation": "

The canned ACL to apply to the object. Amazon S3 supports a set of predefined ACLs, known as\n canned ACLs. Each canned ACL has a predefined set of grantees and\n permissions. For more information, see Canned ACL in the\n Amazon S3 User Guide.

\n

By default, all objects are private. Only the owner has full access control. When\n uploading an object, you can grant access permissions to individual Amazon Web Services accounts or to\n predefined groups defined by Amazon S3. These permissions are then added to the access control\n list (ACL) on the new object. For more information, see Using ACLs. One way to grant\n the permissions using the request headers is to specify a canned ACL with the\n x-amz-acl request header.

\n \n
    \n
  • \n

    This functionality is not supported for directory buckets.

    \n
    • \n
  • \n

    This functionality is not supported for Amazon S3 on Outposts.

    \n
    • \n
\n ", + "smithy.api#httpHeader": "x-amz-acl" + } + }, + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket where the multipart upload is initiated and where the object is\n uploaded.

\n

\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n \n

Access points and Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "CacheControl": { + "target": "com.amazonaws.s3#CacheControl", + "traits": { + "smithy.api#documentation": "

Specifies caching behavior along the request/reply chain.

", + "smithy.api#httpHeader": "Cache-Control" + } + }, + "ContentDisposition": { + "target": "com.amazonaws.s3#ContentDisposition", + "traits": { + "smithy.api#documentation": "

Specifies presentational information for the object.

", + "smithy.api#httpHeader": "Content-Disposition" + } + }, + "ContentEncoding": { + "target": "com.amazonaws.s3#ContentEncoding", + "traits": { + "smithy.api#documentation": "

Specifies what content encodings have been applied to the object and thus what decoding\n mechanisms must be applied to obtain the media-type referenced by the Content-Type header\n field.

\n \n

For directory buckets, only the aws-chunked value is supported in this header field.

\n ", + "smithy.api#httpHeader": "Content-Encoding" + } + }, + "ContentLanguage": { + "target": "com.amazonaws.s3#ContentLanguage", + "traits": { + "smithy.api#documentation": "

The language that the content is in.

", + "smithy.api#httpHeader": "Content-Language" + } + }, + "ContentType": { + "target": "com.amazonaws.s3#ContentType", + "traits": { + "smithy.api#documentation": "

A standard MIME type describing the format of the object data.

", + "smithy.api#httpHeader": "Content-Type" + } + }, + "Expires": { + "target": "com.amazonaws.s3#Expires", + "traits": { + "smithy.api#documentation": "

The date and time at which the object is no longer cacheable.

", + "smithy.api#httpHeader": "Expires" + } + }, + "GrantFullControl": { + "target": "com.amazonaws.s3#GrantFullControl", + "traits": { + "smithy.api#documentation": "

Specify access permissions explicitly to give the grantee READ, READ_ACP, and WRITE_ACP\n permissions on the object.

\n

By default, all objects are private. Only the owner has full access control. When\n uploading an object, you can use this header to explicitly grant access permissions to\n specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3\n supports in an ACL. For more information, see Access Control List (ACL) Overview\n in the Amazon S3 User Guide.

\n

You specify each grantee as a type=value pair, where the type is one of the\n following:

\n
    \n
  • \n

    \n id – if the value specified is the canonical user ID of an\n Amazon Web Services account

    \n
    • \n
  • \n

    \n uri – if you are granting permissions to a predefined group

    \n
    • \n
  • \n

    \n emailAddress – if the value specified is the email address of an\n Amazon Web Services account

    \n \n

    Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

    \n
      \n
    • \n

      US East (N. Virginia)

      \n
      • \n
    • \n

      US West (N. California)

      \n
      • \n
    • \n

      US West (Oregon)

      \n
      • \n
    • \n

      Asia Pacific (Singapore)

      \n
      • \n
    • \n

      Asia Pacific (Sydney)

      \n
      • \n
    • \n

      Asia Pacific (Tokyo)

      \n
      • \n
    • \n

      Europe (Ireland)

      \n
      • \n
    • \n

      South America (São Paulo)

      \n
      • \n
    \n

    For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

    \n     \n
    • \n
\n

For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:

\n

\n x-amz-grant-read: id=\"11112222333\", id=\"444455556666\" \n

\n \n
    \n
  • \n

    This functionality is not supported for directory buckets.

    \n
    • \n
  • \n

    This functionality is not supported for Amazon S3 on Outposts.

    \n
    • \n
\n ", + "smithy.api#httpHeader": "x-amz-grant-full-control" + } + }, + "GrantRead": { + "target": "com.amazonaws.s3#GrantRead", + "traits": { + "smithy.api#documentation": "

Specify access permissions explicitly to allow grantee to read the object data and its\n metadata.

\n

By default, all objects are private. Only the owner has full access control. When\n uploading an object, you can use this header to explicitly grant access permissions to\n specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3\n supports in an ACL. For more information, see Access Control List (ACL) Overview\n in the Amazon S3 User Guide.

\n

You specify each grantee as a type=value pair, where the type is one of the\n following:

\n
    \n
  • \n

    \n id – if the value specified is the canonical user ID of an\n Amazon Web Services account

    \n
    • \n
  • \n

    \n uri – if you are granting permissions to a predefined group

    \n
    • \n
  • \n

    \n emailAddress – if the value specified is the email address of an\n Amazon Web Services account

    \n \n

    Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

    \n
      \n
    • \n

      US East (N. Virginia)

      \n
      • \n
    • \n

      US West (N. California)

      \n
      • \n
    • \n

      US West (Oregon)

      \n
      • \n
    • \n

      Asia Pacific (Singapore)

      \n
      • \n
    • \n

      Asia Pacific (Sydney)

      \n
      • \n
    • \n

      Asia Pacific (Tokyo)

      \n
      • \n
    • \n

      Europe (Ireland)

      \n
      • \n
    • \n

      South America (São Paulo)

      \n
      • \n
    \n

    For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

    \n     \n
    • \n
\n

For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:

\n

\n x-amz-grant-read: id=\"11112222333\", id=\"444455556666\" \n

\n \n
    \n
  • \n

    This functionality is not supported for directory buckets.

    \n
    • \n
  • \n

    This functionality is not supported for Amazon S3 on Outposts.

    \n
    • \n
\n ", + "smithy.api#httpHeader": "x-amz-grant-read" + } + }, + "GrantReadACP": { + "target": "com.amazonaws.s3#GrantReadACP", + "traits": { + "smithy.api#documentation": "

Specify access permissions explicitly to allows grantee to read the object ACL.

\n

By default, all objects are private. Only the owner has full access control. When\n uploading an object, you can use this header to explicitly grant access permissions to\n specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3\n supports in an ACL. For more information, see Access Control List (ACL) Overview\n in the Amazon S3 User Guide.

\n

You specify each grantee as a type=value pair, where the type is one of the\n following:

\n
    \n
  • \n

    \n id – if the value specified is the canonical user ID of an\n Amazon Web Services account

    \n
    • \n
  • \n

    \n uri – if you are granting permissions to a predefined group

    \n
    • \n
  • \n

    \n emailAddress – if the value specified is the email address of an\n Amazon Web Services account

    \n \n

    Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

    \n
      \n
    • \n

      US East (N. Virginia)

      \n
      • \n
    • \n

      US West (N. California)

      \n
      • \n
    • \n

      US West (Oregon)

      \n
      • \n
    • \n

      Asia Pacific (Singapore)

      \n
      • \n
    • \n

      Asia Pacific (Sydney)

      \n
      • \n
    • \n

      Asia Pacific (Tokyo)

      \n
      • \n
    • \n

      Europe (Ireland)

      \n
      • \n
    • \n

      South America (São Paulo)

      \n
      • \n
    \n

    For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

    \n     \n
    • \n
\n

For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:

\n

\n x-amz-grant-read: id=\"11112222333\", id=\"444455556666\" \n

\n \n
    \n
  • \n

    This functionality is not supported for directory buckets.

    \n
    • \n
  • \n

    This functionality is not supported for Amazon S3 on Outposts.

    \n
    • \n
\n ", + "smithy.api#httpHeader": "x-amz-grant-read-acp" + } + }, + "GrantWriteACP": { + "target": "com.amazonaws.s3#GrantWriteACP", + "traits": { + "smithy.api#documentation": "

Specify access permissions explicitly to allows grantee to allow grantee to write the\n ACL for the applicable object.

\n

By default, all objects are private. Only the owner has full access control. When\n uploading an object, you can use this header to explicitly grant access permissions to\n specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3\n supports in an ACL. For more information, see Access Control List (ACL) Overview\n in the Amazon S3 User Guide.

\n

You specify each grantee as a type=value pair, where the type is one of the\n following:

\n
    \n
  • \n

    \n id – if the value specified is the canonical user ID of an\n Amazon Web Services account

    \n
    • \n
  • \n

    \n uri – if you are granting permissions to a predefined group

    \n
    • \n
  • \n

    \n emailAddress – if the value specified is the email address of an\n Amazon Web Services account

    \n \n

    Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

    \n
      \n
    • \n

      US East (N. Virginia)

      \n
      • \n
    • \n

      US West (N. California)

      \n
      • \n
    • \n

      US West (Oregon)

      \n
      • \n
    • \n

      Asia Pacific (Singapore)

      \n
      • \n
    • \n

      Asia Pacific (Sydney)

      \n
      • \n
    • \n

      Asia Pacific (Tokyo)

      \n
      • \n
    • \n

      Europe (Ireland)

      \n
      • \n
    • \n

      South America (São Paulo)

      \n
      • \n
    \n

    For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

    \n     \n
    • \n
\n

For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:

\n

\n x-amz-grant-read: id=\"11112222333\", id=\"444455556666\" \n

\n \n
    \n
  • \n

    This functionality is not supported for directory buckets.

    \n
    • \n
  • \n

    This functionality is not supported for Amazon S3 on Outposts.

    \n
    • \n
\n ", + "smithy.api#httpHeader": "x-amz-grant-write-acp" + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

Object key for which the multipart upload is to be initiated.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Key" + } + } + }, + "Metadata": { + "target": "com.amazonaws.s3#Metadata", + "traits": { + "smithy.api#documentation": "

A map of metadata to store with the object in S3.

", + "smithy.api#httpPrefixHeaders": "x-amz-meta-" + } + }, + "ServerSideEncryption": { + "target": "com.amazonaws.s3#ServerSideEncryption", + "traits": { + "smithy.api#documentation": "

The server-side encryption algorithm used when you store this object in Amazon S3 (for\n example, AES256, aws:kms).

\n
    \n
  • \n

    \n Directory buckets -\n For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (aws:kms). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your \n CreateSession requests or PUT object requests. Then, new objects \n are automatically encrypted with the desired encryption settings. For more\n information, see Protecting data with server-side encryption in the Amazon S3 User Guide. For more information about the encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.

    \n

    In the Zonal endpoint API calls (except CopyObject and UploadPartCopy) using the REST API, the encryption request headers must match the encryption settings that are specified in the CreateSession request. \n You can't override the values of the encryption settings (x-amz-server-side-encryption, x-amz-server-side-encryption-aws-kms-key-id, x-amz-server-side-encryption-context, and x-amz-server-side-encryption-bucket-key-enabled) that are specified in the CreateSession request. \n You don't need to explicitly specify these encryption settings values in Zonal endpoint API calls, and \n Amazon S3 will use the encryption settings values from the CreateSession request to protect new objects in the directory bucket. \n

    \n \n

    When you use the CLI or the Amazon Web Services SDKs, for CreateSession, the session token refreshes automatically to avoid service interruptions when a session expires. The CLI or the Amazon Web Services SDKs use the bucket's default encryption configuration for the \n CreateSession request. It's not supported to override the encryption settings values in the CreateSession request. \n So in the Zonal endpoint API calls (except CopyObject and UploadPartCopy), \n the encryption request headers must match the default encryption configuration of the directory bucket.\n\n

    \n     \n
    • \n
", + "smithy.api#httpHeader": "x-amz-server-side-encryption" + } + }, + "StorageClass": { + "target": "com.amazonaws.s3#StorageClass", + "traits": { + "smithy.api#documentation": "

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The\n STANDARD storage class provides high durability and high availability. Depending on\n performance needs, you can specify a different Storage Class. For more information, see\n Storage\n Classes in the Amazon S3 User Guide.

\n \n
    \n
  • \n

    For directory buckets, only the S3 Express One Zone storage class is supported to store\n newly created objects.

    \n
    • \n
  • \n

    Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.

    \n
    • \n
\n ", + "smithy.api#httpHeader": "x-amz-storage-class" + } + }, + "WebsiteRedirectLocation": { + "target": "com.amazonaws.s3#WebsiteRedirectLocation", + "traits": { + "smithy.api#documentation": "

If the bucket is configured as a website, redirects requests for this object to another\n object in the same bucket or to an external URL. Amazon S3 stores the value of this header in\n the object metadata.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-website-redirect-location" + } + }, + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "traits": { + "smithy.api#documentation": "

Specifies the algorithm to use when encrypting the object (for example, AES256).

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + } + }, + "SSECustomerKey": { + "target": "com.amazonaws.s3#SSECustomerKey", + "traits": { + "smithy.api#documentation": "

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This\n value is used to store the object and then it is discarded; Amazon S3 does not store the\n encryption key. The key must be appropriate for use with the algorithm specified in the\n x-amz-server-side-encryption-customer-algorithm header.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key" + } + }, + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "traits": { + "smithy.api#documentation": "

Specifies the 128-bit MD5 digest of the customer-provided encryption key according to\n RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption\n key was transmitted without error.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" + } + }, + "SSEKMSKeyId": { + "target": "com.amazonaws.s3#SSEKMSKeyId", + "traits": { + "smithy.api#documentation": "

Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption. If the KMS key doesn't exist in the same\n account that's issuing the command, you must use the full Key ARN not the Key ID.

\n

\n General purpose buckets - If you specify x-amz-server-side-encryption with aws:kms or aws:kms:dsse, this header specifies the ID (Key ID, Key ARN, or Key Alias) of the KMS \n key to use. If you specify\n x-amz-server-side-encryption:aws:kms or\n x-amz-server-side-encryption:aws:kms:dsse, but do not provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed key\n (aws/s3) to protect the data.

\n

\n Directory buckets - If you specify x-amz-server-side-encryption with aws:kms, the \n x-amz-server-side-encryption-aws-kms-key-id header is implicitly assigned the ID of the KMS \n symmetric encryption customer managed key that's configured for your directory bucket's default encryption setting. \n If you want to specify the \n x-amz-server-side-encryption-aws-kms-key-id header explicitly, you can only specify it with the ID (Key ID or Key ARN) of the KMS \n customer managed key that's configured for your directory bucket's default encryption setting. Otherwise, you get an HTTP 400 Bad Request error. Only use the key ID or key ARN. The key alias format of the KMS key isn't supported. Your SSE-KMS configuration can only support 1 customer managed key per directory bucket for the lifetime of the bucket. \nThe Amazon Web Services managed key (aws/s3) isn't supported. \n

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" + } + }, + "SSEKMSEncryptionContext": { + "target": "com.amazonaws.s3#SSEKMSEncryptionContext", + "traits": { + "smithy.api#documentation": "

Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of\n this header is a Base64-encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs.

\n

\n Directory buckets - You can optionally provide an explicit encryption context value. The value must match the default encryption context - the bucket Amazon Resource Name (ARN). An additional encryption context value is not supported.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-context" + } + }, + "BucketKeyEnabled": { + "target": "com.amazonaws.s3#BucketKeyEnabled", + "traits": { + "smithy.api#documentation": "

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with\n server-side encryption using Key Management Service (KMS) keys (SSE-KMS).

\n

\n General purpose buckets - Setting this header to\n true causes Amazon S3 to use an S3 Bucket Key for object encryption with\n SSE-KMS. Also, specifying this header with a PUT action doesn't affect bucket-level settings for S3\n Bucket Key.

\n

\n Directory buckets - S3 Bucket Keys are always enabled for GET and PUT operations in a directory bucket and can’t be disabled. S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets \nto directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through CopyObject, UploadPartCopy, the Copy operation in Batch Operations, or \n the import jobs. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "Tagging": { + "target": "com.amazonaws.s3#TaggingHeader", + "traits": { + "smithy.api#documentation": "

The tag-set for the object. The tag-set must be encoded as URL Query parameters.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-tagging" + } + }, + "ObjectLockMode": { + "target": "com.amazonaws.s3#ObjectLockMode", + "traits": { + "smithy.api#documentation": "

Specifies the Object Lock mode that you want to apply to the uploaded object.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-object-lock-mode" + } + }, + "ObjectLockRetainUntilDate": { + "target": "com.amazonaws.s3#ObjectLockRetainUntilDate", + "traits": { + "smithy.api#documentation": "

Specifies the date and time when you want the Object Lock to expire.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-object-lock-retain-until-date" + } + }, + "ObjectLockLegalHoldStatus": { + "target": "com.amazonaws.s3#ObjectLockLegalHoldStatus", + "traits": { + "smithy.api#documentation": "

Specifies whether you want to apply a legal hold to the uploaded object.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-object-lock-legal-hold" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + }, + "ChecksumAlgorithm": { + "target": "com.amazonaws.s3#ChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "

Indicates the algorithm that you want Amazon S3 to use to create the checksum for the object. For more information, see\n Checking object integrity in\n the Amazon S3 User Guide.

", + "smithy.api#httpHeader": "x-amz-checksum-algorithm" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#CreateSession": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#CreateSessionRequest" + }, + "output": { + "target": "com.amazonaws.s3#CreateSessionOutput" + }, + "errors": [ + { + "target": "com.amazonaws.s3#NoSuchBucket" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a session that establishes temporary security credentials to support fast\n authentication and authorization for the Zonal endpoint API operations on directory buckets. For more\n information about Zonal endpoint API operations that include the Availability Zone in the request endpoint, see S3 Express One Zone\n APIs in the Amazon S3 User Guide.

\n

To make Zonal endpoint API requests on a directory bucket, use the CreateSession\n API operation. Specifically, you grant s3express:CreateSession permission to a\n bucket in a bucket policy or an IAM identity-based policy. Then, you use IAM credentials to make the\n CreateSession API request on the bucket, which returns temporary security\n credentials that include the access key ID, secret access key, session token, and\n expiration. These credentials have associated permissions to access the Zonal endpoint API operations. After\n the session is created, you don’t need to use other policies to grant permissions to each\n Zonal endpoint API individually. Instead, in your Zonal endpoint API requests, you sign your requests by\n applying the temporary security credentials of the session to the request headers and\n following the SigV4 protocol for authentication. You also apply the session token to the\n x-amz-s3session-token request header for authorization. Temporary security\n credentials are scoped to the bucket and expire after 5 minutes. After the expiration time,\n any calls that you make with those credentials will fail. You must use IAM credentials\n again to make a CreateSession API request that generates a new set of\n temporary credentials for use. Temporary credentials cannot be extended or refreshed beyond\n the original specified interval.

\n

If you use Amazon Web Services SDKs, SDKs handle the session token refreshes automatically to avoid\n service interruptions when a session expires. We recommend that you use the Amazon Web Services SDKs to\n initiate and manage requests to the CreateSession API. For more information, see Performance guidelines and design patterns in the\n Amazon S3 User Guide.

\n \n
    \n
  • \n

    You must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the\n Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the\n Amazon S3 User Guide.

    \n
    • \n
  • \n

    \n \n CopyObject API operation -\n Unlike other Zonal endpoint API operations, the CopyObject API operation doesn't use\n the temporary security credentials returned from the CreateSession\n API operation for authentication and authorization. For information about\n authentication and authorization of the CopyObject API operation on\n directory buckets, see CopyObject.

    \n
    • \n
  • \n

    \n \n HeadBucket API operation -\n Unlike other Zonal endpoint API operations, the HeadBucket API operation doesn't use\n the temporary security credentials returned from the CreateSession\n API operation for authentication and authorization. For information about\n authentication and authorization of the HeadBucket API operation on\n directory buckets, see HeadBucket.

    \n
    • \n
\n \n
\n
Permissions
\n
\n

To obtain temporary security credentials, you must create\n a bucket policy or an IAM identity-based policy that grants s3express:CreateSession\n permission to the bucket. In a policy, you can have the\n s3express:SessionMode condition key to control who can create a\n ReadWrite or ReadOnly session. For more information\n about ReadWrite or ReadOnly sessions, see \n x-amz-create-session-mode\n . For example policies, see\n Example bucket policies for S3 Express One Zone and Amazon Web Services Identity and Access Management (IAM) identity-based policies for\n S3 Express One Zone in the Amazon S3 User Guide.

\n

To grant cross-account access to Zonal endpoint API operations, the bucket policy should also\n grant both accounts the s3express:CreateSession permission.

\n

If you want to encrypt objects with SSE-KMS, you must also have the\n kms:GenerateDataKey and the kms:Decrypt permissions\n in IAM identity-based policies and KMS key policies for the target KMS\n key.

\n
\n
Encryption
\n
\n

For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (aws:kms). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your \n CreateSession requests or PUT object requests. Then, new objects \n are automatically encrypted with the desired encryption settings. For more\n information, see Protecting data with server-side encryption in the Amazon S3 User Guide. For more information about the encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.

\n

For Zonal endpoint (object-level) API operations except CopyObject and UploadPartCopy, \nyou authenticate and authorize requests through CreateSession for low latency. \n To encrypt new objects in a directory bucket with SSE-KMS, you must specify SSE-KMS as the directory bucket's default encryption configuration with a KMS key (specifically, a customer managed key). Then, when a session is created for Zonal endpoint API operations, new objects are automatically encrypted and decrypted with SSE-KMS and S3 Bucket Keys during the session.

\n \n

\n Only 1 customer managed key is supported per directory bucket for the lifetime of the bucket. The Amazon Web Services managed key (aws/s3) isn't supported. \n After you specify SSE-KMS as your bucket's default encryption configuration with a customer managed key, you can't change the customer managed key for the bucket's SSE-KMS configuration.\n

\n \n

In the Zonal endpoint API calls (except CopyObject and UploadPartCopy) using the REST API, \n you can't override the values of the encryption settings (x-amz-server-side-encryption, x-amz-server-side-encryption-aws-kms-key-id, x-amz-server-side-encryption-context, and x-amz-server-side-encryption-bucket-key-enabled) from the CreateSession request. \n You don't need to explicitly specify these encryption settings values in Zonal endpoint API calls, and \n Amazon S3 will use the encryption settings values from the CreateSession request to protect new objects in the directory bucket. \n

\n \n

When you use the CLI or the Amazon Web Services SDKs, for CreateSession, the session token refreshes automatically to avoid service interruptions when a session expires. The CLI or the Amazon Web Services SDKs use the bucket's default encryption configuration for the \n CreateSession request. It's not supported to override the encryption settings values in the CreateSession request. \n Also, in the Zonal endpoint API calls (except CopyObject and UploadPartCopy), \n it's not supported to override the values of the encryption settings from the CreateSession request. \n\n

\n \n
\n
HTTP Host header syntax
\n
\n

\n Directory buckets - The HTTP Host header syntax is \n Bucket-name.s3express-zone-id.region-code.amazonaws.com.

\n
\n
", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?session", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "DisableS3ExpressSessionAuth": { + "value": true + } + } + } + }, + "com.amazonaws.s3#CreateSessionOutput": { + "type": "structure", + "members": { + "ServerSideEncryption": { + "target": "com.amazonaws.s3#ServerSideEncryption", + "traits": { + "smithy.api#documentation": "

The server-side encryption algorithm used when you store objects in the directory bucket.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption" + } + }, + "SSEKMSKeyId": { + "target": "com.amazonaws.s3#SSEKMSKeyId", + "traits": { + "smithy.api#documentation": "

If you specify x-amz-server-side-encryption with aws:kms, this header indicates the ID of the KMS \n symmetric encryption customer managed key that was used for object encryption.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" + } + }, + "SSEKMSEncryptionContext": { + "target": "com.amazonaws.s3#SSEKMSEncryptionContext", + "traits": { + "smithy.api#documentation": "

If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption. The value of\n this header is a Base64-encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs. \n This value is stored as object metadata and automatically gets\n passed on to Amazon Web Services KMS for future GetObject \n operations on this object.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-context" + } + }, + "BucketKeyEnabled": { + "target": "com.amazonaws.s3#BucketKeyEnabled", + "traits": { + "smithy.api#documentation": "

Indicates whether to use an S3 Bucket Key for server-side encryption\n with KMS keys (SSE-KMS).

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" + } + }, + "Credentials": { + "target": "com.amazonaws.s3#SessionCredentials", + "traits": { + "smithy.api#documentation": "

The established temporary security credentials for the created session.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "Credentials" + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#xmlName": "CreateSessionResult" + } + }, + "com.amazonaws.s3#CreateSessionRequest": { + "type": "structure", + "members": { + "SessionMode": { + "target": "com.amazonaws.s3#SessionMode", + "traits": { + "smithy.api#documentation": "

Specifies the mode of the session that will be created, either ReadWrite or\n ReadOnly. By default, a ReadWrite session is created. A\n ReadWrite session is capable of executing all the Zonal endpoint API operations on a\n directory bucket. A ReadOnly session is constrained to execute the following\n Zonal endpoint API operations: GetObject, HeadObject, ListObjectsV2,\n GetObjectAttributes, ListParts, and\n ListMultipartUploads.

", + "smithy.api#httpHeader": "x-amz-create-session-mode" + } + }, + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket that you create a session for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ServerSideEncryption": { + "target": "com.amazonaws.s3#ServerSideEncryption", + "traits": { + "smithy.api#documentation": "

The server-side encryption algorithm to use when you store objects in the directory bucket.

\n

For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (aws:kms). By default, Amazon S3 encrypts data with SSE-S3. \n For more\n information, see Protecting data with server-side encryption in the Amazon S3 User Guide.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption" + } + }, + "SSEKMSKeyId": { + "target": "com.amazonaws.s3#SSEKMSKeyId", + "traits": { + "smithy.api#documentation": "

If you specify x-amz-server-side-encryption with aws:kms, you must specify the \n x-amz-server-side-encryption-aws-kms-key-id header with the ID (Key ID or Key ARN) of the KMS \n symmetric encryption customer managed key to use. Otherwise, you get an HTTP 400 Bad Request error. Only use the key ID or key ARN. The key alias format of the KMS key isn't supported. Also, if the KMS key doesn't exist in the same\n account that't issuing the command, you must use the full Key ARN not the Key ID.

\n

Your SSE-KMS configuration can only support 1 customer managed key per directory bucket for the lifetime of the bucket. \nThe Amazon Web Services managed key (aws/s3) isn't supported. \n

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" + } + }, + "SSEKMSEncryptionContext": { + "target": "com.amazonaws.s3#SSEKMSEncryptionContext", + "traits": { + "smithy.api#documentation": "

Specifies the Amazon Web Services KMS Encryption Context as an additional encryption context to use for object encryption. The value of\n this header is a Base64-encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs. \n This value is stored as object metadata and automatically gets passed on\n to Amazon Web Services KMS for future GetObject operations on\n this object.

\n

\n General purpose buckets - This value must be explicitly added during CopyObject operations if you want an additional encryption context for your object. For more information, see Encryption context in the Amazon S3 User Guide.

\n

\n Directory buckets - You can optionally provide an explicit encryption context value. The value must match the default encryption context - the bucket Amazon Resource Name (ARN). An additional encryption context value is not supported.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-context" + } + }, + "BucketKeyEnabled": { + "target": "com.amazonaws.s3#BucketKeyEnabled", + "traits": { + "smithy.api#documentation": "

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with\n server-side encryption using KMS keys (SSE-KMS).

\n

S3 Bucket Keys are always enabled for GET and PUT operations in a directory bucket and can’t be disabled. S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets \nto directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through CopyObject, UploadPartCopy, the Copy operation in Batch Operations, or \n the import jobs. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#CreationDate": { + "type": "timestamp" + }, + "com.amazonaws.s3#DataRedundancy": { + "type": "enum", + "members": { + "SingleAvailabilityZone": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SingleAvailabilityZone" + } + }, + "SingleLocalZone": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SingleLocalZone" + } + } + } + }, + "com.amazonaws.s3#Date": { + "type": "timestamp", + "traits": { + "smithy.api#timestampFormat": "date-time" + } + }, + "com.amazonaws.s3#Days": { + "type": "integer" + }, + "com.amazonaws.s3#DaysAfterInitiation": { + "type": "integer" + }, + "com.amazonaws.s3#DefaultRetention": { + "type": "structure", + "members": { + "Mode": { + "target": "com.amazonaws.s3#ObjectLockRetentionMode", + "traits": { + "smithy.api#documentation": "

The default Object Lock retention mode you want to apply to new objects placed in the\n specified bucket. Must be used with either Days or Years.

" + } + }, + "Days": { + "target": "com.amazonaws.s3#Days", + "traits": { + "smithy.api#documentation": "

The number of days that you want to specify for the default retention period. Must be\n used with Mode.

" + } + }, + "Years": { + "target": "com.amazonaws.s3#Years", + "traits": { + "smithy.api#documentation": "

The number of years that you want to specify for the default retention period. Must be\n used with Mode.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The container element for optionally specifying the default Object Lock retention\n settings for new objects placed in the specified bucket.

\n \n
    \n
  • \n

    The DefaultRetention settings require both a mode and a\n period.

    \n
    • \n
  • \n

    The DefaultRetention period can be either Days or\n Years but you must select one. You cannot specify\n Days and Years at the same time.

    \n
    • \n
\n " + } + }, + "com.amazonaws.s3#Delete": { + "type": "structure", + "members": { + "Objects": { + "target": "com.amazonaws.s3#ObjectIdentifierList", + "traits": { + "smithy.api#documentation": "

The object to delete.

\n \n

\n Directory buckets - For directory buckets,\n an object that's composed entirely of whitespace characters is not supported by the\n DeleteObjects API operation. The request will receive a 400 Bad\n Request error and none of the objects in the request will be deleted.

\n ", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Object" + } + }, + "Quiet": { + "target": "com.amazonaws.s3#Quiet", + "traits": { + "smithy.api#documentation": "

Element to enable quiet mode for the request. When you add this element, you must set\n its value to true.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Container for the objects to delete.

" + } + }, + "com.amazonaws.s3#DeleteBucket": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#DeleteBucketRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deletes the S3 bucket. All objects (including all object versions and delete markers) in\n the bucket must be deleted before the bucket itself can be deleted.

\n \n
    \n
  • \n

    \n Directory buckets - If multipart\n uploads in a directory bucket are in progress, you can't delete the bucket until\n all the in-progress multipart uploads are aborted or completed.

    \n
    • \n
  • \n

    \n Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name\n . Virtual-hosted-style requests aren't supported. \nFor more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the\n Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the\n Amazon S3 User Guide.

    \n
    • \n
\n \n
\n
Permissions
\n
\n
    \n
  • \n

    \n General purpose bucket permissions - You\n must have the s3:DeleteBucket permission on the specified\n bucket in a policy.

    \n
    • \n
  • \n

    \n Directory bucket permissions -\n You must have the s3express:DeleteBucket permission in\n an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource.\n For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

    \n
    • \n
\n
\n
HTTP Host header syntax
\n
\n

\n Directory buckets - The HTTP Host header syntax is s3express-control.region-code.amazonaws.com.

\n
\n
\n

The following operations are related to DeleteBucket:

\n ", + "smithy.api#examples": [ + { + "title": "To delete a bucket", + "documentation": "The following example deletes the specified bucket.", + "input": { + "Bucket": "forrandall2" + } + } + ], + "smithy.api#http": { + "method": "DELETE", + "uri": "/{Bucket}", + "code": 204 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#DeleteBucketAnalyticsConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#DeleteBucketAnalyticsConfigurationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Deletes an analytics configuration for the bucket (specified by the analytics\n configuration ID).

\n

To use this operation, you must have permissions to perform the\n s3:PutAnalyticsConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.

\n

For information about the Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class\n Analysis.

\n

The following operations are related to\n DeleteBucketAnalyticsConfiguration:

\n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/{Bucket}?analytics", + "code": 204 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#DeleteBucketAnalyticsConfigurationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket from which an analytics configuration is deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "Id": { + "target": "com.amazonaws.s3#AnalyticsId", + "traits": { + "smithy.api#documentation": "

The ID that identifies the analytics configuration.

", + "smithy.api#httpQuery": "id", + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#DeleteBucketCors": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#DeleteBucketCorsRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Deletes the cors configuration information set for the bucket.

\n

To use this operation, you must have permission to perform the\n s3:PutBucketCORS action. The bucket owner has this permission by default\n and can grant this permission to others.

\n

For information about cors, see Enabling Cross-Origin Resource Sharing in\n the Amazon S3 User Guide.

\n

\n Related Resources\n

\n ", + "smithy.api#examples": [ + { + "title": "To delete cors configuration on a bucket.", + "documentation": "The following example deletes CORS configuration on a bucket.", + "input": { + "Bucket": "examplebucket" + } + } + ], + "smithy.api#http": { + "method": "DELETE", + "uri": "/{Bucket}?cors", + "code": 204 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#DeleteBucketCorsRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

Specifies the bucket whose cors configuration is being deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#DeleteBucketEncryption": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#DeleteBucketEncryptionRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

This implementation of the DELETE action resets the default encryption for the bucket as\n server-side encryption with Amazon S3 managed keys (SSE-S3).

\n \n \n \n
\n
Permissions
\n
\n
    \n
  • \n

    \n General purpose bucket permissions - The\n s3:PutEncryptionConfiguration permission is required in a\n policy. The bucket owner has this permission by default. The bucket owner\n can grant this permission to others. For more information about permissions,\n see Permissions Related to Bucket Operations and Managing Access\n Permissions to Your Amazon S3 Resources.

    \n
    • \n
  • \n

    \n Directory bucket permissions -\n To grant access to this API operation, you must have the\n s3express:PutEncryptionConfiguration permission in\n an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource.\n For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

    \n
    • \n
\n
\n
HTTP Host header syntax
\n
\n

\n Directory buckets - The HTTP Host header syntax is s3express-control.region-code.amazonaws.com.

\n
\n
\n

The following operations are related to DeleteBucketEncryption:

\n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/{Bucket}?encryption", + "code": 204 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#DeleteBucketEncryptionRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket containing the server-side encryption configuration to\n delete.

\n

\n Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name\n . Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide\n

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

\n \n

For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code \n501 Not Implemented.

\n ", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#DeleteBucketIntelligentTieringConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#DeleteBucketIntelligentTieringConfigurationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Deletes the S3 Intelligent-Tiering configuration from the specified bucket.

\n

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.

\n

The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.

\n

For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

\n

Operations related to DeleteBucketIntelligentTieringConfiguration include:

\n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/{Bucket}?intelligent-tiering", + "code": 204 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#DeleteBucketIntelligentTieringConfigurationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "Id": { + "target": "com.amazonaws.s3#IntelligentTieringId", + "traits": { + "smithy.api#documentation": "

The ID used to identify the S3 Intelligent-Tiering configuration.

", + "smithy.api#httpQuery": "id", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#DeleteBucketInventoryConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#DeleteBucketInventoryConfigurationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Deletes an inventory configuration (identified by the inventory ID) from the\n bucket.

\n

To use this operation, you must have permissions to perform the\n s3:PutInventoryConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.

\n

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.

\n

Operations related to DeleteBucketInventoryConfiguration include:

\n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/{Bucket}?inventory", + "code": 204 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#DeleteBucketInventoryConfigurationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket containing the inventory configuration to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "Id": { + "target": "com.amazonaws.s3#InventoryId", + "traits": { + "smithy.api#documentation": "

The ID used to identify the inventory configuration.

", + "smithy.api#httpQuery": "id", + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#DeleteBucketLifecycle": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#DeleteBucketLifecycleRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all the\n lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your\n objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of\n rules contained in the deleted lifecycle configuration.

\n
\n
Permissions
\n
\n
    \n
  • \n

    \n General purpose bucket permissions - By\n default, all Amazon S3 resources are private, including buckets, objects, and\n related subresources (for example, lifecycle configuration and website\n configuration). Only the resource owner (that is, the Amazon Web Services account that\n created it) can access the resource. The resource owner can optionally grant\n access permissions to others by writing an access policy. For this\n operation, a user must have the s3:PutLifecycleConfiguration\n permission.

    \n

    For more information about permissions, see Managing Access\n Permissions to Your Amazon S3 Resources.

    \n
    • \n
\n
    \n
  • \n

    \n Directory bucket permissions -\n You must have the s3express:PutLifecycleConfiguration\n permission in an IAM identity-based policy to use this operation.\n Cross-account access to this API operation isn't supported. The resource\n owner can optionally grant access permissions to others by creating a role\n or user for them as long as they are within the same account as the owner\n and resource.

    \n

    For more information about directory bucket policies and permissions, see\n Authorizing Regional endpoint APIs with IAM in the\n Amazon S3 User Guide.

    \n \n

    \n Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name\n . Virtual-hosted-style requests aren't supported. \nFor more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the\n Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the\n Amazon S3 User Guide.

    \n     \n
    • \n
\n
\n
\n
\n
HTTP Host header syntax
\n
\n

\n Directory buckets - The HTTP Host\n header syntax is\n s3express-control.region.amazonaws.com.

\n
\n
\n

For more information about the object expiration, see Elements to Describe Lifecycle Actions.

\n

Related actions include:

\n ", + "smithy.api#examples": [ + { + "title": "To delete lifecycle configuration on a bucket.", + "documentation": "The following example deletes lifecycle configuration on a bucket.", + "input": { + "Bucket": "examplebucket" + } + } + ], + "smithy.api#http": { + "method": "DELETE", + "uri": "/{Bucket}?lifecycle", + "code": 204 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#DeleteBucketLifecycleRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name of the lifecycle to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

\n \n

This parameter applies to general purpose buckets only. It is not supported for\n directory bucket lifecycle configurations.

\n ", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#DeleteBucketMetadataTableConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#DeleteBucketMetadataTableConfigurationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

\n Deletes a metadata table configuration from a general purpose bucket. For more\n information, see Accelerating data\n discovery with S3 Metadata in the Amazon S3 User Guide.

\n
\n
Permissions
\n
\n

To use this operation, you must have the s3:DeleteBucketMetadataTableConfiguration permission. For more\n information, see Setting up\n permissions for configuring metadata tables in the\n Amazon S3 User Guide.

\n
\n
\n

The following operations are related to DeleteBucketMetadataTableConfiguration:

\n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/{Bucket}?metadataTable", + "code": 204 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#DeleteBucketMetadataTableConfigurationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

\n The general purpose bucket that you want to remove the metadata table configuration from.\n

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

\n The expected bucket owner of the general purpose bucket that you want to remove the \n metadata table configuration from.\n

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#DeleteBucketMetricsConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#DeleteBucketMetricsConfigurationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified by the\n metrics configuration ID) from the bucket. Note that this doesn't include the daily storage\n metrics.

\n

To use this operation, you must have permissions to perform the\n s3:PutMetricsConfiguration action. The bucket owner has this permission by\n default. The bucket owner can grant this permission to others. For more information about\n permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.

\n

For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with\n Amazon CloudWatch.

\n

The following operations are related to\n DeleteBucketMetricsConfiguration:

\n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/{Bucket}?metrics", + "code": 204 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#DeleteBucketMetricsConfigurationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket containing the metrics configuration to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "Id": { + "target": "com.amazonaws.s3#MetricsId", + "traits": { + "smithy.api#documentation": "

The ID used to identify the metrics configuration. The ID has a 64 character limit and\n can only contain letters, numbers, periods, dashes, and underscores.

", + "smithy.api#httpQuery": "id", + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#DeleteBucketOwnershipControls": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#DeleteBucketOwnershipControlsRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Removes OwnershipControls for an Amazon S3 bucket. To use this operation, you\n must have the s3:PutBucketOwnershipControls permission. For more information\n about Amazon S3 permissions, see Specifying Permissions in a\n Policy.

\n

For information about Amazon S3 Object Ownership, see Using Object Ownership.

\n

The following operations are related to\n DeleteBucketOwnershipControls:

\n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/{Bucket}?ownershipControls", + "code": 204 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#DeleteBucketOwnershipControlsRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The Amazon S3 bucket whose OwnershipControls you want to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#DeleteBucketPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#DeleteBucketPolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deletes the policy of a specified bucket.

\n \n

\n Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name\n . Virtual-hosted-style requests aren't supported. \nFor more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the\n Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the\n Amazon S3 User Guide.

\n \n
\n
Permissions
\n
\n

If you are using an identity other than the root user of the Amazon Web Services account that\n owns the bucket, the calling identity must both have the\n DeleteBucketPolicy permissions on the specified bucket and belong\n to the bucket owner's account in order to use this operation.

\n

If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a\n 403 Access Denied error. If you have the correct permissions, but\n you're not using an identity that belongs to the bucket owner's account, Amazon S3\n returns a 405 Method Not Allowed error.

\n \n

To ensure that bucket owners don't inadvertently lock themselves out of\n their own buckets, the root principal in a bucket owner's Amazon Web Services account can\n perform the GetBucketPolicy, PutBucketPolicy, and\n DeleteBucketPolicy API actions, even if their bucket policy\n explicitly denies the root principal's access. Bucket owner root principals can\n only be blocked from performing these API actions by VPC endpoint policies and\n Amazon Web Services Organizations policies.

\n \n
    \n
  • \n

    \n General purpose bucket permissions - The\n s3:DeleteBucketPolicy permission is required in a policy.\n For more information about general purpose buckets bucket policies, see Using Bucket Policies and User Policies in the\n Amazon S3 User Guide.

    \n
    • \n
  • \n

    \n Directory bucket permissions -\n To grant access to this API operation, you must have the\n s3express:DeleteBucketPolicy permission in\n an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource.\n For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

    \n
    • \n
\n
\n
HTTP Host header syntax
\n
\n

\n Directory buckets - The HTTP Host header syntax is s3express-control.region-code.amazonaws.com.

\n
\n
\n

The following operations are related to DeleteBucketPolicy\n

\n ", + "smithy.api#examples": [ + { + "title": "To delete bucket policy", + "documentation": "The following example deletes bucket policy on the specified bucket.", + "input": { + "Bucket": "examplebucket" + } + } + ], + "smithy.api#http": { + "method": "DELETE", + "uri": "/{Bucket}?policy", + "code": 204 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#DeleteBucketPolicyRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name.

\n

\n Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name\n . Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide\n

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

\n \n

For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code \n501 Not Implemented.

\n ", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#DeleteBucketReplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#DeleteBucketReplicationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Deletes the replication configuration from the bucket.

\n

To use this operation, you must have permissions to perform the\n s3:PutReplicationConfiguration action. The bucket owner has these\n permissions by default and can grant it to others. For more information about permissions,\n see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.

\n \n

It can take a while for the deletion of a replication configuration to fully\n propagate.

\n \n

For information about replication configuration, see Replication in the\n Amazon S3 User Guide.

\n

The following operations are related to DeleteBucketReplication:

\n ", + "smithy.api#examples": [ + { + "title": "To delete bucket replication configuration", + "documentation": "The following example deletes replication configuration set on bucket.", + "input": { + "Bucket": "example" + } + } + ], + "smithy.api#http": { + "method": "DELETE", + "uri": "/{Bucket}?replication", + "code": 204 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#DeleteBucketReplicationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#DeleteBucketRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

Specifies the bucket being deleted.

\n

\n Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name\n . Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide\n

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

\n \n

For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code \n501 Not Implemented.

\n ", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#DeleteBucketTagging": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#DeleteBucketTaggingRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Deletes the tags from the bucket.

\n

To use this operation, you must have permission to perform the\n s3:PutBucketTagging action. By default, the bucket owner has this\n permission and can grant this permission to others.

\n

The following operations are related to DeleteBucketTagging:

\n ", + "smithy.api#examples": [ + { + "title": "To delete bucket tags", + "documentation": "The following example deletes bucket tags.", + "input": { + "Bucket": "examplebucket" + } + } + ], + "smithy.api#http": { + "method": "DELETE", + "uri": "/{Bucket}?tagging", + "code": 204 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#DeleteBucketTaggingRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket that has the tag set to be removed.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#DeleteBucketWebsite": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#DeleteBucketWebsiteRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

This action removes the website configuration for a bucket. Amazon S3 returns a 200\n OK response upon successfully deleting a website configuration on the specified\n bucket. You will get a 200 OK response if the website configuration you are\n trying to delete does not exist on the bucket. Amazon S3 returns a 404 response if\n the bucket specified in the request does not exist.

\n

This DELETE action requires the S3:DeleteBucketWebsite permission. By\n default, only the bucket owner can delete the website configuration attached to a bucket.\n However, bucket owners can grant other users permission to delete the website configuration\n by writing a bucket policy granting them the S3:DeleteBucketWebsite\n permission.

\n

For more information about hosting websites, see Hosting Websites on Amazon S3.

\n

The following operations are related to DeleteBucketWebsite:

\n ", + "smithy.api#examples": [ + { + "title": "To delete bucket website configuration", + "documentation": "The following example deletes bucket website configuration.", + "input": { + "Bucket": "examplebucket" + } + } + ], + "smithy.api#http": { + "method": "DELETE", + "uri": "/{Bucket}?website", + "code": 204 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#DeleteBucketWebsiteRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name for which you want to remove the website configuration.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#DeleteMarker": { + "type": "boolean" + }, + "com.amazonaws.s3#DeleteMarkerEntry": { + "type": "structure", + "members": { + "Owner": { + "target": "com.amazonaws.s3#Owner", + "traits": { + "smithy.api#documentation": "

The account that created the delete marker.>

" + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

The object key.

" + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

Version ID of an object.

" + } + }, + "IsLatest": { + "target": "com.amazonaws.s3#IsLatest", + "traits": { + "smithy.api#documentation": "

Specifies whether the object is (true) or is not (false) the latest version of an\n object.

" + } + }, + "LastModified": { + "target": "com.amazonaws.s3#LastModified", + "traits": { + "smithy.api#documentation": "

Date and time when the object was last modified.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the delete marker.

" + } + }, + "com.amazonaws.s3#DeleteMarkerReplication": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.s3#DeleteMarkerReplicationStatus", + "traits": { + "smithy.api#documentation": "

Indicates whether to replicate delete markers.

\n \n

Indicates whether to replicate delete markers.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies whether Amazon S3 replicates delete markers. If you specify a Filter\n in your replication configuration, you must also include a\n DeleteMarkerReplication element. If your Filter includes a\n Tag element, the DeleteMarkerReplication\n Status must be set to Disabled, because Amazon S3 does not support replicating\n delete markers for tag-based rules. For an example configuration, see Basic Rule Configuration.

\n

For more information about delete marker replication, see Basic Rule\n Configuration.

\n \n

If you are using an earlier version of the replication configuration, Amazon S3 handles\n replication of delete markers differently. For more information, see Backward Compatibility.

\n " + } + }, + "com.amazonaws.s3#DeleteMarkerReplicationStatus": { + "type": "enum", + "members": { + "Enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enabled" + } + }, + "Disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disabled" + } + } + } + }, + "com.amazonaws.s3#DeleteMarkerVersionId": { + "type": "string" + }, + "com.amazonaws.s3#DeleteMarkers": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#DeleteMarkerEntry" + } + }, + "com.amazonaws.s3#DeleteObject": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#DeleteObjectRequest" + }, + "output": { + "target": "com.amazonaws.s3#DeleteObjectOutput" + }, + "traits": { + "smithy.api#documentation": "

Removes an object from a bucket. The behavior depends on the bucket's versioning state:

\n
    \n
  • \n

    If bucket versioning is not enabled, the operation permanently deletes the object.

    \n
    • \n
  • \n

    If bucket versioning is enabled, the operation inserts a delete marker, which becomes the current version of the object. To permanently delete an object in a versioned bucket, you must include the object’s versionId in the request. For more information about versioning-enabled buckets, see Deleting object versions from a versioning-enabled bucket.

    \n
    • \n
  • \n

    If bucket versioning is suspended, the operation removes the object that has a null versionId, if there is one, and inserts a delete marker that becomes the current version of the object. If there isn't an object with a null versionId, and all versions of the object have a versionId, Amazon S3 does not remove the object and only inserts a delete marker. To permanently delete an object that has a versionId, you must include the object’s versionId in the request. For more information about versioning-suspended buckets, see Deleting objects from versioning-suspended buckets.

    \n
    • \n
\n \n
    \n
  • \n

    \n Directory buckets - S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the null value of the version ID is supported by directory buckets. You can only specify null \n to the versionId query parameter in the request.

    \n
    • \n
  • \n

    \n Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket-name.s3express-zone-id.region-code.amazonaws.com/key-name\n . Path-style requests are not supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the\n Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the\n Amazon S3 User Guide.

    \n
    • \n
\n \n

To remove a specific version, you must use the versionId query parameter. Using this\n query parameter permanently deletes the version. If the object deleted is a delete marker, Amazon S3\n sets the response header x-amz-delete-marker to true.

\n

If the object you want to delete is in a bucket where the bucket versioning\n configuration is MFA Delete enabled, you must include the x-amz-mfa request\n header in the DELETE versionId request. Requests that include\n x-amz-mfa must use HTTPS. For more information about MFA Delete, see Using MFA Delete in the Amazon S3\n User Guide. To see sample\n requests that use versioning, see Sample\n Request.

\n \n

\n Directory buckets - MFA delete is not supported by directory buckets.

\n \n

You can delete objects by explicitly calling DELETE Object or calling \n (PutBucketLifecycle) to enable Amazon S3 to remove them for you. If you want to block\n users or accounts from removing or deleting objects from your bucket, you must deny them\n the s3:DeleteObject, s3:DeleteObjectVersion, and\n s3:PutLifeCycleConfiguration actions.

\n \n

\n Directory buckets - S3 Lifecycle is not supported by directory buckets.

\n \n
\n
Permissions
\n
\n
    \n
  • \n

    \n General purpose bucket permissions - The following permissions are required in your policies when your \n DeleteObjects request includes specific headers.

    \n
      \n
    • \n

      \n \n s3:DeleteObject\n - To delete an object from a bucket, you must always have the s3:DeleteObject permission.

      \n
      • \n
    • \n

      \n \n s3:DeleteObjectVersion\n - To delete a specific version of an object from a versioning-enabled bucket, you must have the s3:DeleteObjectVersion permission.

      \n
      • \n
    \n
    • \n
  • \n

    \n Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the \n CreateSession\n API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. \nAmazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see \n CreateSession\n .

    \n
    • \n
\n
\n
HTTP Host header syntax
\n
\n

\n Directory buckets - The HTTP Host header syntax is \n Bucket-name.s3express-zone-id.region-code.amazonaws.com.

\n
\n
\n

The following action is related to DeleteObject:

\n ", + "smithy.api#examples": [ + { + "title": "To delete an object (from a non-versioned bucket)", + "documentation": "The following example deletes an object from a non-versioned bucket.", + "input": { + "Bucket": "ExampleBucket", + "Key": "HappyFace.jpg" + } + }, + { + "title": "To delete an object", + "documentation": "The following example deletes an object from an S3 bucket.", + "input": { + "Bucket": "examplebucket", + "Key": "objectkey.jpg" + }, + "output": {} + } + ], + "smithy.api#http": { + "method": "DELETE", + "uri": "/{Bucket}/{Key+}?x-id=DeleteObject", + "code": 204 + } + } + }, + "com.amazonaws.s3#DeleteObjectOutput": { + "type": "structure", + "members": { + "DeleteMarker": { + "target": "com.amazonaws.s3#DeleteMarker", + "traits": { + "smithy.api#documentation": "

Indicates whether the specified object version that was permanently deleted was (true)\n or was not (false) a delete marker before deletion. In a simple DELETE, this header\n indicates whether (true) or not (false) the current version of the object is a delete\n marker.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-delete-marker" + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

Returns the version ID of the delete marker created as a result of the DELETE\n operation.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-version-id" + } + }, + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3#DeleteObjectRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name of the bucket containing the object.

\n

\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n \n

Access points and Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

Key name of the object to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Key" + } + } + }, + "MFA": { + "target": "com.amazonaws.s3#MFA", + "traits": { + "smithy.api#documentation": "

The concatenation of the authentication device's serial number, a space, and the value\n that is displayed on your authentication device. Required to permanently delete a versioned\n object if versioning is configured with MFA delete enabled.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-mfa" + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

Version ID used to reference a specific version of the object.

\n \n

For directory buckets in this API operation, only the null value of the version ID is supported.

\n ", + "smithy.api#httpQuery": "versionId" + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "BypassGovernanceRetention": { + "target": "com.amazonaws.s3#BypassGovernanceRetention", + "traits": { + "smithy.api#documentation": "

Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process\n this operation. To use this header, you must have the\n s3:BypassGovernanceRetention permission.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-bypass-governance-retention" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + }, + "IfMatch": { + "target": "com.amazonaws.s3#IfMatch", + "traits": { + "smithy.api#documentation": "

The If-Match header field makes the request method conditional on ETags. If the ETag value does not match, the operation returns\n a 412 Precondition Failed error. If the ETag matches or if the object doesn't exist, the operation will return a 204 Success (No \n Content) response.

\n

For more information about conditional requests, see RFC 7232.

\n \n

This functionality is only supported for directory buckets.

\n ", + "smithy.api#httpHeader": "If-Match" + } + }, + "IfMatchLastModifiedTime": { + "target": "com.amazonaws.s3#IfMatchLastModifiedTime", + "traits": { + "smithy.api#documentation": "

If present, the object is deleted only if its modification times matches the provided\n Timestamp. If the Timestamp values do not match, the operation\n returns a 412 Precondition Failed error. If the Timestamp matches\n or if the object doesn’t exist, the operation returns a 204 Success (No\n Content) response.

\n \n

This functionality is only supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-if-match-last-modified-time" + } + }, + "IfMatchSize": { + "target": "com.amazonaws.s3#IfMatchSize", + "traits": { + "smithy.api#documentation": "

If present, the object is deleted only if its size matches the provided size in bytes. If the Size value does not match, the operation returns a 412 Precondition Failed error. If the Size matches or if the object doesn’t exist, \n the operation returns a 204 Success (No Content) response.

\n \n

This functionality is only supported for directory buckets.

\n \n \n

You can use the If-Match, x-amz-if-match-last-modified-time and x-amz-if-match-size \n conditional headers in conjunction with each-other or individually.

\n ", + "smithy.api#httpHeader": "x-amz-if-match-size" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#DeleteObjectTagging": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#DeleteObjectTaggingRequest" + }, + "output": { + "target": "com.amazonaws.s3#DeleteObjectTaggingOutput" + }, + "traits": { + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Removes the entire tag set from the specified object. For more information about\n managing object tags, see Object Tagging.

\n

To use this operation, you must have permission to perform the\n s3:DeleteObjectTagging action.

\n

To delete tags of a specific object version, add the versionId query\n parameter in the request. You will need permission for the\n s3:DeleteObjectVersionTagging action.

\n

The following operations are related to DeleteObjectTagging:

\n ", + "smithy.api#examples": [ + { + "title": "To remove tag set from an object", + "documentation": "The following example removes tag set associated with the specified object. If the bucket is versioning enabled, the operation removes tag set from the latest object version.", + "input": { + "Bucket": "examplebucket", + "Key": "HappyFace.jpg" + }, + "output": { + "VersionId": "null" + } + }, + { + "title": "To remove tag set from an object version", + "documentation": "The following example removes tag set associated with the specified object version. The request specifies both the object key and object version.", + "input": { + "Bucket": "examplebucket", + "Key": "HappyFace.jpg", + "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI" + }, + "output": { + "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI" + } + } + ], + "smithy.api#http": { + "method": "DELETE", + "uri": "/{Bucket}/{Key+}?tagging", + "code": 204 + } + } + }, + "com.amazonaws.s3#DeleteObjectTaggingOutput": { + "type": "structure", + "members": { + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

The versionId of the object the tag-set was removed from.

", + "smithy.api#httpHeader": "x-amz-version-id" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3#DeleteObjectTaggingRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name containing the objects from which to remove the tags.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

\n S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

The key that identifies the object in the bucket from which to remove all tags.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

The versionId of the object that the tag-set will be removed from.

", + "smithy.api#httpQuery": "versionId" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#DeleteObjects": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#DeleteObjectsRequest" + }, + "output": { + "target": "com.amazonaws.s3#DeleteObjectsOutput" + }, + "traits": { + "aws.protocols#httpChecksum": { + "requestAlgorithmMember": "ChecksumAlgorithm", + "requestChecksumRequired": true + }, + "smithy.api#documentation": "

This operation enables you to delete multiple objects from a bucket using a single HTTP\n request. If you know the object keys that you want to delete, then this operation provides\n a suitable alternative to sending individual delete requests, reducing per-request\n overhead.

\n

The request can contain a list of up to 1000 keys that you want to delete. In the XML,\n you provide the object key names, and optionally, version IDs if you want to delete a\n specific version of the object from a versioning-enabled bucket. For each key, Amazon S3\n performs a delete operation and returns the result of that delete, success or failure, in\n the response. Note that if the object specified in the request is not found, Amazon S3 returns\n the result as deleted.

\n \n
    \n
  • \n

    \n Directory buckets -\n S3 Versioning isn't enabled and supported for directory buckets.

    \n
    • \n
  • \n

    \n Directory buckets -\n For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket-name.s3express-zone-id.region-code.amazonaws.com/key-name\n . Path-style requests are not supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the\n Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the\n Amazon S3 User Guide.

    \n
    • \n
\n \n

The operation supports two modes for the response: verbose and quiet. By default, the\n operation uses verbose mode in which the response includes the result of deletion of each\n key in your request. In quiet mode the response includes only keys where the delete\n operation encountered an error. For a successful deletion in a quiet mode, the operation\n does not return any information about the delete in the response body.

\n

When performing this action on an MFA Delete enabled bucket, that attempts to delete any\n versioned objects, you must include an MFA token. If you do not provide one, the entire\n request will fail, even if there are non-versioned objects you are trying to delete. If you\n provide an invalid token, whether there are versioned keys in the request or not, the\n entire Multi-Object Delete request will fail. For information about MFA Delete, see MFA\n Delete in the Amazon S3 User Guide.

\n \n

\n Directory buckets -\n MFA delete is not supported by directory buckets.

\n \n
\n
Permissions
\n
\n
    \n
  • \n

    \n General purpose bucket permissions - The\n following permissions are required in your policies when your\n DeleteObjects request includes specific headers.

    \n
      \n
    • \n

      \n \n s3:DeleteObject\n \n - To delete an object from a bucket, you must always specify\n the s3:DeleteObject permission.

      \n
      • \n
    • \n

      \n \n s3:DeleteObjectVersion\n - To delete a specific version of an object from a\n versioning-enabled bucket, you must specify the\n s3:DeleteObjectVersion permission.

      \n
      • \n
    \n
    • \n
  • \n

    \n Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the \n CreateSession\n API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. \nAmazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see \n CreateSession\n .

    \n
    • \n
\n
\n
Content-MD5 request header
\n
\n
    \n
  • \n

    \n General purpose bucket - The Content-MD5\n request header is required for all Multi-Object Delete requests. Amazon S3 uses\n the header value to ensure that your request body has not been altered in\n transit.

    \n
    • \n
  • \n

    \n Directory bucket - The\n Content-MD5 request header or a additional checksum request header\n (including x-amz-checksum-crc32,\n x-amz-checksum-crc32c, x-amz-checksum-sha1, or\n x-amz-checksum-sha256) is required for all Multi-Object\n Delete requests.

    \n
    • \n
\n
\n
HTTP Host header syntax
\n
\n

\n Directory buckets - The HTTP Host header syntax is \n Bucket-name.s3express-zone-id.region-code.amazonaws.com.

\n
\n
\n

The following operations are related to DeleteObjects:

\n ", + "smithy.api#examples": [ + { + "title": "To delete multiple object versions from a versioned bucket", + "documentation": "The following example deletes objects from a bucket. The request specifies object versions. S3 deletes specific object versions and returns the key and versions of deleted objects in the response.", + "input": { + "Bucket": "examplebucket", + "Delete": { + "Objects": [ + { + "Key": "HappyFace.jpg", + "VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b" + }, + { + "Key": "HappyFace.jpg", + "VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd" + } + ], + "Quiet": false + } + }, + "output": { + "Deleted": [ + { + "VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd", + "Key": "HappyFace.jpg" + }, + { + "VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b", + "Key": "HappyFace.jpg" + } + ] + } + }, + { + "title": "To delete multiple objects from a versioned bucket", + "documentation": "The following example deletes objects from a bucket. The bucket is versioned, and the request does not specify the object version to delete. In this case, all versions remain in the bucket and S3 adds a delete marker.", + "input": { + "Bucket": "examplebucket", + "Delete": { + "Objects": [ + { + "Key": "objectkey1" + }, + { + "Key": "objectkey2" + } + ], + "Quiet": false + } + }, + "output": { + "Deleted": [ + { + "DeleteMarkerVersionId": "A._w1z6EFiCF5uhtQMDal9JDkID9tQ7F", + "Key": "objectkey1", + "DeleteMarker": true + }, + { + "DeleteMarkerVersionId": "iOd_ORxhkKe_e8G8_oSGxt2PjsCZKlkt", + "Key": "objectkey2", + "DeleteMarker": true + } + ] + } + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/{Bucket}?delete", + "code": 200 + } + } + }, + "com.amazonaws.s3#DeleteObjectsOutput": { + "type": "structure", + "members": { + "Deleted": { + "target": "com.amazonaws.s3#DeletedObjects", + "traits": { + "smithy.api#documentation": "

Container element for a successful delete. It identifies the object that was\n successfully deleted.

", + "smithy.api#xmlFlattened": {} + } + }, + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" + } + }, + "Errors": { + "target": "com.amazonaws.s3#Errors", + "traits": { + "smithy.api#documentation": "

Container for a failed delete action that describes the object that Amazon S3 attempted to\n delete and the error it encountered.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Error" + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#xmlName": "DeleteResult" + } + }, + "com.amazonaws.s3#DeleteObjectsRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name containing the objects to delete.

\n

\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n \n

Access points and Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "Delete": { + "target": "com.amazonaws.s3#Delete", + "traits": { + "smithy.api#documentation": "

Container for the request.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {}, + "smithy.api#xmlName": "Delete" + } + }, + "MFA": { + "target": "com.amazonaws.s3#MFA", + "traits": { + "smithy.api#documentation": "

The concatenation of the authentication device's serial number, a space, and the value\n that is displayed on your authentication device. Required to permanently delete a versioned\n object if versioning is configured with MFA delete enabled.

\n

When performing the DeleteObjects operation on an MFA delete enabled\n bucket, which attempts to delete the specified versioned objects, you must include an MFA\n token. If you don't provide an MFA token, the entire request will fail, even if there are\n non-versioned objects that you are trying to delete. If you provide an invalid token,\n whether there are versioned object keys in the request or not, the entire Multi-Object\n Delete request will fail. For information about MFA Delete, see MFA\n Delete in the Amazon S3 User Guide.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-mfa" + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "BypassGovernanceRetention": { + "target": "com.amazonaws.s3#BypassGovernanceRetention", + "traits": { + "smithy.api#documentation": "

Specifies whether you want to delete this object even if it has a Governance-type Object\n Lock in place. To use this header, you must have the\n s3:BypassGovernanceRetention permission.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-bypass-governance-retention" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + }, + "ChecksumAlgorithm": { + "target": "com.amazonaws.s3#ChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any\n additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum-algorithm\n or\n x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request.

\n

For the x-amz-checksum-algorithm\n header, replace \n algorithm\n with the supported algorithm from the following list:

\n
    \n
  • \n

    \n CRC32\n

    \n
    • \n
  • \n

    \n CRC32C\n

    \n
    • \n
  • \n

    \n SHA1\n

    \n
    • \n
  • \n

    \n SHA256\n

    \n
    • \n
\n

For more\n information, see Checking object integrity in\n the Amazon S3 User Guide.

\n

If the individual checksum value you provide through x-amz-checksum-algorithm\n doesn't match the checksum algorithm you set through x-amz-sdk-checksum-algorithm, Amazon S3 ignores any provided\n ChecksumAlgorithm parameter and uses the checksum algorithm that matches the provided value in x-amz-checksum-algorithm\n .

\n

If you provide an individual checksum, Amazon S3 ignores any provided\n ChecksumAlgorithm parameter.

", + "smithy.api#httpHeader": "x-amz-sdk-checksum-algorithm" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#DeletePublicAccessBlock": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#DeletePublicAccessBlockRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Removes the PublicAccessBlock configuration for an Amazon S3 bucket. To use this\n operation, you must have the s3:PutBucketPublicAccessBlock permission. For\n more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.

\n

The following operations are related to DeletePublicAccessBlock:

\n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/{Bucket}?publicAccessBlock", + "code": 204 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#DeletePublicAccessBlockRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The Amazon S3 bucket whose PublicAccessBlock configuration you want to delete.\n

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#DeletedObject": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

The name of the deleted object.

" + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

The version ID of the deleted object.

\n \n

This functionality is not supported for directory buckets.

\n " + } + }, + "DeleteMarker": { + "target": "com.amazonaws.s3#DeleteMarker", + "traits": { + "smithy.api#documentation": "

Indicates whether the specified object version that was permanently deleted was (true)\n or was not (false) a delete marker before deletion. In a simple DELETE, this header\n indicates whether (true) or not (false) the current version of the object is a delete\n marker.

\n \n

This functionality is not supported for directory buckets.

\n " + } + }, + "DeleteMarkerVersionId": { + "target": "com.amazonaws.s3#DeleteMarkerVersionId", + "traits": { + "smithy.api#documentation": "

The version ID of the delete marker created as a result of the DELETE operation. If you\n delete a specific object version, the value returned by this header is the version ID of\n the object version deleted.

\n \n

This functionality is not supported for directory buckets.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the deleted object.

" + } + }, + "com.amazonaws.s3#DeletedObjects": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#DeletedObject" + } + }, + "com.amazonaws.s3#Delimiter": { + "type": "string" + }, + "com.amazonaws.s3#Description": { + "type": "string" + }, + "com.amazonaws.s3#Destination": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store the\n results.

", + "smithy.api#required": {} + } + }, + "Account": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

Destination bucket owner account ID. In a cross-account scenario, if you direct Amazon S3 to\n change replica ownership to the Amazon Web Services account that owns the destination bucket by\n specifying the AccessControlTranslation property, this is the account ID of\n the destination bucket owner. For more information, see Replication Additional\n Configuration: Changing the Replica Owner in the\n Amazon S3 User Guide.

" + } + }, + "StorageClass": { + "target": "com.amazonaws.s3#StorageClass", + "traits": { + "smithy.api#documentation": "

The storage class to use when replicating objects, such as S3 Standard or reduced\n redundancy. By default, Amazon S3 uses the storage class of the source object to create the\n object replica.

\n

For valid values, see the StorageClass element of the PUT Bucket\n replication action in the Amazon S3 API Reference.

" + } + }, + "AccessControlTranslation": { + "target": "com.amazonaws.s3#AccessControlTranslation", + "traits": { + "smithy.api#documentation": "

Specify this only in a cross-account scenario (where source and destination bucket\n owners are not the same), and you want to change replica ownership to the Amazon Web Services account\n that owns the destination bucket. If this is not specified in the replication\n configuration, the replicas are owned by same Amazon Web Services account that owns the source\n object.

" + } + }, + "EncryptionConfiguration": { + "target": "com.amazonaws.s3#EncryptionConfiguration", + "traits": { + "smithy.api#documentation": "

A container that provides information about encryption. If\n SourceSelectionCriteria is specified, you must specify this element.

" + } + }, + "ReplicationTime": { + "target": "com.amazonaws.s3#ReplicationTime", + "traits": { + "smithy.api#documentation": "

A container specifying S3 Replication Time Control (S3 RTC), including whether S3 RTC is enabled and the time\n when all objects and operations on objects must be replicated. Must be specified together\n with a Metrics block.

" + } + }, + "Metrics": { + "target": "com.amazonaws.s3#Metrics", + "traits": { + "smithy.api#documentation": "

A container specifying replication metrics-related settings enabling replication\n metrics and events.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies information about where to publish analysis or configuration results for an\n Amazon S3 bucket and S3 Replication Time Control (S3 RTC).

" + } + }, + "com.amazonaws.s3#DirectoryBucketToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.s3#DisplayName": { + "type": "string" + }, + "com.amazonaws.s3#ETag": { + "type": "string" + }, + "com.amazonaws.s3#EmailAddress": { + "type": "string" + }, + "com.amazonaws.s3#EnableRequestProgress": { + "type": "boolean" + }, + "com.amazonaws.s3#EncodingType": { + "type": "enum", + "members": { + "url": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "url" + } + } + }, + "traits": { + "smithy.api#documentation": "

Encoding type used by Amazon S3 to encode the object keys in the response.\n Responses are encoded only in UTF-8. An object key can contain any Unicode character.\n However, the XML 1.0 parser can't parse certain characters, such as characters with an\n ASCII value from 0 to 10. For characters that aren't supported in XML 1.0, you can add this\n parameter to request that Amazon S3 encode the keys in the response. For more information about\n characters to avoid in object key names, see Object key naming\n guidelines.

\n \n

When using the URL encoding type, non-ASCII characters that are used in an object's\n key name will be percent-encoded according to UTF-8 code values. For example, the object\n test_file(3).png will appear as\n test_file%283%29.png.

\n " + } + }, + "com.amazonaws.s3#Encryption": { + "type": "structure", + "members": { + "EncryptionType": { + "target": "com.amazonaws.s3#ServerSideEncryption", + "traits": { + "smithy.api#documentation": "

The server-side encryption algorithm used when storing job results in Amazon S3 (for example,\n AES256, aws:kms).

", + "smithy.api#required": {} + } + }, + "KMSKeyId": { + "target": "com.amazonaws.s3#SSEKMSKeyId", + "traits": { + "smithy.api#documentation": "

If the encryption type is aws:kms, this optional value specifies the ID of\n the symmetric encryption customer managed key to use for encryption of job results. Amazon S3 only\n supports symmetric encryption KMS keys. For more information, see Asymmetric keys in KMS in the Amazon Web Services Key Management Service\n Developer Guide.

" + } + }, + "KMSContext": { + "target": "com.amazonaws.s3#KMSContext", + "traits": { + "smithy.api#documentation": "

If the encryption type is aws:kms, this optional value can be used to\n specify the encryption context for the restore results.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the type of server-side encryption used.

" + } + }, + "com.amazonaws.s3#EncryptionConfiguration": { + "type": "structure", + "members": { + "ReplicaKmsKeyID": { + "target": "com.amazonaws.s3#ReplicaKmsKeyID", + "traits": { + "smithy.api#documentation": "

Specifies the ID (Key ARN or Alias ARN) of the customer managed Amazon Web Services KMS key stored in\n Amazon Web Services Key Management Service (KMS) for the destination bucket. Amazon S3 uses this key to\n encrypt replica objects. Amazon S3 only supports symmetric encryption KMS keys. For more\n information, see Asymmetric keys in Amazon Web Services\n KMS in the Amazon Web Services Key Management Service Developer\n Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies encryption-related information for an Amazon S3 bucket that is a destination for\n replicated objects.

\n \n

If you're specifying a customer managed KMS key, we recommend using a fully\n qualified KMS key ARN. If you use a KMS key alias instead, then KMS resolves the\n key within the requester’s account. This behavior can result in data that's encrypted\n with a KMS key that belongs to the requester, and not the bucket owner.

\n " + } + }, + "com.amazonaws.s3#EncryptionTypeMismatch": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

\n The existing object was created with a different encryption type. \n Subsequent write requests must include the appropriate encryption \n parameters in the request or while creating the session.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.s3#End": { + "type": "long" + }, + "com.amazonaws.s3#EndEvent": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

A message that indicates the request is complete and no more messages will be sent. You\n should not assume that the request is complete until the client receives an\n EndEvent.

" + } + }, + "com.amazonaws.s3#Error": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

The error key.

" + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

The version ID of the error.

\n \n

This functionality is not supported for directory buckets.

\n " + } + }, + "Code": { + "target": "com.amazonaws.s3#Code", + "traits": { + "smithy.api#documentation": "

The error code is a string that uniquely identifies an error condition. It is meant to\n be read and understood by programs that detect and handle errors by type. The following is\n a list of Amazon S3 error codes. For more information, see Error responses.

\n
    \n
  • \n
      \n
    • \n

      \n Code: AccessDenied

      \n
      • \n
    • \n

      \n Description: Access Denied

      \n
      • \n
    • \n

      \n HTTP Status Code: 403 Forbidden

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: AccountProblem

      \n
      • \n
    • \n

      \n Description: There is a problem with your Amazon Web Services account\n that prevents the action from completing successfully. Contact Amazon Web Services Support\n for further assistance.

      \n
      • \n
    • \n

      \n HTTP Status Code: 403 Forbidden

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: AllAccessDisabled

      \n
      • \n
    • \n

      \n Description: All access to this Amazon S3 resource has been\n disabled. Contact Amazon Web Services Support for further assistance.

      \n
      • \n
    • \n

      \n HTTP Status Code: 403 Forbidden

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: AmbiguousGrantByEmailAddress

      \n
      • \n
    • \n

      \n Description: The email address you provided is\n associated with more than one account.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: AuthorizationHeaderMalformed

      \n
      • \n
    • \n

      \n Description: The authorization header you provided is\n invalid.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n HTTP Status Code: N/A

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: BadDigest

      \n
      • \n
    • \n

      \n Description: The Content-MD5 you specified did not\n match what we received.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: BucketAlreadyExists

      \n
      • \n
    • \n

      \n Description: The requested bucket name is not\n available. The bucket namespace is shared by all users of the system. Please\n select a different name and try again.

      \n
      • \n
    • \n

      \n HTTP Status Code: 409 Conflict

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: BucketAlreadyOwnedByYou

      \n
      • \n
    • \n

      \n Description: The bucket you tried to create already\n exists, and you own it. Amazon S3 returns this error in all Amazon Web Services Regions except in\n the North Virginia Region. For legacy compatibility, if you re-create an\n existing bucket that you already own in the North Virginia Region, Amazon S3 returns\n 200 OK and resets the bucket access control lists (ACLs).

      \n
      • \n
    • \n

      \n Code: 409 Conflict (in all Regions except the North\n Virginia Region)

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: BucketNotEmpty

      \n
      • \n
    • \n

      \n Description: The bucket you tried to delete is not\n empty.

      \n
      • \n
    • \n

      \n HTTP Status Code: 409 Conflict

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: CredentialsNotSupported

      \n
      • \n
    • \n

      \n Description: This request does not support\n credentials.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: CrossLocationLoggingProhibited

      \n
      • \n
    • \n

      \n Description: Cross-location logging not allowed.\n Buckets in one geographic location cannot log information to a bucket in\n another location.

      \n
      • \n
    • \n

      \n HTTP Status Code: 403 Forbidden

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: EntityTooSmall

      \n
      • \n
    • \n

      \n Description: Your proposed upload is smaller than the\n minimum allowed object size.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: EntityTooLarge

      \n
      • \n
    • \n

      \n Description: Your proposed upload exceeds the maximum\n allowed object size.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: ExpiredToken

      \n
      • \n
    • \n

      \n Description: The provided token has expired.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: IllegalVersioningConfigurationException

      \n
      • \n
    • \n

      \n Description: Indicates that the versioning\n configuration specified in the request is invalid.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: IncompleteBody

      \n
      • \n
    • \n

      \n Description: You did not provide the number of bytes\n specified by the Content-Length HTTP header

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: IncorrectNumberOfFilesInPostRequest

      \n
      • \n
    • \n

      \n Description: POST requires exactly one file upload per\n request.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InlineDataTooLarge

      \n
      • \n
    • \n

      \n Description: Inline data exceeds the maximum allowed\n size.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InternalError

      \n
      • \n
    • \n

      \n Description: We encountered an internal error. Please\n try again.

      \n
      • \n
    • \n

      \n HTTP Status Code: 500 Internal Server Error

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Server

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidAccessKeyId

      \n
      • \n
    • \n

      \n Description: The Amazon Web Services access key ID you provided does\n not exist in our records.

      \n
      • \n
    • \n

      \n HTTP Status Code: 403 Forbidden

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidAddressingHeader

      \n
      • \n
    • \n

      \n Description: You must specify the Anonymous\n role.

      \n
      • \n
    • \n

      \n HTTP Status Code: N/A

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidArgument

      \n
      • \n
    • \n

      \n Description: Invalid Argument

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidBucketName

      \n
      • \n
    • \n

      \n Description: The specified bucket is not valid.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidBucketState

      \n
      • \n
    • \n

      \n Description: The request is not valid with the current\n state of the bucket.

      \n
      • \n
    • \n

      \n HTTP Status Code: 409 Conflict

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidDigest

      \n
      • \n
    • \n

      \n Description: The Content-MD5 you specified is not\n valid.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidEncryptionAlgorithmError

      \n
      • \n
    • \n

      \n Description: The encryption request you specified is\n not valid. The valid value is AES256.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidLocationConstraint

      \n
      • \n
    • \n

      \n Description: The specified location constraint is not\n valid. For more information about Regions, see How to Select\n a Region for Your Buckets.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidObjectState

      \n
      • \n
    • \n

      \n Description: The action is not valid for the current\n state of the object.

      \n
      • \n
    • \n

      \n HTTP Status Code: 403 Forbidden

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidPart

      \n
      • \n
    • \n

      \n Description: One or more of the specified parts could\n not be found. The part might not have been uploaded, or the specified entity\n tag might not have matched the part's entity tag.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidPartOrder

      \n
      • \n
    • \n

      \n Description: The list of parts was not in ascending\n order. Parts list must be specified in order by part number.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidPayer

      \n
      • \n
    • \n

      \n Description: All access to this object has been\n disabled. Please contact Amazon Web Services Support for further assistance.

      \n
      • \n
    • \n

      \n HTTP Status Code: 403 Forbidden

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidPolicyDocument

      \n
      • \n
    • \n

      \n Description: The content of the form does not meet the\n conditions specified in the policy document.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidRange

      \n
      • \n
    • \n

      \n Description: The requested range cannot be\n satisfied.

      \n
      • \n
    • \n

      \n HTTP Status Code: 416 Requested Range Not\n Satisfiable

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidRequest

      \n
      • \n
    • \n

      \n Description: Please use\n AWS4-HMAC-SHA256.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n Code: N/A

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidRequest

      \n
      • \n
    • \n

      \n Description: SOAP requests must be made over an HTTPS\n connection.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidRequest

      \n
      • \n
    • \n

      \n Description: Amazon S3 Transfer Acceleration is not\n supported for buckets with non-DNS compliant names.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n Code: N/A

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidRequest

      \n
      • \n
    • \n

      \n Description: Amazon S3 Transfer Acceleration is not\n supported for buckets with periods (.) in their names.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n Code: N/A

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidRequest

      \n
      • \n
    • \n

      \n Description: Amazon S3 Transfer Accelerate endpoint only\n supports virtual style requests.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n Code: N/A

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidRequest

      \n
      • \n
    • \n

      \n Description: Amazon S3 Transfer Accelerate is not configured\n on this bucket.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n Code: N/A

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidRequest

      \n
      • \n
    • \n

      \n Description: Amazon S3 Transfer Accelerate is disabled on\n this bucket.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n Code: N/A

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidRequest

      \n
      • \n
    • \n

      \n Description: Amazon S3 Transfer Acceleration is not\n supported on this bucket. Contact Amazon Web Services Support for more information.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n Code: N/A

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidRequest

      \n
      • \n
    • \n

      \n Description: Amazon S3 Transfer Acceleration cannot be\n enabled on this bucket. Contact Amazon Web Services Support for more information.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n Code: N/A

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidSecurity

      \n
      • \n
    • \n

      \n Description: The provided security credentials are not\n valid.

      \n
      • \n
    • \n

      \n HTTP Status Code: 403 Forbidden

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidSOAPRequest

      \n
      • \n
    • \n

      \n Description: The SOAP request body is invalid.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidStorageClass

      \n
      • \n
    • \n

      \n Description: The storage class you specified is not\n valid.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidTargetBucketForLogging

      \n
      • \n
    • \n

      \n Description: The target bucket for logging does not\n exist, is not owned by you, or does not have the appropriate grants for the\n log-delivery group.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidToken

      \n
      • \n
    • \n

      \n Description: The provided token is malformed or\n otherwise invalid.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidURI

      \n
      • \n
    • \n

      \n Description: Couldn't parse the specified URI.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: KeyTooLongError

      \n
      • \n
    • \n

      \n Description: Your key is too long.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: MalformedACLError

      \n
      • \n
    • \n

      \n Description: The XML you provided was not well-formed\n or did not validate against our published schema.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: MalformedPOSTRequest

      \n
      • \n
    • \n

      \n Description: The body of your POST request is not\n well-formed multipart/form-data.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: MalformedXML

      \n
      • \n
    • \n

      \n Description: This happens when the user sends malformed\n XML (XML that doesn't conform to the published XSD) for the configuration. The\n error message is, \"The XML you provided was not well-formed or did not validate\n against our published schema.\"

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: MaxMessageLengthExceeded

      \n
      • \n
    • \n

      \n Description: Your request was too big.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: MaxPostPreDataLengthExceededError

      \n
      • \n
    • \n

      \n Description: Your POST request fields preceding the\n upload file were too large.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: MetadataTooLarge

      \n
      • \n
    • \n

      \n Description: Your metadata headers exceed the maximum\n allowed metadata size.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: MethodNotAllowed

      \n
      • \n
    • \n

      \n Description: The specified method is not allowed\n against this resource.

      \n
      • \n
    • \n

      \n HTTP Status Code: 405 Method Not Allowed

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: MissingAttachment

      \n
      • \n
    • \n

      \n Description: A SOAP attachment was expected, but none\n were found.

      \n
      • \n
    • \n

      \n HTTP Status Code: N/A

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: MissingContentLength

      \n
      • \n
    • \n

      \n Description: You must provide the Content-Length HTTP\n header.

      \n
      • \n
    • \n

      \n HTTP Status Code: 411 Length Required

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: MissingRequestBodyError

      \n
      • \n
    • \n

      \n Description: This happens when the user sends an empty\n XML document as a request. The error message is, \"Request body is empty.\"\n

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: MissingSecurityElement

      \n
      • \n
    • \n

      \n Description: The SOAP 1.1 request is missing a security\n element.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: MissingSecurityHeader

      \n
      • \n
    • \n

      \n Description: Your request is missing a required\n header.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: NoLoggingStatusForKey

      \n
      • \n
    • \n

      \n Description: There is no such thing as a logging status\n subresource for a key.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: NoSuchBucket

      \n
      • \n
    • \n

      \n Description: The specified bucket does not\n exist.

      \n
      • \n
    • \n

      \n HTTP Status Code: 404 Not Found

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: NoSuchBucketPolicy

      \n
      • \n
    • \n

      \n Description: The specified bucket does not have a\n bucket policy.

      \n
      • \n
    • \n

      \n HTTP Status Code: 404 Not Found

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: NoSuchKey

      \n
      • \n
    • \n

      \n Description: The specified key does not exist.

      \n
      • \n
    • \n

      \n HTTP Status Code: 404 Not Found

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: NoSuchLifecycleConfiguration

      \n
      • \n
    • \n

      \n Description: The lifecycle configuration does not\n exist.

      \n
      • \n
    • \n

      \n HTTP Status Code: 404 Not Found

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: NoSuchUpload

      \n
      • \n
    • \n

      \n Description: The specified multipart upload does not\n exist. The upload ID might be invalid, or the multipart upload might have been\n aborted or completed.

      \n
      • \n
    • \n

      \n HTTP Status Code: 404 Not Found

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: NoSuchVersion

      \n
      • \n
    • \n

      \n Description: Indicates that the version ID specified in\n the request does not match an existing version.

      \n
      • \n
    • \n

      \n HTTP Status Code: 404 Not Found

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: NotImplemented

      \n
      • \n
    • \n

      \n Description: A header you provided implies\n functionality that is not implemented.

      \n
      • \n
    • \n

      \n HTTP Status Code: 501 Not Implemented

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Server

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: NotSignedUp

      \n
      • \n
    • \n

      \n Description: Your account is not signed up for the Amazon S3\n service. You must sign up before you can use Amazon S3. You can sign up at the\n following URL: Amazon S3\n

      \n
      • \n
    • \n

      \n HTTP Status Code: 403 Forbidden

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: OperationAborted

      \n
      • \n
    • \n

      \n Description: A conflicting conditional action is\n currently in progress against this resource. Try again.

      \n
      • \n
    • \n

      \n HTTP Status Code: 409 Conflict

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: PermanentRedirect

      \n
      • \n
    • \n

      \n Description: The bucket you are attempting to access\n must be addressed using the specified endpoint. Send all future requests to\n this endpoint.

      \n
      • \n
    • \n

      \n HTTP Status Code: 301 Moved Permanently

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: PreconditionFailed

      \n
      • \n
    • \n

      \n Description: At least one of the preconditions you\n specified did not hold.

      \n
      • \n
    • \n

      \n HTTP Status Code: 412 Precondition Failed

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: Redirect

      \n
      • \n
    • \n

      \n Description: Temporary redirect.

      \n
      • \n
    • \n

      \n HTTP Status Code: 307 Moved Temporarily

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: RestoreAlreadyInProgress

      \n
      • \n
    • \n

      \n Description: Object restore is already in\n progress.

      \n
      • \n
    • \n

      \n HTTP Status Code: 409 Conflict

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: RequestIsNotMultiPartContent

      \n
      • \n
    • \n

      \n Description: Bucket POST must be of the enclosure-type\n multipart/form-data.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: RequestTimeout

      \n
      • \n
    • \n

      \n Description: Your socket connection to the server was\n not read from or written to within the timeout period.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: RequestTimeTooSkewed

      \n
      • \n
    • \n

      \n Description: The difference between the request time\n and the server's time is too large.

      \n
      • \n
    • \n

      \n HTTP Status Code: 403 Forbidden

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: RequestTorrentOfBucketError

      \n
      • \n
    • \n

      \n Description: Requesting the torrent file of a bucket is\n not permitted.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: SignatureDoesNotMatch

      \n
      • \n
    • \n

      \n Description: The request signature we calculated does\n not match the signature you provided. Check your Amazon Web Services secret access key and\n signing method. For more information, see REST\n Authentication and SOAP\n Authentication for details.

      \n
      • \n
    • \n

      \n HTTP Status Code: 403 Forbidden

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: ServiceUnavailable

      \n
      • \n
    • \n

      \n Description: Service is unable to handle\n request.

      \n
      • \n
    • \n

      \n HTTP Status Code: 503 Service Unavailable

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Server

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: SlowDown

      \n
      • \n
    • \n

      \n Description: Reduce your request rate.

      \n
      • \n
    • \n

      \n HTTP Status Code: 503 Slow Down

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Server

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: TemporaryRedirect

      \n
      • \n
    • \n

      \n Description: You are being redirected to the bucket\n while DNS updates.

      \n
      • \n
    • \n

      \n HTTP Status Code: 307 Moved Temporarily

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: TokenRefreshRequired

      \n
      • \n
    • \n

      \n Description: The provided token must be\n refreshed.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: TooManyBuckets

      \n
      • \n
    • \n

      \n Description: You have attempted to create more buckets\n than allowed.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: UnexpectedContent

      \n
      • \n
    • \n

      \n Description: This request does not support\n content.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: UnresolvableGrantByEmailAddress

      \n
      • \n
    • \n

      \n Description: The email address you provided does not\n match any account on record.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: UserKeyMustBeSpecified

      \n
      • \n
    • \n

      \n Description: The bucket POST must contain the specified\n field name. If it is specified, check the order of the fields.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
\n

" + } + }, + "Message": { + "target": "com.amazonaws.s3#Message", + "traits": { + "smithy.api#documentation": "

The error message contains a generic description of the error condition in English. It\n is intended for a human audience. Simple programs display the message directly to the end\n user if they encounter an error condition they don't know how or don't care to handle.\n Sophisticated programs with more exhaustive error handling and proper internationalization\n are more likely to ignore the error message.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Container for all error elements.

" + } + }, + "com.amazonaws.s3#ErrorCode": { + "type": "string" + }, + "com.amazonaws.s3#ErrorDetails": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.s3#ErrorCode", + "traits": { + "smithy.api#documentation": "

\n If the CreateBucketMetadataTableConfiguration request succeeds, but S3 Metadata was \n unable to create the table, this structure contains the error code. The possible error codes and \n error messages are as follows:\n

\n
    \n
  • \n

    \n AccessDeniedCreatingResources - You don't have sufficient permissions to \n create the required resources. Make sure that you have s3tables:CreateNamespace, \n s3tables:CreateTable, s3tables:GetTable and \n s3tables:PutTablePolicy permissions, and then try again. To create a new metadata \n table, you must delete the metadata configuration for this bucket, and then create a new \n metadata configuration.\n

    \n
    • \n
  • \n

    \n AccessDeniedWritingToTable - Unable to write to the metadata table because of \n missing resource permissions. To fix the resource policy, Amazon S3 needs to create a new \n metadata table. To create a new metadata table, you must delete the metadata configuration for \n this bucket, and then create a new metadata configuration.

    \n
    • \n
  • \n

    \n DestinationTableNotFound - The destination table doesn't exist. To create a \n new metadata table, you must delete the metadata configuration for this bucket, and then \n create a new metadata configuration.

    \n
    • \n
  • \n

    \n ServerInternalError - An internal error has occurred. To create a new metadata \n table, you must delete the metadata configuration for this bucket, and then create a new \n metadata configuration.

    \n
    • \n
  • \n

    \n TableAlreadyExists - The table that you specified already exists in the table \n bucket's namespace. Specify a different table name. To create a new metadata table, you must \n delete the metadata configuration for this bucket, and then create a new metadata \n configuration.

    \n
    • \n
  • \n

    \n TableBucketNotFound - The table bucket that you specified doesn't exist in \n this Amazon Web Services Region and account. Create or choose a different table bucket. To create a new \n metadata table, you must delete the metadata configuration for this bucket, and then create \n a new metadata configuration.

    \n
    • \n
" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.s3#ErrorMessage", + "traits": { + "smithy.api#documentation": "

\n If the CreateBucketMetadataTableConfiguration request succeeds, but S3 Metadata was \n unable to create the table, this structure contains the error message. The possible error codes and \n error messages are as follows:\n

\n
    \n
  • \n

    \n AccessDeniedCreatingResources - You don't have sufficient permissions to \n create the required resources. Make sure that you have s3tables:CreateNamespace, \n s3tables:CreateTable, s3tables:GetTable and \n s3tables:PutTablePolicy permissions, and then try again. To create a new metadata \n table, you must delete the metadata configuration for this bucket, and then create a new \n metadata configuration.\n

    \n
    • \n
  • \n

    \n AccessDeniedWritingToTable - Unable to write to the metadata table because of \n missing resource permissions. To fix the resource policy, Amazon S3 needs to create a new \n metadata table. To create a new metadata table, you must delete the metadata configuration for \n this bucket, and then create a new metadata configuration.

    \n
    • \n
  • \n

    \n DestinationTableNotFound - The destination table doesn't exist. To create a \n new metadata table, you must delete the metadata configuration for this bucket, and then \n create a new metadata configuration.

    \n
    • \n
  • \n

    \n ServerInternalError - An internal error has occurred. To create a new metadata \n table, you must delete the metadata configuration for this bucket, and then create a new \n metadata configuration.

    \n
    • \n
  • \n

    \n TableAlreadyExists - The table that you specified already exists in the table \n bucket's namespace. Specify a different table name. To create a new metadata table, you must \n delete the metadata configuration for this bucket, and then create a new metadata \n configuration.

    \n
    • \n
  • \n

    \n TableBucketNotFound - The table bucket that you specified doesn't exist in \n this Amazon Web Services Region and account. Create or choose a different table bucket. To create a new \n metadata table, you must delete the metadata configuration for this bucket, and then create \n a new metadata configuration.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n If the CreateBucketMetadataTableConfiguration request succeeds, but S3 Metadata was \n unable to create the table, this structure contains the error code and error message.\n

" + } + }, + "com.amazonaws.s3#ErrorDocument": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

The object key name to use when a 4XX class error occurs.

\n \n

Replacement must be made for object keys containing special characters (such as carriage returns) when using \n XML requests. For more information, see \n XML related object key constraints.

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The error information.

" + } + }, + "com.amazonaws.s3#ErrorMessage": { + "type": "string" + }, + "com.amazonaws.s3#Errors": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#Error" + } + }, + "com.amazonaws.s3#Event": { + "type": "enum", + "members": { + "s3_ReducedRedundancyLostObject": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "s3:ReducedRedundancyLostObject" + } + }, + "s3_ObjectCreated_": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "s3:ObjectCreated:*" + } + }, + "s3_ObjectCreated_Put": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "s3:ObjectCreated:Put" + } + }, + "s3_ObjectCreated_Post": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "s3:ObjectCreated:Post" + } + }, + "s3_ObjectCreated_Copy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "s3:ObjectCreated:Copy" + } + }, + "s3_ObjectCreated_CompleteMultipartUpload": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "s3:ObjectCreated:CompleteMultipartUpload" + } + }, + "s3_ObjectRemoved_": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "s3:ObjectRemoved:*" + } + }, + "s3_ObjectRemoved_Delete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "s3:ObjectRemoved:Delete" + } + }, + "s3_ObjectRemoved_DeleteMarkerCreated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "s3:ObjectRemoved:DeleteMarkerCreated" + } + }, + "s3_ObjectRestore_": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "s3:ObjectRestore:*" + } + }, + "s3_ObjectRestore_Post": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "s3:ObjectRestore:Post" + } + }, + "s3_ObjectRestore_Completed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "s3:ObjectRestore:Completed" + } + }, + "s3_Replication_": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "s3:Replication:*" + } + }, + "s3_Replication_OperationFailedReplication": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "s3:Replication:OperationFailedReplication" + } + }, + "s3_Replication_OperationNotTracked": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "s3:Replication:OperationNotTracked" + } + }, + "s3_Replication_OperationMissedThreshold": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "s3:Replication:OperationMissedThreshold" + } + }, + "s3_Replication_OperationReplicatedAfterThreshold": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "s3:Replication:OperationReplicatedAfterThreshold" + } + }, + "s3_ObjectRestore_Delete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "s3:ObjectRestore:Delete" + } + }, + "s3_LifecycleTransition": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "s3:LifecycleTransition" + } + }, + "s3_IntelligentTiering": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "s3:IntelligentTiering" + } + }, + "s3_ObjectAcl_Put": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "s3:ObjectAcl:Put" + } + }, + "s3_LifecycleExpiration_": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "s3:LifecycleExpiration:*" + } + }, + "s3_LifecycleExpiration_Delete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "s3:LifecycleExpiration:Delete" + } + }, + "s3_LifecycleExpiration_DeleteMarkerCreated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "s3:LifecycleExpiration:DeleteMarkerCreated" + } + }, + "s3_ObjectTagging_": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "s3:ObjectTagging:*" + } + }, + "s3_ObjectTagging_Put": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "s3:ObjectTagging:Put" + } + }, + "s3_ObjectTagging_Delete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "s3:ObjectTagging:Delete" + } + } + }, + "traits": { + "smithy.api#documentation": "

The bucket event for which to send notifications.

" + } + }, + "com.amazonaws.s3#EventBridgeConfiguration": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

A container for specifying the configuration for Amazon EventBridge.

" + } + }, + "com.amazonaws.s3#EventList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#Event" + } + }, + "com.amazonaws.s3#ExistingObjectReplication": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.s3#ExistingObjectReplicationStatus", + "traits": { + "smithy.api#documentation": "

Specifies whether Amazon S3 replicates existing source bucket objects.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Optional configuration to replicate existing source bucket objects.

\n \n

This parameter is no longer supported. To replicate existing objects, see Replicating existing objects with S3 Batch Replication in the\n Amazon S3 User Guide.

\n " + } + }, + "com.amazonaws.s3#ExistingObjectReplicationStatus": { + "type": "enum", + "members": { + "Enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enabled" + } + }, + "Disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disabled" + } + } + } + }, + "com.amazonaws.s3#Expiration": { + "type": "string" + }, + "com.amazonaws.s3#ExpirationStatus": { + "type": "enum", + "members": { + "Enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enabled" + } + }, + "Disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disabled" + } + } + } + }, + "com.amazonaws.s3#ExpiredObjectDeleteMarker": { + "type": "boolean" + }, + "com.amazonaws.s3#Expires": { + "type": "timestamp" + }, + "com.amazonaws.s3#ExposeHeader": { + "type": "string" + }, + "com.amazonaws.s3#ExposeHeaders": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#ExposeHeader" + } + }, + "com.amazonaws.s3#Expression": { + "type": "string" + }, + "com.amazonaws.s3#ExpressionType": { + "type": "enum", + "members": { + "SQL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SQL" + } + } + } + }, + "com.amazonaws.s3#FetchOwner": { + "type": "boolean" + }, + "com.amazonaws.s3#FieldDelimiter": { + "type": "string" + }, + "com.amazonaws.s3#FileHeaderInfo": { + "type": "enum", + "members": { + "USE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USE" + } + }, + "IGNORE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IGNORE" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, + "com.amazonaws.s3#FilterRule": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.s3#FilterRuleName", + "traits": { + "smithy.api#documentation": "

The object key name prefix or suffix identifying one or more objects to which the\n filtering rule applies. The maximum length is 1,024 characters. Overlapping prefixes and\n suffixes are not supported. For more information, see Configuring Event Notifications\n in the Amazon S3 User Guide.

" + } + }, + "Value": { + "target": "com.amazonaws.s3#FilterRuleValue", + "traits": { + "smithy.api#documentation": "

The value that the filter searches for in object key names.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the Amazon S3 object key name to filter on. An object key name is the name assigned\n to an object in your Amazon S3 bucket. You specify whether to filter on the suffix or prefix of\n the object key name. A prefix is a specific string of characters at the beginning of an\n object key name, which you can use to organize objects. For example, you can start the key\n names of related objects with a prefix, such as 2023- or\n engineering/. Then, you can use FilterRule to find objects in\n a bucket with key names that have the same prefix. A suffix is similar to a prefix, but it\n is at the end of the object key name instead of at the beginning.

" + } + }, + "com.amazonaws.s3#FilterRuleList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#FilterRule" + }, + "traits": { + "smithy.api#documentation": "

A list of containers for the key-value pair that defines the criteria for the filter\n rule.

" + } + }, + "com.amazonaws.s3#FilterRuleName": { + "type": "enum", + "members": { + "prefix": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "prefix" + } + }, + "suffix": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "suffix" + } + } + } + }, + "com.amazonaws.s3#FilterRuleValue": { + "type": "string" + }, + "com.amazonaws.s3#GetBucketAccelerateConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetBucketAccelerateConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetBucketAccelerateConfigurationOutput" + }, + "traits": { + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

This implementation of the GET action uses the accelerate subresource to\n return the Transfer Acceleration state of a bucket, which is either Enabled or\n Suspended. Amazon S3 Transfer Acceleration is a bucket-level feature that\n enables you to perform faster data transfers to and from Amazon S3.

\n

To use this operation, you must have permission to perform the\n s3:GetAccelerateConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to your Amazon S3 Resources in the\n Amazon S3 User Guide.

\n

You set the Transfer Acceleration state of an existing bucket to Enabled or\n Suspended by using the PutBucketAccelerateConfiguration operation.

\n

A GET accelerate request does not return a state value for a bucket that\n has no transfer acceleration state. A bucket has no Transfer Acceleration state if a state\n has never been set on the bucket.

\n

For more information about transfer acceleration, see Transfer Acceleration in\n the Amazon S3 User Guide.

\n

The following operations are related to\n GetBucketAccelerateConfiguration:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?accelerate", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#GetBucketAccelerateConfigurationOutput": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.s3#BucketAccelerateStatus", + "traits": { + "smithy.api#documentation": "

The accelerate configuration of the bucket.

" + } + }, + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#xmlName": "AccelerateConfiguration" + } + }, + "com.amazonaws.s3#GetBucketAccelerateConfigurationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket for which the accelerate configuration is retrieved.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#GetBucketAcl": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetBucketAclRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetBucketAclOutput" + }, + "traits": { + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

This implementation of the GET action uses the acl subresource\n to return the access control list (ACL) of a bucket. To use GET to return the\n ACL of the bucket, you must have the READ_ACP access to the bucket. If\n READ_ACP permission is granted to the anonymous user, you can return the\n ACL of the bucket without using an authorization header.

\n

When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

\n

When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. \nIf the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. \nFor more information about InvalidAccessPointAliasError, see List of\n Error Codes.

\n \n

If your bucket uses the bucket owner enforced setting for S3 Object Ownership,\n requests to read ACLs are still supported and return the\n bucket-owner-full-control ACL with the owner being the account that\n created the bucket. For more information, see Controlling object\n ownership and disabling ACLs in the\n Amazon S3 User Guide.

\n \n

The following operations are related to GetBucketAcl:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?acl", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#GetBucketAclOutput": { + "type": "structure", + "members": { + "Owner": { + "target": "com.amazonaws.s3#Owner", + "traits": { + "smithy.api#documentation": "

Container for the bucket owner's display name and ID.

" + } + }, + "Grants": { + "target": "com.amazonaws.s3#Grants", + "traits": { + "smithy.api#documentation": "

A list of grants.

", + "smithy.api#xmlName": "AccessControlList" + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#xmlName": "AccessControlPolicy" + } + }, + "com.amazonaws.s3#GetBucketAclRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

Specifies the S3 bucket whose ACL is being requested.

\n

When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

\n

When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. \nIf the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. \nFor more information about InvalidAccessPointAliasError, see List of\n Error Codes.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#GetBucketAnalyticsConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetBucketAnalyticsConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetBucketAnalyticsConfigurationOutput" + }, + "traits": { + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

This implementation of the GET action returns an analytics configuration (identified by\n the analytics configuration ID) from the bucket.

\n

To use this operation, you must have permissions to perform the\n s3:GetAnalyticsConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources in the\n Amazon S3 User Guide.

\n

For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class\n Analysis in the Amazon S3 User Guide.

\n

The following operations are related to\n GetBucketAnalyticsConfiguration:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?analytics&x-id=GetBucketAnalyticsConfiguration", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#GetBucketAnalyticsConfigurationOutput": { + "type": "structure", + "members": { + "AnalyticsConfiguration": { + "target": "com.amazonaws.s3#AnalyticsConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration and any analyses for the analytics filter.

", + "smithy.api#httpPayload": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3#GetBucketAnalyticsConfigurationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket from which an analytics configuration is retrieved.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "Id": { + "target": "com.amazonaws.s3#AnalyticsId", + "traits": { + "smithy.api#documentation": "

The ID that identifies the analytics configuration.

", + "smithy.api#httpQuery": "id", + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#GetBucketCors": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetBucketCorsRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetBucketCorsOutput" + }, + "traits": { + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Returns the Cross-Origin Resource Sharing (CORS) configuration information set for the\n bucket.

\n

To use this operation, you must have permission to perform the\n s3:GetBucketCORS action. By default, the bucket owner has this permission\n and can grant it to others.

\n

When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

\n

When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. \nIf the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. \nFor more information about InvalidAccessPointAliasError, see List of\n Error Codes.

\n

For more information about CORS, see Enabling Cross-Origin Resource\n Sharing.

\n

The following operations are related to GetBucketCors:

\n ", + "smithy.api#examples": [ + { + "title": "To get cors configuration set on a bucket", + "documentation": "The following example returns cross-origin resource sharing (CORS) configuration set on a bucket.", + "input": { + "Bucket": "examplebucket" + }, + "output": { + "CORSRules": [ + { + "AllowedHeaders": [ + "Authorization" + ], + "MaxAgeSeconds": 3000, + "AllowedMethods": [ + "GET" + ], + "AllowedOrigins": [ + "*" + ] + } + ] + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?cors", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#GetBucketCorsOutput": { + "type": "structure", + "members": { + "CORSRules": { + "target": "com.amazonaws.s3#CORSRules", + "traits": { + "smithy.api#documentation": "

A set of origins and methods (cross-origin access that you want to allow). You can add\n up to 100 rules to the configuration.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "CORSRule" + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#xmlName": "CORSConfiguration" + } + }, + "com.amazonaws.s3#GetBucketCorsRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name for which to get the cors configuration.

\n

When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

\n

When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. \nIf the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. \nFor more information about InvalidAccessPointAliasError, see List of\n Error Codes.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#GetBucketEncryption": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetBucketEncryptionRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetBucketEncryptionOutput" + }, + "traits": { + "smithy.api#documentation": "

Returns the default encryption configuration for an Amazon S3 bucket. By default, all buckets\n have a default encryption configuration that uses server-side encryption with Amazon S3 managed\n keys (SSE-S3).

\n \n \n \n
\n
Permissions
\n
\n
    \n
  • \n

    \n General purpose bucket permissions - The\n s3:GetEncryptionConfiguration permission is required in a\n policy. The bucket owner has this permission by default. The bucket owner\n can grant this permission to others. For more information about permissions,\n see Permissions Related to Bucket Operations and Managing Access\n Permissions to Your Amazon S3 Resources.

    \n
    • \n
  • \n

    \n Directory bucket permissions -\n To grant access to this API operation, you must have the\n s3express:GetEncryptionConfiguration permission in\n an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource.\n For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

    \n
    • \n
\n
\n
HTTP Host header syntax
\n
\n

\n Directory buckets - The HTTP Host header syntax is s3express-control.region-code.amazonaws.com.

\n
\n
\n

The following operations are related to GetBucketEncryption:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?encryption", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#GetBucketEncryptionOutput": { + "type": "structure", + "members": { + "ServerSideEncryptionConfiguration": { + "target": "com.amazonaws.s3#ServerSideEncryptionConfiguration", + "traits": { + "smithy.api#httpPayload": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3#GetBucketEncryptionRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket from which the server-side encryption configuration is\n retrieved.

\n

\n Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name\n . Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide\n

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

\n \n

For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code \n501 Not Implemented.

\n ", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#GetBucketIntelligentTieringConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetBucketIntelligentTieringConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetBucketIntelligentTieringConfigurationOutput" + }, + "traits": { + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Gets the S3 Intelligent-Tiering configuration from the specified bucket.

\n

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.

\n

The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.

\n

For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

\n

Operations related to GetBucketIntelligentTieringConfiguration include:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?intelligent-tiering&x-id=GetBucketIntelligentTieringConfiguration", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#GetBucketIntelligentTieringConfigurationOutput": { + "type": "structure", + "members": { + "IntelligentTieringConfiguration": { + "target": "com.amazonaws.s3#IntelligentTieringConfiguration", + "traits": { + "smithy.api#documentation": "

Container for S3 Intelligent-Tiering configuration.

", + "smithy.api#httpPayload": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3#GetBucketIntelligentTieringConfigurationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "Id": { + "target": "com.amazonaws.s3#IntelligentTieringId", + "traits": { + "smithy.api#documentation": "

The ID used to identify the S3 Intelligent-Tiering configuration.

", + "smithy.api#httpQuery": "id", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#GetBucketInventoryConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetBucketInventoryConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetBucketInventoryConfigurationOutput" + }, + "traits": { + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Returns an inventory configuration (identified by the inventory configuration ID) from\n the bucket.

\n

To use this operation, you must have permissions to perform the\n s3:GetInventoryConfiguration action. The bucket owner has this permission\n by default and can grant this permission to others. For more information about permissions,\n see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.

\n

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.

\n

The following operations are related to\n GetBucketInventoryConfiguration:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?inventory&x-id=GetBucketInventoryConfiguration", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#GetBucketInventoryConfigurationOutput": { + "type": "structure", + "members": { + "InventoryConfiguration": { + "target": "com.amazonaws.s3#InventoryConfiguration", + "traits": { + "smithy.api#documentation": "

Specifies the inventory configuration.

", + "smithy.api#httpPayload": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3#GetBucketInventoryConfigurationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket containing the inventory configuration to retrieve.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "Id": { + "target": "com.amazonaws.s3#InventoryId", + "traits": { + "smithy.api#documentation": "

The ID used to identify the inventory configuration.

", + "smithy.api#httpQuery": "id", + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#GetBucketLifecycleConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetBucketLifecycleConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetBucketLifecycleConfigurationOutput" + }, + "traits": { + "smithy.api#documentation": "

Returns the lifecycle configuration information set on the bucket. For information about\n lifecycle configuration, see Object Lifecycle\n Management.

\n

Bucket lifecycle configuration now supports specifying a lifecycle rule using an object\n key name prefix, one or more object tags, object size, or any combination of these.\n Accordingly, this section describes the latest API, which is compatible with the new\n functionality. The previous version of the API supported filtering based only on an object\n key name prefix, which is supported for general purpose buckets for backward compatibility.\n For the related API description, see GetBucketLifecycle.

\n \n

Lifecyle configurations for directory buckets only support expiring objects and\n cancelling multipart uploads. Expiring of versioned objects, transitions and tag filters\n are not supported.

\n \n
\n
Permissions
\n
\n
    \n
  • \n

    \n General purpose bucket permissions - By\n default, all Amazon S3 resources are private, including buckets, objects, and\n related subresources (for example, lifecycle configuration and website\n configuration). Only the resource owner (that is, the Amazon Web Services account that\n created it) can access the resource. The resource owner can optionally grant\n access permissions to others by writing an access policy. For this\n operation, a user must have the s3:GetLifecycleConfiguration\n permission.

    \n

    For more information about permissions, see Managing Access\n Permissions to Your Amazon S3 Resources.

    \n
    • \n
\n
    \n
  • \n

    \n Directory bucket permissions -\n You must have the s3express:GetLifecycleConfiguration\n permission in an IAM identity-based policy to use this operation.\n Cross-account access to this API operation isn't supported. The resource\n owner can optionally grant access permissions to others by creating a role\n or user for them as long as they are within the same account as the owner\n and resource.

    \n

    For more information about directory bucket policies and permissions, see\n Authorizing Regional endpoint APIs with IAM in the\n Amazon S3 User Guide.

    \n \n

    \n Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name\n . Virtual-hosted-style requests aren't supported. \nFor more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the\n Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the\n Amazon S3 User Guide.

    \n     \n
    • \n
\n
\n
HTTP Host header syntax
\n
\n

\n Directory buckets - The HTTP Host\n header syntax is\n s3express-control.region.amazonaws.com.

\n
\n
\n

\n GetBucketLifecycleConfiguration has the following special error:

\n
    \n
  • \n

    Error code: NoSuchLifecycleConfiguration\n

    \n
      \n
    • \n

      Description: The lifecycle configuration does not exist.

      \n
      • \n
    • \n

      HTTP Status Code: 404 Not Found

      \n
      • \n
    • \n

      SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
\n

The following operations are related to\n GetBucketLifecycleConfiguration:

\n ", + "smithy.api#examples": [ + { + "title": "To get lifecycle configuration on a bucket", + "documentation": "The following example retrieves lifecycle configuration on set on a bucket. ", + "input": { + "Bucket": "examplebucket" + }, + "output": { + "Rules": [ + { + "Prefix": "TaxDocs", + "Status": "Enabled", + "Transitions": [ + { + "Days": 365, + "StorageClass": "STANDARD_IA" + } + ], + "ID": "Rule for TaxDocs/" + } + ] + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?lifecycle", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#GetBucketLifecycleConfigurationOutput": { + "type": "structure", + "members": { + "Rules": { + "target": "com.amazonaws.s3#LifecycleRules", + "traits": { + "smithy.api#documentation": "

Container for a lifecycle rule.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Rule" + } + }, + "TransitionDefaultMinimumObjectSize": { + "target": "com.amazonaws.s3#TransitionDefaultMinimumObjectSize", + "traits": { + "smithy.api#documentation": "

Indicates which default minimum object size behavior is applied to the lifecycle\n configuration.

\n \n

This parameter applies to general purpose buckets only. It is not supported for\n directory bucket lifecycle configurations.

\n \n
    \n
  • \n

    \n all_storage_classes_128K - Objects smaller than 128 KB will not\n transition to any storage class by default.

    \n
    • \n
  • \n

    \n varies_by_storage_class - Objects smaller than 128 KB will\n transition to Glacier Flexible Retrieval or Glacier Deep Archive storage classes. By\n default, all other storage classes will prevent transitions smaller than 128 KB.\n

    \n
    • \n
\n

To customize the minimum object size for any transition you can add a filter that\n specifies a custom ObjectSizeGreaterThan or ObjectSizeLessThan in\n the body of your transition rule. Custom filters always take precedence over the default\n transition behavior.

", + "smithy.api#httpHeader": "x-amz-transition-default-minimum-object-size" + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#xmlName": "LifecycleConfiguration" + } + }, + "com.amazonaws.s3#GetBucketLifecycleConfigurationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket for which to get the lifecycle information.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

\n \n

This parameter applies to general purpose buckets only. It is not supported for\n directory bucket lifecycle configurations.

\n ", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#GetBucketLocation": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetBucketLocationRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetBucketLocationOutput" + }, + "traits": { + "aws.customizations#s3UnwrappedXmlOutput": {}, + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Returns the Region the bucket resides in. You set the bucket's Region using the\n LocationConstraint request parameter in a CreateBucket\n request. For more information, see CreateBucket.

\n

When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

\n

When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. \nIf the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. \nFor more information about InvalidAccessPointAliasError, see List of\n Error Codes.

\n \n

We recommend that you use HeadBucket to return the Region\n that a bucket resides in. For backward compatibility, Amazon S3 continues to support\n GetBucketLocation.

\n \n

The following operations are related to GetBucketLocation:

\n ", + "smithy.api#examples": [ + { + "title": "To get bucket location", + "documentation": "The following example returns bucket location.", + "input": { + "Bucket": "examplebucket" + }, + "output": { + "LocationConstraint": "us-west-2" + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?location", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#GetBucketLocationOutput": { + "type": "structure", + "members": { + "LocationConstraint": { + "target": "com.amazonaws.s3#BucketLocationConstraint", + "traits": { + "smithy.api#documentation": "

Specifies the Region where the bucket resides. For a list of all the Amazon S3 supported\n location constraints by Region, see Regions and Endpoints. Buckets in\n Region us-east-1 have a LocationConstraint of null.

" + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#xmlName": "LocationConstraint" + } + }, + "com.amazonaws.s3#GetBucketLocationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket for which to get the location.

\n

When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

\n

When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. \nIf the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. \nFor more information about InvalidAccessPointAliasError, see List of\n Error Codes.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#GetBucketLogging": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetBucketLoggingRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetBucketLoggingOutput" + }, + "traits": { + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Returns the logging status of a bucket and the permissions users have to view and modify\n that status.

\n

The following operations are related to GetBucketLogging:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?logging", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#GetBucketLoggingOutput": { + "type": "structure", + "members": { + "LoggingEnabled": { + "target": "com.amazonaws.s3#LoggingEnabled" + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#xmlName": "BucketLoggingStatus" + } + }, + "com.amazonaws.s3#GetBucketLoggingRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name for which to get the logging information.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#GetBucketMetadataTableConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetBucketMetadataTableConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetBucketMetadataTableConfigurationOutput" + }, + "traits": { + "smithy.api#documentation": "

\n Retrieves the metadata table configuration for a general purpose bucket. For more\n information, see Accelerating data\n discovery with S3 Metadata in the Amazon S3 User Guide.

\n
\n
Permissions
\n
\n

To use this operation, you must have the s3:GetBucketMetadataTableConfiguration permission. For more\n information, see Setting up\n permissions for configuring metadata tables in the\n Amazon S3 User Guide.

\n
\n
\n

The following operations are related to GetBucketMetadataTableConfiguration:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?metadataTable", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#GetBucketMetadataTableConfigurationOutput": { + "type": "structure", + "members": { + "GetBucketMetadataTableConfigurationResult": { + "target": "com.amazonaws.s3#GetBucketMetadataTableConfigurationResult", + "traits": { + "smithy.api#documentation": "

\n The metadata table configuration for the general purpose bucket.\n

", + "smithy.api#httpPayload": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3#GetBucketMetadataTableConfigurationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

\n The general purpose bucket that contains the metadata table configuration that you want to retrieve.\n

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

\n The expected owner of the general purpose bucket that you want to retrieve the metadata table configuration from.\n

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#GetBucketMetadataTableConfigurationResult": { + "type": "structure", + "members": { + "MetadataTableConfigurationResult": { + "target": "com.amazonaws.s3#MetadataTableConfigurationResult", + "traits": { + "smithy.api#documentation": "

\n The metadata table configuration for a general purpose bucket.\n

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.s3#MetadataTableStatus", + "traits": { + "smithy.api#documentation": "

\n The status of the metadata table. The status values are:\n

\n
    \n
  • \n

    \n CREATING - The metadata table is in the process of being created in the \n specified table bucket.

    \n
    • \n
  • \n

    \n ACTIVE - The metadata table has been created successfully and records \n are being delivered to the table.\n

    \n
    • \n
  • \n

    \n FAILED - Amazon S3 is unable to create the metadata table, or Amazon S3 is unable to deliver \n records. See ErrorDetails for details.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Error": { + "target": "com.amazonaws.s3#ErrorDetails", + "traits": { + "smithy.api#documentation": "

\n If the CreateBucketMetadataTableConfiguration request succeeds, but S3 Metadata was \n unable to create the table, this structure contains the error code and error message. \n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The metadata table configuration for a general purpose bucket.\n

" + } + }, + "com.amazonaws.s3#GetBucketMetricsConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetBucketMetricsConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetBucketMetricsConfigurationOutput" + }, + "traits": { + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Gets a metrics configuration (specified by the metrics configuration ID) from the\n bucket. Note that this doesn't include the daily storage metrics.

\n

To use this operation, you must have permissions to perform the\n s3:GetMetricsConfiguration action. The bucket owner has this permission by\n default. The bucket owner can grant this permission to others. For more information about\n permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.

\n

For information about CloudWatch request metrics for Amazon S3, see Monitoring\n Metrics with Amazon CloudWatch.

\n

The following operations are related to\n GetBucketMetricsConfiguration:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?metrics&x-id=GetBucketMetricsConfiguration", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#GetBucketMetricsConfigurationOutput": { + "type": "structure", + "members": { + "MetricsConfiguration": { + "target": "com.amazonaws.s3#MetricsConfiguration", + "traits": { + "smithy.api#documentation": "

Specifies the metrics configuration.

", + "smithy.api#httpPayload": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3#GetBucketMetricsConfigurationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket containing the metrics configuration to retrieve.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "Id": { + "target": "com.amazonaws.s3#MetricsId", + "traits": { + "smithy.api#documentation": "

The ID used to identify the metrics configuration. The ID has a 64 character limit and\n can only contain letters, numbers, periods, dashes, and underscores.

", + "smithy.api#httpQuery": "id", + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#GetBucketNotificationConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetBucketNotificationConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.s3#NotificationConfiguration" + }, + "traits": { + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Returns the notification configuration of a bucket.

\n

If notifications are not enabled on the bucket, the action returns an empty\n NotificationConfiguration element.

\n

By default, you must be the bucket owner to read the notification configuration of a\n bucket. However, the bucket owner can use a bucket policy to grant permission to other\n users to read this configuration with the s3:GetBucketNotification\n permission.

\n

When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

\n

When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. \nIf the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. \nFor more information about InvalidAccessPointAliasError, see List of\n Error Codes.

\n

For more information about setting and reading the notification configuration on a\n bucket, see Setting Up Notification of Bucket Events. For more information about bucket\n policies, see Using Bucket Policies.

\n

The following action is related to GetBucketNotification:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?notification", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#GetBucketNotificationConfigurationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket for which to get the notification configuration.

\n

When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

\n

When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. \nIf the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. \nFor more information about InvalidAccessPointAliasError, see List of\n Error Codes.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#GetBucketOwnershipControls": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetBucketOwnershipControlsRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetBucketOwnershipControlsOutput" + }, + "traits": { + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Retrieves OwnershipControls for an Amazon S3 bucket. To use this operation, you\n must have the s3:GetBucketOwnershipControls permission. For more information\n about Amazon S3 permissions, see Specifying permissions in a\n policy.

\n

For information about Amazon S3 Object Ownership, see Using Object\n Ownership.

\n

The following operations are related to GetBucketOwnershipControls:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?ownershipControls", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#GetBucketOwnershipControlsOutput": { + "type": "structure", + "members": { + "OwnershipControls": { + "target": "com.amazonaws.s3#OwnershipControls", + "traits": { + "smithy.api#documentation": "

The OwnershipControls (BucketOwnerEnforced, BucketOwnerPreferred, or\n ObjectWriter) currently in effect for this Amazon S3 bucket.

", + "smithy.api#httpPayload": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3#GetBucketOwnershipControlsRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the Amazon S3 bucket whose OwnershipControls you want to retrieve.\n

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#GetBucketPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetBucketPolicyRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetBucketPolicyOutput" + }, + "traits": { + "smithy.api#documentation": "

Returns the policy of a specified bucket.

\n \n

\n Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name\n . Virtual-hosted-style requests aren't supported. \nFor more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the\n Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the\n Amazon S3 User Guide.

\n \n
\n
Permissions
\n
\n

If you are using an identity other than the root user of the Amazon Web Services account that\n owns the bucket, the calling identity must both have the\n GetBucketPolicy permissions on the specified bucket and belong to\n the bucket owner's account in order to use this operation.

\n

If you don't have GetBucketPolicy permissions, Amazon S3 returns a\n 403 Access Denied error. If you have the correct permissions, but\n you're not using an identity that belongs to the bucket owner's account, Amazon S3\n returns a 405 Method Not Allowed error.

\n \n

To ensure that bucket owners don't inadvertently lock themselves out of\n their own buckets, the root principal in a bucket owner's Amazon Web Services account can\n perform the GetBucketPolicy, PutBucketPolicy, and\n DeleteBucketPolicy API actions, even if their bucket policy\n explicitly denies the root principal's access. Bucket owner root principals can\n only be blocked from performing these API actions by VPC endpoint policies and\n Amazon Web Services Organizations policies.

\n \n
    \n
  • \n

    \n General purpose bucket permissions - The\n s3:GetBucketPolicy permission is required in a policy. For\n more information about general purpose buckets bucket policies, see Using Bucket Policies and User Policies in the\n Amazon S3 User Guide.

    \n
    • \n
  • \n

    \n Directory bucket permissions -\n To grant access to this API operation, you must have the\n s3express:GetBucketPolicy permission in\n an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource.\n For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

    \n
    • \n
\n
\n
Example bucket policies
\n
\n

\n General purpose buckets example bucket policies\n - See Bucket policy\n examples in the Amazon S3 User Guide.

\n

\n Directory bucket example bucket policies\n - See Example bucket policies for S3 Express One Zone in the\n Amazon S3 User Guide.

\n
\n
HTTP Host header syntax
\n
\n

\n Directory buckets - The HTTP Host header syntax is s3express-control.region-code.amazonaws.com.

\n
\n
\n

The following action is related to GetBucketPolicy:

\n ", + "smithy.api#examples": [ + { + "title": "To get bucket policy", + "documentation": "The following example returns bucket policy associated with a bucket.", + "input": { + "Bucket": "examplebucket" + }, + "output": { + "Policy": "{\"Version\":\"2008-10-17\",\"Id\":\"LogPolicy\",\"Statement\":[{\"Sid\":\"Enables the log delivery group to publish logs to your bucket \",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"111122223333\"},\"Action\":[\"s3:GetBucketAcl\",\"s3:GetObjectAcl\",\"s3:PutObject\"],\"Resource\":[\"arn:aws:s3:::policytest1/*\",\"arn:aws:s3:::policytest1\"]}]}" + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?policy", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#GetBucketPolicyOutput": { + "type": "structure", + "members": { + "Policy": { + "target": "com.amazonaws.s3#Policy", + "traits": { + "smithy.api#documentation": "

The bucket policy as a JSON document.

", + "smithy.api#httpPayload": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3#GetBucketPolicyRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name to get the bucket policy for.

\n

\n Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name\n . Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide\n

\n

\n Access points - When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

\n

\n Object Lambda access points - When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. \nIf the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. \nFor more information about InvalidAccessPointAliasError, see List of\n Error Codes.

\n \n

Access points and Object Lambda access points are not supported by directory buckets.

\n ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

\n \n

For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code \n501 Not Implemented.

\n ", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#GetBucketPolicyStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetBucketPolicyStatusRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetBucketPolicyStatusOutput" + }, + "traits": { + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public.\n In order to use this operation, you must have the s3:GetBucketPolicyStatus\n permission. For more information about Amazon S3 permissions, see Specifying Permissions in a\n Policy.

\n

For more information about when Amazon S3 considers a bucket public, see The Meaning of \"Public\".

\n

The following operations are related to GetBucketPolicyStatus:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?policyStatus", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#GetBucketPolicyStatusOutput": { + "type": "structure", + "members": { + "PolicyStatus": { + "target": "com.amazonaws.s3#PolicyStatus", + "traits": { + "smithy.api#documentation": "

The policy status for the specified bucket.

", + "smithy.api#httpPayload": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3#GetBucketPolicyStatusRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the Amazon S3 bucket whose policy status you want to retrieve.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#GetBucketReplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetBucketReplicationRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetBucketReplicationOutput" + }, + "traits": { + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Returns the replication configuration of a bucket.

\n \n

It can take a while to propagate the put or delete a replication configuration to\n all Amazon S3 systems. Therefore, a get request soon after put or delete can return a wrong\n result.

\n \n

For information about replication configuration, see Replication in the\n Amazon S3 User Guide.

\n

This action requires permissions for the s3:GetReplicationConfiguration\n action. For more information about permissions, see Using Bucket Policies and User\n Policies.

\n

If you include the Filter element in a replication configuration, you must\n also include the DeleteMarkerReplication and Priority elements.\n The response also returns those elements.

\n

For information about GetBucketReplication errors, see List of\n replication-related error codes\n

\n

The following operations are related to GetBucketReplication:

\n ", + "smithy.api#examples": [ + { + "title": "To get replication configuration set on a bucket", + "documentation": "The following example returns replication configuration set on a bucket.", + "input": { + "Bucket": "examplebucket" + }, + "output": { + "ReplicationConfiguration": { + "Rules": [ + { + "Status": "Enabled", + "Prefix": "Tax", + "Destination": { + "Bucket": "arn:aws:s3:::destination-bucket" + }, + "ID": "MWIwNTkwZmItMTE3MS00ZTc3LWJkZDEtNzRmODQwYzc1OTQy" + } + ], + "Role": "arn:aws:iam::acct-id:role/example-role" + } + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?replication", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#GetBucketReplicationOutput": { + "type": "structure", + "members": { + "ReplicationConfiguration": { + "target": "com.amazonaws.s3#ReplicationConfiguration", + "traits": { + "smithy.api#httpPayload": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3#GetBucketReplicationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name for which to get the replication information.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#GetBucketRequestPayment": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetBucketRequestPaymentRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetBucketRequestPaymentOutput" + }, + "traits": { + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Returns the request payment configuration of a bucket. To use this version of the\n operation, you must be the bucket owner. For more information, see Requester Pays\n Buckets.

\n

The following operations are related to GetBucketRequestPayment:

\n ", + "smithy.api#examples": [ + { + "title": "To get bucket versioning configuration", + "documentation": "The following example retrieves bucket versioning configuration.", + "input": { + "Bucket": "examplebucket" + }, + "output": { + "Payer": "BucketOwner" + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?requestPayment", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#GetBucketRequestPaymentOutput": { + "type": "structure", + "members": { + "Payer": { + "target": "com.amazonaws.s3#Payer", + "traits": { + "smithy.api#documentation": "

Specifies who pays for the download and request fees.

" + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#xmlName": "RequestPaymentConfiguration" + } + }, + "com.amazonaws.s3#GetBucketRequestPaymentRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket for which to get the payment request configuration

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#GetBucketTagging": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetBucketTaggingRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetBucketTaggingOutput" + }, + "traits": { + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Returns the tag set associated with the bucket.

\n

To use this operation, you must have permission to perform the\n s3:GetBucketTagging action. By default, the bucket owner has this\n permission and can grant this permission to others.

\n

\n GetBucketTagging has the following special error:

\n
    \n
  • \n

    Error code: NoSuchTagSet\n

    \n
      \n
    • \n

      Description: There is no tag set associated with the bucket.

      \n
      • \n
    \n
    • \n
\n

The following operations are related to GetBucketTagging:

\n ", + "smithy.api#examples": [ + { + "title": "To get tag set associated with a bucket", + "documentation": "The following example returns tag set associated with a bucket", + "input": { + "Bucket": "examplebucket" + }, + "output": { + "TagSet": [ + { + "Value": "value1", + "Key": "key1" + }, + { + "Value": "value2", + "Key": "key2" + } + ] + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?tagging", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#GetBucketTaggingOutput": { + "type": "structure", + "members": { + "TagSet": { + "target": "com.amazonaws.s3#TagSet", + "traits": { + "smithy.api#documentation": "

Contains the tag set.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#xmlName": "Tagging" + } + }, + "com.amazonaws.s3#GetBucketTaggingRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket for which to get the tagging information.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#GetBucketVersioning": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetBucketVersioningRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetBucketVersioningOutput" + }, + "traits": { + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Returns the versioning state of a bucket.

\n

To retrieve the versioning state of a bucket, you must be the bucket owner.

\n

This implementation also returns the MFA Delete status of the versioning state. If the\n MFA Delete status is enabled, the bucket owner must use an authentication\n device to change the versioning state of the bucket.

\n

The following operations are related to GetBucketVersioning:

\n ", + "smithy.api#examples": [ + { + "title": "To get bucket versioning configuration", + "documentation": "The following example retrieves bucket versioning configuration.", + "input": { + "Bucket": "examplebucket" + }, + "output": { + "Status": "Enabled", + "MFADelete": "Disabled" + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?versioning", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#GetBucketVersioningOutput": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.s3#BucketVersioningStatus", + "traits": { + "smithy.api#documentation": "

The versioning state of the bucket.

" + } + }, + "MFADelete": { + "target": "com.amazonaws.s3#MFADeleteStatus", + "traits": { + "smithy.api#documentation": "

Specifies whether MFA delete is enabled in the bucket versioning configuration. This\n element is only returned if the bucket has been configured with MFA delete. If the bucket\n has never been so configured, this element is not returned.

", + "smithy.api#xmlName": "MfaDelete" + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#xmlName": "VersioningConfiguration" + } + }, + "com.amazonaws.s3#GetBucketVersioningRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket for which to get the versioning information.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#GetBucketWebsite": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetBucketWebsiteRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetBucketWebsiteOutput" + }, + "traits": { + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Returns the website configuration for a bucket. To host website on Amazon S3, you can\n configure a bucket as website by adding a website configuration. For more information about\n hosting websites, see Hosting Websites on Amazon S3.

\n

This GET action requires the S3:GetBucketWebsite permission. By default,\n only the bucket owner can read the bucket website configuration. However, bucket owners can\n allow other users to read the website configuration by writing a bucket policy granting\n them the S3:GetBucketWebsite permission.

\n

The following operations are related to GetBucketWebsite:

\n ", + "smithy.api#examples": [ + { + "title": "To get bucket website configuration", + "documentation": "The following example retrieves website configuration of a bucket.", + "input": { + "Bucket": "examplebucket" + }, + "output": { + "IndexDocument": { + "Suffix": "index.html" + }, + "ErrorDocument": { + "Key": "error.html" + } + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?website", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#GetBucketWebsiteOutput": { + "type": "structure", + "members": { + "RedirectAllRequestsTo": { + "target": "com.amazonaws.s3#RedirectAllRequestsTo", + "traits": { + "smithy.api#documentation": "

Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3\n bucket.

" + } + }, + "IndexDocument": { + "target": "com.amazonaws.s3#IndexDocument", + "traits": { + "smithy.api#documentation": "

The name of the index document for the website (for example\n index.html).

" + } + }, + "ErrorDocument": { + "target": "com.amazonaws.s3#ErrorDocument", + "traits": { + "smithy.api#documentation": "

The object key name of the website error document to use for 4XX class errors.

" + } + }, + "RoutingRules": { + "target": "com.amazonaws.s3#RoutingRules", + "traits": { + "smithy.api#documentation": "

Rules that define when a redirect is applied and the redirect behavior.

" + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#xmlName": "WebsiteConfiguration" + } + }, + "com.amazonaws.s3#GetBucketWebsiteRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name for which to get the website configuration.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#GetObject": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetObjectRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetObjectOutput" + }, + "errors": [ + { + "target": "com.amazonaws.s3#InvalidObjectState" + }, + { + "target": "com.amazonaws.s3#NoSuchKey" + } + ], + "traits": { + "aws.protocols#httpChecksum": { + "requestValidationModeMember": "ChecksumMode", + "responseAlgorithms": [ + "CRC32", + "CRC32C", + "SHA256", + "SHA1" + ] + }, + "smithy.api#documentation": "

Retrieves an object from Amazon S3.

\n

In the GetObject request, specify the full key name for the object.

\n

\n General purpose buckets - Both the virtual-hosted-style\n requests and the path-style requests are supported. For a virtual hosted-style request\n example, if you have the object photos/2006/February/sample.jpg, specify the\n object key name as /photos/2006/February/sample.jpg. For a path-style request\n example, if you have the object photos/2006/February/sample.jpg in the bucket\n named examplebucket, specify the object key name as\n /examplebucket/photos/2006/February/sample.jpg. For more information about\n request types, see HTTP Host\n Header Bucket Specification in the Amazon S3 User Guide.

\n

\n Directory buckets -\n Only virtual-hosted-style requests are supported. For a virtual hosted-style request example, if you have the object photos/2006/February/sample.jpg in the bucket named examplebucket--use1-az5--x-s3, specify the object key name as /photos/2006/February/sample.jpg. Also, when you make requests to this API operation, your requests are sent to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket-name.s3express-zone-id.region-code.amazonaws.com/key-name\n . Path-style requests are not supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the\n Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the\n Amazon S3 User Guide.

\n
\n
Permissions
\n
\n
    \n
  • \n

    \n General purpose bucket permissions - You\n must have the required permissions in a policy. To use\n GetObject, you must have the READ access to the\n object (or version). If you grant READ access to the anonymous\n user, the GetObject operation returns the object without using\n an authorization header. For more information, see Specifying permissions in a policy in the\n Amazon S3 User Guide.

    \n

    If you include a versionId in your request header, you must\n have the s3:GetObjectVersion permission to access a specific\n version of an object. The s3:GetObject permission is not\n required in this scenario.

    \n

    If you request the current version of an object without a specific\n versionId in the request header, only the\n s3:GetObject permission is required. The\n s3:GetObjectVersion permission is not required in this\n scenario.

    \n

    If the object that you request doesn’t exist, the error that Amazon S3 returns\n depends on whether you also have the s3:ListBucket\n permission.

    \n
      \n
    • \n

      If you have the s3:ListBucket permission on the\n bucket, Amazon S3 returns an HTTP status code 404 Not Found\n error.

      \n
      • \n
    • \n

      If you don’t have the s3:ListBucket permission, Amazon S3\n returns an HTTP status code 403 Access Denied\n error.

      \n
      • \n
    \n
    • \n
  • \n

    \n Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the \n CreateSession\n API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. \nAmazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see \n CreateSession\n .

    \n

    If\n the\n object is encrypted using SSE-KMS, you must also have the\n kms:GenerateDataKey and kms:Decrypt permissions\n in IAM identity-based policies and KMS key policies for the KMS\n key.

    \n
    • \n
\n
\n
Storage classes
\n
\n

If the object you are retrieving is stored in the S3 Glacier Flexible Retrieval\n storage class, the S3 Glacier Deep Archive storage class, the\n S3 Intelligent-Tiering Archive Access tier, or the S3 Intelligent-Tiering Deep Archive Access tier,\n before you can retrieve the object you must first restore a copy using RestoreObject. Otherwise, this operation returns an\n InvalidObjectState error. For information about restoring archived\n objects, see Restoring Archived\n Objects in the Amazon S3 User Guide.

\n

\n Directory buckets -\n For directory buckets, only the S3 Express One Zone storage class is supported to store newly created objects. \nUnsupported storage class values won't write a destination object and will respond with the HTTP status code 400 Bad Request.

\n
\n
Encryption
\n
\n

Encryption request headers, like x-amz-server-side-encryption,\n should not be sent for the GetObject requests, if your object uses\n server-side encryption with Amazon S3 managed encryption keys (SSE-S3), server-side\n encryption with Key Management Service (KMS) keys (SSE-KMS), or dual-layer server-side\n encryption with Amazon Web Services KMS keys (DSSE-KMS). If you include the header in your\n GetObject requests for the object that uses these types of keys,\n you’ll get an HTTP 400 Bad Request error.

\n

\n Directory buckets -\n For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS. SSE-C isn't supported. For more\n information, see Protecting data with server-side encryption in the Amazon S3 User Guide.

\n
\n
Overriding response header values through the request
\n
\n

There are times when you want to override certain response header values of a\n GetObject response. For example, you might override the\n Content-Disposition response header value through your\n GetObject request.

\n

You can override values for a set of response headers. These modified response\n header values are included only in a successful response, that is, when the HTTP\n status code 200 OK is returned. The headers you can override using\n the following query parameters in the request are a subset of the headers that\n Amazon S3 accepts when you create an object.

\n

The response headers that you can override for the GetObject\n response are Cache-Control, Content-Disposition,\n Content-Encoding, Content-Language,\n Content-Type, and Expires.

\n

To override values for a set of response headers in the GetObject\n response, you can use the following query parameters in the request.

\n
    \n
  • \n

    \n response-cache-control\n

    \n
    • \n
  • \n

    \n response-content-disposition\n

    \n
    • \n
  • \n

    \n response-content-encoding\n

    \n
    • \n
  • \n

    \n response-content-language\n

    \n
    • \n
  • \n

    \n response-content-type\n

    \n
    • \n
  • \n

    \n response-expires\n

    \n
    • \n
\n \n

When you use these parameters, you must sign the request by using either an\n Authorization header or a presigned URL. These parameters cannot be used with\n an unsigned (anonymous) request.

\n \n
\n
HTTP Host header syntax
\n
\n

\n Directory buckets - The HTTP Host header syntax is \n Bucket-name.s3express-zone-id.region-code.amazonaws.com.

\n
\n
\n

The following operations are related to GetObject:

\n ", + "smithy.api#examples": [ + { + "title": "To retrieve a byte range of an object ", + "documentation": "The following example retrieves an object for an S3 bucket. The request specifies the range header to retrieve a specific byte range.", + "input": { + "Bucket": "examplebucket", + "Key": "SampleFile.txt", + "Range": "bytes=0-9" + }, + "output": { + "AcceptRanges": "bytes", + "ContentType": "text/plain", + "LastModified": "2014-10-09T22:57:28.000Z", + "ContentLength": 10, + "VersionId": "null", + "ETag": "\"0d94420ffd0bc68cd3d152506b97a9cc\"", + "ContentRange": "bytes 0-9/43", + "Metadata": {} + } + }, + { + "title": "To retrieve an object", + "documentation": "The following example retrieves an object for an S3 bucket.", + "input": { + "Bucket": "examplebucket", + "Key": "HappyFace.jpg" + }, + "output": { + "AcceptRanges": "bytes", + "ContentType": "image/jpeg", + "LastModified": "2016-12-15T01:19:41.000Z", + "ContentLength": 3191, + "VersionId": "null", + "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", + "TagCount": 2, + "Metadata": {} + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}/{Key+}?x-id=GetObject", + "code": 200 + } + } + }, + "com.amazonaws.s3#GetObjectAcl": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetObjectAclRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetObjectAclOutput" + }, + "errors": [ + { + "target": "com.amazonaws.s3#NoSuchKey" + } + ], + "traits": { + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Returns the access control list (ACL) of an object. To use this operation, you must have\n s3:GetObjectAcl permissions or READ_ACP access to the object.\n For more information, see Mapping of ACL permissions and access policy permissions in the Amazon S3\n User Guide\n

\n

This functionality is not supported for Amazon S3 on Outposts.

\n

By default, GET returns ACL information about the current version of an object. To\n return ACL information about a different version, use the versionId subresource.

\n \n

If your bucket uses the bucket owner enforced setting for S3 Object Ownership,\n requests to read ACLs are still supported and return the\n bucket-owner-full-control ACL with the owner being the account that\n created the bucket. For more information, see Controlling object\n ownership and disabling ACLs in the\n Amazon S3 User Guide.

\n \n

The following operations are related to GetObjectAcl:

\n ", + "smithy.api#examples": [ + { + "title": "To retrieve object ACL", + "documentation": "The following example retrieves access control list (ACL) of an object.", + "input": { + "Bucket": "examplebucket", + "Key": "HappyFace.jpg" + }, + "output": { + "Owner": { + "DisplayName": "owner-display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + }, + "Grants": [ + { + "Grantee": { + "Type": "CanonicalUser", + "DisplayName": "owner-display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + }, + "Permission": "WRITE" + }, + { + "Grantee": { + "Type": "CanonicalUser", + "DisplayName": "owner-display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + }, + "Permission": "WRITE_ACP" + }, + { + "Grantee": { + "Type": "CanonicalUser", + "DisplayName": "owner-display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + }, + "Permission": "READ" + }, + { + "Grantee": { + "Type": "CanonicalUser", + "DisplayName": "owner-display-name", + "ID": "852b113eexamplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + }, + "Permission": "READ_ACP" + } + ] + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}/{Key+}?acl", + "code": 200 + } + } + }, + "com.amazonaws.s3#GetObjectAclOutput": { + "type": "structure", + "members": { + "Owner": { + "target": "com.amazonaws.s3#Owner", + "traits": { + "smithy.api#documentation": "

Container for the bucket owner's display name and ID.

" + } + }, + "Grants": { + "target": "com.amazonaws.s3#Grants", + "traits": { + "smithy.api#documentation": "

A list of grants.

", + "smithy.api#xmlName": "AccessControlList" + } + }, + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#xmlName": "AccessControlPolicy" + } + }, + "com.amazonaws.s3#GetObjectAclRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name that contains the object for which to get the ACL information.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

The key of the object for which to get the ACL information.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Key" + } + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

Version ID used to reference a specific version of the object.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpQuery": "versionId" + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#GetObjectAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetObjectAttributesRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetObjectAttributesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.s3#NoSuchKey" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves all the metadata from an object without returning the object itself. This\n operation is useful if you're interested only in an object's metadata.

\n

\n GetObjectAttributes combines the functionality of HeadObject\n and ListParts. All of the data returned with each of those individual calls\n can be returned with a single call to GetObjectAttributes.

\n \n

\n Directory buckets -\n For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket-name.s3express-zone-id.region-code.amazonaws.com/key-name\n . Path-style requests are not supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the\n Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the\n Amazon S3 User Guide.

\n \n
\n
Permissions
\n
\n
    \n
  • \n

    \n General purpose bucket permissions - To\n use GetObjectAttributes, you must have READ access to the\n object. The permissions that you need to use this operation depend on\n whether the bucket is versioned. If the bucket is versioned, you need both\n the s3:GetObjectVersion and\n s3:GetObjectVersionAttributes permissions for this\n operation. If the bucket is not versioned, you need the\n s3:GetObject and s3:GetObjectAttributes\n permissions. For more information, see Specifying\n Permissions in a Policy in the\n Amazon S3 User Guide. If the object that you request does\n not exist, the error Amazon S3 returns depends on whether you also have the\n s3:ListBucket permission.

    \n
      \n
    • \n

      If you have the s3:ListBucket permission on the\n bucket, Amazon S3 returns an HTTP status code 404 Not Found\n (\"no such key\") error.

      \n
      • \n
    • \n

      If you don't have the s3:ListBucket permission, Amazon S3\n returns an HTTP status code 403 Forbidden (\"access\n denied\") error.

      \n
      • \n
    \n
    • \n
  • \n

    \n Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the \n CreateSession\n API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. \nAmazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see \n CreateSession\n .

    \n

    If\n the\n object is encrypted with SSE-KMS, you must also have the\n kms:GenerateDataKey and kms:Decrypt permissions\n in IAM identity-based policies and KMS key policies for the KMS\n key.

    \n
    • \n
\n
\n
Encryption
\n
\n \n

Encryption request headers, like x-amz-server-side-encryption,\n should not be sent for HEAD requests if your object uses\n server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer\n server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side\n encryption with Amazon S3 managed encryption keys (SSE-S3). The\n x-amz-server-side-encryption header is used when you\n PUT an object to S3 and want to specify the encryption method.\n If you include this header in a GET request for an object that\n uses these types of keys, you’ll get an HTTP 400 Bad Request\n error. It's because the encryption method can't be changed when you retrieve\n the object.

\n \n

If you encrypt an object by using server-side encryption with customer-provided\n encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve\n the metadata from the object, you must use the following headers to provide the\n encryption key for the server to be able to retrieve the object's metadata. The\n headers are:

\n
    \n
  • \n

    \n x-amz-server-side-encryption-customer-algorithm\n

    \n
    • \n
  • \n

    \n x-amz-server-side-encryption-customer-key\n

    \n
    • \n
  • \n

    \n x-amz-server-side-encryption-customer-key-MD5\n

    \n
    • \n
\n

For more information about SSE-C, see Server-Side\n Encryption (Using Customer-Provided Encryption Keys) in the\n Amazon S3 User Guide.

\n \n

\n Directory bucket permissions -\n For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (aws:kms). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your \n CreateSession requests or PUT object requests. Then, new objects \n are automatically encrypted with the desired encryption settings. For more\n information, see Protecting data with server-side encryption in the Amazon S3 User Guide. For more information about the encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.

\n \n
\n
Versioning
\n
\n

\n Directory buckets -\n S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the null value of the version ID is supported by directory buckets. You can only specify null to the\n versionId query parameter in the request.

\n
\n
Conditional request headers
\n
\n

Consider the following when using request headers:

\n
    \n
  • \n

    If both of the If-Match and If-Unmodified-Since\n headers are present in the request as follows, then Amazon S3 returns the HTTP\n status code 200 OK and the data requested:

    \n
      \n
    • \n

      \n If-Match condition evaluates to\n true.

      \n
      • \n
    • \n

      \n If-Unmodified-Since condition evaluates to\n false.

      \n
      • \n
    \n

    For more information about conditional requests, see RFC 7232.

    \n
    • \n
  • \n

    If both of the If-None-Match and\n If-Modified-Since headers are present in the request as\n follows, then Amazon S3 returns the HTTP status code 304 Not\n Modified:

    \n
      \n
    • \n

      \n If-None-Match condition evaluates to\n false.

      \n
      • \n
    • \n

      \n If-Modified-Since condition evaluates to\n true.

      \n
      • \n
    \n

    For more information about conditional requests, see RFC 7232.

    \n
    • \n
\n
\n
HTTP Host header syntax
\n
\n

\n Directory buckets - The HTTP Host header syntax is \n Bucket-name.s3express-zone-id.region-code.amazonaws.com.

\n
\n
\n

The following actions are related to GetObjectAttributes:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}/{Key+}?attributes", + "code": 200 + } + } + }, + "com.amazonaws.s3#GetObjectAttributesOutput": { + "type": "structure", + "members": { + "DeleteMarker": { + "target": "com.amazonaws.s3#DeleteMarker", + "traits": { + "smithy.api#documentation": "

Specifies whether the object retrieved was (true) or was not\n (false) a delete marker. If false, this response header does\n not appear in the response.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-delete-marker" + } + }, + "LastModified": { + "target": "com.amazonaws.s3#LastModified", + "traits": { + "smithy.api#documentation": "

Date and time when the object was last modified.

", + "smithy.api#httpHeader": "Last-Modified" + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

The version ID of the object.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-version-id" + } + }, + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" + } + }, + "ETag": { + "target": "com.amazonaws.s3#ETag", + "traits": { + "smithy.api#documentation": "

An ETag is an opaque identifier assigned by a web server to a specific version of a\n resource found at a URL.

" + } + }, + "Checksum": { + "target": "com.amazonaws.s3#Checksum", + "traits": { + "smithy.api#documentation": "

The checksum or digest of the object.

" + } + }, + "ObjectParts": { + "target": "com.amazonaws.s3#GetObjectAttributesParts", + "traits": { + "smithy.api#documentation": "

A collection of parts associated with a multipart upload.

" + } + }, + "StorageClass": { + "target": "com.amazonaws.s3#StorageClass", + "traits": { + "smithy.api#documentation": "

Provides the storage class information of the object. Amazon S3 returns this header for all\n objects except for S3 Standard storage class objects.

\n

For more information, see Storage Classes.

\n \n

\n Directory buckets -\n Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

\n " + } + }, + "ObjectSize": { + "target": "com.amazonaws.s3#ObjectSize", + "traits": { + "smithy.api#documentation": "

The size of the object in bytes.

" + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#xmlName": "GetObjectAttributesResponse" + } + }, + "com.amazonaws.s3#GetObjectAttributesParts": { + "type": "structure", + "members": { + "TotalPartsCount": { + "target": "com.amazonaws.s3#PartsCount", + "traits": { + "smithy.api#documentation": "

The total number of parts.

", + "smithy.api#xmlName": "PartsCount" + } + }, + "PartNumberMarker": { + "target": "com.amazonaws.s3#PartNumberMarker", + "traits": { + "smithy.api#documentation": "

The marker for the current part.

" + } + }, + "NextPartNumberMarker": { + "target": "com.amazonaws.s3#NextPartNumberMarker", + "traits": { + "smithy.api#documentation": "

When a list is truncated, this element specifies the last part in the list, as well as\n the value to use for the PartNumberMarker request parameter in a subsequent\n request.

" + } + }, + "MaxParts": { + "target": "com.amazonaws.s3#MaxParts", + "traits": { + "smithy.api#documentation": "

The maximum number of parts allowed in the response.

" + } + }, + "IsTruncated": { + "target": "com.amazonaws.s3#IsTruncated", + "traits": { + "smithy.api#documentation": "

Indicates whether the returned list of parts is truncated. A value of true\n indicates that the list was truncated. A list can be truncated if the number of parts\n exceeds the limit returned in the MaxParts element.

" + } + }, + "Parts": { + "target": "com.amazonaws.s3#PartsList", + "traits": { + "smithy.api#documentation": "

A container for elements related to a particular part. A response can contain zero or\n more Parts elements.

\n \n
    \n
  • \n

    \n General purpose buckets - For\n GetObjectAttributes, if a additional checksum (including\n x-amz-checksum-crc32, x-amz-checksum-crc32c,\n x-amz-checksum-sha1, or x-amz-checksum-sha256) isn't\n applied to the object specified in the request, the response doesn't return\n Part.

    \n
    • \n
  • \n

    \n Directory buckets - For\n GetObjectAttributes, no matter whether a additional checksum is\n applied to the object specified in the request, the response returns\n Part.

    \n
    • \n
\n ", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Part" + } + } + }, + "traits": { + "smithy.api#documentation": "

A collection of parts associated with a multipart upload.

" + } + }, + "com.amazonaws.s3#GetObjectAttributesRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket that contains the object.

\n

\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n \n

Access points and Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

The object key.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

The version ID used to reference a specific version of the object.

\n \n

S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the null value of the version ID is supported by directory buckets. You can only specify null to the\n versionId query parameter in the request.

\n ", + "smithy.api#httpQuery": "versionId" + } + }, + "MaxParts": { + "target": "com.amazonaws.s3#MaxParts", + "traits": { + "smithy.api#documentation": "

Sets the maximum number of parts to return.

", + "smithy.api#httpHeader": "x-amz-max-parts" + } + }, + "PartNumberMarker": { + "target": "com.amazonaws.s3#PartNumberMarker", + "traits": { + "smithy.api#documentation": "

Specifies the part after which listing should begin. Only parts with higher part numbers\n will be listed.

", + "smithy.api#httpHeader": "x-amz-part-number-marker" + } + }, + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "traits": { + "smithy.api#documentation": "

Specifies the algorithm to use when encrypting the object (for example, AES256).

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + } + }, + "SSECustomerKey": { + "target": "com.amazonaws.s3#SSECustomerKey", + "traits": { + "smithy.api#documentation": "

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This\n value is used to store the object and then it is discarded; Amazon S3 does not store the\n encryption key. The key must be appropriate for use with the algorithm specified in the\n x-amz-server-side-encryption-customer-algorithm header.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key" + } + }, + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "traits": { + "smithy.api#documentation": "

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n this header for a message integrity check to ensure that the encryption key was transmitted\n without error.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + }, + "ObjectAttributes": { + "target": "com.amazonaws.s3#ObjectAttributesList", + "traits": { + "smithy.api#documentation": "

Specifies the fields at the root level that you want returned in the response. Fields\n that you do not specify are not returned.

", + "smithy.api#httpHeader": "x-amz-object-attributes", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#GetObjectLegalHold": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetObjectLegalHoldRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetObjectLegalHoldOutput" + }, + "traits": { + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Gets an object's current legal hold status. For more information, see Locking\n Objects.

\n

This functionality is not supported for Amazon S3 on Outposts.

\n

The following action is related to GetObjectLegalHold:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}/{Key+}?legal-hold", + "code": 200 + } + } + }, + "com.amazonaws.s3#GetObjectLegalHoldOutput": { + "type": "structure", + "members": { + "LegalHold": { + "target": "com.amazonaws.s3#ObjectLockLegalHold", + "traits": { + "smithy.api#documentation": "

The current legal hold status for the specified object.

", + "smithy.api#httpPayload": {}, + "smithy.api#xmlName": "LegalHold" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3#GetObjectLegalHoldRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name containing the object whose legal hold status you want to retrieve.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

The key name for the object whose legal hold status you want to retrieve.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

The version ID of the object whose legal hold status you want to retrieve.

", + "smithy.api#httpQuery": "versionId" + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#GetObjectLockConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetObjectLockConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetObjectLockConfigurationOutput" + }, + "traits": { + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock\n configuration will be applied by default to every new object placed in the specified\n bucket. For more information, see Locking Objects.

\n

The following action is related to GetObjectLockConfiguration:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?object-lock", + "code": 200 + } + } + }, + "com.amazonaws.s3#GetObjectLockConfigurationOutput": { + "type": "structure", + "members": { + "ObjectLockConfiguration": { + "target": "com.amazonaws.s3#ObjectLockConfiguration", + "traits": { + "smithy.api#documentation": "

The specified bucket's Object Lock configuration.

", + "smithy.api#httpPayload": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3#GetObjectLockConfigurationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket whose Object Lock configuration you want to retrieve.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#GetObjectOutput": { + "type": "structure", + "members": { + "Body": { + "target": "com.amazonaws.s3#StreamingBlob", + "traits": { + "smithy.api#default": "", + "smithy.api#documentation": "

Object data.

", + "smithy.api#httpPayload": {} + } + }, + "DeleteMarker": { + "target": "com.amazonaws.s3#DeleteMarker", + "traits": { + "smithy.api#documentation": "

Indicates whether the object retrieved was (true) or was not (false) a Delete Marker. If\n false, this response header does not appear in the response.

\n \n
    \n
  • \n

    If the current version of the object is a delete marker, Amazon S3 behaves as if the\n object was deleted and includes x-amz-delete-marker: true in the\n response.

    \n
    • \n
  • \n

    If the specified version in the request is a delete marker, the response\n returns a 405 Method Not Allowed error and the Last-Modified:\n timestamp response header.

    \n
    • \n
\n ", + "smithy.api#httpHeader": "x-amz-delete-marker" + } + }, + "AcceptRanges": { + "target": "com.amazonaws.s3#AcceptRanges", + "traits": { + "smithy.api#documentation": "

Indicates that a range of bytes was specified in the request.

", + "smithy.api#httpHeader": "accept-ranges" + } + }, + "Expiration": { + "target": "com.amazonaws.s3#Expiration", + "traits": { + "smithy.api#documentation": "

If the object expiration is configured (see \n PutBucketLifecycleConfiguration\n ), the response includes this\n header. It includes the expiry-date and rule-id key-value pairs\n providing object expiration information. The value of the rule-id is\n URL-encoded.

\n \n

Object expiration information is not returned in directory buckets and this header returns the value \"NotImplemented\" in all responses for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-expiration" + } + }, + "Restore": { + "target": "com.amazonaws.s3#Restore", + "traits": { + "smithy.api#documentation": "

Provides information about object restoration action and expiration time of the restored\n object copy.

\n \n

This functionality is not supported for directory buckets.\n Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

\n ", + "smithy.api#httpHeader": "x-amz-restore" + } + }, + "LastModified": { + "target": "com.amazonaws.s3#LastModified", + "traits": { + "smithy.api#documentation": "

Date and time when the object was last modified.

\n

\n General purpose buckets - When you specify a\n versionId of the object in your request, if the specified version in the\n request is a delete marker, the response returns a 405 Method Not Allowed\n error and the Last-Modified: timestamp response header.

", + "smithy.api#httpHeader": "Last-Modified" + } + }, + "ContentLength": { + "target": "com.amazonaws.s3#ContentLength", + "traits": { + "smithy.api#documentation": "

Size of the body in bytes.

", + "smithy.api#httpHeader": "Content-Length" + } + }, + "ETag": { + "target": "com.amazonaws.s3#ETag", + "traits": { + "smithy.api#documentation": "

An entity tag (ETag) is an opaque identifier assigned by a web server to a specific\n version of a resource found at a URL.

", + "smithy.api#httpHeader": "ETag" + } + }, + "ChecksumCRC32": { + "target": "com.amazonaws.s3#ChecksumCRC32", + "traits": { + "smithy.api#documentation": "

The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded\n with the object. For more information, see \n Checking object integrity in the Amazon S3 User Guide.

", + "smithy.api#httpHeader": "x-amz-checksum-crc32" + } + }, + "ChecksumCRC32C": { + "target": "com.amazonaws.s3#ChecksumCRC32C", + "traits": { + "smithy.api#documentation": "

The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded\n with the object. For more information, see \n Checking object integrity in the Amazon S3 User Guide.

", + "smithy.api#httpHeader": "x-amz-checksum-crc32c" + } + }, + "ChecksumSHA1": { + "target": "com.amazonaws.s3#ChecksumSHA1", + "traits": { + "smithy.api#documentation": "

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded\n with the object. For more information, see \n Checking object integrity in the Amazon S3 User Guide.

", + "smithy.api#httpHeader": "x-amz-checksum-sha1" + } + }, + "ChecksumSHA256": { + "target": "com.amazonaws.s3#ChecksumSHA256", + "traits": { + "smithy.api#documentation": "

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded\n with the object. For more information, see \n Checking object integrity in the Amazon S3 User Guide.

", + "smithy.api#httpHeader": "x-amz-checksum-sha256" + } + }, + "MissingMeta": { + "target": "com.amazonaws.s3#MissingMeta", + "traits": { + "smithy.api#documentation": "

This is set to the number of metadata entries not returned in the headers that are\n prefixed with x-amz-meta-. This can happen if you create metadata using an API\n like SOAP that supports more flexible metadata than the REST API. For example, using SOAP,\n you can create metadata whose values are not legal HTTP headers.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-missing-meta" + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

Version ID of the object.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-version-id" + } + }, + "CacheControl": { + "target": "com.amazonaws.s3#CacheControl", + "traits": { + "smithy.api#documentation": "

Specifies caching behavior along the request/reply chain.

", + "smithy.api#httpHeader": "Cache-Control" + } + }, + "ContentDisposition": { + "target": "com.amazonaws.s3#ContentDisposition", + "traits": { + "smithy.api#documentation": "

Specifies presentational information for the object.

", + "smithy.api#httpHeader": "Content-Disposition" + } + }, + "ContentEncoding": { + "target": "com.amazonaws.s3#ContentEncoding", + "traits": { + "smithy.api#documentation": "

Indicates what content encodings have been applied to the object and thus what decoding\n mechanisms must be applied to obtain the media-type referenced by the Content-Type header\n field.

", + "smithy.api#httpHeader": "Content-Encoding" + } + }, + "ContentLanguage": { + "target": "com.amazonaws.s3#ContentLanguage", + "traits": { + "smithy.api#documentation": "

The language the content is in.

", + "smithy.api#httpHeader": "Content-Language" + } + }, + "ContentRange": { + "target": "com.amazonaws.s3#ContentRange", + "traits": { + "smithy.api#documentation": "

The portion of the object returned in the response.

", + "smithy.api#httpHeader": "Content-Range" + } + }, + "ContentType": { + "target": "com.amazonaws.s3#ContentType", + "traits": { + "smithy.api#documentation": "

A standard MIME type describing the format of the object data.

", + "smithy.api#httpHeader": "Content-Type" + } + }, + "Expires": { + "target": "com.amazonaws.s3#Expires", + "traits": { + "smithy.api#documentation": "

The date and time at which the object is no longer cacheable.

", + "smithy.api#httpHeader": "Expires" + } + }, + "WebsiteRedirectLocation": { + "target": "com.amazonaws.s3#WebsiteRedirectLocation", + "traits": { + "smithy.api#documentation": "

If the bucket is configured as a website, redirects requests for this object to another\n object in the same bucket or to an external URL. Amazon S3 stores the value of this header in\n the object metadata.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-website-redirect-location" + } + }, + "ServerSideEncryption": { + "target": "com.amazonaws.s3#ServerSideEncryption", + "traits": { + "smithy.api#documentation": "

The server-side encryption algorithm used when you store this object in Amazon S3.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption" + } + }, + "Metadata": { + "target": "com.amazonaws.s3#Metadata", + "traits": { + "smithy.api#documentation": "

A map of metadata to store with the object in S3.

", + "smithy.api#httpPrefixHeaders": "x-amz-meta-" + } + }, + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "traits": { + "smithy.api#documentation": "

If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to confirm the encryption algorithm that's used.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + } + }, + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "traits": { + "smithy.api#documentation": "

If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to provide the round-trip message integrity verification\n of the customer-provided encryption key.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" + } + }, + "SSEKMSKeyId": { + "target": "com.amazonaws.s3#SSEKMSKeyId", + "traits": { + "smithy.api#documentation": "

If present, indicates the ID of the KMS key that was used for object encryption.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" + } + }, + "BucketKeyEnabled": { + "target": "com.amazonaws.s3#BucketKeyEnabled", + "traits": { + "smithy.api#documentation": "

Indicates whether the object uses an S3 Bucket Key for server-side encryption with\n Key Management Service (KMS) keys (SSE-KMS).

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" + } + }, + "StorageClass": { + "target": "com.amazonaws.s3#StorageClass", + "traits": { + "smithy.api#documentation": "

Provides storage class information of the object. Amazon S3 returns this header for all\n objects except for S3 Standard storage class objects.

\n \n

\n Directory buckets -\n Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

\n ", + "smithy.api#httpHeader": "x-amz-storage-class" + } + }, + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" + } + }, + "ReplicationStatus": { + "target": "com.amazonaws.s3#ReplicationStatus", + "traits": { + "smithy.api#documentation": "

Amazon S3 can return this if your request involves a bucket that is either a source or\n destination in a replication rule.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-replication-status" + } + }, + "PartsCount": { + "target": "com.amazonaws.s3#PartsCount", + "traits": { + "smithy.api#documentation": "

The count of parts this object has. This value is only returned if you specify\n partNumber in your request and the object was uploaded as a multipart\n upload.

", + "smithy.api#httpHeader": "x-amz-mp-parts-count" + } + }, + "TagCount": { + "target": "com.amazonaws.s3#TagCount", + "traits": { + "smithy.api#documentation": "

The number of tags, if any, on the object, when you have the relevant permission to read\n object tags.

\n

You can use GetObjectTagging to retrieve\n the tag set associated with an object.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-tagging-count" + } + }, + "ObjectLockMode": { + "target": "com.amazonaws.s3#ObjectLockMode", + "traits": { + "smithy.api#documentation": "

The Object Lock mode that's currently in place for this object.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-object-lock-mode" + } + }, + "ObjectLockRetainUntilDate": { + "target": "com.amazonaws.s3#ObjectLockRetainUntilDate", + "traits": { + "smithy.api#documentation": "

The date and time when this object's Object Lock will expire.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-object-lock-retain-until-date" + } + }, + "ObjectLockLegalHoldStatus": { + "target": "com.amazonaws.s3#ObjectLockLegalHoldStatus", + "traits": { + "smithy.api#documentation": "

Indicates whether this object has an active legal hold. This field is only returned if\n you have permission to view an object's legal hold status.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-object-lock-legal-hold" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3#GetObjectRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name containing the object.

\n

\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

\n Object Lambda access points - When you use this action with an Object Lambda access point, you must direct requests to the Object Lambda access point hostname. The Object Lambda access point hostname takes the form AccessPointName-AccountId.s3-object-lambda.Region.amazonaws.com.

\n \n

Access points and Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "IfMatch": { + "target": "com.amazonaws.s3#IfMatch", + "traits": { + "smithy.api#documentation": "

Return the object only if its entity tag (ETag) is the same as the one specified in this\n header; otherwise, return a 412 Precondition Failed error.

\n

If both of the If-Match and If-Unmodified-Since headers are\n present in the request as follows: If-Match condition evaluates to\n true, and; If-Unmodified-Since condition evaluates to\n false; then, S3 returns 200 OK and the data requested.

\n

For more information about conditional requests, see RFC 7232.

", + "smithy.api#httpHeader": "If-Match" + } + }, + "IfModifiedSince": { + "target": "com.amazonaws.s3#IfModifiedSince", + "traits": { + "smithy.api#documentation": "

Return the object only if it has been modified since the specified time; otherwise,\n return a 304 Not Modified error.

\n

If both of the If-None-Match and If-Modified-Since headers are\n present in the request as follows: If-None-Match condition evaluates to\n false, and; If-Modified-Since condition evaluates to\n true; then, S3 returns 304 Not Modified status code.

\n

For more information about conditional requests, see RFC 7232.

", + "smithy.api#httpHeader": "If-Modified-Since" + } + }, + "IfNoneMatch": { + "target": "com.amazonaws.s3#IfNoneMatch", + "traits": { + "smithy.api#documentation": "

Return the object only if its entity tag (ETag) is different from the one specified in\n this header; otherwise, return a 304 Not Modified error.

\n

If both of the If-None-Match and If-Modified-Since headers are\n present in the request as follows: If-None-Match condition evaluates to\n false, and; If-Modified-Since condition evaluates to\n true; then, S3 returns 304 Not Modified HTTP status\n code.

\n

For more information about conditional requests, see RFC 7232.

", + "smithy.api#httpHeader": "If-None-Match" + } + }, + "IfUnmodifiedSince": { + "target": "com.amazonaws.s3#IfUnmodifiedSince", + "traits": { + "smithy.api#documentation": "

Return the object only if it has not been modified since the specified time; otherwise,\n return a 412 Precondition Failed error.

\n

If both of the If-Match and If-Unmodified-Since headers are\n present in the request as follows: If-Match condition evaluates to\n true, and; If-Unmodified-Since condition evaluates to\n false; then, S3 returns 200 OK and the data requested.

\n

For more information about conditional requests, see RFC 7232.

", + "smithy.api#httpHeader": "If-Unmodified-Since" + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

Key of the object to get.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Key" + } + } + }, + "Range": { + "target": "com.amazonaws.s3#Range", + "traits": { + "smithy.api#documentation": "

Downloads the specified byte range of an object. For more information about the HTTP\n Range header, see https://www.rfc-editor.org/rfc/rfc9110.html#name-range.

\n \n

Amazon S3 doesn't support retrieving multiple ranges of data per GET\n request.

\n ", + "smithy.api#httpHeader": "Range" + } + }, + "ResponseCacheControl": { + "target": "com.amazonaws.s3#ResponseCacheControl", + "traits": { + "smithy.api#documentation": "

Sets the Cache-Control header of the response.

", + "smithy.api#httpQuery": "response-cache-control" + } + }, + "ResponseContentDisposition": { + "target": "com.amazonaws.s3#ResponseContentDisposition", + "traits": { + "smithy.api#documentation": "

Sets the Content-Disposition header of the response.

", + "smithy.api#httpQuery": "response-content-disposition" + } + }, + "ResponseContentEncoding": { + "target": "com.amazonaws.s3#ResponseContentEncoding", + "traits": { + "smithy.api#documentation": "

Sets the Content-Encoding header of the response.

", + "smithy.api#httpQuery": "response-content-encoding" + } + }, + "ResponseContentLanguage": { + "target": "com.amazonaws.s3#ResponseContentLanguage", + "traits": { + "smithy.api#documentation": "

Sets the Content-Language header of the response.

", + "smithy.api#httpQuery": "response-content-language" + } + }, + "ResponseContentType": { + "target": "com.amazonaws.s3#ResponseContentType", + "traits": { + "smithy.api#documentation": "

Sets the Content-Type header of the response.

", + "smithy.api#httpQuery": "response-content-type" + } + }, + "ResponseExpires": { + "target": "com.amazonaws.s3#ResponseExpires", + "traits": { + "smithy.api#documentation": "

Sets the Expires header of the response.

", + "smithy.api#httpQuery": "response-expires" + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

Version ID used to reference a specific version of the object.

\n

By default, the GetObject operation returns the current version of an\n object. To return a different version, use the versionId subresource.

\n \n
    \n
  • \n

    If you include a versionId in your request header, you must have\n the s3:GetObjectVersion permission to access a specific version of an\n object. The s3:GetObject permission is not required in this\n scenario.

    \n
    • \n
  • \n

    If you request the current version of an object without a specific\n versionId in the request header, only the\n s3:GetObject permission is required. The\n s3:GetObjectVersion permission is not required in this\n scenario.

    \n
    • \n
  • \n

    \n Directory buckets -\n S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the null value of the version ID is supported by directory buckets. You can only specify null to the\n versionId query parameter in the request.

    \n
    • \n
\n \n

For more information about versioning, see PutBucketVersioning.

", + "smithy.api#httpQuery": "versionId" + } + }, + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "traits": { + "smithy.api#documentation": "

Specifies the algorithm to use when decrypting the object (for example,\n AES256).

\n

If you encrypt an object by using server-side encryption with customer-provided\n encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object,\n you must use the following headers:

\n
    \n
  • \n

    \n x-amz-server-side-encryption-customer-algorithm\n

    \n
    • \n
  • \n

    \n x-amz-server-side-encryption-customer-key\n

    \n
    • \n
  • \n

    \n x-amz-server-side-encryption-customer-key-MD5\n

    \n
    • \n
\n

For more information about SSE-C, see Server-Side Encryption\n (Using Customer-Provided Encryption Keys) in the\n Amazon S3 User Guide.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + } + }, + "SSECustomerKey": { + "target": "com.amazonaws.s3#SSECustomerKey", + "traits": { + "smithy.api#documentation": "

Specifies the customer-provided encryption key that you originally provided for Amazon S3 to\n encrypt the data before storing it. This value is used to decrypt the object when\n recovering it and must match the one used when storing the data. The key must be\n appropriate for use with the algorithm specified in the\n x-amz-server-side-encryption-customer-algorithm header.

\n

If you encrypt an object by using server-side encryption with customer-provided\n encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object,\n you must use the following headers:

\n
    \n
  • \n

    \n x-amz-server-side-encryption-customer-algorithm\n

    \n
    • \n
  • \n

    \n x-amz-server-side-encryption-customer-key\n

    \n
    • \n
  • \n

    \n x-amz-server-side-encryption-customer-key-MD5\n

    \n
    • \n
\n

For more information about SSE-C, see Server-Side Encryption\n (Using Customer-Provided Encryption Keys) in the\n Amazon S3 User Guide.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key" + } + }, + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "traits": { + "smithy.api#documentation": "

Specifies the 128-bit MD5 digest of the customer-provided encryption key according to\n RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption\n key was transmitted without error.

\n

If you encrypt an object by using server-side encryption with customer-provided\n encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object,\n you must use the following headers:

\n
    \n
  • \n

    \n x-amz-server-side-encryption-customer-algorithm\n

    \n
    • \n
  • \n

    \n x-amz-server-side-encryption-customer-key\n

    \n
    • \n
  • \n

    \n x-amz-server-side-encryption-customer-key-MD5\n

    \n
    • \n
\n

For more information about SSE-C, see Server-Side Encryption\n (Using Customer-Provided Encryption Keys) in the\n Amazon S3 User Guide.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "PartNumber": { + "target": "com.amazonaws.s3#PartNumber", + "traits": { + "smithy.api#documentation": "

Part number of the object being read. This is a positive integer between 1 and 10,000.\n Effectively performs a 'ranged' GET request for the part specified. Useful for downloading\n just a part of an object.

", + "smithy.api#httpQuery": "partNumber" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + }, + "ChecksumMode": { + "target": "com.amazonaws.s3#ChecksumMode", + "traits": { + "smithy.api#documentation": "

To retrieve the checksum, this mode must be enabled.

\n

\n General purpose buckets - In addition, if you enable\n checksum mode and the object is uploaded with a checksum and encrypted with an\n Key Management Service (KMS) key, you must have permission to use the kms:Decrypt action\n to retrieve the checksum.

", + "smithy.api#httpHeader": "x-amz-checksum-mode" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#GetObjectResponseStatusCode": { + "type": "integer" + }, + "com.amazonaws.s3#GetObjectRetention": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetObjectRetentionRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetObjectRetentionOutput" + }, + "traits": { + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Retrieves an object's retention settings. For more information, see Locking\n Objects.

\n

This functionality is not supported for Amazon S3 on Outposts.

\n

The following action is related to GetObjectRetention:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}/{Key+}?retention", + "code": 200 + } + } + }, + "com.amazonaws.s3#GetObjectRetentionOutput": { + "type": "structure", + "members": { + "Retention": { + "target": "com.amazonaws.s3#ObjectLockRetention", + "traits": { + "smithy.api#documentation": "

The container element for an object's retention settings.

", + "smithy.api#httpPayload": {}, + "smithy.api#xmlName": "Retention" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3#GetObjectRetentionRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name containing the object whose retention settings you want to retrieve.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

The key name for the object whose retention settings you want to retrieve.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

The version ID for the object whose retention settings you want to retrieve.

", + "smithy.api#httpQuery": "versionId" + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#GetObjectTagging": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetObjectTaggingRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetObjectTaggingOutput" + }, + "traits": { + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Returns the tag-set of an object. You send the GET request against the tagging\n subresource associated with the object.

\n

To use this operation, you must have permission to perform the\n s3:GetObjectTagging action. By default, the GET action returns information\n about current version of an object. For a versioned bucket, you can have multiple versions\n of an object in your bucket. To retrieve tags of any other version, use the versionId query\n parameter. You also need permission for the s3:GetObjectVersionTagging\n action.

\n

By default, the bucket owner has this permission and can grant this permission to\n others.

\n

For information about the Amazon S3 object tagging feature, see Object Tagging.

\n

The following actions are related to GetObjectTagging:

\n ", + "smithy.api#examples": [ + { + "title": "To retrieve tag set of a specific object version", + "documentation": "The following example retrieves tag set of an object. The request specifies object version.", + "input": { + "Bucket": "examplebucket", + "Key": "exampleobject", + "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI" + }, + "output": { + "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI", + "TagSet": [ + { + "Value": "Value1", + "Key": "Key1" + } + ] + } + }, + { + "title": "To retrieve tag set of an object", + "documentation": "The following example retrieves tag set of an object.", + "input": { + "Bucket": "examplebucket", + "Key": "HappyFace.jpg" + }, + "output": { + "VersionId": "null", + "TagSet": [ + { + "Value": "Value4", + "Key": "Key4" + }, + { + "Value": "Value3", + "Key": "Key3" + } + ] + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}/{Key+}?tagging", + "code": 200 + } + } + }, + "com.amazonaws.s3#GetObjectTaggingOutput": { + "type": "structure", + "members": { + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

The versionId of the object for which you got the tagging information.

", + "smithy.api#httpHeader": "x-amz-version-id" + } + }, + "TagSet": { + "target": "com.amazonaws.s3#TagSet", + "traits": { + "smithy.api#documentation": "

Contains the tag set.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#xmlName": "Tagging" + } + }, + "com.amazonaws.s3#GetObjectTaggingRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name containing the object for which to get the tagging information.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

\n S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

Object key for which to get the tagging information.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

The versionId of the object for which to get the tagging information.

", + "smithy.api#httpQuery": "versionId" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#GetObjectTorrent": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetObjectTorrentRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetObjectTorrentOutput" + }, + "traits": { + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're\n distributing large files.

\n \n

You can get torrent only for objects that are less than 5 GB in size, and that are\n not encrypted using server-side encryption with a customer-provided encryption\n key.

\n \n

To use GET, you must have READ access to the object.

\n

This functionality is not supported for Amazon S3 on Outposts.

\n

The following action is related to GetObjectTorrent:

\n ", + "smithy.api#examples": [ + { + "title": "To retrieve torrent files for an object", + "documentation": "The following example retrieves torrent files of an object.", + "input": { + "Bucket": "examplebucket", + "Key": "HappyFace.jpg" + }, + "output": {} + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}/{Key+}?torrent", + "code": 200 + } + } + }, + "com.amazonaws.s3#GetObjectTorrentOutput": { + "type": "structure", + "members": { + "Body": { + "target": "com.amazonaws.s3#StreamingBlob", + "traits": { + "smithy.api#default": "", + "smithy.api#documentation": "

A Bencoded dictionary as defined by the BitTorrent specification

", + "smithy.api#httpPayload": {} + } + }, + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3#GetObjectTorrentRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket containing the object for which to get the torrent files.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

The object key for which to get the information.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#GetPublicAccessBlock": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetPublicAccessBlockRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetPublicAccessBlockOutput" + }, + "traits": { + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. To use\n this operation, you must have the s3:GetBucketPublicAccessBlock permission.\n For more information about Amazon S3 permissions, see Specifying Permissions in a\n Policy.

\n \n

When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or\n an object, it checks the PublicAccessBlock configuration for both the\n bucket (or the bucket that contains the object) and the bucket owner's account. If the\n PublicAccessBlock settings are different between the bucket and the\n account, Amazon S3 uses the most restrictive combination of the bucket-level and\n account-level settings.

\n \n

For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of \"Public\".

\n

The following operations are related to GetPublicAccessBlock:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?publicAccessBlock", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#GetPublicAccessBlockOutput": { + "type": "structure", + "members": { + "PublicAccessBlockConfiguration": { + "target": "com.amazonaws.s3#PublicAccessBlockConfiguration", + "traits": { + "smithy.api#documentation": "

The PublicAccessBlock configuration currently in effect for this Amazon S3\n bucket.

", + "smithy.api#httpPayload": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3#GetPublicAccessBlockRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the Amazon S3 bucket whose PublicAccessBlock configuration you want\n to retrieve.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#GlacierJobParameters": { + "type": "structure", + "members": { + "Tier": { + "target": "com.amazonaws.s3#Tier", + "traits": { + "smithy.api#documentation": "

Retrieval tier at which the restore will be processed.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Container for S3 Glacier job parameters.

" + } + }, + "com.amazonaws.s3#Grant": { + "type": "structure", + "members": { + "Grantee": { + "target": "com.amazonaws.s3#Grantee", + "traits": { + "smithy.api#documentation": "

The person being granted permissions.

", + "smithy.api#xmlNamespace": { + "uri": "http://www.w3.org/2001/XMLSchema-instance", + "prefix": "xsi" + } + } + }, + "Permission": { + "target": "com.amazonaws.s3#Permission", + "traits": { + "smithy.api#documentation": "

Specifies the permission given to the grantee.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Container for grant information.

" + } + }, + "com.amazonaws.s3#GrantFullControl": { + "type": "string" + }, + "com.amazonaws.s3#GrantRead": { + "type": "string" + }, + "com.amazonaws.s3#GrantReadACP": { + "type": "string" + }, + "com.amazonaws.s3#GrantWrite": { + "type": "string" + }, + "com.amazonaws.s3#GrantWriteACP": { + "type": "string" + }, + "com.amazonaws.s3#Grantee": { + "type": "structure", + "members": { + "DisplayName": { + "target": "com.amazonaws.s3#DisplayName", + "traits": { + "smithy.api#documentation": "

Screen name of the grantee.

" + } + }, + "EmailAddress": { + "target": "com.amazonaws.s3#EmailAddress", + "traits": { + "smithy.api#documentation": "

Email address of the grantee.

\n \n

Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

\n
    \n
  • \n

    US East (N. Virginia)

    \n
    • \n
  • \n

    US West (N. California)

    \n
    • \n
  • \n

    US West (Oregon)

    \n
    • \n
  • \n

    Asia Pacific (Singapore)

    \n
    • \n
  • \n

    Asia Pacific (Sydney)

    \n
    • \n
  • \n

    Asia Pacific (Tokyo)

    \n
    • \n
  • \n

    Europe (Ireland)

    \n
    • \n
  • \n

    South America (São Paulo)

    \n
    • \n
\n

For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

\n " + } + }, + "ID": { + "target": "com.amazonaws.s3#ID", + "traits": { + "smithy.api#documentation": "

The canonical user ID of the grantee.

" + } + }, + "URI": { + "target": "com.amazonaws.s3#URI", + "traits": { + "smithy.api#documentation": "

URI of the grantee group.

" + } + }, + "Type": { + "target": "com.amazonaws.s3#Type", + "traits": { + "smithy.api#documentation": "

Type of grantee

", + "smithy.api#required": {}, + "smithy.api#xmlAttribute": {}, + "smithy.api#xmlName": "xsi:type" + } + } + }, + "traits": { + "smithy.api#documentation": "

Container for the person being granted permissions.

" + } + }, + "com.amazonaws.s3#Grants": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#Grant", + "traits": { + "smithy.api#xmlName": "Grant" + } + } + }, + "com.amazonaws.s3#HeadBucket": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#HeadBucketRequest" + }, + "output": { + "target": "com.amazonaws.s3#HeadBucketOutput" + }, + "errors": [ + { + "target": "com.amazonaws.s3#NotFound" + } + ], + "traits": { + "smithy.api#documentation": "

You can use this operation to determine if a bucket exists and if you have permission to\n access it. The action returns a 200 OK if the bucket exists and you have\n permission to access it.

\n \n

If the bucket does not exist or you do not have permission to access it, the\n HEAD request returns a generic 400 Bad Request, 403\n Forbidden or 404 Not Found code. A message body is not included,\n so you cannot determine the exception beyond these HTTP response codes.

\n \n
\n
Authentication and authorization
\n
\n

\n General purpose buckets - Request to public\n buckets that grant the s3:ListBucket permission publicly do not need to be signed.\n All other HeadBucket requests must be authenticated and signed by\n using IAM credentials (access key ID and secret access key for the IAM\n identities). All headers with the x-amz- prefix, including\n x-amz-copy-source, must be signed. For more information, see\n REST Authentication.

\n

\n Directory buckets - You must use IAM\n credentials to authenticate and authorize your access to the\n HeadBucket API operation, instead of using the temporary security\n credentials through the CreateSession API operation.

\n

Amazon Web Services CLI or SDKs handles authentication and authorization on your\n behalf.

\n
\n
Permissions
\n
\n

\n \n
\n
HTTP Host header syntax
\n
\n

\n Directory buckets - The HTTP Host header syntax is \n Bucket-name.s3express-zone-id.region-code.amazonaws.com.

\n \n

You must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the\n Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the\n Amazon S3 User Guide.

\n \n
\n
", + "smithy.api#examples": [ + { + "title": "To determine if bucket exists", + "documentation": "This operation checks to see if a bucket exists.", + "input": { + "Bucket": "acl1" + } + } + ], + "smithy.api#http": { + "method": "HEAD", + "uri": "/{Bucket}", + "code": 200 + }, + "smithy.waiters#waitable": { + "BucketExists": { + "acceptors": [ + { + "state": "success", + "matcher": { + "success": true + } + }, + { + "state": "retry", + "matcher": { + "errorType": "NotFound" + } + } + ], + "minDelay": 5 + }, + "BucketNotExists": { + "acceptors": [ + { + "state": "success", + "matcher": { + "errorType": "NotFound" + } + } + ], + "minDelay": 5 + } + } + } + }, + "com.amazonaws.s3#HeadBucketOutput": { + "type": "structure", + "members": { + "BucketLocationType": { + "target": "com.amazonaws.s3#LocationType", + "traits": { + "smithy.api#documentation": "

The type of location where the bucket is created.

\n \n

This functionality is only supported by directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-bucket-location-type" + } + }, + "BucketLocationName": { + "target": "com.amazonaws.s3#BucketLocationName", + "traits": { + "smithy.api#documentation": "

The name of the location where the bucket will be created.

\n

For directory buckets, the Zone ID of the Availability Zone or the Local Zone where the bucket is created. An example Zone ID value for an Availability Zone is usw2-az1.

\n \n

This functionality is only supported by directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-bucket-location-name" + } + }, + "BucketRegion": { + "target": "com.amazonaws.s3#Region", + "traits": { + "smithy.api#documentation": "

The Region that the bucket is located.

", + "smithy.api#httpHeader": "x-amz-bucket-region" + } + }, + "AccessPointAlias": { + "target": "com.amazonaws.s3#AccessPointAlias", + "traits": { + "smithy.api#documentation": "

Indicates whether the bucket name used in the request is an access point alias.

\n \n

For directory buckets, the value of this field is false.

\n ", + "smithy.api#httpHeader": "x-amz-access-point-alias" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3#HeadBucketRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name.

\n

\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

\n Object Lambda access points - When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. \nIf the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. \nFor more information about InvalidAccessPointAliasError, see List of\n Error Codes.

\n \n

Access points and Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#HeadObject": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#HeadObjectRequest" + }, + "output": { + "target": "com.amazonaws.s3#HeadObjectOutput" + }, + "errors": [ + { + "target": "com.amazonaws.s3#NotFound" + } + ], + "traits": { + "smithy.api#documentation": "

The HEAD operation retrieves metadata from an object without returning the\n object itself. This operation is useful if you're interested only in an object's\n metadata.

\n \n

A HEAD request has the same options as a GET operation on\n an object. The response is identical to the GET response except that there\n is no response body. Because of this, if the HEAD request generates an\n error, it returns a generic code, such as 400 Bad Request, 403\n Forbidden, 404 Not Found, 405 Method Not Allowed,\n 412 Precondition Failed, or 304 Not Modified. It's not\n possible to retrieve the exact exception of these error codes.

\n \n

Request headers are limited to 8 KB in size. For more information, see Common\n Request Headers.

\n
\n
Permissions
\n
\n

\n
    \n
  • \n

    \n General purpose bucket permissions - To\n use HEAD, you must have the s3:GetObject\n permission. You need the relevant read object (or version) permission for\n this operation. For more information, see Actions, resources, and\n condition keys for Amazon S3 in the Amazon S3 User\n Guide. For more information about the permissions to S3 API\n operations by S3 resource types, see Required permissions for Amazon S3 API operations in the\n Amazon S3 User Guide.

    \n

    If the object you request doesn't exist, the error that Amazon S3 returns\n depends on whether you also have the s3:ListBucket\n permission.

    \n
      \n
    • \n

      If you have the s3:ListBucket permission on the\n bucket, Amazon S3 returns an HTTP status code 404 Not Found\n error.

      \n
      • \n
    • \n

      If you don’t have the s3:ListBucket permission, Amazon S3\n returns an HTTP status code 403 Forbidden error.

      \n
      • \n
    \n
    • \n
  • \n

    \n Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the \n CreateSession\n API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. \nAmazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see \n CreateSession\n .

    \n

    If you enable x-amz-checksum-mode in the request and the\n object is encrypted with Amazon Web Services Key Management Service (Amazon Web Services KMS), you must\n also have the kms:GenerateDataKey and kms:Decrypt\n permissions in IAM identity-based policies and KMS key policies for the\n KMS key to retrieve the checksum of the object.

    \n
    • \n
\n
\n
Encryption
\n
\n \n

Encryption request headers, like x-amz-server-side-encryption,\n should not be sent for HEAD requests if your object uses\n server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer\n server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side\n encryption with Amazon S3 managed encryption keys (SSE-S3). The\n x-amz-server-side-encryption header is used when you\n PUT an object to S3 and want to specify the encryption method.\n If you include this header in a HEAD request for an object that\n uses these types of keys, you’ll get an HTTP 400 Bad Request\n error. It's because the encryption method can't be changed when you retrieve\n the object.

\n \n

If you encrypt an object by using server-side encryption with customer-provided\n encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve\n the metadata from the object, you must use the following headers to provide the\n encryption key for the server to be able to retrieve the object's metadata. The\n headers are:

\n
    \n
  • \n

    \n x-amz-server-side-encryption-customer-algorithm\n

    \n
    • \n
  • \n

    \n x-amz-server-side-encryption-customer-key\n

    \n
    • \n
  • \n

    \n x-amz-server-side-encryption-customer-key-MD5\n

    \n
    • \n
\n

For more information about SSE-C, see Server-Side\n Encryption (Using Customer-Provided Encryption Keys) in the\n Amazon S3 User Guide.

\n \n

\n Directory bucket -\n For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS. SSE-C isn't supported. For more\n information, see Protecting data with server-side encryption in the Amazon S3 User Guide.

\n \n
\n
Versioning
\n
\n
    \n
  • \n

    If the current version of the object is a delete marker, Amazon S3 behaves as\n if the object was deleted and includes x-amz-delete-marker:\n true in the response.

    \n
    • \n
  • \n

    If the specified version is a delete marker, the response returns a\n 405 Method Not Allowed error and the Last-Modified:\n timestamp response header.

    \n
    • \n
\n \n
    \n
  • \n

    \n Directory buckets -\n Delete marker is not supported for directory buckets.

    \n
    • \n
  • \n

    \n Directory buckets -\n S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the null value of the version ID is supported by directory buckets. You can only specify null\n to the versionId query parameter in the request.

    \n
    • \n
\n \n
\n
HTTP Host header syntax
\n
\n

\n Directory buckets - The HTTP Host header syntax is \n Bucket-name.s3express-zone-id.region-code.amazonaws.com.

\n \n

For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket-name.s3express-zone-id.region-code.amazonaws.com/key-name\n . Path-style requests are not supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the\n Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the\n Amazon S3 User Guide.

\n \n
\n
\n

The following actions are related to HeadObject:

\n ", + "smithy.api#examples": [ + { + "title": "To retrieve metadata of an object without returning the object itself", + "documentation": "The following example retrieves an object metadata.", + "input": { + "Bucket": "examplebucket", + "Key": "HappyFace.jpg" + }, + "output": { + "AcceptRanges": "bytes", + "ContentType": "image/jpeg", + "LastModified": "2016-12-15T01:19:41.000Z", + "ContentLength": 3191, + "VersionId": "null", + "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", + "Metadata": {} + } + } + ], + "smithy.api#http": { + "method": "HEAD", + "uri": "/{Bucket}/{Key+}", + "code": 200 + }, + "smithy.waiters#waitable": { + "ObjectExists": { + "acceptors": [ + { + "state": "success", + "matcher": { + "success": true + } + }, + { + "state": "retry", + "matcher": { + "errorType": "NotFound" + } + } + ], + "minDelay": 5 + }, + "ObjectNotExists": { + "acceptors": [ + { + "state": "success", + "matcher": { + "errorType": "NotFound" + } + } + ], + "minDelay": 5 + } + } + } + }, + "com.amazonaws.s3#HeadObjectOutput": { + "type": "structure", + "members": { + "DeleteMarker": { + "target": "com.amazonaws.s3#DeleteMarker", + "traits": { + "smithy.api#documentation": "

Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If\n false, this response header does not appear in the response.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-delete-marker" + } + }, + "AcceptRanges": { + "target": "com.amazonaws.s3#AcceptRanges", + "traits": { + "smithy.api#documentation": "

Indicates that a range of bytes was specified.

", + "smithy.api#httpHeader": "accept-ranges" + } + }, + "Expiration": { + "target": "com.amazonaws.s3#Expiration", + "traits": { + "smithy.api#documentation": "

If the object expiration is configured (see \n PutBucketLifecycleConfiguration\n ), the response includes this\n header. It includes the expiry-date and rule-id key-value pairs\n providing object expiration information. The value of the rule-id is\n URL-encoded.

\n \n

Object expiration information is not returned in directory buckets and this header returns the value \"NotImplemented\" in all responses for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-expiration" + } + }, + "Restore": { + "target": "com.amazonaws.s3#Restore", + "traits": { + "smithy.api#documentation": "

If the object is an archived object (an object whose storage class is GLACIER), the\n response includes this header if either the archive restoration is in progress (see RestoreObject or an archive copy is already restored.

\n

If an archive copy is already restored, the header value indicates when Amazon S3 is\n scheduled to delete the object copy. For example:

\n

\n x-amz-restore: ongoing-request=\"false\", expiry-date=\"Fri, 21 Dec 2012 00:00:00\n GMT\"\n

\n

If the object restoration is in progress, the header returns the value\n ongoing-request=\"true\".

\n

For more information about archiving objects, see Transitioning Objects: General Considerations.

\n \n

This functionality is not supported for directory buckets.\n Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

\n ", + "smithy.api#httpHeader": "x-amz-restore" + } + }, + "ArchiveStatus": { + "target": "com.amazonaws.s3#ArchiveStatus", + "traits": { + "smithy.api#documentation": "

The archive state of the head object.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-archive-status" + } + }, + "LastModified": { + "target": "com.amazonaws.s3#LastModified", + "traits": { + "smithy.api#documentation": "

Date and time when the object was last modified.

", + "smithy.api#httpHeader": "Last-Modified" + } + }, + "ContentLength": { + "target": "com.amazonaws.s3#ContentLength", + "traits": { + "smithy.api#documentation": "

Size of the body in bytes.

", + "smithy.api#httpHeader": "Content-Length" + } + }, + "ChecksumCRC32": { + "target": "com.amazonaws.s3#ChecksumCRC32", + "traits": { + "smithy.api#documentation": "

The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

", + "smithy.api#httpHeader": "x-amz-checksum-crc32" + } + }, + "ChecksumCRC32C": { + "target": "com.amazonaws.s3#ChecksumCRC32C", + "traits": { + "smithy.api#documentation": "

The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

", + "smithy.api#httpHeader": "x-amz-checksum-crc32c" + } + }, + "ChecksumSHA1": { + "target": "com.amazonaws.s3#ChecksumSHA1", + "traits": { + "smithy.api#documentation": "

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded\n with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

", + "smithy.api#httpHeader": "x-amz-checksum-sha1" + } + }, + "ChecksumSHA256": { + "target": "com.amazonaws.s3#ChecksumSHA256", + "traits": { + "smithy.api#documentation": "

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

", + "smithy.api#httpHeader": "x-amz-checksum-sha256" + } + }, + "ETag": { + "target": "com.amazonaws.s3#ETag", + "traits": { + "smithy.api#documentation": "

An entity tag (ETag) is an opaque identifier assigned by a web server to a specific\n version of a resource found at a URL.

", + "smithy.api#httpHeader": "ETag" + } + }, + "MissingMeta": { + "target": "com.amazonaws.s3#MissingMeta", + "traits": { + "smithy.api#documentation": "

This is set to the number of metadata entries not returned in x-amz-meta\n headers. This can happen if you create metadata using an API like SOAP that supports more\n flexible metadata than the REST API. For example, using SOAP, you can create metadata whose\n values are not legal HTTP headers.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-missing-meta" + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

Version ID of the object.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-version-id" + } + }, + "CacheControl": { + "target": "com.amazonaws.s3#CacheControl", + "traits": { + "smithy.api#documentation": "

Specifies caching behavior along the request/reply chain.

", + "smithy.api#httpHeader": "Cache-Control" + } + }, + "ContentDisposition": { + "target": "com.amazonaws.s3#ContentDisposition", + "traits": { + "smithy.api#documentation": "

Specifies presentational information for the object.

", + "smithy.api#httpHeader": "Content-Disposition" + } + }, + "ContentEncoding": { + "target": "com.amazonaws.s3#ContentEncoding", + "traits": { + "smithy.api#documentation": "

Indicates what content encodings have been applied to the object and thus what decoding\n mechanisms must be applied to obtain the media-type referenced by the Content-Type header\n field.

", + "smithy.api#httpHeader": "Content-Encoding" + } + }, + "ContentLanguage": { + "target": "com.amazonaws.s3#ContentLanguage", + "traits": { + "smithy.api#documentation": "

The language the content is in.

", + "smithy.api#httpHeader": "Content-Language" + } + }, + "ContentType": { + "target": "com.amazonaws.s3#ContentType", + "traits": { + "smithy.api#documentation": "

A standard MIME type describing the format of the object data.

", + "smithy.api#httpHeader": "Content-Type" + } + }, + "Expires": { + "target": "com.amazonaws.s3#Expires", + "traits": { + "smithy.api#documentation": "

The date and time at which the object is no longer cacheable.

", + "smithy.api#httpHeader": "Expires" + } + }, + "WebsiteRedirectLocation": { + "target": "com.amazonaws.s3#WebsiteRedirectLocation", + "traits": { + "smithy.api#documentation": "

If the bucket is configured as a website, redirects requests for this object to another\n object in the same bucket or to an external URL. Amazon S3 stores the value of this header in\n the object metadata.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-website-redirect-location" + } + }, + "ServerSideEncryption": { + "target": "com.amazonaws.s3#ServerSideEncryption", + "traits": { + "smithy.api#documentation": "

The server-side encryption algorithm used when you store this object in Amazon S3 (for\n example, AES256, aws:kms, aws:kms:dsse).

", + "smithy.api#httpHeader": "x-amz-server-side-encryption" + } + }, + "Metadata": { + "target": "com.amazonaws.s3#Metadata", + "traits": { + "smithy.api#documentation": "

A map of metadata to store with the object in S3.

", + "smithy.api#httpPrefixHeaders": "x-amz-meta-" + } + }, + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "traits": { + "smithy.api#documentation": "

If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to confirm the encryption algorithm that's used.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + } + }, + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "traits": { + "smithy.api#documentation": "

If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to provide the round-trip message integrity verification\n of the customer-provided encryption key.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" + } + }, + "SSEKMSKeyId": { + "target": "com.amazonaws.s3#SSEKMSKeyId", + "traits": { + "smithy.api#documentation": "

If present, indicates the ID of the KMS key that was used for object encryption.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" + } + }, + "BucketKeyEnabled": { + "target": "com.amazonaws.s3#BucketKeyEnabled", + "traits": { + "smithy.api#documentation": "

Indicates whether the object uses an S3 Bucket Key for server-side encryption with\n Key Management Service (KMS) keys (SSE-KMS).

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" + } + }, + "StorageClass": { + "target": "com.amazonaws.s3#StorageClass", + "traits": { + "smithy.api#documentation": "

Provides storage class information of the object. Amazon S3 returns this header for all\n objects except for S3 Standard storage class objects.

\n

For more information, see Storage Classes.

\n \n

\n Directory buckets -\n Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

\n ", + "smithy.api#httpHeader": "x-amz-storage-class" + } + }, + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" + } + }, + "ReplicationStatus": { + "target": "com.amazonaws.s3#ReplicationStatus", + "traits": { + "smithy.api#documentation": "

Amazon S3 can return this header if your request involves a bucket that is either a source or\n a destination in a replication rule.

\n

In replication, you have a source bucket on which you configure replication and\n destination bucket or buckets where Amazon S3 stores object replicas. When you request an object\n (GetObject) or object metadata (HeadObject) from these\n buckets, Amazon S3 will return the x-amz-replication-status header in the response\n as follows:

\n
    \n
  • \n

    \n If requesting an object from the source bucket,\n Amazon S3 will return the x-amz-replication-status header if the object in\n your request is eligible for replication.

    \n

    For example, suppose that in your replication configuration, you specify object\n prefix TaxDocs requesting Amazon S3 to replicate objects with key prefix\n TaxDocs. Any objects you upload with this key name prefix, for\n example TaxDocs/document1.pdf, are eligible for replication. For any\n object request with this key name prefix, Amazon S3 will return the\n x-amz-replication-status header with value PENDING, COMPLETED or\n FAILED indicating object replication status.

    \n
    • \n
  • \n

    \n If requesting an object from a destination\n bucket, Amazon S3 will return the x-amz-replication-status header\n with value REPLICA if the object in your request is a replica that Amazon S3 created and\n there is no replica modification replication in progress.

    \n
    • \n
  • \n

    \n When replicating objects to multiple destination\n buckets, the x-amz-replication-status header acts\n differently. The header of the source object will only return a value of COMPLETED\n when replication is successful to all destinations. The header will remain at value\n PENDING until replication has completed for all destinations. If one or more\n destinations fails replication the header will return FAILED.

    \n
    • \n
\n

For more information, see Replication.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-replication-status" + } + }, + "PartsCount": { + "target": "com.amazonaws.s3#PartsCount", + "traits": { + "smithy.api#documentation": "

The count of parts this object has. This value is only returned if you specify\n partNumber in your request and the object was uploaded as a multipart\n upload.

", + "smithy.api#httpHeader": "x-amz-mp-parts-count" + } + }, + "ObjectLockMode": { + "target": "com.amazonaws.s3#ObjectLockMode", + "traits": { + "smithy.api#documentation": "

The Object Lock mode, if any, that's in effect for this object. This header is only\n returned if the requester has the s3:GetObjectRetention permission. For more\n information about S3 Object Lock, see Object Lock.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-object-lock-mode" + } + }, + "ObjectLockRetainUntilDate": { + "target": "com.amazonaws.s3#ObjectLockRetainUntilDate", + "traits": { + "smithy.api#documentation": "

The date and time when the Object Lock retention period expires. This header is only\n returned if the requester has the s3:GetObjectRetention permission.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-object-lock-retain-until-date" + } + }, + "ObjectLockLegalHoldStatus": { + "target": "com.amazonaws.s3#ObjectLockLegalHoldStatus", + "traits": { + "smithy.api#documentation": "

Specifies whether a legal hold is in effect for this object. This header is only\n returned if the requester has the s3:GetObjectLegalHold permission. This\n header is not returned if the specified version of this object has never had a legal hold\n applied. For more information about S3 Object Lock, see Object Lock.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-object-lock-legal-hold" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3#HeadObjectRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket that contains the object.

\n

\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n \n

Access points and Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "IfMatch": { + "target": "com.amazonaws.s3#IfMatch", + "traits": { + "smithy.api#documentation": "

Return the object only if its entity tag (ETag) is the same as the one specified;\n otherwise, return a 412 (precondition failed) error.

\n

If both of the If-Match and If-Unmodified-Since headers are\n present in the request as follows:

\n
    \n
  • \n

    \n If-Match condition evaluates to true, and;

    \n
    • \n
  • \n

    \n If-Unmodified-Since condition evaluates to false;

    \n
    • \n
\n

Then Amazon S3 returns 200 OK and the data requested.

\n

For more information about conditional requests, see RFC 7232.

", + "smithy.api#httpHeader": "If-Match" + } + }, + "IfModifiedSince": { + "target": "com.amazonaws.s3#IfModifiedSince", + "traits": { + "smithy.api#documentation": "

Return the object only if it has been modified since the specified time; otherwise,\n return a 304 (not modified) error.

\n

If both of the If-None-Match and If-Modified-Since headers are\n present in the request as follows:

\n
    \n
  • \n

    \n If-None-Match condition evaluates to false, and;

    \n
    • \n
  • \n

    \n If-Modified-Since condition evaluates to true;

    \n
    • \n
\n

Then Amazon S3 returns the 304 Not Modified response code.

\n

For more information about conditional requests, see RFC 7232.

", + "smithy.api#httpHeader": "If-Modified-Since" + } + }, + "IfNoneMatch": { + "target": "com.amazonaws.s3#IfNoneMatch", + "traits": { + "smithy.api#documentation": "

Return the object only if its entity tag (ETag) is different from the one specified;\n otherwise, return a 304 (not modified) error.

\n

If both of the If-None-Match and If-Modified-Since headers are\n present in the request as follows:

\n
    \n
  • \n

    \n If-None-Match condition evaluates to false, and;

    \n
    • \n
  • \n

    \n If-Modified-Since condition evaluates to true;

    \n
    • \n
\n

Then Amazon S3 returns the 304 Not Modified response code.

\n

For more information about conditional requests, see RFC 7232.

", + "smithy.api#httpHeader": "If-None-Match" + } + }, + "IfUnmodifiedSince": { + "target": "com.amazonaws.s3#IfUnmodifiedSince", + "traits": { + "smithy.api#documentation": "

Return the object only if it has not been modified since the specified time; otherwise,\n return a 412 (precondition failed) error.

\n

If both of the If-Match and If-Unmodified-Since headers are\n present in the request as follows:

\n
    \n
  • \n

    \n If-Match condition evaluates to true, and;

    \n
    • \n
  • \n

    \n If-Unmodified-Since condition evaluates to false;

    \n
    • \n
\n

Then Amazon S3 returns 200 OK and the data requested.

\n

For more information about conditional requests, see RFC 7232.

", + "smithy.api#httpHeader": "If-Unmodified-Since" + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

The object key.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Key" + } + } + }, + "Range": { + "target": "com.amazonaws.s3#Range", + "traits": { + "smithy.api#documentation": "

HeadObject returns only the metadata for an object. If the Range is satisfiable, only\n the ContentLength is affected in the response. If the Range is not\n satisfiable, S3 returns a 416 - Requested Range Not Satisfiable error.

", + "smithy.api#httpHeader": "Range" + } + }, + "ResponseCacheControl": { + "target": "com.amazonaws.s3#ResponseCacheControl", + "traits": { + "smithy.api#documentation": "

Sets the Cache-Control header of the response.

", + "smithy.api#httpQuery": "response-cache-control" + } + }, + "ResponseContentDisposition": { + "target": "com.amazonaws.s3#ResponseContentDisposition", + "traits": { + "smithy.api#documentation": "

Sets the Content-Disposition header of the response.

", + "smithy.api#httpQuery": "response-content-disposition" + } + }, + "ResponseContentEncoding": { + "target": "com.amazonaws.s3#ResponseContentEncoding", + "traits": { + "smithy.api#documentation": "

Sets the Content-Encoding header of the response.

", + "smithy.api#httpQuery": "response-content-encoding" + } + }, + "ResponseContentLanguage": { + "target": "com.amazonaws.s3#ResponseContentLanguage", + "traits": { + "smithy.api#documentation": "

Sets the Content-Language header of the response.

", + "smithy.api#httpQuery": "response-content-language" + } + }, + "ResponseContentType": { + "target": "com.amazonaws.s3#ResponseContentType", + "traits": { + "smithy.api#documentation": "

Sets the Content-Type header of the response.

", + "smithy.api#httpQuery": "response-content-type" + } + }, + "ResponseExpires": { + "target": "com.amazonaws.s3#ResponseExpires", + "traits": { + "smithy.api#documentation": "

Sets the Expires header of the response.

", + "smithy.api#httpQuery": "response-expires" + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

Version ID used to reference a specific version of the object.

\n \n

For directory buckets in this API operation, only the null value of the version ID is supported.

\n ", + "smithy.api#httpQuery": "versionId" + } + }, + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "traits": { + "smithy.api#documentation": "

Specifies the algorithm to use when encrypting the object (for example, AES256).

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + } + }, + "SSECustomerKey": { + "target": "com.amazonaws.s3#SSECustomerKey", + "traits": { + "smithy.api#documentation": "

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This\n value is used to store the object and then it is discarded; Amazon S3 does not store the\n encryption key. The key must be appropriate for use with the algorithm specified in the\n x-amz-server-side-encryption-customer-algorithm header.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key" + } + }, + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "traits": { + "smithy.api#documentation": "

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n this header for a message integrity check to ensure that the encryption key was transmitted\n without error.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "PartNumber": { + "target": "com.amazonaws.s3#PartNumber", + "traits": { + "smithy.api#documentation": "

Part number of the object being read. This is a positive integer between 1 and 10,000.\n Effectively performs a 'ranged' HEAD request for the part specified. Useful querying about\n the size of the part and the number of parts in this object.

", + "smithy.api#httpQuery": "partNumber" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + }, + "ChecksumMode": { + "target": "com.amazonaws.s3#ChecksumMode", + "traits": { + "smithy.api#documentation": "

To retrieve the checksum, this parameter must be enabled.

\n

\n General purpose buckets -\n If you enable checksum mode and the object is uploaded with a\n checksum\n and encrypted with an Key Management Service (KMS) key, you must have permission to use the\n kms:Decrypt action to retrieve the checksum.

\n

\n Directory buckets - If you enable\n ChecksumMode and the object is encrypted with Amazon Web Services Key Management Service\n (Amazon Web Services KMS), you must also have the kms:GenerateDataKey and\n kms:Decrypt permissions in IAM identity-based policies and KMS key\n policies for the KMS key to retrieve the checksum of the object.

", + "smithy.api#httpHeader": "x-amz-checksum-mode" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#HostName": { + "type": "string" + }, + "com.amazonaws.s3#HttpErrorCodeReturnedEquals": { + "type": "string" + }, + "com.amazonaws.s3#HttpRedirectCode": { + "type": "string" + }, + "com.amazonaws.s3#ID": { + "type": "string" + }, + "com.amazonaws.s3#IfMatch": { + "type": "string" + }, + "com.amazonaws.s3#IfMatchInitiatedTime": { + "type": "timestamp", + "traits": { + "smithy.api#timestampFormat": "http-date" + } + }, + "com.amazonaws.s3#IfMatchLastModifiedTime": { + "type": "timestamp", + "traits": { + "smithy.api#timestampFormat": "http-date" + } + }, + "com.amazonaws.s3#IfMatchSize": { + "type": "long" + }, + "com.amazonaws.s3#IfModifiedSince": { + "type": "timestamp" + }, + "com.amazonaws.s3#IfNoneMatch": { + "type": "string" + }, + "com.amazonaws.s3#IfUnmodifiedSince": { + "type": "timestamp" + }, + "com.amazonaws.s3#IndexDocument": { + "type": "structure", + "members": { + "Suffix": { + "target": "com.amazonaws.s3#Suffix", + "traits": { + "smithy.api#documentation": "

A suffix that is appended to a request that is for a directory on the website endpoint.\n (For example, if the suffix is index.html and you make a request to\n samplebucket/images/, the data that is returned will be for the object with\n the key name images/index.html.) The suffix must not be empty and must not\n include a slash character.

\n \n

Replacement must be made for object keys containing special characters (such as carriage returns) when using \n XML requests. For more information, see \n XML related object key constraints.

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Container for the Suffix element.

" + } + }, + "com.amazonaws.s3#Initiated": { + "type": "timestamp" + }, + "com.amazonaws.s3#Initiator": { + "type": "structure", + "members": { + "ID": { + "target": "com.amazonaws.s3#ID", + "traits": { + "smithy.api#documentation": "

If the principal is an Amazon Web Services account, it provides the Canonical User ID. If the\n principal is an IAM User, it provides a user ARN value.

\n \n

\n Directory buckets - If the principal is an\n Amazon Web Services account, it provides the Amazon Web Services account ID. If the principal is an IAM User, it\n provides a user ARN value.

\n " + } + }, + "DisplayName": { + "target": "com.amazonaws.s3#DisplayName", + "traits": { + "smithy.api#documentation": "

Name of the Principal.

\n \n

This functionality is not supported for directory buckets.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Container element that identifies who initiated the multipart upload.

" + } + }, + "com.amazonaws.s3#InputSerialization": { + "type": "structure", + "members": { + "CSV": { + "target": "com.amazonaws.s3#CSVInput", + "traits": { + "smithy.api#documentation": "

Describes the serialization of a CSV-encoded object.

" + } + }, + "CompressionType": { + "target": "com.amazonaws.s3#CompressionType", + "traits": { + "smithy.api#documentation": "

Specifies object's compression format. Valid values: NONE, GZIP, BZIP2. Default Value:\n NONE.

" + } + }, + "JSON": { + "target": "com.amazonaws.s3#JSONInput", + "traits": { + "smithy.api#documentation": "

Specifies JSON as object's input serialization format.

" + } + }, + "Parquet": { + "target": "com.amazonaws.s3#ParquetInput", + "traits": { + "smithy.api#documentation": "

Specifies Parquet as object's input serialization format.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the serialization format of the object.

" + } + }, + "com.amazonaws.s3#IntelligentTieringAccessTier": { + "type": "enum", + "members": { + "ARCHIVE_ACCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARCHIVE_ACCESS" + } + }, + "DEEP_ARCHIVE_ACCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEEP_ARCHIVE_ACCESS" + } + } + } + }, + "com.amazonaws.s3#IntelligentTieringAndOperator": { + "type": "structure", + "members": { + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "

An object key name prefix that identifies the subset of objects to which the\n configuration applies.

" + } + }, + "Tags": { + "target": "com.amazonaws.s3#TagSet", + "traits": { + "smithy.api#documentation": "

All of these tags must exist in the object's tag set in order for the configuration to\n apply.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Tag" + } + } + }, + "traits": { + "smithy.api#documentation": "

A container for specifying S3 Intelligent-Tiering filters. The filters determine the\n subset of objects to which the rule applies.

" + } + }, + "com.amazonaws.s3#IntelligentTieringConfiguration": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.s3#IntelligentTieringId", + "traits": { + "smithy.api#documentation": "

The ID used to identify the S3 Intelligent-Tiering configuration.

", + "smithy.api#required": {} + } + }, + "Filter": { + "target": "com.amazonaws.s3#IntelligentTieringFilter", + "traits": { + "smithy.api#documentation": "

Specifies a bucket filter. The configuration only includes objects that meet the\n filter's criteria.

" + } + }, + "Status": { + "target": "com.amazonaws.s3#IntelligentTieringStatus", + "traits": { + "smithy.api#documentation": "

Specifies the status of the configuration.

", + "smithy.api#required": {} + } + }, + "Tierings": { + "target": "com.amazonaws.s3#TieringList", + "traits": { + "smithy.api#documentation": "

Specifies the S3 Intelligent-Tiering storage class tier of the configuration.

", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Tiering" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the S3 Intelligent-Tiering configuration for an Amazon S3 bucket.

\n

For information about the S3 Intelligent-Tiering storage class, see Storage class\n for automatically optimizing frequently and infrequently accessed\n objects.

" + } + }, + "com.amazonaws.s3#IntelligentTieringConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#IntelligentTieringConfiguration" + } + }, + "com.amazonaws.s3#IntelligentTieringDays": { + "type": "integer" + }, + "com.amazonaws.s3#IntelligentTieringFilter": { + "type": "structure", + "members": { + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "

An object key name prefix that identifies the subset of objects to which the rule\n applies.

\n \n

Replacement must be made for object keys containing special characters (such as carriage returns) when using \n XML requests. For more information, see \n XML related object key constraints.

\n " + } + }, + "Tag": { + "target": "com.amazonaws.s3#Tag" + }, + "And": { + "target": "com.amazonaws.s3#IntelligentTieringAndOperator", + "traits": { + "smithy.api#documentation": "

A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter.\n The operator must have at least two predicates, and an object must match all of the\n predicates in order for the filter to apply.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Filter is used to identify objects that the S3 Intelligent-Tiering\n configuration applies to.

" + } + }, + "com.amazonaws.s3#IntelligentTieringId": { + "type": "string" + }, + "com.amazonaws.s3#IntelligentTieringStatus": { + "type": "enum", + "members": { + "Enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enabled" + } + }, + "Disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disabled" + } + } + } + }, + "com.amazonaws.s3#InvalidObjectState": { + "type": "structure", + "members": { + "StorageClass": { + "target": "com.amazonaws.s3#StorageClass" + }, + "AccessTier": { + "target": "com.amazonaws.s3#IntelligentTieringAccessTier" + } + }, + "traits": { + "smithy.api#documentation": "

Object is archived and inaccessible until restored.

\n

If the object you are retrieving is stored in the S3 Glacier Flexible Retrieval storage\n class, the S3 Glacier Deep Archive storage class, the S3 Intelligent-Tiering Archive Access\n tier, or the S3 Intelligent-Tiering Deep Archive Access tier, before you can retrieve the object you\n must first restore a copy using RestoreObject. Otherwise, this\n operation returns an InvalidObjectState error. For information about restoring\n archived objects, see Restoring Archived Objects in\n the Amazon S3 User Guide.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.s3#InvalidRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

You may receive this error in multiple cases. Depending on the reason for the error, you may receive one of the messages below:

\n
    \n
  • \n

    Cannot specify both a write offset value and user-defined object metadata for existing objects.

    \n
    • \n
  • \n

    Checksum Type mismatch occurred, expected checksum Type: sha1, actual checksum Type: crc32c.

    \n
    • \n
  • \n

    Request body cannot be empty when 'write offset' is specified.

    \n
    • \n
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.s3#InvalidWriteOffset": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

\n The write offset value that you specified does not match the current object size.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.s3#InventoryConfiguration": { + "type": "structure", + "members": { + "Destination": { + "target": "com.amazonaws.s3#InventoryDestination", + "traits": { + "smithy.api#documentation": "

Contains information about where to publish the inventory results.

", + "smithy.api#required": {} + } + }, + "IsEnabled": { + "target": "com.amazonaws.s3#IsEnabled", + "traits": { + "smithy.api#documentation": "

Specifies whether the inventory is enabled or disabled. If set to True, an\n inventory list is generated. If set to False, no inventory list is\n generated.

", + "smithy.api#required": {} + } + }, + "Filter": { + "target": "com.amazonaws.s3#InventoryFilter", + "traits": { + "smithy.api#documentation": "

Specifies an inventory filter. The inventory only includes objects that meet the\n filter's criteria.

" + } + }, + "Id": { + "target": "com.amazonaws.s3#InventoryId", + "traits": { + "smithy.api#documentation": "

The ID used to identify the inventory configuration.

", + "smithy.api#required": {} + } + }, + "IncludedObjectVersions": { + "target": "com.amazonaws.s3#InventoryIncludedObjectVersions", + "traits": { + "smithy.api#documentation": "

Object versions to include in the inventory list. If set to All, the list\n includes all the object versions, which adds the version-related fields\n VersionId, IsLatest, and DeleteMarker to the\n list. If set to Current, the list does not contain these version-related\n fields.

", + "smithy.api#required": {} + } + }, + "OptionalFields": { + "target": "com.amazonaws.s3#InventoryOptionalFields", + "traits": { + "smithy.api#documentation": "

Contains the optional fields that are included in the inventory results.

" + } + }, + "Schedule": { + "target": "com.amazonaws.s3#InventorySchedule", + "traits": { + "smithy.api#documentation": "

Specifies the schedule for generating inventory results.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the inventory configuration for an Amazon S3 bucket. For more information, see\n GET Bucket inventory in the Amazon S3 API Reference.

" + } + }, + "com.amazonaws.s3#InventoryConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#InventoryConfiguration" + } + }, + "com.amazonaws.s3#InventoryDestination": { + "type": "structure", + "members": { + "S3BucketDestination": { + "target": "com.amazonaws.s3#InventoryS3BucketDestination", + "traits": { + "smithy.api#documentation": "

Contains the bucket name, file format, bucket owner (optional), and prefix (optional)\n where inventory results are published.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the inventory configuration for an Amazon S3 bucket.

" + } + }, + "com.amazonaws.s3#InventoryEncryption": { + "type": "structure", + "members": { + "SSES3": { + "target": "com.amazonaws.s3#SSES3", + "traits": { + "smithy.api#documentation": "

Specifies the use of SSE-S3 to encrypt delivered inventory reports.

", + "smithy.api#xmlName": "SSE-S3" + } + }, + "SSEKMS": { + "target": "com.amazonaws.s3#SSEKMS", + "traits": { + "smithy.api#documentation": "

Specifies the use of SSE-KMS to encrypt delivered inventory reports.

", + "smithy.api#xmlName": "SSE-KMS" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the type of server-side encryption used to encrypt the inventory\n results.

" + } + }, + "com.amazonaws.s3#InventoryFilter": { + "type": "structure", + "members": { + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "

The prefix that an object must have to be included in the inventory results.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies an inventory filter. The inventory only includes objects that meet the\n filter's criteria.

" + } + }, + "com.amazonaws.s3#InventoryFormat": { + "type": "enum", + "members": { + "CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CSV" + } + }, + "ORC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ORC" + } + }, + "Parquet": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Parquet" + } + } + } + }, + "com.amazonaws.s3#InventoryFrequency": { + "type": "enum", + "members": { + "Daily": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Daily" + } + }, + "Weekly": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Weekly" + } + } + } + }, + "com.amazonaws.s3#InventoryId": { + "type": "string" + }, + "com.amazonaws.s3#InventoryIncludedObjectVersions": { + "type": "enum", + "members": { + "All": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "All" + } + }, + "Current": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Current" + } + } + } + }, + "com.amazonaws.s3#InventoryOptionalField": { + "type": "enum", + "members": { + "Size": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Size" + } + }, + "LastModifiedDate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LastModifiedDate" + } + }, + "StorageClass": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StorageClass" + } + }, + "ETag": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ETag" + } + }, + "IsMultipartUploaded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IsMultipartUploaded" + } + }, + "ReplicationStatus": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ReplicationStatus" + } + }, + "EncryptionStatus": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EncryptionStatus" + } + }, + "ObjectLockRetainUntilDate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ObjectLockRetainUntilDate" + } + }, + "ObjectLockMode": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ObjectLockMode" + } + }, + "ObjectLockLegalHoldStatus": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ObjectLockLegalHoldStatus" + } + }, + "IntelligentTieringAccessTier": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IntelligentTieringAccessTier" + } + }, + "BucketKeyStatus": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BucketKeyStatus" + } + }, + "ChecksumAlgorithm": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ChecksumAlgorithm" + } + }, + "ObjectAccessControlList": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ObjectAccessControlList" + } + }, + "ObjectOwner": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ObjectOwner" + } + } + } + }, + "com.amazonaws.s3#InventoryOptionalFields": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#InventoryOptionalField", + "traits": { + "smithy.api#xmlName": "Field" + } + } + }, + "com.amazonaws.s3#InventoryS3BucketDestination": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID that owns the destination S3 bucket. If no account ID is provided, the\n owner is not validated before exporting data.

\n \n

Although this value is optional, we strongly recommend that you set it to help\n prevent problems if the destination bucket ownership changes.

\n " + } + }, + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the bucket where inventory results will be\n published.

", + "smithy.api#required": {} + } + }, + "Format": { + "target": "com.amazonaws.s3#InventoryFormat", + "traits": { + "smithy.api#documentation": "

Specifies the output format of the inventory results.

", + "smithy.api#required": {} + } + }, + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "

The prefix that is prepended to all inventory results.

" + } + }, + "Encryption": { + "target": "com.amazonaws.s3#InventoryEncryption", + "traits": { + "smithy.api#documentation": "

Contains the type of server-side encryption used to encrypt the inventory\n results.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the bucket name, file format, bucket owner (optional), and prefix (optional)\n where inventory results are published.

" + } + }, + "com.amazonaws.s3#InventorySchedule": { + "type": "structure", + "members": { + "Frequency": { + "target": "com.amazonaws.s3#InventoryFrequency", + "traits": { + "smithy.api#documentation": "

Specifies how frequently inventory results are produced.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the schedule for generating inventory results.

" + } + }, + "com.amazonaws.s3#IsEnabled": { + "type": "boolean" + }, + "com.amazonaws.s3#IsLatest": { + "type": "boolean" + }, + "com.amazonaws.s3#IsPublic": { + "type": "boolean" + }, + "com.amazonaws.s3#IsRestoreInProgress": { + "type": "boolean" + }, + "com.amazonaws.s3#IsTruncated": { + "type": "boolean" + }, + "com.amazonaws.s3#JSONInput": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.s3#JSONType", + "traits": { + "smithy.api#documentation": "

The type of JSON. Valid values: Document, Lines.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies JSON as object's input serialization format.

" + } + }, + "com.amazonaws.s3#JSONOutput": { + "type": "structure", + "members": { + "RecordDelimiter": { + "target": "com.amazonaws.s3#RecordDelimiter", + "traits": { + "smithy.api#documentation": "

The value used to separate individual records in the output. If no value is specified,\n Amazon S3 uses a newline character ('\\n').

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies JSON as request's output serialization format.

" + } + }, + "com.amazonaws.s3#JSONType": { + "type": "enum", + "members": { + "DOCUMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOCUMENT" + } + }, + "LINES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINES" + } + } + } + }, + "com.amazonaws.s3#KMSContext": { + "type": "string" + }, + "com.amazonaws.s3#KeyCount": { + "type": "integer" + }, + "com.amazonaws.s3#KeyMarker": { + "type": "string" + }, + "com.amazonaws.s3#KeyPrefixEquals": { + "type": "string" + }, + "com.amazonaws.s3#LambdaFunctionArn": { + "type": "string" + }, + "com.amazonaws.s3#LambdaFunctionConfiguration": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.s3#NotificationId" + }, + "LambdaFunctionArn": { + "target": "com.amazonaws.s3#LambdaFunctionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Lambda function that Amazon S3 invokes when the\n specified event type occurs.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "CloudFunction" + } + }, + "Events": { + "target": "com.amazonaws.s3#EventList", + "traits": { + "smithy.api#documentation": "

The Amazon S3 bucket event for which to invoke the Lambda function. For more information,\n see Supported\n Event Types in the Amazon S3 User Guide.

", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Event" + } + }, + "Filter": { + "target": "com.amazonaws.s3#NotificationConfigurationFilter" + } + }, + "traits": { + "smithy.api#documentation": "

A container for specifying the configuration for Lambda notifications.

" + } + }, + "com.amazonaws.s3#LambdaFunctionConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#LambdaFunctionConfiguration" + } + }, + "com.amazonaws.s3#LastModified": { + "type": "timestamp" + }, + "com.amazonaws.s3#LastModifiedTime": { + "type": "timestamp", + "traits": { + "smithy.api#timestampFormat": "http-date" + } + }, + "com.amazonaws.s3#LifecycleExpiration": { + "type": "structure", + "members": { + "Date": { + "target": "com.amazonaws.s3#Date", + "traits": { + "smithy.api#documentation": "

Indicates at what date the object is to be moved or deleted. The date value must conform\n to the ISO 8601 format. The time is always midnight UTC.

\n \n

This parameter applies to general purpose buckets only. It is not supported for\n directory bucket lifecycle configurations.

\n " + } + }, + "Days": { + "target": "com.amazonaws.s3#Days", + "traits": { + "smithy.api#documentation": "

Indicates the lifetime, in days, of the objects that are subject to the rule. The value\n must be a non-zero positive integer.

" + } + }, + "ExpiredObjectDeleteMarker": { + "target": "com.amazonaws.s3#ExpiredObjectDeleteMarker", + "traits": { + "smithy.api#documentation": "

Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set\n to true, the delete marker will be expired; if set to false the policy takes no action.\n This cannot be specified with Days or Date in a Lifecycle Expiration Policy.

\n \n

This parameter applies to general purpose buckets only. It is not supported for\n directory bucket lifecycle configurations.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Container for the expiration for the lifecycle of the object.

\n

For more information see, Managing your storage\n lifecycle in the Amazon S3 User Guide.

" + } + }, + "com.amazonaws.s3#LifecycleRule": { + "type": "structure", + "members": { + "Expiration": { + "target": "com.amazonaws.s3#LifecycleExpiration", + "traits": { + "smithy.api#documentation": "

Specifies the expiration for the lifecycle of the object in the form of date, days and,\n whether the object has a delete marker.

" + } + }, + "ID": { + "target": "com.amazonaws.s3#ID", + "traits": { + "smithy.api#documentation": "

Unique identifier for the rule. The value cannot be longer than 255 characters.

" + } + }, + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

Prefix identifying one or more objects to which the rule applies. This is\n no longer used; use Filter instead.

\n \n

Replacement must be made for object keys containing special characters (such as carriage returns) when using \n XML requests. For more information, see \n XML related object key constraints.

\n " + } + }, + "Filter": { + "target": "com.amazonaws.s3#LifecycleRuleFilter", + "traits": { + "smithy.api#documentation": "

The Filter is used to identify objects that a Lifecycle Rule applies to. A\n Filter must have exactly one of Prefix, Tag, or\n And specified. Filter is required if the\n LifecycleRule does not contain a Prefix element.

\n \n

\n Tag filters are not supported for directory buckets.

\n " + } + }, + "Status": { + "target": "com.amazonaws.s3#ExpirationStatus", + "traits": { + "smithy.api#documentation": "

If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not\n currently being applied.

", + "smithy.api#required": {} + } + }, + "Transitions": { + "target": "com.amazonaws.s3#TransitionList", + "traits": { + "smithy.api#documentation": "

Specifies when an Amazon S3 object transitions to a specified storage class.

\n \n

This parameter applies to general purpose buckets only. It is not supported for\n directory bucket lifecycle configurations.

\n ", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Transition" + } + }, + "NoncurrentVersionTransitions": { + "target": "com.amazonaws.s3#NoncurrentVersionTransitionList", + "traits": { + "smithy.api#documentation": "

Specifies the transition rule for the lifecycle rule that describes when noncurrent\n objects transition to a specific storage class. If your bucket is versioning-enabled (or\n versioning is suspended), you can set this action to request that Amazon S3 transition\n noncurrent object versions to a specific storage class at a set period in the object's\n lifetime.

\n \n

This parameter applies to general purpose buckets only. It is not supported for\n directory bucket lifecycle configurations.

\n ", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "NoncurrentVersionTransition" + } + }, + "NoncurrentVersionExpiration": { + "target": "com.amazonaws.s3#NoncurrentVersionExpiration" + }, + "AbortIncompleteMultipartUpload": { + "target": "com.amazonaws.s3#AbortIncompleteMultipartUpload" + } + }, + "traits": { + "smithy.api#documentation": "

A lifecycle rule for individual objects in an Amazon S3 bucket.

\n

For more information see, Managing your storage\n lifecycle in the Amazon S3 User Guide.

" + } + }, + "com.amazonaws.s3#LifecycleRuleAndOperator": { + "type": "structure", + "members": { + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "

Prefix identifying one or more objects to which the rule applies.

" + } + }, + "Tags": { + "target": "com.amazonaws.s3#TagSet", + "traits": { + "smithy.api#documentation": "

All of these tags must exist in the object's tag set in order for the rule to\n apply.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Tag" + } + }, + "ObjectSizeGreaterThan": { + "target": "com.amazonaws.s3#ObjectSizeGreaterThanBytes", + "traits": { + "smithy.api#documentation": "

Minimum object size to which the rule applies.

" + } + }, + "ObjectSizeLessThan": { + "target": "com.amazonaws.s3#ObjectSizeLessThanBytes", + "traits": { + "smithy.api#documentation": "

Maximum object size to which the rule applies.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This is used in a Lifecycle Rule Filter to apply a logical AND to two or more\n predicates. The Lifecycle Rule will apply to any object matching all of the predicates\n configured inside the And operator.

" + } + }, + "com.amazonaws.s3#LifecycleRuleFilter": { + "type": "structure", + "members": { + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "

Prefix identifying one or more objects to which the rule applies.

\n \n

Replacement must be made for object keys containing special characters (such as carriage returns) when using \n XML requests. For more information, see \n XML related object key constraints.

\n " + } + }, + "Tag": { + "target": "com.amazonaws.s3#Tag", + "traits": { + "smithy.api#documentation": "

This tag must exist in the object's tag set in order for the rule to apply.

\n \n

This parameter applies to general purpose buckets only. It is not supported for\n directory bucket lifecycle configurations.

\n " + } + }, + "ObjectSizeGreaterThan": { + "target": "com.amazonaws.s3#ObjectSizeGreaterThanBytes", + "traits": { + "smithy.api#documentation": "

Minimum object size to which the rule applies.

" + } + }, + "ObjectSizeLessThan": { + "target": "com.amazonaws.s3#ObjectSizeLessThanBytes", + "traits": { + "smithy.api#documentation": "

Maximum object size to which the rule applies.

" + } + }, + "And": { + "target": "com.amazonaws.s3#LifecycleRuleAndOperator" + } + }, + "traits": { + "smithy.api#documentation": "

The Filter is used to identify objects that a Lifecycle Rule applies to. A\n Filter can have exactly one of Prefix, Tag,\n ObjectSizeGreaterThan, ObjectSizeLessThan, or And\n specified. If the Filter element is left empty, the Lifecycle Rule applies to\n all objects in the bucket.

" + } + }, + "com.amazonaws.s3#LifecycleRules": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#LifecycleRule" + } + }, + "com.amazonaws.s3#ListBucketAnalyticsConfigurations": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#ListBucketAnalyticsConfigurationsRequest" + }, + "output": { + "target": "com.amazonaws.s3#ListBucketAnalyticsConfigurationsOutput" + }, + "traits": { + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Lists the analytics configurations for the bucket. You can have up to 1,000 analytics\n configurations per bucket.

\n

This action supports list pagination and does not return more than 100 configurations at\n a time. You should always check the IsTruncated element in the response. If\n there are no more configurations to list, IsTruncated is set to false. If\n there are more configurations to list, IsTruncated is set to true, and there\n will be a value in NextContinuationToken. You use the\n NextContinuationToken value to continue the pagination of the list by\n passing the value in continuation-token in the request to GET the next\n page.

\n

To use this operation, you must have permissions to perform the\n s3:GetAnalyticsConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.

\n

For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class\n Analysis.

\n

The following operations are related to\n ListBucketAnalyticsConfigurations:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?analytics&x-id=ListBucketAnalyticsConfigurations", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#ListBucketAnalyticsConfigurationsOutput": { + "type": "structure", + "members": { + "IsTruncated": { + "target": "com.amazonaws.s3#IsTruncated", + "traits": { + "smithy.api#documentation": "

Indicates whether the returned list of analytics configurations is complete. A value of\n true indicates that the list is not complete and the NextContinuationToken will be provided\n for a subsequent request.

" + } + }, + "ContinuationToken": { + "target": "com.amazonaws.s3#Token", + "traits": { + "smithy.api#documentation": "

The marker that is used as a starting point for this analytics configuration list\n response. This value is present if it was sent in the request.

" + } + }, + "NextContinuationToken": { + "target": "com.amazonaws.s3#NextToken", + "traits": { + "smithy.api#documentation": "

\n NextContinuationToken is sent when isTruncated is true, which\n indicates that there are more analytics configurations to list. The next request must\n include this NextContinuationToken. The token is obfuscated and is not a\n usable value.

" + } + }, + "AnalyticsConfigurationList": { + "target": "com.amazonaws.s3#AnalyticsConfigurationList", + "traits": { + "smithy.api#documentation": "

The list of analytics configurations for a bucket.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "AnalyticsConfiguration" + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#xmlName": "ListBucketAnalyticsConfigurationResult" + } + }, + "com.amazonaws.s3#ListBucketAnalyticsConfigurationsRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket from which analytics configurations are retrieved.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ContinuationToken": { + "target": "com.amazonaws.s3#Token", + "traits": { + "smithy.api#documentation": "

The ContinuationToken that represents a placeholder from where this request\n should begin.

", + "smithy.api#httpQuery": "continuation-token" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#ListBucketIntelligentTieringConfigurations": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#ListBucketIntelligentTieringConfigurationsRequest" + }, + "output": { + "target": "com.amazonaws.s3#ListBucketIntelligentTieringConfigurationsOutput" + }, + "traits": { + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Lists the S3 Intelligent-Tiering configuration from the specified bucket.

\n

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.

\n

The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.

\n

For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

\n

Operations related to ListBucketIntelligentTieringConfigurations include:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?intelligent-tiering&x-id=ListBucketIntelligentTieringConfigurations", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#ListBucketIntelligentTieringConfigurationsOutput": { + "type": "structure", + "members": { + "IsTruncated": { + "target": "com.amazonaws.s3#IsTruncated", + "traits": { + "smithy.api#documentation": "

Indicates whether the returned list of analytics configurations is complete. A value of\n true indicates that the list is not complete and the\n NextContinuationToken will be provided for a subsequent request.

" + } + }, + "ContinuationToken": { + "target": "com.amazonaws.s3#Token", + "traits": { + "smithy.api#documentation": "

The ContinuationToken that represents a placeholder from where this request\n should begin.

" + } + }, + "NextContinuationToken": { + "target": "com.amazonaws.s3#NextToken", + "traits": { + "smithy.api#documentation": "

The marker used to continue this inventory configuration listing. Use the\n NextContinuationToken from this response to continue the listing in a\n subsequent request. The continuation token is an opaque value that Amazon S3 understands.

" + } + }, + "IntelligentTieringConfigurationList": { + "target": "com.amazonaws.s3#IntelligentTieringConfigurationList", + "traits": { + "smithy.api#documentation": "

The list of S3 Intelligent-Tiering configurations for a bucket.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "IntelligentTieringConfiguration" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3#ListBucketIntelligentTieringConfigurationsRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ContinuationToken": { + "target": "com.amazonaws.s3#Token", + "traits": { + "smithy.api#documentation": "

The ContinuationToken that represents a placeholder from where this request\n should begin.

", + "smithy.api#httpQuery": "continuation-token" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#ListBucketInventoryConfigurations": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#ListBucketInventoryConfigurationsRequest" + }, + "output": { + "target": "com.amazonaws.s3#ListBucketInventoryConfigurationsOutput" + }, + "traits": { + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Returns a list of inventory configurations for the bucket. You can have up to 1,000\n analytics configurations per bucket.

\n

This action supports list pagination and does not return more than 100 configurations at\n a time. Always check the IsTruncated element in the response. If there are no\n more configurations to list, IsTruncated is set to false. If there are more\n configurations to list, IsTruncated is set to true, and there is a value in\n NextContinuationToken. You use the NextContinuationToken value\n to continue the pagination of the list by passing the value in continuation-token in the\n request to GET the next page.

\n

To use this operation, you must have permissions to perform the\n s3:GetInventoryConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.

\n

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory\n

\n

The following operations are related to\n ListBucketInventoryConfigurations:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?inventory&x-id=ListBucketInventoryConfigurations", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#ListBucketInventoryConfigurationsOutput": { + "type": "structure", + "members": { + "ContinuationToken": { + "target": "com.amazonaws.s3#Token", + "traits": { + "smithy.api#documentation": "

If sent in the request, the marker that is used as a starting point for this inventory\n configuration list response.

" + } + }, + "InventoryConfigurationList": { + "target": "com.amazonaws.s3#InventoryConfigurationList", + "traits": { + "smithy.api#documentation": "

The list of inventory configurations for a bucket.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "InventoryConfiguration" + } + }, + "IsTruncated": { + "target": "com.amazonaws.s3#IsTruncated", + "traits": { + "smithy.api#documentation": "

Tells whether the returned list of inventory configurations is complete. A value of true\n indicates that the list is not complete and the NextContinuationToken is provided for a\n subsequent request.

" + } + }, + "NextContinuationToken": { + "target": "com.amazonaws.s3#NextToken", + "traits": { + "smithy.api#documentation": "

The marker used to continue this inventory configuration listing. Use the\n NextContinuationToken from this response to continue the listing in a\n subsequent request. The continuation token is an opaque value that Amazon S3 understands.

" + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#xmlName": "ListInventoryConfigurationsResult" + } + }, + "com.amazonaws.s3#ListBucketInventoryConfigurationsRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket containing the inventory configurations to retrieve.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ContinuationToken": { + "target": "com.amazonaws.s3#Token", + "traits": { + "smithy.api#documentation": "

The marker used to continue an inventory configuration listing that has been truncated.\n Use the NextContinuationToken from a previously truncated list response to\n continue the listing. The continuation token is an opaque value that Amazon S3\n understands.

", + "smithy.api#httpQuery": "continuation-token" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#ListBucketMetricsConfigurations": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#ListBucketMetricsConfigurationsRequest" + }, + "output": { + "target": "com.amazonaws.s3#ListBucketMetricsConfigurationsOutput" + }, + "traits": { + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Lists the metrics configurations for the bucket. The metrics configurations are only for\n the request metrics of the bucket and do not provide information on daily storage metrics.\n You can have up to 1,000 configurations per bucket.

\n

This action supports list pagination and does not return more than 100 configurations at\n a time. Always check the IsTruncated element in the response. If there are no\n more configurations to list, IsTruncated is set to false. If there are more\n configurations to list, IsTruncated is set to true, and there is a value in\n NextContinuationToken. You use the NextContinuationToken value\n to continue the pagination of the list by passing the value in\n continuation-token in the request to GET the next page.

\n

To use this operation, you must have permissions to perform the\n s3:GetMetricsConfiguration action. The bucket owner has this permission by\n default. The bucket owner can grant this permission to others. For more information about\n permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.

\n

For more information about metrics configurations and CloudWatch request metrics, see\n Monitoring Metrics with Amazon CloudWatch.

\n

The following operations are related to\n ListBucketMetricsConfigurations:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?metrics&x-id=ListBucketMetricsConfigurations", + "code": 200 + } + } + }, + "com.amazonaws.s3#ListBucketMetricsConfigurationsOutput": { + "type": "structure", + "members": { + "IsTruncated": { + "target": "com.amazonaws.s3#IsTruncated", + "traits": { + "smithy.api#documentation": "

Indicates whether the returned list of metrics configurations is complete. A value of\n true indicates that the list is not complete and the NextContinuationToken will be provided\n for a subsequent request.

" + } + }, + "ContinuationToken": { + "target": "com.amazonaws.s3#Token", + "traits": { + "smithy.api#documentation": "

The marker that is used as a starting point for this metrics configuration list\n response. This value is present if it was sent in the request.

" + } + }, + "NextContinuationToken": { + "target": "com.amazonaws.s3#NextToken", + "traits": { + "smithy.api#documentation": "

The marker used to continue a metrics configuration listing that has been truncated. Use\n the NextContinuationToken from a previously truncated list response to\n continue the listing. The continuation token is an opaque value that Amazon S3\n understands.

" + } + }, + "MetricsConfigurationList": { + "target": "com.amazonaws.s3#MetricsConfigurationList", + "traits": { + "smithy.api#documentation": "

The list of metrics configurations for a bucket.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "MetricsConfiguration" + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#xmlName": "ListMetricsConfigurationsResult" + } + }, + "com.amazonaws.s3#ListBucketMetricsConfigurationsRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket containing the metrics configurations to retrieve.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ContinuationToken": { + "target": "com.amazonaws.s3#Token", + "traits": { + "smithy.api#documentation": "

The marker that is used to continue a metrics configuration listing that has been\n truncated. Use the NextContinuationToken from a previously truncated list\n response to continue the listing. The continuation token is an opaque value that Amazon S3\n understands.

", + "smithy.api#httpQuery": "continuation-token" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#ListBuckets": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#ListBucketsRequest" + }, + "output": { + "target": "com.amazonaws.s3#ListBucketsOutput" + }, + "traits": { + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Returns a list of all buckets owned by the authenticated sender of the request. To grant IAM permission to use\n this operation, you must add the s3:ListAllMyBuckets policy action.

\n

For information about Amazon S3 buckets, see Creating, configuring, and\n working with Amazon S3 buckets.

\n \n

We strongly recommend using only paginated ListBuckets requests. Unpaginated ListBuckets requests are only supported for \n Amazon Web Services accounts set to the default general purpose bucket quota of 10,000. If you have an approved \n general purpose bucket quota above 10,000, you must send paginated ListBuckets requests to list your account’s buckets. \n All unpaginated ListBuckets requests will be rejected for Amazon Web Services accounts with a general purpose bucket quota \n greater than 10,000.

\n ", + "smithy.api#examples": [ + { + "title": "To list all buckets", + "documentation": "The following example returns all the buckets owned by the sender of this request.", + "output": { + "Owner": { + "DisplayName": "own-display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31" + }, + "Buckets": [ + { + "CreationDate": "2012-02-15T21:03:02.000Z", + "Name": "examplebucket" + }, + { + "CreationDate": "2011-07-24T19:33:50.000Z", + "Name": "examplebucket2" + }, + { + "CreationDate": "2010-12-17T00:56:49.000Z", + "Name": "examplebucket3" + } + ] + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/?x-id=ListBuckets", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "ContinuationToken", + "outputToken": "ContinuationToken", + "items": "Buckets", + "pageSize": "MaxBuckets" + } + } + }, + "com.amazonaws.s3#ListBucketsOutput": { + "type": "structure", + "members": { + "Buckets": { + "target": "com.amazonaws.s3#Buckets", + "traits": { + "smithy.api#documentation": "

The list of buckets owned by the requester.

" + } + }, + "Owner": { + "target": "com.amazonaws.s3#Owner", + "traits": { + "smithy.api#documentation": "

The owner of the buckets listed.

" + } + }, + "ContinuationToken": { + "target": "com.amazonaws.s3#NextToken", + "traits": { + "smithy.api#documentation": "

\n ContinuationToken is included in the response when there are more buckets\n that can be listed with pagination. The next ListBuckets request to Amazon S3 can\n be continued with this ContinuationToken. ContinuationToken is\n obfuscated and is not a real bucket.

" + } + }, + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "

If Prefix was sent with the request, it is included in the response.

\n

All bucket names in the response begin with the specified bucket name prefix.

" + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#xmlName": "ListAllMyBucketsResult" + } + }, + "com.amazonaws.s3#ListBucketsRequest": { + "type": "structure", + "members": { + "MaxBuckets": { + "target": "com.amazonaws.s3#MaxBuckets", + "traits": { + "smithy.api#documentation": "

Maximum number of buckets to be returned in response. When the number is more than the\n count of buckets that are owned by an Amazon Web Services account, return all the buckets in\n response.

", + "smithy.api#httpQuery": "max-buckets" + } + }, + "ContinuationToken": { + "target": "com.amazonaws.s3#Token", + "traits": { + "smithy.api#documentation": "

\n ContinuationToken indicates to Amazon S3 that the list is being continued on\n this bucket with a token. ContinuationToken is obfuscated and is not a real\n key. You can use this ContinuationToken for pagination of the list results.

\n

Length Constraints: Minimum length of 0. Maximum length of 1024.

\n

Required: No.

\n \n

If you specify the bucket-region, prefix, or continuation-token \n query parameters without using max-buckets to set the maximum number of buckets returned in the response, \n Amazon S3 applies a default page size of 10,000 and provides a continuation token if there are more buckets.

\n ", + "smithy.api#httpQuery": "continuation-token" + } + }, + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "

Limits the response to bucket names that begin with the specified bucket name\n prefix.

", + "smithy.api#httpQuery": "prefix" + } + }, + "BucketRegion": { + "target": "com.amazonaws.s3#BucketRegion", + "traits": { + "smithy.api#documentation": "

Limits the response to buckets that are located in the specified Amazon Web Services Region. The Amazon Web Services\n Region must be expressed according to the Amazon Web Services Region code, such as us-west-2\n for the US West (Oregon) Region. For a list of the valid values for all of the Amazon Web Services\n Regions, see Regions and Endpoints.

\n \n

Requests made to a Regional endpoint that is different from the\n bucket-region parameter are not supported. For example, if you want to\n limit the response to your buckets in Region us-west-2, the request must be\n made to an endpoint in Region us-west-2.

\n ", + "smithy.api#httpQuery": "bucket-region" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#ListDirectoryBuckets": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#ListDirectoryBucketsRequest" + }, + "output": { + "target": "com.amazonaws.s3#ListDirectoryBucketsOutput" + }, + "traits": { + "smithy.api#documentation": "

Returns a list of all Amazon S3 directory buckets owned by the authenticated sender of the\n request. For more information about directory buckets, see Directory buckets in the Amazon S3 User Guide.

\n \n

\n Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name\n . Virtual-hosted-style requests aren't supported. \nFor more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the\n Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the\n Amazon S3 User Guide.

\n \n
\n
Permissions
\n
\n

You must have the s3express:ListAllMyDirectoryBuckets permission\n in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource.\n For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

\n
\n
HTTP Host header syntax
\n
\n

\n Directory buckets - The HTTP Host\n header syntax is\n s3express-control.region.amazonaws.com.

\n
\n
\n \n

The BucketRegion response element is not part of the\n ListDirectoryBuckets Response Syntax.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/?x-id=ListDirectoryBuckets", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "ContinuationToken", + "outputToken": "ContinuationToken", + "items": "Buckets", + "pageSize": "MaxDirectoryBuckets" + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#ListDirectoryBucketsOutput": { + "type": "structure", + "members": { + "Buckets": { + "target": "com.amazonaws.s3#Buckets", + "traits": { + "smithy.api#documentation": "

The list of buckets owned by the requester.

" + } + }, + "ContinuationToken": { + "target": "com.amazonaws.s3#DirectoryBucketToken", + "traits": { + "smithy.api#documentation": "

If ContinuationToken was sent with the request, it is included in the\n response. You can use the returned ContinuationToken for pagination of the\n list response.

" + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#xmlName": "ListAllMyDirectoryBucketsResult" + } + }, + "com.amazonaws.s3#ListDirectoryBucketsRequest": { + "type": "structure", + "members": { + "ContinuationToken": { + "target": "com.amazonaws.s3#DirectoryBucketToken", + "traits": { + "smithy.api#documentation": "

\n ContinuationToken indicates to Amazon S3 that the list is being continued on\n buckets in this account with a token. ContinuationToken is obfuscated and is\n not a real bucket name. You can use this ContinuationToken for the pagination\n of the list results.

", + "smithy.api#httpQuery": "continuation-token" + } + }, + "MaxDirectoryBuckets": { + "target": "com.amazonaws.s3#MaxDirectoryBuckets", + "traits": { + "smithy.api#documentation": "

Maximum number of buckets to be returned in response. When the number is more than the\n count of buckets that are owned by an Amazon Web Services account, return all the buckets in\n response.

", + "smithy.api#httpQuery": "max-directory-buckets" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#ListMultipartUploads": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#ListMultipartUploadsRequest" + }, + "output": { + "target": "com.amazonaws.s3#ListMultipartUploadsOutput" + }, + "traits": { + "smithy.api#documentation": "

This operation lists in-progress multipart uploads in a bucket. An in-progress multipart\n upload is a multipart upload that has been initiated by the\n CreateMultipartUpload request, but has not yet been completed or\n aborted.

\n \n

\n Directory buckets - If multipart uploads in\n a directory bucket are in progress, you can't delete the bucket until all the\n in-progress multipart uploads are aborted or completed. To delete these in-progress\n multipart uploads, use the ListMultipartUploads operation to list the\n in-progress multipart uploads in the bucket and use the\n AbortMultipartUpload operation to abort all the in-progress multipart\n uploads.

\n \n

The ListMultipartUploads operation returns a maximum of 1,000 multipart\n uploads in the response. The limit of 1,000 multipart uploads is also the default value.\n You can further limit the number of uploads in a response by specifying the\n max-uploads request parameter. If there are more than 1,000 multipart\n uploads that satisfy your ListMultipartUploads request, the response returns\n an IsTruncated element with the value of true, a\n NextKeyMarker element, and a NextUploadIdMarker element. To\n list the remaining multipart uploads, you need to make subsequent\n ListMultipartUploads requests. In these requests, include two query\n parameters: key-marker and upload-id-marker. Set the value of\n key-marker to the NextKeyMarker value from the previous\n response. Similarly, set the value of upload-id-marker to the\n NextUploadIdMarker value from the previous response.

\n \n

\n Directory buckets - The\n upload-id-marker element and the NextUploadIdMarker element\n aren't supported by directory buckets. To list the additional multipart uploads, you\n only need to set the value of key-marker to the NextKeyMarker\n value from the previous response.

\n \n

For more information about multipart uploads, see Uploading Objects Using Multipart\n Upload in the Amazon S3 User Guide.

\n \n

\n Directory buckets -\n For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket-name.s3express-zone-id.region-code.amazonaws.com/key-name\n . Path-style requests are not supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the\n Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the\n Amazon S3 User Guide.

\n \n
\n
Permissions
\n
\n
    \n
  • \n

    \n General purpose bucket permissions - For\n information about permissions required to use the multipart upload API, see\n Multipart Upload and\n Permissions in the Amazon S3 User Guide.

    \n
    • \n
  • \n

    \n Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the \n CreateSession\n API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. \nAmazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see \n CreateSession\n .

    \n
    • \n
\n
\n
Sorting of multipart uploads in response
\n
\n
    \n
  • \n

    \n General purpose bucket - In the\n ListMultipartUploads response, the multipart uploads are\n sorted based on two criteria:

    \n
      \n
    • \n

      Key-based sorting - Multipart uploads are initially sorted\n in ascending order based on their object keys.

      \n
      • \n
    • \n

      Time-based sorting - For uploads that share the same object\n key, they are further sorted in ascending order based on the upload\n initiation time. Among uploads with the same key, the one that was\n initiated first will appear before the ones that were initiated\n later.

      \n
      • \n
    \n
    • \n
  • \n

    \n Directory bucket - In the\n ListMultipartUploads response, the multipart uploads aren't\n sorted lexicographically based on the object keys.\n \n

    \n
    • \n
\n
\n
HTTP Host header syntax
\n
\n

\n Directory buckets - The HTTP Host header syntax is \n Bucket-name.s3express-zone-id.region-code.amazonaws.com.

\n
\n
\n

The following operations are related to ListMultipartUploads:

\n ", + "smithy.api#examples": [ + { + "title": "List next set of multipart uploads when previous result is truncated", + "documentation": "The following example specifies the upload-id-marker and key-marker from previous truncated response to retrieve next setup of multipart uploads.", + "input": { + "Bucket": "examplebucket", + "KeyMarker": "nextkeyfrompreviousresponse", + "MaxUploads": 2, + "UploadIdMarker": "valuefrompreviousresponse" + }, + "output": { + "UploadIdMarker": "", + "NextKeyMarker": "someobjectkey", + "Bucket": "acl1", + "NextUploadIdMarker": "examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--", + "Uploads": [ + { + "Initiator": { + "DisplayName": "ownder-display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + }, + "Initiated": "2014-05-01T05:40:58.000Z", + "UploadId": "gZ30jIqlUa.CInXklLQtSMJITdUnoZ1Y5GACB5UckOtspm5zbDMCkPF_qkfZzMiFZ6dksmcnqxJyIBvQMG9X9Q--", + "StorageClass": "STANDARD", + "Key": "JavaFile", + "Owner": { + "DisplayName": "mohanataws", + "ID": "852b113e7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + } + }, + { + "Initiator": { + "DisplayName": "ownder-display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + }, + "Initiated": "2014-05-01T05:41:27.000Z", + "UploadId": "b7tZSqIlo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--", + "StorageClass": "STANDARD", + "Key": "JavaFile", + "Owner": { + "DisplayName": "ownder-display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + } + } + ], + "KeyMarker": "", + "MaxUploads": 2, + "IsTruncated": true + } + }, + { + "title": "To list in-progress multipart uploads on a bucket", + "documentation": "The following example lists in-progress multipart uploads on a specific bucket.", + "input": { + "Bucket": "examplebucket" + }, + "output": { + "Uploads": [ + { + "Initiator": { + "DisplayName": "display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + }, + "Initiated": "2014-05-01T05:40:58.000Z", + "UploadId": "examplelUa.CInXklLQtSMJITdUnoZ1Y5GACB5UckOtspm5zbDMCkPF_qkfZzMiFZ6dksmcnqxJyIBvQMG9X9Q--", + "StorageClass": "STANDARD", + "Key": "JavaFile", + "Owner": { + "DisplayName": "display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + } + }, + { + "Initiator": { + "DisplayName": "display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + }, + "Initiated": "2014-05-01T05:41:27.000Z", + "UploadId": "examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--", + "StorageClass": "STANDARD", + "Key": "JavaFile", + "Owner": { + "DisplayName": "display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + } + } + ] + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?uploads", + "code": 200 + } + } + }, + "com.amazonaws.s3#ListMultipartUploadsOutput": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket to which the multipart upload was initiated. Does not return the\n access point ARN or access point alias if used.

" + } + }, + "KeyMarker": { + "target": "com.amazonaws.s3#KeyMarker", + "traits": { + "smithy.api#documentation": "

The key at or after which the listing began.

" + } + }, + "UploadIdMarker": { + "target": "com.amazonaws.s3#UploadIdMarker", + "traits": { + "smithy.api#documentation": "

Together with key-marker, specifies the multipart upload after which listing should\n begin. If key-marker is not specified, the upload-id-marker parameter is ignored.\n Otherwise, any multipart uploads for a key equal to the key-marker might be included in the\n list only if they have an upload ID lexicographically greater than the specified\n upload-id-marker.

\n \n

This functionality is not supported for directory buckets.

\n " + } + }, + "NextKeyMarker": { + "target": "com.amazonaws.s3#NextKeyMarker", + "traits": { + "smithy.api#documentation": "

When a list is truncated, this element specifies the value that should be used for the\n key-marker request parameter in a subsequent request.

" + } + }, + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "

When a prefix is provided in the request, this field contains the specified prefix. The\n result contains only keys starting with the specified prefix.

\n \n

\n Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.

\n " + } + }, + "Delimiter": { + "target": "com.amazonaws.s3#Delimiter", + "traits": { + "smithy.api#documentation": "

Contains the delimiter you specified in the request. If you don't specify a delimiter in\n your request, this element is absent from the response.

\n \n

\n Directory buckets - For directory buckets, / is the only supported delimiter.

\n " + } + }, + "NextUploadIdMarker": { + "target": "com.amazonaws.s3#NextUploadIdMarker", + "traits": { + "smithy.api#documentation": "

When a list is truncated, this element specifies the value that should be used for the\n upload-id-marker request parameter in a subsequent request.

\n \n

This functionality is not supported for directory buckets.

\n " + } + }, + "MaxUploads": { + "target": "com.amazonaws.s3#MaxUploads", + "traits": { + "smithy.api#documentation": "

Maximum number of multipart uploads that could have been included in the\n response.

" + } + }, + "IsTruncated": { + "target": "com.amazonaws.s3#IsTruncated", + "traits": { + "smithy.api#documentation": "

Indicates whether the returned list of multipart uploads is truncated. A value of true\n indicates that the list was truncated. The list can be truncated if the number of multipart\n uploads exceeds the limit allowed or specified by max uploads.

" + } + }, + "Uploads": { + "target": "com.amazonaws.s3#MultipartUploadList", + "traits": { + "smithy.api#documentation": "

Container for elements related to a particular multipart upload. A response can contain\n zero or more Upload elements.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Upload" + } + }, + "CommonPrefixes": { + "target": "com.amazonaws.s3#CommonPrefixList", + "traits": { + "smithy.api#documentation": "

If you specify a delimiter in the request, then the result returns each distinct key\n prefix containing the delimiter in a CommonPrefixes element. The distinct key\n prefixes are returned in the Prefix child element.

\n \n

\n Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.

\n ", + "smithy.api#xmlFlattened": {} + } + }, + "EncodingType": { + "target": "com.amazonaws.s3#EncodingType", + "traits": { + "smithy.api#documentation": "

Encoding type used by Amazon S3 to encode object keys in the response.

\n

If you specify the encoding-type request parameter, Amazon S3 includes this\n element in the response, and returns encoded key name values in the following response\n elements:

\n

\n Delimiter, KeyMarker, Prefix,\n NextKeyMarker, Key.

" + } + }, + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#xmlName": "ListMultipartUploadsResult" + } + }, + "com.amazonaws.s3#ListMultipartUploadsRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket to which the multipart upload was initiated.

\n

\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n \n

Access points and Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "Delimiter": { + "target": "com.amazonaws.s3#Delimiter", + "traits": { + "smithy.api#documentation": "

Character you use to group keys.

\n

All keys that contain the same string between the prefix, if specified, and the first\n occurrence of the delimiter after the prefix are grouped under a single result element,\n CommonPrefixes. If you don't specify the prefix parameter, then the\n substring starts at the beginning of the key. The keys that are grouped under\n CommonPrefixes result element are not returned elsewhere in the\n response.

\n \n

\n Directory buckets - For directory buckets, / is the only supported delimiter.

\n ", + "smithy.api#httpQuery": "delimiter" + } + }, + "EncodingType": { + "target": "com.amazonaws.s3#EncodingType", + "traits": { + "smithy.api#httpQuery": "encoding-type" + } + }, + "KeyMarker": { + "target": "com.amazonaws.s3#KeyMarker", + "traits": { + "smithy.api#documentation": "

Specifies the multipart upload after which listing should begin.

\n \n
    \n
  • \n

    \n General purpose buckets - For\n general purpose buckets, key-marker is an object key. Together with\n upload-id-marker, this parameter specifies the multipart upload\n after which listing should begin.

    \n

    If upload-id-marker is not specified, only the keys\n lexicographically greater than the specified key-marker will be\n included in the list.

    \n

    If upload-id-marker is specified, any multipart uploads for a key\n equal to the key-marker might also be included, provided those\n multipart uploads have upload IDs lexicographically greater than the specified\n upload-id-marker.

    \n
    • \n
  • \n

    \n Directory buckets - For\n directory buckets, key-marker is obfuscated and isn't a real object\n key. The upload-id-marker parameter isn't supported by\n directory buckets. To list the additional multipart uploads, you only need to set\n the value of key-marker to the NextKeyMarker value from\n the previous response.

    \n

    In the ListMultipartUploads response, the multipart uploads aren't\n sorted lexicographically based on the object keys.\n \n

    \n
    • \n
\n ", + "smithy.api#httpQuery": "key-marker" + } + }, + "MaxUploads": { + "target": "com.amazonaws.s3#MaxUploads", + "traits": { + "smithy.api#documentation": "

Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response\n body. 1,000 is the maximum number of uploads that can be returned in a response.

", + "smithy.api#httpQuery": "max-uploads" + } + }, + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "

Lists in-progress uploads only for those keys that begin with the specified prefix. You\n can use prefixes to separate a bucket into different grouping of keys. (You can think of\n using prefix to make groups in the same way that you'd use a folder in a file\n system.)

\n \n

\n Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.

\n ", + "smithy.api#httpQuery": "prefix", + "smithy.rules#contextParam": { + "name": "Prefix" + } + } + }, + "UploadIdMarker": { + "target": "com.amazonaws.s3#UploadIdMarker", + "traits": { + "smithy.api#documentation": "

Together with key-marker, specifies the multipart upload after which listing should\n begin. If key-marker is not specified, the upload-id-marker parameter is ignored.\n Otherwise, any multipart uploads for a key equal to the key-marker might be included in the\n list only if they have an upload ID lexicographically greater than the specified\n upload-id-marker.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpQuery": "upload-id-marker" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#ListObjectVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#ListObjectVersionsRequest" + }, + "output": { + "target": "com.amazonaws.s3#ListObjectVersionsOutput" + }, + "traits": { + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Returns metadata about all versions of the objects in a bucket. You can also use request\n parameters as selection criteria to return metadata about a subset of all the object\n versions.

\n \n

To use this operation, you must have permission to perform the\n s3:ListBucketVersions action. Be aware of the name difference.

\n \n \n

A 200 OK response can contain valid or invalid XML. Make sure to design\n your application to parse the contents of the response and handle it\n appropriately.

\n \n

To use this operation, you must have READ access to the bucket.

\n

The following operations are related to ListObjectVersions:

\n ", + "smithy.api#examples": [ + { + "title": "To list object versions", + "documentation": "The following example returns versions of an object with specific key name prefix.", + "input": { + "Bucket": "examplebucket", + "Prefix": "HappyFace.jpg" + }, + "output": { + "Versions": [ + { + "LastModified": "2016-12-15T01:19:41.000Z", + "VersionId": "null", + "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", + "StorageClass": "STANDARD", + "Key": "HappyFace.jpg", + "Owner": { + "DisplayName": "owner-display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + }, + "IsLatest": true, + "Size": 3191 + }, + { + "LastModified": "2016-12-13T00:58:26.000Z", + "VersionId": "PHtexPGjH2y.zBgT8LmB7wwLI2mpbz.k", + "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", + "StorageClass": "STANDARD", + "Key": "HappyFace.jpg", + "Owner": { + "DisplayName": "owner-display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + }, + "IsLatest": false, + "Size": 3191 + } + ] + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?versions", + "code": 200 + } + } + }, + "com.amazonaws.s3#ListObjectVersionsOutput": { + "type": "structure", + "members": { + "IsTruncated": { + "target": "com.amazonaws.s3#IsTruncated", + "traits": { + "smithy.api#documentation": "

A flag that indicates whether Amazon S3 returned all of the results that satisfied the search\n criteria. If your results were truncated, you can make a follow-up paginated request by\n using the NextKeyMarker and NextVersionIdMarker response\n parameters as a starting place in another request to return the rest of the results.

" + } + }, + "KeyMarker": { + "target": "com.amazonaws.s3#KeyMarker", + "traits": { + "smithy.api#documentation": "

Marks the last key returned in a truncated response.

" + } + }, + "VersionIdMarker": { + "target": "com.amazonaws.s3#VersionIdMarker", + "traits": { + "smithy.api#documentation": "

Marks the last version of the key returned in a truncated response.

" + } + }, + "NextKeyMarker": { + "target": "com.amazonaws.s3#NextKeyMarker", + "traits": { + "smithy.api#documentation": "

When the number of responses exceeds the value of MaxKeys,\n NextKeyMarker specifies the first key not returned that satisfies the\n search criteria. Use this value for the key-marker request parameter in a subsequent\n request.

" + } + }, + "NextVersionIdMarker": { + "target": "com.amazonaws.s3#NextVersionIdMarker", + "traits": { + "smithy.api#documentation": "

When the number of responses exceeds the value of MaxKeys,\n NextVersionIdMarker specifies the first object version not returned that\n satisfies the search criteria. Use this value for the version-id-marker\n request parameter in a subsequent request.

" + } + }, + "Versions": { + "target": "com.amazonaws.s3#ObjectVersionList", + "traits": { + "smithy.api#documentation": "

Container for version information.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Version" + } + }, + "DeleteMarkers": { + "target": "com.amazonaws.s3#DeleteMarkers", + "traits": { + "smithy.api#documentation": "

Container for an object that is a delete marker.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "DeleteMarker" + } + }, + "Name": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name.

" + } + }, + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "

Selects objects that start with the value supplied by this parameter.

" + } + }, + "Delimiter": { + "target": "com.amazonaws.s3#Delimiter", + "traits": { + "smithy.api#documentation": "

The delimiter grouping the included keys. A delimiter is a character that you specify to\n group keys. All keys that contain the same string between the prefix and the first\n occurrence of the delimiter are grouped under a single result element in\n CommonPrefixes. These groups are counted as one result against the\n max-keys limitation. These keys are not returned elsewhere in the\n response.

" + } + }, + "MaxKeys": { + "target": "com.amazonaws.s3#MaxKeys", + "traits": { + "smithy.api#documentation": "

Specifies the maximum number of objects to return.

" + } + }, + "CommonPrefixes": { + "target": "com.amazonaws.s3#CommonPrefixList", + "traits": { + "smithy.api#documentation": "

All of the keys rolled up into a common prefix count as a single return when calculating\n the number of returns.

", + "smithy.api#xmlFlattened": {} + } + }, + "EncodingType": { + "target": "com.amazonaws.s3#EncodingType", + "traits": { + "smithy.api#documentation": "

Encoding type used by Amazon S3 to encode object key names in the XML response.

\n

If you specify the encoding-type request parameter, Amazon S3 includes this\n element in the response, and returns encoded key name values in the following response\n elements:

\n

\n KeyMarker, NextKeyMarker, Prefix, Key, and Delimiter.

" + } + }, + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#xmlName": "ListVersionsResult" + } + }, + "com.amazonaws.s3#ListObjectVersionsRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name that contains the objects.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "Delimiter": { + "target": "com.amazonaws.s3#Delimiter", + "traits": { + "smithy.api#documentation": "

A delimiter is a character that you specify to group keys. All keys that contain the\n same string between the prefix and the first occurrence of the delimiter are\n grouped under a single result element in CommonPrefixes. These groups are\n counted as one result against the max-keys limitation. These keys are not\n returned elsewhere in the response.

", + "smithy.api#httpQuery": "delimiter" + } + }, + "EncodingType": { + "target": "com.amazonaws.s3#EncodingType", + "traits": { + "smithy.api#httpQuery": "encoding-type" + } + }, + "KeyMarker": { + "target": "com.amazonaws.s3#KeyMarker", + "traits": { + "smithy.api#documentation": "

Specifies the key to start with when listing objects in a bucket.

", + "smithy.api#httpQuery": "key-marker" + } + }, + "MaxKeys": { + "target": "com.amazonaws.s3#MaxKeys", + "traits": { + "smithy.api#documentation": "

Sets the maximum number of keys returned in the response. By default, the action returns\n up to 1,000 key names. The response might contain fewer keys but will never contain more.\n If additional keys satisfy the search criteria, but were not returned because\n max-keys was exceeded, the response contains\n true. To return the additional keys,\n see key-marker and version-id-marker.

", + "smithy.api#httpQuery": "max-keys" + } + }, + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "

Use this parameter to select only those keys that begin with the specified prefix. You\n can use prefixes to separate a bucket into different groupings of keys. (You can think of\n using prefix to make groups in the same way that you'd use a folder in a file\n system.) You can use prefix with delimiter to roll up numerous\n objects into a single result under CommonPrefixes.

", + "smithy.api#httpQuery": "prefix", + "smithy.rules#contextParam": { + "name": "Prefix" + } + } + }, + "VersionIdMarker": { + "target": "com.amazonaws.s3#VersionIdMarker", + "traits": { + "smithy.api#documentation": "

Specifies the object version you want to start listing from.

", + "smithy.api#httpQuery": "version-id-marker" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "OptionalObjectAttributes": { + "target": "com.amazonaws.s3#OptionalObjectAttributesList", + "traits": { + "smithy.api#documentation": "

Specifies the optional fields that you want returned in the response. Fields that you do\n not specify are not returned.

", + "smithy.api#httpHeader": "x-amz-optional-object-attributes" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#ListObjects": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#ListObjectsRequest" + }, + "output": { + "target": "com.amazonaws.s3#ListObjectsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.s3#NoSuchBucket" + } + ], + "traits": { + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Returns some or all (up to 1,000) of the objects in a bucket. You can use the request\n parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK\n response can contain valid or invalid XML. Be sure to design your application to parse the\n contents of the response and handle it appropriately.

\n \n

This action has been revised. We recommend that you use the newer version, ListObjectsV2, when developing applications. For backward compatibility,\n Amazon S3 continues to support ListObjects.

\n \n

The following operations are related to ListObjects:

\n ", + "smithy.api#examples": [ + { + "title": "To list objects in a bucket", + "documentation": "The following example list two objects in a bucket.", + "input": { + "Bucket": "examplebucket", + "MaxKeys": 2 + }, + "output": { + "NextMarker": "eyJNYXJrZXIiOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAyfQ==", + "Contents": [ + { + "LastModified": "2014-11-21T19:40:05.000Z", + "ETag": "\"70ee1738b6b21e2c8a43f3a5ab0eee71\"", + "StorageClass": "STANDARD", + "Key": "example1.jpg", + "Owner": { + "DisplayName": "myname", + "ID": "12345example25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + }, + "Size": 11 + }, + { + "LastModified": "2013-11-15T01:10:49.000Z", + "ETag": "\"9c8af9a76df052144598c115ef33e511\"", + "StorageClass": "STANDARD", + "Key": "example2.jpg", + "Owner": { + "DisplayName": "myname", + "ID": "12345example25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + }, + "Size": 713193 + } + ] + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}", + "code": 200 + } + } + }, + "com.amazonaws.s3#ListObjectsOutput": { + "type": "structure", + "members": { + "IsTruncated": { + "target": "com.amazonaws.s3#IsTruncated", + "traits": { + "smithy.api#documentation": "

A flag that indicates whether Amazon S3 returned all of the results that satisfied the search\n criteria.

" + } + }, + "Marker": { + "target": "com.amazonaws.s3#Marker", + "traits": { + "smithy.api#documentation": "

Indicates where in the bucket listing begins. Marker is included in the response if it\n was sent with the request.

" + } + }, + "NextMarker": { + "target": "com.amazonaws.s3#NextMarker", + "traits": { + "smithy.api#documentation": "

When the response is truncated (the IsTruncated element value in the\n response is true), you can use the key name in this field as the\n marker parameter in the subsequent request to get the next set of objects.\n Amazon S3 lists objects in alphabetical order.

\n \n

This element is returned only if you have the delimiter request\n parameter specified. If the response does not include the NextMarker\n element and it is truncated, you can use the value of the last Key element\n in the response as the marker parameter in the subsequent request to get\n the next set of object keys.

\n " + } + }, + "Contents": { + "target": "com.amazonaws.s3#ObjectList", + "traits": { + "smithy.api#documentation": "

Metadata about each object returned.

", + "smithy.api#xmlFlattened": {} + } + }, + "Name": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name.

" + } + }, + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "

Keys that begin with the indicated prefix.

" + } + }, + "Delimiter": { + "target": "com.amazonaws.s3#Delimiter", + "traits": { + "smithy.api#documentation": "

Causes keys that contain the same string between the prefix and the first occurrence of\n the delimiter to be rolled up into a single result element in the\n CommonPrefixes collection. These rolled-up keys are not returned elsewhere\n in the response. Each rolled-up result counts as only one return against the\n MaxKeys value.

" + } + }, + "MaxKeys": { + "target": "com.amazonaws.s3#MaxKeys", + "traits": { + "smithy.api#documentation": "

The maximum number of keys returned in the response body.

" + } + }, + "CommonPrefixes": { + "target": "com.amazonaws.s3#CommonPrefixList", + "traits": { + "smithy.api#documentation": "

All of the keys (up to 1,000) rolled up in a common prefix count as a single return when\n calculating the number of returns.

\n

A response can contain CommonPrefixes only if you specify a\n delimiter.

\n

\n CommonPrefixes contains all (if there are any) keys between\n Prefix and the next occurrence of the string specified by the\n delimiter.

\n

\n CommonPrefixes lists keys that act like subdirectories in the directory\n specified by Prefix.

\n

For example, if the prefix is notes/ and the delimiter is a slash\n (/), as in notes/summer/july, the common prefix is\n notes/summer/. All of the keys that roll up into a common prefix count as a\n single return when calculating the number of returns.

", + "smithy.api#xmlFlattened": {} + } + }, + "EncodingType": { + "target": "com.amazonaws.s3#EncodingType", + "traits": { + "smithy.api#documentation": "

Encoding type used by Amazon S3 to encode the object keys in the response.\n Responses are encoded only in UTF-8. An object key can contain any Unicode character.\n However, the XML 1.0 parser can't parse certain characters, such as characters with an\n ASCII value from 0 to 10. For characters that aren't supported in XML 1.0, you can add this\n parameter to request that Amazon S3 encode the keys in the response. For more information about\n characters to avoid in object key names, see Object key naming\n guidelines.

\n \n

When using the URL encoding type, non-ASCII characters that are used in an object's\n key name will be percent-encoded according to UTF-8 code values. For example, the object\n test_file(3).png will appear as\n test_file%283%29.png.

\n " + } + }, + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#xmlName": "ListBucketResult" + } + }, + "com.amazonaws.s3#ListObjectsRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket containing the objects.

\n

\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n \n

Access points and Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "Delimiter": { + "target": "com.amazonaws.s3#Delimiter", + "traits": { + "smithy.api#documentation": "

A delimiter is a character that you use to group keys.

", + "smithy.api#httpQuery": "delimiter" + } + }, + "EncodingType": { + "target": "com.amazonaws.s3#EncodingType", + "traits": { + "smithy.api#httpQuery": "encoding-type" + } + }, + "Marker": { + "target": "com.amazonaws.s3#Marker", + "traits": { + "smithy.api#documentation": "

Marker is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this\n specified key. Marker can be any key in the bucket.

", + "smithy.api#httpQuery": "marker" + } + }, + "MaxKeys": { + "target": "com.amazonaws.s3#MaxKeys", + "traits": { + "smithy.api#documentation": "

Sets the maximum number of keys returned in the response. By default, the action returns\n up to 1,000 key names. The response might contain fewer keys but will never contain more.\n

", + "smithy.api#httpQuery": "max-keys" + } + }, + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "

Limits the response to keys that begin with the specified prefix.

", + "smithy.api#httpQuery": "prefix", + "smithy.rules#contextParam": { + "name": "Prefix" + } + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#documentation": "

Confirms that the requester knows that she or he will be charged for the list objects\n request. Bucket owners need not specify this parameter in their requests.

", + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + }, + "OptionalObjectAttributes": { + "target": "com.amazonaws.s3#OptionalObjectAttributesList", + "traits": { + "smithy.api#documentation": "

Specifies the optional fields that you want returned in the response. Fields that you do\n not specify are not returned.

", + "smithy.api#httpHeader": "x-amz-optional-object-attributes" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#ListObjectsV2": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#ListObjectsV2Request" + }, + "output": { + "target": "com.amazonaws.s3#ListObjectsV2Output" + }, + "errors": [ + { + "target": "com.amazonaws.s3#NoSuchBucket" + } + ], + "traits": { + "smithy.api#documentation": "

Returns some or all (up to 1,000) of the objects in a bucket with each request. You can\n use the request parameters as selection criteria to return a subset of the objects in a\n bucket. A 200 OK response can contain valid or invalid XML. Make sure to\n design your application to parse the contents of the response and handle it appropriately.\n For more information about listing objects, see Listing object keys\n programmatically in the Amazon S3 User Guide. To get a list of\n your buckets, see ListBuckets.

\n \n
    \n
  • \n

    \n General purpose bucket - For general purpose buckets,\n ListObjectsV2 doesn't return prefixes that are related only to\n in-progress multipart uploads.

    \n
    • \n
  • \n

    \n Directory buckets - For\n directory buckets, ListObjectsV2 response includes the prefixes that\n are related only to in-progress multipart uploads.

    \n
    • \n
  • \n

    \n Directory buckets -\n For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket-name.s3express-zone-id.region-code.amazonaws.com/key-name\n . Path-style requests are not supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the\n Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the\n Amazon S3 User Guide.

    \n
    • \n
\n \n
\n
Permissions
\n
\n
    \n
  • \n

    \n General purpose bucket permissions - To\n use this operation, you must have READ access to the bucket. You must have\n permission to perform the s3:ListBucket action. The bucket\n owner has this permission by default and can grant this permission to\n others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access\n Permissions to Your Amazon S3 Resources in the\n Amazon S3 User Guide.

    \n
    • \n
  • \n

    \n Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the \n CreateSession\n API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. \nAmazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see \n CreateSession\n .

    \n
    • \n
\n
\n
Sorting order of returned objects
\n
\n
    \n
  • \n

    \n General purpose bucket - For\n general purpose buckets, ListObjectsV2 returns objects in\n lexicographical order based on their key names.

    \n
    • \n
  • \n

    \n Directory bucket - For\n directory buckets, ListObjectsV2 does not return objects in\n lexicographical order.

    \n
    • \n
\n
\n
HTTP Host header syntax
\n
\n

\n Directory buckets - The HTTP Host header syntax is \n Bucket-name.s3express-zone-id.region-code.amazonaws.com.

\n
\n
\n \n

This section describes the latest revision of this action. We recommend that you use\n this revised API operation for application development. For backward compatibility, Amazon S3\n continues to support the prior version of this API operation, ListObjects.

\n \n

The following operations are related to ListObjectsV2:

\n ", + "smithy.api#examples": [ + { + "title": "To get object list", + "documentation": "The following example retrieves object list. The request specifies max keys to limit response to include only 2 object keys. ", + "input": { + "Bucket": "DOC-EXAMPLE-BUCKET", + "MaxKeys": 2 + }, + "output": { + "Name": "DOC-EXAMPLE-BUCKET", + "MaxKeys": 2, + "Prefix": "", + "KeyCount": 2, + "NextContinuationToken": "1w41l63U0xa8q7smH50vCxyTQqdxo69O3EmK28Bi5PcROI4wI/EyIJg==", + "IsTruncated": true, + "Contents": [ + { + "LastModified": "2014-11-21T19:40:05.000Z", + "ETag": "\"70ee1738b6b21e2c8a43f3a5ab0eee71\"", + "StorageClass": "STANDARD", + "Key": "happyface.jpg", + "Size": 11 + }, + { + "LastModified": "2014-05-02T04:51:50.000Z", + "ETag": "\"becf17f89c30367a9a44495d62ed521a-1\"", + "StorageClass": "STANDARD", + "Key": "test.jpg", + "Size": 4192256 + } + ] + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?list-type=2", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "ContinuationToken", + "outputToken": "NextContinuationToken", + "pageSize": "MaxKeys" + } + } + }, + "com.amazonaws.s3#ListObjectsV2Output": { + "type": "structure", + "members": { + "IsTruncated": { + "target": "com.amazonaws.s3#IsTruncated", + "traits": { + "smithy.api#documentation": "

Set to false if all of the results were returned. Set to true\n if more keys are available to return. If the number of results exceeds that specified by\n MaxKeys, all of the results might not be returned.

" + } + }, + "Contents": { + "target": "com.amazonaws.s3#ObjectList", + "traits": { + "smithy.api#documentation": "

Metadata about each object returned.

", + "smithy.api#xmlFlattened": {} + } + }, + "Name": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name.

" + } + }, + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "

Keys that begin with the indicated prefix.

\n \n

\n Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.

\n " + } + }, + "Delimiter": { + "target": "com.amazonaws.s3#Delimiter", + "traits": { + "smithy.api#documentation": "

Causes keys that contain the same string between the prefix and the first\n occurrence of the delimiter to be rolled up into a single result element in the\n CommonPrefixes collection. These rolled-up keys are not returned elsewhere\n in the response. Each rolled-up result counts as only one return against the\n MaxKeys value.

\n \n

\n Directory buckets - For directory buckets, / is the only supported delimiter.

\n " + } + }, + "MaxKeys": { + "target": "com.amazonaws.s3#MaxKeys", + "traits": { + "smithy.api#documentation": "

Sets the maximum number of keys returned in the response. By default, the action returns\n up to 1,000 key names. The response might contain fewer keys but will never contain\n more.

" + } + }, + "CommonPrefixes": { + "target": "com.amazonaws.s3#CommonPrefixList", + "traits": { + "smithy.api#documentation": "

All of the keys (up to 1,000) that share the same prefix are grouped together. When\n counting the total numbers of returns by this API operation, this group of keys is\n considered as one item.

\n

A response can contain CommonPrefixes only if you specify a\n delimiter.

\n

\n CommonPrefixes contains all (if there are any) keys between\n Prefix and the next occurrence of the string specified by a\n delimiter.

\n

\n CommonPrefixes lists keys that act like subdirectories in the directory\n specified by Prefix.

\n

For example, if the prefix is notes/ and the delimiter is a slash\n (/) as in notes/summer/july, the common prefix is\n notes/summer/. All of the keys that roll up into a common prefix count as a\n single return when calculating the number of returns.

\n \n
    \n
  • \n

    \n Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.

    \n
    • \n
  • \n

    \n Directory buckets - When you query\n ListObjectsV2 with a delimiter during in-progress multipart\n uploads, the CommonPrefixes response parameter contains the prefixes\n that are associated with the in-progress multipart uploads. For more information\n about multipart uploads, see Multipart Upload Overview in\n the Amazon S3 User Guide.

    \n
    • \n
\n ", + "smithy.api#xmlFlattened": {} + } + }, + "EncodingType": { + "target": "com.amazonaws.s3#EncodingType", + "traits": { + "smithy.api#documentation": "

Encoding type used by Amazon S3 to encode object key names in the XML response.

\n

If you specify the encoding-type request parameter, Amazon S3 includes this\n element in the response, and returns encoded key name values in the following response\n elements:

\n

\n Delimiter, Prefix, Key, and StartAfter.

" + } + }, + "KeyCount": { + "target": "com.amazonaws.s3#KeyCount", + "traits": { + "smithy.api#documentation": "

\n KeyCount is the number of keys returned with this request.\n KeyCount will always be less than or equal to the MaxKeys\n field. For example, if you ask for 50 keys, your result will include 50 keys or\n fewer.

" + } + }, + "ContinuationToken": { + "target": "com.amazonaws.s3#Token", + "traits": { + "smithy.api#documentation": "

If ContinuationToken was sent with the request, it is included in the\n response. You can use the returned ContinuationToken for pagination of the\n list response. You can use this ContinuationToken for pagination of the list\n results.

" + } + }, + "NextContinuationToken": { + "target": "com.amazonaws.s3#NextToken", + "traits": { + "smithy.api#documentation": "

\n NextContinuationToken is sent when isTruncated is true, which\n means there are more keys in the bucket that can be listed. The next list requests to Amazon S3\n can be continued with this NextContinuationToken.\n NextContinuationToken is obfuscated and is not a real key

" + } + }, + "StartAfter": { + "target": "com.amazonaws.s3#StartAfter", + "traits": { + "smithy.api#documentation": "

If StartAfter was sent with the request, it is included in the response.

\n \n

This functionality is not supported for directory buckets.

\n " + } + }, + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#xmlName": "ListBucketResult" + } + }, + "com.amazonaws.s3#ListObjectsV2Request": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n \n

Access points and Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "Delimiter": { + "target": "com.amazonaws.s3#Delimiter", + "traits": { + "smithy.api#documentation": "

A delimiter is a character that you use to group keys.

\n \n
    \n
  • \n

    \n Directory buckets - For directory buckets, / is the only supported delimiter.

    \n
    • \n
  • \n

    \n Directory buckets - When you query\n ListObjectsV2 with a delimiter during in-progress multipart\n uploads, the CommonPrefixes response parameter contains the prefixes\n that are associated with the in-progress multipart uploads. For more information\n about multipart uploads, see Multipart Upload Overview in\n the Amazon S3 User Guide.

    \n
    • \n
\n ", + "smithy.api#httpQuery": "delimiter" + } + }, + "EncodingType": { + "target": "com.amazonaws.s3#EncodingType", + "traits": { + "smithy.api#documentation": "

Encoding type used by Amazon S3 to encode the object keys in the response.\n Responses are encoded only in UTF-8. An object key can contain any Unicode character.\n However, the XML 1.0 parser can't parse certain characters, such as characters with an\n ASCII value from 0 to 10. For characters that aren't supported in XML 1.0, you can add this\n parameter to request that Amazon S3 encode the keys in the response. For more information about\n characters to avoid in object key names, see Object key naming\n guidelines.

\n \n

When using the URL encoding type, non-ASCII characters that are used in an object's\n key name will be percent-encoded according to UTF-8 code values. For example, the object\n test_file(3).png will appear as\n test_file%283%29.png.

\n ", + "smithy.api#httpQuery": "encoding-type" + } + }, + "MaxKeys": { + "target": "com.amazonaws.s3#MaxKeys", + "traits": { + "smithy.api#documentation": "

Sets the maximum number of keys returned in the response. By default, the action returns\n up to 1,000 key names. The response might contain fewer keys but will never contain\n more.

", + "smithy.api#httpQuery": "max-keys" + } + }, + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "

Limits the response to keys that begin with the specified prefix.

\n \n

\n Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.

\n ", + "smithy.api#httpQuery": "prefix", + "smithy.rules#contextParam": { + "name": "Prefix" + } + } + }, + "ContinuationToken": { + "target": "com.amazonaws.s3#Token", + "traits": { + "smithy.api#documentation": "

\n ContinuationToken indicates to Amazon S3 that the list is being continued on\n this bucket with a token. ContinuationToken is obfuscated and is not a real\n key. You can use this ContinuationToken for pagination of the list results.\n

", + "smithy.api#httpQuery": "continuation-token" + } + }, + "FetchOwner": { + "target": "com.amazonaws.s3#FetchOwner", + "traits": { + "smithy.api#documentation": "

The owner field is not present in ListObjectsV2 by default. If you want to\n return the owner field with each key in the result, then set the FetchOwner\n field to true.

\n \n

\n Directory buckets - For directory buckets,\n the bucket owner is returned as the object owner for all objects.

\n ", + "smithy.api#httpQuery": "fetch-owner" + } + }, + "StartAfter": { + "target": "com.amazonaws.s3#StartAfter", + "traits": { + "smithy.api#documentation": "

StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this\n specified key. StartAfter can be any key in the bucket.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpQuery": "start-after" + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#documentation": "

Confirms that the requester knows that she or he will be charged for the list objects\n request in V2 style. Bucket owners need not specify this parameter in their\n requests.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + }, + "OptionalObjectAttributes": { + "target": "com.amazonaws.s3#OptionalObjectAttributesList", + "traits": { + "smithy.api#documentation": "

Specifies the optional fields that you want returned in the response. Fields that you do\n not specify are not returned.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-optional-object-attributes" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#ListParts": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#ListPartsRequest" + }, + "output": { + "target": "com.amazonaws.s3#ListPartsOutput" + }, + "traits": { + "smithy.api#documentation": "

Lists the parts that have been uploaded for a specific multipart upload.

\n

To use this operation, you must provide the upload ID in the request. You\n obtain this uploadID by sending the initiate multipart upload request through CreateMultipartUpload.

\n

The ListParts request returns a maximum of 1,000 uploaded parts. The limit\n of 1,000 parts is also the default value. You can restrict the number of parts in a\n response by specifying the max-parts request parameter. If your multipart\n upload consists of more than 1,000 parts, the response returns an IsTruncated\n field with the value of true, and a NextPartNumberMarker element.\n To list remaining uploaded parts, in subsequent ListParts requests, include\n the part-number-marker query string parameter and set its value to the\n NextPartNumberMarker field value from the previous response.

\n

For more information on multipart uploads, see Uploading Objects Using Multipart\n Upload in the Amazon S3 User Guide.

\n \n

\n Directory buckets -\n For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket-name.s3express-zone-id.region-code.amazonaws.com/key-name\n . Path-style requests are not supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the\n Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the\n Amazon S3 User Guide.

\n \n
\n
Permissions
\n
\n
    \n
  • \n

    \n General purpose bucket permissions - For\n information about permissions required to use the multipart upload API, see\n Multipart Upload and\n Permissions in the Amazon S3 User Guide.

    \n

    If the upload was created using server-side encryption with Key Management Service\n (KMS) keys (SSE-KMS) or dual-layer server-side encryption with\n Amazon Web Services KMS keys (DSSE-KMS), you must have permission to the\n kms:Decrypt action for the ListParts request to\n succeed.

    \n
    • \n
  • \n

    \n Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the \n CreateSession\n API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. \nAmazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see \n CreateSession\n .

    \n
    • \n
\n
\n
HTTP Host header syntax
\n
\n

\n Directory buckets - The HTTP Host header syntax is \n Bucket-name.s3express-zone-id.region-code.amazonaws.com.

\n
\n
\n

The following operations are related to ListParts:

\n ", + "smithy.api#examples": [ + { + "title": "To list parts of a multipart upload.", + "documentation": "The following example lists parts uploaded for a specific multipart upload.", + "input": { + "Bucket": "examplebucket", + "Key": "bigobject", + "UploadId": "example7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--" + }, + "output": { + "Owner": { + "DisplayName": "owner-display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + }, + "Initiator": { + "DisplayName": "owner-display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + }, + "Parts": [ + { + "LastModified": "2016-12-16T00:11:42.000Z", + "PartNumber": 1, + "ETag": "\"d8c2eafd90c266e19ab9dcacc479f8af\"", + "Size": 26246026 + }, + { + "LastModified": "2016-12-16T00:15:01.000Z", + "PartNumber": 2, + "ETag": "\"d8c2eafd90c266e19ab9dcacc479f8af\"", + "Size": 26246026 + } + ], + "StorageClass": "STANDARD" + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}/{Key+}?x-id=ListParts", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "PartNumberMarker", + "outputToken": "NextPartNumberMarker", + "items": "Parts", + "pageSize": "MaxParts" + } + } + }, + "com.amazonaws.s3#ListPartsOutput": { + "type": "structure", + "members": { + "AbortDate": { + "target": "com.amazonaws.s3#AbortDate", + "traits": { + "smithy.api#documentation": "

If the bucket has a lifecycle rule configured with an action to abort incomplete\n multipart uploads and the prefix in the lifecycle rule matches the object name in the\n request, then the response includes this header indicating when the initiated multipart\n upload will become eligible for abort operation. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle\n Configuration.

\n

The response will also include the x-amz-abort-rule-id header that will\n provide the ID of the lifecycle configuration rule that defines this action.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-abort-date" + } + }, + "AbortRuleId": { + "target": "com.amazonaws.s3#AbortRuleId", + "traits": { + "smithy.api#documentation": "

This header is returned along with the x-amz-abort-date header. It\n identifies applicable lifecycle configuration rule that defines the action to abort\n incomplete multipart uploads.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-abort-rule-id" + } + }, + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket to which the multipart upload was initiated. Does not return the\n access point ARN or access point alias if used.

" + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

Object key for which the multipart upload was initiated.

" + } + }, + "UploadId": { + "target": "com.amazonaws.s3#MultipartUploadId", + "traits": { + "smithy.api#documentation": "

Upload ID identifying the multipart upload whose parts are being listed.

" + } + }, + "PartNumberMarker": { + "target": "com.amazonaws.s3#PartNumberMarker", + "traits": { + "smithy.api#documentation": "

Specifies the part after which listing should begin. Only parts with higher part numbers\n will be listed.

" + } + }, + "NextPartNumberMarker": { + "target": "com.amazonaws.s3#NextPartNumberMarker", + "traits": { + "smithy.api#documentation": "

When a list is truncated, this element specifies the last part in the list, as well as\n the value to use for the part-number-marker request parameter in a subsequent\n request.

" + } + }, + "MaxParts": { + "target": "com.amazonaws.s3#MaxParts", + "traits": { + "smithy.api#documentation": "

Maximum number of parts that were allowed in the response.

" + } + }, + "IsTruncated": { + "target": "com.amazonaws.s3#IsTruncated", + "traits": { + "smithy.api#documentation": "

Indicates whether the returned list of parts is truncated. A true value indicates that\n the list was truncated. A list can be truncated if the number of parts exceeds the limit\n returned in the MaxParts element.

" + } + }, + "Parts": { + "target": "com.amazonaws.s3#Parts", + "traits": { + "smithy.api#documentation": "

Container for elements related to a particular part. A response can contain zero or more\n Part elements.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Part" + } + }, + "Initiator": { + "target": "com.amazonaws.s3#Initiator", + "traits": { + "smithy.api#documentation": "

Container element that identifies who initiated the multipart upload. If the initiator\n is an Amazon Web Services account, this element provides the same information as the Owner\n element. If the initiator is an IAM User, this element provides the user ARN and display\n name.

" + } + }, + "Owner": { + "target": "com.amazonaws.s3#Owner", + "traits": { + "smithy.api#documentation": "

Container element that identifies the object owner, after the object is created. If\n multipart upload is initiated by an IAM user, this element provides the parent account ID\n and display name.

\n \n

\n Directory buckets - The bucket owner is\n returned as the object owner for all the parts.

\n " + } + }, + "StorageClass": { + "target": "com.amazonaws.s3#StorageClass", + "traits": { + "smithy.api#documentation": "

The class of storage used to store the uploaded object.

\n \n

\n Directory buckets -\n Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

\n " + } + }, + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" + } + }, + "ChecksumAlgorithm": { + "target": "com.amazonaws.s3#ChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "

The algorithm that was used to create a checksum of the object.

" + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#xmlName": "ListPartsResult" + } + }, + "com.amazonaws.s3#ListPartsRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket to which the parts are being uploaded.

\n

\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n \n

Access points and Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

Object key for which the multipart upload was initiated.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Key" + } + } + }, + "MaxParts": { + "target": "com.amazonaws.s3#MaxParts", + "traits": { + "smithy.api#documentation": "

Sets the maximum number of parts to return.

", + "smithy.api#httpQuery": "max-parts" + } + }, + "PartNumberMarker": { + "target": "com.amazonaws.s3#PartNumberMarker", + "traits": { + "smithy.api#documentation": "

Specifies the part after which listing should begin. Only parts with higher part numbers\n will be listed.

", + "smithy.api#httpQuery": "part-number-marker" + } + }, + "UploadId": { + "target": "com.amazonaws.s3#MultipartUploadId", + "traits": { + "smithy.api#documentation": "

Upload ID identifying the multipart upload whose parts are being listed.

", + "smithy.api#httpQuery": "uploadId", + "smithy.api#required": {} + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + }, + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "traits": { + "smithy.api#documentation": "

The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is needed only when the object was created \n using a checksum algorithm. For more information,\n see Protecting data using SSE-C keys in the\n Amazon S3 User Guide.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + } + }, + "SSECustomerKey": { + "target": "com.amazonaws.s3#SSECustomerKey", + "traits": { + "smithy.api#documentation": "

The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. \n For more information, see\n Protecting data using SSE-C keys in the\n Amazon S3 User Guide.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key" + } + }, + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "traits": { + "smithy.api#documentation": "

The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum \n algorithm. For more information,\n see Protecting data using SSE-C keys in the\n Amazon S3 User Guide.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#Location": { + "type": "string" + }, + "com.amazonaws.s3#LocationInfo": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.s3#LocationType", + "traits": { + "smithy.api#documentation": "

The type of location where the bucket will be created.

" + } + }, + "Name": { + "target": "com.amazonaws.s3#LocationNameAsString", + "traits": { + "smithy.api#documentation": "

The name of the location where the bucket will be created.

\n

For directory buckets, the name of the location is the Zone ID of the Availability Zone (AZ) or Local Zone (LZ) where the bucket will be created. An example AZ ID value is usw2-az1.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the location where the bucket will be created.

\n

For directory buckets, the location type is Availability Zone or Local Zone. For more information about directory buckets, see \n Working with directory buckets in the Amazon S3 User Guide.

\n \n

This functionality is only supported by directory buckets.

\n " + } + }, + "com.amazonaws.s3#LocationNameAsString": { + "type": "string" + }, + "com.amazonaws.s3#LocationPrefix": { + "type": "string" + }, + "com.amazonaws.s3#LocationType": { + "type": "enum", + "members": { + "AvailabilityZone": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AvailabilityZone" + } + }, + "LocalZone": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LocalZone" + } + } + } + }, + "com.amazonaws.s3#LoggingEnabled": { + "type": "structure", + "members": { + "TargetBucket": { + "target": "com.amazonaws.s3#TargetBucket", + "traits": { + "smithy.api#documentation": "

Specifies the bucket where you want Amazon S3 to store server access logs. You can have your\n logs delivered to any bucket that you own, including the same bucket that is being logged.\n You can also configure multiple buckets to deliver their logs to the same target bucket. In\n this case, you should choose a different TargetPrefix for each source bucket\n so that the delivered log files can be distinguished by key.

", + "smithy.api#required": {} + } + }, + "TargetGrants": { + "target": "com.amazonaws.s3#TargetGrants", + "traits": { + "smithy.api#documentation": "

Container for granting information.

\n

Buckets that use the bucket owner enforced setting for Object Ownership don't support\n target grants. For more information, see Permissions for server access log delivery in the\n Amazon S3 User Guide.

" + } + }, + "TargetPrefix": { + "target": "com.amazonaws.s3#TargetPrefix", + "traits": { + "smithy.api#documentation": "

A prefix for all log object keys. If you store log files from multiple Amazon S3 buckets in a\n single bucket, you can use a prefix to distinguish which log files came from which\n bucket.

", + "smithy.api#required": {} + } + }, + "TargetObjectKeyFormat": { + "target": "com.amazonaws.s3#TargetObjectKeyFormat", + "traits": { + "smithy.api#documentation": "

Amazon S3 key format for log objects.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys\n for a bucket. For more information, see PUT Bucket logging in the\n Amazon S3 API Reference.

" + } + }, + "com.amazonaws.s3#MFA": { + "type": "string" + }, + "com.amazonaws.s3#MFADelete": { + "type": "enum", + "members": { + "Enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enabled" + } + }, + "Disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disabled" + } + } + } + }, + "com.amazonaws.s3#MFADeleteStatus": { + "type": "enum", + "members": { + "Enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enabled" + } + }, + "Disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disabled" + } + } + } + }, + "com.amazonaws.s3#Marker": { + "type": "string" + }, + "com.amazonaws.s3#MaxAgeSeconds": { + "type": "integer" + }, + "com.amazonaws.s3#MaxBuckets": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 10000 + } + } + }, + "com.amazonaws.s3#MaxDirectoryBuckets": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 1000 + } + } + }, + "com.amazonaws.s3#MaxKeys": { + "type": "integer" + }, + "com.amazonaws.s3#MaxParts": { + "type": "integer" + }, + "com.amazonaws.s3#MaxUploads": { + "type": "integer" + }, + "com.amazonaws.s3#Message": { + "type": "string" + }, + "com.amazonaws.s3#Metadata": { + "type": "map", + "key": { + "target": "com.amazonaws.s3#MetadataKey" + }, + "value": { + "target": "com.amazonaws.s3#MetadataValue" + } + }, + "com.amazonaws.s3#MetadataDirective": { + "type": "enum", + "members": { + "COPY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COPY" + } + }, + "REPLACE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REPLACE" + } + } + } + }, + "com.amazonaws.s3#MetadataEntry": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.s3#MetadataKey", + "traits": { + "smithy.api#documentation": "

Name of the object.

" + } + }, + "Value": { + "target": "com.amazonaws.s3#MetadataValue", + "traits": { + "smithy.api#documentation": "

Value of the object.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A metadata key-value pair to store with an object.

" + } + }, + "com.amazonaws.s3#MetadataKey": { + "type": "string" + }, + "com.amazonaws.s3#MetadataTableConfiguration": { + "type": "structure", + "members": { + "S3TablesDestination": { + "target": "com.amazonaws.s3#S3TablesDestination", + "traits": { + "smithy.api#documentation": "

\n The destination information for the metadata table configuration. The destination table bucket\n must be in the same Region and Amazon Web Services account as the general purpose bucket. The specified metadata\n table name must be unique within the aws_s3_metadata namespace in the destination \n table bucket.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The metadata table configuration for a general purpose bucket.\n

" + } + }, + "com.amazonaws.s3#MetadataTableConfigurationResult": { + "type": "structure", + "members": { + "S3TablesDestinationResult": { + "target": "com.amazonaws.s3#S3TablesDestinationResult", + "traits": { + "smithy.api#documentation": "

\n The destination information for the metadata table configuration. The destination table bucket\n must be in the same Region and Amazon Web Services account as the general purpose bucket. The specified metadata\n table name must be unique within the aws_s3_metadata namespace in the destination \n table bucket.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The metadata table configuration for a general purpose bucket. The destination table bucket\n must be in the same Region and Amazon Web Services account as the general purpose bucket. The specified metadata\n table name must be unique within the aws_s3_metadata namespace in the destination \n table bucket. \n

" + } + }, + "com.amazonaws.s3#MetadataTableStatus": { + "type": "string" + }, + "com.amazonaws.s3#MetadataValue": { + "type": "string" + }, + "com.amazonaws.s3#Metrics": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.s3#MetricsStatus", + "traits": { + "smithy.api#documentation": "

Specifies whether the replication metrics are enabled.

", + "smithy.api#required": {} + } + }, + "EventThreshold": { + "target": "com.amazonaws.s3#ReplicationTimeValue", + "traits": { + "smithy.api#documentation": "

A container specifying the time threshold for emitting the\n s3:Replication:OperationMissedThreshold event.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A container specifying replication metrics-related settings enabling replication\n metrics and events.

" + } + }, + "com.amazonaws.s3#MetricsAndOperator": { + "type": "structure", + "members": { + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "

The prefix used when evaluating an AND predicate.

" + } + }, + "Tags": { + "target": "com.amazonaws.s3#TagSet", + "traits": { + "smithy.api#documentation": "

The list of tags used when evaluating an AND predicate.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Tag" + } + }, + "AccessPointArn": { + "target": "com.amazonaws.s3#AccessPointArn", + "traits": { + "smithy.api#documentation": "

The access point ARN used when evaluating an AND predicate.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter.\n The operator must have at least two predicates, and an object must match all of the\n predicates in order for the filter to apply.

" + } + }, + "com.amazonaws.s3#MetricsConfiguration": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.s3#MetricsId", + "traits": { + "smithy.api#documentation": "

The ID used to identify the metrics configuration. The ID has a 64 character limit and\n can only contain letters, numbers, periods, dashes, and underscores.

", + "smithy.api#required": {} + } + }, + "Filter": { + "target": "com.amazonaws.s3#MetricsFilter", + "traits": { + "smithy.api#documentation": "

Specifies a metrics configuration filter. The metrics configuration will only include\n objects that meet the filter's criteria. A filter must be a prefix, an object tag, an\n access point ARN, or a conjunction (MetricsAndOperator).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies a metrics configuration for the CloudWatch request metrics (specified by the\n metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics\n configuration, note that this is a full replacement of the existing metrics configuration.\n If you don't include the elements you want to keep, they are erased. For more information,\n see PutBucketMetricsConfiguration.

" + } + }, + "com.amazonaws.s3#MetricsConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#MetricsConfiguration" + } + }, + "com.amazonaws.s3#MetricsFilter": { + "type": "union", + "members": { + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "

The prefix used when evaluating a metrics filter.

" + } + }, + "Tag": { + "target": "com.amazonaws.s3#Tag", + "traits": { + "smithy.api#documentation": "

The tag used when evaluating a metrics filter.

" + } + }, + "AccessPointArn": { + "target": "com.amazonaws.s3#AccessPointArn", + "traits": { + "smithy.api#documentation": "

The access point ARN used when evaluating a metrics filter.

" + } + }, + "And": { + "target": "com.amazonaws.s3#MetricsAndOperator", + "traits": { + "smithy.api#documentation": "

A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter.\n The operator must have at least two predicates, and an object must match all of the\n predicates in order for the filter to apply.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies a metrics configuration filter. The metrics configuration only includes\n objects that meet the filter's criteria. A filter must be a prefix, an object tag, an\n access point ARN, or a conjunction (MetricsAndOperator). For more information, see PutBucketMetricsConfiguration.

" + } + }, + "com.amazonaws.s3#MetricsId": { + "type": "string" + }, + "com.amazonaws.s3#MetricsStatus": { + "type": "enum", + "members": { + "Enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enabled" + } + }, + "Disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disabled" + } + } + } + }, + "com.amazonaws.s3#Minutes": { + "type": "integer" + }, + "com.amazonaws.s3#MissingMeta": { + "type": "integer" + }, + "com.amazonaws.s3#MultipartUpload": { + "type": "structure", + "members": { + "UploadId": { + "target": "com.amazonaws.s3#MultipartUploadId", + "traits": { + "smithy.api#documentation": "

Upload ID that identifies the multipart upload.

" + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

Key of the object for which the multipart upload was initiated.

" + } + }, + "Initiated": { + "target": "com.amazonaws.s3#Initiated", + "traits": { + "smithy.api#documentation": "

Date and time at which the multipart upload was initiated.

" + } + }, + "StorageClass": { + "target": "com.amazonaws.s3#StorageClass", + "traits": { + "smithy.api#documentation": "

The class of storage used to store the object.

\n \n

\n Directory buckets -\n Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

\n " + } + }, + "Owner": { + "target": "com.amazonaws.s3#Owner", + "traits": { + "smithy.api#documentation": "

Specifies the owner of the object that is part of the multipart upload.

\n \n

\n Directory buckets - The bucket owner is\n returned as the object owner for all the objects.

\n " + } + }, + "Initiator": { + "target": "com.amazonaws.s3#Initiator", + "traits": { + "smithy.api#documentation": "

Identifies who initiated the multipart upload.

" + } + }, + "ChecksumAlgorithm": { + "target": "com.amazonaws.s3#ChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "

The algorithm that was used to create a checksum of the object.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Container for the MultipartUpload for the Amazon S3 object.

" + } + }, + "com.amazonaws.s3#MultipartUploadId": { + "type": "string" + }, + "com.amazonaws.s3#MultipartUploadList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#MultipartUpload" + } + }, + "com.amazonaws.s3#NextKeyMarker": { + "type": "string" + }, + "com.amazonaws.s3#NextMarker": { + "type": "string" + }, + "com.amazonaws.s3#NextPartNumberMarker": { + "type": "string" + }, + "com.amazonaws.s3#NextToken": { + "type": "string" + }, + "com.amazonaws.s3#NextUploadIdMarker": { + "type": "string" + }, + "com.amazonaws.s3#NextVersionIdMarker": { + "type": "string" + }, + "com.amazonaws.s3#NoSuchBucket": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

The specified bucket does not exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.s3#NoSuchKey": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

The specified key does not exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.s3#NoSuchUpload": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

The specified multipart upload does not exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.s3#NoncurrentVersionExpiration": { + "type": "structure", + "members": { + "NoncurrentDays": { + "target": "com.amazonaws.s3#Days", + "traits": { + "smithy.api#documentation": "

Specifies the number of days an object is noncurrent before Amazon S3 can perform the\n associated action. The value must be a non-zero positive integer. For information about the\n noncurrent days calculations, see How\n Amazon S3 Calculates When an Object Became Noncurrent in the\n Amazon S3 User Guide.

\n \n

This parameter applies to general purpose buckets only. It is not supported for\n directory bucket lifecycle configurations.

\n " + } + }, + "NewerNoncurrentVersions": { + "target": "com.amazonaws.s3#VersionCount", + "traits": { + "smithy.api#documentation": "

Specifies how many noncurrent versions Amazon S3 will retain. You can specify up to 100\n noncurrent versions to retain. Amazon S3 will permanently delete any additional noncurrent\n versions beyond the specified number to retain. For more information about noncurrent\n versions, see Lifecycle configuration\n elements in the Amazon S3 User Guide.

\n \n

This parameter applies to general purpose buckets only. It is not supported for\n directory bucket lifecycle configurations.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently\n deletes the noncurrent object versions. You set this lifecycle configuration action on a\n bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent\n object versions at a specific period in the object's lifetime.

\n \n

This parameter applies to general purpose buckets only. It is not supported for\n directory bucket lifecycle configurations.

\n " + } + }, + "com.amazonaws.s3#NoncurrentVersionTransition": { + "type": "structure", + "members": { + "NoncurrentDays": { + "target": "com.amazonaws.s3#Days", + "traits": { + "smithy.api#documentation": "

Specifies the number of days an object is noncurrent before Amazon S3 can perform the\n associated action. For information about the noncurrent days calculations, see How\n Amazon S3 Calculates How Long an Object Has Been Noncurrent in the\n Amazon S3 User Guide.

" + } + }, + "StorageClass": { + "target": "com.amazonaws.s3#TransitionStorageClass", + "traits": { + "smithy.api#documentation": "

The class of storage used to store the object.

" + } + }, + "NewerNoncurrentVersions": { + "target": "com.amazonaws.s3#VersionCount", + "traits": { + "smithy.api#documentation": "

Specifies how many noncurrent versions Amazon S3 will retain in the same storage class before\n transitioning objects. You can specify up to 100 noncurrent versions to retain. Amazon S3 will\n transition any additional noncurrent versions beyond the specified number to retain. For\n more information about noncurrent versions, see Lifecycle configuration\n elements in the Amazon S3 User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Container for the transition rule that describes when noncurrent objects transition to\n the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING,\n GLACIER_IR, GLACIER, or DEEP_ARCHIVE storage\n class. If your bucket is versioning-enabled (or versioning is suspended), you can set this\n action to request that Amazon S3 transition noncurrent object versions to the\n STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING,\n GLACIER_IR, GLACIER, or DEEP_ARCHIVE storage\n class at a specific period in the object's lifetime.

" + } + }, + "com.amazonaws.s3#NoncurrentVersionTransitionList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#NoncurrentVersionTransition" + } + }, + "com.amazonaws.s3#NotFound": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

The specified content does not exist.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.s3#NotificationConfiguration": { + "type": "structure", + "members": { + "TopicConfigurations": { + "target": "com.amazonaws.s3#TopicConfigurationList", + "traits": { + "smithy.api#documentation": "

The topic to which notifications are sent and the events for which notifications are\n generated.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "TopicConfiguration" + } + }, + "QueueConfigurations": { + "target": "com.amazonaws.s3#QueueConfigurationList", + "traits": { + "smithy.api#documentation": "

The Amazon Simple Queue Service queues to publish messages to and the events for which\n to publish messages.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "QueueConfiguration" + } + }, + "LambdaFunctionConfigurations": { + "target": "com.amazonaws.s3#LambdaFunctionConfigurationList", + "traits": { + "smithy.api#documentation": "

Describes the Lambda functions to invoke and the events for which to invoke\n them.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "CloudFunctionConfiguration" + } + }, + "EventBridgeConfiguration": { + "target": "com.amazonaws.s3#EventBridgeConfiguration", + "traits": { + "smithy.api#documentation": "

Enables delivery of events to Amazon EventBridge.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A container for specifying the notification configuration of the bucket. If this element\n is empty, notifications are turned off for the bucket.

" + } + }, + "com.amazonaws.s3#NotificationConfigurationFilter": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.s3#S3KeyFilter", + "traits": { + "smithy.api#xmlName": "S3Key" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies object key name filtering rules. For information about key name filtering, see\n Configuring event\n notifications using object key name filtering in the\n Amazon S3 User Guide.

" + } + }, + "com.amazonaws.s3#NotificationId": { + "type": "string", + "traits": { + "smithy.api#documentation": "

An optional unique identifier for configurations in a notification configuration. If you\n don't provide one, Amazon S3 will assign an ID.

" + } + }, + "com.amazonaws.s3#Object": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

The name that you assign to an object. You use the object key to retrieve the\n object.

" + } + }, + "LastModified": { + "target": "com.amazonaws.s3#LastModified", + "traits": { + "smithy.api#documentation": "

Creation date of the object.

" + } + }, + "ETag": { + "target": "com.amazonaws.s3#ETag", + "traits": { + "smithy.api#documentation": "

The entity tag is a hash of the object. The ETag reflects changes only to the contents\n of an object, not its metadata. The ETag may or may not be an MD5 digest of the object\n data. Whether or not it is depends on how the object was created and how it is encrypted as\n described below:

\n
    \n
  • \n

    Objects created by the PUT Object, POST Object, or Copy operation, or through the\n Amazon Web Services Management Console, and are encrypted by SSE-S3 or plaintext, have ETags that\n are an MD5 digest of their object data.

    \n
    • \n
  • \n

    Objects created by the PUT Object, POST Object, or Copy operation, or through the\n Amazon Web Services Management Console, and are encrypted by SSE-C or SSE-KMS, have ETags that are\n not an MD5 digest of their object data.

    \n
    • \n
  • \n

    If an object is created by either the Multipart Upload or Part Copy operation, the\n ETag is not an MD5 digest, regardless of the method of encryption. If an object is\n larger than 16 MB, the Amazon Web Services Management Console will upload or copy that object as a\n Multipart Upload, and therefore the ETag will not be an MD5 digest.

    \n
    • \n
\n \n

\n Directory buckets - MD5 is not supported by directory buckets.

\n " + } + }, + "ChecksumAlgorithm": { + "target": "com.amazonaws.s3#ChecksumAlgorithmList", + "traits": { + "smithy.api#documentation": "

The algorithm that was used to create a checksum of the object.

", + "smithy.api#xmlFlattened": {} + } + }, + "Size": { + "target": "com.amazonaws.s3#Size", + "traits": { + "smithy.api#documentation": "

Size in bytes of the object

" + } + }, + "StorageClass": { + "target": "com.amazonaws.s3#ObjectStorageClass", + "traits": { + "smithy.api#documentation": "

The class of storage used to store the object.

\n \n

\n Directory buckets -\n Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

\n " + } + }, + "Owner": { + "target": "com.amazonaws.s3#Owner", + "traits": { + "smithy.api#documentation": "

The owner of the object

\n \n

\n Directory buckets - The bucket owner is\n returned as the object owner.

\n " + } + }, + "RestoreStatus": { + "target": "com.amazonaws.s3#RestoreStatus", + "traits": { + "smithy.api#documentation": "

Specifies the restoration status of an object. Objects in certain storage classes must\n be restored before they can be retrieved. For more information about these storage classes\n and how to work with archived objects, see Working with archived\n objects in the Amazon S3 User Guide.

\n \n

This functionality is not supported for directory buckets.\n Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

An object consists of data and its descriptive metadata.

" + } + }, + "com.amazonaws.s3#ObjectAlreadyInActiveTierError": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

This action is not allowed against this storage tier.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.s3#ObjectAttributes": { + "type": "enum", + "members": { + "ETAG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ETag" + } + }, + "CHECKSUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Checksum" + } + }, + "OBJECT_PARTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ObjectParts" + } + }, + "STORAGE_CLASS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StorageClass" + } + }, + "OBJECT_SIZE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ObjectSize" + } + } + } + }, + "com.amazonaws.s3#ObjectAttributesList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#ObjectAttributes" + } + }, + "com.amazonaws.s3#ObjectCannedACL": { + "type": "enum", + "members": { + "private": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "private" + } + }, + "public_read": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "public-read" + } + }, + "public_read_write": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "public-read-write" + } + }, + "authenticated_read": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "authenticated-read" + } + }, + "aws_exec_read": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "aws-exec-read" + } + }, + "bucket_owner_read": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "bucket-owner-read" + } + }, + "bucket_owner_full_control": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "bucket-owner-full-control" + } + } + } + }, + "com.amazonaws.s3#ObjectIdentifier": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

Key name of the object.

\n \n

Replacement must be made for object keys containing special characters (such as carriage returns) when using \n XML requests. For more information, see \n XML related object key constraints.

\n ", + "smithy.api#required": {} + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

Version ID for the specific version of the object to delete.

\n \n

This functionality is not supported for directory buckets.

\n " + } + }, + "ETag": { + "target": "com.amazonaws.s3#ETag", + "traits": { + "smithy.api#documentation": "

An entity tag (ETag) is an identifier assigned by a web server to a specific version of a resource found at a URL.\n This header field makes the request method conditional on ETags.

\n \n

Entity tags (ETags) for S3 Express One Zone are random alphanumeric strings unique to the object.

\n " + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.s3#LastModifiedTime", + "traits": { + "smithy.api#documentation": "

If present, the objects are deleted only if its modification times matches the provided Timestamp. \n

\n \n

This functionality is only supported for directory buckets.

\n " + } + }, + "Size": { + "target": "com.amazonaws.s3#Size", + "traits": { + "smithy.api#documentation": "

If present, the objects are deleted only if its size matches the provided size in bytes.

\n \n

This functionality is only supported for directory buckets.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Object Identifier is unique value to identify objects.

" + } + }, + "com.amazonaws.s3#ObjectIdentifierList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#ObjectIdentifier" + } + }, + "com.amazonaws.s3#ObjectKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.s3#ObjectList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#Object" + } + }, + "com.amazonaws.s3#ObjectLockConfiguration": { + "type": "structure", + "members": { + "ObjectLockEnabled": { + "target": "com.amazonaws.s3#ObjectLockEnabled", + "traits": { + "smithy.api#documentation": "

Indicates whether this bucket has an Object Lock configuration enabled. Enable\n ObjectLockEnabled when you apply ObjectLockConfiguration to a\n bucket.

" + } + }, + "Rule": { + "target": "com.amazonaws.s3#ObjectLockRule", + "traits": { + "smithy.api#documentation": "

Specifies the Object Lock rule for the specified object. Enable the this rule when you\n apply ObjectLockConfiguration to a bucket. Bucket settings require both a mode\n and a period. The period can be either Days or Years but you must\n select one. You cannot specify Days and Years at the same\n time.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The container element for Object Lock configuration parameters.

" + } + }, + "com.amazonaws.s3#ObjectLockEnabled": { + "type": "enum", + "members": { + "Enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enabled" + } + } + } + }, + "com.amazonaws.s3#ObjectLockEnabledForBucket": { + "type": "boolean" + }, + "com.amazonaws.s3#ObjectLockLegalHold": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.s3#ObjectLockLegalHoldStatus", + "traits": { + "smithy.api#documentation": "

Indicates whether the specified object has a legal hold in place.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A legal hold configuration for an object.

" + } + }, + "com.amazonaws.s3#ObjectLockLegalHoldStatus": { + "type": "enum", + "members": { + "ON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ON" + } + }, + "OFF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OFF" + } + } + } + }, + "com.amazonaws.s3#ObjectLockMode": { + "type": "enum", + "members": { + "GOVERNANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GOVERNANCE" + } + }, + "COMPLIANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLIANCE" + } + } + } + }, + "com.amazonaws.s3#ObjectLockRetainUntilDate": { + "type": "timestamp", + "traits": { + "smithy.api#timestampFormat": "date-time" + } + }, + "com.amazonaws.s3#ObjectLockRetention": { + "type": "structure", + "members": { + "Mode": { + "target": "com.amazonaws.s3#ObjectLockRetentionMode", + "traits": { + "smithy.api#documentation": "

Indicates the Retention mode for the specified object.

" + } + }, + "RetainUntilDate": { + "target": "com.amazonaws.s3#Date", + "traits": { + "smithy.api#documentation": "

The date on which this Object Lock Retention will expire.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A Retention configuration for an object.

" + } + }, + "com.amazonaws.s3#ObjectLockRetentionMode": { + "type": "enum", + "members": { + "GOVERNANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GOVERNANCE" + } + }, + "COMPLIANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLIANCE" + } + } + } + }, + "com.amazonaws.s3#ObjectLockRule": { + "type": "structure", + "members": { + "DefaultRetention": { + "target": "com.amazonaws.s3#DefaultRetention", + "traits": { + "smithy.api#documentation": "

The default Object Lock retention mode and period that you want to apply to new objects\n placed in the specified bucket. Bucket settings require both a mode and a period. The\n period can be either Days or Years but you must select one. You\n cannot specify Days and Years at the same time.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The container element for an Object Lock rule.

" + } + }, + "com.amazonaws.s3#ObjectLockToken": { + "type": "string" + }, + "com.amazonaws.s3#ObjectNotInActiveTierError": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

The source object of the COPY action is not in the active tier and is only stored in\n Amazon S3 Glacier.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.s3#ObjectOwnership": { + "type": "enum", + "members": { + "BucketOwnerPreferred": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BucketOwnerPreferred" + } + }, + "ObjectWriter": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ObjectWriter" + } + }, + "BucketOwnerEnforced": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BucketOwnerEnforced" + } + } + }, + "traits": { + "smithy.api#documentation": "

The container element for object ownership for a bucket's ownership controls.

\n

\n BucketOwnerPreferred - Objects uploaded to the bucket change ownership to\n the bucket owner if the objects are uploaded with the\n bucket-owner-full-control canned ACL.

\n

\n ObjectWriter - The uploading account will own the object if the object is\n uploaded with the bucket-owner-full-control canned ACL.

\n

\n BucketOwnerEnforced - Access control lists (ACLs) are disabled and no\n longer affect permissions. The bucket owner automatically owns and has full control over\n every object in the bucket. The bucket only accepts PUT requests that don't specify an ACL\n or specify bucket owner full control ACLs (such as the predefined\n bucket-owner-full-control canned ACL or a custom ACL in XML format that\n grants the same permissions).

\n

By default, ObjectOwnership is set to BucketOwnerEnforced and\n ACLs are disabled. We recommend keeping ACLs disabled, except in uncommon use cases where\n you must control access for each object individually. For more information about S3 Object\n Ownership, see Controlling ownership of\n objects and disabling ACLs for your bucket in the\n Amazon S3 User Guide.

\n \n

This functionality is not supported for directory buckets. Directory buckets use the bucket owner enforced setting for S3 Object Ownership.

\n " + } + }, + "com.amazonaws.s3#ObjectPart": { + "type": "structure", + "members": { + "PartNumber": { + "target": "com.amazonaws.s3#PartNumber", + "traits": { + "smithy.api#documentation": "

The part number identifying the part. This value is a positive integer between 1 and\n 10,000.

" + } + }, + "Size": { + "target": "com.amazonaws.s3#Size", + "traits": { + "smithy.api#documentation": "

The size of the uploaded part in bytes.

" + } + }, + "ChecksumCRC32": { + "target": "com.amazonaws.s3#ChecksumCRC32", + "traits": { + "smithy.api#documentation": "

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.\n This header specifies the base64-encoded, 32-bit CRC-32 checksum of the object. For more information, see\n Checking object integrity in the\n Amazon S3 User Guide.

" + } + }, + "ChecksumCRC32C": { + "target": "com.amazonaws.s3#ChecksumCRC32C", + "traits": { + "smithy.api#documentation": "

The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

" + } + }, + "ChecksumSHA1": { + "target": "com.amazonaws.s3#ChecksumSHA1", + "traits": { + "smithy.api#documentation": "

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded\n with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

" + } + }, + "ChecksumSHA256": { + "target": "com.amazonaws.s3#ChecksumSHA256", + "traits": { + "smithy.api#documentation": "

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A container for elements related to an individual part.

" + } + }, + "com.amazonaws.s3#ObjectSize": { + "type": "long" + }, + "com.amazonaws.s3#ObjectSizeGreaterThanBytes": { + "type": "long" + }, + "com.amazonaws.s3#ObjectSizeLessThanBytes": { + "type": "long" + }, + "com.amazonaws.s3#ObjectStorageClass": { + "type": "enum", + "members": { + "STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STANDARD" + } + }, + "REDUCED_REDUNDANCY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REDUCED_REDUNDANCY" + } + }, + "GLACIER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GLACIER" + } + }, + "STANDARD_IA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STANDARD_IA" + } + }, + "ONEZONE_IA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ONEZONE_IA" + } + }, + "INTELLIGENT_TIERING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTELLIGENT_TIERING" + } + }, + "DEEP_ARCHIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEEP_ARCHIVE" + } + }, + "OUTPOSTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OUTPOSTS" + } + }, + "GLACIER_IR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GLACIER_IR" + } + }, + "SNOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SNOW" + } + }, + "EXPRESS_ONEZONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPRESS_ONEZONE" + } + } + } + }, + "com.amazonaws.s3#ObjectVersion": { + "type": "structure", + "members": { + "ETag": { + "target": "com.amazonaws.s3#ETag", + "traits": { + "smithy.api#documentation": "

The entity tag is an MD5 hash of that version of the object.

" + } + }, + "ChecksumAlgorithm": { + "target": "com.amazonaws.s3#ChecksumAlgorithmList", + "traits": { + "smithy.api#documentation": "

The algorithm that was used to create a checksum of the object.

", + "smithy.api#xmlFlattened": {} + } + }, + "Size": { + "target": "com.amazonaws.s3#Size", + "traits": { + "smithy.api#documentation": "

Size in bytes of the object.

" + } + }, + "StorageClass": { + "target": "com.amazonaws.s3#ObjectVersionStorageClass", + "traits": { + "smithy.api#documentation": "

The class of storage used to store the object.

" + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

The object key.

" + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

Version ID of an object.

" + } + }, + "IsLatest": { + "target": "com.amazonaws.s3#IsLatest", + "traits": { + "smithy.api#documentation": "

Specifies whether the object is (true) or is not (false) the latest version of an\n object.

" + } + }, + "LastModified": { + "target": "com.amazonaws.s3#LastModified", + "traits": { + "smithy.api#documentation": "

Date and time when the object was last modified.

" + } + }, + "Owner": { + "target": "com.amazonaws.s3#Owner", + "traits": { + "smithy.api#documentation": "

Specifies the owner of the object.

" + } + }, + "RestoreStatus": { + "target": "com.amazonaws.s3#RestoreStatus", + "traits": { + "smithy.api#documentation": "

Specifies the restoration status of an object. Objects in certain storage classes must\n be restored before they can be retrieved. For more information about these storage classes\n and how to work with archived objects, see Working with archived\n objects in the Amazon S3 User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The version of an object.

" + } + }, + "com.amazonaws.s3#ObjectVersionId": { + "type": "string" + }, + "com.amazonaws.s3#ObjectVersionList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#ObjectVersion" + } + }, + "com.amazonaws.s3#ObjectVersionStorageClass": { + "type": "enum", + "members": { + "STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STANDARD" + } + } + } + }, + "com.amazonaws.s3#OptionalObjectAttributes": { + "type": "enum", + "members": { + "RESTORE_STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RestoreStatus" + } + } + } + }, + "com.amazonaws.s3#OptionalObjectAttributesList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#OptionalObjectAttributes" + } + }, + "com.amazonaws.s3#OutputLocation": { + "type": "structure", + "members": { + "S3": { + "target": "com.amazonaws.s3#S3Location", + "traits": { + "smithy.api#documentation": "

Describes an S3 location that will receive the results of the restore request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the location where the restore job's output is stored.

" + } + }, + "com.amazonaws.s3#OutputSerialization": { + "type": "structure", + "members": { + "CSV": { + "target": "com.amazonaws.s3#CSVOutput", + "traits": { + "smithy.api#documentation": "

Describes the serialization of CSV-encoded Select results.

" + } + }, + "JSON": { + "target": "com.amazonaws.s3#JSONOutput", + "traits": { + "smithy.api#documentation": "

Specifies JSON as request's output serialization format.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes how results of the Select job are serialized.

" + } + }, + "com.amazonaws.s3#Owner": { + "type": "structure", + "members": { + "DisplayName": { + "target": "com.amazonaws.s3#DisplayName", + "traits": { + "smithy.api#documentation": "

Container for the display name of the owner. This value is only supported in the\n following Amazon Web Services Regions:

\n
    \n
  • \n

    US East (N. Virginia)

    \n
    • \n
  • \n

    US West (N. California)

    \n
    • \n
  • \n

    US West (Oregon)

    \n
    • \n
  • \n

    Asia Pacific (Singapore)

    \n
    • \n
  • \n

    Asia Pacific (Sydney)

    \n
    • \n
  • \n

    Asia Pacific (Tokyo)

    \n
    • \n
  • \n

    Europe (Ireland)

    \n
    • \n
  • \n

    South America (São Paulo)

    \n
    • \n
\n \n

This functionality is not supported for directory buckets.

\n " + } + }, + "ID": { + "target": "com.amazonaws.s3#ID", + "traits": { + "smithy.api#documentation": "

Container for the ID of the owner.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Container for the owner's display name and ID.

" + } + }, + "com.amazonaws.s3#OwnerOverride": { + "type": "enum", + "members": { + "Destination": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Destination" + } + } + } + }, + "com.amazonaws.s3#OwnershipControls": { + "type": "structure", + "members": { + "Rules": { + "target": "com.amazonaws.s3#OwnershipControlsRules", + "traits": { + "smithy.api#documentation": "

The container element for an ownership control rule.

", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Rule" + } + } + }, + "traits": { + "smithy.api#documentation": "

The container element for a bucket's ownership controls.

" + } + }, + "com.amazonaws.s3#OwnershipControlsRule": { + "type": "structure", + "members": { + "ObjectOwnership": { + "target": "com.amazonaws.s3#ObjectOwnership", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The container element for an ownership control rule.

" + } + }, + "com.amazonaws.s3#OwnershipControlsRules": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#OwnershipControlsRule" + } + }, + "com.amazonaws.s3#ParquetInput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Container for Parquet.

" + } + }, + "com.amazonaws.s3#Part": { + "type": "structure", + "members": { + "PartNumber": { + "target": "com.amazonaws.s3#PartNumber", + "traits": { + "smithy.api#documentation": "

Part number identifying the part. This is a positive integer between 1 and\n 10,000.

" + } + }, + "LastModified": { + "target": "com.amazonaws.s3#LastModified", + "traits": { + "smithy.api#documentation": "

Date and time at which the part was uploaded.

" + } + }, + "ETag": { + "target": "com.amazonaws.s3#ETag", + "traits": { + "smithy.api#documentation": "

Entity tag returned when the part was uploaded.

" + } + }, + "Size": { + "target": "com.amazonaws.s3#Size", + "traits": { + "smithy.api#documentation": "

Size in bytes of the uploaded part data.

" + } + }, + "ChecksumCRC32": { + "target": "com.amazonaws.s3#ChecksumCRC32", + "traits": { + "smithy.api#documentation": "

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.\n This header specifies the base64-encoded, 32-bit CRC-32 checksum of the object. For more information, see\n Checking object integrity in the\n Amazon S3 User Guide.

" + } + }, + "ChecksumCRC32C": { + "target": "com.amazonaws.s3#ChecksumCRC32C", + "traits": { + "smithy.api#documentation": "

The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

" + } + }, + "ChecksumSHA1": { + "target": "com.amazonaws.s3#ChecksumSHA1", + "traits": { + "smithy.api#documentation": "

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded\n with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

" + } + }, + "ChecksumSHA256": { + "target": "com.amazonaws.s3#ChecksumSHA256", + "traits": { + "smithy.api#documentation": "

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.\n This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see\n Checking object integrity in the\n Amazon S3 User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Container for elements related to a part.

" + } + }, + "com.amazonaws.s3#PartNumber": { + "type": "integer" + }, + "com.amazonaws.s3#PartNumberMarker": { + "type": "string" + }, + "com.amazonaws.s3#PartitionDateSource": { + "type": "enum", + "members": { + "EventTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EventTime" + } + }, + "DeliveryTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeliveryTime" + } + } + } + }, + "com.amazonaws.s3#PartitionedPrefix": { + "type": "structure", + "members": { + "PartitionDateSource": { + "target": "com.amazonaws.s3#PartitionDateSource", + "traits": { + "smithy.api#documentation": "

Specifies the partition date source for the partitioned prefix.\n PartitionDateSource can be EventTime or\n DeliveryTime.

\n

For DeliveryTime, the time in the log file names corresponds to the\n delivery time for the log files.

\n

For EventTime, The logs delivered are for a specific day only. The year,\n month, and day correspond to the day on which the event occurred, and the hour, minutes and\n seconds are set to 00 in the key.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Amazon S3 keys for log objects are partitioned in the following format:

\n

\n [DestinationPrefix][SourceAccountId]/[SourceRegion]/[SourceBucket]/[YYYY]/[MM]/[DD]/[YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]\n

\n

PartitionedPrefix defaults to EventTime delivery when server access logs are\n delivered.

", + "smithy.api#xmlName": "PartitionedPrefix" + } + }, + "com.amazonaws.s3#Parts": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#Part" + } + }, + "com.amazonaws.s3#PartsCount": { + "type": "integer" + }, + "com.amazonaws.s3#PartsList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#ObjectPart" + } + }, + "com.amazonaws.s3#Payer": { + "type": "enum", + "members": { + "Requester": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Requester" + } + }, + "BucketOwner": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BucketOwner" + } + } + } + }, + "com.amazonaws.s3#Permission": { + "type": "enum", + "members": { + "FULL_CONTROL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FULL_CONTROL" + } + }, + "WRITE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WRITE" + } + }, + "WRITE_ACP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WRITE_ACP" + } + }, + "READ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READ" + } + }, + "READ_ACP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READ_ACP" + } + } + } + }, + "com.amazonaws.s3#Policy": { + "type": "string" + }, + "com.amazonaws.s3#PolicyStatus": { + "type": "structure", + "members": { + "IsPublic": { + "target": "com.amazonaws.s3#IsPublic", + "traits": { + "smithy.api#documentation": "

The policy status for this bucket. TRUE indicates that this bucket is\n public. FALSE indicates that the bucket is not public.

", + "smithy.api#xmlName": "IsPublic" + } + } + }, + "traits": { + "smithy.api#documentation": "

The container element for a bucket's policy status.

" + } + }, + "com.amazonaws.s3#Prefix": { + "type": "string" + }, + "com.amazonaws.s3#Priority": { + "type": "integer" + }, + "com.amazonaws.s3#Progress": { + "type": "structure", + "members": { + "BytesScanned": { + "target": "com.amazonaws.s3#BytesScanned", + "traits": { + "smithy.api#documentation": "

The current number of object bytes scanned.

" + } + }, + "BytesProcessed": { + "target": "com.amazonaws.s3#BytesProcessed", + "traits": { + "smithy.api#documentation": "

The current number of uncompressed object bytes processed.

" + } + }, + "BytesReturned": { + "target": "com.amazonaws.s3#BytesReturned", + "traits": { + "smithy.api#documentation": "

The current number of bytes of records payload data returned.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type contains information about progress of an operation.

" + } + }, + "com.amazonaws.s3#ProgressEvent": { + "type": "structure", + "members": { + "Details": { + "target": "com.amazonaws.s3#Progress", + "traits": { + "smithy.api#documentation": "

The Progress event details.

", + "smithy.api#eventPayload": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type contains information about the progress event of an operation.

" + } + }, + "com.amazonaws.s3#Protocol": { + "type": "enum", + "members": { + "http": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "http" + } + }, + "https": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "https" + } + } + } + }, + "com.amazonaws.s3#PublicAccessBlockConfiguration": { + "type": "structure", + "members": { + "BlockPublicAcls": { + "target": "com.amazonaws.s3#Setting", + "traits": { + "smithy.api#documentation": "

Specifies whether Amazon S3 should block public access control lists (ACLs) for this bucket\n and objects in this bucket. Setting this element to TRUE causes the following\n behavior:

\n
    \n
  • \n

    PUT Bucket ACL and PUT Object ACL calls fail if the specified ACL is\n public.

    \n
    • \n
  • \n

    PUT Object calls fail if the request includes a public ACL.

    \n
    • \n
  • \n

    PUT Bucket calls fail if the request includes a public ACL.

    \n
    • \n
\n

Enabling this setting doesn't affect existing policies or ACLs.

", + "smithy.api#xmlName": "BlockPublicAcls" + } + }, + "IgnorePublicAcls": { + "target": "com.amazonaws.s3#Setting", + "traits": { + "smithy.api#documentation": "

Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this\n bucket. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on\n this bucket and objects in this bucket.

\n

Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't\n prevent new public ACLs from being set.

", + "smithy.api#xmlName": "IgnorePublicAcls" + } + }, + "BlockPublicPolicy": { + "target": "com.amazonaws.s3#Setting", + "traits": { + "smithy.api#documentation": "

Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting this\n element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the\n specified bucket policy allows public access.

\n

Enabling this setting doesn't affect existing bucket policies.

", + "smithy.api#xmlName": "BlockPublicPolicy" + } + }, + "RestrictPublicBuckets": { + "target": "com.amazonaws.s3#Setting", + "traits": { + "smithy.api#documentation": "

Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting\n this element to TRUE restricts access to this bucket to only Amazon Web Services service principals and authorized users within this account if the bucket has\n a public policy.

\n

Enabling this setting doesn't affect previously stored bucket policies, except that\n public and cross-account access within any public bucket policy, including non-public\n delegation to specific accounts, is blocked.

", + "smithy.api#xmlName": "RestrictPublicBuckets" + } + } + }, + "traits": { + "smithy.api#documentation": "

The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can\n enable the configuration options in any combination. For more information about when Amazon S3\n considers a bucket or object public, see The Meaning of \"Public\" in the Amazon S3 User Guide.

" + } + }, + "com.amazonaws.s3#PutBucketAccelerateConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutBucketAccelerateConfigurationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "aws.protocols#httpChecksum": { + "requestAlgorithmMember": "ChecksumAlgorithm" + }, + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration is a\n bucket-level feature that enables you to perform faster data transfers to Amazon S3.

\n

To use this operation, you must have permission to perform the\n s3:PutAccelerateConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.

\n

The Transfer Acceleration state of a bucket can be set to one of the following two\n values:

\n
    \n
  • \n

    Enabled – Enables accelerated data transfers to the bucket.

    \n
    • \n
  • \n

    Suspended – Disables accelerated data transfers to the bucket.

    \n
    • \n
\n

The GetBucketAccelerateConfiguration action returns the transfer acceleration state\n of a bucket.

\n

After setting the Transfer Acceleration state of a bucket to Enabled, it might take up\n to thirty minutes before the data transfer rates to the bucket increase.

\n

The name of the bucket used for Transfer Acceleration must be DNS-compliant and must\n not contain periods (\".\").

\n

For more information about transfer acceleration, see Transfer\n Acceleration.

\n

The following operations are related to\n PutBucketAccelerateConfiguration:

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}?accelerate", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#PutBucketAccelerateConfigurationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket for which the accelerate configuration is set.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "AccelerateConfiguration": { + "target": "com.amazonaws.s3#AccelerateConfiguration", + "traits": { + "smithy.api#documentation": "

Container for setting the transfer acceleration state.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {}, + "smithy.api#xmlName": "AccelerateConfiguration" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + }, + "ChecksumAlgorithm": { + "target": "com.amazonaws.s3#ChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any\n additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or\n x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more\n information, see Checking object integrity in\n the Amazon S3 User Guide.

\n

If you provide an individual checksum, Amazon S3 ignores any provided\n ChecksumAlgorithm parameter.

", + "smithy.api#httpHeader": "x-amz-sdk-checksum-algorithm" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#PutBucketAcl": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutBucketAclRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "aws.protocols#httpChecksum": { + "requestAlgorithmMember": "ChecksumAlgorithm", + "requestChecksumRequired": true + }, + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Sets the permissions on an existing bucket using access control lists (ACL). For more\n information, see Using ACLs. To set the ACL of a\n bucket, you must have the WRITE_ACP permission.

\n

You can use one of the following two ways to set a bucket's permissions:

\n
    \n
  • \n

    Specify the ACL in the request body

    \n
    • \n
  • \n

    Specify permissions using request headers

    \n
    • \n
\n \n

You cannot specify access permission using both the body and the request\n headers.

\n \n

Depending on your application needs, you may choose to set the ACL on a bucket using\n either the request body or the headers. For example, if you have an existing application\n that updates a bucket ACL using the request body, then you can continue to use that\n approach.

\n \n

If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs\n are disabled and no longer affect permissions. You must use policies to grant access to\n your bucket and the objects in it. Requests to set ACLs or update ACLs fail and return\n the AccessControlListNotSupported error code. Requests to read ACLs are\n still supported. For more information, see Controlling object\n ownership in the Amazon S3 User Guide.

\n \n
\n
Permissions
\n
\n

You can set access permissions by using one of the following methods:

\n
    \n
  • \n

    Specify a canned ACL with the x-amz-acl request header. Amazon S3\n supports a set of predefined ACLs, known as canned\n ACLs. Each canned ACL has a predefined set of grantees and\n permissions. Specify the canned ACL name as the value of\n x-amz-acl. If you use this header, you cannot use other\n access control-specific headers in your request. For more information, see\n Canned\n ACL.

    \n
    • \n
  • \n

    Specify access permissions explicitly with the\n x-amz-grant-read, x-amz-grant-read-acp,\n x-amz-grant-write-acp, and\n x-amz-grant-full-control headers. When using these headers,\n you specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3\n groups) who will receive the permission. If you use these ACL-specific\n headers, you cannot use the x-amz-acl header to set a canned\n ACL. These parameters map to the set of permissions that Amazon S3 supports in an\n ACL. For more information, see Access Control List (ACL)\n Overview.

    \n

    You specify each grantee as a type=value pair, where the type is one of\n the following:

    \n
      \n
    • \n

      \n id – if the value specified is the canonical user ID\n of an Amazon Web Services account

      \n
      • \n
    • \n

      \n uri – if you are granting permissions to a predefined\n group

      \n
      • \n
    • \n

      \n emailAddress – if the value specified is the email\n address of an Amazon Web Services account

      \n \n

      Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

      \n
        \n
      • \n

        US East (N. Virginia)

        \n
        • \n
      • \n

        US West (N. California)

        \n
        • \n
      • \n

        US West (Oregon)

        \n
        • \n
      • \n

        Asia Pacific (Singapore)

        \n
        • \n
      • \n

        Asia Pacific (Sydney)

        \n
        • \n
      • \n

        Asia Pacific (Tokyo)

        \n
        • \n
      • \n

        Europe (Ireland)

        \n
        • \n
      • \n

        South America (São Paulo)

        \n
        • \n
      \n

      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

      \n       \n
      • \n
    \n

    For example, the following x-amz-grant-write header grants\n create, overwrite, and delete objects permission to LogDelivery group\n predefined by Amazon S3 and two Amazon Web Services accounts identified by their email\n addresses.

    \n

    \n x-amz-grant-write:\n uri=\"http://acs.amazonaws.com/groups/s3/LogDelivery\", id=\"111122223333\",\n id=\"555566667777\" \n

    \n
    • \n
\n

You can use either a canned ACL or specify access permissions explicitly. You\n cannot do both.

\n
\n
Grantee Values
\n
\n

You can specify the person (grantee) to whom you're assigning access rights\n (using request elements) in the following ways:

\n
    \n
  • \n

    By the person's ID:

    \n

    \n <>ID<><>GranteesEmail<>\n \n

    \n

    DisplayName is optional and ignored in the request

    \n
    • \n
  • \n

    By URI:

    \n

    \n <>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<>\n

    \n
    • \n
  • \n

    By Email address:

    \n

    \n <>Grantees@email.com<>&\n

    \n

    The grantee is resolved to the CanonicalUser and, in a response to a GET\n Object acl request, appears as the CanonicalUser.

    \n \n

    Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

    \n
      \n
    • \n

      US East (N. Virginia)

      \n
      • \n
    • \n

      US West (N. California)

      \n
      • \n
    • \n

      US West (Oregon)

      \n
      • \n
    • \n

      Asia Pacific (Singapore)

      \n
      • \n
    • \n

      Asia Pacific (Sydney)

      \n
      • \n
    • \n

      Asia Pacific (Tokyo)

      \n
      • \n
    • \n

      Europe (Ireland)

      \n
      • \n
    • \n

      South America (São Paulo)

      \n
      • \n
    \n

    For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

    \n     \n
    • \n
\n
\n
\n

The following operations are related to PutBucketAcl:

\n ", + "smithy.api#examples": [ + { + "title": "Put bucket acl", + "documentation": "The following example replaces existing ACL on a bucket. The ACL grants the bucket owner (specified using the owner ID) and write permission to the LogDelivery group. Because this is a replace operation, you must specify all the grants in your request. To incrementally add or remove ACL grants, you might use the console.", + "input": { + "Bucket": "examplebucket", + "GrantFullControl": "id=examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484", + "GrantWrite": "uri=http://acs.amazonaws.com/groups/s3/LogDelivery" + } + } + ], + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}?acl", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#PutBucketAclRequest": { + "type": "structure", + "members": { + "ACL": { + "target": "com.amazonaws.s3#BucketCannedACL", + "traits": { + "smithy.api#documentation": "

The canned ACL to apply to the bucket.

", + "smithy.api#httpHeader": "x-amz-acl" + } + }, + "AccessControlPolicy": { + "target": "com.amazonaws.s3#AccessControlPolicy", + "traits": { + "smithy.api#documentation": "

Contains the elements that set the ACL permissions for an object per grantee.

", + "smithy.api#httpPayload": {}, + "smithy.api#xmlName": "AccessControlPolicy" + } + }, + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket to which to apply the ACL.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ContentMD5": { + "target": "com.amazonaws.s3#ContentMD5", + "traits": { + "smithy.api#documentation": "

The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message\n integrity check to verify that the request body was not corrupted in transit. For more\n information, go to RFC\n 1864.\n

\n

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

", + "smithy.api#httpHeader": "Content-MD5" + } + }, + "ChecksumAlgorithm": { + "target": "com.amazonaws.s3#ChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any\n additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or\n x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more\n information, see Checking object integrity in\n the Amazon S3 User Guide.

\n

If you provide an individual checksum, Amazon S3 ignores any provided\n ChecksumAlgorithm parameter.

", + "smithy.api#httpHeader": "x-amz-sdk-checksum-algorithm" + } + }, + "GrantFullControl": { + "target": "com.amazonaws.s3#GrantFullControl", + "traits": { + "smithy.api#documentation": "

Allows grantee the read, write, read ACP, and write ACP permissions on the\n bucket.

", + "smithy.api#httpHeader": "x-amz-grant-full-control" + } + }, + "GrantRead": { + "target": "com.amazonaws.s3#GrantRead", + "traits": { + "smithy.api#documentation": "

Allows grantee to list the objects in the bucket.

", + "smithy.api#httpHeader": "x-amz-grant-read" + } + }, + "GrantReadACP": { + "target": "com.amazonaws.s3#GrantReadACP", + "traits": { + "smithy.api#documentation": "

Allows grantee to read the bucket ACL.

", + "smithy.api#httpHeader": "x-amz-grant-read-acp" + } + }, + "GrantWrite": { + "target": "com.amazonaws.s3#GrantWrite", + "traits": { + "smithy.api#documentation": "

Allows grantee to create new objects in the bucket.

\n

For the bucket and object owners of existing objects, also allows deletions and\n overwrites of those objects.

", + "smithy.api#httpHeader": "x-amz-grant-write" + } + }, + "GrantWriteACP": { + "target": "com.amazonaws.s3#GrantWriteACP", + "traits": { + "smithy.api#documentation": "

Allows grantee to write the ACL for the applicable bucket.

", + "smithy.api#httpHeader": "x-amz-grant-write-acp" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#PutBucketAnalyticsConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutBucketAnalyticsConfigurationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Sets an analytics configuration for the bucket (specified by the analytics configuration\n ID). You can have up to 1,000 analytics configurations per bucket.

\n

You can choose to have storage class analysis export analysis reports sent to a\n comma-separated values (CSV) flat file. See the DataExport request element.\n Reports are updated daily and are based on the object filters that you configure. When\n selecting data export, you specify a destination bucket and an optional destination prefix\n where the file is written. You can export the data to a destination bucket in a different\n account. However, the destination bucket must be in the same Region as the bucket that you\n are making the PUT analytics configuration to. For more information, see Amazon S3\n Analytics – Storage Class Analysis.

\n \n

You must create a bucket policy on the destination bucket where the exported file is\n written to grant permissions to Amazon S3 to write objects to the bucket. For an example\n policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.

\n \n

To use this operation, you must have permissions to perform the\n s3:PutAnalyticsConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.

\n

\n PutBucketAnalyticsConfiguration has the following special errors:

\n
    \n
  • \n
      \n
    • \n

      \n HTTP Error: HTTP 400 Bad Request\n

      \n
      • \n
    • \n

      \n Code: InvalidArgument\n

      \n
      • \n
    • \n

      \n Cause: Invalid argument.\n

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n HTTP Error: HTTP 400 Bad Request\n

      \n
      • \n
    • \n

      \n Code: TooManyConfigurations\n

      \n
      • \n
    • \n

      \n Cause: You are attempting to create a new configuration but have\n already reached the 1,000-configuration limit.\n

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n HTTP Error: HTTP 403 Forbidden\n

      \n
      • \n
    • \n

      \n Code: AccessDenied\n

      \n
      • \n
    • \n

      \n Cause: You are not the owner of the specified bucket, or you do\n not have the s3:PutAnalyticsConfiguration bucket permission to set the\n configuration on the bucket.\n

      \n
      • \n
    \n
    • \n
\n

The following operations are related to\n PutBucketAnalyticsConfiguration:

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}?analytics", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#PutBucketAnalyticsConfigurationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket to which an analytics configuration is stored.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "Id": { + "target": "com.amazonaws.s3#AnalyticsId", + "traits": { + "smithy.api#documentation": "

The ID that identifies the analytics configuration.

", + "smithy.api#httpQuery": "id", + "smithy.api#required": {} + } + }, + "AnalyticsConfiguration": { + "target": "com.amazonaws.s3#AnalyticsConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration and any analyses for the analytics filter.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {}, + "smithy.api#xmlName": "AnalyticsConfiguration" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#PutBucketCors": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutBucketCorsRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "aws.protocols#httpChecksum": { + "requestAlgorithmMember": "ChecksumAlgorithm", + "requestChecksumRequired": true + }, + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Sets the cors configuration for your bucket. If the configuration exists,\n Amazon S3 replaces it.

\n

To use this operation, you must be allowed to perform the s3:PutBucketCORS\n action. By default, the bucket owner has this permission and can grant it to others.

\n

You set this configuration on a bucket so that the bucket can service cross-origin\n requests. For example, you might want to enable a request whose origin is\n http://www.example.com to access your Amazon S3 bucket at\n my.example.bucket.com by using the browser's XMLHttpRequest\n capability.

\n

To enable cross-origin resource sharing (CORS) on a bucket, you add the\n cors subresource to the bucket. The cors subresource is an XML\n document in which you configure rules that identify origins and the HTTP methods that can\n be executed on your bucket. The document is limited to 64 KB in size.

\n

When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS request) against a\n bucket, it evaluates the cors configuration on the bucket and uses the first\n CORSRule rule that matches the incoming browser request to enable a\n cross-origin request. For a rule to match, the following conditions must be met:

\n
    \n
  • \n

    The request's Origin header must match AllowedOrigin\n elements.

    \n
    • \n
  • \n

    The request method (for example, GET, PUT, HEAD, and so on) or the\n Access-Control-Request-Method header in case of a pre-flight\n OPTIONS request must be one of the AllowedMethod\n elements.

    \n
    • \n
  • \n

    Every header specified in the Access-Control-Request-Headers request\n header of a pre-flight request must match an AllowedHeader element.\n

    \n
    • \n
\n

For more information about CORS, go to Enabling Cross-Origin Resource Sharing in\n the Amazon S3 User Guide.

\n

The following operations are related to PutBucketCors:

\n ", + "smithy.api#examples": [ + { + "title": "To set cors configuration on a bucket.", + "documentation": "The following example enables PUT, POST, and DELETE requests from www.example.com, and enables GET requests from any domain.", + "input": { + "Bucket": "", + "CORSConfiguration": { + "CORSRules": [ + { + "AllowedOrigins": [ + "http://www.example.com" + ], + "AllowedHeaders": [ + "*" + ], + "AllowedMethods": [ + "PUT", + "POST", + "DELETE" + ], + "MaxAgeSeconds": 3000, + "ExposeHeaders": [ + "x-amz-server-side-encryption" + ] + }, + { + "AllowedOrigins": [ + "*" + ], + "AllowedHeaders": [ + "Authorization" + ], + "AllowedMethods": [ + "GET" + ], + "MaxAgeSeconds": 3000 + } + ] + }, + "ContentMD5": "" + } + } + ], + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}?cors", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#PutBucketCorsRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

Specifies the bucket impacted by the corsconfiguration.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "CORSConfiguration": { + "target": "com.amazonaws.s3#CORSConfiguration", + "traits": { + "smithy.api#documentation": "

Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more\n information, see Enabling\n Cross-Origin Resource Sharing in the\n Amazon S3 User Guide.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {}, + "smithy.api#xmlName": "CORSConfiguration" + } + }, + "ContentMD5": { + "target": "com.amazonaws.s3#ContentMD5", + "traits": { + "smithy.api#documentation": "

The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message\n integrity check to verify that the request body was not corrupted in transit. For more\n information, go to RFC\n 1864.\n

\n

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

", + "smithy.api#httpHeader": "Content-MD5" + } + }, + "ChecksumAlgorithm": { + "target": "com.amazonaws.s3#ChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any\n additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or\n x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more\n information, see Checking object integrity in\n the Amazon S3 User Guide.

\n

If you provide an individual checksum, Amazon S3 ignores any provided\n ChecksumAlgorithm parameter.

", + "smithy.api#httpHeader": "x-amz-sdk-checksum-algorithm" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#PutBucketEncryption": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutBucketEncryptionRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "aws.protocols#httpChecksum": { + "requestAlgorithmMember": "ChecksumAlgorithm", + "requestChecksumRequired": true + }, + "smithy.api#documentation": "

This operation configures default encryption and Amazon S3 Bucket Keys for an existing\n bucket.

\n \n

\n Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name\n . Virtual-hosted-style requests aren't supported. \nFor more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the\n Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the\n Amazon S3 User Guide.

\n \n

By default, all buckets have a default encryption configuration that uses server-side\n encryption with Amazon S3 managed keys (SSE-S3).

\n \n
    \n
  • \n

    \n General purpose buckets\n

    \n
      \n
    • \n

      You can optionally configure default encryption for a bucket by using\n server-side encryption with Key Management Service (KMS) keys (SSE-KMS) or dual-layer\n server-side encryption with Amazon Web Services KMS keys (DSSE-KMS). If you specify\n default encryption by using SSE-KMS, you can also configure Amazon S3\n Bucket Keys. For information about the bucket default encryption\n feature, see Amazon S3 Bucket Default\n Encryption in the Amazon S3 User Guide.

      \n
      • \n
    • \n

      If you use PutBucketEncryption to set your default bucket\n encryption to SSE-KMS, you should verify that your KMS key ID\n is correct. Amazon S3 doesn't validate the KMS key ID provided in\n PutBucketEncryption requests.

      \n
      • \n
    \n
    • \n
  • \n

    \n Directory buckets - You can\n optionally configure default encryption for a bucket by using server-side\n encryption with Key Management Service (KMS) keys (SSE-KMS).

    \n
      \n
    • \n

      We recommend that the bucket's default encryption uses the desired\n encryption configuration and you don't override the bucket default\n encryption in your CreateSession requests or PUT\n object requests. Then, new objects are automatically encrypted with the\n desired encryption settings.\n For more information about the encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.

      \n
      • \n
    • \n

      Your SSE-KMS configuration can only support 1 customer managed key per directory bucket for the lifetime of the bucket. \nThe Amazon Web Services managed key (aws/s3) isn't supported. \n

      \n
      • \n
    • \n

      S3 Bucket Keys are always enabled for GET and PUT operations in a directory bucket and can’t be disabled. S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets \nto directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through CopyObject, UploadPartCopy, the Copy operation in Batch Operations, or \n the import jobs. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.

      \n
      • \n
    • \n

      When you specify an KMS customer managed key for encryption in your directory bucket, only use the key ID or key ARN. The key alias format of the KMS key isn't supported.

      \n
      • \n
    • \n

      For directory buckets, if you use PutBucketEncryption to set your default bucket encryption to SSE-KMS, Amazon S3 validates the\n KMS key ID provided in PutBucketEncryption requests.

      \n
      • \n
    \n
    • \n
\n \n \n

If you're specifying a customer managed KMS key, we recommend using a fully\n qualified KMS key ARN. If you use a KMS key alias instead, then KMS resolves the\n key within the requester’s account. This behavior can result in data that's encrypted\n with a KMS key that belongs to the requester, and not the bucket owner.

\n

Also, this action requires Amazon Web Services Signature Version 4. For more information, see\n Authenticating\n Requests (Amazon Web Services Signature Version 4).

\n \n
\n
Permissions
\n
\n
    \n
  • \n

    \n General purpose bucket permissions - The\n s3:PutEncryptionConfiguration permission is required in a\n policy. The bucket owner has this permission by default. The bucket owner\n can grant this permission to others. For more information about permissions,\n see Permissions Related to Bucket Operations and Managing Access\n Permissions to Your Amazon S3 Resources in the\n Amazon S3 User Guide.

    \n
    • \n
  • \n

    \n Directory bucket permissions -\n To grant access to this API operation, you must have the\n s3express:PutEncryptionConfiguration permission in\n an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource.\n For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

    \n

    To set a directory bucket default encryption with SSE-KMS, you must also\n have the kms:GenerateDataKey and the kms:Decrypt\n permissions in IAM identity-based policies and KMS key policies for the\n target KMS key.

    \n
    • \n
\n
\n
HTTP Host header syntax
\n
\n

\n Directory buckets - The HTTP Host header syntax is s3express-control.region-code.amazonaws.com.

\n
\n
\n

The following operations are related to PutBucketEncryption:

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}?encryption", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#PutBucketEncryptionRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

Specifies default encryption for a bucket using server-side encryption with different\n key options.

\n

\n Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name\n . Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide\n

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ContentMD5": { + "target": "com.amazonaws.s3#ContentMD5", + "traits": { + "smithy.api#documentation": "

The base64-encoded 128-bit MD5 digest of the server-side encryption\n configuration.

\n

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "Content-MD5" + } + }, + "ChecksumAlgorithm": { + "target": "com.amazonaws.s3#ChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any\n additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or\n x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more\n information, see Checking object integrity in\n the Amazon S3 User Guide.

\n

If you provide an individual checksum, Amazon S3 ignores any provided\n ChecksumAlgorithm parameter.

\n \n

For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default checksum algorithm that's used for performance.

\n ", + "smithy.api#httpHeader": "x-amz-sdk-checksum-algorithm" + } + }, + "ServerSideEncryptionConfiguration": { + "target": "com.amazonaws.s3#ServerSideEncryptionConfiguration", + "traits": { + "smithy.api#httpPayload": {}, + "smithy.api#required": {}, + "smithy.api#xmlName": "ServerSideEncryptionConfiguration" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

\n \n

For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code \n501 Not Implemented.

\n ", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#PutBucketIntelligentTieringConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutBucketIntelligentTieringConfigurationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Puts a S3 Intelligent-Tiering configuration to the specified bucket. You can have up to\n 1,000 S3 Intelligent-Tiering configurations per bucket.

\n

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.

\n

The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.

\n

For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

\n

Operations related to PutBucketIntelligentTieringConfiguration include:

\n \n \n

You only need S3 Intelligent-Tiering enabled on a bucket if you want to automatically\n move objects stored in the S3 Intelligent-Tiering storage class to the Archive Access\n or Deep Archive Access tier.

\n \n

\n PutBucketIntelligentTieringConfiguration has the following special\n errors:

\n
\n
HTTP 400 Bad Request Error
\n
\n

\n Code: InvalidArgument

\n

\n Cause: Invalid Argument

\n
\n
HTTP 400 Bad Request Error
\n
\n

\n Code: TooManyConfigurations

\n

\n Cause: You are attempting to create a new configuration\n but have already reached the 1,000-configuration limit.

\n
\n
HTTP 403 Forbidden Error
\n
\n

\n Cause: You are not the owner of the specified bucket, or\n you do not have the s3:PutIntelligentTieringConfiguration bucket\n permission to set the configuration on the bucket.

\n
\n
", + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}?intelligent-tiering", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#PutBucketIntelligentTieringConfigurationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "Id": { + "target": "com.amazonaws.s3#IntelligentTieringId", + "traits": { + "smithy.api#documentation": "

The ID used to identify the S3 Intelligent-Tiering configuration.

", + "smithy.api#httpQuery": "id", + "smithy.api#required": {} + } + }, + "IntelligentTieringConfiguration": { + "target": "com.amazonaws.s3#IntelligentTieringConfiguration", + "traits": { + "smithy.api#documentation": "

Container for S3 Intelligent-Tiering configuration.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {}, + "smithy.api#xmlName": "IntelligentTieringConfiguration" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#PutBucketInventoryConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutBucketInventoryConfigurationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

This implementation of the PUT action adds an inventory configuration\n (identified by the inventory ID) to the bucket. You can have up to 1,000 inventory\n configurations per bucket.

\n

Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly\n basis, and the results are published to a flat file. The bucket that is inventoried is\n called the source bucket, and the bucket where the inventory flat file\n is stored is called the destination bucket. The\n destination bucket must be in the same Amazon Web Services Region as the\n source bucket.

\n

When you configure an inventory for a source bucket, you specify\n the destination bucket where you want the inventory to be stored, and\n whether to generate the inventory daily or weekly. You can also configure what object\n metadata to include and whether to inventory all object versions or only current versions.\n For more information, see Amazon S3 Inventory in the\n Amazon S3 User Guide.

\n \n

You must create a bucket policy on the destination bucket to\n grant permissions to Amazon S3 to write objects to the bucket in the defined location. For an\n example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.

\n \n
\n
Permissions
\n
\n

To use this operation, you must have permission to perform the\n s3:PutInventoryConfiguration action. The bucket owner has this\n permission by default and can grant this permission to others.

\n

The s3:PutInventoryConfiguration permission allows a user to\n create an S3 Inventory\n report that includes all object metadata fields available and to specify the\n destination bucket to store the inventory. A user with read access to objects in\n the destination bucket can also access all object metadata fields that are\n available in the inventory report.

\n

To restrict access to an inventory report, see Restricting access to an Amazon S3 Inventory report in the\n Amazon S3 User Guide. For more information about the metadata\n fields available in S3 Inventory, see Amazon S3 Inventory lists in the Amazon S3 User Guide. For\n more information about permissions, see Permissions related to bucket subresource operations and Identity and access management in Amazon S3 in the\n Amazon S3 User Guide.

\n
\n
\n

\n PutBucketInventoryConfiguration has the following special errors:

\n
\n
HTTP 400 Bad Request Error
\n
\n

\n Code: InvalidArgument

\n

\n Cause: Invalid Argument

\n
\n
HTTP 400 Bad Request Error
\n
\n

\n Code: TooManyConfigurations

\n

\n Cause: You are attempting to create a new configuration\n but have already reached the 1,000-configuration limit.

\n
\n
HTTP 403 Forbidden Error
\n
\n

\n Cause: You are not the owner of the specified bucket, or\n you do not have the s3:PutInventoryConfiguration bucket permission to\n set the configuration on the bucket.

\n
\n
\n

The following operations are related to\n PutBucketInventoryConfiguration:

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}?inventory", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#PutBucketInventoryConfigurationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket where the inventory configuration will be stored.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "Id": { + "target": "com.amazonaws.s3#InventoryId", + "traits": { + "smithy.api#documentation": "

The ID used to identify the inventory configuration.

", + "smithy.api#httpQuery": "id", + "smithy.api#required": {} + } + }, + "InventoryConfiguration": { + "target": "com.amazonaws.s3#InventoryConfiguration", + "traits": { + "smithy.api#documentation": "

Specifies the inventory configuration.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {}, + "smithy.api#xmlName": "InventoryConfiguration" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#PutBucketLifecycleConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutBucketLifecycleConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.s3#PutBucketLifecycleConfigurationOutput" + }, + "traits": { + "aws.protocols#httpChecksum": { + "requestAlgorithmMember": "ChecksumAlgorithm", + "requestChecksumRequired": true + }, + "smithy.api#documentation": "

Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle\n configuration. Keep in mind that this will overwrite an existing lifecycle configuration,\n so if you want to retain any configuration details, they must be included in the new\n lifecycle configuration. For information about lifecycle configuration, see Managing\n your storage lifecycle.

\n \n

Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, object size, or any combination of these. Accordingly, this section describes the latest API. The previous version of the API supported filtering based only on an object key name prefix, which is supported for backward compatibility.\n For the related API description, see PutBucketLifecycle.

\n \n
\n
Rules
\n
Permissions
\n
HTTP Host header syntax
\n
\n

You specify the lifecycle configuration in your request body. The lifecycle\n configuration is specified as XML consisting of one or more rules. An Amazon S3\n Lifecycle configuration can have up to 1,000 rules. This limit is not\n adjustable.

\n

Bucket lifecycle configuration supports specifying a lifecycle rule using an\n object key name prefix, one or more object tags, object size, or any combination\n of these. Accordingly, this section describes the latest API. The previous version\n of the API supported filtering based only on an object key name prefix, which is\n supported for backward compatibility for general purpose buckets. For the related\n API description, see PutBucketLifecycle.

\n \n

Lifecyle configurations for directory buckets only support expiring objects and\n cancelling multipart uploads. Expiring of versioned objects,transitions and tag\n filters are not supported.

\n \n

A lifecycle rule consists of the following:

\n
    \n
  • \n

    A filter identifying a subset of objects to which the rule applies. The\n filter can be based on a key name prefix, object tags, object size, or any\n combination of these.

    \n
    • \n
  • \n

    A status indicating whether the rule is in effect.

    \n
    • \n
  • \n

    One or more lifecycle transition and expiration actions that you want\n Amazon S3 to perform on the objects identified by the filter. If the state of\n your bucket is versioning-enabled or versioning-suspended, you can have many\n versions of the same object (one current version and zero or more noncurrent\n versions). Amazon S3 provides predefined actions that you can specify for current\n and noncurrent object versions.

    \n
    • \n
\n

For more information, see Object Lifecycle\n Management and Lifecycle Configuration\n Elements.

\n
\n
\n
    \n
  • \n

    \n General purpose bucket permissions - By\n default, all Amazon S3 resources are private, including buckets, objects, and\n related subresources (for example, lifecycle configuration and website\n configuration). Only the resource owner (that is, the Amazon Web Services account that\n created it) can access the resource. The resource owner can optionally grant\n access permissions to others by writing an access policy. For this\n operation, a user must have the s3:PutLifecycleConfiguration\n permission.

    \n

    You can also explicitly deny permissions. An explicit deny also\n supersedes any other permissions. If you want to block users or accounts\n from removing or deleting objects from your bucket, you must deny them\n permissions for the following actions:

    \n \n
    • \n
\n
    \n
  • \n

    \n Directory bucket permissions -\n You must have the s3express:PutLifecycleConfiguration\n permission in an IAM identity-based policy to use this operation.\n Cross-account access to this API operation isn't supported. The resource\n owner can optionally grant access permissions to others by creating a role\n or user for them as long as they are within the same account as the owner\n and resource.

    \n

    For more information about directory bucket policies and permissions, see\n Authorizing Regional endpoint APIs with IAM in the\n Amazon S3 User Guide.

    \n \n

    \n Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name\n . Virtual-hosted-style requests aren't supported. \nFor more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the\n Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the\n Amazon S3 User Guide.

    \n     \n
    • \n
\n
\n
\n

\n Directory buckets - The HTTP Host\n header syntax is\n s3express-control.region.amazonaws.com.

\n

The following operations are related to\n PutBucketLifecycleConfiguration:

\n \n
\n
", + "smithy.api#examples": [ + { + "title": "Put bucket lifecycle", + "documentation": "The following example replaces existing lifecycle configuration, if any, on the specified bucket. ", + "input": { + "Bucket": "examplebucket", + "LifecycleConfiguration": { + "Rules": [ + { + "Filter": { + "Prefix": "documents/" + }, + "Status": "Enabled", + "Transitions": [ + { + "Days": 365, + "StorageClass": "GLACIER" + } + ], + "Expiration": { + "Days": 3650 + }, + "ID": "TestOnly" + } + ] + } + } + } + ], + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}?lifecycle", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#PutBucketLifecycleConfigurationOutput": { + "type": "structure", + "members": { + "TransitionDefaultMinimumObjectSize": { + "target": "com.amazonaws.s3#TransitionDefaultMinimumObjectSize", + "traits": { + "smithy.api#documentation": "

Indicates which default minimum object size behavior is applied to the lifecycle\n configuration.

\n \n

This parameter applies to general purpose buckets only. It is not supported for\n directory bucket lifecycle configurations.

\n \n
    \n
  • \n

    \n all_storage_classes_128K - Objects smaller than 128 KB will not\n transition to any storage class by default.

    \n
    • \n
  • \n

    \n varies_by_storage_class - Objects smaller than 128 KB will\n transition to Glacier Flexible Retrieval or Glacier Deep Archive storage classes. By\n default, all other storage classes will prevent transitions smaller than 128 KB.\n

    \n
    • \n
\n

To customize the minimum object size for any transition you can add a filter that\n specifies a custom ObjectSizeGreaterThan or ObjectSizeLessThan in\n the body of your transition rule. Custom filters always take precedence over the default\n transition behavior.

", + "smithy.api#httpHeader": "x-amz-transition-default-minimum-object-size" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3#PutBucketLifecycleConfigurationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket for which to set the configuration.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ChecksumAlgorithm": { + "target": "com.amazonaws.s3#ChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any\n additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or\n x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more\n information, see Checking object integrity in\n the Amazon S3 User Guide.

\n

If you provide an individual checksum, Amazon S3 ignores any provided\n ChecksumAlgorithm parameter.

", + "smithy.api#httpHeader": "x-amz-sdk-checksum-algorithm" + } + }, + "LifecycleConfiguration": { + "target": "com.amazonaws.s3#BucketLifecycleConfiguration", + "traits": { + "smithy.api#documentation": "

Container for lifecycle rules. You can add as many as 1,000 rules.

", + "smithy.api#httpPayload": {}, + "smithy.api#xmlName": "LifecycleConfiguration" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

\n \n

This parameter applies to general purpose buckets only. It is not supported for\n directory bucket lifecycle configurations.

\n ", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + }, + "TransitionDefaultMinimumObjectSize": { + "target": "com.amazonaws.s3#TransitionDefaultMinimumObjectSize", + "traits": { + "smithy.api#documentation": "

Indicates which default minimum object size behavior is applied to the lifecycle\n configuration.

\n \n

This parameter applies to general purpose buckets only. It is not supported for\n directory bucket lifecycle configurations.

\n \n
    \n
  • \n

    \n all_storage_classes_128K - Objects smaller than 128 KB will not\n transition to any storage class by default.

    \n
    • \n
  • \n

    \n varies_by_storage_class - Objects smaller than 128 KB will\n transition to Glacier Flexible Retrieval or Glacier Deep Archive storage classes. By\n default, all other storage classes will prevent transitions smaller than 128 KB.\n

    \n
    • \n
\n

To customize the minimum object size for any transition you can add a filter that\n specifies a custom ObjectSizeGreaterThan or ObjectSizeLessThan in\n the body of your transition rule. Custom filters always take precedence over the default\n transition behavior.

", + "smithy.api#httpHeader": "x-amz-transition-default-minimum-object-size" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#PutBucketLogging": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutBucketLoggingRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "aws.protocols#httpChecksum": { + "requestAlgorithmMember": "ChecksumAlgorithm", + "requestChecksumRequired": true + }, + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Set the logging parameters for a bucket and to specify permissions for who can view and\n modify the logging parameters. All logs are saved to buckets in the same Amazon Web Services Region as\n the source bucket. To set the logging status of a bucket, you must be the bucket\n owner.

\n

The bucket owner is automatically granted FULL_CONTROL to all logs. You use the\n Grantee request element to grant access to other people. The\n Permissions request element specifies the kind of access the grantee has to\n the logs.

\n \n

If the target bucket for log delivery uses the bucket owner enforced setting for S3\n Object Ownership, you can't use the Grantee request element to grant access\n to others. Permissions can only be granted using policies. For more information, see\n Permissions for server access log delivery in the\n Amazon S3 User Guide.

\n \n
\n
Grantee Values
\n
\n

You can specify the person (grantee) to whom you're assigning access rights (by\n using request elements) in the following ways:

\n
    \n
  • \n

    By the person's ID:

    \n

    \n <>ID<><>GranteesEmail<>\n \n

    \n

    \n DisplayName is optional and ignored in the request.

    \n
    • \n
  • \n

    By Email address:

    \n

    \n <>Grantees@email.com<>\n

    \n

    The grantee is resolved to the CanonicalUser and, in a\n response to a GETObjectAcl request, appears as the\n CanonicalUser.

    \n
    • \n
  • \n

    By URI:

    \n

    \n <>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<>\n

    \n
    • \n
\n
\n
\n

To enable logging, you use LoggingEnabled and its children request\n elements. To disable logging, you use an empty BucketLoggingStatus request\n element:

\n

\n \n

\n

For more information about server access logging, see Server Access Logging in the\n Amazon S3 User Guide.

\n

For more information about creating a bucket, see CreateBucket. For more\n information about returning the logging status of a bucket, see GetBucketLogging.

\n

The following operations are related to PutBucketLogging:

\n ", + "smithy.api#examples": [ + { + "title": "Set logging configuration for a bucket", + "documentation": "The following example sets logging policy on a bucket. For the Log Delivery group to deliver logs to the destination bucket, it needs permission for the READ_ACP action which the policy grants.", + "input": { + "Bucket": "sourcebucket", + "BucketLoggingStatus": { + "LoggingEnabled": { + "TargetBucket": "targetbucket", + "TargetPrefix": "MyBucketLogs/", + "TargetGrants": [ + { + "Grantee": { + "Type": "Group", + "URI": "http://acs.amazonaws.com/groups/global/AllUsers" + }, + "Permission": "READ" + } + ] + } + } + } + } + ], + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}?logging", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#PutBucketLoggingRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket for which to set the logging parameters.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "BucketLoggingStatus": { + "target": "com.amazonaws.s3#BucketLoggingStatus", + "traits": { + "smithy.api#documentation": "

Container for logging status information.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {}, + "smithy.api#xmlName": "BucketLoggingStatus" + } + }, + "ContentMD5": { + "target": "com.amazonaws.s3#ContentMD5", + "traits": { + "smithy.api#documentation": "

The MD5 hash of the PutBucketLogging request body.

\n

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

", + "smithy.api#httpHeader": "Content-MD5" + } + }, + "ChecksumAlgorithm": { + "target": "com.amazonaws.s3#ChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any\n additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or\n x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more\n information, see Checking object integrity in\n the Amazon S3 User Guide.

\n

If you provide an individual checksum, Amazon S3 ignores any provided\n ChecksumAlgorithm parameter.

", + "smithy.api#httpHeader": "x-amz-sdk-checksum-algorithm" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#PutBucketMetricsConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutBucketMetricsConfigurationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Sets a metrics configuration (specified by the metrics configuration ID) for the bucket.\n You can have up to 1,000 metrics configurations per bucket. If you're updating an existing\n metrics configuration, note that this is a full replacement of the existing metrics\n configuration. If you don't include the elements you want to keep, they are erased.

\n

To use this operation, you must have permissions to perform the\n s3:PutMetricsConfiguration action. The bucket owner has this permission by\n default. The bucket owner can grant this permission to others. For more information about\n permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.

\n

For information about CloudWatch request metrics for Amazon S3, see Monitoring\n Metrics with Amazon CloudWatch.

\n

The following operations are related to\n PutBucketMetricsConfiguration:

\n \n

\n PutBucketMetricsConfiguration has the following special error:

\n
    \n
  • \n

    Error code: TooManyConfigurations\n

    \n
      \n
    • \n

      Description: You are attempting to create a new configuration but have\n already reached the 1,000-configuration limit.

      \n
      • \n
    • \n

      HTTP Status Code: HTTP 400 Bad Request

      \n
      • \n
    \n
    • \n
", + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}?metrics", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#PutBucketMetricsConfigurationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket for which the metrics configuration is set.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "Id": { + "target": "com.amazonaws.s3#MetricsId", + "traits": { + "smithy.api#documentation": "

The ID used to identify the metrics configuration. The ID has a 64 character limit and\n can only contain letters, numbers, periods, dashes, and underscores.

", + "smithy.api#httpQuery": "id", + "smithy.api#required": {} + } + }, + "MetricsConfiguration": { + "target": "com.amazonaws.s3#MetricsConfiguration", + "traits": { + "smithy.api#documentation": "

Specifies the metrics configuration.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {}, + "smithy.api#xmlName": "MetricsConfiguration" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#PutBucketNotificationConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutBucketNotificationConfigurationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Enables notifications of specified events for a bucket. For more information about event\n notifications, see Configuring Event\n Notifications.

\n

Using this API, you can replace an existing notification configuration. The\n configuration is an XML file that defines the event types that you want Amazon S3 to publish and\n the destination where you want Amazon S3 to publish an event notification when it detects an\n event of the specified type.

\n

By default, your bucket has no event notifications configured. That is, the notification\n configuration will be an empty NotificationConfiguration.

\n

\n \n

\n

\n \n

\n

This action replaces the existing notification configuration with the configuration you\n include in the request body.

\n

After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification\n Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and\n that the bucket owner has permission to publish to it by sending a test notification. In\n the case of Lambda destinations, Amazon S3 verifies that the Lambda function permissions\n grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information,\n see Configuring Notifications for Amazon S3 Events.

\n

You can disable notifications by adding the empty NotificationConfiguration\n element.

\n

For more information about the number of event notification configurations that you can\n create per bucket, see Amazon S3 service quotas in Amazon Web Services\n General Reference.

\n

By default, only the bucket owner can configure notifications on a bucket. However,\n bucket owners can use a bucket policy to grant permission to other users to set this\n configuration with the required s3:PutBucketNotification permission.

\n \n

The PUT notification is an atomic operation. For example, suppose your notification\n configuration includes SNS topic, SQS queue, and Lambda function configurations. When\n you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS\n topic. If the message fails, the entire PUT action will fail, and Amazon S3 will not add the\n configuration to your bucket.

\n \n

If the configuration in the request body includes only one\n TopicConfiguration specifying only the\n s3:ReducedRedundancyLostObject event type, the response will also include\n the x-amz-sns-test-message-id header containing the message ID of the test\n notification sent to the topic.

\n

The following action is related to\n PutBucketNotificationConfiguration:

\n ", + "smithy.api#examples": [ + { + "title": "Set notification configuration for a bucket", + "documentation": "The following example sets notification configuration on a bucket to publish the object created events to an SNS topic.", + "input": { + "Bucket": "examplebucket", + "NotificationConfiguration": { + "TopicConfigurations": [ + { + "TopicArn": "arn:aws:sns:us-west-2:123456789012:s3-notification-topic", + "Events": [ + "s3:ObjectCreated:*" + ] + } + ] + } + } + } + ], + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}?notification", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#PutBucketNotificationConfigurationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "NotificationConfiguration": { + "target": "com.amazonaws.s3#NotificationConfiguration", + "traits": { + "smithy.api#httpPayload": {}, + "smithy.api#required": {}, + "smithy.api#xmlName": "NotificationConfiguration" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + }, + "SkipDestinationValidation": { + "target": "com.amazonaws.s3#SkipValidation", + "traits": { + "smithy.api#documentation": "

Skips validation of Amazon SQS, Amazon SNS, and Lambda\n destinations. True or false value.

", + "smithy.api#httpHeader": "x-amz-skip-destination-validation" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#PutBucketOwnershipControls": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutBucketOwnershipControlsRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "aws.protocols#httpChecksum": { + "requestChecksumRequired": true + }, + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Creates or modifies OwnershipControls for an Amazon S3 bucket. To use this\n operation, you must have the s3:PutBucketOwnershipControls permission. For\n more information about Amazon S3 permissions, see Specifying permissions in a\n policy.

\n

For information about Amazon S3 Object Ownership, see Using object\n ownership.

\n

The following operations are related to PutBucketOwnershipControls:

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}?ownershipControls", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#PutBucketOwnershipControlsRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the Amazon S3 bucket whose OwnershipControls you want to set.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ContentMD5": { + "target": "com.amazonaws.s3#ContentMD5", + "traits": { + "smithy.api#documentation": "

The MD5 hash of the OwnershipControls request body.

\n

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

", + "smithy.api#httpHeader": "Content-MD5" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + }, + "OwnershipControls": { + "target": "com.amazonaws.s3#OwnershipControls", + "traits": { + "smithy.api#documentation": "

The OwnershipControls (BucketOwnerEnforced, BucketOwnerPreferred, or\n ObjectWriter) that you want to apply to this Amazon S3 bucket.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {}, + "smithy.api#xmlName": "OwnershipControls" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#PutBucketPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutBucketPolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "aws.protocols#httpChecksum": { + "requestAlgorithmMember": "ChecksumAlgorithm", + "requestChecksumRequired": true + }, + "smithy.api#documentation": "

Applies an Amazon S3 bucket policy to an Amazon S3 bucket.

\n \n

\n Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name\n . Virtual-hosted-style requests aren't supported. \nFor more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the\n Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the\n Amazon S3 User Guide.

\n \n
\n
Permissions
\n
\n

If you are using an identity other than the root user of the Amazon Web Services account that\n owns the bucket, the calling identity must both have the\n PutBucketPolicy permissions on the specified bucket and belong to\n the bucket owner's account in order to use this operation.

\n

If you don't have PutBucketPolicy permissions, Amazon S3 returns a\n 403 Access Denied error. If you have the correct permissions, but\n you're not using an identity that belongs to the bucket owner's account, Amazon S3\n returns a 405 Method Not Allowed error.

\n \n

To ensure that bucket owners don't inadvertently lock themselves out of\n their own buckets, the root principal in a bucket owner's Amazon Web Services account can\n perform the GetBucketPolicy, PutBucketPolicy, and\n DeleteBucketPolicy API actions, even if their bucket policy\n explicitly denies the root principal's access. Bucket owner root principals can\n only be blocked from performing these API actions by VPC endpoint policies and\n Amazon Web Services Organizations policies.

\n \n
    \n
  • \n

    \n General purpose bucket permissions - The\n s3:PutBucketPolicy permission is required in a policy. For\n more information about general purpose buckets bucket policies, see Using Bucket Policies and User Policies in the\n Amazon S3 User Guide.

    \n
    • \n
  • \n

    \n Directory bucket permissions -\n To grant access to this API operation, you must have the\n s3express:PutBucketPolicy permission in\n an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource.\n For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

    \n
    • \n
\n
\n
Example bucket policies
\n
\n

\n General purpose buckets example bucket policies\n - See Bucket policy\n examples in the Amazon S3 User Guide.

\n

\n Directory bucket example bucket policies\n - See Example bucket policies for S3 Express One Zone in the\n Amazon S3 User Guide.

\n
\n
HTTP Host header syntax
\n
\n

\n Directory buckets - The HTTP Host header syntax is s3express-control.region-code.amazonaws.com.

\n
\n
\n

The following operations are related to PutBucketPolicy:

\n ", + "smithy.api#examples": [ + { + "title": "Set bucket policy", + "documentation": "The following example sets a permission policy on a bucket.", + "input": { + "Bucket": "examplebucket", + "Policy": "{\"Version\": \"2012-10-17\", \"Statement\": [{ \"Sid\": \"id-1\",\"Effect\": \"Allow\",\"Principal\": {\"AWS\": \"arn:aws:iam::123456789012:root\"}, \"Action\": [ \"s3:PutObject\",\"s3:PutObjectAcl\"], \"Resource\": [\"arn:aws:s3:::acl3/*\" ] } ]}" + } + } + ], + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}?policy", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#PutBucketPolicyRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket.

\n

\n Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name\n . Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide\n

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ContentMD5": { + "target": "com.amazonaws.s3#ContentMD5", + "traits": { + "smithy.api#documentation": "

The MD5 hash of the request body.

\n

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "Content-MD5" + } + }, + "ChecksumAlgorithm": { + "target": "com.amazonaws.s3#ChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any\n additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum-algorithm\n or\n x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request.

\n

For the x-amz-checksum-algorithm\n header, replace \n algorithm\n with the supported algorithm from the following list:

\n
    \n
  • \n

    \n CRC32\n

    \n
    • \n
  • \n

    \n CRC32C\n

    \n
    • \n
  • \n

    \n SHA1\n

    \n
    • \n
  • \n

    \n SHA256\n

    \n
    • \n
\n

For more\n information, see Checking object integrity in\n the Amazon S3 User Guide.

\n

If the individual checksum value you provide through x-amz-checksum-algorithm\n doesn't match the checksum algorithm you set through x-amz-sdk-checksum-algorithm, Amazon S3 ignores any provided\n ChecksumAlgorithm parameter and uses the checksum algorithm that matches the provided value in x-amz-checksum-algorithm\n .

\n \n

For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default checksum algorithm that's used for performance.

\n ", + "smithy.api#httpHeader": "x-amz-sdk-checksum-algorithm" + } + }, + "ConfirmRemoveSelfBucketAccess": { + "target": "com.amazonaws.s3#ConfirmRemoveSelfBucketAccess", + "traits": { + "smithy.api#documentation": "

Set this parameter to true to confirm that you want to remove your permissions to change\n this bucket policy in the future.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-confirm-remove-self-bucket-access" + } + }, + "Policy": { + "target": "com.amazonaws.s3#Policy", + "traits": { + "smithy.api#documentation": "

The bucket policy as a JSON document.

\n

For directory buckets, the only IAM action supported in the bucket policy is\n s3express:CreateSession.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

\n \n

For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code \n501 Not Implemented.

\n ", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#PutBucketReplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutBucketReplicationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "aws.protocols#httpChecksum": { + "requestAlgorithmMember": "ChecksumAlgorithm", + "requestChecksumRequired": true + }, + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Creates a replication configuration or replaces an existing one. For more information,\n see Replication in the Amazon S3 User Guide.

\n

Specify the replication configuration in the request body. In the replication\n configuration, you provide the name of the destination bucket or buckets where you want\n Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to replicate objects on your\n behalf, and other relevant information. You can invoke this request for a specific Amazon Web Services\n Region by using the \n aws:RequestedRegion\n condition key.

\n

A replication configuration must include at least one rule, and can contain a maximum of\n 1,000. Each rule identifies a subset of objects to replicate by filtering the objects in\n the source bucket. To choose additional subsets of objects to replicate, add a rule for\n each subset.

\n

To specify a subset of the objects in the source bucket to apply a replication rule to,\n add the Filter element as a child of the Rule element. You can filter objects based on an\n object key prefix, one or more object tags, or both. When you add the Filter element in the\n configuration, you must also add the following elements:\n DeleteMarkerReplication, Status, and\n Priority.

\n \n

If you are using an earlier version of the replication configuration, Amazon S3 handles\n replication of delete markers differently. For more information, see Backward Compatibility.

\n \n

For information about enabling versioning on a bucket, see Using Versioning.

\n
\n
Handling Replication of Encrypted Objects
\n
\n

By default, Amazon S3 doesn't replicate objects that are stored at rest using\n server-side encryption with KMS keys. To replicate Amazon Web Services KMS-encrypted objects,\n add the following: SourceSelectionCriteria,\n SseKmsEncryptedObjects, Status,\n EncryptionConfiguration, and ReplicaKmsKeyID. For\n information about replication configuration, see Replicating\n Objects Created with SSE Using KMS keys.

\n

For information on PutBucketReplication errors, see List of\n replication-related error codes\n

\n
\n
Permissions
\n
\n

To create a PutBucketReplication request, you must have\n s3:PutReplicationConfiguration permissions for the bucket.\n \n

\n

By default, a resource owner, in this case the Amazon Web Services account that created the\n bucket, can perform this operation. The resource owner can also grant others\n permissions to perform the operation. For more information about permissions, see\n Specifying Permissions in\n a Policy and Managing Access\n Permissions to Your Amazon S3 Resources.

\n \n

To perform this operation, the user or role performing the action must have\n the iam:PassRole\n permission.

\n \n
\n
\n

The following operations are related to PutBucketReplication:

\n ", + "smithy.api#examples": [ + { + "title": "Set replication configuration on a bucket", + "documentation": "The following example sets replication configuration on a bucket.", + "input": { + "Bucket": "examplebucket", + "ReplicationConfiguration": { + "Role": "arn:aws:iam::123456789012:role/examplerole", + "Rules": [ + { + "Prefix": "", + "Status": "Enabled", + "Destination": { + "Bucket": "arn:aws:s3:::destinationbucket", + "StorageClass": "STANDARD" + } + } + ] + } + } + } + ], + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}?replication", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#PutBucketReplicationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ContentMD5": { + "target": "com.amazonaws.s3#ContentMD5", + "traits": { + "smithy.api#documentation": "

The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message\n integrity check to verify that the request body was not corrupted in transit. For more\n information, see RFC 1864.

\n

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

", + "smithy.api#httpHeader": "Content-MD5" + } + }, + "ChecksumAlgorithm": { + "target": "com.amazonaws.s3#ChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any\n additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or\n x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more\n information, see Checking object integrity in\n the Amazon S3 User Guide.

\n

If you provide an individual checksum, Amazon S3 ignores any provided\n ChecksumAlgorithm parameter.

", + "smithy.api#httpHeader": "x-amz-sdk-checksum-algorithm" + } + }, + "ReplicationConfiguration": { + "target": "com.amazonaws.s3#ReplicationConfiguration", + "traits": { + "smithy.api#httpPayload": {}, + "smithy.api#required": {}, + "smithy.api#xmlName": "ReplicationConfiguration" + } + }, + "Token": { + "target": "com.amazonaws.s3#ObjectLockToken", + "traits": { + "smithy.api#documentation": "

A token to allow Object Lock to be enabled for an existing bucket.

", + "smithy.api#httpHeader": "x-amz-bucket-object-lock-token" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#PutBucketRequestPayment": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutBucketRequestPaymentRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "aws.protocols#httpChecksum": { + "requestAlgorithmMember": "ChecksumAlgorithm", + "requestChecksumRequired": true + }, + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Sets the request payment configuration for a bucket. By default, the bucket owner pays\n for downloads from the bucket. This configuration parameter enables the bucket owner (only)\n to specify that the person requesting the download will be charged for the download. For\n more information, see Requester Pays\n Buckets.

\n

The following operations are related to PutBucketRequestPayment:

\n ", + "smithy.api#examples": [ + { + "title": "Set request payment configuration on a bucket.", + "documentation": "The following example sets request payment configuration on a bucket so that person requesting the download is charged.", + "input": { + "Bucket": "examplebucket", + "RequestPaymentConfiguration": { + "Payer": "Requester" + } + } + } + ], + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}?requestPayment", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#PutBucketRequestPaymentRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ContentMD5": { + "target": "com.amazonaws.s3#ContentMD5", + "traits": { + "smithy.api#documentation": "

The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message\n integrity check to verify that the request body was not corrupted in transit. For more\n information, see RFC 1864.

\n

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

", + "smithy.api#httpHeader": "Content-MD5" + } + }, + "ChecksumAlgorithm": { + "target": "com.amazonaws.s3#ChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any\n additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or\n x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more\n information, see Checking object integrity in\n the Amazon S3 User Guide.

\n

If you provide an individual checksum, Amazon S3 ignores any provided\n ChecksumAlgorithm parameter.

", + "smithy.api#httpHeader": "x-amz-sdk-checksum-algorithm" + } + }, + "RequestPaymentConfiguration": { + "target": "com.amazonaws.s3#RequestPaymentConfiguration", + "traits": { + "smithy.api#documentation": "

Container for Payer.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {}, + "smithy.api#xmlName": "RequestPaymentConfiguration" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#PutBucketTagging": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutBucketTaggingRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "aws.protocols#httpChecksum": { + "requestAlgorithmMember": "ChecksumAlgorithm", + "requestChecksumRequired": true + }, + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Sets the tags for a bucket.

\n

Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this,\n sign up to get your Amazon Web Services account bill with tag key values included. Then, to see the cost\n of combined resources, organize your billing information according to resources with the\n same tag key values. For example, you can tag several resources with a specific application\n name, and then organize your billing information to see the total cost of that application\n across several services. For more information, see Cost Allocation and\n Tagging and Using Cost Allocation in Amazon S3\n Bucket Tags.

\n \n

When this operation sets the tags for a bucket, it will overwrite any current tags\n the bucket already has. You cannot use this operation to add tags to an existing list of\n tags.

\n \n

To use this operation, you must have permissions to perform the\n s3:PutBucketTagging action. The bucket owner has this permission by default\n and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.

\n

\n PutBucketTagging has the following special errors. For more Amazon S3 errors\n see, Error\n Responses.

\n
    \n
  • \n

    \n InvalidTag - The tag provided was not a valid tag. This error\n can occur if the tag did not pass input validation. For more information, see Using\n Cost Allocation in Amazon S3 Bucket Tags.

    \n
    • \n
  • \n

    \n MalformedXML - The XML provided does not match the\n schema.

    \n
    • \n
  • \n

    \n OperationAborted - A conflicting conditional action is\n currently in progress against this resource. Please try again.

    \n
    • \n
  • \n

    \n InternalError - The service was unable to apply the provided\n tag to the bucket.

    \n
    • \n
\n

The following operations are related to PutBucketTagging:

\n ", + "smithy.api#examples": [ + { + "title": "Set tags on a bucket", + "documentation": "The following example sets tags on a bucket. Any existing tags are replaced.", + "input": { + "Bucket": "examplebucket", + "Tagging": { + "TagSet": [ + { + "Key": "Key1", + "Value": "Value1" + }, + { + "Key": "Key2", + "Value": "Value2" + } + ] + } + } + } + ], + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}?tagging", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#PutBucketTaggingRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ContentMD5": { + "target": "com.amazonaws.s3#ContentMD5", + "traits": { + "smithy.api#documentation": "

The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message\n integrity check to verify that the request body was not corrupted in transit. For more\n information, see RFC 1864.

\n

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

", + "smithy.api#httpHeader": "Content-MD5" + } + }, + "ChecksumAlgorithm": { + "target": "com.amazonaws.s3#ChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any\n additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or\n x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more\n information, see Checking object integrity in\n the Amazon S3 User Guide.

\n

If you provide an individual checksum, Amazon S3 ignores any provided\n ChecksumAlgorithm parameter.

", + "smithy.api#httpHeader": "x-amz-sdk-checksum-algorithm" + } + }, + "Tagging": { + "target": "com.amazonaws.s3#Tagging", + "traits": { + "smithy.api#documentation": "

Container for the TagSet and Tag elements.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {}, + "smithy.api#xmlName": "Tagging" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#PutBucketVersioning": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutBucketVersioningRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "aws.protocols#httpChecksum": { + "requestAlgorithmMember": "ChecksumAlgorithm", + "requestChecksumRequired": true + }, + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n \n

When you enable versioning on a bucket for the first time, it might take a short\n amount of time for the change to be fully propagated. While this change is propagating,\n you may encounter intermittent HTTP 404 NoSuchKey errors for requests to\n objects created or updated after enabling versioning. We recommend that you wait for 15\n minutes after enabling versioning before issuing write operations (PUT or\n DELETE) on objects in the bucket.

\n \n

Sets the versioning state of an existing bucket.

\n

You can set the versioning state with one of the following values:

\n

\n Enabled—Enables versioning for the objects in the\n bucket. All objects added to the bucket receive a unique version ID.

\n

\n Suspended—Disables versioning for the objects in the\n bucket. All objects added to the bucket receive the version ID null.

\n

If the versioning state has never been set on a bucket, it has no versioning state; a\n GetBucketVersioning request does not return a versioning state value.

\n

In order to enable MFA Delete, you must be the bucket owner. If you are the bucket owner\n and want to enable MFA Delete in the bucket versioning configuration, you must include the\n x-amz-mfa request header and the Status and the\n MfaDelete request elements in a request to set the versioning state of the\n bucket.

\n \n

If you have an object expiration lifecycle configuration in your non-versioned bucket\n and you want to maintain the same permanent delete behavior when you enable versioning,\n you must add a noncurrent expiration policy. The noncurrent expiration lifecycle\n configuration will manage the deletes of the noncurrent object versions in the\n version-enabled bucket. (A version-enabled bucket maintains one current and zero or more\n noncurrent object versions.) For more information, see Lifecycle and Versioning.

\n \n

The following operations are related to PutBucketVersioning:

\n ", + "smithy.api#examples": [ + { + "title": "Set versioning configuration on a bucket", + "documentation": "The following example sets versioning configuration on bucket. The configuration enables versioning on the bucket.", + "input": { + "Bucket": "examplebucket", + "VersioningConfiguration": { + "MFADelete": "Disabled", + "Status": "Enabled" + } + } + } + ], + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}?versioning", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#PutBucketVersioningRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ContentMD5": { + "target": "com.amazonaws.s3#ContentMD5", + "traits": { + "smithy.api#documentation": "

>The base64-encoded 128-bit MD5 digest of the data. You must use this header as a\n message integrity check to verify that the request body was not corrupted in transit. For\n more information, see RFC\n 1864.

\n

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

", + "smithy.api#httpHeader": "Content-MD5" + } + }, + "ChecksumAlgorithm": { + "target": "com.amazonaws.s3#ChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any\n additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or\n x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more\n information, see Checking object integrity in\n the Amazon S3 User Guide.

\n

If you provide an individual checksum, Amazon S3 ignores any provided\n ChecksumAlgorithm parameter.

", + "smithy.api#httpHeader": "x-amz-sdk-checksum-algorithm" + } + }, + "MFA": { + "target": "com.amazonaws.s3#MFA", + "traits": { + "smithy.api#documentation": "

The concatenation of the authentication device's serial number, a space, and the value\n that is displayed on your authentication device.

", + "smithy.api#httpHeader": "x-amz-mfa" + } + }, + "VersioningConfiguration": { + "target": "com.amazonaws.s3#VersioningConfiguration", + "traits": { + "smithy.api#documentation": "

Container for setting the versioning state.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {}, + "smithy.api#xmlName": "VersioningConfiguration" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#PutBucketWebsite": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutBucketWebsiteRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "aws.protocols#httpChecksum": { + "requestAlgorithmMember": "ChecksumAlgorithm", + "requestChecksumRequired": true + }, + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Sets the configuration of the website that is specified in the website\n subresource. To configure a bucket as a website, you can add this subresource on the bucket\n with website configuration information such as the file name of the index document and any\n redirect rules. For more information, see Hosting Websites on Amazon S3.

\n

This PUT action requires the S3:PutBucketWebsite permission. By default,\n only the bucket owner can configure the website attached to a bucket; however, bucket\n owners can allow other users to set the website configuration by writing a bucket policy\n that grants them the S3:PutBucketWebsite permission.

\n

To redirect all website requests sent to the bucket's website endpoint, you add a\n website configuration with the following elements. Because all requests are sent to another\n website, you don't need to provide index document name for the bucket.

\n
    \n
  • \n

    \n WebsiteConfiguration\n

    \n
    • \n
  • \n

    \n RedirectAllRequestsTo\n

    \n
    • \n
  • \n

    \n HostName\n

    \n
    • \n
  • \n

    \n Protocol\n

    \n
    • \n
\n

If you want granular control over redirects, you can use the following elements to add\n routing rules that describe conditions for redirecting requests and information about the\n redirect destination. In this case, the website configuration must provide an index\n document for the bucket, because some requests might not be redirected.

\n
    \n
  • \n

    \n WebsiteConfiguration\n

    \n
    • \n
  • \n

    \n IndexDocument\n

    \n
    • \n
  • \n

    \n Suffix\n

    \n
    • \n
  • \n

    \n ErrorDocument\n

    \n
    • \n
  • \n

    \n Key\n

    \n
    • \n
  • \n

    \n RoutingRules\n

    \n
    • \n
  • \n

    \n RoutingRule\n

    \n
    • \n
  • \n

    \n Condition\n

    \n
    • \n
  • \n

    \n HttpErrorCodeReturnedEquals\n

    \n
    • \n
  • \n

    \n KeyPrefixEquals\n

    \n
    • \n
  • \n

    \n Redirect\n

    \n
    • \n
  • \n

    \n Protocol\n

    \n
    • \n
  • \n

    \n HostName\n

    \n
    • \n
  • \n

    \n ReplaceKeyPrefixWith\n

    \n
    • \n
  • \n

    \n ReplaceKeyWith\n

    \n
    • \n
  • \n

    \n HttpRedirectCode\n

    \n
    • \n
\n

Amazon S3 has a limitation of 50 routing rules per website configuration. If you require more\n than 50 routing rules, you can use object redirect. For more information, see Configuring an\n Object Redirect in the Amazon S3 User Guide.

\n

The maximum request length is limited to 128 KB.

", + "smithy.api#examples": [ + { + "title": "Set website configuration on a bucket", + "documentation": "The following example adds website configuration to a bucket.", + "input": { + "Bucket": "examplebucket", + "ContentMD5": "", + "WebsiteConfiguration": { + "IndexDocument": { + "Suffix": "index.html" + }, + "ErrorDocument": { + "Key": "error.html" + } + } + } + } + ], + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}?website", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#PutBucketWebsiteRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ContentMD5": { + "target": "com.amazonaws.s3#ContentMD5", + "traits": { + "smithy.api#documentation": "

The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message\n integrity check to verify that the request body was not corrupted in transit. For more\n information, see RFC 1864.

\n

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

", + "smithy.api#httpHeader": "Content-MD5" + } + }, + "ChecksumAlgorithm": { + "target": "com.amazonaws.s3#ChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any\n additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or\n x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more\n information, see Checking object integrity in\n the Amazon S3 User Guide.

\n

If you provide an individual checksum, Amazon S3 ignores any provided\n ChecksumAlgorithm parameter.

", + "smithy.api#httpHeader": "x-amz-sdk-checksum-algorithm" + } + }, + "WebsiteConfiguration": { + "target": "com.amazonaws.s3#WebsiteConfiguration", + "traits": { + "smithy.api#documentation": "

Container for the request.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {}, + "smithy.api#xmlName": "WebsiteConfiguration" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#PutObject": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutObjectRequest" + }, + "output": { + "target": "com.amazonaws.s3#PutObjectOutput" + }, + "errors": [ + { + "target": "com.amazonaws.s3#EncryptionTypeMismatch" + }, + { + "target": "com.amazonaws.s3#InvalidRequest" + }, + { + "target": "com.amazonaws.s3#InvalidWriteOffset" + }, + { + "target": "com.amazonaws.s3#TooManyParts" + } + ], + "traits": { + "aws.protocols#httpChecksum": { + "requestAlgorithmMember": "ChecksumAlgorithm" + }, + "smithy.api#documentation": "

Adds an object to a bucket.

\n \n
    \n
  • \n

    Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added\n the entire object to the bucket. You cannot use PutObject to only\n update a single piece of metadata for an existing object. You must put the entire\n object with updated metadata if you want to update some values.

    \n
    • \n
  • \n

    If your bucket uses the bucket owner enforced setting for Object Ownership,\n ACLs are disabled and no longer affect permissions. All objects written to the\n bucket by any account will be owned by the bucket owner.

    \n
    • \n
  • \n

    \n Directory buckets -\n For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket-name.s3express-zone-id.region-code.amazonaws.com/key-name\n . Path-style requests are not supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the\n Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the\n Amazon S3 User Guide.

    \n
    • \n
\n \n

Amazon S3 is a distributed system. If it receives multiple write requests for the same object\n simultaneously, it overwrites all but the last object written. However, Amazon S3 provides\n features that can modify this behavior:

\n
    \n
  • \n

    \n S3 Object Lock - To prevent objects from\n being deleted or overwritten, you can use Amazon S3 Object\n Lock in the Amazon S3 User Guide.

    \n \n

    This functionality is not supported for directory buckets.

    \n     \n
    • \n
  • \n

    \n S3 Versioning - When you enable versioning\n for a bucket, if Amazon S3 receives multiple write requests for the same object\n simultaneously, it stores all versions of the objects. For each write request that is\n made to the same object, Amazon S3 automatically generates a unique version ID of that\n object being stored in Amazon S3. You can retrieve, replace, or delete any version of the\n object. For more information about versioning, see Adding\n Objects to Versioning-Enabled Buckets in the Amazon S3 User\n Guide. For information about returning the versioning state of a\n bucket, see GetBucketVersioning.

    \n \n

    This functionality is not supported for directory buckets.

    \n     \n
    • \n
\n
\n
Permissions
\n
\n
    \n
  • \n

    \n General purpose bucket permissions - The\n following permissions are required in your policies when your\n PutObject request includes specific headers.

    \n
      \n
    • \n

      \n \n s3:PutObject\n -\n To successfully complete the PutObject request, you must\n always have the s3:PutObject permission on a bucket to\n add an object to it.

      \n
      • \n
    • \n

      \n \n s3:PutObjectAcl\n - To successfully change the objects ACL of your\n PutObject request, you must have the\n s3:PutObjectAcl.

      \n
      • \n
    • \n

      \n \n s3:PutObjectTagging\n - To successfully set the tag-set with your\n PutObject request, you must have the\n s3:PutObjectTagging.

      \n
      • \n
    \n
    • \n
  • \n

    \n Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the \n CreateSession\n API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. \nAmazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see \n CreateSession\n .

    \n

    If the object is encrypted with SSE-KMS, you must also have the\n kms:GenerateDataKey and kms:Decrypt permissions\n in IAM identity-based policies and KMS key policies for the KMS\n key.

    \n
    • \n
\n
\n
Data integrity with Content-MD5
\n
\n
    \n
  • \n

    \n General purpose bucket - To ensure that\n data is not corrupted traversing the network, use the\n Content-MD5 header. When you use this header, Amazon S3 checks\n the object against the provided MD5 value and, if they do not match, Amazon S3\n returns an error. Alternatively, when the object's ETag is its MD5 digest,\n you can calculate the MD5 while putting the object to Amazon S3 and compare the\n returned ETag to the calculated MD5 value.

    \n
    • \n
  • \n

    \n Directory bucket -\n This functionality is not supported for directory buckets.

    \n
    • \n
\n
\n
HTTP Host header syntax
\n
\n

\n Directory buckets - The HTTP Host header syntax is \n Bucket-name.s3express-zone-id.region-code.amazonaws.com.

\n
\n
\n

For more information about related Amazon S3 APIs, see the following:

\n ", + "smithy.api#examples": [ + { + "title": "To create an object.", + "documentation": "The following example creates an object. If the bucket is versioning enabled, S3 returns version ID in response.", + "input": { + "Body": "filetoupload", + "Bucket": "examplebucket", + "Key": "objectkey" + }, + "output": { + "VersionId": "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ", + "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"" + } + }, + { + "title": "To upload an object (specify optional headers)", + "documentation": "The following example uploads an object. The request specifies optional request headers to directs S3 to use specific storage class and use server-side encryption.", + "input": { + "Body": "HappyFace.jpg", + "Bucket": "examplebucket", + "Key": "HappyFace.jpg", + "ServerSideEncryption": "AES256", + "StorageClass": "STANDARD_IA" + }, + "output": { + "VersionId": "CG612hodqujkf8FaaNfp8U..FIhLROcp", + "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", + "ServerSideEncryption": "AES256" + } + }, + { + "title": "To upload an object", + "documentation": "The following example uploads an object to a versioning-enabled bucket. The source file is specified using Windows file syntax. S3 returns VersionId of the newly created object.", + "input": { + "Body": "HappyFace.jpg", + "Bucket": "examplebucket", + "Key": "HappyFace.jpg" + }, + "output": { + "VersionId": "tpf3zF08nBplQK1XLOefGskR7mGDwcDk", + "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"" + } + }, + { + "title": "To upload an object and specify canned ACL.", + "documentation": "The following example uploads and object. The request specifies optional canned ACL (access control list) to all READ access to authenticated users. If the bucket is versioning enabled, S3 returns version ID in response.", + "input": { + "ACL": "authenticated-read", + "Body": "filetoupload", + "Bucket": "examplebucket", + "Key": "exampleobject" + }, + "output": { + "VersionId": "Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr", + "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"" + } + }, + { + "title": "To upload an object and specify optional tags", + "documentation": "The following example uploads an object. The request specifies optional object tags. The bucket is versioned, therefore S3 returns version ID of the newly created object.", + "input": { + "Body": "c:\\HappyFace.jpg", + "Bucket": "examplebucket", + "Key": "HappyFace.jpg", + "Tagging": "key1=value1&key2=value2" + }, + "output": { + "VersionId": "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a", + "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"" + } + }, + { + "title": "To upload an object and specify server-side encryption and object tags", + "documentation": "The following example uploads an object. The request specifies the optional server-side encryption option. The request also specifies optional object tags. If the bucket is versioning enabled, S3 returns version ID in response.", + "input": { + "Body": "filetoupload", + "Bucket": "examplebucket", + "Key": "exampleobject", + "ServerSideEncryption": "AES256", + "Tagging": "key1=value1&key2=value2" + }, + "output": { + "VersionId": "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt", + "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", + "ServerSideEncryption": "AES256" + } + }, + { + "title": "To upload object and specify user-defined metadata", + "documentation": "The following example creates an object. The request also specifies optional metadata. If the bucket is versioning enabled, S3 returns version ID in response.", + "input": { + "Body": "filetoupload", + "Bucket": "examplebucket", + "Key": "exampleobject", + "Metadata": { + "metadata1": "value1", + "metadata2": "value2" + } + }, + "output": { + "VersionId": "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0", + "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"" + } + } + ], + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}/{Key+}?x-id=PutObject", + "code": 200 + } + } + }, + "com.amazonaws.s3#PutObjectAcl": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutObjectAclRequest" + }, + "output": { + "target": "com.amazonaws.s3#PutObjectAclOutput" + }, + "errors": [ + { + "target": "com.amazonaws.s3#NoSuchKey" + } + ], + "traits": { + "aws.protocols#httpChecksum": { + "requestAlgorithmMember": "ChecksumAlgorithm", + "requestChecksumRequired": true + }, + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Uses the acl subresource to set the access control list (ACL) permissions\n for a new or existing object in an S3 bucket. You must have the WRITE_ACP\n permission to set the ACL of an object. For more information, see What\n permissions can I grant? in the Amazon S3 User Guide.

\n

This functionality is not supported for Amazon S3 on Outposts.

\n

Depending on your application needs, you can choose to set the ACL on an object using\n either the request body or the headers. For example, if you have an existing application\n that updates a bucket ACL using the request body, you can continue to use that approach.\n For more information, see Access Control List (ACL) Overview\n in the Amazon S3 User Guide.

\n \n

If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs\n are disabled and no longer affect permissions. You must use policies to grant access to\n your bucket and the objects in it. Requests to set ACLs or update ACLs fail and return\n the AccessControlListNotSupported error code. Requests to read ACLs are\n still supported. For more information, see Controlling object\n ownership in the Amazon S3 User Guide.

\n \n
\n
Permissions
\n
\n

You can set access permissions using one of the following methods:

\n
    \n
  • \n

    Specify a canned ACL with the x-amz-acl request header. Amazon S3\n supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has\n a predefined set of grantees and permissions. Specify the canned ACL name as\n the value of x-amz-acl. If you use this header, you cannot use\n other access control-specific headers in your request. For more information,\n see Canned\n ACL.

    \n
    • \n
  • \n

    Specify access permissions explicitly with the\n x-amz-grant-read, x-amz-grant-read-acp,\n x-amz-grant-write-acp, and\n x-amz-grant-full-control headers. When using these headers,\n you specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3\n groups) who will receive the permission. If you use these ACL-specific\n headers, you cannot use x-amz-acl header to set a canned ACL.\n These parameters map to the set of permissions that Amazon S3 supports in an ACL.\n For more information, see Access Control List (ACL)\n Overview.

    \n

    You specify each grantee as a type=value pair, where the type is one of\n the following:

    \n
      \n
    • \n

      \n id – if the value specified is the canonical user ID\n of an Amazon Web Services account

      \n
      • \n
    • \n

      \n uri – if you are granting permissions to a predefined\n group

      \n
      • \n
    • \n

      \n emailAddress – if the value specified is the email\n address of an Amazon Web Services account

      \n \n

      Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

      \n
        \n
      • \n

        US East (N. Virginia)

        \n
        • \n
      • \n

        US West (N. California)

        \n
        • \n
      • \n

        US West (Oregon)

        \n
        • \n
      • \n

        Asia Pacific (Singapore)

        \n
        • \n
      • \n

        Asia Pacific (Sydney)

        \n
        • \n
      • \n

        Asia Pacific (Tokyo)

        \n
        • \n
      • \n

        Europe (Ireland)

        \n
        • \n
      • \n

        South America (São Paulo)

        \n
        • \n
      \n

      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

      \n       \n
      • \n
    \n

    For example, the following x-amz-grant-read header grants\n list objects permission to the two Amazon Web Services accounts identified by their email\n addresses.

    \n

    \n x-amz-grant-read: emailAddress=\"xyz@amazon.com\",\n emailAddress=\"abc@amazon.com\" \n

    \n
    • \n
\n

You can use either a canned ACL or specify access permissions explicitly. You\n cannot do both.

\n
\n
Grantee Values
\n
\n

You can specify the person (grantee) to whom you're assigning access rights\n (using request elements) in the following ways:

\n
    \n
  • \n

    By the person's ID:

    \n

    \n <>ID<><>GranteesEmail<>\n \n

    \n

    DisplayName is optional and ignored in the request.

    \n
    • \n
  • \n

    By URI:

    \n

    \n <>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<>\n

    \n
    • \n
  • \n

    By Email address:

    \n

    \n <>Grantees@email.com<>lt;/Grantee>\n

    \n

    The grantee is resolved to the CanonicalUser and, in a response to a GET\n Object acl request, appears as the CanonicalUser.

    \n \n

    Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

    \n
      \n
    • \n

      US East (N. Virginia)

      \n
      • \n
    • \n

      US West (N. California)

      \n
      • \n
    • \n

      US West (Oregon)

      \n
      • \n
    • \n

      Asia Pacific (Singapore)

      \n
      • \n
    • \n

      Asia Pacific (Sydney)

      \n
      • \n
    • \n

      Asia Pacific (Tokyo)

      \n
      • \n
    • \n

      Europe (Ireland)

      \n
      • \n
    • \n

      South America (São Paulo)

      \n
      • \n
    \n

    For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

    \n     \n
    • \n
\n
\n
Versioning
\n
\n

The ACL of an object is set at the object version level. By default, PUT sets\n the ACL of the current version of an object. To set the ACL of a different\n version, use the versionId subresource.

\n
\n
\n

The following operations are related to PutObjectAcl:

\n ", + "smithy.api#examples": [ + { + "title": "To grant permissions using object ACL", + "documentation": "The following example adds grants to an object ACL. The first permission grants user1 and user2 FULL_CONTROL and the AllUsers group READ permission.", + "input": { + "AccessControlPolicy": {}, + "Bucket": "examplebucket", + "GrantFullControl": "emailaddress=user1@example.com,emailaddress=user2@example.com", + "GrantRead": "uri=http://acs.amazonaws.com/groups/global/AllUsers", + "Key": "HappyFace.jpg" + }, + "output": {} + } + ], + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}/{Key+}?acl", + "code": 200 + } + } + }, + "com.amazonaws.s3#PutObjectAclOutput": { + "type": "structure", + "members": { + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3#PutObjectAclRequest": { + "type": "structure", + "members": { + "ACL": { + "target": "com.amazonaws.s3#ObjectCannedACL", + "traits": { + "smithy.api#documentation": "

The canned ACL to apply to the object. For more information, see Canned\n ACL.

", + "smithy.api#httpHeader": "x-amz-acl" + } + }, + "AccessControlPolicy": { + "target": "com.amazonaws.s3#AccessControlPolicy", + "traits": { + "smithy.api#documentation": "

Contains the elements that set the ACL permissions for an object per grantee.

", + "smithy.api#httpPayload": {}, + "smithy.api#xmlName": "AccessControlPolicy" + } + }, + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name that contains the object to which you want to attach the ACL.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

\n S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ContentMD5": { + "target": "com.amazonaws.s3#ContentMD5", + "traits": { + "smithy.api#documentation": "

The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message\n integrity check to verify that the request body was not corrupted in transit. For more\n information, go to RFC\n 1864.>\n

\n

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

", + "smithy.api#httpHeader": "Content-MD5" + } + }, + "ChecksumAlgorithm": { + "target": "com.amazonaws.s3#ChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any\n additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or\n x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more\n information, see Checking object integrity in\n the Amazon S3 User Guide.

\n

If you provide an individual checksum, Amazon S3 ignores any provided\n ChecksumAlgorithm parameter.

", + "smithy.api#httpHeader": "x-amz-sdk-checksum-algorithm" + } + }, + "GrantFullControl": { + "target": "com.amazonaws.s3#GrantFullControl", + "traits": { + "smithy.api#documentation": "

Allows grantee the read, write, read ACP, and write ACP permissions on the\n bucket.

\n

This functionality is not supported for Amazon S3 on Outposts.

", + "smithy.api#httpHeader": "x-amz-grant-full-control" + } + }, + "GrantRead": { + "target": "com.amazonaws.s3#GrantRead", + "traits": { + "smithy.api#documentation": "

Allows grantee to list the objects in the bucket.

\n

This functionality is not supported for Amazon S3 on Outposts.

", + "smithy.api#httpHeader": "x-amz-grant-read" + } + }, + "GrantReadACP": { + "target": "com.amazonaws.s3#GrantReadACP", + "traits": { + "smithy.api#documentation": "

Allows grantee to read the bucket ACL.

\n

This functionality is not supported for Amazon S3 on Outposts.

", + "smithy.api#httpHeader": "x-amz-grant-read-acp" + } + }, + "GrantWrite": { + "target": "com.amazonaws.s3#GrantWrite", + "traits": { + "smithy.api#documentation": "

Allows grantee to create new objects in the bucket.

\n

For the bucket and object owners of existing objects, also allows deletions and\n overwrites of those objects.

", + "smithy.api#httpHeader": "x-amz-grant-write" + } + }, + "GrantWriteACP": { + "target": "com.amazonaws.s3#GrantWriteACP", + "traits": { + "smithy.api#documentation": "

Allows grantee to write the ACL for the applicable bucket.

\n

This functionality is not supported for Amazon S3 on Outposts.

", + "smithy.api#httpHeader": "x-amz-grant-write-acp" + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

Key for which the PUT action was initiated.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Key" + } + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

Version ID used to reference a specific version of the object.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpQuery": "versionId" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#PutObjectLegalHold": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutObjectLegalHoldRequest" + }, + "output": { + "target": "com.amazonaws.s3#PutObjectLegalHoldOutput" + }, + "traits": { + "aws.protocols#httpChecksum": { + "requestAlgorithmMember": "ChecksumAlgorithm", + "requestChecksumRequired": true + }, + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Applies a legal hold configuration to the specified object. For more information, see\n Locking\n Objects.

\n

This functionality is not supported for Amazon S3 on Outposts.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}/{Key+}?legal-hold", + "code": 200 + } + } + }, + "com.amazonaws.s3#PutObjectLegalHoldOutput": { + "type": "structure", + "members": { + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3#PutObjectLegalHoldRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name containing the object that you want to place a legal hold on.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

The key name for the object that you want to place a legal hold on.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LegalHold": { + "target": "com.amazonaws.s3#ObjectLockLegalHold", + "traits": { + "smithy.api#documentation": "

Container element for the legal hold configuration you want to apply to the specified\n object.

", + "smithy.api#httpPayload": {}, + "smithy.api#xmlName": "LegalHold" + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

The version ID of the object that you want to place a legal hold on.

", + "smithy.api#httpQuery": "versionId" + } + }, + "ContentMD5": { + "target": "com.amazonaws.s3#ContentMD5", + "traits": { + "smithy.api#documentation": "

The MD5 hash for the request body.

\n

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

", + "smithy.api#httpHeader": "Content-MD5" + } + }, + "ChecksumAlgorithm": { + "target": "com.amazonaws.s3#ChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any\n additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or\n x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more\n information, see Checking object integrity in\n the Amazon S3 User Guide.

\n

If you provide an individual checksum, Amazon S3 ignores any provided\n ChecksumAlgorithm parameter.

", + "smithy.api#httpHeader": "x-amz-sdk-checksum-algorithm" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#PutObjectLockConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutObjectLockConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.s3#PutObjectLockConfigurationOutput" + }, + "traits": { + "aws.protocols#httpChecksum": { + "requestAlgorithmMember": "ChecksumAlgorithm", + "requestChecksumRequired": true + }, + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Places an Object Lock configuration on the specified bucket. The rule specified in the\n Object Lock configuration will be applied by default to every new object placed in the\n specified bucket. For more information, see Locking Objects.

\n \n
    \n
  • \n

    The DefaultRetention settings require both a mode and a\n period.

    \n
    • \n
  • \n

    The DefaultRetention period can be either Days or\n Years but you must select one. You cannot specify\n Days and Years at the same time.

    \n
    • \n
  • \n

    You can enable Object Lock for new or existing buckets. For more information,\n see Configuring Object\n Lock.

    \n
    • \n
\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}?object-lock", + "code": 200 + } + } + }, + "com.amazonaws.s3#PutObjectLockConfigurationOutput": { + "type": "structure", + "members": { + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3#PutObjectLockConfigurationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket whose Object Lock configuration you want to create or replace.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ObjectLockConfiguration": { + "target": "com.amazonaws.s3#ObjectLockConfiguration", + "traits": { + "smithy.api#documentation": "

The Object Lock configuration that you want to apply to the specified bucket.

", + "smithy.api#httpPayload": {}, + "smithy.api#xmlName": "ObjectLockConfiguration" + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "Token": { + "target": "com.amazonaws.s3#ObjectLockToken", + "traits": { + "smithy.api#documentation": "

A token to allow Object Lock to be enabled for an existing bucket.

", + "smithy.api#httpHeader": "x-amz-bucket-object-lock-token" + } + }, + "ContentMD5": { + "target": "com.amazonaws.s3#ContentMD5", + "traits": { + "smithy.api#documentation": "

The MD5 hash for the request body.

\n

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

", + "smithy.api#httpHeader": "Content-MD5" + } + }, + "ChecksumAlgorithm": { + "target": "com.amazonaws.s3#ChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any\n additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or\n x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more\n information, see Checking object integrity in\n the Amazon S3 User Guide.

\n

If you provide an individual checksum, Amazon S3 ignores any provided\n ChecksumAlgorithm parameter.

", + "smithy.api#httpHeader": "x-amz-sdk-checksum-algorithm" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#PutObjectOutput": { + "type": "structure", + "members": { + "Expiration": { + "target": "com.amazonaws.s3#Expiration", + "traits": { + "smithy.api#documentation": "

If the expiration is configured for the object (see PutBucketLifecycleConfiguration) in the Amazon S3 User Guide,\n the response includes this header. It includes the expiry-date and\n rule-id key-value pairs that provide information about object expiration.\n The value of the rule-id is URL-encoded.

\n \n

Object expiration information is not returned in directory buckets and this header returns the value \"NotImplemented\" in all responses for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-expiration" + } + }, + "ETag": { + "target": "com.amazonaws.s3#ETag", + "traits": { + "smithy.api#documentation": "

Entity tag for the uploaded object.

\n

\n General purpose buckets - To ensure that data is not\n corrupted traversing the network, for objects where the ETag is the MD5 digest of the\n object, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned\n ETag to the calculated MD5 value.

\n

\n Directory buckets - The ETag for the object in\n a directory bucket isn't the MD5 digest of the object.

", + "smithy.api#httpHeader": "ETag" + } + }, + "ChecksumCRC32": { + "target": "com.amazonaws.s3#ChecksumCRC32", + "traits": { + "smithy.api#documentation": "

The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

", + "smithy.api#httpHeader": "x-amz-checksum-crc32" + } + }, + "ChecksumCRC32C": { + "target": "com.amazonaws.s3#ChecksumCRC32C", + "traits": { + "smithy.api#documentation": "

The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

", + "smithy.api#httpHeader": "x-amz-checksum-crc32c" + } + }, + "ChecksumSHA1": { + "target": "com.amazonaws.s3#ChecksumSHA1", + "traits": { + "smithy.api#documentation": "

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded\n with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

", + "smithy.api#httpHeader": "x-amz-checksum-sha1" + } + }, + "ChecksumSHA256": { + "target": "com.amazonaws.s3#ChecksumSHA256", + "traits": { + "smithy.api#documentation": "

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

", + "smithy.api#httpHeader": "x-amz-checksum-sha256" + } + }, + "ServerSideEncryption": { + "target": "com.amazonaws.s3#ServerSideEncryption", + "traits": { + "smithy.api#documentation": "

The server-side encryption algorithm used when you store this object in Amazon S3.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption" + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

Version ID of the object.

\n

If you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID\n for the object being stored. Amazon S3 returns this ID in the response. When you enable\n versioning for a bucket, if Amazon S3 receives multiple write requests for the same object\n simultaneously, it stores all of the objects. For more information about versioning, see\n Adding Objects to\n Versioning-Enabled Buckets in the Amazon S3 User Guide. For\n information about returning the versioning state of a bucket, see GetBucketVersioning.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-version-id" + } + }, + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "traits": { + "smithy.api#documentation": "

If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to confirm the encryption algorithm that's used.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + } + }, + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "traits": { + "smithy.api#documentation": "

If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to provide the round-trip message integrity verification\n of the customer-provided encryption key.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" + } + }, + "SSEKMSKeyId": { + "target": "com.amazonaws.s3#SSEKMSKeyId", + "traits": { + "smithy.api#documentation": "

If present, indicates the ID of the KMS key that was used for object encryption.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" + } + }, + "SSEKMSEncryptionContext": { + "target": "com.amazonaws.s3#SSEKMSEncryptionContext", + "traits": { + "smithy.api#documentation": "

If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption. The value of\n this header is a Base64-encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs. \n This value is stored as object metadata and automatically gets\n passed on to Amazon Web Services KMS for future GetObject \n operations on this object.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-context" + } + }, + "BucketKeyEnabled": { + "target": "com.amazonaws.s3#BucketKeyEnabled", + "traits": { + "smithy.api#documentation": "

Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption\n with Key Management Service (KMS) keys (SSE-KMS).

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" + } + }, + "Size": { + "target": "com.amazonaws.s3#Size", + "traits": { + "smithy.api#documentation": "

\n The size of the object in bytes. This will only be present if you append to an object.\n

\n \n

This functionality is only supported for objects in the Amazon S3 Express One Zone storage class in directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-object-size" + } + }, + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3#PutObjectRequest": { + "type": "structure", + "members": { + "ACL": { + "target": "com.amazonaws.s3#ObjectCannedACL", + "traits": { + "smithy.api#documentation": "

The canned ACL to apply to the object. For more information, see Canned\n ACL in the Amazon S3 User Guide.

\n

When adding a new object, you can use headers to grant ACL-based permissions to\n individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are\n then added to the ACL on the object. By default, all objects are private. Only the owner\n has full access control. For more information, see Access Control List (ACL) Overview\n and Managing\n ACLs Using the REST API in the Amazon S3 User Guide.

\n

If the bucket that you're uploading objects to uses the bucket owner enforced setting\n for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that\n use this setting only accept PUT requests that don't specify an ACL or PUT requests that\n specify bucket owner full control ACLs, such as the bucket-owner-full-control\n canned ACL or an equivalent form of this ACL expressed in the XML format. PUT requests that\n contain other ACLs (for example, custom grants to certain Amazon Web Services accounts) fail and return a\n 400 error with the error code AccessControlListNotSupported.\n For more information, see Controlling ownership of\n objects and disabling ACLs in the Amazon S3 User Guide.

\n \n
    \n
  • \n

    This functionality is not supported for directory buckets.

    \n
    • \n
  • \n

    This functionality is not supported for Amazon S3 on Outposts.

    \n
    • \n
\n ", + "smithy.api#httpHeader": "x-amz-acl" + } + }, + "Body": { + "target": "com.amazonaws.s3#StreamingBlob", + "traits": { + "smithy.api#default": "", + "smithy.api#documentation": "

Object data.

", + "smithy.api#httpPayload": {} + } + }, + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name to which the PUT action was initiated.

\n

\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n \n

Access points and Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "CacheControl": { + "target": "com.amazonaws.s3#CacheControl", + "traits": { + "smithy.api#documentation": "

Can be used to specify caching behavior along the request/reply chain. For more\n information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.

", + "smithy.api#httpHeader": "Cache-Control" + } + }, + "ContentDisposition": { + "target": "com.amazonaws.s3#ContentDisposition", + "traits": { + "smithy.api#documentation": "

Specifies presentational information for the object. For more information, see https://www.rfc-editor.org/rfc/rfc6266#section-4.

", + "smithy.api#httpHeader": "Content-Disposition" + } + }, + "ContentEncoding": { + "target": "com.amazonaws.s3#ContentEncoding", + "traits": { + "smithy.api#documentation": "

Specifies what content encodings have been applied to the object and thus what decoding\n mechanisms must be applied to obtain the media-type referenced by the Content-Type header\n field. For more information, see https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding.

", + "smithy.api#httpHeader": "Content-Encoding" + } + }, + "ContentLanguage": { + "target": "com.amazonaws.s3#ContentLanguage", + "traits": { + "smithy.api#documentation": "

The language the content is in.

", + "smithy.api#httpHeader": "Content-Language" + } + }, + "ContentLength": { + "target": "com.amazonaws.s3#ContentLength", + "traits": { + "smithy.api#documentation": "

Size of the body in bytes. This parameter is useful when the size of the body cannot be\n determined automatically. For more information, see https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length.

", + "smithy.api#httpHeader": "Content-Length" + } + }, + "ContentMD5": { + "target": "com.amazonaws.s3#ContentMD5", + "traits": { + "smithy.api#documentation": "

The base64-encoded 128-bit MD5 digest of the message (without the headers) according to\n RFC 1864. This header can be used as a message integrity check to verify that the data is\n the same data that was originally sent. Although it is optional, we recommend using the\n Content-MD5 mechanism as an end-to-end integrity check. For more information about REST\n request authentication, see REST Authentication.

\n \n

The Content-MD5 or x-amz-sdk-checksum-algorithm header is\n required for any request to upload an object with a retention period configured using\n Amazon S3 Object Lock. For more information, see Uploading objects to an Object Lock enabled bucket in the\n Amazon S3 User Guide.

\n \n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "Content-MD5" + } + }, + "ContentType": { + "target": "com.amazonaws.s3#ContentType", + "traits": { + "smithy.api#documentation": "

A standard MIME type describing the format of the contents. For more information, see\n https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type.

", + "smithy.api#httpHeader": "Content-Type" + } + }, + "ChecksumAlgorithm": { + "target": "com.amazonaws.s3#ChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any\n additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum-algorithm\n or\n x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request.

\n

For the x-amz-checksum-algorithm\n header, replace \n algorithm\n with the supported algorithm from the following list:

\n
    \n
  • \n

    \n CRC32\n

    \n
    • \n
  • \n

    \n CRC32C\n

    \n
    • \n
  • \n

    \n SHA1\n

    \n
    • \n
  • \n

    \n SHA256\n

    \n
    • \n
\n

For more\n information, see Checking object integrity in\n the Amazon S3 User Guide.

\n

If the individual checksum value you provide through x-amz-checksum-algorithm\n doesn't match the checksum algorithm you set through x-amz-sdk-checksum-algorithm, Amazon S3 ignores any provided\n ChecksumAlgorithm parameter and uses the checksum algorithm that matches the provided value in x-amz-checksum-algorithm\n .

\n \n

The Content-MD5 or x-amz-sdk-checksum-algorithm header is\n required for any request to upload an object with a retention period configured using\n Amazon S3 Object Lock. For more information, see Uploading objects to an Object Lock enabled bucket in the\n Amazon S3 User Guide.

\n \n

For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default checksum algorithm that's used for performance.

", + "smithy.api#httpHeader": "x-amz-sdk-checksum-algorithm" + } + }, + "ChecksumCRC32": { + "target": "com.amazonaws.s3#ChecksumCRC32", + "traits": { + "smithy.api#documentation": "

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.\n This header specifies the base64-encoded, 32-bit CRC-32 checksum of the object. For more information, see\n Checking object integrity in the\n Amazon S3 User Guide.

", + "smithy.api#httpHeader": "x-amz-checksum-crc32" + } + }, + "ChecksumCRC32C": { + "target": "com.amazonaws.s3#ChecksumCRC32C", + "traits": { + "smithy.api#documentation": "

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.\n This header specifies the base64-encoded, 32-bit CRC-32C checksum of the object. For more information, see\n Checking object integrity in the\n Amazon S3 User Guide.

", + "smithy.api#httpHeader": "x-amz-checksum-crc32c" + } + }, + "ChecksumSHA1": { + "target": "com.amazonaws.s3#ChecksumSHA1", + "traits": { + "smithy.api#documentation": "

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.\n This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see\n Checking object integrity in the\n Amazon S3 User Guide.

", + "smithy.api#httpHeader": "x-amz-checksum-sha1" + } + }, + "ChecksumSHA256": { + "target": "com.amazonaws.s3#ChecksumSHA256", + "traits": { + "smithy.api#documentation": "

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.\n This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see\n Checking object integrity in the\n Amazon S3 User Guide.

", + "smithy.api#httpHeader": "x-amz-checksum-sha256" + } + }, + "Expires": { + "target": "com.amazonaws.s3#Expires", + "traits": { + "smithy.api#documentation": "

The date and time at which the object is no longer cacheable. For more information, see\n https://www.rfc-editor.org/rfc/rfc7234#section-5.3.

", + "smithy.api#httpHeader": "Expires" + } + }, + "IfMatch": { + "target": "com.amazonaws.s3#IfMatch", + "traits": { + "smithy.api#documentation": "

Uploads the object only if the ETag (entity tag) value provided during the WRITE\n operation matches the ETag of the object in S3. If the ETag values do not match, the\n operation returns a 412 Precondition Failed error.

\n

If a conflicting operation occurs during the upload S3 returns a 409 ConditionalRequestConflict response. On a 409 failure you should fetch the object's ETag and retry the upload.

\n

Expects the ETag value as a string.

\n

For more information about conditional requests, see RFC 7232, or Conditional requests in the Amazon S3 User Guide.

", + "smithy.api#httpHeader": "If-Match" + } + }, + "IfNoneMatch": { + "target": "com.amazonaws.s3#IfNoneMatch", + "traits": { + "smithy.api#documentation": "

Uploads the object only if the object key name does not already exist in the bucket\n specified. Otherwise, Amazon S3 returns a 412 Precondition Failed error.

\n

If a conflicting operation occurs during the upload S3 returns a 409\n ConditionalRequestConflict response. On a 409 failure you should retry the\n upload.

\n

Expects the '*' (asterisk) character.

\n

For more information about conditional requests, see RFC 7232, or Conditional requests in the Amazon S3 User Guide.

", + "smithy.api#httpHeader": "If-None-Match" + } + }, + "GrantFullControl": { + "target": "com.amazonaws.s3#GrantFullControl", + "traits": { + "smithy.api#documentation": "

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

\n \n
    \n
  • \n

    This functionality is not supported for directory buckets.

    \n
    • \n
  • \n

    This functionality is not supported for Amazon S3 on Outposts.

    \n
    • \n
\n ", + "smithy.api#httpHeader": "x-amz-grant-full-control" + } + }, + "GrantRead": { + "target": "com.amazonaws.s3#GrantRead", + "traits": { + "smithy.api#documentation": "

Allows grantee to read the object data and its metadata.

\n \n
    \n
  • \n

    This functionality is not supported for directory buckets.

    \n
    • \n
  • \n

    This functionality is not supported for Amazon S3 on Outposts.

    \n
    • \n
\n ", + "smithy.api#httpHeader": "x-amz-grant-read" + } + }, + "GrantReadACP": { + "target": "com.amazonaws.s3#GrantReadACP", + "traits": { + "smithy.api#documentation": "

Allows grantee to read the object ACL.

\n \n
    \n
  • \n

    This functionality is not supported for directory buckets.

    \n
    • \n
  • \n

    This functionality is not supported for Amazon S3 on Outposts.

    \n
    • \n
\n ", + "smithy.api#httpHeader": "x-amz-grant-read-acp" + } + }, + "GrantWriteACP": { + "target": "com.amazonaws.s3#GrantWriteACP", + "traits": { + "smithy.api#documentation": "

Allows grantee to write the ACL for the applicable object.

\n \n
    \n
  • \n

    This functionality is not supported for directory buckets.

    \n
    • \n
  • \n

    This functionality is not supported for Amazon S3 on Outposts.

    \n
    • \n
\n ", + "smithy.api#httpHeader": "x-amz-grant-write-acp" + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

Object key for which the PUT action was initiated.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Key" + } + } + }, + "WriteOffsetBytes": { + "target": "com.amazonaws.s3#WriteOffsetBytes", + "traits": { + "smithy.api#documentation": "

\n Specifies the offset for appending data to existing objects in bytes. \n The offset must be equal to the size of the existing object being appended to. \n If no object exists, setting this header to 0 will create a new object.\n

\n \n

This functionality is only supported for objects in the Amazon S3 Express One Zone storage class in directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-write-offset-bytes" + } + }, + "Metadata": { + "target": "com.amazonaws.s3#Metadata", + "traits": { + "smithy.api#documentation": "

A map of metadata to store with the object in S3.

", + "smithy.api#httpPrefixHeaders": "x-amz-meta-" + } + }, + "ServerSideEncryption": { + "target": "com.amazonaws.s3#ServerSideEncryption", + "traits": { + "smithy.api#documentation": "

The server-side encryption algorithm that was used when you store this object in Amazon S3\n (for example, AES256, aws:kms, aws:kms:dsse).

\n
    \n
  • \n

    \n General purpose buckets - You have four mutually\n exclusive options to protect data using server-side encryption in Amazon S3, depending on\n how you choose to manage the encryption keys. Specifically, the encryption key\n options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS or DSSE-KMS), and\n customer-provided keys (SSE-C). Amazon S3 encrypts data with server-side encryption by\n using Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to encrypt\n data at rest by using server-side encryption with other key options. For more\n information, see Using Server-Side\n Encryption in the Amazon S3 User Guide.

    \n
    • \n
  • \n

    \n Directory buckets -\n For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (aws:kms). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your \n CreateSession requests or PUT object requests. Then, new objects \n are automatically encrypted with the desired encryption settings. For more\n information, see Protecting data with server-side encryption in the Amazon S3 User Guide. For more information about the encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.

    \n

    In the Zonal endpoint API calls (except CopyObject and UploadPartCopy) using the REST API, the encryption request headers must match the encryption settings that are specified in the CreateSession request. \n You can't override the values of the encryption settings (x-amz-server-side-encryption, x-amz-server-side-encryption-aws-kms-key-id, x-amz-server-side-encryption-context, and x-amz-server-side-encryption-bucket-key-enabled) that are specified in the CreateSession request. \n You don't need to explicitly specify these encryption settings values in Zonal endpoint API calls, and \n Amazon S3 will use the encryption settings values from the CreateSession request to protect new objects in the directory bucket. \n

    \n \n

    When you use the CLI or the Amazon Web Services SDKs, for CreateSession, the session token refreshes automatically to avoid service interruptions when a session expires. The CLI or the Amazon Web Services SDKs use the bucket's default encryption configuration for the \n CreateSession request. It's not supported to override the encryption settings values in the CreateSession request. \n So in the Zonal endpoint API calls (except CopyObject and UploadPartCopy), \n the encryption request headers must match the default encryption configuration of the directory bucket.\n\n

    \n     \n
    • \n
", + "smithy.api#httpHeader": "x-amz-server-side-encryption" + } + }, + "StorageClass": { + "target": "com.amazonaws.s3#StorageClass", + "traits": { + "smithy.api#documentation": "

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The\n STANDARD storage class provides high durability and high availability. Depending on\n performance needs, you can specify a different Storage Class. For more information, see\n Storage\n Classes in the Amazon S3 User Guide.

\n \n
    \n
  • \n

    For directory buckets, only the S3 Express One Zone storage class is supported to store\n newly created objects.

    \n
    • \n
  • \n

    Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.

    \n
    • \n
\n ", + "smithy.api#httpHeader": "x-amz-storage-class" + } + }, + "WebsiteRedirectLocation": { + "target": "com.amazonaws.s3#WebsiteRedirectLocation", + "traits": { + "smithy.api#documentation": "

If the bucket is configured as a website, redirects requests for this object to another\n object in the same bucket or to an external URL. Amazon S3 stores the value of this header in\n the object metadata. For information about object metadata, see Object Key and Metadata in the\n Amazon S3 User Guide.

\n

In the following example, the request header sets the redirect to an object\n (anotherPage.html) in the same bucket:

\n

\n x-amz-website-redirect-location: /anotherPage.html\n

\n

In the following example, the request header sets the object redirect to another\n website:

\n

\n x-amz-website-redirect-location: http://www.example.com/\n

\n

For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3 and\n How to\n Configure Website Page Redirects in the Amazon S3 User Guide.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-website-redirect-location" + } + }, + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "traits": { + "smithy.api#documentation": "

Specifies the algorithm to use when encrypting the object (for example,\n AES256).

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + } + }, + "SSECustomerKey": { + "target": "com.amazonaws.s3#SSECustomerKey", + "traits": { + "smithy.api#documentation": "

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This\n value is used to store the object and then it is discarded; Amazon S3 does not store the\n encryption key. The key must be appropriate for use with the algorithm specified in the\n x-amz-server-side-encryption-customer-algorithm header.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key" + } + }, + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "traits": { + "smithy.api#documentation": "

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n this header for a message integrity check to ensure that the encryption key was transmitted\n without error.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" + } + }, + "SSEKMSKeyId": { + "target": "com.amazonaws.s3#SSEKMSKeyId", + "traits": { + "smithy.api#documentation": "

Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption. If the KMS key doesn't exist in the same\n account that's issuing the command, you must use the full Key ARN not the Key ID.

\n

\n General purpose buckets - If you specify x-amz-server-side-encryption with aws:kms or aws:kms:dsse, this header specifies the ID (Key ID, Key ARN, or Key Alias) of the KMS \n key to use. If you specify\n x-amz-server-side-encryption:aws:kms or\n x-amz-server-side-encryption:aws:kms:dsse, but do not provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed key\n (aws/s3) to protect the data.

\n

\n Directory buckets - If you specify x-amz-server-side-encryption with aws:kms, the \n x-amz-server-side-encryption-aws-kms-key-id header is implicitly assigned the ID of the KMS \n symmetric encryption customer managed key that's configured for your directory bucket's default encryption setting. \n If you want to specify the \n x-amz-server-side-encryption-aws-kms-key-id header explicitly, you can only specify it with the ID (Key ID or Key ARN) of the KMS \n customer managed key that's configured for your directory bucket's default encryption setting. Otherwise, you get an HTTP 400 Bad Request error. Only use the key ID or key ARN. The key alias format of the KMS key isn't supported. Your SSE-KMS configuration can only support 1 customer managed key per directory bucket for the lifetime of the bucket. \nThe Amazon Web Services managed key (aws/s3) isn't supported. \n

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" + } + }, + "SSEKMSEncryptionContext": { + "target": "com.amazonaws.s3#SSEKMSEncryptionContext", + "traits": { + "smithy.api#documentation": "

Specifies the Amazon Web Services KMS Encryption Context as an additional encryption context to use for object encryption. The value of\n this header is a Base64-encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs. \n This value is stored as object metadata and automatically gets passed on\n to Amazon Web Services KMS for future GetObject operations on\n this object.

\n

\n General purpose buckets - This value must be explicitly added during CopyObject operations if you want an additional encryption context for your object. For more information, see Encryption context in the Amazon S3 User Guide.

\n

\n Directory buckets - You can optionally provide an explicit encryption context value. The value must match the default encryption context - the bucket Amazon Resource Name (ARN). An additional encryption context value is not supported.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-context" + } + }, + "BucketKeyEnabled": { + "target": "com.amazonaws.s3#BucketKeyEnabled", + "traits": { + "smithy.api#documentation": "

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with\n server-side encryption using Key Management Service (KMS) keys (SSE-KMS).

\n

\n General purpose buckets - Setting this header to\n true causes Amazon S3 to use an S3 Bucket Key for object encryption with\n SSE-KMS. Also, specifying this header with a PUT action doesn't affect bucket-level settings for S3\n Bucket Key.

\n

\n Directory buckets - S3 Bucket Keys are always enabled for GET and PUT operations in a directory bucket and can’t be disabled. S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets \nto directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through CopyObject, UploadPartCopy, the Copy operation in Batch Operations, or \n the import jobs. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "Tagging": { + "target": "com.amazonaws.s3#TaggingHeader", + "traits": { + "smithy.api#documentation": "

The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For\n example, \"Key1=Value1\")

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-tagging" + } + }, + "ObjectLockMode": { + "target": "com.amazonaws.s3#ObjectLockMode", + "traits": { + "smithy.api#documentation": "

The Object Lock mode that you want to apply to this object.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-object-lock-mode" + } + }, + "ObjectLockRetainUntilDate": { + "target": "com.amazonaws.s3#ObjectLockRetainUntilDate", + "traits": { + "smithy.api#documentation": "

The date and time when you want this object's Object Lock to expire. Must be formatted\n as a timestamp parameter.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-object-lock-retain-until-date" + } + }, + "ObjectLockLegalHoldStatus": { + "target": "com.amazonaws.s3#ObjectLockLegalHoldStatus", + "traits": { + "smithy.api#documentation": "

Specifies whether a legal hold will be applied to this object. For more information\n about S3 Object Lock, see Object Lock in the\n Amazon S3 User Guide.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-object-lock-legal-hold" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#PutObjectRetention": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutObjectRetentionRequest" + }, + "output": { + "target": "com.amazonaws.s3#PutObjectRetentionOutput" + }, + "traits": { + "aws.protocols#httpChecksum": { + "requestAlgorithmMember": "ChecksumAlgorithm", + "requestChecksumRequired": true + }, + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Places an Object Retention configuration on an object. For more information, see Locking Objects.\n Users or accounts require the s3:PutObjectRetention permission in order to\n place an Object Retention configuration on objects. Bypassing a Governance Retention\n configuration requires the s3:BypassGovernanceRetention permission.

\n

This functionality is not supported for Amazon S3 on Outposts.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}/{Key+}?retention", + "code": 200 + } + } + }, + "com.amazonaws.s3#PutObjectRetentionOutput": { + "type": "structure", + "members": { + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3#PutObjectRetentionRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name that contains the object you want to apply this Object Retention\n configuration to.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

The key name for the object that you want to apply this Object Retention configuration\n to.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Retention": { + "target": "com.amazonaws.s3#ObjectLockRetention", + "traits": { + "smithy.api#documentation": "

The container element for the Object Retention configuration.

", + "smithy.api#httpPayload": {}, + "smithy.api#xmlName": "Retention" + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

The version ID for the object that you want to apply this Object Retention configuration\n to.

", + "smithy.api#httpQuery": "versionId" + } + }, + "BypassGovernanceRetention": { + "target": "com.amazonaws.s3#BypassGovernanceRetention", + "traits": { + "smithy.api#documentation": "

Indicates whether this action should bypass Governance-mode restrictions.

", + "smithy.api#httpHeader": "x-amz-bypass-governance-retention" + } + }, + "ContentMD5": { + "target": "com.amazonaws.s3#ContentMD5", + "traits": { + "smithy.api#documentation": "

The MD5 hash for the request body.

\n

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

", + "smithy.api#httpHeader": "Content-MD5" + } + }, + "ChecksumAlgorithm": { + "target": "com.amazonaws.s3#ChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any\n additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or\n x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more\n information, see Checking object integrity in\n the Amazon S3 User Guide.

\n

If you provide an individual checksum, Amazon S3 ignores any provided\n ChecksumAlgorithm parameter.

", + "smithy.api#httpHeader": "x-amz-sdk-checksum-algorithm" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#PutObjectTagging": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutObjectTaggingRequest" + }, + "output": { + "target": "com.amazonaws.s3#PutObjectTaggingOutput" + }, + "traits": { + "aws.protocols#httpChecksum": { + "requestAlgorithmMember": "ChecksumAlgorithm", + "requestChecksumRequired": true + }, + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Sets the supplied tag-set to an object that already exists in a bucket. A tag is a\n key-value pair. For more information, see Object Tagging.

\n

You can associate tags with an object by sending a PUT request against the tagging\n subresource that is associated with the object. You can retrieve tags by sending a GET\n request. For more information, see GetObjectTagging.

\n

For tagging-related restrictions related to characters and encodings, see Tag\n Restrictions. Note that Amazon S3 limits the maximum number of tags to 10 tags per\n object.

\n

To use this operation, you must have permission to perform the\n s3:PutObjectTagging action. By default, the bucket owner has this\n permission and can grant this permission to others.

\n

To put tags of any other version, use the versionId query parameter. You\n also need permission for the s3:PutObjectVersionTagging action.

\n

\n PutObjectTagging has the following special errors. For more Amazon S3 errors\n see, Error\n Responses.

\n
    \n
  • \n

    \n InvalidTag - The tag provided was not a valid tag. This error\n can occur if the tag did not pass input validation. For more information, see Object\n Tagging.

    \n
    • \n
  • \n

    \n MalformedXML - The XML provided does not match the\n schema.

    \n
    • \n
  • \n

    \n OperationAborted - A conflicting conditional action is\n currently in progress against this resource. Please try again.

    \n
    • \n
  • \n

    \n InternalError - The service was unable to apply the provided\n tag to the object.

    \n
    • \n
\n

The following operations are related to PutObjectTagging:

\n ", + "smithy.api#examples": [ + { + "title": "To add tags to an existing object", + "documentation": "The following example adds tags to an existing object.", + "input": { + "Bucket": "examplebucket", + "Key": "HappyFace.jpg", + "Tagging": { + "TagSet": [ + { + "Key": "Key3", + "Value": "Value3" + }, + { + "Key": "Key4", + "Value": "Value4" + } + ] + } + }, + "output": { + "VersionId": "null" + } + } + ], + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}/{Key+}?tagging", + "code": 200 + } + } + }, + "com.amazonaws.s3#PutObjectTaggingOutput": { + "type": "structure", + "members": { + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

The versionId of the object the tag-set was added to.

", + "smithy.api#httpHeader": "x-amz-version-id" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3#PutObjectTaggingRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name containing the object.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

\n S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

Name of the object key.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

The versionId of the object that the tag-set will be added to.

", + "smithy.api#httpQuery": "versionId" + } + }, + "ContentMD5": { + "target": "com.amazonaws.s3#ContentMD5", + "traits": { + "smithy.api#documentation": "

The MD5 hash for the request body.

\n

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

", + "smithy.api#httpHeader": "Content-MD5" + } + }, + "ChecksumAlgorithm": { + "target": "com.amazonaws.s3#ChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any\n additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or\n x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more\n information, see Checking object integrity in\n the Amazon S3 User Guide.

\n

If you provide an individual checksum, Amazon S3 ignores any provided\n ChecksumAlgorithm parameter.

", + "smithy.api#httpHeader": "x-amz-sdk-checksum-algorithm" + } + }, + "Tagging": { + "target": "com.amazonaws.s3#Tagging", + "traits": { + "smithy.api#documentation": "

Container for the TagSet and Tag elements

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {}, + "smithy.api#xmlName": "Tagging" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#PutPublicAccessBlock": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutPublicAccessBlockRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "aws.protocols#httpChecksum": { + "requestAlgorithmMember": "ChecksumAlgorithm", + "requestChecksumRequired": true + }, + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Creates or modifies the PublicAccessBlock configuration for an Amazon S3 bucket.\n To use this operation, you must have the s3:PutBucketPublicAccessBlock\n permission. For more information about Amazon S3 permissions, see Specifying Permissions in a\n Policy.

\n \n

When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or\n an object, it checks the PublicAccessBlock configuration for both the\n bucket (or the bucket that contains the object) and the bucket owner's account. If the\n PublicAccessBlock configurations are different between the bucket and\n the account, Amazon S3 uses the most restrictive combination of the bucket-level and\n account-level settings.

\n \n

For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of \"Public\".

\n

The following operations are related to PutPublicAccessBlock:

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}?publicAccessBlock", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#PutPublicAccessBlockRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the Amazon S3 bucket whose PublicAccessBlock configuration you want\n to set.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ContentMD5": { + "target": "com.amazonaws.s3#ContentMD5", + "traits": { + "smithy.api#documentation": "

The MD5 hash of the PutPublicAccessBlock request body.

\n

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

", + "smithy.api#httpHeader": "Content-MD5" + } + }, + "ChecksumAlgorithm": { + "target": "com.amazonaws.s3#ChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any\n additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or\n x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more\n information, see Checking object integrity in\n the Amazon S3 User Guide.

\n

If you provide an individual checksum, Amazon S3 ignores any provided\n ChecksumAlgorithm parameter.

", + "smithy.api#httpHeader": "x-amz-sdk-checksum-algorithm" + } + }, + "PublicAccessBlockConfiguration": { + "target": "com.amazonaws.s3#PublicAccessBlockConfiguration", + "traits": { + "smithy.api#documentation": "

The PublicAccessBlock configuration that you want to apply to this Amazon S3\n bucket. You can enable the configuration options in any combination. For more information\n about when Amazon S3 considers a bucket or object public, see The Meaning of \"Public\" in the Amazon S3 User Guide.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {}, + "smithy.api#xmlName": "PublicAccessBlockConfiguration" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#QueueArn": { + "type": "string" + }, + "com.amazonaws.s3#QueueConfiguration": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.s3#NotificationId" + }, + "QueueArn": { + "target": "com.amazonaws.s3#QueueArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 publishes a message\n when it detects events of the specified type.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "Queue" + } + }, + "Events": { + "target": "com.amazonaws.s3#EventList", + "traits": { + "smithy.api#documentation": "

A collection of bucket events for which to send notifications

", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Event" + } + }, + "Filter": { + "target": "com.amazonaws.s3#NotificationConfigurationFilter" + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the configuration for publishing messages to an Amazon Simple Queue Service\n (Amazon SQS) queue when Amazon S3 detects specified events.

" + } + }, + "com.amazonaws.s3#QueueConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#QueueConfiguration" + } + }, + "com.amazonaws.s3#Quiet": { + "type": "boolean" + }, + "com.amazonaws.s3#QuoteCharacter": { + "type": "string" + }, + "com.amazonaws.s3#QuoteEscapeCharacter": { + "type": "string" + }, + "com.amazonaws.s3#QuoteFields": { + "type": "enum", + "members": { + "ALWAYS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALWAYS" + } + }, + "ASNEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASNEEDED" + } + } + } + }, + "com.amazonaws.s3#Range": { + "type": "string" + }, + "com.amazonaws.s3#RecordDelimiter": { + "type": "string" + }, + "com.amazonaws.s3#RecordsEvent": { + "type": "structure", + "members": { + "Payload": { + "target": "com.amazonaws.s3#Body", + "traits": { + "smithy.api#documentation": "

The byte array of partial, one or more result records. S3 Select doesn't guarantee that\n a record will be self-contained in one record frame. To ensure continuous streaming of\n data, S3 Select might split the same record across multiple record frames instead of\n aggregating the results in memory. Some S3 clients (for example, the SDK for Java) handle this behavior by creating a ByteStream out of the response by\n default. Other clients might not handle this behavior by default. In those cases, you must\n aggregate the results on the client side and parse the response.

", + "smithy.api#eventPayload": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The container for the records event.

" + } + }, + "com.amazonaws.s3#Redirect": { + "type": "structure", + "members": { + "HostName": { + "target": "com.amazonaws.s3#HostName", + "traits": { + "smithy.api#documentation": "

The host name to use in the redirect request.

" + } + }, + "HttpRedirectCode": { + "target": "com.amazonaws.s3#HttpRedirectCode", + "traits": { + "smithy.api#documentation": "

The HTTP redirect code to use on the response. Not required if one of the siblings is\n present.

" + } + }, + "Protocol": { + "target": "com.amazonaws.s3#Protocol", + "traits": { + "smithy.api#documentation": "

Protocol to use when redirecting requests. The default is the protocol that is used in\n the original request.

" + } + }, + "ReplaceKeyPrefixWith": { + "target": "com.amazonaws.s3#ReplaceKeyPrefixWith", + "traits": { + "smithy.api#documentation": "

The object key prefix to use in the redirect request. For example, to redirect requests\n for all pages with prefix docs/ (objects in the docs/ folder) to\n documents/, you can set a condition block with KeyPrefixEquals\n set to docs/ and in the Redirect set ReplaceKeyPrefixWith to\n /documents. Not required if one of the siblings is present. Can be present\n only if ReplaceKeyWith is not provided.

\n \n

Replacement must be made for object keys containing special characters (such as carriage returns) when using \n XML requests. For more information, see \n XML related object key constraints.

\n " + } + }, + "ReplaceKeyWith": { + "target": "com.amazonaws.s3#ReplaceKeyWith", + "traits": { + "smithy.api#documentation": "

The specific object key to use in the redirect request. For example, redirect request to\n error.html. Not required if one of the siblings is present. Can be present\n only if ReplaceKeyPrefixWith is not provided.

\n \n

Replacement must be made for object keys containing special characters (such as carriage returns) when using \n XML requests. For more information, see \n XML related object key constraints.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies how requests are redirected. In the event of an error, you can specify a\n different error code to return.

" + } + }, + "com.amazonaws.s3#RedirectAllRequestsTo": { + "type": "structure", + "members": { + "HostName": { + "target": "com.amazonaws.s3#HostName", + "traits": { + "smithy.api#documentation": "

Name of the host where requests are redirected.

", + "smithy.api#required": {} + } + }, + "Protocol": { + "target": "com.amazonaws.s3#Protocol", + "traits": { + "smithy.api#documentation": "

Protocol to use when redirecting requests. The default is the protocol that is used in\n the original request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3\n bucket.

" + } + }, + "com.amazonaws.s3#Region": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.s3#ReplaceKeyPrefixWith": { + "type": "string" + }, + "com.amazonaws.s3#ReplaceKeyWith": { + "type": "string" + }, + "com.amazonaws.s3#ReplicaKmsKeyID": { + "type": "string" + }, + "com.amazonaws.s3#ReplicaModifications": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.s3#ReplicaModificationsStatus", + "traits": { + "smithy.api#documentation": "

Specifies whether Amazon S3 replicates modifications on replicas.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A filter that you can specify for selection for modifications on replicas. Amazon S3 doesn't\n replicate replica modifications by default. In the latest version of replication\n configuration (when Filter is specified), you can specify this element and set\n the status to Enabled to replicate modifications on replicas.

\n \n

If you don't specify the Filter element, Amazon S3 assumes that the\n replication configuration is the earlier version, V1. In the earlier version, this\n element is not allowed.

\n " + } + }, + "com.amazonaws.s3#ReplicaModificationsStatus": { + "type": "enum", + "members": { + "Enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enabled" + } + }, + "Disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disabled" + } + } + } + }, + "com.amazonaws.s3#ReplicationConfiguration": { + "type": "structure", + "members": { + "Role": { + "target": "com.amazonaws.s3#Role", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that Amazon S3 assumes when\n replicating objects. For more information, see How to Set Up Replication\n in the Amazon S3 User Guide.

", + "smithy.api#required": {} + } + }, + "Rules": { + "target": "com.amazonaws.s3#ReplicationRules", + "traits": { + "smithy.api#documentation": "

A container for one or more replication rules. A replication configuration must have at\n least one rule and can contain a maximum of 1,000 rules.

", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Rule" + } + } + }, + "traits": { + "smithy.api#documentation": "

A container for replication rules. You can add up to 1,000 rules. The maximum size of a\n replication configuration is 2 MB.

" + } + }, + "com.amazonaws.s3#ReplicationRule": { + "type": "structure", + "members": { + "ID": { + "target": "com.amazonaws.s3#ID", + "traits": { + "smithy.api#documentation": "

A unique identifier for the rule. The maximum value is 255 characters.

" + } + }, + "Priority": { + "target": "com.amazonaws.s3#Priority", + "traits": { + "smithy.api#documentation": "

The priority indicates which rule has precedence whenever two or more replication rules\n conflict. Amazon S3 will attempt to replicate objects according to all replication rules.\n However, if there are two or more rules with the same destination bucket, then objects will\n be replicated according to the rule with the highest priority. The higher the number, the\n higher the priority.

\n

For more information, see Replication in the\n Amazon S3 User Guide.

" + } + }, + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

An object key name prefix that identifies the object or objects to which the rule\n applies. The maximum prefix length is 1,024 characters. To include all objects in a bucket,\n specify an empty string.

\n \n

Replacement must be made for object keys containing special characters (such as carriage returns) when using \n XML requests. For more information, see \n XML related object key constraints.

\n " + } + }, + "Filter": { + "target": "com.amazonaws.s3#ReplicationRuleFilter" + }, + "Status": { + "target": "com.amazonaws.s3#ReplicationRuleStatus", + "traits": { + "smithy.api#documentation": "

Specifies whether the rule is enabled.

", + "smithy.api#required": {} + } + }, + "SourceSelectionCriteria": { + "target": "com.amazonaws.s3#SourceSelectionCriteria", + "traits": { + "smithy.api#documentation": "

A container that describes additional filters for identifying the source objects that\n you want to replicate. You can choose to enable or disable the replication of these\n objects. Currently, Amazon S3 supports only the filter that you can specify for objects created\n with server-side encryption using a customer managed key stored in Amazon Web Services Key Management Service\n (SSE-KMS).

" + } + }, + "ExistingObjectReplication": { + "target": "com.amazonaws.s3#ExistingObjectReplication", + "traits": { + "smithy.api#documentation": "

Optional configuration to replicate existing source bucket objects.

\n \n

This parameter is no longer supported. To replicate existing objects, see Replicating existing objects with S3 Batch Replication in the\n Amazon S3 User Guide.

\n " + } + }, + "Destination": { + "target": "com.amazonaws.s3#Destination", + "traits": { + "smithy.api#documentation": "

A container for information about the replication destination and its configurations\n including enabling the S3 Replication Time Control (S3 RTC).

", + "smithy.api#required": {} + } + }, + "DeleteMarkerReplication": { + "target": "com.amazonaws.s3#DeleteMarkerReplication" + } + }, + "traits": { + "smithy.api#documentation": "

Specifies which Amazon S3 objects to replicate and where to store the replicas.

" + } + }, + "com.amazonaws.s3#ReplicationRuleAndOperator": { + "type": "structure", + "members": { + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "

An object key name prefix that identifies the subset of objects to which the rule\n applies.

" + } + }, + "Tags": { + "target": "com.amazonaws.s3#TagSet", + "traits": { + "smithy.api#documentation": "

An array of tags containing key and value pairs.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Tag" + } + } + }, + "traits": { + "smithy.api#documentation": "

A container for specifying rule filters. The filters determine the subset of objects to\n which the rule applies. This element is required only if you specify more than one filter.

\n

For example:

\n
    \n
  • \n

    If you specify both a Prefix and a Tag filter, wrap\n these filters in an And tag.

    \n
    • \n
  • \n

    If you specify a filter based on multiple tags, wrap the Tag elements\n in an And tag.

    \n
    • \n
" + } + }, + "com.amazonaws.s3#ReplicationRuleFilter": { + "type": "structure", + "members": { + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "

An object key name prefix that identifies the subset of objects to which the rule\n applies.

\n \n

Replacement must be made for object keys containing special characters (such as carriage returns) when using \n XML requests. For more information, see \n XML related object key constraints.

\n " + } + }, + "Tag": { + "target": "com.amazonaws.s3#Tag", + "traits": { + "smithy.api#documentation": "

A container for specifying a tag key and value.

\n

The rule applies only to objects that have the tag in their tag set.

" + } + }, + "And": { + "target": "com.amazonaws.s3#ReplicationRuleAndOperator", + "traits": { + "smithy.api#documentation": "

A container for specifying rule filters. The filters determine the subset of objects to\n which the rule applies. This element is required only if you specify more than one filter.\n For example:

\n
    \n
  • \n

    If you specify both a Prefix and a Tag filter, wrap\n these filters in an And tag.

    \n
    • \n
  • \n

    If you specify a filter based on multiple tags, wrap the Tag elements\n in an And tag.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

A filter that identifies the subset of objects to which the replication rule applies. A\n Filter must specify exactly one Prefix, Tag, or\n an And child element.

" + } + }, + "com.amazonaws.s3#ReplicationRuleStatus": { + "type": "enum", + "members": { + "Enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enabled" + } + }, + "Disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disabled" + } + } + } + }, + "com.amazonaws.s3#ReplicationRules": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#ReplicationRule" + } + }, + "com.amazonaws.s3#ReplicationStatus": { + "type": "enum", + "members": { + "COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETE" + } + }, + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "REPLICA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REPLICA" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + } + } + }, + "com.amazonaws.s3#ReplicationTime": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.s3#ReplicationTimeStatus", + "traits": { + "smithy.api#documentation": "

Specifies whether the replication time is enabled.

", + "smithy.api#required": {} + } + }, + "Time": { + "target": "com.amazonaws.s3#ReplicationTimeValue", + "traits": { + "smithy.api#documentation": "

A container specifying the time by which replication should be complete for all objects\n and operations on objects.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A container specifying S3 Replication Time Control (S3 RTC) related information, including whether S3 RTC is\n enabled and the time when all objects and operations on objects must be replicated. Must be\n specified together with a Metrics block.

" + } + }, + "com.amazonaws.s3#ReplicationTimeStatus": { + "type": "enum", + "members": { + "Enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enabled" + } + }, + "Disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disabled" + } + } + } + }, + "com.amazonaws.s3#ReplicationTimeValue": { + "type": "structure", + "members": { + "Minutes": { + "target": "com.amazonaws.s3#Minutes", + "traits": { + "smithy.api#documentation": "

Contains an integer specifying time in minutes.

\n

Valid value: 15

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A container specifying the time value for S3 Replication Time Control (S3 RTC) and replication metrics\n EventThreshold.

" + } + }, + "com.amazonaws.s3#RequestCharged": { + "type": "enum", + "members": { + "requester": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "requester" + } + } + }, + "traits": { + "smithy.api#documentation": "

If present, indicates that the requester was successfully charged for the\n request.

\n \n

This functionality is not supported for directory buckets.

\n " + } + }, + "com.amazonaws.s3#RequestPayer": { + "type": "enum", + "members": { + "requester": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "requester" + } + } + }, + "traits": { + "smithy.api#documentation": "

Confirms that the requester knows that they will be charged for the request. Bucket\n owners need not specify this parameter in their requests. If either the source or\n destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding\n charges to copy the object. For information about downloading objects from Requester Pays\n buckets, see Downloading Objects in\n Requester Pays Buckets in the Amazon S3 User Guide.

\n \n

This functionality is not supported for directory buckets.

\n " + } + }, + "com.amazonaws.s3#RequestPaymentConfiguration": { + "type": "structure", + "members": { + "Payer": { + "target": "com.amazonaws.s3#Payer", + "traits": { + "smithy.api#documentation": "

Specifies who pays for the download and request fees.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Container for Payer.

" + } + }, + "com.amazonaws.s3#RequestProgress": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.s3#EnableRequestProgress", + "traits": { + "smithy.api#documentation": "

Specifies whether periodic QueryProgress frames should be sent. Valid values: TRUE,\n FALSE. Default value: FALSE.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Container for specifying if periodic QueryProgress messages should be\n sent.

" + } + }, + "com.amazonaws.s3#RequestRoute": { + "type": "string" + }, + "com.amazonaws.s3#RequestToken": { + "type": "string" + }, + "com.amazonaws.s3#ResponseCacheControl": { + "type": "string" + }, + "com.amazonaws.s3#ResponseContentDisposition": { + "type": "string" + }, + "com.amazonaws.s3#ResponseContentEncoding": { + "type": "string" + }, + "com.amazonaws.s3#ResponseContentLanguage": { + "type": "string" + }, + "com.amazonaws.s3#ResponseContentType": { + "type": "string" + }, + "com.amazonaws.s3#ResponseExpires": { + "type": "timestamp", + "traits": { + "smithy.api#timestampFormat": "http-date" + } + }, + "com.amazonaws.s3#Restore": { + "type": "string" + }, + "com.amazonaws.s3#RestoreExpiryDate": { + "type": "timestamp" + }, + "com.amazonaws.s3#RestoreObject": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#RestoreObjectRequest" + }, + "output": { + "target": "com.amazonaws.s3#RestoreObjectOutput" + }, + "errors": [ + { + "target": "com.amazonaws.s3#ObjectAlreadyInActiveTierError" + } + ], + "traits": { + "aws.protocols#httpChecksum": { + "requestAlgorithmMember": "ChecksumAlgorithm" + }, + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Restores an archived copy of an object back into Amazon S3

\n

This functionality is not supported for Amazon S3 on Outposts.

\n

This action performs the following types of requests:

\n
    \n
  • \n

    \n restore an archive - Restore an archived object

    \n
    • \n
\n

For more information about the S3 structure in the request body, see the\n following:

\n \n
\n
Permissions
\n
\n

To use this operation, you must have permissions to perform the\n s3:RestoreObject action. The bucket owner has this permission by\n default and can grant this permission to others. For more information about\n permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the\n Amazon S3 User Guide.

\n
\n
Restoring objects
\n
\n

Objects that you archive to the S3 Glacier Flexible Retrieval Flexible Retrieval\n or S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or\n S3 Intelligent-Tiering Deep Archive tiers, are not accessible in real time. For objects in the\n S3 Glacier Flexible Retrieval Flexible Retrieval or S3 Glacier Deep Archive\n storage classes, you must first initiate a restore request, and then wait until a\n temporary copy of the object is available. If you want a permanent copy of the\n object, create a copy of it in the Amazon S3 Standard storage class in your S3 bucket.\n To access an archived object, you must restore the object for the duration (number\n of days) that you specify. For objects in the Archive Access or Deep Archive\n Access tiers of S3 Intelligent-Tiering, you must first initiate a restore request,\n and then wait until the object is moved into the Frequent Access tier.

\n

To restore a specific object version, you can provide a version ID. If you\n don't provide a version ID, Amazon S3 restores the current version.

\n

When restoring an archived object, you can specify one of the following data\n access tier options in the Tier element of the request body:

\n
    \n
  • \n

    \n Expedited - Expedited retrievals allow you to quickly access\n your data stored in the S3 Glacier Flexible Retrieval Flexible Retrieval\n storage class or S3 Intelligent-Tiering Archive tier when occasional urgent requests\n for restoring archives are required. For all but the largest archived\n objects (250 MB+), data accessed using Expedited retrievals is typically\n made available within 1–5 minutes. Provisioned capacity ensures that\n retrieval capacity for Expedited retrievals is available when you need it.\n Expedited retrievals and provisioned capacity are not available for objects\n stored in the S3 Glacier Deep Archive storage class or\n S3 Intelligent-Tiering Deep Archive tier.

    \n
    • \n
  • \n

    \n Standard - Standard retrievals allow you to access any of\n your archived objects within several hours. This is the default option for\n retrieval requests that do not specify the retrieval option. Standard\n retrievals typically finish within 3–5 hours for objects stored in the\n S3 Glacier Flexible Retrieval Flexible Retrieval storage class or\n S3 Intelligent-Tiering Archive tier. They typically finish within 12 hours for\n objects stored in the S3 Glacier Deep Archive storage class or\n S3 Intelligent-Tiering Deep Archive tier. Standard retrievals are free for objects stored\n in S3 Intelligent-Tiering.

    \n
    • \n
  • \n

    \n Bulk - Bulk retrievals free for objects stored in the\n S3 Glacier Flexible Retrieval and S3 Intelligent-Tiering storage classes,\n enabling you to retrieve large amounts, even petabytes, of data at no cost.\n Bulk retrievals typically finish within 5–12 hours for objects stored in the\n S3 Glacier Flexible Retrieval Flexible Retrieval storage class or\n S3 Intelligent-Tiering Archive tier. Bulk retrievals are also the lowest-cost\n retrieval option when restoring objects from\n S3 Glacier Deep Archive. They typically finish within 48 hours for\n objects stored in the S3 Glacier Deep Archive storage class or\n S3 Intelligent-Tiering Deep Archive tier.

    \n
    • \n
\n

For more information about archive retrieval options and provisioned capacity\n for Expedited data access, see Restoring Archived\n Objects in the Amazon S3 User Guide.

\n

You can use Amazon S3 restore speed upgrade to change the restore speed to a faster\n speed while it is in progress. For more information, see Upgrading the speed of an in-progress restore in the\n Amazon S3 User Guide.

\n

To get the status of object restoration, you can send a HEAD\n request. Operations return the x-amz-restore header, which provides\n information about the restoration status, in the response. You can use Amazon S3 event\n notifications to notify you when a restore is initiated or completed. For more\n information, see Configuring Amazon S3 Event\n Notifications in the Amazon S3 User Guide.

\n

After restoring an archived object, you can update the restoration period by\n reissuing the request with a new period. Amazon S3 updates the restoration period\n relative to the current time and charges only for the request-there are no\n data transfer charges. You cannot update the restoration period when Amazon S3 is\n actively processing your current restore request for the object.

\n

If your bucket has a lifecycle configuration with a rule that includes an\n expiration action, the object expiration overrides the life span that you specify\n in a restore request. For example, if you restore an object copy for 10 days, but\n the object is scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days.\n For more information about lifecycle configuration, see PutBucketLifecycleConfiguration and Object Lifecycle\n Management in Amazon S3 User Guide.

\n
\n
Responses
\n
\n

A successful action returns either the 200 OK or 202\n Accepted status code.

\n
    \n
  • \n

    If the object is not previously restored, then Amazon S3 returns 202\n Accepted in the response.

    \n
    • \n
  • \n

    If the object is previously restored, Amazon S3 returns 200 OK in\n the response.

    \n
    • \n
\n
    \n
  • \n

    Special errors:

    \n
      \n
    • \n

      \n Code: RestoreAlreadyInProgress\n

      \n
      • \n
    • \n

      \n Cause: Object restore is already in progress.\n

      \n
      • \n
    • \n

      \n HTTP Status Code: 409 Conflict\n

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client\n

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: GlacierExpeditedRetrievalNotAvailable\n

      \n
      • \n
    • \n

      \n Cause: expedited retrievals are currently not available.\n Try again later. (Returned if there is insufficient capacity to\n process the Expedited request. This error applies only to Expedited\n retrievals and not to S3 Standard or Bulk retrievals.)\n

      \n
      • \n
    • \n

      \n HTTP Status Code: 503\n

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: N/A\n

      \n
      • \n
    \n
    • \n
\n
\n
\n

The following operations are related to RestoreObject:

\n ", + "smithy.api#examples": [ + { + "title": "To restore an archived object", + "documentation": "The following example restores for one day an archived copy of an object back into Amazon S3 bucket.", + "input": { + "Bucket": "examplebucket", + "Key": "archivedobjectkey", + "RestoreRequest": { + "Days": 1, + "GlacierJobParameters": { + "Tier": "Expedited" + } + } + }, + "output": {} + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/{Bucket}/{Key+}?restore", + "code": 200 + } + } + }, + "com.amazonaws.s3#RestoreObjectOutput": { + "type": "structure", + "members": { + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" + } + }, + "RestoreOutputPath": { + "target": "com.amazonaws.s3#RestoreOutputPath", + "traits": { + "smithy.api#documentation": "

Indicates the path in the provided S3 output location where Select results will be\n restored to.

", + "smithy.api#httpHeader": "x-amz-restore-output-path" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3#RestoreObjectRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name containing the object to restore.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

\n S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

Object key for which the action was initiated.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

VersionId used to reference a specific version of the object.

", + "smithy.api#httpQuery": "versionId" + } + }, + "RestoreRequest": { + "target": "com.amazonaws.s3#RestoreRequest", + "traits": { + "smithy.api#httpPayload": {}, + "smithy.api#xmlName": "RestoreRequest" + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "ChecksumAlgorithm": { + "target": "com.amazonaws.s3#ChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any\n additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or\n x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more\n information, see Checking object integrity in\n the Amazon S3 User Guide.

\n

If you provide an individual checksum, Amazon S3 ignores any provided\n ChecksumAlgorithm parameter.

", + "smithy.api#httpHeader": "x-amz-sdk-checksum-algorithm" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#RestoreOutputPath": { + "type": "string" + }, + "com.amazonaws.s3#RestoreRequest": { + "type": "structure", + "members": { + "Days": { + "target": "com.amazonaws.s3#Days", + "traits": { + "smithy.api#documentation": "

Lifetime of the active copy in days. Do not use with restores that specify\n OutputLocation.

\n

The Days element is required for regular restores, and must not be provided for select\n requests.

" + } + }, + "GlacierJobParameters": { + "target": "com.amazonaws.s3#GlacierJobParameters", + "traits": { + "smithy.api#documentation": "

S3 Glacier related parameters pertaining to this job. Do not use with restores that\n specify OutputLocation.

" + } + }, + "Type": { + "target": "com.amazonaws.s3#RestoreRequestType", + "traits": { + "smithy.api#documentation": "\n

Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can continue to use the feature as usual. Learn more\n

\n \n

Type of restore request.

" + } + }, + "Tier": { + "target": "com.amazonaws.s3#Tier", + "traits": { + "smithy.api#documentation": "

Retrieval tier at which the restore will be processed.

" + } + }, + "Description": { + "target": "com.amazonaws.s3#Description", + "traits": { + "smithy.api#documentation": "

The optional description for the job.

" + } + }, + "SelectParameters": { + "target": "com.amazonaws.s3#SelectParameters", + "traits": { + "smithy.api#documentation": "\n

Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can continue to use the feature as usual. Learn more\n

\n \n

Describes the parameters for Select job types.

" + } + }, + "OutputLocation": { + "target": "com.amazonaws.s3#OutputLocation", + "traits": { + "smithy.api#documentation": "

Describes the location where the restore job's output is stored.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Container for restore job parameters.

" + } + }, + "com.amazonaws.s3#RestoreRequestType": { + "type": "enum", + "members": { + "SELECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SELECT" + } + } + } + }, + "com.amazonaws.s3#RestoreStatus": { + "type": "structure", + "members": { + "IsRestoreInProgress": { + "target": "com.amazonaws.s3#IsRestoreInProgress", + "traits": { + "smithy.api#documentation": "

Specifies whether the object is currently being restored. If the object restoration is\n in progress, the header returns the value TRUE. For example:

\n

\n x-amz-optional-object-attributes: IsRestoreInProgress=\"true\"\n

\n

If the object restoration has completed, the header returns the value\n FALSE. For example:

\n

\n x-amz-optional-object-attributes: IsRestoreInProgress=\"false\",\n RestoreExpiryDate=\"2012-12-21T00:00:00.000Z\"\n

\n

If the object hasn't been restored, there is no header response.

" + } + }, + "RestoreExpiryDate": { + "target": "com.amazonaws.s3#RestoreExpiryDate", + "traits": { + "smithy.api#documentation": "

Indicates when the restored copy will expire. This value is populated only if the object\n has already been restored. For example:

\n

\n x-amz-optional-object-attributes: IsRestoreInProgress=\"false\",\n RestoreExpiryDate=\"2012-12-21T00:00:00.000Z\"\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the restoration status of an object. Objects in certain storage classes must\n be restored before they can be retrieved. For more information about these storage classes\n and how to work with archived objects, see Working with archived\n objects in the Amazon S3 User Guide.

\n \n

This functionality is not supported for directory buckets.\n Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

\n " + } + }, + "com.amazonaws.s3#Role": { + "type": "string" + }, + "com.amazonaws.s3#RoutingRule": { + "type": "structure", + "members": { + "Condition": { + "target": "com.amazonaws.s3#Condition", + "traits": { + "smithy.api#documentation": "

A container for describing a condition that must be met for the specified redirect to\n apply. For example, 1. If request is for pages in the /docs folder, redirect\n to the /documents folder. 2. If request results in HTTP error 4xx, redirect\n request to another host where you might process the error.

" + } + }, + "Redirect": { + "target": "com.amazonaws.s3#Redirect", + "traits": { + "smithy.api#documentation": "

Container for redirect information. You can redirect requests to another host, to\n another page, or with another protocol. In the event of an error, you can specify a\n different error code to return.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the redirect behavior and when a redirect is applied. For more information\n about routing rules, see Configuring advanced conditional redirects in the\n Amazon S3 User Guide.

" + } + }, + "com.amazonaws.s3#RoutingRules": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#RoutingRule", + "traits": { + "smithy.api#xmlName": "RoutingRule" + } + } + }, + "com.amazonaws.s3#S3KeyFilter": { + "type": "structure", + "members": { + "FilterRules": { + "target": "com.amazonaws.s3#FilterRuleList", + "traits": { + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "FilterRule" + } + } + }, + "traits": { + "smithy.api#documentation": "

A container for object key name prefix and suffix filtering rules.

" + } + }, + "com.amazonaws.s3#S3Location": { + "type": "structure", + "members": { + "BucketName": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket where the restore results will be placed.

", + "smithy.api#required": {} + } + }, + "Prefix": { + "target": "com.amazonaws.s3#LocationPrefix", + "traits": { + "smithy.api#documentation": "

The prefix that is prepended to the restore results for this request.

", + "smithy.api#required": {} + } + }, + "Encryption": { + "target": "com.amazonaws.s3#Encryption" + }, + "CannedACL": { + "target": "com.amazonaws.s3#ObjectCannedACL", + "traits": { + "smithy.api#documentation": "

The canned ACL to apply to the restore results.

" + } + }, + "AccessControlList": { + "target": "com.amazonaws.s3#Grants", + "traits": { + "smithy.api#documentation": "

A list of grants that control access to the staged results.

" + } + }, + "Tagging": { + "target": "com.amazonaws.s3#Tagging", + "traits": { + "smithy.api#documentation": "

The tag-set that is applied to the restore results.

" + } + }, + "UserMetadata": { + "target": "com.amazonaws.s3#UserMetadata", + "traits": { + "smithy.api#documentation": "

A list of metadata to store with the restore results in S3.

" + } + }, + "StorageClass": { + "target": "com.amazonaws.s3#StorageClass", + "traits": { + "smithy.api#documentation": "

The class of storage used to store the restore results.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an Amazon S3 location that will receive the results of the restore request.

" + } + }, + "com.amazonaws.s3#S3TablesArn": { + "type": "string" + }, + "com.amazonaws.s3#S3TablesBucketArn": { + "type": "string" + }, + "com.amazonaws.s3#S3TablesDestination": { + "type": "structure", + "members": { + "TableBucketArn": { + "target": "com.amazonaws.s3#S3TablesBucketArn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) for the table bucket that's specified as the \n destination in the metadata table configuration. The destination table bucket\n must be in the same Region and Amazon Web Services account as the general purpose bucket.\n

", + "smithy.api#required": {} + } + }, + "TableName": { + "target": "com.amazonaws.s3#S3TablesName", + "traits": { + "smithy.api#documentation": "

\n The name for the metadata table in your metadata table configuration. The specified metadata\n table name must be unique within the aws_s3_metadata namespace in the destination \n table bucket.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The destination information for the metadata table configuration. The destination table bucket\n must be in the same Region and Amazon Web Services account as the general purpose bucket. The specified metadata\n table name must be unique within the aws_s3_metadata namespace in the destination \n table bucket. \n

" + } + }, + "com.amazonaws.s3#S3TablesDestinationResult": { + "type": "structure", + "members": { + "TableBucketArn": { + "target": "com.amazonaws.s3#S3TablesBucketArn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) for the table bucket that's specified as the \n destination in the metadata table configuration. The destination table bucket\n must be in the same Region and Amazon Web Services account as the general purpose bucket.\n

", + "smithy.api#required": {} + } + }, + "TableName": { + "target": "com.amazonaws.s3#S3TablesName", + "traits": { + "smithy.api#documentation": "

\n The name for the metadata table in your metadata table configuration. The specified metadata\n table name must be unique within the aws_s3_metadata namespace in the destination \n table bucket.\n

", + "smithy.api#required": {} + } + }, + "TableArn": { + "target": "com.amazonaws.s3#S3TablesArn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) for the metadata table in the metadata table configuration. The \n specified metadata table name must be unique within the aws_s3_metadata namespace \n in the destination table bucket.\n

", + "smithy.api#required": {} + } + }, + "TableNamespace": { + "target": "com.amazonaws.s3#S3TablesNamespace", + "traits": { + "smithy.api#documentation": "

\n The table bucket namespace for the metadata table in your metadata table configuration. This value \n is always aws_s3_metadata.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The destination information for the metadata table configuration. The destination table bucket\n must be in the same Region and Amazon Web Services account as the general purpose bucket. The specified metadata\n table name must be unique within the aws_s3_metadata namespace in the destination \n table bucket.\n

" + } + }, + "com.amazonaws.s3#S3TablesName": { + "type": "string" + }, + "com.amazonaws.s3#S3TablesNamespace": { + "type": "string" + }, + "com.amazonaws.s3#SSECustomerAlgorithm": { + "type": "string" + }, + "com.amazonaws.s3#SSECustomerKey": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.s3#SSECustomerKeyMD5": { + "type": "string" + }, + "com.amazonaws.s3#SSEKMS": { + "type": "structure", + "members": { + "KeyId": { + "target": "com.amazonaws.s3#SSEKMSKeyId", + "traits": { + "smithy.api#documentation": "

Specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key to use for\n encrypting inventory reports.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the use of SSE-KMS to encrypt delivered inventory reports.

", + "smithy.api#xmlName": "SSE-KMS" + } + }, + "com.amazonaws.s3#SSEKMSEncryptionContext": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.s3#SSEKMSKeyId": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.s3#SSES3": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Specifies the use of SSE-S3 to encrypt delivered inventory reports.

", + "smithy.api#xmlName": "SSE-S3" + } + }, + "com.amazonaws.s3#ScanRange": { + "type": "structure", + "members": { + "Start": { + "target": "com.amazonaws.s3#Start", + "traits": { + "smithy.api#documentation": "

Specifies the start of the byte range. This parameter is optional. Valid values:\n non-negative integers. The default value is 0. If only start is supplied, it\n means scan from that point to the end of the file. For example,\n 50 means scan\n from byte 50 until the end of the file.

" + } + }, + "End": { + "target": "com.amazonaws.s3#End", + "traits": { + "smithy.api#documentation": "

Specifies the end of the byte range. This parameter is optional. Valid values:\n non-negative integers. The default value is one less than the size of the object being\n queried. If only the End parameter is supplied, it is interpreted to mean scan the last N\n bytes of the file. For example,\n 50 means scan the\n last 50 bytes.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the byte range of the object to get the records from. A record is processed\n when its first byte is contained by the range. This parameter is optional, but when\n specified, it must not be empty. See RFC 2616, Section 14.35.1 about how to specify the\n start and end of the range.

" + } + }, + "com.amazonaws.s3#SelectObjectContent": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#SelectObjectContentRequest" + }, + "output": { + "target": "com.amazonaws.s3#SelectObjectContentOutput" + }, + "traits": { + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

This action filters the contents of an Amazon S3 object based on a simple structured query\n language (SQL) statement. In the request, along with the SQL expression, you must also\n specify a data serialization format (JSON, CSV, or Apache Parquet) of the object. Amazon S3 uses\n this format to parse object data into records, and returns only records that match the\n specified SQL expression. You must also specify the data serialization format for the\n response.

\n

This functionality is not supported for Amazon S3 on Outposts.

\n

For more information about Amazon S3 Select, see Selecting Content from\n Objects and SELECT\n Command in the Amazon S3 User Guide.

\n

\n
\n
Permissions
\n
\n

You must have the s3:GetObject permission for this operation. Amazon S3\n Select does not support anonymous access. For more information about permissions,\n see Specifying Permissions in\n a Policy in the Amazon S3 User Guide.

\n
\n
Object Data Formats
\n
\n

You can use Amazon S3 Select to query objects that have the following format\n properties:

\n
    \n
  • \n

    \n CSV, JSON, and Parquet - Objects must be in CSV,\n JSON, or Parquet format.

    \n
    • \n
  • \n

    \n UTF-8 - UTF-8 is the only encoding type Amazon S3 Select\n supports.

    \n
    • \n
  • \n

    \n GZIP or BZIP2 - CSV and JSON files can be compressed\n using GZIP or BZIP2. GZIP and BZIP2 are the only compression formats that\n Amazon S3 Select supports for CSV and JSON files. Amazon S3 Select supports columnar\n compression for Parquet using GZIP or Snappy. Amazon S3 Select does not support\n whole-object compression for Parquet objects.

    \n
    • \n
  • \n

    \n Server-side encryption - Amazon S3 Select supports\n querying objects that are protected with server-side encryption.

    \n

    For objects that are encrypted with customer-provided encryption keys\n (SSE-C), you must use HTTPS, and you must use the headers that are\n documented in the GetObject. For more\n information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys)\n in the Amazon S3 User Guide.

    \n

    For objects that are encrypted with Amazon S3 managed keys (SSE-S3) and\n Amazon Web Services KMS keys (SSE-KMS), server-side encryption is handled transparently,\n so you don't need to specify anything. For more information about\n server-side encryption, including SSE-S3 and SSE-KMS, see Protecting Data Using Server-Side Encryption in the\n Amazon S3 User Guide.

    \n
    • \n
\n
\n
Working with the Response Body
\n
\n

Given the response size is unknown, Amazon S3 Select streams the response as a\n series of messages and includes a Transfer-Encoding header with\n chunked as its value in the response. For more information, see\n Appendix:\n SelectObjectContent\n Response.

\n
\n
GetObject Support
\n
\n

The SelectObjectContent action does not support the following\n GetObject functionality. For more information, see GetObject.

\n
    \n
  • \n

    \n Range: Although you can specify a scan range for an Amazon S3 Select\n request (see SelectObjectContentRequest - ScanRange in the request\n parameters), you cannot specify the range of bytes of an object to return.\n

    \n
    • \n
  • \n

    The GLACIER, DEEP_ARCHIVE, and\n REDUCED_REDUNDANCY storage classes, or the\n ARCHIVE_ACCESS and DEEP_ARCHIVE_ACCESS access\n tiers of the INTELLIGENT_TIERING storage class: You cannot\n query objects in the GLACIER, DEEP_ARCHIVE, or\n REDUCED_REDUNDANCY storage classes, nor objects in the\n ARCHIVE_ACCESS or DEEP_ARCHIVE_ACCESS access\n tiers of the INTELLIGENT_TIERING storage class. For more\n information about storage classes, see Using Amazon S3\n storage classes in the\n Amazon S3 User Guide.

    \n
    • \n
\n
\n
Special Errors
\n
\n

For a list of special errors for this operation, see List of SELECT Object Content Error Codes\n

\n
\n
\n

The following operations are related to SelectObjectContent:

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/{Bucket}/{Key+}?select&select-type=2", + "code": 200 + } + } + }, + "com.amazonaws.s3#SelectObjectContentEventStream": { + "type": "union", + "members": { + "Records": { + "target": "com.amazonaws.s3#RecordsEvent", + "traits": { + "smithy.api#documentation": "

The Records Event.

" + } + }, + "Stats": { + "target": "com.amazonaws.s3#StatsEvent", + "traits": { + "smithy.api#documentation": "

The Stats Event.

" + } + }, + "Progress": { + "target": "com.amazonaws.s3#ProgressEvent", + "traits": { + "smithy.api#documentation": "

The Progress Event.

" + } + }, + "Cont": { + "target": "com.amazonaws.s3#ContinuationEvent", + "traits": { + "smithy.api#documentation": "

The Continuation Event.

" + } + }, + "End": { + "target": "com.amazonaws.s3#EndEvent", + "traits": { + "smithy.api#documentation": "

The End Event.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The container for selecting objects from a content event stream.

", + "smithy.api#streaming": {} + } + }, + "com.amazonaws.s3#SelectObjectContentOutput": { + "type": "structure", + "members": { + "Payload": { + "target": "com.amazonaws.s3#SelectObjectContentEventStream", + "traits": { + "smithy.api#documentation": "

The array of results.

", + "smithy.api#httpPayload": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3#SelectObjectContentRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The S3 bucket.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

The object key.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "traits": { + "smithy.api#documentation": "

The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is needed only when the object was created \n using a checksum algorithm. For more information,\n see Protecting data using SSE-C keys in the\n Amazon S3 User Guide.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + } + }, + "SSECustomerKey": { + "target": "com.amazonaws.s3#SSECustomerKey", + "traits": { + "smithy.api#documentation": "

The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. \n For more information, see\n Protecting data using SSE-C keys in the\n Amazon S3 User Guide.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key" + } + }, + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "traits": { + "smithy.api#documentation": "

The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum \n algorithm. For more information,\n see Protecting data using SSE-C keys in the\n Amazon S3 User Guide.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" + } + }, + "Expression": { + "target": "com.amazonaws.s3#Expression", + "traits": { + "smithy.api#documentation": "

The expression that is used to query the object.

", + "smithy.api#required": {} + } + }, + "ExpressionType": { + "target": "com.amazonaws.s3#ExpressionType", + "traits": { + "smithy.api#documentation": "

The type of the provided expression (for example, SQL).

", + "smithy.api#required": {} + } + }, + "RequestProgress": { + "target": "com.amazonaws.s3#RequestProgress", + "traits": { + "smithy.api#documentation": "

Specifies if periodic request progress information should be enabled.

" + } + }, + "InputSerialization": { + "target": "com.amazonaws.s3#InputSerialization", + "traits": { + "smithy.api#documentation": "

Describes the format of the data in the object that is being queried.

", + "smithy.api#required": {} + } + }, + "OutputSerialization": { + "target": "com.amazonaws.s3#OutputSerialization", + "traits": { + "smithy.api#documentation": "

Describes the format of the data that you want Amazon S3 to return in response.

", + "smithy.api#required": {} + } + }, + "ScanRange": { + "target": "com.amazonaws.s3#ScanRange", + "traits": { + "smithy.api#documentation": "

Specifies the byte range of the object to get the records from. A record is processed\n when its first byte is contained by the range. This parameter is optional, but when\n specified, it must not be empty. See RFC 2616, Section 14.35.1 about how to specify the\n start and end of the range.

\n

\n ScanRangemay be used in the following ways:

\n
    \n
  • \n

    \n 50100\n - process only the records starting between the bytes 50 and 100 (inclusive, counting\n from zero)

    \n
    • \n
  • \n

    \n 50 -\n process only the records starting after the byte 50

    \n
    • \n
  • \n

    \n 50 -\n process only the records within the last 50 bytes of the file.

    \n
    • \n
" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#documentation": "\n

Learn Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can continue to use the feature as usual. Learn more\n

\n \n

Request to filter the contents of an Amazon S3 object based on a simple Structured Query\n Language (SQL) statement. In the request, along with the SQL expression, you must specify a\n data serialization format (JSON or CSV) of the object. Amazon S3 uses this to parse object data\n into records. It returns only records that match the specified SQL expression. You must\n also specify the data serialization format for the response. For more information, see\n S3Select API Documentation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#SelectParameters": { + "type": "structure", + "members": { + "InputSerialization": { + "target": "com.amazonaws.s3#InputSerialization", + "traits": { + "smithy.api#documentation": "

Describes the serialization format of the object.

", + "smithy.api#required": {} + } + }, + "ExpressionType": { + "target": "com.amazonaws.s3#ExpressionType", + "traits": { + "smithy.api#documentation": "

The type of the provided expression (for example, SQL).

", + "smithy.api#required": {} + } + }, + "Expression": { + "target": "com.amazonaws.s3#Expression", + "traits": { + "smithy.api#documentation": "\n

Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can continue to use the feature as usual. Learn more\n

\n \n

The expression that is used to query the object.

", + "smithy.api#required": {} + } + }, + "OutputSerialization": { + "target": "com.amazonaws.s3#OutputSerialization", + "traits": { + "smithy.api#documentation": "

Describes how the results of the Select job are serialized.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "\n

Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can continue to use the feature as usual. Learn more\n

\n \n

Describes the parameters for Select job types.

\n

Learn How to optimize querying your data in Amazon S3 using\n Amazon Athena, S3 Object Lambda, or client-side filtering.

" + } + }, + "com.amazonaws.s3#ServerSideEncryption": { + "type": "enum", + "members": { + "AES256": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AES256" + } + }, + "aws_kms": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "aws:kms" + } + }, + "aws_kms_dsse": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "aws:kms:dsse" + } + } + } + }, + "com.amazonaws.s3#ServerSideEncryptionByDefault": { + "type": "structure", + "members": { + "SSEAlgorithm": { + "target": "com.amazonaws.s3#ServerSideEncryption", + "traits": { + "smithy.api#documentation": "

Server-side encryption algorithm to use for the default encryption.

\n \n

For directory buckets, there are only two supported values for server-side encryption: AES256 and aws:kms.

\n ", + "smithy.api#required": {} + } + }, + "KMSMasterKeyID": { + "target": "com.amazonaws.s3#SSEKMSKeyId", + "traits": { + "smithy.api#documentation": "

Amazon Web Services Key Management Service (KMS) customer managed key ID to use for the default\n encryption.

\n \n
    \n
  • \n

    \n General purpose buckets - This parameter is\n allowed if and only if SSEAlgorithm is set to aws:kms or\n aws:kms:dsse.

    \n
    • \n
  • \n

    \n Directory buckets - This parameter is\n allowed if and only if SSEAlgorithm is set to\n aws:kms.

    \n
    • \n
\n \n

You can specify the key ID, key alias, or the Amazon Resource Name (ARN) of the KMS\n key.

\n
    \n
  • \n

    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Key ARN:\n arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Key Alias: alias/alias-name\n

    \n
    • \n
\n

If you are using encryption with cross-account or Amazon Web Services service operations, you must use\n a fully qualified KMS key ARN. For more information, see Using encryption for cross-account operations.

\n \n
    \n
  • \n

    \n General purpose buckets - If you're specifying\n a customer managed KMS key, we recommend using a fully qualified KMS key ARN.\n If you use a KMS key alias instead, then KMS resolves the key within the\n requester’s account. This behavior can result in data that's encrypted with a\n KMS key that belongs to the requester, and not the bucket owner. Also, if you\n use a key ID, you can run into a LogDestination undeliverable error when creating\n a VPC flow log.

    \n
    • \n
  • \n

    \n Directory buckets -\n When you specify an KMS customer managed key for encryption in your directory bucket, only use the key ID or key ARN. The key alias format of the KMS key isn't supported.

    \n
    • \n
\n \n \n

Amazon S3 only supports symmetric encryption KMS keys. For more information, see Asymmetric keys in Amazon Web Services KMS in the Amazon Web Services Key Management Service\n Developer Guide.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the default server-side encryption to apply to new objects in the bucket. If a\n PUT Object request doesn't specify any server-side encryption, this default encryption will\n be applied. For more information, see PutBucketEncryption.

\n \n
    \n
  • \n

    \n General purpose buckets - If you don't specify\n a customer managed key at configuration, Amazon S3 automatically creates an Amazon Web Services KMS key\n (aws/s3) in your Amazon Web Services account the first time that you add an\n object encrypted with SSE-KMS to a bucket. By default, Amazon S3 uses this KMS key\n for SSE-KMS.

    \n
    • \n
  • \n

    \n Directory buckets -\n Your SSE-KMS configuration can only support 1 customer managed key per directory bucket for the lifetime of the bucket. \nThe Amazon Web Services managed key (aws/s3) isn't supported. \n

    \n
    • \n
  • \n

    \n Directory buckets -\n For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS.

    \n
    • \n
\n " + } + }, + "com.amazonaws.s3#ServerSideEncryptionConfiguration": { + "type": "structure", + "members": { + "Rules": { + "target": "com.amazonaws.s3#ServerSideEncryptionRules", + "traits": { + "smithy.api#documentation": "

Container for information about a particular server-side encryption configuration\n rule.

", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Rule" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the default server-side-encryption configuration.

" + } + }, + "com.amazonaws.s3#ServerSideEncryptionRule": { + "type": "structure", + "members": { + "ApplyServerSideEncryptionByDefault": { + "target": "com.amazonaws.s3#ServerSideEncryptionByDefault", + "traits": { + "smithy.api#documentation": "

Specifies the default server-side encryption to apply to new objects in the bucket. If a\n PUT Object request doesn't specify any server-side encryption, this default encryption will\n be applied.

" + } + }, + "BucketKeyEnabled": { + "target": "com.amazonaws.s3#BucketKeyEnabled", + "traits": { + "smithy.api#documentation": "

Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS\n (SSE-KMS) for new objects in the bucket. Existing objects are not affected. Setting the\n BucketKeyEnabled element to true causes Amazon S3 to use an S3\n Bucket Key.

\n \n
    \n
  • \n

    \n General purpose buckets - By default, S3\n Bucket Key is not enabled. For more information, see Amazon S3 Bucket Keys in the\n Amazon S3 User Guide.

    \n
    • \n
  • \n

    \n Directory buckets -\n S3 Bucket Keys are always enabled for GET and PUT operations in a directory bucket and can’t be disabled. S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets \nto directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through CopyObject, UploadPartCopy, the Copy operation in Batch Operations, or \n the import jobs. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.

    \n
    • \n
\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the default server-side encryption configuration.

\n \n
    \n
  • \n

    \n General purpose buckets - If you're specifying\n a customer managed KMS key, we recommend using a fully qualified KMS key ARN.\n If you use a KMS key alias instead, then KMS resolves the key within the\n requester’s account. This behavior can result in data that's encrypted with a\n KMS key that belongs to the requester, and not the bucket owner.

    \n
    • \n
  • \n

    \n Directory buckets -\n When you specify an KMS customer managed key for encryption in your directory bucket, only use the key ID or key ARN. The key alias format of the KMS key isn't supported.

    \n
    • \n
\n " + } + }, + "com.amazonaws.s3#ServerSideEncryptionRules": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#ServerSideEncryptionRule" + } + }, + "com.amazonaws.s3#SessionCredentialValue": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.s3#SessionCredentials": { + "type": "structure", + "members": { + "AccessKeyId": { + "target": "com.amazonaws.s3#AccessKeyIdValue", + "traits": { + "smithy.api#documentation": "

A unique identifier that's associated with a secret access key. The access key ID and\n the secret access key are used together to sign programmatic Amazon Web Services requests\n cryptographically.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "AccessKeyId" + } + }, + "SecretAccessKey": { + "target": "com.amazonaws.s3#SessionCredentialValue", + "traits": { + "smithy.api#documentation": "

A key that's used with the access key ID to cryptographically sign programmatic Amazon Web Services\n requests. Signing a request identifies the sender and prevents the request from being\n altered.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "SecretAccessKey" + } + }, + "SessionToken": { + "target": "com.amazonaws.s3#SessionCredentialValue", + "traits": { + "smithy.api#documentation": "

A part of the temporary security credentials. The session token is used to validate the\n temporary security credentials.\n \n

", + "smithy.api#required": {}, + "smithy.api#xmlName": "SessionToken" + } + }, + "Expiration": { + "target": "com.amazonaws.s3#SessionExpiration", + "traits": { + "smithy.api#documentation": "

Temporary security credentials expire after a specified interval. After temporary\n credentials expire, any calls that you make with those credentials will fail. So you must\n generate a new set of temporary credentials. Temporary credentials cannot be extended or\n refreshed beyond the original specified interval.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "Expiration" + } + } + }, + "traits": { + "smithy.api#documentation": "

The established temporary security credentials of the session.

\n \n

\n Directory buckets - These session\n credentials are only supported for the authentication and authorization of Zonal endpoint API operations\n on directory buckets.

\n " + } + }, + "com.amazonaws.s3#SessionExpiration": { + "type": "timestamp" + }, + "com.amazonaws.s3#SessionMode": { + "type": "enum", + "members": { + "ReadOnly": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ReadOnly" + } + }, + "ReadWrite": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ReadWrite" + } + } + } + }, + "com.amazonaws.s3#Setting": { + "type": "boolean" + }, + "com.amazonaws.s3#SimplePrefix": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

To use simple format for S3 keys for log objects, set SimplePrefix to an empty\n object.

\n

\n [DestinationPrefix][YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]\n

", + "smithy.api#xmlName": "SimplePrefix" + } + }, + "com.amazonaws.s3#Size": { + "type": "long" + }, + "com.amazonaws.s3#SkipValidation": { + "type": "boolean" + }, + "com.amazonaws.s3#SourceSelectionCriteria": { + "type": "structure", + "members": { + "SseKmsEncryptedObjects": { + "target": "com.amazonaws.s3#SseKmsEncryptedObjects", + "traits": { + "smithy.api#documentation": "

A container for filter information for the selection of Amazon S3 objects encrypted with\n Amazon Web Services KMS. If you include SourceSelectionCriteria in the replication\n configuration, this element is required.

" + } + }, + "ReplicaModifications": { + "target": "com.amazonaws.s3#ReplicaModifications", + "traits": { + "smithy.api#documentation": "

A filter that you can specify for selections for modifications on replicas. Amazon S3 doesn't\n replicate replica modifications by default. In the latest version of replication\n configuration (when Filter is specified), you can specify this element and set\n the status to Enabled to replicate modifications on replicas.

\n \n

If you don't specify the Filter element, Amazon S3 assumes that the\n replication configuration is the earlier version, V1. In the earlier version, this\n element is not allowed

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

A container that describes additional filters for identifying the source objects that\n you want to replicate. You can choose to enable or disable the replication of these\n objects. Currently, Amazon S3 supports only the filter that you can specify for objects created\n with server-side encryption using a customer managed key stored in Amazon Web Services Key Management Service\n (SSE-KMS).

" + } + }, + "com.amazonaws.s3#SseKmsEncryptedObjects": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.s3#SseKmsEncryptedObjectsStatus", + "traits": { + "smithy.api#documentation": "

Specifies whether Amazon S3 replicates objects created with server-side encryption using an\n Amazon Web Services KMS key stored in Amazon Web Services Key Management Service.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A container for filter information for the selection of S3 objects encrypted with Amazon Web Services\n KMS.

" + } + }, + "com.amazonaws.s3#SseKmsEncryptedObjectsStatus": { + "type": "enum", + "members": { + "Enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enabled" + } + }, + "Disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disabled" + } + } + } + }, + "com.amazonaws.s3#Start": { + "type": "long" + }, + "com.amazonaws.s3#StartAfter": { + "type": "string" + }, + "com.amazonaws.s3#Stats": { + "type": "structure", + "members": { + "BytesScanned": { + "target": "com.amazonaws.s3#BytesScanned", + "traits": { + "smithy.api#documentation": "

The total number of object bytes scanned.

" + } + }, + "BytesProcessed": { + "target": "com.amazonaws.s3#BytesProcessed", + "traits": { + "smithy.api#documentation": "

The total number of uncompressed object bytes processed.

" + } + }, + "BytesReturned": { + "target": "com.amazonaws.s3#BytesReturned", + "traits": { + "smithy.api#documentation": "

The total number of bytes of records payload data returned.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Container for the stats details.

" + } + }, + "com.amazonaws.s3#StatsEvent": { + "type": "structure", + "members": { + "Details": { + "target": "com.amazonaws.s3#Stats", + "traits": { + "smithy.api#documentation": "

The Stats event details.

", + "smithy.api#eventPayload": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Container for the Stats Event.

" + } + }, + "com.amazonaws.s3#StorageClass": { + "type": "enum", + "members": { + "STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STANDARD" + } + }, + "REDUCED_REDUNDANCY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REDUCED_REDUNDANCY" + } + }, + "STANDARD_IA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STANDARD_IA" + } + }, + "ONEZONE_IA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ONEZONE_IA" + } + }, + "INTELLIGENT_TIERING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTELLIGENT_TIERING" + } + }, + "GLACIER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GLACIER" + } + }, + "DEEP_ARCHIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEEP_ARCHIVE" + } + }, + "OUTPOSTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OUTPOSTS" + } + }, + "GLACIER_IR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GLACIER_IR" + } + }, + "SNOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SNOW" + } + }, + "EXPRESS_ONEZONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPRESS_ONEZONE" + } + } + } + }, + "com.amazonaws.s3#StorageClassAnalysis": { + "type": "structure", + "members": { + "DataExport": { + "target": "com.amazonaws.s3#StorageClassAnalysisDataExport", + "traits": { + "smithy.api#documentation": "

Specifies how data related to the storage class analysis for an Amazon S3 bucket should be\n exported.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies data related to access patterns to be collected and made available to analyze\n the tradeoffs between different storage classes for an Amazon S3 bucket.

" + } + }, + "com.amazonaws.s3#StorageClassAnalysisDataExport": { + "type": "structure", + "members": { + "OutputSchemaVersion": { + "target": "com.amazonaws.s3#StorageClassAnalysisSchemaVersion", + "traits": { + "smithy.api#documentation": "

The version of the output schema to use when exporting data. Must be\n V_1.

", + "smithy.api#required": {} + } + }, + "Destination": { + "target": "com.amazonaws.s3#AnalyticsExportDestination", + "traits": { + "smithy.api#documentation": "

The place to store the data for an analysis.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Container for data related to the storage class analysis for an Amazon S3 bucket for\n export.

" + } + }, + "com.amazonaws.s3#StorageClassAnalysisSchemaVersion": { + "type": "enum", + "members": { + "V_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "V_1" + } + } + } + }, + "com.amazonaws.s3#StreamingBlob": { + "type": "blob", + "traits": { + "smithy.api#streaming": {} + } + }, + "com.amazonaws.s3#Suffix": { + "type": "string" + }, + "com.amazonaws.s3#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

Name of the object key.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.s3#Value", + "traits": { + "smithy.api#documentation": "

Value of the tag.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A container of a key value name pair.

" + } + }, + "com.amazonaws.s3#TagCount": { + "type": "integer" + }, + "com.amazonaws.s3#TagSet": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#Tag", + "traits": { + "smithy.api#xmlName": "Tag" + } + } + }, + "com.amazonaws.s3#Tagging": { + "type": "structure", + "members": { + "TagSet": { + "target": "com.amazonaws.s3#TagSet", + "traits": { + "smithy.api#documentation": "

A collection for a set of tags

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Container for TagSet elements.

" + } + }, + "com.amazonaws.s3#TaggingDirective": { + "type": "enum", + "members": { + "COPY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COPY" + } + }, + "REPLACE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REPLACE" + } + } + } + }, + "com.amazonaws.s3#TaggingHeader": { + "type": "string" + }, + "com.amazonaws.s3#TargetBucket": { + "type": "string" + }, + "com.amazonaws.s3#TargetGrant": { + "type": "structure", + "members": { + "Grantee": { + "target": "com.amazonaws.s3#Grantee", + "traits": { + "smithy.api#documentation": "

Container for the person being granted permissions.

", + "smithy.api#xmlNamespace": { + "uri": "http://www.w3.org/2001/XMLSchema-instance", + "prefix": "xsi" + } + } + }, + "Permission": { + "target": "com.amazonaws.s3#BucketLogsPermission", + "traits": { + "smithy.api#documentation": "

Logging permissions assigned to the grantee for the bucket.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Container for granting information.

\n

Buckets that use the bucket owner enforced setting for Object Ownership don't support\n target grants. For more information, see Permissions server access log delivery in the\n Amazon S3 User Guide.

" + } + }, + "com.amazonaws.s3#TargetGrants": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#TargetGrant", + "traits": { + "smithy.api#xmlName": "Grant" + } + } + }, + "com.amazonaws.s3#TargetObjectKeyFormat": { + "type": "structure", + "members": { + "SimplePrefix": { + "target": "com.amazonaws.s3#SimplePrefix", + "traits": { + "smithy.api#documentation": "

To use the simple format for S3 keys for log objects. To specify SimplePrefix format,\n set SimplePrefix to {}.

", + "smithy.api#xmlName": "SimplePrefix" + } + }, + "PartitionedPrefix": { + "target": "com.amazonaws.s3#PartitionedPrefix", + "traits": { + "smithy.api#documentation": "

Partitioned S3 key for log objects.

", + "smithy.api#xmlName": "PartitionedPrefix" + } + } + }, + "traits": { + "smithy.api#documentation": "

Amazon S3 key format for log objects. Only one format, PartitionedPrefix or\n SimplePrefix, is allowed.

" + } + }, + "com.amazonaws.s3#TargetPrefix": { + "type": "string" + }, + "com.amazonaws.s3#Tier": { + "type": "enum", + "members": { + "Standard": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Standard" + } + }, + "Bulk": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bulk" + } + }, + "Expedited": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Expedited" + } + } + } + }, + "com.amazonaws.s3#Tiering": { + "type": "structure", + "members": { + "Days": { + "target": "com.amazonaws.s3#IntelligentTieringDays", + "traits": { + "smithy.api#documentation": "

The number of consecutive days of no access after which an object will be eligible to be\n transitioned to the corresponding tier. The minimum number of days specified for\n Archive Access tier must be at least 90 days and Deep Archive Access tier must be at least\n 180 days. The maximum can be up to 2 years (730 days).

", + "smithy.api#required": {} + } + }, + "AccessTier": { + "target": "com.amazonaws.s3#IntelligentTieringAccessTier", + "traits": { + "smithy.api#documentation": "

S3 Intelligent-Tiering access tier. See Storage class\n for automatically optimizing frequently and infrequently accessed objects for a\n list of access tiers in the S3 Intelligent-Tiering storage class.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by\n automatically moving data to the most cost-effective storage access tier, without\n additional operational overhead.

" + } + }, + "com.amazonaws.s3#TieringList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#Tiering" + } + }, + "com.amazonaws.s3#Token": { + "type": "string" + }, + "com.amazonaws.s3#TooManyParts": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

\n You have attempted to add more parts than the maximum of 10000 \n that are allowed for this object. You can use the CopyObject operation \n to copy this object to another and then add more data to the newly copied object.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.s3#TopicArn": { + "type": "string" + }, + "com.amazonaws.s3#TopicConfiguration": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.s3#NotificationId" + }, + "TopicArn": { + "target": "com.amazonaws.s3#TopicArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon SNS topic to which Amazon S3 publishes a message\n when it detects events of the specified type.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "Topic" + } + }, + "Events": { + "target": "com.amazonaws.s3#EventList", + "traits": { + "smithy.api#documentation": "

The Amazon S3 bucket event about which to send notifications. For more information, see\n Supported\n Event Types in the Amazon S3 User Guide.

", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Event" + } + }, + "Filter": { + "target": "com.amazonaws.s3#NotificationConfigurationFilter" + } + }, + "traits": { + "smithy.api#documentation": "

A container for specifying the configuration for publication of messages to an Amazon\n Simple Notification Service (Amazon SNS) topic when Amazon S3 detects specified events.

" + } + }, + "com.amazonaws.s3#TopicConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#TopicConfiguration" + } + }, + "com.amazonaws.s3#Transition": { + "type": "structure", + "members": { + "Date": { + "target": "com.amazonaws.s3#Date", + "traits": { + "smithy.api#documentation": "

Indicates when objects are transitioned to the specified storage class. The date value\n must be in ISO 8601 format. The time is always midnight UTC.

" + } + }, + "Days": { + "target": "com.amazonaws.s3#Days", + "traits": { + "smithy.api#documentation": "

Indicates the number of days after creation when objects are transitioned to the\n specified storage class. The value must be a positive integer.

" + } + }, + "StorageClass": { + "target": "com.amazonaws.s3#TransitionStorageClass", + "traits": { + "smithy.api#documentation": "

The storage class to which you want the object to transition.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies when an object transitions to a specified storage class. For more information\n about Amazon S3 lifecycle configuration rules, see Transitioning\n Objects Using Amazon S3 Lifecycle in the Amazon S3 User Guide.

" + } + }, + "com.amazonaws.s3#TransitionDefaultMinimumObjectSize": { + "type": "enum", + "members": { + "varies_by_storage_class": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "varies_by_storage_class" + } + }, + "all_storage_classes_128K": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "all_storage_classes_128K" + } + } + } + }, + "com.amazonaws.s3#TransitionList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#Transition" + } + }, + "com.amazonaws.s3#TransitionStorageClass": { + "type": "enum", + "members": { + "GLACIER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GLACIER" + } + }, + "STANDARD_IA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STANDARD_IA" + } + }, + "ONEZONE_IA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ONEZONE_IA" + } + }, + "INTELLIGENT_TIERING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTELLIGENT_TIERING" + } + }, + "DEEP_ARCHIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEEP_ARCHIVE" + } + }, + "GLACIER_IR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GLACIER_IR" + } + } + } + }, + "com.amazonaws.s3#Type": { + "type": "enum", + "members": { + "CanonicalUser": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CanonicalUser" + } + }, + "AmazonCustomerByEmail": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AmazonCustomerByEmail" + } + }, + "Group": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Group" + } + } + } + }, + "com.amazonaws.s3#URI": { + "type": "string" + }, + "com.amazonaws.s3#UploadIdMarker": { + "type": "string" + }, + "com.amazonaws.s3#UploadPart": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#UploadPartRequest" + }, + "output": { + "target": "com.amazonaws.s3#UploadPartOutput" + }, + "traits": { + "aws.protocols#httpChecksum": { + "requestAlgorithmMember": "ChecksumAlgorithm" + }, + "smithy.api#documentation": "

Uploads a part in a multipart upload.

\n \n

In this operation, you provide new data as a part of an object in your request.\n However, you have an option to specify your existing Amazon S3 object as a data source for\n the part you are uploading. To upload a part from an existing object, you use the UploadPartCopy operation.

\n \n

You must initiate a multipart upload (see CreateMultipartUpload)\n before you can upload any part. In response to your initiate request, Amazon S3 returns an\n upload ID, a unique identifier that you must include in your upload part request.

\n

Part numbers can be any number from 1 to 10,000, inclusive. A part number uniquely\n identifies a part and also defines its position within the object being created. If you\n upload a new part using the same part number that was used with a previous part, the\n previously uploaded part is overwritten.

\n

For information about maximum and minimum part sizes and other multipart upload\n specifications, see Multipart upload limits in the Amazon S3 User Guide.

\n \n

After you initiate multipart upload and upload one or more parts, you must either\n complete or abort multipart upload in order to stop getting charged for storage of the\n uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up\n the parts storage and stops charging you for the parts storage.

\n \n

For more information on multipart uploads, go to Multipart Upload Overview in the\n Amazon S3 User Guide .

\n \n

\n Directory buckets -\n For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket-name.s3express-zone-id.region-code.amazonaws.com/key-name\n . Path-style requests are not supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the\n Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the\n Amazon S3 User Guide.

\n \n
\n
Permissions
\n
\n
    \n
  • \n

    \n General purpose bucket permissions - To\n perform a multipart upload with encryption using an Key Management Service key, the\n requester must have permission to the kms:Decrypt and\n kms:GenerateDataKey actions on the key. The requester must\n also have permissions for the kms:GenerateDataKey action for\n the CreateMultipartUpload API. Then, the requester needs\n permissions for the kms:Decrypt action on the\n UploadPart and UploadPartCopy APIs.

    \n

    These permissions are required because Amazon S3 must decrypt and read data\n from the encrypted file parts before it completes the multipart upload. For\n more information about KMS permissions, see Protecting data\n using server-side encryption with KMS in the\n Amazon S3 User Guide. For information about the\n permissions required to use the multipart upload API, see Multipart upload and permissions and Multipart upload API and permissions in the\n Amazon S3 User Guide.

    \n
    • \n
  • \n

    \n Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the \n CreateSession\n API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. \nAmazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see \n CreateSession\n .

    \n

    If the object is encrypted with SSE-KMS, you must also have the\n kms:GenerateDataKey and kms:Decrypt permissions\n in IAM identity-based policies and KMS key policies for the KMS\n key.

    \n
    • \n
\n
\n
Data integrity
\n
\n

\n General purpose bucket - To ensure that data\n is not corrupted traversing the network, specify the Content-MD5\n header in the upload part request. Amazon S3 checks the part data against the provided\n MD5 value. If they do not match, Amazon S3 returns an error. If the upload request is\n signed with Signature Version 4, then Amazon Web Services S3 uses the\n x-amz-content-sha256 header as a checksum instead of\n Content-MD5. For more information see Authenticating Requests: Using the Authorization Header (Amazon Web Services Signature\n Version 4).

\n \n

\n Directory buckets - MD5 is not supported by directory buckets. You can use checksum algorithms to check object integrity.

\n \n
\n
Encryption
\n
\n
    \n
  • \n

    \n General purpose bucket - Server-side\n encryption is for data encryption at rest. Amazon S3 encrypts your data as it\n writes it to disks in its data centers and decrypts it when you access it.\n You have mutually exclusive options to protect data using server-side\n encryption in Amazon S3, depending on how you choose to manage the encryption\n keys. Specifically, the encryption key options are Amazon S3 managed keys\n (SSE-S3), Amazon Web Services KMS keys (SSE-KMS), and Customer-Provided Keys (SSE-C).\n Amazon S3 encrypts data with server-side encryption using Amazon S3 managed keys\n (SSE-S3) by default. You can optionally tell Amazon S3 to encrypt data at rest\n using server-side encryption with other key options. The option you use\n depends on whether you want to use KMS keys (SSE-KMS) or provide your own\n encryption key (SSE-C).

    \n

    Server-side encryption is supported by the S3 Multipart Upload\n operations. Unless you are using a customer-provided encryption key (SSE-C),\n you don't need to specify the encryption parameters in each UploadPart\n request. Instead, you only need to specify the server-side encryption\n parameters in the initial Initiate Multipart request. For more information,\n see CreateMultipartUpload.

    \n

    If you request server-side encryption using a customer-provided\n encryption key (SSE-C) in your initiate multipart upload request, you must\n provide identical encryption information in each part upload using the\n following request headers.

    \n
      \n
    • \n

      x-amz-server-side-encryption-customer-algorithm

      \n
      • \n
    • \n

      x-amz-server-side-encryption-customer-key

      \n
      • \n
    • \n

      x-amz-server-side-encryption-customer-key-MD5

      \n
      • \n
    \n

    For more information, see Using\n Server-Side Encryption in the\n Amazon S3 User Guide.

    \n
    • \n
  • \n

    \n Directory buckets -\n For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (aws:kms).

    \n
    • \n
\n
\n
Special errors
\n
\n
    \n
  • \n

    Error Code: NoSuchUpload\n

    \n
      \n
    • \n

      Description: The specified multipart upload does not exist. The\n upload ID might be invalid, or the multipart upload might have been\n aborted or completed.

      \n
      • \n
    • \n

      HTTP Status Code: 404 Not Found

      \n
      • \n
    • \n

      SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
\n
\n
HTTP Host header syntax
\n
\n

\n Directory buckets - The HTTP Host header syntax is \n Bucket-name.s3express-zone-id.region-code.amazonaws.com.

\n
\n
\n

The following operations are related to UploadPart:

\n ", + "smithy.api#examples": [ + { + "title": "To upload a part", + "documentation": "The following example uploads part 1 of a multipart upload. The example specifies a file name for the part data. The Upload ID is same that is returned by the initiate multipart upload.", + "input": { + "Body": "fileToUpload", + "Bucket": "examplebucket", + "Key": "examplelargeobject", + "PartNumber": 1, + "UploadId": "xadcOB_7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--" + }, + "output": { + "ETag": "\"d8c2eafd90c266e19ab9dcacc479f8af\"" + } + } + ], + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}/{Key+}?x-id=UploadPart", + "code": 200 + } + } + }, + "com.amazonaws.s3#UploadPartCopy": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#UploadPartCopyRequest" + }, + "output": { + "target": "com.amazonaws.s3#UploadPartCopyOutput" + }, + "traits": { + "smithy.api#documentation": "

Uploads a part by copying data from an existing object as data source. To specify the\n data source, you add the request header x-amz-copy-source in your request. To\n specify a byte range, you add the request header x-amz-copy-source-range in\n your request.

\n

For information about maximum and minimum part sizes and other multipart upload\n specifications, see Multipart upload limits in the Amazon S3 User Guide.

\n \n

Instead of copying data from an existing object as part data, you might use the\n UploadPart action to upload new data as a part of an object in your\n request.

\n \n

You must initiate a multipart upload before you can upload any part. In response to your\n initiate request, Amazon S3 returns the upload ID, a unique identifier that you must include in\n your upload part request.

\n

For conceptual information about multipart uploads, see Uploading Objects Using Multipart\n Upload in the Amazon S3 User Guide. For information about\n copying objects using a single atomic action vs. a multipart upload, see Operations on\n Objects in the Amazon S3 User Guide.

\n \n

\n Directory buckets -\n For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket-name.s3express-zone-id.region-code.amazonaws.com/key-name\n . Path-style requests are not supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the\n Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the\n Amazon S3 User Guide.

\n \n
\n
Authentication and authorization
\n
\n

All UploadPartCopy requests must be authenticated and signed by\n using IAM credentials (access key ID and secret access key for the IAM\n identities). All headers with the x-amz- prefix, including\n x-amz-copy-source, must be signed. For more information, see\n REST Authentication.

\n

\n Directory buckets - You must use IAM\n credentials to authenticate and authorize your access to the\n UploadPartCopy API operation, instead of using the temporary\n security credentials through the CreateSession API operation.

\n

Amazon Web Services CLI or SDKs handles authentication and authorization on your\n behalf.

\n
\n
Permissions
\n
\n

You must have READ access to the source object and\n WRITE access to the destination bucket.

\n
    \n
  • \n

    \n General purpose bucket permissions - You\n must have the permissions in a policy based on the bucket types of your\n source bucket and destination bucket in an UploadPartCopy\n operation.

    \n
      \n
    • \n

      If the source object is in a general purpose bucket, you must have the\n \n s3:GetObject\n \n permission to read the source object that is being copied.

      \n
      • \n
    • \n

      If the destination bucket is a general purpose bucket, you must have the\n \n s3:PutObject\n \n permission to write the object copy to the destination bucket.

      \n
      • \n
    • \n

      To perform a multipart upload with encryption using an Key Management Service\n key, the requester must have permission to the\n kms:Decrypt and kms:GenerateDataKey\n actions on the key. The requester must also have permissions for the\n kms:GenerateDataKey action for the\n CreateMultipartUpload API. Then, the requester needs\n permissions for the kms:Decrypt action on the\n UploadPart and UploadPartCopy APIs. These\n permissions are required because Amazon S3 must decrypt and read data from\n the encrypted file parts before it completes the multipart upload. For\n more information about KMS permissions, see Protecting\n data using server-side encryption with KMS in the\n Amazon S3 User Guide. For information about the\n permissions required to use the multipart upload API, see Multipart upload\n and permissions and Multipart upload API and permissions in the\n Amazon S3 User Guide.

      \n
      • \n
    \n
    • \n
  • \n

    \n Directory bucket permissions -\n You must have permissions in a bucket policy or an IAM identity-based policy based on the\n source and destination bucket types in an UploadPartCopy\n operation.

    \n
      \n
    • \n

      If the source object that you want to copy is in a\n directory bucket, you must have the \n s3express:CreateSession\n permission in\n the Action element of a policy to read the object. By\n default, the session is in the ReadWrite mode. If you\n want to restrict the access, you can explicitly set the\n s3express:SessionMode condition key to\n ReadOnly on the copy source bucket.

      \n
      • \n
    • \n

      If the copy destination is a directory bucket, you must have the\n \n s3express:CreateSession\n permission in the\n Action element of a policy to write the object to the\n destination. The s3express:SessionMode condition key\n cannot be set to ReadOnly on the copy destination.\n

      \n
      • \n
    \n

    If the object is encrypted with SSE-KMS, you must also have the\n kms:GenerateDataKey and kms:Decrypt permissions\n in IAM identity-based policies and KMS key policies for the KMS\n key.

    \n

    For example policies, see Example bucket policies for S3 Express One Zone and Amazon Web Services Identity and Access Management (IAM) identity-based policies for\n S3 Express One Zone in the Amazon S3 User Guide.

    \n
    • \n
\n
\n
Encryption
\n
\n
    \n
  • \n

    \n General purpose buckets -\n For information about using\n server-side encryption with customer-provided encryption keys with the\n UploadPartCopy operation, see CopyObject and\n UploadPart.

    \n
    • \n
  • \n

    \n Directory buckets -\n For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (aws:kms). For more\n information, see Protecting data with server-side encryption in the Amazon S3 User Guide.

    \n \n

    For directory buckets, when you perform a\n CreateMultipartUpload operation and an\n UploadPartCopy operation, the request headers you provide\n in the CreateMultipartUpload request must match the default\n encryption configuration of the destination bucket.

    \n     \n

    S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets \nto directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through UploadPartCopy. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.

    \n
    • \n
\n
\n
Special errors
\n
\n
    \n
  • \n

    Error Code: NoSuchUpload\n

    \n
      \n
    • \n

      Description: The specified multipart upload does not exist. The\n upload ID might be invalid, or the multipart upload might have been\n aborted or completed.

      \n
      • \n
    • \n

      HTTP Status Code: 404 Not Found

      \n
      • \n
    \n
    • \n
  • \n

    Error Code: InvalidRequest\n

    \n
      \n
    • \n

      Description: The specified copy source is not supported as a\n byte-range copy source.

      \n
      • \n
    • \n

      HTTP Status Code: 400 Bad Request

      \n
      • \n
    \n
    • \n
\n
\n
HTTP Host header syntax
\n
\n

\n Directory buckets - The HTTP Host header syntax is \n Bucket-name.s3express-zone-id.region-code.amazonaws.com.

\n
\n
\n

The following operations are related to UploadPartCopy:

\n ", + "smithy.api#examples": [ + { + "title": "To upload a part by copying byte range from an existing object as data source", + "documentation": "The following example uploads a part of a multipart upload by copying a specified byte range from an existing object as data source.", + "input": { + "Bucket": "examplebucket", + "CopySource": "/bucketname/sourceobjectkey", + "CopySourceRange": "bytes=1-100000", + "Key": "examplelargeobject", + "PartNumber": 2, + "UploadId": "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--" + }, + "output": { + "CopyPartResult": { + "LastModified": "2016-12-29T21:44:28.000Z", + "ETag": "\"65d16d19e65a7508a51f043180edcc36\"" + } + } + }, + { + "title": "To upload a part by copying data from an existing object as data source", + "documentation": "The following example uploads a part of a multipart upload by copying data from an existing object as data source.", + "input": { + "Bucket": "examplebucket", + "CopySource": "/bucketname/sourceobjectkey", + "Key": "examplelargeobject", + "PartNumber": 1, + "UploadId": "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--" + }, + "output": { + "CopyPartResult": { + "LastModified": "2016-12-29T21:24:43.000Z", + "ETag": "\"b0c6f0e7e054ab8fa2536a2677f8734d\"" + } + } + } + ], + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}/{Key+}?x-id=UploadPartCopy", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "DisableS3ExpressSessionAuth": { + "value": true + } + } + } + }, + "com.amazonaws.s3#UploadPartCopyOutput": { + "type": "structure", + "members": { + "CopySourceVersionId": { + "target": "com.amazonaws.s3#CopySourceVersionId", + "traits": { + "smithy.api#documentation": "

The version of the source object that was copied, if you have enabled versioning on the\n source bucket.

\n \n

This functionality is not supported when the source object is in a directory bucket.

\n ", + "smithy.api#httpHeader": "x-amz-copy-source-version-id" + } + }, + "CopyPartResult": { + "target": "com.amazonaws.s3#CopyPartResult", + "traits": { + "smithy.api#documentation": "

Container for all response elements.

", + "smithy.api#httpPayload": {} + } + }, + "ServerSideEncryption": { + "target": "com.amazonaws.s3#ServerSideEncryption", + "traits": { + "smithy.api#documentation": "

The server-side encryption algorithm used when you store this object in Amazon S3 (for\n example, AES256, aws:kms).

", + "smithy.api#httpHeader": "x-amz-server-side-encryption" + } + }, + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "traits": { + "smithy.api#documentation": "

If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to confirm the encryption algorithm that's used.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + } + }, + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "traits": { + "smithy.api#documentation": "

If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to provide the round-trip message integrity verification\n of the customer-provided encryption key.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" + } + }, + "SSEKMSKeyId": { + "target": "com.amazonaws.s3#SSEKMSKeyId", + "traits": { + "smithy.api#documentation": "

If present, indicates the ID of the KMS key that was used for object encryption.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" + } + }, + "BucketKeyEnabled": { + "target": "com.amazonaws.s3#BucketKeyEnabled", + "traits": { + "smithy.api#documentation": "

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption\n with Key Management Service (KMS) keys (SSE-KMS).

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" + } + }, + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3#UploadPartCopyRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name.

\n

\n Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n \n

Copying objects across different Amazon Web Services Regions isn't supported when the source or destination bucket is in Amazon Web Services Local Zones. The source and destination buckets must have the same parent Amazon Web Services Region. Otherwise, \n you get an HTTP 400 Bad Request error with the error code InvalidRequest.

\n \n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n \n

Access points and Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "CopySource": { + "target": "com.amazonaws.s3#CopySource", + "traits": { + "smithy.api#documentation": "

Specifies the source object for the copy operation. You specify the value in one of two\n formats, depending on whether you want to access the source object through an access point:

\n
    \n
  • \n

    For objects not accessed through an access point, specify the name of the source bucket\n and key of the source object, separated by a slash (/). For example, to copy the\n object reports/january.pdf from the bucket\n awsexamplebucket, use awsexamplebucket/reports/january.pdf.\n The value must be URL-encoded.

    \n
    • \n
  • \n

    For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:::accesspoint//object/. For example, to copy the object reports/january.pdf through access point my-access-point owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The value must be URL encoded.

    \n \n
      \n
    • \n

      Amazon S3 supports copy operations using Access points only when the source and destination buckets are in the same Amazon Web Services Region.

      \n
      • \n
    • \n

      Access points are not supported by directory buckets.

      \n
      • \n
    \n     \n

    Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:::outpost//object/. For example, to copy the object reports/january.pdf through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. The value must be URL-encoded.

    \n
    • \n
\n

If your bucket has versioning enabled, you could have multiple versions of the same\n object. By default, x-amz-copy-source identifies the current version of the\n source object to copy. To copy a specific version of the source object to copy, append\n ?versionId= to the x-amz-copy-source request\n header (for example, x-amz-copy-source:\n /awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893).

\n

If the current version is a delete marker and you don't specify a versionId in the\n x-amz-copy-source request header, Amazon S3 returns a 404 Not Found\n error, because the object does not exist. If you specify versionId in the\n x-amz-copy-source and the versionId is a delete marker, Amazon S3 returns an\n HTTP 400 Bad Request error, because you are not allowed to specify a delete\n marker as a version for the x-amz-copy-source.

\n \n

\n Directory buckets -\n S3 Versioning isn't enabled and supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-copy-source", + "smithy.api#required": {} + } + }, + "CopySourceIfMatch": { + "target": "com.amazonaws.s3#CopySourceIfMatch", + "traits": { + "smithy.api#documentation": "

Copies the object if its entity tag (ETag) matches the specified tag.

\n

If both of the x-amz-copy-source-if-match and\n x-amz-copy-source-if-unmodified-since headers are present in the request as\n follows:

\n

\n x-amz-copy-source-if-match condition evaluates to true,\n and;

\n

\n x-amz-copy-source-if-unmodified-since condition evaluates to\n false;

\n

Amazon S3 returns 200 OK and copies the data.\n

", + "smithy.api#httpHeader": "x-amz-copy-source-if-match" + } + }, + "CopySourceIfModifiedSince": { + "target": "com.amazonaws.s3#CopySourceIfModifiedSince", + "traits": { + "smithy.api#documentation": "

Copies the object if it has been modified since the specified time.

\n

If both of the x-amz-copy-source-if-none-match and\n x-amz-copy-source-if-modified-since headers are present in the request as\n follows:

\n

\n x-amz-copy-source-if-none-match condition evaluates to false,\n and;

\n

\n x-amz-copy-source-if-modified-since condition evaluates to\n true;

\n

Amazon S3 returns 412 Precondition Failed response code.\n

", + "smithy.api#httpHeader": "x-amz-copy-source-if-modified-since" + } + }, + "CopySourceIfNoneMatch": { + "target": "com.amazonaws.s3#CopySourceIfNoneMatch", + "traits": { + "smithy.api#documentation": "

Copies the object if its entity tag (ETag) is different than the specified ETag.

\n

If both of the x-amz-copy-source-if-none-match and\n x-amz-copy-source-if-modified-since headers are present in the request as\n follows:

\n

\n x-amz-copy-source-if-none-match condition evaluates to false,\n and;

\n

\n x-amz-copy-source-if-modified-since condition evaluates to\n true;

\n

Amazon S3 returns 412 Precondition Failed response code.\n

", + "smithy.api#httpHeader": "x-amz-copy-source-if-none-match" + } + }, + "CopySourceIfUnmodifiedSince": { + "target": "com.amazonaws.s3#CopySourceIfUnmodifiedSince", + "traits": { + "smithy.api#documentation": "

Copies the object if it hasn't been modified since the specified time.

\n

If both of the x-amz-copy-source-if-match and\n x-amz-copy-source-if-unmodified-since headers are present in the request as\n follows:

\n

\n x-amz-copy-source-if-match condition evaluates to true,\n and;

\n

\n x-amz-copy-source-if-unmodified-since condition evaluates to\n false;

\n

Amazon S3 returns 200 OK and copies the data.\n

", + "smithy.api#httpHeader": "x-amz-copy-source-if-unmodified-since" + } + }, + "CopySourceRange": { + "target": "com.amazonaws.s3#CopySourceRange", + "traits": { + "smithy.api#documentation": "

The range of bytes to copy from the source object. The range value must use the form\n bytes=first-last, where the first and last are the zero-based byte offsets to copy. For\n example, bytes=0-9 indicates that you want to copy the first 10 bytes of the source. You\n can copy a range only if the source object is greater than 5 MB.

", + "smithy.api#httpHeader": "x-amz-copy-source-range" + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

Object key for which the multipart upload was initiated.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "PartNumber": { + "target": "com.amazonaws.s3#PartNumber", + "traits": { + "smithy.api#documentation": "

Part number of part being copied. This is a positive integer between 1 and\n 10,000.

", + "smithy.api#httpQuery": "partNumber", + "smithy.api#required": {} + } + }, + "UploadId": { + "target": "com.amazonaws.s3#MultipartUploadId", + "traits": { + "smithy.api#documentation": "

Upload ID identifying the multipart upload whose part is being copied.

", + "smithy.api#httpQuery": "uploadId", + "smithy.api#required": {} + } + }, + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "traits": { + "smithy.api#documentation": "

Specifies the algorithm to use when encrypting the object (for example, AES256).

\n \n

This functionality is not supported when the destination bucket is a directory bucket.

\n ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + } + }, + "SSECustomerKey": { + "target": "com.amazonaws.s3#SSECustomerKey", + "traits": { + "smithy.api#documentation": "

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This\n value is used to store the object and then it is discarded; Amazon S3 does not store the\n encryption key. The key must be appropriate for use with the algorithm specified in the\n x-amz-server-side-encryption-customer-algorithm header. This must be the\n same encryption key specified in the initiate multipart upload request.

\n \n

This functionality is not supported when the destination bucket is a directory bucket.

\n ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key" + } + }, + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "traits": { + "smithy.api#documentation": "

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n this header for a message integrity check to ensure that the encryption key was transmitted\n without error.

\n \n

This functionality is not supported when the destination bucket is a directory bucket.

\n ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" + } + }, + "CopySourceSSECustomerAlgorithm": { + "target": "com.amazonaws.s3#CopySourceSSECustomerAlgorithm", + "traits": { + "smithy.api#documentation": "

Specifies the algorithm to use when decrypting the source object (for example,\n AES256).

\n \n

This functionality is not supported when the source object is in a directory bucket.

\n ", + "smithy.api#httpHeader": "x-amz-copy-source-server-side-encryption-customer-algorithm" + } + }, + "CopySourceSSECustomerKey": { + "target": "com.amazonaws.s3#CopySourceSSECustomerKey", + "traits": { + "smithy.api#documentation": "

Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source\n object. The encryption key provided in this header must be one that was used when the\n source object was created.

\n \n

This functionality is not supported when the source object is in a directory bucket.

\n ", + "smithy.api#httpHeader": "x-amz-copy-source-server-side-encryption-customer-key" + } + }, + "CopySourceSSECustomerKeyMD5": { + "target": "com.amazonaws.s3#CopySourceSSECustomerKeyMD5", + "traits": { + "smithy.api#documentation": "

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n this header for a message integrity check to ensure that the encryption key was transmitted\n without error.

\n \n

This functionality is not supported when the source object is in a directory bucket.

\n ", + "smithy.api#httpHeader": "x-amz-copy-source-server-side-encryption-customer-key-MD5" + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected destination bucket owner. If the account ID that you provide does not match the actual owner of the destination bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + }, + "ExpectedSourceBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected source bucket owner. If the account ID that you provide does not match the actual owner of the source bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-source-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#UploadPartOutput": { + "type": "structure", + "members": { + "ServerSideEncryption": { + "target": "com.amazonaws.s3#ServerSideEncryption", + "traits": { + "smithy.api#documentation": "

The server-side encryption algorithm used when you store this object in Amazon S3 (for\n example, AES256, aws:kms).

", + "smithy.api#httpHeader": "x-amz-server-side-encryption" + } + }, + "ETag": { + "target": "com.amazonaws.s3#ETag", + "traits": { + "smithy.api#documentation": "

Entity tag for the uploaded object.

", + "smithy.api#httpHeader": "ETag" + } + }, + "ChecksumCRC32": { + "target": "com.amazonaws.s3#ChecksumCRC32", + "traits": { + "smithy.api#documentation": "

The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

", + "smithy.api#httpHeader": "x-amz-checksum-crc32" + } + }, + "ChecksumCRC32C": { + "target": "com.amazonaws.s3#ChecksumCRC32C", + "traits": { + "smithy.api#documentation": "

The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

", + "smithy.api#httpHeader": "x-amz-checksum-crc32c" + } + }, + "ChecksumSHA1": { + "target": "com.amazonaws.s3#ChecksumSHA1", + "traits": { + "smithy.api#documentation": "

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded\n with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

", + "smithy.api#httpHeader": "x-amz-checksum-sha1" + } + }, + "ChecksumSHA256": { + "target": "com.amazonaws.s3#ChecksumSHA256", + "traits": { + "smithy.api#documentation": "

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

", + "smithy.api#httpHeader": "x-amz-checksum-sha256" + } + }, + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "traits": { + "smithy.api#documentation": "

If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to confirm the encryption algorithm that's used.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + } + }, + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "traits": { + "smithy.api#documentation": "

If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to provide the round-trip message integrity verification\n of the customer-provided encryption key.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" + } + }, + "SSEKMSKeyId": { + "target": "com.amazonaws.s3#SSEKMSKeyId", + "traits": { + "smithy.api#documentation": "

If present, indicates the ID of the KMS key that was used for object encryption.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" + } + }, + "BucketKeyEnabled": { + "target": "com.amazonaws.s3#BucketKeyEnabled", + "traits": { + "smithy.api#documentation": "

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption\n with Key Management Service (KMS) keys (SSE-KMS).

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" + } + }, + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3#UploadPartRequest": { + "type": "structure", + "members": { + "Body": { + "target": "com.amazonaws.s3#StreamingBlob", + "traits": { + "smithy.api#default": "", + "smithy.api#documentation": "

Object data.

", + "smithy.api#httpPayload": {} + } + }, + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket to which the multipart upload was initiated.

\n

\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n \n

Access points and Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ContentLength": { + "target": "com.amazonaws.s3#ContentLength", + "traits": { + "smithy.api#documentation": "

Size of the body in bytes. This parameter is useful when the size of the body cannot be\n determined automatically.

", + "smithy.api#httpHeader": "Content-Length" + } + }, + "ContentMD5": { + "target": "com.amazonaws.s3#ContentMD5", + "traits": { + "smithy.api#documentation": "

The base64-encoded 128-bit MD5 digest of the part data. This parameter is auto-populated\n when using the command from the CLI. This parameter is required if object lock parameters\n are specified.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "Content-MD5" + } + }, + "ChecksumAlgorithm": { + "target": "com.amazonaws.s3#ChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any\n additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or\n x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more\n information, see Checking object integrity in\n the Amazon S3 User Guide.

\n

If you provide an individual checksum, Amazon S3 ignores any provided\n ChecksumAlgorithm parameter.

\n

This checksum algorithm must be the same for all parts and it match the checksum value\n supplied in the CreateMultipartUpload request.

", + "smithy.api#httpHeader": "x-amz-sdk-checksum-algorithm" + } + }, + "ChecksumCRC32": { + "target": "com.amazonaws.s3#ChecksumCRC32", + "traits": { + "smithy.api#documentation": "

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.\n This header specifies the base64-encoded, 32-bit CRC-32 checksum of the object. For more information, see\n Checking object integrity in the\n Amazon S3 User Guide.

", + "smithy.api#httpHeader": "x-amz-checksum-crc32" + } + }, + "ChecksumCRC32C": { + "target": "com.amazonaws.s3#ChecksumCRC32C", + "traits": { + "smithy.api#documentation": "

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.\n This header specifies the base64-encoded, 32-bit CRC-32C checksum of the object. For more information, see\n Checking object integrity in the\n Amazon S3 User Guide.

", + "smithy.api#httpHeader": "x-amz-checksum-crc32c" + } + }, + "ChecksumSHA1": { + "target": "com.amazonaws.s3#ChecksumSHA1", + "traits": { + "smithy.api#documentation": "

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.\n This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see\n Checking object integrity in the\n Amazon S3 User Guide.

", + "smithy.api#httpHeader": "x-amz-checksum-sha1" + } + }, + "ChecksumSHA256": { + "target": "com.amazonaws.s3#ChecksumSHA256", + "traits": { + "smithy.api#documentation": "

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.\n This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see\n Checking object integrity in the\n Amazon S3 User Guide.

", + "smithy.api#httpHeader": "x-amz-checksum-sha256" + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

Object key for which the multipart upload was initiated.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Key" + } + } + }, + "PartNumber": { + "target": "com.amazonaws.s3#PartNumber", + "traits": { + "smithy.api#documentation": "

Part number of part being uploaded. This is a positive integer between 1 and\n 10,000.

", + "smithy.api#httpQuery": "partNumber", + "smithy.api#required": {} + } + }, + "UploadId": { + "target": "com.amazonaws.s3#MultipartUploadId", + "traits": { + "smithy.api#documentation": "

Upload ID identifying the multipart upload whose part is being uploaded.

", + "smithy.api#httpQuery": "uploadId", + "smithy.api#required": {} + } + }, + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "traits": { + "smithy.api#documentation": "

Specifies the algorithm to use when encrypting the object (for example, AES256).

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + } + }, + "SSECustomerKey": { + "target": "com.amazonaws.s3#SSECustomerKey", + "traits": { + "smithy.api#documentation": "

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This\n value is used to store the object and then it is discarded; Amazon S3 does not store the\n encryption key. The key must be appropriate for use with the algorithm specified in the\n x-amz-server-side-encryption-customer-algorithm header. This must be the\n same encryption key specified in the initiate multipart upload request.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key" + } + }, + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "traits": { + "smithy.api#documentation": "

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n this header for a message integrity check to ensure that the encryption key was transmitted\n without error.

\n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#UserMetadata": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#MetadataEntry", + "traits": { + "smithy.api#xmlName": "MetadataEntry" + } + } + }, + "com.amazonaws.s3#Value": { + "type": "string" + }, + "com.amazonaws.s3#VersionCount": { + "type": "integer" + }, + "com.amazonaws.s3#VersionIdMarker": { + "type": "string" + }, + "com.amazonaws.s3#VersioningConfiguration": { + "type": "structure", + "members": { + "MFADelete": { + "target": "com.amazonaws.s3#MFADelete", + "traits": { + "smithy.api#documentation": "

Specifies whether MFA delete is enabled in the bucket versioning configuration. This\n element is only returned if the bucket has been configured with MFA delete. If the bucket\n has never been so configured, this element is not returned.

", + "smithy.api#xmlName": "MfaDelete" + } + }, + "Status": { + "target": "com.amazonaws.s3#BucketVersioningStatus", + "traits": { + "smithy.api#documentation": "

The versioning state of the bucket.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the versioning state of an Amazon S3 bucket. For more information, see PUT\n Bucket versioning in the Amazon S3 API Reference.

" + } + }, + "com.amazonaws.s3#WebsiteConfiguration": { + "type": "structure", + "members": { + "ErrorDocument": { + "target": "com.amazonaws.s3#ErrorDocument", + "traits": { + "smithy.api#documentation": "

The name of the error document for the website.

" + } + }, + "IndexDocument": { + "target": "com.amazonaws.s3#IndexDocument", + "traits": { + "smithy.api#documentation": "

The name of the index document for the website.

" + } + }, + "RedirectAllRequestsTo": { + "target": "com.amazonaws.s3#RedirectAllRequestsTo", + "traits": { + "smithy.api#documentation": "

The redirect behavior for every request to this bucket's website endpoint.

\n \n

If you specify this property, you can't specify any other property.

\n " + } + }, + "RoutingRules": { + "target": "com.amazonaws.s3#RoutingRules", + "traits": { + "smithy.api#documentation": "

Rules that define when a redirect is applied and the redirect behavior.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies website configuration parameters for an Amazon S3 bucket.

" + } + }, + "com.amazonaws.s3#WebsiteRedirectLocation": { + "type": "string" + }, + "com.amazonaws.s3#WriteGetObjectResponse": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#WriteGetObjectResponseRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "aws.auth#unsignedPayload": {}, + "smithy.api#auth": [ + "aws.auth#sigv4" + ], + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Passes transformed objects to a GetObject operation when using Object Lambda access points. For\n information about Object Lambda access points, see Transforming objects with\n Object Lambda access points in the Amazon S3 User Guide.

\n

This operation supports metadata that can be returned by GetObject, in addition to\n RequestRoute, RequestToken, StatusCode,\n ErrorCode, and ErrorMessage. The GetObject\n response metadata is supported so that the WriteGetObjectResponse caller,\n typically an Lambda function, can provide the same metadata when it internally invokes\n GetObject. When WriteGetObjectResponse is called by a\n customer-owned Lambda function, the metadata returned to the end user\n GetObject call might differ from what Amazon S3 would normally return.

\n

You can include any number of metadata headers. When including a metadata header, it\n should be prefaced with x-amz-meta. For example,\n x-amz-meta-my-custom-header: MyCustomValue. The primary use case for this\n is to forward GetObject metadata.

\n

Amazon Web Services provides some prebuilt Lambda functions that you can use with S3 Object Lambda to\n detect and redact personally identifiable information (PII) and decompress S3 objects.\n These Lambda functions are available in the Amazon Web Services Serverless Application Repository, and\n can be selected through the Amazon Web Services Management Console when you create your Object Lambda access point.

\n

Example 1: PII Access Control - This Lambda function uses Amazon Comprehend, a\n natural language processing (NLP) service using machine learning to find insights and\n relationships in text. It automatically detects personally identifiable information (PII)\n such as names, addresses, dates, credit card numbers, and social security numbers from\n documents in your Amazon S3 bucket.

\n

Example 2: PII Redaction - This Lambda function uses Amazon Comprehend, a natural\n language processing (NLP) service using machine learning to find insights and relationships\n in text. It automatically redacts personally identifiable information (PII) such as names,\n addresses, dates, credit card numbers, and social security numbers from documents in your\n Amazon S3 bucket.

\n

Example 3: Decompression - The Lambda function S3ObjectLambdaDecompression, is\n equipped to decompress objects stored in S3 in one of six compressed file formats including\n bzip2, gzip, snappy, zlib, zstandard and ZIP.

\n

For information on how to view and use these functions, see Using Amazon Web Services built Lambda\n functions in the Amazon S3 User Guide.

", + "smithy.api#endpoint": { + "hostPrefix": "{RequestRoute}." + }, + "smithy.api#http": { + "method": "POST", + "uri": "/WriteGetObjectResponse", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseObjectLambdaEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#WriteGetObjectResponseRequest": { + "type": "structure", + "members": { + "RequestRoute": { + "target": "com.amazonaws.s3#RequestRoute", + "traits": { + "smithy.api#documentation": "

Route prefix to the HTTP URL generated.

", + "smithy.api#hostLabel": {}, + "smithy.api#httpHeader": "x-amz-request-route", + "smithy.api#required": {} + } + }, + "RequestToken": { + "target": "com.amazonaws.s3#RequestToken", + "traits": { + "smithy.api#documentation": "

A single use encrypted token that maps WriteGetObjectResponse to the end\n user GetObject request.

", + "smithy.api#httpHeader": "x-amz-request-token", + "smithy.api#required": {} + } + }, + "Body": { + "target": "com.amazonaws.s3#StreamingBlob", + "traits": { + "smithy.api#default": "", + "smithy.api#documentation": "

The object data.

", + "smithy.api#httpPayload": {} + } + }, + "StatusCode": { + "target": "com.amazonaws.s3#GetObjectResponseStatusCode", + "traits": { + "smithy.api#documentation": "

The integer status code for an HTTP response of a corresponding GetObject\n request. The following is a list of status codes.

\n
    \n
  • \n

    \n 200 - OK\n

    \n
    • \n
  • \n

    \n 206 - Partial Content\n

    \n
    • \n
  • \n

    \n 304 - Not Modified\n

    \n
    • \n
  • \n

    \n 400 - Bad Request\n

    \n
    • \n
  • \n

    \n 401 - Unauthorized\n

    \n
    • \n
  • \n

    \n 403 - Forbidden\n

    \n
    • \n
  • \n

    \n 404 - Not Found\n

    \n
    • \n
  • \n

    \n 405 - Method Not Allowed\n

    \n
    • \n
  • \n

    \n 409 - Conflict\n

    \n
    • \n
  • \n

    \n 411 - Length Required\n

    \n
    • \n
  • \n

    \n 412 - Precondition Failed\n

    \n
    • \n
  • \n

    \n 416 - Range Not Satisfiable\n

    \n
    • \n
  • \n

    \n 500 - Internal Server Error\n

    \n
    • \n
  • \n

    \n 503 - Service Unavailable\n

    \n
    • \n
", + "smithy.api#httpHeader": "x-amz-fwd-status" + } + }, + "ErrorCode": { + "target": "com.amazonaws.s3#ErrorCode", + "traits": { + "smithy.api#documentation": "

A string that uniquely identifies an error condition. Returned in the tag\n of the error XML response for a corresponding GetObject call. Cannot be used\n with a successful StatusCode header or when the transformed object is provided\n in the body. All error codes from S3 are sentence-cased. The regular expression (regex)\n value is \"^[A-Z][a-zA-Z]+$\".

", + "smithy.api#httpHeader": "x-amz-fwd-error-code" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.s3#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Contains a generic description of the error condition. Returned in the \n tag of the error XML response for a corresponding GetObject call. Cannot be\n used with a successful StatusCode header or when the transformed object is\n provided in body.

", + "smithy.api#httpHeader": "x-amz-fwd-error-message" + } + }, + "AcceptRanges": { + "target": "com.amazonaws.s3#AcceptRanges", + "traits": { + "smithy.api#documentation": "

Indicates that a range of bytes was specified.

", + "smithy.api#httpHeader": "x-amz-fwd-header-accept-ranges" + } + }, + "CacheControl": { + "target": "com.amazonaws.s3#CacheControl", + "traits": { + "smithy.api#documentation": "

Specifies caching behavior along the request/reply chain.

", + "smithy.api#httpHeader": "x-amz-fwd-header-Cache-Control" + } + }, + "ContentDisposition": { + "target": "com.amazonaws.s3#ContentDisposition", + "traits": { + "smithy.api#documentation": "

Specifies presentational information for the object.

", + "smithy.api#httpHeader": "x-amz-fwd-header-Content-Disposition" + } + }, + "ContentEncoding": { + "target": "com.amazonaws.s3#ContentEncoding", + "traits": { + "smithy.api#documentation": "

Specifies what content encodings have been applied to the object and thus what decoding\n mechanisms must be applied to obtain the media-type referenced by the Content-Type header\n field.

", + "smithy.api#httpHeader": "x-amz-fwd-header-Content-Encoding" + } + }, + "ContentLanguage": { + "target": "com.amazonaws.s3#ContentLanguage", + "traits": { + "smithy.api#documentation": "

The language the content is in.

", + "smithy.api#httpHeader": "x-amz-fwd-header-Content-Language" + } + }, + "ContentLength": { + "target": "com.amazonaws.s3#ContentLength", + "traits": { + "smithy.api#documentation": "

The size of the content body in bytes.

", + "smithy.api#httpHeader": "Content-Length" + } + }, + "ContentRange": { + "target": "com.amazonaws.s3#ContentRange", + "traits": { + "smithy.api#documentation": "

The portion of the object returned in the response.

", + "smithy.api#httpHeader": "x-amz-fwd-header-Content-Range" + } + }, + "ContentType": { + "target": "com.amazonaws.s3#ContentType", + "traits": { + "smithy.api#documentation": "

A standard MIME type describing the format of the object data.

", + "smithy.api#httpHeader": "x-amz-fwd-header-Content-Type" + } + }, + "ChecksumCRC32": { + "target": "com.amazonaws.s3#ChecksumCRC32", + "traits": { + "smithy.api#documentation": "

This header can be used as a data integrity check to verify that the data received is\n the same data that was originally sent. This specifies the base64-encoded, 32-bit CRC-32\n checksum of the object returned by the Object Lambda function. This may not match the\n checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values\n only when the original GetObject request required checksum validation. For\n more information about checksums, see Checking object\n integrity in the Amazon S3 User Guide.

\n

Only one checksum header can be specified at a time. If you supply multiple checksum\n headers, this request will fail.

\n

", + "smithy.api#httpHeader": "x-amz-fwd-header-x-amz-checksum-crc32" + } + }, + "ChecksumCRC32C": { + "target": "com.amazonaws.s3#ChecksumCRC32C", + "traits": { + "smithy.api#documentation": "

This header can be used as a data integrity check to verify that the data received is\n the same data that was originally sent. This specifies the base64-encoded, 32-bit CRC-32C\n checksum of the object returned by the Object Lambda function. This may not match the\n checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values\n only when the original GetObject request required checksum validation. For\n more information about checksums, see Checking object\n integrity in the Amazon S3 User Guide.

\n

Only one checksum header can be specified at a time. If you supply multiple checksum\n headers, this request will fail.

", + "smithy.api#httpHeader": "x-amz-fwd-header-x-amz-checksum-crc32c" + } + }, + "ChecksumSHA1": { + "target": "com.amazonaws.s3#ChecksumSHA1", + "traits": { + "smithy.api#documentation": "

This header can be used as a data integrity check to verify that the data received is\n the same data that was originally sent. This specifies the base64-encoded, 160-bit SHA-1\n digest of the object returned by the Object Lambda function. This may not match the\n checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values\n only when the original GetObject request required checksum validation. For\n more information about checksums, see Checking object\n integrity in the Amazon S3 User Guide.

\n

Only one checksum header can be specified at a time. If you supply multiple checksum\n headers, this request will fail.

", + "smithy.api#httpHeader": "x-amz-fwd-header-x-amz-checksum-sha1" + } + }, + "ChecksumSHA256": { + "target": "com.amazonaws.s3#ChecksumSHA256", + "traits": { + "smithy.api#documentation": "

This header can be used as a data integrity check to verify that the data received is\n the same data that was originally sent. This specifies the base64-encoded, 256-bit SHA-256\n digest of the object returned by the Object Lambda function. This may not match the\n checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values\n only when the original GetObject request required checksum validation. For\n more information about checksums, see Checking object\n integrity in the Amazon S3 User Guide.

\n

Only one checksum header can be specified at a time. If you supply multiple checksum\n headers, this request will fail.

", + "smithy.api#httpHeader": "x-amz-fwd-header-x-amz-checksum-sha256" + } + }, + "DeleteMarker": { + "target": "com.amazonaws.s3#DeleteMarker", + "traits": { + "smithy.api#documentation": "

Specifies whether an object stored in Amazon S3 is (true) or is not\n (false) a delete marker.

", + "smithy.api#httpHeader": "x-amz-fwd-header-x-amz-delete-marker" + } + }, + "ETag": { + "target": "com.amazonaws.s3#ETag", + "traits": { + "smithy.api#documentation": "

An opaque identifier assigned by a web server to a specific version of a resource found\n at a URL.

", + "smithy.api#httpHeader": "x-amz-fwd-header-ETag" + } + }, + "Expires": { + "target": "com.amazonaws.s3#Expires", + "traits": { + "smithy.api#documentation": "

The date and time at which the object is no longer cacheable.

", + "smithy.api#httpHeader": "x-amz-fwd-header-Expires" + } + }, + "Expiration": { + "target": "com.amazonaws.s3#Expiration", + "traits": { + "smithy.api#documentation": "

If the object expiration is configured (see PUT Bucket lifecycle), the response includes\n this header. It includes the expiry-date and rule-id key-value\n pairs that provide the object expiration information. The value of the rule-id\n is URL-encoded.

", + "smithy.api#httpHeader": "x-amz-fwd-header-x-amz-expiration" + } + }, + "LastModified": { + "target": "com.amazonaws.s3#LastModified", + "traits": { + "smithy.api#documentation": "

The date and time that the object was last modified.

", + "smithy.api#httpHeader": "x-amz-fwd-header-Last-Modified" + } + }, + "MissingMeta": { + "target": "com.amazonaws.s3#MissingMeta", + "traits": { + "smithy.api#documentation": "

Set to the number of metadata entries not returned in x-amz-meta headers.\n This can happen if you create metadata using an API like SOAP that supports more flexible\n metadata than the REST API. For example, using SOAP, you can create metadata whose values\n are not legal HTTP headers.

", + "smithy.api#httpHeader": "x-amz-fwd-header-x-amz-missing-meta" + } + }, + "Metadata": { + "target": "com.amazonaws.s3#Metadata", + "traits": { + "smithy.api#documentation": "

A map of metadata to store with the object in S3.

", + "smithy.api#httpPrefixHeaders": "x-amz-meta-" + } + }, + "ObjectLockMode": { + "target": "com.amazonaws.s3#ObjectLockMode", + "traits": { + "smithy.api#documentation": "

Indicates whether an object stored in Amazon S3 has Object Lock enabled. For more information\n about S3 Object Lock, see Object Lock.

", + "smithy.api#httpHeader": "x-amz-fwd-header-x-amz-object-lock-mode" + } + }, + "ObjectLockLegalHoldStatus": { + "target": "com.amazonaws.s3#ObjectLockLegalHoldStatus", + "traits": { + "smithy.api#documentation": "

Indicates whether an object stored in Amazon S3 has an active legal hold.

", + "smithy.api#httpHeader": "x-amz-fwd-header-x-amz-object-lock-legal-hold" + } + }, + "ObjectLockRetainUntilDate": { + "target": "com.amazonaws.s3#ObjectLockRetainUntilDate", + "traits": { + "smithy.api#documentation": "

The date and time when Object Lock is configured to expire.

", + "smithy.api#httpHeader": "x-amz-fwd-header-x-amz-object-lock-retain-until-date" + } + }, + "PartsCount": { + "target": "com.amazonaws.s3#PartsCount", + "traits": { + "smithy.api#documentation": "

The count of parts this object has.

", + "smithy.api#httpHeader": "x-amz-fwd-header-x-amz-mp-parts-count" + } + }, + "ReplicationStatus": { + "target": "com.amazonaws.s3#ReplicationStatus", + "traits": { + "smithy.api#documentation": "

Indicates if request involves bucket that is either a source or destination in a\n Replication rule. For more information about S3 Replication, see Replication.

", + "smithy.api#httpHeader": "x-amz-fwd-header-x-amz-replication-status" + } + }, + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-fwd-header-x-amz-request-charged" + } + }, + "Restore": { + "target": "com.amazonaws.s3#Restore", + "traits": { + "smithy.api#documentation": "

Provides information about object restoration operation and expiration time of the\n restored object copy.

", + "smithy.api#httpHeader": "x-amz-fwd-header-x-amz-restore" + } + }, + "ServerSideEncryption": { + "target": "com.amazonaws.s3#ServerSideEncryption", + "traits": { + "smithy.api#documentation": "

The server-side encryption algorithm used when storing requested object in Amazon S3 (for\n example, AES256, aws:kms).

", + "smithy.api#httpHeader": "x-amz-fwd-header-x-amz-server-side-encryption" + } + }, + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "traits": { + "smithy.api#documentation": "

Encryption algorithm used if server-side encryption with a customer-provided encryption\n key was specified for object stored in Amazon S3.

", + "smithy.api#httpHeader": "x-amz-fwd-header-x-amz-server-side-encryption-customer-algorithm" + } + }, + "SSEKMSKeyId": { + "target": "com.amazonaws.s3#SSEKMSKeyId", + "traits": { + "smithy.api#documentation": "

If present, specifies the ID (Key ID, Key ARN, or Key Alias) of the Amazon Web Services Key\n Management Service (Amazon Web Services KMS) symmetric encryption customer managed key that was used for stored in\n Amazon S3 object.

", + "smithy.api#httpHeader": "x-amz-fwd-header-x-amz-server-side-encryption-aws-kms-key-id" + } + }, + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "traits": { + "smithy.api#documentation": "

128-bit MD5 digest of customer-provided encryption key used in Amazon S3 to encrypt data\n stored in S3. For more information, see Protecting data\n using server-side encryption with customer-provided encryption keys\n (SSE-C).

", + "smithy.api#httpHeader": "x-amz-fwd-header-x-amz-server-side-encryption-customer-key-MD5" + } + }, + "StorageClass": { + "target": "com.amazonaws.s3#StorageClass", + "traits": { + "smithy.api#documentation": "

Provides storage class information of the object. Amazon S3 returns this header for all\n objects except for S3 Standard storage class objects.

\n

For more information, see Storage Classes.

", + "smithy.api#httpHeader": "x-amz-fwd-header-x-amz-storage-class" + } + }, + "TagCount": { + "target": "com.amazonaws.s3#TagCount", + "traits": { + "smithy.api#documentation": "

The number of tags, if any, on the object.

", + "smithy.api#httpHeader": "x-amz-fwd-header-x-amz-tagging-count" + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

An ID used to reference a specific version of the object.

", + "smithy.api#httpHeader": "x-amz-fwd-header-x-amz-version-id" + } + }, + "BucketKeyEnabled": { + "target": "com.amazonaws.s3#BucketKeyEnabled", + "traits": { + "smithy.api#documentation": "

Indicates whether the object stored in Amazon S3 uses an S3 bucket key for server-side\n encryption with Amazon Web Services KMS (SSE-KMS).

", + "smithy.api#httpHeader": "x-amz-fwd-header-x-amz-server-side-encryption-bucket-key-enabled" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#WriteOffsetBytes": { + "type": "long" + }, + "com.amazonaws.s3#Years": { + "type": "integer" + } + } +} \ No newline at end of file diff --git a/pkg/testdata/codegen/sdk-codegen/aws-models/sagemaker.json b/pkg/testdata/codegen/sdk-codegen/aws-models/sagemaker.json new file mode 100644 index 00000000..628f68ed --- /dev/null +++ b/pkg/testdata/codegen/sdk-codegen/aws-models/sagemaker.json @@ -0,0 +1,76024 @@ +{ + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.sagemaker#Accept": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#AcceptEula": { + "type": "boolean" + }, + "com.amazonaws.sagemaker#AccountId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "^\\d+$" + } + }, + "com.amazonaws.sagemaker#ActionArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:action/" + } + }, + "com.amazonaws.sagemaker#ActionSource": { + "type": "structure", + "members": { + "SourceUri": { + "target": "com.amazonaws.sagemaker#SourceUri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The URI of the source.

", + "smithy.api#required": {} + } + }, + "SourceType": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "

The type of the source.

" + } + }, + "SourceId": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "

The ID of the source.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure describing the source of an action.

" + } + }, + "com.amazonaws.sagemaker#ActionStatus": { + "type": "enum", + "members": { + "UNKNOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Unknown" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + } + } + }, + "com.amazonaws.sagemaker#ActionSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ActionSummary" + } + }, + "com.amazonaws.sagemaker#ActionSummary": { + "type": "structure", + "members": { + "ActionArn": { + "target": "com.amazonaws.sagemaker#ActionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the action.

" + } + }, + "ActionName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

The name of the action.

" + } + }, + "Source": { + "target": "com.amazonaws.sagemaker#ActionSource", + "traits": { + "smithy.api#documentation": "

The source of the action.

" + } + }, + "ActionType": { + "target": "com.amazonaws.sagemaker#String64", + "traits": { + "smithy.api#documentation": "

The type of the action.

" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#ActionStatus", + "traits": { + "smithy.api#documentation": "

The status of the action.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the action was created.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the action was last modified.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Lists the properties of an action. An action represents an action\n or activity. Some examples are a workflow step and a model deployment. Generally, an\n action involves at least one input artifact or output artifact.

" + } + }, + "com.amazonaws.sagemaker#ActivationState": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enabled" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disabled" + } + } + } + }, + "com.amazonaws.sagemaker#AddAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#AddAssociationRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#AddAssociationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an association between the source and the destination. A\n source can be associated with multiple destinations, and a destination can be associated\n with multiple sources. An association is a lineage tracking entity. For more information, see\n Amazon SageMaker\n ML Lineage Tracking.

" + } + }, + "com.amazonaws.sagemaker#AddAssociationRequest": { + "type": "structure", + "members": { + "SourceArn": { + "target": "com.amazonaws.sagemaker#AssociationEntityArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the source.

", + "smithy.api#required": {} + } + }, + "DestinationArn": { + "target": "com.amazonaws.sagemaker#AssociationEntityArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the destination.

", + "smithy.api#required": {} + } + }, + "AssociationType": { + "target": "com.amazonaws.sagemaker#AssociationEdgeType", + "traits": { + "smithy.api#documentation": "

The type of association. The following are suggested uses for each type. Amazon SageMaker\n places no restrictions on their use.

\n
    \n
  • \n

    ContributedTo - The source contributed to the destination or had a part in\n enabling the destination. For example, the training data contributed to the training\n job.

    \n
    • \n
  • \n

    AssociatedWith - The source is connected to the destination. For example, an\n approval workflow is associated with a model deployment.

    \n
    • \n
  • \n

    DerivedFrom - The destination is a modification of the source. For example, a digest\n output of a channel input for a processing job is derived from the original inputs.

    \n
    • \n
  • \n

    Produced - The source generated the destination. For example, a training job\n produced a model artifact.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#AddAssociationResponse": { + "type": "structure", + "members": { + "SourceArn": { + "target": "com.amazonaws.sagemaker#AssociationEntityArn", + "traits": { + "smithy.api#documentation": "

The ARN of the source.

" + } + }, + "DestinationArn": { + "target": "com.amazonaws.sagemaker#AssociationEntityArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the destination.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#AddTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#AddTagsInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#AddTagsOutput" + }, + "traits": { + "smithy.api#documentation": "

Adds or overwrites one or more tags for the specified SageMaker resource. You can add\n tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform\n jobs, models, labeling jobs, work teams, endpoint configurations, and\n endpoints.

\n

Each tag consists of a key and an optional value. Tag keys must be unique per\n resource. For more information about tags, see For more information, see Amazon Web Services Tagging Strategies.

\n \n

Tags that you add to a hyperparameter tuning job by calling this API are also\n added to any training jobs that the hyperparameter tuning job launches after you\n call this API, but not to training jobs that the hyperparameter tuning job launched\n before you called this API. To make sure that the tags associated with a\n hyperparameter tuning job are also added to all training jobs that the\n hyperparameter tuning job launches, add the tags when you first create the tuning\n job by specifying them in the Tags parameter of CreateHyperParameterTuningJob\n

\n \n \n

Tags that you add to a SageMaker Domain or User Profile by calling this API are\n also added to any Apps that the Domain or User Profile launches after you call this\n API, but not to Apps that the Domain or User Profile launched before you called this\n API. To make sure that the tags associated with a Domain or User Profile are also\n added to all Apps that the Domain or User Profile launches, add the tags when you\n first create the Domain or User Profile by specifying them in the Tags\n parameter of CreateDomain\n or CreateUserProfile.

\n " + } + }, + "com.amazonaws.sagemaker#AddTagsInput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.sagemaker#ResourceArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that you want to tag.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#AddTagsOutput": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags associated with the SageMaker resource.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#AdditionalCodeRepositoryNamesOrUrls": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#CodeRepositoryNameOrUrl" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3 + } + } + }, + "com.amazonaws.sagemaker#AdditionalInferenceSpecificationDefinition": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A unique name to identify the additional inference specification. The name must \n be unique within the list of your additional inference specifications for a \n particular model package.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "

A description of the additional Inference specification

" + } + }, + "Containers": { + "target": "com.amazonaws.sagemaker#ModelPackageContainerDefinitionList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon ECR registry path of the Docker image that contains the inference code.

", + "smithy.api#required": {} + } + }, + "SupportedTransformInstanceTypes": { + "target": "com.amazonaws.sagemaker#TransformInstanceTypes", + "traits": { + "smithy.api#documentation": "

A list of the instance types on which a transformation job can be run \n or on which an endpoint can be deployed.

" + } + }, + "SupportedRealtimeInferenceInstanceTypes": { + "target": "com.amazonaws.sagemaker#RealtimeInferenceInstanceTypes", + "traits": { + "smithy.api#documentation": "

A list of the instance types that are used to generate inferences in real-time.

" + } + }, + "SupportedContentTypes": { + "target": "com.amazonaws.sagemaker#ContentTypes", + "traits": { + "smithy.api#documentation": "

The supported MIME types for the input data.

" + } + }, + "SupportedResponseMIMETypes": { + "target": "com.amazonaws.sagemaker#ResponseMIMETypes", + "traits": { + "smithy.api#documentation": "

The supported MIME types for the output data.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure of additional Inference Specification. Additional Inference Specification \n specifies details about inference jobs that can be run with models based on\n this model package

" + } + }, + "com.amazonaws.sagemaker#AdditionalInferenceSpecifications": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AdditionalInferenceSpecificationDefinition" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 15 + } + } + }, + "com.amazonaws.sagemaker#AdditionalModelChannelName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[A-Za-z0-9\\.\\-_]+$" + } + }, + "com.amazonaws.sagemaker#AdditionalModelDataSource": { + "type": "structure", + "members": { + "ChannelName": { + "target": "com.amazonaws.sagemaker#AdditionalModelChannelName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A custom name for this AdditionalModelDataSource object.

", + "smithy.api#required": {} + } + }, + "S3DataSource": { + "target": "com.amazonaws.sagemaker#S3ModelDataSource", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Data sources that are available to your model in addition to the one that you specify for ModelDataSource when you use the CreateModel action.

" + } + }, + "com.amazonaws.sagemaker#AdditionalModelDataSources": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AdditionalModelDataSource" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#AdditionalS3DataSource": { + "type": "structure", + "members": { + "S3DataType": { + "target": "com.amazonaws.sagemaker#AdditionalS3DataSourceDataType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The data type of the additional data source that you specify for use in inference or\n training.

", + "smithy.api#required": {} + } + }, + "S3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The uniform resource identifier (URI) used to identify an additional data source used\n in inference or training.

", + "smithy.api#required": {} + } + }, + "CompressionType": { + "target": "com.amazonaws.sagemaker#CompressionType", + "traits": { + "smithy.api#documentation": "

The type of compression used for an additional data source used in inference or\n training. Specify None if your additional data source is not\n compressed.

" + } + }, + "ETag": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The ETag associated with S3 URI.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A data source used for training or inference that is in addition to the input dataset\n or model data.

" + } + }, + "com.amazonaws.sagemaker#AdditionalS3DataSourceDataType": { + "type": "enum", + "members": { + "S3OBJECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3Object" + } + }, + "S3PREFIX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3Prefix" + } + } + } + }, + "com.amazonaws.sagemaker#AgentVersion": { + "type": "structure", + "members": { + "Version": { + "target": "com.amazonaws.sagemaker#EdgeVersion", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Version of the agent.

", + "smithy.api#required": {} + } + }, + "AgentCount": { + "target": "com.amazonaws.sagemaker#Long", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of Edge Manager agents.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Edge Manager agent version.

" + } + }, + "com.amazonaws.sagemaker#AgentVersions": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AgentVersion" + } + }, + "com.amazonaws.sagemaker#AggregationTransformationValue": { + "type": "enum", + "members": { + "Sum": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sum" + } + }, + "Avg": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "avg" + } + }, + "First": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "first" + } + }, + "Min": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "min" + } + }, + "Max": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "max" + } + } + } + }, + "com.amazonaws.sagemaker#AggregationTransformations": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#TransformationAttributeName" + }, + "value": { + "target": "com.amazonaws.sagemaker#AggregationTransformationValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.sagemaker#Alarm": { + "type": "structure", + "members": { + "AlarmName": { + "target": "com.amazonaws.sagemaker#AlarmName", + "traits": { + "smithy.api#documentation": "

The name of a CloudWatch alarm in your account.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An Amazon CloudWatch alarm configured to monitor metrics on an endpoint.

" + } + }, + "com.amazonaws.sagemaker#AlarmList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#Alarm" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.sagemaker#AlarmName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^(?!\\s*$).+$" + } + }, + "com.amazonaws.sagemaker#AlgorithmArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-cn|-us-gov|-iso-f)?:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:algorithm/[\\S]{1,2048}$" + } + }, + "com.amazonaws.sagemaker#AlgorithmImage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#AlgorithmSortBy": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + } + } + }, + "com.amazonaws.sagemaker#AlgorithmSpecification": { + "type": "structure", + "members": { + "TrainingImage": { + "target": "com.amazonaws.sagemaker#AlgorithmImage", + "traits": { + "smithy.api#documentation": "

The registry path of the Docker image\n that contains the training algorithm.\n For information about docker registry paths for SageMaker built-in algorithms, see Docker Registry\n Paths and Example Code in the Amazon SageMaker developer guide.\n SageMaker supports both registry/repository[:tag] and\n registry/repository[@digest] image path formats. For more information\n about using your custom training container, see Using Your Own Algorithms with\n Amazon SageMaker.

\n \n

You must specify either the algorithm name to the AlgorithmName\n parameter or the image URI of the algorithm container to the\n TrainingImage parameter.

\n

For more information, see the note in the AlgorithmName parameter\n description.

\n " + } + }, + "AlgorithmName": { + "target": "com.amazonaws.sagemaker#ArnOrName", + "traits": { + "smithy.api#documentation": "

The name of the algorithm resource to use for the training job. This must be an\n algorithm resource that you created or subscribe to on Amazon Web Services\n Marketplace.

\n \n

You must specify either the algorithm name to the AlgorithmName\n parameter or the image URI of the algorithm container to the\n TrainingImage parameter.

\n

Note that the AlgorithmName parameter is mutually exclusive with the\n TrainingImage parameter. If you specify a value for the\n AlgorithmName parameter, you can't specify a value for\n TrainingImage, and vice versa.

\n

If you specify values for both parameters, the training job might break; if you\n don't specify any value for both parameters, the training job might raise a\n null error.

\n " + } + }, + "TrainingInputMode": { + "target": "com.amazonaws.sagemaker#TrainingInputMode", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "MetricDefinitions": { + "target": "com.amazonaws.sagemaker#MetricDefinitionList", + "traits": { + "smithy.api#documentation": "

A list of metric definition objects. Each object specifies the metric name and regular\n expressions used to parse algorithm logs. SageMaker publishes each metric to Amazon CloudWatch.

" + } + }, + "EnableSageMakerMetricsTimeSeries": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

To generate and save time-series metrics during training, set to true.\n The default is false and time-series metrics aren't generated except in the\n following cases:

\n
    \n
  • \n

    You use one of the SageMaker built-in algorithms

    \n
    • \n
  • \n

    You use one of the following Prebuilt SageMaker Docker Images:

    \n
      \n
    • \n

      Tensorflow (version >= 1.15)

      \n
      • \n
    • \n

      MXNet (version >= 1.6)

      \n
      • \n
    • \n

      PyTorch (version >= 1.3)

      \n
      • \n
    \n
    • \n
  • \n

    You specify at least one MetricDefinition\n

    \n
    • \n
" + } + }, + "ContainerEntrypoint": { + "target": "com.amazonaws.sagemaker#TrainingContainerEntrypoint", + "traits": { + "smithy.api#documentation": "

The entrypoint script\n for a Docker container used to run a training job. This script takes\n precedence over the default train processing instructions. See How Amazon SageMaker\n Runs Your Training Image for more information.

" + } + }, + "ContainerArguments": { + "target": "com.amazonaws.sagemaker#TrainingContainerArguments", + "traits": { + "smithy.api#documentation": "

The arguments for a container used to run a training job. See How Amazon SageMaker\n Runs Your Training Image for additional information.

" + } + }, + "TrainingImageConfig": { + "target": "com.amazonaws.sagemaker#TrainingImageConfig", + "traits": { + "smithy.api#documentation": "

The configuration to use an image from a private Docker registry for a training\n job.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the training algorithm to use in a CreateTrainingJob request.

\n \n

SageMaker uses its own SageMaker account credentials to pull and access built-in algorithms\n so built-in algorithms are universally accessible across all Amazon Web Services accounts. As a\n result, built-in algorithms have standard, unrestricted access. You cannot restrict\n built-in algorithms using IAM roles. Use custom algorithms if you require specific\n access controls.

\n \n

For more information about algorithms provided by SageMaker, see Algorithms. For\n information about using your own algorithms, see Using Your Own Algorithms with\n Amazon SageMaker.

" + } + }, + "com.amazonaws.sagemaker#AlgorithmStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + } + } + }, + "com.amazonaws.sagemaker#AlgorithmStatusDetails": { + "type": "structure", + "members": { + "ValidationStatuses": { + "target": "com.amazonaws.sagemaker#AlgorithmStatusItemList", + "traits": { + "smithy.api#documentation": "

The status of algorithm validation.

" + } + }, + "ImageScanStatuses": { + "target": "com.amazonaws.sagemaker#AlgorithmStatusItemList", + "traits": { + "smithy.api#documentation": "

The status of the scan of the algorithm's Docker image container.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the validation and image scan statuses of the algorithm.

" + } + }, + "com.amazonaws.sagemaker#AlgorithmStatusItem": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the algorithm for which the overall status is being reported.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#DetailedAlgorithmStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The current status.

", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

if the overall status is Failed, the reason for the failure.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the overall status of an algorithm.

" + } + }, + "com.amazonaws.sagemaker#AlgorithmStatusItemList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AlgorithmStatusItem" + } + }, + "com.amazonaws.sagemaker#AlgorithmSummary": { + "type": "structure", + "members": { + "AlgorithmName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the algorithm that is described by the summary.

", + "smithy.api#required": {} + } + }, + "AlgorithmArn": { + "target": "com.amazonaws.sagemaker#AlgorithmArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the algorithm.

", + "smithy.api#required": {} + } + }, + "AlgorithmDescription": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "

A brief description of the algorithm.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A timestamp that shows when the algorithm was created.

", + "smithy.api#required": {} + } + }, + "AlgorithmStatus": { + "target": "com.amazonaws.sagemaker#AlgorithmStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The overall status of the algorithm.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides summary information about an algorithm.

" + } + }, + "com.amazonaws.sagemaker#AlgorithmSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AlgorithmSummary" + } + }, + "com.amazonaws.sagemaker#AlgorithmValidationProfile": { + "type": "structure", + "members": { + "ProfileName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the profile for the algorithm. The name must have 1 to 63 characters.\n Valid characters are a-z, A-Z, 0-9, and - (hyphen).

", + "smithy.api#required": {} + } + }, + "TrainingJobDefinition": { + "target": "com.amazonaws.sagemaker#TrainingJobDefinition", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The TrainingJobDefinition object that describes the training job that\n SageMaker runs to validate your algorithm.

", + "smithy.api#required": {} + } + }, + "TransformJobDefinition": { + "target": "com.amazonaws.sagemaker#TransformJobDefinition", + "traits": { + "smithy.api#documentation": "

The TransformJobDefinition object that describes the transform job that\n SageMaker runs to validate your algorithm.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines a training job and a batch transform job that SageMaker runs to validate your\n algorithm.

\n

The data provided in the validation profile is made available to your buyers on\n Amazon Web Services Marketplace.

" + } + }, + "com.amazonaws.sagemaker#AlgorithmValidationProfiles": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AlgorithmValidationProfile" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.sagemaker#AlgorithmValidationSpecification": { + "type": "structure", + "members": { + "ValidationRole": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IAM roles that SageMaker uses to run the training jobs.

", + "smithy.api#required": {} + } + }, + "ValidationProfiles": { + "target": "com.amazonaws.sagemaker#AlgorithmValidationProfiles", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An array of AlgorithmValidationProfile objects, each of which specifies a\n training job and batch transform job that SageMaker runs to validate your algorithm.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies configurations for one or more training jobs that SageMaker runs to test the\n algorithm.

" + } + }, + "com.amazonaws.sagemaker#AmazonQSettings": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.sagemaker#FeatureStatus", + "traits": { + "smithy.api#documentation": "

Whether Amazon Q has been enabled within the domain.

" + } + }, + "QProfileArn": { + "target": "com.amazonaws.sagemaker#QProfileArn", + "traits": { + "smithy.api#documentation": "

The ARN of the Amazon Q profile used within the domain.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A collection of settings that configure the Amazon Q experience within the domain.

" + } + }, + "com.amazonaws.sagemaker#AnnotationConsolidationConfig": { + "type": "structure", + "members": { + "AnnotationConsolidationLambdaArn": { + "target": "com.amazonaws.sagemaker#LambdaFunctionArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Lambda function implements the logic for annotation consolidation and to process output data.

\n

For built-in task types, use one of the following Amazon SageMaker Ground Truth Lambda function ARNs for AnnotationConsolidationLambdaArn. For custom labeling workflows, see Post-annotation Lambda.

\n

\n Bounding box - Finds the most similar boxes from\n different workers based on the Jaccard index of the boxes.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-BoundingBox\n

    \n
    • \n
\n

\n Image classification - Uses a variant of the\n Expectation Maximization approach to estimate the true class of an image based on\n annotations from individual workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClass\n

    \n
    • \n
\n

\n Multi-label image classification - Uses a variant of\n the Expectation Maximization approach to estimate the true classes of an image based on\n annotations from individual workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
\n

\n Semantic segmentation - Treats each pixel in an image\n as a multi-class classification and treats pixel annotations from workers as \"votes\" for\n the correct label.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-SemanticSegmentation\n

    \n
    • \n
\n

\n Text classification - Uses a variant of the\n Expectation Maximization approach to estimate the true class of text based on\n annotations from individual workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClass\n

    \n
    • \n
\n

\n Multi-label text classification - Uses a variant of\n the Expectation Maximization approach to estimate the true classes of text based on\n annotations from individual workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
\n

\n Named entity recognition - Groups similar selections\n and calculates aggregate boundaries, resolving to most-assigned label.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-NamedEntityRecognition\n

    \n
    • \n
\n

\n Video Classification - Use this task type when you need workers to classify videos using\n predefined labels that you specify. Workers are shown videos and are asked to choose one\n label for each video.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoMultiClass\n

    \n
    • \n
\n

\n Video Frame Object Detection - Use this task type to\n have workers identify and locate objects in a sequence of video frames (images extracted\n from a video) using bounding boxes. For example, you can use this task to ask workers to\n identify and localize various objects in a series of video frames, such as cars, bikes,\n and pedestrians.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoObjectDetection\n

    \n
    • \n
\n

\n Video Frame Object Tracking - Use this task type to\n have workers track the movement of objects in a sequence of video frames (images\n extracted from a video) using bounding boxes. For example, you can use this task to ask\n workers to track the movement of objects, such as cars, bikes, and pedestrians.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoObjectTracking\n

    \n
    • \n
\n

\n 3D Point Cloud Object Detection - Use this task type\n when you want workers to classify objects in a 3D point cloud by drawing 3D cuboids\n around objects. For example, you can use this task type to ask workers to identify\n different types of objects in a point cloud, such as cars, bikes, and\n pedestrians.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
\n

\n 3D Point Cloud Object Tracking - Use this task type\n when you want workers to draw 3D cuboids around objects that appear in a sequence of 3D\n point cloud frames. For example, you can use this task type to ask workers to track the\n movement of vehicles across multiple point cloud frames.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
\n

\n 3D Point Cloud Semantic Segmentation - Use this task\n type when you want workers to create a point-level semantic segmentation masks by\n painting objects in a 3D point cloud using different colors where each color is assigned\n to one of the classes you specify.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
\n

\n Use the following ARNs for Label Verification and Adjustment Jobs\n

\n

Use label verification and adjustment jobs to review and adjust labels. To learn more,\n see Verify and Adjust Labels .

\n

\n Semantic Segmentation Adjustment - Treats each pixel\n in an image as a multi-class classification and treats pixel adjusted annotations from\n workers as \"votes\" for the correct label.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
\n

\n Semantic Segmentation Verification - Uses a variant\n of the Expectation Maximization approach to estimate the true class of verification\n judgment for semantic segmentation labels based on annotations from individual\n workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
\n

\n Bounding Box Adjustment - Finds the most similar\n boxes from different workers based on the Jaccard index of the adjusted\n annotations.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
\n

\n Bounding Box Verification - Uses a variant of the\n Expectation Maximization approach to estimate the true class of verification judgement\n for bounding box labels based on annotations from individual workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationBoundingBox\n

    \n
    • \n
\n

\n Video Frame Object Detection Adjustment - \n Use this task type when you want workers to adjust bounding boxes that workers have added \n to video frames to classify and localize objects in a sequence of video frames.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
\n

\n Video Frame Object Tracking Adjustment - \n Use this task type when you want workers to adjust bounding boxes that workers have added \n to video frames to track object movement across a sequence of video frames.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
\n

\n 3D Point Cloud Object Detection Adjustment - Use this\n task type when you want workers to adjust 3D cuboids around objects in a 3D point cloud.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
\n

\n 3D Point Cloud Object Tracking Adjustment - Use this\n task type when you want workers to adjust 3D cuboids around objects that appear in a\n sequence of 3D point cloud frames.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
\n

\n 3D Point Cloud Semantic Segmentation Adjustment - Use this task\n type when you want workers to adjust a point-level semantic segmentation masks using a paint tool.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Configures how labels are consolidated across human workers and processes output data.

" + } + }, + "com.amazonaws.sagemaker#AppArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:app/" + } + }, + "com.amazonaws.sagemaker#AppDetails": { + "type": "structure", + "members": { + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#documentation": "

The domain ID.

" + } + }, + "UserProfileName": { + "target": "com.amazonaws.sagemaker#UserProfileName", + "traits": { + "smithy.api#documentation": "

The user profile name.

" + } + }, + "SpaceName": { + "target": "com.amazonaws.sagemaker#SpaceName", + "traits": { + "smithy.api#documentation": "

The name of the space.

" + } + }, + "AppType": { + "target": "com.amazonaws.sagemaker#AppType", + "traits": { + "smithy.api#documentation": "

The type of app.

" + } + }, + "AppName": { + "target": "com.amazonaws.sagemaker#AppName", + "traits": { + "smithy.api#documentation": "

The name of the app.

" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#AppStatus", + "traits": { + "smithy.api#documentation": "

The status.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "

The creation time.

" + } + }, + "ResourceSpec": { + "target": "com.amazonaws.sagemaker#ResourceSpec" + } + }, + "traits": { + "smithy.api#documentation": "

Details about an Amazon SageMaker AI app.

" + } + }, + "com.amazonaws.sagemaker#AppImageConfigArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:app-image-config/" + } + }, + "com.amazonaws.sagemaker#AppImageConfigDetails": { + "type": "structure", + "members": { + "AppImageConfigArn": { + "target": "com.amazonaws.sagemaker#AppImageConfigArn", + "traits": { + "smithy.api#documentation": "

The ARN of the AppImageConfig.

" + } + }, + "AppImageConfigName": { + "target": "com.amazonaws.sagemaker#AppImageConfigName", + "traits": { + "smithy.api#documentation": "

The name of the AppImageConfig. Must be unique to your account.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the AppImageConfig was created.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the AppImageConfig was last modified.

" + } + }, + "KernelGatewayImageConfig": { + "target": "com.amazonaws.sagemaker#KernelGatewayImageConfig", + "traits": { + "smithy.api#documentation": "

The configuration for the file system and kernels in the SageMaker AI image.

" + } + }, + "JupyterLabAppImageConfig": { + "target": "com.amazonaws.sagemaker#JupyterLabAppImageConfig", + "traits": { + "smithy.api#documentation": "

The configuration for the file system and the runtime, such as the environment variables and entry point.

" + } + }, + "CodeEditorAppImageConfig": { + "target": "com.amazonaws.sagemaker#CodeEditorAppImageConfig", + "traits": { + "smithy.api#documentation": "

The configuration for the file system and the runtime, \n such as the environment variables and entry point.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for running a SageMaker AI image as a KernelGateway app.

" + } + }, + "com.amazonaws.sagemaker#AppImageConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AppImageConfigDetails" + } + }, + "com.amazonaws.sagemaker#AppImageConfigName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#AppImageConfigSortKey": { + "type": "enum", + "members": { + "CreationTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "LastModifiedTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LastModifiedTime" + } + }, + "Name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + } + } + }, + "com.amazonaws.sagemaker#AppInstanceType": { + "type": "enum", + "members": { + "SYSTEM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "system" + } + }, + "ML_T3_MICRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.micro" + } + }, + "ML_T3_SMALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.small" + } + }, + "ML_T3_MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.medium" + } + }, + "ML_T3_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.large" + } + }, + "ML_T3_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.xlarge" + } + }, + "ML_T3_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.2xlarge" + } + }, + "ML_M5_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.large" + } + }, + "ML_M5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.xlarge" + } + }, + "ML_M5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.2xlarge" + } + }, + "ML_M5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.4xlarge" + } + }, + "ML_M5_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.8xlarge" + } + }, + "ML_M5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.12xlarge" + } + }, + "ML_M5_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.16xlarge" + } + }, + "ML_M5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.24xlarge" + } + }, + "ML_M5D_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.large" + } + }, + "ML_M5D_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.xlarge" + } + }, + "ML_M5D_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.2xlarge" + } + }, + "ML_M5D_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.4xlarge" + } + }, + "ML_M5D_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.8xlarge" + } + }, + "ML_M5D_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.12xlarge" + } + }, + "ML_M5D_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.16xlarge" + } + }, + "ML_M5D_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.24xlarge" + } + }, + "ML_C5_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.large" + } + }, + "ML_C5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.xlarge" + } + }, + "ML_C5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.2xlarge" + } + }, + "ML_C5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.4xlarge" + } + }, + "ML_C5_9XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.9xlarge" + } + }, + "ML_C5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.12xlarge" + } + }, + "ML_C5_18XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.18xlarge" + } + }, + "ML_C5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.24xlarge" + } + }, + "ML_P3_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3.2xlarge" + } + }, + "ML_P3_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3.8xlarge" + } + }, + "ML_P3_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3.16xlarge" + } + }, + "ML_P3DN_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3dn.24xlarge" + } + }, + "ML_G4DN_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.xlarge" + } + }, + "ML_G4DN_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.2xlarge" + } + }, + "ML_G4DN_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.4xlarge" + } + }, + "ML_G4DN_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.8xlarge" + } + }, + "ML_G4DN_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.12xlarge" + } + }, + "ML_G4DN_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.16xlarge" + } + }, + "ML_R5_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.large" + } + }, + "ML_R5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.xlarge" + } + }, + "ML_R5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.2xlarge" + } + }, + "ML_R5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.4xlarge" + } + }, + "ML_R5_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.8xlarge" + } + }, + "ML_R5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.12xlarge" + } + }, + "ML_R5_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.16xlarge" + } + }, + "ML_R5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.24xlarge" + } + }, + "ML_G5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.xlarge" + } + }, + "ML_G5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.2xlarge" + } + }, + "ML_G5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.4xlarge" + } + }, + "ML_G5_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.8xlarge" + } + }, + "ML_G5_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.16xlarge" + } + }, + "ML_G5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.12xlarge" + } + }, + "ML_G5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.24xlarge" + } + }, + "ML_G5_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.48xlarge" + } + }, + "ML_G6_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.xlarge" + } + }, + "ML_G6_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.2xlarge" + } + }, + "ML_G6_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.4xlarge" + } + }, + "ML_G6_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.8xlarge" + } + }, + "ML_G6_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.12xlarge" + } + }, + "ML_G6_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.16xlarge" + } + }, + "ML_G6_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.24xlarge" + } + }, + "ML_G6_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.48xlarge" + } + }, + "ML_G6E_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.xlarge" + } + }, + "ML_G6E_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.2xlarge" + } + }, + "ML_G6E_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.4xlarge" + } + }, + "ML_G6E_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.8xlarge" + } + }, + "ML_G6E_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.12xlarge" + } + }, + "ML_G6E_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.16xlarge" + } + }, + "ML_G6E_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.24xlarge" + } + }, + "ML_G6E_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.48xlarge" + } + }, + "ML_GEOSPATIAL_INTERACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.geospatial.interactive" + } + }, + "ML_P4D_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p4d.24xlarge" + } + }, + "ML_P4DE_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p4de.24xlarge" + } + }, + "ML_TRN1_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1.2xlarge" + } + }, + "ML_TRN1_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1.32xlarge" + } + }, + "ML_TRN1N_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1n.32xlarge" + } + }, + "ML_P5_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p5.48xlarge" + } + }, + "ML_M6I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.large" + } + }, + "ML_M6I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.xlarge" + } + }, + "ML_M6I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.2xlarge" + } + }, + "ML_M6I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.4xlarge" + } + }, + "ML_M6I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.8xlarge" + } + }, + "ML_M6I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.12xlarge" + } + }, + "ML_M6I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.16xlarge" + } + }, + "ML_M6I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.24xlarge" + } + }, + "ML_M6I_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.32xlarge" + } + }, + "ML_M7I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.large" + } + }, + "ML_M7I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.xlarge" + } + }, + "ML_M7I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.2xlarge" + } + }, + "ML_M7I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.4xlarge" + } + }, + "ML_M7I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.8xlarge" + } + }, + "ML_M7I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.12xlarge" + } + }, + "ML_M7I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.16xlarge" + } + }, + "ML_M7I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.24xlarge" + } + }, + "ML_M7I_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.48xlarge" + } + }, + "ML_C6I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.large" + } + }, + "ML_C6I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.xlarge" + } + }, + "ML_C6I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.2xlarge" + } + }, + "ML_C6I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.4xlarge" + } + }, + "ML_C6I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.8xlarge" + } + }, + "ML_C6I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.12xlarge" + } + }, + "ML_C6I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.16xlarge" + } + }, + "ML_C6I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.24xlarge" + } + }, + "ML_C6I_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.32xlarge" + } + }, + "ML_C7I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.large" + } + }, + "ML_C7I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.xlarge" + } + }, + "ML_C7I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.2xlarge" + } + }, + "ML_C7I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.4xlarge" + } + }, + "ML_C7I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.8xlarge" + } + }, + "ML_C7I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.12xlarge" + } + }, + "ML_C7I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.16xlarge" + } + }, + "ML_C7I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.24xlarge" + } + }, + "ML_C7I_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.48xlarge" + } + }, + "ML_R6I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.large" + } + }, + "ML_R6I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.xlarge" + } + }, + "ML_R6I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.2xlarge" + } + }, + "ML_R6I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.4xlarge" + } + }, + "ML_R6I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.8xlarge" + } + }, + "ML_R6I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.12xlarge" + } + }, + "ML_R6I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.16xlarge" + } + }, + "ML_R6I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.24xlarge" + } + }, + "ML_R6I_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.32xlarge" + } + }, + "ML_R7I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.large" + } + }, + "ML_R7I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.xlarge" + } + }, + "ML_R7I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.2xlarge" + } + }, + "ML_R7I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.4xlarge" + } + }, + "ML_R7I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.8xlarge" + } + }, + "ML_R7I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.12xlarge" + } + }, + "ML_R7I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.16xlarge" + } + }, + "ML_R7I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.24xlarge" + } + }, + "ML_R7I_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.48xlarge" + } + }, + "ML_M6ID_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6id.large" + } + }, + "ML_M6ID_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6id.xlarge" + } + }, + "ML_M6ID_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6id.2xlarge" + } + }, + "ML_M6ID_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6id.4xlarge" + } + }, + "ML_M6ID_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6id.8xlarge" + } + }, + "ML_M6ID_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6id.12xlarge" + } + }, + "ML_M6ID_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6id.16xlarge" + } + }, + "ML_M6ID_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6id.24xlarge" + } + }, + "ML_M6ID_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6id.32xlarge" + } + }, + "ML_C6ID_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6id.large" + } + }, + "ML_C6ID_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6id.xlarge" + } + }, + "ML_C6ID_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6id.2xlarge" + } + }, + "ML_C6ID_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6id.4xlarge" + } + }, + "ML_C6ID_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6id.8xlarge" + } + }, + "ML_C6ID_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6id.12xlarge" + } + }, + "ML_C6ID_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6id.16xlarge" + } + }, + "ML_C6ID_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6id.24xlarge" + } + }, + "ML_C6ID_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6id.32xlarge" + } + }, + "ML_R6ID_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6id.large" + } + }, + "ML_R6ID_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6id.xlarge" + } + }, + "ML_R6ID_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6id.2xlarge" + } + }, + "ML_R6ID_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6id.4xlarge" + } + }, + "ML_R6ID_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6id.8xlarge" + } + }, + "ML_R6ID_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6id.12xlarge" + } + }, + "ML_R6ID_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6id.16xlarge" + } + }, + "ML_R6ID_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6id.24xlarge" + } + }, + "ML_R6ID_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6id.32xlarge" + } + } + } + }, + "com.amazonaws.sagemaker#AppLifecycleManagement": { + "type": "structure", + "members": { + "IdleSettings": { + "target": "com.amazonaws.sagemaker#IdleSettings", + "traits": { + "smithy.api#documentation": "

Settings related to idle shutdown of Studio applications.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Settings that are used to configure and manage the lifecycle of Amazon SageMaker Studio\n applications.

" + } + }, + "com.amazonaws.sagemaker#AppList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AppDetails" + } + }, + "com.amazonaws.sagemaker#AppManaged": { + "type": "boolean" + }, + "com.amazonaws.sagemaker#AppName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#AppNetworkAccessType": { + "type": "enum", + "members": { + "PublicInternetOnly": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PublicInternetOnly" + } + }, + "VpcOnly": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VpcOnly" + } + } + } + }, + "com.amazonaws.sagemaker#AppSecurityGroupManagement": { + "type": "enum", + "members": { + "Service": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Service" + } + }, + "Customer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Customer" + } + } + } + }, + "com.amazonaws.sagemaker#AppSortKey": { + "type": "enum", + "members": { + "CreationTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + } + } + }, + "com.amazonaws.sagemaker#AppSpecification": { + "type": "structure", + "members": { + "ImageUri": { + "target": "com.amazonaws.sagemaker#ImageUri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The container image to be run by the processing job.

", + "smithy.api#required": {} + } + }, + "ContainerEntrypoint": { + "target": "com.amazonaws.sagemaker#ContainerEntrypoint", + "traits": { + "smithy.api#documentation": "

The entrypoint for a container used to run a processing job.

" + } + }, + "ContainerArguments": { + "target": "com.amazonaws.sagemaker#ContainerArguments", + "traits": { + "smithy.api#documentation": "

The arguments for a container used to run a processing job.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration to run a processing job in a specified container image.

" + } + }, + "com.amazonaws.sagemaker#AppStatus": { + "type": "enum", + "members": { + "Deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleted" + } + }, + "Deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "InService": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InService" + } + }, + "Pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + } + } + }, + "com.amazonaws.sagemaker#AppType": { + "type": "enum", + "members": { + "JupyterServer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JupyterServer" + } + }, + "KernelGateway": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KernelGateway" + } + }, + "DetailedProfiler": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DetailedProfiler" + } + }, + "TensorBoard": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TensorBoard" + } + }, + "CodeEditor": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CodeEditor" + } + }, + "JupyterLab": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JupyterLab" + } + }, + "RStudioServerPro": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RStudioServerPro" + } + }, + "RSessionGateway": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RSessionGateway" + } + }, + "Canvas": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Canvas" + } + } + } + }, + "com.amazonaws.sagemaker#ApprovalDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#ArnOrName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 170 + }, + "smithy.api#pattern": "^(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:[a-z\\-]*\\/)?([a-zA-Z0-9]([a-zA-Z0-9-]){0,62})(?The URI of the source.

", + "smithy.api#required": {} + } + }, + "SourceTypes": { + "target": "com.amazonaws.sagemaker#ArtifactSourceTypes", + "traits": { + "smithy.api#documentation": "

A list of source types.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure describing the source of an artifact.

" + } + }, + "com.amazonaws.sagemaker#ArtifactSourceIdType": { + "type": "enum", + "members": { + "MD5_HASH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MD5Hash" + } + }, + "S3_ETAG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3ETag" + } + }, + "S3_VERSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3Version" + } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Custom" + } + } + } + }, + "com.amazonaws.sagemaker#ArtifactSourceType": { + "type": "structure", + "members": { + "SourceIdType": { + "target": "com.amazonaws.sagemaker#ArtifactSourceIdType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of ID.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The ID and ID type of an artifact source.

" + } + }, + "com.amazonaws.sagemaker#ArtifactSourceTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ArtifactSourceType" + } + }, + "com.amazonaws.sagemaker#ArtifactSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ArtifactSummary" + } + }, + "com.amazonaws.sagemaker#ArtifactSummary": { + "type": "structure", + "members": { + "ArtifactArn": { + "target": "com.amazonaws.sagemaker#ArtifactArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the artifact.

" + } + }, + "ArtifactName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

The name of the artifact.

" + } + }, + "Source": { + "target": "com.amazonaws.sagemaker#ArtifactSource", + "traits": { + "smithy.api#documentation": "

The source of the artifact.

" + } + }, + "ArtifactType": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "

The type of the artifact.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the artifact was created.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the artifact was last modified.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Lists a summary of the properties of an artifact. An artifact represents a URI\n addressable object or data. Some examples are a dataset and a model.

" + } + }, + "com.amazonaws.sagemaker#AssemblyType": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "None" + } + }, + "LINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Line" + } + } + } + }, + "com.amazonaws.sagemaker#AssociateTrialComponent": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#AssociateTrialComponentRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#AssociateTrialComponentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Associates a trial component with a trial. A trial component can be associated with\n multiple trials. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.

" + } + }, + "com.amazonaws.sagemaker#AssociateTrialComponentRequest": { + "type": "structure", + "members": { + "TrialComponentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the component to associated with the trial.

", + "smithy.api#required": {} + } + }, + "TrialName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the trial to associate with.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#AssociateTrialComponentResponse": { + "type": "structure", + "members": { + "TrialComponentArn": { + "target": "com.amazonaws.sagemaker#TrialComponentArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the trial component.

" + } + }, + "TrialArn": { + "target": "com.amazonaws.sagemaker#TrialArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the trial.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#AssociationEdgeType": { + "type": "enum", + "members": { + "CONTRIBUTED_TO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ContributedTo" + } + }, + "ASSOCIATED_WITH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AssociatedWith" + } + }, + "DERIVED_FROM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DerivedFrom" + } + }, + "PRODUCED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Produced" + } + }, + "SAME_AS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SameAs" + } + } + } + }, + "com.amazonaws.sagemaker#AssociationEntityArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:(experiment|experiment-trial-component|artifact|action|context)/" + } + }, + "com.amazonaws.sagemaker#AssociationSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AssociationSummary" + } + }, + "com.amazonaws.sagemaker#AssociationSummary": { + "type": "structure", + "members": { + "SourceArn": { + "target": "com.amazonaws.sagemaker#AssociationEntityArn", + "traits": { + "smithy.api#documentation": "

The ARN of the source.

" + } + }, + "DestinationArn": { + "target": "com.amazonaws.sagemaker#AssociationEntityArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the destination.

" + } + }, + "SourceType": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "

The source type.

" + } + }, + "DestinationType": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "

The destination type.

" + } + }, + "AssociationType": { + "target": "com.amazonaws.sagemaker#AssociationEdgeType", + "traits": { + "smithy.api#documentation": "

The type of the association.

" + } + }, + "SourceName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

The name of the source.

" + } + }, + "DestinationName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

The name of the destination.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the association was created.

" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + } + }, + "traits": { + "smithy.api#documentation": "

Lists a summary of the properties of an association. An association is an entity that\n links other lineage or experiment entities. An example would be an association between a\n training job and a model.

" + } + }, + "com.amazonaws.sagemaker#AssumableRoleArns": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#RoleArn" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#AsyncInferenceClientConfig": { + "type": "structure", + "members": { + "MaxConcurrentInvocationsPerInstance": { + "target": "com.amazonaws.sagemaker#MaxConcurrentInvocationsPerInstance", + "traits": { + "smithy.api#documentation": "

The maximum number of concurrent requests sent by the SageMaker client to the model\n container. If no value is provided, SageMaker chooses an optimal value.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configures the behavior of the client used by SageMaker to interact with the model\n container during asynchronous inference.

" + } + }, + "com.amazonaws.sagemaker#AsyncInferenceConfig": { + "type": "structure", + "members": { + "ClientConfig": { + "target": "com.amazonaws.sagemaker#AsyncInferenceClientConfig", + "traits": { + "smithy.api#documentation": "

Configures the behavior of the client used by SageMaker to interact with the model\n container during asynchronous inference.

" + } + }, + "OutputConfig": { + "target": "com.amazonaws.sagemaker#AsyncInferenceOutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies the configuration for asynchronous inference invocation outputs.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies configuration for how an endpoint performs asynchronous inference.

" + } + }, + "com.amazonaws.sagemaker#AsyncInferenceNotificationConfig": { + "type": "structure", + "members": { + "SuccessTopic": { + "target": "com.amazonaws.sagemaker#SnsTopicArn", + "traits": { + "smithy.api#documentation": "

Amazon SNS topic to post a notification to when inference completes successfully. If no\n topic is provided, no notification is sent on success.

" + } + }, + "ErrorTopic": { + "target": "com.amazonaws.sagemaker#SnsTopicArn", + "traits": { + "smithy.api#documentation": "

Amazon SNS topic to post a notification to when inference fails. If no topic is provided,\n no notification is sent on failure.

" + } + }, + "IncludeInferenceResponseIn": { + "target": "com.amazonaws.sagemaker#AsyncNotificationTopicTypeList", + "traits": { + "smithy.api#documentation": "

The Amazon SNS topics where you want the inference response to be included.

\n \n

The inference response is included only if the response size is less than or equal\n to 128 KB.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the configuration for notifications of inference results for asynchronous\n inference.

" + } + }, + "com.amazonaws.sagemaker#AsyncInferenceOutputConfig": { + "type": "structure", + "members": { + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker\n uses to encrypt the asynchronous inference output in Amazon S3.

\n

" + } + }, + "S3OutputPath": { + "target": "com.amazonaws.sagemaker#DestinationS3Uri", + "traits": { + "smithy.api#documentation": "

The Amazon S3 location to upload inference responses to.

" + } + }, + "NotificationConfig": { + "target": "com.amazonaws.sagemaker#AsyncInferenceNotificationConfig", + "traits": { + "smithy.api#documentation": "

Specifies the configuration for notifications of inference results for asynchronous\n inference.

" + } + }, + "S3FailurePath": { + "target": "com.amazonaws.sagemaker#DestinationS3Uri", + "traits": { + "smithy.api#documentation": "

The Amazon S3 location to upload failure inference responses to.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the configuration for asynchronous inference invocation outputs.

" + } + }, + "com.amazonaws.sagemaker#AsyncNotificationTopicTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AsyncNotificationTopicTypes" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2 + } + } + }, + "com.amazonaws.sagemaker#AsyncNotificationTopicTypes": { + "type": "enum", + "members": { + "SUCCESS_NOTIFICATION_TOPIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS_NOTIFICATION_TOPIC" + } + }, + "ERROR_NOTIFICATION_TOPIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR_NOTIFICATION_TOPIC" + } + } + } + }, + "com.amazonaws.sagemaker#AthenaCatalog": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The name of the data catalog used in Athena query execution.

", + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*$" + } + }, + "com.amazonaws.sagemaker#AthenaDatabase": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The name of the database used in the Athena query execution.

", + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#AthenaDatasetDefinition": { + "type": "structure", + "members": { + "Catalog": { + "target": "com.amazonaws.sagemaker#AthenaCatalog", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.sagemaker#AthenaDatabase", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "QueryString": { + "target": "com.amazonaws.sagemaker#AthenaQueryString", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "WorkGroup": { + "target": "com.amazonaws.sagemaker#AthenaWorkGroup" + }, + "OutputS3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The location in Amazon S3 where Athena query results are stored.

", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data generated from\n an Athena query execution.

" + } + }, + "OutputFormat": { + "target": "com.amazonaws.sagemaker#AthenaResultFormat", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "OutputCompression": { + "target": "com.amazonaws.sagemaker#AthenaResultCompressionType" + } + }, + "traits": { + "smithy.api#documentation": "

Configuration for Athena Dataset Definition input.

" + } + }, + "com.amazonaws.sagemaker#AthenaQueryString": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The SQL query statements, to be executed.

", + "smithy.api#length": { + "min": 1, + "max": 4096 + }, + "smithy.api#pattern": "^[\\s\\S]+$" + } + }, + "com.amazonaws.sagemaker#AthenaResultCompressionType": { + "type": "enum", + "members": { + "GZIP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GZIP" + } + }, + "SNAPPY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SNAPPY" + } + }, + "ZLIB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZLIB" + } + } + }, + "traits": { + "smithy.api#documentation": "

The compression used for Athena query results.

" + } + }, + "com.amazonaws.sagemaker#AthenaResultFormat": { + "type": "enum", + "members": { + "PARQUET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARQUET" + } + }, + "ORC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ORC" + } + }, + "AVRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVRO" + } + }, + "JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSON" + } + }, + "TEXTFILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEXTFILE" + } + } + }, + "traits": { + "smithy.api#documentation": "

The data storage format for Athena query results.

" + } + }, + "com.amazonaws.sagemaker#AthenaWorkGroup": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The name of the workgroup in which the Athena query is being started.

", + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._-]+$" + } + }, + "com.amazonaws.sagemaker#AttributeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.sagemaker#AttributeNames": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AttributeName" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 16 + } + } + }, + "com.amazonaws.sagemaker#AuthMode": { + "type": "enum", + "members": { + "SSO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SSO" + } + }, + "IAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM" + } + } + } + }, + "com.amazonaws.sagemaker#AuthenticationRequestExtraParams": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#AuthenticationRequestExtraParamsKey" + }, + "value": { + "target": "com.amazonaws.sagemaker#AuthenticationRequestExtraParamsValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.sagemaker#AuthenticationRequestExtraParamsKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#AuthenticationRequestExtraParamsValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#AutoGenerateEndpointName": { + "type": "boolean" + }, + "com.amazonaws.sagemaker#AutoMLAlgorithm": { + "type": "enum", + "members": { + "XGBOOST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "xgboost" + } + }, + "LINEAR_LEARNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "linear-learner" + } + }, + "MLP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "mlp" + } + }, + "LIGHTGBM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "lightgbm" + } + }, + "CATBOOST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "catboost" + } + }, + "RANDOMFOREST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "randomforest" + } + }, + "EXTRA_TREES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "extra-trees" + } + }, + "NN_TORCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nn-torch" + } + }, + "FASTAI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fastai" + } + }, + "CNN_QR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cnn-qr" + } + }, + "DEEPAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deepar" + } + }, + "PROPHET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "prophet" + } + }, + "NPTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "npts" + } + }, + "ARIMA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "arima" + } + }, + "ETS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ets" + } + } + } + }, + "com.amazonaws.sagemaker#AutoMLAlgorithmConfig": { + "type": "structure", + "members": { + "AutoMLAlgorithms": { + "target": "com.amazonaws.sagemaker#AutoMLAlgorithms", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The selection of algorithms trained on your dataset to generate the model candidates for\n an Autopilot job.

\n
    \n
  • \n

    \n For the tabular problem type\n TabularJobConfig:\n

    \n \n

    Selected algorithms must belong to the list corresponding to the training mode\n set in AutoMLJobConfig.Mode (ENSEMBLING or\n HYPERPARAMETER_TUNING). Choose a minimum of 1 algorithm.

    \n     \n
      \n
    • \n

      In ENSEMBLING mode:

      \n
        \n
      • \n

        \"catboost\"

        \n
        • \n
      • \n

        \"extra-trees\"

        \n
        • \n
      • \n

        \"fastai\"

        \n
        • \n
      • \n

        \"lightgbm\"

        \n
        • \n
      • \n

        \"linear-learner\"

        \n
        • \n
      • \n

        \"nn-torch\"

        \n
        • \n
      • \n

        \"randomforest\"

        \n
        • \n
      • \n

        \"xgboost\"

        \n
        • \n
      \n
      • \n
    • \n

      In HYPERPARAMETER_TUNING mode:

      \n
        \n
      • \n

        \"linear-learner\"

        \n
        • \n
      • \n

        \"mlp\"

        \n
        • \n
      • \n

        \"xgboost\"

        \n
        • \n
      \n
      • \n
    \n
    • \n
  • \n

    \n For the time-series forecasting problem type\n TimeSeriesForecastingJobConfig:\n

    \n
      \n
    • \n

      Choose your algorithms from this list.

      \n
        \n
      • \n

        \"cnn-qr\"

        \n
        • \n
      • \n

        \"deepar\"

        \n
        • \n
      • \n

        \"prophet\"

        \n
        • \n
      • \n

        \"arima\"

        \n
        • \n
      • \n

        \"npts\"

        \n
        • \n
      • \n

        \"ets\"

        \n
        • \n
      \n
      • \n
    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The selection of algorithms trained on your dataset to generate the model candidates for\n an Autopilot job.

" + } + }, + "com.amazonaws.sagemaker#AutoMLAlgorithms": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AutoMLAlgorithm" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 11 + } + } + }, + "com.amazonaws.sagemaker#AutoMLAlgorithmsConfig": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AutoMLAlgorithmConfig" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.sagemaker#AutoMLCandidate": { + "type": "structure", + "members": { + "CandidateName": { + "target": "com.amazonaws.sagemaker#CandidateName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the candidate.

", + "smithy.api#required": {} + } + }, + "FinalAutoMLJobObjectiveMetric": { + "target": "com.amazonaws.sagemaker#FinalAutoMLJobObjectiveMetric" + }, + "ObjectiveStatus": { + "target": "com.amazonaws.sagemaker#ObjectiveStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The objective's status.

", + "smithy.api#required": {} + } + }, + "CandidateSteps": { + "target": "com.amazonaws.sagemaker#CandidateSteps", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Information about the candidate's steps.

", + "smithy.api#required": {} + } + }, + "CandidateStatus": { + "target": "com.amazonaws.sagemaker#CandidateStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The candidate's status.

", + "smithy.api#required": {} + } + }, + "InferenceContainers": { + "target": "com.amazonaws.sagemaker#AutoMLContainerDefinitions", + "traits": { + "smithy.api#documentation": "

Information about the recommended inference container definitions.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The creation time.

", + "smithy.api#required": {} + } + }, + "EndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The end time.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The last modified time.

", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#AutoMLFailureReason", + "traits": { + "smithy.api#documentation": "

The failure reason.

" + } + }, + "CandidateProperties": { + "target": "com.amazonaws.sagemaker#CandidateProperties", + "traits": { + "smithy.api#documentation": "

The properties of an AutoML candidate job.

" + } + }, + "InferenceContainerDefinitions": { + "target": "com.amazonaws.sagemaker#AutoMLInferenceContainerDefinitions", + "traits": { + "smithy.api#documentation": "

The mapping of all supported processing unit (CPU, GPU, etc...) to inference container\n definitions for the candidate. This field is populated for the AutoML jobs V2 (for example,\n for jobs created by calling CreateAutoMLJobV2) related to image or text\n classification problem types only.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a candidate produced by an AutoML training job, including its status,\n steps, and other properties.

" + } + }, + "com.amazonaws.sagemaker#AutoMLCandidateGenerationConfig": { + "type": "structure", + "members": { + "FeatureSpecificationS3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "

A URL to the Amazon S3 data source containing selected features from the input\n data source to run an Autopilot job. You can input FeatureAttributeNames\n (optional) in JSON format as shown below:

\n

\n { \"FeatureAttributeNames\":[\"col1\", \"col2\", ...] }.

\n

You can also specify the data type of the feature (optional) in the format shown\n below:

\n

\n { \"FeatureDataTypes\":{\"col1\":\"numeric\", \"col2\":\"categorical\" ... } }\n

\n \n

These column keys may not include the target column.

\n \n

In ensembling mode, Autopilot only supports the following data types: numeric,\n categorical, text, and datetime. In HPO mode,\n Autopilot can support numeric, categorical, text,\n datetime, and sequence.

\n

If only FeatureDataTypes is provided, the column keys (col1,\n col2,..) should be a subset of the column names in the input data.

\n

If both FeatureDataTypes and FeatureAttributeNames are\n provided, then the column keys should be a subset of the column names provided in\n FeatureAttributeNames.

\n

The key name FeatureAttributeNames is fixed. The values listed in\n [\"col1\", \"col2\", ...] are case sensitive and should be a list of strings\n containing unique values that are a subset of the column names in the input data. The list\n of columns provided must not include the target column.

" + } + }, + "AlgorithmsConfig": { + "target": "com.amazonaws.sagemaker#AutoMLAlgorithmsConfig", + "traits": { + "smithy.api#documentation": "

Stores the configuration information for the selection of algorithms trained on tabular\n data.

\n

The list of available algorithms to choose from depends on the training mode set in\n \n TabularJobConfig.Mode\n .

\n
    \n
  • \n

    \n AlgorithmsConfig should not be set if the training mode is set on\n AUTO.

    \n
    • \n
  • \n

    When AlgorithmsConfig is provided, one AutoMLAlgorithms\n attribute must be set and one only.

    \n

    If the list of algorithms provided as values for AutoMLAlgorithms is\n empty, CandidateGenerationConfig uses the full set of algorithms for the\n given training mode.

    \n
    • \n
  • \n

    When AlgorithmsConfig is not provided,\n CandidateGenerationConfig uses the full set of algorithms for the\n given training mode.

    \n
    • \n
\n

For the list of all algorithms per problem type and training mode, see \n AutoMLAlgorithmConfig.

\n

For more information on each algorithm, see the Algorithm support section in Autopilot developer guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Stores the configuration information for how a candidate is generated (optional).

" + } + }, + "com.amazonaws.sagemaker#AutoMLCandidateStep": { + "type": "structure", + "members": { + "CandidateStepType": { + "target": "com.amazonaws.sagemaker#CandidateStepType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Whether the candidate is at the transform, training, or processing step.

", + "smithy.api#required": {} + } + }, + "CandidateStepArn": { + "target": "com.amazonaws.sagemaker#CandidateStepArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN for the candidate's step.

", + "smithy.api#required": {} + } + }, + "CandidateStepName": { + "target": "com.amazonaws.sagemaker#CandidateStepName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name for the candidate's step.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the steps for a candidate and what step it is working on.

" + } + }, + "com.amazonaws.sagemaker#AutoMLCandidates": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AutoMLCandidate" + } + }, + "com.amazonaws.sagemaker#AutoMLChannel": { + "type": "structure", + "members": { + "DataSource": { + "target": "com.amazonaws.sagemaker#AutoMLDataSource", + "traits": { + "smithy.api#documentation": "

The data source for an AutoML channel.

" + } + }, + "CompressionType": { + "target": "com.amazonaws.sagemaker#CompressionType", + "traits": { + "smithy.api#documentation": "

You can use Gzip or None. The default value is\n None.

" + } + }, + "TargetAttributeName": { + "target": "com.amazonaws.sagemaker#TargetAttributeName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the target variable in supervised learning, usually represented by\n 'y'.

", + "smithy.api#required": {} + } + }, + "ContentType": { + "target": "com.amazonaws.sagemaker#ContentType", + "traits": { + "smithy.api#documentation": "

The content type of the data from the input source. You can use\n text/csv;header=present or x-application/vnd.amazon+parquet.\n The default value is text/csv;header=present.

" + } + }, + "ChannelType": { + "target": "com.amazonaws.sagemaker#AutoMLChannelType", + "traits": { + "smithy.api#documentation": "

The channel type (optional) is an enum string. The default value is\n training. Channels for training and validation must share the same\n ContentType and TargetAttributeName. For information on\n specifying training and validation channel types, see How to specify training and validation datasets.

" + } + }, + "SampleWeightAttributeName": { + "target": "com.amazonaws.sagemaker#SampleWeightAttributeName", + "traits": { + "smithy.api#documentation": "

If specified, this column name indicates which column of the dataset should be treated\n as sample weights for use by the objective metric during the training, evaluation, and the\n selection of the best model. This column is not considered as a predictive feature. For\n more information on Autopilot metrics, see Metrics and\n validation.

\n

Sample weights should be numeric, non-negative, with larger values indicating which rows\n are more important than others. Data points that have invalid or no weight value are\n excluded.

\n

Support for sample weights is available in Ensembling\n mode only.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A channel is a named input source that training algorithms can consume. The validation\n dataset size is limited to less than 2 GB. The training dataset size must be less than 100\n GB. For more information, see Channel.

\n \n

A validation dataset must contain the same headers as the training dataset.

\n \n

" + } + }, + "com.amazonaws.sagemaker#AutoMLChannelType": { + "type": "enum", + "members": { + "TRAINING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "training" + } + }, + "VALIDATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "validation" + } + } + } + }, + "com.amazonaws.sagemaker#AutoMLComputeConfig": { + "type": "structure", + "members": { + "EmrServerlessComputeConfig": { + "target": "com.amazonaws.sagemaker#EmrServerlessComputeConfig", + "traits": { + "smithy.api#documentation": "

The configuration for using EMR Serverless\n to run the AutoML job V2.

\n

To allow your AutoML job V2 to automatically initiate a remote job on EMR Serverless\n when additional compute resources are needed to process large datasets, you need to provide\n an EmrServerlessComputeConfig object, which includes an\n ExecutionRoleARN attribute, to the AutoMLComputeConfig of the\n AutoML job V2 input request.

\n

By seamlessly transitioning to EMR Serverless when required, the AutoML job can handle\n datasets that would otherwise exceed the initially provisioned resources, without any\n manual intervention from you.

\n

EMR Serverless is available for the tabular and time series problem types. We\n recommend setting up this option for tabular datasets larger than 5 GB and time series\n datasets larger than 30 GB.

" + } + } + }, + "traits": { + "smithy.api#documentation": "\n

This data type is intended for use exclusively by SageMaker Canvas and cannot be used in\n other contexts at the moment.

\n \n

Specifies the compute configuration for an AutoML job V2.

" + } + }, + "com.amazonaws.sagemaker#AutoMLContainerDefinition": { + "type": "structure", + "members": { + "Image": { + "target": "com.amazonaws.sagemaker#ContainerImage", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Elastic Container Registry (Amazon ECR) path of the container. For more\n information, see \n ContainerDefinition.

", + "smithy.api#required": {} + } + }, + "ModelDataUrl": { + "target": "com.amazonaws.sagemaker#Url", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The location of the model artifacts. For more information, see \n ContainerDefinition.

", + "smithy.api#required": {} + } + }, + "Environment": { + "target": "com.amazonaws.sagemaker#EnvironmentMap", + "traits": { + "smithy.api#documentation": "

The environment variables to set in the container. For more information, see \n ContainerDefinition.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of container definitions that describe the different containers that make up an\n AutoML candidate. For more information, see \n ContainerDefinition.

" + } + }, + "com.amazonaws.sagemaker#AutoMLContainerDefinitions": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AutoMLContainerDefinition" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#AutoMLDataSource": { + "type": "structure", + "members": { + "S3DataSource": { + "target": "com.amazonaws.sagemaker#AutoMLS3DataSource", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon S3 location of the input data.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The data source for the Autopilot job.

" + } + }, + "com.amazonaws.sagemaker#AutoMLDataSplitConfig": { + "type": "structure", + "members": { + "ValidationFraction": { + "target": "com.amazonaws.sagemaker#ValidationFraction", + "traits": { + "smithy.api#documentation": "

The validation fraction (optional) is a float that specifies the portion of the training\n dataset to be used for validation. The default value is 0.2, and values must be greater\n than 0 and less than 1. We recommend setting this value to be less than 0.5.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This structure specifies how to split the data into train and validation\n datasets.

\n

The validation and training datasets must contain the same headers. For jobs created by\n calling CreateAutoMLJob, the validation dataset must be less than 2 GB in\n size.

" + } + }, + "com.amazonaws.sagemaker#AutoMLFailureReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.sagemaker#AutoMLInferenceContainerDefinitions": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#AutoMLProcessingUnit", + "traits": { + "smithy.api#documentation": "

Processing unit for an inference container. Currently Autopilot only supports\n CPU or GPU.

" + } + }, + "value": { + "target": "com.amazonaws.sagemaker#AutoMLContainerDefinitions", + "traits": { + "smithy.api#documentation": "

Information about the recommended inference container definitions.

" + } + }, + "traits": { + "smithy.api#documentation": "

The mapping of all supported processing unit (CPU, GPU, etc...) to inference container\n definitions for the candidate. This field is populated for the V2 API only (for example,\n for jobs created by calling CreateAutoMLJobV2).

", + "smithy.api#length": { + "min": 0, + "max": 2 + } + } + }, + "com.amazonaws.sagemaker#AutoMLInputDataConfig": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AutoMLChannel" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.sagemaker#AutoMLJobArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:automl-job/" + } + }, + "com.amazonaws.sagemaker#AutoMLJobArtifacts": { + "type": "structure", + "members": { + "CandidateDefinitionNotebookLocation": { + "target": "com.amazonaws.sagemaker#CandidateDefinitionNotebookLocation", + "traits": { + "smithy.api#documentation": "

The URL of the notebook location.

" + } + }, + "DataExplorationNotebookLocation": { + "target": "com.amazonaws.sagemaker#DataExplorationNotebookLocation", + "traits": { + "smithy.api#documentation": "

The URL of the notebook location.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The artifacts that are generated during an AutoML job.

" + } + }, + "com.amazonaws.sagemaker#AutoMLJobChannel": { + "type": "structure", + "members": { + "ChannelType": { + "target": "com.amazonaws.sagemaker#AutoMLChannelType", + "traits": { + "smithy.api#documentation": "

The type of channel. Defines whether the data are used for training or validation. The\n default value is training. Channels for training and\n validation must share the same ContentType\n

\n \n

The type of channel defaults to training for the time-series forecasting\n problem type.

\n " + } + }, + "ContentType": { + "target": "com.amazonaws.sagemaker#ContentType", + "traits": { + "smithy.api#documentation": "

The content type of the data from the input source. The following are the allowed\n content types for different problems:

\n
    \n
  • \n

    For tabular problem types: text/csv;header=present or\n x-application/vnd.amazon+parquet. The default value is\n text/csv;header=present.

    \n
    • \n
  • \n

    For image classification: image/png, image/jpeg, or\n image/*. The default value is image/*.

    \n
    • \n
  • \n

    For text classification: text/csv;header=present or\n x-application/vnd.amazon+parquet. The default value is\n text/csv;header=present.

    \n
    • \n
  • \n

    For time-series forecasting: text/csv;header=present or\n x-application/vnd.amazon+parquet. The default value is\n text/csv;header=present.

    \n
    • \n
  • \n

    For text generation (LLMs fine-tuning): text/csv;header=present or\n x-application/vnd.amazon+parquet. The default value is\n text/csv;header=present.

    \n
    • \n
" + } + }, + "CompressionType": { + "target": "com.amazonaws.sagemaker#CompressionType", + "traits": { + "smithy.api#documentation": "

The allowed compression types depend on the input format and problem type. We allow the\n compression type Gzip for S3Prefix inputs on tabular data only.\n For all other inputs, the compression type should be None. If no compression\n type is provided, we default to None.

" + } + }, + "DataSource": { + "target": "com.amazonaws.sagemaker#AutoMLDataSource", + "traits": { + "smithy.api#documentation": "

The data source for an AutoML channel (Required).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A channel is a named input source that training algorithms can consume. This channel is\n used for AutoML jobs V2 (jobs created by calling CreateAutoMLJobV2).

" + } + }, + "com.amazonaws.sagemaker#AutoMLJobCompletionCriteria": { + "type": "structure", + "members": { + "MaxCandidates": { + "target": "com.amazonaws.sagemaker#MaxCandidates", + "traits": { + "smithy.api#documentation": "

The maximum number of times a training job is allowed to run.

\n

For text and image classification, time-series forecasting, as well as text generation\n (LLMs fine-tuning) problem types, the supported value is 1. For tabular problem types, the\n maximum value is 750.

" + } + }, + "MaxRuntimePerTrainingJobInSeconds": { + "target": "com.amazonaws.sagemaker#MaxRuntimePerTrainingJobInSeconds", + "traits": { + "smithy.api#documentation": "

The maximum time, in seconds, that each training job executed inside hyperparameter\n tuning is allowed to run as part of a hyperparameter tuning job. For more information, see\n the StoppingCondition\n used by the CreateHyperParameterTuningJob action.

\n

For job V2s (jobs created by calling CreateAutoMLJobV2), this field\n controls the runtime of the job candidate.

\n

For TextGenerationJobConfig problem types, the maximum time defaults to 72 hours\n (259200 seconds).

" + } + }, + "MaxAutoMLJobRuntimeInSeconds": { + "target": "com.amazonaws.sagemaker#MaxAutoMLJobRuntimeInSeconds", + "traits": { + "smithy.api#documentation": "

The maximum runtime, in seconds, an AutoML job has to complete.

\n

If an AutoML job exceeds the maximum runtime, the job is stopped automatically and its\n processing is ended gracefully. The AutoML job identifies the best model whose training was\n completed and marks it as the best-performing model. Any unfinished steps of the job, such\n as automatic one-click Autopilot model deployment, are not completed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

How long a job is allowed to run, or how many candidates a job is allowed to\n generate.

" + } + }, + "com.amazonaws.sagemaker#AutoMLJobConfig": { + "type": "structure", + "members": { + "CompletionCriteria": { + "target": "com.amazonaws.sagemaker#AutoMLJobCompletionCriteria", + "traits": { + "smithy.api#documentation": "

How long an AutoML job is allowed to run, or how many candidates a job is allowed to\n generate.

" + } + }, + "SecurityConfig": { + "target": "com.amazonaws.sagemaker#AutoMLSecurityConfig", + "traits": { + "smithy.api#documentation": "

The security configuration for traffic encryption or Amazon VPC settings.

" + } + }, + "CandidateGenerationConfig": { + "target": "com.amazonaws.sagemaker#AutoMLCandidateGenerationConfig", + "traits": { + "smithy.api#documentation": "

The configuration for generating a candidate for an AutoML job (optional).

" + } + }, + "DataSplitConfig": { + "target": "com.amazonaws.sagemaker#AutoMLDataSplitConfig", + "traits": { + "smithy.api#documentation": "

The configuration for splitting the input training dataset.

\n

Type: AutoMLDataSplitConfig

" + } + }, + "Mode": { + "target": "com.amazonaws.sagemaker#AutoMLMode", + "traits": { + "smithy.api#documentation": "

The method that Autopilot uses to train the data. You can either specify the mode manually\n or let Autopilot choose for you based on the dataset size by selecting AUTO. In\n AUTO mode, Autopilot chooses ENSEMBLING for datasets smaller than\n 100 MB, and HYPERPARAMETER_TUNING for larger ones.

\n

The ENSEMBLING mode uses a multi-stack ensemble model to predict\n classification and regression tasks directly from your dataset. This machine learning mode\n combines several base models to produce an optimal predictive model. It then uses a\n stacking ensemble method to combine predictions from contributing members. A multi-stack\n ensemble model can provide better performance over a single model by combining the\n predictive capabilities of multiple models. See Autopilot algorithm support for a list of algorithms supported by\n ENSEMBLING mode.

\n

The HYPERPARAMETER_TUNING (HPO) mode uses the best hyperparameters to train\n the best version of a model. HPO automatically selects an algorithm for the type of problem\n you want to solve. Then HPO finds the best hyperparameters according to your objective\n metric. See Autopilot algorithm support for a list of algorithms supported by\n HYPERPARAMETER_TUNING mode.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A collection of settings used for an AutoML job.

" + } + }, + "com.amazonaws.sagemaker#AutoMLJobInputDataConfig": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AutoMLJobChannel" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.sagemaker#AutoMLJobName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}$" + } + }, + "com.amazonaws.sagemaker#AutoMLJobObjective": { + "type": "structure", + "members": { + "MetricName": { + "target": "com.amazonaws.sagemaker#AutoMLMetricEnum", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the objective metric used to measure the predictive quality of a machine\n learning system. During training, the model's parameters are updated iteratively to\n optimize its performance based on the feedback provided by the objective metric when\n evaluating the model on the validation dataset.

\n

The list of available metrics supported by Autopilot and the default metric applied when you\n do not specify a metric name explicitly depend on the problem type.

\n
    \n
  • \n

    For tabular problem types:

    \n
      \n
    • \n

      List of available metrics:

      \n
        \n
      • \n

        Regression: MAE, MSE, R2,\n RMSE\n

        \n
        • \n
      • \n

        Binary classification: Accuracy, AUC,\n BalancedAccuracy, F1,\n Precision, Recall\n

        \n
        • \n
      • \n

        Multiclass classification: Accuracy,\n BalancedAccuracy, F1macro,\n PrecisionMacro, RecallMacro\n

        \n
        • \n
      \n

      For a description of each metric, see Autopilot metrics for classification and regression.

      \n
      • \n
    • \n

      Default objective metrics:

      \n
        \n
      • \n

        Regression: MSE.

        \n
        • \n
      • \n

        Binary classification: F1.

        \n
        • \n
      • \n

        Multiclass classification: Accuracy.

        \n
        • \n
      \n
      • \n
    \n
    • \n
  • \n

    For image or text classification problem types:

    \n \n
    • \n
  • \n

    For time-series forecasting problem types:

    \n
      \n
    • \n

      List of available metrics: RMSE, wQL,\n Average wQL, MASE, MAPE,\n WAPE\n

      \n

      For a description of each metric, see Autopilot metrics for\n time-series forecasting.

      \n
      • \n
    • \n

      Default objective metrics: AverageWeightedQuantileLoss\n

      \n
      • \n
    \n
    • \n
  • \n

    For text generation problem types (LLMs fine-tuning): \n Fine-tuning language models in Autopilot does not\n require setting the AutoMLJobObjective field. Autopilot fine-tunes LLMs\n without requiring multiple candidates to be trained and evaluated. \n Instead, using your dataset, Autopilot directly fine-tunes your target model to enhance a\n default objective metric, the cross-entropy loss. After fine-tuning a language model,\n you can evaluate the quality of its generated text using different metrics. \n For a list of the available metrics, see Metrics for\n fine-tuning LLMs in Autopilot.

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies a metric to minimize or maximize as the objective of an AutoML job.

" + } + }, + "com.amazonaws.sagemaker#AutoMLJobObjectiveType": { + "type": "enum", + "members": { + "MAXIMIZE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Maximize" + } + }, + "MINIMIZE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Minimize" + } + } + } + }, + "com.amazonaws.sagemaker#AutoMLJobSecondaryStatus": { + "type": "enum", + "members": { + "STARTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Starting" + } + }, + "MAX_CANDIDATES_REACHED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MaxCandidatesReached" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + }, + "MAX_AUTO_ML_JOB_RUNTIME_REACHED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MaxAutoMLJobRuntimeReached" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "CANDIDATE_DEFINITIONS_GENERATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CandidateDefinitionsGenerated" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "EXPLAINABILITY_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ExplainabilityError" + } + }, + "DEPLOYING_MODEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeployingModel" + } + }, + "MODEL_DEPLOYMENT_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ModelDeploymentError" + } + }, + "GENERATING_MODEL_INSIGHTS_REPORT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GeneratingModelInsightsReport" + } + }, + "MODEL_INSIGHTS_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ModelInsightsError" + } + }, + "ANALYZING_DATA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AnalyzingData" + } + }, + "FEATURE_ENGINEERING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FeatureEngineering" + } + }, + "MODEL_TUNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ModelTuning" + } + }, + "GENERATING_EXPLAINABILITY_REPORT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GeneratingExplainabilityReport" + } + }, + "TRAINING_MODELS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TrainingModels" + } + }, + "PRE_TRAINING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PreTraining" + } + } + } + }, + "com.amazonaws.sagemaker#AutoMLJobStatus": { + "type": "enum", + "members": { + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + } + } + }, + "com.amazonaws.sagemaker#AutoMLJobStepMetadata": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#AutoMLJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AutoML job.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Metadata for an AutoML job step.

" + } + }, + "com.amazonaws.sagemaker#AutoMLJobSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AutoMLJobSummary" + } + }, + "com.amazonaws.sagemaker#AutoMLJobSummary": { + "type": "structure", + "members": { + "AutoMLJobName": { + "target": "com.amazonaws.sagemaker#AutoMLJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the AutoML job you are requesting.

", + "smithy.api#required": {} + } + }, + "AutoMLJobArn": { + "target": "com.amazonaws.sagemaker#AutoMLJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the AutoML job.

", + "smithy.api#required": {} + } + }, + "AutoMLJobStatus": { + "target": "com.amazonaws.sagemaker#AutoMLJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of the AutoML job.

", + "smithy.api#required": {} + } + }, + "AutoMLJobSecondaryStatus": { + "target": "com.amazonaws.sagemaker#AutoMLJobSecondaryStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The secondary status of the AutoML job.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

When the AutoML job was created.

", + "smithy.api#required": {} + } + }, + "EndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The end time of an AutoML job.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

When the AutoML job was last modified.

", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#AutoMLFailureReason", + "traits": { + "smithy.api#documentation": "

The failure reason of an AutoML job.

" + } + }, + "PartialFailureReasons": { + "target": "com.amazonaws.sagemaker#AutoMLPartialFailureReasons", + "traits": { + "smithy.api#documentation": "

The list of reasons for partial failures within an AutoML job.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides a summary about an AutoML job.

" + } + }, + "com.amazonaws.sagemaker#AutoMLMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#AutoMLMaxResultsForTrials": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 300 + } + } + }, + "com.amazonaws.sagemaker#AutoMLMetricEnum": { + "type": "enum", + "members": { + "ACCURACY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Accuracy" + } + }, + "MSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MSE" + } + }, + "F1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "F1" + } + }, + "F1_MACRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "F1macro" + } + }, + "AUC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUC" + } + }, + "RMSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RMSE" + } + }, + "BALANCED_ACCURACY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BalancedAccuracy" + } + }, + "R2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "R2" + } + }, + "RECALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Recall" + } + }, + "RECALL_MACRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RecallMacro" + } + }, + "PRECISION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Precision" + } + }, + "PRECISION_MACRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PrecisionMacro" + } + }, + "MAE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAE" + } + }, + "MAPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAPE" + } + }, + "MASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MASE" + } + }, + "WAPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WAPE" + } + }, + "AVERAGE_WEIGHTED_QUANTILE_LOSS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AverageWeightedQuantileLoss" + } + } + } + }, + "com.amazonaws.sagemaker#AutoMLMetricExtendedEnum": { + "type": "enum", + "members": { + "ACCURACY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Accuracy" + } + }, + "MSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MSE" + } + }, + "F1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "F1" + } + }, + "F1_MACRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "F1macro" + } + }, + "AUC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUC" + } + }, + "RMSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RMSE" + } + }, + "MAE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAE" + } + }, + "R2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "R2" + } + }, + "BALANCED_ACCURACY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BalancedAccuracy" + } + }, + "PRECISION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Precision" + } + }, + "PRECISION_MACRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PrecisionMacro" + } + }, + "RECALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Recall" + } + }, + "RECALL_MACRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RecallMacro" + } + }, + "LogLoss": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LogLoss" + } + }, + "INFERENCE_LATENCY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InferenceLatency" + } + }, + "MAPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAPE" + } + }, + "MASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MASE" + } + }, + "WAPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WAPE" + } + }, + "AVERAGE_WEIGHTED_QUANTILE_LOSS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AverageWeightedQuantileLoss" + } + }, + "ROUGE1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Rouge1" + } + }, + "ROUGE2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Rouge2" + } + }, + "ROUGEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RougeL" + } + }, + "ROUGEL_SUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RougeLSum" + } + }, + "PERPLEXITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Perplexity" + } + }, + "VALIDATION_LOSS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ValidationLoss" + } + }, + "TRAINING_LOSS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TrainingLoss" + } + } + } + }, + "com.amazonaws.sagemaker#AutoMLMode": { + "type": "enum", + "members": { + "AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO" + } + }, + "ENSEMBLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENSEMBLING" + } + }, + "HYPERPARAMETER_TUNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HYPERPARAMETER_TUNING" + } + } + } + }, + "com.amazonaws.sagemaker#AutoMLNameContains": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\-]+$" + } + }, + "com.amazonaws.sagemaker#AutoMLOutputDataConfig": { + "type": "structure", + "members": { + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The Key Management Service encryption key ID.

" + } + }, + "S3OutputPath": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon S3 output path. Must be 512 characters or less.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The output data configuration.

" + } + }, + "com.amazonaws.sagemaker#AutoMLPartialFailureReason": { + "type": "structure", + "members": { + "PartialFailureMessage": { + "target": "com.amazonaws.sagemaker#AutoMLFailureReason", + "traits": { + "smithy.api#documentation": "

The message containing the reason for a partial failure of an AutoML job.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The reason for a partial failure of an AutoML job.

" + } + }, + "com.amazonaws.sagemaker#AutoMLPartialFailureReasons": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AutoMLPartialFailureReason" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#AutoMLProblemTypeConfig": { + "type": "union", + "members": { + "ImageClassificationJobConfig": { + "target": "com.amazonaws.sagemaker#ImageClassificationJobConfig", + "traits": { + "smithy.api#documentation": "

Settings used to configure an AutoML job V2 for the image classification problem\n type.

" + } + }, + "TextClassificationJobConfig": { + "target": "com.amazonaws.sagemaker#TextClassificationJobConfig", + "traits": { + "smithy.api#documentation": "

Settings used to configure an AutoML job V2 for the text classification problem\n type.

" + } + }, + "TimeSeriesForecastingJobConfig": { + "target": "com.amazonaws.sagemaker#TimeSeriesForecastingJobConfig", + "traits": { + "smithy.api#documentation": "

Settings used to configure an AutoML job V2 for the time-series forecasting problem\n type.

" + } + }, + "TabularJobConfig": { + "target": "com.amazonaws.sagemaker#TabularJobConfig", + "traits": { + "smithy.api#documentation": "

Settings used to configure an AutoML job V2 for the tabular problem type (regression,\n classification).

" + } + }, + "TextGenerationJobConfig": { + "target": "com.amazonaws.sagemaker#TextGenerationJobConfig", + "traits": { + "smithy.api#documentation": "

Settings used to configure an AutoML job V2 for the text generation (LLMs fine-tuning)\n problem type.

\n \n

The text generation models that support fine-tuning in Autopilot are currently accessible\n exclusively in regions supported by Canvas. Refer to the documentation of Canvas for the full list of its supported\n Regions.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

A collection of settings specific to the problem type used to configure an AutoML job V2.\n There must be one and only one config of the following type.

" + } + }, + "com.amazonaws.sagemaker#AutoMLProblemTypeConfigName": { + "type": "enum", + "members": { + "IMAGE_CLASSIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ImageClassification" + } + }, + "TEXT_CLASSIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TextClassification" + } + }, + "TIMESERIES_FORECASTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TimeSeriesForecasting" + } + }, + "TABULAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Tabular" + } + }, + "TEXT_GENERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TextGeneration" + } + } + } + }, + "com.amazonaws.sagemaker#AutoMLProblemTypeResolvedAttributes": { + "type": "union", + "members": { + "TabularResolvedAttributes": { + "target": "com.amazonaws.sagemaker#TabularResolvedAttributes", + "traits": { + "smithy.api#documentation": "

The resolved attributes for the tabular problem type.

" + } + }, + "TextGenerationResolvedAttributes": { + "target": "com.amazonaws.sagemaker#TextGenerationResolvedAttributes", + "traits": { + "smithy.api#documentation": "

The resolved attributes for the text generation problem type.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Stores resolved attributes specific to the problem type of an AutoML job V2.

" + } + }, + "com.amazonaws.sagemaker#AutoMLProcessingUnit": { + "type": "enum", + "members": { + "CPU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CPU" + } + }, + "GPU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GPU" + } + } + } + }, + "com.amazonaws.sagemaker#AutoMLResolvedAttributes": { + "type": "structure", + "members": { + "AutoMLJobObjective": { + "target": "com.amazonaws.sagemaker#AutoMLJobObjective" + }, + "CompletionCriteria": { + "target": "com.amazonaws.sagemaker#AutoMLJobCompletionCriteria" + }, + "AutoMLProblemTypeResolvedAttributes": { + "target": "com.amazonaws.sagemaker#AutoMLProblemTypeResolvedAttributes", + "traits": { + "smithy.api#documentation": "

Defines the resolved attributes specific to a problem type.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The resolved attributes used to configure an AutoML job V2.

" + } + }, + "com.amazonaws.sagemaker#AutoMLS3DataSource": { + "type": "structure", + "members": { + "S3DataType": { + "target": "com.amazonaws.sagemaker#AutoMLS3DataType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The data type.

\n
    \n
  • \n

    If you choose S3Prefix, S3Uri identifies a key name\n prefix. SageMaker AI uses all objects that match the specified key name prefix\n for model training.

    \n

    The S3Prefix should have the following format:

    \n

    \n s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER-OR-FILE\n

    \n
    • \n
  • \n

    If you choose ManifestFile, S3Uri identifies an object\n that is a manifest file containing a list of object keys that you want SageMaker AI to use for model training.

    \n

    A ManifestFile should have the format shown below:

    \n

    \n [ {\"prefix\":\n \"s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER/DOC-EXAMPLE-PREFIX/\"}, \n

    \n

    \n \"DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-1\",\n

    \n

    \n \"DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-2\",\n

    \n

    \n ... \"DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-N\" ]\n

    \n
    • \n
  • \n

    If you choose AugmentedManifestFile, S3Uri identifies an\n object that is an augmented manifest file in JSON lines format. This file contains\n the data you want to use for model training. AugmentedManifestFile is\n available for V2 API jobs only (for example, for jobs created by calling\n CreateAutoMLJobV2).

    \n

    Here is a minimal, single-record example of an\n AugmentedManifestFile:

    \n

    \n {\"source-ref\":\n \"s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER/cats/cat.jpg\",\n

    \n

    \n \"label-metadata\": {\"class-name\": \"cat\" }

    \n

    For more information on AugmentedManifestFile, see Provide\n Dataset Metadata to Training Jobs with an Augmented Manifest File.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "S3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The URL to the Amazon S3 data source. The Uri refers to the Amazon S3\n prefix or ManifestFile depending on the data type.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the Amazon S3 data source.

" + } + }, + "com.amazonaws.sagemaker#AutoMLS3DataType": { + "type": "enum", + "members": { + "MANIFEST_FILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ManifestFile" + } + }, + "S3_PREFIX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3Prefix" + } + }, + "AUGMENTED_MANIFEST_FILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AugmentedManifestFile" + } + } + } + }, + "com.amazonaws.sagemaker#AutoMLSecurityConfig": { + "type": "structure", + "members": { + "VolumeKmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The key used to encrypt stored data.

" + } + }, + "EnableInterContainerTrafficEncryption": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

Whether to use traffic encryption between the container layers.

" + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig", + "traits": { + "smithy.api#documentation": "

The VPC configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Security options.

" + } + }, + "com.amazonaws.sagemaker#AutoMLSortBy": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + } + } + }, + "com.amazonaws.sagemaker#AutoMLSortOrder": { + "type": "enum", + "members": { + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ascending" + } + }, + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Descending" + } + } + } + }, + "com.amazonaws.sagemaker#AutoMountHomeEFS": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enabled" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disabled" + } + }, + "DEFAULT_AS_DOMAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DefaultAsDomain" + } + } + } + }, + "com.amazonaws.sagemaker#AutoParameter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#ParameterKey", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the hyperparameter to optimize using Autotune.

", + "smithy.api#required": {} + } + }, + "ValueHint": { + "target": "com.amazonaws.sagemaker#ParameterValue", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An example value of the hyperparameter to optimize using Autotune.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The name and an example value of the hyperparameter that you want to use in Autotune.\n If Automatic model tuning (AMT) determines that your hyperparameter is eligible for\n Autotune, an optimal hyperparameter range is selected for you.

" + } + }, + "com.amazonaws.sagemaker#AutoParameters": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AutoParameter" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#AutoRollbackConfig": { + "type": "structure", + "members": { + "Alarms": { + "target": "com.amazonaws.sagemaker#AlarmList", + "traits": { + "smithy.api#documentation": "

List of CloudWatch alarms in your account that are configured to monitor metrics on an\n endpoint. If any alarms are tripped during a deployment, SageMaker rolls back the\n deployment.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Automatic rollback configuration for handling endpoint deployment failures and\n recovery.

" + } + }, + "com.amazonaws.sagemaker#Autotune": { + "type": "structure", + "members": { + "Mode": { + "target": "com.amazonaws.sagemaker#AutotuneMode", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Set Mode to Enabled if you want to use Autotune.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A flag to indicate if you want to use Autotune to automatically find optimal values\n for the following fields:

\n
    \n
  • \n

    \n ParameterRanges: The names and ranges of parameters that a\n hyperparameter tuning job can optimize.

    \n
    • \n
  • \n

    \n ResourceLimits: The maximum resources that can be used for a\n training job. These resources include the maximum number of training jobs, the\n maximum runtime of a tuning job, and the maximum number of training jobs to run\n at the same time.

    \n
    • \n
  • \n

    \n TrainingJobEarlyStoppingType: A flag that specifies whether or not\n to use early stopping for training jobs launched by a hyperparameter tuning\n job.

    \n
    • \n
  • \n

    \n RetryStrategy: The number of times to retry a training job.

    \n
    • \n
  • \n

    \n Strategy: Specifies how hyperparameter tuning chooses the\n combinations of hyperparameter values to use for the training jobs that it\n launches.

    \n
    • \n
  • \n

    \n ConvergenceDetected: A flag to indicate that Automatic model tuning\n (AMT) has detected model convergence.

    \n
    • \n
" + } + }, + "com.amazonaws.sagemaker#AutotuneMode": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enabled" + } + } + } + }, + "com.amazonaws.sagemaker#AvailabilityZone": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + }, + "smithy.api#pattern": "^[a-z]+\\-[0-9a-z\\-]+$" + } + }, + "com.amazonaws.sagemaker#AvailableInstanceCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.sagemaker#AwsManagedHumanLoopRequestSource": { + "type": "enum", + "members": { + "REKOGNITION_DETECT_MODERATION_LABELS_IMAGE_V3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS/Rekognition/DetectModerationLabels/Image/V3" + } + }, + "TEXTRACT_ANALYZE_DOCUMENT_FORMS_V1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS/Textract/AnalyzeDocument/Forms/V1" + } + } + } + }, + "com.amazonaws.sagemaker#BacktestResultsLocation": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#BaseModelName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + } + }, + "com.amazonaws.sagemaker#BatchDataCaptureConfig": { + "type": "structure", + "members": { + "DestinationS3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon S3 location being used to capture the data.

", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on\n the storage volume attached to the ML compute instance that hosts the batch transform job.

\n

The KmsKeyId can be any of the following formats:

\n
    \n
  • \n

    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Key ARN:\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Alias name: alias/ExampleAlias\n

    \n
    • \n
  • \n

    Alias name ARN:\n arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\n

    \n
    • \n
" + } + }, + "GenerateInferenceId": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

Flag that indicates whether to append inference id to the output.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration to control how SageMaker captures inference data for batch transform jobs.

" + } + }, + "com.amazonaws.sagemaker#BatchDeleteClusterNodes": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#BatchDeleteClusterNodesRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#BatchDeleteClusterNodesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes specific nodes within a SageMaker HyperPod cluster. BatchDeleteClusterNodes\n accepts a cluster name and a list of node IDs.

\n \n \n " + } + }, + "com.amazonaws.sagemaker#BatchDeleteClusterNodesError": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.sagemaker#BatchDeleteClusterNodesErrorCode", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The error code associated with the error encountered when deleting a node.

\n

The code provides information about the specific issue encountered, such as the node not\n being found, the node's status being invalid for deletion, or the node ID being in use by\n another process.

", + "smithy.api#required": {} + } + }, + "Message": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A message describing the error encountered when deleting a node.

", + "smithy.api#required": {} + } + }, + "NodeId": { + "target": "com.amazonaws.sagemaker#ClusterNodeId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the node that encountered an error during the deletion process.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents an error encountered when deleting a node from a SageMaker HyperPod cluster.

" + } + }, + "com.amazonaws.sagemaker#BatchDeleteClusterNodesErrorCode": { + "type": "enum", + "members": { + "NODE_ID_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NodeIdNotFound" + } + }, + "INVALID_NODE_STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidNodeStatus" + } + }, + "NODE_ID_IN_USE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NodeIdInUse" + } + } + } + }, + "com.amazonaws.sagemaker#BatchDeleteClusterNodesErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#BatchDeleteClusterNodesError" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 99 + } + } + }, + "com.amazonaws.sagemaker#BatchDeleteClusterNodesRequest": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.sagemaker#ClusterNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the SageMaker HyperPod cluster from which to delete the specified nodes.

", + "smithy.api#required": {} + } + }, + "NodeIds": { + "target": "com.amazonaws.sagemaker#ClusterNodeIds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A list of node IDs to be deleted from the specified cluster.

\n \n

For SageMaker HyperPod clusters using the Slurm workload manager, \n you cannot remove instances that are configured as Slurm controller nodes.

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#BatchDeleteClusterNodesResponse": { + "type": "structure", + "members": { + "Failed": { + "target": "com.amazonaws.sagemaker#BatchDeleteClusterNodesErrorList", + "traits": { + "smithy.api#documentation": "

A list of errors encountered when deleting the specified nodes.

" + } + }, + "Successful": { + "target": "com.amazonaws.sagemaker#ClusterNodeIds", + "traits": { + "smithy.api#documentation": "

A list of node IDs that were successfully deleted from the specified cluster.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#BatchDescribeModelPackage": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#BatchDescribeModelPackageInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#BatchDescribeModelPackageOutput" + }, + "traits": { + "smithy.api#documentation": "

This action batch describes a list of versioned model packages

" + } + }, + "com.amazonaws.sagemaker#BatchDescribeModelPackageError": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + }, + "ErrorResponse": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The error code and error description associated with the resource.

" + } + }, + "com.amazonaws.sagemaker#BatchDescribeModelPackageErrorMap": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#ModelPackageArn" + }, + "value": { + "target": "com.amazonaws.sagemaker#BatchDescribeModelPackageError" + } + }, + "com.amazonaws.sagemaker#BatchDescribeModelPackageInput": { + "type": "structure", + "members": { + "ModelPackageArnList": { + "target": "com.amazonaws.sagemaker#ModelPackageArnList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The list of Amazon Resource Name (ARN) of the model package groups.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#BatchDescribeModelPackageOutput": { + "type": "structure", + "members": { + "ModelPackageSummaries": { + "target": "com.amazonaws.sagemaker#ModelPackageSummaries", + "traits": { + "smithy.api#documentation": "

The summaries for the model package versions

" + } + }, + "BatchDescribeModelPackageErrorMap": { + "target": "com.amazonaws.sagemaker#BatchDescribeModelPackageErrorMap", + "traits": { + "smithy.api#documentation": "

A map of the resource and BatchDescribeModelPackageError objects \n reporting the error associated with describing the model package.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#BatchDescribeModelPackageSummary": { + "type": "structure", + "members": { + "ModelPackageGroupName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The group name for the model package

", + "smithy.api#required": {} + } + }, + "ModelPackageVersion": { + "target": "com.amazonaws.sagemaker#ModelPackageVersion", + "traits": { + "smithy.api#documentation": "

The version number of a versioned model.

" + } + }, + "ModelPackageArn": { + "target": "com.amazonaws.sagemaker#ModelPackageArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model package.

", + "smithy.api#required": {} + } + }, + "ModelPackageDescription": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "

The description of the model package.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The creation time of the mortgage package summary.

", + "smithy.api#required": {} + } + }, + "InferenceSpecification": { + "target": "com.amazonaws.sagemaker#InferenceSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "ModelPackageStatus": { + "target": "com.amazonaws.sagemaker#ModelPackageStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of the mortgage package.

", + "smithy.api#required": {} + } + }, + "ModelApprovalStatus": { + "target": "com.amazonaws.sagemaker#ModelApprovalStatus", + "traits": { + "smithy.api#documentation": "

The approval status of the model.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides summary information about the model package.

" + } + }, + "com.amazonaws.sagemaker#BatchStrategy": { + "type": "enum", + "members": { + "MULTI_RECORD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MultiRecord" + } + }, + "SINGLE_RECORD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SingleRecord" + } + } + } + }, + "com.amazonaws.sagemaker#BatchTransformInput": { + "type": "structure", + "members": { + "DataCapturedDestinationS3Uri": { + "target": "com.amazonaws.sagemaker#DestinationS3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon S3 location being used to capture the data.

", + "smithy.api#required": {} + } + }, + "DatasetFormat": { + "target": "com.amazonaws.sagemaker#MonitoringDatasetFormat", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The dataset format for your batch transform job.

", + "smithy.api#required": {} + } + }, + "LocalPath": { + "target": "com.amazonaws.sagemaker#ProcessingLocalPath", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Path to the filesystem where the batch transform data is available to the container.

", + "smithy.api#required": {} + } + }, + "S3InputMode": { + "target": "com.amazonaws.sagemaker#ProcessingS3InputMode", + "traits": { + "smithy.api#documentation": "

Whether the Pipe or File is used as the input mode for\n transferring data for the monitoring job. Pipe mode is recommended for large\n datasets. File mode is useful for small files that fit in memory. Defaults to\n File.

" + } + }, + "S3DataDistributionType": { + "target": "com.amazonaws.sagemaker#ProcessingS3DataDistributionType", + "traits": { + "smithy.api#documentation": "

Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key.\n Defaults to FullyReplicated\n

" + } + }, + "FeaturesAttribute": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The attributes of the input data that are the input features.

" + } + }, + "InferenceAttribute": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The attribute of the input data that represents the ground truth label.

" + } + }, + "ProbabilityAttribute": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

In a classification problem, the attribute that represents the class probability.

" + } + }, + "ProbabilityThresholdAttribute": { + "target": "com.amazonaws.sagemaker#ProbabilityThresholdAttribute", + "traits": { + "smithy.api#documentation": "

The threshold for the class probability to be evaluated as a positive result.

" + } + }, + "StartTimeOffset": { + "target": "com.amazonaws.sagemaker#MonitoringTimeOffsetString", + "traits": { + "smithy.api#documentation": "

If specified, monitoring jobs substract this time from the start time. For information\n about using offsets for scheduling monitoring jobs, see Schedule Model\n Quality Monitoring Jobs.

" + } + }, + "EndTimeOffset": { + "target": "com.amazonaws.sagemaker#MonitoringTimeOffsetString", + "traits": { + "smithy.api#documentation": "

If specified, monitoring jobs subtract this time from the end time. For information\n about using offsets for scheduling monitoring jobs, see Schedule Model\n Quality Monitoring Jobs.

" + } + }, + "ExcludeFeaturesAttribute": { + "target": "com.amazonaws.sagemaker#ExcludeFeaturesAttribute", + "traits": { + "smithy.api#documentation": "

The attributes of the input data to exclude from the analysis.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Input object for the batch transform job.

" + } + }, + "com.amazonaws.sagemaker#BestObjectiveNotImproving": { + "type": "structure", + "members": { + "MaxNumberOfTrainingJobsNotImproving": { + "target": "com.amazonaws.sagemaker#MaxNumberOfTrainingJobsNotImproving", + "traits": { + "smithy.api#documentation": "

The number of training jobs that have failed to improve model performance by 1% or\n greater over prior training jobs as evaluated against an objective function.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that keeps track of which training jobs launched by your hyperparameter\n tuning job are not improving model performance as evaluated against an objective\n function.

" + } + }, + "com.amazonaws.sagemaker#Bias": { + "type": "structure", + "members": { + "Report": { + "target": "com.amazonaws.sagemaker#MetricsSource", + "traits": { + "smithy.api#documentation": "

The bias report for a model

" + } + }, + "PreTrainingReport": { + "target": "com.amazonaws.sagemaker#MetricsSource", + "traits": { + "smithy.api#documentation": "

The pre-training bias report for a model.

" + } + }, + "PostTrainingReport": { + "target": "com.amazonaws.sagemaker#MetricsSource", + "traits": { + "smithy.api#documentation": "

The post-training bias report for a model.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains bias metrics for a model.

" + } + }, + "com.amazonaws.sagemaker#BillableTimeInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#BlockedReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.sagemaker#BlueGreenUpdatePolicy": { + "type": "structure", + "members": { + "TrafficRoutingConfiguration": { + "target": "com.amazonaws.sagemaker#TrafficRoutingConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Defines the traffic routing strategy to shift traffic from the old fleet to the new\n fleet during an endpoint deployment.

", + "smithy.api#required": {} + } + }, + "TerminationWaitInSeconds": { + "target": "com.amazonaws.sagemaker#TerminationWaitInSeconds", + "traits": { + "smithy.api#documentation": "

Additional waiting time in seconds after the completion of an endpoint deployment\n before terminating the old endpoint fleet. Default is 0.

" + } + }, + "MaximumExecutionTimeoutInSeconds": { + "target": "com.amazonaws.sagemaker#MaximumExecutionTimeoutInSeconds", + "traits": { + "smithy.api#documentation": "

Maximum execution timeout for the deployment. Note that the timeout value should be\n larger than the total waiting time specified in TerminationWaitInSeconds\n and WaitIntervalInSeconds.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Update policy for a blue/green deployment. If this update policy is specified, SageMaker\n creates a new fleet during the deployment while maintaining the old fleet. SageMaker flips\n traffic to the new fleet according to the specified traffic routing configuration. Only\n one update policy should be used in the deployment configuration. If no update policy is\n specified, SageMaker uses a blue/green deployment strategy with all at once traffic shifting\n by default.

" + } + }, + "com.amazonaws.sagemaker#Boolean": { + "type": "boolean" + }, + "com.amazonaws.sagemaker#BooleanOperator": { + "type": "enum", + "members": { + "AND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "And" + } + }, + "OR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Or" + } + } + } + }, + "com.amazonaws.sagemaker#BorrowLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.sagemaker#Branch": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[^ ~^:?*\\[]+$" + } + }, + "com.amazonaws.sagemaker#BucketName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$" + } + }, + "com.amazonaws.sagemaker#CacheHitResult": { + "type": "structure", + "members": { + "SourcePipelineExecutionArn": { + "target": "com.amazonaws.sagemaker#PipelineExecutionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the pipeline execution.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details on the cache hit of a pipeline execution step.

" + } + }, + "com.amazonaws.sagemaker#CallbackStepMetadata": { + "type": "structure", + "members": { + "CallbackToken": { + "target": "com.amazonaws.sagemaker#CallbackToken", + "traits": { + "smithy.api#documentation": "

The pipeline generated token from the Amazon SQS queue.

" + } + }, + "SqsQueueUrl": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "

The URL of the Amazon Simple Queue Service (Amazon SQS) queue used by the callback step.

" + } + }, + "OutputParameters": { + "target": "com.amazonaws.sagemaker#OutputParameterList", + "traits": { + "smithy.api#documentation": "

A list of the output parameters of the callback step.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Metadata about a callback step.

" + } + }, + "com.amazonaws.sagemaker#CallbackToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 10 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]+$" + } + }, + "com.amazonaws.sagemaker#CandidateArtifactLocations": { + "type": "structure", + "members": { + "Explainability": { + "target": "com.amazonaws.sagemaker#ExplainabilityLocation", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon S3 prefix to the explainability artifacts generated for the AutoML\n candidate.

", + "smithy.api#required": {} + } + }, + "ModelInsights": { + "target": "com.amazonaws.sagemaker#ModelInsightsLocation", + "traits": { + "smithy.api#documentation": "

The Amazon S3 prefix to the model insight artifacts generated for the AutoML\n candidate.

" + } + }, + "BacktestResults": { + "target": "com.amazonaws.sagemaker#BacktestResultsLocation", + "traits": { + "smithy.api#documentation": "

The Amazon S3 prefix to the accuracy metrics and the inference results observed\n over the testing window. Available only for the time-series forecasting problem\n type.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The location of artifacts for an AutoML candidate job.

" + } + }, + "com.amazonaws.sagemaker#CandidateDefinitionNotebookLocation": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#CandidateGenerationConfig": { + "type": "structure", + "members": { + "AlgorithmsConfig": { + "target": "com.amazonaws.sagemaker#AutoMLAlgorithmsConfig", + "traits": { + "smithy.api#documentation": "

Your Autopilot job trains a default set of algorithms on your dataset. For tabular and\n time-series data, you can customize the algorithm list by selecting a subset of algorithms\n for your problem type.

\n

\n AlgorithmsConfig stores the customized selection of algorithms to train on\n your data.

\n
    \n
  • \n

    \n For the tabular problem type\n TabularJobConfig, the list of available algorithms to\n choose from depends on the training mode set in \n AutoMLJobConfig.Mode\n .

    \n
      \n
    • \n

      \n AlgorithmsConfig should not be set when the training mode\n AutoMLJobConfig.Mode is set to AUTO.

      \n
      • \n
    • \n

      When AlgorithmsConfig is provided, one\n AutoMLAlgorithms attribute must be set and one only.

      \n

      If the list of algorithms provided as values for\n AutoMLAlgorithms is empty,\n CandidateGenerationConfig uses the full set of algorithms for\n the given training mode.

      \n
      • \n
    • \n

      When AlgorithmsConfig is not provided,\n CandidateGenerationConfig uses the full set of algorithms for\n the given training mode.

      \n
      • \n
    \n

    For the list of all algorithms per training mode, see \n AlgorithmConfig.

    \n

    For more information on each algorithm, see the Algorithm support section in the Autopilot developer guide.

    \n
    • \n
  • \n

    \n For the time-series forecasting problem type\n TimeSeriesForecastingJobConfig, choose your algorithms\n from the list provided in \n AlgorithmConfig.

    \n

    For more information on each algorithm, see the Algorithms\n support for time-series forecasting section in the Autopilot developer\n guide.

    \n
      \n
    • \n

      When AlgorithmsConfig is provided, one\n AutoMLAlgorithms attribute must be set and one only.

      \n

      If the list of algorithms provided as values for\n AutoMLAlgorithms is empty,\n CandidateGenerationConfig uses the full set of algorithms for\n time-series forecasting.

      \n
      • \n
    • \n

      When AlgorithmsConfig is not provided,\n CandidateGenerationConfig uses the full set of algorithms for\n time-series forecasting.

      \n
      • \n
    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

Stores the configuration information for how model candidates are generated using an\n AutoML job V2.

" + } + }, + "com.amazonaws.sagemaker#CandidateName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.sagemaker#CandidateProperties": { + "type": "structure", + "members": { + "CandidateArtifactLocations": { + "target": "com.amazonaws.sagemaker#CandidateArtifactLocations", + "traits": { + "smithy.api#documentation": "

The Amazon S3 prefix to the artifacts generated for an AutoML candidate.

" + } + }, + "CandidateMetrics": { + "target": "com.amazonaws.sagemaker#MetricDataList", + "traits": { + "smithy.api#documentation": "

Information about the candidate metrics for an AutoML job.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The properties of an AutoML candidate job.

" + } + }, + "com.amazonaws.sagemaker#CandidateSortBy": { + "type": "enum", + "members": { + "CreationTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "Status": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + }, + "FinalObjectiveMetricValue": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FinalObjectiveMetricValue" + } + } + } + }, + "com.amazonaws.sagemaker#CandidateStatus": { + "type": "enum", + "members": { + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + } + } + }, + "com.amazonaws.sagemaker#CandidateStepArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:.*/" + } + }, + "com.amazonaws.sagemaker#CandidateStepName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.sagemaker#CandidateStepType": { + "type": "enum", + "members": { + "TRAINING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::SageMaker::TrainingJob" + } + }, + "TRANSFORM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::SageMaker::TransformJob" + } + }, + "PROCESSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::SageMaker::ProcessingJob" + } + } + } + }, + "com.amazonaws.sagemaker#CandidateSteps": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AutoMLCandidateStep" + } + }, + "com.amazonaws.sagemaker#CanvasAppSettings": { + "type": "structure", + "members": { + "TimeSeriesForecastingSettings": { + "target": "com.amazonaws.sagemaker#TimeSeriesForecastingSettings", + "traits": { + "smithy.api#documentation": "

Time series forecast settings for the SageMaker Canvas application.

" + } + }, + "ModelRegisterSettings": { + "target": "com.amazonaws.sagemaker#ModelRegisterSettings", + "traits": { + "smithy.api#documentation": "

The model registry settings for the SageMaker Canvas application.

" + } + }, + "WorkspaceSettings": { + "target": "com.amazonaws.sagemaker#WorkspaceSettings", + "traits": { + "smithy.api#documentation": "

The workspace settings for the SageMaker Canvas application.

" + } + }, + "IdentityProviderOAuthSettings": { + "target": "com.amazonaws.sagemaker#IdentityProviderOAuthSettings", + "traits": { + "smithy.api#documentation": "

The settings for connecting to an external data source with OAuth.

" + } + }, + "DirectDeploySettings": { + "target": "com.amazonaws.sagemaker#DirectDeploySettings", + "traits": { + "smithy.api#documentation": "

The model deployment settings for the SageMaker Canvas application.

" + } + }, + "KendraSettings": { + "target": "com.amazonaws.sagemaker#KendraSettings", + "traits": { + "smithy.api#documentation": "

The settings for document querying.

" + } + }, + "GenerativeAiSettings": { + "target": "com.amazonaws.sagemaker#GenerativeAiSettings", + "traits": { + "smithy.api#documentation": "

The generative AI settings for the SageMaker Canvas application.

" + } + }, + "EmrServerlessSettings": { + "target": "com.amazonaws.sagemaker#EmrServerlessSettings", + "traits": { + "smithy.api#documentation": "

The settings for running Amazon EMR Serverless data processing jobs in SageMaker Canvas.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The SageMaker Canvas application settings.

" + } + }, + "com.amazonaws.sagemaker#CapacitySize": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.sagemaker#CapacitySizeType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies the endpoint capacity type.

\n
    \n
  • \n

    \n INSTANCE_COUNT: The endpoint activates based on the number of\n instances.

    \n
    • \n
  • \n

    \n CAPACITY_PERCENT: The endpoint activates based on the specified\n percentage of capacity.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.sagemaker#CapacitySizeValue", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Defines the capacity size, either as a number of instances or a capacity\n percentage.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the type and size of the endpoint capacity to activate for a blue/green\n deployment, a rolling deployment, or a rollback strategy. You can specify your batches\n as either instance count or the overall percentage or your fleet.

\n

For a rollback strategy, if you don't specify the fields in this object, or if you set\n the Value to 100%, then SageMaker uses a blue/green rollback strategy and rolls\n all traffic back to the blue fleet.

" + } + }, + "com.amazonaws.sagemaker#CapacitySizeType": { + "type": "enum", + "members": { + "INSTANCE_COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSTANCE_COUNT" + } + }, + "CAPACITY_PERCENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CAPACITY_PERCENT" + } + } + } + }, + "com.amazonaws.sagemaker#CapacitySizeValue": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#CapacityUnit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 10000000 + } + } + }, + "com.amazonaws.sagemaker#CaptureContentTypeHeader": { + "type": "structure", + "members": { + "CsvContentTypes": { + "target": "com.amazonaws.sagemaker#CsvContentTypes", + "traits": { + "smithy.api#documentation": "

The list of all content type headers that Amazon SageMaker AI will treat as CSV and\n capture accordingly.

" + } + }, + "JsonContentTypes": { + "target": "com.amazonaws.sagemaker#JsonContentTypes", + "traits": { + "smithy.api#documentation": "

The list of all content type headers that SageMaker AI will treat as JSON and\n capture accordingly.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration specifying how to treat different headers. If no headers are specified\n Amazon SageMaker AI will by default base64 encode when capturing the data.

" + } + }, + "com.amazonaws.sagemaker#CaptureMode": { + "type": "enum", + "members": { + "INPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Input" + } + }, + "OUTPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Output" + } + }, + "INPUT_AND_OUTPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InputAndOutput" + } + } + } + }, + "com.amazonaws.sagemaker#CaptureOption": { + "type": "structure", + "members": { + "CaptureMode": { + "target": "com.amazonaws.sagemaker#CaptureMode", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specify the boundary of data to capture.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies data Model Monitor will capture.

" + } + }, + "com.amazonaws.sagemaker#CaptureOptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#CaptureOption" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + } + } + }, + "com.amazonaws.sagemaker#CaptureStatus": { + "type": "enum", + "members": { + "STARTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Started" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + } + } + }, + "com.amazonaws.sagemaker#Catalog": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*$" + } + }, + "com.amazonaws.sagemaker#CategoricalParameter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#String64", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Name of the environment variable.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.sagemaker#CategoricalParameterRangeValues", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The list of values you can pass.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Environment parameters you want to benchmark your load test against.

" + } + }, + "com.amazonaws.sagemaker#CategoricalParameterRange": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#ParameterKey", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the categorical hyperparameter to tune.

", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.sagemaker#ParameterValues", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A list of the categories\n for\n the hyperparameter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of categorical hyperparameters to tune.

" + } + }, + "com.amazonaws.sagemaker#CategoricalParameterRangeSpecification": { + "type": "structure", + "members": { + "Values": { + "target": "com.amazonaws.sagemaker#ParameterValues", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The allowed categories for the hyperparameter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines the possible values for a categorical hyperparameter.

" + } + }, + "com.amazonaws.sagemaker#CategoricalParameterRangeValues": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#String128" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 3 + } + } + }, + "com.amazonaws.sagemaker#CategoricalParameterRanges": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#CategoricalParameterRange" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 30 + } + } + }, + "com.amazonaws.sagemaker#CategoricalParameters": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#CategoricalParameter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#Cents": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 99 + } + } + }, + "com.amazonaws.sagemaker#CertifyForMarketplace": { + "type": "boolean" + }, + "com.amazonaws.sagemaker#Channel": { + "type": "structure", + "members": { + "ChannelName": { + "target": "com.amazonaws.sagemaker#ChannelName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the channel.

", + "smithy.api#required": {} + } + }, + "DataSource": { + "target": "com.amazonaws.sagemaker#DataSource", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The location of the channel data.

", + "smithy.api#required": {} + } + }, + "ContentType": { + "target": "com.amazonaws.sagemaker#ContentType", + "traits": { + "smithy.api#documentation": "

The MIME type of the data.

" + } + }, + "CompressionType": { + "target": "com.amazonaws.sagemaker#CompressionType", + "traits": { + "smithy.api#documentation": "

If training data is compressed, the compression type. The default value is\n None. CompressionType is used only in Pipe input mode. In\n File mode, leave this field unset or set it to None.

" + } + }, + "RecordWrapperType": { + "target": "com.amazonaws.sagemaker#RecordWrapper", + "traits": { + "smithy.api#documentation": "

\n

Specify RecordIO as the value when input data is in raw format but the training\n algorithm requires the RecordIO format. In this case, SageMaker wraps each individual S3\n object in a RecordIO record. If the input data is already in RecordIO format, you don't\n need to set this attribute. For more information, see Create\n a Dataset Using RecordIO.

\n

In File mode, leave this field unset or set it to None.

" + } + }, + "InputMode": { + "target": "com.amazonaws.sagemaker#TrainingInputMode", + "traits": { + "smithy.api#documentation": "

(Optional) The input mode to use for the data channel in a training job. If you don't\n set a value for InputMode, SageMaker uses the value set for\n TrainingInputMode. Use this parameter to override the\n TrainingInputMode setting in a AlgorithmSpecification request when you have a channel that needs a\n different input mode from the training job's general setting. To download the data from\n Amazon Simple Storage Service (Amazon S3) to the provisioned ML storage volume, and mount the directory to a\n Docker volume, use File input mode. To stream data directly from Amazon S3 to\n the container, choose Pipe input mode.

\n

To use a model for incremental training, choose File input model.

" + } + }, + "ShuffleConfig": { + "target": "com.amazonaws.sagemaker#ShuffleConfig", + "traits": { + "smithy.api#documentation": "

A configuration for a shuffle option for input data in a channel. If you use\n S3Prefix for S3DataType, this shuffles the results of the\n S3 key prefix matches. If you use ManifestFile, the order of the S3 object\n references in the ManifestFile is shuffled. If you use\n AugmentedManifestFile, the order of the JSON lines in the\n AugmentedManifestFile is shuffled. The shuffling order is determined\n using the Seed value.

\n

For Pipe input mode, shuffling is done at the start of every epoch. With large\n datasets this ensures that the order of the training data is different for each epoch,\n it helps reduce bias and possible overfitting. In a multi-node training job when\n ShuffleConfig is combined with S3DataDistributionType of\n ShardedByS3Key, the data is shuffled across nodes so that the content\n sent to a particular node on the first epoch might be sent to a different node on the\n second epoch.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A channel is a named input source that training algorithms can consume.

" + } + }, + "com.amazonaws.sagemaker#ChannelName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[A-Za-z0-9\\.\\-_]+$" + } + }, + "com.amazonaws.sagemaker#ChannelSpecification": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#ChannelName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the channel.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "

A brief description of the channel.

" + } + }, + "IsRequired": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the channel is required by the algorithm.

" + } + }, + "SupportedContentTypes": { + "target": "com.amazonaws.sagemaker#ContentTypes", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The supported MIME types for the data.

", + "smithy.api#required": {} + } + }, + "SupportedCompressionTypes": { + "target": "com.amazonaws.sagemaker#CompressionTypes", + "traits": { + "smithy.api#documentation": "

The allowed compression types, if data compression is used.

" + } + }, + "SupportedInputModes": { + "target": "com.amazonaws.sagemaker#InputModes", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The allowed input mode, either FILE or PIPE.

\n

In FILE mode, Amazon SageMaker copies the data from the input source onto the local Amazon\n Elastic Block Store (Amazon EBS) volumes before starting your training algorithm. This\n is the most commonly used input mode.

\n

In PIPE mode, Amazon SageMaker streams input data from the source directly to your algorithm\n without using the EBS volume.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines a named input source, called a channel, to be used by an algorithm.

" + } + }, + "com.amazonaws.sagemaker#ChannelSpecifications": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ChannelSpecification" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 8 + } + } + }, + "com.amazonaws.sagemaker#CheckpointConfig": { + "type": "structure", + "members": { + "S3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Identifies the S3 path where you want SageMaker to store checkpoints. For example,\n s3://bucket-name/key-name-prefix.

", + "smithy.api#required": {} + } + }, + "LocalPath": { + "target": "com.amazonaws.sagemaker#DirectoryPath", + "traits": { + "smithy.api#documentation": "

(Optional) The local directory where checkpoints are written. The default directory is\n /opt/ml/checkpoints/.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the output location for managed spot training checkpoint\n data.

" + } + }, + "com.amazonaws.sagemaker#Cidr": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 4, + "max": 64 + }, + "smithy.api#pattern": "^(^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\\/(3[0-2]|[1-2][0-9]|[0-9]))$)|(^s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:)))(%.+)?s*(\\/(12[0-8]|1[0-1][0-9]|[1-9][0-9]|[0-9]))$)$" + } + }, + "com.amazonaws.sagemaker#Cidrs": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#Cidr" + } + }, + "com.amazonaws.sagemaker#ClarifyCheckStepMetadata": { + "type": "structure", + "members": { + "CheckType": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "

The type of the Clarify Check step

" + } + }, + "BaselineUsedForDriftCheckConstraints": { + "target": "com.amazonaws.sagemaker#String1024", + "traits": { + "smithy.api#documentation": "

The Amazon S3 URI of baseline constraints file to be used for the drift check.

" + } + }, + "CalculatedBaselineConstraints": { + "target": "com.amazonaws.sagemaker#String1024", + "traits": { + "smithy.api#documentation": "

The Amazon S3 URI of the newly calculated baseline constraints file.

" + } + }, + "ModelPackageGroupName": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "

The model package group name.

" + } + }, + "ViolationReport": { + "target": "com.amazonaws.sagemaker#String1024", + "traits": { + "smithy.api#documentation": "

The Amazon S3 URI of the violation report if violations are detected.

" + } + }, + "CheckJobArn": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the check processing job that was run by this step's execution.

" + } + }, + "SkipCheck": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

This flag indicates if the drift check against the previous baseline will be skipped or not. \n If it is set to False, the previous baseline of the configured check type must be available.

" + } + }, + "RegisterNewBaseline": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

This flag indicates if a newly calculated baseline can be accessed through step properties \n BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. \n If it is set to False, the previous baseline of the configured check type must also be available. \n These can be accessed through the BaselineUsedForDriftCheckConstraints property.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The container for the metadata for the ClarifyCheck step. For more information, \n see the topic on ClarifyCheck step in the Amazon SageMaker Developer Guide.\n

" + } + }, + "com.amazonaws.sagemaker#ClarifyContentTemplate": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#ClarifyEnableExplanations": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#ClarifyExplainerConfig": { + "type": "structure", + "members": { + "EnableExplanations": { + "target": "com.amazonaws.sagemaker#ClarifyEnableExplanations", + "traits": { + "smithy.api#documentation": "

A JMESPath boolean expression used to filter which records to explain. Explanations\n are activated by default. See \n EnableExplanations\n for additional information.

" + } + }, + "InferenceConfig": { + "target": "com.amazonaws.sagemaker#ClarifyInferenceConfig", + "traits": { + "smithy.api#documentation": "

The inference configuration parameter for the model container.

" + } + }, + "ShapConfig": { + "target": "com.amazonaws.sagemaker#ClarifyShapConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The configuration for SHAP analysis.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration parameters for the SageMaker Clarify explainer.

" + } + }, + "com.amazonaws.sagemaker#ClarifyFeatureHeaders": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ClarifyHeader" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.sagemaker#ClarifyFeatureType": { + "type": "enum", + "members": { + "NUMERICAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "numerical" + } + }, + "CATEGORICAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "categorical" + } + }, + "TEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "text" + } + } + } + }, + "com.amazonaws.sagemaker#ClarifyFeatureTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ClarifyFeatureType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.sagemaker#ClarifyFeaturesAttribute": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#ClarifyHeader": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#ClarifyInferenceConfig": { + "type": "structure", + "members": { + "FeaturesAttribute": { + "target": "com.amazonaws.sagemaker#ClarifyFeaturesAttribute", + "traits": { + "smithy.api#documentation": "

Provides the JMESPath expression to extract the features from a model container input\n in JSON Lines format. For example, if FeaturesAttribute is the JMESPath\n expression 'myfeatures', it extracts a list of features\n [1,2,3] from request data '{\"myfeatures\":[1,2,3]}'.

" + } + }, + "ContentTemplate": { + "target": "com.amazonaws.sagemaker#ClarifyContentTemplate", + "traits": { + "smithy.api#documentation": "

A template string used to format a JSON record into an acceptable model container\n input. For example, a ContentTemplate string\n '{\"myfeatures\":$features}' will format a list of features\n [1,2,3] into the record string '{\"myfeatures\":[1,2,3]}'.\n Required only when the model container input is in JSON Lines format.

" + } + }, + "MaxRecordCount": { + "target": "com.amazonaws.sagemaker#ClarifyMaxRecordCount", + "traits": { + "smithy.api#documentation": "

The maximum number of records in a request that the model container can process when\n querying the model container for the predictions of a synthetic dataset. A record is a unit of input data that inference can be\n made on, for example, a single line in CSV data. If MaxRecordCount is\n 1, the model container expects one record per request. A value of 2 or\n greater means that the model expects batch requests, which can reduce overhead and speed\n up the inferencing process. If this parameter is not provided, the explainer will tune\n the record count per request according to the model container's capacity at\n runtime.

" + } + }, + "MaxPayloadInMB": { + "target": "com.amazonaws.sagemaker#ClarifyMaxPayloadInMB", + "traits": { + "smithy.api#documentation": "

The maximum payload size (MB) allowed of a request from the explainer to the model\n container. Defaults to 6 MB.

" + } + }, + "ProbabilityIndex": { + "target": "com.amazonaws.sagemaker#ClarifyProbabilityIndex", + "traits": { + "smithy.api#documentation": "

A zero-based index used to extract a probability value (score) or list from model\n container output in CSV format. If this value is not provided, the entire model\n container output will be treated as a probability value (score) or list.

\n

\n Example for a single class model: If the model\n container output consists of a string-formatted prediction label followed by its\n probability: '1,0.6', set ProbabilityIndex to 1\n to select the probability value 0.6.

\n

\n Example for a multiclass model: If the model\n container output consists of a string-formatted prediction label followed by its\n probability: '\"[\\'cat\\',\\'dog\\',\\'fish\\']\",\"[0.1,0.6,0.3]\"', set\n ProbabilityIndex to 1 to select the probability values\n [0.1,0.6,0.3].

" + } + }, + "LabelIndex": { + "target": "com.amazonaws.sagemaker#ClarifyLabelIndex", + "traits": { + "smithy.api#documentation": "

A zero-based index used to extract a label header or list of label headers from model\n container output in CSV format.

\n

\n Example for a multiclass model: If the model\n container output consists of label headers followed by probabilities:\n '\"[\\'cat\\',\\'dog\\',\\'fish\\']\",\"[0.1,0.6,0.3]\"', set\n LabelIndex to 0 to select the label headers\n ['cat','dog','fish'].

" + } + }, + "ProbabilityAttribute": { + "target": "com.amazonaws.sagemaker#ClarifyProbabilityAttribute", + "traits": { + "smithy.api#documentation": "

A JMESPath expression used to extract the probability (or score) from the model\n container output if the model container is in JSON Lines format.

\n

\n Example: If the model container output of a single\n request is '{\"predicted_label\":1,\"probability\":0.6}', then set\n ProbabilityAttribute to 'probability'.

" + } + }, + "LabelAttribute": { + "target": "com.amazonaws.sagemaker#ClarifyLabelAttribute", + "traits": { + "smithy.api#documentation": "

A JMESPath expression used to locate the list of label headers in the model container\n output.

\n

\n Example: If the model container output of a batch\n request is '{\"labels\":[\"cat\",\"dog\",\"fish\"],\"probability\":[0.6,0.3,0.1]}',\n then set LabelAttribute to 'labels' to extract the list of\n label headers [\"cat\",\"dog\",\"fish\"]\n

" + } + }, + "LabelHeaders": { + "target": "com.amazonaws.sagemaker#ClarifyLabelHeaders", + "traits": { + "smithy.api#documentation": "

For multiclass classification problems, the label headers are the names of the\n classes. Otherwise, the label header is the name of the predicted label. These are used\n to help readability for the output of the InvokeEndpoint API. See the\n response section under Invoke the endpoint\n in the Developer Guide for more information. If there are no label headers in the model\n container output, provide them manually using this parameter.

" + } + }, + "FeatureHeaders": { + "target": "com.amazonaws.sagemaker#ClarifyFeatureHeaders", + "traits": { + "smithy.api#documentation": "

The names of the features. If provided, these are included in the endpoint response\n payload to help readability of the InvokeEndpoint output. See the Response section under Invoke the endpoint\n in the Developer Guide for more information.

" + } + }, + "FeatureTypes": { + "target": "com.amazonaws.sagemaker#ClarifyFeatureTypes", + "traits": { + "smithy.api#documentation": "

A list of data types of the features (optional). Applicable only to NLP\n explainability. If provided, FeatureTypes must have at least one\n 'text' string (for example, ['text']). If\n FeatureTypes is not provided, the explainer infers the feature types\n based on the baseline data. The feature types are included in the endpoint response\n payload. For additional information see the response section under Invoke the endpoint\n in the Developer Guide for more information.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The inference configuration parameter for the model container.

" + } + }, + "com.amazonaws.sagemaker#ClarifyLabelAttribute": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#ClarifyLabelHeaders": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ClarifyHeader" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16 + } + } + }, + "com.amazonaws.sagemaker#ClarifyLabelIndex": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.sagemaker#ClarifyMaxPayloadInMB": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.sagemaker#ClarifyMaxRecordCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#ClarifyMimeType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*\\/[a-zA-Z0-9](-*[a-zA-Z0-9+.])*$" + } + }, + "com.amazonaws.sagemaker#ClarifyProbabilityAttribute": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#ClarifyProbabilityIndex": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.sagemaker#ClarifyShapBaseline": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + }, + "smithy.api#pattern": "^[\\s\\S]+$" + } + }, + "com.amazonaws.sagemaker#ClarifyShapBaselineConfig": { + "type": "structure", + "members": { + "MimeType": { + "target": "com.amazonaws.sagemaker#ClarifyMimeType", + "traits": { + "smithy.api#documentation": "

The MIME type of the baseline data. Choose from 'text/csv' or\n 'application/jsonlines'. Defaults to 'text/csv'.

" + } + }, + "ShapBaseline": { + "target": "com.amazonaws.sagemaker#ClarifyShapBaseline", + "traits": { + "smithy.api#documentation": "

The inline SHAP baseline data in string format. ShapBaseline can have one\n or multiple records to be used as the baseline dataset. The format of the SHAP baseline\n file should be the same format as the training dataset. For example, if the training\n dataset is in CSV format and each record contains four features, and all features are\n numerical, then the format of the baseline data should also share these characteristics.\n For natural language processing (NLP) of text columns, the baseline value should be the\n value used to replace the unit of text specified by the Granularity of the\n TextConfig parameter. The size limit for ShapBasline is 4\n KB. Use the ShapBaselineUri parameter if you want to provide more than 4 KB\n of baseline data.

" + } + }, + "ShapBaselineUri": { + "target": "com.amazonaws.sagemaker#Url", + "traits": { + "smithy.api#documentation": "

The uniform resource identifier (URI) of the S3 bucket where the SHAP baseline file is\n stored. The format of the SHAP baseline file should be the same format as the format of\n the training dataset. For example, if the training dataset is in CSV format, and each\n record in the training dataset has four features, and all features are numerical, then\n the baseline file should also have this same format. Each record should contain only the\n features. If you are using a virtual private cloud (VPC), the\n ShapBaselineUri should be accessible to the VPC. For more information\n about setting up endpoints with Amazon Virtual Private Cloud, see Give SageMaker access to\n Resources in your Amazon Virtual Private Cloud.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for the SHAP\n baseline (also called the background or reference dataset) of the Kernal\n SHAP algorithm.

\n \n
    \n
  • \n

    The number of records in the baseline data determines the size of the\n synthetic dataset, which has an impact on latency of explainability\n requests. For more information, see the Synthetic\n data of Configure and create an endpoint.

    \n
    • \n
  • \n

    \n ShapBaseline and ShapBaselineUri are mutually\n exclusive parameters. One or the either is required to configure a SHAP\n baseline.

    \n
    • \n
\n " + } + }, + "com.amazonaws.sagemaker#ClarifyShapConfig": { + "type": "structure", + "members": { + "ShapBaselineConfig": { + "target": "com.amazonaws.sagemaker#ClarifyShapBaselineConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The configuration for the SHAP baseline of the Kernal SHAP algorithm.

", + "smithy.api#required": {} + } + }, + "NumberOfSamples": { + "target": "com.amazonaws.sagemaker#ClarifyShapNumberOfSamples", + "traits": { + "smithy.api#documentation": "

The number of samples to be used for analysis by the Kernal SHAP algorithm.

\n \n

The number of samples determines the size of the synthetic dataset, which has an\n impact on latency of explainability requests. For more information, see the\n Synthetic data of Configure and create an endpoint.

\n " + } + }, + "UseLogit": { + "target": "com.amazonaws.sagemaker#ClarifyShapUseLogit", + "traits": { + "smithy.api#documentation": "

A Boolean toggle to indicate if you want to use the logit function (true) or log-odds\n units (false) for model predictions. Defaults to false.

" + } + }, + "Seed": { + "target": "com.amazonaws.sagemaker#ClarifyShapSeed", + "traits": { + "smithy.api#documentation": "

The starting value used to initialize the random number generator in the explainer.\n Provide a value for this parameter to obtain a deterministic SHAP result.

" + } + }, + "TextConfig": { + "target": "com.amazonaws.sagemaker#ClarifyTextConfig", + "traits": { + "smithy.api#documentation": "

A parameter that indicates if text features are treated as text and explanations are\n provided for individual units of text. Required for natural language processing (NLP)\n explainability only.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for SHAP analysis using SageMaker Clarify Explainer.

" + } + }, + "com.amazonaws.sagemaker#ClarifyShapNumberOfSamples": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#ClarifyShapSeed": { + "type": "integer" + }, + "com.amazonaws.sagemaker#ClarifyShapUseLogit": { + "type": "boolean" + }, + "com.amazonaws.sagemaker#ClarifyTextConfig": { + "type": "structure", + "members": { + "Language": { + "target": "com.amazonaws.sagemaker#ClarifyTextLanguage", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies the language of the text features in ISO 639-1 or\n ISO 639-3 code of a\n supported language.

\n \n

For a mix of multiple languages, use code 'xx'.

\n ", + "smithy.api#required": {} + } + }, + "Granularity": { + "target": "com.amazonaws.sagemaker#ClarifyTextGranularity", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The unit of granularity for the analysis of text features. For example, if the unit is\n 'token', then each token (like a word in English) of the text is\n treated as a feature. SHAP values are computed for each unit/feature.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A parameter used to configure the SageMaker Clarify explainer to treat text features as text so\n that explanations are provided for individual units of text. Required only for natural\n language processing (NLP) explainability.

" + } + }, + "com.amazonaws.sagemaker#ClarifyTextGranularity": { + "type": "enum", + "members": { + "TOKEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "token" + } + }, + "SENTENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sentence" + } + }, + "PARAGRAPH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "paragraph" + } + } + } + }, + "com.amazonaws.sagemaker#ClarifyTextLanguage": { + "type": "enum", + "members": { + "AFRIKAANS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "af" + } + }, + "ALBANIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sq" + } + }, + "ARABIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ar" + } + }, + "ARMENIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hy" + } + }, + "BASQUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu" + } + }, + "BENGALI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "bn" + } + }, + "BULGARIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "bg" + } + }, + "CATALAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ca" + } + }, + "CHINESE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "zh" + } + }, + "CROATIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hr" + } + }, + "CZECH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cs" + } + }, + "DANISH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "da" + } + }, + "DUTCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nl" + } + }, + "ENGLISH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "en" + } + }, + "ESTONIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "et" + } + }, + "FINNISH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fi" + } + }, + "FRENCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fr" + } + }, + "GERMAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "de" + } + }, + "GREEK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "el" + } + }, + "GUJARATI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "gu" + } + }, + "HEBREW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "he" + } + }, + "HINDI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hi" + } + }, + "HUNGARIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hu" + } + }, + "ICELANDIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "is" + } + }, + "INDONESIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "id" + } + }, + "IRISH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ga" + } + }, + "ITALIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "it" + } + }, + "KANNADA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "kn" + } + }, + "KYRGYZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ky" + } + }, + "LATVIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "lv" + } + }, + "LITHUANIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "lt" + } + }, + "LUXEMBOURGISH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "lb" + } + }, + "MACEDONIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "mk" + } + }, + "MALAYALAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml" + } + }, + "MARATHI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "mr" + } + }, + "NEPALI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ne" + } + }, + "NORWEGIAN_BOKMAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nb" + } + }, + "PERSIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fa" + } + }, + "POLISH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pl" + } + }, + "PORTUGUESE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pt" + } + }, + "ROMANIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ro" + } + }, + "RUSSIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ru" + } + }, + "SANSKRIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sa" + } + }, + "SERBIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sr" + } + }, + "SETSWANA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "tn" + } + }, + "SINHALA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "si" + } + }, + "SLOVAK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sk" + } + }, + "SLOVENIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sl" + } + }, + "SPANISH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "es" + } + }, + "SWEDISH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sv" + } + }, + "TAGALOG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "tl" + } + }, + "TAMIL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ta" + } + }, + "TATAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "tt" + } + }, + "TELUGU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "te" + } + }, + "TURKISH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "tr" + } + }, + "UKRAINIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "uk" + } + }, + "URDU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ur" + } + }, + "YORUBA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "yo" + } + }, + "LIGURIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "lij" + } + }, + "MULTI_LANGUAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "xx" + } + } + } + }, + "com.amazonaws.sagemaker#ClientId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[ -~]+$" + } + }, + "com.amazonaws.sagemaker#ClientSecret": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[ -~]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.sagemaker#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 36 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.sagemaker#ClusterArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:cluster/[a-z0-9]{12}$" + } + }, + "com.amazonaws.sagemaker#ClusterAvailabilityZone": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-z]{2}-[a-z]+-\\d[a-z]$" + } + }, + "com.amazonaws.sagemaker#ClusterAvailabilityZoneId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-z]{3}\\d-az\\d$" + } + }, + "com.amazonaws.sagemaker#ClusterEbsVolumeConfig": { + "type": "structure", + "members": { + "VolumeSizeInGB": { + "target": "com.amazonaws.sagemaker#ClusterEbsVolumeSizeInGB", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The size in gigabytes (GB) of the additional EBS volume to be attached to the instances\n in the SageMaker HyperPod cluster instance group. The additional EBS volume is attached to each\n instance within the SageMaker HyperPod cluster instance group and mounted to\n /opt/sagemaker.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines the configuration for attaching an additional Amazon Elastic Block Store (EBS)\n volume to each instance of the SageMaker HyperPod cluster instance group. To learn more, see SageMaker HyperPod release notes: June 20, 2024.

" + } + }, + "com.amazonaws.sagemaker#ClusterEbsVolumeSizeInGB": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 16384 + } + } + }, + "com.amazonaws.sagemaker#ClusterInstanceCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 6758 + } + } + }, + "com.amazonaws.sagemaker#ClusterInstanceGroupDetails": { + "type": "structure", + "members": { + "CurrentCount": { + "target": "com.amazonaws.sagemaker#ClusterNonNegativeInstanceCount", + "traits": { + "smithy.api#documentation": "

The number of instances that are currently in the instance group of a SageMaker HyperPod\n cluster.

" + } + }, + "TargetCount": { + "target": "com.amazonaws.sagemaker#ClusterInstanceCount", + "traits": { + "smithy.api#documentation": "

The number of instances you specified to add to the instance group of a SageMaker HyperPod\n cluster.

" + } + }, + "InstanceGroupName": { + "target": "com.amazonaws.sagemaker#ClusterInstanceGroupName", + "traits": { + "smithy.api#documentation": "

The name of the instance group of a SageMaker HyperPod cluster.

" + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#ClusterInstanceType", + "traits": { + "smithy.api#documentation": "

The instance type of the instance group of a SageMaker HyperPod cluster.

" + } + }, + "LifeCycleConfig": { + "target": "com.amazonaws.sagemaker#ClusterLifeCycleConfig", + "traits": { + "smithy.api#documentation": "

Details of LifeCycle configuration for the instance group.

" + } + }, + "ExecutionRole": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "

The execution role for the instance group to assume.

" + } + }, + "ThreadsPerCore": { + "target": "com.amazonaws.sagemaker#ClusterThreadsPerCore", + "traits": { + "smithy.api#documentation": "

The number you specified to TreadsPerCore in CreateCluster for\n enabling or disabling multithreading. For instance types that support multithreading, you\n can specify 1 for disabling multithreading and 2 for enabling multithreading. For more\n information, see the reference table of CPU cores and\n threads per CPU core per instance type in the Amazon Elastic Compute Cloud User\n Guide.

" + } + }, + "InstanceStorageConfigs": { + "target": "com.amazonaws.sagemaker#ClusterInstanceStorageConfigs", + "traits": { + "smithy.api#documentation": "

The additional storage configurations for the instances in the SageMaker HyperPod cluster instance\n group.

" + } + }, + "OnStartDeepHealthChecks": { + "target": "com.amazonaws.sagemaker#OnStartDeepHealthChecks", + "traits": { + "smithy.api#documentation": "

A flag indicating whether deep health checks should be performed when the cluster\n instance group is created or updated.

" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#InstanceGroupStatus", + "traits": { + "smithy.api#documentation": "

The current status of the cluster instance group.

\n
    \n
  • \n

    \n InService: The instance group is active and healthy.

    \n
    • \n
  • \n

    \n Creating: The instance group is being provisioned.

    \n
    • \n
  • \n

    \n Updating: The instance group is being updated.

    \n
    • \n
  • \n

    \n Failed: The instance group has failed to provision or is no longer\n healthy.

    \n
    • \n
  • \n

    \n Degraded: The instance group is degraded, meaning that some instances\n have failed to provision or are no longer healthy.

    \n
    • \n
  • \n

    \n Deleting: The instance group is being deleted.

    \n
    • \n
" + } + }, + "TrainingPlanArn": { + "target": "com.amazonaws.sagemaker#TrainingPlanArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN); of the training plan associated with this cluster instance group.

\n

For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using\n Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .

" + } + }, + "TrainingPlanStatus": { + "target": "com.amazonaws.sagemaker#InstanceGroupTrainingPlanStatus", + "traits": { + "smithy.api#documentation": "

The current status of the training plan associated with this cluster instance\n group.

" + } + }, + "OverrideVpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig" + } + }, + "traits": { + "smithy.api#documentation": "

Details of an instance group in a SageMaker HyperPod cluster.

" + } + }, + "com.amazonaws.sagemaker#ClusterInstanceGroupDetailsList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ClusterInstanceGroupDetails" + } + }, + "com.amazonaws.sagemaker#ClusterInstanceGroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + } + }, + "com.amazonaws.sagemaker#ClusterInstanceGroupSpecification": { + "type": "structure", + "members": { + "InstanceCount": { + "target": "com.amazonaws.sagemaker#ClusterInstanceCount", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies the number of instances to add to the instance group of a SageMaker HyperPod\n cluster.

", + "smithy.api#required": {} + } + }, + "InstanceGroupName": { + "target": "com.amazonaws.sagemaker#ClusterInstanceGroupName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies the name of the instance group.

", + "smithy.api#required": {} + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#ClusterInstanceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies the instance type of the instance group.

", + "smithy.api#required": {} + } + }, + "LifeCycleConfig": { + "target": "com.amazonaws.sagemaker#ClusterLifeCycleConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies the LifeCycle configuration for the instance group.

", + "smithy.api#required": {} + } + }, + "ExecutionRole": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies an IAM execution role to be assumed by the instance group.

", + "smithy.api#required": {} + } + }, + "ThreadsPerCore": { + "target": "com.amazonaws.sagemaker#ClusterThreadsPerCore", + "traits": { + "smithy.api#documentation": "

Specifies the value for Threads per core. For instance\n types that support multithreading, you can specify 1 for disabling\n multithreading and 2 for enabling multithreading. For instance types that\n doesn't support multithreading, specify 1. For more information, see the\n reference table of CPU cores and\n threads per CPU core per instance type in the Amazon Elastic Compute Cloud User\n Guide.

" + } + }, + "InstanceStorageConfigs": { + "target": "com.amazonaws.sagemaker#ClusterInstanceStorageConfigs", + "traits": { + "smithy.api#documentation": "

Specifies the additional storage configurations for the instances in the SageMaker HyperPod cluster\n instance group.

" + } + }, + "OnStartDeepHealthChecks": { + "target": "com.amazonaws.sagemaker#OnStartDeepHealthChecks", + "traits": { + "smithy.api#documentation": "

A flag indicating whether deep health checks should be performed when the cluster\n instance group is created or updated.

" + } + }, + "TrainingPlanArn": { + "target": "com.amazonaws.sagemaker#TrainingPlanArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN); of the training plan to use for this cluster instance group.

\n

For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using\n Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .

" + } + }, + "OverrideVpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig" + } + }, + "traits": { + "smithy.api#documentation": "

The specifications of an instance group that you need to define.

" + } + }, + "com.amazonaws.sagemaker#ClusterInstanceGroupSpecifications": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ClusterInstanceGroupSpecification" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#ClusterInstancePlacement": { + "type": "structure", + "members": { + "AvailabilityZone": { + "target": "com.amazonaws.sagemaker#ClusterAvailabilityZone", + "traits": { + "smithy.api#documentation": "

The Availability Zone where the node in the SageMaker HyperPod cluster is launched.

" + } + }, + "AvailabilityZoneId": { + "target": "com.amazonaws.sagemaker#ClusterAvailabilityZoneId", + "traits": { + "smithy.api#documentation": "

The unique identifier (ID) of the Availability Zone where the node in the SageMaker HyperPod cluster\n is launched.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the placement details for the node in the SageMaker HyperPod cluster, including the\n Availability Zone and the unique identifier (ID) of the Availability Zone.

" + } + }, + "com.amazonaws.sagemaker#ClusterInstanceStatus": { + "type": "enum", + "members": { + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Running" + } + }, + "FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failure" + } + }, + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "SHUTTING_DOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ShuttingDown" + } + }, + "SYSTEM_UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SystemUpdating" + } + }, + "DEEP_HEALTH_CHECK_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeepHealthCheckInProgress" + } + } + } + }, + "com.amazonaws.sagemaker#ClusterInstanceStatusDetails": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.sagemaker#ClusterInstanceStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of an instance in a SageMaker HyperPod cluster.

", + "smithy.api#required": {} + } + }, + "Message": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The message from an instance in a SageMaker HyperPod cluster.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details of an instance in a SageMaker HyperPod cluster.

" + } + }, + "com.amazonaws.sagemaker#ClusterInstanceStorageConfig": { + "type": "union", + "members": { + "EbsVolumeConfig": { + "target": "com.amazonaws.sagemaker#ClusterEbsVolumeConfig", + "traits": { + "smithy.api#documentation": "

Defines the configuration for attaching additional Amazon Elastic Block Store (EBS)\n volumes to the instances in the SageMaker HyperPod cluster instance group. The additional EBS volume is\n attached to each instance within the SageMaker HyperPod cluster instance group and mounted to\n /opt/sagemaker.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines the configuration for attaching additional storage to the instances in the\n SageMaker HyperPod cluster instance group. To learn more, see SageMaker HyperPod release notes: June 20, 2024.

" + } + }, + "com.amazonaws.sagemaker#ClusterInstanceStorageConfigs": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ClusterInstanceStorageConfig" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.sagemaker#ClusterInstanceType": { + "type": "enum", + "members": { + "ML_P4D_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p4d.24xlarge" + } + }, + "ML_P4DE_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p4de.24xlarge" + } + }, + "ML_P5_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p5.48xlarge" + } + }, + "ML_TRN1_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1.32xlarge" + } + }, + "ML_TRN1N_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1n.32xlarge" + } + }, + "ML_G5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.xlarge" + } + }, + "ML_G5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.2xlarge" + } + }, + "ML_G5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.4xlarge" + } + }, + "ML_G5_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.8xlarge" + } + }, + "ML_G5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.12xlarge" + } + }, + "ML_G5_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.16xlarge" + } + }, + "ML_G5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.24xlarge" + } + }, + "ML_G5_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.48xlarge" + } + }, + "ML_C5_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.large" + } + }, + "ML_C5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.xlarge" + } + }, + "ML_C5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.2xlarge" + } + }, + "ML_C5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.4xlarge" + } + }, + "ML_C5_9XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.9xlarge" + } + }, + "ML_C5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.12xlarge" + } + }, + "ML_C5_18XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.18xlarge" + } + }, + "ML_C5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.24xlarge" + } + }, + "ML_C5N_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5n.large" + } + }, + "ML_C5N_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5n.2xlarge" + } + }, + "ML_C5N_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5n.4xlarge" + } + }, + "ML_C5N_9XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5n.9xlarge" + } + }, + "ML_C5N_18XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5n.18xlarge" + } + }, + "ML_M5_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.large" + } + }, + "ML_M5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.xlarge" + } + }, + "ML_M5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.2xlarge" + } + }, + "ML_M5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.4xlarge" + } + }, + "ML_M5_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.8xlarge" + } + }, + "ML_M5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.12xlarge" + } + }, + "ML_M5_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.16xlarge" + } + }, + "ML_M5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.24xlarge" + } + }, + "ML_T3_MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.medium" + } + }, + "ML_T3_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.large" + } + }, + "ML_T3_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.xlarge" + } + }, + "ML_T3_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.2xlarge" + } + }, + "ML_G6_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.xlarge" + } + }, + "ML_G6_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.2xlarge" + } + }, + "ML_G6_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.4xlarge" + } + }, + "ML_G6_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.8xlarge" + } + }, + "ML_G6_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.16xlarge" + } + }, + "ML_G6_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.12xlarge" + } + }, + "ML_G6_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.24xlarge" + } + }, + "ML_G6_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.48xlarge" + } + }, + "ML_GR6_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.gr6.4xlarge" + } + }, + "ML_GR6_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.gr6.8xlarge" + } + }, + "ML_G6E_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.xlarge" + } + }, + "ML_G6E_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.2xlarge" + } + }, + "ML_G6E_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.4xlarge" + } + }, + "ML_G6E_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.8xlarge" + } + }, + "ML_G6E_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.16xlarge" + } + }, + "ML_G6E_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.12xlarge" + } + }, + "ML_G6E_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.24xlarge" + } + }, + "ML_G6E_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.48xlarge" + } + }, + "ML_P5E_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p5e.48xlarge" + } + }, + "ML_P5EN_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p5en.48xlarge" + } + }, + "ML_TRN2_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn2.48xlarge" + } + }, + "ML_C6I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.large" + } + }, + "ML_C6I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.xlarge" + } + }, + "ML_C6I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.2xlarge" + } + }, + "ML_C6I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.4xlarge" + } + }, + "ML_C6I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.8xlarge" + } + }, + "ML_C6I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.12xlarge" + } + }, + "ML_C6I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.16xlarge" + } + }, + "ML_C6I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.24xlarge" + } + }, + "ML_C6I_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.32xlarge" + } + }, + "ML_M6I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.large" + } + }, + "ML_M6I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.xlarge" + } + }, + "ML_M6I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.2xlarge" + } + }, + "ML_M6I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.4xlarge" + } + }, + "ML_M6I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.8xlarge" + } + }, + "ML_M6I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.12xlarge" + } + }, + "ML_M6I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.16xlarge" + } + }, + "ML_M6I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.24xlarge" + } + }, + "ML_M6I_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.32xlarge" + } + }, + "ML_R6I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.large" + } + }, + "ML_R6I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.xlarge" + } + }, + "ML_R6I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.2xlarge" + } + }, + "ML_R6I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.4xlarge" + } + }, + "ML_R6I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.8xlarge" + } + }, + "ML_R6I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.12xlarge" + } + }, + "ML_R6I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.16xlarge" + } + }, + "ML_R6I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.24xlarge" + } + }, + "ML_R6I_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.32xlarge" + } + } + } + }, + "com.amazonaws.sagemaker#ClusterLifeCycleConfig": { + "type": "structure", + "members": { + "SourceS3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An Amazon S3 bucket path where your lifecycle scripts are stored.

\n \n

Make sure that the S3 bucket path starts with s3://sagemaker-. The\n IAM role for SageMaker HyperPod has the managed \n AmazonSageMakerClusterInstanceRolePolicy\n attached, which\n allows access to S3 buckets with the specific prefix sagemaker-.

\n ", + "smithy.api#required": {} + } + }, + "OnCreate": { + "target": "com.amazonaws.sagemaker#ClusterLifeCycleConfigFileName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The file name of the entrypoint script of lifecycle scripts under\n SourceS3Uri. This entrypoint script runs during cluster creation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The lifecycle configuration for a SageMaker HyperPod cluster.

" + } + }, + "com.amazonaws.sagemaker#ClusterLifeCycleConfigFileName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\S\\s]+$" + } + }, + "com.amazonaws.sagemaker#ClusterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + } + }, + "com.amazonaws.sagemaker#ClusterNameOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:cluster/[a-z0-9]{12})|([a-zA-Z0-9](-*[a-zA-Z0-9]){0,62})$" + } + }, + "com.amazonaws.sagemaker#ClusterNodeDetails": { + "type": "structure", + "members": { + "InstanceGroupName": { + "target": "com.amazonaws.sagemaker#ClusterInstanceGroupName", + "traits": { + "smithy.api#documentation": "

The instance group name in which the instance is.

" + } + }, + "InstanceId": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The ID of the instance.

" + } + }, + "InstanceStatus": { + "target": "com.amazonaws.sagemaker#ClusterInstanceStatusDetails", + "traits": { + "smithy.api#documentation": "

The status of the instance.

" + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#ClusterInstanceType", + "traits": { + "smithy.api#documentation": "

The type of the instance.

" + } + }, + "LaunchTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the instance is launched.

" + } + }, + "LifeCycleConfig": { + "target": "com.amazonaws.sagemaker#ClusterLifeCycleConfig", + "traits": { + "smithy.api#documentation": "

The LifeCycle configuration applied to the instance.

" + } + }, + "OverrideVpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig" + }, + "ThreadsPerCore": { + "target": "com.amazonaws.sagemaker#ClusterThreadsPerCore", + "traits": { + "smithy.api#documentation": "

The number of threads per CPU core you specified under\n CreateCluster.

" + } + }, + "InstanceStorageConfigs": { + "target": "com.amazonaws.sagemaker#ClusterInstanceStorageConfigs", + "traits": { + "smithy.api#documentation": "

The configurations of additional storage specified to the instance group where the\n instance (node) is launched.

" + } + }, + "PrivatePrimaryIp": { + "target": "com.amazonaws.sagemaker#ClusterPrivatePrimaryIp", + "traits": { + "smithy.api#documentation": "

The private primary IP address of the SageMaker HyperPod cluster node.

" + } + }, + "PrivatePrimaryIpv6": { + "target": "com.amazonaws.sagemaker#ClusterPrivatePrimaryIpv6", + "traits": { + "smithy.api#documentation": "

The private primary IPv6 address of the SageMaker HyperPod cluster node.

" + } + }, + "PrivateDnsHostname": { + "target": "com.amazonaws.sagemaker#ClusterPrivateDnsHostname", + "traits": { + "smithy.api#documentation": "

The private DNS hostname of the SageMaker HyperPod cluster node.

" + } + }, + "Placement": { + "target": "com.amazonaws.sagemaker#ClusterInstancePlacement", + "traits": { + "smithy.api#documentation": "

The placement details of the SageMaker HyperPod cluster node.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details of an instance (also called a node interchangeably) in a\n SageMaker HyperPod cluster.

" + } + }, + "com.amazonaws.sagemaker#ClusterNodeId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^i-[a-f0-9]{8}(?:[a-f0-9]{9})?$" + } + }, + "com.amazonaws.sagemaker#ClusterNodeIds": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ClusterNodeId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 99 + } + } + }, + "com.amazonaws.sagemaker#ClusterNodeRecovery": { + "type": "enum", + "members": { + "AUTOMATIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Automatic" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "None" + } + } + } + }, + "com.amazonaws.sagemaker#ClusterNodeSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ClusterNodeSummary" + } + }, + "com.amazonaws.sagemaker#ClusterNodeSummary": { + "type": "structure", + "members": { + "InstanceGroupName": { + "target": "com.amazonaws.sagemaker#ClusterInstanceGroupName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the instance group in which the instance is.

", + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#required": {} + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#ClusterInstanceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of the instance.

", + "smithy.api#required": {} + } + }, + "LaunchTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The time when the instance is launched.

", + "smithy.api#required": {} + } + }, + "InstanceStatus": { + "target": "com.amazonaws.sagemaker#ClusterInstanceStatusDetails", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of the instance.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Lists a summary of the properties of an instance (also called a\n node interchangeably) of a SageMaker HyperPod cluster.

" + } + }, + "com.amazonaws.sagemaker#ClusterNonNegativeInstanceCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.sagemaker#ClusterOrchestrator": { + "type": "structure", + "members": { + "Eks": { + "target": "com.amazonaws.sagemaker#ClusterOrchestratorEksConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon EKS cluster used as the orchestrator for the SageMaker HyperPod cluster.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The type of orchestrator used for the SageMaker HyperPod cluster.

" + } + }, + "com.amazonaws.sagemaker#ClusterOrchestratorEksConfig": { + "type": "structure", + "members": { + "ClusterArn": { + "target": "com.amazonaws.sagemaker#EksClusterArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon EKS cluster associated with the SageMaker HyperPod\n cluster.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration settings for the Amazon EKS cluster used as the orchestrator for the\n SageMaker HyperPod cluster.

" + } + }, + "com.amazonaws.sagemaker#ClusterPrivateDnsHostname": { + "type": "string", + "traits": { + "smithy.api#pattern": "^ip-((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)-?\\b){4}\\..*$" + } + }, + "com.amazonaws.sagemaker#ClusterPrivatePrimaryIp": { + "type": "string", + "traits": { + "smithy.api#pattern": "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)\\.?\\b){4}$" + } + }, + "com.amazonaws.sagemaker#ClusterPrivatePrimaryIpv6": { + "type": "string" + }, + "com.amazonaws.sagemaker#ClusterSchedulerConfigArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:cluster-scheduler-config/[a-z0-9]{12}$" + } + }, + "com.amazonaws.sagemaker#ClusterSchedulerConfigId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 12 + }, + "smithy.api#pattern": "^[a-z0-9]{12}$" + } + }, + "com.amazonaws.sagemaker#ClusterSchedulerConfigSummary": { + "type": "structure", + "members": { + "ClusterSchedulerConfigArn": { + "target": "com.amazonaws.sagemaker#ClusterSchedulerConfigArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

ARN of the cluster policy.

", + "smithy.api#required": {} + } + }, + "ClusterSchedulerConfigId": { + "target": "com.amazonaws.sagemaker#ClusterSchedulerConfigId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

ID of the cluster policy.

", + "smithy.api#required": {} + } + }, + "ClusterSchedulerConfigVersion": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "

Version of the cluster policy.

" + } + }, + "Name": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Name of the cluster policy.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Creation time of the cluster policy.

", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Last modified time of the cluster policy.

" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#SchedulerResourceStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Status of the cluster policy.

", + "smithy.api#required": {} + } + }, + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#documentation": "

ARN of the cluster.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Summary of the cluster policy.

" + } + }, + "com.amazonaws.sagemaker#ClusterSchedulerConfigSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ClusterSchedulerConfigSummary" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#ClusterSchedulerPriorityClassName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9]){0,39}?$" + } + }, + "com.amazonaws.sagemaker#ClusterSortBy": { + "type": "enum", + "members": { + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_TIME" + } + }, + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAME" + } + } + } + }, + "com.amazonaws.sagemaker#ClusterStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Creating" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "INSERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InService" + } + }, + "ROLLINGBACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RollingBack" + } + }, + "SYSTEMUPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SystemUpdating" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + } + } + }, + "com.amazonaws.sagemaker#ClusterSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ClusterSummary" + } + }, + "com.amazonaws.sagemaker#ClusterSummary": { + "type": "structure", + "members": { + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

", + "smithy.api#required": {} + } + }, + "ClusterName": { + "target": "com.amazonaws.sagemaker#ClusterName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the SageMaker HyperPod cluster.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The time when the SageMaker HyperPod cluster is created.

", + "smithy.api#required": {} + } + }, + "ClusterStatus": { + "target": "com.amazonaws.sagemaker#ClusterStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of the SageMaker HyperPod cluster.

", + "smithy.api#required": {} + } + }, + "TrainingPlanArns": { + "target": "com.amazonaws.sagemaker#TrainingPlanArns", + "traits": { + "smithy.api#documentation": "

A list of Amazon Resource Names (ARNs) of the training plans associated with this\n cluster.

\n

For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using\n Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Lists a summary of the properties of a SageMaker HyperPod cluster.

" + } + }, + "com.amazonaws.sagemaker#ClusterThreadsPerCore": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.sagemaker#CodeEditorAppImageConfig": { + "type": "structure", + "members": { + "FileSystemConfig": { + "target": "com.amazonaws.sagemaker#FileSystemConfig" + }, + "ContainerConfig": { + "target": "com.amazonaws.sagemaker#ContainerConfig" + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for the file system and kernels in a SageMaker image running as a Code Editor app. \n The FileSystemConfig object is not supported.

" + } + }, + "com.amazonaws.sagemaker#CodeEditorAppSettings": { + "type": "structure", + "members": { + "DefaultResourceSpec": { + "target": "com.amazonaws.sagemaker#ResourceSpec" + }, + "CustomImages": { + "target": "com.amazonaws.sagemaker#CustomImages", + "traits": { + "smithy.api#documentation": "

A list of custom SageMaker images that are configured to run as a Code Editor app.

" + } + }, + "LifecycleConfigArns": { + "target": "com.amazonaws.sagemaker#LifecycleConfigArns", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Code Editor application \n lifecycle configuration.

" + } + }, + "AppLifecycleManagement": { + "target": "com.amazonaws.sagemaker#AppLifecycleManagement", + "traits": { + "smithy.api#documentation": "

Settings that are used to configure and manage the lifecycle of CodeEditor\n applications.

" + } + }, + "BuiltInLifecycleConfigArn": { + "target": "com.amazonaws.sagemaker#StudioLifecycleConfigArn", + "traits": { + "smithy.api#documentation": "

The lifecycle configuration that runs before the default lifecycle configuration. It can\n override changes made in the default lifecycle configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Code Editor application settings.

\n

For more information about Code Editor, see Get started with Code \n Editor in Amazon SageMaker.

" + } + }, + "com.amazonaws.sagemaker#CodeRepositories": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#CodeRepository" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.sagemaker#CodeRepository": { + "type": "structure", + "members": { + "RepositoryUrl": { + "target": "com.amazonaws.sagemaker#RepositoryUrl", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The URL of the Git repository.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A Git repository that SageMaker AI automatically displays to users for cloning in the\n JupyterServer application.

" + } + }, + "com.amazonaws.sagemaker#CodeRepositoryArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-cn|-us-gov|-iso-f)?:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:code-repository/[\\S]{1,2048}$" + } + }, + "com.amazonaws.sagemaker#CodeRepositoryContains": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.sagemaker#CodeRepositoryNameContains": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.sagemaker#CodeRepositoryNameOrUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^https://([^/]+)/?(.*)$|^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + } + }, + "com.amazonaws.sagemaker#CodeRepositorySortBy": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "LAST_MODIFIED_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LastModifiedTime" + } + } + } + }, + "com.amazonaws.sagemaker#CodeRepositorySortOrder": { + "type": "enum", + "members": { + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ascending" + } + }, + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Descending" + } + } + } + }, + "com.amazonaws.sagemaker#CodeRepositorySummary": { + "type": "structure", + "members": { + "CodeRepositoryName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Git repository.

", + "smithy.api#required": {} + } + }, + "CodeRepositoryArn": { + "target": "com.amazonaws.sagemaker#CodeRepositoryArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Git repository.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The date and time that the Git repository was created.

", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The date and time that the Git repository was last modified.

", + "smithy.api#required": {} + } + }, + "GitConfig": { + "target": "com.amazonaws.sagemaker#GitConfig", + "traits": { + "smithy.api#documentation": "

Configuration details for the Git repository, including the URL where it is located\n and the ARN of the Amazon Web Services Secrets Manager secret that contains the\n credentials used to access the repository.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies summary information about a Git repository.

" + } + }, + "com.amazonaws.sagemaker#CodeRepositorySummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#CodeRepositorySummary" + } + }, + "com.amazonaws.sagemaker#CognitoConfig": { + "type": "structure", + "members": { + "UserPool": { + "target": "com.amazonaws.sagemaker#CognitoUserPool", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A \n user pool is a user directory in Amazon Cognito. \n With a user pool, your users can sign in to your web or mobile app through Amazon Cognito. \n Your users can also sign in through social identity providers like \n Google, Facebook, Amazon, or Apple, and through SAML identity providers.

", + "smithy.api#required": {} + } + }, + "ClientId": { + "target": "com.amazonaws.sagemaker#ClientId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The client ID for your Amazon Cognito user pool.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Use this parameter to configure your Amazon Cognito workforce. \n A single Cognito workforce is created using and corresponds to a single\n \n Amazon Cognito user pool.

" + } + }, + "com.amazonaws.sagemaker#CognitoMemberDefinition": { + "type": "structure", + "members": { + "UserPool": { + "target": "com.amazonaws.sagemaker#CognitoUserPool", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An identifier for a user pool. The user pool must be in the same region as the service\n that you are calling.

", + "smithy.api#required": {} + } + }, + "UserGroup": { + "target": "com.amazonaws.sagemaker#CognitoUserGroup", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An identifier for a user group.

", + "smithy.api#required": {} + } + }, + "ClientId": { + "target": "com.amazonaws.sagemaker#ClientId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An identifier for an application client. You must create the app client ID using\n Amazon Cognito.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Identifies a Amazon Cognito user group. A user group can be used in on or more work\n teams.

" + } + }, + "com.amazonaws.sagemaker#CognitoUserGroup": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+$" + } + }, + "com.amazonaws.sagemaker#CognitoUserPool": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 55 + }, + "smithy.api#pattern": "^[\\w-]+_[0-9a-zA-Z]+$" + } + }, + "com.amazonaws.sagemaker#CollectionConfig": { + "type": "union", + "members": { + "VectorConfig": { + "target": "com.amazonaws.sagemaker#VectorConfig", + "traits": { + "smithy.api#documentation": "

Configuration for your vector collection type.

\n
    \n
  • \n

    \n Dimension: The number of elements in your vector.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration for your collection.

" + } + }, + "com.amazonaws.sagemaker#CollectionConfiguration": { + "type": "structure", + "members": { + "CollectionName": { + "target": "com.amazonaws.sagemaker#CollectionName", + "traits": { + "smithy.api#documentation": "

The name of the tensor collection. The name must be unique relative to other rule configuration names.

" + } + }, + "CollectionParameters": { + "target": "com.amazonaws.sagemaker#CollectionParameters", + "traits": { + "smithy.api#documentation": "

Parameter values for the tensor collection. The allowed parameters are\n \"name\", \"include_regex\", \"reduction_config\",\n \"save_config\", \"tensor_names\", and\n \"save_histogram\".

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration information for the Amazon SageMaker Debugger output tensor collections.

" + } + }, + "com.amazonaws.sagemaker#CollectionConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#CollectionConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.sagemaker#CollectionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#CollectionParameters": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#ConfigKey" + }, + "value": { + "target": "com.amazonaws.sagemaker#ConfigValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.sagemaker#CollectionType": { + "type": "enum", + "members": { + "LIST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "List" + } + }, + "SET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Set" + } + }, + "VECTOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Vector" + } + } + } + }, + "com.amazonaws.sagemaker#CompilationJobArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:compilation-job/" + } + }, + "com.amazonaws.sagemaker#CompilationJobStatus": { + "type": "enum", + "members": { + "INPROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INPROGRESS" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "STARTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTING" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPING" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + } + } + }, + "com.amazonaws.sagemaker#CompilationJobSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#CompilationJobSummary" + } + }, + "com.amazonaws.sagemaker#CompilationJobSummary": { + "type": "structure", + "members": { + "CompilationJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the model compilation job that you want a summary for.

", + "smithy.api#required": {} + } + }, + "CompilationJobArn": { + "target": "com.amazonaws.sagemaker#CompilationJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model compilation job.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The time when the model compilation job was created.

", + "smithy.api#required": {} + } + }, + "CompilationStartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the model compilation job started.

" + } + }, + "CompilationEndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the model compilation job completed.

" + } + }, + "CompilationTargetDevice": { + "target": "com.amazonaws.sagemaker#TargetDevice", + "traits": { + "smithy.api#documentation": "

The type of device that the model will run on after the compilation job has\n completed.

" + } + }, + "CompilationTargetPlatformOs": { + "target": "com.amazonaws.sagemaker#TargetPlatformOs", + "traits": { + "smithy.api#documentation": "

The type of OS that the model will run on after the compilation job has\n completed.

" + } + }, + "CompilationTargetPlatformArch": { + "target": "com.amazonaws.sagemaker#TargetPlatformArch", + "traits": { + "smithy.api#documentation": "

The type of architecture that the model will run on after the compilation job has\n completed.

" + } + }, + "CompilationTargetPlatformAccelerator": { + "target": "com.amazonaws.sagemaker#TargetPlatformAccelerator", + "traits": { + "smithy.api#documentation": "

The type of accelerator that the model will run on after the compilation job has\n completed.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "

The time when the model compilation job was last modified.

" + } + }, + "CompilationJobStatus": { + "target": "com.amazonaws.sagemaker#CompilationJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of the model compilation job.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A summary of a model compilation job.

" + } + }, + "com.amazonaws.sagemaker#CompilerOptions": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 1024 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#CompleteOnConvergence": { + "type": "enum", + "members": { + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disabled" + } + }, + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enabled" + } + } + } + }, + "com.amazonaws.sagemaker#CompressionType": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "None" + } + }, + "GZIP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Gzip" + } + } + } + }, + "com.amazonaws.sagemaker#CompressionTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#CompressionType" + } + }, + "com.amazonaws.sagemaker#ComputeQuotaArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:compute-quota/[a-z0-9]{12}$" + } + }, + "com.amazonaws.sagemaker#ComputeQuotaConfig": { + "type": "structure", + "members": { + "ComputeQuotaResources": { + "target": "com.amazonaws.sagemaker#ComputeQuotaResourceConfigList", + "traits": { + "smithy.api#documentation": "

Allocate compute resources by instance types.

" + } + }, + "ResourceSharingConfig": { + "target": "com.amazonaws.sagemaker#ResourceSharingConfig", + "traits": { + "smithy.api#documentation": "

Resource sharing configuration. This defines how an entity can lend and borrow idle\n compute with other entities within the cluster.

" + } + }, + "PreemptTeamTasks": { + "target": "com.amazonaws.sagemaker#PreemptTeamTasks", + "traits": { + "smithy.api#documentation": "

Allows workloads from within an entity to preempt same-team workloads. When set to\n LowerPriority, the entity's lower priority tasks are preempted by their own\n higher priority tasks.

\n

Default is LowerPriority.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration of the compute allocation definition for an entity. This includes the\n resource sharing option and the setting to preempt low priority tasks.

" + } + }, + "com.amazonaws.sagemaker#ComputeQuotaId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-z0-9]{12}$" + } + }, + "com.amazonaws.sagemaker#ComputeQuotaResourceConfig": { + "type": "structure", + "members": { + "InstanceType": { + "target": "com.amazonaws.sagemaker#ClusterInstanceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The instance type of the instance group for the cluster.

", + "smithy.api#required": {} + } + }, + "Count": { + "target": "com.amazonaws.sagemaker#InstanceCount", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of instances to add to the instance group of a SageMaker HyperPod\n cluster.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration of the resources used for the compute allocation definition.

" + } + }, + "com.amazonaws.sagemaker#ComputeQuotaResourceConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ComputeQuotaResourceConfig" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 15 + } + } + }, + "com.amazonaws.sagemaker#ComputeQuotaSummary": { + "type": "structure", + "members": { + "ComputeQuotaArn": { + "target": "com.amazonaws.sagemaker#ComputeQuotaArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

ARN of the compute allocation definition.

", + "smithy.api#required": {} + } + }, + "ComputeQuotaId": { + "target": "com.amazonaws.sagemaker#ComputeQuotaId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

ID of the compute allocation definition.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Name of the compute allocation definition.

", + "smithy.api#required": {} + } + }, + "ComputeQuotaVersion": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "

Version of the compute allocation definition.

" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#SchedulerResourceStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Status of the compute allocation definition.

", + "smithy.api#required": {} + } + }, + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#documentation": "

ARN of the cluster.

" + } + }, + "ComputeQuotaConfig": { + "target": "com.amazonaws.sagemaker#ComputeQuotaConfig", + "traits": { + "smithy.api#documentation": "

Configuration of the compute allocation definition. This includes the resource sharing\n option, and the setting to preempt low priority tasks.

" + } + }, + "ComputeQuotaTarget": { + "target": "com.amazonaws.sagemaker#ComputeQuotaTarget", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The target entity to allocate compute resources to.

", + "smithy.api#required": {} + } + }, + "ActivationState": { + "target": "com.amazonaws.sagemaker#ActivationState", + "traits": { + "smithy.api#documentation": "

The state of the compute allocation being described. Use to enable or disable compute\n allocation.

\n

Default is Enabled.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Creation time of the compute allocation definition.

", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Last modified time of the compute allocation definition.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Summary of the compute allocation definition.

" + } + }, + "com.amazonaws.sagemaker#ComputeQuotaSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ComputeQuotaSummary" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#ComputeQuotaTarget": { + "type": "structure", + "members": { + "TeamName": { + "target": "com.amazonaws.sagemaker#ComputeQuotaTargetTeamName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Name of the team to allocate compute resources to.

", + "smithy.api#required": {} + } + }, + "FairShareWeight": { + "target": "com.amazonaws.sagemaker#FairShareWeight", + "traits": { + "smithy.api#documentation": "

Assigned entity fair-share weight. Idle compute will be shared across entities based on\n these assigned weights. This weight is only used when FairShare is\n enabled.

\n

A weight of 0 is the lowest priority and 100 is the highest. Weight 0 is the\n default.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The target entity to allocate compute resources to.

" + } + }, + "com.amazonaws.sagemaker#ComputeQuotaTargetTeamName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9]){0,39}?$" + } + }, + "com.amazonaws.sagemaker#ConditionOutcome": { + "type": "enum", + "members": { + "TRUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "True" + } + }, + "FALSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "False" + } + } + } + }, + "com.amazonaws.sagemaker#ConditionStepMetadata": { + "type": "structure", + "members": { + "Outcome": { + "target": "com.amazonaws.sagemaker#ConditionOutcome", + "traits": { + "smithy.api#documentation": "

The outcome of the Condition step evaluation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Metadata for a Condition step.

" + } + }, + "com.amazonaws.sagemaker#ConfigKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#ConfigValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#ConflictException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.sagemaker#FailureReason" + } + }, + "traits": { + "smithy.api#documentation": "

There was a conflict when you attempted to modify a SageMaker entity such as an\n Experiment or Artifact.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.sagemaker#ContainerArgument": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#ContainerArguments": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ContainerArgument" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#ContainerConfig": { + "type": "structure", + "members": { + "ContainerArguments": { + "target": "com.amazonaws.sagemaker#CustomImageContainerArguments", + "traits": { + "smithy.api#documentation": "

The arguments for the container when you're running the application.

" + } + }, + "ContainerEntrypoint": { + "target": "com.amazonaws.sagemaker#CustomImageContainerEntrypoint", + "traits": { + "smithy.api#documentation": "

The entrypoint used to run the application in the container.

" + } + }, + "ContainerEnvironmentVariables": { + "target": "com.amazonaws.sagemaker#CustomImageContainerEnvironmentVariables", + "traits": { + "smithy.api#documentation": "

The environment variables to set in the container

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration used to run the application image container.

" + } + }, + "com.amazonaws.sagemaker#ContainerDefinition": { + "type": "structure", + "members": { + "ContainerHostname": { + "target": "com.amazonaws.sagemaker#ContainerHostname", + "traits": { + "smithy.api#documentation": "

This parameter is ignored for models that contain only a\n PrimaryContainer.

\n

When a ContainerDefinition is part of an inference pipeline, the value of\n the parameter uniquely identifies the container for the purposes of logging and metrics.\n For information, see Use Logs and Metrics\n to Monitor an Inference Pipeline. If you don't specify a value for this\n parameter for a ContainerDefinition that is part of an inference pipeline,\n a unique name is automatically assigned based on the position of the\n ContainerDefinition in the pipeline. If you specify a value for the\n ContainerHostName for any ContainerDefinition that is part\n of an inference pipeline, you must specify a value for the\n ContainerHostName parameter of every ContainerDefinition\n in that pipeline.

" + } + }, + "Image": { + "target": "com.amazonaws.sagemaker#ContainerImage", + "traits": { + "smithy.api#documentation": "

The path where inference code is stored. This can be either in Amazon EC2 Container Registry or in a\n Docker registry that is accessible from the same VPC that you configure for your\n endpoint. If you are using your own custom algorithm instead of an algorithm provided by\n SageMaker, the inference code must meet SageMaker requirements. SageMaker supports both\n registry/repository[:tag] and registry/repository[@digest]\n image path formats. For more information, see Using Your Own Algorithms with\n Amazon SageMaker.

\n \n

The model artifacts in an Amazon S3 bucket and the Docker image for inference container\n in Amazon EC2 Container Registry must be in the same region as the model or endpoint you are\n creating.

\n " + } + }, + "ImageConfig": { + "target": "com.amazonaws.sagemaker#ImageConfig", + "traits": { + "smithy.api#documentation": "

Specifies whether the model container is in Amazon ECR or a private Docker registry\n accessible from your Amazon Virtual Private Cloud (VPC). For information about storing containers in a\n private Docker registry, see Use a\n Private Docker Registry for Real-Time Inference Containers.

\n \n

The model artifacts in an Amazon S3 bucket and the Docker image for inference container\n in Amazon EC2 Container Registry must be in the same region as the model or endpoint you are\n creating.

\n " + } + }, + "Mode": { + "target": "com.amazonaws.sagemaker#ContainerMode", + "traits": { + "smithy.api#documentation": "

Whether the container hosts a single model or multiple models.

" + } + }, + "ModelDataUrl": { + "target": "com.amazonaws.sagemaker#Url", + "traits": { + "smithy.api#documentation": "

The S3 path where the model artifacts, which result from model training, are stored.\n This path must point to a single gzip compressed tar archive (.tar.gz suffix). The S3\n path is required for SageMaker built-in algorithms, but not if you use your own algorithms.\n For more information on built-in algorithms, see Common\n Parameters.

\n \n

The model artifacts must be in an S3 bucket that is in the same region as the\n model or endpoint you are creating.

\n \n

If you provide a value for this parameter, SageMaker uses Amazon Web Services Security Token\n Service to download model artifacts from the S3 path you provide. Amazon Web Services STS\n is activated in your Amazon Web Services account by default. If you previously\n deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and\n Deactivating Amazon Web Services STS in an Amazon Web Services Region in the\n Amazon Web Services Identity and Access Management User\n Guide.

\n \n

If you use a built-in algorithm to create a model, SageMaker requires that you provide\n a S3 path to the model artifacts in ModelDataUrl.

\n " + } + }, + "ModelDataSource": { + "target": "com.amazonaws.sagemaker#ModelDataSource", + "traits": { + "smithy.api#documentation": "

Specifies the location of ML model data to deploy.

\n \n

Currently you cannot use ModelDataSource in conjunction with SageMaker\n batch transform, SageMaker serverless endpoints, SageMaker multi-model endpoints, and SageMaker\n Marketplace.

\n " + } + }, + "AdditionalModelDataSources": { + "target": "com.amazonaws.sagemaker#AdditionalModelDataSources", + "traits": { + "smithy.api#documentation": "

Data sources that are available to your model in addition to the one that you specify for ModelDataSource when you use the CreateModel action.

" + } + }, + "Environment": { + "target": "com.amazonaws.sagemaker#EnvironmentMap", + "traits": { + "smithy.api#documentation": "

The environment variables to set in the Docker container. Don't include any\n sensitive data in your environment variables.

\n

The maximum length of each key and value in the Environment map is\n 1024 bytes. The maximum length of all keys and values in the map, combined, is 32 KB. If\n you pass multiple containers to a CreateModel request, then the maximum\n length of all of their maps, combined, is also 32 KB.

" + } + }, + "ModelPackageName": { + "target": "com.amazonaws.sagemaker#VersionedArnOrName", + "traits": { + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the model package to use to create the\n model.

" + } + }, + "InferenceSpecificationName": { + "target": "com.amazonaws.sagemaker#InferenceSpecificationName", + "traits": { + "smithy.api#documentation": "

The inference specification name in the model package version.

" + } + }, + "MultiModelConfig": { + "target": "com.amazonaws.sagemaker#MultiModelConfig", + "traits": { + "smithy.api#documentation": "

Specifies additional configuration for multi-model endpoints.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the container, as part of model definition.

" + } + }, + "com.amazonaws.sagemaker#ContainerDefinitionList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ContainerDefinition" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 15 + } + } + }, + "com.amazonaws.sagemaker#ContainerEntrypoint": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ContainerEntrypointString" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#ContainerEntrypointString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#ContainerHostname": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#ContainerImage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.sagemaker#ContainerMode": { + "type": "enum", + "members": { + "SINGLE_MODEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SingleModel" + } + }, + "MULTI_MODEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MultiModel" + } + } + } + }, + "com.amazonaws.sagemaker#ContentClassifier": { + "type": "enum", + "members": { + "FREE_OF_PERSONALLY_IDENTIFIABLE_INFORMATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FreeOfPersonallyIdentifiableInformation" + } + }, + "FREE_OF_ADULT_CONTENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FreeOfAdultContent" + } + } + } + }, + "com.amazonaws.sagemaker#ContentClassifiers": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ContentClassifier" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.sagemaker#ContentColumn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.sagemaker#ContentDigest": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 72 + }, + "smithy.api#pattern": "^[Ss][Hh][Aa]256:[0-9a-fA-F]{64}$" + } + }, + "com.amazonaws.sagemaker#ContentType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#ContentTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ContentType" + } + }, + "com.amazonaws.sagemaker#ContextArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:context/" + } + }, + "com.amazonaws.sagemaker#ContextName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 120 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,119}$" + } + }, + "com.amazonaws.sagemaker#ContextNameOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:context\\/)?([a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,119})$" + } + }, + "com.amazonaws.sagemaker#ContextSource": { + "type": "structure", + "members": { + "SourceUri": { + "target": "com.amazonaws.sagemaker#SourceUri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The URI of the source.

", + "smithy.api#required": {} + } + }, + "SourceType": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "

The type of the source.

" + } + }, + "SourceId": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "

The ID of the source.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure describing the source of a context.

" + } + }, + "com.amazonaws.sagemaker#ContextSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ContextSummary" + } + }, + "com.amazonaws.sagemaker#ContextSummary": { + "type": "structure", + "members": { + "ContextArn": { + "target": "com.amazonaws.sagemaker#ContextArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the context.

" + } + }, + "ContextName": { + "target": "com.amazonaws.sagemaker#ContextName", + "traits": { + "smithy.api#documentation": "

The name of the context.

" + } + }, + "Source": { + "target": "com.amazonaws.sagemaker#ContextSource", + "traits": { + "smithy.api#documentation": "

The source of the context.

" + } + }, + "ContextType": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "

The type of the context.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the context was created.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the context was last modified.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Lists a summary of the properties of a context. A context provides a logical grouping\n of other entities.

" + } + }, + "com.amazonaws.sagemaker#ContinuousParameterRange": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#ParameterKey", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the continuous hyperparameter to tune.

", + "smithy.api#required": {} + } + }, + "MinValue": { + "target": "com.amazonaws.sagemaker#ParameterValue", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The minimum value for the hyperparameter.\n The\n tuning job uses floating-point values between this value and MaxValuefor\n tuning.

", + "smithy.api#required": {} + } + }, + "MaxValue": { + "target": "com.amazonaws.sagemaker#ParameterValue", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The maximum value for the hyperparameter. The tuning job uses floating-point values\n between MinValue value and this value for tuning.

", + "smithy.api#required": {} + } + }, + "ScalingType": { + "target": "com.amazonaws.sagemaker#HyperParameterScalingType", + "traits": { + "smithy.api#documentation": "

The scale that hyperparameter tuning uses to search the hyperparameter range. For\n information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

\n
\n
Auto
\n
\n

SageMaker hyperparameter tuning chooses the best scale for the\n hyperparameter.

\n
\n
Linear
\n
\n

Hyperparameter tuning searches the values in the hyperparameter range by\n using a linear scale.

\n
\n
Logarithmic
\n
\n

Hyperparameter tuning searches the values in the hyperparameter range by\n using a logarithmic scale.

\n

Logarithmic scaling works only for ranges that have only values greater\n than 0.

\n
\n
ReverseLogarithmic
\n
\n

Hyperparameter tuning searches the values in the hyperparameter range by\n using a reverse logarithmic scale.

\n

Reverse logarithmic scaling works only for ranges that are entirely within\n the range 0<=x<1.0.

\n
\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of continuous hyperparameters to tune.

" + } + }, + "com.amazonaws.sagemaker#ContinuousParameterRangeSpecification": { + "type": "structure", + "members": { + "MinValue": { + "target": "com.amazonaws.sagemaker#ParameterValue", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The minimum floating-point value allowed.

", + "smithy.api#required": {} + } + }, + "MaxValue": { + "target": "com.amazonaws.sagemaker#ParameterValue", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The maximum floating-point value allowed.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines the possible values for a continuous hyperparameter.

" + } + }, + "com.amazonaws.sagemaker#ContinuousParameterRanges": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ContinuousParameterRange" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 30 + } + } + }, + "com.amazonaws.sagemaker#ConvergenceDetected": { + "type": "structure", + "members": { + "CompleteOnConvergence": { + "target": "com.amazonaws.sagemaker#CompleteOnConvergence", + "traits": { + "smithy.api#documentation": "

A flag to stop a tuning job once AMT has detected that the job has converged.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A flag to indicating that automatic model tuning (AMT) has detected model convergence,\n defined as a lack of significant improvement (1% or less) against an objective\n metric.

" + } + }, + "com.amazonaws.sagemaker#CountryCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 2 + }, + "smithy.api#pattern": "^[A-Z]{2}$" + } + }, + "com.amazonaws.sagemaker#CreateAction": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateActionRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateActionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an action. An action is a lineage tracking entity that\n represents an action or activity. For example, a model deployment or an HPO job.\n Generally, an action involves at least one input or output artifact. For more information, see\n Amazon SageMaker\n ML Lineage Tracking.

" + } + }, + "com.amazonaws.sagemaker#CreateActionRequest": { + "type": "structure", + "members": { + "ActionName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the action. Must be unique to your account in an Amazon Web Services Region.

", + "smithy.api#required": {} + } + }, + "Source": { + "target": "com.amazonaws.sagemaker#ActionSource", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The source type, ID, and URI.

", + "smithy.api#required": {} + } + }, + "ActionType": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The action type.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#ExperimentDescription", + "traits": { + "smithy.api#documentation": "

The description of the action.

" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#ActionStatus", + "traits": { + "smithy.api#documentation": "

The status of the action.

" + } + }, + "Properties": { + "target": "com.amazonaws.sagemaker#LineageEntityParameters", + "traits": { + "smithy.api#documentation": "

A list of properties to add to the action.

" + } + }, + "MetadataProperties": { + "target": "com.amazonaws.sagemaker#MetadataProperties" + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags to apply to the action.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateActionResponse": { + "type": "structure", + "members": { + "ActionArn": { + "target": "com.amazonaws.sagemaker#ActionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the action.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateAlgorithm": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateAlgorithmInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateAlgorithmOutput" + }, + "traits": { + "smithy.api#documentation": "

Create a machine learning algorithm that you can use in SageMaker and list in the Amazon Web Services Marketplace.

" + } + }, + "com.amazonaws.sagemaker#CreateAlgorithmInput": { + "type": "structure", + "members": { + "AlgorithmName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the algorithm.

", + "smithy.api#required": {} + } + }, + "AlgorithmDescription": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "

A description of the algorithm.

" + } + }, + "TrainingSpecification": { + "target": "com.amazonaws.sagemaker#TrainingSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies details about training jobs run by this algorithm, including the\n following:

\n
    \n
  • \n

    The Amazon ECR path of the container and the version digest of the\n algorithm.

    \n
    • \n
  • \n

    The hyperparameters that the algorithm supports.

    \n
    • \n
  • \n

    The instance types that the algorithm supports for training.

    \n
    • \n
  • \n

    Whether the algorithm supports distributed training.

    \n
    • \n
  • \n

    The metrics that the algorithm emits to Amazon CloudWatch.

    \n
    • \n
  • \n

    Which metrics that the algorithm emits can be used as the objective metric for\n hyperparameter tuning jobs.

    \n
    • \n
  • \n

    The input channels that the algorithm supports for training data. For example,\n an algorithm might support train, validation, and\n test channels.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "InferenceSpecification": { + "target": "com.amazonaws.sagemaker#InferenceSpecification", + "traits": { + "smithy.api#documentation": "

Specifies details about inference jobs that the algorithm runs, including the\n following:

\n
    \n
  • \n

    The Amazon ECR paths of containers that contain the inference code and model\n artifacts.

    \n
    • \n
  • \n

    The instance types that the algorithm supports for transform jobs and\n real-time endpoints used for inference.

    \n
    • \n
  • \n

    The input and output content formats that the algorithm supports for\n inference.

    \n
    • \n
" + } + }, + "ValidationSpecification": { + "target": "com.amazonaws.sagemaker#AlgorithmValidationSpecification", + "traits": { + "smithy.api#documentation": "

Specifies configurations for one or more training jobs and that SageMaker runs to test the\n algorithm's training code and, optionally, one or more batch transform jobs that SageMaker\n runs to test the algorithm's inference code.

" + } + }, + "CertifyForMarketplace": { + "target": "com.amazonaws.sagemaker#CertifyForMarketplace", + "traits": { + "smithy.api#documentation": "

Whether to certify the algorithm so that it can be listed in Amazon Web Services\n Marketplace.

" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateAlgorithmOutput": { + "type": "structure", + "members": { + "AlgorithmArn": { + "target": "com.amazonaws.sagemaker#AlgorithmArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the new algorithm.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateApp": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateAppRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateAppResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a running app for the specified UserProfile. This operation is automatically\n invoked by Amazon SageMaker AI upon access to the associated Domain, and when new kernel\n configurations are selected by the user. A user may have multiple Apps active\n simultaneously.

" + } + }, + "com.amazonaws.sagemaker#CreateAppImageConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateAppImageConfigRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateAppImageConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a configuration for running a SageMaker AI image as a KernelGateway app. The\n configuration specifies the Amazon Elastic File System storage volume on the image, and a list of the\n kernels in the image.

" + } + }, + "com.amazonaws.sagemaker#CreateAppImageConfigRequest": { + "type": "structure", + "members": { + "AppImageConfigName": { + "target": "com.amazonaws.sagemaker#AppImageConfigName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the AppImageConfig. Must be unique to your account.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags to apply to the AppImageConfig.

" + } + }, + "KernelGatewayImageConfig": { + "target": "com.amazonaws.sagemaker#KernelGatewayImageConfig", + "traits": { + "smithy.api#documentation": "

The KernelGatewayImageConfig. You can only specify one image kernel in the \n AppImageConfig API. This kernel will be shown to users before the \n image starts. Once the image runs, all kernels are visible in JupyterLab.

" + } + }, + "JupyterLabAppImageConfig": { + "target": "com.amazonaws.sagemaker#JupyterLabAppImageConfig", + "traits": { + "smithy.api#documentation": "

The JupyterLabAppImageConfig. You can only specify one image kernel in the AppImageConfig API. This kernel is shown to users before the image starts. After the image runs, all kernels are visible in JupyterLab.

" + } + }, + "CodeEditorAppImageConfig": { + "target": "com.amazonaws.sagemaker#CodeEditorAppImageConfig", + "traits": { + "smithy.api#documentation": "

The CodeEditorAppImageConfig. You can only specify one image kernel \n in the AppImageConfig API. This kernel is shown to users before the image starts. \n After the image runs, all kernels are visible in Code Editor.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateAppImageConfigResponse": { + "type": "structure", + "members": { + "AppImageConfigArn": { + "target": "com.amazonaws.sagemaker#AppImageConfigArn", + "traits": { + "smithy.api#documentation": "

The ARN of the AppImageConfig.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateAppRequest": { + "type": "structure", + "members": { + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The domain ID.

", + "smithy.api#required": {} + } + }, + "UserProfileName": { + "target": "com.amazonaws.sagemaker#UserProfileName", + "traits": { + "smithy.api#documentation": "

The user profile name. If this value is not set, then SpaceName must be\n set.

" + } + }, + "SpaceName": { + "target": "com.amazonaws.sagemaker#SpaceName", + "traits": { + "smithy.api#documentation": "

The name of the space. If this value is not set, then UserProfileName must be\n set.

" + } + }, + "AppType": { + "target": "com.amazonaws.sagemaker#AppType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of app.

", + "smithy.api#required": {} + } + }, + "AppName": { + "target": "com.amazonaws.sagemaker#AppName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the app.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

Each tag consists of a key and an optional value. Tag keys must be unique per\n resource.

" + } + }, + "ResourceSpec": { + "target": "com.amazonaws.sagemaker#ResourceSpec", + "traits": { + "smithy.api#documentation": "

The instance type and the Amazon Resource Name (ARN) of the SageMaker AI image\n created on the instance.

\n \n

The value of InstanceType passed as part of the ResourceSpec\n in the CreateApp call overrides the value passed as part of the\n ResourceSpec configured for the user profile or the domain. If\n InstanceType is not specified in any of those three ResourceSpec\n values for a KernelGateway app, the CreateApp call fails with a\n request validation error.

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateAppResponse": { + "type": "structure", + "members": { + "AppArn": { + "target": "com.amazonaws.sagemaker#AppArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the app.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateArtifact": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateArtifactRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateArtifactResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an artifact. An artifact is a lineage tracking entity that\n represents a URI addressable object or data. Some examples are the S3 URI of a dataset and\n the ECR registry path of an image. For more information, see\n Amazon SageMaker\n ML Lineage Tracking.

" + } + }, + "com.amazonaws.sagemaker#CreateArtifactRequest": { + "type": "structure", + "members": { + "ArtifactName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

The name of the artifact. Must be unique to your account in an Amazon Web Services Region.

" + } + }, + "Source": { + "target": "com.amazonaws.sagemaker#ArtifactSource", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID, ID type, and URI of the source.

", + "smithy.api#required": {} + } + }, + "ArtifactType": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The artifact type.

", + "smithy.api#required": {} + } + }, + "Properties": { + "target": "com.amazonaws.sagemaker#ArtifactProperties", + "traits": { + "smithy.api#documentation": "

A list of properties to add to the artifact.

" + } + }, + "MetadataProperties": { + "target": "com.amazonaws.sagemaker#MetadataProperties" + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags to apply to the artifact.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateArtifactResponse": { + "type": "structure", + "members": { + "ArtifactArn": { + "target": "com.amazonaws.sagemaker#ArtifactArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the artifact.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateAutoMLJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateAutoMLJobRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateAutoMLJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an Autopilot job also referred to as Autopilot experiment or AutoML job.

\n

An AutoML job in SageMaker AI is a fully automated process that allows you to build machine\n learning models with minimal effort and machine learning expertise. When initiating an\n AutoML job, you provide your data and optionally specify parameters tailored to your use\n case. SageMaker AI then automates the entire model development lifecycle, including data\n preprocessing, model training, tuning, and evaluation. AutoML jobs are designed to simplify\n and accelerate the model building process by automating various tasks and exploring\n different combinations of machine learning algorithms, data preprocessing techniques, and\n hyperparameter values. The output of an AutoML job comprises one or more trained models\n ready for deployment and inference. Additionally, SageMaker AI AutoML jobs generate a candidate\n model leaderboard, allowing you to select the best-performing model for deployment.

\n

For more information about AutoML jobs, see https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-automate-model-development.html\n in the SageMaker AI developer guide.

\n \n

We recommend using the new versions CreateAutoMLJobV2 and DescribeAutoMLJobV2, which offer backward compatibility.

\n

\n CreateAutoMLJobV2 can manage tabular problem types identical to those of\n its previous version CreateAutoMLJob, as well as time-series forecasting,\n non-tabular problem types such as image or text classification, and text generation\n (LLMs fine-tuning).

\n

Find guidelines about how to migrate a CreateAutoMLJob to\n CreateAutoMLJobV2 in Migrate a CreateAutoMLJob to CreateAutoMLJobV2.

\n \n

You can find the best-performing model after you run an AutoML job by calling DescribeAutoMLJobV2 (recommended) or DescribeAutoMLJob.

" + } + }, + "com.amazonaws.sagemaker#CreateAutoMLJobRequest": { + "type": "structure", + "members": { + "AutoMLJobName": { + "target": "com.amazonaws.sagemaker#AutoMLJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Identifies an Autopilot job. The name must be unique to your account and is case\n insensitive.

", + "smithy.api#required": {} + } + }, + "InputDataConfig": { + "target": "com.amazonaws.sagemaker#AutoMLInputDataConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An array of channel objects that describes the input data and its location. Each channel\n is a named input source. Similar to InputDataConfig supported by HyperParameterTrainingJobDefinition. Format(s) supported: CSV, Parquet. A\n minimum of 500 rows is required for the training dataset. There is not a minimum number of\n rows required for the validation dataset.

", + "smithy.api#required": {} + } + }, + "OutputDataConfig": { + "target": "com.amazonaws.sagemaker#AutoMLOutputDataConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Provides information about encryption and the Amazon S3 output path needed to\n store artifacts from an AutoML job. Format(s) supported: CSV.

", + "smithy.api#required": {} + } + }, + "ProblemType": { + "target": "com.amazonaws.sagemaker#ProblemType", + "traits": { + "smithy.api#documentation": "

Defines the type of supervised learning problem available for the candidates. For more\n information, see \n SageMaker Autopilot problem types.

" + } + }, + "AutoMLJobObjective": { + "target": "com.amazonaws.sagemaker#AutoMLJobObjective", + "traits": { + "smithy.api#documentation": "

Specifies a metric to minimize or maximize as the objective of a job. If not specified,\n the default objective metric depends on the problem type. See AutoMLJobObjective for the default values.

" + } + }, + "AutoMLJobConfig": { + "target": "com.amazonaws.sagemaker#AutoMLJobConfig", + "traits": { + "smithy.api#documentation": "

A collection of settings used to configure an AutoML job.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the role that is used to access the data.

", + "smithy.api#required": {} + } + }, + "GenerateCandidateDefinitionsOnly": { + "target": "com.amazonaws.sagemaker#GenerateCandidateDefinitionsOnly", + "traits": { + "smithy.api#documentation": "

Generates possible candidates without training the models. A candidate is a combination\n of data preprocessors, algorithms, and algorithm parameter settings.

" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web ServicesResources. Tag keys must be unique per\n resource.

" + } + }, + "ModelDeployConfig": { + "target": "com.amazonaws.sagemaker#ModelDeployConfig", + "traits": { + "smithy.api#documentation": "

Specifies how to generate the endpoint name for an automatic one-click Autopilot model\n deployment.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateAutoMLJobResponse": { + "type": "structure", + "members": { + "AutoMLJobArn": { + "target": "com.amazonaws.sagemaker#AutoMLJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The unique ARN assigned to the AutoML job when it is created.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateAutoMLJobV2": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateAutoMLJobV2Request" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateAutoMLJobV2Response" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an Autopilot job also referred to as Autopilot experiment or AutoML job V2.

\n

An AutoML job in SageMaker AI is a fully automated process that allows you to build machine\n learning models with minimal effort and machine learning expertise. When initiating an\n AutoML job, you provide your data and optionally specify parameters tailored to your use\n case. SageMaker AI then automates the entire model development lifecycle, including data\n preprocessing, model training, tuning, and evaluation. AutoML jobs are designed to simplify\n and accelerate the model building process by automating various tasks and exploring\n different combinations of machine learning algorithms, data preprocessing techniques, and\n hyperparameter values. The output of an AutoML job comprises one or more trained models\n ready for deployment and inference. Additionally, SageMaker AI AutoML jobs generate a candidate\n model leaderboard, allowing you to select the best-performing model for deployment.

\n

For more information about AutoML jobs, see https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-automate-model-development.html\n in the SageMaker AI developer guide.

\n

AutoML jobs V2 support various problem types such as regression, binary, and multiclass\n classification with tabular data, text and image classification, time-series forecasting,\n and fine-tuning of large language models (LLMs) for text generation.

\n \n

\n CreateAutoMLJobV2 and DescribeAutoMLJobV2 are new versions of CreateAutoMLJob\n and DescribeAutoMLJob which offer backward compatibility.

\n

\n CreateAutoMLJobV2 can manage tabular problem types identical to those of\n its previous version CreateAutoMLJob, as well as time-series forecasting,\n non-tabular problem types such as image or text classification, and text generation\n (LLMs fine-tuning).

\n

Find guidelines about how to migrate a CreateAutoMLJob to\n CreateAutoMLJobV2 in Migrate a CreateAutoMLJob to CreateAutoMLJobV2.

\n \n

For the list of available problem types supported by CreateAutoMLJobV2, see\n AutoMLProblemTypeConfig.

\n

You can find the best-performing model after you run an AutoML job V2 by calling DescribeAutoMLJobV2.

" + } + }, + "com.amazonaws.sagemaker#CreateAutoMLJobV2Request": { + "type": "structure", + "members": { + "AutoMLJobName": { + "target": "com.amazonaws.sagemaker#AutoMLJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Identifies an Autopilot job. The name must be unique to your account and is case\n insensitive.

", + "smithy.api#required": {} + } + }, + "AutoMLJobInputDataConfig": { + "target": "com.amazonaws.sagemaker#AutoMLJobInputDataConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An array of channel objects describing the input data and their location. Each channel\n is a named input source. Similar to the InputDataConfig attribute in the CreateAutoMLJob input parameters.\n The supported formats depend on the problem type:

\n
    \n
  • \n

    For tabular problem types: S3Prefix,\n ManifestFile.

    \n
    • \n
  • \n

    For image classification: S3Prefix, ManifestFile,\n AugmentedManifestFile.

    \n
    • \n
  • \n

    For text classification: S3Prefix.

    \n
    • \n
  • \n

    For time-series forecasting: S3Prefix.

    \n
    • \n
  • \n

    For text generation (LLMs fine-tuning): S3Prefix.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "OutputDataConfig": { + "target": "com.amazonaws.sagemaker#AutoMLOutputDataConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Provides information about encryption and the Amazon S3 output path needed to\n store artifacts from an AutoML job.

", + "smithy.api#required": {} + } + }, + "AutoMLProblemTypeConfig": { + "target": "com.amazonaws.sagemaker#AutoMLProblemTypeConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Defines the configuration settings of one of the supported problem types.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the role that is used to access the data.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, such as by purpose, owner, or environment. For more\n information, see Tagging Amazon Web ServicesResources. Tag keys must be unique per\n resource.

" + } + }, + "SecurityConfig": { + "target": "com.amazonaws.sagemaker#AutoMLSecurityConfig", + "traits": { + "smithy.api#documentation": "

The security configuration for traffic encryption or Amazon VPC settings.

" + } + }, + "AutoMLJobObjective": { + "target": "com.amazonaws.sagemaker#AutoMLJobObjective", + "traits": { + "smithy.api#documentation": "

Specifies a metric to minimize or maximize as the objective of a job. If not specified,\n the default objective metric depends on the problem type. For the list of default values\n per problem type, see AutoMLJobObjective.

\n \n
    \n
  • \n

    For tabular problem types: You must either provide both the\n AutoMLJobObjective and indicate the type of supervised learning\n problem in AutoMLProblemTypeConfig\n (TabularJobConfig.ProblemType), or none at all.

    \n
    • \n
  • \n

    For text generation problem types (LLMs fine-tuning): \n Fine-tuning language models in Autopilot does not\n require setting the AutoMLJobObjective field. Autopilot fine-tunes LLMs\n without requiring multiple candidates to be trained and evaluated. \n Instead, using your dataset, Autopilot directly fine-tunes your target model to enhance a\n default objective metric, the cross-entropy loss. After fine-tuning a language model,\n you can evaluate the quality of its generated text using different metrics. \n For a list of the available metrics, see Metrics for\n fine-tuning LLMs in Autopilot.

    \n
    • \n
\n " + } + }, + "ModelDeployConfig": { + "target": "com.amazonaws.sagemaker#ModelDeployConfig", + "traits": { + "smithy.api#documentation": "

Specifies how to generate the endpoint name for an automatic one-click Autopilot model\n deployment.

" + } + }, + "DataSplitConfig": { + "target": "com.amazonaws.sagemaker#AutoMLDataSplitConfig", + "traits": { + "smithy.api#documentation": "

This structure specifies how to split the data into train and validation\n datasets.

\n

The validation and training datasets must contain the same headers. For jobs created by\n calling CreateAutoMLJob, the validation dataset must be less than 2 GB in\n size.

\n \n

This attribute must not be set for the time-series forecasting problem type, as Autopilot\n automatically splits the input dataset into training and validation sets.

\n " + } + }, + "AutoMLComputeConfig": { + "target": "com.amazonaws.sagemaker#AutoMLComputeConfig", + "traits": { + "smithy.api#documentation": "

Specifies the compute configuration for the AutoML job V2.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateAutoMLJobV2Response": { + "type": "structure", + "members": { + "AutoMLJobArn": { + "target": "com.amazonaws.sagemaker#AutoMLJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The unique ARN assigned to the AutoMLJob when it is created.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateClusterRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateClusterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a SageMaker HyperPod cluster. SageMaker HyperPod is a capability of SageMaker for creating and managing\n persistent clusters for developing large machine learning models, such as large language\n models (LLMs) and diffusion models. To learn more, see Amazon SageMaker HyperPod in the\n Amazon SageMaker Developer Guide.

" + } + }, + "com.amazonaws.sagemaker#CreateClusterRequest": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.sagemaker#ClusterName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name for the new SageMaker HyperPod cluster.

", + "smithy.api#required": {} + } + }, + "InstanceGroups": { + "target": "com.amazonaws.sagemaker#ClusterInstanceGroupSpecifications", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The instance groups to be created in the SageMaker HyperPod cluster.

", + "smithy.api#required": {} + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig" + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

Custom tags for managing the SageMaker HyperPod cluster as an Amazon Web Services resource. You can\n add tags to your cluster in the same way you add them in other Amazon Web Services services\n that support tagging. To learn more about tagging Amazon Web Services resources in general,\n see Tagging\n Amazon Web Services Resources User Guide.

" + } + }, + "Orchestrator": { + "target": "com.amazonaws.sagemaker#ClusterOrchestrator", + "traits": { + "smithy.api#documentation": "

The type of orchestrator to use for the SageMaker HyperPod cluster. Currently, the only supported\n value is \"eks\", which is to use an Amazon Elastic Kubernetes Service (EKS)\n cluster as the orchestrator.

" + } + }, + "NodeRecovery": { + "target": "com.amazonaws.sagemaker#ClusterNodeRecovery", + "traits": { + "smithy.api#documentation": "

The node recovery mode for the SageMaker HyperPod cluster. When set to Automatic,\n SageMaker HyperPod will automatically reboot or replace faulty nodes when issues are detected. When set\n to None, cluster administrators will need to manually manage any faulty\n cluster instances.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateClusterResponse": { + "type": "structure", + "members": { + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateClusterSchedulerConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateClusterSchedulerConfigRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateClusterSchedulerConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Create cluster policy configuration. This policy is used for task prioritization and\n fair-share allocation of idle compute. This helps prioritize critical workloads and distributes\n idle compute across entities.

" + } + }, + "com.amazonaws.sagemaker#CreateClusterSchedulerConfigRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Name for the cluster policy.

", + "smithy.api#required": {} + } + }, + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

ARN of the cluster.

", + "smithy.api#required": {} + } + }, + "SchedulerConfig": { + "target": "com.amazonaws.sagemaker#SchedulerConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Configuration about the monitoring schedule.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "

Description of the cluster policy.

" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

Tags of the cluster policy.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateClusterSchedulerConfigResponse": { + "type": "structure", + "members": { + "ClusterSchedulerConfigArn": { + "target": "com.amazonaws.sagemaker#ClusterSchedulerConfigArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

ARN of the cluster policy.

", + "smithy.api#required": {} + } + }, + "ClusterSchedulerConfigId": { + "target": "com.amazonaws.sagemaker#ClusterSchedulerConfigId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

ID of the cluster policy.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateCodeRepository": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateCodeRepositoryInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateCodeRepositoryOutput" + }, + "traits": { + "smithy.api#documentation": "

Creates a Git repository as a resource in your SageMaker AI account. You can\n associate the repository with notebook instances so that you can use Git source control\n for the notebooks you create. The Git repository is a resource in your SageMaker AI\n account, so it can be associated with more than one notebook instance, and it persists\n independently from the lifecycle of any notebook instances it is associated with.

\n

The repository can be hosted either in Amazon Web Services CodeCommit\n or in any other Git repository.

" + } + }, + "com.amazonaws.sagemaker#CreateCodeRepositoryInput": { + "type": "structure", + "members": { + "CodeRepositoryName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Git repository. The name must have 1 to 63 characters. Valid\n characters are a-z, A-Z, 0-9, and - (hyphen).

", + "smithy.api#required": {} + } + }, + "GitConfig": { + "target": "com.amazonaws.sagemaker#GitConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies details about the repository, including the URL where the repository is\n located, the default branch, and credentials to use to access the repository.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateCodeRepositoryOutput": { + "type": "structure", + "members": { + "CodeRepositoryArn": { + "target": "com.amazonaws.sagemaker#CodeRepositoryArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the new repository.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateCompilationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateCompilationJobRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateCompilationJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Starts a model compilation job. After the model has been compiled, Amazon SageMaker AI saves the\n resulting model artifacts to an Amazon Simple Storage Service (Amazon S3) bucket that you specify.

\n

If\n you choose to host your model using Amazon SageMaker AI hosting services, you can use the resulting\n model artifacts as part of the model. You can also use the artifacts with\n Amazon Web Services IoT Greengrass. In that case, deploy them as an ML\n resource.

\n

In the request body, you provide the following:

\n
    \n
  • \n

    A name for the compilation job

    \n
    • \n
  • \n

    Information about the input model artifacts

    \n
    • \n
  • \n

    The output location for the compiled model and the device (target) that the\n model runs on

    \n
    • \n
  • \n

    The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker AI assumes to perform\n the model compilation job.

    \n
    • \n
\n

You can also provide a Tag to track the model compilation job's resource\n use and costs. The response body contains the\n CompilationJobArn\n for the compiled job.

\n

To stop a model compilation job, use StopCompilationJob. To get information about a particular model compilation\n job, use DescribeCompilationJob. To get information about multiple model compilation\n jobs, use ListCompilationJobs.

" + } + }, + "com.amazonaws.sagemaker#CreateCompilationJobRequest": { + "type": "structure", + "members": { + "CompilationJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A name for the model compilation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker AI to perform tasks on\n your behalf.

\n

During model compilation, Amazon SageMaker AI needs your permission to:

\n
    \n
  • \n

    Read input data from an S3 bucket

    \n
    • \n
  • \n

    Write model artifacts to an S3 bucket

    \n
    • \n
  • \n

    Write logs to Amazon CloudWatch Logs

    \n
    • \n
  • \n

    Publish metrics to Amazon CloudWatch

    \n
    • \n
\n

You grant permissions for all of these tasks to an IAM role. To pass this role to\n Amazon SageMaker AI, the caller of this API must have the iam:PassRole permission. For\n more information, see Amazon SageMaker AI\n Roles.\n

", + "smithy.api#required": {} + } + }, + "ModelPackageVersionArn": { + "target": "com.amazonaws.sagemaker#ModelPackageArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a versioned model package. Provide either a \n ModelPackageVersionArn or an InputConfig object in the \n request syntax. The presence of both objects in the CreateCompilationJob \n request will return an exception.

" + } + }, + "InputConfig": { + "target": "com.amazonaws.sagemaker#InputConfig", + "traits": { + "smithy.api#documentation": "

Provides information about the location of input model artifacts, the name and shape\n of the expected data inputs, and the framework in which the model was trained.

" + } + }, + "OutputConfig": { + "target": "com.amazonaws.sagemaker#OutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Provides information about the output location for the compiled model and the target\n device the model runs on.

", + "smithy.api#required": {} + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#NeoVpcConfig", + "traits": { + "smithy.api#documentation": "

A VpcConfig object that specifies the VPC that you want your compilation job\n to connect to. Control access to your models by configuring the VPC. For more\n information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.

" + } + }, + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#StoppingCondition", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies a limit to how long a model compilation job can run. When the job reaches\n the time limit, Amazon SageMaker AI ends the compilation job. Use this API to cap model training\n costs.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateCompilationJobResponse": { + "type": "structure", + "members": { + "CompilationJobArn": { + "target": "com.amazonaws.sagemaker#CompilationJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

If the action is successful, the service sends back an HTTP 200 response. Amazon SageMaker AI returns\n the following data in JSON format:

\n
    \n
  • \n

    \n CompilationJobArn: The Amazon Resource Name (ARN) of the compiled\n job.

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateComputeQuota": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateComputeQuotaRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateComputeQuotaResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Create compute allocation definition. This defines how compute is allocated, shared, and\n borrowed for specified entities. Specifically, how to lend and borrow idle compute and\n assign a fair-share weight to the specified entities.

" + } + }, + "com.amazonaws.sagemaker#CreateComputeQuotaRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Name to the compute allocation definition.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "

Description of the compute allocation definition.

" + } + }, + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

ARN of the cluster.

", + "smithy.api#required": {} + } + }, + "ComputeQuotaConfig": { + "target": "com.amazonaws.sagemaker#ComputeQuotaConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Configuration of the compute allocation definition. This includes the resource sharing\n option, and the setting to preempt low priority tasks.

", + "smithy.api#required": {} + } + }, + "ComputeQuotaTarget": { + "target": "com.amazonaws.sagemaker#ComputeQuotaTarget", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The target entity to allocate compute resources to.

", + "smithy.api#required": {} + } + }, + "ActivationState": { + "target": "com.amazonaws.sagemaker#ActivationState", + "traits": { + "smithy.api#documentation": "

The state of the compute allocation being described. Use to enable or disable compute\n allocation.

\n

Default is Enabled.

" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

Tags of the compute allocation definition.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateComputeQuotaResponse": { + "type": "structure", + "members": { + "ComputeQuotaArn": { + "target": "com.amazonaws.sagemaker#ComputeQuotaArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

ARN of the compute allocation definition.

", + "smithy.api#required": {} + } + }, + "ComputeQuotaId": { + "target": "com.amazonaws.sagemaker#ComputeQuotaId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

ID of the compute allocation definition.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateContext": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateContextRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateContextResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a context. A context is a lineage tracking entity that\n represents a logical grouping of other tracking or experiment entities. Some examples are\n an endpoint and a model package. For more information, see\n Amazon SageMaker\n ML Lineage Tracking.

" + } + }, + "com.amazonaws.sagemaker#CreateContextRequest": { + "type": "structure", + "members": { + "ContextName": { + "target": "com.amazonaws.sagemaker#ContextName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the context. Must be unique to your account in an Amazon Web Services Region.

", + "smithy.api#required": {} + } + }, + "Source": { + "target": "com.amazonaws.sagemaker#ContextSource", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The source type, ID, and URI.

", + "smithy.api#required": {} + } + }, + "ContextType": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The context type.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#ExperimentDescription", + "traits": { + "smithy.api#documentation": "

The description of the context.

" + } + }, + "Properties": { + "target": "com.amazonaws.sagemaker#LineageEntityParameters", + "traits": { + "smithy.api#documentation": "

A list of properties to add to the context.

" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags to apply to the context.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateContextResponse": { + "type": "structure", + "members": { + "ContextArn": { + "target": "com.amazonaws.sagemaker#ContextArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the context.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateDataQualityJobDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateDataQualityJobDefinitionRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateDataQualityJobDefinitionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a definition for a job that monitors data quality and drift. For information\n about model monitor, see Amazon SageMaker AI Model\n Monitor.

" + } + }, + "com.amazonaws.sagemaker#CreateDataQualityJobDefinitionRequest": { + "type": "structure", + "members": { + "JobDefinitionName": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name for the monitoring job definition.

", + "smithy.api#required": {} + } + }, + "DataQualityBaselineConfig": { + "target": "com.amazonaws.sagemaker#DataQualityBaselineConfig", + "traits": { + "smithy.api#documentation": "

Configures the constraints and baselines for the monitoring job.

" + } + }, + "DataQualityAppSpecification": { + "target": "com.amazonaws.sagemaker#DataQualityAppSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies the container that runs the monitoring job.

", + "smithy.api#required": {} + } + }, + "DataQualityJobInput": { + "target": "com.amazonaws.sagemaker#DataQualityJobInput", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A list of inputs for the monitoring job. Currently endpoints are supported as monitoring\n inputs.

", + "smithy.api#required": {} + } + }, + "DataQualityJobOutputConfig": { + "target": "com.amazonaws.sagemaker#MonitoringOutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "JobResources": { + "target": "com.amazonaws.sagemaker#MonitoringResources", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "NetworkConfig": { + "target": "com.amazonaws.sagemaker#MonitoringNetworkConfig", + "traits": { + "smithy.api#documentation": "

Specifies networking configuration for the monitoring job.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can \n assume to perform tasks on your behalf.

", + "smithy.api#required": {} + } + }, + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#MonitoringStoppingCondition" + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

(Optional) An array of key-value pairs. For more information, see \n \n Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateDataQualityJobDefinitionResponse": { + "type": "structure", + "members": { + "JobDefinitionArn": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the job definition.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateDeviceFleet": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateDeviceFleetRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a device fleet.

" + } + }, + "com.amazonaws.sagemaker#CreateDeviceFleetRequest": { + "type": "structure", + "members": { + "DeviceFleetName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the fleet that the device belongs to.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet of Things (IoT).

" + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#DeviceFleetDescription", + "traits": { + "smithy.api#documentation": "

A description of the fleet.

" + } + }, + "OutputConfig": { + "target": "com.amazonaws.sagemaker#EdgeOutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The output configuration for storing sample data collected by the fleet.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

Creates tags for the specified fleet.

" + } + }, + "EnableIotRoleAlias": { + "target": "com.amazonaws.sagemaker#EnableIotRoleAlias", + "traits": { + "smithy.api#documentation": "

Whether to create an Amazon Web Services IoT Role Alias during device fleet creation. \n The name of the role alias generated will match this pattern: \n \"SageMakerEdge-{DeviceFleetName}\".

\n

For example, if your device fleet is called \"demo-fleet\", the name of \n the role alias will be \"SageMakerEdge-demo-fleet\".

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateDomain": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateDomainRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateDomainResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a Domain. A domain consists of an associated Amazon Elastic File System\n volume, a list of authorized users, and a variety of security, application, policy, and\n Amazon Virtual Private Cloud (VPC) configurations. Users within a domain can share notebook files\n and other artifacts with each other.

\n

\n EFS storage\n

\n

When a domain is created, an EFS volume is created for use by all of the users within the\n domain. Each user receives a private home directory within the EFS volume for notebooks, Git\n repositories, and data files.

\n

SageMaker AI uses the Amazon Web Services Key Management Service (Amazon Web Services\n KMS) to encrypt the EFS volume attached to the domain with an Amazon Web Services managed key\n by default. For more control, you can specify a customer managed key. For more information,\n see Protect Data\n at Rest Using Encryption.

\n

\n VPC configuration\n

\n

All traffic between the domain and the Amazon EFS volume is through the specified\n VPC and subnets. For other traffic, you can specify the AppNetworkAccessType\n parameter. AppNetworkAccessType corresponds to the network access type that you\n choose when you onboard to the domain. The following options are available:

\n
    \n
  • \n

    \n PublicInternetOnly - Non-EFS traffic goes through a VPC managed by\n Amazon SageMaker AI, which allows internet access. This is the default value.

    \n
    • \n
  • \n

    \n VpcOnly - All traffic is through the specified VPC and subnets. Internet\n access is disabled by default. To allow internet access, you must specify a NAT\n gateway.

    \n

    When internet access is disabled, you won't be able to run a Amazon SageMaker AI\n Studio notebook or to train or host models unless your VPC has an interface endpoint to\n the SageMaker AI API and runtime or a NAT gateway and your security groups allow\n outbound connections.

    \n
    • \n
\n \n

NFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules\n in order to launch a Amazon SageMaker AI Studio app successfully.

\n \n

For more information, see Connect Amazon SageMaker AI Studio Notebooks to Resources in a VPC.

" + } + }, + "com.amazonaws.sagemaker#CreateDomainRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.sagemaker#DomainName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A name for the domain.

", + "smithy.api#required": {} + } + }, + "AuthMode": { + "target": "com.amazonaws.sagemaker#AuthMode", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The mode of authentication that members use to access the domain.

", + "smithy.api#required": {} + } + }, + "DefaultUserSettings": { + "target": "com.amazonaws.sagemaker#UserSettings", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The default settings to use to create a user profile when UserSettings isn't\n specified in the call to the CreateUserProfile API.

\n

\n SecurityGroups is aggregated when specified in both calls. For all other\n settings in UserSettings, the values specified in CreateUserProfile\n take precedence over those specified in CreateDomain.

", + "smithy.api#required": {} + } + }, + "DomainSettings": { + "target": "com.amazonaws.sagemaker#DomainSettings", + "traits": { + "smithy.api#documentation": "

A collection of Domain settings.

" + } + }, + "SubnetIds": { + "target": "com.amazonaws.sagemaker#Subnets", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The VPC subnets that the domain uses for communication.

", + "smithy.api#required": {} + } + }, + "VpcId": { + "target": "com.amazonaws.sagemaker#VpcId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

Tags to associated with the Domain. Each tag consists of a key and an optional value. Tag\n keys must be unique per resource. Tags are searchable using the Search\n API.

\n

Tags that you specify for the Domain are also added to all Apps that the Domain\n launches.

" + } + }, + "AppNetworkAccessType": { + "target": "com.amazonaws.sagemaker#AppNetworkAccessType", + "traits": { + "smithy.api#documentation": "

Specifies the VPC used for non-EFS traffic. The default value is\n PublicInternetOnly.

\n
    \n
  • \n

    \n PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker AI, which allows direct internet access

    \n
    • \n
  • \n

    \n VpcOnly - All traffic is through the specified VPC and subnets

    \n
    • \n
" + } + }, + "HomeEfsFileSystemKmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#deprecated": { + "message": "This property is deprecated, use KmsKeyId instead." + }, + "smithy.api#documentation": "

Use KmsKeyId.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

SageMaker AI uses Amazon Web Services KMS to encrypt EFS and EBS volumes attached to\n the domain with an Amazon Web Services managed key by default. For more control, specify a\n customer managed key.

" + } + }, + "AppSecurityGroupManagement": { + "target": "com.amazonaws.sagemaker#AppSecurityGroupManagement", + "traits": { + "smithy.api#documentation": "

The entity that creates and manages the required security groups for inter-app\n communication in VPCOnly mode. Required when\n CreateDomain.AppNetworkAccessType is VPCOnly and\n DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is\n provided. If setting up the domain for use with RStudio, this value must be set to\n Service.

" + } + }, + "TagPropagation": { + "target": "com.amazonaws.sagemaker#TagPropagation", + "traits": { + "smithy.api#documentation": "

Indicates whether custom tag propagation is supported for the domain. Defaults to\n DISABLED.

" + } + }, + "DefaultSpaceSettings": { + "target": "com.amazonaws.sagemaker#DefaultSpaceSettings", + "traits": { + "smithy.api#documentation": "

The default settings for shared spaces that users create in the domain.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateDomainResponse": { + "type": "structure", + "members": { + "DomainArn": { + "target": "com.amazonaws.sagemaker#DomainArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the created domain.

" + } + }, + "Url": { + "target": "com.amazonaws.sagemaker#String1024", + "traits": { + "smithy.api#documentation": "

The URL to the created domain.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateEdgeDeploymentPlan": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateEdgeDeploymentPlanRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateEdgeDeploymentPlanResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an edge deployment plan, consisting of multiple stages. Each stage may have a\n different deployment configuration and devices.

" + } + }, + "com.amazonaws.sagemaker#CreateEdgeDeploymentPlanRequest": { + "type": "structure", + "members": { + "EdgeDeploymentPlanName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the edge deployment plan.

", + "smithy.api#required": {} + } + }, + "ModelConfigs": { + "target": "com.amazonaws.sagemaker#EdgeDeploymentModelConfigs", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

List of models associated with the edge deployment plan.

", + "smithy.api#required": {} + } + }, + "DeviceFleetName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The device fleet used for this edge deployment plan.

", + "smithy.api#required": {} + } + }, + "Stages": { + "target": "com.amazonaws.sagemaker#DeploymentStages", + "traits": { + "smithy.api#documentation": "

List of stages of the edge deployment plan. The number of stages is limited to 10 per\n deployment.

" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

List of tags with which to tag the edge deployment plan.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateEdgeDeploymentPlanResponse": { + "type": "structure", + "members": { + "EdgeDeploymentPlanArn": { + "target": "com.amazonaws.sagemaker#EdgeDeploymentPlanArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the edge deployment plan.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateEdgeDeploymentStage": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateEdgeDeploymentStageRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new stage in an existing edge deployment plan.

" + } + }, + "com.amazonaws.sagemaker#CreateEdgeDeploymentStageRequest": { + "type": "structure", + "members": { + "EdgeDeploymentPlanName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the edge deployment plan.

", + "smithy.api#required": {} + } + }, + "Stages": { + "target": "com.amazonaws.sagemaker#DeploymentStages", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

List of stages to be added to the edge deployment plan.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateEdgePackagingJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateEdgePackagingJobRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Starts a SageMaker Edge Manager model packaging job. Edge Manager will use the model artifacts from the Amazon Simple Storage Service bucket that you specify. After the model has been packaged, Amazon SageMaker saves the resulting artifacts to an S3 bucket that you specify.

" + } + }, + "com.amazonaws.sagemaker#CreateEdgePackagingJobRequest": { + "type": "structure", + "members": { + "EdgePackagingJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the edge packaging job.

", + "smithy.api#required": {} + } + }, + "CompilationJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the SageMaker Neo compilation job that will be used to locate model artifacts for packaging.

", + "smithy.api#required": {} + } + }, + "ModelName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the model.

", + "smithy.api#required": {} + } + }, + "ModelVersion": { + "target": "com.amazonaws.sagemaker#EdgeVersion", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The version of the model.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload the model, and to contact SageMaker Neo.

", + "smithy.api#required": {} + } + }, + "OutputConfig": { + "target": "com.amazonaws.sagemaker#EdgeOutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Provides information about the output location for the packaged model.

", + "smithy.api#required": {} + } + }, + "ResourceKey": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key to use when encrypting the EBS volume the edge packaging job runs on.

" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

Creates tags for the packaging job.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateEndpointInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateEndpointOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an endpoint using the endpoint configuration specified in the request. SageMaker\n uses the endpoint to provision resources and deploy models. You create the endpoint\n configuration with the CreateEndpointConfig API.

\n

Use this API to deploy models using SageMaker hosting services.

\n \n

You must not delete an EndpointConfig that is in use by an endpoint\n that is live or while the UpdateEndpoint or CreateEndpoint\n operations are being performed on the endpoint. To update an endpoint, you must\n create a new EndpointConfig.

\n \n

The endpoint name must be unique within an Amazon Web Services Region in your\n Amazon Web Services account.

\n

When it receives the request, SageMaker creates the endpoint, launches the resources (ML\n compute instances), and deploys the model(s) on them.

\n \n

When you call CreateEndpoint, a load call is made to DynamoDB to verify that your\n endpoint configuration exists. When you read data from a DynamoDB table supporting\n \n Eventually Consistent Reads\n , the response might not\n reflect the results of a recently completed write operation. The response might\n include some stale data. If the dependent entities are not yet in DynamoDB, this\n causes a validation error. If you repeat your read request after a short time, the\n response should return the latest data. So retry logic is recommended to handle\n these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB\n eventually consistent read.

\n \n

When SageMaker receives the request, it sets the endpoint status to\n Creating. After it creates the endpoint, it sets the status to\n InService. SageMaker can then process incoming requests for inferences. To\n check the status of an endpoint, use the DescribeEndpoint API.

\n

If any of the models hosted at this endpoint get model data from an Amazon S3 location,\n SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the\n S3 path you provided. Amazon Web Services STS is activated in your Amazon Web Services\n account by default. If you previously deactivated Amazon Web Services STS for a region,\n you need to reactivate Amazon Web Services STS for that region. For more information, see\n Activating and\n Deactivating Amazon Web Services STS in an Amazon Web Services Region in the\n Amazon Web Services Identity and Access Management User\n Guide.

\n \n

To add the IAM role policies for using this API operation, go to the IAM console, and choose\n Roles in the left navigation pane. Search the IAM role that you want to grant\n access to use the CreateEndpoint and CreateEndpointConfig API operations, add the following policies to the\n role.

\n
    \n
  • \n

    Option 1: For a full SageMaker access, search and attach the\n AmazonSageMakerFullAccess policy.

    \n
    • \n
  • \n

    Option 2: For granting a limited access to an IAM role, paste the\n following Action elements manually into the JSON file of the IAM role:

    \n

    \n \"Action\": [\"sagemaker:CreateEndpoint\",\n \"sagemaker:CreateEndpointConfig\"]\n

    \n

    \n \"Resource\": [\n

    \n

    \n \"arn:aws:sagemaker:region:account-id:endpoint/endpointName\"\n

    \n

    \n \"arn:aws:sagemaker:region:account-id:endpoint-config/endpointConfigName\"\n

    \n

    \n ]\n

    \n

    For more information, see SageMaker API\n Permissions: Actions, Permissions, and Resources\n Reference.

    \n
    • \n
\n " + } + }, + "com.amazonaws.sagemaker#CreateEndpointConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateEndpointConfigInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateEndpointConfigOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an endpoint configuration that SageMaker hosting services uses to deploy models. In\n the configuration, you identify one or more models, created using the\n CreateModel API, to deploy and the resources that you want SageMaker to\n provision. Then you call the CreateEndpoint\n API.

\n \n

Use this API if you want to use SageMaker hosting services to deploy models into\n production.

\n \n

In the request, you define a ProductionVariant, for each model that you\n want to deploy. Each ProductionVariant parameter also describes the\n resources that you want SageMaker to provision. This includes the number and type of ML\n compute instances to deploy.

\n

If you are hosting multiple models, you also assign a VariantWeight to\n specify how much traffic you want to allocate to each model. For example, suppose that\n you want to host two models, A and B, and you assign traffic weight 2 for model A and 1\n for model B. SageMaker distributes two-thirds of the traffic to Model A, and one-third to\n model B.

\n \n

When you call CreateEndpoint, a load call is made to DynamoDB to verify that your\n endpoint configuration exists. When you read data from a DynamoDB table supporting\n \n Eventually Consistent Reads\n , the response might not\n reflect the results of a recently completed write operation. The response might\n include some stale data. If the dependent entities are not yet in DynamoDB, this\n causes a validation error. If you repeat your read request after a short time, the\n response should return the latest data. So retry logic is recommended to handle\n these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB\n eventually consistent read.

\n " + } + }, + "com.amazonaws.sagemaker#CreateEndpointConfigInput": { + "type": "structure", + "members": { + "EndpointConfigName": { + "target": "com.amazonaws.sagemaker#EndpointConfigName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the endpoint configuration. You specify this name in a CreateEndpoint request.

", + "smithy.api#required": {} + } + }, + "ProductionVariants": { + "target": "com.amazonaws.sagemaker#ProductionVariantList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An array of ProductionVariant objects, one for each model that you want\n to host at this endpoint.

", + "smithy.api#required": {} + } + }, + "DataCaptureConfig": { + "target": "com.amazonaws.sagemaker#DataCaptureConfig" + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that\n SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that\n hosts the endpoint.

\n

The KmsKeyId can be any of the following formats:

\n
    \n
  • \n

    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Key ARN:\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Alias name: alias/ExampleAlias\n

    \n
    • \n
  • \n

    Alias name ARN:\n arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\n

    \n
    • \n
\n

The KMS key policy must grant permission to the IAM role that you specify in your\n CreateEndpoint, UpdateEndpoint requests. For more\n information, refer to the Amazon Web Services Key Management Service section Using Key\n Policies in Amazon Web Services KMS \n

\n \n

Certain Nitro-based instances include local storage, dependent on the instance\n type. Local storage volumes are encrypted using a hardware module on the instance.\n You can't request a KmsKeyId when using an instance type with local\n storage. If any of the models that you specify in the\n ProductionVariants parameter use nitro-based instances with local\n storage, do not specify a value for the KmsKeyId parameter. If you\n specify a value for KmsKeyId when using any nitro-based instances with\n local storage, the call to CreateEndpointConfig fails.

\n

For a list of instance types that support local instance storage, see Instance Store Volumes.

\n

For more information about local instance storage encryption, see SSD\n Instance Store Volumes.

\n " + } + }, + "AsyncInferenceConfig": { + "target": "com.amazonaws.sagemaker#AsyncInferenceConfig", + "traits": { + "smithy.api#documentation": "

Specifies configuration for how an endpoint performs asynchronous inference. This is a\n required field in order for your Endpoint to be invoked using InvokeEndpointAsync.

" + } + }, + "ExplainerConfig": { + "target": "com.amazonaws.sagemaker#ExplainerConfig", + "traits": { + "smithy.api#documentation": "

A member of CreateEndpointConfig that enables explainers.

" + } + }, + "ShadowProductionVariants": { + "target": "com.amazonaws.sagemaker#ProductionVariantList", + "traits": { + "smithy.api#documentation": "

An array of ProductionVariant objects, one for each model that you want\n to host at this endpoint in shadow mode with production traffic replicated from the\n model specified on ProductionVariants. If you use this field, you can only\n specify one variant for ProductionVariants and one variant for\n ShadowProductionVariants.

" + } + }, + "ExecutionRoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform actions on your behalf. For more information, see SageMaker AI\n Roles.

\n \n

To be able to pass this role to Amazon SageMaker AI, the caller of this action must\n have the iam:PassRole permission.

\n " + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig" + }, + "EnableNetworkIsolation": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

Sets whether all model containers deployed to the endpoint are isolated. If they are, no\n inbound or outbound network calls can be made to or from the model containers.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateEndpointConfigOutput": { + "type": "structure", + "members": { + "EndpointConfigArn": { + "target": "com.amazonaws.sagemaker#EndpointConfigArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the endpoint configuration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateEndpointInput": { + "type": "structure", + "members": { + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the endpoint.The name must be unique within an Amazon Web Services\n Region in your Amazon Web Services account. The name is case-insensitive in\n CreateEndpoint, but the case is preserved and must be matched in InvokeEndpoint.

", + "smithy.api#required": {} + } + }, + "EndpointConfigName": { + "target": "com.amazonaws.sagemaker#EndpointConfigName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of an endpoint configuration. For more information, see CreateEndpointConfig.

", + "smithy.api#required": {} + } + }, + "DeploymentConfig": { + "target": "com.amazonaws.sagemaker#DeploymentConfig" + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateEndpointOutput": { + "type": "structure", + "members": { + "EndpointArn": { + "target": "com.amazonaws.sagemaker#EndpointArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the endpoint.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateExperiment": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateExperimentRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateExperimentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a SageMaker experiment. An experiment is a collection of\n trials that are observed, compared and evaluated as a group. A trial is\n a set of steps, called trial components, that produce a machine learning\n model.

\n \n

In the Studio UI, trials are referred to as run groups and trial\n components are referred to as runs.

\n \n

The goal of an experiment is to determine the components that produce the best model.\n Multiple trials are performed, each one isolating and measuring the impact of a change to one\n or more inputs, while keeping the remaining inputs constant.

\n

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial\n components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you\n must use the logging APIs provided by the SDK.

\n

You can add tags to experiments, trials, trial components and then use the Search API to search for the tags.

\n

To add a description to an experiment, specify the optional Description\n parameter. To add a description later, or to change the description, call the UpdateExperiment API.

\n

To get a list of all your experiments, call the ListExperiments API. To\n view an experiment's properties, call the DescribeExperiment API. To get a\n list of all the trials associated with an experiment, call the ListTrials API. To create a trial call the CreateTrial API.

" + } + }, + "com.amazonaws.sagemaker#CreateExperimentRequest": { + "type": "structure", + "members": { + "ExperimentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the experiment. The name must be unique in your Amazon Web Services account and is not\n case-sensitive.

", + "smithy.api#required": {} + } + }, + "DisplayName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

The name of the experiment as displayed. The name doesn't need to be unique. If you don't\n specify DisplayName, the value in ExperimentName is\n displayed.

" + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#ExperimentDescription", + "traits": { + "smithy.api#documentation": "

The description of the experiment.

" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags to associate with the experiment. You can use Search API\n to search on the tags.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateExperimentResponse": { + "type": "structure", + "members": { + "ExperimentArn": { + "target": "com.amazonaws.sagemaker#ExperimentArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the experiment.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateFeatureGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateFeatureGroupRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateFeatureGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Create a new FeatureGroup. A FeatureGroup is a group of\n Features defined in the FeatureStore to describe a\n Record.

\n

The FeatureGroup defines the schema and features contained in the\n FeatureGroup. A FeatureGroup definition is composed of a list\n of Features, a RecordIdentifierFeatureName, an\n EventTimeFeatureName and configurations for its OnlineStore\n and OfflineStore. Check Amazon Web Services service\n quotas to see the FeatureGroups quota for your Amazon Web Services\n account.

\n

Note that it can take approximately 10-15 minutes to provision an\n OnlineStore\n FeatureGroup with the InMemory\n StorageType.

\n \n

You must include at least one of OnlineStoreConfig and\n OfflineStoreConfig to create a FeatureGroup.

\n " + } + }, + "com.amazonaws.sagemaker#CreateFeatureGroupRequest": { + "type": "structure", + "members": { + "FeatureGroupName": { + "target": "com.amazonaws.sagemaker#FeatureGroupName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the FeatureGroup. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.

\n

The name:

\n
    \n
  • \n

    Must start with an alphanumeric character.

    \n
    • \n
  • \n

    Can only include alphanumeric characters, underscores, and hyphens. Spaces are not\n allowed.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "RecordIdentifierFeatureName": { + "target": "com.amazonaws.sagemaker#FeatureName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Feature whose value uniquely identifies a\n Record defined in the FeatureStore. Only the latest record per\n identifier value will be stored in the OnlineStore.\n RecordIdentifierFeatureName must be one of feature definitions'\n names.

\n

You use the RecordIdentifierFeatureName to access data in a\n FeatureStore.

\n

This name:

\n
    \n
  • \n

    Must start with an alphanumeric character.

    \n
    • \n
  • \n

    Can only contains alphanumeric characters, hyphens, underscores. Spaces are not\n allowed.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "EventTimeFeatureName": { + "target": "com.amazonaws.sagemaker#FeatureName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the feature that stores the EventTime of a Record\n in a FeatureGroup.

\n

An EventTime is a point in time when a new event occurs that corresponds to\n the creation or update of a Record in a FeatureGroup. All\n Records in the FeatureGroup must have a corresponding\n EventTime.

\n

An EventTime can be a String or Fractional.

\n
    \n
  • \n

    \n Fractional: EventTime feature values must be a Unix\n timestamp in seconds.

    \n
    • \n
  • \n

    \n String: EventTime feature values must be an ISO-8601\n string in the format. The following formats are supported\n yyyy-MM-dd'T'HH:mm:ssZ and yyyy-MM-dd'T'HH:mm:ss.SSSZ\n where yyyy, MM, and dd represent the year,\n month, and day respectively and HH, mm, ss,\n and if applicable, SSS represent the hour, month, second and\n milliseconds respsectively. 'T' and Z are constants.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "FeatureDefinitions": { + "target": "com.amazonaws.sagemaker#FeatureDefinitions", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A list of Feature names and types. Name and Type\n is compulsory per Feature.

\n

Valid feature FeatureTypes are Integral,\n Fractional and String.

\n

\n FeatureNames cannot be any of the following: is_deleted,\n write_time, api_invocation_time\n

\n

You can create up to 2,500 FeatureDefinitions per\n FeatureGroup.

", + "smithy.api#required": {} + } + }, + "OnlineStoreConfig": { + "target": "com.amazonaws.sagemaker#OnlineStoreConfig", + "traits": { + "smithy.api#documentation": "

You can turn the OnlineStore on or off by specifying True for\n the EnableOnlineStore flag in OnlineStoreConfig.

\n

You can also include an Amazon Web Services KMS key ID (KMSKeyId) for\n at-rest encryption of the OnlineStore.

\n

The default value is False.

" + } + }, + "OfflineStoreConfig": { + "target": "com.amazonaws.sagemaker#OfflineStoreConfig", + "traits": { + "smithy.api#documentation": "

Use this to configure an OfflineFeatureStore. This parameter allows you to\n specify:

\n
    \n
  • \n

    The Amazon Simple Storage Service (Amazon S3) location of an\n OfflineStore.

    \n
    • \n
  • \n

    A configuration for an Amazon Web Services Glue or Amazon Web Services Hive data\n catalog.

    \n
    • \n
  • \n

    An KMS encryption key to encrypt the Amazon S3 location used for\n OfflineStore. If KMS encryption key is not specified, by default we\n encrypt all data at rest using Amazon Web Services KMS key. By defining your bucket-level\n key for SSE, you can reduce Amazon Web Services KMS requests costs by up to\n 99 percent.

    \n
    • \n
  • \n

    Format for the offline store table. Supported formats are Glue (Default) and\n Apache Iceberg.

    \n
    • \n
\n

To learn more about this parameter, see OfflineStoreConfig.

" + } + }, + "ThroughputConfig": { + "target": "com.amazonaws.sagemaker#ThroughputConfig" + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the\n OfflineStore if an OfflineStoreConfig is provided.

" + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#Description", + "traits": { + "smithy.api#documentation": "

A free-form description of a FeatureGroup.

" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

Tags used to identify Features in each FeatureGroup.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateFeatureGroupResponse": { + "type": "structure", + "members": { + "FeatureGroupArn": { + "target": "com.amazonaws.sagemaker#FeatureGroupArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the FeatureGroup. This is a unique\n identifier for the feature group.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateFlowDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateFlowDefinitionRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateFlowDefinitionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a flow definition.

" + } + }, + "com.amazonaws.sagemaker#CreateFlowDefinitionRequest": { + "type": "structure", + "members": { + "FlowDefinitionName": { + "target": "com.amazonaws.sagemaker#FlowDefinitionName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of your flow definition.

", + "smithy.api#required": {} + } + }, + "HumanLoopRequestSource": { + "target": "com.amazonaws.sagemaker#HumanLoopRequestSource", + "traits": { + "smithy.api#documentation": "

Container for configuring the source of human task requests. Use to specify if\n Amazon Rekognition or Amazon Textract is used as an integration source.

" + } + }, + "HumanLoopActivationConfig": { + "target": "com.amazonaws.sagemaker#HumanLoopActivationConfig", + "traits": { + "smithy.api#documentation": "

An object containing information about the events that trigger a human workflow.

" + } + }, + "HumanLoopConfig": { + "target": "com.amazonaws.sagemaker#HumanLoopConfig", + "traits": { + "smithy.api#documentation": "

An object containing information about the tasks the human reviewers will perform.

" + } + }, + "OutputConfig": { + "target": "com.amazonaws.sagemaker#FlowDefinitionOutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An object containing information about where the human review results will be uploaded.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role needed to call other services on your behalf. For example, arn:aws:iam::1234567890:role/service-role/AmazonSageMaker-ExecutionRole-20180111T151298.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs that contain metadata to help you categorize and organize a flow definition. Each tag consists of a key and a value, both of which you define.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateFlowDefinitionResponse": { + "type": "structure", + "members": { + "FlowDefinitionArn": { + "target": "com.amazonaws.sagemaker#FlowDefinitionArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the flow definition you create.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateHub": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateHubRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateHubResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Create a hub.

" + } + }, + "com.amazonaws.sagemaker#CreateHubContentReference": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateHubContentReferenceRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateHubContentReferenceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Create a hub content reference in order to add a model in the JumpStart public hub to a private hub.

" + } + }, + "com.amazonaws.sagemaker#CreateHubContentReferenceRequest": { + "type": "structure", + "members": { + "HubName": { + "target": "com.amazonaws.sagemaker#HubNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the hub to add the hub content reference to.

", + "smithy.api#required": {} + } + }, + "SageMakerPublicHubContentArn": { + "target": "com.amazonaws.sagemaker#SageMakerPublicHubContentArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the public hub content to reference.

", + "smithy.api#required": {} + } + }, + "HubContentName": { + "target": "com.amazonaws.sagemaker#HubContentName", + "traits": { + "smithy.api#documentation": "

The name of the hub content to reference.

" + } + }, + "MinVersion": { + "target": "com.amazonaws.sagemaker#HubContentVersion", + "traits": { + "smithy.api#documentation": "

The minimum version of the hub content to reference.

" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

Any tags associated with the hub content to reference.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateHubContentReferenceResponse": { + "type": "structure", + "members": { + "HubArn": { + "target": "com.amazonaws.sagemaker#HubArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the hub that the hub content reference was added to.

", + "smithy.api#required": {} + } + }, + "HubContentArn": { + "target": "com.amazonaws.sagemaker#HubContentArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the hub content.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateHubRequest": { + "type": "structure", + "members": { + "HubName": { + "target": "com.amazonaws.sagemaker#HubName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the hub to create.

", + "smithy.api#required": {} + } + }, + "HubDescription": { + "target": "com.amazonaws.sagemaker#HubDescription", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A description of the hub.

", + "smithy.api#required": {} + } + }, + "HubDisplayName": { + "target": "com.amazonaws.sagemaker#HubDisplayName", + "traits": { + "smithy.api#documentation": "

The display name of the hub.

" + } + }, + "HubSearchKeywords": { + "target": "com.amazonaws.sagemaker#HubSearchKeywordList", + "traits": { + "smithy.api#documentation": "

The searchable keywords for the hub.

" + } + }, + "S3StorageConfig": { + "target": "com.amazonaws.sagemaker#HubS3StorageConfig", + "traits": { + "smithy.api#documentation": "

The Amazon S3 storage configuration for the hub.

" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

Any tags to associate with the hub.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateHubResponse": { + "type": "structure", + "members": { + "HubArn": { + "target": "com.amazonaws.sagemaker#HubArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the hub.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateHumanTaskUi": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateHumanTaskUiRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateHumanTaskUiResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Defines the settings you will use for the human review workflow user interface. Reviewers will see a three-panel interface with an instruction area, the item to review, and an input area.

" + } + }, + "com.amazonaws.sagemaker#CreateHumanTaskUiRequest": { + "type": "structure", + "members": { + "HumanTaskUiName": { + "target": "com.amazonaws.sagemaker#HumanTaskUiName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the user interface you are creating.

", + "smithy.api#required": {} + } + }, + "UiTemplate": { + "target": "com.amazonaws.sagemaker#UiTemplate", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs that contain metadata to help you categorize and organize a human review workflow user interface. Each tag consists of a key and a value, both of which you define.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateHumanTaskUiResponse": { + "type": "structure", + "members": { + "HumanTaskUiArn": { + "target": "com.amazonaws.sagemaker#HumanTaskUiArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the human review workflow user interface you create.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateHyperParameterTuningJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateHyperParameterTuningJobRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateHyperParameterTuningJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Starts a hyperparameter tuning job. A hyperparameter tuning job finds the best version\n of a model by running many training jobs on your dataset using the algorithm you choose\n and values for hyperparameters within ranges that you specify. It then chooses the\n hyperparameter values that result in a model that performs the best, as measured by an\n objective metric that you choose.

\n

A hyperparameter tuning job automatically creates Amazon SageMaker experiments, trials, and\n trial components for each training job that it runs. You can view these entities in\n Amazon SageMaker Studio. For more information, see View\n Experiments, Trials, and Trial Components.

\n \n

Do not include any security-sensitive information including account access IDs,\n secrets or tokens in any hyperparameter field. If the use of security-sensitive\n credentials are detected, SageMaker will reject your training job request and return an\n exception error.

\n " + } + }, + "com.amazonaws.sagemaker#CreateHyperParameterTuningJobRequest": { + "type": "structure", + "members": { + "HyperParameterTuningJobName": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the tuning job. This name is the prefix for the names of all training jobs\n that this tuning job launches. The name must be unique within the same Amazon Web Services account and Amazon Web Services Region. The name must have 1 to 32 characters. Valid\n characters are a-z, A-Z, 0-9, and : + = @ _ % - (hyphen). The name is not case\n sensitive.

", + "smithy.api#required": {} + } + }, + "HyperParameterTuningJobConfig": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The HyperParameterTuningJobConfig object that describes the tuning job,\n including the search strategy, the objective metric used to evaluate training jobs,\n ranges of parameters to search, and resource limits for the tuning job. For more\n information, see How\n Hyperparameter Tuning Works.

", + "smithy.api#required": {} + } + }, + "TrainingJobDefinition": { + "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinition", + "traits": { + "smithy.api#documentation": "

The HyperParameterTrainingJobDefinition object that describes the training jobs\n that this tuning job launches, including static hyperparameters, input data\n configuration, output data configuration, resource configuration, and stopping\n condition.

" + } + }, + "TrainingJobDefinitions": { + "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinitions", + "traits": { + "smithy.api#documentation": "

A list of the HyperParameterTrainingJobDefinition objects launched for this tuning\n job.

" + } + }, + "WarmStartConfig": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobWarmStartConfig", + "traits": { + "smithy.api#documentation": "

Specifies the configuration for starting the hyperparameter tuning job using one or\n more previous tuning jobs as a starting point. The results of previous tuning jobs are\n used to inform which combinations of hyperparameters to search over in the new tuning\n job.

\n

All training jobs launched by the new hyperparameter tuning job are evaluated by using\n the objective metric. If you specify IDENTICAL_DATA_AND_ALGORITHM as the\n WarmStartType value for the warm start configuration, the training job\n that performs the best in the new tuning job is compared to the best training jobs from\n the parent tuning jobs. From these, the training job that performs the best as measured\n by the objective metric is returned as the overall best training job.

\n \n

All training jobs launched by parent hyperparameter tuning jobs and the new\n hyperparameter tuning jobs count against the limit of training jobs for the tuning\n job.

\n " + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.

\n

Tags that you specify for the tuning job are also added to all training jobs that the\n tuning job launches.

" + } + }, + "Autotune": { + "target": "com.amazonaws.sagemaker#Autotune", + "traits": { + "smithy.api#documentation": "

Configures SageMaker Automatic model tuning (AMT) to automatically find optimal\n parameters for the following fields:

\n
    \n
  • \n

    \n ParameterRanges: The names and ranges of parameters that a\n hyperparameter tuning job can optimize.

    \n
    • \n
  • \n

    \n ResourceLimits: The maximum resources that can be used for a\n training job. These resources include the maximum number of training jobs, the\n maximum runtime of a tuning job, and the maximum number of training jobs to run\n at the same time.

    \n
    • \n
  • \n

    \n TrainingJobEarlyStoppingType: A flag that specifies whether or not\n to use early stopping for training jobs launched by a hyperparameter tuning\n job.

    \n
    • \n
  • \n

    \n RetryStrategy: The number of times to retry a training job.

    \n
    • \n
  • \n

    \n Strategy: Specifies how hyperparameter tuning chooses the\n combinations of hyperparameter values to use for the training jobs that it\n launches.

    \n
    • \n
  • \n

    \n ConvergenceDetected: A flag to indicate that Automatic model tuning\n (AMT) has detected model convergence.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateHyperParameterTuningJobResponse": { + "type": "structure", + "members": { + "HyperParameterTuningJobArn": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the tuning job. SageMaker assigns an ARN to a\n hyperparameter tuning job when you create it.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateImageRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateImageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a custom SageMaker AI image. A SageMaker AI image is a set of image versions. Each image\n version represents a container image stored in Amazon ECR. For more information, see\n Bring your own SageMaker AI image.

" + } + }, + "com.amazonaws.sagemaker#CreateImageRequest": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.sagemaker#ImageDescription", + "traits": { + "smithy.api#documentation": "

The description of the image.

" + } + }, + "DisplayName": { + "target": "com.amazonaws.sagemaker#ImageDisplayName", + "traits": { + "smithy.api#documentation": "

The display name of the image. If not provided, ImageName is displayed.

" + } + }, + "ImageName": { + "target": "com.amazonaws.sagemaker#ImageName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the image. Must be unique to your account.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of an IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags to apply to the image.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateImageResponse": { + "type": "structure", + "members": { + "ImageArn": { + "target": "com.amazonaws.sagemaker#ImageArn", + "traits": { + "smithy.api#documentation": "

The ARN of the image.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateImageVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateImageVersionRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateImageVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a version of the SageMaker AI image specified by ImageName. The version\n represents the Amazon ECR container image specified by BaseImage.

" + } + }, + "com.amazonaws.sagemaker#CreateImageVersionRequest": { + "type": "structure", + "members": { + "BaseImage": { + "target": "com.amazonaws.sagemaker#ImageBaseImage", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The registry path of the container image to use as the starting point for this\n version. The path is an Amazon ECR URI in the following format:

\n

\n .dkr.ecr..amazonaws.com/\n

", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.sagemaker#ClientToken", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A unique ID. If not specified, the Amazon Web Services CLI and Amazon Web Services SDKs, such as the SDK for Python\n (Boto3), add a unique value to the call.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "ImageName": { + "target": "com.amazonaws.sagemaker#ImageName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ImageName of the Image to create a version of.

", + "smithy.api#required": {} + } + }, + "Aliases": { + "target": "com.amazonaws.sagemaker#SageMakerImageVersionAliases", + "traits": { + "smithy.api#documentation": "

A list of aliases created with the image version.

" + } + }, + "VendorGuidance": { + "target": "com.amazonaws.sagemaker#VendorGuidance", + "traits": { + "smithy.api#documentation": "

The stability of the image version, specified by the maintainer.

\n
    \n
  • \n

    \n NOT_PROVIDED: The maintainers did not provide a status for image version stability.

    \n
    • \n
  • \n

    \n STABLE: The image version is stable.

    \n
    • \n
  • \n

    \n TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.

    \n
    • \n
  • \n

    \n ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.

    \n
    • \n
" + } + }, + "JobType": { + "target": "com.amazonaws.sagemaker#JobType", + "traits": { + "smithy.api#documentation": "

Indicates SageMaker AI job type compatibility.

\n
    \n
  • \n

    \n TRAINING: The image version is compatible with SageMaker AI training jobs.

    \n
    • \n
  • \n

    \n INFERENCE: The image version is compatible with SageMaker AI inference jobs.

    \n
    • \n
  • \n

    \n NOTEBOOK_KERNEL: The image version is compatible with SageMaker AI notebook kernels.

    \n
    • \n
" + } + }, + "MLFramework": { + "target": "com.amazonaws.sagemaker#MLFramework", + "traits": { + "smithy.api#documentation": "

The machine learning framework vended in the image version.

" + } + }, + "ProgrammingLang": { + "target": "com.amazonaws.sagemaker#ProgrammingLang", + "traits": { + "smithy.api#documentation": "

The supported programming language and its version.

" + } + }, + "Processor": { + "target": "com.amazonaws.sagemaker#Processor", + "traits": { + "smithy.api#documentation": "

Indicates CPU or GPU compatibility.

\n
    \n
  • \n

    \n CPU: The image version is compatible with CPU.

    \n
    • \n
  • \n

    \n GPU: The image version is compatible with GPU.

    \n
    • \n
" + } + }, + "Horovod": { + "target": "com.amazonaws.sagemaker#Horovod", + "traits": { + "smithy.api#documentation": "

Indicates Horovod compatibility.

" + } + }, + "ReleaseNotes": { + "target": "com.amazonaws.sagemaker#ReleaseNotes", + "traits": { + "smithy.api#documentation": "

The maintainer description of the image version.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateImageVersionResponse": { + "type": "structure", + "members": { + "ImageVersionArn": { + "target": "com.amazonaws.sagemaker#ImageVersionArn", + "traits": { + "smithy.api#documentation": "

The ARN of the image version.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateInferenceComponent": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateInferenceComponentInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateInferenceComponentOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an inference component, which is a SageMaker AI hosting object that you can\n use to deploy a model to an endpoint. In the inference component settings, you specify the\n model, the endpoint, and how the model utilizes the resources that the endpoint hosts. You\n can optimize resource utilization by tailoring how the required CPU cores, accelerators,\n and memory are allocated. You can deploy multiple inference components to an endpoint,\n where each inference component contains one model and the resource utilization needs for\n that individual model. After you deploy an inference component, you can directly invoke the\n associated model when you use the InvokeEndpoint API action.

" + } + }, + "com.amazonaws.sagemaker#CreateInferenceComponentInput": { + "type": "structure", + "members": { + "InferenceComponentName": { + "target": "com.amazonaws.sagemaker#InferenceComponentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A unique name to assign to the inference component.

", + "smithy.api#required": {} + } + }, + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of an existing endpoint where you host the inference component.

", + "smithy.api#required": {} + } + }, + "VariantName": { + "target": "com.amazonaws.sagemaker#VariantName", + "traits": { + "smithy.api#documentation": "

The name of an existing production variant where you host the inference\n component.

" + } + }, + "Specification": { + "target": "com.amazonaws.sagemaker#InferenceComponentSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Details about the resources to deploy with this inference component, including the\n model, container, and compute resources.

", + "smithy.api#required": {} + } + }, + "RuntimeConfig": { + "target": "com.amazonaws.sagemaker#InferenceComponentRuntimeConfig", + "traits": { + "smithy.api#documentation": "

Runtime settings for a model that is deployed with an inference component.

" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

A list of key-value pairs associated with the model. For more information, see Tagging Amazon Web Services\n resources in the Amazon Web Services General\n Reference.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateInferenceComponentOutput": { + "type": "structure", + "members": { + "InferenceComponentArn": { + "target": "com.amazonaws.sagemaker#InferenceComponentArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the inference component.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateInferenceExperiment": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateInferenceExperimentRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateInferenceExperimentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

\n Creates an inference experiment using the configurations specified in the request.\n

\n

\n Use this API to setup and schedule an experiment to compare model variants on a Amazon SageMaker inference endpoint. For\n more information about inference experiments, see Shadow tests.\n

\n

\n Amazon SageMaker begins your experiment at the scheduled time and routes traffic to your endpoint's model variants based\n on your specified configuration.\n

\n

\n While the experiment is in progress or after it has concluded, you can view metrics that compare your model\n variants. For more information, see View, monitor, and edit shadow tests.\n

" + } + }, + "com.amazonaws.sagemaker#CreateInferenceExperimentRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#InferenceExperimentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name for the inference experiment.

", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.sagemaker#InferenceExperimentType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

\n The type of the inference experiment that you want to run. The following types of experiments are possible:\n

\n
    \n
  • \n

    \n ShadowMode: You can use this type to validate a shadow variant. For more information,\n see Shadow tests.\n

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Schedule": { + "target": "com.amazonaws.sagemaker#InferenceExperimentSchedule", + "traits": { + "smithy.api#documentation": "

\n The duration for which you want the inference experiment to run. If you don't specify this field, the\n experiment automatically starts immediately upon creation and concludes after 7 days.\n

" + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#InferenceExperimentDescription", + "traits": { + "smithy.api#documentation": "

A description for the inference experiment.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

\n The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage\n Amazon SageMaker Inference endpoints for model deployment.\n

", + "smithy.api#required": {} + } + }, + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

\n The name of the Amazon SageMaker endpoint on which you want to run the inference experiment.\n

", + "smithy.api#required": {} + } + }, + "ModelVariants": { + "target": "com.amazonaws.sagemaker#ModelVariantConfigList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

\n An array of ModelVariantConfig objects. There is one for each variant in the inference\n experiment. Each ModelVariantConfig object in the array describes the infrastructure\n configuration for the corresponding variant.\n

", + "smithy.api#required": {} + } + }, + "DataStorageConfig": { + "target": "com.amazonaws.sagemaker#InferenceExperimentDataStorageConfig", + "traits": { + "smithy.api#documentation": "

\n The Amazon S3 location and configuration for storing inference request and response data.\n

\n

\n This is an optional parameter that you can use for data capture. For more information, see Capture data.\n

" + } + }, + "ShadowModeConfig": { + "target": "com.amazonaws.sagemaker#ShadowModeConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

\n The configuration of ShadowMode inference experiment type. Use this field to specify a\n production variant which takes all the inference requests, and a shadow variant to which Amazon SageMaker replicates a\n percentage of the inference requests. For the shadow variant also specify the percentage of requests that\n Amazon SageMaker replicates.\n

", + "smithy.api#required": {} + } + }, + "KmsKey": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

\n The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on\n the storage volume attached to the ML compute instance that hosts the endpoint. The KmsKey can\n be any of the following formats:\n

\n
    \n
  • \n

    KMS key ID

    \n

    \n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    Amazon Resource Name (ARN) of a KMS key

    \n

    \n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    KMS key Alias

    \n

    \n \"alias/ExampleAlias\"\n

    \n
    • \n
  • \n

    Amazon Resource Name (ARN) of a KMS key Alias

    \n

    \n \"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"\n

    \n
    • \n
\n

\n If you use a KMS key ID or an alias of your KMS key, the Amazon SageMaker execution role must include permissions to\n call kms:Encrypt. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for\n your role's account. Amazon SageMaker uses server-side encryption with KMS managed keys for\n OutputDataConfig. If you use a bucket policy with an s3:PutObject permission that\n only allows objects with server-side encryption, set the condition key of\n s3:x-amz-server-side-encryption to \"aws:kms\". For more information, see KMS managed Encryption Keys\n in the Amazon Simple Storage Service Developer Guide.\n

\n

\n The KMS key policy must grant permission to the IAM role that you specify in your\n CreateEndpoint and UpdateEndpoint requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer\n Guide.\n

" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

\n Array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different\n ways, for example, by purpose, owner, or environment. For more information, see Tagging your Amazon Web Services Resources.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateInferenceExperimentResponse": { + "type": "structure", + "members": { + "InferenceExperimentArn": { + "target": "com.amazonaws.sagemaker#InferenceExperimentArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN for your inference experiment.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateInferenceRecommendationsJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateInferenceRecommendationsJobRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateInferenceRecommendationsJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Starts a recommendation job. You can create either an instance \n recommendation or load test job.

" + } + }, + "com.amazonaws.sagemaker#CreateInferenceRecommendationsJobRequest": { + "type": "structure", + "members": { + "JobName": { + "target": "com.amazonaws.sagemaker#RecommendationJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A name for the recommendation job. The name must be unique within \n the Amazon Web Services Region and within your Amazon Web Services account.\n The job name is passed down to the resources created by the recommendation job.\n The names of resources (such as the model, endpoint configuration, endpoint, and compilation)\n that are prefixed with the job name are truncated at 40 characters.

", + "smithy.api#required": {} + } + }, + "JobType": { + "target": "com.amazonaws.sagemaker#RecommendationJobType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Defines the type of recommendation job. Specify Default to initiate an instance \n recommendation and Advanced to initiate a load test. If left unspecified, \n Amazon SageMaker Inference Recommender will run an instance recommendation (DEFAULT) job.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker \n to perform tasks on your behalf.

", + "smithy.api#required": {} + } + }, + "InputConfig": { + "target": "com.amazonaws.sagemaker#RecommendationJobInputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Provides information about the versioned model package Amazon Resource Name (ARN), \n the traffic pattern, and endpoint configurations.

", + "smithy.api#required": {} + } + }, + "JobDescription": { + "target": "com.amazonaws.sagemaker#RecommendationJobDescription", + "traits": { + "smithy.api#documentation": "

Description of the recommendation job.

" + } + }, + "StoppingConditions": { + "target": "com.amazonaws.sagemaker#RecommendationJobStoppingConditions", + "traits": { + "smithy.api#documentation": "

A set of conditions for stopping a recommendation job. If any of \n the conditions are met, the job is automatically stopped.

" + } + }, + "OutputConfig": { + "target": "com.amazonaws.sagemaker#RecommendationJobOutputConfig", + "traits": { + "smithy.api#documentation": "

Provides information about the output artifacts and the KMS key \n to use for Amazon S3 server-side encryption.

" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

The metadata that you apply to Amazon Web Services resources to help you \n categorize and organize them. Each tag consists of a key and a value, both of \n which you define. For more information, see \n Tagging Amazon Web Services Resources \n in the Amazon Web Services General Reference.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateInferenceRecommendationsJobResponse": { + "type": "structure", + "members": { + "JobArn": { + "target": "com.amazonaws.sagemaker#RecommendationJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recommendation job.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateLabelingJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateLabelingJobRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateLabelingJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a job that uses workers to label the data objects in your input dataset. You\n can use the labeled data to train machine learning models.

\n

You can select your workforce from one of three providers:

\n
    \n
  • \n

    A private workforce that you create. It can include employees, contractors,\n and outside experts. Use a private workforce when want the data to stay within\n your organization or when a specific set of skills is required.

    \n
    • \n
  • \n

    One or more vendors that you select from the Amazon Web Services Marketplace. Vendors provide\n expertise in specific areas.

    \n
    • \n
  • \n

    The Amazon Mechanical Turk workforce. This is the largest workforce, but it\n should only be used for public data or data that has been stripped of any\n personally identifiable information.

    \n
    • \n
\n

You can also use automated data labeling to reduce the number of\n data objects that need to be labeled by a human. Automated data labeling uses\n active learning to determine if a data object can be labeled by\n machine or if it needs to be sent to a human worker. For more information, see Using\n Automated Data Labeling.

\n

The data objects to be labeled are contained in an Amazon S3 bucket. You create a\n manifest file that describes the location of each object. For\n more information, see Using Input and Output Data.

\n

The output can be used as the manifest file for another labeling job or as training\n data for your machine learning models.

\n

You can use this operation to create a static labeling job or a streaming labeling\n job. A static labeling job stops if all data objects in the input manifest file\n identified in ManifestS3Uri have been labeled. A streaming labeling job\n runs perpetually until it is manually stopped, or remains idle for 10 days. You can send\n new data objects to an active (InProgress) streaming labeling job in real\n time. To learn how to create a static labeling job, see Create a Labeling Job\n (API) in the Amazon SageMaker Developer Guide. To learn how to create a streaming\n labeling job, see Create a Streaming Labeling\n Job.

" + } + }, + "com.amazonaws.sagemaker#CreateLabelingJobRequest": { + "type": "structure", + "members": { + "LabelingJobName": { + "target": "com.amazonaws.sagemaker#LabelingJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the labeling job. This name is used to identify the job in a list of\n labeling jobs. Labeling job names must be unique within an Amazon Web Services account and region.\n LabelingJobName is not case sensitive. For example, Example-job and\n example-job are considered the same labeling job name by Ground Truth.

", + "smithy.api#required": {} + } + }, + "LabelAttributeName": { + "target": "com.amazonaws.sagemaker#LabelAttributeName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The attribute name to use for the label in the output manifest file. This is the key\n for the key/value pair formed with the label that a worker assigns to the object. The\n LabelAttributeName must meet the following requirements.

\n
    \n
  • \n

    The name can't end with \"-metadata\".

    \n
    • \n
  • \n

    If you are using one of the following built-in task types,\n the attribute name must end with \"-ref\". If the task type\n you are using is not listed below, the attribute name must\n not end with \"-ref\".

    \n
      \n
    • \n

      Image semantic segmentation (SemanticSegmentation), and\n adjustment (AdjustmentSemanticSegmentation) and\n verification (VerificationSemanticSegmentation) labeling\n jobs for this task type.

      \n
      • \n
    • \n

      Video frame object detection (VideoObjectDetection), and\n adjustment and verification\n (AdjustmentVideoObjectDetection) labeling jobs for this\n task type.

      \n
      • \n
    • \n

      Video frame object tracking (VideoObjectTracking), and\n adjustment and verification (AdjustmentVideoObjectTracking)\n labeling jobs for this task type.

      \n
      • \n
    • \n

      3D point cloud semantic segmentation\n (3DPointCloudSemanticSegmentation), and adjustment and\n verification (Adjustment3DPointCloudSemanticSegmentation)\n labeling jobs for this task type.

      \n
      • \n
    • \n

      3D point cloud object tracking\n (3DPointCloudObjectTracking), and adjustment and\n verification (Adjustment3DPointCloudObjectTracking)\n labeling jobs for this task type.

      \n
      • \n
    \n
    • \n
\n

\n \n

If you are creating an adjustment or verification labeling job, you must use a\n different\n LabelAttributeName than the one used in the original labeling job. The\n original labeling job is the Ground Truth labeling job that produced the labels that you\n want verified or adjusted. To learn more about adjustment and verification labeling\n jobs, see Verify and Adjust\n Labels.

\n ", + "smithy.api#required": {} + } + }, + "InputConfig": { + "target": "com.amazonaws.sagemaker#LabelingJobInputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Input data for the labeling job, such as the Amazon S3 location of the data objects and the\n location of the manifest file that describes the data objects.

\n

You must specify at least one of the following: S3DataSource or\n SnsDataSource.

\n
    \n
  • \n

    Use SnsDataSource to specify an SNS input topic for a streaming\n labeling job. If you do not specify and SNS input topic ARN, Ground Truth will\n create a one-time labeling job that stops after all data objects in the input\n manifest file have been labeled.

    \n
    • \n
  • \n

    Use S3DataSource to specify an input manifest file for both\n streaming and one-time labeling jobs. Adding an S3DataSource is\n optional if you use SnsDataSource to create a streaming labeling\n job.

    \n
    • \n
\n

If you use the Amazon Mechanical Turk workforce, your input data should not include\n confidential information, personal information or protected health information. Use\n ContentClassifiers to specify that your data is free of personally\n identifiable information and adult content.

", + "smithy.api#required": {} + } + }, + "OutputConfig": { + "target": "com.amazonaws.sagemaker#LabelingJobOutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The location of the output data and the Amazon Web Services Key Management Service key ID for the key used to encrypt\n the output data, if any.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf\n during data labeling. You must grant this role the necessary permissions so that Amazon SageMaker\n can successfully complete data labeling.

", + "smithy.api#required": {} + } + }, + "LabelCategoryConfigS3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "

The S3 URI of the file, referred to as a label category configuration\n file, that defines the categories used to label the data objects.

\n

For 3D point cloud and video frame task types, you can add label category attributes\n and frame attributes to your label category configuration file. To learn how, see Create a\n Labeling Category Configuration File for 3D Point Cloud Labeling Jobs.

\n

For named entity recognition jobs, in addition to \"labels\", you must\n provide worker instructions in the label category configuration file using the\n \"instructions\" parameter: \"instructions\":\n {\"shortInstruction\":\"

Add header

Add Instructions

\",\n \"fullInstruction\":\"

Add additional instructions.

\"}. For details\n and an example, see Create a\n Named Entity Recognition Labeling Job (API) .

\n

For all other built-in task types and custom\n tasks, your label category configuration file must be a JSON file in the\n following format. Identify the labels you want to use by replacing label_1,\n label_2,...,label_n with your label\n categories.

\n

\n { \n

\n

\n \"document-version\": \"2018-11-28\",\n

\n

\n \"labels\": [{\"label\": \"label_1\"},{\"label\": \"label_2\"},...{\"label\":\n \"label_n\"}]\n

\n

\n }\n

\n

Note the following about the label category configuration file:

\n
    \n
  • \n

    For image classification and text classification (single and multi-label) you\n must specify at least two label categories. For all other task types, the\n minimum number of label categories required is one.

    \n
    • \n
  • \n

    Each label category must be unique, you cannot specify duplicate label\n categories.

    \n
    • \n
  • \n

    If you create a 3D point cloud or video frame adjustment or verification\n labeling job, you must include auditLabelAttributeName in the label\n category configuration. Use this parameter to enter the \n LabelAttributeName\n of the labeling job you want to\n adjust or verify annotations of.

    \n
    • \n
" + } + }, + "StoppingConditions": { + "target": "com.amazonaws.sagemaker#LabelingJobStoppingConditions", + "traits": { + "smithy.api#documentation": "

A set of conditions for stopping the labeling job. If any of the conditions are met,\n the job is automatically stopped. You can use these conditions to control the cost of\n data labeling.

" + } + }, + "LabelingJobAlgorithmsConfig": { + "target": "com.amazonaws.sagemaker#LabelingJobAlgorithmsConfig", + "traits": { + "smithy.api#documentation": "

Configures the information required to perform automated data labeling.

" + } + }, + "HumanTaskConfig": { + "target": "com.amazonaws.sagemaker#HumanTaskConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Configures the labeling task and how it is presented to workers; including, but not limited to price, keywords, and batch size (task count).

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

An array of key/value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management\n User Guide.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateLabelingJobResponse": { + "type": "structure", + "members": { + "LabelingJobArn": { + "target": "com.amazonaws.sagemaker#LabelingJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the labeling job. You use this ARN to identify the\n labeling job.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateMlflowTrackingServer": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateMlflowTrackingServerRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateMlflowTrackingServerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an MLflow Tracking Server using a general purpose Amazon S3 bucket as the artifact\n store. For more information, see Create an MLflow Tracking\n Server.

" + } + }, + "com.amazonaws.sagemaker#CreateMlflowTrackingServerRequest": { + "type": "structure", + "members": { + "TrackingServerName": { + "target": "com.amazonaws.sagemaker#TrackingServerName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A unique string identifying the tracking server name. This string is part of the tracking server\n ARN.

", + "smithy.api#required": {} + } + }, + "ArtifactStoreUri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The S3 URI for a general purpose bucket to use as the MLflow Tracking Server artifact\n store.

", + "smithy.api#required": {} + } + }, + "TrackingServerSize": { + "target": "com.amazonaws.sagemaker#TrackingServerSize", + "traits": { + "smithy.api#documentation": "

The size of the tracking server you want to create. You can choose between\n \"Small\", \"Medium\", and \"Large\". The default MLflow\n Tracking Server configuration size is \"Small\". You can choose a size depending on\n the projected use of the tracking server such as the volume of data logged, number of users,\n and frequency of use.

\n

We recommend using a small tracking server for teams of up to 25 users, a medium tracking\n server for teams of up to 50 users, and a large tracking server for teams of up to 100 users.

" + } + }, + "MlflowVersion": { + "target": "com.amazonaws.sagemaker#MlflowVersion", + "traits": { + "smithy.api#documentation": "

The version of MLflow that the tracking server uses. To see which MLflow versions are\n available to use, see How it works.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for an IAM role in your account that the MLflow Tracking Server uses to\n access the artifact store in Amazon S3. The role should have AmazonS3FullAccess\n permissions. For more information on IAM permissions for tracking server creation, see\n Set up IAM permissions for MLflow.

", + "smithy.api#required": {} + } + }, + "AutomaticModelRegistration": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry. To enable automatic model registration, set this value to True. \n To disable automatic model registration, set this value to False. If not specified, AutomaticModelRegistration defaults to False.

" + } + }, + "WeeklyMaintenanceWindowStart": { + "target": "com.amazonaws.sagemaker#WeeklyMaintenanceWindowStart", + "traits": { + "smithy.api#documentation": "

The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled. For example: TUE:03:30.

" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

Tags consisting of key-value pairs used to manage metadata for the tracking server.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateMlflowTrackingServerResponse": { + "type": "structure", + "members": { + "TrackingServerArn": { + "target": "com.amazonaws.sagemaker#TrackingServerArn", + "traits": { + "smithy.api#documentation": "

The ARN of the tracking server.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateModelInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateModelOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a model in SageMaker. In the request, you name the model and describe a primary\n container. For the primary container, you specify the Docker image that\n contains inference code, artifacts (from prior training), and a custom environment map\n that the inference code uses when you deploy the model for predictions.

\n

Use this API to create a model if you want to use SageMaker hosting services or run a batch\n transform job.

\n

To host your model, you create an endpoint configuration with the\n CreateEndpointConfig API, and then create an endpoint with the\n CreateEndpoint API. SageMaker then deploys all of the containers that you\n defined for the model in the hosting environment.

\n

To run a batch transform using your model, you start a job with the\n CreateTransformJob API. SageMaker uses your model and your dataset to get\n inferences which are then saved to a specified S3 location.

\n

In the request, you also provide an IAM role that SageMaker can assume to access model\n artifacts and docker image for deployment on ML compute hosting instances or for batch\n transform jobs. In addition, you also use the IAM role to manage permissions the\n inference code needs. For example, if the inference code access any other Amazon Web Services resources, you grant necessary permissions via this role.

" + } + }, + "com.amazonaws.sagemaker#CreateModelBiasJobDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateModelBiasJobDefinitionRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateModelBiasJobDefinitionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates the definition for a model bias job.

" + } + }, + "com.amazonaws.sagemaker#CreateModelBiasJobDefinitionRequest": { + "type": "structure", + "members": { + "JobDefinitionName": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the bias job definition. The name must be unique within an Amazon Web Services \n Region in the Amazon Web Services account.

", + "smithy.api#required": {} + } + }, + "ModelBiasBaselineConfig": { + "target": "com.amazonaws.sagemaker#ModelBiasBaselineConfig", + "traits": { + "smithy.api#documentation": "

The baseline configuration for a model bias job.

" + } + }, + "ModelBiasAppSpecification": { + "target": "com.amazonaws.sagemaker#ModelBiasAppSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Configures the model bias job to run a specified Docker container image.

", + "smithy.api#required": {} + } + }, + "ModelBiasJobInput": { + "target": "com.amazonaws.sagemaker#ModelBiasJobInput", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Inputs for the model bias job.

", + "smithy.api#required": {} + } + }, + "ModelBiasJobOutputConfig": { + "target": "com.amazonaws.sagemaker#MonitoringOutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "JobResources": { + "target": "com.amazonaws.sagemaker#MonitoringResources", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "NetworkConfig": { + "target": "com.amazonaws.sagemaker#MonitoringNetworkConfig", + "traits": { + "smithy.api#documentation": "

Networking options for a model bias job.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can \n assume to perform tasks on your behalf.

", + "smithy.api#required": {} + } + }, + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#MonitoringStoppingCondition" + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

(Optional) An array of key-value pairs. For more information, see \n \n Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateModelBiasJobDefinitionResponse": { + "type": "structure", + "members": { + "JobDefinitionArn": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model bias job.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateModelCard": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateModelCardRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateModelCardResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an Amazon SageMaker Model Card.

\n

For information about how to use model cards, see Amazon SageMaker Model Card.

" + } + }, + "com.amazonaws.sagemaker#CreateModelCardExportJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateModelCardExportJobRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateModelCardExportJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an Amazon SageMaker Model Card export job.

" + } + }, + "com.amazonaws.sagemaker#CreateModelCardExportJobRequest": { + "type": "structure", + "members": { + "ModelCardName": { + "target": "com.amazonaws.sagemaker#ModelCardNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the model card to export.

", + "smithy.api#required": {} + } + }, + "ModelCardVersion": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "

The version of the model card to export. If a version is not provided, then the latest version of the model card is exported.

" + } + }, + "ModelCardExportJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the model card export job.

", + "smithy.api#required": {} + } + }, + "OutputConfig": { + "target": "com.amazonaws.sagemaker#ModelCardExportOutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The model card output configuration that specifies the Amazon S3 path for exporting.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateModelCardExportJobResponse": { + "type": "structure", + "members": { + "ModelCardExportJobArn": { + "target": "com.amazonaws.sagemaker#ModelCardExportJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model card export job.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateModelCardRequest": { + "type": "structure", + "members": { + "ModelCardName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The unique name of the model card.

", + "smithy.api#required": {} + } + }, + "SecurityConfig": { + "target": "com.amazonaws.sagemaker#ModelCardSecurityConfig", + "traits": { + "smithy.api#documentation": "

An optional Key Management Service \n key to encrypt, decrypt, and re-encrypt model card content for regulated workloads with\n highly sensitive data.

" + } + }, + "Content": { + "target": "com.amazonaws.sagemaker#ModelCardContent", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The content of the model card. Content must be in model card JSON schema and provided as a string.

", + "smithy.api#required": {} + } + }, + "ModelCardStatus": { + "target": "com.amazonaws.sagemaker#ModelCardStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

\n
    \n
  • \n

    \n Draft: The model card is a work in progress.

    \n
    • \n
  • \n

    \n PendingReview: The model card is pending review.

    \n
    • \n
  • \n

    \n Approved: The model card is approved.

    \n
    • \n
  • \n

    \n Archived: The model card is archived. No more updates should be made to the model\n card, but it can still be exported.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

Key-value pairs used to manage metadata for model cards.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateModelCardResponse": { + "type": "structure", + "members": { + "ModelCardArn": { + "target": "com.amazonaws.sagemaker#ModelCardArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the successfully created model card.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateModelExplainabilityJobDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateModelExplainabilityJobDefinitionRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateModelExplainabilityJobDefinitionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates the definition for a model explainability job.

" + } + }, + "com.amazonaws.sagemaker#CreateModelExplainabilityJobDefinitionRequest": { + "type": "structure", + "members": { + "JobDefinitionName": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the model explainability job definition. The name must be unique within an\n Amazon Web Services Region in the Amazon Web Services account.

", + "smithy.api#required": {} + } + }, + "ModelExplainabilityBaselineConfig": { + "target": "com.amazonaws.sagemaker#ModelExplainabilityBaselineConfig", + "traits": { + "smithy.api#documentation": "

The baseline configuration for a model explainability job.

" + } + }, + "ModelExplainabilityAppSpecification": { + "target": "com.amazonaws.sagemaker#ModelExplainabilityAppSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Configures the model explainability job to run a specified Docker container image.

", + "smithy.api#required": {} + } + }, + "ModelExplainabilityJobInput": { + "target": "com.amazonaws.sagemaker#ModelExplainabilityJobInput", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Inputs for the model explainability job.

", + "smithy.api#required": {} + } + }, + "ModelExplainabilityJobOutputConfig": { + "target": "com.amazonaws.sagemaker#MonitoringOutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "JobResources": { + "target": "com.amazonaws.sagemaker#MonitoringResources", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "NetworkConfig": { + "target": "com.amazonaws.sagemaker#MonitoringNetworkConfig", + "traits": { + "smithy.api#documentation": "

Networking options for a model explainability job.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can \n assume to perform tasks on your behalf.

", + "smithy.api#required": {} + } + }, + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#MonitoringStoppingCondition" + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

(Optional) An array of key-value pairs. For more information, see \n \n Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateModelExplainabilityJobDefinitionResponse": { + "type": "structure", + "members": { + "JobDefinitionArn": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model explainability job.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateModelInput": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.sagemaker#ModelName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the new model.

", + "smithy.api#required": {} + } + }, + "PrimaryContainer": { + "target": "com.amazonaws.sagemaker#ContainerDefinition", + "traits": { + "smithy.api#documentation": "

The location of the primary docker image containing inference code, associated\n artifacts, and custom environment map that the inference code uses when the model is\n deployed for predictions.

" + } + }, + "Containers": { + "target": "com.amazonaws.sagemaker#ContainerDefinitionList", + "traits": { + "smithy.api#documentation": "

Specifies the containers in the inference pipeline.

" + } + }, + "InferenceExecutionConfig": { + "target": "com.amazonaws.sagemaker#InferenceExecutionConfig", + "traits": { + "smithy.api#documentation": "

Specifies details of how containers in a multi-container endpoint are called.

" + } + }, + "ExecutionRoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access model\n artifacts and docker image for deployment on ML compute instances or for batch transform\n jobs. Deploying on ML compute instances is part of model hosting. For more information,\n see SageMaker\n Roles.

\n \n

To be able to pass this role to SageMaker, the caller of this API must have the\n iam:PassRole permission.

\n " + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.

" + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig", + "traits": { + "smithy.api#documentation": "

A VpcConfig object that specifies the VPC that you want your model to connect\n to. Control access to and from your model container by configuring the VPC.\n VpcConfig is used in hosting services and in batch transform. For more\n information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Data in Batch\n Transform Jobs by Using an Amazon Virtual Private Cloud.

" + } + }, + "EnableNetworkIsolation": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

Isolates the model container. No inbound or outbound network calls can be made to or\n from the model container.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateModelOutput": { + "type": "structure", + "members": { + "ModelArn": { + "target": "com.amazonaws.sagemaker#ModelArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the model created in SageMaker.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateModelPackage": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateModelPackageInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateModelPackageOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a model package that you can use to create SageMaker models or list on Amazon Web Services\n Marketplace, or a versioned model that is part of a model group. Buyers can subscribe to\n model packages listed on Amazon Web Services Marketplace to create models in SageMaker.

\n

To create a model package by specifying a Docker container that contains your\n inference code and the Amazon S3 location of your model artifacts, provide values for\n InferenceSpecification. To create a model from an algorithm resource\n that you created or subscribed to in Amazon Web Services Marketplace, provide a value for\n SourceAlgorithmSpecification.

\n \n

There are two types of model packages:

\n
    \n
  • \n

    Versioned - a model that is part of a model group in the model\n registry.

    \n
    • \n
  • \n

    Unversioned - a model package that is not part of a model group.

    \n
    • \n
\n " + } + }, + "com.amazonaws.sagemaker#CreateModelPackageGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateModelPackageGroupInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateModelPackageGroupOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a model group. A model group contains a group of model versions.

" + } + }, + "com.amazonaws.sagemaker#CreateModelPackageGroupInput": { + "type": "structure", + "members": { + "ModelPackageGroupName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the model group.

", + "smithy.api#required": {} + } + }, + "ModelPackageGroupDescription": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "

A description for the model group.

" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

A list of key value pairs associated with the model group. For more information, see\n Tagging Amazon Web Services\n resources in the Amazon Web Services General Reference Guide.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateModelPackageGroupOutput": { + "type": "structure", + "members": { + "ModelPackageGroupArn": { + "target": "com.amazonaws.sagemaker#ModelPackageGroupArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model group.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateModelPackageInput": { + "type": "structure", + "members": { + "ModelPackageName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the model package. The name must have 1 to 63 characters. Valid characters\n are a-z, A-Z, 0-9, and - (hyphen).

\n

This parameter is required for unversioned models. It is not applicable to versioned\n models.

" + } + }, + "ModelPackageGroupName": { + "target": "com.amazonaws.sagemaker#ArnOrName", + "traits": { + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the model package group that this model version belongs to.

\n

This parameter is required for versioned models, and does not apply to unversioned\n models.

" + } + }, + "ModelPackageDescription": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "

A description of the model package.

" + } + }, + "InferenceSpecification": { + "target": "com.amazonaws.sagemaker#InferenceSpecification", + "traits": { + "smithy.api#documentation": "

Specifies details about inference jobs that you can run with models based on this model\n package, including the following information:

\n
    \n
  • \n

    The Amazon ECR paths of containers that contain the inference code and model\n artifacts.

    \n
    • \n
  • \n

    The instance types that the model package supports for transform jobs and\n real-time endpoints used for inference.

    \n
    • \n
  • \n

    The input and output content formats that the model package supports for\n inference.

    \n
    • \n
" + } + }, + "ValidationSpecification": { + "target": "com.amazonaws.sagemaker#ModelPackageValidationSpecification", + "traits": { + "smithy.api#documentation": "

Specifies configurations for one or more transform jobs that SageMaker runs to test the\n model package.

" + } + }, + "SourceAlgorithmSpecification": { + "target": "com.amazonaws.sagemaker#SourceAlgorithmSpecification", + "traits": { + "smithy.api#documentation": "

Details about the algorithm that was used to create the model package.

" + } + }, + "CertifyForMarketplace": { + "target": "com.amazonaws.sagemaker#CertifyForMarketplace", + "traits": { + "smithy.api#documentation": "

Whether to certify the model package for listing on Amazon Web Services Marketplace.

\n

This parameter is optional for unversioned models, and does not apply to versioned\n models.

" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

A list of key value pairs associated with the model. For more information, see Tagging Amazon Web Services\n resources in the Amazon Web Services General Reference Guide.

\n

If you supply ModelPackageGroupName, your model package belongs to the model group\n\t you specify and uses the tags associated with the model group. In this case, you cannot\n\t supply a tag argument.\n

" + } + }, + "ModelApprovalStatus": { + "target": "com.amazonaws.sagemaker#ModelApprovalStatus", + "traits": { + "smithy.api#documentation": "

Whether the model is approved for deployment.

\n

This parameter is optional for versioned models, and does not apply to unversioned\n models.

\n

For versioned models, the value of this parameter must be set to Approved\n to deploy the model.

" + } + }, + "MetadataProperties": { + "target": "com.amazonaws.sagemaker#MetadataProperties" + }, + "ModelMetrics": { + "target": "com.amazonaws.sagemaker#ModelMetrics", + "traits": { + "smithy.api#documentation": "

A structure that contains model metrics reports.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.sagemaker#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique token that guarantees that the call to this API is idempotent.

", + "smithy.api#idempotencyToken": {} + } + }, + "Domain": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The machine learning domain of your model package and its components. Common\n machine learning domains include computer vision and natural language processing.

" + } + }, + "Task": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The machine learning task your model package accomplishes. Common machine\n learning tasks include object detection and image classification. The following\n tasks are supported by Inference Recommender:\n \"IMAGE_CLASSIFICATION\" | \"OBJECT_DETECTION\" | \"TEXT_GENERATION\" |\"IMAGE_SEGMENTATION\" |\n \"FILL_MASK\" | \"CLASSIFICATION\" | \"REGRESSION\" | \"OTHER\".

\n

Specify \"OTHER\" if none of the tasks listed fit your use case.

" + } + }, + "SamplePayloadUrl": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "

The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point\n to a single gzip compressed tar archive (.tar.gz suffix). This archive can hold multiple files\n that are all equally used in the load test. Each file in the archive must satisfy the size constraints of the\n InvokeEndpoint call.

" + } + }, + "CustomerMetadataProperties": { + "target": "com.amazonaws.sagemaker#CustomerMetadataMap", + "traits": { + "smithy.api#documentation": "

The metadata properties associated with the model package versions.

" + } + }, + "DriftCheckBaselines": { + "target": "com.amazonaws.sagemaker#DriftCheckBaselines", + "traits": { + "smithy.api#documentation": "

Represents the drift check baselines that can be used when the model monitor is set using the model package.\n For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.\n

" + } + }, + "AdditionalInferenceSpecifications": { + "target": "com.amazonaws.sagemaker#AdditionalInferenceSpecifications", + "traits": { + "smithy.api#documentation": "

An array of additional Inference Specification objects. Each additional\n Inference Specification specifies artifacts based on this model package that can\n be used on inference endpoints. Generally used with SageMaker Neo to store the\n compiled artifacts.

" + } + }, + "SkipModelValidation": { + "target": "com.amazonaws.sagemaker#SkipModelValidation", + "traits": { + "smithy.api#documentation": "

Indicates if you want to skip model validation.

" + } + }, + "SourceUri": { + "target": "com.amazonaws.sagemaker#ModelPackageSourceUri", + "traits": { + "smithy.api#documentation": "

The URI of the source for the model package. If you want to clone a model package,\n set it to the model package Amazon Resource Name (ARN). If you want to register a model,\n set it to the model ARN.

" + } + }, + "SecurityConfig": { + "target": "com.amazonaws.sagemaker#ModelPackageSecurityConfig", + "traits": { + "smithy.api#documentation": "

The KMS Key ID (KMSKeyId) used for encryption of model package information.

" + } + }, + "ModelCard": { + "target": "com.amazonaws.sagemaker#ModelPackageModelCard", + "traits": { + "smithy.api#documentation": "

The model card associated with the model package. Since ModelPackageModelCard is\n tied to a model package, it is a specific usage of a model card and its schema is\n simplified compared to the schema of ModelCard. The \n ModelPackageModelCard schema does not include model_package_details,\n and model_overview is composed of the model_creator and\n model_artifact properties. For more information about the model package model\n card schema, see Model\n package model card schema. For more information about\n the model card associated with the model package, see View\n the Details of a Model Version.

" + } + }, + "ModelLifeCycle": { + "target": "com.amazonaws.sagemaker#ModelLifeCycle", + "traits": { + "smithy.api#documentation": "

\n A structure describing the current state of the model in its life cycle.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateModelPackageOutput": { + "type": "structure", + "members": { + "ModelPackageArn": { + "target": "com.amazonaws.sagemaker#ModelPackageArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the new model package.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateModelQualityJobDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateModelQualityJobDefinitionRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateModelQualityJobDefinitionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a definition for a job that monitors model quality and drift. For information\n about model monitor, see Amazon SageMaker AI Model\n Monitor.

" + } + }, + "com.amazonaws.sagemaker#CreateModelQualityJobDefinitionRequest": { + "type": "structure", + "members": { + "JobDefinitionName": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the monitoring job definition.

", + "smithy.api#required": {} + } + }, + "ModelQualityBaselineConfig": { + "target": "com.amazonaws.sagemaker#ModelQualityBaselineConfig", + "traits": { + "smithy.api#documentation": "

Specifies the constraints and baselines for the monitoring job.

" + } + }, + "ModelQualityAppSpecification": { + "target": "com.amazonaws.sagemaker#ModelQualityAppSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The container that runs the monitoring job.

", + "smithy.api#required": {} + } + }, + "ModelQualityJobInput": { + "target": "com.amazonaws.sagemaker#ModelQualityJobInput", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A list of the inputs that are monitored. Currently endpoints are supported.

", + "smithy.api#required": {} + } + }, + "ModelQualityJobOutputConfig": { + "target": "com.amazonaws.sagemaker#MonitoringOutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "JobResources": { + "target": "com.amazonaws.sagemaker#MonitoringResources", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "NetworkConfig": { + "target": "com.amazonaws.sagemaker#MonitoringNetworkConfig", + "traits": { + "smithy.api#documentation": "

Specifies the network configuration for the monitoring job.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can \n assume to perform tasks on your behalf.

", + "smithy.api#required": {} + } + }, + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#MonitoringStoppingCondition" + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

(Optional) An array of key-value pairs. For more information, see \n \n Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateModelQualityJobDefinitionResponse": { + "type": "structure", + "members": { + "JobDefinitionArn": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model quality monitoring job.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateMonitoringSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateMonitoringScheduleRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateMonitoringScheduleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a schedule that regularly starts Amazon SageMaker AI Processing Jobs to\n monitor the data captured for an Amazon SageMaker AI Endpoint.

" + } + }, + "com.amazonaws.sagemaker#CreateMonitoringScheduleRequest": { + "type": "structure", + "members": { + "MonitoringScheduleName": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the monitoring schedule. The name must be unique within an Amazon Web Services \n Region within an Amazon Web Services account.

", + "smithy.api#required": {} + } + }, + "MonitoringScheduleConfig": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The configuration object that specifies the monitoring schedule and defines the monitoring \n job.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost\n Management User Guide.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateMonitoringScheduleResponse": { + "type": "structure", + "members": { + "MonitoringScheduleArn": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the monitoring schedule.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateNotebookInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateNotebookInstanceInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateNotebookInstanceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an SageMaker AI notebook instance. A notebook instance is a machine\n learning (ML) compute instance running on a Jupyter notebook.

\n

In a CreateNotebookInstance request, specify the type of ML compute\n instance that you want to run. SageMaker AI launches the instance, installs common\n libraries that you can use to explore datasets for model training, and attaches an ML\n storage volume to the notebook instance.

\n

SageMaker AI also provides a set of example notebooks. Each notebook\n demonstrates how to use SageMaker AI with a specific algorithm or with a machine\n learning framework.

\n

After receiving the request, SageMaker AI does the following:

\n
    \n
  1. \n

    Creates a network interface in the SageMaker AI VPC.

    \n
    2. \n
  2. \n

    (Option) If you specified SubnetId, SageMaker AI creates\n a network interface in your own VPC, which is inferred from the subnet ID that\n you provide in the input. When creating this network interface, SageMaker AI attaches the security group that you specified in the request to the network\n interface that it creates in your VPC.

    \n
    3. \n
  3. \n

    Launches an EC2 instance of the type specified in the request in the\n SageMaker AI VPC. If you specified SubnetId of your VPC,\n SageMaker AI specifies both network interfaces when launching this\n instance. This enables inbound traffic from your own VPC to the notebook\n instance, assuming that the security groups allow it.

    \n
    4. \n
\n

After creating the notebook instance, SageMaker AI returns its Amazon Resource\n Name (ARN). You can't change the name of a notebook instance after you create\n it.

\n

After SageMaker AI creates the notebook instance, you can connect to the\n Jupyter server and work in Jupyter notebooks. For example, you can write code to explore\n a dataset that you can use for model training, train a model, host models by creating\n SageMaker AI endpoints, and validate hosted models.

\n

For more information, see How It Works.

" + } + }, + "com.amazonaws.sagemaker#CreateNotebookInstanceInput": { + "type": "structure", + "members": { + "NotebookInstanceName": { + "target": "com.amazonaws.sagemaker#NotebookInstanceName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the new notebook instance.

", + "smithy.api#required": {} + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#InstanceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of ML compute instance to launch for the notebook instance.

", + "smithy.api#required": {} + } + }, + "SubnetId": { + "target": "com.amazonaws.sagemaker#SubnetId", + "traits": { + "smithy.api#documentation": "

The ID of the subnet in a VPC to which you would like to have a connectivity from\n your ML compute instance.

" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.sagemaker#SecurityGroupIds", + "traits": { + "smithy.api#documentation": "

The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be\n for the same VPC as specified in the subnet.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

When you send any requests to Amazon Web Services resources from the notebook\n instance, SageMaker AI assumes this role to perform tasks on your behalf. You must\n grant this role necessary permissions so SageMaker AI can perform these tasks. The\n policy must allow the SageMaker AI service principal (sagemaker.amazonaws.com)\n permissions to assume this role. For more information, see SageMaker AI Roles.

\n \n

To be able to pass this role to SageMaker AI, the caller of this API must\n have the iam:PassRole permission.

\n ", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that\n SageMaker AI uses to encrypt data on the storage volume attached to your\n notebook instance. The KMS key you provide must be enabled. For information, see Enabling and\n Disabling Keys in the Amazon Web Services Key Management Service\n Developer Guide.

" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.

" + } + }, + "LifecycleConfigName": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigName", + "traits": { + "smithy.api#documentation": "

The name of a lifecycle configuration to associate with the notebook instance. For\n information about lifestyle configurations, see Step 2.1: (Optional)\n Customize a Notebook Instance.

" + } + }, + "DirectInternetAccess": { + "target": "com.amazonaws.sagemaker#DirectInternetAccess", + "traits": { + "smithy.api#documentation": "

Sets whether SageMaker AI provides internet access to the notebook instance. If\n you set this to Disabled this notebook instance is able to access resources\n only in your VPC, and is not be able to connect to SageMaker AI training and\n endpoint services unless you configure a NAT Gateway in your VPC.

\n

For more information, see Notebook Instances Are Internet-Enabled by Default. You can set the value\n of this parameter to Disabled only if you set a value for the\n SubnetId parameter.

" + } + }, + "VolumeSizeInGB": { + "target": "com.amazonaws.sagemaker#NotebookInstanceVolumeSizeInGB", + "traits": { + "smithy.api#documentation": "

The size, in GB, of the ML storage volume to attach to the notebook instance. The\n default value is 5 GB.

" + } + }, + "AcceleratorTypes": { + "target": "com.amazonaws.sagemaker#NotebookInstanceAcceleratorTypes", + "traits": { + "smithy.api#documentation": "

This parameter is no longer supported. Elastic Inference (EI) is no longer\n available.

\n

This parameter was used to specify a list of EI instance types to associate with this\n notebook instance.

" + } + }, + "DefaultCodeRepository": { + "target": "com.amazonaws.sagemaker#CodeRepositoryNameOrUrl", + "traits": { + "smithy.api#documentation": "

A Git repository to associate with the notebook instance as its default code\n repository. This can be either the name of a Git repository stored as a resource in your\n account, or the URL of a Git repository in Amazon Web Services CodeCommit\n or in any other Git repository. When you open a notebook instance, it opens in the\n directory that contains this repository. For more information, see Associating Git\n Repositories with SageMaker AI Notebook Instances.

" + } + }, + "AdditionalCodeRepositories": { + "target": "com.amazonaws.sagemaker#AdditionalCodeRepositoryNamesOrUrls", + "traits": { + "smithy.api#documentation": "

An array of up to three Git repositories to associate with the notebook instance.\n These can be either the names of Git repositories stored as resources in your account,\n or the URL of Git repositories in Amazon Web Services CodeCommit\n or in any other Git repository. These repositories are cloned at the same level as the\n default repository of your notebook instance. For more information, see Associating Git\n Repositories with SageMaker AI Notebook Instances.

" + } + }, + "RootAccess": { + "target": "com.amazonaws.sagemaker#RootAccess", + "traits": { + "smithy.api#documentation": "

Whether root access is enabled or disabled for users of the notebook instance. The\n default value is Enabled.

\n \n

Lifecycle configurations need root access to be able to set up a notebook\n instance. Because of this, lifecycle configurations associated with a notebook\n instance always run with root access even if you disable root access for\n users.

\n " + } + }, + "PlatformIdentifier": { + "target": "com.amazonaws.sagemaker#PlatformIdentifier", + "traits": { + "smithy.api#documentation": "

The platform identifier of the notebook instance runtime environment.

" + } + }, + "InstanceMetadataServiceConfiguration": { + "target": "com.amazonaws.sagemaker#InstanceMetadataServiceConfiguration", + "traits": { + "smithy.api#documentation": "

Information on the IMDS configuration of the notebook instance

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateNotebookInstanceLifecycleConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateNotebookInstanceLifecycleConfigInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateNotebookInstanceLifecycleConfigOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a lifecycle configuration that you can associate with a notebook instance. A\n lifecycle configuration is a collection of shell scripts that\n run when you create or start a notebook instance.

\n

Each lifecycle configuration script has a limit of 16384 characters.

\n

The value of the $PATH environment variable that is available to both\n scripts is /sbin:bin:/usr/sbin:/usr/bin.

\n

View Amazon CloudWatch Logs for notebook instance lifecycle configurations in log\n group /aws/sagemaker/NotebookInstances in log stream\n [notebook-instance-name]/[LifecycleConfigHook].

\n

Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs\n for longer than 5 minutes, it fails and the notebook instance is not created or\n started.

\n

For information about notebook instance lifestyle configurations, see Step\n 2.1: (Optional) Customize a Notebook Instance.

" + } + }, + "com.amazonaws.sagemaker#CreateNotebookInstanceLifecycleConfigInput": { + "type": "structure", + "members": { + "NotebookInstanceLifecycleConfigName": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the lifecycle configuration.

", + "smithy.api#required": {} + } + }, + "OnCreate": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigList", + "traits": { + "smithy.api#documentation": "

A shell script that runs only once, when you create a notebook instance. The shell\n script must be a base64-encoded string.

" + } + }, + "OnStart": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigList", + "traits": { + "smithy.api#documentation": "

A shell script that runs every time you start a notebook instance, including when you\n create the notebook instance. The shell script must be a base64-encoded string.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateNotebookInstanceLifecycleConfigOutput": { + "type": "structure", + "members": { + "NotebookInstanceLifecycleConfigArn": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the lifecycle configuration.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateNotebookInstanceOutput": { + "type": "structure", + "members": { + "NotebookInstanceArn": { + "target": "com.amazonaws.sagemaker#NotebookInstanceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the notebook instance.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateOptimizationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateOptimizationJobRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateOptimizationJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a job that optimizes a model for inference performance. To create the job, you\n provide the location of a source model, and you provide the settings for the optimization\n techniques that you want the job to apply. When the job completes successfully, SageMaker\n uploads the new optimized model to the output destination that you specify.

\n

For more information about how to use this action, and about the supported optimization\n techniques, see Optimize model inference with Amazon SageMaker.

" + } + }, + "com.amazonaws.sagemaker#CreateOptimizationJobRequest": { + "type": "structure", + "members": { + "OptimizationJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A custom name for the new optimization job.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.

\n

During model optimization, Amazon SageMaker AI needs your permission to:

\n
    \n
  • \n

    Read input data from an S3 bucket

    \n
    • \n
  • \n

    Write model artifacts to an S3 bucket

    \n
    • \n
  • \n

    Write logs to Amazon CloudWatch Logs

    \n
    • \n
  • \n

    Publish metrics to Amazon CloudWatch

    \n
    • \n
\n

You grant permissions for all of these tasks to an IAM role. To pass this\n role to Amazon SageMaker AI, the caller of this API must have the\n iam:PassRole permission. For more information, see Amazon SageMaker AI Roles.\n

", + "smithy.api#required": {} + } + }, + "ModelSource": { + "target": "com.amazonaws.sagemaker#OptimizationJobModelSource", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The location of the source model to optimize with an optimization job.

", + "smithy.api#required": {} + } + }, + "DeploymentInstanceType": { + "target": "com.amazonaws.sagemaker#OptimizationJobDeploymentInstanceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of instance that hosts the optimized model that you create with the optimization job.

", + "smithy.api#required": {} + } + }, + "OptimizationEnvironment": { + "target": "com.amazonaws.sagemaker#OptimizationJobEnvironmentVariables", + "traits": { + "smithy.api#documentation": "

The environment variables to set in the model container.

" + } + }, + "OptimizationConfigs": { + "target": "com.amazonaws.sagemaker#OptimizationConfigs", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Settings for each of the optimization techniques that the job applies.

", + "smithy.api#required": {} + } + }, + "OutputConfig": { + "target": "com.amazonaws.sagemaker#OptimizationJobOutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Details for where to store the optimized model that you create with the optimization job.

", + "smithy.api#required": {} + } + }, + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#StoppingCondition", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

A list of key-value pairs associated with the optimization job. For more information,\n see Tagging Amazon Web Services resources in the Amazon Web Services General Reference\n Guide.

" + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#OptimizationVpcConfig", + "traits": { + "smithy.api#documentation": "

A VPC in Amazon VPC that your optimized model has access to.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateOptimizationJobResponse": { + "type": "structure", + "members": { + "OptimizationJobArn": { + "target": "com.amazonaws.sagemaker#OptimizationJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the optimization job.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreatePartnerApp": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreatePartnerAppRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreatePartnerAppResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an Amazon SageMaker Partner AI App.

" + } + }, + "com.amazonaws.sagemaker#CreatePartnerAppPresignedUrl": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreatePartnerAppPresignedUrlRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreatePartnerAppPresignedUrlResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a presigned URL to access an Amazon SageMaker Partner AI App.

" + } + }, + "com.amazonaws.sagemaker#CreatePartnerAppPresignedUrlRequest": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#PartnerAppArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the SageMaker Partner AI App to create the presigned URL for.

", + "smithy.api#required": {} + } + }, + "ExpiresInSeconds": { + "target": "com.amazonaws.sagemaker#ExpiresInSeconds", + "traits": { + "smithy.api#documentation": "

The time that will pass before the presigned URL expires.

" + } + }, + "SessionExpirationDurationInSeconds": { + "target": "com.amazonaws.sagemaker#SessionExpirationDurationInSeconds", + "traits": { + "smithy.api#documentation": "

Indicates how long the Amazon SageMaker Partner AI App session can be accessed for after logging in.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreatePartnerAppPresignedUrlResponse": { + "type": "structure", + "members": { + "Url": { + "target": "com.amazonaws.sagemaker#String2048", + "traits": { + "smithy.api#documentation": "

The presigned URL that you can use to access the SageMaker Partner AI App.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreatePartnerAppRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#PartnerAppName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name to give the SageMaker Partner AI App.

", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.sagemaker#PartnerAppType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of SageMaker Partner AI App to create. Must be one of the following: lakera-guard, comet, deepchecks-llm-evaluation, or fiddler.

", + "smithy.api#required": {} + } + }, + "ExecutionRoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the IAM role that the partner application uses.

", + "smithy.api#required": {} + } + }, + "MaintenanceConfig": { + "target": "com.amazonaws.sagemaker#PartnerAppMaintenanceConfig", + "traits": { + "smithy.api#documentation": "

Maintenance configuration settings for the SageMaker Partner AI App.

" + } + }, + "Tier": { + "target": "com.amazonaws.sagemaker#NonEmptyString64", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Indicates the instance type and size of the cluster attached to the SageMaker Partner AI App.

", + "smithy.api#required": {} + } + }, + "ApplicationConfig": { + "target": "com.amazonaws.sagemaker#PartnerAppConfig", + "traits": { + "smithy.api#documentation": "

Configuration settings for the SageMaker Partner AI App.

" + } + }, + "AuthType": { + "target": "com.amazonaws.sagemaker#PartnerAppAuthType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The authorization type that users use to access the SageMaker Partner AI App.

", + "smithy.api#required": {} + } + }, + "EnableIamSessionBasedIdentity": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

When set to TRUE, the SageMaker Partner AI App sets the Amazon Web Services IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.sagemaker#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique token that guarantees that the call to this API is idempotent.

", + "smithy.api#idempotencyToken": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

Each tag consists of a key and an optional value. Tag keys must be unique per\n resource.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreatePartnerAppResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#PartnerAppArn", + "traits": { + "smithy.api#documentation": "

The ARN of the SageMaker Partner AI App.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreatePipeline": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreatePipelineRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreatePipelineResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a pipeline using a JSON pipeline definition.

" + } + }, + "com.amazonaws.sagemaker#CreatePipelineRequest": { + "type": "structure", + "members": { + "PipelineName": { + "target": "com.amazonaws.sagemaker#PipelineName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the pipeline.

", + "smithy.api#required": {} + } + }, + "PipelineDisplayName": { + "target": "com.amazonaws.sagemaker#PipelineName", + "traits": { + "smithy.api#documentation": "

The display name of the pipeline.

" + } + }, + "PipelineDefinition": { + "target": "com.amazonaws.sagemaker#PipelineDefinition", + "traits": { + "smithy.api#documentation": "

The JSON \n pipeline definition of the pipeline.

" + } + }, + "PipelineDefinitionS3Location": { + "target": "com.amazonaws.sagemaker#PipelineDefinitionS3Location", + "traits": { + "smithy.api#documentation": "

The location of the pipeline definition stored in Amazon S3. If specified, \n SageMaker will retrieve the pipeline definition from this location.

" + } + }, + "PipelineDescription": { + "target": "com.amazonaws.sagemaker#PipelineDescription", + "traits": { + "smithy.api#documentation": "

A description of the pipeline.

" + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.sagemaker#IdempotencyToken", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n operation. An idempotent operation completes no more than one time.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role used by the pipeline to access and create resources.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags to apply to the created pipeline.

" + } + }, + "ParallelismConfiguration": { + "target": "com.amazonaws.sagemaker#ParallelismConfiguration", + "traits": { + "smithy.api#documentation": "

This is the configuration that controls the parallelism of the pipeline. \n If specified, it applies to all runs of this pipeline by default.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreatePipelineResponse": { + "type": "structure", + "members": { + "PipelineArn": { + "target": "com.amazonaws.sagemaker#PipelineArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the created pipeline.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreatePresignedDomainUrl": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreatePresignedDomainUrlRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreatePresignedDomainUrlResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a URL for a specified UserProfile in a Domain. When accessed in a web browser, the\n user will be automatically signed in to the domain, and granted access to all of the Apps and\n files associated with the Domain's Amazon Elastic File System volume. This operation can only be\n called when the authentication mode equals IAM.

\n

The IAM role or user passed to this API defines the permissions to access\n the app. Once the presigned URL is created, no additional permission is required to access\n this URL. IAM authorization policies for this API are also enforced for every\n HTTP request and WebSocket frame that attempts to connect to the app.

\n

You can restrict access to this API and to the URL that it returns to a list of IP\n addresses, Amazon VPCs or Amazon VPC Endpoints that you specify. For more\n information, see Connect to Amazon SageMaker AI\n Studio Through an Interface VPC Endpoint .

\n \n
    \n
  • \n

    The URL that you get from a call to CreatePresignedDomainUrl has a\n default timeout of 5 minutes. You can configure this value using\n ExpiresInSeconds. If you try to use the URL after the timeout limit\n expires, you are directed to the Amazon Web Services console sign-in page.

    \n
    • \n
  • \n

    The JupyterLab session default expiration time is 12 hours. You can configure this\n value using SessionExpirationDurationInSeconds.

    \n
    • \n
\n " + } + }, + "com.amazonaws.sagemaker#CreatePresignedDomainUrlRequest": { + "type": "structure", + "members": { + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The domain ID.

", + "smithy.api#required": {} + } + }, + "UserProfileName": { + "target": "com.amazonaws.sagemaker#UserProfileName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the UserProfile to sign-in as.

", + "smithy.api#required": {} + } + }, + "SessionExpirationDurationInSeconds": { + "target": "com.amazonaws.sagemaker#SessionExpirationDurationInSeconds", + "traits": { + "smithy.api#documentation": "

The session expiration duration in seconds. This value defaults to 43200.

" + } + }, + "ExpiresInSeconds": { + "target": "com.amazonaws.sagemaker#ExpiresInSeconds", + "traits": { + "smithy.api#documentation": "

The number of seconds until the pre-signed URL expires. This value defaults to 300.

" + } + }, + "SpaceName": { + "target": "com.amazonaws.sagemaker#SpaceName", + "traits": { + "smithy.api#documentation": "

The name of the space.

" + } + }, + "LandingUri": { + "target": "com.amazonaws.sagemaker#LandingUri", + "traits": { + "smithy.api#documentation": "

The landing page that the user is directed to when accessing the presigned URL. Using this\n value, users can access Studio or Studio Classic, even if it is not the default experience for\n the domain. The supported values are:

\n
    \n
  • \n

    \n studio::relative/path: Directs users to the relative path in\n Studio.

    \n
    • \n
  • \n

    \n app:JupyterServer:relative/path: Directs users to the relative path in\n the Studio Classic application.

    \n
    • \n
  • \n

    \n app:JupyterLab:relative/path: Directs users to the relative path in the\n JupyterLab application.

    \n
    • \n
  • \n

    \n app:RStudioServerPro:relative/path: Directs users to the relative path in\n the RStudio application.

    \n
    • \n
  • \n

    \n app:CodeEditor:relative/path: Directs users to the relative path in the\n Code Editor, based on Code-OSS, Visual Studio Code - Open Source application.

    \n
    • \n
  • \n

    \n app:Canvas:relative/path: Directs users to the relative path in the\n Canvas application.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreatePresignedDomainUrlResponse": { + "type": "structure", + "members": { + "AuthorizedUrl": { + "target": "com.amazonaws.sagemaker#PresignedDomainUrl", + "traits": { + "smithy.api#documentation": "

The presigned URL.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreatePresignedMlflowTrackingServerUrl": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreatePresignedMlflowTrackingServerUrlRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreatePresignedMlflowTrackingServerUrlResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a presigned URL that you can use to connect to the MLflow UI attached to your\n tracking server. For more information, see Launch the MLflow UI using a presigned URL.

" + } + }, + "com.amazonaws.sagemaker#CreatePresignedMlflowTrackingServerUrlRequest": { + "type": "structure", + "members": { + "TrackingServerName": { + "target": "com.amazonaws.sagemaker#TrackingServerName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the tracking server to connect to your MLflow UI.

", + "smithy.api#required": {} + } + }, + "ExpiresInSeconds": { + "target": "com.amazonaws.sagemaker#ExpiresInSeconds", + "traits": { + "smithy.api#documentation": "

The duration in seconds that your presigned URL is valid. The presigned URL can be used\n only once.

" + } + }, + "SessionExpirationDurationInSeconds": { + "target": "com.amazonaws.sagemaker#SessionExpirationDurationInSeconds", + "traits": { + "smithy.api#documentation": "

The duration in seconds that your MLflow UI session is valid.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreatePresignedMlflowTrackingServerUrlResponse": { + "type": "structure", + "members": { + "AuthorizedUrl": { + "target": "com.amazonaws.sagemaker#TrackingServerUrl", + "traits": { + "smithy.api#documentation": "

A presigned URL with an authorization token.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreatePresignedNotebookInstanceUrl": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreatePresignedNotebookInstanceUrlInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreatePresignedNotebookInstanceUrlOutput" + }, + "traits": { + "smithy.api#documentation": "

Returns a URL that you can use to connect to the Jupyter server from a notebook\n instance. In the SageMaker AI console, when you choose Open next to a\n notebook instance, SageMaker AI opens a new tab showing the Jupyter server home\n page from the notebook instance. The console uses this API to get the URL and show the\n page.

\n

The IAM role or user used to call this API defines the permissions to\n access the notebook instance. Once the presigned URL is created, no additional\n permission is required to access this URL. IAM authorization policies for\n this API are also enforced for every HTTP request and WebSocket frame that attempts to\n connect to the notebook instance.

\n

You can restrict access to this API and to the URL that it returns to a list of IP\n addresses that you specify. Use the NotIpAddress condition operator and the\n aws:SourceIP condition context key to specify the list of IP addresses\n that you want to have access to the notebook instance. For more information, see Limit Access to a Notebook Instance by IP Address.

\n \n

The URL that you get from a call to CreatePresignedNotebookInstanceUrl is valid only for 5 minutes. If you\n try to use the URL after the 5-minute limit expires, you are directed to the Amazon Web Services console sign-in page.

\n " + } + }, + "com.amazonaws.sagemaker#CreatePresignedNotebookInstanceUrlInput": { + "type": "structure", + "members": { + "NotebookInstanceName": { + "target": "com.amazonaws.sagemaker#NotebookInstanceName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the notebook instance.

", + "smithy.api#required": {} + } + }, + "SessionExpirationDurationInSeconds": { + "target": "com.amazonaws.sagemaker#SessionExpirationDurationInSeconds", + "traits": { + "smithy.api#documentation": "

The duration of the session, in seconds. The default is 12 hours.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreatePresignedNotebookInstanceUrlOutput": { + "type": "structure", + "members": { + "AuthorizedUrl": { + "target": "com.amazonaws.sagemaker#NotebookInstanceUrl", + "traits": { + "smithy.api#documentation": "

A JSON object that contains the URL string.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateProcessingJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateProcessingJobRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateProcessingJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a processing job.

" + } + }, + "com.amazonaws.sagemaker#CreateProcessingJobRequest": { + "type": "structure", + "members": { + "ProcessingInputs": { + "target": "com.amazonaws.sagemaker#ProcessingInputs", + "traits": { + "smithy.api#documentation": "

An array of inputs configuring the data to download into the \n processing container.

" + } + }, + "ProcessingOutputConfig": { + "target": "com.amazonaws.sagemaker#ProcessingOutputConfig", + "traits": { + "smithy.api#documentation": "

Output configuration for the processing job.

" + } + }, + "ProcessingJobName": { + "target": "com.amazonaws.sagemaker#ProcessingJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the processing job. The name must be unique within an Amazon Web Services Region in the\n Amazon Web Services account.

", + "smithy.api#required": {} + } + }, + "ProcessingResources": { + "target": "com.amazonaws.sagemaker#ProcessingResources", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Identifies the resources, ML compute instances, and ML storage volumes to deploy for a\n processing job. In distributed training, you specify more than one instance.

", + "smithy.api#required": {} + } + }, + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#ProcessingStoppingCondition", + "traits": { + "smithy.api#documentation": "

The time limit for how long the processing job is allowed to run.

" + } + }, + "AppSpecification": { + "target": "com.amazonaws.sagemaker#AppSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Configures the processing job to run a specified Docker container image.

", + "smithy.api#required": {} + } + }, + "Environment": { + "target": "com.amazonaws.sagemaker#ProcessingEnvironmentMap", + "traits": { + "smithy.api#documentation": "

The environment variables to set in the Docker container. Up to \n 100 key and values entries in the map are supported.

" + } + }, + "NetworkConfig": { + "target": "com.amazonaws.sagemaker#NetworkConfig", + "traits": { + "smithy.api#documentation": "

Networking options for a processing job, such as whether to allow inbound and \n outbound network calls to and from processing containers, and the VPC subnets and \n security groups to use for VPC-enabled processing jobs.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on\n your behalf.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management\n User Guide.

" + } + }, + "ExperimentConfig": { + "target": "com.amazonaws.sagemaker#ExperimentConfig" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateProcessingJobResponse": { + "type": "structure", + "members": { + "ProcessingJobArn": { + "target": "com.amazonaws.sagemaker#ProcessingJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the processing job.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateProject": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateProjectInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateProjectOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a machine learning (ML) project that can contain one or more templates that set\n up an ML pipeline from training to deploying an approved model.

" + } + }, + "com.amazonaws.sagemaker#CreateProjectInput": { + "type": "structure", + "members": { + "ProjectName": { + "target": "com.amazonaws.sagemaker#ProjectEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the project.

", + "smithy.api#required": {} + } + }, + "ProjectDescription": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "

A description for the project.

" + } + }, + "ServiceCatalogProvisioningDetails": { + "target": "com.amazonaws.sagemaker#ServiceCatalogProvisioningDetails", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The product ID and provisioning artifact ID to provision a service catalog. The provisioning \n artifact ID will default to the latest provisioning artifact ID of the product, if you don't \n provide the provisioning artifact ID. For more information, see What is Amazon Web Services Service\n Catalog.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs that you want to use to organize and track your Amazon Web Services\n resource costs. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateProjectOutput": { + "type": "structure", + "members": { + "ProjectArn": { + "target": "com.amazonaws.sagemaker#ProjectArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the project.

", + "smithy.api#required": {} + } + }, + "ProjectId": { + "target": "com.amazonaws.sagemaker#ProjectId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the new project.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateSpace": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateSpaceRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateSpaceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a private space or a space used for real time collaboration in a domain.

" + } + }, + "com.amazonaws.sagemaker#CreateSpaceRequest": { + "type": "structure", + "members": { + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the associated domain.

", + "smithy.api#required": {} + } + }, + "SpaceName": { + "target": "com.amazonaws.sagemaker#SpaceName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the space.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

Tags to associated with the space. Each tag consists of a key and an optional value. Tag\n keys must be unique for each resource. Tags are searchable using the Search\n API.

" + } + }, + "SpaceSettings": { + "target": "com.amazonaws.sagemaker#SpaceSettings", + "traits": { + "smithy.api#documentation": "

A collection of space settings.

" + } + }, + "OwnershipSettings": { + "target": "com.amazonaws.sagemaker#OwnershipSettings", + "traits": { + "smithy.api#documentation": "

A collection of ownership settings.

" + } + }, + "SpaceSharingSettings": { + "target": "com.amazonaws.sagemaker#SpaceSharingSettings", + "traits": { + "smithy.api#documentation": "

A collection of space sharing settings.

" + } + }, + "SpaceDisplayName": { + "target": "com.amazonaws.sagemaker#NonEmptyString64", + "traits": { + "smithy.api#documentation": "

The name of the space that appears in the SageMaker Studio UI.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateSpaceResponse": { + "type": "structure", + "members": { + "SpaceArn": { + "target": "com.amazonaws.sagemaker#SpaceArn", + "traits": { + "smithy.api#documentation": "

The space's Amazon Resource Name (ARN).

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateStudioLifecycleConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateStudioLifecycleConfigRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateStudioLifecycleConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new Amazon SageMaker AI Studio Lifecycle Configuration.

" + } + }, + "com.amazonaws.sagemaker#CreateStudioLifecycleConfigRequest": { + "type": "structure", + "members": { + "StudioLifecycleConfigName": { + "target": "com.amazonaws.sagemaker#StudioLifecycleConfigName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Amazon SageMaker AI Studio Lifecycle Configuration to create.

", + "smithy.api#required": {} + } + }, + "StudioLifecycleConfigContent": { + "target": "com.amazonaws.sagemaker#StudioLifecycleConfigContent", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The content of your Amazon SageMaker AI Studio Lifecycle Configuration script. This\n content must be base64 encoded.

", + "smithy.api#required": {} + } + }, + "StudioLifecycleConfigAppType": { + "target": "com.amazonaws.sagemaker#StudioLifecycleConfigAppType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The App type that the Lifecycle Configuration is attached to.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

Tags to be associated with the Lifecycle Configuration. Each tag consists of a key and an\n optional value. Tag keys must be unique per resource. Tags are searchable using the Search\n API.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateStudioLifecycleConfigResponse": { + "type": "structure", + "members": { + "StudioLifecycleConfigArn": { + "target": "com.amazonaws.sagemaker#StudioLifecycleConfigArn", + "traits": { + "smithy.api#documentation": "

The ARN of your created Lifecycle Configuration.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateTrainingJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateTrainingJobRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateTrainingJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Starts a model training job. After training completes, SageMaker saves the resulting\n model artifacts to an Amazon S3 location that you specify.

\n

If you choose to host your model using SageMaker hosting services, you can use the\n resulting model artifacts as part of the model. You can also use the artifacts in a\n machine learning service other than SageMaker, provided that you know how to use them for\n inference. \n

\n

In the request body, you provide the following:

\n
    \n
  • \n

    \n AlgorithmSpecification - Identifies the training algorithm to\n use.\n

    \n
    • \n
  • \n

    \n HyperParameters - Specify these algorithm-specific parameters to\n enable the estimation of model parameters during training. Hyperparameters can\n be tuned to optimize this learning process. For a list of hyperparameters for\n each training algorithm provided by SageMaker, see Algorithms.

    \n \n

    Do not include any security-sensitive information including account access\n IDs, secrets or tokens in any hyperparameter field. If the use of\n security-sensitive credentials are detected, SageMaker will reject your training\n job request and return an exception error.

    \n     \n
    • \n
  • \n

    \n InputDataConfig - Describes the input required by the training\n job and the Amazon S3, EFS, or FSx location where it is stored.

    \n
    • \n
  • \n

    \n OutputDataConfig - Identifies the Amazon S3 bucket where you want\n SageMaker to save the results of model training.

    \n
    • \n
  • \n

    \n ResourceConfig - Identifies the resources, ML compute\n instances, and ML storage volumes to deploy for model training. In distributed\n training, you specify more than one instance.

    \n
    • \n
  • \n

    \n EnableManagedSpotTraining - Optimize the cost of training machine\n learning models by up to 80% by using Amazon EC2 Spot instances. For more\n information, see Managed Spot\n Training.

    \n
    • \n
  • \n

    \n RoleArn - The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on\n your behalf during model training.\n \n You must grant this role the necessary permissions so that SageMaker can successfully\n complete model training.

    \n
    • \n
  • \n

    \n StoppingCondition - To help cap training costs, use\n MaxRuntimeInSeconds to set a time limit for training. Use\n MaxWaitTimeInSeconds to specify how long a managed spot\n training job has to complete.

    \n
    • \n
  • \n

    \n Environment - The environment variables to set in the Docker\n container.

    \n
    • \n
  • \n

    \n RetryStrategy - The number of times to retry the job when the job\n fails due to an InternalServerError.

    \n
    • \n
\n

For more information about SageMaker, see How It Works.

" + } + }, + "com.amazonaws.sagemaker#CreateTrainingJobRequest": { + "type": "structure", + "members": { + "TrainingJobName": { + "target": "com.amazonaws.sagemaker#TrainingJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the training job. The name must be unique within an Amazon Web Services\n Region in an Amazon Web Services account.

", + "smithy.api#required": {} + } + }, + "HyperParameters": { + "target": "com.amazonaws.sagemaker#HyperParameters", + "traits": { + "smithy.api#documentation": "

Algorithm-specific parameters that influence the quality of the model. You set\n hyperparameters before you start the learning process. For a list of hyperparameters for\n each training algorithm provided by SageMaker, see Algorithms.

\n

You can specify a maximum of 100 hyperparameters. Each hyperparameter is a\n key-value pair. Each key and value is limited to 256 characters, as specified by the\n Length Constraint.

\n \n

Do not include any security-sensitive information including account access IDs,\n secrets or tokens in any hyperparameter field. If the use of security-sensitive\n credentials are detected, SageMaker will reject your training job request and return an\n exception error.

\n " + } + }, + "AlgorithmSpecification": { + "target": "com.amazonaws.sagemaker#AlgorithmSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The registry path of the Docker image that contains the training algorithm and\n algorithm-specific metadata, including the input mode. For more information about\n algorithms provided by SageMaker, see Algorithms. For information about\n providing your own algorithms, see Using Your Own Algorithms with\n Amazon SageMaker.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that SageMaker can assume to perform\n tasks on your behalf.

\n

During model training, SageMaker needs your permission to read input data from an S3\n bucket, download a Docker image that contains training code, write model artifacts to an\n S3 bucket, write logs to Amazon CloudWatch Logs, and publish metrics to Amazon CloudWatch. You grant\n permissions for all of these tasks to an IAM role. For more information, see SageMaker\n Roles.

\n \n

To be able to pass this role to SageMaker, the caller of this API must have the\n iam:PassRole permission.

\n ", + "smithy.api#required": {} + } + }, + "InputDataConfig": { + "target": "com.amazonaws.sagemaker#InputDataConfig", + "traits": { + "smithy.api#documentation": "

An array of Channel objects. Each channel is a named input source.\n InputDataConfig describes the input data and its location.

\n

Algorithms can accept input data from one or more channels. For example, an\n algorithm might have two channels of input data, training_data and\n validation_data. The configuration for each channel provides the S3,\n EFS, or FSx location where the input data is stored. It also provides information about\n the stored data: the MIME type, compression method, and whether the data is wrapped in\n RecordIO format.

\n

Depending on the input mode that the algorithm supports, SageMaker either copies input\n data files from an S3 bucket to a local directory in the Docker container, or makes it\n available as input streams. For example, if you specify an EFS location, input data\n files are available as input streams. They do not need to be downloaded.

\n

Your input must be in the same Amazon Web Services region as your training\n job.

" + } + }, + "OutputDataConfig": { + "target": "com.amazonaws.sagemaker#OutputDataConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies the path to the S3 location where you want to store model artifacts. SageMaker\n creates subfolders for the artifacts.

", + "smithy.api#required": {} + } + }, + "ResourceConfig": { + "target": "com.amazonaws.sagemaker#ResourceConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The resources, including the ML compute instances and ML storage volumes, to use\n for model training.

\n

ML storage volumes store model artifacts and incremental states. Training\n algorithms might also use ML storage volumes for scratch space. If you want SageMaker to use\n the ML storage volume to store the training data, choose File as the\n TrainingInputMode in the algorithm specification. For distributed\n training algorithms, specify an instance count greater than 1.

", + "smithy.api#required": {} + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig", + "traits": { + "smithy.api#documentation": "

A VpcConfig object that specifies the VPC that you want your training job to\n connect to. Control access to and from your training container by configuring the VPC.\n For more information, see Protect Training Jobs by Using an Amazon\n Virtual Private Cloud.

" + } + }, + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#StoppingCondition", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies a limit to how long a model training job can run. It also specifies how long\n a managed Spot training job has to complete. When the job reaches the time limit, SageMaker\n ends the training job. Use this API to cap model training costs.

\n

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays\n job termination for 120 seconds. Algorithms can use this 120-second window to save the\n model artifacts, so the results of training are not lost.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.

" + } + }, + "EnableNetworkIsolation": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

Isolates the training container. No inbound or outbound network calls can be made,\n except for calls between peers within a training cluster for distributed training. If\n you enable network isolation for training jobs that are configured to use a VPC, SageMaker\n downloads and uploads customer data and model artifacts through the specified VPC, but\n the training container does not have network access.

" + } + }, + "EnableInterContainerTrafficEncryption": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

To encrypt all communications between ML compute instances in distributed training,\n choose True. Encryption provides greater security for distributed training,\n but training might take longer. How long it takes depends on the amount of communication\n between compute instances, especially if you use a deep learning algorithm in\n distributed training. For more information, see Protect Communications Between ML\n Compute Instances in a Distributed Training Job.

" + } + }, + "EnableManagedSpotTraining": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

To train models using managed spot training, choose True. Managed spot\n training provides a fully managed and scalable infrastructure for training machine\n learning models. this option is useful when training jobs can be interrupted and when\n there is flexibility when the training job is run.

\n

The complete and intermediate results of jobs are stored in an Amazon S3 bucket, and can be\n used as a starting point to train models incrementally. Amazon SageMaker provides metrics and\n logs in CloudWatch. They can be used to see when managed spot training jobs are running,\n interrupted, resumed, or completed.

" + } + }, + "CheckpointConfig": { + "target": "com.amazonaws.sagemaker#CheckpointConfig", + "traits": { + "smithy.api#documentation": "

Contains information about the output location for managed spot training checkpoint\n data.

" + } + }, + "DebugHookConfig": { + "target": "com.amazonaws.sagemaker#DebugHookConfig" + }, + "DebugRuleConfigurations": { + "target": "com.amazonaws.sagemaker#DebugRuleConfigurations", + "traits": { + "smithy.api#documentation": "

Configuration information for Amazon SageMaker Debugger rules for debugging output tensors.

" + } + }, + "TensorBoardOutputConfig": { + "target": "com.amazonaws.sagemaker#TensorBoardOutputConfig" + }, + "ExperimentConfig": { + "target": "com.amazonaws.sagemaker#ExperimentConfig" + }, + "ProfilerConfig": { + "target": "com.amazonaws.sagemaker#ProfilerConfig" + }, + "ProfilerRuleConfigurations": { + "target": "com.amazonaws.sagemaker#ProfilerRuleConfigurations", + "traits": { + "smithy.api#documentation": "

Configuration information for Amazon SageMaker Debugger rules for profiling system and framework\n metrics.

" + } + }, + "Environment": { + "target": "com.amazonaws.sagemaker#TrainingEnvironmentMap", + "traits": { + "smithy.api#documentation": "

The environment variables to set in the Docker container.

" + } + }, + "RetryStrategy": { + "target": "com.amazonaws.sagemaker#RetryStrategy", + "traits": { + "smithy.api#documentation": "

The number of times to retry the job when the job fails due to an\n InternalServerError.

" + } + }, + "RemoteDebugConfig": { + "target": "com.amazonaws.sagemaker#RemoteDebugConfig", + "traits": { + "smithy.api#documentation": "

Configuration for remote debugging. To learn more about the remote debugging\n functionality of SageMaker, see Access a training container\n through Amazon Web Services Systems Manager (SSM) for remote\n debugging.

" + } + }, + "InfraCheckConfig": { + "target": "com.amazonaws.sagemaker#InfraCheckConfig", + "traits": { + "smithy.api#documentation": "

Contains information about the infrastructure health check configuration for the training job.

" + } + }, + "SessionChainingConfig": { + "target": "com.amazonaws.sagemaker#SessionChainingConfig", + "traits": { + "smithy.api#documentation": "

Contains information about attribute-based access control (ABAC) for the training\n job.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateTrainingJobResponse": { + "type": "structure", + "members": { + "TrainingJobArn": { + "target": "com.amazonaws.sagemaker#TrainingJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the training job.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateTrainingPlan": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateTrainingPlanRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateTrainingPlanResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new training plan in SageMaker to reserve compute capacity.

\n

Amazon SageMaker Training Plan is a capability within SageMaker that allows customers to reserve and manage GPU\n capacity for large-scale AI model training. It provides a way to secure predictable access\n to computational resources within specific timelines and budgets, without the need to\n manage underlying infrastructure.

\n

\n How it works\n

\n

Plans can be created for specific resources such as SageMaker Training Jobs or SageMaker HyperPod\n clusters, automatically provisioning resources, setting up infrastructure, executing\n workloads, and handling infrastructure failures.

\n

\n Plan creation workflow\n

\n
    \n
  • \n

    Users search for available plan offerings based on their requirements (e.g.,\n instance type, count, start time, duration) using the \n SearchTrainingPlanOfferings\n API operation.

    \n
    • \n
  • \n

    They create a plan that best matches their needs using the ID of the plan offering\n they want to use.

    \n
    • \n
  • \n

    After successful upfront payment, the plan's status becomes\n Scheduled.

    \n
    • \n
  • \n

    The plan can be used to:

    \n
      \n
    • \n

      Queue training jobs.

      \n
      • \n
    • \n

      Allocate to an instance group of a SageMaker HyperPod cluster.

      \n
      • \n
    \n
    • \n
  • \n

    When the plan start date arrives, it becomes Active. Based on\n available reserved capacity:

    \n
      \n
    • \n

      Training jobs are launched.

      \n
      • \n
    • \n

      Instance groups are provisioned.

      \n
      • \n
    \n
    • \n
\n

\n Plan composition\n

\n

A plan can consist of one or more Reserved Capacities, each defined by a specific\n instance type, quantity, Availability Zone, duration, and start and end times. For more\n information about Reserved Capacity, see \n ReservedCapacitySummary\n .

" + } + }, + "com.amazonaws.sagemaker#CreateTrainingPlanRequest": { + "type": "structure", + "members": { + "TrainingPlanName": { + "target": "com.amazonaws.sagemaker#TrainingPlanName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the training plan to create.

", + "smithy.api#required": {} + } + }, + "TrainingPlanOfferingId": { + "target": "com.amazonaws.sagemaker#TrainingPlanOfferingId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The unique identifier of the training plan offering to use for creating this\n plan.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs to apply to this training plan.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateTrainingPlanResponse": { + "type": "structure", + "members": { + "TrainingPlanArn": { + "target": "com.amazonaws.sagemaker#TrainingPlanArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN); of the created training plan.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateTransformJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateTransformJobRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateTransformJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Starts a transform job. A transform job uses a trained model to get inferences on a\n dataset and saves these results to an Amazon S3 location that you specify.

\n

To perform batch transformations, you create a transform job and use the data that you\n have readily available.

\n

In the request body, you provide the following:

\n
    \n
  • \n

    \n TransformJobName - Identifies the transform job. The name must be\n unique within an Amazon Web Services Region in an Amazon Web Services account.

    \n
    • \n
  • \n

    \n ModelName - Identifies the model to use. ModelName\n must be the name of an existing Amazon SageMaker model in the same Amazon Web Services Region and Amazon Web Services\n\t\t account. For information on creating a model, see CreateModel.

    \n
    • \n
  • \n

    \n TransformInput - Describes the dataset to be transformed and the\n Amazon S3 location where it is stored.

    \n
    • \n
  • \n

    \n TransformOutput - Identifies the Amazon S3 location where you want\n Amazon SageMaker to save the results from the transform job.

    \n
    • \n
  • \n

    \n TransformResources - Identifies the ML compute instances for the\n transform job.

    \n
    • \n
\n

For more information about how batch transformation works, see Batch\n Transform.

" + } + }, + "com.amazonaws.sagemaker#CreateTransformJobRequest": { + "type": "structure", + "members": { + "TransformJobName": { + "target": "com.amazonaws.sagemaker#TransformJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the transform job. The name must be unique within an Amazon Web Services Region in an\n Amazon Web Services account.

", + "smithy.api#required": {} + } + }, + "ModelName": { + "target": "com.amazonaws.sagemaker#ModelName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the model that you want to use for the transform job.\n ModelName must be the name of an existing Amazon SageMaker model within an Amazon Web Services\n Region in an Amazon Web Services account.

", + "smithy.api#required": {} + } + }, + "MaxConcurrentTransforms": { + "target": "com.amazonaws.sagemaker#MaxConcurrentTransforms", + "traits": { + "smithy.api#documentation": "

The maximum number of parallel requests that can be sent to each instance in a\n transform job. If MaxConcurrentTransforms is set to 0 or left\n unset, Amazon SageMaker checks the optional execution-parameters to determine the settings for your\n chosen algorithm. If the execution-parameters endpoint is not enabled, the default value\n is 1. For more information on execution-parameters, see How Containers Serve Requests. For built-in algorithms, you don't need to\n set a value for MaxConcurrentTransforms.

" + } + }, + "ModelClientConfig": { + "target": "com.amazonaws.sagemaker#ModelClientConfig", + "traits": { + "smithy.api#documentation": "

Configures the timeout and maximum number of retries for processing a transform job\n invocation.

" + } + }, + "MaxPayloadInMB": { + "target": "com.amazonaws.sagemaker#MaxPayloadInMB", + "traits": { + "smithy.api#documentation": "

The maximum allowed size of the payload, in MB. A payload is the\n data portion of a record (without metadata). The value in MaxPayloadInMB\n must be greater than, or equal to, the size of a single record. To estimate the size of\n a record in MB, divide the size of your dataset by the number of records. To ensure that\n the records fit within the maximum payload size, we recommend using a slightly larger\n value. The default value is 6 MB.\n

\n

The value of MaxPayloadInMB cannot be greater than 100 MB. If you specify\n the MaxConcurrentTransforms parameter, the value of\n (MaxConcurrentTransforms * MaxPayloadInMB) also cannot exceed 100\n MB.

\n

For cases where the payload might be arbitrarily large and is transmitted using HTTP\n chunked encoding, set the value to 0.\n This\n feature works only in supported algorithms. Currently, Amazon SageMaker built-in\n algorithms do not support HTTP chunked encoding.

" + } + }, + "BatchStrategy": { + "target": "com.amazonaws.sagemaker#BatchStrategy", + "traits": { + "smithy.api#documentation": "

Specifies the number of records to include in a mini-batch for an HTTP inference\n request. A record\n is a single unit of input data that\n inference can be made on. For example, a single line in a CSV file is a record.

\n

To enable the batch strategy, you must set the SplitType property to\n Line, RecordIO, or TFRecord.

\n

To use only one record when making an HTTP invocation request to a container, set\n BatchStrategy to SingleRecord and SplitType\n to Line.

\n

To fit as many records in a mini-batch as can fit within the\n MaxPayloadInMB limit, set BatchStrategy to\n MultiRecord and SplitType to Line.

" + } + }, + "Environment": { + "target": "com.amazonaws.sagemaker#TransformEnvironmentMap", + "traits": { + "smithy.api#documentation": "

The environment variables to set in the Docker container. Don't include any\n sensitive data in your environment variables. We support up to 16 key and\n values entries in the map.

" + } + }, + "TransformInput": { + "target": "com.amazonaws.sagemaker#TransformInput", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Describes the input source and\n the\n way the transform job consumes it.

", + "smithy.api#required": {} + } + }, + "TransformOutput": { + "target": "com.amazonaws.sagemaker#TransformOutput", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Describes the results of the transform job.

", + "smithy.api#required": {} + } + }, + "DataCaptureConfig": { + "target": "com.amazonaws.sagemaker#BatchDataCaptureConfig", + "traits": { + "smithy.api#documentation": "

Configuration to control how SageMaker captures inference data.

" + } + }, + "TransformResources": { + "target": "com.amazonaws.sagemaker#TransformResources", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Describes the resources, including\n ML\n instance types and ML instance count, to use for the transform\n job.

", + "smithy.api#required": {} + } + }, + "DataProcessing": { + "target": "com.amazonaws.sagemaker#DataProcessing", + "traits": { + "smithy.api#documentation": "

The data structure used to specify the data to be used for inference in a batch\n transform job and to associate the data that is relevant to the prediction results in\n the output. The input filter provided allows you to exclude input data that is not\n needed for inference in a batch transform job. The output filter provided allows you to\n include input data relevant to interpreting the predictions in the output from the job.\n For more information, see Associate Prediction\n Results with their Corresponding Input Records.

" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

(Optional)\n An\n array of key-value pairs. For more information, see Using\n Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User\n Guide.

" + } + }, + "ExperimentConfig": { + "target": "com.amazonaws.sagemaker#ExperimentConfig" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateTransformJobResponse": { + "type": "structure", + "members": { + "TransformJobArn": { + "target": "com.amazonaws.sagemaker#TransformJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the transform job.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateTrial": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateTrialRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateTrialResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an SageMaker trial. A trial is a set of steps called\n trial components that produce a machine learning model. A trial is part\n of a single SageMaker experiment.

\n

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial\n components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you\n must use the logging APIs provided by the SDK.

\n

You can add tags to a trial and then use the Search API to search for\n the tags.

\n

To get a list of all your trials, call the ListTrials API. To view a\n trial's properties, call the DescribeTrial API. To create a trial component,\n call the CreateTrialComponent API.

" + } + }, + "com.amazonaws.sagemaker#CreateTrialComponent": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateTrialComponentRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateTrialComponentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a trial component, which is a stage of a machine learning\n trial. A trial is composed of one or more trial components. A trial\n component can be used in multiple trials.

\n

Trial components include pre-processing jobs, training jobs, and batch transform\n jobs.

\n

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial\n components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you\n must use the logging APIs provided by the SDK.

\n

You can add tags to a trial component and then use the Search API to\n search for the tags.

" + } + }, + "com.amazonaws.sagemaker#CreateTrialComponentRequest": { + "type": "structure", + "members": { + "TrialComponentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the component. The name must be unique in your Amazon Web Services account and is not\n case-sensitive.

", + "smithy.api#required": {} + } + }, + "DisplayName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

The name of the component as displayed. The name doesn't need to be unique. If\n DisplayName isn't specified, TrialComponentName is\n displayed.

" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#TrialComponentStatus", + "traits": { + "smithy.api#documentation": "

The status of the component. States include:

\n
    \n
  • \n

    InProgress

    \n
    • \n
  • \n

    Completed

    \n
    • \n
  • \n

    Failed

    \n
    • \n
" + } + }, + "StartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the component started.

" + } + }, + "EndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the component ended.

" + } + }, + "Parameters": { + "target": "com.amazonaws.sagemaker#TrialComponentParameters", + "traits": { + "smithy.api#documentation": "

The hyperparameters for the component.

" + } + }, + "InputArtifacts": { + "target": "com.amazonaws.sagemaker#TrialComponentArtifacts", + "traits": { + "smithy.api#documentation": "

The input artifacts for the component. Examples of input artifacts are datasets,\n algorithms, hyperparameters, source code, and instance types.

" + } + }, + "OutputArtifacts": { + "target": "com.amazonaws.sagemaker#TrialComponentArtifacts", + "traits": { + "smithy.api#documentation": "

The output artifacts for the component. Examples of output artifacts are metrics,\n snapshots, logs, and images.

" + } + }, + "MetadataProperties": { + "target": "com.amazonaws.sagemaker#MetadataProperties" + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags to associate with the component. You can use Search API\n to search on the tags.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateTrialComponentResponse": { + "type": "structure", + "members": { + "TrialComponentArn": { + "target": "com.amazonaws.sagemaker#TrialComponentArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the trial component.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateTrialRequest": { + "type": "structure", + "members": { + "TrialName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the trial. The name must be unique in your Amazon Web Services account and is not\n case-sensitive.

", + "smithy.api#required": {} + } + }, + "DisplayName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

The name of the trial as displayed. The name doesn't need to be unique. If\n DisplayName isn't specified, TrialName is displayed.

" + } + }, + "ExperimentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the experiment to associate the trial with.

", + "smithy.api#required": {} + } + }, + "MetadataProperties": { + "target": "com.amazonaws.sagemaker#MetadataProperties" + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags to associate with the trial. You can use Search API to\n search on the tags.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateTrialResponse": { + "type": "structure", + "members": { + "TrialArn": { + "target": "com.amazonaws.sagemaker#TrialArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the trial.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateUserProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateUserProfileRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateUserProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a user profile. A user profile represents a single user within a domain, and is\n the main way to reference a \"person\" for the purposes of sharing, reporting, and other\n user-oriented features. This entity is created when a user onboards to a domain. If an\n administrator invites a person by email or imports them from IAM Identity Center, a user\n profile is automatically created. A user profile is the primary holder of settings for an\n individual user and has a reference to the user's private Amazon Elastic File System home\n directory.

" + } + }, + "com.amazonaws.sagemaker#CreateUserProfileRequest": { + "type": "structure", + "members": { + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the associated Domain.

", + "smithy.api#required": {} + } + }, + "UserProfileName": { + "target": "com.amazonaws.sagemaker#UserProfileName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A name for the UserProfile. This value is not case sensitive.

", + "smithy.api#required": {} + } + }, + "SingleSignOnUserIdentifier": { + "target": "com.amazonaws.sagemaker#SingleSignOnUserIdentifier", + "traits": { + "smithy.api#documentation": "

A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only\n supported value is \"UserName\". If the Domain's AuthMode is IAM Identity Center, this field is\n required. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.\n

" + } + }, + "SingleSignOnUserValue": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "

The username of the associated Amazon Web Services Single Sign-On User for this\n UserProfile. If the Domain's AuthMode is IAM Identity Center, this field is required, and must\n match a valid username of a user in your directory. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.

" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

Each tag consists of a key and an optional value. Tag keys must be unique per\n resource.

\n

Tags that you specify for the User Profile are also added to all Apps that the User\n Profile launches.

" + } + }, + "UserSettings": { + "target": "com.amazonaws.sagemaker#UserSettings", + "traits": { + "smithy.api#documentation": "

A collection of settings.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateUserProfileResponse": { + "type": "structure", + "members": { + "UserProfileArn": { + "target": "com.amazonaws.sagemaker#UserProfileArn", + "traits": { + "smithy.api#documentation": "

The user profile Amazon Resource Name (ARN).

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateWorkforce": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateWorkforceRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateWorkforceResponse" + }, + "traits": { + "smithy.api#documentation": "

Use this operation to create a workforce. This operation will return an error\n if a workforce already exists in the Amazon Web Services Region that you specify. You can only\n create one workforce in each Amazon Web Services Region per Amazon Web Services account.

\n

If you want to create a new workforce in an Amazon Web Services Region where \n a workforce already exists, use the DeleteWorkforce API\n operation to delete the existing workforce and then use CreateWorkforce \n to create a new workforce.

\n

To create a private workforce using Amazon Cognito, you must specify a Cognito user pool\n in CognitoConfig.\n You can also create an Amazon Cognito workforce using the Amazon SageMaker console. \n For more information, see \n \n Create a Private Workforce (Amazon Cognito).

\n

To create a private workforce using your own OIDC Identity Provider (IdP), specify your IdP\n configuration in OidcConfig. Your OIDC IdP must support groups\n because groups are used by Ground Truth and Amazon A2I to create work teams. \n For more information, see \n Create a Private Workforce (OIDC IdP).

" + } + }, + "com.amazonaws.sagemaker#CreateWorkforceRequest": { + "type": "structure", + "members": { + "CognitoConfig": { + "target": "com.amazonaws.sagemaker#CognitoConfig", + "traits": { + "smithy.api#documentation": "

Use this parameter to configure an Amazon Cognito private workforce.\n A single Cognito workforce is created using and corresponds to a single\n \n Amazon Cognito user pool.

\n

Do not use OidcConfig if you specify values for \n CognitoConfig.

" + } + }, + "OidcConfig": { + "target": "com.amazonaws.sagemaker#OidcConfig", + "traits": { + "smithy.api#documentation": "

Use this parameter to configure a private workforce using your own OIDC Identity Provider.

\n

Do not use CognitoConfig if you specify values for \n OidcConfig.

" + } + }, + "SourceIpConfig": { + "target": "com.amazonaws.sagemaker#SourceIpConfig" + }, + "WorkforceName": { + "target": "com.amazonaws.sagemaker#WorkforceName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the private workforce.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs that contain metadata to help you categorize and \n organize our workforce. Each tag consists of a key and a value, \n both of which you define.

" + } + }, + "WorkforceVpcConfig": { + "target": "com.amazonaws.sagemaker#WorkforceVpcConfigRequest", + "traits": { + "smithy.api#documentation": "

Use this parameter to configure a workforce using VPC.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateWorkforceResponse": { + "type": "structure", + "members": { + "WorkforceArn": { + "target": "com.amazonaws.sagemaker#WorkforceArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the workforce.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateWorkteam": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateWorkteamRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateWorkteamResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new work team for labeling your data. A work team is defined by one or more\n Amazon Cognito user pools. You must first create the user pools before you can create a work\n team.

\n

You cannot create more than 25 work teams in an account and region.

" + } + }, + "com.amazonaws.sagemaker#CreateWorkteamRequest": { + "type": "structure", + "members": { + "WorkteamName": { + "target": "com.amazonaws.sagemaker#WorkteamName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the work team. Use this name to identify the work team.

", + "smithy.api#required": {} + } + }, + "WorkforceName": { + "target": "com.amazonaws.sagemaker#WorkforceName", + "traits": { + "smithy.api#documentation": "

The name of the workforce.

" + } + }, + "MemberDefinitions": { + "target": "com.amazonaws.sagemaker#MemberDefinitions", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A list of MemberDefinition objects that contains objects that identify\n the workers that make up the work team.

\n

Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For\n private workforces created using Amazon Cognito use CognitoMemberDefinition. For\n workforces created using your own OIDC identity provider (IdP) use\n OidcMemberDefinition. Do not provide input for both of these parameters\n in a single request.

\n

For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito\n user groups within the user pool used to create a workforce. All of the\n CognitoMemberDefinition objects that make up the member definition must\n have the same ClientId and UserPool values. To add a Amazon\n Cognito user group to an existing worker pool, see Adding groups to a User\n Pool. For more information about user pools, see Amazon Cognito User\n Pools.

\n

For workforces created using your own OIDC IdP, specify the user groups that you want to \n include in your private work team in OidcMemberDefinition by listing those groups\n in Groups.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#String200", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A description of the work team.

", + "smithy.api#required": {} + } + }, + "NotificationConfiguration": { + "target": "com.amazonaws.sagemaker#NotificationConfiguration", + "traits": { + "smithy.api#documentation": "

Configures notification of workers regarding available or expiring work items.

" + } + }, + "WorkerAccessConfiguration": { + "target": "com.amazonaws.sagemaker#WorkerAccessConfiguration", + "traits": { + "smithy.api#documentation": "

Use this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys. The Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL.

" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs.

\n

For more information, see Resource\n Tag and Using\n Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User\n Guide.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateWorkteamResponse": { + "type": "structure", + "members": { + "WorkteamArn": { + "target": "com.amazonaws.sagemaker#WorkteamArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the work team. You can use this ARN to identify the\n work team.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreationTime": { + "type": "timestamp" + }, + "com.amazonaws.sagemaker#CrossAccountFilterOption": { + "type": "enum", + "members": { + "SAME_ACCOUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SameAccount" + } + }, + "CROSS_ACCOUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CrossAccount" + } + } + } + }, + "com.amazonaws.sagemaker#CsvContentType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*\\/[a-zA-Z0-9](-*[a-zA-Z0-9.])*$" + } + }, + "com.amazonaws.sagemaker#CsvContentTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#CsvContentType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.sagemaker#CurrencyCode": { + "type": "string" + }, + "com.amazonaws.sagemaker#CustomFileSystem": { + "type": "union", + "members": { + "EFSFileSystem": { + "target": "com.amazonaws.sagemaker#EFSFileSystem", + "traits": { + "smithy.api#documentation": "

A custom file system in Amazon EFS.

" + } + }, + "FSxLustreFileSystem": { + "target": "com.amazonaws.sagemaker#FSxLustreFileSystem", + "traits": { + "smithy.api#documentation": "

A custom file system in Amazon FSx for Lustre.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A file system, created by you, that you assign to a user profile or space for an Amazon SageMaker AI Domain. Permitted users can access this file system in Amazon SageMaker AI\n Studio.

" + } + }, + "com.amazonaws.sagemaker#CustomFileSystemConfig": { + "type": "union", + "members": { + "EFSFileSystemConfig": { + "target": "com.amazonaws.sagemaker#EFSFileSystemConfig", + "traits": { + "smithy.api#documentation": "

The settings for a custom Amazon EFS file system.

" + } + }, + "FSxLustreFileSystemConfig": { + "target": "com.amazonaws.sagemaker#FSxLustreFileSystemConfig", + "traits": { + "smithy.api#documentation": "

The settings for a custom Amazon FSx for Lustre file system.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The settings for assigning a custom file system to a user profile or space for an Amazon SageMaker AI Domain. Permitted users can access this file system in Amazon SageMaker AI\n Studio.

" + } + }, + "com.amazonaws.sagemaker#CustomFileSystemConfigs": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#CustomFileSystemConfig" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.sagemaker#CustomFileSystems": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#CustomFileSystem" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#CustomImage": { + "type": "structure", + "members": { + "ImageName": { + "target": "com.amazonaws.sagemaker#ImageName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the CustomImage. Must be unique to your account.

", + "smithy.api#required": {} + } + }, + "ImageVersionNumber": { + "target": "com.amazonaws.sagemaker#ImageVersionNumber", + "traits": { + "smithy.api#documentation": "

The version number of the CustomImage.

" + } + }, + "AppImageConfigName": { + "target": "com.amazonaws.sagemaker#AppImageConfigName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the AppImageConfig.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A custom SageMaker AI image. For more information, see\n Bring your own SageMaker AI image.

" + } + }, + "com.amazonaws.sagemaker#CustomImageContainerArguments": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#NonEmptyString64" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.sagemaker#CustomImageContainerEntrypoint": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#NonEmptyString256" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.sagemaker#CustomImageContainerEnvironmentVariables": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#NonEmptyString256" + }, + "value": { + "target": "com.amazonaws.sagemaker#String256" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 25 + } + } + }, + "com.amazonaws.sagemaker#CustomImages": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#CustomImage" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.sagemaker#CustomPosixUserConfig": { + "type": "structure", + "members": { + "Uid": { + "target": "com.amazonaws.sagemaker#Uid", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The POSIX user ID.

", + "smithy.api#required": {} + } + }, + "Gid": { + "target": "com.amazonaws.sagemaker#Gid", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The POSIX group ID.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the POSIX identity that is used for file system operations.

" + } + }, + "com.amazonaws.sagemaker#CustomerMetadataKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*)${1,128}$" + } + }, + "com.amazonaws.sagemaker#CustomerMetadataKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#CustomerMetadataKey" + } + }, + "com.amazonaws.sagemaker#CustomerMetadataMap": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#CustomerMetadataKey" + }, + "value": { + "target": "com.amazonaws.sagemaker#CustomerMetadataValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.sagemaker#CustomerMetadataValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*)${1,256}$" + } + }, + "com.amazonaws.sagemaker#CustomizedMetricSpecification": { + "type": "structure", + "members": { + "MetricName": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The name of the customized metric.

" + } + }, + "Namespace": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The namespace of the customized metric.

" + } + }, + "Statistic": { + "target": "com.amazonaws.sagemaker#Statistic", + "traits": { + "smithy.api#documentation": "

The statistic of the customized metric.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A customized metric.

" + } + }, + "com.amazonaws.sagemaker#DataCaptureConfig": { + "type": "structure", + "members": { + "EnableCapture": { + "target": "com.amazonaws.sagemaker#EnableCapture", + "traits": { + "smithy.api#documentation": "

Whether data capture should be enabled or disabled (defaults to enabled).

" + } + }, + "InitialSamplingPercentage": { + "target": "com.amazonaws.sagemaker#SamplingPercentage", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The percentage of requests SageMaker AI will capture. A lower value is recommended\n for Endpoints with high traffic.

", + "smithy.api#required": {} + } + }, + "DestinationS3Uri": { + "target": "com.amazonaws.sagemaker#DestinationS3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon S3 location used to capture the data.

", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Key Management Service key that SageMaker AI\n uses to encrypt the captured data at rest using Amazon S3 server-side\n encryption.

\n

The KmsKeyId can be any of the following formats:

\n
    \n
  • \n

    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Key ARN:\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Alias name: alias/ExampleAlias\n

    \n
    • \n
  • \n

    Alias name ARN:\n arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\n

    \n
    • \n
" + } + }, + "CaptureOptions": { + "target": "com.amazonaws.sagemaker#CaptureOptionList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies data Model Monitor will capture. You can configure whether to collect only\n input, only output, or both

", + "smithy.api#required": {} + } + }, + "CaptureContentTypeHeader": { + "target": "com.amazonaws.sagemaker#CaptureContentTypeHeader", + "traits": { + "smithy.api#documentation": "

Configuration specifying how to treat different headers. If no headers are specified\n SageMaker AI will by default base64 encode when capturing the data.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration to control how SageMaker AI captures inference data.

" + } + }, + "com.amazonaws.sagemaker#DataCaptureConfigSummary": { + "type": "structure", + "members": { + "EnableCapture": { + "target": "com.amazonaws.sagemaker#EnableCapture", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Whether data capture is enabled or disabled.

", + "smithy.api#required": {} + } + }, + "CaptureStatus": { + "target": "com.amazonaws.sagemaker#CaptureStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Whether data capture is currently functional.

", + "smithy.api#required": {} + } + }, + "CurrentSamplingPercentage": { + "target": "com.amazonaws.sagemaker#SamplingPercentage", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The percentage of requests being captured by your Endpoint.

", + "smithy.api#required": {} + } + }, + "DestinationS3Uri": { + "target": "com.amazonaws.sagemaker#DestinationS3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon S3 location being used to capture the data.

", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The KMS key being used to encrypt the data in Amazon S3.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The currently active data capture configuration used by your Endpoint.

" + } + }, + "com.amazonaws.sagemaker#DataCatalogConfig": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.sagemaker#TableName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Glue table.

", + "smithy.api#required": {} + } + }, + "Catalog": { + "target": "com.amazonaws.sagemaker#Catalog", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Glue table catalog.

", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.sagemaker#Database", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Glue table database.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The meta data of the Glue table which serves as data catalog for the\n OfflineStore.

" + } + }, + "com.amazonaws.sagemaker#DataDistributionType": { + "type": "enum", + "members": { + "FULLYREPLICATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FullyReplicated" + } + }, + "SHARDEDBYS3KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ShardedByS3Key" + } + } + } + }, + "com.amazonaws.sagemaker#DataExplorationNotebookLocation": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#DataInputConfig": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16384 + }, + "smithy.api#pattern": "^[\\S\\s]+$" + } + }, + "com.amazonaws.sagemaker#DataProcessing": { + "type": "structure", + "members": { + "InputFilter": { + "target": "com.amazonaws.sagemaker#JsonPath", + "traits": { + "smithy.api#documentation": "

A JSONPath expression used to select a portion of the input data to pass to\n the algorithm. Use the InputFilter parameter to exclude fields, such as an\n ID column, from the input. If you want SageMaker to pass the entire input dataset to the\n algorithm, accept the default value $.

\n

Examples: \"$\", \"$[1:]\", \"$.features\"\n

" + } + }, + "OutputFilter": { + "target": "com.amazonaws.sagemaker#JsonPath", + "traits": { + "smithy.api#documentation": "

A JSONPath expression used to select a portion of the joined dataset to save\n in the output file for a batch transform job. If you want SageMaker to store the entire input\n dataset in the output file, leave the default value, $. If you specify\n indexes that aren't within the dimension size of the joined dataset, you get an\n error.

\n

Examples: \"$\", \"$[0,5:]\",\n \"$['id','SageMakerOutput']\"\n

" + } + }, + "JoinSource": { + "target": "com.amazonaws.sagemaker#JoinSource", + "traits": { + "smithy.api#documentation": "

Specifies the source of the data to join with the transformed data. The valid values\n are None and Input. The default value is None,\n which specifies not to join the input with the transformed data. If you want the batch\n transform job to join the original input data with the transformed data, set\n JoinSource to Input. You can specify\n OutputFilter as an additional filter to select a portion of the joined\n dataset and store it in the output file.

\n

For JSON or JSONLines objects, such as a JSON array, SageMaker adds the transformed data to\n the input JSON object in an attribute called SageMakerOutput. The joined\n result for JSON must be a key-value pair object. If the input is not a key-value pair\n object, SageMaker creates a new JSON file. In the new JSON file, and the input data is stored\n under the SageMakerInput key and the results are stored in\n SageMakerOutput.

\n

For CSV data, SageMaker takes each row as a JSON array and joins the transformed data with\n the input by appending each transformed row to the end of the input. The joined data has\n the original input data followed by the transformed data and the output is a CSV\n file.

\n

For information on how joining in applied, see Workflow for Associating Inferences with Input Records.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The data structure used to specify the data to be used for inference in a batch\n transform job and to associate the data that is relevant to the prediction results in\n the output. The input filter provided allows you to exclude input data that is not\n needed for inference in a batch transform job. The output filter provided allows you to\n include input data relevant to interpreting the predictions in the output from the job.\n For more information, see Associate Prediction\n Results with their Corresponding Input Records.

" + } + }, + "com.amazonaws.sagemaker#DataQualityAppSpecification": { + "type": "structure", + "members": { + "ImageUri": { + "target": "com.amazonaws.sagemaker#ImageUri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The container image that the data quality monitoring job runs.

", + "smithy.api#required": {} + } + }, + "ContainerEntrypoint": { + "target": "com.amazonaws.sagemaker#ContainerEntrypoint", + "traits": { + "smithy.api#documentation": "

The entrypoint for a container used to run a monitoring job.

" + } + }, + "ContainerArguments": { + "target": "com.amazonaws.sagemaker#MonitoringContainerArguments", + "traits": { + "smithy.api#documentation": "

The arguments to send to the container that the monitoring job runs.

" + } + }, + "RecordPreprocessorSourceUri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "

An Amazon S3 URI to a script that is called per row prior to running analysis. It can \n base64 decode the payload and convert it into a flattened JSON so that the built-in container can use \n the converted data. Applicable only for the built-in (first party) containers.

" + } + }, + "PostAnalyticsProcessorSourceUri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "

An Amazon S3 URI to a script that is called after analysis has been performed. Applicable \n only for the built-in (first party) containers.

" + } + }, + "Environment": { + "target": "com.amazonaws.sagemaker#MonitoringEnvironmentMap", + "traits": { + "smithy.api#documentation": "

Sets the environment variables in the container that the monitoring job runs.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the container that a data quality monitoring job runs.

" + } + }, + "com.amazonaws.sagemaker#DataQualityBaselineConfig": { + "type": "structure", + "members": { + "BaseliningJobName": { + "target": "com.amazonaws.sagemaker#ProcessingJobName", + "traits": { + "smithy.api#documentation": "

The name of the job that performs baselining for the data quality monitoring job.

" + } + }, + "ConstraintsResource": { + "target": "com.amazonaws.sagemaker#MonitoringConstraintsResource" + }, + "StatisticsResource": { + "target": "com.amazonaws.sagemaker#MonitoringStatisticsResource" + } + }, + "traits": { + "smithy.api#documentation": "

Configuration for monitoring constraints and monitoring statistics. These baseline resources are \n compared against the results of the current job from the series of jobs scheduled to collect data \n periodically.

" + } + }, + "com.amazonaws.sagemaker#DataQualityJobInput": { + "type": "structure", + "members": { + "EndpointInput": { + "target": "com.amazonaws.sagemaker#EndpointInput" + }, + "BatchTransformInput": { + "target": "com.amazonaws.sagemaker#BatchTransformInput", + "traits": { + "smithy.api#documentation": "

Input object for the batch transform job.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The input for the data quality monitoring job. Currently endpoints are supported for\n input.

" + } + }, + "com.amazonaws.sagemaker#DataSource": { + "type": "structure", + "members": { + "S3DataSource": { + "target": "com.amazonaws.sagemaker#S3DataSource", + "traits": { + "smithy.api#documentation": "

The S3 location of the data source that is associated with a channel.

" + } + }, + "FileSystemDataSource": { + "target": "com.amazonaws.sagemaker#FileSystemDataSource", + "traits": { + "smithy.api#documentation": "

The file system that is associated with a channel.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the location of the channel data.

" + } + }, + "com.amazonaws.sagemaker#DataSourceName": { + "type": "enum", + "members": { + "SalesforceGenie": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SalesforceGenie" + } + }, + "Snowflake": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Snowflake" + } + } + } + }, + "com.amazonaws.sagemaker#Database": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*$" + } + }, + "com.amazonaws.sagemaker#DatasetDefinition": { + "type": "structure", + "members": { + "AthenaDatasetDefinition": { + "target": "com.amazonaws.sagemaker#AthenaDatasetDefinition" + }, + "RedshiftDatasetDefinition": { + "target": "com.amazonaws.sagemaker#RedshiftDatasetDefinition" + }, + "LocalPath": { + "target": "com.amazonaws.sagemaker#ProcessingLocalPath", + "traits": { + "smithy.api#documentation": "

The local path where you want Amazon SageMaker to download the Dataset Definition inputs to run a\n processing job. LocalPath is an absolute path to the input data. This is a required\n parameter when AppManaged is False (default).

" + } + }, + "DataDistributionType": { + "target": "com.amazonaws.sagemaker#DataDistributionType", + "traits": { + "smithy.api#documentation": "

Whether the generated dataset is FullyReplicated or\n ShardedByS3Key (default).

" + } + }, + "InputMode": { + "target": "com.amazonaws.sagemaker#InputMode", + "traits": { + "smithy.api#documentation": "

Whether to use File or Pipe input mode. In File (default) mode,\n Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store\n (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used\n input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your\n algorithm without using the EBS volume.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration for Dataset Definition inputs. The Dataset Definition input must specify\n exactly one of either AthenaDatasetDefinition or RedshiftDatasetDefinition\n types.

" + } + }, + "com.amazonaws.sagemaker#DebugHookConfig": { + "type": "structure", + "members": { + "LocalPath": { + "target": "com.amazonaws.sagemaker#DirectoryPath", + "traits": { + "smithy.api#documentation": "

Path to local storage location for metrics and tensors. Defaults to\n /opt/ml/output/tensors/.

" + } + }, + "S3OutputPath": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Path to Amazon S3 storage location for metrics and tensors.

", + "smithy.api#required": {} + } + }, + "HookParameters": { + "target": "com.amazonaws.sagemaker#HookParameters", + "traits": { + "smithy.api#documentation": "

Configuration information for the Amazon SageMaker Debugger hook parameters.

" + } + }, + "CollectionConfigurations": { + "target": "com.amazonaws.sagemaker#CollectionConfigurations", + "traits": { + "smithy.api#documentation": "

Configuration information for Amazon SageMaker Debugger tensor collections. To learn more about\n how to configure the CollectionConfiguration parameter, \n see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration information for the Amazon SageMaker Debugger hook parameters, metric and tensor collections, and\n storage paths. To learn more about\n how to configure the DebugHookConfig parameter, \n see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

" + } + }, + "com.amazonaws.sagemaker#DebugRuleConfiguration": { + "type": "structure", + "members": { + "RuleConfigurationName": { + "target": "com.amazonaws.sagemaker#RuleConfigurationName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the rule configuration. It must be unique relative to other rule\n configuration names.

", + "smithy.api#required": {} + } + }, + "LocalPath": { + "target": "com.amazonaws.sagemaker#DirectoryPath", + "traits": { + "smithy.api#documentation": "

Path to local storage location for output of rules. Defaults to\n /opt/ml/processing/output/rule/.

" + } + }, + "S3OutputPath": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "

Path to Amazon S3 storage location for rules.

" + } + }, + "RuleEvaluatorImage": { + "target": "com.amazonaws.sagemaker#AlgorithmImage", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Elastic Container (ECR) Image for the managed rule evaluation.

", + "smithy.api#required": {} + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#ProcessingInstanceType", + "traits": { + "smithy.api#documentation": "

The instance type to deploy a custom rule for debugging a training job.

" + } + }, + "VolumeSizeInGB": { + "target": "com.amazonaws.sagemaker#OptionalVolumeSizeInGB", + "traits": { + "smithy.api#documentation": "

The size, in GB, of the ML storage volume attached to the processing instance.

" + } + }, + "RuleParameters": { + "target": "com.amazonaws.sagemaker#RuleParameters", + "traits": { + "smithy.api#documentation": "

Runtime configuration for rule container.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration information for SageMaker Debugger rules for debugging. To learn more about\n how to configure the DebugRuleConfiguration parameter, \n see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

" + } + }, + "com.amazonaws.sagemaker#DebugRuleConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#DebugRuleConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.sagemaker#DebugRuleEvaluationStatus": { + "type": "structure", + "members": { + "RuleConfigurationName": { + "target": "com.amazonaws.sagemaker#RuleConfigurationName", + "traits": { + "smithy.api#documentation": "

The name of the rule configuration.

" + } + }, + "RuleEvaluationJobArn": { + "target": "com.amazonaws.sagemaker#ProcessingJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the rule evaluation job.

" + } + }, + "RuleEvaluationStatus": { + "target": "com.amazonaws.sagemaker#RuleEvaluationStatus", + "traits": { + "smithy.api#documentation": "

Status of the rule evaluation.

" + } + }, + "StatusDetails": { + "target": "com.amazonaws.sagemaker#StatusDetails", + "traits": { + "smithy.api#documentation": "

Details from the rule evaluation.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Timestamp when the rule evaluation status was last modified.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the status of the rule evaluation.

" + } + }, + "com.amazonaws.sagemaker#DebugRuleEvaluationStatuses": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#DebugRuleEvaluationStatus" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.sagemaker#DeepHealthCheckType": { + "type": "enum", + "members": { + "INSTANCE_STRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InstanceStress" + } + }, + "INSTANCE_CONNECTIVITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InstanceConnectivity" + } + } + } + }, + "com.amazonaws.sagemaker#DefaultEbsStorageSettings": { + "type": "structure", + "members": { + "DefaultEbsVolumeSizeInGb": { + "target": "com.amazonaws.sagemaker#SpaceEbsVolumeSizeInGb", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The default size of the EBS storage volume for a space.

", + "smithy.api#required": {} + } + }, + "MaximumEbsVolumeSizeInGb": { + "target": "com.amazonaws.sagemaker#SpaceEbsVolumeSizeInGb", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The maximum size of the EBS storage volume for a space.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A collection of default EBS storage settings that apply to spaces created within a domain or user profile.

" + } + }, + "com.amazonaws.sagemaker#DefaultGid": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 65535 + } + } + }, + "com.amazonaws.sagemaker#DefaultSpaceSettings": { + "type": "structure", + "members": { + "ExecutionRole": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of the execution role for the space.

" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.sagemaker#SecurityGroupIds", + "traits": { + "smithy.api#documentation": "

The security group IDs for the Amazon VPC that the space uses for\n communication.

" + } + }, + "JupyterServerAppSettings": { + "target": "com.amazonaws.sagemaker#JupyterServerAppSettings" + }, + "KernelGatewayAppSettings": { + "target": "com.amazonaws.sagemaker#KernelGatewayAppSettings" + }, + "JupyterLabAppSettings": { + "target": "com.amazonaws.sagemaker#JupyterLabAppSettings" + }, + "SpaceStorageSettings": { + "target": "com.amazonaws.sagemaker#DefaultSpaceStorageSettings" + }, + "CustomPosixUserConfig": { + "target": "com.amazonaws.sagemaker#CustomPosixUserConfig" + }, + "CustomFileSystemConfigs": { + "target": "com.amazonaws.sagemaker#CustomFileSystemConfigs", + "traits": { + "smithy.api#documentation": "

The settings for assigning a custom file system to a domain. Permitted users can access\n this file system in Amazon SageMaker AI Studio.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The default settings for shared spaces that users create in the domain.

\n

SageMaker applies these settings only to shared spaces. It doesn't apply them to private\n spaces.

" + } + }, + "com.amazonaws.sagemaker#DefaultSpaceStorageSettings": { + "type": "structure", + "members": { + "DefaultEbsStorageSettings": { + "target": "com.amazonaws.sagemaker#DefaultEbsStorageSettings", + "traits": { + "smithy.api#documentation": "

The default EBS storage settings for a space.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The default storage settings for a space.

" + } + }, + "com.amazonaws.sagemaker#DefaultUid": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 65535 + } + } + }, + "com.amazonaws.sagemaker#DeleteAction": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteActionRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DeleteActionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an action.

" + } + }, + "com.amazonaws.sagemaker#DeleteActionRequest": { + "type": "structure", + "members": { + "ActionName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the action to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteActionResponse": { + "type": "structure", + "members": { + "ActionArn": { + "target": "com.amazonaws.sagemaker#ActionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the action.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DeleteAlgorithm": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteAlgorithmInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes the specified algorithm from your account.

" + } + }, + "com.amazonaws.sagemaker#DeleteAlgorithmInput": { + "type": "structure", + "members": { + "AlgorithmName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the algorithm to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteApp": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteAppRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Used to stop and delete an app.

" + } + }, + "com.amazonaws.sagemaker#DeleteAppImageConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteAppImageConfigRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an AppImageConfig.

" + } + }, + "com.amazonaws.sagemaker#DeleteAppImageConfigRequest": { + "type": "structure", + "members": { + "AppImageConfigName": { + "target": "com.amazonaws.sagemaker#AppImageConfigName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the AppImageConfig to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteAppRequest": { + "type": "structure", + "members": { + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The domain ID.

", + "smithy.api#required": {} + } + }, + "UserProfileName": { + "target": "com.amazonaws.sagemaker#UserProfileName", + "traits": { + "smithy.api#documentation": "

The user profile name. If this value is not set, then SpaceName must be\n set.

" + } + }, + "SpaceName": { + "target": "com.amazonaws.sagemaker#SpaceName", + "traits": { + "smithy.api#documentation": "

The name of the space. If this value is not set, then UserProfileName must be\n set.

" + } + }, + "AppType": { + "target": "com.amazonaws.sagemaker#AppType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of app.

", + "smithy.api#required": {} + } + }, + "AppName": { + "target": "com.amazonaws.sagemaker#AppName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the app.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteArtifact": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteArtifactRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DeleteArtifactResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an artifact. Either ArtifactArn or Source must be\n specified.

" + } + }, + "com.amazonaws.sagemaker#DeleteArtifactRequest": { + "type": "structure", + "members": { + "ArtifactArn": { + "target": "com.amazonaws.sagemaker#ArtifactArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the artifact to delete.

" + } + }, + "Source": { + "target": "com.amazonaws.sagemaker#ArtifactSource", + "traits": { + "smithy.api#documentation": "

The URI of the source.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteArtifactResponse": { + "type": "structure", + "members": { + "ArtifactArn": { + "target": "com.amazonaws.sagemaker#ArtifactArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the artifact.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DeleteAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteAssociationRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DeleteAssociationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an association.

" + } + }, + "com.amazonaws.sagemaker#DeleteAssociationRequest": { + "type": "structure", + "members": { + "SourceArn": { + "target": "com.amazonaws.sagemaker#AssociationEntityArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the source.

", + "smithy.api#required": {} + } + }, + "DestinationArn": { + "target": "com.amazonaws.sagemaker#AssociationEntityArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the destination.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteAssociationResponse": { + "type": "structure", + "members": { + "SourceArn": { + "target": "com.amazonaws.sagemaker#AssociationEntityArn", + "traits": { + "smithy.api#documentation": "

The ARN of the source.

" + } + }, + "DestinationArn": { + "target": "com.amazonaws.sagemaker#AssociationEntityArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the destination.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DeleteCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteClusterRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DeleteClusterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Delete a SageMaker HyperPod cluster.

" + } + }, + "com.amazonaws.sagemaker#DeleteClusterRequest": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.sagemaker#ClusterNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteClusterResponse": { + "type": "structure", + "members": { + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DeleteClusterSchedulerConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteClusterSchedulerConfigRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the cluster policy of the cluster.

" + } + }, + "com.amazonaws.sagemaker#DeleteClusterSchedulerConfigRequest": { + "type": "structure", + "members": { + "ClusterSchedulerConfigId": { + "target": "com.amazonaws.sagemaker#ClusterSchedulerConfigId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

ID of the cluster policy.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteCodeRepository": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteCodeRepositoryInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified Git repository from your account.

" + } + }, + "com.amazonaws.sagemaker#DeleteCodeRepositoryInput": { + "type": "structure", + "members": { + "CodeRepositoryName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Git repository to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteCompilationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteCompilationJobRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified compilation job. This action deletes only the compilation job\n resource in Amazon SageMaker AI. It doesn't delete other resources that are related to\n that job, such as the model artifacts that the job creates, the compilation logs in\n CloudWatch, the compiled model, or the IAM role.

\n

You can delete a compilation job only if its current status is COMPLETED,\n FAILED, or STOPPED. If the job status is\n STARTING or INPROGRESS, stop the job, and then delete it\n after its status becomes STOPPED.

" + } + }, + "com.amazonaws.sagemaker#DeleteCompilationJobRequest": { + "type": "structure", + "members": { + "CompilationJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the compilation job to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteComputeQuota": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteComputeQuotaRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the compute allocation from the cluster.

" + } + }, + "com.amazonaws.sagemaker#DeleteComputeQuotaRequest": { + "type": "structure", + "members": { + "ComputeQuotaId": { + "target": "com.amazonaws.sagemaker#ComputeQuotaId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

ID of the compute allocation definition.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteContext": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteContextRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DeleteContextResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an context.

" + } + }, + "com.amazonaws.sagemaker#DeleteContextRequest": { + "type": "structure", + "members": { + "ContextName": { + "target": "com.amazonaws.sagemaker#ContextName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the context to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteContextResponse": { + "type": "structure", + "members": { + "ContextArn": { + "target": "com.amazonaws.sagemaker#ContextArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the context.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DeleteDataQualityJobDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteDataQualityJobDefinitionRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a data quality monitoring job definition.

" + } + }, + "com.amazonaws.sagemaker#DeleteDataQualityJobDefinitionRequest": { + "type": "structure", + "members": { + "JobDefinitionName": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the data quality monitoring job definition to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteDeviceFleet": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteDeviceFleetRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a fleet.

" + } + }, + "com.amazonaws.sagemaker#DeleteDeviceFleetRequest": { + "type": "structure", + "members": { + "DeviceFleetName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the fleet to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteDomain": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteDomainRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Used to delete a domain. If you onboarded with IAM mode, you will need to delete your\n domain to onboard again using IAM Identity Center. Use with caution. All of the members of the\n domain will lose access to their EFS volume, including data, notebooks, and other artifacts.\n

" + } + }, + "com.amazonaws.sagemaker#DeleteDomainRequest": { + "type": "structure", + "members": { + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The domain ID.

", + "smithy.api#required": {} + } + }, + "RetentionPolicy": { + "target": "com.amazonaws.sagemaker#RetentionPolicy", + "traits": { + "smithy.api#documentation": "

The retention policy for this domain, which specifies whether resources will be retained\n after the Domain is deleted. By default, all resources are retained (not automatically\n deleted).

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteEdgeDeploymentPlan": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteEdgeDeploymentPlanRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an edge deployment plan if (and only if) all the stages in the plan are\n inactive or there are no stages in the plan.

" + } + }, + "com.amazonaws.sagemaker#DeleteEdgeDeploymentPlanRequest": { + "type": "structure", + "members": { + "EdgeDeploymentPlanName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the edge deployment plan to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteEdgeDeploymentStage": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteEdgeDeploymentStageRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + } + ], + "traits": { + "smithy.api#documentation": "

Delete a stage in an edge deployment plan if (and only if) the stage is\n inactive.

" + } + }, + "com.amazonaws.sagemaker#DeleteEdgeDeploymentStageRequest": { + "type": "structure", + "members": { + "EdgeDeploymentPlanName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the edge deployment plan from which the stage will be deleted.

", + "smithy.api#required": {} + } + }, + "StageName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the stage.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteEndpointInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deletes an endpoint. SageMaker frees up all of the resources that were deployed when the\n endpoint was created.

\n

SageMaker retires any custom KMS key grants associated with the endpoint, meaning you don't\n need to use the RevokeGrant API call.

\n

When you delete your endpoint, SageMaker asynchronously deletes associated endpoint\n resources such as KMS key grants. You might still see these resources in your account\n for a few minutes after deleting your endpoint. Do not delete or revoke the permissions\n for your \n ExecutionRoleArn\n , otherwise SageMaker cannot delete these\n resources.

" + } + }, + "com.amazonaws.sagemaker#DeleteEndpointConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteEndpointConfigInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deletes an endpoint configuration. The DeleteEndpointConfig API\n deletes only the specified configuration. It does not delete endpoints created using the\n configuration.

\n

You must not delete an EndpointConfig in use by an endpoint that is\n live or while the UpdateEndpoint or CreateEndpoint operations\n are being performed on the endpoint. If you delete the EndpointConfig of an\n endpoint that is active or being created or updated you may lose visibility into the\n instance type the endpoint is using. The endpoint must be deleted in order to stop\n incurring charges.

" + } + }, + "com.amazonaws.sagemaker#DeleteEndpointConfigInput": { + "type": "structure", + "members": { + "EndpointConfigName": { + "target": "com.amazonaws.sagemaker#EndpointConfigName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the endpoint configuration that you want to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteEndpointInput": { + "type": "structure", + "members": { + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the endpoint that you want to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteExperiment": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteExperimentRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DeleteExperimentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an SageMaker experiment. All trials associated with the experiment must be deleted\n first. Use the ListTrials API to get a list of the trials associated with\n the experiment.

" + } + }, + "com.amazonaws.sagemaker#DeleteExperimentRequest": { + "type": "structure", + "members": { + "ExperimentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the experiment to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteExperimentResponse": { + "type": "structure", + "members": { + "ExperimentArn": { + "target": "com.amazonaws.sagemaker#ExperimentArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the experiment that is being deleted.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DeleteFeatureGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteFeatureGroupRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Delete the FeatureGroup and any data that was written to the\n OnlineStore of the FeatureGroup. Data cannot be accessed from\n the OnlineStore immediately after DeleteFeatureGroup is called.

\n

Data written into the OfflineStore will not be deleted. The Amazon Web Services Glue database and tables that are automatically created for your\n OfflineStore are not deleted.

\n

Note that it can take approximately 10-15 minutes to delete an OnlineStore\n FeatureGroup with the InMemory\n StorageType.

" + } + }, + "com.amazonaws.sagemaker#DeleteFeatureGroupRequest": { + "type": "structure", + "members": { + "FeatureGroupName": { + "target": "com.amazonaws.sagemaker#FeatureGroupName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the FeatureGroup you want to delete. The name must be unique\n within an Amazon Web Services Region in an Amazon Web Services account.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteFlowDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteFlowDefinitionRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DeleteFlowDefinitionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified flow definition.

" + } + }, + "com.amazonaws.sagemaker#DeleteFlowDefinitionRequest": { + "type": "structure", + "members": { + "FlowDefinitionName": { + "target": "com.amazonaws.sagemaker#FlowDefinitionName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the flow definition you are deleting.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteFlowDefinitionResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DeleteHub": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteHubRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Delete a hub.

" + } + }, + "com.amazonaws.sagemaker#DeleteHubContent": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteHubContentRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Delete the contents of a hub.

" + } + }, + "com.amazonaws.sagemaker#DeleteHubContentReference": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteHubContentReferenceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Delete a hub content reference in order to remove a model from a private hub.

" + } + }, + "com.amazonaws.sagemaker#DeleteHubContentReferenceRequest": { + "type": "structure", + "members": { + "HubName": { + "target": "com.amazonaws.sagemaker#HubNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the hub to delete the hub content reference from.

", + "smithy.api#required": {} + } + }, + "HubContentType": { + "target": "com.amazonaws.sagemaker#HubContentType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of hub content reference to delete. The only supported type of hub content reference to delete is ModelReference.

", + "smithy.api#required": {} + } + }, + "HubContentName": { + "target": "com.amazonaws.sagemaker#HubContentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the hub content to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteHubContentRequest": { + "type": "structure", + "members": { + "HubName": { + "target": "com.amazonaws.sagemaker#HubNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the hub that you want to delete content in.

", + "smithy.api#required": {} + } + }, + "HubContentType": { + "target": "com.amazonaws.sagemaker#HubContentType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of content that you want to delete from a hub.

", + "smithy.api#required": {} + } + }, + "HubContentName": { + "target": "com.amazonaws.sagemaker#HubContentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the content that you want to delete from a hub.

", + "smithy.api#required": {} + } + }, + "HubContentVersion": { + "target": "com.amazonaws.sagemaker#HubContentVersion", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The version of the content that you want to delete from a hub.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteHubRequest": { + "type": "structure", + "members": { + "HubName": { + "target": "com.amazonaws.sagemaker#HubNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the hub to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteHumanTaskUi": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteHumanTaskUiRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DeleteHumanTaskUiResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Use this operation to delete a human task user interface (worker task template).

\n

\n To see a list of human task user interfaces\n (work task templates) in your account, use ListHumanTaskUis.\n When you delete a worker task template, it no longer appears when you call ListHumanTaskUis.

" + } + }, + "com.amazonaws.sagemaker#DeleteHumanTaskUiRequest": { + "type": "structure", + "members": { + "HumanTaskUiName": { + "target": "com.amazonaws.sagemaker#HumanTaskUiName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the human task user interface (work task template) you want to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteHumanTaskUiResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DeleteHyperParameterTuningJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteHyperParameterTuningJobRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deletes a hyperparameter tuning job. The DeleteHyperParameterTuningJob\n API deletes only the tuning job entry that was created in SageMaker when you called the\n CreateHyperParameterTuningJob API. It does not delete training jobs,\n artifacts, or the IAM role that you specified when creating the model.

" + } + }, + "com.amazonaws.sagemaker#DeleteHyperParameterTuningJobRequest": { + "type": "structure", + "members": { + "HyperParameterTuningJobName": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the hyperparameter tuning job that you want to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteImageRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DeleteImageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a SageMaker AI image and all versions of the image. The container images aren't\n deleted.

" + } + }, + "com.amazonaws.sagemaker#DeleteImageRequest": { + "type": "structure", + "members": { + "ImageName": { + "target": "com.amazonaws.sagemaker#ImageName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the image to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteImageResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DeleteImageVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteImageVersionRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DeleteImageVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a version of a SageMaker AI image. The container image the version represents isn't\n deleted.

" + } + }, + "com.amazonaws.sagemaker#DeleteImageVersionRequest": { + "type": "structure", + "members": { + "ImageName": { + "target": "com.amazonaws.sagemaker#ImageName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the image to delete.

", + "smithy.api#required": {} + } + }, + "Version": { + "target": "com.amazonaws.sagemaker#ImageVersionNumber", + "traits": { + "smithy.api#documentation": "

The version to delete.

" + } + }, + "Alias": { + "target": "com.amazonaws.sagemaker#SageMakerImageVersionAlias", + "traits": { + "smithy.api#documentation": "

The alias of the image to delete.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteImageVersionResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DeleteInferenceComponent": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteInferenceComponentInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deletes an inference component.

" + } + }, + "com.amazonaws.sagemaker#DeleteInferenceComponentInput": { + "type": "structure", + "members": { + "InferenceComponentName": { + "target": "com.amazonaws.sagemaker#InferenceComponentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the inference component to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteInferenceExperiment": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteInferenceExperimentRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DeleteInferenceExperimentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an inference experiment.

\n \n

\n This operation does not delete your endpoint, variants, or any underlying resources. This operation only\n deletes the metadata of your experiment.\n

\n " + } + }, + "com.amazonaws.sagemaker#DeleteInferenceExperimentRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#InferenceExperimentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the inference experiment you want to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteInferenceExperimentResponse": { + "type": "structure", + "members": { + "InferenceExperimentArn": { + "target": "com.amazonaws.sagemaker#InferenceExperimentArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the deleted inference experiment.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DeleteMlflowTrackingServer": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteMlflowTrackingServerRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DeleteMlflowTrackingServerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an MLflow Tracking Server. For more information, see Clean up MLflow resources.

" + } + }, + "com.amazonaws.sagemaker#DeleteMlflowTrackingServerRequest": { + "type": "structure", + "members": { + "TrackingServerName": { + "target": "com.amazonaws.sagemaker#TrackingServerName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the the tracking server to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteMlflowTrackingServerResponse": { + "type": "structure", + "members": { + "TrackingServerArn": { + "target": "com.amazonaws.sagemaker#TrackingServerArn", + "traits": { + "smithy.api#documentation": "

A TrackingServerArn object, the ARN of the tracking server that is deleted if\n successfully found.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DeleteModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteModelInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deletes a model. The DeleteModel API deletes only the model entry that\n was created in SageMaker when you called the CreateModel API. It does not delete\n model artifacts, inference code, or the IAM role that you specified when creating the\n model.

" + } + }, + "com.amazonaws.sagemaker#DeleteModelBiasJobDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteModelBiasJobDefinitionRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an Amazon SageMaker AI model bias job definition.

" + } + }, + "com.amazonaws.sagemaker#DeleteModelBiasJobDefinitionRequest": { + "type": "structure", + "members": { + "JobDefinitionName": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the model bias job definition to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteModelCard": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteModelCardRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an Amazon SageMaker Model Card.

" + } + }, + "com.amazonaws.sagemaker#DeleteModelCardRequest": { + "type": "structure", + "members": { + "ModelCardName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the model card to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteModelExplainabilityJobDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteModelExplainabilityJobDefinitionRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an Amazon SageMaker AI model explainability job definition.

" + } + }, + "com.amazonaws.sagemaker#DeleteModelExplainabilityJobDefinitionRequest": { + "type": "structure", + "members": { + "JobDefinitionName": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the model explainability job definition to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteModelInput": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.sagemaker#ModelName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the model to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteModelPackage": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteModelPackageInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a model package.

\n

A model package is used to create SageMaker models or list on Amazon Web Services Marketplace. Buyers can\n subscribe to model packages listed on Amazon Web Services Marketplace to create models in SageMaker.

" + } + }, + "com.amazonaws.sagemaker#DeleteModelPackageGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteModelPackageGroupInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified model group.

" + } + }, + "com.amazonaws.sagemaker#DeleteModelPackageGroupInput": { + "type": "structure", + "members": { + "ModelPackageGroupName": { + "target": "com.amazonaws.sagemaker#ArnOrName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the model group to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteModelPackageGroupPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteModelPackageGroupPolicyInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deletes a model group resource policy.

" + } + }, + "com.amazonaws.sagemaker#DeleteModelPackageGroupPolicyInput": { + "type": "structure", + "members": { + "ModelPackageGroupName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the model group for which to delete the policy.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteModelPackageInput": { + "type": "structure", + "members": { + "ModelPackageName": { + "target": "com.amazonaws.sagemaker#VersionedArnOrName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the model package to delete.

\n

When you specify a name, the name must have 1 to 63 characters. Valid\n characters are a-z, A-Z, 0-9, and - (hyphen).

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteModelQualityJobDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteModelQualityJobDefinitionRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the secified model quality monitoring job definition.

" + } + }, + "com.amazonaws.sagemaker#DeleteModelQualityJobDefinitionRequest": { + "type": "structure", + "members": { + "JobDefinitionName": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the model quality monitoring job definition to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteMonitoringSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteMonitoringScheduleRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a monitoring schedule. Also stops the schedule had not already been stopped.\n This does not delete the job execution history of the monitoring schedule.

" + } + }, + "com.amazonaws.sagemaker#DeleteMonitoringScheduleRequest": { + "type": "structure", + "members": { + "MonitoringScheduleName": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the monitoring schedule to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteNotebookInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteNotebookInstanceInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deletes an SageMaker AI notebook instance. Before you can delete a notebook\n instance, you must call the StopNotebookInstance API.

\n \n

When you delete a notebook instance, you lose all of your data. SageMaker AI removes the ML compute instance, and deletes the ML storage volume and the\n network interface associated with the notebook instance.

\n " + } + }, + "com.amazonaws.sagemaker#DeleteNotebookInstanceInput": { + "type": "structure", + "members": { + "NotebookInstanceName": { + "target": "com.amazonaws.sagemaker#NotebookInstanceName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the SageMaker AI notebook instance to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteNotebookInstanceLifecycleConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteNotebookInstanceLifecycleConfigInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deletes a notebook instance lifecycle configuration.

" + } + }, + "com.amazonaws.sagemaker#DeleteNotebookInstanceLifecycleConfigInput": { + "type": "structure", + "members": { + "NotebookInstanceLifecycleConfigName": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the lifecycle configuration to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteOptimizationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteOptimizationJobRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an optimization job.

" + } + }, + "com.amazonaws.sagemaker#DeleteOptimizationJobRequest": { + "type": "structure", + "members": { + "OptimizationJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name that you assigned to the optimization job.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeletePartnerApp": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeletePartnerAppRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DeletePartnerAppResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a SageMaker Partner AI App.

" + } + }, + "com.amazonaws.sagemaker#DeletePartnerAppRequest": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#PartnerAppArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the SageMaker Partner AI App to delete.

", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.sagemaker#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique token that guarantees that the call to this API is idempotent.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeletePartnerAppResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#PartnerAppArn", + "traits": { + "smithy.api#documentation": "

The ARN of the SageMaker Partner AI App that was deleted.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DeletePipeline": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeletePipelineRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DeletePipelineResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a pipeline if there are no running instances of the pipeline. To delete a\n pipeline, you must stop all running instances of the pipeline using the\n StopPipelineExecution API. When you delete a pipeline, all instances of the\n pipeline are deleted.

" + } + }, + "com.amazonaws.sagemaker#DeletePipelineRequest": { + "type": "structure", + "members": { + "PipelineName": { + "target": "com.amazonaws.sagemaker#PipelineName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the pipeline to delete.

", + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.sagemaker#IdempotencyToken", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n operation. An idempotent operation completes no more than one time.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeletePipelineResponse": { + "type": "structure", + "members": { + "PipelineArn": { + "target": "com.amazonaws.sagemaker#PipelineArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the pipeline to delete.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DeleteProject": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteProjectInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + } + ], + "traits": { + "smithy.api#documentation": "

Delete the specified project.

" + } + }, + "com.amazonaws.sagemaker#DeleteProjectInput": { + "type": "structure", + "members": { + "ProjectName": { + "target": "com.amazonaws.sagemaker#ProjectEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the project to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteSpace": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteSpaceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Used to delete a space.

" + } + }, + "com.amazonaws.sagemaker#DeleteSpaceRequest": { + "type": "structure", + "members": { + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the associated domain.

", + "smithy.api#required": {} + } + }, + "SpaceName": { + "target": "com.amazonaws.sagemaker#SpaceName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the space.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteStudioLifecycleConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteStudioLifecycleConfigRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the Amazon SageMaker AI Studio Lifecycle Configuration. In order to delete the\n Lifecycle Configuration, there must be no running apps using the Lifecycle Configuration. You\n must also remove the Lifecycle Configuration from UserSettings in all Domains and\n UserProfiles.

" + } + }, + "com.amazonaws.sagemaker#DeleteStudioLifecycleConfigRequest": { + "type": "structure", + "members": { + "StudioLifecycleConfigName": { + "target": "com.amazonaws.sagemaker#StudioLifecycleConfigName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Amazon SageMaker AI Studio Lifecycle Configuration to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteTagsInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#DeleteTagsOutput" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified tags from an SageMaker resource.

\n

To list a resource's tags, use the ListTags API.

\n \n

When you call this API to delete tags from a hyperparameter tuning job, the\n deleted tags are not removed from training jobs that the hyperparameter tuning job\n launched before you called this API.

\n \n \n

When you call this API to delete tags from a SageMaker Domain or User Profile, the\n deleted tags are not removed from Apps that the SageMaker Domain or User Profile\n launched before you called this API.

\n " + } + }, + "com.amazonaws.sagemaker#DeleteTagsInput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.sagemaker#ResourceArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource whose tags you want to\n delete.

", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.sagemaker#TagKeyList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An array or one or more tag keys to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteTagsOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DeleteTrial": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteTrialRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DeleteTrialResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified trial. All trial components that make up the trial must be deleted\n first. Use the DescribeTrialComponent API to get the list of trial\n components.

" + } + }, + "com.amazonaws.sagemaker#DeleteTrialComponent": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteTrialComponentRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DeleteTrialComponentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified trial component. A trial component must be disassociated from all\n trials before the trial component can be deleted. To disassociate a trial component from a\n trial, call the DisassociateTrialComponent API.

" + } + }, + "com.amazonaws.sagemaker#DeleteTrialComponentRequest": { + "type": "structure", + "members": { + "TrialComponentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the component to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteTrialComponentResponse": { + "type": "structure", + "members": { + "TrialComponentArn": { + "target": "com.amazonaws.sagemaker#TrialComponentArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component is being deleted.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DeleteTrialRequest": { + "type": "structure", + "members": { + "TrialName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the trial to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteTrialResponse": { + "type": "structure", + "members": { + "TrialArn": { + "target": "com.amazonaws.sagemaker#TrialArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the trial that is being deleted.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DeleteUserProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteUserProfileRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a user profile. When a user profile is deleted, the user loses access to their EFS\n volume, including data, notebooks, and other artifacts.

" + } + }, + "com.amazonaws.sagemaker#DeleteUserProfileRequest": { + "type": "structure", + "members": { + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The domain ID.

", + "smithy.api#required": {} + } + }, + "UserProfileName": { + "target": "com.amazonaws.sagemaker#UserProfileName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The user profile name.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteWorkforce": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteWorkforceRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DeleteWorkforceResponse" + }, + "traits": { + "smithy.api#documentation": "

Use this operation to delete a workforce.

\n

If you want to create a new workforce in an Amazon Web Services Region where\n a workforce already exists, use this operation to delete the \n existing workforce and then use CreateWorkforce\n to create a new workforce.

\n \n

If a private workforce contains one or more work teams, you must use \n the DeleteWorkteam\n operation to delete all work teams before you delete the workforce.\n If you try to delete a workforce that contains one or more work teams,\n you will receive a ResourceInUse error.

\n " + } + }, + "com.amazonaws.sagemaker#DeleteWorkforceRequest": { + "type": "structure", + "members": { + "WorkforceName": { + "target": "com.amazonaws.sagemaker#WorkforceName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the workforce.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteWorkforceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DeleteWorkteam": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteWorkteamRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DeleteWorkteamResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an existing work team. This operation can't be undone.

" + } + }, + "com.amazonaws.sagemaker#DeleteWorkteamRequest": { + "type": "structure", + "members": { + "WorkteamName": { + "target": "com.amazonaws.sagemaker#WorkteamName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the work team to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteWorkteamResponse": { + "type": "structure", + "members": { + "Success": { + "target": "com.amazonaws.sagemaker#Success", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Returns true if the work team was successfully deleted; otherwise,\n returns false.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DependencyCopyPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1023 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#DependencyOriginPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1023 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#DeployedImage": { + "type": "structure", + "members": { + "SpecifiedImage": { + "target": "com.amazonaws.sagemaker#ContainerImage", + "traits": { + "smithy.api#documentation": "

The image path you specified when you created the model.

" + } + }, + "ResolvedImage": { + "target": "com.amazonaws.sagemaker#ContainerImage", + "traits": { + "smithy.api#documentation": "

The specific digest path of the image hosted in this\n ProductionVariant.

" + } + }, + "ResolutionTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time when the image path for the model resolved to the\n ResolvedImage\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Gets the Amazon EC2 Container Registry path of the docker image of the model that is hosted in this ProductionVariant.

\n

If you used the registry/repository[:tag] form to specify the image path\n of the primary container when you created the model hosted in this\n ProductionVariant, the path resolves to a path of the form\n registry/repository[@digest]. A digest is a hash value that identifies\n a specific version of an image. For information about Amazon ECR paths, see Pulling an Image in the Amazon ECR User Guide.

" + } + }, + "com.amazonaws.sagemaker#DeployedImages": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#DeployedImage" + } + }, + "com.amazonaws.sagemaker#DeploymentConfig": { + "type": "structure", + "members": { + "BlueGreenUpdatePolicy": { + "target": "com.amazonaws.sagemaker#BlueGreenUpdatePolicy", + "traits": { + "smithy.api#documentation": "

Update policy for a blue/green deployment. If this update policy is specified, SageMaker\n creates a new fleet during the deployment while maintaining the old fleet. SageMaker flips\n traffic to the new fleet according to the specified traffic routing configuration. Only\n one update policy should be used in the deployment configuration. If no update policy is\n specified, SageMaker uses a blue/green deployment strategy with all at once traffic shifting\n by default.

" + } + }, + "RollingUpdatePolicy": { + "target": "com.amazonaws.sagemaker#RollingUpdatePolicy", + "traits": { + "smithy.api#documentation": "

Specifies a rolling deployment strategy for updating a SageMaker endpoint.

" + } + }, + "AutoRollbackConfiguration": { + "target": "com.amazonaws.sagemaker#AutoRollbackConfig", + "traits": { + "smithy.api#documentation": "

Automatic rollback configuration for handling endpoint deployment failures and\n recovery.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The deployment configuration for an endpoint, which contains the desired deployment\n strategy and rollback configurations.

" + } + }, + "com.amazonaws.sagemaker#DeploymentRecommendation": { + "type": "structure", + "members": { + "RecommendationStatus": { + "target": "com.amazonaws.sagemaker#RecommendationStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Status of the deployment recommendation. The status NOT_APPLICABLE means that SageMaker\n is unable to provide a default recommendation for the model using the information provided. If the deployment status is IN_PROGRESS,\n retry your API call after a few seconds to get a COMPLETED deployment recommendation.

", + "smithy.api#required": {} + } + }, + "RealTimeInferenceRecommendations": { + "target": "com.amazonaws.sagemaker#RealTimeInferenceRecommendations", + "traits": { + "smithy.api#documentation": "

A list of RealTimeInferenceRecommendation items.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A set of recommended deployment configurations for the model. To get more advanced recommendations, see\n CreateInferenceRecommendationsJob\n to create an inference recommendation job.

" + } + }, + "com.amazonaws.sagemaker#DeploymentStage": { + "type": "structure", + "members": { + "StageName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the stage.

", + "smithy.api#required": {} + } + }, + "DeviceSelectionConfig": { + "target": "com.amazonaws.sagemaker#DeviceSelectionConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Configuration of the devices in the stage.

", + "smithy.api#required": {} + } + }, + "DeploymentConfig": { + "target": "com.amazonaws.sagemaker#EdgeDeploymentConfig", + "traits": { + "smithy.api#documentation": "

Configuration of the deployment details.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a stage in an edge deployment plan.

" + } + }, + "com.amazonaws.sagemaker#DeploymentStageMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "max": 10 + } + } + }, + "com.amazonaws.sagemaker#DeploymentStageStatusSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#DeploymentStageStatusSummary" + } + }, + "com.amazonaws.sagemaker#DeploymentStageStatusSummary": { + "type": "structure", + "members": { + "StageName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the stage.

", + "smithy.api#required": {} + } + }, + "DeviceSelectionConfig": { + "target": "com.amazonaws.sagemaker#DeviceSelectionConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Configuration of the devices in the stage.

", + "smithy.api#required": {} + } + }, + "DeploymentConfig": { + "target": "com.amazonaws.sagemaker#EdgeDeploymentConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Configuration of the deployment details.

", + "smithy.api#required": {} + } + }, + "DeploymentStatus": { + "target": "com.amazonaws.sagemaker#EdgeDeploymentStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

General status of the current state.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information summarizing the deployment stage results.

" + } + }, + "com.amazonaws.sagemaker#DeploymentStages": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#DeploymentStage" + } + }, + "com.amazonaws.sagemaker#DeregisterDevices": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeregisterDevicesRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deregisters the specified devices. After you deregister a device, you will need to re-register the devices.

" + } + }, + "com.amazonaws.sagemaker#DeregisterDevicesRequest": { + "type": "structure", + "members": { + "DeviceFleetName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the fleet the devices belong to.

", + "smithy.api#required": {} + } + }, + "DeviceNames": { + "target": "com.amazonaws.sagemaker#DeviceNames", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The unique IDs of the devices.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DerivedInformation": { + "type": "structure", + "members": { + "DerivedDataInputConfig": { + "target": "com.amazonaws.sagemaker#DataInputConfig", + "traits": { + "smithy.api#documentation": "

The data input configuration that SageMaker Neo automatically derived for the model.\n When SageMaker Neo derives this information, you don't need to specify the data input\n configuration when you create a compilation job.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information that SageMaker Neo automatically derived about the model.

" + } + }, + "com.amazonaws.sagemaker#DescribeAction": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeActionRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeActionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Describes an action.

" + } + }, + "com.amazonaws.sagemaker#DescribeActionRequest": { + "type": "structure", + "members": { + "ActionName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the action to describe.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeActionResponse": { + "type": "structure", + "members": { + "ActionName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityNameOrArn", + "traits": { + "smithy.api#documentation": "

The name of the action.

" + } + }, + "ActionArn": { + "target": "com.amazonaws.sagemaker#ActionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the action.

" + } + }, + "Source": { + "target": "com.amazonaws.sagemaker#ActionSource", + "traits": { + "smithy.api#documentation": "

The source of the action.

" + } + }, + "ActionType": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "

The type of the action.

" + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#ExperimentDescription", + "traits": { + "smithy.api#documentation": "

The description of the action.

" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#ActionStatus", + "traits": { + "smithy.api#documentation": "

The status of the action.

" + } + }, + "Properties": { + "target": "com.amazonaws.sagemaker#LineageEntityParameters", + "traits": { + "smithy.api#documentation": "

A list of the action's properties.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the action was created.

" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the action was last modified.

" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "MetadataProperties": { + "target": "com.amazonaws.sagemaker#MetadataProperties" + }, + "LineageGroupArn": { + "target": "com.amazonaws.sagemaker#LineageGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the lineage group.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeAlgorithm": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeAlgorithmInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeAlgorithmOutput" + }, + "traits": { + "smithy.api#documentation": "

Returns a description of the specified algorithm that is in your account.

" + } + }, + "com.amazonaws.sagemaker#DescribeAlgorithmInput": { + "type": "structure", + "members": { + "AlgorithmName": { + "target": "com.amazonaws.sagemaker#ArnOrName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the algorithm to describe.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeAlgorithmOutput": { + "type": "structure", + "members": { + "AlgorithmName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the algorithm being described.

", + "smithy.api#required": {} + } + }, + "AlgorithmArn": { + "target": "com.amazonaws.sagemaker#AlgorithmArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the algorithm.

", + "smithy.api#required": {} + } + }, + "AlgorithmDescription": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "

A brief summary about the algorithm.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A timestamp specifying when the algorithm was created.

", + "smithy.api#required": {} + } + }, + "TrainingSpecification": { + "target": "com.amazonaws.sagemaker#TrainingSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Details about training jobs run by this algorithm.

", + "smithy.api#required": {} + } + }, + "InferenceSpecification": { + "target": "com.amazonaws.sagemaker#InferenceSpecification", + "traits": { + "smithy.api#documentation": "

Details about inference jobs that the algorithm runs.

" + } + }, + "ValidationSpecification": { + "target": "com.amazonaws.sagemaker#AlgorithmValidationSpecification", + "traits": { + "smithy.api#documentation": "

Details about configurations for one or more training jobs that SageMaker runs to test the\n algorithm.

" + } + }, + "AlgorithmStatus": { + "target": "com.amazonaws.sagemaker#AlgorithmStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The current status of the algorithm.

", + "smithy.api#required": {} + } + }, + "AlgorithmStatusDetails": { + "target": "com.amazonaws.sagemaker#AlgorithmStatusDetails", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Details about the current status of the algorithm.

", + "smithy.api#required": {} + } + }, + "ProductId": { + "target": "com.amazonaws.sagemaker#ProductId", + "traits": { + "smithy.api#documentation": "

The product identifier of the algorithm.

" + } + }, + "CertifyForMarketplace": { + "target": "com.amazonaws.sagemaker#CertifyForMarketplace", + "traits": { + "smithy.api#documentation": "

Whether the algorithm is certified to be listed in Amazon Web Services\n Marketplace.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeApp": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeAppRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeAppResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the app.

" + } + }, + "com.amazonaws.sagemaker#DescribeAppImageConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeAppImageConfigRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeAppImageConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Describes an AppImageConfig.

" + } + }, + "com.amazonaws.sagemaker#DescribeAppImageConfigRequest": { + "type": "structure", + "members": { + "AppImageConfigName": { + "target": "com.amazonaws.sagemaker#AppImageConfigName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the AppImageConfig to describe.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeAppImageConfigResponse": { + "type": "structure", + "members": { + "AppImageConfigArn": { + "target": "com.amazonaws.sagemaker#AppImageConfigArn", + "traits": { + "smithy.api#documentation": "

The ARN of the AppImageConfig.

" + } + }, + "AppImageConfigName": { + "target": "com.amazonaws.sagemaker#AppImageConfigName", + "traits": { + "smithy.api#documentation": "

The name of the AppImageConfig.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the AppImageConfig was created.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the AppImageConfig was last modified.

" + } + }, + "KernelGatewayImageConfig": { + "target": "com.amazonaws.sagemaker#KernelGatewayImageConfig", + "traits": { + "smithy.api#documentation": "

The configuration of a KernelGateway app.

" + } + }, + "JupyterLabAppImageConfig": { + "target": "com.amazonaws.sagemaker#JupyterLabAppImageConfig", + "traits": { + "smithy.api#documentation": "

The configuration of the JupyterLab app.

" + } + }, + "CodeEditorAppImageConfig": { + "target": "com.amazonaws.sagemaker#CodeEditorAppImageConfig", + "traits": { + "smithy.api#documentation": "

The configuration of the Code Editor app.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeAppRequest": { + "type": "structure", + "members": { + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The domain ID.

", + "smithy.api#required": {} + } + }, + "UserProfileName": { + "target": "com.amazonaws.sagemaker#UserProfileName", + "traits": { + "smithy.api#documentation": "

The user profile name. If this value is not set, then SpaceName must be\n set.

" + } + }, + "SpaceName": { + "target": "com.amazonaws.sagemaker#SpaceName", + "traits": { + "smithy.api#documentation": "

The name of the space.

" + } + }, + "AppType": { + "target": "com.amazonaws.sagemaker#AppType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of app.

", + "smithy.api#required": {} + } + }, + "AppName": { + "target": "com.amazonaws.sagemaker#AppName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the app.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeAppResponse": { + "type": "structure", + "members": { + "AppArn": { + "target": "com.amazonaws.sagemaker#AppArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the app.

" + } + }, + "AppType": { + "target": "com.amazonaws.sagemaker#AppType", + "traits": { + "smithy.api#documentation": "

The type of app.

" + } + }, + "AppName": { + "target": "com.amazonaws.sagemaker#AppName", + "traits": { + "smithy.api#documentation": "

The name of the app.

" + } + }, + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#documentation": "

The domain ID.

" + } + }, + "UserProfileName": { + "target": "com.amazonaws.sagemaker#UserProfileName", + "traits": { + "smithy.api#documentation": "

The user profile name.

" + } + }, + "SpaceName": { + "target": "com.amazonaws.sagemaker#SpaceName", + "traits": { + "smithy.api#documentation": "

The name of the space. If this value is not set, then UserProfileName must be\n set.

" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#AppStatus", + "traits": { + "smithy.api#documentation": "

The status.

" + } + }, + "LastHealthCheckTimestamp": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of the last health check.

" + } + }, + "LastUserActivityTimestamp": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of the last user's activity. LastUserActivityTimestamp is also\n updated when SageMaker AI performs health checks without user activity. As a result, this\n value is set to the same value as LastHealthCheckTimestamp.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The creation time of the application.

\n \n

After an application has been shut down for 24 hours, SageMaker AI deletes all\n metadata for the application. To be considered an update and retain application metadata,\n applications must be restarted within 24 hours after the previous application has been shut\n down. After this time window, creation of an application is considered a new application\n rather than an update of the previous application.

\n " + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "

The failure reason.

" + } + }, + "ResourceSpec": { + "target": "com.amazonaws.sagemaker#ResourceSpec", + "traits": { + "smithy.api#documentation": "

The instance type and the Amazon Resource Name (ARN) of the SageMaker AI image\n created on the instance.

" + } + }, + "BuiltInLifecycleConfigArn": { + "target": "com.amazonaws.sagemaker#StudioLifecycleConfigArn", + "traits": { + "smithy.api#documentation": "

The lifecycle configuration that runs before the default lifecycle configuration

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeArtifact": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeArtifactRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeArtifactResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Describes an artifact.

" + } + }, + "com.amazonaws.sagemaker#DescribeArtifactRequest": { + "type": "structure", + "members": { + "ArtifactArn": { + "target": "com.amazonaws.sagemaker#ArtifactArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the artifact to describe.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeArtifactResponse": { + "type": "structure", + "members": { + "ArtifactName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityNameOrArn", + "traits": { + "smithy.api#documentation": "

The name of the artifact.

" + } + }, + "ArtifactArn": { + "target": "com.amazonaws.sagemaker#ArtifactArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the artifact.

" + } + }, + "Source": { + "target": "com.amazonaws.sagemaker#ArtifactSource", + "traits": { + "smithy.api#documentation": "

The source of the artifact.

" + } + }, + "ArtifactType": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "

The type of the artifact.

" + } + }, + "Properties": { + "target": "com.amazonaws.sagemaker#LineageEntityParameters", + "traits": { + "smithy.api#documentation": "

A list of the artifact's properties.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the artifact was created.

" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the artifact was last modified.

" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "MetadataProperties": { + "target": "com.amazonaws.sagemaker#MetadataProperties" + }, + "LineageGroupArn": { + "target": "com.amazonaws.sagemaker#LineageGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the lineage group.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeAutoMLJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeAutoMLJobRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeAutoMLJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about an AutoML job created by calling CreateAutoMLJob.

\n \n

AutoML jobs created by calling CreateAutoMLJobV2 cannot be described by\n DescribeAutoMLJob.

\n " + } + }, + "com.amazonaws.sagemaker#DescribeAutoMLJobRequest": { + "type": "structure", + "members": { + "AutoMLJobName": { + "target": "com.amazonaws.sagemaker#AutoMLJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Requests information about an AutoML job using its unique name.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeAutoMLJobResponse": { + "type": "structure", + "members": { + "AutoMLJobName": { + "target": "com.amazonaws.sagemaker#AutoMLJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Returns the name of the AutoML job.

", + "smithy.api#required": {} + } + }, + "AutoMLJobArn": { + "target": "com.amazonaws.sagemaker#AutoMLJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Returns the ARN of the AutoML job.

", + "smithy.api#required": {} + } + }, + "InputDataConfig": { + "target": "com.amazonaws.sagemaker#AutoMLInputDataConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Returns the input data configuration for the AutoML job.

", + "smithy.api#required": {} + } + }, + "OutputDataConfig": { + "target": "com.amazonaws.sagemaker#AutoMLOutputDataConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Returns the job's output data config.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the IAM role that has read permission to the input data\n location and write permission to the output data location in Amazon S3.

", + "smithy.api#required": {} + } + }, + "AutoMLJobObjective": { + "target": "com.amazonaws.sagemaker#AutoMLJobObjective", + "traits": { + "smithy.api#documentation": "

Returns the job's objective.

" + } + }, + "ProblemType": { + "target": "com.amazonaws.sagemaker#ProblemType", + "traits": { + "smithy.api#documentation": "

Returns the job's problem type.

" + } + }, + "AutoMLJobConfig": { + "target": "com.amazonaws.sagemaker#AutoMLJobConfig", + "traits": { + "smithy.api#documentation": "

Returns the configuration for the AutoML job.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Returns the creation time of the AutoML job.

", + "smithy.api#required": {} + } + }, + "EndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Returns the end time of the AutoML job.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Returns the job's last modified time.

", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#AutoMLFailureReason", + "traits": { + "smithy.api#documentation": "

Returns the failure reason for an AutoML job, when applicable.

" + } + }, + "PartialFailureReasons": { + "target": "com.amazonaws.sagemaker#AutoMLPartialFailureReasons", + "traits": { + "smithy.api#documentation": "

Returns a list of reasons for partial failures within an AutoML job.

" + } + }, + "BestCandidate": { + "target": "com.amazonaws.sagemaker#AutoMLCandidate", + "traits": { + "smithy.api#documentation": "

The best model candidate selected by SageMaker AI Autopilot using both the best\n objective metric and lowest InferenceLatency for\n an experiment.

" + } + }, + "AutoMLJobStatus": { + "target": "com.amazonaws.sagemaker#AutoMLJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Returns the status of the AutoML job.

", + "smithy.api#required": {} + } + }, + "AutoMLJobSecondaryStatus": { + "target": "com.amazonaws.sagemaker#AutoMLJobSecondaryStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Returns the secondary status of the AutoML job.

", + "smithy.api#required": {} + } + }, + "GenerateCandidateDefinitionsOnly": { + "target": "com.amazonaws.sagemaker#GenerateCandidateDefinitionsOnly", + "traits": { + "smithy.api#documentation": "

Indicates whether the output for an AutoML job generates candidate definitions\n only.

" + } + }, + "AutoMLJobArtifacts": { + "target": "com.amazonaws.sagemaker#AutoMLJobArtifacts", + "traits": { + "smithy.api#documentation": "

Returns information on the job's artifacts found in\n AutoMLJobArtifacts.

" + } + }, + "ResolvedAttributes": { + "target": "com.amazonaws.sagemaker#ResolvedAttributes", + "traits": { + "smithy.api#documentation": "

Contains ProblemType, AutoMLJobObjective, and\n CompletionCriteria. If you do not provide these values, they are\n inferred.

" + } + }, + "ModelDeployConfig": { + "target": "com.amazonaws.sagemaker#ModelDeployConfig", + "traits": { + "smithy.api#documentation": "

Indicates whether the model was deployed automatically to an endpoint and the name of\n that endpoint if deployed automatically.

" + } + }, + "ModelDeployResult": { + "target": "com.amazonaws.sagemaker#ModelDeployResult", + "traits": { + "smithy.api#documentation": "

Provides information about endpoint for the model deployment.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeAutoMLJobV2": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeAutoMLJobV2Request" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeAutoMLJobV2Response" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about an AutoML job created by calling CreateAutoMLJobV2\n or CreateAutoMLJob.

" + } + }, + "com.amazonaws.sagemaker#DescribeAutoMLJobV2Request": { + "type": "structure", + "members": { + "AutoMLJobName": { + "target": "com.amazonaws.sagemaker#AutoMLJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Requests information about an AutoML job V2 using its unique name.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeAutoMLJobV2Response": { + "type": "structure", + "members": { + "AutoMLJobName": { + "target": "com.amazonaws.sagemaker#AutoMLJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Returns the name of the AutoML job V2.

", + "smithy.api#required": {} + } + }, + "AutoMLJobArn": { + "target": "com.amazonaws.sagemaker#AutoMLJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Returns the Amazon Resource Name (ARN) of the AutoML job V2.

", + "smithy.api#required": {} + } + }, + "AutoMLJobInputDataConfig": { + "target": "com.amazonaws.sagemaker#AutoMLJobInputDataConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Returns an array of channel objects describing the input data and their location.

", + "smithy.api#required": {} + } + }, + "OutputDataConfig": { + "target": "com.amazonaws.sagemaker#AutoMLOutputDataConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Returns the job's output data config.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the IAM role that has read permission to the input data\n location and write permission to the output data location in Amazon S3.

", + "smithy.api#required": {} + } + }, + "AutoMLJobObjective": { + "target": "com.amazonaws.sagemaker#AutoMLJobObjective", + "traits": { + "smithy.api#documentation": "

Returns the job's objective.

" + } + }, + "AutoMLProblemTypeConfig": { + "target": "com.amazonaws.sagemaker#AutoMLProblemTypeConfig", + "traits": { + "smithy.api#documentation": "

Returns the configuration settings of the problem type set for the AutoML job V2.

" + } + }, + "AutoMLProblemTypeConfigName": { + "target": "com.amazonaws.sagemaker#AutoMLProblemTypeConfigName", + "traits": { + "smithy.api#documentation": "

Returns the name of the problem type configuration set for the AutoML job V2.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Returns the creation time of the AutoML job V2.

", + "smithy.api#required": {} + } + }, + "EndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Returns the end time of the AutoML job V2.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Returns the job's last modified time.

", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#AutoMLFailureReason", + "traits": { + "smithy.api#documentation": "

Returns the reason for the failure of the AutoML job V2, when applicable.

" + } + }, + "PartialFailureReasons": { + "target": "com.amazonaws.sagemaker#AutoMLPartialFailureReasons", + "traits": { + "smithy.api#documentation": "

Returns a list of reasons for partial failures within an AutoML job V2.

" + } + }, + "BestCandidate": { + "target": "com.amazonaws.sagemaker#AutoMLCandidate", + "traits": { + "smithy.api#documentation": "

Information about the candidate produced by an AutoML training job V2, including its\n status, steps, and other properties.

" + } + }, + "AutoMLJobStatus": { + "target": "com.amazonaws.sagemaker#AutoMLJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Returns the status of the AutoML job V2.

", + "smithy.api#required": {} + } + }, + "AutoMLJobSecondaryStatus": { + "target": "com.amazonaws.sagemaker#AutoMLJobSecondaryStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Returns the secondary status of the AutoML job V2.

", + "smithy.api#required": {} + } + }, + "AutoMLJobArtifacts": { + "target": "com.amazonaws.sagemaker#AutoMLJobArtifacts" + }, + "ResolvedAttributes": { + "target": "com.amazonaws.sagemaker#AutoMLResolvedAttributes", + "traits": { + "smithy.api#documentation": "

Returns the resolved attributes used by the AutoML job V2.

" + } + }, + "ModelDeployConfig": { + "target": "com.amazonaws.sagemaker#ModelDeployConfig", + "traits": { + "smithy.api#documentation": "

Indicates whether the model was deployed automatically to an endpoint and the name of\n that endpoint if deployed automatically.

" + } + }, + "ModelDeployResult": { + "target": "com.amazonaws.sagemaker#ModelDeployResult", + "traits": { + "smithy.api#documentation": "

Provides information about endpoint for the model deployment.

" + } + }, + "DataSplitConfig": { + "target": "com.amazonaws.sagemaker#AutoMLDataSplitConfig", + "traits": { + "smithy.api#documentation": "

Returns the configuration settings of how the data are split into train and validation\n datasets.

" + } + }, + "SecurityConfig": { + "target": "com.amazonaws.sagemaker#AutoMLSecurityConfig", + "traits": { + "smithy.api#documentation": "

Returns the security configuration for traffic encryption or Amazon VPC\n settings.

" + } + }, + "AutoMLComputeConfig": { + "target": "com.amazonaws.sagemaker#AutoMLComputeConfig", + "traits": { + "smithy.api#documentation": "

The compute configuration used for the AutoML job V2.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeClusterRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeClusterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves information of a SageMaker HyperPod cluster.

" + } + }, + "com.amazonaws.sagemaker#DescribeClusterNode": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeClusterNodeRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeClusterNodeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves information of a node (also called a instance\n interchangeably) of a SageMaker HyperPod cluster.

" + } + }, + "com.amazonaws.sagemaker#DescribeClusterNodeRequest": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.sagemaker#ClusterNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which the node is.

", + "smithy.api#required": {} + } + }, + "NodeId": { + "target": "com.amazonaws.sagemaker#ClusterNodeId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the SageMaker HyperPod cluster node.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeClusterNodeResponse": { + "type": "structure", + "members": { + "NodeDetails": { + "target": "com.amazonaws.sagemaker#ClusterNodeDetails", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The details of the SageMaker HyperPod cluster node.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeClusterRequest": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.sagemaker#ClusterNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeClusterResponse": { + "type": "structure", + "members": { + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

", + "smithy.api#required": {} + } + }, + "ClusterName": { + "target": "com.amazonaws.sagemaker#ClusterName", + "traits": { + "smithy.api#documentation": "

The name of the SageMaker HyperPod cluster.

" + } + }, + "ClusterStatus": { + "target": "com.amazonaws.sagemaker#ClusterStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of the SageMaker HyperPod cluster.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the SageMaker Cluster is created.

" + } + }, + "FailureMessage": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The failure message of the SageMaker HyperPod cluster.

" + } + }, + "InstanceGroups": { + "target": "com.amazonaws.sagemaker#ClusterInstanceGroupDetailsList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The instance groups of the SageMaker HyperPod cluster.

", + "smithy.api#required": {} + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig" + }, + "Orchestrator": { + "target": "com.amazonaws.sagemaker#ClusterOrchestrator", + "traits": { + "smithy.api#documentation": "

The type of orchestrator used for the SageMaker HyperPod cluster.

" + } + }, + "NodeRecovery": { + "target": "com.amazonaws.sagemaker#ClusterNodeRecovery", + "traits": { + "smithy.api#documentation": "

The node recovery mode configured for the SageMaker HyperPod cluster.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeClusterSchedulerConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeClusterSchedulerConfigRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeClusterSchedulerConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Description of the cluster policy. This policy is used for task prioritization and\n fair-share allocation. This helps prioritize critical workloads and distributes\n idle compute across entities.

" + } + }, + "com.amazonaws.sagemaker#DescribeClusterSchedulerConfigRequest": { + "type": "structure", + "members": { + "ClusterSchedulerConfigId": { + "target": "com.amazonaws.sagemaker#ClusterSchedulerConfigId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

ID of the cluster policy.

", + "smithy.api#required": {} + } + }, + "ClusterSchedulerConfigVersion": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "

Version of the cluster policy.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeClusterSchedulerConfigResponse": { + "type": "structure", + "members": { + "ClusterSchedulerConfigArn": { + "target": "com.amazonaws.sagemaker#ClusterSchedulerConfigArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

ARN of the cluster policy.

", + "smithy.api#required": {} + } + }, + "ClusterSchedulerConfigId": { + "target": "com.amazonaws.sagemaker#ClusterSchedulerConfigId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

ID of the cluster policy.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Name of the cluster policy.

", + "smithy.api#required": {} + } + }, + "ClusterSchedulerConfigVersion": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Version of the cluster policy.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#SchedulerResourceStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Status of the cluster policy.

", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "

Failure reason of the cluster policy.

" + } + }, + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#documentation": "

ARN of the cluster where the cluster policy is applied.

" + } + }, + "SchedulerConfig": { + "target": "com.amazonaws.sagemaker#SchedulerConfig", + "traits": { + "smithy.api#documentation": "

Cluster policy configuration. This policy is used for task prioritization and fair-share\n allocation. This helps prioritize critical workloads and distributes idle compute\n across entities.

" + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "

Description of the cluster policy.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Creation time of the cluster policy.

", + "smithy.api#required": {} + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Last modified time of the cluster policy.

" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeCodeRepository": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeCodeRepositoryInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeCodeRepositoryOutput" + }, + "traits": { + "smithy.api#documentation": "

Gets details about the specified Git repository.

" + } + }, + "com.amazonaws.sagemaker#DescribeCodeRepositoryInput": { + "type": "structure", + "members": { + "CodeRepositoryName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Git repository to describe.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeCodeRepositoryOutput": { + "type": "structure", + "members": { + "CodeRepositoryName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Git repository.

", + "smithy.api#required": {} + } + }, + "CodeRepositoryArn": { + "target": "com.amazonaws.sagemaker#CodeRepositoryArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Git repository.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The date and time that the repository was created.

", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The date and time that the repository was last changed.

", + "smithy.api#required": {} + } + }, + "GitConfig": { + "target": "com.amazonaws.sagemaker#GitConfig", + "traits": { + "smithy.api#documentation": "

Configuration details about the repository, including the URL where the repository is\n located, the default branch, and the Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the\n repository.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeCompilationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeCompilationJobRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeCompilationJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a model compilation job.

\n

To create a model compilation job, use CreateCompilationJob. To get information about multiple model compilation\n jobs, use ListCompilationJobs.

" + } + }, + "com.amazonaws.sagemaker#DescribeCompilationJobRequest": { + "type": "structure", + "members": { + "CompilationJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the model compilation job that you want information about.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeCompilationJobResponse": { + "type": "structure", + "members": { + "CompilationJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the model compilation job.

", + "smithy.api#required": {} + } + }, + "CompilationJobArn": { + "target": "com.amazonaws.sagemaker#CompilationJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model compilation job.

", + "smithy.api#required": {} + } + }, + "CompilationJobStatus": { + "target": "com.amazonaws.sagemaker#CompilationJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of the model compilation job.

", + "smithy.api#required": {} + } + }, + "CompilationStartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the model compilation job started the CompilationJob\n instances.

\n

You are billed for the time between this timestamp and the timestamp in the\n CompilationEndTime field. In Amazon CloudWatch Logs, the start time might be later\n than this time. That's because it takes time to download the compilation job, which\n depends on the size of the compilation job container.

" + } + }, + "CompilationEndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the model compilation job on a compilation job instance ended. For a\n successful or stopped job, this is when the job's model artifacts have finished\n uploading. For a failed job, this is when Amazon SageMaker AI detected that the job failed.

" + } + }, + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#StoppingCondition", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies a limit to how long a model compilation job can run. When the job reaches\n the time limit, Amazon SageMaker AI ends the compilation job. Use this API to cap model training\n costs.

", + "smithy.api#required": {} + } + }, + "InferenceImage": { + "target": "com.amazonaws.sagemaker#InferenceImage", + "traits": { + "smithy.api#documentation": "

The inference image to use when compiling a model. Specify an image only if the target\n device is a cloud instance.

" + } + }, + "ModelPackageVersionArn": { + "target": "com.amazonaws.sagemaker#ModelPackageArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the versioned model package that was \n provided to SageMaker Neo when you initiated a compilation job.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The time that the model compilation job was created.

", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The time that the status\n of\n the model compilation job was last modified.

", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

If a model compilation job failed, the reason it failed.

", + "smithy.api#required": {} + } + }, + "ModelArtifacts": { + "target": "com.amazonaws.sagemaker#ModelArtifacts", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Information about the location in Amazon S3 that has been configured for storing the model\n artifacts used in the compilation job.

", + "smithy.api#required": {} + } + }, + "ModelDigests": { + "target": "com.amazonaws.sagemaker#ModelDigests", + "traits": { + "smithy.api#documentation": "

Provides a BLAKE2 hash value that identifies the compiled model artifacts in\n Amazon S3.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI assumes to perform the model\n compilation job.

", + "smithy.api#required": {} + } + }, + "InputConfig": { + "target": "com.amazonaws.sagemaker#InputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Information about the location in Amazon S3 of the input model artifacts, the name and\n shape of the expected data inputs, and the framework in which the model was\n trained.

", + "smithy.api#required": {} + } + }, + "OutputConfig": { + "target": "com.amazonaws.sagemaker#OutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Information about the output location for the compiled model and the target device\n that the model runs on.

", + "smithy.api#required": {} + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#NeoVpcConfig", + "traits": { + "smithy.api#documentation": "

A VpcConfig object that specifies the VPC that you want your compilation job\n to connect to. Control access to your models by configuring the VPC. For more\n information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.

" + } + }, + "DerivedInformation": { + "target": "com.amazonaws.sagemaker#DerivedInformation", + "traits": { + "smithy.api#documentation": "

Information that SageMaker Neo automatically derived about the model.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeComputeQuota": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeComputeQuotaRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeComputeQuotaResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Description of the compute allocation definition.

" + } + }, + "com.amazonaws.sagemaker#DescribeComputeQuotaRequest": { + "type": "structure", + "members": { + "ComputeQuotaId": { + "target": "com.amazonaws.sagemaker#ComputeQuotaId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

ID of the compute allocation definition.

", + "smithy.api#required": {} + } + }, + "ComputeQuotaVersion": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "

Version of the compute allocation definition.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeComputeQuotaResponse": { + "type": "structure", + "members": { + "ComputeQuotaArn": { + "target": "com.amazonaws.sagemaker#ComputeQuotaArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

ARN of the compute allocation definition.

", + "smithy.api#required": {} + } + }, + "ComputeQuotaId": { + "target": "com.amazonaws.sagemaker#ComputeQuotaId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

ID of the compute allocation definition.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Name of the compute allocation definition.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "

Description of the compute allocation definition.

" + } + }, + "ComputeQuotaVersion": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Version of the compute allocation definition.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#SchedulerResourceStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Status of the compute allocation definition.

", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "

Failure reason of the compute allocation definition.

" + } + }, + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#documentation": "

ARN of the cluster.

" + } + }, + "ComputeQuotaConfig": { + "target": "com.amazonaws.sagemaker#ComputeQuotaConfig", + "traits": { + "smithy.api#documentation": "

Configuration of the compute allocation definition. This includes the resource sharing\n option, and the setting to preempt low priority tasks.

" + } + }, + "ComputeQuotaTarget": { + "target": "com.amazonaws.sagemaker#ComputeQuotaTarget", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The target entity to allocate compute resources to.

", + "smithy.api#required": {} + } + }, + "ActivationState": { + "target": "com.amazonaws.sagemaker#ActivationState", + "traits": { + "smithy.api#documentation": "

The state of the compute allocation being described. Use to enable or disable compute\n allocation.

\n

Default is Enabled.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Creation time of the compute allocation configuration.

", + "smithy.api#required": {} + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Last modified time of the compute allocation configuration.

" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeContext": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeContextRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeContextResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Describes a context.

" + } + }, + "com.amazonaws.sagemaker#DescribeContextRequest": { + "type": "structure", + "members": { + "ContextName": { + "target": "com.amazonaws.sagemaker#ContextNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the context to describe.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeContextResponse": { + "type": "structure", + "members": { + "ContextName": { + "target": "com.amazonaws.sagemaker#ContextName", + "traits": { + "smithy.api#documentation": "

The name of the context.

" + } + }, + "ContextArn": { + "target": "com.amazonaws.sagemaker#ContextArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the context.

" + } + }, + "Source": { + "target": "com.amazonaws.sagemaker#ContextSource", + "traits": { + "smithy.api#documentation": "

The source of the context.

" + } + }, + "ContextType": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "

The type of the context.

" + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#ExperimentDescription", + "traits": { + "smithy.api#documentation": "

The description of the context.

" + } + }, + "Properties": { + "target": "com.amazonaws.sagemaker#LineageEntityParameters", + "traits": { + "smithy.api#documentation": "

A list of the context's properties.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the context was created.

" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the context was last modified.

" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "LineageGroupArn": { + "target": "com.amazonaws.sagemaker#LineageGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the lineage group.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeDataQualityJobDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeDataQualityJobDefinitionRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeDataQualityJobDefinitionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the details of a data quality monitoring job definition.

" + } + }, + "com.amazonaws.sagemaker#DescribeDataQualityJobDefinitionRequest": { + "type": "structure", + "members": { + "JobDefinitionName": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the data quality monitoring job definition to describe.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeDataQualityJobDefinitionResponse": { + "type": "structure", + "members": { + "JobDefinitionArn": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data quality monitoring job definition.

", + "smithy.api#required": {} + } + }, + "JobDefinitionName": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the data quality monitoring job definition.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The time that the data quality monitoring job definition was created.

", + "smithy.api#required": {} + } + }, + "DataQualityBaselineConfig": { + "target": "com.amazonaws.sagemaker#DataQualityBaselineConfig", + "traits": { + "smithy.api#documentation": "

The constraints and baselines for the data quality monitoring job definition.

" + } + }, + "DataQualityAppSpecification": { + "target": "com.amazonaws.sagemaker#DataQualityAppSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Information about the container that runs the data quality monitoring job.

", + "smithy.api#required": {} + } + }, + "DataQualityJobInput": { + "target": "com.amazonaws.sagemaker#DataQualityJobInput", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The list of inputs for the data quality monitoring job. Currently endpoints are\n supported.

", + "smithy.api#required": {} + } + }, + "DataQualityJobOutputConfig": { + "target": "com.amazonaws.sagemaker#MonitoringOutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "JobResources": { + "target": "com.amazonaws.sagemaker#MonitoringResources", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "NetworkConfig": { + "target": "com.amazonaws.sagemaker#MonitoringNetworkConfig", + "traits": { + "smithy.api#documentation": "

The networking configuration for the data quality monitoring job.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can \n assume to perform tasks on your behalf.

", + "smithy.api#required": {} + } + }, + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#MonitoringStoppingCondition" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeDevice": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeDeviceRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeDeviceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the device.

" + } + }, + "com.amazonaws.sagemaker#DescribeDeviceFleet": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeDeviceFleetRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeDeviceFleetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

A description of the fleet the device belongs to.

" + } + }, + "com.amazonaws.sagemaker#DescribeDeviceFleetRequest": { + "type": "structure", + "members": { + "DeviceFleetName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the fleet.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeDeviceFleetResponse": { + "type": "structure", + "members": { + "DeviceFleetName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the fleet.

", + "smithy.api#required": {} + } + }, + "DeviceFleetArn": { + "target": "com.amazonaws.sagemaker#DeviceFleetArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The The Amazon Resource Name (ARN) of the fleet.

", + "smithy.api#required": {} + } + }, + "OutputConfig": { + "target": "com.amazonaws.sagemaker#EdgeOutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The output configuration for storing sampled data.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#DeviceFleetDescription", + "traits": { + "smithy.api#documentation": "

A description of the fleet.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Timestamp of when the device fleet was created.

", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Timestamp of when the device fleet was last updated.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet of Things (IoT).

" + } + }, + "IotRoleAlias": { + "target": "com.amazonaws.sagemaker#IotRoleAlias", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) alias created in Amazon Web Services Internet of Things (IoT).

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeDeviceRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

Next token of device description.

" + } + }, + "DeviceName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The unique ID of the device.

", + "smithy.api#required": {} + } + }, + "DeviceFleetName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the fleet the devices belong to.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeDeviceResponse": { + "type": "structure", + "members": { + "DeviceArn": { + "target": "com.amazonaws.sagemaker#DeviceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the device.

" + } + }, + "DeviceName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The unique identifier of the device.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#DeviceDescription", + "traits": { + "smithy.api#documentation": "

A description of the device.

" + } + }, + "DeviceFleetName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the fleet the device belongs to.

", + "smithy.api#required": {} + } + }, + "IotThingName": { + "target": "com.amazonaws.sagemaker#ThingName", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Internet of Things (IoT) object thing name associated with the device.

" + } + }, + "RegistrationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The timestamp of the last registration or de-reregistration.

", + "smithy.api#required": {} + } + }, + "LatestHeartbeat": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The last heartbeat received from the device.

" + } + }, + "Models": { + "target": "com.amazonaws.sagemaker#EdgeModels", + "traits": { + "smithy.api#documentation": "

Models on the device.

" + } + }, + "MaxModels": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of models.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

The response from the last list when returning a list large enough to need tokening.

" + } + }, + "AgentVersion": { + "target": "com.amazonaws.sagemaker#EdgeVersion", + "traits": { + "smithy.api#documentation": "

Edge Manager agent version.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeDomain": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeDomainRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeDomainResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

The description of the domain.

" + } + }, + "com.amazonaws.sagemaker#DescribeDomainRequest": { + "type": "structure", + "members": { + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The domain ID.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeDomainResponse": { + "type": "structure", + "members": { + "DomainArn": { + "target": "com.amazonaws.sagemaker#DomainArn", + "traits": { + "smithy.api#documentation": "

The domain's Amazon Resource Name (ARN).

" + } + }, + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#documentation": "

The domain ID.

" + } + }, + "DomainName": { + "target": "com.amazonaws.sagemaker#DomainName", + "traits": { + "smithy.api#documentation": "

The domain name.

" + } + }, + "HomeEfsFileSystemId": { + "target": "com.amazonaws.sagemaker#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Elastic File System managed by this Domain.

" + } + }, + "SingleSignOnManagedApplicationInstanceId": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "

The IAM Identity Center managed application instance ID.

" + } + }, + "SingleSignOnApplicationArn": { + "target": "com.amazonaws.sagemaker#SingleSignOnApplicationArn", + "traits": { + "smithy.api#documentation": "

The ARN of the application managed by SageMaker AI in IAM Identity Center. This value\n is only returned for domains created after October 1, 2023.

" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#DomainStatus", + "traits": { + "smithy.api#documentation": "

The status.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "

The creation time.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "

The last modified time.

" + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "

The failure reason.

" + } + }, + "SecurityGroupIdForDomainBoundary": { + "target": "com.amazonaws.sagemaker#SecurityGroupId", + "traits": { + "smithy.api#documentation": "

The ID of the security group that authorizes traffic between the\n RSessionGateway apps and the RStudioServerPro app.

" + } + }, + "AuthMode": { + "target": "com.amazonaws.sagemaker#AuthMode", + "traits": { + "smithy.api#documentation": "

The domain's authentication mode.

" + } + }, + "DefaultUserSettings": { + "target": "com.amazonaws.sagemaker#UserSettings", + "traits": { + "smithy.api#documentation": "

Settings which are applied to UserProfiles in this domain if settings are not explicitly\n specified in a given UserProfile.

" + } + }, + "DomainSettings": { + "target": "com.amazonaws.sagemaker#DomainSettings", + "traits": { + "smithy.api#documentation": "

A collection of Domain settings.

" + } + }, + "AppNetworkAccessType": { + "target": "com.amazonaws.sagemaker#AppNetworkAccessType", + "traits": { + "smithy.api#documentation": "

Specifies the VPC used for non-EFS traffic. The default value is\n PublicInternetOnly.

\n
    \n
  • \n

    \n PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker AI, which allows direct internet access

    \n
    • \n
  • \n

    \n VpcOnly - All traffic is through the specified VPC and subnets

    \n
    • \n
" + } + }, + "HomeEfsFileSystemKmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#deprecated": { + "message": "This property is deprecated, use KmsKeyId instead." + }, + "smithy.api#documentation": "

Use KmsKeyId.

" + } + }, + "SubnetIds": { + "target": "com.amazonaws.sagemaker#Subnets", + "traits": { + "smithy.api#documentation": "

The VPC subnets that the domain uses for communication.

" + } + }, + "Url": { + "target": "com.amazonaws.sagemaker#String1024", + "traits": { + "smithy.api#documentation": "

The domain's URL.

" + } + }, + "VpcId": { + "target": "com.amazonaws.sagemaker#VpcId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS customer managed key used to encrypt the EFS volume attached to\n the domain.

" + } + }, + "AppSecurityGroupManagement": { + "target": "com.amazonaws.sagemaker#AppSecurityGroupManagement", + "traits": { + "smithy.api#documentation": "

The entity that creates and manages the required security groups for inter-app\n communication in VPCOnly mode. Required when\n CreateDomain.AppNetworkAccessType is VPCOnly and\n DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is\n provided.

" + } + }, + "TagPropagation": { + "target": "com.amazonaws.sagemaker#TagPropagation", + "traits": { + "smithy.api#documentation": "

Indicates whether custom tag propagation is supported for the domain.

" + } + }, + "DefaultSpaceSettings": { + "target": "com.amazonaws.sagemaker#DefaultSpaceSettings", + "traits": { + "smithy.api#documentation": "

The default settings for shared spaces that users create in the domain.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeEdgeDeploymentPlan": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeEdgeDeploymentPlanRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeEdgeDeploymentPlanResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Describes an edge deployment plan with deployment status per stage.

" + } + }, + "com.amazonaws.sagemaker#DescribeEdgeDeploymentPlanRequest": { + "type": "structure", + "members": { + "EdgeDeploymentPlanName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the deployment plan to describe.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the edge deployment plan has enough stages to require tokening, then this is the\n response from the last list of stages returned.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#DeploymentStageMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to select (50 by default).

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeEdgeDeploymentPlanResponse": { + "type": "structure", + "members": { + "EdgeDeploymentPlanArn": { + "target": "com.amazonaws.sagemaker#EdgeDeploymentPlanArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of edge deployment plan.

", + "smithy.api#required": {} + } + }, + "EdgeDeploymentPlanName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the edge deployment plan.

", + "smithy.api#required": {} + } + }, + "ModelConfigs": { + "target": "com.amazonaws.sagemaker#EdgeDeploymentModelConfigs", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

List of models associated with the edge deployment plan.

", + "smithy.api#required": {} + } + }, + "DeviceFleetName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The device fleet used for this edge deployment plan.

", + "smithy.api#required": {} + } + }, + "EdgeDeploymentSuccess": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "

The number of edge devices with the successful deployment.

" + } + }, + "EdgeDeploymentPending": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "

The number of edge devices yet to pick up deployment, or in progress.

" + } + }, + "EdgeDeploymentFailed": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "

The number of edge devices that failed the deployment.

" + } + }, + "Stages": { + "target": "com.amazonaws.sagemaker#DeploymentStageStatusSummaries", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

List of stages in the edge deployment plan.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

Token to use when calling the next set of stages in the edge deployment plan.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the edge deployment plan was created.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the edge deployment plan was last updated.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeEdgePackagingJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeEdgePackagingJobRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeEdgePackagingJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

A description of edge packaging jobs.

" + } + }, + "com.amazonaws.sagemaker#DescribeEdgePackagingJobRequest": { + "type": "structure", + "members": { + "EdgePackagingJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the edge packaging job.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeEdgePackagingJobResponse": { + "type": "structure", + "members": { + "EdgePackagingJobArn": { + "target": "com.amazonaws.sagemaker#EdgePackagingJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the edge packaging job.

", + "smithy.api#required": {} + } + }, + "EdgePackagingJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the edge packaging job.

", + "smithy.api#required": {} + } + }, + "CompilationJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the SageMaker Neo compilation job that is used to locate model artifacts that are being packaged.

" + } + }, + "ModelName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the model.

" + } + }, + "ModelVersion": { + "target": "com.amazonaws.sagemaker#EdgeVersion", + "traits": { + "smithy.api#documentation": "

The version of the model.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload the model, and to contact Neo.

" + } + }, + "OutputConfig": { + "target": "com.amazonaws.sagemaker#EdgeOutputConfig", + "traits": { + "smithy.api#documentation": "

The output configuration for the edge packaging job.

" + } + }, + "ResourceKey": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key to use when encrypting the EBS volume the job run on.

" + } + }, + "EdgePackagingJobStatus": { + "target": "com.amazonaws.sagemaker#EdgePackagingJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The current status of the packaging job.

", + "smithy.api#required": {} + } + }, + "EdgePackagingJobStatusMessage": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

Returns a message describing the job status and error messages.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the packaging job was created.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the job was last updated.

" + } + }, + "ModelArtifact": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "

The Amazon Simple Storage (S3) URI where model artifacts ares stored.

" + } + }, + "ModelSignature": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The signature document of files in the model artifact.

" + } + }, + "PresetDeploymentOutput": { + "target": "com.amazonaws.sagemaker#EdgePresetDeploymentOutput", + "traits": { + "smithy.api#documentation": "

The output of a SageMaker Edge Manager deployable resource.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeEndpointInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeEndpointOutput" + }, + "traits": { + "smithy.api#documentation": "

Returns the description of an endpoint.

", + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "EndpointDeleted": { + "acceptors": [ + { + "state": "success", + "matcher": { + "errorType": "ValidationException" + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "EndpointStatus", + "expected": "Failed", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 30 + }, + "EndpointInService": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "EndpointStatus", + "expected": "InService", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "EndpointStatus", + "expected": "Failed", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "errorType": "ValidationException" + } + } + ], + "minDelay": 30 + } + } + } + }, + "com.amazonaws.sagemaker#DescribeEndpointConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeEndpointConfigInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeEndpointConfigOutput" + }, + "traits": { + "smithy.api#documentation": "

Returns the description of an endpoint configuration created using the\n CreateEndpointConfig API.

" + } + }, + "com.amazonaws.sagemaker#DescribeEndpointConfigInput": { + "type": "structure", + "members": { + "EndpointConfigName": { + "target": "com.amazonaws.sagemaker#EndpointConfigName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the endpoint configuration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeEndpointConfigOutput": { + "type": "structure", + "members": { + "EndpointConfigName": { + "target": "com.amazonaws.sagemaker#EndpointConfigName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Name of the SageMaker endpoint configuration.

", + "smithy.api#required": {} + } + }, + "EndpointConfigArn": { + "target": "com.amazonaws.sagemaker#EndpointConfigArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the endpoint configuration.

", + "smithy.api#required": {} + } + }, + "ProductionVariants": { + "target": "com.amazonaws.sagemaker#ProductionVariantList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An array of ProductionVariant objects, one for each model that you\n want to host at this endpoint.

", + "smithy.api#required": {} + } + }, + "DataCaptureConfig": { + "target": "com.amazonaws.sagemaker#DataCaptureConfig" + }, + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

Amazon Web Services KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML\n storage volume attached to the instance.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A timestamp that shows when the endpoint configuration was created.

", + "smithy.api#required": {} + } + }, + "AsyncInferenceConfig": { + "target": "com.amazonaws.sagemaker#AsyncInferenceConfig", + "traits": { + "smithy.api#documentation": "

Returns the description of an endpoint configuration created using the \n CreateEndpointConfig\n API.

" + } + }, + "ExplainerConfig": { + "target": "com.amazonaws.sagemaker#ExplainerConfig", + "traits": { + "smithy.api#documentation": "

The configuration parameters for an explainer.

" + } + }, + "ShadowProductionVariants": { + "target": "com.amazonaws.sagemaker#ProductionVariantList", + "traits": { + "smithy.api#documentation": "

An array of ProductionVariant objects, one for each model that you want\n to host at this endpoint in shadow mode with production traffic replicated from the\n model specified on ProductionVariants.

" + } + }, + "ExecutionRoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that you assigned to the\n endpoint configuration.

" + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig" + }, + "EnableNetworkIsolation": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether all model containers deployed to the endpoint are isolated. If they\n are, no inbound or outbound network calls can be made to or from the model\n containers.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeEndpointInput": { + "type": "structure", + "members": { + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the endpoint.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeEndpointOutput": { + "type": "structure", + "members": { + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Name of the endpoint.

", + "smithy.api#required": {} + } + }, + "EndpointArn": { + "target": "com.amazonaws.sagemaker#EndpointArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the endpoint.

", + "smithy.api#required": {} + } + }, + "EndpointConfigName": { + "target": "com.amazonaws.sagemaker#EndpointConfigName", + "traits": { + "smithy.api#documentation": "

The name of the endpoint configuration associated with this endpoint.

" + } + }, + "ProductionVariants": { + "target": "com.amazonaws.sagemaker#ProductionVariantSummaryList", + "traits": { + "smithy.api#documentation": "

An array of ProductionVariantSummary objects, one for each model hosted behind this\n endpoint.

" + } + }, + "DataCaptureConfig": { + "target": "com.amazonaws.sagemaker#DataCaptureConfigSummary" + }, + "EndpointStatus": { + "target": "com.amazonaws.sagemaker#EndpointStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of the endpoint.

\n
    \n
  • \n

    \n OutOfService: Endpoint is not available to take incoming\n requests.

    \n
    • \n
  • \n

    \n Creating: CreateEndpoint is executing.

    \n
    • \n
  • \n

    \n Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.

    \n
    • \n
  • \n

    \n SystemUpdating: Endpoint is undergoing maintenance and cannot be\n updated or deleted or re-scaled until it has completed. This maintenance\n operation does not change any customer-specified values such as VPC config, KMS\n encryption, model, instance type, or instance count.

    \n
    • \n
  • \n

    \n RollingBack: Endpoint fails to scale up or down or change its\n variant weight and is in the process of rolling back to its previous\n configuration. Once the rollback completes, endpoint returns to an\n InService status. This transitional status only applies to an\n endpoint that has autoscaling enabled and is undergoing variant weight or\n capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called\n explicitly.

    \n
    • \n
  • \n

    \n InService: Endpoint is available to process incoming\n requests.

    \n
    • \n
  • \n

    \n Deleting: DeleteEndpoint is executing.

    \n
    • \n
  • \n

    \n Failed: Endpoint could not be created, updated, or re-scaled. Use\n the FailureReason value returned by DescribeEndpoint for information about the failure. DeleteEndpoint is the only operation that can be performed on a\n failed endpoint.

    \n
    • \n
  • \n

    \n UpdateRollbackFailed: Both the rolling deployment and\n auto-rollback failed. Your endpoint is in service with a mix of the old and new\n endpoint configurations. For information about how to remedy this issue and\n restore the endpoint's status to InService, see Rolling\n Deployments.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "

If the status of the endpoint is Failed, the reason why it failed.\n

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A timestamp that shows when the endpoint was created.

", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A timestamp that shows when the endpoint was last modified.

", + "smithy.api#required": {} + } + }, + "LastDeploymentConfig": { + "target": "com.amazonaws.sagemaker#DeploymentConfig", + "traits": { + "smithy.api#documentation": "

The most recent deployment configuration for the endpoint.

" + } + }, + "AsyncInferenceConfig": { + "target": "com.amazonaws.sagemaker#AsyncInferenceConfig", + "traits": { + "smithy.api#documentation": "

Returns the description of an endpoint configuration created using the \n CreateEndpointConfig\n API.

" + } + }, + "PendingDeploymentSummary": { + "target": "com.amazonaws.sagemaker#PendingDeploymentSummary", + "traits": { + "smithy.api#documentation": "

Returns the summary of an in-progress deployment. This field is only returned when the\n endpoint is creating or updating with a new endpoint configuration.

" + } + }, + "ExplainerConfig": { + "target": "com.amazonaws.sagemaker#ExplainerConfig", + "traits": { + "smithy.api#documentation": "

The configuration parameters for an explainer.

" + } + }, + "ShadowProductionVariants": { + "target": "com.amazonaws.sagemaker#ProductionVariantSummaryList", + "traits": { + "smithy.api#documentation": "

An array of ProductionVariantSummary objects, one for each model that you want to host\n at this endpoint in shadow mode with production traffic replicated from the model\n specified on ProductionVariants.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeExperiment": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeExperimentRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeExperimentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Provides a list of an experiment's properties.

" + } + }, + "com.amazonaws.sagemaker#DescribeExperimentRequest": { + "type": "structure", + "members": { + "ExperimentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the experiment to describe.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeExperimentResponse": { + "type": "structure", + "members": { + "ExperimentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

The name of the experiment.

" + } + }, + "ExperimentArn": { + "target": "com.amazonaws.sagemaker#ExperimentArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the experiment.

" + } + }, + "DisplayName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

The name of the experiment as displayed. If DisplayName isn't specified,\n ExperimentName is displayed.

" + } + }, + "Source": { + "target": "com.amazonaws.sagemaker#ExperimentSource", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source and, optionally, the type.

" + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#ExperimentDescription", + "traits": { + "smithy.api#documentation": "

The description of the experiment.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the experiment was created.

" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext", + "traits": { + "smithy.api#documentation": "

Who created the experiment.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the experiment was last modified.

" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext", + "traits": { + "smithy.api#documentation": "

Who last modified the experiment.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeFeatureGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeFeatureGroupRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeFeatureGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Use this operation to describe a FeatureGroup. The response includes\n information on the creation time, FeatureGroup name, the unique identifier for\n each FeatureGroup, and more.

" + } + }, + "com.amazonaws.sagemaker#DescribeFeatureGroupRequest": { + "type": "structure", + "members": { + "FeatureGroupName": { + "target": "com.amazonaws.sagemaker#FeatureGroupNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the FeatureGroup you want\n described.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

A token to resume pagination of the list of Features\n (FeatureDefinitions). 2,500 Features are returned by\n default.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeFeatureGroupResponse": { + "type": "structure", + "members": { + "FeatureGroupArn": { + "target": "com.amazonaws.sagemaker#FeatureGroupArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the FeatureGroup.

", + "smithy.api#required": {} + } + }, + "FeatureGroupName": { + "target": "com.amazonaws.sagemaker#FeatureGroupName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

he name of the FeatureGroup.

", + "smithy.api#required": {} + } + }, + "RecordIdentifierFeatureName": { + "target": "com.amazonaws.sagemaker#FeatureName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Feature used for RecordIdentifier, whose value\n uniquely identifies a record stored in the feature store.

", + "smithy.api#required": {} + } + }, + "EventTimeFeatureName": { + "target": "com.amazonaws.sagemaker#FeatureName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the feature that stores the EventTime of a Record in a\n FeatureGroup.

\n

An EventTime is a point in time when a new event occurs that corresponds\n to the creation or update of a Record in a FeatureGroup. All\n Records in the FeatureGroup have a corresponding\n EventTime.

", + "smithy.api#required": {} + } + }, + "FeatureDefinitions": { + "target": "com.amazonaws.sagemaker#FeatureDefinitions", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A list of the Features in the FeatureGroup. Each feature is\n defined by a FeatureName and FeatureType.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A timestamp indicating when SageMaker created the FeatureGroup.

", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "

A timestamp indicating when the feature group was last updated.

" + } + }, + "OnlineStoreConfig": { + "target": "com.amazonaws.sagemaker#OnlineStoreConfig", + "traits": { + "smithy.api#documentation": "

The configuration for the OnlineStore.

" + } + }, + "OfflineStoreConfig": { + "target": "com.amazonaws.sagemaker#OfflineStoreConfig", + "traits": { + "smithy.api#documentation": "

The configuration of the offline store. It includes the following configurations:

\n
    \n
  • \n

    Amazon S3 location of the offline store.

    \n
    • \n
  • \n

    Configuration of the Glue data catalog.

    \n
    • \n
  • \n

    Table format of the offline store.

    \n
    • \n
  • \n

    Option to disable the automatic creation of a Glue table for the offline\n store.

    \n
    • \n
  • \n

    Encryption configuration.

    \n
    • \n
" + } + }, + "ThroughputConfig": { + "target": "com.amazonaws.sagemaker#ThroughputConfigDescription" + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the\n OfflineStore if an OfflineStoreConfig is provided.

" + } + }, + "FeatureGroupStatus": { + "target": "com.amazonaws.sagemaker#FeatureGroupStatus", + "traits": { + "smithy.api#documentation": "

The status of the feature group.

" + } + }, + "OfflineStoreStatus": { + "target": "com.amazonaws.sagemaker#OfflineStoreStatus", + "traits": { + "smithy.api#documentation": "

The status of the OfflineStore. Notifies you if replicating data into the\n OfflineStore has failed. Returns either: Active or\n Blocked\n

" + } + }, + "LastUpdateStatus": { + "target": "com.amazonaws.sagemaker#LastUpdateStatus", + "traits": { + "smithy.api#documentation": "

A value indicating whether the update made to the feature group was successful.

" + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "

The reason that the FeatureGroup failed to be replicated in the\n OfflineStore. This is failure can occur because:

\n
    \n
  • \n

    The FeatureGroup could not be created in the\n OfflineStore.

    \n
    • \n
  • \n

    The FeatureGroup could not be deleted from the\n OfflineStore.

    \n
    • \n
" + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#Description", + "traits": { + "smithy.api#documentation": "

A free form description of the feature group.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A token to resume pagination of the list of Features\n (FeatureDefinitions).

", + "smithy.api#required": {} + } + }, + "OnlineStoreTotalSizeBytes": { + "target": "com.amazonaws.sagemaker#OnlineStoreTotalSizeBytes", + "traits": { + "smithy.api#documentation": "

The size of the OnlineStore in bytes.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeFeatureMetadata": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeFeatureMetadataRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeFeatureMetadataResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Shows the metadata for a feature within a feature group.

" + } + }, + "com.amazonaws.sagemaker#DescribeFeatureMetadataRequest": { + "type": "structure", + "members": { + "FeatureGroupName": { + "target": "com.amazonaws.sagemaker#FeatureGroupNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the feature group containing the\n feature.

", + "smithy.api#required": {} + } + }, + "FeatureName": { + "target": "com.amazonaws.sagemaker#FeatureName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the feature.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeFeatureMetadataResponse": { + "type": "structure", + "members": { + "FeatureGroupArn": { + "target": "com.amazonaws.sagemaker#FeatureGroupArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the feature group that contains the feature.

", + "smithy.api#required": {} + } + }, + "FeatureGroupName": { + "target": "com.amazonaws.sagemaker#FeatureGroupName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the feature group that you've specified.

", + "smithy.api#required": {} + } + }, + "FeatureName": { + "target": "com.amazonaws.sagemaker#FeatureName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the feature that you've specified.

", + "smithy.api#required": {} + } + }, + "FeatureType": { + "target": "com.amazonaws.sagemaker#FeatureType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The data type of the feature.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A timestamp indicating when the feature was created.

", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A timestamp indicating when the metadata for the feature group was modified. For\n example, if you add a parameter describing the feature, the timestamp changes to reflect\n the last time you

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#FeatureDescription", + "traits": { + "smithy.api#documentation": "

The description you added to describe the feature.

" + } + }, + "Parameters": { + "target": "com.amazonaws.sagemaker#FeatureParameters", + "traits": { + "smithy.api#documentation": "

The key-value pairs that you added to describe the feature.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeFlowDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeFlowDefinitionRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeFlowDefinitionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about the specified flow definition.

" + } + }, + "com.amazonaws.sagemaker#DescribeFlowDefinitionRequest": { + "type": "structure", + "members": { + "FlowDefinitionName": { + "target": "com.amazonaws.sagemaker#FlowDefinitionName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the flow definition.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeFlowDefinitionResponse": { + "type": "structure", + "members": { + "FlowDefinitionArn": { + "target": "com.amazonaws.sagemaker#FlowDefinitionArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the flow defintion.

", + "smithy.api#required": {} + } + }, + "FlowDefinitionName": { + "target": "com.amazonaws.sagemaker#FlowDefinitionName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the flow definition.

", + "smithy.api#required": {} + } + }, + "FlowDefinitionStatus": { + "target": "com.amazonaws.sagemaker#FlowDefinitionStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of the flow definition. Valid values are listed below.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The timestamp when the flow definition was created.

", + "smithy.api#required": {} + } + }, + "HumanLoopRequestSource": { + "target": "com.amazonaws.sagemaker#HumanLoopRequestSource", + "traits": { + "smithy.api#documentation": "

Container for configuring the source of human task requests. Used to specify if\n Amazon Rekognition or Amazon Textract is used as an integration source.

" + } + }, + "HumanLoopActivationConfig": { + "target": "com.amazonaws.sagemaker#HumanLoopActivationConfig", + "traits": { + "smithy.api#documentation": "

An object containing information about what triggers a human review workflow.

" + } + }, + "HumanLoopConfig": { + "target": "com.amazonaws.sagemaker#HumanLoopConfig", + "traits": { + "smithy.api#documentation": "

An object containing information about who works on the task, the workforce task price, and other task details.

" + } + }, + "OutputConfig": { + "target": "com.amazonaws.sagemaker#FlowDefinitionOutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An object containing information about the output file.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) execution role for the flow definition.

", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "

The reason your flow definition failed.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeHub": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeHubRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeHubResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Describes a hub.

" + } + }, + "com.amazonaws.sagemaker#DescribeHubContent": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeHubContentRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeHubContentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Describe the content of a hub.

" + } + }, + "com.amazonaws.sagemaker#DescribeHubContentRequest": { + "type": "structure", + "members": { + "HubName": { + "target": "com.amazonaws.sagemaker#HubNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the hub that contains the content to describe.

", + "smithy.api#required": {} + } + }, + "HubContentType": { + "target": "com.amazonaws.sagemaker#HubContentType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of content in the hub.

", + "smithy.api#required": {} + } + }, + "HubContentName": { + "target": "com.amazonaws.sagemaker#HubContentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the content to describe.

", + "smithy.api#required": {} + } + }, + "HubContentVersion": { + "target": "com.amazonaws.sagemaker#HubContentVersion", + "traits": { + "smithy.api#documentation": "

The version of the content to describe.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeHubContentResponse": { + "type": "structure", + "members": { + "HubContentName": { + "target": "com.amazonaws.sagemaker#HubContentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the hub content.

", + "smithy.api#required": {} + } + }, + "HubContentArn": { + "target": "com.amazonaws.sagemaker#HubContentArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the hub content.

", + "smithy.api#required": {} + } + }, + "HubContentVersion": { + "target": "com.amazonaws.sagemaker#HubContentVersion", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The version of the hub content.

", + "smithy.api#required": {} + } + }, + "HubContentType": { + "target": "com.amazonaws.sagemaker#HubContentType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of hub content.

", + "smithy.api#required": {} + } + }, + "DocumentSchemaVersion": { + "target": "com.amazonaws.sagemaker#DocumentSchemaVersion", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The document schema version for the hub content.

", + "smithy.api#required": {} + } + }, + "HubName": { + "target": "com.amazonaws.sagemaker#HubName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the hub that contains the content.

", + "smithy.api#required": {} + } + }, + "HubArn": { + "target": "com.amazonaws.sagemaker#HubArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the hub that contains the content.

", + "smithy.api#required": {} + } + }, + "HubContentDisplayName": { + "target": "com.amazonaws.sagemaker#HubContentDisplayName", + "traits": { + "smithy.api#documentation": "

The display name of the hub content.

" + } + }, + "HubContentDescription": { + "target": "com.amazonaws.sagemaker#HubContentDescription", + "traits": { + "smithy.api#documentation": "

A description of the hub content.

" + } + }, + "HubContentMarkdown": { + "target": "com.amazonaws.sagemaker#HubContentMarkdown", + "traits": { + "smithy.api#documentation": "

A string that provides a description of the hub content. This string can include links, tables, and standard markdown formating.

" + } + }, + "HubContentDocument": { + "target": "com.amazonaws.sagemaker#HubContentDocument", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The hub content document that describes information about the hub content such as type, associated containers, scripts, and more.

", + "smithy.api#required": {} + } + }, + "SageMakerPublicHubContentArn": { + "target": "com.amazonaws.sagemaker#SageMakerPublicHubContentArn", + "traits": { + "smithy.api#documentation": "

The ARN of the public hub content.

" + } + }, + "ReferenceMinVersion": { + "target": "com.amazonaws.sagemaker#ReferenceMinVersion", + "traits": { + "smithy.api#documentation": "

The minimum version of the hub content.

" + } + }, + "SupportStatus": { + "target": "com.amazonaws.sagemaker#HubContentSupportStatus", + "traits": { + "smithy.api#documentation": "

The support status of the hub content.

" + } + }, + "HubContentSearchKeywords": { + "target": "com.amazonaws.sagemaker#HubContentSearchKeywordList", + "traits": { + "smithy.api#documentation": "

The searchable keywords for the hub content.

" + } + }, + "HubContentDependencies": { + "target": "com.amazonaws.sagemaker#HubContentDependencyList", + "traits": { + "smithy.api#documentation": "

The location of any dependencies that the hub content has, such as scripts, model artifacts, datasets, or notebooks.

" + } + }, + "HubContentStatus": { + "target": "com.amazonaws.sagemaker#HubContentStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of the hub content.

", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "

The failure reason if importing hub content failed.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The date and time that hub content was created.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeHubRequest": { + "type": "structure", + "members": { + "HubName": { + "target": "com.amazonaws.sagemaker#HubNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the hub to describe.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeHubResponse": { + "type": "structure", + "members": { + "HubName": { + "target": "com.amazonaws.sagemaker#HubName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the hub.

", + "smithy.api#required": {} + } + }, + "HubArn": { + "target": "com.amazonaws.sagemaker#HubArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the hub.

", + "smithy.api#required": {} + } + }, + "HubDisplayName": { + "target": "com.amazonaws.sagemaker#HubDisplayName", + "traits": { + "smithy.api#documentation": "

The display name of the hub.

" + } + }, + "HubDescription": { + "target": "com.amazonaws.sagemaker#HubDescription", + "traits": { + "smithy.api#documentation": "

A description of the hub.

" + } + }, + "HubSearchKeywords": { + "target": "com.amazonaws.sagemaker#HubSearchKeywordList", + "traits": { + "smithy.api#documentation": "

The searchable keywords for the hub.

" + } + }, + "S3StorageConfig": { + "target": "com.amazonaws.sagemaker#HubS3StorageConfig", + "traits": { + "smithy.api#documentation": "

The Amazon S3 storage configuration for the hub.

" + } + }, + "HubStatus": { + "target": "com.amazonaws.sagemaker#HubStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of the hub.

", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "

The failure reason if importing hub content failed.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The date and time that the hub was created.

", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The date and time that the hub was last modified.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeHumanTaskUi": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeHumanTaskUiRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeHumanTaskUiResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about the requested human task user interface (worker task template).

" + } + }, + "com.amazonaws.sagemaker#DescribeHumanTaskUiRequest": { + "type": "structure", + "members": { + "HumanTaskUiName": { + "target": "com.amazonaws.sagemaker#HumanTaskUiName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the human task user interface \n (worker task template) you want information about.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeHumanTaskUiResponse": { + "type": "structure", + "members": { + "HumanTaskUiArn": { + "target": "com.amazonaws.sagemaker#HumanTaskUiArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the human task user interface (worker task template).

", + "smithy.api#required": {} + } + }, + "HumanTaskUiName": { + "target": "com.amazonaws.sagemaker#HumanTaskUiName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the human task user interface (worker task template).

", + "smithy.api#required": {} + } + }, + "HumanTaskUiStatus": { + "target": "com.amazonaws.sagemaker#HumanTaskUiStatus", + "traits": { + "smithy.api#documentation": "

The status of the human task user interface (worker task template). Valid values are listed below.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The timestamp when the human task user interface was created.

", + "smithy.api#required": {} + } + }, + "UiTemplate": { + "target": "com.amazonaws.sagemaker#UiTemplateInfo", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeHyperParameterTuningJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeHyperParameterTuningJobRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeHyperParameterTuningJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a description of a hyperparameter tuning job, depending on the fields\n selected. These fields can include the name, Amazon Resource Name (ARN), job status of\n your tuning job and more.

" + } + }, + "com.amazonaws.sagemaker#DescribeHyperParameterTuningJobRequest": { + "type": "structure", + "members": { + "HyperParameterTuningJobName": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the tuning job.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeHyperParameterTuningJobResponse": { + "type": "structure", + "members": { + "HyperParameterTuningJobName": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the hyperparameter tuning job.

", + "smithy.api#required": {} + } + }, + "HyperParameterTuningJobArn": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the tuning job.

", + "smithy.api#required": {} + } + }, + "HyperParameterTuningJobConfig": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The HyperParameterTuningJobConfig object that specifies the configuration of\n the tuning job.

", + "smithy.api#required": {} + } + }, + "TrainingJobDefinition": { + "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinition", + "traits": { + "smithy.api#documentation": "

The HyperParameterTrainingJobDefinition object that specifies the definition of\n the training jobs that this tuning job launches.

" + } + }, + "TrainingJobDefinitions": { + "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinitions", + "traits": { + "smithy.api#documentation": "

A list of the HyperParameterTrainingJobDefinition objects launched for this tuning\n job.

" + } + }, + "HyperParameterTuningJobStatus": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of the tuning job.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The date and time that the tuning job started.

", + "smithy.api#required": {} + } + }, + "HyperParameterTuningEndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the tuning job ended.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the status of the tuning job was modified.

" + } + }, + "TrainingJobStatusCounters": { + "target": "com.amazonaws.sagemaker#TrainingJobStatusCounters", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The TrainingJobStatusCounters object that specifies the number of training\n jobs, categorized by status, that this tuning job launched.

", + "smithy.api#required": {} + } + }, + "ObjectiveStatusCounters": { + "target": "com.amazonaws.sagemaker#ObjectiveStatusCounters", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ObjectiveStatusCounters object that specifies the number of training jobs,\n categorized by the status of their final objective metric, that this tuning job\n launched.

", + "smithy.api#required": {} + } + }, + "BestTrainingJob": { + "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobSummary", + "traits": { + "smithy.api#documentation": "

A TrainingJobSummary object that describes the training job that completed\n with the best current HyperParameterTuningJobObjective.

" + } + }, + "OverallBestTrainingJob": { + "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobSummary", + "traits": { + "smithy.api#documentation": "

If the hyperparameter tuning job is an warm start tuning job with a\n WarmStartType of IDENTICAL_DATA_AND_ALGORITHM, this is the\n TrainingJobSummary for the training job with the best objective metric\n value of all training jobs launched by this tuning job and all parent jobs specified for\n the warm start tuning job.

" + } + }, + "WarmStartConfig": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobWarmStartConfig", + "traits": { + "smithy.api#documentation": "

The configuration for starting the hyperparameter parameter tuning job using one or\n more previous tuning jobs as a starting point. The results of previous tuning jobs are\n used to inform which combinations of hyperparameters to search over in the new tuning\n job.

" + } + }, + "Autotune": { + "target": "com.amazonaws.sagemaker#Autotune", + "traits": { + "smithy.api#documentation": "

A flag to indicate if autotune is enabled for the hyperparameter tuning job.

" + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "

If the tuning job failed, the reason it failed.

" + } + }, + "TuningJobCompletionDetails": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobCompletionDetails", + "traits": { + "smithy.api#documentation": "

Tuning job completion information returned as the response from a hyperparameter\n tuning job. This information tells if your tuning job has or has not converged. It also\n includes the number of training jobs that have not improved model performance as\n evaluated against the objective function.

" + } + }, + "ConsumedResources": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobConsumedResources" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeImageRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeImageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Describes a SageMaker AI image.

", + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "ImageCreated": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "ImageStatus", + "expected": "CREATED", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ImageStatus", + "expected": "CREATE_FAILED", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "errorType": "ValidationException" + } + } + ], + "minDelay": 60 + }, + "ImageDeleted": { + "acceptors": [ + { + "state": "success", + "matcher": { + "errorType": "ResourceNotFoundException" + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ImageStatus", + "expected": "DELETE_FAILED", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "errorType": "ValidationException" + } + } + ], + "minDelay": 60 + }, + "ImageUpdated": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "ImageStatus", + "expected": "CREATED", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ImageStatus", + "expected": "UPDATE_FAILED", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "errorType": "ValidationException" + } + } + ], + "minDelay": 60 + } + } + } + }, + "com.amazonaws.sagemaker#DescribeImageRequest": { + "type": "structure", + "members": { + "ImageName": { + "target": "com.amazonaws.sagemaker#ImageName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the image to describe.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeImageResponse": { + "type": "structure", + "members": { + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the image was created.

" + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#ImageDescription", + "traits": { + "smithy.api#documentation": "

The description of the image.

" + } + }, + "DisplayName": { + "target": "com.amazonaws.sagemaker#ImageDisplayName", + "traits": { + "smithy.api#documentation": "

The name of the image as displayed.

" + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "

When a create, update, or delete operation fails, the reason for the failure.

" + } + }, + "ImageArn": { + "target": "com.amazonaws.sagemaker#ImageArn", + "traits": { + "smithy.api#documentation": "

The ARN of the image.

" + } + }, + "ImageName": { + "target": "com.amazonaws.sagemaker#ImageName", + "traits": { + "smithy.api#documentation": "

The name of the image.

" + } + }, + "ImageStatus": { + "target": "com.amazonaws.sagemaker#ImageStatus", + "traits": { + "smithy.api#documentation": "

The status of the image.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the image was last modified.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeImageVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeImageVersionRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeImageVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Describes a version of a SageMaker AI image.

", + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "ImageVersionCreated": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "ImageVersionStatus", + "expected": "CREATED", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ImageVersionStatus", + "expected": "CREATE_FAILED", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "errorType": "ValidationException" + } + } + ], + "minDelay": 60 + }, + "ImageVersionDeleted": { + "acceptors": [ + { + "state": "success", + "matcher": { + "errorType": "ResourceNotFoundException" + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ImageVersionStatus", + "expected": "DELETE_FAILED", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "errorType": "ValidationException" + } + } + ], + "minDelay": 60 + } + } + } + }, + "com.amazonaws.sagemaker#DescribeImageVersionRequest": { + "type": "structure", + "members": { + "ImageName": { + "target": "com.amazonaws.sagemaker#ImageName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the image.

", + "smithy.api#required": {} + } + }, + "Version": { + "target": "com.amazonaws.sagemaker#ImageVersionNumber", + "traits": { + "smithy.api#documentation": "

The version of the image. If not specified, the latest version is described.

" + } + }, + "Alias": { + "target": "com.amazonaws.sagemaker#SageMakerImageVersionAlias", + "traits": { + "smithy.api#documentation": "

The alias of the image version.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeImageVersionResponse": { + "type": "structure", + "members": { + "BaseImage": { + "target": "com.amazonaws.sagemaker#ImageBaseImage", + "traits": { + "smithy.api#documentation": "

The registry path of the container image on which this image version is based.

" + } + }, + "ContainerImage": { + "target": "com.amazonaws.sagemaker#ImageContainerImage", + "traits": { + "smithy.api#documentation": "

The registry path of the container image that contains this image version.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the version was created.

" + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "

When a create or delete operation fails, the reason for the failure.

" + } + }, + "ImageArn": { + "target": "com.amazonaws.sagemaker#ImageArn", + "traits": { + "smithy.api#documentation": "

The ARN of the image the version is based on.

" + } + }, + "ImageVersionArn": { + "target": "com.amazonaws.sagemaker#ImageVersionArn", + "traits": { + "smithy.api#documentation": "

The ARN of the version.

" + } + }, + "ImageVersionStatus": { + "target": "com.amazonaws.sagemaker#ImageVersionStatus", + "traits": { + "smithy.api#documentation": "

The status of the version.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the version was last modified.

" + } + }, + "Version": { + "target": "com.amazonaws.sagemaker#ImageVersionNumber", + "traits": { + "smithy.api#documentation": "

The version number.

" + } + }, + "VendorGuidance": { + "target": "com.amazonaws.sagemaker#VendorGuidance", + "traits": { + "smithy.api#documentation": "

The stability of the image version specified by the maintainer.

\n
    \n
  • \n

    \n NOT_PROVIDED: The maintainers did not provide a status for image version stability.

    \n
    • \n
  • \n

    \n STABLE: The image version is stable.

    \n
    • \n
  • \n

    \n TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.

    \n
    • \n
  • \n

    \n ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.

    \n
    • \n
" + } + }, + "JobType": { + "target": "com.amazonaws.sagemaker#JobType", + "traits": { + "smithy.api#documentation": "

Indicates SageMaker AI job type compatibility.

\n
    \n
  • \n

    \n TRAINING: The image version is compatible with SageMaker AI training jobs.

    \n
    • \n
  • \n

    \n INFERENCE: The image version is compatible with SageMaker AI inference jobs.

    \n
    • \n
  • \n

    \n NOTEBOOK_KERNEL: The image version is compatible with SageMaker AI notebook kernels.

    \n
    • \n
" + } + }, + "MLFramework": { + "target": "com.amazonaws.sagemaker#MLFramework", + "traits": { + "smithy.api#documentation": "

The machine learning framework vended in the image version.

" + } + }, + "ProgrammingLang": { + "target": "com.amazonaws.sagemaker#ProgrammingLang", + "traits": { + "smithy.api#documentation": "

The supported programming language and its version.

" + } + }, + "Processor": { + "target": "com.amazonaws.sagemaker#Processor", + "traits": { + "smithy.api#documentation": "

Indicates CPU or GPU compatibility.

\n
    \n
  • \n

    \n CPU: The image version is compatible with CPU.

    \n
    • \n
  • \n

    \n GPU: The image version is compatible with GPU.

    \n
    • \n
" + } + }, + "Horovod": { + "target": "com.amazonaws.sagemaker#Horovod", + "traits": { + "smithy.api#documentation": "

Indicates Horovod compatibility.

" + } + }, + "ReleaseNotes": { + "target": "com.amazonaws.sagemaker#ReleaseNotes", + "traits": { + "smithy.api#documentation": "

The maintainer description of the image version.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeInferenceComponent": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeInferenceComponentInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeInferenceComponentOutput" + }, + "traits": { + "smithy.api#documentation": "

Returns information about an inference component.

" + } + }, + "com.amazonaws.sagemaker#DescribeInferenceComponentInput": { + "type": "structure", + "members": { + "InferenceComponentName": { + "target": "com.amazonaws.sagemaker#InferenceComponentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the inference component.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeInferenceComponentOutput": { + "type": "structure", + "members": { + "InferenceComponentName": { + "target": "com.amazonaws.sagemaker#InferenceComponentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the inference component.

", + "smithy.api#required": {} + } + }, + "InferenceComponentArn": { + "target": "com.amazonaws.sagemaker#InferenceComponentArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the inference component.

", + "smithy.api#required": {} + } + }, + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the endpoint that hosts the inference component.

", + "smithy.api#required": {} + } + }, + "EndpointArn": { + "target": "com.amazonaws.sagemaker#EndpointArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.

", + "smithy.api#required": {} + } + }, + "VariantName": { + "target": "com.amazonaws.sagemaker#VariantName", + "traits": { + "smithy.api#documentation": "

The name of the production variant that hosts the inference component.

" + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "

If the inference component status is Failed, the reason for the\n failure.

" + } + }, + "Specification": { + "target": "com.amazonaws.sagemaker#InferenceComponentSpecificationSummary", + "traits": { + "smithy.api#documentation": "

Details about the resources that are deployed with this inference component.

" + } + }, + "RuntimeConfig": { + "target": "com.amazonaws.sagemaker#InferenceComponentRuntimeConfigSummary", + "traits": { + "smithy.api#documentation": "

Details about the runtime settings for the model that is deployed with the inference\n component.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The time when the inference component was created.

", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The time when the inference component was last updated.

", + "smithy.api#required": {} + } + }, + "InferenceComponentStatus": { + "target": "com.amazonaws.sagemaker#InferenceComponentStatus", + "traits": { + "smithy.api#documentation": "

The status of the inference component.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeInferenceExperiment": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeInferenceExperimentRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeInferenceExperimentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Returns details about an inference experiment.

" + } + }, + "com.amazonaws.sagemaker#DescribeInferenceExperimentRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#InferenceExperimentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the inference experiment to describe.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeInferenceExperimentResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#InferenceExperimentArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the inference experiment being described.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.sagemaker#InferenceExperimentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the inference experiment.

", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.sagemaker#InferenceExperimentType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of the inference experiment.

", + "smithy.api#required": {} + } + }, + "Schedule": { + "target": "com.amazonaws.sagemaker#InferenceExperimentSchedule", + "traits": { + "smithy.api#documentation": "

The duration for which the inference experiment ran or will run.

" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#InferenceExperimentStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

\n The status of the inference experiment. The following are the possible statuses for an inference\n experiment:\n

\n
    \n
  • \n

    \n Creating - Amazon SageMaker is creating your experiment.\n

    \n
    • \n
  • \n

    \n Created - Amazon SageMaker has finished the creation of your experiment and will begin the\n experiment at the scheduled time.\n

    \n
    • \n
  • \n

    \n Updating - When you make changes to your experiment, your experiment shows as updating.\n

    \n
    • \n
  • \n

    \n Starting - Amazon SageMaker is beginning your experiment.\n

    \n
    • \n
  • \n

    \n Running - Your experiment is in progress.\n

    \n
    • \n
  • \n

    \n Stopping - Amazon SageMaker is stopping your experiment.\n

    \n
    • \n
  • \n

    \n Completed - Your experiment has completed.\n

    \n
    • \n
  • \n

    \n Cancelled - When you conclude your experiment early using the StopInferenceExperiment API, or if any operation fails with an unexpected error, it shows\n as cancelled.\n

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "StatusReason": { + "target": "com.amazonaws.sagemaker#InferenceExperimentStatusReason", + "traits": { + "smithy.api#documentation": "

\n The error message or client-specified Reason from the StopInferenceExperiment\n API, that explains the status of the inference experiment.\n

" + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#InferenceExperimentDescription", + "traits": { + "smithy.api#documentation": "

The description of the inference experiment.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp at which you created the inference experiment.

" + } + }, + "CompletionTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The timestamp at which the inference experiment was completed.\n

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp at which you last modified the inference experiment.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "

\n The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage\n Amazon SageMaker Inference endpoints for model deployment.\n

" + } + }, + "EndpointMetadata": { + "target": "com.amazonaws.sagemaker#EndpointMetadata", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The metadata of the endpoint on which the inference experiment ran.

", + "smithy.api#required": {} + } + }, + "ModelVariants": { + "target": "com.amazonaws.sagemaker#ModelVariantConfigSummaryList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

\n An array of ModelVariantConfigSummary objects. There is one for each variant in the inference\n experiment. Each ModelVariantConfigSummary object in the array describes the infrastructure\n configuration for deploying the corresponding variant.\n

", + "smithy.api#required": {} + } + }, + "DataStorageConfig": { + "target": "com.amazonaws.sagemaker#InferenceExperimentDataStorageConfig", + "traits": { + "smithy.api#documentation": "

The Amazon S3 location and configuration for storing inference request and response data.

" + } + }, + "ShadowModeConfig": { + "target": "com.amazonaws.sagemaker#ShadowModeConfig", + "traits": { + "smithy.api#documentation": "

\n The configuration of ShadowMode inference experiment type, which shows the production variant\n that takes all the inference requests, and the shadow variant to which Amazon SageMaker replicates a percentage of the\n inference requests. For the shadow variant it also shows the percentage of requests that Amazon SageMaker replicates.\n

" + } + }, + "KmsKey": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

\n The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on\n the storage volume attached to the ML compute instance that hosts the endpoint. For more information, see\n CreateInferenceExperiment.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeInferenceRecommendationsJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeInferenceRecommendationsJobRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeInferenceRecommendationsJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Provides the results of the Inference Recommender job. \n One or more recommendation jobs are returned.

" + } + }, + "com.amazonaws.sagemaker#DescribeInferenceRecommendationsJobRequest": { + "type": "structure", + "members": { + "JobName": { + "target": "com.amazonaws.sagemaker#RecommendationJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the job. The name must be unique within an \n Amazon Web Services Region in the Amazon Web Services account.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeInferenceRecommendationsJobResponse": { + "type": "structure", + "members": { + "JobName": { + "target": "com.amazonaws.sagemaker#RecommendationJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the job. The name must be unique within an \n Amazon Web Services Region in the Amazon Web Services account.

", + "smithy.api#required": {} + } + }, + "JobDescription": { + "target": "com.amazonaws.sagemaker#RecommendationJobDescription", + "traits": { + "smithy.api#documentation": "

The job description that you provided when you initiated the job.

" + } + }, + "JobType": { + "target": "com.amazonaws.sagemaker#RecommendationJobType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The job type that you provided when you initiated the job.

", + "smithy.api#required": {} + } + }, + "JobArn": { + "target": "com.amazonaws.sagemaker#RecommendationJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the job.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services \n Identity and Access Management (IAM) role you provided when you initiated the job.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#RecommendationJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of the job.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A timestamp that shows when the job was created.

", + "smithy.api#required": {} + } + }, + "CompletionTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A timestamp that shows when the job completed.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A timestamp that shows when the job was last modified.

", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "

If the job fails, provides information why the job failed.

" + } + }, + "InputConfig": { + "target": "com.amazonaws.sagemaker#RecommendationJobInputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Returns information about the versioned model package Amazon Resource Name (ARN), \n the traffic pattern, and endpoint configurations you provided when you initiated the job.

", + "smithy.api#required": {} + } + }, + "StoppingConditions": { + "target": "com.amazonaws.sagemaker#RecommendationJobStoppingConditions", + "traits": { + "smithy.api#documentation": "

The stopping conditions that you provided when you initiated the job.

" + } + }, + "InferenceRecommendations": { + "target": "com.amazonaws.sagemaker#InferenceRecommendations", + "traits": { + "smithy.api#documentation": "

The recommendations made by Inference Recommender.

" + } + }, + "EndpointPerformances": { + "target": "com.amazonaws.sagemaker#EndpointPerformances", + "traits": { + "smithy.api#documentation": "

The performance results from running an Inference Recommender job on an existing endpoint.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeLabelingJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeLabelingJobRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeLabelingJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about a labeling job.

" + } + }, + "com.amazonaws.sagemaker#DescribeLabelingJobRequest": { + "type": "structure", + "members": { + "LabelingJobName": { + "target": "com.amazonaws.sagemaker#LabelingJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the labeling job to return information for.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeLabelingJobResponse": { + "type": "structure", + "members": { + "LabelingJobStatus": { + "target": "com.amazonaws.sagemaker#LabelingJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The processing status of the labeling job.

", + "smithy.api#required": {} + } + }, + "LabelCounters": { + "target": "com.amazonaws.sagemaker#LabelCounters", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Provides a breakdown of the number of data objects labeled by humans, the number of\n objects labeled by machine, the number of objects than couldn't be labeled, and the\n total number of objects labeled.

", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "

If the job failed, the reason that it failed.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The date and time that the labeling job was created.

", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The date and time that the labeling job was last updated.

", + "smithy.api#required": {} + } + }, + "JobReferenceCode": { + "target": "com.amazonaws.sagemaker#JobReferenceCode", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A unique identifier for work done as part of a labeling job.

", + "smithy.api#required": {} + } + }, + "LabelingJobName": { + "target": "com.amazonaws.sagemaker#LabelingJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name assigned to the labeling job when it was created.

", + "smithy.api#required": {} + } + }, + "LabelingJobArn": { + "target": "com.amazonaws.sagemaker#LabelingJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the labeling job.

", + "smithy.api#required": {} + } + }, + "LabelAttributeName": { + "target": "com.amazonaws.sagemaker#LabelAttributeName", + "traits": { + "smithy.api#documentation": "

The attribute used as the label in the output manifest file.

" + } + }, + "InputConfig": { + "target": "com.amazonaws.sagemaker#LabelingJobInputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Input configuration information for the labeling job, such as the Amazon S3 location of the\n data objects and the location of the manifest file that describes the data\n objects.

", + "smithy.api#required": {} + } + }, + "OutputConfig": { + "target": "com.amazonaws.sagemaker#LabelingJobOutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The location of the job's output data and the Amazon Web Services Key Management\n Service key ID for the key used to encrypt the output data, if any.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf\n during data labeling.

", + "smithy.api#required": {} + } + }, + "LabelCategoryConfigS3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "

The S3 location of the JSON file that defines the categories used to label data\n objects. Please note the following label-category limits:

\n
    \n
  • \n

    Semantic segmentation labeling jobs using automated labeling: 20 labels

    \n
    • \n
  • \n

    Box bounding labeling jobs (all): 10 labels

    \n
    • \n
\n

The file is a JSON structure in the following format:

\n

\n {\n

\n

\n \"document-version\": \"2018-11-28\"\n

\n

\n \"labels\": [\n

\n

\n {\n

\n

\n \"label\": \"label 1\"\n

\n

\n },\n

\n

\n {\n

\n

\n \"label\": \"label 2\"\n

\n

\n },\n

\n

\n ...\n

\n

\n {\n

\n

\n \"label\": \"label n\"\n

\n

\n }\n

\n

\n ]\n

\n

\n }\n

" + } + }, + "StoppingConditions": { + "target": "com.amazonaws.sagemaker#LabelingJobStoppingConditions", + "traits": { + "smithy.api#documentation": "

A set of conditions for stopping a labeling job. If any of the conditions are met, the\n job is automatically stopped.

" + } + }, + "LabelingJobAlgorithmsConfig": { + "target": "com.amazonaws.sagemaker#LabelingJobAlgorithmsConfig", + "traits": { + "smithy.api#documentation": "

Configuration information for automated data labeling.

" + } + }, + "HumanTaskConfig": { + "target": "com.amazonaws.sagemaker#HumanTaskConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Configuration information required for human workers to complete a labeling\n task.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.

" + } + }, + "LabelingJobOutput": { + "target": "com.amazonaws.sagemaker#LabelingJobOutput", + "traits": { + "smithy.api#documentation": "

The location of the output produced by the labeling job.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeLineageGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeLineageGroupRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeLineageGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Provides a list of properties for the requested lineage group. \n For more information, see \n Cross-Account Lineage Tracking in the Amazon SageMaker Developer Guide.

" + } + }, + "com.amazonaws.sagemaker#DescribeLineageGroupRequest": { + "type": "structure", + "members": { + "LineageGroupName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the lineage group.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeLineageGroupResponse": { + "type": "structure", + "members": { + "LineageGroupName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

The name of the lineage group.

" + } + }, + "LineageGroupArn": { + "target": "com.amazonaws.sagemaker#LineageGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the lineage group.

" + } + }, + "DisplayName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

The display name of the lineage group.

" + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#ExperimentDescription", + "traits": { + "smithy.api#documentation": "

The description of the lineage group.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The creation time of lineage group.

" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The last modified time of the lineage group.

" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeMlflowTrackingServer": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeMlflowTrackingServerRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeMlflowTrackingServerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about an MLflow Tracking Server.

" + } + }, + "com.amazonaws.sagemaker#DescribeMlflowTrackingServerRequest": { + "type": "structure", + "members": { + "TrackingServerName": { + "target": "com.amazonaws.sagemaker#TrackingServerName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the MLflow Tracking Server to describe.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeMlflowTrackingServerResponse": { + "type": "structure", + "members": { + "TrackingServerArn": { + "target": "com.amazonaws.sagemaker#TrackingServerArn", + "traits": { + "smithy.api#documentation": "

The ARN of the described tracking server.

" + } + }, + "TrackingServerName": { + "target": "com.amazonaws.sagemaker#TrackingServerName", + "traits": { + "smithy.api#documentation": "

The name of the described tracking server.

" + } + }, + "ArtifactStoreUri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "

The S3 URI of the general purpose bucket used as the MLflow Tracking Server\n artifact store.

" + } + }, + "TrackingServerSize": { + "target": "com.amazonaws.sagemaker#TrackingServerSize", + "traits": { + "smithy.api#documentation": "

The size of the described tracking server.

" + } + }, + "MlflowVersion": { + "target": "com.amazonaws.sagemaker#MlflowVersion", + "traits": { + "smithy.api#documentation": "

The MLflow version used for the described tracking server.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for an IAM role in your account that the described MLflow Tracking Server\n uses to access the artifact store in Amazon S3.

" + } + }, + "TrackingServerStatus": { + "target": "com.amazonaws.sagemaker#TrackingServerStatus", + "traits": { + "smithy.api#documentation": "

The current creation status of the described MLflow Tracking Server.

" + } + }, + "IsActive": { + "target": "com.amazonaws.sagemaker#IsTrackingServerActive", + "traits": { + "smithy.api#documentation": "

Whether the described MLflow Tracking Server is currently active.

" + } + }, + "TrackingServerUrl": { + "target": "com.amazonaws.sagemaker#TrackingServerUrl", + "traits": { + "smithy.api#documentation": "

The URL to connect to the MLflow user interface for the described tracking server.

" + } + }, + "WeeklyMaintenanceWindowStart": { + "target": "com.amazonaws.sagemaker#WeeklyMaintenanceWindowStart", + "traits": { + "smithy.api#documentation": "

The day and time of the week when weekly maintenance occurs on the described tracking server.

" + } + }, + "AutomaticModelRegistration": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

Whether automatic registration of new MLflow models to the SageMaker Model Registry is enabled.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the described MLflow Tracking Server was created.

" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the described MLflow Tracking Server was last modified.

" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeModelInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeModelOutput" + }, + "traits": { + "smithy.api#documentation": "

Describes a model that you created using the CreateModel\n API.

" + } + }, + "com.amazonaws.sagemaker#DescribeModelBiasJobDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeModelBiasJobDefinitionRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeModelBiasJobDefinitionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a description of a model bias job definition.

" + } + }, + "com.amazonaws.sagemaker#DescribeModelBiasJobDefinitionRequest": { + "type": "structure", + "members": { + "JobDefinitionName": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the model bias job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeModelBiasJobDefinitionResponse": { + "type": "structure", + "members": { + "JobDefinitionArn": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model bias job.

", + "smithy.api#required": {} + } + }, + "JobDefinitionName": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the bias job definition. The name must be unique within an Amazon Web Services \n Region in the Amazon Web Services account.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The time at which the model bias job was created.

", + "smithy.api#required": {} + } + }, + "ModelBiasBaselineConfig": { + "target": "com.amazonaws.sagemaker#ModelBiasBaselineConfig", + "traits": { + "smithy.api#documentation": "

The baseline configuration for a model bias job.

" + } + }, + "ModelBiasAppSpecification": { + "target": "com.amazonaws.sagemaker#ModelBiasAppSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Configures the model bias job to run a specified Docker container image.

", + "smithy.api#required": {} + } + }, + "ModelBiasJobInput": { + "target": "com.amazonaws.sagemaker#ModelBiasJobInput", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Inputs for the model bias job.

", + "smithy.api#required": {} + } + }, + "ModelBiasJobOutputConfig": { + "target": "com.amazonaws.sagemaker#MonitoringOutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "JobResources": { + "target": "com.amazonaws.sagemaker#MonitoringResources", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "NetworkConfig": { + "target": "com.amazonaws.sagemaker#MonitoringNetworkConfig", + "traits": { + "smithy.api#documentation": "

Networking options for a model bias job.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that has read permission to the \n input data location and write permission to the output data location in Amazon S3.

", + "smithy.api#required": {} + } + }, + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#MonitoringStoppingCondition" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeModelCard": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeModelCardRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeModelCardResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the content, creation time, and security configuration of an Amazon SageMaker Model Card.

" + } + }, + "com.amazonaws.sagemaker#DescribeModelCardExportJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeModelCardExportJobRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeModelCardExportJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Describes an Amazon SageMaker Model Card export job.

" + } + }, + "com.amazonaws.sagemaker#DescribeModelCardExportJobRequest": { + "type": "structure", + "members": { + "ModelCardExportJobArn": { + "target": "com.amazonaws.sagemaker#ModelCardExportJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model card export job to describe.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeModelCardExportJobResponse": { + "type": "structure", + "members": { + "ModelCardExportJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the model card export job to describe.

", + "smithy.api#required": {} + } + }, + "ModelCardExportJobArn": { + "target": "com.amazonaws.sagemaker#ModelCardExportJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model card export job.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#ModelCardExportJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The completion status of the model card export job.

\n
    \n
  • \n

    \n InProgress: The model card export job is in progress.

    \n
    • \n
  • \n

    \n Completed: The model card export job is complete.

    \n
    • \n
  • \n

    \n Failed: The model card export job failed. To see the reason for the failure, see\n the FailureReason field in the response to a\n DescribeModelCardExportJob call.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "ModelCardName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the model card that the model export job exports.

", + "smithy.api#required": {} + } + }, + "ModelCardVersion": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The version of the model card that the model export job exports.

", + "smithy.api#required": {} + } + }, + "OutputConfig": { + "target": "com.amazonaws.sagemaker#ModelCardExportOutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The export output details for the model card.

", + "smithy.api#required": {} + } + }, + "CreatedAt": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The date and time that the model export job was created.

", + "smithy.api#required": {} + } + }, + "LastModifiedAt": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The date and time that the model export job was last modified.

", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "

The failure reason if the model export job fails.

" + } + }, + "ExportArtifacts": { + "target": "com.amazonaws.sagemaker#ModelCardExportArtifacts", + "traits": { + "smithy.api#documentation": "

The exported model card artifacts.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeModelCardRequest": { + "type": "structure", + "members": { + "ModelCardName": { + "target": "com.amazonaws.sagemaker#ModelCardNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the model card to describe.

", + "smithy.api#required": {} + } + }, + "ModelCardVersion": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "

The version of the model card to describe. If a version is not provided, then the latest version of the model card is described.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeModelCardResponse": { + "type": "structure", + "members": { + "ModelCardArn": { + "target": "com.amazonaws.sagemaker#ModelCardArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model card.

", + "smithy.api#required": {} + } + }, + "ModelCardName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the model card.

", + "smithy.api#required": {} + } + }, + "ModelCardVersion": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The version of the model card.

", + "smithy.api#required": {} + } + }, + "Content": { + "target": "com.amazonaws.sagemaker#ModelCardContent", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The content of the model card.

", + "smithy.api#required": {} + } + }, + "ModelCardStatus": { + "target": "com.amazonaws.sagemaker#ModelCardStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

\n
    \n
  • \n

    \n Draft: The model card is a work in progress.

    \n
    • \n
  • \n

    \n PendingReview: The model card is pending review.

    \n
    • \n
  • \n

    \n Approved: The model card is approved.

    \n
    • \n
  • \n

    \n Archived: The model card is archived. No more updates should be made to the model\n card, but it can still be exported.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "SecurityConfig": { + "target": "com.amazonaws.sagemaker#ModelCardSecurityConfig", + "traits": { + "smithy.api#documentation": "

The security configuration used to protect model card content.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The date and time the model card was created.

", + "smithy.api#required": {} + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time the model card was last modified.

" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "ModelCardProcessingStatus": { + "target": "com.amazonaws.sagemaker#ModelCardProcessingStatus", + "traits": { + "smithy.api#documentation": "

The processing status of model card deletion. The ModelCardProcessingStatus updates throughout the different deletion steps.

\n
    \n
  • \n

    \n DeletePending: Model card deletion request received.

    \n
    • \n
  • \n

    \n DeleteInProgress: Model card deletion is in progress.

    \n
    • \n
  • \n

    \n ContentDeleted: Deleted model card content.

    \n
    • \n
  • \n

    \n ExportJobsDeleted: Deleted all export jobs associated with the model card.

    \n
    • \n
  • \n

    \n DeleteCompleted: Successfully deleted the model card.

    \n
    • \n
  • \n

    \n DeleteFailed: The model card failed to delete.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeModelExplainabilityJobDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeModelExplainabilityJobDefinitionRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeModelExplainabilityJobDefinitionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a description of a model explainability job definition.

" + } + }, + "com.amazonaws.sagemaker#DescribeModelExplainabilityJobDefinitionRequest": { + "type": "structure", + "members": { + "JobDefinitionName": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the model explainability job definition. The name must be unique within an\n Amazon Web Services Region in the Amazon Web Services account.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeModelExplainabilityJobDefinitionResponse": { + "type": "structure", + "members": { + "JobDefinitionArn": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model explainability job.

", + "smithy.api#required": {} + } + }, + "JobDefinitionName": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The time at which the model explainability job was created.

", + "smithy.api#required": {} + } + }, + "ModelExplainabilityBaselineConfig": { + "target": "com.amazonaws.sagemaker#ModelExplainabilityBaselineConfig", + "traits": { + "smithy.api#documentation": "

The baseline configuration for a model explainability job.

" + } + }, + "ModelExplainabilityAppSpecification": { + "target": "com.amazonaws.sagemaker#ModelExplainabilityAppSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Configures the model explainability job to run a specified Docker container image.

", + "smithy.api#required": {} + } + }, + "ModelExplainabilityJobInput": { + "target": "com.amazonaws.sagemaker#ModelExplainabilityJobInput", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Inputs for the model explainability job.

", + "smithy.api#required": {} + } + }, + "ModelExplainabilityJobOutputConfig": { + "target": "com.amazonaws.sagemaker#MonitoringOutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "JobResources": { + "target": "com.amazonaws.sagemaker#MonitoringResources", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "NetworkConfig": { + "target": "com.amazonaws.sagemaker#MonitoringNetworkConfig", + "traits": { + "smithy.api#documentation": "

Networking options for a model explainability job.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that has read permission to the \n input data location and write permission to the output data location in Amazon S3.

", + "smithy.api#required": {} + } + }, + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#MonitoringStoppingCondition" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeModelInput": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.sagemaker#ModelName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the model.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeModelOutput": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.sagemaker#ModelName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Name of the SageMaker model.

", + "smithy.api#required": {} + } + }, + "PrimaryContainer": { + "target": "com.amazonaws.sagemaker#ContainerDefinition", + "traits": { + "smithy.api#documentation": "

The location of the primary inference code, associated artifacts, and custom\n environment map that the inference code uses when it is deployed in production.\n

" + } + }, + "Containers": { + "target": "com.amazonaws.sagemaker#ContainerDefinitionList", + "traits": { + "smithy.api#documentation": "

The containers in the inference pipeline.

" + } + }, + "InferenceExecutionConfig": { + "target": "com.amazonaws.sagemaker#InferenceExecutionConfig", + "traits": { + "smithy.api#documentation": "

Specifies details of how containers in a multi-container endpoint are called.

" + } + }, + "ExecutionRoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that you specified for the\n model.

" + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig", + "traits": { + "smithy.api#documentation": "

A VpcConfig object that specifies the VPC that this model has access to. For\n more information, see Protect Endpoints by Using an Amazon Virtual\n Private Cloud\n

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A timestamp that shows when the model was created.

", + "smithy.api#required": {} + } + }, + "ModelArn": { + "target": "com.amazonaws.sagemaker#ModelArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model.

", + "smithy.api#required": {} + } + }, + "EnableNetworkIsolation": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

If True, no inbound or outbound network calls can be made to or from the\n model container.

" + } + }, + "DeploymentRecommendation": { + "target": "com.amazonaws.sagemaker#DeploymentRecommendation", + "traits": { + "smithy.api#documentation": "

A set of recommended deployment configurations for the model.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeModelPackage": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeModelPackageInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeModelPackageOutput" + }, + "traits": { + "smithy.api#documentation": "

Returns a description of the specified model package, which is used to create SageMaker\n models or list them on Amazon Web Services Marketplace.

\n \n

If you provided a KMS Key ID when you created your model package,\n you will see the KMS\n Decrypt API call in your CloudTrail logs when you use this API.

\n \n

To create models in SageMaker, buyers can subscribe to model packages listed on Amazon Web Services\n Marketplace.

" + } + }, + "com.amazonaws.sagemaker#DescribeModelPackageGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeModelPackageGroupInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeModelPackageGroupOutput" + }, + "traits": { + "smithy.api#documentation": "

Gets a description for the specified model group.

" + } + }, + "com.amazonaws.sagemaker#DescribeModelPackageGroupInput": { + "type": "structure", + "members": { + "ModelPackageGroupName": { + "target": "com.amazonaws.sagemaker#ArnOrName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the model group to describe.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeModelPackageGroupOutput": { + "type": "structure", + "members": { + "ModelPackageGroupName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the model group.

", + "smithy.api#required": {} + } + }, + "ModelPackageGroupArn": { + "target": "com.amazonaws.sagemaker#ModelPackageGroupArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model group.

", + "smithy.api#required": {} + } + }, + "ModelPackageGroupDescription": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "

A description of the model group.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The time that the model group was created.

", + "smithy.api#required": {} + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "ModelPackageGroupStatus": { + "target": "com.amazonaws.sagemaker#ModelPackageGroupStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of the model group.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeModelPackageInput": { + "type": "structure", + "members": { + "ModelPackageName": { + "target": "com.amazonaws.sagemaker#VersionedArnOrName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the model package to describe.

\n

When you specify a name, the name must have 1 to 63 characters. Valid\n characters are a-z, A-Z, 0-9, and - (hyphen).

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeModelPackageOutput": { + "type": "structure", + "members": { + "ModelPackageName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the model package being described.

", + "smithy.api#required": {} + } + }, + "ModelPackageGroupName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#documentation": "

If the model is a versioned model, the name of the model group that the versioned\n model belongs to.

" + } + }, + "ModelPackageVersion": { + "target": "com.amazonaws.sagemaker#ModelPackageVersion", + "traits": { + "smithy.api#documentation": "

The version of the model package.

" + } + }, + "ModelPackageArn": { + "target": "com.amazonaws.sagemaker#ModelPackageArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model package.

", + "smithy.api#required": {} + } + }, + "ModelPackageDescription": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "

A brief summary of the model package.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A timestamp specifying when the model package was created.

", + "smithy.api#required": {} + } + }, + "InferenceSpecification": { + "target": "com.amazonaws.sagemaker#InferenceSpecification", + "traits": { + "smithy.api#documentation": "

Details about inference jobs that you can run with models based on this model\n package.

" + } + }, + "SourceAlgorithmSpecification": { + "target": "com.amazonaws.sagemaker#SourceAlgorithmSpecification", + "traits": { + "smithy.api#documentation": "

Details about the algorithm that was used to create the model package.

" + } + }, + "ValidationSpecification": { + "target": "com.amazonaws.sagemaker#ModelPackageValidationSpecification", + "traits": { + "smithy.api#documentation": "

Configurations for one or more transform jobs that SageMaker runs to test the model\n package.

" + } + }, + "ModelPackageStatus": { + "target": "com.amazonaws.sagemaker#ModelPackageStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The current status of the model package.

", + "smithy.api#required": {} + } + }, + "ModelPackageStatusDetails": { + "target": "com.amazonaws.sagemaker#ModelPackageStatusDetails", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Details about the current status of the model package.

", + "smithy.api#required": {} + } + }, + "CertifyForMarketplace": { + "target": "com.amazonaws.sagemaker#CertifyForMarketplace", + "traits": { + "smithy.api#documentation": "

Whether the model package is certified for listing on Amazon Web Services Marketplace.

" + } + }, + "ModelApprovalStatus": { + "target": "com.amazonaws.sagemaker#ModelApprovalStatus", + "traits": { + "smithy.api#documentation": "

The approval status of the model package.

" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "MetadataProperties": { + "target": "com.amazonaws.sagemaker#MetadataProperties" + }, + "ModelMetrics": { + "target": "com.amazonaws.sagemaker#ModelMetrics", + "traits": { + "smithy.api#documentation": "

Metrics for the model.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The last time that the model package was modified.

" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "ApprovalDescription": { + "target": "com.amazonaws.sagemaker#ApprovalDescription", + "traits": { + "smithy.api#documentation": "

A description provided for the model approval.

" + } + }, + "Domain": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The machine learning domain of the model package you specified. Common machine\n learning domains include computer vision and natural language processing.

" + } + }, + "Task": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The machine learning task you specified that your model package accomplishes.\n Common machine learning tasks include object detection and image classification.

" + } + }, + "SamplePayloadUrl": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored. This path points to a single\n gzip compressed tar archive (.tar.gz suffix).

" + } + }, + "CustomerMetadataProperties": { + "target": "com.amazonaws.sagemaker#CustomerMetadataMap", + "traits": { + "smithy.api#documentation": "

The metadata properties associated with the model package versions.

" + } + }, + "DriftCheckBaselines": { + "target": "com.amazonaws.sagemaker#DriftCheckBaselines", + "traits": { + "smithy.api#documentation": "

Represents the drift check baselines that can be used when the model monitor is set using the model package. \n For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.\n

" + } + }, + "AdditionalInferenceSpecifications": { + "target": "com.amazonaws.sagemaker#AdditionalInferenceSpecifications", + "traits": { + "smithy.api#documentation": "

An array of additional Inference Specification objects. Each additional\n Inference Specification specifies artifacts based on this model package that can\n be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

" + } + }, + "SkipModelValidation": { + "target": "com.amazonaws.sagemaker#SkipModelValidation", + "traits": { + "smithy.api#documentation": "

Indicates if you want to skip model validation.

" + } + }, + "SourceUri": { + "target": "com.amazonaws.sagemaker#ModelPackageSourceUri", + "traits": { + "smithy.api#documentation": "

The URI of the source for the model package.

" + } + }, + "SecurityConfig": { + "target": "com.amazonaws.sagemaker#ModelPackageSecurityConfig", + "traits": { + "smithy.api#documentation": "

The KMS Key ID (KMSKeyId) used for encryption of model package information.

" + } + }, + "ModelCard": { + "target": "com.amazonaws.sagemaker#ModelPackageModelCard", + "traits": { + "smithy.api#documentation": "

The model card associated with the model package. Since ModelPackageModelCard is\n tied to a model package, it is a specific usage of a model card and its schema is\n simplified compared to the schema of ModelCard. The \n ModelPackageModelCard schema does not include model_package_details,\n and model_overview is composed of the model_creator and\n model_artifact properties. For more information about the model package model\n card schema, see Model\n package model card schema. For more information about\n the model card associated with the model package, see View\n the Details of a Model Version.

" + } + }, + "ModelLifeCycle": { + "target": "com.amazonaws.sagemaker#ModelLifeCycle", + "traits": { + "smithy.api#documentation": "

\n A structure describing the current state of the model in its life cycle.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeModelQualityJobDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeModelQualityJobDefinitionRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeModelQualityJobDefinitionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a description of a model quality job definition.

" + } + }, + "com.amazonaws.sagemaker#DescribeModelQualityJobDefinitionRequest": { + "type": "structure", + "members": { + "JobDefinitionName": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the model quality job. The name must be unique within an Amazon Web Services\n Region in the Amazon Web Services account.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeModelQualityJobDefinitionResponse": { + "type": "structure", + "members": { + "JobDefinitionArn": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model quality job.

", + "smithy.api#required": {} + } + }, + "JobDefinitionName": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the quality job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The time at which the model quality job was created.

", + "smithy.api#required": {} + } + }, + "ModelQualityBaselineConfig": { + "target": "com.amazonaws.sagemaker#ModelQualityBaselineConfig", + "traits": { + "smithy.api#documentation": "

The baseline configuration for a model quality job.

" + } + }, + "ModelQualityAppSpecification": { + "target": "com.amazonaws.sagemaker#ModelQualityAppSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Configures the model quality job to run a specified Docker container image.

", + "smithy.api#required": {} + } + }, + "ModelQualityJobInput": { + "target": "com.amazonaws.sagemaker#ModelQualityJobInput", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Inputs for the model quality job.

", + "smithy.api#required": {} + } + }, + "ModelQualityJobOutputConfig": { + "target": "com.amazonaws.sagemaker#MonitoringOutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "JobResources": { + "target": "com.amazonaws.sagemaker#MonitoringResources", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "NetworkConfig": { + "target": "com.amazonaws.sagemaker#MonitoringNetworkConfig", + "traits": { + "smithy.api#documentation": "

Networking options for a model quality job.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can \n assume to perform tasks on your behalf.

", + "smithy.api#required": {} + } + }, + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#MonitoringStoppingCondition" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeMonitoringSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeMonitoringScheduleRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeMonitoringScheduleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the schedule for a monitoring job.

" + } + }, + "com.amazonaws.sagemaker#DescribeMonitoringScheduleRequest": { + "type": "structure", + "members": { + "MonitoringScheduleName": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Name of a previously created monitoring schedule.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeMonitoringScheduleResponse": { + "type": "structure", + "members": { + "MonitoringScheduleArn": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the monitoring schedule.

", + "smithy.api#required": {} + } + }, + "MonitoringScheduleName": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Name of the monitoring schedule.

", + "smithy.api#required": {} + } + }, + "MonitoringScheduleStatus": { + "target": "com.amazonaws.sagemaker#ScheduleStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of an monitoring job.

", + "smithy.api#required": {} + } + }, + "MonitoringType": { + "target": "com.amazonaws.sagemaker#MonitoringType", + "traits": { + "smithy.api#documentation": "

The type of the monitoring job that this schedule runs. This is one of the following\n values.

\n
    \n
  • \n

    \n DATA_QUALITY - The schedule is for a data quality monitoring\n job.

    \n
    • \n
  • \n

    \n MODEL_QUALITY - The schedule is for a model quality monitoring\n job.

    \n
    • \n
  • \n

    \n MODEL_BIAS - The schedule is for a bias monitoring job.

    \n
    • \n
  • \n

    \n MODEL_EXPLAINABILITY - The schedule is for an explainability\n monitoring job.

    \n
    • \n
" + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "

A string, up to one KB in size, that contains the reason a monitoring job failed, if it\n failed.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The time at which the monitoring job was created.

", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The time at which the monitoring job was last modified.

", + "smithy.api#required": {} + } + }, + "MonitoringScheduleConfig": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The configuration object that specifies the monitoring schedule and defines the monitoring \n job.

", + "smithy.api#required": {} + } + }, + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#documentation": "

The name of the endpoint for the monitoring job.

" + } + }, + "LastMonitoringExecutionSummary": { + "target": "com.amazonaws.sagemaker#MonitoringExecutionSummary", + "traits": { + "smithy.api#documentation": "

Describes metadata on the last execution to run, if there was one.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeNotebookInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeNotebookInstanceInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeNotebookInstanceOutput" + }, + "traits": { + "smithy.api#documentation": "

Returns information about a notebook instance.

", + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "NotebookInstanceDeleted": { + "acceptors": [ + { + "state": "success", + "matcher": { + "errorType": "ValidationException" + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "NotebookInstanceStatus", + "expected": "Failed", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 30 + }, + "NotebookInstanceInService": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "NotebookInstanceStatus", + "expected": "InService", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "NotebookInstanceStatus", + "expected": "Failed", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 30 + }, + "NotebookInstanceStopped": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "NotebookInstanceStatus", + "expected": "Stopped", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "NotebookInstanceStatus", + "expected": "Failed", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 30 + } + } + } + }, + "com.amazonaws.sagemaker#DescribeNotebookInstanceInput": { + "type": "structure", + "members": { + "NotebookInstanceName": { + "target": "com.amazonaws.sagemaker#NotebookInstanceName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the notebook instance that you want information about.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeNotebookInstanceLifecycleConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeNotebookInstanceLifecycleConfigInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeNotebookInstanceLifecycleConfigOutput" + }, + "traits": { + "smithy.api#documentation": "

Returns a description of a notebook instance lifecycle configuration.

\n

For information about notebook instance lifestyle configurations, see Step\n 2.1: (Optional) Customize a Notebook Instance.

" + } + }, + "com.amazonaws.sagemaker#DescribeNotebookInstanceLifecycleConfigInput": { + "type": "structure", + "members": { + "NotebookInstanceLifecycleConfigName": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the lifecycle configuration to describe.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeNotebookInstanceLifecycleConfigOutput": { + "type": "structure", + "members": { + "NotebookInstanceLifecycleConfigArn": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the lifecycle configuration.

" + } + }, + "NotebookInstanceLifecycleConfigName": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigName", + "traits": { + "smithy.api#documentation": "

The name of the lifecycle configuration.

" + } + }, + "OnCreate": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigList", + "traits": { + "smithy.api#documentation": "

The shell script that runs only once, when you create a notebook instance.

" + } + }, + "OnStart": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigList", + "traits": { + "smithy.api#documentation": "

The shell script that runs every time you start a notebook instance, including when\n you create the notebook instance.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "

A timestamp that tells when the lifecycle configuration was last modified.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "

A timestamp that tells when the lifecycle configuration was created.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeNotebookInstanceOutput": { + "type": "structure", + "members": { + "NotebookInstanceArn": { + "target": "com.amazonaws.sagemaker#NotebookInstanceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the notebook instance.

" + } + }, + "NotebookInstanceName": { + "target": "com.amazonaws.sagemaker#NotebookInstanceName", + "traits": { + "smithy.api#documentation": "

The name of the SageMaker AI notebook instance.

" + } + }, + "NotebookInstanceStatus": { + "target": "com.amazonaws.sagemaker#NotebookInstanceStatus", + "traits": { + "smithy.api#documentation": "

The status of the notebook instance.

" + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "

If status is Failed, the reason it failed.

" + } + }, + "Url": { + "target": "com.amazonaws.sagemaker#NotebookInstanceUrl", + "traits": { + "smithy.api#documentation": "

The URL that you use to connect to the Jupyter notebook that is running in your\n notebook instance.

" + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#InstanceType", + "traits": { + "smithy.api#documentation": "

The type of ML compute instance running on the notebook instance.

" + } + }, + "SubnetId": { + "target": "com.amazonaws.sagemaker#SubnetId", + "traits": { + "smithy.api#documentation": "

The ID of the VPC subnet.

" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.sagemaker#SecurityGroupIds", + "traits": { + "smithy.api#documentation": "

The IDs of the VPC security groups.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role associated with the instance.\n

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key ID SageMaker AI uses to encrypt data when\n storing it on the ML storage volume attached to the instance.

" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.sagemaker#NetworkInterfaceId", + "traits": { + "smithy.api#documentation": "

The network interface IDs that SageMaker AI created at the time of creating\n the instance.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "

A timestamp. Use this parameter to retrieve the time when the notebook instance was\n last modified.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "

A timestamp. Use this parameter to return the time when the notebook instance was\n created

" + } + }, + "NotebookInstanceLifecycleConfigName": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigName", + "traits": { + "smithy.api#documentation": "

Returns the name of a notebook instance lifecycle configuration.

\n

For information about notebook instance lifestyle configurations, see Step\n 2.1: (Optional) Customize a Notebook Instance\n

" + } + }, + "DirectInternetAccess": { + "target": "com.amazonaws.sagemaker#DirectInternetAccess", + "traits": { + "smithy.api#documentation": "

Describes whether SageMaker AI provides internet access to the notebook instance.\n If this value is set to Disabled, the notebook instance does not\n have internet access, and cannot connect to SageMaker AI training and endpoint\n services.

\n

For more information, see Notebook Instances Are Internet-Enabled by Default.

" + } + }, + "VolumeSizeInGB": { + "target": "com.amazonaws.sagemaker#NotebookInstanceVolumeSizeInGB", + "traits": { + "smithy.api#documentation": "

The size, in GB, of the ML storage volume attached to the notebook instance.

" + } + }, + "AcceleratorTypes": { + "target": "com.amazonaws.sagemaker#NotebookInstanceAcceleratorTypes", + "traits": { + "smithy.api#documentation": "

This parameter is no longer supported. Elastic Inference (EI) is no longer\n available.

\n

This parameter was used to specify a list of the EI instance types associated with\n this notebook instance.

" + } + }, + "DefaultCodeRepository": { + "target": "com.amazonaws.sagemaker#CodeRepositoryNameOrUrl", + "traits": { + "smithy.api#documentation": "

The Git repository associated with the notebook instance as its default code\n repository. This can be either the name of a Git repository stored as a resource in your\n account, or the URL of a Git repository in Amazon Web Services CodeCommit\n or in any other Git repository. When you open a notebook instance, it opens in the\n directory that contains this repository. For more information, see Associating Git\n Repositories with SageMaker AI Notebook Instances.

" + } + }, + "AdditionalCodeRepositories": { + "target": "com.amazonaws.sagemaker#AdditionalCodeRepositoryNamesOrUrls", + "traits": { + "smithy.api#documentation": "

An array of up to three Git repositories associated with the notebook instance. These\n can be either the names of Git repositories stored as resources in your account, or the\n URL of Git repositories in Amazon Web Services CodeCommit\n or in any other Git repository. These repositories are cloned at the same level as the\n default repository of your notebook instance. For more information, see Associating Git\n Repositories with SageMaker AI Notebook Instances.

" + } + }, + "RootAccess": { + "target": "com.amazonaws.sagemaker#RootAccess", + "traits": { + "smithy.api#documentation": "

Whether root access is enabled or disabled for users of the notebook instance.

\n \n

Lifecycle configurations need root access to be able to set up a notebook\n instance. Because of this, lifecycle configurations associated with a notebook\n instance always run with root access even if you disable root access for\n users.

\n " + } + }, + "PlatformIdentifier": { + "target": "com.amazonaws.sagemaker#PlatformIdentifier", + "traits": { + "smithy.api#documentation": "

The platform identifier of the notebook instance runtime environment.

" + } + }, + "InstanceMetadataServiceConfiguration": { + "target": "com.amazonaws.sagemaker#InstanceMetadataServiceConfiguration", + "traits": { + "smithy.api#documentation": "

Information on the IMDS configuration of the notebook instance

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeOptimizationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeOptimizationJobRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeOptimizationJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Provides the properties of the specified optimization job.

" + } + }, + "com.amazonaws.sagemaker#DescribeOptimizationJobRequest": { + "type": "structure", + "members": { + "OptimizationJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name that you assigned to the optimization job.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeOptimizationJobResponse": { + "type": "structure", + "members": { + "OptimizationJobArn": { + "target": "com.amazonaws.sagemaker#OptimizationJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the optimization job.

", + "smithy.api#required": {} + } + }, + "OptimizationJobStatus": { + "target": "com.amazonaws.sagemaker#OptimizationJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The current status of the optimization job.

", + "smithy.api#required": {} + } + }, + "OptimizationStartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the optimization job started.

" + } + }, + "OptimizationEndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the optimization job finished processing.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The time when you created the optimization job.

", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The time when the optimization job was last updated.

", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "

If the optimization job status is FAILED, the reason for the\n failure.

" + } + }, + "OptimizationJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name that you assigned to the optimization job.

", + "smithy.api#required": {} + } + }, + "ModelSource": { + "target": "com.amazonaws.sagemaker#OptimizationJobModelSource", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The location of the source model to optimize with an optimization job.

", + "smithy.api#required": {} + } + }, + "OptimizationEnvironment": { + "target": "com.amazonaws.sagemaker#OptimizationJobEnvironmentVariables", + "traits": { + "smithy.api#documentation": "

The environment variables to set in the model container.

" + } + }, + "DeploymentInstanceType": { + "target": "com.amazonaws.sagemaker#OptimizationJobDeploymentInstanceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of instance that hosts the optimized model that you create with the optimization job.

", + "smithy.api#required": {} + } + }, + "OptimizationConfigs": { + "target": "com.amazonaws.sagemaker#OptimizationConfigs", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Settings for each of the optimization techniques that the job applies.

", + "smithy.api#required": {} + } + }, + "OutputConfig": { + "target": "com.amazonaws.sagemaker#OptimizationJobOutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Details for where to store the optimized model that you create with the optimization job.

", + "smithy.api#required": {} + } + }, + "OptimizationOutput": { + "target": "com.amazonaws.sagemaker#OptimizationOutput", + "traits": { + "smithy.api#documentation": "

Output values produced by an optimization job.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the IAM role that you assigned to the optimization job.

", + "smithy.api#required": {} + } + }, + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#StoppingCondition", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#OptimizationVpcConfig", + "traits": { + "smithy.api#documentation": "

A VPC in Amazon VPC that your optimized model has access to.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribePartnerApp": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribePartnerAppRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribePartnerAppResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about a SageMaker Partner AI App.

" + } + }, + "com.amazonaws.sagemaker#DescribePartnerAppRequest": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#PartnerAppArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the SageMaker Partner AI App to describe.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribePartnerAppResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#PartnerAppArn", + "traits": { + "smithy.api#documentation": "

The ARN of the SageMaker Partner AI App that was described.

" + } + }, + "Name": { + "target": "com.amazonaws.sagemaker#PartnerAppName", + "traits": { + "smithy.api#documentation": "

The name of the SageMaker Partner AI App.

" + } + }, + "Type": { + "target": "com.amazonaws.sagemaker#PartnerAppType", + "traits": { + "smithy.api#documentation": "

The type of SageMaker Partner AI App. Must be one of the following: lakera-guard, comet, deepchecks-llm-evaluation, or fiddler.

" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#PartnerAppStatus", + "traits": { + "smithy.api#documentation": "

The status of the SageMaker Partner AI App.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the SageMaker Partner AI App was created.

" + } + }, + "ExecutionRoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM role associated with the SageMaker Partner AI App.

" + } + }, + "BaseUrl": { + "target": "com.amazonaws.sagemaker#String2048", + "traits": { + "smithy.api#documentation": "

The URL of the SageMaker Partner AI App that the Application SDK uses to support in-app calls for the user.

" + } + }, + "MaintenanceConfig": { + "target": "com.amazonaws.sagemaker#PartnerAppMaintenanceConfig", + "traits": { + "smithy.api#documentation": "

Maintenance configuration settings for the SageMaker Partner AI App.

" + } + }, + "Tier": { + "target": "com.amazonaws.sagemaker#NonEmptyString64", + "traits": { + "smithy.api#documentation": "

The instance type and size of the cluster attached to the SageMaker Partner AI App.

" + } + }, + "Version": { + "target": "com.amazonaws.sagemaker#NonEmptyString64", + "traits": { + "smithy.api#documentation": "

The version of the SageMaker Partner AI App.

" + } + }, + "ApplicationConfig": { + "target": "com.amazonaws.sagemaker#PartnerAppConfig", + "traits": { + "smithy.api#documentation": "

Configuration settings for the SageMaker Partner AI App.

" + } + }, + "AuthType": { + "target": "com.amazonaws.sagemaker#PartnerAppAuthType", + "traits": { + "smithy.api#documentation": "

The authorization type that users use to access the SageMaker Partner AI App.

" + } + }, + "EnableIamSessionBasedIdentity": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

When set to TRUE, the SageMaker Partner AI App sets the Amazon Web Services IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user.

" + } + }, + "Error": { + "target": "com.amazonaws.sagemaker#ErrorInfo", + "traits": { + "smithy.api#documentation": "

This is an error field object that contains the error code and the reason for an operation failure.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribePipeline": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribePipelineRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribePipelineResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the details of a pipeline.

" + } + }, + "com.amazonaws.sagemaker#DescribePipelineDefinitionForExecution": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribePipelineDefinitionForExecutionRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribePipelineDefinitionForExecutionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the details of an execution's pipeline definition.

" + } + }, + "com.amazonaws.sagemaker#DescribePipelineDefinitionForExecutionRequest": { + "type": "structure", + "members": { + "PipelineExecutionArn": { + "target": "com.amazonaws.sagemaker#PipelineExecutionArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the pipeline execution.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribePipelineDefinitionForExecutionResponse": { + "type": "structure", + "members": { + "PipelineDefinition": { + "target": "com.amazonaws.sagemaker#PipelineDefinition", + "traits": { + "smithy.api#documentation": "

The JSON pipeline definition.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the pipeline was created.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribePipelineExecution": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribePipelineExecutionRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribePipelineExecutionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the details of a pipeline execution.

" + } + }, + "com.amazonaws.sagemaker#DescribePipelineExecutionRequest": { + "type": "structure", + "members": { + "PipelineExecutionArn": { + "target": "com.amazonaws.sagemaker#PipelineExecutionArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the pipeline execution.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribePipelineExecutionResponse": { + "type": "structure", + "members": { + "PipelineArn": { + "target": "com.amazonaws.sagemaker#PipelineArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the pipeline.

" + } + }, + "PipelineExecutionArn": { + "target": "com.amazonaws.sagemaker#PipelineExecutionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the pipeline execution.

" + } + }, + "PipelineExecutionDisplayName": { + "target": "com.amazonaws.sagemaker#PipelineExecutionName", + "traits": { + "smithy.api#documentation": "

The display name of the pipeline execution.

" + } + }, + "PipelineExecutionStatus": { + "target": "com.amazonaws.sagemaker#PipelineExecutionStatus", + "traits": { + "smithy.api#documentation": "

The status of the pipeline execution.

" + } + }, + "PipelineExecutionDescription": { + "target": "com.amazonaws.sagemaker#PipelineExecutionDescription", + "traits": { + "smithy.api#documentation": "

The description of the pipeline execution.

" + } + }, + "PipelineExperimentConfig": { + "target": "com.amazonaws.sagemaker#PipelineExperimentConfig" + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#PipelineExecutionFailureReason", + "traits": { + "smithy.api#documentation": "

If the execution failed, a message describing why.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the pipeline execution was created.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the pipeline execution was modified last.

" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "ParallelismConfiguration": { + "target": "com.amazonaws.sagemaker#ParallelismConfiguration", + "traits": { + "smithy.api#documentation": "

The parallelism configuration applied to the pipeline.

" + } + }, + "SelectiveExecutionConfig": { + "target": "com.amazonaws.sagemaker#SelectiveExecutionConfig", + "traits": { + "smithy.api#documentation": "

The selective execution configuration applied to the pipeline run.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribePipelineRequest": { + "type": "structure", + "members": { + "PipelineName": { + "target": "com.amazonaws.sagemaker#PipelineNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the pipeline to describe.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribePipelineResponse": { + "type": "structure", + "members": { + "PipelineArn": { + "target": "com.amazonaws.sagemaker#PipelineArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the pipeline.

" + } + }, + "PipelineName": { + "target": "com.amazonaws.sagemaker#PipelineName", + "traits": { + "smithy.api#documentation": "

The name of the pipeline.

" + } + }, + "PipelineDisplayName": { + "target": "com.amazonaws.sagemaker#PipelineName", + "traits": { + "smithy.api#documentation": "

The display name of the pipeline.

" + } + }, + "PipelineDefinition": { + "target": "com.amazonaws.sagemaker#PipelineDefinition", + "traits": { + "smithy.api#documentation": "

The JSON pipeline definition.

" + } + }, + "PipelineDescription": { + "target": "com.amazonaws.sagemaker#PipelineDescription", + "traits": { + "smithy.api#documentation": "

The description of the pipeline.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that the pipeline uses to execute.

" + } + }, + "PipelineStatus": { + "target": "com.amazonaws.sagemaker#PipelineStatus", + "traits": { + "smithy.api#documentation": "

The status of the pipeline execution.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the pipeline was created.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the pipeline was last modified.

" + } + }, + "LastRunTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the pipeline was last run.

" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "ParallelismConfiguration": { + "target": "com.amazonaws.sagemaker#ParallelismConfiguration", + "traits": { + "smithy.api#documentation": "

Lists the parallelism configuration applied to the pipeline.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeProcessingJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeProcessingJobRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeProcessingJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a description of a processing job.

", + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "ProcessingJobCompletedOrStopped": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "ProcessingJobStatus", + "expected": "Completed", + "comparator": "stringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "output": { + "path": "ProcessingJobStatus", + "expected": "Stopped", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ProcessingJobStatus", + "expected": "Failed", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "errorType": "ValidationException" + } + } + ], + "minDelay": 60 + } + } + } + }, + "com.amazonaws.sagemaker#DescribeProcessingJobRequest": { + "type": "structure", + "members": { + "ProcessingJobName": { + "target": "com.amazonaws.sagemaker#ProcessingJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the processing job. The name must be unique within an Amazon Web Services Region in the\n Amazon Web Services account.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeProcessingJobResponse": { + "type": "structure", + "members": { + "ProcessingInputs": { + "target": "com.amazonaws.sagemaker#ProcessingInputs", + "traits": { + "smithy.api#documentation": "

The inputs for a processing job.

" + } + }, + "ProcessingOutputConfig": { + "target": "com.amazonaws.sagemaker#ProcessingOutputConfig", + "traits": { + "smithy.api#documentation": "

Output configuration for the processing job.

" + } + }, + "ProcessingJobName": { + "target": "com.amazonaws.sagemaker#ProcessingJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the processing job. The name must be unique within an Amazon Web Services Region in the\n Amazon Web Services account.

", + "smithy.api#required": {} + } + }, + "ProcessingResources": { + "target": "com.amazonaws.sagemaker#ProcessingResources", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Identifies the resources, ML compute instances, and ML storage volumes to deploy for a\n processing job. In distributed training, you specify more than one instance.

", + "smithy.api#required": {} + } + }, + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#ProcessingStoppingCondition", + "traits": { + "smithy.api#documentation": "

The time limit for how long the processing job is allowed to run.

" + } + }, + "AppSpecification": { + "target": "com.amazonaws.sagemaker#AppSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Configures the processing job to run a specified container image.

", + "smithy.api#required": {} + } + }, + "Environment": { + "target": "com.amazonaws.sagemaker#ProcessingEnvironmentMap", + "traits": { + "smithy.api#documentation": "

The environment variables set in the Docker container.

" + } + }, + "NetworkConfig": { + "target": "com.amazonaws.sagemaker#NetworkConfig", + "traits": { + "smithy.api#documentation": "

Networking options for a processing job.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on\n your behalf.

" + } + }, + "ExperimentConfig": { + "target": "com.amazonaws.sagemaker#ExperimentConfig", + "traits": { + "smithy.api#documentation": "

The configuration information used to create an experiment.

" + } + }, + "ProcessingJobArn": { + "target": "com.amazonaws.sagemaker#ProcessingJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the processing job.

", + "smithy.api#required": {} + } + }, + "ProcessingJobStatus": { + "target": "com.amazonaws.sagemaker#ProcessingJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Provides the status of a processing job.

", + "smithy.api#required": {} + } + }, + "ExitMessage": { + "target": "com.amazonaws.sagemaker#ExitMessage", + "traits": { + "smithy.api#documentation": "

An optional string, up to one KB in size, that contains metadata from the processing\n container when the processing job exits.

" + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "

A string, up to one KB in size, that contains the reason a processing job failed, if\n it failed.

" + } + }, + "ProcessingEndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the processing job completed.

" + } + }, + "ProcessingStartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the processing job started.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the processing job was last modified.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The time at which the processing job was created.

", + "smithy.api#required": {} + } + }, + "MonitoringScheduleArn": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleArn", + "traits": { + "smithy.api#documentation": "

The ARN of a monitoring schedule for an endpoint associated with this processing\n job.

" + } + }, + "AutoMLJobArn": { + "target": "com.amazonaws.sagemaker#AutoMLJobArn", + "traits": { + "smithy.api#documentation": "

The ARN of an AutoML job associated with this processing job.

" + } + }, + "TrainingJobArn": { + "target": "com.amazonaws.sagemaker#TrainingJobArn", + "traits": { + "smithy.api#documentation": "

The ARN of a training job associated with this processing job.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeProject": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeProjectInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeProjectOutput" + }, + "traits": { + "smithy.api#documentation": "

Describes the details of a project.

" + } + }, + "com.amazonaws.sagemaker#DescribeProjectInput": { + "type": "structure", + "members": { + "ProjectName": { + "target": "com.amazonaws.sagemaker#ProjectEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the project to describe.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeProjectOutput": { + "type": "structure", + "members": { + "ProjectArn": { + "target": "com.amazonaws.sagemaker#ProjectArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the project.

", + "smithy.api#required": {} + } + }, + "ProjectName": { + "target": "com.amazonaws.sagemaker#ProjectEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the project.

", + "smithy.api#required": {} + } + }, + "ProjectId": { + "target": "com.amazonaws.sagemaker#ProjectId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the project.

", + "smithy.api#required": {} + } + }, + "ProjectDescription": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "

The description of the project.

" + } + }, + "ServiceCatalogProvisioningDetails": { + "target": "com.amazonaws.sagemaker#ServiceCatalogProvisioningDetails", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Information used to provision a service catalog product. For information, see What is Amazon Web Services Service\n Catalog.

", + "smithy.api#required": {} + } + }, + "ServiceCatalogProvisionedProductDetails": { + "target": "com.amazonaws.sagemaker#ServiceCatalogProvisionedProductDetails", + "traits": { + "smithy.api#documentation": "

Information about a provisioned service catalog product.

" + } + }, + "ProjectStatus": { + "target": "com.amazonaws.sagemaker#ProjectStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of the project.

", + "smithy.api#required": {} + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The time when the project was created.

", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when project was last modified.

" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeSpace": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeSpaceRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeSpaceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the space.

" + } + }, + "com.amazonaws.sagemaker#DescribeSpaceRequest": { + "type": "structure", + "members": { + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the associated domain.

", + "smithy.api#required": {} + } + }, + "SpaceName": { + "target": "com.amazonaws.sagemaker#SpaceName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the space.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeSpaceResponse": { + "type": "structure", + "members": { + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the associated domain.

" + } + }, + "SpaceArn": { + "target": "com.amazonaws.sagemaker#SpaceArn", + "traits": { + "smithy.api#documentation": "

The space's Amazon Resource Name (ARN).

" + } + }, + "SpaceName": { + "target": "com.amazonaws.sagemaker#SpaceName", + "traits": { + "smithy.api#documentation": "

The name of the space.

" + } + }, + "HomeEfsFileSystemUid": { + "target": "com.amazonaws.sagemaker#EfsUid", + "traits": { + "smithy.api#documentation": "

The ID of the space's profile in the Amazon EFS volume.

" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#SpaceStatus", + "traits": { + "smithy.api#documentation": "

The status.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "

The last modified time.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "

The creation time.

" + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "

The failure reason.

" + } + }, + "SpaceSettings": { + "target": "com.amazonaws.sagemaker#SpaceSettings", + "traits": { + "smithy.api#documentation": "

A collection of space settings.

" + } + }, + "OwnershipSettings": { + "target": "com.amazonaws.sagemaker#OwnershipSettings", + "traits": { + "smithy.api#documentation": "

The collection of ownership settings for a space.

" + } + }, + "SpaceSharingSettings": { + "target": "com.amazonaws.sagemaker#SpaceSharingSettings", + "traits": { + "smithy.api#documentation": "

The collection of space sharing settings for a space.

" + } + }, + "SpaceDisplayName": { + "target": "com.amazonaws.sagemaker#NonEmptyString64", + "traits": { + "smithy.api#documentation": "

The name of the space that appears in the Amazon SageMaker Studio UI.

" + } + }, + "Url": { + "target": "com.amazonaws.sagemaker#String1024", + "traits": { + "smithy.api#documentation": "

Returns the URL of the space. If the space is created with Amazon Web Services IAM Identity\n Center (Successor to Amazon Web Services Single Sign-On) authentication, users can navigate to\n the URL after appending the respective redirect parameter for the application type to be\n federated through Amazon Web Services IAM Identity Center.

\n

The following application types are supported:

\n
    \n
  • \n

    Studio Classic: &redirect=JupyterServer\n

    \n
    • \n
  • \n

    JupyterLab: &redirect=JupyterLab\n

    \n
    • \n
  • \n

    Code Editor, based on Code-OSS, Visual Studio Code - Open Source:\n &redirect=CodeEditor\n

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeStudioLifecycleConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeStudioLifecycleConfigRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeStudioLifecycleConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the Amazon SageMaker AI Studio Lifecycle Configuration.

" + } + }, + "com.amazonaws.sagemaker#DescribeStudioLifecycleConfigRequest": { + "type": "structure", + "members": { + "StudioLifecycleConfigName": { + "target": "com.amazonaws.sagemaker#StudioLifecycleConfigName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Amazon SageMaker AI Studio Lifecycle Configuration to describe.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeStudioLifecycleConfigResponse": { + "type": "structure", + "members": { + "StudioLifecycleConfigArn": { + "target": "com.amazonaws.sagemaker#StudioLifecycleConfigArn", + "traits": { + "smithy.api#documentation": "

The ARN of the Lifecycle Configuration to describe.

" + } + }, + "StudioLifecycleConfigName": { + "target": "com.amazonaws.sagemaker#StudioLifecycleConfigName", + "traits": { + "smithy.api#documentation": "

The name of the Amazon SageMaker AI Studio Lifecycle Configuration that is\n described.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The creation time of the Amazon SageMaker AI Studio Lifecycle Configuration.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

This value is equivalent to CreationTime because Amazon SageMaker AI Studio Lifecycle\n Configurations are immutable.

" + } + }, + "StudioLifecycleConfigContent": { + "target": "com.amazonaws.sagemaker#StudioLifecycleConfigContent", + "traits": { + "smithy.api#documentation": "

The content of your Amazon SageMaker AI Studio Lifecycle Configuration script.

" + } + }, + "StudioLifecycleConfigAppType": { + "target": "com.amazonaws.sagemaker#StudioLifecycleConfigAppType", + "traits": { + "smithy.api#documentation": "

The App type that the Lifecycle Configuration is attached to.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeSubscribedWorkteam": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeSubscribedWorkteamRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeSubscribedWorkteamResponse" + }, + "traits": { + "smithy.api#documentation": "

Gets information about a work team provided by a vendor. It returns details about the\n subscription with a vendor in the Amazon Web Services Marketplace.

" + } + }, + "com.amazonaws.sagemaker#DescribeSubscribedWorkteamRequest": { + "type": "structure", + "members": { + "WorkteamArn": { + "target": "com.amazonaws.sagemaker#WorkteamArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the subscribed work team to describe.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeSubscribedWorkteamResponse": { + "type": "structure", + "members": { + "SubscribedWorkteam": { + "target": "com.amazonaws.sagemaker#SubscribedWorkteam", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A Workteam instance that contains information about the work team.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeTrainingJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeTrainingJobRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeTrainingJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a training job.

\n

Some of the attributes below only appear if the training job successfully starts.\n If the training job fails, TrainingJobStatus is Failed and,\n depending on the FailureReason, attributes like\n TrainingStartTime, TrainingTimeInSeconds,\n TrainingEndTime, and BillableTimeInSeconds may not be\n present in the response.

", + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "TrainingJobCompletedOrStopped": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "TrainingJobStatus", + "expected": "Completed", + "comparator": "stringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "output": { + "path": "TrainingJobStatus", + "expected": "Stopped", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "TrainingJobStatus", + "expected": "Failed", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "errorType": "ValidationException" + } + } + ], + "minDelay": 120 + } + } + } + }, + "com.amazonaws.sagemaker#DescribeTrainingJobRequest": { + "type": "structure", + "members": { + "TrainingJobName": { + "target": "com.amazonaws.sagemaker#TrainingJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the training job.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeTrainingJobResponse": { + "type": "structure", + "members": { + "TrainingJobName": { + "target": "com.amazonaws.sagemaker#TrainingJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Name of the model training job.

", + "smithy.api#required": {} + } + }, + "TrainingJobArn": { + "target": "com.amazonaws.sagemaker#TrainingJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the training job.

", + "smithy.api#required": {} + } + }, + "TuningJobArn": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the\n training job was launched by a hyperparameter tuning job.

" + } + }, + "LabelingJobArn": { + "target": "com.amazonaws.sagemaker#LabelingJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SageMaker Ground Truth labeling job that created the\n transform or training job.

" + } + }, + "AutoMLJobArn": { + "target": "com.amazonaws.sagemaker#AutoMLJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an AutoML job.

" + } + }, + "ModelArtifacts": { + "target": "com.amazonaws.sagemaker#ModelArtifacts", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Information about the Amazon S3 location that is configured for storing model artifacts.\n

", + "smithy.api#required": {} + } + }, + "TrainingJobStatus": { + "target": "com.amazonaws.sagemaker#TrainingJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of the training job.

\n

SageMaker provides the following training job statuses:

\n
    \n
  • \n

    \n InProgress - The training is in progress.

    \n
    • \n
  • \n

    \n Completed - The training job has completed.

    \n
    • \n
  • \n

    \n Failed - The training job has failed. To see the reason for the\n failure, see the FailureReason field in the response to a\n DescribeTrainingJobResponse call.

    \n
    • \n
  • \n

    \n Stopping - The training job is stopping.

    \n
    • \n
  • \n

    \n Stopped - The training job has stopped.

    \n
    • \n
\n

For more detailed information, see SecondaryStatus.

", + "smithy.api#required": {} + } + }, + "SecondaryStatus": { + "target": "com.amazonaws.sagemaker#SecondaryStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Provides detailed information about the state of the training job. For detailed\n information on the secondary status of the training job, see StatusMessage\n under SecondaryStatusTransition.

\n

SageMaker provides primary statuses and secondary statuses that apply to each of\n them:

\n
\n
InProgress
\n
\n
    \n
  • \n

    \n Starting\n - Starting the training job.

    \n
    • \n
  • \n

    \n Downloading - An optional stage for algorithms that\n support File training input mode. It indicates that\n data is being downloaded to the ML storage volumes.

    \n
    • \n
  • \n

    \n Training - Training is in progress.

    \n
    • \n
  • \n

    \n Interrupted - The job stopped because the managed\n spot training instances were interrupted.

    \n
    • \n
  • \n

    \n Uploading - Training is complete and the model\n artifacts are being uploaded to the S3 location.

    \n
    • \n
\n
\n
Completed
\n
\n
    \n
  • \n

    \n Completed - The training job has completed.

    \n
    • \n
\n
\n
Failed
\n
\n
    \n
  • \n

    \n Failed - The training job has failed. The reason for\n the failure is returned in the FailureReason field of\n DescribeTrainingJobResponse.

    \n
    • \n
\n
\n
Stopped
\n
\n
    \n
  • \n

    \n MaxRuntimeExceeded - The job stopped because it\n exceeded the maximum allowed runtime.

    \n
    • \n
  • \n

    \n MaxWaitTimeExceeded - The job stopped because it\n exceeded the maximum allowed wait time.

    \n
    • \n
  • \n

    \n Stopped - The training job has stopped.

    \n
    • \n
\n
\n
Stopping
\n
\n
    \n
  • \n

    \n Stopping - Stopping the training job.

    \n
    • \n
\n
\n
\n \n

Valid values for SecondaryStatus are subject to change.

\n \n

We no longer support the following secondary statuses:

\n
    \n
  • \n

    \n LaunchingMLInstances\n

    \n
    • \n
  • \n

    \n PreparingTraining\n

    \n
    • \n
  • \n

    \n DownloadingTrainingImage\n

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "

If the training job failed, the reason it failed.

" + } + }, + "HyperParameters": { + "target": "com.amazonaws.sagemaker#HyperParameters", + "traits": { + "smithy.api#documentation": "

Algorithm-specific parameters.

" + } + }, + "AlgorithmSpecification": { + "target": "com.amazonaws.sagemaker#AlgorithmSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Information about the algorithm used for training, and algorithm metadata.\n

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Identity and Access Management (IAM) role configured for\n the training job.

" + } + }, + "InputDataConfig": { + "target": "com.amazonaws.sagemaker#InputDataConfig", + "traits": { + "smithy.api#documentation": "

An array of Channel objects that describes each data input channel.\n

" + } + }, + "OutputDataConfig": { + "target": "com.amazonaws.sagemaker#OutputDataConfig", + "traits": { + "smithy.api#documentation": "

The S3 path where model artifacts that you configured when creating the job are\n stored. SageMaker creates subfolders for model artifacts.

" + } + }, + "ResourceConfig": { + "target": "com.amazonaws.sagemaker#ResourceConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Resources, including ML compute instances and ML storage volumes, that are\n configured for model training.

", + "smithy.api#required": {} + } + }, + "WarmPoolStatus": { + "target": "com.amazonaws.sagemaker#WarmPoolStatus", + "traits": { + "smithy.api#documentation": "

The status of the warm pool associated with the training job.

" + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig", + "traits": { + "smithy.api#documentation": "

A VpcConfig object that specifies the VPC that this training job has access\n to. For more information, see Protect Training Jobs by Using an Amazon\n Virtual Private Cloud.

" + } + }, + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#StoppingCondition", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies a limit to how long a model training job can run. It also specifies how long\n a managed Spot training job has to complete. When the job reaches the time limit, SageMaker\n ends the training job. Use this API to cap model training costs.

\n

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays\n job termination for 120 seconds. Algorithms can use this 120-second window to save the\n model artifacts, so the results of training are not lost.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A timestamp that indicates when the training job was created.

", + "smithy.api#required": {} + } + }, + "TrainingStartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Indicates the time when the training job starts on training instances. You are\n billed for the time interval between this time and the value of\n TrainingEndTime. The start time in CloudWatch Logs might be later than this time.\n The difference is due to the time it takes to download the training data and to the size\n of the training container.

" + } + }, + "TrainingEndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Indicates the time when the training job ends on training instances. You are billed\n for the time interval between the value of TrainingStartTime and this time.\n For successful jobs and stopped jobs, this is the time after model artifacts are\n uploaded. For failed jobs, this is the time when SageMaker detects a job failure.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A timestamp that indicates when the status of the training job was last\n modified.

" + } + }, + "SecondaryStatusTransitions": { + "target": "com.amazonaws.sagemaker#SecondaryStatusTransitions", + "traits": { + "smithy.api#documentation": "

A history of all of the secondary statuses that the training job has transitioned\n through.

" + } + }, + "FinalMetricDataList": { + "target": "com.amazonaws.sagemaker#FinalMetricDataList", + "traits": { + "smithy.api#documentation": "

A collection of MetricData objects that specify the names, values, and\n dates and times that the training algorithm emitted to Amazon CloudWatch.

" + } + }, + "EnableNetworkIsolation": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

If you want to allow inbound or outbound network calls, except for calls between peers\n within a training cluster for distributed training, choose True. If you\n enable network isolation for training jobs that are configured to use a VPC, SageMaker\n downloads and uploads customer data and model artifacts through the specified VPC, but\n the training container does not have network access.

" + } + }, + "EnableInterContainerTrafficEncryption": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

To encrypt all communications between ML compute instances in distributed training,\n choose True. Encryption provides greater security for distributed training,\n but training might take longer. How long it takes depends on the amount of communication\n between compute instances, especially if you use a deep learning algorithms in\n distributed training.

" + } + }, + "EnableManagedSpotTraining": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

A Boolean indicating whether managed spot training is enabled (True) or\n not (False).

" + } + }, + "CheckpointConfig": { + "target": "com.amazonaws.sagemaker#CheckpointConfig" + }, + "TrainingTimeInSeconds": { + "target": "com.amazonaws.sagemaker#TrainingTimeInSeconds", + "traits": { + "smithy.api#documentation": "

The training time in seconds.

" + } + }, + "BillableTimeInSeconds": { + "target": "com.amazonaws.sagemaker#BillableTimeInSeconds", + "traits": { + "smithy.api#documentation": "

The billable time in seconds. Billable time refers to the absolute wall-clock\n time.

\n

Multiply BillableTimeInSeconds by the number of instances\n (InstanceCount) in your training cluster to get the total compute time\n SageMaker bills you if you run distributed training. The formula is as follows:\n BillableTimeInSeconds * InstanceCount .

\n

You can calculate the savings from using managed spot training using the formula\n (1 - BillableTimeInSeconds / TrainingTimeInSeconds) * 100. For example,\n if BillableTimeInSeconds is 100 and TrainingTimeInSeconds is\n 500, the savings is 80%.

" + } + }, + "DebugHookConfig": { + "target": "com.amazonaws.sagemaker#DebugHookConfig" + }, + "ExperimentConfig": { + "target": "com.amazonaws.sagemaker#ExperimentConfig" + }, + "DebugRuleConfigurations": { + "target": "com.amazonaws.sagemaker#DebugRuleConfigurations", + "traits": { + "smithy.api#documentation": "

Configuration information for Amazon SageMaker Debugger rules for debugging output tensors.

" + } + }, + "TensorBoardOutputConfig": { + "target": "com.amazonaws.sagemaker#TensorBoardOutputConfig" + }, + "DebugRuleEvaluationStatuses": { + "target": "com.amazonaws.sagemaker#DebugRuleEvaluationStatuses", + "traits": { + "smithy.api#documentation": "

Evaluation status of Amazon SageMaker Debugger rules for debugging on a training job.

" + } + }, + "ProfilerConfig": { + "target": "com.amazonaws.sagemaker#ProfilerConfig" + }, + "ProfilerRuleConfigurations": { + "target": "com.amazonaws.sagemaker#ProfilerRuleConfigurations", + "traits": { + "smithy.api#documentation": "

Configuration information for Amazon SageMaker Debugger rules for profiling system and framework\n metrics.

" + } + }, + "ProfilerRuleEvaluationStatuses": { + "target": "com.amazonaws.sagemaker#ProfilerRuleEvaluationStatuses", + "traits": { + "smithy.api#documentation": "

Evaluation status of Amazon SageMaker Debugger rules for profiling on a training job.

" + } + }, + "ProfilingStatus": { + "target": "com.amazonaws.sagemaker#ProfilingStatus", + "traits": { + "smithy.api#documentation": "

Profiling status of a training job.

" + } + }, + "Environment": { + "target": "com.amazonaws.sagemaker#TrainingEnvironmentMap", + "traits": { + "smithy.api#documentation": "

The environment variables to set in the Docker container.

" + } + }, + "RetryStrategy": { + "target": "com.amazonaws.sagemaker#RetryStrategy", + "traits": { + "smithy.api#documentation": "

The number of times to retry the job when the job fails due to an\n InternalServerError.

" + } + }, + "RemoteDebugConfig": { + "target": "com.amazonaws.sagemaker#RemoteDebugConfig", + "traits": { + "smithy.api#documentation": "

Configuration for remote debugging. To learn more about the remote debugging\n functionality of SageMaker, see Access a training container\n through Amazon Web Services Systems Manager (SSM) for remote\n debugging.

" + } + }, + "InfraCheckConfig": { + "target": "com.amazonaws.sagemaker#InfraCheckConfig", + "traits": { + "smithy.api#documentation": "

Contains information about the infrastructure health check configuration for the training job.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeTrainingPlan": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeTrainingPlanRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeTrainingPlanResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves detailed information about a specific training plan.

" + } + }, + "com.amazonaws.sagemaker#DescribeTrainingPlanRequest": { + "type": "structure", + "members": { + "TrainingPlanName": { + "target": "com.amazonaws.sagemaker#TrainingPlanName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the training plan to describe.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeTrainingPlanResponse": { + "type": "structure", + "members": { + "TrainingPlanArn": { + "target": "com.amazonaws.sagemaker#TrainingPlanArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN); of the training plan.

", + "smithy.api#required": {} + } + }, + "TrainingPlanName": { + "target": "com.amazonaws.sagemaker#TrainingPlanName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the training plan.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#TrainingPlanStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The current status of the training plan (e.g., Pending, Active, Expired). To see the\n complete list of status values available for a training plan, refer to the\n Status attribute within the \n TrainingPlanSummary\n object.

", + "smithy.api#required": {} + } + }, + "StatusMessage": { + "target": "com.amazonaws.sagemaker#TrainingPlanStatusMessage", + "traits": { + "smithy.api#documentation": "

A message providing additional information about the current status of the training\n plan.

" + } + }, + "DurationHours": { + "target": "com.amazonaws.sagemaker#TrainingPlanDurationHours", + "traits": { + "smithy.api#documentation": "

The number of whole hours in the total duration for this training plan.

" + } + }, + "DurationMinutes": { + "target": "com.amazonaws.sagemaker#TrainingPlanDurationMinutes", + "traits": { + "smithy.api#documentation": "

The additional minutes beyond whole hours in the total duration for this training\n plan.

" + } + }, + "StartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The start time of the training plan.

" + } + }, + "EndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The end time of the training plan.

" + } + }, + "UpfrontFee": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "

The upfront fee for the training plan.

" + } + }, + "CurrencyCode": { + "target": "com.amazonaws.sagemaker#CurrencyCode", + "traits": { + "smithy.api#documentation": "

The currency code for the upfront fee (e.g., USD).

" + } + }, + "TotalInstanceCount": { + "target": "com.amazonaws.sagemaker#TotalInstanceCount", + "traits": { + "smithy.api#documentation": "

The total number of instances reserved in this training plan.

" + } + }, + "AvailableInstanceCount": { + "target": "com.amazonaws.sagemaker#AvailableInstanceCount", + "traits": { + "smithy.api#documentation": "

The number of instances currently available for use in this training plan.

" + } + }, + "InUseInstanceCount": { + "target": "com.amazonaws.sagemaker#InUseInstanceCount", + "traits": { + "smithy.api#documentation": "

The number of instances currently in use from this training plan.

" + } + }, + "TargetResources": { + "target": "com.amazonaws.sagemaker#SageMakerResourceNames", + "traits": { + "smithy.api#documentation": "

The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) that can use this training\n plan.

\n

Training plans are specific to their target resource.

\n
    \n
  • \n

    A training plan designed for SageMaker training jobs can only be used to schedule and\n run training jobs.

    \n
    • \n
  • \n

    A training plan for HyperPod clusters can be used exclusively to provide\n compute resources to a cluster's instance group.

    \n
    • \n
" + } + }, + "ReservedCapacitySummaries": { + "target": "com.amazonaws.sagemaker#ReservedCapacitySummaries", + "traits": { + "smithy.api#documentation": "

The list of Reserved Capacity providing the underlying compute resources of the plan.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeTransformJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeTransformJobRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeTransformJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a transform job.

", + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "TransformJobCompletedOrStopped": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "TransformJobStatus", + "expected": "Completed", + "comparator": "stringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "output": { + "path": "TransformJobStatus", + "expected": "Stopped", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "TransformJobStatus", + "expected": "Failed", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "errorType": "ValidationException" + } + } + ], + "minDelay": 60 + } + } + } + }, + "com.amazonaws.sagemaker#DescribeTransformJobRequest": { + "type": "structure", + "members": { + "TransformJobName": { + "target": "com.amazonaws.sagemaker#TransformJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the transform job that you want to view details of.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeTransformJobResponse": { + "type": "structure", + "members": { + "TransformJobName": { + "target": "com.amazonaws.sagemaker#TransformJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the transform job.

", + "smithy.api#required": {} + } + }, + "TransformJobArn": { + "target": "com.amazonaws.sagemaker#TransformJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the transform job.

", + "smithy.api#required": {} + } + }, + "TransformJobStatus": { + "target": "com.amazonaws.sagemaker#TransformJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The\n status of the transform job. If the transform job failed, the reason\n is returned in the FailureReason field.

", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "

If the transform job failed, FailureReason describes\n why\n it failed. A transform job creates a log file, which includes error\n messages, and stores it\n as\n an Amazon S3 object. For more information, see Log Amazon SageMaker Events with\n Amazon CloudWatch.

" + } + }, + "ModelName": { + "target": "com.amazonaws.sagemaker#ModelName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the model used in the transform job.

", + "smithy.api#required": {} + } + }, + "MaxConcurrentTransforms": { + "target": "com.amazonaws.sagemaker#MaxConcurrentTransforms", + "traits": { + "smithy.api#documentation": "

The\n maximum number\n of\n parallel requests on each instance node\n that can be launched in a transform job. The default value is 1.

" + } + }, + "ModelClientConfig": { + "target": "com.amazonaws.sagemaker#ModelClientConfig", + "traits": { + "smithy.api#documentation": "

The timeout and maximum number of retries for processing a transform job\n invocation.

" + } + }, + "MaxPayloadInMB": { + "target": "com.amazonaws.sagemaker#MaxPayloadInMB", + "traits": { + "smithy.api#documentation": "

The\n maximum\n payload size, in MB, used in the\n transform job.

" + } + }, + "BatchStrategy": { + "target": "com.amazonaws.sagemaker#BatchStrategy", + "traits": { + "smithy.api#documentation": "

Specifies the number of records to include in a mini-batch for an HTTP inference\n request.\n A record\n is a single unit of input data that inference\n can be made on. For example, a single line in a CSV file is a record.

\n

To enable the batch strategy, you must set SplitType\n to\n Line, RecordIO, or\n TFRecord.

" + } + }, + "Environment": { + "target": "com.amazonaws.sagemaker#TransformEnvironmentMap", + "traits": { + "smithy.api#documentation": "

The\n environment variables to set in the Docker container. We support up to 16 key and values\n entries in the map.

" + } + }, + "TransformInput": { + "target": "com.amazonaws.sagemaker#TransformInput", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Describes the dataset to be transformed and the Amazon S3 location where it is\n stored.

", + "smithy.api#required": {} + } + }, + "TransformOutput": { + "target": "com.amazonaws.sagemaker#TransformOutput", + "traits": { + "smithy.api#documentation": "

Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the\n transform job.

" + } + }, + "DataCaptureConfig": { + "target": "com.amazonaws.sagemaker#BatchDataCaptureConfig", + "traits": { + "smithy.api#documentation": "

Configuration to control how SageMaker captures inference data.

" + } + }, + "TransformResources": { + "target": "com.amazonaws.sagemaker#TransformResources", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Describes\n the resources, including ML instance types and ML instance count, to\n use for the transform job.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A timestamp that shows when the transform Job was created.

", + "smithy.api#required": {} + } + }, + "TransformStartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Indicates when the transform job starts\n on\n ML instances. You are billed for the time interval between this time\n and the value of TransformEndTime.

" + } + }, + "TransformEndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Indicates when the transform job has been\n \n completed, or has stopped or failed. You are billed for the time\n interval between this time and the value of TransformStartTime.

" + } + }, + "LabelingJobArn": { + "target": "com.amazonaws.sagemaker#LabelingJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the\n transform or training job.

" + } + }, + "AutoMLJobArn": { + "target": "com.amazonaws.sagemaker#AutoMLJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AutoML transform job.

" + } + }, + "DataProcessing": { + "target": "com.amazonaws.sagemaker#DataProcessing" + }, + "ExperimentConfig": { + "target": "com.amazonaws.sagemaker#ExperimentConfig" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeTrial": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeTrialRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeTrialResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Provides a list of a trial's properties.

" + } + }, + "com.amazonaws.sagemaker#DescribeTrialComponent": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeTrialComponentRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeTrialComponentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Provides a list of a trials component's properties.

" + } + }, + "com.amazonaws.sagemaker#DescribeTrialComponentRequest": { + "type": "structure", + "members": { + "TrialComponentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the trial component to describe.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeTrialComponentResponse": { + "type": "structure", + "members": { + "TrialComponentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

The name of the trial component.

" + } + }, + "TrialComponentArn": { + "target": "com.amazonaws.sagemaker#TrialComponentArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the trial component.

" + } + }, + "DisplayName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

The name of the component as displayed. If DisplayName isn't specified,\n TrialComponentName is displayed.

" + } + }, + "Source": { + "target": "com.amazonaws.sagemaker#TrialComponentSource", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source and, optionally, the job type.

" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#TrialComponentStatus", + "traits": { + "smithy.api#documentation": "

The status of the component. States include:

\n
    \n
  • \n

    InProgress

    \n
    • \n
  • \n

    Completed

    \n
    • \n
  • \n

    Failed

    \n
    • \n
" + } + }, + "StartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the component started.

" + } + }, + "EndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the component ended.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the component was created.

" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext", + "traits": { + "smithy.api#documentation": "

Who created the trial component.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the component was last modified.

" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext", + "traits": { + "smithy.api#documentation": "

Who last modified the component.

" + } + }, + "Parameters": { + "target": "com.amazonaws.sagemaker#TrialComponentParameters", + "traits": { + "smithy.api#documentation": "

The hyperparameters of the component.

" + } + }, + "InputArtifacts": { + "target": "com.amazonaws.sagemaker#TrialComponentArtifacts", + "traits": { + "smithy.api#documentation": "

The input artifacts of the component.

" + } + }, + "OutputArtifacts": { + "target": "com.amazonaws.sagemaker#TrialComponentArtifacts", + "traits": { + "smithy.api#documentation": "

The output artifacts of the component.

" + } + }, + "MetadataProperties": { + "target": "com.amazonaws.sagemaker#MetadataProperties" + }, + "Metrics": { + "target": "com.amazonaws.sagemaker#TrialComponentMetricSummaries", + "traits": { + "smithy.api#documentation": "

The metrics for the component.

" + } + }, + "LineageGroupArn": { + "target": "com.amazonaws.sagemaker#LineageGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the lineage group.

" + } + }, + "Sources": { + "target": "com.amazonaws.sagemaker#TrialComponentSources", + "traits": { + "smithy.api#documentation": "

A list of ARNs and, if applicable, job types for multiple sources of an experiment\n run.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeTrialRequest": { + "type": "structure", + "members": { + "TrialName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the trial to describe.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeTrialResponse": { + "type": "structure", + "members": { + "TrialName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

The name of the trial.

" + } + }, + "TrialArn": { + "target": "com.amazonaws.sagemaker#TrialArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the trial.

" + } + }, + "DisplayName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

The name of the trial as displayed. If DisplayName isn't specified,\n TrialName is displayed.

" + } + }, + "ExperimentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

The name of the experiment the trial is part of.

" + } + }, + "Source": { + "target": "com.amazonaws.sagemaker#TrialSource", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source and, optionally, the job type.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the trial was created.

" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext", + "traits": { + "smithy.api#documentation": "

Who created the trial.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the trial was last modified.

" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext", + "traits": { + "smithy.api#documentation": "

Who last modified the trial.

" + } + }, + "MetadataProperties": { + "target": "com.amazonaws.sagemaker#MetadataProperties" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeUserProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeUserProfileRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeUserProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Describes a user profile. For more information, see CreateUserProfile.

" + } + }, + "com.amazonaws.sagemaker#DescribeUserProfileRequest": { + "type": "structure", + "members": { + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The domain ID.

", + "smithy.api#required": {} + } + }, + "UserProfileName": { + "target": "com.amazonaws.sagemaker#UserProfileName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The user profile name. This value is not case sensitive.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeUserProfileResponse": { + "type": "structure", + "members": { + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the domain that contains the profile.

" + } + }, + "UserProfileArn": { + "target": "com.amazonaws.sagemaker#UserProfileArn", + "traits": { + "smithy.api#documentation": "

The user profile Amazon Resource Name (ARN).

" + } + }, + "UserProfileName": { + "target": "com.amazonaws.sagemaker#UserProfileName", + "traits": { + "smithy.api#documentation": "

The user profile name.

" + } + }, + "HomeEfsFileSystemUid": { + "target": "com.amazonaws.sagemaker#EfsUid", + "traits": { + "smithy.api#documentation": "

The ID of the user's profile in the Amazon Elastic File System volume.

" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#UserProfileStatus", + "traits": { + "smithy.api#documentation": "

The status.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "

The last modified time.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "

The creation time.

" + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "

The failure reason.

" + } + }, + "SingleSignOnUserIdentifier": { + "target": "com.amazonaws.sagemaker#SingleSignOnUserIdentifier", + "traits": { + "smithy.api#documentation": "

The IAM Identity Center user identifier.

" + } + }, + "SingleSignOnUserValue": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "

The IAM Identity Center user value.

" + } + }, + "UserSettings": { + "target": "com.amazonaws.sagemaker#UserSettings", + "traits": { + "smithy.api#documentation": "

A collection of settings.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeWorkforce": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeWorkforceRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeWorkforceResponse" + }, + "traits": { + "smithy.api#documentation": "

Lists private workforce information, including workforce name, Amazon Resource Name\n (ARN), and, if applicable, allowed IP address ranges (CIDRs). Allowable IP address\n ranges are the IP addresses that workers can use to access tasks.

\n \n

This operation applies only to private workforces.

\n " + } + }, + "com.amazonaws.sagemaker#DescribeWorkforceRequest": { + "type": "structure", + "members": { + "WorkforceName": { + "target": "com.amazonaws.sagemaker#WorkforceName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the private workforce whose access you want to restrict.\n WorkforceName is automatically set to default when a\n workforce is created and cannot be modified.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeWorkforceResponse": { + "type": "structure", + "members": { + "Workforce": { + "target": "com.amazonaws.sagemaker#Workforce", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A single private workforce, which is automatically created when you create your first\n private work team. You can create one private work force in each Amazon Web Services Region. By default,\n any workforce-related API operation used in a specific region will apply to the\n workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeWorkteam": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeWorkteamRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeWorkteamResponse" + }, + "traits": { + "smithy.api#documentation": "

Gets information about a specific work team. You can see information such as the\n creation date, the last updated date, membership information, and the work team's Amazon\n Resource Name (ARN).

" + } + }, + "com.amazonaws.sagemaker#DescribeWorkteamRequest": { + "type": "structure", + "members": { + "WorkteamName": { + "target": "com.amazonaws.sagemaker#WorkteamName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the work team to return a description of.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeWorkteamResponse": { + "type": "structure", + "members": { + "Workteam": { + "target": "com.amazonaws.sagemaker#Workteam", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A Workteam instance that contains information about the work team.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + } + } + }, + "com.amazonaws.sagemaker#DesiredWeightAndCapacity": { + "type": "structure", + "members": { + "VariantName": { + "target": "com.amazonaws.sagemaker#VariantName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the variant to update.

", + "smithy.api#required": {} + } + }, + "DesiredWeight": { + "target": "com.amazonaws.sagemaker#VariantWeight", + "traits": { + "smithy.api#documentation": "

The variant's weight.

" + } + }, + "DesiredInstanceCount": { + "target": "com.amazonaws.sagemaker#TaskCount", + "traits": { + "smithy.api#documentation": "

The variant's capacity.

" + } + }, + "ServerlessUpdateConfig": { + "target": "com.amazonaws.sagemaker#ProductionVariantServerlessUpdateConfig", + "traits": { + "smithy.api#documentation": "

Specifies the serverless update concurrency configuration for an endpoint variant.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies weight and capacity values for a production variant.

" + } + }, + "com.amazonaws.sagemaker#DesiredWeightAndCapacityList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#DesiredWeightAndCapacity" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#DestinationS3Uri": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^(https|s3)://([^/])/?(.*)$" + } + }, + "com.amazonaws.sagemaker#DetailedAlgorithmStatus": { + "type": "enum", + "members": { + "NOT_STARTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotStarted" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + } + } + }, + "com.amazonaws.sagemaker#DetailedModelPackageStatus": { + "type": "enum", + "members": { + "NOT_STARTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotStarted" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + } + } + }, + "com.amazonaws.sagemaker#Device": { + "type": "structure", + "members": { + "DeviceName": { + "target": "com.amazonaws.sagemaker#DeviceName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the device.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#DeviceDescription", + "traits": { + "smithy.api#documentation": "

Description of the device.

" + } + }, + "IotThingName": { + "target": "com.amazonaws.sagemaker#ThingName", + "traits": { + "smithy.api#documentation": "

Amazon Web Services Internet of Things (IoT) object name.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information of a particular device.

" + } + }, + "com.amazonaws.sagemaker#DeviceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:[a-z\\-]*:[a-z\\-]*:\\d{12}:[a-z\\-]*/?[a-zA-Z_0-9+=,.@\\-_/]+$" + } + }, + "com.amazonaws.sagemaker#DeviceDeploymentStatus": { + "type": "enum", + "members": { + "ReadyToDeploy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READYTODEPLOY" + } + }, + "InProgress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INPROGRESS" + } + }, + "Deployed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEPLOYED" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "Stopping": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPING" + } + }, + "Stopped": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + } + } + }, + "com.amazonaws.sagemaker#DeviceDeploymentSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#DeviceDeploymentSummary" + } + }, + "com.amazonaws.sagemaker#DeviceDeploymentSummary": { + "type": "structure", + "members": { + "EdgeDeploymentPlanArn": { + "target": "com.amazonaws.sagemaker#EdgeDeploymentPlanArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the edge deployment plan.

", + "smithy.api#required": {} + } + }, + "EdgeDeploymentPlanName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the edge deployment plan.

", + "smithy.api#required": {} + } + }, + "StageName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the stage in the edge deployment plan.

", + "smithy.api#required": {} + } + }, + "DeployedStageName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the deployed stage.

" + } + }, + "DeviceFleetName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the fleet to which the device belongs to.

" + } + }, + "DeviceName": { + "target": "com.amazonaws.sagemaker#DeviceName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the device.

", + "smithy.api#required": {} + } + }, + "DeviceArn": { + "target": "com.amazonaws.sagemaker#DeviceArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the device.

", + "smithy.api#required": {} + } + }, + "DeviceDeploymentStatus": { + "target": "com.amazonaws.sagemaker#DeviceDeploymentStatus", + "traits": { + "smithy.api#documentation": "

The deployment status of the device.

" + } + }, + "DeviceDeploymentStatusMessage": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The detailed error message for the deployoment status result.

" + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#DeviceDescription", + "traits": { + "smithy.api#documentation": "

The description of the device.

" + } + }, + "DeploymentStartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the deployment on the device started.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information summarizing device details and deployment status.

" + } + }, + "com.amazonaws.sagemaker#DeviceDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 40 + }, + "smithy.api#pattern": "^[-a-zA-Z0-9_.,;:! ]*$" + } + }, + "com.amazonaws.sagemaker#DeviceFleetArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws[a-z\\-]*:iam::\\d{12}:device-fleet/?[a-zA-Z_0-9+=,.@\\-_/]+$" + } + }, + "com.amazonaws.sagemaker#DeviceFleetDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 800 + }, + "smithy.api#pattern": "^[-a-zA-Z0-9_.,;:! ]*$" + } + }, + "com.amazonaws.sagemaker#DeviceFleetSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#DeviceFleetSummary" + } + }, + "com.amazonaws.sagemaker#DeviceFleetSummary": { + "type": "structure", + "members": { + "DeviceFleetArn": { + "target": "com.amazonaws.sagemaker#DeviceFleetArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Amazon Resource Name (ARN) of the device fleet.

", + "smithy.api#required": {} + } + }, + "DeviceFleetName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Name of the device fleet.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Timestamp of when the device fleet was created.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Timestamp of when the device fleet was last updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Summary of the device fleet.

" + } + }, + "com.amazonaws.sagemaker#DeviceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#DeviceNames": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#DeviceName" + } + }, + "com.amazonaws.sagemaker#DeviceSelectionConfig": { + "type": "structure", + "members": { + "DeviceSubsetType": { + "target": "com.amazonaws.sagemaker#DeviceSubsetType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Type of device subsets to deploy to the current stage.

", + "smithy.api#required": {} + } + }, + "Percentage": { + "target": "com.amazonaws.sagemaker#Percentage", + "traits": { + "smithy.api#documentation": "

Percentage of devices in the fleet to deploy to the current stage.

" + } + }, + "DeviceNames": { + "target": "com.amazonaws.sagemaker#DeviceNames", + "traits": { + "smithy.api#documentation": "

List of devices chosen to deploy.

" + } + }, + "DeviceNameContains": { + "target": "com.amazonaws.sagemaker#DeviceName", + "traits": { + "smithy.api#documentation": "

A filter to select devices with names containing this name.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the configurations of selected devices.

" + } + }, + "com.amazonaws.sagemaker#DeviceStats": { + "type": "structure", + "members": { + "ConnectedDeviceCount": { + "target": "com.amazonaws.sagemaker#Long", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of devices connected with a heartbeat.

", + "smithy.api#required": {} + } + }, + "RegisteredDeviceCount": { + "target": "com.amazonaws.sagemaker#Long", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of registered devices.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Status of devices.

" + } + }, + "com.amazonaws.sagemaker#DeviceSubsetType": { + "type": "enum", + "members": { + "Percentage": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERCENTAGE" + } + }, + "Selection": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SELECTION" + } + }, + "NameContains": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAMECONTAINS" + } + } + } + }, + "com.amazonaws.sagemaker#DeviceSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#DeviceSummary" + } + }, + "com.amazonaws.sagemaker#DeviceSummary": { + "type": "structure", + "members": { + "DeviceName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The unique identifier of the device.

", + "smithy.api#required": {} + } + }, + "DeviceArn": { + "target": "com.amazonaws.sagemaker#DeviceArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Amazon Resource Name (ARN) of the device.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#DeviceDescription", + "traits": { + "smithy.api#documentation": "

A description of the device.

" + } + }, + "DeviceFleetName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the fleet the device belongs to.

" + } + }, + "IotThingName": { + "target": "com.amazonaws.sagemaker#ThingName", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Internet of Things (IoT) object thing name associated with the device..

" + } + }, + "RegistrationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of the last registration or de-reregistration.

" + } + }, + "LatestHeartbeat": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The last heartbeat received from the device.

" + } + }, + "Models": { + "target": "com.amazonaws.sagemaker#EdgeModelSummaries", + "traits": { + "smithy.api#documentation": "

Models on the device.

" + } + }, + "AgentVersion": { + "target": "com.amazonaws.sagemaker#EdgeVersion", + "traits": { + "smithy.api#documentation": "

Edge Manager agent version.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Summary of the device.

" + } + }, + "com.amazonaws.sagemaker#Devices": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#Device" + } + }, + "com.amazonaws.sagemaker#Dimension": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 8192 + } + } + }, + "com.amazonaws.sagemaker#DirectDeploySettings": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.sagemaker#FeatureStatus", + "traits": { + "smithy.api#documentation": "

Describes whether model deployment permissions are enabled or disabled in the Canvas application.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The model deployment settings for the SageMaker Canvas application.

\n \n

In order to enable model deployment for Canvas, the SageMaker Domain's or user profile's Amazon Web Services IAM\n execution role must have the AmazonSageMakerCanvasDirectDeployAccess policy attached. You can also\n turn on model deployment permissions through the SageMaker Domain's or user profile's settings in the SageMaker console.

\n " + } + }, + "com.amazonaws.sagemaker#DirectInternetAccess": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enabled" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disabled" + } + } + } + }, + "com.amazonaws.sagemaker#Direction": { + "type": "enum", + "members": { + "BOTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Both" + } + }, + "ASCENDANTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ascendants" + } + }, + "DESCENDANTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Descendants" + } + } + } + }, + "com.amazonaws.sagemaker#DirectoryPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4096 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#DisableProfiler": { + "type": "boolean" + }, + "com.amazonaws.sagemaker#DisableSagemakerServicecatalogPortfolio": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DisableSagemakerServicecatalogPortfolioInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#DisableSagemakerServicecatalogPortfolioOutput" + }, + "traits": { + "smithy.api#documentation": "

Disables using Service Catalog in SageMaker. Service Catalog is used to create\n SageMaker projects.

" + } + }, + "com.amazonaws.sagemaker#DisableSagemakerServicecatalogPortfolioInput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DisableSagemakerServicecatalogPortfolioOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DisassociateAdditionalCodeRepositories": { + "type": "boolean" + }, + "com.amazonaws.sagemaker#DisassociateDefaultCodeRepository": { + "type": "boolean" + }, + "com.amazonaws.sagemaker#DisassociateNotebookInstanceAcceleratorTypes": { + "type": "boolean" + }, + "com.amazonaws.sagemaker#DisassociateNotebookInstanceLifecycleConfig": { + "type": "boolean" + }, + "com.amazonaws.sagemaker#DisassociateTrialComponent": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DisassociateTrialComponentRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DisassociateTrialComponentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Disassociates a trial component from a trial. This doesn't effect other trials the\n component is associated with. Before you can delete a component, you must disassociate the\n component from all trials it is associated with. To associate a trial component with a trial,\n call the AssociateTrialComponent API.

\n

To get a list of the trials a component is associated with, use the Search API. Specify ExperimentTrialComponent for the Resource parameter.\n The list appears in the response under Results.TrialComponent.Parents.

" + } + }, + "com.amazonaws.sagemaker#DisassociateTrialComponentRequest": { + "type": "structure", + "members": { + "TrialComponentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the component to disassociate from the trial.

", + "smithy.api#required": {} + } + }, + "TrialName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the trial to disassociate from.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DisassociateTrialComponentResponse": { + "type": "structure", + "members": { + "TrialComponentArn": { + "target": "com.amazonaws.sagemaker#TrialComponentArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the trial component.

" + } + }, + "TrialArn": { + "target": "com.amazonaws.sagemaker#TrialArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the trial.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DockerSettings": { + "type": "structure", + "members": { + "EnableDockerAccess": { + "target": "com.amazonaws.sagemaker#FeatureStatus", + "traits": { + "smithy.api#documentation": "

Indicates whether the domain can access Docker.

" + } + }, + "VpcOnlyTrustedAccounts": { + "target": "com.amazonaws.sagemaker#VpcOnlyTrustedAccounts", + "traits": { + "smithy.api#documentation": "

The list of Amazon Web Services accounts that are trusted when the domain is created in\n VPC-only mode.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A collection of settings that configure the domain's Docker interaction.

" + } + }, + "com.amazonaws.sagemaker#DocumentSchemaVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 5, + "max": 14 + }, + "smithy.api#pattern": "^\\d{1,4}.\\d{1,4}.\\d{1,4}$" + } + }, + "com.amazonaws.sagemaker#Dollars": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 2 + } + } + }, + "com.amazonaws.sagemaker#DomainArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:domain/" + } + }, + "com.amazonaws.sagemaker#DomainDetails": { + "type": "structure", + "members": { + "DomainArn": { + "target": "com.amazonaws.sagemaker#DomainArn", + "traits": { + "smithy.api#documentation": "

The domain's Amazon Resource Name (ARN).

" + } + }, + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#documentation": "

The domain ID.

" + } + }, + "DomainName": { + "target": "com.amazonaws.sagemaker#DomainName", + "traits": { + "smithy.api#documentation": "

The domain name.

" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#DomainStatus", + "traits": { + "smithy.api#documentation": "

The status.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "

The creation time.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "

The last modified time.

" + } + }, + "Url": { + "target": "com.amazonaws.sagemaker#String1024", + "traits": { + "smithy.api#documentation": "

The domain's URL.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The domain's details.

" + } + }, + "com.amazonaws.sagemaker#DomainId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^d-(-*[a-z0-9]){1,61}$" + } + }, + "com.amazonaws.sagemaker#DomainList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#DomainDetails" + } + }, + "com.amazonaws.sagemaker#DomainName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#DomainSecurityGroupIds": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#SecurityGroupId" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3 + } + } + }, + "com.amazonaws.sagemaker#DomainSettings": { + "type": "structure", + "members": { + "SecurityGroupIds": { + "target": "com.amazonaws.sagemaker#DomainSecurityGroupIds", + "traits": { + "smithy.api#documentation": "

The security groups for the Amazon Virtual Private Cloud that the Domain uses for\n communication between Domain-level apps and user apps.

" + } + }, + "RStudioServerProDomainSettings": { + "target": "com.amazonaws.sagemaker#RStudioServerProDomainSettings", + "traits": { + "smithy.api#documentation": "

A collection of settings that configure the RStudioServerPro Domain-level\n app.

" + } + }, + "ExecutionRoleIdentityConfig": { + "target": "com.amazonaws.sagemaker#ExecutionRoleIdentityConfig", + "traits": { + "smithy.api#documentation": "

The configuration for attaching a SageMaker AI user profile name to the execution\n role as a sts:SourceIdentity key.

" + } + }, + "DockerSettings": { + "target": "com.amazonaws.sagemaker#DockerSettings", + "traits": { + "smithy.api#documentation": "

A collection of settings that configure the domain's Docker interaction.

" + } + }, + "AmazonQSettings": { + "target": "com.amazonaws.sagemaker#AmazonQSettings", + "traits": { + "smithy.api#documentation": "

A collection of settings that configure the Amazon Q experience within the domain. The\n AuthMode that you use to create the domain must be SSO.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A collection of settings that apply to the SageMaker Domain. These settings\n are specified through the CreateDomain API call.

" + } + }, + "com.amazonaws.sagemaker#DomainSettingsForUpdate": { + "type": "structure", + "members": { + "RStudioServerProDomainSettingsForUpdate": { + "target": "com.amazonaws.sagemaker#RStudioServerProDomainSettingsForUpdate", + "traits": { + "smithy.api#documentation": "

A collection of RStudioServerPro Domain-level app settings to update. A\n single RStudioServerPro application is created for a domain.

" + } + }, + "ExecutionRoleIdentityConfig": { + "target": "com.amazonaws.sagemaker#ExecutionRoleIdentityConfig", + "traits": { + "smithy.api#documentation": "

The configuration for attaching a SageMaker AI user profile name to the execution\n role as a sts:SourceIdentity key. This configuration can only be modified if there are no\n apps in the InService or Pending state.

" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.sagemaker#DomainSecurityGroupIds", + "traits": { + "smithy.api#documentation": "

The security groups for the Amazon Virtual Private Cloud that the Domain uses for\n communication between Domain-level apps and user apps.

" + } + }, + "DockerSettings": { + "target": "com.amazonaws.sagemaker#DockerSettings", + "traits": { + "smithy.api#documentation": "

A collection of settings that configure the domain's Docker interaction.

" + } + }, + "AmazonQSettings": { + "target": "com.amazonaws.sagemaker#AmazonQSettings", + "traits": { + "smithy.api#documentation": "

A collection of settings that configure the Amazon Q experience within the domain.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A collection of Domain configuration settings to update.

" + } + }, + "com.amazonaws.sagemaker#DomainStatus": { + "type": "enum", + "members": { + "Deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "InService": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InService" + } + }, + "Pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "Updating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + }, + "Update_Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Update_Failed" + } + }, + "Delete_Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Delete_Failed" + } + } + } + }, + "com.amazonaws.sagemaker#Double": { + "type": "double" + }, + "com.amazonaws.sagemaker#DoubleParameterValue": { + "type": "double" + }, + "com.amazonaws.sagemaker#DriftCheckBaselines": { + "type": "structure", + "members": { + "Bias": { + "target": "com.amazonaws.sagemaker#DriftCheckBias", + "traits": { + "smithy.api#documentation": "

Represents the drift check bias baselines that can be used when the model monitor is set using the model \n package.

" + } + }, + "Explainability": { + "target": "com.amazonaws.sagemaker#DriftCheckExplainability", + "traits": { + "smithy.api#documentation": "

Represents the drift check explainability baselines that can be used when the model monitor is set using \n the model package.

" + } + }, + "ModelQuality": { + "target": "com.amazonaws.sagemaker#DriftCheckModelQuality", + "traits": { + "smithy.api#documentation": "

Represents the drift check model quality baselines that can be used when the model monitor is set using \n the model package.

" + } + }, + "ModelDataQuality": { + "target": "com.amazonaws.sagemaker#DriftCheckModelDataQuality", + "traits": { + "smithy.api#documentation": "

Represents the drift check model data quality baselines that can be used when the model monitor is set \n using the model package.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the drift check baselines that can be used when the model monitor is set using the model \n package.

" + } + }, + "com.amazonaws.sagemaker#DriftCheckBias": { + "type": "structure", + "members": { + "ConfigFile": { + "target": "com.amazonaws.sagemaker#FileSource", + "traits": { + "smithy.api#documentation": "

The bias config file for a model.

" + } + }, + "PreTrainingConstraints": { + "target": "com.amazonaws.sagemaker#MetricsSource", + "traits": { + "smithy.api#documentation": "

The pre-training constraints.

" + } + }, + "PostTrainingConstraints": { + "target": "com.amazonaws.sagemaker#MetricsSource", + "traits": { + "smithy.api#documentation": "

The post-training constraints.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the drift check bias baselines that can be used when the model monitor is set using the \n model package.

" + } + }, + "com.amazonaws.sagemaker#DriftCheckExplainability": { + "type": "structure", + "members": { + "Constraints": { + "target": "com.amazonaws.sagemaker#MetricsSource", + "traits": { + "smithy.api#documentation": "

The drift check explainability constraints.

" + } + }, + "ConfigFile": { + "target": "com.amazonaws.sagemaker#FileSource", + "traits": { + "smithy.api#documentation": "

The explainability config file for the model.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the drift check explainability baselines that can be used when the model monitor is set \n using the model package.

" + } + }, + "com.amazonaws.sagemaker#DriftCheckModelDataQuality": { + "type": "structure", + "members": { + "Statistics": { + "target": "com.amazonaws.sagemaker#MetricsSource", + "traits": { + "smithy.api#documentation": "

The drift check model data quality statistics.

" + } + }, + "Constraints": { + "target": "com.amazonaws.sagemaker#MetricsSource", + "traits": { + "smithy.api#documentation": "

The drift check model data quality constraints.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the drift check data quality baselines that can be used when the model monitor is set using \n the model package.

" + } + }, + "com.amazonaws.sagemaker#DriftCheckModelQuality": { + "type": "structure", + "members": { + "Statistics": { + "target": "com.amazonaws.sagemaker#MetricsSource", + "traits": { + "smithy.api#documentation": "

The drift check model quality statistics.

" + } + }, + "Constraints": { + "target": "com.amazonaws.sagemaker#MetricsSource", + "traits": { + "smithy.api#documentation": "

The drift check model quality constraints.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the drift check model quality baselines that can be used when the model monitor is set using \n the model package.

" + } + }, + "com.amazonaws.sagemaker#DynamicScalingConfiguration": { + "type": "structure", + "members": { + "MinCapacity": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "

The recommended minimum capacity to specify for your autoscaling policy.

" + } + }, + "MaxCapacity": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "

The recommended maximum capacity to specify for your autoscaling policy.

" + } + }, + "ScaleInCooldown": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "

The recommended scale in cooldown time for your autoscaling policy.

" + } + }, + "ScaleOutCooldown": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "

The recommended scale out cooldown time for your autoscaling policy.

" + } + }, + "ScalingPolicies": { + "target": "com.amazonaws.sagemaker#ScalingPolicies", + "traits": { + "smithy.api#documentation": "

An object of the scaling policies for each metric.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object with the recommended values for you to specify when creating an autoscaling policy.

" + } + }, + "com.amazonaws.sagemaker#EFSFileSystem": { + "type": "structure", + "members": { + "FileSystemId": { + "target": "com.amazonaws.sagemaker#FileSystemId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of your Amazon EFS file system.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A file system, created by you in Amazon EFS, that you assign to a user profile or\n space for an Amazon SageMaker AI Domain. Permitted users can access this file system in\n Amazon SageMaker AI Studio.

" + } + }, + "com.amazonaws.sagemaker#EFSFileSystemConfig": { + "type": "structure", + "members": { + "FileSystemId": { + "target": "com.amazonaws.sagemaker#FileSystemId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of your Amazon EFS file system.

", + "smithy.api#required": {} + } + }, + "FileSystemPath": { + "target": "com.amazonaws.sagemaker#FileSystemPath", + "traits": { + "smithy.api#documentation": "

The path to the file system directory that is accessible in Amazon SageMaker AI Studio.\n Permitted users can access only this directory and below.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The settings for assigning a custom Amazon EFS file system to a user profile or\n space for an Amazon SageMaker AI Domain.

" + } + }, + "com.amazonaws.sagemaker#EMRStepMetadata": { + "type": "structure", + "members": { + "ClusterId": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "

The identifier of the EMR cluster.

" + } + }, + "StepId": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "

The identifier of the EMR cluster step.

" + } + }, + "StepName": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "

The name of the EMR cluster step.

" + } + }, + "LogFilePath": { + "target": "com.amazonaws.sagemaker#String1024", + "traits": { + "smithy.api#documentation": "

The path to the log file where the cluster step's failure root cause \n is recorded.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configurations and outcomes of an Amazon EMR step execution.

" + } + }, + "com.amazonaws.sagemaker#EbsStorageSettings": { + "type": "structure", + "members": { + "EbsVolumeSizeInGb": { + "target": "com.amazonaws.sagemaker#SpaceEbsVolumeSizeInGb", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The size of an EBS storage volume for a space.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A collection of EBS storage settings that apply to both private and shared spaces.

" + } + }, + "com.amazonaws.sagemaker#Edge": { + "type": "structure", + "members": { + "SourceArn": { + "target": "com.amazonaws.sagemaker#AssociationEntityArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source lineage entity of the directed edge.

" + } + }, + "DestinationArn": { + "target": "com.amazonaws.sagemaker#AssociationEntityArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the destination lineage entity of the directed edge.

" + } + }, + "AssociationType": { + "target": "com.amazonaws.sagemaker#AssociationEdgeType", + "traits": { + "smithy.api#documentation": "

The type of the Association(Edge) between the source and destination. For example ContributedTo, \n Produced, or DerivedFrom.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A directed edge connecting two lineage entities.

" + } + }, + "com.amazonaws.sagemaker#EdgeDeploymentConfig": { + "type": "structure", + "members": { + "FailureHandlingPolicy": { + "target": "com.amazonaws.sagemaker#FailureHandlingPolicy", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Toggle that determines whether to rollback to previous configuration if the current\n deployment fails. By default this is turned on. You may turn this off if you want to\n investigate the errors yourself.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the configuration of a deployment.

" + } + }, + "com.amazonaws.sagemaker#EdgeDeploymentModelConfig": { + "type": "structure", + "members": { + "ModelHandle": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name the device application uses to reference this model.

", + "smithy.api#required": {} + } + }, + "EdgePackagingJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The edge packaging job associated with this deployment.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the configuration of a model in a deployment.

" + } + }, + "com.amazonaws.sagemaker#EdgeDeploymentModelConfigs": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#EdgeDeploymentModelConfig" + } + }, + "com.amazonaws.sagemaker#EdgeDeploymentPlanArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z\\-]*:\\d{12}:edge-deployment/?[a-zA-Z_0-9+=,.@\\-_/]+$" + } + }, + "com.amazonaws.sagemaker#EdgeDeploymentPlanSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#EdgeDeploymentPlanSummary" + } + }, + "com.amazonaws.sagemaker#EdgeDeploymentPlanSummary": { + "type": "structure", + "members": { + "EdgeDeploymentPlanArn": { + "target": "com.amazonaws.sagemaker#EdgeDeploymentPlanArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the edge deployment plan.

", + "smithy.api#required": {} + } + }, + "EdgeDeploymentPlanName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the edge deployment plan.

", + "smithy.api#required": {} + } + }, + "DeviceFleetName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the device fleet used for the deployment.

", + "smithy.api#required": {} + } + }, + "EdgeDeploymentSuccess": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of edge devices with the successful deployment.

", + "smithy.api#required": {} + } + }, + "EdgeDeploymentPending": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of edge devices yet to pick up the deployment, or in progress.

", + "smithy.api#required": {} + } + }, + "EdgeDeploymentFailed": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of edge devices that failed the deployment.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the edge deployment plan was created.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the edge deployment plan was last updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information summarizing an edge deployment plan.

" + } + }, + "com.amazonaws.sagemaker#EdgeDeploymentStatus": { + "type": "structure", + "members": { + "StageStatus": { + "target": "com.amazonaws.sagemaker#StageStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The general status of the current stage.

", + "smithy.api#required": {} + } + }, + "EdgeDeploymentSuccessInStage": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of edge devices with the successful deployment in the current stage.

", + "smithy.api#required": {} + } + }, + "EdgeDeploymentPendingInStage": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of edge devices yet to pick up the deployment in current stage, or in\n progress.

", + "smithy.api#required": {} + } + }, + "EdgeDeploymentFailedInStage": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of edge devices that failed the deployment in current stage.

", + "smithy.api#required": {} + } + }, + "EdgeDeploymentStatusMessage": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

A detailed message about deployment status in current stage.

" + } + }, + "EdgeDeploymentStageStartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the deployment API started.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information summarizing the deployment stage results.

" + } + }, + "com.amazonaws.sagemaker#EdgeModel": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the model.

", + "smithy.api#required": {} + } + }, + "ModelVersion": { + "target": "com.amazonaws.sagemaker#EdgeVersion", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The model version.

", + "smithy.api#required": {} + } + }, + "LatestSampleTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of the last data sample taken.

" + } + }, + "LatestInference": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of the last inference that was made.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The model on the edge device.

" + } + }, + "com.amazonaws.sagemaker#EdgeModelStat": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the model.

", + "smithy.api#required": {} + } + }, + "ModelVersion": { + "target": "com.amazonaws.sagemaker#EdgeVersion", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The model version.

", + "smithy.api#required": {} + } + }, + "OfflineDeviceCount": { + "target": "com.amazonaws.sagemaker#Long", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of devices that have this model version and do not have a heart beat.

", + "smithy.api#required": {} + } + }, + "ConnectedDeviceCount": { + "target": "com.amazonaws.sagemaker#Long", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of devices that have this model version and have a heart beat.

", + "smithy.api#required": {} + } + }, + "ActiveDeviceCount": { + "target": "com.amazonaws.sagemaker#Long", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of devices that have this model version, a heart beat, and are currently running.

", + "smithy.api#required": {} + } + }, + "SamplingDeviceCount": { + "target": "com.amazonaws.sagemaker#Long", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of devices with this model version and are producing sample data.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Status of edge devices with this model.

" + } + }, + "com.amazonaws.sagemaker#EdgeModelStats": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#EdgeModelStat" + } + }, + "com.amazonaws.sagemaker#EdgeModelSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#EdgeModelSummary" + } + }, + "com.amazonaws.sagemaker#EdgeModelSummary": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the model.

", + "smithy.api#required": {} + } + }, + "ModelVersion": { + "target": "com.amazonaws.sagemaker#EdgeVersion", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The version model.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Summary of model on edge device.

" + } + }, + "com.amazonaws.sagemaker#EdgeModels": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#EdgeModel" + } + }, + "com.amazonaws.sagemaker#EdgeOutputConfig": { + "type": "structure", + "members": { + "S3OutputLocation": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Simple Storage (S3) bucker URI.

", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume after compilation job. \n If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account.

" + } + }, + "PresetDeploymentType": { + "target": "com.amazonaws.sagemaker#EdgePresetDeploymentType", + "traits": { + "smithy.api#documentation": "

The deployment type SageMaker Edge Manager will create. \n Currently only supports Amazon Web Services IoT Greengrass Version 2 components.

" + } + }, + "PresetDeploymentConfig": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The configuration used to create deployment artifacts. \n Specify configuration options with a JSON string. The available configuration options for each type are:

\n
    \n
  • \n

    \n ComponentName (optional) - Name of the GreenGrass V2 component. If not specified,\n the default name generated consists of \"SagemakerEdgeManager\" and the name of your SageMaker Edge Manager\n packaging job.

    \n
    • \n
  • \n

    \n ComponentDescription (optional) - Description of the component.

    \n
    • \n
  • \n

    \n ComponentVersion (optional) - The version of the component.

    \n \n

    Amazon Web Services IoT Greengrass uses semantic versions for components. Semantic versions follow a\n major.minor.patch number system. For example, version 1.0.0 represents the first\n major release for a component. For more information, see the semantic version specification.

    \n     \n
    • \n
  • \n

    \n PlatformOS (optional) - The name of the operating system for the platform.\n Supported platforms include Windows and Linux.

    \n
    • \n
  • \n

    \n PlatformArchitecture (optional) - The processor architecture for the platform.

    \n

    Supported architectures Windows include: Windows32_x86, Windows64_x64.

    \n

    Supported architectures for Linux include: Linux x86_64, Linux ARMV8.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

The output configuration.

" + } + }, + "com.amazonaws.sagemaker#EdgePackagingJobArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z\\-]*:\\d{12}:edge-packaging-job/?[a-zA-Z_0-9+=,.@\\-_/]+$" + } + }, + "com.amazonaws.sagemaker#EdgePackagingJobStatus": { + "type": "enum", + "members": { + "Starting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTING" + } + }, + "InProgress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INPROGRESS" + } + }, + "Completed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "Stopping": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPING" + } + }, + "Stopped": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + } + } + }, + "com.amazonaws.sagemaker#EdgePackagingJobSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#EdgePackagingJobSummary" + } + }, + "com.amazonaws.sagemaker#EdgePackagingJobSummary": { + "type": "structure", + "members": { + "EdgePackagingJobArn": { + "target": "com.amazonaws.sagemaker#EdgePackagingJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the edge packaging job.

", + "smithy.api#required": {} + } + }, + "EdgePackagingJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the edge packaging job.

", + "smithy.api#required": {} + } + }, + "EdgePackagingJobStatus": { + "target": "com.amazonaws.sagemaker#EdgePackagingJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of the edge packaging job.

", + "smithy.api#required": {} + } + }, + "CompilationJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the SageMaker Neo compilation job.

" + } + }, + "ModelName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the model.

" + } + }, + "ModelVersion": { + "target": "com.amazonaws.sagemaker#EdgeVersion", + "traits": { + "smithy.api#documentation": "

The version of the model.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the job was created.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the edge packaging job was last updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Summary of edge packaging job.

" + } + }, + "com.amazonaws.sagemaker#EdgePresetDeploymentArtifact": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + } + } + }, + "com.amazonaws.sagemaker#EdgePresetDeploymentOutput": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.sagemaker#EdgePresetDeploymentType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The deployment type created by SageMaker Edge Manager. Currently only \n supports Amazon Web Services IoT Greengrass Version 2 components.

", + "smithy.api#required": {} + } + }, + "Artifact": { + "target": "com.amazonaws.sagemaker#EdgePresetDeploymentArtifact", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the generated deployable resource.

" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#EdgePresetDeploymentStatus", + "traits": { + "smithy.api#documentation": "

The status of the deployable resource.

" + } + }, + "StatusMessage": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

Returns a message describing the status of the deployed resource.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The output of a SageMaker Edge Manager deployable resource.

" + } + }, + "com.amazonaws.sagemaker#EdgePresetDeploymentStatus": { + "type": "enum", + "members": { + "Completed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.sagemaker#EdgePresetDeploymentType": { + "type": "enum", + "members": { + "GreengrassV2Component": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GreengrassV2Component" + } + } + } + }, + "com.amazonaws.sagemaker#EdgeVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 30 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\ \\_\\.]+$" + } + }, + "com.amazonaws.sagemaker#Edges": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#Edge" + } + }, + "com.amazonaws.sagemaker#EfsUid": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + }, + "smithy.api#pattern": "^\\d+$" + } + }, + "com.amazonaws.sagemaker#EksClusterArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:eks:[a-z0-9\\-]*:[0-9]{12}:cluster\\/[0-9A-Za-z][A-Za-z0-9\\-_]{0,99}$" + } + }, + "com.amazonaws.sagemaker#EmrServerlessComputeConfig": { + "type": "structure", + "members": { + "ExecutionRoleARN": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the IAM role granting the AutoML job V2 the necessary\n permissions access policies to list, connect to, or manage EMR Serverless jobs. For\n detailed information about the required permissions of this role, see \"How to configure\n AutoML to initiate a remote job on EMR Serverless for large datasets\" in Create a regression or classification job for tabular data using the AutoML API\n or Create an AutoML job for time-series forecasting using the API.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "\n

This data type is intended for use exclusively by SageMaker Canvas and cannot be used in\n other contexts at the moment.

\n \n

Specifies the compute configuration for the EMR Serverless job.

" + } + }, + "com.amazonaws.sagemaker#EmrServerlessSettings": { + "type": "structure", + "members": { + "ExecutionRoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services IAM role that is assumed for\n running Amazon EMR Serverless jobs in SageMaker Canvas. This role should have the necessary\n permissions to read and write data attached and a trust relationship with\n EMR Serverless.

" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#FeatureStatus", + "traits": { + "smithy.api#documentation": "

Describes whether Amazon EMR Serverless job capabilities are enabled or disabled in the SageMaker\n Canvas application.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The settings for running Amazon EMR Serverless jobs in SageMaker Canvas.

" + } + }, + "com.amazonaws.sagemaker#EmrSettings": { + "type": "structure", + "members": { + "AssumableRoleArns": { + "target": "com.amazonaws.sagemaker#AssumableRoleArns", + "traits": { + "smithy.api#documentation": "

An array of Amazon Resource Names (ARNs) of the IAM roles that the execution role of\n SageMaker can assume for performing operations or tasks related to Amazon EMR clusters or Amazon EMR\n Serverless applications. These roles define the permissions and access policies required\n when performing Amazon EMR-related operations, such as listing, connecting to, or terminating\n Amazon EMR clusters or Amazon EMR Serverless applications. They are typically used in\n cross-account access scenarios, where the Amazon EMR resources (clusters or serverless\n applications) are located in a different Amazon Web Services account than the SageMaker\n domain.

" + } + }, + "ExecutionRoleArns": { + "target": "com.amazonaws.sagemaker#ExecutionRoleArns", + "traits": { + "smithy.api#documentation": "

An array of Amazon Resource Names (ARNs) of the IAM roles used by the Amazon EMR cluster instances\n or job execution environments to access other Amazon Web Services services and resources needed during the \n runtime of your Amazon EMR or Amazon EMR Serverless workloads, such as Amazon S3 for data access, Amazon CloudWatch for logging, or other\n Amazon Web Services services based on the particular workload requirements.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration parameters that specify the IAM roles assumed by the execution role of \n SageMaker (assumable roles) and the cluster instances or job execution environments \n (execution roles or runtime roles) to manage and access resources required for running Amazon EMR\n clusters or Amazon EMR Serverless applications.

" + } + }, + "com.amazonaws.sagemaker#EnableCapture": { + "type": "boolean" + }, + "com.amazonaws.sagemaker#EnableInfraCheck": { + "type": "boolean" + }, + "com.amazonaws.sagemaker#EnableIotRoleAlias": { + "type": "boolean" + }, + "com.amazonaws.sagemaker#EnableRemoteDebug": { + "type": "boolean" + }, + "com.amazonaws.sagemaker#EnableSagemakerServicecatalogPortfolio": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#EnableSagemakerServicecatalogPortfolioInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#EnableSagemakerServicecatalogPortfolioOutput" + }, + "traits": { + "smithy.api#documentation": "

Enables using Service Catalog in SageMaker. Service Catalog is used to create\n SageMaker projects.

" + } + }, + "com.amazonaws.sagemaker#EnableSagemakerServicecatalogPortfolioInput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#EnableSagemakerServicecatalogPortfolioOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#EnableSessionTagChaining": { + "type": "boolean" + }, + "com.amazonaws.sagemaker#EnabledOrDisabled": { + "type": "enum", + "members": { + "Enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enabled" + } + }, + "Disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disabled" + } + } + } + }, + "com.amazonaws.sagemaker#Endpoint": { + "type": "structure", + "members": { + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the endpoint.

", + "smithy.api#required": {} + } + }, + "EndpointArn": { + "target": "com.amazonaws.sagemaker#EndpointArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the endpoint.

", + "smithy.api#required": {} + } + }, + "EndpointConfigName": { + "target": "com.amazonaws.sagemaker#EndpointConfigName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The endpoint configuration associated with the endpoint.

", + "smithy.api#required": {} + } + }, + "ProductionVariants": { + "target": "com.amazonaws.sagemaker#ProductionVariantSummaryList", + "traits": { + "smithy.api#documentation": "

A list of the production variants hosted on the endpoint. Each production variant is a\n model.

" + } + }, + "DataCaptureConfig": { + "target": "com.amazonaws.sagemaker#DataCaptureConfigSummary" + }, + "EndpointStatus": { + "target": "com.amazonaws.sagemaker#EndpointStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of the endpoint.

", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "

If the endpoint failed, the reason it failed.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The time that the endpoint was created.

", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The last time the endpoint was modified.

", + "smithy.api#required": {} + } + }, + "MonitoringSchedules": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleList", + "traits": { + "smithy.api#documentation": "

A list of monitoring schedules for the endpoint. For information about model\n monitoring, see Amazon SageMaker Model Monitor.

" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

A list of the tags associated with the endpoint. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General\n Reference Guide.

" + } + }, + "ShadowProductionVariants": { + "target": "com.amazonaws.sagemaker#ProductionVariantSummaryList", + "traits": { + "smithy.api#documentation": "

A list of the shadow variants hosted on the endpoint. Each shadow variant is a model\n in shadow mode with production traffic replicated from the production variant.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A hosted endpoint for real-time inference.

" + } + }, + "com.amazonaws.sagemaker#EndpointArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:endpoint/" + } + }, + "com.amazonaws.sagemaker#EndpointConfigArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:endpoint-config/" + } + }, + "com.amazonaws.sagemaker#EndpointConfigName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#EndpointConfigNameContains": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.sagemaker#EndpointConfigSortKey": { + "type": "enum", + "members": { + "Name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CreationTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + } + } + }, + "com.amazonaws.sagemaker#EndpointConfigStepMetadata": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#EndpointConfigArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the endpoint configuration used in the step.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Metadata for an endpoint configuration step.

" + } + }, + "com.amazonaws.sagemaker#EndpointConfigSummary": { + "type": "structure", + "members": { + "EndpointConfigName": { + "target": "com.amazonaws.sagemaker#EndpointConfigName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the endpoint configuration.

", + "smithy.api#required": {} + } + }, + "EndpointConfigArn": { + "target": "com.amazonaws.sagemaker#EndpointConfigArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the endpoint configuration.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A timestamp that shows when the endpoint configuration was created.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides summary information for an endpoint configuration.

" + } + }, + "com.amazonaws.sagemaker#EndpointConfigSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#EndpointConfigSummary" + } + }, + "com.amazonaws.sagemaker#EndpointInfo": { + "type": "structure", + "members": { + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#documentation": "

The name of a customer's endpoint.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about a customer endpoint that was compared in an Inference Recommender job.

" + } + }, + "com.amazonaws.sagemaker#EndpointInput": { + "type": "structure", + "members": { + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An endpoint in customer's account which has enabled DataCaptureConfig\n enabled.

", + "smithy.api#required": {} + } + }, + "LocalPath": { + "target": "com.amazonaws.sagemaker#ProcessingLocalPath", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Path to the filesystem where the endpoint data is available to the container.

", + "smithy.api#required": {} + } + }, + "S3InputMode": { + "target": "com.amazonaws.sagemaker#ProcessingS3InputMode", + "traits": { + "smithy.api#documentation": "

Whether the Pipe or File is used as the input mode for\n transferring data for the monitoring job. Pipe mode is recommended for large\n datasets. File mode is useful for small files that fit in memory. Defaults to\n File.

" + } + }, + "S3DataDistributionType": { + "target": "com.amazonaws.sagemaker#ProcessingS3DataDistributionType", + "traits": { + "smithy.api#documentation": "

Whether input data distributed in Amazon S3 is fully replicated or sharded by an\n Amazon S3 key. Defaults to FullyReplicated\n

" + } + }, + "FeaturesAttribute": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The attributes of the input data that are the input features.

" + } + }, + "InferenceAttribute": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The attribute of the input data that represents the ground truth label.

" + } + }, + "ProbabilityAttribute": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

In a classification problem, the attribute that represents the class probability.

" + } + }, + "ProbabilityThresholdAttribute": { + "target": "com.amazonaws.sagemaker#ProbabilityThresholdAttribute", + "traits": { + "smithy.api#documentation": "

The threshold for the class probability to be evaluated as a positive result.

" + } + }, + "StartTimeOffset": { + "target": "com.amazonaws.sagemaker#MonitoringTimeOffsetString", + "traits": { + "smithy.api#documentation": "

If specified, monitoring jobs substract this time from the start time. For information\n about using offsets for scheduling monitoring jobs, see Schedule Model\n Quality Monitoring Jobs.

" + } + }, + "EndTimeOffset": { + "target": "com.amazonaws.sagemaker#MonitoringTimeOffsetString", + "traits": { + "smithy.api#documentation": "

If specified, monitoring jobs substract this time from the end time. For information\n about using offsets for scheduling monitoring jobs, see Schedule Model\n Quality Monitoring Jobs.

" + } + }, + "ExcludeFeaturesAttribute": { + "target": "com.amazonaws.sagemaker#ExcludeFeaturesAttribute", + "traits": { + "smithy.api#documentation": "

The attributes of the input data to exclude from the analysis.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Input object for the endpoint

" + } + }, + "com.amazonaws.sagemaker#EndpointInputConfiguration": { + "type": "structure", + "members": { + "InstanceType": { + "target": "com.amazonaws.sagemaker#ProductionVariantInstanceType", + "traits": { + "smithy.api#documentation": "

The instance types to use for the load test.

" + } + }, + "ServerlessConfig": { + "target": "com.amazonaws.sagemaker#ProductionVariantServerlessConfig" + }, + "InferenceSpecificationName": { + "target": "com.amazonaws.sagemaker#InferenceSpecificationName", + "traits": { + "smithy.api#documentation": "

The inference specification name in the model package version.

" + } + }, + "EnvironmentParameterRanges": { + "target": "com.amazonaws.sagemaker#EnvironmentParameterRanges", + "traits": { + "smithy.api#documentation": "

The parameter you want to benchmark against.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The endpoint configuration for the load test.

" + } + }, + "com.amazonaws.sagemaker#EndpointInputConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#EndpointInputConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.sagemaker#EndpointMetadata": { + "type": "structure", + "members": { + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the endpoint.

", + "smithy.api#required": {} + } + }, + "EndpointConfigName": { + "target": "com.amazonaws.sagemaker#EndpointConfigName", + "traits": { + "smithy.api#documentation": "

The name of the endpoint configuration.

" + } + }, + "EndpointStatus": { + "target": "com.amazonaws.sagemaker#EndpointStatus", + "traits": { + "smithy.api#documentation": "

\n The status of the endpoint. For possible values of the status of an endpoint, see EndpointSummary.\n

" + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "

\n If the status of the endpoint is Failed, or the status is InService but update\n operation fails, this provides the reason why it failed.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The metadata of the endpoint.

" + } + }, + "com.amazonaws.sagemaker#EndpointName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#EndpointNameContains": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.sagemaker#EndpointOutputConfiguration": { + "type": "structure", + "members": { + "EndpointName": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the endpoint made during a recommendation job.

", + "smithy.api#required": {} + } + }, + "VariantName": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the production variant (deployed model) made during a recommendation job.

", + "smithy.api#required": {} + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#ProductionVariantInstanceType", + "traits": { + "smithy.api#documentation": "

The instance type recommended by Amazon SageMaker Inference Recommender.

" + } + }, + "InitialInstanceCount": { + "target": "com.amazonaws.sagemaker#InitialInstanceCount", + "traits": { + "smithy.api#documentation": "

The number of instances recommended to launch initially.

" + } + }, + "ServerlessConfig": { + "target": "com.amazonaws.sagemaker#ProductionVariantServerlessConfig" + } + }, + "traits": { + "smithy.api#documentation": "

The endpoint configuration made by Inference Recommender during a recommendation job.

" + } + }, + "com.amazonaws.sagemaker#EndpointPerformance": { + "type": "structure", + "members": { + "Metrics": { + "target": "com.amazonaws.sagemaker#InferenceMetrics", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The metrics for an existing endpoint.

", + "smithy.api#required": {} + } + }, + "EndpointInfo": { + "target": "com.amazonaws.sagemaker#EndpointInfo", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The performance results from running an Inference Recommender job on an existing endpoint.

" + } + }, + "com.amazonaws.sagemaker#EndpointPerformances": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#EndpointPerformance" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.sagemaker#EndpointSortKey": { + "type": "enum", + "members": { + "Name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CreationTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "Status": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + } + } + }, + "com.amazonaws.sagemaker#EndpointStatus": { + "type": "enum", + "members": { + "OUT_OF_SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OutOfService" + } + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Creating" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + }, + "SYSTEM_UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SystemUpdating" + } + }, + "ROLLING_BACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RollingBack" + } + }, + "IN_SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InService" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "UPDATE_ROLLBACK_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateRollbackFailed" + } + } + } + }, + "com.amazonaws.sagemaker#EndpointStepMetadata": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#EndpointArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the endpoint in the step.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Metadata for an endpoint step.

" + } + }, + "com.amazonaws.sagemaker#EndpointSummary": { + "type": "structure", + "members": { + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the endpoint.

", + "smithy.api#required": {} + } + }, + "EndpointArn": { + "target": "com.amazonaws.sagemaker#EndpointArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the endpoint.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A timestamp that shows when the endpoint was created.

", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A timestamp that shows when the endpoint was last modified.

", + "smithy.api#required": {} + } + }, + "EndpointStatus": { + "target": "com.amazonaws.sagemaker#EndpointStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of the endpoint.

\n
    \n
  • \n

    \n OutOfService: Endpoint is not available to take incoming\n requests.

    \n
    • \n
  • \n

    \n Creating: CreateEndpoint is executing.

    \n
    • \n
  • \n

    \n Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.

    \n
    • \n
  • \n

    \n SystemUpdating: Endpoint is undergoing maintenance and cannot be\n updated or deleted or re-scaled until it has completed. This maintenance\n operation does not change any customer-specified values such as VPC config, KMS\n encryption, model, instance type, or instance count.

    \n
    • \n
  • \n

    \n RollingBack: Endpoint fails to scale up or down or change its\n variant weight and is in the process of rolling back to its previous\n configuration. Once the rollback completes, endpoint returns to an\n InService status. This transitional status only applies to an\n endpoint that has autoscaling enabled and is undergoing variant weight or\n capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called\n explicitly.

    \n
    • \n
  • \n

    \n InService: Endpoint is available to process incoming\n requests.

    \n
    • \n
  • \n

    \n Deleting: DeleteEndpoint is executing.

    \n
    • \n
  • \n

    \n Failed: Endpoint could not be created, updated, or re-scaled. Use\n DescribeEndpointOutput$FailureReason for information about the\n failure. DeleteEndpoint is the only operation that can be performed on a\n failed endpoint.

    \n
    • \n
\n

To get a list of endpoints with a specified status, use the StatusEquals\n filter with a call to ListEndpoints.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides summary information for an endpoint.

" + } + }, + "com.amazonaws.sagemaker#EndpointSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#EndpointSummary" + } + }, + "com.amazonaws.sagemaker#Endpoints": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#EndpointInfo" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.sagemaker#EntityDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*$" + } + }, + "com.amazonaws.sagemaker#EntityName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#EnvironmentKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$" + } + }, + "com.amazonaws.sagemaker#EnvironmentMap": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#EnvironmentKey" + }, + "value": { + "target": "com.amazonaws.sagemaker#EnvironmentValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#EnvironmentParameter": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The environment key suggested by the Amazon SageMaker Inference Recommender.

", + "smithy.api#required": {} + } + }, + "ValueType": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The value type suggested by the Amazon SageMaker Inference Recommender.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The value suggested by the Amazon SageMaker Inference Recommender.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of environment parameters suggested by the Amazon SageMaker Inference Recommender.

" + } + }, + "com.amazonaws.sagemaker#EnvironmentParameterRanges": { + "type": "structure", + "members": { + "CategoricalParameterRanges": { + "target": "com.amazonaws.sagemaker#CategoricalParameters", + "traits": { + "smithy.api#documentation": "

Specified a list of parameters for each category.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the range of environment parameters

" + } + }, + "com.amazonaws.sagemaker#EnvironmentParameters": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#EnvironmentParameter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.sagemaker#EnvironmentValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^[\\S\\s]*$" + } + }, + "com.amazonaws.sagemaker#ErrorInfo": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.sagemaker#NonEmptyString64", + "traits": { + "smithy.api#documentation": "

The error code for an invalid or failed operation.

" + } + }, + "Reason": { + "target": "com.amazonaws.sagemaker#NonEmptyString256", + "traits": { + "smithy.api#documentation": "

The failure reason for the operation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This is an error field object that contains the error code and the reason for an operation failure.

" + } + }, + "com.amazonaws.sagemaker#ExcludeFeaturesAttribute": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#ExecutionRoleArns": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#RoleArn" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#ExecutionRoleIdentityConfig": { + "type": "enum", + "members": { + "USER_PROFILE_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USER_PROFILE_NAME" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.sagemaker#ExecutionStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "COMPLETED_WITH_VIOLATIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CompletedWithViolations" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + } + } + }, + "com.amazonaws.sagemaker#ExitMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^[\\S\\s]*$" + } + }, + "com.amazonaws.sagemaker#Experiment": { + "type": "structure", + "members": { + "ExperimentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

The name of the experiment.

" + } + }, + "ExperimentArn": { + "target": "com.amazonaws.sagemaker#ExperimentArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the experiment.

" + } + }, + "DisplayName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

The name of the experiment as displayed. If DisplayName isn't specified,\n ExperimentName is displayed.

" + } + }, + "Source": { + "target": "com.amazonaws.sagemaker#ExperimentSource" + }, + "Description": { + "target": "com.amazonaws.sagemaker#ExperimentDescription", + "traits": { + "smithy.api#documentation": "

The description of the experiment.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the experiment was created.

" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext", + "traits": { + "smithy.api#documentation": "

Who created the experiment.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the experiment was last modified.

" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

The list of tags that are associated with the experiment. You can use Search API to search on the tags.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The properties of an experiment as returned by the Search API.

" + } + }, + "com.amazonaws.sagemaker#ExperimentArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:experiment/" + } + }, + "com.amazonaws.sagemaker#ExperimentConfig": { + "type": "structure", + "members": { + "ExperimentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

The name of an existing experiment to associate with the trial component.

" + } + }, + "TrialName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

The name of an existing trial to associate the trial component with. If not specified, a\n new trial is created.

" + } + }, + "TrialComponentDisplayName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

The display name for the trial component. If this key isn't specified, the display name is\n the trial component name.

" + } + }, + "RunName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

The name of the experiment run to associate with the trial component.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Associates a SageMaker job as a trial component with an experiment and trial. Specified when\n you call the following APIs:

\n " + } + }, + "com.amazonaws.sagemaker#ExperimentDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3072 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#ExperimentEntityName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 120 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}$" + } + }, + "com.amazonaws.sagemaker#ExperimentEntityNameOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:(experiment|experiment-trial|experiment-trial-component|artifact|action|context)\\/)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,119})$" + } + }, + "com.amazonaws.sagemaker#ExperimentSource": { + "type": "structure", + "members": { + "SourceArn": { + "target": "com.amazonaws.sagemaker#ExperimentSourceArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source.

", + "smithy.api#required": {} + } + }, + "SourceType": { + "target": "com.amazonaws.sagemaker#SourceType", + "traits": { + "smithy.api#documentation": "

The source type.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The source of the experiment.

" + } + }, + "com.amazonaws.sagemaker#ExperimentSourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:" + } + }, + "com.amazonaws.sagemaker#ExperimentSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ExperimentSummary" + } + }, + "com.amazonaws.sagemaker#ExperimentSummary": { + "type": "structure", + "members": { + "ExperimentArn": { + "target": "com.amazonaws.sagemaker#ExperimentArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the experiment.

" + } + }, + "ExperimentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

The name of the experiment.

" + } + }, + "DisplayName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

The name of the experiment as displayed. If DisplayName isn't specified,\n ExperimentName is displayed.

" + } + }, + "ExperimentSource": { + "target": "com.amazonaws.sagemaker#ExperimentSource" + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the experiment was created.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the experiment was last modified.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A summary of the properties of an experiment. To get the complete set of properties, call\n the DescribeExperiment API and provide the\n ExperimentName.

" + } + }, + "com.amazonaws.sagemaker#ExpiresInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 300 + } + } + }, + "com.amazonaws.sagemaker#Explainability": { + "type": "structure", + "members": { + "Report": { + "target": "com.amazonaws.sagemaker#MetricsSource", + "traits": { + "smithy.api#documentation": "

The explainability report for a model.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains explainability metrics for a model.

" + } + }, + "com.amazonaws.sagemaker#ExplainabilityLocation": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#ExplainerConfig": { + "type": "structure", + "members": { + "ClarifyExplainerConfig": { + "target": "com.amazonaws.sagemaker#ClarifyExplainerConfig", + "traits": { + "smithy.api#documentation": "

A member of ExplainerConfig that contains configuration parameters for\n the SageMaker Clarify explainer.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A parameter to activate explainers.

" + } + }, + "com.amazonaws.sagemaker#FSxLustreFileSystem": { + "type": "structure", + "members": { + "FileSystemId": { + "target": "com.amazonaws.sagemaker#FileSystemId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Amazon FSx for Lustre file system ID.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A custom file system in Amazon FSx for Lustre.

" + } + }, + "com.amazonaws.sagemaker#FSxLustreFileSystemConfig": { + "type": "structure", + "members": { + "FileSystemId": { + "target": "com.amazonaws.sagemaker#FileSystemId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The globally unique, 17-digit, ID of the file system, assigned by Amazon FSx for Lustre.

", + "smithy.api#required": {} + } + }, + "FileSystemPath": { + "target": "com.amazonaws.sagemaker#FileSystemPath", + "traits": { + "smithy.api#documentation": "

The path to the file system directory that is accessible in Amazon SageMaker Studio. Permitted\n users can access only this directory and below.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The settings for assigning a custom Amazon FSx for Lustre file system to a user profile or space for an\n Amazon SageMaker Domain.

" + } + }, + "com.amazonaws.sagemaker#FailStepMetadata": { + "type": "structure", + "members": { + "ErrorMessage": { + "target": "com.amazonaws.sagemaker#String3072", + "traits": { + "smithy.api#documentation": "

A message that you define and then is processed and rendered by \n the Fail step when the error occurs.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The container for the metadata for Fail step.

" + } + }, + "com.amazonaws.sagemaker#FailureHandlingPolicy": { + "type": "enum", + "members": { + "RollbackOnFailure": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROLLBACK_ON_FAILURE" + } + }, + "DoNothing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DO_NOTHING" + } + } + } + }, + "com.amazonaws.sagemaker#FailureReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.sagemaker#FairShare": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enabled" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disabled" + } + } + } + }, + "com.amazonaws.sagemaker#FairShareWeight": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#FeatureAdditions": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#FeatureDefinition" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#FeatureDefinition": { + "type": "structure", + "members": { + "FeatureName": { + "target": "com.amazonaws.sagemaker#FeatureName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of a feature. The type must be a string. FeatureName cannot be any\n of the following: is_deleted, write_time,\n api_invocation_time.

\n

The name:

\n
    \n
  • \n

    Must start with an alphanumeric character.

    \n
    • \n
  • \n

    Can only include alphanumeric characters, underscores, and hyphens. Spaces are not\n allowed.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "FeatureType": { + "target": "com.amazonaws.sagemaker#FeatureType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The value type of a feature. Valid values are Integral, Fractional, or String.

", + "smithy.api#required": {} + } + }, + "CollectionType": { + "target": "com.amazonaws.sagemaker#CollectionType", + "traits": { + "smithy.api#documentation": "

A grouping of elements where each element within the collection must have the same\n feature type (String, Integral, or\n Fractional).

\n
    \n
  • \n

    \n List: An ordered collection of elements.

    \n
    • \n
  • \n

    \n Set: An unordered collection of unique elements.

    \n
    • \n
  • \n

    \n Vector: A specialized list that represents a fixed-size array of\n elements. The vector dimension is determined by you. Must have elements with\n fractional feature types.

    \n
    • \n
" + } + }, + "CollectionConfig": { + "target": "com.amazonaws.sagemaker#CollectionConfig", + "traits": { + "smithy.api#documentation": "

Configuration for your collection.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of features. You must include FeatureName and\n FeatureType. Valid feature FeatureTypes are\n Integral, Fractional and String.

" + } + }, + "com.amazonaws.sagemaker#FeatureDefinitions": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#FeatureDefinition" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2500 + } + } + }, + "com.amazonaws.sagemaker#FeatureDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#FeatureGroup": { + "type": "structure", + "members": { + "FeatureGroupArn": { + "target": "com.amazonaws.sagemaker#FeatureGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a FeatureGroup.

" + } + }, + "FeatureGroupName": { + "target": "com.amazonaws.sagemaker#FeatureGroupName", + "traits": { + "smithy.api#documentation": "

The name of the FeatureGroup.

" + } + }, + "RecordIdentifierFeatureName": { + "target": "com.amazonaws.sagemaker#FeatureName", + "traits": { + "smithy.api#documentation": "

The name of the Feature whose value uniquely identifies a\n Record defined in the FeatureGroup\n FeatureDefinitions.

" + } + }, + "EventTimeFeatureName": { + "target": "com.amazonaws.sagemaker#FeatureName", + "traits": { + "smithy.api#documentation": "

The name of the feature that stores the EventTime of a Record in a\n FeatureGroup.

\n

A EventTime is point in time when a new event occurs that corresponds to\n the creation or update of a Record in FeatureGroup. All\n Records in the FeatureGroup must have a corresponding\n EventTime.

" + } + }, + "FeatureDefinitions": { + "target": "com.amazonaws.sagemaker#FeatureDefinitions", + "traits": { + "smithy.api#documentation": "

A list of Features. Each Feature must include a\n FeatureName and a FeatureType.

\n

Valid FeatureTypes are Integral, Fractional and\n String.

\n

\n FeatureNames cannot be any of the following: is_deleted,\n write_time, api_invocation_time.

\n

You can create up to 2,500 FeatureDefinitions per\n FeatureGroup.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "

The time a FeatureGroup was created.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "

A timestamp indicating the last time you updated the feature group.

" + } + }, + "OnlineStoreConfig": { + "target": "com.amazonaws.sagemaker#OnlineStoreConfig" + }, + "OfflineStoreConfig": { + "target": "com.amazonaws.sagemaker#OfflineStoreConfig" + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM execution role used to create the feature\n group.

" + } + }, + "FeatureGroupStatus": { + "target": "com.amazonaws.sagemaker#FeatureGroupStatus", + "traits": { + "smithy.api#documentation": "

A FeatureGroup status.

" + } + }, + "OfflineStoreStatus": { + "target": "com.amazonaws.sagemaker#OfflineStoreStatus" + }, + "LastUpdateStatus": { + "target": "com.amazonaws.sagemaker#LastUpdateStatus", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the feature group was updated successfully.

" + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "

The reason that the FeatureGroup failed to be replicated in the\n OfflineStore. This is failure may be due to a failure to create a\n FeatureGroup in or delete a FeatureGroup from the\n OfflineStore.

" + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#Description", + "traits": { + "smithy.api#documentation": "

A free form description of a FeatureGroup.

" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

Tags used to define a FeatureGroup.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Amazon SageMaker Feature Store stores features in a collection called Feature Group. A\n Feature Group can be visualized as a table which has rows, with a unique identifier for\n each row where each column in the table is a feature. In principle, a Feature Group is\n composed of features and values per features.

" + } + }, + "com.amazonaws.sagemaker#FeatureGroupArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:feature-group/" + } + }, + "com.amazonaws.sagemaker#FeatureGroupMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#FeatureGroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]([_-]*[a-zA-Z0-9]){0,63}$" + } + }, + "com.amazonaws.sagemaker#FeatureGroupNameContains": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.sagemaker#FeatureGroupNameOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:feature-group\\/)?([a-zA-Z0-9]([_-]*[a-zA-Z0-9]){0,63})$" + } + }, + "com.amazonaws.sagemaker#FeatureGroupSortBy": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "FEATURE_GROUP_STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FeatureGroupStatus" + } + }, + "OFFLINE_STORE_STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OfflineStoreStatus" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + } + } + }, + "com.amazonaws.sagemaker#FeatureGroupSortOrder": { + "type": "enum", + "members": { + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ascending" + } + }, + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Descending" + } + } + } + }, + "com.amazonaws.sagemaker#FeatureGroupStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Creating" + } + }, + "CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Created" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateFailed" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteFailed" + } + } + } + }, + "com.amazonaws.sagemaker#FeatureGroupSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#FeatureGroupSummary" + } + }, + "com.amazonaws.sagemaker#FeatureGroupSummary": { + "type": "structure", + "members": { + "FeatureGroupName": { + "target": "com.amazonaws.sagemaker#FeatureGroupName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of FeatureGroup.

", + "smithy.api#required": {} + } + }, + "FeatureGroupArn": { + "target": "com.amazonaws.sagemaker#FeatureGroupArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Unique identifier for the FeatureGroup.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A timestamp indicating the time of creation time of the\n FeatureGroup.

", + "smithy.api#required": {} + } + }, + "FeatureGroupStatus": { + "target": "com.amazonaws.sagemaker#FeatureGroupStatus", + "traits": { + "smithy.api#documentation": "

The status of a FeatureGroup. The status can be any of the following:\n Creating, Created, CreateFail,\n Deleting or DetailFail.

" + } + }, + "OfflineStoreStatus": { + "target": "com.amazonaws.sagemaker#OfflineStoreStatus", + "traits": { + "smithy.api#documentation": "

Notifies you if replicating data into the OfflineStore has failed. Returns\n either: Active or Blocked.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The name, ARN, CreationTime, FeatureGroup values,\n LastUpdatedTime and EnableOnlineStorage status of a\n FeatureGroup.

" + } + }, + "com.amazonaws.sagemaker#FeatureMetadata": { + "type": "structure", + "members": { + "FeatureGroupArn": { + "target": "com.amazonaws.sagemaker#FeatureGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the feature group.

" + } + }, + "FeatureGroupName": { + "target": "com.amazonaws.sagemaker#FeatureGroupName", + "traits": { + "smithy.api#documentation": "

The name of the feature group containing the feature.

" + } + }, + "FeatureName": { + "target": "com.amazonaws.sagemaker#FeatureName", + "traits": { + "smithy.api#documentation": "

The name of feature.

" + } + }, + "FeatureType": { + "target": "com.amazonaws.sagemaker#FeatureType", + "traits": { + "smithy.api#documentation": "

The data type of the feature.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "

A timestamp indicating when the feature was created.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "

A timestamp indicating when the feature was last modified.

" + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#FeatureDescription", + "traits": { + "smithy.api#documentation": "

An optional description that you specify to better describe the feature.

" + } + }, + "Parameters": { + "target": "com.amazonaws.sagemaker#FeatureParameters", + "traits": { + "smithy.api#documentation": "

Optional key-value pairs that you specify to better describe the feature.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The metadata for a feature. It can either be metadata that you specify, or metadata that\n is updated automatically.

" + } + }, + "com.amazonaws.sagemaker#FeatureName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,63}$" + } + }, + "com.amazonaws.sagemaker#FeatureParameter": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.sagemaker#FeatureParameterKey", + "traits": { + "smithy.api#documentation": "

A key that must contain a value to describe the feature.

" + } + }, + "Value": { + "target": "com.amazonaws.sagemaker#FeatureParameterValue", + "traits": { + "smithy.api#documentation": "

The value that belongs to a key.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A key-value pair that you specify to describe the feature.

" + } + }, + "com.amazonaws.sagemaker#FeatureParameterAdditions": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#FeatureParameter" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 25 + } + } + }, + "com.amazonaws.sagemaker#FeatureParameterKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$" + } + }, + "com.amazonaws.sagemaker#FeatureParameterRemovals": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#FeatureParameterKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 25 + } + } + }, + "com.amazonaws.sagemaker#FeatureParameterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$" + } + }, + "com.amazonaws.sagemaker#FeatureParameters": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#FeatureParameter" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 25 + } + } + }, + "com.amazonaws.sagemaker#FeatureStatus": { + "type": "enum", + "members": { + "Enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "Disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.sagemaker#FeatureType": { + "type": "enum", + "members": { + "INTEGRAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Integral" + } + }, + "FRACTIONAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Fractional" + } + }, + "STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "String" + } + } + } + }, + "com.amazonaws.sagemaker#FileSource": { + "type": "structure", + "members": { + "ContentType": { + "target": "com.amazonaws.sagemaker#ContentType", + "traits": { + "smithy.api#documentation": "

The type of content stored in the file source.

" + } + }, + "ContentDigest": { + "target": "com.amazonaws.sagemaker#ContentDigest", + "traits": { + "smithy.api#documentation": "

The digest of the file source.

" + } + }, + "S3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon S3 URI for the file source.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details regarding the file source.

" + } + }, + "com.amazonaws.sagemaker#FileSystemAccessMode": { + "type": "enum", + "members": { + "RW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rw" + } + }, + "RO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ro" + } + } + } + }, + "com.amazonaws.sagemaker#FileSystemConfig": { + "type": "structure", + "members": { + "MountPath": { + "target": "com.amazonaws.sagemaker#MountPath", + "traits": { + "smithy.api#documentation": "

The path within the image to mount the user's EFS home directory. The directory\n should be empty. If not specified, defaults to /home/sagemaker-user.

" + } + }, + "DefaultUid": { + "target": "com.amazonaws.sagemaker#DefaultUid", + "traits": { + "smithy.api#documentation": "

The default POSIX user ID (UID). If not specified, defaults to 1000.

" + } + }, + "DefaultGid": { + "target": "com.amazonaws.sagemaker#DefaultGid", + "traits": { + "smithy.api#documentation": "

The default POSIX group ID (GID). If not specified, defaults to 100.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon Elastic File System storage configuration for a SageMaker AI image.

" + } + }, + "com.amazonaws.sagemaker#FileSystemDataSource": { + "type": "structure", + "members": { + "FileSystemId": { + "target": "com.amazonaws.sagemaker#FileSystemId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The file system id.

", + "smithy.api#required": {} + } + }, + "FileSystemAccessMode": { + "target": "com.amazonaws.sagemaker#FileSystemAccessMode", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The access mode of the mount of the directory associated with the channel. A directory\n can be mounted either in ro (read-only) or rw (read-write)\n mode.

", + "smithy.api#required": {} + } + }, + "FileSystemType": { + "target": "com.amazonaws.sagemaker#FileSystemType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The file system type.

", + "smithy.api#required": {} + } + }, + "DirectoryPath": { + "target": "com.amazonaws.sagemaker#DirectoryPath", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The full path to the directory to associate with the channel.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies a file system data source for a channel.

" + } + }, + "com.amazonaws.sagemaker#FileSystemId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 11, + "max": 21 + }, + "smithy.api#pattern": "^(fs-[0-9a-f]{8,})$" + } + }, + "com.amazonaws.sagemaker#FileSystemPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^\\/\\S*$" + } + }, + "com.amazonaws.sagemaker#FileSystemType": { + "type": "enum", + "members": { + "EFS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EFS" + } + }, + "FSXLUSTRE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FSxLustre" + } + } + } + }, + "com.amazonaws.sagemaker#FillingTransformationMap": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#FillingType" + }, + "value": { + "target": "com.amazonaws.sagemaker#FillingTransformationValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 6 + } + } + }, + "com.amazonaws.sagemaker#FillingTransformationValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\_\\-]+$" + } + }, + "com.amazonaws.sagemaker#FillingTransformations": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#TransformationAttributeName" + }, + "value": { + "target": "com.amazonaws.sagemaker#FillingTransformationMap" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.sagemaker#FillingType": { + "type": "enum", + "members": { + "Frontfill": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "frontfill" + } + }, + "Middlefill": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "middlefill" + } + }, + "Backfill": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "backfill" + } + }, + "Futurefill": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "futurefill" + } + }, + "FrontfillValue": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "frontfill_value" + } + }, + "MiddlefillValue": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "middlefill_value" + } + }, + "BackfillValue": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "backfill_value" + } + }, + "FuturefillValue": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "futurefill_value" + } + } + } + }, + "com.amazonaws.sagemaker#Filter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#ResourcePropertyName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A resource property name. For example, TrainingJobName. For\n valid property names, see SearchRecord.\n You must specify a valid property for the resource.

", + "smithy.api#required": {} + } + }, + "Operator": { + "target": "com.amazonaws.sagemaker#Operator", + "traits": { + "smithy.api#documentation": "

A Boolean binary operator that is used to evaluate the filter. The operator field\n contains one of the following values:

\n
\n
Equals
\n
\n

The value of Name equals Value.

\n
\n
NotEquals
\n
\n

The value of Name doesn't equal Value.

\n
\n
Exists
\n
\n

The Name property exists.

\n
\n
NotExists
\n
\n

The Name property does not exist.

\n
\n
GreaterThan
\n
\n

The value of Name is greater than Value.\n Not supported for text properties.

\n
\n
GreaterThanOrEqualTo
\n
\n

The value of Name is greater than or equal to Value.\n Not supported for text properties.

\n
\n
LessThan
\n
\n

The value of Name is less than Value.\n Not supported for text properties.

\n
\n
LessThanOrEqualTo
\n
\n

The value of Name is less than or equal to Value.\n Not supported for text properties.

\n
\n
In
\n
\n

The value of Name is one of the comma delimited strings in\n Value. Only supported for text properties.

\n
\n
Contains
\n
\n

The value of Name contains the string Value.\n Only supported for text properties.

\n

A SearchExpression can include the Contains operator\n multiple times when the value of Name is one of the following:

\n
    \n
  • \n

    \n Experiment.DisplayName\n

    \n
    • \n
  • \n

    \n Experiment.ExperimentName\n

    \n
    • \n
  • \n

    \n Experiment.Tags\n

    \n
    • \n
  • \n

    \n Trial.DisplayName\n

    \n
    • \n
  • \n

    \n Trial.TrialName\n

    \n
    • \n
  • \n

    \n Trial.Tags\n

    \n
    • \n
  • \n

    \n TrialComponent.DisplayName\n

    \n
    • \n
  • \n

    \n TrialComponent.TrialComponentName\n

    \n
    • \n
  • \n

    \n TrialComponent.Tags\n

    \n
    • \n
  • \n

    \n TrialComponent.InputArtifacts\n

    \n
    • \n
  • \n

    \n TrialComponent.OutputArtifacts\n

    \n
    • \n
\n

A SearchExpression can include only one Contains operator\n for all other values of Name. In these cases, if you include multiple\n Contains operators in the SearchExpression, the result is\n the following error message: \"'CONTAINS' operator usage limit of 1\n exceeded.\"

\n
\n
" + } + }, + "Value": { + "target": "com.amazonaws.sagemaker#FilterValue", + "traits": { + "smithy.api#documentation": "

A value used with Name and Operator to determine which\n resources satisfy the filter's condition. For numerical properties, Value\n must be an integer or floating-point decimal. For timestamp properties,\n Value must be an ISO 8601 date-time string of the following format:\n YYYY-mm-dd'T'HH:MM:SS.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A conditional statement for a search expression that includes a resource property, a\n Boolean operator, and a value. Resources that match the statement are returned in the\n results from the Search API.

\n

If you specify a Value, but not an Operator, SageMaker uses the\n equals operator.

\n

In search, there are several property types:

\n
\n
Metrics
\n
\n

To define a metric filter, enter a value using the form\n \"Metrics.\", where is\n a metric name. For example, the following filter searches for training jobs\n with an \"accuracy\" metric greater than\n \"0.9\":

\n

\n {\n

\n

\n \"Name\": \"Metrics.accuracy\",\n

\n

\n \"Operator\": \"GreaterThan\",\n

\n

\n \"Value\": \"0.9\"\n

\n

\n }\n

\n
\n
HyperParameters
\n
\n

To define a hyperparameter filter, enter a value with the form\n \"HyperParameters.\". Decimal hyperparameter\n values are treated as a decimal in a comparison if the specified\n Value is also a decimal value. If the specified\n Value is an integer, the decimal hyperparameter values are\n treated as integers. For example, the following filter is satisfied by\n training jobs with a \"learning_rate\" hyperparameter that is\n less than \"0.5\":

\n

\n {\n

\n

\n \"Name\": \"HyperParameters.learning_rate\",\n

\n

\n \"Operator\": \"LessThan\",\n

\n

\n \"Value\": \"0.5\"\n

\n

\n }\n

\n
\n
Tags
\n
\n

To define a tag filter, enter a value with the form\n Tags..

\n
\n
" + } + }, + "com.amazonaws.sagemaker#FilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#Filter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.sagemaker#FilterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.sagemaker#FinalAutoMLJobObjectiveMetric": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.sagemaker#AutoMLJobObjectiveType", + "traits": { + "smithy.api#documentation": "

The type of metric with the best result.

" + } + }, + "MetricName": { + "target": "com.amazonaws.sagemaker#AutoMLMetricEnum", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the metric with the best result. For a description of the possible objective\n metrics, see AutoMLJobObjective$MetricName.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.sagemaker#MetricValue", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The value of the metric with the best result.

", + "smithy.api#required": {} + } + }, + "StandardMetricName": { + "target": "com.amazonaws.sagemaker#AutoMLMetricEnum", + "traits": { + "smithy.api#documentation": "

The name of the standard metric. For a description of the standard metrics, see Autopilot\n candidate metrics.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The best candidate result from an AutoML training job.

" + } + }, + "com.amazonaws.sagemaker#FinalHyperParameterTuningJobObjectiveMetric": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobObjectiveType", + "traits": { + "smithy.api#documentation": "

Select if you want to minimize or maximize the objective metric during hyperparameter\n tuning.

" + } + }, + "MetricName": { + "target": "com.amazonaws.sagemaker#MetricName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the objective metric. For SageMaker built-in algorithms, metrics are defined\n per algorithm. See the metrics for XGBoost as an\n example. You can also use a custom algorithm for training and define your own metrics.\n For more information, see Define metrics and environment variables.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.sagemaker#MetricValue", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The value of the objective metric.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Shows the latest objective metric emitted by a training job that was launched by a\n hyperparameter tuning job. You define the objective metric in the\n HyperParameterTuningJobObjective parameter of HyperParameterTuningJobConfig.

" + } + }, + "com.amazonaws.sagemaker#FinalMetricDataList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#MetricData" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 40 + } + } + }, + "com.amazonaws.sagemaker#FlatInvocations": { + "type": "enum", + "members": { + "CONTINUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Continue" + } + }, + "STOP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stop" + } + } + } + }, + "com.amazonaws.sagemaker#Float": { + "type": "float" + }, + "com.amazonaws.sagemaker#FlowDefinitionArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]+:[0-9]{12}:flow-definition/" + } + }, + "com.amazonaws.sagemaker#FlowDefinitionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-z0-9](-*[a-z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#FlowDefinitionOutputConfig": { + "type": "structure", + "members": { + "S3OutputPath": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon S3 path where the object containing human output will be made available.

\n

To learn more about the format of Amazon A2I output data, see Amazon A2I\n Output Data.

", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The Amazon Key Management Service (KMS) key ID for server-side encryption.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about where human output will be stored.

" + } + }, + "com.amazonaws.sagemaker#FlowDefinitionStatus": { + "type": "enum", + "members": { + "INITIALIZING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Initializing" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + } + } + }, + "com.amazonaws.sagemaker#FlowDefinitionSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#FlowDefinitionSummary" + } + }, + "com.amazonaws.sagemaker#FlowDefinitionSummary": { + "type": "structure", + "members": { + "FlowDefinitionName": { + "target": "com.amazonaws.sagemaker#FlowDefinitionName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the flow definition.

", + "smithy.api#required": {} + } + }, + "FlowDefinitionArn": { + "target": "com.amazonaws.sagemaker#FlowDefinitionArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the flow definition.

", + "smithy.api#required": {} + } + }, + "FlowDefinitionStatus": { + "target": "com.amazonaws.sagemaker#FlowDefinitionStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of the flow definition. Valid values:

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The timestamp when SageMaker created the flow definition.

", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "

The reason why the flow definition creation failed. A failure reason is returned only when the flow definition status is Failed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains summary information about the flow definition.

" + } + }, + "com.amazonaws.sagemaker#FlowDefinitionTaskAvailabilityLifetimeInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#FlowDefinitionTaskCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 3 + } + } + }, + "com.amazonaws.sagemaker#FlowDefinitionTaskDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.sagemaker#FlowDefinitionTaskKeyword": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 30 + }, + "smithy.api#pattern": "^[A-Za-z0-9]+( [A-Za-z0-9]+)*$" + } + }, + "com.amazonaws.sagemaker#FlowDefinitionTaskKeywords": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#FlowDefinitionTaskKeyword" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#FlowDefinitionTaskTimeLimitInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 30 + } + } + }, + "com.amazonaws.sagemaker#FlowDefinitionTaskTitle": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\t\\n\\r -\\uD7FF\\uE000-\\uFFFD]*$" + } + }, + "com.amazonaws.sagemaker#ForecastFrequency": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + }, + "smithy.api#pattern": "^1Y|Y|([1-9]|1[0-1])M|M|[1-4]W|W|[1-6]D|D|([1-9]|1[0-9]|2[0-3])H|H|([1-9]|[1-5][0-9])min$" + } + }, + "com.amazonaws.sagemaker#ForecastHorizon": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#ForecastQuantile": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 4 + }, + "smithy.api#pattern": "^(^p[1-9]\\d?$)$" + } + }, + "com.amazonaws.sagemaker#ForecastQuantiles": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ForecastQuantile" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#Framework": { + "type": "enum", + "members": { + "TENSORFLOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TENSORFLOW" + } + }, + "KERAS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KERAS" + } + }, + "MXNET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MXNET" + } + }, + "ONNX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ONNX" + } + }, + "PYTORCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PYTORCH" + } + }, + "XGBOOST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "XGBOOST" + } + }, + "TFLITE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TFLITE" + } + }, + "DARKNET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DARKNET" + } + }, + "SKLEARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SKLEARN" + } + } + } + }, + "com.amazonaws.sagemaker#FrameworkVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 10 + }, + "smithy.api#pattern": "^[0-9]\\.[A-Za-z0-9.]+$" + } + }, + "com.amazonaws.sagemaker#GenerateCandidateDefinitionsOnly": { + "type": "boolean" + }, + "com.amazonaws.sagemaker#GenerativeAiSettings": { + "type": "structure", + "members": { + "AmazonBedrockRoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of an Amazon Web Services IAM role that allows fine-tuning of large language models (LLMs) in\n Amazon Bedrock. The IAM role should have Amazon S3 read and write permissions, as well as a trust relationship that\n establishes bedrock.amazonaws.com as a service principal.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The generative AI settings for the SageMaker Canvas application.

\n

Configure these settings for Canvas users starting chats with generative AI foundation models.\n For more information, see \n Use generative AI with foundation models.

" + } + }, + "com.amazonaws.sagemaker#GetDeviceFleetReport": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#GetDeviceFleetReportRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#GetDeviceFleetReportResponse" + }, + "traits": { + "smithy.api#documentation": "

Describes a fleet.

" + } + }, + "com.amazonaws.sagemaker#GetDeviceFleetReportRequest": { + "type": "structure", + "members": { + "DeviceFleetName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the fleet.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#GetDeviceFleetReportResponse": { + "type": "structure", + "members": { + "DeviceFleetArn": { + "target": "com.amazonaws.sagemaker#DeviceFleetArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the device.

", + "smithy.api#required": {} + } + }, + "DeviceFleetName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the fleet.

", + "smithy.api#required": {} + } + }, + "OutputConfig": { + "target": "com.amazonaws.sagemaker#EdgeOutputConfig", + "traits": { + "smithy.api#documentation": "

The output configuration for storing sample data collected by the fleet.

" + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#DeviceFleetDescription", + "traits": { + "smithy.api#documentation": "

Description of the fleet.

" + } + }, + "ReportGenerated": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Timestamp of when the report was generated.

" + } + }, + "DeviceStats": { + "target": "com.amazonaws.sagemaker#DeviceStats", + "traits": { + "smithy.api#documentation": "

Status of devices.

" + } + }, + "AgentVersions": { + "target": "com.amazonaws.sagemaker#AgentVersions", + "traits": { + "smithy.api#documentation": "

The versions of Edge Manager agent deployed on the fleet.

" + } + }, + "ModelStats": { + "target": "com.amazonaws.sagemaker#EdgeModelStats", + "traits": { + "smithy.api#documentation": "

Status of model on device.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#GetLineageGroupPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#GetLineageGroupPolicyRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#GetLineageGroupPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

The resource policy for the lineage group.

" + } + }, + "com.amazonaws.sagemaker#GetLineageGroupPolicyRequest": { + "type": "structure", + "members": { + "LineageGroupName": { + "target": "com.amazonaws.sagemaker#LineageGroupNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the lineage group.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#GetLineageGroupPolicyResponse": { + "type": "structure", + "members": { + "LineageGroupArn": { + "target": "com.amazonaws.sagemaker#LineageGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the lineage group.

" + } + }, + "ResourcePolicy": { + "target": "com.amazonaws.sagemaker#ResourcePolicyString", + "traits": { + "smithy.api#documentation": "

The resource policy that gives access to the lineage group in another account.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#GetModelPackageGroupPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#GetModelPackageGroupPolicyInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#GetModelPackageGroupPolicyOutput" + }, + "traits": { + "smithy.api#documentation": "

Gets a resource policy that manages access for a model group. For information about\n resource policies, see Identity-based\n policies and resource-based policies in the Amazon Web Services Identity and\n Access Management User Guide..

" + } + }, + "com.amazonaws.sagemaker#GetModelPackageGroupPolicyInput": { + "type": "structure", + "members": { + "ModelPackageGroupName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the model group for which to get the resource policy.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#GetModelPackageGroupPolicyOutput": { + "type": "structure", + "members": { + "ResourcePolicy": { + "target": "com.amazonaws.sagemaker#PolicyString", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The resource policy for the model group.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#GetSagemakerServicecatalogPortfolioStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#GetSagemakerServicecatalogPortfolioStatusInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#GetSagemakerServicecatalogPortfolioStatusOutput" + }, + "traits": { + "smithy.api#documentation": "

Gets the status of Service Catalog in SageMaker. Service Catalog is used to create\n SageMaker projects.

" + } + }, + "com.amazonaws.sagemaker#GetSagemakerServicecatalogPortfolioStatusInput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#GetSagemakerServicecatalogPortfolioStatusOutput": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.sagemaker#SagemakerServicecatalogStatus", + "traits": { + "smithy.api#documentation": "

Whether Service Catalog is enabled or disabled in SageMaker.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#GetScalingConfigurationRecommendation": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#GetScalingConfigurationRecommendationRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#GetScalingConfigurationRecommendationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Starts an Amazon SageMaker Inference Recommender autoscaling recommendation job. Returns recommendations for autoscaling policies\n that you can apply to your SageMaker endpoint.

" + } + }, + "com.amazonaws.sagemaker#GetScalingConfigurationRecommendationRequest": { + "type": "structure", + "members": { + "InferenceRecommendationsJobName": { + "target": "com.amazonaws.sagemaker#RecommendationJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of a previously completed Inference Recommender job.

", + "smithy.api#required": {} + } + }, + "RecommendationId": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The recommendation ID of a previously completed inference recommendation. This ID should come from one of the\n recommendations returned by the job specified in the InferenceRecommendationsJobName field.

\n

Specify either this field or the EndpointName field.

" + } + }, + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#documentation": "

The name of an endpoint benchmarked during a previously completed inference recommendation job. This name should come from one of the\n recommendations returned by the job specified in the InferenceRecommendationsJobName field.

\n

Specify either this field or the RecommendationId field.

" + } + }, + "TargetCpuUtilizationPerCore": { + "target": "com.amazonaws.sagemaker#UtilizationPercentagePerCore", + "traits": { + "smithy.api#documentation": "

The percentage of how much utilization you want an instance to use before autoscaling. The default value is 50%.

" + } + }, + "ScalingPolicyObjective": { + "target": "com.amazonaws.sagemaker#ScalingPolicyObjective", + "traits": { + "smithy.api#documentation": "

An object where you specify the anticipated traffic pattern for an endpoint.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#GetScalingConfigurationRecommendationResponse": { + "type": "structure", + "members": { + "InferenceRecommendationsJobName": { + "target": "com.amazonaws.sagemaker#RecommendationJobName", + "traits": { + "smithy.api#documentation": "

The name of a previously completed Inference Recommender job.

" + } + }, + "RecommendationId": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The recommendation ID of a previously completed inference recommendation.

" + } + }, + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#documentation": "

The name of an endpoint benchmarked during a previously completed Inference Recommender job.

" + } + }, + "TargetCpuUtilizationPerCore": { + "target": "com.amazonaws.sagemaker#UtilizationPercentagePerCore", + "traits": { + "smithy.api#documentation": "

The percentage of how much utilization you want an instance to use before autoscaling, which you specified in the request. The default value is 50%.

" + } + }, + "ScalingPolicyObjective": { + "target": "com.amazonaws.sagemaker#ScalingPolicyObjective", + "traits": { + "smithy.api#documentation": "

An object representing the anticipated traffic pattern for an endpoint that you specified in the request.

" + } + }, + "Metric": { + "target": "com.amazonaws.sagemaker#ScalingPolicyMetric", + "traits": { + "smithy.api#documentation": "

An object with a list of metrics that were benchmarked during the previously completed Inference Recommender job.

" + } + }, + "DynamicScalingConfiguration": { + "target": "com.amazonaws.sagemaker#DynamicScalingConfiguration", + "traits": { + "smithy.api#documentation": "

An object with the recommended values for you to specify when creating an autoscaling policy.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#GetSearchSuggestions": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#GetSearchSuggestionsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#GetSearchSuggestionsResponse" + }, + "traits": { + "smithy.api#documentation": "

An auto-complete API for the search functionality in the SageMaker console. It returns\n suggestions of possible matches for the property name to use in Search\n queries. Provides suggestions for HyperParameters, Tags, and\n Metrics.

" + } + }, + "com.amazonaws.sagemaker#GetSearchSuggestionsRequest": { + "type": "structure", + "members": { + "Resource": { + "target": "com.amazonaws.sagemaker#ResourceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the SageMaker resource to search for.

", + "smithy.api#required": {} + } + }, + "SuggestionQuery": { + "target": "com.amazonaws.sagemaker#SuggestionQuery", + "traits": { + "smithy.api#documentation": "

Limits the property names that are included in the response.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#GetSearchSuggestionsResponse": { + "type": "structure", + "members": { + "PropertyNameSuggestions": { + "target": "com.amazonaws.sagemaker#PropertyNameSuggestionList", + "traits": { + "smithy.api#documentation": "

A list of property names for a Resource that match a\n SuggestionQuery.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#Gid": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1001, + "max": 4000000 + } + } + }, + "com.amazonaws.sagemaker#GitConfig": { + "type": "structure", + "members": { + "RepositoryUrl": { + "target": "com.amazonaws.sagemaker#GitConfigUrl", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The URL where the Git repository is located.

", + "smithy.api#required": {} + } + }, + "Branch": { + "target": "com.amazonaws.sagemaker#Branch", + "traits": { + "smithy.api#documentation": "

The default branch for the Git repository.

" + } + }, + "SecretArn": { + "target": "com.amazonaws.sagemaker#SecretArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that\n contains the credentials used to access the git repository. The secret must have a\n staging label of AWSCURRENT and must be in the following format:

\n

\n {\"username\": UserName, \"password\":\n Password}\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies configuration details for a Git repository in your Amazon Web Services\n account.

" + } + }, + "com.amazonaws.sagemaker#GitConfigForUpdate": { + "type": "structure", + "members": { + "SecretArn": { + "target": "com.amazonaws.sagemaker#SecretArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that\n contains the credentials used to access the git repository. The secret must have a\n staging label of AWSCURRENT and must be in the following format:

\n

\n {\"username\": UserName, \"password\":\n Password}\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies configuration details for a Git repository when the repository is\n updated.

" + } + }, + "com.amazonaws.sagemaker#GitConfigUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 11, + "max": 1024 + }, + "smithy.api#pattern": "^https://([^/]+)/?.{3,1016}$" + } + }, + "com.amazonaws.sagemaker#Group": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+$" + } + }, + "com.amazonaws.sagemaker#GroupingAttributeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.sagemaker#GroupingAttributeNames": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#GroupingAttributeName" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#Groups": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#Group" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.sagemaker#HiddenAppTypesList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AppType" + } + }, + "com.amazonaws.sagemaker#HiddenInstanceTypesList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AppInstanceType" + } + }, + "com.amazonaws.sagemaker#HiddenMlToolsList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#MlTools" + } + }, + "com.amazonaws.sagemaker#HiddenSageMakerImage": { + "type": "structure", + "members": { + "SageMakerImageName": { + "target": "com.amazonaws.sagemaker#SageMakerImageName", + "traits": { + "smithy.api#documentation": "

The SageMaker image name that you are hiding from the Studio user interface.

" + } + }, + "VersionAliases": { + "target": "com.amazonaws.sagemaker#VersionAliasesList", + "traits": { + "smithy.api#documentation": "

The version aliases you are hiding from the Studio user interface.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The SageMaker images that are hidden from the Studio user interface. You must specify the SageMaker\n image name and version aliases.

" + } + }, + "com.amazonaws.sagemaker#HiddenSageMakerImageVersionAliasesList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#HiddenSageMakerImage" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#HolidayConfig": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#HolidayConfigAttributes" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.sagemaker#HolidayConfigAttributes": { + "type": "structure", + "members": { + "CountryCode": { + "target": "com.amazonaws.sagemaker#CountryCode", + "traits": { + "smithy.api#documentation": "

The country code for the holiday calendar.

\n

For the list of public holiday calendars supported by AutoML job V2, see Country Codes. Use the country code corresponding to the country of your\n choice.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Stores the holiday featurization attributes applicable to each item of time-series\n datasets during the training of a forecasting model. This allows the model to identify\n patterns associated with specific holidays.

" + } + }, + "com.amazonaws.sagemaker#HookParameters": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#ConfigKey" + }, + "value": { + "target": "com.amazonaws.sagemaker#ConfigValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.sagemaker#Horovod": { + "type": "boolean" + }, + "com.amazonaws.sagemaker#HubArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#HubContentArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#HubContentDependency": { + "type": "structure", + "members": { + "DependencyOriginPath": { + "target": "com.amazonaws.sagemaker#DependencyOriginPath", + "traits": { + "smithy.api#documentation": "

The hub content dependency origin path.

" + } + }, + "DependencyCopyPath": { + "target": "com.amazonaws.sagemaker#DependencyCopyPath", + "traits": { + "smithy.api#documentation": "

The hub content dependency copy path.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Any dependencies related to hub content, such as scripts, model artifacts, datasets, or notebooks.

" + } + }, + "com.amazonaws.sagemaker#HubContentDependencyList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#HubContentDependency" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.sagemaker#HubContentDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1023 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#HubContentDisplayName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#HubContentDocument": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 65535 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#HubContentInfo": { + "type": "structure", + "members": { + "HubContentName": { + "target": "com.amazonaws.sagemaker#HubContentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the hub content.

", + "smithy.api#required": {} + } + }, + "HubContentArn": { + "target": "com.amazonaws.sagemaker#HubContentArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the hub content.

", + "smithy.api#required": {} + } + }, + "SageMakerPublicHubContentArn": { + "target": "com.amazonaws.sagemaker#SageMakerPublicHubContentArn", + "traits": { + "smithy.api#documentation": "

The ARN of the public hub content.

" + } + }, + "HubContentVersion": { + "target": "com.amazonaws.sagemaker#HubContentVersion", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The version of the hub content.

", + "smithy.api#required": {} + } + }, + "HubContentType": { + "target": "com.amazonaws.sagemaker#HubContentType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of hub content.

", + "smithy.api#required": {} + } + }, + "DocumentSchemaVersion": { + "target": "com.amazonaws.sagemaker#DocumentSchemaVersion", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The version of the hub content document schema.

", + "smithy.api#required": {} + } + }, + "HubContentDisplayName": { + "target": "com.amazonaws.sagemaker#HubContentDisplayName", + "traits": { + "smithy.api#documentation": "

The display name of the hub content.

" + } + }, + "HubContentDescription": { + "target": "com.amazonaws.sagemaker#HubContentDescription", + "traits": { + "smithy.api#documentation": "

A description of the hub content.

" + } + }, + "SupportStatus": { + "target": "com.amazonaws.sagemaker#HubContentSupportStatus", + "traits": { + "smithy.api#documentation": "

The support status of the hub content.

" + } + }, + "HubContentSearchKeywords": { + "target": "com.amazonaws.sagemaker#HubContentSearchKeywordList", + "traits": { + "smithy.api#documentation": "

The searchable keywords for the hub content.

" + } + }, + "HubContentStatus": { + "target": "com.amazonaws.sagemaker#HubContentStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of the hub content.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The date and time that the hub content was created.

", + "smithy.api#required": {} + } + }, + "OriginalCreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time when the hub content was originally created, before any updates or revisions.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about hub content.

" + } + }, + "com.amazonaws.sagemaker#HubContentInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#HubContentInfo" + } + }, + "com.amazonaws.sagemaker#HubContentMarkdown": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 65535 + } + } + }, + "com.amazonaws.sagemaker#HubContentName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#HubContentSearchKeywordList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#HubSearchKeyword" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.sagemaker#HubContentSortBy": { + "type": "enum", + "members": { + "HUB_CONTENT_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HubContentName" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "HUB_CONTENT_STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HubContentStatus" + } + } + } + }, + "com.amazonaws.sagemaker#HubContentStatus": { + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Available" + } + }, + "IMPORTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Importing" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "IMPORT_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ImportFailed" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteFailed" + } + } + } + }, + "com.amazonaws.sagemaker#HubContentSupportStatus": { + "type": "enum", + "members": { + "SUPPORTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Supported" + } + }, + "DEPRECATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deprecated" + } + } + } + }, + "com.amazonaws.sagemaker#HubContentType": { + "type": "enum", + "members": { + "MODEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Model" + } + }, + "NOTEBOOK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Notebook" + } + }, + "MODEL_REFERENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ModelReference" + } + } + } + }, + "com.amazonaws.sagemaker#HubContentVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 5, + "max": 14 + }, + "smithy.api#pattern": "^\\d{1,4}.\\d{1,4}.\\d{1,4}$" + } + }, + "com.amazonaws.sagemaker#HubDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1023 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#HubDisplayName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#HubInfo": { + "type": "structure", + "members": { + "HubName": { + "target": "com.amazonaws.sagemaker#HubName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the hub.

", + "smithy.api#required": {} + } + }, + "HubArn": { + "target": "com.amazonaws.sagemaker#HubArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the hub.

", + "smithy.api#required": {} + } + }, + "HubDisplayName": { + "target": "com.amazonaws.sagemaker#HubDisplayName", + "traits": { + "smithy.api#documentation": "

The display name of the hub.

" + } + }, + "HubDescription": { + "target": "com.amazonaws.sagemaker#HubDescription", + "traits": { + "smithy.api#documentation": "

A description of the hub.

" + } + }, + "HubSearchKeywords": { + "target": "com.amazonaws.sagemaker#HubSearchKeywordList", + "traits": { + "smithy.api#documentation": "

The searchable keywords for the hub.

" + } + }, + "HubStatus": { + "target": "com.amazonaws.sagemaker#HubStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of the hub.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The date and time that the hub was created.

", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The date and time that the hub was last modified.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a hub.

" + } + }, + "com.amazonaws.sagemaker#HubInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#HubInfo" + } + }, + "com.amazonaws.sagemaker#HubName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#HubNameOrArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(arn:[a-z0-9-\\.]{1,63}:sagemaker:\\w+(?:-\\w+)+:(\\d{12}|aws):hub\\/)?[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#HubS3StorageConfig": { + "type": "structure", + "members": { + "S3OutputPath": { + "target": "com.amazonaws.sagemaker#S3OutputPath", + "traits": { + "smithy.api#documentation": "

The Amazon S3 bucket prefix for hosting hub content.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon S3 storage configuration of a hub.

" + } + }, + "com.amazonaws.sagemaker#HubSearchKeyword": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": "^[^A-Z]*$" + } + }, + "com.amazonaws.sagemaker#HubSearchKeywordList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#HubSearchKeyword" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.sagemaker#HubSortBy": { + "type": "enum", + "members": { + "HUB_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HubName" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "HUB_STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HubStatus" + } + }, + "ACCOUNT_ID_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AccountIdOwner" + } + } + } + }, + "com.amazonaws.sagemaker#HubStatus": { + "type": "enum", + "members": { + "IN_SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InService" + } + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Creating" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateFailed" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateFailed" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteFailed" + } + } + } + }, + "com.amazonaws.sagemaker#HumanLoopActivationConditionsConfig": { + "type": "structure", + "members": { + "HumanLoopActivationConditions": { + "target": "com.amazonaws.sagemaker#SynthesizedJsonHumanLoopActivationConditions", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

JSON expressing use-case specific conditions declaratively. If any condition is matched, atomic tasks are created against the configured work team. \n The set of conditions is different for Rekognition and Textract. For more information about how to structure the JSON, see \n JSON Schema for Human Loop Activation Conditions in Amazon Augmented AI \n in the Amazon SageMaker Developer Guide.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines under what conditions SageMaker creates a human loop. Used within CreateFlowDefinition. See HumanLoopActivationConditionsConfig for the required\n format of activation conditions.

" + } + }, + "com.amazonaws.sagemaker#HumanLoopActivationConfig": { + "type": "structure", + "members": { + "HumanLoopActivationConditionsConfig": { + "target": "com.amazonaws.sagemaker#HumanLoopActivationConditionsConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Container structure for defining under what conditions SageMaker creates a human\n loop.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about how and under what conditions SageMaker creates a human loop. If HumanLoopActivationConfig is not given, then all requests go to humans.

" + } + }, + "com.amazonaws.sagemaker#HumanLoopConfig": { + "type": "structure", + "members": { + "WorkteamArn": { + "target": "com.amazonaws.sagemaker#WorkteamArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Amazon Resource Name (ARN) of a team of workers. To learn more about the types of\n workforces and work teams you can create and use with Amazon A2I, see Create\n and Manage Workforces.

", + "smithy.api#required": {} + } + }, + "HumanTaskUiArn": { + "target": "com.amazonaws.sagemaker#HumanTaskUiArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the human task user interface.

\n

You can use standard HTML and Crowd HTML Elements to create a custom worker task\n template. You use this template to create a human task UI.

\n

To learn how to create a custom HTML template, see Create Custom Worker\n Task Template.

\n

To learn how to create a human task UI, which is a worker task template that can be used\n in a flow definition, see Create and Delete a Worker Task Templates.

", + "smithy.api#required": {} + } + }, + "TaskTitle": { + "target": "com.amazonaws.sagemaker#FlowDefinitionTaskTitle", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A title for the human worker task.

", + "smithy.api#required": {} + } + }, + "TaskDescription": { + "target": "com.amazonaws.sagemaker#FlowDefinitionTaskDescription", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A description for the human worker task.

", + "smithy.api#required": {} + } + }, + "TaskCount": { + "target": "com.amazonaws.sagemaker#FlowDefinitionTaskCount", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of distinct workers who will perform the same task on each object.\n For example, if TaskCount is set to 3 for an image classification \n labeling job, three workers will classify each input image. \n Increasing TaskCount can improve label accuracy.

", + "smithy.api#required": {} + } + }, + "TaskAvailabilityLifetimeInSeconds": { + "target": "com.amazonaws.sagemaker#FlowDefinitionTaskAvailabilityLifetimeInSeconds", + "traits": { + "smithy.api#documentation": "

The length of time that a task remains available for review by human workers.

" + } + }, + "TaskTimeLimitInSeconds": { + "target": "com.amazonaws.sagemaker#FlowDefinitionTaskTimeLimitInSeconds", + "traits": { + "smithy.api#documentation": "

The amount of time that a worker has to complete a task. The default value is 3,600\n seconds (1 hour).

" + } + }, + "TaskKeywords": { + "target": "com.amazonaws.sagemaker#FlowDefinitionTaskKeywords", + "traits": { + "smithy.api#documentation": "

Keywords used to describe the task so that workers can discover the task.

" + } + }, + "PublicWorkforceTaskPrice": { + "target": "com.amazonaws.sagemaker#PublicWorkforceTaskPrice" + } + }, + "traits": { + "smithy.api#documentation": "

Describes the work to be performed by human workers.

" + } + }, + "com.amazonaws.sagemaker#HumanLoopRequestSource": { + "type": "structure", + "members": { + "AwsManagedHumanLoopRequestSource": { + "target": "com.amazonaws.sagemaker#AwsManagedHumanLoopRequestSource", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies whether Amazon Rekognition or Amazon Textract are used as the integration source. \n The default field settings and JSON parsing rules are different based on the integration source. Valid values:

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Container for configuring the source of human task requests.

" + } + }, + "com.amazonaws.sagemaker#HumanTaskConfig": { + "type": "structure", + "members": { + "WorkteamArn": { + "target": "com.amazonaws.sagemaker#WorkteamArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the work team assigned to complete the tasks.

", + "smithy.api#required": {} + } + }, + "UiConfig": { + "target": "com.amazonaws.sagemaker#UiConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Information about the user interface that workers use to complete the labeling\n task.

", + "smithy.api#required": {} + } + }, + "PreHumanTaskLambdaArn": { + "target": "com.amazonaws.sagemaker#LambdaFunctionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Lambda function that is run before a data object\n is sent to a human worker. Use this function to provide input to a custom labeling\n job.

\n

For built-in\n task types, use one of the following Amazon SageMaker Ground Truth Lambda function ARNs for\n PreHumanTaskLambdaArn. For custom labeling workflows, see Pre-annotation Lambda.

\n

\n Bounding box - Finds the most similar boxes from\n different workers based on the Jaccard index of the boxes.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-BoundingBox\n

    \n
    • \n
\n

\n Image classification - Uses a variant of the Expectation\n Maximization approach to estimate the true class of an image based on\n annotations from individual workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClass\n

    \n
    • \n
\n

\n Multi-label image classification - Uses a variant of the Expectation\n Maximization approach to estimate the true classes of an image based on\n annotations from individual workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
\n

\n Semantic segmentation - Treats each pixel in an image as\n a multi-class classification and treats pixel annotations from workers as\n \"votes\" for the correct label.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-SemanticSegmentation\n

    \n
    • \n
\n

\n Text classification - Uses a variant of the Expectation\n Maximization approach to estimate the true class of text based on annotations\n from individual workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClass\n

    \n
    • \n
\n

\n Multi-label text classification - Uses a variant of the\n Expectation Maximization approach to estimate the true classes of text based on\n annotations from individual workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
\n

\n Named entity recognition - Groups similar selections and\n calculates aggregate boundaries, resolving to most-assigned label.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-NamedEntityRecognition\n

    \n
    • \n
\n

\n Video Classification - Use this task type when you need workers to classify videos using\n predefined labels that you specify. Workers are shown videos and are asked to choose one\n label for each video.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoMultiClass\n

    \n
    • \n
\n

\n Video Frame Object Detection - Use this task type to\n have workers identify and locate objects in a sequence of video frames (images extracted\n from a video) using bounding boxes. For example, you can use this task to ask workers to\n identify and localize various objects in a series of video frames, such as cars, bikes,\n and pedestrians.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectDetection\n

    \n
    • \n
\n

\n Video Frame Object Tracking - Use this task type to\n have workers track the movement of objects in a sequence of video frames (images\n extracted from a video) using bounding boxes. For example, you can use this task to ask\n workers to track the movement of objects, such as cars, bikes, and pedestrians.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectTracking\n

    \n
    • \n
\n

\n 3D Point Cloud Modalities\n

\n

Use the following pre-annotation lambdas for 3D point cloud labeling modality tasks.\n See 3D Point Cloud Task types\n to learn more.

\n

\n 3D Point Cloud Object Detection - \n Use this task type when you want workers to classify objects in a 3D point cloud by \n drawing 3D cuboids around objects. For example, you can use this task type to ask workers \n to identify different types of objects in a point cloud, such as cars, bikes, and pedestrians.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
\n

\n 3D Point Cloud Object Tracking - \n Use this task type when you want workers to draw 3D cuboids around objects\n that appear in a sequence of 3D point cloud frames. \n For example, you can use this task type to ask workers to track \n the movement of vehicles across multiple point cloud frames.\n

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
\n

\n 3D Point Cloud Semantic Segmentation - \n Use this task type when you want workers to create a point-level semantic segmentation masks by \n painting objects in a 3D point cloud using different colors where each color is assigned to one of \n the classes you specify.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
\n

\n Use the following ARNs for Label Verification and Adjustment Jobs\n

\n

Use label verification and adjustment jobs to review and adjust labels. To learn more,\n see Verify and Adjust Labels .

\n

\n Bounding box verification - Uses a variant of the\n Expectation Maximization approach to estimate the true class of verification\n judgement for bounding box labels based on annotations from individual\n workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationBoundingBox\n

    \n
    • \n
\n

\n Bounding box adjustment - Finds the most similar boxes\n from different workers based on the Jaccard index of the adjusted\n annotations.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
\n

\n Semantic segmentation verification - Uses a variant of\n the Expectation Maximization approach to estimate the true class of verification\n judgment for semantic segmentation labels based on annotations from individual\n workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
\n

\n Semantic segmentation adjustment - Treats each pixel in\n an image as a multi-class classification and treats pixel adjusted annotations\n from workers as \"votes\" for the correct label.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
\n

\n Video Frame Object Detection Adjustment - \n Use this task type when you want workers to adjust bounding boxes that workers have added \n to video frames to classify and localize objects in a sequence of video frames.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
\n

\n Video Frame Object Tracking Adjustment - \n Use this task type when you want workers to adjust bounding boxes that workers have added \n to video frames to track object movement across a sequence of video frames.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
\n

\n 3D point cloud object detection adjustment - Adjust\n 3D cuboids in a point cloud frame.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
\n

\n 3D point cloud object tracking adjustment - Adjust 3D\n cuboids across a sequence of point cloud frames.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
\n

\n 3D point cloud semantic segmentation adjustment -\n Adjust semantic segmentation masks in a 3D point cloud.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
" + } + }, + "TaskKeywords": { + "target": "com.amazonaws.sagemaker#TaskKeywords", + "traits": { + "smithy.api#documentation": "

Keywords used to describe the task so that workers on Amazon Mechanical Turk can\n discover the task.

" + } + }, + "TaskTitle": { + "target": "com.amazonaws.sagemaker#TaskTitle", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A title for the task for your human workers.

", + "smithy.api#required": {} + } + }, + "TaskDescription": { + "target": "com.amazonaws.sagemaker#TaskDescription", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A description of the task for your human workers.

", + "smithy.api#required": {} + } + }, + "NumberOfHumanWorkersPerDataObject": { + "target": "com.amazonaws.sagemaker#NumberOfHumanWorkersPerDataObject", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of human workers that will label an object.

", + "smithy.api#required": {} + } + }, + "TaskTimeLimitInSeconds": { + "target": "com.amazonaws.sagemaker#TaskTimeLimitInSeconds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The amount of time that a worker has to complete a task.

\n

If you create a custom labeling job, the maximum value for this parameter is 8 hours\n (28,800 seconds).

\n

If you create a labeling job using a built-in task type the maximum\n for this parameter depends on the task type you use:

\n
    \n
  • \n

    For image and \n text labeling jobs,\n the maximum is 8 hours (28,800 seconds).

    \n
    • \n
  • \n

    For 3D point cloud and video frame labeling jobs, the maximum is 30 days (2952,000 seconds) for non-AL mode. For most users, the maximum is also 30 days.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "TaskAvailabilityLifetimeInSeconds": { + "target": "com.amazonaws.sagemaker#TaskAvailabilityLifetimeInSeconds", + "traits": { + "smithy.api#documentation": "

The length of time that a task remains available for labeling by human workers. The\n default and maximum values for this parameter depend on the type of workforce you\n use.

\n
    \n
  • \n

    If you choose the Amazon Mechanical Turk workforce, the maximum is 12 hours (43,200 seconds).\n The default is 6 hours (21,600 seconds).

    \n
    • \n
  • \n

    If you choose a private or vendor workforce, the default value is 30 days (2592,000 seconds) for non-AL mode. For most users, the maximum is also 30 days.

    \n
    • \n
" + } + }, + "MaxConcurrentTaskCount": { + "target": "com.amazonaws.sagemaker#MaxConcurrentTaskCount", + "traits": { + "smithy.api#documentation": "

Defines the maximum number of data objects that can be labeled by human workers at the\n same time. Also referred to as batch size. Each object may have more than one worker at one time.\n The default value is 1000 objects. To increase the maximum value to 5000 objects, contact Amazon Web Services Support.

" + } + }, + "AnnotationConsolidationConfig": { + "target": "com.amazonaws.sagemaker#AnnotationConsolidationConfig", + "traits": { + "smithy.api#documentation": "

Configures how labels are consolidated across human workers.

" + } + }, + "PublicWorkforceTaskPrice": { + "target": "com.amazonaws.sagemaker#PublicWorkforceTaskPrice", + "traits": { + "smithy.api#documentation": "

The price that you pay for each task performed by an Amazon Mechanical Turk worker.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information required for human workers to complete a labeling task.

" + } + }, + "com.amazonaws.sagemaker#HumanTaskUiArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]+:[0-9]{12}:human-task-ui/" + } + }, + "com.amazonaws.sagemaker#HumanTaskUiName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-z0-9](-*[a-z0-9])*$" + } + }, + "com.amazonaws.sagemaker#HumanTaskUiStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + } + } + }, + "com.amazonaws.sagemaker#HumanTaskUiSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#HumanTaskUiSummary" + } + }, + "com.amazonaws.sagemaker#HumanTaskUiSummary": { + "type": "structure", + "members": { + "HumanTaskUiName": { + "target": "com.amazonaws.sagemaker#HumanTaskUiName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the human task user interface.

", + "smithy.api#required": {} + } + }, + "HumanTaskUiArn": { + "target": "com.amazonaws.sagemaker#HumanTaskUiArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the human task user interface.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A timestamp when SageMaker created the human task user interface.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Container for human task user interface information.

" + } + }, + "com.amazonaws.sagemaker#HyperParameterAlgorithmSpecification": { + "type": "structure", + "members": { + "TrainingImage": { + "target": "com.amazonaws.sagemaker#AlgorithmImage", + "traits": { + "smithy.api#documentation": "

The registry path of the Docker image that contains the training algorithm. For\n information about Docker registry paths for built-in algorithms, see Algorithms\n Provided by Amazon SageMaker: Common Parameters. SageMaker supports both\n registry/repository[:tag] and registry/repository[@digest]\n image path formats. For more information, see Using Your Own Algorithms with\n Amazon SageMaker.

" + } + }, + "TrainingInputMode": { + "target": "com.amazonaws.sagemaker#TrainingInputMode", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "AlgorithmName": { + "target": "com.amazonaws.sagemaker#ArnOrName", + "traits": { + "smithy.api#documentation": "

The name of the resource algorithm to use for the hyperparameter tuning job. If you\n specify a value for this parameter, do not specify a value for\n TrainingImage.

" + } + }, + "MetricDefinitions": { + "target": "com.amazonaws.sagemaker#MetricDefinitionList", + "traits": { + "smithy.api#documentation": "

An array of MetricDefinition objects that specify the\n metrics\n that the algorithm emits.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies\n which\n training algorithm to use for training jobs that a hyperparameter\n tuning job launches and the metrics to monitor.

" + } + }, + "com.amazonaws.sagemaker#HyperParameterKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#HyperParameterScalingType": { + "type": "enum", + "members": { + "AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Auto" + } + }, + "LINEAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Linear" + } + }, + "LOGARITHMIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Logarithmic" + } + }, + "REVERSE_LOGARITHMIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ReverseLogarithmic" + } + } + } + }, + "com.amazonaws.sagemaker#HyperParameterSpecification": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#ParameterName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of this hyperparameter. The name must be unique.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "

A brief description of the hyperparameter.

" + } + }, + "Type": { + "target": "com.amazonaws.sagemaker#ParameterType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of this hyperparameter. The valid types are Integer,\n Continuous, Categorical, and FreeText.

", + "smithy.api#required": {} + } + }, + "Range": { + "target": "com.amazonaws.sagemaker#ParameterRange", + "traits": { + "smithy.api#documentation": "

The allowed range for this hyperparameter.

" + } + }, + "IsTunable": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether this hyperparameter is tunable in a hyperparameter tuning\n job.

" + } + }, + "IsRequired": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether this hyperparameter is required.

" + } + }, + "DefaultValue": { + "target": "com.amazonaws.sagemaker#HyperParameterValue", + "traits": { + "smithy.api#documentation": "

The default value for this hyperparameter. If a default value is specified, a\n hyperparameter cannot be required.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines a hyperparameter to be used by an algorithm.

" + } + }, + "com.amazonaws.sagemaker#HyperParameterSpecifications": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#HyperParameterSpecification" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinition": { + "type": "structure", + "members": { + "DefinitionName": { + "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinitionName", + "traits": { + "smithy.api#documentation": "

The job definition name.

" + } + }, + "TuningObjective": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobObjective" + }, + "HyperParameterRanges": { + "target": "com.amazonaws.sagemaker#ParameterRanges" + }, + "StaticHyperParameters": { + "target": "com.amazonaws.sagemaker#HyperParameters", + "traits": { + "smithy.api#documentation": "

Specifies the values of hyperparameters\n that\n do not change for the tuning job.

" + } + }, + "AlgorithmSpecification": { + "target": "com.amazonaws.sagemaker#HyperParameterAlgorithmSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The HyperParameterAlgorithmSpecification object that\n specifies\n the resource algorithm to use for the training jobs that the tuning\n job launches.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the\n IAM\n role associated with the training jobs that the tuning job\n launches.

", + "smithy.api#required": {} + } + }, + "InputDataConfig": { + "target": "com.amazonaws.sagemaker#InputDataConfig", + "traits": { + "smithy.api#documentation": "

An array of Channel objects that\n specify\n the\n input for the training jobs that the tuning job launches.

" + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig", + "traits": { + "smithy.api#documentation": "

The VpcConfig object that specifies the VPC that you want the training jobs\n that this hyperparameter tuning job launches to connect to. Control access to and from\n your training container by configuring the VPC. For more information, see Protect Training Jobs\n by Using an Amazon Virtual Private Cloud.

" + } + }, + "OutputDataConfig": { + "target": "com.amazonaws.sagemaker#OutputDataConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies the path to the Amazon S3 bucket where you\n store\n model artifacts from the training jobs that the tuning job\n launches.

", + "smithy.api#required": {} + } + }, + "ResourceConfig": { + "target": "com.amazonaws.sagemaker#ResourceConfig", + "traits": { + "smithy.api#documentation": "

The resources,\n including\n the compute instances and storage volumes, to use for the training\n jobs that the tuning job launches.

\n

Storage volumes store model artifacts and\n incremental\n states. Training algorithms might also use storage volumes for\n scratch\n space. If you want SageMaker to use the storage volume to store the\n training data, choose File as the TrainingInputMode in the\n algorithm specification. For distributed training algorithms, specify an instance count\n greater than 1.

\n \n

If you want to use hyperparameter optimization with instance type flexibility, use\n HyperParameterTuningResourceConfig instead.

\n " + } + }, + "HyperParameterTuningResourceConfig": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningResourceConfig", + "traits": { + "smithy.api#documentation": "

The configuration for the hyperparameter tuning resources, including the compute\n instances and storage volumes, used for training jobs launched by the tuning job. By\n default, storage volumes hold model artifacts and incremental states. Choose\n File for TrainingInputMode in the\n AlgorithmSpecification parameter to additionally store training data in\n the storage volume (optional).

" + } + }, + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#StoppingCondition", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies a limit to how long a model hyperparameter training job can run. It also\n specifies how long a managed spot training job has to complete. When the job reaches the\n time limit, SageMaker ends the training job. Use this API to cap model training costs.

", + "smithy.api#required": {} + } + }, + "EnableNetworkIsolation": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

Isolates the training container. No inbound or outbound network calls can be made,\n except for calls between peers within a training cluster for distributed training. If\n network isolation is used for training jobs that are configured to use a VPC, SageMaker\n downloads and uploads customer data and model artifacts through the specified VPC, but\n the training container does not have network access.

" + } + }, + "EnableInterContainerTrafficEncryption": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

To encrypt all communications between ML compute instances in distributed training,\n choose True. Encryption provides greater security for distributed training,\n but training might take longer. How long it takes depends on the amount of communication\n between compute instances, especially if you use a deep learning algorithm in\n distributed training.

" + } + }, + "EnableManagedSpotTraining": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

A Boolean indicating whether managed spot training is enabled (True) or\n not (False).

" + } + }, + "CheckpointConfig": { + "target": "com.amazonaws.sagemaker#CheckpointConfig" + }, + "RetryStrategy": { + "target": "com.amazonaws.sagemaker#RetryStrategy", + "traits": { + "smithy.api#documentation": "

The number of times to retry the job when the job fails due to an\n InternalServerError.

" + } + }, + "Environment": { + "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobEnvironmentMap", + "traits": { + "smithy.api#documentation": "

An environment variable that you can pass into the SageMaker CreateTrainingJob API. You can use an existing environment variable from the training container or use your own. See\n Define metrics and variables for more information.

\n \n

The maximum number of items specified for Map Entries refers to the\n maximum number of environment variables for each TrainingJobDefinition\n and also the maximum for the hyperparameter tuning job itself. That is, the sum of\n the number of environment variables for all the training job definitions can't\n exceed the maximum number specified.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines\n the training jobs launched by a hyperparameter tuning job.

" + } + }, + "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinitionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}$" + } + }, + "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinitions": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinition" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.sagemaker#HyperParameterTrainingJobEnvironmentKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$" + } + }, + "com.amazonaws.sagemaker#HyperParameterTrainingJobEnvironmentMap": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobEnvironmentKey" + }, + "value": { + "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobEnvironmentValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 48 + } + } + }, + "com.amazonaws.sagemaker#HyperParameterTrainingJobEnvironmentValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^[\\S\\s]*$" + } + }, + "com.amazonaws.sagemaker#HyperParameterTrainingJobSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobSummary" + } + }, + "com.amazonaws.sagemaker#HyperParameterTrainingJobSummary": { + "type": "structure", + "members": { + "TrainingJobDefinitionName": { + "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinitionName", + "traits": { + "smithy.api#documentation": "

The training job definition name.

" + } + }, + "TrainingJobName": { + "target": "com.amazonaws.sagemaker#TrainingJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the training job.

", + "smithy.api#required": {} + } + }, + "TrainingJobArn": { + "target": "com.amazonaws.sagemaker#TrainingJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the training job.

", + "smithy.api#required": {} + } + }, + "TuningJobName": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobName", + "traits": { + "smithy.api#documentation": "

The HyperParameter tuning job that launched the training job.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The date and time that the training job was created.

", + "smithy.api#required": {} + } + }, + "TrainingStartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the training job started.

" + } + }, + "TrainingEndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Specifies the time when the training job ends on training instances. You are billed\n for the time interval between the value of TrainingStartTime and this time.\n For successful jobs and stopped jobs, this is the time after model artifacts are\n uploaded. For failed jobs, this is the time when SageMaker detects a job failure.

" + } + }, + "TrainingJobStatus": { + "target": "com.amazonaws.sagemaker#TrainingJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The\n status\n of the training job.

", + "smithy.api#required": {} + } + }, + "TunedHyperParameters": { + "target": "com.amazonaws.sagemaker#HyperParameters", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A\n list of the hyperparameters for which you specified ranges to\n search.

", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "

The\n reason that the training job failed.\n

" + } + }, + "FinalHyperParameterTuningJobObjectiveMetric": { + "target": "com.amazonaws.sagemaker#FinalHyperParameterTuningJobObjectiveMetric", + "traits": { + "smithy.api#documentation": "

The FinalHyperParameterTuningJobObjectiveMetric object that specifies the\n value\n of the\n objective\n metric of the tuning job that launched this training job.

" + } + }, + "ObjectiveStatus": { + "target": "com.amazonaws.sagemaker#ObjectiveStatus", + "traits": { + "smithy.api#documentation": "

The status of the objective metric for the training job:

\n
    \n
  • \n

    Succeeded: The\n final\n objective metric for the training job was evaluated by the\n hyperparameter tuning job and\n used\n in the hyperparameter tuning process.

    \n
    • \n
\n
    \n
  • \n

    Pending: The training job is in progress and evaluation of its final objective\n metric is pending.

    \n
    • \n
\n
    \n
  • \n

    Failed:\n The final objective metric for the training job was not evaluated, and was not\n used in the hyperparameter tuning process. This typically occurs when the\n training job failed or did not emit an objective\n metric.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

The container for the summary information about a training job.

" + } + }, + "com.amazonaws.sagemaker#HyperParameterTuningAllocationStrategy": { + "type": "enum", + "members": { + "PRIORITIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Prioritized" + } + } + } + }, + "com.amazonaws.sagemaker#HyperParameterTuningInstanceConfig": { + "type": "structure", + "members": { + "InstanceType": { + "target": "com.amazonaws.sagemaker#TrainingInstanceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The instance type used for processing of hyperparameter optimization jobs. Choose from\n general purpose (no GPUs) instance types: ml.m5.xlarge, ml.m5.2xlarge, and ml.m5.4xlarge\n or compute optimized (no GPUs) instance types: ml.c5.xlarge and ml.c5.2xlarge. For more\n information about instance types, see instance type\n descriptions.

", + "smithy.api#required": {} + } + }, + "InstanceCount": { + "target": "com.amazonaws.sagemaker#TrainingInstanceCount", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of instances of the type specified by InstanceType. Choose an\n instance count larger than 1 for distributed training algorithms. See Step 2:\n Launch a SageMaker Distributed Training Job Using the SageMaker Python SDK for more\n information.

", + "smithy.api#required": {} + } + }, + "VolumeSizeInGB": { + "target": "com.amazonaws.sagemaker#VolumeSizeInGB", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The volume size in GB of the data to be processed for hyperparameter optimization\n (optional).

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for hyperparameter tuning resources for use in training jobs\n launched by the tuning job. These resources include compute instances and storage\n volumes. Specify one or more compute instance configurations and allocation strategies\n to select resources (optional).

" + } + }, + "com.amazonaws.sagemaker#HyperParameterTuningInstanceConfigs": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningInstanceConfig" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 6 + } + } + }, + "com.amazonaws.sagemaker#HyperParameterTuningJobArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:hyper-parameter-tuning-job/" + } + }, + "com.amazonaws.sagemaker#HyperParameterTuningJobCompletionDetails": { + "type": "structure", + "members": { + "NumberOfTrainingJobsObjectiveNotImproving": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "

The number of training jobs launched by a tuning job that are not improving (1% or\n less) as measured by model performance evaluated against an objective function.

" + } + }, + "ConvergenceDetectedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The time in timestamp format that AMT detected model convergence, as defined by a lack\n of significant improvement over time based on criteria developed over a wide range of\n diverse benchmarking tests.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains runtime information about both current and completed\n hyperparameter tuning jobs.

" + } + }, + "com.amazonaws.sagemaker#HyperParameterTuningJobConfig": { + "type": "structure", + "members": { + "Strategy": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobStrategyType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies how hyperparameter tuning chooses the combinations of hyperparameter values\n to use for the training job it launches. For information about search strategies, see\n How\n Hyperparameter Tuning Works.

", + "smithy.api#required": {} + } + }, + "StrategyConfig": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobStrategyConfig", + "traits": { + "smithy.api#documentation": "

The configuration for the Hyperband optimization strategy. This parameter\n should be provided only if Hyperband is selected as the strategy for\n HyperParameterTuningJobConfig.

" + } + }, + "HyperParameterTuningJobObjective": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobObjective", + "traits": { + "smithy.api#documentation": "

The HyperParameterTuningJobObjective specifies the objective metric used to\n evaluate the performance of training jobs launched by this tuning job.

" + } + }, + "ResourceLimits": { + "target": "com.amazonaws.sagemaker#ResourceLimits", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ResourceLimits\n object that specifies the maximum number of training and parallel training jobs that can\n be used for this hyperparameter tuning job.

", + "smithy.api#required": {} + } + }, + "ParameterRanges": { + "target": "com.amazonaws.sagemaker#ParameterRanges", + "traits": { + "smithy.api#documentation": "

The ParameterRanges\n object that specifies the ranges of hyperparameters that this tuning job searches over\n to find the optimal configuration for the highest model performance against your chosen\n objective metric.

" + } + }, + "TrainingJobEarlyStoppingType": { + "target": "com.amazonaws.sagemaker#TrainingJobEarlyStoppingType", + "traits": { + "smithy.api#documentation": "

Specifies whether to use early stopping for training jobs launched by the\n hyperparameter tuning job. Because the Hyperband strategy has its own\n advanced internal early stopping mechanism, TrainingJobEarlyStoppingType\n must be OFF to use Hyperband. This parameter can take on one\n of the following values (the default value is OFF):

\n
\n
OFF
\n
\n

Training jobs launched by the hyperparameter tuning job do not use early\n stopping.

\n
\n
AUTO
\n
\n

SageMaker stops training jobs launched by the hyperparameter tuning job when\n they are unlikely to perform better than previously completed training jobs.\n For more information, see Stop Training Jobs Early.

\n
\n
" + } + }, + "TuningJobCompletionCriteria": { + "target": "com.amazonaws.sagemaker#TuningJobCompletionCriteria", + "traits": { + "smithy.api#documentation": "

The tuning job's completion criteria.

" + } + }, + "RandomSeed": { + "target": "com.amazonaws.sagemaker#RandomSeed", + "traits": { + "smithy.api#documentation": "

A value used to initialize a pseudo-random number generator. Setting a random seed and\n using the same seed later for the same tuning job will allow hyperparameter optimization\n to find more a consistent hyperparameter configuration between the two runs.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configures a hyperparameter tuning job.

" + } + }, + "com.amazonaws.sagemaker#HyperParameterTuningJobConsumedResources": { + "type": "structure", + "members": { + "RuntimeInSeconds": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "

The wall clock runtime in seconds used by your hyperparameter tuning job.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The total resources consumed by your hyperparameter tuning job.

" + } + }, + "com.amazonaws.sagemaker#HyperParameterTuningJobName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}$" + } + }, + "com.amazonaws.sagemaker#HyperParameterTuningJobObjective": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobObjectiveType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Whether to minimize or maximize the objective metric.

", + "smithy.api#required": {} + } + }, + "MetricName": { + "target": "com.amazonaws.sagemaker#MetricName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The\n name of the metric to use for the objective metric.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines the objective metric for a hyperparameter tuning job. Hyperparameter tuning\n uses the value of this metric to evaluate the training jobs it launches, and returns the\n training job that results in either the highest or lowest value for this metric,\n depending on the value you specify for the Type parameter. If you want to\n define a custom objective metric, see Define metrics and environment variables.

" + } + }, + "com.amazonaws.sagemaker#HyperParameterTuningJobObjectiveType": { + "type": "enum", + "members": { + "MAXIMIZE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Maximize" + } + }, + "MINIMIZE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Minimize" + } + } + } + }, + "com.amazonaws.sagemaker#HyperParameterTuningJobObjectives": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobObjective" + } + }, + "com.amazonaws.sagemaker#HyperParameterTuningJobSearchEntity": { + "type": "structure", + "members": { + "HyperParameterTuningJobName": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobName", + "traits": { + "smithy.api#documentation": "

The name of a hyperparameter tuning job.

" + } + }, + "HyperParameterTuningJobArn": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a hyperparameter tuning job.

" + } + }, + "HyperParameterTuningJobConfig": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobConfig" + }, + "TrainingJobDefinition": { + "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinition" + }, + "TrainingJobDefinitions": { + "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinitions", + "traits": { + "smithy.api#documentation": "

The job definitions included in a hyperparameter tuning job.

" + } + }, + "HyperParameterTuningJobStatus": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobStatus", + "traits": { + "smithy.api#documentation": "

The status of a hyperparameter tuning job.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that a hyperparameter tuning job was created.

" + } + }, + "HyperParameterTuningEndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that a hyperparameter tuning job ended.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that a hyperparameter tuning job was last modified.

" + } + }, + "TrainingJobStatusCounters": { + "target": "com.amazonaws.sagemaker#TrainingJobStatusCounters" + }, + "ObjectiveStatusCounters": { + "target": "com.amazonaws.sagemaker#ObjectiveStatusCounters" + }, + "BestTrainingJob": { + "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobSummary" + }, + "OverallBestTrainingJob": { + "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobSummary" + }, + "WarmStartConfig": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobWarmStartConfig" + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "

The error that was created when a hyperparameter tuning job failed.

" + } + }, + "TuningJobCompletionDetails": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobCompletionDetails", + "traits": { + "smithy.api#documentation": "

Information about either a current or completed hyperparameter tuning job.

" + } + }, + "ConsumedResources": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobConsumedResources", + "traits": { + "smithy.api#documentation": "

The total amount of resources consumed by a hyperparameter tuning job.

" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

The tags associated with a hyperparameter tuning job. For more information see Tagging Amazon Web Services resources.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An entity returned by the SearchRecord API\n containing the properties of a hyperparameter tuning job.

" + } + }, + "com.amazonaws.sagemaker#HyperParameterTuningJobSortByOptions": { + "type": "enum", + "members": { + "Name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "Status": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + }, + "CreationTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + } + } + }, + "com.amazonaws.sagemaker#HyperParameterTuningJobStatus": { + "type": "enum", + "members": { + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteFailed" + } + } + } + }, + "com.amazonaws.sagemaker#HyperParameterTuningJobStrategyConfig": { + "type": "structure", + "members": { + "HyperbandStrategyConfig": { + "target": "com.amazonaws.sagemaker#HyperbandStrategyConfig", + "traits": { + "smithy.api#documentation": "

The configuration for the object that specifies the Hyperband strategy.\n This parameter is only supported for the Hyperband selection for\n Strategy within the HyperParameterTuningJobConfig API.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for a training job launched by a hyperparameter tuning job. Choose\n Bayesian for Bayesian optimization, and Random for random\n search optimization. For more advanced use cases, use Hyperband, which\n evaluates objective metrics for training jobs after every epoch. For more information about\n strategies, see How Hyperparameter\n Tuning Works.

" + } + }, + "com.amazonaws.sagemaker#HyperParameterTuningJobStrategyType": { + "type": "enum", + "members": { + "BAYESIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bayesian" + } + }, + "RANDOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Random" + } + }, + "HYPERBAND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Hyperband" + } + }, + "GRID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Grid" + } + } + }, + "traits": { + "smithy.api#documentation": "

The strategy hyperparameter tuning uses to find the best combination of\n hyperparameters for your model.

" + } + }, + "com.amazonaws.sagemaker#HyperParameterTuningJobSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobSummary" + } + }, + "com.amazonaws.sagemaker#HyperParameterTuningJobSummary": { + "type": "structure", + "members": { + "HyperParameterTuningJobName": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the tuning job.

", + "smithy.api#required": {} + } + }, + "HyperParameterTuningJobArn": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The\n Amazon\n Resource Name (ARN) of the tuning job.

", + "smithy.api#required": {} + } + }, + "HyperParameterTuningJobStatus": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of the\n tuning\n job.

", + "smithy.api#required": {} + } + }, + "Strategy": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobStrategyType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies the search strategy hyperparameter tuning uses to choose which\n hyperparameters to\n evaluate\n at each iteration.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The date and time that the tuning job was created.

", + "smithy.api#required": {} + } + }, + "HyperParameterTuningEndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the tuning job ended.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the tuning job was\n modified.

" + } + }, + "TrainingJobStatusCounters": { + "target": "com.amazonaws.sagemaker#TrainingJobStatusCounters", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The TrainingJobStatusCounters object that specifies the numbers of training\n jobs, categorized by status, that this tuning job launched.

", + "smithy.api#required": {} + } + }, + "ObjectiveStatusCounters": { + "target": "com.amazonaws.sagemaker#ObjectiveStatusCounters", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ObjectiveStatusCounters object that specifies the numbers of training jobs,\n categorized by objective metric status, that this tuning job launched.

", + "smithy.api#required": {} + } + }, + "ResourceLimits": { + "target": "com.amazonaws.sagemaker#ResourceLimits", + "traits": { + "smithy.api#documentation": "

The ResourceLimits\n object that specifies the maximum number of training jobs and parallel training jobs\n allowed for this tuning job.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides summary information about a hyperparameter tuning job.

" + } + }, + "com.amazonaws.sagemaker#HyperParameterTuningJobWarmStartConfig": { + "type": "structure", + "members": { + "ParentHyperParameterTuningJobs": { + "target": "com.amazonaws.sagemaker#ParentHyperParameterTuningJobs", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An array of hyperparameter tuning jobs that are used as the starting point for the new\n hyperparameter tuning job. For more information about warm starting a hyperparameter\n tuning job, see Using a Previous\n Hyperparameter Tuning Job as a Starting Point.

\n

Hyperparameter tuning jobs created before October 1, 2018 cannot be used as parent\n jobs for warm start tuning jobs.

", + "smithy.api#required": {} + } + }, + "WarmStartType": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobWarmStartType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies one of the following:

\n
\n
IDENTICAL_DATA_AND_ALGORITHM
\n
\n

The new hyperparameter tuning job uses the same input data and training\n image as the parent tuning jobs. You can change the hyperparameter ranges to\n search and the maximum number of training jobs that the hyperparameter\n tuning job launches. You cannot use a new version of the training algorithm,\n unless the changes in the new version do not affect the algorithm itself.\n For example, changes that improve logging or adding support for a different\n data format are allowed. You can also change hyperparameters from tunable to\n static, and from static to tunable, but the total number of static plus\n tunable hyperparameters must remain the same as it is in all parent jobs.\n The objective metric for the new tuning job must be the same as for all\n parent jobs.

\n
\n
TRANSFER_LEARNING
\n
\n

The new hyperparameter tuning job can include input data, hyperparameter\n ranges, maximum number of concurrent training jobs, and maximum number of\n training jobs that are different than those of its parent hyperparameter\n tuning jobs. The training image can also be a different version from the\n version used in the parent hyperparameter tuning job. You can also change\n hyperparameters from tunable to static, and from static to tunable, but the\n total number of static plus tunable hyperparameters must remain the same as\n it is in all parent jobs. The objective metric for the new tuning job must\n be the same as for all parent jobs.

\n
\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the configuration for a hyperparameter tuning job that uses one or more\n previous hyperparameter tuning jobs as a starting point. The results of previous tuning\n jobs are used to inform which combinations of hyperparameters to search over in the new\n tuning job.

\n

All training jobs launched by the new hyperparameter tuning job are evaluated by using\n the objective metric, and the training job that performs the best is compared to the\n best training jobs from the parent tuning jobs. From these, the training job that\n performs the best as measured by the objective metric is returned as the overall best\n training job.

\n \n

All training jobs launched by parent hyperparameter tuning jobs and the new\n hyperparameter tuning jobs count against the limit of training jobs for the tuning\n job.

\n " + } + }, + "com.amazonaws.sagemaker#HyperParameterTuningJobWarmStartType": { + "type": "enum", + "members": { + "IDENTICAL_DATA_AND_ALGORITHM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IdenticalDataAndAlgorithm" + } + }, + "TRANSFER_LEARNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TransferLearning" + } + } + } + }, + "com.amazonaws.sagemaker#HyperParameterTuningMaxRuntimeInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 120, + "max": 15768000 + } + } + }, + "com.amazonaws.sagemaker#HyperParameterTuningResourceConfig": { + "type": "structure", + "members": { + "InstanceType": { + "target": "com.amazonaws.sagemaker#TrainingInstanceType", + "traits": { + "smithy.api#documentation": "

The instance type used to run hyperparameter optimization tuning jobs. See descriptions of\n instance types for more information.

" + } + }, + "InstanceCount": { + "target": "com.amazonaws.sagemaker#TrainingInstanceCount", + "traits": { + "smithy.api#documentation": "

The number of compute instances of type InstanceType to use. For distributed training, select a value greater than 1.

" + } + }, + "VolumeSizeInGB": { + "target": "com.amazonaws.sagemaker#OptionalVolumeSizeInGB", + "traits": { + "smithy.api#documentation": "

The volume size in GB for the storage volume to be used in processing hyperparameter\n optimization jobs (optional). These volumes store model artifacts, incremental states\n and optionally, scratch space for training algorithms. Do not provide a value for this\n parameter if a value for InstanceConfigs is also specified.

\n

Some instance types have a fixed total local storage size. If you select one of these\n instances for training, VolumeSizeInGB cannot be greater than this total\n size. For a list of instance types with local instance storage and their sizes, see\n instance store volumes.

\n \n

SageMaker supports only the General Purpose SSD\n (gp2) storage volume type.

\n " + } + }, + "VolumeKmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

A key used by Amazon Web Services Key Management Service to encrypt data on the storage volume\n attached to the compute instances used to run the training job. You can use either of\n the following formats to specify a key.

\n

KMS Key ID:

\n

\n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

\n

Amazon Resource Name (ARN) of a KMS key:

\n

\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

\n

Some instances use local storage, which use a hardware module to\n encrypt storage volumes. If you choose one of these instance types, you\n cannot request a VolumeKmsKeyId. For a list of instance types that use\n local storage, see instance store\n volumes. For more information about Amazon Web Services Key Management Service, see KMS\n encryption for more information.

" + } + }, + "AllocationStrategy": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningAllocationStrategy", + "traits": { + "smithy.api#documentation": "

The strategy that determines the order of preference for resources specified in\n InstanceConfigs used in hyperparameter optimization.

" + } + }, + "InstanceConfigs": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningInstanceConfigs", + "traits": { + "smithy.api#documentation": "

A list containing the configuration(s) for one or more resources for processing\n hyperparameter jobs. These resources include compute instances and storage volumes to\n use in model training jobs launched by hyperparameter tuning jobs. The\n AllocationStrategy controls the order in which multiple configurations\n provided in InstanceConfigs are used.

\n \n

If you only want to use a single instance configuration inside the\n HyperParameterTuningResourceConfig API, do not provide a value for\n InstanceConfigs. Instead, use InstanceType,\n VolumeSizeInGB and InstanceCount. If you use\n InstanceConfigs, do not provide values for\n InstanceType, VolumeSizeInGB or\n InstanceCount.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of resources, including compute instances and storage volumes for\n use in training jobs launched by hyperparameter tuning jobs.\n HyperParameterTuningResourceConfig is similar to\n ResourceConfig, but has the additional InstanceConfigs and\n AllocationStrategy fields to allow for flexible instance management.\n Specify one or more instance types, count, and the allocation strategy for instance\n selection.

\n \n

\n HyperParameterTuningResourceConfig supports the capabilities of\n ResourceConfig with the exception of\n KeepAlivePeriodInSeconds. Hyperparameter tuning jobs use warm pools\n by default, which reuse clusters between training jobs.

\n " + } + }, + "com.amazonaws.sagemaker#HyperParameterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2500 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#HyperParameters": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#HyperParameterKey" + }, + "value": { + "target": "com.amazonaws.sagemaker#HyperParameterValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#HyperbandStrategyConfig": { + "type": "structure", + "members": { + "MinResource": { + "target": "com.amazonaws.sagemaker#HyperbandStrategyMinResource", + "traits": { + "smithy.api#documentation": "

The minimum number of resources (such as epochs) that can be used by a training job\n launched by a hyperparameter tuning job. If the value for MinResource has not\n been reached, the training job is not stopped by Hyperband.

" + } + }, + "MaxResource": { + "target": "com.amazonaws.sagemaker#HyperbandStrategyMaxResource", + "traits": { + "smithy.api#documentation": "

The maximum number of resources (such as epochs) that can be used by a training job\n launched by a hyperparameter tuning job. Once a job reaches the MaxResource\n value, it is stopped. If a value for MaxResource is not provided, and\n Hyperband is selected as the hyperparameter tuning strategy,\n HyperbandTraining attempts to infer MaxResource from the\n following keys (if present) in StaticsHyperParameters:

\n
    \n
  • \n

    \n epochs\n

    \n
    • \n
  • \n

    \n numepochs\n

    \n
    • \n
  • \n

    \n n-epochs\n

    \n
    • \n
  • \n

    \n n_epochs\n

    \n
    • \n
  • \n

    \n num_epochs\n

    \n
    • \n
\n

If HyperbandStrategyConfig is unable to infer a value for\n MaxResource, it generates a validation error. The maximum value is 20,000\n epochs. All metrics that correspond to an objective metric are used to derive early stopping\n decisions. For distributed training jobs,\n ensure that duplicate metrics are not printed in the logs across the individual nodes in a\n training job. If multiple nodes are publishing duplicate or incorrect metrics, training\n jobs may make an incorrect stopping decision and stop the job prematurely.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for Hyperband, a multi-fidelity based hyperparameter\n tuning strategy. Hyperband uses the final and intermediate results of a\n training job to dynamically allocate resources to utilized hyperparameter configurations\n while automatically stopping under-performing configurations. This parameter should be\n provided only if Hyperband is selected as the StrategyConfig\n under the HyperParameterTuningJobConfig API.

" + } + }, + "com.amazonaws.sagemaker#HyperbandStrategyMaxResource": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#HyperbandStrategyMinResource": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#IamIdentity": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM identity.

" + } + }, + "PrincipalId": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The ID of the principal that assumes the IAM identity.

" + } + }, + "SourceIdentity": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The person or application which assumes the IAM identity.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The IAM Identity details associated with the user. These details are\n associated with model package groups, model packages and project entities only.

" + } + }, + "com.amazonaws.sagemaker#IamPolicyConstraints": { + "type": "structure", + "members": { + "SourceIp": { + "target": "com.amazonaws.sagemaker#EnabledOrDisabled", + "traits": { + "smithy.api#documentation": "

When SourceIp is Enabled the worker's IP address when a task is rendered in the worker portal is added to the IAM policy as a Condition used to generate the Amazon S3 presigned URL. This IP address is checked by Amazon S3 and must match in order for the Amazon S3 resource to be rendered in the worker portal.

" + } + }, + "VpcSourceIp": { + "target": "com.amazonaws.sagemaker#EnabledOrDisabled", + "traits": { + "smithy.api#documentation": "

When VpcSourceIp is Enabled the worker's IP address when a task is rendered in private worker portal inside the VPC is added to the IAM policy as a Condition used to generate the Amazon S3 presigned URL. To render the task successfully Amazon S3 checks that the presigned URL is being accessed over an Amazon S3 VPC Endpoint, and that the worker's IP address matches the IP address in the IAM policy. To learn more about configuring private worker portal, see Use Amazon VPC mode from a private worker portal.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Use this parameter to specify a supported global condition key that is added to the IAM policy.

" + } + }, + "com.amazonaws.sagemaker#IdempotencyToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 32, + "max": 128 + } + } + }, + "com.amazonaws.sagemaker#IdentityProviderOAuthSetting": { + "type": "structure", + "members": { + "DataSourceName": { + "target": "com.amazonaws.sagemaker#DataSourceName", + "traits": { + "smithy.api#documentation": "

The name of the data source that you're connecting to. Canvas currently supports OAuth for Snowflake and Salesforce Data Cloud.

" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#FeatureStatus", + "traits": { + "smithy.api#documentation": "

Describes whether OAuth for a data source is enabled or disabled in the Canvas\n application.

" + } + }, + "SecretArn": { + "target": "com.amazonaws.sagemaker#SecretArn", + "traits": { + "smithy.api#documentation": "

The ARN of an Amazon Web Services Secrets Manager secret that stores the credentials from your\n identity provider, such as the client ID and secret, authorization URL, and token URL.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon SageMaker Canvas application setting where you configure OAuth for connecting to an external\n data source, such as Snowflake.

" + } + }, + "com.amazonaws.sagemaker#IdentityProviderOAuthSettings": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#IdentityProviderOAuthSetting" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.sagemaker#IdleSettings": { + "type": "structure", + "members": { + "LifecycleManagement": { + "target": "com.amazonaws.sagemaker#LifecycleManagement", + "traits": { + "smithy.api#documentation": "

Indicates whether idle shutdown is activated for the application type.

" + } + }, + "IdleTimeoutInMinutes": { + "target": "com.amazonaws.sagemaker#IdleTimeoutInMinutes", + "traits": { + "smithy.api#documentation": "

The time that SageMaker waits after the application becomes idle before shutting it\n down.

" + } + }, + "MinIdleTimeoutInMinutes": { + "target": "com.amazonaws.sagemaker#IdleTimeoutInMinutes", + "traits": { + "smithy.api#documentation": "

The minimum value in minutes that custom idle shutdown can be set to by the user.

" + } + }, + "MaxIdleTimeoutInMinutes": { + "target": "com.amazonaws.sagemaker#IdleTimeoutInMinutes", + "traits": { + "smithy.api#documentation": "

The maximum value in minutes that custom idle shutdown can be set to by the user.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Settings related to idle shutdown of Studio applications.

" + } + }, + "com.amazonaws.sagemaker#IdleTimeoutInMinutes": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 60, + "max": 525600 + } + } + }, + "com.amazonaws.sagemaker#Image": { + "type": "structure", + "members": { + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

When the image was created.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#ImageDescription", + "traits": { + "smithy.api#documentation": "

The description of the image.

" + } + }, + "DisplayName": { + "target": "com.amazonaws.sagemaker#ImageDisplayName", + "traits": { + "smithy.api#documentation": "

The name of the image as displayed.

" + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "

When a create, update, or delete operation fails, the reason for the failure.

" + } + }, + "ImageArn": { + "target": "com.amazonaws.sagemaker#ImageArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the image.

", + "smithy.api#required": {} + } + }, + "ImageName": { + "target": "com.amazonaws.sagemaker#ImageName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the image.

", + "smithy.api#required": {} + } + }, + "ImageStatus": { + "target": "com.amazonaws.sagemaker#ImageStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of the image.

", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

When the image was last modified.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A SageMaker AI image. A SageMaker AI image represents a set of container images that are derived from\n a common base container image. Each of these container images is represented by a SageMaker AI\n ImageVersion.

" + } + }, + "com.amazonaws.sagemaker#ImageArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-zA-Z0-9]([-.]?[a-zA-Z0-9])*$" + } + }, + "com.amazonaws.sagemaker#ImageBaseImage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#ImageClassificationJobConfig": { + "type": "structure", + "members": { + "CompletionCriteria": { + "target": "com.amazonaws.sagemaker#AutoMLJobCompletionCriteria", + "traits": { + "smithy.api#documentation": "

How long a job is allowed to run, or how many candidates a job is allowed to\n generate.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The collection of settings used by an AutoML job V2 for the image classification problem\n type.

" + } + }, + "com.amazonaws.sagemaker#ImageConfig": { + "type": "structure", + "members": { + "RepositoryAccessMode": { + "target": "com.amazonaws.sagemaker#RepositoryAccessMode", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Set this to one of the following values:

\n
    \n
  • \n

    \n Platform - The model image is hosted in Amazon ECR.

    \n
    • \n
  • \n

    \n Vpc - The model image is hosted in a private Docker registry in\n your VPC.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "RepositoryAuthConfig": { + "target": "com.amazonaws.sagemaker#RepositoryAuthConfig", + "traits": { + "smithy.api#documentation": "

(Optional) Specifies an authentication configuration for the private docker registry\n where your model image is hosted. Specify a value for this property only if you\n specified Vpc as the value for the RepositoryAccessMode field,\n and the private Docker registry where the model image is hosted requires\n authentication.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies whether the model container is in Amazon ECR or a private Docker registry\n accessible from your Amazon Virtual Private Cloud (VPC).

" + } + }, + "com.amazonaws.sagemaker#ImageContainerImage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.sagemaker#ImageDeleteProperty": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 11 + }, + "smithy.api#pattern": "^(^DisplayName$)|(^Description$)$" + } + }, + "com.amazonaws.sagemaker#ImageDeletePropertyList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ImageDeleteProperty" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2 + } + } + }, + "com.amazonaws.sagemaker#ImageDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#ImageDigest": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 72 + }, + "smithy.api#pattern": "^[Ss][Hh][Aa]256:[0-9a-fA-F]{64}$" + } + }, + "com.amazonaws.sagemaker#ImageDisplayName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^\\S(.*\\S)?$" + } + }, + "com.amazonaws.sagemaker#ImageName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#ImageNameContains": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\-.]+$" + } + }, + "com.amazonaws.sagemaker#ImageSortBy": { + "type": "enum", + "members": { + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_TIME" + } + }, + "LAST_MODIFIED_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAST_MODIFIED_TIME" + } + }, + "IMAGE_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMAGE_NAME" + } + } + } + }, + "com.amazonaws.sagemaker#ImageSortOrder": { + "type": "enum", + "members": { + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASCENDING" + } + }, + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DESCENDING" + } + } + } + }, + "com.amazonaws.sagemaker#ImageStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATED" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + } + } + }, + "com.amazonaws.sagemaker#ImageUri": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#ImageVersion": { + "type": "structure", + "members": { + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

When the version was created.

", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "

When a create or delete operation fails, the reason for the failure.

" + } + }, + "ImageArn": { + "target": "com.amazonaws.sagemaker#ImageArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the image the version is based on.

", + "smithy.api#required": {} + } + }, + "ImageVersionArn": { + "target": "com.amazonaws.sagemaker#ImageVersionArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the version.

", + "smithy.api#required": {} + } + }, + "ImageVersionStatus": { + "target": "com.amazonaws.sagemaker#ImageVersionStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of the version.

", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

When the version was last modified.

", + "smithy.api#required": {} + } + }, + "Version": { + "target": "com.amazonaws.sagemaker#ImageVersionNumber", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The version number.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A version of a SageMaker AI Image. A version represents an existing container\n image.

" + } + }, + "com.amazonaws.sagemaker#ImageVersionAlias": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(^\\d+$)|(^\\d+.\\d+$)|(^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$)$" + } + }, + "com.amazonaws.sagemaker#ImageVersionAliasPattern": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$" + } + }, + "com.amazonaws.sagemaker#ImageVersionArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^(arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])*/[0-9]+|None)$" + } + }, + "com.amazonaws.sagemaker#ImageVersionNumber": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.sagemaker#ImageVersionSortBy": { + "type": "enum", + "members": { + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_TIME" + } + }, + "LAST_MODIFIED_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAST_MODIFIED_TIME" + } + }, + "VERSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VERSION" + } + } + } + }, + "com.amazonaws.sagemaker#ImageVersionSortOrder": { + "type": "enum", + "members": { + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASCENDING" + } + }, + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DESCENDING" + } + } + } + }, + "com.amazonaws.sagemaker#ImageVersionStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATED" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + } + } + }, + "com.amazonaws.sagemaker#ImageVersions": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ImageVersion" + } + }, + "com.amazonaws.sagemaker#Images": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#Image" + } + }, + "com.amazonaws.sagemaker#ImportHubContent": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ImportHubContentRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ImportHubContentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Import hub content.

" + } + }, + "com.amazonaws.sagemaker#ImportHubContentRequest": { + "type": "structure", + "members": { + "HubContentName": { + "target": "com.amazonaws.sagemaker#HubContentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the hub content to import.

", + "smithy.api#required": {} + } + }, + "HubContentVersion": { + "target": "com.amazonaws.sagemaker#HubContentVersion", + "traits": { + "smithy.api#documentation": "

The version of the hub content to import.

" + } + }, + "HubContentType": { + "target": "com.amazonaws.sagemaker#HubContentType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of hub content to import.

", + "smithy.api#required": {} + } + }, + "DocumentSchemaVersion": { + "target": "com.amazonaws.sagemaker#DocumentSchemaVersion", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The version of the hub content schema to import.

", + "smithy.api#required": {} + } + }, + "HubName": { + "target": "com.amazonaws.sagemaker#HubNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the hub to import content into.

", + "smithy.api#required": {} + } + }, + "HubContentDisplayName": { + "target": "com.amazonaws.sagemaker#HubContentDisplayName", + "traits": { + "smithy.api#documentation": "

The display name of the hub content to import.

" + } + }, + "HubContentDescription": { + "target": "com.amazonaws.sagemaker#HubContentDescription", + "traits": { + "smithy.api#documentation": "

A description of the hub content to import.

" + } + }, + "HubContentMarkdown": { + "target": "com.amazonaws.sagemaker#HubContentMarkdown", + "traits": { + "smithy.api#documentation": "

A string that provides a description of the hub content. This string can include links, tables, and standard markdown formating.

" + } + }, + "HubContentDocument": { + "target": "com.amazonaws.sagemaker#HubContentDocument", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The hub content document that describes information about the hub content such as type, associated containers, scripts, and more.

", + "smithy.api#required": {} + } + }, + "HubContentSearchKeywords": { + "target": "com.amazonaws.sagemaker#HubContentSearchKeywordList", + "traits": { + "smithy.api#documentation": "

The searchable keywords of the hub content.

" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

Any tags associated with the hub content.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ImportHubContentResponse": { + "type": "structure", + "members": { + "HubArn": { + "target": "com.amazonaws.sagemaker#HubArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the hub that the content was imported into.

", + "smithy.api#required": {} + } + }, + "HubContentArn": { + "target": "com.amazonaws.sagemaker#HubContentArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the hub content that was imported.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#InUseInstanceCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.sagemaker#InferenceComponentArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + } + } + }, + "com.amazonaws.sagemaker#InferenceComponentComputeResourceRequirements": { + "type": "structure", + "members": { + "NumberOfCpuCoresRequired": { + "target": "com.amazonaws.sagemaker#NumberOfCpuCores", + "traits": { + "smithy.api#documentation": "

The number of CPU cores to allocate to run a model that you assign to an inference\n component.

" + } + }, + "NumberOfAcceleratorDevicesRequired": { + "target": "com.amazonaws.sagemaker#NumberOfAcceleratorDevices", + "traits": { + "smithy.api#documentation": "

The number of accelerators to allocate to run a model that you assign to an inference\n component. Accelerators include GPUs and Amazon Web Services Inferentia.

" + } + }, + "MinMemoryRequiredInMb": { + "target": "com.amazonaws.sagemaker#MemoryInMb", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The minimum MB of memory to allocate to run a model that you assign to an inference\n component.

", + "smithy.api#required": {} + } + }, + "MaxMemoryRequiredInMb": { + "target": "com.amazonaws.sagemaker#MemoryInMb", + "traits": { + "smithy.api#documentation": "

The maximum MB of memory to allocate to run a model that you assign to an inference\n component.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines the compute resources to allocate to run a model, plus any adapter models, that\n you assign to an inference component. These resources include CPU cores, accelerators, and\n memory.

" + } + }, + "com.amazonaws.sagemaker#InferenceComponentContainerSpecification": { + "type": "structure", + "members": { + "Image": { + "target": "com.amazonaws.sagemaker#ContainerImage", + "traits": { + "smithy.api#documentation": "

The Amazon Elastic Container Registry (Amazon ECR) path where the Docker image for the model is stored.

" + } + }, + "ArtifactUrl": { + "target": "com.amazonaws.sagemaker#Url", + "traits": { + "smithy.api#documentation": "

The Amazon S3 path where the model artifacts, which result from model training,\n are stored. This path must point to a single gzip compressed tar archive (.tar.gz\n suffix).

" + } + }, + "Environment": { + "target": "com.amazonaws.sagemaker#EnvironmentMap", + "traits": { + "smithy.api#documentation": "

The environment variables to set in the Docker container. Each key and value in the\n Environment string-to-string map can have length of up to 1024. We support up to 16 entries\n in the map.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines a container that provides the runtime environment for a model that you deploy\n with an inference component.

" + } + }, + "com.amazonaws.sagemaker#InferenceComponentContainerSpecificationSummary": { + "type": "structure", + "members": { + "DeployedImage": { + "target": "com.amazonaws.sagemaker#DeployedImage" + }, + "ArtifactUrl": { + "target": "com.amazonaws.sagemaker#Url", + "traits": { + "smithy.api#documentation": "

The Amazon S3 path where the model artifacts are stored.

" + } + }, + "Environment": { + "target": "com.amazonaws.sagemaker#EnvironmentMap", + "traits": { + "smithy.api#documentation": "

The environment variables to set in the Docker container.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the resources that are deployed with this inference component.

" + } + }, + "com.amazonaws.sagemaker#InferenceComponentCopyCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.sagemaker#InferenceComponentName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]([\\-a-zA-Z0-9]*[a-zA-Z0-9])?$" + } + }, + "com.amazonaws.sagemaker#InferenceComponentNameContains": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.sagemaker#InferenceComponentRuntimeConfig": { + "type": "structure", + "members": { + "CopyCount": { + "target": "com.amazonaws.sagemaker#InferenceComponentCopyCount", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of runtime copies of the model container to deploy with the inference\n component. Each copy can serve inference requests.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Runtime settings for a model that is deployed with an inference component.

" + } + }, + "com.amazonaws.sagemaker#InferenceComponentRuntimeConfigSummary": { + "type": "structure", + "members": { + "DesiredCopyCount": { + "target": "com.amazonaws.sagemaker#InferenceComponentCopyCount", + "traits": { + "smithy.api#documentation": "

The number of runtime copies of the model container that you requested to deploy with\n the inference component.

" + } + }, + "CurrentCopyCount": { + "target": "com.amazonaws.sagemaker#InferenceComponentCopyCount", + "traits": { + "smithy.api#documentation": "

The number of runtime copies of the model container that are currently deployed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the runtime settings for the model that is deployed with the inference\n component.

" + } + }, + "com.amazonaws.sagemaker#InferenceComponentSortKey": { + "type": "enum", + "members": { + "Name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CreationTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "Status": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + } + } + }, + "com.amazonaws.sagemaker#InferenceComponentSpecification": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.sagemaker#ModelName", + "traits": { + "smithy.api#documentation": "

The name of an existing SageMaker AI model object in your account that you want to\n deploy with the inference component.

" + } + }, + "Container": { + "target": "com.amazonaws.sagemaker#InferenceComponentContainerSpecification", + "traits": { + "smithy.api#documentation": "

Defines a container that provides the runtime environment for a model that you deploy\n with an inference component.

" + } + }, + "StartupParameters": { + "target": "com.amazonaws.sagemaker#InferenceComponentStartupParameters", + "traits": { + "smithy.api#documentation": "

Settings that take effect while the model container starts up.

" + } + }, + "ComputeResourceRequirements": { + "target": "com.amazonaws.sagemaker#InferenceComponentComputeResourceRequirements", + "traits": { + "smithy.api#documentation": "

The compute resources allocated to run the model, plus any \n adapter models, that you assign to the inference component.

\n

Omit this parameter if your request is meant to create an adapter inference component.\n An adapter inference component is loaded by a base inference component, and it uses the\n compute resources of the base inference component.

" + } + }, + "BaseInferenceComponentName": { + "target": "com.amazonaws.sagemaker#InferenceComponentName", + "traits": { + "smithy.api#documentation": "

The name of an existing inference component that is to contain the inference component\n that you're creating with your request.

\n

Specify this parameter only if your request is meant to create an adapter inference\n component. An adapter inference component contains the path to an adapter model. The\n purpose of the adapter model is to tailor the inference output of a base foundation model,\n which is hosted by the base inference component. The adapter inference component uses the\n compute resources that you assigned to the base inference component.

\n

When you create an adapter inference component, use the Container parameter\n to specify the location of the adapter artifacts. In the parameter value, use the\n ArtifactUrl parameter of the\n InferenceComponentContainerSpecification data type.

\n

Before you can create an adapter inference component, you must have an existing\n inference component that contains the foundation model that you want to adapt.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the resources to deploy with this inference component, including the\n model, container, and compute resources.

" + } + }, + "com.amazonaws.sagemaker#InferenceComponentSpecificationSummary": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.sagemaker#ModelName", + "traits": { + "smithy.api#documentation": "

The name of the SageMaker AI model object that is deployed with the inference\n component.

" + } + }, + "Container": { + "target": "com.amazonaws.sagemaker#InferenceComponentContainerSpecificationSummary", + "traits": { + "smithy.api#documentation": "

Details about the container that provides the runtime environment for the model that is\n deployed with the inference component.

" + } + }, + "StartupParameters": { + "target": "com.amazonaws.sagemaker#InferenceComponentStartupParameters", + "traits": { + "smithy.api#documentation": "

Settings that take effect while the model container starts up.

" + } + }, + "ComputeResourceRequirements": { + "target": "com.amazonaws.sagemaker#InferenceComponentComputeResourceRequirements", + "traits": { + "smithy.api#documentation": "

The compute resources allocated to run the model, plus any \n adapter models, that you assign to the inference component.

" + } + }, + "BaseInferenceComponentName": { + "target": "com.amazonaws.sagemaker#InferenceComponentName", + "traits": { + "smithy.api#documentation": "

The name of the base inference component that contains this inference component.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the resources that are deployed with this inference component.

" + } + }, + "com.amazonaws.sagemaker#InferenceComponentStartupParameters": { + "type": "structure", + "members": { + "ModelDataDownloadTimeoutInSeconds": { + "target": "com.amazonaws.sagemaker#ProductionVariantModelDataDownloadTimeoutInSeconds", + "traits": { + "smithy.api#documentation": "

The timeout value, in seconds, to download and extract the model that you want to host\n from Amazon S3 to the individual inference instance associated with this inference\n component.

" + } + }, + "ContainerStartupHealthCheckTimeoutInSeconds": { + "target": "com.amazonaws.sagemaker#ProductionVariantContainerStartupHealthCheckTimeoutInSeconds", + "traits": { + "smithy.api#documentation": "

The timeout value, in seconds, for your inference container to pass health check by\n Amazon S3 Hosting. For more information about health check, see How Your Container Should Respond to Health Check (Ping) Requests.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Settings that take effect while the model container starts up.

" + } + }, + "com.amazonaws.sagemaker#InferenceComponentStatus": { + "type": "enum", + "members": { + "IN_SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InService" + } + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Creating" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + } + } + }, + "com.amazonaws.sagemaker#InferenceComponentSummary": { + "type": "structure", + "members": { + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The time when the inference component was created.

", + "smithy.api#required": {} + } + }, + "InferenceComponentArn": { + "target": "com.amazonaws.sagemaker#InferenceComponentArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the inference component.

", + "smithy.api#required": {} + } + }, + "InferenceComponentName": { + "target": "com.amazonaws.sagemaker#InferenceComponentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the inference component.

", + "smithy.api#required": {} + } + }, + "EndpointArn": { + "target": "com.amazonaws.sagemaker#EndpointArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.

", + "smithy.api#required": {} + } + }, + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the endpoint that hosts the inference component.

", + "smithy.api#required": {} + } + }, + "VariantName": { + "target": "com.amazonaws.sagemaker#VariantName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the production variant that hosts the inference component.

", + "smithy.api#required": {} + } + }, + "InferenceComponentStatus": { + "target": "com.amazonaws.sagemaker#InferenceComponentStatus", + "traits": { + "smithy.api#documentation": "

The status of the inference component.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The time when the inference component was last updated.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A summary of the properties of an inference component.

" + } + }, + "com.amazonaws.sagemaker#InferenceComponentSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#InferenceComponentSummary" + } + }, + "com.amazonaws.sagemaker#InferenceExecutionConfig": { + "type": "structure", + "members": { + "Mode": { + "target": "com.amazonaws.sagemaker#InferenceExecutionMode", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

How containers in a multi-container are run. The following values are valid.

\n
    \n
  • \n

    \n SERIAL - Containers run as a serial pipeline.

    \n
    • \n
  • \n

    \n DIRECT - Only the individual container that you specify is\n run.

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies details about how containers in a multi-container endpoint are run.

" + } + }, + "com.amazonaws.sagemaker#InferenceExecutionMode": { + "type": "enum", + "members": { + "SERIAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Serial" + } + }, + "DIRECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Direct" + } + } + } + }, + "com.amazonaws.sagemaker#InferenceExperimentArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:inference-experiment/" + } + }, + "com.amazonaws.sagemaker#InferenceExperimentDataStorageConfig": { + "type": "structure", + "members": { + "Destination": { + "target": "com.amazonaws.sagemaker#DestinationS3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon S3 bucket where the inference request and response data is stored.

", + "smithy.api#required": {} + } + }, + "KmsKey": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

\n The Amazon Web Services Key Management Service key that Amazon SageMaker uses to encrypt captured data at rest using Amazon S3\n server-side encryption.\n

" + } + }, + "ContentType": { + "target": "com.amazonaws.sagemaker#CaptureContentTypeHeader" + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon S3 location and configuration for storing inference request and response data.

" + } + }, + "com.amazonaws.sagemaker#InferenceExperimentDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#InferenceExperimentList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#InferenceExperimentSummary" + } + }, + "com.amazonaws.sagemaker#InferenceExperimentName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 120 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}$" + } + }, + "com.amazonaws.sagemaker#InferenceExperimentSchedule": { + "type": "structure", + "members": { + "StartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp at which the inference experiment started or will start.

" + } + }, + "EndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp at which the inference experiment ended or will end.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The start and end times of an inference experiment.

\n

The maximum duration that you can set for an inference experiment is 30 days.

" + } + }, + "com.amazonaws.sagemaker#InferenceExperimentStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Creating" + } + }, + "CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Created" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Running" + } + }, + "STARTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Starting" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Cancelled" + } + } + } + }, + "com.amazonaws.sagemaker#InferenceExperimentStatusReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#InferenceExperimentStopDesiredState": { + "type": "enum", + "members": { + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Cancelled" + } + } + } + }, + "com.amazonaws.sagemaker#InferenceExperimentSummary": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#InferenceExperimentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the inference experiment.

", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.sagemaker#InferenceExperimentType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of the inference experiment.

", + "smithy.api#required": {} + } + }, + "Schedule": { + "target": "com.amazonaws.sagemaker#InferenceExperimentSchedule", + "traits": { + "smithy.api#documentation": "

The duration for which the inference experiment ran or will run.

\n

The maximum duration that you can set for an inference experiment is 30 days.

" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#InferenceExperimentStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of the inference experiment.

", + "smithy.api#required": {} + } + }, + "StatusReason": { + "target": "com.amazonaws.sagemaker#InferenceExperimentStatusReason", + "traits": { + "smithy.api#documentation": "

The error message for the inference experiment status result.

" + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#InferenceExperimentDescription", + "traits": { + "smithy.api#documentation": "

The description of the inference experiment.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The timestamp at which the inference experiment was created.

", + "smithy.api#required": {} + } + }, + "CompletionTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp at which the inference experiment was completed.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The timestamp when you last modified the inference experiment.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "

\n The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage\n Amazon SageMaker Inference endpoints for model deployment.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Lists a summary of properties of an inference experiment.

" + } + }, + "com.amazonaws.sagemaker#InferenceExperimentType": { + "type": "enum", + "members": { + "SHADOW_MODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ShadowMode" + } + } + } + }, + "com.amazonaws.sagemaker#InferenceHubAccessConfig": { + "type": "structure", + "members": { + "HubContentArn": { + "target": "com.amazonaws.sagemaker#HubContentArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the hub content for which deployment access is allowed.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration information specifying which hub contents have accessible deployment options.

" + } + }, + "com.amazonaws.sagemaker#InferenceImage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.sagemaker#InferenceMetrics": { + "type": "structure", + "members": { + "MaxInvocations": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The expected maximum number of requests per minute for the instance.

", + "smithy.api#required": {} + } + }, + "ModelLatency": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The expected model latency at maximum invocations per minute for the instance.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The metrics for an existing endpoint compared in an Inference Recommender job.

" + } + }, + "com.amazonaws.sagemaker#InferenceRecommendation": { + "type": "structure", + "members": { + "RecommendationId": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The recommendation ID which uniquely identifies each recommendation.

" + } + }, + "Metrics": { + "target": "com.amazonaws.sagemaker#RecommendationMetrics", + "traits": { + "smithy.api#documentation": "

The metrics used to decide what recommendation to make.

" + } + }, + "EndpointConfiguration": { + "target": "com.amazonaws.sagemaker#EndpointOutputConfiguration", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Defines the endpoint configuration parameters.

", + "smithy.api#required": {} + } + }, + "ModelConfiguration": { + "target": "com.amazonaws.sagemaker#ModelConfiguration", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Defines the model configuration.

", + "smithy.api#required": {} + } + }, + "InvocationEndTime": { + "target": "com.amazonaws.sagemaker#InvocationEndTime", + "traits": { + "smithy.api#documentation": "

A timestamp that shows when the benchmark completed.

" + } + }, + "InvocationStartTime": { + "target": "com.amazonaws.sagemaker#InvocationStartTime", + "traits": { + "smithy.api#documentation": "

A timestamp that shows when the benchmark started.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of recommendations made by Amazon SageMaker Inference Recommender.

" + } + }, + "com.amazonaws.sagemaker#InferenceRecommendations": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#InferenceRecommendation" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.sagemaker#InferenceRecommendationsJob": { + "type": "structure", + "members": { + "JobName": { + "target": "com.amazonaws.sagemaker#RecommendationJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the job.

", + "smithy.api#required": {} + } + }, + "JobDescription": { + "target": "com.amazonaws.sagemaker#RecommendationJobDescription", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The job description.

", + "smithy.api#required": {} + } + }, + "JobType": { + "target": "com.amazonaws.sagemaker#RecommendationJobType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The recommendation job type.

", + "smithy.api#required": {} + } + }, + "JobArn": { + "target": "com.amazonaws.sagemaker#RecommendationJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recommendation job.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#RecommendationJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of the job.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A timestamp that shows when the job was created.

", + "smithy.api#required": {} + } + }, + "CompletionTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A timestamp that shows when the job completed.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker \n to perform tasks on your behalf.

", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A timestamp that shows when the job was last modified.

", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "

If the job fails, provides information why the job failed.

" + } + }, + "ModelName": { + "target": "com.amazonaws.sagemaker#ModelName", + "traits": { + "smithy.api#documentation": "

The name of the created model.

" + } + }, + "SamplePayloadUrl": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "

The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored.\n This path must point to a single gzip compressed tar archive (.tar.gz suffix).

" + } + }, + "ModelPackageVersionArn": { + "target": "com.amazonaws.sagemaker#ModelPackageArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a versioned model package.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains a list of recommendation jobs.

" + } + }, + "com.amazonaws.sagemaker#InferenceRecommendationsJobStep": { + "type": "structure", + "members": { + "StepType": { + "target": "com.amazonaws.sagemaker#RecommendationStepType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of the subtask.

\n

\n BENCHMARK: Evaluate the performance of your model on different instance types.

", + "smithy.api#required": {} + } + }, + "JobName": { + "target": "com.amazonaws.sagemaker#RecommendationJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Inference Recommender job.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#RecommendationJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The current status of the benchmark.

", + "smithy.api#required": {} + } + }, + "InferenceBenchmark": { + "target": "com.amazonaws.sagemaker#RecommendationJobInferenceBenchmark", + "traits": { + "smithy.api#documentation": "

The details for a specific benchmark.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A returned array object for the Steps response field in the\n ListInferenceRecommendationsJobSteps API command.

" + } + }, + "com.amazonaws.sagemaker#InferenceRecommendationsJobSteps": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#InferenceRecommendationsJobStep" + } + }, + "com.amazonaws.sagemaker#InferenceRecommendationsJobs": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#InferenceRecommendationsJob" + } + }, + "com.amazonaws.sagemaker#InferenceSpecification": { + "type": "structure", + "members": { + "Containers": { + "target": "com.amazonaws.sagemaker#ModelPackageContainerDefinitionList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon ECR registry path of the Docker image that contains the inference code.

", + "smithy.api#required": {} + } + }, + "SupportedTransformInstanceTypes": { + "target": "com.amazonaws.sagemaker#TransformInstanceTypes", + "traits": { + "smithy.api#documentation": "

A list of the instance types on which a transformation job can be run or on which an\n endpoint can be deployed.

\n

This parameter is required for unversioned models, and optional for versioned\n models.

" + } + }, + "SupportedRealtimeInferenceInstanceTypes": { + "target": "com.amazonaws.sagemaker#RealtimeInferenceInstanceTypes", + "traits": { + "smithy.api#documentation": "

A list of the instance types that are used to generate inferences in real-time.

\n

This parameter is required for unversioned models, and optional for versioned\n models.

" + } + }, + "SupportedContentTypes": { + "target": "com.amazonaws.sagemaker#ContentTypes", + "traits": { + "smithy.api#documentation": "

The supported MIME types for the input data.

" + } + }, + "SupportedResponseMIMETypes": { + "target": "com.amazonaws.sagemaker#ResponseMIMETypes", + "traits": { + "smithy.api#documentation": "

The supported MIME types for the output data.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines how to perform inference generation after a training job is run.

" + } + }, + "com.amazonaws.sagemaker#InferenceSpecificationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#InfraCheckConfig": { + "type": "structure", + "members": { + "EnableInfraCheck": { + "target": "com.amazonaws.sagemaker#EnableInfraCheck", + "traits": { + "smithy.api#documentation": "

Enables an infrastructure health check.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration information for the infrastructure health check of a training job. A SageMaker-provided health check tests the health of instance hardware and cluster network \n connectivity.

" + } + }, + "com.amazonaws.sagemaker#InitialInstanceCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#InitialNumberOfUsers": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#InitialTaskCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#InputConfig": { + "type": "structure", + "members": { + "S3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The S3 path where the model artifacts, which result from model training, are stored.\n This path must point to a single gzip compressed tar archive (.tar.gz suffix).

", + "smithy.api#required": {} + } + }, + "DataInputConfig": { + "target": "com.amazonaws.sagemaker#DataInputConfig", + "traits": { + "smithy.api#documentation": "

Specifies the name and shape of the expected data inputs for your trained model with a\n JSON dictionary form. The data inputs are Framework specific.

\n
    \n
  • \n

    \n TensorFlow: You must specify the name and shape (NHWC format) of\n the expected data inputs using a dictionary format for your trained model. The\n dictionary formats required for the console and CLI are different.

    \n
      \n
    • \n

      Examples for one input:

      \n
        \n
      • \n

        If using the console,\n {\"input\":[1,1024,1024,3]}\n

        \n
        • \n
      • \n

        If using the CLI,\n {\\\"input\\\":[1,1024,1024,3]}\n

        \n
        • \n
      \n
      • \n
    • \n

      Examples for two inputs:

      \n
        \n
      • \n

        If using the console, {\"data1\": [1,28,28,1],\n \"data2\":[1,28,28,1]}\n

        \n
        • \n
      • \n

        If using the CLI, {\\\"data1\\\": [1,28,28,1],\n \\\"data2\\\":[1,28,28,1]}\n

        \n
        • \n
      \n
      • \n
    \n
    • \n
  • \n

    \n KERAS: You must specify the name and shape (NCHW format) of\n expected data inputs using a dictionary format for your trained model. Note that\n while Keras model artifacts should be uploaded in NHWC (channel-last) format,\n DataInputConfig should be specified in NCHW (channel-first)\n format. The dictionary formats required for the console and CLI are\n different.

    \n
      \n
    • \n

      Examples for one input:

      \n
        \n
      • \n

        If using the console,\n {\"input_1\":[1,3,224,224]}\n

        \n
        • \n
      • \n

        If using the CLI,\n {\\\"input_1\\\":[1,3,224,224]}\n

        \n
        • \n
      \n
      • \n
    • \n

      Examples for two inputs:

      \n
        \n
      • \n

        If using the console, {\"input_1\": [1,3,224,224],\n \"input_2\":[1,3,224,224]} \n

        \n
        • \n
      • \n

        If using the CLI, {\\\"input_1\\\": [1,3,224,224],\n \\\"input_2\\\":[1,3,224,224]}\n

        \n
        • \n
      \n
      • \n
    \n
    • \n
  • \n

    \n MXNET/ONNX/DARKNET: You must specify the name and shape (NCHW\n format) of the expected data inputs in order using a dictionary format for your\n trained model. The dictionary formats required for the console and CLI are\n different.

    \n
      \n
    • \n

      Examples for one input:

      \n
        \n
      • \n

        If using the console,\n {\"data\":[1,3,1024,1024]}\n

        \n
        • \n
      • \n

        If using the CLI,\n {\\\"data\\\":[1,3,1024,1024]}\n

        \n
        • \n
      \n
      • \n
    • \n

      Examples for two inputs:

      \n
        \n
      • \n

        If using the console, {\"var1\": [1,1,28,28],\n \"var2\":[1,1,28,28]} \n

        \n
        • \n
      • \n

        If using the CLI, {\\\"var1\\\": [1,1,28,28],\n \\\"var2\\\":[1,1,28,28]}\n

        \n
        • \n
      \n
      • \n
    \n
    • \n
  • \n

    \n PyTorch: You can either specify the name and shape (NCHW format)\n of expected data inputs in order using a dictionary format for your trained\n model or you can specify the shape only using a list format. The dictionary\n formats required for the console and CLI are different. The list formats for the\n console and CLI are the same.

    \n
      \n
    • \n

      Examples for one input in dictionary format:

      \n
        \n
      • \n

        If using the console,\n {\"input0\":[1,3,224,224]}\n

        \n
        • \n
      • \n

        If using the CLI,\n {\\\"input0\\\":[1,3,224,224]}\n

        \n
        • \n
      \n
      • \n
    • \n

      Example for one input in list format:\n [[1,3,224,224]]\n

      \n
      • \n
    • \n

      Examples for two inputs in dictionary format:

      \n
        \n
      • \n

        If using the console, {\"input0\":[1,3,224,224],\n \"input1\":[1,3,224,224]}\n

        \n
        • \n
      • \n

        If using the CLI, {\\\"input0\\\":[1,3,224,224],\n \\\"input1\\\":[1,3,224,224]} \n

        \n
        • \n
      \n
      • \n
    • \n

      Example for two inputs in list format: [[1,3,224,224],\n [1,3,224,224]]\n

      \n
      • \n
    \n
    • \n
  • \n

    \n XGBOOST: input data name and shape are not needed.

    \n
    • \n
\n

\n DataInputConfig supports the following parameters for CoreML\n TargetDevice (ML Model format):

\n
    \n
  • \n

    \n shape: Input shape, for example {\"input_1\": {\"shape\":\n [1,224,224,3]}}. In addition to static input shapes, CoreML converter\n supports Flexible input shapes:

    \n
      \n
    • \n

      Range Dimension. You can use the Range Dimension feature if you know\n the input shape will be within some specific interval in that dimension,\n for example: {\"input_1\": {\"shape\": [\"1..10\", 224, 224,\n 3]}}\n

      \n
      • \n
    • \n

      Enumerated shapes. Sometimes, the models are trained to work only on a\n select set of inputs. You can enumerate all supported input shapes, for\n example: {\"input_1\": {\"shape\": [[1, 224, 224, 3], [1, 160, 160,\n 3]]}}\n

      \n
      • \n
    \n
    • \n
  • \n

    \n default_shape: Default input shape. You can set a default shape\n during conversion for both Range Dimension and Enumerated Shapes. For example\n {\"input_1\": {\"shape\": [\"1..10\", 224, 224, 3], \"default_shape\": [1,\n 224, 224, 3]}}\n

    \n
    • \n
  • \n

    \n type: Input type. Allowed values: Image and\n Tensor. By default, the converter generates an ML Model with\n inputs of type Tensor (MultiArray). User can set input type to be Image. Image\n input type requires additional input parameters such as bias and\n scale.

    \n
    • \n
  • \n

    \n bias: If the input type is an Image, you need to provide the bias\n vector.

    \n
    • \n
  • \n

    \n scale: If the input type is an Image, you need to provide a scale\n factor.

    \n
    • \n
\n

CoreML ClassifierConfig parameters can be specified using OutputConfig\n CompilerOptions. CoreML converter supports Tensorflow and PyTorch models.\n CoreML conversion examples:

\n
    \n
  • \n

    Tensor type input:

    \n
      \n
    • \n

      \n \"DataInputConfig\": {\"input_1\": {\"shape\": [[1,224,224,3],\n [1,160,160,3]], \"default_shape\": [1,224,224,3]}}\n

      \n
      • \n
    \n
    • \n
  • \n

    Tensor type input without input name (PyTorch):

    \n
      \n
    • \n

      \n \"DataInputConfig\": [{\"shape\": [[1,3,224,224], [1,3,160,160]],\n \"default_shape\": [1,3,224,224]}]\n

      \n
      • \n
    \n
    • \n
  • \n

    Image type input:

    \n
      \n
    • \n

      \n \"DataInputConfig\": {\"input_1\": {\"shape\": [[1,224,224,3],\n [1,160,160,3]], \"default_shape\": [1,224,224,3], \"type\": \"Image\",\n \"bias\": [-1,-1,-1], \"scale\": 0.007843137255}}\n

      \n
      • \n
    • \n

      \n \"CompilerOptions\": {\"class_labels\":\n \"imagenet_labels_1000.txt\"}\n

      \n
      • \n
    \n
    • \n
  • \n

    Image type input without input name (PyTorch):

    \n
      \n
    • \n

      \n \"DataInputConfig\": [{\"shape\": [[1,3,224,224], [1,3,160,160]],\n \"default_shape\": [1,3,224,224], \"type\": \"Image\", \"bias\": [-1,-1,-1],\n \"scale\": 0.007843137255}]\n

      \n
      • \n
    • \n

      \n \"CompilerOptions\": {\"class_labels\":\n \"imagenet_labels_1000.txt\"}\n

      \n
      • \n
    \n
    • \n
\n

Depending on the model format, DataInputConfig requires the following\n parameters for ml_eia2\n OutputConfig:TargetDevice.

\n
    \n
  • \n

    For TensorFlow models saved in the SavedModel format, specify the input names\n from signature_def_key and the input model shapes for\n DataInputConfig. Specify the signature_def_key in\n \n OutputConfig:CompilerOptions\n if the model does not\n use TensorFlow's default signature def key. For example:

    \n
      \n
    • \n

      \n \"DataInputConfig\": {\"inputs\": [1, 224, 224, 3]}\n

      \n
      • \n
    • \n

      \n \"CompilerOptions\": {\"signature_def_key\":\n \"serving_custom\"}\n

      \n
      • \n
    \n
    • \n
  • \n

    For TensorFlow models saved as a frozen graph, specify the input tensor names\n and shapes in DataInputConfig and the output tensor names for\n output_names in \n OutputConfig:CompilerOptions\n . For\n example:

    \n
      \n
    • \n

      \n \"DataInputConfig\": {\"input_tensor:0\": [1, 224, 224,\n 3]}\n

      \n
      • \n
    • \n

      \n \"CompilerOptions\": {\"output_names\":\n [\"output_tensor:0\"]}\n

      \n
      • \n
    \n
    • \n
" + } + }, + "Framework": { + "target": "com.amazonaws.sagemaker#Framework", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Identifies the framework in which the model was trained. For example:\n TENSORFLOW.

", + "smithy.api#required": {} + } + }, + "FrameworkVersion": { + "target": "com.amazonaws.sagemaker#FrameworkVersion", + "traits": { + "smithy.api#documentation": "

Specifies the framework version to use. This API field is only supported for the\n MXNet, PyTorch, TensorFlow and TensorFlow Lite frameworks.

\n

For information about framework versions supported for cloud targets and edge devices,\n see Cloud\n Supported Instance Types and Frameworks and Edge Supported\n Frameworks.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the location of input model artifacts, the name and\n shape\n of the expected data inputs, and the framework in which the model was trained.

" + } + }, + "com.amazonaws.sagemaker#InputDataConfig": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#Channel" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.sagemaker#InputMode": { + "type": "enum", + "members": { + "PIPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pipe" + } + }, + "FILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "File" + } + } + } + }, + "com.amazonaws.sagemaker#InputModes": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#TrainingInputMode" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#InstanceCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#InstanceGroup": { + "type": "structure", + "members": { + "InstanceType": { + "target": "com.amazonaws.sagemaker#TrainingInstanceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies the instance type of the instance group.

", + "smithy.api#required": {} + } + }, + "InstanceCount": { + "target": "com.amazonaws.sagemaker#TrainingInstanceCount", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies the number of instances of the instance group.

", + "smithy.api#required": {} + } + }, + "InstanceGroupName": { + "target": "com.amazonaws.sagemaker#InstanceGroupName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies the name of the instance group.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines an instance group for heterogeneous cluster training. When requesting a\n training job using the CreateTrainingJob API, you can configure multiple instance groups .

" + } + }, + "com.amazonaws.sagemaker#InstanceGroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.sagemaker#InstanceGroupNames": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#InstanceGroupName" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#InstanceGroupStatus": { + "type": "enum", + "members": { + "INSERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InService" + } + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Creating" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "DEGRADED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Degraded" + } + }, + "SYSTEMUPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SystemUpdating" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + } + } + }, + "com.amazonaws.sagemaker#InstanceGroupTrainingPlanStatus": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + } + } + }, + "com.amazonaws.sagemaker#InstanceGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#InstanceGroup" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#InstanceMetadataServiceConfiguration": { + "type": "structure", + "members": { + "MinimumInstanceMetadataServiceVersion": { + "target": "com.amazonaws.sagemaker#MinimumInstanceMetadataServiceVersion", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Indicates the minimum IMDS version that the notebook instance supports. When passed as\n part of CreateNotebookInstance, if no value is selected, then it defaults\n to IMDSv1. This means that both IMDSv1 and IMDSv2 are supported. If passed as part of\n UpdateNotebookInstance, there is no default.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Information on the IMDS configuration of the notebook instance

" + } + }, + "com.amazonaws.sagemaker#InstanceType": { + "type": "enum", + "members": { + "ML_T2_MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t2.medium" + } + }, + "ML_T2_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t2.large" + } + }, + "ML_T2_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t2.xlarge" + } + }, + "ML_T2_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t2.2xlarge" + } + }, + "ML_T3_MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.medium" + } + }, + "ML_T3_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.large" + } + }, + "ML_T3_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.xlarge" + } + }, + "ML_T3_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.2xlarge" + } + }, + "ML_M4_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.xlarge" + } + }, + "ML_M4_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.2xlarge" + } + }, + "ML_M4_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.4xlarge" + } + }, + "ML_M4_10XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.10xlarge" + } + }, + "ML_M4_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.16xlarge" + } + }, + "ML_M5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.xlarge" + } + }, + "ML_M5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.2xlarge" + } + }, + "ML_M5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.4xlarge" + } + }, + "ML_M5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.12xlarge" + } + }, + "ML_M5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.24xlarge" + } + }, + "ML_M5D_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.large" + } + }, + "ML_M5D_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.xlarge" + } + }, + "ML_M5D_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.2xlarge" + } + }, + "ML_M5D_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.4xlarge" + } + }, + "ML_M5D_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.8xlarge" + } + }, + "ML_M5D_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.12xlarge" + } + }, + "ML_M5D_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.16xlarge" + } + }, + "ML_M5D_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.24xlarge" + } + }, + "ML_C4_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.xlarge" + } + }, + "ML_C4_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.2xlarge" + } + }, + "ML_C4_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.4xlarge" + } + }, + "ML_C4_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.8xlarge" + } + }, + "ML_C5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.xlarge" + } + }, + "ML_C5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.2xlarge" + } + }, + "ML_C5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.4xlarge" + } + }, + "ML_C5_9XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.9xlarge" + } + }, + "ML_C5_18XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.18xlarge" + } + }, + "ML_C5D_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5d.xlarge" + } + }, + "ML_C5D_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5d.2xlarge" + } + }, + "ML_C5D_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5d.4xlarge" + } + }, + "ML_C5D_9XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5d.9xlarge" + } + }, + "ML_C5D_18XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5d.18xlarge" + } + }, + "ML_P2_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p2.xlarge" + } + }, + "ML_P2_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p2.8xlarge" + } + }, + "ML_P2_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p2.16xlarge" + } + }, + "ML_P3_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3.2xlarge" + } + }, + "ML_P3_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3.8xlarge" + } + }, + "ML_P3_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3.16xlarge" + } + }, + "ML_P3DN_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3dn.24xlarge" + } + }, + "ML_G4DN_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.xlarge" + } + }, + "ML_G4DN_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.2xlarge" + } + }, + "ML_G4DN_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.4xlarge" + } + }, + "ML_G4DN_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.8xlarge" + } + }, + "ML_G4DN_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.12xlarge" + } + }, + "ML_G4DN_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.16xlarge" + } + }, + "ML_R5_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.large" + } + }, + "ML_R5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.xlarge" + } + }, + "ML_R5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.2xlarge" + } + }, + "ML_R5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.4xlarge" + } + }, + "ML_R5_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.8xlarge" + } + }, + "ML_R5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.12xlarge" + } + }, + "ML_R5_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.16xlarge" + } + }, + "ML_R5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.24xlarge" + } + }, + "ML_G5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.xlarge" + } + }, + "ML_G5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.2xlarge" + } + }, + "ML_G5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.4xlarge" + } + }, + "ML_G5_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.8xlarge" + } + }, + "ML_G5_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.16xlarge" + } + }, + "ML_G5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.12xlarge" + } + }, + "ML_G5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.24xlarge" + } + }, + "ML_G5_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.48xlarge" + } + }, + "ML_INF1_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf1.xlarge" + } + }, + "ML_INF1_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf1.2xlarge" + } + }, + "ML_INF1_6XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf1.6xlarge" + } + }, + "ML_INF1_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf1.24xlarge" + } + }, + "ML_TRN1_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1.2xlarge" + } + }, + "ML_TRN1_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1.32xlarge" + } + }, + "ML_TRN1N_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1n.32xlarge" + } + }, + "ML_INF2_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf2.xlarge" + } + }, + "ML_INF2_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf2.8xlarge" + } + }, + "ML_INF2_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf2.24xlarge" + } + }, + "ML_INF2_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf2.48xlarge" + } + }, + "ML_P4D_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p4d.24xlarge" + } + }, + "ML_P4DE_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p4de.24xlarge" + } + }, + "ML_P5_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p5.48xlarge" + } + }, + "ML_M6I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.large" + } + }, + "ML_M6I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.xlarge" + } + }, + "ML_M6I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.2xlarge" + } + }, + "ML_M6I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.4xlarge" + } + }, + "ML_M6I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.8xlarge" + } + }, + "ML_M6I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.12xlarge" + } + }, + "ML_M6I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.16xlarge" + } + }, + "ML_M6I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.24xlarge" + } + }, + "ML_M6I_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.32xlarge" + } + }, + "ML_M7I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.large" + } + }, + "ML_M7I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.xlarge" + } + }, + "ML_M7I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.2xlarge" + } + }, + "ML_M7I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.4xlarge" + } + }, + "ML_M7I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.8xlarge" + } + }, + "ML_M7I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.12xlarge" + } + }, + "ML_M7I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.16xlarge" + } + }, + "ML_M7I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.24xlarge" + } + }, + "ML_M7I_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.48xlarge" + } + }, + "ML_C6I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.large" + } + }, + "ML_C6I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.xlarge" + } + }, + "ML_C6I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.2xlarge" + } + }, + "ML_C6I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.4xlarge" + } + }, + "ML_C6I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.8xlarge" + } + }, + "ML_C6I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.12xlarge" + } + }, + "ML_C6I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.16xlarge" + } + }, + "ML_C6I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.24xlarge" + } + }, + "ML_C6I_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.32xlarge" + } + }, + "ML_C7I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.large" + } + }, + "ML_C7I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.xlarge" + } + }, + "ML_C7I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.2xlarge" + } + }, + "ML_C7I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.4xlarge" + } + }, + "ML_C7I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.8xlarge" + } + }, + "ML_C7I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.12xlarge" + } + }, + "ML_C7I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.16xlarge" + } + }, + "ML_C7I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.24xlarge" + } + }, + "ML_C7I_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.48xlarge" + } + }, + "ML_R6I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.large" + } + }, + "ML_R6I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.xlarge" + } + }, + "ML_R6I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.2xlarge" + } + }, + "ML_R6I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.4xlarge" + } + }, + "ML_R6I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.8xlarge" + } + }, + "ML_R6I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.12xlarge" + } + }, + "ML_R6I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.16xlarge" + } + }, + "ML_R6I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.24xlarge" + } + }, + "ML_R6I_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.32xlarge" + } + }, + "ML_R7I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.large" + } + }, + "ML_R7I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.xlarge" + } + }, + "ML_R7I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.2xlarge" + } + }, + "ML_R7I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.4xlarge" + } + }, + "ML_R7I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.8xlarge" + } + }, + "ML_R7I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.12xlarge" + } + }, + "ML_R7I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.16xlarge" + } + }, + "ML_R7I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.24xlarge" + } + }, + "ML_R7I_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.48xlarge" + } + }, + "ML_M6ID_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6id.large" + } + }, + "ML_M6ID_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6id.xlarge" + } + }, + "ML_M6ID_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6id.2xlarge" + } + }, + "ML_M6ID_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6id.4xlarge" + } + }, + "ML_M6ID_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6id.8xlarge" + } + }, + "ML_M6ID_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6id.12xlarge" + } + }, + "ML_M6ID_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6id.16xlarge" + } + }, + "ML_M6ID_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6id.24xlarge" + } + }, + "ML_M6ID_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6id.32xlarge" + } + }, + "ML_C6ID_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6id.large" + } + }, + "ML_C6ID_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6id.xlarge" + } + }, + "ML_C6ID_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6id.2xlarge" + } + }, + "ML_C6ID_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6id.4xlarge" + } + }, + "ML_C6ID_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6id.8xlarge" + } + }, + "ML_C6ID_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6id.12xlarge" + } + }, + "ML_C6ID_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6id.16xlarge" + } + }, + "ML_C6ID_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6id.24xlarge" + } + }, + "ML_C6ID_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6id.32xlarge" + } + }, + "ML_R6ID_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6id.large" + } + }, + "ML_R6ID_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6id.xlarge" + } + }, + "ML_R6ID_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6id.2xlarge" + } + }, + "ML_R6ID_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6id.4xlarge" + } + }, + "ML_R6ID_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6id.8xlarge" + } + }, + "ML_R6ID_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6id.12xlarge" + } + }, + "ML_R6ID_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6id.16xlarge" + } + }, + "ML_R6ID_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6id.24xlarge" + } + }, + "ML_R6ID_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6id.32xlarge" + } + }, + "ML_G6_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.xlarge" + } + }, + "ML_G6_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.2xlarge" + } + }, + "ML_G6_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.4xlarge" + } + }, + "ML_G6_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.8xlarge" + } + }, + "ML_G6_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.12xlarge" + } + }, + "ML_G6_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.16xlarge" + } + }, + "ML_G6_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.24xlarge" + } + }, + "ML_G6_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.48xlarge" + } + } + } + }, + "com.amazonaws.sagemaker#Integer": { + "type": "integer" + }, + "com.amazonaws.sagemaker#IntegerParameterRange": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#ParameterKey", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the hyperparameter to search.

", + "smithy.api#required": {} + } + }, + "MinValue": { + "target": "com.amazonaws.sagemaker#ParameterValue", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The minimum\n value\n of the hyperparameter to search.

", + "smithy.api#required": {} + } + }, + "MaxValue": { + "target": "com.amazonaws.sagemaker#ParameterValue", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The maximum\n value\n of the hyperparameter to search.

", + "smithy.api#required": {} + } + }, + "ScalingType": { + "target": "com.amazonaws.sagemaker#HyperParameterScalingType", + "traits": { + "smithy.api#documentation": "

The scale that hyperparameter tuning uses to search the hyperparameter range. For\n information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

\n
\n
Auto
\n
\n

SageMaker hyperparameter tuning chooses the best scale for the\n hyperparameter.

\n
\n
Linear
\n
\n

Hyperparameter tuning searches the values in the hyperparameter range by\n using a linear scale.

\n
\n
Logarithmic
\n
\n

Hyperparameter tuning searches the values in the hyperparameter range by\n using a logarithmic scale.

\n

Logarithmic scaling works only for ranges that have only values greater\n than 0.

\n
\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

For a hyperparameter of the integer type, specifies the range\n that\n a hyperparameter tuning job searches.

" + } + }, + "com.amazonaws.sagemaker#IntegerParameterRangeSpecification": { + "type": "structure", + "members": { + "MinValue": { + "target": "com.amazonaws.sagemaker#ParameterValue", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The minimum integer value allowed.

", + "smithy.api#required": {} + } + }, + "MaxValue": { + "target": "com.amazonaws.sagemaker#ParameterValue", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The maximum integer value allowed.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines the possible values for an integer hyperparameter.

" + } + }, + "com.amazonaws.sagemaker#IntegerParameterRanges": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#IntegerParameterRange" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 30 + } + } + }, + "com.amazonaws.sagemaker#InvocationEndTime": { + "type": "timestamp" + }, + "com.amazonaws.sagemaker#InvocationStartTime": { + "type": "timestamp" + }, + "com.amazonaws.sagemaker#InvocationsMaxRetries": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 3 + } + } + }, + "com.amazonaws.sagemaker#InvocationsTimeoutInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 3600 + } + } + }, + "com.amazonaws.sagemaker#IotRoleAlias": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws[a-z\\-]*:iam::\\d{12}:rolealias/?[a-zA-Z_0-9+=,.@\\-_/]+$" + } + }, + "com.amazonaws.sagemaker#IsTrackingServerActive": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active" + } + }, + "INACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Inactive" + } + } + } + }, + "com.amazonaws.sagemaker#ItemIdentifierAttributeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.sagemaker#JobDurationInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#JobReferenceCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.sagemaker#JobReferenceCodeContains": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.sagemaker#JobType": { + "type": "enum", + "members": { + "TRAINING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRAINING" + } + }, + "INFERENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INFERENCE" + } + }, + "NOTEBOOK_KERNEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOTEBOOK_KERNEL" + } + } + } + }, + "com.amazonaws.sagemaker#JoinSource": { + "type": "enum", + "members": { + "INPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Input" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "None" + } + } + } + }, + "com.amazonaws.sagemaker#JsonContentType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*\\/[a-zA-Z0-9](-*[a-zA-Z0-9.])*$" + } + }, + "com.amazonaws.sagemaker#JsonContentTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#JsonContentType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.sagemaker#JsonPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + } + } + }, + "com.amazonaws.sagemaker#JupyterLabAppImageConfig": { + "type": "structure", + "members": { + "FileSystemConfig": { + "target": "com.amazonaws.sagemaker#FileSystemConfig" + }, + "ContainerConfig": { + "target": "com.amazonaws.sagemaker#ContainerConfig" + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for the file system and kernels in a SageMaker AI image running as a JupyterLab app. The FileSystemConfig object is not supported.

" + } + }, + "com.amazonaws.sagemaker#JupyterLabAppSettings": { + "type": "structure", + "members": { + "DefaultResourceSpec": { + "target": "com.amazonaws.sagemaker#ResourceSpec" + }, + "CustomImages": { + "target": "com.amazonaws.sagemaker#CustomImages", + "traits": { + "smithy.api#documentation": "

A list of custom SageMaker images that are configured to run as a JupyterLab app.

" + } + }, + "LifecycleConfigArns": { + "target": "com.amazonaws.sagemaker#LifecycleConfigArns", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the lifecycle configurations attached to the user profile or domain. To remove a lifecycle config, you must set LifecycleConfigArns to an empty list.

" + } + }, + "CodeRepositories": { + "target": "com.amazonaws.sagemaker#CodeRepositories", + "traits": { + "smithy.api#documentation": "

A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.

" + } + }, + "AppLifecycleManagement": { + "target": "com.amazonaws.sagemaker#AppLifecycleManagement", + "traits": { + "smithy.api#documentation": "

Indicates whether idle shutdown is activated for JupyterLab applications.

" + } + }, + "EmrSettings": { + "target": "com.amazonaws.sagemaker#EmrSettings", + "traits": { + "smithy.api#documentation": "

The configuration parameters that specify the IAM roles assumed by the execution role of \n SageMaker (assumable roles) and the cluster instances or job execution environments \n (execution roles or runtime roles) to manage and access resources required for running Amazon EMR\n clusters or Amazon EMR Serverless applications.

" + } + }, + "BuiltInLifecycleConfigArn": { + "target": "com.amazonaws.sagemaker#StudioLifecycleConfigArn", + "traits": { + "smithy.api#documentation": "

The lifecycle configuration that runs before the default lifecycle configuration. It can\n override changes made in the default lifecycle configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The settings for the JupyterLab application.

" + } + }, + "com.amazonaws.sagemaker#JupyterServerAppSettings": { + "type": "structure", + "members": { + "DefaultResourceSpec": { + "target": "com.amazonaws.sagemaker#ResourceSpec", + "traits": { + "smithy.api#documentation": "

The default instance type and the Amazon Resource Name (ARN) of the default SageMaker AI image used by the JupyterServer app. If you use the\n LifecycleConfigArns parameter, then this parameter is also required.

" + } + }, + "LifecycleConfigArns": { + "target": "com.amazonaws.sagemaker#LifecycleConfigArns", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the\n JupyterServerApp. If you use this parameter, the DefaultResourceSpec parameter is\n also required.

\n \n

To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty\n list.

\n " + } + }, + "CodeRepositories": { + "target": "com.amazonaws.sagemaker#CodeRepositories", + "traits": { + "smithy.api#documentation": "

A list of Git repositories that SageMaker AI automatically displays to users for\n cloning in the JupyterServer application.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The JupyterServer app settings.

" + } + }, + "com.amazonaws.sagemaker#KeepAlivePeriodInSeconds": { + "type": "integer", + "traits": { + "smithy.api#documentation": "Optional. Customer requested period in seconds for which the Training cluster is kept alive after the job is finished.", + "smithy.api#range": { + "min": 0, + "max": 3600 + } + } + }, + "com.amazonaws.sagemaker#KendraSettings": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.sagemaker#FeatureStatus", + "traits": { + "smithy.api#documentation": "

Describes whether the document querying feature is enabled\n or disabled in the Canvas application.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon SageMaker Canvas application setting where you configure\n document querying.

" + } + }, + "com.amazonaws.sagemaker#KernelDisplayName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.sagemaker#KernelGatewayAppSettings": { + "type": "structure", + "members": { + "DefaultResourceSpec": { + "target": "com.amazonaws.sagemaker#ResourceSpec", + "traits": { + "smithy.api#documentation": "

The default instance type and the Amazon Resource Name (ARN) of the default SageMaker AI image used by the KernelGateway app.

\n \n

The Amazon SageMaker AI Studio UI does not use the default instance type value set\n here. The default instance type set here is used when Apps are created using the CLI or CloudFormation and the instance type parameter value is not\n passed.

\n " + } + }, + "CustomImages": { + "target": "com.amazonaws.sagemaker#CustomImages", + "traits": { + "smithy.api#documentation": "

A list of custom SageMaker AI images that are configured to run as a KernelGateway\n app.

" + } + }, + "LifecycleConfigArns": { + "target": "com.amazonaws.sagemaker#LifecycleConfigArns", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user\n profile or domain.

\n \n

To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty\n list.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

The KernelGateway app settings.

" + } + }, + "com.amazonaws.sagemaker#KernelGatewayImageConfig": { + "type": "structure", + "members": { + "KernelSpecs": { + "target": "com.amazonaws.sagemaker#KernelSpecs", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The specification of the Jupyter kernels in the image.

", + "smithy.api#required": {} + } + }, + "FileSystemConfig": { + "target": "com.amazonaws.sagemaker#FileSystemConfig", + "traits": { + "smithy.api#documentation": "

The Amazon Elastic File System storage configuration for a SageMaker AI image.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for the file system and kernels in a SageMaker AI image running as a\n KernelGateway app.

" + } + }, + "com.amazonaws.sagemaker#KernelName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.sagemaker#KernelSpec": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#KernelName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Jupyter kernel in the image. This value is case sensitive.

", + "smithy.api#required": {} + } + }, + "DisplayName": { + "target": "com.amazonaws.sagemaker#KernelDisplayName", + "traits": { + "smithy.api#documentation": "

The display name of the kernel.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The specification of a Jupyter kernel.

" + } + }, + "com.amazonaws.sagemaker#KernelSpecs": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#KernelSpec" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#Key": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.sagemaker#KmsKeyId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "^[a-zA-Z0-9:/_-]*$" + } + }, + "com.amazonaws.sagemaker#LabelAttributeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 127 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,126}$" + } + }, + "com.amazonaws.sagemaker#LabelCounter": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.sagemaker#LabelCounters": { + "type": "structure", + "members": { + "TotalLabeled": { + "target": "com.amazonaws.sagemaker#LabelCounter", + "traits": { + "smithy.api#documentation": "

The total number of objects labeled.

" + } + }, + "HumanLabeled": { + "target": "com.amazonaws.sagemaker#LabelCounter", + "traits": { + "smithy.api#documentation": "

The total number of objects labeled by a human worker.

" + } + }, + "MachineLabeled": { + "target": "com.amazonaws.sagemaker#LabelCounter", + "traits": { + "smithy.api#documentation": "

The total number of objects labeled by automated data labeling.

" + } + }, + "FailedNonRetryableError": { + "target": "com.amazonaws.sagemaker#LabelCounter", + "traits": { + "smithy.api#documentation": "

The total number of objects that could not be labeled due to an error.

" + } + }, + "Unlabeled": { + "target": "com.amazonaws.sagemaker#LabelCounter", + "traits": { + "smithy.api#documentation": "

The total number of objects not yet labeled.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides a breakdown of the number of objects labeled.

" + } + }, + "com.amazonaws.sagemaker#LabelCountersForWorkteam": { + "type": "structure", + "members": { + "HumanLabeled": { + "target": "com.amazonaws.sagemaker#LabelCounter", + "traits": { + "smithy.api#documentation": "

The total number of data objects labeled by a human worker.

" + } + }, + "PendingHuman": { + "target": "com.amazonaws.sagemaker#LabelCounter", + "traits": { + "smithy.api#documentation": "

The total number of data objects that need to be labeled by a human worker.

" + } + }, + "Total": { + "target": "com.amazonaws.sagemaker#LabelCounter", + "traits": { + "smithy.api#documentation": "

The total number of tasks in the labeling job.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides counts for human-labeled tasks in the labeling job.

" + } + }, + "com.amazonaws.sagemaker#LabelingJobAlgorithmSpecificationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "^arn:" + } + }, + "com.amazonaws.sagemaker#LabelingJobAlgorithmsConfig": { + "type": "structure", + "members": { + "LabelingJobAlgorithmSpecificationArn": { + "target": "com.amazonaws.sagemaker#LabelingJobAlgorithmSpecificationArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies the Amazon Resource Name (ARN) of the algorithm used for auto-labeling. You\n must select one of the following ARNs:

\n
    \n
  • \n

    \n Image classification\n

    \n

    \n arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/image-classification\n

    \n
    • \n
  • \n

    \n Text classification\n

    \n

    \n arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/text-classification\n

    \n
    • \n
  • \n

    \n Object detection\n

    \n

    \n arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/object-detection\n

    \n
    • \n
  • \n

    \n Semantic Segmentation\n

    \n

    \n arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/semantic-segmentation\n

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "InitialActiveLearningModelArn": { + "target": "com.amazonaws.sagemaker#ModelArn", + "traits": { + "smithy.api#documentation": "

At the end of an auto-label job Ground Truth sends the Amazon Resource Name (ARN) of the final\n model used for auto-labeling. You can use this model as the starting point for\n subsequent similar jobs by providing the ARN of the model here.

" + } + }, + "LabelingJobResourceConfig": { + "target": "com.amazonaws.sagemaker#LabelingJobResourceConfig", + "traits": { + "smithy.api#documentation": "

Provides configuration information for a labeling job.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides configuration information for auto-labeling of your data objects. A\n LabelingJobAlgorithmsConfig object must be supplied in order to use\n auto-labeling.

" + } + }, + "com.amazonaws.sagemaker#LabelingJobArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:labeling-job/" + } + }, + "com.amazonaws.sagemaker#LabelingJobDataAttributes": { + "type": "structure", + "members": { + "ContentClassifiers": { + "target": "com.amazonaws.sagemaker#ContentClassifiers", + "traits": { + "smithy.api#documentation": "

Declares that your content is free of personally identifiable information or adult\n content. SageMaker may restrict the Amazon Mechanical Turk workers that can view your task\n based on this information.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Attributes of the data specified by the customer. Use these to describe the data to be\n labeled.

" + } + }, + "com.amazonaws.sagemaker#LabelingJobDataSource": { + "type": "structure", + "members": { + "S3DataSource": { + "target": "com.amazonaws.sagemaker#LabelingJobS3DataSource", + "traits": { + "smithy.api#documentation": "

The Amazon S3 location of the input data objects.

" + } + }, + "SnsDataSource": { + "target": "com.amazonaws.sagemaker#LabelingJobSnsDataSource", + "traits": { + "smithy.api#documentation": "

An Amazon SNS data source used for streaming labeling jobs. To learn more, see Send Data to a Streaming Labeling Job.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about the location of input data.

\n

You must specify at least one of the following: S3DataSource or SnsDataSource.

\n

Use SnsDataSource to specify an SNS input topic\n for a streaming labeling job. If you do not specify \n and SNS input topic ARN, Ground Truth will create a one-time labeling job.

\n

Use S3DataSource to specify an input \n manifest file for both streaming and one-time labeling jobs.\n Adding an S3DataSource is optional if you use SnsDataSource to create a streaming labeling job.

" + } + }, + "com.amazonaws.sagemaker#LabelingJobForWorkteamSummary": { + "type": "structure", + "members": { + "LabelingJobName": { + "target": "com.amazonaws.sagemaker#LabelingJobName", + "traits": { + "smithy.api#documentation": "

The name of the labeling job that the work team is assigned to.

" + } + }, + "JobReferenceCode": { + "target": "com.amazonaws.sagemaker#JobReferenceCode", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A unique identifier for a labeling job. You can use this to refer to a specific\n labeling job.

", + "smithy.api#required": {} + } + }, + "WorkRequesterAccountId": { + "target": "com.amazonaws.sagemaker#AccountId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Web Services account ID of the account used to start the labeling\n job.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The date and time that the labeling job was created.

", + "smithy.api#required": {} + } + }, + "LabelCounters": { + "target": "com.amazonaws.sagemaker#LabelCountersForWorkteam", + "traits": { + "smithy.api#documentation": "

Provides information about the progress of a labeling job.

" + } + }, + "NumberOfHumanWorkersPerDataObject": { + "target": "com.amazonaws.sagemaker#NumberOfHumanWorkersPerDataObject", + "traits": { + "smithy.api#documentation": "

The configured number of workers per data object.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides summary information for a work team.

" + } + }, + "com.amazonaws.sagemaker#LabelingJobForWorkteamSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#LabelingJobForWorkteamSummary" + } + }, + "com.amazonaws.sagemaker#LabelingJobInputConfig": { + "type": "structure", + "members": { + "DataSource": { + "target": "com.amazonaws.sagemaker#LabelingJobDataSource", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The location of the input data.

", + "smithy.api#required": {} + } + }, + "DataAttributes": { + "target": "com.amazonaws.sagemaker#LabelingJobDataAttributes", + "traits": { + "smithy.api#documentation": "

Attributes of the data specified by the customer.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Input configuration information for a labeling job.

" + } + }, + "com.amazonaws.sagemaker#LabelingJobName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#LabelingJobOutput": { + "type": "structure", + "members": { + "OutputDatasetS3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon S3 bucket location of the manifest file for labeled data.

", + "smithy.api#required": {} + } + }, + "FinalActiveLearningModelArn": { + "target": "com.amazonaws.sagemaker#ModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the most recent SageMaker model trained as part of\n automated data labeling.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the location of the output produced by the labeling job.

" + } + }, + "com.amazonaws.sagemaker#LabelingJobOutputConfig": { + "type": "structure", + "members": { + "S3OutputPath": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon S3 location to write output data.

", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Key Management Service ID of the key used to encrypt the output data, if any.

\n

If you provide your own KMS key ID, you must add the required permissions to your KMS\n key described in Encrypt Output Data and Storage Volume with Amazon Web Services KMS.

\n

If you don't provide a KMS key ID, Amazon SageMaker uses the default Amazon Web Services KMS key for Amazon S3 for your\n role's account to encrypt your output data.

\n

If you use a bucket policy with an s3:PutObject permission that only\n allows objects with server-side encryption, set the condition key of\n s3:x-amz-server-side-encryption to \"aws:kms\". For more\n information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer\n Guide.\n

" + } + }, + "SnsTopicArn": { + "target": "com.amazonaws.sagemaker#SnsTopicArn", + "traits": { + "smithy.api#documentation": "

An Amazon Simple Notification Service (Amazon SNS) output topic ARN. Provide a SnsTopicArn if you want to\n do real time chaining to another streaming job and receive an Amazon SNS notifications each\n time a data object is submitted by a worker.

\n

If you provide an SnsTopicArn in OutputConfig, when workers\n complete labeling tasks, Ground Truth will send labeling task output data to the SNS output\n topic you specify here.

\n

To learn more, see Receive Output Data from a Streaming Labeling\n Job.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Output configuration information for a labeling job.

" + } + }, + "com.amazonaws.sagemaker#LabelingJobResourceConfig": { + "type": "structure", + "members": { + "VolumeKmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume\n attached to the ML compute instance(s) that run the training and inference jobs used for\n automated data labeling.

\n

You can only specify a VolumeKmsKeyId when you create a labeling job with\n automated data labeling enabled using the API operation CreateLabelingJob.\n You cannot specify an Amazon Web Services KMS key to encrypt the storage volume used for\n automated data labeling model training and inference when you create a labeling job\n using the console. To learn more, see Output Data and Storage Volume\n Encryption.

\n

The VolumeKmsKeyId can be any of the following formats:

\n
    \n
  • \n

    KMS Key ID

    \n

    \n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    Amazon Resource Name (ARN) of a KMS Key

    \n

    \n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
" + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig" + } + }, + "traits": { + "smithy.api#documentation": "

Configure encryption on the storage volume attached to the ML compute instance used to\n run automated data labeling model training and inference.

" + } + }, + "com.amazonaws.sagemaker#LabelingJobS3DataSource": { + "type": "structure", + "members": { + "ManifestS3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon S3 location of the manifest file that describes the input data objects.

\n

The input manifest file referenced in ManifestS3Uri must contain one of\n the following keys: source-ref or source. The value of the\n keys are interpreted as follows:

\n
    \n
  • \n

    \n source-ref: The source of the object is the Amazon S3 object\n specified in the value. Use this value when the object is a binary object, such\n as an image.

    \n
    • \n
  • \n

    \n source: The source of the object is the value. Use this\n value when the object is a text value.

    \n
    • \n
\n

If you are a new user of Ground Truth, it is recommended you review Use an Input Manifest File in the Amazon SageMaker Developer Guide to learn how to\n create an input manifest file.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon S3 location of the input data objects.

" + } + }, + "com.amazonaws.sagemaker#LabelingJobSnsDataSource": { + "type": "structure", + "members": { + "SnsTopicArn": { + "target": "com.amazonaws.sagemaker#SnsTopicArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon SNS input topic Amazon Resource Name (ARN). Specify the ARN of the input topic\n you will use to send new data objects to a streaming labeling job.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An Amazon SNS data source used for streaming labeling jobs.

" + } + }, + "com.amazonaws.sagemaker#LabelingJobStatus": { + "type": "enum", + "members": { + "INITIALIZING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Initializing" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + } + } + }, + "com.amazonaws.sagemaker#LabelingJobStoppingConditions": { + "type": "structure", + "members": { + "MaxHumanLabeledObjectCount": { + "target": "com.amazonaws.sagemaker#MaxHumanLabeledObjectCount", + "traits": { + "smithy.api#documentation": "

The maximum number of objects that can be labeled by human workers.

" + } + }, + "MaxPercentageOfInputDatasetLabeled": { + "target": "com.amazonaws.sagemaker#MaxPercentageOfInputDatasetLabeled", + "traits": { + "smithy.api#documentation": "

The maximum number of input data objects that should be labeled.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A set of conditions for stopping a labeling job. If any of the conditions are met, the\n job is automatically stopped. You can use these conditions to control the cost of data\n labeling.

\n \n

Labeling jobs fail after 30 days with an appropriate client error message.

\n " + } + }, + "com.amazonaws.sagemaker#LabelingJobSummary": { + "type": "structure", + "members": { + "LabelingJobName": { + "target": "com.amazonaws.sagemaker#LabelingJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the labeling job.

", + "smithy.api#required": {} + } + }, + "LabelingJobArn": { + "target": "com.amazonaws.sagemaker#LabelingJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) assigned to the labeling job when it was\n created.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The date and time that the job was created (timestamp).

", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The date and time that the job was last modified (timestamp).

", + "smithy.api#required": {} + } + }, + "LabelingJobStatus": { + "target": "com.amazonaws.sagemaker#LabelingJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The current status of the labeling job.

", + "smithy.api#required": {} + } + }, + "LabelCounters": { + "target": "com.amazonaws.sagemaker#LabelCounters", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Counts showing the progress of the labeling job.

", + "smithy.api#required": {} + } + }, + "WorkteamArn": { + "target": "com.amazonaws.sagemaker#WorkteamArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the work team assigned to the job.

", + "smithy.api#required": {} + } + }, + "PreHumanTaskLambdaArn": { + "target": "com.amazonaws.sagemaker#LambdaFunctionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Lambda function. The function is run before each\n data object is sent to a worker.

" + } + }, + "AnnotationConsolidationLambdaArn": { + "target": "com.amazonaws.sagemaker#LambdaFunctionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Lambda function used to consolidate the\n annotations from individual workers into a label for a data object. For more\n information, see Annotation\n Consolidation.

" + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "

If the LabelingJobStatus field is Failed, this field\n contains a description of the error.

" + } + }, + "LabelingJobOutput": { + "target": "com.amazonaws.sagemaker#LabelingJobOutput", + "traits": { + "smithy.api#documentation": "

The location of the output produced by the labeling job.

" + } + }, + "InputConfig": { + "target": "com.amazonaws.sagemaker#LabelingJobInputConfig", + "traits": { + "smithy.api#documentation": "

Input configuration for the labeling job.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides summary information about a labeling job.

" + } + }, + "com.amazonaws.sagemaker#LabelingJobSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#LabelingJobSummary" + } + }, + "com.amazonaws.sagemaker#LambdaFunctionArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:lambda:[a-z0-9\\-]*:[0-9]{12}:function:" + } + }, + "com.amazonaws.sagemaker#LambdaStepMetadata": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution.

" + } + }, + "OutputParameters": { + "target": "com.amazonaws.sagemaker#OutputParameterList", + "traits": { + "smithy.api#documentation": "

A list of the output parameters of the Lambda step.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Metadata for a Lambda step.

" + } + }, + "com.amazonaws.sagemaker#LandingUri": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1023 + } + } + }, + "com.amazonaws.sagemaker#LastModifiedTime": { + "type": "timestamp" + }, + "com.amazonaws.sagemaker#LastUpdateStatus": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.sagemaker#LastUpdateStatusValue", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A value that indicates whether the update was made successful.

", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "

If the update wasn't successful, indicates the reason why it failed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A value that indicates whether the update was successful.

" + } + }, + "com.amazonaws.sagemaker#LastUpdateStatusValue": { + "type": "enum", + "members": { + "SUCCESSFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Successful" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + } + } + }, + "com.amazonaws.sagemaker#LifecycleConfigArns": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#StudioLifecycleConfigArn" + } + }, + "com.amazonaws.sagemaker#LifecycleManagement": { + "type": "enum", + "members": { + "Enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "Disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.sagemaker#LineageEntityParameters": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#StringParameterValue" + }, + "value": { + "target": "com.amazonaws.sagemaker#StringParameterValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 30 + } + } + }, + "com.amazonaws.sagemaker#LineageGroupArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:lineage-group/" + } + }, + "com.amazonaws.sagemaker#LineageGroupNameOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:lineage-group\\/)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,119})$" + } + }, + "com.amazonaws.sagemaker#LineageGroupSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#LineageGroupSummary" + } + }, + "com.amazonaws.sagemaker#LineageGroupSummary": { + "type": "structure", + "members": { + "LineageGroupArn": { + "target": "com.amazonaws.sagemaker#LineageGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the lineage group resource.

" + } + }, + "LineageGroupName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the lineage group.

" + } + }, + "DisplayName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

The display name of the lineage group summary.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The creation time of the lineage group summary.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The last modified time of the lineage group summary.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Lists a summary of the properties of a lineage group. A lineage group provides a group of shareable lineage entity \n resources.

" + } + }, + "com.amazonaws.sagemaker#LineageType": { + "type": "enum", + "members": { + "TRIAL_COMPONENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TrialComponent" + } + }, + "ARTIFACT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Artifact" + } + }, + "CONTEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Context" + } + }, + "ACTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Action" + } + } + } + }, + "com.amazonaws.sagemaker#ListActions": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListActionsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListActionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the actions in your account and their properties.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ActionSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListActionsRequest": { + "type": "structure", + "members": { + "SourceUri": { + "target": "com.amazonaws.sagemaker#SourceUri", + "traits": { + "smithy.api#documentation": "

A filter that returns only actions with the specified source URI.

" + } + }, + "ActionType": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "

A filter that returns only actions of the specified type.

" + } + }, + "CreatedAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only actions created on or after the specified time.

" + } + }, + "CreatedBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only actions created on or before the specified time.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#SortActionsBy", + "traits": { + "smithy.api#documentation": "

The property used to sort results. The default value is CreationTime.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

The sort order. The default value is Descending.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the previous call to ListActions didn't return the full set of actions,\n the call returns a token for getting the next set of actions.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of actions to return in the response. The default value is 10.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListActionsResponse": { + "type": "structure", + "members": { + "ActionSummaries": { + "target": "com.amazonaws.sagemaker#ActionSummaries", + "traits": { + "smithy.api#documentation": "

A list of actions and their properties.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

A token for getting the next set of actions, if there are any.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListAlgorithms": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListAlgorithmsInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListAlgorithmsOutput" + }, + "traits": { + "smithy.api#documentation": "

Lists the machine learning algorithms that have been created.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AlgorithmSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListAlgorithmsInput": { + "type": "structure", + "members": { + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "

A filter that returns only algorithms created after the specified time\n (timestamp).

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "

A filter that returns only algorithms created before the specified time\n (timestamp).

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of algorithms to return in the response.

" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "

A string in the algorithm name. This filter returns only algorithms whose name\n contains the specified string.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the response to a previous ListAlgorithms request was truncated, the\n response includes a NextToken. To retrieve the next set of algorithms, use\n the token in the next request.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#AlgorithmSortBy", + "traits": { + "smithy.api#documentation": "

The parameter by which to sort the results. The default is\n CreationTime.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

The sort order for the results. The default is Ascending.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListAlgorithmsOutput": { + "type": "structure", + "members": { + "AlgorithmSummaryList": { + "target": "com.amazonaws.sagemaker#AlgorithmSummaryList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

>An array of AlgorithmSummary objects, each of which lists an\n algorithm.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of\n algorithms, use it in the subsequent request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListAliases": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListAliasesRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListAliasesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the aliases of a specified image or image version.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "SageMakerImageVersionAliases", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListAliasesRequest": { + "type": "structure", + "members": { + "ImageName": { + "target": "com.amazonaws.sagemaker#ImageName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the image.

", + "smithy.api#required": {} + } + }, + "Alias": { + "target": "com.amazonaws.sagemaker#SageMakerImageVersionAlias", + "traits": { + "smithy.api#documentation": "

The alias of the image version.

" + } + }, + "Version": { + "target": "com.amazonaws.sagemaker#ImageVersionNumber", + "traits": { + "smithy.api#documentation": "

The version of the image. If image version is not specified, the aliases of all versions of the image are listed.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of aliases to return.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the previous call to ListAliases didn't return the full set of\n aliases, the call returns a token for retrieving the next set of aliases.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListAliasesResponse": { + "type": "structure", + "members": { + "SageMakerImageVersionAliases": { + "target": "com.amazonaws.sagemaker#SageMakerImageVersionAliases", + "traits": { + "smithy.api#documentation": "

A list of SageMaker AI image version aliases.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

A token for getting the next set of aliases, if more aliases exist.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListAppImageConfigs": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListAppImageConfigsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListAppImageConfigsResponse" + }, + "traits": { + "smithy.api#documentation": "

Lists the AppImageConfigs in your account and their properties. The list can be\n filtered by creation time or modified time, and whether the AppImageConfig name contains\n a specified string.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AppImageConfigs", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListAppImageConfigsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The total number of items to return in the response. If the total\n number of items available is more than the value specified, a NextToken\n is provided in the response. To resume pagination, provide the NextToken\n value in the as part of a subsequent call. The default value is 10.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the previous call to ListImages didn't return the full set of\n AppImageConfigs, the call returns a token for getting the next set of AppImageConfigs.

" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#AppImageConfigName", + "traits": { + "smithy.api#documentation": "

A filter that returns only AppImageConfigs whose name contains the specified string.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only AppImageConfigs created on or before the specified time.

" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only AppImageConfigs created on or after the specified time.

" + } + }, + "ModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only AppImageConfigs modified on or before the specified time.

" + } + }, + "ModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only AppImageConfigs modified on or after the specified time.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#AppImageConfigSortKey", + "traits": { + "smithy.api#documentation": "

The property used to sort results. The default value is CreationTime.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

The sort order. The default value is Descending.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListAppImageConfigsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

A token for getting the next set of AppImageConfigs, if there are any.

" + } + }, + "AppImageConfigs": { + "target": "com.amazonaws.sagemaker#AppImageConfigList", + "traits": { + "smithy.api#documentation": "

A list of AppImageConfigs and their properties.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListApps": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListAppsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListAppsResponse" + }, + "traits": { + "smithy.api#documentation": "

Lists apps.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Apps", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListAppsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

This parameter defines the maximum number of results that can be return in a single\n response. The MaxResults parameter is an upper bound, not a target. If there are\n more results available than the value specified, a NextToken is provided in the\n response. The NextToken indicates that the user should get the next set of\n results by providing this token as a part of a subsequent call. The default value for\n MaxResults is 10.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

The sort order for the results. The default is Ascending.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#AppSortKey", + "traits": { + "smithy.api#documentation": "

The parameter by which to sort the results. The default is CreationTime.

" + } + }, + "DomainIdEquals": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#documentation": "

A parameter to search for the domain ID.

" + } + }, + "UserProfileNameEquals": { + "target": "com.amazonaws.sagemaker#UserProfileName", + "traits": { + "smithy.api#documentation": "

A parameter to search by user profile name. If SpaceNameEquals is set, then\n this value cannot be set.

" + } + }, + "SpaceNameEquals": { + "target": "com.amazonaws.sagemaker#SpaceName", + "traits": { + "smithy.api#documentation": "

A parameter to search by space name. If UserProfileNameEquals is set, then\n this value cannot be set.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListAppsResponse": { + "type": "structure", + "members": { + "Apps": { + "target": "com.amazonaws.sagemaker#AppList", + "traits": { + "smithy.api#documentation": "

The list of apps.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListArtifacts": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListArtifactsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListArtifactsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the artifacts in your account and their properties.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ArtifactSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListArtifactsRequest": { + "type": "structure", + "members": { + "SourceUri": { + "target": "com.amazonaws.sagemaker#SourceUri", + "traits": { + "smithy.api#documentation": "

A filter that returns only artifacts with the specified source URI.

" + } + }, + "ArtifactType": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "

A filter that returns only artifacts of the specified type.

" + } + }, + "CreatedAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only artifacts created on or after the specified time.

" + } + }, + "CreatedBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only artifacts created on or before the specified time.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#SortArtifactsBy", + "traits": { + "smithy.api#documentation": "

The property used to sort results. The default value is CreationTime.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

The sort order. The default value is Descending.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the previous call to ListArtifacts didn't return the full set of artifacts,\n the call returns a token for getting the next set of artifacts.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of artifacts to return in the response. The default value is 10.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListArtifactsResponse": { + "type": "structure", + "members": { + "ArtifactSummaries": { + "target": "com.amazonaws.sagemaker#ArtifactSummaries", + "traits": { + "smithy.api#documentation": "

A list of artifacts and their properties.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

A token for getting the next set of artifacts, if there are any.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListAssociationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the associations in your account and their properties.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AssociationSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListAssociationsRequest": { + "type": "structure", + "members": { + "SourceArn": { + "target": "com.amazonaws.sagemaker#AssociationEntityArn", + "traits": { + "smithy.api#documentation": "

A filter that returns only associations with the specified source ARN.

" + } + }, + "DestinationArn": { + "target": "com.amazonaws.sagemaker#AssociationEntityArn", + "traits": { + "smithy.api#documentation": "

A filter that returns only associations with the specified destination Amazon Resource Name (ARN).

" + } + }, + "SourceType": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "

A filter that returns only associations with the specified source type.

" + } + }, + "DestinationType": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "

A filter that returns only associations with the specified destination type.

" + } + }, + "AssociationType": { + "target": "com.amazonaws.sagemaker#AssociationEdgeType", + "traits": { + "smithy.api#documentation": "

A filter that returns only associations of the specified type.

" + } + }, + "CreatedAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only associations created on or after the specified time.

" + } + }, + "CreatedBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only associations created on or before the specified time.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#SortAssociationsBy", + "traits": { + "smithy.api#documentation": "

The property used to sort results. The default value is CreationTime.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

The sort order. The default value is Descending.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the previous call to ListAssociations didn't return the full set of associations,\n the call returns a token for getting the next set of associations.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of associations to return in the response. The default value is 10.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListAssociationsResponse": { + "type": "structure", + "members": { + "AssociationSummaries": { + "target": "com.amazonaws.sagemaker#AssociationSummaries", + "traits": { + "smithy.api#documentation": "

A list of associations and their properties.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

A token for getting the next set of associations, if there are any.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListAutoMLJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListAutoMLJobsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListAutoMLJobsResponse" + }, + "traits": { + "smithy.api#documentation": "

Request a list of jobs.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AutoMLJobSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListAutoMLJobsRequest": { + "type": "structure", + "members": { + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Request a list of jobs, using a filter for time.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Request a list of jobs, using a filter for time.

" + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Request a list of jobs, using a filter for time.

" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Request a list of jobs, using a filter for time.

" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#AutoMLNameContains", + "traits": { + "smithy.api#documentation": "

Request a list of jobs, using a search filter for name.

" + } + }, + "StatusEquals": { + "target": "com.amazonaws.sagemaker#AutoMLJobStatus", + "traits": { + "smithy.api#documentation": "

Request a list of jobs, using a filter for status.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#AutoMLSortOrder", + "traits": { + "smithy.api#documentation": "

The sort order for the results. The default is Descending.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#AutoMLSortBy", + "traits": { + "smithy.api#documentation": "

The parameter by which to sort the results. The default is Name.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#AutoMLMaxResults", + "traits": { + "smithy.api#documentation": "

Request a list of jobs up to a specified limit.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the previous response was truncated, you receive this token. Use it in your next\n request to receive the next set of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListAutoMLJobsResponse": { + "type": "structure", + "members": { + "AutoMLJobSummaries": { + "target": "com.amazonaws.sagemaker#AutoMLJobSummaries", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Returns a summary list of jobs.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the previous response was truncated, you receive this token. Use it in your next\n request to receive the next set of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListCandidatesForAutoMLJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListCandidatesForAutoMLJobRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListCandidatesForAutoMLJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

List the candidates created for the job.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Candidates", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListCandidatesForAutoMLJobRequest": { + "type": "structure", + "members": { + "AutoMLJobName": { + "target": "com.amazonaws.sagemaker#AutoMLJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

List the candidates created for the job by providing the job's name.

", + "smithy.api#required": {} + } + }, + "StatusEquals": { + "target": "com.amazonaws.sagemaker#CandidateStatus", + "traits": { + "smithy.api#documentation": "

List the candidates for the job and filter by status.

" + } + }, + "CandidateNameEquals": { + "target": "com.amazonaws.sagemaker#CandidateName", + "traits": { + "smithy.api#documentation": "

List the candidates for the job and filter by candidate name.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#AutoMLSortOrder", + "traits": { + "smithy.api#documentation": "

The sort order for the results. The default is Ascending.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#CandidateSortBy", + "traits": { + "smithy.api#documentation": "

The parameter by which to sort the results. The default is\n Descending.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#AutoMLMaxResultsForTrials", + "traits": { + "smithy.api#documentation": "

List the job's candidates up to a specified limit.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the previous response was truncated, you receive this token. Use it in your next\n request to receive the next set of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListCandidatesForAutoMLJobResponse": { + "type": "structure", + "members": { + "Candidates": { + "target": "com.amazonaws.sagemaker#AutoMLCandidates", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Summaries about the AutoMLCandidates.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the previous response was truncated, you receive this token. Use it in your next\n request to receive the next set of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListClusterNodes": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListClusterNodesRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListClusterNodesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the list of instances (also called nodes interchangeably)\n in a SageMaker HyperPod cluster.

" + } + }, + "com.amazonaws.sagemaker#ListClusterNodesRequest": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.sagemaker#ClusterNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which you want to retrieve the\n list of nodes.

", + "smithy.api#required": {} + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns nodes in a SageMaker HyperPod cluster created after the specified time.\n Timestamps are formatted according to the ISO 8601 standard.

\n

Acceptable formats include:

\n
    \n
  • \n

    \n YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example,\n 2014-10-01T20:30:00.000Z\n

    \n
    • \n
  • \n

    \n YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example,\n 2014-10-01T12:30:00.000-08:00\n

    \n
    • \n
  • \n

    \n YYYY-MM-DD, for example, 2014-10-01\n

    \n
    • \n
  • \n

    Unix time in seconds, for example, 1412195400. This is also referred\n to as Unix Epoch time and represents the number of seconds since midnight, January 1,\n 1970 UTC.

    \n
    • \n
\n

For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User\n Guide.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The\n acceptable formats are the same as the timestamp formats for\n CreationTimeAfter. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User\n Guide.

" + } + }, + "InstanceGroupNameContains": { + "target": "com.amazonaws.sagemaker#ClusterInstanceGroupName", + "traits": { + "smithy.api#documentation": "

A filter that returns the instance groups whose name contain a specified string.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of nodes to return in the response.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the result of the previous ListClusterNodes request was truncated, the\n response includes a NextToken. To retrieve the next set of cluster nodes, use\n the token in the next request.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#ClusterSortBy", + "traits": { + "smithy.api#documentation": "

The field by which to sort results. The default value is\n CREATION_TIME.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

The sort order for results. The default value is Ascending.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListClusterNodesResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The next token specified for listing instances in a SageMaker HyperPod cluster.

", + "smithy.api#required": {} + } + }, + "ClusterNodeSummaries": { + "target": "com.amazonaws.sagemaker#ClusterNodeSummaries", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The summaries of listed instances in a SageMaker HyperPod cluster

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListClusterSchedulerConfigs": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListClusterSchedulerConfigsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListClusterSchedulerConfigsResponse" + }, + "traits": { + "smithy.api#documentation": "

List the cluster policy configurations.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ClusterSchedulerConfigSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListClusterSchedulerConfigsRequest": { + "type": "structure", + "members": { + "CreatedAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Filter for after this creation time. The input for this parameter is a Unix timestamp.\n To convert a date and time into a Unix timestamp, see EpochConverter.

" + } + }, + "CreatedBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Filter for before this creation time. The input for this parameter is a Unix timestamp.\n To convert a date and time into a Unix timestamp, see EpochConverter.

" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#documentation": "

Filter for name containing this string.

" + } + }, + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#documentation": "

Filter for ARN of the cluster.

" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#SchedulerResourceStatus", + "traits": { + "smithy.api#documentation": "

Filter for status.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#SortClusterSchedulerConfigBy", + "traits": { + "smithy.api#documentation": "

Filter for sorting the list by a given value. For example, sort by name, creation time,\n or status.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

The order of the list. By default, listed in Descending order according to\n by SortBy. To change the list order, you can specify SortOrder to\n be Ascending.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of cluster policies to list.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListClusterSchedulerConfigsResponse": { + "type": "structure", + "members": { + "ClusterSchedulerConfigSummaries": { + "target": "com.amazonaws.sagemaker#ClusterSchedulerConfigSummaryList", + "traits": { + "smithy.api#documentation": "

Summaries of the cluster policies.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListClusters": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListClustersRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListClustersResponse" + }, + "traits": { + "smithy.api#documentation": "

Retrieves the list of SageMaker HyperPod clusters.

" + } + }, + "com.amazonaws.sagemaker#ListClustersRequest": { + "type": "structure", + "members": { + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Set a start time for the time range during which you want to list SageMaker HyperPod clusters.\n Timestamps are formatted according to the ISO 8601 standard.

\n

Acceptable formats include:

\n
    \n
  • \n

    \n YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example,\n 2014-10-01T20:30:00.000Z\n

    \n
    • \n
  • \n

    \n YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example,\n 2014-10-01T12:30:00.000-08:00\n

    \n
    • \n
  • \n

    \n YYYY-MM-DD, for example, 2014-10-01\n

    \n
    • \n
  • \n

    Unix time in seconds, for example, 1412195400. This is also referred\n to as Unix Epoch time and represents the number of seconds since midnight, January 1,\n 1970 UTC.

    \n
    • \n
\n

For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User\n Guide.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Set an end time for the time range during which you want to list SageMaker HyperPod clusters. A\n filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The\n acceptable formats are the same as the timestamp formats for\n CreationTimeAfter. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User\n Guide.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

Set the maximum number of SageMaker HyperPod clusters to list.

" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "

Set the maximum number of instances to print in the list.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

Set the next token to retrieve the list of SageMaker HyperPod clusters.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#ClusterSortBy", + "traits": { + "smithy.api#documentation": "

The field by which to sort results. The default value is\n CREATION_TIME.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

The sort order for results. The default value is Ascending.

" + } + }, + "TrainingPlanArn": { + "target": "com.amazonaws.sagemaker#TrainingPlanArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN); of the training plan to filter clusters by. For more information about\n reserving GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListClustersResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

If the result of the previous ListClusters request was truncated, the\n response includes a NextToken. To retrieve the next set of clusters, use the\n token in the next request.

", + "smithy.api#required": {} + } + }, + "ClusterSummaries": { + "target": "com.amazonaws.sagemaker#ClusterSummaries", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The summaries of listed SageMaker HyperPod clusters.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListCodeRepositories": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListCodeRepositoriesInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListCodeRepositoriesOutput" + }, + "traits": { + "smithy.api#documentation": "

Gets a list of the Git repositories in your account.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "CodeRepositorySummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListCodeRepositoriesInput": { + "type": "structure", + "members": { + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "

A filter that returns only Git repositories that were created after the specified\n time.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "

A filter that returns only Git repositories that were created before the specified\n time.

" + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only Git repositories that were last modified after the\n specified time.

" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only Git repositories that were last modified before the\n specified time.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of Git repositories to return in the response.

" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#CodeRepositoryNameContains", + "traits": { + "smithy.api#documentation": "

A string in the Git repositories name. This filter returns only repositories whose\n name contains the specified string.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the result of a ListCodeRepositoriesOutput request was truncated, the\n response includes a NextToken. To get the next set of Git repositories, use\n the token in the next request.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#CodeRepositorySortBy", + "traits": { + "smithy.api#documentation": "

The field to sort results by. The default is Name.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#CodeRepositorySortOrder", + "traits": { + "smithy.api#documentation": "

The sort order for results. The default is Ascending.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListCodeRepositoriesOutput": { + "type": "structure", + "members": { + "CodeRepositorySummaryList": { + "target": "com.amazonaws.sagemaker#CodeRepositorySummaryList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Gets a list of summaries of the Git repositories. Each summary specifies the following\n values for the repository:

\n
    \n
  • \n

    Name

    \n
    • \n
  • \n

    Amazon Resource Name (ARN)

    \n
    • \n
  • \n

    Creation time

    \n
    • \n
  • \n

    Last modified time

    \n
    • \n
  • \n

    Configuration information, including the URL location of the repository and\n the ARN of the Amazon Web Services Secrets Manager secret that contains the\n credentials used to access the repository.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the result of a ListCodeRepositoriesOutput request was truncated, the\n response includes a NextToken. To get the next set of Git repositories, use\n the token in the next request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListCompilationJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListCompilationJobsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListCompilationJobsResponse" + }, + "traits": { + "smithy.api#documentation": "

Lists model compilation jobs that satisfy various filters.

\n

To create a model compilation job, use CreateCompilationJob. To get information about a particular model\n compilation job you have created, use DescribeCompilationJob.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "CompilationJobSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListCompilationJobsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the result of the previous ListCompilationJobs request was truncated,\n the response includes a NextToken. To retrieve the next set of model\n compilation jobs, use the token in the next request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of model compilation jobs to return in the response.

" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "

A filter that returns the model compilation jobs that were created after a specified\n time.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "

A filter that returns the model compilation jobs that were created before a specified\n time.

" + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "

A filter that returns the model compilation jobs that were modified after a specified\n time.

" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "

A filter that returns the model compilation jobs that were modified before a specified\n time.

" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "

A filter that returns the model compilation jobs whose name contains a specified\n string.

" + } + }, + "StatusEquals": { + "target": "com.amazonaws.sagemaker#CompilationJobStatus", + "traits": { + "smithy.api#documentation": "

A filter that retrieves model compilation jobs with a specific\n CompilationJobStatus status.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#ListCompilationJobsSortBy", + "traits": { + "smithy.api#documentation": "

The field by which to sort results. The default is CreationTime.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

The sort order for results. The default is Ascending.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListCompilationJobsResponse": { + "type": "structure", + "members": { + "CompilationJobSummaries": { + "target": "com.amazonaws.sagemaker#CompilationJobSummaries", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An array of CompilationJobSummary objects, each describing a model compilation job.\n

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the response is truncated, Amazon SageMaker AI returns this NextToken. To retrieve\n the next set of model compilation jobs, use this token in the next request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListCompilationJobsSortBy": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + } + } + }, + "com.amazonaws.sagemaker#ListComputeQuotas": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListComputeQuotasRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListComputeQuotasResponse" + }, + "traits": { + "smithy.api#documentation": "

List the resource allocation definitions.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ComputeQuotaSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListComputeQuotasRequest": { + "type": "structure", + "members": { + "CreatedAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Filter for after this creation time. The input for this parameter is a Unix timestamp.\n To convert a date and time into a Unix timestamp, see EpochConverter.

" + } + }, + "CreatedBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Filter for before this creation time. The input for this parameter is a Unix timestamp.\n To convert a date and time into a Unix timestamp, see EpochConverter.

" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#documentation": "

Filter for name containing this string.

" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#SchedulerResourceStatus", + "traits": { + "smithy.api#documentation": "

Filter for status.

" + } + }, + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#documentation": "

Filter for ARN of the cluster.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#SortQuotaBy", + "traits": { + "smithy.api#documentation": "

Filter for sorting the list by a given value. For example, sort by name, creation time,\n or status.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

The order of the list. By default, listed in Descending order according to\n by SortBy. To change the list order, you can specify SortOrder to\n be Ascending.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of compute allocation definitions to list.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListComputeQuotasResponse": { + "type": "structure", + "members": { + "ComputeQuotaSummaries": { + "target": "com.amazonaws.sagemaker#ComputeQuotaSummaryList", + "traits": { + "smithy.api#documentation": "

Summaries of the compute allocation definitions.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListContexts": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListContextsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListContextsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the contexts in your account and their properties.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ContextSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListContextsRequest": { + "type": "structure", + "members": { + "SourceUri": { + "target": "com.amazonaws.sagemaker#SourceUri", + "traits": { + "smithy.api#documentation": "

A filter that returns only contexts with the specified source URI.

" + } + }, + "ContextType": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "

A filter that returns only contexts of the specified type.

" + } + }, + "CreatedAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only contexts created on or after the specified time.

" + } + }, + "CreatedBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only contexts created on or before the specified time.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#SortContextsBy", + "traits": { + "smithy.api#documentation": "

The property used to sort results. The default value is CreationTime.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

The sort order. The default value is Descending.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the previous call to ListContexts didn't return the full set of contexts,\n the call returns a token for getting the next set of contexts.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of contexts to return in the response. The default value is 10.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListContextsResponse": { + "type": "structure", + "members": { + "ContextSummaries": { + "target": "com.amazonaws.sagemaker#ContextSummaries", + "traits": { + "smithy.api#documentation": "

A list of contexts and their properties.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

A token for getting the next set of contexts, if there are any.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListDataQualityJobDefinitions": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListDataQualityJobDefinitionsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListDataQualityJobDefinitionsResponse" + }, + "traits": { + "smithy.api#documentation": "

Lists the data quality job definitions in your account.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "JobDefinitionSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListDataQualityJobDefinitionsRequest": { + "type": "structure", + "members": { + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#documentation": "

A filter that lists the data quality job definitions associated with the specified\n endpoint.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionSortKey", + "traits": { + "smithy.api#documentation": "

The field to sort results by. The default is CreationTime.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

Whether to sort the results in Ascending or Descending order. \n The default is Descending.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the result of the previous ListDataQualityJobDefinitions request was\n truncated, the response includes a NextToken. To retrieve the next set of\n transform jobs, use the token in the next request.>

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of data quality monitoring job definitions to return in the\n response.

" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "

A string in the data quality monitoring job definition name. This filter returns only\n data quality monitoring job definitions whose name contains the specified string.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only data quality monitoring job definitions created before the\n specified time.

" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only data quality monitoring job definitions created after the\n specified time.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListDataQualityJobDefinitionsResponse": { + "type": "structure", + "members": { + "JobDefinitionSummaries": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionSummaryList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A list of data quality monitoring job definitions.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the result of the previous ListDataQualityJobDefinitions request was\n truncated, the response includes a NextToken. To retrieve the next set of data\n quality monitoring job definitions, use the token in the next request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListDeviceFleets": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListDeviceFleetsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListDeviceFleetsResponse" + }, + "traits": { + "smithy.api#documentation": "

Returns a list of devices in the fleet.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "DeviceFleetSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListDeviceFleetsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

The response from the last list when returning a list large enough to need tokening.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#ListMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to select.

" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Filter fleets where packaging job was created after specified time.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Filter fleets where the edge packaging job was created before specified time.

" + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Select fleets where the job was updated after X

" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Select fleets where the job was updated before X

" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "

Filter for fleets containing this name in their fleet device name.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#ListDeviceFleetsSortBy", + "traits": { + "smithy.api#documentation": "

The column to sort by.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

What direction to sort in.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListDeviceFleetsResponse": { + "type": "structure", + "members": { + "DeviceFleetSummaries": { + "target": "com.amazonaws.sagemaker#DeviceFleetSummaries", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Summary of the device fleet.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

The response from the last list when returning a list large enough to need tokening.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListDeviceFleetsSortBy": { + "type": "enum", + "members": { + "Name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAME" + } + }, + "CreationTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_TIME" + } + }, + "LastModifiedTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAST_MODIFIED_TIME" + } + } + } + }, + "com.amazonaws.sagemaker#ListDevices": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListDevicesRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListDevicesResponse" + }, + "traits": { + "smithy.api#documentation": "

A list of devices.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "DeviceSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListDevicesRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

The response from the last list when returning a list large enough to need tokening.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#ListMaxResults", + "traits": { + "smithy.api#documentation": "

Maximum number of results to select.

" + } + }, + "LatestHeartbeatAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Select fleets where the job was updated after X

" + } + }, + "ModelName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#documentation": "

A filter that searches devices that contains this name in any of their models.

" + } + }, + "DeviceFleetName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#documentation": "

Filter for fleets containing this name in their device fleet name.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListDevicesResponse": { + "type": "structure", + "members": { + "DeviceSummaries": { + "target": "com.amazonaws.sagemaker#DeviceSummaries", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Summary of devices.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

The response from the last list when returning a list large enough to need tokening.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListDomains": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListDomainsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListDomainsResponse" + }, + "traits": { + "smithy.api#documentation": "

Lists the domains.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Domains", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListDomainsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

This parameter defines the maximum number of results that can be return in a single\n response. The MaxResults parameter is an upper bound, not a target. If there are\n more results available than the value specified, a NextToken is provided in the\n response. The NextToken indicates that the user should get the next set of\n results by providing this token as a part of a subsequent call. The default value for\n MaxResults is 10.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListDomainsResponse": { + "type": "structure", + "members": { + "Domains": { + "target": "com.amazonaws.sagemaker#DomainList", + "traits": { + "smithy.api#documentation": "

The list of domains.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListEdgeDeploymentPlans": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListEdgeDeploymentPlansRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListEdgeDeploymentPlansResponse" + }, + "traits": { + "smithy.api#documentation": "

Lists all edge deployment plans.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "EdgeDeploymentPlanSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListEdgeDeploymentPlansRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

The response from the last list when returning a list large enough to need\n tokening.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#ListMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to select (50 by default).

" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Selects edge deployment plans created after this time.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Selects edge deployment plans created before this time.

" + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Selects edge deployment plans that were last updated after this time.

" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Selects edge deployment plans that were last updated before this time.

" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "

Selects edge deployment plans with names containing this name.

" + } + }, + "DeviceFleetNameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "

Selects edge deployment plans with a device fleet name containing this name.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#ListEdgeDeploymentPlansSortBy", + "traits": { + "smithy.api#documentation": "

The column by which to sort the edge deployment plans. Can be one of\n NAME, DEVICEFLEETNAME, CREATIONTIME,\n LASTMODIFIEDTIME.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

The direction of the sorting (ascending or descending).

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListEdgeDeploymentPlansResponse": { + "type": "structure", + "members": { + "EdgeDeploymentPlanSummaries": { + "target": "com.amazonaws.sagemaker#EdgeDeploymentPlanSummaries", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

List of summaries of edge deployment plans.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

The token to use when calling the next page of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListEdgeDeploymentPlansSortBy": { + "type": "enum", + "members": { + "Name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAME" + } + }, + "DeviceFleetName": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEVICE_FLEET_NAME" + } + }, + "CreationTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_TIME" + } + }, + "LastModifiedTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAST_MODIFIED_TIME" + } + } + } + }, + "com.amazonaws.sagemaker#ListEdgePackagingJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListEdgePackagingJobsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListEdgePackagingJobsResponse" + }, + "traits": { + "smithy.api#documentation": "

Returns a list of edge packaging jobs.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "EdgePackagingJobSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListEdgePackagingJobsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

The response from the last list when returning a list large enough to need tokening.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#ListMaxResults", + "traits": { + "smithy.api#documentation": "

Maximum number of results to select.

" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Select jobs where the job was created after specified time.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Select jobs where the job was created before specified time.

" + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Select jobs where the job was updated after specified time.

" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Select jobs where the job was updated before specified time.

" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "

Filter for jobs containing this name in their packaging job name.

" + } + }, + "ModelNameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "

Filter for jobs where the model name contains this string.

" + } + }, + "StatusEquals": { + "target": "com.amazonaws.sagemaker#EdgePackagingJobStatus", + "traits": { + "smithy.api#documentation": "

The job status to filter for.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#ListEdgePackagingJobsSortBy", + "traits": { + "smithy.api#documentation": "

Use to specify what column to sort by.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

What direction to sort by.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListEdgePackagingJobsResponse": { + "type": "structure", + "members": { + "EdgePackagingJobSummaries": { + "target": "com.amazonaws.sagemaker#EdgePackagingJobSummaries", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Summaries of edge packaging jobs.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

Token to use when calling the next page of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListEdgePackagingJobsSortBy": { + "type": "enum", + "members": { + "Name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAME" + } + }, + "ModelName": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MODEL_NAME" + } + }, + "CreationTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_TIME" + } + }, + "LastModifiedTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAST_MODIFIED_TIME" + } + }, + "EdgePackagingJobStatus": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STATUS" + } + } + } + }, + "com.amazonaws.sagemaker#ListEndpointConfigs": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListEndpointConfigsInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListEndpointConfigsOutput" + }, + "traits": { + "smithy.api#documentation": "

Lists endpoint configurations.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "EndpointConfigs", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListEndpointConfigsInput": { + "type": "structure", + "members": { + "SortBy": { + "target": "com.amazonaws.sagemaker#EndpointConfigSortKey", + "traits": { + "smithy.api#documentation": "

The field to sort results by. The default is CreationTime.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#OrderKey", + "traits": { + "smithy.api#documentation": "

The sort order for results. The default is Descending.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#PaginationToken", + "traits": { + "smithy.api#documentation": "

If the result of the previous ListEndpointConfig request was\n truncated, the response includes a NextToken. To retrieve the next set of\n endpoint configurations, use the token in the next request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of training jobs to return in the response.

" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#EndpointConfigNameContains", + "traits": { + "smithy.api#documentation": "

A string in the endpoint configuration name. This filter returns only endpoint\n configurations whose name contains the specified string.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only endpoint configurations created before the specified\n time (timestamp).

" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only endpoint configurations with a creation time greater\n than or equal to the specified time (timestamp).

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListEndpointConfigsOutput": { + "type": "structure", + "members": { + "EndpointConfigs": { + "target": "com.amazonaws.sagemaker#EndpointConfigSummaryList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An array of endpoint configurations.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#PaginationToken", + "traits": { + "smithy.api#documentation": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of\n endpoint configurations, use it in the subsequent request

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListEndpoints": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListEndpointsInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListEndpointsOutput" + }, + "traits": { + "smithy.api#documentation": "

Lists endpoints.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Endpoints", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListEndpointsInput": { + "type": "structure", + "members": { + "SortBy": { + "target": "com.amazonaws.sagemaker#EndpointSortKey", + "traits": { + "smithy.api#documentation": "

Sorts the list of results. The default is CreationTime.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#OrderKey", + "traits": { + "smithy.api#documentation": "

The sort order for results. The default is Descending.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#PaginationToken", + "traits": { + "smithy.api#documentation": "

If the result of a ListEndpoints request was truncated, the response\n includes a NextToken. To retrieve the next set of endpoints, use the token\n in the next request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of endpoints to return in the response. This value defaults to\n 10.

" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#EndpointNameContains", + "traits": { + "smithy.api#documentation": "

A string in endpoint names. This filter returns only endpoints whose name contains\n the specified string.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only endpoints that were created before the specified time\n (timestamp).

" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only endpoints with a creation time greater than or equal to\n the specified time (timestamp).

" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only endpoints that were modified before the specified\n timestamp.

" + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only endpoints that were modified after the specified\n timestamp.

" + } + }, + "StatusEquals": { + "target": "com.amazonaws.sagemaker#EndpointStatus", + "traits": { + "smithy.api#documentation": "

A filter that returns only endpoints with the specified status.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListEndpointsOutput": { + "type": "structure", + "members": { + "Endpoints": { + "target": "com.amazonaws.sagemaker#EndpointSummaryList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An array or endpoint objects.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#PaginationToken", + "traits": { + "smithy.api#documentation": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of\n training jobs, use it in the subsequent request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListExperiments": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListExperimentsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListExperimentsResponse" + }, + "traits": { + "smithy.api#documentation": "

Lists all the experiments in your account. The list can be filtered to show only\n experiments that were created in a specific time range. The list can be sorted by experiment\n name or creation time.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ExperimentSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListExperimentsRequest": { + "type": "structure", + "members": { + "CreatedAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only experiments created after the specified time.

" + } + }, + "CreatedBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only experiments created before the specified time.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#SortExperimentsBy", + "traits": { + "smithy.api#documentation": "

The property used to sort results. The default value is CreationTime.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

The sort order. The default value is Descending.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the previous call to ListExperiments didn't return the full set of\n experiments, the call returns a token for getting the next set of experiments.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of experiments to return in the response. The default value is\n 10.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListExperimentsResponse": { + "type": "structure", + "members": { + "ExperimentSummaries": { + "target": "com.amazonaws.sagemaker#ExperimentSummaries", + "traits": { + "smithy.api#documentation": "

A list of the summaries of your experiments.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

A token for getting the next set of experiments, if there are any.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListFeatureGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListFeatureGroupsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListFeatureGroupsResponse" + }, + "traits": { + "smithy.api#documentation": "

List FeatureGroups based on given filter and order.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "FeatureGroupSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListFeatureGroupsRequest": { + "type": "structure", + "members": { + "NameContains": { + "target": "com.amazonaws.sagemaker#FeatureGroupNameContains", + "traits": { + "smithy.api#documentation": "

A string that partially matches one or more FeatureGroups names. Filters\n FeatureGroups by name.

" + } + }, + "FeatureGroupStatusEquals": { + "target": "com.amazonaws.sagemaker#FeatureGroupStatus", + "traits": { + "smithy.api#documentation": "

A FeatureGroup status. Filters by FeatureGroup status.

" + } + }, + "OfflineStoreStatusEquals": { + "target": "com.amazonaws.sagemaker#OfflineStoreStatusValue", + "traits": { + "smithy.api#documentation": "

An OfflineStore status. Filters by OfflineStore status.\n

" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "

Use this parameter to search for FeatureGroupss created after a specific\n date and time.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "

Use this parameter to search for FeatureGroupss created before a specific\n date and time.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#FeatureGroupSortOrder", + "traits": { + "smithy.api#documentation": "

The order in which feature groups are listed.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#FeatureGroupSortBy", + "traits": { + "smithy.api#documentation": "

The value on which the feature group list is sorted.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#FeatureGroupMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results returned by ListFeatureGroups.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

A token to resume pagination of ListFeatureGroups results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListFeatureGroupsResponse": { + "type": "structure", + "members": { + "FeatureGroupSummaries": { + "target": "com.amazonaws.sagemaker#FeatureGroupSummaries", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A summary of feature groups.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

A token to resume pagination of ListFeatureGroups results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListFlowDefinitions": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListFlowDefinitionsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListFlowDefinitionsResponse" + }, + "traits": { + "smithy.api#documentation": "

Returns information about the flow definitions in your account.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "FlowDefinitionSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListFlowDefinitionsRequest": { + "type": "structure", + "members": { + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only flow definitions with a creation time greater than or equal to the specified timestamp.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only flow definitions that were created before the specified timestamp.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

An optional value that specifies whether you want the results sorted in Ascending or Descending order.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

A token to resume pagination.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListFlowDefinitionsResponse": { + "type": "structure", + "members": { + "FlowDefinitionSummaries": { + "target": "com.amazonaws.sagemaker#FlowDefinitionSummaries", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An array of objects describing the flow definitions.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

A token to resume pagination.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListHubContentVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListHubContentVersionsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListHubContentVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

List hub content versions.

" + } + }, + "com.amazonaws.sagemaker#ListHubContentVersionsRequest": { + "type": "structure", + "members": { + "HubName": { + "target": "com.amazonaws.sagemaker#HubNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the hub to list the content versions of.

", + "smithy.api#required": {} + } + }, + "HubContentType": { + "target": "com.amazonaws.sagemaker#HubContentType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of hub content to list versions of.

", + "smithy.api#required": {} + } + }, + "HubContentName": { + "target": "com.amazonaws.sagemaker#HubContentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the hub content.

", + "smithy.api#required": {} + } + }, + "MinVersion": { + "target": "com.amazonaws.sagemaker#HubContentVersion", + "traits": { + "smithy.api#documentation": "

The lower bound of the hub content versions to list.

" + } + }, + "MaxSchemaVersion": { + "target": "com.amazonaws.sagemaker#DocumentSchemaVersion", + "traits": { + "smithy.api#documentation": "

The upper bound of the hub content schema version.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Only list hub content versions that were created before the time specified.

" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Only list hub content versions that were created after the time specified.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#HubContentSortBy", + "traits": { + "smithy.api#documentation": "

Sort hub content versions by either name or creation time.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

Sort hub content versions by ascending or descending order.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of hub content versions to list.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the response to a previous ListHubContentVersions request was truncated, the response includes a NextToken. To retrieve the next set of hub content versions, use the token in the next request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListHubContentVersionsResponse": { + "type": "structure", + "members": { + "HubContentSummaries": { + "target": "com.amazonaws.sagemaker#HubContentInfoList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The summaries of the listed hub content versions.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of hub content versions, use it in the subsequent request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListHubContents": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListHubContentsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListHubContentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

List the contents of a hub.

" + } + }, + "com.amazonaws.sagemaker#ListHubContentsRequest": { + "type": "structure", + "members": { + "HubName": { + "target": "com.amazonaws.sagemaker#HubNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the hub to list the contents of.

", + "smithy.api#required": {} + } + }, + "HubContentType": { + "target": "com.amazonaws.sagemaker#HubContentType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of hub content to list.

", + "smithy.api#required": {} + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "

Only list hub content if the name contains the specified string.

" + } + }, + "MaxSchemaVersion": { + "target": "com.amazonaws.sagemaker#DocumentSchemaVersion", + "traits": { + "smithy.api#documentation": "

The upper bound of the hub content schema verion.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Only list hub content that was created before the time specified.

" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Only list hub content that was created after the time specified.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#HubContentSortBy", + "traits": { + "smithy.api#documentation": "

Sort hub content versions by either name or creation time.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

Sort hubs by ascending or descending order.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum amount of hub content to list.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the response to a previous ListHubContents request was truncated, the response includes a NextToken. To retrieve the next set of hub content, use the token in the next request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListHubContentsResponse": { + "type": "structure", + "members": { + "HubContentSummaries": { + "target": "com.amazonaws.sagemaker#HubContentInfoList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The summaries of the listed hub content.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of hub content, use it in the subsequent request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListHubs": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListHubsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListHubsResponse" + }, + "traits": { + "smithy.api#documentation": "

List all existing hubs.

" + } + }, + "com.amazonaws.sagemaker#ListHubsRequest": { + "type": "structure", + "members": { + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "

Only list hubs with names that contain the specified string.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Only list hubs that were created before the time specified.

" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Only list hubs that were created after the time specified.

" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Only list hubs that were last modified before the time specified.

" + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Only list hubs that were last modified after the time specified.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#HubSortBy", + "traits": { + "smithy.api#documentation": "

Sort hubs by either name or creation time.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

Sort hubs by ascending or descending order.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of hubs to list.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the response to a previous ListHubs request was truncated, the response includes a NextToken. To retrieve the next set of hubs, use the token in the next request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListHubsResponse": { + "type": "structure", + "members": { + "HubSummaries": { + "target": "com.amazonaws.sagemaker#HubInfoList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The summaries of the listed hubs.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of hubs, use it in the subsequent request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListHumanTaskUis": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListHumanTaskUisRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListHumanTaskUisResponse" + }, + "traits": { + "smithy.api#documentation": "

Returns information about the human task user interfaces in your account.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "HumanTaskUiSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListHumanTaskUisRequest": { + "type": "structure", + "members": { + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only human task user interfaces with a creation time greater than or equal to the specified timestamp.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only human task user interfaces that were created before the specified timestamp.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

An optional value that specifies whether you want the results sorted in Ascending or Descending order.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

A token to resume pagination.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListHumanTaskUisResponse": { + "type": "structure", + "members": { + "HumanTaskUiSummaries": { + "target": "com.amazonaws.sagemaker#HumanTaskUiSummaries", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An array of objects describing the human task user interfaces.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

A token to resume pagination.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListHyperParameterTuningJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListHyperParameterTuningJobsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListHyperParameterTuningJobsResponse" + }, + "traits": { + "smithy.api#documentation": "

Gets a list of HyperParameterTuningJobSummary objects that\n describe\n the hyperparameter tuning jobs launched in your account.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "HyperParameterTuningJobSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListHyperParameterTuningJobsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the result of the previous ListHyperParameterTuningJobs request was\n truncated, the response includes a NextToken. To retrieve the next set of\n tuning jobs, use the token in the next request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The\n maximum number of tuning jobs to return. The default value is\n 10.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobSortByOptions", + "traits": { + "smithy.api#documentation": "

The field to sort results by. The default is Name.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

The sort order for results. The default is Ascending.

" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "

A string in the tuning job name. This filter returns only tuning jobs whose name\n contains the specified string.

" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only tuning jobs that were created after the specified\n time.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only tuning jobs that were created before the specified\n time.

" + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only tuning jobs that were modified after the specified\n time.

" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only tuning jobs that were modified before the specified\n time.

" + } + }, + "StatusEquals": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobStatus", + "traits": { + "smithy.api#documentation": "

A filter that returns only tuning jobs with the specified status.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListHyperParameterTuningJobsResponse": { + "type": "structure", + "members": { + "HyperParameterTuningJobSummaries": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobSummaries", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A list of HyperParameterTuningJobSummary objects that\n describe\n the tuning jobs that the ListHyperParameterTuningJobs\n request returned.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the result of this ListHyperParameterTuningJobs request was truncated,\n the response includes a NextToken. To retrieve the next set of tuning jobs,\n use the token in the next request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListImageVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListImageVersionsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListImageVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the versions of a specified image and their properties. The list can be filtered\n by creation time or modified time.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ImageVersions", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListImageVersionsRequest": { + "type": "structure", + "members": { + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only versions created on or after the specified time.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only versions created on or before the specified time.

" + } + }, + "ImageName": { + "target": "com.amazonaws.sagemaker#ImageName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the image to list the versions of.

", + "smithy.api#required": {} + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only versions modified on or after the specified time.

" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only versions modified on or before the specified time.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of versions to return in the response. The default value is 10.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the previous call to ListImageVersions didn't return the full set of\n versions, the call returns a token for getting the next set of versions.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#ImageVersionSortBy", + "traits": { + "smithy.api#documentation": "

The property used to sort results. The default value is CREATION_TIME.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#ImageVersionSortOrder", + "traits": { + "smithy.api#documentation": "

The sort order. The default value is DESCENDING.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListImageVersionsResponse": { + "type": "structure", + "members": { + "ImageVersions": { + "target": "com.amazonaws.sagemaker#ImageVersions", + "traits": { + "smithy.api#documentation": "

A list of versions and their properties.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

A token for getting the next set of versions, if there are any.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListImages": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListImagesRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListImagesResponse" + }, + "traits": { + "smithy.api#documentation": "

Lists the images in your account and their properties. The list can be filtered by\n creation time or modified time, and whether the image name contains a specified string.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Images", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListImagesRequest": { + "type": "structure", + "members": { + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only images created on or after the specified time.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only images created on or before the specified time.

" + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only images modified on or after the specified time.

" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only images modified on or before the specified time.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of images to return in the response. The default value is 10.

" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#ImageNameContains", + "traits": { + "smithy.api#documentation": "

A filter that returns only images whose name contains the specified string.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the previous call to ListImages didn't return the full set of images,\n the call returns a token for getting the next set of images.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#ImageSortBy", + "traits": { + "smithy.api#documentation": "

The property used to sort results. The default value is CREATION_TIME.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#ImageSortOrder", + "traits": { + "smithy.api#documentation": "

The sort order. The default value is DESCENDING.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListImagesResponse": { + "type": "structure", + "members": { + "Images": { + "target": "com.amazonaws.sagemaker#Images", + "traits": { + "smithy.api#documentation": "

A list of images and their properties.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

A token for getting the next set of images, if there are any.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListInferenceComponents": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListInferenceComponentsInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListInferenceComponentsOutput" + }, + "traits": { + "smithy.api#documentation": "

Lists the inference components in your account and their properties.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "InferenceComponents", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListInferenceComponentsInput": { + "type": "structure", + "members": { + "SortBy": { + "target": "com.amazonaws.sagemaker#InferenceComponentSortKey", + "traits": { + "smithy.api#documentation": "

The field by which to sort the inference components in the response. The default is\n CreationTime.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#OrderKey", + "traits": { + "smithy.api#documentation": "

The sort order for results. The default is Descending.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#PaginationToken", + "traits": { + "smithy.api#documentation": "

A token that you use to get the next set of results following a truncated response. If\n the response to the previous request was truncated, that response provides the value for\n this token.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of inference components to return in the response. This value\n defaults to 10.

" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#InferenceComponentNameContains", + "traits": { + "smithy.api#documentation": "

Filters the results to only those inference components with a name that contains the\n specified string.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Filters the results to only those inference components that were created before the\n specified time.

" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Filters the results to only those inference components that were created after the\n specified time.

" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Filters the results to only those inference components that were updated before the\n specified time.

" + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Filters the results to only those inference components that were updated after the\n specified time.

" + } + }, + "StatusEquals": { + "target": "com.amazonaws.sagemaker#InferenceComponentStatus", + "traits": { + "smithy.api#documentation": "

Filters the results to only those inference components with the specified status.

" + } + }, + "EndpointNameEquals": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#documentation": "

An endpoint name to filter the listed inference components. The response includes only\n those inference components that are hosted at the specified endpoint.

" + } + }, + "VariantNameEquals": { + "target": "com.amazonaws.sagemaker#VariantName", + "traits": { + "smithy.api#documentation": "

A production variant name to filter the listed inference components. The response\n includes only those inference components that are hosted at the specified variant.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListInferenceComponentsOutput": { + "type": "structure", + "members": { + "InferenceComponents": { + "target": "com.amazonaws.sagemaker#InferenceComponentSummaryList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A list of inference components and their properties that matches any of the filters you\n specified in the request.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token to use in a subsequent request to get the next set of results following a\n truncated response.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListInferenceExperiments": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListInferenceExperimentsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListInferenceExperimentsResponse" + }, + "traits": { + "smithy.api#documentation": "

Returns the list of all inference experiments.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "InferenceExperiments", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListInferenceExperimentsRequest": { + "type": "structure", + "members": { + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "

Selects inference experiments whose names contain this name.

" + } + }, + "Type": { + "target": "com.amazonaws.sagemaker#InferenceExperimentType", + "traits": { + "smithy.api#documentation": "

\n Selects inference experiments of this type. For the possible types of inference experiments, see CreateInferenceExperiment.\n

" + } + }, + "StatusEquals": { + "target": "com.amazonaws.sagemaker#InferenceExperimentStatus", + "traits": { + "smithy.api#documentation": "

\n Selects inference experiments which are in this status. For the possible statuses, see DescribeInferenceExperiment.\n

" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Selects inference experiments which were created after this timestamp.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Selects inference experiments which were created before this timestamp.

" + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Selects inference experiments which were last modified after this timestamp.

" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Selects inference experiments which were last modified before this timestamp.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#SortInferenceExperimentsBy", + "traits": { + "smithy.api#documentation": "

The column by which to sort the listed inference experiments.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

The direction of sorting (ascending or descending).

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

\n The response from the last list when returning a list large enough to need tokening.\n

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to select.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListInferenceExperimentsResponse": { + "type": "structure", + "members": { + "InferenceExperiments": { + "target": "com.amazonaws.sagemaker#InferenceExperimentList", + "traits": { + "smithy.api#documentation": "

List of inference experiments.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

The token to use when calling the next page of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListInferenceRecommendationsJobSteps": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListInferenceRecommendationsJobStepsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListInferenceRecommendationsJobStepsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of the subtasks for an Inference Recommender job.

\n

The supported subtasks are benchmarks, which evaluate the performance of your model on different instance types.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Steps", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListInferenceRecommendationsJobStepsRequest": { + "type": "structure", + "members": { + "JobName": { + "target": "com.amazonaws.sagemaker#RecommendationJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name for the Inference Recommender job.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#RecommendationJobStatus", + "traits": { + "smithy.api#documentation": "

A filter to return benchmarks of a specified status. If this field is left empty, then all benchmarks are returned.

" + } + }, + "StepType": { + "target": "com.amazonaws.sagemaker#RecommendationStepType", + "traits": { + "smithy.api#documentation": "

A filter to return details about the specified type of subtask.

\n

\n BENCHMARK: Evaluate the performance of your model on different instance types.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

A token that you can specify to return more results from the list. Specify this field if you have a token that was returned from a previous request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListInferenceRecommendationsJobStepsResponse": { + "type": "structure", + "members": { + "Steps": { + "target": "com.amazonaws.sagemaker#InferenceRecommendationsJobSteps", + "traits": { + "smithy.api#documentation": "

A list of all subtask details in Inference Recommender.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

A token that you can specify in your next request to return more results from the list.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListInferenceRecommendationsJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListInferenceRecommendationsJobsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListInferenceRecommendationsJobsResponse" + }, + "traits": { + "smithy.api#documentation": "

Lists recommendation jobs that satisfy various filters.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "InferenceRecommendationsJobs", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListInferenceRecommendationsJobsRequest": { + "type": "structure", + "members": { + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "

A filter that returns only jobs created after the specified time (timestamp).

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "

A filter that returns only jobs created before the specified time (timestamp).

" + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "

A filter that returns only jobs that were last modified after the specified time (timestamp).

" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "

A filter that returns only jobs that were last modified before the specified time (timestamp).

" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "

A string in the job name. This filter returns only recommendations whose name contains the specified string.

" + } + }, + "StatusEquals": { + "target": "com.amazonaws.sagemaker#RecommendationJobStatus", + "traits": { + "smithy.api#documentation": "

A filter that retrieves only inference recommendations jobs with a specific status.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#ListInferenceRecommendationsJobsSortBy", + "traits": { + "smithy.api#documentation": "

The parameter by which to sort the results.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

The sort order for the results.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the response to a previous ListInferenceRecommendationsJobsRequest request \n was truncated, the response includes a NextToken. To retrieve the next set \n of recommendations, use the token in the next request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of recommendations to return in the response.

" + } + }, + "ModelNameEquals": { + "target": "com.amazonaws.sagemaker#ModelName", + "traits": { + "smithy.api#documentation": "

A filter that returns only jobs that were created for this model.

" + } + }, + "ModelPackageVersionArnEquals": { + "target": "com.amazonaws.sagemaker#ModelPackageArn", + "traits": { + "smithy.api#documentation": "

A filter that returns only jobs that were created for this versioned model package.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListInferenceRecommendationsJobsResponse": { + "type": "structure", + "members": { + "InferenceRecommendationsJobs": { + "target": "com.amazonaws.sagemaker#InferenceRecommendationsJobs", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The recommendations created from the Amazon SageMaker Inference Recommender job.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

A token for getting the next set of recommendations, if there are any.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListInferenceRecommendationsJobsSortBy": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + } + } + }, + "com.amazonaws.sagemaker#ListLabelingJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListLabelingJobsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListLabelingJobsResponse" + }, + "traits": { + "smithy.api#documentation": "

Gets a list of labeling jobs.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "LabelingJobSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListLabelingJobsForWorkteam": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListLabelingJobsForWorkteamRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListLabelingJobsForWorkteamResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a list of labeling jobs assigned to a specified work team.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "LabelingJobSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListLabelingJobsForWorkteamRequest": { + "type": "structure", + "members": { + "WorkteamArn": { + "target": "com.amazonaws.sagemaker#WorkteamArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the work team for which you want to see labeling\n jobs for.

", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of labeling jobs to return in each page of the response.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the result of the previous ListLabelingJobsForWorkteam request was\n truncated, the response includes a NextToken. To retrieve the next set of\n labeling jobs, use the token in the next request.

" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only labeling jobs created after the specified time\n (timestamp).

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only labeling jobs created before the specified time\n (timestamp).

" + } + }, + "JobReferenceCodeContains": { + "target": "com.amazonaws.sagemaker#JobReferenceCodeContains", + "traits": { + "smithy.api#documentation": "

A filter the limits jobs to only the ones whose job reference code contains the\n specified string.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#ListLabelingJobsForWorkteamSortByOptions", + "traits": { + "smithy.api#documentation": "

The field to sort results by. The default is CreationTime.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

The sort order for results. The default is Ascending.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListLabelingJobsForWorkteamResponse": { + "type": "structure", + "members": { + "LabelingJobSummaryList": { + "target": "com.amazonaws.sagemaker#LabelingJobForWorkteamSummaryList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An array of LabelingJobSummary objects, each describing a labeling\n job.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of\n labeling jobs, use it in the subsequent request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListLabelingJobsForWorkteamSortByOptions": { + "type": "enum", + "members": { + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + } + } + }, + "com.amazonaws.sagemaker#ListLabelingJobsRequest": { + "type": "structure", + "members": { + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only labeling jobs created after the specified time\n (timestamp).

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only labeling jobs created before the specified time\n (timestamp).

" + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only labeling jobs modified after the specified time\n (timestamp).

" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only labeling jobs modified before the specified time\n (timestamp).

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of labeling jobs to return in each page of the response.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the result of the previous ListLabelingJobs request was truncated, the\n response includes a NextToken. To retrieve the next set of labeling jobs,\n use the token in the next request.

" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "

A string in the labeling job name. This filter returns only labeling jobs whose name\n contains the specified string.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#SortBy", + "traits": { + "smithy.api#documentation": "

The field to sort results by. The default is CreationTime.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

The sort order for results. The default is Ascending.

" + } + }, + "StatusEquals": { + "target": "com.amazonaws.sagemaker#LabelingJobStatus", + "traits": { + "smithy.api#documentation": "

A filter that retrieves only labeling jobs with a specific status.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListLabelingJobsResponse": { + "type": "structure", + "members": { + "LabelingJobSummaryList": { + "target": "com.amazonaws.sagemaker#LabelingJobSummaryList", + "traits": { + "smithy.api#documentation": "

An array of LabelingJobSummary objects, each describing a labeling\n job.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of\n labeling jobs, use it in the subsequent request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListLineageEntityParameterKey": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#StringParameterValue" + } + }, + "com.amazonaws.sagemaker#ListLineageGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListLineageGroupsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListLineageGroupsResponse" + }, + "traits": { + "smithy.api#documentation": "

A list of lineage groups shared with your Amazon Web Services account. \n For more information, see \n Cross-Account Lineage Tracking in the Amazon SageMaker Developer Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "LineageGroupSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListLineageGroupsRequest": { + "type": "structure", + "members": { + "CreatedAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A timestamp to filter against lineage groups created after a certain point in time.

" + } + }, + "CreatedBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A timestamp to filter against lineage groups created before a certain point in time.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#SortLineageGroupsBy", + "traits": { + "smithy.api#documentation": "

The parameter by which to sort the results. The default is\n CreationTime.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

The sort order for the results. The default is Ascending.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of\n algorithms, use it in the subsequent request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of endpoints to return in the response. This value defaults to\n 10.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListLineageGroupsResponse": { + "type": "structure", + "members": { + "LineageGroupSummaries": { + "target": "com.amazonaws.sagemaker#LineageGroupSummaries", + "traits": { + "smithy.api#documentation": "

A list of lineage groups and their properties.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of\n algorithms, use it in the subsequent request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#ListMlflowTrackingServers": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListMlflowTrackingServersRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListMlflowTrackingServersResponse" + }, + "traits": { + "smithy.api#documentation": "

Lists all MLflow Tracking Servers.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TrackingServerSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListMlflowTrackingServersRequest": { + "type": "structure", + "members": { + "CreatedAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Use the CreatedAfter filter to only list tracking servers created after a\n specific date and time. Listed tracking servers are shown with a date and time such as\n \"2024-03-16T01:46:56+00:00\". The CreatedAfter parameter takes in a\n Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.

" + } + }, + "CreatedBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Use the CreatedBefore filter to only list tracking servers created before a\n specific date and time. Listed tracking servers are shown with a date and time such as\n \"2024-03-16T01:46:56+00:00\". The CreatedBefore parameter takes in\n a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.

" + } + }, + "TrackingServerStatus": { + "target": "com.amazonaws.sagemaker#TrackingServerStatus", + "traits": { + "smithy.api#documentation": "

Filter for tracking servers with a specified creation status.

" + } + }, + "MlflowVersion": { + "target": "com.amazonaws.sagemaker#MlflowVersion", + "traits": { + "smithy.api#documentation": "

Filter for tracking servers using the specified MLflow version.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#SortTrackingServerBy", + "traits": { + "smithy.api#documentation": "

Filter for trackings servers sorting by name, creation time, or creation status.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

Change the order of the listed tracking servers. By default, tracking servers are listed in Descending order by creation time. \n To change the list order, you can specify SortOrder to be Ascending.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of tracking servers to list.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListMlflowTrackingServersResponse": { + "type": "structure", + "members": { + "TrackingServerSummaries": { + "target": "com.amazonaws.sagemaker#TrackingServerSummaryList", + "traits": { + "smithy.api#documentation": "

A list of tracking servers according to chosen filters.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListModelBiasJobDefinitions": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListModelBiasJobDefinitionsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListModelBiasJobDefinitionsResponse" + }, + "traits": { + "smithy.api#documentation": "

Lists model bias jobs definitions that satisfy various filters.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "JobDefinitionSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListModelBiasJobDefinitionsRequest": { + "type": "structure", + "members": { + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#documentation": "

Name of the endpoint to monitor for model bias.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionSortKey", + "traits": { + "smithy.api#documentation": "

Whether to sort results by the Name or CreationTime field. \n The default is CreationTime.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

Whether to sort the results in Ascending or Descending order. \n The default is Descending.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned if the response is truncated. To retrieve the next set of job executions, use \n it in the next request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of model bias jobs to return in the response. The default value is\n 10.

" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "

Filter for model bias jobs whose name contains a specified string.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only model bias jobs created before a specified time.

" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only model bias jobs created after a specified time.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListModelBiasJobDefinitionsResponse": { + "type": "structure", + "members": { + "JobDefinitionSummaries": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionSummaryList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A JSON array in which each element is a summary for a model bias jobs.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned if the response is truncated. To retrieve the next set of job executions, use \n it in the next request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListModelCardExportJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListModelCardExportJobsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListModelCardExportJobsResponse" + }, + "traits": { + "smithy.api#documentation": "

List the export jobs for the Amazon SageMaker Model Card.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ModelCardExportJobSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListModelCardExportJobsRequest": { + "type": "structure", + "members": { + "ModelCardName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

List export jobs for the model card with the specified name.

", + "smithy.api#required": {} + } + }, + "ModelCardVersion": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "

List export jobs for the model card with the specified version.

" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Only list model card export jobs that were created after the time specified.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Only list model card export jobs that were created before the time specified.

" + } + }, + "ModelCardExportJobNameContains": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#documentation": "

Only list model card export jobs with names that contain the specified string.

" + } + }, + "StatusEquals": { + "target": "com.amazonaws.sagemaker#ModelCardExportJobStatus", + "traits": { + "smithy.api#documentation": "

Only list model card export jobs with the specified status.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#ModelCardExportJobSortBy", + "traits": { + "smithy.api#documentation": "

Sort model card export jobs by either name or creation time. Sorts by creation time by default.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#ModelCardExportJobSortOrder", + "traits": { + "smithy.api#documentation": "

Sort model card export jobs by ascending or descending order.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the response to a previous ListModelCardExportJobs request was\n truncated, the response includes a NextToken. To retrieve the next set of\n model card export jobs, use the token in the next request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of model card export jobs to list.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListModelCardExportJobsResponse": { + "type": "structure", + "members": { + "ModelCardExportJobSummaries": { + "target": "com.amazonaws.sagemaker#ModelCardExportJobSummaryList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The summaries of the listed model card export jobs.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of model\n card export jobs, use it in the subsequent request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListModelCardVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListModelCardVersionsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListModelCardVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

List existing versions of an Amazon SageMaker Model Card.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ModelCardVersionSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListModelCardVersionsRequest": { + "type": "structure", + "members": { + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Only list model card versions that were created after the time specified.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Only list model card versions that were created before the time specified.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of model card versions to list.

" + } + }, + "ModelCardName": { + "target": "com.amazonaws.sagemaker#ModelCardNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

List model card versions for the model card with the specified name or Amazon Resource Name (ARN).

", + "smithy.api#required": {} + } + }, + "ModelCardStatus": { + "target": "com.amazonaws.sagemaker#ModelCardStatus", + "traits": { + "smithy.api#documentation": "

Only list model card versions with the specified approval status.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the response to a previous ListModelCardVersions request was truncated,\n the response includes a NextToken. To retrieve the next set of model card\n versions, use the token in the next request.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#ModelCardVersionSortBy", + "traits": { + "smithy.api#documentation": "

Sort listed model card versions by version. Sorts by version by default.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#ModelCardSortOrder", + "traits": { + "smithy.api#documentation": "

Sort model card versions by ascending or descending order.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListModelCardVersionsResponse": { + "type": "structure", + "members": { + "ModelCardVersionSummaryList": { + "target": "com.amazonaws.sagemaker#ModelCardVersionSummaryList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The summaries of the listed versions of the model card.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of model\n card versions, use it in the subsequent request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListModelCards": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListModelCardsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListModelCardsResponse" + }, + "traits": { + "smithy.api#documentation": "

List existing model cards.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ModelCardSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListModelCardsRequest": { + "type": "structure", + "members": { + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Only list model cards that were created after the time specified.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Only list model cards that were created before the time specified.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of model cards to list.

" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#documentation": "

Only list model cards with names that contain the specified string.

" + } + }, + "ModelCardStatus": { + "target": "com.amazonaws.sagemaker#ModelCardStatus", + "traits": { + "smithy.api#documentation": "

Only list model cards with the specified approval status.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the response to a previous ListModelCards request was truncated, the\n response includes a NextToken. To retrieve the next set of model cards, use\n the token in the next request.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#ModelCardSortBy", + "traits": { + "smithy.api#documentation": "

Sort model cards by either name or creation time. Sorts by creation time by default.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#ModelCardSortOrder", + "traits": { + "smithy.api#documentation": "

Sort model cards by ascending or descending order.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListModelCardsResponse": { + "type": "structure", + "members": { + "ModelCardSummaries": { + "target": "com.amazonaws.sagemaker#ModelCardSummaryList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The summaries of the listed model cards.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of model\n cards, use it in the subsequent request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListModelExplainabilityJobDefinitions": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListModelExplainabilityJobDefinitionsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListModelExplainabilityJobDefinitionsResponse" + }, + "traits": { + "smithy.api#documentation": "

Lists model explainability job definitions that satisfy various filters.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "JobDefinitionSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListModelExplainabilityJobDefinitionsRequest": { + "type": "structure", + "members": { + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#documentation": "

Name of the endpoint to monitor for model explainability.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionSortKey", + "traits": { + "smithy.api#documentation": "

Whether to sort results by the Name or CreationTime field. \n The default is CreationTime.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

Whether to sort the results in Ascending or Descending order. \n The default is Descending.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned if the response is truncated. To retrieve the next set of job executions, use \n it in the next request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of jobs to return in the response. The default value is 10.

" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "

Filter for model explainability jobs whose name contains a specified string.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only model explainability jobs created before a specified\n time.

" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only model explainability jobs created after a specified\n time.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListModelExplainabilityJobDefinitionsResponse": { + "type": "structure", + "members": { + "JobDefinitionSummaries": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionSummaryList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A JSON array in which each element is a summary for a explainability bias jobs.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned if the response is truncated. To retrieve the next set of job executions, use \n it in the next request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListModelMetadata": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListModelMetadataRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListModelMetadataResponse" + }, + "traits": { + "smithy.api#documentation": "

Lists the domain, framework, task, and model name of standard \n machine learning models found in common model zoos.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ModelMetadataSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListModelMetadataRequest": { + "type": "structure", + "members": { + "SearchExpression": { + "target": "com.amazonaws.sagemaker#ModelMetadataSearchExpression", + "traits": { + "smithy.api#documentation": "

One or more filters that searches for the specified resource or resources \n in a search. All resource objects that satisfy the expression's condition are \n included in the search results. Specify the Framework, FrameworkVersion, Domain \n or Task to filter supported. Filter names and values are case-sensitive.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the response to a previous ListModelMetadataResponse request was truncated, \n the response includes a NextToken. To retrieve the next set of model metadata, \n use the token in the next request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of models to return in the response.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListModelMetadataResponse": { + "type": "structure", + "members": { + "ModelMetadataSummaries": { + "target": "com.amazonaws.sagemaker#ModelMetadataSummaries", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A structure that holds model metadata.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

A token for getting the next set of recommendations, if there are any.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListModelPackageGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListModelPackageGroupsInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListModelPackageGroupsOutput" + }, + "traits": { + "smithy.api#documentation": "

Gets a list of the model groups in your Amazon Web Services account.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ModelPackageGroupSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListModelPackageGroupsInput": { + "type": "structure", + "members": { + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "

A filter that returns only model groups created after the specified time.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "

A filter that returns only model groups created before the specified time.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in the response.

" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "

A string in the model group name. This filter returns only model groups whose name\n contains the specified string.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the result of the previous ListModelPackageGroups request was\n truncated, the response includes a NextToken. To retrieve the next set of\n model groups, use the token in the next request.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#ModelPackageGroupSortBy", + "traits": { + "smithy.api#documentation": "

The field to sort results by. The default is CreationTime.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

The sort order for results. The default is Ascending.

" + } + }, + "CrossAccountFilterOption": { + "target": "com.amazonaws.sagemaker#CrossAccountFilterOption", + "traits": { + "smithy.api#documentation": "

A filter that returns either model groups shared with you or model groups in\n\t your own account. When the value is CrossAccount, the results show\n\t the resources made discoverable to you from other accounts. When the value is\n SameAccount or null, the results show resources from your\n \t account. The default is SameAccount.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListModelPackageGroupsOutput": { + "type": "structure", + "members": { + "ModelPackageGroupSummaryList": { + "target": "com.amazonaws.sagemaker#ModelPackageGroupSummaryList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A list of summaries of the model groups in your Amazon Web Services account.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the response is truncated, SageMaker returns this token. To retrieve the next set\n of model groups, use it in the subsequent request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListModelPackages": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListModelPackagesInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListModelPackagesOutput" + }, + "traits": { + "smithy.api#documentation": "

Lists the model packages that have been created.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ModelPackageSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListModelPackagesInput": { + "type": "structure", + "members": { + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "

A filter that returns only model packages created after the specified time\n (timestamp).

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "

A filter that returns only model packages created before the specified time\n (timestamp).

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of model packages to return in the response.

" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "

A string in the model package name. This filter returns only model packages whose name\n contains the specified string.

" + } + }, + "ModelApprovalStatus": { + "target": "com.amazonaws.sagemaker#ModelApprovalStatus", + "traits": { + "smithy.api#documentation": "

A filter that returns only the model packages with the specified approval\n status.

" + } + }, + "ModelPackageGroupName": { + "target": "com.amazonaws.sagemaker#ArnOrName", + "traits": { + "smithy.api#documentation": "

A filter that returns only model versions that belong to the specified model group.

" + } + }, + "ModelPackageType": { + "target": "com.amazonaws.sagemaker#ModelPackageType", + "traits": { + "smithy.api#documentation": "

A filter that returns only the model packages of the specified type. This can be one\n of the following values.

\n
    \n
  • \n

    \n UNVERSIONED - List only unversioined models. \n This is the default value if no ModelPackageType is specified.

    \n
    • \n
  • \n

    \n VERSIONED - List only versioned models.

    \n
    • \n
  • \n

    \n BOTH - List both versioned and unversioned models.

    \n
    • \n
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the response to a previous ListModelPackages request was truncated,\n the response includes a NextToken. To retrieve the next set of model\n packages, use the token in the next request.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#ModelPackageSortBy", + "traits": { + "smithy.api#documentation": "

The parameter by which to sort the results. The default is\n CreationTime.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

The sort order for the results. The default is Ascending.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListModelPackagesOutput": { + "type": "structure", + "members": { + "ModelPackageSummaryList": { + "target": "com.amazonaws.sagemaker#ModelPackageSummaryList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An array of ModelPackageSummary objects, each of which lists a model\n package.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of\n model packages, use it in the subsequent request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListModelQualityJobDefinitions": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListModelQualityJobDefinitionsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListModelQualityJobDefinitionsResponse" + }, + "traits": { + "smithy.api#documentation": "

Gets a list of model quality monitoring job definitions in your account.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "JobDefinitionSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListModelQualityJobDefinitionsRequest": { + "type": "structure", + "members": { + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#documentation": "

A filter that returns only model quality monitoring job definitions that are associated\n with the specified endpoint.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionSortKey", + "traits": { + "smithy.api#documentation": "

The field to sort results by. The default is CreationTime.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

Whether to sort the results in Ascending or Descending order. \n The default is Descending.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the result of the previous ListModelQualityJobDefinitions request was\n truncated, the response includes a NextToken. To retrieve the next set of\n model quality monitoring job definitions, use the token in the next request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in a call to\n ListModelQualityJobDefinitions.

" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "

A string in the transform job name. This filter returns only model quality monitoring\n job definitions whose name contains the specified string.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only model quality monitoring job definitions created before the\n specified time.

" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only model quality monitoring job definitions created after the\n specified time.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListModelQualityJobDefinitionsResponse": { + "type": "structure", + "members": { + "JobDefinitionSummaries": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionSummaryList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A list of summaries of model quality monitoring job definitions.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the response is truncated, Amazon SageMaker AI returns this token. To retrieve the\n next set of model quality monitoring job definitions, use it in the next request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListModels": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListModelsInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListModelsOutput" + }, + "traits": { + "smithy.api#documentation": "

Lists models created with the CreateModel API.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Models", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListModelsInput": { + "type": "structure", + "members": { + "SortBy": { + "target": "com.amazonaws.sagemaker#ModelSortKey", + "traits": { + "smithy.api#documentation": "

Sorts the list of results. The default is CreationTime.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#OrderKey", + "traits": { + "smithy.api#documentation": "

The sort order for results. The default is Descending.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#PaginationToken", + "traits": { + "smithy.api#documentation": "

If the response to a previous ListModels request was truncated, the\n response includes a NextToken. To retrieve the next set of models, use the\n token in the next request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of models to return in the response.

" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#ModelNameContains", + "traits": { + "smithy.api#documentation": "

A string in the model name. This filter returns only models whose name contains the\n specified string.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only models created before the specified time\n (timestamp).

" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only models with a creation time greater than or equal to the\n specified time (timestamp).

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListModelsOutput": { + "type": "structure", + "members": { + "Models": { + "target": "com.amazonaws.sagemaker#ModelSummaryList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An array of ModelSummary objects, each of which lists a\n model.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#PaginationToken", + "traits": { + "smithy.api#documentation": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of\n models, use it in the subsequent request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListMonitoringAlertHistory": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListMonitoringAlertHistoryRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListMonitoringAlertHistoryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a list of past alerts in a model monitoring schedule.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "MonitoringAlertHistory", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListMonitoringAlertHistoryRequest": { + "type": "structure", + "members": { + "MonitoringScheduleName": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleName", + "traits": { + "smithy.api#documentation": "

The name of a monitoring schedule.

" + } + }, + "MonitoringAlertName": { + "target": "com.amazonaws.sagemaker#MonitoringAlertName", + "traits": { + "smithy.api#documentation": "

The name of a monitoring alert.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#MonitoringAlertHistorySortKey", + "traits": { + "smithy.api#documentation": "

The field used to sort results. The default is CreationTime.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

The sort order, whether Ascending or Descending, of the alert\n history. The default is Descending.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the result of the previous ListMonitoringAlertHistory request was\n truncated, the response includes a NextToken. To retrieve the next set of\n alerts in the history, use the token in the next request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to display. The default is 100.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only alerts created on or before the specified time.

" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only alerts created on or after the specified time.

" + } + }, + "StatusEquals": { + "target": "com.amazonaws.sagemaker#MonitoringAlertStatus", + "traits": { + "smithy.api#documentation": "

A filter that retrieves only alerts with a specific status.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListMonitoringAlertHistoryResponse": { + "type": "structure", + "members": { + "MonitoringAlertHistory": { + "target": "com.amazonaws.sagemaker#MonitoringAlertHistoryList", + "traits": { + "smithy.api#documentation": "

An alert history for a model monitoring schedule.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of\n alerts, use it in the subsequent request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListMonitoringAlerts": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListMonitoringAlertsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListMonitoringAlertsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the alerts for a single monitoring schedule.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "MonitoringAlertSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListMonitoringAlertsRequest": { + "type": "structure", + "members": { + "MonitoringScheduleName": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of a monitoring schedule.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the result of the previous ListMonitoringAlerts request was truncated,\n the response includes a NextToken. To retrieve the next set of alerts in the\n history, use the token in the next request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to display. The default is 100.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListMonitoringAlertsResponse": { + "type": "structure", + "members": { + "MonitoringAlertSummaries": { + "target": "com.amazonaws.sagemaker#MonitoringAlertSummaryList", + "traits": { + "smithy.api#documentation": "

A JSON array where each element is a summary for a monitoring alert.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of\n alerts, use it in the subsequent request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListMonitoringExecutions": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListMonitoringExecutionsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListMonitoringExecutionsResponse" + }, + "traits": { + "smithy.api#documentation": "

Returns list of all monitoring job executions.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "MonitoringExecutionSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListMonitoringExecutionsRequest": { + "type": "structure", + "members": { + "MonitoringScheduleName": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleName", + "traits": { + "smithy.api#documentation": "

Name of a specific schedule to fetch jobs for.

" + } + }, + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#documentation": "

Name of a specific endpoint to fetch jobs for.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#MonitoringExecutionSortKey", + "traits": { + "smithy.api#documentation": "

Whether to sort the results by the Status, CreationTime, or \n ScheduledTime field. The default is CreationTime.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

Whether to sort the results in Ascending or Descending order. \n The default is Descending.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned if the response is truncated. To retrieve the next set of job executions, use \n it in the next request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of jobs to return in the response. The default value is 10.

" + } + }, + "ScheduledTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Filter for jobs scheduled before a specified time.

" + } + }, + "ScheduledTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Filter for jobs scheduled after a specified time.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only jobs created before a specified time.

" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only jobs created after a specified time.

" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only jobs modified after a specified time.

" + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only jobs modified before a specified time.

" + } + }, + "StatusEquals": { + "target": "com.amazonaws.sagemaker#ExecutionStatus", + "traits": { + "smithy.api#documentation": "

A filter that retrieves only jobs with a specific status.

" + } + }, + "MonitoringJobDefinitionName": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", + "traits": { + "smithy.api#documentation": "

Gets a list of the monitoring job runs of the specified monitoring job\n definitions.

" + } + }, + "MonitoringTypeEquals": { + "target": "com.amazonaws.sagemaker#MonitoringType", + "traits": { + "smithy.api#documentation": "

A filter that returns only the monitoring job runs of the specified monitoring\n type.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListMonitoringExecutionsResponse": { + "type": "structure", + "members": { + "MonitoringExecutionSummaries": { + "target": "com.amazonaws.sagemaker#MonitoringExecutionSummaryList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A JSON array in which each element is a summary for a monitoring execution.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned if the response is truncated. To retrieve the next set of job executions, use \n it in the next request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListMonitoringSchedules": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListMonitoringSchedulesRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListMonitoringSchedulesResponse" + }, + "traits": { + "smithy.api#documentation": "

Returns list of all monitoring schedules.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "MonitoringScheduleSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListMonitoringSchedulesRequest": { + "type": "structure", + "members": { + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#documentation": "

Name of a specific endpoint to fetch schedules for.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleSortKey", + "traits": { + "smithy.api#documentation": "

Whether to sort the results by the Status, CreationTime, or \n ScheduledTime field. The default is CreationTime.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

Whether to sort the results in Ascending or Descending order. \n The default is Descending.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned if the response is truncated. To retrieve the next set of job executions, use \n it in the next request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of jobs to return in the response. The default value is 10.

" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "

Filter for monitoring schedules whose name contains a specified string.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only monitoring schedules created before a specified time.

" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only monitoring schedules created after a specified time.

" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only monitoring schedules modified before a specified time.

" + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only monitoring schedules modified after a specified time.

" + } + }, + "StatusEquals": { + "target": "com.amazonaws.sagemaker#ScheduleStatus", + "traits": { + "smithy.api#documentation": "

A filter that returns only monitoring schedules modified before a specified time.

" + } + }, + "MonitoringJobDefinitionName": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", + "traits": { + "smithy.api#documentation": "

Gets a list of the monitoring schedules for the specified monitoring job\n definition.

" + } + }, + "MonitoringTypeEquals": { + "target": "com.amazonaws.sagemaker#MonitoringType", + "traits": { + "smithy.api#documentation": "

A filter that returns only the monitoring schedules for the specified monitoring\n type.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListMonitoringSchedulesResponse": { + "type": "structure", + "members": { + "MonitoringScheduleSummaries": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleSummaryList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A JSON array in which each element is a summary for a monitoring schedule.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned if the response is truncated. To retrieve the next set of job executions, use \n it in the next request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListNotebookInstanceLifecycleConfigs": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListNotebookInstanceLifecycleConfigsInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListNotebookInstanceLifecycleConfigsOutput" + }, + "traits": { + "smithy.api#documentation": "

Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "NotebookInstanceLifecycleConfigs", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListNotebookInstanceLifecycleConfigsInput": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the result of a ListNotebookInstanceLifecycleConfigs request was\n truncated, the response includes a NextToken. To get the next set of\n lifecycle configurations, use the token in the next request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of lifecycle configurations to return in the response.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigSortKey", + "traits": { + "smithy.api#documentation": "

Sorts the list of results. The default is CreationTime.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigSortOrder", + "traits": { + "smithy.api#documentation": "

The sort order for results.

" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigNameContains", + "traits": { + "smithy.api#documentation": "

A string in the lifecycle configuration name. This filter returns only lifecycle\n configurations whose name contains the specified string.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "

A filter that returns only lifecycle configurations that were created before the\n specified time (timestamp).

" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "

A filter that returns only lifecycle configurations that were created after the\n specified time (timestamp).

" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "

A filter that returns only lifecycle configurations that were modified before the\n specified time (timestamp).

" + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "

A filter that returns only lifecycle configurations that were modified after the\n specified time (timestamp).

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListNotebookInstanceLifecycleConfigsOutput": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the response is truncated, SageMaker AI returns this token. To get the next\n set of lifecycle configurations, use it in the next request.

" + } + }, + "NotebookInstanceLifecycleConfigs": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigSummaryList", + "traits": { + "smithy.api#documentation": "

An array of NotebookInstanceLifecycleConfiguration objects, each listing\n a lifecycle configuration.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListNotebookInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListNotebookInstancesInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListNotebookInstancesOutput" + }, + "traits": { + "smithy.api#documentation": "

Returns a list of the SageMaker AI notebook instances in the requester's\n account in an Amazon Web Services Region.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "NotebookInstances", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListNotebookInstancesInput": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the previous call to the ListNotebookInstances is truncated, the\n response includes a NextToken. You can use this token in your subsequent\n ListNotebookInstances request to fetch the next set of notebook\n instances.

\n \n

You might specify a filter or a sort order in your request. When response is\n truncated, you must use the same values for the filer and sort order in the next\n request.

\n " + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of notebook instances to return.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#NotebookInstanceSortKey", + "traits": { + "smithy.api#documentation": "

The field to sort results by. The default is Name.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#NotebookInstanceSortOrder", + "traits": { + "smithy.api#documentation": "

The sort order for results.

" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#NotebookInstanceNameContains", + "traits": { + "smithy.api#documentation": "

A string in the notebook instances' name. This filter returns only notebook\n instances whose name contains the specified string.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "

A filter that returns only notebook instances that were created before the\n specified time (timestamp).

" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "

A filter that returns only notebook instances that were created after the specified\n time (timestamp).

" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "

A filter that returns only notebook instances that were modified before the\n specified time (timestamp).

" + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "

A filter that returns only notebook instances that were modified after the\n specified time (timestamp).

" + } + }, + "StatusEquals": { + "target": "com.amazonaws.sagemaker#NotebookInstanceStatus", + "traits": { + "smithy.api#documentation": "

A filter that returns only notebook instances with the specified status.

" + } + }, + "NotebookInstanceLifecycleConfigNameContains": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigName", + "traits": { + "smithy.api#documentation": "

A string in the name of a notebook instances lifecycle configuration associated with\n this notebook instance. This filter returns only notebook instances associated with a\n lifecycle configuration with a name that contains the specified string.

" + } + }, + "DefaultCodeRepositoryContains": { + "target": "com.amazonaws.sagemaker#CodeRepositoryContains", + "traits": { + "smithy.api#documentation": "

A string in the name or URL of a Git repository associated with this notebook\n instance. This filter returns only notebook instances associated with a git repository\n with a name that contains the specified string.

" + } + }, + "AdditionalCodeRepositoryEquals": { + "target": "com.amazonaws.sagemaker#CodeRepositoryNameOrUrl", + "traits": { + "smithy.api#documentation": "

A filter that returns only notebook instances with associated with the specified git\n repository.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListNotebookInstancesOutput": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the response to the previous ListNotebookInstances request was\n truncated, SageMaker AI returns this token. To retrieve the next set of notebook\n instances, use the token in the next request.

" + } + }, + "NotebookInstances": { + "target": "com.amazonaws.sagemaker#NotebookInstanceSummaryList", + "traits": { + "smithy.api#documentation": "

An array of NotebookInstanceSummary objects, one for each notebook\n instance.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListOptimizationJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListOptimizationJobsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListOptimizationJobsResponse" + }, + "traits": { + "smithy.api#documentation": "

Lists the optimization jobs in your account and their properties.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "OptimizationJobSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListOptimizationJobsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

A token that you use to get the next set of results following a truncated response. If\n the response to the previous request was truncated, that response provides the value for\n this token.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of optimization jobs to return in the response. The default is\n 50.

" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "

Filters the results to only those optimization jobs that were created after the\n specified time.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "

Filters the results to only those optimization jobs that were created before the\n specified time.

" + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "

Filters the results to only those optimization jobs that were updated after the\n specified time.

" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "

Filters the results to only those optimization jobs that were updated before the\n specified time.

" + } + }, + "OptimizationContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "

Filters the results to only those optimization jobs that apply the specified\n optimization techniques. You can specify either Quantization or\n Compilation.

" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "

Filters the results to only those optimization jobs with a name that contains the\n specified string.

" + } + }, + "StatusEquals": { + "target": "com.amazonaws.sagemaker#OptimizationJobStatus", + "traits": { + "smithy.api#documentation": "

Filters the results to only those optimization jobs with the specified status.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#ListOptimizationJobsSortBy", + "traits": { + "smithy.api#documentation": "

The field by which to sort the optimization jobs in the response. The default is\n CreationTime\n

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

The sort order for results. The default is Ascending\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListOptimizationJobsResponse": { + "type": "structure", + "members": { + "OptimizationJobSummaries": { + "target": "com.amazonaws.sagemaker#OptimizationJobSummaries", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A list of optimization jobs and their properties that matches any of the filters you\n specified in the request.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

The token to use in a subsequent request to get the next set of results following a\n truncated response.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListOptimizationJobsSortBy": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + } + } + }, + "com.amazonaws.sagemaker#ListPartnerApps": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListPartnerAppsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListPartnerAppsResponse" + }, + "traits": { + "smithy.api#documentation": "

Lists all of the SageMaker Partner AI Apps in an account.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Summaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListPartnerAppsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

This parameter defines the maximum number of results that can be returned in a single\n response. The MaxResults parameter is an upper bound, not a target. If there are\n more results available than the value specified, a NextToken is provided in the\n response. The NextToken indicates that the user should get the next set of\n results by providing this token as a part of a subsequent call. The default value for\n MaxResults is 10.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListPartnerAppsResponse": { + "type": "structure", + "members": { + "Summaries": { + "target": "com.amazonaws.sagemaker#PartnerAppSummaries", + "traits": { + "smithy.api#documentation": "

The information related to each of the SageMaker Partner AI Apps in an account.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListPipelineExecutionSteps": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListPipelineExecutionStepsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListPipelineExecutionStepsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a list of PipeLineExecutionStep objects.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "PipelineExecutionSteps", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListPipelineExecutionStepsRequest": { + "type": "structure", + "members": { + "PipelineExecutionArn": { + "target": "com.amazonaws.sagemaker#PipelineExecutionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the pipeline execution.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the result of the previous ListPipelineExecutionSteps request was truncated,\n the response includes a NextToken. To retrieve the next set of pipeline execution steps, use the token in the next request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of pipeline execution steps to return in the response.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

The field by which to sort results. The default is CreatedTime.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListPipelineExecutionStepsResponse": { + "type": "structure", + "members": { + "PipelineExecutionSteps": { + "target": "com.amazonaws.sagemaker#PipelineExecutionStepList", + "traits": { + "smithy.api#documentation": "

A list of PipeLineExecutionStep objects. Each\n PipeLineExecutionStep consists of StepName, StartTime, EndTime, StepStatus,\n and Metadata. Metadata is an object with properties for each job that contains relevant\n information about the job created by the step.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the result of the previous ListPipelineExecutionSteps request was truncated,\n the response includes a NextToken. To retrieve the next set of pipeline execution steps, use the token in the next request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListPipelineExecutions": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListPipelineExecutionsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListPipelineExecutionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a list of the pipeline executions.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "PipelineExecutionSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListPipelineExecutionsRequest": { + "type": "structure", + "members": { + "PipelineName": { + "target": "com.amazonaws.sagemaker#PipelineNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the pipeline.

", + "smithy.api#required": {} + } + }, + "CreatedAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns the pipeline executions that were created after a specified\n time.

" + } + }, + "CreatedBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns the pipeline executions that were created before a specified\n time.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#SortPipelineExecutionsBy", + "traits": { + "smithy.api#documentation": "

The field by which to sort results. The default is CreatedTime.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

The sort order for results.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the result of the previous ListPipelineExecutions request was truncated,\n the response includes a NextToken. To retrieve the next set of pipeline executions, use the token in the next request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of pipeline executions to return in the response.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListPipelineExecutionsResponse": { + "type": "structure", + "members": { + "PipelineExecutionSummaries": { + "target": "com.amazonaws.sagemaker#PipelineExecutionSummaryList", + "traits": { + "smithy.api#documentation": "

Contains a sorted list of pipeline execution summary objects matching the specified\n filters. Each run summary includes the Amazon Resource Name (ARN) of the pipeline execution, the run date,\n and the status. This list can be empty.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the result of the previous ListPipelineExecutions request was truncated,\n the response includes a NextToken. To retrieve the next set of pipeline executions, use the token in the next request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListPipelineParametersForExecution": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListPipelineParametersForExecutionRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListPipelineParametersForExecutionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a list of parameters for a pipeline execution.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "PipelineParameters", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListPipelineParametersForExecutionRequest": { + "type": "structure", + "members": { + "PipelineExecutionArn": { + "target": "com.amazonaws.sagemaker#PipelineExecutionArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the pipeline execution.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the result of the previous ListPipelineParametersForExecution request was truncated,\n the response includes a NextToken. To retrieve the next set of parameters, use the token in the next request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of parameters to return in the response.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListPipelineParametersForExecutionResponse": { + "type": "structure", + "members": { + "PipelineParameters": { + "target": "com.amazonaws.sagemaker#ParameterList", + "traits": { + "smithy.api#documentation": "

Contains a list of pipeline parameters. This list can be empty.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the result of the previous ListPipelineParametersForExecution request was truncated,\n the response includes a NextToken. To retrieve the next set of parameters, use the token in the next request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListPipelines": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListPipelinesRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListPipelinesResponse" + }, + "traits": { + "smithy.api#documentation": "

Gets a list of pipelines.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "PipelineSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListPipelinesRequest": { + "type": "structure", + "members": { + "PipelineNamePrefix": { + "target": "com.amazonaws.sagemaker#PipelineName", + "traits": { + "smithy.api#documentation": "

The prefix of the pipeline name.

" + } + }, + "CreatedAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns the pipelines that were created after a specified\n time.

" + } + }, + "CreatedBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns the pipelines that were created before a specified\n time.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#SortPipelinesBy", + "traits": { + "smithy.api#documentation": "

The field by which to sort results. The default is CreatedTime.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

The sort order for results.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the result of the previous ListPipelines request was truncated,\n the response includes a NextToken. To retrieve the next set of pipelines, use the token in the next request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of pipelines to return in the response.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListPipelinesResponse": { + "type": "structure", + "members": { + "PipelineSummaries": { + "target": "com.amazonaws.sagemaker#PipelineSummaryList", + "traits": { + "smithy.api#documentation": "

Contains a sorted list of PipelineSummary objects matching the specified\n filters. Each PipelineSummary consists of PipelineArn, PipelineName,\n ExperimentName, PipelineDescription, CreationTime, LastModifiedTime, LastRunTime, and\n RoleArn. This list can be empty.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the result of the previous ListPipelines request was truncated,\n the response includes a NextToken. To retrieve the next set of pipelines, use the token in the next request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListProcessingJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListProcessingJobsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListProcessingJobsResponse" + }, + "traits": { + "smithy.api#documentation": "

Lists processing jobs that satisfy various filters.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ProcessingJobSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListProcessingJobsRequest": { + "type": "structure", + "members": { + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only processing jobs created after the specified time.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only processing jobs created after the specified time.

" + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only processing jobs modified after the specified time.

" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only processing jobs modified before the specified time.

" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

A string in the processing job name. This filter returns only processing jobs whose\n name contains the specified string.

" + } + }, + "StatusEquals": { + "target": "com.amazonaws.sagemaker#ProcessingJobStatus", + "traits": { + "smithy.api#documentation": "

A filter that retrieves only processing jobs with a specific status.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#SortBy", + "traits": { + "smithy.api#documentation": "

The field to sort results by. The default is CreationTime.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

The sort order for results. The default is Ascending.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the result of the previous ListProcessingJobs request was truncated,\n the response includes a NextToken. To retrieve the next set of processing\n jobs, use the token in the next request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of processing jobs to return in the response.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListProcessingJobsResponse": { + "type": "structure", + "members": { + "ProcessingJobSummaries": { + "target": "com.amazonaws.sagemaker#ProcessingJobSummaries", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An array of ProcessingJobSummary objects, each listing a processing\n job.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of\n processing jobs, use it in the subsequent request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListProjects": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListProjectsInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListProjectsOutput" + }, + "traits": { + "smithy.api#documentation": "

Gets a list of the projects in an Amazon Web Services account.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListProjectsInput": { + "type": "structure", + "members": { + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns the projects that were created after a specified\n time.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns the projects that were created before a specified\n time.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of projects to return in the response.

" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#ProjectEntityName", + "traits": { + "smithy.api#documentation": "

A filter that returns the projects whose name contains a specified\n string.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the result of the previous ListProjects request was truncated,\n the response includes a NextToken. To retrieve the next set of projects, use the token in the next request.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#ProjectSortBy", + "traits": { + "smithy.api#documentation": "

The field by which to sort results. The default is CreationTime.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#ProjectSortOrder", + "traits": { + "smithy.api#documentation": "

The sort order for results. The default is Ascending.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListProjectsOutput": { + "type": "structure", + "members": { + "ProjectSummaryList": { + "target": "com.amazonaws.sagemaker#ProjectSummaryList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A list of summaries of projects.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the result of the previous ListCompilationJobs request was truncated,\n the response includes a NextToken. To retrieve the next set of model\n compilation jobs, use the token in the next request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListResourceCatalogs": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListResourceCatalogsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListResourceCatalogsResponse" + }, + "traits": { + "smithy.api#documentation": "

Lists Amazon SageMaker Catalogs based on given filters and orders. The maximum number of\n ResourceCatalogs viewable is 1000.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ResourceCatalogs", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListResourceCatalogsRequest": { + "type": "structure", + "members": { + "NameContains": { + "target": "com.amazonaws.sagemaker#ResourceCatalogName", + "traits": { + "smithy.api#documentation": "

A string that partially matches one or more ResourceCatalogs names.\n Filters ResourceCatalog by name.

" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Use this parameter to search for ResourceCatalogs created after a\n specific date and time.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Use this parameter to search for ResourceCatalogs created before a\n specific date and time.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#ResourceCatalogSortOrder", + "traits": { + "smithy.api#documentation": "

The order in which the resource catalogs are listed.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#ResourceCatalogSortBy", + "traits": { + "smithy.api#documentation": "

The value on which the resource catalog list is sorted.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results returned by ListResourceCatalogs.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

A token to resume pagination of ListResourceCatalogs results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListResourceCatalogsResponse": { + "type": "structure", + "members": { + "ResourceCatalogs": { + "target": "com.amazonaws.sagemaker#ResourceCatalogList", + "traits": { + "smithy.api#documentation": "

A list of the requested ResourceCatalogs.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

A token to resume pagination of ListResourceCatalogs results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListSpaces": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListSpacesRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListSpacesResponse" + }, + "traits": { + "smithy.api#documentation": "

Lists spaces.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Spaces", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListSpacesRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

This parameter defines the maximum number of results that can be return in a single\n response. The MaxResults parameter is an upper bound, not a target. If there are\n more results available than the value specified, a NextToken is provided in the\n response. The NextToken indicates that the user should get the next set of\n results by providing this token as a part of a subsequent call. The default value for\n MaxResults is 10.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

The sort order for the results. The default is Ascending.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#SpaceSortKey", + "traits": { + "smithy.api#documentation": "

The parameter by which to sort the results. The default is\n CreationTime.

" + } + }, + "DomainIdEquals": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#documentation": "

A parameter to search for the domain ID.

" + } + }, + "SpaceNameContains": { + "target": "com.amazonaws.sagemaker#SpaceName", + "traits": { + "smithy.api#documentation": "

A parameter by which to filter the results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListSpacesResponse": { + "type": "structure", + "members": { + "Spaces": { + "target": "com.amazonaws.sagemaker#SpaceList", + "traits": { + "smithy.api#documentation": "

The list of spaces.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListStageDevices": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListStageDevicesRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListStageDevicesResponse" + }, + "traits": { + "smithy.api#documentation": "

Lists devices allocated to the stage, containing detailed device information and\n deployment status.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "DeviceDeploymentSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListStageDevicesRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

The response from the last list when returning a list large enough to neeed\n tokening.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#ListMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of requests to select.

" + } + }, + "EdgeDeploymentPlanName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the edge deployment plan.

", + "smithy.api#required": {} + } + }, + "ExcludeDevicesDeployedInOtherStage": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

Toggle for excluding devices deployed in other stages.

" + } + }, + "StageName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the stage in the deployment.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListStageDevicesResponse": { + "type": "structure", + "members": { + "DeviceDeploymentSummaries": { + "target": "com.amazonaws.sagemaker#DeviceDeploymentSummaries", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

List of summaries of devices allocated to the stage.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

The token to use when calling the next page of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListStudioLifecycleConfigs": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListStudioLifecycleConfigsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListStudioLifecycleConfigsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the Amazon SageMaker AI Studio Lifecycle Configurations in your Amazon Web Services\n Account.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "StudioLifecycleConfigs", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListStudioLifecycleConfigsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The total number of items to return in the response. If the total number of items\n available is more than the value specified, a NextToken is provided in the\n response. To resume pagination, provide the NextToken value in the as part of a\n subsequent call. The default value is 10.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the previous call to ListStudioLifecycleConfigs didn't return the full set of Lifecycle\n Configurations, the call returns a token for getting the next set of Lifecycle\n Configurations.

" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#StudioLifecycleConfigName", + "traits": { + "smithy.api#documentation": "

A string in the Lifecycle Configuration name. This filter returns only Lifecycle\n Configurations whose name contains the specified string.

" + } + }, + "AppTypeEquals": { + "target": "com.amazonaws.sagemaker#StudioLifecycleConfigAppType", + "traits": { + "smithy.api#documentation": "

A parameter to search for the App Type to which the Lifecycle Configuration is\n attached.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only Lifecycle Configurations created on or before the specified\n time.

" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only Lifecycle Configurations created on or after the specified\n time.

" + } + }, + "ModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only Lifecycle Configurations modified before the specified\n time.

" + } + }, + "ModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only Lifecycle Configurations modified after the specified\n time.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#StudioLifecycleConfigSortKey", + "traits": { + "smithy.api#documentation": "

The property used to sort results. The default value is CreationTime.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

The sort order. The default value is Descending.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListStudioLifecycleConfigsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.

" + } + }, + "StudioLifecycleConfigs": { + "target": "com.amazonaws.sagemaker#StudioLifecycleConfigsList", + "traits": { + "smithy.api#documentation": "

A list of Lifecycle Configurations and their properties.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListSubscribedWorkteams": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListSubscribedWorkteamsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListSubscribedWorkteamsResponse" + }, + "traits": { + "smithy.api#documentation": "

Gets a list of the work teams that you are subscribed to in the Amazon Web Services Marketplace. The\n list may be empty if no work team satisfies the filter specified in the\n NameContains parameter.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "SubscribedWorkteams", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListSubscribedWorkteamsRequest": { + "type": "structure", + "members": { + "NameContains": { + "target": "com.amazonaws.sagemaker#WorkteamName", + "traits": { + "smithy.api#documentation": "

A string in the work team name. This filter returns only work teams whose name\n contains the specified string.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the result of the previous ListSubscribedWorkteams request was\n truncated, the response includes a NextToken. To retrieve the next set of\n labeling jobs, use the token in the next request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of work teams to return in each page of the response.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListSubscribedWorkteamsResponse": { + "type": "structure", + "members": { + "SubscribedWorkteams": { + "target": "com.amazonaws.sagemaker#SubscribedWorkteams", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An array of Workteam objects, each describing a work team.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of\n work teams, use it in the subsequent request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListTagsInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListTagsOutput" + }, + "traits": { + "smithy.api#documentation": "

Returns the tags for the specified SageMaker resource.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Tags", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListTagsInput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.sagemaker#ResourceArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource whose tags you want to\n retrieve.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the response to the previous ListTags request is truncated, SageMaker\n returns this token. To retrieve the next set of tags, use it in the subsequent request.\n

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#ListTagsMaxResults", + "traits": { + "smithy.api#documentation": "

Maximum number of tags to return.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListTagsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 50 + } + } + }, + "com.amazonaws.sagemaker#ListTagsOutput": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

An array of Tag objects, each with a tag key and a value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If response is truncated, SageMaker includes a token in the response. You can use this\n token in your subsequent request to fetch next set of tokens.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListTrainingJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListTrainingJobsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListTrainingJobsResponse" + }, + "traits": { + "smithy.api#documentation": "

Lists training jobs.

\n \n

When StatusEquals and MaxResults are set at the same\n time, the MaxResults number of training jobs are first retrieved\n ignoring the StatusEquals parameter and then they are filtered by the\n StatusEquals parameter, which is returned as a response.

\n

For example, if ListTrainingJobs is invoked with the following\n parameters:

\n

\n { ... MaxResults: 100, StatusEquals: InProgress ... }\n

\n

First, 100 trainings jobs with any status, including those other than\n InProgress, are selected (sorted according to the creation time,\n from the most current to the oldest). Next, those with a status of\n InProgress are returned.

\n

You can quickly test the API using the following Amazon Web Services CLI\n code.

\n

\n aws sagemaker list-training-jobs --max-results 100 --status-equals\n InProgress\n

\n ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TrainingJobSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListTrainingJobsForHyperParameterTuningJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListTrainingJobsForHyperParameterTuningJobRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListTrainingJobsForHyperParameterTuningJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a list of TrainingJobSummary objects that describe the training jobs that a\n hyperparameter tuning job launched.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TrainingJobSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListTrainingJobsForHyperParameterTuningJobRequest": { + "type": "structure", + "members": { + "HyperParameterTuningJobName": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the tuning job whose training jobs you want to list.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the result of the previous ListTrainingJobsForHyperParameterTuningJob\n request was truncated, the response includes a NextToken. To retrieve the\n next set of training jobs, use the token in the next request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of training jobs to return. The default value is 10.

" + } + }, + "StatusEquals": { + "target": "com.amazonaws.sagemaker#TrainingJobStatus", + "traits": { + "smithy.api#documentation": "

A filter that returns only training jobs with the specified status.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#TrainingJobSortByOptions", + "traits": { + "smithy.api#documentation": "

The field to sort results by. The default is Name.

\n

If the value of this field is FinalObjectiveMetricValue, any training\n jobs that did not return an objective metric are not listed.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

The sort order for results. The default is Ascending.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListTrainingJobsForHyperParameterTuningJobResponse": { + "type": "structure", + "members": { + "TrainingJobSummaries": { + "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobSummaries", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A list of TrainingJobSummary objects that\n describe\n the training jobs that the\n ListTrainingJobsForHyperParameterTuningJob request returned.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the result of this ListTrainingJobsForHyperParameterTuningJob request\n was truncated, the response includes a NextToken. To retrieve the next set\n of training jobs, use the token in the next request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListTrainingJobsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the result of the previous ListTrainingJobs request was truncated,\n the response includes a NextToken. To retrieve the next set of training\n jobs, use the token in the next request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of training jobs to return in the response.

" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only training jobs created after the specified time\n (timestamp).

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only training jobs created before the specified time\n (timestamp).

" + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only training jobs modified after the specified time\n (timestamp).

" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only training jobs modified before the specified time\n (timestamp).

" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "

A string in the training job name. This filter returns only training jobs whose\n name contains the specified string.

" + } + }, + "StatusEquals": { + "target": "com.amazonaws.sagemaker#TrainingJobStatus", + "traits": { + "smithy.api#documentation": "

A filter that retrieves only training jobs with a specific status.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#SortBy", + "traits": { + "smithy.api#documentation": "

The field to sort results by. The default is CreationTime.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

The sort order for results. The default is Ascending.

" + } + }, + "WarmPoolStatusEquals": { + "target": "com.amazonaws.sagemaker#WarmPoolResourceStatus", + "traits": { + "smithy.api#documentation": "

A filter that retrieves only training jobs with a specific warm pool status.

" + } + }, + "TrainingPlanArnEquals": { + "target": "com.amazonaws.sagemaker#TrainingPlanArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN); of the training plan to filter training jobs by. For more information\n about reserving GPU capacity for your SageMaker training jobs using Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListTrainingJobsResponse": { + "type": "structure", + "members": { + "TrainingJobSummaries": { + "target": "com.amazonaws.sagemaker#TrainingJobSummaries", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An array of TrainingJobSummary objects, each listing a training\n job.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of\n training jobs, use it in the subsequent request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListTrainingPlans": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListTrainingPlansRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListTrainingPlansResponse" + }, + "traits": { + "smithy.api#documentation": "

Retrieves a list of training plans for the current account.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TrainingPlanSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListTrainingPlansRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

A token to continue pagination if more results are available.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in the response.

" + } + }, + "StartTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Filter to list only training plans with an actual start time after this date.

" + } + }, + "StartTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Filter to list only training plans with an actual start time before this date.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#TrainingPlanSortBy", + "traits": { + "smithy.api#documentation": "

The training plan field to sort the results by (e.g., StartTime, Status).

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#TrainingPlanSortOrder", + "traits": { + "smithy.api#documentation": "

The order to sort the results (Ascending or Descending).

" + } + }, + "Filters": { + "target": "com.amazonaws.sagemaker#TrainingPlanFilters", + "traits": { + "smithy.api#documentation": "

Additional filters to apply to the list of training plans.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListTrainingPlansResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

A token to continue pagination if more results are available.

" + } + }, + "TrainingPlanSummaries": { + "target": "com.amazonaws.sagemaker#TrainingPlanSummaries", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A list of summary information for the training plans.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListTransformJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListTransformJobsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListTransformJobsResponse" + }, + "traits": { + "smithy.api#documentation": "

Lists transform jobs.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TransformJobSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListTransformJobsRequest": { + "type": "structure", + "members": { + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only transform jobs created after the specified time.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only transform jobs created before the specified time.

" + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only transform jobs modified after the specified time.

" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only transform jobs modified before the specified time.

" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "

A string in the transform job name. This filter returns only transform jobs whose name\n contains the specified string.

" + } + }, + "StatusEquals": { + "target": "com.amazonaws.sagemaker#TransformJobStatus", + "traits": { + "smithy.api#documentation": "

A filter that retrieves only transform jobs with a specific status.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#SortBy", + "traits": { + "smithy.api#documentation": "

The field to sort results by. The default is CreationTime.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

The sort order for results. The default is Descending.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the result of the previous ListTransformJobs request was truncated,\n the response includes a NextToken. To retrieve the next set of transform\n jobs, use the token in the next request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of transform jobs to return in the response. The default value is 10.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListTransformJobsResponse": { + "type": "structure", + "members": { + "TransformJobSummaries": { + "target": "com.amazonaws.sagemaker#TransformJobSummaries", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An array of\n TransformJobSummary\n objects.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of\n transform jobs, use it in the next request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListTrialComponentKey256": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#TrialComponentKey256" + } + }, + "com.amazonaws.sagemaker#ListTrialComponents": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListTrialComponentsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListTrialComponentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the trial components in your account. You can sort the list by trial component name\n or creation time. You can filter the list to show only components that were created in a\n specific time range. You can also filter on one of the following:

\n
    \n
  • \n

    \n ExperimentName\n

    \n
    • \n
  • \n

    \n SourceArn\n

    \n
    • \n
  • \n

    \n TrialName\n

    \n
    • \n
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TrialComponentSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListTrialComponentsRequest": { + "type": "structure", + "members": { + "ExperimentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

A filter that returns only components that are part of the specified experiment. If you\n specify ExperimentName, you can't filter by SourceArn or\n TrialName.

" + } + }, + "TrialName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

A filter that returns only components that are part of the specified trial. If you specify\n TrialName, you can't filter by ExperimentName or\n SourceArn.

" + } + }, + "SourceArn": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "

A filter that returns only components that have the specified source Amazon Resource Name (ARN). \n If you specify SourceArn, you can't filter by ExperimentName\n or TrialName.

" + } + }, + "CreatedAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only components created after the specified time.

" + } + }, + "CreatedBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only components created before the specified time.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#SortTrialComponentsBy", + "traits": { + "smithy.api#documentation": "

The property used to sort results. The default value is CreationTime.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

The sort order. The default value is Descending.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of components to return in the response. The default value is\n 10.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the previous call to ListTrialComponents didn't return the full set of\n components, the call returns a token for getting the next set of components.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListTrialComponentsResponse": { + "type": "structure", + "members": { + "TrialComponentSummaries": { + "target": "com.amazonaws.sagemaker#TrialComponentSummaries", + "traits": { + "smithy.api#documentation": "

A list of the summaries of your trial components.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

A token for getting the next set of components, if there are any.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListTrials": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListTrialsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListTrialsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the trials in your account. Specify an experiment name to limit the list to the\n trials that are part of that experiment. Specify a trial component name to limit the list to\n the trials that associated with that trial component. The list can be filtered to show only\n trials that were created in a specific time range. The list can be sorted by trial name or\n creation time.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TrialSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListTrialsRequest": { + "type": "structure", + "members": { + "ExperimentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

A filter that returns only trials that are part of the specified experiment.

" + } + }, + "TrialComponentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

A filter that returns only trials that are associated with the specified trial\n component.

" + } + }, + "CreatedAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only trials created after the specified time.

" + } + }, + "CreatedBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns only trials created before the specified time.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#SortTrialsBy", + "traits": { + "smithy.api#documentation": "

The property used to sort results. The default value is CreationTime.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

The sort order. The default value is Descending.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of trials to return in the response. The default value is 10.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the previous call to ListTrials didn't return the full set of trials, the\n call returns a token for getting the next set of trials.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListTrialsResponse": { + "type": "structure", + "members": { + "TrialSummaries": { + "target": "com.amazonaws.sagemaker#TrialSummaries", + "traits": { + "smithy.api#documentation": "

A list of the summaries of your trials.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

A token for getting the next set of trials, if there are any.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListUserProfiles": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListUserProfilesRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListUserProfilesResponse" + }, + "traits": { + "smithy.api#documentation": "

Lists user profiles.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "UserProfiles", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListUserProfilesRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

This parameter defines the maximum number of results that can be return in a single\n response. The MaxResults parameter is an upper bound, not a target. If there are\n more results available than the value specified, a NextToken is provided in the\n response. The NextToken indicates that the user should get the next set of\n results by providing this token as a part of a subsequent call. The default value for\n MaxResults is 10.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

The sort order for the results. The default is Ascending.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#UserProfileSortKey", + "traits": { + "smithy.api#documentation": "

The parameter by which to sort the results. The default is CreationTime.

" + } + }, + "DomainIdEquals": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#documentation": "

A parameter by which to filter the results.

" + } + }, + "UserProfileNameContains": { + "target": "com.amazonaws.sagemaker#UserProfileName", + "traits": { + "smithy.api#documentation": "

A parameter by which to filter the results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListUserProfilesResponse": { + "type": "structure", + "members": { + "UserProfiles": { + "target": "com.amazonaws.sagemaker#UserProfileList", + "traits": { + "smithy.api#documentation": "

The list of user profiles.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListWorkforces": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListWorkforcesRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListWorkforcesResponse" + }, + "traits": { + "smithy.api#documentation": "

Use this operation to list all private and vendor workforces in an Amazon Web Services Region. Note that you can only \n have one private workforce per Amazon Web Services Region.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Workforces", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListWorkforcesRequest": { + "type": "structure", + "members": { + "SortBy": { + "target": "com.amazonaws.sagemaker#ListWorkforcesSortByOptions", + "traits": { + "smithy.api#documentation": "

Sort workforces using the workforce name or creation date.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

Sort workforces in ascending or descending order.

" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#WorkforceName", + "traits": { + "smithy.api#documentation": "

A filter you can use to search for workforces using part of the workforce name.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

A token to resume pagination.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of workforces returned in the response.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListWorkforcesResponse": { + "type": "structure", + "members": { + "Workforces": { + "target": "com.amazonaws.sagemaker#Workforces", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A list containing information about your workforce.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

A token to resume pagination.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListWorkforcesSortByOptions": { + "type": "enum", + "members": { + "Name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CreateDate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateDate" + } + } + } + }, + "com.amazonaws.sagemaker#ListWorkteams": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListWorkteamsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListWorkteamsResponse" + }, + "traits": { + "smithy.api#documentation": "

Gets a list of private work teams that you have defined in a region. The list may be empty if\n no work team satisfies the filter specified in the NameContains\n parameter.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Workteams", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListWorkteamsRequest": { + "type": "structure", + "members": { + "SortBy": { + "target": "com.amazonaws.sagemaker#ListWorkteamsSortByOptions", + "traits": { + "smithy.api#documentation": "

The field to sort results by. The default is CreationTime.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

The sort order for results. The default is Ascending.

" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#WorkteamName", + "traits": { + "smithy.api#documentation": "

A string in the work team's name. This filter returns only work teams whose name\n contains the specified string.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the result of the previous ListWorkteams request was truncated, the\n response includes a NextToken. To retrieve the next set of labeling jobs,\n use the token in the next request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of work teams to return in each page of the response.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListWorkteamsResponse": { + "type": "structure", + "members": { + "Workteams": { + "target": "com.amazonaws.sagemaker#Workteams", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An array of Workteam objects, each describing a work team.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of\n work teams, use it in the subsequent request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListWorkteamsSortByOptions": { + "type": "enum", + "members": { + "Name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CreateDate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateDate" + } + } + } + }, + "com.amazonaws.sagemaker#Long": { + "type": "long" + }, + "com.amazonaws.sagemaker#MLFramework": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z]+ ?\\d+\\.\\d+(\\.\\d+)?$" + } + }, + "com.amazonaws.sagemaker#ManagedInstanceScalingMaxInstanceCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#ManagedInstanceScalingMinInstanceCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.sagemaker#ManagedInstanceScalingStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.sagemaker#MaxAutoMLJobRuntimeInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#MaxCandidates": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 750 + } + } + }, + "com.amazonaws.sagemaker#MaxConcurrentInvocationsPerInstance": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.sagemaker#MaxConcurrentTaskCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 5000 + } + } + }, + "com.amazonaws.sagemaker#MaxConcurrentTransforms": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.sagemaker#MaxHumanLabeledObjectCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#MaxNumberOfTests": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#MaxNumberOfTrainingJobs": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#MaxNumberOfTrainingJobsNotImproving": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 3 + } + } + }, + "com.amazonaws.sagemaker#MaxParallelExecutionSteps": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#MaxParallelOfTests": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#MaxParallelTrainingJobs": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#MaxPayloadInMB": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.sagemaker#MaxPendingTimeInSeconds": { + "type": "integer", + "traits": { + "smithy.api#documentation": "Maximum job scheduler pending time in seconds.", + "smithy.api#range": { + "min": 7200, + "max": 2419200 + } + } + }, + "com.amazonaws.sagemaker#MaxPercentageOfInputDatasetLabeled": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#MaxRuntimeInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#MaxRuntimePerTrainingJobInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#MaxWaitTimeInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#MaximumExecutionTimeoutInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 600, + "max": 28800 + } + } + }, + "com.amazonaws.sagemaker#MaximumRetryAttempts": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 30 + } + } + }, + "com.amazonaws.sagemaker#MediaType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + }, + "smithy.api#pattern": "^[-\\w]+\\/[-\\w+]+$" + } + }, + "com.amazonaws.sagemaker#MemberDefinition": { + "type": "structure", + "members": { + "CognitoMemberDefinition": { + "target": "com.amazonaws.sagemaker#CognitoMemberDefinition", + "traits": { + "smithy.api#documentation": "

The Amazon Cognito user group that is part of the work team.

" + } + }, + "OidcMemberDefinition": { + "target": "com.amazonaws.sagemaker#OidcMemberDefinition", + "traits": { + "smithy.api#documentation": "

A list user groups that exist in your OIDC Identity Provider (IdP). \n One to ten groups can be used to create a single private work team. \n When you add a user group to the list of Groups, you can add that user group to one or more\n private work teams. If you add a user group to a private work team, all workers in that user group \n are added to the work team.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines an Amazon Cognito or your own OIDC IdP user group that is part of a work team.

" + } + }, + "com.amazonaws.sagemaker#MemberDefinitions": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#MemberDefinition" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.sagemaker#MemoryInMb": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 128 + } + } + }, + "com.amazonaws.sagemaker#MetadataProperties": { + "type": "structure", + "members": { + "CommitId": { + "target": "com.amazonaws.sagemaker#MetadataPropertyValue", + "traits": { + "smithy.api#documentation": "

The commit ID.

" + } + }, + "Repository": { + "target": "com.amazonaws.sagemaker#MetadataPropertyValue", + "traits": { + "smithy.api#documentation": "

The repository.

" + } + }, + "GeneratedBy": { + "target": "com.amazonaws.sagemaker#MetadataPropertyValue", + "traits": { + "smithy.api#documentation": "

The entity this entity was generated by.

" + } + }, + "ProjectId": { + "target": "com.amazonaws.sagemaker#MetadataPropertyValue", + "traits": { + "smithy.api#documentation": "

The project ID.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Metadata properties of the tracking entity, trial, or trial component.

" + } + }, + "com.amazonaws.sagemaker#MetadataPropertyValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#MetricData": { + "type": "structure", + "members": { + "MetricName": { + "target": "com.amazonaws.sagemaker#MetricName", + "traits": { + "smithy.api#documentation": "

The name of the metric.

" + } + }, + "Value": { + "target": "com.amazonaws.sagemaker#Float", + "traits": { + "smithy.api#documentation": "

The value of the metric.

" + } + }, + "Timestamp": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the algorithm emitted the metric.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The name, value, and date and time of a metric that was emitted to Amazon CloudWatch.

" + } + }, + "com.amazonaws.sagemaker#MetricDataList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#MetricDatum" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 40 + } + } + }, + "com.amazonaws.sagemaker#MetricDatum": { + "type": "structure", + "members": { + "MetricName": { + "target": "com.amazonaws.sagemaker#AutoMLMetricEnum", + "traits": { + "smithy.api#documentation": "

The name of the metric.

" + } + }, + "StandardMetricName": { + "target": "com.amazonaws.sagemaker#AutoMLMetricExtendedEnum", + "traits": { + "smithy.api#documentation": "

The name of the standard metric.

\n \n

For definitions of the standard metrics, see \n Autopilot candidate metrics\n .

\n " + } + }, + "Value": { + "target": "com.amazonaws.sagemaker#Float", + "traits": { + "smithy.api#documentation": "

The value of the metric.

" + } + }, + "Set": { + "target": "com.amazonaws.sagemaker#MetricSetSource", + "traits": { + "smithy.api#documentation": "

The dataset split from which the AutoML job produced the metric.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the metric for a candidate produced by an AutoML job.

" + } + }, + "com.amazonaws.sagemaker#MetricDefinition": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#MetricName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the metric.

", + "smithy.api#required": {} + } + }, + "Regex": { + "target": "com.amazonaws.sagemaker#MetricRegex", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A regular expression that searches the output of a training job and gets the value of\n the metric. For more information about using regular expressions to define metrics, see\n Defining metrics and environment variables.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies a metric that the training algorithm writes to stderr or\n stdout. You can view these logs to understand how your training job\n performs and check for any errors encountered during training. SageMaker hyperparameter\n tuning captures all defined metrics. Specify one of the defined metrics to use as an\n objective metric using the TuningObjective parameter in the\n HyperParameterTrainingJobDefinition API to evaluate job performance\n during hyperparameter tuning.

" + } + }, + "com.amazonaws.sagemaker#MetricDefinitionList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#MetricDefinition" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 40 + } + } + }, + "com.amazonaws.sagemaker#MetricName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.sagemaker#MetricRegex": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + }, + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.sagemaker#MetricSetSource": { + "type": "enum", + "members": { + "TRAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Train" + } + }, + "VALIDATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Validation" + } + }, + "TEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Test" + } + } + } + }, + "com.amazonaws.sagemaker#MetricSpecification": { + "type": "union", + "members": { + "Predefined": { + "target": "com.amazonaws.sagemaker#PredefinedMetricSpecification", + "traits": { + "smithy.api#documentation": "

Information about a predefined metric.

" + } + }, + "Customized": { + "target": "com.amazonaws.sagemaker#CustomizedMetricSpecification", + "traits": { + "smithy.api#documentation": "

Information about a customized metric.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object containing information about a metric.

" + } + }, + "com.amazonaws.sagemaker#MetricValue": { + "type": "float" + }, + "com.amazonaws.sagemaker#MetricsSource": { + "type": "structure", + "members": { + "ContentType": { + "target": "com.amazonaws.sagemaker#ContentType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The metric source content type.

", + "smithy.api#required": {} + } + }, + "ContentDigest": { + "target": "com.amazonaws.sagemaker#ContentDigest", + "traits": { + "smithy.api#documentation": "

The hash key used for the metrics source.

" + } + }, + "S3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The S3 URI for the metrics source.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the metrics source.

" + } + }, + "com.amazonaws.sagemaker#MinimumInstanceMetadataServiceVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + }, + "smithy.api#pattern": "^1|2$" + } + }, + "com.amazonaws.sagemaker#MlTools": { + "type": "enum", + "members": { + "DATA_WRANGLER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DataWrangler" + } + }, + "FEATURE_STORE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FeatureStore" + } + }, + "EMR_CLUSTERS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EmrClusters" + } + }, + "AUTO_ML": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AutoMl" + } + }, + "EXPERIMENTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Experiments" + } + }, + "TRAINING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Training" + } + }, + "MODEL_EVALUATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ModelEvaluation" + } + }, + "PIPELINES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pipelines" + } + }, + "MODELS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Models" + } + }, + "JUMP_START": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JumpStart" + } + }, + "INFERENCE_RECOMMENDER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InferenceRecommender" + } + }, + "ENDPOINTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Endpoints" + } + }, + "PROJECTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Projects" + } + }, + "INFERENCE_OPTIMIZATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InferenceOptimization" + } + }, + "PERFORMANCE_EVALUATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PerformanceEvaluation" + } + }, + "LAKERA_GUARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LakeraGuard" + } + }, + "COMET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Comet" + } + }, + "DEEPCHECKS_LLM_EVALUATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeepchecksLLMEvaluation" + } + }, + "FIDDLER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Fiddler" + } + }, + "HYPER_POD_CLUSTERS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HyperPodClusters" + } + } + } + }, + "com.amazonaws.sagemaker#MlflowVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 16 + }, + "smithy.api#pattern": "^[0-9]*.[0-9]*.[0-9]*$" + } + }, + "com.amazonaws.sagemaker#Model": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.sagemaker#ModelName", + "traits": { + "smithy.api#documentation": "

The name of the model.

" + } + }, + "PrimaryContainer": { + "target": "com.amazonaws.sagemaker#ContainerDefinition" + }, + "Containers": { + "target": "com.amazonaws.sagemaker#ContainerDefinitionList", + "traits": { + "smithy.api#documentation": "

The containers in the inference pipeline.

" + } + }, + "InferenceExecutionConfig": { + "target": "com.amazonaws.sagemaker#InferenceExecutionConfig" + }, + "ExecutionRoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that you specified for the\n model.

" + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig" + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A timestamp that indicates when the model was created.

" + } + }, + "ModelArn": { + "target": "com.amazonaws.sagemaker#ModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model.

" + } + }, + "EnableNetworkIsolation": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

Isolates the model container. No inbound or outbound network calls can be made to or\n from the model container.

" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

A list of key-value pairs associated with the model. For more information, see\n Tagging Amazon Web Services\n resources in the Amazon Web Services General Reference Guide.

" + } + }, + "DeploymentRecommendation": { + "target": "com.amazonaws.sagemaker#DeploymentRecommendation", + "traits": { + "smithy.api#documentation": "

A set of recommended deployment configurations for the model.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The properties of a model as returned by the Search API.

" + } + }, + "com.amazonaws.sagemaker#ModelAccessConfig": { + "type": "structure", + "members": { + "AcceptEula": { + "target": "com.amazonaws.sagemaker#AcceptEula", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies agreement to the model end-user license agreement (EULA). The\n AcceptEula value must be explicitly defined as True in order\n to accept the EULA that this model requires. You are responsible for reviewing and\n complying with any applicable license terms and making sure they are acceptable for your\n use case before downloading or using a model.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The access configuration file to control access to the ML model. You can explicitly accept the model\n end-user license agreement (EULA) within the ModelAccessConfig.

\n " + } + }, + "com.amazonaws.sagemaker#ModelApprovalStatus": { + "type": "enum", + "members": { + "APPROVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Approved" + } + }, + "REJECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Rejected" + } + }, + "PENDING_MANUAL_APPROVAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PendingManualApproval" + } + } + } + }, + "com.amazonaws.sagemaker#ModelArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:model/" + } + }, + "com.amazonaws.sagemaker#ModelArtifacts": { + "type": "structure", + "members": { + "S3ModelArtifacts": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The path of the S3 object that contains the model artifacts. For example,\n s3://bucket-name/keynameprefix/model.tar.gz.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about the location that is configured for storing model\n artifacts.

\n

Model artifacts are outputs that result from training a model. They typically consist\n of trained parameters, a model definition that describes how to compute inferences, and\n other metadata. A SageMaker container stores your trained model artifacts in the\n /opt/ml/model directory. After training has completed, by default,\n these artifacts are uploaded to your Amazon S3 bucket as compressed files.

" + } + }, + "com.amazonaws.sagemaker#ModelBiasAppSpecification": { + "type": "structure", + "members": { + "ImageUri": { + "target": "com.amazonaws.sagemaker#ImageUri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The container image to be run by the model bias job.

", + "smithy.api#required": {} + } + }, + "ConfigUri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

JSON formatted S3 file that defines bias parameters. For more information on this JSON\n configuration file, see Configure\n bias parameters.

", + "smithy.api#required": {} + } + }, + "Environment": { + "target": "com.amazonaws.sagemaker#MonitoringEnvironmentMap", + "traits": { + "smithy.api#documentation": "

Sets the environment variables in the Docker container.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Docker container image configuration object for the model bias job.

" + } + }, + "com.amazonaws.sagemaker#ModelBiasBaselineConfig": { + "type": "structure", + "members": { + "BaseliningJobName": { + "target": "com.amazonaws.sagemaker#ProcessingJobName", + "traits": { + "smithy.api#documentation": "

The name of the baseline model bias job.

" + } + }, + "ConstraintsResource": { + "target": "com.amazonaws.sagemaker#MonitoringConstraintsResource" + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for a baseline model bias job.

" + } + }, + "com.amazonaws.sagemaker#ModelBiasJobInput": { + "type": "structure", + "members": { + "EndpointInput": { + "target": "com.amazonaws.sagemaker#EndpointInput" + }, + "BatchTransformInput": { + "target": "com.amazonaws.sagemaker#BatchTransformInput", + "traits": { + "smithy.api#documentation": "

Input object for the batch transform job.

" + } + }, + "GroundTruthS3Input": { + "target": "com.amazonaws.sagemaker#MonitoringGroundTruthS3Input", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Location of ground truth labels to use in model bias job.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Inputs for the model bias job.

" + } + }, + "com.amazonaws.sagemaker#ModelCacheSetting": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enabled" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disabled" + } + } + } + }, + "com.amazonaws.sagemaker#ModelCard": { + "type": "structure", + "members": { + "ModelCardArn": { + "target": "com.amazonaws.sagemaker#ModelCardArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model card.

" + } + }, + "ModelCardName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#documentation": "

The unique name of the model card.

" + } + }, + "ModelCardVersion": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "

The version of the model card.

" + } + }, + "Content": { + "target": "com.amazonaws.sagemaker#ModelCardContent", + "traits": { + "smithy.api#documentation": "

The content of the model card. Content uses the model card JSON schema and provided as a string.

" + } + }, + "ModelCardStatus": { + "target": "com.amazonaws.sagemaker#ModelCardStatus", + "traits": { + "smithy.api#documentation": "

The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

\n
    \n
  • \n

    \n Draft: The model card is a work in progress.

    \n
    • \n
  • \n

    \n PendingReview: The model card is pending review.

    \n
    • \n
  • \n

    \n Approved: The model card is approved.

    \n
    • \n
  • \n

    \n Archived: The model card is archived. No more updates should be made to the model\n card, but it can still be exported.

    \n
    • \n
" + } + }, + "SecurityConfig": { + "target": "com.amazonaws.sagemaker#ModelCardSecurityConfig", + "traits": { + "smithy.api#documentation": "

The security configuration used to protect model card data.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the model card was created.

" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the model card was last modified.

" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

Key-value pairs used to manage metadata for the model card.

" + } + }, + "ModelId": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The unique name (ID) of the model.

" + } + }, + "RiskRating": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The risk rating of the model. Different organizations might have different criteria for model card risk ratings. For more information, see Risk ratings.

" + } + }, + "ModelPackageGroupName": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The model package group that contains the model package. Only relevant for model cards created for model packages in the Amazon SageMaker Model Registry.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An Amazon SageMaker Model Card.

" + } + }, + "com.amazonaws.sagemaker#ModelCardArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:model-card/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#ModelCardContent": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100000 + }, + "smithy.api#pattern": ".*", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.sagemaker#ModelCardExportArtifacts": { + "type": "structure", + "members": { + "S3ExportArtifacts": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon S3 URI of the exported model artifacts.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The artifacts of the model card export job.

" + } + }, + "com.amazonaws.sagemaker#ModelCardExportJobArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:model-card/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}/export-job/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#ModelCardExportJobSortBy": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + } + }, + "traits": { + "smithy.api#documentation": "Attribute by which to sort returned export jobs." + } + }, + "com.amazonaws.sagemaker#ModelCardExportJobSortOrder": { + "type": "enum", + "members": { + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ascending" + } + }, + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Descending" + } + } + } + }, + "com.amazonaws.sagemaker#ModelCardExportJobStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + } + } + }, + "com.amazonaws.sagemaker#ModelCardExportJobSummary": { + "type": "structure", + "members": { + "ModelCardExportJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the model card export job.

", + "smithy.api#required": {} + } + }, + "ModelCardExportJobArn": { + "target": "com.amazonaws.sagemaker#ModelCardExportJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model card export job.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#ModelCardExportJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The completion status of the model card export job.

", + "smithy.api#required": {} + } + }, + "ModelCardName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the model card that the export job exports.

", + "smithy.api#required": {} + } + }, + "ModelCardVersion": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The version of the model card that the export job exports.

", + "smithy.api#required": {} + } + }, + "CreatedAt": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The date and time that the model card export job was created.

", + "smithy.api#required": {} + } + }, + "LastModifiedAt": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The date and time that the model card export job was last modified..

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The summary of the Amazon SageMaker Model Card export job.

" + } + }, + "com.amazonaws.sagemaker#ModelCardExportJobSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ModelCardExportJobSummary" + } + }, + "com.amazonaws.sagemaker#ModelCardExportOutputConfig": { + "type": "structure", + "members": { + "S3OutputPath": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon S3 output path to export your model card PDF.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Configure the export output details for an Amazon SageMaker Model Card.

" + } + }, + "com.amazonaws.sagemaker#ModelCardNameOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:model-card/.*)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,62})$" + } + }, + "com.amazonaws.sagemaker#ModelCardProcessingStatus": { + "type": "enum", + "members": { + "DELETE_INPROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteInProgress" + } + }, + "DELETE_PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeletePending" + } + }, + "CONTENT_DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ContentDeleted" + } + }, + "EXPORTJOBS_DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ExportJobsDeleted" + } + }, + "DELETE_COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteCompleted" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteFailed" + } + } + } + }, + "com.amazonaws.sagemaker#ModelCardSecurityConfig": { + "type": "structure", + "members": { + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

A Key Management Service\n key\n ID to use for encrypting a model card.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configure the security settings to protect model card data.

" + } + }, + "com.amazonaws.sagemaker#ModelCardSortBy": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + } + } + }, + "com.amazonaws.sagemaker#ModelCardSortOrder": { + "type": "enum", + "members": { + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ascending" + } + }, + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Descending" + } + } + } + }, + "com.amazonaws.sagemaker#ModelCardStatus": { + "type": "enum", + "members": { + "DRAFT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Draft" + } + }, + "PENDINGREVIEW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PendingReview" + } + }, + "APPROVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Approved" + } + }, + "ARCHIVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Archived" + } + } + } + }, + "com.amazonaws.sagemaker#ModelCardSummary": { + "type": "structure", + "members": { + "ModelCardName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the model card.

", + "smithy.api#required": {} + } + }, + "ModelCardArn": { + "target": "com.amazonaws.sagemaker#ModelCardArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model card.

", + "smithy.api#required": {} + } + }, + "ModelCardStatus": { + "target": "com.amazonaws.sagemaker#ModelCardStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

\n
    \n
  • \n

    \n Draft: The model card is a work in progress.

    \n
    • \n
  • \n

    \n PendingReview: The model card is pending review.

    \n
    • \n
  • \n

    \n Approved: The model card is approved.

    \n
    • \n
  • \n

    \n Archived: The model card is archived. No more updates should be made to the model\n card, but it can still be exported.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The date and time that the model card was created.

", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the model card was last modified.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A summary of the model card.

" + } + }, + "com.amazonaws.sagemaker#ModelCardSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ModelCardSummary" + } + }, + "com.amazonaws.sagemaker#ModelCardVersionSortBy": { + "type": "enum", + "members": { + "VERSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Version" + } + } + } + }, + "com.amazonaws.sagemaker#ModelCardVersionSummary": { + "type": "structure", + "members": { + "ModelCardName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the model card.

", + "smithy.api#required": {} + } + }, + "ModelCardArn": { + "target": "com.amazonaws.sagemaker#ModelCardArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model card.

", + "smithy.api#required": {} + } + }, + "ModelCardStatus": { + "target": "com.amazonaws.sagemaker#ModelCardStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The approval status of the model card version within your organization. Different organizations might have different criteria for model card review and approval.

\n
    \n
  • \n

    \n Draft: The model card is a work in progress.

    \n
    • \n
  • \n

    \n PendingReview: The model card is pending review.

    \n
    • \n
  • \n

    \n Approved: The model card is approved.

    \n
    • \n
  • \n

    \n Archived: The model card is archived. No more updates should be made to the model\n card, but it can still be exported.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "ModelCardVersion": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A version of the model card.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The date and time that the model card version was created.

", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The time date and time that the model card version was last modified.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A summary of a specific version of the model card.

" + } + }, + "com.amazonaws.sagemaker#ModelCardVersionSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ModelCardVersionSummary" + } + }, + "com.amazonaws.sagemaker#ModelClientConfig": { + "type": "structure", + "members": { + "InvocationsTimeoutInSeconds": { + "target": "com.amazonaws.sagemaker#InvocationsTimeoutInSeconds", + "traits": { + "smithy.api#documentation": "

The timeout value in seconds for an invocation request. The default value is\n 600.

" + } + }, + "InvocationsMaxRetries": { + "target": "com.amazonaws.sagemaker#InvocationsMaxRetries", + "traits": { + "smithy.api#documentation": "

The maximum number of retries when invocation requests are failing. The default value\n is 3.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configures the timeout and maximum number of retries for processing a transform job\n invocation.

" + } + }, + "com.amazonaws.sagemaker#ModelCompilationConfig": { + "type": "structure", + "members": { + "Image": { + "target": "com.amazonaws.sagemaker#OptimizationContainerImage", + "traits": { + "smithy.api#documentation": "

The URI of an LMI DLC in Amazon ECR. SageMaker uses this image to run the optimization.

" + } + }, + "OverrideEnvironment": { + "target": "com.amazonaws.sagemaker#OptimizationJobEnvironmentVariables", + "traits": { + "smithy.api#documentation": "

Environment variables that override the default ones in the model container.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Settings for the model compilation technique that's applied by a model optimization job.

" + } + }, + "com.amazonaws.sagemaker#ModelCompressionType": { + "type": "enum", + "members": { + "None": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "None" + } + }, + "Gzip": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Gzip" + } + } + } + }, + "com.amazonaws.sagemaker#ModelConfiguration": { + "type": "structure", + "members": { + "InferenceSpecificationName": { + "target": "com.amazonaws.sagemaker#InferenceSpecificationName", + "traits": { + "smithy.api#documentation": "

The inference specification name in the model package version.

" + } + }, + "EnvironmentParameters": { + "target": "com.amazonaws.sagemaker#EnvironmentParameters", + "traits": { + "smithy.api#documentation": "

Defines the environment parameters that includes key, value types, and values.

" + } + }, + "CompilationJobName": { + "target": "com.amazonaws.sagemaker#RecommendationJobCompilationJobName", + "traits": { + "smithy.api#documentation": "

The name of the compilation job used to create the recommended model artifacts.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines the model configuration. Includes the specification name and environment parameters.

" + } + }, + "com.amazonaws.sagemaker#ModelDashboardEndpoint": { + "type": "structure", + "members": { + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The endpoint name.

", + "smithy.api#required": {} + } + }, + "EndpointArn": { + "target": "com.amazonaws.sagemaker#EndpointArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the endpoint.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A timestamp that indicates when the endpoint was created.

", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The last time the endpoint was modified.

", + "smithy.api#required": {} + } + }, + "EndpointStatus": { + "target": "com.amazonaws.sagemaker#EndpointStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The endpoint status.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An endpoint that hosts a model displayed in the Amazon SageMaker Model Dashboard.

" + } + }, + "com.amazonaws.sagemaker#ModelDashboardEndpoints": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ModelDashboardEndpoint" + } + }, + "com.amazonaws.sagemaker#ModelDashboardIndicatorAction": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the alert action is turned on.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An alert action taken to light up an icon on the Amazon SageMaker Model Dashboard when an alert goes into\n InAlert status.

" + } + }, + "com.amazonaws.sagemaker#ModelDashboardModel": { + "type": "structure", + "members": { + "Model": { + "target": "com.amazonaws.sagemaker#Model", + "traits": { + "smithy.api#documentation": "

A model displayed in the Model Dashboard.

" + } + }, + "Endpoints": { + "target": "com.amazonaws.sagemaker#ModelDashboardEndpoints", + "traits": { + "smithy.api#documentation": "

The endpoints that host a model.

" + } + }, + "LastBatchTransformJob": { + "target": "com.amazonaws.sagemaker#TransformJob" + }, + "MonitoringSchedules": { + "target": "com.amazonaws.sagemaker#ModelDashboardMonitoringSchedules", + "traits": { + "smithy.api#documentation": "

The monitoring schedules for a model.

" + } + }, + "ModelCard": { + "target": "com.amazonaws.sagemaker#ModelDashboardModelCard", + "traits": { + "smithy.api#documentation": "

The model card for a model.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A model displayed in the Amazon SageMaker Model Dashboard.

" + } + }, + "com.amazonaws.sagemaker#ModelDashboardModelCard": { + "type": "structure", + "members": { + "ModelCardArn": { + "target": "com.amazonaws.sagemaker#ModelCardArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for a model card.

" + } + }, + "ModelCardName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#documentation": "

The name of a model card.

" + } + }, + "ModelCardVersion": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "

The model card version.

" + } + }, + "ModelCardStatus": { + "target": "com.amazonaws.sagemaker#ModelCardStatus", + "traits": { + "smithy.api#documentation": "

The model card status.

" + } + }, + "SecurityConfig": { + "target": "com.amazonaws.sagemaker#ModelCardSecurityConfig", + "traits": { + "smithy.api#documentation": "

The KMS Key ID (KMSKeyId) for encryption of model card information.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A timestamp that indicates when the model card was created.

" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A timestamp that indicates when the model card was last updated.

" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

The tags associated with a model card.

" + } + }, + "ModelId": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

For models created in SageMaker, this is the model ARN. For models created\n outside of SageMaker, this is a user-customized string.

" + } + }, + "RiskRating": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

A model card's risk rating. Can be low, medium, or high.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The model card for a model displayed in the Amazon SageMaker Model Dashboard.

" + } + }, + "com.amazonaws.sagemaker#ModelDashboardMonitoringSchedule": { + "type": "structure", + "members": { + "MonitoringScheduleArn": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a monitoring schedule.

" + } + }, + "MonitoringScheduleName": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleName", + "traits": { + "smithy.api#documentation": "

The name of a monitoring schedule.

" + } + }, + "MonitoringScheduleStatus": { + "target": "com.amazonaws.sagemaker#ScheduleStatus", + "traits": { + "smithy.api#documentation": "

The status of the monitoring schedule.

" + } + }, + "MonitoringType": { + "target": "com.amazonaws.sagemaker#MonitoringType", + "traits": { + "smithy.api#documentation": "

The monitor type of a model monitor.

" + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "

If a monitoring job failed, provides the reason.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A timestamp that indicates when the monitoring schedule was created.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A timestamp that indicates when the monitoring schedule was last updated.

" + } + }, + "MonitoringScheduleConfig": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleConfig" + }, + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#documentation": "

The endpoint which is monitored.

" + } + }, + "MonitoringAlertSummaries": { + "target": "com.amazonaws.sagemaker#MonitoringAlertSummaryList", + "traits": { + "smithy.api#documentation": "

A JSON array where each element is a summary for a monitoring alert.

" + } + }, + "LastMonitoringExecutionSummary": { + "target": "com.amazonaws.sagemaker#MonitoringExecutionSummary" + }, + "BatchTransformInput": { + "target": "com.amazonaws.sagemaker#BatchTransformInput" + } + }, + "traits": { + "smithy.api#documentation": "

A monitoring schedule for a model displayed in the Amazon SageMaker Model Dashboard.

" + } + }, + "com.amazonaws.sagemaker#ModelDashboardMonitoringSchedules": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ModelDashboardMonitoringSchedule" + } + }, + "com.amazonaws.sagemaker#ModelDataQuality": { + "type": "structure", + "members": { + "Statistics": { + "target": "com.amazonaws.sagemaker#MetricsSource", + "traits": { + "smithy.api#documentation": "

Data quality statistics for a model.

" + } + }, + "Constraints": { + "target": "com.amazonaws.sagemaker#MetricsSource", + "traits": { + "smithy.api#documentation": "

Data quality constraints for a model.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Data quality constraints and statistics for a model.

" + } + }, + "com.amazonaws.sagemaker#ModelDataSource": { + "type": "structure", + "members": { + "S3DataSource": { + "target": "com.amazonaws.sagemaker#S3ModelDataSource", + "traits": { + "smithy.api#documentation": "

Specifies the S3 location of ML model data to deploy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the location of ML model data to deploy. If specified, you must specify one\n and only one of the available data sources.

" + } + }, + "com.amazonaws.sagemaker#ModelDeployConfig": { + "type": "structure", + "members": { + "AutoGenerateEndpointName": { + "target": "com.amazonaws.sagemaker#AutoGenerateEndpointName", + "traits": { + "smithy.api#documentation": "

Set to True to automatically generate an endpoint name for a one-click\n Autopilot model deployment; set to False otherwise. The default value is\n False.

\n \n

If you set AutoGenerateEndpointName to True, do not specify\n the EndpointName; otherwise a 400 error is thrown.

\n " + } + }, + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#documentation": "

Specifies the endpoint name to use for a one-click Autopilot model deployment if the\n endpoint name is not generated automatically.

\n \n

Specify the EndpointName if and only if you set\n AutoGenerateEndpointName to False; otherwise a 400 error is\n thrown.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies how to generate the endpoint name for an automatic one-click Autopilot model\n deployment.

" + } + }, + "com.amazonaws.sagemaker#ModelDeployResult": { + "type": "structure", + "members": { + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#documentation": "

The name of the endpoint to which the model has been deployed.

\n \n

If model deployment fails, this field is omitted from the response.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about the endpoint of the model deployment.

" + } + }, + "com.amazonaws.sagemaker#ModelDigests": { + "type": "structure", + "members": { + "ArtifactDigest": { + "target": "com.amazonaws.sagemaker#ArtifactDigest", + "traits": { + "smithy.api#documentation": "

Provides a hash value that uniquely identifies the stored model\n artifacts.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information to verify the integrity of stored model artifacts.

" + } + }, + "com.amazonaws.sagemaker#ModelExplainabilityAppSpecification": { + "type": "structure", + "members": { + "ImageUri": { + "target": "com.amazonaws.sagemaker#ImageUri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The container image to be run by the model explainability job.

", + "smithy.api#required": {} + } + }, + "ConfigUri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

JSON formatted Amazon S3 file that defines explainability parameters. For more\n information on this JSON configuration file, see Configure model explainability parameters.

", + "smithy.api#required": {} + } + }, + "Environment": { + "target": "com.amazonaws.sagemaker#MonitoringEnvironmentMap", + "traits": { + "smithy.api#documentation": "

Sets the environment variables in the Docker container.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Docker container image configuration object for the model explainability job.

" + } + }, + "com.amazonaws.sagemaker#ModelExplainabilityBaselineConfig": { + "type": "structure", + "members": { + "BaseliningJobName": { + "target": "com.amazonaws.sagemaker#ProcessingJobName", + "traits": { + "smithy.api#documentation": "

The name of the baseline model explainability job.

" + } + }, + "ConstraintsResource": { + "target": "com.amazonaws.sagemaker#MonitoringConstraintsResource" + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for a baseline model explainability job.

" + } + }, + "com.amazonaws.sagemaker#ModelExplainabilityJobInput": { + "type": "structure", + "members": { + "EndpointInput": { + "target": "com.amazonaws.sagemaker#EndpointInput" + }, + "BatchTransformInput": { + "target": "com.amazonaws.sagemaker#BatchTransformInput", + "traits": { + "smithy.api#documentation": "

Input object for the batch transform job.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Inputs for the model explainability job.

" + } + }, + "com.amazonaws.sagemaker#ModelInfrastructureConfig": { + "type": "structure", + "members": { + "InfrastructureType": { + "target": "com.amazonaws.sagemaker#ModelInfrastructureType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The inference option to which to deploy your model. Possible values are the following:

\n
    \n
  • \n

    \n RealTime: Deploy to real-time inference.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "RealTimeInferenceConfig": { + "target": "com.amazonaws.sagemaker#RealTimeInferenceConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The infrastructure configuration for deploying the model to real-time inference.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for the infrastructure that the model will be deployed to.

" + } + }, + "com.amazonaws.sagemaker#ModelInfrastructureType": { + "type": "enum", + "members": { + "REAL_TIME_INFERENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RealTimeInference" + } + } + } + }, + "com.amazonaws.sagemaker#ModelInput": { + "type": "structure", + "members": { + "DataInputConfig": { + "target": "com.amazonaws.sagemaker#DataInputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The input configuration object for the model.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Input object for the model.

" + } + }, + "com.amazonaws.sagemaker#ModelInsightsLocation": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#ModelLatencyThreshold": { + "type": "structure", + "members": { + "Percentile": { + "target": "com.amazonaws.sagemaker#String64", + "traits": { + "smithy.api#documentation": "

The model latency percentile threshold. Acceptable values are P95 and P99.\n For custom load tests, specify the value as P95.

" + } + }, + "ValueInMilliseconds": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "

The model latency percentile value in milliseconds.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The model latency threshold.

" + } + }, + "com.amazonaws.sagemaker#ModelLatencyThresholds": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ModelLatencyThreshold" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.sagemaker#ModelLifeCycle": { + "type": "structure", + "members": { + "Stage": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

\n The current stage in the model life cycle.\n

", + "smithy.api#required": {} + } + }, + "StageStatus": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

\n The current status of a stage in model life cycle.\n

", + "smithy.api#required": {} + } + }, + "StageDescription": { + "target": "com.amazonaws.sagemaker#StageDescription", + "traits": { + "smithy.api#documentation": "

\n Describes the stage related details.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n A structure describing the current state of the model in its life cycle.\n

" + } + }, + "com.amazonaws.sagemaker#ModelMetadataFilter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#ModelMetadataFilterType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the of the model to filter by.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The value to filter the model metadata.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Part of the search expression. You can specify the name and value \n (domain, task, framework, framework version, task, and model).

" + } + }, + "com.amazonaws.sagemaker#ModelMetadataFilterType": { + "type": "enum", + "members": { + "DOMAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Domain" + } + }, + "FRAMEWORK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Framework" + } + }, + "TASK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Task" + } + }, + "FRAMEWORKVERSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FrameworkVersion" + } + } + } + }, + "com.amazonaws.sagemaker#ModelMetadataFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ModelMetadataFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4 + } + } + }, + "com.amazonaws.sagemaker#ModelMetadataSearchExpression": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.sagemaker#ModelMetadataFilters", + "traits": { + "smithy.api#documentation": "

A list of filter objects.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

One or more filters that searches for the specified resource or resources in \n a search. All resource objects that satisfy the expression's condition are \n included in the search results

" + } + }, + "com.amazonaws.sagemaker#ModelMetadataSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ModelMetadataSummary" + } + }, + "com.amazonaws.sagemaker#ModelMetadataSummary": { + "type": "structure", + "members": { + "Domain": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The machine learning domain of the model.

", + "smithy.api#required": {} + } + }, + "Framework": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The machine learning framework of the model.

", + "smithy.api#required": {} + } + }, + "Task": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The machine learning task of the model.

", + "smithy.api#required": {} + } + }, + "Model": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the model.

", + "smithy.api#required": {} + } + }, + "FrameworkVersion": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The framework version of the model.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A summary of the model metadata.

" + } + }, + "com.amazonaws.sagemaker#ModelMetrics": { + "type": "structure", + "members": { + "ModelQuality": { + "target": "com.amazonaws.sagemaker#ModelQuality", + "traits": { + "smithy.api#documentation": "

Metrics that measure the quality of a model.

" + } + }, + "ModelDataQuality": { + "target": "com.amazonaws.sagemaker#ModelDataQuality", + "traits": { + "smithy.api#documentation": "

Metrics that measure the quality of the input data for a model.

" + } + }, + "Bias": { + "target": "com.amazonaws.sagemaker#Bias", + "traits": { + "smithy.api#documentation": "

Metrics that measure bias in a model.

" + } + }, + "Explainability": { + "target": "com.amazonaws.sagemaker#Explainability", + "traits": { + "smithy.api#documentation": "

Metrics that help explain a model.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains metrics captured from a model.

" + } + }, + "com.amazonaws.sagemaker#ModelName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]([\\-a-zA-Z0-9]*[a-zA-Z0-9])?$" + } + }, + "com.amazonaws.sagemaker#ModelNameContains": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.sagemaker#ModelPackage": { + "type": "structure", + "members": { + "ModelPackageName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the model.

" + } + }, + "ModelPackageGroupName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#documentation": "

The model group to which the model belongs.

" + } + }, + "ModelPackageVersion": { + "target": "com.amazonaws.sagemaker#ModelPackageVersion", + "traits": { + "smithy.api#documentation": "

The version number of a versioned model.

" + } + }, + "ModelPackageArn": { + "target": "com.amazonaws.sagemaker#ModelPackageArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model package.

" + } + }, + "ModelPackageDescription": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "

The description of the model package.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "

The time that the model package was created.

" + } + }, + "InferenceSpecification": { + "target": "com.amazonaws.sagemaker#InferenceSpecification", + "traits": { + "smithy.api#documentation": "

Defines how to perform inference generation after a training job is run.

" + } + }, + "SourceAlgorithmSpecification": { + "target": "com.amazonaws.sagemaker#SourceAlgorithmSpecification", + "traits": { + "smithy.api#documentation": "

A list of algorithms that were used to create a model package.

" + } + }, + "ValidationSpecification": { + "target": "com.amazonaws.sagemaker#ModelPackageValidationSpecification", + "traits": { + "smithy.api#documentation": "

Specifies batch transform jobs that SageMaker runs to validate your model package.

" + } + }, + "ModelPackageStatus": { + "target": "com.amazonaws.sagemaker#ModelPackageStatus", + "traits": { + "smithy.api#documentation": "

The status of the model package. This can be one of the following values.

\n
    \n
  • \n

    \n PENDING - The model package is pending being created.

    \n
    • \n
  • \n

    \n IN_PROGRESS - The model package is in the process of being\n created.

    \n
    • \n
  • \n

    \n COMPLETED - The model package was successfully created.

    \n
    • \n
  • \n

    \n FAILED - The model package failed.

    \n
    • \n
  • \n

    \n DELETING - The model package is in the process of being deleted.

    \n
    • \n
" + } + }, + "ModelPackageStatusDetails": { + "target": "com.amazonaws.sagemaker#ModelPackageStatusDetails", + "traits": { + "smithy.api#documentation": "

Specifies the validation and image scan statuses of the model package.

" + } + }, + "CertifyForMarketplace": { + "target": "com.amazonaws.sagemaker#CertifyForMarketplace", + "traits": { + "smithy.api#documentation": "

Whether the model package is to be certified to be listed on Amazon Web Services Marketplace. For\n information about listing model packages on Amazon Web Services Marketplace, see List Your\n Algorithm or Model Package on Amazon Web Services Marketplace.

" + } + }, + "ModelApprovalStatus": { + "target": "com.amazonaws.sagemaker#ModelApprovalStatus", + "traits": { + "smithy.api#documentation": "

The approval status of the model. This can be one of the following values.

\n
    \n
  • \n

    \n APPROVED - The model is approved

    \n
    • \n
  • \n

    \n REJECTED - The model is rejected.

    \n
    • \n
  • \n

    \n PENDING_MANUAL_APPROVAL - The model is waiting for manual\n approval.

    \n
    • \n
" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext", + "traits": { + "smithy.api#documentation": "

Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.

" + } + }, + "MetadataProperties": { + "target": "com.amazonaws.sagemaker#MetadataProperties", + "traits": { + "smithy.api#documentation": "

Metadata properties of the tracking entity, trial, or trial component.

" + } + }, + "ModelMetrics": { + "target": "com.amazonaws.sagemaker#ModelMetrics", + "traits": { + "smithy.api#documentation": "

Metrics for the model.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The last time the model package was modified.

" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext", + "traits": { + "smithy.api#documentation": "

Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.

" + } + }, + "ApprovalDescription": { + "target": "com.amazonaws.sagemaker#ApprovalDescription", + "traits": { + "smithy.api#documentation": "

A description provided when the model approval is set.

" + } + }, + "Domain": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The machine learning domain of your model package and its components. Common\n machine learning domains include computer vision and natural language processing.

" + } + }, + "Task": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The machine learning task your model package accomplishes. Common machine\n learning tasks include object detection and image classification.

" + } + }, + "SamplePayloadUrl": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The Amazon Simple Storage Service path where the sample payload are stored. This path must point to\n a single gzip compressed tar archive (.tar.gz suffix).

" + } + }, + "AdditionalInferenceSpecifications": { + "target": "com.amazonaws.sagemaker#AdditionalInferenceSpecifications", + "traits": { + "smithy.api#documentation": "

An array of additional Inference Specification objects.

" + } + }, + "SourceUri": { + "target": "com.amazonaws.sagemaker#ModelPackageSourceUri", + "traits": { + "smithy.api#documentation": "

The URI of the source for the model package.

" + } + }, + "SecurityConfig": { + "target": "com.amazonaws.sagemaker#ModelPackageSecurityConfig" + }, + "ModelCard": { + "target": "com.amazonaws.sagemaker#ModelPackageModelCard" + }, + "ModelLifeCycle": { + "target": "com.amazonaws.sagemaker#ModelLifeCycle", + "traits": { + "smithy.api#documentation": "

\n A structure describing the current state of the model in its life cycle.\n

" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

A list of the tags associated with the model package. For more information, see Tagging Amazon Web Services\n resources in the Amazon Web Services General Reference Guide.

" + } + }, + "CustomerMetadataProperties": { + "target": "com.amazonaws.sagemaker#CustomerMetadataMap", + "traits": { + "smithy.api#documentation": "

The metadata properties for the model package.

" + } + }, + "DriftCheckBaselines": { + "target": "com.amazonaws.sagemaker#DriftCheckBaselines", + "traits": { + "smithy.api#documentation": "

Represents the drift check baselines that can be used when the model monitor is set using the model package.

" + } + }, + "SkipModelValidation": { + "target": "com.amazonaws.sagemaker#SkipModelValidation", + "traits": { + "smithy.api#documentation": "

Indicates if you want to skip model validation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A versioned model that can be deployed for SageMaker inference.

" + } + }, + "com.amazonaws.sagemaker#ModelPackageArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-cn|-us-gov|-iso-f)?:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:model-package/[\\S]{1,2048}$" + } + }, + "com.amazonaws.sagemaker#ModelPackageArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ModelPackageArn" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#ModelPackageContainerDefinition": { + "type": "structure", + "members": { + "ContainerHostname": { + "target": "com.amazonaws.sagemaker#ContainerHostname", + "traits": { + "smithy.api#documentation": "

The DNS host name for the Docker container.

" + } + }, + "Image": { + "target": "com.amazonaws.sagemaker#ContainerImage", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon EC2 Container Registry path where inference code is stored.

\n

If you are using your own custom algorithm instead of an algorithm provided by SageMaker,\n the inference code must meet SageMaker requirements. SageMaker supports both\n registry/repository[:tag] and registry/repository[@digest]\n image path formats. For more information, see Using Your Own Algorithms with Amazon\n SageMaker.

", + "smithy.api#required": {} + } + }, + "ImageDigest": { + "target": "com.amazonaws.sagemaker#ImageDigest", + "traits": { + "smithy.api#documentation": "

An MD5 hash of the training algorithm that identifies the Docker image used for\n training.

" + } + }, + "ModelDataUrl": { + "target": "com.amazonaws.sagemaker#Url", + "traits": { + "smithy.api#documentation": "

The Amazon S3 path where the model artifacts, which result from model training, are stored.\n This path must point to a single gzip compressed tar archive\n (.tar.gz suffix).

\n \n

The model artifacts must be in an S3 bucket that is in the same region as the\n model package.

\n " + } + }, + "ModelDataSource": { + "target": "com.amazonaws.sagemaker#ModelDataSource", + "traits": { + "smithy.api#documentation": "

Specifies the location of ML model data to deploy during endpoint creation.

" + } + }, + "ProductId": { + "target": "com.amazonaws.sagemaker#ProductId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Marketplace product ID of the model package.

" + } + }, + "Environment": { + "target": "com.amazonaws.sagemaker#EnvironmentMap", + "traits": { + "smithy.api#documentation": "

The environment variables to set in the Docker container. Each key and value in the\n Environment string to string map can have length of up to 1024. We\n support up to 16 entries in the map.

" + } + }, + "ModelInput": { + "target": "com.amazonaws.sagemaker#ModelInput", + "traits": { + "smithy.api#documentation": "

A structure with Model Input details.

" + } + }, + "Framework": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The machine learning framework of the model package container image.

" + } + }, + "FrameworkVersion": { + "target": "com.amazonaws.sagemaker#ModelPackageFrameworkVersion", + "traits": { + "smithy.api#documentation": "

The framework version of the Model Package Container Image.

" + } + }, + "NearestModelName": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The name of a pre-trained machine learning benchmarked by \n Amazon SageMaker Inference Recommender model that matches your model. \n You can find a list of benchmarked models by calling ListModelMetadata.

" + } + }, + "AdditionalS3DataSource": { + "target": "com.amazonaws.sagemaker#AdditionalS3DataSource", + "traits": { + "smithy.api#documentation": "

The additional data source that is used during inference in the Docker container for\n your model package.

" + } + }, + "ModelDataETag": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The ETag associated with Model Data URL.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the Docker container for the model package.

" + } + }, + "com.amazonaws.sagemaker#ModelPackageContainerDefinitionList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ModelPackageContainerDefinition" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 15 + } + } + }, + "com.amazonaws.sagemaker#ModelPackageFrameworkVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 10 + }, + "smithy.api#pattern": "^[0-9]\\.[A-Za-z0-9.-]+$" + } + }, + "com.amazonaws.sagemaker#ModelPackageGroup": { + "type": "structure", + "members": { + "ModelPackageGroupName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the model group.

" + } + }, + "ModelPackageGroupArn": { + "target": "com.amazonaws.sagemaker#ModelPackageGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model group.

" + } + }, + "ModelPackageGroupDescription": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "

The description for the model group.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "

The time that the model group was created.

" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "ModelPackageGroupStatus": { + "target": "com.amazonaws.sagemaker#ModelPackageGroupStatus", + "traits": { + "smithy.api#documentation": "

The status of the model group. This can be one of the following values.

\n
    \n
  • \n

    \n PENDING - The model group is pending being created.

    \n
    • \n
  • \n

    \n IN_PROGRESS - The model group is in the process of being\n created.

    \n
    • \n
  • \n

    \n COMPLETED - The model group was successfully created.

    \n
    • \n
  • \n

    \n FAILED - The model group failed.

    \n
    • \n
  • \n

    \n DELETING - The model group is in the process of being deleted.

    \n
    • \n
  • \n

    \n DELETE_FAILED - SageMaker failed to delete the model group.

    \n
    • \n
" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

A list of the tags associated with the model group. For more information, see Tagging Amazon Web Services\n resources in the Amazon Web Services General Reference Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A group of versioned models in the model registry.

" + } + }, + "com.amazonaws.sagemaker#ModelPackageGroupArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-cn|-us-gov|-iso-f)?:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:model-package-group/[\\S]{1,2048}$" + } + }, + "com.amazonaws.sagemaker#ModelPackageGroupSortBy": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + } + } + }, + "com.amazonaws.sagemaker#ModelPackageGroupStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteFailed" + } + } + } + }, + "com.amazonaws.sagemaker#ModelPackageGroupSummary": { + "type": "structure", + "members": { + "ModelPackageGroupName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the model group.

", + "smithy.api#required": {} + } + }, + "ModelPackageGroupArn": { + "target": "com.amazonaws.sagemaker#ModelPackageGroupArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model group.

", + "smithy.api#required": {} + } + }, + "ModelPackageGroupDescription": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "

A description of the model group.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The time that the model group was created.

", + "smithy.api#required": {} + } + }, + "ModelPackageGroupStatus": { + "target": "com.amazonaws.sagemaker#ModelPackageGroupStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of the model group.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Summary information about a model group.

" + } + }, + "com.amazonaws.sagemaker#ModelPackageGroupSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ModelPackageGroupSummary" + } + }, + "com.amazonaws.sagemaker#ModelPackageModelCard": { + "type": "structure", + "members": { + "ModelCardContent": { + "target": "com.amazonaws.sagemaker#ModelCardContent", + "traits": { + "smithy.api#documentation": "

The content of the model card. The content must follow the schema described\n in Model\n Package Model Card Schema.

" + } + }, + "ModelCardStatus": { + "target": "com.amazonaws.sagemaker#ModelCardStatus", + "traits": { + "smithy.api#documentation": "

The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

\n
    \n
  • \n

    \n Draft: The model card is a work in progress.

    \n
    • \n
  • \n

    \n PendingReview: The model card is pending review.

    \n
    • \n
  • \n

    \n Approved: The model card is approved.

    \n
    • \n
  • \n

    \n Archived: The model card is archived. No more updates can be made to the model\n card content. If you try to update the model card content, you will receive the message Model Card\n \t is in Archived state.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

The model card associated with the model package. Since ModelPackageModelCard is\n tied to a model package, it is a specific usage of a model card and its schema is\n simplified compared to the schema of ModelCard. The \n ModelPackageModelCard schema does not include model_package_details,\n and model_overview is composed of the model_creator and\n model_artifact properties. For more information about the model package model\n card schema, see Model\n package model card schema. For more information about\n the model card associated with the model package, see View\n the Details of a Model Version.

" + } + }, + "com.amazonaws.sagemaker#ModelPackageSecurityConfig": { + "type": "structure", + "members": { + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The KMS Key ID (KMSKeyId) used for encryption of model package information.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An optional Key Management Service\n key to encrypt, decrypt, and re-encrypt model package information for regulated workloads with\n highly sensitive data.

" + } + }, + "com.amazonaws.sagemaker#ModelPackageSortBy": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + } + } + }, + "com.amazonaws.sagemaker#ModelPackageSourceUri": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^[\\p{L}\\p{M}\\p{Z}\\p{N}\\p{P}]{0,1024}$" + } + }, + "com.amazonaws.sagemaker#ModelPackageStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + } + } + }, + "com.amazonaws.sagemaker#ModelPackageStatusDetails": { + "type": "structure", + "members": { + "ValidationStatuses": { + "target": "com.amazonaws.sagemaker#ModelPackageStatusItemList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The validation status of the model package.

", + "smithy.api#required": {} + } + }, + "ImageScanStatuses": { + "target": "com.amazonaws.sagemaker#ModelPackageStatusItemList", + "traits": { + "smithy.api#documentation": "

The status of the scan of the Docker image container for the model package.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the validation and image scan statuses of the model package.

" + } + }, + "com.amazonaws.sagemaker#ModelPackageStatusItem": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the model package for which the overall status is being reported.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#DetailedModelPackageStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The current status.

", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

if the overall status is Failed, the reason for the failure.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the overall status of a model package.

" + } + }, + "com.amazonaws.sagemaker#ModelPackageStatusItemList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ModelPackageStatusItem" + } + }, + "com.amazonaws.sagemaker#ModelPackageSummaries": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#ModelPackageArn" + }, + "value": { + "target": "com.amazonaws.sagemaker#BatchDescribeModelPackageSummary" + } + }, + "com.amazonaws.sagemaker#ModelPackageSummary": { + "type": "structure", + "members": { + "ModelPackageName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the model package.

" + } + }, + "ModelPackageGroupName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#documentation": "

If the model package is a versioned model, the model group that the versioned model\n belongs to.

" + } + }, + "ModelPackageVersion": { + "target": "com.amazonaws.sagemaker#ModelPackageVersion", + "traits": { + "smithy.api#documentation": "

If the model package is a versioned model, the version of the model.

" + } + }, + "ModelPackageArn": { + "target": "com.amazonaws.sagemaker#ModelPackageArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model package.

", + "smithy.api#required": {} + } + }, + "ModelPackageDescription": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "

A brief description of the model package.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A timestamp that shows when the model package was created.

", + "smithy.api#required": {} + } + }, + "ModelPackageStatus": { + "target": "com.amazonaws.sagemaker#ModelPackageStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The overall status of the model package.

", + "smithy.api#required": {} + } + }, + "ModelApprovalStatus": { + "target": "com.amazonaws.sagemaker#ModelApprovalStatus", + "traits": { + "smithy.api#documentation": "

The approval status of the model. This can be one of the following values.

\n
    \n
  • \n

    \n APPROVED - The model is approved

    \n
    • \n
  • \n

    \n REJECTED - The model is rejected.

    \n
    • \n
  • \n

    \n PENDING_MANUAL_APPROVAL - The model is waiting for manual\n approval.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides summary information about a model package.

" + } + }, + "com.amazonaws.sagemaker#ModelPackageSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ModelPackageSummary" + } + }, + "com.amazonaws.sagemaker#ModelPackageType": { + "type": "enum", + "members": { + "VERSIONED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Versioned" + } + }, + "UNVERSIONED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Unversioned" + } + }, + "BOTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Both" + } + } + } + }, + "com.amazonaws.sagemaker#ModelPackageValidationProfile": { + "type": "structure", + "members": { + "ProfileName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the profile for the model package.

", + "smithy.api#required": {} + } + }, + "TransformJobDefinition": { + "target": "com.amazonaws.sagemaker#TransformJobDefinition", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The TransformJobDefinition object that describes the transform job used\n for the validation of the model package.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains data, such as the inputs and targeted instance types that are used in the\n process of validating the model package.

\n

The data provided in the validation profile is made available to your buyers on Amazon Web Services\n Marketplace.

" + } + }, + "com.amazonaws.sagemaker#ModelPackageValidationProfiles": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ModelPackageValidationProfile" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.sagemaker#ModelPackageValidationSpecification": { + "type": "structure", + "members": { + "ValidationRole": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IAM roles to be used for the validation of the model package.

", + "smithy.api#required": {} + } + }, + "ValidationProfiles": { + "target": "com.amazonaws.sagemaker#ModelPackageValidationProfiles", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An array of ModelPackageValidationProfile objects, each of which\n specifies a batch transform job that SageMaker runs to validate your model package.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies batch transform jobs that SageMaker runs to validate your model package.

" + } + }, + "com.amazonaws.sagemaker#ModelPackageVersion": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#ModelQuality": { + "type": "structure", + "members": { + "Statistics": { + "target": "com.amazonaws.sagemaker#MetricsSource", + "traits": { + "smithy.api#documentation": "

Model quality statistics.

" + } + }, + "Constraints": { + "target": "com.amazonaws.sagemaker#MetricsSource", + "traits": { + "smithy.api#documentation": "

Model quality constraints.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Model quality statistics and constraints.

" + } + }, + "com.amazonaws.sagemaker#ModelQualityAppSpecification": { + "type": "structure", + "members": { + "ImageUri": { + "target": "com.amazonaws.sagemaker#ImageUri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The address of the container image that the monitoring job runs.

", + "smithy.api#required": {} + } + }, + "ContainerEntrypoint": { + "target": "com.amazonaws.sagemaker#ContainerEntrypoint", + "traits": { + "smithy.api#documentation": "

Specifies the entrypoint for a container that the monitoring job runs.

" + } + }, + "ContainerArguments": { + "target": "com.amazonaws.sagemaker#MonitoringContainerArguments", + "traits": { + "smithy.api#documentation": "

An array of arguments for the container used to run the monitoring job.

" + } + }, + "RecordPreprocessorSourceUri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "

An Amazon S3 URI to a script that is called per row prior to running analysis. It can \n base64 decode the payload and convert it into a flattened JSON so that the built-in container can use \n the converted data. Applicable only for the built-in (first party) containers.

" + } + }, + "PostAnalyticsProcessorSourceUri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "

An Amazon S3 URI to a script that is called after analysis has been performed. Applicable \n only for the built-in (first party) containers.

" + } + }, + "ProblemType": { + "target": "com.amazonaws.sagemaker#MonitoringProblemType", + "traits": { + "smithy.api#documentation": "

The machine learning problem type of the model that the monitoring job monitors.

" + } + }, + "Environment": { + "target": "com.amazonaws.sagemaker#MonitoringEnvironmentMap", + "traits": { + "smithy.api#documentation": "

Sets the environment variables in the container that the monitoring job runs.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Container image configuration object for the monitoring job.

" + } + }, + "com.amazonaws.sagemaker#ModelQualityBaselineConfig": { + "type": "structure", + "members": { + "BaseliningJobName": { + "target": "com.amazonaws.sagemaker#ProcessingJobName", + "traits": { + "smithy.api#documentation": "

The name of the job that performs baselining for the monitoring job.

" + } + }, + "ConstraintsResource": { + "target": "com.amazonaws.sagemaker#MonitoringConstraintsResource" + } + }, + "traits": { + "smithy.api#documentation": "

Configuration for monitoring constraints and monitoring statistics. These baseline resources are \n compared against the results of the current job from the series of jobs scheduled to collect data \n periodically.

" + } + }, + "com.amazonaws.sagemaker#ModelQualityJobInput": { + "type": "structure", + "members": { + "EndpointInput": { + "target": "com.amazonaws.sagemaker#EndpointInput" + }, + "BatchTransformInput": { + "target": "com.amazonaws.sagemaker#BatchTransformInput", + "traits": { + "smithy.api#documentation": "

Input object for the batch transform job.

" + } + }, + "GroundTruthS3Input": { + "target": "com.amazonaws.sagemaker#MonitoringGroundTruthS3Input", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ground truth label provided for the model.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The input for the model quality monitoring job. Currently endpoints are supported for\n input for model quality monitoring jobs.

" + } + }, + "com.amazonaws.sagemaker#ModelQuantizationConfig": { + "type": "structure", + "members": { + "Image": { + "target": "com.amazonaws.sagemaker#OptimizationContainerImage", + "traits": { + "smithy.api#documentation": "

The URI of an LMI DLC in Amazon ECR. SageMaker uses this image to run the optimization.

" + } + }, + "OverrideEnvironment": { + "target": "com.amazonaws.sagemaker#OptimizationJobEnvironmentVariables", + "traits": { + "smithy.api#documentation": "

Environment variables that override the default ones in the model container.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Settings for the model quantization technique that's applied by a model optimization job.

" + } + }, + "com.amazonaws.sagemaker#ModelRegisterSettings": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.sagemaker#FeatureStatus", + "traits": { + "smithy.api#documentation": "

Describes whether the integration to the model registry is enabled or disabled in the\n Canvas application.

" + } + }, + "CrossAccountModelRegisterRoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SageMaker model registry account. Required only to register model versions\n created by a different SageMaker Canvas Amazon Web Services account than the Amazon Web Services\n account in which SageMaker model registry is set up.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The model registry settings for the SageMaker Canvas application.

" + } + }, + "com.amazonaws.sagemaker#ModelSetupTime": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.sagemaker#ModelShardingConfig": { + "type": "structure", + "members": { + "Image": { + "target": "com.amazonaws.sagemaker#OptimizationContainerImage", + "traits": { + "smithy.api#documentation": "

The URI of an LMI DLC in Amazon ECR. SageMaker uses this image to run the optimization.

" + } + }, + "OverrideEnvironment": { + "target": "com.amazonaws.sagemaker#OptimizationJobEnvironmentVariables", + "traits": { + "smithy.api#documentation": "

Environment variables that override the default ones in the model container.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Settings for the model sharding technique that's applied by a model optimization job.

" + } + }, + "com.amazonaws.sagemaker#ModelSortKey": { + "type": "enum", + "members": { + "Name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CreationTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + } + } + }, + "com.amazonaws.sagemaker#ModelStepMetadata": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the created model.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Metadata for Model steps.

" + } + }, + "com.amazonaws.sagemaker#ModelSummary": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.sagemaker#ModelName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the model that you want a summary for.

", + "smithy.api#required": {} + } + }, + "ModelArn": { + "target": "com.amazonaws.sagemaker#ModelArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A timestamp that indicates when the model was created.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides summary information about a model.

" + } + }, + "com.amazonaws.sagemaker#ModelSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ModelSummary" + } + }, + "com.amazonaws.sagemaker#ModelVariantAction": { + "type": "enum", + "members": { + "RETAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Retain" + } + }, + "REMOVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Remove" + } + }, + "PROMOTE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Promote" + } + } + } + }, + "com.amazonaws.sagemaker#ModelVariantActionMap": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#ModelVariantName" + }, + "value": { + "target": "com.amazonaws.sagemaker#ModelVariantAction" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.sagemaker#ModelVariantConfig": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.sagemaker#ModelName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Amazon SageMaker Model entity.

", + "smithy.api#required": {} + } + }, + "VariantName": { + "target": "com.amazonaws.sagemaker#ModelVariantName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the variant.

", + "smithy.api#required": {} + } + }, + "InfrastructureConfig": { + "target": "com.amazonaws.sagemaker#ModelInfrastructureConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The configuration for the infrastructure that the model will be deployed to.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the deployment options of a model.

" + } + }, + "com.amazonaws.sagemaker#ModelVariantConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ModelVariantConfig" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.sagemaker#ModelVariantConfigSummary": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.sagemaker#ModelName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Amazon SageMaker Model entity.

", + "smithy.api#required": {} + } + }, + "VariantName": { + "target": "com.amazonaws.sagemaker#ModelVariantName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the variant.

", + "smithy.api#required": {} + } + }, + "InfrastructureConfig": { + "target": "com.amazonaws.sagemaker#ModelInfrastructureConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The configuration of the infrastructure that the model has been deployed to.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#ModelVariantStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of deployment for the model variant on the hosted inference endpoint.

\n
    \n
  • \n

    \n Creating - Amazon SageMaker is preparing the model variant on the hosted inference endpoint.\n

    \n
    • \n
  • \n

    \n InService - The model variant is running on the hosted inference endpoint.\n

    \n
    • \n
  • \n

    \n Updating - Amazon SageMaker is updating the model variant on the hosted inference endpoint.\n

    \n
    • \n
  • \n

    \n Deleting - Amazon SageMaker is deleting the model variant on the hosted inference endpoint.\n

    \n
    • \n
  • \n

    \n Deleted - The model variant has been deleted on the hosted inference endpoint. This\n can only happen after stopping the experiment.\n

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Summary of the deployment configuration of a model.

" + } + }, + "com.amazonaws.sagemaker#ModelVariantConfigSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ModelVariantConfigSummary" + } + }, + "com.amazonaws.sagemaker#ModelVariantName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]([\\-a-zA-Z0-9]*[a-zA-Z0-9])?$" + } + }, + "com.amazonaws.sagemaker#ModelVariantStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Creating" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + }, + "IN_SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InService" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleted" + } + } + } + }, + "com.amazonaws.sagemaker#MonitoringAlertActions": { + "type": "structure", + "members": { + "ModelDashboardIndicator": { + "target": "com.amazonaws.sagemaker#ModelDashboardIndicatorAction", + "traits": { + "smithy.api#documentation": "

An alert action taken to light up an icon on the Model Dashboard when an alert goes into\n InAlert status.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of alert actions taken in response to an alert going into\n InAlert status.

" + } + }, + "com.amazonaws.sagemaker#MonitoringAlertHistoryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#MonitoringAlertHistorySummary" + } + }, + "com.amazonaws.sagemaker#MonitoringAlertHistorySortKey": { + "type": "enum", + "members": { + "CreationTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "Status": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + } + } + }, + "com.amazonaws.sagemaker#MonitoringAlertHistorySummary": { + "type": "structure", + "members": { + "MonitoringScheduleName": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of a monitoring schedule.

", + "smithy.api#required": {} + } + }, + "MonitoringAlertName": { + "target": "com.amazonaws.sagemaker#MonitoringAlertName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of a monitoring alert.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A timestamp that indicates when the first alert transition occurred in an alert history.\n An alert transition can be from status InAlert to OK, \n or from OK to InAlert.

", + "smithy.api#required": {} + } + }, + "AlertStatus": { + "target": "com.amazonaws.sagemaker#MonitoringAlertStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The current alert status of an alert.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides summary information of an alert's history.

" + } + }, + "com.amazonaws.sagemaker#MonitoringAlertName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#MonitoringAlertStatus": { + "type": "enum", + "members": { + "IN_ALERT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InAlert" + } + }, + "OK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OK" + } + } + } + }, + "com.amazonaws.sagemaker#MonitoringAlertSummary": { + "type": "structure", + "members": { + "MonitoringAlertName": { + "target": "com.amazonaws.sagemaker#MonitoringAlertName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of a monitoring alert.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A timestamp that indicates when a monitor alert was created.

", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A timestamp that indicates when a monitor alert was last updated.

", + "smithy.api#required": {} + } + }, + "AlertStatus": { + "target": "com.amazonaws.sagemaker#MonitoringAlertStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The current status of an alert.

", + "smithy.api#required": {} + } + }, + "DatapointsToAlert": { + "target": "com.amazonaws.sagemaker#MonitoringDatapointsToAlert", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Within EvaluationPeriod, how many execution failures will raise an\n alert.

", + "smithy.api#required": {} + } + }, + "EvaluationPeriod": { + "target": "com.amazonaws.sagemaker#MonitoringEvaluationPeriod", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of most recent monitoring executions to consider when evaluating alert\n status.

", + "smithy.api#required": {} + } + }, + "Actions": { + "target": "com.amazonaws.sagemaker#MonitoringAlertActions", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A list of alert actions taken in response to an alert going into\n InAlert status.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides summary information about a monitor alert.

" + } + }, + "com.amazonaws.sagemaker#MonitoringAlertSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#MonitoringAlertSummary" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#MonitoringAppSpecification": { + "type": "structure", + "members": { + "ImageUri": { + "target": "com.amazonaws.sagemaker#ImageUri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The container image to be run by the monitoring job.

", + "smithy.api#required": {} + } + }, + "ContainerEntrypoint": { + "target": "com.amazonaws.sagemaker#ContainerEntrypoint", + "traits": { + "smithy.api#documentation": "

Specifies the entrypoint for a container used to run the monitoring job.

" + } + }, + "ContainerArguments": { + "target": "com.amazonaws.sagemaker#MonitoringContainerArguments", + "traits": { + "smithy.api#documentation": "

An array of arguments for the container used to run the monitoring job.

" + } + }, + "RecordPreprocessorSourceUri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "

An Amazon S3 URI to a script that is called per row prior to running analysis. It can \n base64 decode the payload and convert it into a flattened JSON so that the built-in container can use \n the converted data. Applicable only for the built-in (first party) containers.

" + } + }, + "PostAnalyticsProcessorSourceUri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "

An Amazon S3 URI to a script that is called after analysis has been performed. Applicable \n only for the built-in (first party) containers.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Container image configuration object for the monitoring job.

" + } + }, + "com.amazonaws.sagemaker#MonitoringBaselineConfig": { + "type": "structure", + "members": { + "BaseliningJobName": { + "target": "com.amazonaws.sagemaker#ProcessingJobName", + "traits": { + "smithy.api#documentation": "

The name of the job that performs baselining for the monitoring job.

" + } + }, + "ConstraintsResource": { + "target": "com.amazonaws.sagemaker#MonitoringConstraintsResource", + "traits": { + "smithy.api#documentation": "

The baseline constraint file in Amazon S3 that the current monitoring job should\n validated against.

" + } + }, + "StatisticsResource": { + "target": "com.amazonaws.sagemaker#MonitoringStatisticsResource", + "traits": { + "smithy.api#documentation": "

The baseline statistics file in Amazon S3 that the current monitoring job should\n be validated against.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration for monitoring constraints and monitoring statistics. These baseline resources are \n compared against the results of the current job from the series of jobs scheduled to collect data \n periodically.

" + } + }, + "com.amazonaws.sagemaker#MonitoringClusterConfig": { + "type": "structure", + "members": { + "InstanceCount": { + "target": "com.amazonaws.sagemaker#ProcessingInstanceCount", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of ML compute instances to use in the model monitoring job. For distributed\n processing jobs, specify a value greater than 1. The default value is 1.

", + "smithy.api#required": {} + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#ProcessingInstanceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ML compute instance type for the processing job.

", + "smithy.api#required": {} + } + }, + "VolumeSizeInGB": { + "target": "com.amazonaws.sagemaker#ProcessingVolumeSizeInGB", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The size of the ML storage volume, in gigabytes, that you want to provision. You must\n specify sufficient ML storage for your scenario.

", + "smithy.api#required": {} + } + }, + "VolumeKmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The Key Management Service (KMS) key that Amazon SageMaker AI uses to\n encrypt data on the storage volume attached to the ML compute instance(s) that run the\n model monitoring job.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration for the cluster used to run model monitoring jobs.

" + } + }, + "com.amazonaws.sagemaker#MonitoringConstraintsResource": { + "type": "structure", + "members": { + "S3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "

The Amazon S3 URI for the constraints resource.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The constraints resource for a monitoring job.

" + } + }, + "com.amazonaws.sagemaker#MonitoringContainerArguments": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ContainerArgument" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.sagemaker#MonitoringCsvDatasetFormat": { + "type": "structure", + "members": { + "Header": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates if the CSV data has a header.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the CSV dataset format used when running a monitoring job.

" + } + }, + "com.amazonaws.sagemaker#MonitoringDatapointsToAlert": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#MonitoringDatasetFormat": { + "type": "structure", + "members": { + "Csv": { + "target": "com.amazonaws.sagemaker#MonitoringCsvDatasetFormat", + "traits": { + "smithy.api#documentation": "

The CSV dataset used in the monitoring job.

" + } + }, + "Json": { + "target": "com.amazonaws.sagemaker#MonitoringJsonDatasetFormat", + "traits": { + "smithy.api#documentation": "

The JSON dataset used in the monitoring job

" + } + }, + "Parquet": { + "target": "com.amazonaws.sagemaker#MonitoringParquetDatasetFormat", + "traits": { + "smithy.api#documentation": "

The Parquet dataset used in the monitoring job

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the dataset format used when running a monitoring job.

" + } + }, + "com.amazonaws.sagemaker#MonitoringEnvironmentMap": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#ProcessingEnvironmentKey" + }, + "value": { + "target": "com.amazonaws.sagemaker#ProcessingEnvironmentValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.sagemaker#MonitoringEvaluationPeriod": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#MonitoringExecutionSortKey": { + "type": "enum", + "members": { + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "SCHEDULED_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ScheduledTime" + } + }, + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + } + } + }, + "com.amazonaws.sagemaker#MonitoringExecutionSummary": { + "type": "structure", + "members": { + "MonitoringScheduleName": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the monitoring schedule.

", + "smithy.api#required": {} + } + }, + "ScheduledTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The time the monitoring job was scheduled.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The time at which the monitoring job was created.

", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A timestamp that indicates the last time the monitoring job was modified.

", + "smithy.api#required": {} + } + }, + "MonitoringExecutionStatus": { + "target": "com.amazonaws.sagemaker#ExecutionStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of the monitoring job.

", + "smithy.api#required": {} + } + }, + "ProcessingJobArn": { + "target": "com.amazonaws.sagemaker#ProcessingJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the monitoring job.

" + } + }, + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#documentation": "

The name of the endpoint used to run the monitoring job.

" + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "

Contains the reason a monitoring job failed, if it failed.

" + } + }, + "MonitoringJobDefinitionName": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", + "traits": { + "smithy.api#documentation": "

The name of the monitoring job.

" + } + }, + "MonitoringType": { + "target": "com.amazonaws.sagemaker#MonitoringType", + "traits": { + "smithy.api#documentation": "

The type of the monitoring job.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Summary of information about the last monitoring job to run.

" + } + }, + "com.amazonaws.sagemaker#MonitoringExecutionSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#MonitoringExecutionSummary" + } + }, + "com.amazonaws.sagemaker#MonitoringGroundTruthS3Input": { + "type": "structure", + "members": { + "S3Uri": { + "target": "com.amazonaws.sagemaker#MonitoringS3Uri", + "traits": { + "smithy.api#documentation": "

The address of the Amazon S3 location of the ground truth labels.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The ground truth labels for the dataset used for the monitoring job.

" + } + }, + "com.amazonaws.sagemaker#MonitoringInput": { + "type": "structure", + "members": { + "EndpointInput": { + "target": "com.amazonaws.sagemaker#EndpointInput", + "traits": { + "smithy.api#documentation": "

The endpoint for a monitoring job.

" + } + }, + "BatchTransformInput": { + "target": "com.amazonaws.sagemaker#BatchTransformInput", + "traits": { + "smithy.api#documentation": "

Input object for the batch transform job.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The inputs for a monitoring job.

" + } + }, + "com.amazonaws.sagemaker#MonitoringInputs": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#MonitoringInput" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.sagemaker#MonitoringJobDefinition": { + "type": "structure", + "members": { + "BaselineConfig": { + "target": "com.amazonaws.sagemaker#MonitoringBaselineConfig", + "traits": { + "smithy.api#documentation": "

Baseline configuration used to validate that the data conforms to the specified\n constraints and statistics

" + } + }, + "MonitoringInputs": { + "target": "com.amazonaws.sagemaker#MonitoringInputs", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The array of inputs for the monitoring job. Currently we support monitoring an Amazon SageMaker AI Endpoint.

", + "smithy.api#required": {} + } + }, + "MonitoringOutputConfig": { + "target": "com.amazonaws.sagemaker#MonitoringOutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The array of outputs from the monitoring job to be uploaded to Amazon S3.

", + "smithy.api#required": {} + } + }, + "MonitoringResources": { + "target": "com.amazonaws.sagemaker#MonitoringResources", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Identifies the resources, ML compute instances, and ML storage volumes to deploy for a\n monitoring job. In distributed processing, you specify more than one instance.

", + "smithy.api#required": {} + } + }, + "MonitoringAppSpecification": { + "target": "com.amazonaws.sagemaker#MonitoringAppSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Configures the monitoring job to run a specified Docker container image.

", + "smithy.api#required": {} + } + }, + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#MonitoringStoppingCondition", + "traits": { + "smithy.api#documentation": "

Specifies a time limit for how long the monitoring job is allowed to run.

" + } + }, + "Environment": { + "target": "com.amazonaws.sagemaker#MonitoringEnvironmentMap", + "traits": { + "smithy.api#documentation": "

Sets the environment variables in the Docker container.

" + } + }, + "NetworkConfig": { + "target": "com.amazonaws.sagemaker#NetworkConfig", + "traits": { + "smithy.api#documentation": "

Specifies networking options for an monitoring job.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can \n assume to perform tasks on your behalf.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines the monitoring job.

" + } + }, + "com.amazonaws.sagemaker#MonitoringJobDefinitionArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#MonitoringJobDefinitionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#MonitoringJobDefinitionSortKey": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + } + } + }, + "com.amazonaws.sagemaker#MonitoringJobDefinitionSummary": { + "type": "structure", + "members": { + "MonitoringJobDefinitionName": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the monitoring job.

", + "smithy.api#required": {} + } + }, + "MonitoringJobDefinitionArn": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the monitoring job.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The time that the monitoring job was created.

", + "smithy.api#required": {} + } + }, + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the endpoint that the job monitors.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Summary information about a monitoring job.

" + } + }, + "com.amazonaws.sagemaker#MonitoringJobDefinitionSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionSummary" + } + }, + "com.amazonaws.sagemaker#MonitoringJsonDatasetFormat": { + "type": "structure", + "members": { + "Line": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates if the file should be read as a JSON object per line.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the JSON dataset format used when running a monitoring job.

" + } + }, + "com.amazonaws.sagemaker#MonitoringMaxRuntimeInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 86400 + } + } + }, + "com.amazonaws.sagemaker#MonitoringNetworkConfig": { + "type": "structure", + "members": { + "EnableInterContainerTrafficEncryption": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

Whether to encrypt all communications between the instances used for the monitoring\n jobs. Choose True to encrypt communications. Encryption provides greater\n security for distributed jobs, but the processing might take longer.

" + } + }, + "EnableNetworkIsolation": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

Whether to allow inbound and outbound network calls to and from the containers used for\n the monitoring job.

" + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig" + } + }, + "traits": { + "smithy.api#documentation": "

The networking configuration for the monitoring job.

" + } + }, + "com.amazonaws.sagemaker#MonitoringOutput": { + "type": "structure", + "members": { + "S3Output": { + "target": "com.amazonaws.sagemaker#MonitoringS3Output", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon S3 storage location where the results of a monitoring job are\n saved.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The output object for a monitoring job.

" + } + }, + "com.amazonaws.sagemaker#MonitoringOutputConfig": { + "type": "structure", + "members": { + "MonitoringOutputs": { + "target": "com.amazonaws.sagemaker#MonitoringOutputs", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Monitoring outputs for monitoring jobs. This is where the output of the periodic\n monitoring jobs is uploaded.

", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The Key Management Service (KMS) key that Amazon SageMaker AI uses to\n encrypt the model artifacts at rest using Amazon S3 server-side encryption.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The output configuration for monitoring jobs.

" + } + }, + "com.amazonaws.sagemaker#MonitoringOutputs": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#MonitoringOutput" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.sagemaker#MonitoringParquetDatasetFormat": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Represents the Parquet dataset format used when running a monitoring job.

" + } + }, + "com.amazonaws.sagemaker#MonitoringProblemType": { + "type": "enum", + "members": { + "BINARY_CLASSIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BinaryClassification" + } + }, + "MULTICLASS_CLASSIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MulticlassClassification" + } + }, + "REGRESSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Regression" + } + } + } + }, + "com.amazonaws.sagemaker#MonitoringResources": { + "type": "structure", + "members": { + "ClusterConfig": { + "target": "com.amazonaws.sagemaker#MonitoringClusterConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The configuration for the cluster resources used to run the processing job.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Identifies the resources to deploy for a monitoring job.

" + } + }, + "com.amazonaws.sagemaker#MonitoringS3Output": { + "type": "structure", + "members": { + "S3Uri": { + "target": "com.amazonaws.sagemaker#MonitoringS3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A URI that identifies the Amazon S3 storage location where Amazon SageMaker AI\n saves the results of a monitoring job.

", + "smithy.api#required": {} + } + }, + "LocalPath": { + "target": "com.amazonaws.sagemaker#ProcessingLocalPath", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The local path to the Amazon S3 storage location where Amazon SageMaker AI\n saves the results of a monitoring job. LocalPath is an absolute path for the output\n data.

", + "smithy.api#required": {} + } + }, + "S3UploadMode": { + "target": "com.amazonaws.sagemaker#ProcessingS3UploadMode", + "traits": { + "smithy.api#documentation": "

Whether to upload the results of the monitoring job continuously or after the job\n completes.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about where and how you want to store the results of a monitoring\n job.

" + } + }, + "com.amazonaws.sagemaker#MonitoringS3Uri": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^(https|s3)://([^/]+)/?(.*)$" + } + }, + "com.amazonaws.sagemaker#MonitoringSchedule": { + "type": "structure", + "members": { + "MonitoringScheduleArn": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the monitoring schedule.

" + } + }, + "MonitoringScheduleName": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleName", + "traits": { + "smithy.api#documentation": "

The name of the monitoring schedule.

" + } + }, + "MonitoringScheduleStatus": { + "target": "com.amazonaws.sagemaker#ScheduleStatus", + "traits": { + "smithy.api#documentation": "

The status of the monitoring schedule. This can be one of the following values.

\n
    \n
  • \n

    \n PENDING - The schedule is pending being created.

    \n
    • \n
  • \n

    \n FAILED - The schedule failed.

    \n
    • \n
  • \n

    \n SCHEDULED - The schedule was successfully created.

    \n
    • \n
  • \n

    \n STOPPED - The schedule was stopped.

    \n
    • \n
" + } + }, + "MonitoringType": { + "target": "com.amazonaws.sagemaker#MonitoringType", + "traits": { + "smithy.api#documentation": "

The type of the monitoring job definition to schedule.

" + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "

If the monitoring schedule failed, the reason it failed.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the monitoring schedule was created.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The last time the monitoring schedule was changed.

" + } + }, + "MonitoringScheduleConfig": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleConfig" + }, + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#documentation": "

The endpoint that hosts the model being monitored.

" + } + }, + "LastMonitoringExecutionSummary": { + "target": "com.amazonaws.sagemaker#MonitoringExecutionSummary" + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

A list of the tags associated with the monitoring schedlue. For more information, see Tagging Amazon Web Services\n resources in the Amazon Web Services General Reference Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A schedule for a model monitoring job. For information about model monitor, see\n Amazon SageMaker Model\n Monitor.

" + } + }, + "com.amazonaws.sagemaker#MonitoringScheduleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#MonitoringScheduleConfig": { + "type": "structure", + "members": { + "ScheduleConfig": { + "target": "com.amazonaws.sagemaker#ScheduleConfig", + "traits": { + "smithy.api#documentation": "

Configures the monitoring schedule.

" + } + }, + "MonitoringJobDefinition": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinition", + "traits": { + "smithy.api#documentation": "

Defines the monitoring job.

" + } + }, + "MonitoringJobDefinitionName": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", + "traits": { + "smithy.api#documentation": "

The name of the monitoring job definition to schedule.

" + } + }, + "MonitoringType": { + "target": "com.amazonaws.sagemaker#MonitoringType", + "traits": { + "smithy.api#documentation": "

The type of the monitoring job definition to schedule.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configures the monitoring schedule and defines the monitoring job.

" + } + }, + "com.amazonaws.sagemaker#MonitoringScheduleList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#MonitoringSchedule" + } + }, + "com.amazonaws.sagemaker#MonitoringScheduleName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#MonitoringScheduleSortKey": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + } + } + }, + "com.amazonaws.sagemaker#MonitoringScheduleSummary": { + "type": "structure", + "members": { + "MonitoringScheduleName": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the monitoring schedule.

", + "smithy.api#required": {} + } + }, + "MonitoringScheduleArn": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the monitoring schedule.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The creation time of the monitoring schedule.

", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The last time the monitoring schedule was modified.

", + "smithy.api#required": {} + } + }, + "MonitoringScheduleStatus": { + "target": "com.amazonaws.sagemaker#ScheduleStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of the monitoring schedule.

", + "smithy.api#required": {} + } + }, + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#documentation": "

The name of the endpoint using the monitoring schedule.

" + } + }, + "MonitoringJobDefinitionName": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", + "traits": { + "smithy.api#documentation": "

The name of the monitoring job definition that the schedule is for.

" + } + }, + "MonitoringType": { + "target": "com.amazonaws.sagemaker#MonitoringType", + "traits": { + "smithy.api#documentation": "

The type of the monitoring job definition that the schedule is for.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Summarizes the monitoring schedule.

" + } + }, + "com.amazonaws.sagemaker#MonitoringScheduleSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleSummary" + } + }, + "com.amazonaws.sagemaker#MonitoringStatisticsResource": { + "type": "structure", + "members": { + "S3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "

The Amazon S3 URI for the statistics resource.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The statistics resource for a monitoring job.

" + } + }, + "com.amazonaws.sagemaker#MonitoringStoppingCondition": { + "type": "structure", + "members": { + "MaxRuntimeInSeconds": { + "target": "com.amazonaws.sagemaker#MonitoringMaxRuntimeInSeconds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The maximum runtime allowed in seconds.

\n \n

The MaxRuntimeInSeconds cannot exceed the frequency of the job. For data\n quality and model explainability, this can be up to 3600 seconds for an hourly schedule.\n For model bias and model quality hourly schedules, this can be up to 1800\n seconds.

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A time limit for how long the monitoring job is allowed to run before stopping.

" + } + }, + "com.amazonaws.sagemaker#MonitoringTimeOffsetString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 15 + }, + "smithy.api#pattern": "^.?P" + } + }, + "com.amazonaws.sagemaker#MonitoringType": { + "type": "enum", + "members": { + "DATA_QUALITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DataQuality" + } + }, + "MODEL_QUALITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ModelQuality" + } + }, + "MODEL_BIAS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ModelBias" + } + }, + "MODEL_EXPLAINABILITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ModelExplainability" + } + } + } + }, + "com.amazonaws.sagemaker#MountPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^\\/" + } + }, + "com.amazonaws.sagemaker#MultiModelConfig": { + "type": "structure", + "members": { + "ModelCacheSetting": { + "target": "com.amazonaws.sagemaker#ModelCacheSetting", + "traits": { + "smithy.api#documentation": "

Whether to cache models for a multi-model endpoint. By default, multi-model endpoints\n cache models so that a model does not have to be loaded into memory each time it is\n invoked. Some use cases do not benefit from model caching. For example, if an endpoint\n hosts a large number of models that are each invoked infrequently, the endpoint might\n perform better if you disable model caching. To disable model caching, set the value of\n this parameter to Disabled.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies additional configuration for hosting multi-model endpoints.

" + } + }, + "com.amazonaws.sagemaker#NameContains": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\-]+$" + } + }, + "com.amazonaws.sagemaker#NeoVpcConfig": { + "type": "structure", + "members": { + "SecurityGroupIds": { + "target": "com.amazonaws.sagemaker#NeoVpcSecurityGroupIds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The VPC security group IDs. IDs have the form of sg-xxxxxxxx. Specify the\n security groups for the VPC that is specified in the Subnets field.

", + "smithy.api#required": {} + } + }, + "Subnets": { + "target": "com.amazonaws.sagemaker#NeoVpcSubnets", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the subnets in the VPC that you want to connect the compilation job to for\n accessing the model in Amazon S3.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The VpcConfig configuration object that specifies the VPC that you want the\n compilation jobs to connect to. For more information on controlling access to your Amazon S3\n buckets used for compilation job, see Give Amazon SageMaker AI Compilation Jobs Access to\n Resources in Your Amazon VPC.

" + } + }, + "com.amazonaws.sagemaker#NeoVpcSecurityGroupId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + }, + "smithy.api#pattern": "^[-0-9a-zA-Z]+$" + } + }, + "com.amazonaws.sagemaker#NeoVpcSecurityGroupIds": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#NeoVpcSecurityGroupId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#NeoVpcSubnetId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + }, + "smithy.api#pattern": "^[-0-9a-zA-Z]+$" + } + }, + "com.amazonaws.sagemaker#NeoVpcSubnets": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#NeoVpcSubnetId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16 + } + } + }, + "com.amazonaws.sagemaker#NestedFilters": { + "type": "structure", + "members": { + "NestedPropertyName": { + "target": "com.amazonaws.sagemaker#ResourcePropertyName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the property to use in the nested filters. The value must match a listed property name,\n such as InputDataConfig.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.sagemaker#FilterList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A list of filters. Each filter acts on a property. Filters must contain at least one\n Filters value. For example, a NestedFilters call might\n include a filter on the PropertyName parameter of the\n InputDataConfig property:\n InputDataConfig.DataSource.S3DataSource.S3Uri.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of nested Filter objects. A resource must satisfy the conditions\n of all filters to be included in the results returned from the Search API.

\n

For example, to filter on a training job's InputDataConfig property with a\n specific channel name and S3Uri prefix, define the following filters:

\n
    \n
  • \n

    \n '{Name:\"InputDataConfig.ChannelName\", \"Operator\":\"Equals\", \"Value\":\"train\"}',\n

    \n
    • \n
  • \n

    \n '{Name:\"InputDataConfig.DataSource.S3DataSource.S3Uri\", \"Operator\":\"Contains\",\n \"Value\":\"mybucket/catdata\"}'\n

    \n
    • \n
" + } + }, + "com.amazonaws.sagemaker#NestedFiltersList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#NestedFilters" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.sagemaker#NetworkConfig": { + "type": "structure", + "members": { + "EnableInterContainerTrafficEncryption": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

Whether to encrypt all communications between distributed processing jobs. Choose\n True to encrypt communications. Encryption provides greater security for distributed\n processing jobs, but the processing might take longer.

" + } + }, + "EnableNetworkIsolation": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

Whether to allow inbound and outbound network calls to and from the containers used for\n the processing job.

" + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig" + } + }, + "traits": { + "smithy.api#documentation": "

Networking options for a job, such as network traffic encryption between containers,\n whether to allow inbound and outbound network calls to and from containers, and the VPC\n subnets and security groups to use for VPC-enabled jobs.

" + } + }, + "com.amazonaws.sagemaker#NetworkInterfaceId": { + "type": "string" + }, + "com.amazonaws.sagemaker#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 8192 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#NonEmptyString256": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^(?!\\s*$).+$" + } + }, + "com.amazonaws.sagemaker#NonEmptyString64": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + }, + "smithy.api#pattern": "^(?!\\s*$).+$" + } + }, + "com.amazonaws.sagemaker#NotebookInstanceAcceleratorType": { + "type": "enum", + "members": { + "ML_EIA1_MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.eia1.medium" + } + }, + "ML_EIA1_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.eia1.large" + } + }, + "ML_EIA1_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.eia1.xlarge" + } + }, + "ML_EIA2_MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.eia2.medium" + } + }, + "ML_EIA2_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.eia2.large" + } + }, + "ML_EIA2_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.eia2.xlarge" + } + } + } + }, + "com.amazonaws.sagemaker#NotebookInstanceAcceleratorTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#NotebookInstanceAcceleratorType" + } + }, + "com.amazonaws.sagemaker#NotebookInstanceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigContent": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16384 + }, + "smithy.api#pattern": "^[\\S\\s]+$" + } + }, + "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleHook" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + } + }, + "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigNameContains": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigSortKey": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "LAST_MODIFIED_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LastModifiedTime" + } + } + } + }, + "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigSortOrder": { + "type": "enum", + "members": { + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ascending" + } + }, + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Descending" + } + } + } + }, + "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigSummary": { + "type": "structure", + "members": { + "NotebookInstanceLifecycleConfigName": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the lifecycle configuration.

", + "smithy.api#required": {} + } + }, + "NotebookInstanceLifecycleConfigArn": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the lifecycle configuration.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "

A timestamp that tells when the lifecycle configuration was created.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "

A timestamp that tells when the lifecycle configuration was last modified.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides a summary of a notebook instance lifecycle configuration.

" + } + }, + "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigSummary" + } + }, + "com.amazonaws.sagemaker#NotebookInstanceLifecycleHook": { + "type": "structure", + "members": { + "Content": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigContent", + "traits": { + "smithy.api#documentation": "

A base64-encoded string that contains a shell script for a notebook instance lifecycle\n configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the notebook instance lifecycle configuration script.

\n

Each lifecycle configuration script has a limit of 16384 characters.

\n

The value of the $PATH environment variable that is available to both\n scripts is /sbin:bin:/usr/sbin:/usr/bin.

\n

View Amazon CloudWatch Logs for notebook instance lifecycle configurations in log\n group /aws/sagemaker/NotebookInstances in log stream\n [notebook-instance-name]/[LifecycleConfigHook].

\n

Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs\n for longer than 5 minutes, it fails and the notebook instance is not created or\n started.

\n

For information about notebook instance lifestyle configurations, see Step\n 2.1: (Optional) Customize a Notebook Instance.

" + } + }, + "com.amazonaws.sagemaker#NotebookInstanceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + } + }, + "com.amazonaws.sagemaker#NotebookInstanceNameContains": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.sagemaker#NotebookInstanceSortKey": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + } + } + }, + "com.amazonaws.sagemaker#NotebookInstanceSortOrder": { + "type": "enum", + "members": { + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ascending" + } + }, + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Descending" + } + } + } + }, + "com.amazonaws.sagemaker#NotebookInstanceStatus": { + "type": "enum", + "members": { + "Pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "InService": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InService" + } + }, + "Stopping": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "Stopped": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "Deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "Updating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + } + } + }, + "com.amazonaws.sagemaker#NotebookInstanceSummary": { + "type": "structure", + "members": { + "NotebookInstanceName": { + "target": "com.amazonaws.sagemaker#NotebookInstanceName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the notebook instance that you want a summary for.

", + "smithy.api#required": {} + } + }, + "NotebookInstanceArn": { + "target": "com.amazonaws.sagemaker#NotebookInstanceArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the notebook instance.

", + "smithy.api#required": {} + } + }, + "NotebookInstanceStatus": { + "target": "com.amazonaws.sagemaker#NotebookInstanceStatus", + "traits": { + "smithy.api#documentation": "

The status of the notebook instance.

" + } + }, + "Url": { + "target": "com.amazonaws.sagemaker#NotebookInstanceUrl", + "traits": { + "smithy.api#documentation": "

The URL that you use to connect to the Jupyter notebook running in your notebook\n instance.

" + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#InstanceType", + "traits": { + "smithy.api#documentation": "

The type of ML compute instance that the notebook instance is running on.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "

A timestamp that shows when the notebook instance was created.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "

A timestamp that shows when the notebook instance was last modified.

" + } + }, + "NotebookInstanceLifecycleConfigName": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigName", + "traits": { + "smithy.api#documentation": "

The name of a notebook instance lifecycle configuration associated with this notebook\n instance.

\n

For information about notebook instance lifestyle configurations, see Step\n 2.1: (Optional) Customize a Notebook Instance.

" + } + }, + "DefaultCodeRepository": { + "target": "com.amazonaws.sagemaker#CodeRepositoryNameOrUrl", + "traits": { + "smithy.api#documentation": "

The Git repository associated with the notebook instance as its default code\n repository. This can be either the name of a Git repository stored as a resource in your\n account, or the URL of a Git repository in Amazon Web Services CodeCommit\n or in any other Git repository. When you open a notebook instance, it opens in the\n directory that contains this repository. For more information, see Associating Git\n Repositories with SageMaker AI Notebook Instances.

" + } + }, + "AdditionalCodeRepositories": { + "target": "com.amazonaws.sagemaker#AdditionalCodeRepositoryNamesOrUrls", + "traits": { + "smithy.api#documentation": "

An array of up to three Git repositories associated with the notebook instance. These\n can be either the names of Git repositories stored as resources in your account, or the\n URL of Git repositories in Amazon Web Services CodeCommit\n or in any other Git repository. These repositories are cloned at the same level as the\n default repository of your notebook instance. For more information, see Associating Git\n Repositories with SageMaker AI Notebook Instances.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides summary information for an SageMaker AI notebook instance.

" + } + }, + "com.amazonaws.sagemaker#NotebookInstanceSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#NotebookInstanceSummary" + } + }, + "com.amazonaws.sagemaker#NotebookInstanceUrl": { + "type": "string" + }, + "com.amazonaws.sagemaker#NotebookInstanceVolumeSizeInGB": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 16384 + } + } + }, + "com.amazonaws.sagemaker#NotebookOutputOption": { + "type": "enum", + "members": { + "Allowed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Allowed" + } + }, + "Disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disabled" + } + } + } + }, + "com.amazonaws.sagemaker#NotificationConfiguration": { + "type": "structure", + "members": { + "NotificationTopicArn": { + "target": "com.amazonaws.sagemaker#NotificationTopicArn", + "traits": { + "smithy.api#documentation": "

The ARN for the Amazon SNS topic to which notifications should be published.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configures Amazon SNS notifications of available or expiring work items for work\n teams.

" + } + }, + "com.amazonaws.sagemaker#NotificationTopicArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sns:[a-z0-9\\-]*:[0-9]{12}:[a-zA-Z0-9_.-]*$" + } + }, + "com.amazonaws.sagemaker#NumberOfAcceleratorDevices": { + "type": "float", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#NumberOfCpuCores": { + "type": "float", + "traits": { + "smithy.api#range": { + "min": 0.25 + } + } + }, + "com.amazonaws.sagemaker#NumberOfHumanWorkersPerDataObject": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 9 + } + } + }, + "com.amazonaws.sagemaker#NumberOfSteps": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#ObjectiveStatus": { + "type": "enum", + "members": { + "Succeeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Succeeded" + } + }, + "Pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + } + } + }, + "com.amazonaws.sagemaker#ObjectiveStatusCounter": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.sagemaker#ObjectiveStatusCounters": { + "type": "structure", + "members": { + "Succeeded": { + "target": "com.amazonaws.sagemaker#ObjectiveStatusCounter", + "traits": { + "smithy.api#documentation": "

The number of training jobs whose final objective metric was evaluated by the\n hyperparameter tuning job and used in the hyperparameter tuning process.

" + } + }, + "Pending": { + "target": "com.amazonaws.sagemaker#ObjectiveStatusCounter", + "traits": { + "smithy.api#documentation": "

The number of training jobs that are in progress and pending evaluation of their final\n objective metric.

" + } + }, + "Failed": { + "target": "com.amazonaws.sagemaker#ObjectiveStatusCounter", + "traits": { + "smithy.api#documentation": "

The number of training jobs whose final objective metric was not evaluated and used in\n the hyperparameter tuning process. This typically occurs when the training job failed or\n did not emit an objective metric.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the number of training jobs that this hyperparameter tuning job launched,\n categorized by the status of their objective metric. The objective metric status shows\n whether the\n final\n objective metric for the training job has been evaluated by the\n tuning job and used in the hyperparameter tuning process.

" + } + }, + "com.amazonaws.sagemaker#OfflineStoreConfig": { + "type": "structure", + "members": { + "S3StorageConfig": { + "target": "com.amazonaws.sagemaker#S3StorageConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Simple Storage (Amazon S3) location of OfflineStore.

", + "smithy.api#required": {} + } + }, + "DisableGlueTableCreation": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

Set to True to disable the automatic creation of an Amazon Web Services Glue\n table when configuring an OfflineStore. If set to False, Feature\n Store will name the OfflineStore Glue table following Athena's\n naming recommendations.

\n

The default value is False.

" + } + }, + "DataCatalogConfig": { + "target": "com.amazonaws.sagemaker#DataCatalogConfig", + "traits": { + "smithy.api#documentation": "

The meta data of the Glue table that is autogenerated when an OfflineStore\n is created.

" + } + }, + "TableFormat": { + "target": "com.amazonaws.sagemaker#TableFormat", + "traits": { + "smithy.api#documentation": "

Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of an OfflineStore.

\n

Provide an OfflineStoreConfig in a request to\n CreateFeatureGroup to create an OfflineStore.

\n

To encrypt an OfflineStore using at rest data encryption, specify Amazon Web Services Key Management Service (KMS) key ID, or KMSKeyId, in\n S3StorageConfig.

" + } + }, + "com.amazonaws.sagemaker#OfflineStoreStatus": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.sagemaker#OfflineStoreStatusValue", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An OfflineStore status.

", + "smithy.api#required": {} + } + }, + "BlockedReason": { + "target": "com.amazonaws.sagemaker#BlockedReason", + "traits": { + "smithy.api#documentation": "

The justification for why the OfflineStoreStatus is Blocked (if applicable).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The status of OfflineStore.

" + } + }, + "com.amazonaws.sagemaker#OfflineStoreStatusValue": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active" + } + }, + "BLOCKED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Blocked" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disabled" + } + } + } + }, + "com.amazonaws.sagemaker#OidcConfig": { + "type": "structure", + "members": { + "ClientId": { + "target": "com.amazonaws.sagemaker#ClientId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The OIDC IdP client ID used to configure your private workforce.

", + "smithy.api#required": {} + } + }, + "ClientSecret": { + "target": "com.amazonaws.sagemaker#ClientSecret", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The OIDC IdP client secret used to configure your private workforce.

", + "smithy.api#required": {} + } + }, + "Issuer": { + "target": "com.amazonaws.sagemaker#OidcEndpoint", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The OIDC IdP issuer used to configure your private workforce.

", + "smithy.api#required": {} + } + }, + "AuthorizationEndpoint": { + "target": "com.amazonaws.sagemaker#OidcEndpoint", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The OIDC IdP authorization endpoint used to configure your private workforce.

", + "smithy.api#required": {} + } + }, + "TokenEndpoint": { + "target": "com.amazonaws.sagemaker#OidcEndpoint", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The OIDC IdP token endpoint used to configure your private workforce.

", + "smithy.api#required": {} + } + }, + "UserInfoEndpoint": { + "target": "com.amazonaws.sagemaker#OidcEndpoint", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The OIDC IdP user information endpoint used to configure your private workforce.

", + "smithy.api#required": {} + } + }, + "LogoutEndpoint": { + "target": "com.amazonaws.sagemaker#OidcEndpoint", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The OIDC IdP logout endpoint used to configure your private workforce.

", + "smithy.api#required": {} + } + }, + "JwksUri": { + "target": "com.amazonaws.sagemaker#OidcEndpoint", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.sagemaker#Scope", + "traits": { + "smithy.api#documentation": "

An array of string identifiers used to refer to the specific pieces of user data or claims that the client application wants to access.

" + } + }, + "AuthenticationRequestExtraParams": { + "target": "com.amazonaws.sagemaker#AuthenticationRequestExtraParams", + "traits": { + "smithy.api#documentation": "

A string to string map of identifiers specific to the custom identity provider (IdP) being used.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Use this parameter to configure your OIDC Identity Provider (IdP).

" + } + }, + "com.amazonaws.sagemaker#OidcConfigForResponse": { + "type": "structure", + "members": { + "ClientId": { + "target": "com.amazonaws.sagemaker#ClientId", + "traits": { + "smithy.api#documentation": "

The OIDC IdP client ID used to configure your private workforce.

" + } + }, + "Issuer": { + "target": "com.amazonaws.sagemaker#OidcEndpoint", + "traits": { + "smithy.api#documentation": "

The OIDC IdP issuer used to configure your private workforce.

" + } + }, + "AuthorizationEndpoint": { + "target": "com.amazonaws.sagemaker#OidcEndpoint", + "traits": { + "smithy.api#documentation": "

The OIDC IdP authorization endpoint used to configure your private workforce.

" + } + }, + "TokenEndpoint": { + "target": "com.amazonaws.sagemaker#OidcEndpoint", + "traits": { + "smithy.api#documentation": "

The OIDC IdP token endpoint used to configure your private workforce.

" + } + }, + "UserInfoEndpoint": { + "target": "com.amazonaws.sagemaker#OidcEndpoint", + "traits": { + "smithy.api#documentation": "

The OIDC IdP user information endpoint used to configure your private workforce.

" + } + }, + "LogoutEndpoint": { + "target": "com.amazonaws.sagemaker#OidcEndpoint", + "traits": { + "smithy.api#documentation": "

The OIDC IdP logout endpoint used to configure your private workforce.

" + } + }, + "JwksUri": { + "target": "com.amazonaws.sagemaker#OidcEndpoint", + "traits": { + "smithy.api#documentation": "

The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.

" + } + }, + "Scope": { + "target": "com.amazonaws.sagemaker#Scope", + "traits": { + "smithy.api#documentation": "

An array of string identifiers used to refer to the specific pieces of user data or claims that the client application wants to access.

" + } + }, + "AuthenticationRequestExtraParams": { + "target": "com.amazonaws.sagemaker#AuthenticationRequestExtraParams", + "traits": { + "smithy.api#documentation": "

A string to string map of identifiers specific to the custom identity provider (IdP) being used.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Your OIDC IdP workforce configuration.

" + } + }, + "com.amazonaws.sagemaker#OidcEndpoint": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + }, + "smithy.api#pattern": "^https://\\S+$" + } + }, + "com.amazonaws.sagemaker#OidcMemberDefinition": { + "type": "structure", + "members": { + "Groups": { + "target": "com.amazonaws.sagemaker#Groups", + "traits": { + "smithy.api#documentation": "

A list of comma seperated strings that identifies\n user groups in your OIDC IdP. Each user group is\n made up of a group of private workers.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of user groups that exist in your OIDC Identity Provider (IdP). \n One to ten groups can be used to create a single private work team. \n When you add a user group to the list of Groups, you can add that user group to one or more\n private work teams. If you add a user group to a private work team, all workers in that user group \n are added to the work team.

" + } + }, + "com.amazonaws.sagemaker#OnStartDeepHealthChecks": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#DeepHealthCheckType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.sagemaker#OnlineStoreConfig": { + "type": "structure", + "members": { + "SecurityConfig": { + "target": "com.amazonaws.sagemaker#OnlineStoreSecurityConfig", + "traits": { + "smithy.api#documentation": "

Use to specify KMS Key ID (KMSKeyId) for at-rest encryption of your\n OnlineStore.

" + } + }, + "EnableOnlineStore": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

Turn OnlineStore off by specifying False for the\n EnableOnlineStore flag. Turn OnlineStore on by specifying\n True for the EnableOnlineStore flag.

\n

The default value is False.

" + } + }, + "TtlDuration": { + "target": "com.amazonaws.sagemaker#TtlDuration", + "traits": { + "smithy.api#documentation": "

Time to live duration, where the record is hard deleted after the expiration time is\n reached; ExpiresAt = EventTime + TtlDuration. For\n information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.

" + } + }, + "StorageType": { + "target": "com.amazonaws.sagemaker#StorageType", + "traits": { + "smithy.api#documentation": "

Option for different tiers of low latency storage for real-time data retrieval.

\n
    \n
  • \n

    \n Standard: A managed low latency data store for feature groups.

    \n
    • \n
  • \n

    \n InMemory: A managed data store for feature groups that supports very\n low latency retrieval.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

Use this to specify the Amazon Web Services Key Management Service (KMS) Key ID, or\n KMSKeyId, for at rest data encryption. You can turn\n OnlineStore on or off by specifying the EnableOnlineStore flag\n at General Assembly.

\n

The default value is False.

" + } + }, + "com.amazonaws.sagemaker#OnlineStoreConfigUpdate": { + "type": "structure", + "members": { + "TtlDuration": { + "target": "com.amazonaws.sagemaker#TtlDuration", + "traits": { + "smithy.api#documentation": "

Time to live duration, where the record is hard deleted after the expiration time is\n reached; ExpiresAt = EventTime + TtlDuration. For\n information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Updates the feature group online store configuration.

" + } + }, + "com.amazonaws.sagemaker#OnlineStoreSecurityConfig": { + "type": "structure", + "members": { + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Key Management Service (KMS) key ARN that SageMaker Feature Store\n uses to encrypt the Amazon S3 objects at rest using Amazon S3 server-side\n encryption.

\n

The caller (either user or IAM role) of CreateFeatureGroup must have below\n permissions to the OnlineStore\n KmsKeyId:

\n
    \n
  • \n

    \n \"kms:Encrypt\"\n

    \n
    • \n
  • \n

    \n \"kms:Decrypt\"\n

    \n
    • \n
  • \n

    \n \"kms:DescribeKey\"\n

    \n
    • \n
  • \n

    \n \"kms:CreateGrant\"\n

    \n
    • \n
  • \n

    \n \"kms:RetireGrant\"\n

    \n
    • \n
  • \n

    \n \"kms:ReEncryptFrom\"\n

    \n
    • \n
  • \n

    \n \"kms:ReEncryptTo\"\n

    \n
    • \n
  • \n

    \n \"kms:GenerateDataKey\"\n

    \n
    • \n
  • \n

    \n \"kms:ListAliases\"\n

    \n
    • \n
  • \n

    \n \"kms:ListGrants\"\n

    \n
    • \n
  • \n

    \n \"kms:RevokeGrant\"\n

    \n
    • \n
\n

The caller (either user or IAM role) to all DataPlane operations\n (PutRecord, GetRecord, DeleteRecord) must have the\n following permissions to the KmsKeyId:

\n
    \n
  • \n

    \n \"kms:Decrypt\"\n

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

The security configuration for OnlineStore.

" + } + }, + "com.amazonaws.sagemaker#OnlineStoreTotalSizeBytes": { + "type": "long" + }, + "com.amazonaws.sagemaker#Operator": { + "type": "enum", + "members": { + "EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Equals" + } + }, + "NOT_EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotEquals" + } + }, + "GREATER_THAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GreaterThan" + } + }, + "GREATER_THAN_OR_EQUAL_TO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GreaterThanOrEqualTo" + } + }, + "LESS_THAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LessThan" + } + }, + "LESS_THAN_OR_EQUAL_TO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LessThanOrEqualTo" + } + }, + "CONTAINS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Contains" + } + }, + "EXISTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Exists" + } + }, + "NOT_EXISTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotExists" + } + }, + "IN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "In" + } + } + } + }, + "com.amazonaws.sagemaker#OptimizationConfig": { + "type": "union", + "members": { + "ModelQuantizationConfig": { + "target": "com.amazonaws.sagemaker#ModelQuantizationConfig", + "traits": { + "smithy.api#documentation": "

Settings for the model quantization technique that's applied by a model optimization job.

" + } + }, + "ModelCompilationConfig": { + "target": "com.amazonaws.sagemaker#ModelCompilationConfig", + "traits": { + "smithy.api#documentation": "

Settings for the model compilation technique that's applied by a model optimization job.

" + } + }, + "ModelShardingConfig": { + "target": "com.amazonaws.sagemaker#ModelShardingConfig", + "traits": { + "smithy.api#documentation": "

Settings for the model sharding technique that's applied by a model optimization job.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Settings for an optimization technique that you apply with a model optimization\n job.

" + } + }, + "com.amazonaws.sagemaker#OptimizationConfigs": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#OptimizationConfig" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.sagemaker#OptimizationContainerImage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.sagemaker#OptimizationJobArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:optimization-job/" + } + }, + "com.amazonaws.sagemaker#OptimizationJobDeploymentInstanceType": { + "type": "enum", + "members": { + "ML_P4D_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p4d.24xlarge" + } + }, + "ML_P4DE_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p4de.24xlarge" + } + }, + "ML_P5_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p5.48xlarge" + } + }, + "ML_G5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.xlarge" + } + }, + "ML_G5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.2xlarge" + } + }, + "ML_G5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.4xlarge" + } + }, + "ML_G5_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.8xlarge" + } + }, + "ML_G5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.12xlarge" + } + }, + "ML_G5_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.16xlarge" + } + }, + "ML_G5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.24xlarge" + } + }, + "ML_G5_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.48xlarge" + } + }, + "ML_G6_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.xlarge" + } + }, + "ML_G6_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.2xlarge" + } + }, + "ML_G6_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.4xlarge" + } + }, + "ML_G6_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.8xlarge" + } + }, + "ML_G6_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.12xlarge" + } + }, + "ML_G6_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.16xlarge" + } + }, + "ML_G6_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.24xlarge" + } + }, + "ML_G6_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.48xlarge" + } + }, + "ML_INF2_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf2.xlarge" + } + }, + "ML_INF2_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf2.8xlarge" + } + }, + "ML_INF2_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf2.24xlarge" + } + }, + "ML_INF2_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf2.48xlarge" + } + }, + "ML_TRN1_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1.2xlarge" + } + }, + "ML_TRN1_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1.32xlarge" + } + }, + "ML_TRN1N_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1n.32xlarge" + } + } + } + }, + "com.amazonaws.sagemaker#OptimizationJobEnvironmentVariables": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#NonEmptyString256" + }, + "value": { + "target": "com.amazonaws.sagemaker#String256" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 25 + } + } + }, + "com.amazonaws.sagemaker#OptimizationJobModelSource": { + "type": "structure", + "members": { + "S3": { + "target": "com.amazonaws.sagemaker#OptimizationJobModelSourceS3", + "traits": { + "smithy.api#documentation": "

The Amazon S3 location of a source model to optimize with an optimization job.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The location of the source model to optimize with an optimization job.

" + } + }, + "com.amazonaws.sagemaker#OptimizationJobModelSourceS3": { + "type": "structure", + "members": { + "S3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "

An Amazon S3 URI that locates a source model to optimize with an optimization job.

" + } + }, + "ModelAccessConfig": { + "target": "com.amazonaws.sagemaker#OptimizationModelAccessConfig", + "traits": { + "smithy.api#documentation": "

The access configuration settings for the source ML model for an optimization job, where you can accept the model end-user license agreement (EULA).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon S3 location of a source model to optimize with an optimization job.

" + } + }, + "com.amazonaws.sagemaker#OptimizationJobOutputConfig": { + "type": "structure", + "members": { + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a key in Amazon Web Services KMS. SageMaker uses they key to encrypt the artifacts of the\n optimized model when SageMaker uploads the model to Amazon S3.

" + } + }, + "S3OutputLocation": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon S3 URI for where to store the optimized model that you create with an optimization\n job.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Details for where to store the optimized model that you create with the optimization job.

" + } + }, + "com.amazonaws.sagemaker#OptimizationJobStatus": { + "type": "enum", + "members": { + "INPROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INPROGRESS" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "STARTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTING" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPING" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + } + } + }, + "com.amazonaws.sagemaker#OptimizationJobSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#OptimizationJobSummary" + } + }, + "com.amazonaws.sagemaker#OptimizationJobSummary": { + "type": "structure", + "members": { + "OptimizationJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name that you assigned to the optimization job.

", + "smithy.api#required": {} + } + }, + "OptimizationJobArn": { + "target": "com.amazonaws.sagemaker#OptimizationJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the optimization job.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The time when you created the optimization job.

", + "smithy.api#required": {} + } + }, + "OptimizationJobStatus": { + "target": "com.amazonaws.sagemaker#OptimizationJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The current status of the optimization job.

", + "smithy.api#required": {} + } + }, + "OptimizationStartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the optimization job started.

" + } + }, + "OptimizationEndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the optimization job finished processing.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "

The time when the optimization job was last updated.

" + } + }, + "DeploymentInstanceType": { + "target": "com.amazonaws.sagemaker#OptimizationJobDeploymentInstanceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of instance that hosts the optimized model that you create with the optimization job.

", + "smithy.api#required": {} + } + }, + "OptimizationTypes": { + "target": "com.amazonaws.sagemaker#OptimizationTypes", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The optimization techniques that are applied by the optimization job.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Summarizes an optimization job by providing some of its key properties.

" + } + }, + "com.amazonaws.sagemaker#OptimizationModelAcceptEula": { + "type": "boolean" + }, + "com.amazonaws.sagemaker#OptimizationModelAccessConfig": { + "type": "structure", + "members": { + "AcceptEula": { + "target": "com.amazonaws.sagemaker#OptimizationModelAcceptEula", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies agreement to the model end-user license agreement (EULA). The\n AcceptEula value must be explicitly defined as True in order\n to accept the EULA that this model requires. You are responsible for reviewing and\n complying with any applicable license terms and making sure they are acceptable for your\n use case before downloading or using a model.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The access configuration settings for the source ML model for an optimization job, where you can accept the model end-user license agreement (EULA).

" + } + }, + "com.amazonaws.sagemaker#OptimizationOutput": { + "type": "structure", + "members": { + "RecommendedInferenceImage": { + "target": "com.amazonaws.sagemaker#OptimizationContainerImage", + "traits": { + "smithy.api#documentation": "

The image that SageMaker recommends that you use to host the optimized model that you created\n with an optimization job.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Output values produced by an optimization job.

" + } + }, + "com.amazonaws.sagemaker#OptimizationType": { + "type": "string" + }, + "com.amazonaws.sagemaker#OptimizationTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#OptimizationType" + } + }, + "com.amazonaws.sagemaker#OptimizationVpcConfig": { + "type": "structure", + "members": { + "SecurityGroupIds": { + "target": "com.amazonaws.sagemaker#OptimizationVpcSecurityGroupIds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security\n groups for the VPC that is specified in the Subnets field.

", + "smithy.api#required": {} + } + }, + "Subnets": { + "target": "com.amazonaws.sagemaker#OptimizationVpcSubnets", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the subnets in the VPC to which you want to connect your optimized\n model.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A VPC in Amazon VPC that's accessible to an optimized that you create with an optimization\n job. You can control access to and from your resources by configuring a VPC. For more\n information, see Give SageMaker Access to Resources in your Amazon VPC.

" + } + }, + "com.amazonaws.sagemaker#OptimizationVpcSecurityGroupId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + }, + "smithy.api#pattern": "^[-0-9a-zA-Z]+$" + } + }, + "com.amazonaws.sagemaker#OptimizationVpcSecurityGroupIds": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#OptimizationVpcSecurityGroupId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#OptimizationVpcSubnetId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + }, + "smithy.api#pattern": "^[-0-9a-zA-Z]+$" + } + }, + "com.amazonaws.sagemaker#OptimizationVpcSubnets": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#OptimizationVpcSubnetId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16 + } + } + }, + "com.amazonaws.sagemaker#OptionalDouble": { + "type": "double" + }, + "com.amazonaws.sagemaker#OptionalInteger": { + "type": "integer" + }, + "com.amazonaws.sagemaker#OptionalVolumeSizeInGB": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.sagemaker#OrderKey": { + "type": "enum", + "members": { + "Ascending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ascending" + } + }, + "Descending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Descending" + } + } + } + }, + "com.amazonaws.sagemaker#OutputCompressionType": { + "type": "enum", + "members": { + "GZIP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GZIP" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, + "com.amazonaws.sagemaker#OutputConfig": { + "type": "structure", + "members": { + "S3OutputLocation": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Identifies the S3 bucket where you want Amazon SageMaker AI to store the model artifacts. For\n example, s3://bucket-name/key-name-prefix.

", + "smithy.api#required": {} + } + }, + "TargetDevice": { + "target": "com.amazonaws.sagemaker#TargetDevice", + "traits": { + "smithy.api#documentation": "

Identifies the target device or the machine learning instance that you want to run\n your model on after the compilation has completed. Alternatively, you can specify OS,\n architecture, and accelerator using TargetPlatform\n fields. It can be used instead of TargetPlatform.

\n \n

Currently ml_trn1 is available only in US East (N. Virginia) Region,\n and ml_inf2 is available only in US East (Ohio) Region.

\n " + } + }, + "TargetPlatform": { + "target": "com.amazonaws.sagemaker#TargetPlatform", + "traits": { + "smithy.api#documentation": "

Contains information about a target platform that you want your model to run on, such\n as OS, architecture, and accelerators. It is an alternative of\n TargetDevice.

\n

The following examples show how to configure the TargetPlatform and\n CompilerOptions JSON strings for popular target platforms:

\n
    \n
  • \n

    Raspberry Pi 3 Model B+

    \n

    \n \"TargetPlatform\": {\"Os\": \"LINUX\", \"Arch\": \"ARM_EABIHF\"},\n

    \n

    \n \"CompilerOptions\": {'mattr': ['+neon']}\n

    \n
    • \n
  • \n

    Jetson TX2

    \n

    \n \"TargetPlatform\": {\"Os\": \"LINUX\", \"Arch\": \"ARM64\", \"Accelerator\":\n \"NVIDIA\"},\n

    \n

    \n \"CompilerOptions\": {'gpu-code': 'sm_62', 'trt-ver': '6.0.1',\n 'cuda-ver': '10.0'}\n

    \n
    • \n
  • \n

    EC2 m5.2xlarge instance OS

    \n

    \n \"TargetPlatform\": {\"Os\": \"LINUX\", \"Arch\": \"X86_64\", \"Accelerator\":\n \"NVIDIA\"},\n

    \n

    \n \"CompilerOptions\": {'mcpu': 'skylake-avx512'}\n

    \n
    • \n
  • \n

    RK3399

    \n

    \n \"TargetPlatform\": {\"Os\": \"LINUX\", \"Arch\": \"ARM64\", \"Accelerator\":\n \"MALI\"}\n

    \n
    • \n
  • \n

    ARMv7 phone (CPU)

    \n

    \n \"TargetPlatform\": {\"Os\": \"ANDROID\", \"Arch\": \"ARM_EABI\"},\n

    \n

    \n \"CompilerOptions\": {'ANDROID_PLATFORM': 25, 'mattr':\n ['+neon']}\n

    \n
    • \n
  • \n

    ARMv8 phone (CPU)

    \n

    \n \"TargetPlatform\": {\"Os\": \"ANDROID\", \"Arch\": \"ARM64\"},\n

    \n

    \n \"CompilerOptions\": {'ANDROID_PLATFORM': 29}\n

    \n
    • \n
" + } + }, + "CompilerOptions": { + "target": "com.amazonaws.sagemaker#CompilerOptions", + "traits": { + "smithy.api#documentation": "

Specifies additional parameters for compiler options in JSON format. The compiler\n options are TargetPlatform specific. It is required for NVIDIA accelerators\n and highly recommended for CPU compilations. For any other cases, it is optional to\n specify CompilerOptions.\n

\n
    \n
  • \n

    \n DTYPE: Specifies the data type for the input. When compiling for\n ml_* (except for ml_inf) instances using PyTorch\n framework, provide the data type (dtype) of the model's input.\n \"float32\" is used if \"DTYPE\" is not specified.\n Options for data type are:

    \n
      \n
    • \n

      float32: Use either \"float\" or\n \"float32\".

      \n
      • \n
    • \n

      int64: Use either \"int64\" or \"long\".

      \n
      • \n
    \n

    For example, {\"dtype\" : \"float32\"}.

    \n
    • \n
  • \n

    \n CPU: Compilation for CPU supports the following compiler\n options.

    \n
      \n
    • \n

      \n mcpu: CPU micro-architecture. For example, {'mcpu':\n 'skylake-avx512'}\n

      \n
      • \n
    • \n

      \n mattr: CPU flags. For example, {'mattr': ['+neon',\n '+vfpv4']}\n

      \n
      • \n
    \n
    • \n
  • \n

    \n ARM: Details of ARM CPU compilations.

    \n
      \n
    • \n

      \n NEON: NEON is an implementation of the Advanced SIMD\n extension used in ARMv7 processors.

      \n

      For example, add {'mattr': ['+neon']} to the compiler\n options if compiling for ARM 32-bit platform with the NEON\n support.

      \n
      • \n
    \n
    • \n
  • \n

    \n NVIDIA: Compilation for NVIDIA GPU supports the following\n compiler options.

    \n
      \n
    • \n

      \n gpu_code: Specifies the targeted architecture.

      \n
      • \n
    • \n

      \n trt-ver: Specifies the TensorRT versions in x.y.z.\n format.

      \n
      • \n
    • \n

      \n cuda-ver: Specifies the CUDA version in x.y\n format.

      \n
      • \n
    \n

    For example, {'gpu-code': 'sm_72', 'trt-ver': '6.0.1', 'cuda-ver':\n '10.1'}\n

    \n
    • \n
  • \n

    \n ANDROID: Compilation for the Android OS supports the following\n compiler options:

    \n
      \n
    • \n

      \n ANDROID_PLATFORM: Specifies the Android API levels.\n Available levels range from 21 to 29. For example,\n {'ANDROID_PLATFORM': 28}.

      \n
      • \n
    • \n

      \n mattr: Add {'mattr': ['+neon']} to compiler\n options if compiling for ARM 32-bit platform with NEON support.

      \n
      • \n
    \n
    • \n
  • \n

    \n INFERENTIA: Compilation for target ml_inf1 uses compiler options\n passed in as a JSON string. For example, \"CompilerOptions\": \"\\\"--verbose 1\n --num-neuroncores 2 -O2\\\"\".

    \n

    For information about supported compiler options, see Neuron Compiler CLI Reference Guide.

    \n
    • \n
  • \n

    \n CoreML: Compilation for the CoreML OutputConfig\n TargetDevice supports the following compiler options:

    \n
      \n
    • \n

      \n class_labels: Specifies the classification labels file\n name inside input tar.gz file. For example, {\"class_labels\":\n \"imagenet_labels_1000.txt\"}. Labels inside the txt file\n should be separated by newlines.

      \n
      • \n
    \n
    • \n
" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Key Management Service key (Amazon Web Services KMS) that Amazon SageMaker AI\n uses to encrypt your output models with Amazon S3 server-side encryption after compilation\n job. If you don't provide a KMS key ID, Amazon SageMaker AI uses the default KMS key for Amazon S3 for your\n role's account. For more information, see KMS-Managed Encryption\n Keys in the Amazon Simple Storage Service Developer\n Guide.\n

\n

The KmsKeyId can be any of the following formats:

\n
    \n
  • \n

    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Key ARN:\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Alias name: alias/ExampleAlias\n

    \n
    • \n
  • \n

    Alias name ARN:\n arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\n

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the output location for the compiled model and the target\n device that the model runs on. TargetDevice and TargetPlatform\n are mutually exclusive, so you need to choose one between the two to specify your target\n device or platform. If you cannot find your device you want to use from the\n TargetDevice list, use TargetPlatform to describe the\n platform of your edge device and CompilerOptions if there are specific\n settings that are required or recommended to use for particular TargetPlatform.

" + } + }, + "com.amazonaws.sagemaker#OutputDataConfig": { + "type": "structure", + "members": { + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker\n uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The\n KmsKeyId can be any of the following formats:

\n
    \n
  • \n

    // KMS Key ID

    \n

    \n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    // Amazon Resource Name (ARN) of a KMS Key

    \n

    \n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    // KMS Key Alias

    \n

    \n \"alias/ExampleAlias\"\n

    \n
    • \n
  • \n

    // Amazon Resource Name (ARN) of a KMS Key Alias

    \n

    \n \"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"\n

    \n
    • \n
\n

If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must\n include permissions to call kms:Encrypt. If you don't provide a KMS key ID,\n SageMaker uses the default KMS key for Amazon S3 for your role's account.\n \n For more information, see KMS-Managed Encryption\n Keys in the Amazon Simple Storage Service Developer Guide. If the output\n data is stored in Amazon S3 Express One Zone, it is encrypted with server-side encryption with Amazon S3\n managed keys (SSE-S3). KMS key is not supported for Amazon S3 Express One Zone

\n

The KMS key policy must grant permission to the IAM role that you specify in your\n CreateTrainingJob, CreateTransformJob, or\n CreateHyperParameterTuningJob requests. For more information, see\n Using\n Key Policies in Amazon Web Services KMS in the Amazon Web Services\n Key Management Service Developer Guide.

" + } + }, + "S3OutputPath": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Identifies the S3 path where you want SageMaker to store the model artifacts. For\n example, s3://bucket-name/key-name-prefix.

", + "smithy.api#required": {} + } + }, + "CompressionType": { + "target": "com.amazonaws.sagemaker#OutputCompressionType", + "traits": { + "smithy.api#documentation": "

The model output compression type. Select None to output an uncompressed\n model, recommended for large model outputs. Defaults to gzip.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about how to store model training results (model\n artifacts).

" + } + }, + "com.amazonaws.sagemaker#OutputParameter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the output parameter.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.sagemaker#String1024", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The value of the output parameter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An output parameter of a pipeline step.

" + } + }, + "com.amazonaws.sagemaker#OutputParameterList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#OutputParameter" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.sagemaker#OwnershipSettings": { + "type": "structure", + "members": { + "OwnerUserProfileName": { + "target": "com.amazonaws.sagemaker#UserProfileName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The user profile who is the owner of the space.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The collection of ownership settings for a space.

" + } + }, + "com.amazonaws.sagemaker#OwnershipSettingsSummary": { + "type": "structure", + "members": { + "OwnerUserProfileName": { + "target": "com.amazonaws.sagemaker#UserProfileName", + "traits": { + "smithy.api#documentation": "

The user profile who is the owner of the space.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies summary information about the ownership settings.

" + } + }, + "com.amazonaws.sagemaker#PaginationToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 8192 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#ParallelismConfiguration": { + "type": "structure", + "members": { + "MaxParallelExecutionSteps": { + "target": "com.amazonaws.sagemaker#MaxParallelExecutionSteps", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The max number of steps that can be executed in parallel.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration that controls the parallelism of the pipeline. \n By default, the parallelism configuration specified applies to all \n executions of the pipeline unless overridden.

" + } + }, + "com.amazonaws.sagemaker#Parameter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#PipelineParameterName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the parameter to assign a value to. This \n parameter name must match a named parameter in the \n pipeline definition.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.sagemaker#String1024", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The literal value for the parameter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Assigns a value to a named Pipeline parameter.

" + } + }, + "com.amazonaws.sagemaker#ParameterKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#ParameterList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#Parameter" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.sagemaker#ParameterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*$" + } + }, + "com.amazonaws.sagemaker#ParameterRange": { + "type": "structure", + "members": { + "IntegerParameterRangeSpecification": { + "target": "com.amazonaws.sagemaker#IntegerParameterRangeSpecification", + "traits": { + "smithy.api#documentation": "

A IntegerParameterRangeSpecification object that defines the possible\n values for an integer hyperparameter.

" + } + }, + "ContinuousParameterRangeSpecification": { + "target": "com.amazonaws.sagemaker#ContinuousParameterRangeSpecification", + "traits": { + "smithy.api#documentation": "

A ContinuousParameterRangeSpecification object that defines the possible\n values for a continuous hyperparameter.

" + } + }, + "CategoricalParameterRangeSpecification": { + "target": "com.amazonaws.sagemaker#CategoricalParameterRangeSpecification", + "traits": { + "smithy.api#documentation": "

A CategoricalParameterRangeSpecification object that defines the possible\n values for a categorical hyperparameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines the possible values for categorical, continuous, and integer hyperparameters\n to be used by an algorithm.

" + } + }, + "com.amazonaws.sagemaker#ParameterRanges": { + "type": "structure", + "members": { + "IntegerParameterRanges": { + "target": "com.amazonaws.sagemaker#IntegerParameterRanges", + "traits": { + "smithy.api#documentation": "

The array of IntegerParameterRange objects that specify ranges of integer\n hyperparameters that a hyperparameter tuning job searches.

" + } + }, + "ContinuousParameterRanges": { + "target": "com.amazonaws.sagemaker#ContinuousParameterRanges", + "traits": { + "smithy.api#documentation": "

The array of ContinuousParameterRange objects that specify ranges of continuous\n hyperparameters that a hyperparameter tuning job searches.

" + } + }, + "CategoricalParameterRanges": { + "target": "com.amazonaws.sagemaker#CategoricalParameterRanges", + "traits": { + "smithy.api#documentation": "

The array of CategoricalParameterRange objects that specify ranges of categorical\n hyperparameters that a hyperparameter tuning job searches.

" + } + }, + "AutoParameters": { + "target": "com.amazonaws.sagemaker#AutoParameters", + "traits": { + "smithy.api#documentation": "

A list containing hyperparameter names and example values to be used by Autotune to\n determine optimal ranges for your tuning job.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies ranges of integer, continuous, and categorical hyperparameters that a\n hyperparameter tuning job searches. The hyperparameter tuning job launches training jobs\n with hyperparameter values within these ranges to find the combination of values that\n result in the training job with the best performance as measured by the objective metric\n of the hyperparameter tuning job.

\n \n

The maximum number of items specified for Array Members refers to the\n maximum number of hyperparameters for each range and also the maximum for the\n hyperparameter tuning job itself. That is, the sum of the number of hyperparameters\n for all the ranges can't exceed the maximum number specified.

\n " + } + }, + "com.amazonaws.sagemaker#ParameterType": { + "type": "enum", + "members": { + "INTEGER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Integer" + } + }, + "CONTINUOUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Continuous" + } + }, + "CATEGORICAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Categorical" + } + }, + "FREE_TEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FreeText" + } + } + } + }, + "com.amazonaws.sagemaker#ParameterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#ParameterValues": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ParameterValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 30 + } + } + }, + "com.amazonaws.sagemaker#Parent": { + "type": "structure", + "members": { + "TrialName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

The name of the trial.

" + } + }, + "ExperimentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

The name of the experiment.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The trial that a trial component is associated with and the experiment the trial is part\n of. A component might not be associated with a trial. A component can be associated with\n multiple trials.

" + } + }, + "com.amazonaws.sagemaker#ParentHyperParameterTuningJob": { + "type": "structure", + "members": { + "HyperParameterTuningJobName": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobName", + "traits": { + "smithy.api#documentation": "

The name of the hyperparameter tuning job to be used as a starting point for a new\n hyperparameter tuning job.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A previously completed or stopped hyperparameter tuning job to be used as a starting\n point for a new hyperparameter tuning job.

" + } + }, + "com.amazonaws.sagemaker#ParentHyperParameterTuningJobs": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ParentHyperParameterTuningJob" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#Parents": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#Parent" + } + }, + "com.amazonaws.sagemaker#PartnerAppAdminUserList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#NonEmptyString256" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#PartnerAppArguments": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#NonEmptyString256" + }, + "value": { + "target": "com.amazonaws.sagemaker#String1024" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#PartnerAppArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:partner-app\\/app-[A-Z0-9]{12}$" + } + }, + "com.amazonaws.sagemaker#PartnerAppAuthType": { + "type": "enum", + "members": { + "IAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM" + } + } + } + }, + "com.amazonaws.sagemaker#PartnerAppConfig": { + "type": "structure", + "members": { + "AdminUsers": { + "target": "com.amazonaws.sagemaker#PartnerAppAdminUserList", + "traits": { + "smithy.api#documentation": "

The list of users that are given admin access to the SageMaker Partner AI App.

" + } + }, + "Arguments": { + "target": "com.amazonaws.sagemaker#PartnerAppArguments", + "traits": { + "smithy.api#documentation": "

This is a map of required inputs for a SageMaker Partner AI App. Based on the application type, the map is populated with a key and value pair that is specific to the user and application.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration settings for the SageMaker Partner AI App.

" + } + }, + "com.amazonaws.sagemaker#PartnerAppMaintenanceConfig": { + "type": "structure", + "members": { + "MaintenanceWindowStart": { + "target": "com.amazonaws.sagemaker#WeeklyScheduleTimeFormat", + "traits": { + "smithy.api#documentation": "

The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled. This value must take the following format: 3-letter-day:24-h-hour:minute. For example: TUE:03:30.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Maintenance configuration settings for the SageMaker Partner AI App.

" + } + }, + "com.amazonaws.sagemaker#PartnerAppName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]+$" + } + }, + "com.amazonaws.sagemaker#PartnerAppStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Creating" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Available" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateFailed" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleted" + } + } + } + }, + "com.amazonaws.sagemaker#PartnerAppSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#PartnerAppSummary" + } + }, + "com.amazonaws.sagemaker#PartnerAppSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#PartnerAppArn", + "traits": { + "smithy.api#documentation": "

The ARN of the SageMaker Partner AI App.

" + } + }, + "Name": { + "target": "com.amazonaws.sagemaker#PartnerAppName", + "traits": { + "smithy.api#documentation": "

The name of the SageMaker Partner AI App.

" + } + }, + "Type": { + "target": "com.amazonaws.sagemaker#PartnerAppType", + "traits": { + "smithy.api#documentation": "

The type of SageMaker Partner AI App to create. Must be one of the following: lakera-guard, comet, deepchecks-llm-evaluation, or fiddler.

" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#PartnerAppStatus", + "traits": { + "smithy.api#documentation": "

The status of the SageMaker Partner AI App.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The creation time of the SageMaker Partner AI App.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A subset of information related to a SageMaker Partner AI App. This information is used as part of the ListPartnerApps API response.

" + } + }, + "com.amazonaws.sagemaker#PartnerAppType": { + "type": "enum", + "members": { + "LAKERA_GUARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "lakera-guard" + } + }, + "COMET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "comet" + } + }, + "DEEPCHECKS_LLM_EVALUATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deepchecks-llm-evaluation" + } + }, + "FIDDLER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fiddler" + } + } + } + }, + "com.amazonaws.sagemaker#PendingDeploymentSummary": { + "type": "structure", + "members": { + "EndpointConfigName": { + "target": "com.amazonaws.sagemaker#EndpointConfigName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the endpoint configuration used in the deployment.

", + "smithy.api#required": {} + } + }, + "ProductionVariants": { + "target": "com.amazonaws.sagemaker#PendingProductionVariantSummaryList", + "traits": { + "smithy.api#documentation": "

An array of PendingProductionVariantSummary objects, one for each model hosted behind\n this endpoint for the in-progress deployment.

" + } + }, + "StartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The start time of the deployment.

" + } + }, + "ShadowProductionVariants": { + "target": "com.amazonaws.sagemaker#PendingProductionVariantSummaryList", + "traits": { + "smithy.api#documentation": "

An array of PendingProductionVariantSummary objects, one for each model hosted behind\n this endpoint in shadow mode with production traffic replicated from the model specified\n on ProductionVariants for the in-progress deployment.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The summary of an in-progress deployment when an endpoint is creating or updating with\n a new endpoint configuration.

" + } + }, + "com.amazonaws.sagemaker#PendingProductionVariantSummary": { + "type": "structure", + "members": { + "VariantName": { + "target": "com.amazonaws.sagemaker#VariantName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the variant.

", + "smithy.api#required": {} + } + }, + "DeployedImages": { + "target": "com.amazonaws.sagemaker#DeployedImages", + "traits": { + "smithy.api#documentation": "

An array of DeployedImage objects that specify the Amazon EC2 Container\n Registry paths of the inference images deployed on instances of this\n ProductionVariant.

" + } + }, + "CurrentWeight": { + "target": "com.amazonaws.sagemaker#VariantWeight", + "traits": { + "smithy.api#documentation": "

The weight associated with the variant.

" + } + }, + "DesiredWeight": { + "target": "com.amazonaws.sagemaker#VariantWeight", + "traits": { + "smithy.api#documentation": "

The requested weight for the variant in this deployment, as specified in the endpoint\n configuration for the endpoint. The value is taken from the request to the CreateEndpointConfig operation.

" + } + }, + "CurrentInstanceCount": { + "target": "com.amazonaws.sagemaker#TaskCount", + "traits": { + "smithy.api#documentation": "

The number of instances associated with the variant.

" + } + }, + "DesiredInstanceCount": { + "target": "com.amazonaws.sagemaker#TaskCount", + "traits": { + "smithy.api#documentation": "

The number of instances requested in this deployment, as specified in the endpoint\n configuration for the endpoint. The value is taken from the request to the CreateEndpointConfig operation.

" + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#ProductionVariantInstanceType", + "traits": { + "smithy.api#documentation": "

The type of instances associated with the variant.

" + } + }, + "AcceleratorType": { + "target": "com.amazonaws.sagemaker#ProductionVariantAcceleratorType", + "traits": { + "smithy.api#documentation": "

This parameter is no longer supported. Elastic Inference (EI) is no longer\n available.

\n

This parameter was used to specify the size of the EI instance to use for the\n production variant.

" + } + }, + "VariantStatus": { + "target": "com.amazonaws.sagemaker#ProductionVariantStatusList", + "traits": { + "smithy.api#documentation": "

The endpoint variant status which describes the current deployment stage status or\n operational status.

" + } + }, + "CurrentServerlessConfig": { + "target": "com.amazonaws.sagemaker#ProductionVariantServerlessConfig", + "traits": { + "smithy.api#documentation": "

The serverless configuration for the endpoint.

" + } + }, + "DesiredServerlessConfig": { + "target": "com.amazonaws.sagemaker#ProductionVariantServerlessConfig", + "traits": { + "smithy.api#documentation": "

The serverless configuration requested for this deployment, as specified in the endpoint configuration for the endpoint.

" + } + }, + "ManagedInstanceScaling": { + "target": "com.amazonaws.sagemaker#ProductionVariantManagedInstanceScaling", + "traits": { + "smithy.api#documentation": "

Settings that control the range in the number of instances that the endpoint provisions\n as it scales up or down to accommodate traffic.

" + } + }, + "RoutingConfig": { + "target": "com.amazonaws.sagemaker#ProductionVariantRoutingConfig", + "traits": { + "smithy.api#documentation": "

Settings that control how the endpoint routes incoming traffic to the instances that the\n endpoint hosts.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The production variant summary for a deployment when an endpoint is creating or\n updating with the CreateEndpoint\n or UpdateEndpoint\n operations. Describes the VariantStatus , weight and capacity for a\n production variant associated with an endpoint.

" + } + }, + "com.amazonaws.sagemaker#PendingProductionVariantSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#PendingProductionVariantSummary" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#Percentage": { + "type": "integer", + "traits": { + "smithy.api#range": { + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#Phase": { + "type": "structure", + "members": { + "InitialNumberOfUsers": { + "target": "com.amazonaws.sagemaker#InitialNumberOfUsers", + "traits": { + "smithy.api#documentation": "

Specifies how many concurrent users to start with. The value should be between 1 and 3.

" + } + }, + "SpawnRate": { + "target": "com.amazonaws.sagemaker#SpawnRate", + "traits": { + "smithy.api#documentation": "

Specified how many new users to spawn in a minute.

" + } + }, + "DurationInSeconds": { + "target": "com.amazonaws.sagemaker#TrafficDurationInSeconds", + "traits": { + "smithy.api#documentation": "

Specifies how long a traffic phase should be. For custom load tests, the value should be between 120 and 3600.\n This value should not exceed JobDurationInSeconds.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines the traffic pattern.

" + } + }, + "com.amazonaws.sagemaker#Phases": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#Phase" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#Pipeline": { + "type": "structure", + "members": { + "PipelineArn": { + "target": "com.amazonaws.sagemaker#PipelineArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the pipeline.

" + } + }, + "PipelineName": { + "target": "com.amazonaws.sagemaker#PipelineName", + "traits": { + "smithy.api#documentation": "

The name of the pipeline.

" + } + }, + "PipelineDisplayName": { + "target": "com.amazonaws.sagemaker#PipelineName", + "traits": { + "smithy.api#documentation": "

The display name of the pipeline.

" + } + }, + "PipelineDescription": { + "target": "com.amazonaws.sagemaker#PipelineDescription", + "traits": { + "smithy.api#documentation": "

The description of the pipeline.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role that created the pipeline.

" + } + }, + "PipelineStatus": { + "target": "com.amazonaws.sagemaker#PipelineStatus", + "traits": { + "smithy.api#documentation": "

The status of the pipeline.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The creation time of the pipeline.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the pipeline was last modified.

" + } + }, + "LastRunTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the pipeline was last run.

" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "ParallelismConfiguration": { + "target": "com.amazonaws.sagemaker#ParallelismConfiguration", + "traits": { + "smithy.api#documentation": "

The parallelism configuration applied to the pipeline.

" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags that apply to the pipeline.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A SageMaker Model Building Pipeline instance.

" + } + }, + "com.amazonaws.sagemaker#PipelineArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:pipeline/" + } + }, + "com.amazonaws.sagemaker#PipelineDefinition": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1048576 + }, + "smithy.api#pattern": "(?:[ \\r\\n\\t].*)*$" + } + }, + "com.amazonaws.sagemaker#PipelineDefinitionS3Location": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.sagemaker#BucketName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Name of the S3 bucket.

", + "smithy.api#required": {} + } + }, + "ObjectKey": { + "target": "com.amazonaws.sagemaker#Key", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The object key (or key name) uniquely identifies the \n object in an S3 bucket.

", + "smithy.api#required": {} + } + }, + "VersionId": { + "target": "com.amazonaws.sagemaker#VersionId", + "traits": { + "smithy.api#documentation": "

Version Id of the pipeline definition file. If not specified, Amazon SageMaker \n will retrieve the latest version.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The location of the pipeline definition stored in Amazon S3.

" + } + }, + "com.amazonaws.sagemaker#PipelineDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3072 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#PipelineExecution": { + "type": "structure", + "members": { + "PipelineArn": { + "target": "com.amazonaws.sagemaker#PipelineArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the pipeline that was executed.

" + } + }, + "PipelineExecutionArn": { + "target": "com.amazonaws.sagemaker#PipelineExecutionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the pipeline execution.

" + } + }, + "PipelineExecutionDisplayName": { + "target": "com.amazonaws.sagemaker#PipelineExecutionName", + "traits": { + "smithy.api#documentation": "

The display name of the pipeline execution.

" + } + }, + "PipelineExecutionStatus": { + "target": "com.amazonaws.sagemaker#PipelineExecutionStatus", + "traits": { + "smithy.api#documentation": "

The status of the pipeline status.

" + } + }, + "PipelineExecutionDescription": { + "target": "com.amazonaws.sagemaker#PipelineExecutionDescription", + "traits": { + "smithy.api#documentation": "

The description of the pipeline execution.

" + } + }, + "PipelineExperimentConfig": { + "target": "com.amazonaws.sagemaker#PipelineExperimentConfig" + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#PipelineExecutionFailureReason", + "traits": { + "smithy.api#documentation": "

If the execution failed, a message describing why.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The creation time of the pipeline execution.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the pipeline execution was last modified.

" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "ParallelismConfiguration": { + "target": "com.amazonaws.sagemaker#ParallelismConfiguration", + "traits": { + "smithy.api#documentation": "

The parallelism configuration applied to the pipeline execution.

" + } + }, + "SelectiveExecutionConfig": { + "target": "com.amazonaws.sagemaker#SelectiveExecutionConfig", + "traits": { + "smithy.api#documentation": "

The selective execution configuration applied to the pipeline run.

" + } + }, + "PipelineParameters": { + "target": "com.amazonaws.sagemaker#ParameterList", + "traits": { + "smithy.api#documentation": "

Contains a list of pipeline parameters. This list can be empty.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An execution of a pipeline.

" + } + }, + "com.amazonaws.sagemaker#PipelineExecutionArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:pipeline\\/.*\\/execution\\/.*$" + } + }, + "com.amazonaws.sagemaker#PipelineExecutionDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3072 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#PipelineExecutionFailureReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1300 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#PipelineExecutionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 82 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,81}$" + } + }, + "com.amazonaws.sagemaker#PipelineExecutionStatus": { + "type": "enum", + "members": { + "EXECUTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Executing" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Succeeded" + } + } + } + }, + "com.amazonaws.sagemaker#PipelineExecutionStep": { + "type": "structure", + "members": { + "StepName": { + "target": "com.amazonaws.sagemaker#StepName", + "traits": { + "smithy.api#documentation": "

The name of the step that is executed.

" + } + }, + "StepDisplayName": { + "target": "com.amazonaws.sagemaker#StepDisplayName", + "traits": { + "smithy.api#documentation": "

The display name of the step.

" + } + }, + "StepDescription": { + "target": "com.amazonaws.sagemaker#StepDescription", + "traits": { + "smithy.api#documentation": "

The description of the step.

" + } + }, + "StartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the step started executing.

" + } + }, + "EndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the step stopped executing.

" + } + }, + "StepStatus": { + "target": "com.amazonaws.sagemaker#StepStatus", + "traits": { + "smithy.api#documentation": "

The status of the step execution.

" + } + }, + "CacheHitResult": { + "target": "com.amazonaws.sagemaker#CacheHitResult", + "traits": { + "smithy.api#documentation": "

If this pipeline execution step was cached, details on the cache hit.

" + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "

The reason why the step failed execution. This is only returned if the step failed its execution.

" + } + }, + "Metadata": { + "target": "com.amazonaws.sagemaker#PipelineExecutionStepMetadata", + "traits": { + "smithy.api#documentation": "

Metadata to run the pipeline step.

" + } + }, + "AttemptCount": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "

The current attempt of the execution step. For more information, see Retry Policy for SageMaker Pipelines steps.

" + } + }, + "SelectiveExecutionResult": { + "target": "com.amazonaws.sagemaker#SelectiveExecutionResult", + "traits": { + "smithy.api#documentation": "

The ARN from an execution of the current pipeline from which\n results are reused for this step.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An execution of a step in a pipeline.

" + } + }, + "com.amazonaws.sagemaker#PipelineExecutionStepList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#PipelineExecutionStep" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#PipelineExecutionStepMetadata": { + "type": "structure", + "members": { + "TrainingJob": { + "target": "com.amazonaws.sagemaker#TrainingJobStepMetadata", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the training job that was run by this step execution.

" + } + }, + "ProcessingJob": { + "target": "com.amazonaws.sagemaker#ProcessingJobStepMetadata", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the processing job that was run by this step execution.

" + } + }, + "TransformJob": { + "target": "com.amazonaws.sagemaker#TransformJobStepMetadata", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the transform job that was run by this step execution.

" + } + }, + "TuningJob": { + "target": "com.amazonaws.sagemaker#TuningJobStepMetaData", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.

" + } + }, + "Model": { + "target": "com.amazonaws.sagemaker#ModelStepMetadata", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model that was created by this step execution.

" + } + }, + "RegisterModel": { + "target": "com.amazonaws.sagemaker#RegisterModelStepMetadata", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model package that the model was registered to by this step execution.

" + } + }, + "Condition": { + "target": "com.amazonaws.sagemaker#ConditionStepMetadata", + "traits": { + "smithy.api#documentation": "

The outcome of the condition evaluation that was run by this step execution.

" + } + }, + "Callback": { + "target": "com.amazonaws.sagemaker#CallbackStepMetadata", + "traits": { + "smithy.api#documentation": "

The URL of the Amazon SQS queue used by this step execution, the pipeline generated token,\n and a list of output parameters.

" + } + }, + "Lambda": { + "target": "com.amazonaws.sagemaker#LambdaStepMetadata", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution and a list of\n output parameters.

" + } + }, + "EMR": { + "target": "com.amazonaws.sagemaker#EMRStepMetadata", + "traits": { + "smithy.api#documentation": "

The configurations and outcomes of an Amazon EMR step execution.

" + } + }, + "QualityCheck": { + "target": "com.amazonaws.sagemaker#QualityCheckStepMetadata", + "traits": { + "smithy.api#documentation": "

The configurations and outcomes of the check step execution. This includes:

\n
    \n
  • \n

    The type of the check conducted.

    \n
    • \n
  • \n

    The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.

    \n
    • \n
  • \n

    The Amazon S3 URIs of newly calculated baseline constraints and statistics.

    \n
    • \n
  • \n

    The model package group name provided.

    \n
    • \n
  • \n

    The Amazon S3 URI of the violation report if violations detected.

    \n
    • \n
  • \n

    The Amazon Resource Name (ARN) of check processing job initiated by the step execution.

    \n
    • \n
  • \n

    The Boolean flags indicating if the drift check is skipped.

    \n
    • \n
  • \n

    If step property BaselineUsedForDriftCheck is set the same as \n CalculatedBaseline.

    \n
    • \n
" + } + }, + "ClarifyCheck": { + "target": "com.amazonaws.sagemaker#ClarifyCheckStepMetadata", + "traits": { + "smithy.api#documentation": "

Container for the metadata for a Clarify check step. The configurations \n and outcomes of the check step execution. This includes:

\n
    \n
  • \n

    The type of the check conducted,

    \n
    • \n
  • \n

    The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.

    \n
    • \n
  • \n

    The Amazon S3 URIs of newly calculated baseline constraints and statistics.

    \n
    • \n
  • \n

    The model package group name provided.

    \n
    • \n
  • \n

    The Amazon S3 URI of the violation report if violations detected.

    \n
    • \n
  • \n

    The Amazon Resource Name (ARN) of check processing job initiated by the step execution.

    \n
    • \n
  • \n

    The boolean flags indicating if the drift check is skipped.

    \n
    • \n
  • \n

    If step property BaselineUsedForDriftCheck is set the same as \n CalculatedBaseline.

    \n
    • \n
" + } + }, + "Fail": { + "target": "com.amazonaws.sagemaker#FailStepMetadata", + "traits": { + "smithy.api#documentation": "

The configurations and outcomes of a Fail step execution.

" + } + }, + "AutoMLJob": { + "target": "com.amazonaws.sagemaker#AutoMLJobStepMetadata", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AutoML job that was run by this step.

" + } + }, + "Endpoint": { + "target": "com.amazonaws.sagemaker#EndpointStepMetadata", + "traits": { + "smithy.api#documentation": "

The endpoint that was invoked during this step execution.

" + } + }, + "EndpointConfig": { + "target": "com.amazonaws.sagemaker#EndpointConfigStepMetadata", + "traits": { + "smithy.api#documentation": "

The endpoint configuration used to create an endpoint during this step execution.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Metadata for a step execution.

" + } + }, + "com.amazonaws.sagemaker#PipelineExecutionSummary": { + "type": "structure", + "members": { + "PipelineExecutionArn": { + "target": "com.amazonaws.sagemaker#PipelineExecutionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the pipeline execution.

" + } + }, + "StartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The start time of the pipeline execution.

" + } + }, + "PipelineExecutionStatus": { + "target": "com.amazonaws.sagemaker#PipelineExecutionStatus", + "traits": { + "smithy.api#documentation": "

The status of the pipeline execution.

" + } + }, + "PipelineExecutionDescription": { + "target": "com.amazonaws.sagemaker#PipelineExecutionDescription", + "traits": { + "smithy.api#documentation": "

The description of the pipeline execution.

" + } + }, + "PipelineExecutionDisplayName": { + "target": "com.amazonaws.sagemaker#PipelineExecutionName", + "traits": { + "smithy.api#documentation": "

The display name of the pipeline execution.

" + } + }, + "PipelineExecutionFailureReason": { + "target": "com.amazonaws.sagemaker#String3072", + "traits": { + "smithy.api#documentation": "

A message generated by SageMaker Pipelines describing why the pipeline execution failed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A pipeline execution summary.

" + } + }, + "com.amazonaws.sagemaker#PipelineExecutionSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#PipelineExecutionSummary" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#PipelineExperimentConfig": { + "type": "structure", + "members": { + "ExperimentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

The name of the experiment.

" + } + }, + "TrialName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

The name of the trial.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the names of the experiment and trial created by a pipeline.

" + } + }, + "com.amazonaws.sagemaker#PipelineName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}$" + } + }, + "com.amazonaws.sagemaker#PipelineNameOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:pipeline/.*)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,255})$" + } + }, + "com.amazonaws.sagemaker#PipelineParameterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9\\-_]*$" + } + }, + "com.amazonaws.sagemaker#PipelineStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + } + } + }, + "com.amazonaws.sagemaker#PipelineSummary": { + "type": "structure", + "members": { + "PipelineArn": { + "target": "com.amazonaws.sagemaker#PipelineArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the pipeline.

" + } + }, + "PipelineName": { + "target": "com.amazonaws.sagemaker#PipelineName", + "traits": { + "smithy.api#documentation": "

The name of the pipeline.

" + } + }, + "PipelineDisplayName": { + "target": "com.amazonaws.sagemaker#PipelineName", + "traits": { + "smithy.api#documentation": "

The display name of the pipeline.

" + } + }, + "PipelineDescription": { + "target": "com.amazonaws.sagemaker#PipelineDescription", + "traits": { + "smithy.api#documentation": "

The description of the pipeline.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that the pipeline used to execute.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The creation time of the pipeline.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the pipeline was last modified.

" + } + }, + "LastExecutionTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The last time that a pipeline execution began.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A summary of a pipeline.

" + } + }, + "com.amazonaws.sagemaker#PipelineSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#PipelineSummary" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#PlatformIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 15 + }, + "smithy.api#pattern": "^(notebook-al1-v1|notebook-al2-v1|notebook-al2-v2|notebook-al2-v3)$" + } + }, + "com.amazonaws.sagemaker#PolicyString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20480 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#PredefinedMetricSpecification": { + "type": "structure", + "members": { + "PredefinedMetricType": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The metric type. You can only apply SageMaker metric types to SageMaker endpoints.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A specification for a predefined metric.

" + } + }, + "com.amazonaws.sagemaker#PreemptTeamTasks": { + "type": "enum", + "members": { + "NEVER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Never" + } + }, + "LOWERPRIORITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LowerPriority" + } + } + } + }, + "com.amazonaws.sagemaker#PresignedDomainUrl": { + "type": "string" + }, + "com.amazonaws.sagemaker#PriorityClass": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#ClusterSchedulerPriorityClassName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Name of the priority class.

", + "smithy.api#required": {} + } + }, + "Weight": { + "target": "com.amazonaws.sagemaker#PriorityWeight", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Weight of the priority class. The value is within a range from 0 to 100, where 0 is the\n default.

\n

A weight of 0 is the lowest priority and 100 is the highest. Weight 0 is the\n default.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Priority class configuration. When included in PriorityClasses, these class\n configurations define how tasks are queued.

" + } + }, + "com.amazonaws.sagemaker#PriorityClassList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#PriorityClass" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.sagemaker#PriorityWeight": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#ProbabilityThresholdAttribute": { + "type": "double" + }, + "com.amazonaws.sagemaker#ProblemType": { + "type": "enum", + "members": { + "BINARY_CLASSIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BinaryClassification" + } + }, + "MULTICLASS_CLASSIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MulticlassClassification" + } + }, + "REGRESSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Regression" + } + } + } + }, + "com.amazonaws.sagemaker#ProcessingClusterConfig": { + "type": "structure", + "members": { + "InstanceCount": { + "target": "com.amazonaws.sagemaker#ProcessingInstanceCount", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of ML compute instances to use in the processing job. For distributed\n processing jobs, specify a value greater than 1. The default value is 1.

", + "smithy.api#required": {} + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#ProcessingInstanceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ML compute instance type for the processing job.

", + "smithy.api#required": {} + } + }, + "VolumeSizeInGB": { + "target": "com.amazonaws.sagemaker#ProcessingVolumeSizeInGB", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The size of the ML storage volume in gigabytes that you want to provision. You must\n specify sufficient ML storage for your scenario.

\n \n

Certain Nitro-based instances include local storage with a fixed total size,\n dependent on the instance type. When using these instances for processing, Amazon SageMaker mounts\n the local instance storage instead of Amazon EBS gp2 storage. You can't request a\n VolumeSizeInGB greater than the total size of the local instance\n storage.

\n

For a list of instance types that support local instance storage, including the\n total size per instance type, see Instance Store Volumes.

\n ", + "smithy.api#required": {} + } + }, + "VolumeKmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the\n storage volume attached to the ML compute instance(s) that run the processing job.\n

\n \n

Certain Nitro-based instances include local storage, dependent on the instance\n type. Local storage volumes are encrypted using a hardware module on the instance.\n You can't request a VolumeKmsKeyId when using an instance type with\n local storage.

\n

For a list of instance types that support local instance storage, see Instance Store Volumes.

\n

For more information about local instance storage encryption, see SSD\n Instance Store Volumes.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration for the cluster used to run a processing job.

" + } + }, + "com.amazonaws.sagemaker#ProcessingEnvironmentKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$" + } + }, + "com.amazonaws.sagemaker#ProcessingEnvironmentMap": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#ProcessingEnvironmentKey" + }, + "value": { + "target": "com.amazonaws.sagemaker#ProcessingEnvironmentValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#ProcessingEnvironmentValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[\\S\\s]*$" + } + }, + "com.amazonaws.sagemaker#ProcessingFeatureStoreOutput": { + "type": "structure", + "members": { + "FeatureGroupName": { + "target": "com.amazonaws.sagemaker#FeatureGroupName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Amazon SageMaker FeatureGroup to use as the destination for processing job output. Note that your \n processing script is responsible for putting records into your Feature Store.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration for processing job outputs in Amazon SageMaker Feature Store.

" + } + }, + "com.amazonaws.sagemaker#ProcessingInput": { + "type": "structure", + "members": { + "InputName": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name for the processing job input.

", + "smithy.api#required": {} + } + }, + "AppManaged": { + "target": "com.amazonaws.sagemaker#AppManaged", + "traits": { + "smithy.api#documentation": "

When True, input operations such as data download are managed natively by the\n processing job application. When False (default), input operations are managed by Amazon SageMaker.

" + } + }, + "S3Input": { + "target": "com.amazonaws.sagemaker#ProcessingS3Input", + "traits": { + "smithy.api#documentation": "

Configuration for downloading input data from Amazon S3 into the processing container.

" + } + }, + "DatasetDefinition": { + "target": "com.amazonaws.sagemaker#DatasetDefinition", + "traits": { + "smithy.api#documentation": "

Configuration for a Dataset Definition input.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The inputs for a processing job. The processing input must specify exactly one of either\n S3Input or DatasetDefinition types.

" + } + }, + "com.amazonaws.sagemaker#ProcessingInputs": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ProcessingInput" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.sagemaker#ProcessingInstanceCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#ProcessingInstanceType": { + "type": "enum", + "members": { + "ML_T3_MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.medium" + } + }, + "ML_T3_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.large" + } + }, + "ML_T3_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.xlarge" + } + }, + "ML_T3_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.2xlarge" + } + }, + "ML_M4_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.xlarge" + } + }, + "ML_M4_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.2xlarge" + } + }, + "ML_M4_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.4xlarge" + } + }, + "ML_M4_10XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.10xlarge" + } + }, + "ML_M4_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.16xlarge" + } + }, + "ML_C4_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.xlarge" + } + }, + "ML_C4_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.2xlarge" + } + }, + "ML_C4_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.4xlarge" + } + }, + "ML_C4_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.8xlarge" + } + }, + "ML_P2_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p2.xlarge" + } + }, + "ML_P2_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p2.8xlarge" + } + }, + "ML_P2_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p2.16xlarge" + } + }, + "ML_P3_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3.2xlarge" + } + }, + "ML_P3_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3.8xlarge" + } + }, + "ML_P3_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3.16xlarge" + } + }, + "ML_C5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.xlarge" + } + }, + "ML_C5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.2xlarge" + } + }, + "ML_C5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.4xlarge" + } + }, + "ML_C5_9XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.9xlarge" + } + }, + "ML_C5_18XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.18xlarge" + } + }, + "ML_M5_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.large" + } + }, + "ML_M5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.xlarge" + } + }, + "ML_M5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.2xlarge" + } + }, + "ML_M5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.4xlarge" + } + }, + "ML_M5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.12xlarge" + } + }, + "ML_M5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.24xlarge" + } + }, + "ML_R5_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.large" + } + }, + "ML_R5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.xlarge" + } + }, + "ML_R5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.2xlarge" + } + }, + "ML_R5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.4xlarge" + } + }, + "ML_R5_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.8xlarge" + } + }, + "ML_R5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.12xlarge" + } + }, + "ML_R5_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.16xlarge" + } + }, + "ML_R5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.24xlarge" + } + }, + "ML_G4DN_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.xlarge" + } + }, + "ML_G4DN_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.2xlarge" + } + }, + "ML_G4DN_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.4xlarge" + } + }, + "ML_G4DN_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.8xlarge" + } + }, + "ML_G4DN_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.12xlarge" + } + }, + "ML_G4DN_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.16xlarge" + } + }, + "ML_G5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.xlarge" + } + }, + "ML_G5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.2xlarge" + } + }, + "ML_G5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.4xlarge" + } + }, + "ML_G5_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.8xlarge" + } + }, + "ML_G5_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.16xlarge" + } + }, + "ML_G5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.12xlarge" + } + }, + "ML_G5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.24xlarge" + } + }, + "ML_G5_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.48xlarge" + } + }, + "ML_R5D_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5d.large" + } + }, + "ML_R5D_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5d.xlarge" + } + }, + "ML_R5D_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5d.2xlarge" + } + }, + "ML_R5D_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5d.4xlarge" + } + }, + "ML_R5D_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5d.8xlarge" + } + }, + "ML_R5D_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5d.12xlarge" + } + }, + "ML_R5D_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5d.16xlarge" + } + }, + "ML_R5D_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5d.24xlarge" + } + } + } + }, + "com.amazonaws.sagemaker#ProcessingJob": { + "type": "structure", + "members": { + "ProcessingInputs": { + "target": "com.amazonaws.sagemaker#ProcessingInputs", + "traits": { + "smithy.api#documentation": "

List of input configurations for the processing job.

" + } + }, + "ProcessingOutputConfig": { + "target": "com.amazonaws.sagemaker#ProcessingOutputConfig" + }, + "ProcessingJobName": { + "target": "com.amazonaws.sagemaker#ProcessingJobName", + "traits": { + "smithy.api#documentation": "

The name of the processing job.

" + } + }, + "ProcessingResources": { + "target": "com.amazonaws.sagemaker#ProcessingResources" + }, + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#ProcessingStoppingCondition" + }, + "AppSpecification": { + "target": "com.amazonaws.sagemaker#AppSpecification" + }, + "Environment": { + "target": "com.amazonaws.sagemaker#ProcessingEnvironmentMap", + "traits": { + "smithy.api#documentation": "

Sets the environment variables in the Docker container.

" + } + }, + "NetworkConfig": { + "target": "com.amazonaws.sagemaker#NetworkConfig" + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of the role used to create the processing job.

" + } + }, + "ExperimentConfig": { + "target": "com.amazonaws.sagemaker#ExperimentConfig" + }, + "ProcessingJobArn": { + "target": "com.amazonaws.sagemaker#ProcessingJobArn", + "traits": { + "smithy.api#documentation": "

The ARN of the processing job.

" + } + }, + "ProcessingJobStatus": { + "target": "com.amazonaws.sagemaker#ProcessingJobStatus", + "traits": { + "smithy.api#documentation": "

The status of the processing job.

" + } + }, + "ExitMessage": { + "target": "com.amazonaws.sagemaker#ExitMessage", + "traits": { + "smithy.api#documentation": "

A string, up to one KB in size, that contains metadata from the processing\n container when the processing job exits.

" + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "

A string, up to one KB in size, that contains the reason a processing job failed, if\n it failed.

" + } + }, + "ProcessingEndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the processing job ended.

" + } + }, + "ProcessingStartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the processing job started.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the processing job was last modified.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the processing job was created.

" + } + }, + "MonitoringScheduleArn": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleArn", + "traits": { + "smithy.api#documentation": "

The ARN of a monitoring schedule for an endpoint associated with this processing\n job.

" + } + }, + "AutoMLJobArn": { + "target": "com.amazonaws.sagemaker#AutoMLJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AutoML job associated with this processing job.

" + } + }, + "TrainingJobArn": { + "target": "com.amazonaws.sagemaker#TrainingJobArn", + "traits": { + "smithy.api#documentation": "

The ARN of the training job associated with this processing job.

" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management\n User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An Amazon SageMaker processing job that is used to analyze data and evaluate models. For more information,\n see Process\n Data and Evaluate Models.

" + } + }, + "com.amazonaws.sagemaker#ProcessingJobArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:processing-job/" + } + }, + "com.amazonaws.sagemaker#ProcessingJobName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#ProcessingJobStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + } + } + }, + "com.amazonaws.sagemaker#ProcessingJobStepMetadata": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#ProcessingJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the processing job.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Metadata for a processing job step.

" + } + }, + "com.amazonaws.sagemaker#ProcessingJobSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ProcessingJobSummary" + } + }, + "com.amazonaws.sagemaker#ProcessingJobSummary": { + "type": "structure", + "members": { + "ProcessingJobName": { + "target": "com.amazonaws.sagemaker#ProcessingJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the processing job.

", + "smithy.api#required": {} + } + }, + "ProcessingJobArn": { + "target": "com.amazonaws.sagemaker#ProcessingJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the processing job..

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The time at which the processing job was created.

", + "smithy.api#required": {} + } + }, + "ProcessingEndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the processing job completed.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A timestamp that indicates the last time the processing job was modified.

" + } + }, + "ProcessingJobStatus": { + "target": "com.amazonaws.sagemaker#ProcessingJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of the processing job.

", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "

A string, up to one KB in size, that contains the reason a processing job failed, if\n it failed.

" + } + }, + "ExitMessage": { + "target": "com.amazonaws.sagemaker#ExitMessage", + "traits": { + "smithy.api#documentation": "

An optional string, up to one KB in size, that contains metadata from the processing\n container when the processing job exits.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Summary of information about a processing job.

" + } + }, + "com.amazonaws.sagemaker#ProcessingLocalPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#ProcessingMaxRuntimeInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 777600 + } + } + }, + "com.amazonaws.sagemaker#ProcessingOutput": { + "type": "structure", + "members": { + "OutputName": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name for the processing job output.

", + "smithy.api#required": {} + } + }, + "S3Output": { + "target": "com.amazonaws.sagemaker#ProcessingS3Output", + "traits": { + "smithy.api#documentation": "

Configuration for processing job outputs in Amazon S3.

" + } + }, + "FeatureStoreOutput": { + "target": "com.amazonaws.sagemaker#ProcessingFeatureStoreOutput", + "traits": { + "smithy.api#documentation": "

Configuration for processing job outputs in Amazon SageMaker Feature Store. This processing output\n type is only supported when AppManaged is specified.

" + } + }, + "AppManaged": { + "target": "com.amazonaws.sagemaker#AppManaged", + "traits": { + "smithy.api#documentation": "

When True, output operations such as data upload are managed natively by the\n processing job application. When False (default), output operations are managed by\n Amazon SageMaker.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the results of a processing job. The processing output must specify exactly one of\n either S3Output or FeatureStoreOutput types.

" + } + }, + "com.amazonaws.sagemaker#ProcessingOutputConfig": { + "type": "structure", + "members": { + "Outputs": { + "target": "com.amazonaws.sagemaker#ProcessingOutputs", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An array of outputs configuring the data to upload from the processing container.

", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the processing\n job output. KmsKeyId can be an ID of a KMS key, ARN of a KMS key, alias of\n a KMS key, or alias of a KMS key. The KmsKeyId is applied to all\n outputs.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration for uploading output from the processing container.

" + } + }, + "com.amazonaws.sagemaker#ProcessingOutputs": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ProcessingOutput" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.sagemaker#ProcessingResources": { + "type": "structure", + "members": { + "ClusterConfig": { + "target": "com.amazonaws.sagemaker#ProcessingClusterConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The configuration for the resources in a cluster used to run the processing\n job.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Identifies the resources, ML compute instances, and ML storage volumes to deploy for a\n processing job. In distributed training, you specify more than one instance.

" + } + }, + "com.amazonaws.sagemaker#ProcessingS3CompressionType": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "None" + } + }, + "GZIP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Gzip" + } + } + } + }, + "com.amazonaws.sagemaker#ProcessingS3DataDistributionType": { + "type": "enum", + "members": { + "FULLYREPLICATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FullyReplicated" + } + }, + "SHARDEDBYS3KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ShardedByS3Key" + } + } + } + }, + "com.amazonaws.sagemaker#ProcessingS3DataType": { + "type": "enum", + "members": { + "MANIFEST_FILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ManifestFile" + } + }, + "S3_PREFIX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3Prefix" + } + } + } + }, + "com.amazonaws.sagemaker#ProcessingS3Input": { + "type": "structure", + "members": { + "S3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The URI of the Amazon S3 prefix Amazon SageMaker downloads data required to run a processing job.

", + "smithy.api#required": {} + } + }, + "LocalPath": { + "target": "com.amazonaws.sagemaker#ProcessingLocalPath", + "traits": { + "smithy.api#documentation": "

The local path in your container where you want Amazon SageMaker to write input data to. \n LocalPath is an absolute path to the input data and must begin with \n /opt/ml/processing/. LocalPath is a required \n parameter when AppManaged is False (default).

" + } + }, + "S3DataType": { + "target": "com.amazonaws.sagemaker#ProcessingS3DataType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Whether you use an S3Prefix or a ManifestFile for\n the data type. If you choose S3Prefix, S3Uri identifies a key\n name prefix. Amazon SageMaker uses all objects with the specified key name prefix for the processing\n job. If you choose ManifestFile, S3Uri identifies an object\n that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for\n the processing job.

", + "smithy.api#required": {} + } + }, + "S3InputMode": { + "target": "com.amazonaws.sagemaker#ProcessingS3InputMode", + "traits": { + "smithy.api#documentation": "

Whether to use File or Pipe input mode. In File mode, Amazon SageMaker copies the data \n from the input source onto the local ML storage volume before starting your processing \n container. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker \n streams input data from the source directly to your processing container into named \n pipes without using the ML storage volume.

" + } + }, + "S3DataDistributionType": { + "target": "com.amazonaws.sagemaker#ProcessingS3DataDistributionType", + "traits": { + "smithy.api#documentation": "

Whether to distribute the data from Amazon S3 to all processing instances with \n FullyReplicated, or whether the data from Amazon S3 is shared by Amazon S3 key, \n downloading one shard of data to each processing instance.

" + } + }, + "S3CompressionType": { + "target": "com.amazonaws.sagemaker#ProcessingS3CompressionType", + "traits": { + "smithy.api#documentation": "

Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing \n container. Gzip can only be used when Pipe mode is \n specified as the S3InputMode. In Pipe mode, Amazon SageMaker streams input \n data from the source directly to your container without using the EBS volume.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration for downloading input data from Amazon S3 into the processing container.

" + } + }, + "com.amazonaws.sagemaker#ProcessingS3InputMode": { + "type": "enum", + "members": { + "PIPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pipe" + } + }, + "FILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "File" + } + } + } + }, + "com.amazonaws.sagemaker#ProcessingS3Output": { + "type": "structure", + "members": { + "S3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A URI that identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of\n a processing job.

", + "smithy.api#required": {} + } + }, + "LocalPath": { + "target": "com.amazonaws.sagemaker#ProcessingLocalPath", + "traits": { + "smithy.api#documentation": "

The local path of a directory where you want Amazon SageMaker to upload its contents to Amazon S3. \n LocalPath is an absolute path to a directory containing output files. \n This directory will be created by the platform and exist when your container's \n entrypoint is invoked.

" + } + }, + "S3UploadMode": { + "target": "com.amazonaws.sagemaker#ProcessingS3UploadMode", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Whether to upload the results of the processing job continuously or after the job\n completes.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration for uploading output data to Amazon S3 from the processing container.

" + } + }, + "com.amazonaws.sagemaker#ProcessingS3UploadMode": { + "type": "enum", + "members": { + "CONTINUOUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Continuous" + } + }, + "END_OF_JOB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EndOfJob" + } + } + } + }, + "com.amazonaws.sagemaker#ProcessingStoppingCondition": { + "type": "structure", + "members": { + "MaxRuntimeInSeconds": { + "target": "com.amazonaws.sagemaker#ProcessingMaxRuntimeInSeconds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies the maximum runtime in seconds.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Configures conditions under which the processing job should be stopped, such as how long \n the processing job has been running. After the condition is met, the processing job is stopped.

" + } + }, + "com.amazonaws.sagemaker#ProcessingVolumeSizeInGB": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 16384 + } + } + }, + "com.amazonaws.sagemaker#Processor": { + "type": "enum", + "members": { + "CPU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CPU" + } + }, + "GPU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GPU" + } + } + } + }, + "com.amazonaws.sagemaker#ProductId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + } + }, + "com.amazonaws.sagemaker#ProductListings": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#String" + } + }, + "com.amazonaws.sagemaker#ProductionVariant": { + "type": "structure", + "members": { + "VariantName": { + "target": "com.amazonaws.sagemaker#VariantName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the production variant.

", + "smithy.api#required": {} + } + }, + "ModelName": { + "target": "com.amazonaws.sagemaker#ModelName", + "traits": { + "smithy.api#documentation": "

The name of the model that you want to host. This is the name that you specified\n when creating the model.

" + } + }, + "InitialInstanceCount": { + "target": "com.amazonaws.sagemaker#InitialTaskCount", + "traits": { + "smithy.api#documentation": "

Number of instances to launch initially.

" + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#ProductionVariantInstanceType", + "traits": { + "smithy.api#documentation": "

The ML compute instance type.

" + } + }, + "InitialVariantWeight": { + "target": "com.amazonaws.sagemaker#VariantWeight", + "traits": { + "smithy.api#documentation": "

Determines initial traffic distribution among all of the models that you specify in\n the endpoint configuration. The traffic to a production variant is determined by the\n ratio of the VariantWeight to the sum of all VariantWeight\n values across all ProductionVariants. If unspecified, it defaults to 1.0.\n

" + } + }, + "AcceleratorType": { + "target": "com.amazonaws.sagemaker#ProductionVariantAcceleratorType", + "traits": { + "smithy.api#documentation": "

This parameter is no longer supported. Elastic Inference (EI) is no longer\n available.

\n

This parameter was used to specify the size of the EI instance to use for the\n production variant.

" + } + }, + "CoreDumpConfig": { + "target": "com.amazonaws.sagemaker#ProductionVariantCoreDumpConfig", + "traits": { + "smithy.api#documentation": "

Specifies configuration for a core dump from the model container when the process\n crashes.

" + } + }, + "ServerlessConfig": { + "target": "com.amazonaws.sagemaker#ProductionVariantServerlessConfig", + "traits": { + "smithy.api#documentation": "

The serverless configuration for an endpoint. Specifies a serverless endpoint configuration instead of an instance-based endpoint configuration.

" + } + }, + "VolumeSizeInGB": { + "target": "com.amazonaws.sagemaker#ProductionVariantVolumeSizeInGB", + "traits": { + "smithy.api#documentation": "

The size, in GB, of the ML storage volume attached to individual inference instance\n associated with the production variant. Currently only Amazon EBS gp2 storage volumes are\n supported.

" + } + }, + "ModelDataDownloadTimeoutInSeconds": { + "target": "com.amazonaws.sagemaker#ProductionVariantModelDataDownloadTimeoutInSeconds", + "traits": { + "smithy.api#documentation": "

The timeout value, in seconds, to download and extract the model that you want to host\n from Amazon S3 to the individual inference instance associated with this production\n variant.

" + } + }, + "ContainerStartupHealthCheckTimeoutInSeconds": { + "target": "com.amazonaws.sagemaker#ProductionVariantContainerStartupHealthCheckTimeoutInSeconds", + "traits": { + "smithy.api#documentation": "

The timeout value, in seconds, for your inference container to pass health check by\n SageMaker Hosting. For more information about health check, see How Your Container Should Respond to Health Check (Ping) Requests.

" + } + }, + "EnableSSMAccess": { + "target": "com.amazonaws.sagemaker#ProductionVariantSSMAccess", + "traits": { + "smithy.api#documentation": "

You can use this parameter to turn on native Amazon Web Services Systems Manager (SSM)\n access for a production variant behind an endpoint. By default, SSM access is disabled\n for all production variants behind an endpoint. You can turn on or turn off SSM access\n for a production variant behind an existing endpoint by creating a new endpoint\n configuration and calling UpdateEndpoint.

" + } + }, + "ManagedInstanceScaling": { + "target": "com.amazonaws.sagemaker#ProductionVariantManagedInstanceScaling", + "traits": { + "smithy.api#documentation": "

Settings that control the range in the number of instances that the endpoint provisions\n as it scales up or down to accommodate traffic.

" + } + }, + "RoutingConfig": { + "target": "com.amazonaws.sagemaker#ProductionVariantRoutingConfig", + "traits": { + "smithy.api#documentation": "

Settings that control how the endpoint routes incoming traffic to the instances that the\n endpoint hosts.

" + } + }, + "InferenceAmiVersion": { + "target": "com.amazonaws.sagemaker#ProductionVariantInferenceAmiVersion", + "traits": { + "smithy.api#documentation": "

Specifies an option from a collection of preconfigured Amazon Machine Image (AMI)\n images. Each image is configured by Amazon Web Services with a set of software and driver\n versions. Amazon Web Services optimizes these configurations for different machine\n learning workloads.

\n

By selecting an AMI version, you can ensure that your inference environment is\n compatible with specific software requirements, such as CUDA driver versions, Linux\n kernel versions, or Amazon Web Services Neuron driver versions.

\n

The AMI version names, and their configurations, are the following:

\n
\n
al2-ami-sagemaker-inference-gpu-2
\n
\n
    \n
  • \n

    Accelerator: GPU

    \n
    • \n
  • \n

    NVIDIA driver version: 535.54.03

    \n
    • \n
  • \n

    CUDA driver version: 12.2

    \n
    • \n
  • \n

    Supported instance types: ml.g4dn.*, ml.g5.*, ml.g6.*, ml.p3.*,\n ml.p4d.*, ml.p4de.*, ml.p5.*

    \n
    • \n
\n
\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

Identifies a model that you want to host and the resources chosen to deploy for\n hosting it. If you are deploying multiple models, tell SageMaker how to distribute traffic\n among the models by specifying variant weights. For more information on production\n variants, check Production variants.\n

" + } + }, + "com.amazonaws.sagemaker#ProductionVariantAcceleratorType": { + "type": "enum", + "members": { + "ML_EIA1_MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.eia1.medium" + } + }, + "ML_EIA1_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.eia1.large" + } + }, + "ML_EIA1_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.eia1.xlarge" + } + }, + "ML_EIA2_MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.eia2.medium" + } + }, + "ML_EIA2_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.eia2.large" + } + }, + "ML_EIA2_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.eia2.xlarge" + } + } + } + }, + "com.amazonaws.sagemaker#ProductionVariantContainerStartupHealthCheckTimeoutInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 60, + "max": 3600 + } + } + }, + "com.amazonaws.sagemaker#ProductionVariantCoreDumpConfig": { + "type": "structure", + "members": { + "DestinationS3Uri": { + "target": "com.amazonaws.sagemaker#DestinationS3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon S3 bucket to send the core dump to.

", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker\n uses to encrypt the core dump data at rest using Amazon S3 server-side encryption. The\n KmsKeyId can be any of the following formats:

\n
    \n
  • \n

    // KMS Key ID

    \n

    \n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    // Amazon Resource Name (ARN) of a KMS Key

    \n

    \n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    // KMS Key Alias

    \n

    \n \"alias/ExampleAlias\"\n

    \n
    • \n
  • \n

    // Amazon Resource Name (ARN) of a KMS Key Alias

    \n

    \n \"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"\n

    \n
    • \n
\n

If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must\n include permissions to call kms:Encrypt. If you don't provide a KMS key ID,\n SageMaker uses the default KMS key for Amazon S3 for your role's account. SageMaker uses server-side\n encryption with KMS-managed keys for OutputDataConfig. If you use a bucket\n policy with an s3:PutObject permission that only allows objects with\n server-side encryption, set the condition key of\n s3:x-amz-server-side-encryption to \"aws:kms\". For more\n information, see KMS-Managed Encryption\n Keys in the Amazon Simple Storage Service Developer Guide.\n

\n

The KMS key policy must grant permission to the IAM role that you specify in your\n CreateEndpoint and UpdateEndpoint requests. For more\n information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management\n Service Developer Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies configuration for a core dump from the model container when the process\n crashes.

" + } + }, + "com.amazonaws.sagemaker#ProductionVariantInferenceAmiVersion": { + "type": "enum", + "members": { + "AL2_GPU_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "al2-ami-sagemaker-inference-gpu-2" + } + } + } + }, + "com.amazonaws.sagemaker#ProductionVariantInstanceType": { + "type": "enum", + "members": { + "ML_T2_MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t2.medium" + } + }, + "ML_T2_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t2.large" + } + }, + "ML_T2_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t2.xlarge" + } + }, + "ML_T2_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t2.2xlarge" + } + }, + "ML_M4_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.xlarge" + } + }, + "ML_M4_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.2xlarge" + } + }, + "ML_M4_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.4xlarge" + } + }, + "ML_M4_10XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.10xlarge" + } + }, + "ML_M4_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.16xlarge" + } + }, + "ML_M5_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.large" + } + }, + "ML_M5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.xlarge" + } + }, + "ML_M5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.2xlarge" + } + }, + "ML_M5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.4xlarge" + } + }, + "ML_M5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.12xlarge" + } + }, + "ML_M5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.24xlarge" + } + }, + "ML_M5D_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.large" + } + }, + "ML_M5D_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.xlarge" + } + }, + "ML_M5D_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.2xlarge" + } + }, + "ML_M5D_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.4xlarge" + } + }, + "ML_M5D_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.12xlarge" + } + }, + "ML_M5D_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.24xlarge" + } + }, + "ML_C4_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.large" + } + }, + "ML_C4_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.xlarge" + } + }, + "ML_C4_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.2xlarge" + } + }, + "ML_C4_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.4xlarge" + } + }, + "ML_C4_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.8xlarge" + } + }, + "ML_P2_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p2.xlarge" + } + }, + "ML_P2_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p2.8xlarge" + } + }, + "ML_P2_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p2.16xlarge" + } + }, + "ML_P3_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3.2xlarge" + } + }, + "ML_P3_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3.8xlarge" + } + }, + "ML_P3_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3.16xlarge" + } + }, + "ML_C5_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.large" + } + }, + "ML_C5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.xlarge" + } + }, + "ML_C5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.2xlarge" + } + }, + "ML_C5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.4xlarge" + } + }, + "ML_C5_9XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.9xlarge" + } + }, + "ML_C5_18XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.18xlarge" + } + }, + "ML_C5D_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5d.large" + } + }, + "ML_C5D_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5d.xlarge" + } + }, + "ML_C5D_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5d.2xlarge" + } + }, + "ML_C5D_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5d.4xlarge" + } + }, + "ML_C5D_9XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5d.9xlarge" + } + }, + "ML_C5D_18XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5d.18xlarge" + } + }, + "ML_G4DN_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.xlarge" + } + }, + "ML_G4DN_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.2xlarge" + } + }, + "ML_G4DN_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.4xlarge" + } + }, + "ML_G4DN_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.8xlarge" + } + }, + "ML_G4DN_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.12xlarge" + } + }, + "ML_G4DN_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.16xlarge" + } + }, + "ML_R5_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.large" + } + }, + "ML_R5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.xlarge" + } + }, + "ML_R5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.2xlarge" + } + }, + "ML_R5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.4xlarge" + } + }, + "ML_R5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.12xlarge" + } + }, + "ML_R5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.24xlarge" + } + }, + "ML_R5D_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5d.large" + } + }, + "ML_R5D_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5d.xlarge" + } + }, + "ML_R5D_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5d.2xlarge" + } + }, + "ML_R5D_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5d.4xlarge" + } + }, + "ML_R5D_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5d.12xlarge" + } + }, + "ML_R5D_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5d.24xlarge" + } + }, + "ML_INF1_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf1.xlarge" + } + }, + "ML_INF1_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf1.2xlarge" + } + }, + "ML_INF1_6XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf1.6xlarge" + } + }, + "ML_INF1_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf1.24xlarge" + } + }, + "ML_DL1_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.dl1.24xlarge" + } + }, + "ML_C6I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.large" + } + }, + "ML_C6I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.xlarge" + } + }, + "ML_C6I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.2xlarge" + } + }, + "ML_C6I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.4xlarge" + } + }, + "ML_C6I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.8xlarge" + } + }, + "ML_C6I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.12xlarge" + } + }, + "ML_C6I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.16xlarge" + } + }, + "ML_C6I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.24xlarge" + } + }, + "ML_C6I_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.32xlarge" + } + }, + "ML_M6I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.large" + } + }, + "ML_M6I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.xlarge" + } + }, + "ML_M6I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.2xlarge" + } + }, + "ML_M6I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.4xlarge" + } + }, + "ML_M6I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.8xlarge" + } + }, + "ML_M6I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.12xlarge" + } + }, + "ML_M6I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.16xlarge" + } + }, + "ML_M6I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.24xlarge" + } + }, + "ML_M6I_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.32xlarge" + } + }, + "ML_R6I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.large" + } + }, + "ML_R6I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.xlarge" + } + }, + "ML_R6I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.2xlarge" + } + }, + "ML_R6I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.4xlarge" + } + }, + "ML_R6I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.8xlarge" + } + }, + "ML_R6I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.12xlarge" + } + }, + "ML_R6I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.16xlarge" + } + }, + "ML_R6I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.24xlarge" + } + }, + "ML_R6I_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.32xlarge" + } + }, + "ML_G5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.xlarge" + } + }, + "ML_G5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.2xlarge" + } + }, + "ML_G5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.4xlarge" + } + }, + "ML_G5_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.8xlarge" + } + }, + "ML_G5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.12xlarge" + } + }, + "ML_G5_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.16xlarge" + } + }, + "ML_G5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.24xlarge" + } + }, + "ML_G5_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.48xlarge" + } + }, + "ML_G6_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.xlarge" + } + }, + "ML_G6_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.2xlarge" + } + }, + "ML_G6_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.4xlarge" + } + }, + "ML_G6_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.8xlarge" + } + }, + "ML_G6_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.12xlarge" + } + }, + "ML_G6_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.16xlarge" + } + }, + "ML_G6_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.24xlarge" + } + }, + "ML_G6_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.48xlarge" + } + }, + "ML_G6E_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.xlarge" + } + }, + "ML_G6E_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.2xlarge" + } + }, + "ML_G6E_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.4xlarge" + } + }, + "ML_G6E_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.8xlarge" + } + }, + "ML_G6E_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.12xlarge" + } + }, + "ML_G6E_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.16xlarge" + } + }, + "ML_G6E_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.24xlarge" + } + }, + "ML_G6E_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.48xlarge" + } + }, + "ML_P4D_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p4d.24xlarge" + } + }, + "ML_C7G_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7g.large" + } + }, + "ML_C7G_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7g.xlarge" + } + }, + "ML_C7G_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7g.2xlarge" + } + }, + "ML_C7G_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7g.4xlarge" + } + }, + "ML_C7G_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7g.8xlarge" + } + }, + "ML_C7G_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7g.12xlarge" + } + }, + "ML_C7G_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7g.16xlarge" + } + }, + "ML_M6G_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6g.large" + } + }, + "ML_M6G_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6g.xlarge" + } + }, + "ML_M6G_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6g.2xlarge" + } + }, + "ML_M6G_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6g.4xlarge" + } + }, + "ML_M6G_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6g.8xlarge" + } + }, + "ML_M6G_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6g.12xlarge" + } + }, + "ML_M6G_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6g.16xlarge" + } + }, + "ML_M6GD_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6gd.large" + } + }, + "ML_M6GD_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6gd.xlarge" + } + }, + "ML_M6GD_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6gd.2xlarge" + } + }, + "ML_M6GD_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6gd.4xlarge" + } + }, + "ML_M6GD_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6gd.8xlarge" + } + }, + "ML_M6GD_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6gd.12xlarge" + } + }, + "ML_M6GD_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6gd.16xlarge" + } + }, + "ML_C6G_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6g.large" + } + }, + "ML_C6G_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6g.xlarge" + } + }, + "ML_C6G_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6g.2xlarge" + } + }, + "ML_C6G_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6g.4xlarge" + } + }, + "ML_C6G_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6g.8xlarge" + } + }, + "ML_C6G_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6g.12xlarge" + } + }, + "ML_C6G_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6g.16xlarge" + } + }, + "ML_C6GD_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6gd.large" + } + }, + "ML_C6GD_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6gd.xlarge" + } + }, + "ML_C6GD_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6gd.2xlarge" + } + }, + "ML_C6GD_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6gd.4xlarge" + } + }, + "ML_C6GD_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6gd.8xlarge" + } + }, + "ML_C6GD_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6gd.12xlarge" + } + }, + "ML_C6GD_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6gd.16xlarge" + } + }, + "ML_C6GN_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6gn.large" + } + }, + "ML_C6GN_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6gn.xlarge" + } + }, + "ML_C6GN_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6gn.2xlarge" + } + }, + "ML_C6GN_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6gn.4xlarge" + } + }, + "ML_C6GN_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6gn.8xlarge" + } + }, + "ML_C6GN_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6gn.12xlarge" + } + }, + "ML_C6GN_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6gn.16xlarge" + } + }, + "ML_R6G_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6g.large" + } + }, + "ML_R6G_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6g.xlarge" + } + }, + "ML_R6G_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6g.2xlarge" + } + }, + "ML_R6G_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6g.4xlarge" + } + }, + "ML_R6G_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6g.8xlarge" + } + }, + "ML_R6G_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6g.12xlarge" + } + }, + "ML_R6G_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6g.16xlarge" + } + }, + "ML_R6GD_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6gd.large" + } + }, + "ML_R6GD_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6gd.xlarge" + } + }, + "ML_R6GD_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6gd.2xlarge" + } + }, + "ML_R6GD_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6gd.4xlarge" + } + }, + "ML_R6GD_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6gd.8xlarge" + } + }, + "ML_R6GD_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6gd.12xlarge" + } + }, + "ML_R6GD_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6gd.16xlarge" + } + }, + "ML_P4DE_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p4de.24xlarge" + } + }, + "ML_TRN1_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1.2xlarge" + } + }, + "ML_TRN1_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1.32xlarge" + } + }, + "ML_TRN1N_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1n.32xlarge" + } + }, + "ML_TRN2_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn2.48xlarge" + } + }, + "ML_INF2_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf2.xlarge" + } + }, + "ML_INF2_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf2.8xlarge" + } + }, + "ML_INF2_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf2.24xlarge" + } + }, + "ML_INF2_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf2.48xlarge" + } + }, + "ML_P5_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p5.48xlarge" + } + }, + "ML_P5E_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p5e.48xlarge" + } + }, + "ML_M7I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.large" + } + }, + "ML_M7I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.xlarge" + } + }, + "ML_M7I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.2xlarge" + } + }, + "ML_M7I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.4xlarge" + } + }, + "ML_M7I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.8xlarge" + } + }, + "ML_M7I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.12xlarge" + } + }, + "ML_M7I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.16xlarge" + } + }, + "ML_M7I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.24xlarge" + } + }, + "ML_M7I_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.48xlarge" + } + }, + "ML_C7I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.large" + } + }, + "ML_C7I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.xlarge" + } + }, + "ML_C7I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.2xlarge" + } + }, + "ML_C7I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.4xlarge" + } + }, + "ML_C7I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.8xlarge" + } + }, + "ML_C7I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.12xlarge" + } + }, + "ML_C7I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.16xlarge" + } + }, + "ML_C7I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.24xlarge" + } + }, + "ML_C7I_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.48xlarge" + } + }, + "ML_R7I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.large" + } + }, + "ML_R7I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.xlarge" + } + }, + "ML_R7I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.2xlarge" + } + }, + "ML_R7I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.4xlarge" + } + }, + "ML_R7I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.8xlarge" + } + }, + "ML_R7I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.12xlarge" + } + }, + "ML_R7I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.16xlarge" + } + }, + "ML_R7I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.24xlarge" + } + }, + "ML_R7I_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.48xlarge" + } + } + } + }, + "com.amazonaws.sagemaker#ProductionVariantList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ProductionVariant" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.sagemaker#ProductionVariantManagedInstanceScaling": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.sagemaker#ManagedInstanceScalingStatus", + "traits": { + "smithy.api#documentation": "

Indicates whether managed instance scaling is enabled.

" + } + }, + "MinInstanceCount": { + "target": "com.amazonaws.sagemaker#ManagedInstanceScalingMinInstanceCount", + "traits": { + "smithy.api#documentation": "

The minimum number of instances that the endpoint must retain when it scales down to\n accommodate a decrease in traffic.

" + } + }, + "MaxInstanceCount": { + "target": "com.amazonaws.sagemaker#ManagedInstanceScalingMaxInstanceCount", + "traits": { + "smithy.api#documentation": "

The maximum number of instances that the endpoint can provision when it scales up to\n accommodate an increase in traffic.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Settings that control the range in the number of instances that the endpoint provisions\n as it scales up or down to accommodate traffic.

" + } + }, + "com.amazonaws.sagemaker#ProductionVariantModelDataDownloadTimeoutInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 60, + "max": 3600 + } + } + }, + "com.amazonaws.sagemaker#ProductionVariantRoutingConfig": { + "type": "structure", + "members": { + "RoutingStrategy": { + "target": "com.amazonaws.sagemaker#RoutingStrategy", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Sets how the endpoint routes incoming traffic:

\n
    \n
  • \n

    \n LEAST_OUTSTANDING_REQUESTS: The endpoint routes requests to the\n specific instances that have more capacity to process them.

    \n
    • \n
  • \n

    \n RANDOM: The endpoint routes each request to a randomly chosen\n instance.

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Settings that control how the endpoint routes incoming traffic to the instances that the\n endpoint hosts.

" + } + }, + "com.amazonaws.sagemaker#ProductionVariantSSMAccess": { + "type": "boolean" + }, + "com.amazonaws.sagemaker#ProductionVariantServerlessConfig": { + "type": "structure", + "members": { + "MemorySizeInMB": { + "target": "com.amazonaws.sagemaker#ServerlessMemorySizeInMB", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The memory size of your serverless endpoint. Valid values are in 1 GB increments: 1024 MB, 2048 MB, 3072 MB, 4096 MB, 5120 MB, or 6144 MB.

", + "smithy.api#required": {} + } + }, + "MaxConcurrency": { + "target": "com.amazonaws.sagemaker#ServerlessMaxConcurrency", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The maximum number of concurrent invocations your serverless endpoint can process.

", + "smithy.api#required": {} + } + }, + "ProvisionedConcurrency": { + "target": "com.amazonaws.sagemaker#ServerlessProvisionedConcurrency", + "traits": { + "smithy.api#documentation": "

The amount of provisioned concurrency to allocate for the serverless endpoint.\n Should be less than or equal to MaxConcurrency.

\n \n

This field is not supported for serverless endpoint recommendations for Inference Recommender jobs.\n For more information about creating an Inference Recommender job, see\n CreateInferenceRecommendationsJobs.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the serverless configuration for an endpoint variant.

" + } + }, + "com.amazonaws.sagemaker#ProductionVariantServerlessUpdateConfig": { + "type": "structure", + "members": { + "MaxConcurrency": { + "target": "com.amazonaws.sagemaker#ServerlessMaxConcurrency", + "traits": { + "smithy.api#documentation": "

The updated maximum number of concurrent invocations your serverless endpoint can process.

" + } + }, + "ProvisionedConcurrency": { + "target": "com.amazonaws.sagemaker#ServerlessProvisionedConcurrency", + "traits": { + "smithy.api#documentation": "

The updated amount of provisioned concurrency to allocate for the serverless endpoint.\n Should be less than or equal to MaxConcurrency.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the serverless update concurrency configuration for an endpoint variant.

" + } + }, + "com.amazonaws.sagemaker#ProductionVariantStatus": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.sagemaker#VariantStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The endpoint variant status which describes the current deployment stage status or\n operational status.

\n
    \n
  • \n

    \n Creating: Creating inference resources for the production\n variant.

    \n
    • \n
  • \n

    \n Deleting: Terminating inference resources for the production\n variant.

    \n
    • \n
  • \n

    \n Updating: Updating capacity for the production variant.

    \n
    • \n
  • \n

    \n ActivatingTraffic: Turning on traffic for the production\n variant.

    \n
    • \n
  • \n

    \n Baking: Waiting period to monitor the CloudWatch alarms in the\n automatic rollback configuration.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "StatusMessage": { + "target": "com.amazonaws.sagemaker#VariantStatusMessage", + "traits": { + "smithy.api#documentation": "

A message that describes the status of the production variant.

" + } + }, + "StartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The start time of the current status change.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the status of the production variant.

" + } + }, + "com.amazonaws.sagemaker#ProductionVariantStatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ProductionVariantStatus" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#ProductionVariantSummary": { + "type": "structure", + "members": { + "VariantName": { + "target": "com.amazonaws.sagemaker#VariantName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the variant.

", + "smithy.api#required": {} + } + }, + "DeployedImages": { + "target": "com.amazonaws.sagemaker#DeployedImages", + "traits": { + "smithy.api#documentation": "

An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the\n inference images deployed on instances of this ProductionVariant.

" + } + }, + "CurrentWeight": { + "target": "com.amazonaws.sagemaker#VariantWeight", + "traits": { + "smithy.api#documentation": "

The weight associated with the variant.

" + } + }, + "DesiredWeight": { + "target": "com.amazonaws.sagemaker#VariantWeight", + "traits": { + "smithy.api#documentation": "

The requested weight, as specified in the\n UpdateEndpointWeightsAndCapacities request.

" + } + }, + "CurrentInstanceCount": { + "target": "com.amazonaws.sagemaker#TaskCount", + "traits": { + "smithy.api#documentation": "

The number of instances associated with the variant.

" + } + }, + "DesiredInstanceCount": { + "target": "com.amazonaws.sagemaker#TaskCount", + "traits": { + "smithy.api#documentation": "

The number of instances requested in the\n UpdateEndpointWeightsAndCapacities request.

" + } + }, + "VariantStatus": { + "target": "com.amazonaws.sagemaker#ProductionVariantStatusList", + "traits": { + "smithy.api#documentation": "

The endpoint variant status which describes the current deployment stage status or\n operational status.

" + } + }, + "CurrentServerlessConfig": { + "target": "com.amazonaws.sagemaker#ProductionVariantServerlessConfig", + "traits": { + "smithy.api#documentation": "

The serverless configuration for the endpoint.

" + } + }, + "DesiredServerlessConfig": { + "target": "com.amazonaws.sagemaker#ProductionVariantServerlessConfig", + "traits": { + "smithy.api#documentation": "

The serverless configuration requested for the endpoint update.

" + } + }, + "ManagedInstanceScaling": { + "target": "com.amazonaws.sagemaker#ProductionVariantManagedInstanceScaling", + "traits": { + "smithy.api#documentation": "

Settings that control the range in the number of instances that the endpoint provisions\n as it scales up or down to accommodate traffic.

" + } + }, + "RoutingConfig": { + "target": "com.amazonaws.sagemaker#ProductionVariantRoutingConfig", + "traits": { + "smithy.api#documentation": "

Settings that control how the endpoint routes incoming traffic to the instances that the\n endpoint hosts.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes weight and capacities for a production variant associated with an\n endpoint. If you sent a request to the UpdateEndpointWeightsAndCapacities\n API and the endpoint status is Updating, you get different desired and\n current values.

" + } + }, + "com.amazonaws.sagemaker#ProductionVariantSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ProductionVariantSummary" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#ProductionVariantVolumeSizeInGB": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.sagemaker#ProfilerConfig": { + "type": "structure", + "members": { + "S3OutputPath": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "

Path to Amazon S3 storage location for system and framework metrics.

" + } + }, + "ProfilingIntervalInMilliseconds": { + "target": "com.amazonaws.sagemaker#ProfilingIntervalInMilliseconds", + "traits": { + "smithy.api#documentation": "

A time interval for capturing system metrics in milliseconds. Available values are\n 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.

" + } + }, + "ProfilingParameters": { + "target": "com.amazonaws.sagemaker#ProfilingParameters", + "traits": { + "smithy.api#documentation": "

Configuration information for capturing framework metrics. Available key strings for different profiling options are\n DetailedProfilingConfig, PythonProfilingConfig, and DataLoaderProfilingConfig.\n The following codes are configuration structures for the ProfilingParameters parameter. To learn more about\n how to configure the ProfilingParameters parameter, \n see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.\n

" + } + }, + "DisableProfiler": { + "target": "com.amazonaws.sagemaker#DisableProfiler", + "traits": { + "smithy.api#documentation": "

Configuration to turn off Amazon SageMaker Debugger's system monitoring and profiling functionality. To turn it off, set to True.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and\n storage paths.

" + } + }, + "com.amazonaws.sagemaker#ProfilerConfigForUpdate": { + "type": "structure", + "members": { + "S3OutputPath": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "

Path to Amazon S3 storage location for system and framework metrics.

" + } + }, + "ProfilingIntervalInMilliseconds": { + "target": "com.amazonaws.sagemaker#ProfilingIntervalInMilliseconds", + "traits": { + "smithy.api#documentation": "

A time interval for capturing system metrics in milliseconds. Available values are\n 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.

" + } + }, + "ProfilingParameters": { + "target": "com.amazonaws.sagemaker#ProfilingParameters", + "traits": { + "smithy.api#documentation": "

Configuration information for capturing framework metrics. Available key strings for different profiling options are\n DetailedProfilingConfig, PythonProfilingConfig, and DataLoaderProfilingConfig.\n The following codes are configuration structures for the ProfilingParameters parameter. To learn more about\n how to configure the ProfilingParameters parameter, \n see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.\n

" + } + }, + "DisableProfiler": { + "target": "com.amazonaws.sagemaker#DisableProfiler", + "traits": { + "smithy.api#documentation": "

To turn off Amazon SageMaker Debugger monitoring and profiling while a training job is in progress, set to True.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration information for updating the Amazon SageMaker Debugger profile parameters, system and framework metrics configurations, and\n storage paths.

" + } + }, + "com.amazonaws.sagemaker#ProfilerRuleConfiguration": { + "type": "structure", + "members": { + "RuleConfigurationName": { + "target": "com.amazonaws.sagemaker#RuleConfigurationName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the rule configuration. It must be unique relative to other rule configuration names.

", + "smithy.api#required": {} + } + }, + "LocalPath": { + "target": "com.amazonaws.sagemaker#DirectoryPath", + "traits": { + "smithy.api#documentation": "

Path to local storage location for output of rules. Defaults to /opt/ml/processing/output/rule/.

" + } + }, + "S3OutputPath": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "

Path to Amazon S3 storage location for rules.

" + } + }, + "RuleEvaluatorImage": { + "target": "com.amazonaws.sagemaker#AlgorithmImage", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Elastic Container Registry Image for the managed rule evaluation.

", + "smithy.api#required": {} + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#ProcessingInstanceType", + "traits": { + "smithy.api#documentation": "

The instance type to deploy a custom rule for profiling a training job.

" + } + }, + "VolumeSizeInGB": { + "target": "com.amazonaws.sagemaker#OptionalVolumeSizeInGB", + "traits": { + "smithy.api#documentation": "

The size, in GB, of the ML storage volume attached to the processing instance.

" + } + }, + "RuleParameters": { + "target": "com.amazonaws.sagemaker#RuleParameters", + "traits": { + "smithy.api#documentation": "

Runtime configuration for rule container.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration information for profiling rules.

" + } + }, + "com.amazonaws.sagemaker#ProfilerRuleConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ProfilerRuleConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.sagemaker#ProfilerRuleEvaluationStatus": { + "type": "structure", + "members": { + "RuleConfigurationName": { + "target": "com.amazonaws.sagemaker#RuleConfigurationName", + "traits": { + "smithy.api#documentation": "

The name of the rule configuration.

" + } + }, + "RuleEvaluationJobArn": { + "target": "com.amazonaws.sagemaker#ProcessingJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the rule evaluation job.

" + } + }, + "RuleEvaluationStatus": { + "target": "com.amazonaws.sagemaker#RuleEvaluationStatus", + "traits": { + "smithy.api#documentation": "

Status of the rule evaluation.

" + } + }, + "StatusDetails": { + "target": "com.amazonaws.sagemaker#StatusDetails", + "traits": { + "smithy.api#documentation": "

Details from the rule evaluation.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Timestamp when the rule evaluation status was last modified.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the status of the rule evaluation.

" + } + }, + "com.amazonaws.sagemaker#ProfilerRuleEvaluationStatuses": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ProfilerRuleEvaluationStatus" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.sagemaker#ProfilingIntervalInMilliseconds": { + "type": "long" + }, + "com.amazonaws.sagemaker#ProfilingParameters": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#ConfigKey" + }, + "value": { + "target": "com.amazonaws.sagemaker#ConfigValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.sagemaker#ProfilingStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enabled" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disabled" + } + } + } + }, + "com.amazonaws.sagemaker#ProgrammingLang": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z]+ ?\\d+\\.\\d+(\\.\\d+)?$" + } + }, + "com.amazonaws.sagemaker#Project": { + "type": "structure", + "members": { + "ProjectArn": { + "target": "com.amazonaws.sagemaker#ProjectArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the project.

" + } + }, + "ProjectName": { + "target": "com.amazonaws.sagemaker#ProjectEntityName", + "traits": { + "smithy.api#documentation": "

The name of the project.

" + } + }, + "ProjectId": { + "target": "com.amazonaws.sagemaker#ProjectId", + "traits": { + "smithy.api#documentation": "

The ID of the project.

" + } + }, + "ProjectDescription": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "

The description of the project.

" + } + }, + "ServiceCatalogProvisioningDetails": { + "target": "com.amazonaws.sagemaker#ServiceCatalogProvisioningDetails" + }, + "ServiceCatalogProvisionedProductDetails": { + "target": "com.amazonaws.sagemaker#ServiceCatalogProvisionedProductDetails" + }, + "ProjectStatus": { + "target": "com.amazonaws.sagemaker#ProjectStatus", + "traits": { + "smithy.api#documentation": "

The status of the project.

" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext", + "traits": { + "smithy.api#documentation": "

Who created the project.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A timestamp specifying when the project was created.

" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A timestamp container for when the project was last modified.

" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + } + }, + "traits": { + "smithy.api#documentation": "

The properties of a project as returned by the Search API.

" + } + }, + "com.amazonaws.sagemaker#ProjectArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-cn|-us-gov|-iso-f)?:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:project/[\\S]{1,2048}$" + } + }, + "com.amazonaws.sagemaker#ProjectEntityName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}$" + } + }, + "com.amazonaws.sagemaker#ProjectId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + } + }, + "com.amazonaws.sagemaker#ProjectSortBy": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + } + } + }, + "com.amazonaws.sagemaker#ProjectSortOrder": { + "type": "enum", + "members": { + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ascending" + } + }, + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Descending" + } + } + } + }, + "com.amazonaws.sagemaker#ProjectStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "CREATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateInProgress" + } + }, + "CREATE_COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateCompleted" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateFailed" + } + }, + "DELETE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteInProgress" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteFailed" + } + }, + "DELETE_COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteCompleted" + } + }, + "UPDATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateInProgress" + } + }, + "UPDATE_COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateCompleted" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateFailed" + } + } + } + }, + "com.amazonaws.sagemaker#ProjectSummary": { + "type": "structure", + "members": { + "ProjectName": { + "target": "com.amazonaws.sagemaker#ProjectEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the project.

", + "smithy.api#required": {} + } + }, + "ProjectDescription": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "

The description of the project.

" + } + }, + "ProjectArn": { + "target": "com.amazonaws.sagemaker#ProjectArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the project.

", + "smithy.api#required": {} + } + }, + "ProjectId": { + "target": "com.amazonaws.sagemaker#ProjectId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the project.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The time that the project was created.

", + "smithy.api#required": {} + } + }, + "ProjectStatus": { + "target": "com.amazonaws.sagemaker#ProjectStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of the project.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a project.

" + } + }, + "com.amazonaws.sagemaker#ProjectSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ProjectSummary" + } + }, + "com.amazonaws.sagemaker#PropertyNameHint": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#PropertyNameQuery": { + "type": "structure", + "members": { + "PropertyNameHint": { + "target": "com.amazonaws.sagemaker#PropertyNameHint", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Text that begins a property's name.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Part of the SuggestionQuery type. Specifies a hint for retrieving property\n names that begin with the specified text.

" + } + }, + "com.amazonaws.sagemaker#PropertyNameSuggestion": { + "type": "structure", + "members": { + "PropertyName": { + "target": "com.amazonaws.sagemaker#ResourcePropertyName", + "traits": { + "smithy.api#documentation": "

A suggested property name based on what you entered in the search textbox in the SageMaker\n console.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A property name returned from a GetSearchSuggestions call that specifies\n a value in the PropertyNameQuery field.

" + } + }, + "com.amazonaws.sagemaker#PropertyNameSuggestionList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#PropertyNameSuggestion" + } + }, + "com.amazonaws.sagemaker#ProvisionedProductStatusMessage": { + "type": "string", + "traits": { + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#ProvisioningParameter": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.sagemaker#ProvisioningParameterKey", + "traits": { + "smithy.api#documentation": "

The key that identifies a provisioning parameter.

" + } + }, + "Value": { + "target": "com.amazonaws.sagemaker#ProvisioningParameterValue", + "traits": { + "smithy.api#documentation": "

The value of the provisioning parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A key value pair used when you provision a project as a service catalog product. For\n information, see What is Amazon Web Services Service\n Catalog.

" + } + }, + "com.amazonaws.sagemaker#ProvisioningParameterKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#ProvisioningParameterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4096 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#ProvisioningParameters": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ProvisioningParameter" + } + }, + "com.amazonaws.sagemaker#PublicWorkforceTaskPrice": { + "type": "structure", + "members": { + "AmountInUsd": { + "target": "com.amazonaws.sagemaker#USD", + "traits": { + "smithy.api#documentation": "

Defines the amount of money paid to an Amazon Mechanical Turk worker in United States dollars.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines the amount of money paid to an Amazon Mechanical Turk worker for each task performed.

\n

Use one of the following prices for bounding box tasks. Prices are in US dollars and\n should be based on the complexity of the task; the longer it takes in your initial\n testing, the more you should offer.

\n
    \n
  • \n

    0.036

    \n
    • \n
  • \n

    0.048

    \n
    • \n
  • \n

    0.060

    \n
    • \n
  • \n

    0.072

    \n
    • \n
  • \n

    0.120

    \n
    • \n
  • \n

    0.240

    \n
    • \n
  • \n

    0.360

    \n
    • \n
  • \n

    0.480

    \n
    • \n
  • \n

    0.600

    \n
    • \n
  • \n

    0.720

    \n
    • \n
  • \n

    0.840

    \n
    • \n
  • \n

    0.960

    \n
    • \n
  • \n

    1.080

    \n
    • \n
  • \n

    1.200

    \n
    • \n
\n

Use one of the following prices for image classification, text classification, and\n custom tasks. Prices are in US dollars.

\n
    \n
  • \n

    0.012

    \n
    • \n
  • \n

    0.024

    \n
    • \n
  • \n

    0.036

    \n
    • \n
  • \n

    0.048

    \n
    • \n
  • \n

    0.060

    \n
    • \n
  • \n

    0.072

    \n
    • \n
  • \n

    0.120

    \n
    • \n
  • \n

    0.240

    \n
    • \n
  • \n

    0.360

    \n
    • \n
  • \n

    0.480

    \n
    • \n
  • \n

    0.600

    \n
    • \n
  • \n

    0.720

    \n
    • \n
  • \n

    0.840

    \n
    • \n
  • \n

    0.960

    \n
    • \n
  • \n

    1.080

    \n
    • \n
  • \n

    1.200

    \n
    • \n
\n

Use one of the following prices for semantic segmentation tasks. Prices are in US\n dollars.

\n
    \n
  • \n

    0.840

    \n
    • \n
  • \n

    0.960

    \n
    • \n
  • \n

    1.080

    \n
    • \n
  • \n

    1.200

    \n
    • \n
\n

Use one of the following prices for Textract AnalyzeDocument Important Form Key Amazon\n Augmented AI review tasks. Prices are in US dollars.

\n
    \n
  • \n

    2.400

    \n
    • \n
  • \n

    2.280

    \n
    • \n
  • \n

    2.160

    \n
    • \n
  • \n

    2.040

    \n
    • \n
  • \n

    1.920

    \n
    • \n
  • \n

    1.800

    \n
    • \n
  • \n

    1.680

    \n
    • \n
  • \n

    1.560

    \n
    • \n
  • \n

    1.440

    \n
    • \n
  • \n

    1.320

    \n
    • \n
  • \n

    1.200

    \n
    • \n
  • \n

    1.080

    \n
    • \n
  • \n

    0.960

    \n
    • \n
  • \n

    0.840

    \n
    • \n
  • \n

    0.720

    \n
    • \n
  • \n

    0.600

    \n
    • \n
  • \n

    0.480

    \n
    • \n
  • \n

    0.360

    \n
    • \n
  • \n

    0.240

    \n
    • \n
  • \n

    0.120

    \n
    • \n
  • \n

    0.072

    \n
    • \n
  • \n

    0.060

    \n
    • \n
  • \n

    0.048

    \n
    • \n
  • \n

    0.036

    \n
    • \n
  • \n

    0.024

    \n
    • \n
  • \n

    0.012

    \n
    • \n
\n

Use one of the following prices for Rekognition DetectModerationLabels Amazon\n Augmented AI review tasks. Prices are in US dollars.

\n
    \n
  • \n

    1.200

    \n
    • \n
  • \n

    1.080

    \n
    • \n
  • \n

    0.960

    \n
    • \n
  • \n

    0.840

    \n
    • \n
  • \n

    0.720

    \n
    • \n
  • \n

    0.600

    \n
    • \n
  • \n

    0.480

    \n
    • \n
  • \n

    0.360

    \n
    • \n
  • \n

    0.240

    \n
    • \n
  • \n

    0.120

    \n
    • \n
  • \n

    0.072

    \n
    • \n
  • \n

    0.060

    \n
    • \n
  • \n

    0.048

    \n
    • \n
  • \n

    0.036

    \n
    • \n
  • \n

    0.024

    \n
    • \n
  • \n

    0.012

    \n
    • \n
\n

Use one of the following prices for Amazon Augmented AI custom human review tasks.\n Prices are in US dollars.

\n
    \n
  • \n

    1.200

    \n
    • \n
  • \n

    1.080

    \n
    • \n
  • \n

    0.960

    \n
    • \n
  • \n

    0.840

    \n
    • \n
  • \n

    0.720

    \n
    • \n
  • \n

    0.600

    \n
    • \n
  • \n

    0.480

    \n
    • \n
  • \n

    0.360

    \n
    • \n
  • \n

    0.240

    \n
    • \n
  • \n

    0.120

    \n
    • \n
  • \n

    0.072

    \n
    • \n
  • \n

    0.060

    \n
    • \n
  • \n

    0.048

    \n
    • \n
  • \n

    0.036

    \n
    • \n
  • \n

    0.024

    \n
    • \n
  • \n

    0.012

    \n
    • \n
" + } + }, + "com.amazonaws.sagemaker#PutModelPackageGroupPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#PutModelPackageGroupPolicyInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#PutModelPackageGroupPolicyOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds a resouce policy to control access to a model group. For information about\n resoure policies, see Identity-based\n policies and resource-based policies in the Amazon Web Services Identity and Access Management User Guide..

" + } + }, + "com.amazonaws.sagemaker#PutModelPackageGroupPolicyInput": { + "type": "structure", + "members": { + "ModelPackageGroupName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the model group to add a resource policy to.

", + "smithy.api#required": {} + } + }, + "ResourcePolicy": { + "target": "com.amazonaws.sagemaker#PolicyString", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The resource policy for the model group.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#PutModelPackageGroupPolicyOutput": { + "type": "structure", + "members": { + "ModelPackageGroupArn": { + "target": "com.amazonaws.sagemaker#ModelPackageGroupArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model package group.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#QProfileArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:[-.a-z0-9]{1,63}:codewhisperer:([-.a-z0-9]{0,63}:){2}([a-zA-Z0-9-_:/]){1,1023}$" + } + }, + "com.amazonaws.sagemaker#QualityCheckStepMetadata": { + "type": "structure", + "members": { + "CheckType": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "

The type of the Quality check step.

" + } + }, + "BaselineUsedForDriftCheckStatistics": { + "target": "com.amazonaws.sagemaker#String1024", + "traits": { + "smithy.api#documentation": "

The Amazon S3 URI of the baseline statistics file used for the drift check.

" + } + }, + "BaselineUsedForDriftCheckConstraints": { + "target": "com.amazonaws.sagemaker#String1024", + "traits": { + "smithy.api#documentation": "

The Amazon S3 URI of the baseline constraints file used for the drift check.

" + } + }, + "CalculatedBaselineStatistics": { + "target": "com.amazonaws.sagemaker#String1024", + "traits": { + "smithy.api#documentation": "

The Amazon S3 URI of the newly calculated baseline statistics file.

" + } + }, + "CalculatedBaselineConstraints": { + "target": "com.amazonaws.sagemaker#String1024", + "traits": { + "smithy.api#documentation": "

The Amazon S3 URI of the newly calculated baseline constraints file.

" + } + }, + "ModelPackageGroupName": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "

The model package group name.

" + } + }, + "ViolationReport": { + "target": "com.amazonaws.sagemaker#String1024", + "traits": { + "smithy.api#documentation": "

The Amazon S3 URI of violation report if violations are detected.

" + } + }, + "CheckJobArn": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Quality check processing job that was run by this step execution.

" + } + }, + "SkipCheck": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

This flag indicates if the drift check against the previous baseline will be skipped or not. \n If it is set to False, the previous baseline of the configured check type must be available.

" + } + }, + "RegisterNewBaseline": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

This flag indicates if a newly calculated baseline can be accessed through step properties \n BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. \n If it is set to False, the previous baseline of the configured check type must also be available. \n These can be accessed through the BaselineUsedForDriftCheckConstraints and \n BaselineUsedForDriftCheckStatistics properties.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Container for the metadata for a Quality check step. For more information, see \n the topic on QualityCheck step in the Amazon SageMaker Developer Guide.\n

" + } + }, + "com.amazonaws.sagemaker#QueryFilters": { + "type": "structure", + "members": { + "Types": { + "target": "com.amazonaws.sagemaker#QueryTypes", + "traits": { + "smithy.api#documentation": "

Filter the lineage entities connected to the StartArn by type. For example: DataSet, \n Model, Endpoint, or ModelDeployment.

" + } + }, + "LineageTypes": { + "target": "com.amazonaws.sagemaker#QueryLineageTypes", + "traits": { + "smithy.api#documentation": "

Filter the lineage entities connected to the StartArn(s) by the type of the lineage entity.

" + } + }, + "CreatedBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Filter the lineage entities connected to the StartArn(s) by created date.

" + } + }, + "CreatedAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Filter the lineage entities connected to the StartArn(s) after the create date.

" + } + }, + "ModifiedBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Filter the lineage entities connected to the StartArn(s) before the last modified date.

" + } + }, + "ModifiedAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Filter the lineage entities connected to the StartArn(s) after the last modified date.

" + } + }, + "Properties": { + "target": "com.amazonaws.sagemaker#QueryProperties", + "traits": { + "smithy.api#documentation": "

Filter the lineage entities connected to the StartArn(s) by a set if property key value pairs. \n If multiple pairs are provided, an entity is included in the results if it matches any of the provided pairs.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A set of filters to narrow the set of lineage entities connected to the StartArn(s) returned by the \n QueryLineage API action.

" + } + }, + "com.amazonaws.sagemaker#QueryLineage": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#QueryLineageRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#QueryLineageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Use this action to inspect your lineage and discover relationships between entities. \n For more information, see \n Querying Lineage Entities in the Amazon SageMaker Developer Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#QueryLineageMaxDepth": { + "type": "integer", + "traits": { + "smithy.api#range": { + "max": 10 + } + } + }, + "com.amazonaws.sagemaker#QueryLineageMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "max": 50 + } + } + }, + "com.amazonaws.sagemaker#QueryLineageRequest": { + "type": "structure", + "members": { + "StartArns": { + "target": "com.amazonaws.sagemaker#QueryLineageStartArns", + "traits": { + "smithy.api#documentation": "

A list of resource Amazon Resource Name (ARN) that represent the starting point for your lineage query.

" + } + }, + "Direction": { + "target": "com.amazonaws.sagemaker#Direction", + "traits": { + "smithy.api#documentation": "

Associations between lineage entities have a direction. This parameter determines the direction from the \n StartArn(s) that the query traverses.

" + } + }, + "IncludeEdges": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

Setting this value to True retrieves not only the entities of interest but also the \n Associations and \n lineage entities on the path. Set to False to only return lineage entities that match your query.

" + } + }, + "Filters": { + "target": "com.amazonaws.sagemaker#QueryFilters", + "traits": { + "smithy.api#documentation": "

A set of filtering parameters that allow you to specify which entities should be returned.

\n
    \n
  • \n

    Properties - Key-value pairs to match on the lineage entities' properties.

    \n
    • \n
  • \n

    LineageTypes - A set of lineage entity types to match on. For example: TrialComponent, \n Artifact, or Context.

    \n
    • \n
  • \n

    CreatedBefore - Filter entities created before this date.

    \n
    • \n
  • \n

    ModifiedBefore - Filter entities modified before this date.

    \n
    • \n
  • \n

    ModifiedAfter - Filter entities modified after this date.

    \n
    • \n
" + } + }, + "MaxDepth": { + "target": "com.amazonaws.sagemaker#QueryLineageMaxDepth", + "traits": { + "smithy.api#documentation": "

The maximum depth in lineage relationships from the StartArns that are traversed. Depth is a measure of the number \n of Associations from the StartArn entity to the matched results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#QueryLineageMaxResults", + "traits": { + "smithy.api#documentation": "

Limits the number of vertices in the results. Use the NextToken in a response to to retrieve the next page of results.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#String8192", + "traits": { + "smithy.api#documentation": "

Limits the number of vertices in the request. Use the NextToken in a response to to retrieve the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#QueryLineageResponse": { + "type": "structure", + "members": { + "Vertices": { + "target": "com.amazonaws.sagemaker#Vertices", + "traits": { + "smithy.api#documentation": "

A list of vertices connected to the start entity(ies) in the lineage graph.

" + } + }, + "Edges": { + "target": "com.amazonaws.sagemaker#Edges", + "traits": { + "smithy.api#documentation": "

A list of edges that connect vertices in the response.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#String8192", + "traits": { + "smithy.api#documentation": "

Limits the number of vertices in the response. Use the NextToken in a response to to retrieve the next page of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#QueryLineageStartArns": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AssociationEntityArn" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.sagemaker#QueryLineageTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#LineageType" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4 + } + } + }, + "com.amazonaws.sagemaker#QueryProperties": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#String256" + }, + "value": { + "target": "com.amazonaws.sagemaker#String256" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#QueryTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#String40" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#RSessionAppSettings": { + "type": "structure", + "members": { + "DefaultResourceSpec": { + "target": "com.amazonaws.sagemaker#ResourceSpec" + }, + "CustomImages": { + "target": "com.amazonaws.sagemaker#CustomImages", + "traits": { + "smithy.api#documentation": "

A list of custom SageMaker AI images that are configured to run as a RSession\n app.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A collection of settings that apply to an RSessionGateway app.

" + } + }, + "com.amazonaws.sagemaker#RStudioServerProAccessStatus": { + "type": "enum", + "members": { + "Enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "Disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.sagemaker#RStudioServerProAppSettings": { + "type": "structure", + "members": { + "AccessStatus": { + "target": "com.amazonaws.sagemaker#RStudioServerProAccessStatus", + "traits": { + "smithy.api#documentation": "

Indicates whether the current user has access to the RStudioServerPro\n app.

" + } + }, + "UserGroup": { + "target": "com.amazonaws.sagemaker#RStudioServerProUserGroup", + "traits": { + "smithy.api#documentation": "

The level of permissions that the user has within the RStudioServerPro app.\n This value defaults to `User`. The `Admin` value allows the user access to the RStudio\n Administrative Dashboard.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A collection of settings that configure user interaction with the\n RStudioServerPro app.

" + } + }, + "com.amazonaws.sagemaker#RStudioServerProDomainSettings": { + "type": "structure", + "members": { + "DomainExecutionRoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the execution role for the RStudioServerPro Domain-level\n app.

", + "smithy.api#required": {} + } + }, + "RStudioConnectUrl": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

A URL pointing to an RStudio Connect server.

" + } + }, + "RStudioPackageManagerUrl": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

A URL pointing to an RStudio Package Manager server.

" + } + }, + "DefaultResourceSpec": { + "target": "com.amazonaws.sagemaker#ResourceSpec" + } + }, + "traits": { + "smithy.api#documentation": "

A collection of settings that configure the RStudioServerPro Domain-level\n app.

" + } + }, + "com.amazonaws.sagemaker#RStudioServerProDomainSettingsForUpdate": { + "type": "structure", + "members": { + "DomainExecutionRoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The execution role for the RStudioServerPro Domain-level app.

", + "smithy.api#required": {} + } + }, + "DefaultResourceSpec": { + "target": "com.amazonaws.sagemaker#ResourceSpec" + }, + "RStudioConnectUrl": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

A URL pointing to an RStudio Connect server.

" + } + }, + "RStudioPackageManagerUrl": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

A URL pointing to an RStudio Package Manager server.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A collection of settings that update the current configuration for the\n RStudioServerPro Domain-level app.

" + } + }, + "com.amazonaws.sagemaker#RStudioServerProUserGroup": { + "type": "enum", + "members": { + "Admin": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "R_STUDIO_ADMIN" + } + }, + "User": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "R_STUDIO_USER" + } + } + } + }, + "com.amazonaws.sagemaker#RandomSeed": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.sagemaker#RealTimeInferenceConfig": { + "type": "structure", + "members": { + "InstanceType": { + "target": "com.amazonaws.sagemaker#InstanceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The instance type the model is deployed to.

", + "smithy.api#required": {} + } + }, + "InstanceCount": { + "target": "com.amazonaws.sagemaker#TaskCount", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of instances of the type specified by InstanceType.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The infrastructure configuration for deploying the model to a real-time inference endpoint.

" + } + }, + "com.amazonaws.sagemaker#RealTimeInferenceRecommendation": { + "type": "structure", + "members": { + "RecommendationId": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The recommendation ID which uniquely identifies each recommendation.

", + "smithy.api#required": {} + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#ProductionVariantInstanceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The recommended instance type for Real-Time Inference.

", + "smithy.api#required": {} + } + }, + "Environment": { + "target": "com.amazonaws.sagemaker#EnvironmentMap", + "traits": { + "smithy.api#documentation": "

The recommended environment variables to set in the model container for Real-Time Inference.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The recommended configuration to use for Real-Time Inference.

" + } + }, + "com.amazonaws.sagemaker#RealTimeInferenceRecommendations": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#RealTimeInferenceRecommendation" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3 + } + } + }, + "com.amazonaws.sagemaker#RealtimeInferenceInstanceTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ProductionVariantInstanceType" + } + }, + "com.amazonaws.sagemaker#RecommendationFailureReason": { + "type": "string" + }, + "com.amazonaws.sagemaker#RecommendationJobArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:inference-recommendations-job/" + } + }, + "com.amazonaws.sagemaker#RecommendationJobCompilationJobName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#RecommendationJobCompiledOutputConfig": { + "type": "structure", + "members": { + "S3OutputUri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "

Identifies the Amazon S3 bucket where you want SageMaker to store the \n compiled model artifacts.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about the output configuration for the compiled \n model.

" + } + }, + "com.amazonaws.sagemaker#RecommendationJobContainerConfig": { + "type": "structure", + "members": { + "Domain": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The machine learning domain of the model and its components.

\n

Valid Values: COMPUTER_VISION | NATURAL_LANGUAGE_PROCESSING |\n MACHINE_LEARNING\n

" + } + }, + "Task": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The machine learning task that the model accomplishes.

\n

Valid Values: IMAGE_CLASSIFICATION | OBJECT_DETECTION\n | TEXT_GENERATION | IMAGE_SEGMENTATION | FILL_MASK | CLASSIFICATION |\n REGRESSION | OTHER\n

" + } + }, + "Framework": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The machine learning framework of the container image.

\n

Valid Values: TENSORFLOW | PYTORCH | XGBOOST | SAGEMAKER-SCIKIT-LEARN\n

" + } + }, + "FrameworkVersion": { + "target": "com.amazonaws.sagemaker#RecommendationJobFrameworkVersion", + "traits": { + "smithy.api#documentation": "

The framework version of the container image.

" + } + }, + "PayloadConfig": { + "target": "com.amazonaws.sagemaker#RecommendationJobPayloadConfig", + "traits": { + "smithy.api#documentation": "

Specifies the SamplePayloadUrl and all other sample payload-related fields.

" + } + }, + "NearestModelName": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The name of a pre-trained machine learning model benchmarked by Amazon SageMaker Inference Recommender that matches your model.

\n

Valid Values: efficientnetb7 | unet | xgboost | faster-rcnn-resnet101 | nasnetlarge | vgg16 | inception-v3 | mask-rcnn | sagemaker-scikit-learn |\n densenet201-gluon | resnet18v2-gluon | xception | densenet201 | yolov4 | resnet152 | bert-base-cased | xceptionV1-keras | resnet50 | retinanet\n

" + } + }, + "SupportedInstanceTypes": { + "target": "com.amazonaws.sagemaker#RecommendationJobSupportedInstanceTypes", + "traits": { + "smithy.api#documentation": "

A list of the instance types that are used to generate inferences in real-time.

" + } + }, + "SupportedEndpointType": { + "target": "com.amazonaws.sagemaker#RecommendationJobSupportedEndpointType", + "traits": { + "smithy.api#documentation": "

The endpoint type to receive recommendations for. By default this is null, and the results of \n the inference recommendation job return a combined list of both real-time and serverless benchmarks.\n By specifying a value for this field, you can receive a longer list of benchmarks for the desired endpoint type.

" + } + }, + "DataInputConfig": { + "target": "com.amazonaws.sagemaker#RecommendationJobDataInputConfig", + "traits": { + "smithy.api#documentation": "

Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form.\n This field is used for optimizing your model using SageMaker Neo. For more information, see\n DataInputConfig.

" + } + }, + "SupportedResponseMIMETypes": { + "target": "com.amazonaws.sagemaker#RecommendationJobSupportedResponseMIMETypes", + "traits": { + "smithy.api#documentation": "

The supported MIME types for the output data.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies mandatory fields for running an Inference Recommender job directly in the\n CreateInferenceRecommendationsJob\n API. The fields specified in ContainerConfig override the corresponding fields in the model package. Use\n ContainerConfig if you want to specify these fields for the recommendation job but don't want to edit them in your model package.

" + } + }, + "com.amazonaws.sagemaker#RecommendationJobDataInputConfig": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[\\S\\s]+$" + } + }, + "com.amazonaws.sagemaker#RecommendationJobDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + } + } + }, + "com.amazonaws.sagemaker#RecommendationJobFrameworkVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 10 + }, + "smithy.api#pattern": "^[0-9]\\.[A-Za-z0-9.-]+$" + } + }, + "com.amazonaws.sagemaker#RecommendationJobInferenceBenchmark": { + "type": "structure", + "members": { + "Metrics": { + "target": "com.amazonaws.sagemaker#RecommendationMetrics" + }, + "EndpointMetrics": { + "target": "com.amazonaws.sagemaker#InferenceMetrics" + }, + "EndpointConfiguration": { + "target": "com.amazonaws.sagemaker#EndpointOutputConfiguration" + }, + "ModelConfiguration": { + "target": "com.amazonaws.sagemaker#ModelConfiguration", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#RecommendationFailureReason", + "traits": { + "smithy.api#documentation": "

The reason why a benchmark failed.

" + } + }, + "InvocationEndTime": { + "target": "com.amazonaws.sagemaker#InvocationEndTime", + "traits": { + "smithy.api#documentation": "

A timestamp that shows when the benchmark completed.

" + } + }, + "InvocationStartTime": { + "target": "com.amazonaws.sagemaker#InvocationStartTime", + "traits": { + "smithy.api#documentation": "

A timestamp that shows when the benchmark started.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The details for a specific benchmark from an Inference Recommender job.

" + } + }, + "com.amazonaws.sagemaker#RecommendationJobInputConfig": { + "type": "structure", + "members": { + "ModelPackageVersionArn": { + "target": "com.amazonaws.sagemaker#ModelPackageArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a versioned model package.

" + } + }, + "ModelName": { + "target": "com.amazonaws.sagemaker#ModelName", + "traits": { + "smithy.api#documentation": "

The name of the created model.

" + } + }, + "JobDurationInSeconds": { + "target": "com.amazonaws.sagemaker#JobDurationInSeconds", + "traits": { + "smithy.api#documentation": "

Specifies the maximum duration of the job, in seconds. The maximum value is 18,000 seconds.

" + } + }, + "TrafficPattern": { + "target": "com.amazonaws.sagemaker#TrafficPattern", + "traits": { + "smithy.api#documentation": "

Specifies the traffic pattern of the job.

" + } + }, + "ResourceLimit": { + "target": "com.amazonaws.sagemaker#RecommendationJobResourceLimit", + "traits": { + "smithy.api#documentation": "

Defines the resource limit of the job.

" + } + }, + "EndpointConfigurations": { + "target": "com.amazonaws.sagemaker#EndpointInputConfigurations", + "traits": { + "smithy.api#documentation": "

Specifies the endpoint configuration to use for a job.

" + } + }, + "VolumeKmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key \n that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. \n This key will be passed to SageMaker Hosting for endpoint creation.

\n

The SageMaker execution role must have kms:CreateGrant permission in order to encrypt data on the storage \n volume of the endpoints created for inference recommendation. The inference recommendation job will fail \n asynchronously during endpoint configuration creation if the role passed does not have \n kms:CreateGrant permission.

\n

The KmsKeyId can be any of the following formats:

\n
    \n
  • \n

    // KMS Key ID

    \n

    \n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    // Amazon Resource Name (ARN) of a KMS Key

    \n

    \n \"arn:aws:kms:::key/\"\n

    \n
    • \n
  • \n

    // KMS Key Alias

    \n

    \n \"alias/ExampleAlias\"\n

    \n
    • \n
  • \n

    // Amazon Resource Name (ARN) of a KMS Key Alias

    \n

    \n \"arn:aws:kms:::alias/\"\n

    \n
    • \n
\n

For more information about key identifiers, see \n Key identifiers (KeyID) in the \n Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.

" + } + }, + "ContainerConfig": { + "target": "com.amazonaws.sagemaker#RecommendationJobContainerConfig", + "traits": { + "smithy.api#documentation": "

Specifies mandatory fields for running an Inference Recommender job. The fields specified in ContainerConfig\n override the corresponding fields in the model package.

" + } + }, + "Endpoints": { + "target": "com.amazonaws.sagemaker#Endpoints", + "traits": { + "smithy.api#documentation": "

Existing customer endpoints on which to run an Inference Recommender job.

" + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#RecommendationJobVpcConfig", + "traits": { + "smithy.api#documentation": "

Inference Recommender provisions SageMaker endpoints with access to VPC in the inference recommendation job.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The input configuration of the recommendation job.

" + } + }, + "com.amazonaws.sagemaker#RecommendationJobName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}$" + } + }, + "com.amazonaws.sagemaker#RecommendationJobOutputConfig": { + "type": "structure", + "members": { + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key \n that Amazon SageMaker uses to encrypt your output artifacts with Amazon S3 server-side encryption. \n The SageMaker execution role must have kms:GenerateDataKey permission.

\n

The KmsKeyId can be any of the following formats:

\n
    \n
  • \n

    // KMS Key ID

    \n

    \n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    // Amazon Resource Name (ARN) of a KMS Key

    \n

    \n \"arn:aws:kms:::key/\"\n

    \n
    • \n
  • \n

    // KMS Key Alias

    \n

    \n \"alias/ExampleAlias\"\n

    \n
    • \n
  • \n

    // Amazon Resource Name (ARN) of a KMS Key Alias

    \n

    \n \"arn:aws:kms:::alias/\"\n

    \n
    • \n
\n

For more information about key identifiers, see \n Key identifiers (KeyID) in the \n Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.

" + } + }, + "CompiledOutputConfig": { + "target": "com.amazonaws.sagemaker#RecommendationJobCompiledOutputConfig", + "traits": { + "smithy.api#documentation": "

Provides information about the output configuration for the compiled \n model.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about the output configuration for the compiled model.

" + } + }, + "com.amazonaws.sagemaker#RecommendationJobPayloadConfig": { + "type": "structure", + "members": { + "SamplePayloadUrl": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "

The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

" + } + }, + "SupportedContentTypes": { + "target": "com.amazonaws.sagemaker#RecommendationJobSupportedContentTypes", + "traits": { + "smithy.api#documentation": "

The supported MIME types for the input data.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for the payload for a recommendation job.

" + } + }, + "com.amazonaws.sagemaker#RecommendationJobResourceLimit": { + "type": "structure", + "members": { + "MaxNumberOfTests": { + "target": "com.amazonaws.sagemaker#MaxNumberOfTests", + "traits": { + "smithy.api#documentation": "

Defines the maximum number of load tests.

" + } + }, + "MaxParallelOfTests": { + "target": "com.amazonaws.sagemaker#MaxParallelOfTests", + "traits": { + "smithy.api#documentation": "

Defines the maximum number of parallel load tests.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the maximum number of jobs that can run in parallel \n and the maximum number of jobs that can run.

" + } + }, + "com.amazonaws.sagemaker#RecommendationJobStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPING" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + } + } + }, + "com.amazonaws.sagemaker#RecommendationJobStoppingConditions": { + "type": "structure", + "members": { + "MaxInvocations": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of requests per minute expected for the endpoint.

" + } + }, + "ModelLatencyThresholds": { + "target": "com.amazonaws.sagemaker#ModelLatencyThresholds", + "traits": { + "smithy.api#documentation": "

The interval of time taken by a model to respond as viewed from SageMaker. \n The interval includes the local communication time taken to send the request \n and to fetch the response from the container of a model and the time taken to \n complete the inference in the container.

" + } + }, + "FlatInvocations": { + "target": "com.amazonaws.sagemaker#FlatInvocations", + "traits": { + "smithy.api#documentation": "

Stops a load test when the number of invocations (TPS) peaks and flattens,\n which means that the instance has reached capacity. The default value is Stop.\n If you want the load test to continue after invocations have flattened, set the value to Continue.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies conditions for stopping a job. When a job reaches a \n stopping condition limit, SageMaker ends the job.

" + } + }, + "com.amazonaws.sagemaker#RecommendationJobSupportedContentType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#RecommendationJobSupportedContentTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#RecommendationJobSupportedContentType" + } + }, + "com.amazonaws.sagemaker#RecommendationJobSupportedEndpointType": { + "type": "enum", + "members": { + "REALTIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RealTime" + } + }, + "SERVERLESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Serverless" + } + } + } + }, + "com.amazonaws.sagemaker#RecommendationJobSupportedInstanceTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#String" + } + }, + "com.amazonaws.sagemaker#RecommendationJobSupportedResponseMIMEType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^[-\\w]+\\/.+$" + } + }, + "com.amazonaws.sagemaker#RecommendationJobSupportedResponseMIMETypes": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#RecommendationJobSupportedResponseMIMEType" + } + }, + "com.amazonaws.sagemaker#RecommendationJobType": { + "type": "enum", + "members": { + "DEFAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Default" + } + }, + "ADVANCED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Advanced" + } + } + } + }, + "com.amazonaws.sagemaker#RecommendationJobVpcConfig": { + "type": "structure", + "members": { + "SecurityGroupIds": { + "target": "com.amazonaws.sagemaker#RecommendationJobVpcSecurityGroupIds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The VPC security group IDs. IDs have the form of sg-xxxxxxxx.\n Specify the security groups for the VPC that is specified in the Subnets field.

", + "smithy.api#required": {} + } + }, + "Subnets": { + "target": "com.amazonaws.sagemaker#RecommendationJobVpcSubnets", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the subnets in the VPC to which you want to connect your model.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Inference Recommender provisions SageMaker endpoints with access to VPC in the inference recommendation job.

" + } + }, + "com.amazonaws.sagemaker#RecommendationJobVpcSecurityGroupId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + }, + "smithy.api#pattern": "^[-0-9a-zA-Z]+$" + } + }, + "com.amazonaws.sagemaker#RecommendationJobVpcSecurityGroupIds": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#RecommendationJobVpcSecurityGroupId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#RecommendationJobVpcSubnetId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + }, + "smithy.api#pattern": "^[-0-9a-zA-Z]+$" + } + }, + "com.amazonaws.sagemaker#RecommendationJobVpcSubnets": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#RecommendationJobVpcSubnetId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16 + } + } + }, + "com.amazonaws.sagemaker#RecommendationMetrics": { + "type": "structure", + "members": { + "CostPerHour": { + "target": "com.amazonaws.sagemaker#Float", + "traits": { + "smithy.api#documentation": "

Defines the cost per hour for the instance.

" + } + }, + "CostPerInference": { + "target": "com.amazonaws.sagemaker#Float", + "traits": { + "smithy.api#documentation": "

Defines the cost per inference for the instance .

" + } + }, + "MaxInvocations": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "

The expected maximum number of requests per minute for the instance.

" + } + }, + "ModelLatency": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "

The expected model latency at maximum invocation per minute for the instance.

" + } + }, + "CpuUtilization": { + "target": "com.amazonaws.sagemaker#UtilizationMetric", + "traits": { + "smithy.api#documentation": "

The expected CPU utilization at maximum invocations per minute for the instance.

\n

\n NaN indicates that the value is not available.

" + } + }, + "MemoryUtilization": { + "target": "com.amazonaws.sagemaker#UtilizationMetric", + "traits": { + "smithy.api#documentation": "

The expected memory utilization at maximum invocations per minute for the instance.

\n

\n NaN indicates that the value is not available.

" + } + }, + "ModelSetupTime": { + "target": "com.amazonaws.sagemaker#ModelSetupTime", + "traits": { + "smithy.api#documentation": "

The time it takes to launch new compute resources for a serverless endpoint.\n The time can vary depending on the model size, how long it takes to download the\n model, and the start-up time of the container.

\n

\n NaN indicates that the value is not available.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The metrics of recommendations.

" + } + }, + "com.amazonaws.sagemaker#RecommendationStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "NOT_APPLICABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_APPLICABLE" + } + } + } + }, + "com.amazonaws.sagemaker#RecommendationStepType": { + "type": "enum", + "members": { + "BENCHMARK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BENCHMARK" + } + } + } + }, + "com.amazonaws.sagemaker#RecordWrapper": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "None" + } + }, + "RECORDIO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RecordIO" + } + } + } + }, + "com.amazonaws.sagemaker#RedshiftClusterId": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The Redshift cluster Identifier.

", + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#RedshiftDatabase": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The name of the Redshift database used in Redshift query execution.

", + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#RedshiftDatasetDefinition": { + "type": "structure", + "members": { + "ClusterId": { + "target": "com.amazonaws.sagemaker#RedshiftClusterId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.sagemaker#RedshiftDatabase", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "DbUser": { + "target": "com.amazonaws.sagemaker#RedshiftUserName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "QueryString": { + "target": "com.amazonaws.sagemaker#RedshiftQueryString", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "ClusterRoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IAM role attached to your Redshift cluster that Amazon SageMaker uses to generate datasets.

", + "smithy.api#required": {} + } + }, + "OutputS3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The location in Amazon S3 where the Redshift query results are stored.

", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data from a\n Redshift execution.

" + } + }, + "OutputFormat": { + "target": "com.amazonaws.sagemaker#RedshiftResultFormat", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "OutputCompression": { + "target": "com.amazonaws.sagemaker#RedshiftResultCompressionType" + } + }, + "traits": { + "smithy.api#documentation": "

Configuration for Redshift Dataset Definition input.

" + } + }, + "com.amazonaws.sagemaker#RedshiftQueryString": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The SQL query statements to be executed.

", + "smithy.api#length": { + "min": 1, + "max": 4096 + }, + "smithy.api#pattern": "^[\\s\\S]+$" + } + }, + "com.amazonaws.sagemaker#RedshiftResultCompressionType": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "None" + } + }, + "GZIP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GZIP" + } + }, + "BZIP2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BZIP2" + } + }, + "ZSTD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZSTD" + } + }, + "SNAPPY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SNAPPY" + } + } + }, + "traits": { + "smithy.api#documentation": "

The compression used for Redshift query results.

" + } + }, + "com.amazonaws.sagemaker#RedshiftResultFormat": { + "type": "enum", + "members": { + "PARQUET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARQUET" + } + }, + "CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CSV" + } + } + }, + "traits": { + "smithy.api#documentation": "

The data storage format for Redshift query results.

" + } + }, + "com.amazonaws.sagemaker#RedshiftUserName": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The database user name used in Redshift query execution.

", + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#ReferenceMinVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 5, + "max": 14 + }, + "smithy.api#pattern": "^\\d{1,4}.\\d{1,4}.\\d{1,4}$" + } + }, + "com.amazonaws.sagemaker#RegisterDevices": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#RegisterDevicesRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Register devices.

" + } + }, + "com.amazonaws.sagemaker#RegisterDevicesRequest": { + "type": "structure", + "members": { + "DeviceFleetName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the fleet.

", + "smithy.api#required": {} + } + }, + "Devices": { + "target": "com.amazonaws.sagemaker#Devices", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A list of devices to register with SageMaker Edge Manager.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

The tags associated with devices.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#RegisterModelStepMetadata": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model package.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Metadata for a register model job step.

" + } + }, + "com.amazonaws.sagemaker#ReleaseNotes": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#RemoteDebugConfig": { + "type": "structure", + "members": { + "EnableRemoteDebug": { + "target": "com.amazonaws.sagemaker#EnableRemoteDebug", + "traits": { + "smithy.api#documentation": "

If set to True, enables remote debugging.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration for remote debugging for the CreateTrainingJob API. To learn more about the remote debugging\n functionality of SageMaker, see Access a training container\n through Amazon Web Services Systems Manager (SSM) for remote\n debugging.

" + } + }, + "com.amazonaws.sagemaker#RemoteDebugConfigForUpdate": { + "type": "structure", + "members": { + "EnableRemoteDebug": { + "target": "com.amazonaws.sagemaker#EnableRemoteDebug", + "traits": { + "smithy.api#documentation": "

If set to True, enables remote debugging.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration for remote debugging for the UpdateTrainingJob API. To learn more about the remote debugging\n functionality of SageMaker, see Access a training container\n through Amazon Web Services Systems Manager (SSM) for remote\n debugging.

" + } + }, + "com.amazonaws.sagemaker#RenderUiTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#RenderUiTemplateRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#RenderUiTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Renders the UI template so that you can preview the worker's experience.

" + } + }, + "com.amazonaws.sagemaker#RenderUiTemplateRequest": { + "type": "structure", + "members": { + "UiTemplate": { + "target": "com.amazonaws.sagemaker#UiTemplate", + "traits": { + "smithy.api#documentation": "

A Template object containing the worker UI template to render.

" + } + }, + "Task": { + "target": "com.amazonaws.sagemaker#RenderableTask", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A RenderableTask object containing a representative task to\n render.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the\n template.

", + "smithy.api#required": {} + } + }, + "HumanTaskUiArn": { + "target": "com.amazonaws.sagemaker#HumanTaskUiArn", + "traits": { + "smithy.api#documentation": "

The HumanTaskUiArn of the worker UI that you want to render. Do not\n provide a HumanTaskUiArn if you use the UiTemplate\n parameter.

\n

See a list of available Human Ui Amazon Resource Names (ARNs) in UiConfig.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#RenderUiTemplateResponse": { + "type": "structure", + "members": { + "RenderedContent": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A Liquid template that renders the HTML for the worker UI.

", + "smithy.api#required": {} + } + }, + "Errors": { + "target": "com.amazonaws.sagemaker#RenderingErrorList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A list of one or more RenderingError objects if any were encountered\n while rendering the template. If there were no errors, the list is empty.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#RenderableTask": { + "type": "structure", + "members": { + "Input": { + "target": "com.amazonaws.sagemaker#TaskInput", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A JSON object that contains values for the variables defined in the template. It is\n made available to the template under the substitution variable task.input.\n For example, if you define a variable task.input.text in your template, you\n can supply the variable in the JSON object as \"text\": \"sample text\".

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains input values for a task.

" + } + }, + "com.amazonaws.sagemaker#RenderingError": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A unique identifier for a specific class of errors.

", + "smithy.api#required": {} + } + }, + "Message": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A human-readable message describing the error.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A description of an error that occurred while rendering the template.

" + } + }, + "com.amazonaws.sagemaker#RenderingErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#RenderingError" + } + }, + "com.amazonaws.sagemaker#RepositoryAccessMode": { + "type": "enum", + "members": { + "PLATFORM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Platform" + } + }, + "VPC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Vpc" + } + } + } + }, + "com.amazonaws.sagemaker#RepositoryAuthConfig": { + "type": "structure", + "members": { + "RepositoryCredentialsProviderArn": { + "target": "com.amazonaws.sagemaker#RepositoryCredentialsProviderArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Amazon Web Services Lambda function that provides\n credentials to authenticate to the private Docker registry where your model image is\n hosted. For information about how to create an Amazon Web Services Lambda function, see\n Create a Lambda function\n with the console in the Amazon Web Services Lambda Developer\n Guide.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies an authentication configuration for the private docker registry where your\n model image is hosted. Specify a value for this property only if you specified\n Vpc as the value for the RepositoryAccessMode field of the\n ImageConfig object that you passed to a call to\n CreateModel and the private Docker registry where the model image is\n hosted requires authentication.

" + } + }, + "com.amazonaws.sagemaker#RepositoryCredentialsProviderArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#RepositoryUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^https://([.\\-_a-zA-Z0-9]+/?){3,1016}$" + } + }, + "com.amazonaws.sagemaker#ReservedCapacityArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 50, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:reserved-capacity/" + } + }, + "com.amazonaws.sagemaker#ReservedCapacityDurationHours": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 87600 + } + } + }, + "com.amazonaws.sagemaker#ReservedCapacityDurationMinutes": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 59 + } + } + }, + "com.amazonaws.sagemaker#ReservedCapacityInstanceCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.sagemaker#ReservedCapacityInstanceType": { + "type": "enum", + "members": { + "ML_P4D_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p4d.24xlarge" + } + }, + "ML_P5_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p5.48xlarge" + } + }, + "ML_P5E_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p5e.48xlarge" + } + }, + "ML_P5EN_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p5en.48xlarge" + } + }, + "ML_TRN2_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn2.48xlarge" + } + } + } + }, + "com.amazonaws.sagemaker#ReservedCapacityOffering": { + "type": "structure", + "members": { + "InstanceType": { + "target": "com.amazonaws.sagemaker#ReservedCapacityInstanceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The instance type for the reserved capacity offering.

", + "smithy.api#required": {} + } + }, + "InstanceCount": { + "target": "com.amazonaws.sagemaker#ReservedCapacityInstanceCount", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of instances in the reserved capacity offering.

", + "smithy.api#required": {} + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.sagemaker#AvailabilityZone", + "traits": { + "smithy.api#documentation": "

The availability zone for the reserved capacity offering.

" + } + }, + "DurationHours": { + "target": "com.amazonaws.sagemaker#ReservedCapacityDurationHours", + "traits": { + "smithy.api#documentation": "

The number of whole hours in the total duration for this reserved capacity\n offering.

" + } + }, + "DurationMinutes": { + "target": "com.amazonaws.sagemaker#ReservedCapacityDurationMinutes", + "traits": { + "smithy.api#documentation": "

The additional minutes beyond whole hours in the total duration for this reserved\n capacity offering.

" + } + }, + "StartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The start time of the reserved capacity offering.

" + } + }, + "EndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The end time of the reserved capacity offering.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about a reserved capacity offering for a training plan offering.

\n

For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using\n Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .

" + } + }, + "com.amazonaws.sagemaker#ReservedCapacityOfferings": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ReservedCapacityOffering" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#ReservedCapacityStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active" + } + }, + "SCHEDULED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Scheduled" + } + }, + "EXPIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Expired" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + } + } + }, + "com.amazonaws.sagemaker#ReservedCapacitySummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ReservedCapacitySummary" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#ReservedCapacitySummary": { + "type": "structure", + "members": { + "ReservedCapacityArn": { + "target": "com.amazonaws.sagemaker#ReservedCapacityArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN); of the reserved capacity.

", + "smithy.api#required": {} + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#ReservedCapacityInstanceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The instance type for the reserved capacity.

", + "smithy.api#required": {} + } + }, + "TotalInstanceCount": { + "target": "com.amazonaws.sagemaker#TotalInstanceCount", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The total number of instances in the reserved capacity.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#ReservedCapacityStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The current status of the reserved capacity.

", + "smithy.api#required": {} + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.sagemaker#AvailabilityZone", + "traits": { + "smithy.api#documentation": "

The availability zone for the reserved capacity.

" + } + }, + "DurationHours": { + "target": "com.amazonaws.sagemaker#ReservedCapacityDurationHours", + "traits": { + "smithy.api#documentation": "

The number of whole hours in the total duration for this reserved capacity.

" + } + }, + "DurationMinutes": { + "target": "com.amazonaws.sagemaker#ReservedCapacityDurationMinutes", + "traits": { + "smithy.api#documentation": "

The additional minutes beyond whole hours in the total duration for this reserved\n capacity.

" + } + }, + "StartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The start time of the reserved capacity.

" + } + }, + "EndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The end time of the reserved capacity.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details of a reserved capacity for the training plan.

\n

For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using\n Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .

" + } + }, + "com.amazonaws.sagemaker#ResolvedAttributes": { + "type": "structure", + "members": { + "AutoMLJobObjective": { + "target": "com.amazonaws.sagemaker#AutoMLJobObjective" + }, + "ProblemType": { + "target": "com.amazonaws.sagemaker#ProblemType", + "traits": { + "smithy.api#documentation": "

The problem type.

" + } + }, + "CompletionCriteria": { + "target": "com.amazonaws.sagemaker#AutoMLJobCompletionCriteria" + } + }, + "traits": { + "smithy.api#documentation": "

The resolved attributes.

" + } + }, + "com.amazonaws.sagemaker#ResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z-]*:sagemaker:[a-z0-9-]*:[0-9]{12}:.+$" + } + }, + "com.amazonaws.sagemaker#ResourceCatalog": { + "type": "structure", + "members": { + "ResourceCatalogArn": { + "target": "com.amazonaws.sagemaker#ResourceCatalogArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the ResourceCatalog.

", + "smithy.api#required": {} + } + }, + "ResourceCatalogName": { + "target": "com.amazonaws.sagemaker#ResourceCatalogName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the ResourceCatalog.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#ResourceCatalogDescription", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A free form description of the ResourceCatalog.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The time the ResourceCatalog was created.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A resource catalog containing all of the resources of a specific resource type within\n a resource owner account. For an example on sharing the Amazon SageMaker Feature Store\n DefaultFeatureGroupCatalog, see Share Amazon SageMaker Catalog resource type in the Amazon SageMaker Developer Guide.\n

" + } + }, + "com.amazonaws.sagemaker#ResourceCatalogArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:sagemaker-catalog/" + } + }, + "com.amazonaws.sagemaker#ResourceCatalogDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.sagemaker#ResourceCatalogList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ResourceCatalog" + } + }, + "com.amazonaws.sagemaker#ResourceCatalogName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.sagemaker#ResourceCatalogSortBy": { + "type": "enum", + "members": { + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + } + } + }, + "com.amazonaws.sagemaker#ResourceCatalogSortOrder": { + "type": "enum", + "members": { + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ascending" + } + }, + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Descending" + } + } + } + }, + "com.amazonaws.sagemaker#ResourceConfig": { + "type": "structure", + "members": { + "InstanceType": { + "target": "com.amazonaws.sagemaker#TrainingInstanceType", + "traits": { + "smithy.api#documentation": "

The ML compute instance type.

\n \n

SageMaker Training on Amazon Elastic Compute Cloud (EC2) P4de instances is in preview release starting\n December 9th, 2022.

\n

\n Amazon EC2 P4de instances\n (currently in preview) are powered by 8 NVIDIA A100 GPUs with 80GB high-performance\n HBM2e GPU memory, which accelerate the speed of training ML models that need to be\n trained on large datasets of high-resolution data. In this preview release, Amazon SageMaker\n supports ML training jobs on P4de instances (ml.p4de.24xlarge) to\n reduce model training time. The ml.p4de.24xlarge instances are\n available in the following Amazon Web Services Regions.

\n
    \n
  • \n

    US East (N. Virginia) (us-east-1)

    \n
    • \n
  • \n

    US West (Oregon) (us-west-2)

    \n
    • \n
\n

To request quota limit increase and start using P4de instances, contact the SageMaker\n Training service team through your account team.

\n " + } + }, + "InstanceCount": { + "target": "com.amazonaws.sagemaker#TrainingInstanceCount", + "traits": { + "smithy.api#documentation": "

The number of ML compute instances to use. For distributed training, provide a\n value greater than 1.

" + } + }, + "VolumeSizeInGB": { + "target": "com.amazonaws.sagemaker#VolumeSizeInGB", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The size of the ML storage volume that you want to provision.

\n

ML storage volumes store model artifacts and incremental states. Training\n algorithms might also use the ML storage volume for scratch space. If you want to store\n the training data in the ML storage volume, choose File as the\n TrainingInputMode in the algorithm specification.

\n

When using an ML instance with NVMe SSD\n volumes, SageMaker doesn't provision Amazon EBS General Purpose SSD (gp2) storage.\n Available storage is fixed to the NVMe-type instance's storage capacity. SageMaker configures\n storage paths for training datasets, checkpoints, model artifacts, and outputs to use\n the entire capacity of the instance storage. For example, ML instance families with the\n NVMe-type instance storage include ml.p4d, ml.g4dn, and\n ml.g5.

\n

When using an ML instance with the EBS-only storage option and without instance\n storage, you must define the size of EBS volume through VolumeSizeInGB in\n the ResourceConfig API. For example, ML instance families that use EBS\n volumes include ml.c5 and ml.p2.

\n

To look up instance types and their instance storage types and volumes, see Amazon EC2 Instance Types.

\n

To find the default local paths defined by the SageMaker training platform, see Amazon SageMaker\n Training Storage Folders for Training Datasets, Checkpoints, Model Artifacts, and\n Outputs.

", + "smithy.api#required": {} + } + }, + "VolumeKmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key that SageMaker uses to encrypt data on the storage volume\n attached to the ML compute instance(s) that run the training job.

\n \n

Certain Nitro-based instances include local storage, dependent on the instance\n type. Local storage volumes are encrypted using a hardware module on the instance.\n You can't request a VolumeKmsKeyId when using an instance type with\n local storage.

\n

For a list of instance types that support local instance storage, see Instance Store Volumes.

\n

For more information about local instance storage encryption, see SSD\n Instance Store Volumes.

\n \n

The VolumeKmsKeyId can be in any of the following formats:

\n
    \n
  • \n

    // KMS Key ID

    \n

    \n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    // Amazon Resource Name (ARN) of a KMS Key

    \n

    \n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
" + } + }, + "KeepAlivePeriodInSeconds": { + "target": "com.amazonaws.sagemaker#KeepAlivePeriodInSeconds", + "traits": { + "smithy.api#documentation": "

The duration of time in seconds to retain configured resources in a warm pool for\n subsequent training jobs.

" + } + }, + "InstanceGroups": { + "target": "com.amazonaws.sagemaker#InstanceGroups", + "traits": { + "smithy.api#documentation": "

The configuration of a heterogeneous cluster in JSON format.

" + } + }, + "TrainingPlanArn": { + "target": "com.amazonaws.sagemaker#TrainingPlanArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN); of the training plan to use for this resource configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the resources, including machine learning (ML) compute instances and ML\n storage volumes, to use for model training.

" + } + }, + "com.amazonaws.sagemaker#ResourceConfigForUpdate": { + "type": "structure", + "members": { + "KeepAlivePeriodInSeconds": { + "target": "com.amazonaws.sagemaker#KeepAlivePeriodInSeconds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The KeepAlivePeriodInSeconds value specified in the\n ResourceConfig to update.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The ResourceConfig to update KeepAlivePeriodInSeconds. Other\n fields in the ResourceConfig cannot be updated.

" + } + }, + "com.amazonaws.sagemaker#ResourceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + } + } + }, + "com.amazonaws.sagemaker#ResourceInUse": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.sagemaker#FailureReason" + } + }, + "traits": { + "smithy.api#documentation": "

Resource being accessed is in use.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.sagemaker#ResourceLimitExceeded": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.sagemaker#FailureReason" + } + }, + "traits": { + "smithy.api#documentation": "

You have exceeded an SageMaker resource limit. For example, you might have too many\n training jobs created.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.sagemaker#ResourceLimits": { + "type": "structure", + "members": { + "MaxNumberOfTrainingJobs": { + "target": "com.amazonaws.sagemaker#MaxNumberOfTrainingJobs", + "traits": { + "smithy.api#documentation": "

The maximum number of training jobs that a hyperparameter tuning job can\n launch.

" + } + }, + "MaxParallelTrainingJobs": { + "target": "com.amazonaws.sagemaker#MaxParallelTrainingJobs", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The maximum number of concurrent training jobs that a hyperparameter tuning job can\n launch.

", + "smithy.api#required": {} + } + }, + "MaxRuntimeInSeconds": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningMaxRuntimeInSeconds", + "traits": { + "smithy.api#documentation": "

The maximum time in seconds that a hyperparameter tuning job can run.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the maximum number of training jobs and parallel training jobs that a\n hyperparameter tuning job can launch.

" + } + }, + "com.amazonaws.sagemaker#ResourceNotFound": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.sagemaker#FailureReason" + } + }, + "traits": { + "smithy.api#documentation": "

Resource being access is not found.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.sagemaker#ResourcePolicyString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20480 + }, + "smithy.api#pattern": "(?:[ \\r\\n\\t].*)*$" + } + }, + "com.amazonaws.sagemaker#ResourcePropertyName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.sagemaker#ResourceRetainedBillableTimeInSeconds": { + "type": "integer", + "traits": { + "smithy.api#documentation": "Optional. Indicates how many seconds the resource stayed in ResourceRetained state. Populated only after\n resource reaches ResourceReused or ResourceReleased state.", + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.sagemaker#ResourceSharingConfig": { + "type": "structure", + "members": { + "Strategy": { + "target": "com.amazonaws.sagemaker#ResourceSharingStrategy", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The strategy of how idle compute is shared within the cluster. The following are the\n options of strategies.

\n
    \n
  • \n

    \n DontLend: entities do not lend idle compute.

    \n
    • \n
  • \n

    \n Lend: entities can lend idle compute to entities that can\n borrow.

    \n
    • \n
  • \n

    \n LendandBorrow: entities can lend idle compute and borrow idle compute\n from other entities.

    \n
    • \n
\n

Default is LendandBorrow.

", + "smithy.api#required": {} + } + }, + "BorrowLimit": { + "target": "com.amazonaws.sagemaker#BorrowLimit", + "traits": { + "smithy.api#documentation": "

The limit on how much idle compute can be borrowed.The values can be 1 - 500 percent of\n idle compute that the team is allowed to borrow.

\n

Default is 50.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Resource sharing configuration.

" + } + }, + "com.amazonaws.sagemaker#ResourceSharingStrategy": { + "type": "enum", + "members": { + "LEND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Lend" + } + }, + "DONTLEND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DontLend" + } + }, + "LENDANDBORROW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LendAndBorrow" + } + } + } + }, + "com.amazonaws.sagemaker#ResourceSpec": { + "type": "structure", + "members": { + "SageMakerImageArn": { + "target": "com.amazonaws.sagemaker#ImageArn", + "traits": { + "smithy.api#documentation": "

The ARN of the SageMaker AI image that the image version belongs to.

" + } + }, + "SageMakerImageVersionArn": { + "target": "com.amazonaws.sagemaker#ImageVersionArn", + "traits": { + "smithy.api#documentation": "

The ARN of the image version created on the instance.

" + } + }, + "SageMakerImageVersionAlias": { + "target": "com.amazonaws.sagemaker#ImageVersionAlias", + "traits": { + "smithy.api#documentation": "

The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.

" + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#AppInstanceType", + "traits": { + "smithy.api#documentation": "

The instance type that the image version runs on.

\n \n

\n JupyterServer apps only support the system value.

\n

For KernelGateway apps, the system\n value is translated to ml.t3.medium. KernelGateway apps also support all other values for available\n instance types.

\n " + } + }, + "LifecycleConfigArn": { + "target": "com.amazonaws.sagemaker#StudioLifecycleConfigArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the\n Resource.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the ARN's of a SageMaker AI image and SageMaker AI image version, and the instance type that\n the version runs on.

" + } + }, + "com.amazonaws.sagemaker#ResourceType": { + "type": "enum", + "members": { + "TRAINING_JOB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TrainingJob" + } + }, + "EXPERIMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Experiment" + } + }, + "EXPERIMENT_TRIAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ExperimentTrial" + } + }, + "EXPERIMENT_TRIAL_COMPONENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ExperimentTrialComponent" + } + }, + "ENDPOINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Endpoint" + } + }, + "MODEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Model" + } + }, + "MODEL_PACKAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ModelPackage" + } + }, + "MODEL_PACKAGE_GROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ModelPackageGroup" + } + }, + "PIPELINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pipeline" + } + }, + "PIPELINE_EXECUTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PipelineExecution" + } + }, + "FEATURE_GROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FeatureGroup" + } + }, + "FEATURE_METADATA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FeatureMetadata" + } + }, + "IMAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Image" + } + }, + "IMAGE_VERSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ImageVersion" + } + }, + "PROJECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Project" + } + }, + "HYPER_PARAMETER_TUNING_JOB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HyperParameterTuningJob" + } + }, + "MODEL_CARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ModelCard" + } + } + } + }, + "com.amazonaws.sagemaker#ResponseMIMEType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^[-\\w]+\\/.+$" + } + }, + "com.amazonaws.sagemaker#ResponseMIMETypes": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ResponseMIMEType" + } + }, + "com.amazonaws.sagemaker#RetentionPolicy": { + "type": "structure", + "members": { + "HomeEfsFileSystem": { + "target": "com.amazonaws.sagemaker#RetentionType", + "traits": { + "smithy.api#documentation": "

The default is Retain, which specifies to keep the data stored on the\n Amazon EFS volume.

\n

Specify Delete to delete the data stored on the Amazon EFS\n volume.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The retention policy for data stored on an Amazon Elastic File System volume.

" + } + }, + "com.amazonaws.sagemaker#RetentionType": { + "type": "enum", + "members": { + "Retain": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Retain" + } + }, + "Delete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Delete" + } + } + } + }, + "com.amazonaws.sagemaker#RetryPipelineExecution": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#RetryPipelineExecutionRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#RetryPipelineExecutionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Retry the execution of the pipeline.

" + } + }, + "com.amazonaws.sagemaker#RetryPipelineExecutionRequest": { + "type": "structure", + "members": { + "PipelineExecutionArn": { + "target": "com.amazonaws.sagemaker#PipelineExecutionArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the pipeline execution.

", + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.sagemaker#IdempotencyToken", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n operation. An idempotent operation completes no more than once.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "ParallelismConfiguration": { + "target": "com.amazonaws.sagemaker#ParallelismConfiguration", + "traits": { + "smithy.api#documentation": "

This configuration, if specified, overrides the parallelism configuration \n of the parent pipeline.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#RetryPipelineExecutionResponse": { + "type": "structure", + "members": { + "PipelineExecutionArn": { + "target": "com.amazonaws.sagemaker#PipelineExecutionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the pipeline execution.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#RetryStrategy": { + "type": "structure", + "members": { + "MaximumRetryAttempts": { + "target": "com.amazonaws.sagemaker#MaximumRetryAttempts", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of times to retry the job. When the job is retried, it's\n SecondaryStatus is changed to STARTING.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The retry strategy to use when a training job fails due to an\n InternalServerError. RetryStrategy is specified as part of\n the CreateTrainingJob and CreateHyperParameterTuningJob\n requests. You can add the StoppingCondition parameter to the request to\n limit the training time for the complete job.

" + } + }, + "com.amazonaws.sagemaker#RoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$" + } + }, + "com.amazonaws.sagemaker#RollingUpdatePolicy": { + "type": "structure", + "members": { + "MaximumBatchSize": { + "target": "com.amazonaws.sagemaker#CapacitySize", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Batch size for each rolling step to provision capacity and turn on traffic on the new\n endpoint fleet, and terminate capacity on the old endpoint fleet. Value must be between\n 5% to 50% of the variant's total instance count.

", + "smithy.api#required": {} + } + }, + "WaitIntervalInSeconds": { + "target": "com.amazonaws.sagemaker#WaitIntervalInSeconds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The length of the baking period, during which SageMaker monitors alarms for each batch on\n the new fleet.

", + "smithy.api#required": {} + } + }, + "MaximumExecutionTimeoutInSeconds": { + "target": "com.amazonaws.sagemaker#MaximumExecutionTimeoutInSeconds", + "traits": { + "smithy.api#documentation": "

The time limit for the total deployment. Exceeding this limit causes a timeout.

" + } + }, + "RollbackMaximumBatchSize": { + "target": "com.amazonaws.sagemaker#CapacitySize", + "traits": { + "smithy.api#documentation": "

Batch size for rollback to the old endpoint fleet. Each rolling step to provision\n capacity and turn on traffic on the old endpoint fleet, and terminate capacity on the\n new endpoint fleet. If this field is absent, the default value will be set to 100% of\n total capacity which means to bring up the whole capacity of the old fleet at once\n during rollback.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies a rolling deployment strategy for updating a SageMaker endpoint.

" + } + }, + "com.amazonaws.sagemaker#RootAccess": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enabled" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disabled" + } + } + } + }, + "com.amazonaws.sagemaker#RoutingStrategy": { + "type": "enum", + "members": { + "LEAST_OUTSTANDING_REQUESTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LEAST_OUTSTANDING_REQUESTS" + } + }, + "RANDOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RANDOM" + } + } + } + }, + "com.amazonaws.sagemaker#RuleConfigurationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#RuleEvaluationStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "NO_ISSUES_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NoIssuesFound" + } + }, + "ISSUES_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IssuesFound" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Error" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + } + } + }, + "com.amazonaws.sagemaker#RuleParameters": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#ConfigKey" + }, + "value": { + "target": "com.amazonaws.sagemaker#ConfigValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#S3DataDistribution": { + "type": "enum", + "members": { + "FULLY_REPLICATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FullyReplicated" + } + }, + "SHARDED_BY_S3_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ShardedByS3Key" + } + } + } + }, + "com.amazonaws.sagemaker#S3DataSource": { + "type": "structure", + "members": { + "S3DataType": { + "target": "com.amazonaws.sagemaker#S3DataType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

If you choose S3Prefix, S3Uri identifies a key name prefix.\n SageMaker uses all objects that match the specified key name prefix for model training.

\n

If you choose ManifestFile, S3Uri identifies an object that\n is a manifest file containing a list of object keys that you want SageMaker to use for model\n training.

\n

If you choose AugmentedManifestFile, S3Uri identifies an object that is\n an augmented manifest file in JSON lines format. This file contains the data you want to\n use for model training. AugmentedManifestFile can only be used if the\n Channel's input mode is Pipe.

", + "smithy.api#required": {} + } + }, + "S3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Depending on the value specified for the S3DataType, identifies either\n a key name prefix or a manifest. For example:

\n
    \n
  • \n

    A key name prefix might look like this:\n s3://bucketname/exampleprefix/\n

    \n
    • \n
  • \n

    A manifest might look like this:\n s3://bucketname/example.manifest\n

    \n

    A manifest is an S3 object which is a JSON file consisting of an array of\n elements. The first element is a prefix which is followed by one or more\n suffixes. SageMaker appends the suffix elements to the prefix to get a full set of\n S3Uri. Note that the prefix must be a valid non-empty\n S3Uri that precludes users from specifying a manifest whose\n individual S3Uri is sourced from different S3 buckets.

    \n

    The following code example shows a valid manifest format:

    \n

    \n [ {\"prefix\": \"s3://customer_bucket/some/prefix/\"},\n

    \n

    \n \"relative/path/to/custdata-1\",\n

    \n

    \n \"relative/path/custdata-2\",\n

    \n

    \n ...\n

    \n

    \n \"relative/path/custdata-N\"\n

    \n

    \n ]\n

    \n

    This JSON is equivalent to the following S3Uri\n list:

    \n

    \n s3://customer_bucket/some/prefix/relative/path/to/custdata-1\n

    \n

    \n s3://customer_bucket/some/prefix/relative/path/custdata-2\n

    \n

    \n ...\n

    \n

    \n s3://customer_bucket/some/prefix/relative/path/custdata-N\n

    \n

    The complete set of S3Uri in this manifest is the input data\n for the channel for this data source. The object that each S3Uri\n points to must be readable by the IAM role that SageMaker uses to perform tasks on\n your behalf.

    \n
    • \n
\n

Your input bucket must be located in same Amazon Web Services region as your\n training job.

", + "smithy.api#required": {} + } + }, + "S3DataDistributionType": { + "target": "com.amazonaws.sagemaker#S3DataDistribution", + "traits": { + "smithy.api#documentation": "

If you want SageMaker to replicate the entire dataset on each ML compute instance that\n is launched for model training, specify FullyReplicated.

\n

If you want SageMaker to replicate a subset of data on each ML compute instance that is\n launched for model training, specify ShardedByS3Key. If there are\n n ML compute instances launched for a training job, each\n instance gets approximately 1/n of the number of S3 objects. In\n this case, model training on each machine uses only the subset of training data.

\n

Don't choose more ML compute instances for training than available S3 objects. If\n you do, some nodes won't get any data and you will pay for nodes that aren't getting any\n training data. This applies in both File and Pipe modes. Keep this in mind when\n developing algorithms.

\n

In distributed training, where you use multiple ML compute EC2 instances, you might\n choose ShardedByS3Key. If the algorithm requires copying training data to\n the ML storage volume (when TrainingInputMode is set to File),\n this copies 1/n of the number of objects.

" + } + }, + "AttributeNames": { + "target": "com.amazonaws.sagemaker#AttributeNames", + "traits": { + "smithy.api#documentation": "

A list of one or more attribute names to use that are found in a specified augmented\n manifest file.

" + } + }, + "InstanceGroupNames": { + "target": "com.amazonaws.sagemaker#InstanceGroupNames", + "traits": { + "smithy.api#documentation": "

A list of names of instance groups that get data from the S3 data source.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the S3 data source.

\n

Your input bucket must be in the same Amazon Web Services region as your training\n job.

" + } + }, + "com.amazonaws.sagemaker#S3DataType": { + "type": "enum", + "members": { + "MANIFEST_FILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ManifestFile" + } + }, + "S3_PREFIX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3Prefix" + } + }, + "AUGMENTED_MANIFEST_FILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AugmentedManifestFile" + } + } + } + }, + "com.amazonaws.sagemaker#S3ModelDataSource": { + "type": "structure", + "members": { + "S3Uri": { + "target": "com.amazonaws.sagemaker#S3ModelUri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies the S3 path of ML model data to deploy.

", + "smithy.api#required": {} + } + }, + "S3DataType": { + "target": "com.amazonaws.sagemaker#S3ModelDataType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies the type of ML model data to deploy.

\n

If you choose S3Prefix, S3Uri identifies a key name prefix.\n SageMaker uses all objects that match the specified key name prefix as part of the ML model\n data to deploy. A valid key name prefix identified by S3Uri always ends\n with a forward slash (/).

\n

If you choose S3Object, S3Uri identifies an object that is\n the ML model data to deploy.

", + "smithy.api#required": {} + } + }, + "CompressionType": { + "target": "com.amazonaws.sagemaker#ModelCompressionType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies how the ML model data is prepared.

\n

If you choose Gzip and choose S3Object as the value of\n S3DataType, S3Uri identifies an object that is a\n gzip-compressed TAR archive. SageMaker will attempt to decompress and untar the object during\n model deployment.

\n

If you choose None and chooose S3Object as the value of\n S3DataType, S3Uri identifies an object that represents an\n uncompressed ML model to deploy.

\n

If you choose None and choose S3Prefix as the value of\n S3DataType, S3Uri identifies a key name prefix, under\n which all objects represents the uncompressed ML model to deploy.

\n

If you choose None, then SageMaker will follow rules below when creating model data files\n under /opt/ml/model directory for use by your inference code:

\n
    \n
  • \n

    If you choose S3Object as the value of S3DataType,\n then SageMaker will split the key of the S3 object referenced by S3Uri\n by slash (/), and use the last part as the filename of the file holding the\n content of the S3 object.

    \n
    • \n
  • \n

    If you choose S3Prefix as the value of S3DataType,\n then for each S3 object under the key name pefix referenced by\n S3Uri, SageMaker will trim its key by the prefix, and use the\n remainder as the path (relative to /opt/ml/model) of the file\n holding the content of the S3 object. SageMaker will split the remainder by slash\n (/), using intermediate parts as directory names and the last part as filename\n of the file holding the content of the S3 object.

    \n
    • \n
  • \n

    Do not use any of the following as file names or directory names:

    \n
      \n
    • \n

      An empty or blank string

      \n
      • \n
    • \n

      A string which contains null bytes

      \n
      • \n
    • \n

      A string longer than 255 bytes

      \n
      • \n
    • \n

      A single dot (.)

      \n
      • \n
    • \n

      A double dot (..)

      \n
      • \n
    \n
    • \n
  • \n

    Ambiguous file names will result in model deployment failure. For example, if\n your uncompressed ML model consists of two S3 objects\n s3://mybucket/model/weights and\n s3://mybucket/model/weights/part1 and you specify\n s3://mybucket/model/ as the value of S3Uri and\n S3Prefix as the value of S3DataType, then it will\n result in name clash between /opt/ml/model/weights (a regular file)\n and /opt/ml/model/weights/ (a directory).

    \n
    • \n
  • \n

    Do not organize the model artifacts in S3 console using\n folders. When you create a folder in S3 console, S3 creates a 0-byte\n object with a key set to the folder name you provide. They key of the 0-byte\n object ends with a slash (/) which violates SageMaker restrictions on model artifact\n file names, leading to model deployment failure.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "ModelAccessConfig": { + "target": "com.amazonaws.sagemaker#ModelAccessConfig", + "traits": { + "smithy.api#documentation": "

Specifies the access configuration file for the ML model. You can explicitly accept the\n model end-user license agreement (EULA) within the ModelAccessConfig. You are\n responsible for reviewing and complying with any applicable license terms and making sure\n they are acceptable for your use case before downloading or using a model.

" + } + }, + "HubAccessConfig": { + "target": "com.amazonaws.sagemaker#InferenceHubAccessConfig", + "traits": { + "smithy.api#documentation": "

Configuration information for hub access.

" + } + }, + "ManifestS3Uri": { + "target": "com.amazonaws.sagemaker#S3ModelUri", + "traits": { + "smithy.api#documentation": "

The Amazon S3 URI of the manifest file. The manifest file is a CSV file that stores the\n artifact locations.

" + } + }, + "ETag": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The ETag associated with S3 URI.

" + } + }, + "ManifestEtag": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The ETag associated with Manifest S3 URI.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the S3 location of ML model data to deploy.

" + } + }, + "com.amazonaws.sagemaker#S3ModelDataType": { + "type": "enum", + "members": { + "S3Prefix": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3Prefix" + } + }, + "S3Object": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3Object" + } + } + } + }, + "com.amazonaws.sagemaker#S3ModelUri": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^(https|s3)://([^/]+)/?(.*)$" + } + }, + "com.amazonaws.sagemaker#S3OutputPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^(https|s3)://([^/]+)/?(.*)$" + } + }, + "com.amazonaws.sagemaker#S3Presign": { + "type": "structure", + "members": { + "IamPolicyConstraints": { + "target": "com.amazonaws.sagemaker#IamPolicyConstraints", + "traits": { + "smithy.api#documentation": "

Use this parameter to specify the allowed request source. Possible sources are either SourceIp or VpcSourceIp.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This object defines the access restrictions to Amazon S3 resources that are included in custom worker task templates using the Liquid filter, grant_read_access.

\n

To learn more about how custom templates are created, see Create custom worker task templates.

" + } + }, + "com.amazonaws.sagemaker#S3StorageConfig": { + "type": "structure", + "members": { + "S3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The S3 URI, or location in Amazon S3, of OfflineStore.

\n

S3 URIs have a format similar to the following:\n s3://example-bucket/prefix/.

", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Key Management Service (KMS) key ARN of the key used to encrypt\n any objects written into the OfflineStore S3 location.

\n

The IAM roleARN that is passed as a parameter to\n CreateFeatureGroup must have below permissions to the\n KmsKeyId:

\n
    \n
  • \n

    \n \"kms:GenerateDataKey\"\n

    \n
    • \n
" + } + }, + "ResolvedOutputS3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "

The S3 path where offline records are written.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon Simple Storage (Amazon S3) location and security configuration for\n OfflineStore.

" + } + }, + "com.amazonaws.sagemaker#S3Uri": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^(https|s3)://([^/]+)/?(.*)$" + } + }, + "com.amazonaws.sagemaker#SageMaker": { + "type": "service", + "version": "2017-07-24", + "operations": [ + { + "target": "com.amazonaws.sagemaker#AddAssociation" + }, + { + "target": "com.amazonaws.sagemaker#AddTags" + }, + { + "target": "com.amazonaws.sagemaker#AssociateTrialComponent" + }, + { + "target": "com.amazonaws.sagemaker#BatchDeleteClusterNodes" + }, + { + "target": "com.amazonaws.sagemaker#BatchDescribeModelPackage" + }, + { + "target": "com.amazonaws.sagemaker#CreateAction" + }, + { + "target": "com.amazonaws.sagemaker#CreateAlgorithm" + }, + { + "target": "com.amazonaws.sagemaker#CreateApp" + }, + { + "target": "com.amazonaws.sagemaker#CreateAppImageConfig" + }, + { + "target": "com.amazonaws.sagemaker#CreateArtifact" + }, + { + "target": "com.amazonaws.sagemaker#CreateAutoMLJob" + }, + { + "target": "com.amazonaws.sagemaker#CreateAutoMLJobV2" + }, + { + "target": "com.amazonaws.sagemaker#CreateCluster" + }, + { + "target": "com.amazonaws.sagemaker#CreateClusterSchedulerConfig" + }, + { + "target": "com.amazonaws.sagemaker#CreateCodeRepository" + }, + { + "target": "com.amazonaws.sagemaker#CreateCompilationJob" + }, + { + "target": "com.amazonaws.sagemaker#CreateComputeQuota" + }, + { + "target": "com.amazonaws.sagemaker#CreateContext" + }, + { + "target": "com.amazonaws.sagemaker#CreateDataQualityJobDefinition" + }, + { + "target": "com.amazonaws.sagemaker#CreateDeviceFleet" + }, + { + "target": "com.amazonaws.sagemaker#CreateDomain" + }, + { + "target": "com.amazonaws.sagemaker#CreateEdgeDeploymentPlan" + }, + { + "target": "com.amazonaws.sagemaker#CreateEdgeDeploymentStage" + }, + { + "target": "com.amazonaws.sagemaker#CreateEdgePackagingJob" + }, + { + "target": "com.amazonaws.sagemaker#CreateEndpoint" + }, + { + "target": "com.amazonaws.sagemaker#CreateEndpointConfig" + }, + { + "target": "com.amazonaws.sagemaker#CreateExperiment" + }, + { + "target": "com.amazonaws.sagemaker#CreateFeatureGroup" + }, + { + "target": "com.amazonaws.sagemaker#CreateFlowDefinition" + }, + { + "target": "com.amazonaws.sagemaker#CreateHub" + }, + { + "target": "com.amazonaws.sagemaker#CreateHubContentReference" + }, + { + "target": "com.amazonaws.sagemaker#CreateHumanTaskUi" + }, + { + "target": "com.amazonaws.sagemaker#CreateHyperParameterTuningJob" + }, + { + "target": "com.amazonaws.sagemaker#CreateImage" + }, + { + "target": "com.amazonaws.sagemaker#CreateImageVersion" + }, + { + "target": "com.amazonaws.sagemaker#CreateInferenceComponent" + }, + { + "target": "com.amazonaws.sagemaker#CreateInferenceExperiment" + }, + { + "target": "com.amazonaws.sagemaker#CreateInferenceRecommendationsJob" + }, + { + "target": "com.amazonaws.sagemaker#CreateLabelingJob" + }, + { + "target": "com.amazonaws.sagemaker#CreateMlflowTrackingServer" + }, + { + "target": "com.amazonaws.sagemaker#CreateModel" + }, + { + "target": "com.amazonaws.sagemaker#CreateModelBiasJobDefinition" + }, + { + "target": "com.amazonaws.sagemaker#CreateModelCard" + }, + { + "target": "com.amazonaws.sagemaker#CreateModelCardExportJob" + }, + { + "target": "com.amazonaws.sagemaker#CreateModelExplainabilityJobDefinition" + }, + { + "target": "com.amazonaws.sagemaker#CreateModelPackage" + }, + { + "target": "com.amazonaws.sagemaker#CreateModelPackageGroup" + }, + { + "target": "com.amazonaws.sagemaker#CreateModelQualityJobDefinition" + }, + { + "target": "com.amazonaws.sagemaker#CreateMonitoringSchedule" + }, + { + "target": "com.amazonaws.sagemaker#CreateNotebookInstance" + }, + { + "target": "com.amazonaws.sagemaker#CreateNotebookInstanceLifecycleConfig" + }, + { + "target": "com.amazonaws.sagemaker#CreateOptimizationJob" + }, + { + "target": "com.amazonaws.sagemaker#CreatePartnerApp" + }, + { + "target": "com.amazonaws.sagemaker#CreatePartnerAppPresignedUrl" + }, + { + "target": "com.amazonaws.sagemaker#CreatePipeline" + }, + { + "target": "com.amazonaws.sagemaker#CreatePresignedDomainUrl" + }, + { + "target": "com.amazonaws.sagemaker#CreatePresignedMlflowTrackingServerUrl" + }, + { + "target": "com.amazonaws.sagemaker#CreatePresignedNotebookInstanceUrl" + }, + { + "target": "com.amazonaws.sagemaker#CreateProcessingJob" + }, + { + "target": "com.amazonaws.sagemaker#CreateProject" + }, + { + "target": "com.amazonaws.sagemaker#CreateSpace" + }, + { + "target": "com.amazonaws.sagemaker#CreateStudioLifecycleConfig" + }, + { + "target": "com.amazonaws.sagemaker#CreateTrainingJob" + }, + { + "target": "com.amazonaws.sagemaker#CreateTrainingPlan" + }, + { + "target": "com.amazonaws.sagemaker#CreateTransformJob" + }, + { + "target": "com.amazonaws.sagemaker#CreateTrial" + }, + { + "target": "com.amazonaws.sagemaker#CreateTrialComponent" + }, + { + "target": "com.amazonaws.sagemaker#CreateUserProfile" + }, + { + "target": "com.amazonaws.sagemaker#CreateWorkforce" + }, + { + "target": "com.amazonaws.sagemaker#CreateWorkteam" + }, + { + "target": "com.amazonaws.sagemaker#DeleteAction" + }, + { + "target": "com.amazonaws.sagemaker#DeleteAlgorithm" + }, + { + "target": "com.amazonaws.sagemaker#DeleteApp" + }, + { + "target": "com.amazonaws.sagemaker#DeleteAppImageConfig" + }, + { + "target": "com.amazonaws.sagemaker#DeleteArtifact" + }, + { + "target": "com.amazonaws.sagemaker#DeleteAssociation" + }, + { + "target": "com.amazonaws.sagemaker#DeleteCluster" + }, + { + "target": "com.amazonaws.sagemaker#DeleteClusterSchedulerConfig" + }, + { + "target": "com.amazonaws.sagemaker#DeleteCodeRepository" + }, + { + "target": "com.amazonaws.sagemaker#DeleteCompilationJob" + }, + { + "target": "com.amazonaws.sagemaker#DeleteComputeQuota" + }, + { + "target": "com.amazonaws.sagemaker#DeleteContext" + }, + { + "target": "com.amazonaws.sagemaker#DeleteDataQualityJobDefinition" + }, + { + "target": "com.amazonaws.sagemaker#DeleteDeviceFleet" + }, + { + "target": "com.amazonaws.sagemaker#DeleteDomain" + }, + { + "target": "com.amazonaws.sagemaker#DeleteEdgeDeploymentPlan" + }, + { + "target": "com.amazonaws.sagemaker#DeleteEdgeDeploymentStage" + }, + { + "target": "com.amazonaws.sagemaker#DeleteEndpoint" + }, + { + "target": "com.amazonaws.sagemaker#DeleteEndpointConfig" + }, + { + "target": "com.amazonaws.sagemaker#DeleteExperiment" + }, + { + "target": "com.amazonaws.sagemaker#DeleteFeatureGroup" + }, + { + "target": "com.amazonaws.sagemaker#DeleteFlowDefinition" + }, + { + "target": "com.amazonaws.sagemaker#DeleteHub" + }, + { + "target": "com.amazonaws.sagemaker#DeleteHubContent" + }, + { + "target": "com.amazonaws.sagemaker#DeleteHubContentReference" + }, + { + "target": "com.amazonaws.sagemaker#DeleteHumanTaskUi" + }, + { + "target": "com.amazonaws.sagemaker#DeleteHyperParameterTuningJob" + }, + { + "target": "com.amazonaws.sagemaker#DeleteImage" + }, + { + "target": "com.amazonaws.sagemaker#DeleteImageVersion" + }, + { + "target": "com.amazonaws.sagemaker#DeleteInferenceComponent" + }, + { + "target": "com.amazonaws.sagemaker#DeleteInferenceExperiment" + }, + { + "target": "com.amazonaws.sagemaker#DeleteMlflowTrackingServer" + }, + { + "target": "com.amazonaws.sagemaker#DeleteModel" + }, + { + "target": "com.amazonaws.sagemaker#DeleteModelBiasJobDefinition" + }, + { + "target": "com.amazonaws.sagemaker#DeleteModelCard" + }, + { + "target": "com.amazonaws.sagemaker#DeleteModelExplainabilityJobDefinition" + }, + { + "target": "com.amazonaws.sagemaker#DeleteModelPackage" + }, + { + "target": "com.amazonaws.sagemaker#DeleteModelPackageGroup" + }, + { + "target": "com.amazonaws.sagemaker#DeleteModelPackageGroupPolicy" + }, + { + "target": "com.amazonaws.sagemaker#DeleteModelQualityJobDefinition" + }, + { + "target": "com.amazonaws.sagemaker#DeleteMonitoringSchedule" + }, + { + "target": "com.amazonaws.sagemaker#DeleteNotebookInstance" + }, + { + "target": "com.amazonaws.sagemaker#DeleteNotebookInstanceLifecycleConfig" + }, + { + "target": "com.amazonaws.sagemaker#DeleteOptimizationJob" + }, + { + "target": "com.amazonaws.sagemaker#DeletePartnerApp" + }, + { + "target": "com.amazonaws.sagemaker#DeletePipeline" + }, + { + "target": "com.amazonaws.sagemaker#DeleteProject" + }, + { + "target": "com.amazonaws.sagemaker#DeleteSpace" + }, + { + "target": "com.amazonaws.sagemaker#DeleteStudioLifecycleConfig" + }, + { + "target": "com.amazonaws.sagemaker#DeleteTags" + }, + { + "target": "com.amazonaws.sagemaker#DeleteTrial" + }, + { + "target": "com.amazonaws.sagemaker#DeleteTrialComponent" + }, + { + "target": "com.amazonaws.sagemaker#DeleteUserProfile" + }, + { + "target": "com.amazonaws.sagemaker#DeleteWorkforce" + }, + { + "target": "com.amazonaws.sagemaker#DeleteWorkteam" + }, + { + "target": "com.amazonaws.sagemaker#DeregisterDevices" + }, + { + "target": "com.amazonaws.sagemaker#DescribeAction" + }, + { + "target": "com.amazonaws.sagemaker#DescribeAlgorithm" + }, + { + "target": "com.amazonaws.sagemaker#DescribeApp" + }, + { + "target": "com.amazonaws.sagemaker#DescribeAppImageConfig" + }, + { + "target": "com.amazonaws.sagemaker#DescribeArtifact" + }, + { + "target": "com.amazonaws.sagemaker#DescribeAutoMLJob" + }, + { + "target": "com.amazonaws.sagemaker#DescribeAutoMLJobV2" + }, + { + "target": "com.amazonaws.sagemaker#DescribeCluster" + }, + { + "target": "com.amazonaws.sagemaker#DescribeClusterNode" + }, + { + "target": "com.amazonaws.sagemaker#DescribeClusterSchedulerConfig" + }, + { + "target": "com.amazonaws.sagemaker#DescribeCodeRepository" + }, + { + "target": "com.amazonaws.sagemaker#DescribeCompilationJob" + }, + { + "target": "com.amazonaws.sagemaker#DescribeComputeQuota" + }, + { + "target": "com.amazonaws.sagemaker#DescribeContext" + }, + { + "target": "com.amazonaws.sagemaker#DescribeDataQualityJobDefinition" + }, + { + "target": "com.amazonaws.sagemaker#DescribeDevice" + }, + { + "target": "com.amazonaws.sagemaker#DescribeDeviceFleet" + }, + { + "target": "com.amazonaws.sagemaker#DescribeDomain" + }, + { + "target": "com.amazonaws.sagemaker#DescribeEdgeDeploymentPlan" + }, + { + "target": "com.amazonaws.sagemaker#DescribeEdgePackagingJob" + }, + { + "target": "com.amazonaws.sagemaker#DescribeEndpoint" + }, + { + "target": "com.amazonaws.sagemaker#DescribeEndpointConfig" + }, + { + "target": "com.amazonaws.sagemaker#DescribeExperiment" + }, + { + "target": "com.amazonaws.sagemaker#DescribeFeatureGroup" + }, + { + "target": "com.amazonaws.sagemaker#DescribeFeatureMetadata" + }, + { + "target": "com.amazonaws.sagemaker#DescribeFlowDefinition" + }, + { + "target": "com.amazonaws.sagemaker#DescribeHub" + }, + { + "target": "com.amazonaws.sagemaker#DescribeHubContent" + }, + { + "target": "com.amazonaws.sagemaker#DescribeHumanTaskUi" + }, + { + "target": "com.amazonaws.sagemaker#DescribeHyperParameterTuningJob" + }, + { + "target": "com.amazonaws.sagemaker#DescribeImage" + }, + { + "target": "com.amazonaws.sagemaker#DescribeImageVersion" + }, + { + "target": "com.amazonaws.sagemaker#DescribeInferenceComponent" + }, + { + "target": "com.amazonaws.sagemaker#DescribeInferenceExperiment" + }, + { + "target": "com.amazonaws.sagemaker#DescribeInferenceRecommendationsJob" + }, + { + "target": "com.amazonaws.sagemaker#DescribeLabelingJob" + }, + { + "target": "com.amazonaws.sagemaker#DescribeLineageGroup" + }, + { + "target": "com.amazonaws.sagemaker#DescribeMlflowTrackingServer" + }, + { + "target": "com.amazonaws.sagemaker#DescribeModel" + }, + { + "target": "com.amazonaws.sagemaker#DescribeModelBiasJobDefinition" + }, + { + "target": "com.amazonaws.sagemaker#DescribeModelCard" + }, + { + "target": "com.amazonaws.sagemaker#DescribeModelCardExportJob" + }, + { + "target": "com.amazonaws.sagemaker#DescribeModelExplainabilityJobDefinition" + }, + { + "target": "com.amazonaws.sagemaker#DescribeModelPackage" + }, + { + "target": "com.amazonaws.sagemaker#DescribeModelPackageGroup" + }, + { + "target": "com.amazonaws.sagemaker#DescribeModelQualityJobDefinition" + }, + { + "target": "com.amazonaws.sagemaker#DescribeMonitoringSchedule" + }, + { + "target": "com.amazonaws.sagemaker#DescribeNotebookInstance" + }, + { + "target": "com.amazonaws.sagemaker#DescribeNotebookInstanceLifecycleConfig" + }, + { + "target": "com.amazonaws.sagemaker#DescribeOptimizationJob" + }, + { + "target": "com.amazonaws.sagemaker#DescribePartnerApp" + }, + { + "target": "com.amazonaws.sagemaker#DescribePipeline" + }, + { + "target": "com.amazonaws.sagemaker#DescribePipelineDefinitionForExecution" + }, + { + "target": "com.amazonaws.sagemaker#DescribePipelineExecution" + }, + { + "target": "com.amazonaws.sagemaker#DescribeProcessingJob" + }, + { + "target": "com.amazonaws.sagemaker#DescribeProject" + }, + { + "target": "com.amazonaws.sagemaker#DescribeSpace" + }, + { + "target": "com.amazonaws.sagemaker#DescribeStudioLifecycleConfig" + }, + { + "target": "com.amazonaws.sagemaker#DescribeSubscribedWorkteam" + }, + { + "target": "com.amazonaws.sagemaker#DescribeTrainingJob" + }, + { + "target": "com.amazonaws.sagemaker#DescribeTrainingPlan" + }, + { + "target": "com.amazonaws.sagemaker#DescribeTransformJob" + }, + { + "target": "com.amazonaws.sagemaker#DescribeTrial" + }, + { + "target": "com.amazonaws.sagemaker#DescribeTrialComponent" + }, + { + "target": "com.amazonaws.sagemaker#DescribeUserProfile" + }, + { + "target": "com.amazonaws.sagemaker#DescribeWorkforce" + }, + { + "target": "com.amazonaws.sagemaker#DescribeWorkteam" + }, + { + "target": "com.amazonaws.sagemaker#DisableSagemakerServicecatalogPortfolio" + }, + { + "target": "com.amazonaws.sagemaker#DisassociateTrialComponent" + }, + { + "target": "com.amazonaws.sagemaker#EnableSagemakerServicecatalogPortfolio" + }, + { + "target": "com.amazonaws.sagemaker#GetDeviceFleetReport" + }, + { + "target": "com.amazonaws.sagemaker#GetLineageGroupPolicy" + }, + { + "target": "com.amazonaws.sagemaker#GetModelPackageGroupPolicy" + }, + { + "target": "com.amazonaws.sagemaker#GetSagemakerServicecatalogPortfolioStatus" + }, + { + "target": "com.amazonaws.sagemaker#GetScalingConfigurationRecommendation" + }, + { + "target": "com.amazonaws.sagemaker#GetSearchSuggestions" + }, + { + "target": "com.amazonaws.sagemaker#ImportHubContent" + }, + { + "target": "com.amazonaws.sagemaker#ListActions" + }, + { + "target": "com.amazonaws.sagemaker#ListAlgorithms" + }, + { + "target": "com.amazonaws.sagemaker#ListAliases" + }, + { + "target": "com.amazonaws.sagemaker#ListAppImageConfigs" + }, + { + "target": "com.amazonaws.sagemaker#ListApps" + }, + { + "target": "com.amazonaws.sagemaker#ListArtifacts" + }, + { + "target": "com.amazonaws.sagemaker#ListAssociations" + }, + { + "target": "com.amazonaws.sagemaker#ListAutoMLJobs" + }, + { + "target": "com.amazonaws.sagemaker#ListCandidatesForAutoMLJob" + }, + { + "target": "com.amazonaws.sagemaker#ListClusterNodes" + }, + { + "target": "com.amazonaws.sagemaker#ListClusters" + }, + { + "target": "com.amazonaws.sagemaker#ListClusterSchedulerConfigs" + }, + { + "target": "com.amazonaws.sagemaker#ListCodeRepositories" + }, + { + "target": "com.amazonaws.sagemaker#ListCompilationJobs" + }, + { + "target": "com.amazonaws.sagemaker#ListComputeQuotas" + }, + { + "target": "com.amazonaws.sagemaker#ListContexts" + }, + { + "target": "com.amazonaws.sagemaker#ListDataQualityJobDefinitions" + }, + { + "target": "com.amazonaws.sagemaker#ListDeviceFleets" + }, + { + "target": "com.amazonaws.sagemaker#ListDevices" + }, + { + "target": "com.amazonaws.sagemaker#ListDomains" + }, + { + "target": "com.amazonaws.sagemaker#ListEdgeDeploymentPlans" + }, + { + "target": "com.amazonaws.sagemaker#ListEdgePackagingJobs" + }, + { + "target": "com.amazonaws.sagemaker#ListEndpointConfigs" + }, + { + "target": "com.amazonaws.sagemaker#ListEndpoints" + }, + { + "target": "com.amazonaws.sagemaker#ListExperiments" + }, + { + "target": "com.amazonaws.sagemaker#ListFeatureGroups" + }, + { + "target": "com.amazonaws.sagemaker#ListFlowDefinitions" + }, + { + "target": "com.amazonaws.sagemaker#ListHubContents" + }, + { + "target": "com.amazonaws.sagemaker#ListHubContentVersions" + }, + { + "target": "com.amazonaws.sagemaker#ListHubs" + }, + { + "target": "com.amazonaws.sagemaker#ListHumanTaskUis" + }, + { + "target": "com.amazonaws.sagemaker#ListHyperParameterTuningJobs" + }, + { + "target": "com.amazonaws.sagemaker#ListImages" + }, + { + "target": "com.amazonaws.sagemaker#ListImageVersions" + }, + { + "target": "com.amazonaws.sagemaker#ListInferenceComponents" + }, + { + "target": "com.amazonaws.sagemaker#ListInferenceExperiments" + }, + { + "target": "com.amazonaws.sagemaker#ListInferenceRecommendationsJobs" + }, + { + "target": "com.amazonaws.sagemaker#ListInferenceRecommendationsJobSteps" + }, + { + "target": "com.amazonaws.sagemaker#ListLabelingJobs" + }, + { + "target": "com.amazonaws.sagemaker#ListLabelingJobsForWorkteam" + }, + { + "target": "com.amazonaws.sagemaker#ListLineageGroups" + }, + { + "target": "com.amazonaws.sagemaker#ListMlflowTrackingServers" + }, + { + "target": "com.amazonaws.sagemaker#ListModelBiasJobDefinitions" + }, + { + "target": "com.amazonaws.sagemaker#ListModelCardExportJobs" + }, + { + "target": "com.amazonaws.sagemaker#ListModelCards" + }, + { + "target": "com.amazonaws.sagemaker#ListModelCardVersions" + }, + { + "target": "com.amazonaws.sagemaker#ListModelExplainabilityJobDefinitions" + }, + { + "target": "com.amazonaws.sagemaker#ListModelMetadata" + }, + { + "target": "com.amazonaws.sagemaker#ListModelPackageGroups" + }, + { + "target": "com.amazonaws.sagemaker#ListModelPackages" + }, + { + "target": "com.amazonaws.sagemaker#ListModelQualityJobDefinitions" + }, + { + "target": "com.amazonaws.sagemaker#ListModels" + }, + { + "target": "com.amazonaws.sagemaker#ListMonitoringAlertHistory" + }, + { + "target": "com.amazonaws.sagemaker#ListMonitoringAlerts" + }, + { + "target": "com.amazonaws.sagemaker#ListMonitoringExecutions" + }, + { + "target": "com.amazonaws.sagemaker#ListMonitoringSchedules" + }, + { + "target": "com.amazonaws.sagemaker#ListNotebookInstanceLifecycleConfigs" + }, + { + "target": "com.amazonaws.sagemaker#ListNotebookInstances" + }, + { + "target": "com.amazonaws.sagemaker#ListOptimizationJobs" + }, + { + "target": "com.amazonaws.sagemaker#ListPartnerApps" + }, + { + "target": "com.amazonaws.sagemaker#ListPipelineExecutions" + }, + { + "target": "com.amazonaws.sagemaker#ListPipelineExecutionSteps" + }, + { + "target": "com.amazonaws.sagemaker#ListPipelineParametersForExecution" + }, + { + "target": "com.amazonaws.sagemaker#ListPipelines" + }, + { + "target": "com.amazonaws.sagemaker#ListProcessingJobs" + }, + { + "target": "com.amazonaws.sagemaker#ListProjects" + }, + { + "target": "com.amazonaws.sagemaker#ListResourceCatalogs" + }, + { + "target": "com.amazonaws.sagemaker#ListSpaces" + }, + { + "target": "com.amazonaws.sagemaker#ListStageDevices" + }, + { + "target": "com.amazonaws.sagemaker#ListStudioLifecycleConfigs" + }, + { + "target": "com.amazonaws.sagemaker#ListSubscribedWorkteams" + }, + { + "target": "com.amazonaws.sagemaker#ListTags" + }, + { + "target": "com.amazonaws.sagemaker#ListTrainingJobs" + }, + { + "target": "com.amazonaws.sagemaker#ListTrainingJobsForHyperParameterTuningJob" + }, + { + "target": "com.amazonaws.sagemaker#ListTrainingPlans" + }, + { + "target": "com.amazonaws.sagemaker#ListTransformJobs" + }, + { + "target": "com.amazonaws.sagemaker#ListTrialComponents" + }, + { + "target": "com.amazonaws.sagemaker#ListTrials" + }, + { + "target": "com.amazonaws.sagemaker#ListUserProfiles" + }, + { + "target": "com.amazonaws.sagemaker#ListWorkforces" + }, + { + "target": "com.amazonaws.sagemaker#ListWorkteams" + }, + { + "target": "com.amazonaws.sagemaker#PutModelPackageGroupPolicy" + }, + { + "target": "com.amazonaws.sagemaker#QueryLineage" + }, + { + "target": "com.amazonaws.sagemaker#RegisterDevices" + }, + { + "target": "com.amazonaws.sagemaker#RenderUiTemplate" + }, + { + "target": "com.amazonaws.sagemaker#RetryPipelineExecution" + }, + { + "target": "com.amazonaws.sagemaker#Search" + }, + { + "target": "com.amazonaws.sagemaker#SearchTrainingPlanOfferings" + }, + { + "target": "com.amazonaws.sagemaker#SendPipelineExecutionStepFailure" + }, + { + "target": "com.amazonaws.sagemaker#SendPipelineExecutionStepSuccess" + }, + { + "target": "com.amazonaws.sagemaker#StartEdgeDeploymentStage" + }, + { + "target": "com.amazonaws.sagemaker#StartInferenceExperiment" + }, + { + "target": "com.amazonaws.sagemaker#StartMlflowTrackingServer" + }, + { + "target": "com.amazonaws.sagemaker#StartMonitoringSchedule" + }, + { + "target": "com.amazonaws.sagemaker#StartNotebookInstance" + }, + { + "target": "com.amazonaws.sagemaker#StartPipelineExecution" + }, + { + "target": "com.amazonaws.sagemaker#StopAutoMLJob" + }, + { + "target": "com.amazonaws.sagemaker#StopCompilationJob" + }, + { + "target": "com.amazonaws.sagemaker#StopEdgeDeploymentStage" + }, + { + "target": "com.amazonaws.sagemaker#StopEdgePackagingJob" + }, + { + "target": "com.amazonaws.sagemaker#StopHyperParameterTuningJob" + }, + { + "target": "com.amazonaws.sagemaker#StopInferenceExperiment" + }, + { + "target": "com.amazonaws.sagemaker#StopInferenceRecommendationsJob" + }, + { + "target": "com.amazonaws.sagemaker#StopLabelingJob" + }, + { + "target": "com.amazonaws.sagemaker#StopMlflowTrackingServer" + }, + { + "target": "com.amazonaws.sagemaker#StopMonitoringSchedule" + }, + { + "target": "com.amazonaws.sagemaker#StopNotebookInstance" + }, + { + "target": "com.amazonaws.sagemaker#StopOptimizationJob" + }, + { + "target": "com.amazonaws.sagemaker#StopPipelineExecution" + }, + { + "target": "com.amazonaws.sagemaker#StopProcessingJob" + }, + { + "target": "com.amazonaws.sagemaker#StopTrainingJob" + }, + { + "target": "com.amazonaws.sagemaker#StopTransformJob" + }, + { + "target": "com.amazonaws.sagemaker#UpdateAction" + }, + { + "target": "com.amazonaws.sagemaker#UpdateAppImageConfig" + }, + { + "target": "com.amazonaws.sagemaker#UpdateArtifact" + }, + { + "target": "com.amazonaws.sagemaker#UpdateCluster" + }, + { + "target": "com.amazonaws.sagemaker#UpdateClusterSchedulerConfig" + }, + { + "target": "com.amazonaws.sagemaker#UpdateClusterSoftware" + }, + { + "target": "com.amazonaws.sagemaker#UpdateCodeRepository" + }, + { + "target": "com.amazonaws.sagemaker#UpdateComputeQuota" + }, + { + "target": "com.amazonaws.sagemaker#UpdateContext" + }, + { + "target": "com.amazonaws.sagemaker#UpdateDeviceFleet" + }, + { + "target": "com.amazonaws.sagemaker#UpdateDevices" + }, + { + "target": "com.amazonaws.sagemaker#UpdateDomain" + }, + { + "target": "com.amazonaws.sagemaker#UpdateEndpoint" + }, + { + "target": "com.amazonaws.sagemaker#UpdateEndpointWeightsAndCapacities" + }, + { + "target": "com.amazonaws.sagemaker#UpdateExperiment" + }, + { + "target": "com.amazonaws.sagemaker#UpdateFeatureGroup" + }, + { + "target": "com.amazonaws.sagemaker#UpdateFeatureMetadata" + }, + { + "target": "com.amazonaws.sagemaker#UpdateHub" + }, + { + "target": "com.amazonaws.sagemaker#UpdateImage" + }, + { + "target": "com.amazonaws.sagemaker#UpdateImageVersion" + }, + { + "target": "com.amazonaws.sagemaker#UpdateInferenceComponent" + }, + { + "target": "com.amazonaws.sagemaker#UpdateInferenceComponentRuntimeConfig" + }, + { + "target": "com.amazonaws.sagemaker#UpdateInferenceExperiment" + }, + { + "target": "com.amazonaws.sagemaker#UpdateMlflowTrackingServer" + }, + { + "target": "com.amazonaws.sagemaker#UpdateModelCard" + }, + { + "target": "com.amazonaws.sagemaker#UpdateModelPackage" + }, + { + "target": "com.amazonaws.sagemaker#UpdateMonitoringAlert" + }, + { + "target": "com.amazonaws.sagemaker#UpdateMonitoringSchedule" + }, + { + "target": "com.amazonaws.sagemaker#UpdateNotebookInstance" + }, + { + "target": "com.amazonaws.sagemaker#UpdateNotebookInstanceLifecycleConfig" + }, + { + "target": "com.amazonaws.sagemaker#UpdatePartnerApp" + }, + { + "target": "com.amazonaws.sagemaker#UpdatePipeline" + }, + { + "target": "com.amazonaws.sagemaker#UpdatePipelineExecution" + }, + { + "target": "com.amazonaws.sagemaker#UpdateProject" + }, + { + "target": "com.amazonaws.sagemaker#UpdateSpace" + }, + { + "target": "com.amazonaws.sagemaker#UpdateTrainingJob" + }, + { + "target": "com.amazonaws.sagemaker#UpdateTrial" + }, + { + "target": "com.amazonaws.sagemaker#UpdateTrialComponent" + }, + { + "target": "com.amazonaws.sagemaker#UpdateUserProfile" + }, + { + "target": "com.amazonaws.sagemaker#UpdateWorkforce" + }, + { + "target": "com.amazonaws.sagemaker#UpdateWorkteam" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "SageMaker", + "arnNamespace": "sagemaker", + "cloudFormationName": "SageMaker", + "cloudTrailEventSource": "sagemaker.amazonaws.com", + "endpointPrefix": "api.sagemaker" + }, + "aws.auth#sigv4": { + "name": "sagemaker" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "

Provides APIs for creating and managing SageMaker resources.

\n

Other Resources:

\n ", + "smithy.api#title": "Amazon SageMaker Service", + "smithy.api#xmlNamespace": { + "uri": "http://sagemaker.amazonaws.com/doc/2017-05-13/" + }, + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://api.sagemaker-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws" + ] + } + ], + "endpoint": { + "url": "https://api-fips.sagemaker.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-us-gov" + ] + } + ], + "endpoint": { + "url": "https://api.sagemaker.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://api.sagemaker-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://api.sagemaker.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://api.sagemaker.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.sagemaker.af-south-1.amazonaws.com" + } + }, + "params": { + "Region": "af-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.sagemaker.ap-east-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.sagemaker.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.sagemaker.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.sagemaker.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.sagemaker.ap-south-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.sagemaker.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.sagemaker.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.sagemaker.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.sagemaker.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.sagemaker.eu-north-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.sagemaker.eu-south-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.sagemaker.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.sagemaker.eu-west-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.sagemaker.eu-west-3.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.sagemaker.me-south-1.amazonaws.com" + } + }, + "params": { + "Region": "me-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.sagemaker.sa-east-1.amazonaws.com" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.sagemaker.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api-fips.sagemaker.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.sagemaker.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api-fips.sagemaker.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.sagemaker.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api-fips.sagemaker.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.sagemaker.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api-fips.sagemaker.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://api.sagemaker-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://api.sagemaker.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.sagemaker.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.sagemaker.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://api.sagemaker-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.sagemaker-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://api.sagemaker.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.sagemaker.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.sagemaker.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://api.sagemaker-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.sagemaker.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://api.sagemaker.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.sagemaker.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.sagemaker.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.sagemaker-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.sagemaker-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.sagemaker.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.sagemaker#SageMakerImageName": { + "type": "enum", + "members": { + "sagemaker_distribution": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sagemaker_distribution" + } + } + } + }, + "com.amazonaws.sagemaker#SageMakerImageVersionAlias": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(?!^[.-])^([a-zA-Z0-9-_.]+)$" + } + }, + "com.amazonaws.sagemaker#SageMakerImageVersionAliases": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#SageMakerImageVersionAlias" + } + }, + "com.amazonaws.sagemaker#SageMakerPublicHubContentArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": "^arn:[a-z0-9-\\.]{1,63}:sagemaker:\\w+(?:-\\w+)+:aws:hub-content\\/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}\\/Model\\/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}$" + } + }, + "com.amazonaws.sagemaker#SageMakerResourceName": { + "type": "enum", + "members": { + "TRAINING_JOB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "training-job" + } + }, + "HYPERPOD_CLUSTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hyperpod-cluster" + } + } + } + }, + "com.amazonaws.sagemaker#SageMakerResourceNames": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#SageMakerResourceName" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#SagemakerServicecatalogStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enabled" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disabled" + } + } + } + }, + "com.amazonaws.sagemaker#SampleWeightAttributeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_-]+$" + } + }, + "com.amazonaws.sagemaker#SamplingPercentage": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#ScalingPolicies": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ScalingPolicy" + } + }, + "com.amazonaws.sagemaker#ScalingPolicy": { + "type": "union", + "members": { + "TargetTracking": { + "target": "com.amazonaws.sagemaker#TargetTrackingScalingPolicyConfiguration", + "traits": { + "smithy.api#documentation": "

A target tracking scaling policy. Includes support for predefined or customized metrics.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object containing a recommended scaling policy.

" + } + }, + "com.amazonaws.sagemaker#ScalingPolicyMetric": { + "type": "structure", + "members": { + "InvocationsPerInstance": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "

The number of invocations sent to a model, normalized by InstanceCount\n in each ProductionVariant. 1/numberOfInstances is sent as the value on each\n request, where numberOfInstances is the number of active instances for the\n ProductionVariant behind the endpoint at the time of the request.

" + } + }, + "ModelLatency": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "

The interval of time taken by a model to respond as viewed from SageMaker.\n This interval includes the local communication times taken to send the request\n and to fetch the response from the container of a model and the time taken to\n complete the inference in the container.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The metric for a scaling policy.

" + } + }, + "com.amazonaws.sagemaker#ScalingPolicyObjective": { + "type": "structure", + "members": { + "MinInvocationsPerMinute": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "

The minimum number of expected requests to your endpoint per minute.

" + } + }, + "MaxInvocationsPerMinute": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of expected requests to your endpoint per minute.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object where you specify the anticipated traffic pattern for an endpoint.

" + } + }, + "com.amazonaws.sagemaker#ScheduleConfig": { + "type": "structure", + "members": { + "ScheduleExpression": { + "target": "com.amazonaws.sagemaker#ScheduleExpression", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A cron expression that describes details about the monitoring schedule.

\n

The supported cron expressions are:

\n
    \n
  • \n

    If you want to set the job to start every hour, use the following:

    \n

    \n Hourly: cron(0 * ? * * *)\n

    \n
    • \n
  • \n

    If you want to start the job daily:

    \n

    \n cron(0 [00-23] ? * * *)\n

    \n
    • \n
  • \n

    If you want to run the job one time, immediately, use the following\n keyword:

    \n

    \n NOW\n

    \n
    • \n
\n

For example, the following are valid cron expressions:

\n
    \n
  • \n

    Daily at noon UTC: cron(0 12 ? * * *)\n

    \n
    • \n
  • \n

    Daily at midnight UTC: cron(0 0 ? * * *)\n

    \n
    • \n
\n

To support running every 6, 12 hours, the following are also supported:

\n

\n cron(0 [00-23]/[01-24] ? * * *)\n

\n

For example, the following are valid cron expressions:

\n
    \n
  • \n

    Every 12 hours, starting at 5pm UTC: cron(0 17/12 ? * * *)\n

    \n
    • \n
  • \n

    Every two hours starting at midnight: cron(0 0/2 ? * * *)\n

    \n
    • \n
\n \n
    \n
  • \n

    Even though the cron expression is set to start at 5PM UTC, note that there\n could be a delay of 0-20 minutes from the actual requested time to run the\n execution.

    \n
    • \n
  • \n

    We recommend that if you would like a daily schedule, you do not provide this\n parameter. Amazon SageMaker AI will pick a time for running every day.

    \n
    • \n
\n \n

You can also specify the keyword NOW to run the monitoring job immediately,\n one time, without recurring.

", + "smithy.api#required": {} + } + }, + "DataAnalysisStartTime": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

Sets the start time for a monitoring job window. Express this time as an offset to the\n times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the\n ScheduleExpression parameter. Specify this offset in ISO 8601 duration\n format. For example, if you want to monitor the five hours of data in your dataset that\n precede the start of each monitoring job, you would specify: \"-PT5H\".

\n

The start time that you specify must not precede the end time that you specify by more\n than 24 hours. You specify the end time with the DataAnalysisEndTime\n parameter.

\n

If you set ScheduleExpression to NOW, this parameter is\n required.

" + } + }, + "DataAnalysisEndTime": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

Sets the end time for a monitoring job window. Express this time as an offset to the\n times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the\n ScheduleExpression parameter. Specify this offset in ISO 8601 duration\n format. For example, if you want to end the window one hour before the start of each\n monitoring job, you would specify: \"-PT1H\".

\n

The end time that you specify must not follow the start time that you specify by more\n than 24 hours. You specify the start time with the DataAnalysisStartTime\n parameter.

\n

If you set ScheduleExpression to NOW, this parameter is\n required.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration details about the monitoring schedule.

" + } + }, + "com.amazonaws.sagemaker#ScheduleExpression": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.sagemaker#ScheduleStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "SCHEDULED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Scheduled" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + } + } + }, + "com.amazonaws.sagemaker#SchedulerConfig": { + "type": "structure", + "members": { + "PriorityClasses": { + "target": "com.amazonaws.sagemaker#PriorityClassList", + "traits": { + "smithy.api#documentation": "

List of the priority classes, PriorityClass, of the cluster policy. When\n specified, these class configurations define how tasks are queued.

" + } + }, + "FairShare": { + "target": "com.amazonaws.sagemaker#FairShare", + "traits": { + "smithy.api#documentation": "

When enabled, entities borrow idle compute based on their assigned\n FairShareWeight.

\n

When disabled, entities borrow idle compute based on a first-come first-serve\n basis.

\n

Default is Enabled.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Cluster policy configuration. This policy is used for task prioritization and fair-share\n allocation. This helps prioritize critical workloads and distributes idle compute\n across entities.

" + } + }, + "com.amazonaws.sagemaker#SchedulerResourceStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Creating" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateFailed" + } + }, + "CREATE_ROLLBACK_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateRollbackFailed" + } + }, + "CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Created" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateFailed" + } + }, + "UPDATE_ROLLBACK_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateRollbackFailed" + } + }, + "UPDATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updated" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteFailed" + } + }, + "DELETE_ROLLBACK_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteRollbackFailed" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleted" + } + } + } + }, + "com.amazonaws.sagemaker#Scope": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^[!#-\\[\\]-~]+( [!#-\\[\\]-~]+)*$" + } + }, + "com.amazonaws.sagemaker#Search": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#SearchRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#SearchResponse" + }, + "traits": { + "smithy.api#documentation": "

Finds SageMaker resources that match a search query. Matching resources are returned\n as a list of SearchRecord objects in the response. You can sort the search\n results by any resource property in a ascending or descending order.

\n

You can query against the following value types: numeric, text, Boolean, and\n timestamp.

\n \n

The Search API may provide access to otherwise restricted data. See Amazon SageMaker \n API Permissions: Actions, Permissions, and Resources Reference for more\n information.

\n ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Results", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#SearchExpression": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.sagemaker#FilterList", + "traits": { + "smithy.api#documentation": "

A list of filter objects.

" + } + }, + "NestedFilters": { + "target": "com.amazonaws.sagemaker#NestedFiltersList", + "traits": { + "smithy.api#documentation": "

A list of nested filter objects.

" + } + }, + "SubExpressions": { + "target": "com.amazonaws.sagemaker#SearchExpressionList", + "traits": { + "smithy.api#documentation": "

A list of search expression objects.

" + } + }, + "Operator": { + "target": "com.amazonaws.sagemaker#BooleanOperator", + "traits": { + "smithy.api#documentation": "

A Boolean operator used to evaluate the search expression. If you want every\n conditional statement in all lists to be satisfied for the entire search expression to\n be true, specify And. If only a single conditional statement needs to be\n true for the entire search expression to be true, specify Or. The default\n value is And.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A multi-expression that searches for the specified resource or resources in a search. All resource\n objects that satisfy the expression's condition are included in the search results. You must specify at\n least one subexpression, filter, or nested filter. A SearchExpression can contain up to\n twenty elements.

\n

A SearchExpression contains the following components:

\n
    \n
  • \n

    A list of Filter objects. Each filter defines a simple Boolean\n expression comprised of a resource property name, Boolean operator, and\n value.

    \n
    • \n
  • \n

    A list of NestedFilter objects. Each nested filter defines a list\n of Boolean expressions using a list of resource properties. A nested filter is\n satisfied if a single object in the list satisfies all Boolean\n expressions.

    \n
    • \n
  • \n

    A list of SearchExpression objects. A search expression object\n can be nested in a list of search expression objects.

    \n
    • \n
  • \n

    A Boolean operator: And or Or.

    \n
    • \n
" + } + }, + "com.amazonaws.sagemaker#SearchExpressionList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#SearchExpression" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.sagemaker#SearchRecord": { + "type": "structure", + "members": { + "TrainingJob": { + "target": "com.amazonaws.sagemaker#TrainingJob", + "traits": { + "smithy.api#documentation": "

The properties of a training job.

" + } + }, + "Experiment": { + "target": "com.amazonaws.sagemaker#Experiment", + "traits": { + "smithy.api#documentation": "

The properties of an experiment.

" + } + }, + "Trial": { + "target": "com.amazonaws.sagemaker#Trial", + "traits": { + "smithy.api#documentation": "

The properties of a trial.

" + } + }, + "TrialComponent": { + "target": "com.amazonaws.sagemaker#TrialComponent", + "traits": { + "smithy.api#documentation": "

The properties of a trial component.

" + } + }, + "Endpoint": { + "target": "com.amazonaws.sagemaker#Endpoint" + }, + "ModelPackage": { + "target": "com.amazonaws.sagemaker#ModelPackage" + }, + "ModelPackageGroup": { + "target": "com.amazonaws.sagemaker#ModelPackageGroup" + }, + "Pipeline": { + "target": "com.amazonaws.sagemaker#Pipeline" + }, + "PipelineExecution": { + "target": "com.amazonaws.sagemaker#PipelineExecution" + }, + "FeatureGroup": { + "target": "com.amazonaws.sagemaker#FeatureGroup" + }, + "FeatureMetadata": { + "target": "com.amazonaws.sagemaker#FeatureMetadata", + "traits": { + "smithy.api#documentation": "

The feature metadata used to search through the features.

" + } + }, + "Project": { + "target": "com.amazonaws.sagemaker#Project", + "traits": { + "smithy.api#documentation": "

The properties of a project.

" + } + }, + "HyperParameterTuningJob": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobSearchEntity", + "traits": { + "smithy.api#documentation": "

The properties of a hyperparameter tuning job.

" + } + }, + "ModelCard": { + "target": "com.amazonaws.sagemaker#ModelCard", + "traits": { + "smithy.api#documentation": "

An Amazon SageMaker Model Card that documents details about a machine learning model.

" + } + }, + "Model": { + "target": "com.amazonaws.sagemaker#ModelDashboardModel" + } + }, + "traits": { + "smithy.api#documentation": "

A single resource returned as part of the Search API response.

" + } + }, + "com.amazonaws.sagemaker#SearchRequest": { + "type": "structure", + "members": { + "Resource": { + "target": "com.amazonaws.sagemaker#ResourceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the SageMaker resource to search for.

", + "smithy.api#required": {} + } + }, + "SearchExpression": { + "target": "com.amazonaws.sagemaker#SearchExpression", + "traits": { + "smithy.api#documentation": "

A Boolean conditional statement. Resources must satisfy this condition to be\n included in search results. You must provide at least one subexpression, filter, or\n nested filter. The maximum number of recursive SubExpressions,\n NestedFilters, and Filters that can be included in a\n SearchExpression object is 50.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#ResourcePropertyName", + "traits": { + "smithy.api#documentation": "

The name of the resource property used to sort the SearchResults. The\n default is LastModifiedTime.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SearchSortOrder", + "traits": { + "smithy.api#documentation": "

How SearchResults are ordered. Valid values are Ascending or\n Descending. The default is Descending.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If more than MaxResults resources match the specified\n SearchExpression, the response includes a\n NextToken. The NextToken can be passed to the next\n SearchRequest to continue retrieving results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return.

" + } + }, + "CrossAccountFilterOption": { + "target": "com.amazonaws.sagemaker#CrossAccountFilterOption", + "traits": { + "smithy.api#documentation": "

\n A cross account filter option. When the value is \"CrossAccount\" the \n search results will only include resources made discoverable to you from other \n accounts. When the value is \"SameAccount\" or null the \n search results will only include resources from your account. Default is \n null. For more information on searching for resources made \n discoverable to your account, see \n Search discoverable resources in the SageMaker Developer Guide.\n The maximum number of ResourceCatalogs viewable is 1000.\n

" + } + }, + "VisibilityConditions": { + "target": "com.amazonaws.sagemaker#VisibilityConditionsList", + "traits": { + "smithy.api#documentation": "

\n Limits the results of your search request to the resources that you can access.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#SearchResponse": { + "type": "structure", + "members": { + "Results": { + "target": "com.amazonaws.sagemaker#SearchResultsList", + "traits": { + "smithy.api#documentation": "

A list of SearchRecord objects.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the result of the previous Search request was truncated, the response\n includes a NextToken. To retrieve the next set of results, use the token in the next\n request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#SearchResultsList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#SearchRecord" + } + }, + "com.amazonaws.sagemaker#SearchSortOrder": { + "type": "enum", + "members": { + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ascending" + } + }, + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Descending" + } + } + } + }, + "com.amazonaws.sagemaker#SearchTrainingPlanOfferings": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#SearchTrainingPlanOfferingsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#SearchTrainingPlanOfferingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Searches for available training plan offerings based on specified criteria.

\n
    \n
  • \n

    Users search for available plan offerings based on their requirements (e.g.,\n instance type, count, start time, duration).

    \n
    • \n
  • \n

    And then, they create a plan that best matches their needs using the ID of the\n plan offering they want to use.

    \n
    • \n
\n

For more information about how to reserve GPU capacity for your SageMaker training jobs or\n SageMaker HyperPod clusters using Amazon SageMaker Training Plan , see \n CreateTrainingPlan\n .

" + } + }, + "com.amazonaws.sagemaker#SearchTrainingPlanOfferingsRequest": { + "type": "structure", + "members": { + "InstanceType": { + "target": "com.amazonaws.sagemaker#ReservedCapacityInstanceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of instance you want to search for in the available training plan offerings.\n This field allows you to filter the search results based on the specific compute resources\n you require for your SageMaker training jobs or SageMaker HyperPod clusters. When searching for training\n plan offerings, specifying the instance type helps you find Reserved Instances that match\n your computational needs.

", + "smithy.api#required": {} + } + }, + "InstanceCount": { + "target": "com.amazonaws.sagemaker#ReservedCapacityInstanceCount", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of instances you want to reserve in the training plan offerings. This allows\n you to specify the quantity of compute resources needed for your SageMaker training jobs or\n SageMaker HyperPod clusters, helping you find reserved capacity offerings that match your\n requirements.

", + "smithy.api#required": {} + } + }, + "StartTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter to search for training plan offerings with a start time after a specified\n date.

" + } + }, + "EndTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter to search for reserved capacity offerings with an end time before a specified\n date.

" + } + }, + "DurationHours": { + "target": "com.amazonaws.sagemaker#TrainingPlanDurationHoursInput", + "traits": { + "smithy.api#documentation": "

The desired duration in hours for the training plan offerings.

" + } + }, + "TargetResources": { + "target": "com.amazonaws.sagemaker#SageMakerResourceNames", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) to search for in the\n offerings.

\n

Training plans are specific to their target resource.

\n
    \n
  • \n

    A training plan designed for SageMaker training jobs can only be used to schedule and\n run training jobs.

    \n
    • \n
  • \n

    A training plan for HyperPod clusters can be used exclusively to provide\n compute resources to a cluster's instance group.

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#SearchTrainingPlanOfferingsResponse": { + "type": "structure", + "members": { + "TrainingPlanOfferings": { + "target": "com.amazonaws.sagemaker#TrainingPlanOfferings", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A list of training plan offerings that match the search criteria.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#SecondaryStatus": { + "type": "enum", + "members": { + "STARTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Starting" + } + }, + "LAUNCHING_ML_INSTANCES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LaunchingMLInstances" + } + }, + "PREPARING_TRAINING_STACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PreparingTrainingStack" + } + }, + "DOWNLOADING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Downloading" + } + }, + "DOWNLOADING_TRAINING_IMAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DownloadingTrainingImage" + } + }, + "TRAINING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Training" + } + }, + "UPLOADING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Uploading" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + }, + "MAX_RUNTIME_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MaxRuntimeExceeded" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "INTERRUPTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Interrupted" + } + }, + "MAX_WAIT_TIME_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MaxWaitTimeExceeded" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + }, + "RESTARTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Restarting" + } + }, + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + } + } + }, + "com.amazonaws.sagemaker#SecondaryStatusTransition": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.sagemaker#SecondaryStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Contains a secondary status information from a training\n job.

\n

Status might be one of the following secondary statuses:

\n
\n
InProgress
\n
\n
    \n
  • \n

    \n Starting\n - Starting the training job.

    \n
    • \n
  • \n

    \n Downloading - An optional stage for algorithms that\n support File training input mode. It indicates that\n data is being downloaded to the ML storage volumes.

    \n
    • \n
  • \n

    \n Training - Training is in progress.

    \n
    • \n
  • \n

    \n Uploading - Training is complete and the model\n artifacts are being uploaded to the S3 location.

    \n
    • \n
\n
\n
Completed
\n
\n
    \n
  • \n

    \n Completed - The training job has completed.

    \n
    • \n
\n
\n
Failed
\n
\n
    \n
  • \n

    \n Failed - The training job has failed. The reason for\n the failure is returned in the FailureReason field of\n DescribeTrainingJobResponse.

    \n
    • \n
\n
\n
Stopped
\n
\n
    \n
  • \n

    \n MaxRuntimeExceeded - The job stopped because it\n exceeded the maximum allowed runtime.

    \n
    • \n
  • \n

    \n Stopped - The training job has stopped.

    \n
    • \n
\n
\n
Stopping
\n
\n
    \n
  • \n

    \n Stopping - Stopping the training job.

    \n
    • \n
\n
\n
\n

We no longer support the following secondary statuses:

\n
    \n
  • \n

    \n LaunchingMLInstances\n

    \n
    • \n
  • \n

    \n PreparingTrainingStack\n

    \n
    • \n
  • \n

    \n DownloadingTrainingImage\n

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "StartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A timestamp that shows when the training job transitioned to the current secondary\n status state.

", + "smithy.api#required": {} + } + }, + "EndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A timestamp that shows when the training job transitioned out of this secondary status\n state into another secondary status state or when the training job has ended.

" + } + }, + "StatusMessage": { + "target": "com.amazonaws.sagemaker#StatusMessage", + "traits": { + "smithy.api#documentation": "

A detailed description of the progress within a secondary status.\n

\n

SageMaker provides secondary statuses and status messages that apply to each of\n them:

\n
\n
Starting
\n
\n
    \n
  • \n

    Starting the training job.

    \n
    • \n
  • \n

    Launching requested ML\n instances.

    \n
    • \n
  • \n

    Insufficient\n capacity error from EC2 while launching instances,\n retrying!

    \n
    • \n
  • \n

    Launched\n instance was unhealthy, replacing it!

    \n
    • \n
  • \n

    Preparing the instances for training.

    \n
    • \n
\n
\n
Training
\n
\n
    \n
  • \n

    Training\n image download completed. Training in\n progress.

    \n
    • \n
\n
\n
\n \n

Status messages are subject to change. Therefore, we recommend not including them\n in code that programmatically initiates actions. For examples, don't use status\n messages in if statements.

\n \n

To have an overview of your training job's progress, view\n TrainingJobStatus and SecondaryStatus in DescribeTrainingJob, and StatusMessage together. For example,\n at the start of a training job, you might see the following:

\n
    \n
  • \n

    \n TrainingJobStatus - InProgress

    \n
    • \n
  • \n

    \n SecondaryStatus - Training

    \n
    • \n
  • \n

    \n StatusMessage - Downloading the training image

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

An array element of SecondaryStatusTransitions for DescribeTrainingJob. It provides additional details about a status that the\n training job has transitioned through. A training job can be in one of several states,\n for example, starting, downloading, training, or uploading. Within each state, there are\n a number of intermediate states. For example, within the starting state, SageMaker could be\n starting the training job or launching the ML instances. These transitional states are\n referred to as the job's secondary\n status.\n

\n

" + } + }, + "com.amazonaws.sagemaker#SecondaryStatusTransitions": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#SecondaryStatusTransition" + } + }, + "com.amazonaws.sagemaker#SecretArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:secretsmanager:[a-z0-9\\-]*:[0-9]{12}:secret:" + } + }, + "com.amazonaws.sagemaker#SecurityGroupId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + }, + "smithy.api#pattern": "^[-0-9a-zA-Z]+$" + } + }, + "com.amazonaws.sagemaker#SecurityGroupIds": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#SecurityGroupId" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#Seed": { + "type": "long" + }, + "com.amazonaws.sagemaker#SelectedStep": { + "type": "structure", + "members": { + "StepName": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the pipeline step.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A step selected to run in selective execution mode.

" + } + }, + "com.amazonaws.sagemaker#SelectedStepList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#SelectedStep" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.sagemaker#SelectiveExecutionConfig": { + "type": "structure", + "members": { + "SourcePipelineExecutionArn": { + "target": "com.amazonaws.sagemaker#PipelineExecutionArn", + "traits": { + "smithy.api#documentation": "

The ARN from a reference execution of the current pipeline. \n Used to copy input collaterals needed for the selected steps to run.\n The execution status of the pipeline can be either Failed\n or Success.

\n

This field is required if the steps you specify for\n SelectedSteps depend on output collaterals from any non-specified pipeline\n steps. For more information, see Selective\n Execution for Pipeline Steps.

" + } + }, + "SelectedSteps": { + "target": "com.amazonaws.sagemaker#SelectedStepList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A list of pipeline steps to run. All step(s) in all path(s) between\n two selected steps should be included.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The selective execution configuration applied to the pipeline run.

" + } + }, + "com.amazonaws.sagemaker#SelectiveExecutionResult": { + "type": "structure", + "members": { + "SourcePipelineExecutionArn": { + "target": "com.amazonaws.sagemaker#PipelineExecutionArn", + "traits": { + "smithy.api#documentation": "

The ARN from an execution of the current pipeline.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The ARN from an execution of the current pipeline.

" + } + }, + "com.amazonaws.sagemaker#SendPipelineExecutionStepFailure": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#SendPipelineExecutionStepFailureRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#SendPipelineExecutionStepFailureResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Notifies the pipeline that the execution of a callback step failed, along with a\n message describing why. When a callback step is run, the pipeline generates a callback\n token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS).

" + } + }, + "com.amazonaws.sagemaker#SendPipelineExecutionStepFailureRequest": { + "type": "structure", + "members": { + "CallbackToken": { + "target": "com.amazonaws.sagemaker#CallbackToken", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The pipeline generated token from the Amazon SQS queue.

", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "

A message describing why the step failed.

" + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.sagemaker#IdempotencyToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n operation. An idempotent operation completes no more than one time.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#SendPipelineExecutionStepFailureResponse": { + "type": "structure", + "members": { + "PipelineExecutionArn": { + "target": "com.amazonaws.sagemaker#PipelineExecutionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the pipeline execution.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#SendPipelineExecutionStepSuccess": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#SendPipelineExecutionStepSuccessRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#SendPipelineExecutionStepSuccessResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Notifies the pipeline that the execution of a callback step succeeded and provides a\n list of the step's output parameters. When a callback step is run, the pipeline generates\n a callback token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS).

" + } + }, + "com.amazonaws.sagemaker#SendPipelineExecutionStepSuccessRequest": { + "type": "structure", + "members": { + "CallbackToken": { + "target": "com.amazonaws.sagemaker#CallbackToken", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The pipeline generated token from the Amazon SQS queue.

", + "smithy.api#required": {} + } + }, + "OutputParameters": { + "target": "com.amazonaws.sagemaker#OutputParameterList", + "traits": { + "smithy.api#documentation": "

A list of the output parameters of the callback step.

" + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.sagemaker#IdempotencyToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n operation. An idempotent operation completes no more than one time.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#SendPipelineExecutionStepSuccessResponse": { + "type": "structure", + "members": { + "PipelineExecutionArn": { + "target": "com.amazonaws.sagemaker#PipelineExecutionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the pipeline execution.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ServerlessMaxConcurrency": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.sagemaker#ServerlessMemorySizeInMB": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1024, + "max": 6144 + } + } + }, + "com.amazonaws.sagemaker#ServerlessProvisionedConcurrency": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.sagemaker#ServiceCatalogEntityId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_\\-]*$" + } + }, + "com.amazonaws.sagemaker#ServiceCatalogProvisionedProductDetails": { + "type": "structure", + "members": { + "ProvisionedProductId": { + "target": "com.amazonaws.sagemaker#ServiceCatalogEntityId", + "traits": { + "smithy.api#documentation": "

The ID of the provisioned product.

" + } + }, + "ProvisionedProductStatusMessage": { + "target": "com.amazonaws.sagemaker#ProvisionedProductStatusMessage", + "traits": { + "smithy.api#documentation": "

The current status of the product.

\n
    \n
  • \n

    \n AVAILABLE - Stable state, ready to perform any operation. The most recent operation succeeded and completed.

    \n
    • \n
  • \n

    \n UNDER_CHANGE - Transitive state. Operations performed might not have valid results. Wait for an AVAILABLE status before performing operations.

    \n
    • \n
  • \n

    \n TAINTED - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version.

    \n
    • \n
  • \n

    \n ERROR - An unexpected error occurred. The provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack.

    \n
    • \n
  • \n

    \n PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to provision a new product, but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE status before performing operations.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details of a provisioned service catalog product. For information about service catalog,\n see What is Amazon Web Services Service\n Catalog.

" + } + }, + "com.amazonaws.sagemaker#ServiceCatalogProvisioningDetails": { + "type": "structure", + "members": { + "ProductId": { + "target": "com.amazonaws.sagemaker#ServiceCatalogEntityId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the product to provision.

", + "smithy.api#required": {} + } + }, + "ProvisioningArtifactId": { + "target": "com.amazonaws.sagemaker#ServiceCatalogEntityId", + "traits": { + "smithy.api#documentation": "

The ID of the provisioning artifact.

" + } + }, + "PathId": { + "target": "com.amazonaws.sagemaker#ServiceCatalogEntityId", + "traits": { + "smithy.api#documentation": "

The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path.

" + } + }, + "ProvisioningParameters": { + "target": "com.amazonaws.sagemaker#ProvisioningParameters", + "traits": { + "smithy.api#documentation": "

A list of key value pairs that you specify when you provision a product.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details that you specify to provision a service catalog product. For information about\n service catalog, see What is Amazon Web Services Service\n Catalog.

" + } + }, + "com.amazonaws.sagemaker#ServiceCatalogProvisioningUpdateDetails": { + "type": "structure", + "members": { + "ProvisioningArtifactId": { + "target": "com.amazonaws.sagemaker#ServiceCatalogEntityId", + "traits": { + "smithy.api#documentation": "

The ID of the provisioning artifact.

" + } + }, + "ProvisioningParameters": { + "target": "com.amazonaws.sagemaker#ProvisioningParameters", + "traits": { + "smithy.api#documentation": "

A list of key value pairs that you specify when you provision a product.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details that you specify to provision a service catalog product. \n For information about service catalog, see What is Amazon Web Services Service Catalog.\n

" + } + }, + "com.amazonaws.sagemaker#SessionChainingConfig": { + "type": "structure", + "members": { + "EnableSessionTagChaining": { + "target": "com.amazonaws.sagemaker#EnableSessionTagChaining", + "traits": { + "smithy.api#documentation": "

Set to True to allow SageMaker to extract session tags from a training job\n creation role and reuse these tags when assuming the training job execution role.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about attribute-based access control (ABAC) for a training job.\n The session chaining configuration uses Amazon Security Token Service (STS) for your training job to\n request temporary, limited-privilege credentials to tenants. For more information, see\n Attribute-based access control (ABAC) for multi-tenancy training.

" + } + }, + "com.amazonaws.sagemaker#SessionExpirationDurationInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1800, + "max": 43200 + } + } + }, + "com.amazonaws.sagemaker#ShadowModeConfig": { + "type": "structure", + "members": { + "SourceModelVariantName": { + "target": "com.amazonaws.sagemaker#ModelVariantName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

\n The name of the production variant, which takes all the inference requests.\n

", + "smithy.api#required": {} + } + }, + "ShadowModelVariants": { + "target": "com.amazonaws.sagemaker#ShadowModelVariantConfigList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

List of shadow variant configurations.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The configuration of ShadowMode inference experiment type, which specifies a production variant\n to take all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the\n inference requests. For the shadow variant it also specifies the percentage of requests that Amazon SageMaker replicates.\n

" + } + }, + "com.amazonaws.sagemaker#ShadowModelVariantConfig": { + "type": "structure", + "members": { + "ShadowModelVariantName": { + "target": "com.amazonaws.sagemaker#ModelVariantName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the shadow variant.

", + "smithy.api#required": {} + } + }, + "SamplingPercentage": { + "target": "com.amazonaws.sagemaker#Percentage", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

\n The percentage of inference requests that Amazon SageMaker replicates from the production variant to the shadow variant.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The name and sampling percentage of a shadow variant.

" + } + }, + "com.amazonaws.sagemaker#ShadowModelVariantConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ShadowModelVariantConfig" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.sagemaker#SharingSettings": { + "type": "structure", + "members": { + "NotebookOutputOption": { + "target": "com.amazonaws.sagemaker#NotebookOutputOption", + "traits": { + "smithy.api#documentation": "

Whether to include the notebook cell output when sharing the notebook. The default is\n Disabled.

" + } + }, + "S3OutputPath": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "

When NotebookOutputOption is Allowed, the Amazon S3\n bucket used to store the shared notebook snapshots.

" + } + }, + "S3KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

When NotebookOutputOption is Allowed, the Amazon Web Services Key\n Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the\n Amazon S3 bucket.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies options for sharing Amazon SageMaker AI Studio notebooks. These settings are\n specified as part of DefaultUserSettings when the CreateDomain API\n is called, and as part of UserSettings when the CreateUserProfile\n API is called. When SharingSettings is not specified, notebook sharing isn't\n allowed.

" + } + }, + "com.amazonaws.sagemaker#SharingType": { + "type": "enum", + "members": { + "Private": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Private" + } + }, + "Shared": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Shared" + } + } + } + }, + "com.amazonaws.sagemaker#ShuffleConfig": { + "type": "structure", + "members": { + "Seed": { + "target": "com.amazonaws.sagemaker#Seed", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Determines the shuffling order in ShuffleConfig value.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A configuration for a shuffle option for input data in a channel. If you use\n S3Prefix for S3DataType, the results of the S3 key prefix\n matches are shuffled. If you use ManifestFile, the order of the S3 object\n references in the ManifestFile is shuffled. If you use\n AugmentedManifestFile, the order of the JSON lines in the\n AugmentedManifestFile is shuffled. The shuffling order is determined\n using the Seed value.

\n

For Pipe input mode, when ShuffleConfig is specified shuffling is done at\n the start of every epoch. With large datasets, this ensures that the order of the\n training data is different for each epoch, and it helps reduce bias and possible\n overfitting. In a multi-node training job when ShuffleConfig is combined\n with S3DataDistributionType of ShardedByS3Key, the data is\n shuffled across nodes so that the content sent to a particular node on the first epoch\n might be sent to a different node on the second epoch.

" + } + }, + "com.amazonaws.sagemaker#SingleSignOnApplicationArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::[0-9]+:application\\/[a-zA-Z0-9-_.]+\\/apl-[a-zA-Z0-9]+$" + } + }, + "com.amazonaws.sagemaker#SingleSignOnUserIdentifier": { + "type": "string", + "traits": { + "smithy.api#pattern": "^UserName$" + } + }, + "com.amazonaws.sagemaker#SkipModelValidation": { + "type": "enum", + "members": { + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "All" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "None" + } + } + } + }, + "com.amazonaws.sagemaker#SnsTopicArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sns:[a-z0-9\\-]*:[0-9]{12}:[a-zA-Z0-9_.-]+$" + } + }, + "com.amazonaws.sagemaker#SortActionsBy": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + } + } + }, + "com.amazonaws.sagemaker#SortArtifactsBy": { + "type": "enum", + "members": { + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + } + } + }, + "com.amazonaws.sagemaker#SortAssociationsBy": { + "type": "enum", + "members": { + "SOURCE_ARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SourceArn" + } + }, + "DESTINATION_ARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DestinationArn" + } + }, + "SOURCE_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SourceType" + } + }, + "DESTINATION_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DestinationType" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + } + } + }, + "com.amazonaws.sagemaker#SortBy": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + } + } + }, + "com.amazonaws.sagemaker#SortClusterSchedulerConfigBy": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + } + } + }, + "com.amazonaws.sagemaker#SortContextsBy": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + } + } + }, + "com.amazonaws.sagemaker#SortExperimentsBy": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + } + } + }, + "com.amazonaws.sagemaker#SortInferenceExperimentsBy": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + } + } + }, + "com.amazonaws.sagemaker#SortLineageGroupsBy": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + } + } + }, + "com.amazonaws.sagemaker#SortOrder": { + "type": "enum", + "members": { + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ascending" + } + }, + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Descending" + } + } + } + }, + "com.amazonaws.sagemaker#SortPipelineExecutionsBy": { + "type": "enum", + "members": { + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "PIPELINE_EXECUTION_ARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PipelineExecutionArn" + } + } + } + }, + "com.amazonaws.sagemaker#SortPipelinesBy": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + } + } + }, + "com.amazonaws.sagemaker#SortQuotaBy": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + }, + "CLUSTER_ARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ClusterArn" + } + } + } + }, + "com.amazonaws.sagemaker#SortTrackingServerBy": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + } + } + }, + "com.amazonaws.sagemaker#SortTrialComponentsBy": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + } + } + }, + "com.amazonaws.sagemaker#SortTrialsBy": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + } + } + }, + "com.amazonaws.sagemaker#SourceAlgorithm": { + "type": "structure", + "members": { + "ModelDataUrl": { + "target": "com.amazonaws.sagemaker#Url", + "traits": { + "smithy.api#documentation": "

The Amazon S3 path where the model artifacts, which result from model training, are stored.\n This path must point to a single gzip compressed tar archive\n (.tar.gz suffix).

\n \n

The model artifacts must be in an S3 bucket that is in the same Amazon Web Services\n region as the algorithm.

\n " + } + }, + "ModelDataSource": { + "target": "com.amazonaws.sagemaker#ModelDataSource", + "traits": { + "smithy.api#documentation": "

Specifies the location of ML model data to deploy during endpoint creation.

" + } + }, + "ModelDataETag": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The ETag associated with Model Data URL.

" + } + }, + "AlgorithmName": { + "target": "com.amazonaws.sagemaker#ArnOrName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of an algorithm that was used to create the model package. The algorithm must\n be either an algorithm resource in your SageMaker account or an algorithm in Amazon Web Services Marketplace that you are subscribed to.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies an algorithm that was used to create the model package. The algorithm must\n be either an algorithm resource in your SageMaker account or an algorithm in Amazon Web Services Marketplace that you are subscribed to.

" + } + }, + "com.amazonaws.sagemaker#SourceAlgorithmList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#SourceAlgorithm" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.sagemaker#SourceAlgorithmSpecification": { + "type": "structure", + "members": { + "SourceAlgorithms": { + "target": "com.amazonaws.sagemaker#SourceAlgorithmList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A list of the algorithms that were used to create a model package.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of algorithms that were used to create a model package.

" + } + }, + "com.amazonaws.sagemaker#SourceIpConfig": { + "type": "structure", + "members": { + "Cidrs": { + "target": "com.amazonaws.sagemaker#Cidrs", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A list of one to ten Classless Inter-Domain Routing (CIDR) values.

\n

Maximum: Ten CIDR values

\n \n

The following Length Constraints apply to individual CIDR values in\n the CIDR value list.

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of IP address ranges (CIDRs). Used to create an allow\n list of IP addresses for a private workforce. Workers will only be able to log in to their worker portal from an\n IP address within this range. By default, a workforce isn't restricted to specific IP addresses.

" + } + }, + "com.amazonaws.sagemaker#SourceType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + } + } + }, + "com.amazonaws.sagemaker#SourceUri": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#SpaceAppLifecycleManagement": { + "type": "structure", + "members": { + "IdleSettings": { + "target": "com.amazonaws.sagemaker#SpaceIdleSettings", + "traits": { + "smithy.api#documentation": "

Settings related to idle shutdown of Studio applications.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Settings that are used to configure and manage the lifecycle of Amazon SageMaker Studio\n applications in a space.

" + } + }, + "com.amazonaws.sagemaker#SpaceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:space/" + } + }, + "com.amazonaws.sagemaker#SpaceCodeEditorAppSettings": { + "type": "structure", + "members": { + "DefaultResourceSpec": { + "target": "com.amazonaws.sagemaker#ResourceSpec" + }, + "AppLifecycleManagement": { + "target": "com.amazonaws.sagemaker#SpaceAppLifecycleManagement", + "traits": { + "smithy.api#documentation": "

Settings that are used to configure and manage the lifecycle of CodeEditor applications in\n a space.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The application settings for a Code Editor space.

" + } + }, + "com.amazonaws.sagemaker#SpaceDetails": { + "type": "structure", + "members": { + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the associated domain.

" + } + }, + "SpaceName": { + "target": "com.amazonaws.sagemaker#SpaceName", + "traits": { + "smithy.api#documentation": "

The name of the space.

" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#SpaceStatus", + "traits": { + "smithy.api#documentation": "

The status.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "

The creation time.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "

The last modified time.

" + } + }, + "SpaceSettingsSummary": { + "target": "com.amazonaws.sagemaker#SpaceSettingsSummary", + "traits": { + "smithy.api#documentation": "

Specifies summary information about the space settings.

" + } + }, + "SpaceSharingSettingsSummary": { + "target": "com.amazonaws.sagemaker#SpaceSharingSettingsSummary", + "traits": { + "smithy.api#documentation": "

Specifies summary information about the space sharing settings.

" + } + }, + "OwnershipSettingsSummary": { + "target": "com.amazonaws.sagemaker#OwnershipSettingsSummary", + "traits": { + "smithy.api#documentation": "

Specifies summary information about the ownership settings.

" + } + }, + "SpaceDisplayName": { + "target": "com.amazonaws.sagemaker#NonEmptyString64", + "traits": { + "smithy.api#documentation": "

The name of the space that appears in the Studio UI.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The space's details.

" + } + }, + "com.amazonaws.sagemaker#SpaceEbsVolumeSizeInGb": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 16384 + } + } + }, + "com.amazonaws.sagemaker#SpaceIdleSettings": { + "type": "structure", + "members": { + "IdleTimeoutInMinutes": { + "target": "com.amazonaws.sagemaker#IdleTimeoutInMinutes", + "traits": { + "smithy.api#documentation": "

The time that SageMaker waits after the application becomes idle before shutting it\n down.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Settings related to idle shutdown of Studio applications in a space.

" + } + }, + "com.amazonaws.sagemaker#SpaceJupyterLabAppSettings": { + "type": "structure", + "members": { + "DefaultResourceSpec": { + "target": "com.amazonaws.sagemaker#ResourceSpec" + }, + "CodeRepositories": { + "target": "com.amazonaws.sagemaker#CodeRepositories", + "traits": { + "smithy.api#documentation": "

A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.

" + } + }, + "AppLifecycleManagement": { + "target": "com.amazonaws.sagemaker#SpaceAppLifecycleManagement", + "traits": { + "smithy.api#documentation": "

Settings that are used to configure and manage the lifecycle of JupyterLab applications in\n a space.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The settings for the JupyterLab application within a space.

" + } + }, + "com.amazonaws.sagemaker#SpaceList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#SpaceDetails" + } + }, + "com.amazonaws.sagemaker#SpaceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#SpaceSettings": { + "type": "structure", + "members": { + "JupyterServerAppSettings": { + "target": "com.amazonaws.sagemaker#JupyterServerAppSettings" + }, + "KernelGatewayAppSettings": { + "target": "com.amazonaws.sagemaker#KernelGatewayAppSettings" + }, + "CodeEditorAppSettings": { + "target": "com.amazonaws.sagemaker#SpaceCodeEditorAppSettings", + "traits": { + "smithy.api#documentation": "

The Code Editor application settings.

" + } + }, + "JupyterLabAppSettings": { + "target": "com.amazonaws.sagemaker#SpaceJupyterLabAppSettings", + "traits": { + "smithy.api#documentation": "

The settings for the JupyterLab application.

" + } + }, + "AppType": { + "target": "com.amazonaws.sagemaker#AppType", + "traits": { + "smithy.api#documentation": "

The type of app created within the space.

\n

If using the \n UpdateSpace API, you can't change the app type of your\n space by specifying a different value for this field.

" + } + }, + "SpaceStorageSettings": { + "target": "com.amazonaws.sagemaker#SpaceStorageSettings", + "traits": { + "smithy.api#documentation": "

The storage settings for a space.

" + } + }, + "CustomFileSystems": { + "target": "com.amazonaws.sagemaker#CustomFileSystems", + "traits": { + "smithy.api#documentation": "

A file system, created by you, that you assign to a space for an Amazon SageMaker AI\n Domain. Permitted users can access this file system in Amazon SageMaker AI Studio.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A collection of space settings.

" + } + }, + "com.amazonaws.sagemaker#SpaceSettingsSummary": { + "type": "structure", + "members": { + "AppType": { + "target": "com.amazonaws.sagemaker#AppType", + "traits": { + "smithy.api#documentation": "

The type of app created within the space.

" + } + }, + "SpaceStorageSettings": { + "target": "com.amazonaws.sagemaker#SpaceStorageSettings", + "traits": { + "smithy.api#documentation": "

The storage settings for a space.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies summary information about the space settings.

" + } + }, + "com.amazonaws.sagemaker#SpaceSharingSettings": { + "type": "structure", + "members": { + "SharingType": { + "target": "com.amazonaws.sagemaker#SharingType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies the sharing type of the space.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A collection of space sharing settings.

" + } + }, + "com.amazonaws.sagemaker#SpaceSharingSettingsSummary": { + "type": "structure", + "members": { + "SharingType": { + "target": "com.amazonaws.sagemaker#SharingType", + "traits": { + "smithy.api#documentation": "

Specifies the sharing type of the space.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies summary information about the space sharing settings.

" + } + }, + "com.amazonaws.sagemaker#SpaceSortKey": { + "type": "enum", + "members": { + "CreationTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "LastModifiedTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LastModifiedTime" + } + } + } + }, + "com.amazonaws.sagemaker#SpaceStatus": { + "type": "enum", + "members": { + "Deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "InService": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InService" + } + }, + "Pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "Updating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + }, + "Update_Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Update_Failed" + } + }, + "Delete_Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Delete_Failed" + } + } + } + }, + "com.amazonaws.sagemaker#SpaceStorageSettings": { + "type": "structure", + "members": { + "EbsStorageSettings": { + "target": "com.amazonaws.sagemaker#EbsStorageSettings", + "traits": { + "smithy.api#documentation": "

A collection of EBS storage settings for a space.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The storage settings for a space.

" + } + }, + "com.amazonaws.sagemaker#SpawnRate": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.sagemaker#SplitType": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "None" + } + }, + "LINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Line" + } + }, + "RECORDIO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RecordIO" + } + }, + "TFRECORD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TFRecord" + } + } + } + }, + "com.amazonaws.sagemaker#StageDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^.{0,1024}$" + } + }, + "com.amazonaws.sagemaker#StageStatus": { + "type": "enum", + "members": { + "Creating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ReadyToDeploy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READYTODEPLOY" + } + }, + "Starting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTING" + } + }, + "InProgress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INPROGRESS" + } + }, + "Deployed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEPLOYED" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "Stopping": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPING" + } + }, + "Stopped": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + } + } + }, + "com.amazonaws.sagemaker#Stairs": { + "type": "structure", + "members": { + "DurationInSeconds": { + "target": "com.amazonaws.sagemaker#TrafficDurationInSeconds", + "traits": { + "smithy.api#documentation": "

Defines how long each traffic step should be.

" + } + }, + "NumberOfSteps": { + "target": "com.amazonaws.sagemaker#NumberOfSteps", + "traits": { + "smithy.api#documentation": "

Specifies how many steps to perform during traffic.

" + } + }, + "UsersPerStep": { + "target": "com.amazonaws.sagemaker#UsersPerStep", + "traits": { + "smithy.api#documentation": "

Specifies how many new users to spawn in each step.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines the stairs traffic pattern for an Inference Recommender load test. This pattern\n type consists of multiple steps where the number of users increases at each step.

\n

Specify either the stairs or phases traffic pattern.

" + } + }, + "com.amazonaws.sagemaker#StartEdgeDeploymentStage": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StartEdgeDeploymentStageRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Starts a stage in an edge deployment plan.

" + } + }, + "com.amazonaws.sagemaker#StartEdgeDeploymentStageRequest": { + "type": "structure", + "members": { + "EdgeDeploymentPlanName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the edge deployment plan to start.

", + "smithy.api#required": {} + } + }, + "StageName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the stage to start.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#StartInferenceExperiment": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StartInferenceExperimentRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#StartInferenceExperimentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Starts an inference experiment.

" + } + }, + "com.amazonaws.sagemaker#StartInferenceExperimentRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#InferenceExperimentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the inference experiment to start.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#StartInferenceExperimentResponse": { + "type": "structure", + "members": { + "InferenceExperimentArn": { + "target": "com.amazonaws.sagemaker#InferenceExperimentArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the started inference experiment to start.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#StartMlflowTrackingServer": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StartMlflowTrackingServerRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#StartMlflowTrackingServerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Programmatically start an MLflow Tracking Server.

" + } + }, + "com.amazonaws.sagemaker#StartMlflowTrackingServerRequest": { + "type": "structure", + "members": { + "TrackingServerName": { + "target": "com.amazonaws.sagemaker#TrackingServerName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the tracking server to start.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#StartMlflowTrackingServerResponse": { + "type": "structure", + "members": { + "TrackingServerArn": { + "target": "com.amazonaws.sagemaker#TrackingServerArn", + "traits": { + "smithy.api#documentation": "

The ARN of the started tracking server.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#StartMonitoringSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StartMonitoringScheduleRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Starts a previously stopped monitoring schedule.

\n \n

By default, when you successfully create a new schedule, the status of a monitoring\n schedule is scheduled.

\n " + } + }, + "com.amazonaws.sagemaker#StartMonitoringScheduleRequest": { + "type": "structure", + "members": { + "MonitoringScheduleName": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the schedule to start.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#StartNotebookInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StartNotebookInstanceInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Launches an ML compute instance with the latest version of the libraries and\n attaches your ML storage volume. After configuring the notebook instance, SageMaker AI sets the notebook instance status to InService. A notebook\n instance's status must be InService before you can connect to your Jupyter\n notebook.

" + } + }, + "com.amazonaws.sagemaker#StartNotebookInstanceInput": { + "type": "structure", + "members": { + "NotebookInstanceName": { + "target": "com.amazonaws.sagemaker#NotebookInstanceName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the notebook instance to start.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#StartPipelineExecution": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StartPipelineExecutionRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#StartPipelineExecutionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Starts a pipeline execution.

" + } + }, + "com.amazonaws.sagemaker#StartPipelineExecutionRequest": { + "type": "structure", + "members": { + "PipelineName": { + "target": "com.amazonaws.sagemaker#PipelineNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the pipeline.

", + "smithy.api#required": {} + } + }, + "PipelineExecutionDisplayName": { + "target": "com.amazonaws.sagemaker#PipelineExecutionName", + "traits": { + "smithy.api#documentation": "

The display name of the pipeline execution.

" + } + }, + "PipelineParameters": { + "target": "com.amazonaws.sagemaker#ParameterList", + "traits": { + "smithy.api#documentation": "

Contains a list of pipeline parameters. This list can be empty.

" + } + }, + "PipelineExecutionDescription": { + "target": "com.amazonaws.sagemaker#PipelineExecutionDescription", + "traits": { + "smithy.api#documentation": "

The description of the pipeline execution.

" + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.sagemaker#IdempotencyToken", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n operation. An idempotent operation completes no more than once.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "ParallelismConfiguration": { + "target": "com.amazonaws.sagemaker#ParallelismConfiguration", + "traits": { + "smithy.api#documentation": "

This configuration, if specified, overrides the parallelism configuration \n of the parent pipeline for this specific run.

" + } + }, + "SelectiveExecutionConfig": { + "target": "com.amazonaws.sagemaker#SelectiveExecutionConfig", + "traits": { + "smithy.api#documentation": "

The selective execution configuration applied to the pipeline run.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#StartPipelineExecutionResponse": { + "type": "structure", + "members": { + "PipelineExecutionArn": { + "target": "com.amazonaws.sagemaker#PipelineExecutionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the pipeline execution.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#Statistic": { + "type": "enum", + "members": { + "AVERAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Average" + } + }, + "MINIMUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Minimum" + } + }, + "MAXIMUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Maximum" + } + }, + "SAMPLE_COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SampleCount" + } + }, + "SUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Sum" + } + } + } + }, + "com.amazonaws.sagemaker#StatusDetails": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#StatusMessage": { + "type": "string" + }, + "com.amazonaws.sagemaker#StepDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3072 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#StepDisplayName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#StepName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + }, + "smithy.api#pattern": "^[A-Za-z0-9\\-_]*$" + } + }, + "com.amazonaws.sagemaker#StepStatus": { + "type": "enum", + "members": { + "STARTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Starting" + } + }, + "EXECUTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Executing" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Succeeded" + } + } + } + }, + "com.amazonaws.sagemaker#StopAutoMLJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StopAutoMLJobRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

A method for forcing a running job to shut down.

" + } + }, + "com.amazonaws.sagemaker#StopAutoMLJobRequest": { + "type": "structure", + "members": { + "AutoMLJobName": { + "target": "com.amazonaws.sagemaker#AutoMLJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the object you are requesting.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#StopCompilationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StopCompilationJobRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Stops a model compilation job.

\n

To stop a job, Amazon SageMaker AI sends the algorithm the SIGTERM signal. This gracefully shuts the\n job down. If the job hasn't stopped, it sends the SIGKILL signal.

\n

When it receives a StopCompilationJob request, Amazon SageMaker AI changes the\n CompilationJobStatus of the job to Stopping. After Amazon\n SageMaker stops the job, it sets the CompilationJobStatus to\n Stopped.

" + } + }, + "com.amazonaws.sagemaker#StopCompilationJobRequest": { + "type": "structure", + "members": { + "CompilationJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the model compilation job to stop.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#StopEdgeDeploymentStage": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StopEdgeDeploymentStageRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Stops a stage in an edge deployment plan.

" + } + }, + "com.amazonaws.sagemaker#StopEdgeDeploymentStageRequest": { + "type": "structure", + "members": { + "EdgeDeploymentPlanName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the edge deployment plan to stop.

", + "smithy.api#required": {} + } + }, + "StageName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the stage to stop.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#StopEdgePackagingJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StopEdgePackagingJobRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Request to stop an edge packaging job.

" + } + }, + "com.amazonaws.sagemaker#StopEdgePackagingJobRequest": { + "type": "structure", + "members": { + "EdgePackagingJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the edge packaging job.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#StopHyperParameterTuningJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StopHyperParameterTuningJobRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Stops a running hyperparameter tuning job and all running training jobs that the\n tuning job launched.

\n

All model artifacts output from the training jobs are stored in Amazon Simple Storage Service (Amazon S3). All\n data that the training jobs write to Amazon CloudWatch Logs are still available in CloudWatch. After the\n tuning job moves to the Stopped state, it releases all\n reserved\n resources for the tuning job.

" + } + }, + "com.amazonaws.sagemaker#StopHyperParameterTuningJobRequest": { + "type": "structure", + "members": { + "HyperParameterTuningJobName": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the tuning job to stop.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#StopInferenceExperiment": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StopInferenceExperimentRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#StopInferenceExperimentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Stops an inference experiment.

" + } + }, + "com.amazonaws.sagemaker#StopInferenceExperimentRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#InferenceExperimentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the inference experiment to stop.

", + "smithy.api#required": {} + } + }, + "ModelVariantActions": { + "target": "com.amazonaws.sagemaker#ModelVariantActionMap", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

\n Array of key-value pairs, with names of variants mapped to actions. The possible actions are the following:\n

\n
    \n
  • \n

    \n Promote - Promote the shadow variant to a production variant

    \n
    • \n
  • \n

    \n Remove - Delete the variant

    \n
    • \n
  • \n

    \n Retain - Keep the variant as it is

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "DesiredModelVariants": { + "target": "com.amazonaws.sagemaker#ModelVariantConfigList", + "traits": { + "smithy.api#documentation": "

\n An array of ModelVariantConfig objects. There is one for each variant that you want to deploy\n after the inference experiment stops. Each ModelVariantConfig describes the infrastructure\n configuration for deploying the corresponding variant.\n

" + } + }, + "DesiredState": { + "target": "com.amazonaws.sagemaker#InferenceExperimentStopDesiredState", + "traits": { + "smithy.api#documentation": "

\n The desired state of the experiment after stopping. The possible states are the following:\n

\n
    \n
  • \n

    \n Completed: The experiment completed successfully

    \n
    • \n
  • \n

    \n Cancelled: The experiment was canceled

    \n
    • \n
" + } + }, + "Reason": { + "target": "com.amazonaws.sagemaker#InferenceExperimentStatusReason", + "traits": { + "smithy.api#documentation": "

The reason for stopping the experiment.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#StopInferenceExperimentResponse": { + "type": "structure", + "members": { + "InferenceExperimentArn": { + "target": "com.amazonaws.sagemaker#InferenceExperimentArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the stopped inference experiment.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#StopInferenceRecommendationsJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StopInferenceRecommendationsJobRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Stops an Inference Recommender job.

" + } + }, + "com.amazonaws.sagemaker#StopInferenceRecommendationsJobRequest": { + "type": "structure", + "members": { + "JobName": { + "target": "com.amazonaws.sagemaker#RecommendationJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the job you want to stop.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#StopLabelingJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StopLabelingJobRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Stops a running labeling job. A job that is stopped cannot be restarted. Any results\n obtained before the job is stopped are placed in the Amazon S3 output bucket.

" + } + }, + "com.amazonaws.sagemaker#StopLabelingJobRequest": { + "type": "structure", + "members": { + "LabelingJobName": { + "target": "com.amazonaws.sagemaker#LabelingJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the labeling job to stop.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#StopMlflowTrackingServer": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StopMlflowTrackingServerRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#StopMlflowTrackingServerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Programmatically stop an MLflow Tracking Server.

" + } + }, + "com.amazonaws.sagemaker#StopMlflowTrackingServerRequest": { + "type": "structure", + "members": { + "TrackingServerName": { + "target": "com.amazonaws.sagemaker#TrackingServerName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the tracking server to stop.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#StopMlflowTrackingServerResponse": { + "type": "structure", + "members": { + "TrackingServerArn": { + "target": "com.amazonaws.sagemaker#TrackingServerArn", + "traits": { + "smithy.api#documentation": "

The ARN of the stopped tracking server.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#StopMonitoringSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StopMonitoringScheduleRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Stops a previously started monitoring schedule.

" + } + }, + "com.amazonaws.sagemaker#StopMonitoringScheduleRequest": { + "type": "structure", + "members": { + "MonitoringScheduleName": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the schedule to stop.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#StopNotebookInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StopNotebookInstanceInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Terminates the ML compute instance. Before terminating the instance, SageMaker AI disconnects the ML storage volume from it. SageMaker AI preserves the\n ML storage volume. SageMaker AI stops charging you for the ML compute instance when\n you call StopNotebookInstance.

\n

To access data on the ML storage volume for a notebook instance that has been\n terminated, call the StartNotebookInstance API.\n StartNotebookInstance launches another ML compute instance, configures\n it, and attaches the preserved ML storage volume so you can continue your work.\n

" + } + }, + "com.amazonaws.sagemaker#StopNotebookInstanceInput": { + "type": "structure", + "members": { + "NotebookInstanceName": { + "target": "com.amazonaws.sagemaker#NotebookInstanceName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the notebook instance to terminate.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#StopOptimizationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StopOptimizationJobRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Ends a running inference optimization job.

" + } + }, + "com.amazonaws.sagemaker#StopOptimizationJobRequest": { + "type": "structure", + "members": { + "OptimizationJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name that you assigned to the optimization job.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#StopPipelineExecution": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StopPipelineExecutionRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#StopPipelineExecutionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Stops a pipeline execution.

\n

\n Callback Step\n

\n

A pipeline execution won't stop while a callback step is running.\n When you call StopPipelineExecution\n on a pipeline execution with a running callback step, SageMaker Pipelines sends an\n additional Amazon SQS message to the specified SQS queue. The body of the SQS message\n contains a \"Status\" field which is set to \"Stopping\".

\n

You should add logic to your Amazon SQS message consumer to take any needed action (for\n example, resource cleanup) upon receipt of the message followed by a call to\n SendPipelineExecutionStepSuccess or\n SendPipelineExecutionStepFailure.

\n

Only when SageMaker Pipelines receives one of these calls will it stop the pipeline execution.

\n

\n Lambda Step\n

\n

A pipeline execution can't be stopped while a lambda step is running because the Lambda\n function invoked by the lambda step can't be stopped. If you attempt to stop the execution\n while the Lambda function is running, the pipeline waits for the Lambda function to finish\n or until the timeout is hit, whichever occurs first, and then stops. If the Lambda function\n finishes, the pipeline execution status is Stopped. If the timeout is hit\n the pipeline execution status is Failed.

" + } + }, + "com.amazonaws.sagemaker#StopPipelineExecutionRequest": { + "type": "structure", + "members": { + "PipelineExecutionArn": { + "target": "com.amazonaws.sagemaker#PipelineExecutionArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the pipeline execution.

", + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.sagemaker#IdempotencyToken", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n operation. An idempotent operation completes no more than once.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#StopPipelineExecutionResponse": { + "type": "structure", + "members": { + "PipelineExecutionArn": { + "target": "com.amazonaws.sagemaker#PipelineExecutionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the pipeline execution.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#StopProcessingJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StopProcessingJobRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Stops a processing job.

" + } + }, + "com.amazonaws.sagemaker#StopProcessingJobRequest": { + "type": "structure", + "members": { + "ProcessingJobName": { + "target": "com.amazonaws.sagemaker#ProcessingJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the processing job to stop.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#StopTrainingJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StopTrainingJobRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Stops a training job. To stop a job, SageMaker sends the algorithm the\n SIGTERM signal, which delays job termination for 120 seconds.\n Algorithms might use this 120-second window to save the model artifacts, so the results\n of the training is not lost.

\n

When it receives a StopTrainingJob request, SageMaker changes the status of\n the job to Stopping. After SageMaker stops the job, it sets the status to\n Stopped.

" + } + }, + "com.amazonaws.sagemaker#StopTrainingJobRequest": { + "type": "structure", + "members": { + "TrainingJobName": { + "target": "com.amazonaws.sagemaker#TrainingJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the training job to stop.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#StopTransformJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StopTransformJobRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Stops a batch transform job.

\n

When Amazon SageMaker receives a StopTransformJob request, the status of the job\n changes to Stopping. After Amazon SageMaker\n stops\n the job, the status is set to Stopped. When you stop a batch transform job before\n it is completed, Amazon SageMaker doesn't store the job's output in Amazon S3.

" + } + }, + "com.amazonaws.sagemaker#StopTransformJobRequest": { + "type": "structure", + "members": { + "TransformJobName": { + "target": "com.amazonaws.sagemaker#TransformJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the batch transform job to stop.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#StoppingCondition": { + "type": "structure", + "members": { + "MaxRuntimeInSeconds": { + "target": "com.amazonaws.sagemaker#MaxRuntimeInSeconds", + "traits": { + "smithy.api#documentation": "

The maximum length of time, in seconds, that a training or compilation job can run\n before it is stopped.

\n

For compilation jobs, if the job does not complete during this time, a\n TimeOut error is generated. We recommend starting with 900 seconds and\n increasing as necessary based on your model.

\n

For all other jobs, if the job does not complete during this time, SageMaker ends the job.\n When RetryStrategy is specified in the job request,\n MaxRuntimeInSeconds specifies the maximum time for all of the attempts\n in total, not each individual attempt. The default value is 1 day. The maximum value is\n 28 days.

\n

The maximum time that a TrainingJob can run in total, including any time\n spent publishing metrics or archiving and uploading models after it has been stopped, is\n 30 days.

" + } + }, + "MaxWaitTimeInSeconds": { + "target": "com.amazonaws.sagemaker#MaxWaitTimeInSeconds", + "traits": { + "smithy.api#documentation": "

The maximum length of time, in seconds, that a managed Spot training job has to\n complete. It is the amount of time spent waiting for Spot capacity plus the amount of\n time the job can run. It must be equal to or greater than\n MaxRuntimeInSeconds. If the job does not complete during this time,\n SageMaker ends the job.

\n

When RetryStrategy is specified in the job request,\n MaxWaitTimeInSeconds specifies the maximum time for all of the attempts\n in total, not each individual attempt.

" + } + }, + "MaxPendingTimeInSeconds": { + "target": "com.amazonaws.sagemaker#MaxPendingTimeInSeconds", + "traits": { + "smithy.api#documentation": "

The maximum length of time, in seconds, that a training or compilation job can be\n pending before it is stopped.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies a limit to how long a job can run. When the job reaches the time limit, SageMaker\n ends the job. Use this API to cap costs.

\n

To stop a training job, SageMaker sends the algorithm the SIGTERM signal,\n which delays job termination for 120 seconds. Algorithms can use this 120-second window\n to save the model artifacts, so the results of training are not lost.

\n

The training algorithms provided by SageMaker automatically save the intermediate results\n of a model training job when possible. This attempt to save artifacts is only a best\n effort case as model might not be in a state from which it can be saved. For example, if\n training has just started, the model might not be ready to save. When saved, this\n intermediate data is a valid model artifact. You can use it to create a model with\n CreateModel.

\n \n

The Neural Topic Model (NTM) currently does not support saving intermediate model\n artifacts. When training NTMs, make sure that the maximum runtime is sufficient for\n the training job to complete.

\n " + } + }, + "com.amazonaws.sagemaker#StorageType": { + "type": "enum", + "members": { + "STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Standard" + } + }, + "IN_MEMORY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InMemory" + } + } + } + }, + "com.amazonaws.sagemaker#String": { + "type": "string" + }, + "com.amazonaws.sagemaker#String1024": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.sagemaker#String128": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + } + } + }, + "com.amazonaws.sagemaker#String200": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.sagemaker#String2048": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + } + } + }, + "com.amazonaws.sagemaker#String256": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.sagemaker#String3072": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3072 + } + } + }, + "com.amazonaws.sagemaker#String40": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 40 + } + } + }, + "com.amazonaws.sagemaker#String64": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + } + } + }, + "com.amazonaws.sagemaker#String8192": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 8192 + } + } + }, + "com.amazonaws.sagemaker#StringParameterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2500 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#StudioLifecycleConfigAppType": { + "type": "enum", + "members": { + "JupyterServer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JupyterServer" + } + }, + "KernelGateway": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KernelGateway" + } + }, + "CodeEditor": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CodeEditor" + } + }, + "JupyterLab": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JupyterLab" + } + } + } + }, + "com.amazonaws.sagemaker#StudioLifecycleConfigArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:studio-lifecycle-config/.*|None)$" + } + }, + "com.amazonaws.sagemaker#StudioLifecycleConfigContent": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16384 + }, + "smithy.api#pattern": "^[\\S\\s]+$" + } + }, + "com.amazonaws.sagemaker#StudioLifecycleConfigDetails": { + "type": "structure", + "members": { + "StudioLifecycleConfigArn": { + "target": "com.amazonaws.sagemaker#StudioLifecycleConfigArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Lifecycle Configuration.

" + } + }, + "StudioLifecycleConfigName": { + "target": "com.amazonaws.sagemaker#StudioLifecycleConfigName", + "traits": { + "smithy.api#documentation": "

The name of the Amazon SageMaker AI Studio Lifecycle Configuration.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The creation time of the Amazon SageMaker AI Studio Lifecycle Configuration.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

This value is equivalent to CreationTime because Amazon SageMaker AI Studio Lifecycle\n Configurations are immutable.

" + } + }, + "StudioLifecycleConfigAppType": { + "target": "com.amazonaws.sagemaker#StudioLifecycleConfigAppType", + "traits": { + "smithy.api#documentation": "

The App type to which the Lifecycle Configuration is attached.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details of the Amazon SageMaker AI Studio Lifecycle Configuration.

" + } + }, + "com.amazonaws.sagemaker#StudioLifecycleConfigName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#StudioLifecycleConfigSortKey": { + "type": "enum", + "members": { + "CreationTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "LastModifiedTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LastModifiedTime" + } + }, + "Name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + } + } + }, + "com.amazonaws.sagemaker#StudioLifecycleConfigsList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#StudioLifecycleConfigDetails" + } + }, + "com.amazonaws.sagemaker#StudioWebPortal": { + "type": "enum", + "members": { + "Enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "Disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.sagemaker#StudioWebPortalSettings": { + "type": "structure", + "members": { + "HiddenMlTools": { + "target": "com.amazonaws.sagemaker#HiddenMlToolsList", + "traits": { + "smithy.api#documentation": "

The machine learning tools that are hidden from the Studio left navigation pane.

" + } + }, + "HiddenAppTypes": { + "target": "com.amazonaws.sagemaker#HiddenAppTypesList", + "traits": { + "smithy.api#documentation": "

The Applications supported in Studio that are hidden from the Studio left navigation\n pane.

" + } + }, + "HiddenInstanceTypes": { + "target": "com.amazonaws.sagemaker#HiddenInstanceTypesList", + "traits": { + "smithy.api#documentation": "

The instance types you are hiding from the Studio user interface.

" + } + }, + "HiddenSageMakerImageVersionAliases": { + "target": "com.amazonaws.sagemaker#HiddenSageMakerImageVersionAliasesList", + "traits": { + "smithy.api#documentation": "

The version aliases you are hiding from the Studio user interface.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Studio settings. If these settings are applied on a user level, they take priority over\n the settings applied on a domain level.

" + } + }, + "com.amazonaws.sagemaker#SubnetId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + }, + "smithy.api#pattern": "^[-0-9a-zA-Z]+$" + } + }, + "com.amazonaws.sagemaker#Subnets": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#SubnetId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16 + } + } + }, + "com.amazonaws.sagemaker#SubscribedWorkteam": { + "type": "structure", + "members": { + "WorkteamArn": { + "target": "com.amazonaws.sagemaker#WorkteamArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the vendor that you have subscribed.

", + "smithy.api#required": {} + } + }, + "MarketplaceTitle": { + "target": "com.amazonaws.sagemaker#String200", + "traits": { + "smithy.api#documentation": "

The title of the service provided by the vendor in the Amazon Marketplace.

" + } + }, + "SellerName": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The name of the vendor in the Amazon Marketplace.

" + } + }, + "MarketplaceDescription": { + "target": "com.amazonaws.sagemaker#String200", + "traits": { + "smithy.api#documentation": "

The description of the vendor from the Amazon Marketplace.

" + } + }, + "ListingId": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

Marketplace product listing ID.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a work team of a vendor that does the labelling job.

" + } + }, + "com.amazonaws.sagemaker#SubscribedWorkteams": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#SubscribedWorkteam" + } + }, + "com.amazonaws.sagemaker#Success": { + "type": "boolean" + }, + "com.amazonaws.sagemaker#SuggestionQuery": { + "type": "structure", + "members": { + "PropertyNameQuery": { + "target": "com.amazonaws.sagemaker#PropertyNameQuery", + "traits": { + "smithy.api#documentation": "

Defines a property name hint. Only property\n names that begin with the specified hint are included in the response.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specified in the GetSearchSuggestions request.\n Limits the property names that are included in the response.

" + } + }, + "com.amazonaws.sagemaker#SynthesizedJsonHumanLoopActivationConditions": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10240 + }, + "smithy.api#mediaType": "application/json" + } + }, + "com.amazonaws.sagemaker#TableFormat": { + "type": "enum", + "members": { + "DEFAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Default" + } + }, + "GLUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Glue" + } + }, + "ICEBERG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Iceberg" + } + } + } + }, + "com.amazonaws.sagemaker#TableName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*$" + } + }, + "com.amazonaws.sagemaker#TabularJobConfig": { + "type": "structure", + "members": { + "CandidateGenerationConfig": { + "target": "com.amazonaws.sagemaker#CandidateGenerationConfig", + "traits": { + "smithy.api#documentation": "

The configuration information of how model candidates are generated.

" + } + }, + "CompletionCriteria": { + "target": "com.amazonaws.sagemaker#AutoMLJobCompletionCriteria" + }, + "FeatureSpecificationS3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "

A URL to the Amazon S3 data source containing selected features from the input\n data source to run an Autopilot job V2. You can input FeatureAttributeNames\n (optional) in JSON format as shown below:

\n

\n { \"FeatureAttributeNames\":[\"col1\", \"col2\", ...] }.

\n

You can also specify the data type of the feature (optional) in the format shown\n below:

\n

\n { \"FeatureDataTypes\":{\"col1\":\"numeric\", \"col2\":\"categorical\" ... } }\n

\n \n

These column keys may not include the target column.

\n \n

In ensembling mode, Autopilot only supports the following data types: numeric,\n categorical, text, and datetime. In HPO mode,\n Autopilot can support numeric, categorical, text,\n datetime, and sequence.

\n

If only FeatureDataTypes is provided, the column keys (col1,\n col2,..) should be a subset of the column names in the input data.

\n

If both FeatureDataTypes and FeatureAttributeNames are\n provided, then the column keys should be a subset of the column names provided in\n FeatureAttributeNames.

\n

The key name FeatureAttributeNames is fixed. The values listed in\n [\"col1\", \"col2\", ...] are case sensitive and should be a list of strings\n containing unique values that are a subset of the column names in the input data. The list\n of columns provided must not include the target column.

" + } + }, + "Mode": { + "target": "com.amazonaws.sagemaker#AutoMLMode", + "traits": { + "smithy.api#documentation": "

The method that Autopilot uses to train the data. You can either specify the mode manually\n or let Autopilot choose for you based on the dataset size by selecting AUTO. In\n AUTO mode, Autopilot chooses ENSEMBLING for datasets smaller than\n 100 MB, and HYPERPARAMETER_TUNING for larger ones.

\n

The ENSEMBLING mode uses a multi-stack ensemble model to predict\n classification and regression tasks directly from your dataset. This machine learning mode\n combines several base models to produce an optimal predictive model. It then uses a\n stacking ensemble method to combine predictions from contributing members. A multi-stack\n ensemble model can provide better performance over a single model by combining the\n predictive capabilities of multiple models. See Autopilot algorithm support for a list of algorithms supported by\n ENSEMBLING mode.

\n

The HYPERPARAMETER_TUNING (HPO) mode uses the best hyperparameters to train\n the best version of a model. HPO automatically selects an algorithm for the type of problem\n you want to solve. Then HPO finds the best hyperparameters according to your objective\n metric. See Autopilot algorithm support for a list of algorithms supported by\n HYPERPARAMETER_TUNING mode.

" + } + }, + "GenerateCandidateDefinitionsOnly": { + "target": "com.amazonaws.sagemaker#GenerateCandidateDefinitionsOnly", + "traits": { + "smithy.api#documentation": "

Generates possible candidates without training the models. A model candidate is a\n combination of data preprocessors, algorithms, and algorithm parameter settings.

" + } + }, + "ProblemType": { + "target": "com.amazonaws.sagemaker#ProblemType", + "traits": { + "smithy.api#documentation": "

The type of supervised learning problem available for the model candidates of the AutoML\n job V2. For more information, see \n SageMaker Autopilot problem types.

\n \n

You must either specify the type of supervised learning problem in\n ProblemType and provide the AutoMLJobObjective metric, or none at all.

\n " + } + }, + "TargetAttributeName": { + "target": "com.amazonaws.sagemaker#TargetAttributeName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the target variable in supervised learning, usually represented by\n 'y'.

", + "smithy.api#required": {} + } + }, + "SampleWeightAttributeName": { + "target": "com.amazonaws.sagemaker#SampleWeightAttributeName", + "traits": { + "smithy.api#documentation": "

If specified, this column name indicates which column of the dataset should be treated\n as sample weights for use by the objective metric during the training, evaluation, and the\n selection of the best model. This column is not considered as a predictive feature. For\n more information on Autopilot metrics, see Metrics and\n validation.

\n

Sample weights should be numeric, non-negative, with larger values indicating which rows\n are more important than others. Data points that have invalid or no weight value are\n excluded.

\n

Support for sample weights is available in Ensembling\n mode only.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The collection of settings used by an AutoML job V2 for the tabular problem type.

" + } + }, + "com.amazonaws.sagemaker#TabularResolvedAttributes": { + "type": "structure", + "members": { + "ProblemType": { + "target": "com.amazonaws.sagemaker#ProblemType", + "traits": { + "smithy.api#documentation": "

The type of supervised learning problem available for the model candidates of the AutoML\n job V2 (Binary Classification, Multiclass Classification, Regression). For more\n information, see \n SageMaker Autopilot problem types.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The resolved attributes specific to the tabular problem type.

" + } + }, + "com.amazonaws.sagemaker#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.sagemaker#TagKey", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The tag key. Tag keys must be unique per resource.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.sagemaker#TagValue", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The tag value.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A tag object that consists of a key and an optional value, used to manage metadata\n for SageMaker Amazon Web Services resources.

\n

You can add tags to notebook instances, training jobs, hyperparameter tuning jobs,\n batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and\n endpoints. For more information on adding tags to SageMaker resources, see AddTags.

\n

For more information on adding metadata to your Amazon Web Services resources with\n tagging, see Tagging Amazon Web Services resources. For advice on best practices for\n managing Amazon Web Services resources with tagging, see Tagging\n Best Practices: Implement an Effective Amazon Web Services Resource Tagging\n Strategy.

" + } + }, + "com.amazonaws.sagemaker#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + } + }, + "com.amazonaws.sagemaker#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.sagemaker#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#Tag" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.sagemaker#TagPropagation": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.sagemaker#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + } + }, + "com.amazonaws.sagemaker#TargetAttributeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#TargetDevice": { + "type": "enum", + "members": { + "LAMBDA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "lambda" + } + }, + "ML_M4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml_m4" + } + }, + "ML_M5": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml_m5" + } + }, + "ML_M6G": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml_m6g" + } + }, + "ML_C4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml_c4" + } + }, + "ML_C5": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml_c5" + } + }, + "ML_C6G": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml_c6g" + } + }, + "ML_P2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml_p2" + } + }, + "ML_P3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml_p3" + } + }, + "ML_G4DN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml_g4dn" + } + }, + "ML_INF1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml_inf1" + } + }, + "ML_INF2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml_inf2" + } + }, + "ML_TRN1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml_trn1" + } + }, + "ML_EIA2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml_eia2" + } + }, + "JETSON_TX1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "jetson_tx1" + } + }, + "JETSON_TX2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "jetson_tx2" + } + }, + "JETSON_NANO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "jetson_nano" + } + }, + "JETSON_XAVIER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "jetson_xavier" + } + }, + "RASP3B": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rasp3b" + } + }, + "RASP4B": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rasp4b" + } + }, + "IMX8QM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "imx8qm" + } + }, + "DEEPLENS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deeplens" + } + }, + "RK3399": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rk3399" + } + }, + "RK3288": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rk3288" + } + }, + "AISAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "aisage" + } + }, + "SBE_C": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sbe_c" + } + }, + "QCS605": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "qcs605" + } + }, + "QCS603": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "qcs603" + } + }, + "SITARA_AM57X": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sitara_am57x" + } + }, + "AMBA_CV2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "amba_cv2" + } + }, + "AMBA_CV22": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "amba_cv22" + } + }, + "AMBA_CV25": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "amba_cv25" + } + }, + "X86_WIN32": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x86_win32" + } + }, + "X86_WIN64": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x86_win64" + } + }, + "COREML": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "coreml" + } + }, + "JACINTO_TDA4VM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "jacinto_tda4vm" + } + }, + "IMX8MPLUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "imx8mplus" + } + } + } + }, + "com.amazonaws.sagemaker#TargetLabelColumn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.sagemaker#TargetObjectiveMetricValue": { + "type": "float" + }, + "com.amazonaws.sagemaker#TargetPlatform": { + "type": "structure", + "members": { + "Os": { + "target": "com.amazonaws.sagemaker#TargetPlatformOs", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies a target platform OS.

\n
    \n
  • \n

    \n LINUX: Linux-based operating systems.

    \n
    • \n
  • \n

    \n ANDROID: Android operating systems. Android API level can be\n specified using the ANDROID_PLATFORM compiler option. For example,\n \"CompilerOptions\": {'ANDROID_PLATFORM': 28}\n

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Arch": { + "target": "com.amazonaws.sagemaker#TargetPlatformArch", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies a target platform architecture.

\n
    \n
  • \n

    \n X86_64: 64-bit version of the x86 instruction set.

    \n
    • \n
  • \n

    \n X86: 32-bit version of the x86 instruction set.

    \n
    • \n
  • \n

    \n ARM64: ARMv8 64-bit CPU.

    \n
    • \n
  • \n

    \n ARM_EABIHF: ARMv7 32-bit, Hard Float.

    \n
    • \n
  • \n

    \n ARM_EABI: ARMv7 32-bit, Soft Float. Used by Android 32-bit ARM\n platform.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Accelerator": { + "target": "com.amazonaws.sagemaker#TargetPlatformAccelerator", + "traits": { + "smithy.api#documentation": "

Specifies a target platform accelerator (optional).

\n
    \n
  • \n

    \n NVIDIA: Nvidia graphics processing unit. It also requires\n gpu-code, trt-ver, cuda-ver compiler\n options

    \n
    • \n
  • \n

    \n MALI: ARM Mali graphics processor

    \n
    • \n
  • \n

    \n INTEL_GRAPHICS: Integrated Intel graphics

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a target platform that you want your model to run on, such\n as OS, architecture, and accelerators. It is an alternative of\n TargetDevice.

" + } + }, + "com.amazonaws.sagemaker#TargetPlatformAccelerator": { + "type": "enum", + "members": { + "INTEL_GRAPHICS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTEL_GRAPHICS" + } + }, + "MALI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MALI" + } + }, + "NVIDIA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NVIDIA" + } + }, + "NNA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NNA" + } + } + } + }, + "com.amazonaws.sagemaker#TargetPlatformArch": { + "type": "enum", + "members": { + "X86_64": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "X86_64" + } + }, + "X86": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "X86" + } + }, + "ARM64": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARM64" + } + }, + "ARM_EABI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARM_EABI" + } + }, + "ARM_EABIHF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARM_EABIHF" + } + } + } + }, + "com.amazonaws.sagemaker#TargetPlatformOs": { + "type": "enum", + "members": { + "ANDROID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANDROID" + } + }, + "LINUX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINUX" + } + } + } + }, + "com.amazonaws.sagemaker#TargetTrackingScalingPolicyConfiguration": { + "type": "structure", + "members": { + "MetricSpecification": { + "target": "com.amazonaws.sagemaker#MetricSpecification", + "traits": { + "smithy.api#documentation": "

An object containing information about a metric.

" + } + }, + "TargetValue": { + "target": "com.amazonaws.sagemaker#Double", + "traits": { + "smithy.api#documentation": "

The recommended target value to specify for the metric when creating a scaling policy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A target tracking scaling policy. Includes support for predefined or customized metrics.

\n

When using the PutScalingPolicy API,\n this parameter is required when you are creating a policy with the policy type TargetTrackingScaling.

" + } + }, + "com.amazonaws.sagemaker#TaskAvailabilityLifetimeInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 60 + } + } + }, + "com.amazonaws.sagemaker#TaskCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.sagemaker#TaskDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.sagemaker#TaskInput": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 128000 + }, + "smithy.api#pattern": "^[\\S\\s]+$" + } + }, + "com.amazonaws.sagemaker#TaskKeyword": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 30 + }, + "smithy.api#pattern": "^[A-Za-z0-9]+( [A-Za-z0-9]+)*$" + } + }, + "com.amazonaws.sagemaker#TaskKeywords": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#TaskKeyword" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#TaskTimeLimitInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 30 + } + } + }, + "com.amazonaws.sagemaker#TaskTitle": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\t\\n\\r -\\uD7FF\\uE000-\\uFFFD]*$" + } + }, + "com.amazonaws.sagemaker#TemplateContent": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128000 + }, + "smithy.api#pattern": "^[\\S\\s]+$" + } + }, + "com.amazonaws.sagemaker#TemplateContentSha256": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128000 + } + } + }, + "com.amazonaws.sagemaker#TemplateUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.sagemaker#TensorBoardAppSettings": { + "type": "structure", + "members": { + "DefaultResourceSpec": { + "target": "com.amazonaws.sagemaker#ResourceSpec", + "traits": { + "smithy.api#documentation": "

The default instance type and the Amazon Resource Name (ARN) of the SageMaker AI\n image created on the instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The TensorBoard app settings.

" + } + }, + "com.amazonaws.sagemaker#TensorBoardOutputConfig": { + "type": "structure", + "members": { + "LocalPath": { + "target": "com.amazonaws.sagemaker#DirectoryPath", + "traits": { + "smithy.api#documentation": "

Path to local storage location for tensorBoard output. Defaults to\n /opt/ml/output/tensorboard.

" + } + }, + "S3OutputPath": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Path to Amazon S3 storage location for TensorBoard output.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration of storage locations for the Amazon SageMaker Debugger TensorBoard output data.

" + } + }, + "com.amazonaws.sagemaker#TenthFractionsOfACent": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 9 + } + } + }, + "com.amazonaws.sagemaker#TerminationWaitInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 3600 + } + } + }, + "com.amazonaws.sagemaker#TextClassificationJobConfig": { + "type": "structure", + "members": { + "CompletionCriteria": { + "target": "com.amazonaws.sagemaker#AutoMLJobCompletionCriteria", + "traits": { + "smithy.api#documentation": "

How long a job is allowed to run, or how many candidates a job is allowed to\n generate.

" + } + }, + "ContentColumn": { + "target": "com.amazonaws.sagemaker#ContentColumn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the column used to provide the sentences to be classified. It should not be\n the same as the target column.

", + "smithy.api#required": {} + } + }, + "TargetLabelColumn": { + "target": "com.amazonaws.sagemaker#TargetLabelColumn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the column used to provide the class labels. It should not be same as the\n content column.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The collection of settings used by an AutoML job V2 for the text classification problem\n type.

" + } + }, + "com.amazonaws.sagemaker#TextGenerationHyperParameterKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._-]+$" + } + }, + "com.amazonaws.sagemaker#TextGenerationHyperParameterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 16 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._-]+$" + } + }, + "com.amazonaws.sagemaker#TextGenerationHyperParameters": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#TextGenerationHyperParameterKey" + }, + "value": { + "target": "com.amazonaws.sagemaker#TextGenerationHyperParameterValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 30 + } + } + }, + "com.amazonaws.sagemaker#TextGenerationJobConfig": { + "type": "structure", + "members": { + "CompletionCriteria": { + "target": "com.amazonaws.sagemaker#AutoMLJobCompletionCriteria", + "traits": { + "smithy.api#documentation": "

How long a fine-tuning job is allowed to run. For TextGenerationJobConfig\n problem types, the MaxRuntimePerTrainingJobInSeconds attribute of\n AutoMLJobCompletionCriteria defaults to 72h (259200s).

" + } + }, + "BaseModelName": { + "target": "com.amazonaws.sagemaker#BaseModelName", + "traits": { + "smithy.api#documentation": "

The name of the base model to fine-tune. Autopilot supports fine-tuning a variety of large\n language models. For information on the list of supported models, see Text generation models supporting fine-tuning in Autopilot. If no\n BaseModelName is provided, the default model used is Falcon7BInstruct.

" + } + }, + "TextGenerationHyperParameters": { + "target": "com.amazonaws.sagemaker#TextGenerationHyperParameters", + "traits": { + "smithy.api#documentation": "

The hyperparameters used to configure and optimize the learning process of the base\n model. You can set any combination of the following hyperparameters for all base models.\n For more information on each supported hyperparameter, see Optimize\n the learning process of your text generation models with hyperparameters.

\n
    \n
  • \n

    \n \"epochCount\": The number of times the model goes through the entire\n training dataset. Its value should be a string containing an integer value within the\n range of \"1\" to \"10\".

    \n
    • \n
  • \n

    \n \"batchSize\": The number of data samples used in each iteration of\n training. Its value should be a string containing an integer value within the range\n of \"1\" to \"64\".

    \n
    • \n
  • \n

    \n \"learningRate\": The step size at which a model's parameters are\n updated during training. Its value should be a string containing a floating-point\n value within the range of \"0\" to \"1\".

    \n
    • \n
  • \n

    \n \"learningRateWarmupSteps\": The number of training steps during which\n the learning rate gradually increases before reaching its target or maximum value.\n Its value should be a string containing an integer value within the range of \"0\" to\n \"250\".

    \n
    • \n
\n

Here is an example where all four hyperparameters are configured.

\n

\n { \"epochCount\":\"5\", \"learningRate\":\"0.5\", \"batchSize\": \"32\",\n \"learningRateWarmupSteps\": \"10\" }\n

" + } + }, + "ModelAccessConfig": { + "target": "com.amazonaws.sagemaker#ModelAccessConfig" + } + }, + "traits": { + "smithy.api#documentation": "

The collection of settings used by an AutoML job V2 for the text generation problem\n type.

\n \n

The text generation models that support fine-tuning in Autopilot are currently accessible\n exclusively in regions supported by Canvas. Refer to the documentation of Canvas for the full list of its supported\n Regions.

\n " + } + }, + "com.amazonaws.sagemaker#TextGenerationResolvedAttributes": { + "type": "structure", + "members": { + "BaseModelName": { + "target": "com.amazonaws.sagemaker#BaseModelName", + "traits": { + "smithy.api#documentation": "

The name of the base model to fine-tune.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The resolved attributes specific to the text generation problem type.

" + } + }, + "com.amazonaws.sagemaker#ThingName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9:_-]+$" + } + }, + "com.amazonaws.sagemaker#ThroughputConfig": { + "type": "structure", + "members": { + "ThroughputMode": { + "target": "com.amazonaws.sagemaker#ThroughputMode", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The mode used for your feature group throughput: ON_DEMAND or\n PROVISIONED.

", + "smithy.api#required": {} + } + }, + "ProvisionedReadCapacityUnits": { + "target": "com.amazonaws.sagemaker#CapacityUnit", + "traits": { + "smithy.api#documentation": "

For provisioned feature groups with online store enabled, this indicates the read\n throughput you are billed for and can consume without throttling.

\n

This field is not applicable for on-demand feature groups.

" + } + }, + "ProvisionedWriteCapacityUnits": { + "target": "com.amazonaws.sagemaker#CapacityUnit", + "traits": { + "smithy.api#documentation": "

For provisioned feature groups, this indicates the write throughput you are billed for\n and can consume without throttling.

\n

This field is not applicable for on-demand feature groups.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Used to set feature group throughput configuration. There are two modes:\n ON_DEMAND and PROVISIONED. With on-demand mode, you are\n charged for data reads and writes that your application performs on your feature group. You\n do not need to specify read and write throughput because Feature Store accommodates your\n workloads as they ramp up and down. You can switch a feature group to on-demand only once\n in a 24 hour period. With provisioned throughput mode, you specify the read and write\n capacity per second that you expect your application to require, and you are billed based\n on those limits. Exceeding provisioned throughput will result in your requests being\n throttled.

\n

Note: PROVISIONED throughput mode is supported only for feature groups that\n are offline-only, or use the \n Standard\n tier online store.

" + } + }, + "com.amazonaws.sagemaker#ThroughputConfigDescription": { + "type": "structure", + "members": { + "ThroughputMode": { + "target": "com.amazonaws.sagemaker#ThroughputMode", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The mode used for your feature group throughput: ON_DEMAND or\n PROVISIONED.

", + "smithy.api#required": {} + } + }, + "ProvisionedReadCapacityUnits": { + "target": "com.amazonaws.sagemaker#CapacityUnit", + "traits": { + "smithy.api#documentation": "

For provisioned feature groups with online store enabled, this indicates the read\n throughput you are billed for and can consume without throttling.

\n

This field is not applicable for on-demand feature groups.

" + } + }, + "ProvisionedWriteCapacityUnits": { + "target": "com.amazonaws.sagemaker#CapacityUnit", + "traits": { + "smithy.api#documentation": "

For provisioned feature groups, this indicates the write throughput you are billed for\n and can consume without throttling.

\n

This field is not applicable for on-demand feature groups.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Active throughput configuration of the feature group. There are two modes:\n ON_DEMAND and PROVISIONED. With on-demand mode, you are\n charged for data reads and writes that your application performs on your feature group. You\n do not need to specify read and write throughput because Feature Store accommodates your\n workloads as they ramp up and down. You can switch a feature group to on-demand only once\n in a 24 hour period. With provisioned throughput mode, you specify the read and write\n capacity per second that you expect your application to require, and you are billed based\n on those limits. Exceeding provisioned throughput will result in your requests being\n throttled.

\n

Note: PROVISIONED throughput mode is supported only for feature groups that\n are offline-only, or use the \n Standard\n tier online store.

" + } + }, + "com.amazonaws.sagemaker#ThroughputConfigUpdate": { + "type": "structure", + "members": { + "ThroughputMode": { + "target": "com.amazonaws.sagemaker#ThroughputMode", + "traits": { + "smithy.api#documentation": "

Target throughput mode of the feature group. Throughput update is an asynchronous\n operation, and the outcome should be monitored by polling LastUpdateStatus\n field in DescribeFeatureGroup response. You cannot update a feature group's\n throughput while another update is in progress.

" + } + }, + "ProvisionedReadCapacityUnits": { + "target": "com.amazonaws.sagemaker#CapacityUnit", + "traits": { + "smithy.api#documentation": "

For provisioned feature groups with online store enabled, this indicates the read\n throughput you are billed for and can consume without throttling.

" + } + }, + "ProvisionedWriteCapacityUnits": { + "target": "com.amazonaws.sagemaker#CapacityUnit", + "traits": { + "smithy.api#documentation": "

For provisioned feature groups, this indicates the write throughput you are billed for\n and can consume without throttling.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The new throughput configuration for the feature group. You can switch between on-demand\n and provisioned modes or update the read / write capacity of provisioned feature groups.\n You can switch a feature group to on-demand only once in a 24 hour period.

" + } + }, + "com.amazonaws.sagemaker#ThroughputMode": { + "type": "enum", + "members": { + "ON_DEMAND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OnDemand" + } + }, + "PROVISIONED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Provisioned" + } + } + } + }, + "com.amazonaws.sagemaker#TimeSeriesConfig": { + "type": "structure", + "members": { + "TargetAttributeName": { + "target": "com.amazonaws.sagemaker#TargetAttributeName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the column representing the target variable that you want to predict for\n each item in your dataset. The data type of the target variable must be numerical.

", + "smithy.api#required": {} + } + }, + "TimestampAttributeName": { + "target": "com.amazonaws.sagemaker#TimestampAttributeName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the column indicating a point in time at which the target value of a given\n item is recorded.

", + "smithy.api#required": {} + } + }, + "ItemIdentifierAttributeName": { + "target": "com.amazonaws.sagemaker#ItemIdentifierAttributeName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the column that represents the set of item identifiers for which you want to\n predict the target value.

", + "smithy.api#required": {} + } + }, + "GroupingAttributeNames": { + "target": "com.amazonaws.sagemaker#GroupingAttributeNames", + "traits": { + "smithy.api#documentation": "

A set of columns names that can be grouped with the item identifier column to create a\n composite key for which a target value is predicted.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The collection of components that defines the time-series.

" + } + }, + "com.amazonaws.sagemaker#TimeSeriesForecastingJobConfig": { + "type": "structure", + "members": { + "FeatureSpecificationS3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "

A URL to the Amazon S3 data source containing additional selected features that\n complement the target, itemID, timestamp, and grouped columns set in\n TimeSeriesConfig. When not provided, the AutoML job V2 includes all the\n columns from the original dataset that are not already declared in\n TimeSeriesConfig. If provided, the AutoML job V2 only considers these\n additional columns as a complement to the ones declared in\n TimeSeriesConfig.

\n

You can input FeatureAttributeNames (optional) in JSON format as shown\n below:

\n

\n { \"FeatureAttributeNames\":[\"col1\", \"col2\", ...] }.

\n

You can also specify the data type of the feature (optional) in the format shown\n below:

\n

\n { \"FeatureDataTypes\":{\"col1\":\"numeric\", \"col2\":\"categorical\" ... } }\n

\n

Autopilot supports the following data types: numeric, categorical,\n text, and datetime.

\n \n

These column keys must not include any column set in\n TimeSeriesConfig.

\n " + } + }, + "CompletionCriteria": { + "target": "com.amazonaws.sagemaker#AutoMLJobCompletionCriteria" + }, + "ForecastFrequency": { + "target": "com.amazonaws.sagemaker#ForecastFrequency", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The frequency of predictions in a forecast.

\n

Valid intervals are an integer followed by Y (Year), M (Month), W (Week), D (Day), H\n (Hour), and min (Minute). For example, 1D indicates every day and\n 15min indicates every 15 minutes. The value of a frequency must not overlap\n with the next larger frequency. For example, you must use a frequency of 1H\n instead of 60min.

\n

The valid values for each frequency are the following:

\n
    \n
  • \n

    Minute - 1-59

    \n
    • \n
  • \n

    Hour - 1-23

    \n
    • \n
  • \n

    Day - 1-6

    \n
    • \n
  • \n

    Week - 1-4

    \n
    • \n
  • \n

    Month - 1-11

    \n
    • \n
  • \n

    Year - 1

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "ForecastHorizon": { + "target": "com.amazonaws.sagemaker#ForecastHorizon", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of time-steps that the model predicts. The forecast horizon is also called\n the prediction length. The maximum forecast horizon is the lesser of 500 time-steps or 1/4\n of the time-steps in the dataset.

", + "smithy.api#required": {} + } + }, + "ForecastQuantiles": { + "target": "com.amazonaws.sagemaker#ForecastQuantiles", + "traits": { + "smithy.api#documentation": "

The quantiles used to train the model for forecasts at a specified quantile. You can\n specify quantiles from 0.01 (p1) to 0.99 (p99), by increments of\n 0.01 or higher. Up to five forecast quantiles can be specified. When\n ForecastQuantiles is not provided, the AutoML job uses the quantiles p10,\n p50, and p90 as default.

" + } + }, + "Transformations": { + "target": "com.amazonaws.sagemaker#TimeSeriesTransformations", + "traits": { + "smithy.api#documentation": "

The transformations modifying specific attributes of the time-series, such as filling\n strategies for missing values.

" + } + }, + "TimeSeriesConfig": { + "target": "com.amazonaws.sagemaker#TimeSeriesConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The collection of components that defines the time-series.

", + "smithy.api#required": {} + } + }, + "HolidayConfig": { + "target": "com.amazonaws.sagemaker#HolidayConfig", + "traits": { + "smithy.api#documentation": "

The collection of holiday featurization attributes used to incorporate national holiday\n information into your forecasting model.

" + } + }, + "CandidateGenerationConfig": { + "target": "com.amazonaws.sagemaker#CandidateGenerationConfig" + } + }, + "traits": { + "smithy.api#documentation": "

The collection of settings used by an AutoML job V2 for the time-series forecasting\n problem type.

" + } + }, + "com.amazonaws.sagemaker#TimeSeriesForecastingSettings": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.sagemaker#FeatureStatus", + "traits": { + "smithy.api#documentation": "

Describes whether time series forecasting is enabled or disabled in the Canvas\n application.

" + } + }, + "AmazonForecastRoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "

The IAM role that Canvas passes to Amazon Forecast for time series forecasting. By default,\n Canvas uses the execution role specified in the UserProfile that launches the\n Canvas application. If an execution role is not specified in the UserProfile,\n Canvas uses the execution role specified in the Domain that owns the\n UserProfile. To allow time series forecasting, this IAM role should have the\n AmazonSageMakerCanvasForecastAccess policy attached and\n forecast.amazonaws.com added in the trust relationship as a service\n principal.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Time series forecast settings for the SageMaker Canvas application.

" + } + }, + "com.amazonaws.sagemaker#TimeSeriesTransformations": { + "type": "structure", + "members": { + "Filling": { + "target": "com.amazonaws.sagemaker#FillingTransformations", + "traits": { + "smithy.api#documentation": "

A key value pair defining the filling method for a column, where the key is the column\n name and the value is an object which defines the filling logic. You can specify multiple\n filling methods for a single column.

\n

The supported filling methods and their corresponding options are:

\n
    \n
  • \n

    \n frontfill: none (Supported only for target\n column)

    \n
    • \n
  • \n

    \n middlefill: zero, value,\n median, mean, min, max\n

    \n
    • \n
  • \n

    \n backfill: zero, value, median,\n mean, min, max\n

    \n
    • \n
  • \n

    \n futurefill: zero, value,\n median, mean, min, max\n

    \n
    • \n
\n

To set a filling method to a specific value, set the fill parameter to the chosen\n filling method value (for example \"backfill\" : \"value\"), and define the\n filling value in an additional parameter prefixed with \"_value\". For example, to set\n backfill to a value of 2, you must include two parameters:\n \"backfill\": \"value\" and \"backfill_value\":\"2\".

" + } + }, + "Aggregation": { + "target": "com.amazonaws.sagemaker#AggregationTransformations", + "traits": { + "smithy.api#documentation": "

A key value pair defining the aggregation method for a column, where the key is the\n column name and the value is the aggregation method.

\n

The supported aggregation methods are sum (default), avg,\n first, min, max.

\n \n

Aggregation is only supported for the target column.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Transformations allowed on the dataset. Supported transformations are\n Filling and Aggregation. Filling specifies how to\n add values to missing values in the dataset. Aggregation defines how to\n aggregate data that does not align with forecast frequency.

" + } + }, + "com.amazonaws.sagemaker#Timestamp": { + "type": "timestamp" + }, + "com.amazonaws.sagemaker#TimestampAttributeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.sagemaker#TotalInstanceCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.sagemaker#TrackingServerArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:mlflow-tracking-server/" + } + }, + "com.amazonaws.sagemaker#TrackingServerName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}$" + } + }, + "com.amazonaws.sagemaker#TrackingServerSize": { + "type": "enum", + "members": { + "S": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Small" + } + }, + "M": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Medium" + } + }, + "L": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Large" + } + } + } + }, + "com.amazonaws.sagemaker#TrackingServerStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Creating" + } + }, + "CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Created" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateFailed" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + }, + "UPDATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updated" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateFailed" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteFailed" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + }, + "STOP_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StopFailed" + } + }, + "STARTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Starting" + } + }, + "STARTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Started" + } + }, + "START_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StartFailed" + } + }, + "MAINTENANCE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MaintenanceInProgress" + } + }, + "MAINTENANCE_COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MaintenanceComplete" + } + }, + "MAINTENANCE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MaintenanceFailed" + } + } + } + }, + "com.amazonaws.sagemaker#TrackingServerSummary": { + "type": "structure", + "members": { + "TrackingServerArn": { + "target": "com.amazonaws.sagemaker#TrackingServerArn", + "traits": { + "smithy.api#documentation": "

The ARN of a listed tracking server.

" + } + }, + "TrackingServerName": { + "target": "com.amazonaws.sagemaker#TrackingServerName", + "traits": { + "smithy.api#documentation": "

The name of a listed tracking server.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The creation time of a listed tracking server.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The last modified time of a listed tracking server.

" + } + }, + "TrackingServerStatus": { + "target": "com.amazonaws.sagemaker#TrackingServerStatus", + "traits": { + "smithy.api#documentation": "

The creation status of a listed tracking server.

" + } + }, + "IsActive": { + "target": "com.amazonaws.sagemaker#IsTrackingServerActive", + "traits": { + "smithy.api#documentation": "

The activity status of a listed tracking server.

" + } + }, + "MlflowVersion": { + "target": "com.amazonaws.sagemaker#MlflowVersion", + "traits": { + "smithy.api#documentation": "

The MLflow version used for a listed tracking server.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The summary of the tracking server to list.

" + } + }, + "com.amazonaws.sagemaker#TrackingServerSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#TrackingServerSummary" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#TrackingServerUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + } + } + }, + "com.amazonaws.sagemaker#TrafficDurationInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#TrafficPattern": { + "type": "structure", + "members": { + "TrafficType": { + "target": "com.amazonaws.sagemaker#TrafficType", + "traits": { + "smithy.api#documentation": "

Defines the traffic patterns. Choose either PHASES or STAIRS.

" + } + }, + "Phases": { + "target": "com.amazonaws.sagemaker#Phases", + "traits": { + "smithy.api#documentation": "

Defines the phases traffic specification.

" + } + }, + "Stairs": { + "target": "com.amazonaws.sagemaker#Stairs", + "traits": { + "smithy.api#documentation": "

Defines the stairs traffic pattern.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines the traffic pattern of the load test.

" + } + }, + "com.amazonaws.sagemaker#TrafficRoutingConfig": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.sagemaker#TrafficRoutingConfigType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Traffic routing strategy type.

\n
    \n
  • \n

    \n ALL_AT_ONCE: Endpoint traffic shifts to the new fleet\n in a single step.\n

    \n
    • \n
  • \n

    \n CANARY: Endpoint traffic shifts to the new fleet\n in two steps. The first step is the canary, which is a small portion of the traffic. The\n second step is the remainder of the traffic.\n

    \n
    • \n
  • \n

    \n LINEAR: Endpoint traffic shifts to the new fleet in\n n steps of a configurable size.\n

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "WaitIntervalInSeconds": { + "target": "com.amazonaws.sagemaker#WaitIntervalInSeconds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The waiting time (in seconds) between incremental steps to turn on traffic on the\n new endpoint fleet.

", + "smithy.api#required": {} + } + }, + "CanarySize": { + "target": "com.amazonaws.sagemaker#CapacitySize", + "traits": { + "smithy.api#documentation": "

Batch size for the first step to turn on traffic on the new endpoint fleet. Value must be less than\n or equal to 50% of the variant's total instance count.

" + } + }, + "LinearStepSize": { + "target": "com.amazonaws.sagemaker#CapacitySize", + "traits": { + "smithy.api#documentation": "

Batch size for each step to turn on traffic on the new endpoint fleet. Value must be\n 10-50% of the variant's total instance count.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines the traffic routing strategy during an endpoint deployment to shift traffic from the\n old fleet to the new fleet.

" + } + }, + "com.amazonaws.sagemaker#TrafficRoutingConfigType": { + "type": "enum", + "members": { + "ALL_AT_ONCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL_AT_ONCE" + } + }, + "CANARY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANARY" + } + }, + "LINEAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINEAR" + } + } + } + }, + "com.amazonaws.sagemaker#TrafficType": { + "type": "enum", + "members": { + "PHASES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PHASES" + } + }, + "STAIRS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STAIRS" + } + } + } + }, + "com.amazonaws.sagemaker#TrainingContainerArgument": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#TrainingContainerArguments": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#TrainingContainerArgument" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#TrainingContainerEntrypoint": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#TrainingContainerEntrypointString" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#TrainingContainerEntrypointString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#TrainingEnvironmentKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$" + } + }, + "com.amazonaws.sagemaker#TrainingEnvironmentMap": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#TrainingEnvironmentKey" + }, + "value": { + "target": "com.amazonaws.sagemaker#TrainingEnvironmentValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#TrainingEnvironmentValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^[\\S\\s]*$" + } + }, + "com.amazonaws.sagemaker#TrainingImageConfig": { + "type": "structure", + "members": { + "TrainingRepositoryAccessMode": { + "target": "com.amazonaws.sagemaker#TrainingRepositoryAccessMode", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The method that your training job will use to gain access to the images in your\n private Docker registry. For access to an image in a private Docker registry, set to\n Vpc.

", + "smithy.api#required": {} + } + }, + "TrainingRepositoryAuthConfig": { + "target": "com.amazonaws.sagemaker#TrainingRepositoryAuthConfig", + "traits": { + "smithy.api#documentation": "

An object containing authentication information for a private Docker registry\n containing your training images.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration to use an image from a private Docker registry for a training\n job.

" + } + }, + "com.amazonaws.sagemaker#TrainingInputMode": { + "type": "enum", + "members": { + "PIPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pipe" + } + }, + "FILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "File" + } + }, + "FASTFILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FastFile" + } + } + }, + "traits": { + "smithy.api#documentation": "

The training input mode that the algorithm supports. For more information about input\n modes, see Algorithms.

\n

\n Pipe mode\n

\n

If an algorithm supports Pipe mode, Amazon SageMaker streams data directly from\n Amazon S3 to the container.

\n

\n File mode\n

\n

If an algorithm supports File mode, SageMaker downloads the training data from\n S3 to the provisioned ML storage volume, and mounts the directory to the Docker volume\n for the training container.

\n

You must provision the ML storage volume with sufficient capacity to accommodate the\n data downloaded from S3. In addition to the training data, the ML storage volume also\n stores the output model. The algorithm container uses the ML storage volume to also\n store intermediate information, if any.

\n

For distributed algorithms, training data is distributed uniformly. Your training\n duration is predictable if the input data objects sizes are approximately the same. SageMaker\n does not split the files any further for model training. If the object sizes are skewed,\n training won't be optimal as the data distribution is also skewed when one host in a\n training cluster is overloaded, thus becoming a bottleneck in training.

\n

\n FastFile mode\n

\n

If an algorithm supports FastFile mode, SageMaker streams data directly from\n S3 to the container with no code changes, and provides file system access to the data.\n Users can author their training script to interact with these files as if they were\n stored on disk.

\n

\n FastFile mode works best when the data is read sequentially. Augmented\n manifest files aren't supported. The startup time is lower when there are fewer files in\n the S3 bucket provided.

" + } + }, + "com.amazonaws.sagemaker#TrainingInstanceCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.sagemaker#TrainingInstanceType": { + "type": "enum", + "members": { + "ML_M4_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.xlarge" + } + }, + "ML_M4_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.2xlarge" + } + }, + "ML_M4_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.4xlarge" + } + }, + "ML_M4_10XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.10xlarge" + } + }, + "ML_M4_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.16xlarge" + } + }, + "ML_G4DN_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.xlarge" + } + }, + "ML_G4DN_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.2xlarge" + } + }, + "ML_G4DN_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.4xlarge" + } + }, + "ML_G4DN_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.8xlarge" + } + }, + "ML_G4DN_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.12xlarge" + } + }, + "ML_G4DN_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.16xlarge" + } + }, + "ML_M5_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.large" + } + }, + "ML_M5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.xlarge" + } + }, + "ML_M5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.2xlarge" + } + }, + "ML_M5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.4xlarge" + } + }, + "ML_M5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.12xlarge" + } + }, + "ML_M5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.24xlarge" + } + }, + "ML_C4_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.xlarge" + } + }, + "ML_C4_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.2xlarge" + } + }, + "ML_C4_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.4xlarge" + } + }, + "ML_C4_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.8xlarge" + } + }, + "ML_P2_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p2.xlarge" + } + }, + "ML_P2_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p2.8xlarge" + } + }, + "ML_P2_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p2.16xlarge" + } + }, + "ML_P3_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3.2xlarge" + } + }, + "ML_P3_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3.8xlarge" + } + }, + "ML_P3_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3.16xlarge" + } + }, + "ML_P3DN_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3dn.24xlarge" + } + }, + "ML_P4D_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p4d.24xlarge" + } + }, + "ML_P4DE_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p4de.24xlarge" + } + }, + "ML_P5_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p5.48xlarge" + } + }, + "ML_P5E_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p5e.48xlarge" + } + }, + "ML_P5EN_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p5en.48xlarge" + } + }, + "ML_C5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.xlarge" + } + }, + "ML_C5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.2xlarge" + } + }, + "ML_C5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.4xlarge" + } + }, + "ML_C5_9XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.9xlarge" + } + }, + "ML_C5_18XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.18xlarge" + } + }, + "ML_C5N_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5n.xlarge" + } + }, + "ML_C5N_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5n.2xlarge" + } + }, + "ML_C5N_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5n.4xlarge" + } + }, + "ML_C5N_9XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5n.9xlarge" + } + }, + "ML_C5N_18XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5n.18xlarge" + } + }, + "ML_G5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.xlarge" + } + }, + "ML_G5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.2xlarge" + } + }, + "ML_G5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.4xlarge" + } + }, + "ML_G5_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.8xlarge" + } + }, + "ML_G5_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.16xlarge" + } + }, + "ML_G5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.12xlarge" + } + }, + "ML_G5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.24xlarge" + } + }, + "ML_G5_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.48xlarge" + } + }, + "ML_G6_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.xlarge" + } + }, + "ML_G6_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.2xlarge" + } + }, + "ML_G6_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.4xlarge" + } + }, + "ML_G6_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.8xlarge" + } + }, + "ML_G6_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.16xlarge" + } + }, + "ML_G6_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.12xlarge" + } + }, + "ML_G6_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.24xlarge" + } + }, + "ML_G6_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.48xlarge" + } + }, + "ML_G6E_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.xlarge" + } + }, + "ML_G6E_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.2xlarge" + } + }, + "ML_G6E_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.4xlarge" + } + }, + "ML_G6E_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.8xlarge" + } + }, + "ML_G6E_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.16xlarge" + } + }, + "ML_G6E_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.12xlarge" + } + }, + "ML_G6E_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.24xlarge" + } + }, + "ML_G6E_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.48xlarge" + } + }, + "ML_TRN1_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1.2xlarge" + } + }, + "ML_TRN1_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1.32xlarge" + } + }, + "ML_TRN1N_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1n.32xlarge" + } + }, + "ML_TRN2_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn2.48xlarge" + } + }, + "ML_M6I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.large" + } + }, + "ML_M6I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.xlarge" + } + }, + "ML_M6I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.2xlarge" + } + }, + "ML_M6I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.4xlarge" + } + }, + "ML_M6I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.8xlarge" + } + }, + "ML_M6I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.12xlarge" + } + }, + "ML_M6I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.16xlarge" + } + }, + "ML_M6I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.24xlarge" + } + }, + "ML_M6I_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.32xlarge" + } + }, + "ML_C6I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.xlarge" + } + }, + "ML_C6I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.2xlarge" + } + }, + "ML_C6I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.8xlarge" + } + }, + "ML_C6I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.4xlarge" + } + }, + "ML_C6I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.12xlarge" + } + }, + "ML_C6I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.16xlarge" + } + }, + "ML_C6I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.24xlarge" + } + }, + "ML_C6I_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.32xlarge" + } + }, + "ML_R5D_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5d.large" + } + }, + "ML_R5D_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5d.xlarge" + } + }, + "ML_R5D_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5d.2xlarge" + } + }, + "ML_R5D_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5d.4xlarge" + } + }, + "ML_R5D_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5d.8xlarge" + } + }, + "ML_R5D_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5d.12xlarge" + } + }, + "ML_R5D_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5d.16xlarge" + } + }, + "ML_R5D_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5d.24xlarge" + } + }, + "ML_T3_MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.medium" + } + }, + "ML_T3_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.large" + } + }, + "ML_T3_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.xlarge" + } + }, + "ML_T3_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.2xlarge" + } + }, + "ML_R5_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.large" + } + }, + "ML_R5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.xlarge" + } + }, + "ML_R5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.2xlarge" + } + }, + "ML_R5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.4xlarge" + } + }, + "ML_R5_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.8xlarge" + } + }, + "ML_R5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.12xlarge" + } + }, + "ML_R5_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.16xlarge" + } + }, + "ML_R5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.24xlarge" + } + } + } + }, + "com.amazonaws.sagemaker#TrainingInstanceTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#TrainingInstanceType" + } + }, + "com.amazonaws.sagemaker#TrainingJob": { + "type": "structure", + "members": { + "TrainingJobName": { + "target": "com.amazonaws.sagemaker#TrainingJobName", + "traits": { + "smithy.api#documentation": "

The name of the training job.

" + } + }, + "TrainingJobArn": { + "target": "com.amazonaws.sagemaker#TrainingJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the training job.

" + } + }, + "TuningJobArn": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the\n training job was launched by a hyperparameter tuning job.

" + } + }, + "LabelingJobArn": { + "target": "com.amazonaws.sagemaker#LabelingJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the labeling job.

" + } + }, + "AutoMLJobArn": { + "target": "com.amazonaws.sagemaker#AutoMLJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the job.

" + } + }, + "ModelArtifacts": { + "target": "com.amazonaws.sagemaker#ModelArtifacts", + "traits": { + "smithy.api#documentation": "

Information about the Amazon S3 location that is configured for storing model\n artifacts.

" + } + }, + "TrainingJobStatus": { + "target": "com.amazonaws.sagemaker#TrainingJobStatus", + "traits": { + "smithy.api#documentation": "

The status of the\n training\n job.

\n

Training job statuses are:

\n
    \n
  • \n

    \n InProgress - The training is in progress.

    \n
    • \n
  • \n

    \n Completed - The training job has completed.

    \n
    • \n
  • \n

    \n Failed - The training job has failed. To see the reason for the\n failure, see the FailureReason field in the response to a\n DescribeTrainingJobResponse call.

    \n
    • \n
  • \n

    \n Stopping - The training job is stopping.

    \n
    • \n
  • \n

    \n Stopped - The training job has stopped.

    \n
    • \n
\n

For\n more detailed information, see SecondaryStatus.

" + } + }, + "SecondaryStatus": { + "target": "com.amazonaws.sagemaker#SecondaryStatus", + "traits": { + "smithy.api#documentation": "

Provides detailed information about the state of the training job. For detailed\n information about the secondary status of the training job, see\n StatusMessage under SecondaryStatusTransition.

\n

SageMaker provides primary statuses and secondary statuses that apply to each of\n them:

\n
\n
InProgress
\n
\n
    \n
  • \n

    \n Starting\n - Starting the training job.

    \n
    • \n
  • \n

    \n Downloading - An optional stage for algorithms that\n support File training input mode. It indicates that\n data is being downloaded to the ML storage volumes.

    \n
    • \n
  • \n

    \n Training - Training is in progress.

    \n
    • \n
  • \n

    \n Uploading - Training is complete and the model\n artifacts are being uploaded to the S3 location.

    \n
    • \n
\n
\n
Completed
\n
\n
    \n
  • \n

    \n Completed - The training job has completed.

    \n
    • \n
\n
\n
Failed
\n
\n
    \n
  • \n

    \n Failed - The training job has failed. The reason for\n the failure is returned in the FailureReason field of\n DescribeTrainingJobResponse.

    \n
    • \n
\n
\n
Stopped
\n
\n
    \n
  • \n

    \n MaxRuntimeExceeded - The job stopped because it\n exceeded the maximum allowed runtime.

    \n
    • \n
  • \n

    \n Stopped - The training job has stopped.

    \n
    • \n
\n
\n
Stopping
\n
\n
    \n
  • \n

    \n Stopping - Stopping the training job.

    \n
    • \n
\n
\n
\n \n

Valid values for SecondaryStatus are subject to change.

\n \n

We no longer support the following secondary statuses:

\n
    \n
  • \n

    \n LaunchingMLInstances\n

    \n
    • \n
  • \n

    \n PreparingTrainingStack\n

    \n
    • \n
  • \n

    \n DownloadingTrainingImage\n

    \n
    • \n
" + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "

If the training job failed, the reason it failed.

" + } + }, + "HyperParameters": { + "target": "com.amazonaws.sagemaker#HyperParameters", + "traits": { + "smithy.api#documentation": "

Algorithm-specific parameters.

" + } + }, + "AlgorithmSpecification": { + "target": "com.amazonaws.sagemaker#AlgorithmSpecification", + "traits": { + "smithy.api#documentation": "

Information about the algorithm used for training, and algorithm metadata.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Identity and Access Management (IAM) role configured for the\n training job.

" + } + }, + "InputDataConfig": { + "target": "com.amazonaws.sagemaker#InputDataConfig", + "traits": { + "smithy.api#documentation": "

An array of Channel objects that describes each data input\n channel.

\n

Your input must be in the same Amazon Web Services region as your training job.

" + } + }, + "OutputDataConfig": { + "target": "com.amazonaws.sagemaker#OutputDataConfig", + "traits": { + "smithy.api#documentation": "

The S3 path where model artifacts that you configured when creating the job are\n stored. SageMaker creates subfolders for model artifacts.

" + } + }, + "ResourceConfig": { + "target": "com.amazonaws.sagemaker#ResourceConfig", + "traits": { + "smithy.api#documentation": "

Resources, including ML compute instances and ML storage volumes, that are configured\n for model training.

" + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig", + "traits": { + "smithy.api#documentation": "

A VpcConfig object that specifies the VPC that this training job has access\n to. For more information, see Protect Training Jobs by Using an Amazon\n Virtual Private Cloud.

" + } + }, + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#StoppingCondition", + "traits": { + "smithy.api#documentation": "

Specifies a limit to how long a model training job can run. It also specifies how long\n a managed Spot training job has to complete. When the job reaches the time limit, SageMaker\n ends the training job. Use this API to cap model training costs.

\n

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays\n job termination for 120 seconds. Algorithms can use this 120-second window to save the\n model artifacts, so the results of training are not lost.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A timestamp that indicates when the training job was created.

" + } + }, + "TrainingStartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Indicates the time when the training job starts on training instances. You are billed\n for the time interval between this time and the value of TrainingEndTime.\n The start time in CloudWatch Logs might be later than this time. The difference is due to the time\n it takes to download the training data and to the size of the training container.

" + } + }, + "TrainingEndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Indicates the time when the training job ends on training instances. You are billed\n for the time interval between the value of TrainingStartTime and this time.\n For successful jobs and stopped jobs, this is the time after model artifacts are\n uploaded. For failed jobs, this is the time when SageMaker detects a job failure.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A timestamp that indicates when the status of the training job was last\n modified.

" + } + }, + "SecondaryStatusTransitions": { + "target": "com.amazonaws.sagemaker#SecondaryStatusTransitions", + "traits": { + "smithy.api#documentation": "

A history of all of the secondary statuses that the training job has transitioned\n through.

" + } + }, + "FinalMetricDataList": { + "target": "com.amazonaws.sagemaker#FinalMetricDataList", + "traits": { + "smithy.api#documentation": "

A list of final metric values that are set when the training job completes. Used only\n if the training job was configured to use metrics.

" + } + }, + "EnableNetworkIsolation": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

If the TrainingJob was created with network isolation, the value is set\n to true. If network isolation is enabled, nodes can't communicate beyond\n the VPC they run in.

" + } + }, + "EnableInterContainerTrafficEncryption": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

To encrypt all communications between ML compute instances in distributed training,\n choose True. Encryption provides greater security for distributed training,\n but training might take longer. How long it takes depends on the amount of communication\n between compute instances, especially if you use a deep learning algorithm in\n distributed training.

" + } + }, + "EnableManagedSpotTraining": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

When true, enables managed spot training using Amazon EC2 Spot instances to run\n training jobs instead of on-demand instances. For more information, see Managed Spot Training.

" + } + }, + "CheckpointConfig": { + "target": "com.amazonaws.sagemaker#CheckpointConfig" + }, + "TrainingTimeInSeconds": { + "target": "com.amazonaws.sagemaker#TrainingTimeInSeconds", + "traits": { + "smithy.api#documentation": "

The training time in seconds.

" + } + }, + "BillableTimeInSeconds": { + "target": "com.amazonaws.sagemaker#BillableTimeInSeconds", + "traits": { + "smithy.api#documentation": "

The billable time in seconds.

" + } + }, + "DebugHookConfig": { + "target": "com.amazonaws.sagemaker#DebugHookConfig" + }, + "ExperimentConfig": { + "target": "com.amazonaws.sagemaker#ExperimentConfig" + }, + "DebugRuleConfigurations": { + "target": "com.amazonaws.sagemaker#DebugRuleConfigurations", + "traits": { + "smithy.api#documentation": "

Information about the debug rule configuration.

" + } + }, + "TensorBoardOutputConfig": { + "target": "com.amazonaws.sagemaker#TensorBoardOutputConfig" + }, + "DebugRuleEvaluationStatuses": { + "target": "com.amazonaws.sagemaker#DebugRuleEvaluationStatuses", + "traits": { + "smithy.api#documentation": "

Information about the evaluation status of the rules for the training job.

" + } + }, + "ProfilerConfig": { + "target": "com.amazonaws.sagemaker#ProfilerConfig" + }, + "Environment": { + "target": "com.amazonaws.sagemaker#TrainingEnvironmentMap", + "traits": { + "smithy.api#documentation": "

The environment variables to set in the Docker container.

" + } + }, + "RetryStrategy": { + "target": "com.amazonaws.sagemaker#RetryStrategy", + "traits": { + "smithy.api#documentation": "

The number of times to retry the job when the job fails due to an\n InternalServerError.

" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a training job.

" + } + }, + "com.amazonaws.sagemaker#TrainingJobArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:training-job/" + } + }, + "com.amazonaws.sagemaker#TrainingJobDefinition": { + "type": "structure", + "members": { + "TrainingInputMode": { + "target": "com.amazonaws.sagemaker#TrainingInputMode", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "HyperParameters": { + "target": "com.amazonaws.sagemaker#HyperParameters", + "traits": { + "smithy.api#documentation": "

The hyperparameters used for the training job.

" + } + }, + "InputDataConfig": { + "target": "com.amazonaws.sagemaker#InputDataConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An array of Channel objects, each of which specifies an input\n source.

", + "smithy.api#required": {} + } + }, + "OutputDataConfig": { + "target": "com.amazonaws.sagemaker#OutputDataConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

the path to the S3 bucket where you want to store model artifacts. SageMaker creates\n subfolders for the artifacts.

", + "smithy.api#required": {} + } + }, + "ResourceConfig": { + "target": "com.amazonaws.sagemaker#ResourceConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The resources, including the ML compute instances and ML storage volumes, to use for\n model training.

", + "smithy.api#required": {} + } + }, + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#StoppingCondition", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies a limit to how long a model training job can run. It also specifies how long\n a managed Spot training job has to complete. When the job reaches the time limit, SageMaker\n ends the training job. Use this API to cap model training costs.

\n

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job\n termination for 120 seconds. Algorithms can use this 120-second window to save the model\n artifacts.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines the input needed to run a training job using the algorithm.

" + } + }, + "com.amazonaws.sagemaker#TrainingJobEarlyStoppingType": { + "type": "enum", + "members": { + "OFF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Off" + } + }, + "AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Auto" + } + } + } + }, + "com.amazonaws.sagemaker#TrainingJobName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#TrainingJobSortByOptions": { + "type": "enum", + "members": { + "Name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CreationTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "Status": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + }, + "FinalObjectiveMetricValue": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FinalObjectiveMetricValue" + } + } + } + }, + "com.amazonaws.sagemaker#TrainingJobStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + } + } + }, + "com.amazonaws.sagemaker#TrainingJobStatusCounter": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.sagemaker#TrainingJobStatusCounters": { + "type": "structure", + "members": { + "Completed": { + "target": "com.amazonaws.sagemaker#TrainingJobStatusCounter", + "traits": { + "smithy.api#documentation": "

The number of completed training jobs launched by the hyperparameter tuning\n job.

" + } + }, + "InProgress": { + "target": "com.amazonaws.sagemaker#TrainingJobStatusCounter", + "traits": { + "smithy.api#documentation": "

The number of in-progress training jobs launched by a hyperparameter tuning\n job.

" + } + }, + "RetryableError": { + "target": "com.amazonaws.sagemaker#TrainingJobStatusCounter", + "traits": { + "smithy.api#documentation": "

The number of training jobs that failed, but can be retried. A failed training job can\n be retried only if it failed because an internal service error occurred.

" + } + }, + "NonRetryableError": { + "target": "com.amazonaws.sagemaker#TrainingJobStatusCounter", + "traits": { + "smithy.api#documentation": "

The number of training jobs that failed and can't be retried. A failed training job\n can't be retried if it failed because a client error occurred.

" + } + }, + "Stopped": { + "target": "com.amazonaws.sagemaker#TrainingJobStatusCounter", + "traits": { + "smithy.api#documentation": "

The number of training jobs launched by a hyperparameter tuning job that were\n manually\n stopped.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The numbers of training jobs launched by a hyperparameter tuning job, categorized by\n status.

" + } + }, + "com.amazonaws.sagemaker#TrainingJobStepMetadata": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#TrainingJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the training job that was run by this step execution.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Metadata for a training job step.

" + } + }, + "com.amazonaws.sagemaker#TrainingJobSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#TrainingJobSummary" + } + }, + "com.amazonaws.sagemaker#TrainingJobSummary": { + "type": "structure", + "members": { + "TrainingJobName": { + "target": "com.amazonaws.sagemaker#TrainingJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the training job that you want a summary for.

", + "smithy.api#required": {} + } + }, + "TrainingJobArn": { + "target": "com.amazonaws.sagemaker#TrainingJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the training job.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A timestamp that shows when the training job was created.

", + "smithy.api#required": {} + } + }, + "TrainingEndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A timestamp that shows when the training job ended. This field is set only if the\n training job has one of the terminal statuses (Completed,\n Failed, or Stopped).

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Timestamp when the training job was last modified.

" + } + }, + "TrainingJobStatus": { + "target": "com.amazonaws.sagemaker#TrainingJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of the training job.

", + "smithy.api#required": {} + } + }, + "SecondaryStatus": { + "target": "com.amazonaws.sagemaker#SecondaryStatus", + "traits": { + "smithy.api#documentation": "

The secondary status of the training job.

" + } + }, + "WarmPoolStatus": { + "target": "com.amazonaws.sagemaker#WarmPoolStatus", + "traits": { + "smithy.api#documentation": "

The status of the warm pool associated with the training job.

" + } + }, + "TrainingPlanArn": { + "target": "com.amazonaws.sagemaker#TrainingPlanArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN); of the training plan associated with this training job.

\n

For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using\n Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides summary information about a training job.

" + } + }, + "com.amazonaws.sagemaker#TrainingPlanArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 50, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:training-plan/" + } + }, + "com.amazonaws.sagemaker#TrainingPlanArns": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#TrainingPlanArn" + } + }, + "com.amazonaws.sagemaker#TrainingPlanDurationHours": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 87600 + } + } + }, + "com.amazonaws.sagemaker#TrainingPlanDurationHoursInput": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 87600 + } + } + }, + "com.amazonaws.sagemaker#TrainingPlanDurationMinutes": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 59 + } + } + }, + "com.amazonaws.sagemaker#TrainingPlanFilter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#TrainingPlanFilterName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the filter field (e.g., Status, InstanceType).

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.sagemaker#String64", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The value to filter by for the specified field.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A filter to apply when listing or searching for training plans.

\n

For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using\n Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .

" + } + }, + "com.amazonaws.sagemaker#TrainingPlanFilterName": { + "type": "enum", + "members": { + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + } + } + }, + "com.amazonaws.sagemaker#TrainingPlanFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#TrainingPlanFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#TrainingPlanName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}$" + } + }, + "com.amazonaws.sagemaker#TrainingPlanOffering": { + "type": "structure", + "members": { + "TrainingPlanOfferingId": { + "target": "com.amazonaws.sagemaker#TrainingPlanOfferingId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The unique identifier for this training plan offering.

", + "smithy.api#required": {} + } + }, + "TargetResources": { + "target": "com.amazonaws.sagemaker#SageMakerResourceNames", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) for this training plan\n offering.

\n

Training plans are specific to their target resource.

\n
    \n
  • \n

    A training plan designed for SageMaker training jobs can only be used to schedule and\n run training jobs.

    \n
    • \n
  • \n

    A training plan for HyperPod clusters can be used exclusively to provide\n compute resources to a cluster's instance group.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "RequestedStartTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The requested start time that the user specified when searching for the training plan\n offering.

" + } + }, + "RequestedEndTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The requested end time that the user specified when searching for the training plan\n offering.

" + } + }, + "DurationHours": { + "target": "com.amazonaws.sagemaker#TrainingPlanDurationHours", + "traits": { + "smithy.api#documentation": "

The number of whole hours in the total duration for this training plan offering.

" + } + }, + "DurationMinutes": { + "target": "com.amazonaws.sagemaker#TrainingPlanDurationMinutes", + "traits": { + "smithy.api#documentation": "

The additional minutes beyond whole hours in the total duration for this training plan\n offering.

" + } + }, + "UpfrontFee": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "

The upfront fee for this training plan offering.

" + } + }, + "CurrencyCode": { + "target": "com.amazonaws.sagemaker#CurrencyCode", + "traits": { + "smithy.api#documentation": "

The currency code for the upfront fee (e.g., USD).

" + } + }, + "ReservedCapacityOfferings": { + "target": "com.amazonaws.sagemaker#ReservedCapacityOfferings", + "traits": { + "smithy.api#documentation": "

A list of reserved capacity offerings associated with this training plan\n offering.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about a training plan offering.

\n

For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using\n Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .

" + } + }, + "com.amazonaws.sagemaker#TrainingPlanOfferingId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-z0-9\\-]+$" + } + }, + "com.amazonaws.sagemaker#TrainingPlanOfferings": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#TrainingPlanOffering" + }, + "traits": { + "smithy.api#length": { + "min": 0 + } + } + }, + "com.amazonaws.sagemaker#TrainingPlanSortBy": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TrainingPlanName" + } + }, + "START_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StartTime" + } + }, + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + } + } + }, + "com.amazonaws.sagemaker#TrainingPlanSortOrder": { + "type": "enum", + "members": { + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ascending" + } + }, + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Descending" + } + } + } + }, + "com.amazonaws.sagemaker#TrainingPlanStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active" + } + }, + "SCHEDULED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Scheduled" + } + }, + "EXPIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Expired" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + } + } + }, + "com.amazonaws.sagemaker#TrainingPlanStatusMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.sagemaker#TrainingPlanSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#TrainingPlanSummary" + } + }, + "com.amazonaws.sagemaker#TrainingPlanSummary": { + "type": "structure", + "members": { + "TrainingPlanArn": { + "target": "com.amazonaws.sagemaker#TrainingPlanArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN); of the training plan.

", + "smithy.api#required": {} + } + }, + "TrainingPlanName": { + "target": "com.amazonaws.sagemaker#TrainingPlanName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the training plan.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#TrainingPlanStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The current status of the training plan (e.g., Pending, Active, Expired). To see the\n complete list of status values available for a training plan, refer to the\n Status attribute within the \n TrainingPlanSummary\n object.

", + "smithy.api#required": {} + } + }, + "StatusMessage": { + "target": "com.amazonaws.sagemaker#TrainingPlanStatusMessage", + "traits": { + "smithy.api#documentation": "

A message providing additional information about the current status of the training\n plan.

" + } + }, + "DurationHours": { + "target": "com.amazonaws.sagemaker#TrainingPlanDurationHours", + "traits": { + "smithy.api#documentation": "

The number of whole hours in the total duration for this training plan.

" + } + }, + "DurationMinutes": { + "target": "com.amazonaws.sagemaker#TrainingPlanDurationMinutes", + "traits": { + "smithy.api#documentation": "

The additional minutes beyond whole hours in the total duration for this training\n plan.

" + } + }, + "StartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The start time of the training plan.

" + } + }, + "EndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The end time of the training plan.

" + } + }, + "UpfrontFee": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "

The upfront fee for the training plan.

" + } + }, + "CurrencyCode": { + "target": "com.amazonaws.sagemaker#CurrencyCode", + "traits": { + "smithy.api#documentation": "

The currency code for the upfront fee (e.g., USD).

" + } + }, + "TotalInstanceCount": { + "target": "com.amazonaws.sagemaker#TotalInstanceCount", + "traits": { + "smithy.api#documentation": "

The total number of instances reserved in this training plan.

" + } + }, + "AvailableInstanceCount": { + "target": "com.amazonaws.sagemaker#AvailableInstanceCount", + "traits": { + "smithy.api#documentation": "

The number of instances currently available for use in this training plan.

" + } + }, + "InUseInstanceCount": { + "target": "com.amazonaws.sagemaker#InUseInstanceCount", + "traits": { + "smithy.api#documentation": "

The number of instances currently in use from this training plan.

" + } + }, + "TargetResources": { + "target": "com.amazonaws.sagemaker#SageMakerResourceNames", + "traits": { + "smithy.api#documentation": "

The target resources (e.g., training jobs, HyperPod clusters) that can use this training\n plan.

\n

Training plans are specific to their target resource.

\n
    \n
  • \n

    A training plan designed for SageMaker training jobs can only be used to schedule and\n run training jobs.

    \n
    • \n
  • \n

    A training plan for HyperPod clusters can be used exclusively to provide\n compute resources to a cluster's instance group.

    \n
    • \n
" + } + }, + "ReservedCapacitySummaries": { + "target": "com.amazonaws.sagemaker#ReservedCapacitySummaries", + "traits": { + "smithy.api#documentation": "

A list of reserved capacities associated with this training plan, including details such\n as instance types, counts, and availability zones.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details of the training plan.

\n

For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using\n Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .

" + } + }, + "com.amazonaws.sagemaker#TrainingRepositoryAccessMode": { + "type": "enum", + "members": { + "PLATFORM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Platform" + } + }, + "VPC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Vpc" + } + } + } + }, + "com.amazonaws.sagemaker#TrainingRepositoryAuthConfig": { + "type": "structure", + "members": { + "TrainingRepositoryCredentialsProviderArn": { + "target": "com.amazonaws.sagemaker#TrainingRepositoryCredentialsProviderArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Amazon Web Services Lambda function used to give SageMaker access\n credentials to your private Docker registry.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An object containing authentication information for a private Docker registry.

" + } + }, + "com.amazonaws.sagemaker#TrainingRepositoryCredentialsProviderArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:[\\p{Alnum}\\-]+:lambda:[\\p{Alnum}\\-]+:[0-9]{12}:function:" + } + }, + "com.amazonaws.sagemaker#TrainingSpecification": { + "type": "structure", + "members": { + "TrainingImage": { + "target": "com.amazonaws.sagemaker#ContainerImage", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon ECR registry path of the Docker image that contains the training\n algorithm.

", + "smithy.api#required": {} + } + }, + "TrainingImageDigest": { + "target": "com.amazonaws.sagemaker#ImageDigest", + "traits": { + "smithy.api#documentation": "

An MD5 hash of the training algorithm that identifies the Docker image used for\n training.

" + } + }, + "SupportedHyperParameters": { + "target": "com.amazonaws.sagemaker#HyperParameterSpecifications", + "traits": { + "smithy.api#documentation": "

A list of the HyperParameterSpecification objects, that define the\n supported hyperparameters. This is required if the algorithm supports automatic model\n tuning.>

" + } + }, + "SupportedTrainingInstanceTypes": { + "target": "com.amazonaws.sagemaker#TrainingInstanceTypes", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A list of the instance types that this algorithm can use for training.

", + "smithy.api#required": {} + } + }, + "SupportsDistributedTraining": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the algorithm supports distributed training. If set to false, buyers\n can't request more than one instance during training.

" + } + }, + "MetricDefinitions": { + "target": "com.amazonaws.sagemaker#MetricDefinitionList", + "traits": { + "smithy.api#documentation": "

A list of MetricDefinition objects, which are used for parsing metrics\n generated by the algorithm.

" + } + }, + "TrainingChannels": { + "target": "com.amazonaws.sagemaker#ChannelSpecifications", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A list of ChannelSpecification objects, which specify the input sources\n to be used by the algorithm.

", + "smithy.api#required": {} + } + }, + "SupportedTuningJobObjectiveMetrics": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobObjectives", + "traits": { + "smithy.api#documentation": "

A list of the metrics that the algorithm emits that can be used as the objective\n metric in a hyperparameter tuning job.

" + } + }, + "AdditionalS3DataSource": { + "target": "com.amazonaws.sagemaker#AdditionalS3DataSource", + "traits": { + "smithy.api#documentation": "

The additional data source used during the training job.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines how the algorithm is used for a training job.

" + } + }, + "com.amazonaws.sagemaker#TrainingTimeInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#TransformDataSource": { + "type": "structure", + "members": { + "S3DataSource": { + "target": "com.amazonaws.sagemaker#TransformS3DataSource", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The S3 location of the data source that is associated with a channel.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the location of the channel data.

" + } + }, + "com.amazonaws.sagemaker#TransformEnvironmentKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^[a-zA-Z_][a-zA-Z0-9_]{0,1023}$" + } + }, + "com.amazonaws.sagemaker#TransformEnvironmentMap": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#TransformEnvironmentKey" + }, + "value": { + "target": "com.amazonaws.sagemaker#TransformEnvironmentValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 16 + } + } + }, + "com.amazonaws.sagemaker#TransformEnvironmentValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10240 + }, + "smithy.api#pattern": "^[\\S\\s]*$" + } + }, + "com.amazonaws.sagemaker#TransformInput": { + "type": "structure", + "members": { + "DataSource": { + "target": "com.amazonaws.sagemaker#TransformDataSource", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Describes the location of\n the\n channel data, which is, the S3 location of the input data that the\n model can consume.

", + "smithy.api#required": {} + } + }, + "ContentType": { + "target": "com.amazonaws.sagemaker#ContentType", + "traits": { + "smithy.api#documentation": "

The multipurpose internet mail extension\n (MIME)\n type of the data. Amazon SageMaker uses the MIME type with each http call to\n transfer data to the transform job.

" + } + }, + "CompressionType": { + "target": "com.amazonaws.sagemaker#CompressionType", + "traits": { + "smithy.api#documentation": "

If your transform data\n is\n compressed, specify the compression type. Amazon SageMaker automatically\n decompresses the data for the transform job accordingly. The default value is\n None.

" + } + }, + "SplitType": { + "target": "com.amazonaws.sagemaker#SplitType", + "traits": { + "smithy.api#documentation": "

The method to use to split the transform job's data files into smaller batches.\n Splitting is necessary when the total size of each object is too large to fit in a\n single request. You can also use data splitting to improve performance by processing\n multiple concurrent mini-batches. The default value for SplitType is\n None, which indicates that input data files are not split, and request\n payloads contain the entire contents of an input object. Set the value of this parameter\n to Line to split records on a newline character boundary.\n SplitType also supports a number of record-oriented binary data\n formats. Currently, the supported record formats are:

\n
    \n
  • \n

    RecordIO

    \n
    • \n
  • \n

    TFRecord

    \n
    • \n
\n

When splitting is enabled, the size of a mini-batch depends on the values of the\n BatchStrategy and MaxPayloadInMB parameters. When the\n value of BatchStrategy is MultiRecord, Amazon SageMaker sends the maximum\n number of records in each request, up to the MaxPayloadInMB limit. If the\n value of BatchStrategy is SingleRecord, Amazon SageMaker sends individual\n records in each request.

\n \n

Some data formats represent a record as a binary payload wrapped with extra\n padding bytes. When splitting is applied to a binary data format, padding is removed\n if the value of BatchStrategy is set to SingleRecord.\n Padding is not removed if the value of BatchStrategy is set to\n MultiRecord.

\n

For more information about RecordIO, see Create a Dataset Using\n RecordIO in the MXNet documentation. For more information about\n TFRecord, see Consuming TFRecord data in the TensorFlow documentation.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the input source of a transform job and the way the transform job consumes\n it.

" + } + }, + "com.amazonaws.sagemaker#TransformInstanceCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#TransformInstanceType": { + "type": "enum", + "members": { + "ML_M4_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.xlarge" + } + }, + "ML_M4_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.2xlarge" + } + }, + "ML_M4_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.4xlarge" + } + }, + "ML_M4_10XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.10xlarge" + } + }, + "ML_M4_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.16xlarge" + } + }, + "ML_C4_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.xlarge" + } + }, + "ML_C4_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.2xlarge" + } + }, + "ML_C4_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.4xlarge" + } + }, + "ML_C4_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.8xlarge" + } + }, + "ML_P2_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p2.xlarge" + } + }, + "ML_P2_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p2.8xlarge" + } + }, + "ML_P2_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p2.16xlarge" + } + }, + "ML_P3_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3.2xlarge" + } + }, + "ML_P3_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3.8xlarge" + } + }, + "ML_P3_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3.16xlarge" + } + }, + "ML_C5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.xlarge" + } + }, + "ML_C5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.2xlarge" + } + }, + "ML_C5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.4xlarge" + } + }, + "ML_C5_9XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.9xlarge" + } + }, + "ML_C5_18XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.18xlarge" + } + }, + "ML_M5_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.large" + } + }, + "ML_M5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.xlarge" + } + }, + "ML_M5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.2xlarge" + } + }, + "ML_M5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.4xlarge" + } + }, + "ML_M5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.12xlarge" + } + }, + "ML_M5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.24xlarge" + } + }, + "ML_M6I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.large" + } + }, + "ML_M6I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.xlarge" + } + }, + "ML_M6I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.2xlarge" + } + }, + "ML_M6I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.4xlarge" + } + }, + "ML_M6I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.8xlarge" + } + }, + "ML_M6I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.12xlarge" + } + }, + "ML_M6I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.16xlarge" + } + }, + "ML_M6I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.24xlarge" + } + }, + "ML_M6I_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.32xlarge" + } + }, + "ML_C6I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.large" + } + }, + "ML_C6I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.xlarge" + } + }, + "ML_C6I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.2xlarge" + } + }, + "ML_C6I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.4xlarge" + } + }, + "ML_C6I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.8xlarge" + } + }, + "ML_C6I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.12xlarge" + } + }, + "ML_C6I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.16xlarge" + } + }, + "ML_C6I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.24xlarge" + } + }, + "ML_C6I_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.32xlarge" + } + }, + "ML_R6I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.large" + } + }, + "ML_R6I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.xlarge" + } + }, + "ML_R6I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.2xlarge" + } + }, + "ML_R6I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.4xlarge" + } + }, + "ML_R6I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.8xlarge" + } + }, + "ML_R6I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.12xlarge" + } + }, + "ML_R6I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.16xlarge" + } + }, + "ML_R6I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.24xlarge" + } + }, + "ML_R6I_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.32xlarge" + } + }, + "ML_M7I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.large" + } + }, + "ML_M7I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.xlarge" + } + }, + "ML_M7I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.2xlarge" + } + }, + "ML_M7I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.4xlarge" + } + }, + "ML_M7I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.8xlarge" + } + }, + "ML_M7I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.12xlarge" + } + }, + "ML_M7I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.16xlarge" + } + }, + "ML_M7I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.24xlarge" + } + }, + "ML_M7I_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.48xlarge" + } + }, + "ML_C7I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.large" + } + }, + "ML_C7I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.xlarge" + } + }, + "ML_C7I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.2xlarge" + } + }, + "ML_C7I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.4xlarge" + } + }, + "ML_C7I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.8xlarge" + } + }, + "ML_C7I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.12xlarge" + } + }, + "ML_C7I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.16xlarge" + } + }, + "ML_C7I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.24xlarge" + } + }, + "ML_C7I_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.48xlarge" + } + }, + "ML_R7I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.large" + } + }, + "ML_R7I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.xlarge" + } + }, + "ML_R7I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.2xlarge" + } + }, + "ML_R7I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.4xlarge" + } + }, + "ML_R7I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.8xlarge" + } + }, + "ML_R7I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.12xlarge" + } + }, + "ML_R7I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.16xlarge" + } + }, + "ML_R7I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.24xlarge" + } + }, + "ML_R7I_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.48xlarge" + } + }, + "ML_G4DN_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.xlarge" + } + }, + "ML_G4DN_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.2xlarge" + } + }, + "ML_G4DN_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.4xlarge" + } + }, + "ML_G4DN_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.8xlarge" + } + }, + "ML_G4DN_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.12xlarge" + } + }, + "ML_G4DN_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.16xlarge" + } + }, + "ML_G5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.xlarge" + } + }, + "ML_G5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.2xlarge" + } + }, + "ML_G5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.4xlarge" + } + }, + "ML_G5_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.8xlarge" + } + }, + "ML_G5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.12xlarge" + } + }, + "ML_G5_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.16xlarge" + } + }, + "ML_G5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.24xlarge" + } + }, + "ML_G5_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.48xlarge" + } + }, + "ML_TRN1_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1.2xlarge" + } + }, + "ML_TRN1_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1.32xlarge" + } + }, + "ML_INF2_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf2.xlarge" + } + }, + "ML_INF2_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf2.8xlarge" + } + }, + "ML_INF2_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf2.24xlarge" + } + }, + "ML_INF2_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf2.48xlarge" + } + } + } + }, + "com.amazonaws.sagemaker#TransformInstanceTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#TransformInstanceType" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#TransformJob": { + "type": "structure", + "members": { + "TransformJobName": { + "target": "com.amazonaws.sagemaker#TransformJobName", + "traits": { + "smithy.api#documentation": "

The name of the transform job.

" + } + }, + "TransformJobArn": { + "target": "com.amazonaws.sagemaker#TransformJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the transform job.

" + } + }, + "TransformJobStatus": { + "target": "com.amazonaws.sagemaker#TransformJobStatus", + "traits": { + "smithy.api#documentation": "

The status of the transform job.

\n

Transform job statuses are:

\n
    \n
  • \n

    \n InProgress - The job is in progress.

    \n
    • \n
  • \n

    \n Completed - The job has completed.

    \n
    • \n
  • \n

    \n Failed - The transform job has failed. To see the reason for the failure,\n see the FailureReason field in the response to a\n DescribeTransformJob call.

    \n
    • \n
  • \n

    \n Stopping - The transform job is stopping.

    \n
    • \n
  • \n

    \n Stopped - The transform job has stopped.

    \n
    • \n
" + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "

If the transform job failed, the reason it failed.

" + } + }, + "ModelName": { + "target": "com.amazonaws.sagemaker#ModelName", + "traits": { + "smithy.api#documentation": "

The name of the model associated with the transform job.

" + } + }, + "MaxConcurrentTransforms": { + "target": "com.amazonaws.sagemaker#MaxConcurrentTransforms", + "traits": { + "smithy.api#documentation": "

The maximum number of parallel requests that can be sent to each instance in a transform\n job. If MaxConcurrentTransforms is set to 0 or left unset, SageMaker checks the\n optional execution-parameters to determine the settings for your chosen algorithm. If the\n execution-parameters endpoint is not enabled, the default value is 1. For built-in algorithms,\n you don't need to set a value for MaxConcurrentTransforms.

" + } + }, + "ModelClientConfig": { + "target": "com.amazonaws.sagemaker#ModelClientConfig" + }, + "MaxPayloadInMB": { + "target": "com.amazonaws.sagemaker#MaxPayloadInMB", + "traits": { + "smithy.api#documentation": "

The maximum allowed size of the payload, in MB. A payload is the data portion of a record\n (without metadata). The value in MaxPayloadInMB must be greater than, or equal\n to, the size of a single record. To estimate the size of a record in MB, divide the size of\n your dataset by the number of records. To ensure that the records fit within the maximum\n payload size, we recommend using a slightly larger value. The default value is 6 MB. For cases\n where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding,\n set the value to 0. This feature works only in supported algorithms. Currently, SageMaker built-in\n algorithms do not support HTTP chunked encoding.

" + } + }, + "BatchStrategy": { + "target": "com.amazonaws.sagemaker#BatchStrategy", + "traits": { + "smithy.api#documentation": "

Specifies the number of records to include in a mini-batch for an HTTP inference request.\n A record is a single unit of input data that inference can be made on. For example, a single\n line in a CSV file is a record.

" + } + }, + "Environment": { + "target": "com.amazonaws.sagemaker#TransformEnvironmentMap", + "traits": { + "smithy.api#documentation": "

The environment variables to set in the Docker container. We support up to 16 key and\n values entries in the map.

" + } + }, + "TransformInput": { + "target": "com.amazonaws.sagemaker#TransformInput" + }, + "TransformOutput": { + "target": "com.amazonaws.sagemaker#TransformOutput" + }, + "DataCaptureConfig": { + "target": "com.amazonaws.sagemaker#BatchDataCaptureConfig" + }, + "TransformResources": { + "target": "com.amazonaws.sagemaker#TransformResources" + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A timestamp that shows when the transform Job was created.

" + } + }, + "TransformStartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Indicates when the transform job starts on ML instances. You are billed for the time\n interval between this time and the value of TransformEndTime.

" + } + }, + "TransformEndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Indicates when the transform job has been completed, or has stopped or failed. You are\n billed for the time interval between this time and the value of\n TransformStartTime.

" + } + }, + "LabelingJobArn": { + "target": "com.amazonaws.sagemaker#LabelingJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the labeling job that created the transform job.

" + } + }, + "AutoMLJobArn": { + "target": "com.amazonaws.sagemaker#AutoMLJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AutoML job that created the transform job.

" + } + }, + "DataProcessing": { + "target": "com.amazonaws.sagemaker#DataProcessing" + }, + "ExperimentConfig": { + "target": "com.amazonaws.sagemaker#ExperimentConfig" + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags associated with the transform job.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A batch transform job. For information about SageMaker batch transform, see Use Batch\n Transform.

" + } + }, + "com.amazonaws.sagemaker#TransformJobArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:transform-job/" + } + }, + "com.amazonaws.sagemaker#TransformJobDefinition": { + "type": "structure", + "members": { + "MaxConcurrentTransforms": { + "target": "com.amazonaws.sagemaker#MaxConcurrentTransforms", + "traits": { + "smithy.api#documentation": "

The maximum number of parallel requests that can be sent to each instance in a\n transform job. The default value is 1.

" + } + }, + "MaxPayloadInMB": { + "target": "com.amazonaws.sagemaker#MaxPayloadInMB", + "traits": { + "smithy.api#documentation": "

The maximum payload size allowed, in MB. A payload is the data portion of a record\n (without metadata).

" + } + }, + "BatchStrategy": { + "target": "com.amazonaws.sagemaker#BatchStrategy", + "traits": { + "smithy.api#documentation": "

A string that determines the number of records included in a single mini-batch.

\n

\n SingleRecord means only one record is used per mini-batch.\n MultiRecord means a mini-batch is set to contain as many records that\n can fit within the MaxPayloadInMB limit.

" + } + }, + "Environment": { + "target": "com.amazonaws.sagemaker#TransformEnvironmentMap", + "traits": { + "smithy.api#documentation": "

The environment variables to set in the Docker container. We support up to 16 key and\n values entries in the map.

" + } + }, + "TransformInput": { + "target": "com.amazonaws.sagemaker#TransformInput", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A description of the input source and the way the transform job consumes it.

", + "smithy.api#required": {} + } + }, + "TransformOutput": { + "target": "com.amazonaws.sagemaker#TransformOutput", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the\n transform job.

", + "smithy.api#required": {} + } + }, + "TransformResources": { + "target": "com.amazonaws.sagemaker#TransformResources", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Identifies the ML compute instances for the transform job.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines the input needed to run a transform job using the inference specification\n specified in the algorithm.

" + } + }, + "com.amazonaws.sagemaker#TransformJobName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#TransformJobStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + } + } + }, + "com.amazonaws.sagemaker#TransformJobStepMetadata": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#TransformJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the transform job that was run by this step execution.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Metadata for a transform job step.

" + } + }, + "com.amazonaws.sagemaker#TransformJobSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#TransformJobSummary" + } + }, + "com.amazonaws.sagemaker#TransformJobSummary": { + "type": "structure", + "members": { + "TransformJobName": { + "target": "com.amazonaws.sagemaker#TransformJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the transform job.

", + "smithy.api#required": {} + } + }, + "TransformJobArn": { + "target": "com.amazonaws.sagemaker#TransformJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the transform job.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A timestamp that shows when the transform Job was created.

", + "smithy.api#required": {} + } + }, + "TransformEndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Indicates when the transform\n job\n ends on compute instances. For successful jobs and stopped jobs, this\n is the exact time\n recorded\n after the results are uploaded. For failed jobs, this is when Amazon SageMaker\n detected that the job failed.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Indicates when the transform job was last modified.

" + } + }, + "TransformJobStatus": { + "target": "com.amazonaws.sagemaker#TransformJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of the transform job.

", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "

If the transform job failed,\n the\n reason it failed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides a\n summary\n of a transform job. Multiple TransformJobSummary objects are returned as a\n list after in response to a ListTransformJobs call.

" + } + }, + "com.amazonaws.sagemaker#TransformOutput": { + "type": "structure", + "members": { + "S3OutputPath": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job. For\n example, s3://bucket-name/key-name-prefix.

\n

For every S3 object used as input for the transform job, batch transform stores the\n transformed data with an .out suffix in a corresponding subfolder in the\n location in the output prefix. For example, for the input data stored at\n s3://bucket-name/input-name-prefix/dataset01/data.csv, batch transform\n stores the transformed data at\n s3://bucket-name/output-name-prefix/input-name-prefix/data.csv.out.\n Batch transform doesn't upload partially processed objects. For an input S3 object that\n contains multiple records, it creates an .out file only if the transform\n job succeeds on the entire file. When the input contains multiple S3 objects, the batch\n transform job processes the listed S3 objects and uploads only the output for\n successfully processed objects. If any object fails in the transform job batch transform\n marks the job as failed to prompt investigation.

", + "smithy.api#required": {} + } + }, + "Accept": { + "target": "com.amazonaws.sagemaker#Accept", + "traits": { + "smithy.api#documentation": "

The MIME type used to specify the output data. Amazon SageMaker uses the MIME type with each http\n call to transfer data from the transform job.

" + } + }, + "AssembleWith": { + "target": "com.amazonaws.sagemaker#AssemblyType", + "traits": { + "smithy.api#documentation": "

Defines how to assemble the results of the transform job as a single S3 object. Choose\n a format that is most convenient to you. To concatenate the results in binary format,\n specify None. To add a newline character at the end of every transformed\n record, specify\n Line.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using\n Amazon S3 server-side encryption. The KmsKeyId can be any of the following\n formats:

\n
    \n
  • \n

    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Key ARN:\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Alias name: alias/ExampleAlias\n

    \n
    • \n
  • \n

    Alias name ARN:\n arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\n

    \n
    • \n
\n

If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your\n role's account. For more information, see KMS-Managed Encryption Keys in the\n Amazon Simple Storage Service\n Developer Guide.\n

\n

The KMS key policy must grant permission to the IAM role that you specify in your\n\tCreateModel\n\t\trequest. For more information, see Using\n Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer\n Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the results of a transform job.

" + } + }, + "com.amazonaws.sagemaker#TransformResources": { + "type": "structure", + "members": { + "InstanceType": { + "target": "com.amazonaws.sagemaker#TransformInstanceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ML compute instance type for the transform job. If you are using built-in\n algorithms to\n transform\n moderately sized datasets, we recommend using ml.m4.xlarge or\n ml.m5.largeinstance types.

", + "smithy.api#required": {} + } + }, + "InstanceCount": { + "target": "com.amazonaws.sagemaker#TransformInstanceCount", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of\n ML\n compute instances to use in the transform job. The default value is\n 1, and the maximum is 100. For distributed transform jobs,\n specify a value greater than 1.

", + "smithy.api#required": {} + } + }, + "VolumeKmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt model data on the storage volume\n attached to the ML compute instance(s) that run the batch transform job.

\n \n

Certain Nitro-based instances include local storage, dependent on the instance\n type. Local storage volumes are encrypted using a hardware module on the instance.\n You can't request a VolumeKmsKeyId when using an instance type with\n local storage.

\n

For a list of instance types that support local instance storage, see Instance Store Volumes.

\n

For more information about local instance storage encryption, see SSD\n Instance Store Volumes.

\n \n

\n The VolumeKmsKeyId can be any of the following formats:

\n
    \n
  • \n

    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Key ARN:\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Alias name: alias/ExampleAlias\n

    \n
    • \n
  • \n

    Alias name ARN:\n arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\n

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the resources, including ML instance types and ML instance count, to use for\n transform job.

" + } + }, + "com.amazonaws.sagemaker#TransformS3DataSource": { + "type": "structure", + "members": { + "S3DataType": { + "target": "com.amazonaws.sagemaker#S3DataType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

If you choose S3Prefix, S3Uri identifies a key name prefix.\n Amazon SageMaker uses all objects with the specified key name prefix for batch transform.

\n

If you choose ManifestFile, S3Uri identifies an object that\n is a manifest file containing a list of object keys that you want Amazon SageMaker to use for batch\n transform.

\n

The following values are compatible: ManifestFile,\n S3Prefix\n

\n

The following value is not compatible: AugmentedManifestFile\n

", + "smithy.api#required": {} + } + }, + "S3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Depending on the value specified for the S3DataType, identifies either a\n key name prefix or a manifest. For example:

\n
    \n
  • \n

    A key name prefix might look like this:\n\t\ts3://bucketname/exampleprefix/.

    \n
    • \n
  • \n

    A manifest might look like this:\n s3://bucketname/example.manifest\n

    \n

    The manifest is an S3 object which is a JSON file with the following format:

    \n

    \n [ {\"prefix\": \"s3://customer_bucket/some/prefix/\"},\n

    \n

    \n \"relative/path/to/custdata-1\",\n

    \n

    \n \"relative/path/custdata-2\",\n

    \n

    \n ...\n

    \n

    \n \"relative/path/custdata-N\"\n

    \n

    \n ]\n

    \n

    The preceding JSON matches the following S3Uris:

    \n

    \n s3://customer_bucket/some/prefix/relative/path/to/custdata-1\n

    \n

    \n s3://customer_bucket/some/prefix/relative/path/custdata-2\n

    \n

    \n ...\n

    \n

    \n s3://customer_bucket/some/prefix/relative/path/custdata-N\n

    \n

    The complete set of S3Uris in this manifest constitutes the\n input data for the channel for this datasource. The object that each\n S3Uris points to must be readable by the IAM role that Amazon SageMaker\n uses to perform tasks on your behalf.

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the S3 data source.

" + } + }, + "com.amazonaws.sagemaker#TransformationAttributeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.sagemaker#Trial": { + "type": "structure", + "members": { + "TrialName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

The name of the trial.

" + } + }, + "TrialArn": { + "target": "com.amazonaws.sagemaker#TrialArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the trial.

" + } + }, + "DisplayName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

The name of the trial as displayed. If DisplayName isn't specified,\n TrialName is displayed.

" + } + }, + "ExperimentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

The name of the experiment the trial is part of.

" + } + }, + "Source": { + "target": "com.amazonaws.sagemaker#TrialSource" + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the trial was created.

" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext", + "traits": { + "smithy.api#documentation": "

Who created the trial.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Who last modified the trial.

" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "MetadataProperties": { + "target": "com.amazonaws.sagemaker#MetadataProperties" + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

The list of tags that are associated with the trial. You can use Search\n API to search on the tags.

" + } + }, + "TrialComponentSummaries": { + "target": "com.amazonaws.sagemaker#TrialComponentSimpleSummaries", + "traits": { + "smithy.api#documentation": "

A list of the components associated with the trial. For each component, a summary of the\n component's properties is included.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The properties of a trial as returned by the Search API.

" + } + }, + "com.amazonaws.sagemaker#TrialArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:experiment-trial/" + } + }, + "com.amazonaws.sagemaker#TrialComponent": { + "type": "structure", + "members": { + "TrialComponentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

The name of the trial component.

" + } + }, + "DisplayName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

The name of the component as displayed. If DisplayName isn't specified,\n TrialComponentName is displayed.

" + } + }, + "TrialComponentArn": { + "target": "com.amazonaws.sagemaker#TrialComponentArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the trial component.

" + } + }, + "Source": { + "target": "com.amazonaws.sagemaker#TrialComponentSource", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) and job type of the source of the component.

" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#TrialComponentStatus" + }, + "StartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the component started.

" + } + }, + "EndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the component ended.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the component was created.

" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext", + "traits": { + "smithy.api#documentation": "

Who created the trial component.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the component was last modified.

" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "Parameters": { + "target": "com.amazonaws.sagemaker#TrialComponentParameters", + "traits": { + "smithy.api#documentation": "

The hyperparameters of the component.

" + } + }, + "InputArtifacts": { + "target": "com.amazonaws.sagemaker#TrialComponentArtifacts", + "traits": { + "smithy.api#documentation": "

The input artifacts of the component.

" + } + }, + "OutputArtifacts": { + "target": "com.amazonaws.sagemaker#TrialComponentArtifacts", + "traits": { + "smithy.api#documentation": "

The output artifacts of the component.

" + } + }, + "Metrics": { + "target": "com.amazonaws.sagemaker#TrialComponentMetricSummaries", + "traits": { + "smithy.api#documentation": "

The metrics for the component.

" + } + }, + "MetadataProperties": { + "target": "com.amazonaws.sagemaker#MetadataProperties" + }, + "SourceDetail": { + "target": "com.amazonaws.sagemaker#TrialComponentSourceDetail", + "traits": { + "smithy.api#documentation": "

Details of the source of the component.

" + } + }, + "LineageGroupArn": { + "target": "com.amazonaws.sagemaker#LineageGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the lineage group resource.

" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

The list of tags that are associated with the component. You can use Search API to search on the tags.

" + } + }, + "Parents": { + "target": "com.amazonaws.sagemaker#Parents", + "traits": { + "smithy.api#documentation": "

An array of the parents of the component. A parent is a trial the component is associated\n with and the experiment the trial is part of. A component might not have any parents.

" + } + }, + "RunName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

The name of the experiment run.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The properties of a trial component as returned by the Search\n API.

" + } + }, + "com.amazonaws.sagemaker#TrialComponentArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:experiment-trial-component/" + } + }, + "com.amazonaws.sagemaker#TrialComponentArtifact": { + "type": "structure", + "members": { + "MediaType": { + "target": "com.amazonaws.sagemaker#MediaType", + "traits": { + "smithy.api#documentation": "

The media type of the artifact, which indicates the type of data in the artifact file. The\n media type consists of a type and a subtype\n concatenated with a slash (/) character, for example, text/csv, image/jpeg, and s3/uri. The\n type specifies the category of the media. The subtype specifies the kind of data.

" + } + }, + "Value": { + "target": "com.amazonaws.sagemaker#TrialComponentArtifactValue", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The location of the artifact.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents an input or output artifact of a trial component. You specify\n TrialComponentArtifact as part of the InputArtifacts and\n OutputArtifacts parameters in the CreateTrialComponent\n request.

\n

Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and\n instance types. Examples of output artifacts are metrics, snapshots, logs, and images.

" + } + }, + "com.amazonaws.sagemaker#TrialComponentArtifactValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#TrialComponentArtifacts": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#TrialComponentKey128" + }, + "value": { + "target": "com.amazonaws.sagemaker#TrialComponentArtifact" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 60 + } + } + }, + "com.amazonaws.sagemaker#TrialComponentKey128": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#TrialComponentKey256": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#TrialComponentKey320": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 320 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#TrialComponentMetricSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#TrialComponentMetricSummary" + } + }, + "com.amazonaws.sagemaker#TrialComponentMetricSummary": { + "type": "structure", + "members": { + "MetricName": { + "target": "com.amazonaws.sagemaker#MetricName", + "traits": { + "smithy.api#documentation": "

The name of the metric.

" + } + }, + "SourceArn": { + "target": "com.amazonaws.sagemaker#TrialComponentSourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source.

" + } + }, + "TimeStamp": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the metric was last updated.

" + } + }, + "Max": { + "target": "com.amazonaws.sagemaker#OptionalDouble", + "traits": { + "smithy.api#documentation": "

The maximum value of the metric.

" + } + }, + "Min": { + "target": "com.amazonaws.sagemaker#OptionalDouble", + "traits": { + "smithy.api#documentation": "

The minimum value of the metric.

" + } + }, + "Last": { + "target": "com.amazonaws.sagemaker#OptionalDouble", + "traits": { + "smithy.api#documentation": "

The most recent value of the metric.

" + } + }, + "Count": { + "target": "com.amazonaws.sagemaker#OptionalInteger", + "traits": { + "smithy.api#documentation": "

The number of samples used to generate the metric.

" + } + }, + "Avg": { + "target": "com.amazonaws.sagemaker#OptionalDouble", + "traits": { + "smithy.api#documentation": "

The average value of the metric.

" + } + }, + "StdDev": { + "target": "com.amazonaws.sagemaker#OptionalDouble", + "traits": { + "smithy.api#documentation": "

The standard deviation of the metric.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A summary of the metrics of a trial component.

" + } + }, + "com.amazonaws.sagemaker#TrialComponentParameterValue": { + "type": "union", + "members": { + "StringValue": { + "target": "com.amazonaws.sagemaker#StringParameterValue", + "traits": { + "smithy.api#documentation": "

The string value of a categorical hyperparameter. If you specify a value for this\n parameter, you can't specify the NumberValue parameter.

" + } + }, + "NumberValue": { + "target": "com.amazonaws.sagemaker#DoubleParameterValue", + "traits": { + "smithy.api#documentation": "

The numeric value of a numeric hyperparameter. If you specify a value for this parameter,\n you can't specify the StringValue parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The value of a hyperparameter. Only one of NumberValue or\n StringValue can be specified.

\n

This object is specified in the CreateTrialComponent request.

" + } + }, + "com.amazonaws.sagemaker#TrialComponentParameters": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#TrialComponentKey320" + }, + "value": { + "target": "com.amazonaws.sagemaker#TrialComponentParameterValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 300 + } + } + }, + "com.amazonaws.sagemaker#TrialComponentPrimaryStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + } + } + }, + "com.amazonaws.sagemaker#TrialComponentSimpleSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#TrialComponentSimpleSummary" + } + }, + "com.amazonaws.sagemaker#TrialComponentSimpleSummary": { + "type": "structure", + "members": { + "TrialComponentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

The name of the trial component.

" + } + }, + "TrialComponentArn": { + "target": "com.amazonaws.sagemaker#TrialComponentArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the trial component.

" + } + }, + "TrialComponentSource": { + "target": "com.amazonaws.sagemaker#TrialComponentSource" + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the component was created.

" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + } + }, + "traits": { + "smithy.api#documentation": "

A short summary of a trial component.

" + } + }, + "com.amazonaws.sagemaker#TrialComponentSource": { + "type": "structure", + "members": { + "SourceArn": { + "target": "com.amazonaws.sagemaker#TrialComponentSourceArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The source Amazon Resource Name (ARN).

", + "smithy.api#required": {} + } + }, + "SourceType": { + "target": "com.amazonaws.sagemaker#SourceType", + "traits": { + "smithy.api#documentation": "

The source job type.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) and job type of the source of a trial component.

" + } + }, + "com.amazonaws.sagemaker#TrialComponentSourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:" + } + }, + "com.amazonaws.sagemaker#TrialComponentSourceDetail": { + "type": "structure", + "members": { + "SourceArn": { + "target": "com.amazonaws.sagemaker#TrialComponentSourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source.

" + } + }, + "TrainingJob": { + "target": "com.amazonaws.sagemaker#TrainingJob", + "traits": { + "smithy.api#documentation": "

Information about a training job that's the source of a trial component.

" + } + }, + "ProcessingJob": { + "target": "com.amazonaws.sagemaker#ProcessingJob", + "traits": { + "smithy.api#documentation": "

Information about a processing job that's the source of a trial component.

" + } + }, + "TransformJob": { + "target": "com.amazonaws.sagemaker#TransformJob", + "traits": { + "smithy.api#documentation": "

Information about a transform job that's the source of a trial component.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Detailed information about the source of a trial component. Either\n ProcessingJob or TrainingJob is returned.

" + } + }, + "com.amazonaws.sagemaker#TrialComponentSources": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#TrialComponentSource" + } + }, + "com.amazonaws.sagemaker#TrialComponentStatus": { + "type": "structure", + "members": { + "PrimaryStatus": { + "target": "com.amazonaws.sagemaker#TrialComponentPrimaryStatus", + "traits": { + "smithy.api#documentation": "

The status of the trial component.

" + } + }, + "Message": { + "target": "com.amazonaws.sagemaker#TrialComponentStatusMessage", + "traits": { + "smithy.api#documentation": "

If the component failed, a message describing why.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The status of the trial component.

" + } + }, + "com.amazonaws.sagemaker#TrialComponentStatusMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#TrialComponentSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#TrialComponentSummary" + } + }, + "com.amazonaws.sagemaker#TrialComponentSummary": { + "type": "structure", + "members": { + "TrialComponentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

The name of the trial component.

" + } + }, + "TrialComponentArn": { + "target": "com.amazonaws.sagemaker#TrialComponentArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the trial component.

" + } + }, + "DisplayName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

The name of the component as displayed. If DisplayName isn't specified,\n TrialComponentName is displayed.

" + } + }, + "TrialComponentSource": { + "target": "com.amazonaws.sagemaker#TrialComponentSource" + }, + "Status": { + "target": "com.amazonaws.sagemaker#TrialComponentStatus", + "traits": { + "smithy.api#documentation": "

The status of the component. States include:

\n
    \n
  • \n

    InProgress

    \n
    • \n
  • \n

    Completed

    \n
    • \n
  • \n

    Failed

    \n
    • \n
" + } + }, + "StartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the component started.

" + } + }, + "EndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the component ended.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the component was created.

" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext", + "traits": { + "smithy.api#documentation": "

Who created the trial component.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the component was last modified.

" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext", + "traits": { + "smithy.api#documentation": "

Who last modified the component.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A summary of the properties of a trial component. To get all the properties, call the\n DescribeTrialComponent API and provide the\n TrialComponentName.

" + } + }, + "com.amazonaws.sagemaker#TrialSource": { + "type": "structure", + "members": { + "SourceArn": { + "target": "com.amazonaws.sagemaker#TrialSourceArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source.

", + "smithy.api#required": {} + } + }, + "SourceType": { + "target": "com.amazonaws.sagemaker#SourceType", + "traits": { + "smithy.api#documentation": "

The source job type.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The source of the trial.

" + } + }, + "com.amazonaws.sagemaker#TrialSourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:" + } + }, + "com.amazonaws.sagemaker#TrialSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#TrialSummary" + } + }, + "com.amazonaws.sagemaker#TrialSummary": { + "type": "structure", + "members": { + "TrialArn": { + "target": "com.amazonaws.sagemaker#TrialArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the trial.

" + } + }, + "TrialName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

The name of the trial.

" + } + }, + "DisplayName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

The name of the trial as displayed. If DisplayName isn't specified,\n TrialName is displayed.

" + } + }, + "TrialSource": { + "target": "com.amazonaws.sagemaker#TrialSource" + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the trial was created.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the trial was last modified.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A summary of the properties of a trial. To get the complete set of properties, call the\n DescribeTrial API and provide the TrialName.

" + } + }, + "com.amazonaws.sagemaker#TtlDuration": { + "type": "structure", + "members": { + "Unit": { + "target": "com.amazonaws.sagemaker#TtlDurationUnit", + "traits": { + "smithy.api#documentation": "

\n TtlDuration time unit.

" + } + }, + "Value": { + "target": "com.amazonaws.sagemaker#TtlDurationValue", + "traits": { + "smithy.api#documentation": "

\n TtlDuration time value.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Time to live duration, where the record is hard deleted after the expiration time is\n reached; ExpiresAt = EventTime + TtlDuration. For\n information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.

" + } + }, + "com.amazonaws.sagemaker#TtlDurationUnit": { + "type": "enum", + "members": { + "SECONDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Seconds" + } + }, + "MINUTES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Minutes" + } + }, + "HOURS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Hours" + } + }, + "DAYS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Days" + } + }, + "WEEKS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Weeks" + } + } + } + }, + "com.amazonaws.sagemaker#TtlDurationValue": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#TuningJobCompletionCriteria": { + "type": "structure", + "members": { + "TargetObjectiveMetricValue": { + "target": "com.amazonaws.sagemaker#TargetObjectiveMetricValue", + "traits": { + "smithy.api#documentation": "

The value of the objective metric.

" + } + }, + "BestObjectiveNotImproving": { + "target": "com.amazonaws.sagemaker#BestObjectiveNotImproving", + "traits": { + "smithy.api#documentation": "

A flag to stop your hyperparameter tuning job if model performance fails to improve as\n evaluated against an objective function.

" + } + }, + "ConvergenceDetected": { + "target": "com.amazonaws.sagemaker#ConvergenceDetected", + "traits": { + "smithy.api#documentation": "

A flag to top your hyperparameter tuning job if automatic model tuning (AMT) has\n detected that your model has converged as evaluated against your objective\n function.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The job completion criteria.

" + } + }, + "com.amazonaws.sagemaker#TuningJobStepMetaData": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Metadata for a tuning step.

" + } + }, + "com.amazonaws.sagemaker#USD": { + "type": "structure", + "members": { + "Dollars": { + "target": "com.amazonaws.sagemaker#Dollars", + "traits": { + "smithy.api#documentation": "

The whole number of dollars in the amount.

" + } + }, + "Cents": { + "target": "com.amazonaws.sagemaker#Cents", + "traits": { + "smithy.api#documentation": "

The fractional portion, in cents, of the amount.

" + } + }, + "TenthFractionsOfACent": { + "target": "com.amazonaws.sagemaker#TenthFractionsOfACent", + "traits": { + "smithy.api#documentation": "

Fractions of a cent, in tenths.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents an amount of money in United States dollars.

" + } + }, + "com.amazonaws.sagemaker#UiConfig": { + "type": "structure", + "members": { + "UiTemplateS3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "

The Amazon S3 bucket location of the UI template, or worker task template. This is the\n template used to render the worker UI and tools for labeling job tasks. For more\n information about the contents of a UI template, see Creating Your Custom\n Labeling Task Template.

" + } + }, + "HumanTaskUiArn": { + "target": "com.amazonaws.sagemaker#HumanTaskUiArn", + "traits": { + "smithy.api#documentation": "

The ARN of the worker task template used to render the worker UI and tools for\n labeling job tasks.

\n

Use this parameter when you are creating a labeling job for named entity recognition,\n 3D point cloud and video frame labeling jobs. Use your labeling job task type to select\n one of the following ARNs and use it with this parameter when you create a labeling job.\n Replace aws-region with the Amazon Web Services Region you are creating your labeling job\n in. For example, replace aws-region with us-west-1 if you\n create a labeling job in US West (N. California).

\n

\n Named Entity Recognition\n

\n

Use the following HumanTaskUiArn for named entity recognition labeling\n jobs:

\n

\n arn:aws:sagemaker:aws-region:394669845002:human-task-ui/NamedEntityRecognition\n

\n

\n 3D Point Cloud HumanTaskUiArns\n

\n

Use this HumanTaskUiArn for 3D point cloud object detection and 3D point\n cloud object detection adjustment labeling jobs.

\n
    \n
  • \n

    \n arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectDetection\n

    \n
    • \n
\n

Use this HumanTaskUiArn for 3D point cloud object tracking and 3D point\n cloud object tracking adjustment labeling jobs.

\n
    \n
  • \n

    \n arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectTracking\n

    \n
    • \n
\n

Use this HumanTaskUiArn for 3D point cloud semantic segmentation and 3D\n point cloud semantic segmentation adjustment labeling jobs.

\n
    \n
  • \n

    \n arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudSemanticSegmentation\n

    \n
    • \n
\n

\n Video Frame HumanTaskUiArns\n

\n

Use this HumanTaskUiArn for video frame object detection and video frame\n object detection adjustment labeling jobs.

\n
    \n
  • \n

    \n arn:aws:sagemaker:region:394669845002:human-task-ui/VideoObjectDetection\n

    \n
    • \n
\n

Use this HumanTaskUiArn for video frame object tracking and video frame\n object tracking adjustment labeling jobs.

\n
    \n
  • \n

    \n arn:aws:sagemaker:aws-region:394669845002:human-task-ui/VideoObjectTracking\n

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provided configuration information for the worker UI for a labeling job. Provide\n either HumanTaskUiArn or UiTemplateS3Uri.

\n

For named entity recognition, 3D point cloud and video frame labeling jobs, use\n HumanTaskUiArn.

\n

For all other Ground Truth built-in task types and custom task types, use\n UiTemplateS3Uri to specify the location of a worker task template in\n Amazon S3.

" + } + }, + "com.amazonaws.sagemaker#UiTemplate": { + "type": "structure", + "members": { + "Content": { + "target": "com.amazonaws.sagemaker#TemplateContent", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The content of the Liquid template for the worker user interface.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The Liquid template for the worker user interface.

" + } + }, + "com.amazonaws.sagemaker#UiTemplateInfo": { + "type": "structure", + "members": { + "Url": { + "target": "com.amazonaws.sagemaker#TemplateUrl", + "traits": { + "smithy.api#documentation": "

The URL for the user interface template.

" + } + }, + "ContentSha256": { + "target": "com.amazonaws.sagemaker#TemplateContentSha256", + "traits": { + "smithy.api#documentation": "

The SHA-256 digest of the contents of the template.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Container for user interface template information.

" + } + }, + "com.amazonaws.sagemaker#Uid": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 10000, + "max": 4000000 + } + } + }, + "com.amazonaws.sagemaker#UpdateAction": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateActionRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateActionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an action.

" + } + }, + "com.amazonaws.sagemaker#UpdateActionRequest": { + "type": "structure", + "members": { + "ActionName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the action to update.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#ExperimentDescription", + "traits": { + "smithy.api#documentation": "

The new description for the action.

" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#ActionStatus", + "traits": { + "smithy.api#documentation": "

The new status for the action.

" + } + }, + "Properties": { + "target": "com.amazonaws.sagemaker#LineageEntityParameters", + "traits": { + "smithy.api#documentation": "

The new list of properties. Overwrites the current property list.

" + } + }, + "PropertiesToRemove": { + "target": "com.amazonaws.sagemaker#ListLineageEntityParameterKey", + "traits": { + "smithy.api#documentation": "

A list of properties to remove.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateActionResponse": { + "type": "structure", + "members": { + "ActionArn": { + "target": "com.amazonaws.sagemaker#ActionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the action.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateAppImageConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateAppImageConfigRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateAppImageConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the properties of an AppImageConfig.

" + } + }, + "com.amazonaws.sagemaker#UpdateAppImageConfigRequest": { + "type": "structure", + "members": { + "AppImageConfigName": { + "target": "com.amazonaws.sagemaker#AppImageConfigName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the AppImageConfig to update.

", + "smithy.api#required": {} + } + }, + "KernelGatewayImageConfig": { + "target": "com.amazonaws.sagemaker#KernelGatewayImageConfig", + "traits": { + "smithy.api#documentation": "

The new KernelGateway app to run on the image.

" + } + }, + "JupyterLabAppImageConfig": { + "target": "com.amazonaws.sagemaker#JupyterLabAppImageConfig", + "traits": { + "smithy.api#documentation": "

The JupyterLab app running on the image.

" + } + }, + "CodeEditorAppImageConfig": { + "target": "com.amazonaws.sagemaker#CodeEditorAppImageConfig", + "traits": { + "smithy.api#documentation": "

The Code Editor app running on the image.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateAppImageConfigResponse": { + "type": "structure", + "members": { + "AppImageConfigArn": { + "target": "com.amazonaws.sagemaker#AppImageConfigArn", + "traits": { + "smithy.api#documentation": "

The ARN for the AppImageConfig.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateArtifact": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateArtifactRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateArtifactResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an artifact.

" + } + }, + "com.amazonaws.sagemaker#UpdateArtifactRequest": { + "type": "structure", + "members": { + "ArtifactArn": { + "target": "com.amazonaws.sagemaker#ArtifactArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the artifact to update.

", + "smithy.api#required": {} + } + }, + "ArtifactName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

The new name for the artifact.

" + } + }, + "Properties": { + "target": "com.amazonaws.sagemaker#ArtifactProperties", + "traits": { + "smithy.api#documentation": "

The new list of properties. Overwrites the current property list.

" + } + }, + "PropertiesToRemove": { + "target": "com.amazonaws.sagemaker#ListLineageEntityParameterKey", + "traits": { + "smithy.api#documentation": "

A list of properties to remove.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateArtifactResponse": { + "type": "structure", + "members": { + "ArtifactArn": { + "target": "com.amazonaws.sagemaker#ArtifactArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the artifact.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateClusterRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateClusterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a SageMaker HyperPod cluster.

" + } + }, + "com.amazonaws.sagemaker#UpdateClusterRequest": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.sagemaker#ClusterNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specify the name of the SageMaker HyperPod cluster you want to update.

", + "smithy.api#required": {} + } + }, + "InstanceGroups": { + "target": "com.amazonaws.sagemaker#ClusterInstanceGroupSpecifications", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specify the instance groups to update.

", + "smithy.api#required": {} + } + }, + "NodeRecovery": { + "target": "com.amazonaws.sagemaker#ClusterNodeRecovery", + "traits": { + "smithy.api#documentation": "

The node recovery mode to be applied to the SageMaker HyperPod cluster.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateClusterResponse": { + "type": "structure", + "members": { + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the updated SageMaker HyperPod cluster.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateClusterSchedulerConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateClusterSchedulerConfigRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateClusterSchedulerConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Update the cluster policy configuration.

" + } + }, + "com.amazonaws.sagemaker#UpdateClusterSchedulerConfigRequest": { + "type": "structure", + "members": { + "ClusterSchedulerConfigId": { + "target": "com.amazonaws.sagemaker#ClusterSchedulerConfigId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

ID of the cluster policy.

", + "smithy.api#required": {} + } + }, + "TargetVersion": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Target version.

", + "smithy.api#required": {} + } + }, + "SchedulerConfig": { + "target": "com.amazonaws.sagemaker#SchedulerConfig", + "traits": { + "smithy.api#documentation": "

Cluster policy configuration.

" + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "

Description of the cluster policy.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateClusterSchedulerConfigResponse": { + "type": "structure", + "members": { + "ClusterSchedulerConfigArn": { + "target": "com.amazonaws.sagemaker#ClusterSchedulerConfigArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

ARN of the cluster policy.

", + "smithy.api#required": {} + } + }, + "ClusterSchedulerConfigVersion": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Version of the cluster policy.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateClusterSoftware": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateClusterSoftwareRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateClusterSoftwareResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the platform software of a SageMaker HyperPod cluster for security patching. To learn how to\n use this API, see Update the SageMaker HyperPod platform software of a cluster.

\n \n

The UpgradeClusterSoftware API call may impact your SageMaker HyperPod cluster\n uptime and availability. Plan accordingly to mitigate potential disruptions to your\n workloads.

\n " + } + }, + "com.amazonaws.sagemaker#UpdateClusterSoftwareRequest": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.sagemaker#ClusterNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specify the name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster you want to update for security\n patching.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateClusterSoftwareResponse": { + "type": "structure", + "members": { + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster being updated for security patching.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateCodeRepository": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateCodeRepositoryInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateCodeRepositoryOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the specified Git repository with the specified values.

" + } + }, + "com.amazonaws.sagemaker#UpdateCodeRepositoryInput": { + "type": "structure", + "members": { + "CodeRepositoryName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Git repository to update.

", + "smithy.api#required": {} + } + }, + "GitConfig": { + "target": "com.amazonaws.sagemaker#GitConfigForUpdate", + "traits": { + "smithy.api#documentation": "

The configuration of the git repository, including the URL and the Amazon Resource\n Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the\n credentials used to access the repository. The secret must have a staging label of\n AWSCURRENT and must be in the following format:

\n

\n {\"username\": UserName, \"password\":\n Password}\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateCodeRepositoryOutput": { + "type": "structure", + "members": { + "CodeRepositoryArn": { + "target": "com.amazonaws.sagemaker#CodeRepositoryArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the Git repository.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateComputeQuota": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateComputeQuotaRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateComputeQuotaResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Update the compute allocation definition.

" + } + }, + "com.amazonaws.sagemaker#UpdateComputeQuotaRequest": { + "type": "structure", + "members": { + "ComputeQuotaId": { + "target": "com.amazonaws.sagemaker#ComputeQuotaId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

ID of the compute allocation definition.

", + "smithy.api#required": {} + } + }, + "TargetVersion": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Target version.

", + "smithy.api#required": {} + } + }, + "ComputeQuotaConfig": { + "target": "com.amazonaws.sagemaker#ComputeQuotaConfig", + "traits": { + "smithy.api#documentation": "

Configuration of the compute allocation definition. This includes the resource sharing\n option, and the setting to preempt low priority tasks.

" + } + }, + "ComputeQuotaTarget": { + "target": "com.amazonaws.sagemaker#ComputeQuotaTarget", + "traits": { + "smithy.api#documentation": "

The target entity to allocate compute resources to.

" + } + }, + "ActivationState": { + "target": "com.amazonaws.sagemaker#ActivationState", + "traits": { + "smithy.api#documentation": "

The state of the compute allocation being described. Use to enable or disable compute\n allocation.

\n

Default is Enabled.

" + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "

Description of the compute allocation definition.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateComputeQuotaResponse": { + "type": "structure", + "members": { + "ComputeQuotaArn": { + "target": "com.amazonaws.sagemaker#ComputeQuotaArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

ARN of the compute allocation definition.

", + "smithy.api#required": {} + } + }, + "ComputeQuotaVersion": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Version of the compute allocation definition.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateContext": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateContextRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateContextResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a context.

" + } + }, + "com.amazonaws.sagemaker#UpdateContextRequest": { + "type": "structure", + "members": { + "ContextName": { + "target": "com.amazonaws.sagemaker#ContextName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the context to update.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#ExperimentDescription", + "traits": { + "smithy.api#documentation": "

The new description for the context.

" + } + }, + "Properties": { + "target": "com.amazonaws.sagemaker#LineageEntityParameters", + "traits": { + "smithy.api#documentation": "

The new list of properties. Overwrites the current property list.

" + } + }, + "PropertiesToRemove": { + "target": "com.amazonaws.sagemaker#ListLineageEntityParameterKey", + "traits": { + "smithy.api#documentation": "

A list of properties to remove.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateContextResponse": { + "type": "structure", + "members": { + "ContextArn": { + "target": "com.amazonaws.sagemaker#ContextArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the context.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateDeviceFleet": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateDeviceFleetRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a fleet of devices.

" + } + }, + "com.amazonaws.sagemaker#UpdateDeviceFleetRequest": { + "type": "structure", + "members": { + "DeviceFleetName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the fleet.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the device.

" + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#DeviceFleetDescription", + "traits": { + "smithy.api#documentation": "

Description of the fleet.

" + } + }, + "OutputConfig": { + "target": "com.amazonaws.sagemaker#EdgeOutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Output configuration for storing sample data collected by the fleet.

", + "smithy.api#required": {} + } + }, + "EnableIotRoleAlias": { + "target": "com.amazonaws.sagemaker#EnableIotRoleAlias", + "traits": { + "smithy.api#documentation": "

Whether to create an Amazon Web Services IoT Role Alias during device fleet creation. \n The name of the role alias generated will match this pattern: \n \"SageMakerEdge-{DeviceFleetName}\".

\n

For example, if your device fleet is called \"demo-fleet\", the name of \n the role alias will be \"SageMakerEdge-demo-fleet\".

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateDevices": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateDevicesRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Updates one or more devices in a fleet.

" + } + }, + "com.amazonaws.sagemaker#UpdateDevicesRequest": { + "type": "structure", + "members": { + "DeviceFleetName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the fleet the devices belong to.

", + "smithy.api#required": {} + } + }, + "Devices": { + "target": "com.amazonaws.sagemaker#Devices", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

List of devices to register with Edge Manager agent.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateDomain": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateDomainRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateDomainResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the default settings for new user profiles in the domain.

" + } + }, + "com.amazonaws.sagemaker#UpdateDomainRequest": { + "type": "structure", + "members": { + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the domain to be updated.

", + "smithy.api#required": {} + } + }, + "DefaultUserSettings": { + "target": "com.amazonaws.sagemaker#UserSettings", + "traits": { + "smithy.api#documentation": "

A collection of settings.

" + } + }, + "DomainSettingsForUpdate": { + "target": "com.amazonaws.sagemaker#DomainSettingsForUpdate", + "traits": { + "smithy.api#documentation": "

A collection of DomainSettings configuration values to update.

" + } + }, + "AppSecurityGroupManagement": { + "target": "com.amazonaws.sagemaker#AppSecurityGroupManagement", + "traits": { + "smithy.api#documentation": "

The entity that creates and manages the required security groups for inter-app\n communication in VPCOnly mode. Required when\n CreateDomain.AppNetworkAccessType is VPCOnly and\n DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is\n provided. If setting up the domain for use with RStudio, this value must be set to\n Service.

" + } + }, + "DefaultSpaceSettings": { + "target": "com.amazonaws.sagemaker#DefaultSpaceSettings", + "traits": { + "smithy.api#documentation": "

The default settings for shared spaces that users create in the domain.

" + } + }, + "SubnetIds": { + "target": "com.amazonaws.sagemaker#Subnets", + "traits": { + "smithy.api#documentation": "

The VPC subnets that Studio uses for communication.

\n

If removing subnets, ensure there are no apps in the InService,\n Pending, or Deleting state.

" + } + }, + "AppNetworkAccessType": { + "target": "com.amazonaws.sagemaker#AppNetworkAccessType", + "traits": { + "smithy.api#documentation": "

Specifies the VPC used for non-EFS traffic.

\n
    \n
  • \n

    \n PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker AI, which allows direct internet access.

    \n
    • \n
  • \n

    \n VpcOnly - All Studio traffic is through the specified VPC and\n subnets.

    \n
    • \n
\n

This configuration can only be modified if there are no apps in the\n InService, Pending, or Deleting state. The\n configuration cannot be updated if\n DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is already\n set or DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is\n provided as part of the same request.

" + } + }, + "TagPropagation": { + "target": "com.amazonaws.sagemaker#TagPropagation", + "traits": { + "smithy.api#documentation": "

Indicates whether custom tag propagation is supported for the domain. Defaults to\n DISABLED.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateDomainResponse": { + "type": "structure", + "members": { + "DomainArn": { + "target": "com.amazonaws.sagemaker#DomainArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the domain.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateEndpointInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateEndpointOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Deploys the EndpointConfig specified in the request to a new fleet of\n instances. SageMaker shifts endpoint traffic to the new instances with the updated endpoint\n configuration and then deletes the old instances using the previous\n EndpointConfig (there is no availability loss). For more information\n about how to control the update and traffic shifting process, see Update\n models in production.

\n

When SageMaker receives the request, it sets the endpoint status to Updating.\n After updating the endpoint, it sets the status to InService. To check the\n status of an endpoint, use the DescribeEndpoint API.\n \n

\n \n

You must not delete an EndpointConfig in use by an endpoint that is\n live or while the UpdateEndpoint or CreateEndpoint\n operations are being performed on the endpoint. To update an endpoint, you must\n create a new EndpointConfig.

\n

If you delete the EndpointConfig of an endpoint that is active or\n being created or updated you may lose visibility into the instance type the endpoint\n is using. The endpoint must be deleted in order to stop incurring charges.

\n " + } + }, + "com.amazonaws.sagemaker#UpdateEndpointInput": { + "type": "structure", + "members": { + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the endpoint whose configuration you want to update.

", + "smithy.api#required": {} + } + }, + "EndpointConfigName": { + "target": "com.amazonaws.sagemaker#EndpointConfigName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the new endpoint configuration.

", + "smithy.api#required": {} + } + }, + "RetainAllVariantProperties": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight. To\n retain the variant properties of an endpoint when updating it, set\n RetainAllVariantProperties to true. To use the variant\n properties specified in a new EndpointConfig call when updating an\n endpoint, set RetainAllVariantProperties to false. The default\n is false.

" + } + }, + "ExcludeRetainedVariantProperties": { + "target": "com.amazonaws.sagemaker#VariantPropertyList", + "traits": { + "smithy.api#documentation": "

When you are updating endpoint resources with RetainAllVariantProperties,\n whose value is set to true, ExcludeRetainedVariantProperties\n specifies the list of type VariantProperty\n to override with the values provided by EndpointConfig. If you don't\n specify a value for ExcludeRetainedVariantProperties, no variant properties\n are overridden.

" + } + }, + "DeploymentConfig": { + "target": "com.amazonaws.sagemaker#DeploymentConfig", + "traits": { + "smithy.api#documentation": "

The deployment configuration for an endpoint, which contains the desired deployment\n strategy and rollback configurations.

" + } + }, + "RetainDeploymentConfig": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether to reuse the last deployment configuration. The default value is\n false (the configuration is not reused).

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateEndpointOutput": { + "type": "structure", + "members": { + "EndpointArn": { + "target": "com.amazonaws.sagemaker#EndpointArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the endpoint.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateEndpointWeightsAndCapacities": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateEndpointWeightsAndCapacitiesInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateEndpointWeightsAndCapacitiesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Updates variant weight of one or more variants associated with an existing\n endpoint, or capacity of one variant associated with an existing endpoint. When it\n receives the request, SageMaker sets the endpoint status to Updating. After\n updating the endpoint, it sets the status to InService. To check the status\n of an endpoint, use the DescribeEndpoint API.

" + } + }, + "com.amazonaws.sagemaker#UpdateEndpointWeightsAndCapacitiesInput": { + "type": "structure", + "members": { + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of an existing SageMaker endpoint.

", + "smithy.api#required": {} + } + }, + "DesiredWeightsAndCapacities": { + "target": "com.amazonaws.sagemaker#DesiredWeightAndCapacityList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An object that provides new capacity and weight values for a variant.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateEndpointWeightsAndCapacitiesOutput": { + "type": "structure", + "members": { + "EndpointArn": { + "target": "com.amazonaws.sagemaker#EndpointArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the updated endpoint.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateExperiment": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateExperimentRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateExperimentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Adds, updates, or removes the description of an experiment. Updates the display name of an\n experiment.

" + } + }, + "com.amazonaws.sagemaker#UpdateExperimentRequest": { + "type": "structure", + "members": { + "ExperimentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the experiment to update.

", + "smithy.api#required": {} + } + }, + "DisplayName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

The name of the experiment as displayed. The name doesn't need to be unique. If\n DisplayName isn't specified, ExperimentName is displayed.

" + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#ExperimentDescription", + "traits": { + "smithy.api#documentation": "

The description of the experiment.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateExperimentResponse": { + "type": "structure", + "members": { + "ExperimentArn": { + "target": "com.amazonaws.sagemaker#ExperimentArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the experiment.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateFeatureGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateFeatureGroupRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateFeatureGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the feature group by either adding features or updating the online store\n configuration. Use one of the following request parameters at a time while using the\n UpdateFeatureGroup API.

\n

You can add features for your feature group using the FeatureAdditions\n request parameter. Features cannot be removed from a feature group.

\n

You can update the online store configuration by using the\n OnlineStoreConfig request parameter. If a TtlDuration is\n specified, the default TtlDuration applies for all records added to the\n feature group after the feature group is updated. If a record level\n TtlDuration exists from using the PutRecord API, the record\n level TtlDuration applies to that record instead of the default\n TtlDuration. To remove the default TtlDuration from an\n existing feature group, use the UpdateFeatureGroup API and set the\n TtlDuration\n Unit and Value to null.

" + } + }, + "com.amazonaws.sagemaker#UpdateFeatureGroupRequest": { + "type": "structure", + "members": { + "FeatureGroupName": { + "target": "com.amazonaws.sagemaker#FeatureGroupNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the feature group that you're updating.

", + "smithy.api#required": {} + } + }, + "FeatureAdditions": { + "target": "com.amazonaws.sagemaker#FeatureAdditions", + "traits": { + "smithy.api#documentation": "

Updates the feature group. Updating a feature group is an asynchronous operation. When\n you get an HTTP 200 response, you've made a valid request. It takes some time after you've\n made a valid request for Feature Store to update the feature group.

" + } + }, + "OnlineStoreConfig": { + "target": "com.amazonaws.sagemaker#OnlineStoreConfigUpdate", + "traits": { + "smithy.api#documentation": "

Updates the feature group online store configuration.

" + } + }, + "ThroughputConfig": { + "target": "com.amazonaws.sagemaker#ThroughputConfigUpdate" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateFeatureGroupResponse": { + "type": "structure", + "members": { + "FeatureGroupArn": { + "target": "com.amazonaws.sagemaker#FeatureGroupArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the feature group that you're updating.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateFeatureMetadata": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateFeatureMetadataRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the description and parameters of the feature group.

" + } + }, + "com.amazonaws.sagemaker#UpdateFeatureMetadataRequest": { + "type": "structure", + "members": { + "FeatureGroupName": { + "target": "com.amazonaws.sagemaker#FeatureGroupNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the feature group containing the feature that\n you're updating.

", + "smithy.api#required": {} + } + }, + "FeatureName": { + "target": "com.amazonaws.sagemaker#FeatureName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the feature that you're updating.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#FeatureDescription", + "traits": { + "smithy.api#documentation": "

A description that you can write to better describe the feature.

" + } + }, + "ParameterAdditions": { + "target": "com.amazonaws.sagemaker#FeatureParameterAdditions", + "traits": { + "smithy.api#documentation": "

A list of key-value pairs that you can add to better describe the feature.

" + } + }, + "ParameterRemovals": { + "target": "com.amazonaws.sagemaker#FeatureParameterRemovals", + "traits": { + "smithy.api#documentation": "

A list of parameter keys that you can specify to remove parameters that describe your\n feature.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateHub": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateHubRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateHubResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Update a hub.

" + } + }, + "com.amazonaws.sagemaker#UpdateHubRequest": { + "type": "structure", + "members": { + "HubName": { + "target": "com.amazonaws.sagemaker#HubNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the hub to update.

", + "smithy.api#required": {} + } + }, + "HubDescription": { + "target": "com.amazonaws.sagemaker#HubDescription", + "traits": { + "smithy.api#documentation": "

A description of the updated hub.

" + } + }, + "HubDisplayName": { + "target": "com.amazonaws.sagemaker#HubDisplayName", + "traits": { + "smithy.api#documentation": "

The display name of the hub.

" + } + }, + "HubSearchKeywords": { + "target": "com.amazonaws.sagemaker#HubSearchKeywordList", + "traits": { + "smithy.api#documentation": "

The searchable keywords for the hub.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateHubResponse": { + "type": "structure", + "members": { + "HubArn": { + "target": "com.amazonaws.sagemaker#HubArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the updated hub.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateImageRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateImageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the properties of a SageMaker AI image. To change the image's tags, use the\n AddTags and DeleteTags APIs.

" + } + }, + "com.amazonaws.sagemaker#UpdateImageRequest": { + "type": "structure", + "members": { + "DeleteProperties": { + "target": "com.amazonaws.sagemaker#ImageDeletePropertyList", + "traits": { + "smithy.api#documentation": "

A list of properties to delete. Only the Description and\n DisplayName properties can be deleted.

" + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#ImageDescription", + "traits": { + "smithy.api#documentation": "

The new description for the image.

" + } + }, + "DisplayName": { + "target": "com.amazonaws.sagemaker#ImageDisplayName", + "traits": { + "smithy.api#documentation": "

The new display name for the image.

" + } + }, + "ImageName": { + "target": "com.amazonaws.sagemaker#ImageName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the image to update.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "

The new ARN for the IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateImageResponse": { + "type": "structure", + "members": { + "ImageArn": { + "target": "com.amazonaws.sagemaker#ImageArn", + "traits": { + "smithy.api#documentation": "

The ARN of the image.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateImageVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateImageVersionRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateImageVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the properties of a SageMaker AI image version.

" + } + }, + "com.amazonaws.sagemaker#UpdateImageVersionRequest": { + "type": "structure", + "members": { + "ImageName": { + "target": "com.amazonaws.sagemaker#ImageName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the image.

", + "smithy.api#required": {} + } + }, + "Alias": { + "target": "com.amazonaws.sagemaker#SageMakerImageVersionAlias", + "traits": { + "smithy.api#documentation": "

The alias of the image version.

" + } + }, + "Version": { + "target": "com.amazonaws.sagemaker#ImageVersionNumber", + "traits": { + "smithy.api#documentation": "

The version of the image.

" + } + }, + "AliasesToAdd": { + "target": "com.amazonaws.sagemaker#SageMakerImageVersionAliases", + "traits": { + "smithy.api#documentation": "

A list of aliases to add.

" + } + }, + "AliasesToDelete": { + "target": "com.amazonaws.sagemaker#SageMakerImageVersionAliases", + "traits": { + "smithy.api#documentation": "

A list of aliases to delete.

" + } + }, + "VendorGuidance": { + "target": "com.amazonaws.sagemaker#VendorGuidance", + "traits": { + "smithy.api#documentation": "

The availability of the image version specified by the maintainer.

\n
    \n
  • \n

    \n NOT_PROVIDED: The maintainers did not provide a status for image version stability.

    \n
    • \n
  • \n

    \n STABLE: The image version is stable.

    \n
    • \n
  • \n

    \n TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.

    \n
    • \n
  • \n

    \n ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.

    \n
    • \n
" + } + }, + "JobType": { + "target": "com.amazonaws.sagemaker#JobType", + "traits": { + "smithy.api#documentation": "

Indicates SageMaker AI job type compatibility.

\n
    \n
  • \n

    \n TRAINING: The image version is compatible with SageMaker AI training jobs.

    \n
    • \n
  • \n

    \n INFERENCE: The image version is compatible with SageMaker AI inference jobs.

    \n
    • \n
  • \n

    \n NOTEBOOK_KERNEL: The image version is compatible with SageMaker AI notebook kernels.

    \n
    • \n
" + } + }, + "MLFramework": { + "target": "com.amazonaws.sagemaker#MLFramework", + "traits": { + "smithy.api#documentation": "

The machine learning framework vended in the image version.

" + } + }, + "ProgrammingLang": { + "target": "com.amazonaws.sagemaker#ProgrammingLang", + "traits": { + "smithy.api#documentation": "

The supported programming language and its version.

" + } + }, + "Processor": { + "target": "com.amazonaws.sagemaker#Processor", + "traits": { + "smithy.api#documentation": "

Indicates CPU or GPU compatibility.

\n
    \n
  • \n

    \n CPU: The image version is compatible with CPU.

    \n
    • \n
  • \n

    \n GPU: The image version is compatible with GPU.

    \n
    • \n
" + } + }, + "Horovod": { + "target": "com.amazonaws.sagemaker#Horovod", + "traits": { + "smithy.api#documentation": "

Indicates Horovod compatibility.

" + } + }, + "ReleaseNotes": { + "target": "com.amazonaws.sagemaker#ReleaseNotes", + "traits": { + "smithy.api#documentation": "

The maintainer description of the image version.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateImageVersionResponse": { + "type": "structure", + "members": { + "ImageVersionArn": { + "target": "com.amazonaws.sagemaker#ImageVersionArn", + "traits": { + "smithy.api#documentation": "

The ARN of the image version.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateInferenceComponent": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateInferenceComponentInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateInferenceComponentOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an inference component.

" + } + }, + "com.amazonaws.sagemaker#UpdateInferenceComponentInput": { + "type": "structure", + "members": { + "InferenceComponentName": { + "target": "com.amazonaws.sagemaker#InferenceComponentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the inference component.

", + "smithy.api#required": {} + } + }, + "Specification": { + "target": "com.amazonaws.sagemaker#InferenceComponentSpecification", + "traits": { + "smithy.api#documentation": "

Details about the resources to deploy with this inference component, including the\n model, container, and compute resources.

" + } + }, + "RuntimeConfig": { + "target": "com.amazonaws.sagemaker#InferenceComponentRuntimeConfig", + "traits": { + "smithy.api#documentation": "

Runtime settings for a model that is deployed with an inference component.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateInferenceComponentOutput": { + "type": "structure", + "members": { + "InferenceComponentArn": { + "target": "com.amazonaws.sagemaker#InferenceComponentArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the inference component.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateInferenceComponentRuntimeConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateInferenceComponentRuntimeConfigInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateInferenceComponentRuntimeConfigOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Runtime settings for a model that is deployed with an inference component.

" + } + }, + "com.amazonaws.sagemaker#UpdateInferenceComponentRuntimeConfigInput": { + "type": "structure", + "members": { + "InferenceComponentName": { + "target": "com.amazonaws.sagemaker#InferenceComponentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the inference component to update.

", + "smithy.api#required": {} + } + }, + "DesiredRuntimeConfig": { + "target": "com.amazonaws.sagemaker#InferenceComponentRuntimeConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Runtime settings for a model that is deployed with an inference component.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateInferenceComponentRuntimeConfigOutput": { + "type": "structure", + "members": { + "InferenceComponentArn": { + "target": "com.amazonaws.sagemaker#InferenceComponentArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the inference component.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateInferenceExperiment": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateInferenceExperimentRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateInferenceExperimentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

\n Updates an inference experiment that you created. The status of the inference experiment has to be either\n Created, Running. For more information on the status of an inference experiment,\n see DescribeInferenceExperiment.\n

" + } + }, + "com.amazonaws.sagemaker#UpdateInferenceExperimentRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#InferenceExperimentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the inference experiment to be updated.

", + "smithy.api#required": {} + } + }, + "Schedule": { + "target": "com.amazonaws.sagemaker#InferenceExperimentSchedule", + "traits": { + "smithy.api#documentation": "

\n The duration for which the inference experiment will run. If the status of the inference experiment is\n Created, then you can update both the start and end dates. If the status of the inference\n experiment is Running, then you can update only the end date.\n

" + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#InferenceExperimentDescription", + "traits": { + "smithy.api#documentation": "

The description of the inference experiment.

" + } + }, + "ModelVariants": { + "target": "com.amazonaws.sagemaker#ModelVariantConfigList", + "traits": { + "smithy.api#documentation": "

\n An array of ModelVariantConfig objects. There is one for each variant, whose infrastructure\n configuration you want to update.\n

" + } + }, + "DataStorageConfig": { + "target": "com.amazonaws.sagemaker#InferenceExperimentDataStorageConfig", + "traits": { + "smithy.api#documentation": "

The Amazon S3 location and configuration for storing inference request and response data.

" + } + }, + "ShadowModeConfig": { + "target": "com.amazonaws.sagemaker#ShadowModeConfig", + "traits": { + "smithy.api#documentation": "

\n The configuration of ShadowMode inference experiment type. Use this field to specify a\n production variant which takes all the inference requests, and a shadow variant to which Amazon SageMaker replicates a\n percentage of the inference requests. For the shadow variant also specify the percentage of requests that\n Amazon SageMaker replicates.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateInferenceExperimentResponse": { + "type": "structure", + "members": { + "InferenceExperimentArn": { + "target": "com.amazonaws.sagemaker#InferenceExperimentArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the updated inference experiment.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateMlflowTrackingServer": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateMlflowTrackingServerRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateMlflowTrackingServerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Updates properties of an existing MLflow Tracking Server.

" + } + }, + "com.amazonaws.sagemaker#UpdateMlflowTrackingServerRequest": { + "type": "structure", + "members": { + "TrackingServerName": { + "target": "com.amazonaws.sagemaker#TrackingServerName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the MLflow Tracking Server to update.

", + "smithy.api#required": {} + } + }, + "ArtifactStoreUri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "

The new S3 URI for the general purpose bucket to use as the artifact store for the MLflow\n Tracking Server.

" + } + }, + "TrackingServerSize": { + "target": "com.amazonaws.sagemaker#TrackingServerSize", + "traits": { + "smithy.api#documentation": "

The new size for the MLflow Tracking Server.

" + } + }, + "AutomaticModelRegistration": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry. \n To enable automatic model registration, set this value to True. \n To disable automatic model registration, set this value to False. \n If not specified, AutomaticModelRegistration defaults to False\n

" + } + }, + "WeeklyMaintenanceWindowStart": { + "target": "com.amazonaws.sagemaker#WeeklyMaintenanceWindowStart", + "traits": { + "smithy.api#documentation": "

The new weekly maintenance window start day and time to update. The maintenance window day and time should be \n in Coordinated Universal Time (UTC) 24-hour standard time. For example: TUE:03:30.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateMlflowTrackingServerResponse": { + "type": "structure", + "members": { + "TrackingServerArn": { + "target": "com.amazonaws.sagemaker#TrackingServerArn", + "traits": { + "smithy.api#documentation": "

The ARN of the updated MLflow Tracking Server.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateModelCard": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateModelCardRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateModelCardResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Update an Amazon SageMaker Model Card.

\n \n

You cannot update both model card content and model card status in a single call.

\n " + } + }, + "com.amazonaws.sagemaker#UpdateModelCardRequest": { + "type": "structure", + "members": { + "ModelCardName": { + "target": "com.amazonaws.sagemaker#ModelCardNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the model card to update.

", + "smithy.api#required": {} + } + }, + "Content": { + "target": "com.amazonaws.sagemaker#ModelCardContent", + "traits": { + "smithy.api#documentation": "

The updated model card content. Content must be in model card JSON schema and provided as a string.

\n

When updating model card content, be sure to include the full content and not just updated content.

" + } + }, + "ModelCardStatus": { + "target": "com.amazonaws.sagemaker#ModelCardStatus", + "traits": { + "smithy.api#documentation": "

The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

\n
    \n
  • \n

    \n Draft: The model card is a work in progress.

    \n
    • \n
  • \n

    \n PendingReview: The model card is pending review.

    \n
    • \n
  • \n

    \n Approved: The model card is approved.

    \n
    • \n
  • \n

    \n Archived: The model card is archived. No more updates should be made to the model\n card, but it can still be exported.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateModelCardResponse": { + "type": "structure", + "members": { + "ModelCardArn": { + "target": "com.amazonaws.sagemaker#ModelCardArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the updated model card.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateModelPackage": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateModelPackageInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateModelPackageOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a versioned model.

" + } + }, + "com.amazonaws.sagemaker#UpdateModelPackageInput": { + "type": "structure", + "members": { + "ModelPackageArn": { + "target": "com.amazonaws.sagemaker#ModelPackageArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model package.

", + "smithy.api#required": {} + } + }, + "ModelApprovalStatus": { + "target": "com.amazonaws.sagemaker#ModelApprovalStatus", + "traits": { + "smithy.api#documentation": "

The approval status of the model.

" + } + }, + "ApprovalDescription": { + "target": "com.amazonaws.sagemaker#ApprovalDescription", + "traits": { + "smithy.api#documentation": "

A description for the approval status of the model.

" + } + }, + "CustomerMetadataProperties": { + "target": "com.amazonaws.sagemaker#CustomerMetadataMap", + "traits": { + "smithy.api#documentation": "

The metadata properties associated with the model package versions.

" + } + }, + "CustomerMetadataPropertiesToRemove": { + "target": "com.amazonaws.sagemaker#CustomerMetadataKeyList", + "traits": { + "smithy.api#documentation": "

The metadata properties associated with the model package versions to remove.

" + } + }, + "AdditionalInferenceSpecificationsToAdd": { + "target": "com.amazonaws.sagemaker#AdditionalInferenceSpecifications", + "traits": { + "smithy.api#documentation": "

An array of additional Inference Specification objects to be added to the \n existing array additional Inference Specification. Total number of additional \n Inference Specifications can not exceed 15. Each additional Inference Specification \n specifies artifacts based on this model package that can be used on inference endpoints. \n Generally used with SageMaker Neo to store the compiled artifacts.

" + } + }, + "InferenceSpecification": { + "target": "com.amazonaws.sagemaker#InferenceSpecification", + "traits": { + "smithy.api#documentation": "

Specifies details about inference jobs that you can run with models based on this model\n package, including the following information:

\n
    \n
  • \n

    The Amazon ECR paths of containers that contain the inference code and model\n artifacts.

    \n
    • \n
  • \n

    The instance types that the model package supports for transform jobs and\n real-time endpoints used for inference.

    \n
    • \n
  • \n

    The input and output content formats that the model package supports for\n inference.

    \n
    • \n
" + } + }, + "SourceUri": { + "target": "com.amazonaws.sagemaker#ModelPackageSourceUri", + "traits": { + "smithy.api#documentation": "

The URI of the source for the model package.

" + } + }, + "ModelCard": { + "target": "com.amazonaws.sagemaker#ModelPackageModelCard", + "traits": { + "smithy.api#documentation": "

The model card associated with the model package. Since ModelPackageModelCard is\n tied to a model package, it is a specific usage of a model card and its schema is\n simplified compared to the schema of ModelCard. The \n ModelPackageModelCard schema does not include model_package_details,\n and model_overview is composed of the model_creator and\n model_artifact properties. For more information about the model package model\n card schema, see Model\n package model card schema. For more information about\n the model card associated with the model package, see View\n the Details of a Model Version.

" + } + }, + "ModelLifeCycle": { + "target": "com.amazonaws.sagemaker#ModelLifeCycle", + "traits": { + "smithy.api#documentation": "

\n A structure describing the current state of the model in its life cycle.\n

" + } + }, + "ClientToken": { + "target": "com.amazonaws.sagemaker#ClientToken", + "traits": { + "smithy.api#documentation": "

\n A unique token that guarantees that the call to this API is idempotent.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateModelPackageOutput": { + "type": "structure", + "members": { + "ModelPackageArn": { + "target": "com.amazonaws.sagemaker#ModelPackageArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateMonitoringAlert": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateMonitoringAlertRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateMonitoringAlertResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Update the parameters of a model monitor alert.

" + } + }, + "com.amazonaws.sagemaker#UpdateMonitoringAlertRequest": { + "type": "structure", + "members": { + "MonitoringScheduleName": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of a monitoring schedule.

", + "smithy.api#required": {} + } + }, + "MonitoringAlertName": { + "target": "com.amazonaws.sagemaker#MonitoringAlertName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of a monitoring alert.

", + "smithy.api#required": {} + } + }, + "DatapointsToAlert": { + "target": "com.amazonaws.sagemaker#MonitoringDatapointsToAlert", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Within EvaluationPeriod, how many execution failures will raise an\n alert.

", + "smithy.api#required": {} + } + }, + "EvaluationPeriod": { + "target": "com.amazonaws.sagemaker#MonitoringEvaluationPeriod", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of most recent monitoring executions to consider when evaluating alert\n status.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateMonitoringAlertResponse": { + "type": "structure", + "members": { + "MonitoringScheduleArn": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the monitoring schedule.

", + "smithy.api#required": {} + } + }, + "MonitoringAlertName": { + "target": "com.amazonaws.sagemaker#MonitoringAlertName", + "traits": { + "smithy.api#documentation": "

The name of a monitoring alert.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateMonitoringSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateMonitoringScheduleRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateMonitoringScheduleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a previously created schedule.

" + } + }, + "com.amazonaws.sagemaker#UpdateMonitoringScheduleRequest": { + "type": "structure", + "members": { + "MonitoringScheduleName": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the monitoring schedule. The name must be unique within an Amazon Web Services \n Region within an Amazon Web Services account.

", + "smithy.api#required": {} + } + }, + "MonitoringScheduleConfig": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The configuration object that specifies the monitoring schedule and defines the monitoring \n job.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateMonitoringScheduleResponse": { + "type": "structure", + "members": { + "MonitoringScheduleArn": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the monitoring schedule.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateNotebookInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateNotebookInstanceInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateNotebookInstanceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a notebook instance. NotebookInstance updates include upgrading or\n downgrading the ML compute instance used for your notebook instance to accommodate\n changes in your workload requirements.

" + } + }, + "com.amazonaws.sagemaker#UpdateNotebookInstanceInput": { + "type": "structure", + "members": { + "NotebookInstanceName": { + "target": "com.amazonaws.sagemaker#NotebookInstanceName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the notebook instance to update.

", + "smithy.api#required": {} + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#InstanceType", + "traits": { + "smithy.api#documentation": "

The Amazon ML compute instance type.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that SageMaker AI can assume to\n access the notebook instance. For more information, see SageMaker AI Roles.

\n \n

To be able to pass this role to SageMaker AI, the caller of this API must\n have the iam:PassRole permission.

\n " + } + }, + "LifecycleConfigName": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigName", + "traits": { + "smithy.api#documentation": "

The name of a lifecycle configuration to associate with the notebook instance. For\n information about lifestyle configurations, see Step 2.1: (Optional)\n Customize a Notebook Instance.

" + } + }, + "DisassociateLifecycleConfig": { + "target": "com.amazonaws.sagemaker#DisassociateNotebookInstanceLifecycleConfig", + "traits": { + "smithy.api#documentation": "

Set to true to remove the notebook instance lifecycle configuration\n currently associated with the notebook instance. This operation is idempotent. If you\n specify a lifecycle configuration that is not associated with the notebook instance when\n you call this method, it does not throw an error.

" + } + }, + "VolumeSizeInGB": { + "target": "com.amazonaws.sagemaker#NotebookInstanceVolumeSizeInGB", + "traits": { + "smithy.api#documentation": "

The size, in GB, of the ML storage volume to attach to the notebook instance. The\n default value is 5 GB. ML storage volumes are encrypted, so SageMaker AI can't\n determine the amount of available free space on the volume. Because of this, you can\n increase the volume size when you update a notebook instance, but you can't decrease the\n volume size. If you want to decrease the size of the ML storage volume in use, create a\n new notebook instance with the desired size.

" + } + }, + "DefaultCodeRepository": { + "target": "com.amazonaws.sagemaker#CodeRepositoryNameOrUrl", + "traits": { + "smithy.api#documentation": "

The Git repository to associate with the notebook instance as its default code\n repository. This can be either the name of a Git repository stored as a resource in your\n account, or the URL of a Git repository in Amazon Web Services CodeCommit\n or in any other Git repository. When you open a notebook instance, it opens in the\n directory that contains this repository. For more information, see Associating Git\n Repositories with SageMaker AI Notebook Instances.

" + } + }, + "AdditionalCodeRepositories": { + "target": "com.amazonaws.sagemaker#AdditionalCodeRepositoryNamesOrUrls", + "traits": { + "smithy.api#documentation": "

An array of up to three Git repositories to associate with the notebook instance.\n These can be either the names of Git repositories stored as resources in your account,\n or the URL of Git repositories in Amazon Web Services CodeCommit\n or in any other Git repository. These repositories are cloned at the same level as the\n default repository of your notebook instance. For more information, see Associating Git\n Repositories with SageMaker AI Notebook Instances.

" + } + }, + "AcceleratorTypes": { + "target": "com.amazonaws.sagemaker#NotebookInstanceAcceleratorTypes", + "traits": { + "smithy.api#documentation": "

This parameter is no longer supported. Elastic Inference (EI) is no longer\n available.

\n

This parameter was used to specify a list of the EI instance types to associate with\n this notebook instance.

" + } + }, + "DisassociateAcceleratorTypes": { + "target": "com.amazonaws.sagemaker#DisassociateNotebookInstanceAcceleratorTypes", + "traits": { + "smithy.api#documentation": "

This parameter is no longer supported. Elastic Inference (EI) is no longer\n available.

\n

This parameter was used to specify a list of the EI instance types to remove from this notebook\n instance.

" + } + }, + "DisassociateDefaultCodeRepository": { + "target": "com.amazonaws.sagemaker#DisassociateDefaultCodeRepository", + "traits": { + "smithy.api#documentation": "

The name or URL of the default Git repository to remove from this notebook instance.\n This operation is idempotent. If you specify a Git repository that is not associated\n with the notebook instance when you call this method, it does not throw an error.

" + } + }, + "DisassociateAdditionalCodeRepositories": { + "target": "com.amazonaws.sagemaker#DisassociateAdditionalCodeRepositories", + "traits": { + "smithy.api#documentation": "

A list of names or URLs of the default Git repositories to remove from this notebook\n instance. This operation is idempotent. If you specify a Git repository that is not\n associated with the notebook instance when you call this method, it does not throw an\n error.

" + } + }, + "RootAccess": { + "target": "com.amazonaws.sagemaker#RootAccess", + "traits": { + "smithy.api#documentation": "

Whether root access is enabled or disabled for users of the notebook instance. The\n default value is Enabled.

\n \n

If you set this to Disabled, users don't have root access on the\n notebook instance, but lifecycle configuration scripts still run with root\n permissions.

\n " + } + }, + "InstanceMetadataServiceConfiguration": { + "target": "com.amazonaws.sagemaker#InstanceMetadataServiceConfiguration", + "traits": { + "smithy.api#documentation": "

Information on the IMDS configuration of the notebook instance

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateNotebookInstanceLifecycleConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateNotebookInstanceLifecycleConfigInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateNotebookInstanceLifecycleConfigOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a notebook instance lifecycle configuration created with the CreateNotebookInstanceLifecycleConfig API.

" + } + }, + "com.amazonaws.sagemaker#UpdateNotebookInstanceLifecycleConfigInput": { + "type": "structure", + "members": { + "NotebookInstanceLifecycleConfigName": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the lifecycle configuration.

", + "smithy.api#required": {} + } + }, + "OnCreate": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigList", + "traits": { + "smithy.api#documentation": "

The shell script that runs only once, when you create a notebook instance. The shell\n script must be a base64-encoded string.

" + } + }, + "OnStart": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigList", + "traits": { + "smithy.api#documentation": "

The shell script that runs every time you start a notebook instance, including when\n you create the notebook instance. The shell script must be a base64-encoded\n string.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateNotebookInstanceLifecycleConfigOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateNotebookInstanceOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdatePartnerApp": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdatePartnerAppRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdatePartnerAppResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Updates all of the SageMaker Partner AI Apps in an account.

" + } + }, + "com.amazonaws.sagemaker#UpdatePartnerAppRequest": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#PartnerAppArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the SageMaker Partner AI App to update.

", + "smithy.api#required": {} + } + }, + "MaintenanceConfig": { + "target": "com.amazonaws.sagemaker#PartnerAppMaintenanceConfig", + "traits": { + "smithy.api#documentation": "

Maintenance configuration settings for the SageMaker Partner AI App.

" + } + }, + "Tier": { + "target": "com.amazonaws.sagemaker#NonEmptyString64", + "traits": { + "smithy.api#documentation": "

Indicates the instance type and size of the cluster attached to the SageMaker Partner AI App.

" + } + }, + "ApplicationConfig": { + "target": "com.amazonaws.sagemaker#PartnerAppConfig", + "traits": { + "smithy.api#documentation": "

Configuration settings for the SageMaker Partner AI App.

" + } + }, + "EnableIamSessionBasedIdentity": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

When set to TRUE, the SageMaker Partner AI App sets the Amazon Web Services IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.sagemaker#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique token that guarantees that the call to this API is idempotent.

", + "smithy.api#idempotencyToken": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

Each tag consists of a key and an optional value. Tag keys must be unique per\n resource.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdatePartnerAppResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#PartnerAppArn", + "traits": { + "smithy.api#documentation": "

The ARN of the SageMaker Partner AI App that was updated.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdatePipeline": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdatePipelineRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdatePipelineResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a pipeline.

" + } + }, + "com.amazonaws.sagemaker#UpdatePipelineExecution": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdatePipelineExecutionRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdatePipelineExecutionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a pipeline execution.

" + } + }, + "com.amazonaws.sagemaker#UpdatePipelineExecutionRequest": { + "type": "structure", + "members": { + "PipelineExecutionArn": { + "target": "com.amazonaws.sagemaker#PipelineExecutionArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the pipeline execution.

", + "smithy.api#required": {} + } + }, + "PipelineExecutionDescription": { + "target": "com.amazonaws.sagemaker#PipelineExecutionDescription", + "traits": { + "smithy.api#documentation": "

The description of the pipeline execution.

" + } + }, + "PipelineExecutionDisplayName": { + "target": "com.amazonaws.sagemaker#PipelineExecutionName", + "traits": { + "smithy.api#documentation": "

The display name of the pipeline execution.

" + } + }, + "ParallelismConfiguration": { + "target": "com.amazonaws.sagemaker#ParallelismConfiguration", + "traits": { + "smithy.api#documentation": "

This configuration, if specified, overrides the parallelism configuration \n of the parent pipeline for this specific run.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdatePipelineExecutionResponse": { + "type": "structure", + "members": { + "PipelineExecutionArn": { + "target": "com.amazonaws.sagemaker#PipelineExecutionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the updated pipeline execution.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdatePipelineRequest": { + "type": "structure", + "members": { + "PipelineName": { + "target": "com.amazonaws.sagemaker#PipelineName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the pipeline to update.

", + "smithy.api#required": {} + } + }, + "PipelineDisplayName": { + "target": "com.amazonaws.sagemaker#PipelineName", + "traits": { + "smithy.api#documentation": "

The display name of the pipeline.

" + } + }, + "PipelineDefinition": { + "target": "com.amazonaws.sagemaker#PipelineDefinition", + "traits": { + "smithy.api#documentation": "

The JSON pipeline definition.

" + } + }, + "PipelineDefinitionS3Location": { + "target": "com.amazonaws.sagemaker#PipelineDefinitionS3Location", + "traits": { + "smithy.api#documentation": "

The location of the pipeline definition stored in Amazon S3. If specified, \n SageMaker will retrieve the pipeline definition from this location.

" + } + }, + "PipelineDescription": { + "target": "com.amazonaws.sagemaker#PipelineDescription", + "traits": { + "smithy.api#documentation": "

The description of the pipeline.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that the pipeline uses to execute.

" + } + }, + "ParallelismConfiguration": { + "target": "com.amazonaws.sagemaker#ParallelismConfiguration", + "traits": { + "smithy.api#documentation": "

If specified, it applies to all executions of this pipeline by default.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdatePipelineResponse": { + "type": "structure", + "members": { + "PipelineArn": { + "target": "com.amazonaws.sagemaker#PipelineArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the updated pipeline.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateProject": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateProjectInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateProjectOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a machine learning (ML) project that is created from a template that \n sets up an ML pipeline from training to deploying an approved model.

\n \n

You must not update a project that is in use. If you update the\n ServiceCatalogProvisioningUpdateDetails of a project that is active\n or being created, or updated, you may lose resources already created by the\n project.

\n " + } + }, + "com.amazonaws.sagemaker#UpdateProjectInput": { + "type": "structure", + "members": { + "ProjectName": { + "target": "com.amazonaws.sagemaker#ProjectEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the project.

", + "smithy.api#required": {} + } + }, + "ProjectDescription": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "

The description for the project.

" + } + }, + "ServiceCatalogProvisioningUpdateDetails": { + "target": "com.amazonaws.sagemaker#ServiceCatalogProvisioningUpdateDetails", + "traits": { + "smithy.api#documentation": "

The product ID and provisioning artifact ID to provision a service catalog. \n The provisioning artifact ID will default to the latest provisioning artifact \n ID of the product, if you don't provide the provisioning artifact ID. For more \n information, see What is Amazon Web Services Service Catalog.\n

" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your \n Amazon Web Services resources in different ways, for example, by purpose, owner, or \n environment. For more information, see Tagging Amazon Web Services Resources.\n In addition, the project must have tag update constraints set in order to include this \n parameter in the request. For more information, see Amazon Web Services Service \n Catalog Tag Update Constraints.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateProjectOutput": { + "type": "structure", + "members": { + "ProjectArn": { + "target": "com.amazonaws.sagemaker#ProjectArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the project.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateSpace": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateSpaceRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateSpaceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the settings of a space.

\n \n

You can't edit the app type of a space in the SpaceSettings.

\n " + } + }, + "com.amazonaws.sagemaker#UpdateSpaceRequest": { + "type": "structure", + "members": { + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the associated domain.

", + "smithy.api#required": {} + } + }, + "SpaceName": { + "target": "com.amazonaws.sagemaker#SpaceName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the space.

", + "smithy.api#required": {} + } + }, + "SpaceSettings": { + "target": "com.amazonaws.sagemaker#SpaceSettings", + "traits": { + "smithy.api#documentation": "

A collection of space settings.

" + } + }, + "SpaceDisplayName": { + "target": "com.amazonaws.sagemaker#NonEmptyString64", + "traits": { + "smithy.api#documentation": "

The name of the space that appears in the Amazon SageMaker Studio UI.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateSpaceResponse": { + "type": "structure", + "members": { + "SpaceArn": { + "target": "com.amazonaws.sagemaker#SpaceArn", + "traits": { + "smithy.api#documentation": "

The space's Amazon Resource Name (ARN).

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateTrainingJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateTrainingJobRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateTrainingJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Update a model training job to request a new Debugger profiling configuration or to\n change warm pool retention length.

" + } + }, + "com.amazonaws.sagemaker#UpdateTrainingJobRequest": { + "type": "structure", + "members": { + "TrainingJobName": { + "target": "com.amazonaws.sagemaker#TrainingJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of a training job to update the Debugger profiling configuration.

", + "smithy.api#required": {} + } + }, + "ProfilerConfig": { + "target": "com.amazonaws.sagemaker#ProfilerConfigForUpdate", + "traits": { + "smithy.api#documentation": "

Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and\n storage paths.

" + } + }, + "ProfilerRuleConfigurations": { + "target": "com.amazonaws.sagemaker#ProfilerRuleConfigurations", + "traits": { + "smithy.api#documentation": "

Configuration information for Amazon SageMaker Debugger rules for profiling system and framework\n metrics.

" + } + }, + "ResourceConfig": { + "target": "com.amazonaws.sagemaker#ResourceConfigForUpdate", + "traits": { + "smithy.api#documentation": "

The training job ResourceConfig to update warm pool retention\n length.

" + } + }, + "RemoteDebugConfig": { + "target": "com.amazonaws.sagemaker#RemoteDebugConfigForUpdate", + "traits": { + "smithy.api#documentation": "

Configuration for remote debugging while the training job is running. You can update\n the remote debugging configuration when the SecondaryStatus of the job is\n Downloading or Training.To learn more about the remote\n debugging functionality of SageMaker, see Access a training container\n through Amazon Web Services Systems Manager (SSM) for remote\n debugging.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateTrainingJobResponse": { + "type": "structure", + "members": { + "TrainingJobArn": { + "target": "com.amazonaws.sagemaker#TrainingJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the training job.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateTrial": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateTrialRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateTrialResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the display name of a trial.

" + } + }, + "com.amazonaws.sagemaker#UpdateTrialComponent": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateTrialComponentRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateTrialComponentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Updates one or more properties of a trial component.

" + } + }, + "com.amazonaws.sagemaker#UpdateTrialComponentRequest": { + "type": "structure", + "members": { + "TrialComponentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the component to update.

", + "smithy.api#required": {} + } + }, + "DisplayName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

The name of the component as displayed. The name doesn't need to be unique. If\n DisplayName isn't specified, TrialComponentName is\n displayed.

" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#TrialComponentStatus", + "traits": { + "smithy.api#documentation": "

The new status of the component.

" + } + }, + "StartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the component started.

" + } + }, + "EndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

When the component ended.

" + } + }, + "Parameters": { + "target": "com.amazonaws.sagemaker#TrialComponentParameters", + "traits": { + "smithy.api#documentation": "

Replaces all of the component's hyperparameters with the specified hyperparameters or add new hyperparameters. Existing hyperparameters are replaced if the trial component is updated with an identical hyperparameter key.

" + } + }, + "ParametersToRemove": { + "target": "com.amazonaws.sagemaker#ListTrialComponentKey256", + "traits": { + "smithy.api#documentation": "

The hyperparameters to remove from the component.

" + } + }, + "InputArtifacts": { + "target": "com.amazonaws.sagemaker#TrialComponentArtifacts", + "traits": { + "smithy.api#documentation": "

Replaces all of the component's input artifacts with the specified artifacts or adds new input artifacts. Existing input artifacts are replaced if the trial component is updated with an identical input artifact key.

" + } + }, + "InputArtifactsToRemove": { + "target": "com.amazonaws.sagemaker#ListTrialComponentKey256", + "traits": { + "smithy.api#documentation": "

The input artifacts to remove from the component.

" + } + }, + "OutputArtifacts": { + "target": "com.amazonaws.sagemaker#TrialComponentArtifacts", + "traits": { + "smithy.api#documentation": "

Replaces all of the component's output artifacts with the specified artifacts or adds new output artifacts. Existing output artifacts are replaced if the trial component is updated with an identical output artifact key.

" + } + }, + "OutputArtifactsToRemove": { + "target": "com.amazonaws.sagemaker#ListTrialComponentKey256", + "traits": { + "smithy.api#documentation": "

The output artifacts to remove from the component.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateTrialComponentResponse": { + "type": "structure", + "members": { + "TrialComponentArn": { + "target": "com.amazonaws.sagemaker#TrialComponentArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the trial component.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateTrialRequest": { + "type": "structure", + "members": { + "TrialName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the trial to update.

", + "smithy.api#required": {} + } + }, + "DisplayName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

The name of the trial as displayed. The name doesn't need to be unique. If\n DisplayName isn't specified, TrialName is displayed.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateTrialResponse": { + "type": "structure", + "members": { + "TrialArn": { + "target": "com.amazonaws.sagemaker#TrialArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the trial.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateUserProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateUserProfileRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateUserProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a user profile.

" + } + }, + "com.amazonaws.sagemaker#UpdateUserProfileRequest": { + "type": "structure", + "members": { + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The domain ID.

", + "smithy.api#required": {} + } + }, + "UserProfileName": { + "target": "com.amazonaws.sagemaker#UserProfileName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The user profile name.

", + "smithy.api#required": {} + } + }, + "UserSettings": { + "target": "com.amazonaws.sagemaker#UserSettings", + "traits": { + "smithy.api#documentation": "

A collection of settings.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateUserProfileResponse": { + "type": "structure", + "members": { + "UserProfileArn": { + "target": "com.amazonaws.sagemaker#UserProfileArn", + "traits": { + "smithy.api#documentation": "

The user profile Amazon Resource Name (ARN).

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateWorkforce": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateWorkforceRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateWorkforceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + } + ], + "traits": { + "smithy.api#documentation": "

Use this operation to update your workforce. You can use this operation to \n require that workers use specific IP addresses to work on tasks\n and to update your OpenID Connect (OIDC) Identity Provider (IdP) workforce configuration.

\n

The worker portal is now supported in VPC and public internet.

\n

Use SourceIpConfig to restrict worker access to tasks to a specific range of IP addresses. \n You specify allowed IP addresses by creating a list of up to ten CIDRs.\n By default, a workforce isn't restricted to specific IP addresses. If you specify a\n range of IP addresses, workers who attempt to access tasks using any IP address outside\n the specified range are denied and get a Not Found error message on\n the worker portal.

\n

To restrict access to all the workers in public internet, add the SourceIpConfig CIDR value as \"10.0.0.0/16\".

\n \n

Amazon SageMaker does not support Source Ip restriction for worker portals in VPC.

\n \n

Use OidcConfig to update the configuration of a workforce created using\n your own OIDC IdP.

\n \n

You can only update your OIDC IdP configuration when there are no work teams\n associated with your workforce. You can delete work teams using the DeleteWorkteam operation.

\n \n

After restricting access to a range of IP addresses or updating your OIDC IdP configuration with this operation, you\n can view details about your update workforce using the DescribeWorkforce\n operation.

\n \n

This operation only applies to private workforces.

\n " + } + }, + "com.amazonaws.sagemaker#UpdateWorkforceRequest": { + "type": "structure", + "members": { + "WorkforceName": { + "target": "com.amazonaws.sagemaker#WorkforceName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the private workforce that you want to update. You can find your workforce\n name by using the ListWorkforces operation.

", + "smithy.api#required": {} + } + }, + "SourceIpConfig": { + "target": "com.amazonaws.sagemaker#SourceIpConfig", + "traits": { + "smithy.api#documentation": "

A list of one to ten worker IP address ranges (CIDRs) that can be used to\n access tasks assigned to this workforce.

\n

Maximum: Ten CIDR values

" + } + }, + "OidcConfig": { + "target": "com.amazonaws.sagemaker#OidcConfig", + "traits": { + "smithy.api#documentation": "

Use this parameter to update your OIDC Identity Provider (IdP) \n configuration for a workforce made using your own IdP.

" + } + }, + "WorkforceVpcConfig": { + "target": "com.amazonaws.sagemaker#WorkforceVpcConfigRequest", + "traits": { + "smithy.api#documentation": "

Use this parameter to update your VPC configuration for a workforce.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateWorkforceResponse": { + "type": "structure", + "members": { + "Workforce": { + "target": "com.amazonaws.sagemaker#Workforce", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A single private workforce. You can create one private work force in each Amazon Web Services Region. By default,\n any workforce-related API operation used in a specific region will apply to the\n workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateWorkteam": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateWorkteamRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateWorkteamResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an existing work team with new member definitions or description.

" + } + }, + "com.amazonaws.sagemaker#UpdateWorkteamRequest": { + "type": "structure", + "members": { + "WorkteamName": { + "target": "com.amazonaws.sagemaker#WorkteamName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the work team to update.

", + "smithy.api#required": {} + } + }, + "MemberDefinitions": { + "target": "com.amazonaws.sagemaker#MemberDefinitions", + "traits": { + "smithy.api#documentation": "

A list of MemberDefinition objects that contains objects that identify\n the workers that make up the work team.

\n

Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). \n For private workforces created using Amazon Cognito use\n CognitoMemberDefinition. For workforces created using your own OIDC identity\n provider (IdP) use OidcMemberDefinition. You should not provide input\n for both of these parameters in a single request.

\n

For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito\n user groups within the user pool used to create a workforce. All of the\n CognitoMemberDefinition objects that make up the member definition must\n have the same ClientId and UserPool values. To add a Amazon\n Cognito user group to an existing worker pool, see Adding groups to a User\n Pool. For more information about user pools, see Amazon Cognito User\n Pools.

\n

For workforces created using your own OIDC IdP, specify the user groups that you want\n to include in your private work team in OidcMemberDefinition by listing\n those groups in Groups. Be aware that user groups that are already in the\n work team must also be listed in Groups when you make this request to\n remain on the work team. If you do not include these user groups, they will no longer be\n associated with the work team you update.

" + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#String200", + "traits": { + "smithy.api#documentation": "

An updated description for the work team.

" + } + }, + "NotificationConfiguration": { + "target": "com.amazonaws.sagemaker#NotificationConfiguration", + "traits": { + "smithy.api#documentation": "

Configures SNS topic notifications for available or expiring work items

" + } + }, + "WorkerAccessConfiguration": { + "target": "com.amazonaws.sagemaker#WorkerAccessConfiguration", + "traits": { + "smithy.api#documentation": "

Use this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys. The Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateWorkteamResponse": { + "type": "structure", + "members": { + "Workteam": { + "target": "com.amazonaws.sagemaker#Workteam", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A Workteam object that describes the updated work team.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#Url": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^(https|s3)://([^/]+)/?(.*)$" + } + }, + "com.amazonaws.sagemaker#UserContext": { + "type": "structure", + "members": { + "UserProfileArn": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user's profile.

" + } + }, + "UserProfileName": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The name of the user's profile.

" + } + }, + "DomainId": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The domain associated with the user.

" + } + }, + "IamIdentity": { + "target": "com.amazonaws.sagemaker#IamIdentity", + "traits": { + "smithy.api#documentation": "

The IAM Identity details associated with the user. These details are\n associated with model package groups, model packages, and project entities only.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the user who created or modified an experiment, trial, trial\n component, lineage group, project, or model card.

" + } + }, + "com.amazonaws.sagemaker#UserProfileArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:user-profile/" + } + }, + "com.amazonaws.sagemaker#UserProfileDetails": { + "type": "structure", + "members": { + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#documentation": "

The domain ID.

" + } + }, + "UserProfileName": { + "target": "com.amazonaws.sagemaker#UserProfileName", + "traits": { + "smithy.api#documentation": "

The user profile name.

" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#UserProfileStatus", + "traits": { + "smithy.api#documentation": "

The status.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "

The creation time.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "

The last modified time.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The user profile details.

" + } + }, + "com.amazonaws.sagemaker#UserProfileList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#UserProfileDetails" + } + }, + "com.amazonaws.sagemaker#UserProfileName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#UserProfileSortKey": { + "type": "enum", + "members": { + "CreationTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "LastModifiedTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LastModifiedTime" + } + } + } + }, + "com.amazonaws.sagemaker#UserProfileStatus": { + "type": "enum", + "members": { + "Deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "InService": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InService" + } + }, + "Pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "Updating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + }, + "Update_Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Update_Failed" + } + }, + "Delete_Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Delete_Failed" + } + } + } + }, + "com.amazonaws.sagemaker#UserSettings": { + "type": "structure", + "members": { + "ExecutionRole": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "

The execution role for the user.

\n

SageMaker applies this setting only to private spaces that the user creates in the domain. SageMaker doesn't apply this setting to shared spaces.

" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.sagemaker#SecurityGroupIds", + "traits": { + "smithy.api#documentation": "

The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for\n communication.

\n

Optional when the CreateDomain.AppNetworkAccessType parameter is set to\n PublicInternetOnly.

\n

Required when the CreateDomain.AppNetworkAccessType parameter is set to\n VpcOnly, unless specified as part of the DefaultUserSettings for\n the domain.

\n

Amazon SageMaker AI adds a security group to allow NFS traffic from Amazon SageMaker AI Studio. Therefore, the number of security groups that you can specify is one less than the\n maximum number shown.

\n

SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

" + } + }, + "SharingSettings": { + "target": "com.amazonaws.sagemaker#SharingSettings", + "traits": { + "smithy.api#documentation": "

Specifies options for sharing Amazon SageMaker AI Studio notebooks.

" + } + }, + "JupyterServerAppSettings": { + "target": "com.amazonaws.sagemaker#JupyterServerAppSettings", + "traits": { + "smithy.api#documentation": "

The Jupyter server's app settings.

" + } + }, + "KernelGatewayAppSettings": { + "target": "com.amazonaws.sagemaker#KernelGatewayAppSettings", + "traits": { + "smithy.api#documentation": "

The kernel gateway app settings.

" + } + }, + "TensorBoardAppSettings": { + "target": "com.amazonaws.sagemaker#TensorBoardAppSettings", + "traits": { + "smithy.api#documentation": "

The TensorBoard app settings.

" + } + }, + "RStudioServerProAppSettings": { + "target": "com.amazonaws.sagemaker#RStudioServerProAppSettings", + "traits": { + "smithy.api#documentation": "

A collection of settings that configure user interaction with the\n RStudioServerPro app.

" + } + }, + "RSessionAppSettings": { + "target": "com.amazonaws.sagemaker#RSessionAppSettings", + "traits": { + "smithy.api#documentation": "

A collection of settings that configure the RSessionGateway app.

" + } + }, + "CanvasAppSettings": { + "target": "com.amazonaws.sagemaker#CanvasAppSettings", + "traits": { + "smithy.api#documentation": "

The Canvas app settings.

\n

SageMaker applies these settings only to private spaces that SageMaker creates for the Canvas\n app.

" + } + }, + "CodeEditorAppSettings": { + "target": "com.amazonaws.sagemaker#CodeEditorAppSettings", + "traits": { + "smithy.api#documentation": "

The Code Editor application settings.

\n

SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

" + } + }, + "JupyterLabAppSettings": { + "target": "com.amazonaws.sagemaker#JupyterLabAppSettings", + "traits": { + "smithy.api#documentation": "

The settings for the JupyterLab application.

\n

SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

" + } + }, + "SpaceStorageSettings": { + "target": "com.amazonaws.sagemaker#DefaultSpaceStorageSettings", + "traits": { + "smithy.api#documentation": "

The storage settings for a space.

\n

SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

" + } + }, + "DefaultLandingUri": { + "target": "com.amazonaws.sagemaker#LandingUri", + "traits": { + "smithy.api#documentation": "

The default experience that the user is directed to when accessing the domain. The\n supported values are:

\n
    \n
  • \n

    \n studio::: Indicates that Studio is the default experience. This value can\n only be passed if StudioWebPortal is set to ENABLED.

    \n
    • \n
  • \n

    \n app:JupyterServer:: Indicates that Studio Classic is the default\n experience.

    \n
    • \n
" + } + }, + "StudioWebPortal": { + "target": "com.amazonaws.sagemaker#StudioWebPortal", + "traits": { + "smithy.api#documentation": "

Whether the user can access Studio. If this value is set to DISABLED, the\n user cannot access Studio, even if that is the default experience for the domain.

" + } + }, + "CustomPosixUserConfig": { + "target": "com.amazonaws.sagemaker#CustomPosixUserConfig", + "traits": { + "smithy.api#documentation": "

Details about the POSIX identity that is used for file system operations.

\n

SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

" + } + }, + "CustomFileSystemConfigs": { + "target": "com.amazonaws.sagemaker#CustomFileSystemConfigs", + "traits": { + "smithy.api#documentation": "

The settings for assigning a custom file system to a user profile. Permitted users can\n access this file system in Amazon SageMaker AI Studio.

\n

SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

" + } + }, + "StudioWebPortalSettings": { + "target": "com.amazonaws.sagemaker#StudioWebPortalSettings", + "traits": { + "smithy.api#documentation": "

Studio settings. If these settings are applied on a user level, they take priority over\n the settings applied on a domain level.

" + } + }, + "AutoMountHomeEFS": { + "target": "com.amazonaws.sagemaker#AutoMountHomeEFS", + "traits": { + "smithy.api#documentation": "

Indicates whether auto-mounting of an EFS volume is supported for the user profile. The\n DefaultAsDomain value is only supported for user profiles. Do not use the\n DefaultAsDomain value when setting this parameter for a domain.

\n

SageMaker applies this setting only to private spaces that the user creates in the domain. SageMaker doesn't apply this setting to shared spaces.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A collection of settings that apply to users in a domain. These settings are specified\n when the CreateUserProfile API is called, and as DefaultUserSettings\n when the CreateDomain API is called.

\n

\n SecurityGroups is aggregated when specified in both calls. For all other\n settings in UserSettings, the values specified in CreateUserProfile\n take precedence over those specified in CreateDomain.

" + } + }, + "com.amazonaws.sagemaker#UsersPerStep": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 3 + } + } + }, + "com.amazonaws.sagemaker#UtilizationMetric": { + "type": "float", + "traits": { + "smithy.api#range": { + "min": 0.0 + } + } + }, + "com.amazonaws.sagemaker#UtilizationPercentagePerCore": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#ValidationFraction": { + "type": "float", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.sagemaker#VariantName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#VariantProperty": { + "type": "structure", + "members": { + "VariantPropertyType": { + "target": "com.amazonaws.sagemaker#VariantPropertyType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of variant property. The supported values are:

\n
    \n
  • \n

    \n DesiredInstanceCount: Overrides the existing variant instance\n counts using the InitialInstanceCount values in the\n ProductionVariants of CreateEndpointConfig.

    \n
    • \n
  • \n

    \n DesiredWeight: Overrides the existing variant weights using the\n InitialVariantWeight values in the\n ProductionVariants of CreateEndpointConfig.

    \n
    • \n
  • \n

    \n DataCaptureConfig: (Not currently supported.)

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies a production variant property type for an Endpoint.

\n

If you are updating an endpoint with the RetainAllVariantProperties\n option of UpdateEndpointInput set to true, the\n VariantProperty objects listed in the\n ExcludeRetainedVariantProperties parameter of UpdateEndpointInput override the existing variant properties of the\n endpoint.

" + } + }, + "com.amazonaws.sagemaker#VariantPropertyList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#VariantProperty" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3 + } + } + }, + "com.amazonaws.sagemaker#VariantPropertyType": { + "type": "enum", + "members": { + "DesiredInstanceCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DesiredInstanceCount" + } + }, + "DesiredWeight": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DesiredWeight" + } + }, + "DataCaptureConfig": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DataCaptureConfig" + } + } + } + }, + "com.amazonaws.sagemaker#VariantStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Creating" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "ACTIVATING_TRAFFIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ActivatingTraffic" + } + }, + "BAKING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Baking" + } + } + } + }, + "com.amazonaws.sagemaker#VariantStatusMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.sagemaker#VariantWeight": { + "type": "float", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.sagemaker#VectorConfig": { + "type": "structure", + "members": { + "Dimension": { + "target": "com.amazonaws.sagemaker#Dimension", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of elements in your vector.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration for your vector collection type.

" + } + }, + "com.amazonaws.sagemaker#VendorGuidance": { + "type": "enum", + "members": { + "NOT_PROVIDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_PROVIDED" + } + }, + "STABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STABLE" + } + }, + "TO_BE_ARCHIVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TO_BE_ARCHIVED" + } + }, + "ARCHIVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARCHIVED" + } + } + } + }, + "com.amazonaws.sagemaker#VersionAliasesList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ImageVersionAliasPattern" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.sagemaker#VersionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.sagemaker#VersionedArnOrName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 176 + }, + "smithy.api#pattern": "^(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:[a-z\\-]*\\/)?([a-zA-Z0-9]([a-zA-Z0-9-]){0,62})(?The Amazon Resource Name (ARN) of the lineage entity resource.

" + } + }, + "Type": { + "target": "com.amazonaws.sagemaker#String40", + "traits": { + "smithy.api#documentation": "

The type of the lineage entity resource. For example: DataSet, Model, Endpoint, \n etc...

" + } + }, + "LineageType": { + "target": "com.amazonaws.sagemaker#LineageType", + "traits": { + "smithy.api#documentation": "

The type of resource of the lineage entity.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A lineage entity connected to the starting entity(ies).

" + } + }, + "com.amazonaws.sagemaker#Vertices": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#Vertex" + } + }, + "com.amazonaws.sagemaker#VisibilityConditions": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.sagemaker#VisibilityConditionsKey", + "traits": { + "smithy.api#documentation": "

The key that specifies the tag that you're using to filter the search results. It must be in the following format: Tags..

" + } + }, + "Value": { + "target": "com.amazonaws.sagemaker#VisibilityConditionsValue", + "traits": { + "smithy.api#documentation": "

The value for the tag that you're using to filter the search results.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The list of key-value pairs used to filter your search results. If a search result contains a key from your list, it is included in the final search response if the value associated with the key in the result matches the value you specified. \n If the value doesn't match, the result is excluded from the search response. Any resources that don't have a key from the list that you've provided will also be included in the search response.

" + } + }, + "com.amazonaws.sagemaker#VisibilityConditionsKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + } + }, + "com.amazonaws.sagemaker#VisibilityConditionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#VisibilityConditions" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#VisibilityConditionsValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + } + }, + "com.amazonaws.sagemaker#VolumeSizeInGB": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#VpcConfig": { + "type": "structure", + "members": { + "SecurityGroupIds": { + "target": "com.amazonaws.sagemaker#VpcSecurityGroupIds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security\n groups for the VPC that is specified in the Subnets field.

", + "smithy.api#required": {} + } + }, + "Subnets": { + "target": "com.amazonaws.sagemaker#Subnets", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the subnets in the VPC to which you want to connect your training job or\n model. For information about the availability of specific instance types, see Supported\n Instance Types and Availability Zones.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources\n have access to. You can control access to and from your resources by configuring a VPC.\n For more information, see Give SageMaker Access to\n Resources in your Amazon VPC.

" + } + }, + "com.amazonaws.sagemaker#VpcId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + }, + "smithy.api#pattern": "^[-0-9a-zA-Z]+$" + } + }, + "com.amazonaws.sagemaker#VpcOnlyTrustedAccounts": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AccountId" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.sagemaker#VpcSecurityGroupIds": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#SecurityGroupId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#WaitIntervalInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 3600 + } + } + }, + "com.amazonaws.sagemaker#WarmPoolResourceStatus": { + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Available" + } + }, + "TERMINATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terminated" + } + }, + "REUSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Reused" + } + }, + "INUSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InUse" + } + } + } + }, + "com.amazonaws.sagemaker#WarmPoolStatus": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.sagemaker#WarmPoolResourceStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of the warm pool.

\n
    \n
  • \n

    \n InUse: The warm pool is in use for the training job.

    \n
    • \n
  • \n

    \n Available: The warm pool is available to reuse for a matching\n training job.

    \n
    • \n
  • \n

    \n Reused: The warm pool moved to a matching training job for\n reuse.

    \n
    • \n
  • \n

    \n Terminated: The warm pool is no longer available. Warm pools are\n unavailable if they are terminated by a user, terminated for a patch update, or\n terminated for exceeding the specified\n KeepAlivePeriodInSeconds.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "ResourceRetainedBillableTimeInSeconds": { + "target": "com.amazonaws.sagemaker#ResourceRetainedBillableTimeInSeconds", + "traits": { + "smithy.api#documentation": "

The billable time in seconds used by the warm pool. Billable time refers to the\n absolute wall-clock time.

\n

Multiply ResourceRetainedBillableTimeInSeconds by the number of instances\n (InstanceCount) in your training cluster to get the total compute time\n SageMaker bills you if you run warm pool training. The formula is as follows:\n ResourceRetainedBillableTimeInSeconds * InstanceCount.

" + } + }, + "ReusedByJob": { + "target": "com.amazonaws.sagemaker#TrainingJobName", + "traits": { + "smithy.api#documentation": "

The name of the matching training job that reused the warm pool.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Status and billing information about the warm pool.

" + } + }, + "com.amazonaws.sagemaker#WeeklyMaintenanceWindowStart": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 9 + }, + "smithy.api#pattern": "^(Mon|Tue|Wed|Thu|Fri|Sat|Sun):([01]\\d|2[0-3]):([0-5]\\d)$" + } + }, + "com.amazonaws.sagemaker#WeeklyScheduleTimeFormat": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 9 + }, + "smithy.api#pattern": "^(Mon|Tue|Wed|Thu|Fri|Sat|Sun):([01]\\d|2[0-3]):([0-5]\\d)$" + } + }, + "com.amazonaws.sagemaker#WorkerAccessConfiguration": { + "type": "structure", + "members": { + "S3Presign": { + "target": "com.amazonaws.sagemaker#S3Presign", + "traits": { + "smithy.api#documentation": "

Defines any Amazon S3 resource constraints.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Use this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys. The Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL.

" + } + }, + "com.amazonaws.sagemaker#Workforce": { + "type": "structure", + "members": { + "WorkforceName": { + "target": "com.amazonaws.sagemaker#WorkforceName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the private workforce.

", + "smithy.api#required": {} + } + }, + "WorkforceArn": { + "target": "com.amazonaws.sagemaker#WorkforceArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the private workforce.

", + "smithy.api#required": {} + } + }, + "LastUpdatedDate": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The most recent date that UpdateWorkforce was used to\n successfully add one or more IP address ranges (CIDRs) to a private workforce's\n allow list.

" + } + }, + "SourceIpConfig": { + "target": "com.amazonaws.sagemaker#SourceIpConfig", + "traits": { + "smithy.api#documentation": "

A list of one to ten IP address ranges (CIDRs) to be added to the\n workforce allow list. By default, a workforce isn't restricted to specific IP addresses.

" + } + }, + "SubDomain": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The subdomain for your OIDC Identity Provider.

" + } + }, + "CognitoConfig": { + "target": "com.amazonaws.sagemaker#CognitoConfig", + "traits": { + "smithy.api#documentation": "

The configuration of an Amazon Cognito workforce. \n A single Cognito workforce is created using and corresponds to a single\n \n Amazon Cognito user pool.

" + } + }, + "OidcConfig": { + "target": "com.amazonaws.sagemaker#OidcConfigForResponse", + "traits": { + "smithy.api#documentation": "

The configuration of an OIDC Identity Provider (IdP) private workforce.

" + } + }, + "CreateDate": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The date that the workforce is created.

" + } + }, + "WorkforceVpcConfig": { + "target": "com.amazonaws.sagemaker#WorkforceVpcConfigResponse", + "traits": { + "smithy.api#documentation": "

The configuration of a VPC workforce.

" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#WorkforceStatus", + "traits": { + "smithy.api#documentation": "

The status of your workforce.

" + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#WorkforceFailureReason", + "traits": { + "smithy.api#documentation": "

The reason your workforce failed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A single private workforce, which is automatically created when you create your first\n private work team. You can create one private work force in each Amazon Web Services Region. By default,\n any workforce-related API operation used in a specific region will apply to the\n workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.

" + } + }, + "com.amazonaws.sagemaker#WorkforceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:workforce/" + } + }, + "com.amazonaws.sagemaker#WorkforceFailureReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.sagemaker#WorkforceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]([a-zA-Z0-9\\-]){0,62}$" + } + }, + "com.amazonaws.sagemaker#WorkforceSecurityGroupId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + }, + "smithy.api#pattern": "^sg-[0-9a-z]*$" + } + }, + "com.amazonaws.sagemaker#WorkforceSecurityGroupIds": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#WorkforceSecurityGroupId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#WorkforceStatus": { + "type": "enum", + "members": { + "INITIALIZING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Initializing" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active" + } + } + } + }, + "com.amazonaws.sagemaker#WorkforceSubnetId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + }, + "smithy.api#pattern": "^subnet-[0-9a-z]*$" + } + }, + "com.amazonaws.sagemaker#WorkforceSubnets": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#WorkforceSubnetId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16 + } + } + }, + "com.amazonaws.sagemaker#WorkforceVpcConfigRequest": { + "type": "structure", + "members": { + "VpcId": { + "target": "com.amazonaws.sagemaker#WorkforceVpcId", + "traits": { + "smithy.api#documentation": "

The ID of the VPC that the workforce uses for communication.

" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.sagemaker#WorkforceSecurityGroupIds", + "traits": { + "smithy.api#documentation": "

The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.

" + } + }, + "Subnets": { + "target": "com.amazonaws.sagemaker#WorkforceSubnets", + "traits": { + "smithy.api#documentation": "

The ID of the subnets in the VPC that you want to connect.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The VPC object you use to create or update a workforce.

" + } + }, + "com.amazonaws.sagemaker#WorkforceVpcConfigResponse": { + "type": "structure", + "members": { + "VpcId": { + "target": "com.amazonaws.sagemaker#WorkforceVpcId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC that the workforce uses for communication.

", + "smithy.api#required": {} + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.sagemaker#WorkforceSecurityGroupIds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.

", + "smithy.api#required": {} + } + }, + "Subnets": { + "target": "com.amazonaws.sagemaker#WorkforceSubnets", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the subnets in the VPC that you want to connect.

", + "smithy.api#required": {} + } + }, + "VpcEndpointId": { + "target": "com.amazonaws.sagemaker#WorkforceVpcEndpointId", + "traits": { + "smithy.api#documentation": "

The IDs for the VPC service endpoints of your VPC workforce when it is created and updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A VpcConfig object that specifies the VPC that you want your workforce to connect to.

" + } + }, + "com.amazonaws.sagemaker#WorkforceVpcEndpointId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^vpce-[0-9a-z]*$" + } + }, + "com.amazonaws.sagemaker#WorkforceVpcId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + }, + "smithy.api#pattern": "^vpc-[0-9a-z]*$" + } + }, + "com.amazonaws.sagemaker#Workforces": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#Workforce" + } + }, + "com.amazonaws.sagemaker#WorkspaceSettings": { + "type": "structure", + "members": { + "S3ArtifactPath": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "

The Amazon S3 bucket used to store artifacts generated by Canvas. Updating the Amazon S3 location impacts\n existing configuration settings, and Canvas users no longer have access to their artifacts. Canvas users\n must log out and log back in to apply the new location.

" + } + }, + "S3KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Key Management Service (KMS) encryption key ID that is used to encrypt artifacts generated by Canvas in the Amazon S3 bucket.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The workspace settings for the SageMaker Canvas application.

" + } + }, + "com.amazonaws.sagemaker#Workteam": { + "type": "structure", + "members": { + "WorkteamName": { + "target": "com.amazonaws.sagemaker#WorkteamName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the work team.

", + "smithy.api#required": {} + } + }, + "MemberDefinitions": { + "target": "com.amazonaws.sagemaker#MemberDefinitions", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A list of MemberDefinition objects that contains objects that identify\n the workers that make up the work team.

\n

Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). \n For private workforces created using Amazon Cognito use\n CognitoMemberDefinition. For workforces created using your own OIDC identity\n provider (IdP) use OidcMemberDefinition.

", + "smithy.api#required": {} + } + }, + "WorkteamArn": { + "target": "com.amazonaws.sagemaker#WorkteamArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the work team.

", + "smithy.api#required": {} + } + }, + "WorkforceArn": { + "target": "com.amazonaws.sagemaker#WorkforceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the workforce.

" + } + }, + "ProductListingIds": { + "target": "com.amazonaws.sagemaker#ProductListings", + "traits": { + "smithy.api#documentation": "

The Amazon Marketplace identifier for a vendor's work team.

" + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#String200", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A description of the work team.

", + "smithy.api#required": {} + } + }, + "SubDomain": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The URI of the labeling job's user interface. Workers open this URI to start labeling\n your data objects.

" + } + }, + "CreateDate": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the work team was created (timestamp).

" + } + }, + "LastUpdatedDate": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the work team was last updated (timestamp).

" + } + }, + "NotificationConfiguration": { + "target": "com.amazonaws.sagemaker#NotificationConfiguration", + "traits": { + "smithy.api#documentation": "

Configures SNS notifications of available or expiring work items for work\n teams.

" + } + }, + "WorkerAccessConfiguration": { + "target": "com.amazonaws.sagemaker#WorkerAccessConfiguration", + "traits": { + "smithy.api#documentation": "

Describes any access constraints that have been defined for Amazon S3 resources.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details about a labeling work team.

" + } + }, + "com.amazonaws.sagemaker#WorkteamArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:workteam/" + } + }, + "com.amazonaws.sagemaker#WorkteamName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#Workteams": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#Workteam" + } + } + } +} \ No newline at end of file diff --git a/pkg/testdata/codegen/sdk-codegen/aws-models/sns.json b/pkg/testdata/codegen/sdk-codegen/aws-models/sns.json new file mode 100644 index 00000000..22b3db1c --- /dev/null +++ b/pkg/testdata/codegen/sdk-codegen/aws-models/sns.json @@ -0,0 +1,5289 @@ +{ + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.sns#ActionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.sns#action" + } + }, + "com.amazonaws.sns#AddPermission": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#AddPermissionInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds a statement to a topic's access control policy, granting access for the specified\n Amazon Web Services accounts to the specified actions.

\n \n

To remove the ability to change topic permissions, you must deny permissions to\n the AddPermission, RemovePermission, and\n SetTopicAttributes actions in your IAM policy.

\n " + } + }, + "com.amazonaws.sns#AddPermissionInput": { + "type": "structure", + "members": { + "TopicArn": { + "target": "com.amazonaws.sns#topicARN", + "traits": { + "smithy.api#documentation": "

The ARN of the topic whose access control policy you wish to modify.

", + "smithy.api#required": {} + } + }, + "Label": { + "target": "com.amazonaws.sns#label", + "traits": { + "smithy.api#documentation": "

A unique identifier for the new policy statement.

", + "smithy.api#required": {} + } + }, + "AWSAccountId": { + "target": "com.amazonaws.sns#DelegatesList", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account IDs of the users (principals) who will be given access to the\n specified actions. The users must have Amazon Web Services account, but do not need to be signed up\n for this service.

", + "smithy.api#required": {} + } + }, + "ActionName": { + "target": "com.amazonaws.sns#ActionsList", + "traits": { + "smithy.api#documentation": "

The action you want to allow for the specified principal(s).

\n

Valid values: Any Amazon SNS action name, for example Publish.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#AmazonResourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1011 + } + } + }, + "com.amazonaws.sns#AmazonSimpleNotificationService": { + "type": "service", + "version": "2010-03-31", + "operations": [ + { + "target": "com.amazonaws.sns#AddPermission" + }, + { + "target": "com.amazonaws.sns#CheckIfPhoneNumberIsOptedOut" + }, + { + "target": "com.amazonaws.sns#ConfirmSubscription" + }, + { + "target": "com.amazonaws.sns#CreatePlatformApplication" + }, + { + "target": "com.amazonaws.sns#CreatePlatformEndpoint" + }, + { + "target": "com.amazonaws.sns#CreateSMSSandboxPhoneNumber" + }, + { + "target": "com.amazonaws.sns#CreateTopic" + }, + { + "target": "com.amazonaws.sns#DeleteEndpoint" + }, + { + "target": "com.amazonaws.sns#DeletePlatformApplication" + }, + { + "target": "com.amazonaws.sns#DeleteSMSSandboxPhoneNumber" + }, + { + "target": "com.amazonaws.sns#DeleteTopic" + }, + { + "target": "com.amazonaws.sns#GetDataProtectionPolicy" + }, + { + "target": "com.amazonaws.sns#GetEndpointAttributes" + }, + { + "target": "com.amazonaws.sns#GetPlatformApplicationAttributes" + }, + { + "target": "com.amazonaws.sns#GetSMSAttributes" + }, + { + "target": "com.amazonaws.sns#GetSMSSandboxAccountStatus" + }, + { + "target": "com.amazonaws.sns#GetSubscriptionAttributes" + }, + { + "target": "com.amazonaws.sns#GetTopicAttributes" + }, + { + "target": "com.amazonaws.sns#ListEndpointsByPlatformApplication" + }, + { + "target": "com.amazonaws.sns#ListOriginationNumbers" + }, + { + "target": "com.amazonaws.sns#ListPhoneNumbersOptedOut" + }, + { + "target": "com.amazonaws.sns#ListPlatformApplications" + }, + { + "target": "com.amazonaws.sns#ListSMSSandboxPhoneNumbers" + }, + { + "target": "com.amazonaws.sns#ListSubscriptions" + }, + { + "target": "com.amazonaws.sns#ListSubscriptionsByTopic" + }, + { + "target": "com.amazonaws.sns#ListTagsForResource" + }, + { + "target": "com.amazonaws.sns#ListTopics" + }, + { + "target": "com.amazonaws.sns#OptInPhoneNumber" + }, + { + "target": "com.amazonaws.sns#Publish" + }, + { + "target": "com.amazonaws.sns#PublishBatch" + }, + { + "target": "com.amazonaws.sns#PutDataProtectionPolicy" + }, + { + "target": "com.amazonaws.sns#RemovePermission" + }, + { + "target": "com.amazonaws.sns#SetEndpointAttributes" + }, + { + "target": "com.amazonaws.sns#SetPlatformApplicationAttributes" + }, + { + "target": "com.amazonaws.sns#SetSMSAttributes" + }, + { + "target": "com.amazonaws.sns#SetSubscriptionAttributes" + }, + { + "target": "com.amazonaws.sns#SetTopicAttributes" + }, + { + "target": "com.amazonaws.sns#Subscribe" + }, + { + "target": "com.amazonaws.sns#TagResource" + }, + { + "target": "com.amazonaws.sns#Unsubscribe" + }, + { + "target": "com.amazonaws.sns#UntagResource" + }, + { + "target": "com.amazonaws.sns#VerifySMSSandboxPhoneNumber" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "SNS", + "arnNamespace": "sns", + "cloudFormationName": "SNS", + "cloudTrailEventSource": "sns.amazonaws.com", + "endpointPrefix": "sns" + }, + "aws.auth#sigv4": { + "name": "sns" + }, + "aws.protocols#awsQuery": {}, + "smithy.api#documentation": "Amazon Simple Notification Service\n

Amazon Simple Notification Service (Amazon SNS) is a web service that enables you\n to build distributed web-enabled applications. Applications can use Amazon SNS to easily push\n real-time notification messages to interested subscribers over multiple delivery\n protocols. For more information about this product see the Amazon SNS product page. For detailed information about Amazon SNS features\n and their associated API calls, see the Amazon SNS Developer Guide.

\n

For information on the permissions you need to use this API, see Identity and access management in Amazon SNS in the Amazon SNS Developer\n Guide.\n

\n

We also provide SDKs that enable you to access Amazon SNS from your preferred programming\n language. The SDKs contain functionality that automatically takes care of tasks such as:\n cryptographically signing your service requests, retrying requests, and handling error\n responses. For a list of available SDKs, go to Tools for Amazon Web Services.

", + "smithy.api#title": "Amazon Simple Notification Service", + "smithy.api#xmlNamespace": { + "uri": "http://sns.amazonaws.com/doc/2010-03-31/" + }, + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://sns-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-gov-east-1" + ] + } + ], + "endpoint": { + "url": "https://sns.us-gov-east-1.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-gov-west-1" + ] + } + ], + "endpoint": { + "url": "https://sns.us-gov-west-1.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://sns-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://sns.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://sns.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sns.af-south-1.amazonaws.com" + } + }, + "params": { + "Region": "af-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sns.ap-east-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sns.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sns.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sns.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sns.ap-south-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sns.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sns.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sns.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sns.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sns.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sns.eu-north-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sns.eu-south-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sns.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sns.eu-west-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sns.eu-west-3.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sns.me-south-1.amazonaws.com" + } + }, + "params": { + "Region": "me-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sns.sa-east-1.amazonaws.com" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sns.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sns-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sns.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sns-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sns.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sns-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sns.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sns-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://sns-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://sns.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sns.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sns.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://sns-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sns-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://sns.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sns.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sns.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sns.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sns.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://sns-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://sns.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sns.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sns.us-iso-west-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sns-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sns.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sns-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.sns#AuthorizationErrorException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AuthorizationError", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "

Indicates that the user has been denied access to the requested resource.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.sns#BatchEntryIdsNotDistinctException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "BatchEntryIdsNotDistinct", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Two or more batch entries in the request have the same Id.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sns#BatchRequestTooLongException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "BatchRequestTooLong", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The length of all the batch messages put together is more than the limit.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sns#BatchResultErrorEntry": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

The Id of an entry in a batch request

", + "smithy.api#required": {} + } + }, + "Code": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

An error code representing why the action failed on this entry.

", + "smithy.api#required": {} + } + }, + "Message": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

A message explaining why the action failed on this entry.

" + } + }, + "SenderFault": { + "target": "com.amazonaws.sns#boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether the error happened due to the caller of the batch API action.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Gives a detailed description of failed messages in the batch.

" + } + }, + "com.amazonaws.sns#BatchResultErrorEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sns#BatchResultErrorEntry" + } + }, + "com.amazonaws.sns#Binary": { + "type": "blob" + }, + "com.amazonaws.sns#CheckIfPhoneNumberIsOptedOut": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#CheckIfPhoneNumberIsOptedOutInput" + }, + "output": { + "target": "com.amazonaws.sns#CheckIfPhoneNumberIsOptedOutResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#ThrottledException" + } + ], + "traits": { + "smithy.api#documentation": "

Accepts a phone number and indicates whether the phone holder has opted out of\n receiving SMS messages from your Amazon Web Services account. You cannot send SMS messages to a number\n that is opted out.

\n

To resume sending messages, you can opt in the number by using the\n OptInPhoneNumber action.

" + } + }, + "com.amazonaws.sns#CheckIfPhoneNumberIsOptedOutInput": { + "type": "structure", + "members": { + "phoneNumber": { + "target": "com.amazonaws.sns#PhoneNumber", + "traits": { + "smithy.api#documentation": "

The phone number for which you want to check the opt out status.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The input for the CheckIfPhoneNumberIsOptedOut action.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#CheckIfPhoneNumberIsOptedOutResponse": { + "type": "structure", + "members": { + "isOptedOut": { + "target": "com.amazonaws.sns#boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the phone number is opted out:

\n
    \n
  • \n

    \n true – The phone number is opted out, meaning you cannot publish\n SMS messages to it.

    \n
    • \n
  • \n

    \n false – The phone number is opted in, meaning you can publish SMS\n messages to it.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

The response from the CheckIfPhoneNumberIsOptedOut action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#ConcurrentAccessException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ConcurrentAccess", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Can't perform multiple operations on a tag simultaneously. Perform the operations\n sequentially.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sns#ConfirmSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#ConfirmSubscriptionInput" + }, + "output": { + "target": "com.amazonaws.sns#ConfirmSubscriptionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#FilterPolicyLimitExceededException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#NotFoundException" + }, + { + "target": "com.amazonaws.sns#ReplayLimitExceededException" + }, + { + "target": "com.amazonaws.sns#SubscriptionLimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Verifies an endpoint owner's intent to receive messages by validating the token sent\n to the endpoint by an earlier Subscribe action. If the token is valid, the\n action creates a new subscription and returns its Amazon Resource Name (ARN). This call\n requires an AWS signature only when the AuthenticateOnUnsubscribe flag is\n set to \"true\".

" + } + }, + "com.amazonaws.sns#ConfirmSubscriptionInput": { + "type": "structure", + "members": { + "TopicArn": { + "target": "com.amazonaws.sns#topicARN", + "traits": { + "smithy.api#documentation": "

The ARN of the topic for which you wish to confirm a subscription.

", + "smithy.api#required": {} + } + }, + "Token": { + "target": "com.amazonaws.sns#token", + "traits": { + "smithy.api#documentation": "

Short-lived token sent to an endpoint during the Subscribe action.

", + "smithy.api#required": {} + } + }, + "AuthenticateOnUnsubscribe": { + "target": "com.amazonaws.sns#authenticateOnUnsubscribe", + "traits": { + "smithy.api#documentation": "

Disallows unauthenticated unsubscribes of the subscription. If the value of this\n parameter is true and the request has an Amazon Web Services signature, then only the\n topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe\n action requires Amazon Web Services authentication.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Input for ConfirmSubscription action.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#ConfirmSubscriptionResponse": { + "type": "structure", + "members": { + "SubscriptionArn": { + "target": "com.amazonaws.sns#subscriptionARN", + "traits": { + "smithy.api#documentation": "

The ARN of the created subscription.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Response for ConfirmSubscriptions action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#CreateEndpointResponse": { + "type": "structure", + "members": { + "EndpointArn": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

EndpointArn returned from CreateEndpoint action.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Response from CreateEndpoint action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#CreatePlatformApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#CreatePlatformApplicationInput" + }, + "output": { + "target": "com.amazonaws.sns#CreatePlatformApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a platform application object for one of the supported push notification\n services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile\n apps may register. You must specify PlatformPrincipal and\n PlatformCredential attributes when using the\n CreatePlatformApplication action.

\n

\n PlatformPrincipal and PlatformCredential are received from\n the notification service.

\n
    \n
  • \n

    For ADM, PlatformPrincipal is client id and\n PlatformCredential is client secret.

    \n
    • \n
  • \n

    For APNS and APNS_SANDBOX using certificate credentials,\n PlatformPrincipal is SSL certificate and\n PlatformCredential is private key.

    \n
    • \n
  • \n

    For APNS and APNS_SANDBOX using token credentials,\n PlatformPrincipal is signing key ID and\n PlatformCredential is signing key.

    \n
    • \n
  • \n

    For Baidu, PlatformPrincipal is API key and\n PlatformCredential is secret key.

    \n
    • \n
  • \n

    For GCM (Firebase Cloud Messaging) using key credentials, there is no\n PlatformPrincipal. The PlatformCredential is\n API key.

    \n
    • \n
  • \n

    For GCM (Firebase Cloud Messaging) using token credentials, there is no\n PlatformPrincipal. The PlatformCredential is a\n JSON formatted private key file. When using the Amazon Web Services CLI, the file must be in\n string format and special characters must be ignored. To format the file\n correctly, Amazon SNS recommends using the following command: SERVICE_JSON=`jq\n @json <<< cat service.json`.

    \n
    • \n
  • \n

    For MPNS, PlatformPrincipal is TLS certificate and\n PlatformCredential is private key.

    \n
    • \n
  • \n

    For WNS, PlatformPrincipal is Package Security\n Identifier and PlatformCredential is secret\n key.

    \n
    • \n
\n

You can use the returned PlatformApplicationArn as an attribute for the\n CreatePlatformEndpoint action.

" + } + }, + "com.amazonaws.sns#CreatePlatformApplicationInput": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

Application names must be made up of only uppercase and lowercase ASCII letters,\n numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters\n long.

", + "smithy.api#required": {} + } + }, + "Platform": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push\n Notification Service), APNS_SANDBOX, and GCM (Firebase Cloud Messaging).

", + "smithy.api#required": {} + } + }, + "Attributes": { + "target": "com.amazonaws.sns#MapStringToString", + "traits": { + "smithy.api#documentation": "

For a list of attributes, see \n SetPlatformApplicationAttributes\n .

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Input for CreatePlatformApplication action.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#CreatePlatformApplicationResponse": { + "type": "structure", + "members": { + "PlatformApplicationArn": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

\n PlatformApplicationArn is returned.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Response from CreatePlatformApplication action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#CreatePlatformEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#CreatePlatformEndpointInput" + }, + "output": { + "target": "com.amazonaws.sns#CreateEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an endpoint for a device and mobile app on one of the supported push\n notification services, such as GCM (Firebase Cloud Messaging) and APNS.\n CreatePlatformEndpoint requires the PlatformApplicationArn\n that is returned from CreatePlatformApplication. You can use the returned\n EndpointArn to send a message to a mobile app or by the\n Subscribe action for subscription to a topic. The\n CreatePlatformEndpoint action is idempotent, so if the requester\n already owns an endpoint with the same device token and attributes, that endpoint's ARN\n is returned without creating a new endpoint. For more information, see Using Amazon SNS Mobile Push\n Notifications.

\n

When using CreatePlatformEndpoint with Baidu, two attributes must be\n provided: ChannelId and UserId. The token field must also contain the ChannelId. For\n more information, see Creating an Amazon SNS Endpoint for\n Baidu.

" + } + }, + "com.amazonaws.sns#CreatePlatformEndpointInput": { + "type": "structure", + "members": { + "PlatformApplicationArn": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

\n PlatformApplicationArn returned from CreatePlatformApplication is used to\n create a an endpoint.

", + "smithy.api#required": {} + } + }, + "Token": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

Unique identifier created by the notification service for an app on a device. The\n specific name for Token will vary, depending on which notification service is being\n used. For example, when using APNS as the notification service, you need the device\n token. Alternatively, when using GCM (Firebase Cloud Messaging) or ADM, the device token\n equivalent is called the registration ID.

", + "smithy.api#required": {} + } + }, + "CustomUserData": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

Arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The\n data must be in UTF-8 format and less than 2KB.

" + } + }, + "Attributes": { + "target": "com.amazonaws.sns#MapStringToString", + "traits": { + "smithy.api#documentation": "

For a list of attributes, see \n SetEndpointAttributes\n .

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Input for CreatePlatformEndpoint action.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#CreateSMSSandboxPhoneNumber": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#CreateSMSSandboxPhoneNumberInput" + }, + "output": { + "target": "com.amazonaws.sns#CreateSMSSandboxPhoneNumberResult" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#OptedOutException" + }, + { + "target": "com.amazonaws.sns#ThrottledException" + }, + { + "target": "com.amazonaws.sns#UserErrorException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds a destination phone number to an Amazon Web Services account in the SMS sandbox and sends a\n one-time password (OTP) to that phone number.

\n

When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the\n SMS sandbox. The SMS sandbox provides a safe environment for \n you to try Amazon SNS features without risking your reputation as an SMS sender. While your \n Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send \n SMS messages only to verified destination phone numbers. For more information, including how to \n move out of the sandbox to send messages without restrictions, \n see SMS sandbox in \n the Amazon SNS Developer Guide.

" + } + }, + "com.amazonaws.sns#CreateSMSSandboxPhoneNumberInput": { + "type": "structure", + "members": { + "PhoneNumber": { + "target": "com.amazonaws.sns#PhoneNumberString", + "traits": { + "smithy.api#documentation": "

The destination phone number to verify. On verification, Amazon SNS adds this phone number\n to the list of verified phone numbers that you can send SMS messages to.

", + "smithy.api#required": {} + } + }, + "LanguageCode": { + "target": "com.amazonaws.sns#LanguageCodeString", + "traits": { + "smithy.api#documentation": "

The language to use for sending the OTP. The default value is\n en-US.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#CreateSMSSandboxPhoneNumberResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#CreateTopic": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#CreateTopicInput" + }, + "output": { + "target": "com.amazonaws.sns#CreateTopicResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#ConcurrentAccessException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#InvalidSecurityException" + }, + { + "target": "com.amazonaws.sns#StaleTagException" + }, + { + "target": "com.amazonaws.sns#TagLimitExceededException" + }, + { + "target": "com.amazonaws.sns#TagPolicyException" + }, + { + "target": "com.amazonaws.sns#TopicLimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a topic to which notifications can be published. Users can create at most\n 100,000 standard topics (at most 1,000 FIFO topics). For more information, see Creating an Amazon SNS\n topic in the Amazon SNS Developer Guide. This action is\n idempotent, so if the requester already owns a topic with the specified name, that\n topic's ARN is returned without creating a new topic.

" + } + }, + "com.amazonaws.sns#CreateTopicInput": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sns#topicName", + "traits": { + "smithy.api#documentation": "

The name of the topic you want to create.

\n

Constraints: Topic names must be made up of only uppercase and lowercase ASCII\n letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters\n long.

\n

For a FIFO (first-in-first-out) topic, the name must end with the .fifo\n suffix.

", + "smithy.api#required": {} + } + }, + "Attributes": { + "target": "com.amazonaws.sns#TopicAttributesMap", + "traits": { + "smithy.api#documentation": "

A map of attributes with their corresponding values.

\n

The following lists names, descriptions, and values of the special request parameters\n that the CreateTopic action uses:

\n
    \n
  • \n

    \n DeliveryPolicy – The policy that defines how Amazon SNS retries\n failed deliveries to HTTP/S endpoints.

    \n
    • \n
  • \n

    \n DisplayName – The display name to use for a topic with SMS\n subscriptions.

    \n
    • \n
  • \n

    \n FifoTopic – Set to true to create a FIFO topic.

    \n
    • \n
  • \n

    \n Policy – The policy that defines who can access your\n topic. By default, only the topic owner can publish or subscribe to the\n topic.

    \n
    • \n
  • \n

    \n SignatureVersion – The signature version corresponds to\n the hashing algorithm used while creating the signature of the notifications,\n subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS.\n By default, SignatureVersion is set to 1.

    \n
    • \n
  • \n

    \n TracingConfig – Tracing mode of an Amazon SNS topic. By default\n TracingConfig is set to PassThrough, and the topic\n passes through the tracing header it receives from an Amazon SNS publisher to its\n subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data\n to topic owner account if the sampled flag in the tracing header is true. This\n is only supported on standard topics.

    \n
    • \n
\n

The following attribute applies only to server-side\n encryption:

\n
    \n
  • \n

    \n KmsMasterKeyId – The ID of an Amazon Web Services managed customer master\n key (CMK) for Amazon SNS or a custom CMK. For more information, see Key\n Terms. For more examples, see KeyId in the Key Management Service API Reference.

    \n
    • \n
\n

The following attributes apply only to FIFO topics:

\n
    \n
  • \n

    \n ArchivePolicy – The policy that sets the retention period\n for messages stored in the message archive of an Amazon SNS FIFO\n topic.

    \n
    • \n
  • \n

    \n ContentBasedDeduplication – Enables content-based\n deduplication for FIFO topics.

    \n
      \n
    • \n

      By default, ContentBasedDeduplication is set to\n false. If you create a FIFO topic and this attribute is\n false, you must specify a value for the\n MessageDeduplicationId parameter for the Publish\n action.

      \n
      • \n
    • \n

      When you set ContentBasedDeduplication to true,\n Amazon SNS uses a SHA-256 hash to generate the\n MessageDeduplicationId using the body of the message (but not\n the attributes of the message).

      \n

      (Optional) To override the generated value, you can specify a value for the\n MessageDeduplicationId parameter for the Publish\n action.

      \n
      • \n
    \n
    • \n
" + } + }, + "Tags": { + "target": "com.amazonaws.sns#TagList", + "traits": { + "smithy.api#documentation": "

The list of tags to add to a new topic.

\n \n

To be able to tag a topic on creation, you must have the\n sns:CreateTopic and sns:TagResource\n permissions.

\n " + } + }, + "DataProtectionPolicy": { + "target": "com.amazonaws.sns#attributeValue", + "traits": { + "smithy.api#documentation": "

The body of the policy document you want to use for this topic.

\n

You can only add one policy per topic.

\n

The policy must be in JSON string format.

\n

Length Constraints: Maximum length of 30,720.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Input for CreateTopic action.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#CreateTopicResponse": { + "type": "structure", + "members": { + "TopicArn": { + "target": "com.amazonaws.sns#topicARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) assigned to the created topic.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Response from CreateTopic action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#DelegatesList": { + "type": "list", + "member": { + "target": "com.amazonaws.sns#delegate" + } + }, + "com.amazonaws.sns#DeleteEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#DeleteEndpointInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the endpoint for a device and mobile app from Amazon SNS. This action is\n idempotent. For more information, see Using Amazon SNS Mobile Push\n Notifications.

\n

When you delete an endpoint that is also subscribed to a topic, then you must also\n unsubscribe the endpoint from the topic.

" + } + }, + "com.amazonaws.sns#DeleteEndpointInput": { + "type": "structure", + "members": { + "EndpointArn": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

\n EndpointArn of endpoint to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Input for DeleteEndpoint action.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#DeletePlatformApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#DeletePlatformApplicationInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a platform application object for one of the supported push notification\n services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see\n Using Amazon SNS\n Mobile Push Notifications.

" + } + }, + "com.amazonaws.sns#DeletePlatformApplicationInput": { + "type": "structure", + "members": { + "PlatformApplicationArn": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

\n PlatformApplicationArn of platform application object to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Input for DeletePlatformApplication action.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#DeleteSMSSandboxPhoneNumber": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#DeleteSMSSandboxPhoneNumberInput" + }, + "output": { + "target": "com.amazonaws.sns#DeleteSMSSandboxPhoneNumberResult" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.sns#ThrottledException" + }, + { + "target": "com.amazonaws.sns#UserErrorException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an Amazon Web Services account's verified or pending phone number from the SMS\n sandbox.

\n

When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the\n SMS sandbox. The SMS sandbox provides a safe environment for \n you to try Amazon SNS features without risking your reputation as an SMS sender. While your \n Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send \n SMS messages only to verified destination phone numbers. For more information, including how to \n move out of the sandbox to send messages without restrictions, \n see SMS sandbox in \n the Amazon SNS Developer Guide.

" + } + }, + "com.amazonaws.sns#DeleteSMSSandboxPhoneNumberInput": { + "type": "structure", + "members": { + "PhoneNumber": { + "target": "com.amazonaws.sns#PhoneNumberString", + "traits": { + "smithy.api#documentation": "

The destination phone number to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#DeleteSMSSandboxPhoneNumberResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#DeleteTopic": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#DeleteTopicInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#ConcurrentAccessException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#InvalidStateException" + }, + { + "target": "com.amazonaws.sns#NotFoundException" + }, + { + "target": "com.amazonaws.sns#StaleTagException" + }, + { + "target": "com.amazonaws.sns#TagPolicyException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a topic and all its subscriptions. Deleting a topic might prevent some\n messages previously sent to the topic from being delivered to subscribers. This action\n is idempotent, so deleting a topic that does not exist does not result in an\n error.

" + } + }, + "com.amazonaws.sns#DeleteTopicInput": { + "type": "structure", + "members": { + "TopicArn": { + "target": "com.amazonaws.sns#topicARN", + "traits": { + "smithy.api#documentation": "

The ARN of the topic you want to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#EmptyBatchRequestException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "EmptyBatchRequest", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The batch request doesn't contain any entries.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sns#Endpoint": { + "type": "structure", + "members": { + "EndpointArn": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

The EndpointArn for mobile app and device.

" + } + }, + "Attributes": { + "target": "com.amazonaws.sns#MapStringToString", + "traits": { + "smithy.api#documentation": "

Attributes for endpoint.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The endpoint for mobile app and device.

" + } + }, + "com.amazonaws.sns#Endpoint2": { + "type": "string" + }, + "com.amazonaws.sns#EndpointDisabledException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

Message for endpoint disabled.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "EndpointDisabled", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Exception error indicating endpoint disabled.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sns#FilterPolicyLimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "FilterPolicyLimitExceeded", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "

Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To\n add more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support\n Center.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.sns#GetDataProtectionPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#GetDataProtectionPolicyInput" + }, + "output": { + "target": "com.amazonaws.sns#GetDataProtectionPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#InvalidSecurityException" + }, + { + "target": "com.amazonaws.sns#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the specified inline DataProtectionPolicy document that is\n stored in the specified Amazon SNS topic.

" + } + }, + "com.amazonaws.sns#GetDataProtectionPolicyInput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.sns#topicARN", + "traits": { + "smithy.api#documentation": "

The ARN of the topic whose DataProtectionPolicy you want to get.

\n

For more information about ARNs, see Amazon Resource Names\n (ARNs) in the Amazon Web Services General Reference.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#GetDataProtectionPolicyResponse": { + "type": "structure", + "members": { + "DataProtectionPolicy": { + "target": "com.amazonaws.sns#attributeValue", + "traits": { + "smithy.api#documentation": "

Retrieves the DataProtectionPolicy in JSON string format.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#GetEndpointAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#GetEndpointAttributesInput" + }, + "output": { + "target": "com.amazonaws.sns#GetEndpointAttributesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the endpoint attributes for a device on one of the supported push\n notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more\n information, see Using Amazon SNS Mobile Push Notifications.

" + } + }, + "com.amazonaws.sns#GetEndpointAttributesInput": { + "type": "structure", + "members": { + "EndpointArn": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

\n EndpointArn for GetEndpointAttributes input.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Input for GetEndpointAttributes action.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#GetEndpointAttributesResponse": { + "type": "structure", + "members": { + "Attributes": { + "target": "com.amazonaws.sns#MapStringToString", + "traits": { + "smithy.api#documentation": "

Attributes include the following:

\n
    \n
  • \n

    \n CustomUserData – arbitrary user data to associate with the\n endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and\n less than 2KB.

    \n
    • \n
  • \n

    \n Enabled – flag that enables/disables delivery to the\n endpoint. Amazon SNS will set this to false when a notification service indicates to\n Amazon SNS that the endpoint is invalid. Users can set it back to true, typically\n after updating Token.

    \n
    • \n
  • \n

    \n Token – device token, also referred to as a registration id,\n for an app and mobile device. This is returned from the notification service\n when an app and mobile device are registered with the notification\n service.

    \n \n

    The device token for the iOS platform is returned in lowercase.

    \n     \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

Response from GetEndpointAttributes of the\n EndpointArn.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#GetPlatformApplicationAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#GetPlatformApplicationAttributesInput" + }, + "output": { + "target": "com.amazonaws.sns#GetPlatformApplicationAttributesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the attributes of the platform application object for the supported push\n notification services, such as APNS and GCM (Firebase Cloud Messaging). For more\n information, see Using Amazon SNS Mobile Push Notifications.

" + } + }, + "com.amazonaws.sns#GetPlatformApplicationAttributesInput": { + "type": "structure", + "members": { + "PlatformApplicationArn": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

\n PlatformApplicationArn for GetPlatformApplicationAttributesInput.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Input for GetPlatformApplicationAttributes action.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#GetPlatformApplicationAttributesResponse": { + "type": "structure", + "members": { + "Attributes": { + "target": "com.amazonaws.sns#MapStringToString", + "traits": { + "smithy.api#documentation": "

Attributes include the following:

\n
    \n
  • \n

    \n AppleCertificateExpiryDate – The expiry date of the SSL\n certificate used to configure certificate-based authentication.

    \n
    • \n
  • \n

    \n ApplePlatformTeamID – The Apple developer account ID used to\n configure token-based authentication.

    \n
    • \n
  • \n

    \n ApplePlatformBundleID – The app identifier used to configure\n token-based authentication.

    \n
    • \n
  • \n

    \n AuthenticationMethod – Returns the credential type used when\n sending push notifications from application to APNS/APNS_Sandbox, or application\n to GCM.

    \n
      \n
    • \n

      APNS – Returns the token or certificate.

      \n
      • \n
    • \n

      GCM – Returns the token or key.

      \n
      • \n
    \n
    • \n
  • \n

    \n EventEndpointCreated – Topic ARN to which EndpointCreated\n event notifications should be sent.

    \n
    • \n
  • \n

    \n EventEndpointDeleted – Topic ARN to which EndpointDeleted\n event notifications should be sent.

    \n
    • \n
  • \n

    \n EventEndpointUpdated – Topic ARN to which EndpointUpdate\n event notifications should be sent.

    \n
    • \n
  • \n

    \n EventDeliveryFailure – Topic ARN to which DeliveryFailure\n event notifications should be sent upon Direct Publish delivery failure\n (permanent) to one of the application's endpoints.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

Response for GetPlatformApplicationAttributes action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#GetSMSAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#GetSMSAttributesInput" + }, + "output": { + "target": "com.amazonaws.sns#GetSMSAttributesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#ThrottledException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the settings for sending SMS messages from your Amazon Web Services account.

\n

These settings are set with the SetSMSAttributes action.

" + } + }, + "com.amazonaws.sns#GetSMSAttributesInput": { + "type": "structure", + "members": { + "attributes": { + "target": "com.amazonaws.sns#ListString", + "traits": { + "smithy.api#documentation": "

A list of the individual attribute names, such as MonthlySpendLimit, for\n which you want values.

\n

For all attribute names, see SetSMSAttributes.

\n

If you don't use this parameter, Amazon SNS returns all SMS attributes.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The input for the GetSMSAttributes request.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#GetSMSAttributesResponse": { + "type": "structure", + "members": { + "attributes": { + "target": "com.amazonaws.sns#MapStringToString", + "traits": { + "smithy.api#documentation": "

The SMS attribute names and their values.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The response from the GetSMSAttributes request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#GetSMSSandboxAccountStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#GetSMSSandboxAccountStatusInput" + }, + "output": { + "target": "com.amazonaws.sns#GetSMSSandboxAccountStatusResult" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#ThrottledException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the SMS sandbox status for the calling Amazon Web Services account in the target\n Amazon Web Services Region.

\n

When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the\n SMS sandbox. The SMS sandbox provides a safe environment for \n you to try Amazon SNS features without risking your reputation as an SMS sender. While your \n Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send \n SMS messages only to verified destination phone numbers. For more information, including how to \n move out of the sandbox to send messages without restrictions, \n see SMS sandbox in \n the Amazon SNS Developer Guide.

" + } + }, + "com.amazonaws.sns#GetSMSSandboxAccountStatusInput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#GetSMSSandboxAccountStatusResult": { + "type": "structure", + "members": { + "IsInSandbox": { + "target": "com.amazonaws.sns#boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the calling Amazon Web Services account is in the SMS sandbox.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#GetSubscriptionAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#GetSubscriptionAttributesInput" + }, + "output": { + "target": "com.amazonaws.sns#GetSubscriptionAttributesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns all of the properties of a subscription.

" + } + }, + "com.amazonaws.sns#GetSubscriptionAttributesInput": { + "type": "structure", + "members": { + "SubscriptionArn": { + "target": "com.amazonaws.sns#subscriptionARN", + "traits": { + "smithy.api#documentation": "

The ARN of the subscription whose properties you want to get.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Input for GetSubscriptionAttributes.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#GetSubscriptionAttributesResponse": { + "type": "structure", + "members": { + "Attributes": { + "target": "com.amazonaws.sns#SubscriptionAttributesMap", + "traits": { + "smithy.api#documentation": "

A map of the subscription's attributes. Attributes in this map include the\n following:

\n
    \n
  • \n

    \n ConfirmationWasAuthenticated – true if the\n subscription confirmation request was authenticated.

    \n
    • \n
  • \n

    \n DeliveryPolicy – The JSON serialization of the\n subscription's delivery policy.

    \n
    • \n
  • \n

    \n EffectiveDeliveryPolicy – The JSON serialization of the\n effective delivery policy that takes into account the topic delivery policy and\n account system defaults.

    \n
    • \n
  • \n

    \n FilterPolicy – The filter policy JSON that is assigned to\n the subscription. For more information, see Amazon SNS Message\n Filtering in the Amazon SNS Developer Guide.

    \n
    • \n
  • \n

    \n FilterPolicyScope – This attribute lets you choose the\n filtering scope by using one of the following string value types:

    \n
      \n
    • \n

      \n MessageAttributes (default) – The filter is\n applied on the message attributes.

      \n
      • \n
    • \n

      \n MessageBody – The filter is applied on the message\n body.

      \n
      • \n
    \n
    • \n
  • \n

    \n Owner – The Amazon Web Services account ID of the subscription's\n owner.

    \n
    • \n
  • \n

    \n PendingConfirmation – true if the subscription\n hasn't been confirmed. To confirm a pending subscription, call the\n ConfirmSubscription action with a confirmation token.

    \n
    • \n
  • \n

    \n RawMessageDelivery – true if raw message\n delivery is enabled for the subscription. Raw messages are free of JSON\n formatting and can be sent to HTTP/S and Amazon SQS endpoints.

    \n
    • \n
  • \n

    \n RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. \n Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable)\n or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held \n in the dead-letter queue for further analysis or reprocessing.

    \n
    • \n
  • \n

    \n SubscriptionArn – The subscription's ARN.

    \n
    • \n
  • \n

    \n TopicArn – The topic ARN that the subscription is associated\n with.

    \n
    • \n
\n

The following attribute applies only to Amazon Data Firehose delivery stream subscriptions:

\n
    \n
  • \n

    \n SubscriptionRoleArn – The ARN of the IAM role that has the following:

    \n
      \n
    • \n

      Permission to write to the Firehose delivery stream

      \n
      • \n
    • \n

      Amazon SNS listed as a trusted entity

      \n
      • \n
    \n

    Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. \n For more information, see Fanout \n to Firehose delivery streams in the Amazon SNS Developer Guide.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

Response for GetSubscriptionAttributes action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#GetTopicAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#GetTopicAttributesInput" + }, + "output": { + "target": "com.amazonaws.sns#GetTopicAttributesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#InvalidSecurityException" + }, + { + "target": "com.amazonaws.sns#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns all of the properties of a topic. Topic properties returned might differ based\n on the authorization of the user.

" + } + }, + "com.amazonaws.sns#GetTopicAttributesInput": { + "type": "structure", + "members": { + "TopicArn": { + "target": "com.amazonaws.sns#topicARN", + "traits": { + "smithy.api#documentation": "

The ARN of the topic whose properties you want to get.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Input for GetTopicAttributes action.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#GetTopicAttributesResponse": { + "type": "structure", + "members": { + "Attributes": { + "target": "com.amazonaws.sns#TopicAttributesMap", + "traits": { + "smithy.api#documentation": "

A map of the topic's attributes. Attributes in this map include the following:

\n
    \n
  • \n

    \n DeliveryPolicy – The JSON serialization of the topic's\n delivery policy.

    \n
    • \n
  • \n

    \n DisplayName – The human-readable name used in the\n From field for notifications to email and\n email-json endpoints.

    \n
    • \n
  • \n

    \n EffectiveDeliveryPolicy – The JSON serialization of the\n effective delivery policy, taking system defaults into account.

    \n
    • \n
  • \n

    \n Owner – The Amazon Web Services account ID of the topic's owner.

    \n
    • \n
  • \n

    \n Policy – The JSON serialization of the topic's access\n control policy.

    \n
    • \n
  • \n

    \n SignatureVersion – The signature version corresponds to\n the hashing algorithm used while creating the signature of the notifications,\n subscription confirmations, or unsubscribe confirmation messages sent by\n Amazon SNS.

    \n
      \n
    • \n

      By default, SignatureVersion is set to 1. The signature is a Base64-encoded\n SHA1withRSA signature.

      \n
      • \n
    • \n

      When you set SignatureVersion to 2. Amazon SNS uses a Base64-encoded SHA256withRSA signature.

      \n \n

      If the API response does not include the\n SignatureVersion attribute, it means that the\n SignatureVersion for the topic has value 1.

      \n       \n
      • \n
    \n
    • \n
  • \n

    \n SubscriptionsConfirmed – The number of confirmed\n subscriptions for the topic.

    \n
    • \n
  • \n

    \n SubscriptionsDeleted – The number of deleted subscriptions\n for the topic.

    \n
    • \n
  • \n

    \n SubscriptionsPending – The number of subscriptions pending\n confirmation for the topic.

    \n
    • \n
  • \n

    \n TopicArn – The topic's ARN.

    \n
    • \n
  • \n

    \n TracingConfig – Tracing mode of an Amazon SNS topic. By default\n TracingConfig is set to PassThrough, and the topic\n passes through the tracing header it receives from an Amazon SNS publisher to its\n subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data\n to topic owner account if the sampled flag in the tracing header is true. This\n is only supported on standard topics.

    \n
    • \n
\n

The following attribute applies only to server-side-encryption:

\n
    \n
  • \n

    \n KmsMasterKeyId - The ID of an Amazon Web Services managed customer master key\n (CMK) for Amazon SNS or a custom CMK. For more information, see Key\n Terms. For more examples, see KeyId in the Key Management Service API Reference.

    \n
    • \n
\n

The following attributes apply only to FIFO topics:

\n
    \n
  • \n

    \n ArchivePolicy – The policy that sets the retention period\n for messages stored in the message archive of an Amazon SNS FIFO\n topic.

    \n
    • \n
  • \n

    \n BeginningArchiveTime – The earliest starting point at\n which a message in the topic’s archive can be replayed from. This point in time\n is based on the configured message retention period set by the topic’s message\n archiving policy.

    \n
    • \n
  • \n

    \n ContentBasedDeduplication – Enables content-based\n deduplication for FIFO topics.

    \n
      \n
    • \n

      By default, ContentBasedDeduplication is set to\n false. If you create a FIFO topic and this attribute is\n false, you must specify a value for the\n MessageDeduplicationId parameter for the Publish action.

      \n
      • \n
    • \n

      When you set ContentBasedDeduplication to\n true, Amazon SNS uses a SHA-256 hash to\n generate the MessageDeduplicationId using the body of the\n message (but not the attributes of the message).

      \n

      (Optional) To override the generated value, you can specify a value\n for the MessageDeduplicationId parameter for the\n Publish action.

      \n
      • \n
    \n
    • \n
  • \n

    \n FifoTopic – When this is set to true, a FIFO\n topic is created.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

Response for GetTopicAttributes action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#InternalErrorException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InternalError", + "httpResponseCode": 500 + }, + "smithy.api#documentation": "

Indicates an internal service error.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.sns#InvalidBatchEntryIdException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidBatchEntryId", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The Id of a batch entry in a batch request doesn't abide by the specification.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sns#InvalidParameterException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidParameter", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Indicates that a request parameter does not comply with the associated\n constraints.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sns#InvalidParameterValueException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

The parameter of an entry in a request doesn't abide by the specification.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ParameterValueInvalid", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Indicates that a request parameter does not comply with the associated constraints.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sns#InvalidSecurityException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidSecurity", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "

The credential signature isn't valid. You must use an HTTPS endpoint and sign your\n request using Signature Version 4.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.sns#InvalidStateException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidState", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Indicates that the specified state is not a valid state for an event source.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sns#Iso2CountryCode": { + "type": "string", + "traits": { + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. For example, GB or US.", + "smithy.api#length": { + "min": 0, + "max": 2 + }, + "smithy.api#pattern": "^[A-Za-z]{2}$" + } + }, + "com.amazonaws.sns#KMSAccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "KMSAccessDenied", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The ciphertext references a key that doesn't exist or that you don't have access\n to.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sns#KMSDisabledException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "KMSDisabled", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request was rejected because the specified Amazon Web Services KMS key isn't\n enabled.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sns#KMSInvalidStateException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "KMSInvalidState", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request was rejected because the state of the specified resource isn't valid for\n this request. For more information, see Key states of Amazon Web Services KMS keys in the Key Management Service Developer\n Guide.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sns#KMSNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "KMSNotFound", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request was rejected because the specified entity or resource can't be\n found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sns#KMSOptInRequired": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "KMSOptInRequired", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "

The Amazon Web Services access key ID needs a subscription for the service.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.sns#KMSThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "KMSThrottling", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request was denied due to request throttling. For more information about\n throttling, see Limits in\n the Key Management Service Developer Guide.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sns#LanguageCodeString": { + "type": "enum", + "members": { + "en_US": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "en-US" + } + }, + "en_GB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "en-GB" + } + }, + "es_419": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "es-419" + } + }, + "es_ES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "es-ES" + } + }, + "de_DE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "de-DE" + } + }, + "fr_CA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fr-CA" + } + }, + "fr_FR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fr-FR" + } + }, + "it_IT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "it-IT" + } + }, + "jp_JP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ja-JP" + } + }, + "pt_BR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pt-BR" + } + }, + "kr_KR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "kr-KR" + } + }, + "zh_CN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "zh-CN" + } + }, + "zh_TW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "zh-TW" + } + } + }, + "traits": { + "smithy.api#documentation": "Supported language code for sending OTP message" + } + }, + "com.amazonaws.sns#ListEndpointsByPlatformApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#ListEndpointsByPlatformApplicationInput" + }, + "output": { + "target": "com.amazonaws.sns#ListEndpointsByPlatformApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the endpoints and endpoint attributes for devices in a supported push\n notification service, such as GCM (Firebase Cloud Messaging) and APNS. The results for\n ListEndpointsByPlatformApplication are paginated and return a limited\n list of endpoints, up to 100. If additional records are available after the first page\n results, then a NextToken string will be returned. To receive the next page, you call\n ListEndpointsByPlatformApplication again using the NextToken string\n received from the previous call. When there are no more records to return, NextToken\n will be null. For more information, see Using Amazon SNS Mobile Push\n Notifications.

\n

This action is throttled at 30 transactions per second (TPS).

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Endpoints" + } + } + }, + "com.amazonaws.sns#ListEndpointsByPlatformApplicationInput": { + "type": "structure", + "members": { + "PlatformApplicationArn": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

\n PlatformApplicationArn for\n ListEndpointsByPlatformApplicationInput action.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

\n NextToken string is used when calling\n ListEndpointsByPlatformApplication action to retrieve additional\n records that are available after the first page results.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Input for ListEndpointsByPlatformApplication action.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#ListEndpointsByPlatformApplicationResponse": { + "type": "structure", + "members": { + "Endpoints": { + "target": "com.amazonaws.sns#ListOfEndpoints", + "traits": { + "smithy.api#documentation": "

Endpoints returned for ListEndpointsByPlatformApplication action.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

\n NextToken string is returned when calling\n ListEndpointsByPlatformApplication action if additional records are\n available after the first page results.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Response for ListEndpointsByPlatformApplication action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#ListOfEndpoints": { + "type": "list", + "member": { + "target": "com.amazonaws.sns#Endpoint" + } + }, + "com.amazonaws.sns#ListOfPlatformApplications": { + "type": "list", + "member": { + "target": "com.amazonaws.sns#PlatformApplication" + } + }, + "com.amazonaws.sns#ListOriginationNumbers": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#ListOriginationNumbersRequest" + }, + "output": { + "target": "com.amazonaws.sns#ListOriginationNumbersResult" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#ThrottledException" + }, + { + "target": "com.amazonaws.sns#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the calling Amazon Web Services account's dedicated origination numbers and their metadata.\n For more information about origination numbers, see Origination numbers in the Amazon SNS Developer\n Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "PhoneNumbers", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sns#ListOriginationNumbersRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sns#nextToken", + "traits": { + "smithy.api#documentation": "

Token that the previous ListOriginationNumbers request returns.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sns#MaxItemsListOriginationNumbers", + "traits": { + "smithy.api#documentation": "

The maximum number of origination numbers to return.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#ListOriginationNumbersResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sns#nextToken", + "traits": { + "smithy.api#documentation": "

A NextToken string is returned when you call the\n ListOriginationNumbers operation if additional pages of records are\n available.

" + } + }, + "PhoneNumbers": { + "target": "com.amazonaws.sns#PhoneNumberInformationList", + "traits": { + "smithy.api#documentation": "

A list of the calling account's verified and pending origination numbers.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#ListPhoneNumbersOptedOut": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#ListPhoneNumbersOptedOutInput" + }, + "output": { + "target": "com.amazonaws.sns#ListPhoneNumbersOptedOutResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#ThrottledException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of phone numbers that are opted out, meaning you cannot send SMS\n messages to them.

\n

The results for ListPhoneNumbersOptedOut are paginated, and each page\n returns up to 100 phone numbers. If additional phone numbers are available after the\n first page of results, then a NextToken string will be returned. To receive\n the next page, you call ListPhoneNumbersOptedOut again using the\n NextToken string received from the previous call. When there are no\n more records to return, NextToken will be null.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "phoneNumbers" + } + } + }, + "com.amazonaws.sns#ListPhoneNumbersOptedOutInput": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

A NextToken string is used when you call the\n ListPhoneNumbersOptedOut action to retrieve additional records that are\n available after the first page of results.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The input for the ListPhoneNumbersOptedOut action.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#ListPhoneNumbersOptedOutResponse": { + "type": "structure", + "members": { + "phoneNumbers": { + "target": "com.amazonaws.sns#PhoneNumberList", + "traits": { + "smithy.api#documentation": "

A list of phone numbers that are opted out of receiving SMS messages. The list is\n paginated, and each page can contain up to 100 phone numbers.

" + } + }, + "nextToken": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

A NextToken string is returned when you call the\n ListPhoneNumbersOptedOut action if additional records are available\n after the first page of results.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The response from the ListPhoneNumbersOptedOut action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#ListPlatformApplications": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#ListPlatformApplicationsInput" + }, + "output": { + "target": "com.amazonaws.sns#ListPlatformApplicationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the platform application objects for the supported push notification services,\n such as APNS and GCM (Firebase Cloud Messaging). The results for\n ListPlatformApplications are paginated and return a limited list of\n applications, up to 100. If additional records are available after the first page\n results, then a NextToken string will be returned. To receive the next page, you call\n ListPlatformApplications using the NextToken string received from the\n previous call. When there are no more records to return, NextToken will be\n null. For more information, see Using Amazon SNS Mobile Push\n Notifications.

\n

This action is throttled at 15 transactions per second (TPS).

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "PlatformApplications" + } + } + }, + "com.amazonaws.sns#ListPlatformApplicationsInput": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

\n NextToken string is used when calling\n ListPlatformApplications action to retrieve additional records that are\n available after the first page results.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Input for ListPlatformApplications action.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#ListPlatformApplicationsResponse": { + "type": "structure", + "members": { + "PlatformApplications": { + "target": "com.amazonaws.sns#ListOfPlatformApplications", + "traits": { + "smithy.api#documentation": "

Platform applications returned when calling ListPlatformApplications\n action.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

\n NextToken string is returned when calling\n ListPlatformApplications action if additional records are available\n after the first page results.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Response for ListPlatformApplications action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#ListSMSSandboxPhoneNumbers": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#ListSMSSandboxPhoneNumbersInput" + }, + "output": { + "target": "com.amazonaws.sns#ListSMSSandboxPhoneNumbersResult" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.sns#ThrottledException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the calling Amazon Web Services account's current verified and pending destination phone\n numbers in the SMS sandbox.

\n

When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the\n SMS sandbox. The SMS sandbox provides a safe environment for \n you to try Amazon SNS features without risking your reputation as an SMS sender. While your \n Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send \n SMS messages only to verified destination phone numbers. For more information, including how to \n move out of the sandbox to send messages without restrictions, \n see SMS sandbox in \n the Amazon SNS Developer Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "PhoneNumbers", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sns#ListSMSSandboxPhoneNumbersInput": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sns#nextToken", + "traits": { + "smithy.api#documentation": "

Token that the previous ListSMSSandboxPhoneNumbersInput request\n returns.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sns#MaxItems", + "traits": { + "smithy.api#documentation": "

The maximum number of phone numbers to return.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#ListSMSSandboxPhoneNumbersResult": { + "type": "structure", + "members": { + "PhoneNumbers": { + "target": "com.amazonaws.sns#SMSSandboxPhoneNumberList", + "traits": { + "smithy.api#documentation": "

A list of the calling account's pending and verified phone numbers.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

A NextToken string is returned when you call the\n ListSMSSandboxPhoneNumbersInput operation if additional pages of\n records are available.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#ListString": { + "type": "list", + "member": { + "target": "com.amazonaws.sns#String" + } + }, + "com.amazonaws.sns#ListSubscriptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#ListSubscriptionsInput" + }, + "output": { + "target": "com.amazonaws.sns#ListSubscriptionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of the requester's subscriptions. Each call returns a limited list of\n subscriptions, up to 100. If there are more subscriptions, a NextToken is\n also returned. Use the NextToken parameter in a new\n ListSubscriptions call to get further results.

\n

This action is throttled at 30 transactions per second (TPS).

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Subscriptions" + } + } + }, + "com.amazonaws.sns#ListSubscriptionsByTopic": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#ListSubscriptionsByTopicInput" + }, + "output": { + "target": "com.amazonaws.sns#ListSubscriptionsByTopicResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of the subscriptions to a specific topic. Each call returns a limited\n list of subscriptions, up to 100. If there are more subscriptions, a\n NextToken is also returned. Use the NextToken parameter in\n a new ListSubscriptionsByTopic call to get further results.

\n

This action is throttled at 30 transactions per second (TPS).

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Subscriptions" + } + } + }, + "com.amazonaws.sns#ListSubscriptionsByTopicInput": { + "type": "structure", + "members": { + "TopicArn": { + "target": "com.amazonaws.sns#topicARN", + "traits": { + "smithy.api#documentation": "

The ARN of the topic for which you wish to find subscriptions.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sns#nextToken", + "traits": { + "smithy.api#documentation": "

Token returned by the previous ListSubscriptionsByTopic request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Input for ListSubscriptionsByTopic action.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#ListSubscriptionsByTopicResponse": { + "type": "structure", + "members": { + "Subscriptions": { + "target": "com.amazonaws.sns#SubscriptionsList", + "traits": { + "smithy.api#documentation": "

A list of subscriptions.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sns#nextToken", + "traits": { + "smithy.api#documentation": "

Token to pass along to the next ListSubscriptionsByTopic request. This\n element is returned if there are more subscriptions to retrieve.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Response for ListSubscriptionsByTopic action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#ListSubscriptionsInput": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sns#nextToken", + "traits": { + "smithy.api#documentation": "

Token returned by the previous ListSubscriptions request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Input for ListSubscriptions action.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#ListSubscriptionsResponse": { + "type": "structure", + "members": { + "Subscriptions": { + "target": "com.amazonaws.sns#SubscriptionsList", + "traits": { + "smithy.api#documentation": "

A list of subscriptions.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sns#nextToken", + "traits": { + "smithy.api#documentation": "

Token to pass along to the next ListSubscriptions request. This element\n is returned if there are more subscriptions to retrieve.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Response for ListSubscriptions action

", + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.sns#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#ConcurrentAccessException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.sns#TagPolicyException" + } + ], + "traits": { + "smithy.api#documentation": "

List all tags added to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the\n Amazon Simple Notification Service Developer Guide.

" + } + }, + "com.amazonaws.sns#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.sns#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The ARN of the topic for which to list tags.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.sns#TagList", + "traits": { + "smithy.api#documentation": "

The tags associated with the specified topic.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#ListTopics": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#ListTopicsInput" + }, + "output": { + "target": "com.amazonaws.sns#ListTopicsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of the requester's topics. Each call returns a limited list of topics,\n up to 100. If there are more topics, a NextToken is also returned. Use the\n NextToken parameter in a new ListTopics call to get\n further results.

\n

This action is throttled at 30 transactions per second (TPS).

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Topics" + }, + "smithy.test#smokeTests": [ + { + "id": "ListTopicsSuccess", + "params": {}, + "vendorParams": { + "region": "us-west-2" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "success": {} + } + } + ] + } + }, + "com.amazonaws.sns#ListTopicsInput": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sns#nextToken", + "traits": { + "smithy.api#documentation": "

Token returned by the previous ListTopics request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#ListTopicsResponse": { + "type": "structure", + "members": { + "Topics": { + "target": "com.amazonaws.sns#TopicsList", + "traits": { + "smithy.api#documentation": "

A list of topic ARNs.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sns#nextToken", + "traits": { + "smithy.api#documentation": "

Token to pass along to the next ListTopics request. This element is\n returned if there are additional topics to retrieve.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Response for ListTopics action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#MapStringToString": { + "type": "map", + "key": { + "target": "com.amazonaws.sns#String" + }, + "value": { + "target": "com.amazonaws.sns#String" + } + }, + "com.amazonaws.sns#MaxItems": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.sns#MaxItemsListOriginationNumbers": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 30 + } + } + }, + "com.amazonaws.sns#MessageAttributeMap": { + "type": "map", + "key": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#xmlName": "Name" + } + }, + "value": { + "target": "com.amazonaws.sns#MessageAttributeValue", + "traits": { + "smithy.api#xmlName": "Value" + } + } + }, + "com.amazonaws.sns#MessageAttributeValue": { + "type": "structure", + "members": { + "DataType": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

Amazon SNS supports the following logical data types: String, String.Array, Number, and\n Binary. For more information, see Message\n Attribute Data Types.

", + "smithy.api#required": {} + } + }, + "StringValue": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

Strings are Unicode with UTF8 binary encoding. For a list of code values, see ASCII Printable\n Characters.

" + } + }, + "BinaryValue": { + "target": "com.amazonaws.sns#Binary", + "traits": { + "smithy.api#documentation": "

Binary type attributes can store any binary data, for example, compressed data,\n encrypted data, or images.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The user-specified message attribute value. For string data types, the value attribute\n has the same restrictions on the content as the message body. For more information, see\n Publish.

\n

Name, type, and value must not be empty or null. In addition, the message body should\n not be empty or null. All parts of the message attribute, including name, type, and\n value, are included in the message size restriction, which is currently 256 KB (262,144\n bytes). For more information, see Amazon SNS message attributes and\n Publishing\n to a mobile phone in the Amazon SNS Developer Guide.\n

" + } + }, + "com.amazonaws.sns#NotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "NotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

Indicates that the requested resource does not exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.sns#NumberCapability": { + "type": "enum", + "members": { + "SMS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SMS" + } + }, + "MMS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MMS" + } + }, + "VOICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VOICE" + } + } + }, + "traits": { + "smithy.api#documentation": "Enum listing out all supported number capabilities." + } + }, + "com.amazonaws.sns#NumberCapabilityList": { + "type": "list", + "member": { + "target": "com.amazonaws.sns#NumberCapability" + }, + "traits": { + "smithy.api#documentation": "List of number capability (SMS,MMS,Voice)." + } + }, + "com.amazonaws.sns#OTPCode": { + "type": "string", + "traits": { + "smithy.api#documentation": "String of Origination/Destination address including phone numbers and email addresses", + "smithy.api#length": { + "min": 5, + "max": 8 + }, + "smithy.api#pattern": "^[0-9]+$" + } + }, + "com.amazonaws.sns#OptInPhoneNumber": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#OptInPhoneNumberInput" + }, + "output": { + "target": "com.amazonaws.sns#OptInPhoneNumberResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#ThrottledException" + } + ], + "traits": { + "smithy.api#documentation": "

Use this request to opt in a phone number that is opted out, which enables you to\n resume sending SMS messages to the number.

\n

You can opt in a phone number only once every 30 days.

" + } + }, + "com.amazonaws.sns#OptInPhoneNumberInput": { + "type": "structure", + "members": { + "phoneNumber": { + "target": "com.amazonaws.sns#PhoneNumber", + "traits": { + "smithy.api#documentation": "

The phone number to opt in. Use E.164 format.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Input for the OptInPhoneNumber action.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#OptInPhoneNumberResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

The response for the OptInPhoneNumber action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#OptedOutException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "OptedOut", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Indicates that the specified phone number opted out of receiving SMS messages from\n your Amazon Web Services account. You can't send SMS messages to phone numbers that opt out.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sns#PhoneNumber": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.sns#PhoneNumberInformation": { + "type": "structure", + "members": { + "CreatedAt": { + "target": "com.amazonaws.sns#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time when the phone number was created.

" + } + }, + "PhoneNumber": { + "target": "com.amazonaws.sns#PhoneNumber", + "traits": { + "smithy.api#documentation": "

The phone number.

" + } + }, + "Status": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

The status of the phone number.

" + } + }, + "Iso2CountryCode": { + "target": "com.amazonaws.sns#Iso2CountryCode", + "traits": { + "smithy.api#documentation": "

The two-character code for the country or region, in ISO 3166-1 alpha-2 format.

" + } + }, + "RouteType": { + "target": "com.amazonaws.sns#RouteType", + "traits": { + "smithy.api#documentation": "

The list of supported routes.

" + } + }, + "NumberCapabilities": { + "target": "com.amazonaws.sns#NumberCapabilityList", + "traits": { + "smithy.api#documentation": "

The capabilities of each phone number.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of phone numbers and their metadata.

" + } + }, + "com.amazonaws.sns#PhoneNumberInformationList": { + "type": "list", + "member": { + "target": "com.amazonaws.sns#PhoneNumberInformation" + }, + "traits": { + "smithy.api#documentation": "List of customer owned phone numbers." + } + }, + "com.amazonaws.sns#PhoneNumberList": { + "type": "list", + "member": { + "target": "com.amazonaws.sns#PhoneNumber" + } + }, + "com.amazonaws.sns#PhoneNumberString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + }, + "smithy.api#pattern": "^(\\+[0-9]{8,}|[0-9]{0,9})$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.sns#PlatformApplication": { + "type": "structure", + "members": { + "PlatformApplicationArn": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

PlatformApplicationArn for platform application object.

" + } + }, + "Attributes": { + "target": "com.amazonaws.sns#MapStringToString", + "traits": { + "smithy.api#documentation": "

Attributes for platform application object.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Platform application object.

" + } + }, + "com.amazonaws.sns#PlatformApplicationDisabledException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

Message for platform application disabled.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "PlatformApplicationDisabled", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Exception error indicating platform application disabled.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sns#Publish": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#PublishInput" + }, + "output": { + "target": "com.amazonaws.sns#PublishResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#EndpointDisabledException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.sns#InvalidSecurityException" + }, + { + "target": "com.amazonaws.sns#KMSAccessDeniedException" + }, + { + "target": "com.amazonaws.sns#KMSDisabledException" + }, + { + "target": "com.amazonaws.sns#KMSInvalidStateException" + }, + { + "target": "com.amazonaws.sns#KMSNotFoundException" + }, + { + "target": "com.amazonaws.sns#KMSOptInRequired" + }, + { + "target": "com.amazonaws.sns#KMSThrottlingException" + }, + { + "target": "com.amazonaws.sns#NotFoundException" + }, + { + "target": "com.amazonaws.sns#PlatformApplicationDisabledException" + }, + { + "target": "com.amazonaws.sns#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Sends a message to an Amazon SNS topic, a text message (SMS message) directly to a phone\n number, or a message to a mobile platform endpoint (when you specify the\n TargetArn).

\n

If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is\n subscribed to the topic. The format of the message depends on the notification protocol\n for each subscribed endpoint.

\n

When a messageId is returned, the message is saved and Amazon SNS immediately\n delivers it to subscribers.

\n

To use the Publish action for publishing a message to a mobile endpoint,\n such as an app on a Kindle device or mobile phone, you must specify the EndpointArn for\n the TargetArn parameter. The EndpointArn is returned when making a call with the\n CreatePlatformEndpoint action.

\n

For more information about formatting messages, see Send Custom\n Platform-Specific Payloads in Messages to Mobile Devices.

\n \n

You can publish messages only to topics and endpoints in the same\n Amazon Web Services Region.

\n " + } + }, + "com.amazonaws.sns#PublishBatch": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#PublishBatchInput" + }, + "output": { + "target": "com.amazonaws.sns#PublishBatchResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#BatchEntryIdsNotDistinctException" + }, + { + "target": "com.amazonaws.sns#BatchRequestTooLongException" + }, + { + "target": "com.amazonaws.sns#EmptyBatchRequestException" + }, + { + "target": "com.amazonaws.sns#EndpointDisabledException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidBatchEntryIdException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.sns#InvalidSecurityException" + }, + { + "target": "com.amazonaws.sns#KMSAccessDeniedException" + }, + { + "target": "com.amazonaws.sns#KMSDisabledException" + }, + { + "target": "com.amazonaws.sns#KMSInvalidStateException" + }, + { + "target": "com.amazonaws.sns#KMSNotFoundException" + }, + { + "target": "com.amazonaws.sns#KMSOptInRequired" + }, + { + "target": "com.amazonaws.sns#KMSThrottlingException" + }, + { + "target": "com.amazonaws.sns#NotFoundException" + }, + { + "target": "com.amazonaws.sns#PlatformApplicationDisabledException" + }, + { + "target": "com.amazonaws.sns#TooManyEntriesInBatchRequestException" + }, + { + "target": "com.amazonaws.sns#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Publishes up to ten messages to the specified topic. This is a batch version of\n Publish. For FIFO topics, multiple messages within a single batch are\n published in the order they are sent, and messages are deduplicated within the batch and\n across batches for 5 minutes.

\n

The result of publishing each message is reported individually in the response.\n Because the batch request can result in a combination of successful and unsuccessful\n actions, you should check for batch errors even when the call returns an HTTP status\n code of 200.

\n

The maximum allowed individual message size and the maximum total payload size (the\n sum of the individual lengths of all of the batched messages) are both 256 KB (262,144\n bytes).

\n

Some actions take lists of parameters. These lists are specified using the\n param.n notation. Values of n are integers starting from\n 1. For example, a parameter list with two elements looks like this:

\n

&AttributeName.1=first

\n

&AttributeName.2=second

\n

If you send a batch message to a topic, Amazon SNS publishes the batch message to each\n endpoint that is subscribed to the topic. The format of the batch message depends on the\n notification protocol for each subscribed endpoint.

\n

When a messageId is returned, the batch message is saved and Amazon SNS\n immediately delivers the message to subscribers.

" + } + }, + "com.amazonaws.sns#PublishBatchInput": { + "type": "structure", + "members": { + "TopicArn": { + "target": "com.amazonaws.sns#topicARN", + "traits": { + "smithy.api#documentation": "

The Amazon resource name (ARN) of the topic you want to batch publish to.

", + "smithy.api#required": {} + } + }, + "PublishBatchRequestEntries": { + "target": "com.amazonaws.sns#PublishBatchRequestEntryList", + "traits": { + "smithy.api#documentation": "

A list of PublishBatch request entries to be sent to the SNS\n topic.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#PublishBatchRequestEntry": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

An identifier for the message in this batch.

\n \n

The Ids of a batch request must be unique within a request.

\n

This identifier can have up to 80 characters. The following characters are\n accepted: alphanumeric characters, hyphens(-), and underscores (_).

\n ", + "smithy.api#required": {} + } + }, + "Message": { + "target": "com.amazonaws.sns#message", + "traits": { + "smithy.api#documentation": "

The body of the message.

", + "smithy.api#required": {} + } + }, + "Subject": { + "target": "com.amazonaws.sns#subject", + "traits": { + "smithy.api#documentation": "

The subject of the batch message.

" + } + }, + "MessageStructure": { + "target": "com.amazonaws.sns#messageStructure", + "traits": { + "smithy.api#documentation": "

Set MessageStructure to json if you want to send a different\n message for each protocol. For example, using one publish action, you can send a short\n message to your SMS subscribers and a longer message to your email subscribers. If you\n set MessageStructure to json, the value of the\n Message parameter must:

\n
    \n
  • \n

    be a syntactically valid JSON object; and

    \n
    • \n
  • \n

    contain at least a top-level JSON key of \"default\" with a value that is a\n string.

    \n
    • \n
\n

You can define other top-level keys that define the message you want to send to a\n specific transport protocol (e.g. http).

" + } + }, + "MessageAttributes": { + "target": "com.amazonaws.sns#MessageAttributeMap", + "traits": { + "smithy.api#documentation": "

Each message attribute consists of a Name, Type, and\n Value. For more information, see Amazon SNS message attributes in\n the Amazon SNS Developer Guide.

" + } + }, + "MessageDeduplicationId": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) topics.

\n

The token used for deduplication of messages within a 5-minute minimum deduplication\n interval. If a message with a particular MessageDeduplicationId is sent\n successfully, subsequent messages with the same MessageDeduplicationId are\n accepted successfully but aren't delivered.

\n
    \n
  • \n

    Every message must have a unique MessageDeduplicationId.

    \n
      \n
    • \n

      You may provide a MessageDeduplicationId\n explicitly.

      \n
      • \n
    • \n

      If you aren't able to provide a MessageDeduplicationId\n and you enable ContentBasedDeduplication for your topic,\n Amazon SNS uses a SHA-256 hash to generate the\n MessageDeduplicationId using the body of the message\n (but not the attributes of the message).

      \n
      • \n
    • \n

      If you don't provide a MessageDeduplicationId and the\n topic doesn't have ContentBasedDeduplication set, the\n action fails with an error.

      \n
      • \n
    • \n

      If the topic has a ContentBasedDeduplication set, your\n MessageDeduplicationId overrides the generated one.\n

      \n
      • \n
    \n
    • \n
  • \n

    When ContentBasedDeduplication is in effect, messages with\n identical content sent within the deduplication interval are treated as\n duplicates and only one copy of the message is delivered.

    \n
    • \n
  • \n

    If you send one message with ContentBasedDeduplication enabled,\n and then another message with a MessageDeduplicationId that is the\n same as the one generated for the first MessageDeduplicationId, the\n two messages are treated as duplicates and only one copy of the message is\n delivered.

    \n
    • \n
\n \n

The MessageDeduplicationId is available to the consumer of the\n message (this can be useful for troubleshooting delivery issues).

\n

If a message is sent successfully but the acknowledgement is lost and the message\n is resent with the same MessageDeduplicationId after the deduplication\n interval, Amazon SNS can't detect duplicate messages.

\n

Amazon SNS continues to keep track of the message deduplication ID even after the\n message is received and deleted.

\n \n

The length of MessageDeduplicationId is 128 characters.

\n

\n MessageDeduplicationId can contain alphanumeric characters (a-z,\n A-Z, 0-9) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

" + } + }, + "MessageGroupId": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) topics.

\n

The tag that specifies that a message belongs to a specific message group. Messages\n that belong to the same message group are processed in a FIFO manner (however, messages\n in different message groups might be processed out of order). To interleave multiple\n ordered streams within a single topic, use MessageGroupId values (for\n example, session data for multiple users). In this scenario, multiple consumers can\n process the topic, but the session data of each user is processed in a FIFO fashion.

\n

You must associate a non-empty MessageGroupId with a message. If you\n don't provide a MessageGroupId, the action fails.

\n

The length of MessageGroupId is 128 characters.

\n

\n MessageGroupId can contain alphanumeric characters (a-z, A-Z,\n 0-9) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

\n \n

\n MessageGroupId is required for FIFO topics. You can't use it for\n standard topics.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details of a single Amazon SNS message along with an Id that\n identifies a message within the batch.

" + } + }, + "com.amazonaws.sns#PublishBatchRequestEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sns#PublishBatchRequestEntry" + } + }, + "com.amazonaws.sns#PublishBatchResponse": { + "type": "structure", + "members": { + "Successful": { + "target": "com.amazonaws.sns#PublishBatchResultEntryList", + "traits": { + "smithy.api#documentation": "

A list of successful PublishBatch responses.

" + } + }, + "Failed": { + "target": "com.amazonaws.sns#BatchResultErrorEntryList", + "traits": { + "smithy.api#documentation": "

A list of failed PublishBatch responses.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#PublishBatchResultEntry": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

The Id of an entry in a batch request.

" + } + }, + "MessageId": { + "target": "com.amazonaws.sns#messageId", + "traits": { + "smithy.api#documentation": "

An identifier for the message.

" + } + }, + "SequenceNumber": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) topics.

\n

The large, non-consecutive number that Amazon SNS assigns to each message.

\n

The length of SequenceNumber is 128 bits. SequenceNumber\n continues to increase for a particular MessageGroupId.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Encloses data related to a successful message in a batch request for topic.

" + } + }, + "com.amazonaws.sns#PublishBatchResultEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sns#PublishBatchResultEntry" + } + }, + "com.amazonaws.sns#PublishInput": { + "type": "structure", + "members": { + "TopicArn": { + "target": "com.amazonaws.sns#topicARN", + "traits": { + "smithy.api#documentation": "

The topic you want to publish to.

\n

If you don't specify a value for the TopicArn parameter, you must specify\n a value for the PhoneNumber or TargetArn parameters.

" + } + }, + "TargetArn": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

If you don't specify a value for the TargetArn parameter, you must\n specify a value for the PhoneNumber or TopicArn\n parameters.

" + } + }, + "PhoneNumber": { + "target": "com.amazonaws.sns#PhoneNumber", + "traits": { + "smithy.api#documentation": "

The phone number to which you want to deliver an SMS message. Use E.164 format.

\n

If you don't specify a value for the PhoneNumber parameter, you must\n specify a value for the TargetArn or TopicArn\n parameters.

" + } + }, + "Message": { + "target": "com.amazonaws.sns#message", + "traits": { + "smithy.api#documentation": "

The message you want to send.

\n

If you are publishing to a topic and you want to send the same message to all\n transport protocols, include the text of the message as a String value. If you want to\n send different messages for each transport protocol, set the value of the\n MessageStructure parameter to json and use a JSON object\n for the Message parameter. \n

\n

\n

Constraints:

\n
    \n
  • \n

    With the exception of SMS, messages must be UTF-8 encoded strings and at most\n 256 KB in size (262,144 bytes, not 262,144 characters).

    \n
    • \n
  • \n

    For SMS, each message can contain up to 140 characters. This character limit\n depends on the encoding schema. For example, an SMS message can contain 160 GSM\n characters, 140 ASCII characters, or 70 UCS-2 characters.

    \n

    If you publish a message that exceeds this size limit, Amazon SNS sends the message\n as multiple messages, each fitting within the size limit. Messages aren't\n truncated mid-word but are cut off at whole-word boundaries.

    \n

    The total size limit for a single SMS Publish action is 1,600\n characters.

    \n
    • \n
\n

JSON-specific constraints:

\n
    \n
  • \n

    Keys in the JSON object that correspond to supported transport protocols must\n have simple JSON string values.

    \n
    • \n
  • \n

    The values will be parsed (unescaped) before they are used in outgoing\n messages.

    \n
    • \n
  • \n

    Outbound notifications are JSON encoded (meaning that the characters will be\n reescaped for sending).

    \n
    • \n
  • \n

    Values have a minimum length of 0 (the empty string, \"\", is allowed).

    \n
    • \n
  • \n

    Values have a maximum length bounded by the overall message size (so,\n including multiple protocols may limit message sizes).

    \n
    • \n
  • \n

    Non-string values will cause the key to be ignored.

    \n
    • \n
  • \n

    Keys that do not correspond to supported transport protocols are\n ignored.

    \n
    • \n
  • \n

    Duplicate keys are not allowed.

    \n
    • \n
  • \n

    Failure to parse or validate any key or value in the message will cause the\n Publish call to return an error (no partial delivery).

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Subject": { + "target": "com.amazonaws.sns#subject", + "traits": { + "smithy.api#documentation": "

Optional parameter to be used as the \"Subject\" line when the message is delivered to\n email endpoints. This field will also be included, if present, in the standard JSON\n messages delivered to other endpoints.

\n

Constraints: Subjects must be UTF-8 text with no line breaks or control characters,\n and less than 100 characters long.

" + } + }, + "MessageStructure": { + "target": "com.amazonaws.sns#messageStructure", + "traits": { + "smithy.api#documentation": "

Set MessageStructure to json if you want to send a different\n message for each protocol. For example, using one publish action, you can send a short\n message to your SMS subscribers and a longer message to your email subscribers. If you\n set MessageStructure to json, the value of the\n Message parameter must:

\n
    \n
  • \n

    be a syntactically valid JSON object; and

    \n
    • \n
  • \n

    contain at least a top-level JSON key of \"default\" with a value that is a\n string.

    \n
    • \n
\n

You can define other top-level keys that define the message you want to send to a\n specific transport protocol (e.g., \"http\").

\n

Valid value: json\n

" + } + }, + "MessageAttributes": { + "target": "com.amazonaws.sns#MessageAttributeMap", + "traits": { + "smithy.api#documentation": "

Message attributes for Publish action.

" + } + }, + "MessageDeduplicationId": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) topics. The\n MessageDeduplicationId can contain up to 128 alphanumeric characters\n (a-z, A-Z, 0-9) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

\n

Every message must have a unique MessageDeduplicationId, which is a token\n used for deduplication of sent messages. If a message with a particular\n MessageDeduplicationId is sent successfully, any message sent with the\n same MessageDeduplicationId during the 5-minute deduplication interval is\n treated as a duplicate.

\n

If the topic has ContentBasedDeduplication set, the system generates a\n MessageDeduplicationId based on the contents of the message. Your\n MessageDeduplicationId overrides the generated one.

" + } + }, + "MessageGroupId": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) topics. The\n MessageGroupId can contain up to 128 alphanumeric characters\n (a-z, A-Z, 0-9) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

\n

The MessageGroupId is a tag that specifies that a message belongs to a\n specific message group. Messages that belong to the same message group are processed in\n a FIFO manner (however, messages in different message groups might be processed out of\n order). Every message must include a MessageGroupId.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Input for Publish action.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#PublishResponse": { + "type": "structure", + "members": { + "MessageId": { + "target": "com.amazonaws.sns#messageId", + "traits": { + "smithy.api#documentation": "

Unique identifier assigned to the published message.

\n

Length Constraint: Maximum 100 characters

" + } + }, + "SequenceNumber": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

This response element applies only to FIFO (first-in-first-out) topics.

\n

The sequence number is a large, non-consecutive number that Amazon SNS assigns to each\n message. The length of SequenceNumber is 128 bits.\n SequenceNumber continues to increase for each\n MessageGroupId.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Response for Publish action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#PutDataProtectionPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#PutDataProtectionPolicyInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#InvalidSecurityException" + }, + { + "target": "com.amazonaws.sns#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds or updates an inline policy document that is stored in the specified Amazon SNS\n topic.

" + } + }, + "com.amazonaws.sns#PutDataProtectionPolicyInput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.sns#topicARN", + "traits": { + "smithy.api#documentation": "

The ARN of the topic whose DataProtectionPolicy you want to add or\n update.

\n

For more information about ARNs, see Amazon Resource Names\n (ARNs) in the Amazon Web Services General Reference.

", + "smithy.api#required": {} + } + }, + "DataProtectionPolicy": { + "target": "com.amazonaws.sns#attributeValue", + "traits": { + "smithy.api#documentation": "

The JSON serialization of the topic's DataProtectionPolicy.

\n

The DataProtectionPolicy must be in JSON string format.

\n

Length Constraints: Maximum length of 30,720.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#RemovePermission": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#RemovePermissionInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes a statement from a topic's access control policy.

\n \n

To remove the ability to change topic permissions, you must deny permissions to\n the AddPermission, RemovePermission, and\n SetTopicAttributes actions in your IAM policy.

\n " + } + }, + "com.amazonaws.sns#RemovePermissionInput": { + "type": "structure", + "members": { + "TopicArn": { + "target": "com.amazonaws.sns#topicARN", + "traits": { + "smithy.api#documentation": "

The ARN of the topic whose access control policy you wish to modify.

", + "smithy.api#required": {} + } + }, + "Label": { + "target": "com.amazonaws.sns#label", + "traits": { + "smithy.api#documentation": "

The unique label of the statement you want to remove.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Input for RemovePermission action.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#ReplayLimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ReplayLimitExceeded", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "

Indicates that the request parameter has exceeded the maximum number of concurrent message replays.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.sns#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ResourceNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

Can’t perform the action on the specified resource. Make sure that the resource\n exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.sns#RouteType": { + "type": "enum", + "members": { + "Transactional": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Transactional" + } + }, + "Promotional": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Promotional" + } + }, + "Premium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Premium" + } + } + }, + "traits": { + "smithy.api#documentation": "Enum listing out all supported route types. The following enum values are supported.\n 1. Transactional : Non-marketing traffic\n 2. Promotional : Marketing\n 3. Premium : Premium routes for OTP delivery to the carriers" + } + }, + "com.amazonaws.sns#SMSSandboxPhoneNumber": { + "type": "structure", + "members": { + "PhoneNumber": { + "target": "com.amazonaws.sns#PhoneNumberString", + "traits": { + "smithy.api#documentation": "

The destination phone number.

" + } + }, + "Status": { + "target": "com.amazonaws.sns#SMSSandboxPhoneNumberVerificationStatus", + "traits": { + "smithy.api#documentation": "

The destination phone number's verification status.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A verified or pending destination phone number in the SMS sandbox.

\n

When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the\n SMS sandbox. The SMS sandbox provides a safe environment for \n you to try Amazon SNS features without risking your reputation as an SMS sender. While your \n Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send \n SMS messages only to verified destination phone numbers. For more information, including how to \n move out of the sandbox to send messages without restrictions, \n see SMS sandbox in \n the Amazon SNS Developer Guide.

" + } + }, + "com.amazonaws.sns#SMSSandboxPhoneNumberList": { + "type": "list", + "member": { + "target": "com.amazonaws.sns#SMSSandboxPhoneNumber" + } + }, + "com.amazonaws.sns#SMSSandboxPhoneNumberVerificationStatus": { + "type": "enum", + "members": { + "Pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "Verified": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Verified" + } + } + }, + "traits": { + "smithy.api#documentation": "Enum listing out all supported destination phone number verification statuses. The following enum values are\n supported.\n 1. PENDING : The destination phone number is pending verification.\n 2. VERIFIED : The destination phone number is verified." + } + }, + "com.amazonaws.sns#SetEndpointAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#SetEndpointAttributesInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Sets the attributes for an endpoint for a device on one of the supported push\n notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more\n information, see Using Amazon SNS Mobile Push Notifications.

" + } + }, + "com.amazonaws.sns#SetEndpointAttributesInput": { + "type": "structure", + "members": { + "EndpointArn": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

EndpointArn used for SetEndpointAttributes action.

", + "smithy.api#required": {} + } + }, + "Attributes": { + "target": "com.amazonaws.sns#MapStringToString", + "traits": { + "smithy.api#documentation": "

A map of the endpoint attributes. Attributes in this map include the following:

\n
    \n
  • \n

    \n CustomUserData – arbitrary user data to associate with the\n endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and\n less than 2KB.

    \n
    • \n
  • \n

    \n Enabled – flag that enables/disables delivery to the\n endpoint. Amazon SNS will set this to false when a notification service indicates to\n Amazon SNS that the endpoint is invalid. Users can set it back to true, typically\n after updating Token.

    \n
    • \n
  • \n

    \n Token – device token, also referred to as a registration id,\n for an app and mobile device. This is returned from the notification service\n when an app and mobile device are registered with the notification\n service.

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Input for SetEndpointAttributes action.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#SetPlatformApplicationAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#SetPlatformApplicationAttributesInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Sets the attributes of the platform application object for the supported push\n notification services, such as APNS and GCM (Firebase Cloud Messaging). For more\n information, see Using Amazon SNS Mobile Push Notifications. For information on configuring\n attributes for message delivery status, see Using Amazon SNS Application Attributes for\n Message Delivery Status.

" + } + }, + "com.amazonaws.sns#SetPlatformApplicationAttributesInput": { + "type": "structure", + "members": { + "PlatformApplicationArn": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

\n PlatformApplicationArn for SetPlatformApplicationAttributes\n action.

", + "smithy.api#required": {} + } + }, + "Attributes": { + "target": "com.amazonaws.sns#MapStringToString", + "traits": { + "smithy.api#documentation": "

A map of the platform application attributes. Attributes in this map include the\n following:

\n
    \n
  • \n

    \n PlatformCredential – The credential received from the\n notification service.

    \n
      \n
    • \n

      For ADM, PlatformCredentialis client secret.

      \n
      • \n
    • \n

      For Apple Services using certificate credentials,\n PlatformCredential is private key.

      \n
      • \n
    • \n

      For Apple Services using token credentials,\n PlatformCredential is signing key.

      \n
      • \n
    • \n

      For GCM (Firebase Cloud Messaging) using key credentials, there is no\n PlatformPrincipal. The PlatformCredential\n is API key.

      \n
      • \n
    • \n

      For GCM (Firebase Cloud Messaging) using token credentials, there is\n no PlatformPrincipal. The PlatformCredential\n is a JSON formatted private key file. When using the Amazon Web Services CLI, the file\n must be in string format and special characters must be ignored. To\n format the file correctly, Amazon SNS recommends using the following command:\n SERVICE_JSON=`jq @json <<< cat\n service.json`.

      \n
      • \n
    \n
    • \n
\n
    \n
  • \n

    \n PlatformPrincipal – The principal received from the\n notification service.

    \n
      \n
    • \n

      For ADM, PlatformPrincipalis client id.

      \n
      • \n
    • \n

      For Apple Services using certificate credentials,\n PlatformPrincipal is SSL certificate.

      \n
      • \n
    • \n

      For Apple Services using token credentials,\n PlatformPrincipal is signing key ID.

      \n
      • \n
    • \n

      For GCM (Firebase Cloud Messaging), there is no\n PlatformPrincipal.

      \n
      • \n
    \n
    • \n
\n
    \n
  • \n

    \n EventEndpointCreated – Topic ARN to which\n EndpointCreated event notifications are sent.

    \n
    • \n
  • \n

    \n EventEndpointDeleted – Topic ARN to which\n EndpointDeleted event notifications are sent.

    \n
    • \n
  • \n

    \n EventEndpointUpdated – Topic ARN to which\n EndpointUpdate event notifications are sent.

    \n
    • \n
  • \n

    \n EventDeliveryFailure – Topic ARN to which\n DeliveryFailure event notifications are sent upon Direct\n Publish delivery failure (permanent) to one of the application's\n endpoints.

    \n
    • \n
  • \n

    \n SuccessFeedbackRoleArn – IAM role ARN used to give Amazon SNS\n write access to use CloudWatch Logs on your behalf.

    \n
    • \n
  • \n

    \n FailureFeedbackRoleArn – IAM role ARN used to give Amazon SNS\n write access to use CloudWatch Logs on your behalf.

    \n
    • \n
  • \n

    \n SuccessFeedbackSampleRate – Sample rate percentage (0-100)\n of successfully delivered messages.

    \n
    • \n
\n

The following attributes only apply to APNs token-based\n authentication:

\n
    \n
  • \n

    \n ApplePlatformTeamID – The identifier that's assigned to your\n Apple developer account team.

    \n
    • \n
  • \n

    \n ApplePlatformBundleID – The bundle identifier that's assigned to\n your iOS app.

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Input for SetPlatformApplicationAttributes action.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#SetSMSAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#SetSMSAttributesInput" + }, + "output": { + "target": "com.amazonaws.sns#SetSMSAttributesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#ThrottledException" + } + ], + "traits": { + "smithy.api#documentation": "

Use this request to set the default settings for sending SMS messages and receiving\n daily SMS usage reports.

\n

You can override some of these settings for a single message when you use the\n Publish action with the MessageAttributes.entry.N\n parameter. For more information, see Publishing to a mobile phone\n in the Amazon SNS Developer Guide.

\n \n

To use this operation, you must grant the Amazon SNS service principal\n (sns.amazonaws.com) permission to perform the\n s3:ListBucket action.

\n " + } + }, + "com.amazonaws.sns#SetSMSAttributesInput": { + "type": "structure", + "members": { + "attributes": { + "target": "com.amazonaws.sns#MapStringToString", + "traits": { + "smithy.api#documentation": "

The default settings for sending SMS messages from your Amazon Web Services account. You can set\n values for the following attribute names:

\n

\n MonthlySpendLimit – The maximum amount in USD that you are willing to spend\n each month to send SMS messages. When Amazon SNS determines that sending an SMS message would\n incur a cost that exceeds this limit, it stops sending SMS messages within\n minutes.

\n \n

Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During\n that interval, if you continue to send SMS messages, you will incur costs that\n exceed your limit.

\n \n

By default, the spend limit is set to the maximum allowed by Amazon SNS. If you want to\n raise the limit, submit an SNS Limit Increase case. For New limit\n value, enter your desired monthly spend limit. In the Use Case Description field, explain that you are requesting\n an SMS monthly spend limit increase.

\n

\n DeliveryStatusIAMRole – The ARN of the IAM role that allows Amazon SNS to write\n logs about SMS deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS\n writes a log that includes the message price, the success or failure status, the reason\n for failure (if the message failed), the message dwell time, and other\n information.

\n

\n DeliveryStatusSuccessSamplingRate – The percentage of successful SMS\n deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value can be an\n integer from 0 - 100. For example, to write logs only for failed deliveries, set this\n value to 0. To write logs for 10% of your successful deliveries, set it to\n 10.

\n

\n DefaultSenderID – A string, such as your business brand, that is displayed\n as the sender on the receiving device. Support for sender IDs varies by country. The\n sender ID can be 1 - 11 alphanumeric characters, and it must contain at least one\n letter.

\n

\n DefaultSMSType – The type of SMS message that you will send by default. You\n can assign the following values:

\n
    \n
  • \n

    \n Promotional – (Default) Noncritical messages, such as marketing\n messages. Amazon SNS optimizes the message delivery to incur the lowest cost.

    \n
    • \n
  • \n

    \n Transactional – Critical messages that support customer\n transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS\n optimizes the message delivery to achieve the highest reliability.

    \n
    • \n
\n

\n UsageReportS3Bucket – The name of the Amazon S3 bucket to receive daily SMS\n usage reports from Amazon SNS. Each day, Amazon SNS will deliver a usage report as a CSV file to\n the bucket. The report includes the following information for each SMS message that was\n successfully delivered by your Amazon Web Services account:

\n
    \n
  • \n

    Time that the message was published (in UTC)

    \n
    • \n
  • \n

    Message ID

    \n
    • \n
  • \n

    Destination phone number

    \n
    • \n
  • \n

    Message type

    \n
    • \n
  • \n

    Delivery status

    \n
    • \n
  • \n

    Message price (in USD)

    \n
    • \n
  • \n

    Part number (a message is split into multiple parts if it is too long for a\n single message)

    \n
    • \n
  • \n

    Total number of parts

    \n
    • \n
\n

To receive the report, the bucket must have a policy that allows the Amazon SNS service\n principal to perform the s3:PutObject and s3:GetBucketLocation\n actions.

\n

For an example bucket policy and usage report, see Monitoring SMS Activity in the\n Amazon SNS Developer Guide.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The input for the SetSMSAttributes action.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#SetSMSAttributesResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

The response for the SetSMSAttributes action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#SetSubscriptionAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#SetSubscriptionAttributesInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#FilterPolicyLimitExceededException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#NotFoundException" + }, + { + "target": "com.amazonaws.sns#ReplayLimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Allows a subscription owner to set an attribute of the subscription to a new\n value.

" + } + }, + "com.amazonaws.sns#SetSubscriptionAttributesInput": { + "type": "structure", + "members": { + "SubscriptionArn": { + "target": "com.amazonaws.sns#subscriptionARN", + "traits": { + "smithy.api#documentation": "

The ARN of the subscription to modify.

", + "smithy.api#required": {} + } + }, + "AttributeName": { + "target": "com.amazonaws.sns#attributeName", + "traits": { + "smithy.api#documentation": "

A map of attributes with their corresponding values.

\n

The following lists the names, descriptions, and values of the special request\n parameters that this action uses:

\n
    \n
  • \n

    \n DeliveryPolicy – The policy that defines how Amazon SNS retries\n failed deliveries to HTTP/S endpoints.

    \n
    • \n
  • \n

    \n FilterPolicy – The simple JSON object that lets your\n subscriber receive only a subset of messages, rather than receiving every\n message published to the topic.

    \n
    • \n
  • \n

    \n FilterPolicyScope – This attribute lets you choose the\n filtering scope by using one of the following string value types:

    \n
      \n
    • \n

      \n MessageAttributes (default) – The filter is\n applied on the message attributes.

      \n
      • \n
    • \n

      \n MessageBody – The filter is applied on the message\n body.

      \n
      • \n
    \n
    • \n
  • \n

    \n RawMessageDelivery – When set to true,\n enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the\n need for the endpoints to process JSON formatting, which is otherwise created\n for Amazon SNS metadata.

    \n
    • \n
  • \n

    \n RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. \n Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable)\n or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held \n in the dead-letter queue for further analysis or reprocessing.

    \n
    • \n
\n

The following attribute applies only to Amazon Data Firehose delivery stream subscriptions:

\n
    \n
  • \n

    \n SubscriptionRoleArn – The ARN of the IAM role that has the following:

    \n
      \n
    • \n

      Permission to write to the Firehose delivery stream

      \n
      • \n
    • \n

      Amazon SNS listed as a trusted entity

      \n
      • \n
    \n

    Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. \n For more information, see Fanout \n to Firehose delivery streams in the Amazon SNS Developer Guide.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "AttributeValue": { + "target": "com.amazonaws.sns#attributeValue", + "traits": { + "smithy.api#documentation": "

The new value for the attribute in JSON format.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Input for SetSubscriptionAttributes action.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#SetTopicAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#SetTopicAttributesInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#InvalidSecurityException" + }, + { + "target": "com.amazonaws.sns#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Allows a topic owner to set an attribute of the topic to a new value.

\n \n

To remove the ability to change topic permissions, you must deny permissions to\n the AddPermission, RemovePermission, and\n SetTopicAttributes actions in your IAM policy.

\n " + } + }, + "com.amazonaws.sns#SetTopicAttributesInput": { + "type": "structure", + "members": { + "TopicArn": { + "target": "com.amazonaws.sns#topicARN", + "traits": { + "smithy.api#documentation": "

The ARN of the topic to modify.

", + "smithy.api#required": {} + } + }, + "AttributeName": { + "target": "com.amazonaws.sns#attributeName", + "traits": { + "smithy.api#documentation": "

A map of attributes with their corresponding values.

\n

The following lists the names, descriptions, and values of the special request\n parameters that the SetTopicAttributes action uses:

\n
    \n
  • \n

    \n ApplicationSuccessFeedbackRoleArn – Indicates failed\n message delivery status for an Amazon SNS topic that is subscribed to a platform\n application endpoint.

    \n
    • \n
  • \n

    \n DeliveryPolicy – The policy that defines how Amazon SNS retries\n failed deliveries to HTTP/S endpoints.

    \n
    • \n
  • \n

    \n DisplayName – The display name to use for a topic with SMS\n subscriptions.

    \n
    • \n
  • \n

    \n Policy – The policy that defines who can access your\n topic. By default, only the topic owner can publish or subscribe to the\n topic.

    \n
    • \n
  • \n

    \n TracingConfig – Tracing mode of an Amazon SNS topic. By default\n TracingConfig is set to PassThrough, and the topic\n passes through the tracing header it receives from an Amazon SNS publisher to its\n subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data\n to topic owner account if the sampled flag in the tracing header is true. This\n is only supported on standard topics.

    \n
    • \n
  • \n

    HTTP

    \n
      \n
    • \n

      \n HTTPSuccessFeedbackRoleArn – Indicates successful\n message delivery status for an Amazon SNS topic that is subscribed to an HTTP\n endpoint.

      \n
      • \n
    • \n

      \n HTTPSuccessFeedbackSampleRate – Indicates\n percentage of successful messages to sample for an Amazon SNS topic that is\n subscribed to an HTTP endpoint.

      \n
      • \n
    • \n

      \n HTTPFailureFeedbackRoleArn – Indicates failed\n message delivery status for an Amazon SNS topic that is subscribed to an HTTP\n endpoint.

      \n
      • \n
    \n
    • \n
  • \n

    Amazon Kinesis Data Firehose

    \n
      \n
    • \n

      \n FirehoseSuccessFeedbackRoleArn – Indicates\n successful message delivery status for an Amazon SNS topic that is subscribed\n to an Amazon Kinesis Data Firehose endpoint.

      \n
      • \n
    • \n

      \n FirehoseSuccessFeedbackSampleRate – Indicates\n percentage of successful messages to sample for an Amazon SNS topic that is\n subscribed to an Amazon Kinesis Data Firehose endpoint.

      \n
      • \n
    • \n

      \n FirehoseFailureFeedbackRoleArn – Indicates failed\n message delivery status for an Amazon SNS topic that is subscribed to an\n Amazon Kinesis Data Firehose endpoint.

      \n
      • \n
    \n
    • \n
  • \n

    Lambda

    \n
      \n
    • \n

      \n LambdaSuccessFeedbackRoleArn – Indicates\n successful message delivery status for an Amazon SNS topic that is subscribed\n to an Lambda endpoint.

      \n
      • \n
    • \n

      \n LambdaSuccessFeedbackSampleRate – Indicates\n percentage of successful messages to sample for an Amazon SNS topic that is\n subscribed to an Lambda endpoint.

      \n
      • \n
    • \n

      \n LambdaFailureFeedbackRoleArn – Indicates failed\n message delivery status for an Amazon SNS topic that is subscribed to an\n Lambda endpoint.

      \n
      • \n
    \n
    • \n
  • \n

    Platform application endpoint

    \n
      \n
    • \n

      \n ApplicationSuccessFeedbackRoleArn – Indicates\n successful message delivery status for an Amazon SNS topic that is subscribed\n to an Amazon Web Services application endpoint.

      \n
      • \n
    • \n

      \n ApplicationSuccessFeedbackSampleRate – Indicates\n percentage of successful messages to sample for an Amazon SNS topic that is\n subscribed to an Amazon Web Services application endpoint.

      \n
      • \n
    • \n

      \n ApplicationFailureFeedbackRoleArn – Indicates\n failed message delivery status for an Amazon SNS topic that is subscribed to\n an Amazon Web Services application endpoint.

      \n
      • \n
    \n \n

    In addition to being able to configure topic attributes for message\n delivery status of notification messages sent to Amazon SNS application\n endpoints, you can also configure application attributes for the delivery\n status of push notification messages sent to push notification\n services.

    \n

    For example, For more information, see Using Amazon SNS Application\n Attributes for Message Delivery Status.

    \n     \n
    • \n
  • \n

    Amazon SQS

    \n
      \n
    • \n

      \n SQSSuccessFeedbackRoleArn – Indicates successful\n message delivery status for an Amazon SNS topic that is subscribed to an\n Amazon SQS endpoint.

      \n
      • \n
    • \n

      \n SQSSuccessFeedbackSampleRate – Indicates\n percentage of successful messages to sample for an Amazon SNS topic that is\n subscribed to an Amazon SQS endpoint.

      \n
      • \n
    • \n

      \n SQSFailureFeedbackRoleArn – Indicates failed\n message delivery status for an Amazon SNS topic that is subscribed to an\n Amazon SQS endpoint.

      \n
      • \n
    \n
    • \n
\n \n

The SuccessFeedbackRoleArn and FailureFeedbackRoleArn\n attributes are used to give Amazon SNS write access to use CloudWatch Logs on your\n behalf. The SuccessFeedbackSampleRate attribute is for specifying the\n sample rate percentage (0-100) of successfully delivered messages. After you\n configure the FailureFeedbackRoleArn attribute, then all failed message\n deliveries generate CloudWatch Logs.

\n \n

The following attribute applies only to server-side-encryption:

\n
    \n
  • \n

    \n KmsMasterKeyId – The ID of an Amazon Web Services managed customer master\n key (CMK) for Amazon SNS or a custom CMK. For more information, see Key\n Terms. For more examples, see KeyId in the Key Management Service API Reference.

    \n
    • \n
  • \n

    \n SignatureVersion – The signature version corresponds to the\n hashing algorithm used while creating the signature of the notifications,\n subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS.\n By default, SignatureVersion is set to 1.

    \n
    • \n
\n

The following attribute applies only to FIFO topics:

\n
    \n
  • \n

    \n ArchivePolicy – The policy that sets the retention period\n for messages stored in the message archive of an Amazon SNS FIFO\n topic.

    \n
    • \n
  • \n

    \n ContentBasedDeduplication – Enables content-based\n deduplication for FIFO topics.

    \n
      \n
    • \n

      By default, ContentBasedDeduplication is set to\n false. If you create a FIFO topic and this attribute is\n false, you must specify a value for the\n MessageDeduplicationId parameter for the Publish\n action.

      \n
      • \n
    • \n

      When you set ContentBasedDeduplication to true,\n Amazon SNS uses a SHA-256 hash to generate the\n MessageDeduplicationId using the body of the message (but not\n the attributes of the message).

      \n

      (Optional) To override the generated value, you can specify a value for the\n MessageDeduplicationId parameter for the Publish\n action.

      \n
      • \n
    \n
    • \n
", + "smithy.api#required": {} + } + }, + "AttributeValue": { + "target": "com.amazonaws.sns#attributeValue", + "traits": { + "smithy.api#documentation": "

The new value for the attribute.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Input for SetTopicAttributes action.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#StaleTagException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "StaleTag", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

A tag has been added to a resource with the same ARN as a deleted resource. Wait a\n short while and then retry the operation.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sns#String": { + "type": "string" + }, + "com.amazonaws.sns#Subscribe": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#SubscribeInput" + }, + "output": { + "target": "com.amazonaws.sns#SubscribeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#FilterPolicyLimitExceededException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#InvalidSecurityException" + }, + { + "target": "com.amazonaws.sns#NotFoundException" + }, + { + "target": "com.amazonaws.sns#ReplayLimitExceededException" + }, + { + "target": "com.amazonaws.sns#SubscriptionLimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Subscribes an endpoint to an Amazon SNS topic. If the endpoint type is HTTP/S or email, or\n if the endpoint and the topic are not in the same Amazon Web Services account, the endpoint owner must\n run the ConfirmSubscription action to confirm the subscription.

\n

You call the ConfirmSubscription action with the token from the\n subscription response. Confirmation tokens are valid for two days.

\n

This action is throttled at 100 transactions per second (TPS).

" + } + }, + "com.amazonaws.sns#SubscribeInput": { + "type": "structure", + "members": { + "TopicArn": { + "target": "com.amazonaws.sns#topicARN", + "traits": { + "smithy.api#documentation": "

The ARN of the topic you want to subscribe to.

", + "smithy.api#required": {} + } + }, + "Protocol": { + "target": "com.amazonaws.sns#protocol", + "traits": { + "smithy.api#documentation": "

The protocol that you want to use. Supported protocols include:

\n
    \n
  • \n

    \n http – delivery of JSON-encoded message via HTTP\n POST

    \n
    • \n
  • \n

    \n https – delivery of JSON-encoded message via HTTPS\n POST

    \n
    • \n
  • \n

    \n email – delivery of message via SMTP

    \n
    • \n
  • \n

    \n email-json – delivery of JSON-encoded message via\n SMTP

    \n
    • \n
  • \n

    \n sms – delivery of message via SMS

    \n
    • \n
  • \n

    \n sqs – delivery of JSON-encoded message to an Amazon SQS\n queue

    \n
    • \n
  • \n

    \n application – delivery of JSON-encoded message to an\n EndpointArn for a mobile app and device

    \n
    • \n
  • \n

    \n lambda – delivery of JSON-encoded message to an Lambda\n function

    \n
    • \n
  • \n

    \n firehose – delivery of JSON-encoded message to an Amazon\n Kinesis Data Firehose delivery stream.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Endpoint": { + "target": "com.amazonaws.sns#Endpoint2", + "traits": { + "smithy.api#documentation": "

The endpoint that you want to receive notifications. Endpoints vary by\n protocol:

\n
    \n
  • \n

    For the http protocol, the (public) endpoint is a URL beginning\n with http://.

    \n
    • \n
  • \n

    For the https protocol, the (public) endpoint is a URL beginning\n with https://.

    \n
    • \n
  • \n

    For the email protocol, the endpoint is an email address.

    \n
    • \n
  • \n

    For the email-json protocol, the endpoint is an email\n address.

    \n
    • \n
  • \n

    For the sms protocol, the endpoint is a phone number of an\n SMS-enabled device.

    \n
    • \n
  • \n

    For the sqs protocol, the endpoint is the ARN of an Amazon SQS\n queue.

    \n
    • \n
  • \n

    For the application protocol, the endpoint is the EndpointArn of\n a mobile app and device.

    \n
    • \n
  • \n

    For the lambda protocol, the endpoint is the ARN of an Lambda\n function.

    \n
    • \n
  • \n

    For the firehose protocol, the endpoint is the ARN of an Amazon\n Kinesis Data Firehose delivery stream.

    \n
    • \n
" + } + }, + "Attributes": { + "target": "com.amazonaws.sns#SubscriptionAttributesMap", + "traits": { + "smithy.api#documentation": "

A map of attributes with their corresponding values.

\n

The following lists the names, descriptions, and values of the special request\n parameters that the Subscribe action uses:

\n
    \n
  • \n

    \n DeliveryPolicy – The policy that defines how Amazon SNS retries\n failed deliveries to HTTP/S endpoints.

    \n
    • \n
  • \n

    \n FilterPolicy – The simple JSON object that lets your\n subscriber receive only a subset of messages, rather than receiving every\n message published to the topic.

    \n
    • \n
  • \n

    \n FilterPolicyScope – This attribute lets you choose the\n filtering scope by using one of the following string value types:

    \n
      \n
    • \n

      \n MessageAttributes (default) – The filter is\n applied on the message attributes.

      \n
      • \n
    • \n

      \n MessageBody – The filter is applied on the message\n body.

      \n
      • \n
    \n
    • \n
  • \n

    \n RawMessageDelivery – When set to true,\n enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the\n need for the endpoints to process JSON formatting, which is otherwise created\n for Amazon SNS metadata.

    \n
    • \n
  • \n

    \n RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. \n Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable)\n or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held \n in the dead-letter queue for further analysis or reprocessing.

    \n
    • \n
\n

The following attribute applies only to Amazon Data Firehose delivery stream subscriptions:

\n
    \n
  • \n

    \n SubscriptionRoleArn – The ARN of the IAM role that has the following:

    \n
      \n
    • \n

      Permission to write to the Firehose delivery stream

      \n
      • \n
    • \n

      Amazon SNS listed as a trusted entity

      \n
      • \n
    \n

    Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. \n For more information, see Fanout \n to Firehose delivery streams in the Amazon SNS Developer Guide.

    \n
    • \n
\n

The following attributes apply only to FIFO topics:

\n
    \n
  • \n

    \n ReplayPolicy – Adds or updates an inline policy document\n for a subscription to replay messages stored in the specified Amazon SNS\n topic.

    \n
    • \n
  • \n

    \n ReplayStatus – Retrieves the status of the subscription\n message replay, which can be one of the following:

    \n
      \n
    • \n

      \n Completed – The replay has successfully\n redelivered all messages, and is now delivering newly published\n messages. If an ending point was specified in the\n ReplayPolicy then the subscription will no longer\n receive newly published messages.

      \n
      • \n
    • \n

      \n In progress – The replay is currently replaying\n the selected messages.

      \n
      • \n
    • \n

      \n Failed – The replay was unable to complete.

      \n
      • \n
    • \n

      \n Pending – The default state while the replay\n initiates.

      \n
      • \n
    \n
    • \n
" + } + }, + "ReturnSubscriptionArn": { + "target": "com.amazonaws.sns#boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Sets whether the response from the Subscribe request includes the\n subscription ARN, even if the subscription is not yet confirmed.

\n

If you set this parameter to true, the response includes the ARN in all\n cases, even if the subscription is not yet confirmed. In addition to the ARN for\n confirmed subscriptions, the response also includes the pending\n subscription ARN value for subscriptions that aren't yet confirmed. A\n subscription becomes confirmed when the subscriber calls the\n ConfirmSubscription action with a confirmation token.

\n

\n

The default value is false.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Input for Subscribe action.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#SubscribeResponse": { + "type": "structure", + "members": { + "SubscriptionArn": { + "target": "com.amazonaws.sns#subscriptionARN", + "traits": { + "smithy.api#documentation": "

The ARN of the subscription if it is confirmed, or the string \"pending confirmation\"\n if the subscription requires confirmation. However, if the API request parameter\n ReturnSubscriptionArn is true, then the value is always the\n subscription ARN, even if the subscription requires confirmation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Response for Subscribe action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#Subscription": { + "type": "structure", + "members": { + "SubscriptionArn": { + "target": "com.amazonaws.sns#subscriptionARN", + "traits": { + "smithy.api#documentation": "

The subscription's ARN.

" + } + }, + "Owner": { + "target": "com.amazonaws.sns#account", + "traits": { + "smithy.api#documentation": "

The subscription's owner.

" + } + }, + "Protocol": { + "target": "com.amazonaws.sns#protocol", + "traits": { + "smithy.api#documentation": "

The subscription's protocol.

" + } + }, + "Endpoint": { + "target": "com.amazonaws.sns#Endpoint2", + "traits": { + "smithy.api#documentation": "

The subscription's endpoint (format depends on the protocol).

" + } + }, + "TopicArn": { + "target": "com.amazonaws.sns#topicARN", + "traits": { + "smithy.api#documentation": "

The ARN of the subscription's topic.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A wrapper type for the attributes of an Amazon SNS subscription.

" + } + }, + "com.amazonaws.sns#SubscriptionAttributesMap": { + "type": "map", + "key": { + "target": "com.amazonaws.sns#attributeName" + }, + "value": { + "target": "com.amazonaws.sns#attributeValue" + } + }, + "com.amazonaws.sns#SubscriptionLimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SubscriptionLimitExceeded", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "

Indicates that the customer already owns the maximum allowed number of\n subscriptions.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.sns#SubscriptionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.sns#Subscription" + } + }, + "com.amazonaws.sns#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.sns#TagKey", + "traits": { + "smithy.api#documentation": "

The required key portion of the tag.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.sns#TagValue", + "traits": { + "smithy.api#documentation": "

The optional value portion of the tag.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The list of tags to be added to the specified topic.

" + } + }, + "com.amazonaws.sns#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.sns#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.sns#TagKey" + } + }, + "com.amazonaws.sns#TagLimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "TagLimitExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Can't add more than 50 tags to a topic.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sns#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.sns#Tag" + } + }, + "com.amazonaws.sns#TagPolicyException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "TagPolicy", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request doesn't comply with the IAM tag policy. Correct your request and then\n retry it.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sns#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.sns#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#ConcurrentAccessException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.sns#StaleTagException" + }, + { + "target": "com.amazonaws.sns#TagLimitExceededException" + }, + { + "target": "com.amazonaws.sns#TagPolicyException" + } + ], + "traits": { + "smithy.api#documentation": "

Add tags to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the\n Amazon SNS Developer Guide.

\n

When you use topic tags, keep the following guidelines in mind:

\n
    \n
  • \n

    Adding more than 50 tags to a topic isn't recommended.

    \n
    • \n
  • \n

    Tags don't have any semantic meaning. Amazon SNS interprets tags as character\n strings.

    \n
    • \n
  • \n

    Tags are case-sensitive.

    \n
    • \n
  • \n

    A new tag with a key identical to that of an existing tag overwrites the\n existing tag.

    \n
    • \n
  • \n

    Tagging actions are limited to 10 TPS per Amazon Web Services account, per Amazon Web Services Region. If\n your application requires a higher throughput, file a technical support request.

    \n
    • \n
" + } + }, + "com.amazonaws.sns#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.sns#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The ARN of the topic to which to add tags.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sns#TagList", + "traits": { + "smithy.api#documentation": "

The tags to be added to the specified topic. A tag consists of a required key and an\n optional value.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.sns#ThrottledException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

Throttled request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "Throttled", + "httpResponseCode": 429 + }, + "smithy.api#documentation": "

Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.sns#Timestamp": { + "type": "timestamp" + }, + "com.amazonaws.sns#TooManyEntriesInBatchRequestException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "TooManyEntriesInBatchRequest", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The batch request contains more entries than permissible.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sns#Topic": { + "type": "structure", + "members": { + "TopicArn": { + "target": "com.amazonaws.sns#topicARN", + "traits": { + "smithy.api#documentation": "

The topic's ARN.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A wrapper type for the topic's Amazon Resource Name (ARN). To retrieve a topic's\n attributes, use GetTopicAttributes.

" + } + }, + "com.amazonaws.sns#TopicAttributesMap": { + "type": "map", + "key": { + "target": "com.amazonaws.sns#attributeName" + }, + "value": { + "target": "com.amazonaws.sns#attributeValue" + } + }, + "com.amazonaws.sns#TopicLimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "TopicLimitExceeded", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "

Indicates that the customer already owns the maximum allowed number of topics.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.sns#TopicsList": { + "type": "list", + "member": { + "target": "com.amazonaws.sns#Topic" + } + }, + "com.amazonaws.sns#Unsubscribe": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#UnsubscribeInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#InvalidSecurityException" + }, + { + "target": "com.amazonaws.sns#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a subscription. If the subscription requires authentication for deletion, only\n the owner of the subscription or the topic's owner can unsubscribe, and an Amazon Web Services\n signature is required. If the Unsubscribe call does not require\n authentication and the requester is not the subscription owner, a final cancellation\n message is delivered to the endpoint, so that the endpoint owner can easily resubscribe\n to the topic if the Unsubscribe request was unintended.

\n \n

Amazon SQS queue subscriptions require authentication for deletion. Only the owner of\n the subscription, or the owner of the topic can unsubscribe using the required Amazon Web Services\n signature.

\n \n

This action is throttled at 100 transactions per second (TPS).

" + } + }, + "com.amazonaws.sns#UnsubscribeInput": { + "type": "structure", + "members": { + "SubscriptionArn": { + "target": "com.amazonaws.sns#subscriptionARN", + "traits": { + "smithy.api#documentation": "

The ARN of the subscription to be deleted.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Input for Unsubscribe action.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.sns#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#ConcurrentAccessException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.sns#StaleTagException" + }, + { + "target": "com.amazonaws.sns#TagLimitExceededException" + }, + { + "target": "com.amazonaws.sns#TagPolicyException" + } + ], + "traits": { + "smithy.api#documentation": "

Remove tags from the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the\n Amazon SNS Developer Guide.

" + } + }, + "com.amazonaws.sns#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.sns#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The ARN of the topic from which to remove tags.

", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.sns#TagKeyList", + "traits": { + "smithy.api#documentation": "

The list of tag keys to remove from the specified topic.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#UserErrorException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "UserError", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Indicates that a request parameter does not comply with the associated\n constraints.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sns#ValidationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ValidationException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Indicates that a parameter in the request is invalid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sns#VerificationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

The status of the verification error.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Indicates that the one-time password (OTP) used for verification is invalid.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.sns#VerifySMSSandboxPhoneNumber": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#VerifySMSSandboxPhoneNumberInput" + }, + "output": { + "target": "com.amazonaws.sns#VerifySMSSandboxPhoneNumberResult" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.sns#ThrottledException" + }, + { + "target": "com.amazonaws.sns#VerificationException" + } + ], + "traits": { + "smithy.api#documentation": "

Verifies a destination phone number with a one-time password (OTP) for the calling\n Amazon Web Services account.

\n

When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the\n SMS sandbox. The SMS sandbox provides a safe environment for \n you to try Amazon SNS features without risking your reputation as an SMS sender. While your \n Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send \n SMS messages only to verified destination phone numbers. For more information, including how to \n move out of the sandbox to send messages without restrictions, \n see SMS sandbox in \n the Amazon SNS Developer Guide.

" + } + }, + "com.amazonaws.sns#VerifySMSSandboxPhoneNumberInput": { + "type": "structure", + "members": { + "PhoneNumber": { + "target": "com.amazonaws.sns#PhoneNumberString", + "traits": { + "smithy.api#documentation": "

The destination phone number to verify.

", + "smithy.api#required": {} + } + }, + "OneTimePassword": { + "target": "com.amazonaws.sns#OTPCode", + "traits": { + "smithy.api#documentation": "

The OTP sent to the destination number from the\n CreateSMSSandBoxPhoneNumber call.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#VerifySMSSandboxPhoneNumberResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

The destination phone number's verification status.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#account": { + "type": "string" + }, + "com.amazonaws.sns#action": { + "type": "string" + }, + "com.amazonaws.sns#attributeName": { + "type": "string" + }, + "com.amazonaws.sns#attributeValue": { + "type": "string" + }, + "com.amazonaws.sns#authenticateOnUnsubscribe": { + "type": "string" + }, + "com.amazonaws.sns#boolean": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.sns#delegate": { + "type": "string" + }, + "com.amazonaws.sns#label": { + "type": "string" + }, + "com.amazonaws.sns#message": { + "type": "string" + }, + "com.amazonaws.sns#messageId": { + "type": "string" + }, + "com.amazonaws.sns#messageStructure": { + "type": "string" + }, + "com.amazonaws.sns#nextToken": { + "type": "string" + }, + "com.amazonaws.sns#protocol": { + "type": "string" + }, + "com.amazonaws.sns#subject": { + "type": "string" + }, + "com.amazonaws.sns#subscriptionARN": { + "type": "string" + }, + "com.amazonaws.sns#token": { + "type": "string" + }, + "com.amazonaws.sns#topicARN": { + "type": "string" + }, + "com.amazonaws.sns#topicName": { + "type": "string" + } + } +} \ No newline at end of file diff --git a/pkg/testdata/codegen/sdk-codegen/aws-models/sqs.json b/pkg/testdata/codegen/sdk-codegen/aws-models/sqs.json new file mode 100644 index 00000000..93f9b5e0 --- /dev/null +++ b/pkg/testdata/codegen/sdk-codegen/aws-models/sqs.json @@ -0,0 +1,4193 @@ +{ + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.sqs#AWSAccountIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#String" + } + }, + "com.amazonaws.sqs#ActionNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#String" + } + }, + "com.amazonaws.sqs#AddPermission": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#AddPermissionRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#OverLimit" + }, + { + "target": "com.amazonaws.sqs#QueueDoesNotExist" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "

Adds a permission to a queue for a specific principal. This allows sharing\n access to the queue.

\n

When you create a queue, you have full control access rights for the queue. Only you,\n the owner of the queue, can grant or deny permissions to the queue. For more information\n about these permissions, see Allow Developers to Write Messages to a Shared Queue in the Amazon SQS\n Developer Guide.

\n \n
    \n
  • \n

    \n AddPermission generates a policy for you. You can use\n \n SetQueueAttributes\n to upload your\n policy. For more information, see Using Custom Policies with the Amazon SQS Access Policy Language in\n the Amazon SQS Developer Guide.

    \n
    • \n
  • \n

    An Amazon SQS policy can have a maximum of seven actions per statement.

    \n
    • \n
  • \n

    To remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.

    \n
    • \n
  • \n

    Amazon SQS AddPermission does not support adding a non-account\n principal.

    \n
    • \n
\n \n \n

Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.

\n " + } + }, + "com.amazonaws.sqs#AddPermissionRequest": { + "type": "structure", + "members": { + "QueueUrl": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The URL of the Amazon SQS queue to which permissions are added.

\n

Queue URLs and names are case-sensitive.

", + "smithy.api#required": {} + } + }, + "Label": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The unique identification of the permission you're setting (for example,\n AliceSendMessage). Maximum 80 characters. Allowed characters include\n alphanumeric characters, hyphens (-), and underscores\n (_).

", + "smithy.api#required": {} + } + }, + "AWSAccountIds": { + "target": "com.amazonaws.sqs#AWSAccountIdList", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account numbers of the principals who are to receive\n permission. For information about locating the Amazon Web Services account identification, see Your Amazon Web Services Identifiers in the Amazon SQS Developer\n Guide.

", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "AWSAccountId" + } + }, + "Actions": { + "target": "com.amazonaws.sqs#ActionNameList", + "traits": { + "smithy.api#documentation": "

The action the client wants to allow for the specified principal. Valid values: the\n name of any action or *.

\n

For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service\n Resource in the Amazon SQS Developer Guide.

\n

Specifying SendMessage, DeleteMessage, or\n ChangeMessageVisibility for ActionName.n also grants\n permissions for the corresponding batch versions of those actions:\n SendMessageBatch, DeleteMessageBatch, and\n ChangeMessageVisibilityBatch.

", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "ActionName" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#AmazonSQS": { + "type": "service", + "version": "2012-11-05", + "operations": [ + { + "target": "com.amazonaws.sqs#AddPermission" + }, + { + "target": "com.amazonaws.sqs#CancelMessageMoveTask" + }, + { + "target": "com.amazonaws.sqs#ChangeMessageVisibility" + }, + { + "target": "com.amazonaws.sqs#ChangeMessageVisibilityBatch" + }, + { + "target": "com.amazonaws.sqs#CreateQueue" + }, + { + "target": "com.amazonaws.sqs#DeleteMessage" + }, + { + "target": "com.amazonaws.sqs#DeleteMessageBatch" + }, + { + "target": "com.amazonaws.sqs#DeleteQueue" + }, + { + "target": "com.amazonaws.sqs#GetQueueAttributes" + }, + { + "target": "com.amazonaws.sqs#GetQueueUrl" + }, + { + "target": "com.amazonaws.sqs#ListDeadLetterSourceQueues" + }, + { + "target": "com.amazonaws.sqs#ListMessageMoveTasks" + }, + { + "target": "com.amazonaws.sqs#ListQueues" + }, + { + "target": "com.amazonaws.sqs#ListQueueTags" + }, + { + "target": "com.amazonaws.sqs#PurgeQueue" + }, + { + "target": "com.amazonaws.sqs#ReceiveMessage" + }, + { + "target": "com.amazonaws.sqs#RemovePermission" + }, + { + "target": "com.amazonaws.sqs#SendMessage" + }, + { + "target": "com.amazonaws.sqs#SendMessageBatch" + }, + { + "target": "com.amazonaws.sqs#SetQueueAttributes" + }, + { + "target": "com.amazonaws.sqs#StartMessageMoveTask" + }, + { + "target": "com.amazonaws.sqs#TagQueue" + }, + { + "target": "com.amazonaws.sqs#UntagQueue" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "SQS", + "arnNamespace": "sqs", + "cloudFormationName": "SQS", + "cloudTrailEventSource": "sqs.amazonaws.com", + "endpointPrefix": "sqs" + }, + "aws.auth#sigv4": { + "name": "sqs" + }, + "aws.protocols#awsJson1_0": {}, + "aws.protocols#awsQueryCompatible": {}, + "smithy.api#documentation": "

Welcome to the Amazon SQS API Reference.

\n

Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel\n between applications or microservices. Amazon SQS moves data between distributed application\n components and helps you decouple these components.

\n

For information on the permissions you need to use this API, see Identity and access management in the Amazon SQS Developer\n Guide.\n

\n

You can use Amazon Web Services SDKs to access\n Amazon SQS using your favorite programming language. The SDKs perform tasks such as the\n following automatically:

\n
    \n
  • \n

    Cryptographically sign your service requests

    \n
    • \n
  • \n

    Retry requests

    \n
    • \n
  • \n

    Handle error responses

    \n
    • \n
\n

\n Additional information\n

\n ", + "smithy.api#title": "Amazon Simple Queue Service", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://sqs-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-us-gov" + ] + } + ], + "endpoint": { + "url": "https://sqs.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://sqs-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://sqs.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://sqs.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.af-south-1.amazonaws.com" + } + }, + "params": { + "Region": "af-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.ap-east-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.ap-south-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.eu-north-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.eu-south-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.eu-west-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.eu-west-3.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.me-south-1.amazonaws.com" + } + }, + "params": { + "Region": "me-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.sa-east-1.amazonaws.com" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://sqs-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://sqs.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://sqs-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://sqs.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://sqs-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://sqs.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.us-iso-west-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.sqs#AttributeNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#QueueAttributeName" + } + }, + "com.amazonaws.sqs#BatchEntryIdsNotDistinct": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AWS.SimpleQueueService.BatchEntryIdsNotDistinct", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Two or more batch entries in the request have the same Id.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sqs#BatchRequestTooLong": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AWS.SimpleQueueService.BatchRequestTooLong", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The length of all the messages put together is more than the limit.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sqs#BatchResultErrorEntry": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The Id of an entry in a batch request.

", + "smithy.api#required": {} + } + }, + "SenderFault": { + "target": "com.amazonaws.sqs#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether the error happened due to the caller of the batch API action.

", + "smithy.api#required": {} + } + }, + "Code": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

An error code representing why the action failed on this entry.

", + "smithy.api#required": {} + } + }, + "Message": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

A message explaining why the action failed on this entry.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Gives a detailed description of the result of an action on each entry in the\n request.

" + } + }, + "com.amazonaws.sqs#BatchResultErrorEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#BatchResultErrorEntry" + } + }, + "com.amazonaws.sqs#Binary": { + "type": "blob" + }, + "com.amazonaws.sqs#BinaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#Binary", + "traits": { + "smithy.api#xmlName": "BinaryListValue" + } + } + }, + "com.amazonaws.sqs#Boolean": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.sqs#BoxedInteger": { + "type": "integer" + }, + "com.amazonaws.sqs#CancelMessageMoveTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#CancelMessageMoveTaskRequest" + }, + "output": { + "target": "com.amazonaws.sqs#CancelMessageMoveTaskResult" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "

Cancels a specified message movement task. A message movement can only be cancelled\n when the current status is RUNNING. Cancelling a message movement task does not revert\n the messages that have already been moved. It can only stop the messages that have not\n been moved yet.

\n \n
    \n
  • \n

    This action is currently limited to supporting message redrive from dead-letter queues (DLQs) only. In this context, the source\n queue is the dead-letter queue (DLQ), while the destination queue can be the\n original source queue (from which the messages were driven to the\n dead-letter-queue), or a custom destination queue.

    \n
    • \n
  • \n

    Only one active message movement task is supported per queue at any given\n time.

    \n
    • \n
\n " + } + }, + "com.amazonaws.sqs#CancelMessageMoveTaskRequest": { + "type": "structure", + "members": { + "TaskHandle": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

An identifier associated with a message movement task.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#CancelMessageMoveTaskResult": { + "type": "structure", + "members": { + "ApproximateNumberOfMessagesMoved": { + "target": "com.amazonaws.sqs#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The approximate number of messages already moved to the destination queue.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sqs#ChangeMessageVisibility": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#ChangeMessageVisibilityRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#MessageNotInflight" + }, + { + "target": "com.amazonaws.sqs#QueueDoesNotExist" + }, + { + "target": "com.amazonaws.sqs#ReceiptHandleIsInvalid" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "

Changes the visibility timeout of a specified message in a queue to a new value. The\n default visibility timeout for a message is 30 seconds. The minimum is 0 seconds. The\n maximum is 12 hours. For more information, see Visibility Timeout in the Amazon SQS Developer\n Guide.

\n

For example, if the default timeout for a queue is 60 seconds, 15 seconds have elapsed\n since you received the message, and you send a ChangeMessageVisibility call with\n VisibilityTimeout set to 10 seconds, the 10 seconds begin to count from\n the time that you make the ChangeMessageVisibility call. Thus, any attempt\n to change the visibility timeout or to delete that message 10 seconds after you\n initially change the visibility timeout (a total of 25 seconds) might result in an\n error.

\n

An Amazon SQS message has three basic states:

\n
    \n
  1. \n

    Sent to a queue by a producer.

    \n
    2. \n
  2. \n

    Received from the queue by a consumer.

    \n
    3. \n
  3. \n

    Deleted from the queue.

    \n
    4. \n
\n

A message is considered to be stored after it is sent to a queue by a producer, but not yet received from the queue by a consumer (that is, between states 1 and 2). There is no limit to the number of stored messages.\n A message is considered to be in flight after it is received from a queue by a consumer, but not yet deleted from the queue (that is, between states 2 and 3). There is a limit to the number of in flight messages.

\n

Limits that apply to in flight messages are unrelated to the unlimited number of stored messages.

\n

For most standard queues (depending on queue traffic and message backlog), there can be a maximum of approximately 120,000 in flight messages (received from a queue by a consumer, but not yet deleted from the queue). \n If you reach this limit, Amazon SQS returns the OverLimit error message.\n To avoid reaching the limit, you should delete messages from the queue after they're processed. You can also increase the number of queues you use to process your messages.\n To request a limit increase, file a support request.

\n

For FIFO queues, there can be a maximum of 120,000 in flight messages (received from a queue by a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS returns no error messages.

\n \n

If you attempt to set the VisibilityTimeout to a value greater than\n the maximum time left, Amazon SQS returns an error. Amazon SQS doesn't automatically\n recalculate and increase the timeout to the maximum remaining time.

\n

Unlike with a queue, when you change the visibility timeout for a specific message\n the timeout value is applied immediately but isn't saved in memory for that message.\n If you don't delete a message after it is received, the visibility timeout for the\n message reverts to the original timeout value (not to the value you set using the\n ChangeMessageVisibility action) the next time the message is\n received.

\n " + } + }, + "com.amazonaws.sqs#ChangeMessageVisibilityBatch": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#ChangeMessageVisibilityBatchRequest" + }, + "output": { + "target": "com.amazonaws.sqs#ChangeMessageVisibilityBatchResult" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#BatchEntryIdsNotDistinct" + }, + { + "target": "com.amazonaws.sqs#EmptyBatchRequest" + }, + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidBatchEntryId" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#QueueDoesNotExist" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#TooManyEntriesInBatchRequest" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "

Changes the visibility timeout of multiple messages. This is a batch version of\n \n ChangeMessageVisibility. The result of the action\n on each message is reported individually in the response. You can send up to 10\n \n ChangeMessageVisibility\n requests with each\n ChangeMessageVisibilityBatch action.

\n \n

Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

\n " + } + }, + "com.amazonaws.sqs#ChangeMessageVisibilityBatchRequest": { + "type": "structure", + "members": { + "QueueUrl": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The URL of the Amazon SQS queue whose messages' visibility is changed.

\n

Queue URLs and names are case-sensitive.

", + "smithy.api#required": {} + } + }, + "Entries": { + "target": "com.amazonaws.sqs#ChangeMessageVisibilityBatchRequestEntryList", + "traits": { + "smithy.api#documentation": "

Lists the receipt handles of the messages for which the visibility timeout must be\n changed.

", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "ChangeMessageVisibilityBatchRequestEntry" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#ChangeMessageVisibilityBatchRequestEntry": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

An identifier for this particular receipt handle used to communicate the\n result.

\n \n

The Ids of a batch request need to be unique within a request.

\n

This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).

\n ", + "smithy.api#required": {} + } + }, + "ReceiptHandle": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

A receipt handle.

", + "smithy.api#required": {} + } + }, + "VisibilityTimeout": { + "target": "com.amazonaws.sqs#NullableInteger", + "traits": { + "smithy.api#documentation": "

The new value (in seconds) for the message's visibility timeout.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Encloses a receipt handle and an entry ID for each message in \n ChangeMessageVisibilityBatch.\n

" + } + }, + "com.amazonaws.sqs#ChangeMessageVisibilityBatchRequestEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#ChangeMessageVisibilityBatchRequestEntry" + } + }, + "com.amazonaws.sqs#ChangeMessageVisibilityBatchResult": { + "type": "structure", + "members": { + "Successful": { + "target": "com.amazonaws.sqs#ChangeMessageVisibilityBatchResultEntryList", + "traits": { + "smithy.api#documentation": "

A list of \n ChangeMessageVisibilityBatchResultEntry\n \n items.

", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "ChangeMessageVisibilityBatchResultEntry" + } + }, + "Failed": { + "target": "com.amazonaws.sqs#BatchResultErrorEntryList", + "traits": { + "smithy.api#documentation": "

A list of \n BatchResultErrorEntry\n items.

", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "BatchResultErrorEntry" + } + } + }, + "traits": { + "smithy.api#documentation": "

For each message in the batch, the response contains a \n ChangeMessageVisibilityBatchResultEntry\n tag if the message\n succeeds or a \n BatchResultErrorEntry\n tag if the message\n fails.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.sqs#ChangeMessageVisibilityBatchResultEntry": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

Represents a message whose visibility timeout has been changed successfully.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Encloses the Id of an entry in \n ChangeMessageVisibilityBatch.\n

" + } + }, + "com.amazonaws.sqs#ChangeMessageVisibilityBatchResultEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#ChangeMessageVisibilityBatchResultEntry" + } + }, + "com.amazonaws.sqs#ChangeMessageVisibilityRequest": { + "type": "structure", + "members": { + "QueueUrl": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The URL of the Amazon SQS queue whose message's visibility is changed.

\n

Queue URLs and names are case-sensitive.

", + "smithy.api#required": {} + } + }, + "ReceiptHandle": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The receipt handle associated with the message, whose visibility timeout is changed.\n This parameter is returned by the \n ReceiveMessage\n \n action.

", + "smithy.api#required": {} + } + }, + "VisibilityTimeout": { + "target": "com.amazonaws.sqs#NullableInteger", + "traits": { + "smithy.api#documentation": "

The new value for the message's visibility timeout (in seconds). Values range:\n 0 to 43200. Maximum: 12 hours.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#CreateQueue": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#CreateQueueRequest" + }, + "output": { + "target": "com.amazonaws.sqs#CreateQueueResult" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidAttributeName" + }, + { + "target": "com.amazonaws.sqs#InvalidAttributeValue" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#QueueDeletedRecently" + }, + { + "target": "com.amazonaws.sqs#QueueNameExists" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new standard or FIFO queue. You can pass one or more attributes in\n the request. Keep the following in mind:

\n
    \n
  • \n

    If you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue.

    \n \n

    You can't change the queue type after you create it and you can't convert\n an existing standard queue into a FIFO queue. You must either create a new\n FIFO queue for your application or delete your existing standard queue and\n recreate it as a FIFO queue. For more information, see Moving From a Standard Queue to a FIFO Queue in the\n Amazon SQS Developer Guide.

    \n     \n
    • \n
  • \n

    If you don't provide a value for an attribute, the queue is created with the\n default value for the attribute.

    \n
    • \n
  • \n

    If you delete a queue, you must wait at least 60 seconds before creating a\n queue with the same name.

    \n
    • \n
\n

To successfully create a new queue, you must provide a queue name that adheres to the\n limits\n related to queues and is unique within the scope of your queues.

\n \n

After you create a queue, you must wait at least one second after the queue is\n created to be able to use the queue.

\n \n

To retrieve the URL of a queue, use the \n GetQueueUrl\n action. This action only requires the \n QueueName\n parameter.

\n

When creating queues, keep the following points in mind:

\n
    \n
  • \n

    If you specify the name of an existing queue and provide the exact same names\n and values for all its attributes, the \n CreateQueue\n action will return the URL of the\n existing queue instead of creating a new one.

    \n
    • \n
  • \n

    If you attempt to create a queue with a name that already exists but with\n different attribute names or values, the CreateQueue action will\n return an error. This ensures that existing queues are not inadvertently\n altered.

    \n
    • \n
\n \n

Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.

\n " + } + }, + "com.amazonaws.sqs#CreateQueueRequest": { + "type": "structure", + "members": { + "QueueName": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The name of the new queue. The following limits apply to this name:

\n
    \n
  • \n

    A queue name can have up to 80 characters.

    \n
    • \n
  • \n

    Valid values: alphanumeric characters, hyphens (-), and\n underscores (_).

    \n
    • \n
  • \n

    A FIFO queue name must end with the .fifo suffix.

    \n
    • \n
\n

Queue URLs and names are case-sensitive.

", + "smithy.api#required": {} + } + }, + "Attributes": { + "target": "com.amazonaws.sqs#QueueAttributeMap", + "traits": { + "smithy.api#documentation": "

A map of attributes with their corresponding values.

\n

The following lists the names, descriptions, and values of the special request\n parameters that the CreateQueue action uses:

\n
    \n
  • \n

    \n DelaySeconds – The length of time, in seconds, for which the\n delivery of all messages in the queue is delayed. Valid values: An integer from\n 0 to 900 seconds (15 minutes). Default: 0.

    \n
    • \n
  • \n

    \n MaximumMessageSize – The limit of how many bytes a message\n can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes\n (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).

    \n
    • \n
  • \n

    \n MessageRetentionPeriod – The length of time, in seconds, for\n which Amazon SQS retains a message. Valid values: An integer from 60 seconds (1\n minute) to 1,209,600 seconds (14 days). Default: 345,600 (4 days). When you\n change a queue's attributes, the change can take up to 60 seconds for most of\n the attributes to propagate throughout the Amazon SQS system. Changes made to the\n MessageRetentionPeriod attribute can take up to 15 minutes and\n will impact existing messages in the queue potentially causing them to be\n expired and deleted if the MessageRetentionPeriod is reduced below\n the age of existing messages.

    \n
    • \n
  • \n

    \n Policy – The queue's policy. A valid Amazon Web Services policy. For more\n information about policy structure, see Overview of Amazon Web Services IAM\n Policies in the IAM User Guide.

    \n
    • \n
  • \n

    \n ReceiveMessageWaitTimeSeconds – The length of time, in\n seconds, for which a \n ReceiveMessage\n action waits\n for a message to arrive. Valid values: An integer from 0 to 20 (seconds).\n Default: 0.

    \n
    • \n
  • \n

    \n VisibilityTimeout – The visibility timeout for the queue, in\n seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For\n more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer\n Guide.

    \n
    • \n
\n

The following attributes apply only to dead-letter queues:\n

\n
    \n
  • \n

    \n RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality \n of the source queue as a JSON object. The parameters are as follows:

    \n
      \n
    • \n

      \n deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to \n which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.

      \n
      • \n
    • \n

      \n maxReceiveCount – The number of times a message is delivered to the source queue before being \n moved to the dead-letter queue. Default: 10. When the ReceiveCount for a message exceeds the maxReceiveCount \n for a queue, Amazon SQS moves the message to the dead-letter-queue.

      \n
      • \n
    \n
    • \n
  • \n

    \n RedriveAllowPolicy – The string that includes the parameters for the permissions for the dead-letter\n queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:

    \n
      \n
    • \n

      \n redrivePermission – The permission type that defines which source queues can \n specify the current queue as the dead-letter queue. Valid values are:

      \n
        \n
      • \n

        \n allowAll – (Default) Any source queues in this Amazon Web Services account in the same Region can \n specify this queue as the dead-letter queue.

        \n
        • \n
      • \n

        \n denyAll – No source queues can specify this queue as the dead-letter\n queue.

        \n
        • \n
      • \n

        \n byQueue – Only queues specified by the sourceQueueArns parameter can specify \n this queue as the dead-letter queue.

        \n
        • \n
      \n
      • \n
    • \n

      \n sourceQueueArns – The Amazon Resource Names (ARN)s of the source queues that can specify \n this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the \n redrivePermission parameter is set to byQueue. You can specify up to 10 source queue ARNs. \n To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission parameter\n to allowAll.

      \n
      • \n
    \n
    • \n
\n \n

The dead-letter queue of a \n FIFO queue must also be a FIFO queue. Similarly, the dead-letter \n queue of a standard queue must also be a standard queue.

\n \n

The following attributes apply only to server-side-encryption:

\n
    \n
  • \n

    \n KmsMasterKeyId – The ID of an Amazon Web Services managed customer master\n key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms. While the alias of the Amazon Web Services managed CMK for Amazon SQS is\n always alias/aws/sqs, the alias of a custom CMK can, for example,\n be alias/MyAlias\n . For more examples, see\n KeyId in the Key Management Service API\n Reference.

    \n
    • \n
  • \n

    \n KmsDataKeyReusePeriodSeconds – The length of time, in\n seconds, for which Amazon SQS can reuse a data key to\n encrypt or decrypt messages before calling KMS again. An integer\n representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24\n hours). Default: 300 (5 minutes). A shorter time period provides better security\n but results in more calls to KMS which might incur charges after Free Tier. For\n more information, see How Does the Data Key Reuse Period Work?\n

    \n
    • \n
  • \n

    \n SqsManagedSseEnabled – Enables server-side queue encryption\n using SQS owned encryption keys. Only one server-side encryption option is\n supported per queue (for example, SSE-KMS or SSE-SQS).

    \n
    • \n
\n

The following attributes apply only to FIFO (first-in-first-out)\n queues:

\n
    \n
  • \n

    \n FifoQueue – Designates a queue as FIFO. Valid values are\n true and false. If you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue. You\n can provide this attribute only during queue creation. You can't change it for\n an existing queue. When you set this attribute, you must also provide the\n MessageGroupId for your messages explicitly.

    \n

    For more information, see FIFO queue logic in the Amazon SQS Developer\n Guide.

    \n
    • \n
  • \n

    \n ContentBasedDeduplication – Enables content-based\n deduplication. Valid values are true and false. For\n more information, see Exactly-once processing in the Amazon SQS Developer\n Guide. Note the following:

    \n
      \n
    • \n

      Every message must have a unique\n MessageDeduplicationId.

      \n
        \n
      • \n

        You may provide a MessageDeduplicationId\n explicitly.

        \n
        • \n
      • \n

        If you aren't able to provide a\n MessageDeduplicationId and you enable\n ContentBasedDeduplication for your queue, Amazon SQS\n uses a SHA-256 hash to generate the\n MessageDeduplicationId using the body of the\n message (but not the attributes of the message).

        \n
        • \n
      • \n

        If you don't provide a MessageDeduplicationId and\n the queue doesn't have ContentBasedDeduplication\n set, the action fails with an error.

        \n
        • \n
      • \n

        If the queue has ContentBasedDeduplication set,\n your MessageDeduplicationId overrides the generated\n one.

        \n
        • \n
      \n
      • \n
    • \n

      When ContentBasedDeduplication is in effect, messages\n with identical content sent within the deduplication interval are\n treated as duplicates and only one copy of the message is\n delivered.

      \n
      • \n
    • \n

      If you send one message with ContentBasedDeduplication\n enabled and then another message with a\n MessageDeduplicationId that is the same as the one\n generated for the first MessageDeduplicationId, the two\n messages are treated as duplicates and only one copy of the message is\n delivered.

      \n
      • \n
    \n
    • \n
\n

The following attributes apply only to \nhigh throughput\nfor FIFO queues:

\n
    \n
  • \n

    \n DeduplicationScope – Specifies whether message deduplication occurs at the \n message group or queue level. Valid values are messageGroup and queue.

    \n
    • \n
  • \n

    \n FifoThroughputLimit – Specifies whether the FIFO queue throughput \n quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. \n The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup.

    \n
    • \n
\n

To enable high throughput for FIFO queues, do the following:

\n
    \n
  • \n

    Set DeduplicationScope to messageGroup.

    \n
    • \n
  • \n

    Set FifoThroughputLimit to perMessageGroupId.

    \n
    • \n
\n

If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified.

\n

For information on throughput quotas, \n see Quotas related to messages \n in the Amazon SQS Developer Guide.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Attribute" + } + }, + "tags": { + "target": "com.amazonaws.sqs#TagMap", + "traits": { + "smithy.api#documentation": "

Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging \nYour Amazon SQS Queues in the Amazon SQS Developer Guide.

\n

When you use queue tags, keep the following guidelines in mind:

\n
    \n
  • \n

    Adding more than 50 tags to a queue isn't recommended.

    \n
    • \n
  • \n

    Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings.

    \n
    • \n
  • \n

    Tags are case-sensitive.

    \n
    • \n
  • \n

    A new tag with a key identical to that of an existing tag overwrites the existing tag.

    \n
    • \n
\n

For a full list of tag restrictions, see \nQuotas related to queues \nin the Amazon SQS Developer Guide.

\n \n

To be able to tag a queue on creation, you must have the\n sqs:CreateQueue and sqs:TagQueue permissions.

\n

Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.

\n ", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Tag" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#CreateQueueResult": { + "type": "structure", + "members": { + "QueueUrl": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The URL of the created Amazon SQS queue.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Returns the QueueUrl attribute of the created queue.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.sqs#DeleteMessage": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#DeleteMessageRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidIdFormat" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#QueueDoesNotExist" + }, + { + "target": "com.amazonaws.sqs#ReceiptHandleIsInvalid" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified message from the specified queue. To select the message to\n delete, use the ReceiptHandle of the message (not the\n MessageId which you receive when you send the message). Amazon SQS can\n delete a message from a queue even if a visibility timeout setting causes the message to\n be locked by another consumer. Amazon SQS automatically deletes messages left in a queue\n longer than the retention period configured for the queue.

\n \n

Each time you receive a message, meaning when a consumer retrieves a message from\n the queue, it comes with a unique ReceiptHandle. If you receive the\n same message more than once, you will get a different ReceiptHandle\n each time. When you want to delete a message using the DeleteMessage\n action, you must use the ReceiptHandle from the most recent time you\n received the message. If you use an old ReceiptHandle, the request will\n succeed, but the message might not be deleted.

\n

For standard queues, it is possible to receive a message even after you\n delete it. This might happen on rare occasions if one of the servers which stores a\n copy of the message is unavailable when you send the request to delete the message.\n The copy remains on the server and might be returned to you during a subsequent\n receive request. You should ensure that your application is idempotent, so that\n receiving a message more than once does not cause issues.

\n " + } + }, + "com.amazonaws.sqs#DeleteMessageBatch": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#DeleteMessageBatchRequest" + }, + "output": { + "target": "com.amazonaws.sqs#DeleteMessageBatchResult" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#BatchEntryIdsNotDistinct" + }, + { + "target": "com.amazonaws.sqs#EmptyBatchRequest" + }, + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidBatchEntryId" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#QueueDoesNotExist" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#TooManyEntriesInBatchRequest" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes up to ten messages from the specified queue. This is a batch version of\n \n DeleteMessage. The result of the action on each\n message is reported individually in the response.

\n \n

Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

\n " + } + }, + "com.amazonaws.sqs#DeleteMessageBatchRequest": { + "type": "structure", + "members": { + "QueueUrl": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The URL of the Amazon SQS queue from which messages are deleted.

\n

Queue URLs and names are case-sensitive.

", + "smithy.api#required": {} + } + }, + "Entries": { + "target": "com.amazonaws.sqs#DeleteMessageBatchRequestEntryList", + "traits": { + "smithy.api#documentation": "

Lists the receipt handles for the messages to be deleted.

", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "DeleteMessageBatchRequestEntry" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#DeleteMessageBatchRequestEntry": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The identifier for this particular receipt handle. This is used to communicate the\n result.

\n \n

The Ids of a batch request need to be unique within a request.

\n

This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).

\n ", + "smithy.api#required": {} + } + }, + "ReceiptHandle": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

A receipt handle.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Encloses a receipt handle and an identifier for it.

" + } + }, + "com.amazonaws.sqs#DeleteMessageBatchRequestEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#DeleteMessageBatchRequestEntry" + } + }, + "com.amazonaws.sqs#DeleteMessageBatchResult": { + "type": "structure", + "members": { + "Successful": { + "target": "com.amazonaws.sqs#DeleteMessageBatchResultEntryList", + "traits": { + "smithy.api#documentation": "

A list of \n DeleteMessageBatchResultEntry\n items.

", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "DeleteMessageBatchResultEntry" + } + }, + "Failed": { + "target": "com.amazonaws.sqs#BatchResultErrorEntryList", + "traits": { + "smithy.api#documentation": "

A list of \n BatchResultErrorEntry\n items.

", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "BatchResultErrorEntry" + } + } + }, + "traits": { + "smithy.api#documentation": "

For each message in the batch, the response contains a \n DeleteMessageBatchResultEntry\n tag if the message is deleted\n or a \n BatchResultErrorEntry\n tag if the message can't be\n deleted.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.sqs#DeleteMessageBatchResultEntry": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

Represents a successfully deleted message.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Encloses the Id of an entry in \n DeleteMessageBatch.\n

" + } + }, + "com.amazonaws.sqs#DeleteMessageBatchResultEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#DeleteMessageBatchResultEntry" + } + }, + "com.amazonaws.sqs#DeleteMessageRequest": { + "type": "structure", + "members": { + "QueueUrl": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The URL of the Amazon SQS queue from which messages are deleted.

\n

Queue URLs and names are case-sensitive.

", + "smithy.api#required": {} + } + }, + "ReceiptHandle": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The receipt handle associated with the message to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#DeleteQueue": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#DeleteQueueRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#QueueDoesNotExist" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the queue specified by the QueueUrl, regardless of the queue's\n contents.

\n \n

Be careful with the DeleteQueue action: When you delete a queue, any\n messages in the queue are no longer available.

\n \n

When you delete a queue, the deletion process takes up to 60 seconds. Requests you\n send involving that queue during the 60 seconds might succeed. For example, a\n \n SendMessage\n request might succeed, but after 60\n seconds the queue and the message you sent no longer exist.

\n

When you delete a queue, you must wait at least 60 seconds before creating a queue\n with the same name.

\n \n

Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.

\n

The delete operation uses the HTTP GET verb.

\n " + } + }, + "com.amazonaws.sqs#DeleteQueueRequest": { + "type": "structure", + "members": { + "QueueUrl": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The URL of the Amazon SQS queue to delete.

\n

Queue URLs and names are case-sensitive.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#EmptyBatchRequest": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AWS.SimpleQueueService.EmptyBatchRequest", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The batch request doesn't contain any entries.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sqs#ExceptionMessage": { + "type": "string" + }, + "com.amazonaws.sqs#GetQueueAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#GetQueueAttributesRequest" + }, + "output": { + "target": "com.amazonaws.sqs#GetQueueAttributesResult" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidAttributeName" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#QueueDoesNotExist" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "

Gets attributes for the specified queue.

\n \n

To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.

\n " + } + }, + "com.amazonaws.sqs#GetQueueAttributesRequest": { + "type": "structure", + "members": { + "QueueUrl": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The URL of the Amazon SQS queue whose attribute information is retrieved.

\n

Queue URLs and names are case-sensitive.

", + "smithy.api#required": {} + } + }, + "AttributeNames": { + "target": "com.amazonaws.sqs#AttributeNameList", + "traits": { + "smithy.api#documentation": "

A list of attributes for which to retrieve information.

\n

The AttributeNames parameter is optional, but if you don't specify values\n for this parameter, the request returns empty results.

\n \n

In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

\n \n

The following attributes are supported:

\n \n

The ApproximateNumberOfMessagesDelayed,\n ApproximateNumberOfMessagesNotVisible, and\n ApproximateNumberOfMessages metrics may not achieve consistency\n until at least 1 minute after the producers stop sending messages. This period is\n required for the queue metadata to reach eventual consistency.

\n \n
    \n
  • \n

    \n All – Returns all values.

    \n
    • \n
  • \n

    \n ApproximateNumberOfMessages – Returns the approximate\n number of messages available for retrieval from the queue.

    \n
    • \n
  • \n

    \n ApproximateNumberOfMessagesDelayed – Returns the\n approximate number of messages in the queue that are delayed and not available\n for reading immediately. This can happen when the queue is configured as a delay\n queue or when a message has been sent with a delay parameter.

    \n
    • \n
  • \n

    \n ApproximateNumberOfMessagesNotVisible – Returns the\n approximate number of messages that are in flight. Messages are considered to be\n in flight if they have been sent to a client but have\n not yet been deleted or have not yet reached the end of their visibility window.\n

    \n
    • \n
  • \n

    \n CreatedTimestamp – Returns the time when the queue was\n created in seconds (epoch\n time).

    \n
    • \n
  • \n

    \n DelaySeconds – Returns the default delay on the queue in\n seconds.

    \n
    • \n
  • \n

    \n LastModifiedTimestamp – Returns the time when the queue\n was last changed in seconds (epoch time).

    \n
    • \n
  • \n

    \n MaximumMessageSize – Returns the limit of how many bytes a\n message can contain before Amazon SQS rejects it.

    \n
    • \n
  • \n

    \n MessageRetentionPeriod – Returns the length of time, in\n seconds, for which Amazon SQS retains a message. When you change a queue's\n attributes, the change can take up to 60 seconds for most of the attributes to\n propagate throughout the Amazon SQS system. Changes made to the\n MessageRetentionPeriod attribute can take up to 15 minutes and\n will impact existing messages in the queue potentially causing them to be\n expired and deleted if the MessageRetentionPeriod is reduced below\n the age of existing messages.

    \n
    • \n
  • \n

    \n Policy – Returns the policy of the queue.

    \n
    • \n
  • \n

    \n QueueArn – Returns the Amazon resource name (ARN) of the\n queue.

    \n
    • \n
  • \n

    \n ReceiveMessageWaitTimeSeconds – Returns the length of\n time, in seconds, for which the ReceiveMessage action waits for a\n message to arrive.

    \n
    • \n
  • \n

    \n VisibilityTimeout – Returns the visibility timeout for the\n queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer\n Guide.

    \n
    • \n
\n

The following attributes apply only to dead-letter queues:\n

\n
    \n
  • \n

    \n RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality \n of the source queue as a JSON object. The parameters are as follows:

    \n
      \n
    • \n

      \n deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to \n which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.

      \n
      • \n
    • \n

      \n maxReceiveCount – The number of times a message is delivered to the source queue before being \n moved to the dead-letter queue. Default: 10. When the ReceiveCount for a message exceeds the maxReceiveCount \n for a queue, Amazon SQS moves the message to the dead-letter-queue.

      \n
      • \n
    \n
    • \n
  • \n

    \n RedriveAllowPolicy – The string that includes the parameters for the permissions for the dead-letter\n queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:

    \n
      \n
    • \n

      \n redrivePermission – The permission type that defines which source queues can \n specify the current queue as the dead-letter queue. Valid values are:

      \n
        \n
      • \n

        \n allowAll – (Default) Any source queues in this Amazon Web Services account in the same Region can \n specify this queue as the dead-letter queue.

        \n
        • \n
      • \n

        \n denyAll – No source queues can specify this queue as the dead-letter\n queue.

        \n
        • \n
      • \n

        \n byQueue – Only queues specified by the sourceQueueArns parameter can specify \n this queue as the dead-letter queue.

        \n
        • \n
      \n
      • \n
    • \n

      \n sourceQueueArns – The Amazon Resource Names (ARN)s of the source queues that can specify \n this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the \n redrivePermission parameter is set to byQueue. You can specify up to 10 source queue ARNs. \n To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission parameter\n to allowAll.

      \n
      • \n
    \n
    • \n
\n \n

The dead-letter queue of a \n FIFO queue must also be a FIFO queue. Similarly, the dead-letter \n queue of a standard queue must also be a standard queue.

\n \n

The following attributes apply only to server-side-encryption:

\n
    \n
  • \n

    \n KmsMasterKeyId – Returns the ID of an Amazon Web Services managed customer\n master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.

    \n
    • \n
  • \n

    \n KmsDataKeyReusePeriodSeconds – Returns the length of time,\n in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt\n messages before calling KMS again. For more information, see\n How Does the Data Key Reuse Period Work?.

    \n
    • \n
  • \n

    \n SqsManagedSseEnabled – Returns information about whether the\n queue is using SSE-SQS encryption using SQS owned encryption keys. Only one\n server-side encryption option is supported per queue (for example, SSE-KMS or SSE-SQS).

    \n
    • \n
\n

The following attributes apply only to FIFO (first-in-first-out)\n queues:

\n
    \n
  • \n

    \n FifoQueue – Returns information about whether the queue is\n FIFO. For more information, see FIFO queue logic in the Amazon SQS Developer\n Guide.

    \n \n

    To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.

    \n     \n
    • \n
  • \n

    \n ContentBasedDeduplication – Returns whether content-based\n deduplication is enabled for the queue. For more information, see Exactly-once processing in the Amazon SQS Developer\n Guide.

    \n
    • \n
\n

The following attributes apply only to \nhigh throughput\nfor FIFO queues:

\n
    \n
  • \n

    \n DeduplicationScope – Specifies whether message deduplication occurs at the \n message group or queue level. Valid values are messageGroup and queue.

    \n
    • \n
  • \n

    \n FifoThroughputLimit – Specifies whether the FIFO queue throughput \n quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. \n The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup.

    \n
    • \n
\n

To enable high throughput for FIFO queues, do the following:

\n
    \n
  • \n

    Set DeduplicationScope to messageGroup.

    \n
    • \n
  • \n

    Set FifoThroughputLimit to perMessageGroupId.

    \n
    • \n
\n

If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified.

\n

For information on throughput quotas, \n see Quotas related to messages \n in the Amazon SQS Developer Guide.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "AttributeName" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#GetQueueAttributesResult": { + "type": "structure", + "members": { + "Attributes": { + "target": "com.amazonaws.sqs#QueueAttributeMap", + "traits": { + "smithy.api#documentation": "

A map of attributes to their respective values.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Attribute" + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of returned queue attributes.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.sqs#GetQueueUrl": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#GetQueueUrlRequest" + }, + "output": { + "target": "com.amazonaws.sqs#GetQueueUrlResult" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#QueueDoesNotExist" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "

The GetQueueUrl API returns the URL of an existing Amazon SQS queue. This is\n useful when you know the queue's name but need to retrieve its URL for further\n operations.

\n

To access a queue owned by another Amazon Web Services account, use the\n QueueOwnerAWSAccountId parameter to specify the account ID of the\n queue's owner. Note that the queue owner must grant you the necessary permissions to\n access the queue. For more information about accessing shared queues, see the\n \n AddPermission\n API or Allow developers to write messages to a shared queue in the Amazon SQS\n Developer Guide.

" + } + }, + "com.amazonaws.sqs#GetQueueUrlRequest": { + "type": "structure", + "members": { + "QueueName": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

(Required) The name of the queue for which you want to fetch the URL. The name can be\n up to 80 characters long and can include alphanumeric characters, hyphens (-), and\n underscores (_). Queue URLs and names are case-sensitive.

", + "smithy.api#required": {} + } + }, + "QueueOwnerAWSAccountId": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

(Optional) The Amazon Web Services account ID of the account that created the queue. This is only\n required when you are attempting to access a queue owned by another\n Amazon Web Services account.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Retrieves the URL of an existing queue based on its name and, optionally, the Amazon Web Services\n account ID.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#GetQueueUrlResult": { + "type": "structure", + "members": { + "QueueUrl": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The URL of the queue.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

For more information, see Interpreting Responses in the Amazon SQS Developer\n Guide.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.sqs#InvalidAddress": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidAddress", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified ID is invalid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.sqs#InvalidAttributeName": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The specified attribute doesn't exist.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.sqs#InvalidAttributeValue": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

A queue attribute value is invalid.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.sqs#InvalidBatchEntryId": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AWS.SimpleQueueService.InvalidBatchEntryId", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The Id of a batch entry in a batch request doesn't abide by the\n specification.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sqs#InvalidIdFormat": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#deprecated": { + "message": "exception has been included in ReceiptHandleIsInvalid" + }, + "smithy.api#documentation": "

The specified receipt handle isn't valid for the current version.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.sqs#InvalidMessageContents": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The message contains characters outside the allowed set.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.sqs#InvalidSecurity": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidSecurity", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "

The request was not made over HTTPS or did not use SigV4 for signing.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.sqs#KmsAccessDenied": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "KMS.AccessDeniedException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The caller doesn't have the required KMS access.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sqs#KmsDisabled": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "KMS.DisabledException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request was denied due to request throttling.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sqs#KmsInvalidKeyUsage": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "KMS.InvalidKeyUsageException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request was rejected for one of the following reasons:

\n
    \n
  • \n

    The KeyUsage value of the KMS key is incompatible with the API\n operation.

    \n
    • \n
  • \n

    The encryption algorithm or signing algorithm specified for the operation is\n incompatible with the type of key material in the KMS key (KeySpec).

    \n
    • \n
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sqs#KmsInvalidState": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "KMS.InvalidStateException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request was rejected because the state of the specified resource is not valid for\n this request.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sqs#KmsNotFound": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "KMS.NotFoundException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request was rejected because the specified entity or resource could not be found.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sqs#KmsOptInRequired": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "KMS.OptInRequired", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "

The request was rejected because the specified key policy isn't syntactically or\n semantically correct.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.sqs#KmsThrottled": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "KMS.ThrottlingException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Amazon Web Services KMS throttles requests for the following conditions.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sqs#ListDeadLetterSourceQueues": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#ListDeadLetterSourceQueuesRequest" + }, + "output": { + "target": "com.amazonaws.sqs#ListDeadLetterSourceQueuesResult" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#QueueDoesNotExist" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of your queues that have the RedrivePolicy queue attribute\n configured with a dead-letter queue.

\n

The ListDeadLetterSourceQueues methods supports pagination. Set\n parameter MaxResults in the request to specify the maximum number of\n results to be returned in the response. If you do not set MaxResults, the\n response includes a maximum of 1,000 results. If you set MaxResults and\n there are additional results to display, the response includes a value for\n NextToken. Use NextToken as a parameter in your next\n request to ListDeadLetterSourceQueues to receive the next page of results.

\n

For more information about using dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon SQS Developer\n Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "queueUrls", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sqs#ListDeadLetterSourceQueuesRequest": { + "type": "structure", + "members": { + "QueueUrl": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The URL of a dead-letter queue.

\n

Queue URLs and names are case-sensitive.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sqs#Token", + "traits": { + "smithy.api#documentation": "

Pagination token to request the next set of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sqs#BoxedInteger", + "traits": { + "smithy.api#documentation": "

Maximum number of results to include in the response. Value range is 1 to 1000. You\n must set MaxResults to receive a value for NextToken in the\n response.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#ListDeadLetterSourceQueuesResult": { + "type": "structure", + "members": { + "queueUrls": { + "target": "com.amazonaws.sqs#QueueUrlList", + "traits": { + "smithy.api#documentation": "

A list of source queue URLs that have the RedrivePolicy queue attribute\n configured with a dead-letter queue.

", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "QueueUrl" + } + }, + "NextToken": { + "target": "com.amazonaws.sqs#Token", + "traits": { + "smithy.api#documentation": "

Pagination token to include in the next request. Token value is null if\n there are no additional results to request, or if you did not set\n MaxResults in the request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of your dead letter source queues.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.sqs#ListMessageMoveTasks": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#ListMessageMoveTasksRequest" + }, + "output": { + "target": "com.amazonaws.sqs#ListMessageMoveTasksResult" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the most recent message movement tasks (up to 10) under a specific source\n queue.

\n \n
    \n
  • \n

    This action is currently limited to supporting message redrive from dead-letter queues (DLQs) only. In this context, the source\n queue is the dead-letter queue (DLQ), while the destination queue can be the\n original source queue (from which the messages were driven to the\n dead-letter-queue), or a custom destination queue.

    \n
    • \n
  • \n

    Only one active message movement task is supported per queue at any given\n time.

    \n
    • \n
\n " + } + }, + "com.amazonaws.sqs#ListMessageMoveTasksRequest": { + "type": "structure", + "members": { + "SourceArn": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The ARN of the queue whose message movement tasks are to be listed.

", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.sqs#NullableInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of results to include in the response. The default is 1, which\n provides the most recent message movement task. The upper limit is 10.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#ListMessageMoveTasksResult": { + "type": "structure", + "members": { + "Results": { + "target": "com.amazonaws.sqs#ListMessageMoveTasksResultEntryList", + "traits": { + "smithy.api#documentation": "

A list of message movement tasks and their attributes.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "ListMessageMoveTasksResultEntry" + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#xmlName": "ListMessageMoveTasksResult" + } + }, + "com.amazonaws.sqs#ListMessageMoveTasksResultEntry": { + "type": "structure", + "members": { + "TaskHandle": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

An identifier associated with a message movement task. When this field is returned in\n the response of the ListMessageMoveTasks action, it is only populated for\n tasks that are in RUNNING status.

" + } + }, + "Status": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The status of the message movement task. Possible values are: RUNNING, COMPLETED,\n CANCELLING, CANCELLED, and FAILED.

" + } + }, + "SourceArn": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The ARN of the queue that contains the messages to be moved to another queue.

" + } + }, + "DestinationArn": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The ARN of the destination queue if it has been specified in the\n StartMessageMoveTask request. If a DestinationArn has not\n been specified in the StartMessageMoveTask request, this field value will\n be NULL.

" + } + }, + "MaxNumberOfMessagesPerSecond": { + "target": "com.amazonaws.sqs#NullableInteger", + "traits": { + "smithy.api#documentation": "

The number of messages to be moved per second (the message movement rate), if it has\n been specified in the StartMessageMoveTask request. If a\n MaxNumberOfMessagesPerSecond has not been specified in the\n StartMessageMoveTask request, this field value will be NULL.

" + } + }, + "ApproximateNumberOfMessagesMoved": { + "target": "com.amazonaws.sqs#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The approximate number of messages already moved to the destination queue.

" + } + }, + "ApproximateNumberOfMessagesToMove": { + "target": "com.amazonaws.sqs#NullableLong", + "traits": { + "smithy.api#documentation": "

The number of messages to be moved from the source queue. This number is obtained at\n the time of starting the message movement task and is only included after the message\n movement task is selected to start.

" + } + }, + "FailureReason": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The task failure reason (only included if the task status is FAILED).

" + } + }, + "StartedTimestamp": { + "target": "com.amazonaws.sqs#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The timestamp of starting the message movement task.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details of a message movement task.

" + } + }, + "com.amazonaws.sqs#ListMessageMoveTasksResultEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#ListMessageMoveTasksResultEntry" + } + }, + "com.amazonaws.sqs#ListQueueTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#ListQueueTagsRequest" + }, + "output": { + "target": "com.amazonaws.sqs#ListQueueTagsResult" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#QueueDoesNotExist" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "

List all cost allocation tags added to the specified Amazon SQS queue.\n For an overview, see Tagging \nYour Amazon SQS Queues in the Amazon SQS Developer Guide.

\n \n

Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.

\n " + } + }, + "com.amazonaws.sqs#ListQueueTagsRequest": { + "type": "structure", + "members": { + "QueueUrl": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The URL of the queue.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#ListQueueTagsResult": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.sqs#TagMap", + "traits": { + "smithy.api#documentation": "

The list of all tags added to the specified queue.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Tag" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sqs#ListQueues": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#ListQueuesRequest" + }, + "output": { + "target": "com.amazonaws.sqs#ListQueuesResult" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of your queues in the current region. The response includes a maximum\n of 1,000 results. If you specify a value for the optional QueueNamePrefix\n parameter, only queues with a name that begins with the specified value are\n returned.

\n

The listQueues methods supports pagination. Set parameter\n MaxResults in the request to specify the maximum number of results to\n be returned in the response. If you do not set MaxResults, the response\n includes a maximum of 1,000 results. If you set MaxResults and there are\n additional results to display, the response includes a value for NextToken.\n Use NextToken as a parameter in your next request to\n listQueues to receive the next page of results.

\n \n

Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.

\n ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "QueueUrls", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sqs#ListQueuesRequest": { + "type": "structure", + "members": { + "QueueNamePrefix": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

A string to use for filtering the list results. Only those queues whose name begins\n with the specified string are returned.

\n

Queue URLs and names are case-sensitive.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sqs#Token", + "traits": { + "smithy.api#documentation": "

Pagination token to request the next set of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sqs#BoxedInteger", + "traits": { + "smithy.api#documentation": "

Maximum number of results to include in the response. Value range is 1 to 1000. You\n must set MaxResults to receive a value for NextToken in the\n response.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#ListQueuesResult": { + "type": "structure", + "members": { + "QueueUrls": { + "target": "com.amazonaws.sqs#QueueUrlList", + "traits": { + "smithy.api#documentation": "

A list of queue URLs, up to 1,000 entries, or the value of MaxResults\n that you sent in the request.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "QueueUrl" + } + }, + "NextToken": { + "target": "com.amazonaws.sqs#Token", + "traits": { + "smithy.api#documentation": "

Pagination token to include in the next request. Token value is null if\n there are no additional results to request, or if you did not set\n MaxResults in the request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of your queues.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.sqs#Long": { + "type": "long", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.sqs#Message": { + "type": "structure", + "members": { + "MessageId": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

A unique identifier for the message. A MessageIdis considered unique\n across all Amazon Web Services accounts for an extended period of time.

" + } + }, + "ReceiptHandle": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

An identifier associated with the act of receiving the message. A new receipt handle\n is returned every time you receive a message. When deleting a message, you provide the\n last received receipt handle to delete the message.

" + } + }, + "MD5OfBody": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

An MD5 digest of the non-URL-encoded message body string.

" + } + }, + "Body": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The message's contents (not URL-encoded).

" + } + }, + "Attributes": { + "target": "com.amazonaws.sqs#MessageSystemAttributeMap", + "traits": { + "smithy.api#documentation": "

A map of the attributes requested in \n ReceiveMessage\n to\n their respective values. Supported attributes:

\n
    \n
  • \n

    \n ApproximateReceiveCount\n

    \n
    • \n
  • \n

    \n ApproximateFirstReceiveTimestamp\n

    \n
    • \n
  • \n

    \n MessageDeduplicationId\n

    \n
    • \n
  • \n

    \n MessageGroupId\n

    \n
    • \n
  • \n

    \n SenderId\n

    \n
    • \n
  • \n

    \n SentTimestamp\n

    \n
    • \n
  • \n

    \n SequenceNumber\n

    \n
    • \n
\n

\n ApproximateFirstReceiveTimestamp and SentTimestamp are each\n returned as an integer representing the epoch time in\n milliseconds.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Attribute" + } + }, + "MD5OfMessageAttributes": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

" + } + }, + "MessageAttributes": { + "target": "com.amazonaws.sqs#MessageBodyAttributeMap", + "traits": { + "smithy.api#documentation": "

Each message attribute consists of a Name, Type, \nand Value. For more information, see \nAmazon SQS \nmessage attributes in the Amazon SQS Developer Guide.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "MessageAttribute" + } + } + }, + "traits": { + "smithy.api#documentation": "

An Amazon SQS message.

" + } + }, + "com.amazonaws.sqs#MessageAttributeName": { + "type": "string" + }, + "com.amazonaws.sqs#MessageAttributeNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#MessageAttributeName" + } + }, + "com.amazonaws.sqs#MessageAttributeValue": { + "type": "structure", + "members": { + "StringValue": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable\n Characters.

" + } + }, + "BinaryValue": { + "target": "com.amazonaws.sqs#Binary", + "traits": { + "smithy.api#documentation": "

Binary type attributes can store any binary data, such as compressed data, encrypted\n data, or images.

" + } + }, + "StringListValues": { + "target": "com.amazonaws.sqs#StringList", + "traits": { + "smithy.api#documentation": "

Not implemented. Reserved for future use.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "StringListValue" + } + }, + "BinaryListValues": { + "target": "com.amazonaws.sqs#BinaryList", + "traits": { + "smithy.api#documentation": "

Not implemented. Reserved for future use.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "BinaryListValue" + } + }, + "DataType": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

Amazon SQS supports the following logical data types: String,\n Number, and Binary. For the Number data type,\n you must use StringValue.

\n

You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer\n Guide.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The user-specified message attribute value. For string data types, the\n Value attribute has the same restrictions on the content as the message\n body. For more information, see \n SendMessage.\n

\n

\n Name, type, value and the message body must not\n be empty or null. All parts of the message attribute, including Name,\n Type, and Value, are part of the message size restriction\n (256 KiB or 262,144 bytes).

" + } + }, + "com.amazonaws.sqs#MessageBodyAttributeMap": { + "type": "map", + "key": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#xmlName": "Name" + } + }, + "value": { + "target": "com.amazonaws.sqs#MessageAttributeValue", + "traits": { + "smithy.api#xmlName": "Value" + } + } + }, + "com.amazonaws.sqs#MessageBodySystemAttributeMap": { + "type": "map", + "key": { + "target": "com.amazonaws.sqs#MessageSystemAttributeNameForSends", + "traits": { + "smithy.api#xmlName": "Name" + } + }, + "value": { + "target": "com.amazonaws.sqs#MessageSystemAttributeValue", + "traits": { + "smithy.api#xmlName": "Value" + } + } + }, + "com.amazonaws.sqs#MessageList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#Message" + } + }, + "com.amazonaws.sqs#MessageNotInflight": { + "type": "structure", + "members": {}, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AWS.SimpleQueueService.MessageNotInflight", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The specified message isn't in flight.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sqs#MessageSystemAttributeList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#MessageSystemAttributeName" + } + }, + "com.amazonaws.sqs#MessageSystemAttributeMap": { + "type": "map", + "key": { + "target": "com.amazonaws.sqs#MessageSystemAttributeName", + "traits": { + "smithy.api#xmlName": "Name" + } + }, + "value": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#xmlName": "Value" + } + } + }, + "com.amazonaws.sqs#MessageSystemAttributeName": { + "type": "enum", + "members": { + "All": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "All" + } + }, + "SenderId": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SenderId" + } + }, + "SentTimestamp": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SentTimestamp" + } + }, + "ApproximateReceiveCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ApproximateReceiveCount" + } + }, + "ApproximateFirstReceiveTimestamp": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ApproximateFirstReceiveTimestamp" + } + }, + "SequenceNumber": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SequenceNumber" + } + }, + "MessageDeduplicationId": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MessageDeduplicationId" + } + }, + "MessageGroupId": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MessageGroupId" + } + }, + "AWSTraceHeader": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWSTraceHeader" + } + }, + "DeadLetterQueueSourceArn": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeadLetterQueueSourceArn" + } + } + } + }, + "com.amazonaws.sqs#MessageSystemAttributeNameForSends": { + "type": "enum", + "members": { + "AWSTraceHeader": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWSTraceHeader" + } + } + } + }, + "com.amazonaws.sqs#MessageSystemAttributeValue": { + "type": "structure", + "members": { + "StringValue": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable\n Characters.

" + } + }, + "BinaryValue": { + "target": "com.amazonaws.sqs#Binary", + "traits": { + "smithy.api#documentation": "

Binary type attributes can store any binary data, such as compressed data, encrypted\n data, or images.

" + } + }, + "StringListValues": { + "target": "com.amazonaws.sqs#StringList", + "traits": { + "smithy.api#documentation": "

Not implemented. Reserved for future use.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "StringListValue" + } + }, + "BinaryListValues": { + "target": "com.amazonaws.sqs#BinaryList", + "traits": { + "smithy.api#documentation": "

Not implemented. Reserved for future use.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "BinaryListValue" + } + }, + "DataType": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

Amazon SQS supports the following logical data types: String,\n Number, and Binary. For the Number data type,\n you must use StringValue.

\n

You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer\n Guide.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The user-specified message system attribute value. For string data types, the\n Value attribute has the same restrictions on the content as the message\n body. For more information, see \n SendMessage.\n

\n

\n Name, type, value and the message body must not\n be empty or null.

" + } + }, + "com.amazonaws.sqs#NullableInteger": { + "type": "integer" + }, + "com.amazonaws.sqs#NullableLong": { + "type": "long" + }, + "com.amazonaws.sqs#OverLimit": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "OverLimit", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "

The specified action violates a limit. For example, ReceiveMessage\n returns this error if the maximum number of in flight messages is reached and\n AddPermission returns this error if the maximum number of permissions\n for the queue is reached.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.sqs#PurgeQueue": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#PurgeQueueRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#PurgeQueueInProgress" + }, + { + "target": "com.amazonaws.sqs#QueueDoesNotExist" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes available messages in a queue (including in-flight messages) specified by the\n QueueURL parameter.

\n \n

When you use the PurgeQueue action, you can't retrieve any messages\n deleted from a queue.

\n

The message deletion process takes up to 60 seconds. We recommend waiting for 60\n seconds regardless of your queue's size.

\n \n

Messages sent to the queue before you call\n PurgeQueue might be received but are deleted within the next\n minute.

\n

Messages sent to the queue after you call PurgeQueue\n might be deleted while the queue is being purged.

" + } + }, + "com.amazonaws.sqs#PurgeQueueInProgress": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AWS.SimpleQueueService.PurgeQueueInProgress", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "

Indicates that the specified queue previously received a PurgeQueue\n request within the last 60 seconds (the time it can take to delete the messages in the\n queue).

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.sqs#PurgeQueueRequest": { + "type": "structure", + "members": { + "QueueUrl": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The URL of the queue from which the PurgeQueue action deletes\n messages.

\n

Queue URLs and names are case-sensitive.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#QueueAttributeMap": { + "type": "map", + "key": { + "target": "com.amazonaws.sqs#QueueAttributeName", + "traits": { + "smithy.api#xmlName": "Name" + } + }, + "value": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#xmlName": "Value" + } + } + }, + "com.amazonaws.sqs#QueueAttributeName": { + "type": "enum", + "members": { + "All": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "All" + } + }, + "Policy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Policy" + } + }, + "VisibilityTimeout": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VisibilityTimeout" + } + }, + "MaximumMessageSize": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MaximumMessageSize" + } + }, + "MessageRetentionPeriod": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MessageRetentionPeriod" + } + }, + "ApproximateNumberOfMessages": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ApproximateNumberOfMessages" + } + }, + "ApproximateNumberOfMessagesNotVisible": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ApproximateNumberOfMessagesNotVisible" + } + }, + "CreatedTimestamp": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreatedTimestamp" + } + }, + "LastModifiedTimestamp": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LastModifiedTimestamp" + } + }, + "QueueArn": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QueueArn" + } + }, + "ApproximateNumberOfMessagesDelayed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ApproximateNumberOfMessagesDelayed" + } + }, + "DelaySeconds": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DelaySeconds" + } + }, + "ReceiveMessageWaitTimeSeconds": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ReceiveMessageWaitTimeSeconds" + } + }, + "RedrivePolicy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RedrivePolicy" + } + }, + "FifoQueue": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FifoQueue" + } + }, + "ContentBasedDeduplication": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ContentBasedDeduplication" + } + }, + "KmsMasterKeyId": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KmsMasterKeyId" + } + }, + "KmsDataKeyReusePeriodSeconds": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KmsDataKeyReusePeriodSeconds" + } + }, + "DeduplicationScope": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeduplicationScope" + } + }, + "FifoThroughputLimit": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FifoThroughputLimit" + } + }, + "RedriveAllowPolicy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RedriveAllowPolicy" + } + }, + "SqsManagedSseEnabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SqsManagedSseEnabled" + } + } + } + }, + "com.amazonaws.sqs#QueueDeletedRecently": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AWS.SimpleQueueService.QueueDeletedRecently", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

You must wait 60 seconds after deleting a queue before you can create another queue\n with the same name.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sqs#QueueDoesNotExist": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AWS.SimpleQueueService.NonExistentQueue", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Ensure that the QueueUrl is correct and that the queue has not been\n deleted.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sqs#QueueNameExists": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "QueueAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

A queue with this name already exists. Amazon SQS returns this error only if the request\n includes attributes whose values differ from those of the existing queue.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sqs#QueueUrlList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#String" + } + }, + "com.amazonaws.sqs#ReceiptHandleIsInvalid": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ReceiptHandleIsInvalid", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified receipt handle isn't valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.sqs#ReceiveMessage": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#ReceiveMessageRequest" + }, + "output": { + "target": "com.amazonaws.sqs#ReceiveMessageResult" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#KmsAccessDenied" + }, + { + "target": "com.amazonaws.sqs#KmsDisabled" + }, + { + "target": "com.amazonaws.sqs#KmsInvalidKeyUsage" + }, + { + "target": "com.amazonaws.sqs#KmsInvalidState" + }, + { + "target": "com.amazonaws.sqs#KmsNotFound" + }, + { + "target": "com.amazonaws.sqs#KmsOptInRequired" + }, + { + "target": "com.amazonaws.sqs#KmsThrottled" + }, + { + "target": "com.amazonaws.sqs#OverLimit" + }, + { + "target": "com.amazonaws.sqs#QueueDoesNotExist" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves one or more messages (up to 10), from the specified queue. Using the\n WaitTimeSeconds parameter enables long-poll support. For more\n information, see Amazon SQS\n Long Polling in the Amazon SQS Developer Guide.

\n

Short poll is the default behavior where a weighted random set of machines is sampled\n on a ReceiveMessage call. Therefore, only the messages on the sampled\n machines are returned. If the number of messages in the queue is small (fewer than\n 1,000), you most likely get fewer messages than you requested per\n ReceiveMessage call. If the number of messages in the queue is\n extremely small, you might not receive any messages in a particular\n ReceiveMessage response. If this happens, repeat the request.

\n

For each message returned, the response includes the following:

\n
    \n
  • \n

    The message body.

    \n
    • \n
  • \n

    An MD5 digest of the message body. For information about MD5, see RFC1321.

    \n
    • \n
  • \n

    The MessageId you received when you sent the message to the\n queue.

    \n
    • \n
  • \n

    The receipt handle.

    \n
    • \n
  • \n

    The message attributes.

    \n
    • \n
  • \n

    An MD5 digest of the message attributes.

    \n
    • \n
\n

The receipt handle is the identifier you must provide when deleting the message. For\n more information, see Queue and Message Identifiers in the Amazon SQS Developer\n Guide.

\n

You can provide the VisibilityTimeout parameter in your request. The\n parameter is applied to the messages that Amazon SQS returns in the response. If you don't\n include the parameter, the overall visibility timeout for the queue is used for the\n returned messages. The default visibility timeout for a queue is 30 seconds.

\n \n

In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

\n " + } + }, + "com.amazonaws.sqs#ReceiveMessageRequest": { + "type": "structure", + "members": { + "QueueUrl": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The URL of the Amazon SQS queue from which messages are received.

\n

Queue URLs and names are case-sensitive.

", + "smithy.api#required": {} + } + }, + "AttributeNames": { + "target": "com.amazonaws.sqs#AttributeNameList", + "traits": { + "smithy.api#deprecated": { + "message": "AttributeNames has been replaced by MessageSystemAttributeNames" + }, + "smithy.api#documentation": "\n

This parameter has been discontinued but will be supported for backward\n compatibility. To provide attribute names, you are encouraged to use\n MessageSystemAttributeNames.

\n \n

A list of attributes that need to be returned along with each message. These\n attributes include:

\n
    \n
  • \n

    \n All – Returns all values.

    \n
    • \n
  • \n

    \n ApproximateFirstReceiveTimestamp – Returns the time the\n message was first received from the queue (epoch time in\n milliseconds).

    \n
    • \n
  • \n

    \n ApproximateReceiveCount – Returns the number of times a\n message has been received across all queues but not deleted.

    \n
    • \n
  • \n

    \n AWSTraceHeader – Returns the X-Ray trace\n header string.

    \n
    • \n
  • \n

    \n SenderId\n

    \n
      \n
    • \n

      For a user, returns the user ID, for example\n ABCDEFGHI1JKLMNOPQ23R.

      \n
      • \n
    • \n

      For an IAM role, returns the IAM role ID, for example\n ABCDE1F2GH3I4JK5LMNOP:i-a123b456.

      \n
      • \n
    \n
    • \n
  • \n

    \n SentTimestamp – Returns the time the message was sent to the\n queue (epoch time in\n milliseconds).

    \n
    • \n
  • \n

    \n SqsManagedSseEnabled – Enables server-side queue encryption\n using SQS owned encryption keys. Only one server-side encryption option is\n supported per queue (for example, SSE-KMS or SSE-SQS).

    \n
    • \n
  • \n

    \n MessageDeduplicationId – Returns the value provided by the\n producer that calls the \n SendMessage\n \n action.

    \n
    • \n
  • \n

    \n MessageGroupId – Returns the value provided by the\n producer that calls the \n SendMessage\n action.\n Messages with the same MessageGroupId are returned in\n sequence.

    \n
    • \n
  • \n

    \n SequenceNumber – Returns the value provided by\n Amazon SQS.

    \n
    • \n
", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "AttributeName" + } + }, + "MessageSystemAttributeNames": { + "target": "com.amazonaws.sqs#MessageSystemAttributeList", + "traits": { + "smithy.api#documentation": "

A list of attributes that need to be returned along with each message. These\n attributes include:

\n
    \n
  • \n

    \n All – Returns all values.

    \n
    • \n
  • \n

    \n ApproximateFirstReceiveTimestamp – Returns the time the\n message was first received from the queue (epoch time in\n milliseconds).

    \n
    • \n
  • \n

    \n ApproximateReceiveCount – Returns the number of times a\n message has been received across all queues but not deleted.

    \n
    • \n
  • \n

    \n AWSTraceHeader – Returns the X-Ray trace\n header string.

    \n
    • \n
  • \n

    \n SenderId\n

    \n
      \n
    • \n

      For a user, returns the user ID, for example\n ABCDEFGHI1JKLMNOPQ23R.

      \n
      • \n
    • \n

      For an IAM role, returns the IAM role ID, for example\n ABCDE1F2GH3I4JK5LMNOP:i-a123b456.

      \n
      • \n
    \n
    • \n
  • \n

    \n SentTimestamp – Returns the time the message was sent to the\n queue (epoch time in\n milliseconds).

    \n
    • \n
  • \n

    \n SqsManagedSseEnabled – Enables server-side queue encryption\n using SQS owned encryption keys. Only one server-side encryption option is\n supported per queue (for example, SSE-KMS or SSE-SQS).

    \n
    • \n
  • \n

    \n MessageDeduplicationId – Returns the value provided by the\n producer that calls the \n SendMessage\n \n action.

    \n
    • \n
  • \n

    \n MessageGroupId – Returns the value provided by the\n producer that calls the \n SendMessage\n action.\n Messages with the same MessageGroupId are returned in\n sequence.

    \n
    • \n
  • \n

    \n SequenceNumber – Returns the value provided by\n Amazon SQS.

    \n
    • \n
", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "AttributeName" + } + }, + "MessageAttributeNames": { + "target": "com.amazonaws.sqs#MessageAttributeNameList", + "traits": { + "smithy.api#documentation": "

The name of the message attribute, where N is the index.

\n
    \n
  • \n

    The name can contain alphanumeric characters and the underscore\n (_), hyphen (-), and period\n (.).

    \n
    • \n
  • \n

    The name is case-sensitive and must be unique among all attribute names for\n the message.

    \n
    • \n
  • \n

    The name must not start with AWS-reserved prefixes such as AWS.\n or Amazon. (or any casing variants).

    \n
    • \n
  • \n

    The name must not start or end with a period (.), and it should\n not have periods in succession (..).

    \n
    • \n
  • \n

    The name can be up to 256 characters long.

    \n
    • \n
\n

When using ReceiveMessage, you can send a list of attribute names to\n receive, or you can return all of the attributes by specifying All or\n .* in your request. You can also use all message attributes starting\n with a prefix, for example bar.*.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "MessageAttributeName" + } + }, + "MaxNumberOfMessages": { + "target": "com.amazonaws.sqs#NullableInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of messages to return. Amazon SQS never returns more messages than this\n value (however, fewer messages might be returned). Valid values: 1 to 10. Default:\n 1.

" + } + }, + "VisibilityTimeout": { + "target": "com.amazonaws.sqs#NullableInteger", + "traits": { + "smithy.api#documentation": "

The duration (in seconds) that the received messages are hidden from subsequent\n retrieve requests after being retrieved by a ReceiveMessage request. If not\n specified, the default visibility timeout for the queue is used, which is 30\n seconds.

\n

Understanding VisibilityTimeout:

\n
    \n
  • \n

    When a message is received from a queue, it becomes temporarily invisible to\n other consumers for the duration of the visibility timeout. This prevents\n multiple consumers from processing the same message simultaneously. If the\n message is not deleted or its visibility timeout is not extended before the\n timeout expires, it becomes visible again and can be retrieved by other\n consumers.

    \n
    • \n
  • \n

    Setting an appropriate visibility timeout is crucial. If it's too short, the\n message might become visible again before processing is complete, leading to\n duplicate processing. If it's too long, it delays the reprocessing of messages\n if the initial processing fails.

    \n
    • \n
  • \n

    You can adjust the visibility timeout using the\n --visibility-timeout parameter in the\n receive-message command to match the processing time required\n by your application.

    \n
    • \n
  • \n

    A message that isn't deleted or a message whose visibility isn't extended\n before the visibility timeout expires counts as a failed receive. Depending on\n the configuration of the queue, the message might be sent to the dead-letter\n queue.

    \n
    • \n
\n

For more information, see Visibility Timeout in the Amazon SQS Developer\n Guide.

" + } + }, + "WaitTimeSeconds": { + "target": "com.amazonaws.sqs#NullableInteger", + "traits": { + "smithy.api#documentation": "

The duration (in seconds) for which the call waits for a message to arrive in the\n queue before returning. If a message is available, the call returns sooner than\n WaitTimeSeconds. If no messages are available and the wait time\n expires, the call does not return a message list. If you are using the Java SDK, it\n returns a ReceiveMessageResponse object, which has a empty list instead of\n a Null object.

\n \n

To avoid HTTP errors, ensure that the HTTP response timeout for\n ReceiveMessage requests is longer than the\n WaitTimeSeconds parameter. For example, with the Java SDK, you can\n set HTTP transport settings using the NettyNioAsyncHttpClient for asynchronous clients, or the ApacheHttpClient for synchronous clients.

\n " + } + }, + "ReceiveRequestAttemptId": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) queues.

\n

The token used for deduplication of ReceiveMessage calls. If a networking\n issue occurs after a ReceiveMessage action, and instead of a response you\n receive a generic error, it is possible to retry the same action with an identical\n ReceiveRequestAttemptId to retrieve the same set of messages, even if\n their visibility timeout has not yet expired.

\n
    \n
  • \n

    You can use ReceiveRequestAttemptId only for 5 minutes after a\n ReceiveMessage action.

    \n
    • \n
  • \n

    When you set FifoQueue, a caller of the\n ReceiveMessage action can provide a\n ReceiveRequestAttemptId explicitly.

    \n
    • \n
  • \n

    It is possible to retry the ReceiveMessage action with the same\n ReceiveRequestAttemptId if none of the messages have been\n modified (deleted or had their visibility changes).

    \n
    • \n
  • \n

    During a visibility timeout, subsequent calls with the same\n ReceiveRequestAttemptId return the same messages and receipt\n handles. If a retry occurs within the deduplication interval, it resets the\n visibility timeout. For more information, see Visibility Timeout in the Amazon SQS Developer\n Guide.

    \n \n

    If a caller of the ReceiveMessage action still processes\n messages when the visibility timeout expires and messages become visible,\n another worker consuming from the same queue can receive the same messages\n and therefore process duplicates. Also, if a consumer whose message\n processing time is longer than the visibility timeout tries to delete the\n processed messages, the action fails with an error.

    \n

    To mitigate this effect, ensure that your application observes a safe\n threshold before the visibility timeout expires and extend the visibility\n timeout as necessary.

    \n     \n
    • \n
  • \n

    While messages with a particular MessageGroupId are invisible, no\n more messages belonging to the same MessageGroupId are returned\n until the visibility timeout expires. You can still receive messages with\n another MessageGroupId as long as it is also visible.

    \n
    • \n
  • \n

    If a caller of ReceiveMessage can't track the\n ReceiveRequestAttemptId, no retries work until the original\n visibility timeout expires. As a result, delays might occur but the messages in\n the queue remain in a strict order.

    \n
    • \n
\n

The maximum length of ReceiveRequestAttemptId is 128 characters.\n ReceiveRequestAttemptId can contain alphanumeric characters\n (a-z, A-Z, 0-9) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

\n

For best practices of using ReceiveRequestAttemptId, see Using the ReceiveRequestAttemptId Request Parameter in the Amazon SQS\n Developer Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Retrieves one or more messages from a specified queue.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#ReceiveMessageResult": { + "type": "structure", + "members": { + "Messages": { + "target": "com.amazonaws.sqs#MessageList", + "traits": { + "smithy.api#documentation": "

A list of messages.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Message" + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of received messages.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.sqs#RemovePermission": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#RemovePermissionRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#QueueDoesNotExist" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "

Revokes any permissions in the queue policy that matches the specified\n Label parameter.

\n \n
    \n
  • \n

    Only the owner of a queue can remove permissions from it.

    \n
    • \n
  • \n

    Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.

    \n
    • \n
  • \n

    To remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.

    \n
    • \n
\n " + } + }, + "com.amazonaws.sqs#RemovePermissionRequest": { + "type": "structure", + "members": { + "QueueUrl": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The URL of the Amazon SQS queue from which permissions are removed.

\n

Queue URLs and names are case-sensitive.

", + "smithy.api#required": {} + } + }, + "Label": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The identification of the permission to remove. This is the label added using the\n \n AddPermission\n action.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#RequestThrottled": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "RequestThrottled", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "

The request was denied due to request throttling.

\n
    \n
  • \n

    Exceeds the permitted request rate for the queue or for the recipient of the\n request.

    \n
    • \n
  • \n

    Ensure that the request rate is within the Amazon SQS limits for\n sending messages. For more information, see Amazon SQS quotas in the Amazon SQS\n Developer Guide.

    \n
    • \n
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.sqs#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ResourceNotFoundException", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

One or more specified resources don't exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.sqs#SendMessage": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#SendMessageRequest" + }, + "output": { + "target": "com.amazonaws.sqs#SendMessageResult" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidMessageContents" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#KmsAccessDenied" + }, + { + "target": "com.amazonaws.sqs#KmsDisabled" + }, + { + "target": "com.amazonaws.sqs#KmsInvalidKeyUsage" + }, + { + "target": "com.amazonaws.sqs#KmsInvalidState" + }, + { + "target": "com.amazonaws.sqs#KmsNotFound" + }, + { + "target": "com.amazonaws.sqs#KmsOptInRequired" + }, + { + "target": "com.amazonaws.sqs#KmsThrottled" + }, + { + "target": "com.amazonaws.sqs#QueueDoesNotExist" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "

Delivers a message to the specified queue.

\n \n

A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters.

\n

\n #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF\n

\n

Amazon SQS does not throw an exception or completely reject the message if it contains invalid characters. Instead, it replaces those invalid characters with U+FFFD before storing the message in the queue, as long as the message body contains at least one valid character.

\n " + } + }, + "com.amazonaws.sqs#SendMessageBatch": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#SendMessageBatchRequest" + }, + "output": { + "target": "com.amazonaws.sqs#SendMessageBatchResult" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#BatchEntryIdsNotDistinct" + }, + { + "target": "com.amazonaws.sqs#BatchRequestTooLong" + }, + { + "target": "com.amazonaws.sqs#EmptyBatchRequest" + }, + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidBatchEntryId" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#KmsAccessDenied" + }, + { + "target": "com.amazonaws.sqs#KmsDisabled" + }, + { + "target": "com.amazonaws.sqs#KmsInvalidKeyUsage" + }, + { + "target": "com.amazonaws.sqs#KmsInvalidState" + }, + { + "target": "com.amazonaws.sqs#KmsNotFound" + }, + { + "target": "com.amazonaws.sqs#KmsOptInRequired" + }, + { + "target": "com.amazonaws.sqs#KmsThrottled" + }, + { + "target": "com.amazonaws.sqs#QueueDoesNotExist" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#TooManyEntriesInBatchRequest" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "

You can use SendMessageBatch to send up to 10 messages to the specified\n queue by assigning either identical or different values to each message (or by not\n assigning values at all). This is a batch version of \n SendMessage. For a FIFO queue, multiple messages within a single batch are enqueued\n in the order they are sent.

\n

The result of sending each message is reported individually in the response.\n Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

\n

The maximum allowed individual message size and the maximum total payload size (the\n sum of the individual lengths of all of the batched messages) are both 256 KiB (262,144\n bytes).

\n \n

A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters.

\n

\n #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF\n

\n

Amazon SQS does not throw an exception or completely reject the message if it contains invalid characters. Instead, it replaces those invalid characters with U+FFFD before storing the message in the queue, as long as the message body contains at least one valid character.

\n \n

If you don't specify the DelaySeconds parameter for an entry, Amazon SQS uses\n the default value for the queue.

" + } + }, + "com.amazonaws.sqs#SendMessageBatchRequest": { + "type": "structure", + "members": { + "QueueUrl": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The URL of the Amazon SQS queue to which batched messages are sent.

\n

Queue URLs and names are case-sensitive.

", + "smithy.api#required": {} + } + }, + "Entries": { + "target": "com.amazonaws.sqs#SendMessageBatchRequestEntryList", + "traits": { + "smithy.api#documentation": "

A list of \n SendMessageBatchRequestEntry\n items.

", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "SendMessageBatchRequestEntry" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#SendMessageBatchRequestEntry": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

An identifier for a message in this batch used to communicate the result.

\n \n

The Ids of a batch request need to be unique within a request.

\n

This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).

\n ", + "smithy.api#required": {} + } + }, + "MessageBody": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The body of the message.

", + "smithy.api#required": {} + } + }, + "DelaySeconds": { + "target": "com.amazonaws.sqs#NullableInteger", + "traits": { + "smithy.api#documentation": "

The length of time, in seconds, for which a specific message is delayed. Valid values:\n 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value\n become available for processing after the delay period is finished. If you don't specify\n a value, the default value for the queue is applied.

\n \n

When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.

\n " + } + }, + "MessageAttributes": { + "target": "com.amazonaws.sqs#MessageBodyAttributeMap", + "traits": { + "smithy.api#documentation": "

Each message attribute consists of a Name, Type, \nand Value. For more information, see \nAmazon SQS \nmessage attributes in the Amazon SQS Developer Guide.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "MessageAttribute" + } + }, + "MessageSystemAttributes": { + "target": "com.amazonaws.sqs#MessageBodySystemAttributeMap", + "traits": { + "smithy.api#documentation": "

The message system attribute to send Each message system attribute consists of a Name, Type, and Value.

\n \n
    \n
  • \n

    Currently, the only supported message system attribute is AWSTraceHeader.\n Its type must be String and its value must be a correctly formatted\n X-Ray trace header string.

    \n
    • \n
  • \n

    The size of a message system attribute doesn't count towards the total size of a message.

    \n
    • \n
\n ", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "MessageSystemAttribute" + } + }, + "MessageDeduplicationId": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) queues.

\n

The token used for deduplication of messages within a 5-minute minimum deduplication\n interval. If a message with a particular MessageDeduplicationId is sent\n successfully, subsequent messages with the same MessageDeduplicationId are\n accepted successfully but aren't delivered. For more information, see Exactly-once processing in the Amazon SQS Developer\n Guide.

\n
    \n
  • \n

    Every message must have a unique MessageDeduplicationId,

    \n
      \n
    • \n

      You may provide a MessageDeduplicationId\n explicitly.

      \n
      • \n
    • \n

      If you aren't able to provide a MessageDeduplicationId\n and you enable ContentBasedDeduplication for your queue,\n Amazon SQS uses a SHA-256 hash to generate the\n MessageDeduplicationId using the body of the message\n (but not the attributes of the message).

      \n
      • \n
    • \n

      If you don't provide a MessageDeduplicationId and the\n queue doesn't have ContentBasedDeduplication set, the\n action fails with an error.

      \n
      • \n
    • \n

      If the queue has ContentBasedDeduplication set, your\n MessageDeduplicationId overrides the generated\n one.

      \n
      • \n
    \n
    • \n
  • \n

    When ContentBasedDeduplication is in effect, messages with\n identical content sent within the deduplication interval are treated as\n duplicates and only one copy of the message is delivered.

    \n
    • \n
  • \n

    If you send one message with ContentBasedDeduplication enabled\n and then another message with a MessageDeduplicationId that is the\n same as the one generated for the first MessageDeduplicationId, the\n two messages are treated as duplicates and only one copy of the message is\n delivered.

    \n
    • \n
\n \n

The MessageDeduplicationId is available to the consumer of the\n message (this can be useful for troubleshooting delivery issues).

\n

If a message is sent successfully but the acknowledgement is lost and the message\n is resent with the same MessageDeduplicationId after the deduplication\n interval, Amazon SQS can't detect duplicate messages.

\n

Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.

\n \n

The length of MessageDeduplicationId is 128 characters.\n MessageDeduplicationId can contain alphanumeric characters\n (a-z, A-Z, 0-9) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

\n

For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId Property in the Amazon SQS Developer\n Guide.

" + } + }, + "MessageGroupId": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) queues.

\n

The tag that specifies that a message belongs to a specific message group. Messages\n that belong to the same message group are processed in a FIFO manner (however,\n messages in different message groups might be processed out of order). To interleave\n multiple ordered streams within a single queue, use MessageGroupId values\n (for example, session data for multiple users). In this scenario, multiple consumers can\n process the queue, but the session data of each user is processed in a FIFO\n fashion.

\n
    \n
  • \n

    You must associate a non-empty MessageGroupId with a message. If\n you don't provide a MessageGroupId, the action fails.

    \n
    • \n
  • \n

    \n ReceiveMessage might return messages with multiple\n MessageGroupId values. For each MessageGroupId,\n the messages are sorted by time sent. The caller can't specify a\n MessageGroupId.

    \n
    • \n
\n

The length of MessageGroupId is 128 characters. Valid values:\n alphanumeric characters and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

\n

For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon SQS Developer\n Guide.

\n \n

\n MessageGroupId is required for FIFO queues. You can't use it for\n Standard queues.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details of a single Amazon SQS message along with an Id.

" + } + }, + "com.amazonaws.sqs#SendMessageBatchRequestEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#SendMessageBatchRequestEntry" + } + }, + "com.amazonaws.sqs#SendMessageBatchResult": { + "type": "structure", + "members": { + "Successful": { + "target": "com.amazonaws.sqs#SendMessageBatchResultEntryList", + "traits": { + "smithy.api#documentation": "

A list of \n SendMessageBatchResultEntry\n items.

", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "SendMessageBatchResultEntry" + } + }, + "Failed": { + "target": "com.amazonaws.sqs#BatchResultErrorEntryList", + "traits": { + "smithy.api#documentation": "

A list of \n BatchResultErrorEntry\n items with error\n details about each message that can't be enqueued.

", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "BatchResultErrorEntry" + } + } + }, + "traits": { + "smithy.api#documentation": "

For each message in the batch, the response contains a \n SendMessageBatchResultEntry\n tag if the message succeeds or a\n \n BatchResultErrorEntry\n tag if the message\n fails.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.sqs#SendMessageBatchResultEntry": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

An identifier for the message in this batch.

", + "smithy.api#required": {} + } + }, + "MessageId": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

An identifier for the message.

", + "smithy.api#required": {} + } + }, + "MD5OfMessageBody": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

An MD5 digest of the non-URL-encoded message body string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

", + "smithy.api#required": {} + } + }, + "MD5OfMessageAttributes": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

" + } + }, + "MD5OfMessageSystemAttributes": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

An MD5 digest of the non-URL-encoded message system attribute string. You can use this \nattribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

" + } + }, + "SequenceNumber": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) queues.

\n

The large, non-consecutive number that Amazon SQS assigns to each message.

\n

The length of SequenceNumber is 128 bits. As SequenceNumber\n continues to increase for a particular MessageGroupId.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Encloses a MessageId for a successfully-enqueued message in a \n SendMessageBatch.\n

" + } + }, + "com.amazonaws.sqs#SendMessageBatchResultEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#SendMessageBatchResultEntry" + } + }, + "com.amazonaws.sqs#SendMessageRequest": { + "type": "structure", + "members": { + "QueueUrl": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The URL of the Amazon SQS queue to which a message is sent.

\n

Queue URLs and names are case-sensitive.

", + "smithy.api#required": {} + } + }, + "MessageBody": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The message to send. The minimum size is one character. The maximum size is 256\n KiB.

\n \n

A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters.

\n

\n #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF\n

\n

Amazon SQS does not throw an exception or completely reject the message if it contains invalid characters. Instead, it replaces those invalid characters with U+FFFD before storing the message in the queue, as long as the message body contains at least one valid character.

\n ", + "smithy.api#required": {} + } + }, + "DelaySeconds": { + "target": "com.amazonaws.sqs#NullableInteger", + "traits": { + "smithy.api#documentation": "

The length of time, in seconds, for which to delay a specific message. Valid values:\n 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value\n become available for processing after the delay period is finished. If you don't specify\n a value, the default value for the queue applies.

\n \n

When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.

\n " + } + }, + "MessageAttributes": { + "target": "com.amazonaws.sqs#MessageBodyAttributeMap", + "traits": { + "smithy.api#documentation": "

Each message attribute consists of a Name, Type, \nand Value. For more information, see \nAmazon SQS \nmessage attributes in the Amazon SQS Developer Guide.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "MessageAttribute" + } + }, + "MessageSystemAttributes": { + "target": "com.amazonaws.sqs#MessageBodySystemAttributeMap", + "traits": { + "smithy.api#documentation": "

The message system attribute to send. Each message system attribute consists of a Name, Type, and Value.

\n \n
    \n
  • \n

    Currently, the only supported message system attribute is AWSTraceHeader.\n Its type must be String and its value must be a correctly formatted\n X-Ray trace header string.

    \n
    • \n
  • \n

    The size of a message system attribute doesn't count towards the total size of a message.

    \n
    • \n
\n ", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "MessageSystemAttribute" + } + }, + "MessageDeduplicationId": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) queues.

\n

The token used for deduplication of sent messages. If a message with a particular\n MessageDeduplicationId is sent successfully, any messages sent with the\n same MessageDeduplicationId are accepted successfully but aren't delivered\n during the 5-minute deduplication interval. For more information, see Exactly-once processing in the Amazon SQS Developer\n Guide.

\n
    \n
  • \n

    Every message must have a unique MessageDeduplicationId,

    \n
      \n
    • \n

      You may provide a MessageDeduplicationId\n explicitly.

      \n
      • \n
    • \n

      If you aren't able to provide a MessageDeduplicationId\n and you enable ContentBasedDeduplication for your queue,\n Amazon SQS uses a SHA-256 hash to generate the\n MessageDeduplicationId using the body of the message\n (but not the attributes of the message).

      \n
      • \n
    • \n

      If you don't provide a MessageDeduplicationId and the\n queue doesn't have ContentBasedDeduplication set, the\n action fails with an error.

      \n
      • \n
    • \n

      If the queue has ContentBasedDeduplication set, your\n MessageDeduplicationId overrides the generated\n one.

      \n
      • \n
    \n
    • \n
  • \n

    When ContentBasedDeduplication is in effect, messages with\n identical content sent within the deduplication interval are treated as\n duplicates and only one copy of the message is delivered.

    \n
    • \n
  • \n

    If you send one message with ContentBasedDeduplication enabled\n and then another message with a MessageDeduplicationId that is the\n same as the one generated for the first MessageDeduplicationId, the\n two messages are treated as duplicates and only one copy of the message is\n delivered.

    \n
    • \n
\n \n

The MessageDeduplicationId is available to the consumer of the\n message (this can be useful for troubleshooting delivery issues).

\n

If a message is sent successfully but the acknowledgement is lost and the message\n is resent with the same MessageDeduplicationId after the deduplication\n interval, Amazon SQS can't detect duplicate messages.

\n

Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.

\n \n

The maximum length of MessageDeduplicationId is 128 characters.\n MessageDeduplicationId can contain alphanumeric characters\n (a-z, A-Z, 0-9) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

\n

For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId Property in the Amazon SQS Developer\n Guide.

" + } + }, + "MessageGroupId": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) queues.

\n

The tag that specifies that a message belongs to a specific message group. Messages\n that belong to the same message group are processed in a FIFO manner (however,\n messages in different message groups might be processed out of order). To interleave\n multiple ordered streams within a single queue, use MessageGroupId values\n (for example, session data for multiple users). In this scenario, multiple consumers can\n process the queue, but the session data of each user is processed in a FIFO\n fashion.

\n
    \n
  • \n

    You must associate a non-empty MessageGroupId with a message. If\n you don't provide a MessageGroupId, the action fails.

    \n
    • \n
  • \n

    \n ReceiveMessage might return messages with multiple\n MessageGroupId values. For each MessageGroupId,\n the messages are sorted by time sent. The caller can't specify a\n MessageGroupId.

    \n
    • \n
\n

The maximum length of MessageGroupId is 128 characters. Valid values:\n alphanumeric characters and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

\n

For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon SQS Developer\n Guide.

\n \n

\n MessageGroupId is required for FIFO queues. You can't use it for\n Standard queues.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#SendMessageResult": { + "type": "structure", + "members": { + "MD5OfMessageBody": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

An MD5 digest of the non-URL-encoded message body string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

" + } + }, + "MD5OfMessageAttributes": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

" + } + }, + "MD5OfMessageSystemAttributes": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

An MD5 digest of the non-URL-encoded message system attribute string. You can use this \nattribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest.

" + } + }, + "MessageId": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

An attribute containing the MessageId of the message sent to the queue.\n For more information, see Queue and Message Identifiers in the Amazon SQS Developer\n Guide.

" + } + }, + "SequenceNumber": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) queues.

\n

The large, non-consecutive number that Amazon SQS assigns to each message.

\n

The length of SequenceNumber is 128 bits. SequenceNumber\n continues to increase for a particular MessageGroupId.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The MD5OfMessageBody and MessageId elements.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.sqs#SetQueueAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#SetQueueAttributesRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidAttributeName" + }, + { + "target": "com.amazonaws.sqs#InvalidAttributeValue" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#OverLimit" + }, + { + "target": "com.amazonaws.sqs#QueueDoesNotExist" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "

Sets the value of one or more queue attributes, like a policy. When you change a\n queue's attributes, the change can take up to 60 seconds for most of the attributes to\n propagate throughout the Amazon SQS system. Changes made to the\n MessageRetentionPeriod attribute can take up to 15 minutes and will\n impact existing messages in the queue potentially causing them to be expired and deleted\n if the MessageRetentionPeriod is reduced below the age of existing\n messages.

\n \n
    \n
  • \n

    In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

    \n
    • \n
  • \n

    Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.

    \n
    • \n
  • \n

    To remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.

    \n
    • \n
\n " + } + }, + "com.amazonaws.sqs#SetQueueAttributesRequest": { + "type": "structure", + "members": { + "QueueUrl": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The URL of the Amazon SQS queue whose attributes are set.

\n

Queue URLs and names are case-sensitive.

", + "smithy.api#required": {} + } + }, + "Attributes": { + "target": "com.amazonaws.sqs#QueueAttributeMap", + "traits": { + "smithy.api#documentation": "

A map of attributes to set.

\n

The following lists the names, descriptions, and values of the special request\n parameters that the SetQueueAttributes action uses:

\n
    \n
  • \n

    \n DelaySeconds – The length of time, in seconds, for which the\n delivery of all messages in the queue is delayed. Valid values: An integer from\n 0 to 900 (15 minutes). Default: 0.

    \n
    • \n
  • \n

    \n MaximumMessageSize – The limit of how many bytes a message\n can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes\n (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).

    \n
    • \n
  • \n

    \n MessageRetentionPeriod – The length of time, in seconds, for\n which Amazon SQS retains a message. Valid values: An integer representing seconds,\n from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days). When you\n change a queue's attributes, the change can take up to 60 seconds for most of\n the attributes to propagate throughout the Amazon SQS system. Changes made to the\n MessageRetentionPeriod attribute can take up to 15 minutes and\n will impact existing messages in the queue potentially causing them to be\n expired and deleted if the MessageRetentionPeriod is reduced below\n the age of existing messages.

    \n
    • \n
  • \n

    \n Policy – The queue's policy. A valid Amazon Web Services policy. For more\n information about policy structure, see Overview of Amazon Web Services IAM\n Policies in the Identity and Access Management User\n Guide.

    \n
    • \n
  • \n

    \n ReceiveMessageWaitTimeSeconds – The length of time, in\n seconds, for which a \n ReceiveMessage\n action waits\n for a message to arrive. Valid values: An integer from 0 to 20 (seconds).\n Default: 0.

    \n
    • \n
  • \n

    \n VisibilityTimeout – The visibility timeout for the queue, in\n seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For\n more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer\n Guide.

    \n
    • \n
\n

The following attributes apply only to dead-letter queues:\n

\n
    \n
  • \n

    \n RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality \n of the source queue as a JSON object. The parameters are as follows:

    \n
      \n
    • \n

      \n deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to \n which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.

      \n
      • \n
    • \n

      \n maxReceiveCount – The number of times a message is delivered to the source queue before being \n moved to the dead-letter queue. Default: 10. When the ReceiveCount for a message exceeds the maxReceiveCount \n for a queue, Amazon SQS moves the message to the dead-letter-queue.

      \n
      • \n
    \n
    • \n
  • \n

    \n RedriveAllowPolicy – The string that includes the parameters for the permissions for the dead-letter\n queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:

    \n
      \n
    • \n

      \n redrivePermission – The permission type that defines which source queues can \n specify the current queue as the dead-letter queue. Valid values are:

      \n
        \n
      • \n

        \n allowAll – (Default) Any source queues in this Amazon Web Services account in the same Region can \n specify this queue as the dead-letter queue.

        \n
        • \n
      • \n

        \n denyAll – No source queues can specify this queue as the dead-letter\n queue.

        \n
        • \n
      • \n

        \n byQueue – Only queues specified by the sourceQueueArns parameter can specify \n this queue as the dead-letter queue.

        \n
        • \n
      \n
      • \n
    • \n

      \n sourceQueueArns – The Amazon Resource Names (ARN)s of the source queues that can specify \n this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the \n redrivePermission parameter is set to byQueue. You can specify up to 10 source queue ARNs. \n To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission parameter\n to allowAll.

      \n
      • \n
    \n
    • \n
\n \n

The dead-letter queue of a \n FIFO queue must also be a FIFO queue. Similarly, the dead-letter \n queue of a standard queue must also be a standard queue.

\n \n

The following attributes apply only to server-side-encryption:

\n
    \n
  • \n

    \n KmsMasterKeyId – The ID of an Amazon Web Services managed customer master\n key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is\n always alias/aws/sqs, the alias of a custom CMK can, for example,\n be alias/MyAlias\n . For more examples, see\n KeyId in the Key Management Service API\n Reference.

    \n
    • \n
  • \n

    \n KmsDataKeyReusePeriodSeconds – The length of time, in\n seconds, for which Amazon SQS can reuse a data key to\n encrypt or decrypt messages before calling KMS again. An integer\n representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24\n hours). Default: 300 (5 minutes). A shorter time period provides better security\n but results in more calls to KMS which might incur charges after Free Tier. For\n more information, see How Does the Data Key Reuse Period Work?.

    \n
    • \n
  • \n

    \n SqsManagedSseEnabled – Enables server-side queue encryption\n using SQS owned encryption keys. Only one server-side encryption option is\n supported per queue (for example, SSE-KMS or SSE-SQS).

    \n
    • \n
\n

The following attribute applies only to FIFO (first-in-first-out)\n queues:

\n
    \n
  • \n

    \n ContentBasedDeduplication – Enables content-based\n deduplication. For more information, see Exactly-once processing in the Amazon SQS Developer\n Guide. Note the following:

    \n
      \n
    • \n

      Every message must have a unique\n MessageDeduplicationId.

      \n
        \n
      • \n

        You may provide a MessageDeduplicationId\n explicitly.

        \n
        • \n
      • \n

        If you aren't able to provide a\n MessageDeduplicationId and you enable\n ContentBasedDeduplication for your queue, Amazon SQS\n uses a SHA-256 hash to generate the\n MessageDeduplicationId using the body of the\n message (but not the attributes of the message).

        \n
        • \n
      • \n

        If you don't provide a MessageDeduplicationId and\n the queue doesn't have ContentBasedDeduplication\n set, the action fails with an error.

        \n
        • \n
      • \n

        If the queue has ContentBasedDeduplication set,\n your MessageDeduplicationId overrides the generated\n one.

        \n
        • \n
      \n
      • \n
    • \n

      When ContentBasedDeduplication is in effect, messages\n with identical content sent within the deduplication interval are\n treated as duplicates and only one copy of the message is\n delivered.

      \n
      • \n
    • \n

      If you send one message with ContentBasedDeduplication\n enabled and then another message with a\n MessageDeduplicationId that is the same as the one\n generated for the first MessageDeduplicationId, the two\n messages are treated as duplicates and only one copy of the message is\n delivered.

      \n
      • \n
    \n
    • \n
\n

The following attributes apply only to \nhigh throughput\nfor FIFO queues:

\n
    \n
  • \n

    \n DeduplicationScope – Specifies whether message deduplication occurs at the \n message group or queue level. Valid values are messageGroup and queue.

    \n
    • \n
  • \n

    \n FifoThroughputLimit – Specifies whether the FIFO queue throughput \n quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. \n The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup.

    \n
    • \n
\n

To enable high throughput for FIFO queues, do the following:

\n
    \n
  • \n

    Set DeduplicationScope to messageGroup.

    \n
    • \n
  • \n

    Set FifoThroughputLimit to perMessageGroupId.

    \n
    • \n
\n

If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified.

\n

For information on throughput quotas, \n see Quotas related to messages \n in the Amazon SQS Developer Guide.

", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Attribute" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#StartMessageMoveTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#StartMessageMoveTaskRequest" + }, + "output": { + "target": "com.amazonaws.sqs#StartMessageMoveTaskResult" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "

Starts an asynchronous task to move messages from a specified source queue to a\n specified destination queue.

\n \n
    \n
  • \n

    This action is currently limited to supporting message redrive from queues\n that are configured as dead-letter queues (DLQs) of other Amazon SQS queues only. Non-SQS\n queue sources of dead-letter queues, such as Lambda or Amazon SNS topics, are\n currently not supported.

    \n
    • \n
  • \n

    In dead-letter queues redrive context, the\n StartMessageMoveTask the source queue is the DLQ, while the\n destination queue can be the original source queue (from which the messages\n were driven to the dead-letter-queue), or a custom destination queue.

    \n
    • \n
  • \n

    Only one active message movement task is supported per queue at any given\n time.

    \n
    • \n
\n " + } + }, + "com.amazonaws.sqs#StartMessageMoveTaskRequest": { + "type": "structure", + "members": { + "SourceArn": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The ARN of the queue that contains the messages to be moved to another queue.\n Currently, only ARNs of dead-letter queues (DLQs) whose sources are other Amazon SQS queues\n are accepted. DLQs whose sources are non-SQS queues, such as Lambda or Amazon SNS topics, are\n not currently supported.

", + "smithy.api#required": {} + } + }, + "DestinationArn": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The ARN of the queue that receives the moved messages. You can use this field to\n specify the destination queue where you would like to redrive messages. If this field is\n left blank, the messages will be redriven back to their respective original source\n queues.

" + } + }, + "MaxNumberOfMessagesPerSecond": { + "target": "com.amazonaws.sqs#NullableInteger", + "traits": { + "smithy.api#documentation": "

The number of messages to be moved per second (the message movement rate). You can use\n this field to define a fixed message movement rate. The maximum value for messages per\n second is 500. If this field is left blank, the system will optimize the rate based on\n the queue message backlog size, which may vary throughout the duration of the message\n movement task.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#StartMessageMoveTaskResult": { + "type": "structure", + "members": { + "TaskHandle": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

An identifier associated with a message movement task. You can use this identifier to\n cancel a specified message movement task using the CancelMessageMoveTask\n action.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sqs#String": { + "type": "string" + }, + "com.amazonaws.sqs#StringList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#xmlName": "StringListValue" + } + } + }, + "com.amazonaws.sqs#TagKey": { + "type": "string" + }, + "com.amazonaws.sqs#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#TagKey" + } + }, + "com.amazonaws.sqs#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.sqs#TagKey", + "traits": { + "smithy.api#xmlName": "Key" + } + }, + "value": { + "target": "com.amazonaws.sqs#TagValue", + "traits": { + "smithy.api#xmlName": "Value" + } + } + }, + "com.amazonaws.sqs#TagQueue": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#TagQueueRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#QueueDoesNotExist" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "

Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging \nYour Amazon SQS Queues in the Amazon SQS Developer Guide.

\n

When you use queue tags, keep the following guidelines in mind:

\n
    \n
  • \n

    Adding more than 50 tags to a queue isn't recommended.

    \n
    • \n
  • \n

    Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings.

    \n
    • \n
  • \n

    Tags are case-sensitive.

    \n
    • \n
  • \n

    A new tag with a key identical to that of an existing tag overwrites the existing tag.

    \n
    • \n
\n

For a full list of tag restrictions, see \nQuotas related to queues \nin the Amazon SQS Developer Guide.

\n \n

Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.

\n " + } + }, + "com.amazonaws.sqs#TagQueueRequest": { + "type": "structure", + "members": { + "QueueUrl": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The URL of the queue.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sqs#TagMap", + "traits": { + "smithy.api#documentation": "

The list of tags to be added to the specified queue.

", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Tag" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#TagValue": { + "type": "string" + }, + "com.amazonaws.sqs#Token": { + "type": "string" + }, + "com.amazonaws.sqs#TooManyEntriesInBatchRequest": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AWS.SimpleQueueService.TooManyEntriesInBatchRequest", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The batch request contains more entries than permissible. For Amazon SQS, the\n maximum number of entries you can include in a single SendMessageBatch, DeleteMessageBatch, or ChangeMessageVisibilityBatch request is 10.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sqs#UnsupportedOperation": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AWS.SimpleQueueService.UnsupportedOperation", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Error code 400. Unsupported operation.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sqs#UntagQueue": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#UntagQueueRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#QueueDoesNotExist" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "

Remove cost allocation tags from the specified Amazon SQS queue. For an overview, see Tagging \nYour Amazon SQS Queues in the Amazon SQS Developer Guide.

\n \n

Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.

\n " + } + }, + "com.amazonaws.sqs#UntagQueueRequest": { + "type": "structure", + "members": { + "QueueUrl": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The URL of the queue.

", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.sqs#TagKeyList", + "traits": { + "smithy.api#documentation": "

The list of tags to be removed from the specified queue.

", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "TagKey" + } + } + }, + "traits": { + "smithy.api#input": {} + } + } + } +} \ No newline at end of file diff --git a/pkg/testdata/codegen/sdk-codegen/aws-models/wafv2.json b/pkg/testdata/codegen/sdk-codegen/aws-models/wafv2.json new file mode 100644 index 00000000..2a4d714e --- /dev/null +++ b/pkg/testdata/codegen/sdk-codegen/aws-models/wafv2.json @@ -0,0 +1,13073 @@ +{ + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.wafv2#APIKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.wafv2#APIKeySummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#APIKeySummary" + } + }, + "com.amazonaws.wafv2#APIKeySummary": { + "type": "structure", + "members": { + "TokenDomains": { + "target": "com.amazonaws.wafv2#TokenDomains", + "traits": { + "smithy.api#documentation": "

The token domains that are defined in this API key.

" + } + }, + "APIKey": { + "target": "com.amazonaws.wafv2#APIKey", + "traits": { + "smithy.api#documentation": "

The generated, encrypted API key. You can copy this for use in your JavaScript CAPTCHA integration.

" + } + }, + "CreationTimestamp": { + "target": "com.amazonaws.wafv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the key was created.

" + } + }, + "Version": { + "target": "com.amazonaws.wafv2#APIKeyVersion", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Internal value used by WAF to manage the key.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information for a single API key.

\n

API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. \n The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. \n For more information about the CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.

" + } + }, + "com.amazonaws.wafv2#APIKeyTokenDomains": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#TokenDomain" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.wafv2#APIKeyVersion": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.wafv2#AWSManagedRulesACFPRuleSet": { + "type": "structure", + "members": { + "CreationPath": { + "target": "com.amazonaws.wafv2#CreationPathString", + "traits": { + "smithy.api#documentation": "

The path of the account creation endpoint for your application. This is the page on your website that accepts the completed registration form for a new user. This page must accept POST requests.

\n

For example, for the URL https://example.com/web/newaccount, you would provide\n\tthe path /web/newaccount. Account creation page paths that\n\tstart with the path that you provide are considered a match. For example\n\t/web/newaccount matches the account creation paths\n\t\t/web/newaccount, /web/newaccount/,\n\t\t/web/newaccountPage, and\n\t\t/web/newaccount/thisPage, but doesn't match the path\n\t\t/home/web/newaccount or\n\t\t/website/newaccount.

", + "smithy.api#required": {} + } + }, + "RegistrationPagePath": { + "target": "com.amazonaws.wafv2#RegistrationPagePathString", + "traits": { + "smithy.api#documentation": "

The path of the account registration endpoint for your application. This is the page on your website that presents the registration form to new users.

\n \n

This page must accept GET text/html requests.

\n \n

For example, for the URL https://example.com/web/registration, you would provide\n\tthe path /web/registration. Registration page paths that\n\tstart with the path that you provide are considered a match. For example\n\t /web/registration matches the registration paths\n\t /web/registration, /web/registration/,\n\t /web/registrationPage, and\n\t /web/registration/thisPage, but doesn't match the path\n\t /home/web/registration or\n\t /website/registration.

", + "smithy.api#required": {} + } + }, + "RequestInspection": { + "target": "com.amazonaws.wafv2#RequestInspectionACFP", + "traits": { + "smithy.api#documentation": "

The criteria for inspecting account creation requests, used by the ACFP rule group to validate and track account creation attempts.

", + "smithy.api#required": {} + } + }, + "ResponseInspection": { + "target": "com.amazonaws.wafv2#ResponseInspection", + "traits": { + "smithy.api#documentation": "

The criteria for inspecting responses to account creation requests, used by the ACFP rule group to track account creation success rates.

\n \n

Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.

\n \n

The ACFP rule group evaluates the responses that your protected resources send back to client account creation attempts, keeping count of successful and failed attempts from each IP address and client session. Using this information, the rule group labels \n and mitigates requests from client sessions and IP addresses that have had too many successful account creation attempts in a short amount of time.

" + } + }, + "EnableRegexInPath": { + "target": "com.amazonaws.wafv2#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Allow the use of regular expressions in the registration page path and the account creation path.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details for your use of the account creation fraud prevention managed rule group, AWSManagedRulesACFPRuleSet. This configuration is used in ManagedRuleGroupConfig.

" + } + }, + "com.amazonaws.wafv2#AWSManagedRulesATPRuleSet": { + "type": "structure", + "members": { + "LoginPath": { + "target": "com.amazonaws.wafv2#String", + "traits": { + "smithy.api#documentation": "

The path of the login endpoint for your application. For example, for the URL\n https://example.com/web/login, you would provide the path\n /web/login. Login paths that start with the path that you provide are considered a match. For example /web/login matches the login paths /web/login, /web/login/, /web/loginPage, and /web/login/thisPage, but doesn't match the login path /home/web/login or /website/login.

\n

The rule group inspects only HTTP POST requests to your specified login endpoint.

", + "smithy.api#required": {} + } + }, + "RequestInspection": { + "target": "com.amazonaws.wafv2#RequestInspection", + "traits": { + "smithy.api#documentation": "

The criteria for inspecting login requests, used by the ATP rule group to validate credentials usage.

" + } + }, + "ResponseInspection": { + "target": "com.amazonaws.wafv2#ResponseInspection", + "traits": { + "smithy.api#documentation": "

The criteria for inspecting responses to login requests, used by the ATP rule group to track login failure rates.

\n \n

Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.

\n \n

The ATP rule group evaluates the responses that your protected resources send back to client login attempts, keeping count of successful and failed attempts for each IP address and client session. Using this information, the rule group labels \n and mitigates requests from client sessions and IP addresses that have had too many failed login attempts in a short amount of time.

" + } + }, + "EnableRegexInPath": { + "target": "com.amazonaws.wafv2#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Allow the use of regular expressions in the login page path.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details for your use of the account takeover prevention managed rule group, AWSManagedRulesATPRuleSet. This configuration is used in ManagedRuleGroupConfig.

" + } + }, + "com.amazonaws.wafv2#AWSManagedRulesBotControlRuleSet": { + "type": "structure", + "members": { + "InspectionLevel": { + "target": "com.amazonaws.wafv2#InspectionLevel", + "traits": { + "smithy.api#documentation": "

The inspection level to use for the Bot Control rule group. The common level is the least expensive. The \n targeted level includes all common level rules and adds rules with more advanced inspection criteria. For \n details, see WAF Bot Control rule group\n in the WAF Developer Guide.

", + "smithy.api#required": {} + } + }, + "EnableMachineLearning": { + "target": "com.amazonaws.wafv2#EnableMachineLearning", + "traits": { + "smithy.api#default": true, + "smithy.api#documentation": "

Applies only to the targeted inspection level.

\n

Determines whether to use machine learning (ML) to\n analyze your web traffic for bot-related activity. Machine learning is required for the Bot Control rules TGT_ML_CoordinatedActivityLow and TGT_ML_CoordinatedActivityMedium, which\ninspect for anomalous behavior that might indicate distributed, coordinated bot activity.

\n

For more information about this choice, see the listing for these rules in the table at Bot Control rules listing in the\n WAF Developer Guide.

\n

Default: TRUE\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details for your use of the Bot Control managed rule group, AWSManagedRulesBotControlRuleSet. This configuration is used in ManagedRuleGroupConfig.

" + } + }, + "com.amazonaws.wafv2#AWSWAF_20190729": { + "type": "service", + "version": "2019-07-29", + "operations": [ + { + "target": "com.amazonaws.wafv2#AssociateWebACL" + }, + { + "target": "com.amazonaws.wafv2#CheckCapacity" + }, + { + "target": "com.amazonaws.wafv2#CreateAPIKey" + }, + { + "target": "com.amazonaws.wafv2#CreateIPSet" + }, + { + "target": "com.amazonaws.wafv2#CreateRegexPatternSet" + }, + { + "target": "com.amazonaws.wafv2#CreateRuleGroup" + }, + { + "target": "com.amazonaws.wafv2#CreateWebACL" + }, + { + "target": "com.amazonaws.wafv2#DeleteAPIKey" + }, + { + "target": "com.amazonaws.wafv2#DeleteFirewallManagerRuleGroups" + }, + { + "target": "com.amazonaws.wafv2#DeleteIPSet" + }, + { + "target": "com.amazonaws.wafv2#DeleteLoggingConfiguration" + }, + { + "target": "com.amazonaws.wafv2#DeletePermissionPolicy" + }, + { + "target": "com.amazonaws.wafv2#DeleteRegexPatternSet" + }, + { + "target": "com.amazonaws.wafv2#DeleteRuleGroup" + }, + { + "target": "com.amazonaws.wafv2#DeleteWebACL" + }, + { + "target": "com.amazonaws.wafv2#DescribeAllManagedProducts" + }, + { + "target": "com.amazonaws.wafv2#DescribeManagedProductsByVendor" + }, + { + "target": "com.amazonaws.wafv2#DescribeManagedRuleGroup" + }, + { + "target": "com.amazonaws.wafv2#DisassociateWebACL" + }, + { + "target": "com.amazonaws.wafv2#GenerateMobileSdkReleaseUrl" + }, + { + "target": "com.amazonaws.wafv2#GetDecryptedAPIKey" + }, + { + "target": "com.amazonaws.wafv2#GetIPSet" + }, + { + "target": "com.amazonaws.wafv2#GetLoggingConfiguration" + }, + { + "target": "com.amazonaws.wafv2#GetManagedRuleSet" + }, + { + "target": "com.amazonaws.wafv2#GetMobileSdkRelease" + }, + { + "target": "com.amazonaws.wafv2#GetPermissionPolicy" + }, + { + "target": "com.amazonaws.wafv2#GetRateBasedStatementManagedKeys" + }, + { + "target": "com.amazonaws.wafv2#GetRegexPatternSet" + }, + { + "target": "com.amazonaws.wafv2#GetRuleGroup" + }, + { + "target": "com.amazonaws.wafv2#GetSampledRequests" + }, + { + "target": "com.amazonaws.wafv2#GetWebACL" + }, + { + "target": "com.amazonaws.wafv2#GetWebACLForResource" + }, + { + "target": "com.amazonaws.wafv2#ListAPIKeys" + }, + { + "target": "com.amazonaws.wafv2#ListAvailableManagedRuleGroups" + }, + { + "target": "com.amazonaws.wafv2#ListAvailableManagedRuleGroupVersions" + }, + { + "target": "com.amazonaws.wafv2#ListIPSets" + }, + { + "target": "com.amazonaws.wafv2#ListLoggingConfigurations" + }, + { + "target": "com.amazonaws.wafv2#ListManagedRuleSets" + }, + { + "target": "com.amazonaws.wafv2#ListMobileSdkReleases" + }, + { + "target": "com.amazonaws.wafv2#ListRegexPatternSets" + }, + { + "target": "com.amazonaws.wafv2#ListResourcesForWebACL" + }, + { + "target": "com.amazonaws.wafv2#ListRuleGroups" + }, + { + "target": "com.amazonaws.wafv2#ListTagsForResource" + }, + { + "target": "com.amazonaws.wafv2#ListWebACLs" + }, + { + "target": "com.amazonaws.wafv2#PutLoggingConfiguration" + }, + { + "target": "com.amazonaws.wafv2#PutManagedRuleSetVersions" + }, + { + "target": "com.amazonaws.wafv2#PutPermissionPolicy" + }, + { + "target": "com.amazonaws.wafv2#TagResource" + }, + { + "target": "com.amazonaws.wafv2#UntagResource" + }, + { + "target": "com.amazonaws.wafv2#UpdateIPSet" + }, + { + "target": "com.amazonaws.wafv2#UpdateManagedRuleSetVersionExpiryDate" + }, + { + "target": "com.amazonaws.wafv2#UpdateRegexPatternSet" + }, + { + "target": "com.amazonaws.wafv2#UpdateRuleGroup" + }, + { + "target": "com.amazonaws.wafv2#UpdateWebACL" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "WAFV2", + "arnNamespace": "wafv2", + "cloudFormationName": "WAFv2", + "cloudTrailEventSource": "wafv2.amazonaws.com", + "endpointPrefix": "wafv2" + }, + "aws.auth#sigv4": { + "name": "wafv2" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "WAF\n \n

This is the latest version of the WAF API,\n released in November, 2019. The names of the entities that you use to access this API,\n like endpoints and namespaces, all have the versioning information added, like \"V2\" or\n \"v2\", to distinguish from the prior version. We recommend migrating your resources to\n this version, because it has a number of significant improvements.

\n

If you used WAF prior to this release, you can't use this WAFV2 API to access any\n WAF resources that you created before. WAF Classic support will end on September 30, 2025.

\n

For information about WAF, including how to migrate your WAF Classic resources to this version,\n see the WAF Developer Guide.

\n \n

WAF is a web application firewall that lets you monitor the HTTP and HTTPS\n requests that are forwarded to an Amazon CloudFront distribution, Amazon API Gateway REST API, Application Load Balancer, AppSync\n GraphQL API, Amazon Cognito user pool, App Runner service, or Amazon Web Services Verified Access instance. WAF also lets you control access to your content,\n to protect the Amazon Web Services resource that WAF is monitoring. Based on conditions that\n you specify, such as the IP addresses that requests originate from or the values of query\n strings, the protected resource responds to requests with either the requested content, an HTTP 403 status code\n (Forbidden), or with a custom response.

\n

This API guide is for developers who need detailed information about WAF API actions,\n data types, and errors. For detailed information about WAF features and guidance for configuring and using \n WAF, see the WAF Developer\n Guide.

\n

You can make calls using the endpoints listed in WAF endpoints and quotas.

\n
    \n
  • \n

    For regional applications, you can use any of the endpoints in the list.\n A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

    \n
    • \n
  • \n

    For Amazon CloudFront applications, you must use the API endpoint listed for\n US East (N. Virginia): us-east-1.

    \n
    • \n
\n

Alternatively, you can use one of the Amazon Web Services SDKs to access an API that's tailored to the\n programming language or platform that you're using. For more information, see Amazon Web Services SDKs.

", + "smithy.api#title": "AWS WAFV2", + "smithy.api#xmlNamespace": { + "uri": "http://waf.amazonaws.com/doc/2019-07-29/" + }, + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://wafv2-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://wafv2-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://wafv2.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://wafv2.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.af-south-1.amazonaws.com" + } + }, + "params": { + "Region": "af-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region af-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.af-south-1.amazonaws.com" + } + }, + "params": { + "Region": "af-south-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.ap-east-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.ap-east-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-3", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.ap-south-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.ap-south-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.eu-north-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.eu-north-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.eu-south-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.eu-south-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-south-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.eu-west-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.eu-west-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.eu-west-3.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.eu-west-3.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-3", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.me-south-1.amazonaws.com" + } + }, + "params": { + "Region": "me-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.me-south-1.amazonaws.com" + } + }, + "params": { + "Region": "me-south-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.sa-east-1.amazonaws.com" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.sa-east-1.amazonaws.com" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://wafv2.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://wafv2.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://wafv2.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.wafv2#Action": { + "type": "string" + }, + "com.amazonaws.wafv2#ActionCondition": { + "type": "structure", + "members": { + "Action": { + "target": "com.amazonaws.wafv2#ActionValue", + "traits": { + "smithy.api#documentation": "

The action setting that a log record must contain in order to meet the condition. This is the action that WAF applied to the web request.

\n

For rule groups, this is either the configured rule action setting, or if you've applied a rule action override to the rule, it's the override action. \n The value EXCLUDED_AS_COUNT matches on \n excluded rules and also on rules that have a rule action override of Count.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A single action condition for a Condition in a logging filter.

" + } + }, + "com.amazonaws.wafv2#ActionValue": { + "type": "enum", + "members": { + "ALLOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALLOW" + } + }, + "BLOCK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BLOCK" + } + }, + "COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COUNT" + } + }, + "CAPTCHA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CAPTCHA" + } + }, + "CHALLENGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CHALLENGE" + } + }, + "EXCLUDED_AS_COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXCLUDED_AS_COUNT" + } + } + } + }, + "com.amazonaws.wafv2#AddressField": { + "type": "structure", + "members": { + "Identifier": { + "target": "com.amazonaws.wafv2#FieldIdentifier", + "traits": { + "smithy.api#documentation": "

The name of a single primary address field.

\n

How you specify the address fields depends on the request inspection payload type.

\n
    \n
  • \n

    For JSON payloads, specify the field identifiers in JSON\n pointer syntax. For information about the JSON Pointer\n syntax, see the Internet Engineering Task Force (IETF)\n documentation JavaScript\n \tObject Notation (JSON) Pointer.

    \n

    For example, for the JSON payload { \"form\": { \"primaryaddressline1\": \"THE_ADDRESS1\", \"primaryaddressline2\": \"THE_ADDRESS2\", \"primaryaddressline3\": \"THE_ADDRESS3\" } }, \n the address field idenfiers are /form/primaryaddressline1, /form/primaryaddressline2, and /form/primaryaddressline3.

    \n
    • \n
  • \n

    For form encoded payload types, use the HTML form names.

    \n

    For example, for an HTML form with input elements\n named primaryaddressline1, primaryaddressline2, and primaryaddressline3, the address fields identifiers are primaryaddressline1, primaryaddressline2, and primaryaddressline3.

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The name of a field in the request payload that contains part or all of your customer's primary physical address.

\n

This data type is used in the RequestInspectionACFP data type.

" + } + }, + "com.amazonaws.wafv2#AddressFields": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#AddressField" + } + }, + "com.amazonaws.wafv2#All": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Inspect all of the elements that WAF has parsed and extracted from the web request\n component that you've identified in your FieldToMatch specifications.

\n

This is used in the FieldToMatch specification for some web request component types.

\n

JSON specification: \"All\": {}\n

" + } + }, + "com.amazonaws.wafv2#AllQueryArguments": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Inspect all query arguments of the web request.

\n

This is used in the FieldToMatch specification for some web request component types.

\n

JSON specification: \"AllQueryArguments\": {}\n

" + } + }, + "com.amazonaws.wafv2#AllowAction": { + "type": "structure", + "members": { + "CustomRequestHandling": { + "target": "com.amazonaws.wafv2#CustomRequestHandling", + "traits": { + "smithy.api#documentation": "

Defines custom handling for the web request.

\n

For information about customizing web requests and responses, \n see Customizing web requests and responses in WAF \n in the WAF Developer Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies that WAF should allow the request and optionally defines additional\n custom handling for the request.

\n

This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.

" + } + }, + "com.amazonaws.wafv2#AndStatement": { + "type": "structure", + "members": { + "Statements": { + "target": "com.amazonaws.wafv2#Statements", + "traits": { + "smithy.api#documentation": "

The statements to combine with AND logic. You can use any statements that can be nested.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A logical rule statement used to combine other rule statements with AND logic. You provide more than one Statement within the AndStatement.

" + } + }, + "com.amazonaws.wafv2#AssociateWebACL": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#AssociateWebACLRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#AssociateWebACLResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFUnavailableEntityException" + } + ], + "traits": { + "smithy.api#documentation": "

Associates a web ACL with a regional application resource, to protect the resource.\n A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To\n associate a web ACL, in the CloudFront call UpdateDistribution, set the web ACL ID\n to the Amazon Resource Name (ARN) of the web ACL. For information, see UpdateDistribution in the Amazon CloudFront Developer Guide.

\n

\n Required permissions for customer-managed IAM policies\n

\n

This call requires permissions that are specific to the protected resource type. \n For details, see Permissions for AssociateWebACL in the WAF Developer Guide.

\n

\n Temporary inconsistencies during updates\n

\n

When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.

\n

The following are examples of the temporary inconsistencies that you might notice during change propagation:

\n
    \n
  • \n

    After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable.

    \n
    • \n
  • \n

    After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.

    \n
    • \n
  • \n

    After you change a rule action setting, you might see the old action in some places and the new action in others.

    \n
    • \n
  • \n

    After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.

    \n
    • \n
" + } + }, + "com.amazonaws.wafv2#AssociateWebACLRequest": { + "type": "structure", + "members": { + "WebACLArn": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the web ACL that you want to associate with the\n resource.

", + "smithy.api#required": {} + } + }, + "ResourceArn": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to associate with the web ACL.

\n

The ARN must be in one of the following formats:

\n
    \n
  • \n

    For an Application Load Balancer: arn:partition:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id\n \n

    \n
    • \n
  • \n

    For an Amazon API Gateway REST API: arn:partition:apigateway:region::/restapis/api-id/stages/stage-name\n \n

    \n
    • \n
  • \n

    For an AppSync GraphQL API: arn:partition:appsync:region:account-id:apis/GraphQLApiId\n \n

    \n
    • \n
  • \n

    For an Amazon Cognito user pool: arn:partition:cognito-idp:region:account-id:userpool/user-pool-id\n \n

    \n
    • \n
  • \n

    For an App Runner service: arn:partition:apprunner:region:account-id:service/apprunner-service-name/apprunner-service-id\n \n

    \n
    • \n
  • \n

    For an Amazon Web Services Verified Access instance: arn:partition:ec2:region:account-id:verified-access-instance/instance-id\n \n

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#AssociateWebACLResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#AssociatedResourceType": { + "type": "enum", + "members": { + "CLOUDFRONT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLOUDFRONT" + } + }, + "API_GATEWAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "API_GATEWAY" + } + }, + "COGNITO_USER_POOL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COGNITO_USER_POOL" + } + }, + "APP_RUNNER_SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APP_RUNNER_SERVICE" + } + }, + "VERIFIED_ACCESS_INSTANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VERIFIED_ACCESS_INSTANCE" + } + } + } + }, + "com.amazonaws.wafv2#AssociationConfig": { + "type": "structure", + "members": { + "RequestBody": { + "target": "com.amazonaws.wafv2#RequestBody", + "traits": { + "smithy.api#documentation": "

Customizes the maximum size of the request body that your protected CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access resources forward to WAF for inspection. The default size is 16 KB (16,384 bytes). You can change the setting for any of the available resource types.

\n \n

You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.

\n \n

Example JSON: {\n \"API_GATEWAY\": \"KB_48\",\n \"APP_RUNNER_SERVICE\": \"KB_32\"\n }\n

\n

For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies custom configurations for the associations between the web ACL and protected resources.

\n

Use this to customize the maximum size of the request body that your protected resources forward to WAF for inspection. You can \n customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).

\n \n

You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.

\n \n

For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).

" + } + }, + "com.amazonaws.wafv2#BlockAction": { + "type": "structure", + "members": { + "CustomResponse": { + "target": "com.amazonaws.wafv2#CustomResponse", + "traits": { + "smithy.api#documentation": "

Defines a custom response for the web request.

\n

For information about customizing web requests and responses, \n see Customizing web requests and responses in WAF \n in the WAF Developer Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies that WAF should block the request and optionally defines additional\n custom handling for the response to the web request.

\n

This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.

" + } + }, + "com.amazonaws.wafv2#Body": { + "type": "structure", + "members": { + "OversizeHandling": { + "target": "com.amazonaws.wafv2#OversizeHandling", + "traits": { + "smithy.api#documentation": "

What WAF should do if the body is larger than WAF can inspect.

\n

WAF does not support inspecting the entire contents of the web request body if the body \n exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service \n only forwards the contents that are within the limit to WAF for inspection.

\n
    \n
  • \n

    For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).

    \n
    • \n
  • \n

    For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and \n you can increase the limit for each resource type in the web ACL AssociationConfig, for additional processing fees.

    \n
    • \n
\n

The options for oversize handling are the following:

\n
    \n
  • \n

    \n CONTINUE - Inspect the available body contents normally, according to the rule inspection criteria.

    \n
    • \n
  • \n

    \n MATCH - Treat the web request as matching the rule statement. WAF\n applies the rule action to the request.

    \n
    • \n
  • \n

    \n NO_MATCH - Treat the web request as not matching the rule\n statement.

    \n
    • \n
\n

You can combine the MATCH or NO_MATCH\n settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit.

\n

Default: CONTINUE\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Inspect the body of the web request. The body immediately follows the request\n headers.

\n

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

" + } + }, + "com.amazonaws.wafv2#BodyParsingFallbackBehavior": { + "type": "enum", + "members": { + "MATCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MATCH" + } + }, + "NO_MATCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_MATCH" + } + }, + "EVALUATE_AS_STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EVALUATE_AS_STRING" + } + } + } + }, + "com.amazonaws.wafv2#Boolean": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.wafv2#ByteMatchStatement": { + "type": "structure", + "members": { + "SearchString": { + "target": "com.amazonaws.wafv2#SearchString", + "traits": { + "smithy.api#documentation": "

A string value that you want WAF to search for. WAF searches only in the part of\n web requests that you designate for inspection in FieldToMatch. The\n maximum length of the value is 200 bytes.

\n

Valid values depend on the component that you specify for inspection in\n FieldToMatch:

\n
    \n
  • \n

    \n Method: The HTTP method that you want WAF to search for. This\n indicates the type of operation specified in the request.

    \n
    • \n
  • \n

    \n UriPath: The value that you want WAF to search for in the URI path,\n for example, /images/daily-ad.jpg.

    \n
    • \n
  • \n

    \n JA3Fingerprint: Available for use with Amazon CloudFront distributions and Application Load Balancers. Match against the request's JA3 fingerprint. The JA3 fingerprint is a 32-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. You can use this choice only with a string match ByteMatchStatement with the PositionalConstraint set to \n EXACTLY.

    \n

    You can obtain the JA3 fingerprint for client requests from the web ACL logs. \n\t\t\t\t\t\tIf WAF is able to calculate the fingerprint, it includes it in the logs. \n\t\t\t\t\t\tFor information about the logging fields, \nsee Log fields in the WAF Developer Guide.

    \n
    • \n
  • \n

    \n HeaderOrder: The list of header names to match for. WAF creates a \n string that contains the ordered list of header names, from the headers in the web request, and then matches against that string.

    \n
    • \n
\n

If SearchString includes alphabetic characters A-Z and a-z, note that the\n value is case sensitive.

\n

\n If you're using the WAF API\n

\n

Specify a base64-encoded version of the value. The maximum length of the value before\n you base64-encode it is 200 bytes.

\n

For example, suppose the value of Type is HEADER and the value\n of Data is User-Agent. If you want to search the\n User-Agent header for the value BadBot, you base64-encode\n BadBot using MIME base64-encoding and include the resulting value,\n QmFkQm90, in the value of SearchString.

\n

\n If you're using the CLI or one of the Amazon Web Services SDKs\n

\n

The value that you want WAF to search for. The SDK automatically base64 encodes the\n value.

", + "smithy.api#required": {} + } + }, + "FieldToMatch": { + "target": "com.amazonaws.wafv2#FieldToMatch", + "traits": { + "smithy.api#documentation": "

The part of the web request that you want WAF to inspect.

", + "smithy.api#required": {} + } + }, + "TextTransformations": { + "target": "com.amazonaws.wafv2#TextTransformations", + "traits": { + "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.

", + "smithy.api#required": {} + } + }, + "PositionalConstraint": { + "target": "com.amazonaws.wafv2#PositionalConstraint", + "traits": { + "smithy.api#documentation": "

The area within the portion of the web request that you want WAF to search for\n SearchString. Valid values include the following:

\n

\n CONTAINS\n

\n

The specified part of the web request must include the value of\n SearchString, but the location doesn't matter.

\n

\n CONTAINS_WORD\n

\n

The specified part of the web request must include the value of\n SearchString, and SearchString must contain only alphanumeric\n characters or underscore (A-Z, a-z, 0-9, or _). In addition, SearchString must\n be a word, which means that both of the following are true:

\n
    \n
  • \n

    \n SearchString is at the beginning of the specified part of the web\n request or is preceded by a character other than an alphanumeric character or\n underscore (_). Examples include the value of a header and\n ;BadBot.

    \n
    • \n
  • \n

    \n SearchString is at the end of the specified part of the web request or\n is followed by a character other than an alphanumeric character or underscore (_),\n for example, BadBot; and -BadBot;.

    \n
    • \n
\n

\n EXACTLY\n

\n

The value of the specified part of the web request must exactly match the value of\n SearchString.

\n

\n STARTS_WITH\n

\n

The value of SearchString must appear at the beginning of the specified\n part of the web request.

\n

\n ENDS_WITH\n

\n

The value of SearchString must appear at the end of the specified part of\n the web request.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A rule statement that defines a string match search for WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the WAF console and the developer guide, this is called a string match statement.

" + } + }, + "com.amazonaws.wafv2#CapacityUnit": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.wafv2#CaptchaAction": { + "type": "structure", + "members": { + "CustomRequestHandling": { + "target": "com.amazonaws.wafv2#CustomRequestHandling", + "traits": { + "smithy.api#documentation": "

Defines custom handling for the web request, used when the CAPTCHA inspection determines that the request's token is valid and unexpired.

\n

For information about customizing web requests and responses, \n see Customizing web requests and responses in WAF \n in the WAF Developer Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies that WAF should run a CAPTCHA check against the request:

\n
    \n
  • \n

    If the request includes a valid, unexpired CAPTCHA token,\n WAF applies any custom request handling and labels that you've configured and then allows the web request inspection to \n proceed to the next rule, similar to a CountAction.

    \n
    • \n
  • \n

    If the request doesn't include a valid, unexpired token, WAF \n discontinues the web ACL evaluation of the request and blocks it from going to its intended destination.

    \n

    WAF generates a response that it sends back to the client, which includes the following:

    \n
      \n
    • \n

      The header x-amzn-waf-action with a value of captcha.

      \n
      • \n
    • \n

      The HTTP status code 405 Method Not Allowed.

      \n
      • \n
    • \n

      If the request contains an Accept header with a value of text/html, the response includes a CAPTCHA JavaScript page interstitial.

      \n
      • \n
    \n
    • \n
\n

You can configure the expiration time \n in the CaptchaConfig\n ImmunityTimeProperty setting at the rule and web ACL level. The rule setting overrides the web ACL setting.

\n

This action option is available for rules. It isn't available for web ACL default actions.

" + } + }, + "com.amazonaws.wafv2#CaptchaConfig": { + "type": "structure", + "members": { + "ImmunityTimeProperty": { + "target": "com.amazonaws.wafv2#ImmunityTimeProperty", + "traits": { + "smithy.api#documentation": "

Determines how long a CAPTCHA timestamp in the token remains valid after the client\n successfully solves a CAPTCHA puzzle.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies how WAF should handle CAPTCHA evaluations. This is\n available at the web ACL level and in each rule.

" + } + }, + "com.amazonaws.wafv2#CaptchaResponse": { + "type": "structure", + "members": { + "ResponseCode": { + "target": "com.amazonaws.wafv2#ResponseCode", + "traits": { + "smithy.api#documentation": "

The HTTP response code indicating the status of the CAPTCHA token in the\n web request. If the token is missing, invalid, or expired, this code is 405 Method\n Not Allowed.

" + } + }, + "SolveTimestamp": { + "target": "com.amazonaws.wafv2#SolveTimestamp", + "traits": { + "smithy.api#documentation": "

The time that the CAPTCHA was last solved for the supplied token.

" + } + }, + "FailureReason": { + "target": "com.amazonaws.wafv2#FailureReason", + "traits": { + "smithy.api#documentation": "

The reason for failure, populated when the evaluation of the token fails.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The result from the inspection of the web request for a valid CAPTCHA token.

" + } + }, + "com.amazonaws.wafv2#ChallengeAction": { + "type": "structure", + "members": { + "CustomRequestHandling": { + "target": "com.amazonaws.wafv2#CustomRequestHandling", + "traits": { + "smithy.api#documentation": "

Defines custom handling for the web request, used when the challenge inspection determines that the request's token is valid and unexpired.

\n

For information about customizing web requests and responses, \n see Customizing web requests and responses in WAF \n in the WAF Developer Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies that WAF should run a Challenge check against the request to verify that the request is coming from a legitimate client session:

\n
    \n
  • \n

    If the request includes a valid, unexpired challenge token,\n WAF applies any custom request handling and labels that you've configured and then allows the web request inspection to \n proceed to the next rule, similar to a CountAction.

    \n
    • \n
  • \n

    If the request doesn't include a valid, unexpired challenge token, WAF \n discontinues the web ACL evaluation of the request and blocks it from going to its intended destination.

    \n

    WAF then generates a challenge response that it sends back to the client, which includes the following:

    \n
      \n
    • \n

      The header x-amzn-waf-action with a value of challenge.

      \n
      • \n
    • \n

      The HTTP status code 202 Request Accepted.

      \n
      • \n
    • \n

      If the request contains an Accept header with a value of text/html, the response includes a JavaScript page interstitial with a challenge script.

      \n
      • \n
    \n

    Challenges run silent browser interrogations in the background, and don't generally affect the end user experience.

    \n

    A challenge enforces token acquisition using an interstitial JavaScript challenge that inspects the client session for legitimate behavior. The challenge blocks bots or at least increases the cost of operating sophisticated bots.

    \n

    After the client session successfully responds to \n the challenge, it receives a new token from WAF, which the challenge script uses to resubmit the original request.

    \n
    • \n
\n

You can configure the expiration time \n in the ChallengeConfig\n ImmunityTimeProperty setting at the rule and web ACL level. The rule setting overrides the web ACL setting.

\n

This action option is available for rules. It isn't available for web ACL default actions.

" + } + }, + "com.amazonaws.wafv2#ChallengeConfig": { + "type": "structure", + "members": { + "ImmunityTimeProperty": { + "target": "com.amazonaws.wafv2#ImmunityTimeProperty", + "traits": { + "smithy.api#documentation": "

Determines how long a challenge timestamp in the token remains valid after the client\n successfully responds to a challenge.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies how WAF should handle Challenge evaluations. This is\n available at the web ACL level and in each rule.

" + } + }, + "com.amazonaws.wafv2#ChallengeResponse": { + "type": "structure", + "members": { + "ResponseCode": { + "target": "com.amazonaws.wafv2#ResponseCode", + "traits": { + "smithy.api#documentation": "

The HTTP response code indicating the status of the challenge token in the\n web request. If the token is missing, invalid, or expired, this code is 202 Request Accepted.

" + } + }, + "SolveTimestamp": { + "target": "com.amazonaws.wafv2#SolveTimestamp", + "traits": { + "smithy.api#documentation": "

The time that the challenge was last solved for the supplied token.

" + } + }, + "FailureReason": { + "target": "com.amazonaws.wafv2#FailureReason", + "traits": { + "smithy.api#documentation": "

The reason for failure, populated when the evaluation of the token fails.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The result from the inspection of the web request for a valid challenge token.

" + } + }, + "com.amazonaws.wafv2#CheckCapacity": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#CheckCapacityRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#CheckCapacityResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFExpiredManagedRuleGroupVersionException" + }, + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidResourceException" + }, + { + "target": "com.amazonaws.wafv2#WAFLimitsExceededException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFSubscriptionNotFoundException" + }, + { + "target": "com.amazonaws.wafv2#WAFUnavailableEntityException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the web ACL capacity unit (WCU) requirements for a specified scope and set of rules. \n You can use this to check the capacity requirements for the rules you want to use in a \n RuleGroup or WebACL. \n

\n

WAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) \n in the WAF Developer Guide.

" + } + }, + "com.amazonaws.wafv2#CheckCapacityRequest": { + "type": "structure", + "members": { + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n
    \n
  • \n

    CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    \n
    • \n
  • \n

    API and SDKs - For all calls, use the Region endpoint us-east-1.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Rules": { + "target": "com.amazonaws.wafv2#Rules", + "traits": { + "smithy.api#documentation": "

An array of Rule that you're configuring to use in a rule group or web\n ACL.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#CheckCapacityResponse": { + "type": "structure", + "members": { + "Capacity": { + "target": "com.amazonaws.wafv2#ConsumedCapacity", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The capacity required by the rules and scope.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#ComparisonOperator": { + "type": "enum", + "members": { + "EQ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQ" + } + }, + "NE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NE" + } + }, + "LE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LE" + } + }, + "LT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LT" + } + }, + "GE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GE" + } + }, + "GT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GT" + } + } + } + }, + "com.amazonaws.wafv2#Condition": { + "type": "structure", + "members": { + "ActionCondition": { + "target": "com.amazonaws.wafv2#ActionCondition", + "traits": { + "smithy.api#documentation": "

A single action condition. This is the action setting that a log record must contain in order to meet the condition.

" + } + }, + "LabelNameCondition": { + "target": "com.amazonaws.wafv2#LabelNameCondition", + "traits": { + "smithy.api#documentation": "

A single label name condition. This is the fully qualified label name that a log record must contain in order to meet the condition. \n Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A single match condition for a Filter.

" + } + }, + "com.amazonaws.wafv2#Conditions": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#Condition" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.wafv2#ConsumedCapacity": { + "type": "long", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.wafv2#CookieMatchPattern": { + "type": "structure", + "members": { + "All": { + "target": "com.amazonaws.wafv2#All", + "traits": { + "smithy.api#documentation": "

Inspect all cookies.

" + } + }, + "IncludedCookies": { + "target": "com.amazonaws.wafv2#CookieNames", + "traits": { + "smithy.api#documentation": "

Inspect only the cookies that have a key that matches one of the strings specified here.\n

" + } + }, + "ExcludedCookies": { + "target": "com.amazonaws.wafv2#CookieNames", + "traits": { + "smithy.api#documentation": "

Inspect only the cookies whose keys don't match any of the strings specified here.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The filter to use to identify the subset of cookies to inspect in a web request.

\n

You must specify exactly one setting: either All, IncludedCookies, or ExcludedCookies.

\n

Example JSON: \"MatchPattern\": { \"IncludedCookies\": [ \"session-id-time\", \"session-id\" ] }\n

" + } + }, + "com.amazonaws.wafv2#CookieNames": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#SingleCookieName" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 199 + } + } + }, + "com.amazonaws.wafv2#Cookies": { + "type": "structure", + "members": { + "MatchPattern": { + "target": "com.amazonaws.wafv2#CookieMatchPattern", + "traits": { + "smithy.api#documentation": "

The filter to use to identify the subset of cookies to inspect in a web request.

\n

You must specify exactly one setting: either All, IncludedCookies, or ExcludedCookies.

\n

Example JSON: \"MatchPattern\": { \"IncludedCookies\": [ \"session-id-time\", \"session-id\" ] }\n

", + "smithy.api#required": {} + } + }, + "MatchScope": { + "target": "com.amazonaws.wafv2#MapMatchScope", + "traits": { + "smithy.api#documentation": "

The parts of the cookies to inspect with the rule inspection criteria. If you specify\n ALL, WAF inspects both keys and values.

\n

\n All does not require a match to be found in the keys\n and a match to be found in the values. It requires a match to be found in the keys \n or the values or both. To require a match in the keys and in the values, use a logical AND statement\n to combine two match rules, one that inspects the keys and another that inspects the values.

", + "smithy.api#required": {} + } + }, + "OversizeHandling": { + "target": "com.amazonaws.wafv2#OversizeHandling", + "traits": { + "smithy.api#documentation": "

What WAF should do if the cookies of the request are more numerous or larger than WAF can inspect. \n WAF does not support inspecting the entire contents of request cookies \n when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies\n and at most 8 KB of cookie contents to WAF.

\n

The options for oversize handling are the following:

\n
    \n
  • \n

    \n CONTINUE - Inspect the available cookies normally, according to the rule inspection criteria.

    \n
    • \n
  • \n

    \n MATCH - Treat the web request as matching the rule statement. WAF\n applies the rule action to the request.

    \n
    • \n
  • \n

    \n NO_MATCH - Treat the web request as not matching the rule\n statement.

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Inspect the cookies in the web request. You can specify the parts of the cookies to\n inspect and you can narrow the set of cookies to inspect by including or excluding specific\n keys.

\n

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

\n

Example JSON: \"Cookies\": { \"MatchPattern\": { \"All\": {} }, \"MatchScope\": \"KEY\",\n \"OversizeHandling\": \"MATCH\" }\n

" + } + }, + "com.amazonaws.wafv2#CountAction": { + "type": "structure", + "members": { + "CustomRequestHandling": { + "target": "com.amazonaws.wafv2#CustomRequestHandling", + "traits": { + "smithy.api#documentation": "

Defines custom handling for the web request.

\n

For information about customizing web requests and responses, \n see Customizing web requests and responses in WAF \n in the WAF Developer Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies that WAF should count the request. Optionally defines additional custom\n handling for the request.

\n

This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.

" + } + }, + "com.amazonaws.wafv2#Country": { + "type": "string" + }, + "com.amazonaws.wafv2#CountryCode": { + "type": "enum", + "members": { + "AF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AF" + } + }, + "AX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AX" + } + }, + "AL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AL" + } + }, + "DZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DZ" + } + }, + "AS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AS" + } + }, + "AD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AD" + } + }, + "AO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AO" + } + }, + "AI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AI" + } + }, + "AQ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AQ" + } + }, + "AG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AG" + } + }, + "AR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AR" + } + }, + "AM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AM" + } + }, + "AW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AW" + } + }, + "AU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AU" + } + }, + "AT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AT" + } + }, + "AZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AZ" + } + }, + "BS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BS" + } + }, + "BH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BH" + } + }, + "BD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BD" + } + }, + "BB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BB" + } + }, + "BY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BY" + } + }, + "BE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BE" + } + }, + "BZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BZ" + } + }, + "BJ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BJ" + } + }, + "BM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BM" + } + }, + "BT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BT" + } + }, + "BO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BO" + } + }, + "BQ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BQ" + } + }, + "BA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BA" + } + }, + "BW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BW" + } + }, + "BV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BV" + } + }, + "BR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BR" + } + }, + "IO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IO" + } + }, + "BN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BN" + } + }, + "BG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BG" + } + }, + "BF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BF" + } + }, + "BI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BI" + } + }, + "KH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KH" + } + }, + "CM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CM" + } + }, + "CA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CA" + } + }, + "CV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CV" + } + }, + "KY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KY" + } + }, + "CF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CF" + } + }, + "TD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TD" + } + }, + "CL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CL" + } + }, + "CN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CN" + } + }, + "CX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CX" + } + }, + "CC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CC" + } + }, + "CO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CO" + } + }, + "KM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KM" + } + }, + "CG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CG" + } + }, + "CD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CD" + } + }, + "CK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CK" + } + }, + "CR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CR" + } + }, + "CI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CI" + } + }, + "HR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HR" + } + }, + "CU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CU" + } + }, + "CW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CW" + } + }, + "CY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CY" + } + }, + "CZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CZ" + } + }, + "DK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DK" + } + }, + "DJ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DJ" + } + }, + "DM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DM" + } + }, + "DO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DO" + } + }, + "EC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC" + } + }, + "EG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EG" + } + }, + "SV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SV" + } + }, + "GQ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GQ" + } + }, + "ER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ER" + } + }, + "EE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EE" + } + }, + "ET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ET" + } + }, + "FK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FK" + } + }, + "FO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FO" + } + }, + "FJ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FJ" + } + }, + "FI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FI" + } + }, + "FR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FR" + } + }, + "GF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GF" + } + }, + "PF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PF" + } + }, + "TF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TF" + } + }, + "GA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GA" + } + }, + "GM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GM" + } + }, + "GE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GE" + } + }, + "DE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DE" + } + }, + "GH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GH" + } + }, + "GI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GI" + } + }, + "GR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GR" + } + }, + "GL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GL" + } + }, + "GD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GD" + } + }, + "GP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GP" + } + }, + "GU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GU" + } + }, + "GT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GT" + } + }, + "GG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GG" + } + }, + "GN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GN" + } + }, + "GW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GW" + } + }, + "GY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GY" + } + }, + "HT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HT" + } + }, + "HM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HM" + } + }, + "VA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VA" + } + }, + "HN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HN" + } + }, + "HK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HK" + } + }, + "HU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HU" + } + }, + "IS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IS" + } + }, + "IN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN" + } + }, + "ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ID" + } + }, + "IR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IR" + } + }, + "IQ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IQ" + } + }, + "IE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IE" + } + }, + "IM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IM" + } + }, + "IL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IL" + } + }, + "IT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IT" + } + }, + "JM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JM" + } + }, + "JP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JP" + } + }, + "JE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JE" + } + }, + "JO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JO" + } + }, + "KZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KZ" + } + }, + "KE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KE" + } + }, + "KI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KI" + } + }, + "KP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KP" + } + }, + "KR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KR" + } + }, + "KW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KW" + } + }, + "KG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KG" + } + }, + "LA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LA" + } + }, + "LV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LV" + } + }, + "LB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LB" + } + }, + "LS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LS" + } + }, + "LR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LR" + } + }, + "LY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LY" + } + }, + "LI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LI" + } + }, + "LT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LT" + } + }, + "LU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LU" + } + }, + "MO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MO" + } + }, + "MK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MK" + } + }, + "MG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MG" + } + }, + "MW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MW" + } + }, + "MY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MY" + } + }, + "MV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MV" + } + }, + "ML": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ML" + } + }, + "MT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MT" + } + }, + "MH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MH" + } + }, + "MQ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MQ" + } + }, + "MR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MR" + } + }, + "MU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MU" + } + }, + "YT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "YT" + } + }, + "MX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MX" + } + }, + "FM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FM" + } + }, + "MD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MD" + } + }, + "MC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MC" + } + }, + "MN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MN" + } + }, + "ME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ME" + } + }, + "MS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MS" + } + }, + "MA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MA" + } + }, + "MZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MZ" + } + }, + "MM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MM" + } + }, + "NA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NA" + } + }, + "NR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NR" + } + }, + "NP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NP" + } + }, + "NL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NL" + } + }, + "NC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NC" + } + }, + "NZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NZ" + } + }, + "NI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NI" + } + }, + "NE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NE" + } + }, + "NG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NG" + } + }, + "NU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NU" + } + }, + "NF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NF" + } + }, + "MP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MP" + } + }, + "NO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO" + } + }, + "OM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OM" + } + }, + "PK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PK" + } + }, + "PW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PW" + } + }, + "PS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PS" + } + }, + "PA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PA" + } + }, + "PG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PG" + } + }, + "PY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PY" + } + }, + "PE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PE" + } + }, + "PH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PH" + } + }, + "PN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PN" + } + }, + "PL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PL" + } + }, + "PT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT" + } + }, + "PR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PR" + } + }, + "QA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QA" + } + }, + "RE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RE" + } + }, + "RO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RO" + } + }, + "RU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RU" + } + }, + "RW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RW" + } + }, + "BL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BL" + } + }, + "SH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SH" + } + }, + "KN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KN" + } + }, + "LC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LC" + } + }, + "MF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MF" + } + }, + "PM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PM" + } + }, + "VC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VC" + } + }, + "WS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WS" + } + }, + "SM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SM" + } + }, + "ST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ST" + } + }, + "SA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SA" + } + }, + "SN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SN" + } + }, + "RS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RS" + } + }, + "SC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SC" + } + }, + "SL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SL" + } + }, + "SG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SG" + } + }, + "SX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SX" + } + }, + "SK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SK" + } + }, + "SI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SI" + } + }, + "SB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SB" + } + }, + "SO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SO" + } + }, + "ZA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZA" + } + }, + "GS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GS" + } + }, + "SS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SS" + } + }, + "ES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ES" + } + }, + "LK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LK" + } + }, + "SD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SD" + } + }, + "SR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SR" + } + }, + "SJ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SJ" + } + }, + "SZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SZ" + } + }, + "SE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SE" + } + }, + "CH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CH" + } + }, + "SY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SY" + } + }, + "TW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TW" + } + }, + "TJ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TJ" + } + }, + "TZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TZ" + } + }, + "TH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TH" + } + }, + "TL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TL" + } + }, + "TG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TG" + } + }, + "TK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TK" + } + }, + "TO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TO" + } + }, + "TT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TT" + } + }, + "TN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TN" + } + }, + "TR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TR" + } + }, + "TM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TM" + } + }, + "TC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TC" + } + }, + "TV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TV" + } + }, + "UG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UG" + } + }, + "UA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UA" + } + }, + "AE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AE" + } + }, + "GB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GB" + } + }, + "US": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US" + } + }, + "UM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UM" + } + }, + "UY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UY" + } + }, + "UZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UZ" + } + }, + "VU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VU" + } + }, + "VE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VE" + } + }, + "VN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VN" + } + }, + "VG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VG" + } + }, + "VI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VI" + } + }, + "WF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WF" + } + }, + "EH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EH" + } + }, + "YE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "YE" + } + }, + "ZM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZM" + } + }, + "ZW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZW" + } + }, + "XK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "XK" + } + } + } + }, + "com.amazonaws.wafv2#CountryCodes": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#CountryCode" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.wafv2#CreateAPIKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#CreateAPIKeyRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#CreateAPIKeyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFLimitsExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an API key that contains a set of token domains.

\n

API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. \n The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. \n For more information about the CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.

\n

You can use a single key for up to 5 domains. After you generate a key, you can copy it for use in your JavaScript \n integration.

" + } + }, + "com.amazonaws.wafv2#CreateAPIKeyRequest": { + "type": "structure", + "members": { + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n
    \n
  • \n

    CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    \n
    • \n
  • \n

    API and SDKs - For all calls, use the Region endpoint us-east-1.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "TokenDomains": { + "target": "com.amazonaws.wafv2#APIKeyTokenDomains", + "traits": { + "smithy.api#documentation": "

The client application domains that you want to use this API key for.

\n

Example JSON: \"TokenDomains\": [\"abc.com\", \"store.abc.com\"]\n

\n

Public suffixes aren't allowed. For example, you can't use gov.au or co.uk as token domains.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#CreateAPIKeyResponse": { + "type": "structure", + "members": { + "APIKey": { + "target": "com.amazonaws.wafv2#APIKey", + "traits": { + "smithy.api#documentation": "

The generated, encrypted API key. You can copy this for use in your JavaScript CAPTCHA integration.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#CreateIPSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#CreateIPSetRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#CreateIPSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFDuplicateItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFLimitsExceededException" + }, + { + "target": "com.amazonaws.wafv2#WAFOptimisticLockException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationInternalErrorException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an IPSet, which you use to identify web requests that\n originate from specific IP addresses or ranges of IP addresses. For example, if you're\n receiving a lot of requests from a ranges of IP addresses, you can configure WAF to\n block them using an IPSet that lists those IP addresses.

" + } + }, + "com.amazonaws.wafv2#CreateIPSetRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the IP set. You cannot change the name of an IPSet after you create it.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n
    \n
  • \n

    CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    \n
    • \n
  • \n

    API and SDKs - For all calls, use the Region endpoint us-east-1.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", + "traits": { + "smithy.api#documentation": "

A description of the IP set that helps with identification.

" + } + }, + "IPAddressVersion": { + "target": "com.amazonaws.wafv2#IPAddressVersion", + "traits": { + "smithy.api#documentation": "

The version of the IP addresses, either IPV4 or IPV6.

", + "smithy.api#required": {} + } + }, + "Addresses": { + "target": "com.amazonaws.wafv2#IPAddresses", + "traits": { + "smithy.api#documentation": "

Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF to inspect for in incoming requests. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

\n

Example address strings:

\n
    \n
  • \n

    For requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.

    \n
    • \n
  • \n

    For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify \n 192.0.2.0/24.

    \n
    • \n
  • \n

    For requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.

    \n
    • \n
  • \n

    For requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.

    \n
    • \n
\n

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

\n

Example JSON Addresses specifications:

\n
    \n
  • \n

    Empty array: \"Addresses\": []\n

    \n
    • \n
  • \n

    Array with one address: \"Addresses\": [\"192.0.2.44/32\"]\n

    \n
    • \n
  • \n

    Array with three addresses: \"Addresses\": [\"192.0.2.44/32\", \"192.0.2.0/24\", \"192.0.0.0/16\"]\n

    \n
    • \n
  • \n

    INVALID specification: \"Addresses\": [\"\"] INVALID

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.wafv2#TagList", + "traits": { + "smithy.api#documentation": "

An array of key:value pairs to associate with the resource.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#CreateIPSetResponse": { + "type": "structure", + "members": { + "Summary": { + "target": "com.amazonaws.wafv2#IPSetSummary", + "traits": { + "smithy.api#documentation": "

High-level information about an IPSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage an IPSet, and the ARN, that you provide to the IPSetReferenceStatement to use the address set in a Rule.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#CreateRegexPatternSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#CreateRegexPatternSetRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#CreateRegexPatternSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFDuplicateItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFLimitsExceededException" + }, + { + "target": "com.amazonaws.wafv2#WAFOptimisticLockException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationInternalErrorException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a RegexPatternSet, which you reference in a RegexPatternSetReferenceStatement, to have WAF inspect a web request\n component for the specified patterns.

" + } + }, + "com.amazonaws.wafv2#CreateRegexPatternSetRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the set. You cannot change the name after you create the set.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n
    \n
  • \n

    CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    \n
    • \n
  • \n

    API and SDKs - For all calls, use the Region endpoint us-east-1.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", + "traits": { + "smithy.api#documentation": "

A description of the set that helps with identification.

" + } + }, + "RegularExpressionList": { + "target": "com.amazonaws.wafv2#RegularExpressionList", + "traits": { + "smithy.api#documentation": "

Array of regular expression strings.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.wafv2#TagList", + "traits": { + "smithy.api#documentation": "

An array of key:value pairs to associate with the resource.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#CreateRegexPatternSetResponse": { + "type": "structure", + "members": { + "Summary": { + "target": "com.amazonaws.wafv2#RegexPatternSetSummary", + "traits": { + "smithy.api#documentation": "

High-level information about a RegexPatternSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RegexPatternSet, and the ARN, that you provide to the RegexPatternSetReferenceStatement to use the pattern set in a Rule.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#CreateRuleGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#CreateRuleGroupRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#CreateRuleGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFDuplicateItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFLimitsExceededException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFOptimisticLockException" + }, + { + "target": "com.amazonaws.wafv2#WAFSubscriptionNotFoundException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFUnavailableEntityException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a RuleGroup per the specifications provided.

\n

A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.

" + } + }, + "com.amazonaws.wafv2#CreateRuleGroupRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the rule group. You cannot change the name of a rule group after you create it.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n
    \n
  • \n

    CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    \n
    • \n
  • \n

    API and SDKs - For all calls, use the Region endpoint us-east-1.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Capacity": { + "target": "com.amazonaws.wafv2#CapacityUnit", + "traits": { + "smithy.api#documentation": "

The web ACL capacity units (WCUs) required for this rule group.

\n

When you create your own rule group, you define this, and you cannot change it after creation. \n When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity \n for a set of rules using CheckCapacity.

\n

WAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) \n in the WAF Developer Guide.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", + "traits": { + "smithy.api#documentation": "

A description of the rule group that helps with identification.

" + } + }, + "Rules": { + "target": "com.amazonaws.wafv2#Rules", + "traits": { + "smithy.api#documentation": "

The Rule statements used to identify the web requests that you \n want to manage. Each rule includes one top-level statement that WAF uses to identify matching \n web requests, and parameters that govern how WAF handles them. \n

" + } + }, + "VisibilityConfig": { + "target": "com.amazonaws.wafv2#VisibilityConfig", + "traits": { + "smithy.api#documentation": "

Defines and enables Amazon CloudWatch metrics and web request sample collection.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.wafv2#TagList", + "traits": { + "smithy.api#documentation": "

An array of key:value pairs to associate with the resource.

" + } + }, + "CustomResponseBodies": { + "target": "com.amazonaws.wafv2#CustomResponseBodies", + "traits": { + "smithy.api#documentation": "

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.

\n

For information about customizing web requests and responses, \n see Customizing web requests and responses in WAF \n in the WAF Developer Guide.

\n

For information about the limits on count and size for custom request and response settings, see WAF quotas \n in the WAF Developer Guide.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#CreateRuleGroupResponse": { + "type": "structure", + "members": { + "Summary": { + "target": "com.amazonaws.wafv2#RuleGroupSummary", + "traits": { + "smithy.api#documentation": "

High-level information about a RuleGroup, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RuleGroup, and the ARN, that you provide to the RuleGroupReferenceStatement to use the rule group in a Rule.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#CreateWebACL": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#CreateWebACLRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#CreateWebACLResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFConfigurationWarningException" + }, + { + "target": "com.amazonaws.wafv2#WAFDuplicateItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFExpiredManagedRuleGroupVersionException" + }, + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidResourceException" + }, + { + "target": "com.amazonaws.wafv2#WAFLimitsExceededException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFOptimisticLockException" + }, + { + "target": "com.amazonaws.wafv2#WAFSubscriptionNotFoundException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFUnavailableEntityException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a WebACL per the specifications provided.

\n

A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a statement that defines what to look for in web requests and an action that WAF applies to requests that match the statement. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

" + } + }, + "com.amazonaws.wafv2#CreateWebACLRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the web ACL. You cannot change the name of a web ACL after you create it.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n
    \n
  • \n

    CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    \n
    • \n
  • \n

    API and SDKs - For all calls, use the Region endpoint us-east-1.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "DefaultAction": { + "target": "com.amazonaws.wafv2#DefaultAction", + "traits": { + "smithy.api#documentation": "

The action to perform if none of the Rules contained in the WebACL match.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", + "traits": { + "smithy.api#documentation": "

A description of the web ACL that helps with identification.

" + } + }, + "Rules": { + "target": "com.amazonaws.wafv2#Rules", + "traits": { + "smithy.api#documentation": "

The Rule statements used to identify the web requests that you \n want to manage. Each rule includes one top-level statement that WAF uses to identify matching \n web requests, and parameters that govern how WAF handles them. \n

" + } + }, + "VisibilityConfig": { + "target": "com.amazonaws.wafv2#VisibilityConfig", + "traits": { + "smithy.api#documentation": "

Defines and enables Amazon CloudWatch metrics and web request sample collection.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.wafv2#TagList", + "traits": { + "smithy.api#documentation": "

An array of key:value pairs to associate with the resource.

" + } + }, + "CustomResponseBodies": { + "target": "com.amazonaws.wafv2#CustomResponseBodies", + "traits": { + "smithy.api#documentation": "

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.

\n

For information about customizing web requests and responses, \n see Customizing web requests and responses in WAF \n in the WAF Developer Guide.

\n

For information about the limits on count and size for custom request and response settings, see WAF quotas \n in the WAF Developer Guide.

" + } + }, + "CaptchaConfig": { + "target": "com.amazonaws.wafv2#CaptchaConfig", + "traits": { + "smithy.api#documentation": "

Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings. If you don't specify this, WAF uses its default settings for CaptchaConfig.

" + } + }, + "ChallengeConfig": { + "target": "com.amazonaws.wafv2#ChallengeConfig", + "traits": { + "smithy.api#documentation": "

Specifies how WAF should handle challenge evaluations for rules that don't have \ntheir own ChallengeConfig settings. If you don't specify this, WAF uses its default settings for ChallengeConfig.

" + } + }, + "TokenDomains": { + "target": "com.amazonaws.wafv2#TokenDomains", + "traits": { + "smithy.api#documentation": "

Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.

\n

Example JSON: \"TokenDomains\": { \"mywebsite.com\", \"myotherwebsite.com\" }\n

\n

Public suffixes aren't allowed. For example, you can't use gov.au or co.uk as token domains.

" + } + }, + "AssociationConfig": { + "target": "com.amazonaws.wafv2#AssociationConfig", + "traits": { + "smithy.api#documentation": "

Specifies custom configurations for the associations between the web ACL and protected resources.

\n

Use this to customize the maximum size of the request body that your protected resources forward to WAF for inspection. You can \n customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).

\n \n

You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.

\n \n

For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#CreateWebACLResponse": { + "type": "structure", + "members": { + "Summary": { + "target": "com.amazonaws.wafv2#WebACLSummary", + "traits": { + "smithy.api#documentation": "

High-level information about a WebACL, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a WebACL, and the ARN, that you provide to operations like AssociateWebACL.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#CreationPathString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.wafv2#CustomHTTPHeader": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#CustomHTTPHeaderName", + "traits": { + "smithy.api#documentation": "

The name of the custom header.

\n

For custom request header insertion, when WAF inserts the header into the request,\n it prefixes this name x-amzn-waf-, to avoid confusion with the headers that\n are already in the request. For example, for the header name sample, WAF\n inserts the header x-amzn-waf-sample.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.wafv2#CustomHTTPHeaderValue", + "traits": { + "smithy.api#documentation": "

The value of the custom header.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling.

" + } + }, + "com.amazonaws.wafv2#CustomHTTPHeaderName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._$-]+$" + } + }, + "com.amazonaws.wafv2#CustomHTTPHeaderValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.wafv2#CustomHTTPHeaders": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#CustomHTTPHeader" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.wafv2#CustomRequestHandling": { + "type": "structure", + "members": { + "InsertHeaders": { + "target": "com.amazonaws.wafv2#CustomHTTPHeaders", + "traits": { + "smithy.api#documentation": "

The HTTP headers to insert into the request. Duplicate header names are not allowed.

\n

For information about the limits on count and size for custom request and response settings, see WAF quotas \n in the WAF Developer Guide.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Custom request handling behavior that inserts custom headers into a web request. You can\n add custom request handling for WAF to use when the rule action doesn't block the request. \n For example, CaptchaAction for requests with valid t okens, and AllowAction.

\n

For information about customizing web requests and responses, \n see Customizing web requests and responses in WAF \n in the WAF Developer Guide.

" + } + }, + "com.amazonaws.wafv2#CustomResponse": { + "type": "structure", + "members": { + "ResponseCode": { + "target": "com.amazonaws.wafv2#ResponseStatusCode", + "traits": { + "smithy.api#documentation": "

The HTTP status code to return to the client.

\n

For a list of status codes that you can use in your custom responses, see Supported status codes for custom response \n in the WAF Developer Guide.

", + "smithy.api#required": {} + } + }, + "CustomResponseBodyKey": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

References the response body that you want WAF to return to the web request\n client. You can define a custom response for a rule action or a default web ACL action that\n is set to block. To do this, you first define the response body key and value in the\n CustomResponseBodies setting for the WebACL or RuleGroup where you want to use it. Then, in the rule action or web ACL\n default action BlockAction setting, you reference the response body using this\n key.

" + } + }, + "ResponseHeaders": { + "target": "com.amazonaws.wafv2#CustomHTTPHeaders", + "traits": { + "smithy.api#documentation": "

The HTTP headers to use in the response. You can specify any header name except for content-type. Duplicate header names are not allowed.

\n

For information about the limits on count and size for custom request and response settings, see WAF quotas \n in the WAF Developer Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A custom response to send to the client. You can define a custom response for rule\n actions and default web ACL actions that are set to BlockAction.

\n

For information about customizing web requests and responses, \n see Customizing web requests and responses in WAF \n in the WAF Developer Guide.

" + } + }, + "com.amazonaws.wafv2#CustomResponseBodies": { + "type": "map", + "key": { + "target": "com.amazonaws.wafv2#EntityName" + }, + "value": { + "target": "com.amazonaws.wafv2#CustomResponseBody" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.wafv2#CustomResponseBody": { + "type": "structure", + "members": { + "ContentType": { + "target": "com.amazonaws.wafv2#ResponseContentType", + "traits": { + "smithy.api#documentation": "

The type of content in the payload that you are defining in the Content\n string.

", + "smithy.api#required": {} + } + }, + "Content": { + "target": "com.amazonaws.wafv2#ResponseContent", + "traits": { + "smithy.api#documentation": "

The payload of the custom response.

\n

You can use JSON escape strings in JSON content. To do this, you must specify JSON\n content in the ContentType setting.

\n

For information about the limits on count and size for custom request and response settings, see WAF quotas \n in the WAF Developer Guide.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The response body to use in a custom response to a web request. This is referenced by\n key from CustomResponse\n CustomResponseBodyKey.

" + } + }, + "com.amazonaws.wafv2#DefaultAction": { + "type": "structure", + "members": { + "Block": { + "target": "com.amazonaws.wafv2#BlockAction", + "traits": { + "smithy.api#documentation": "

Specifies that WAF should block requests by default.

" + } + }, + "Allow": { + "target": "com.amazonaws.wafv2#AllowAction", + "traits": { + "smithy.api#documentation": "

Specifies that WAF should allow requests by default.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

In a WebACL, this is the action that you want WAF to perform\n when a web request doesn't match any of the rules in the WebACL. The default\n action must be a terminating action.

" + } + }, + "com.amazonaws.wafv2#DeleteAPIKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#DeleteAPIKeyRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#DeleteAPIKeyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFOptimisticLockException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified API key.

\n

After you delete a key, it can take up to 24 hours for WAF to disallow use of the key in all regions.

" + } + }, + "com.amazonaws.wafv2#DeleteAPIKeyRequest": { + "type": "structure", + "members": { + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n
    \n
  • \n

    CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    \n
    • \n
  • \n

    API and SDKs - For all calls, use the Region endpoint us-east-1.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "APIKey": { + "target": "com.amazonaws.wafv2#APIKey", + "traits": { + "smithy.api#documentation": "

The encrypted API key that you want to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#DeleteAPIKeyResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#DeleteFirewallManagerRuleGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#DeleteFirewallManagerRuleGroupsRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#DeleteFirewallManagerRuleGroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFOptimisticLockException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes all rule groups that are managed by Firewall Manager from the specified WebACL.

\n

You can only use this if ManagedByFirewallManager and RetrofittedByFirewallManager are both false in the web ACL.

" + } + }, + "com.amazonaws.wafv2#DeleteFirewallManagerRuleGroupsRequest": { + "type": "structure", + "members": { + "WebACLArn": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the web ACL.

", + "smithy.api#required": {} + } + }, + "WebACLLockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#DeleteFirewallManagerRuleGroupsResponse": { + "type": "structure", + "members": { + "NextWebACLLockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#DeleteIPSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#DeleteIPSetRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#DeleteIPSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFAssociatedItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFOptimisticLockException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationInternalErrorException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified IPSet.

" + } + }, + "com.amazonaws.wafv2#DeleteIPSetRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the IP set. You cannot change the name of an IPSet after you create it.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n
    \n
  • \n

    CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    \n
    • \n
  • \n

    API and SDKs - For all calls, use the Region endpoint us-east-1.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", + "smithy.api#required": {} + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#DeleteIPSetResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#DeleteLoggingConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#DeleteLoggingConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#DeleteLoggingConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFOptimisticLockException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the LoggingConfiguration from the specified web ACL.

" + } + }, + "com.amazonaws.wafv2#DeleteLoggingConfigurationRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the web ACL from which you want to delete the LoggingConfiguration.

", + "smithy.api#required": {} + } + }, + "LogType": { + "target": "com.amazonaws.wafv2#LogType", + "traits": { + "smithy.api#documentation": "

Used to distinguish between various logging options. Currently, there is one option.

\n

Default: WAF_LOGS\n

" + } + }, + "LogScope": { + "target": "com.amazonaws.wafv2#LogScope", + "traits": { + "smithy.api#documentation": "

The owner of the logging configuration, which must be set to CUSTOMER for the configurations that you manage.

\n

The log scope SECURITY_LAKE indicates a configuration that is managed through Amazon Security Lake. You can use Security Lake to collect log and event data from various sources for normalization, analysis, and management. For information, see \n Collecting data from Amazon Web Services services\n in the Amazon Security Lake user guide.

\n

Default: CUSTOMER\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#DeleteLoggingConfigurationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#DeletePermissionPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#DeletePermissionPolicyRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#DeletePermissionPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + } + ], + "traits": { + "smithy.api#documentation": "

Permanently deletes an IAM policy from the specified rule group.

\n

You must be the owner of the rule group to perform this operation.

" + } + }, + "com.amazonaws.wafv2#DeletePermissionPolicyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the rule group from which you want to delete the\n policy.

\n

You must be the owner of the rule group to perform this operation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#DeletePermissionPolicyResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#DeleteRegexPatternSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#DeleteRegexPatternSetRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#DeleteRegexPatternSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFAssociatedItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFOptimisticLockException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationInternalErrorException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified RegexPatternSet.

" + } + }, + "com.amazonaws.wafv2#DeleteRegexPatternSetRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the set. You cannot change the name after you create the set.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n
    \n
  • \n

    CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    \n
    • \n
  • \n

    API and SDKs - For all calls, use the Region endpoint us-east-1.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", + "smithy.api#required": {} + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#DeleteRegexPatternSetResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#DeleteRuleGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#DeleteRuleGroupRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#DeleteRuleGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFAssociatedItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFOptimisticLockException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationInternalErrorException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified RuleGroup.

" + } + }, + "com.amazonaws.wafv2#DeleteRuleGroupRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the rule group. You cannot change the name of a rule group after you create it.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n
    \n
  • \n

    CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    \n
    • \n
  • \n

    API and SDKs - For all calls, use the Region endpoint us-east-1.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", + "smithy.api#required": {} + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#DeleteRuleGroupResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#DeleteWebACL": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#DeleteWebACLRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#DeleteWebACLResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFAssociatedItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFOptimisticLockException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationInternalErrorException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified WebACL.

\n

You can only use this if ManagedByFirewallManager is false in the web ACL.

\n \n

Before deleting any web ACL, first disassociate it from all resources.

\n
    \n
  • \n

    To retrieve a list of the resources that are associated with a web ACL, use the\n following calls:

    \n
      \n
    • \n

      For regional resources, call ListResourcesForWebACL.

      \n
      • \n
    • \n

      For Amazon CloudFront distributions, use the CloudFront call\n ListDistributionsByWebACLId. For information, see ListDistributionsByWebACLId \n in the Amazon CloudFront API Reference.

      \n
      • \n
    \n
    • \n
  • \n

    To disassociate a resource from a web ACL, use the following calls:

    \n
      \n
    • \n

      For regional resources, call DisassociateWebACL.

      \n
      • \n
    • \n

      For Amazon CloudFront distributions, provide an empty web ACL ID in the CloudFront call\n UpdateDistribution. For information, see UpdateDistribution\n in the Amazon CloudFront API Reference.

      \n
      • \n
    \n
    • \n
\n " + } + }, + "com.amazonaws.wafv2#DeleteWebACLRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the web ACL. You cannot change the name of a web ACL after you create it.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n
    \n
  • \n

    CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    \n
    • \n
  • \n

    API and SDKs - For all calls, use the Region endpoint us-east-1.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", + "smithy.api#required": {} + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#DeleteWebACLResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#DescribeAllManagedProducts": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#DescribeAllManagedProductsRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#DescribeAllManagedProductsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides high-level information for the Amazon Web Services Managed Rules rule groups and Amazon Web Services Marketplace managed rule groups.

" + } + }, + "com.amazonaws.wafv2#DescribeAllManagedProductsRequest": { + "type": "structure", + "members": { + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n
    \n
  • \n

    CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    \n
    • \n
  • \n

    API and SDKs - For all calls, use the Region endpoint us-east-1.

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#DescribeAllManagedProductsResponse": { + "type": "structure", + "members": { + "ManagedProducts": { + "target": "com.amazonaws.wafv2#ManagedProductDescriptors", + "traits": { + "smithy.api#documentation": "

High-level information for the Amazon Web Services Managed Rules rule groups and Amazon Web Services Marketplace managed rule groups.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#DescribeManagedProductsByVendor": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#DescribeManagedProductsByVendorRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#DescribeManagedProductsByVendorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides high-level information for the managed rule groups owned by a specific vendor.

" + } + }, + "com.amazonaws.wafv2#DescribeManagedProductsByVendorRequest": { + "type": "structure", + "members": { + "VendorName": { + "target": "com.amazonaws.wafv2#VendorName", + "traits": { + "smithy.api#documentation": "

The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n
    \n
  • \n

    CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    \n
    • \n
  • \n

    API and SDKs - For all calls, use the Region endpoint us-east-1.

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#DescribeManagedProductsByVendorResponse": { + "type": "structure", + "members": { + "ManagedProducts": { + "target": "com.amazonaws.wafv2#ManagedProductDescriptors", + "traits": { + "smithy.api#documentation": "

High-level information for the managed rule groups owned by the specified vendor.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#DescribeManagedRuleGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#DescribeManagedRuleGroupRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#DescribeManagedRuleGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFExpiredManagedRuleGroupVersionException" + }, + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidResourceException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides high-level information for a managed rule group, including descriptions of the rules.

" + } + }, + "com.amazonaws.wafv2#DescribeManagedRuleGroupRequest": { + "type": "structure", + "members": { + "VendorName": { + "target": "com.amazonaws.wafv2#VendorName", + "traits": { + "smithy.api#documentation": "

The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n
    \n
  • \n

    CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    \n
    • \n
  • \n

    API and SDKs - For all calls, use the Region endpoint us-east-1.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "VersionName": { + "target": "com.amazonaws.wafv2#VersionKeyString", + "traits": { + "smithy.api#documentation": "

The version of the rule group. You can only use a version that is not scheduled for\n expiration. If you don't provide this, WAF uses the vendor's default version.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#DescribeManagedRuleGroupResponse": { + "type": "structure", + "members": { + "VersionName": { + "target": "com.amazonaws.wafv2#VersionKeyString", + "traits": { + "smithy.api#documentation": "

The managed rule group's version.

" + } + }, + "SnsTopicArn": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that's used to provide notification of changes\n to the managed rule group. You can subscribe to the SNS topic to receive notifications when\n the managed rule group is modified, such as for new versions and for version expiration.\n For more information, see the Amazon Simple Notification Service Developer Guide.

" + } + }, + "Capacity": { + "target": "com.amazonaws.wafv2#CapacityUnit", + "traits": { + "smithy.api#documentation": "

The web ACL capacity units (WCUs) required for this rule group.

\n

WAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) \n in the WAF Developer Guide.

" + } + }, + "Rules": { + "target": "com.amazonaws.wafv2#RuleSummaries", + "traits": { + "smithy.api#documentation": "

" + } + }, + "LabelNamespace": { + "target": "com.amazonaws.wafv2#LabelName", + "traits": { + "smithy.api#documentation": "

The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.

\n
    \n
  • \n

    The syntax for the label namespace prefix for a managed rule group is the following:

    \n

    \n awswaf:managed:::

    \n
    • \n
  • \n

    When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:

    \n

    \n \n

    \n
    • \n
" + } + }, + "AvailableLabels": { + "target": "com.amazonaws.wafv2#LabelSummaries", + "traits": { + "smithy.api#documentation": "

The labels that one or more rules in this rule group add to matching web requests. These labels are defined in the RuleLabels for a Rule.

" + } + }, + "ConsumedLabels": { + "target": "com.amazonaws.wafv2#LabelSummaries", + "traits": { + "smithy.api#documentation": "

The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#DisassociateWebACL": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#DisassociateWebACLRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#DisassociateWebACLResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + } + ], + "traits": { + "smithy.api#documentation": "

Disassociates the specified regional application resource from any existing web ACL\n association. A resource can have at most one web ACL association. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To\n disassociate a web ACL, provide an empty web ACL ID in the CloudFront call\n UpdateDistribution. For information, see UpdateDistribution in the Amazon CloudFront API Reference.

\n

\n Required permissions for customer-managed IAM policies\n

\n

This call requires permissions that are specific to the protected resource type. \n For details, see Permissions for DisassociateWebACL in the WAF Developer Guide.

" + } + }, + "com.amazonaws.wafv2#DisassociateWebACLRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to disassociate from the web ACL.

\n

The ARN must be in one of the following formats:

\n
    \n
  • \n

    For an Application Load Balancer: arn:partition:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id\n \n

    \n
    • \n
  • \n

    For an Amazon API Gateway REST API: arn:partition:apigateway:region::/restapis/api-id/stages/stage-name\n \n

    \n
    • \n
  • \n

    For an AppSync GraphQL API: arn:partition:appsync:region:account-id:apis/GraphQLApiId\n \n

    \n
    • \n
  • \n

    For an Amazon Cognito user pool: arn:partition:cognito-idp:region:account-id:userpool/user-pool-id\n \n

    \n
    • \n
  • \n

    For an App Runner service: arn:partition:apprunner:region:account-id:service/apprunner-service-name/apprunner-service-id\n \n

    \n
    • \n
  • \n

    For an Amazon Web Services Verified Access instance: arn:partition:ec2:region:account-id:verified-access-instance/instance-id\n \n

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#DisassociateWebACLResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#DownloadUrl": { + "type": "string" + }, + "com.amazonaws.wafv2#EmailField": { + "type": "structure", + "members": { + "Identifier": { + "target": "com.amazonaws.wafv2#FieldIdentifier", + "traits": { + "smithy.api#documentation": "

The name of the email field.

\n

How you specify this depends on the request inspection payload type.

\n
    \n
  • \n

    For JSON payloads, specify the field name in JSON\n pointer syntax. For information about the JSON Pointer\n syntax, see the Internet Engineering Task Force (IETF)\n documentation JavaScript\n \tObject Notation (JSON) Pointer.

    \n

    For example, for the JSON payload { \"form\": { \"email\": \"THE_EMAIL\" } }, \n the email field specification is /form/email.

    \n
    • \n
  • \n

    For form encoded payload types, use the HTML form names.

    \n

    For example, for an HTML form with the input element\n named email1, the email field specification is email1.

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The name of the field in the request payload that contains your customer's email.

\n

This data type is used in the RequestInspectionACFP data type.

" + } + }, + "com.amazonaws.wafv2#EnableMachineLearning": { + "type": "boolean" + }, + "com.amazonaws.wafv2#EntityDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[\\w+=:#@/\\-,\\.][\\w+=:#@/\\-,\\.\\s]+[\\w+=:#@/\\-,\\.]$" + } + }, + "com.amazonaws.wafv2#EntityId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 36 + }, + "smithy.api#pattern": "^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$" + } + }, + "com.amazonaws.wafv2#EntityName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\w\\-]+$" + } + }, + "com.amazonaws.wafv2#ErrorMessage": { + "type": "string" + }, + "com.amazonaws.wafv2#ErrorReason": { + "type": "string" + }, + "com.amazonaws.wafv2#EvaluationWindowSec": { + "type": "long", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.wafv2#ExcludedRule": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the rule whose action you want to override to Count.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies a single rule in a rule group whose action you want to override to Count.

\n \n

Instead of this option, use RuleActionOverrides. It accepts any valid action setting, including Count.

\n " + } + }, + "com.amazonaws.wafv2#ExcludedRules": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#ExcludedRule" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.wafv2#FailureCode": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 999 + } + } + }, + "com.amazonaws.wafv2#FailureReason": { + "type": "enum", + "members": { + "TOKEN_MISSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOKEN_MISSING" + } + }, + "TOKEN_EXPIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOKEN_EXPIRED" + } + }, + "TOKEN_INVALID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOKEN_INVALID" + } + }, + "TOKEN_DOMAIN_MISMATCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOKEN_DOMAIN_MISMATCH" + } + } + } + }, + "com.amazonaws.wafv2#FailureValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.wafv2#FallbackBehavior": { + "type": "enum", + "members": { + "MATCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MATCH" + } + }, + "NO_MATCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_MATCH" + } + } + } + }, + "com.amazonaws.wafv2#FieldIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.wafv2#FieldToMatch": { + "type": "structure", + "members": { + "SingleHeader": { + "target": "com.amazonaws.wafv2#SingleHeader", + "traits": { + "smithy.api#documentation": "

Inspect a single header. Provide the name of the header to inspect, for example,\n User-Agent or Referer. This setting isn't case\n sensitive.

\n

Example JSON: \"SingleHeader\": { \"Name\": \"haystack\" }\n

\n

Alternately, you can filter and inspect all headers with the Headers\n FieldToMatch setting.

" + } + }, + "SingleQueryArgument": { + "target": "com.amazonaws.wafv2#SingleQueryArgument", + "traits": { + "smithy.api#documentation": "

Inspect a single query argument. Provide the name of the query argument to inspect, such\n as UserName or SalesRegion. The name can be up to\n 30 characters long and isn't case sensitive.

\n

Example JSON: \"SingleQueryArgument\": { \"Name\": \"myArgument\" }\n

" + } + }, + "AllQueryArguments": { + "target": "com.amazonaws.wafv2#AllQueryArguments", + "traits": { + "smithy.api#documentation": "

Inspect all query arguments.

" + } + }, + "UriPath": { + "target": "com.amazonaws.wafv2#UriPath", + "traits": { + "smithy.api#documentation": "

Inspect the request URI path. This is the part of the web request that identifies a\n resource, for example, /images/daily-ad.jpg.

" + } + }, + "QueryString": { + "target": "com.amazonaws.wafv2#QueryString", + "traits": { + "smithy.api#documentation": "

Inspect the query string. This is the part of a URL that appears after a ?\n character, if any.

" + } + }, + "Body": { + "target": "com.amazonaws.wafv2#Body", + "traits": { + "smithy.api#documentation": "

Inspect the request body as plain text. The request body immediately follows the request\n headers. This is the part of a request that contains any additional data that you want to\n send to your web server as the HTTP request body, such as data from a form.

\n

WAF does not support inspecting the entire contents of the web request body if the body \n exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service \n only forwards the contents that are within the limit to WAF for inspection.

\n
    \n
  • \n

    For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).

    \n
    • \n
  • \n

    For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and \n you can increase the limit for each resource type in the web ACL AssociationConfig, for additional processing fees.

    \n
    • \n
\n

For information about how to handle oversized\n request bodies, see the Body object configuration.

" + } + }, + "Method": { + "target": "com.amazonaws.wafv2#Method", + "traits": { + "smithy.api#documentation": "

Inspect the HTTP method. The method indicates the type of operation that the request is\n asking the origin to perform.

" + } + }, + "JsonBody": { + "target": "com.amazonaws.wafv2#JsonBody", + "traits": { + "smithy.api#documentation": "

Inspect the request body as JSON. The request body immediately follows the request\n headers. This is the part of a request that contains any additional data that you want to\n send to your web server as the HTTP request body, such as data from a form.

\n

WAF does not support inspecting the entire contents of the web request body if the body \n exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service \n only forwards the contents that are within the limit to WAF for inspection.

\n
    \n
  • \n

    For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).

    \n
    • \n
  • \n

    For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and \n you can increase the limit for each resource type in the web ACL AssociationConfig, for additional processing fees.

    \n
    • \n
\n

For information about how to handle oversized\n request bodies, see the JsonBody object configuration.

" + } + }, + "Headers": { + "target": "com.amazonaws.wafv2#Headers", + "traits": { + "smithy.api#documentation": "

Inspect the request headers. You must configure scope and pattern matching filters in\n the Headers object, to define the set of headers to and the parts of the\n headers that WAF inspects.

\n

Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers\n are forwarded to WAF for inspection by the underlying host service. You must\n configure how to handle any oversize header content in the Headers object.\n WAF applies the pattern matching filters to the headers that it receives from the\n underlying host service.

" + } + }, + "Cookies": { + "target": "com.amazonaws.wafv2#Cookies", + "traits": { + "smithy.api#documentation": "

Inspect the request cookies. You must configure scope and pattern matching filters in\n the Cookies object, to define the set of cookies and the parts of the cookies\n that WAF inspects.

\n

Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies\n are forwarded to WAF for inspection by the underlying host service. You must\n configure how to handle any oversize cookie content in the Cookies object.\n WAF applies the pattern matching filters to the cookies that it receives from the\n underlying host service.

" + } + }, + "HeaderOrder": { + "target": "com.amazonaws.wafv2#HeaderOrder", + "traits": { + "smithy.api#documentation": "

Inspect a string containing the list of the request's header names, ordered as they appear in the web request\nthat WAF receives for inspection. \n WAF generates the string and then uses that as the field to match component in its inspection. \n WAF separates the header names in the string using colons and no added spaces, for example host:user-agent:accept:authorization:referer.

" + } + }, + "JA3Fingerprint": { + "target": "com.amazonaws.wafv2#JA3Fingerprint", + "traits": { + "smithy.api#documentation": "

Available for use with Amazon CloudFront distributions and Application Load Balancers. Match against the request's JA3 fingerprint. The JA3 fingerprint is a 32-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. WAF calculates and logs this fingerprint for each\n\t\t\t\t\t\trequest that has enough TLS Client Hello information for the calculation. Almost \n all web requests include this information.

\n \n

You can use this choice only with a string match ByteMatchStatement with the PositionalConstraint set to \n EXACTLY.

\n \n

You can obtain the JA3 fingerprint for client requests from the web ACL logs. \n\t\t\t\t\t\tIf WAF is able to calculate the fingerprint, it includes it in the logs. \n\t\t\t\t\t\tFor information about the logging fields, \nsee Log fields in the WAF Developer Guide.

\n

Provide the JA3 fingerprint string from the logs in your string match statement\n\t\t\t\t\t\t\tspecification, to match with any future requests that have the same TLS configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies a web request component to be used in a rule match statement or in a logging configuration.

\n
    \n
  • \n

    In a rule statement, this is the part of the web request that you want WAF to inspect. Include the single\n FieldToMatch type that you want to inspect, with additional specifications\n as needed, according to the type. You specify a single request component in\n FieldToMatch for each rule statement that requires it. To inspect more than\n one component of the web request, create a separate rule statement for each\n component.

    \n

    Example JSON for a QueryString field to match:

    \n

    \n \"FieldToMatch\": { \"QueryString\": {} }\n

    \n

    Example JSON for a Method field to match specification:

    \n

    \n \"FieldToMatch\": { \"Method\": { \"Name\": \"DELETE\" } }\n

    \n
    • \n
  • \n

    In a logging configuration, this is used in the RedactedFields property to specify a field to \n redact from the logging records. For this use case, note the following:

    \n
      \n
    • \n

      Even though all FieldToMatch settings \n are available, the only valid settings for field redaction are UriPath, QueryString, SingleHeader, and Method.

      \n
      • \n
    • \n

      In this documentation, the descriptions of the individual fields talk about specifying the web request component to inspect, \n but for field redaction, you are specifying the component type to redact from the logs.

      \n
      • \n
    • \n

      If you have request sampling enabled, the redacted fields configuration for logging has no impact on sampling. \n The only way to exclude fields from request sampling is by disabling sampling in the web ACL visibility configuration.

      \n
      • \n
    \n
    • \n
" + } + }, + "com.amazonaws.wafv2#FieldToMatchData": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.wafv2#Filter": { + "type": "structure", + "members": { + "Behavior": { + "target": "com.amazonaws.wafv2#FilterBehavior", + "traits": { + "smithy.api#documentation": "

How to handle logs that satisfy the filter's conditions and requirement.

", + "smithy.api#required": {} + } + }, + "Requirement": { + "target": "com.amazonaws.wafv2#FilterRequirement", + "traits": { + "smithy.api#documentation": "

Logic to apply to the filtering conditions. You can specify that, in order to satisfy\n the filter, a log must match all conditions or must match at least one condition.

", + "smithy.api#required": {} + } + }, + "Conditions": { + "target": "com.amazonaws.wafv2#Conditions", + "traits": { + "smithy.api#documentation": "

Match conditions for the filter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A single logging filter, used in LoggingFilter.

" + } + }, + "com.amazonaws.wafv2#FilterBehavior": { + "type": "enum", + "members": { + "KEEP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KEEP" + } + }, + "DROP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DROP" + } + } + } + }, + "com.amazonaws.wafv2#FilterRequirement": { + "type": "enum", + "members": { + "MEETS_ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEETS_ALL" + } + }, + "MEETS_ANY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEETS_ANY" + } + } + } + }, + "com.amazonaws.wafv2#Filters": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#Filter" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.wafv2#FirewallManagerRuleGroup": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the rule group. You cannot change the name of a rule group after you create it.

", + "smithy.api#required": {} + } + }, + "Priority": { + "target": "com.amazonaws.wafv2#RulePriority", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

If you define more than one rule group in the first or last Firewall Manager rule groups, WAF\n evaluates each request against the rule groups in order, starting from the lowest priority\n setting. The priorities don't need to be consecutive, but they must all be\n different.

", + "smithy.api#required": {} + } + }, + "FirewallManagerStatement": { + "target": "com.amazonaws.wafv2#FirewallManagerStatement", + "traits": { + "smithy.api#documentation": "

The processing guidance for an Firewall Manager rule. This is like a regular rule Statement, but it can only contain a rule group reference.

", + "smithy.api#required": {} + } + }, + "OverrideAction": { + "target": "com.amazonaws.wafv2#OverrideAction", + "traits": { + "smithy.api#documentation": "

The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.

\n

You can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.

\n \n

This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count \n matches, do not use this and instead use the rule action override option, with Count action, in your rule group reference statement settings.

\n ", + "smithy.api#required": {} + } + }, + "VisibilityConfig": { + "target": "com.amazonaws.wafv2#VisibilityConfig", + "traits": { + "smithy.api#documentation": "

Defines and enables Amazon CloudWatch metrics and web request sample collection.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A rule group that's defined for an Firewall Manager WAF policy.

" + } + }, + "com.amazonaws.wafv2#FirewallManagerRuleGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#FirewallManagerRuleGroup" + } + }, + "com.amazonaws.wafv2#FirewallManagerStatement": { + "type": "structure", + "members": { + "ManagedRuleGroupStatement": { + "target": "com.amazonaws.wafv2#ManagedRuleGroupStatement", + "traits": { + "smithy.api#documentation": "

A statement used by Firewall Manager to run the rules that are defined in a managed rule group. This is managed by Firewall Manager for an Firewall Manager WAF policy.

" + } + }, + "RuleGroupReferenceStatement": { + "target": "com.amazonaws.wafv2#RuleGroupReferenceStatement", + "traits": { + "smithy.api#documentation": "

A statement used by Firewall Manager to run the rules that are defined in a rule group. This is managed by Firewall Manager for an Firewall Manager WAF policy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The processing guidance for an Firewall Manager rule. This is like a regular rule Statement, but it can only contain a single rule group reference.

" + } + }, + "com.amazonaws.wafv2#ForwardedIPConfig": { + "type": "structure", + "members": { + "HeaderName": { + "target": "com.amazonaws.wafv2#ForwardedIPHeaderName", + "traits": { + "smithy.api#documentation": "

The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

\n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n ", + "smithy.api#required": {} + } + }, + "FallbackBehavior": { + "target": "com.amazonaws.wafv2#FallbackBehavior", + "traits": { + "smithy.api#documentation": "

The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

\n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n \n

You can specify the following fallback behaviors:

\n
    \n
  • \n

    \n MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

    \n
    • \n
  • \n

    \n NO_MATCH - Treat the web request as not matching the rule statement.

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

\n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n \n

This configuration is used for GeoMatchStatement and RateBasedStatement. For IPSetReferenceStatement, use IPSetForwardedIPConfig instead.

\n

WAF only evaluates the first IP address found in the specified HTTP header.\n

" + } + }, + "com.amazonaws.wafv2#ForwardedIPHeaderName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.wafv2#ForwardedIPPosition": { + "type": "enum", + "members": { + "FIRST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIRST" + } + }, + "LAST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAST" + } + }, + "ANY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANY" + } + } + } + }, + "com.amazonaws.wafv2#GenerateMobileSdkReleaseUrl": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#GenerateMobileSdkReleaseUrlRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#GenerateMobileSdkReleaseUrlResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + } + ], + "traits": { + "smithy.api#documentation": "

Generates a presigned download URL for the specified release of the mobile SDK.

\n

The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see \nWAF client application integration in the WAF Developer Guide.

" + } + }, + "com.amazonaws.wafv2#GenerateMobileSdkReleaseUrlRequest": { + "type": "structure", + "members": { + "Platform": { + "target": "com.amazonaws.wafv2#Platform", + "traits": { + "smithy.api#documentation": "

The device platform.

", + "smithy.api#required": {} + } + }, + "ReleaseVersion": { + "target": "com.amazonaws.wafv2#VersionKeyString", + "traits": { + "smithy.api#documentation": "

The release version. For the latest available version, specify\n LATEST.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#GenerateMobileSdkReleaseUrlResponse": { + "type": "structure", + "members": { + "Url": { + "target": "com.amazonaws.wafv2#DownloadUrl", + "traits": { + "smithy.api#documentation": "

The presigned download URL for the specified SDK release.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#GeoMatchStatement": { + "type": "structure", + "members": { + "CountryCodes": { + "target": "com.amazonaws.wafv2#CountryCodes", + "traits": { + "smithy.api#documentation": "

An array of two-character country codes that you want to match against, for example, [ \"US\", \"CN\" ], from\n the alpha-2 country ISO codes of the ISO 3166 international standard.

\n

When you use a geo match statement just for the region and country labels that it adds to requests, you still have to supply a country code for the rule to evaluate. In this case, you configure the rule to only count matching requests, but it will still generate logging and count metrics for any matches. You can reduce the logging and metrics that the rule produces by specifying a country that's unlikely to be a source of traffic to your site.

" + } + }, + "ForwardedIPConfig": { + "target": "com.amazonaws.wafv2#ForwardedIPConfig", + "traits": { + "smithy.api#documentation": "

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

\n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

A rule statement that labels web requests by country and region and that matches against web requests based on country code. A geo match rule labels every request that it inspects regardless of whether it finds a match.

\n
    \n
  • \n

    To manage requests only by country, you can use this statement by itself and specify the countries that you want to match against in the CountryCodes array.

    \n
    • \n
  • \n

    Otherwise, configure your geo match rule with Count action so that it only labels requests. Then, add one or more label match rules to run after the geo match rule and configure them to match against the geographic labels and handle the requests as needed.

    \n
    • \n
\n

WAF labels requests using the alpha-2 country and region codes from the International Organization for Standardization (ISO) 3166 standard. WAF determines the codes using either the IP address in the web request origin or, if you specify it, the address in the geo match ForwardedIPConfig.

\n

If you use the web request origin, the label formats are awswaf:clientip:geo:region:- and awswaf:clientip:geo:country:.

\n

If you use a forwarded IP address, the label formats are awswaf:forwardedip:geo:region:- and awswaf:forwardedip:geo:country:.

\n

For additional details, see Geographic match rule statement in the WAF Developer Guide.

" + } + }, + "com.amazonaws.wafv2#GetDecryptedAPIKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#GetDecryptedAPIKeyRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#GetDecryptedAPIKeyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidResourceException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns your API key in decrypted form. Use this to check the token domains that you have defined for the key.

\n

API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. \n The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. \n For more information about the CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.

" + } + }, + "com.amazonaws.wafv2#GetDecryptedAPIKeyRequest": { + "type": "structure", + "members": { + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n
    \n
  • \n

    CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    \n
    • \n
  • \n

    API and SDKs - For all calls, use the Region endpoint us-east-1.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "APIKey": { + "target": "com.amazonaws.wafv2#APIKey", + "traits": { + "smithy.api#documentation": "

The encrypted API key.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#GetDecryptedAPIKeyResponse": { + "type": "structure", + "members": { + "TokenDomains": { + "target": "com.amazonaws.wafv2#TokenDomains", + "traits": { + "smithy.api#documentation": "

The token domains that are defined in this API key.

" + } + }, + "CreationTimestamp": { + "target": "com.amazonaws.wafv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the key was created.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#GetIPSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#GetIPSetRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#GetIPSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the specified IPSet.

" + } + }, + "com.amazonaws.wafv2#GetIPSetRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the IP set. You cannot change the name of an IPSet after you create it.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n
    \n
  • \n

    CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    \n
    • \n
  • \n

    API and SDKs - For all calls, use the Region endpoint us-east-1.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#GetIPSetResponse": { + "type": "structure", + "members": { + "IPSet": { + "target": "com.amazonaws.wafv2#IPSet", + "traits": { + "smithy.api#documentation": "

" + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#GetLoggingConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#GetLoggingConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#GetLoggingConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the LoggingConfiguration for the specified web ACL.

" + } + }, + "com.amazonaws.wafv2#GetLoggingConfigurationRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the web ACL for which you want to get the LoggingConfiguration.

", + "smithy.api#required": {} + } + }, + "LogType": { + "target": "com.amazonaws.wafv2#LogType", + "traits": { + "smithy.api#documentation": "

Used to distinguish between various logging options. Currently, there is one option.

\n

Default: WAF_LOGS\n

" + } + }, + "LogScope": { + "target": "com.amazonaws.wafv2#LogScope", + "traits": { + "smithy.api#documentation": "

The owner of the logging configuration, which must be set to CUSTOMER for the configurations that you manage.

\n

The log scope SECURITY_LAKE indicates a configuration that is managed through Amazon Security Lake. You can use Security Lake to collect log and event data from various sources for normalization, analysis, and management. For information, see \n Collecting data from Amazon Web Services services\n in the Amazon Security Lake user guide.

\n

Default: CUSTOMER\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#GetLoggingConfigurationResponse": { + "type": "structure", + "members": { + "LoggingConfiguration": { + "target": "com.amazonaws.wafv2#LoggingConfiguration", + "traits": { + "smithy.api#documentation": "

The LoggingConfiguration for the specified web ACL.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#GetManagedRuleSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#GetManagedRuleSetRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#GetManagedRuleSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the specified managed rule set.

\n \n

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

\n

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

\n " + } + }, + "com.amazonaws.wafv2#GetManagedRuleSetRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

\n

This name is assigned to the corresponding managed rule group, which your customers can access and use.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n
    \n
  • \n

    CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    \n
    • \n
  • \n

    API and SDKs - For all calls, use the Region endpoint us-east-1.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#GetManagedRuleSetResponse": { + "type": "structure", + "members": { + "ManagedRuleSet": { + "target": "com.amazonaws.wafv2#ManagedRuleSet", + "traits": { + "smithy.api#documentation": "

The managed rule set that you requested.

" + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#GetMobileSdkRelease": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#GetMobileSdkReleaseRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#GetMobileSdkReleaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves information for the specified mobile SDK release, including release notes and\n tags.

\n

The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see \nWAF client application integration in the WAF Developer Guide.

" + } + }, + "com.amazonaws.wafv2#GetMobileSdkReleaseRequest": { + "type": "structure", + "members": { + "Platform": { + "target": "com.amazonaws.wafv2#Platform", + "traits": { + "smithy.api#documentation": "

The device platform.

", + "smithy.api#required": {} + } + }, + "ReleaseVersion": { + "target": "com.amazonaws.wafv2#VersionKeyString", + "traits": { + "smithy.api#documentation": "

The release version. For the latest available version, specify\n LATEST.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#GetMobileSdkReleaseResponse": { + "type": "structure", + "members": { + "MobileSdkRelease": { + "target": "com.amazonaws.wafv2#MobileSdkRelease", + "traits": { + "smithy.api#documentation": "

Information for a specified SDK release, including release notes and tags.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#GetPermissionPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#GetPermissionPolicyRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#GetPermissionPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the IAM policy that is attached to the specified rule group.

\n

You must be the owner of the rule group to perform this operation.

" + } + }, + "com.amazonaws.wafv2#GetPermissionPolicyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the rule group for which you want to get the\n policy.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#GetPermissionPolicyResponse": { + "type": "structure", + "members": { + "Policy": { + "target": "com.amazonaws.wafv2#PolicyString", + "traits": { + "smithy.api#documentation": "

The IAM policy that is attached to the specified rule group.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#GetRateBasedStatementManagedKeys": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#GetRateBasedStatementManagedKeysRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#GetRateBasedStatementManagedKeysResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFUnsupportedAggregateKeyTypeException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the IP addresses that are currently blocked by a rate-based rule instance. This\n is only available for rate-based rules that aggregate solely on the IP address or on the forwarded IP \n address.

\n

The maximum\n number of addresses that can be blocked for a single rate-based rule instance is 10,000.\n If more than 10,000 addresses exceed the rate limit, those with the highest rates are\n blocked.

\n

For a rate-based rule that you've defined inside a rule group, provide the name of the\n rule group reference statement in your request, in addition to the rate-based rule name and\n the web ACL name.

\n

WAF monitors web requests and manages keys independently for each unique combination\n of web ACL, optional rule group, and rate-based rule. For example, if you define a\n rate-based rule inside a rule group, and then use the rule group in a web ACL, WAF\n monitors web requests and manages keys for that web ACL, rule group reference statement,\n and rate-based rule instance. If you use the same rule group in a second web ACL, WAF\n monitors web requests and manages keys for this second usage completely independent of your\n first.

" + } + }, + "com.amazonaws.wafv2#GetRateBasedStatementManagedKeysRequest": { + "type": "structure", + "members": { + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n
    \n
  • \n

    CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    \n
    • \n
  • \n

    API and SDKs - For all calls, use the Region endpoint us-east-1.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "WebACLName": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the web ACL. You cannot change the name of a web ACL after you create it.

", + "smithy.api#required": {} + } + }, + "WebACLId": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", + "smithy.api#required": {} + } + }, + "RuleGroupRuleName": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the rule group reference statement in your web ACL. This is required only\n when you have the rate-based rule nested inside a rule group.

" + } + }, + "RuleName": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the rate-based rule to get the keys for. If you have the rule defined inside\n a rule group that you're using in your web ACL, also provide the name of the rule group\n reference statement in the request parameter RuleGroupRuleName.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#GetRateBasedStatementManagedKeysResponse": { + "type": "structure", + "members": { + "ManagedKeysIPV4": { + "target": "com.amazonaws.wafv2#RateBasedStatementManagedKeysIPSet", + "traits": { + "smithy.api#documentation": "

The keys that are of Internet Protocol version 4 (IPv4).

" + } + }, + "ManagedKeysIPV6": { + "target": "com.amazonaws.wafv2#RateBasedStatementManagedKeysIPSet", + "traits": { + "smithy.api#documentation": "

The keys that are of Internet Protocol version 6 (IPv6).

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#GetRegexPatternSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#GetRegexPatternSetRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#GetRegexPatternSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the specified RegexPatternSet.

" + } + }, + "com.amazonaws.wafv2#GetRegexPatternSetRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the set. You cannot change the name after you create the set.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n
    \n
  • \n

    CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    \n
    • \n
  • \n

    API and SDKs - For all calls, use the Region endpoint us-east-1.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#GetRegexPatternSetResponse": { + "type": "structure", + "members": { + "RegexPatternSet": { + "target": "com.amazonaws.wafv2#RegexPatternSet", + "traits": { + "smithy.api#documentation": "

" + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#GetRuleGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#GetRuleGroupRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#GetRuleGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the specified RuleGroup.

" + } + }, + "com.amazonaws.wafv2#GetRuleGroupRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the rule group. You cannot change the name of a rule group after you create it.

" + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n
    \n
  • \n

    CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    \n
    • \n
  • \n

    API and SDKs - For all calls, use the Region endpoint us-east-1.

    \n
    • \n
" + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

" + } + }, + "ARN": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the entity.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#GetRuleGroupResponse": { + "type": "structure", + "members": { + "RuleGroup": { + "target": "com.amazonaws.wafv2#RuleGroup", + "traits": { + "smithy.api#documentation": "

" + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#GetSampledRequests": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#GetSampledRequestsRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#GetSampledRequestsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets detailed information about a specified number of requests--a sample--that WAF\n randomly selects from among the first 5,000 requests that your Amazon Web Services resource received\n during a time range that you choose. You can specify a sample size of up to 500 requests,\n and you can specify any time range in the previous three hours.

\n

\n GetSampledRequests returns a time range, which is usually the time range that\n you specified. However, if your resource (such as a CloudFront distribution) received 5,000\n requests before the specified time range elapsed, GetSampledRequests returns\n an updated time range. This new time range indicates the actual period during which WAF\n selected the requests in the sample.

" + } + }, + "com.amazonaws.wafv2#GetSampledRequestsRequest": { + "type": "structure", + "members": { + "WebAclArn": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon resource name (ARN) of the WebACL for which you want a sample of\n requests.

", + "smithy.api#required": {} + } + }, + "RuleMetricName": { + "target": "com.amazonaws.wafv2#MetricName", + "traits": { + "smithy.api#documentation": "

The metric name assigned to the Rule or RuleGroup dimension for which\n you want a sample of requests.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n
    \n
  • \n

    CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    \n
    • \n
  • \n

    API and SDKs - For all calls, use the Region endpoint us-east-1.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "TimeWindow": { + "target": "com.amazonaws.wafv2#TimeWindow", + "traits": { + "smithy.api#documentation": "

The start date and time and the end date and time of the range for which you want\n GetSampledRequests to return a sample of requests. You must specify the\n times in Coordinated Universal Time (UTC) format. UTC format includes the special\n designator, Z. For example, \"2016-09-27T14:50Z\". You can specify\n any time range in the previous three hours. If you specify a start time that's earlier than\n three hours ago, WAF sets it to three hours ago.

", + "smithy.api#required": {} + } + }, + "MaxItems": { + "target": "com.amazonaws.wafv2#ListMaxItems", + "traits": { + "smithy.api#documentation": "

The number of requests that you want WAF to return from among the first 5,000\n requests that your Amazon Web Services resource received during the time range. If your resource received\n fewer requests than the value of MaxItems, GetSampledRequests\n returns information about all of them.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#GetSampledRequestsResponse": { + "type": "structure", + "members": { + "SampledRequests": { + "target": "com.amazonaws.wafv2#SampledHTTPRequests", + "traits": { + "smithy.api#documentation": "

A complex type that contains detailed information about each of the requests in the\n sample.

" + } + }, + "PopulationSize": { + "target": "com.amazonaws.wafv2#PopulationSize", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The total number of requests from which GetSampledRequests got a sample of\n MaxItems requests. If PopulationSize is less than\n MaxItems, the sample includes every request that your Amazon Web Services resource\n received during the specified time range.

" + } + }, + "TimeWindow": { + "target": "com.amazonaws.wafv2#TimeWindow", + "traits": { + "smithy.api#documentation": "

Usually, TimeWindow is the time range that you specified in the\n GetSampledRequests request. However, if your Amazon Web Services resource received more\n than 5,000 requests during the time range that you specified in the request,\n GetSampledRequests returns the time range for the first 5,000 requests.\n Times are in Coordinated Universal Time (UTC) format.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#GetWebACL": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#GetWebACLRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#GetWebACLResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the specified WebACL.

" + } + }, + "com.amazonaws.wafv2#GetWebACLForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#GetWebACLForResourceRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#GetWebACLForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFUnavailableEntityException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the WebACL for the specified resource.

\n

This call uses GetWebACL, to verify that your account has permission to access the retrieved web ACL. \n If you get an error that indicates that your account isn't authorized to perform wafv2:GetWebACL on the resource, \n that error won't be included in your CloudTrail event history.

\n

For Amazon CloudFront, don't use this call. Instead, call the CloudFront action\n GetDistributionConfig. For information, see GetDistributionConfig in the Amazon CloudFront API Reference.

\n

\n Required permissions for customer-managed IAM policies\n

\n

This call requires permissions that are specific to the protected resource type. \n For details, see Permissions for GetWebACLForResource in the WAF Developer Guide.

" + } + }, + "com.amazonaws.wafv2#GetWebACLForResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource whose web ACL you want to retrieve.

\n

The ARN must be in one of the following formats:

\n
    \n
  • \n

    For an Application Load Balancer: arn:partition:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id\n \n

    \n
    • \n
  • \n

    For an Amazon API Gateway REST API: arn:partition:apigateway:region::/restapis/api-id/stages/stage-name\n \n

    \n
    • \n
  • \n

    For an AppSync GraphQL API: arn:partition:appsync:region:account-id:apis/GraphQLApiId\n \n

    \n
    • \n
  • \n

    For an Amazon Cognito user pool: arn:partition:cognito-idp:region:account-id:userpool/user-pool-id\n \n

    \n
    • \n
  • \n

    For an App Runner service: arn:partition:apprunner:region:account-id:service/apprunner-service-name/apprunner-service-id\n \n

    \n
    • \n
  • \n

    For an Amazon Web Services Verified Access instance: arn:partition:ec2:region:account-id:verified-access-instance/instance-id\n \n

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#GetWebACLForResourceResponse": { + "type": "structure", + "members": { + "WebACL": { + "target": "com.amazonaws.wafv2#WebACL", + "traits": { + "smithy.api#documentation": "

The web ACL that is associated with the resource. If there is no associated resource,\n WAF returns a null web ACL.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#GetWebACLRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the web ACL. You cannot change the name of a web ACL after you create it.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n
    \n
  • \n

    CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    \n
    • \n
  • \n

    API and SDKs - For all calls, use the Region endpoint us-east-1.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#GetWebACLResponse": { + "type": "structure", + "members": { + "WebACL": { + "target": "com.amazonaws.wafv2#WebACL", + "traits": { + "smithy.api#documentation": "

The web ACL specification. You can modify the settings in this web ACL and use it to\n update this web ACL or create a new one.

" + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" + } + }, + "ApplicationIntegrationURL": { + "target": "com.amazonaws.wafv2#OutputUrl", + "traits": { + "smithy.api#documentation": "

The URL to use in SDK integrations with Amazon Web Services managed rule groups. For example, you can use the integration SDKs with the account takeover prevention managed rule group AWSManagedRulesATPRuleSet and the account creation fraud prevention managed rule group AWSManagedRulesACFPRuleSet. This is only populated if you are using a rule group in your web ACL that integrates with your applications in this way. For more information, see WAF client application integration \nin the WAF Developer Guide.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#HTTPHeader": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#HeaderName", + "traits": { + "smithy.api#documentation": "

The name of the HTTP header.

" + } + }, + "Value": { + "target": "com.amazonaws.wafv2#HeaderValue", + "traits": { + "smithy.api#documentation": "

The value of the HTTP header.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Part of the response from GetSampledRequests. This is a complex type\n that appears as Headers in the response syntax. HTTPHeader\n contains the names and values of all of the headers that appear in one of the web requests.\n

" + } + }, + "com.amazonaws.wafv2#HTTPHeaders": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#HTTPHeader" + } + }, + "com.amazonaws.wafv2#HTTPMethod": { + "type": "string" + }, + "com.amazonaws.wafv2#HTTPRequest": { + "type": "structure", + "members": { + "ClientIP": { + "target": "com.amazonaws.wafv2#IPString", + "traits": { + "smithy.api#documentation": "

The IP address that the request originated from. If the web ACL is associated with a\n CloudFront distribution, this is the value of one of the following fields in CloudFront access\n logs:

\n
    \n
  • \n

    \n c-ip, if the viewer did not use an HTTP proxy or a load balancer to send\n the request

    \n
    • \n
  • \n

    \n x-forwarded-for, if the viewer did use an HTTP proxy or a load balancer\n to send the request

    \n
    • \n
" + } + }, + "Country": { + "target": "com.amazonaws.wafv2#Country", + "traits": { + "smithy.api#documentation": "

The two-letter country code for the country that the request originated from. For a\n current list of country codes, see the Wikipedia entry ISO 3166-1\n alpha-2.

" + } + }, + "URI": { + "target": "com.amazonaws.wafv2#URIString", + "traits": { + "smithy.api#documentation": "

The URI path of the request, which identifies the resource, for example,\n /images/daily-ad.jpg.

" + } + }, + "Method": { + "target": "com.amazonaws.wafv2#HTTPMethod", + "traits": { + "smithy.api#documentation": "

The HTTP method specified in the sampled web request.

" + } + }, + "HTTPVersion": { + "target": "com.amazonaws.wafv2#HTTPVersion", + "traits": { + "smithy.api#documentation": "

The HTTP version specified in the sampled web request, for example,\n HTTP/1.1.

" + } + }, + "Headers": { + "target": "com.amazonaws.wafv2#HTTPHeaders", + "traits": { + "smithy.api#documentation": "

A complex type that contains the name and value for each header in the sampled web\n request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Part of the response from GetSampledRequests. This is a complex type\n that appears as Request in the response syntax. HTTPRequest\n contains information about one of the web requests.

" + } + }, + "com.amazonaws.wafv2#HTTPVersion": { + "type": "string" + }, + "com.amazonaws.wafv2#HeaderMatchPattern": { + "type": "structure", + "members": { + "All": { + "target": "com.amazonaws.wafv2#All", + "traits": { + "smithy.api#documentation": "

Inspect all headers.

" + } + }, + "IncludedHeaders": { + "target": "com.amazonaws.wafv2#HeaderNames", + "traits": { + "smithy.api#documentation": "

Inspect only the headers that have a key that matches one of the strings specified here.\n

" + } + }, + "ExcludedHeaders": { + "target": "com.amazonaws.wafv2#HeaderNames", + "traits": { + "smithy.api#documentation": "

Inspect only the headers whose keys don't match any of the strings specified here.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The filter to use to identify the subset of headers to inspect in a web request.

\n

You must specify exactly one setting: either All, IncludedHeaders, or ExcludedHeaders.

\n

Example JSON: \"MatchPattern\": { \"ExcludedHeaders\": [ \"KeyToExclude1\", \"KeyToExclude2\" ] }\n

" + } + }, + "com.amazonaws.wafv2#HeaderName": { + "type": "string" + }, + "com.amazonaws.wafv2#HeaderNames": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#FieldToMatchData" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 199 + } + } + }, + "com.amazonaws.wafv2#HeaderOrder": { + "type": "structure", + "members": { + "OversizeHandling": { + "target": "com.amazonaws.wafv2#OversizeHandling", + "traits": { + "smithy.api#documentation": "

What WAF should do if the headers of the request are more numerous or larger than WAF can inspect. \n WAF does not support inspecting the entire contents of request headers \n when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers\n and at most 8 KB of header contents to WAF.

\n

The options for oversize handling are the following:

\n
    \n
  • \n

    \n CONTINUE - Inspect the available headers normally, according to the rule inspection criteria.

    \n
    • \n
  • \n

    \n MATCH - Treat the web request as matching the rule statement. WAF\n applies the rule action to the request.

    \n
    • \n
  • \n

    \n NO_MATCH - Treat the web request as not matching the rule\n statement.

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Inspect a string containing the list of the request's header names, ordered as they appear in the web request\nthat WAF receives for inspection. \n WAF generates the string and then uses that as the field to match component in its inspection. \n WAF separates the header names in the string using colons and no added spaces, for example host:user-agent:accept:authorization:referer.

" + } + }, + "com.amazonaws.wafv2#HeaderValue": { + "type": "string" + }, + "com.amazonaws.wafv2#Headers": { + "type": "structure", + "members": { + "MatchPattern": { + "target": "com.amazonaws.wafv2#HeaderMatchPattern", + "traits": { + "smithy.api#documentation": "

The filter to use to identify the subset of headers to inspect in a web request.

\n

You must specify exactly one setting: either All, IncludedHeaders, or ExcludedHeaders.

\n

Example JSON: \"MatchPattern\": { \"ExcludedHeaders\": [ \"KeyToExclude1\", \"KeyToExclude2\" ] }\n

", + "smithy.api#required": {} + } + }, + "MatchScope": { + "target": "com.amazonaws.wafv2#MapMatchScope", + "traits": { + "smithy.api#documentation": "

The parts of the headers to match with the rule inspection criteria. If you specify\n ALL, WAF inspects both keys and values.

\n

\n All does not require a match to be found in the keys\n and a match to be found in the values. It requires a match to be found in the keys \n or the values or both. To require a match in the keys and in the values, use a logical AND statement\n to combine two match rules, one that inspects the keys and another that inspects the values.

", + "smithy.api#required": {} + } + }, + "OversizeHandling": { + "target": "com.amazonaws.wafv2#OversizeHandling", + "traits": { + "smithy.api#documentation": "

What WAF should do if the headers of the request are more numerous or larger than WAF can inspect. \n WAF does not support inspecting the entire contents of request headers \n when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers\n and at most 8 KB of header contents to WAF.

\n

The options for oversize handling are the following:

\n
    \n
  • \n

    \n CONTINUE - Inspect the available headers normally, according to the rule inspection criteria.

    \n
    • \n
  • \n

    \n MATCH - Treat the web request as matching the rule statement. WAF\n applies the rule action to the request.

    \n
    • \n
  • \n

    \n NO_MATCH - Treat the web request as not matching the rule\n statement.

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Inspect all headers in the web request. You can specify the parts of the headers to\n inspect and you can narrow the set of headers to inspect by including or excluding specific\n keys.

\n

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

\n

If you want to inspect just the value of a single header, use the\n SingleHeader\n FieldToMatch setting instead.

\n

Example JSON: \"Headers\": { \"MatchPattern\": { \"All\": {} }, \"MatchScope\": \"KEY\",\n \"OversizeHandling\": \"MATCH\" }\n

" + } + }, + "com.amazonaws.wafv2#IPAddress": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.wafv2#IPAddressVersion": { + "type": "enum", + "members": { + "IPV4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IPV4" + } + }, + "IPV6": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IPV6" + } + } + } + }, + "com.amazonaws.wafv2#IPAddresses": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#IPAddress" + } + }, + "com.amazonaws.wafv2#IPSet": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the IP set. You cannot change the name of an IPSet after you create it.

", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", + "smithy.api#required": {} + } + }, + "ARN": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the entity.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", + "traits": { + "smithy.api#documentation": "

A description of the IP set that helps with identification.

" + } + }, + "IPAddressVersion": { + "target": "com.amazonaws.wafv2#IPAddressVersion", + "traits": { + "smithy.api#documentation": "

The version of the IP addresses, either IPV4 or IPV6.

", + "smithy.api#required": {} + } + }, + "Addresses": { + "target": "com.amazonaws.wafv2#IPAddresses", + "traits": { + "smithy.api#documentation": "

Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF to inspect for in incoming requests. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

\n

Example address strings:

\n
    \n
  • \n

    For requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.

    \n
    • \n
  • \n

    For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify \n 192.0.2.0/24.

    \n
    • \n
  • \n

    For requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.

    \n
    • \n
  • \n

    For requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.

    \n
    • \n
\n

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

\n

Example JSON Addresses specifications:

\n
    \n
  • \n

    Empty array: \"Addresses\": []\n

    \n
    • \n
  • \n

    Array with one address: \"Addresses\": [\"192.0.2.44/32\"]\n

    \n
    • \n
  • \n

    Array with three addresses: \"Addresses\": [\"192.0.2.44/32\", \"192.0.2.0/24\", \"192.0.0.0/16\"]\n

    \n
    • \n
  • \n

    INVALID specification: \"Addresses\": [\"\"] INVALID

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains zero or more IP addresses or blocks of IP addresses specified in Classless\n Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges\n except for /0. For information about CIDR notation, see the Wikipedia entry Classless\n Inter-Domain Routing.

\n

WAF assigns an ARN to each IPSet that you create. To use an IP set in a\n rule, you provide the ARN to the Rule statement IPSetReferenceStatement.

" + } + }, + "com.amazonaws.wafv2#IPSetForwardedIPConfig": { + "type": "structure", + "members": { + "HeaderName": { + "target": "com.amazonaws.wafv2#ForwardedIPHeaderName", + "traits": { + "smithy.api#documentation": "

The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

\n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n ", + "smithy.api#required": {} + } + }, + "FallbackBehavior": { + "target": "com.amazonaws.wafv2#FallbackBehavior", + "traits": { + "smithy.api#documentation": "

The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

\n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n \n

You can specify the following fallback behaviors:

\n
    \n
  • \n

    \n MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

    \n
    • \n
  • \n

    \n NO_MATCH - Treat the web request as not matching the rule statement.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Position": { + "target": "com.amazonaws.wafv2#ForwardedIPPosition", + "traits": { + "smithy.api#documentation": "

The position in the header to search for the IP address. The header can contain IP\n addresses of the original client and also of proxies. For example, the header value could\n be 10.1.1.1, 127.0.0.0, 10.10.10.10 where the first IP address identifies the\n original client and the rest identify proxies that the request went through.

\n

The options for this setting are the following:

\n
    \n
  • \n

    FIRST - Inspect the first IP address in the list of IP addresses in the\n header. This is usually the client's original IP.

    \n
    • \n
  • \n

    LAST - Inspect the last IP address in the list of IP addresses in the\n header.

    \n
    • \n
  • \n

    ANY - Inspect all IP addresses in the header for a match. If the header\n contains more than 10 IP addresses, WAF inspects the last 10.

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

\n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n \n

This configuration is used only for IPSetReferenceStatement. For GeoMatchStatement and RateBasedStatement, use ForwardedIPConfig instead.

" + } + }, + "com.amazonaws.wafv2#IPSetReferenceStatement": { + "type": "structure", + "members": { + "ARN": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IPSet that this statement\n references.

", + "smithy.api#required": {} + } + }, + "IPSetForwardedIPConfig": { + "target": "com.amazonaws.wafv2#IPSetForwardedIPConfig", + "traits": { + "smithy.api#documentation": "

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

\n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.

\n

Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.

" + } + }, + "com.amazonaws.wafv2#IPSetSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#IPSetSummary" + } + }, + "com.amazonaws.wafv2#IPSetSummary": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the IP set. You cannot change the name of an IPSet after you create it.

" + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

" + } + }, + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", + "traits": { + "smithy.api#documentation": "

A description of the IP set that helps with identification.

" + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" + } + }, + "ARN": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the entity.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

High-level information about an IPSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage an IPSet, and the ARN, that you provide to the IPSetReferenceStatement to use the address set in a Rule.

" + } + }, + "com.amazonaws.wafv2#IPString": { + "type": "string" + }, + "com.amazonaws.wafv2#ImmunityTimeProperty": { + "type": "structure", + "members": { + "ImmunityTime": { + "target": "com.amazonaws.wafv2#TimeWindowSecond", + "traits": { + "smithy.api#documentation": "

The amount of time, in seconds, that a CAPTCHA or challenge timestamp is considered valid by WAF. The default\n setting is 300.

\n

For the Challenge action, the minimum setting is 300.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Used for CAPTCHA and challenge token settings. Determines \n how long a CAPTCHA or challenge timestamp remains valid after WAF updates it for a successful CAPTCHA or challenge response.

" + } + }, + "com.amazonaws.wafv2#InspectionLevel": { + "type": "enum", + "members": { + "COMMON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMMON" + } + }, + "TARGETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TARGETED" + } + } + } + }, + "com.amazonaws.wafv2#JA3Fingerprint": { + "type": "structure", + "members": { + "FallbackBehavior": { + "target": "com.amazonaws.wafv2#FallbackBehavior", + "traits": { + "smithy.api#documentation": "

The match status to assign to the web request if the request doesn't have a JA3 fingerprint.

\n

You can specify the following fallback behaviors:

\n
    \n
  • \n

    \n MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

    \n
    • \n
  • \n

    \n NO_MATCH - Treat the web request as not matching the rule statement.

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Available for use with Amazon CloudFront distributions and Application Load Balancers. Match against the request's JA3 fingerprint. The JA3 fingerprint is a 32-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. WAF calculates and logs this fingerprint for each\n\t\t\t\t\t\trequest that has enough TLS Client Hello information for the calculation. Almost \n all web requests include this information.

\n \n

You can use this choice only with a string match ByteMatchStatement with the PositionalConstraint set to \n EXACTLY.

\n \n

You can obtain the JA3 fingerprint for client requests from the web ACL logs. \n\t\t\t\t\t\tIf WAF is able to calculate the fingerprint, it includes it in the logs. \n\t\t\t\t\t\tFor information about the logging fields, \nsee Log fields in the WAF Developer Guide.

\n

Provide the JA3 fingerprint string from the logs in your string match statement\n\t\t\t\t\t\t\tspecification, to match with any future requests that have the same TLS configuration.

" + } + }, + "com.amazonaws.wafv2#JsonBody": { + "type": "structure", + "members": { + "MatchPattern": { + "target": "com.amazonaws.wafv2#JsonMatchPattern", + "traits": { + "smithy.api#documentation": "

The patterns to look for in the JSON body. WAF inspects the results of these\n pattern matches against the rule inspection criteria.

", + "smithy.api#required": {} + } + }, + "MatchScope": { + "target": "com.amazonaws.wafv2#JsonMatchScope", + "traits": { + "smithy.api#documentation": "

The parts of the JSON to match against using the MatchPattern. If you\n specify ALL, WAF matches against keys and values.

\n

\n All does not require a match to be found in the keys\n and a match to be found in the values. It requires a match to be found in the keys \n or the values or both. To require a match in the keys and in the values, use a logical AND statement\n to combine two match rules, one that inspects the keys and another that inspects the values.

", + "smithy.api#required": {} + } + }, + "InvalidFallbackBehavior": { + "target": "com.amazonaws.wafv2#BodyParsingFallbackBehavior", + "traits": { + "smithy.api#documentation": "

What WAF should do if it fails to completely parse the JSON body. The options are\n the following:

\n
    \n
  • \n

    \n EVALUATE_AS_STRING - Inspect the body as plain text. WAF\n applies the text transformations and inspection criteria that you defined for the\n JSON inspection to the body text string.

    \n
    • \n
  • \n

    \n MATCH - Treat the web request as matching the rule statement.\n WAF applies the rule action to the request.

    \n
    • \n
  • \n

    \n NO_MATCH - Treat the web request as not matching the rule\n statement.

    \n
    • \n
\n

If you don't provide this setting, WAF parses and evaluates the content only up to the\n first parsing failure that it encounters.

\n \n

WAF parsing doesn't fully validate the input JSON string, so parsing can succeed even for invalid JSON. When \n parsing succeeds, WAF doesn't apply the fallback behavior. For more information, \n see JSON body \n in the WAF Developer Guide.

\n " + } + }, + "OversizeHandling": { + "target": "com.amazonaws.wafv2#OversizeHandling", + "traits": { + "smithy.api#documentation": "

What WAF should do if the body is larger than WAF can inspect.

\n

WAF does not support inspecting the entire contents of the web request body if the body \n exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service \n only forwards the contents that are within the limit to WAF for inspection.

\n
    \n
  • \n

    For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).

    \n
    • \n
  • \n

    For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and \n you can increase the limit for each resource type in the web ACL AssociationConfig, for additional processing fees.

    \n
    • \n
\n

The options for oversize handling are the following:

\n
    \n
  • \n

    \n CONTINUE - Inspect the available body contents normally, according to the rule inspection criteria.

    \n
    • \n
  • \n

    \n MATCH - Treat the web request as matching the rule statement. WAF\n applies the rule action to the request.

    \n
    • \n
  • \n

    \n NO_MATCH - Treat the web request as not matching the rule\n statement.

    \n
    • \n
\n

You can combine the MATCH or NO_MATCH\n settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit.

\n

Default: CONTINUE\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Inspect the body of the web request as JSON. The body immediately follows the request\n headers.

\n

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

\n

Use the specifications in this object to indicate which parts of the JSON body to\n inspect using the rule's inspection criteria. WAF inspects only the parts of the JSON\n that result from the matches that you indicate.

\n

Example JSON: \"JsonBody\": { \"MatchPattern\": { \"All\": {} }, \"MatchScope\": \"ALL\"\n }\n

\n

For additional information about this request component option, see JSON body \n in the WAF Developer Guide.

" + } + }, + "com.amazonaws.wafv2#JsonMatchPattern": { + "type": "structure", + "members": { + "All": { + "target": "com.amazonaws.wafv2#All", + "traits": { + "smithy.api#documentation": "

Match all of the elements. See also\n MatchScope\n in JsonBody.

\n

You must specify either this setting or the IncludedPaths setting, but not\n both.

" + } + }, + "IncludedPaths": { + "target": "com.amazonaws.wafv2#JsonPointerPaths", + "traits": { + "smithy.api#documentation": "

Match only the specified include paths. See also\n MatchScope\n in JsonBody.

\n

Provide the include paths using JSON Pointer syntax. For example, \"IncludedPaths\":\n [\"/dogs/0/name\", \"/dogs/1/name\"]. For information about this syntax, see the\n Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON)\n Pointer.

\n

You must specify either this setting or the All setting, but not\n both.

\n \n

Don't use this option to include all paths. Instead, use the All\n setting.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

The patterns to look for in the JSON body. WAF inspects the results of these\n pattern matches against the rule inspection criteria. This is used with the FieldToMatch option JsonBody.

" + } + }, + "com.amazonaws.wafv2#JsonMatchScope": { + "type": "enum", + "members": { + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + }, + "KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KEY" + } + }, + "VALUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALUE" + } + } + } + }, + "com.amazonaws.wafv2#JsonPointerPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^([/])|([/](([^~])|(~[01]))+)$" + } + }, + "com.amazonaws.wafv2#JsonPointerPaths": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#JsonPointerPath" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.wafv2#Label": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#LabelName", + "traits": { + "smithy.api#documentation": "

The label string.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A single label container. This is used as an element of a label array in multiple\n contexts, for example, in RuleLabels inside a Rule and in\n Labels inside a SampledHTTPRequest.

" + } + }, + "com.amazonaws.wafv2#LabelMatchKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[0-9A-Za-z_\\-:]+$" + } + }, + "com.amazonaws.wafv2#LabelMatchScope": { + "type": "enum", + "members": { + "LABEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LABEL" + } + }, + "NAMESPACE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAMESPACE" + } + } + } + }, + "com.amazonaws.wafv2#LabelMatchStatement": { + "type": "structure", + "members": { + "Scope": { + "target": "com.amazonaws.wafv2#LabelMatchScope", + "traits": { + "smithy.api#documentation": "

Specify whether you want to match using the label name or just the namespace.

", + "smithy.api#required": {} + } + }, + "Key": { + "target": "com.amazonaws.wafv2#LabelMatchKey", + "traits": { + "smithy.api#documentation": "

The string to match against. The setting you provide for this depends on the match\n statement's Scope setting:

\n
    \n
  • \n

    If the Scope indicates LABEL, then this specification\n must include the name and can include any number of preceding namespace\n specifications and prefix up to providing the fully qualified label name.

    \n
    • \n
  • \n

    If the Scope indicates NAMESPACE, then this\n specification can include any number of contiguous namespace strings, and can include\n the entire label namespace prefix from the rule group or web ACL where the label\n originates.

    \n
    • \n
\n

Labels are case sensitive and components of a label must be separated by colon, for\n example NS1:NS2:name.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A rule statement to match against labels that have been added to the web request by rules that have already run in the web ACL.

\n

The label match statement provides the label or namespace string to search for. The label string can represent a part or all of the fully qualified label name that had been added to the web request. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. If you do not provide the fully qualified name in your label match string, WAF performs the search for labels that were added in the same context as the label match statement.

" + } + }, + "com.amazonaws.wafv2#LabelName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[0-9A-Za-z_\\-:]+$" + } + }, + "com.amazonaws.wafv2#LabelNameCondition": { + "type": "structure", + "members": { + "LabelName": { + "target": "com.amazonaws.wafv2#LabelName", + "traits": { + "smithy.api#documentation": "

The label name that a log record must contain in order to meet the condition. This must\n be a fully qualified label name. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A single label name condition for a Condition in a logging\n filter.

" + } + }, + "com.amazonaws.wafv2#LabelNamespace": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[0-9A-Za-z_\\-:]+:$" + } + }, + "com.amazonaws.wafv2#LabelSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#LabelSummary" + } + }, + "com.amazonaws.wafv2#LabelSummary": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#LabelName", + "traits": { + "smithy.api#documentation": "

An individual label specification.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

List of labels used by one or more of the rules of a RuleGroup. This\n summary object is used for the following rule group lists:

\n
    \n
  • \n

    \n AvailableLabels - Labels that rules add to matching requests.\n These labels are defined in the RuleLabels for a Rule.

    \n
    • \n
  • \n

    \n ConsumedLabels - Labels that rules match against.\n These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.

    \n
    • \n
" + } + }, + "com.amazonaws.wafv2#Labels": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#Label" + } + }, + "com.amazonaws.wafv2#ListAPIKeys": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#ListAPIKeysRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#ListAPIKeysResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidResourceException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a list of the API keys that you've defined for the specified scope.

\n

API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. \n The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. \n For more information about the CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.

" + } + }, + "com.amazonaws.wafv2#ListAPIKeysRequest": { + "type": "structure", + "members": { + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n
    \n
  • \n

    CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    \n
    • \n
  • \n

    API and SDKs - For all calls, use the Region endpoint us-east-1.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + } + }, + "Limit": { + "target": "com.amazonaws.wafv2#PaginationLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#ListAPIKeysResponse": { + "type": "structure", + "members": { + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + } + }, + "APIKeySummaries": { + "target": "com.amazonaws.wafv2#APIKeySummaries", + "traits": { + "smithy.api#documentation": "

The array of key summaries. If you specified a Limit in your request, this might not be the full list.

" + } + }, + "ApplicationIntegrationURL": { + "target": "com.amazonaws.wafv2#OutputUrl", + "traits": { + "smithy.api#documentation": "

The CAPTCHA application integration URL, for use in your JavaScript implementation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#ListAvailableManagedRuleGroupVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#ListAvailableManagedRuleGroupVersionsRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#ListAvailableManagedRuleGroupVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of the available versions for the specified managed rule group.

" + } + }, + "com.amazonaws.wafv2#ListAvailableManagedRuleGroupVersionsRequest": { + "type": "structure", + "members": { + "VendorName": { + "target": "com.amazonaws.wafv2#VendorName", + "traits": { + "smithy.api#documentation": "

The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n
    \n
  • \n

    CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    \n
    • \n
  • \n

    API and SDKs - For all calls, use the Region endpoint us-east-1.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + } + }, + "Limit": { + "target": "com.amazonaws.wafv2#PaginationLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#ListAvailableManagedRuleGroupVersionsResponse": { + "type": "structure", + "members": { + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + } + }, + "Versions": { + "target": "com.amazonaws.wafv2#ManagedRuleGroupVersions", + "traits": { + "smithy.api#documentation": "

The versions that are currently available for the specified managed rule group. If you specified a Limit in your request, this might not be the full list.

" + } + }, + "CurrentDefaultVersion": { + "target": "com.amazonaws.wafv2#VersionKeyString", + "traits": { + "smithy.api#documentation": "

The name of the version that's currently set as the default.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#ListAvailableManagedRuleGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#ListAvailableManagedRuleGroupsRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#ListAvailableManagedRuleGroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves an array of managed rule groups that are available for you to use. This list\n includes all Amazon Web Services Managed Rules rule groups and all of the Amazon Web Services Marketplace managed rule groups that you're\n subscribed to.

" + } + }, + "com.amazonaws.wafv2#ListAvailableManagedRuleGroupsRequest": { + "type": "structure", + "members": { + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n
    \n
  • \n

    CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    \n
    • \n
  • \n

    API and SDKs - For all calls, use the Region endpoint us-east-1.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + } + }, + "Limit": { + "target": "com.amazonaws.wafv2#PaginationLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#ListAvailableManagedRuleGroupsResponse": { + "type": "structure", + "members": { + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + } + }, + "ManagedRuleGroups": { + "target": "com.amazonaws.wafv2#ManagedRuleGroupSummaries", + "traits": { + "smithy.api#documentation": "

Array of managed rule groups that you can use. If you specified a Limit in your request, this might not be the full list.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#ListIPSets": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#ListIPSetsRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#ListIPSetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves an array of IPSetSummary objects for the IP sets that you\n manage.

" + } + }, + "com.amazonaws.wafv2#ListIPSetsRequest": { + "type": "structure", + "members": { + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n
    \n
  • \n

    CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    \n
    • \n
  • \n

    API and SDKs - For all calls, use the Region endpoint us-east-1.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + } + }, + "Limit": { + "target": "com.amazonaws.wafv2#PaginationLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#ListIPSetsResponse": { + "type": "structure", + "members": { + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + } + }, + "IPSets": { + "target": "com.amazonaws.wafv2#IPSetSummaries", + "traits": { + "smithy.api#documentation": "

Array of IPSets. If you specified a Limit in your request, this might not be the full list.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#ListLoggingConfigurations": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#ListLoggingConfigurationsRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#ListLoggingConfigurationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves an array of your LoggingConfiguration objects.

" + } + }, + "com.amazonaws.wafv2#ListLoggingConfigurationsRequest": { + "type": "structure", + "members": { + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n
    \n
  • \n

    CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    \n
    • \n
  • \n

    API and SDKs - For all calls, use the Region endpoint us-east-1.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + } + }, + "Limit": { + "target": "com.amazonaws.wafv2#PaginationLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" + } + }, + "LogScope": { + "target": "com.amazonaws.wafv2#LogScope", + "traits": { + "smithy.api#documentation": "

The owner of the logging configuration, which must be set to CUSTOMER for the configurations that you manage.

\n

The log scope SECURITY_LAKE indicates a configuration that is managed through Amazon Security Lake. You can use Security Lake to collect log and event data from various sources for normalization, analysis, and management. For information, see \n Collecting data from Amazon Web Services services\n in the Amazon Security Lake user guide.

\n

Default: CUSTOMER\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#ListLoggingConfigurationsResponse": { + "type": "structure", + "members": { + "LoggingConfigurations": { + "target": "com.amazonaws.wafv2#LoggingConfigurations", + "traits": { + "smithy.api#documentation": "

Array of logging configurations. If you specified a Limit in your request, this might not be the full list.

" + } + }, + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#ListManagedRuleSets": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#ListManagedRuleSetsRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#ListManagedRuleSetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the managed rule sets that you own.

\n \n

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

\n

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

\n " + } + }, + "com.amazonaws.wafv2#ListManagedRuleSetsRequest": { + "type": "structure", + "members": { + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n
    \n
  • \n

    CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    \n
    • \n
  • \n

    API and SDKs - For all calls, use the Region endpoint us-east-1.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + } + }, + "Limit": { + "target": "com.amazonaws.wafv2#PaginationLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#ListManagedRuleSetsResponse": { + "type": "structure", + "members": { + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + } + }, + "ManagedRuleSets": { + "target": "com.amazonaws.wafv2#ManagedRuleSetSummaries", + "traits": { + "smithy.api#documentation": "

Your managed rule sets. If you specified a Limit in your request, this might not be the full list.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#ListMaxItems": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.wafv2#ListMobileSdkReleases": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#ListMobileSdkReleasesRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#ListMobileSdkReleasesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a list of the available releases for the mobile SDK and the specified device\n platform.

\n

The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see \nWAF client application integration in the WAF Developer Guide.

" + } + }, + "com.amazonaws.wafv2#ListMobileSdkReleasesRequest": { + "type": "structure", + "members": { + "Platform": { + "target": "com.amazonaws.wafv2#Platform", + "traits": { + "smithy.api#documentation": "

The device platform to retrieve the list for.

", + "smithy.api#required": {} + } + }, + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + } + }, + "Limit": { + "target": "com.amazonaws.wafv2#PaginationLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#ListMobileSdkReleasesResponse": { + "type": "structure", + "members": { + "ReleaseSummaries": { + "target": "com.amazonaws.wafv2#ReleaseSummaries", + "traits": { + "smithy.api#documentation": "

The high level information for the available SDK releases. If you specified a Limit in your request, this might not be the full list.

" + } + }, + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#ListRegexPatternSets": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#ListRegexPatternSetsRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#ListRegexPatternSetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves an array of RegexPatternSetSummary objects for the regex\n pattern sets that you manage.

" + } + }, + "com.amazonaws.wafv2#ListRegexPatternSetsRequest": { + "type": "structure", + "members": { + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n
    \n
  • \n

    CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    \n
    • \n
  • \n

    API and SDKs - For all calls, use the Region endpoint us-east-1.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + } + }, + "Limit": { + "target": "com.amazonaws.wafv2#PaginationLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#ListRegexPatternSetsResponse": { + "type": "structure", + "members": { + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + } + }, + "RegexPatternSets": { + "target": "com.amazonaws.wafv2#RegexPatternSetSummaries", + "traits": { + "smithy.api#documentation": "

Array of regex pattern sets. If you specified a Limit in your request, this might not be the full list.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#ListResourcesForWebACL": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#ListResourcesForWebACLRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#ListResourcesForWebACLResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves an array of the Amazon Resource Names (ARNs) for the regional resources that\n are associated with the specified web ACL.

\n

For Amazon CloudFront, don't use this call. Instead, use the CloudFront call\n ListDistributionsByWebACLId. For information, see ListDistributionsByWebACLId\n in the Amazon CloudFront API Reference.

\n

\n Required permissions for customer-managed IAM policies\n

\n

This call requires permissions that are specific to the protected resource type. \n For details, see Permissions for ListResourcesForWebACL in the WAF Developer Guide.

" + } + }, + "com.amazonaws.wafv2#ListResourcesForWebACLRequest": { + "type": "structure", + "members": { + "WebACLArn": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the web ACL.

", + "smithy.api#required": {} + } + }, + "ResourceType": { + "target": "com.amazonaws.wafv2#ResourceType", + "traits": { + "smithy.api#documentation": "

Used for web ACLs that are scoped for regional applications.\n A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n \n

If you don't provide a resource type, the call uses the resource type APPLICATION_LOAD_BALANCER.

\n \n

Default: APPLICATION_LOAD_BALANCER\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#ListResourcesForWebACLResponse": { + "type": "structure", + "members": { + "ResourceArns": { + "target": "com.amazonaws.wafv2#ResourceArns", + "traits": { + "smithy.api#documentation": "

The array of Amazon Resource Names (ARNs) of the associated resources.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#ListRuleGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#ListRuleGroupsRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#ListRuleGroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves an array of RuleGroupSummary objects for the rule groups\n that you manage.

" + } + }, + "com.amazonaws.wafv2#ListRuleGroupsRequest": { + "type": "structure", + "members": { + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n
    \n
  • \n

    CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    \n
    • \n
  • \n

    API and SDKs - For all calls, use the Region endpoint us-east-1.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + } + }, + "Limit": { + "target": "com.amazonaws.wafv2#PaginationLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#ListRuleGroupsResponse": { + "type": "structure", + "members": { + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + } + }, + "RuleGroups": { + "target": "com.amazonaws.wafv2#RuleGroupSummaries", + "traits": { + "smithy.api#documentation": "

Array of rule groups. If you specified a Limit in your request, this might not be the full list.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationInternalErrorException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the TagInfoForResource for the specified resource. Tags are\n key:value pairs that you can use to categorize and manage your resources, for purposes like\n billing. For example, you might set the tag key to \"customer\" and the value to the customer\n name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags\n for a resource.

\n

You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule\n groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF\n console.

" + } + }, + "com.amazonaws.wafv2#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + } + }, + "Limit": { + "target": "com.amazonaws.wafv2#PaginationLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" + } + }, + "ResourceARN": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + } + }, + "TagInfoForResource": { + "target": "com.amazonaws.wafv2#TagInfoForResource", + "traits": { + "smithy.api#documentation": "

The collection of tagging definitions for the resource. If you specified a Limit in your request, this might not be the full list.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#ListWebACLs": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#ListWebACLsRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#ListWebACLsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves an array of WebACLSummary objects for the web ACLs that you\n manage.

", + "smithy.test#smokeTests": [ + { + "id": "ListWebACLsSuccess", + "params": { + "Scope": "REGIONAL", + "Limit": 20 + }, + "vendorParams": { + "region": "us-east-1" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "success": {} + } + } + ] + } + }, + "com.amazonaws.wafv2#ListWebACLsRequest": { + "type": "structure", + "members": { + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n
    \n
  • \n

    CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    \n
    • \n
  • \n

    API and SDKs - For all calls, use the Region endpoint us-east-1.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + } + }, + "Limit": { + "target": "com.amazonaws.wafv2#PaginationLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#ListWebACLsResponse": { + "type": "structure", + "members": { + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + } + }, + "WebACLs": { + "target": "com.amazonaws.wafv2#WebACLSummaries", + "traits": { + "smithy.api#documentation": "

Array of web ACLs. If you specified a Limit in your request, this might not be the full list.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#LockToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 36 + }, + "smithy.api#pattern": "^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$" + } + }, + "com.amazonaws.wafv2#LogDestinationConfigs": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#ResourceArn" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.wafv2#LogScope": { + "type": "enum", + "members": { + "CUSTOMER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOMER" + } + }, + "SECURITY_LAKE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SECURITY_LAKE" + } + } + } + }, + "com.amazonaws.wafv2#LogType": { + "type": "enum", + "members": { + "WAF_LOGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WAF_LOGS" + } + } + } + }, + "com.amazonaws.wafv2#LoggingConfiguration": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the web ACL that you want to associate with\n LogDestinationConfigs.

", + "smithy.api#required": {} + } + }, + "LogDestinationConfigs": { + "target": "com.amazonaws.wafv2#LogDestinationConfigs", + "traits": { + "smithy.api#documentation": "

The logging destination configuration that you want to associate with the web\n ACL.

\n \n

You can associate one logging destination to a web ACL.

\n ", + "smithy.api#required": {} + } + }, + "RedactedFields": { + "target": "com.amazonaws.wafv2#RedactedFields", + "traits": { + "smithy.api#documentation": "

The parts of the request that you want to keep out of the logs.

\n

For example, if you\n redact the SingleHeader field, the HEADER field in the logs will\n be REDACTED for all rules that use the SingleHeader\n FieldToMatch setting.

\n

Redaction applies only to the component that's specified in the rule's FieldToMatch setting, so the SingleHeader redaction \n doesn't apply to rules that use the Headers\n FieldToMatch.

\n \n

You can specify only the following fields for redaction: UriPath,\n QueryString, SingleHeader, and Method.

\n \n \n

This setting has no impact on request sampling. With request sampling, \n the only way to exclude fields is by disabling sampling in the web ACL visibility configuration.

\n " + } + }, + "ManagedByFirewallManager": { + "target": "com.amazonaws.wafv2#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the logging configuration was created by Firewall Manager, as part of an\n WAF policy configuration. If true, only Firewall Manager can modify or delete the\n configuration.

\n

The logging configuration can be created by Firewall Manager for use with any web ACL that Firewall Manager is using for an WAF policy. \n Web ACLs that Firewall Manager creates and uses have their ManagedByFirewallManager property set to true. Web ACLs that were created \n by a customer account and then retrofitted by Firewall Manager for use by a policy have their RetrofittedByFirewallManager property set to true. \n For either case, any corresponding logging configuration will indicate ManagedByFirewallManager.

" + } + }, + "LoggingFilter": { + "target": "com.amazonaws.wafv2#LoggingFilter", + "traits": { + "smithy.api#documentation": "

Filtering that specifies which web requests are kept in the logs and which are dropped.\n You can filter on the rule action and on the web request labels that were applied by\n matching rules during web ACL evaluation.

" + } + }, + "LogType": { + "target": "com.amazonaws.wafv2#LogType", + "traits": { + "smithy.api#documentation": "

Used to distinguish between various logging options. Currently, there is one option.

\n

Default: WAF_LOGS\n

" + } + }, + "LogScope": { + "target": "com.amazonaws.wafv2#LogScope", + "traits": { + "smithy.api#documentation": "

The owner of the logging configuration, which must be set to CUSTOMER for the configurations that you manage.

\n

The log scope SECURITY_LAKE indicates a configuration that is managed through Amazon Security Lake. You can use Security Lake to collect log and event data from various sources for normalization, analysis, and management. For information, see \n Collecting data from Amazon Web Services services\n in the Amazon Security Lake user guide.

\n

Default: CUSTOMER\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines an association between logging destinations and a web ACL resource, for logging\n from WAF. As part of the association, you can specify parts of the standard logging\n fields to keep out of the logs and you can specify filters so that you log only a subset of\n the logging records.

\n \n

You can define one logging destination per web ACL.

\n \n

You can access information about the traffic that WAF inspects using the following\n steps:

\n
    \n
  1. \n

    Create your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose.

    \n

    The name that you give the destination must start with aws-waf-logs-. Depending on the type of destination, you might need to configure additional settings or permissions.

    \n

    For configuration requirements and pricing information for each destination type, see \n Logging web ACL traffic \n in the WAF Developer Guide.

    \n
    2. \n
  2. \n

    Associate your logging destination to your web ACL using a\n PutLoggingConfiguration request.

    \n
    3. \n
\n

When you successfully enable logging using a PutLoggingConfiguration\n request, WAF creates an additional role or policy that is required to write\n logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group.\n For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role.

\n

For additional information about web ACL logging, see \n Logging web ACL traffic information \n in the WAF Developer Guide.

" + } + }, + "com.amazonaws.wafv2#LoggingConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#LoggingConfiguration" + } + }, + "com.amazonaws.wafv2#LoggingFilter": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.wafv2#Filters", + "traits": { + "smithy.api#documentation": "

The filters that you want to apply to the logs.

", + "smithy.api#required": {} + } + }, + "DefaultBehavior": { + "target": "com.amazonaws.wafv2#FilterBehavior", + "traits": { + "smithy.api#documentation": "

Default handling for logs that don't match any of the specified filtering conditions.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Filtering that specifies which web requests are kept in the logs and which are dropped,\n defined for a web ACL's LoggingConfiguration.

\n

You can filter on the rule action and on the web request labels that were applied by\n matching rules during web ACL evaluation.

" + } + }, + "com.amazonaws.wafv2#LoginPathString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.wafv2#ManagedProductDescriptor": { + "type": "structure", + "members": { + "VendorName": { + "target": "com.amazonaws.wafv2#VendorName", + "traits": { + "smithy.api#documentation": "

The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.

" + } + }, + "ManagedRuleSetName": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the managed rule group. For example, AWSManagedRulesAnonymousIpList or AWSManagedRulesATPRuleSet.

" + } + }, + "ProductId": { + "target": "com.amazonaws.wafv2#ProductId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

" + } + }, + "ProductLink": { + "target": "com.amazonaws.wafv2#ProductLink", + "traits": { + "smithy.api#documentation": "

For Amazon Web Services Marketplace managed rule groups only, the link to the rule group product page.

" + } + }, + "ProductTitle": { + "target": "com.amazonaws.wafv2#ProductTitle", + "traits": { + "smithy.api#documentation": "

The display name for the managed rule group. For example, Anonymous IP list or Account takeover prevention.

" + } + }, + "ProductDescription": { + "target": "com.amazonaws.wafv2#ProductDescription", + "traits": { + "smithy.api#documentation": "

A short description of the managed rule group.

" + } + }, + "SnsTopicArn": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that's used to provide notification of changes\n to the managed rule group. You can subscribe to the SNS topic to receive notifications when\n the managed rule group is modified, such as for new versions and for version expiration.\n For more information, see the Amazon Simple Notification Service Developer Guide.

" + } + }, + "IsVersioningSupported": { + "target": "com.amazonaws.wafv2#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the rule group is versioned.

" + } + }, + "IsAdvancedManagedRuleSet": { + "target": "com.amazonaws.wafv2#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the rule group provides an advanced set of protections, such as the the Amazon Web Services Managed Rules rule groups that \n are used for WAF intelligent threat mitigation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The properties of a managed product, such as an Amazon Web Services Managed Rules rule group or an Amazon Web Services Marketplace managed rule group.

" + } + }, + "com.amazonaws.wafv2#ManagedProductDescriptors": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#ManagedProductDescriptor" + } + }, + "com.amazonaws.wafv2#ManagedRuleGroupConfig": { + "type": "structure", + "members": { + "LoginPath": { + "target": "com.amazonaws.wafv2#LoginPathString", + "traits": { + "smithy.api#deprecated": { + "message": "Deprecated. Use AWSManagedRulesATPRuleSet LoginPath" + }, + "smithy.api#documentation": "\n

Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet.

\n " + } + }, + "PayloadType": { + "target": "com.amazonaws.wafv2#PayloadType", + "traits": { + "smithy.api#deprecated": { + "message": "Deprecated. Use AWSManagedRulesATPRuleSet RequestInspection PayloadType" + }, + "smithy.api#documentation": "\n

Instead of this setting, provide your configuration under the request inspection configuration for AWSManagedRulesATPRuleSet or AWSManagedRulesACFPRuleSet.

\n " + } + }, + "UsernameField": { + "target": "com.amazonaws.wafv2#UsernameField", + "traits": { + "smithy.api#deprecated": { + "message": "Deprecated. Use AWSManagedRulesATPRuleSet RequestInspection UsernameField" + }, + "smithy.api#documentation": "\n

Instead of this setting, provide your configuration under the request inspection configuration for AWSManagedRulesATPRuleSet or AWSManagedRulesACFPRuleSet.

\n " + } + }, + "PasswordField": { + "target": "com.amazonaws.wafv2#PasswordField", + "traits": { + "smithy.api#deprecated": { + "message": "Deprecated. Use AWSManagedRulesATPRuleSet RequestInspection PasswordField" + }, + "smithy.api#documentation": "\n

Instead of this setting, provide your configuration under the request inspection configuration for AWSManagedRulesATPRuleSet or AWSManagedRulesACFPRuleSet.

\n " + } + }, + "AWSManagedRulesBotControlRuleSet": { + "target": "com.amazonaws.wafv2#AWSManagedRulesBotControlRuleSet", + "traits": { + "smithy.api#documentation": "

Additional configuration for using the Bot Control managed rule group. Use this to specify the \n inspection level that you want to use. For information \n about using the Bot Control managed rule group, see WAF Bot Control rule group \n and WAF Bot Control\n in the WAF Developer Guide.

" + } + }, + "AWSManagedRulesATPRuleSet": { + "target": "com.amazonaws.wafv2#AWSManagedRulesATPRuleSet", + "traits": { + "smithy.api#documentation": "

Additional configuration for using the account takeover prevention (ATP) managed rule group, AWSManagedRulesATPRuleSet. \n Use this to provide login request information to the rule group. For web ACLs that protect CloudFront distributions, use this to also provide\n the information about how your distribution responds to login requests.

\n

This configuration replaces the individual configuration fields in ManagedRuleGroupConfig and provides additional feature configuration.

\n

For information \n about using the ATP managed rule group, see WAF Fraud Control account takeover prevention (ATP) rule group \n and WAF Fraud Control account takeover prevention (ATP)\n in the WAF Developer Guide.

" + } + }, + "AWSManagedRulesACFPRuleSet": { + "target": "com.amazonaws.wafv2#AWSManagedRulesACFPRuleSet", + "traits": { + "smithy.api#documentation": "

Additional configuration for using the account creation fraud prevention (ACFP) managed rule group, AWSManagedRulesACFPRuleSet. \n Use this to provide account creation request information to the rule group. For web ACLs that protect CloudFront distributions, use this to also provide\n the information about how your distribution responds to account creation requests.

\n

For information \n about using the ACFP managed rule group, see WAF Fraud Control account creation fraud prevention (ACFP) rule group \n and WAF Fraud Control account creation fraud prevention (ACFP)\n in the WAF Developer Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Additional information that's used by a managed rule group. Many managed rule groups don't require this.

\n

The rule groups used for intelligent threat mitigation require additional configuration:

\n
    \n
  • \n

    Use the AWSManagedRulesACFPRuleSet configuration object to configure the account creation fraud prevention managed rule group. The configuration includes the registration and sign-up pages of your application and the locations in the account creation request payload of data, such as the user email and phone number fields.

    \n
    • \n
  • \n

    Use the AWSManagedRulesATPRuleSet configuration object to configure the account takeover prevention managed rule group. The configuration includes the sign-in page of your application and the locations in the login request payload of data such as the username and password.

    \n
    • \n
  • \n

    Use the AWSManagedRulesBotControlRuleSet configuration object to configure the \n protection level that you want the Bot Control rule group to use.

    \n
    • \n
\n

For example specifications, see the examples section of CreateWebACL.

" + } + }, + "com.amazonaws.wafv2#ManagedRuleGroupConfigs": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#ManagedRuleGroupConfig" + } + }, + "com.amazonaws.wafv2#ManagedRuleGroupStatement": { + "type": "structure", + "members": { + "VendorName": { + "target": "com.amazonaws.wafv2#VendorName", + "traits": { + "smithy.api#documentation": "

The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

", + "smithy.api#required": {} + } + }, + "Version": { + "target": "com.amazonaws.wafv2#VersionKeyString", + "traits": { + "smithy.api#documentation": "

The version of the managed rule group to use. If you specify this, the version setting\n is fixed until you change it. If you don't specify this, WAF uses the vendor's\n default version, and then keeps the version at the vendor's default when the vendor updates\n the managed rule group settings.

" + } + }, + "ExcludedRules": { + "target": "com.amazonaws.wafv2#ExcludedRules", + "traits": { + "smithy.api#documentation": "

Rules in the referenced rule group whose actions are set to Count.

\n \n

Instead of this option, use RuleActionOverrides. It accepts any valid action setting, including Count.

\n " + } + }, + "ScopeDownStatement": { + "target": "com.amazonaws.wafv2#Statement", + "traits": { + "smithy.api#documentation": "

An optional nested statement that narrows the scope of the web requests that are\n evaluated by the managed rule group. Requests are only evaluated by the rule group if they\n match the scope-down statement. You can use any nestable Statement in the\n scope-down statement, and you can nest statements at any level, the same as you can for a\n rule statement.

" + } + }, + "ManagedRuleGroupConfigs": { + "target": "com.amazonaws.wafv2#ManagedRuleGroupConfigs", + "traits": { + "smithy.api#documentation": "

Additional information that's used by a managed rule group. Many managed rule groups don't require this.

\n

The rule groups used for intelligent threat mitigation require additional configuration:

\n
    \n
  • \n

    Use the AWSManagedRulesACFPRuleSet configuration object to configure the account creation fraud prevention managed rule group. The configuration includes the registration and sign-up pages of your application and the locations in the account creation request payload of data, such as the user email and phone number fields.

    \n
    • \n
  • \n

    Use the AWSManagedRulesATPRuleSet configuration object to configure the account takeover prevention managed rule group. The configuration includes the sign-in page of your application and the locations in the login request payload of data such as the username and password.

    \n
    • \n
  • \n

    Use the AWSManagedRulesBotControlRuleSet configuration object to configure the \n protection level that you want the Bot Control rule group to use.

    \n
    • \n
" + } + }, + "RuleActionOverrides": { + "target": "com.amazonaws.wafv2#RuleActionOverrides", + "traits": { + "smithy.api#documentation": "

Action settings to use in the place of the rule actions that are configured inside the rule group. You specify one override for each rule whose action you want to change.

\n

You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.

\n

You cannot nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. You cannot use a managed rule group \n inside another rule group. You can only reference a managed rule group as a top-level statement within a rule that you define in a web ACL.

\n \n

You are charged additional fees when you use the WAF Bot Control managed rule group AWSManagedRulesBotControlRuleSet, the WAF Fraud Control account takeover prevention (ATP) managed rule group AWSManagedRulesATPRuleSet, or the WAF Fraud Control account creation fraud prevention (ACFP) managed rule group AWSManagedRulesACFPRuleSet. For more information, see WAF Pricing.

\n " + } + }, + "com.amazonaws.wafv2#ManagedRuleGroupSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#ManagedRuleGroupSummary" + } + }, + "com.amazonaws.wafv2#ManagedRuleGroupSummary": { + "type": "structure", + "members": { + "VendorName": { + "target": "com.amazonaws.wafv2#VendorName", + "traits": { + "smithy.api#documentation": "

The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.

" + } + }, + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

" + } + }, + "VersioningSupported": { + "target": "com.amazonaws.wafv2#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the managed rule group is versioned. If it is, you can retrieve the\n versions list by calling ListAvailableManagedRuleGroupVersions.

" + } + }, + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", + "traits": { + "smithy.api#documentation": "

The description of the managed rule group, provided by Amazon Web Services Managed Rules or the Amazon Web Services Marketplace seller who manages it.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

High-level information about a managed rule group, returned by ListAvailableManagedRuleGroups. This provides information like the name and vendor name, that you provide when you add a ManagedRuleGroupStatement to a web ACL. Managed rule groups include Amazon Web Services Managed Rules rule groups and Amazon Web Services Marketplace managed rule groups. To use any Amazon Web Services Marketplace managed rule group, first subscribe to the rule group through Amazon Web Services Marketplace.

" + } + }, + "com.amazonaws.wafv2#ManagedRuleGroupVersion": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#VersionKeyString", + "traits": { + "smithy.api#documentation": "

The version name.

" + } + }, + "LastUpdateTimestamp": { + "target": "com.amazonaws.wafv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the managed rule group owner updated the rule group version\n information.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a single version of a managed rule group.

" + } + }, + "com.amazonaws.wafv2#ManagedRuleGroupVersions": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#ManagedRuleGroupVersion" + } + }, + "com.amazonaws.wafv2#ManagedRuleSet": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

\n

This name is assigned to the corresponding managed rule group, which your customers can access and use.

", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.

", + "smithy.api#required": {} + } + }, + "ARN": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the entity.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", + "traits": { + "smithy.api#documentation": "

A description of the set that helps with identification.

" + } + }, + "PublishedVersions": { + "target": "com.amazonaws.wafv2#PublishedVersions", + "traits": { + "smithy.api#documentation": "

The versions of this managed rule set that are available for use by customers.

" + } + }, + "RecommendedVersion": { + "target": "com.amazonaws.wafv2#VersionKeyString", + "traits": { + "smithy.api#documentation": "

The version that you would like your customers to use.

" + } + }, + "LabelNamespace": { + "target": "com.amazonaws.wafv2#LabelName", + "traits": { + "smithy.api#documentation": "

The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this prefix.

\n
    \n
  • \n

    The syntax for the label namespace prefix for a managed rule group is the following:

    \n

    \n awswaf:managed:::

    \n
    • \n
  • \n

    When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:

    \n

    \n \n

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

A set of rules that is managed by Amazon Web Services and Amazon Web Services Marketplace sellers to provide versioned managed\n rule groups for customers of WAF.

\n \n

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

\n

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

\n " + } + }, + "com.amazonaws.wafv2#ManagedRuleSetSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#ManagedRuleSetSummary" + } + }, + "com.amazonaws.wafv2#ManagedRuleSetSummary": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

\n

This name is assigned to the corresponding managed rule group, which your customers can access and use.

" + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.

" + } + }, + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", + "traits": { + "smithy.api#documentation": "

A description of the set that helps with identification.

" + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" + } + }, + "ARN": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the entity.

" + } + }, + "LabelNamespace": { + "target": "com.amazonaws.wafv2#LabelName", + "traits": { + "smithy.api#documentation": "

The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this prefix.

\n
    \n
  • \n

    The syntax for the label namespace prefix for a managed rule group is the following:

    \n

    \n awswaf:managed:::

    \n
    • \n
  • \n

    When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:

    \n

    \n \n

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

High-level information for a managed rule set.

\n \n

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

\n

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

\n " + } + }, + "com.amazonaws.wafv2#ManagedRuleSetVersion": { + "type": "structure", + "members": { + "AssociatedRuleGroupArn": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the vendor rule group that's used to define the\n published version of your managed rule group.

" + } + }, + "Capacity": { + "target": "com.amazonaws.wafv2#CapacityUnit", + "traits": { + "smithy.api#documentation": "

The web ACL capacity units (WCUs) required for this rule group.

\n

WAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) \n in the WAF Developer Guide.

" + } + }, + "ForecastedLifetime": { + "target": "com.amazonaws.wafv2#TimeWindowDay", + "traits": { + "smithy.api#documentation": "

The amount of time you expect this version of your managed rule group to last, in days.\n

" + } + }, + "PublishTimestamp": { + "target": "com.amazonaws.wafv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that you first published this version.

\n

Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\".

" + } + }, + "LastUpdateTimestamp": { + "target": "com.amazonaws.wafv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The last time that you updated this version.

\n

Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\".

" + } + }, + "ExpiryTimestamp": { + "target": "com.amazonaws.wafv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that this version is set to expire.

\n

Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\".

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information for a single version of a managed rule set.

\n \n

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

\n

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

\n " + } + }, + "com.amazonaws.wafv2#MapMatchScope": { + "type": "enum", + "members": { + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + }, + "KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KEY" + } + }, + "VALUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALUE" + } + } + } + }, + "com.amazonaws.wafv2#Method": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Inspect the HTTP method of the web request. The method indicates the type of operation\n that the request is asking the origin to perform.

\n

This is used in the FieldToMatch specification for some web request component types.

\n

JSON specification: \"Method\": {}\n

" + } + }, + "com.amazonaws.wafv2#MetricName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[\\w#:\\.\\-/]+$" + } + }, + "com.amazonaws.wafv2#MobileSdkRelease": { + "type": "structure", + "members": { + "ReleaseVersion": { + "target": "com.amazonaws.wafv2#VersionKeyString", + "traits": { + "smithy.api#documentation": "

The release version.

" + } + }, + "Timestamp": { + "target": "com.amazonaws.wafv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of the release.

" + } + }, + "ReleaseNotes": { + "target": "com.amazonaws.wafv2#ReleaseNotes", + "traits": { + "smithy.api#documentation": "

Notes describing the release.

" + } + }, + "Tags": { + "target": "com.amazonaws.wafv2#TagList", + "traits": { + "smithy.api#documentation": "

Tags that are associated with the release.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information for a release of the mobile SDK, including release notes and tags.

\n

The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see \nWAF client application integration in the WAF Developer Guide.

" + } + }, + "com.amazonaws.wafv2#NextMarker": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.wafv2#NoneAction": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Specifies that WAF should do nothing. This is used for the\n OverrideAction setting on a Rule when the rule uses a\n rule group reference statement.

\n

This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.

\n

JSON specification: \"None\": {}\n

" + } + }, + "com.amazonaws.wafv2#NotStatement": { + "type": "structure", + "members": { + "Statement": { + "target": "com.amazonaws.wafv2#Statement", + "traits": { + "smithy.api#documentation": "

The statement to negate. You can use any statement that can be nested.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A logical rule statement used to negate the results of another rule statement. You provide one Statement within the NotStatement.

" + } + }, + "com.amazonaws.wafv2#OrStatement": { + "type": "structure", + "members": { + "Statements": { + "target": "com.amazonaws.wafv2#Statements", + "traits": { + "smithy.api#documentation": "

The statements to combine with OR logic. You can use any statements that can be\n nested.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement.

" + } + }, + "com.amazonaws.wafv2#OutputUrl": { + "type": "string" + }, + "com.amazonaws.wafv2#OverrideAction": { + "type": "structure", + "members": { + "Count": { + "target": "com.amazonaws.wafv2#CountAction", + "traits": { + "smithy.api#documentation": "

Override the rule group evaluation result to count only.

\n \n

This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count \n matches, do not use this and instead use the rule action override option, with Count action, in your rule group reference statement settings.

\n " + } + }, + "None": { + "target": "com.amazonaws.wafv2#NoneAction", + "traits": { + "smithy.api#documentation": "

Don't override the rule group evaluation result. This is the most common setting.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.

\n

You can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.

\n \n

This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count \n matches, do not use this and instead use the rule action override option, with Count action, in your rule group reference statement settings.

\n " + } + }, + "com.amazonaws.wafv2#OversizeHandling": { + "type": "enum", + "members": { + "CONTINUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTINUE" + } + }, + "MATCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MATCH" + } + }, + "NO_MATCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_MATCH" + } + } + } + }, + "com.amazonaws.wafv2#PaginationLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.wafv2#ParameterExceptionField": { + "type": "enum", + "members": { + "WEB_ACL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WEB_ACL" + } + }, + "RULE_GROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RULE_GROUP" + } + }, + "REGEX_PATTERN_SET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REGEX_PATTERN_SET" + } + }, + "IP_SET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IP_SET" + } + }, + "MANAGED_RULE_SET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANAGED_RULE_SET" + } + }, + "RULE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RULE" + } + }, + "EXCLUDED_RULE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXCLUDED_RULE" + } + }, + "STATEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STATEMENT" + } + }, + "BYTE_MATCH_STATEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BYTE_MATCH_STATEMENT" + } + }, + "SQLI_MATCH_STATEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SQLI_MATCH_STATEMENT" + } + }, + "XSS_MATCH_STATEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "XSS_MATCH_STATEMENT" + } + }, + "SIZE_CONSTRAINT_STATEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SIZE_CONSTRAINT_STATEMENT" + } + }, + "GEO_MATCH_STATEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GEO_MATCH_STATEMENT" + } + }, + "RATE_BASED_STATEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RATE_BASED_STATEMENT" + } + }, + "RULE_GROUP_REFERENCE_STATEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RULE_GROUP_REFERENCE_STATEMENT" + } + }, + "REGEX_PATTERN_REFERENCE_STATEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REGEX_PATTERN_REFERENCE_STATEMENT" + } + }, + "IP_SET_REFERENCE_STATEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IP_SET_REFERENCE_STATEMENT" + } + }, + "MANAGED_RULE_SET_STATEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANAGED_RULE_SET_STATEMENT" + } + }, + "LABEL_MATCH_STATEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LABEL_MATCH_STATEMENT" + } + }, + "AND_STATEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AND_STATEMENT" + } + }, + "OR_STATEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OR_STATEMENT" + } + }, + "NOT_STATEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_STATEMENT" + } + }, + "IP_ADDRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IP_ADDRESS" + } + }, + "IP_ADDRESS_VERSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IP_ADDRESS_VERSION" + } + }, + "FIELD_TO_MATCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIELD_TO_MATCH" + } + }, + "TEXT_TRANSFORMATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEXT_TRANSFORMATION" + } + }, + "SINGLE_QUERY_ARGUMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SINGLE_QUERY_ARGUMENT" + } + }, + "SINGLE_HEADER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SINGLE_HEADER" + } + }, + "DEFAULT_ACTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEFAULT_ACTION" + } + }, + "RULE_ACTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RULE_ACTION" + } + }, + "ENTITY_LIMIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENTITY_LIMIT" + } + }, + "OVERRIDE_ACTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OVERRIDE_ACTION" + } + }, + "SCOPE_VALUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCOPE_VALUE" + } + }, + "RESOURCE_ARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOURCE_ARN" + } + }, + "RESOURCE_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOURCE_TYPE" + } + }, + "TAGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TAGS" + } + }, + "TAG_KEYS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TAG_KEYS" + } + }, + "METRIC_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "METRIC_NAME" + } + }, + "FIREWALL_MANAGER_STATEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIREWALL_MANAGER_STATEMENT" + } + }, + "FALLBACK_BEHAVIOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FALLBACK_BEHAVIOR" + } + }, + "POSITION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POSITION" + } + }, + "FORWARDED_IP_CONFIG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FORWARDED_IP_CONFIG" + } + }, + "IP_SET_FORWARDED_IP_CONFIG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IP_SET_FORWARDED_IP_CONFIG" + } + }, + "HEADER_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HEADER_NAME" + } + }, + "CUSTOM_REQUEST_HANDLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM_REQUEST_HANDLING" + } + }, + "RESPONSE_CONTENT_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESPONSE_CONTENT_TYPE" + } + }, + "CUSTOM_RESPONSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM_RESPONSE" + } + }, + "CUSTOM_RESPONSE_BODY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM_RESPONSE_BODY" + } + }, + "JSON_MATCH_PATTERN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSON_MATCH_PATTERN" + } + }, + "JSON_MATCH_SCOPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSON_MATCH_SCOPE" + } + }, + "BODY_PARSING_FALLBACK_BEHAVIOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BODY_PARSING_FALLBACK_BEHAVIOR" + } + }, + "LOGGING_FILTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOGGING_FILTER" + } + }, + "FILTER_CONDITION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FILTER_CONDITION" + } + }, + "EXPIRE_TIMESTAMP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPIRE_TIMESTAMP" + } + }, + "CHANGE_PROPAGATION_STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CHANGE_PROPAGATION_STATUS" + } + }, + "ASSOCIABLE_RESOURCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASSOCIABLE_RESOURCE" + } + }, + "LOG_DESTINATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOG_DESTINATION" + } + }, + "MANAGED_RULE_GROUP_CONFIG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANAGED_RULE_GROUP_CONFIG" + } + }, + "PAYLOAD_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PAYLOAD_TYPE" + } + }, + "HEADER_MATCH_PATTERN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HEADER_MATCH_PATTERN" + } + }, + "COOKIE_MATCH_PATTERN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COOKIE_MATCH_PATTERN" + } + }, + "MAP_MATCH_SCOPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAP_MATCH_SCOPE" + } + }, + "OVERSIZE_HANDLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OVERSIZE_HANDLING" + } + }, + "CHALLENGE_CONFIG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CHALLENGE_CONFIG" + } + }, + "TOKEN_DOMAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOKEN_DOMAIN" + } + }, + "ATP_RULE_SET_RESPONSE_INSPECTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ATP_RULE_SET_RESPONSE_INSPECTION" + } + }, + "ASSOCIATED_RESOURCE_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASSOCIATED_RESOURCE_TYPE" + } + }, + "SCOPE_DOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCOPE_DOWN" + } + }, + "CUSTOM_KEYS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM_KEYS" + } + }, + "ACP_RULE_SET_RESPONSE_INSPECTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACP_RULE_SET_RESPONSE_INSPECTION" + } + } + } + }, + "com.amazonaws.wafv2#ParameterExceptionParameter": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.wafv2#PasswordField": { + "type": "structure", + "members": { + "Identifier": { + "target": "com.amazonaws.wafv2#FieldIdentifier", + "traits": { + "smithy.api#documentation": "

The name of the password field.

\n

How you specify this depends on the request inspection payload type.

\n
    \n
  • \n

    For JSON payloads, specify the field name in JSON\n pointer syntax. For information about the JSON Pointer\n syntax, see the Internet Engineering Task Force (IETF)\n documentation JavaScript\n \tObject Notation (JSON) Pointer.

    \n

    For example, for the JSON payload { \"form\": { \"password\": \"THE_PASSWORD\" } }, \n the password field specification is /form/password.

    \n
    • \n
  • \n

    For form encoded payload types, use the HTML form names.

    \n

    For example, for an HTML form with the input element\n named password1, the password field specification is password1.

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The name of the field in the request payload that contains your customer's password.

\n

This data type is used in the RequestInspection and RequestInspectionACFP data types.

" + } + }, + "com.amazonaws.wafv2#PayloadType": { + "type": "enum", + "members": { + "JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSON" + } + }, + "FORM_ENCODED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FORM_ENCODED" + } + } + } + }, + "com.amazonaws.wafv2#PhoneNumberField": { + "type": "structure", + "members": { + "Identifier": { + "target": "com.amazonaws.wafv2#FieldIdentifier", + "traits": { + "smithy.api#documentation": "

The name of a single primary phone number field.

\n

How you specify the phone number fields depends on the request inspection payload type.

\n
    \n
  • \n

    For JSON payloads, specify the field identifiers in JSON\n pointer syntax. For information about the JSON Pointer\n syntax, see the Internet Engineering Task Force (IETF)\n documentation JavaScript\n \tObject Notation (JSON) Pointer.

    \n

    For example, for the JSON payload { \"form\": { \"primaryphoneline1\": \"THE_PHONE1\", \"primaryphoneline2\": \"THE_PHONE2\", \"primaryphoneline3\": \"THE_PHONE3\" } }, \n the phone number field identifiers are /form/primaryphoneline1, /form/primaryphoneline2, and /form/primaryphoneline3.

    \n
    • \n
  • \n

    For form encoded payload types, use the HTML form names.

    \n

    For example, for an HTML form with input elements\n named primaryphoneline1, primaryphoneline2, and primaryphoneline3, the phone number field identifiers are primaryphoneline1, primaryphoneline2, and primaryphoneline3.

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The name of a field in the request payload that contains part or all of your customer's primary phone number.

\n

This data type is used in the RequestInspectionACFP data type.

" + } + }, + "com.amazonaws.wafv2#PhoneNumberFields": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#PhoneNumberField" + } + }, + "com.amazonaws.wafv2#Platform": { + "type": "enum", + "members": { + "IOS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IOS" + } + }, + "ANDROID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANDROID" + } + } + } + }, + "com.amazonaws.wafv2#PolicyString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 395000 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.wafv2#PopulationSize": { + "type": "long", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.wafv2#PositionalConstraint": { + "type": "enum", + "members": { + "EXACTLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXACTLY" + } + }, + "STARTS_WITH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTS_WITH" + } + }, + "ENDS_WITH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENDS_WITH" + } + }, + "CONTAINS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTAINS" + } + }, + "CONTAINS_WORD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTAINS_WORD" + } + } + } + }, + "com.amazonaws.wafv2#ProductDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.wafv2#ProductId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.wafv2#ProductLink": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.wafv2#ProductTitle": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.wafv2#PublishedVersions": { + "type": "map", + "key": { + "target": "com.amazonaws.wafv2#VersionKeyString" + }, + "value": { + "target": "com.amazonaws.wafv2#ManagedRuleSetVersion" + } + }, + "com.amazonaws.wafv2#PutLoggingConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#PutLoggingConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#PutLoggingConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFLimitsExceededException" + }, + { + "target": "com.amazonaws.wafv2#WAFLogDestinationPermissionIssueException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFOptimisticLockException" + }, + { + "target": "com.amazonaws.wafv2#WAFServiceLinkedRoleErrorException" + } + ], + "traits": { + "smithy.api#documentation": "

Enables the specified LoggingConfiguration, to start logging from a\n web ACL, according to the configuration provided.

\n \n

This operation completely replaces any mutable specifications that you already have for a logging configuration with the ones that you provide to this call.

\n

To modify an existing logging configuration, do the following:

\n
    \n
  1. \n

    Retrieve it by calling GetLoggingConfiguration\n

    \n
    2. \n
  2. \n

    Update its settings as needed

    \n
    3. \n
  3. \n

    Provide the complete logging configuration specification to this call

    \n
    4. \n
\n \n \n

You can define one logging destination per web ACL.

\n \n

You can access information about the traffic that WAF inspects using the following\n steps:

\n
    \n
  1. \n

    Create your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose.

    \n

    The name that you give the destination must start with aws-waf-logs-. Depending on the type of destination, you might need to configure additional settings or permissions.

    \n

    For configuration requirements and pricing information for each destination type, see \n Logging web ACL traffic \n in the WAF Developer Guide.

    \n
    2. \n
  2. \n

    Associate your logging destination to your web ACL using a\n PutLoggingConfiguration request.

    \n
    3. \n
\n

When you successfully enable logging using a PutLoggingConfiguration\n request, WAF creates an additional role or policy that is required to write\n logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group.\n For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role.

\n

For additional information about web ACL logging, see \n Logging web ACL traffic information \n in the WAF Developer Guide.

" + } + }, + "com.amazonaws.wafv2#PutLoggingConfigurationRequest": { + "type": "structure", + "members": { + "LoggingConfiguration": { + "target": "com.amazonaws.wafv2#LoggingConfiguration", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#PutLoggingConfigurationResponse": { + "type": "structure", + "members": { + "LoggingConfiguration": { + "target": "com.amazonaws.wafv2#LoggingConfiguration", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#PutManagedRuleSetVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#PutManagedRuleSetVersionsRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#PutManagedRuleSetVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFOptimisticLockException" + } + ], + "traits": { + "smithy.api#documentation": "

Defines the versions of your managed rule set that you are offering to the customers.\n Customers see your offerings as managed rule groups with versioning.

\n \n

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

\n

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

\n \n

Customers retrieve their managed rule group list by calling ListAvailableManagedRuleGroups. The name that you provide here for your\n managed rule set is the name the customer sees for the corresponding managed rule group.\n Customers can retrieve the available versions for a managed rule group by calling ListAvailableManagedRuleGroupVersions. You provide a rule group\n specification for each version. For each managed rule set, you must specify a version that\n you recommend using.

\n

To initiate the expiration of a managed rule group version, use UpdateManagedRuleSetVersionExpiryDate.

" + } + }, + "com.amazonaws.wafv2#PutManagedRuleSetVersionsRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

\n

This name is assigned to the corresponding managed rule group, which your customers can access and use.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n
    \n
  • \n

    CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    \n
    • \n
  • \n

    API and SDKs - For all calls, use the Region endpoint us-east-1.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.

", + "smithy.api#required": {} + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", + "smithy.api#required": {} + } + }, + "RecommendedVersion": { + "target": "com.amazonaws.wafv2#VersionKeyString", + "traits": { + "smithy.api#documentation": "

The version of the named managed rule group that you'd like your customers to choose,\n from among your version offerings.

" + } + }, + "VersionsToPublish": { + "target": "com.amazonaws.wafv2#VersionsToPublish", + "traits": { + "smithy.api#documentation": "

The versions of the named managed rule group that you want to offer to your customers.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#PutManagedRuleSetVersionsResponse": { + "type": "structure", + "members": { + "NextLockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#PutPermissionPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#PutPermissionPolicyRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#PutPermissionPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidPermissionPolicyException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + } + ], + "traits": { + "smithy.api#documentation": "

Use this to share a rule group with other accounts.

\n

This action attaches an IAM policy to the specified resource. You must be the owner of the rule group to perform this operation.

\n

This action is subject to the following restrictions:

\n
    \n
  • \n

    You can attach only one policy with each PutPermissionPolicy\n request.

    \n
    • \n
  • \n

    The ARN in the request must be a valid WAF RuleGroup ARN and the\n rule group must exist in the same Region.

    \n
    • \n
  • \n

    The user making the request must be the owner of the rule group.

    \n
    • \n
\n

If a rule group has been shared with your account, you can access it through the call GetRuleGroup, \n and you can reference it in CreateWebACL and UpdateWebACL. \n Rule groups that are shared with you don't appear in your WAF console rule groups listing.

" + } + }, + "com.amazonaws.wafv2#PutPermissionPolicyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the RuleGroup to which you want to\n attach the policy.

", + "smithy.api#required": {} + } + }, + "Policy": { + "target": "com.amazonaws.wafv2#PolicyString", + "traits": { + "smithy.api#documentation": "

The policy to attach to the specified rule group.

\n

The policy specifications must conform to the following:

\n
    \n
  • \n

    The policy must be composed using IAM Policy version 2012-10-17.

    \n
    • \n
  • \n

    The policy must include specifications for Effect, Action, and Principal.

    \n
    • \n
  • \n

    \n Effect must specify Allow.

    \n
    • \n
  • \n

    \n Action must specify wafv2:CreateWebACL, wafv2:UpdateWebACL, and \n wafv2:PutFirewallManagerRuleGroups and may optionally specify wafv2:GetRuleGroup. \n WAF rejects any extra actions or wildcard actions in the policy.

    \n
    • \n
  • \n

    The policy must not include a Resource parameter.

    \n
    • \n
\n

For more information, see IAM Policies.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#PutPermissionPolicyResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#QueryString": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Inspect the query string of the web request. This is the part of a URL that appears\n after a ? character, if any.

\n

This is used in the FieldToMatch specification for some web request component types.

\n

JSON specification: \"QueryString\": {}\n

" + } + }, + "com.amazonaws.wafv2#RateBasedStatement": { + "type": "structure", + "members": { + "Limit": { + "target": "com.amazonaws.wafv2#RateLimit", + "traits": { + "smithy.api#documentation": "

The limit on requests per 5-minute period for a single aggregation instance for the rate-based rule. \n If the rate-based statement includes a ScopeDownStatement, this limit is applied only to the\n requests that match the statement.

\n

Examples:

\n
    \n
  • \n

    If you aggregate on just the IP address, this is the limit on requests from any single IP address.

    \n
    • \n
  • \n

    If you aggregate on the HTTP method and the query argument name \"city\", then this is the limit on\n requests for any single method, city pair.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "EvaluationWindowSec": { + "target": "com.amazonaws.wafv2#EvaluationWindowSec", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The amount of time, in seconds, that WAF\n should include in its request counts, looking back from the current time. For example, \n for a setting of 120, when WAF checks the rate, it counts the requests for the 2 minutes immediately preceding \n the current time. Valid settings are 60, 120, 300, and 600.

\n

This setting doesn't determine how often WAF checks the rate, but how far back it looks each \n time it checks. WAF checks the rate about every 10 seconds.

\n

Default: 300 (5 minutes)

" + } + }, + "AggregateKeyType": { + "target": "com.amazonaws.wafv2#RateBasedStatementAggregateKeyType", + "traits": { + "smithy.api#documentation": "

Setting that indicates how to aggregate the request counts.

\n \n

Web requests that are missing any of the components specified in the aggregation keys\n are omitted from the rate-based rule evaluation and handling.

\n \n
    \n
  • \n

    \n CONSTANT - Count and limit the requests that match the rate-based rule's scope-down \n statement. With this option, the counted requests aren't further aggregated. The scope-down statement \n is the only specification used. When the count of all requests that satisfy the scope-down statement\n goes over the limit, WAF applies the rule action to all requests that satisfy the scope-down statement.

    \n

    With this option, you must configure the ScopeDownStatement property.

    \n
    • \n
  • \n

    \n CUSTOM_KEYS - Aggregate the request counts using one or more web request components as the aggregate keys.

    \n

    With this option, you must specify the aggregate keys in the CustomKeys property.

    \n

    To aggregate on only the IP address or only the forwarded IP address, don't use custom keys. Instead, set the aggregate\n key type to IP or FORWARDED_IP.

    \n
    • \n
  • \n

    \n FORWARDED_IP - Aggregate the request counts on the first IP address in an HTTP header.

    \n

    With this option, you must specify the header to use in the ForwardedIPConfig property.

    \n

    To aggregate on a combination of the forwarded IP address with other aggregate keys, use CUSTOM_KEYS.

    \n
    • \n
  • \n

    \n IP - Aggregate the request counts on the IP address from the web request\n origin.

    \n

    To aggregate on a combination of the IP address with other aggregate keys, use CUSTOM_KEYS.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "ScopeDownStatement": { + "target": "com.amazonaws.wafv2#Statement", + "traits": { + "smithy.api#documentation": "

An optional nested statement that narrows the scope of the web requests that are\n evaluated and managed by the rate-based statement. When you use a scope-down statement, \n the rate-based rule only tracks and rate limits \n requests that match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any\n level, the same as you can for a rule statement.

" + } + }, + "ForwardedIPConfig": { + "target": "com.amazonaws.wafv2#ForwardedIPConfig", + "traits": { + "smithy.api#documentation": "

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

\n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n \n

This is required if you specify a forwarded IP in the rule's aggregate key settings.

" + } + }, + "CustomKeys": { + "target": "com.amazonaws.wafv2#RateBasedStatementCustomKeys", + "traits": { + "smithy.api#documentation": "

Specifies the aggregate keys to use in a rate-base rule.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A rate-based rule counts incoming requests and rate limits requests when they are coming at too fast a rate. The rule categorizes requests according to your aggregation criteria, collects them into aggregation instances, and counts and rate limits the requests for each instance.

\n \n

If you change any of these settings in a rule that's currently in use, the change resets the rule's rate limiting counts. This can pause the rule's rate limiting activities for up to a minute.

\n \n

You can specify individual aggregation keys, like IP address or HTTP method. You can also specify aggregation key combinations, like IP address and HTTP method, or HTTP method, query argument, and cookie.

\n

Each unique set of values for the aggregation keys that you specify is a separate aggregation instance, with the value from each key contributing to the aggregation instance definition.

\n

For example, assume the rule evaluates web requests with the following IP address and HTTP method values:

\n
    \n
  • \n

    IP address 10.1.1.1, HTTP method POST

    \n
    • \n
  • \n

    IP address 10.1.1.1, HTTP method GET

    \n
    • \n
  • \n

    IP address 127.0.0.0, HTTP method POST

    \n
    • \n
  • \n

    IP address 10.1.1.1, HTTP method GET

    \n
    • \n
\n

The rule would create different aggregation instances according to your aggregation criteria, for example:

\n
    \n
  • \n

    If the aggregation criteria is just the IP address, then each individual address is an aggregation instance, and WAF counts requests separately for each. The aggregation instances and request counts for our example would be the following:

    \n
      \n
    • \n

      IP address 10.1.1.1: count 3

      \n
      • \n
    • \n

      IP address 127.0.0.0: count 1

      \n
      • \n
    \n
    • \n
  • \n

    If the aggregation criteria is HTTP method, then each individual HTTP method is an aggregation instance. The aggregation instances and request counts for our example would be the following:

    \n
      \n
    • \n

      HTTP method POST: count 2

      \n
      • \n
    • \n

      HTTP method GET: count 2

      \n
      • \n
    \n
    • \n
  • \n

    If the aggregation criteria is IP address and HTTP method, then each IP address and each HTTP method would contribute to the combined aggregation instance. The aggregation instances and request counts for our example would be the following:

    \n
      \n
    • \n

      IP address 10.1.1.1, HTTP method POST: count 1

      \n
      • \n
    • \n

      IP address 10.1.1.1, HTTP method GET: count 2

      \n
      • \n
    • \n

      IP address 127.0.0.0, HTTP method POST: count 1

      \n
      • \n
    \n
    • \n
\n

For any n-tuple of aggregation keys, each unique combination of values for the keys defines a separate aggregation instance, which WAF counts and rate-limits individually.

\n

You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts and rate limits requests that match the nested statement. You can use this nested scope-down statement in conjunction with your aggregation key specifications or you can just count and rate limit all requests that match the scope-down statement, without additional aggregation. When you choose to just manage all requests that match a scope-down statement, the aggregation instance is singular for the rule.

\n

You cannot nest a RateBasedStatement inside another statement, for example inside a NotStatement or OrStatement. You can define a RateBasedStatement inside a web ACL and inside a rule group.

\n

For additional information about the options, see Rate limiting web requests using rate-based rules \n in the WAF Developer Guide.

\n

If you only aggregate on the individual IP address or forwarded IP address, you can retrieve the list of IP addresses that WAF \n is currently rate limiting for a rule through the API call GetRateBasedStatementManagedKeys. This option is not available\n for other aggregation configurations.

\n

WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by WAF. If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by WAF.

" + } + }, + "com.amazonaws.wafv2#RateBasedStatementAggregateKeyType": { + "type": "enum", + "members": { + "IP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IP" + } + }, + "FORWARDED_IP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FORWARDED_IP" + } + }, + "CUSTOM_KEYS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM_KEYS" + } + }, + "CONSTANT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONSTANT" + } + } + } + }, + "com.amazonaws.wafv2#RateBasedStatementCustomKey": { + "type": "structure", + "members": { + "Header": { + "target": "com.amazonaws.wafv2#RateLimitHeader", + "traits": { + "smithy.api#documentation": "

Use the value of a header in the request as an aggregate key. Each distinct value in the header contributes to the aggregation instance. If you use a single \n header as your custom key, then each value fully defines an aggregation instance.

" + } + }, + "Cookie": { + "target": "com.amazonaws.wafv2#RateLimitCookie", + "traits": { + "smithy.api#documentation": "

Use the value of a cookie in the request as an aggregate key. Each distinct value in the cookie contributes to the aggregation instance. If you use a single\n cookie as your custom key, then each value fully defines an aggregation instance.

" + } + }, + "QueryArgument": { + "target": "com.amazonaws.wafv2#RateLimitQueryArgument", + "traits": { + "smithy.api#documentation": "

Use the specified query argument as an aggregate key. Each distinct value for the named query argument contributes to the aggregation instance. If you \n use a single query argument as your custom key, then each value fully defines an aggregation instance.

" + } + }, + "QueryString": { + "target": "com.amazonaws.wafv2#RateLimitQueryString", + "traits": { + "smithy.api#documentation": "

Use the request's query string as an aggregate key. Each distinct string contributes to the aggregation instance. If you use just the \n query string as your custom key, then each string fully defines an aggregation instance.

" + } + }, + "HTTPMethod": { + "target": "com.amazonaws.wafv2#RateLimitHTTPMethod", + "traits": { + "smithy.api#documentation": "

Use the request's HTTP method as an aggregate key. Each distinct HTTP method contributes to the aggregation instance. If you use just the HTTP method\n as your custom key, then each method fully defines an aggregation instance.

" + } + }, + "ForwardedIP": { + "target": "com.amazonaws.wafv2#RateLimitForwardedIP", + "traits": { + "smithy.api#documentation": "

Use the first IP address in an HTTP header as an aggregate key. Each distinct forwarded IP address contributes to the aggregation instance.

\n

When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use.\n You can aggregate on only the forwarded IP address by specifying FORWARDED_IP in your rate-based statement's AggregateKeyType.

\n

With this option, you must specify the header to use in the rate-based rule's ForwardedIPConfig property.

" + } + }, + "IP": { + "target": "com.amazonaws.wafv2#RateLimitIP", + "traits": { + "smithy.api#documentation": "

Use the request's originating IP address as an aggregate key. Each distinct IP address contributes to the aggregation instance.

\n

When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use.\n You can aggregate on only the IP address by specifying IP in your rate-based statement's AggregateKeyType.

" + } + }, + "LabelNamespace": { + "target": "com.amazonaws.wafv2#RateLimitLabelNamespace", + "traits": { + "smithy.api#documentation": "

Use the specified label namespace as an aggregate key. Each distinct fully qualified label name that has the specified label namespace contributes to the aggregation instance. If you use just one label namespace as your custom key, then each label name fully defines an aggregation instance.

\n

This uses only labels that have been added to the request by rules that are evaluated before this rate-based rule in the web ACL.

\n

For information about label namespaces and names, see \n Label syntax and naming requirements in the WAF Developer Guide.

" + } + }, + "UriPath": { + "target": "com.amazonaws.wafv2#RateLimitUriPath", + "traits": { + "smithy.api#documentation": "

Use the request's URI path as an aggregate key. Each distinct URI path contributes to the aggregation instance. If you use just the \n URI path as your custom key, then each URI path fully defines an aggregation instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies a single custom aggregate key for a rate-base rule.

\n \n

Web requests that are missing any of the components specified in the aggregation keys\n are omitted from the rate-based rule evaluation and handling.

\n " + } + }, + "com.amazonaws.wafv2#RateBasedStatementCustomKeys": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#RateBasedStatementCustomKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.wafv2#RateBasedStatementManagedKeysIPSet": { + "type": "structure", + "members": { + "IPAddressVersion": { + "target": "com.amazonaws.wafv2#IPAddressVersion", + "traits": { + "smithy.api#documentation": "

The version of the IP addresses, either IPV4 or IPV6.

" + } + }, + "Addresses": { + "target": "com.amazonaws.wafv2#IPAddresses", + "traits": { + "smithy.api#documentation": "

The IP addresses that are currently blocked.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The set of IP addresses that are currently blocked for a RateBasedStatement. This is only available for rate-based rules \n that aggregate on just the IP address, with the AggregateKeyType set to IP or FORWARDED_IP.

\n

A rate-based rule applies its rule action to requests from IP addresses that are in the rule's managed keys list and that match the rule's scope-down statement. When a rule has no scope-down statement, it applies the action to all requests from the IP addresses that are in the list. The rule applies its rule action to rate limit the matching requests. The action is usually Block but it can be any valid rule action except for Allow.

\n

The maximum number of IP addresses that can be rate limited by a single rate-based rule instance is 10,000. If more than 10,000 addresses exceed the rate limit, WAF limits those with the highest rates.

" + } + }, + "com.amazonaws.wafv2#RateLimit": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 10, + "max": 2000000000 + } + } + }, + "com.amazonaws.wafv2#RateLimitCookie": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#FieldToMatchData", + "traits": { + "smithy.api#documentation": "

The name of the cookie to use.

", + "smithy.api#required": {} + } + }, + "TextTransformations": { + "target": "com.amazonaws.wafv2#TextTransformations", + "traits": { + "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies a cookie as an aggregate key for a rate-based rule. Each distinct value in the cookie contributes to the aggregation instance. If you use a single\n cookie as your custom key, then each value fully defines an aggregation instance.

" + } + }, + "com.amazonaws.wafv2#RateLimitForwardedIP": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Specifies the first IP address in an HTTP header as an aggregate key for a rate-based rule. Each distinct forwarded IP address contributes to the aggregation instance.

\n

This setting is used only in the RateBasedStatementCustomKey specification of a rate-based rule statement.\n When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use.\n You can aggregate on only the forwarded IP address by specifying FORWARDED_IP in your rate-based statement's AggregateKeyType.

\n

This data type supports using the forwarded IP address in the web request aggregation for a rate-based rule, in RateBasedStatementCustomKey. The JSON specification for using the forwarded IP address doesn't explicitly use this data type.

\n

JSON specification: \"ForwardedIP\": {}\n

\n

When you use this specification, you must also configure the forwarded IP address in the rate-based statement's ForwardedIPConfig.

" + } + }, + "com.amazonaws.wafv2#RateLimitHTTPMethod": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Specifies the request's HTTP method as an aggregate key for a rate-based rule. Each distinct HTTP method contributes to the aggregation instance. If you use just the HTTP method\n as your custom key, then each method fully defines an aggregation instance.

\n

JSON specification: \"RateLimitHTTPMethod\": {}\n

" + } + }, + "com.amazonaws.wafv2#RateLimitHeader": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#FieldToMatchData", + "traits": { + "smithy.api#documentation": "

The name of the header to use.

", + "smithy.api#required": {} + } + }, + "TextTransformations": { + "target": "com.amazonaws.wafv2#TextTransformations", + "traits": { + "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies a header as an aggregate key for a rate-based rule. Each distinct value in the header contributes to the aggregation instance. If you use a single \n header as your custom key, then each value fully defines an aggregation instance.

" + } + }, + "com.amazonaws.wafv2#RateLimitIP": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Specifies the IP address in the web request as an aggregate key for a rate-based rule. Each distinct IP address contributes to the aggregation instance.

\n

This setting is used only in the RateBasedStatementCustomKey specification of a rate-based rule statement.\n To use this in the custom key settings, you must specify at least one other key to use, along with the IP address. \n To aggregate on only the IP address, in your rate-based statement's AggregateKeyType, specify IP.

\n

JSON specification: \"RateLimitIP\": {}\n

" + } + }, + "com.amazonaws.wafv2#RateLimitLabelNamespace": { + "type": "structure", + "members": { + "Namespace": { + "target": "com.amazonaws.wafv2#LabelNamespace", + "traits": { + "smithy.api#documentation": "

The namespace to use for aggregation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies a label namespace to use as an aggregate key for a rate-based rule. Each distinct fully qualified label name that has the specified label namespace contributes to the aggregation instance. If you use just one label namespace as your custom key, then each label name fully defines an aggregation instance.

\n

This uses only labels that have been added to the request by rules that are evaluated before this rate-based rule in the web ACL.

\n

For information about label namespaces and names, see \n Label syntax and naming requirements in the WAF Developer Guide.

" + } + }, + "com.amazonaws.wafv2#RateLimitQueryArgument": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#FieldToMatchData", + "traits": { + "smithy.api#documentation": "

The name of the query argument to use.

", + "smithy.api#required": {} + } + }, + "TextTransformations": { + "target": "com.amazonaws.wafv2#TextTransformations", + "traits": { + "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies a query argument in the request as an aggregate key for a rate-based rule. Each distinct value for the named query argument contributes to the aggregation instance. If you \n use a single query argument as your custom key, then each value fully defines an aggregation instance.

" + } + }, + "com.amazonaws.wafv2#RateLimitQueryString": { + "type": "structure", + "members": { + "TextTransformations": { + "target": "com.amazonaws.wafv2#TextTransformations", + "traits": { + "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the request's query string as an aggregate key for a rate-based rule. Each distinct string contributes to the aggregation instance. If you use just the \n query string as your custom key, then each string fully defines an aggregation instance.

" + } + }, + "com.amazonaws.wafv2#RateLimitUriPath": { + "type": "structure", + "members": { + "TextTransformations": { + "target": "com.amazonaws.wafv2#TextTransformations", + "traits": { + "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the request's URI path as an aggregate key for a rate-based rule. Each distinct URI path contributes to the aggregation instance. If you use just the \n URI path as your custom key, then each URI path fully defines an aggregation instance.

" + } + }, + "com.amazonaws.wafv2#RedactedFields": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#FieldToMatch" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.wafv2#Regex": { + "type": "structure", + "members": { + "RegexString": { + "target": "com.amazonaws.wafv2#RegexPatternString", + "traits": { + "smithy.api#documentation": "

The string representing the regular expression.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A single regular expression. This is used in a RegexPatternSet.

" + } + }, + "com.amazonaws.wafv2#RegexMatchStatement": { + "type": "structure", + "members": { + "RegexString": { + "target": "com.amazonaws.wafv2#RegexPatternString", + "traits": { + "smithy.api#documentation": "

The string representing the regular expression.

", + "smithy.api#required": {} + } + }, + "FieldToMatch": { + "target": "com.amazonaws.wafv2#FieldToMatch", + "traits": { + "smithy.api#documentation": "

The part of the web request that you want WAF to inspect.

", + "smithy.api#required": {} + } + }, + "TextTransformations": { + "target": "com.amazonaws.wafv2#TextTransformations", + "traits": { + "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A rule statement used to search web request components for a match against a single regular expression.

" + } + }, + "com.amazonaws.wafv2#RegexPatternSet": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the set. You cannot change the name after you create the set.

" + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

" + } + }, + "ARN": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the entity.

" + } + }, + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", + "traits": { + "smithy.api#documentation": "

A description of the set that helps with identification.

" + } + }, + "RegularExpressionList": { + "target": "com.amazonaws.wafv2#RegularExpressionList", + "traits": { + "smithy.api#documentation": "

The regular expression patterns in the set.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains one or more regular expressions.

\n

WAF assigns an ARN to each RegexPatternSet that you create. To use a\n set in a rule, you provide the ARN to the Rule statement RegexPatternSetReferenceStatement.

" + } + }, + "com.amazonaws.wafv2#RegexPatternSetReferenceStatement": { + "type": "structure", + "members": { + "ARN": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the RegexPatternSet that this\n statement references.

", + "smithy.api#required": {} + } + }, + "FieldToMatch": { + "target": "com.amazonaws.wafv2#FieldToMatch", + "traits": { + "smithy.api#documentation": "

The part of the web request that you want WAF to inspect.

", + "smithy.api#required": {} + } + }, + "TextTransformations": { + "target": "com.amazonaws.wafv2#TextTransformations", + "traits": { + "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.

\n

Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.

" + } + }, + "com.amazonaws.wafv2#RegexPatternSetSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#RegexPatternSetSummary" + } + }, + "com.amazonaws.wafv2#RegexPatternSetSummary": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the data type instance. You cannot change the name after you create the instance.

" + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

" + } + }, + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", + "traits": { + "smithy.api#documentation": "

A description of the set that helps with identification.

" + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" + } + }, + "ARN": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the entity.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

High-level information about a RegexPatternSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RegexPatternSet, and the ARN, that you provide to the RegexPatternSetReferenceStatement to use the pattern set in a Rule.

" + } + }, + "com.amazonaws.wafv2#RegexPatternString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.wafv2#RegistrationPagePathString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.wafv2#RegularExpressionList": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#Regex" + } + }, + "com.amazonaws.wafv2#ReleaseNotes": { + "type": "string" + }, + "com.amazonaws.wafv2#ReleaseSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#ReleaseSummary" + } + }, + "com.amazonaws.wafv2#ReleaseSummary": { + "type": "structure", + "members": { + "ReleaseVersion": { + "target": "com.amazonaws.wafv2#VersionKeyString", + "traits": { + "smithy.api#documentation": "

The release version.

" + } + }, + "Timestamp": { + "target": "com.amazonaws.wafv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of the release.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

High level information for an SDK release.

" + } + }, + "com.amazonaws.wafv2#RequestBody": { + "type": "map", + "key": { + "target": "com.amazonaws.wafv2#AssociatedResourceType" + }, + "value": { + "target": "com.amazonaws.wafv2#RequestBodyAssociatedResourceTypeConfig" + } + }, + "com.amazonaws.wafv2#RequestBodyAssociatedResourceTypeConfig": { + "type": "structure", + "members": { + "DefaultSizeInspectionLimit": { + "target": "com.amazonaws.wafv2#SizeInspectionLimit", + "traits": { + "smithy.api#documentation": "

Specifies the maximum size of the web request body component that an associated CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resource should send to WAF for inspection. This applies to statements in the web ACL that inspect the body or JSON body.

\n

Default: 16 KB (16,384 bytes)\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Customizes the maximum size of the request body that your protected CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access resources forward to WAF for inspection. The default size is 16 KB (16,384 bytes). You can change the setting for any of the available resource types.

\n \n

You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.

\n \n

Example JSON: {\n \"API_GATEWAY\": \"KB_48\",\n \"APP_RUNNER_SERVICE\": \"KB_32\"\n }\n

\n

For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).

\n

This is used in the AssociationConfig of the web ACL.

" + } + }, + "com.amazonaws.wafv2#RequestInspection": { + "type": "structure", + "members": { + "PayloadType": { + "target": "com.amazonaws.wafv2#PayloadType", + "traits": { + "smithy.api#documentation": "

The payload type for your login endpoint, either JSON or form encoded.

", + "smithy.api#required": {} + } + }, + "UsernameField": { + "target": "com.amazonaws.wafv2#UsernameField", + "traits": { + "smithy.api#documentation": "

The name of the field in the request payload that contains your customer's username.

\n

How you specify this depends on the request inspection payload type.

\n
    \n
  • \n

    For JSON payloads, specify the field name in JSON\n pointer syntax. For information about the JSON Pointer\n syntax, see the Internet Engineering Task Force (IETF)\n documentation JavaScript\n \tObject Notation (JSON) Pointer.

    \n

    For example, for the JSON payload { \"form\": { \"username\": \"THE_USERNAME\" } }, \n the username field specification is /form/username.

    \n
    • \n
  • \n

    For form encoded payload types, use the HTML form names.

    \n

    For example, for an HTML form with the input element\n named username1, the username field specification is\n username1\n

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "PasswordField": { + "target": "com.amazonaws.wafv2#PasswordField", + "traits": { + "smithy.api#documentation": "

The name of the field in the request payload that contains your customer's password.

\n

How you specify this depends on the request inspection payload type.

\n
    \n
  • \n

    For JSON payloads, specify the field name in JSON\n pointer syntax. For information about the JSON Pointer\n syntax, see the Internet Engineering Task Force (IETF)\n documentation JavaScript\n \tObject Notation (JSON) Pointer.

    \n

    For example, for the JSON payload { \"form\": { \"password\": \"THE_PASSWORD\" } }, \n the password field specification is /form/password.

    \n
    • \n
  • \n

    For form encoded payload types, use the HTML form names.

    \n

    For example, for an HTML form with the input element\n named password1, the password field specification is password1.

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The criteria for inspecting login requests, used by the ATP rule group to validate credentials usage.

\n

This is part of the AWSManagedRulesATPRuleSet configuration in ManagedRuleGroupConfig.

\n

In these settings, you specify how your application accepts login attempts\n by providing the request payload type and the names of the fields \n within the request body where the username and password are provided.

" + } + }, + "com.amazonaws.wafv2#RequestInspectionACFP": { + "type": "structure", + "members": { + "PayloadType": { + "target": "com.amazonaws.wafv2#PayloadType", + "traits": { + "smithy.api#documentation": "

The payload type for your account creation endpoint, either JSON or form encoded.

", + "smithy.api#required": {} + } + }, + "UsernameField": { + "target": "com.amazonaws.wafv2#UsernameField", + "traits": { + "smithy.api#documentation": "

The name of the field in the request payload that contains your customer's username.

\n

How you specify this depends on the request inspection payload type.

\n
    \n
  • \n

    For JSON payloads, specify the field name in JSON\n pointer syntax. For information about the JSON Pointer\n syntax, see the Internet Engineering Task Force (IETF)\n documentation JavaScript\n \tObject Notation (JSON) Pointer.

    \n

    For example, for the JSON payload { \"form\": { \"username\": \"THE_USERNAME\" } }, \n the username field specification is /form/username.

    \n
    • \n
  • \n

    For form encoded payload types, use the HTML form names.

    \n

    For example, for an HTML form with the input element\n named username1, the username field specification is\n username1\n

    \n
    • \n
" + } + }, + "PasswordField": { + "target": "com.amazonaws.wafv2#PasswordField", + "traits": { + "smithy.api#documentation": "

The name of the field in the request payload that contains your customer's password.

\n

How you specify this depends on the request inspection payload type.

\n
    \n
  • \n

    For JSON payloads, specify the field name in JSON\n pointer syntax. For information about the JSON Pointer\n syntax, see the Internet Engineering Task Force (IETF)\n documentation JavaScript\n \tObject Notation (JSON) Pointer.

    \n

    For example, for the JSON payload { \"form\": { \"password\": \"THE_PASSWORD\" } }, \n the password field specification is /form/password.

    \n
    • \n
  • \n

    For form encoded payload types, use the HTML form names.

    \n

    For example, for an HTML form with the input element\n named password1, the password field specification is password1.

    \n
    • \n
" + } + }, + "EmailField": { + "target": "com.amazonaws.wafv2#EmailField", + "traits": { + "smithy.api#documentation": "

The name of the field in the request payload that contains your customer's email.

\n

How you specify this depends on the request inspection payload type.

\n
    \n
  • \n

    For JSON payloads, specify the field name in JSON\n pointer syntax. For information about the JSON Pointer\n syntax, see the Internet Engineering Task Force (IETF)\n documentation JavaScript\n \tObject Notation (JSON) Pointer.

    \n

    For example, for the JSON payload { \"form\": { \"email\": \"THE_EMAIL\" } }, \n the email field specification is /form/email.

    \n
    • \n
  • \n

    For form encoded payload types, use the HTML form names.

    \n

    For example, for an HTML form with the input element\n named email1, the email field specification is email1.

    \n
    • \n
" + } + }, + "PhoneNumberFields": { + "target": "com.amazonaws.wafv2#PhoneNumberFields", + "traits": { + "smithy.api#documentation": "

The names of the fields in the request payload that contain your customer's primary phone number.

\n

Order the phone number fields in the array exactly as they are ordered in the request payload.

\n

How you specify the phone number fields depends on the request inspection payload type.

\n
    \n
  • \n

    For JSON payloads, specify the field identifiers in JSON\n pointer syntax. For information about the JSON Pointer\n syntax, see the Internet Engineering Task Force (IETF)\n documentation JavaScript\n \tObject Notation (JSON) Pointer.

    \n

    For example, for the JSON payload { \"form\": { \"primaryphoneline1\": \"THE_PHONE1\", \"primaryphoneline2\": \"THE_PHONE2\", \"primaryphoneline3\": \"THE_PHONE3\" } }, \n the phone number field identifiers are /form/primaryphoneline1, /form/primaryphoneline2, and /form/primaryphoneline3.

    \n
    • \n
  • \n

    For form encoded payload types, use the HTML form names.

    \n

    For example, for an HTML form with input elements\n named primaryphoneline1, primaryphoneline2, and primaryphoneline3, the phone number field identifiers are primaryphoneline1, primaryphoneline2, and primaryphoneline3.

    \n
    • \n
" + } + }, + "AddressFields": { + "target": "com.amazonaws.wafv2#AddressFields", + "traits": { + "smithy.api#documentation": "

The names of the fields in the request payload that contain your customer's primary physical address.

\n

Order the address fields in the array exactly as they are ordered in the request payload.

\n

How you specify the address fields depends on the request inspection payload type.

\n
    \n
  • \n

    For JSON payloads, specify the field identifiers in JSON\n pointer syntax. For information about the JSON Pointer\n syntax, see the Internet Engineering Task Force (IETF)\n documentation JavaScript\n \tObject Notation (JSON) Pointer.

    \n

    For example, for the JSON payload { \"form\": { \"primaryaddressline1\": \"THE_ADDRESS1\", \"primaryaddressline2\": \"THE_ADDRESS2\", \"primaryaddressline3\": \"THE_ADDRESS3\" } }, \n the address field idenfiers are /form/primaryaddressline1, /form/primaryaddressline2, and /form/primaryaddressline3.

    \n
    • \n
  • \n

    For form encoded payload types, use the HTML form names.

    \n

    For example, for an HTML form with input elements\n named primaryaddressline1, primaryaddressline2, and primaryaddressline3, the address fields identifiers are primaryaddressline1, primaryaddressline2, and primaryaddressline3.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

The criteria for inspecting account creation requests, used by the ACFP rule group to validate and track account creation attempts.

\n

This is part of the AWSManagedRulesACFPRuleSet configuration in ManagedRuleGroupConfig.

\n

In these settings, you specify how your application accepts account creation attempts\n by providing the request payload type and the names of the fields \n within the request body where the username, password, email, and primary address and phone number fields are provided.

" + } + }, + "com.amazonaws.wafv2#ResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.wafv2#ResourceArns": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#ResourceArn" + } + }, + "com.amazonaws.wafv2#ResourceType": { + "type": "enum", + "members": { + "APPLICATION_LOAD_BALANCER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPLICATION_LOAD_BALANCER" + } + }, + "API_GATEWAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "API_GATEWAY" + } + }, + "APPSYNC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPSYNC" + } + }, + "COGNITIO_USER_POOL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COGNITO_USER_POOL" + } + }, + "APP_RUNNER_SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APP_RUNNER_SERVICE" + } + }, + "VERIFIED_ACCESS_INSTANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VERIFIED_ACCESS_INSTANCE" + } + } + } + }, + "com.amazonaws.wafv2#ResponseCode": { + "type": "integer" + }, + "com.amazonaws.wafv2#ResponseContent": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10240 + }, + "smithy.api#pattern": "^[\\s\\S]*$" + } + }, + "com.amazonaws.wafv2#ResponseContentType": { + "type": "enum", + "members": { + "TEXT_PLAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEXT_PLAIN" + } + }, + "TEXT_HTML": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEXT_HTML" + } + }, + "APPLICATION_JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPLICATION_JSON" + } + } + } + }, + "com.amazonaws.wafv2#ResponseInspection": { + "type": "structure", + "members": { + "StatusCode": { + "target": "com.amazonaws.wafv2#ResponseInspectionStatusCode", + "traits": { + "smithy.api#documentation": "

Configures inspection of the response status code for success and failure indicators.

" + } + }, + "Header": { + "target": "com.amazonaws.wafv2#ResponseInspectionHeader", + "traits": { + "smithy.api#documentation": "

Configures inspection of the response header for success and failure indicators.

" + } + }, + "BodyContains": { + "target": "com.amazonaws.wafv2#ResponseInspectionBodyContains", + "traits": { + "smithy.api#documentation": "

Configures inspection of the response body for success and failure indicators. WAF can inspect the first 65,536 bytes (64 KB) of the response body.

" + } + }, + "Json": { + "target": "com.amazonaws.wafv2#ResponseInspectionJson", + "traits": { + "smithy.api#documentation": "

Configures inspection of the response JSON for success and failure indicators. WAF can inspect the first 65,536 bytes (64 KB) of the response JSON.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The criteria for inspecting responses to login requests and account creation requests, used by the ATP and ACFP rule groups to track login and account creation success and failure rates.

\n \n

Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.

\n \n

The rule groups evaluates the responses that your protected resources send back to client login and account creation attempts, keeping count of successful and failed attempts from each IP address and client session. Using this information, the rule group labels \n and mitigates requests from client sessions and IP addresses with too much suspicious activity in a short amount of time.

\n

This is part of the AWSManagedRulesATPRuleSet and AWSManagedRulesACFPRuleSet configurations in ManagedRuleGroupConfig.

\n

Enable response inspection by configuring exactly one component of the response to inspect, for example, Header or StatusCode. You can't configure more than one component for inspection. If you don't configure any of the response inspection options, response inspection is disabled.

" + } + }, + "com.amazonaws.wafv2#ResponseInspectionBodyContains": { + "type": "structure", + "members": { + "SuccessStrings": { + "target": "com.amazonaws.wafv2#ResponseInspectionBodyContainsSuccessStrings", + "traits": { + "smithy.api#documentation": "

Strings in the body of the response that indicate a successful login or account creation attempt. To be counted as a success, the string can be anywhere in the body and must be an exact match, including case. Each string must be unique among the success and failure strings.

\n

JSON examples: \"SuccessStrings\": [ \"Login successful\" ] and \"SuccessStrings\": [ \"Account creation successful\", \"Welcome to our site!\" ]\n

", + "smithy.api#required": {} + } + }, + "FailureStrings": { + "target": "com.amazonaws.wafv2#ResponseInspectionBodyContainsFailureStrings", + "traits": { + "smithy.api#documentation": "

Strings in the body of the response that indicate a failed login or account creation attempt. To be counted as a failure, the string can be anywhere in the body and must be an exact match, including case. Each string must be unique among the success and failure strings.

\n

JSON example: \"FailureStrings\": [ \"Request failed\" ]\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Configures inspection of the response body. WAF can inspect the first 65,536 bytes (64 KB) of the response body. \n This is part of the ResponseInspection configuration for AWSManagedRulesATPRuleSet and AWSManagedRulesACFPRuleSet.

\n \n

Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.

\n " + } + }, + "com.amazonaws.wafv2#ResponseInspectionBodyContainsFailureStrings": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#FailureValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.wafv2#ResponseInspectionBodyContainsSuccessStrings": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#SuccessValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.wafv2#ResponseInspectionHeader": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#ResponseInspectionHeaderName", + "traits": { + "smithy.api#documentation": "

The name of the header to match against. The name must be an exact match, including case.

\n

JSON example: \"Name\": [ \"RequestResult\" ]\n

", + "smithy.api#required": {} + } + }, + "SuccessValues": { + "target": "com.amazonaws.wafv2#ResponseInspectionHeaderSuccessValues", + "traits": { + "smithy.api#documentation": "

Values in the response header with the specified name that indicate a successful login or account creation attempt. To be counted as a success, the value must be an exact match, including case. Each value must be unique among the success and failure values.

\n

JSON examples: \"SuccessValues\": [ \"LoginPassed\", \"Successful login\" ] and \"SuccessValues\": [ \"AccountCreated\", \"Successful account creation\" ]\n

", + "smithy.api#required": {} + } + }, + "FailureValues": { + "target": "com.amazonaws.wafv2#ResponseInspectionHeaderFailureValues", + "traits": { + "smithy.api#documentation": "

Values in the response header with the specified name that indicate a failed login or account creation attempt. To be counted as a failure, the value must be an exact match, including case. Each value must be unique among the success and failure values.

\n

JSON examples: \"FailureValues\": [ \"LoginFailed\", \"Failed login\" ] and \"FailureValues\": [ \"AccountCreationFailed\" ]\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Configures inspection of the response header. \n This is part of the ResponseInspection configuration for AWSManagedRulesATPRuleSet and AWSManagedRulesACFPRuleSet.

\n \n

Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.

\n " + } + }, + "com.amazonaws.wafv2#ResponseInspectionHeaderFailureValues": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#FailureValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 3 + } + } + }, + "com.amazonaws.wafv2#ResponseInspectionHeaderName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.wafv2#ResponseInspectionHeaderSuccessValues": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#SuccessValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 3 + } + } + }, + "com.amazonaws.wafv2#ResponseInspectionJson": { + "type": "structure", + "members": { + "Identifier": { + "target": "com.amazonaws.wafv2#FieldIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier for the value to match against in the JSON. The identifier must be an exact match, including case.

\n

JSON examples: \"Identifier\": [ \"/login/success\" ] and \"Identifier\": [ \"/sign-up/success\" ]\n

", + "smithy.api#required": {} + } + }, + "SuccessValues": { + "target": "com.amazonaws.wafv2#ResponseInspectionJsonSuccessValues", + "traits": { + "smithy.api#documentation": "

Values for the specified identifier in the response JSON that indicate a successful login or account creation attempt. To be counted as a success, the value must be an exact match, including case. Each value must be unique among the success and failure values.

\n

JSON example: \"SuccessValues\": [ \"True\", \"Succeeded\" ]\n

", + "smithy.api#required": {} + } + }, + "FailureValues": { + "target": "com.amazonaws.wafv2#ResponseInspectionJsonFailureValues", + "traits": { + "smithy.api#documentation": "

Values for the specified identifier in the response JSON that indicate a failed login or account creation attempt. To be counted as a failure, the value must be an exact match, including case. Each value must be unique among the success and failure values.

\n

JSON example: \"FailureValues\": [ \"False\", \"Failed\" ]\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Configures inspection of the response JSON. WAF can inspect the first 65,536 bytes (64 KB) of the response JSON. \n This is part of the ResponseInspection configuration for AWSManagedRulesATPRuleSet and AWSManagedRulesACFPRuleSet.

\n \n

Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.

\n " + } + }, + "com.amazonaws.wafv2#ResponseInspectionJsonFailureValues": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#FailureValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.wafv2#ResponseInspectionJsonSuccessValues": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#SuccessValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.wafv2#ResponseInspectionStatusCode": { + "type": "structure", + "members": { + "SuccessCodes": { + "target": "com.amazonaws.wafv2#ResponseInspectionStatusCodeSuccessCodes", + "traits": { + "smithy.api#documentation": "

Status codes in the response that indicate a successful login or account creation attempt. To be counted as a success, the response status code must match one of these. Each code must be unique among the success and failure status codes.

\n

JSON example: \"SuccessCodes\": [ 200, 201 ]\n

", + "smithy.api#required": {} + } + }, + "FailureCodes": { + "target": "com.amazonaws.wafv2#ResponseInspectionStatusCodeFailureCodes", + "traits": { + "smithy.api#documentation": "

Status codes in the response that indicate a failed login or account creation attempt. To be counted as a failure, the response status code must match one of these. Each code must be unique among the success and failure status codes.

\n

JSON example: \"FailureCodes\": [ 400, 404 ]\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Configures inspection of the response status code. \n This is part of the ResponseInspection configuration for AWSManagedRulesATPRuleSet and AWSManagedRulesACFPRuleSet.

\n \n

Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.

\n " + } + }, + "com.amazonaws.wafv2#ResponseInspectionStatusCodeFailureCodes": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#FailureCode" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.wafv2#ResponseInspectionStatusCodeSuccessCodes": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#SuccessCode" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.wafv2#ResponseStatusCode": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 200, + "max": 599 + } + } + }, + "com.amazonaws.wafv2#Rule": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the rule.

\n

If you change the name of a Rule after you create\n it and you want the rule's metric name to reflect the change, update the metric name in the rule's VisibilityConfig settings. WAF \n doesn't automatically update the metric name when you update the rule name.

", + "smithy.api#required": {} + } + }, + "Priority": { + "target": "com.amazonaws.wafv2#RulePriority", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

If you define more than one Rule in a WebACL, WAF\n evaluates each request against the Rules in order based on the value of\n Priority. WAF processes rules with lower priority first. The priorities\n don't need to be consecutive, but they must all be different.

", + "smithy.api#required": {} + } + }, + "Statement": { + "target": "com.amazonaws.wafv2#Statement", + "traits": { + "smithy.api#documentation": "

The WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement.

", + "smithy.api#required": {} + } + }, + "Action": { + "target": "com.amazonaws.wafv2#RuleAction", + "traits": { + "smithy.api#documentation": "

The action that WAF should take on a web request when it matches the rule statement. Settings at the web ACL level can override the rule action setting.

\n

This is used only for rules whose statements do not reference a rule group. Rule statements that reference a rule group include RuleGroupReferenceStatement and ManagedRuleGroupStatement.

\n

You must specify either this Action setting or the rule OverrideAction setting, but not both:

\n
    \n
  • \n

    If the rule statement does not reference a rule group, use this rule action setting and not the rule override action setting.

    \n
    • \n
  • \n

    If the rule statement references a rule group, use the override action setting and not this action setting.

    \n
    • \n
" + } + }, + "OverrideAction": { + "target": "com.amazonaws.wafv2#OverrideAction", + "traits": { + "smithy.api#documentation": "

The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.

\n

You can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.

\n \n

This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count \n matches, do not use this and instead use the rule action override option, with Count action, in your rule group reference statement settings.

\n " + } + }, + "RuleLabels": { + "target": "com.amazonaws.wafv2#Labels", + "traits": { + "smithy.api#documentation": "

Labels to apply to web requests that match the rule match statement. WAF applies\n fully qualified labels to matching web requests. A fully qualified label is the\n concatenation of a label namespace and a rule label. The rule's rule group or web ACL\n defines the label namespace.

\n

Rules that run after this rule in the web ACL can match against these labels using a\n LabelMatchStatement.

\n

For each label, provide a case-sensitive string containing optional namespaces and a\n label name, according to the following guidelines:

\n
    \n
  • \n

    Separate each component of the label with a colon.

    \n
    • \n
  • \n

    Each namespace or name can have up to 128 characters.

    \n
    • \n
  • \n

    You can specify up to 5 namespaces in a label.

    \n
    • \n
  • \n

    Don't use the following reserved words in your label specification:\n aws, waf, managed, rulegroup,\n webacl, regexpatternset, or ipset.

    \n
    • \n
\n

For example, myLabelName or nameSpace1:nameSpace2:myLabelName.\n

" + } + }, + "VisibilityConfig": { + "target": "com.amazonaws.wafv2#VisibilityConfig", + "traits": { + "smithy.api#documentation": "

Defines and enables Amazon CloudWatch metrics and web request sample collection.

\n

If you change the name of a Rule after you create\n it and you want the rule's metric name to reflect the change, update the metric name as well. WAF \n doesn't automatically update the metric name.

", + "smithy.api#required": {} + } + }, + "CaptchaConfig": { + "target": "com.amazonaws.wafv2#CaptchaConfig", + "traits": { + "smithy.api#documentation": "

Specifies how WAF should handle CAPTCHA evaluations. If you don't specify this, WAF uses the CAPTCHA configuration that's defined for the web ACL.

" + } + }, + "ChallengeConfig": { + "target": "com.amazonaws.wafv2#ChallengeConfig", + "traits": { + "smithy.api#documentation": "

Specifies how WAF should handle Challenge evaluations. If you don't specify this, WAF uses the challenge configuration that's defined for the web ACL.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A single rule, which you can use in a WebACL or RuleGroup to identify web requests that you want to manage in some way. \n Each rule includes one top-level Statement that WAF uses to\n identify matching web requests, and parameters that govern how WAF handles them.

" + } + }, + "com.amazonaws.wafv2#RuleAction": { + "type": "structure", + "members": { + "Block": { + "target": "com.amazonaws.wafv2#BlockAction", + "traits": { + "smithy.api#documentation": "

Instructs WAF to block the web request.

" + } + }, + "Allow": { + "target": "com.amazonaws.wafv2#AllowAction", + "traits": { + "smithy.api#documentation": "

Instructs WAF to allow the web request.

" + } + }, + "Count": { + "target": "com.amazonaws.wafv2#CountAction", + "traits": { + "smithy.api#documentation": "

Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.

" + } + }, + "Captcha": { + "target": "com.amazonaws.wafv2#CaptchaAction", + "traits": { + "smithy.api#documentation": "

Instructs WAF to run a CAPTCHA check against the web request.

" + } + }, + "Challenge": { + "target": "com.amazonaws.wafv2#ChallengeAction", + "traits": { + "smithy.api#documentation": "

Instructs WAF to run a Challenge check against the web request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The action that WAF should take on a web request when it matches a rule's\n statement. Settings at the web ACL level can override the rule action setting.

" + } + }, + "com.amazonaws.wafv2#RuleActionOverride": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the rule to override.

", + "smithy.api#required": {} + } + }, + "ActionToUse": { + "target": "com.amazonaws.wafv2#RuleAction", + "traits": { + "smithy.api#documentation": "

The override action to use, in place of the configured action of the rule in the rule group.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Action setting to use in the place of a rule action that is configured inside the rule group. You specify one override for each rule whose action you want to change.

\n

You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.

" + } + }, + "com.amazonaws.wafv2#RuleActionOverrides": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#RuleActionOverride" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.wafv2#RuleGroup": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the rule group. You cannot change the name of a rule group after you create it.

", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", + "smithy.api#required": {} + } + }, + "Capacity": { + "target": "com.amazonaws.wafv2#CapacityUnit", + "traits": { + "smithy.api#documentation": "

The web ACL capacity units (WCUs) required for this rule group.

\n

When you create your own rule group, you define this, and you cannot change it after creation. \n When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity \n for a set of rules using CheckCapacity.

\n

WAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) \n in the WAF Developer Guide.

", + "smithy.api#required": {} + } + }, + "ARN": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the entity.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", + "traits": { + "smithy.api#documentation": "

A description of the rule group that helps with identification.

" + } + }, + "Rules": { + "target": "com.amazonaws.wafv2#Rules", + "traits": { + "smithy.api#documentation": "

The Rule statements used to identify the web requests that you \n want to manage. Each rule includes one top-level statement that WAF uses to identify matching \n web requests, and parameters that govern how WAF handles them. \n

" + } + }, + "VisibilityConfig": { + "target": "com.amazonaws.wafv2#VisibilityConfig", + "traits": { + "smithy.api#documentation": "

Defines and enables Amazon CloudWatch metrics and web request sample collection.

", + "smithy.api#required": {} + } + }, + "LabelNamespace": { + "target": "com.amazonaws.wafv2#LabelName", + "traits": { + "smithy.api#documentation": "

The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.

\n
    \n
  • \n

    The syntax for the label namespace prefix for your rule groups is the following:

    \n

    \n awswaf::rulegroup::\n

    \n
    • \n
  • \n

    When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:

    \n

    \n \n

    \n
    • \n
" + } + }, + "CustomResponseBodies": { + "target": "com.amazonaws.wafv2#CustomResponseBodies", + "traits": { + "smithy.api#documentation": "

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.

\n

For information about customizing web requests and responses, \n see Customizing web requests and responses in WAF \n in the WAF Developer Guide.

\n

For information about the limits on count and size for custom request and response settings, see WAF quotas \n in the WAF Developer Guide.

" + } + }, + "AvailableLabels": { + "target": "com.amazonaws.wafv2#LabelSummaries", + "traits": { + "smithy.api#documentation": "

The labels that one or more rules in this rule group add to matching web requests. These labels are defined in the RuleLabels for a Rule.

" + } + }, + "ConsumedLabels": { + "target": "com.amazonaws.wafv2#LabelSummaries", + "traits": { + "smithy.api#documentation": "

The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.

" + } + }, + "com.amazonaws.wafv2#RuleGroupReferenceStatement": { + "type": "structure", + "members": { + "ARN": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the entity.

", + "smithy.api#required": {} + } + }, + "ExcludedRules": { + "target": "com.amazonaws.wafv2#ExcludedRules", + "traits": { + "smithy.api#documentation": "

Rules in the referenced rule group whose actions are set to Count.

\n \n

Instead of this option, use RuleActionOverrides. It accepts any valid action setting, including Count.

\n " + } + }, + "RuleActionOverrides": { + "target": "com.amazonaws.wafv2#RuleActionOverrides", + "traits": { + "smithy.api#documentation": "

Action settings to use in the place of the rule actions that are configured inside the rule group. You specify one override for each rule whose action you want to change.

\n

You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.

\n

You cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. You cannot use a rule group\n reference statement inside another rule group. You can only reference a rule group as a top-level statement within a rule that you define in a web ACL.

" + } + }, + "com.amazonaws.wafv2#RuleGroupSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#RuleGroupSummary" + } + }, + "com.amazonaws.wafv2#RuleGroupSummary": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the data type instance. You cannot change the name after you create the instance.

" + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

" + } + }, + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", + "traits": { + "smithy.api#documentation": "

A description of the rule group that helps with identification.

" + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" + } + }, + "ARN": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the entity.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

High-level information about a RuleGroup, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RuleGroup, and the ARN, that you provide to the RuleGroupReferenceStatement to use the rule group in a Rule.

" + } + }, + "com.amazonaws.wafv2#RulePriority": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.wafv2#RuleSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#RuleSummary" + } + }, + "com.amazonaws.wafv2#RuleSummary": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the rule.

" + } + }, + "Action": { + "target": "com.amazonaws.wafv2#RuleAction", + "traits": { + "smithy.api#documentation": "

The action that WAF should take on a web request when it matches a rule's\n statement. Settings at the web ACL level can override the rule action setting.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

High-level information about a Rule, returned by operations like DescribeManagedRuleGroup. This provides information like the ID, that you can use to retrieve and manage a RuleGroup, and the ARN, that you provide to the RuleGroupReferenceStatement to use the rule group in a Rule.

" + } + }, + "com.amazonaws.wafv2#Rules": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#Rule" + } + }, + "com.amazonaws.wafv2#SampleWeight": { + "type": "long", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.wafv2#SampledHTTPRequest": { + "type": "structure", + "members": { + "Request": { + "target": "com.amazonaws.wafv2#HTTPRequest", + "traits": { + "smithy.api#documentation": "

A complex type that contains detailed information about the request.

", + "smithy.api#required": {} + } + }, + "Weight": { + "target": "com.amazonaws.wafv2#SampleWeight", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

A value that indicates how one result in the response relates proportionally to other\n results in the response. For example, a result that has a weight of 2\n represents roughly twice as many web requests as a result that has a weight of\n 1.

", + "smithy.api#required": {} + } + }, + "Timestamp": { + "target": "com.amazonaws.wafv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which WAF received the request from your Amazon Web Services resource, in Unix time\n format (in seconds).

" + } + }, + "Action": { + "target": "com.amazonaws.wafv2#Action", + "traits": { + "smithy.api#documentation": "

The action that WAF applied to the request.

" + } + }, + "RuleNameWithinRuleGroup": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the Rule that the request matched. For managed rule groups, the\n format for this name is ##. For your own rule groups, the format for this name is #. If the rule is not in a rule group, this field\n is absent.

" + } + }, + "RequestHeadersInserted": { + "target": "com.amazonaws.wafv2#HTTPHeaders", + "traits": { + "smithy.api#documentation": "

Custom request headers inserted by WAF into the request, according to the custom\n request configuration for the matching rule action.

" + } + }, + "ResponseCodeSent": { + "target": "com.amazonaws.wafv2#ResponseStatusCode", + "traits": { + "smithy.api#documentation": "

The response code that was sent for the request.

" + } + }, + "Labels": { + "target": "com.amazonaws.wafv2#Labels", + "traits": { + "smithy.api#documentation": "

Labels applied to the web request by matching rules. WAF applies fully qualified\n labels to matching web requests. A fully qualified label is the concatenation of a label\n namespace and a rule label. The rule's rule group or web ACL defines the label namespace.

\n

For example,\n awswaf:111122223333:myRuleGroup:testRules:testNS1:testNS2:labelNameA or\n awswaf:managed:aws:managed-rule-set:header:encoding:utf8.

" + } + }, + "CaptchaResponse": { + "target": "com.amazonaws.wafv2#CaptchaResponse", + "traits": { + "smithy.api#documentation": "

The CAPTCHA response for the request.

" + } + }, + "ChallengeResponse": { + "target": "com.amazonaws.wafv2#ChallengeResponse", + "traits": { + "smithy.api#documentation": "

The Challenge response for the request.

" + } + }, + "OverriddenAction": { + "target": "com.amazonaws.wafv2#Action", + "traits": { + "smithy.api#documentation": "

Used only for rule group rules that have a rule action override in place in the web ACL. This is the action that the rule group rule is configured for, and not the action that was applied to the request. The action that WAF applied is the Action value.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a single sampled web request. The response from GetSampledRequests includes a SampledHTTPRequests complex type\n that appears as SampledRequests in the response syntax.\n SampledHTTPRequests contains an array of SampledHTTPRequest\n objects.

" + } + }, + "com.amazonaws.wafv2#SampledHTTPRequests": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#SampledHTTPRequest" + } + }, + "com.amazonaws.wafv2#Scope": { + "type": "enum", + "members": { + "CLOUDFRONT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLOUDFRONT" + } + }, + "REGIONAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REGIONAL" + } + } + } + }, + "com.amazonaws.wafv2#SearchString": { + "type": "blob" + }, + "com.amazonaws.wafv2#SensitivityLevel": { + "type": "enum", + "members": { + "LOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOW" + } + }, + "HIGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HIGH" + } + } + } + }, + "com.amazonaws.wafv2#SingleCookieName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 60 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.wafv2#SingleHeader": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#FieldToMatchData", + "traits": { + "smithy.api#documentation": "

The name of the query header to inspect.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Inspect one of the headers in the web request, identified by name, for example,\n User-Agent or Referer. The name isn't case sensitive.

\n

You can filter and inspect all headers with the FieldToMatch setting\n Headers.

\n

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

\n

Example JSON: \"SingleHeader\": { \"Name\": \"haystack\" }\n

" + } + }, + "com.amazonaws.wafv2#SingleQueryArgument": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#FieldToMatchData", + "traits": { + "smithy.api#documentation": "

The name of the query argument to inspect.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Inspect one query argument in the web request, identified by name, for example\n UserName or SalesRegion. The name isn't case\n sensitive.

\n

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

\n

Example JSON: \"SingleQueryArgument\": { \"Name\": \"myArgument\" }\n

" + } + }, + "com.amazonaws.wafv2#Size": { + "type": "long", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 21474836480 + } + } + }, + "com.amazonaws.wafv2#SizeConstraintStatement": { + "type": "structure", + "members": { + "FieldToMatch": { + "target": "com.amazonaws.wafv2#FieldToMatch", + "traits": { + "smithy.api#documentation": "

The part of the web request that you want WAF to inspect.

", + "smithy.api#required": {} + } + }, + "ComparisonOperator": { + "target": "com.amazonaws.wafv2#ComparisonOperator", + "traits": { + "smithy.api#documentation": "

The operator to use to compare the request part to the size setting.

", + "smithy.api#required": {} + } + }, + "Size": { + "target": "com.amazonaws.wafv2#Size", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The size, in byte, to compare to the request part, after any transformations.

", + "smithy.api#required": {} + } + }, + "TextTransformations": { + "target": "com.amazonaws.wafv2#TextTransformations", + "traits": { + "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.

\n

If you configure WAF to inspect the request body, WAF inspects only the number of bytes in the body up to the limit for the web ACL and protected resource type. If you know that the request body for your web requests should never exceed the inspection limit, you can use a size constraint statement to block requests that have a larger request body size. For more information about the inspection limits, see Body and JsonBody settings for the FieldToMatch data type.

\n

If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.

" + } + }, + "com.amazonaws.wafv2#SizeInspectionLimit": { + "type": "enum", + "members": { + "KB_16": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KB_16" + } + }, + "KB_32": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KB_32" + } + }, + "KB_48": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KB_48" + } + }, + "KB_64": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KB_64" + } + } + } + }, + "com.amazonaws.wafv2#SolveTimestamp": { + "type": "long" + }, + "com.amazonaws.wafv2#SourceType": { + "type": "string" + }, + "com.amazonaws.wafv2#SqliMatchStatement": { + "type": "structure", + "members": { + "FieldToMatch": { + "target": "com.amazonaws.wafv2#FieldToMatch", + "traits": { + "smithy.api#documentation": "

The part of the web request that you want WAF to inspect.

", + "smithy.api#required": {} + } + }, + "TextTransformations": { + "target": "com.amazonaws.wafv2#TextTransformations", + "traits": { + "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.

", + "smithy.api#required": {} + } + }, + "SensitivityLevel": { + "target": "com.amazonaws.wafv2#SensitivityLevel", + "traits": { + "smithy.api#documentation": "

The sensitivity that you want WAF to use to inspect for SQL injection attacks.

\n

\n HIGH detects more attacks, but might generate more false positives, \n especially if your web requests frequently contain unusual strings. \n For information about identifying and mitigating false positives, see \n Testing and tuning in the \n WAF Developer Guide.

\n

\n LOW is generally a better choice for resources that already have other \n protections against SQL injection attacks or that have a low tolerance for false positives.

\n

Default: LOW\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A rule statement that inspects for malicious SQL code. Attackers insert malicious SQL code into web requests to do things like modify your database or extract data from it.

" + } + }, + "com.amazonaws.wafv2#Statement": { + "type": "structure", + "members": { + "ByteMatchStatement": { + "target": "com.amazonaws.wafv2#ByteMatchStatement", + "traits": { + "smithy.api#documentation": "

A rule statement that defines a string match search for WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the WAF console and the developer guide, this is called a string match statement.

" + } + }, + "SqliMatchStatement": { + "target": "com.amazonaws.wafv2#SqliMatchStatement", + "traits": { + "smithy.api#documentation": "

A rule statement that inspects for malicious SQL code. Attackers insert malicious SQL code into web requests to do things like modify your database or extract data from it.

" + } + }, + "XssMatchStatement": { + "target": "com.amazonaws.wafv2#XssMatchStatement", + "traits": { + "smithy.api#documentation": "

A rule statement that inspects for cross-site scripting (XSS) attacks. In XSS attacks, the attacker \nuses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers.

" + } + }, + "SizeConstraintStatement": { + "target": "com.amazonaws.wafv2#SizeConstraintStatement", + "traits": { + "smithy.api#documentation": "

A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.

\n

If you configure WAF to inspect the request body, WAF inspects only the number of bytes in the body up to the limit for the web ACL and protected resource type. If you know that the request body for your web requests should never exceed the inspection limit, you can use a size constraint statement to block requests that have a larger request body size. For more information about the inspection limits, see Body and JsonBody settings for the FieldToMatch data type.

\n

If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.

" + } + }, + "GeoMatchStatement": { + "target": "com.amazonaws.wafv2#GeoMatchStatement", + "traits": { + "smithy.api#documentation": "

A rule statement that labels web requests by country and region and that matches against web requests based on country code. A geo match rule labels every request that it inspects regardless of whether it finds a match.

\n
    \n
  • \n

    To manage requests only by country, you can use this statement by itself and specify the countries that you want to match against in the CountryCodes array.

    \n
    • \n
  • \n

    Otherwise, configure your geo match rule with Count action so that it only labels requests. Then, add one or more label match rules to run after the geo match rule and configure them to match against the geographic labels and handle the requests as needed.

    \n
    • \n
\n

WAF labels requests using the alpha-2 country and region codes from the International Organization for Standardization (ISO) 3166 standard. WAF determines the codes using either the IP address in the web request origin or, if you specify it, the address in the geo match ForwardedIPConfig.

\n

If you use the web request origin, the label formats are awswaf:clientip:geo:region:- and awswaf:clientip:geo:country:.

\n

If you use a forwarded IP address, the label formats are awswaf:forwardedip:geo:region:- and awswaf:forwardedip:geo:country:.

\n

For additional details, see Geographic match rule statement in the WAF Developer Guide.

" + } + }, + "RuleGroupReferenceStatement": { + "target": "com.amazonaws.wafv2#RuleGroupReferenceStatement", + "traits": { + "smithy.api#documentation": "

A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.

\n

You cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. You cannot use a rule group\n reference statement inside another rule group. You can only reference a rule group as a top-level statement within a rule that you define in a web ACL.

" + } + }, + "IPSetReferenceStatement": { + "target": "com.amazonaws.wafv2#IPSetReferenceStatement", + "traits": { + "smithy.api#documentation": "

A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.

\n

Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.

" + } + }, + "RegexPatternSetReferenceStatement": { + "target": "com.amazonaws.wafv2#RegexPatternSetReferenceStatement", + "traits": { + "smithy.api#documentation": "

A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.

\n

Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.

" + } + }, + "RateBasedStatement": { + "target": "com.amazonaws.wafv2#RateBasedStatement", + "traits": { + "smithy.api#documentation": "

A rate-based rule counts incoming requests and rate limits requests when they are coming at too fast a rate. The rule categorizes requests according to your aggregation criteria, collects them into aggregation instances, and counts and rate limits the requests for each instance.

\n \n

If you change any of these settings in a rule that's currently in use, the change resets the rule's rate limiting counts. This can pause the rule's rate limiting activities for up to a minute.

\n \n

You can specify individual aggregation keys, like IP address or HTTP method. You can also specify aggregation key combinations, like IP address and HTTP method, or HTTP method, query argument, and cookie.

\n

Each unique set of values for the aggregation keys that you specify is a separate aggregation instance, with the value from each key contributing to the aggregation instance definition.

\n

For example, assume the rule evaluates web requests with the following IP address and HTTP method values:

\n
    \n
  • \n

    IP address 10.1.1.1, HTTP method POST

    \n
    • \n
  • \n

    IP address 10.1.1.1, HTTP method GET

    \n
    • \n
  • \n

    IP address 127.0.0.0, HTTP method POST

    \n
    • \n
  • \n

    IP address 10.1.1.1, HTTP method GET

    \n
    • \n
\n

The rule would create different aggregation instances according to your aggregation criteria, for example:

\n
    \n
  • \n

    If the aggregation criteria is just the IP address, then each individual address is an aggregation instance, and WAF counts requests separately for each. The aggregation instances and request counts for our example would be the following:

    \n
      \n
    • \n

      IP address 10.1.1.1: count 3

      \n
      • \n
    • \n

      IP address 127.0.0.0: count 1

      \n
      • \n
    \n
    • \n
  • \n

    If the aggregation criteria is HTTP method, then each individual HTTP method is an aggregation instance. The aggregation instances and request counts for our example would be the following:

    \n
      \n
    • \n

      HTTP method POST: count 2

      \n
      • \n
    • \n

      HTTP method GET: count 2

      \n
      • \n
    \n
    • \n
  • \n

    If the aggregation criteria is IP address and HTTP method, then each IP address and each HTTP method would contribute to the combined aggregation instance. The aggregation instances and request counts for our example would be the following:

    \n
      \n
    • \n

      IP address 10.1.1.1, HTTP method POST: count 1

      \n
      • \n
    • \n

      IP address 10.1.1.1, HTTP method GET: count 2

      \n
      • \n
    • \n

      IP address 127.0.0.0, HTTP method POST: count 1

      \n
      • \n
    \n
    • \n
\n

For any n-tuple of aggregation keys, each unique combination of values for the keys defines a separate aggregation instance, which WAF counts and rate-limits individually.

\n

You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts and rate limits requests that match the nested statement. You can use this nested scope-down statement in conjunction with your aggregation key specifications or you can just count and rate limit all requests that match the scope-down statement, without additional aggregation. When you choose to just manage all requests that match a scope-down statement, the aggregation instance is singular for the rule.

\n

You cannot nest a RateBasedStatement inside another statement, for example inside a NotStatement or OrStatement. You can define a RateBasedStatement inside a web ACL and inside a rule group.

\n

For additional information about the options, see Rate limiting web requests using rate-based rules \n in the WAF Developer Guide.

\n

If you only aggregate on the individual IP address or forwarded IP address, you can retrieve the list of IP addresses that WAF \n is currently rate limiting for a rule through the API call GetRateBasedStatementManagedKeys. This option is not available\n for other aggregation configurations.

\n

WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by WAF. If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by WAF.

" + } + }, + "AndStatement": { + "target": "com.amazonaws.wafv2#AndStatement", + "traits": { + "smithy.api#documentation": "

A logical rule statement used to combine other rule statements with AND logic. You provide more than one Statement within the AndStatement.

" + } + }, + "OrStatement": { + "target": "com.amazonaws.wafv2#OrStatement", + "traits": { + "smithy.api#documentation": "

A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement.

" + } + }, + "NotStatement": { + "target": "com.amazonaws.wafv2#NotStatement", + "traits": { + "smithy.api#documentation": "

A logical rule statement used to negate the results of another rule statement. You provide one Statement within the NotStatement.

" + } + }, + "ManagedRuleGroupStatement": { + "target": "com.amazonaws.wafv2#ManagedRuleGroupStatement", + "traits": { + "smithy.api#documentation": "

A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.

\n

You cannot nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. You cannot use a managed rule group \n inside another rule group. You can only reference a managed rule group as a top-level statement within a rule that you define in a web ACL.

\n \n

You are charged additional fees when you use the WAF Bot Control managed rule group AWSManagedRulesBotControlRuleSet, the WAF Fraud Control account takeover prevention (ATP) managed rule group AWSManagedRulesATPRuleSet, or the WAF Fraud Control account creation fraud prevention (ACFP) managed rule group AWSManagedRulesACFPRuleSet. For more information, see WAF Pricing.

\n " + } + }, + "LabelMatchStatement": { + "target": "com.amazonaws.wafv2#LabelMatchStatement", + "traits": { + "smithy.api#documentation": "

A rule statement to match against labels that have been added to the web request by rules that have already run in the web ACL.

\n

The label match statement provides the label or namespace string to search for. The label string can represent a part or all of the fully qualified label name that had been added to the web request. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. If you do not provide the fully qualified name in your label match string, WAF performs the search for labels that were added in the same context as the label match statement.

" + } + }, + "RegexMatchStatement": { + "target": "com.amazonaws.wafv2#RegexMatchStatement", + "traits": { + "smithy.api#documentation": "

A rule statement used to search web request components for a match against a single regular expression.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The processing guidance for a Rule, used by WAF to determine whether\n a web request matches the rule.

\n

For example specifications, see the examples section of CreateWebACL.

" + } + }, + "com.amazonaws.wafv2#Statements": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#Statement" + } + }, + "com.amazonaws.wafv2#String": { + "type": "string" + }, + "com.amazonaws.wafv2#SuccessCode": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 999 + } + } + }, + "com.amazonaws.wafv2#SuccessValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.wafv2#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.wafv2#TagKey", + "traits": { + "smithy.api#documentation": "

Part of the key:value pair that defines a tag. You can use a tag key to describe a\n category of information, such as \"customer.\" Tag keys are case-sensitive.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.wafv2#TagValue", + "traits": { + "smithy.api#documentation": "

Part of the key:value pair that defines a tag. You can use a tag value to describe a\n specific value within a category, such as \"companyA\" or \"companyB.\" Tag values are\n case-sensitive.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A tag associated with an Amazon Web Services resource. Tags are key:value pairs that you can use to\n categorize and manage your resources, for purposes like billing or other management.\n Typically, the tag key represents a category, such as \"environment\", and the tag value\n represents a specific value within that category, such as \"test,\" \"development,\" or\n \"production\". Or you might set the tag key to \"customer\" and the value to the customer name\n or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a\n resource.

\n

You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule\n groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF\n console.

" + } + }, + "com.amazonaws.wafv2#TagInfoForResource": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" + } + }, + "TagList": { + "target": "com.amazonaws.wafv2#TagList", + "traits": { + "smithy.api#documentation": "

The array of Tag objects defined for the resource.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The collection of tagging definitions for an Amazon Web Services resource. Tags are key:value pairs\n that you can use to categorize and manage your resources, for purposes like billing or\n other management. Typically, the tag key represents a category, such as \"environment\", and\n the tag value represents a specific value within that category, such as \"test,\"\n \"development,\" or \"production\". Or you might set the tag key to \"customer\" and the value to\n the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up\n to 50 tags for a resource.

\n

You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule\n groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF\n console.

" + } + }, + "com.amazonaws.wafv2#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + } + }, + "com.amazonaws.wafv2#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.wafv2#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#Tag" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.wafv2#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFLimitsExceededException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationInternalErrorException" + } + ], + "traits": { + "smithy.api#documentation": "

Associates tags with the specified Amazon Web Services resource. Tags are key:value pairs that you can\n use to categorize and manage your resources, for purposes like billing. For example, you\n might set the tag key to \"customer\" and the value to the customer name or ID. You can\n specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a\n resource.

\n

You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule\n groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF\n console.

" + } + }, + "com.amazonaws.wafv2#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.wafv2#TagList", + "traits": { + "smithy.api#documentation": "

An array of key:value pairs to associate with the resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + } + }, + "com.amazonaws.wafv2#TextTransformation": { + "type": "structure", + "members": { + "Priority": { + "target": "com.amazonaws.wafv2#TextTransformationPriority", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Sets the relative processing order for multiple transformations.\n WAF processes all transformations, from lowest priority to highest,\n before inspecting the transformed content. The priorities don't need to be consecutive, but\n they must all be different.

", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.wafv2#TextTransformationType", + "traits": { + "smithy.api#documentation": "

For detailed descriptions of each of the transformation types, see Text transformations \n in the WAF Developer Guide.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web\n requests in an effort to bypass detection.

" + } + }, + "com.amazonaws.wafv2#TextTransformationPriority": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.wafv2#TextTransformationType": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "COMPRESS_WHITE_SPACE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPRESS_WHITE_SPACE" + } + }, + "HTML_ENTITY_DECODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTML_ENTITY_DECODE" + } + }, + "LOWERCASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOWERCASE" + } + }, + "CMD_LINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CMD_LINE" + } + }, + "URL_DECODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "URL_DECODE" + } + }, + "BASE64_DECODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BASE64_DECODE" + } + }, + "HEX_DECODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HEX_DECODE" + } + }, + "MD5": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MD5" + } + }, + "REPLACE_COMMENTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REPLACE_COMMENTS" + } + }, + "ESCAPE_SEQ_DECODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ESCAPE_SEQ_DECODE" + } + }, + "SQL_HEX_DECODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SQL_HEX_DECODE" + } + }, + "CSS_DECODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CSS_DECODE" + } + }, + "JS_DECODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JS_DECODE" + } + }, + "NORMALIZE_PATH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NORMALIZE_PATH" + } + }, + "NORMALIZE_PATH_WIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NORMALIZE_PATH_WIN" + } + }, + "REMOVE_NULLS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REMOVE_NULLS" + } + }, + "REPLACE_NULLS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REPLACE_NULLS" + } + }, + "BASE64_DECODE_EXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BASE64_DECODE_EXT" + } + }, + "URL_DECODE_UNI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "URL_DECODE_UNI" + } + }, + "UTF8_TO_UNICODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UTF8_TO_UNICODE" + } + } + } + }, + "com.amazonaws.wafv2#TextTransformations": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#TextTransformation" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.wafv2#TimeWindow": { + "type": "structure", + "members": { + "StartTime": { + "target": "com.amazonaws.wafv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The beginning of the time range from which you want GetSampledRequests to\n return a sample of the requests that your Amazon Web Services resource received. You must specify the\n times in Coordinated Universal Time (UTC) format. UTC format includes the special\n designator, Z. For example, \"2016-09-27T14:50Z\". You can specify\n any time range in the previous three hours.

", + "smithy.api#required": {} + } + }, + "EndTime": { + "target": "com.amazonaws.wafv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The end of the time range from which you want GetSampledRequests to return\n a sample of the requests that your Amazon Web Services resource received. You must specify the times in\n Coordinated Universal Time (UTC) format. UTC format includes the special designator,\n Z. For example, \"2016-09-27T14:50Z\". You can specify any time\n range in the previous three hours.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

In a GetSampledRequests request, the StartTime and\n EndTime objects specify the time range for which you want WAF to\n return a sample of web requests.

\n

You must specify the times in Coordinated Universal Time (UTC) format. UTC format\n includes the special designator, Z. For example,\n \"2016-09-27T14:50Z\". You can specify any time range in the previous three\n hours.

\n

In a GetSampledRequests response, the StartTime and\n EndTime objects specify the time range for which WAF actually returned a\n sample of web requests. WAF gets the specified number of requests from among the first\n 5,000 requests that your Amazon Web Services resource receives during the specified time period. If your\n resource receives more than 5,000 requests during that period, WAF stops sampling after\n the 5,000th request. In that case, EndTime is the time that WAF received the\n 5,000th request.

" + } + }, + "com.amazonaws.wafv2#TimeWindowDay": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.wafv2#TimeWindowSecond": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 60, + "max": 259200 + } + } + }, + "com.amazonaws.wafv2#Timestamp": { + "type": "timestamp" + }, + "com.amazonaws.wafv2#TokenDomain": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 253 + }, + "smithy.api#pattern": "^[\\w\\.\\-/]+$" + } + }, + "com.amazonaws.wafv2#TokenDomains": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#TokenDomain" + } + }, + "com.amazonaws.wafv2#URIString": { + "type": "string" + }, + "com.amazonaws.wafv2#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationInternalErrorException" + } + ], + "traits": { + "smithy.api#documentation": "

Disassociates tags from an Amazon Web Services resource. Tags are key:value pairs that you can\n associate with Amazon Web Services resources. For example, the tag key might be \"customer\" and the tag\n value might be \"companyA.\" You can specify one or more tags to add to each container. You\n can add up to 50 tags to each Amazon Web Services resource.

" + } + }, + "com.amazonaws.wafv2#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.wafv2#TagKeyList", + "traits": { + "smithy.api#documentation": "

An array of keys identifying the tags to disassociate from the resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#UpdateIPSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#UpdateIPSetRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#UpdateIPSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFDuplicateItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFLimitsExceededException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFOptimisticLockException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the specified IPSet.

\n \n

This operation completely replaces the mutable specifications that you already have for the IP set with the ones that you provide to this call.

\n

To modify an IP set, do the following:

\n
    \n
  1. \n

    Retrieve it by calling GetIPSet\n

    \n
    2. \n
  2. \n

    Update its settings as needed

    \n
    3. \n
  3. \n

    Provide the complete IP set specification to this call

    \n
    4. \n
\n \n

\n Temporary inconsistencies during updates\n

\n

When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.

\n

The following are examples of the temporary inconsistencies that you might notice during change propagation:

\n
    \n
  • \n

    After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable.

    \n
    • \n
  • \n

    After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.

    \n
    • \n
  • \n

    After you change a rule action setting, you might see the old action in some places and the new action in others.

    \n
    • \n
  • \n

    After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.

    \n
    • \n
" + } + }, + "com.amazonaws.wafv2#UpdateIPSetRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the IP set. You cannot change the name of an IPSet after you create it.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n
    \n
  • \n

    CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    \n
    • \n
  • \n

    API and SDKs - For all calls, use the Region endpoint us-east-1.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", + "traits": { + "smithy.api#documentation": "

A description of the IP set that helps with identification.

" + } + }, + "Addresses": { + "target": "com.amazonaws.wafv2#IPAddresses", + "traits": { + "smithy.api#documentation": "

Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF to inspect for in incoming requests. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

\n

Example address strings:

\n
    \n
  • \n

    For requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.

    \n
    • \n
  • \n

    For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify \n 192.0.2.0/24.

    \n
    • \n
  • \n

    For requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.

    \n
    • \n
  • \n

    For requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.

    \n
    • \n
\n

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

\n

Example JSON Addresses specifications:

\n
    \n
  • \n

    Empty array: \"Addresses\": []\n

    \n
    • \n
  • \n

    Array with one address: \"Addresses\": [\"192.0.2.44/32\"]\n

    \n
    • \n
  • \n

    Array with three addresses: \"Addresses\": [\"192.0.2.44/32\", \"192.0.2.0/24\", \"192.0.0.0/16\"]\n

    \n
    • \n
  • \n

    INVALID specification: \"Addresses\": [\"\"] INVALID

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#UpdateIPSetResponse": { + "type": "structure", + "members": { + "NextLockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#UpdateManagedRuleSetVersionExpiryDate": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#UpdateManagedRuleSetVersionExpiryDateRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#UpdateManagedRuleSetVersionExpiryDateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFOptimisticLockException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the expiration information for your managed rule set. Use this to initiate the\n expiration of a managed rule group version. After you initiate expiration for a version,\n WAF excludes it from the response to ListAvailableManagedRuleGroupVersions for the managed rule group.

\n \n

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

\n

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

\n " + } + }, + "com.amazonaws.wafv2#UpdateManagedRuleSetVersionExpiryDateRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

\n

This name is assigned to the corresponding managed rule group, which your customers can access and use.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n
    \n
  • \n

    CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    \n
    • \n
  • \n

    API and SDKs - For all calls, use the Region endpoint us-east-1.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.

", + "smithy.api#required": {} + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", + "smithy.api#required": {} + } + }, + "VersionToExpire": { + "target": "com.amazonaws.wafv2#VersionKeyString", + "traits": { + "smithy.api#documentation": "

The version that you want to remove from your list of offerings for the named managed\n rule group.

", + "smithy.api#required": {} + } + }, + "ExpiryTimestamp": { + "target": "com.amazonaws.wafv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that you want the version to expire.

\n

Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\".

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#UpdateManagedRuleSetVersionExpiryDateResponse": { + "type": "structure", + "members": { + "ExpiringVersion": { + "target": "com.amazonaws.wafv2#VersionKeyString", + "traits": { + "smithy.api#documentation": "

The version that is set to expire.

" + } + }, + "ExpiryTimestamp": { + "target": "com.amazonaws.wafv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the version will expire.

\n

Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\".

" + } + }, + "NextLockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#UpdateRegexPatternSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#UpdateRegexPatternSetRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#UpdateRegexPatternSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFDuplicateItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFLimitsExceededException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFOptimisticLockException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the specified RegexPatternSet.

\n \n

This operation completely replaces the mutable specifications that you already have for the regex pattern set with the ones that you provide to this call.

\n

To modify a regex pattern set, do the following:

\n
    \n
  1. \n

    Retrieve it by calling GetRegexPatternSet\n

    \n
    2. \n
  2. \n

    Update its settings as needed

    \n
    3. \n
  3. \n

    Provide the complete regex pattern set specification to this call

    \n
    4. \n
\n \n

\n Temporary inconsistencies during updates\n

\n

When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.

\n

The following are examples of the temporary inconsistencies that you might notice during change propagation:

\n
    \n
  • \n

    After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable.

    \n
    • \n
  • \n

    After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.

    \n
    • \n
  • \n

    After you change a rule action setting, you might see the old action in some places and the new action in others.

    \n
    • \n
  • \n

    After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.

    \n
    • \n
" + } + }, + "com.amazonaws.wafv2#UpdateRegexPatternSetRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the set. You cannot change the name after you create the set.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n
    \n
  • \n

    CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    \n
    • \n
  • \n

    API and SDKs - For all calls, use the Region endpoint us-east-1.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", + "traits": { + "smithy.api#documentation": "

A description of the set that helps with identification.

" + } + }, + "RegularExpressionList": { + "target": "com.amazonaws.wafv2#RegularExpressionList", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#UpdateRegexPatternSetResponse": { + "type": "structure", + "members": { + "NextLockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#UpdateRuleGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#UpdateRuleGroupRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#UpdateRuleGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFConfigurationWarningException" + }, + { + "target": "com.amazonaws.wafv2#WAFDuplicateItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFLimitsExceededException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFOptimisticLockException" + }, + { + "target": "com.amazonaws.wafv2#WAFSubscriptionNotFoundException" + }, + { + "target": "com.amazonaws.wafv2#WAFUnavailableEntityException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the specified RuleGroup.

\n \n

This operation completely replaces the mutable specifications that you already have for the rule group with the ones that you provide to this call.

\n

To modify a rule group, do the following:

\n
    \n
  1. \n

    Retrieve it by calling GetRuleGroup\n

    \n
    2. \n
  2. \n

    Update its settings as needed

    \n
    3. \n
  3. \n

    Provide the complete rule group specification to this call

    \n
    4. \n
\n \n

A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.

\n

\n Temporary inconsistencies during updates\n

\n

When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.

\n

The following are examples of the temporary inconsistencies that you might notice during change propagation:

\n
    \n
  • \n

    After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable.

    \n
    • \n
  • \n

    After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.

    \n
    • \n
  • \n

    After you change a rule action setting, you might see the old action in some places and the new action in others.

    \n
    • \n
  • \n

    After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.

    \n
    • \n
" + } + }, + "com.amazonaws.wafv2#UpdateRuleGroupRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the rule group. You cannot change the name of a rule group after you create it.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n
    \n
  • \n

    CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    \n
    • \n
  • \n

    API and SDKs - For all calls, use the Region endpoint us-east-1.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", + "traits": { + "smithy.api#documentation": "

A description of the rule group that helps with identification.

" + } + }, + "Rules": { + "target": "com.amazonaws.wafv2#Rules", + "traits": { + "smithy.api#documentation": "

The Rule statements used to identify the web requests that you \n want to manage. Each rule includes one top-level statement that WAF uses to identify matching \n web requests, and parameters that govern how WAF handles them. \n

" + } + }, + "VisibilityConfig": { + "target": "com.amazonaws.wafv2#VisibilityConfig", + "traits": { + "smithy.api#documentation": "

Defines and enables Amazon CloudWatch metrics and web request sample collection.

", + "smithy.api#required": {} + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", + "smithy.api#required": {} + } + }, + "CustomResponseBodies": { + "target": "com.amazonaws.wafv2#CustomResponseBodies", + "traits": { + "smithy.api#documentation": "

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.

\n

For information about customizing web requests and responses, \n see Customizing web requests and responses in WAF \n in the WAF Developer Guide.

\n

For information about the limits on count and size for custom request and response settings, see WAF quotas \n in the WAF Developer Guide.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#UpdateRuleGroupResponse": { + "type": "structure", + "members": { + "NextLockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#UpdateWebACL": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#UpdateWebACLRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#UpdateWebACLResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFConfigurationWarningException" + }, + { + "target": "com.amazonaws.wafv2#WAFDuplicateItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFExpiredManagedRuleGroupVersionException" + }, + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidResourceException" + }, + { + "target": "com.amazonaws.wafv2#WAFLimitsExceededException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFOptimisticLockException" + }, + { + "target": "com.amazonaws.wafv2#WAFSubscriptionNotFoundException" + }, + { + "target": "com.amazonaws.wafv2#WAFUnavailableEntityException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the specified WebACL. While updating a web ACL, WAF provides\n continuous coverage to the resources that you have associated with the web ACL.

\n \n

This operation completely replaces the mutable specifications that you already have for the web ACL with the ones that you provide to this call.

\n

To modify a web ACL, do the following:

\n
    \n
  1. \n

    Retrieve it by calling GetWebACL\n

    \n
    2. \n
  2. \n

    Update its settings as needed

    \n
    3. \n
  3. \n

    Provide the complete web ACL specification to this call

    \n
    4. \n
\n \n

A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a statement that defines what to look for in web requests and an action that WAF applies to requests that match the statement. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

\n Temporary inconsistencies during updates\n

\n

When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.

\n

The following are examples of the temporary inconsistencies that you might notice during change propagation:

\n
    \n
  • \n

    After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable.

    \n
    • \n
  • \n

    After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.

    \n
    • \n
  • \n

    After you change a rule action setting, you might see the old action in some places and the new action in others.

    \n
    • \n
  • \n

    After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.

    \n
    • \n
" + } + }, + "com.amazonaws.wafv2#UpdateWebACLRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the web ACL. You cannot change the name of a web ACL after you create it.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n
    \n
  • \n

    CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    \n
    • \n
  • \n

    API and SDKs - For all calls, use the Region endpoint us-east-1.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", + "smithy.api#required": {} + } + }, + "DefaultAction": { + "target": "com.amazonaws.wafv2#DefaultAction", + "traits": { + "smithy.api#documentation": "

The action to perform if none of the Rules contained in the WebACL match.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", + "traits": { + "smithy.api#documentation": "

A description of the web ACL that helps with identification.

" + } + }, + "Rules": { + "target": "com.amazonaws.wafv2#Rules", + "traits": { + "smithy.api#documentation": "

The Rule statements used to identify the web requests that you \n want to manage. Each rule includes one top-level statement that WAF uses to identify matching \n web requests, and parameters that govern how WAF handles them. \n

" + } + }, + "VisibilityConfig": { + "target": "com.amazonaws.wafv2#VisibilityConfig", + "traits": { + "smithy.api#documentation": "

Defines and enables Amazon CloudWatch metrics and web request sample collection.

", + "smithy.api#required": {} + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", + "smithy.api#required": {} + } + }, + "CustomResponseBodies": { + "target": "com.amazonaws.wafv2#CustomResponseBodies", + "traits": { + "smithy.api#documentation": "

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.

\n

For information about customizing web requests and responses, \n see Customizing web requests and responses in WAF \n in the WAF Developer Guide.

\n

For information about the limits on count and size for custom request and response settings, see WAF quotas \n in the WAF Developer Guide.

" + } + }, + "CaptchaConfig": { + "target": "com.amazonaws.wafv2#CaptchaConfig", + "traits": { + "smithy.api#documentation": "

Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings. If you don't specify this, WAF uses its default settings for CaptchaConfig.

" + } + }, + "ChallengeConfig": { + "target": "com.amazonaws.wafv2#ChallengeConfig", + "traits": { + "smithy.api#documentation": "

Specifies how WAF should handle challenge evaluations for rules that don't have \ntheir own ChallengeConfig settings. If you don't specify this, WAF uses its default settings for ChallengeConfig.

" + } + }, + "TokenDomains": { + "target": "com.amazonaws.wafv2#TokenDomains", + "traits": { + "smithy.api#documentation": "

Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.

\n

Example JSON: \"TokenDomains\": { \"mywebsite.com\", \"myotherwebsite.com\" }\n

\n

Public suffixes aren't allowed. For example, you can't use gov.au or co.uk as token domains.

" + } + }, + "AssociationConfig": { + "target": "com.amazonaws.wafv2#AssociationConfig", + "traits": { + "smithy.api#documentation": "

Specifies custom configurations for the associations between the web ACL and protected resources.

\n

Use this to customize the maximum size of the request body that your protected resources forward to WAF for inspection. You can \n customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).

\n \n

You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.

\n \n

For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#UpdateWebACLResponse": { + "type": "structure", + "members": { + "NextLockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#UriPath": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Inspect the path component of the URI of the web request. This is the part of the web\n request that identifies a resource. For example, /images/daily-ad.jpg.

\n

This is used in the FieldToMatch specification for some web request component types.

\n

JSON specification: \"UriPath\": {}\n

" + } + }, + "com.amazonaws.wafv2#UsernameField": { + "type": "structure", + "members": { + "Identifier": { + "target": "com.amazonaws.wafv2#FieldIdentifier", + "traits": { + "smithy.api#documentation": "

The name of the username field.

\n

How you specify this depends on the request inspection payload type.

\n
    \n
  • \n

    For JSON payloads, specify the field name in JSON\n pointer syntax. For information about the JSON Pointer\n syntax, see the Internet Engineering Task Force (IETF)\n documentation JavaScript\n \tObject Notation (JSON) Pointer.

    \n

    For example, for the JSON payload { \"form\": { \"username\": \"THE_USERNAME\" } }, \n the username field specification is /form/username.

    \n
    • \n
  • \n

    For form encoded payload types, use the HTML form names.

    \n

    For example, for an HTML form with the input element\n named username1, the username field specification is\n username1\n

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The name of the field in the request payload that contains your customer's username.

\n

This data type is used in the RequestInspection and RequestInspectionACFP data types.

" + } + }, + "com.amazonaws.wafv2#VendorName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.wafv2#VersionKeyString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[\\w#:\\.\\-/]+$" + } + }, + "com.amazonaws.wafv2#VersionToPublish": { + "type": "structure", + "members": { + "AssociatedRuleGroupArn": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the vendor's rule group that's used in the published\n managed rule group version.

" + } + }, + "ForecastedLifetime": { + "target": "com.amazonaws.wafv2#TimeWindowDay", + "traits": { + "smithy.api#documentation": "

The amount of time the vendor expects this version of the managed rule group to last, in\n days.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A version of the named managed rule group, that the rule group's vendor publishes for\n use by customers.

\n \n

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

\n

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

\n " + } + }, + "com.amazonaws.wafv2#VersionsToPublish": { + "type": "map", + "key": { + "target": "com.amazonaws.wafv2#VersionKeyString" + }, + "value": { + "target": "com.amazonaws.wafv2#VersionToPublish" + } + }, + "com.amazonaws.wafv2#VisibilityConfig": { + "type": "structure", + "members": { + "SampledRequestsEnabled": { + "target": "com.amazonaws.wafv2#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether WAF should store a sampling of the web requests that\n match the rules. You can view the sampled requests through the WAF console.

\n \n

Request sampling doesn't provide a field redaction option, and any field redaction that you specify in your logging configuration doesn't affect sampling. \n The only way to exclude fields from request sampling is by disabling sampling in the web ACL visibility configuration.

\n ", + "smithy.api#required": {} + } + }, + "CloudWatchMetricsEnabled": { + "target": "com.amazonaws.wafv2#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the associated resource sends metrics to Amazon CloudWatch. For the\n list of available metrics, see WAF\n Metrics in the WAF Developer Guide.

\n

For web ACLs, the metrics are for web requests that have the web ACL default action applied. \n WAF applies the default action to web requests that pass the inspection of all rules \n in the web ACL without being either allowed or blocked. For more information,\nsee The web ACL default action in the WAF Developer Guide.

", + "smithy.api#required": {} + } + }, + "MetricName": { + "target": "com.amazonaws.wafv2#MetricName", + "traits": { + "smithy.api#documentation": "

A name of the Amazon CloudWatch metric dimension. The name can contain only the characters: A-Z, a-z, 0-9,\n - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't\n contain whitespace or metric names that are reserved for WAF, for example All and\n Default_Action.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines and enables Amazon CloudWatch metrics and web request sample collection.

" + } + }, + "com.amazonaws.wafv2#WAFAssociatedItemException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wafv2#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

WAF couldn’t perform the operation because your resource is being used by another\n resource or it’s associated with another resource.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.wafv2#WAFConfigurationWarningException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wafv2#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The operation failed because you are inspecting the web request body, headers, or\n cookies without specifying how to handle oversize components. Rules that inspect the body\n must either provide an OversizeHandling configuration or they must be preceded\n by a SizeConstraintStatement that blocks the body content from being too\n large. Rules that inspect the headers or cookies must provide an\n OversizeHandling configuration.

\n

Provide the handling configuration and retry your operation.

\n

Alternately, you can suppress this warning by adding the following tag to the resource\n that you provide to this operation: Tag\n (key:WAF:OversizeFieldsHandlingConstraintOptOut,\n value:true).

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.wafv2#WAFDuplicateItemException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wafv2#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

WAF couldn’t perform the operation because the resource that you tried to save is\n a duplicate of an existing one.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.wafv2#WAFExpiredManagedRuleGroupVersionException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wafv2#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The operation failed because the specified version for the managed rule group has\n expired. You can retrieve the available versions for the managed rule group by calling\n ListAvailableManagedRuleGroupVersions.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.wafv2#WAFInternalErrorException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wafv2#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

Your request is valid, but WAF couldn’t perform the operation because of a system\n problem. Retry your request.

", + "smithy.api#error": "server" + } + }, + "com.amazonaws.wafv2#WAFInvalidOperationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wafv2#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The operation isn't valid.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.wafv2#WAFInvalidParameterException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.wafv2#ErrorMessage" + }, + "Field": { + "target": "com.amazonaws.wafv2#ParameterExceptionField", + "traits": { + "smithy.api#documentation": "

The settings where the invalid parameter was found.

" + } + }, + "Parameter": { + "target": "com.amazonaws.wafv2#ParameterExceptionParameter", + "traits": { + "smithy.api#documentation": "

The invalid parameter that resulted in the exception.

" + } + }, + "Reason": { + "target": "com.amazonaws.wafv2#ErrorReason", + "traits": { + "smithy.api#documentation": "

Additional information about the exception.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The operation failed because WAF didn't recognize a parameter in the request. For\n example:

\n
    \n
  • \n

    You specified a parameter name or value that isn't valid.

    \n
    • \n
  • \n

    Your nested statement isn't valid. You might have tried to nest a statement that\n can’t be nested.

    \n
    • \n
  • \n

    You tried to update a WebACL with a DefaultAction that\n isn't among the types available at DefaultAction.

    \n
    • \n
  • \n

    Your request references an ARN that is malformed, or corresponds to a resource\n with which a web ACL can't be associated.

    \n
    • \n
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.wafv2#WAFInvalidPermissionPolicyException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wafv2#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The operation failed because the specified policy isn't in the proper format.

\n

The policy specifications must conform to the following:

\n
    \n
  • \n

    The policy must be composed using IAM Policy version 2012-10-17.

    \n
    • \n
  • \n

    The policy must include specifications for Effect, Action, and Principal.

    \n
    • \n
  • \n

    \n Effect must specify Allow.

    \n
    • \n
  • \n

    \n Action must specify wafv2:CreateWebACL, wafv2:UpdateWebACL, and \n wafv2:PutFirewallManagerRuleGroups and may optionally specify wafv2:GetRuleGroup. \n WAF rejects any extra actions or wildcard actions in the policy.

    \n
    • \n
  • \n

    The policy must not include a Resource parameter.

    \n
    • \n
\n

For more information, see IAM Policies.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.wafv2#WAFInvalidResourceException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wafv2#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

WAF couldn’t perform the operation because the resource that you requested isn’t\n valid. Check the resource, and try again.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.wafv2#WAFLimitsExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wafv2#ErrorMessage" + }, + "SourceType": { + "target": "com.amazonaws.wafv2#SourceType", + "traits": { + "smithy.api#documentation": "

Source type for the exception.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

WAF couldn’t perform the operation because you exceeded your resource limit. For\n example, the maximum number of WebACL objects that you can create for an Amazon Web Services\n account. For more information, see WAF quotas in the\n WAF Developer Guide.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.wafv2#WAFLogDestinationPermissionIssueException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wafv2#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The operation failed because you don't have the permissions that your logging\n configuration requires. For information, see Logging web ACL traffic information\n in the WAF Developer Guide.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.wafv2#WAFNonexistentItemException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wafv2#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

WAF couldn’t perform the operation because your resource doesn't exist. \n If you've just created a resource that you're using in this operation, you might \n just need to wait a few minutes. It can take from a few seconds to a number of minutes \n for changes to propagate.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.wafv2#WAFOptimisticLockException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wafv2#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

WAF couldn’t save your changes because you tried to update or delete a resource\n that has changed since you last retrieved it. Get the resource again, make any changes you\n need to make to the new copy, and retry your operation.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.wafv2#WAFServiceLinkedRoleErrorException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.wafv2#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

WAF is not able to access the service linked role. This can be caused by a\n previous PutLoggingConfiguration request, which can lock the service linked\n role for about 20 seconds. Please try your request again. The service linked role can also\n be locked by a previous DeleteServiceLinkedRole request, which can lock the\n role for 15 minutes or more. If you recently made a call to\n DeleteServiceLinkedRole, wait at least 15 minutes and try the request\n again. If you receive this same exception again, you will have to wait additional time\n until the role is unlocked.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.wafv2#WAFSubscriptionNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wafv2#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

You tried to use a managed rule group that's available by subscription, but you aren't\n subscribed to it yet.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.wafv2#WAFTagOperationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wafv2#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

An error occurred during the tagging operation. Retry your request.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.wafv2#WAFTagOperationInternalErrorException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wafv2#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

WAF couldn’t perform your tagging operation because of an internal error. Retry\n your request.

", + "smithy.api#error": "server" + } + }, + "com.amazonaws.wafv2#WAFUnavailableEntityException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wafv2#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

WAF couldn’t retrieve a resource that you specified for this operation. \n If you've just created a resource that you're using in this operation, you might \n just need to wait a few minutes. It can take from a few seconds to a number of minutes \n for changes to propagate. Verify the resources that you are specifying in your request \n parameters and then retry the operation.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.wafv2#WAFUnsupportedAggregateKeyTypeException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wafv2#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The rule that you've named doesn't aggregate solely on the IP address or solely on the forwarded IP address. This call \n is only available for rate-based rules with an AggregateKeyType setting of IP or FORWARDED_IP.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.wafv2#WebACL": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the web ACL. You cannot change the name of a web ACL after you create it.

", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the WebACL. This ID is returned in the responses to\n create and list commands. You use this ID to do things like get, update, and delete a\n WebACL.

", + "smithy.api#required": {} + } + }, + "ARN": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the web ACL that you want to associate with the\n resource.

", + "smithy.api#required": {} + } + }, + "DefaultAction": { + "target": "com.amazonaws.wafv2#DefaultAction", + "traits": { + "smithy.api#documentation": "

The action to perform if none of the Rules contained in the WebACL match.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", + "traits": { + "smithy.api#documentation": "

A description of the web ACL that helps with identification.

" + } + }, + "Rules": { + "target": "com.amazonaws.wafv2#Rules", + "traits": { + "smithy.api#documentation": "

The Rule statements used to identify the web requests that you \n want to manage. Each rule includes one top-level statement that WAF uses to identify matching \n web requests, and parameters that govern how WAF handles them. \n

" + } + }, + "VisibilityConfig": { + "target": "com.amazonaws.wafv2#VisibilityConfig", + "traits": { + "smithy.api#documentation": "

Defines and enables Amazon CloudWatch metrics and web request sample collection.

", + "smithy.api#required": {} + } + }, + "Capacity": { + "target": "com.amazonaws.wafv2#ConsumedCapacity", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The web ACL capacity units (WCUs) currently being used by this web ACL.

\n

WAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) \n in the WAF Developer Guide.

" + } + }, + "PreProcessFirewallManagerRuleGroups": { + "target": "com.amazonaws.wafv2#FirewallManagerRuleGroups", + "traits": { + "smithy.api#documentation": "

The first set of rules for WAF to process in the web ACL. This is defined in an\n Firewall Manager WAF policy and contains only rule group references. You can't alter these. Any\n rules and rule groups that you define for the web ACL are prioritized after these.

\n

In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run\n first in the web ACL and a set of rule groups to run last. Within each set, the\n administrator prioritizes the rule groups, to determine their relative processing\n order.

" + } + }, + "PostProcessFirewallManagerRuleGroups": { + "target": "com.amazonaws.wafv2#FirewallManagerRuleGroups", + "traits": { + "smithy.api#documentation": "

The last set of rules for WAF to process in the web ACL. This is defined in an\n Firewall Manager WAF policy and contains only rule group references. You can't alter these. Any\n rules and rule groups that you define for the web ACL are prioritized before these.

\n

In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run\n first in the web ACL and a set of rule groups to run last. Within each set, the\n administrator prioritizes the rule groups, to determine their relative processing\n order.

" + } + }, + "ManagedByFirewallManager": { + "target": "com.amazonaws.wafv2#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether this web ACL was created by Firewall Manager and is being managed by Firewall Manager. If true, then only Firewall Manager can\n delete the web ACL or any Firewall Manager rule groups in the web ACL. \n See also the properties RetrofittedByFirewallManager, PreProcessFirewallManagerRuleGroups, and PostProcessFirewallManagerRuleGroups.

" + } + }, + "LabelNamespace": { + "target": "com.amazonaws.wafv2#LabelName", + "traits": { + "smithy.api#documentation": "

The label namespace prefix for this web ACL. All labels added by rules in this web ACL have this prefix.

\n
    \n
  • \n

    The syntax for the label namespace prefix for a web ACL is the following:

    \n

    \n awswaf::webacl::\n

    \n
    • \n
  • \n

    When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:

    \n

    \n \n

    \n
    • \n
" + } + }, + "CustomResponseBodies": { + "target": "com.amazonaws.wafv2#CustomResponseBodies", + "traits": { + "smithy.api#documentation": "

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.

\n

For information about customizing web requests and responses, \n see Customizing web requests and responses in WAF \n in the WAF Developer Guide.

\n

For information about the limits on count and size for custom request and response settings, see WAF quotas \n in the WAF Developer Guide.

" + } + }, + "CaptchaConfig": { + "target": "com.amazonaws.wafv2#CaptchaConfig", + "traits": { + "smithy.api#documentation": "

Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings. If you don't specify this, WAF uses its default settings for CaptchaConfig.

" + } + }, + "ChallengeConfig": { + "target": "com.amazonaws.wafv2#ChallengeConfig", + "traits": { + "smithy.api#documentation": "

Specifies how WAF should handle challenge evaluations for rules that don't have \ntheir own ChallengeConfig settings. If you don't specify this, WAF uses its default settings for ChallengeConfig.

" + } + }, + "TokenDomains": { + "target": "com.amazonaws.wafv2#TokenDomains", + "traits": { + "smithy.api#documentation": "

Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.

" + } + }, + "AssociationConfig": { + "target": "com.amazonaws.wafv2#AssociationConfig", + "traits": { + "smithy.api#documentation": "

Specifies custom configurations for the associations between the web ACL and protected resources.

\n

Use this to customize the maximum size of the request body that your protected resources forward to WAF for inspection. You can \n customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).

\n \n

You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.

\n \n

For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).

" + } + }, + "RetrofittedByFirewallManager": { + "target": "com.amazonaws.wafv2#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether this web ACL was created by a customer account and then retrofitted by Firewall Manager. If true, then the web ACL is currently being \n managed by a Firewall Manager WAF policy, and only Firewall Manager can manage any Firewall Manager rule groups in the web ACL. \n See also the properties ManagedByFirewallManager, PreProcessFirewallManagerRuleGroups, and PostProcessFirewallManagerRuleGroups.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a statement that defines what to look for in web requests and an action that WAF applies to requests that match the statement. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

" + } + }, + "com.amazonaws.wafv2#WebACLSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#WebACLSummary" + } + }, + "com.amazonaws.wafv2#WebACLSummary": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the web ACL. You cannot change the name of a web ACL after you create it.

" + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

" + } + }, + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", + "traits": { + "smithy.api#documentation": "

A description of the web ACL that helps with identification.

" + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" + } + }, + "ARN": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the entity.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

High-level information about a WebACL, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a WebACL, and the ARN, that you provide to operations like AssociateWebACL.

" + } + }, + "com.amazonaws.wafv2#XssMatchStatement": { + "type": "structure", + "members": { + "FieldToMatch": { + "target": "com.amazonaws.wafv2#FieldToMatch", + "traits": { + "smithy.api#documentation": "

The part of the web request that you want WAF to inspect.

", + "smithy.api#required": {} + } + }, + "TextTransformations": { + "target": "com.amazonaws.wafv2#TextTransformations", + "traits": { + "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A rule statement that inspects for cross-site scripting (XSS) attacks. In XSS attacks, the attacker \nuses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers.

" + } + } + } +} \ No newline at end of file diff --git a/pkg/testdata/models/apis/ecr/0000-00-00/generator-renamed-identifier-field.yaml b/pkg/testdata/models/apis/ecr/0000-00-00/generator-renamed-identifier-field.yaml index 07f51f15..7d8f10eb 100644 --- a/pkg/testdata/models/apis/ecr/0000-00-00/generator-renamed-identifier-field.yaml +++ b/pkg/testdata/models/apis/ecr/0000-00-00/generator-renamed-identifier-field.yaml @@ -8,3 +8,7 @@ resources: DescribeRepositories: input_fields: RepositoryName: Name +ignore: + resources: + - PullThroughCacheRule + - RepositoryCreationTemplate \ No newline at end of file diff --git a/pkg/testdata/models/apis/ecr/0000-00-00/generator-v1alpha1.yaml b/pkg/testdata/models/apis/ecr/0000-00-00/generator-v1alpha1.yaml index fb0ebb1f..a6013cf9 100644 --- a/pkg/testdata/models/apis/ecr/0000-00-00/generator-v1alpha1.yaml +++ b/pkg/testdata/models/apis/ecr/0000-00-00/generator-v1alpha1.yaml @@ -8,4 +8,8 @@ resources: match_fields: - Name update_operation: - custom_method_name: customUpdateRepository \ No newline at end of file + custom_method_name: customUpdateRepository +ignore: + resources: + - PullThroughCacheRule + - RepositoryCreationTemplate \ No newline at end of file diff --git a/pkg/testdata/models/apis/ecr/0000-00-00/generator-v1alpha2.yaml b/pkg/testdata/models/apis/ecr/0000-00-00/generator-v1alpha2.yaml index 0197eb7a..b62cbcda 100644 --- a/pkg/testdata/models/apis/ecr/0000-00-00/generator-v1alpha2.yaml +++ b/pkg/testdata/models/apis/ecr/0000-00-00/generator-v1alpha2.yaml @@ -24,4 +24,8 @@ resources: match_fields: - Name update_operation: - custom_method_name: customUpdateRepository \ No newline at end of file + custom_method_name: customUpdateRepository +ignore: + resources: + - PullThroughCacheRule + - RepositoryCreationTemplate \ No newline at end of file diff --git a/pkg/testdata/models/apis/ecr/0000-00-00/generator-v1alpha3.yaml b/pkg/testdata/models/apis/ecr/0000-00-00/generator-v1alpha3.yaml index b6d0d6cd..bd66df3b 100644 --- a/pkg/testdata/models/apis/ecr/0000-00-00/generator-v1alpha3.yaml +++ b/pkg/testdata/models/apis/ecr/0000-00-00/generator-v1alpha3.yaml @@ -27,4 +27,8 @@ resources: match_fields: - Name update_operation: - custom_method_name: customUpdateRepository \ No newline at end of file + custom_method_name: customUpdateRepository +ignore: + resources: + - PullThroughCacheRule + - RepositoryCreationTemplate \ No newline at end of file diff --git a/pkg/testdata/models/apis/ecr/0000-00-00/generator-with-field-config.yaml b/pkg/testdata/models/apis/ecr/0000-00-00/generator-with-field-config.yaml index 5b2a4758..571fd215 100644 --- a/pkg/testdata/models/apis/ecr/0000-00-00/generator-with-field-config.yaml +++ b/pkg/testdata/models/apis/ecr/0000-00-00/generator-with-field-config.yaml @@ -10,3 +10,7 @@ resources: list_operation: match_fields: - RepositoryName +ignore: + resources: + - PullThroughCacheRule + - RepositoryCreationTemplate \ No newline at end of file diff --git a/pkg/testdata/models/apis/ecr/0000-00-00/generator-with-late-initialize.yaml b/pkg/testdata/models/apis/ecr/0000-00-00/generator-with-late-initialize.yaml index 93a42c84..bdb18ef5 100644 --- a/pkg/testdata/models/apis/ecr/0000-00-00/generator-with-late-initialize.yaml +++ b/pkg/testdata/models/apis/ecr/0000-00-00/generator-with-late-initialize.yaml @@ -13,3 +13,7 @@ resources: list_operation: match_fields: - RepositoryName +ignore: + resources: + - PullThroughCacheRule + - RepositoryCreationTemplate \ No newline at end of file diff --git a/pkg/testdata/models/apis/ecr/0000-00-00/generator-with-nested-path-late-initialize.yaml b/pkg/testdata/models/apis/ecr/0000-00-00/generator-with-nested-path-late-initialize.yaml index c87e8f60..7f7cfd33 100644 --- a/pkg/testdata/models/apis/ecr/0000-00-00/generator-with-nested-path-late-initialize.yaml +++ b/pkg/testdata/models/apis/ecr/0000-00-00/generator-with-nested-path-late-initialize.yaml @@ -26,3 +26,7 @@ resources: list_operation: match_fields: - RepositoryName +ignore: + resources: + - PullThroughCacheRule + - RepositoryCreationTemplate \ No newline at end of file diff --git a/pkg/testdata/models/apis/ecr/0000-00-00/generator.yaml b/pkg/testdata/models/apis/ecr/0000-00-00/generator.yaml index 7af964e7..045180d6 100644 --- a/pkg/testdata/models/apis/ecr/0000-00-00/generator.yaml +++ b/pkg/testdata/models/apis/ecr/0000-00-00/generator.yaml @@ -7,3 +7,7 @@ resources: list_operation: match_fields: - RepositoryName +ignore: + resources: + - PullThroughCacheRule + - RepositoryCreationTemplate diff --git a/pkg/testdata/models/apis/ecr/0000-00-01/generator-v1beta1.yaml b/pkg/testdata/models/apis/ecr/0000-00-01/generator-v1beta1.yaml index 0197eb7a..b62cbcda 100644 --- a/pkg/testdata/models/apis/ecr/0000-00-01/generator-v1beta1.yaml +++ b/pkg/testdata/models/apis/ecr/0000-00-01/generator-v1beta1.yaml @@ -24,4 +24,8 @@ resources: match_fields: - Name update_operation: - custom_method_name: customUpdateRepository \ No newline at end of file + custom_method_name: customUpdateRepository +ignore: + resources: + - PullThroughCacheRule + - RepositoryCreationTemplate \ No newline at end of file diff --git a/pkg/testdata/models/apis/ecr/0000-00-01/generator-v1beta2.yaml b/pkg/testdata/models/apis/ecr/0000-00-01/generator-v1beta2.yaml index 66bc4ec8..2f2ba247 100644 --- a/pkg/testdata/models/apis/ecr/0000-00-01/generator-v1beta2.yaml +++ b/pkg/testdata/models/apis/ecr/0000-00-01/generator-v1beta2.yaml @@ -29,4 +29,8 @@ resources: match_fields: - Name update_operation: - custom_method_name: customUpdateRepository \ No newline at end of file + custom_method_name: customUpdateRepository +ignore: + resources: + - PullThroughCacheRule + - RepositoryCreationTemplate \ No newline at end of file diff --git a/pkg/testdata/models/apis/s3/0000-00-00/generator.yaml b/pkg/testdata/models/apis/s3/0000-00-00/generator.yaml index 44a164e8..ea35297b 100644 --- a/pkg/testdata/models/apis/s3/0000-00-00/generator.yaml +++ b/pkg/testdata/models/apis/s3/0000-00-00/generator.yaml @@ -5,6 +5,10 @@ ignore: shape_names: # These shapes are structs with no members... - SSES3 + field_paths: + - CreateBucketConfiguration.Bucket + - CreateBucketConfiguration.Location + - BucketLoggingStatus.LoggingEnabled.TargetObjectKeyFormat resources: Bucket: renames: diff --git a/pkg/testutil/schema_helper.go b/pkg/testutil/schema_helper.go index 414ea2d4..e54730f2 100644 --- a/pkg/testutil/schema_helper.go +++ b/pkg/testutil/schema_helper.go @@ -76,7 +76,7 @@ func NewModelForServiceWithOptions(t *testing.T, servicePackageName string, opti } options.SetDefaults() - generatorConfigPath := filepath.Join(path, "codegen", "sdk-codegen", "aws-models", servicePackageName+".json") + generatorConfigPath := filepath.Join(path, "models", "apis", servicePackageName, options.ServiceAPIVersion, options.GeneratorConfigFile) if _, err := os.Stat(generatorConfigPath); os.IsNotExist(err) { t.Fatalf("Could not find generator file %q", generatorConfigPath) } diff --git a/templates/pkg/resource/sdk_find_read_many.go.tpl b/templates/pkg/resource/sdk_find_read_many.go.tpl index b7cfec19..f458f424 100644 --- a/templates/pkg/resource/sdk_find_read_many.go.tpl +++ b/templates/pkg/resource/sdk_find_read_many.go.tpl @@ -33,7 +33,7 @@ func (rm *resourceManager) sdkFind( {{- end }} rm.metrics.RecordAPICall("READ_MANY", "{{ .CRD.Ops.ReadMany.ExportedName }}", err) if err != nil { - if if strings.Contains(err.Error(), "{{ ResourceExceptionCode .CRD 404 }}" {{ GoCodeSetExceptionMessageCheck .CRD 404 }}) { + if strings.Contains(err.Error(), "{{ ResourceExceptionCode .CRD 404 }}" {{ GoCodeSetExceptionMessageCheck .CRD 404 }}) { return nil, ackerr.NotFound } return nil, err